ZeeTerminal 0.5.1 src commit

Author: rforzachamp821

CommandFiles/CPUStress.cpp

@@ -43,6 +43,7 @@ void CpuBenchmark(short int nSingleOrMulti, long long int nArgNum = -1) {
 	std::chrono::time_point<std::chrono::steady_clock> start, end;
 	std::chrono::duration<long double> ldElapsedTime; // Save the duration of the operation here
 	long long int nInput = 0;
+	bool bUserCursorVisibilitySetting = true;
 
 
 	// Take input
@@ -87,6 +88,9 @@ void CpuBenchmark(short int nSingleOrMulti, long long int nArgNum = -1) {
 		slowcolourfn(LGRN, ConfigObjMain.sColourGlobalBack, "Single-core benchmark has started...\n");
 		ClearKeyboardBuffer();
 
+		// Disable cursor
+		bUserCursorVisibilitySetting = DisableCursorVisibility();
+
 		start = std::chrono::steady_clock::now();
 
 		std::thread SingleCoreWorker(CpuBenchmarkWorker);
@@ -128,12 +132,6 @@ void CpuBenchmark(short int nSingleOrMulti, long long int nArgNum = -1) {
 			Exiting();
 			colour(ConfigObjMain.sColourGlobal, ConfigObjMain.sColourGlobalBack);
 		}
-
-		// Reset values to default
-		bCpuStressKeyboardTermination = false;
-		nReiterationCount = 0;
-		StopCpuStress = false;
-		nCurrentReiterationNum = 0;
 	}
 
 	// Multi Core
@@ -147,6 +145,9 @@ void CpuBenchmark(short int nSingleOrMulti, long long int nArgNum = -1) {
 		slowcolourfn(LGRN, ConfigObjMain.sColourGlobalBack, "Multi-core benchmark has started...\n");
 		ClearKeyboardBuffer();
 
+		// Disable cursor
+		bUserCursorVisibilitySetting = DisableCursorVisibility();
+
 		start = std::chrono::steady_clock::now();
 		for (int i = 0; i < nLogicalCoreCount; i++) {
 			vThreads[i] = std::thread(CpuBenchmarkWorker);
@@ -198,6 +199,11 @@ void CpuBenchmark(short int nSingleOrMulti, long long int nArgNum = -1) {
 	nReiterationCount = 0;
 	StopCpuStress = false;
 	nCurrentReiterationNum = 0;
+
+	// Reset cursor visibility
+	ConfigObjMain.bShowCursor = bUserCursorVisibilitySetting;
+	SetCursorAttributes();
+
 	return;
 }
 

CommandFiles/CommandFileAssets.cpp

@@ -523,46 +523,147 @@ std::string AnsiToWin32Colours(std::string sAnsiColour)
 
 // Checks all ConfigObjMain.sColour colours to see if they don't exceed the WIN32 colour limit (8192)
 // Returns TRUE for all correct, FALSE for 1 or more variables incorrect.
-bool CheckColourWin32Validity() {
+bool ValidateColourStringsWin32() {
 	bool bSuccess = true;
 
 	// Check validity of WIN32 values - They may not exceed 8192 (base 10).
 	if (not (isNumberi(ConfigObjMain.sColourGlobal) && std::stoi(ConfigObjMain.sColourGlobal) < 8192)) {
-		ConfigObjMain.sColourGlobal = LWHT;
+		ConfigObjMain.sColourGlobal = LWHT_WIN32;
 		bSuccess = false;
 	}
 	if (not (isNumberi(ConfigObjMain.sColourGlobalBack) && std::stoi(ConfigObjMain.sColourGlobalBack) < 8192)) {
-		ConfigObjMain.sColourGlobalBack = BLK;
+		ConfigObjMain.sColourGlobalBack = BLK_WIN32;
 		bSuccess = false;
 	}
 	if (not (isNumberi(ConfigObjMain.sColourHighlight) && std::stoi(ConfigObjMain.sColourHighlight) < 8192)) {
-		ConfigObjMain.sColourHighlight = LWHT;
+		ConfigObjMain.sColourHighlight = LWHT_WIN32;
 		bSuccess = false;
 	}
 	if (not (isNumberi(ConfigObjMain.sColourHighlightBack) && std::stoi(ConfigObjMain.sColourHighlightBack) < 8192)) {
-		ConfigObjMain.sColourHighlightBack = BLU;
+		ConfigObjMain.sColourHighlightBack = BLU_WIN32;
 		bSuccess = false;
 	}
 	if (not (isNumberi(ConfigObjMain.sColourTitle) && std::stoi(ConfigObjMain.sColourTitle) < 8192)) {
-		ConfigObjMain.sColourTitle = BLK;
+		ConfigObjMain.sColourTitle = BLK_WIN32;
 		bSuccess = false;
 	}
 	if (not (isNumberi(ConfigObjMain.sColourTitleBack) && std::stoi(ConfigObjMain.sColourTitleBack) < 8192)) {
-		ConfigObjMain.sColourTitleBack = LCYN;
+		ConfigObjMain.sColourTitleBack = LCYN_WIN32;
 		bSuccess = false;
 	}
 	if (not (isNumberi(ConfigObjMain.sColourSubheading) && std::stoi(ConfigObjMain.sColourSubheading) < 8192)) {
-		ConfigObjMain.sColourSubheading = LWHT;
+		ConfigObjMain.sColourSubheading = LWHT_WIN32;
 		bSuccess = false;
 	}
 	if (not (isNumberi(ConfigObjMain.sColourSubheadingBack) && std::stoi(ConfigObjMain.sColourSubheadingBack) < 8192)) {
-		ConfigObjMain.sColourSubheadingBack = MAG;
+		ConfigObjMain.sColourSubheadingBack = MAG_WIN32;
 		bSuccess = false;
 	}
 
 	return bSuccess;
 }
 
+// VerifyANSIColourString - Verifies an ANSI colour string with the following rules:
+//                        - 1. It must only contain numbers and semicolons
+//                        - 2. The numbers in the colour string must be less than 256.
+// Parameters: sColourString - The colour string to check.
+// Return Values: TRUE or 1 for a valid colour string, FALSE or 0 for a bad colour string.
+//
+bool VerifyANSIColourString(std::string sColourString)
+{
+	std::size_t nLastSemicolonPlus1 = 0;
+
+	// Check if sColourString contains nothing - if so, it's not valid
+	if (sColourString.empty()) return false;
+
+	for (uint8_t i = 0; i < 3; i++)
+	{
+		// Parse up to first non-number
+		std::string sBuffer = "";
+		for (size_t j = nLastSemicolonPlus1; j < sColourString.length(); j++, nLastSemicolonPlus1 = j + 1) {
+			if (sColourString[j] == ';') {
+				break;
+			}
+			else sBuffer.push_back(sColourString[j]);
+		}
+
+		// Check if buffer is empty - if so, it means that the colour string doesn't have enough colour values to make a colour
+		if (sBuffer == "") {
+			return false;
+		}
+		// Check if buffer is a number
+		if (!isNumberi(sBuffer)) {
+			return false;
+		}
+		// Check if number is below 256 (convert as well)
+		if (std::stoi(sBuffer) > 255) {
+			return false;
+		}
+	}
+
+	// Check if whole string checked - if not, it means that there's unwanted characters that are out of the scope of this algorithm, 
+	// and therefore the colour string is invalid
+	if (nLastSemicolonPlus1 - 1 < sColourString.length()) return false;
+
+	return true;
+}
+
+// Checks all ConfigObjMain.sColour colours to see if they are valid, in the 255;255;255 format.
+// Returns TRUE for all correct, FALSE for 1 or more variables incorrect.
+bool ValidateColourStringsANSI() {
+	bool bSuccess = true;
+
+	// Check validity of ANSI string values
+	if (!VerifyANSIColourString(ConfigObjMain.sColourGlobal)) {
+		ConfigObjMain.sColourGlobal = LWHT_ANSI;
+		bSuccess = false;
+	}
+	if (!VerifyANSIColourString(ConfigObjMain.sColourGlobalBack)) {
+		ConfigObjMain.sColourGlobalBack = BLK_ANSI;
+		bSuccess = false;
+	}
+	if (!VerifyANSIColourString(ConfigObjMain.sColourHighlight)) {
+		ConfigObjMain.sColourHighlight = LWHT_ANSI;
+		bSuccess = false;
+	}
+	if (!VerifyANSIColourString(ConfigObjMain.sColourHighlightBack)) {
+		ConfigObjMain.sColourHighlightBack = BLU_ANSI;
+		bSuccess = false;
+	}
+	if (!VerifyANSIColourString(ConfigObjMain.sColourTitle)) {
+		ConfigObjMain.sColourTitle = BLK_ANSI;
+		bSuccess = false;
+	}
+	if (!VerifyANSIColourString(ConfigObjMain.sColourTitleBack)) {
+		ConfigObjMain.sColourTitleBack = LCYN_ANSI;
+		bSuccess = false;
+	}
+	if (!VerifyANSIColourString(ConfigObjMain.sColourSubheading)) {
+		ConfigObjMain.sColourSubheading = LWHT_ANSI;
+		bSuccess = false;
+	}
+	if (!VerifyANSIColourString(ConfigObjMain.sColourSubheadingBack)) {
+		ConfigObjMain.sColourSubheadingBack = MAG_ANSI;
+		bSuccess = false;
+	}
+
+	return bSuccess;
+}
+
+// Function that hides console cursor and returns value of previous setting to set later.
+// Commonly used for progress bars to prevent cursor flickering
+//
+bool DisableCursorVisibility() {
+	bool bPreviousSetting = ConfigObjMain.bShowCursor;
+
+	// Set to FALSE and write cursor attributes
+	ConfigObjMain.bShowCursor = false;
+	SetCursorAttributes();
+
+	// Return previous setting in case user wants to put back to normal
+	return bPreviousSetting;
+}
+
 // Mission Impossible Theme Song in Beeps
 //
 void MissionImpossibleTheme() {

CommandFiles/CommandsFile.cpp

@@ -616,12 +616,18 @@ void RGBColourPresets() {
 				ConfigObjMain.sColourGlobal = RGBPreset[nOption - 1].sColourPresetForeground;
 				ConfigObjMain.sColourGlobalBack = RGBPreset[nOption - 1].sColourPresetBackground;
 
-				// Check validity of colours (only works when using WIN32 for now, a parser function for ANSI colours is coming soon)
+				// Check validity of colours
 				if (RGBPreset[nOption - 1].CheckIfAnsiPreset() == false) {
-					if (CheckColourWin32Validity() == false) {
+					if (ValidateColourStringsWin32() == false) {
 						bValidColours = false;
 					}
 				}
+				else if (RGBPreset[nOption - 1].CheckIfAnsiPreset() == true) {
+					if (ValidateColourStringsANSI() == false) {
+						bValidColours = false;
+					}
+				}
+
 			}
 
 			// Set colours
@@ -640,7 +646,13 @@ void RGBColourPresets() {
 			{
 				// Should be safe to change colours as colours have been validated/reset
 				colour(YLW, ConfigObjMain.sColourGlobalBack);
-				std::cout << wordWrap("Warning: This preset contains invalid WIN32 values, so one or all of the colours will be set to default to prevent errors.") << std::endl;
+				if (bAnsiVTSequences) {
+					std::cout << wordWrap("Warning: This preset contains invalid ANSI string values, so one or all of the colours will be set to default to prevent errors.") << std::endl;
+				}
+				else {
+					std::cout << wordWrap("Warning: This preset contains invalid WIN32 values, so one or all of the colours will be set to default to prevent errors.") << std::endl;
+				}
+
 			}
 
 			// Write to config file immediately (for current global colours)
@@ -766,7 +778,7 @@ void help(bool bFromTutorial) {
 		"This is an early alpha build of ZeeTerminal, with an entirely new engine and components.\nThis program is made in C++, with a few very small parts of C." +
 		"\n\nThis program uses the DirectShow API in the MediaPlayer command, which is licensed by Microsoft Corporation. (c) Microsoft Corporation.\n\n" +
 		"This program uses the BASS API in the AudioPlayer command, which is licensed by Un4Seen Developments. (c) Un4Seen Developments.\n\n" +
-		"\n(c) Ryan Zorkot, 2023. ZeeTerminal is licensed under the MIT License. The license and credits can be viewed on Page 4.\n\n"
+		"\n(c) Ryan Zorkot, 2024. ZeeTerminal is licensed under the MIT License. The license and credits can be viewed on Page 4.\n\n"
 		"  _____        _____                   _             _ \n"
 		" |__  /___  __|_   _|__ _ __ _ __ ___ (_)_ __   __ _| |\n"
 		"   / // _ \\/ _ \\| |/ _ \\ '__| '_ \\` _ \\| | '_ \\ / _\\` |\n"
@@ -776,7 +788,7 @@ void help(bool bFromTutorial) {
 
 		"___LICENSE AND CREDITS___\n\n"
 		"Massive thank-you to my dad, Hazem Zorkot, for assisting with this project, including with the logo design, name, high-level component ideas, and lots of heads-up messages along the way.\n\n"
-		"ZeeTerminal is licensed under the MIT License. Below is the license info:\n\nCopyright (c) 2023 Ryan Zorkot\n\n"
+		"ZeeTerminal is licensed under the MIT License. Below is the license info:\n\nCopyright (c) 2024 Ryan Zorkot\n\n"
 		"Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal"
 		" in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell"
 		" copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n"
@@ -2328,6 +2340,7 @@ void Commands(const std::string sCommand, char* cCommandArgs, const std::string
 	else if (sCommand == "stopwatch" || sCommand == "16") {
 
 		bool bSkipStartScreen = false;
+		bool bUserCursorVisibilitySetting = true;
 
 		// Arguments interface
 		for (int i = 0; i < nArgArraySize; i++) {
@@ -2361,6 +2374,10 @@ void Commands(const std::string sCommand, char* cCommandArgs, const std::string
 		// Start stopwatch
 		std::cout << '\n';
 		std::chrono::duration<long double> elapsedSeconds;
+
+		// Disable cursor visibility
+		bUserCursorVisibilitySetting = DisableCursorVisibility();
+
 		auto start = std::chrono::steady_clock::now();
 
 		while (!_kbhit()) { // exit on keypress
@@ -2386,6 +2403,10 @@ void Commands(const std::string sCommand, char* cCommandArgs, const std::string
 		std::cout << " seconds.\n\n";
 
 		ClearKeyboardBuffer();
+		// Reset cursor visibility to user settings
+		ConfigObjMain.bShowCursor = bUserCursorVisibilitySetting;
+		SetCursorAttributes();
+
 		return;
 	}
 
@@ -2497,8 +2518,8 @@ void Commands(const std::string sCommand, char* cCommandArgs, const std::string
 
 	// Timer
 	else if (sCommand == "timer" || sCommand == "18") {
-
 		long double dInput = 0;
+		bool bUserCursorVisibilitySetting = true;
 
 		CentreColouredText(" ___TIMER___ ", 1);
 		std::cout << '\n';
@@ -2540,6 +2561,9 @@ void Commands(const std::string sCommand, char* cCommandArgs, const std::string
 		std::cout << wordWrap("\nPress any key to exit the timer.\n\n");
 		colour(ConfigObjMain.sColourGlobal, ConfigObjMain.sColourGlobalBack);
 
+		// Disable cursor visibility
+		bUserCursorVisibilitySetting = DisableCursorVisibility();
+
 		std::chrono::duration<long double> elapsedTime{};
 		auto start = std::chrono::steady_clock::now();
 		auto time = std::chrono::steady_clock::now();
@@ -2584,6 +2608,10 @@ void Commands(const std::string sCommand, char* cCommandArgs, const std::string
 		MessageBeep(MB_OK);
 		colour(ConfigObjMain.sColourGlobal, ConfigObjMain.sColourGlobalBack);
 
+		// Reset cursor visibility to user settings
+		ConfigObjMain.bShowCursor = bUserCursorVisibilitySetting;
+		SetCursorAttributes();
+
 		return;
 
 	}

CommandFiles/Settings.cpp

@@ -389,6 +389,7 @@ void AnsiSettings(short int nChoice = 0) {
 
 			// Set new colours
 			ColourTypeSwitch(); // This will write to config file by default
+			SetCursorAttributes(); // Set cursor attributes in case user was using non-ANSI setting - make cursor attributes correct
 			colour(ConfigObjMain.sColourGlobal, ConfigObjMain.sColourGlobalBack);
 			cls(); // Set colours to whole screen
 
@@ -419,6 +420,7 @@ void AnsiSettings(short int nChoice = 0) {
 
 			// Set new colours
 			ColourTypeSwitch(); // This will write to config file by default
+			SetCursorAttributes(); // Set cursor attributes in case user was using ANSI setting - make cursor attributes correct
 			colour(ConfigObjMain.sColourGlobal, ConfigObjMain.sColourGlobalBack);
 			cls(); // Set to whole screen
 

Definitions.h

@@ -119,6 +119,10 @@ typedef void* LPVOID;
 //
 // Define wordWrap function with default arguments
 std::string wordWrap(std::string, long long int = -1, long long int = 0);
+
+// Command Asset Function definition - widely used in other engines, so should be defined here
+bool DisableCursorVisibility();
+
 //
 // The rest \|/
 //

Engine/FileOpenGUIEngine.cpp

@@ -71,7 +71,7 @@ class FileOpenGUIEngine {
 		IFileOpenDialog* pFileOpen = NULL;
 		IShellItem* pItem = NULL;
 
-		LPWSTR pwszFilePath = NULL;
+		LPWSTR pwszFilePath = (LPWSTR)"";
 
 		// Initialise COM libraries
 		hr = CoInitializeEx(NULL, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE);

Engine/LogFile-System.cpp

@@ -361,7 +361,7 @@ class LogFileSystem {
 			VerbosityDisplay("In LogFileSystem::CreateLogFile(): ERROR - Unknown error on std::ofstream init to log file. Failed to create log file.\n", nObjectID, false, true);
 
 			// Log to Windows Log Database
-			std::vector<std::string> vsErrorInfo{
+			std::vector<std::string> vsErrorInfo {
 				"In LogFileSystem::CreateLogFile(): ERROR - Unknown error on std::ofstream init to log file. Failed to create log file.",
 				"Context: Failed to create and write to new log file, due to out-stream failure.",
 				"Object ID: " + std::to_string(nObjectID),
@@ -378,7 +378,7 @@ class LogFileSystem {
 		UpdateProgramInfo();
 
 		// 3. Write global log title surrounded with "___", and system/program info
-		CreateLogFileOut << "___" + sLogFileName + "___\n\n" << sSystemInfoString << "\n" << sProgramInfoString << "\n\n__LOG START__\n# FORMAT: <Time> <Time since program execution> <Object ID> <Message Type> <Info/Message>\n# If the Object ID of a line equates to 10000, there is no object associated with that line.\n# Anything higher than that means that the line is associated with an object.\n\n";
+		CreateLogFileOut << "# ___" + sLogFileName + "___\n\n" << sSystemInfoString << "\n" << sProgramInfoString << "\n\n# __LOG START__\n# FORMAT: <Time> <Time since program execution> <Object ID> <Message Type> <Info/Message>\n# If the Object ID of a line equates to 10000, there is no object associated with that line.\n# Anything higher than that means that the line is associated with an object.\n\n";
 
 		// 4. Exit
 		CreateLogFileOut.close();