From a945418ba6c49704a4e9fbcbdda063e653d4c653 Mon Sep 17 00:00:00 2001
From: Christoph Oelckers <coelckers@users.noreply.github.com>
Date: Sun, 3 Dec 2017 21:03:44 +0100
Subject: [PATCH] - added M_GetDocumentsPath function.

---
 src/m_misc.h                      |  1 +
 src/posix/osx/i_specialpaths.mm   | 21 +++++++++++++++++
 src/posix/unix/i_specialpaths.cpp | 13 +++++++++++
 src/win32/i_specialpaths.cpp      | 38 +++++++++++++++++++++++++++++++
 4 files changed, 73 insertions(+)

diff --git a/src/m_misc.h b/src/m_misc.h
index 8f375b930..f3773659d 100644
--- a/src/m_misc.h
+++ b/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
diff --git a/src/posix/osx/i_specialpaths.mm b/src/posix/osx/i_specialpaths.mm
index fbb32cec6..540aaf4b0 100644
--- a/src/posix/osx/i_specialpaths.mm
+++ b/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;
+}
diff --git a/src/posix/unix/i_specialpaths.cpp b/src/posix/unix/i_specialpaths.cpp
index 581fda5d5..01320548d 100644
--- a/src/posix/unix/i_specialpaths.cpp
+++ b/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);
+}
\ No newline at end of file
diff --git a/src/win32/i_specialpaths.cpp b/src/win32/i_specialpaths.cpp
index 4a790798f..375f301dd 100644
--- a/src/win32/i_specialpaths.cpp
+++ b/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;
+}