- added M_GetDocumentsPath function.

src/m_misc.h

@@ -60,5 +60,6 @@ FString M_GetCajunPath(const char *filename);
 FString M_GetConfigPath(bool for_reading);
 FString M_GetScreenshotsPath();
 FString M_GetSavegamesPath();
+FString M_GetDocumentsPath();
 
 #endif

src/posix/osx/i_specialpaths.mm

@@ -215,3 +215,24 @@ FString M_GetSavegamesPath()
 	return path;
 }
 
+//===========================================================================
+//
+// M_GetDocumentsPath												Unix
+//
+// Returns the path to the default documents directory.
+//
+//===========================================================================
+
+FString M_GetDocumentsPath()
+{
+	FString path;
+	char cpath[PATH_MAX];
+	FSRef folder;
+
+	if (noErr == FSFindFolder(kUserDomain, kDocumentsFolderType, kCreateFolder, &folder) &&
+		noErr == FSRefMakePath(&folder, (UInt8*)cpath, PATH_MAX))
+	{
+		path << cpath << "/" GAME_DIR "/";
+	}
+	return path;
+}

src/posix/unix/i_specialpaths.cpp

@@ -218,3 +218,16 @@ FString M_GetSavegamesPath()
 {
 	return NicePath("~/" GAME_DIR);
 }
+
+//===========================================================================
+//
+// M_GetDocumentsPath												Unix
+//
+// Returns the path to the default documents directory.
+//
+//===========================================================================
+
+FString M_GetDocumentsPath()
+{
+	return NicePath("~/" GAME_DIR);
+}

src/win32/i_specialpaths.cpp

@@ -380,3 +380,41 @@ FString M_GetSavegamesPath()
 	}
 	return path;
 }
+
+//===========================================================================
+//
+// M_GetDocumentsPath												Windows
+//
+// Returns the path to the default documents directory.
+//
+//===========================================================================
+
+FString M_GetDocumentsPath()
+{
+	FString path;
+
+	// A portable INI means that this storage location should also be portable.
+	path.Format("%s" GAMENAME "_portable.ini", progdir.GetChars());
+	if (FileExists(path))
+	{
+		return progdir;
+	}
+
+	if (!UseKnownFolders())
+	{
+		return progdir;
+	}
+	// Try defacto My Documents/My Games folder
+	else if (GetKnownFolder(CSIDL_PERSONAL, FOLDERID_Documents, true, path))
+	{
+		// I assume since this isn't a standard folder, it doesn't have
+		// a localized name either.
+		path << "/My Games/" GAMENAME;
+		CreatePath(path);
+	}
+	else
+	{
+		path = progdir;
+	}
+	return path;
+}