- add a cast to suppress DEL_ARR_F() warnings when compiled with MSVC
[libfirm] / include / libfirm / irprog.h
index cd10c38..01aefdb 100644 (file)
@@ -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.
  *
  * @date    2000
  * @version $Id$
  * @summary
- *  ir representation of a program.
+ *  Intermediate Representation (IR) of a program.
  *
  *  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 contais all global variables and procedures that do
+ *   - A global type that contains 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).
 #include "firm_types.h"
 #include "irgraph.h"
 
+typedef enum ir_segment_t {
+       /** "normal" global data */
+       IR_SEGMENT_GLOBAL,
+       /** thread local storage segment */
+       IR_SEGMENT_THREAD_LOCAL,
+       /**
+        * the constructors segment. Contains pointers to functions which are
+        * executed on module initialization (program start or when a library is
+        * dynamically loaded)
+        */
+       IR_SEGMENT_CONSTRUCTORS,
+       /** like constructors, but functions are executed on module exit */
+       IR_SEGMENT_DESTRUCTORS,
+
+       IR_SEGMENT_COUNT
+} ir_segment_t;
 
 /**
  * Datastructure that holds central information about a program
@@ -85,18 +101,18 @@ ir_prog *get_irp(void);
 
 /** Creates a new ir_prog, returns it and sets irp with it.
  *  Automatically called by init_firm() through init_irprog. */
-ir_prog *new_ir_prog (void);
+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);
+void free_ir_prog(void);
 
 /** Sets the file name / executable name or the like. Initially the
     ident 'no_name_set'. */
-void   set_irp_prog_name (ident *name);
+void set_irp_prog_name(ident *name);
 
 /** Returns true if the user ever set a program name */
-int    irp_prog_name_is_set(void);
+int irp_prog_name_is_set(void);
 
 /** Gets the file name / executable name or the like.
  */
@@ -110,37 +126,46 @@ const char *get_irp_prog_name (void);
 ir_graph *get_irp_main_irg(void);
 
 /** Sets the main routine of the compiled program. */
-void      set_irp_main_irg(ir_graph *main_irg);
+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);
+void add_irp_irg(ir_graph *irg);
 
 /** Removes irg from the list of irgs and
     shrinks the list by one. */
-void      remove_irp_irg_from_list(ir_graph *irg);
+void remove_irp_irg_from_list(ir_graph *irg);
 /** Removes irg from the list of irgs, deallocates it and
     shrinks the list by one. */
-void      remove_irp_irg(ir_graph *irg);
+void remove_irp_irg(ir_graph *irg);
+
+/** returns the biggest not used irg index number */
+int get_irp_last_idx(void);
 
 /** Returns the number of ir graphs in the irp. */
-int       get_irp_n_irgs(void);
+int get_irp_n_irgs(void);
 
 /** Returns the ir graph at position pos in the irp. */
 ir_graph *get_irp_irg(int pos);
 
 /** Sets the ir graph at position pos. */
-void      set_irp_irg(int pos, ir_graph *irg);
+void set_irp_irg(int pos, ir_graph *irg);
 
 /** Gets the number of graphs _and_ pseudo graphs. */
-int       get_irp_n_allirgs(void);
+int get_irp_n_allirgs(void);
 
 /** Returns the ir graph at position pos of all graphs (including
  pseudo graphs).  Visits first graphs, then pseudo graphs. */
 ir_graph *get_irp_allirg(int pos);
 
+/**
+ * returns the type containing the entities for a segment
+ */
+ir_type *get_segment_type(ir_segment_t segment);
+
 /**
  * Returns the "global" type of the irp.
  * Upon creation this is an empty class type.
+ * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL)
  */
 ir_type *get_glob_type(void);
 
@@ -151,42 +176,42 @@ ir_type *get_glob_type(void);
 ir_type *get_tls_type(void);
 
 /** Adds type to the list of types in irp. */
-void  add_irp_type(ir_type *typ);
+void add_irp_type(ir_type *typ);
 
 /** Removes type from the list of types, deallocates it and
     shrinks the list by one. */
-void  remove_irp_type(ir_type *typ);
+void remove_irp_type(ir_type *typ);
 
 /** Returns the number of all types in the irp. */
-int   get_irp_n_types(void);
+int get_irp_n_types(void);
 
 /** Returns the type at position pos in the irp. */
 ir_type *get_irp_type(int pos);
 
 /** Overwrites the type at position pos with another type. */
-void  set_irp_type(int pos, ir_type *typ);
+void set_irp_type(int pos, ir_type *typ);
 
 /** Returns the number of all modes in the irp. */
-int   get_irp_n_modes(void);
+int get_irp_n_modes(void);
 
 /** Returns the mode at position pos in the irp. */
 ir_mode *get_irp_mode(int pos);
 
 /** Adds opcode to the list of opcodes in irp. */
-void  add_irp_opcode(ir_op *opcode);
+void add_irp_opcode(ir_op *opcode);
 
 /** Removes opcode from the list of opcodes, deallocates it and
     shrinks the list by one. */
-void  remove_irp_opcode(ir_op *opcode);
+void remove_irp_opcode(ir_op *opcode);
 
 /** Returns the number of all opcodes in the irp. */
-int   get_irp_n_opcodes(void);
+int get_irp_n_opcodes(void);
 
 /** Returns the opcode at position pos in the irp. */
 ir_op *get_irp_opcode(int pos);
 
 /** Sets the generic function pointer of all opcodes to NULL */
-void  clear_irp_opcodes_generic_func(void);
+void clear_irp_opcodes_generic_func(void);
 
 
 /**  Return the graph for global constants.
@@ -221,4 +246,19 @@ 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);
 
+/** Returns a new, unique exception region number. */
+ir_exc_region_t get_irp_next_region_nr(void);
+
+/** Returns a new, unique label number. */
+ir_label_t get_irp_next_label_nr(void);
+
+/** Add a new global asm include. */
+void add_irp_asm(ident *asm_string);
+
+/** Return the number of global asm includes. */
+int get_irp_n_asms(void);
+
+/** Return the global asm include at position pos. */
+ident *get_irp_asm(int pos);
+
 #endif