Fixed gcc warnings --flo
[libfirm] / ir / ir / irnode.h
index ed1b167..a95e2f5 100644 (file)
  * @remark there are numbers with normalized names below!
  */
 typedef enum {
-  False = 0,           /**< false */
-  Eq,                  /**< equal */
-  Lt,                  /**< less */
-  Le,                  /**< less or equal */
-  Gt,                  /**< greater */
-  Ge,                  /**< greater or equal */
-  Lg,                  /**< less or greater */
-  Leg = 7,             /**< less, equal or greater = ordered */
-  Uo,                  /**< unordered */
-  Ue,                  /**< unordered or equal */
-  Ul,                  /**< unordered or less */
-  Ule,                 /**< unordered, less or equal */
-  Ug,                  /**< unordered or greater */
-  Uge,                 /**< unordered, greater or equal */
-  Ne,                  /**< unordered, less or greater = not equal */
-  True = 15            /**< true */
-  /* not_mask = Leg*/  /* bits to flip to negate comparison * @@ hack for jni interface */
+  False = 0,        /**< false */
+  Eq,           /**< equal */
+  Lt,           /**< less */
+  Le,           /**< less or equal */
+  Gt,           /**< greater */
+  Ge,           /**< greater or equal */
+  Lg,           /**< less or greater */
+  Leg = 7,      /**< less, equal or greater = ordered */
+  Uo,           /**< unordered */
+  Ue,           /**< unordered or equal */
+  Ul,           /**< unordered or less */
+  Ule,          /**< unordered, less or equal */
+  Ug,           /**< unordered or greater */
+  Uge,          /**< unordered, greater or equal */
+  Ne,           /**< unordered, less or greater = not equal */
+  True = 15         /**< true */
+  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
 } pnc_number;   /* pnc: Projection Number Cmp */
 #define not_mask Leg
 
@@ -59,7 +59,7 @@ typedef enum {
 /**
  * @defgroup ir_node Declarations of an ir node.
  *
- * The type definiton of ir_node is also in irgraph.h to resolve
+ * The type definition of ir_node is also in irgraph.h to resolve
  *  recursion between irnode.h and irgraph.h
  *
  * ir_node - a datatype representing a Firm node
@@ -100,7 +100,7 @@ typedef struct ir_node ir_node;
  *       true if the thing is a ir mode, else false
  */
 int
-is_ir_node (void *thing);
+is_ir_node (const void *thing);
 
 /** returns the number of predecessors without the block predecessor: */
 int                  get_irn_arity         (const ir_node *node);
@@ -109,12 +109,12 @@ INLINE int           get_irn_inter_arity   (const ir_node *node);
 
 /** Replaces the old in array by a new one that will contain the ins given in
    the parameters.  Conserves the block predecessor.  It copies the array passed.
-   This function is necessary to ajust in arrays of blocks, calls and phis.
+   This function is necessary to adjust in arrays of blocks, calls and phis.
    Assumes that current_ir_graph is set to the graph containing "node".
    "in" must contain all predecessors except the block that are required for
    the nodes opcode. */
 INLINE void          set_irn_in            (ir_node *node, int arity,
-                                           ir_node *in[]);
+                        ir_node *in[]);
 /* to iterate through the predecessors without touching the array. No
    order of predecessors guaranteed.
    To iterate over the operands iterate from 0 to i < get_irn_arity(),
@@ -161,7 +161,7 @@ INLINE void         *get_irn_link     (const ir_node *node);
  *  is in state pinned (irg is only stored in the block. */
 INLINE ir_graph     *get_irn_irg      (ir_node *node);
 
-/** Outputs a unique number for this node if libfirm is compiled for
+/** Outputs a unique number for this node if libFIRM is compiled for
    debugging, (configure with --enable-debug) else returns address
    of node cast to long. */
 INLINE long          get_irn_node_nr  (const ir_node *node);
@@ -171,16 +171,23 @@ INLINE long          get_irn_node_nr  (const ir_node *node);
  * irnode constructor.
  * Create a new irnode in irg, with an op, mode, arity and
  * some incoming irnodes.
- * If arity is negative, a node with a dynamic array is created.
+ * This constructor is used in every specified irnode constructor.
+ *
+ * @param db    Debug info.
+ * @param irg   IR-graph on with this new node should be constructed.
+ * @param op    The opcode of the new node.
+ * @param mode  The mode of the new node.
+ * @param arity The arity of the new node, may be <0 if yet.
+ * @param in    An array of arity predecessor nodes.
  */
 INLINE ir_node *
 new_ir_node (dbg_info *db,
-            ir_graph *irg,
-            ir_node *block,
-            ir_op *op,
-            ir_mode *mode,
-            int arity,
-            ir_node *in[]);
+         ir_graph *irg,
+         ir_node *block,
+         ir_op *op,
+         ir_mode *mode,
+         int arity,
+         ir_node *in[]);
 
 /*
  *
@@ -205,10 +212,10 @@ typedef enum {
   pn_Start_M,               /**< Projection on the initial memory. */
   pn_Start_P_frame_base,    /**< Projection on the frame base pointer. */
   pn_Start_P_globals,       /**< Projection on the pointer to the data segment
-                              containing _all_ global entities. */
+                   containing _all_ global entities. */
   pn_Start_T_args,          /**< Projection on all arguments. */
   pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
