renamed function to be_gas_label_prefix()

[libfirm] / ir / be / begnuas.h

diff --git a/ir/be/begnuas.h b/ir/be/begnuas.h
index 53f853f..ecfbdb0 100644 (file)
--- a/ir/be/begnuas.h
+++ b/ir/be/begnuas.h
@@ -1,10 +1,31 @@
+/*
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
 /**
- * Header for ia32 assembler declarations dumper.
- * @author Christian Wuerdig, Matthias Braun
- * $Id$
+ * @file
+ * @brief       Dumps global variables and constants as gas assembler.
+ * @author      Christian Wuerdig, Matthias Braun
+ * @date        04.11.2005
+ * @version     $Id$
  */
-#ifndef _BE_GEN_DECLS_H_
-#define _BE_GEN_DECLS_H_
+#ifndef FIRM_BE_BEGNUAS_H
+#define FIRM_BE_BEGNUAS_H
 
 #include "be.h"
 #include "beemitter.h"
@@ -22,20 +43,40 @@ typedef enum section_t {
        GAS_SECTION_MAX    = 6
 } be_gas_section_t;
 
+/**
+ * Support for some GAS "dialects".
+ */
 typedef enum asm_flavour_t {
-       GAS_FLAVOUR_NORMAL = 0,  /**< normal gas */
-       GAS_FLAVOUR_MINGW  = 1,  /**< MinGW variant */
+       GAS_FLAVOUR_NORMAL = 0,  /**< normal gas (ELF) */
+       GAS_FLAVOUR_MINGW  = 1,  /**< MinGW variant (no-ELF) */
        GAS_FLAVOUR_MAX    = 2
 } be_gas_flavour_t;
 
+/** The variable where the GAS dialect is stored. */
 extern be_gas_flavour_t be_gas_flavour;
 
-
 /**
  * Generate all entities.
+ * @param env               the emitter environment
+ * @param main_env          the main backend environment
+ * @param emit_commons      if non-zero, emit commons (non-local uninitialized entities)
+ * @param only_emit_marked  if non-zero, external allocated entities that do not have
+ *                          its visited flag set are ignored
  */
-void be_gas_emit_decls(be_emit_env_t *env, const be_main_env_t *main_env);
+void be_gas_emit_decls(be_emit_env_t *env, const be_main_env_t *main_env,
+                       int only_emit_marked_entities);
 
+/**
+ * Switch the current output section to the given out.
+ *
+ * @param env      the emitter environment
+ * @param section  the new output section
+ */
 void be_gas_emit_switch_section(be_emit_env_t *env, be_gas_section_t section);
 
-#endif
+/**
+ * Return the label prefix for labeled blocks.
+ */
+const char *be_gas_label_prefix(void);
+
+#endif /* FIRM_BE_BEGNUAS_H */