irop_flag_highlevel flag added to Confirm and Cast

[libfirm] / ir / ir / irgraph.h

diff --git a/ir/ir/irgraph.h b/ir/ir/irgraph.h
index 17d3ce4..2858d66 100644 (file)
--- a/ir/ir/irgraph.h
+++ b/ir/ir/irgraph.h
@@ -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 */
@@ -83,7 +82,7 @@ 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.
+ *      *proj_args        The proj nodes of the args node.
  *
  *      *bad             The Bad node is an auxiliary node. It is needed only once,
  *                       so there is this globally reachable node.
@@ -250,9 +249,9 @@ 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. */
+/** Returns an array of the nodes of the argument pointer. */
 ir_node **get_irg_proj_args (const ir_graph *irg);
-/** Sets the array of the nodes off the argument pointer. */
+/** Sets the array of the nodes of the argument pointer. */
 void     set_irg_proj_args (ir_graph *irg, ir_node **nodes);
 
 /** Returns the current block of a graph. */
@@ -320,19 +319,16 @@ void set_irg_phase_low(ir_graph *irg);
 op_pin_state get_irg_pinned (const ir_graph *irg);
 
 /** state: outs_state
-   Outs are the back edges or def-use edges.
-   Values:  outs_none, outs_consistent, outs_inconsistent
-   outs_none: outs are not computed, no memory is allocated.
-   outs_consistent:  outs are computed and correct,
-   outs_inconsistent: outs have been computed, memory is still allocated,
-   but the graph has been changed since. */
+ *  Outs are the back edges or def-use edges of ir nodes.
+ *  Values:  outs_none, outs_consistent, outs_inconsistent */
 typedef enum {
-  outs_none,
-  outs_consistent,
-  outs_inconsistent
+  outs_none,         /**< Outs are not computed, no memory is allocated. */
+  outs_consistent,   /**< Outs are computed and correct. */
+  outs_inconsistent  /**< Outs have been computed, memory is still allocated,
+                       but the graph has been changed since. */
 } irg_outs_state;
 irg_outs_state get_irg_outs_state(const ir_graph *irg);
-void set_irg_outs_inconsistent(ir_graph *irg);
+void           set_irg_outs_inconsistent(ir_graph *irg);
 
 /** state: dom_state
    Signals the state of the dominator infomation.
@@ -356,8 +352,9 @@ irg_dom_state get_irg_dom_state(const ir_graph *irg);
 void set_irg_dom_inconsistent(ir_graph *irg);
 
 /** state: loopinfo_state
-   Loop information describes the loops within the control and
-   data flow of the procedure.  */
+ *  Loop information describes the loops within the control and
+ *  data flow of the procedure.
+ */
 typedef enum {
   loopinfo_none             = 0,       /**< No loop information is constructed. Default. */
   loopinfo_constructed      = 1,       /**< Some kind of loop information is constructed. */
@@ -369,7 +366,7 @@ typedef enum {
                       are used in a switch. */
 
   /** IntRAprocedural loop information constructed and valid. */
-  loopinfo_consistent         = loopinfo_constructed | loopinfo_valid,
+  loopinfo_consistent         = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
   /** IntRAprocedural loop information constructed and invalid. */
   loopinfo_inconsistent       = loopinfo_constructed | loopinfo_for_firmjni,
 
@@ -389,9 +386,13 @@ typedef enum {
   loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
 } irg_loopinfo_state;
 
+/** Return the current loop information state. */
 irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
+
+/** Sets the current loop information state. */
 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
-/** Sets the loopinformation state to the appropriate inconsistent state.
+
+/** Sets the loop information state to the appropriate inconsistent state.
    If state is 'none' does not change. */
 void set_irg_loopinfo_inconsistent(ir_graph *irg);
 
@@ -433,15 +434,19 @@ void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
 void  set_irg_link (ir_graph *irg, void *thing);
 void *get_irg_link (const ir_graph *irg);
 
-/** increments visited by one */
+/** Increments visited flag by one.
+ *  @see also: get_irn_visited() get_irg_block_visited(). */
 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);
+/** An interprocedural flag valid for all irgs.
+ *  @see also: get_irn_visited() get_irg_block_visited(). */
 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.
+ *  @see also: get_irn_visited() get_irg_block_visited(). */
 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);