Parted common.h into two files common_t.h. By this config.h

[libfirm] / ir / ir / irprog.h

diff --git a/ir/ir/irprog.h b/ir/ir/irprog.h
index 166dfdb..296c434 100644 (file)
--- a/ir/ir/irprog.h
+++ b/ir/ir/irprog.h
@@ -15,39 +15,52 @@
 **   - (An obstack containing global things, e.g., the above mentioned lists.)
 */
 
+/* $Id$ */
+
 # ifndef _IRPROG_H_
 # define _IRPROG_H_
 
 # include "irnode.h"
 # include "type.h"
 
-struct ir_prog {
-  firm_kind kind;
-  ir_graph *main_irg;              /* entry point to the compiled program */
-                  /* or a list, in case we compile a library or the like? */
-  ir_graph **graphs;               /* all graphs in the ir */
-  type_class *glob_type;           /* global type.  Class as it can have
-                                     fields and procedures.  Does this work?
-                                     Better name??? @@@ */
-  type **types;                    /* all types in the ir */
-  /*struct obstack *obst;          * @@@ Should we place all types and
-                                      entities on an obstack, too? */
-#ifdef DEBUG_libfirm
-  long max_node_nr;                /* to generate unique numbers for nodes. */
-#endif
-};
+/***** irprog/irprog
+ *
+ * NAME  Datastructure that holds central information about a program
+ *
+ * NOTE  Preliminary documentation ;-)
+ *
+ * SOURCE
+ */
 
+/***s* irprog/irprog
+ *
+ * NAME  Datastructure that holds central information about a program
+ *
+ * NOTE  Preliminary documentation ;-)
+ *
+ * FIELDS
+ *  main_irg  The ir graph that is the entry point to the program.
+ *            (Anything not reachable from here may be optimized away.
+ *            If we want to translate libraries or the like correctly
+ *            we must replace this by a list.)
+ *  irg       List of all ir graphs in the program.
+ *  type      A list containing all types known to the translated program.
+ *            Some types can have several entries in this list (as a result of
+ *            using exchange_types()).
+ *  glob_type The unique global type that is owner of all global entities.
+ *
+ * SOURCE
+ */
 typedef struct ir_prog ir_prog;
 
 /* A variable from where everything in the ir can be accessed. */
-ir_prog *irp;
-
+extern ir_prog *irp;
 
-/* initializes ir_prog. Calles the constructor for an ir_prog. */
+/* initializes ir_prog. Calls the constructor for an ir_prog. */
 void init_irprog(void);
 
 /* Creates a new ir_prog, returns it and sets irp with it.
-   Automatically called by init_firm through init_irprog. */
+   Automatically called by init_firm through init_irprog.  */
 ir_prog *new_ir_prog (void);
 
 /* Access the main routine of the compiled program. */
@@ -56,6 +69,9 @@ void      set_irp_main_irg(ir_graph *main_irg);
 
 /* Adds irg to the list of ir graphs in irp. */
 void      add_irp_irg(ir_graph *irg);
+/* Removes irg from the list or irgs, shrinks the list by one.
+   @@@ does not work properly. */
+void      remove_irp_irg(ir_graph *irg);
 int       get_irp_n_irgs();
 ir_graph *get_irp_irg(int pos);
 void      set_irp_irg(int pos, ir_graph *irg);
@@ -67,11 +83,21 @@ type *get_irp_type(int pos);
 void  set_irp_type(int pos, type *typ);
 
 /** Functions to access the fields of ir_prog **/
-type_class *get_glob_type(void);
+type *get_glob_type(void);
+
+/*****/
 
-#ifdef DEBUG_libfirm
-/* Returns a new, unique number to number nodes or the like. */
-int get_irp_new_node_nr();
-#endif
+/***p* irprog/get_const_code_irg
+ *
+ * NAME
+ *   get_const_code_irg - Returns an irgraph that only contains constant
+ *   expressions for constant entities.
+ * SYNOPSIS
+ *   ir_graph *get_const_code_irg();
+ * NOTE
+ *   Do not use any access function for this graph, do not generate code
+ *   for this graph.
+ */
+ir_graph *get_const_code_irg();
 
 #endif /* ifndef _IRPROG_H_ */