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 * Mnemonic constant definitions and helper functions. 30 */ 31 32 #ifndef ZYDIS_MNEMONIC_H 33 #define ZYDIS_MNEMONIC_H 34 35 #include <Zydis/Defines.h> 36 #include <Zydis/ShortString.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* ============================================================================================== */ 43 /* Enums and types */ 44 /* ============================================================================================== */ 45 46 #include <Zydis/Generated/EnumMnemonic.h> 47 48 /* ============================================================================================== */ 49 /* Exported functions */ 50 /* ============================================================================================== */ 51 52 /** 53 * @addtogroup mnemonic Mnemonic 54 * Functions for retrieving mnemonic names. 55 * @{ 56 */ 57 58 /** 59 * Returns the specified instruction mnemonic string. 60 * 61 * @param mnemonic The mnemonic. 62 * 63 * @return The instruction mnemonic string or `ZYAN_NULL`, if an invalid mnemonic was passed. 64 */ 65 ZYDIS_EXPORT const char* ZydisMnemonicGetString(ZydisMnemonic mnemonic); 66 67 /** 68 * Returns the specified instruction mnemonic as `ZydisShortString`. 69 * 70 * @param mnemonic The mnemonic. 71 * 72 * @return The instruction mnemonic string or `ZYAN_NULL`, if an invalid mnemonic was passed. 73 * 74 * The `buffer` of the returned struct is guaranteed to be zero-terminated in this special case. 75 */ 76 ZYDIS_EXPORT const ZydisShortString* ZydisMnemonicGetStringWrapped(ZydisMnemonic mnemonic); 77 78 /** 79 * @} 80 */ 81 82 /* ============================================================================================== */ 83 84 #ifdef __cplusplus 85 } 86 #endif 87 88 #endif /* ZYDIS_MNEMONIC_H */ 89