libyasm/objfmt.h

Go to the documentation of this file.

#ifndef YASM_OBJFMT_H
#define YASM_OBJFMT_H

#ifndef YASM_DOXYGEN

typedef struct yasm_objfmt_base {
    const struct yasm_objfmt_module *module;
} yasm_objfmt_base;
#endif

struct yasm_objfmt_module {
    const char *name;

    const char *keyword;

    /*@null@*/ const char *extension;

    const unsigned char default_x86_mode_bits;

    const unsigned char id_at_ok;

    const char **dbgfmt_keywords;

    const char *default_dbgfmt_keyword;

    /*@null@*/ const yasm_directive *directives;

    const yasm_stdmac *stdmacs;

    /*@null@*/ /*@only@*/ yasm_objfmt * (*create) (yasm_object *object);

    void (*output) (yasm_object *o, FILE *f, int all_syms,
                    yasm_errwarns *errwarns);

    void (*destroy) (/*@only@*/ yasm_objfmt *objfmt);

    yasm_section * (*add_default_section) (yasm_object *object);

    void (*init_new_section) (yasm_section *section, unsigned long line);

    /*@observer@*/ /*@null@*/ yasm_section *
        (*section_switch)(yasm_object *object, yasm_valparamhead *valparams,
                          /*@null@*/ yasm_valparamhead *objext_valparams,
                          unsigned long line);

    /*@observer@*/ /*@null@*/ yasm_symrec *
        (*get_special_sym)(yasm_object *object, const char *name,
                           const char *parser);
};

/*@null@*/ /*@only@*/ yasm_objfmt *yasm_objfmt_create
    (const yasm_objfmt_module *module, yasm_object *object);

void yasm_objfmt_output(yasm_object *object, FILE *f, int all_syms,
                        yasm_errwarns *errwarns);

void yasm_objfmt_destroy(/*@only@*/ yasm_objfmt *objfmt);

yasm_section *yasm_objfmt_add_default_section(yasm_object *object);

void yasm_objfmt_init_new_section(yasm_object *object, unsigned long line);

/*@observer@*/ /*@null@*/ yasm_section *yasm_objfmt_section_switch
    (yasm_object *object, yasm_valparamhead *valparams,
     /*@null@*/ yasm_valparamhead *objext_valparams, unsigned long line);

/*@observer@*/ /*@null@*/ yasm_symrec *yasm_objfmt_get_special_sym
    (yasm_object *object, const char *name, const char *parser);

#ifndef YASM_DOXYGEN

/* Inline macro implementations for objfmt functions */

#define yasm_objfmt_create(module, object) module->create(object)

#define yasm_objfmt_output(object, f, all_syms, ews) \
    ((yasm_objfmt_base *)((object)->objfmt))->module->output \
        (object, f, all_syms, ews)
#define yasm_objfmt_destroy(objfmt) \
    ((yasm_objfmt_base *)objfmt)->module->destroy(objfmt)
#define yasm_objfmt_section_switch(object, vpms, oe_vpms, line) \
    ((yasm_objfmt_base *)((object)->objfmt))->module->section_switch \
        (object, vpms, oe_vpms, line)
#define yasm_objfmt_add_default_section(object) \
    ((yasm_objfmt_base *)((object)->objfmt))->module->add_default_section \
        (object)
#define yasm_objfmt_init_new_section(section, line) \
    ((yasm_objfmt_base *)((object)->objfmt))->module->init_new_section \
        (section, line)
#define yasm_objfmt_get_special_sym(object, name, parser) \
    ((yasm_objfmt_base *)((object)->objfmt))->module->get_special_sym \
        (object, name, parser)

#endif

#endif

---