diff --git a/Documentation/User/History.txt b/Documentation/User/History.txt index 401b9b6ccc..3b3d488575 100644 --- a/Documentation/User/History.txt +++ b/Documentation/User/History.txt @@ -88,6 +88,10 @@ Misc: - Builds are now digitally signed. - All menus are now drawn in the standard system style, rather than a custom style. +- More detailed help information is now available when starting + Explorer++ from the command line with the --help flag. Each of + the available options is listed and briefly described. The + names of some of the options have also been updated. - The format used to display dates has been updated. Previously, the date and time were separated by a comma. Now, they're separated by a space. diff --git a/Explorer++/Explorer++/CommandLine.cpp b/Explorer++/Explorer++/CommandLine.cpp new file mode 100644 index 0000000000..0e3ba39880 --- /dev/null +++ b/Explorer++/Explorer++/CommandLine.cpp @@ -0,0 +1,226 @@ +// Copyright (C) Explorer++ Project +// SPDX-License-Identifier: GPL-3.0-only +// See LICENSE in the top level directory + +#include "stdafx.h" +#include "CommandLine.h" +#include "Explorer++_internal.h" +#include "MainResource.h" +#include "../Helper/Macros.h" +#include "../Helper/ProcessHelper.h" +#include "../Helper/SetDefaultFileManager.h" +#include "../Helper/ShellHelper.h" +#include "../Helper/StringHelper.h" +#include "../ThirdParty/CLI11/CLI11.hpp" +#include +#include + +extern std::vector g_TabDirs; + +struct CommandLineSettings +{ + bool clearRegistrySettings; + bool enableLogging; + bool enablePlugins; + bool removeAsDefault; + bool setAsDefault; + std::string language; + bool jumplistNewTab; + std::vector directories; +}; + +boost::optional ProcessCommandLineSettings(const CommandLineSettings& commandLineSettings); +void OnClearRegistrySettings(); +void OnRemoveAsDefault(); +void OnSetAsDefault(); +void OnJumplistNewTab(); + +boost::optional CommandLine::ProcessCommandLine() +{ + CLI::App app("Explorer++"); + + CommandLineSettings commandLineSettings; + + commandLineSettings.clearRegistrySettings = false; + app.add_flag("--clear-registry-settings", commandLineSettings.clearRegistrySettings, "Clear existing registry settings"); + + commandLineSettings.enableLogging = false; + app.add_flag("--enable-logging", commandLineSettings.enableLogging, "Enable logging"); + + commandLineSettings.enablePlugins = false; + app.add_flag("--enable-plugins", commandLineSettings.enablePlugins, "Enable the Lua plugin system"); + + commandLineSettings.removeAsDefault = false; + auto removeAsDefaultOption = app.add_flag("--remove-as-default", commandLineSettings.removeAsDefault, "Remove Explorer++ as the default file manager (requires administrator privileges)"); + + commandLineSettings.setAsDefault = false; + auto setAsDefaultOption = app.add_flag("--set-as-default", commandLineSettings.setAsDefault, "Set Explorer++ as the default file manager (requires administrator privileges)"); + + removeAsDefaultOption->excludes(setAsDefaultOption); + setAsDefaultOption->excludes(removeAsDefaultOption); + + app.add_option("--language", commandLineSettings.language, "Allows you to select your desired language. Should be a two-letter language code (e.g. FR, RU, etc)."); + + app.add_option("directories", commandLineSettings.directories, "Directories to open"); + + // The options in this group are only used internally by the + // application. They're not directly exposed to users. + CLI::App *privateCommands = app.add_subcommand("private"); + privateCommands->group(""); + + privateCommands->add_flag(wstrToStr(NExplorerplusplus::JUMPLIST_TASK_NEWTAB_ARGUMENT), commandLineSettings.jumplistNewTab); + + try + { + app.parse(__argc, __argv); + } + catch (const CLI::ParseError & e) + { + return ExitInfo{ app.exit(e) }; + } + + return ProcessCommandLineSettings(commandLineSettings); +} + +boost::optional ProcessCommandLineSettings(const CommandLineSettings& commandLineSettings) +{ + if (commandLineSettings.jumplistNewTab) + { + OnJumplistNewTab(); + return CommandLine::ExitInfo{ EXIT_SUCCESS }; + } + + if (commandLineSettings.clearRegistrySettings) + { + OnClearRegistrySettings(); + } + + if (commandLineSettings.enableLogging) + { + boost::log::core::get()->set_logging_enabled(true); + } + + if (commandLineSettings.enablePlugins) + { + g_enablePlugins = true; + } + + if (commandLineSettings.removeAsDefault) + { + OnRemoveAsDefault(); + } + else if (commandLineSettings.setAsDefault) + { + OnSetAsDefault(); + } + + if (!commandLineSettings.language.empty()) + { + g_bForceLanguageLoad = TRUE; + + StringCchCopy(g_szLang, SIZEOF_ARRAY(g_szLang), strToWstr(commandLineSettings.language).c_str()); + } + + TCHAR processImageName[MAX_PATH]; + GetProcessImageName(GetCurrentProcessId(), processImageName, SIZEOF_ARRAY(processImageName)); + + boost::filesystem::path processDirectoryPath(processImageName); + processDirectoryPath.remove_filename(); + + for (const std::string& directory : commandLineSettings.directories) + { + TCHAR szParsingPath[MAX_PATH]; + DecodePath(strToWstr(directory).c_str(), processDirectoryPath.wstring().c_str(), szParsingPath, SIZEOF_ARRAY(szParsingPath)); + + g_TabDirs.push_back(szParsingPath); + } + + return boost::none; +} + +void OnClearRegistrySettings() +{ + LSTATUS lStatus; + + lStatus = SHDeleteKey(HKEY_CURRENT_USER, NExplorerplusplus::REG_MAIN_KEY); + + if (lStatus == ERROR_SUCCESS) + MessageBox(NULL, _T("Settings cleared successfully."), NExplorerplusplus::APP_NAME, MB_OK); + else + MessageBox(NULL, _T("Settings could not be cleared."), NExplorerplusplus::APP_NAME, MB_ICONWARNING); +} + +void OnRemoveAsDefault() +{ + BOOL bSuccess = NDefaultFileManager::RemoveAsDefaultFileManagerFileSystem(SHELL_DEFAULT_INTERNAL_COMMAND_NAME); + + /* Language hasn't been fully specified at this point, so + can't load success/error message from language dll. Simply show + a hardcoded success/error message. */ + if (bSuccess) + { + MessageBox(NULL, _T("Explorer++ successfully removed as default file manager."), + NExplorerplusplus::APP_NAME, MB_OK); + } + else + { + MessageBox(NULL, _T("Could not remove Explorer++ as default file manager. Please \ +ensure you have administrator privileges."), NExplorerplusplus::APP_NAME, MB_ICONWARNING | MB_OK); + } +} + +void OnSetAsDefault() +{ + TCHAR menuText[256]; + LoadString(GetModuleHandle(0), IDS_OPEN_IN_EXPLORERPLUSPLUS, + menuText, SIZEOF_ARRAY(menuText)); + + BOOL bSuccess = NDefaultFileManager::SetAsDefaultFileManagerFileSystem( + SHELL_DEFAULT_INTERNAL_COMMAND_NAME, menuText); + + if (bSuccess) + { + MessageBox(NULL, _T("Explorer++ successfully set as default file manager."), + NExplorerplusplus::APP_NAME, MB_OK); + } + else + { + MessageBox(NULL, _T("Could not set Explorer++ as default file manager. Please \ +ensure you have administrator privileges."), NExplorerplusplus::APP_NAME, MB_ICONWARNING | MB_OK); + } +} + +void OnJumplistNewTab() +{ + /* This will be called when the user clicks the + 'New Tab' item on the tasks menu in Windows 7 and above. + Find the already opened version of Explorer++, + and tell it to open a new tab. */ + HANDLE hMutex; + + hMutex = CreateMutex(NULL, TRUE, _T("Explorer++")); + + if (GetLastError() == ERROR_ALREADY_EXISTS) + { + HWND hPrev; + + hPrev = FindWindow(NExplorerplusplus::CLASS_NAME, NULL); + + if (hPrev != NULL) + { + COPYDATASTRUCT cds; + + cds.cbData = 0; + cds.lpData = NULL; + SendMessage(hPrev, WM_COPYDATA, NULL, (LPARAM)& cds); + + SetForegroundWindow(hPrev); + ShowWindow(hPrev, SW_SHOW); + } + } + + if (hMutex != NULL) + { + CloseHandle(hMutex); + } +} \ No newline at end of file diff --git a/Explorer++/Explorer++/CommandLine.h b/Explorer++/Explorer++/CommandLine.h new file mode 100644 index 0000000000..1ef031a589 --- /dev/null +++ b/Explorer++/Explorer++/CommandLine.h @@ -0,0 +1,17 @@ +// Copyright (C) Explorer++ Project +// SPDX-License-Identifier: GPL-3.0-only +// See LICENSE in the top level directory + +#pragma once + +#include + +namespace CommandLine +{ + struct ExitInfo + { + int exitCode; + }; + + boost::optional ProcessCommandLine(); +} \ No newline at end of file diff --git a/Explorer++/Explorer++/Console.cpp b/Explorer++/Explorer++/Console.cpp new file mode 100644 index 0000000000..1425e218bd --- /dev/null +++ b/Explorer++/Explorer++/Console.cpp @@ -0,0 +1,104 @@ +// Copyright (C) Explorer++ Project +// SPDX-License-Identifier: GPL-3.0-only +// See LICENSE in the top level directory + +#include "stdafx.h" +#include "Console.h" +#include + +bool RedirectConsoleIO(); + +// The code in this file has been sourced from the following Stack Overflow +// answer: +// https://stackoverflow.com/a/55875595 +// It doesn't make much sense to rewrite it, given that it's relatively simple +// and performs a specific function (so any rewritten code would look about the +// same). + +bool Console::AttachParentConsole() +{ + bool result = false; + + // Release any current console and redirect IO to NUL + ReleaseConsole(); + + // Attempt to attach to parent process's console + if (AttachConsole(ATTACH_PARENT_PROCESS)) + { + result = RedirectConsoleIO(); + } + + return result; +} + +bool Console::ReleaseConsole() +{ + bool result = true; + FILE* fp; + + // Just to be safe, redirect standard IO to NUL before releasing. + + // Redirect STDIN to NUL + if (freopen_s(&fp, "NUL:", "r", stdin) != 0) + result = false; + else + setvbuf(stdin, NULL, _IONBF, 0); + + // Redirect STDOUT to NUL + if (freopen_s(&fp, "NUL:", "w", stdout) != 0) + result = false; + else + setvbuf(stdout, NULL, _IONBF, 0); + + // Redirect STDERR to NUL + if (freopen_s(&fp, "NUL:", "w", stderr) != 0) + result = false; + else + setvbuf(stderr, NULL, _IONBF, 0); + + // Detach from console + if (!FreeConsole() || !result) + return false; + + return true; +} + +bool RedirectConsoleIO() +{ + bool result = true; + FILE* fp; + + // Redirect STDIN if the console has an input handle + if (GetStdHandle(STD_INPUT_HANDLE) != INVALID_HANDLE_VALUE) + if (freopen_s(&fp, "CONIN$", "r", stdin) != 0) + result = false; + else + setvbuf(stdin, NULL, _IONBF, 0); + + // Redirect STDOUT if the console has an output handle + if (GetStdHandle(STD_OUTPUT_HANDLE) != INVALID_HANDLE_VALUE) + if (freopen_s(&fp, "CONOUT$", "w", stdout) != 0) + result = false; + else + setvbuf(stdout, NULL, _IONBF, 0); + + // Redirect STDERR if the console has an error handle + if (GetStdHandle(STD_ERROR_HANDLE) != INVALID_HANDLE_VALUE) + if (freopen_s(&fp, "CONOUT$", "w", stderr) != 0) + result = false; + else + setvbuf(stderr, NULL, _IONBF, 0); + + // Make C++ standard streams point to console as well. + std::ios::sync_with_stdio(true); + + // Clear the error state for each of the C++ standard streams. + std::wcout.clear(); + std::cout.clear(); + std::wcerr.clear(); + std::cerr.clear(); + std::wcin.clear(); + std::cin.clear(); + + return result; +} \ No newline at end of file diff --git a/Explorer++/Explorer++/Console.h b/Explorer++/Explorer++/Console.h new file mode 100644 index 0000000000..efb8437007 --- /dev/null +++ b/Explorer++/Explorer++/Console.h @@ -0,0 +1,11 @@ +// Copyright (C) Explorer++ Project +// SPDX-License-Identifier: GPL-3.0-only +// See LICENSE in the top level directory + +#pragma once + +namespace Console +{ + bool AttachParentConsole(); + bool ReleaseConsole(); +} \ No newline at end of file diff --git a/Explorer++/Explorer++/Explorer++.vcxproj b/Explorer++/Explorer++/Explorer++.vcxproj index b79c3e018a..7c742cd184 100644 --- a/Explorer++/Explorer++/Explorer++.vcxproj +++ b/Explorer++/Explorer++/Explorer++.vcxproj @@ -319,6 +319,8 @@ + + @@ -449,6 +451,8 @@ + + diff --git a/Explorer++/Explorer++/Explorer++.vcxproj.filters b/Explorer++/Explorer++/Explorer++.vcxproj.filters index 03b28f08b1..91222190fa 100644 --- a/Explorer++/Explorer++/Explorer++.vcxproj.filters +++ b/Explorer++/Explorer++/Explorer++.vcxproj.filters @@ -343,6 +343,12 @@ Core + + Core + + + Core + @@ -663,6 +669,12 @@ Core + + Core + + + Core + diff --git a/Explorer++/Explorer++/Explorer++_internal.h b/Explorer++/Explorer++/Explorer++_internal.h index b22412f969..3adbdf15be 100644 --- a/Explorer++/Explorer++/Explorer++_internal.h +++ b/Explorer++/Explorer++/Explorer++_internal.h @@ -25,7 +25,7 @@ namespace NExplorerplusplus /* Command line arguments supplied to the program for each jump list task. */ - const TCHAR JUMPLIST_TASK_NEWTAB_ARGUMENT[] = _T("-open_new_tab"); + const TCHAR JUMPLIST_TASK_NEWTAB_ARGUMENT[] = _T("--open-new-tab"); } /* Used when setting Explorer++ as the default diff --git a/Explorer++/Explorer++/TabHandler.cpp b/Explorer++/Explorer++/TabHandler.cpp index eb4f80e01c..8aa67be204 100644 --- a/Explorer++/Explorer++/TabHandler.cpp +++ b/Explorer++/Explorer++/TabHandler.cpp @@ -35,7 +35,7 @@ UINT TabCtrlStyles = WS_VISIBLE|WS_CHILD|TCS_FOCUSNEVER|TCS_SINGLELINE| extern LRESULT CALLBACK ListViewProcStub(HWND hwnd,UINT uMsg,WPARAM wParam,LPARAM lParam,UINT_PTR uIdSubclass,DWORD_PTR dwRefData); -extern std::list g_TabDirs; +extern std::vector g_TabDirs; void Explorerplusplus::InitializeTabs(void) { diff --git a/Explorer++/Explorer++/WinMain.cpp b/Explorer++/Explorer++/WinMain.cpp index 8a18e2f662..84ec5dda98 100644 --- a/Explorer++/Explorer++/WinMain.cpp +++ b/Explorer++/Explorer++/WinMain.cpp @@ -8,6 +8,8 @@ #include "stdafx.h" #include "Explorer++.h" +#include "CommandLine.h" +#include "Console.h" #include "Explorer++_internal.h" #include "Logging.h" #include "MainResource.h" @@ -18,9 +20,10 @@ #include "../Helper/Logging.h" #include "../Helper/Macros.h" #include "../Helper/ProcessHelper.h" -#include "../Helper/SetDefaultFileManager.h" -#include "../Helper/ShellHelper.h" +#include "../ThirdParty/CLI11/CLI11.hpp" +#include +#pragma warning(disable:4459) // declaration of 'boost_scope_exit_aux_args' hides global declaration /* Default window size/position. */ #define DEFAULT_WINDOWPOS_LEFT_PERCENTAGE 0.02 @@ -34,16 +37,13 @@ typedef BOOL (WINAPI *MINIDUMPWRITEDUMP)( PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam, PMINIDUMP_CALLBACK_INFORMATION CallbackParam); -BOOL ProcessCommandLine(TCHAR *pCommandLine); -void ShowUsage(void); -void ClearRegistrySettings(void); ATOM RegisterMainWindowClass(HINSTANCE hInstance); LONG WINAPI MyUnhandledExceptionFilter(struct _EXCEPTION_POINTERS *pExceptionInfo); DWORD dwControlClasses = ICC_BAR_CLASSES|ICC_COOL_CLASSES| ICC_LISTVIEW_CLASSES|ICC_USEREX_CLASSES|ICC_STANDARD_CLASSES| ICC_LINK_CLASS; -std::list g_TabDirs; +std::vector g_TabDirs; /* Modeless dialog handles. */ HWND g_hwndSearch; @@ -58,187 +58,6 @@ HACCEL g_hAccl; bool g_enablePlugins = false; -/* - * Processes the specified command line. - * - * Command line options: - * -l Specifies the language for Explorer++ to use. - * /? Causes Explorer++ to show a small help message and exit. - * - * Directories can also be passed at any point (no preceding - * arguments needed). - * - * Paths on the command line are automatically expanded by - * the shell. - */ -BOOL ProcessCommandLine(TCHAR *pCommandLine) -{ - TCHAR szPath[MAX_PATH]; - TCHAR *pszCommandLine = NULL; - BOOL bExit = FALSE; - - g_TabDirs.clear(); - - /* The first token will just be the executable name, - and can be ignored. */ - pszCommandLine = GetToken(pCommandLine,szPath); - - while((pszCommandLine = GetToken(pszCommandLine,szPath)) != NULL) - { - /* Check to see if the user has requested the help page. */ - if(StrCmp(szPath,_T("/?")) == 0) - { - /* Show program usage information and then exit. */ - ShowUsage(); - - bExit = TRUE; - } - - if(lstrcmp(szPath,_T("-l")) == 0) - { - pszCommandLine = GetToken(pszCommandLine,szPath); - - if(pszCommandLine != NULL) - { - g_bForceLanguageLoad = TRUE; - - StringCchCopy(g_szLang,SIZEOF_ARRAY(g_szLang),szPath); - } - } - else if(lstrcmp(szPath,_T("-clear_settings")) == 0) - { - ClearRegistrySettings(); - } - else if(lstrcmp(szPath,_T("-remove_as_default")) == 0) - { - BOOL bSuccess; - - bSuccess = NDefaultFileManager::RemoveAsDefaultFileManagerFileSystem(SHELL_DEFAULT_INTERNAL_COMMAND_NAME); - - /* Language hasn't been fully specified at this point, so - can't load success/error message from language dll. Simply show - a hardcoded success/error message. */ - if(bSuccess) - { - MessageBox(NULL,_T("Explorer++ successfully removed as default file manager."), - NExplorerplusplus::APP_NAME,MB_OK); - } - else - { - MessageBox(NULL,_T("Could not remove Explorer++ as default file manager. Please \ -ensure you have administrator privileges."),NExplorerplusplus::APP_NAME,MB_ICONWARNING|MB_OK); - } - } - else if(lstrcmp(szPath,_T("-set_as_default")) == 0) - { - TCHAR menuText[256]; - LoadString(GetModuleHandle(0), IDS_OPEN_IN_EXPLORERPLUSPLUS, - menuText, SIZEOF_ARRAY(menuText)); - - BOOL bSuccess = NDefaultFileManager::SetAsDefaultFileManagerFileSystem( - SHELL_DEFAULT_INTERNAL_COMMAND_NAME, menuText); - - if(bSuccess) - { - MessageBox(NULL,_T("Explorer++ successfully set as default file manager."), - NExplorerplusplus::APP_NAME,MB_OK); - } - else - { - MessageBox(NULL,_T("Could not set Explorer++ as default file manager. Please \ -ensure you have administrator privileges."),NExplorerplusplus::APP_NAME,MB_ICONWARNING|MB_OK); - } - } - else if(lstrcmp(szPath,NExplorerplusplus::JUMPLIST_TASK_NEWTAB_ARGUMENT) == 0) - { - /* This will be called when the user clicks the - 'New Tab' item on the tasks menu in Windows 7. - Find the already opened version of Explorer++, - and tell it to open a new tab. */ - HANDLE hMutex; - - hMutex = CreateMutex(NULL,TRUE,_T("Explorer++")); - - if(GetLastError() == ERROR_ALREADY_EXISTS) - { - HWND hPrev; - - hPrev = FindWindow(NExplorerplusplus::CLASS_NAME,NULL); - - if(hPrev != NULL) - { - COPYDATASTRUCT cds; - - cds.cbData = 0; - cds.lpData = NULL; - SendMessage(hPrev,WM_COPYDATA,NULL,(LPARAM)&cds); - - SetForegroundWindow(hPrev); - ShowWindow(hPrev,SW_SHOW); - } - } - - if(hMutex != NULL) - CloseHandle(hMutex); - - bExit = TRUE; - } - else if(lstrcmp(szPath,_T("-enable_logging")) == 0) - { - boost::log::core::get()->set_logging_enabled(true); - } - else if (lstrcmp(szPath, _T("-enable_plugins")) == 0) - { - g_enablePlugins = true; - } - else - { - TCHAR szParsingPath[MAX_PATH]; - TCHAR szCurrentDirectory[MAX_PATH]; - - GetProcessImageName(GetCurrentProcessId(),szCurrentDirectory, - SIZEOF_ARRAY(szCurrentDirectory)); - PathRemoveFileSpec(szCurrentDirectory); - - DecodePath(szPath,szCurrentDirectory,szParsingPath,SIZEOF_ARRAY(szParsingPath)); - g_TabDirs.push_back(szParsingPath); - } - } - - return bExit; -} - -/* - * Shows a brief message explaining the - * command line parameters Explorer++ - * uses. - */ -void ShowUsage(void) -{ - TCHAR UsageString[] = _T("Usage:\nexplorer++.exe dir1 dir2 ... dirN\n \ -where dir1 to dirN are the directories to \ -open.\n\ne.g. explorer++.exe C:\\ D:\\\nwill open the \ -directories C:\\ and D:\\, each in their own tabs\n\n\ -Virtual folders can be opened simply by \ -supplying their name:\n\ -e.g. explorer++.exe \"control panel\"\nwill open the \ -Control Panel\n"); - - MessageBox(NULL,UsageString,NExplorerplusplus::APP_NAME,MB_OK); -} - -void ClearRegistrySettings(void) -{ - LSTATUS lStatus; - - lStatus = SHDeleteKey(HKEY_CURRENT_USER, NExplorerplusplus::REG_MAIN_KEY); - - if(lStatus == ERROR_SUCCESS) - MessageBox(NULL,_T("Settings cleared successfully."),NExplorerplusplus::APP_NAME,MB_OK); - else - MessageBox(NULL,_T("Settings could not be cleared."),NExplorerplusplus::APP_NAME,MB_ICONWARNING); -} - ATOM RegisterMainWindowClass(HINSTANCE hInstance) { WNDCLASSEX wcex; @@ -324,7 +143,6 @@ int WINAPI WinMain(HINSTANCE hInstance,HINSTANCE hPrevInstance, HMODULE hRichEditLib; HWND hwnd; HANDLE hMutex = NULL; - TCHAR *pCommandLine = NULL; MSG msg; LONG res; BOOL bExit = FALSE; @@ -356,9 +174,21 @@ int WINAPI WinMain(HINSTANCE hInstance,HINSTANCE hPrevInstance, OleInitialize(NULL); - pCommandLine = GetCommandLine(); + bool consoleAttached = Console::AttachParentConsole(); + + BOOST_SCOPE_EXIT(consoleAttached) { + if (consoleAttached) + { + Console::ReleaseConsole(); + } + } BOOST_SCOPE_EXIT_END + + auto exitInfo = CommandLine::ProcessCommandLine(); - bExit = ProcessCommandLine(pCommandLine); + if (exitInfo) + { + return exitInfo->exitCode; + } InitializeLogging(NExplorerplusplus::LOG_FILENAME); diff --git a/Explorer++/Helper/StringHelper.cpp b/Explorer++/Helper/StringHelper.cpp index f361bbf8cc..0aecc69f27 100644 --- a/Explorer++/Helper/StringHelper.cpp +++ b/Explorer++/Helper/StringHelper.cpp @@ -5,7 +5,7 @@ #include "stdafx.h" #include "StringHelper.h" #include "Macros.h" - +#include BOOL CheckWildcardMatchInternal(const TCHAR *szWildcard, const TCHAR *szString, BOOL bCaseSensitive); @@ -321,49 +321,6 @@ void ReplaceCharacterWithString(const TCHAR *szBaseString, TCHAR *szOutput, StringCchCopy(szOutput, cchMax, szNewString); } -TCHAR *GetToken(TCHAR *ptr, TCHAR *Buffer) -{ - TCHAR *p; - int i = 0; - - if(ptr == NULL || *ptr == '\0') - { - *Buffer = NULL; - return NULL; - } - - p = ptr; - - while(*p == ' ' || *p == '\t') - p++; - - if(*p == '\"') - { - p++; - while(*p != '\0' && *p != '\"') - { - Buffer[i++] = *p; - p++; - } - p++; - } - else - { - while(*p != '\0' && *p != ' ' && *p != '\t') - { - Buffer[i++] = *p; - p++; - } - } - - Buffer[i] = '\0'; - - while(*p == ' ' || *p == '\t') - p++; - - return p; -} - void TrimStringLeft(std::wstring &str, const std::wstring &strWhitespace) { size_t pos = str.find_first_not_of(strWhitespace); @@ -380,4 +337,16 @@ void TrimString(std::wstring &str, const std::wstring &strWhitespace) { TrimStringLeft(str, strWhitespace); TrimStringRight(str, strWhitespace); +} + +std::string wstrToStr(std::wstring source) +{ + std::wstring_convert> converter; + return converter.to_bytes(source); +} + +std::wstring strToWstr(std::string source) +{ + std::wstring_convert> converter; + return converter.from_bytes(source); } \ No newline at end of file diff --git a/Explorer++/Helper/StringHelper.h b/Explorer++/Helper/StringHelper.h index 53b6a06d91..b818c478b1 100644 --- a/Explorer++/Helper/StringHelper.h +++ b/Explorer++/Helper/StringHelper.h @@ -24,7 +24,8 @@ BOOL CheckWildcardMatch(const TCHAR *szWildcard, const TCHAR *szString, BOOL bCa void ReplaceCharacter(TCHAR *str, TCHAR ch, TCHAR chReplacement); void ReplaceCharacterWithString(const TCHAR *szBaseString, TCHAR *szOutput, UINT cchMax, TCHAR chToReplace, const TCHAR *szReplacement); -TCHAR *GetToken(TCHAR *ptr, TCHAR *Buffer); void TrimStringLeft(std::wstring &str, const std::wstring &strWhitespace); void TrimStringRight(std::wstring &str, const std::wstring &strWhitespace); -void TrimString(std::wstring &str, const std::wstring &strWhitespace); \ No newline at end of file +void TrimString(std::wstring &str, const std::wstring &strWhitespace); +std::string wstrToStr(std::wstring source); +std::wstring strToWstr(std::string source); \ No newline at end of file diff --git a/Explorer++/ThirdParty/CLI11/CLI11.hpp b/Explorer++/ThirdParty/CLI11/CLI11.hpp new file mode 100644 index 0000000000..ae58c8152f --- /dev/null +++ b/Explorer++/ThirdParty/CLI11/CLI11.hpp @@ -0,0 +1,4641 @@ +#pragma once + +// CLI11: Version 1.7.1 +// Originally designed by Henry Schreiner +// https://github.com/CLIUtils/CLI11 +// +// This is a standalone header file generated by MakeSingleHeader.py in CLI11/scripts +// from: v1.7.1 +// +// From LICENSE: +// +// CLI11 1.7 Copyright (c) 2017-2019 University of Cincinnati, developed by Henry +// Schreiner under NSF AWARD 1414736. All rights reserved. +// +// Redistribution and use in source and binary forms of CLI11, with or without +// modification, are permitted provided that the following conditions are met: +// +// 1. Redistributions of source code must retain the above copyright notice, this +// list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// 3. Neither the name of the copyright holder nor the names of its contributors +// may be used to endorse or promote products derived from this software without +// specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +// Standard combined includes: + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +// Verbatim copy from CLI/Version.hpp: + + +#define CLI11_VERSION_MAJOR 1 +#define CLI11_VERSION_MINOR 7 +#define CLI11_VERSION_PATCH 1 +#define CLI11_VERSION "1.7.1" + + + + +// Verbatim copy from CLI/Macros.hpp: + + +// The following version macro is very similar to the one in PyBind11 +#if !(defined(_MSC_VER) && __cplusplus == 199711L) && !defined(__INTEL_COMPILER) +#if __cplusplus >= 201402L +#define CLI11_CPP14 +#if __cplusplus >= 201703L +#define CLI11_CPP17 +#if __cplusplus > 201703L +#define CLI11_CPP20 +#endif +#endif +#endif +#elif defined(_MSC_VER) && __cplusplus == 199711L +// MSVC sets _MSVC_LANG rather than __cplusplus (supposedly until the standard is fully implemented) +// Unless you use the /Zc:__cplusplus flag on Visual Studio 2017 15.7 Preview 3 or newer +#if _MSVC_LANG >= 201402L +#define CLI11_CPP14 +#if _MSVC_LANG > 201402L && _MSC_VER >= 1910 +#define CLI11_CPP17 +#if __MSVC_LANG > 201703L && _MSC_VER >= 1910 +#define CLI11_CPP20 +#endif +#endif +#endif +#endif + +#if defined(CLI11_CPP14) +#define CLI11_DEPRECATED(reason) [[deprecated(reason)]] +#elif defined(_MSC_VER) +#define CLI11_DEPRECATED(reason) __declspec(deprecated(reason)) +#else +#define CLI11_DEPRECATED(reason) __attribute__((deprecated(reason))) +#endif + + + + +// Verbatim copy from CLI/Optional.hpp: + +#ifdef __has_include + +// You can explicitly enable or disable support +// by defining these to 1 or 0. +#if defined(CLI11_CPP17) && __has_include() && \ + !defined(CLI11_STD_OPTIONAL) +#define CLI11_STD_OPTIONAL 1 +#elif !defined(CLI11_STD_OPTIONAL) +#define CLI11_STD_OPTIONAL 0 +#endif + +#if defined(CLI11_CPP14) && __has_include() && \ + !defined(CLI11_EXPERIMENTAL_OPTIONAL) \ + && (!defined(CLI11_STD_OPTIONAL) || CLI11_STD_OPTIONAL == 0) +#define CLI11_EXPERIMENTAL_OPTIONAL 1 +#elif !defined(CLI11_EXPERIMENTAL_OPTIONAL) +#define CLI11_EXPERIMENTAL_OPTIONAL 0 +#endif + +#if __has_include() && !defined(CLI11_BOOST_OPTIONAL) +#include +#if BOOST_VERSION >= 105800 +#define CLI11_BOOST_OPTIONAL 1 +#endif +#elif !defined(CLI11_BOOST_OPTIONAL) +#define CLI11_BOOST_OPTIONAL 0 +#endif + +#endif + +#if CLI11_STD_OPTIONAL +#include +#endif +#if CLI11_EXPERIMENTAL_OPTIONAL +#include +#endif +#if CLI11_BOOST_OPTIONAL +#include +#endif + + +// From CLI/Version.hpp: + + + +// From CLI/Macros.hpp: + + + +// From CLI/Optional.hpp: + +namespace CLI { + +#if CLI11_STD_OPTIONAL +template std::istream &operator>>(std::istream &in, std::optional &val) { + T v; + in >> v; + val = v; + return in; +} +#endif + +#if CLI11_EXPERIMENTAL_OPTIONAL +template std::istream &operator>>(std::istream &in, std::experimental::optional &val) { + T v; + in >> v; + val = v; + return in; +} +#endif + +#if CLI11_BOOST_OPTIONAL +template std::istream &operator>>(std::istream &in, boost::optional &val) { + T v; + in >> v; + val = v; + return in; +} +#endif + +// Export the best optional to the CLI namespace +#if CLI11_STD_OPTIONAL +using std::optional; +#elif CLI11_EXPERIMENTAL_OPTIONAL +using std::experimental::optional; +#elif CLI11_BOOST_OPTIONAL +using boost::optional; +#endif + +// This is true if any optional is found +#if CLI11_STD_OPTIONAL || CLI11_EXPERIMENTAL_OPTIONAL || CLI11_BOOST_OPTIONAL +#define CLI11_OPTIONAL 1 +#endif + +} // namespace CLI + +// From CLI/StringTools.hpp: + +namespace CLI { +namespace detail { + +// Based on http://stackoverflow.com/questions/236129/split-a-string-in-c +/// Split a string by a delim +inline std::vector split(const std::string &s, char delim) { + std::vector elems; + // Check to see if empty string, give consistent result + if(s.empty()) + elems.emplace_back(""); + else { + std::stringstream ss; + ss.str(s); + std::string item; + while(std::getline(ss, item, delim)) { + elems.push_back(item); + } + } + return elems; +} + +/// Simple function to join a string +template std::string join(const T &v, std::string delim = ",") { + std::ostringstream s; + size_t start = 0; + for(const auto &i : v) { + if(start++ > 0) + s << delim; + s << i; + } + return s.str(); +} + +/// Join a string in reverse order +template std::string rjoin(const T &v, std::string delim = ",") { + std::ostringstream s; + for(size_t start = 0; start < v.size(); start++) { + if(start > 0) + s << delim; + s << v[v.size() - start - 1]; + } + return s.str(); +} + +// Based roughly on http://stackoverflow.com/questions/25829143/c-trim-whitespace-from-a-string + +/// Trim whitespace from left of string +inline std::string <rim(std::string &str) { + auto it = std::find_if(str.begin(), str.end(), [](char ch) { return !std::isspace(ch, std::locale()); }); + str.erase(str.begin(), it); + return str; +} + +/// Trim anything from left of string +inline std::string <rim(std::string &str, const std::string &filter) { + auto it = std::find_if(str.begin(), str.end(), [&filter](char ch) { return filter.find(ch) == std::string::npos; }); + str.erase(str.begin(), it); + return str; +} + +/// Trim whitespace from right of string +inline std::string &rtrim(std::string &str) { + auto it = std::find_if(str.rbegin(), str.rend(), [](char ch) { return !std::isspace(ch, std::locale()); }); + str.erase(it.base(), str.end()); + return str; +} + +/// Trim anything from right of string +inline std::string &rtrim(std::string &str, const std::string &filter) { + auto it = + std::find_if(str.rbegin(), str.rend(), [&filter](char ch) { return filter.find(ch) == std::string::npos; }); + str.erase(it.base(), str.end()); + return str; +} + +/// Trim whitespace from string +inline std::string &trim(std::string &str) { return ltrim(rtrim(str)); } + +/// Trim anything from string +inline std::string &trim(std::string &str, const std::string filter) { return ltrim(rtrim(str, filter), filter); } + +/// Make a copy of the string and then trim it +inline std::string trim_copy(const std::string &str) { + std::string s = str; + return trim(s); +} + +/// Make a copy of the string and then trim it, any filter string can be used (any char in string is filtered) +inline std::string trim_copy(const std::string &str, const std::string &filter) { + std::string s = str; + return trim(s, filter); +} +/// Print a two part "help" string +inline std::ostream &format_help(std::ostream &out, std::string name, std::string description, size_t wid) { + name = " " + name; + out << std::setw(static_cast(wid)) << std::left << name; + if(!description.empty()) { + if(name.length() >= wid) + out << "\n" << std::setw(static_cast(wid)) << ""; + out << description; + } + out << "\n"; + return out; +} + +/// Verify the first character of an option +template bool valid_first_char(T c) { return std::isalpha(c, std::locale()) || c == '_'; } + +/// Verify following characters of an option +template bool valid_later_char(T c) { + return std::isalnum(c, std::locale()) || c == '_' || c == '.' || c == '-'; +} + +/// Verify an option name +inline bool valid_name_string(const std::string &str) { + if(str.empty() || !valid_first_char(str[0])) + return false; + for(auto c : str.substr(1)) + if(!valid_later_char(c)) + return false; + return true; +} + +/// Return a lower case version of a string +inline std::string to_lower(std::string str) { + std::transform(std::begin(str), std::end(str), std::begin(str), [](const std::string::value_type &x) { + return std::tolower(x, std::locale()); + }); + return str; +} + +/// remove underscores from a string +inline std::string remove_underscore(std::string str) { + str.erase(std::remove(std::begin(str), std::end(str), '_'), std::end(str)); + return str; +} + +/// Find and replace a substring with another substring +inline std::string find_and_replace(std::string str, std::string from, std::string to) { + + size_t start_pos = 0; + + while((start_pos = str.find(from, start_pos)) != std::string::npos) { + str.replace(start_pos, from.length(), to); + start_pos += to.length(); + } + + return str; +} + +/// Find a trigger string and call a modify callable function that takes the current string and starting position of the +/// trigger and returns the position in the string to search for the next trigger string +template inline std::string find_and_modify(std::string str, std::string trigger, Callable modify) { + size_t start_pos = 0; + while((start_pos = str.find(trigger, start_pos)) != std::string::npos) { + start_pos = modify(str, start_pos); + } + return str; +} + +/// Split a string '"one two" "three"' into 'one two', 'three' +/// Quote characters can be ` ' or " +inline std::vector split_up(std::string str) { + + const std::string delims("\'\"`"); + auto find_ws = [](char ch) { return std::isspace(ch, std::locale()); }; + trim(str); + + std::vector output; + bool embeddedQuote = false; + char keyChar = ' '; + while(!str.empty()) { + if(delims.find_first_of(str[0]) != std::string::npos) { + keyChar = str[0]; + auto end = str.find_first_of(keyChar, 1); + while((end != std::string::npos) && (str[end - 1] == '\\')) { // deal with escaped quotes + end = str.find_first_of(keyChar, end + 1); + embeddedQuote = true; + } + if(end != std::string::npos) { + output.push_back(str.substr(1, end - 1)); + str = str.substr(end + 1); + } else { + output.push_back(str.substr(1)); + str = ""; + } + } else { + auto it = std::find_if(std::begin(str), std::end(str), find_ws); + if(it != std::end(str)) { + std::string value = std::string(str.begin(), it); + output.push_back(value); + str = std::string(it, str.end()); + } else { + output.push_back(str); + str = ""; + } + } + // transform any embedded quotes into the regular character + if(embeddedQuote) { + output.back() = find_and_replace(output.back(), std::string("\\") + keyChar, std::string(1, keyChar)); + embeddedQuote = false; + } + trim(str); + } + return output; +} + +/// Add a leader to the beginning of all new lines (nothing is added +/// at the start of the first line). `"; "` would be for ini files +/// +/// Can't use Regex, or this would be a subs. +inline std::string fix_newlines(std::string leader, std::string input) { + std::string::size_type n = 0; + while(n != std::string::npos && n < input.size()) { + n = input.find('\n', n); + if(n != std::string::npos) { + input = input.substr(0, n + 1) + leader + input.substr(n + 1); + n += leader.size(); + } + } + return input; +} + +/// This function detects an equal or colon followed by an escaped quote after an argument +/// then modifies the string to replace the equality with a space. This is needed +/// to allow the split up function to work properly and is intended to be used with the find_and_modify function +/// the return value is the offset+1 which is required by the find_and_modify function. +inline size_t escape_detect(std::string &str, size_t offset) { + auto next = str[offset + 1]; + if((next == '\"') || (next == '\'') || (next == '`')) { + auto astart = str.find_last_of("-/ \"\'`", offset - 1); + if(astart != std::string::npos) { + if(str[astart] == ((str[offset] == '=') ? '-' : '/')) + str[offset] = ' '; // interpret this as a space so the split_up works properly + } + } + return offset + 1; +} + +/// Add quotes if the string contains spaces +inline std::string &add_quotes_if_needed(std::string &str) { + if((str.front() != '"' && str.front() != '\'') || str.front() != str.back()) { + char quote = str.find('"') < str.find('\'') ? '\'' : '"'; + if(str.find(' ') != std::string::npos) { + str.insert(0, 1, quote); + str.append(1, quote); + } + } + return str; +} + +} // namespace detail +} // namespace CLI + +// From CLI/Error.hpp: + +namespace CLI { + +// Use one of these on all error classes. +// These are temporary and are undef'd at the end of this file. +#define CLI11_ERROR_DEF(parent, name) \ + protected: \ + name(std::string ename, std::string msg, int exit_code) : parent(std::move(ename), std::move(msg), exit_code) {} \ + name(std::string ename, std::string msg, ExitCodes exit_code) \ + : parent(std::move(ename), std::move(msg), exit_code) {} \ + \ + public: \ + name(std::string msg, ExitCodes exit_code) : parent(#name, std::move(msg), exit_code) {} \ + name(std::string msg, int exit_code) : parent(#name, std::move(msg), exit_code) {} + +// This is added after the one above if a class is used directly and builds its own message +#define CLI11_ERROR_SIMPLE(name) \ + explicit name(std::string msg) : name(#name, msg, ExitCodes::name) {} + +/// These codes are part of every error in CLI. They can be obtained from e using e.exit_code or as a quick shortcut, +/// int values from e.get_error_code(). +enum class ExitCodes { + Success = 0, + IncorrectConstruction = 100, + BadNameString, + OptionAlreadyAdded, + FileError, + ConversionError, + ValidationError, + RequiredError, + RequiresError, + ExcludesError, + ExtrasError, + ConfigError, + InvalidError, + HorribleError, + OptionNotFound, + ArgumentMismatch, + BaseClass = 127 +}; + +// Error definitions + +/// @defgroup error_group Errors +/// @brief Errors thrown by CLI11 +/// +/// These are the errors that can be thrown. Some of them, like CLI::Success, are not really errors. +/// @{ + +/// All errors derive from this one +class Error : public std::runtime_error { + int actual_exit_code; + std::string error_name{"Error"}; + + public: + int get_exit_code() const { return actual_exit_code; } + + std::string get_name() const { return error_name; } + + Error(std::string name, std::string msg, int exit_code = static_cast(ExitCodes::BaseClass)) + : runtime_error(msg), actual_exit_code(exit_code), error_name(std::move(name)) {} + + Error(std::string name, std::string msg, ExitCodes exit_code) : Error(name, msg, static_cast(exit_code)) {} +}; + +// Note: Using Error::Error constructors does not work on GCC 4.7 + +/// Construction errors (not in parsing) +class ConstructionError : public Error { + CLI11_ERROR_DEF(Error, ConstructionError) +}; + +/// Thrown when an option is set to conflicting values (non-vector and multi args, for example) +class IncorrectConstruction : public ConstructionError { + CLI11_ERROR_DEF(ConstructionError, IncorrectConstruction) + CLI11_ERROR_SIMPLE(IncorrectConstruction) + static IncorrectConstruction PositionalFlag(std::string name) { + return IncorrectConstruction(name + ": Flags cannot be positional"); + } + static IncorrectConstruction Set0Opt(std::string name) { + return IncorrectConstruction(name + ": Cannot set 0 expected, use a flag instead"); + } + static IncorrectConstruction SetFlag(std::string name) { + return IncorrectConstruction(name + ": Cannot set an expected number for flags"); + } + static IncorrectConstruction ChangeNotVector(std::string name) { + return IncorrectConstruction(name + ": You can only change the expected arguments for vectors"); + } + static IncorrectConstruction AfterMultiOpt(std::string name) { + return IncorrectConstruction( + name + ": You can't change expected arguments after you've changed the multi option policy!"); + } + static IncorrectConstruction MissingOption(std::string name) { + return IncorrectConstruction("Option " + name + " is not defined"); + } + static IncorrectConstruction MultiOptionPolicy(std::string name) { + return IncorrectConstruction(name + ": multi_option_policy only works for flags and exact value options"); + } +}; + +/// Thrown on construction of a bad name +class BadNameString : public ConstructionError { + CLI11_ERROR_DEF(ConstructionError, BadNameString) + CLI11_ERROR_SIMPLE(BadNameString) + static BadNameString OneCharName(std::string name) { return BadNameString("Invalid one char name: " + name); } + static BadNameString BadLongName(std::string name) { return BadNameString("Bad long name: " + name); } + static BadNameString DashesOnly(std::string name) { + return BadNameString("Must have a name, not just dashes: " + name); + } + static BadNameString MultiPositionalNames(std::string name) { + return BadNameString("Only one positional name allowed, remove: " + name); + } +}; + +/// Thrown when an option already exists +class OptionAlreadyAdded : public ConstructionError { + CLI11_ERROR_DEF(ConstructionError, OptionAlreadyAdded) + explicit OptionAlreadyAdded(std::string name) + : OptionAlreadyAdded(name + " is already added", ExitCodes::OptionAlreadyAdded) {} + static OptionAlreadyAdded Requires(std::string name, std::string other) { + return OptionAlreadyAdded(name + " requires " + other, ExitCodes::OptionAlreadyAdded); + } + static OptionAlreadyAdded Excludes(std::string name, std::string other) { + return OptionAlreadyAdded(name + " excludes " + other, ExitCodes::OptionAlreadyAdded); + } +}; + +// Parsing errors + +/// Anything that can error in Parse +class ParseError : public Error { + CLI11_ERROR_DEF(Error, ParseError) +}; + +// Not really "errors" + +/// This is a successful completion on parsing, supposed to exit +class Success : public ParseError { + CLI11_ERROR_DEF(ParseError, Success) + Success() : Success("Successfully completed, should be caught and quit", ExitCodes::Success) {} +}; + +/// -h or --help on command line +class CallForHelp : public ParseError { + CLI11_ERROR_DEF(ParseError, CallForHelp) + CallForHelp() : CallForHelp("This should be caught in your main function, see examples", ExitCodes::Success) {} +}; + +/// Usually something like --help-all on command line +class CallForAllHelp : public ParseError { + CLI11_ERROR_DEF(ParseError, CallForAllHelp) + CallForAllHelp() + : CallForAllHelp("This should be caught in your main function, see examples", ExitCodes::Success) {} +}; + +/// Does not output a diagnostic in CLI11_PARSE, but allows to return from main() with a specific error code. +class RuntimeError : public ParseError { + CLI11_ERROR_DEF(ParseError, RuntimeError) + explicit RuntimeError(int exit_code = 1) : RuntimeError("Runtime error", exit_code) {} +}; + +/// Thrown when parsing an INI file and it is missing +class FileError : public ParseError { + CLI11_ERROR_DEF(ParseError, FileError) + CLI11_ERROR_SIMPLE(FileError) + static FileError Missing(std::string name) { return FileError(name + " was not readable (missing?)"); } +}; + +/// Thrown when conversion call back fails, such as when an int fails to coerce to a string +class ConversionError : public ParseError { + CLI11_ERROR_DEF(ParseError, ConversionError) + CLI11_ERROR_SIMPLE(ConversionError) + ConversionError(std::string member, std::string name) + : ConversionError("The value " + member + " is not an allowed value for " + name) {} + ConversionError(std::string name, std::vector results) + : ConversionError("Could not convert: " + name + " = " + detail::join(results)) {} + static ConversionError TooManyInputsFlag(std::string name) { + return ConversionError(name + ": too many inputs for a flag"); + } + static ConversionError TrueFalse(std::string name) { + return ConversionError(name + ": Should be true/false or a number"); + } +}; + +/// Thrown when validation of results fails +class ValidationError : public ParseError { + CLI11_ERROR_DEF(ParseError, ValidationError) + CLI11_ERROR_SIMPLE(ValidationError) + explicit ValidationError(std::string name, std::string msg) : ValidationError(name + ": " + msg) {} +}; + +/// Thrown when a required option is missing +class RequiredError : public ParseError { + CLI11_ERROR_DEF(ParseError, RequiredError) + explicit RequiredError(std::string name) : RequiredError(name + " is required", ExitCodes::RequiredError) {} + static RequiredError Subcommand(size_t min_subcom) { + if(min_subcom == 1) + return RequiredError("A subcommand"); + else + return RequiredError("Requires at least " + std::to_string(min_subcom) + " subcommands", + ExitCodes::RequiredError); + } +}; + +/// Thrown when the wrong number of arguments has been received +class ArgumentMismatch : public ParseError { + CLI11_ERROR_DEF(ParseError, ArgumentMismatch) + CLI11_ERROR_SIMPLE(ArgumentMismatch) + ArgumentMismatch(std::string name, int expected, size_t recieved) + : ArgumentMismatch(expected > 0 ? ("Expected exactly " + std::to_string(expected) + " arguments to " + name + + ", got " + std::to_string(recieved)) + : ("Expected at least " + std::to_string(-expected) + " arguments to " + name + + ", got " + std::to_string(recieved)), + ExitCodes::ArgumentMismatch) {} + + static ArgumentMismatch AtLeast(std::string name, int num) { + return ArgumentMismatch(name + ": At least " + std::to_string(num) + " required"); + } + static ArgumentMismatch TypedAtLeast(std::string name, int num, std::string type) { + return ArgumentMismatch(name + ": " + std::to_string(num) + " required " + type + " missing"); + } +}; + +/// Thrown when a requires option is missing +class RequiresError : public ParseError { + CLI11_ERROR_DEF(ParseError, RequiresError) + RequiresError(std::string curname, std::string subname) + : RequiresError(curname + " requires " + subname, ExitCodes::RequiresError) {} +}; + +/// Thrown when an excludes option is present +class ExcludesError : public ParseError { + CLI11_ERROR_DEF(ParseError, ExcludesError) + ExcludesError(std::string curname, std::string subname) + : ExcludesError(curname + " excludes " + subname, ExitCodes::ExcludesError) {} +}; + +/// Thrown when too many positionals or options are found +class ExtrasError : public ParseError { + CLI11_ERROR_DEF(ParseError, ExtrasError) + explicit ExtrasError(std::vector args) + : ExtrasError((args.size() > 1 ? "The following arguments were not expected: " + : "The following argument was not expected: ") + + detail::rjoin(args, " "), + ExitCodes::ExtrasError) {} +}; + +/// Thrown when extra values are found in an INI file +class ConfigError : public ParseError { + CLI11_ERROR_DEF(ParseError, ConfigError) + CLI11_ERROR_SIMPLE(ConfigError) + static ConfigError Extras(std::string item) { return ConfigError("INI was not able to parse " + item); } + static ConfigError NotConfigurable(std::string item) { + return ConfigError(item + ": This option is not allowed in a configuration file"); + } +}; + +/// Thrown when validation fails before parsing +class InvalidError : public ParseError { + CLI11_ERROR_DEF(ParseError, InvalidError) + explicit InvalidError(std::string name) + : InvalidError(name + ": Too many positional arguments with unlimited expected args", ExitCodes::InvalidError) { + } +}; + +/// This is just a safety check to verify selection and parsing match - you should not ever see it +/// Strings are directly added to this error, but again, it should never be seen. +class HorribleError : public ParseError { + CLI11_ERROR_DEF(ParseError, HorribleError) + CLI11_ERROR_SIMPLE(HorribleError) +}; + +// After parsing + +/// Thrown when counting a non-existent option +class OptionNotFound : public Error { + CLI11_ERROR_DEF(Error, OptionNotFound) + explicit OptionNotFound(std::string name) : OptionNotFound(name + " not found", ExitCodes::OptionNotFound) {} +}; + +#undef CLI11_ERROR_DEF +#undef CLI11_ERROR_SIMPLE + +/// @} + +} // namespace CLI + +// From CLI/TypeTools.hpp: + +namespace CLI { + +// Type tools + +/// A copy of enable_if_t from C++14, compatible with C++11. +/// +/// We could check to see if C++14 is being used, but it does not hurt to redefine this +/// (even Google does this: https://github.com/google/skia/blob/master/include/private/SkTLogic.h) +/// It is not in the std namespace anyway, so no harm done. + +template using enable_if_t = typename std::enable_if::type; + +/// Check to see if something is a vector (fail check by default) +template struct is_vector { static const bool value = false; }; + +/// Check to see if something is a vector (true if actually a vector) +template struct is_vector> { static bool const value = true; }; + +/// Check to see if something is bool (fail check by default) +template struct is_bool { static const bool value = false; }; + +/// Check to see if something is bool (true if actually a bool) +template <> struct is_bool { static bool const value = true; }; + +namespace detail { +// Based generally on https://rmf.io/cxx11/almost-static-if +/// Simple empty scoped class +enum class enabler {}; + +/// An instance to use in EnableIf +constexpr enabler dummy = {}; + +// Type name print + +/// Was going to be based on +/// http://stackoverflow.com/questions/1055452/c-get-name-of-type-in-template +/// But this is cleaner and works better in this case + +template ::value && std::is_signed::value, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "INT"; +} + +template ::value && std::is_unsigned::value, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "UINT"; +} + +template ::value, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "FLOAT"; +} + +/// This one should not be used, since vector types print the internal type +template ::value, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "VECTOR"; +} + +template ::value && !std::is_integral::value && !is_vector::value, + detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "TEXT"; +} + +// Lexical cast + +/// Signed integers / enums +template ::value && std::is_signed::value), detail::enabler> = detail::dummy> +bool lexical_cast(std::string input, T &output) { + try { + size_t n = 0; + long long output_ll = std::stoll(input, &n, 0); + output = static_cast(output_ll); + return n == input.size() && static_cast(output) == output_ll; + } catch(const std::invalid_argument &) { + return false; + } catch(const std::out_of_range &) { + return false; + } +} + +/// Unsigned integers +template ::value && std::is_unsigned::value, detail::enabler> = detail::dummy> +bool lexical_cast(std::string input, T &output) { + if(!input.empty() && input.front() == '-') + return false; // std::stoull happily converts negative values to junk without any errors. + + try { + size_t n = 0; + unsigned long long output_ll = std::stoull(input, &n, 0); + output = static_cast(output_ll); + return n == input.size() && static_cast(output) == output_ll; + } catch(const std::invalid_argument &) { + return false; + } catch(const std::out_of_range &) { + return false; + } +} + +/// Floats +template ::value, detail::enabler> = detail::dummy> +bool lexical_cast(std::string input, T &output) { + try { + size_t n = 0; + output = static_cast(std::stold(input, &n)); + return n == input.size(); + } catch(const std::invalid_argument &) { + return false; + } catch(const std::out_of_range &) { + return false; + } +} + +/// String and similar +template ::value && !std::is_integral::value && + std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_cast(std::string input, T &output) { + output = input; + return true; +} + +/// Non-string parsable +template ::value && !std::is_integral::value && + !std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_cast(std::string input, T &output) { + std::istringstream is; + + is.str(input); + is >> output; + return !is.fail() && !is.rdbuf()->in_avail(); +} + +} // namespace detail +} // namespace CLI + +// From CLI/Split.hpp: + +namespace CLI { +namespace detail { + +// Returns false if not a short option. Otherwise, sets opt name and rest and returns true +inline bool split_short(const std::string ¤t, std::string &name, std::string &rest) { + if(current.size() > 1 && current[0] == '-' && valid_first_char(current[1])) { + name = current.substr(1, 1); + rest = current.substr(2); + return true; + } else + return false; +} + +// Returns false if not a long option. Otherwise, sets opt name and other side of = and returns true +inline bool split_long(const std::string ¤t, std::string &name, std::string &value) { + if(current.size() > 2 && current.substr(0, 2) == "--" && valid_first_char(current[2])) { + auto loc = current.find_first_of('='); + if(loc != std::string::npos) { + name = current.substr(2, loc - 2); + value = current.substr(loc + 1); + } else { + name = current.substr(2); + value = ""; + } + return true; + } else + return false; +} + +// Returns false if not a windows style option. Otherwise, sets opt name and value and returns true +inline bool split_windows(const std::string ¤t, std::string &name, std::string &value) { + if(current.size() > 1 && current[0] == '/' && valid_first_char(current[1])) { + auto loc = current.find_first_of(':'); + if(loc != std::string::npos) { + name = current.substr(1, loc - 1); + value = current.substr(loc + 1); + } else { + name = current.substr(1); + value = ""; + } + return true; + } else + return false; +} + +// Splits a string into multiple long and short names +inline std::vector split_names(std::string current) { + std::vector output; + size_t val; + while((val = current.find(",")) != std::string::npos) { + output.push_back(trim_copy(current.substr(0, val))); + current = current.substr(val + 1); + } + output.push_back(trim_copy(current)); + return output; +} + +/// Get a vector of short names, one of long names, and a single name +inline std::tuple, std::vector, std::string> +get_names(const std::vector &input) { + + std::vector short_names; + std::vector long_names; + std::string pos_name; + + for(std::string name : input) { + if(name.length() == 0) + continue; + else if(name.length() > 1 && name[0] == '-' && name[1] != '-') { + if(name.length() == 2 && valid_first_char(name[1])) + short_names.emplace_back(1, name[1]); + else + throw BadNameString::OneCharName(name); + } else if(name.length() > 2 && name.substr(0, 2) == "--") { + name = name.substr(2); + if(valid_name_string(name)) + long_names.push_back(name); + else + throw BadNameString::BadLongName(name); + } else if(name == "-" || name == "--") { + throw BadNameString::DashesOnly(name); + } else { + if(pos_name.length() > 0) + throw BadNameString::MultiPositionalNames(name); + pos_name = name; + } + } + + return std::tuple, std::vector, std::string>( + short_names, long_names, pos_name); +} + +} // namespace detail +} // namespace CLI + +// From CLI/ConfigFwd.hpp: + +namespace CLI { + +class App; + +namespace detail { + +/// Comma separated join, adds quotes if needed +inline std::string ini_join(std::vector args) { + std::ostringstream s; + size_t start = 0; + for(const auto &arg : args) { + if(start++ > 0) + s << " "; + + auto it = std::find_if(arg.begin(), arg.end(), [](char ch) { return std::isspace(ch, std::locale()); }); + if(it == arg.end()) + s << arg; + else if(arg.find(R"(")") == std::string::npos) + s << R"(")" << arg << R"(")"; + else + s << R"(')" << arg << R"(')"; + } + + return s.str(); +} + +} // namespace detail + +/// Holds values to load into Options +struct ConfigItem { + /// This is the list of parents + std::vector parents; + + /// This is the name + std::string name; + + /// Listing of inputs + std::vector inputs; + + /// The list of parents and name joined by "." + std::string fullname() const { + std::vector tmp = parents; + tmp.emplace_back(name); + return detail::join(tmp, "."); + } +}; + +/// This class provides a converter for configuration files. +class Config { + protected: + std::vector items; + + public: + /// Convert an app into a configuration + virtual std::string to_config(const App *, bool, bool, std::string) const = 0; + + /// Convert a configuration into an app + virtual std::vector from_config(std::istream &) const = 0; + + /// Convert a flag to a bool + virtual std::vector to_flag(const ConfigItem &item) const { + if(item.inputs.size() == 1) { + std::string val = item.inputs.at(0); + val = detail::to_lower(val); + + if(val == "true" || val == "on" || val == "yes") { + return std::vector(1); + } else if(val == "false" || val == "off" || val == "no") { + return std::vector(); + } else { + try { + size_t ui = std::stoul(val); + return std::vector(ui); + } catch(const std::invalid_argument &) { + throw ConversionError::TrueFalse(item.fullname()); + } + } + } else { + throw ConversionError::TooManyInputsFlag(item.fullname()); + } + } + + /// Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure + std::vector from_file(const std::string &name) { + std::ifstream input{name}; + if(!input.good()) + throw FileError::Missing(name); + + return from_config(input); + } + + /// virtual destructor + virtual ~Config() = default; +}; + +/// This converter works with INI files +class ConfigINI : public Config { + public: + std::string to_config(const App *, bool default_also, bool write_description, std::string prefix) const override; + + std::vector from_config(std::istream &input) const override { + std::string line; + std::string section = "default"; + + std::vector output; + + while(getline(input, line)) { + std::vector items_buffer; + + detail::trim(line); + size_t len = line.length(); + if(len > 1 && line[0] == '[' && line[len - 1] == ']') { + section = line.substr(1, len - 2); + } else if(len > 0 && line[0] != ';') { + output.emplace_back(); + ConfigItem &out = output.back(); + + // Find = in string, split and recombine + auto pos = line.find('='); + if(pos != std::string::npos) { + out.name = detail::trim_copy(line.substr(0, pos)); + std::string item = detail::trim_copy(line.substr(pos + 1)); + items_buffer = detail::split_up(item); + } else { + out.name = detail::trim_copy(line); + items_buffer = {"ON"}; + } + + if(detail::to_lower(section) != "default") { + out.parents = {section}; + } + + if(out.name.find('.') != std::string::npos) { + std::vector plist = detail::split(out.name, '.'); + out.name = plist.back(); + plist.pop_back(); + out.parents.insert(out.parents.end(), plist.begin(), plist.end()); + } + + out.inputs.insert(std::end(out.inputs), std::begin(items_buffer), std::end(items_buffer)); + } + } + return output; + } +}; + +} // namespace CLI + +// From CLI/Validators.hpp: + +namespace CLI { + +/// @defgroup validator_group Validators + +/// @brief Some validators that are provided +/// +/// These are simple `std::string(const std::string&)` validators that are useful. They return +/// a string if the validation fails. A custom struct is provided, as well, with the same user +/// semantics, but with the ability to provide a new type name. +/// @{ + +/// +struct Validator { + /// This is the type name, if empty the type name will not be changed + std::string tname; + + /// This it the base function that is to be called. + /// Returns a string error message if validation fails. + std::function func; + + /// This is the required operator for a validator - provided to help + /// users (CLI11 uses the member `func` directly) + std::string operator()(const std::string &str) const { return func(str); }; + + /// Combining validators is a new validator + Validator operator&(const Validator &other) const { + Validator newval; + newval.tname = (tname == other.tname ? tname : ""); + + // Give references (will make a copy in lambda function) + const std::function &f1 = func; + const std::function &f2 = other.func; + + newval.func = [f1, f2](const std::string &filename) { + std::string s1 = f1(filename); + std::string s2 = f2(filename); + if(!s1.empty() && !s2.empty()) + return s1 + " & " + s2; + else + return s1 + s2; + }; + return newval; + } + + /// Combining validators is a new validator + Validator operator|(const Validator &other) const { + Validator newval; + newval.tname = (tname == other.tname ? tname : ""); + + // Give references (will make a copy in lambda function) + const std::function &f1 = func; + const std::function &f2 = other.func; + + newval.func = [f1, f2](const std::string &filename) { + std::string s1 = f1(filename); + std::string s2 = f2(filename); + if(s1.empty() || s2.empty()) + return std::string(); + else + return s1 + " & " + s2; + }; + return newval; + } +}; + +// The implementation of the built in validators is using the Validator class; +// the user is only expected to use the const (static) versions (since there's no setup). +// Therefore, this is in detail. +namespace detail { + +/// Check for an existing file (returns error message if check fails) +struct ExistingFileValidator : public Validator { + ExistingFileValidator() { + tname = "FILE"; + func = [](const std::string &filename) { + struct stat buffer; + bool exist = stat(filename.c_str(), &buffer) == 0; + bool is_dir = (buffer.st_mode & S_IFDIR) != 0; + if(!exist) { + return "File does not exist: " + filename; + } else if(is_dir) { + return "File is actually a directory: " + filename; + } + return std::string(); + }; + } +}; + +/// Check for an existing directory (returns error message if check fails) +struct ExistingDirectoryValidator : public Validator { + ExistingDirectoryValidator() { + tname = "DIR"; + func = [](const std::string &filename) { + struct stat buffer; + bool exist = stat(filename.c_str(), &buffer) == 0; + bool is_dir = (buffer.st_mode & S_IFDIR) != 0; + if(!exist) { + return "Directory does not exist: " + filename; + } else if(!is_dir) { + return "Directory is actually a file: " + filename; + } + return std::string(); + }; + } +}; + +/// Check for an existing path +struct ExistingPathValidator : public Validator { + ExistingPathValidator() { + tname = "PATH"; + func = [](const std::string &filename) { + struct stat buffer; + bool const exist = stat(filename.c_str(), &buffer) == 0; + if(!exist) { + return "Path does not exist: " + filename; + } + return std::string(); + }; + } +}; + +/// Check for an non-existing path +struct NonexistentPathValidator : public Validator { + NonexistentPathValidator() { + tname = "PATH"; + func = [](const std::string &filename) { + struct stat buffer; + bool exist = stat(filename.c_str(), &buffer) == 0; + if(exist) { + return "Path already exists: " + filename; + } + return std::string(); + }; + } +}; +} // namespace detail + +// Static is not needed here, because global const implies static. + +/// Check for existing file (returns error message if check fails) +const detail::ExistingFileValidator ExistingFile; + +/// Check for an existing directory (returns error message if check fails) +const detail::ExistingDirectoryValidator ExistingDirectory; + +/// Check for an existing path +const detail::ExistingPathValidator ExistingPath; + +/// Check for an non-existing path +const detail::NonexistentPathValidator NonexistentPath; + +/// Produce a range (factory). Min and max are inclusive. +struct Range : public Validator { + /// This produces a range with min and max inclusive. + /// + /// Note that the constructor is templated, but the struct is not, so C++17 is not + /// needed to provide nice syntax for Range(a,b). + template Range(T min, T max) { + std::stringstream out; + out << detail::type_name() << " in [" << min << " - " << max << "]"; + + tname = out.str(); + func = [min, max](std::string input) { + T val; + detail::lexical_cast(input, val); + if(val < min || val > max) + return "Value " + input + " not in range " + std::to_string(min) + " to " + std::to_string(max); + + return std::string(); + }; + } + + /// Range of one value is 0 to value + template explicit Range(T max) : Range(static_cast(0), max) {} +}; + +namespace detail { +/// split a string into a program name and command line arguments +/// the string is assumed to contain a file name followed by other arguments +/// the return value contains is a pair with the first argument containing the program name and the second everything +/// else +inline std::pair split_program_name(std::string commandline) { + // try to determine the programName + std::pair vals; + trim(commandline); + auto esp = commandline.find_first_of(' ', 1); + while(!ExistingFile(commandline.substr(0, esp)).empty()) { + esp = commandline.find_first_of(' ', esp + 1); + if(esp == std::string::npos) { + // if we have reached the end and haven't found a valid file just assume the first argument is the + // program name + esp = commandline.find_first_of(' ', 1); + break; + } + } + vals.first = commandline.substr(0, esp); + rtrim(vals.first); + // strip the program name + vals.second = (esp != std::string::npos) ? commandline.substr(esp + 1) : std::string{}; + ltrim(vals.second); + return vals; +} +} // namespace detail +/// @} + +} // namespace CLI + +// From CLI/FormatterFwd.hpp: + +namespace CLI { + +class Option; +class App; + +/// This enum signifies the type of help requested +/// +/// This is passed in by App; all user classes must accept this as +/// the second argument. + +enum class AppFormatMode { + Normal, //< The normal, detailed help + All, //< A fully expanded help + Sub, //< Used when printed as part of expanded subcommand +}; + +/// This is the minimum requirements to run a formatter. +/// +/// A user can subclass this is if they do not care at all +/// about the structure in CLI::Formatter. +class FormatterBase { + protected: + /// @name Options + ///@{ + + /// The width of the first column + size_t column_width_{30}; + + /// @brief The required help printout labels (user changeable) + /// Values are Needs, Excludes, etc. + std::map labels_; + + ///@} + /// @name Basic + ///@{ + + public: + FormatterBase() = default; + FormatterBase(const FormatterBase &) = default; + FormatterBase(FormatterBase &&) = default; + virtual ~FormatterBase() = default; + + /// This is the key method that puts together help + virtual std::string make_help(const App *, std::string, AppFormatMode) const = 0; + + ///@} + /// @name Setters + ///@{ + + /// Set the "REQUIRED" label + void label(std::string key, std::string val) { labels_[key] = val; } + + /// Set the column width + void column_width(size_t val) { column_width_ = val; } + + ///@} + /// @name Getters + ///@{ + + /// Get the current value of a name (REQUIRED, etc.) + std::string get_label(std::string key) const { + if(labels_.find(key) == labels_.end()) + return key; + else + return labels_.at(key); + } + + /// Get the current column width + size_t get_column_width() const { return column_width_; } + + ///@} +}; + +/// This is a specialty override for lambda functions +class FormatterLambda final : public FormatterBase { + using funct_t = std::function; + + /// The lambda to hold and run + funct_t lambda_; + + public: + /// Create a FormatterLambda with a lambda function + explicit FormatterLambda(funct_t funct) : lambda_(std::move(funct)) {} + + /// This will simply call the lambda function + std::string make_help(const App *app, std::string name, AppFormatMode mode) const override { + return lambda_(app, name, mode); + } +}; + +/// This is the default Formatter for CLI11. It pretty prints help output, and is broken into quite a few +/// overridable methods, to be highly customizable with minimal effort. +class Formatter : public FormatterBase { + public: + Formatter() = default; + Formatter(const Formatter &) = default; + Formatter(Formatter &&) = default; + + /// @name Overridables + ///@{ + + /// This prints out a group of options with title + /// + virtual std::string make_group(std::string group, bool is_positional, std::vector opts) const; + + /// This prints out just the positionals "group" + virtual std::string make_positionals(const App *app) const; + + /// This prints out all the groups of options + std::string make_groups(const App *app, AppFormatMode mode) const; + + /// This prints out all the subcommands + virtual std::string make_subcommands(const App *app, AppFormatMode mode) const; + + /// This prints out a subcommand + virtual std::string make_subcommand(const App *sub) const; + + /// This prints out a subcommand in help-all + virtual std::string make_expanded(const App *sub) const; + + /// This prints out all the groups of options + virtual std::string make_footer(const App *app) const; + + /// This displays the description line + virtual std::string make_description(const App *app) const; + + /// This displays the usage line + virtual std::string make_usage(const App *app, std::string name) const; + + /// This puts everything together + std::string make_help(const App *, std::string, AppFormatMode) const override; + + ///@} + /// @name Options + ///@{ + + /// This prints out an option help line, either positional or optional form + virtual std::string make_option(const Option *opt, bool is_positional) const { + std::stringstream out; + detail::format_help( + out, make_option_name(opt, is_positional) + make_option_opts(opt), make_option_desc(opt), column_width_); + return out.str(); + } + + /// @brief This is the name part of an option, Default: left column + virtual std::string make_option_name(const Option *, bool) const; + + /// @brief This is the options part of the name, Default: combined into left column + virtual std::string make_option_opts(const Option *) const; + + /// @brief This is the description. Default: Right column, on new line if left column too large + virtual std::string make_option_desc(const Option *) const; + + /// @brief This is used to print the name on the USAGE line + virtual std::string make_option_usage(const Option *opt) const; + + ///@} +}; + +} // namespace CLI + +// From CLI/Option.hpp: + +namespace CLI { + +using results_t = std::vector; +using callback_t = std::function; + +class Option; +class App; + +using Option_p = std::unique_ptr