remove irg_phase_state, use IR_GRAPH_CONSTRAINT instead
[libfirm] / include / libfirm / firm_common.h
index db88412..52645b3 100644 (file)
  * @file
  * @brief    common firm declarations
  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier
- * @version  $Id$
  */
 #ifndef FIRM_COMMON_FIRM_COMMON_H
 #define FIRM_COMMON_FIRM_COMMON_H
 
 #include "firm_types.h"
+#include "begin.h"
 
 /**
- * libFirm initialization parameters.
- */
-struct _firm_parameter_t {
-  /**
-   * The size of this structure. init_firm() will only initialize
-   * this amount of data. This allows to add more fields to this structure
-   * without breaking compatibility to older source.
-   */
-  unsigned int size;
-
-  /**
-   * Statistic options. If statistic function where enabled, these
-   * flags configure it, see enum firmstat_options_t.
-   */
-  unsigned enable_statistics;
-
-  /**
-   * This function is called, whenever a local variable is
-   * used before definition. The function should insert a default value,
-   * and/or raise a compiler error/warning. Note that returning
-   * an Unknown is allowed here.
-   */
-  uninitialized_local_variable_func_t *initialize_local_func;
-
-  /**
-   * The interface functions for the type identification module.
-   * If not set, the default implementation with compare_strict() and
-   * firm_hash_name() will be used.
-   */
-  type_identify_if_t *ti_if;
-
-  /**
-   * The interface for the ident module.
-   * If not set, the default libFirm ident module (using hash sets).
-   */
-  ident_if_t *id_if;
-
-  /**
-   * The default calling convention.
-   */
-  unsigned cc_mask;
-
-  /**
-   * The debug info that should be used for "builtin" objects.
-   */
-  dbg_info *builtin_dbg;
-};
-
-typedef struct _firm_parameter_t firm_parameter_t;
-
-/**
- * Initialize the firm library.
- *
  * Initializes the firm library.  Allocates default data structures.
- * Initializes configurable behavior of the library.
- *
- * @param params   A structure containing the parameters of the libFirm.
- *
- * The parameter struct may be NULL. In that case, the original FIRM behavior
- * is conserved.
  */
-void ir_init(const firm_parameter_t *params);
+FIRM_API void ir_init(void);
 
 /**
  * Frees all memory occupied by the firm library.
  */
-void ir_finish(void);
+FIRM_API void ir_finish(void);
 
 /** returns the libFirm major version number */
-unsigned ir_get_version_major(void);
+FIRM_API unsigned ir_get_version_major(void);
 /** returns libFirm minor version number */
-unsigned ir_get_version_minor(void);
+FIRM_API unsigned ir_get_version_minor(void);
 /** returns string describing libFirm revision */
-const char *ir_get_version_revision(void);
+FIRM_API const char *ir_get_version_revision(void);
 /** returns string describing libFirm build */
-const char *ir_get_version_build(void);
-
+FIRM_API const char *ir_get_version_build(void);
 
-
-/** a list of firm kinds
- @@@ not all datatypes are tagged yet. */
+/**
+ * a list of firm kinds
+ * Most important datastructures in firm contain a firm_kind field at the
+ * beginning so given void* pointer you can usually still guess the kind
+ * of thing the pointer points to.
+ * This is used in debug helper functions and printers.
+ */
 typedef enum {
        k_BAD = 0,                /**< An invalid firm node. */
        k_entity,                 /**< An entity. */
@@ -120,10 +64,7 @@ typedef enum {
        k_ir_op,                  /**< An IR opcode. */
        k_tarval,                 /**< A tarval. */
        k_ir_loop,                /**< A loop. */
-       k_ir_compound_graph_path, /**< A compound graph path, see entity.h. */
-       k_ir_extblk,              /**< An extended basic block. */
        k_ir_prog,                /**< A program representation (irp). */
-       k_ir_region,              /**< A region. */
        k_ir_graph_pass,          /**< An ir_graph pass. */
        k_ir_prog_pass,           /**< An ir_prog pass. */
        k_ir_graph_pass_mgr,      /**< An ir_graph pass manager. */
@@ -136,12 +77,8 @@ typedef enum {
  *
  * @param firm_thing  pointer representing a firm object
  */
-firm_kind get_kind(const void *firm_thing);
-
-/** Returns the kind of a thing as a string. */
-const char *print_firm_kind(void *firm_thing);
+FIRM_API firm_kind get_kind(const void *firm_thing);
 
-/** Print an identification of a firm thing. */
-void firm_identify_thing(void *X);
+#include "end.h"
 
 #endif