fcml_parser.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_PARSER_H_
#define FCML_PARSER_H_

#include "fcml_lib_export.h"

#include "fcml_types.h"
#include "fcml_errors.h"
#include "fcml_common.h"
#include "fcml_dialect.h"
#include "fcml_symbols.h"

#ifdef __cplusplus
extern "C" {
#endif

#define FCML_PARSER_MAX_INSTRUCTION_LEN 1024

typedef struct fcml_st_parser_config {
    fcml_bool ignore_undefined_symbols;
    fcml_bool disable_symbols_declaration;
    fcml_bool override_labels;
    fcml_bool alloc_symbol_table_if_needed;
    // TODO: Support has to be implemented yet.
    fcml_bool enable_error_messages;
} fcml_st_parser_config;

typedef struct fcml_st_parser_context {
    fcml_st_dialect *dialect;
    fcml_st_parser_config configuration;
    fcml_ip ip;
    fcml_st_symbol_table symbol_table;
} fcml_st_parser_context;

typedef struct fcml_st_parser_result {
    fcml_st_ceh_error_container errors;
    fcml_st_symbol *symbol;
    fcml_st_instruction *instruction;
} fcml_st_parser_result;

LIB_EXPORT fcml_ceh_error LIB_CALL fcml_fn_parse(
        fcml_st_parser_context *context, const fcml_string instruction,
        fcml_st_parser_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_parser_result_prepare(
        fcml_st_parser_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_parser_result_free(
        fcml_st_parser_result *result);

#ifdef __cplusplus
}
#endif

#endif /* FCML_PARSER_H_ */