fixed indentation
[libfirm] / ir / common / firm.h
index f6e2ed2..8792cd4 100644 (file)
 *
 */
 
-# ifndef _FIRM_H_
-# define _FIRM_H_
+#ifndef _FIRM_H_
+#define _FIRM_H_
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /* The representations */
-# include "firm_common.h"/* common type tags. */
-# include "irprog.h"     /* control flow and data of a program */
-# include "type.h"       /* type representation */
-# include "entity.h"     /* entity representation */
-# include "tv.h"         /* target values */
-# include "ident.h"      /* source code identificators */
+#include "firm_common.h"   /* common type tags. */
+#include "irprog.h"        /* control flow and data of a program */
+#include "type.h"          /* type representation */
+#include "entity.h"        /* entity representation */
+#include "tv.h"            /* target values */
+#include "ident.h"         /* source code identificators */
 /* Functionality */
-# include "ircons.h"     /* construct ir */
-# include "ircgcons.h"   /* construct interprocedural graph */
-
-# include "irflag.h"     /* optimization flags */
-# include "irgopt.h"     /* optimize ir */
-  /* # include "tailrec.h"*/    /* optimize tail-recursion calls */
-# include "ircgopt.h"    /* Optimizations based on interprocedural graph */
-
-# include "irouts.h"     /* Graph reversal / out edges. */
-# include "irdom.h"      /* Dominator analysis */
-# include "cgana.h"      /* Analysis to construct interprocedural graph */
-                         /* including some optimizations */
-# include "irloop.h"     /* loop and backedge analysis */
-
-# include "irgmod.h"     /* Support to modify ir */
-# include "irgwalk.h"    /* Support to walk ir */
-# include "typewalk.h"   /* Support to walk type information */
-# include "typegmod.h"   /* Support to modify type graph */
-# include "mangle.h"     /* Support for mangling ident names. */
+#include "ircons.h"        /* construct ir */
+#include "ircgcons.h"      /* construct interprocedural graph */
+
+#include "irflag.h"        /* optimization flags */
+#include "irgopt.h"        /* optimize ir */
+#include "reassoc.h"       /* optimize ir by reassociation */
+#include "ldstopt.h"       /* optimize Load/Store */
+#include "cfopt.h"         /* optimize control flow */
+#include "tailrec.h"       /* optimize tail-recursion calls */
+#include "ircgopt.h"       /* Optimizations based on interprocedural graph */
+#include "strength_red.h"  /* Strength reduction */
+
+#include "irouts.h"        /* Graph reversal / out edges. */
+#include "irdom.h"         /* Dominator analysis */
+#include "cgana.h"         /* Analysis to construct interprocedural graph */
+                           /* including some optimizations */
+#include "irloop.h"        /* loop and backedge analysis */
+#include "callgraph.h"     /* Callgraph construction */
+
+#include "irgmod.h"        /* Support to modify ir */
+#include "irgwalk.h"       /* Support to walk ir */
+#include "typewalk.h"      /* Support to walk type information */
+#include "typegmod.h"      /* Support to modify type graph */
+#include "type_identify.h" /* Support for type identification */
+#include "mangle.h"        /* Support for mangling ident names. */
+
+#include "irarch.h"        /* architecture dependant optimizations */
+//#include "modeconv.h"      /* architecture dependant mode conversion */
+
+#include "firmstat.h"      /* statistics */
+
+#include "irreflect.h"     /* reflection */
+
 
 /* @@@ temporarily for jni builder until preprocessor works.
    Then it should be sufficient to include <file.h> instead
-   of firm.h as not all enums are needed in the impelmentation
+   of firm.h as not all enums are needed in the implementation
    files. */
-# include "irdump.h"
-# include "irvrfy.h"
+#include "irdump.h"
+#include "irprintf.h"
+#include "irvrfy.h"
+#include "trvrfy.h"
+
+#include "irarch.h"
+
+/* Makros that define the old function names we decided to rename.
+   Use for compatibility with old implementations. */
+#include "old_fctnames.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 either insert a default value,
+   * or raise a compiler error/warning.
+   */
+  default_initialize_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
+   * 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 factory function for the architecture dependent
+        * optimizations.
+        */
+
+};
+
+
+typedef struct _firm_parameter_t firm_parameter_t;
+
+
 
 /**
  * Initialize the firm library.
@@ -110,7 +181,7 @@ extern "C" {
  * Initializes the firm library.  Allocates default data structures.
  * Initializes configurable behaviour of the library.
  *
- * @param func    This function is called, whenever a local variable is
+ * @param param    This function is called, whenever a local variable is
  * used before definition.  The function should either insert a default value,
  * or raise a compiler error.
  *
@@ -119,15 +190,15 @@ extern "C" {
  *
  * @see default_initialize_local_variable_func_t
  */
-void init_firm (default_initialize_local_variable_func_t *func);
+void init_firm(const firm_parameter_t *params);
 
 /**
  * Frees all memory occupied by the firm library.
  */
-void free_firm (void);
+void free_firm(void);
 
 #ifdef __cplusplus
 }
 #endif
 
-# endif /* _FIRM_H_ */
+#endif /* _FIRM_H_ */