Unit tests for the tGetXDG functions that parse the XDG Base Directories environment variable specifications.

Author: bluescan

Modules/System/Inc/System/tMachine.h

@@ -46,15 +46,14 @@ bool tOpenSystemFileExplorer(const tString& fullFilename);
 // in Tacent's path format with trailing / for directories. All paths are absolute as defined by the spec. Clients using
 // these functions should NOT place data directly in the returned directories -- they should make a subdirectory,
 // usually the name of the app in lowercase, and put their files there.
-bool tGetXDGDataHome(tString& xdgDataHome);				// $XDG_DATA_HOME
-bool tGetXDGConfigHome(tString& xdgConfigHome);			// $XDG_CONFIG_HOME
-bool tGetXDGStateHome(tString& xdgStateHome);			// $XDG_STATE_HOME
-void tGetXDGExeHome(tString& xdgExeHome);				// Not defined by an XDG env variable. Always: $HOME/.local/bin/
-
+bool tGetXDGDataHome(tString& xdgDataHome);					// $XDG_DATA_HOME
+bool tGetXDGConfigHome(tString& xdgConfigHome);				// $XDG_CONFIG_HOME
+bool tGetXDGStateHome(tString& xdgStateHome);				// $XDG_STATE_HOME
+void tGetXDGExeHome(tString& xdgExeHome);					// Not defined by an XDG env variable. Always: $HOME/.local/bin/
 bool tGetXDGDataDirs(tList<tStringItem>& xdgDataDirs);		// $XDG_DATA_DIRS. Priority list of directories to search.
 bool tGetXDGConfigDirs(tList<tStringItem>& xdgConfigDirs);	// $XDG_CONFIG_DIRS. Priority list of directories to search.
-bool tGetXDGCacheHome(tString& xdgCacheHome);			// $XDG_CACHE_HOME
-bool tGetXDGRuntimeDir(tString& xdgRuntimeDir);			// $XDG_RUNTIME_DIR
+bool tGetXDGCacheHome(tString& xdgCacheHome);				// $XDG_CACHE_HOME
+bool tGetXDGRuntimeDir(tString& xdgRuntimeDir);				// $XDG_RUNTIME_DIR
 #endif
 
 }

Modules/System/Inc/System/tPrint.h

@@ -138,7 +138,8 @@ namespace tSystem
 //					Using the 0 prefix flag works differently on Linux vs Windows with non-integral types like %c.
 //					Tacent behaves (on purpose) like Windows where the leading 0s are printed even though the type is
 //					not integral.
-//		Enhanced:	Underscore (_) or single-quote (') chooses a more readable decorative or alternative printing method.
+//		Enhanced:	Underscore (_) or single-quote (') chooses a more readable decorative or alternative printing
+//					method. They do not necessarily do the same thing as each other.
 //					Integral Types:
 //						For built-in integral types, an _ inserts an underscore every 4 characters starting from the
 //						right. Handy for making binary values readable. For Tacent integer types like tint128 and
@@ -196,7 +197,8 @@ namespace tSystem
 //		String:		s				You must call pod(string) or string.Pod() for tStrings, or use char*.
 //					t				Windows only. Allows passing of non-POD tString directly. Warning: You cannot pass
 //									in an tStringItem! You must either cast to an tString or call pod() and use %s.
-//		Boolean:	B				For printing a bool as either "true" or "false".
+//		Boolean:	B				For printing a bool as either "true" or "false" or the alternate formats T or F
+//									when _ used and Y or N when ' used.
 //		Percent:	%				Displays percent sign.
 //
 // The functions return the number of characters printed. They do NOT care about channels in that they always report

UnitTests/Src/TestSystem.cpp

@@ -1440,6 +1440,54 @@ tTestUnit(Machine)
 
 	tString pathEnvVar = tSystem::tGetEnvVar("PATH");
 	tPrintf("PATH Env Var:%s\n", pathEnvVar.Chr());
+
+	#ifdef PLATFORM_LINUX
+	tPrintf("Testing XDG Base Directories\n");
+
+	tString dataHome;
+	bool dataHomeSet = tSystem::tGetXDGDataHome(dataHome);
+	tPrintf("XDGDataHome Set:%'B Dir:%s\n", dataHomeSet, dataHome.Chr());
+	tRequire(tIsAbsolutePath(dataHome));
+
+	tString configHome;
+	bool configHomeSet = tSystem::tGetXDGConfigHome(configHome);
+	tPrintf("XDGConfigHome Set:%'B Dir:%s\n", configHomeSet, configHome.Chr());
+	tRequire(tIsAbsolutePath(configHome));
+
+	tString stateHome;
+	bool stateHomeSet = tSystem::tGetXDGStateHome(stateHome);
+	tPrintf("XDGStateHome Set:%'B Dir:%s\n", stateHomeSet, stateHome.Chr());
+	tRequire(tIsAbsolutePath(stateHome));
+
+	tString exeHome;
+	tSystem::tGetXDGExeHome(exeHome);
+	tPrintf("XDGExeHome Dir:%s\n", exeHome.Chr());
+	tRequire(tIsAbsolutePath(exeHome));
+
+	tList<tStringItem> dataDirs;
+	bool dataDirsSet = tSystem::tGetXDGDataDirs(dataDirs);
+	tPrintf("XDGDataDirs Set:%'B\n", dataDirsSet);
+	for (tStringItem* dir = dataDirs.First(); dir; dir = dir->Next())
+		tPrintf("   Dir:%s\n", dir->Chr());
+	tRequire(!dataDirs.IsEmpty());
+
+	tList<tStringItem> configDirs;
+	bool configDirsSet = tSystem::tGetXDGConfigDirs(configDirs);
+	tPrintf("XDGConfigDirs Set:%'B\n", configDirsSet);
+	for (tStringItem* dir = configDirs.First(); dir; dir = dir->Next())
+		tPrintf("   Dir:%s\n", dir->Chr());
+	tRequire(!configDirs.IsEmpty());
+
+	tString cacheHome;
+	bool cacheHomeSet = tSystem::tGetXDGCacheHome(cacheHome);
+	tPrintf("XDGCacheHome Set:%'B Dir:%s\n", cacheHomeSet, cacheHome.Chr());
+	tRequire(tIsAbsolutePath(cacheHome));
+
+	tString runtimeDir;
+	bool runtimeDirSet = tSystem::tGetXDGRuntimeDir(runtimeDir);
+	tPrintf("XDGRuntimeDir Set:%'B Dir:%s\n", runtimeDirSet, runtimeDir.Chr());
+	tRequire(tIsAbsolutePath(runtimeDir) || runtimeDir.IsEmpty());
+	#endif
 }
 
 

UnitTests/Src/UnitTests.cpp

@@ -201,11 +201,12 @@ int main(int argc, char** argv)
 	// tTest(FindRec);
 	// tTest(Network);
 	// tTest(Time);
+	tTest(Machine);
 	// tTest(CmdLine);
 	// tTest(String);
 	// tTest(List);
 	// tTest(ListExtra);
-	tTest(ListSort);
+	// tTest(ListSort);
 	// tTest(Colour);
 	// tTest(Print);
 	// tTest(Map);