| /* ----------------------------------------------------------------------- * |
| * |
| * Copyright 1996-2016 The NASM Authors - All Rights Reserved |
| * See the file AUTHORS included with the NASM distribution for |
| * the specific copyright holders. |
| * |
| * 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 COPYRIGHT HOLDERS AND |
| * 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 COPYRIGHT OWNER OR |
| * 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. |
| * |
| * ----------------------------------------------------------------------- */ |
| |
| /* |
| * listing.h header file for listing.c |
| */ |
| |
| #ifndef NASM_LISTING_H |
| #define NASM_LISTING_H |
| |
| /* |
| * List-file generators should look like this: |
| */ |
| struct lfmt { |
| /* |
| * Called to initialize the listing file generator. Before this |
| * is called, the other routines will silently do nothing when |
| * called. The `char *' parameter is the file name to write the |
| * listing to. |
| */ |
| void (*init)(const char *fname); |
| |
| /* |
| * Called to clear stuff up and close the listing file. |
| */ |
| void (*cleanup)(void); |
| |
| /* |
| * Called to output binary data. Parameters are: the offset; |
| * the data; the data type. Data types are similar to the |
| * output-format interface, only OUT_ADDRESS will _always_ be |
| * displayed as if it's relocatable, so ensure that any non- |
| * relocatable address has been converted to OUT_RAWDATA by |
| * then. |
| */ |
| void (*output)(const struct out_data *data); |
| |
| /* |
| * Called to send a text line to the listing generator. The |
| * `int' parameter is LIST_READ or LIST_MACRO depending on |
| * whether the line came directly from an input file or is the |
| * result of a multi-line macro expansion. |
| */ |
| void (*line)(int type, char *line); |
| |
| /* |
| * Called to change one of the various levelled mechanisms in |
| * the listing generator. LIST_INCLUDE and LIST_MACRO can be |
| * used to increase the nesting level of include files and |
| * macro expansions; LIST_TIMES and LIST_INCBIN switch on the |
| * two binary-output-suppression mechanisms for large-scale |
| * pseudo-instructions. |
| * |
| * LIST_MACRO_NOLIST is synonymous with LIST_MACRO except that |
| * it indicates the beginning of the expansion of a `nolist' |
| * macro, so anything under that level won't be expanded unless |
| * it includes another file. |
| */ |
| void (*uplevel)(int type); |
| |
| /* |
| * Reverse the effects of uplevel. |
| */ |
| void (*downlevel)(int type); |
| |
| /* |
| * Called on a warning or error, with the error message. |
| */ |
| void (*error)(int severity, const char *pfx, const char *msg); |
| |
| /* |
| * Update the current offset. Used to give the listing generator |
| * an offset to work with when doing things like |
| * uplevel(LIST_TIMES) or uplevel(LIST_INCBIN); see |
| * list_set_offset(); |
| */ |
| void (*set_offset)(uint64_t offset); |
| }; |
| |
| extern const struct lfmt *lfmt; |
| extern bool user_nolist; |
| |
| #endif |