MetaInfo.h (3222B)
1 /*************************************************************************************************** 2 3 Zyan Disassembler Library (Zydis) 4 5 Original Author : Florian Bernd 6 7 * Permission is hereby granted, free of charge, to any person obtaining a copy 8 * of this software and associated documentation files (the "Software"), to deal 9 * in the Software without restriction, including without limitation the rights 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 * copies of the Software, and to permit persons to whom the Software is 12 * furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in all 15 * copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 * SOFTWARE. 24 25 ***************************************************************************************************/ 26 27 /** 28 * @file 29 * @brief 30 */ 31 32 #ifndef ZYDIS_METAINFO_H 33 #define ZYDIS_METAINFO_H 34 35 #include "zydis/Zydis/Defines.h" 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 /* ============================================================================================== */ 42 /* Enums and types */ 43 /* ============================================================================================== */ 44 45 #include "zydis/Zydis/Generated/EnumInstructionCategory.h" 46 #include "zydis/Zydis/Generated/EnumISASet.h" 47 #include "zydis/Zydis/Generated/EnumISAExt.h" 48 49 /* ============================================================================================== */ 50 /* Exported functions */ 51 /* ============================================================================================== */ 52 53 /** 54 * Returns the specified instruction category string. 55 * 56 * @param category The instruction category. 57 * 58 * @return The instruction category string or `ZYAN_NULL`, if an invalid category was passed. 59 */ 60 ZYDIS_EXPORT const char* ZydisCategoryGetString(ZydisInstructionCategory category); 61 62 /** 63 * Returns the specified isa-set string. 64 * 65 * @param isa_set The isa-set. 66 * 67 * @return The isa-set string or `ZYAN_NULL`, if an invalid isa-set was passed. 68 */ 69 ZYDIS_EXPORT const char* ZydisISASetGetString(ZydisISASet isa_set); 70 71 /** 72 * Returns the specified isa-extension string. 73 * 74 * @param isa_ext The isa-extension. 75 * 76 * @return The isa-extension string or `ZYAN_NULL`, if an invalid isa-extension was passed. 77 */ 78 ZYDIS_EXPORT const char* ZydisISAExtGetString(ZydisISAExt isa_ext); 79 80 /* ============================================================================================== */ 81 82 #ifdef __cplusplus 83 } 84 #endif 85 86 #endif /* ZYDIS_METAINFO_H */