-                              type of this method. */
+                   type of this method. */
 } pn_Start; /* Projection numbers for Start. */
 
 /**
@@ -217,14 +224,14 @@ typedef enum {
  */
 typedef enum {
   pns_initial_exec,     /**< Projection on an executable, the initial control
-                          flow. */
+               flow. */
   pns_global_store,     /**< Projection on the global store */
   pns_frame_base,       /**< Projection on the frame base */
   pns_globals,          /**< Projection on the pointer to the data segment
-                            containing _all_ global entities. */
+                 containing _all_ global entities. */
   pns_args,             /**< Projection on all arguments */
   pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
-                            type of this method. */
+                 type of this method. */
 } pns_number; /* pns: Projection Number Start */
 
 /** Test whether arbitrary node is frame pointer.
@@ -267,7 +274,7 @@ void      set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
 void      set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
 /* @@@ not supported */
 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
-/* Returns the number of interproc predecessors.  0 if none. */
+/* Returns the number of interprocedural predecessors.  0 if none. */
 int       get_Block_cg_n_cfgpreds(ir_node * node);
 ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
 /* frees the memory. */
@@ -281,7 +288,7 @@ INLINE int  get_End_n_keepalives(ir_node *end);
 INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
 INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
 INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
-/* Some parts of the End node are allocated seperately -- their memory
+/* Some parts of the End node are allocated separately -- their memory
    is not recovered by dead_node_elimination if a End node is dead.
    free_End frees these data structures. */
 INLINE void free_End (ir_node *end);
@@ -313,7 +320,7 @@ ir_graph *get_EndExcept_irg (ir_node *end);
 typedef enum {
   dense,        /**< Default. Missing Proj nodes are dead control flow. */
   fragmentary   /**< Special. No control flow optimizations allowed.  Missing
-                  Proj nodes mean default control flow, i.e., Proj(n). */
+           Proj nodes mean default control flow, i.e., Proj(n). */
 } cond_kind;
 
 INLINE ir_node  *get_Cond_selector (ir_node *node);
@@ -363,11 +370,11 @@ INLINE void     set_Const_type   (ir_node *node, type *tp);
      this flag. */
 typedef enum {
   type_tag,          /**< The SymConst is a type tag for the given type.
-                       Type_or_id_p is type *. */
+            Type_or_id_p is type *. */
   size,              /**< The SymConst is the size of the given type.
-                       Type_or_id_p is type *. */
+            Type_or_id_p is type *. */
   linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
-                       by the linker. Type_or_id_p is ident *. */
+            by the linker. Type_or_id_p is ident *. */
 } symconst_kind;
 
 typedef union type_or_id * type_or_id_p;
@@ -405,9 +412,9 @@ typedef enum {
   pncl_exc_target = 1,    /**< The control flow result branching to the exception handler */
   pncl_result_tuple = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
   pncl_exc_memory = 3,    /**< The memory result in case the called method terminated with
-                             an exception */
+                  an exception */
   pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
-                             passed by value (for compound result types). */
+                  passed by value (for compound result types). */
 } pncl_number;   /* pncl: Projection Number CaLl */
 
 /**
@@ -417,10 +424,10 @@ typedef enum {
   pn_Call_M_regular = 0,  /**< The memory result. */
   pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
   pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
-                            passed by value (for compound result types). */
+                 passed by value (for compound result types). */
   pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
   pn_Call_M_except  = 3   /**< The memory result in case the called method terminated with
-                            an exception */
+                 an exception */
 } pn_Call;   /* Projection numbers for Call. */
 
 INLINE ir_node *get_Call_mem (ir_node *node);
@@ -442,12 +449,13 @@ INLINE void     set_Call_type (ir_node *node, type *tp);
 INLINE int      get_Call_arity (ir_node *node);
 
 /* Set, get and remove the callee-analysis.
-   The array is only accessible if intformation is valid.
+   The array is only accessible if information is valid.
    It contains NULL for called methods that are not within
    the compilation unit. */
 int     Call_has_callees      (ir_node *node);
 int     get_Call_n_callees    (ir_node * node);
 entity *get_Call_callee       (ir_node * node, int pos);
+/* assumes current_ir_graph set properly! */
 void    set_Call_callee_arr   (ir_node * node, int n, entity ** arr);
 void    remove_Call_callee_arr(ir_node * node);
 
