2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Interface for assembler output.
23 * @author Matthias Braun
27 * This is a framework for emitting data (usually the final assembly code)
29 #ifndef FIRM_BE_BEEMITTER_H
30 #define FIRM_BE_BEEMITTER_H
32 #include "firm_config.h"
36 #include "firm_types.h"
40 /* don't use the following vars directly, they're only here for the inlines */
41 extern FILE *emit_file;
42 extern struct obstack emit_obst;
43 extern int emit_linelength;
46 * Emit a character to the (assembler) output.
48 * @param env the emitter environment
50 static INLINE void be_emit_char(char c)
52 obstack_1grow(&emit_obst, c);
57 * Emit a string to the (assembler) output.
59 * @param env the emitter environment
60 * @param str the string
61 * @param l the length of the given string
63 static INLINE void be_emit_string_len(const char *str, size_t l)
65 obstack_grow(&emit_obst, str, l);
70 * Emit a null-terminated string to the (assembler) output.
72 * @param env the emitter environment
73 * @param str the null-terminated string
75 static INLINE void be_emit_string(const char *str)
77 size_t len = strlen(str);
78 be_emit_string_len(str, len);
82 * Emit a C string-constant to the (assembler) output.
84 * @param env the emitter environment
85 * @param str the null-terminated string constant
87 #define be_emit_cstring(str) \
88 do { be_emit_string_len(str, sizeof(str)-1); } while(0)
91 * Initializes an emitter environment.
93 * @param env the (uninitialized) emitter environment
94 * @param F a file handle where the emitted file is written to.
96 void be_emit_init(FILE *F);
99 * Destroys the given emitter environment.
101 * @param env the emitter environment
103 void be_emit_exit(void);
106 * Emit an ident to the (assembler) output.
108 * @param env the emitter environment
109 * @param id the ident to be emitted
111 void be_emit_ident(ident *id);
114 * Emit a firm tarval.
116 * @param env the emitter environment
117 * @param tv the tarval to be emitted
119 void be_emit_tarval(tarval *tv);
122 * Emit the output of an ir_printf.
124 * @param env the emitter environment
125 * @param fmt the ir_printf format
127 void be_emit_irprintf(const char *fmt, ...);
130 * Emit the output of an ir_vprintf.
132 * @param env the emitter environment
133 * @param fmt the ir_printf format
135 void be_emit_irvprintf(const char *fmt, va_list args);
138 * Flush the line in the current line buffer to the emitter file.
140 * @param env the emitter environment
142 void be_emit_write_line(void);
145 * Flush the line in the current line buffer to the emitter file and
146 * appends a gas-style comment with the node number and writes the line
148 * @param env the emitter environment
149 * @param node the node to get the debug info from
151 void be_emit_finish_line_gas(const ir_node *node);
154 * Emit spaces until the comment position is reached.
156 * @param env the emitter environment
158 void be_emit_pad_comment(void);