libyasm/dbgfmt.h

/**
 * \file libyasm/dbgfmt.h
 * \brief YASM debug format interface.
 *
 * \rcs
 * $IdPath$
 * \endrcs
 *
 * \license
 *  Copyright (C) 2002  Peter Johnson
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  - Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND OTHER CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR OTHER CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * \endlicense
 */
#ifndef YASM_DBGFMT_H
#define YASM_DBGFMT_H

/** Version number of #yasm_dbgfmt interface.  Any functional change to the
 * #yasm_dbgfmt interface should simultaneously increment this number.  This
 * version should be checked by #yasm_dbgfmt loaders to verify that the
 * expected version (the version defined by its libyasm header files) matches
 * the loaded module version (the version defined by the module's libyasm
 * header files).  Doing this will ensure that the module version's function
 * definitions match the module loader's function definitions.  The version
 * number must never be decreased.
 */
#define YASM_DBGFMT_VERSION	2

/** YASM debug format interface. */
struct yasm_dbgfmt {
    /** Version (see #YASM_DBGFMT_VERSION).  Should always be set to
     * #YASM_DBGFMT_VERSION by the module source and checked against
     * #YASM_DBGFMT_VERSION by the module loader.
     */
    unsigned int version;

    /** One-line description of the debug format. */
    const char *name;

    /** Keyword used to select debug format. */
    const char *keyword;

    /** Initialize debug output for use.  Must call before any other debug
     * format functions.  The filenames are provided solely for informational
     * purposes.  Function may be unimplemented (NULL) if not needed by the
     * debug format.
     * \param in_filename   primary input filename
     * \param obj_filename  object filename
     * \param of	    object format in use
     * \return Nonzero if object format does not provide needed support.
     */
    int (*initialize) (const char *in_filename, const char *obj_filename,
		       yasm_object *object, yasm_objfmt *of, yasm_arch *a);

    /** Clean up anything allocated by initialize().  Function may be
     * unimplemented (NULL) if not needed by the debug format.
     */
    void (*cleanup) (void);

    /** DEBUG directive support.
     * \param name	    directive name
     * \param valparams	    value/parameters
     * \param line	    virtual line (from yasm_linemap)
     * \return Nonzero if directive was not recognized; 0 if directive was
     *	       recognized even if it wasn't valid.
     */
    int (*directive) (const char *name, yasm_valparamhead *valparams,
		      unsigned long line);

    /** Generate debugging information bytecodes
     * \param object	    object
     */
    void (*generate) (yasm_object *object);
};

#endif