X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Ffirm_common.h;h=0daa92abf7d782345877678220ab8fa96b2c6ec7;hb=4d64d1d8ea625cc6075a0086671c525a162726a0;hp=48fd85218c96f3b5cfc022e3a51a43d56cb1dd74;hpb=1ec30d95387eb392ba5a1adc7958ebd91383d59c;p=libfirm

diff --git a/include/libfirm/firm_common.h b/include/libfirm/firm_common.h
index 48fd85218..0daa92abf 100644
--- a/include/libfirm/firm_common.h
+++ b/include/libfirm/firm_common.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -26,8 +26,100 @@
 #ifndef FIRM_COMMON_FIRM_COMMON_H
 #define FIRM_COMMON_FIRM_COMMON_H
 
-/** a list of firm kinds
- @@@ not all datatypes are tagged yet. */
+#include "firm_types.h"
+#include "begin.h"
+
+/**
+ * libFirm initialization parameters.
+ * @deprecated
+ */
+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.
+	 * @deprecated  call firm_init_stat(options) instead
+	 */
+	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.
+	 * @deprecated  call ir_set_uninitialized_local_variable_func() instead
+	 */
+	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;
+
+	/**
+	 * dummy parameter
+	 * (this used to hold an identifier module structure)
+	 */
+	void *id_if;
+
+	/**
+	 * dummy parameter
+	 * (this used to hold a default calling convention, but this concept is no
+	 *  more. You should always set the calling convention manually after
+	 *  creating the method entity if you need something else)
+	 */
+	unsigned cc_mask;
+
+	/**
+	 * dummy (here was dbg_info *builtin_dbg before)
+	 */
+	void *dummy;
+};
+
+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   should be NULL (you can pass a structure containing
+ *                 initial parameters but this is deprecated)
+ */
+FIRM_API void ir_init(const firm_parameter_t *params);
+
+/**
+ * Frees all memory occupied by the firm library.
+ */
+FIRM_API void ir_finish(void);
+
+/** returns the libFirm major version number */
+FIRM_API unsigned ir_get_version_major(void);
+/** returns libFirm minor version number */
+FIRM_API unsigned ir_get_version_minor(void);
+/** returns string describing libFirm revision */
+FIRM_API const char *ir_get_version_revision(void);
+/** returns string describing libFirm build */
+FIRM_API const char *ir_get_version_build(void);
+
+
+
+/**
+ * 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. */
@@ -42,6 +134,10 @@ typedef enum {
 	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. */
+	k_ir_prog_pass_mgr,       /**< An ir_prog pass manager. */
 	k_ir_max                  /**< maximum value -- illegal for firm nodes. */
 } firm_kind;
 
@@ -50,12 +146,14 @@ typedef enum {
  *
  * @param firm_thing  pointer representing a firm object
  */
-firm_kind get_kind(const void *firm_thing);
+FIRM_API 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 const char *print_firm_kind(void *firm_thing);
 
 /** Print an identification of a firm thing. */
-void firm_identify_thing(void *X);
+FIRM_API void firm_identify_thing(void *X);
+
+#include "end.h"
 
 #endif