@@ -458,6 +466,33 @@ ir_graph *get_CallBegin_irg  (ir_node *node);
 ir_node  *get_CallBegin_call (ir_node *node);
 void      set_CallBegin_call (ir_node *node, ir_node *call);
 
+INLINE ir_node *get_FuncCall_ptr (ir_node *node);
+INLINE void     set_FuncCall_ptr (ir_node *node, ir_node *ptr);
+INLINE ir_node **get_FuncCall_param_arr (ir_node *node);
+/** Gets the number of parameters of a func call. */
+INLINE int      get_FuncCall_n_params (ir_node *node);
+/** Gets the func call parameter at position pos. */
+INLINE ir_node *get_FuncCall_param (ir_node *node, int pos);
+/** Sets the func call parameter at position pos. */
+INLINE void     set_FuncCall_param (ir_node *node, int pos, ir_node *param);
+/** Gets the type of a func call. */
+INLINE type    *get_FuncCall_type (ir_node *node);
+/** Sets the type of a func call. */
+INLINE void     set_FuncCall_type (ir_node *node, type *tp);
+/** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
+INLINE int      get_FuncCall_arity (ir_node *node);
+
+/* Set, get and remove the callee-analysis.
+   The array is only accessible if information is valid.
+   It contains NULL for called methods that are not within
+   the compilation unit. */
+int     FuncCall_has_callees      (ir_node *node);
+int     get_FuncCall_n_callees    (ir_node * node);
+entity *get_FuncCall_callee       (ir_node * node, int pos);
+/* assumes current_ir_graph set properly! */
+void    set_FuncCall_callee_arr   (ir_node * node, int n, entity ** arr);
+void    remove_FuncCall_callee_arr(ir_node * node);
+
 /* For unary and binary arithmetic operations the access to the
    operands can be factored out.  Left is the first, right the
    second arithmetic value  as listed in tech report 1999-44.
@@ -579,28 +614,28 @@ INLINE void     set_Not_op (ir_node *node, ir_node *op);
 
 /**
  * Projection numbers for Cmp are defined several times.
- * The bit patterns are used for variouse tests, so don't change.
+ * The bit patterns are used for various tests, so don't change.
  * The "unordered" values are possible results of comparing
  * floating point numbers.
  */
 typedef enum {
   pn_Cmp_False = 0,   /**< false */
-  pn_Cmp_Eq,         /**< equal */
-  pn_Cmp_Lt,         /**< less */
-  pn_Cmp_Le,         /**< less or equal */
-  pn_Cmp_Gt,         /**< greater */
-  pn_Cmp_Ge,         /**< greater or equal */
-  pn_Cmp_Lg,         /**< less or greater */
+  pn_Cmp_Eq,          /**< equal */
+  pn_Cmp_Lt,          /**< less */
+  pn_Cmp_Le,          /**< less or equal */
+  pn_Cmp_Gt,          /**< greater */
+  pn_Cmp_Ge,          /**< greater or equal */
+  pn_Cmp_Lg,          /**< less or greater */
   pn_Cmp_Leg = 7,     /**< less, equal or greater = ordered */
-  pn_Cmp_Uo,         /**< unordered */
-  pn_Cmp_Ue,         /**< unordered or equal */
-  pn_Cmp_Ul,         /**< unordered or less */
-  pn_Cmp_Ule,        /**< unordered, less or equal */
-  pn_Cmp_Ug,         /**< unordered or greater */
-  pn_Cmp_Uge,        /**< unordered, greater or equal */
-  pn_Cmp_Ne,         /**< unordered, less or greater = not equal */
+  pn_Cmp_Uo,          /**< unordered */
+  pn_Cmp_Ue,          /**< unordered or equal */
+  pn_Cmp_Ul,          /**< unordered or less */
+  pn_Cmp_Ule,         /**< unordered, less or equal */
+  pn_Cmp_Ug,          /**< unordered or greater */
+  pn_Cmp_Uge,         /**< unordered, greater or equal */
+  pn_Cmp_Ne,          /**< unordered, less or greater = not equal */
   pn_Cmp_True = 15    /**< true */
-  /* not_mask = Leg*/  /* bits to flip to negate comparison * @@ hack for jni interface */
+  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
 } pn_Cmp;   /* Projection numbers for Cmp */
 //#define not_mask pn_Cmp_Leg
 
@@ -636,7 +671,7 @@ INLINE void     set_Conv_op (ir_node *node, ir_node *op);
 
 /* Does Cast need a mem operator?
  * Cast should only depend on the type, not on the state of an
- * entity.  But:  we initialzie various fields after Alloc, that
+ * entity.  But:  we initialze various fields after Alloc, that
  * are accessed in the cast.  This required some precaution, to
  * get the right memory into the Loads generated from the cast.
  */