diff --git a/D3D9Hook/D3D9Hook.vcxproj b/D3D9Hook/D3D9Hook.vcxproj index 882edf4..9993063 100644 --- a/D3D9Hook/D3D9Hook.vcxproj +++ b/D3D9Hook/D3D9Hook.vcxproj @@ -72,13 +72,13 @@ true - C:\Users\hugo_\Documents\Dev\d9hook\imgui;C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Include;C:\Users\hugo_\Documents\Dev\lib\detours-master\detours;$(IncludePath) - C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Lib\x86;C:\Users\hugo_\Documents\Dev\lib\detours-master\Win32\Release;$(LibraryPath) + C:\Users\hugo_\Documents\Dev\GitHub\d9hook\imgui;C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Include;C:\Users\hugo_\Documents\Dev\GitHub\d9hook\detours\detours;$(IncludePath) + C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Lib\x86;C:\Users\hugo_\Documents\Dev\GitHub\d9hook\detours\x86;$(LibraryPath) false - C:\Users\hugo_\Documents\Dev\d9hook\imgui;C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Include;C:\Users\hugo_\Documents\Dev\lib\detours-master\detours;$(IncludePath) - C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Lib\x86;C:\Users\hugo_\Documents\Dev\lib\detours-master\Win32\Release;$(LibraryPath) + C:\Users\hugo_\Documents\Dev\GitHub\d9hook\imgui;C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Include;C:\Users\hugo_\Documents\Dev\GitHub\d9hook\detours\detours;$(IncludePath) + C:\Program Files %28x86%29\Microsoft DirectX SDK %28June 2010%29\Lib\x86;C:\Users\hugo_\Documents\Dev\GitHub\d9hook\detours\x86;$(LibraryPath) true diff --git a/README.md b/README.md index c2dbb63..f42c18e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ -# d9hook Concept +# d9hook POC -Internal hack for any game using DirectX9 and imgui to render a menu. It hook functions and steal the game's d3d device to render things like the menu and other stuff. It still only a concept and can be improved !
-I didn't spent a lot of time on it
- -You will need to use the detour lib: `https://github.com/Nukem9/detours`.
-Make sure to included it in Visual Studio and build the detour lib +Internal hack for any game using DirectX9 and imgui to render a menu. It hook functions and steal the game's d3d device to render things like the menu and other stuff. It still only a concept and can be improved ! +## Setup: + +Project > Propreties > Configuration Properties > VC++ Directories: + +Inlcude Directories: +- Include the `imgui/` folder +- Include the `detours/detours/` folder (detour lib: `https://github.com/Nukem9/detours`) +- Install and Inlcude Microsoft DirectX SDK 2010 Include folder: `https://www.microsoft.com/en-us/download/details.aspx?id=6812` + +Library Directories: +- Include `detours/x86/` folder (detours.lib is inside or recompile it and place it somewhere else) +- Include Microsoft DirectX SDK 2010 Lib/x86/ folder + +(If you want to compile it using x64 recompile the detours lib and include the x64 lib of the Microsoft DirectX SDK) +**Disclaimer** +*This hook was written when I was beginning Game Hacking and can be improved, to understand how it works I suggest you to check out Guided Hacking and Null videos* \ No newline at end of file diff --git a/detours/LICENSE b/detours/LICENSE new file mode 100644 index 0000000..5a5ee5e --- /dev/null +++ b/detours/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Nukem + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/detours/README.md b/detours/README.md new file mode 100644 index 0000000..9d692cc --- /dev/null +++ b/detours/README.md @@ -0,0 +1,5 @@ +# Detours + + +This project uses: +- Zydis: https://github.com/zyantific/zydis \ No newline at end of file diff --git a/detours/detours.sln b/detours/detours.sln new file mode 100644 index 0000000..0f3e9ca --- /dev/null +++ b/detours/detours.sln @@ -0,0 +1,91 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.28922.388 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "detours", "detours\detours.vcxproj", "{06E30C65-D79A-4FEC-8A60-B36D907E6601}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug Kernel|Win32 = Debug Kernel|Win32 + Debug Kernel|x64 = Debug Kernel|x64 + Debug MD DLL|Win32 = Debug MD DLL|Win32 + Debug MD DLL|x64 = Debug MD DLL|x64 + Debug MD|Win32 = Debug MD|Win32 + Debug MD|x64 = Debug MD|x64 + Debug MT DLL|Win32 = Debug MT DLL|Win32 + Debug MT DLL|x64 = Debug MT DLL|x64 + Debug MT|Win32 = Debug MT|Win32 + Debug MT|x64 = Debug MT|x64 + Debug|Win32 = Debug|Win32 + Debug|x64 = Debug|x64 + Release Kernel|Win32 = Release Kernel|Win32 + Release Kernel|x64 = Release Kernel|x64 + Release MD DLL|Win32 = Release MD DLL|Win32 + Release MD DLL|x64 = Release MD DLL|x64 + Release MD|Win32 = Release MD|Win32 + Release MD|x64 = Release MD|x64 + Release MT DLL|Win32 = Release MT DLL|Win32 + Release MT DLL|x64 = Release MT DLL|x64 + Release MT|Win32 = Release MT|Win32 + Release MT|x64 = Release MT|x64 + Release|Win32 = Release|Win32 + Release|x64 = Release|x64 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug Kernel|Win32.ActiveCfg = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug Kernel|Win32.Build.0 = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug Kernel|x64.ActiveCfg = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug Kernel|x64.Build.0 = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD DLL|Win32.ActiveCfg = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD DLL|Win32.Build.0 = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD DLL|x64.ActiveCfg = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD DLL|x64.Build.0 = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD|Win32.ActiveCfg = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD|Win32.Build.0 = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD|x64.ActiveCfg = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MD|x64.Build.0 = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT DLL|Win32.ActiveCfg = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT DLL|Win32.Build.0 = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT DLL|x64.ActiveCfg = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT DLL|x64.Build.0 = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT|Win32.ActiveCfg = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT|Win32.Build.0 = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT|x64.ActiveCfg = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug MT|x64.Build.0 = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug|Win32.ActiveCfg = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug|Win32.Build.0 = Debug|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug|x64.ActiveCfg = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Debug|x64.Build.0 = Debug|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release Kernel|Win32.ActiveCfg = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release Kernel|Win32.Build.0 = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release Kernel|x64.ActiveCfg = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release Kernel|x64.Build.0 = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD DLL|Win32.ActiveCfg = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD DLL|Win32.Build.0 = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD DLL|x64.ActiveCfg = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD DLL|x64.Build.0 = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD|Win32.ActiveCfg = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD|Win32.Build.0 = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD|x64.ActiveCfg = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MD|x64.Build.0 = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT DLL|Win32.ActiveCfg = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT DLL|Win32.Build.0 = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT DLL|x64.ActiveCfg = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT DLL|x64.Build.0 = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT|Win32.ActiveCfg = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT|Win32.Build.0 = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT|x64.ActiveCfg = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release MT|x64.Build.0 = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release|Win32.ActiveCfg = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release|Win32.Build.0 = Release|Win32 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release|x64.ActiveCfg = Release|x64 + {06E30C65-D79A-4FEC-8A60-B36D907E6601}.Release|x64.Build.0 = Release|x64 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {2402E94B-CD88-4BB5-9788-486639B544FB} + EndGlobalSection +EndGlobal diff --git a/detours/detours/Detours.cpp b/detours/detours/Detours.cpp new file mode 100644 index 0000000..6f2fed7 --- /dev/null +++ b/detours/detours/Detours.cpp @@ -0,0 +1,177 @@ +#include "stdafx.h" + +namespace Detours +{ + uint32_t GlobalOptions; + + void SetGlobalOptions(uint32_t Options) + { + InterlockedExchange(&GlobalOptions, Options & OPT_MASK); + } + + uint32_t GetGlobalOptions() + { + return GlobalOptions; + } + + uint64_t DetourAlignAddress(uint64_t Address, uint8_t Align) + { + if (Address % Align != 0) + Address += Align - Address % 8; + + return Address; + } + + bool DetourCopyMemory(uintptr_t Target, uintptr_t Memory, size_t Length) + { + auto pvTarget = reinterpret_cast(Target); + auto pvMemory = reinterpret_cast(Memory); + + DWORD dwOld = 0; + if (!VirtualProtect(pvTarget, Length, PAGE_EXECUTE_READWRITE, &dwOld)) + return false; + + memcpy(pvTarget, pvMemory, Length); + + // Ignore if this fails, the memory was copied either way + VirtualProtect(pvTarget, Length, dwOld, &dwOld); + return true; + } + + bool DetourFlushCache(uintptr_t Target, size_t Length) + { + return FlushInstructionCache(GetCurrentProcess(), reinterpret_cast(Target), Length) != FALSE; + } + + uintptr_t IATThunkHook(uintptr_t Module, PIMAGE_THUNK_DATA NameTable, PIMAGE_THUNK_DATA ImportTable, const char *API, uintptr_t Detour) + { + for (; NameTable->u1.Ordinal != 0; ++NameTable, ++ImportTable) + { + if (!IMAGE_SNAP_BY_ORDINAL(NameTable->u1.Ordinal)) + { + auto importName = reinterpret_cast(Module + NameTable->u1.ForwarderString); + auto funcName = &importName->Name[0]; + + // If this is the function name we want, hook it + if (!strcmp(funcName, API)) + { + // Copy the pointer variable itself, not the function bytes + uintptr_t originalFunc = ImportTable->u1.AddressOfData; + uintptr_t newPointer = Detour; + + if (!DetourCopyMemory(reinterpret_cast(&ImportTable->u1.AddressOfData), reinterpret_cast(&newPointer), sizeof(ImportTable->u1.AddressOfData))) + return 0; + + // Done + return originalFunc; + } + } + } + + return 0; + } + + uintptr_t IATHook(uintptr_t Module, const char *ImportModule, const char *API, uintptr_t Detour) + { + auto dosHeader = reinterpret_cast(Module); + auto ntHeaders = reinterpret_cast(Module + dosHeader->e_lfanew); + + // Validate PE Header and (64-bit|32-bit) module type + if (dosHeader->e_magic != IMAGE_DOS_SIGNATURE) + return 0; + + if (ntHeaders->Signature != IMAGE_NT_SIGNATURE) + return 0; + + if (ntHeaders->OptionalHeader.Magic != IMAGE_NT_OPTIONAL_HDR_MAGIC) + return 0; + + // Get the load configuration section which holds the imports + auto dataDirectory = ntHeaders->OptionalHeader.DataDirectory; + auto sectionRVA = dataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT].VirtualAddress; + auto sectionSize = dataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT].Size; + + if (sectionRVA == 0 || sectionSize == 0) + return 0; + + // https://jpassing.com/2008/01/06/using-import-address-table-hooking-for-testing/ + // https://llvm.org/svn/llvm-project/compiler-rt/trunk/lib/interception/interception_win.cc + // + // Iterate over each import descriptor + auto importDescriptor = reinterpret_cast(Module + sectionRVA); + + for (size_t i = 0; importDescriptor[i].Name != 0; i++) + { + auto dllName = reinterpret_cast(Module + importDescriptor[i].Name); + + // Is this the specific module the user wants? + if (!_stricmp(dllName, ImportModule)) + { + if (!importDescriptor[i].FirstThunk) + return 0; + + auto nameTable = reinterpret_cast(Module + importDescriptor[i].OriginalFirstThunk); + auto importTable = reinterpret_cast(Module + importDescriptor[i].FirstThunk); + + auto originalFunc = IATThunkHook(Module, nameTable, importTable, API, Detour); + + if (!originalFunc) + continue; + + return originalFunc; + } + } + + // API or module name wasn't found + return 0; + } + + uintptr_t IATDelayedHook(uintptr_t Module, const char *ImportModule, const char *API, uintptr_t Detour) + { + auto dosHeader = reinterpret_cast(Module); + auto ntHeaders = reinterpret_cast(Module + dosHeader->e_lfanew); + + // Validate PE Header and (64-bit|32-bit) module type + if (dosHeader->e_magic != IMAGE_DOS_SIGNATURE) + return 0; + + if (ntHeaders->Signature != IMAGE_NT_SIGNATURE) + return 0; + + if (ntHeaders->OptionalHeader.Magic != IMAGE_NT_OPTIONAL_HDR_MAGIC) + return 0; + + // Get the load configuration section which holds the imports + auto dataDirectory = ntHeaders->OptionalHeader.DataDirectory; + auto sectionRVA = dataDirectory[IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT].VirtualAddress; + auto sectionSize = dataDirectory[IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT].Size; + + if (sectionRVA == 0 || sectionSize == 0) + return 0; + + // Iterate over each delayed import descriptor + auto importDescriptor = reinterpret_cast(Module + sectionRVA); + + for (size_t i = 0; importDescriptor[i].DllNameRVA != 0; i++) + { + auto dllName = reinterpret_cast(Module + importDescriptor[i].DllNameRVA); + + // Is this the specific module the user wants? + if (!_stricmp(dllName, ImportModule)) + { + auto nameTable = reinterpret_cast(Module + importDescriptor[i].ImportNameTableRVA); + auto importTable = reinterpret_cast(Module + importDescriptor[i].ImportAddressTableRVA); + + auto originalFunc = IATThunkHook(Module, nameTable, importTable, API, Detour); + + if (!originalFunc) + continue; + + return originalFunc; + } + } + + // API or module name wasn't found + return 0; + } +} \ No newline at end of file diff --git a/detours/detours/Detours.h b/detours/detours/Detours.h new file mode 100644 index 0000000..36ebf67 --- /dev/null +++ b/detours/detours/Detours.h @@ -0,0 +1,134 @@ +#pragma once + +#include + +namespace Detours +{ + static_assert(sizeof(uintptr_t) == sizeof(void*)); + + const static uint32_t DISASM_MAX_INSTRUCTIONS = 50; // Maximum number of instructions to decode at once + + const static uint32_t OPT_MASK = 0xFFF; // Mask for all options + const static uint32_t OPT_NONE = 0x000; // No options + const static uint32_t OPT_BREAK_ON_FAIL = 0x001; // Throw INT3 on failure + const static uint32_t OPT_DO_NOT_PAD_NOPS = 0x002; // Don't pad replaced instructions with NOPs + + struct JumpTrampolineHeader + { + uint32_t Magic; // Used to verify the header + uint32_t Random; // Variable to change the code/data hash + + uintptr_t CodeOffset; // Offset, in code, that was hooked: "target" + uintptr_t DetourOffset; // User function that is called: "destination" + + uintptr_t InstructionLength;// Length of the instructions that were replaced + uintptr_t InstructionOffset;// Where the backed-up instructions are + + uintptr_t TrampolineLength; // Length of the trampoline + uintptr_t TrampolineOffset; // Code offset where 'jmp (q/d)word ptr ' occurs + + // Anything after this struct is null data or pure code (instructions/trampoline) + }; + + void SetGlobalOptions(uint32_t Options); + uint32_t GetGlobalOptions(); + + uint64_t DetourAlignAddress(uint64_t Address, uint8_t Align); + + bool DetourCopyMemory(uintptr_t Target, uintptr_t Memory, size_t Length); + bool DetourFlushCache(uintptr_t Target, size_t Length); + uintptr_t IATHook(uintptr_t Module, const char *ImportModule, const char *API, uintptr_t Detour); + uintptr_t IATDelayedHook(uintptr_t Module, const char *ImportModule, const char *API, uintptr_t Detour); + +#ifdef _M_IX86 + enum class X86Option + { + USE_JUMP, // jmp
; + USE_CALL, // call
; + USE_PUSH_RET, // push
; retn; + }; + + namespace X86 + { + // Redirects a single static function to another + uintptr_t DetourFunction(uintptr_t Target, uintptr_t Detour, X86Option Options = X86Option::USE_JUMP); + + // Redirects a class member function (__thiscall) to another + template + uintptr_t DetourFunctionClass(uintptr_t Target, T Detour, X86Option Options = X86Option::USE_JUMP) + { + return DetourFunction(Target, *(uintptr_t *)&Detour, Options); + } + + // Removes a detoured function (Static or class member) + bool DetourRemove(uintptr_t Trampoline); + + // Redirects an index in a virtual table + uintptr_t DetourVTable(uintptr_t Target, uintptr_t Detour, uint32_t TableIndex); + + // Redirects a class member virtual function (__thiscall) to another + template + uintptr_t DetourClassVTable(uintptr_t Target, T Detour, uint32_t TableIndex) + { + return DetourVTable(Target, *(uintptr_t *)&Detour, TableIndex); + } + + // Removes a detoured virtual table index + bool VTableRemove(uintptr_t Target, uintptr_t Function, uint32_t TableIndex); + + void DetourWriteStub(JumpTrampolineHeader *Header); + bool DetourWriteJump(JumpTrampolineHeader *Header); + bool DetourWriteCall(JumpTrampolineHeader *Header); + bool DetourWritePushRet(JumpTrampolineHeader *Header); + + uint32_t DetourGetHookLength(X86Option Options); + } +#endif // _M_IX86 + +#ifdef _M_AMD64 + enum class X64Option + { + USE_PUSH_RET, // push ; [rsp+4h] = ; retn; + USE_RAX_JUMP, // mov rax,
; jmp rax; + USE_REL32_JUMP, // jmp
+ USE_REL32_CALL, // call
+ }; + + namespace X64 + { + // Redirects a single static function to another + uintptr_t DetourFunction(uintptr_t Target, uintptr_t Detour, X64Option Options = X64Option::USE_REL32_JUMP); + + // Redirects a class member function (__thiscall) to another + template + uintptr_t DetourFunctionClass(uintptr_t Target, T Detour, X64Option Options = X64Option::USE_REL32_JUMP) + { + return DetourFunction(Target, *(uintptr_t *)&Detour, Options); + } + + // Removes a detoured function (Static or class member) + bool DetourRemove(uintptr_t Trampoline); + + // Redirects an index in a virtual table + uintptr_t DetourVTable(uintptr_t Target, uintptr_t Detour, uint32_t TableIndex); + + // Redirects a class member virtual function (__thiscall) to another + template + uintptr_t DetourClassVTable(uintptr_t Target, T Detour, uint32_t TableIndex) + { + return DetourVTable(Target, *(uintptr_t *)&Detour, TableIndex); + } + + // Removes a detoured virtual table index + bool VTableRemove(uintptr_t Target, uintptr_t Function, uint32_t TableIndex); + + void DetourWriteStub(JumpTrampolineHeader *Header); + bool DetourWritePushRet(JumpTrampolineHeader *Header); + bool DetourWriteRaxJump(JumpTrampolineHeader *Header); + bool DetourWriteRel32Jump(JumpTrampolineHeader *Header); + bool DetourWriteRel32Call(JumpTrampolineHeader *Header); + + uint32_t DetourGetHookLength(X64Option Options); + } +#endif // _M_AMD64 +} \ No newline at end of file diff --git a/detours/detours/Detours32.cpp b/detours/detours/Detours32.cpp new file mode 100644 index 0000000..8214376 --- /dev/null +++ b/detours/detours/Detours32.cpp @@ -0,0 +1,263 @@ +#include "stdafx.h" + +extern "C" int DetoursInitZydis32(); +extern "C" int DetoursInitZydis64(); +extern "C" int DetoursGetNextInstructionLength(void *Instruction); + +#ifdef _M_IX86 +namespace Detours +{ + namespace X86 + { + #define HEADER_MAGIC '@D32' + + #define MAX_INSTRUCT_SIZE 0x08 + + #define JUMP_LENGTH_32 0x05 // jmp + #define CALL_LENGTH_32 0x05 // call + #define JUMP_EAX_LENGTH_32 0x07 // mov eax, ; jmp eax + #define JUMP_PTR_LENGTH_32 0x06 // jmp dword ptr + #define PUSH_RET_LENGTH_32 0x06 // push ; retn + + #define ALIGN_32(x) DetourAlignAddress((uint64_t)(x), 0x4); + #define BREAK_ON_ERROR() { if (GetGlobalOptions() & OPT_BREAK_ON_FAIL) __debugbreak(); } + + uintptr_t DetourFunction(uintptr_t Target, uintptr_t Detour, X86Option Options) + { + if (!Target || !Detour) + { + BREAK_ON_ERROR(); + return 0; + } + + // Init decoder exactly once + static bool decoderInit = []() + { + return DetoursInitZydis64() == -1 ? false : true; + }(); + + if (!decoderInit) + { + BREAK_ON_ERROR(); + return 0; + } + + // Decode the actual assembly + uint32_t neededSize = DetourGetHookLength(Options); + uint32_t totalInstrSize = 0; + + for (int len = 0; len != -1; len = DetoursGetNextInstructionLength(reinterpret_cast(Target + totalInstrSize))) + { + totalInstrSize += len; + + if (totalInstrSize >= neededSize) + break; + } + + // Unable to find a needed length + if (neededSize == 0 || totalInstrSize < neededSize) + { + BREAK_ON_ERROR(); + return 0; + } + + // Allocate the trampoline data + uint32_t allocSize = 0; + allocSize += sizeof(JumpTrampolineHeader); // Base structure + allocSize += totalInstrSize; // Size of the copied instructions + allocSize += MAX_INSTRUCT_SIZE; // Maximum instruction size + allocSize += MAX_INSTRUCT_SIZE; // Maximum instruction size + allocSize += 0x64; // Padding for any memory alignment + + uint8_t *jumpTrampolinePtr = (uint8_t *)VirtualAlloc(nullptr, allocSize, MEM_RESERVE | MEM_COMMIT, PAGE_EXECUTE_READWRITE); + + if (!jumpTrampolinePtr) + { + BREAK_ON_ERROR(); + return 0; + } + + // Fill out the header + auto header = reinterpret_cast(jumpTrampolinePtr); + + header->Magic = HEADER_MAGIC; + header->Random = GetCurrentProcessId() + GetCurrentThreadId() + totalInstrSize; + + header->CodeOffset = Target; + header->DetourOffset = Detour; + + header->InstructionLength = totalInstrSize; + header->InstructionOffset = ALIGN_32(jumpTrampolinePtr + sizeof(JumpTrampolineHeader)); + + header->TrampolineLength = JUMP_LENGTH_32; + header->TrampolineOffset = ALIGN_32(header->InstructionOffset + header->InstructionLength + JUMP_LENGTH_32 + header->TrampolineLength); + + // Copy the old instructions over + DetourCopyMemory(header->InstructionOffset, header->CodeOffset, header->InstructionLength); + + // Write the assembly in the allocation block + DetourWriteStub(header); + + // Write padding nops if the hook splices the middle of an instruction + if ((GetGlobalOptions() & OPT_DO_NOT_PAD_NOPS) == 0) + { + std::vector nops; + + for (uint32_t i = 0; i < header->InstructionLength; i++) + nops.push_back(0x90); + + DetourCopyMemory(header->CodeOffset, reinterpret_cast(nops.data()), nops.size()); + } + + bool result = false; + + switch (Options) + { + case X86Option::USE_JUMP: result = DetourWriteJump(header); break; + case X86Option::USE_CALL: result = DetourWriteCall(header); break; + case X86Option::USE_PUSH_RET: result = DetourWritePushRet(header); break; + } + + // If an operation failed free the memory and exit + if (!result) + { + VirtualFree(jumpTrampolinePtr, 0, MEM_RELEASE); + + BREAK_ON_ERROR(); + return 0; + } + + // Force flush any possible CPU cache + DetourFlushCache(Target, totalInstrSize); + DetourFlushCache(reinterpret_cast(jumpTrampolinePtr), allocSize); + + // Set read/execution on the page + DWORD dwOld = 0; + VirtualProtect(jumpTrampolinePtr, allocSize, PAGE_EXECUTE_READ, &dwOld); + + return header->InstructionOffset; + } + + bool DetourRemove(uint8_t *Trampoline) + { + if (!Trampoline) + { + BREAK_ON_ERROR(); + return false; + } + + auto header = reinterpret_cast(Trampoline - sizeof(JumpTrampolineHeader)); + + if (header->Magic != HEADER_MAGIC) + { + BREAK_ON_ERROR(); + return false; + } + + // Rewrite the backed-up code + if (!DetourCopyMemory(header->CodeOffset, header->InstructionOffset, header->InstructionLength)) + { + BREAK_ON_ERROR(); + return false; + } + + DetourFlushCache(header->CodeOffset, header->InstructionLength); + VirtualFree(header, 0, MEM_RELEASE); + + return true; + } + + uintptr_t DetourVTable(uintptr_t Target, uintptr_t Detour, uint32_t TableIndex) + { + // Each function is stored in an array + auto virtualPointer = reinterpret_cast(Target + (TableIndex * sizeof(void *))); + + DWORD dwOld = 0; + if (!VirtualProtect(virtualPointer, sizeof(void *), PAGE_EXECUTE_READWRITE, &dwOld)) + return 0; + + auto original = InterlockedExchangePointer(reinterpret_cast(virtualPointer), reinterpret_cast(Detour)); + + VirtualProtect(virtualPointer, sizeof(void *), dwOld, &dwOld); + return reinterpret_cast(original); + } + + bool VTableRemove(uintptr_t Target, uintptr_t Function, uint32_t TableIndex) + { + // Reverse VTable detour + return DetourVTable(Target, Function, TableIndex) != 0; + } + + void DetourWriteStub(JumpTrampolineHeader *Header) + { + /********** Allocated code block modifications **********/ + uint8_t buffer[5]; + + auto unhookStart = Header->CodeOffset + Header->InstructionLength; // Determine where the 'unhooked' part of the function starts + auto binstrPtr = Header->InstructionOffset + Header->InstructionLength;// Jump to hooked function (Backed up instructions) + + buffer[0] = 0xE9; + *reinterpret_cast(&buffer[1]) = static_cast(unhookStart - (binstrPtr + 5)); + + DetourCopyMemory(binstrPtr, reinterpret_cast(&buffer), sizeof(buffer)); + + // Jump to user function (Write the trampoline) + buffer[0] = 0xE9; + *reinterpret_cast(&buffer[1]) = static_cast(Header->DetourOffset - (Header->TrampolineOffset + 5)); + + DetourCopyMemory(Header->TrampolineOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + bool DetourWriteJump(JumpTrampolineHeader *Header) + { + // Relative JUMP + uint8_t buffer[5]; + + buffer[0] = 0xE9; + *reinterpret_cast(&buffer[1]) = static_cast(Header->TrampolineOffset - (Header->CodeOffset + 5)); + + return DetourCopyMemory(Header->CodeOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + bool DetourWriteCall(JumpTrampolineHeader *Header) + { + // Relative CALL + uint8_t buffer[5]; + + buffer[0] = 0xE8; + *reinterpret_cast(&buffer[1]) = static_cast(Header->TrampolineOffset - (Header->CodeOffset + 5)); + + return DetourCopyMemory(Header->CodeOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + bool DetourWritePushRet(JumpTrampolineHeader *Header) + { + // RET-Jump to trampoline + uint8_t buffer[6]; + + // push 0xXXXXX + buffer[0] = 0x68; + *reinterpret_cast(&buffer[1]) = Header->TrampolineOffset; + + // retn + buffer[5] = 0xC3; + + return DetourCopyMemory(Header->CodeOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + uint32_t DetourGetHookLength(X86Option Options) + { + uint32_t size = 0; + + switch (Options) + { + case X86Option::USE_JUMP: size += JUMP_LENGTH_32; break; + case X86Option::USE_CALL: size += CALL_LENGTH_32; break; + case X86Option::USE_PUSH_RET: size += PUSH_RET_LENGTH_32; break; + } + + return size; + } + } +} +#endif // _M_IX86 \ No newline at end of file diff --git a/detours/detours/Detours64.cpp b/detours/detours/Detours64.cpp new file mode 100644 index 0000000..b997330 --- /dev/null +++ b/detours/detours/Detours64.cpp @@ -0,0 +1,339 @@ +#include "stdafx.h" + +extern "C" int DetoursInitZydis32(); +extern "C" int DetoursInitZydis64(); +extern "C" int DetoursGetNextInstructionLength(void *Instruction); + +#ifdef _M_AMD64 +namespace Detours +{ + namespace X64 + { + #define HEADER_MAGIC '@D64' + + #define MAX_INSTRUCT_SIZE 0x20 + + #define PUSH_RET_LENGTH_64 0x0E // push ; mov [rsp+4h], ; ret; + #define RAX_JUMP_64 0x0C // mov rax, ; jmp rax; + #define REL32_JUMP_64 0x05 // jmp
+ #define REL32_CALL_64 0x05 // call
+ + #define ALIGN_64(x) DetourAlignAddress((uint64_t)(x), 16); + #define BREAK_ON_ERROR() { if (GetGlobalOptions() & OPT_BREAK_ON_FAIL) __debugbreak(); } + + uintptr_t DetourFunction(uintptr_t Target, uintptr_t Detour, X64Option Options) + { + if (!Target || !Detour) + { + BREAK_ON_ERROR(); + return 0; + } + + // Init decoder exactly once + static bool decoderInit = []() + { + return DetoursInitZydis64() == -1 ? false : true; + }(); + + if (!decoderInit) + { + BREAK_ON_ERROR(); + return 0; + } + + // Decode the actual assembly + uint32_t neededSize = DetourGetHookLength(Options); + uint32_t totalInstrSize = 0; + + for (int len = 0; len != -1; len = DetoursGetNextInstructionLength(reinterpret_cast(Target + totalInstrSize))) + { + totalInstrSize += len; + + if (totalInstrSize >= neededSize) + break; + } + + // Unable to find a needed length + if (neededSize == 0 || totalInstrSize < neededSize) + { + BREAK_ON_ERROR(); + return 0; + } + + // Allocate the trampoline data + uint32_t allocSize = 0; + allocSize += sizeof(JumpTrampolineHeader); // Base structure + allocSize += totalInstrSize; // Size of the copied instructions + allocSize += MAX_INSTRUCT_SIZE; // For DetourWriteStub + allocSize += MAX_INSTRUCT_SIZE; // For DetourWriteStub + allocSize += 0x64; // Padding for any memory alignment + + uint8_t *jumpTrampolinePtr = nullptr; + + // NOTE: If we're doing a REL32 hook, we need to do some magic + if (Options == X64Option::USE_REL32_JUMP || Options == X64Option::USE_REL32_CALL) + { + // Find a region within 2GB (subtract some for tolerance) + const uintptr_t maxDelta = (1ull * 1024 * 1024 * 1024) - 4096; + + uintptr_t start = Target - maxDelta; + uintptr_t end = Target + maxDelta; + + while (start < end) + { + MEMORY_BASIC_INFORMATION memInfo = {}; + if (VirtualQuery(reinterpret_cast(start), &memInfo, sizeof(memInfo)) == 0) + break; + + if (memInfo.State == MEM_FREE && memInfo.RegionSize >= allocSize) + { + jumpTrampolinePtr = static_cast(VirtualAlloc(memInfo.BaseAddress, allocSize, MEM_RESERVE | MEM_COMMIT, PAGE_EXECUTE_READWRITE)); + + if (jumpTrampolinePtr) + break; + } + + start = reinterpret_cast(memInfo.BaseAddress) + 4096 + 1; + } + } + else + { + // Can be allocated anywhere + jumpTrampolinePtr = static_cast(VirtualAlloc(nullptr, allocSize, MEM_RESERVE | MEM_COMMIT, PAGE_EXECUTE_READWRITE)); + } + + if (!jumpTrampolinePtr) + { + BREAK_ON_ERROR(); + return 0; + } + + // Fill out the header + auto header = reinterpret_cast(jumpTrampolinePtr); + + header->Magic = HEADER_MAGIC; + header->Random = GetCurrentProcessId() + GetCurrentThreadId() + totalInstrSize; + + header->CodeOffset = Target; + header->DetourOffset = Detour; + + header->InstructionLength = totalInstrSize; + header->InstructionOffset = ALIGN_64(jumpTrampolinePtr + sizeof(JumpTrampolineHeader)); + + header->TrampolineLength = MAX_INSTRUCT_SIZE; + header->TrampolineOffset = ALIGN_64(header->InstructionOffset + header->InstructionLength + MAX_INSTRUCT_SIZE + header->TrampolineLength); + + // Copy the old instructions over + DetourCopyMemory(header->InstructionOffset, header->CodeOffset, header->InstructionLength); + + // Write the assembly in the allocation block + DetourWriteStub(header); + + // Write padding nops if the hook splices the middle of an instruction + if ((GetGlobalOptions() & OPT_DO_NOT_PAD_NOPS) == 0) + { + std::vector nops; + + for (uint32_t i = 0; i < header->InstructionLength; i++) + nops.push_back(0x90); + + DetourCopyMemory(header->CodeOffset, reinterpret_cast(nops.data()), nops.size()); + } + + bool result = false; + + switch (Options) + { + case X64Option::USE_PUSH_RET: result = DetourWritePushRet(header); break; + case X64Option::USE_RAX_JUMP: result = DetourWriteRaxJump(header); break; + case X64Option::USE_REL32_JUMP: result = DetourWriteRel32Jump(header); break; + case X64Option::USE_REL32_CALL: result = DetourWriteRel32Call(header); break; + } + + if (!result) + { + VirtualFree(jumpTrampolinePtr, 0, MEM_RELEASE); + + BREAK_ON_ERROR(); + return 0; + } + + // Force flush any possible CPU cache + DetourFlushCache(Target, totalInstrSize); + DetourFlushCache(reinterpret_cast(jumpTrampolinePtr), allocSize); + + // Set read/execution on the page + DWORD dwOld = 0; + VirtualProtect(jumpTrampolinePtr, allocSize, PAGE_EXECUTE_READ, &dwOld); + + return header->InstructionOffset; + } + + bool DetourRemove(uintptr_t Trampoline) + { + if (!Trampoline) + { + BREAK_ON_ERROR(); + return false; + } + + auto header = reinterpret_cast(Trampoline - sizeof(JumpTrampolineHeader)); + + if (header->Magic != HEADER_MAGIC) + { + BREAK_ON_ERROR(); + return false; + } + + // Rewrite the backed-up code + if (!DetourCopyMemory(header->CodeOffset, header->InstructionOffset, header->InstructionLength)) + { + BREAK_ON_ERROR(); + return false; + } + + DetourFlushCache(header->CodeOffset, header->InstructionLength); + VirtualFree(header, 0, MEM_RELEASE); + + return true; + } + + uintptr_t DetourVTable(uintptr_t Target, uintptr_t Detour, uint32_t TableIndex) + { + // Each function is stored in an array + auto virtualPointer = reinterpret_cast(Target + (TableIndex * sizeof(void *))); + + DWORD dwOld = 0; + if (!VirtualProtect(virtualPointer, sizeof(void *), PAGE_EXECUTE_READWRITE, &dwOld)) + return 0; + + auto original = InterlockedExchangePointer(reinterpret_cast(virtualPointer), reinterpret_cast(Detour)); + + VirtualProtect(virtualPointer, sizeof(void *), dwOld, &dwOld); + return reinterpret_cast(original); + } + + bool VTableRemove(uintptr_t Target, uintptr_t Function, uint32_t TableIndex) + { + // Reverse VTable detour + return DetourVTable(Target, Function, TableIndex) != 0; + } + + void DetourWriteStub(JumpTrampolineHeader *Header) + { + auto writeJmp = [](uintptr_t Base, uintptr_t Destination) + { + uint8_t buffer[14]; + + // 'jmp qword ptr [rip + 0x6]' - unaligned + buffer[0] = 0xFF; + buffer[1] = 0x25; + *reinterpret_cast(&buffer[2]) = 0; + *reinterpret_cast(&buffer[6]) = Destination; + + return DetourCopyMemory(Base, reinterpret_cast(&buffer), sizeof(buffer)); + }; + + // Jump to hooked function (Backed up instructions) [UserFunction -> OldInstructions -> THIS -> HookedFunction] + auto unhookStart = Header->CodeOffset + Header->InstructionLength; + auto instr_ptr = Header->InstructionOffset + Header->InstructionLength; + + writeJmp(instr_ptr, unhookStart); + + // Jump to user function (Write the trampoline) [HookedFunction -> THIS -> UserFunction] + writeJmp(Header->TrampolineOffset, Header->DetourOffset); + } + + bool DetourWritePushRet(JumpTrampolineHeader *Header) + { + uint8_t buffer[14]; + + // Jump with PUSH/RET (push low32, [rsp+4h] = hi32) + // + // push dword low32 + // mov dword [rsp + 0x4], hi32 + // ret + // + buffer[0] = 0x68; + *reinterpret_cast(&buffer[1]) = static_cast(Header->TrampolineOffset & 0xFFFFFFFF); + buffer[5] = 0xC7; + buffer[6] = 0x44; + buffer[7] = 0x24; + buffer[8] = 0x04; + *reinterpret_cast(&buffer[9]) = static_cast(Header->TrampolineOffset >> 32); + buffer[13] = 0x04; + + return DetourCopyMemory(Header->CodeOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + bool DetourWriteRaxJump(JumpTrampolineHeader *Header) + { + // Jump to trampoline (from hooked function) + // + // mov rax, offset64 + // jmp rax + // + uint8_t buffer[12]; + buffer[0] = 0x48; + buffer[1] = 0xB8; + *reinterpret_cast(&buffer[2]) = Header->TrampolineOffset; + + buffer[10] = 0xFF; + buffer[11] = 0xE0; + + return DetourCopyMemory(Header->CodeOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + bool DetourWriteRel32Jump(JumpTrampolineHeader *Header) + { + // Assumes that the delta is less than 2GB. We need to manually write the offset. + // + // jmp offset64 + // + const auto displacement = static_cast(Header->TrampolineOffset - (Header->CodeOffset + 5)); + + if (abs(displacement) >= INT_MAX) + return false; + + uint8_t buffer[5]; + buffer[0] = 0xE9; + *reinterpret_cast(&buffer[1]) = static_cast(displacement); + + return DetourCopyMemory(Header->CodeOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + bool DetourWriteRel32Call(JumpTrampolineHeader *Header) + { + // Same as DetourWriteRel32Jump but with a different opcode + // + // call offset64 + // + const auto displacement = static_cast(Header->TrampolineOffset - (Header->CodeOffset + 5)); + + if (abs(displacement) >= INT_MAX) + return false; + + uint8_t buffer[5]; + buffer[0] = 0xE8; + *reinterpret_cast(&buffer[1]) = static_cast(displacement); + + return DetourCopyMemory(Header->CodeOffset, reinterpret_cast(&buffer), sizeof(buffer)); + } + + uint32_t DetourGetHookLength(X64Option Options) + { + uint32_t size = 0; + + switch(Options) + { + case X64Option::USE_PUSH_RET: size += PUSH_RET_LENGTH_64; break; + case X64Option::USE_RAX_JUMP: size += RAX_JUMP_64; break; + case X64Option::USE_REL32_JUMP: size += REL32_JUMP_64; break; + case X64Option::USE_REL32_CALL: size += REL32_CALL_64; break; + } + + return size; + } + } +} +#endif // _M_AMD64 \ No newline at end of file diff --git a/detours/detours/HideStaticLibSymbols.c b/detours/detours/HideStaticLibSymbols.c new file mode 100644 index 0000000..faf8acf --- /dev/null +++ b/detours/detours/HideStaticLibSymbols.c @@ -0,0 +1,134 @@ +#define ACCESSED_FLAGS __CRAP__COMPILER__ACCESSED_FLAGS +#define INSTR_ENCODINGS __CRAP__COMPILER__INSTR_ENCODINGS +#define REGISTER_MAP __CRAP__COMPILER__REGISTER_MAP +#define STR_INSTRUCTIONCATEGORY __CRAP__COMPILER__STR_INSTRUCTIONCATEGORY +#define STR_ISAEXT __CRAP__COMPILER__STR_ISAEXT +#define STR_ISASET __CRAP__COMPILER__STR_ISASET +#define STR_MNEMONIC __CRAP__COMPILER__STR_MNEMONIC +#define STR_REGISTER __CRAP__COMPILER__STR_REGISTER +#define FILTERS_XOP __CRAP__COMPILER__FILTERS_XOP +#define FILTERS_VEX __CRAP__COMPILER__FILTERS_VEX +#define FILTERS_EMVEX __CRAP__COMPILER__FILTERS_EMVEX +#define FILTERS_OPCODE __CRAP__COMPILER__FILTERS_OPCODE +#define FILTERS_MODE __CRAP__COMPILER__FILTERS_MODE +#define FILTERS_MODE_COMPACT __CRAP__COMPILER__FILTERS_MODE_COMPACT +#define FILTERS_MODRM_MOD __CRAP__COMPILER__FILTERS_MODRM_MOD +#define FILTERS_MODRM_MOD_COMPACT __CRAP__COMPILER__FILTERS_MODRM_MOD_COMPACT +#define FILTERS_MODRM_REG __CRAP__COMPILER__FILTERS_MODRM_REG +#define FILTERS_MODRM_RM __CRAP__COMPILER__FILTERS_MODRM_RM +#define FILTERS_MANDATORY_PREFIX __CRAP__COMPILER__FILTERS_MANDATORY_PREFIX +#define FILTERS_OPERAND_SIZE __CRAP__COMPILER__FILTERS_OPERAND_SIZE +#define FILTERS_ADDRESS_SIZE __CRAP__COMPILER__FILTERS_ADDRESS_SIZE +#define FILTERS_VECTOR_LENGTH __CRAP__COMPILER__FILTERS_VECTOR_LENGTH +#define FILTERS_REX_W __CRAP__COMPILER__FILTERS_REX_W +#define FILTERS_REX_B __CRAP__COMPILER__FILTERS_REX_B +#define FILTERS_EVEX_B __CRAP__COMPILER__FILTERS_EVEX_B +#define FILTERS_MVEX_E __CRAP__COMPILER__FILTERS_MVEX_E +#define FILTERS_MODE_AMD __CRAP__COMPILER__FILTERS_MODE_AMD +#define FILTERS_MODE_KNC __CRAP__COMPILER__FILTERS_MODE_KNC +#define FILTERS_MODE_MPX __CRAP__COMPILER__FILTERS_MODE_MPX +#define FILTERS_MODE_CET __CRAP__COMPILER__FILTERS_MODE_CET +#define FILTERS_MODE_LZCNT __CRAP__COMPILER__FILTERS_MODE_LZCNT +#define FILTERS_MODE_TZCNT __CRAP__COMPILER__FILTERS_MODE_TZCNT +#define FILTERS_MODE_WBNOINVD __CRAP__COMPILER__FILTERS_MODE_WBNOINVD +#define FILTERS_MODE_CLDEMOTE __CRAP__COMPILER__FILTERS_MODE_CLDEMOTE +#define FILTERS_MODE_CENTAUR __CRAP__COMPILER__FILTERS_MODE_CENTAUR +#define ISTR_DEFINITIONS_LEGACY __CRAP__COMPILER__ISTR_DEFINITIONS_LEGACY +#define ISTR_DEFINITIONS_3DNOW __CRAP__COMPILER__ISTR_DEFINITIONS_3DNOW +#define ISTR_DEFINITIONS_XOP __CRAP__COMPILER__ISTR_DEFINITIONS_XOP +#define ISTR_DEFINITIONS_VEX __CRAP__COMPILER__ISTR_DEFINITIONS_VEX +#define ISTR_DEFINITIONS_EVEX __CRAP__COMPILER__ISTR_DEFINITIONS_EVEX +#define ISTR_DEFINITIONS_MVEX __CRAP__COMPILER__ISTR_DEFINITIONS_MVEX +#define OPERAND_DEFINITIONS __CRAP__COMPILER__OPERAND_DEFINITIONS +#define ZydisCategoryGetString __CRAP__COMPILER__ZydisCategoryGetString +#define ZydisISASetGetString __CRAP__COMPILER__ZydisISASetGetString +#define ZydisISAExtGetString __CRAP__COMPILER__ZydisISAExtGetString +#define ZydisMnemonicGetString __CRAP__COMPILER__ZydisMnemonicGetString +#define ZydisMnemonicGetStringWrapped __CRAP__COMPILER__ZydisMnemonicGetStringWrapped +#define ZydisRegisterEncode __CRAP__COMPILER__ZydisRegisterEncode +#define ZydisRegisterGetId __CRAP__COMPILER__ZydisRegisterGetId +#define ZydisRegisterGetClass __CRAP__COMPILER__ZydisRegisterGetClass +#define ZydisRegisterGetWidth __CRAP__COMPILER__ZydisRegisterGetWidth +#define ZydisRegisterGetLargestEnclosing __CRAP__COMPILER__ZydisRegisterGetLargestEnclosing +#define ZydisRegisterGetString __CRAP__COMPILER__ZydisRegisterGetString +#define ZydisRegisterGetStringWrapped __CRAP__COMPILER__ZydisRegisterGetStringWrapped +#define ZydisRegisterClassGetWidth __CRAP__COMPILER__ZydisRegisterClassGetWidth +#define ZydisDecoderInit __CRAP__COMPILER__ZydisDecoderInit +#define ZydisDecoderEnableMode __CRAP__COMPILER__ZydisDecoderEnableMode +#define ZydisDecoderDecodeBuffer __CRAP__COMPILER__ZydisDecoderDecodeBuffer +#define ZydisCalcAbsoluteAddress __CRAP__COMPILER__ZydisCalcAbsoluteAddress +#define ZydisCalcAbsoluteAddressEx __CRAP__COMPILER__ZydisCalcAbsoluteAddressEx +#define ZydisGetAccessedFlagsByAction __CRAP__COMPILER__ZydisGetAccessedFlagsByAction +#define ZydisGetAccessedFlagsRead __CRAP__COMPILER__ZydisGetAccessedFlagsRead +#define ZydisGetAccessedFlagsWritten __CRAP__COMPILER__ZydisGetAccessedFlagsWritten +#define ZydisGetInstructionSegments __CRAP__COMPILER__ZydisGetInstructionSegments +#define ZydisGetVersion __CRAP__COMPILER__ZydisGetVersion +#define ZydisIsFeatureEnabled __CRAP__COMPILER__ZydisIsFeatureEnabled +#define ZydisDecoderTreeGetRootNode __CRAP__COMPILER__ZydisDecoderTreeGetRootNode +#define ZydisDecoderTreeGetChildNode __CRAP__COMPILER__ZydisDecoderTreeGetChildNode +#define ZydisGetInstructionEncodingInfo __CRAP__COMPILER__ZydisGetInstructionEncodingInfo +#define ZydisGetInstructionDefinition __CRAP__COMPILER__ZydisGetInstructionDefinition +#define ZydisGetOperandDefinitions __CRAP__COMPILER__ZydisGetOperandDefinitions +#define ZydisGetElementInfo __CRAP__COMPILER__ZydisGetElementInfo +#define ZydisGetAccessedFlags __CRAP__COMPILER__ZydisGetAccessedFlags +#define ZydisStringAppend __CRAP__COMPILER__ZydisStringAppend +#define ZydisStringAppendDecU __CRAP__COMPILER__ZydisStringAppendDecU +#define ZydisStringAppendHexU __CRAP__COMPILER__ZydisStringAppendHexU +#define ZydisStringAppendDecU64 __CRAP__COMPILER__ZydisStringAppendDecU64 +#define ZydisStringAppendHexU64 __CRAP__COMPILER__ZydisStringAppendHexU64 +#define ZydisCalcRegisterId __CRAP__COMPILER__ZydisCalcRegisterId +#define ZydisCheckErrorConditions __CRAP__COMPILER__ZydisCheckErrorConditions +#define ZydisCollectOptionalPrefixes __CRAP__COMPILER__ZydisCollectOptionalPrefixes +#define ZydisDecodeEVEX __CRAP__COMPILER__ZydisDecodeEVEX +#define ZydisDecodeInstruction __CRAP__COMPILER__ZydisDecodeInstruction +#define ZydisDecodeOperandImplicitMemory __CRAP__COMPILER__ZydisDecodeOperandImplicitMemory +#define ZydisDecodeOperandImplicitRegister __CRAP__COMPILER__ZydisDecodeOperandImplicitRegister +#define ZydisDecodeOperandMemory __CRAP__COMPILER__ZydisDecodeOperandMemory +#define ZydisDecodeOperandRegister __CRAP__COMPILER__ZydisDecodeOperandRegister +#define ZydisDecodeOperands __CRAP__COMPILER__ZydisDecodeOperands +#define ZydisDecodeOptionalInstructionParts __CRAP__COMPILER__ZydisDecodeOptionalInstructionParts +#define ZydisNodeHandlerOpcode __CRAP__COMPILER__ZydisNodeHandlerOpcode +#define ZydisReadDisplacement __CRAP__COMPILER__ZydisReadDisplacement +#define ZydisReadImmediate __CRAP__COMPILER__ZydisReadImmediate +#define ZydisSetAVXInformation __CRAP__COMPILER__ZydisSetAVXInformation +#define ZydisSetAttributes __CRAP__COMPILER__ZydisSetAttributes +#define ZydisSetOperandSizeAndElementInfo __CRAP__COMPILER__ZydisSetOperandSizeAndElementInfo + +#include +#include "zydis/src/Decoder.c" +#include "zydis/src/DecoderData.c" +#include "zydis/src/MetaInfo.c" +#include "zydis/src/Mnemonic.c" +#include "zydis/src/Register.c" +#include "zydis/src/SharedData.c" +#include "zydis/src/String.c" +#include "zydis/src/Utils.c" +#include "zydis/src/Zydis.c" + +static ZydisDecoder g_DetoursZydisDecoder; + +int DetoursInitZydis32() +{ + if (ZYAN_FAILED(ZydisDecoderInit(&g_DetoursZydisDecoder, ZYDIS_MACHINE_MODE_LEGACY_32, ZYDIS_ADDRESS_WIDTH_32))) + return -1; + + return 1; +} + +int DetoursInitZydis64() +{ + if (ZYAN_FAILED(ZydisDecoderInit(&g_DetoursZydisDecoder, ZYDIS_MACHINE_MODE_LONG_64, ZYDIS_ADDRESS_WIDTH_64))) + return -1; + + return 1; +} + +int DetoursGetNextInstructionLength(void *Instruction) +{ + ZydisDecodedInstruction instruction; + + if (ZYAN_SUCCESS(ZydisDecoderDecodeBuffer(&g_DetoursZydisDecoder, Instruction, ZYDIS_MAX_INSTRUCTION_LENGTH, &instruction))) + return instruction.length; + + return -1; +} \ No newline at end of file diff --git a/detours/detours/detours.vcxproj b/detours/detours/detours.vcxproj new file mode 100644 index 0000000..e5364b7 --- /dev/null +++ b/detours/detours/detours.vcxproj @@ -0,0 +1,187 @@ + + + + + Debug + Win32 + + + Debug + x64 + + + Release + Win32 + + + Release + x64 + + + + {06E30C65-D79A-4FEC-8A60-B36D907E6601} + Win32Proj + detours + 10.0 + + + + StaticLibrary + true + v142 + Unicode + + + StaticLibrary + true + v142 + Unicode + + + StaticLibrary + false + v142 + Unicode + false + + + StaticLibrary + false + v142 + Unicode + false + + + + + + + + + + + + + + + + + + + $(ProjectDir)zydis\msvc;$(ProjectDir)zydis\src;$(ProjectDir)zydis\dependencies\zycore\include;$(ProjectDir)zydis\include;$(IncludePath) + $(SolutionDir)$(Platform)\$(Configuration)\ + $(SolutionDir)$(Platform)\$(ProjectName)\$(Configuration)\ + + + $(ProjectDir)zydis\msvc;$(ProjectDir)zydis\src;$(ProjectDir)zydis\dependencies\zycore\include;$(ProjectDir)zydis\include;$(IncludePath) + $(SolutionDir)$(Platform)\$(Configuration)\ + $(SolutionDir)$(Platform)\$(ProjectName)\$(Configuration)\ + + + $(ProjectDir)zydis\msvc;$(ProjectDir)zydis\src;$(ProjectDir)zydis\dependencies\zycore\include;$(ProjectDir)zydis\include;$(VC_IncludePath);$(WindowsSDK_IncludePath) + $(SolutionDir)$(Platform)\$(ProjectName)\$(Configuration)\ + + + $(ProjectDir)zydis\msvc;$(ProjectDir)zydis\src;$(ProjectDir)zydis\dependencies\zycore\include;$(ProjectDir)zydis\include;$(VC_IncludePath);$(WindowsSDK_IncludePath) + $(SolutionDir)$(Platform)\$(ProjectName)\$(Configuration)\ + + + + NotUsing + Level3 + Disabled + ZYDIS_STATIC_DEFINE;WIN32;_DEBUG;_LIB;%(PreprocessorDefinitions) + MultiThreadedDebugDLL + /std:c++latest %(AdditionalOptions) + stdcpp17 + + + Windows + true + + + + + NotUsing + Level3 + Disabled + ZYDIS_STATIC_DEFINE;WIN32;_DEBUG;_LIB;%(PreprocessorDefinitions) + MultiThreadedDebugDLL + /std:c++latest %(AdditionalOptions) + + + Windows + true + + + + + Level3 + NotUsing + MaxSpeed + true + true + ZYDIS_STATIC_DEFINE;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions) + Speed + false + MultiThreadedDLL + true + /std:c++latest %(AdditionalOptions) + stdcpp17 + + + Windows + true + true + true + + + true + libcmt.lib;%(IgnoreSpecificDefaultLibraries) + + + + + Level3 + NotUsing + MaxSpeed + true + true + ZYDIS_STATIC_DEFINE;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions) + Speed + false + MultiThreadedDLL + true + /std:c++latest %(AdditionalOptions) + true + + + Windows + true + true + true + + + true + + + + + + + + + + + + Create + Create + Create + Create + + + + + + + \ No newline at end of file diff --git a/detours/detours/detours.vcxproj.user b/detours/detours/detours.vcxproj.user new file mode 100644 index 0000000..88a5509 --- /dev/null +++ b/detours/detours/detours.vcxproj.user @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/detours/detours/stdafx.cpp b/detours/detours/stdafx.cpp new file mode 100644 index 0000000..1577c4e --- /dev/null +++ b/detours/detours/stdafx.cpp @@ -0,0 +1 @@ +#include "stdafx.h" \ No newline at end of file diff --git a/detours/detours/stdafx.h b/detours/detours/stdafx.h new file mode 100644 index 0000000..80f96d6 --- /dev/null +++ b/detours/detours/stdafx.h @@ -0,0 +1,7 @@ +#pragma once + +#define WIN32_LEAN_AND_MEAN +#include +#include + +#include "Detours.h" \ No newline at end of file diff --git a/detours/detours/zydis/CMakeLists.txt b/detours/detours/zydis/CMakeLists.txt new file mode 100644 index 0000000..2ca5aff --- /dev/null +++ b/detours/detours/zydis/CMakeLists.txt @@ -0,0 +1,264 @@ +cmake_minimum_required(VERSION 3.1 FATAL_ERROR) +include(GenerateExportHeader) +include(GNUInstallDirs) + +project(Zydis VERSION 3.0.0.0 LANGUAGES C CXX) + +# =============================================================================================== # +# Overridable options # +# =============================================================================================== # + +# Features +option(ZYDIS_MINIMAL_MODE + "Enable minimal mode (forces ZYDIS_DECODER_MODE_MINIMAL runtime option)" + OFF) +option(ZYDIS_FEATURE_DECODER + "Enable instruction decoding functionality" + ON) +option(ZYDIS_FEATURE_FORMATTER + "Enable instruction formatting functionality" + ON) +option(ZYDIS_FEATURE_AVX512 + "Enable support for AVX-512 instructions" + ON) +option(ZYDIS_FEATURE_KNC + "Enable support for KNC instructions" + ON) + +# Build configuration +option(ZYDIS_BUILD_SHARED_LIB + "Build shared library" + OFF) +option(ZYDIS_BUILD_EXAMPLES + "Build examples" + ON) +option(ZYDIS_BUILD_TOOLS + "Build tools" + ON) +option(ZYDIS_FUZZ_AFL_FAST + "Enables AFL persistent mode and reduces prints in ZydisFuzzIn" + OFF) + +# =============================================================================================== # +# Dependencies # +# =============================================================================================== # + +if (NOT EXISTS "${CMAKE_CURRENT_LIST_DIR}/dependencies/zycore/CMakeLists.txt") + message( + FATAL_ERROR + "Can't find zycore submodule. Please make sure to clone the repo recursively.\n" + "You can fix this by running\n" + " git submodule update --init\n" + "or by cloning using\n" + " git clone --recursive " + ) +endif () + +# add_subdirectory("${CMAKE_CURRENT_LIST_DIR}/../zycore-c" "${CMAKE_BINARY_DIR}/zycore" +# EXCLUDE_FROM_ALL) +add_subdirectory("${CMAKE_CURRENT_LIST_DIR}/dependencies/zycore" EXCLUDE_FROM_ALL) + +# =============================================================================================== # +# Library configuration # +# =============================================================================================== # + +if (ZYDIS_BUILD_SHARED_LIB) + add_library("Zydis" SHARED) +else () + add_library("Zydis" STATIC) +endif () + +target_link_libraries("Zydis" PUBLIC "Zycore") +target_include_directories("Zydis" + PUBLIC "include" ${PROJECT_BINARY_DIR} + PRIVATE "src") +target_compile_definitions("Zydis" PRIVATE "_CRT_SECURE_NO_WARNINGS" "ZYDIS_EXPORTS") +zyan_set_common_flags("Zydis") +zyan_maybe_enable_wpo_for_lib("Zydis") +generate_export_header("Zydis" BASE_NAME "ZYDIS" EXPORT_FILE_NAME "ZydisExportConfig.h") + +if (ZYDIS_FEATURE_FORMATTER AND NOT ZYDIS_FEATURE_DECODER) + message( + FATAL_ERROR + "\nZYDIS_FEATURE_FORMATTER requires ZYDIS_FEATURE_DECODER to be enabled" + ) +endif () + +if (ZYDIS_MINIMAL_MODE) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_MINIMAL_MODE") +endif () +if (NOT ZYDIS_FEATURE_DECODER) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_DECODER") +endif () +if (NOT ZYDIS_FEATURE_FORMATTER) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_FORMATTER") +endif () +if (NOT ZYDIS_FEATURE_AVX512) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_AVX512") +endif () +if (NOT ZYDIS_FEATURE_KNC) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_KNC") +endif () + +target_sources("Zydis" + PRIVATE + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/MetaInfo.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Mnemonic.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Register.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/SharedTypes.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/ShortString.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Status.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Utils.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Zydis.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/SharedData.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/String.h" + "src/MetaInfo.c" + "src/Mnemonic.c" + "src/Register.c" + "src/SharedData.c" + "src/String.c" + "src/Utils.c" + "src/Zydis.c") + +if (ZYDIS_FEATURE_DECODER) + target_sources("Zydis" + PRIVATE + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Decoder.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/DecoderTypes.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/DecoderData.h" + "src/Decoder.c" + "src/DecoderData.c") + if (ZYDIS_FEATURE_FORMATTER AND (NOT ZYDIS_MINIMAL_MODE)) + target_sources("Zydis" + PRIVATE + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Formatter.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/FormatterBuffer.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/FormatterATT.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/FormatterBase.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/FormatterIntel.h" + "src/Formatter.c" + "src/FormatterBuffer.c" + "src/FormatterATT.c" + "src/FormatterBase.c" + "src/FormatterIntel.c") + endif () +endif () + +if (ZYDIS_BUILD_SHARED_LIB AND WIN32) + target_sources("Zydis" PRIVATE "resources/VersionInfo.rc") +endif () + +zyan_set_source_group("Zydis") + +# TODO: Install CMake config. +install(TARGETS "Zydis" + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) +install(FILES + "${PROJECT_BINARY_DIR}/ZydisExportConfig.h" + DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}") +install(DIRECTORY "include/" DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) + +function (_maybe_set_emscripten_cfg target) + if (EMSCRIPTEN) + # Yep, that madness below is how Emscripten likes its quotes. + set_target_properties("${target}" + PROPERTIES COMPILE_FLAGS + "-s \"EXPORT_NAME='${target}'\" -s MODULARIZE=1") + set_target_properties("${target}" + PROPERTIES LINK_FLAGS_RELEASE + "-s \"EXPORT_NAME='${target}'\" -s MODULARIZE=1") + endif () +endfunction () + +# =============================================================================================== # +# Examples # +# =============================================================================================== # + +if (ZYDIS_BUILD_EXAMPLES AND NOT ZYAN_NO_LIBC) + if (ZYDIS_FEATURE_DECODER AND ZYDIS_FEATURE_FORMATTER AND (NOT ZYDIS_MINIMAL_MODE)) + add_executable("Formatter01" "examples/Formatter01.c") + target_link_libraries("Formatter01" "Zydis") + set_target_properties("Formatter01" PROPERTIES FOLDER "Examples/Formatter") + target_compile_definitions("Formatter01" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("Formatter01") + zyan_maybe_enable_wpo("Formatter01") + _maybe_set_emscripten_cfg("Formatter01") + + add_executable("Formatter02" "examples/Formatter02.c") + target_link_libraries("Formatter02" "Zydis") + set_target_properties("Formatter02" PROPERTIES FOLDER "Examples/Formatter") + target_compile_definitions("Formatter02" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("Formatter02") + zyan_maybe_enable_wpo("Formatter02") + _maybe_set_emscripten_cfg("Formatter02") + + add_executable("Formatter03" "examples/Formatter03.c") + target_link_libraries("Formatter03" "Zydis") + set_target_properties("Formatter03" PROPERTIES FOLDER "Examples/Formatter") + target_compile_definitions("Formatter03" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("Formatter03") + zyan_maybe_enable_wpo("Formatter03") + _maybe_set_emscripten_cfg("Formatter03") + + add_executable("ZydisPerfTest" "examples/ZydisPerfTest.c") + target_link_libraries("ZydisPerfTest" "Zydis") + set_target_properties("ZydisPerfTest" PROPERTIES FOLDER "Examples") + target_compile_definitions("ZydisPerfTest" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("ZydisPerfTest") + zyan_maybe_enable_wpo("ZydisPerfTest") + _maybe_set_emscripten_cfg("ZydisPerfTest") + if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux" + OR ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD") + target_compile_definitions("ZydisPerfTest" PRIVATE "_GNU_SOURCE") + find_package(Threads REQUIRED) + target_link_libraries("ZydisPerfTest" Threads::Threads) + endif () + endif () +endif () + +# =============================================================================================== # +# Tools # +# =============================================================================================== # + +if (ZYDIS_BUILD_TOOLS AND NOT ZYAN_NO_LIBC) + if (ZYDIS_FEATURE_DECODER AND ZYDIS_FEATURE_FORMATTER AND (NOT ZYDIS_MINIMAL_MODE)) + add_executable("ZydisDisasm" "tools/ZydisDisasm.c") + target_link_libraries("ZydisDisasm" "Zydis") + set_target_properties ("ZydisDisasm" PROPERTIES FOLDER "Tools") + target_compile_definitions("ZydisDisasm" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("ZydisDisasm") + zyan_maybe_enable_wpo("ZydisDisasm") + _maybe_set_emscripten_cfg("ZydisDisasm") + install(TARGETS "ZydisDisasm" RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) + + add_executable("ZydisFuzzIn" "tools/ZydisFuzzIn.c") + target_link_libraries("ZydisFuzzIn" "Zydis") + set_target_properties("ZydisFuzzIn" PROPERTIES FOLDER "Tools") + target_compile_definitions("ZydisFuzzIn" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("ZydisFuzzIn") + zyan_maybe_enable_wpo("ZydisFuzzIn") + _maybe_set_emscripten_cfg("ZydisFuzzIn") + if (ZYDIS_FUZZ_AFL_FAST) + target_compile_definitions("ZydisFuzzIn" PRIVATE "ZYDIS_FUZZ_AFL_FAST") + endif () + + add_executable("ZydisInfo" "tools/ZydisInfo.c") + target_link_libraries("ZydisInfo" "Zydis") + set_target_properties ("ZydisInfo" PROPERTIES FOLDER "Tools") + target_compile_definitions("ZydisInfo" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("ZydisInfo") + zyan_maybe_enable_wpo("ZydisInfo") + _maybe_set_emscripten_cfg("ZydisInfo") + install(TARGETS "ZydisInfo" RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) + + #add_executable("ZydisPE" "tools/ZydisPE.c") + #target_link_libraries("ZydisPE" "Zydis") + #set_target_properties ("ZydisPE" PROPERTIES FOLDER "Tools") + #target_compile_definitions("ZydisPE" PRIVATE "_CRT_SECURE_NO_WARNINGS") + #zyan_set_common_flags("ZydisPE") + #zyan_maybe_enable_wpo("ZydisPE") + #_maybe_set_emscripten_cfg("ZydisPE") + endif () +endif () diff --git a/detours/detours/zydis/Doxyfile b/detours/detours/zydis/Doxyfile new file mode 100644 index 0000000..b1da591 --- /dev/null +++ b/detours/detours/zydis/Doxyfile @@ -0,0 +1,2470 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = Zydis + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = v3.0.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./doc + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = YES + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ./include \ + ./README.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /