more status flags

[libfirm] / ir / ir / irprog.h

diff --git a/ir/ir/irprog.h b/ir/ir/irprog.h
index 23ac069..95f4ecc 100644 (file)
--- a/ir/ir/irprog.h
+++ b/ir/ir/irprog.h
@@ -19,12 +19,17 @@
 *
 * This file defines a construct that keeps all information about a
 * program:
+*   - A reference point to the method to be executed on program start.
 *   - A list of all procedures.
 *   - A list of all types.
-*   - A global type that can be thought of as a god-class containing all
-*     global variables and procedures.  This is not the base class of
+*   - A global type that contais all global variables and procedures that do
+*     not belong to a class.  This type represents the data segment of the
+*     program.  It is not the base class of
 *     all classes in a class hierarchy (as, e.g., "object" in java).
-*   - (An obstack containing global things, e.g., the above mentioned lists.)
+*   - A degenerated graph that contains constant expressions.
+*   - interprocedural outs state.
+*   - a flag indicating validity of the interprocedural representation.
+*   - the output file name
 */
 
 # ifndef _IRPROG_H_
@@ -33,6 +38,7 @@
 # include "irnode.h"
 # include "type.h"
 
+
 /**
  * Datastructure that holds central information about a program
  *
@@ -69,13 +75,27 @@ extern ir_prog *irp;
  */
 ir_prog *get_irp(void);
 
-/** 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);
 
+/** frees all memory used by irp.  Types in type list and irgs in irg
+ *  list must be freed by hand before. */
+void     free_ir_prog(void);
+
+/** Sets the file name / executable name or the like. Initially NULL. */
+void   set_irp_prog_name (ident *name);
+
+/** Gets the file name / executable name or the like. Returns NULL if
+ *  not yet set.
+ */
+ident *get_irp_prog_ident(void);
+
+/** Gets the file name / executable name or the like. Returns NULL if
+ *  not yet set.
+ */
+const char *get_irp_prog_name (void);
+
 /** Gets the main routine of the compiled program. */
 ir_graph *get_irp_main_irg(void);
 
@@ -86,7 +106,7 @@ void      set_irp_main_irg(ir_graph *main_irg);
 void      add_irp_irg(ir_graph *irg);
 
 /** Removes irg from the list of irgs, deallocates it and
-   shrinks the list by one. */
+    shrinks the list by one. */
 void      remove_irp_irg(ir_graph *irg);
 
 /** Returns the number of ir graphs in the irp. */
@@ -98,11 +118,15 @@ ir_graph *get_irp_irg(int pos);
 /** Sets the ir graph at position pos. */
 void      set_irp_irg(int pos, ir_graph *irg);
 
+
+/** Returns the "global" type of the irp. */
+type *get_glob_type(void);
+
 /** Adds type to the list of types in irp. */
 void  add_irp_type(type *typ);
 
 /** Removes type from the list of types, deallocates it and
-   shrinks the list by one. */
+    shrinks the list by one. */
 void  remove_irp_type(type *typ);
 
 /** Returns the number of all types in the irp. */
@@ -114,19 +138,24 @@ type *get_irp_type(int pos);
 /** Overwrites the type at position pos with another type. */
 void  set_irp_type(int pos, type *typ);
 
-/** Returns the "global" type of the irp. */
-type *get_glob_type(void);
-
-
-/**
- *   Returns an irgraph that only contains constant
+/**  Return the graph for global constants.
  *
- *   expressions for constant entities.
- *   Do not use any access function for this graph, do not generate code
- *   for this graph.  This graph contains only one block.  The constant
- *   expressions may not contain control flow.  See also copy_const_code()
- *   in entity.h.
+ *   Returns an irgraph that only contains constant expressions for
+ *   constant entities.  Do not use any access function for this
+ *   graph, do not generate code for this graph.  This graph contains
+ *   only one block.  The constant expressions may not contain control
+ *   flow.
+ *   Walking the graph starting from any node will not reach the block
+ *   or any controlflow.
+ *   See also copy_const_code() in entity.h.
  */
 ir_graph *get_const_code_irg(void);
 
+irg_outs_state get_irp_ip_outs_state(void);
+void           set_irp_ip_outs_inconsistent(void);
+
+
+irg_callee_info_state get_irp_callee_info_state(void);
+void                  set_irp_callee_info_state(irg_callee_info_state s);
+
 #endif /* ifndef _IRPROG_H_ */