libyasm/dbgfmt.h

Go to the documentation of this file.

#ifndef YASM_DBGFMT_H
#define YASM_DBGFMT_H

#ifndef YASM_DOXYGEN

typedef struct yasm_dbgfmt_base {
    const struct yasm_dbgfmt_module *module;
} yasm_dbgfmt_base;
#endif

struct yasm_dbgfmt_module {
    const char *name;

    const char *keyword;

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

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

    void (*destroy) (/*@only@*/ yasm_dbgfmt *dbgfmt);

    void (*generate) (yasm_object *object, yasm_linemap *linemap,
                      yasm_errwarns *errwarns);
};

const char *yasm_dbgfmt_keyword(const yasm_dbgfmt *dbgfmt);

/*@null@*/ /*@only@*/ yasm_dbgfmt *yasm_dbgfmt_create
    (const yasm_dbgfmt_module *module, yasm_object *object);

void yasm_dbgfmt_destroy(/*@only@*/ yasm_dbgfmt *dbgfmt);

void yasm_dbgfmt_generate(yasm_object *object, yasm_linemap *linemap,
                          yasm_errwarns *errwarns);

#ifndef YASM_DOXYGEN

/* Inline macro implementations for dbgfmt functions */

#define yasm_dbgfmt_keyword(dbgfmt) \
    (((yasm_dbgfmt_base *)dbgfmt)->module->keyword)

#define yasm_dbgfmt_create(module, object) \
    module->create(object)

#define yasm_dbgfmt_destroy(dbgfmt) \
    ((yasm_dbgfmt_base *)dbgfmt)->module->destroy(dbgfmt)
#define yasm_dbgfmt_generate(object, linemap, ews) \
    ((yasm_dbgfmt_base *)((object)->dbgfmt))->module->generate \
        (object, linemap, ews)

#endif

#endif