fcml_renderer.h

Go to the documentation of this file.

/*
 * FCML - Free Code Manipulation Library.
 * Copyright (C) 2010-2020 Slawomir Wojtasiak
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef FCML_REND_H_
#define FCML_REND_H_

#include "fcml_lib_export.h"

#include "fcml_types.h"
#include "fcml_errors.h"
#include "fcml_dialect.h"
#include "fcml_disassembler.h"

#ifdef __cplusplus
extern "C" {
#endif

#define FCML_REND_MAX_BUFF_LEN                  512

#define FCML_REND_FLAG_RENDER_CODE              0x00000001

#define FCML_REND_FLAG_HEX_IMM                  0x00000002

#define FCML_REND_FLAG_RENDER_DEFAULT_SEG       0x00000004

#define FCML_REND_FLAG_HEX_DISPLACEMENT         0x00000008

#define FCML_REND_FLAG_COND_GROUP_1             0x00000010

#define FCML_REND_FLAG_COND_GROUP_2             0x00000020

#define FCML_REND_FLAG_COND_SHOW_CARRY          0x00000040

#define FCML_REND_FLAG_RENDER_SIB_HINT          0x00000080

#define FCML_REND_FLAG_RENDER_ABS_HINT          0x00000100

#define FCML_REND_FLAG_RENDER_REL_HINT          0x00000200

#define FCML_REND_FLAG_RENDER_INDIRECT_HINT     0x00000400

#define FCML_REND_FLAG_REP_PREFIX_GROUP_1       0x00000800

#define FCML_REND_FLAG_REP_PREFIX_GROUP_2       0x00001000

#define FCML_REND_FLAG_CODE_PADDING             0x00002000

#define FCML_REND_FLAG_MNEMONIC_PADDING         0x00004000

#define FCML_REND_FLAG_REMOVE_LEADING_ZEROS     0x00008000

#define FCML_REND_DEFAULT_FLAGS             0

#define FCML_REND_DEFAULT_CODE_PADDING      8

#define FCML_REND_DEFAULT_MNEMONIC_PADDING  8

typedef struct fcml_st_render_config {
    fcml_uint32_t render_flags;
    fcml_uint16_t prefered_mnemonic_padding;
    fcml_uint16_t prefered_code_padding;
} fcml_st_render_config;

LIB_EXPORT fcml_ceh_error LIB_CALL fcml_fn_render(
        const fcml_st_dialect *dialect, const fcml_st_render_config *config,
        fcml_char *buffer, fcml_usize buffer_len,
        const fcml_st_disassembler_result *result);

#ifdef __cplusplus
}
#endif

#endif /* FCML_REND_H_ */