FormatterBase.h

Go to the documentation of this file.

/***************************************************************************************************
 
 Zyan Disassembler Library (Zydis)
 
 Original Author : Florian Bernd, Joel Hoener
 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 
***************************************************************************************************/
 
#ifndef ZYDIS_FORMATTER_BASE_H
#define ZYDIS_FORMATTER_BASE_H
 
#include <Zydis/Formatter.h>
#include <Zydis/Internal/String.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================================== */
/* Macros */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* String */
/* ---------------------------------------------------------------------------------------------- */
 
#define ZYDIS_STRING_APPEND_NUM_U(formatter, base, str, value, padding_length, \
 force_leading_number) \
 switch (base) \
 { \
 case ZYDIS_NUMERIC_BASE_DEC: \
 ZYAN_CHECK(ZydisStringAppendDecU(str, value, padding_length, \
 (formatter)->number_format[base][0].string, \
 (formatter)->number_format[base][1].string)); \
 break; \
 case ZYDIS_NUMERIC_BASE_HEX: \
 ZYAN_CHECK(ZydisStringAppendHexU(str, value, padding_length, force_leading_number, \
 (formatter)->hex_uppercase, \
 (formatter)->number_format[base][0].string, \
 (formatter)->number_format[base][1].string)); \
 break; \
 default: \
 return ZYAN_STATUS_INVALID_ARGUMENT; \
 }
 
#define ZYDIS_STRING_APPEND_NUM_S(formatter, base, str, value, padding_length, \
 force_leading_number, force_sign) \
 switch (base) \
 { \
 case ZYDIS_NUMERIC_BASE_DEC: \
 ZYAN_CHECK(ZydisStringAppendDecS(str, value, padding_length, force_sign, \
 (formatter)->number_format[base][0].string, \
 (formatter)->number_format[base][1].string)); \
 break; \
 case ZYDIS_NUMERIC_BASE_HEX: \
 ZYAN_CHECK(ZydisStringAppendHexS(str, value, padding_length, force_leading_number, \
 (formatter)->hex_uppercase, force_sign, \
 (formatter)->number_format[base][0].string, \
 (formatter)->number_format[base][1].string)); \
 break; \
 default: \
 return ZYAN_STATUS_INVALID_ARGUMENT; \
 }
 
/* ---------------------------------------------------------------------------------------------- */
/* Buffer */
/* ---------------------------------------------------------------------------------------------- */
 
#define ZYDIS_BUFFER_APPEND_TOKEN(buffer, type) \
 if ((buffer)->is_token_list) \
 { \
 ZYAN_CHECK(ZydisFormatterBufferAppend(buffer, type)); \
 }
 
#define ZYDIS_BUFFER_REMEMBER(buffer, state) \
 if ((buffer)->is_token_list) \
 { \
 (state) = (ZyanUPointer)(buffer)->string.vector.data; \
 } else \
 { \
 (state) = (ZyanUPointer)(buffer)->string.vector.size; \
 }
 
#define ZYDIS_BUFFER_APPEND(buffer, name) \
 if ((buffer)->is_token_list) \
 { \
 ZYAN_CHECK(ZydisFormatterBufferAppendPredefined(buffer, TOK_ ## name)); \
 } else \
 { \
 ZYAN_CHECK(ZydisStringAppendShort(&buffer->string, &STR_ ## name)); \
 }
 
// TODO: Implement `letter_case` for predefined tokens
 
#define ZYDIS_BUFFER_APPEND_CASE(buffer, name, letter_case) \
 if ((buffer)->is_token_list) \
 { \
 ZYAN_CHECK(ZydisFormatterBufferAppendPredefined(buffer, TOK_ ## name)); \
 } else \
 { \
 ZYAN_CHECK(ZydisStringAppendShortCase(&buffer->string, &STR_ ## name, letter_case)); \
 }
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Helper functions */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Buffer */
/* ---------------------------------------------------------------------------------------------- */
 
// MSVC does not like the C99 flexible-array extension
#ifdef ZYAN_MSVC
# pragma warning(push)
# pragma warning(disable:4200)
#endif
 
#pragma pack(push, 1)
 
typedef struct ZydisPredefinedToken_
{
 ZyanU8 size;
 ZyanU8 next;
 ZyanU8 data[];
} ZydisPredefinedToken;
 
#pragma pack(pop)
 
#ifdef ZYAN_MSVC
# pragma warning(pop)
#endif
 
ZYAN_INLINE ZyanStatus ZydisFormatterBufferAppendPredefined(ZydisFormatterBuffer* buffer,
 const ZydisPredefinedToken* data)
{
 ZYAN_ASSERT(buffer);
 ZYAN_ASSERT(data);
 
 const ZyanUSize len = buffer->string.vector.size;
 ZYAN_ASSERT((len > 0) && (len < 256));
 if (buffer->capacity <= len + data->size)
 {
 return ZYAN_STATUS_INSUFFICIENT_BUFFER_SIZE;
 }
 
 ZydisFormatterToken* const last = (ZydisFormatterToken*)buffer->string.vector.data - 1;
 last->next = (ZyanU8)len;
 
 ZYAN_MEMCPY((ZyanU8*)buffer->string.vector.data + len, &data->data[0], data->size);
 
 const ZyanUSize delta = len + data->next;
 buffer->capacity -= delta;
 buffer->string.vector.data = (ZyanU8*)buffer->string.vector.data + delta;
 buffer->string.vector.size = data->size - data->next;
 buffer->string.vector.capacity = ZYAN_MIN(buffer->capacity, 255);
 
 return ZYAN_STATUS_SUCCESS;
}
 
/* ---------------------------------------------------------------------------------------------- */
/* General */
/* ---------------------------------------------------------------------------------------------- */
 
ZyanU32 ZydisFormatterHelperGetExplicitSize(const ZydisFormatter* formatter,
 ZydisFormatterContext* context, const ZydisDecodedOperand* operand);
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Formatter functions */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Operands */
/* ---------------------------------------------------------------------------------------------- */
 
ZyanStatus ZydisFormatterBaseFormatOperandREG(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterBaseFormatOperandPTR(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterBaseFormatOperandIMM(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
/* ---------------------------------------------------------------------------------------------- */
/* Elemental tokens */
/* ---------------------------------------------------------------------------------------------- */
 
ZyanStatus ZydisFormatterBasePrintAddressABS(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterBasePrintAddressREL(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterBasePrintIMM(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
/* ---------------------------------------------------------------------------------------------- */
/* Optional tokens */
/* ---------------------------------------------------------------------------------------------- */
 
ZyanStatus ZydisFormatterBasePrintSegment(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterBasePrintPrefixes(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterBasePrintDecorator(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context, ZydisDecorator decorator);
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif // ZYDIS_FORMATTER_BASE_H