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
32 #include "firm_types.h"
36 /* framework for emitting data (usually the final assembly code) */
38 /** The emitter environment. */
39 typedef struct be_emit_env_t {
40 FILE *F; /**< The handle of the (assembler) file that is written to. */
41 struct obstack obst; /**< An obstack for temporary storage. */
42 int linelength; /**< The length of the current line. */
45 #define NULL_EMITTER { NULL, NULL_OBST, 0 }
48 * Emit a character to the (assembler) output.
50 * @param env the emitter environment
52 static INLINE void be_emit_char(be_emit_env_t *env, char c) {
53 obstack_1grow(&env->obst, c);
58 * Emit a string to the (assembler) output.
60 * @param env the emitter environment
61 * @param str the string
62 * @param l the length of the given string
64 static INLINE void be_emit_string_len(be_emit_env_t *env, const char *str,
67 obstack_grow(&env->obst, str, l);
72 * Emit a null-terminated string to the (assembler) output.
74 * @param env the emitter environment
75 * @param str the null-terminated string
77 static INLINE void be_emit_string(be_emit_env_t *env, const char *str)
79 size_t len = strlen(str);
80 be_emit_string_len(env, str, len);
84 * Emit a C string-constant to the (assembler) output.
86 * @param env the emitter environment
87 * @param str the null-terminated string constant
89 #define be_emit_cstring(env, str) do { be_emit_string_len(env, str, sizeof(str)-1); } while(0)
92 * Initializes an emitter environment.
94 * @param env the (uninitialized) emitter environment
95 * @param F a file handle where the emitted file is written to.
97 void be_emit_init_env(be_emit_env_t *env, FILE *F);
100 * Destroys the given emitter environment.
102 * @param env the emitter environment
104 void be_emit_destroy_env(be_emit_env_t *env);
107 * Emit an ident to the (assembler) output.
109 * @param env the emitter environment
110 * @param id the ident to be emitted
112 void be_emit_ident(be_emit_env_t *env, ident *id);
115 * Emit a firm tarval.
117 * @param env the emitter environment
118 * @param tv the tarval to be emitted
120 void be_emit_tarval(be_emit_env_t *env, tarval *tv);
123 * Emit the output of an ir_printf.
125 * @param env the emitter environment
126 * @param fmt the ir_printf format
128 void be_emit_irprintf(be_emit_env_t *env, const char *fmt, ...);
131 * Emit the output of an ir_vprintf.
133 * @param env the emitter environment
134 * @param fmt the ir_printf format
136 void be_emit_irvprintf(be_emit_env_t *env, const char *fmt, va_list args);
139 * Flush the line in the current line buffer to the emitter file.
141 * @param env the emitter environment
143 void be_emit_write_line(be_emit_env_t *env);
146 * Flush the line in the current line buffer to the emitter file and
147 * appends a gas-style comment with the node number and writes the line
149 * @param env the emitter environment
150 * @param node the node to get the debug info from
152 void be_emit_finish_line_gas(be_emit_env_t *env, const ir_node *node);
155 * Emit spaces until the comment position is reached.
157 * @param env the emitter environment
159 void be_emit_pad_comment(be_emit_env_t *env);
161 #endif /* FIRM_BE_BEEMITTER_H */