ShortString.h (3264B)
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 * Defines the immutable and storage-efficient `ZydisShortString` struct, which 30 * is used to store strings in the generated tables. 31 */ 32 33 #ifndef ZYDIS_SHORTSTRING_H 34 #define ZYDIS_SHORTSTRING_H 35 36 #include <Zycore/Defines.h> 37 #include <Zycore/Types.h> 38 39 #ifdef __cplusplus 40 extern "C" { 41 #endif 42 43 /* ============================================================================================== */ 44 /* Enums and types */ 45 /* ============================================================================================== */ 46 47 #if !(defined(ZYAN_APPLE)) 48 # pragma pack(push, 1) 49 #endif 50 51 /** 52 * Defines the `ZydisShortString` struct. 53 * 54 * This compact struct is mainly used for internal string-tables to save up some bytes. 55 * 56 * All fields in this struct should be considered as "private". Any changes may lead to unexpected 57 * behavior. 58 */ 59 typedef struct ZydisShortString_ 60 { 61 /** 62 * The buffer that contains the actual (null-terminated) string. 63 */ 64 const char* data; 65 /** 66 * The length (number of characters) of the string (without 0-termination). 67 */ 68 ZyanU8 size; 69 } ZydisShortString; 70 71 #if !(defined(ZYAN_APPLE)) 72 # pragma pack(pop) 73 #endif 74 75 /* ============================================================================================== */ 76 /* Macros */ 77 /* ============================================================================================== */ 78 79 /** 80 * Declares a `ZydisShortString` from a static C-style string. 81 * 82 * @param string The C-string constant. 83 */ 84 #define ZYDIS_MAKE_SHORTSTRING(string) \ 85 { string, sizeof(string) - 1 } 86 87 /* ============================================================================================== */ 88 89 #ifdef __cplusplus 90 } 91 #endif 92 93 #endif /* ZYDIS_SHORTSTRING_H */