From 6fa8d51479e9a5542c67bec715a1f68e7ed057ba Mon Sep 17 00:00:00 2001 From: Alexandre Bouvier Date: Sun, 20 Nov 2022 21:52:09 +0100 Subject: [PATCH] Squashed 'externals/zydis/' changes from 25193db0..1ba75aee 1ba75aee Disassembler: fix argument type `usize` -> `u64` de4cbcdb MSVC project updates (#400) e32757cd CMake: Enable `CMAKE_MSVC_RUNTIME_LIBRARY` (MSVC) 325e5e00 CI: fix Doxyfile being used 3ad3d7fc CI: inject Doxygen CSS theme a1dd0652 Doc: remove CSS theme from Zydis repository cc4f22cb Makefile: fix doc target name 83d2afa9 Update zycore to v1.4.0 53dd0880 Match parameter name for documentation 64028db9 Allow doxygen generation to be disabled 4bb3c83f Fixed ISA sets (Fixes #389) 2a9f9c66 Decoder: change error code for `NULL` `buffer` arguments 807af687 Examples: adjust to `ZydisDecoderDecodeFull` changes 71fe85a7 Tools: adjust to `ZydisDecoderDecodeFull` changes 59135031 Decoder: simplify `ZydisDecoderDecodeFull` API e5e52676 Makefile: fix `test` recipe bcb0a361 CMake: rename target `doc` -> `ZydisDoc` 3208f041 Add support for ppc(64) and riscv64 (#383) 0002161e Deps: update zycore to v1.3.0 e0fc2a92 CMake: simplify example build rules 2221bce3 README: switch decoder example to simplified version 392aa410 Examples: add `@file` comment to `Disassemble` example cff56e42 Examples: add `DisassembleSimple` 246d471b Disassemble: add function for decoding and formatting in one step 109d08ba build(make): use new doc target ebf95079 build: add doc target df277052 Fixed kernel build (WDK detection) daf7c62d Decoder: unnest all structs in `ZydisDecodedInstruction` 89cba0c2 Formatter: provide more meaningful documentation for types f8344423 Doc: remove misspelled `@brief` 6cbdb04a Doc: update `Doxyfile` config to latest version 67e15cf0 Doc: fix group references f6dfdbd2 Added `ZydisEncoderNopFill` 404e50b5 Doc: group important macros and refer to them c6141110 CI: clone doxygen theme prior to building doc 9d6c82a3 CI: add automated documentation builds f8866275 Formatter: add missing newline at end of file 2a06d5e5 Decoder: add missing `ZYAN_FALLTHROUGH` b83a3923 CI: enable development mode for all CI builds eca25034 CI: switch to an include-only way of defining the build matrix dd271e90 README: update CI badge URL 90d54ee8 Fix sign compare warnings on clang-cl e66c7010 CI: shorten name prefix 91f9d4ea CI: improved build name generation 14800b6f CI: add ClangCL build on Windows 55b23387 CI: consistently use default-init for empty vars 6c39010e CI: generalize `dev_mode` variable to `cmake_flags` 3160753d Formatter: make `operand_count` check less strict 9b9b72c9 README: include examples via permalinks adb1a85b Examples: add README encoder example to build 0897c271 Doc: switch Doxygen theme 9cb54996 Examples: add README examples to build a762cd6a README: fix example code 503e064c Fixed compiler warnings 091016bd Update workflow f29de7d8 Added tests for encoding in absolute address mode 355ce7e3 Added function to calculate and encode relative operands 73a44921 Updating ZyCore 9413c809 Doc: clarify that `user_data` can be `NULL` f0f44096 Simplify porting guide `Formatter` section 9ba7e55a Combine `ZydisFormatterTokenizeOperand` with `Ex` variant 35ea249d Combine `ZydisFormatterTokenizeInstruction` with `Ex` variant 01dddb93 Combine `ZydisFormatterFormatOperand` and `Ex` variant abcacbcb Combine `ZydisFormatterFormatInstruction` and `Ex` variant 871c40c5 Clean up `.gitignore` file a941e961 Doc: update porting guide e973b3ec MSVC: add `Segment.{h,c}` to projects dbaec910 Build: make segment API an optional feature cd508f3b Utils: split segment API into separate files 2677d5a2 Add Makefile for quick access to various operations 83eddf40 Decoder: fix name confusion (context vs state) e46660c7 Decoder: make placement of parentheses consistent cc9ff174 Fix build without `ZYDIS_FEATURE_ENCODER` 9b882913 Revert default operand-size to 32-bit for `MOVMSKPS/D` 73d7dbb3 Improved signedness data accuracy and consistency (Fixes #327) f46e3e9d Update zasm URL 2ed04d0c Decoder: add `raw.rex` to union dd6235c5 Duplicate encoding to aid Rust bindings c8b5b75d Always initialize `instruction->cpu_flags/fpu_flags` 9392f010 Extend porting guide (#338) 14453b30 Encoder: consistent constant naming (#339) 95329939 Avoid passing variable size to memcpy to prevent external call (#337) f0f0664a Encoder: improve `ZydisArePrefixesCompatible` perf (#334) 7f83c416 Improve LTO support (#333) 70085c71 Encoder: make all internal functions `static` 1581029c Change `st0` operand visibility as specified by SDM 81fae568 Update regression tests for `st0` visibility changes 6d83a277 Declare structs as anonymous within anonymous unions (#329) f146fd18 Apply consistent encodings to existing files cdbf379a Enforce consistent encoding and line endings 0cf3c960 Disable C11 feature warnings in Windows kernel example 6afe1d80 Update Zycore submodule 580cbfe6 Add unions in decoded instruction and operands e14a0789 Fix `vcpkg` install instructions 3f5a3ad8 Cleanup zydis include c0e80e79 Fixed error codes inside `ZydisDecoderDecodeFull` 770c3203 Fix incorrect register definition 0a45c474 Change default operand size for `MOVMSKPS/D` to 64-bit 91742f41 Fixed hidden operand scaling regression (Fixes #309) b44ec347 Remove LuaJIT bindings link 4f232ebf Fixed edge case for hidden operand scaling (Fixes #296) 562a7c1e Fixed newlines on Windows (amalgamation) 79c759ed Fixed signedness compilation warning (MSVC x86) 3092818a Fixed defines in MSVC projects 124571c5 Improve CMake file 69636284 Add amalgamated CI build d866d2e4 Rename STR_REGISTER -> STR_REGISTERS bd392018 Add script for creating amalgamated distributions 311fb0b4 Prevent duplicate CI builds 9770c41d Get rid of ZydisExportConfig.h cbc23017 Update zycore submodule e34e6b97 Remove register lookup special cases a5fb0d09 Fix `MASM` style disassembly (#298) 9fc98de2 Point to zasm for an assembler front-end 4756724a Ignore `.b` for `modrm.rm` encoded mask registers 198fee5d Improved prefix handling a8e43f84 Fixed `MVEX.EH` special cases ecb7e060 Reworked encoding of branching instructions (Fixes #268, Fixes #266) 38aba0fc Improve `ZydisInfo` 0d650daf Fixed decoder example 49005dd8 Add lookup tables for `ZydisRegister` and `ZydisRegisterClass` (#283) c804b8f6 Refactored operand count checks 979f0bea Update porting guide 875c8a75 Decouple operand decoding 5df1b68e Minor refactoring 66e81ebe Add WebAssembly support (#277) 33c5bccf Refactor operand constraints handling b5a92f4e Fixed constraint enforcement for AMX instructions db2c1633 Add regression tests for recent bugs (#275) 17896d72 Add a minimal mode build to CI (#274) 84dfb487 Fix register constraints of certain `AMX` instructions 4581fe30 Fixed build in minimal mode (#273) 70d6bda3 Make test scripts executable 93b503da Add encoder tests to CI (#272) 4f38dd50 Auto-generated `zydis_encoder_types.py` 69884f0e Fix constraints of certain `AMX` instructions 92dffbf2 Correctly set `is_gather` for MVEX instructions 23b499a7 Enforce MVEX constraints 7b981a6f Enforce constraints for gather instructions (Fixes https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=41044) 4f4dade2 Move fuzzing corpus out of the repository d835ac30 docs: add man pages (#267) f2429819 Update version-bump-checklist.txt 7d6ee06e Remove legacy code and general cleanup (#262) 162ef4ef Fix various warnings ocurring in pedantic mode 4189d830 Move static asserts to global scope 9fab1a82 `ZydisEncodablePrefix`/`ZydisEncoderInstructionAttribute` -> `ZYDIS_ATTRIB_*` 9f569b7c Size-optimal outputs, bug fixes, FuzzEncoder improvements, misc tooling improvements 1e8e1702 Added regression test suite for encoder 4634cc22 Update `examples/README.md` 043b2cc3 Added separate projects for fuzz targets 0faa2346 Add porting guide 248bc1fc Move instruction attributes into `SharedTypes.h` 4e0cb756 Fix attribute definitions ecb1286f Add example for rewriting instructions 606e361c Fix unaligned pointer write 3707e70f Rebase attribute flags and add `ZYDIS_ATTRIB_HAS_EVEX_B` 8a452a32 Prefer stdlib functions in example 46cd3e02 Documentation improvements fbcfc5d9 Improve encoder example and cleanup README edcac7b3 Extend example to execute the generated code 2a8eb8e2 Add simple encoding example d3b5e241 Fixed compiler warning 76fdffac Added operand masks for enhanced performance cd6a49e9 Implemented instruction encoder (Closes #129) 29bb0163 Don't pack ZydisShortString on Darwin (#259) 55dd08c2 Fix struct initialization in formatter 554efeb7 Update example code in README.md 869dfb42 Remove ZydisPE 6ae9f61b Create SECURITY.md 077b1851 Fix merge conflict 99a22d85 Fix general address-width handling ab535b1a build(cmake): add option to use system installed Zycore 746faa45 Bump version to v3.2 c3720691 Merged some definitions (TBM instructions) 12b4c46f chore: update zycore submodule 6423f083 build(cmake): add version and soversion to the library 2666f80c Update zycore submodule 4a3f25be build(cmake): fix PUBLIC include dir of installed lib c5f5bcf3 Set `ZYDIS_ATTRIB_ACCEPTS_SEGMENT` for non legacy instructions 795f555b Fix `ECX` scaling for `pcmpestri`/`vpcmpestri`/`pcmpistri`/`vpcmpistri` 3737fcbd Fixed segment override handling (Fixes #231) db796058 Fixed FP16 HV broadcasts (Fixes #243) e5764446 Fixed no_source_dest_match check (Fixes #241) 683bf85c Change branch-type from `short` -> `near` for `jkzd`/`jknzd` c462f63a Scale base register of implicit `SP`/`BP` memory operands by stack- instead of address-size e4931747 Do not sign ZydisWinKernel sample 5c193ca3 Ignore segment override for `BNDC{L|N|U}` f30efaf0 Add mission exception class strings to `ZydisInfo` 82a42657 Rebase tests e38110a4 Add missing `notrack` strings to `ZydisInfo` c95307b3 Do not drop `const` modifier 8ac69395 Fixed {sae}/{rc} formatting (Fixes #232) 80d8d523 Fixed issues with enum signedness 5503f8b0 Fuzzing: validate enum ranges 49a087f9 Fixed MVEX rounding mode decoding (Fixes #226) (#227) 60bc090a Rebase tests 4c7ec7fb Replace wrong eviction hint formatter-string 45ad14c6 Add missing register string 2613f262 Fixed Load-op SwizzUpConv(F32) (Fixes #224) 412a3c8e Add support for `no_compat_mode` flag 255513a6 Fix `T1F` handling for 16-bit elements e57da244 Fix element-size for new `QUARTER` tuple-type d36c77f2 Improve malformed `EVEX` conditions 5ec77520 Update MSVC project files 80a99de0 Fix `EVEX` map for certain `AVX-512 FP16` instructions ac3d45b4 Add `MSBuild` build to CI 1588ad23 Update and clean up CI config b622e814 Update zycore submodule 7fc3a946 Fix decoding/formatting of certain `AVX-512 FP16` instructions e6a72bbf Update copyright year 841bd7ca Update zycore submodule 61731ae2 Fix formatting of offset for `PTR` operands (should be unsigned) ad7ddc2c Add `AVX-512 FP16` isa-set (#214) 861187e2 Use lowercase `windows.h` in examples e5758caa Add multiple new ISA extensions 984e0c1d `XOP`/`VEX`/`EVEX` is invalid in 16-bit real mode 58662bf5 Fixed CET/VMX decoding in real mode (Fixes #211) 4c846ec9 Add formatter option to control printing of scale `*1` e994083e Print asterisk in front of absolute `jmp`/`call` address (AT&T) (#207) 2ab6a5cc Improve multiple instruction definitions 179441f3 Add support for `CET` `no-track` prefix (#204) e3fc6790 Ignore segment override for certain operands (#203) 68ad2460 Document xbegin special case 805a88f8 Improved handling of 16-bit relative operands (Fixes #198) cbf808a7 Removed impossible jcxz/jrcxz encodings (Fixes #196) 8080ae55 Fix cmake config files (#191) fe8f1bfd Enhanced formatting for MIB operands efd9c446 Fixes #192 (#193) 6a17c485 Update `Zycore` submodule git-subtree-dir: externals/zydis git-subtree-split: 1ba75aeefae37094c7be8eba07ff81d4fe0f1f20 --- .gitattributes | 7 +- .github/workflows/doc.yml | 57 + .github/workflows/main.yml | 107 +- .gitignore | 108 +- CMakeLists.txt | 355 +- Doxyfile | 2488 +-- Doxyfile-mcss | 7 - LICENSE | 4 +- Makefile | 39 + README.md | 109 +- SECURITY.md | 5 + assets/ZydisExportConfigSample.h | 41 - assets/ZydisFuzz_seed_corpus.zip | Bin 371379 -> 0 bytes assets/amalgamate.py | 183 + assets/porting-guide-v3-v4.md | 70 + assets/version-bump-checklist.txt | 2 + cmake/zydis-config.cmake.in | 5 + dependencies/zycore | 2 +- examples/Disassemble.c | 82 + examples/DisassembleSimple.c | 66 + examples/EncodeFromScratch.c | 132 + examples/EncodeMov.c | 66 + examples/Formatter01.c | 13 +- examples/Formatter02.c | 21 +- examples/Formatter03.c | 12 +- examples/README.md | 12 +- examples/RewriteCode.c | 173 + examples/ZydisPerfTest.c | 72 +- examples/ZydisWinKernel.c | 13 +- include/Zydis/Decoder.h | 78 +- include/Zydis/DecoderTypes.h | 1694 +- include/Zydis/Defines.h | 76 + include/Zydis/Disassembler.h | 135 + include/Zydis/Encoder.h | 460 + include/Zydis/Formatter.h | 173 +- include/Zydis/FormatterBuffer.h | 4 +- include/Zydis/Generated/EnumISAExt.h | 6 + include/Zydis/Generated/EnumISASet.h | 14 + .../Zydis/Generated/EnumInstructionCategory.h | 7 + include/Zydis/Generated/EnumMnemonic.h | 127 + include/Zydis/Generated/EnumRegister.h | 22 +- include/Zydis/Internal/DecoderData.h | 3 +- include/Zydis/Internal/EncoderData.h | 249 + include/Zydis/Internal/FormatterATT.h | 117 +- include/Zydis/Internal/FormatterBase.h | 42 +- include/Zydis/Internal/FormatterIntel.h | 228 +- include/Zydis/Internal/SharedData.h | 130 +- include/Zydis/Internal/String.h | 72 +- include/Zydis/MetaInfo.h | 4 +- include/Zydis/Mnemonic.h | 2 +- include/Zydis/Register.h | 44 + include/Zydis/Segment.h | 178 + include/Zydis/SharedTypes.h | 269 +- include/Zydis/ShortString.h | 9 +- include/Zydis/Status.h | 8 + include/Zydis/Utils.h | 164 - include/Zydis/Zydis.h | 40 +- man/ZydisDisasm.1.ronn | 51 + man/ZydisInfo.1.ronn | 57 + msvc/ZycoreExportConfig.h | 42 - msvc/Zydis.sln | 353 +- msvc/ZydisExportConfig.h | 42 - msvc/dependencies/zycore/Zycore.vcxproj | 187 +- .../zycore/Zycore.vcxproj.filters | 60 + msvc/examples/Disassemble.vcxproj | 846 + msvc/examples/Disassemble.vcxproj.filters | 119 + msvc/examples/DisassembleSimple.vcxproj | 846 + .../DisassembleSimple.vcxproj.filters | 119 + msvc/examples/EncodeFromScratch.vcxproj | 846 + .../EncodeFromScratch.vcxproj.filters | 119 + .../EncodeMov.vcxproj} | 100 +- msvc/examples/EncodeMov.vcxproj.filters | 119 + msvc/examples/Formatter01.vcxproj | 94 +- msvc/examples/Formatter01.vcxproj.filters | 30 +- msvc/examples/Formatter02.vcxproj | 94 +- msvc/examples/Formatter02.vcxproj.filters | 30 +- msvc/examples/Formatter03.vcxproj | 94 +- msvc/examples/Formatter03.vcxproj.filters | 30 +- msvc/examples/RewriteCode.vcxproj | 846 + msvc/examples/RewriteCode.vcxproj.filters | 119 + msvc/examples/ZydisPerfTest.vcxproj | 94 +- msvc/examples/ZydisPerfTest.vcxproj.filters | 30 +- msvc/examples/ZydisWinKernel.vcxproj | 72 +- msvc/examples/ZydisWinKernel.vcxproj.filters | 30 +- msvc/tools/ZydisDisasm.vcxproj | 94 +- msvc/tools/ZydisDisasm.vcxproj.filters | 36 +- msvc/tools/ZydisFuzzDecoder.vcxproj | 848 + ...lters => ZydisFuzzDecoder.vcxproj.filters} | 38 +- msvc/tools/ZydisFuzzEncoder.vcxproj | 848 + msvc/tools/ZydisFuzzEncoder.vcxproj.filters | 125 + msvc/tools/ZydisFuzzReEncoding.vcxproj | 848 + .../tools/ZydisFuzzReEncoding.vcxproj.filters | 125 + msvc/tools/ZydisInfo.vcxproj | 94 +- msvc/tools/ZydisInfo.vcxproj.filters | 30 +- msvc/tools/ZydisTestEncoderAbsolute.vcxproj | 847 + .../ZydisTestEncoderAbsolute.vcxproj.filters | 125 + msvc/zydis/Zydis.vcxproj | 246 +- msvc/zydis/Zydis.vcxproj.filters | 63 +- resources/VersionInfo.rc | Bin 4504 -> 4504 bytes src/Decoder.c | 2371 +-- src/DecoderData.c | 2 +- src/Disassembler.c | 105 + src/Encoder.c | 4742 +++++ src/EncoderData.c | 43 + src/Formatter.c | 154 +- src/FormatterATT.c | 87 +- src/FormatterBase.c | 103 +- src/FormatterIntel.c | 61 +- src/Generated/AccessedFlags.inc | 147 +- src/Generated/DecoderTables.inc | 11108 ++++++------ src/Generated/EncodableInstructions.inc | 11552 ------------ src/Generated/EncoderTables.inc | 9465 ++++++++++ src/Generated/EnumISAExt.inc | 6 + src/Generated/EnumISASet.inc | 14 + src/Generated/EnumInstructionCategory.inc | 7 + src/Generated/EnumMnemonic.inc | 127 + src/Generated/EnumRegister.inc | 6 +- src/Generated/FormatterStrings.inc | 128 +- src/Generated/GetRelInfo.inc | 58 + src/Generated/InstructionDefinitions.inc | 15040 ++++++++-------- src/Generated/InstructionEncodings.inc | 4 +- src/Generated/OperandDefinitions.inc | 14656 ++++++++------- src/Generated/RegisterClassLookup.inc | 23 + src/Generated/RegisterLookup.inc | 269 + src/MetaInfo.c | 1 + src/Register.c | 254 +- src/Segment.c | 182 + src/SharedData.c | 15 +- src/String.c | 738 +- src/Utils.c | 209 +- src/Zydis.c | 13 + tests/binary_reader.py | 53 + tests/binary_writer.py | 46 + tests/cases/3dnow_000.out | 3 +- tests/cases/3dnow_001.out | 3 +- tests/cases/3dnow_002.out | 3 +- tests/cases/3dnow_003.out | 1 + tests/cases/3dnow_004.out | 3 +- tests/cases/3dnow_005.out | 1 + tests/cases/3dnow_006.out | 1 + tests/cases/3dnow_007.out | 1 + tests/cases/3dnow_008.out | 3 +- tests/cases/3dnow_009.out | 1 + tests/cases/3dnow_010.out | 3 +- tests/cases/3dnow_011.out | 3 +- tests/cases/3dnow_012.out | 3 +- tests/cases/3dnow_013.out | 3 +- tests/cases/3dnow_014.out | 3 +- tests/cases/3dnow_015.out | 3 +- tests/cases/3dnow_016.out | 3 +- tests/cases/3dnow_017.out | 3 +- tests/cases/3dnow_018.out | 3 +- tests/cases/3dnow_019.out | 3 +- tests/cases/3dnow_020.out | 3 +- tests/cases/3dnow_021.out | 3 +- tests/cases/3dnow_022.out | 1 + tests/cases/3dnow_023.out | 3 +- tests/cases/3dnow_024.out | 3 +- tests/cases/default_000.out | 4 +- tests/cases/default_001.out | 2 +- tests/cases/default_002.out | 2 +- tests/cases/default_003.out | 7 +- tests/cases/default_004.out | 2 +- tests/cases/default_005.out | 1 + tests/cases/default_006.out | 3 +- tests/cases/default_007.out | 2 +- tests/cases/default_008.out | 2 +- tests/cases/default_009.out | 2 +- tests/cases/default_010.out | 1 + tests/cases/default_011.out | 2 +- tests/cases/default_012.out | 5 +- tests/cases/default_013.out | 2 +- tests/cases/default_014.out | 4 +- tests/cases/default_015.out | 16 +- tests/cases/default_016.out | 1 + tests/cases/default_017.out | 2 +- tests/cases/default_018.out | 2 +- tests/cases/default_019.out | 3 +- tests/cases/default_020.out | 2 +- tests/cases/default_021.out | 5 +- tests/cases/default_022.out | 2 +- tests/cases/default_023.out | 1 + tests/cases/default_024.out | 2 +- tests/cases/default_025.in | 1 + tests/cases/default_025.out | 37 + tests/cases/default_026.in | 1 + tests/cases/default_026.out | 37 + tests/cases/default_027.in | 1 + tests/cases/default_027.out | 37 + tests/cases/default_028.in | 1 + tests/cases/default_028.out | 37 + tests/cases/default_029.in | 1 + tests/cases/default_029.out | 38 + tests/cases/default_030.in | 1 + tests/cases/default_030.out | 38 + tests/cases/default_031.in | 1 + tests/cases/default_031.out | 39 + tests/cases/default_032.in | 1 + tests/cases/default_032.out | 39 + tests/cases/default_033.in | 1 + tests/cases/default_033.out | 38 + tests/cases/default_034.in | 1 + tests/cases/default_034.out | 38 + tests/cases/default_035.in | 1 + tests/cases/default_035.out | 39 + tests/cases/default_036.in | 1 + tests/cases/default_036.out | 39 + tests/cases/default_037.in | 1 + tests/cases/default_037.out | 35 + tests/cases/default_038.in | 1 + tests/cases/default_038.out | 45 + tests/cases/default_039.in | 1 + tests/cases/default_039.out | 45 + tests/cases/default_040.in | 1 + tests/cases/default_040.out | 45 + tests/cases/default_041.in | 1 + tests/cases/default_041.out | 45 + tests/cases/default_042.in | 1 + tests/cases/default_042.out | 45 + tests/cases/default_043.in | 1 + tests/cases/default_043.out | 45 + tests/cases/default_044.in | 1 + tests/cases/default_044.out | 45 + tests/cases/default_045.in | 1 + tests/cases/default_045.out | 45 + tests/cases/default_046.in | 1 + tests/cases/default_046.out | 45 + tests/cases/default_047.in | 1 + tests/cases/default_047.out | 45 + tests/cases/default_048.in | 1 + tests/cases/default_048.out | 39 + tests/cases/evex_000.out | 3 +- tests/cases/evex_001.out | 3 +- tests/cases/evex_002.out | 9 +- tests/cases/evex_003.out | 3 +- tests/cases/evex_004.out | 3 +- tests/cases/evex_005.out | 1 + tests/cases/evex_006.out | 3 +- tests/cases/evex_007.out | 3 +- tests/cases/evex_008.out | 9 +- tests/cases/evex_009.out | 1 + tests/cases/evex_010.out | 3 +- tests/cases/evex_011.out | 3 +- tests/cases/evex_012.out | 3 +- tests/cases/evex_013.out | 7 +- tests/cases/evex_014.out | 1 + tests/cases/evex_015.out | 3 +- tests/cases/evex_016.out | 7 +- tests/cases/evex_017.out | 5 +- tests/cases/evex_018.out | 1 + tests/cases/evex_019.out | 3 +- tests/cases/evex_020.out | 3 +- tests/cases/evex_021.out | 1 + tests/cases/evex_022.out | 3 +- tests/cases/evex_023.out | 1 + tests/cases/evex_024.out | 3 +- tests/cases/evex_025.in | 1 + tests/cases/evex_025.out | 46 + tests/cases/evex_026.in | 1 + tests/cases/evex_026.out | 44 + tests/cases/evex_027.in | 1 + tests/cases/evex_027.out | 48 + tests/cases/evex_028.in | 1 + tests/cases/evex_028.out | 47 + tests/cases/jmp_far_16.in | 1 + tests/cases/jmp_far_16.out | 42 + tests/cases/jmp_far_32.in | 1 + tests/cases/jmp_far_32.out | 41 + tests/cases/mvex_000.out | 7 +- tests/cases/mvex_001.out | 3 +- tests/cases/mvex_002.out | 3 +- tests/cases/mvex_003.out | 1 + tests/cases/mvex_004.out | 11 +- tests/cases/mvex_005.out | 11 +- tests/cases/mvex_006.out | 1 + tests/cases/mvex_007.out | 11 +- tests/cases/mvex_008.out | 3 +- tests/cases/mvex_009.out | 3 +- tests/cases/mvex_010.out | 3 +- tests/cases/mvex_011.out | 3 +- tests/cases/mvex_012.out | 3 +- tests/cases/mvex_013.out | 3 +- tests/cases/mvex_014.out | 1 + tests/cases/mvex_015.out | 1 + tests/cases/mvex_016.out | 11 +- tests/cases/mvex_017.out | 3 +- tests/cases/mvex_018.out | 3 +- tests/cases/mvex_019.out | 1 + tests/cases/mvex_020.out | 11 +- tests/cases/mvex_021.out | 3 +- tests/cases/mvex_022.out | 1 + tests/cases/mvex_023.out | 11 +- tests/cases/mvex_024.out | 1 + tests/cases/mvex_025.in | 1 + tests/cases/mvex_025.out | 0 tests/cases/mvex_026.in | 1 + tests/cases/mvex_026.out | 45 + tests/cases/vexc4_000.out | 3 +- tests/cases/vexc4_001.out | 3 +- tests/cases/vexc4_002.out | 3 +- tests/cases/vexc4_003.out | 3 +- tests/cases/vexc4_004.out | 3 +- tests/cases/vexc4_005.out | 3 +- tests/cases/vexc4_006.out | 3 +- tests/cases/vexc4_007.out | 3 +- tests/cases/vexc4_008.out | 3 +- tests/cases/vexc4_009.out | 3 +- tests/cases/vexc4_010.out | 3 +- tests/cases/vexc4_011.out | 3 +- tests/cases/vexc4_012.out | 3 +- tests/cases/vexc4_013.out | 3 +- tests/cases/vexc4_014.out | 3 +- tests/cases/vexc4_015.out | 3 +- tests/cases/vexc4_016.out | 1 + tests/cases/vexc4_017.out | 3 +- tests/cases/vexc4_018.out | 1 + tests/cases/vexc4_019.out | 3 +- tests/cases/vexc4_020.out | 1 + tests/cases/vexc4_021.out | 3 +- tests/cases/vexc4_022.out | 1 + tests/cases/vexc4_023.out | 1 + tests/cases/vexc4_024.out | 1 + tests/cases/vexc4_025.in | 1 + tests/cases/vexc4_025.out | 38 + tests/cases/vexc4_026.in | 1 + tests/cases/vexc4_026.out | 0 tests/cases/vexc4_027.in | 1 + tests/cases/vexc4_027.out | 0 tests/cases/vexc5_000.out | 1 + tests/cases/vexc5_001.out | 1 + tests/cases/vexc5_002.out | 1 + tests/cases/vexc5_003.out | 3 +- tests/cases/vexc5_004.out | 3 +- tests/cases/vexc5_005.out | 3 +- tests/cases/vexc5_006.out | 3 +- tests/cases/vexc5_007.out | 3 +- tests/cases/vexc5_008.out | 3 +- tests/cases/vexc5_009.out | 3 +- tests/cases/vexc5_010.out | 3 +- tests/cases/vexc5_011.out | 3 +- tests/cases/vexc5_012.out | 3 +- tests/cases/vexc5_013.out | 3 +- tests/cases/vexc5_014.out | 3 +- tests/cases/vexc5_015.out | 3 +- tests/cases/vexc5_016.out | 3 +- tests/cases/vexc5_017.out | 3 +- tests/cases/vexc5_018.out | 1 + tests/cases/vexc5_019.out | 3 +- tests/cases/vexc5_020.out | 3 +- tests/cases/vexc5_021.out | 3 +- tests/cases/vexc5_022.out | 1 + tests/cases/vexc5_023.out | 3 +- tests/cases/vexc5_024.out | 3 +- tests/cases/xop_000.out | 3 +- tests/cases/xop_001.out | 3 +- tests/cases/xop_002.out | 3 +- tests/cases/xop_003.out | 1 + tests/cases/xop_004.out | 3 +- tests/cases/xop_005.out | 3 +- tests/cases/xop_006.out | 3 +- tests/cases/xop_007.out | 1 + tests/cases/xop_008.out | 3 +- tests/cases/xop_009.out | 3 +- tests/cases/xop_010.out | 1 + tests/cases/xop_011.out | 3 +- tests/cases/xop_012.out | 3 +- tests/cases/xop_013.out | 3 +- tests/cases/xop_014.out | 3 +- tests/cases/xop_015.out | 3 +- tests/cases/xop_016.out | 3 +- tests/cases/xop_017.out | 3 +- tests/cases/xop_018.out | 3 +- tests/cases/xop_019.out | 1 + tests/cases/xop_020.out | 3 +- tests/cases/xop_021.out | 3 +- tests/cases/xop_022.out | 1 + tests/cases/xop_023.out | 3 +- tests/cases/xop_024.out | 3 +- tests/crash_tool.py | 309 + tests/enc_test_cases.json | 2107 +++ tests/re_enc_test_cases.json | 710 + tests/regression.py | 18 +- tests/regression_encoder.py | 52 + tests/zydis_encoder_types.py | 2230 +++ tools/ZydisDisasm.c | 20 +- tools/{ZydisFuzzIn.c => ZydisFuzzDecoder.c} | 181 +- tools/ZydisFuzzEncoder.c | 307 + tools/ZydisFuzzReEncoding.c | 89 + tools/ZydisFuzzShared.c | 483 + tools/ZydisFuzzShared.h | 91 + tools/ZydisInfo.c | 480 +- tools/ZydisPE.c | 1188 -- tools/ZydisTestEncoderAbsolute.c | 462 + 393 files changed, 61406 insertions(+), 39449 deletions(-) create mode 100644 .github/workflows/doc.yml delete mode 100644 Doxyfile-mcss create mode 100644 Makefile create mode 100644 SECURITY.md delete mode 100644 assets/ZydisExportConfigSample.h delete mode 100644 assets/ZydisFuzz_seed_corpus.zip create mode 100755 assets/amalgamate.py create mode 100644 assets/porting-guide-v3-v4.md create mode 100644 examples/Disassemble.c create mode 100644 examples/DisassembleSimple.c create mode 100644 examples/EncodeFromScratch.c create mode 100644 examples/EncodeMov.c create mode 100644 examples/RewriteCode.c create mode 100644 include/Zydis/Defines.h create mode 100644 include/Zydis/Disassembler.h create mode 100644 include/Zydis/Encoder.h create mode 100644 include/Zydis/Internal/EncoderData.h create mode 100644 include/Zydis/Segment.h create mode 100644 man/ZydisDisasm.1.ronn create mode 100644 man/ZydisInfo.1.ronn delete mode 100644 msvc/ZycoreExportConfig.h delete mode 100644 msvc/ZydisExportConfig.h create mode 100644 msvc/examples/Disassemble.vcxproj create mode 100644 msvc/examples/Disassemble.vcxproj.filters create mode 100644 msvc/examples/DisassembleSimple.vcxproj create mode 100644 msvc/examples/DisassembleSimple.vcxproj.filters create mode 100644 msvc/examples/EncodeFromScratch.vcxproj create mode 100644 msvc/examples/EncodeFromScratch.vcxproj.filters rename msvc/{tools/ZydisFuzzIn.vcxproj => examples/EncodeMov.vcxproj} (88%) create mode 100644 msvc/examples/EncodeMov.vcxproj.filters create mode 100644 msvc/examples/RewriteCode.vcxproj create mode 100644 msvc/examples/RewriteCode.vcxproj.filters create mode 100644 msvc/tools/ZydisFuzzDecoder.vcxproj rename msvc/tools/{ZydisFuzzIn.vcxproj.filters => ZydisFuzzDecoder.vcxproj.filters} (74%) create mode 100644 msvc/tools/ZydisFuzzEncoder.vcxproj create mode 100644 msvc/tools/ZydisFuzzEncoder.vcxproj.filters create mode 100644 msvc/tools/ZydisFuzzReEncoding.vcxproj create mode 100644 msvc/tools/ZydisFuzzReEncoding.vcxproj.filters create mode 100644 msvc/tools/ZydisTestEncoderAbsolute.vcxproj create mode 100644 msvc/tools/ZydisTestEncoderAbsolute.vcxproj.filters create mode 100644 src/Disassembler.c create mode 100644 src/Encoder.c create mode 100644 src/EncoderData.c delete mode 100644 src/Generated/EncodableInstructions.inc create mode 100644 src/Generated/EncoderTables.inc create mode 100644 src/Generated/GetRelInfo.inc create mode 100644 src/Generated/RegisterClassLookup.inc create mode 100644 src/Generated/RegisterLookup.inc create mode 100644 src/Segment.c create mode 100644 tests/binary_reader.py create mode 100644 tests/binary_writer.py create mode 100644 tests/cases/default_025.in create mode 100644 tests/cases/default_025.out create mode 100644 tests/cases/default_026.in create mode 100644 tests/cases/default_026.out create mode 100644 tests/cases/default_027.in create mode 100644 tests/cases/default_027.out create mode 100644 tests/cases/default_028.in create mode 100644 tests/cases/default_028.out create mode 100644 tests/cases/default_029.in create mode 100644 tests/cases/default_029.out create mode 100644 tests/cases/default_030.in create mode 100644 tests/cases/default_030.out create mode 100644 tests/cases/default_031.in create mode 100644 tests/cases/default_031.out create mode 100644 tests/cases/default_032.in create mode 100644 tests/cases/default_032.out create mode 100644 tests/cases/default_033.in create mode 100644 tests/cases/default_033.out create mode 100644 tests/cases/default_034.in create mode 100644 tests/cases/default_034.out create mode 100644 tests/cases/default_035.in create mode 100644 tests/cases/default_035.out create mode 100644 tests/cases/default_036.in create mode 100644 tests/cases/default_036.out create mode 100644 tests/cases/default_037.in create mode 100644 tests/cases/default_037.out create mode 100644 tests/cases/default_038.in create mode 100644 tests/cases/default_038.out create mode 100644 tests/cases/default_039.in create mode 100644 tests/cases/default_039.out create mode 100644 tests/cases/default_040.in create mode 100644 tests/cases/default_040.out create mode 100644 tests/cases/default_041.in create mode 100644 tests/cases/default_041.out create mode 100644 tests/cases/default_042.in create mode 100644 tests/cases/default_042.out create mode 100644 tests/cases/default_043.in create mode 100644 tests/cases/default_043.out create mode 100644 tests/cases/default_044.in create mode 100644 tests/cases/default_044.out create mode 100644 tests/cases/default_045.in create mode 100644 tests/cases/default_045.out create mode 100644 tests/cases/default_046.in create mode 100644 tests/cases/default_046.out create mode 100644 tests/cases/default_047.in create mode 100644 tests/cases/default_047.out create mode 100644 tests/cases/default_048.in create mode 100644 tests/cases/default_048.out create mode 100644 tests/cases/evex_025.in create mode 100644 tests/cases/evex_025.out create mode 100644 tests/cases/evex_026.in create mode 100644 tests/cases/evex_026.out create mode 100644 tests/cases/evex_027.in create mode 100644 tests/cases/evex_027.out create mode 100644 tests/cases/evex_028.in create mode 100644 tests/cases/evex_028.out create mode 100644 tests/cases/jmp_far_16.in create mode 100644 tests/cases/jmp_far_16.out create mode 100644 tests/cases/jmp_far_32.in create mode 100644 tests/cases/jmp_far_32.out create mode 100644 tests/cases/mvex_025.in create mode 100644 tests/cases/mvex_025.out create mode 100644 tests/cases/mvex_026.in create mode 100644 tests/cases/mvex_026.out create mode 100644 tests/cases/vexc4_025.in create mode 100644 tests/cases/vexc4_025.out create mode 100644 tests/cases/vexc4_026.in create mode 100644 tests/cases/vexc4_026.out create mode 100644 tests/cases/vexc4_027.in create mode 100644 tests/cases/vexc4_027.out create mode 100644 tests/crash_tool.py create mode 100644 tests/enc_test_cases.json create mode 100644 tests/re_enc_test_cases.json mode change 100644 => 100755 tests/regression.py create mode 100755 tests/regression_encoder.py create mode 100644 tests/zydis_encoder_types.py rename tools/{ZydisFuzzIn.c => ZydisFuzzDecoder.c} (59%) create mode 100644 tools/ZydisFuzzEncoder.c create mode 100644 tools/ZydisFuzzReEncoding.c create mode 100644 tools/ZydisFuzzShared.c create mode 100644 tools/ZydisFuzzShared.h delete mode 100644 tools/ZydisPE.c create mode 100644 tools/ZydisTestEncoderAbsolute.c diff --git a/.gitattributes b/.gitattributes index ef3a96fa..b1753e54 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,6 @@ -*.inc linguist-language=C +*.inc eol=lf encoding=utf-8 linguist-language=C +*.h eof=lf encoding=utf-8 +*.c eof=lf encoding=utf-8 +*.py eof=lf encoding=utf-8 +*.md eof=lf encoding=utf-8 + diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 00000000..059d0068 --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,57 @@ +name: Doc + +on: + push: + branches: + - master + release: + types: [published] + +jobs: + build-and-publish-doc: + name: Build and publish documentation + runs-on: ubuntu-22.04 + + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + submodules: recursive + fetch-depth: 0 # fetch all branches and tags + - name: Install doxygen + run: | + sudo apt-get install -y doxygen + - name: Download & install zydoc + run: | + wget -O zydoc.tar.gz https://github.com/zyantific/zydoc/releases/download/v0.3.2/zydoc_v0.3.2_x86_64-unknown-linux-musl.tar.gz + tar xfv zydoc.tar.gz + mv zydoc /usr/local/bin + - name: Clone Doxygen theme + run: >- + git clone + --depth=1 --branch=v2.1.0 + https://github.com/jothepro/doxygen-awesome-css.git + /tmp/doxy-theme + - name: Generate documentation + run: >- + zydoc + --repo . + --output-dir doc.zydis.re + --config-ref master + --doxyfile ./Doxyfile + --refs 'refs/heads/master' + --refs 'refs/tags/.*' + --exclude-refs 'refs/tags/v1.*' + --extra-css /tmp/doxy-theme/doxygen-awesome.css + --extra-css /tmp/doxy-theme/doxygen-awesome-sidebar-only.css + - name: Publish documentation + uses: cpina/github-action-push-to-another-repository@v1.5 + env: + SSH_DEPLOY_KEY: ${{ secrets.DOCS_ZYDIS_RE_SSH_DEPLOY_KEY }} + with: + source-directory: 'doc.zydis.re' + destination-github-username: 'zyantific' + destination-repository-name: 'doc.zydis.re' + user-name: zydis-doc-bot + user-email: doc-bot@zydis.re + target-branch: main diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 080e1214..5f801106 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,47 +1,106 @@ -name: GitHub Actions CI +name: CI -on: [push, pull_request] +on: + pull_request: + push: + branches: + - master jobs: - build: - name: "Build Zydis (${{ matrix.image_name }}, ${{ matrix.no_libc }})" - runs-on: "${{ matrix.image_name }}" + cmake-build-and-tests: + name: >- + CMake build + tests (${{ matrix.image_name }} ${{ matrix.cmake_flags }}) + runs-on: ${{ matrix.image_name }} strategy: + fail-fast: false matrix: - image_name: ["macOS-latest", "windows-2016", "ubuntu-18.04"] - no_libc: ["", "-DZYAN_NO_LIBC=ON"] include: - - image_name: "ubuntu-16.04" - no_libc: "-DCMAKE_BUILD_TYPE=Release" - dev_mode: "-DZYAN_DEV_MODE=ON" + # Do a regular and a no-libc build for each platform. + - image_name: macOS-latest + - image_name: macOS-latest + cmake_flags: -DZYAN_NO_LIBC=ON + skip_tests: yes + - image_name: windows-2022 + - image_name: windows-2022 + cmake_flags: -DZYAN_NO_LIBC=ON + skip_tests: yes + - image_name: ubuntu-22.04 + - image_name: ubuntu-22.04 + cmake_flags: -DZYAN_NO_LIBC=ON + skip_tests: yes + + # Do a few more specialized configurations. + - image_name: ubuntu-22.04 + cmake_flags: -DZYDIS_MINIMAL_MODE=ON -DZYDIS_FEATURE_ENCODER=OFF + skip_tests: yes + - image_name: windows-2022 + cmake_flags: -TClangCL steps: - - uses: "actions/checkout@v1" - - name: "Cloning submodules" - run: | - git submodule update --init - - name: "Configuring" + - name: Checkout + uses: actions/checkout@v2 + with: { submodules: recursive } + - name: Configuring run: | mkdir build cd build - cmake ${{ matrix.dev_mode }} ${{ matrix.no_libc }} .. - - name: "Building" + cmake -DZYAN_DEV_MODE=ON ${{ matrix.cmake_flags }} .. + - name: Building run: | cmake --build build --config Release - - name: "Running regression tests" + - name: Running regression tests (decoder) run: | cd tests python3 regression.py test ../build/ZydisInfo - if: "!matrix.no_libc && matrix.image_name != 'windows-2016'" - - name: "Running regression tests" + if: "matrix.image_name != 'windows-2022' && !matrix.skip_tests" + - name: Running regression tests (encoder) + run: | + cd tests + python3 regression_encoder.py ../build/ZydisFuzzReEncoding ../build/ZydisFuzzEncoder ../build/ZydisTestEncoderAbsolute + if: "matrix.image_name != 'windows-2022' && !matrix.skip_tests" + - name: Running regression tests run: | cd tests python regression.py test ..\\build\\Release\\ZydisInfo.exe - if: "!matrix.no_libc && matrix.image_name == 'windows-2016'" + if: "matrix.image_name == 'windows-2022' && !matrix.skip_tests" + + msbuild-build: + name: MSBuild build (windows-2022) + runs-on: windows-2022 + steps: + - name: Checkout + uses: actions/checkout@v2 + with: { submodules: recursive } + - name: Add msbuild to PATH + uses: microsoft/setup-msbuild@v1.1.3 + with: { vs-version: '[17,]' } + - name: Build user-mode + run: | + cd msvc + msbuild.exe Zydis.sln /m /t:Rebuild '/p:Configuration="Release MD";Platform=X64' + - name: Build kernel-mode + run: | + cd msvc + msbuild.exe Zydis.sln /m /t:Rebuild '/p:Configuration="Release Kernel";Platform=X64' + + amalgamated: + name: Amalgamated build (Ubuntu 22.04) + runs-on: ubuntu-22.04 + steps: + - name: Checkout + uses: actions/checkout@v2 + with: { submodules: recursive } + - name: Amalgamating sources + run: | + ./assets/amalgamate.py + - name: Compiling library + run: | + cd amalgamated-dist + gcc -shared -I. -fPIC -olibzydis.so Zydis.c fuzzing: - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 strategy: fail-fast: false matrix: @@ -51,13 +110,13 @@ jobs: id: build uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master with: - oss-fuzz-project-name: 'zydis' + oss-fuzz-project-name: zydis dry-run: false sanitizer: ${{ matrix.sanitizer }} - name: Run Fuzzers (${{ matrix.sanitizer }}) uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master with: - oss-fuzz-project-name: 'zydis' + oss-fuzz-project-name: zydis fuzz-seconds: 600 dry-run: false sanitizer: ${{ matrix.sanitizer }} diff --git a/.gitignore b/.gitignore index 7e1b0d73..bda3a049 100644 --- a/.gitignore +++ b/.gitignore @@ -1,101 +1,13 @@ -# Created by https://www.gitignore.io/api/c,c++,cmake - -### C ### -# Object files -*.o -*.ko -*.obj -*.elf - -# Precompiled Headers -*.gch -*.pch - -# Libraries -*.lib -*.a -*.la -*.lo - -# Shared objects (inc. Windows DLLs) -*.dll -*.so -*.so.* -*.dylib - -# Executables -*.exe -*.out -*.app -*.i*86 -*.x86_64 -*.hex - -# Debug files -*.dSYM/ -*.su - - -### C++ ### -# Compiled Object files -*.slo -*.lo -*.o -*.obj - -# Precompiled Headers -*.gch -*.pch - -# Compiled Dynamic libraries -*.so -*.dylib -*.dll - -# Fortran module files -*.mod - -# Compiled Static libraries -*.lai -*.la -*.a -*.lib - -# Executables -*.exe -*.out -*.app - - -### CMake ### -CMakeCache.txt -CMakeFiles -CMakeScripts -Makefile -cmake_install.cmake -install_manifest.txt -CTestTestfile.cmake - - -# MacOS .DS_Store - -build* - -# MSVC -.vs -*.vcxproj.user -*.suo -*.sdf -*.opensdf -*.VC.db -*.VC.opendb -msvc/**/*.user -msvc/**/obj/ -msvc/**/bin/ - -doc/html - .vscode .idea -cmake-build-debug \ No newline at end of file +.vs +__pycache__ + +/build* +/msvc/**/*.user +/msvc/**/obj/ +/msvc/**/bin/ +/doc +/cmake-build-debug +/amalgamated-dist diff --git a/CMakeLists.txt b/CMakeLists.txt index 4bacb5d8..5e812fbd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,8 +1,12 @@ -cmake_minimum_required(VERSION 3.1 FATAL_ERROR) +cmake_minimum_required(VERSION 3.9 FATAL_ERROR) -project(Zydis VERSION 3.1.0.0 LANGUAGES C CXX) +if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.15") + # Enable runtime library selection via CMAKE_MSVC_RUNTIME_LIBRARY + cmake_policy(SET CMP0091 NEW) +endif () + +project(Zydis VERSION 4.0.0.0 LANGUAGES C CXX) -include(GenerateExportHeader) include(GNUInstallDirs) include(CMakePackageConfigHelpers) @@ -17,6 +21,9 @@ option(ZYDIS_MINIMAL_MODE option(ZYDIS_FEATURE_DECODER "Enable instruction decoding functionality" ON) +option(ZYDIS_FEATURE_ENCODER + "Enable instruction encoding functionality" + ON) option(ZYDIS_FEATURE_FORMATTER "Enable instruction formatting functionality" ON) @@ -26,6 +33,9 @@ option(ZYDIS_FEATURE_AVX512 option(ZYDIS_FEATURE_KNC "Enable support for KNC instructions" ON) +option(ZYDIS_FEATURE_SEGMENT + "Enable instruction segment API" + ON) # Build configuration option(ZYDIS_BUILD_SHARED_LIB @@ -37,13 +47,24 @@ option(ZYDIS_BUILD_EXAMPLES option(ZYDIS_BUILD_TOOLS "Build tools" ON) +option(ZYDIS_BUILD_MAN + "Build manpages for the tools (requires Ronn-NG)" + OFF) +option(ZYDIS_BUILD_DOXYGEN + "Build doxygen documentation (requires Doxygen)" + ON) option(ZYDIS_FUZZ_AFL_FAST "Enables AFL persistent mode and reduces prints in ZydisFuzzIn" OFF) option(ZYDIS_LIBFUZZER "Enables LLVM libfuzzer mode and reduces prints in ZydisFuzzIn" OFF) -set(ZYDIS_ZYCORE_PATH + +# Dependencies +option(ZYAN_SYSTEM_ZYCORE + "Use system Zycore library" + OFF) +set(ZYAN_ZYCORE_PATH "${CMAKE_CURRENT_LIST_DIR}/dependencies/zycore" CACHE PATH @@ -53,32 +74,36 @@ set(ZYDIS_ZYCORE_PATH # Dependencies # # =============================================================================================== # -# Try to initialize the Zycore submodule using Git -if (NOT EXISTS "${ZYDIS_ZYCORE_PATH}/CMakeLists.txt" AND - "${ZYDIS_ZYCORE_PATH}" STREQUAL "${CMAKE_CURRENT_LIST_DIR}/dependencies/zycore") - find_package(Git QUIET) - if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git") - execute_process( - COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} +if (ZYAN_SYSTEM_ZYCORE) + find_package(Zycore) +else () + # Try to initialize the Zycore submodule using Git + if (NOT EXISTS "${ZYAN_ZYCORE_PATH}/CMakeLists.txt" AND + "${ZYAN_ZYCORE_PATH}" STREQUAL "${CMAKE_CURRENT_LIST_DIR}/dependencies/zycore") + find_package(Git QUIET) + if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git") + execute_process( + COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + ) + endif() + endif () + + if (NOT EXISTS "${ZYAN_ZYCORE_PATH}/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 \n" + "Alternatively, you can manually clone zycore to some path and set ZYDIS_ZYCORE_PATH." ) - endif() -endif () + endif () -if (NOT EXISTS "${ZYDIS_ZYCORE_PATH}/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 \n" - "Alternatively, you can manually clone zycore to some path and set ZYDIS_ZYCORE_PATH." - ) + add_subdirectory(${ZYAN_ZYCORE_PATH} "zycore" EXCLUDE_FROM_ALL) endif () -add_subdirectory(${ZYDIS_ZYCORE_PATH} "zycore" EXCLUDE_FROM_ALL) - # =============================================================================================== # # Library configuration # # =============================================================================================== # @@ -87,16 +112,23 @@ if (ZYDIS_BUILD_SHARED_LIB) add_library("Zydis" SHARED) else () add_library("Zydis" STATIC) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_STATIC_BUILD") endif () target_link_libraries("Zydis" PUBLIC "Zycore") target_include_directories("Zydis" - PUBLIC "include" ${PROJECT_BINARY_DIR} + PUBLIC + $ + $ + $ PRIVATE "src") -target_compile_definitions("Zydis" PRIVATE "_CRT_SECURE_NO_WARNINGS" "ZYDIS_EXPORTS") +target_compile_definitions("Zydis" PRIVATE "_CRT_SECURE_NO_WARNINGS") +set_target_properties("Zydis" PROPERTIES + VERSION "${Zydis_VERSION}" + SOVERSION "${Zydis_VERSION_MAJOR}.${Zydis_VERSION_MINOR}" + DEFINE_SYMBOL "ZYDIS_SHOULD_EXPORT") zyan_set_common_flags("Zydis") -zyan_maybe_enable_wpo_for_lib("Zydis") -generate_export_header("Zydis" BASE_NAME "ZYDIS" EXPORT_FILE_NAME "ZydisExportConfig.h") +zyan_maybe_enable_wpo("Zydis") if (ZYDIS_FEATURE_FORMATTER AND NOT ZYDIS_FEATURE_DECODER) message( @@ -105,12 +137,26 @@ if (ZYDIS_FEATURE_FORMATTER AND NOT ZYDIS_FEATURE_DECODER) ) endif () +if (ZYDIS_FEATURE_ENCODER AND (ZYDIS_MINIMAL_MODE OR + NOT ZYDIS_FEATURE_DECODER OR + NOT ZYDIS_FEATURE_AVX512 OR + NOT ZYDIS_FEATURE_KNC)) + message( + FATAL_ERROR + "\nZYDIS_FEATURE_ENCODER requires ZYDIS_FEATURE_DECODER in full mode (ZYDIS_MINIMAL_MODE \ + disabled) with all ISA extensions (ZYDIS_FEATURE_AVX512 and ZYDIS_FEATURE_KNC 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_ENCODER) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_ENCODER") +endif () if (NOT ZYDIS_FEATURE_FORMATTER) target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_FORMATTER") endif () @@ -120,12 +166,17 @@ endif () if (NOT ZYDIS_FEATURE_KNC) target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_KNC") endif () +if (NOT ZYDIS_FEATURE_SEGMENT) + target_compile_definitions("Zydis" PUBLIC "ZYDIS_DISABLE_SEGMENT") +endif () target_sources("Zydis" PRIVATE + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Defines.h" "${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/Segment.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" @@ -136,6 +187,7 @@ target_sources("Zydis" "src/MetaInfo.c" "src/Mnemonic.c" "src/Register.c" + "src/Segment.c" "src/SharedData.c" "src/String.c" "src/Utils.c" @@ -149,20 +201,36 @@ if (ZYDIS_FEATURE_DECODER) "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/DecoderData.h" "src/Decoder.c" "src/DecoderData.c") + if (ZYDIS_FEATURE_ENCODER) + target_sources("Zydis" + PRIVATE + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Encoder.h" + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Internal/EncoderData.h" + "src/Encoder.c" + "src/EncoderData.c") + endif () if (ZYDIS_FEATURE_FORMATTER AND (NOT ZYDIS_MINIMAL_MODE)) target_sources("Zydis" PRIVATE + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Disassembler.h" "${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/Disassembler.c" "src/Formatter.c" "src/FormatterBuffer.c" "src/FormatterATT.c" "src/FormatterBase.c" "src/FormatterIntel.c") endif () + if (ZYDIS_FEATURE_SEGMENT) + target_sources("Zydis" + PRIVATE + "${CMAKE_CURRENT_LIST_DIR}/include/Zydis/Segment.h" + "src/Segment.c") + endif () endif () if (ZYDIS_BUILD_SHARED_LIB AND WIN32) @@ -173,20 +241,26 @@ zyan_set_source_group("Zydis") configure_package_config_file(cmake/zydis-config.cmake.in "${CMAKE_CURRENT_BINARY_DIR}/zydis-config.cmake" - INSTALL_DESTINATION "${CMAKE_INSTALL_PREFIX}/cmake" + INSTALL_DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/zydis" +) +write_basic_package_version_file( + "${CMAKE_CURRENT_BINARY_DIR}/zydis-config-version.cmake" + COMPATIBILITY SameMajorVersion ) install(FILES "${CMAKE_CURRENT_BINARY_DIR}/zydis-config.cmake" - DESTINATION "${CMAKE_INSTALL_PREFIX}/cmake" + "${CMAKE_CURRENT_BINARY_DIR}/zydis-config-version.cmake" + DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/zydis" ) install(TARGETS "Zydis" + EXPORT "zydis-targets" 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(EXPORT "zydis-targets" + NAMESPACE "Zydis::" + DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/zydis") install(DIRECTORY "include/" DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) function (_maybe_set_emscripten_cfg target) @@ -201,43 +275,28 @@ function (_maybe_set_emscripten_cfg target) endif () endfunction () +function(_add_example target source_file sub_folder) + add_executable("${target}" "examples/${source_file}") + target_link_libraries("${target}" "Zydis") + set_target_properties("${target}" PROPERTIES FOLDER "Examples/${sub_folder}") + target_compile_definitions("${target}" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("${target}") + zyan_maybe_enable_wpo("${target}") + _maybe_set_emscripten_cfg("${target}") +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") + _add_example("DisassembleSimple" "DisassembleSimple.c" "Decoder") + _add_example("Disassemble" "Disassemble.c" "Decoder") + _add_example("Formatter01" "Formatter01.c" "Decoder") + _add_example("Formatter02" "Formatter02.c" "Decoder") + _add_example("Formatter03" "Formatter03.c" "Decoder") + _add_example("ZydisPerfTest" "ZydisPerfTest.c" "Decoder") if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux" OR ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD") target_compile_definitions("ZydisPerfTest" PRIVATE "_GNU_SOURCE") @@ -245,6 +304,12 @@ if (ZYDIS_BUILD_EXAMPLES AND NOT ZYAN_NO_LIBC) target_link_libraries("ZydisPerfTest" Threads::Threads) endif () endif () + + if (ZYDIS_FEATURE_ENCODER) + _add_example("EncodeMov" "EncodeMov.c" "Encoder") + _add_example("EncodeFromScratch" "EncodeFromScratch.c" "Encoder") + _add_example("RewriteCode" "RewriteCode.c" "Encoder") + endif () endif () # =============================================================================================== # @@ -262,35 +327,159 @@ if (ZYDIS_BUILD_TOOLS AND NOT ZYAN_NO_LIBC) _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") + add_executable("ZydisFuzzDecoder" + "tools/ZydisFuzzDecoder.c" + "tools/ZydisFuzzShared.c" + "tools/ZydisFuzzShared.h") + target_link_libraries("ZydisFuzzDecoder" "Zydis") + set_target_properties("ZydisFuzzDecoder" PROPERTIES FOLDER "Tools") + target_compile_definitions("ZydisFuzzDecoder" PRIVATE "_CRT_SECURE_NO_WARNINGS") + if (NOT ZYDIS_FEATURE_ENCODER) + # For 'ZydisFuzzShared.c' + target_compile_definitions("ZydisFuzzDecoder" PUBLIC "ZYDIS_DISABLE_ENCODER") + endif () + zyan_set_common_flags("ZydisFuzzDecoder") + zyan_maybe_enable_wpo("ZydisFuzzDecoder") + _maybe_set_emscripten_cfg("ZydisFuzzDecoder") if (ZYDIS_FUZZ_AFL_FAST) - target_compile_definitions("ZydisFuzzIn" PRIVATE "ZYDIS_FUZZ_AFL_FAST") + target_compile_definitions("ZydisFuzzDecoder" PRIVATE "ZYDIS_FUZZ_AFL_FAST") endif () if (ZYDIS_LIBFUZZER) - target_compile_definitions("ZydisFuzzIn" PRIVATE "ZYDIS_LIBFUZZER") + target_compile_definitions("ZydisFuzzDecoder" PRIVATE "ZYDIS_LIBFUZZER") + endif () + + if (ZYDIS_FEATURE_ENCODER) + add_executable("ZydisFuzzEncoder" + "tools/ZydisFuzzEncoder.c" + "tools/ZydisFuzzShared.c" + "tools/ZydisFuzzShared.h") + target_link_libraries("ZydisFuzzEncoder" "Zydis") + set_target_properties("ZydisFuzzEncoder" PROPERTIES FOLDER "Tools") + target_compile_definitions("ZydisFuzzEncoder" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("ZydisFuzzEncoder") + zyan_maybe_enable_wpo("ZydisFuzzEncoder") + _maybe_set_emscripten_cfg("ZydisFuzzEncoder") + if (ZYDIS_FUZZ_AFL_FAST) + target_compile_definitions("ZydisFuzzEncoder" PRIVATE "ZYDIS_FUZZ_AFL_FAST") + endif () + if (ZYDIS_LIBFUZZER) + target_compile_definitions("ZydisFuzzEncoder" PRIVATE "ZYDIS_LIBFUZZER") + endif () + + add_executable("ZydisFuzzReEncoding" + "tools/ZydisFuzzReEncoding.c" + "tools/ZydisFuzzShared.c" + "tools/ZydisFuzzShared.h") + target_link_libraries("ZydisFuzzReEncoding" "Zydis") + set_target_properties("ZydisFuzzReEncoding" PROPERTIES FOLDER "Tools") + target_compile_definitions("ZydisFuzzReEncoding" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("ZydisFuzzReEncoding") + zyan_maybe_enable_wpo("ZydisFuzzReEncoding") + _maybe_set_emscripten_cfg("ZydisFuzzReEncoding") + if (ZYDIS_FUZZ_AFL_FAST) + target_compile_definitions("ZydisFuzzReEncoding" PRIVATE "ZYDIS_FUZZ_AFL_FAST") + endif () + if (ZYDIS_LIBFUZZER) + target_compile_definitions("ZydisFuzzReEncoding" PRIVATE "ZYDIS_LIBFUZZER") + endif () + + add_executable("ZydisTestEncoderAbsolute" + "tools/ZydisTestEncoderAbsolute.c") + target_link_libraries("ZydisTestEncoderAbsolute" "Zydis") + set_target_properties("ZydisTestEncoderAbsolute" PROPERTIES FOLDER "Tools") + target_compile_definitions("ZydisTestEncoderAbsolute" PRIVATE "_CRT_SECURE_NO_WARNINGS") + zyan_set_common_flags("ZydisTestEncoderAbsolute") + zyan_maybe_enable_wpo("ZydisTestEncoderAbsolute") + _maybe_set_emscripten_cfg("ZydisTestEncoderAbsolute") 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") + if (NOT ZYDIS_FEATURE_ENCODER) + target_compile_definitions("ZydisInfo" PUBLIC "ZYDIS_DISABLE_ENCODER") + endif () 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 () + +# =============================================================================================== # +# Doxygen documentation # +# =============================================================================================== # + +if (ZYDIS_BUILD_DOXYGEN) + find_package(Doxygen) + if (DOXYGEN_FOUND) + # Read Doxygen options from the Doxyfile and set them as CMake variables + # to accomodate doxygen_add_docs() + file(READ "Doxyfile" DOXYFILE) + # Remove comments + string(REGEX REPLACE "\n?#[^\n]*\n" "" DOXYFILE ${DOXYFILE}) + # Remove empty lines + string(REGEX REPLACE "\n[ \t\r\n]" "\n" DOXYFILE "${DOXYFILE}") + # Strip leading and trailing spaces + string(STRIP "${DOXYFILE}" DOXYFILE) + # Tranform the file in a list of '='-separated options + string(REPLACE "\n" ";" DOXYFILE "${DOXYFILE}") + + foreach(option IN LISTS DOXYFILE) + string(REPLACE "=" ";" option "${option}") + list(GET option 0 opt_name) + list(GET option 1 opt_value) + string(STRIP "${opt_name}" opt_name) + string(STRIP "${opt_value}" opt_value) + + if (opt_name STREQUAL "INPUT") + # Save the INPUTs in a list to be used later + string(REGEX REPLACE "[ ]+" ";" DOC_PATHS "${opt_value}") + # Skip as the input files are not set by a DOXYGEN_INPUT variable + continue() + endif() + + if (opt_name STREQUAL "OUTPUT_DIRECTORY") + # Skip as CMake writes the output files in the build directory + continue() + endif() + + set("DOXYGEN_${opt_name}" ${opt_value}) + endforeach() + + set(DOXYGEN_QUIET YES) + set(DOXYGEN_WARNINGS NO) + set(DOXYGEN_WARN_IF_UNDOCUMENTED NO) + + doxygen_add_docs(ZydisDoc ${DOC_PATHS} ALL) + + install( + DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/" + DESTINATION "${CMAKE_INSTALL_DOCDIR}/api" + COMPONENT Documentation + ) + else () + message("Can't generate documentation, Doxygen not found.") + endif () +endif () + +# =============================================================================================== # +# Manpages # +# =============================================================================================== # + +if (ZYDIS_BUILD_MAN) + set(MAN_NAMES "ZydisDisasm.1" "ZydisInfo.1") + find_program(RONN_BIN "ronn") + foreach(MAN_NAME ${MAN_NAMES}) + add_custom_command( + OUTPUT ${MAN_NAME} + COMMAND ${RONN_BIN} ARGS + "--roff" + "--output-dir=${CMAKE_CURRENT_BINARY_DIR}" + "${CMAKE_CURRENT_SOURCE_DIR}/man/${MAN_NAME}.ronn" + ) + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${MAN_NAME}" TYPE MAN) + endforeach() + add_custom_target(man ALL DEPENDS ${MAN_NAMES}) +endif () diff --git a/Doxyfile b/Doxyfile index dc101bb9..b37baf1f 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,2471 +1,19 @@ -# 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.1.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 = YES - -# 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 = YES - -# 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 \ - ./files.dox - -# 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. - +# This file is also parsed by CMakelists.txt, please only add one option value +# per line (i.e. do not split long lines with '\'), and only use '=' to set values + +PROJECT_NAME = Zydis +PROJECT_NUMBER = v4.0.0 +OUTPUT_DIRECTORY = ./doc +INPUT = ./include ./README.md ./files.dox +JAVADOC_AUTOBRIEF = YES +QT_AUTOBRIEF = YES +OPTIMIZE_OUTPUT_FOR_C = YES +TOC_INCLUDE_HEADINGS = 0 +EXTRACT_LOCAL_CLASSES = NO +HIDE_SCOPE_NAMES = YES +RECURSIVE = YES 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 -# , /