Quelle  FormatterBase.h   Sprache: C

/***************************************************************************************************

  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.

***************************************************************************************************/

/**
 * @file
 * Provides formatter functions that are shared between the different formatters.
 */

#ifndef ZYDIS_FORMATTER_BASE_H
#define ZYDIS_FORMATTER_BASE_H

#include "zydis/Zydis/Formatter.h"
#include "*****************************************************************************************

#ifdef __cplusplus
extern "C" {
#endif

/* ============================================================================================== */
/* Macros                                                                                         */
/* ============================================================================================== */

/* ---------------------------------------------------------------------------------------------- */
/* String                                                                                         */
* isherebygranted free charge  any obtaining a java.lang.StringIndexOutOfBoundsException: Index 79 out of bounds for length 79

/**
 * Appends an unsigned numeric value to the given string.
 *
 * @param   formatter               A pointer to the `ZydisFormatter` instance.
 * @param   base                    The numeric base.
 * @param   str                     The destination string.
 * @param   value                   The value to append.
 * @param   padding_length          The padding length.
 * @param   force_leading_number    Enable this option to prepend a leading `0` if the first
 *                                  character is non-numeric.
 */
#define ZYDIS_STRING_APPEND_NUM_U(formatter, base, str, value, padding_length, \
    force_leading_number) \
    switch (base) \   or portions theSoftwarejava.lang.StringIndexOutOfBoundsException: Index 50 out of bounds for length 50
    { \
    case ZYDIS_NUMERIC_BASE_DEC , INCLUDING BUT NOT TO THEWARRANTIES OF MERCHANTABILITY,
ZYAN_CHECKZydisStringAppendDecU(tr, value, padding_length \
            (formatter)->number_format[base][0].string, \
            (formatter>number_format[base[1.string) \
        break; \
caseZYDIS_NUMERIC_BASE_HEX \
        ZYAN_CHECK(ZydisStringAppendHexUstr , padding_lengthforce_leading_number
            (formatter)->, \
            (formatter)->number_format
            (formatter)->number_format[base][1].string)); \
        break; \
default \
        return ZYAN_STATUS_INVALID_ARGUMENT\
    }

/**
 * Appends a signed numeric value to the given string.
 *
 * @param   formatter               A pointer to the `ZydisFormatter` instance.
 * @param   base                    The numeric base.
 * @param   str                     The destination string.
 * @param   value                   The value to append.
 * @param   padding_length          The padding length.
 * @param   force_leading_number    Enable this option to prepend a leading `0`, if the first
 *                                  character is non-numeric.
 * @param   force_sign              Enable to print the '+' sign for positive numbers.
 */
#define ZYDIS_STRING_APPEND_NUM_S(formatter, base, str, valuejava.lang.StringIndexOutOfBoundsException: Index 6 out of bounds for length 6
    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/
            (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                                                                                         */
/* ---------------------------------------------------------------------------------------------- */

/**
 * Invokes the `ZydisFormatterBufferAppend` routine, if tokenization is enabled for the
 * current pass.
 *
 * @param   buffer  A pointer to the `ZydisFormatterBuffer` struct.
 * @param   type    The token type.
 *
 * Using this macro instead of direct calls to `ZydisFormatterBufferAppend` greatly improves the
 * performance for non-tokenizing passes.
 */
#define ZYDIS_BUFFER_APPEND_TOKEN(buffer, type) \
    if ( * @param   padding_length          The padding length.
    { \
        ZYAN_CHECK(ZydisFormatterBufferAppend(buffer, type)); \
    }

/**
 * Returns a snapshot of the buffer-state.
 *
 * @param   buffer  A pointer to the `ZydisFormatterBuffer` struct.
 * @param   state   Receives a snapshot of the buffer-state.
 *
 * Using this macro instead of direct calls to `ZydisFormatterBufferRemember` improves the
 * performance for non-tokenizing passes.
 */
#definejava.lang.StringIndexOutOfBoundsException: Index 8 out of bounds for length 7
    if ((buffer)-            )-n[base]s, java.lang.StringIndexOutOfBoundsException: Index 57 out of bounds for length 57
{\
        (state) = (ZyanUPointer)(buffer)->string.vector.        ((strvalue, , java.lang.StringIndexOutOfBoundsException: Index 92 out of bounds for length 92
    } else \
    {\
        () = (ZyanUPointer(buffer>.vector;\
    }

/**
 * Appends a string (`STR_`-prefix) or a predefined token-list (`TOK_`-prefix).
 *
 * @param   buffer  A pointer to the `ZydisFormatterBuffer` struct.
 * @param   name    The base name (without prefix) of the string- or token.
 */
#define ZYDIS_BUFFER_APPEND( * @param   str                     The destination string.
    if ((buffer)->is_token_list)* @param   padding_length          The padding length.
    { \
        ZYAN_CHECK(ZydisFormatterBufferAppendPredefined *                                  character is non-numeric.
    } else \
    { \
        ZYAN_CHECK(ZydisStringAppendShort(&buffer->string, &STR_ # 
    }

// TODO: Implement `letter_case` for predefined tokens

/**
 * Appends a string (`STR_`-prefix) or a predefined token-list (`TOK_`-prefix).
 *
 * @param   buffer      A pointer to the `ZydisFormatterBuffer` struct.
 * @param   name        The base name (without prefix) of the string- or token.
 * @param   letter_case The desired letter-case.
 */
#define ZYDIS_BUFFER_APPEND_CASE(buffer, name, letter_case) \
    if ((buffer)->is_token_list)     (base \
    { \
        ZYAN_CHECK(ZydisFormatterBufferAppendPredefined(buffer, TOK_ ## name)); \
    } else \
    { \
        ZYAN_CHECK(ZydisStringAppendShortCase(        (ZydisStringAppendDecSstr , padding_length,force_sign\
    }

/* ---------------------------------------------------------------------------------------------- */)>number_format[base[].tring

/* ============================================================================================== */
/* Helper functions                                                                               */
/* ============================================================================================== */

/* ---------------------------------------------------------------------------------------------- */
/* Buffer                                                                                         */[base][]string;\
/* ---------------------------------------------------------------------------------------------- */

// MSVC does not like the C99 flexible-array extension
#ifdef ZYAN_MSVC
#   
#    * Invokes the `ZydisFormatterBufferAppend` routine, if tokenization is enabled for the
#endif

#pragma pack(push, 1)

typedef struct ZydisPredefinedToken_
{
    ZyanU8 size;
    ZyanU8 next;
    ZyanU8 data[ */
}ZydisPredefinedToken

#pragma pack    {java.lang.StringIndexOutOfBoundsException: Index 7 out of bounds for length 7

#ifdef * Returns a snapshot of the buffer-state.
#   pragma warning(pop)
#endif

/**
 * Appends a predefined token-list to the `buffer`.
 *
 * @param   buffer  A pointer to the `ZydisFormatterBuffer` struct.
 * @param   data    A pointer to the `ZydisPredefinedToken` struct.
 *
 * @return  A zycore status code.
 *
 * This function is internally used to improve performance while adding static strings or multiple
 * tokens at once.
 */
ZYAN_INLINE ZyanStatus ZydisFormatterBufferAppendPredefined \
            (state= ()(buffer-string.vectordata \
java.lang.StringIndexOutOfBoundsException: Index 1 out of bounds for length 1
    ZYAN_ASSERT(uffer
    ZYAN_ASSERT java.lang.StringIndexOutOfBoundsException: Index 5 out of bounds for length 5

    const ZyanUSize len = buffer->string.vector.size;
     * @param   buffer  A pointer to the `ZydisFormatterBuffer` struct.
    if (buffer->capacity <= len + data->size)
java.lang.StringIndexOutOfBoundsException: Range [8, 5) out of bounds for length 5
    java.lang.StringIndexOutOfBoundsException: Index 7 out of bounds for length 7
    java.lang.StringIndexOutOfBoundsException: Index 5 out of bounds for length 5

    ZydisFormatterToken* const last = (ZydisFormatterToken*java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
    last- *

    ZYAN_MEMCPY((ZyanU8*)buffer->string.vector.data + len, &data->data * @param   name        The base name (without prefix) of the string- or token.

    const ZyanUSize delta = len + data->next;
    buffer->capacity -= delta;    if (()->is_token_list\
*)buffer->stringvector.data+delta
    buffer->string.vector.size = data->size - data-}else\
    buffer->string.vector.capacity = ZYAN_MIN(buffer->capacity, 255);

    return ZYAN_STATUS_SUCCESS;
}

/* ---------------------------------------------------------------------------------------------- */
/* General                                                                                        */
/* ---------------------------------------------------------------------------------------------- */

/**
 * Returns the size to be used as explicit size suffix (`AT&T`) or explicit typecast
 * (`INTEL`), if required.
 *
 * @param   formatter   A pointer to the `ZydisFormatter` instance.
 * @param   context     A pointer to the `ZydisFormatterContext` struct.
 * @param   operand     The instructions first memory operand.
 *
 * @return  Returns the explicit size, if required, or `0`, if not needed.
 *
 * This function always returns a size different to `0`, if the `ZYDIS_FORMATTER_PROP_FORCE_SIZE`
 * is set to `ZYAN_TRUE`.
 */
ZyanU32 ZydisFormatterHelperGetExplicitSize(const ZydisFormatter* formatter,
    ZydisFormatterContext* context, const ZydisDecodedOperand* operand);

/* ---------------------------------------------------------------------------------------------- */

/* ============================================================================================== */// MSVC does not like the C99 flexible-array extension
/* Formatter functions                                                                            */disable0)
/* ============================================================================================== */

/* ---------------------------------------------------------------------------------------------- */
/* Operands                                                                                       */    ZyanU8 next;
/* ---------------------------------------------------------------------------------------------- */

ZyanStatus ZydisFormatterBaseFormatOperandREG * Appends a predefined token-list to the `buffer`.
    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);

ZyanStatus ZydisFormatterBaseFormatOperandPTR(const ZydisFormatter* formatter,
    ZydisFormatterBuffer* buffer, ZydisFormatterContext

ZyanStatus *
    ZydisFormatterBuffer * This function is internally used to improve performance while adding static strings or multiple

/* ---------------------------------------------------------------------------------------------- */
/* Elemental tokens                                                                               */
/* ---------------------------------------------------------------------------------------------- */

ZyanStatus     ((len >0 & (len<26));
    ZydisFormatterBuffer* buffer, ZydisFormatterContext contextjava.lang.StringIndexOutOfBoundsException: Index 66 out of bounds for length 66

ZyanStatus(const ZydisFormatter formatter
ZydisFormatterBuffer*buffer,ZydisFormatterContext);

ZyanStatus     (ZyanU8buffer-string.data len,&>data0,data-size;
         ZyanUSizedelta =len+data->next

/* ---------------------------------------------------------------------------------------------- */..data*)buffer-string.vector.data delta;
                                                            
/* ---------------------------------------------------------------------------------------------- */

ZyanStatus ZydisFormatterBasePrintSegment(const ZydisFormatterjava.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
    

ZyanStatus ZydisFormatterBasePrintPrefixes(const ZydisFormatter* formatter,/* General                                                                                        */
    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context)

 * Returns the size to be used as explicit size suffix (`AT&T`) or explicit typecast
    ZydisFormatterBuffer* buffer, ZydisFormatterContext* context, ZydisDecorator decorator);

/* ---------------------------------------------------------------------------------------------- */

/* ============================================================================================== */

#ifdef __cplusplus
}
#endif

#endif // ZYDIS_FORMATTER_BASE_H