diff --git a/.gitmodules b/.gitmodules index b863a50d..58dc0fc2 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,3 +10,6 @@ [submodule "third_party/hooker"] path = third_party/hooker url = https://github.com/guusw/hooker.git +[submodule "third_party/magic_enum"] + path = third_party/magic_enum + url = https://github.com/Neargye/magic_enum.git diff --git a/GhidraScripts/FindRelocations.java b/GhidraScripts/FindRelocations.java index a6bb5e0e..5ddb8023 100644 --- a/GhidraScripts/FindRelocations.java +++ b/GhidraScripts/FindRelocations.java @@ -89,61 +89,86 @@ public class FindRelocations extends GhidraScript { private void analyzeInstruction(Instruction instruction) { String mnemonic = instruction.getMnemonicString().toLowerCase(); + boolean trace = instruction.getAddress().getOffset() == 0x0049b154; + if (trace) { + println("DEBUG: " + mnemonic + " at " + instruction.getAddress()); + } + // Check for instructions that commonly use absolute addresses if (isRelocatableInstruction(mnemonic)) { // Check references from this instruction Reference[] refs = instruction.getReferencesFrom(); for (Reference ref : refs) { Address toAddr = ref.getToAddress(); - - if (isInMainMemorySpace(toAddr)) { - // Check if the target address appears in the instruction bytes (absolute addressing) - int operandOffset = findAbsoluteAddressOffset(instruction, toAddr); + + boolean isInMainMemorySpace = isInMainMemorySpace(toAddr); + if (trace) { + println(" isInMainMemorySpace: " + toAddr + " " + isInMainMemorySpace); + } + if (isInMainMemorySpace) { + // Check if the target address appears in the instruction bytes (absolute + // addressing) + int operandOffset = findAbsoluteAddressOffset(instruction, toAddr, trace); if (operandOffset >= 0) { - recordRelocation(instruction.getAddress(), toAddr, mnemonic, - "absolute_" + ref.getReferenceType().getName(), operandOffset); + recordRelocation(instruction.getAddress(), toAddr, mnemonic, + "absolute_" + ref.getReferenceType().getName(), operandOffset); + } else { + if (trace) { + println(" operandOffset was not found: " + operandOffset); + } } } } } } - private int findAbsoluteAddressOffset(Instruction instruction, Address targetAddr) { + private int findAbsoluteAddressOffset(Instruction instruction, Address targetAddr, boolean trace) { try { byte[] instructionBytes = instruction.getBytes(); long targetValue = targetAddr.getOffset(); - + // Convert target address to little-endian byte array (x86 32-bit) byte[] targetBytes = new byte[4]; targetBytes[0] = (byte) (targetValue & 0xFF); targetBytes[1] = (byte) ((targetValue >> 8) & 0xFF); targetBytes[2] = (byte) ((targetValue >> 16) & 0xFF); targetBytes[3] = (byte) ((targetValue >> 24) & 0xFF); - + // Search for the target address bytes in the instruction and return offset - int offset = findSequenceOffset(instructionBytes, targetBytes); - + int offset = findSequenceOffset(instructionBytes, targetBytes, trace); + return offset; - + } catch (Exception e) { + if (trace) { + println("findAbsoluteAddressOffset exception: " + e.getMessage()); + } return -1; } } - + private String bytesToHex(byte[] bytes) { StringBuilder sb = new StringBuilder(); for (int i = 0; i < bytes.length; i++) { - if (i > 0) sb.append(" "); + if (i > 0) + sb.append(" "); sb.append(String.format("%02x", bytes[i] & 0xFF)); } return sb.toString(); } - private int findSequenceOffset(byte[] haystack, byte[] needle) { + private int findSequenceOffset(byte[] haystack, byte[] needle, boolean trace) { + if (trace) { + println("findSequenceOffset inspected bytes: " + bytesToHex(haystack) + " (length: " + haystack.length + ")"); + } + if (needle.length > haystack.length) { + if (trace) { + println("findSequenceOffset needle.length > haystack.length"); + } return -1; } - + for (int i = 0; i <= haystack.length - needle.length; i++) { boolean found = true; for (int j = 0; j < needle.length; j++) { @@ -162,12 +187,12 @@ public class FindRelocations extends GhidraScript { private boolean isRelocatableInstruction(String mnemonic) { // Instructions that commonly use absolute addresses return mnemonic.equals("mov") || mnemonic.equals("lea") || - mnemonic.equals("call") || mnemonic.equals("jmp") || - mnemonic.equals("push") || mnemonic.equals("cmp") || - mnemonic.equals("test") || mnemonic.equals("add") || - mnemonic.equals("sub") || mnemonic.equals("and") || - mnemonic.equals("or") || mnemonic.equals("xor") || - mnemonic.startsWith("j"); // All jumps, we'll filter by byte analysis + mnemonic.equals("call") || mnemonic.equals("jmp") || + mnemonic.equals("push") || mnemonic.equals("cmp") || + mnemonic.equals("test") || mnemonic.equals("add") || + mnemonic.equals("sub") || mnemonic.equals("and") || + mnemonic.equals("or") || mnemonic.equals("xor") || + mnemonic.startsWith("j"); // All jumps, we'll filter by byte analysis } private void analyzeDataReferences(long instructionsProcessed, long totalWork) { @@ -175,18 +200,18 @@ public class FindRelocations extends GhidraScript { MemoryBlock[] blocks = currentProgram.getMemory().getBlocks(); long processedBytes = 0; int pointerSize = currentProgram.getDefaultPointerSize(); - + for (MemoryBlock block : blocks) { // Skip executable blocks (code sections) if (block.isExecute()) { continue; } - + // Only scan initialized data blocks if (!block.isInitialized()) { continue; } - + if (monitor.isCancelled()) { println("Operation cancelled by user"); return; @@ -195,9 +220,9 @@ public class FindRelocations extends GhidraScript { if (block.getName().equals(".rsrc")) { continue; } - + println("Scanning data block: " + block.getName() + " (" + block.getStart() + " - " + block.getEnd() + ")"); - + Address addr = block.getStart(); while (addr != null && addr.compareTo(block.getEnd()) <= 0) { try { @@ -250,11 +275,11 @@ public class FindRelocations extends GhidraScript { private void recordRelocation(Address fromAddr, Address toAddr, String instruction, String type, int operandOffset) { String relocKey = fromAddr.toString() + " -> " + toAddr.toString(); - + if (foundRelocations.add(relocKey)) { String instructionBytes = getInstructionBytesString(fromAddr); Address operandPtr = fromAddr.add(operandOffset); - + String line = String.format("REL(0x%s, 0x%s, 0x%s) // %s [%s] | %s", fromAddr.toString(), operandPtr.toString(), @@ -262,7 +287,7 @@ public class FindRelocations extends GhidraScript { instruction, type, instructionBytes); - + outputFile.println(line); outputFile.flush(); } @@ -287,7 +312,8 @@ public class FindRelocations extends GhidraScript { if (bytesRead > 0) { StringBuilder sb = new StringBuilder(); for (int i = 0; i < bytesRead; i++) { - if (i > 0) sb.append(" "); + if (i > 0) + sb.append(" "); sb.append(String.format("%02x", bytes[i] & 0xFF)); } return sb.toString(); @@ -308,15 +334,16 @@ public class FindRelocations extends GhidraScript { if (instruction != null) { return true; } - + // Check if this address is within any function's body Function function = currentProgram.getFunctionManager().getFunctionContaining(addr); if (function != null) { - // Additional check: make sure we're in the function body, not just data referenced by it + // Additional check: make sure we're in the function body, not just data + // referenced by it AddressSetView functionBody = function.getBody(); return functionBody.contains(addr); } - + return false; } } diff --git a/GhidraScripts/re3lib/FunctionDumper.java b/GhidraScripts/re3lib/FunctionDumper.java index 626070fe..053f65b3 100644 --- a/GhidraScripts/re3lib/FunctionDumper.java +++ b/GhidraScripts/re3lib/FunctionDumper.java @@ -225,9 +225,9 @@ public class FunctionDumper { String addrString = "0x" + externalFunction.getEntryPoint().toString().replace("0x", ""); if (returnType.equals("void")) { - writer2.println(" " + stubFunction + "<" + addrString + ", void>(" + paramList.toString() + ");"); + writer2.println(" " + stubFunction + "<(stub_t)" + addrString + ", void>(" + paramList.toString() + ");"); } else { - writer2.println(" return " + stubFunction + "<" + addrString + ", " + returnType + ">(" + + writer2.println(" return " + stubFunction + "<(stub_t)" + addrString + ", " + returnType + ">(" + paramList.toString() + ");"); } diff --git a/GhidraScripts/re3lib/GlobalDumper.java b/GhidraScripts/re3lib/GlobalDumper.java index d2885c8b..e0f2b8da 100644 --- a/GhidraScripts/re3lib/GlobalDumper.java +++ b/GhidraScripts/re3lib/GlobalDumper.java @@ -169,14 +169,14 @@ public class GlobalDumper { DataType baseType = ((Pointer) dt).getDataType(); if (baseType == null) { script.println("WARNING: Missing base type for pointer: " + name + " at " + addr); - dataType = "pointer"; + dataType = "pointer&"; } else if (baseType instanceof FunctionDefinition) { script.println("Value is a function type " + name + " at " + addr); dataType = ((FunctionDefinition) baseType).getDisplayName(); } else { - dataType = baseType.getDisplayName() + "*"; + dataType = baseType.getDisplayName() + "*&"; } - initBlk += "(" + dataType + ")&GH_MEM(0x" + addr + ")"; + initBlk += "(" + dataType + ")GH_MEM(0x" + addr + ")"; fullyDefinedType = true; } String linkagePrefix = "extern "; diff --git a/game_re/CMakeLists.txt b/game_re/CMakeLists.txt index 511f2e75..ba750e3d 100644 --- a/game_re/CMakeLists.txt +++ b/game_re/CMakeLists.txt @@ -32,9 +32,11 @@ function(setup_target TARGET DBG_MODE) target_compile_definitions(${TARGET} PRIVATE _CRT_SECURE_NO_WARNINGS=1 - _CRT_NONSTDC_NO_WARNINGS=1) + _CRT_NONSTDC_NO_WARNINGS=1 + SPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_TRACE + ) - target_link_libraries(${TARGET} PRIVATE spdlog) + target_link_libraries(${TARGET} PRIVATE spdlog CLI11 magic_enum) file(GLOB GH_AUTO_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/gh_auto/*.cxx) file(GLOB GH_FIX_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/gh_fix/*.cxx) diff --git a/game_re/gh_fix/entry.cxx b/game_re/gh_fix/entry.cxx index 7063e666..a9f74801 100644 --- a/game_re/gh_fix/entry.cxx +++ b/game_re/gh_fix/entry.cxx @@ -7,20 +7,28 @@ extern "C" { undefined4 crt_createProgramHeap(undefined4 param_1) { - return gh_stub_impl_cdecl<0x00404902, undefined4>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x00404902, undefined4>(param_1); +} +undefined4 ioinit(void) { + return gh_stub_impl_cdecl<(stub_t)0x004046bf, undefined4>(); +} +void crt_initConsole(void) { + return gh_stub_impl_cdecl<(stub_t)0x00404503, void>(); +} +LPSTR crt_setupEnv(void) { + return gh_stub_impl_cdecl<(stub_t)0x004043d1, LPSTR>(); } -undefined4 ioinit(void) { return gh_stub_impl_cdecl<0x004046bf, undefined4>(); } -void crt_initConsole(void) { return gh_stub_impl_cdecl<0x00404503, void>(); } -LPSTR crt_setupEnv(void) { return gh_stub_impl_cdecl<0x004043d1, LPSTR>(); } undefined4 crt_main2(void) { - return gh_stub_impl_cdecl<0x00404184, undefined4>(); + return gh_stub_impl_cdecl<(stub_t)0x00404184, undefined4>(); } undefined4 crt_main1(void) { - return gh_stub_impl_cdecl<0x004040cb, undefined4>(); + return gh_stub_impl_cdecl<(stub_t)0x004040cb, undefined4>(); +} +void crt_static_init(void) { + return gh_stub_impl_cdecl<(stub_t)0x004027be, void>(); } -void crt_static_init(void) { return gh_stub_impl_cdecl<0x004027be, void>(); } -char *crt_0(void) { return gh_stub_impl_cdecl<0x00404073, char *>(); } +char *crt_0(void) { return gh_stub_impl_cdecl<(stub_t)0x00404073, char *>(); } void gh_pre_main(void) { DWORD DVar1; diff --git a/game_re/gh_fix/r3_levelDisplayFn.cxx b/game_re/gh_fix/r3_levelDisplayFn.cxx index ddcb2213..55d6226f 100644 --- a/game_re/gh_fix/r3_levelDisplayFn.cxx +++ b/game_re/gh_fix/r3_levelDisplayFn.cxx @@ -7,10 +7,10 @@ extern "C" { undefined FUN_00447130(void); // 00447130 // FUN_00447130 // cdecl void doGraphics(byte param_1); // 00447460 // doGraphics // stdcall bool UNKr3_renderViewport(byte viewportIdx); // 00447200 // ?r3_renderViewport // stdcall -undefined FUN_0046fec0(void); // 0046fec0 // FUN_0046fec0 // cdecl int get_one(void); // 0046f2c0 // get_one // cdecl undefined FUN_00451530(undefined4 param_1); // 00451530 // FUN_00451530 // cdecl undefined FUN_0048a920(undefined4 param_1); // 0048a920 // FUN_0048a920 // cdecl +void r3_setRendererState(void); // 0046fec0 // r3_setRendererState // cdecl undefined FUN_0045fc70(undefined4 param_1); // 0045fc70 // FUN_0045fc70 // cdecl // 00446fc0 @@ -46,13 +46,13 @@ void __cdecl r3_levelDisplayFn(byte param) if (cVar3 != '\0') { param = param + 1; } - if (param == (uint32_t&)DAT_005d2b18) { + if (param == DAT_005d2b18) { FUN_0045fc70(*(undefined4 *)(iVar1 + 4)); } } } if (DAT_005d2b18 != 0) { - FUN_0046fec0(0,0,0,0); + r3_setRendererState(); } } /* WARNING: Could not inline here */ diff --git a/game_re/gh_fix/r3_main.cxx b/game_re/gh_fix/r3_main.cxx index a01408a3..e8e0dd96 100644 --- a/game_re/gh_fix/r3_main.cxx +++ b/game_re/gh_fix/r3_main.cxx @@ -12,15 +12,15 @@ undefined r3_checkDisc(void); // 004464f0 // r3_checkDisc undefined FUN_00503710(void); // 00503710 // FUN_00503710 undefined r3_initAllModules(void); // 00401000 // r3_initAllModules undefined FUN_00472150(void); // 00472150 // FUN_00472150 -undefined r3_wait_for_dvd(char *param_1, char *param_2, - undefined4 param_3); // 0043e540 // r3_wait_for_dvd +undefined r3_waitForDvd(char *param_1, char *param_2, + undefined4 param_3); // 0043e540 // r3_waitForDvd undefined FUN_004725a0(void); // 004725a0 // FUN_004725a0 int r3_get_gli_width1(void); // 0047baf0 // r3_get_gli_width1 undefined gfx_init2(void); // 00470be0 // gfx_init2 void g_setInitVar0(void); // 00401310 // g_setInitVar0 int r3_get_gli_height1(void); // 0047bb00 // r3_get_gli_height1 undefined FUN_004010b0(void); // 004010b0 // FUN_004010b0 -undefined FUN_00401320(void); // 00401320 // FUN_00401320 +undefined r3_windowLockCursor(void); // 00401320 // r3_windowLockCursor void r3_noop(void *p_cTxt1, void *p_cTxt2); // 00401100 // r3_noop undefined FUN_005038e0(void); // 005038e0 // FUN_005038e0 undefined FUN_004fb300(void); // 004fb300 // FUN_004fb300 @@ -608,7 +608,7 @@ LAB_004017ce: return -1; } g_setInitVar0(); - FUN_00401320(); + r3_windowLockCursor(); spawnThread(); r3_noop(p_cTxt1, p_cTxt2); gfx_init2(); @@ -655,7 +655,7 @@ LAB_004017ce: } sprintf(UStack_830, s_Please_run_the__s_setup__005b63f4, s_windowTitle); sprintf(acStack_528, s__s_not_initialized__005b63e0, s_windowTitle); - r3_wait_for_dvd(UStack_830, acStack_528, 0); + r3_waitForDvd(UStack_830, acStack_528, 0); /* WARNING: Subroutine does not return */ exit(-1); } diff --git a/game_re/gh_fix/r3_wait_for_dvd.cxx b/game_re/gh_fix/r3_waitForDvd.cxx similarity index 66% rename from game_re/gh_fix/r3_wait_for_dvd.cxx rename to game_re/gh_fix/r3_waitForDvd.cxx index 12164bcb..571cec56 100644 --- a/game_re/gh_fix/r3_wait_for_dvd.cxx +++ b/game_re/gh_fix/r3_waitForDvd.cxx @@ -4,21 +4,21 @@ #include extern "C" { -undefined FUN_0043e4f0(void); // 0043e4f0 // FUN_0043e4f0 -void IPT_fn_vReadInput(void); // 00505fe0 // IPT_fn_vReadInput -undefined r3_gfxFrameUNK(void); // 0046fed0 // r3_gfxFrame? -undefined FUN_00441d70(undefined4 param_1, undefined4 param_2, undefined4 param_3, undefined4 param_4, undefined4 param_5); // 00441d70 // FUN_00441d70 -undefined FUN_0046fe20(undefined4 param_1, undefined4 param_2, undefined4 param_3); // 0046fe20 // FUN_0046fe20 +undefined r3_setRendererState1(undefined4 param_1, undefined4 param_2, undefined4 param_3); // 0046fe20 // r3_setRendererState1 // cdecl +undefined FUN_0043e4f0(void); // 0043e4f0 // FUN_0043e4f0 // cdecl +undefined r3_gfxFrameUNK(void); // 0046fed0 // r3_gfxFrame? // cdecl +undefined FUN_00441d70(undefined4 param_1, undefined4 param_2, undefined4 param_3, undefined4 param_4, undefined4 param_5); // 00441d70 // FUN_00441d70 // cdecl +void IPT_fn_vReadInput(void); // 00505fe0 // IPT_fn_vReadInput // stdcall // 0043e540 -int r3_wait_for_dvd(char *param_1,char *param_2,uint param_3) +int __cdecl r3_waitForDvd(char *param_1,char *param_2,uint param_3) { ushort uVar1; int iVar2; char local_64 [100]; - FUN_0046fe20(1,1,0); + r3_setRendererState1(1,1,0); iVar2 = FUN_00441d70((undefined4)param_1,0x42c80000,0x43480000,0,0xffffffff); if (iVar2 == 0) { iVar2 = MessageBoxA(g_gameHWND1,param_1,param_2,param_3 | 0x10000); diff --git a/game_re/gh_fix/r3_windowLockCursor.cxx b/game_re/gh_fix/r3_windowLockCursor.cxx index d2a79d76..97fefba7 100644 --- a/game_re/gh_fix/r3_windowLockCursor.cxx +++ b/game_re/gh_fix/r3_windowLockCursor.cxx @@ -4,12 +4,10 @@ #include extern "C" { -HWND getHWND(void); // 00401300 // getHWND // stdcall // Params: | Types: | Return: typedef HWND HWND__ * +HWND getHWND(void); // 00401300 // getHWND // stdcall -// 00401320 // r3_windowLockCursor(cdecl) -// Parameters: | Types: | Return: undefined - -void unknown r3_windowLockCursor(void) +// 00401320 +void __cdecl r3_windowLockCursor(void) { HWND pHVar1; @@ -30,7 +28,7 @@ void unknown r3_windowLockCursor(void) RStack_30.right = tStack_10.right + -5 + RStack_30.left; RStack_30.bottom = RStack_30.top + -5 + tStack_10.bottom; ClipCursor(&RStack_30); - ShowCursor(0); + // ShowCursor(0); } return; } diff --git a/game_re/gh_fix/r3_windowProc.cxx b/game_re/gh_fix/r3_windowProc.cxx index ab4a991d..520322fb 100644 --- a/game_re/gh_fix/r3_windowProc.cxx +++ b/game_re/gh_fix/r3_windowProc.cxx @@ -4,7 +4,7 @@ #include extern "C" { -undefined FUN_00401320(void); // 00401320 // FUN_00401320 // cdecl +undefined r3_windowLockCursor(void); // 00401320 // r3_windowLockCursor // cdecl undefined r3_windowUnlockCursor(void); // 004013a0 // r3_windowUnlockCursor // cdecl // 004025e0 @@ -16,7 +16,7 @@ long __stdcall r3_windowProc(HWND hwnd,UINT uMsg,WPARAM wParam,LPARAM lParam) if (uMsg < WM_SETCURSOR + 1) { if (uMsg == WM_SETCURSOR) { if (((g_engineShouldRun != 0) && (g_engineRunning != 0)) && (g_runMaximized != 0)) { - FUN_00401320(); + r3_windowLockCursor(); return 1; } } diff --git a/game_re/gh_global.cxx b/game_re/gh_global.cxx index dfc3b484..5eca8f7c 100644 --- a/game_re/gh_global.cxx +++ b/game_re/gh_global.cxx @@ -64,8 +64,8 @@ undefined1& g_errModDInput= (undefined1&) GH_MEM(0x005bd29c); undefined4& DAT_005bd454= (undefined4&) GH_MEM(0x005bd454); const char* s__jc_z_d__s_005bd460 = "\\jc\\z%d:%s"; // 005bd460 undefined1& g_errModMmg= (undefined1&) GH_MEM(0x005bd58c); -FnProcessInput PTR_r3_processInput1_005bdb1c = (FnProcessInput)&GH_MEM(0x005bdb1c); // 005bdb1c -FnDisplay p_fn_vDisplayAll = (FnDisplay)&GH_MEM(0x005bdb24); // 005bdb24 +FnProcessInput PTR_r3_processInput1_005bdb1c = (FnProcessInput)GH_MEM(0x005bdb1c); // 005bdb1c +FnDisplay p_fn_vDisplayAll = (FnDisplay)GH_MEM(0x005bdb24); // 005bdb24 const char* s_R3_DVD_005bdfd8 = "R3_DVD"; // 005bdfd8 const char* s_R3_DVD_005be0ec = "R3_DVD"; // 005be0ec const char* s__s_DVD_missing_005be0f4 = "%s DVD missing "; // 005be0f4 @@ -73,7 +73,7 @@ const char* s_Die__s_DVDROM_kann_nicht_gelesen_005be130 = "Die %s DVDROM kann ni const char* s_Impossibile_trovare_il_DVD____s_005be198 = "Impossibile trovare il DVD : %s"; // 005be198 const char* s_DVD_s_no_v_lido_005be1ec = "DVD %s no v￡lido "; // 005be1ec const char* s_Impossible_de_trouver_le_DVD_____005be238 = "Impossible de trouver le DVD : %s"; // 005be238 -pointer s_Yes = (pointer)&GH_MEM(0x005be304); // 005be304 +pointer& s_Yes = (pointer&)GH_MEM(0x005be304); // 005be304 const char* s_SingleProcessor_005be308 = "SingleProcessor"; // 005be308 const char* lpDefault_005be318 = "No"; // 005be318 const char* s_StartDirectory_005be31c = "StartDirectory"; // 005be31c @@ -111,7 +111,7 @@ dword& DWORD_005cf974= (dword&) GH_MEM(0x005cf974); dword& DWORD_005cf978= (dword&) GH_MEM(0x005cf978); dword& DWORD_005cf97c= (dword&) GH_MEM(0x005cf97c); dword& DWORD_005cf980= (dword&) GH_MEM(0x005cf980); -char* PTR_005cf9b4 = (char*)&GH_MEM(0x005cf9b4); // 005cf9b4 +char*& PTR_005cf9b4 = (char*&)GH_MEM(0x005cf9b4); // 005cf9b4 GameStructure& g_currentBinkMovie= (GameStructure&) GH_MEM(0x005d2660); char(&s_volumeNameBuffer)[128] = reinterpret_cast(GH_MEM(0x005d27b0)); r3_main_data& r3_main_data_005d28b6= (r3_main_data&) GH_MEM(0x005d28b6); @@ -135,7 +135,7 @@ HWND& g_gameHWND= (HWND&) GH_MEM(0x0077d4c4); HANDLE& g_mainThreadHandle= (HANDLE&) GH_MEM(0x0077d4c8); char(&g_appCmdLine)[256] = reinterpret_cast(GH_MEM(0x0077d4e0)); char(&s_wndStrRestoring)[256] = reinterpret_cast(GH_MEM(0x0077d5e0)); -char* g_crt_cmdLine = (char*)&GH_MEM(0x0077ea84); // 0077ea84 +char*& g_crt_cmdLine = (char*&)GH_MEM(0x0077ea84); // 0077ea84 char(&s_quitting1)[64] = reinterpret_cast(GH_MEM(0x007825c0)); char(&s_wndStrQuiting)[56] = reinterpret_cast(GH_MEM(0x00782600)); GAM_EngineStructure& g_stEngineStructure= (GAM_EngineStructure&) GH_MEM(0x007d7dc0); diff --git a/game_re/gh_global.h b/game_re/gh_global.h index c5cb4e54..e35c912d 100644 --- a/game_re/gh_global.h +++ b/game_re/gh_global.h @@ -78,7 +78,7 @@ extern const char* s_Die__s_DVDROM_kann_nicht_gelesen_005be130; // 005be130 extern const char* s_Impossibile_trovare_il_DVD____s_005be198; // 005be198 extern const char* s_DVD_s_no_v_lido_005be1ec; // 005be1ec extern const char* s_Impossible_de_trouver_le_DVD_____005be238; // 005be238 -extern pointer s_Yes; // 005be304 +extern pointer& s_Yes; // 005be304 extern const char* s_SingleProcessor_005be308; // 005be308 extern const char* lpDefault_005be318; // 005be318 extern const char* s_StartDirectory_005be31c; // 005be31c @@ -116,7 +116,7 @@ extern dword& DWORD_005cf974; // 005cf974 extern dword& DWORD_005cf978; // 005cf978 extern dword& DWORD_005cf97c; // 005cf97c extern dword& DWORD_005cf980; // 005cf980 -extern char* PTR_005cf9b4; // 005cf9b4 +extern char*& PTR_005cf9b4; // 005cf9b4 extern GameStructure& g_currentBinkMovie; // 005d2660 extern char(&s_volumeNameBuffer)[128]; // 005d27b0 extern r3_main_data& r3_main_data_005d28b6; // 005d28b6 @@ -140,7 +140,7 @@ extern HWND& g_gameHWND; // 0077d4c4 extern HANDLE& g_mainThreadHandle; // 0077d4c8 extern char(&g_appCmdLine)[256]; // 0077d4e0 extern char(&s_wndStrRestoring)[256]; // 0077d5e0 -extern char* g_crt_cmdLine; // 0077ea84 +extern char*& g_crt_cmdLine; // 0077ea84 extern char(&s_quitting1)[64]; // 007825c0 extern char(&s_wndStrQuiting)[56]; // 00782600 extern GAM_EngineStructure& g_stEngineStructure; // 007d7dc0 diff --git a/game_re/gh_stub/Erm_fn_ucInitErrMsg.cxx b/game_re/gh_stub/Erm_fn_ucInitErrMsg.cxx index 0cc386e4..5c355598 100644 --- a/game_re/gh_stub/Erm_fn_ucInitErrMsg.cxx +++ b/game_re/gh_stub/Erm_fn_ucInitErrMsg.cxx @@ -9,5 +9,5 @@ // 0043e1d0 // Erm_fn_ucInitErrMsg extern "C" byte Erm_fn_ucInitErrMsg(void) { - return gh_stub_impl_stdcall<0x0043e1d0, byte>(); + return gh_stub_impl_stdcall<(stub_t)0x0043e1d0, byte>(); } diff --git a/game_re/gh_stub/FUN_004010b0.cxx b/game_re/gh_stub/FUN_004010b0.cxx index 502338c2..e5082884 100644 --- a/game_re/gh_stub/FUN_004010b0.cxx +++ b/game_re/gh_stub/FUN_004010b0.cxx @@ -9,5 +9,5 @@ // 004010b0 // FUN_004010b0 extern "C" undefined FUN_004010b0(void) { - return gh_stub_impl_cdecl<0x004010b0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x004010b0, undefined>(); } diff --git a/game_re/gh_stub/FUN_00402470.cxx b/game_re/gh_stub/FUN_00402470.cxx index 08c3f52f..e1a93de7 100644 --- a/game_re/gh_stub/FUN_00402470.cxx +++ b/game_re/gh_stub/FUN_00402470.cxx @@ -8,6 +8,6 @@ // 00402470 // FUN_00402470 -extern "C" undefined FUN_00402470(undefined4 param_1) { - return gh_stub_impl_cdecl<0x00402470, undefined>(param_1); +extern "C" void FUN_00402470(HWND param_1) { + gh_stub_impl_cdecl<(stub_t)0x00402470, void>(param_1); } diff --git a/game_re/gh_stub/FUN_0043e4f0.cxx b/game_re/gh_stub/FUN_0043e4f0.cxx index e6f83a8d..74101d99 100644 --- a/game_re/gh_stub/FUN_0043e4f0.cxx +++ b/game_re/gh_stub/FUN_0043e4f0.cxx @@ -9,5 +9,5 @@ // 0043e4f0 // FUN_0043e4f0 extern "C" undefined FUN_0043e4f0(void) { - return gh_stub_impl_cdecl<0x0043e4f0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x0043e4f0, undefined>(); } diff --git a/game_re/gh_stub/FUN_00441d70.cxx b/game_re/gh_stub/FUN_00441d70.cxx index 82e3139d..c5ef2ace 100644 --- a/game_re/gh_stub/FUN_00441d70.cxx +++ b/game_re/gh_stub/FUN_00441d70.cxx @@ -9,5 +9,5 @@ // 00441d70 // FUN_00441d70 extern "C" undefined FUN_00441d70(undefined4 param_1, undefined4 param_2, undefined4 param_3, undefined4 param_4, undefined4 param_5) { - return gh_stub_impl_cdecl<0x00441d70, undefined>(param_1, param_2, param_3, param_4, param_5); + return gh_stub_impl_cdecl<(stub_t)0x00441d70, undefined>(param_1, param_2, param_3, param_4, param_5); } diff --git a/game_re/gh_stub/FUN_00442c50.cxx b/game_re/gh_stub/FUN_00442c50.cxx index 4f15ea72..d78a314c 100644 --- a/game_re/gh_stub/FUN_00442c50.cxx +++ b/game_re/gh_stub/FUN_00442c50.cxx @@ -9,5 +9,5 @@ // 00442c50 // FUN_00442c50 extern "C" undefined FUN_00442c50(void) { - return gh_stub_impl_cdecl<0x00442c50, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00442c50, undefined>(); } diff --git a/game_re/gh_stub/FUN_00442f70.cxx b/game_re/gh_stub/FUN_00442f70.cxx index da149055..7b278eae 100644 --- a/game_re/gh_stub/FUN_00442f70.cxx +++ b/game_re/gh_stub/FUN_00442f70.cxx @@ -9,5 +9,5 @@ // 00442f70 // FUN_00442f70 extern "C" undefined FUN_00442f70(undefined4 param_1) { - return gh_stub_impl_cdecl<0x00442f70, undefined>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x00442f70, undefined>(param_1); } diff --git a/game_re/gh_stub/FUN_00443120.cxx b/game_re/gh_stub/FUN_00443120.cxx index 856bbfbc..88fe4526 100644 --- a/game_re/gh_stub/FUN_00443120.cxx +++ b/game_re/gh_stub/FUN_00443120.cxx @@ -9,5 +9,5 @@ // 00443120 // FUN_00443120 extern "C" undefined FUN_00443120(undefined4 param_1) { - return gh_stub_impl_cdecl<0x00443120, undefined>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x00443120, undefined>(param_1); } diff --git a/game_re/gh_stub/FUN_00445440.cxx b/game_re/gh_stub/FUN_00445440.cxx index 1129e9ec..3a91206c 100644 --- a/game_re/gh_stub/FUN_00445440.cxx +++ b/game_re/gh_stub/FUN_00445440.cxx @@ -9,5 +9,5 @@ // 00445440 // FUN_00445440 extern "C" undefined FUN_00445440(void) { - return gh_stub_impl_cdecl<0x00445440, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00445440, undefined>(); } diff --git a/game_re/gh_stub/FUN_00445460.cxx b/game_re/gh_stub/FUN_00445460.cxx index d2b04d5c..f9e42be4 100644 --- a/game_re/gh_stub/FUN_00445460.cxx +++ b/game_re/gh_stub/FUN_00445460.cxx @@ -9,5 +9,5 @@ // 00445460 // FUN_00445460 extern "C" undefined FUN_00445460(void) { - return gh_stub_impl_cdecl<0x00445460, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00445460, undefined>(); } diff --git a/game_re/gh_stub/FUN_00447130.cxx b/game_re/gh_stub/FUN_00447130.cxx index b12ccfdc..86e1170c 100644 --- a/game_re/gh_stub/FUN_00447130.cxx +++ b/game_re/gh_stub/FUN_00447130.cxx @@ -9,5 +9,5 @@ // 00447130 // FUN_00447130 extern "C" undefined FUN_00447130(void) { - return gh_stub_impl_cdecl<0x00447130, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00447130, undefined>(); } diff --git a/game_re/gh_stub/FUN_00451530.cxx b/game_re/gh_stub/FUN_00451530.cxx index 9b223b28..87dc0a6f 100644 --- a/game_re/gh_stub/FUN_00451530.cxx +++ b/game_re/gh_stub/FUN_00451530.cxx @@ -9,5 +9,5 @@ // 00451530 // FUN_00451530 extern "C" undefined FUN_00451530(undefined4 param_1) { - return gh_stub_impl_cdecl<0x00451530, undefined>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x00451530, undefined>(param_1); } diff --git a/game_re/gh_stub/FUN_0045fc70.cxx b/game_re/gh_stub/FUN_0045fc70.cxx index 9fc686a2..11890f69 100644 --- a/game_re/gh_stub/FUN_0045fc70.cxx +++ b/game_re/gh_stub/FUN_0045fc70.cxx @@ -9,5 +9,5 @@ // 0045fc70 // FUN_0045fc70 extern "C" undefined FUN_0045fc70(undefined4 param_1) { - return gh_stub_impl_cdecl<0x0045fc70, undefined>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x0045fc70, undefined>(param_1); } diff --git a/game_re/gh_stub/FUN_00470350.cxx b/game_re/gh_stub/FUN_00470350.cxx index 2ee4b8b2..02d1f556 100644 --- a/game_re/gh_stub/FUN_00470350.cxx +++ b/game_re/gh_stub/FUN_00470350.cxx @@ -9,5 +9,5 @@ // 00470350 // FUN_00470350 extern "C" undefined FUN_00470350(void) { - return gh_stub_impl_cdecl<0x00470350, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00470350, undefined>(); } diff --git a/game_re/gh_stub/FUN_00470410.cxx b/game_re/gh_stub/FUN_00470410.cxx index 0e1b49b0..d12a61ca 100644 --- a/game_re/gh_stub/FUN_00470410.cxx +++ b/game_re/gh_stub/FUN_00470410.cxx @@ -9,5 +9,5 @@ // 00470410 // FUN_00470410 extern "C" undefined FUN_00470410(void) { - return gh_stub_impl_cdecl<0x00470410, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00470410, undefined>(); } diff --git a/game_re/gh_stub/FUN_00470db0.cxx b/game_re/gh_stub/FUN_00470db0.cxx index 36f1a5d2..e444755e 100644 --- a/game_re/gh_stub/FUN_00470db0.cxx +++ b/game_re/gh_stub/FUN_00470db0.cxx @@ -9,5 +9,5 @@ // 00470db0 // FUN_00470db0 extern "C" undefined FUN_00470db0(void) { - return gh_stub_impl_cdecl<0x00470db0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00470db0, undefined>(); } diff --git a/game_re/gh_stub/FUN_00472150.cxx b/game_re/gh_stub/FUN_00472150.cxx index 161e1c03..fc58de28 100644 --- a/game_re/gh_stub/FUN_00472150.cxx +++ b/game_re/gh_stub/FUN_00472150.cxx @@ -9,5 +9,5 @@ // 00472150 // FUN_00472150 extern "C" undefined FUN_00472150(void) { - return gh_stub_impl_cdecl<0x00472150, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00472150, undefined>(); } diff --git a/game_re/gh_stub/FUN_004725a0.cxx b/game_re/gh_stub/FUN_004725a0.cxx index b2e3a410..f954e4ac 100644 --- a/game_re/gh_stub/FUN_004725a0.cxx +++ b/game_re/gh_stub/FUN_004725a0.cxx @@ -9,5 +9,5 @@ // 004725a0 // FUN_004725a0 extern "C" undefined FUN_004725a0(void) { - return gh_stub_impl_cdecl<0x004725a0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x004725a0, undefined>(); } diff --git a/game_re/gh_stub/FUN_0047bae0.cxx b/game_re/gh_stub/FUN_0047bae0.cxx index 809607bd..db39d6c3 100644 --- a/game_re/gh_stub/FUN_0047bae0.cxx +++ b/game_re/gh_stub/FUN_0047bae0.cxx @@ -9,5 +9,5 @@ // 0047bae0 // FUN_0047bae0 extern "C" undefined FUN_0047bae0(void) { - return gh_stub_impl_cdecl<0x0047bae0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x0047bae0, undefined>(); } diff --git a/game_re/gh_stub/FUN_0048a920.cxx b/game_re/gh_stub/FUN_0048a920.cxx index 5832651f..9de294c0 100644 --- a/game_re/gh_stub/FUN_0048a920.cxx +++ b/game_re/gh_stub/FUN_0048a920.cxx @@ -9,5 +9,5 @@ // 0048a920 // FUN_0048a920 extern "C" undefined FUN_0048a920(undefined4 param_1) { - return gh_stub_impl_cdecl<0x0048a920, undefined>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x0048a920, undefined>(param_1); } diff --git a/game_re/gh_stub/FUN_004fa650.cxx b/game_re/gh_stub/FUN_004fa650.cxx index 7b8c8667..5afb669b 100644 --- a/game_re/gh_stub/FUN_004fa650.cxx +++ b/game_re/gh_stub/FUN_004fa650.cxx @@ -9,5 +9,5 @@ // 004fa650 // FUN_004fa650 extern "C" undefined FUN_004fa650(void) { - return gh_stub_impl_cdecl<0x004fa650, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x004fa650, undefined>(); } diff --git a/game_re/gh_stub/FUN_004fb300.cxx b/game_re/gh_stub/FUN_004fb300.cxx index f4e9bd5f..bdb42538 100644 --- a/game_re/gh_stub/FUN_004fb300.cxx +++ b/game_re/gh_stub/FUN_004fb300.cxx @@ -9,5 +9,5 @@ // 004fb300 // FUN_004fb300 extern "C" undefined FUN_004fb300(void) { - return gh_stub_impl_cdecl<0x004fb300, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x004fb300, undefined>(); } diff --git a/game_re/gh_stub/FUN_00503710.cxx b/game_re/gh_stub/FUN_00503710.cxx index 9d31f05a..519103e0 100644 --- a/game_re/gh_stub/FUN_00503710.cxx +++ b/game_re/gh_stub/FUN_00503710.cxx @@ -9,5 +9,5 @@ // 00503710 // FUN_00503710 extern "C" undefined FUN_00503710(void) { - return gh_stub_impl_cdecl<0x00503710, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00503710, undefined>(); } diff --git a/game_re/gh_stub/FUN_005038e0.cxx b/game_re/gh_stub/FUN_005038e0.cxx index 145c3afc..cfd02749 100644 --- a/game_re/gh_stub/FUN_005038e0.cxx +++ b/game_re/gh_stub/FUN_005038e0.cxx @@ -9,5 +9,5 @@ // 005038e0 // FUN_005038e0 extern "C" undefined FUN_005038e0(void) { - return gh_stub_impl_cdecl<0x005038e0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x005038e0, undefined>(); } diff --git a/game_re/gh_stub/FUN_0051a7a0.cxx b/game_re/gh_stub/FUN_0051a7a0.cxx index 386fd336..8e43ab2a 100644 --- a/game_re/gh_stub/FUN_0051a7a0.cxx +++ b/game_re/gh_stub/FUN_0051a7a0.cxx @@ -9,5 +9,5 @@ // 0051a7a0 // FUN_0051a7a0 extern "C" undefined FUN_0051a7a0(short hGLDDevice, undefined4 param_2) { - return gh_stub_impl_cdecl<0x0051a7a0, undefined>(hGLDDevice, param_2); + return gh_stub_impl_cdecl<(stub_t)0x0051a7a0, undefined>(hGLDDevice, param_2); } diff --git a/game_re/gh_stub/FUN_0051a900.cxx b/game_re/gh_stub/FUN_0051a900.cxx index a09780b0..32c69450 100644 --- a/game_re/gh_stub/FUN_0051a900.cxx +++ b/game_re/gh_stub/FUN_0051a900.cxx @@ -9,5 +9,5 @@ // 0051a900 // FUN_0051a900 extern "C" undefined FUN_0051a900(short hGLDDevice) { - return gh_stub_impl_cdecl<0x0051a900, undefined>(hGLDDevice); + return gh_stub_impl_cdecl<(stub_t)0x0051a900, undefined>(hGLDDevice); } diff --git a/game_re/gh_stub/IPT_fn_vActivateAllEntryElements.cxx b/game_re/gh_stub/IPT_fn_vActivateAllEntryElements.cxx index 39a6e372..7420487a 100644 --- a/game_re/gh_stub/IPT_fn_vActivateAllEntryElements.cxx +++ b/game_re/gh_stub/IPT_fn_vActivateAllEntryElements.cxx @@ -9,5 +9,5 @@ // 00505490 // IPT_fn_vActivateAllEntryElements extern "C" undefined IPT_fn_vActivateAllEntryElements(void) { - return gh_stub_impl_cdecl<0x00505490, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00505490, undefined>(); } diff --git a/game_re/gh_stub/IPT_fn_vReadInput.cxx b/game_re/gh_stub/IPT_fn_vReadInput.cxx index f8feeabf..5827d089 100644 --- a/game_re/gh_stub/IPT_fn_vReadInput.cxx +++ b/game_re/gh_stub/IPT_fn_vReadInput.cxx @@ -9,5 +9,5 @@ // 00505fe0 // IPT_fn_vReadInput extern "C" void IPT_fn_vReadInput(void) { - gh_stub_impl_stdcall<0x00505fe0, void>(); + gh_stub_impl_stdcall<(stub_t)0x00505fe0, void>(); } diff --git a/game_re/gh_stub/Mmg_fn_vFirstInitMmgModule.cxx b/game_re/gh_stub/Mmg_fn_vFirstInitMmgModule.cxx index 39578e08..cb4e509a 100644 --- a/game_re/gh_stub/Mmg_fn_vFirstInitMmgModule.cxx +++ b/game_re/gh_stub/Mmg_fn_vFirstInitMmgModule.cxx @@ -9,5 +9,5 @@ // 0043f830 // Mmg_fn_vFirstInitMmgModule extern "C" undefined Mmg_fn_vFirstInitMmgModule(undefined1 ucMaxNbChannel) { - return gh_stub_impl_stdcall<0x0043f830, undefined>(ucMaxNbChannel); + return gh_stub_impl_stdcall<(stub_t)0x0043f830, undefined>(ucMaxNbChannel); } diff --git a/game_re/gh_stub/SND_fn_vResumeSound.cxx b/game_re/gh_stub/SND_fn_vResumeSound.cxx index 443054a5..f6098c0f 100644 --- a/game_re/gh_stub/SND_fn_vResumeSound.cxx +++ b/game_re/gh_stub/SND_fn_vResumeSound.cxx @@ -9,5 +9,5 @@ // 0040a1e0 // SND_fn_vResumeSound extern "C" undefined SND_fn_vResumeSound(void) { - return gh_stub_impl_cdecl<0x0040a1e0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x0040a1e0, undefined>(); } diff --git a/game_re/gh_stub/UNKr3_renderViewport.cxx b/game_re/gh_stub/UNKr3_renderViewport.cxx index acab9cd6..d5872a9b 100644 --- a/game_re/gh_stub/UNKr3_renderViewport.cxx +++ b/game_re/gh_stub/UNKr3_renderViewport.cxx @@ -8,6 +8,6 @@ // 00447200 // ?r3_renderViewport -extern "C" undefined UNKr3_renderViewport(undefined4 viewportIdx) { - return gh_stub_impl_cdecl<0x00447200, undefined>(viewportIdx); +extern "C" bool UNKr3_renderViewport(byte viewportIdx) { + return gh_stub_impl_stdcall<(stub_t)0x00447200, bool>(viewportIdx); } diff --git a/game_re/gh_stub/doGraphics.cxx b/game_re/gh_stub/doGraphics.cxx index 997b9c77..1cf7ed0f 100644 --- a/game_re/gh_stub/doGraphics.cxx +++ b/game_re/gh_stub/doGraphics.cxx @@ -9,5 +9,5 @@ // 00447460 // doGraphics extern "C" void doGraphics(byte param_1) { - gh_stub_impl_stdcall<0x00447460, void>(param_1); + gh_stub_impl_stdcall<(stub_t)0x00447460, void>(param_1); } diff --git a/game_re/gh_stub/fn_bCreateMainDisplayScreen.cxx b/game_re/gh_stub/fn_bCreateMainDisplayScreen.cxx index 8676299a..16f19d46 100644 --- a/game_re/gh_stub/fn_bCreateMainDisplayScreen.cxx +++ b/game_re/gh_stub/fn_bCreateMainDisplayScreen.cxx @@ -9,5 +9,5 @@ // 004022f0 // fn_bCreateMainDisplayScreen extern "C" undefined fn_bCreateMainDisplayScreen(void) { - return gh_stub_impl_cdecl<0x004022f0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x004022f0, undefined>(); } diff --git a/game_re/gh_stub/g_setInitVar0.cxx b/game_re/gh_stub/g_setInitVar0.cxx index d7434bb4..17271e21 100644 --- a/game_re/gh_stub/g_setInitVar0.cxx +++ b/game_re/gh_stub/g_setInitVar0.cxx @@ -9,5 +9,5 @@ // 00401310 // g_setInitVar0 extern "C" void g_setInitVar0(void) { - gh_stub_impl_stdcall<0x00401310, void>(); + gh_stub_impl_stdcall<(stub_t)0x00401310, void>(); } diff --git a/game_re/gh_stub/getHWND.cxx b/game_re/gh_stub/getHWND.cxx index 94ff9a8d..9fc95d52 100644 --- a/game_re/gh_stub/getHWND.cxx +++ b/game_re/gh_stub/getHWND.cxx @@ -9,5 +9,5 @@ // 00401300 // getHWND extern "C" HWND getHWND(void) { - return gh_stub_impl_stdcall<0x00401300, HWND>(); + return gh_stub_impl_stdcall<(stub_t)0x00401300, HWND>(); } diff --git a/game_re/gh_stub/get_one.cxx b/game_re/gh_stub/get_one.cxx index c2317c47..3db0e267 100644 --- a/game_re/gh_stub/get_one.cxx +++ b/game_re/gh_stub/get_one.cxx @@ -9,5 +9,5 @@ // 0046f2c0 // get_one extern "C" int get_one(void) { - return gh_stub_impl_cdecl<0x0046f2c0, int>(); + return gh_stub_impl_cdecl<(stub_t)0x0046f2c0, int>(); } diff --git a/game_re/gh_stub/gfx_init2.cxx b/game_re/gh_stub/gfx_init2.cxx index 724c8568..64784d5f 100644 --- a/game_re/gh_stub/gfx_init2.cxx +++ b/game_re/gh_stub/gfx_init2.cxx @@ -9,5 +9,5 @@ // 00470be0 // gfx_init2 extern "C" undefined gfx_init2(void) { - return gh_stub_impl_cdecl<0x00470be0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00470be0, undefined>(); } diff --git a/game_re/gh_stub/loadSplashBitmap.cxx b/game_re/gh_stub/loadSplashBitmap.cxx index 31ec0c12..ff94dc2a 100644 --- a/game_re/gh_stub/loadSplashBitmap.cxx +++ b/game_re/gh_stub/loadSplashBitmap.cxx @@ -9,5 +9,5 @@ // 00402450 // loadSplashBitmap extern "C" void loadSplashBitmap(HWND unused) { - gh_stub_impl_stdcall<0x00402450, void>(unused); + gh_stub_impl_stdcall<(stub_t)0x00402450, void>(unused); } diff --git a/game_re/gh_stub/r3_closeConcatTextureFile.cxx b/game_re/gh_stub/r3_closeConcatTextureFile.cxx index 49011b6a..709b610f 100644 --- a/game_re/gh_stub/r3_closeConcatTextureFile.cxx +++ b/game_re/gh_stub/r3_closeConcatTextureFile.cxx @@ -9,5 +9,5 @@ // 004711d0 // r3_closeConcatTextureFile extern "C" undefined r3_closeConcatTextureFile(void) { - return gh_stub_impl_cdecl<0x004711d0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x004711d0, undefined>(); } diff --git a/game_re/gh_stub/r3_config_setGLIMode.cxx b/game_re/gh_stub/r3_config_setGLIMode.cxx index dc1a7317..e023ce63 100644 --- a/game_re/gh_stub/r3_config_setGLIMode.cxx +++ b/game_re/gh_stub/r3_config_setGLIMode.cxx @@ -9,5 +9,5 @@ // 004704e0 // r3_config_setGLIMode extern "C" undefined r3_config_setGLIMode(char * param_1) { - return gh_stub_impl_cdecl<0x004704e0, undefined>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x004704e0, undefined>(param_1); } diff --git a/game_re/gh_stub/r3_config_setIdentifier.cxx b/game_re/gh_stub/r3_config_setIdentifier.cxx index 6ce5b076..e7fcfae2 100644 --- a/game_re/gh_stub/r3_config_setIdentifier.cxx +++ b/game_re/gh_stub/r3_config_setIdentifier.cxx @@ -9,5 +9,5 @@ // 00470570 // r3_config_setIdentifier extern "C" undefined r3_config_setIdentifier(char * param_1) { - return gh_stub_impl_cdecl<0x00470570, undefined>(param_1); + return gh_stub_impl_cdecl<(stub_t)0x00470570, undefined>(param_1); } diff --git a/game_re/gh_stub/r3_config_setTexturesMem.cxx b/game_re/gh_stub/r3_config_setTexturesMem.cxx index 8cdd72af..e842267b 100644 --- a/game_re/gh_stub/r3_config_setTexturesMem.cxx +++ b/game_re/gh_stub/r3_config_setTexturesMem.cxx @@ -9,5 +9,5 @@ // 00470f30 // r3_config_setTexturesMem extern "C" void r3_config_setTexturesMem(char * param_1) { - gh_stub_impl_cdecl<0x00470f30, void>(param_1); + gh_stub_impl_cdecl<(stub_t)0x00470f30, void>(param_1); } diff --git a/game_re/gh_stub/r3_engineLoop.cxx b/game_re/gh_stub/r3_engineLoop.cxx index 207c1765..f8fa3d73 100644 --- a/game_re/gh_stub/r3_engineLoop.cxx +++ b/game_re/gh_stub/r3_engineLoop.cxx @@ -9,5 +9,5 @@ // 00401220 // r3_engineLoop extern "C" undefined r3_engineLoop(void) { - return gh_stub_impl_cdecl<0x00401220, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00401220, undefined>(); } diff --git a/game_re/gh_stub/r3_get_gli_height1.cxx b/game_re/gh_stub/r3_get_gli_height1.cxx index de291801..7ef751a0 100644 --- a/game_re/gh_stub/r3_get_gli_height1.cxx +++ b/game_re/gh_stub/r3_get_gli_height1.cxx @@ -9,5 +9,5 @@ // 0047bb00 // r3_get_gli_height1 extern "C" int r3_get_gli_height1(void) { - return gh_stub_impl_stdcall<0x0047bb00, int>(); + return gh_stub_impl_stdcall<(stub_t)0x0047bb00, int>(); } diff --git a/game_re/gh_stub/r3_get_gli_width1.cxx b/game_re/gh_stub/r3_get_gli_width1.cxx index 80627602..07976af4 100644 --- a/game_re/gh_stub/r3_get_gli_width1.cxx +++ b/game_re/gh_stub/r3_get_gli_width1.cxx @@ -9,5 +9,5 @@ // 0047baf0 // r3_get_gli_width1 extern "C" int r3_get_gli_width1(void) { - return gh_stub_impl_stdcall<0x0047baf0, int>(); + return gh_stub_impl_stdcall<(stub_t)0x0047baf0, int>(); } diff --git a/game_re/gh_stub/r3_gfxFrameUNK.cxx b/game_re/gh_stub/r3_gfxFrameUNK.cxx index 442dc605..94c9b36e 100644 --- a/game_re/gh_stub/r3_gfxFrameUNK.cxx +++ b/game_re/gh_stub/r3_gfxFrameUNK.cxx @@ -9,5 +9,5 @@ // 0046fed0 // r3_gfxFrame? extern "C" undefined r3_gfxFrameUNK(void) { - return gh_stub_impl_cdecl<0x0046fed0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x0046fed0, undefined>(); } diff --git a/game_re/gh_stub/r3_load_textures_2.cxx b/game_re/gh_stub/r3_load_textures_2.cxx index 97a1b60e..24a2c361 100644 --- a/game_re/gh_stub/r3_load_textures_2.cxx +++ b/game_re/gh_stub/r3_load_textures_2.cxx @@ -9,5 +9,5 @@ // 00471760 // r3_load_textures_2 extern "C" undefined r3_load_textures_2(void) { - return gh_stub_impl_cdecl<0x00471760, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00471760, undefined>(); } diff --git a/game_re/gh_stub/r3_module1_init.cxx b/game_re/gh_stub/r3_module1_init.cxx index cd7afd23..48cb179b 100644 --- a/game_re/gh_stub/r3_module1_init.cxx +++ b/game_re/gh_stub/r3_module1_init.cxx @@ -9,5 +9,5 @@ // 0043e630 // r3_module1_init extern "C" undefined r3_module1_init(void) { - return gh_stub_impl_cdecl<0x0043e630, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x0043e630, undefined>(); } diff --git a/game_re/gh_stub/r3_module_big_init.cxx b/game_re/gh_stub/r3_module_big_init.cxx index ba2c7982..00f08553 100644 --- a/game_re/gh_stub/r3_module_big_init.cxx +++ b/game_re/gh_stub/r3_module_big_init.cxx @@ -9,5 +9,5 @@ // 00443f10 // r3_module_big_init extern "C" undefined r3_module_big_init(void) { - return gh_stub_impl_cdecl<0x00443f10, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00443f10, undefined>(); } diff --git a/game_re/gh_stub/r3_noop.cxx b/game_re/gh_stub/r3_noop.cxx index 2c86ccbb..624ba703 100644 --- a/game_re/gh_stub/r3_noop.cxx +++ b/game_re/gh_stub/r3_noop.cxx @@ -9,5 +9,5 @@ // 00401100 // r3_noop extern "C" void r3_noop(void * p_cTxt1, void * p_cTxt2) { - gh_stub_impl_stdcall<0x00401100, void>(p_cTxt1, p_cTxt2); + gh_stub_impl_cdecl<(stub_t)0x00401100, void>(p_cTxt1, p_cTxt2); } diff --git a/game_re/gh_stub/r3_processInput1.cxx b/game_re/gh_stub/r3_processInput1.cxx index ba47782d..a5f33616 100644 --- a/game_re/gh_stub/r3_processInput1.cxx +++ b/game_re/gh_stub/r3_processInput1.cxx @@ -9,5 +9,5 @@ // 00446f10 // r3_processInput1 extern "C" undefined r3_processInput1(void) { - return gh_stub_impl_cdecl<0x00446f10, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00446f10, undefined>(); } diff --git a/game_re/gh_stub/r3_read_game_config_modem_quality.cxx b/game_re/gh_stub/r3_read_game_config_modem_quality.cxx index e220e764..ff91ad03 100644 --- a/game_re/gh_stub/r3_read_game_config_modem_quality.cxx +++ b/game_re/gh_stub/r3_read_game_config_modem_quality.cxx @@ -9,5 +9,5 @@ // 00445fc0 // r3_read_game_config_modem_quality extern "C" undefined r3_read_game_config_modem_quality(void) { - return gh_stub_impl_cdecl<0x00445fc0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00445fc0, undefined>(); } diff --git a/game_re/gh_stub/r3_read_game_config_udp_port.cxx b/game_re/gh_stub/r3_read_game_config_udp_port.cxx index a942d18a..618efe44 100644 --- a/game_re/gh_stub/r3_read_game_config_udp_port.cxx +++ b/game_re/gh_stub/r3_read_game_config_udp_port.cxx @@ -9,5 +9,5 @@ // 00446040 // r3_read_game_config_udp_port extern "C" undefined r3_read_game_config_udp_port(void) { - return gh_stub_impl_cdecl<0x00446040, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x00446040, undefined>(); } diff --git a/game_re/gh_stub/FUN_0046fec0.cxx b/game_re/gh_stub/r3_setRendererState.cxx similarity index 67% rename from game_re/gh_stub/FUN_0046fec0.cxx rename to game_re/gh_stub/r3_setRendererState.cxx index 286f405e..fc1506b2 100644 --- a/game_re/gh_stub/FUN_0046fec0.cxx +++ b/game_re/gh_stub/r3_setRendererState.cxx @@ -7,7 +7,7 @@ #include // 0046fec0 -// FUN_0046fec0 -extern "C" undefined FUN_0046fec0(void) { - return gh_stub_impl_cdecl<0x0046fec0, undefined>(); +// r3_setRendererState +extern "C" void r3_setRendererState(void) { + gh_stub_impl_cdecl<(stub_t)0x0046fec0, void>(); } diff --git a/game_re/gh_stub/FUN_0046fe20.cxx b/game_re/gh_stub/r3_setRendererState1.cxx similarity index 52% rename from game_re/gh_stub/FUN_0046fe20.cxx rename to game_re/gh_stub/r3_setRendererState1.cxx index dd901732..228161eb 100644 --- a/game_re/gh_stub/FUN_0046fe20.cxx +++ b/game_re/gh_stub/r3_setRendererState1.cxx @@ -7,7 +7,7 @@ #include // 0046fe20 -// FUN_0046fe20 -extern "C" undefined FUN_0046fe20(undefined4 param_1, undefined4 param_2, undefined4 param_3) { - return gh_stub_impl_cdecl<0x0046fe20, undefined>(param_1, param_2, param_3); +// r3_setRendererState1 +extern "C" undefined r3_setRendererState1(undefined4 param_1, undefined4 param_2, undefined4 param_3) { + return gh_stub_impl_cdecl<(stub_t)0x0046fe20, undefined>(param_1, param_2, param_3); } diff --git a/game_re/gh_stub/r3_set_GameDataPath.cxx b/game_re/gh_stub/r3_set_GameDataPath.cxx index 800fe79f..5eb23903 100644 --- a/game_re/gh_stub/r3_set_GameDataPath.cxx +++ b/game_re/gh_stub/r3_set_GameDataPath.cxx @@ -9,5 +9,5 @@ // 0055a8d0 // r3_set_GameDataPath extern "C" void r3_set_GameDataPath(char * param_1) { - gh_stub_impl_cdecl<0x0055a8d0, void>(param_1); + gh_stub_impl_cdecl<(stub_t)0x0055a8d0, void>(param_1); } diff --git a/game_re/gh_stub/setGameHWND3.cxx b/game_re/gh_stub/setGameHWND3.cxx index 0cbd6226..236ff4d1 100644 --- a/game_re/gh_stub/setGameHWND3.cxx +++ b/game_re/gh_stub/setGameHWND3.cxx @@ -9,5 +9,5 @@ // 0043e620 // setGameHWND3 extern "C" void setGameHWND3(HWND wnd) { - gh_stub_impl_stdcall<0x0043e620, void>(wnd); + gh_stub_impl_stdcall<(stub_t)0x0043e620, void>(wnd); } diff --git a/game_re/gh_stub/spawnThread.cxx b/game_re/gh_stub/spawnThread.cxx index 8c3c768f..8984d0b3 100644 --- a/game_re/gh_stub/spawnThread.cxx +++ b/game_re/gh_stub/spawnThread.cxx @@ -9,5 +9,5 @@ // 004477d0 // spawnThread extern "C" undefined spawnThread(void) { - return gh_stub_impl_cdecl<0x004477d0, undefined>(); + return gh_stub_impl_cdecl<(stub_t)0x004477d0, undefined>(); } diff --git a/game_re/r3/binders/dbg_mem.cxx b/game_re/r3/binders/dbg_mem.cxx index 468ae309..0c8dfd38 100644 --- a/game_re/r3/binders/dbg_mem.cxx +++ b/game_re/r3/binders/dbg_mem.cxx @@ -212,7 +212,8 @@ uint8_t *gh_map_dbg_mem(size_t addr) { } void *gh_stub_impl_ptr(void *ptr) { R3Bin::get(); - SPDLOG_DEBUG("Forwarding implementation at {}", ptr); - return (void *)R3Bin::get().translateAddress((void *)ptr); + void* r = (void *)R3Bin::get().translateAddress((void *)ptr); + SPDLOG_DEBUG("Forwarding implementation at {} => {}", ptr, r); + return r; } void gh_init_dbg_loader() { R3Bin::get(); } \ No newline at end of file diff --git a/game_re/r3/binders/stub.h b/game_re/r3/binders/stub.h index 0b66e2ce..7bdd2e9b 100644 --- a/game_re/r3/binders/stub.h +++ b/game_re/r3/binders/stub.h @@ -9,31 +9,33 @@ struct GHStubException : public std::exception { void *gh_stub_impl_ptr(void *ptr); -template +typedef uintptr_t stub_t; + +template struct TStubFunctionImpl { + typedef T (*TFn)(Args...); + static inline TFn ptr = (TFn)gh_stub_impl_ptr((void *)addr); +}; + +template +struct TStubFunctionImplStdCall { + typedef T (*__stdcall TFn)(Args...); + static inline TFn ptr = (TFn)gh_stub_impl_ptr((void *)addr); +}; + +template T gh_stub_impl_cdecl(Args... args) { #if RE_DBG_INJECTED -#if MSVC - static T (*__cdecl ptr)(Args...) = (T(*)(Args...))gh_stub_impl_ptr((void*)addr); -#else - using TFn = __cdecl T (*)(Args...); - static TFn ptr = (TFn)gh_stub_impl_ptr((void*)addr); -#endif + auto ptr = TStubFunctionImpl::ptr; return ptr(args...); #else throw GHStubException("Function not implemented"); #endif } -template +template T gh_stub_impl_stdcall(Args... args) { #if RE_DBG_INJECTED -#if MSVC - static T (*__stdcall ptr)(Args...) = - (T(*__stdcall)(Args...))gh_stub_impl_ptr((void*)addr); -#else - using TFn = __stdcall T (*)(Args...); - static TFn ptr = (TFn)gh_stub_impl_ptr((void*)addr); -#endif + auto ptr = TStubFunctionImplStdCall::ptr; return ptr(args...); #else throw GHStubException("Function not implemented"); diff --git a/game_re/r3/main.cxx b/game_re/r3/main.cxx index 3d9574e0..9fa92c25 100644 --- a/game_re/r3/main.cxx +++ b/game_re/r3/main.cxx @@ -15,10 +15,28 @@ void gh_pre_main(void); #include #endif +#include +#include + extern "C" int r3_main(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR *cmdline, int showCmd); + int main(int argc, char **argv) { + CLI::App app("Reman 3: The hooded ones"); + std::string log_level = "info"; + app.add_option("-l,--log-level", log_level, "Log level"); + + CLI11_PARSE(app, argc, argv); + + auto log_level_enum = magic_enum::enum_cast(log_level); + if (log_level_enum.has_value()) { + spdlog::set_level(log_level_enum.value()); + } else { + SPDLOG_ERROR("Invalid log level: {}", log_level); + return 1; + } + try { #if RE_DBG_INJECTED gh_init_dbg_loader(); diff --git a/third_party/CLI11/CLI11.hpp b/third_party/CLI11/CLI11.hpp new file mode 100644 index 00000000..3913fa9c --- /dev/null +++ b/third_party/CLI11/CLI11.hpp @@ -0,0 +1,9686 @@ +// CLI11: Version 2.3.2 +// Originally designed by Henry Schreiner +// https://github.com/CLIUtils/CLI11 +// +// This is a standalone header file generated by MakeSingleHeader.py in CLI11/scripts +// from: v2.3.2 +// +// CLI11 2.3.2 Copyright (c) 2017-2022 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. + +#pragma once + +// 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 + + +#define CLI11_VERSION_MAJOR 2 +#define CLI11_VERSION_MINOR 3 +#define CLI11_VERSION_PATCH 2 +#define CLI11_VERSION "2.3.2" + + + + +// 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 + +// GCC < 10 doesn't ignore this in unevaluated contexts +#if !defined(CLI11_CPP17) || \ + (defined(__GNUC__) && !defined(__llvm__) && !defined(__INTEL_COMPILER) && __GNUC__ < 10 && __GNUC__ > 4) +#define CLI11_NODISCARD +#else +#define CLI11_NODISCARD [[nodiscard]] +#endif + +/** detection of rtti */ +#ifndef CLI11_USE_STATIC_RTTI +#if(defined(_HAS_STATIC_RTTI) && _HAS_STATIC_RTTI) +#define CLI11_USE_STATIC_RTTI 1 +#elif defined(__cpp_rtti) +#if(defined(_CPPRTTI) && _CPPRTTI == 0) +#define CLI11_USE_STATIC_RTTI 1 +#else +#define CLI11_USE_STATIC_RTTI 0 +#endif +#elif(defined(__GCC_RTTI) && __GXX_RTTI) +#define CLI11_USE_STATIC_RTTI 0 +#else +#define CLI11_USE_STATIC_RTTI 1 +#endif +#endif + +/** Inline macro **/ +#ifdef CLI11_COMPILE +#define CLI11_INLINE +#else +#define CLI11_INLINE inline +#endif + + + +// C standard library +// Only needed for existence checking +#if defined CLI11_CPP17 && defined __has_include && !defined CLI11_HAS_FILESYSTEM +#if __has_include() +// Filesystem cannot be used if targeting macOS < 10.15 +#if defined __MAC_OS_X_VERSION_MIN_REQUIRED && __MAC_OS_X_VERSION_MIN_REQUIRED < 101500 +#define CLI11_HAS_FILESYSTEM 0 +#elif defined(__wasi__) +// As of wasi-sdk-14, filesystem is not implemented +#define CLI11_HAS_FILESYSTEM 0 +#else +#include +#if defined __cpp_lib_filesystem && __cpp_lib_filesystem >= 201703 +#if defined _GLIBCXX_RELEASE && _GLIBCXX_RELEASE >= 9 +#define CLI11_HAS_FILESYSTEM 1 +#elif defined(__GLIBCXX__) +// if we are using gcc and Version <9 default to no filesystem +#define CLI11_HAS_FILESYSTEM 0 +#else +#define CLI11_HAS_FILESYSTEM 1 +#endif +#else +#define CLI11_HAS_FILESYSTEM 0 +#endif +#endif +#endif +#endif + +#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 +#include // NOLINT(build/include) +#else +#include +#include +#endif + + + +namespace CLI { + + +/// Include the items in this namespace to get free conversion of enums to/from streams. +/// (This is available inside CLI as well, so CLI11 will use this without a using statement). +namespace enums { + +/// output streaming for enumerations +template ::value>::type> +std::ostream &operator<<(std::ostream &in, const T &item) { + // make sure this is out of the detail namespace otherwise it won't be found when needed + return in << static_cast::type>(item); +} + +} // namespace enums + +/// Export to CLI namespace +using enums::operator<<; + +namespace detail { +/// a constant defining an expected max vector size defined to be a big number that could be multiplied by 4 and not +/// produce overflow for some expected uses +constexpr int expected_max_vector_size{1 << 29}; +// Based on http://stackoverflow.com/questions/236129/split-a-string-in-c +/// Split a string by a delim +CLI11_INLINE std::vector split(const std::string &s, char delim); + +/// Simple function to join a string +template std::string join(const T &v, std::string delim = ",") { + std::ostringstream s; + auto beg = std::begin(v); + auto end = std::end(v); + if(beg != end) + s << *beg++; + while(beg != end) { + s << delim << *beg++; + } + return s.str(); +} + +/// Simple function to join a string from processed elements +template ::value>::type> +std::string join(const T &v, Callable func, std::string delim = ",") { + std::ostringstream s; + auto beg = std::begin(v); + auto end = std::end(v); + auto loc = s.tellp(); + while(beg != end) { + auto nloc = s.tellp(); + if(nloc > loc) { + s << delim; + loc = nloc; + } + s << func(*beg++); + } + return s.str(); +} + +/// Join a string in reverse order +template std::string rjoin(const T &v, std::string delim = ",") { + std::ostringstream s; + for(std::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 +CLI11_INLINE std::string <rim(std::string &str); + +/// Trim anything from left of string +CLI11_INLINE std::string <rim(std::string &str, const std::string &filter); + +/// Trim whitespace from right of string +CLI11_INLINE std::string &rtrim(std::string &str); + +/// Trim anything from right of string +CLI11_INLINE std::string &rtrim(std::string &str, const std::string &filter); + +/// 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); +} + +/// remove quotes at the front and back of a string either '"' or '\'' +CLI11_INLINE std::string &remove_quotes(std::string &str); + +/// 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. +CLI11_INLINE std::string fix_newlines(const std::string &leader, std::string input); + +/// 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 +CLI11_INLINE std::ostream & +format_help(std::ostream &out, std::string name, const std::string &description, std::size_t wid); + +/// Print subcommand aliases +CLI11_INLINE std::ostream &format_aliases(std::ostream &out, const std::vector &aliases, std::size_t wid); + +/// Verify the first character of an option +/// - is a trigger character, ! has special meaning and new lines would just be annoying to deal with +template bool valid_first_char(T c) { return ((c != '-') && (c != '!') && (c != ' ') && c != '\n'); } + +/// Verify following characters of an option +template bool valid_later_char(T c) { + // = and : are value separators, { has special meaning for option defaults, + // and \n would just be annoying to deal with in many places allowing space here has too much potential for + // inadvertent entry errors and bugs + return ((c != '=') && (c != ':') && (c != '{') && (c != ' ') && c != '\n'); +} + +/// Verify an option/subcommand name +CLI11_INLINE bool valid_name_string(const std::string &str); + +/// Verify an app name +inline bool valid_alias_name_string(const std::string &str) { + static const std::string badChars(std::string("\n") + '\0'); + return (str.find_first_of(badChars) == std::string::npos); +} + +/// check if a string is a container segment separator (empty or "%%") +inline bool is_separator(const std::string &str) { + static const std::string sep("%%"); + return (str.empty() || str == sep); +} + +/// Verify that str consists of letters only +inline bool isalpha(const std::string &str) { + return std::all_of(str.begin(), str.end(), [](char c) { return std::isalpha(c, std::locale()); }); +} + +/// 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 +CLI11_INLINE std::string find_and_replace(std::string str, std::string from, std::string to); + +/// check if the flag definitions has possible false flags +inline bool has_default_flag_values(const std::string &flags) { + return (flags.find_first_of("{!") != std::string::npos); +} + +CLI11_INLINE void remove_default_flag_values(std::string &flags); + +/// Check if a string is a member of a list of strings and optionally ignore case or ignore underscores +CLI11_INLINE std::ptrdiff_t find_member(std::string name, + const std::vector names, + bool ignore_case = false, + bool ignore_underscore = false); + +/// 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) { + std::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 " +CLI11_INLINE std::vector split_up(std::string str, char delimiter = '\0'); + +/// 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. +CLI11_INLINE std::size_t escape_detect(std::string &str, std::size_t offset); + +/// Add quotes if the string contains spaces +CLI11_INLINE std::string &add_quotes_if_needed(std::string &str); + +} // namespace detail + + + + +namespace detail { +CLI11_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; +} + +CLI11_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; +} + +CLI11_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; +} + +CLI11_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; +} + +CLI11_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; +} + +CLI11_INLINE std::string &remove_quotes(std::string &str) { + if(str.length() > 1 && (str.front() == '"' || str.front() == '\'')) { + if(str.front() == str.back()) { + str.pop_back(); + str.erase(str.begin(), str.begin() + 1); + } + } + return str; +} + +CLI11_INLINE std::string fix_newlines(const 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; +} + +CLI11_INLINE std::ostream & +format_help(std::ostream &out, std::string name, const std::string &description, std::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)) << ""; + for(const char c : description) { + out.put(c); + if(c == '\n') { + out << std::setw(static_cast(wid)) << ""; + } + } + } + out << "\n"; + return out; +} + +CLI11_INLINE std::ostream &format_aliases(std::ostream &out, const std::vector &aliases, std::size_t wid) { + if(!aliases.empty()) { + out << std::setw(static_cast(wid)) << " aliases: "; + bool front = true; + for(const auto &alias : aliases) { + if(!front) { + out << ", "; + } else { + front = false; + } + out << detail::fix_newlines(" ", alias); + } + out << "\n"; + } + return out; +} + +CLI11_INLINE bool valid_name_string(const std::string &str) { + if(str.empty() || !valid_first_char(str[0])) { + return false; + } + auto e = str.end(); + for(auto c = str.begin() + 1; c != e; ++c) + if(!valid_later_char(*c)) + return false; + return true; +} + +CLI11_INLINE std::string find_and_replace(std::string str, std::string from, std::string to) { + + std::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; +} + +CLI11_INLINE void remove_default_flag_values(std::string &flags) { + auto loc = flags.find_first_of('{', 2); + while(loc != std::string::npos) { + auto finish = flags.find_first_of("},", loc + 1); + if((finish != std::string::npos) && (flags[finish] == '}')) { + flags.erase(flags.begin() + static_cast(loc), + flags.begin() + static_cast(finish) + 1); + } + loc = flags.find_first_of('{', loc + 1); + } + flags.erase(std::remove(flags.begin(), flags.end(), '!'), flags.end()); +} + +CLI11_INLINE std::ptrdiff_t +find_member(std::string name, const std::vector names, bool ignore_case, bool ignore_underscore) { + auto it = std::end(names); + if(ignore_case) { + if(ignore_underscore) { + name = detail::to_lower(detail::remove_underscore(name)); + it = std::find_if(std::begin(names), std::end(names), [&name](std::string local_name) { + return detail::to_lower(detail::remove_underscore(local_name)) == name; + }); + } else { + name = detail::to_lower(name); + it = std::find_if(std::begin(names), std::end(names), [&name](std::string local_name) { + return detail::to_lower(local_name) == name; + }); + } + + } else if(ignore_underscore) { + name = detail::remove_underscore(name); + it = std::find_if(std::begin(names), std::end(names), [&name](std::string local_name) { + return detail::remove_underscore(local_name) == name; + }); + } else { + it = std::find(std::begin(names), std::end(names), name); + } + + return (it != std::end(names)) ? (it - std::begin(names)) : (-1); +} + +CLI11_INLINE std::vector split_up(std::string str, char delimiter) { + + const std::string delims("\'\"`"); + auto find_ws = [delimiter](char ch) { + return (delimiter == '\0') ? std::isspace(ch, std::locale()) : (ch == delimiter); + }; + 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)); + if(end + 2 < str.size()) { + str = str.substr(end + 2); + } else { + str.clear(); + } + + } 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 + 1, 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; +} + +CLI11_INLINE std::size_t escape_detect(std::string &str, std::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; +} + +CLI11_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 + + + +// 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: + CLI11_NODISCARD int get_exit_code() const { return actual_exit_code; } + + CLI11_NODISCARD 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 {name + " requires " + other, ExitCodes::OptionAlreadyAdded}; + } + static OptionAlreadyAdded Excludes(std::string name, std::string other) { + return {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 Success { + CLI11_ERROR_DEF(Success, 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 Success { + CLI11_ERROR_DEF(Success, CallForAllHelp) + CallForAllHelp() + : CallForAllHelp("This should be caught in your main function, see examples", ExitCodes::Success) {} +}; + +/// -v or --version on command line +class CallForVersion : public Success { + CLI11_ERROR_DEF(Success, CallForVersion) + CallForVersion() + : CallForVersion("This should be caught in your main function, see examples", ExitCodes::Success) {} +}; + +/// Does not output a diagnostic in CLI11_PARSE, but allows main() to return 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(std::size_t min_subcom) { + if(min_subcom == 1) { + return RequiredError("A subcommand"); + } + return {"Requires at least " + std::to_string(min_subcom) + " subcommands", ExitCodes::RequiredError}; + } + static RequiredError + Option(std::size_t min_option, std::size_t max_option, std::size_t used, const std::string &option_list) { + if((min_option == 1) && (max_option == 1) && (used == 0)) + return RequiredError("Exactly 1 option from [" + option_list + "]"); + if((min_option == 1) && (max_option == 1) && (used > 1)) { + return {"Exactly 1 option from [" + option_list + "] is required and " + std::to_string(used) + + " were given", + ExitCodes::RequiredError}; + } + if((min_option == 1) && (used == 0)) + return RequiredError("At least 1 option from [" + option_list + "]"); + if(used < min_option) { + return {"Requires at least " + std::to_string(min_option) + " options used and only " + + std::to_string(used) + "were given from [" + option_list + "]", + ExitCodes::RequiredError}; + } + if(max_option == 1) + return {"Requires at most 1 options be given from [" + option_list + "]", ExitCodes::RequiredError}; + + return {"Requires at most " + std::to_string(max_option) + " options be used and " + std::to_string(used) + + "were given from [" + option_list + "]", + 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, std::size_t received) + : ArgumentMismatch(expected > 0 ? ("Expected exactly " + std::to_string(expected) + " arguments to " + name + + ", got " + std::to_string(received)) + : ("Expected at least " + std::to_string(-expected) + " arguments to " + name + + ", got " + std::to_string(received)), + ExitCodes::ArgumentMismatch) {} + + static ArgumentMismatch AtLeast(std::string name, int num, std::size_t received) { + return ArgumentMismatch(name + ": At least " + std::to_string(num) + " required but received " + + std::to_string(received)); + } + static ArgumentMismatch AtMost(std::string name, int num, std::size_t received) { + return ArgumentMismatch(name + ": At Most " + std::to_string(num) + " required but received " + + std::to_string(received)); + } + static ArgumentMismatch TypedAtLeast(std::string name, int num, std::string type) { + return ArgumentMismatch(name + ": " + std::to_string(num) + " required " + type + " missing"); + } + static ArgumentMismatch FlagOverride(std::string name) { + return ArgumentMismatch(name + " was given a disallowed flag override"); + } + static ArgumentMismatch PartialType(std::string name, int num, std::string type) { + return ArgumentMismatch(name + ": " + type + " only partially specified: " + std::to_string(num) + + " required for each element"); + } +}; + +/// 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) {} + ExtrasError(const std::string &name, std::vector args) + : ExtrasError(name, + (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 + +/// @} + + + + +// Type tools + +// Utilities for type enabling +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 = {}; +} // namespace detail + +/// 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/main/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; + +/// A copy of std::void_t from C++17 (helper for C++11 and C++14) +template struct make_void { + using type = void; +}; + +/// A copy of std::void_t from C++17 - same reasoning as enable_if_t, it does not hurt to redefine +template using void_t = typename make_void::type; + +/// A copy of std::conditional_t from C++14 - same reasoning as enable_if_t, it does not hurt to redefine +template using conditional_t = typename std::conditional::type; + +/// Check to see if something is bool (fail check by default) +template struct is_bool : std::false_type {}; + +/// Check to see if something is bool (true if actually a bool) +template <> struct is_bool : std::true_type {}; + +/// Check to see if something is a shared pointer +template struct is_shared_ptr : std::false_type {}; + +/// Check to see if something is a shared pointer (True if really a shared pointer) +template struct is_shared_ptr> : std::true_type {}; + +/// Check to see if something is a shared pointer (True if really a shared pointer) +template struct is_shared_ptr> : std::true_type {}; + +/// Check to see if something is copyable pointer +template struct is_copyable_ptr { + static bool const value = is_shared_ptr::value || std::is_pointer::value; +}; + +/// This can be specialized to override the type deduction for IsMember. +template struct IsMemberType { + using type = T; +}; + +/// The main custom type needed here is const char * should be a string. +template <> struct IsMemberType { + using type = std::string; +}; + +namespace detail { + +// These are utilities for IsMember and other transforming objects + +/// Handy helper to access the element_type generically. This is not part of is_copyable_ptr because it requires that +/// pointer_traits be valid. + +/// not a pointer +template struct element_type { + using type = T; +}; + +template struct element_type::value>::type> { + using type = typename std::pointer_traits::element_type; +}; + +/// Combination of the element type and value type - remove pointer (including smart pointers) and get the value_type of +/// the container +template struct element_value_type { + using type = typename element_type::type::value_type; +}; + +/// Adaptor for set-like structure: This just wraps a normal container in a few utilities that do almost nothing. +template struct pair_adaptor : std::false_type { + using value_type = typename T::value_type; + using first_type = typename std::remove_const::type; + using second_type = typename std::remove_const::type; + + /// Get the first value (really just the underlying value) + template static auto first(Q &&pair_value) -> decltype(std::forward(pair_value)) { + return std::forward(pair_value); + } + /// Get the second value (really just the underlying value) + template static auto second(Q &&pair_value) -> decltype(std::forward(pair_value)) { + return std::forward(pair_value); + } +}; + +/// Adaptor for map-like structure (true version, must have key_type and mapped_type). +/// This wraps a mapped container in a few utilities access it in a general way. +template +struct pair_adaptor< + T, + conditional_t, void>> + : std::true_type { + using value_type = typename T::value_type; + using first_type = typename std::remove_const::type; + using second_type = typename std::remove_const::type; + + /// Get the first value (really just the underlying value) + template static auto first(Q &&pair_value) -> decltype(std::get<0>(std::forward(pair_value))) { + return std::get<0>(std::forward(pair_value)); + } + /// Get the second value (really just the underlying value) + template static auto second(Q &&pair_value) -> decltype(std::get<1>(std::forward(pair_value))) { + return std::get<1>(std::forward(pair_value)); + } +}; + +// Warning is suppressed due to "bug" in gcc<5.0 and gcc 7.0 with c++17 enabled that generates a Wnarrowing warning +// in the unevaluated context even if the function that was using this wasn't used. The standard says narrowing in +// brace initialization shouldn't be allowed but for backwards compatibility gcc allows it in some contexts. It is a +// little fuzzy what happens in template constructs and I think that was something GCC took a little while to work out. +// But regardless some versions of gcc generate a warning when they shouldn't from the following code so that should be +// suppressed +#ifdef __GNUC__ +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wnarrowing" +#endif +// check for constructibility from a specific type and copy assignable used in the parse detection +template class is_direct_constructible { + template + static auto test(int, std::true_type) -> decltype( +// NVCC warns about narrowing conversions here +#ifdef __CUDACC__ +#pragma diag_suppress 2361 +#endif + TT{std::declval()} +#ifdef __CUDACC__ +#pragma diag_default 2361 +#endif + , + std::is_move_assignable()); + + template static auto test(int, std::false_type) -> std::false_type; + + template static auto test(...) -> std::false_type; + + public: + static constexpr bool value = decltype(test(0, typename std::is_constructible::type()))::value; +}; +#ifdef __GNUC__ +#pragma GCC diagnostic pop +#endif + +// Check for output streamability +// Based on https://stackoverflow.com/questions/22758291/how-can-i-detect-if-a-type-can-be-streamed-to-an-stdostream + +template class is_ostreamable { + template + static auto test(int) -> decltype(std::declval() << std::declval(), std::true_type()); + + template static auto test(...) -> std::false_type; + + public: + static constexpr bool value = decltype(test(0))::value; +}; + +/// Check for input streamability +template class is_istreamable { + template + static auto test(int) -> decltype(std::declval() >> std::declval(), std::true_type()); + + template static auto test(...) -> std::false_type; + + public: + static constexpr bool value = decltype(test(0))::value; +}; + +/// Check for complex +template class is_complex { + template + static auto test(int) -> decltype(std::declval().real(), std::declval().imag(), std::true_type()); + + template static auto test(...) -> std::false_type; + + public: + static constexpr bool value = decltype(test(0))::value; +}; + +/// Templated operation to get a value from a stream +template ::value, detail::enabler> = detail::dummy> +bool from_stream(const std::string &istring, T &obj) { + std::istringstream is; + is.str(istring); + is >> obj; + return !is.fail() && !is.rdbuf()->in_avail(); +} + +template ::value, detail::enabler> = detail::dummy> +bool from_stream(const std::string & /*istring*/, T & /*obj*/) { + return false; +} + +// check to see if an object is a mutable container (fail by default) +template struct is_mutable_container : std::false_type {}; + +/// type trait to test if a type is a mutable container meaning it has a value_type, it has an iterator, a clear, and +/// end methods and an insert function. And for our purposes we exclude std::string and types that can be constructed +/// from a std::string +template +struct is_mutable_container< + T, + conditional_t().end()), + decltype(std::declval().clear()), + decltype(std::declval().insert(std::declval().end())>(), + std::declval()))>, + void>> + : public conditional_t::value, std::false_type, std::true_type> {}; + +// check to see if an object is a mutable container (fail by default) +template struct is_readable_container : std::false_type {}; + +/// type trait to test if a type is a container meaning it has a value_type, it has an iterator, a clear, and an end +/// methods and an insert function. And for our purposes we exclude std::string and types that can be constructed from +/// a std::string +template +struct is_readable_container< + T, + conditional_t().end()), decltype(std::declval().begin())>, void>> + : public std::true_type {}; + +// check to see if an object is a wrapper (fail by default) +template struct is_wrapper : std::false_type {}; + +// check if an object is a wrapper (it has a value_type defined) +template +struct is_wrapper, void>> : public std::true_type {}; + +// Check for tuple like types, as in classes with a tuple_size type trait +template class is_tuple_like { + template + // static auto test(int) + // -> decltype(std::conditional<(std::tuple_size::value > 0), std::true_type, std::false_type>::type()); + static auto test(int) -> decltype(std::tuple_size::type>::value, std::true_type{}); + template static auto test(...) -> std::false_type; + + public: + static constexpr bool value = decltype(test(0))::value; +}; + +/// Convert an object to a string (directly forward if this can become a string) +template ::value, detail::enabler> = detail::dummy> +auto to_string(T &&value) -> decltype(std::forward(value)) { + return std::forward(value); +} + +/// Construct a string from the object +template ::value && !std::is_convertible::value, + detail::enabler> = detail::dummy> +std::string to_string(const T &value) { + return std::string(value); // NOLINT(google-readability-casting) +} + +/// Convert an object to a string (streaming must be supported for that type) +template ::value && !std::is_constructible::value && + is_ostreamable::value, + detail::enabler> = detail::dummy> +std::string to_string(T &&value) { + std::stringstream stream; + stream << value; + return stream.str(); +} + +/// If conversion is not supported, return an empty string (streaming is not supported for that type) +template ::value && !is_ostreamable::value && + !is_readable_container::type>::value, + detail::enabler> = detail::dummy> +std::string to_string(T &&) { + return {}; +} + +/// convert a readable container to a string +template ::value && !is_ostreamable::value && + is_readable_container::value, + detail::enabler> = detail::dummy> +std::string to_string(T &&variable) { + auto cval = variable.begin(); + auto end = variable.end(); + if(cval == end) { + return {"{}"}; + } + std::vector defaults; + while(cval != end) { + defaults.emplace_back(CLI::detail::to_string(*cval)); + ++cval; + } + return {"[" + detail::join(defaults) + "]"}; +} + +/// special template overload +template ::value, detail::enabler> = detail::dummy> +auto checked_to_string(T &&value) -> decltype(to_string(std::forward(value))) { + return to_string(std::forward(value)); +} + +/// special template overload +template ::value, detail::enabler> = detail::dummy> +std::string checked_to_string(T &&) { + return std::string{}; +} +/// get a string as a convertible value for arithmetic types +template ::value, detail::enabler> = detail::dummy> +std::string value_string(const T &value) { + return std::to_string(value); +} +/// get a string as a convertible value for enumerations +template ::value, detail::enabler> = detail::dummy> +std::string value_string(const T &value) { + return std::to_string(static_cast::type>(value)); +} +/// for other types just use the regular to_string function +template ::value && !std::is_arithmetic::value, detail::enabler> = detail::dummy> +auto value_string(const T &value) -> decltype(to_string(value)) { + return to_string(value); +} + +/// template to get the underlying value type if it exists or use a default +template struct wrapped_type { + using type = def; +}; + +/// Type size for regular object types that do not look like a tuple +template struct wrapped_type::value>::type> { + using type = typename T::value_type; +}; + +/// This will only trigger for actual void type +template struct type_count_base { + static const int value{0}; +}; + +/// Type size for regular object types that do not look like a tuple +template +struct type_count_base::value && !is_mutable_container::value && + !std::is_void::value>::type> { + static constexpr int value{1}; +}; + +/// the base tuple size +template +struct type_count_base::value && !is_mutable_container::value>::type> { + static constexpr int value{std::tuple_size::value}; +}; + +/// Type count base for containers is the type_count_base of the individual element +template struct type_count_base::value>::type> { + static constexpr int value{type_count_base::value}; +}; + +/// Set of overloads to get the type size of an object + +/// forward declare the subtype_count structure +template struct subtype_count; + +/// forward declare the subtype_count_min structure +template struct subtype_count_min; + +/// This will only trigger for actual void type +template struct type_count { + static const int value{0}; +}; + +/// Type size for regular object types that do not look like a tuple +template +struct type_count::value && !is_tuple_like::value && !is_complex::value && + !std::is_void::value>::type> { + static constexpr int value{1}; +}; + +/// Type size for complex since it sometimes looks like a wrapper +template struct type_count::value>::type> { + static constexpr int value{2}; +}; + +/// Type size of types that are wrappers,except complex and tuples(which can also be wrappers sometimes) +template struct type_count::value>::type> { + static constexpr int value{subtype_count::value}; +}; + +/// Type size of types that are wrappers,except containers complex and tuples(which can also be wrappers sometimes) +template +struct type_count::value && !is_complex::value && !is_tuple_like::value && + !is_mutable_container::value>::type> { + static constexpr int value{type_count::value}; +}; + +/// 0 if the index > tuple size +template +constexpr typename std::enable_if::value, int>::type tuple_type_size() { + return 0; +} + +/// Recursively generate the tuple type name +template + constexpr typename std::enable_if < I::value, int>::type tuple_type_size() { + return subtype_count::type>::value + tuple_type_size(); +} + +/// Get the type size of the sum of type sizes for all the individual tuple types +template struct type_count::value>::type> { + static constexpr int value{tuple_type_size()}; +}; + +/// definition of subtype count +template struct subtype_count { + static constexpr int value{is_mutable_container::value ? expected_max_vector_size : type_count::value}; +}; + +/// This will only trigger for actual void type +template struct type_count_min { + static const int value{0}; +}; + +/// Type size for regular object types that do not look like a tuple +template +struct type_count_min< + T, + typename std::enable_if::value && !is_tuple_like::value && !is_wrapper::value && + !is_complex::value && !std::is_void::value>::type> { + static constexpr int value{type_count::value}; +}; + +/// Type size for complex since it sometimes looks like a wrapper +template struct type_count_min::value>::type> { + static constexpr int value{1}; +}; + +/// Type size min of types that are wrappers,except complex and tuples(which can also be wrappers sometimes) +template +struct type_count_min< + T, + typename std::enable_if::value && !is_complex::value && !is_tuple_like::value>::type> { + static constexpr int value{subtype_count_min::value}; +}; + +/// 0 if the index > tuple size +template +constexpr typename std::enable_if::value, int>::type tuple_type_size_min() { + return 0; +} + +/// Recursively generate the tuple type name +template + constexpr typename std::enable_if < I::value, int>::type tuple_type_size_min() { + return subtype_count_min::type>::value + tuple_type_size_min(); +} + +/// Get the type size of the sum of type sizes for all the individual tuple types +template struct type_count_min::value>::type> { + static constexpr int value{tuple_type_size_min()}; +}; + +/// definition of subtype count +template struct subtype_count_min { + static constexpr int value{is_mutable_container::value + ? ((type_count::value < expected_max_vector_size) ? type_count::value : 0) + : type_count_min::value}; +}; + +/// This will only trigger for actual void type +template struct expected_count { + static const int value{0}; +}; + +/// For most types the number of expected items is 1 +template +struct expected_count::value && !is_wrapper::value && + !std::is_void::value>::type> { + static constexpr int value{1}; +}; +/// number of expected items in a vector +template struct expected_count::value>::type> { + static constexpr int value{expected_max_vector_size}; +}; + +/// number of expected items in a vector +template +struct expected_count::value && is_wrapper::value>::type> { + static constexpr int value{expected_count::value}; +}; + +// Enumeration of the different supported categorizations of objects +enum class object_category : int { + char_value = 1, + integral_value = 2, + unsigned_integral = 4, + enumeration = 6, + boolean_value = 8, + floating_point = 10, + number_constructible = 12, + double_constructible = 14, + integer_constructible = 16, + // string like types + string_assignable = 23, + string_constructible = 24, + other = 45, + // special wrapper or container types + wrapper_value = 50, + complex_number = 60, + tuple_value = 70, + container_value = 80, + +}; + +/// Set of overloads to classify an object according to type + +/// some type that is not otherwise recognized +template struct classify_object { + static constexpr object_category value{object_category::other}; +}; + +/// Signed integers +template +struct classify_object< + T, + typename std::enable_if::value && !std::is_same::value && std::is_signed::value && + !is_bool::value && !std::is_enum::value>::type> { + static constexpr object_category value{object_category::integral_value}; +}; + +/// Unsigned integers +template +struct classify_object::value && std::is_unsigned::value && + !std::is_same::value && !is_bool::value>::type> { + static constexpr object_category value{object_category::unsigned_integral}; +}; + +/// single character values +template +struct classify_object::value && !std::is_enum::value>::type> { + static constexpr object_category value{object_category::char_value}; +}; + +/// Boolean values +template struct classify_object::value>::type> { + static constexpr object_category value{object_category::boolean_value}; +}; + +/// Floats +template struct classify_object::value>::type> { + static constexpr object_category value{object_category::floating_point}; +}; + +/// String and similar direct assignment +template +struct classify_object::value && !std::is_integral::value && + std::is_assignable::value>::type> { + static constexpr object_category value{object_category::string_assignable}; +}; + +/// String and similar constructible and copy assignment +template +struct classify_object< + T, + typename std::enable_if::value && !std::is_integral::value && + !std::is_assignable::value && (type_count::value == 1) && + std::is_constructible::value>::type> { + static constexpr object_category value{object_category::string_constructible}; +}; + +/// Enumerations +template struct classify_object::value>::type> { + static constexpr object_category value{object_category::enumeration}; +}; + +template struct classify_object::value>::type> { + static constexpr object_category value{object_category::complex_number}; +}; + +/// Handy helper to contain a bunch of checks that rule out many common types (integers, string like, floating point, +/// vectors, and enumerations +template struct uncommon_type { + using type = typename std::conditional::value && !std::is_integral::value && + !std::is_assignable::value && + !std::is_constructible::value && !is_complex::value && + !is_mutable_container::value && !std::is_enum::value, + std::true_type, + std::false_type>::type; + static constexpr bool value = type::value; +}; + +/// wrapper type +template +struct classify_object::value && is_wrapper::value && + !is_tuple_like::value && uncommon_type::value)>::type> { + static constexpr object_category value{object_category::wrapper_value}; +}; + +/// Assignable from double or int +template +struct classify_object::value && type_count::value == 1 && + !is_wrapper::value && is_direct_constructible::value && + is_direct_constructible::value>::type> { + static constexpr object_category value{object_category::number_constructible}; +}; + +/// Assignable from int +template +struct classify_object::value && type_count::value == 1 && + !is_wrapper::value && !is_direct_constructible::value && + is_direct_constructible::value>::type> { + static constexpr object_category value{object_category::integer_constructible}; +}; + +/// Assignable from double +template +struct classify_object::value && type_count::value == 1 && + !is_wrapper::value && is_direct_constructible::value && + !is_direct_constructible::value>::type> { + static constexpr object_category value{object_category::double_constructible}; +}; + +/// Tuple type +template +struct classify_object< + T, + typename std::enable_if::value && + ((type_count::value >= 2 && !is_wrapper::value) || + (uncommon_type::value && !is_direct_constructible::value && + !is_direct_constructible::value) || + (uncommon_type::value && type_count::value >= 2))>::type> { + static constexpr object_category value{object_category::tuple_value}; + // the condition on this class requires it be like a tuple, but on some compilers (like Xcode) tuples can be + // constructed from just the first element so tuples of can be constructed from a string, which + // could lead to issues so there are two variants of the condition, the first isolates things with a type size >=2 + // mainly to get tuples on Xcode with the exception of wrappers, the second is the main one and just separating out + // those cases that are caught by other object classifications +}; + +/// container type +template struct classify_object::value>::type> { + static constexpr object_category value{object_category::container_value}; +}; + +// 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 == object_category::char_value, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "CHAR"; +} + +template ::value == object_category::integral_value || + classify_object::value == object_category::integer_constructible, + detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "INT"; +} + +template ::value == object_category::unsigned_integral, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "UINT"; +} + +template ::value == object_category::floating_point || + classify_object::value == object_category::number_constructible || + classify_object::value == object_category::double_constructible, + detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "FLOAT"; +} + +/// Print name for enumeration types +template ::value == object_category::enumeration, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "ENUM"; +} + +/// Print name for enumeration types +template ::value == object_category::boolean_value, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "BOOLEAN"; +} + +/// Print name for enumeration types +template ::value == object_category::complex_number, detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "COMPLEX"; +} + +/// Print for all other types +template ::value >= object_category::string_assignable && + classify_object::value <= object_category::other, + detail::enabler> = detail::dummy> +constexpr const char *type_name() { + return "TEXT"; +} +/// typename for tuple value +template ::value == object_category::tuple_value && type_count_base::value >= 2, + detail::enabler> = detail::dummy> +std::string type_name(); // forward declaration + +/// Generate type name for a wrapper or container value +template ::value == object_category::container_value || + classify_object::value == object_category::wrapper_value, + detail::enabler> = detail::dummy> +std::string type_name(); // forward declaration + +/// Print name for single element tuple types +template ::value == object_category::tuple_value && type_count_base::value == 1, + detail::enabler> = detail::dummy> +inline std::string type_name() { + return type_name::type>::type>(); +} + +/// Empty string if the index > tuple size +template +inline typename std::enable_if::value, std::string>::type tuple_name() { + return std::string{}; +} + +/// Recursively generate the tuple type name +template +inline typename std::enable_if<(I < type_count_base::value), std::string>::type tuple_name() { + auto str = std::string{type_name::type>::type>()} + ',' + + tuple_name(); + if(str.back() == ',') + str.pop_back(); + return str; +} + +/// Print type name for tuples with 2 or more elements +template ::value == object_category::tuple_value && type_count_base::value >= 2, + detail::enabler>> +inline std::string type_name() { + auto tname = std::string(1, '[') + tuple_name(); + tname.push_back(']'); + return tname; +} + +/// get the type name for a type that has a value_type member +template ::value == object_category::container_value || + classify_object::value == object_category::wrapper_value, + detail::enabler>> +inline std::string type_name() { + return type_name(); +} + +// Lexical cast + +/// Convert to an unsigned integral +template ::value, detail::enabler> = detail::dummy> +bool integral_conversion(const std::string &input, T &output) noexcept { + if(input.empty() || input.front() == '-') { + return false; + } + char *val = nullptr; + errno = 0; + std::uint64_t output_ll = std::strtoull(input.c_str(), &val, 0); + if(errno == ERANGE) { + return false; + } + output = static_cast(output_ll); + if(val == (input.c_str() + input.size()) && static_cast(output) == output_ll) { + return true; + } + val = nullptr; + std::int64_t output_sll = std::strtoll(input.c_str(), &val, 0); + if(val == (input.c_str() + input.size())) { + output = (output_sll < 0) ? static_cast(0) : static_cast(output_sll); + return (static_cast(output) == output_sll); + } + return false; +} + +/// Convert to a signed integral +template ::value, detail::enabler> = detail::dummy> +bool integral_conversion(const std::string &input, T &output) noexcept { + if(input.empty()) { + return false; + } + char *val = nullptr; + errno = 0; + std::int64_t output_ll = std::strtoll(input.c_str(), &val, 0); + if(errno == ERANGE) { + return false; + } + output = static_cast(output_ll); + if(val == (input.c_str() + input.size()) && static_cast(output) == output_ll) { + return true; + } + if(input == "true") { + // this is to deal with a few oddities with flags and wrapper int types + output = static_cast(1); + return true; + } + return false; +} + +/// Convert a flag into an integer value typically binary flags +inline std::int64_t to_flag_value(std::string val) { + static const std::string trueString("true"); + static const std::string falseString("false"); + if(val == trueString) { + return 1; + } + if(val == falseString) { + return -1; + } + val = detail::to_lower(val); + std::int64_t ret = 0; + if(val.size() == 1) { + if(val[0] >= '1' && val[0] <= '9') { + return (static_cast(val[0]) - '0'); + } + switch(val[0]) { + case '0': + case 'f': + case 'n': + case '-': + ret = -1; + break; + case 't': + case 'y': + case '+': + ret = 1; + break; + default: + throw std::invalid_argument("unrecognized character"); + } + return ret; + } + if(val == trueString || val == "on" || val == "yes" || val == "enable") { + ret = 1; + } else if(val == falseString || val == "off" || val == "no" || val == "disable") { + ret = -1; + } else { + ret = std::stoll(val); + } + return ret; +} + +/// Integer conversion +template ::value == object_category::integral_value || + classify_object::value == object_category::unsigned_integral, + detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + return integral_conversion(input, output); +} + +/// char values +template ::value == object_category::char_value, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + if(input.size() == 1) { + output = static_cast(input[0]); + return true; + } + return integral_conversion(input, output); +} + +/// Boolean values +template ::value == object_category::boolean_value, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + try { + auto out = to_flag_value(input); + output = (out > 0); + return true; + } catch(const std::invalid_argument &) { + return false; + } catch(const std::out_of_range &) { + // if the number is out of the range of a 64 bit value then it is still a number and for this purpose is still + // valid all we care about the sign + output = (input[0] != '-'); + return true; + } +} + +/// Floats +template ::value == object_category::floating_point, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + if(input.empty()) { + return false; + } + char *val = nullptr; + auto output_ld = std::strtold(input.c_str(), &val); + output = static_cast(output_ld); + return val == (input.c_str() + input.size()); +} + +/// complex +template ::value == object_category::complex_number, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + using XC = typename wrapped_type::type; + XC x{0.0}, y{0.0}; + auto str1 = input; + bool worked = false; + auto nloc = str1.find_last_of("+-"); + if(nloc != std::string::npos && nloc > 0) { + worked = lexical_cast(str1.substr(0, nloc), x); + str1 = str1.substr(nloc); + if(str1.back() == 'i' || str1.back() == 'j') + str1.pop_back(); + worked = worked && lexical_cast(str1, y); + } else { + if(str1.back() == 'i' || str1.back() == 'j') { + str1.pop_back(); + worked = lexical_cast(str1, y); + x = XC{0}; + } else { + worked = lexical_cast(str1, x); + y = XC{0}; + } + } + if(worked) { + output = T{x, y}; + return worked; + } + return from_stream(input, output); +} + +/// String and similar direct assignment +template ::value == object_category::string_assignable, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + output = input; + return true; +} + +/// String and similar constructible and copy assignment +template < + typename T, + enable_if_t::value == object_category::string_constructible, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + output = T(input); + return true; +} + +/// Enumerations +template ::value == object_category::enumeration, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + typename std::underlying_type::type val; + if(!integral_conversion(input, val)) { + return false; + } + output = static_cast(val); + return true; +} + +/// wrapper types +template ::value == object_category::wrapper_value && + std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + typename T::value_type val; + if(lexical_cast(input, val)) { + output = val; + return true; + } + return from_stream(input, output); +} + +template ::value == object_category::wrapper_value && + !std::is_assignable::value && std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + typename T::value_type val; + if(lexical_cast(input, val)) { + output = T{val}; + return true; + } + return from_stream(input, output); +} + +/// Assignable from double or int +template < + typename T, + enable_if_t::value == object_category::number_constructible, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + int val = 0; + if(integral_conversion(input, val)) { + output = T(val); + return true; + } + + double dval = 0.0; + if(lexical_cast(input, dval)) { + output = T{dval}; + return true; + } + + return from_stream(input, output); +} + +/// Assignable from int +template < + typename T, + enable_if_t::value == object_category::integer_constructible, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + int val = 0; + if(integral_conversion(input, val)) { + output = T(val); + return true; + } + return from_stream(input, output); +} + +/// Assignable from double +template < + typename T, + enable_if_t::value == object_category::double_constructible, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + double val = 0.0; + if(lexical_cast(input, val)) { + output = T{val}; + return true; + } + return from_stream(input, output); +} + +/// Non-string convertible from an int +template ::value == object_category::other && std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + int val = 0; + if(integral_conversion(input, val)) { +#ifdef _MSC_VER +#pragma warning(push) +#pragma warning(disable : 4800) +#endif + // with Atomic this could produce a warning due to the conversion but if atomic gets here it is an old style + // so will most likely still work + output = val; +#ifdef _MSC_VER +#pragma warning(pop) +#endif + return true; + } + // LCOV_EXCL_START + // This version of cast is only used for odd cases in an older compilers the fail over + // from_stream is tested elsewhere an not relevant for coverage here + return from_stream(input, output); + // LCOV_EXCL_STOP +} + +/// Non-string parsable by a stream +template ::value == object_category::other && !std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + static_assert(is_istreamable::value, + "option object type must have a lexical cast overload or streaming input operator(>>) defined, if it " + "is convertible from another type use the add_option(...) with XC being the known type"); + return from_stream(input, output); +} + +/// Assign a value through lexical cast operations +/// Strings can be empty so we need to do a little different +template ::value && + (classify_object::value == object_category::string_assignable || + classify_object::value == object_category::string_constructible), + detail::enabler> = detail::dummy> +bool lexical_assign(const std::string &input, AssignTo &output) { + return lexical_cast(input, output); +} + +/// Assign a value through lexical cast operations +template ::value && std::is_assignable::value && + classify_object::value != object_category::string_assignable && + classify_object::value != object_category::string_constructible, + detail::enabler> = detail::dummy> +bool lexical_assign(const std::string &input, AssignTo &output) { + if(input.empty()) { + output = AssignTo{}; + return true; + } + + return lexical_cast(input, output); +} + +/// Assign a value through lexical cast operations +template ::value && !std::is_assignable::value && + classify_object::value == object_category::wrapper_value, + detail::enabler> = detail::dummy> +bool lexical_assign(const std::string &input, AssignTo &output) { + if(input.empty()) { + typename AssignTo::value_type emptyVal{}; + output = emptyVal; + return true; + } + return lexical_cast(input, output); +} + +/// Assign a value through lexical cast operations for int compatible values +/// mainly for atomic operations on some compilers +template ::value && !std::is_assignable::value && + classify_object::value != object_category::wrapper_value && + std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_assign(const std::string &input, AssignTo &output) { + if(input.empty()) { + output = 0; + return true; + } + int val = 0; + if(lexical_cast(input, val)) { + output = val; + return true; + } + return false; +} + +/// Assign a value converted from a string in lexical cast to the output value directly +template ::value && std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_assign(const std::string &input, AssignTo &output) { + ConvertTo val{}; + bool parse_result = (!input.empty()) ? lexical_cast(input, val) : true; + if(parse_result) { + output = val; + } + return parse_result; +} + +/// Assign a value from a lexical cast through constructing a value and move assigning it +template < + typename AssignTo, + typename ConvertTo, + enable_if_t::value && !std::is_assignable::value && + std::is_move_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_assign(const std::string &input, AssignTo &output) { + ConvertTo val{}; + bool parse_result = input.empty() ? true : lexical_cast(input, val); + if(parse_result) { + output = AssignTo(val); // use () form of constructor to allow some implicit conversions + } + return parse_result; +} + +/// primary lexical conversion operation, 1 string to 1 type of some kind +template ::value <= object_category::other && + classify_object::value <= object_category::wrapper_value, + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + return lexical_assign(strings[0], output); +} + +/// Lexical conversion if there is only one element but the conversion type is for two, then call a two element +/// constructor +template ::value <= 2) && expected_count::value == 1 && + is_tuple_like::value && type_count_base::value == 2, + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + // the remove const is to handle pair types coming from a container + typename std::remove_const::type>::type v1; + typename std::tuple_element<1, ConvertTo>::type v2; + bool retval = lexical_assign(strings[0], v1); + if(strings.size() > 1) { + retval = retval && lexical_assign(strings[1], v2); + } + if(retval) { + output = AssignTo{v1, v2}; + } + return retval; +} + +/// Lexical conversion of a container types of single elements +template ::value && is_mutable_container::value && + type_count::value == 1, + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + output.erase(output.begin(), output.end()); + if(strings.size() == 1 && strings[0] == "{}") { + return true; + } + bool skip_remaining = false; + if(strings.size() == 2 && strings[0] == "{}" && is_separator(strings[1])) { + skip_remaining = true; + } + for(const auto &elem : strings) { + typename AssignTo::value_type out; + bool retval = lexical_assign(elem, out); + if(!retval) { + return false; + } + output.insert(output.end(), std::move(out)); + if(skip_remaining) { + break; + } + } + return (!output.empty()); +} + +/// Lexical conversion for complex types +template ::value, detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + + if(strings.size() >= 2 && !strings[1].empty()) { + using XC2 = typename wrapped_type::type; + XC2 x{0.0}, y{0.0}; + auto str1 = strings[1]; + if(str1.back() == 'i' || str1.back() == 'j') { + str1.pop_back(); + } + auto worked = lexical_cast(strings[0], x) && lexical_cast(str1, y); + if(worked) { + output = ConvertTo{x, y}; + } + return worked; + } + return lexical_assign(strings[0], output); +} + +/// Conversion to a vector type using a particular single type as the conversion type +template ::value && (expected_count::value == 1) && + (type_count::value == 1), + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + bool retval = true; + output.clear(); + output.reserve(strings.size()); + for(const auto &elem : strings) { + + output.emplace_back(); + retval = retval && lexical_assign(elem, output.back()); + } + return (!output.empty()) && retval; +} + +// forward declaration + +/// Lexical conversion of a container types with conversion type of two elements +template ::value && is_mutable_container::value && + type_count_base::value == 2, + detail::enabler> = detail::dummy> +bool lexical_conversion(std::vector strings, AssignTo &output); + +/// Lexical conversion of a vector types with type_size >2 forward declaration +template ::value && is_mutable_container::value && + type_count_base::value != 2 && + ((type_count::value > 2) || + (type_count::value > type_count_base::value)), + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output); + +/// Conversion for tuples +template ::value && is_tuple_like::value && + (type_count_base::value != type_count::value || + type_count::value > 2), + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output); // forward declaration + +/// Conversion for operations where the assigned type is some class but the conversion is a mutable container or large +/// tuple +template ::value && !is_mutable_container::value && + classify_object::value != object_category::wrapper_value && + (is_mutable_container::value || type_count::value > 2), + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + + if(strings.size() > 1 || (!strings.empty() && !(strings.front().empty()))) { + ConvertTo val; + auto retval = lexical_conversion(strings, val); + output = AssignTo{val}; + return retval; + } + output = AssignTo{}; + return true; +} + +/// function template for converting tuples if the static Index is greater than the tuple size +template +inline typename std::enable_if<(I >= type_count_base::value), bool>::type +tuple_conversion(const std::vector &, AssignTo &) { + return true; +} + +/// Conversion of a tuple element where the type size ==1 and not a mutable container +template +inline typename std::enable_if::value && type_count::value == 1, bool>::type +tuple_type_conversion(std::vector &strings, AssignTo &output) { + auto retval = lexical_assign(strings[0], output); + strings.erase(strings.begin()); + return retval; +} + +/// Conversion of a tuple element where the type size !=1 but the size is fixed and not a mutable container +template +inline typename std::enable_if::value && (type_count::value > 1) && + type_count::value == type_count_min::value, + bool>::type +tuple_type_conversion(std::vector &strings, AssignTo &output) { + auto retval = lexical_conversion(strings, output); + strings.erase(strings.begin(), strings.begin() + type_count::value); + return retval; +} + +/// Conversion of a tuple element where the type is a mutable container or a type with different min and max type sizes +template +inline typename std::enable_if::value || + type_count::value != type_count_min::value, + bool>::type +tuple_type_conversion(std::vector &strings, AssignTo &output) { + + std::size_t index{subtype_count_min::value}; + const std::size_t mx_count{subtype_count::value}; + const std::size_t mx{(std::max)(mx_count, strings.size())}; + + while(index < mx) { + if(is_separator(strings[index])) { + break; + } + ++index; + } + bool retval = lexical_conversion( + std::vector(strings.begin(), strings.begin() + static_cast(index)), output); + strings.erase(strings.begin(), strings.begin() + static_cast(index) + 1); + return retval; +} + +/// Tuple conversion operation +template +inline typename std::enable_if<(I < type_count_base::value), bool>::type +tuple_conversion(std::vector strings, AssignTo &output) { + bool retval = true; + using ConvertToElement = typename std:: + conditional::value, typename std::tuple_element::type, ConvertTo>::type; + if(!strings.empty()) { + retval = retval && tuple_type_conversion::type, ConvertToElement>( + strings, std::get(output)); + } + retval = retval && tuple_conversion(std::move(strings), output); + return retval; +} + +/// Lexical conversion of a container types with tuple elements of size 2 +template ::value && is_mutable_container::value && + type_count_base::value == 2, + detail::enabler>> +bool lexical_conversion(std::vector strings, AssignTo &output) { + output.clear(); + while(!strings.empty()) { + + typename std::remove_const::type>::type v1; + typename std::tuple_element<1, typename ConvertTo::value_type>::type v2; + bool retval = tuple_type_conversion(strings, v1); + if(!strings.empty()) { + retval = retval && tuple_type_conversion(strings, v2); + } + if(retval) { + output.insert(output.end(), typename AssignTo::value_type{v1, v2}); + } else { + return false; + } + } + return (!output.empty()); +} + +/// lexical conversion of tuples with type count>2 or tuples of types of some element with a type size>=2 +template ::value && is_tuple_like::value && + (type_count_base::value != type_count::value || + type_count::value > 2), + detail::enabler>> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + static_assert( + !is_tuple_like::value || type_count_base::value == type_count_base::value, + "if the conversion type is defined as a tuple it must be the same size as the type you are converting to"); + return tuple_conversion(strings, output); +} + +/// Lexical conversion of a vector types for everything but tuples of two elements and types of size 1 +template ::value && is_mutable_container::value && + type_count_base::value != 2 && + ((type_count::value > 2) || + (type_count::value > type_count_base::value)), + detail::enabler>> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + bool retval = true; + output.clear(); + std::vector temp; + std::size_t ii{0}; + std::size_t icount{0}; + std::size_t xcm{type_count::value}; + auto ii_max = strings.size(); + while(ii < ii_max) { + temp.push_back(strings[ii]); + ++ii; + ++icount; + if(icount == xcm || is_separator(temp.back()) || ii == ii_max) { + if(static_cast(xcm) > type_count_min::value && is_separator(temp.back())) { + temp.pop_back(); + } + typename AssignTo::value_type temp_out; + retval = retval && + lexical_conversion(temp, temp_out); + temp.clear(); + if(!retval) { + return false; + } + output.insert(output.end(), std::move(temp_out)); + icount = 0; + } + } + return retval; +} + +/// conversion for wrapper types +template ::value == object_category::wrapper_value && + std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + if(strings.empty() || strings.front().empty()) { + output = ConvertTo{}; + return true; + } + typename ConvertTo::value_type val; + if(lexical_conversion(strings, val)) { + output = ConvertTo{val}; + return true; + } + return false; +} + +/// conversion for wrapper types +template ::value == object_category::wrapper_value && + !std::is_assignable::value, + detail::enabler> = detail::dummy> +bool lexical_conversion(const std::vector &strings, AssignTo &output) { + using ConvertType = typename ConvertTo::value_type; + if(strings.empty() || strings.front().empty()) { + output = ConvertType{}; + return true; + } + ConvertType val; + if(lexical_conversion(strings, val)) { + output = val; + return true; + } + return false; +} + +/// Sum a vector of strings +inline std::string sum_string_vector(const std::vector &values) { + double val{0.0}; + bool fail{false}; + std::string output; + for(const auto &arg : values) { + double tv{0.0}; + auto comp = lexical_cast(arg, tv); + if(!comp) { + try { + tv = static_cast(detail::to_flag_value(arg)); + } catch(const std::exception &) { + fail = true; + break; + } + } + val += tv; + } + if(fail) { + for(const auto &arg : values) { + output.append(arg); + } + } else { + if(val <= static_cast((std::numeric_limits::min)()) || + val >= static_cast((std::numeric_limits::max)()) || + std::ceil(val) == std::floor(val)) { + output = detail::value_string(static_cast(val)); + } else { + output = detail::value_string(val); + } + } + return output; +} + +} // namespace detail + + + +namespace detail { + +// Returns false if not a short option. Otherwise, sets opt name and rest and returns true +CLI11_INLINE bool split_short(const std::string ¤t, std::string &name, std::string &rest); + +// Returns false if not a long option. Otherwise, sets opt name and other side of = and returns true +CLI11_INLINE bool split_long(const std::string ¤t, std::string &name, std::string &value); + +// Returns false if not a windows style option. Otherwise, sets opt name and value and returns true +CLI11_INLINE bool split_windows_style(const std::string ¤t, std::string &name, std::string &value); + +// Splits a string into multiple long and short names +CLI11_INLINE std::vector split_names(std::string current); + +/// extract default flag values either {def} or starting with a ! +CLI11_INLINE std::vector> get_default_flag_values(const std::string &str); + +/// Get a vector of short names, one of long names, and a single name +CLI11_INLINE std::tuple, std::vector, std::string> +get_names(const std::vector &input); + +} // namespace detail + + + +namespace detail { + +CLI11_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; + } + return false; +} + +CLI11_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; + } + return false; +} + +CLI11_INLINE bool split_windows_style(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; + } + return false; +} + +CLI11_INLINE std::vector split_names(std::string current) { + std::vector output; + std::size_t val = 0; + 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; +} + +CLI11_INLINE std::vector> get_default_flag_values(const std::string &str) { + std::vector flags = split_names(str); + flags.erase(std::remove_if(flags.begin(), + flags.end(), + [](const std::string &name) { + return ((name.empty()) || (!(((name.find_first_of('{') != std::string::npos) && + (name.back() == '}')) || + (name[0] == '!')))); + }), + flags.end()); + std::vector> output; + output.reserve(flags.size()); + for(auto &flag : flags) { + auto def_start = flag.find_first_of('{'); + std::string defval = "false"; + if((def_start != std::string::npos) && (flag.back() == '}')) { + defval = flag.substr(def_start + 1); + defval.pop_back(); + flag.erase(def_start, std::string::npos); // NOLINT(readability-suspicious-call-argument) + } + flag.erase(0, flag.find_first_not_of("-!")); + output.emplace_back(flag, defval); + } + return output; +} + +CLI11_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; + } + 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::make_tuple(short_names, long_names, pos_name); +} + +} // namespace detail + + + +class App; + +/// 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 "." + CLI11_NODISCARD 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; + + /// Get a flag value + CLI11_NODISCARD virtual std::string to_flag(const ConfigItem &item) const { + if(item.inputs.size() == 1) { + return item.inputs.at(0); + } + if(item.inputs.empty()) { + return "{}"; + } + throw ConversionError::TooManyInputsFlag(item.fullname()); // LCOV_EXCL_LINE + } + + /// Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure + CLI11_NODISCARD std::vector from_file(const std::string &name) const { + 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/TOML files; to write INI files use ConfigINI +class ConfigBase : public Config { + protected: + /// the character used for comments + char commentChar = '#'; + /// the character used to start an array '\0' is a default to not use + char arrayStart = '['; + /// the character used to end an array '\0' is a default to not use + char arrayEnd = ']'; + /// the character used to separate elements in an array + char arraySeparator = ','; + /// the character used separate the name from the value + char valueDelimiter = '='; + /// the character to use around strings + char stringQuote = '"'; + /// the character to use around single characters + char characterQuote = '\''; + /// the maximum number of layers to allow + uint8_t maximumLayers{255}; + /// the separator used to separator parent layers + char parentSeparatorChar{'.'}; + /// Specify the configuration index to use for arrayed sections + int16_t configIndex{-1}; + /// Specify the configuration section that should be used + std::string configSection{}; + + public: + std::string + to_config(const App * /*app*/, bool default_also, bool write_description, std::string prefix) const override; + + std::vector from_config(std::istream &input) const override; + /// Specify the configuration for comment characters + ConfigBase *comment(char cchar) { + commentChar = cchar; + return this; + } + /// Specify the start and end characters for an array + ConfigBase *arrayBounds(char aStart, char aEnd) { + arrayStart = aStart; + arrayEnd = aEnd; + return this; + } + /// Specify the delimiter character for an array + ConfigBase *arrayDelimiter(char aSep) { + arraySeparator = aSep; + return this; + } + /// Specify the delimiter between a name and value + ConfigBase *valueSeparator(char vSep) { + valueDelimiter = vSep; + return this; + } + /// Specify the quote characters used around strings and characters + ConfigBase *quoteCharacter(char qString, char qChar) { + stringQuote = qString; + characterQuote = qChar; + return this; + } + /// Specify the maximum number of parents + ConfigBase *maxLayers(uint8_t layers) { + maximumLayers = layers; + return this; + } + /// Specify the separator to use for parent layers + ConfigBase *parentSeparator(char sep) { + parentSeparatorChar = sep; + return this; + } + /// get a reference to the configuration section + std::string §ionRef() { return configSection; } + /// get the section + CLI11_NODISCARD const std::string §ion() const { return configSection; } + /// specify a particular section of the configuration file to use + ConfigBase *section(const std::string §ionName) { + configSection = sectionName; + return this; + } + + /// get a reference to the configuration index + int16_t &indexRef() { return configIndex; } + /// get the section index + CLI11_NODISCARD int16_t index() const { return configIndex; } + /// specify a particular index in the section to use (-1) for all sections to use + ConfigBase *index(int16_t sectionIndex) { + configIndex = sectionIndex; + return this; + } +}; + +/// the default Config is the TOML file format +using ConfigTOML = ConfigBase; + +/// ConfigINI generates a "standard" INI compliant output +class ConfigINI : public ConfigTOML { + + public: + ConfigINI() { + commentChar = ';'; + arrayStart = '\0'; + arrayEnd = '\0'; + arraySeparator = ' '; + valueDelimiter = '='; + } +}; + + + +class Option; + +/// @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. +/// @{ + +/// +class Validator { + protected: + /// This is the description function, if empty the description_ will be used + std::function desc_function_{[]() { return std::string{}; }}; + + /// This is the base function that is to be called. + /// Returns a string error message if validation fails. + std::function func_{[](std::string &) { return std::string{}; }}; + /// The name for search purposes of the Validator + std::string name_{}; + /// A Validator will only apply to an indexed value (-1 is all elements) + int application_index_ = -1; + /// Enable for Validator to allow it to be disabled if need be + bool active_{true}; + /// specify that a validator should not modify the input + bool non_modifying_{false}; + + Validator(std::string validator_desc, std::function func) + : desc_function_([validator_desc]() { return validator_desc; }), func_(std::move(func)) {} + + public: + Validator() = default; + /// Construct a Validator with just the description string + explicit Validator(std::string validator_desc) : desc_function_([validator_desc]() { return validator_desc; }) {} + /// Construct Validator from basic information + Validator(std::function op, std::string validator_desc, std::string validator_name = "") + : desc_function_([validator_desc]() { return validator_desc; }), func_(std::move(op)), + name_(std::move(validator_name)) {} + /// Set the Validator operation function + Validator &operation(std::function op) { + func_ = std::move(op); + return *this; + } + /// This is the required operator for a Validator - provided to help + /// users (CLI11 uses the member `func` directly) + std::string operator()(std::string &str) const; + + /// 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 { + std::string value = str; + return (active_) ? func_(value) : std::string{}; + } + + /// Specify the type string + Validator &description(std::string validator_desc) { + desc_function_ = [validator_desc]() { return validator_desc; }; + return *this; + } + /// Specify the type string + CLI11_NODISCARD Validator description(std::string validator_desc) const; + + /// Generate type description information for the Validator + CLI11_NODISCARD std::string get_description() const { + if(active_) { + return desc_function_(); + } + return std::string{}; + } + /// Specify the type string + Validator &name(std::string validator_name) { + name_ = std::move(validator_name); + return *this; + } + /// Specify the type string + CLI11_NODISCARD Validator name(std::string validator_name) const { + Validator newval(*this); + newval.name_ = std::move(validator_name); + return newval; + } + /// Get the name of the Validator + CLI11_NODISCARD const std::string &get_name() const { return name_; } + /// Specify whether the Validator is active or not + Validator &active(bool active_val = true) { + active_ = active_val; + return *this; + } + /// Specify whether the Validator is active or not + CLI11_NODISCARD Validator active(bool active_val = true) const { + Validator newval(*this); + newval.active_ = active_val; + return newval; + } + + /// Specify whether the Validator can be modifying or not + Validator &non_modifying(bool no_modify = true) { + non_modifying_ = no_modify; + return *this; + } + /// Specify the application index of a validator + Validator &application_index(int app_index) { + application_index_ = app_index; + return *this; + } + /// Specify the application index of a validator + CLI11_NODISCARD Validator application_index(int app_index) const { + Validator newval(*this); + newval.application_index_ = app_index; + return newval; + } + /// Get the current value of the application index + CLI11_NODISCARD int get_application_index() const { return application_index_; } + /// Get a boolean if the validator is active + CLI11_NODISCARD bool get_active() const { return active_; } + + /// Get a boolean if the validator is allowed to modify the input returns true if it can modify the input + CLI11_NODISCARD bool get_modifying() const { return !non_modifying_; } + + /// Combining validators is a new validator. Type comes from left validator if function, otherwise only set if the + /// same. + Validator operator&(const Validator &other) const; + + /// Combining validators is a new validator. Type comes from left validator if function, otherwise only set if the + /// same. + Validator operator|(const Validator &other) const; + + /// Create a validator that fails when a given validator succeeds + Validator operator!() const; + + private: + void _merge_description(const Validator &val1, const Validator &val2, const std::string &merger); +}; + +/// Class wrapping some of the accessors of Validator +class CustomValidator : public Validator { + public: +}; +// 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 { + +/// CLI enumeration of different file types +enum class path_type { nonexistent, file, directory }; + +/// get the type of the path from a file name +CLI11_INLINE path_type check_path(const char *file) noexcept; + +/// Check for an existing file (returns error message if check fails) +class ExistingFileValidator : public Validator { + public: + ExistingFileValidator(); +}; + +/// Check for an existing directory (returns error message if check fails) +class ExistingDirectoryValidator : public Validator { + public: + ExistingDirectoryValidator(); +}; + +/// Check for an existing path +class ExistingPathValidator : public Validator { + public: + ExistingPathValidator(); +}; + +/// Check for an non-existing path +class NonexistentPathValidator : public Validator { + public: + NonexistentPathValidator(); +}; + +/// Validate the given string is a legal ipv4 address +class IPV4Validator : public Validator { + public: + IPV4Validator(); +}; + +} // 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; + +/// Check for an IP4 address +const detail::IPV4Validator ValidIPV4; + +/// Validate the input as a particular type +template class TypeValidator : public Validator { + public: + explicit TypeValidator(const std::string &validator_name) + : Validator(validator_name, [](std::string &input_string) { + using CLI::detail::lexical_cast; + auto val = DesiredType(); + if(!lexical_cast(input_string, val)) { + return std::string("Failed parsing ") + input_string + " as a " + detail::type_name(); + } + return std::string(); + }) {} + TypeValidator() : TypeValidator(detail::type_name()) {} +}; + +/// Check for a number +const TypeValidator Number("NUMBER"); + +/// Modify a path if the file is a particular default location, can be used as Check or transform +/// with the error return optionally disabled +class FileOnDefaultPath : public Validator { + public: + explicit FileOnDefaultPath(std::string default_path, bool enableErrorReturn = true); +}; + +/// Produce a range (factory). Min and max are inclusive. +class Range : public Validator { + public: + /// 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_val, T max_val, const std::string &validator_name = std::string{}) : Validator(validator_name) { + if(validator_name.empty()) { + std::stringstream out; + out << detail::type_name() << " in [" << min_val << " - " << max_val << "]"; + description(out.str()); + } + + func_ = [min_val, max_val](std::string &input) { + using CLI::detail::lexical_cast; + T val; + bool converted = lexical_cast(input, val); + if((!converted) || (val < min_val || val > max_val)) { + std::stringstream out; + out << "Value " << input << " not in range ["; + out << min_val << " - " << max_val << "]"; + return out.str(); + } + return std::string{}; + }; + } + + /// Range of one value is 0 to value + template + explicit Range(T max_val, const std::string &validator_name = std::string{}) + : Range(static_cast(0), max_val, validator_name) {} +}; + +/// Check for a non negative number +const Range NonNegativeNumber((std::numeric_limits::max)(), "NONNEGATIVE"); + +/// Check for a positive valued number (val>0.0), ::min here is the smallest positive number +const Range PositiveNumber((std::numeric_limits::min)(), (std::numeric_limits::max)(), "POSITIVE"); + +/// Produce a bounded range (factory). Min and max are inclusive. +class Bound : public Validator { + public: + /// This bounds a value 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 Bound(T min_val, T max_val) { + std::stringstream out; + out << detail::type_name() << " bounded to [" << min_val << " - " << max_val << "]"; + description(out.str()); + + func_ = [min_val, max_val](std::string &input) { + using CLI::detail::lexical_cast; + T val; + bool converted = lexical_cast(input, val); + if(!converted) { + return std::string("Value ") + input + " could not be converted"; + } + if(val < min_val) + input = detail::to_string(min_val); + else if(val > max_val) + input = detail::to_string(max_val); + + return std::string{}; + }; + } + + /// Range of one value is 0 to value + template explicit Bound(T max_val) : Bound(static_cast(0), max_val) {} +}; + +namespace detail { +template ::type>::value, detail::enabler> = detail::dummy> +auto smart_deref(T value) -> decltype(*value) { + return *value; +} + +template < + typename T, + enable_if_t::type>::value, detail::enabler> = detail::dummy> +typename std::remove_reference::type &smart_deref(T &value) { + return value; +} +/// Generate a string representation of a set +template std::string generate_set(const T &set) { + using element_t = typename detail::element_type::type; + using iteration_type_t = typename detail::pair_adaptor::value_type; // the type of the object pair + std::string out(1, '{'); + out.append(detail::join( + detail::smart_deref(set), + [](const iteration_type_t &v) { return detail::pair_adaptor::first(v); }, + ",")); + out.push_back('}'); + return out; +} + +/// Generate a string representation of a map +template std::string generate_map(const T &map, bool key_only = false) { + using element_t = typename detail::element_type::type; + using iteration_type_t = typename detail::pair_adaptor::value_type; // the type of the object pair + std::string out(1, '{'); + out.append(detail::join( + detail::smart_deref(map), + [key_only](const iteration_type_t &v) { + std::string res{detail::to_string(detail::pair_adaptor::first(v))}; + + if(!key_only) { + res.append("->"); + res += detail::to_string(detail::pair_adaptor::second(v)); + } + return res; + }, + ",")); + out.push_back('}'); + return out; +} + +template struct has_find { + template + static auto test(int) -> decltype(std::declval().find(std::declval()), std::true_type()); + template static auto test(...) -> decltype(std::false_type()); + + static const auto value = decltype(test(0))::value; + using type = std::integral_constant; +}; + +/// A search function +template ::value, detail::enabler> = detail::dummy> +auto search(const T &set, const V &val) -> std::pair { + using element_t = typename detail::element_type::type; + auto &setref = detail::smart_deref(set); + auto it = std::find_if(std::begin(setref), std::end(setref), [&val](decltype(*std::begin(setref)) v) { + return (detail::pair_adaptor::first(v) == val); + }); + return {(it != std::end(setref)), it}; +} + +/// A search function that uses the built in find function +template ::value, detail::enabler> = detail::dummy> +auto search(const T &set, const V &val) -> std::pair { + auto &setref = detail::smart_deref(set); + auto it = setref.find(val); + return {(it != std::end(setref)), it}; +} + +/// A search function with a filter function +template +auto search(const T &set, const V &val, const std::function &filter_function) + -> std::pair { + using element_t = typename detail::element_type::type; + // do the potentially faster first search + auto res = search(set, val); + if((res.first) || (!(filter_function))) { + return res; + } + // if we haven't found it do the longer linear search with all the element translations + auto &setref = detail::smart_deref(set); + auto it = std::find_if(std::begin(setref), std::end(setref), [&](decltype(*std::begin(setref)) v) { + V a{detail::pair_adaptor::first(v)}; + a = filter_function(a); + return (a == val); + }); + return {(it != std::end(setref)), it}; +} + +// the following suggestion was made by Nikita Ofitserov(@himikof) +// done in templates to prevent compiler warnings on negation of unsigned numbers + +/// Do a check for overflow on signed numbers +template +inline typename std::enable_if::value, T>::type overflowCheck(const T &a, const T &b) { + if((a > 0) == (b > 0)) { + return ((std::numeric_limits::max)() / (std::abs)(a) < (std::abs)(b)); + } + return ((std::numeric_limits::min)() / (std::abs)(a) > -(std::abs)(b)); +} +/// Do a check for overflow on unsigned numbers +template +inline typename std::enable_if::value, T>::type overflowCheck(const T &a, const T &b) { + return ((std::numeric_limits::max)() / a < b); +} + +/// Performs a *= b; if it doesn't cause integer overflow. Returns false otherwise. +template typename std::enable_if::value, bool>::type checked_multiply(T &a, T b) { + if(a == 0 || b == 0 || a == 1 || b == 1) { + a *= b; + return true; + } + if(a == (std::numeric_limits::min)() || b == (std::numeric_limits::min)()) { + return false; + } + if(overflowCheck(a, b)) { + return false; + } + a *= b; + return true; +} + +/// Performs a *= b; if it doesn't equal infinity. Returns false otherwise. +template +typename std::enable_if::value, bool>::type checked_multiply(T &a, T b) { + T c = a * b; + if(std::isinf(c) && !std::isinf(a) && !std::isinf(b)) { + return false; + } + a = c; + return true; +} + +} // namespace detail +/// Verify items are in a set +class IsMember : public Validator { + public: + using filter_fn_t = std::function; + + /// This allows in-place construction using an initializer list + template + IsMember(std::initializer_list values, Args &&...args) + : IsMember(std::vector(values), std::forward(args)...) {} + + /// This checks to see if an item is in a set (empty function) + template explicit IsMember(T &&set) : IsMember(std::forward(set), nullptr) {} + + /// This checks to see if an item is in a set: pointer or copy version. You can pass in a function that will filter + /// both sides of the comparison before computing the comparison. + template explicit IsMember(T set, F filter_function) { + + // Get the type of the contained item - requires a container have ::value_type + // if the type does not have first_type and second_type, these are both value_type + using element_t = typename detail::element_type::type; // Removes (smart) pointers if needed + using item_t = typename detail::pair_adaptor::first_type; // Is value_type if not a map + + using local_item_t = typename IsMemberType::type; // This will convert bad types to good ones + // (const char * to std::string) + + // Make a local copy of the filter function, using a std::function if not one already + std::function filter_fn = filter_function; + + // This is the type name for help, it will take the current version of the set contents + desc_function_ = [set]() { return detail::generate_set(detail::smart_deref(set)); }; + + // This is the function that validates + // It stores a copy of the set pointer-like, so shared_ptr will stay alive + func_ = [set, filter_fn](std::string &input) { + using CLI::detail::lexical_cast; + local_item_t b; + if(!lexical_cast(input, b)) { + throw ValidationError(input); // name is added later + } + if(filter_fn) { + b = filter_fn(b); + } + auto res = detail::search(set, b, filter_fn); + if(res.first) { + // Make sure the version in the input string is identical to the one in the set + if(filter_fn) { + input = detail::value_string(detail::pair_adaptor::first(*(res.second))); + } + + // Return empty error string (success) + return std::string{}; + } + + // If you reach this point, the result was not found + return input + " not in " + detail::generate_set(detail::smart_deref(set)); + }; + } + + /// You can pass in as many filter functions as you like, they nest (string only currently) + template + IsMember(T &&set, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other) + : IsMember( + std::forward(set), + [filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); }, + other...) {} +}; + +/// definition of the default transformation object +template using TransformPairs = std::vector>; + +/// Translate named items to other or a value set +class Transformer : public Validator { + public: + using filter_fn_t = std::function; + + /// This allows in-place construction + template + Transformer(std::initializer_list> values, Args &&...args) + : Transformer(TransformPairs(values), std::forward(args)...) {} + + /// direct map of std::string to std::string + template explicit Transformer(T &&mapping) : Transformer(std::forward(mapping), nullptr) {} + + /// This checks to see if an item is in a set: pointer or copy version. You can pass in a function that will filter + /// both sides of the comparison before computing the comparison. + template explicit Transformer(T mapping, F filter_function) { + + static_assert(detail::pair_adaptor::type>::value, + "mapping must produce value pairs"); + // Get the type of the contained item - requires a container have ::value_type + // if the type does not have first_type and second_type, these are both value_type + using element_t = typename detail::element_type::type; // Removes (smart) pointers if needed + using item_t = typename detail::pair_adaptor::first_type; // Is value_type if not a map + using local_item_t = typename IsMemberType::type; // Will convert bad types to good ones + // (const char * to std::string) + + // Make a local copy of the filter function, using a std::function if not one already + std::function filter_fn = filter_function; + + // This is the type name for help, it will take the current version of the set contents + desc_function_ = [mapping]() { return detail::generate_map(detail::smart_deref(mapping)); }; + + func_ = [mapping, filter_fn](std::string &input) { + using CLI::detail::lexical_cast; + local_item_t b; + if(!lexical_cast(input, b)) { + return std::string(); + // there is no possible way we can match anything in the mapping if we can't convert so just return + } + if(filter_fn) { + b = filter_fn(b); + } + auto res = detail::search(mapping, b, filter_fn); + if(res.first) { + input = detail::value_string(detail::pair_adaptor::second(*res.second)); + } + return std::string{}; + }; + } + + /// You can pass in as many filter functions as you like, they nest + template + Transformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other) + : Transformer( + std::forward(mapping), + [filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); }, + other...) {} +}; + +/// translate named items to other or a value set +class CheckedTransformer : public Validator { + public: + using filter_fn_t = std::function; + + /// This allows in-place construction + template + CheckedTransformer(std::initializer_list> values, Args &&...args) + : CheckedTransformer(TransformPairs(values), std::forward(args)...) {} + + /// direct map of std::string to std::string + template explicit CheckedTransformer(T mapping) : CheckedTransformer(std::move(mapping), nullptr) {} + + /// This checks to see if an item is in a set: pointer or copy version. You can pass in a function that will filter + /// both sides of the comparison before computing the comparison. + template explicit CheckedTransformer(T mapping, F filter_function) { + + static_assert(detail::pair_adaptor::type>::value, + "mapping must produce value pairs"); + // Get the type of the contained item - requires a container have ::value_type + // if the type does not have first_type and second_type, these are both value_type + using element_t = typename detail::element_type::type; // Removes (smart) pointers if needed + using item_t = typename detail::pair_adaptor::first_type; // Is value_type if not a map + using local_item_t = typename IsMemberType::type; // Will convert bad types to good ones + // (const char * to std::string) + using iteration_type_t = typename detail::pair_adaptor::value_type; // the type of the object pair + + // Make a local copy of the filter function, using a std::function if not one already + std::function filter_fn = filter_function; + + auto tfunc = [mapping]() { + std::string out("value in "); + out += detail::generate_map(detail::smart_deref(mapping)) + " OR {"; + out += detail::join( + detail::smart_deref(mapping), + [](const iteration_type_t &v) { return detail::to_string(detail::pair_adaptor::second(v)); }, + ","); + out.push_back('}'); + return out; + }; + + desc_function_ = tfunc; + + func_ = [mapping, tfunc, filter_fn](std::string &input) { + using CLI::detail::lexical_cast; + local_item_t b; + bool converted = lexical_cast(input, b); + if(converted) { + if(filter_fn) { + b = filter_fn(b); + } + auto res = detail::search(mapping, b, filter_fn); + if(res.first) { + input = detail::value_string(detail::pair_adaptor::second(*res.second)); + return std::string{}; + } + } + for(const auto &v : detail::smart_deref(mapping)) { + auto output_string = detail::value_string(detail::pair_adaptor::second(v)); + if(output_string == input) { + return std::string(); + } + } + + return "Check " + input + " " + tfunc() + " FAILED"; + }; + } + + /// You can pass in as many filter functions as you like, they nest + template + CheckedTransformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other) + : CheckedTransformer( + std::forward(mapping), + [filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); }, + other...) {} +}; + +/// Helper function to allow ignore_case to be passed to IsMember or Transform +inline std::string ignore_case(std::string item) { return detail::to_lower(item); } + +/// Helper function to allow ignore_underscore to be passed to IsMember or Transform +inline std::string ignore_underscore(std::string item) { return detail::remove_underscore(item); } + +/// Helper function to allow checks to ignore spaces to be passed to IsMember or Transform +inline std::string ignore_space(std::string item) { + item.erase(std::remove(std::begin(item), std::end(item), ' '), std::end(item)); + item.erase(std::remove(std::begin(item), std::end(item), '\t'), std::end(item)); + return item; +} + +/// Multiply a number by a factor using given mapping. +/// Can be used to write transforms for SIZE or DURATION inputs. +/// +/// Example: +/// With mapping = `{"b"->1, "kb"->1024, "mb"->1024*1024}` +/// one can recognize inputs like "100", "12kb", "100 MB", +/// that will be automatically transformed to 100, 14448, 104857600. +/// +/// Output number type matches the type in the provided mapping. +/// Therefore, if it is required to interpret real inputs like "0.42 s", +/// the mapping should be of a type or . +class AsNumberWithUnit : public Validator { + public: + /// Adjust AsNumberWithUnit behavior. + /// CASE_SENSITIVE/CASE_INSENSITIVE controls how units are matched. + /// UNIT_OPTIONAL/UNIT_REQUIRED throws ValidationError + /// if UNIT_REQUIRED is set and unit literal is not found. + enum Options { + CASE_SENSITIVE = 0, + CASE_INSENSITIVE = 1, + UNIT_OPTIONAL = 0, + UNIT_REQUIRED = 2, + DEFAULT = CASE_INSENSITIVE | UNIT_OPTIONAL + }; + + template + explicit AsNumberWithUnit(std::map mapping, + Options opts = DEFAULT, + const std::string &unit_name = "UNIT") { + description(generate_description(unit_name, opts)); + validate_mapping(mapping, opts); + + // transform function + func_ = [mapping, opts](std::string &input) -> std::string { + Number num{}; + + detail::rtrim(input); + if(input.empty()) { + throw ValidationError("Input is empty"); + } + + // Find split position between number and prefix + auto unit_begin = input.end(); + while(unit_begin > input.begin() && std::isalpha(*(unit_begin - 1), std::locale())) { + --unit_begin; + } + + std::string unit{unit_begin, input.end()}; + input.resize(static_cast(std::distance(input.begin(), unit_begin))); + detail::trim(input); + + if(opts & UNIT_REQUIRED && unit.empty()) { + throw ValidationError("Missing mandatory unit"); + } + if(opts & CASE_INSENSITIVE) { + unit = detail::to_lower(unit); + } + if(unit.empty()) { + using CLI::detail::lexical_cast; + if(!lexical_cast(input, num)) { + throw ValidationError(std::string("Value ") + input + " could not be converted to " + + detail::type_name()); + } + // No need to modify input if no unit passed + return {}; + } + + // find corresponding factor + auto it = mapping.find(unit); + if(it == mapping.end()) { + throw ValidationError(unit + + " unit not recognized. " + "Allowed values: " + + detail::generate_map(mapping, true)); + } + + if(!input.empty()) { + using CLI::detail::lexical_cast; + bool converted = lexical_cast(input, num); + if(!converted) { + throw ValidationError(std::string("Value ") + input + " could not be converted to " + + detail::type_name()); + } + // perform safe multiplication + bool ok = detail::checked_multiply(num, it->second); + if(!ok) { + throw ValidationError(detail::to_string(num) + " multiplied by " + unit + + " factor would cause number overflow. Use smaller value."); + } + } else { + num = static_cast(it->second); + } + + input = detail::to_string(num); + + return {}; + }; + } + + private: + /// Check that mapping contains valid units. + /// Update mapping for CASE_INSENSITIVE mode. + template static void validate_mapping(std::map &mapping, Options opts) { + for(auto &kv : mapping) { + if(kv.first.empty()) { + throw ValidationError("Unit must not be empty."); + } + if(!detail::isalpha(kv.first)) { + throw ValidationError("Unit must contain only letters."); + } + } + + // make all units lowercase if CASE_INSENSITIVE + if(opts & CASE_INSENSITIVE) { + std::map lower_mapping; + for(auto &kv : mapping) { + auto s = detail::to_lower(kv.first); + if(lower_mapping.count(s)) { + throw ValidationError(std::string("Several matching lowercase unit representations are found: ") + + s); + } + lower_mapping[detail::to_lower(kv.first)] = kv.second; + } + mapping = std::move(lower_mapping); + } + } + + /// Generate description like this: NUMBER [UNIT] + template static std::string generate_description(const std::string &name, Options opts) { + std::stringstream out; + out << detail::type_name() << ' '; + if(opts & UNIT_REQUIRED) { + out << name; + } else { + out << '[' << name << ']'; + } + return out.str(); + } +}; + +inline AsNumberWithUnit::Options operator|(const AsNumberWithUnit::Options &a, const AsNumberWithUnit::Options &b) { + return static_cast(static_cast(a) | static_cast(b)); +} + +/// Converts a human-readable size string (with unit literal) to uin64_t size. +/// Example: +/// "100" => 100 +/// "1 b" => 100 +/// "10Kb" => 10240 // you can configure this to be interpreted as kilobyte (*1000) or kibibyte (*1024) +/// "10 KB" => 10240 +/// "10 kb" => 10240 +/// "10 kib" => 10240 // *i, *ib are always interpreted as *bibyte (*1024) +/// "10kb" => 10240 +/// "2 MB" => 2097152 +/// "2 EiB" => 2^61 // Units up to exibyte are supported +class AsSizeValue : public AsNumberWithUnit { + public: + using result_t = std::uint64_t; + + /// If kb_is_1000 is true, + /// interpret 'kb', 'k' as 1000 and 'kib', 'ki' as 1024 + /// (same applies to higher order units as well). + /// Otherwise, interpret all literals as factors of 1024. + /// The first option is formally correct, but + /// the second interpretation is more wide-spread + /// (see https://en.wikipedia.org/wiki/Binary_prefix). + explicit AsSizeValue(bool kb_is_1000); + + private: + /// Get mapping + static std::map init_mapping(bool kb_is_1000); + + /// Cache calculated mapping + static std::map get_mapping(bool kb_is_1000); +}; + +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. +CLI11_INLINE std::pair split_program_name(std::string commandline); + +} // namespace detail +/// @} + + + + +CLI11_INLINE std::string Validator::operator()(std::string &str) const { + std::string retstring; + if(active_) { + if(non_modifying_) { + std::string value = str; + retstring = func_(value); + } else { + retstring = func_(str); + } + } + return retstring; +} + +CLI11_NODISCARD CLI11_INLINE Validator Validator::description(std::string validator_desc) const { + Validator newval(*this); + newval.desc_function_ = [validator_desc]() { return validator_desc; }; + return newval; +} + +CLI11_INLINE Validator Validator::operator&(const Validator &other) const { + Validator newval; + + newval._merge_description(*this, other, " AND "); + + // Give references (will make a copy in lambda function) + const std::function &f1 = func_; + const std::function &f2 = other.func_; + + newval.func_ = [f1, f2](std::string &input) { + std::string s1 = f1(input); + std::string s2 = f2(input); + if(!s1.empty() && !s2.empty()) + return std::string("(") + s1 + ") AND (" + s2 + ")"; + return s1 + s2; + }; + + newval.active_ = active_ && other.active_; + newval.application_index_ = application_index_; + return newval; +} + +CLI11_INLINE Validator Validator::operator|(const Validator &other) const { + Validator newval; + + newval._merge_description(*this, other, " OR "); + + // Give references (will make a copy in lambda function) + const std::function &f1 = func_; + const std::function &f2 = other.func_; + + newval.func_ = [f1, f2](std::string &input) { + std::string s1 = f1(input); + std::string s2 = f2(input); + if(s1.empty() || s2.empty()) + return std::string(); + + return std::string("(") + s1 + ") OR (" + s2 + ")"; + }; + newval.active_ = active_ && other.active_; + newval.application_index_ = application_index_; + return newval; +} + +CLI11_INLINE Validator Validator::operator!() const { + Validator newval; + const std::function &dfunc1 = desc_function_; + newval.desc_function_ = [dfunc1]() { + auto str = dfunc1(); + return (!str.empty()) ? std::string("NOT ") + str : std::string{}; + }; + // Give references (will make a copy in lambda function) + const std::function &f1 = func_; + + newval.func_ = [f1, dfunc1](std::string &test) -> std::string { + std::string s1 = f1(test); + if(s1.empty()) { + return std::string("check ") + dfunc1() + " succeeded improperly"; + } + return std::string{}; + }; + newval.active_ = active_; + newval.application_index_ = application_index_; + return newval; +} + +CLI11_INLINE void +Validator::_merge_description(const Validator &val1, const Validator &val2, const std::string &merger) { + + const std::function &dfunc1 = val1.desc_function_; + const std::function &dfunc2 = val2.desc_function_; + + desc_function_ = [=]() { + std::string f1 = dfunc1(); + std::string f2 = dfunc2(); + if((f1.empty()) || (f2.empty())) { + return f1 + f2; + } + return std::string(1, '(') + f1 + ')' + merger + '(' + f2 + ')'; + }; +} + +namespace detail { + +#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 +CLI11_INLINE path_type check_path(const char *file) noexcept { + std::error_code ec; + auto stat = std::filesystem::status(file, ec); + if(ec) { + return path_type::nonexistent; + } + switch(stat.type()) { + case std::filesystem::file_type::none: // LCOV_EXCL_LINE + case std::filesystem::file_type::not_found: + return path_type::nonexistent; + case std::filesystem::file_type::directory: + return path_type::directory; + case std::filesystem::file_type::symlink: + case std::filesystem::file_type::block: + case std::filesystem::file_type::character: + case std::filesystem::file_type::fifo: + case std::filesystem::file_type::socket: + case std::filesystem::file_type::regular: + case std::filesystem::file_type::unknown: + default: + return path_type::file; + } +} +#else +CLI11_INLINE path_type check_path(const char *file) noexcept { +#if defined(_MSC_VER) + struct __stat64 buffer; + if(_stat64(file, &buffer) == 0) { + return ((buffer.st_mode & S_IFDIR) != 0) ? path_type::directory : path_type::file; + } +#else + struct stat buffer; + if(stat(file, &buffer) == 0) { + return ((buffer.st_mode & S_IFDIR) != 0) ? path_type::directory : path_type::file; + } +#endif + return path_type::nonexistent; +} +#endif + +CLI11_INLINE ExistingFileValidator::ExistingFileValidator() : Validator("FILE") { + func_ = [](std::string &filename) { + auto path_result = check_path(filename.c_str()); + if(path_result == path_type::nonexistent) { + return "File does not exist: " + filename; + } + if(path_result == path_type::directory) { + return "File is actually a directory: " + filename; + } + return std::string(); + }; +} + +CLI11_INLINE ExistingDirectoryValidator::ExistingDirectoryValidator() : Validator("DIR") { + func_ = [](std::string &filename) { + auto path_result = check_path(filename.c_str()); + if(path_result == path_type::nonexistent) { + return "Directory does not exist: " + filename; + } + if(path_result == path_type::file) { + return "Directory is actually a file: " + filename; + } + return std::string(); + }; +} + +CLI11_INLINE ExistingPathValidator::ExistingPathValidator() : Validator("PATH(existing)") { + func_ = [](std::string &filename) { + auto path_result = check_path(filename.c_str()); + if(path_result == path_type::nonexistent) { + return "Path does not exist: " + filename; + } + return std::string(); + }; +} + +CLI11_INLINE NonexistentPathValidator::NonexistentPathValidator() : Validator("PATH(non-existing)") { + func_ = [](std::string &filename) { + auto path_result = check_path(filename.c_str()); + if(path_result != path_type::nonexistent) { + return "Path already exists: " + filename; + } + return std::string(); + }; +} + +CLI11_INLINE IPV4Validator::IPV4Validator() : Validator("IPV4") { + func_ = [](std::string &ip_addr) { + auto result = CLI::detail::split(ip_addr, '.'); + if(result.size() != 4) { + return std::string("Invalid IPV4 address must have four parts (") + ip_addr + ')'; + } + int num = 0; + for(const auto &var : result) { + using CLI::detail::lexical_cast; + bool retval = lexical_cast(var, num); + if(!retval) { + return std::string("Failed parsing number (") + var + ')'; + } + if(num < 0 || num > 255) { + return std::string("Each IP number must be between 0 and 255 ") + var; + } + } + return std::string(); + }; +} + +} // namespace detail + +CLI11_INLINE FileOnDefaultPath::FileOnDefaultPath(std::string default_path, bool enableErrorReturn) + : Validator("FILE") { + func_ = [default_path, enableErrorReturn](std::string &filename) { + auto path_result = detail::check_path(filename.c_str()); + if(path_result == detail::path_type::nonexistent) { + std::string test_file_path = default_path; + if(default_path.back() != '/' && default_path.back() != '\\') { + // Add folder separator + test_file_path += '/'; + } + test_file_path.append(filename); + path_result = detail::check_path(test_file_path.c_str()); + if(path_result == detail::path_type::file) { + filename = test_file_path; + } else { + if(enableErrorReturn) { + return "File does not exist: " + filename; + } + } + } + return std::string{}; + }; +} + +CLI11_INLINE AsSizeValue::AsSizeValue(bool kb_is_1000) : AsNumberWithUnit(get_mapping(kb_is_1000)) { + if(kb_is_1000) { + description("SIZE [b, kb(=1000b), kib(=1024b), ...]"); + } else { + description("SIZE [b, kb(=1024b), ...]"); + } +} + +CLI11_INLINE std::map AsSizeValue::init_mapping(bool kb_is_1000) { + std::map m; + result_t k_factor = kb_is_1000 ? 1000 : 1024; + result_t ki_factor = 1024; + result_t k = 1; + result_t ki = 1; + m["b"] = 1; + for(std::string p : {"k", "m", "g", "t", "p", "e"}) { + k *= k_factor; + ki *= ki_factor; + m[p] = k; + m[p + "b"] = k; + m[p + "i"] = ki; + m[p + "ib"] = ki; + } + return m; +} + +CLI11_INLINE std::map AsSizeValue::get_mapping(bool kb_is_1000) { + if(kb_is_1000) { + static auto m = init_mapping(true); + return m; + } + static auto m = init_mapping(false); + return m; +} + +namespace detail { + +CLI11_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(detail::check_path(commandline.substr(0, esp).c_str()) != path_type::file) { + 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 + if(commandline[0] == '"' || commandline[0] == '\'' || commandline[0] == '`') { + bool embeddedQuote = false; + auto keyChar = commandline[0]; + auto end = commandline.find_first_of(keyChar, 1); + while((end != std::string::npos) && (commandline[end - 1] == '\\')) { // deal with escaped quotes + end = commandline.find_first_of(keyChar, end + 1); + embeddedQuote = true; + } + if(end != std::string::npos) { + vals.first = commandline.substr(1, end - 1); + esp = end + 1; + if(embeddedQuote) { + vals.first = find_and_replace(vals.first, std::string("\\") + keyChar, std::string(1, keyChar)); + } + } else { + esp = commandline.find_first_of(' ', 1); + } + } else { + esp = commandline.find_first_of(' ', 1); + } + + break; + } + } + if(vals.first.empty()) { + vals.first = commandline.substr(0, esp); + rtrim(vals.first); + } + + // strip the program name + vals.second = (esp < commandline.length() - 1) ? commandline.substr(esp + 1) : std::string{}; + ltrim(vals.second); + return vals; +} + +} // namespace detail +/// @} + + + + +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 + std::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; + FormatterBase &operator=(const FormatterBase &) = default; + FormatterBase &operator=(FormatterBase &&) = default; + + /// Adding a destructor in this form to work around bug in GCC 4.7 + virtual ~FormatterBase() noexcept {} // NOLINT(modernize-use-equals-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(std::size_t val) { column_width_ = val; } + + ///@} + /// @name Getters + ///@{ + + /// Get the current value of a name (REQUIRED, etc.) + CLI11_NODISCARD std::string get_label(std::string key) const { + if(labels_.find(key) == labels_.end()) + return key; + return labels_.at(key); + } + + /// Get the current column width + CLI11_NODISCARD std::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)) {} + + /// Adding a destructor (mostly to make GCC 4.7 happy) + ~FormatterLambda() noexcept override {} // NOLINT(modernize-use-equals-default) + + /// 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; + Formatter &operator=(const Formatter &) = default; + Formatter &operator=(Formatter &&) = default; + + /// @name Overridables + ///@{ + + /// This prints out a group of options with title + /// + CLI11_NODISCARD 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 * /*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; + + ///@} +}; + + + + +using results_t = std::vector; +/// callback function definition +using callback_t = std::function; + +class Option; +class App; + +using Option_p = std::unique_ptr