fixed a warning regarding const
[libfirm] / ir / ir / irgraph.h
index 354b194..65e40fe 100644 (file)
@@ -24,7 +24,6 @@
 
 # ifndef _IRGRAPH_H_
 # define _IRGRAPH_H_
-# include "tv.h"
 # include "entity.h"
 
 /* to resolve recursion between irnode.h and irgraph.h */
@@ -40,7 +39,7 @@ typedef struct ir_graph ir_graph;
 #endif
 
 /**
- * @page ir_graph      The struct ir_graph
+ * @page ir_graph   The struct ir_graph
  *
  *      This struct contains all information about a procedure.
  *      It's allocated directly to memory.
@@ -83,6 +82,8 @@ typedef struct ir_graph ir_graph;
  *               it's result.  This is a Proj node on the fourth output of
  *               the start node.  This output is tagged as pn_Start_T_args.
  *
+ *      *proj_args        The proj nodes off the args node.
+ *
  *      *bad             The Bad node is an auxiliary node. It is needed only once,
  *                       so there is this globally reachable node.
  *
@@ -248,6 +249,11 @@ ir_node *get_irg_args (const ir_graph *irg);
 /** Sets the node that represents the argument pointer. */
 void     set_irg_args (ir_graph *irg, ir_node *node);
 
+/** Returns an array of the nodes off the argument pointer. */
+ir_node **get_irg_proj_args (const ir_graph *irg);
+/** Sets the array of the nodes off the argument pointer. */
+void     set_irg_proj_args (ir_graph *irg, ir_node **nodes);
+
 /** Returns the current block of a graph. */
 ir_node *get_irg_current_block (const ir_graph *irg);
 /** Sets the current block of a graph. */
@@ -297,7 +303,10 @@ typedef enum {
   phase_low
 } irg_phase_state;
 
+/** returns the phase_state of an IR graph. */
 irg_phase_state get_irg_phase_state (const ir_graph *irg);
+
+/** sets the phase state of an IR graph. */
 void set_irg_phase_low(ir_graph *irg);
 
 /** state: op_pin_state_pinned
@@ -338,7 +347,11 @@ typedef enum {
   dom_consistent,       /**< dominator information is computed and correct */
   dom_inconsistent      /**<  dominator information is computed but the graph has been changed since */
 } irg_dom_state;
+
+/** returns the dom_state of an IR graph. */
 irg_dom_state get_irg_dom_state(const ir_graph *irg);
+
+/** sets the dom_state of an IR graph. */
 void set_irg_dom_inconsistent(ir_graph *irg);
 
 /** state: loopinfo_state
@@ -352,7 +365,7 @@ typedef enum {
   loopinfo_inter            = 8,       /**< Loop information for interprocedural view. */
 
   loopinfo_for_firmjni      = 16,      /**< A hack for firmjni:  all enums must differ as they
-                                         are used in a switch. */
+                      are used in a switch. */
 
   /** IntRAprocedural loop information constructed and valid. */
   loopinfo_consistent         = loopinfo_constructed | loopinfo_valid,
@@ -393,7 +406,11 @@ typedef enum {
   irg_callee_info_consistent,
   irg_callee_info_inconsistent
 } irg_callee_info_state;
+
+/** returns the callee_info_state of an IR graph. */
 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
+
+/** sets the callee_info_state of an IR graph. */
 void                  set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
 
 /** property:
@@ -411,11 +428,11 @@ irg_inline_property get_irg_inline_property(const ir_graph *irg);
 /** Sets the inline property of a graph. */
 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
 
-/** A void * field to link arbritary information to the node. */
+/** A void * field to link arbitrary information to the node. */
 void  set_irg_link (ir_graph *irg, void *thing);
 void *get_irg_link (const ir_graph *irg);
 
-/* increments visited by one */
+/** increments visited by one */
 void          inc_irg_visited (ir_graph *irg);
 unsigned long get_irg_visited (const ir_graph *irg);
 void          set_irg_visited (ir_graph *irg, unsigned long i);
@@ -423,14 +440,20 @@ unsigned long get_max_irg_visited (void);
 void          set_max_irg_visited (int val);
 unsigned long inc_max_irg_visited (void);
 
-/* increments block_visited by one */
+/** increments block_visited by one */
 void          inc_irg_block_visited (ir_graph *irg);
 unsigned long get_irg_block_visited (const ir_graph *irg);
 void          set_irg_block_visited (ir_graph *irg, unsigned long i);
 
-/** put the proj's into the same block as its predecessors */
+/** move Proj nodes into the same block as its predecessors */
 void normalize_proj_nodes(ir_graph *irg);
 
+/** set a description for local value n */
+void set_irg_loc_description(ir_graph *irg, int n, void *description);
+
+/** get the description for local value n */
+void *get_irg_loc_description(ir_graph *irg, int n);
+
 /**
  * Access custom graph data.
  * The data must have been registered with