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 #ifndef FIRM_BE_BEEMITTER_H
28 #define FIRM_BE_BEEMITTER_H
37 /* framework for emitting data (usually the final assembly code) */
39 /** The emitter environment. */
40 typedef struct be_emit_env_t {
41 FILE *F; /**< The handle of the (assembler) file that is written to. */
42 struct obstack obst; /**< An obstack for temporary storage. */
43 int linelength; /**< The length of the current line. */
47 * Emit a character to the (assembler) output.
49 * @param env the emitter environment
51 static INLINE void be_emit_char(be_emit_env_t *env, char c) {
52 obstack_1grow(&env->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(be_emit_env_t *env, const char *str,
66 obstack_grow(&env->obst, str, l);
71 * Emit a null-terminated string to the (assembler) output.
73 * @param env the emitter environment
74 * @param str the null-terminated string
76 static INLINE void be_emit_string(be_emit_env_t *env, const char *str)
78 size_t len = strlen(str);
79 be_emit_string_len(env, str, len);
83 * Emit a C string-constant to the (assembler) output.
85 * @param env the emitter environment
86 * @param str the null-terminated string constant
88 #define be_emit_cstring(env, str) { be_emit_string_len(env, str, sizeof(str)-1); }
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_env(be_emit_env_t *env, FILE *F);
99 * Destroys the given emitter environment.
101 * @param env the emitter environment
103 void be_emit_destroy_env(be_emit_env_t *env);
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(be_emit_env_t *env, ident *id);
114 * Emit the output of an ir_printf.
116 * @param env the emitter environment
117 * @param fmt the ir_printf format
119 void be_emit_irprintf(be_emit_env_t *env, const char *fmt, ...);
122 * Emit the output of an ir_vprintf.
124 * @param env the emitter environment
125 * @param fmt the ir_printf format
127 void be_emit_irvprintf(be_emit_env_t *env, const char *fmt, va_list args);
130 * Flush the line in the current line buffer to the emitter file.
132 * @param env the emitter environment
134 void be_emit_write_line(be_emit_env_t *env);
137 * Flush the line in the current line buffer to the emitter file and
138 * appends a gas-style comment with the node number and writes the line
140 * @param env the emitter environment
141 * @param node the node to get the debug info from
143 void be_emit_finish_line_gas(be_emit_env_t *env, const ir_node *node);
146 * Emit spaces until the comment position is reached.
148 * @param env the emitter environment
150 void be_emit_pad_comment(be_emit_env_t *env);
152 #endif /* FIRM_BE_BEEMITTER_H */