Switch irg index to type size_t, making the API more consistent.
[libfirm] / include / libfirm / irgraph.h
index 91eafb3..97ecbc0 100644 (file)
@@ -76,7 +76,7 @@
  *                   with a Sel node the pointer to a thread local variable.
  *
  * - args            The ir_node that produces the arguments of the method as
- *                   it's result.  This is a Proj node on the fourth output of
+ *                   its 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 of the args node.
@@ -135,15 +135,14 @@ FIRM_API void set_current_ir_graph(ir_graph *graph);
  * represent a procedure in FIRM.
  *
  * It allocates an ir_graph and sets the field irg of the entity ent
- * as well as current_ir_graph to point to this graph.
- * Further it allocates the following nodes needed for every
- * procedure:
+ * to point to this graph. Further it allocates the following nodes needed
+ * for every procedure:
  *
- * - The start block containing a start node and Proj nodes for it's
+ * - The start block containing a start node and Proj nodes for its
  *   seven results (X, M, P, P, P, T, P).
  * - The end block containing an end node. This block is not matured
  *   after executing new_ir_graph() as predecessors need to be added to it.
- *   (Maturing a block means fixing it's number of predecessors.)
+ *   (Maturing a block means fixing its number of predecessors.)
  * - The current block, which is empty and also not matured.
  *
  * Further it enters the global store into the data structure of the start
@@ -228,11 +227,6 @@ FIRM_API ir_node *get_irg_frame(const ir_graph *irg);
 /** Sets the node that represents the frame pointer of the given IR graph. */
 FIRM_API void set_irg_frame(ir_graph *irg, ir_node *node);
 
-/** Returns the node that represents the tls pointer of the given IR graph. */
-FIRM_API ir_node *get_irg_tls(const ir_graph *irg);
-/** Sets the node that represents the tls pointer of the given IR graph. */
-FIRM_API void set_irg_tls(ir_graph *irg, ir_node *node);
-
 /** Returns the node that represents the initial memory of the given IR graph. */
 FIRM_API ir_node *get_irg_initial_mem(const ir_graph *irg);
 /** Sets the node that represents the initial memory of the given IR graph. */
@@ -243,11 +237,6 @@ FIRM_API ir_node *get_irg_args(const ir_graph *irg);
 /** Sets the node that represents the argument pointer of the given IR graph. */
 FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
 
-/** Returns the current block of an IR graph. */
-FIRM_API ir_node *get_irg_current_block(const ir_graph *irg);
-/** Sets the current block of an IR graph. */
-FIRM_API void set_irg_current_block(ir_graph *irg, ir_node *node);
-
 /** Returns the Bad node of the given IR graph.  Use new_Bad() instead!! */
 FIRM_API ir_node *get_irg_bad(const ir_graph *irg);
 FIRM_API void set_irg_bad(ir_graph *irg, ir_node *node);
@@ -267,7 +256,7 @@ FIRM_API long get_irg_graph_nr(const ir_graph *irg);
  * smaller than get_irp_last_idx()
  * Note: you cannot use this number for get_irp_irg()
  */
-FIRM_API int get_irg_idx(const ir_graph *irg);
+FIRM_API size_t get_irg_idx(const ir_graph *irg);
 
 /**
  * Get the node for an index.
@@ -342,11 +331,11 @@ FIRM_API void set_irg_outs_inconsistent(ir_graph *irg);
 
 /** state:  extended basic block state. */
 typedef enum {
-       extblk_none    = 0,  /**< No extended basic block information is constructed. Default. */
-       extblk_valid   = 1,  /**< Extended basic block information is valid. */
-       extblk_invalid = 2   /**< Extended basic block information is constructed but invalid. */
-} irg_extblk_state;
-FIRM_API irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
+       ir_extblk_info_none    = 0,  /**< No extended basic block information is constructed. Default. */
+       ir_extblk_info_valid   = 1,  /**< Extended basic block information is valid. */
+       ir_extblk_info_invalid = 2   /**< Extended basic block information is constructed but invalid. */
+} irg_extblk_info_state;
+FIRM_API irg_extblk_info_state get_irg_extblk_state(const ir_graph *irg);
 FIRM_API void set_irg_extblk_inconsistent(ir_graph *irg);
 
 /** state: dom_state
@@ -453,19 +442,19 @@ FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
  * Returns the mask of the additional graph properties.
  * The properties are automatically inherited from the method type
  * if they were not set using set_irg_additional_properties() or
- * set_irg_additional_property().
+ * set_irg_additional_properties().
  *
- * @return a bitset of mtp_additional_property values
+ * @return a bitset of mtp_additional_properties values
  */
-FIRM_API unsigned get_irg_additional_properties(const ir_graph *irg);
+FIRM_API mtp_additional_properties get_irg_additional_properties(const ir_graph *irg);
 
 /** Sets the mask of the additional graph properties. */
 FIRM_API void set_irg_additional_properties(ir_graph *irg,
-                                            unsigned property_mask);
+                                            mtp_additional_properties property_mask);
 
 /** Sets one additional graph property. */
-FIRM_API void set_irg_additional_property(ir_graph *irg,
-                                          mtp_additional_property flag);
+FIRM_API void add_irg_additional_properties(ir_graph *irg,
+                                            mtp_additional_properties flag);
 
 /** A void * field to link arbitrary information to the node. */
 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
@@ -493,8 +482,9 @@ FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
  * block_visited flags. If NDEBUG is not defined, then the compiler will abort
  * if 2 parties try to use the flags.
  */
-enum ir_resources_enum_t {
+typedef enum ir_resources_t {
        /* local (irg) resources */
+       IR_RESOURCE_NONE          = 0,
        IR_RESOURCE_BLOCK_VISITED = 1 << 0,  /**< Block visited flags are used. */
        IR_RESOURCE_BLOCK_MARK    = 1 << 1,  /**< Block mark bits are used. */
        IR_RESOURCE_IRN_VISITED   = 1 << 2,  /**< IR-node visited flags are used. */
@@ -510,8 +500,8 @@ enum ir_resources_enum_t {
        /* masks */
        IR_RESOURCE_LOCAL_MASK    = 0x00FF,  /**< Mask for all local resources. */
        IR_RESOURCE_GLOBAL_MASK   = 0xFF00   /**< Mask for all global resources. */
-};
-typedef unsigned ir_resources_t;
+} ir_resources_t;
+ENUM_BITSET(ir_resources_t)
 
 #ifndef NDEBUG
 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
@@ -531,17 +521,15 @@ typedef enum {
        IR_GRAPH_STATE_ARCH_DEP      = 1U << 1,  /**< should not construct more nodes which irarch potentially breaks down */
        IR_GRAPH_STATE_BCONV_ALLOWED = 1U << 2,  /**< Conv(mode_b) to Iu is allowed as set command */
 } ir_graph_state_t;
+ENUM_BITSET(ir_graph_state_t)
 
 /** set some state flags on the graph (this does not clear the other flags) */
 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
 /** clear some state flags of the graph */
 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
-/** query wether a set of graph state flags are activated */
+/** query whether a set of graph state flags are activated */
 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
 
-/** Normalization: Move Proj nodes into the same block as its predecessors */
-FIRM_API void normalize_proj_nodes(ir_graph *irg);
-
 /** Set a description for local value n. */
 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);