Typo fixed.
[libfirm] / ir / ir / irnode.h
index b33bcdf..aa11d37 100644 (file)
@@ -7,24 +7,24 @@
 # ifndef _IRNODE_H_
 # define _IRNODE_H_
 
-/* Projection numbers of compare: use for Proj nodes! */
+/** Projection numbers of compare: use for Proj nodes! */
 typedef enum {
-  False,               /* false */
-  Eq,                  /* equal */
-  Lt,                  /* less */
-  Le,                  /* less or equal */
-  Gt,                  /* greater */
-  Ge,                  /* greater or equal */
-  Lg,                  /* less or greater */
-  Leg,                 /* 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                 /* true */
+  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;
 #define not_mask Leg
@@ -82,6 +82,17 @@ typedef struct ir_node ir_node;
  *   of nodes, it's just a big graph.
  */
 
+/**
+ *   Checks whether a pointer points to a ir node.
+ *
+ *   @param thing     an arbitrary pointer
+ *
+ *   @return
+ *       true if the thing is a ir mode, else false
+ */
+int
+is_ir_node (void *thing);
+
 /** returns the number of predecessors without the block predecessor: */
 int                  get_irn_arity         (const ir_node *node);
 
@@ -102,28 +113,31 @@ INLINE void          set_irn_in            (ir_node *node, int arity,
 /* get_irn_n removes Id predecessors. */
 INLINE ir_node      *get_irn_n             (ir_node *node, int n);
 INLINE void          set_irn_n             (ir_node *node, int n, ir_node *in);
-/* Get the mode struct. */
+/** Sets the mode struct of node */
+INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
+/** Gets the mode struct. */
 INLINE ir_mode      *get_irn_mode          (const ir_node *node);
-/* Get the mode-enum modecode */
+/** Gets the mode-enum modecode. */
 INLINE modecode      get_irn_modecode      (const ir_node *node);
-/* Get the ident for a string representation of the mode */
+/** Gets the ident for a string representation of the mode .*/
 INLINE ident        *get_irn_modeident     (const ir_node *node);
-/* Access the opcode struct of the node */
+/** Gets the opcode struct of the node */
 INLINE ir_op        *get_irn_op            (const ir_node *node);
+/** Sets the opcode struct of the node. */
 INLINE void          set_irn_op            (ir_node *node, ir_op *op);
-/* Get the opcode-enum of the node */
+/** Gets the opcode-enum of the node. */
 INLINE opcode        get_irn_opcode        (const ir_node *node);
-/* Get the string representation of the opcode */
+/** Get the string representation of the opcode. */
 INLINE const char   *get_irn_opname        (const ir_node *node);
-/* Get the ident for a string representation of the opcode */
+/** Get the ident for a string representation of the opcode. */
 INLINE ident        *get_irn_opident       (const ir_node *node);
 INLINE unsigned long get_irn_visited (const ir_node *node);
 INLINE void          set_irn_visited (ir_node *node, unsigned long visited);
-/* Sets visited to get_irg_visited(current_ir_graph) */
+/** Sets visited to get_irg_visited(current_ir_graph). */
 INLINE void          mark_irn_visited (ir_node *node);
-/* Returns 1 if visited < get_irg_visited(current_ir_graph).  */
+/** Returns 1 if visited < get_irg_visited(current_ir_graph).  */
 INLINE int           irn_not_visited  (const ir_node *node);
-/* Returns 1 if visited >= get_irg_visited(current_ir_graph).  */
+/** Returns 1 if visited >= get_irg_visited(current_ir_graph).  */
 INLINE int           irn_visited      (const ir_node *node);
 INLINE void          set_irn_link          (ir_node *node, void *link);
 INLINE void         *get_irn_link          (const ir_node *node);
@@ -171,7 +185,9 @@ typedef enum {
   pns_frame_base,       /**< Projection on the frame base */
   pns_globals,          /**< Projection on the pointer to the data segment
                           containing _all_ global entities. */
-  pns_args              /**< Projection on all arguments */
+  pns_args,             /**< Projection on all arguments */
+  pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
+                            type of this method. */
 } pns_number;
 
 /* @@@ no more supported  */
@@ -309,11 +325,17 @@ INLINE void     set_Call_mem (ir_node *node, ir_node *mem);
 INLINE ir_node *get_Call_ptr (ir_node *node);
 INLINE void     set_Call_ptr (ir_node *node, ir_node *ptr);
 INLINE ir_node **get_Call_param_arr (ir_node *node);
+/** Gets the number of parameters of a call. */
 INLINE int      get_Call_n_params (ir_node *node);
+/** Gets the call parameter at position pos. */
 INLINE ir_node *get_Call_param (ir_node *node, int pos);
+/** Sets the call parameter at position pos. */
 INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
+/** Gets the type of a call. */
 INLINE type    *get_Call_type (ir_node *node);
+/** Sets the type of a call. */
 INLINE void     set_Call_type (ir_node *node, type *tp);
+/** Gets the arity of a call. Identical to get_Call_n_params(). */
 INLINE int      get_Call_arity (ir_node *node);
 
 /* Set, get and remove the callee-analysis. */
@@ -331,7 +353,7 @@ void set_CallBegin_call (ir_node *node, ir_node *call);
 /* 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.
-   unops are: Minus, Abs, Not, Conv
+   unops are: Minus, Abs, Not, Conv, Cast
    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
    Shr, Shrs, Rot, Cmp */
 INLINE int      is_unop (ir_node *node);
@@ -441,6 +463,11 @@ INLINE void     set_Rot_right (ir_node *node, ir_node *right);
 INLINE ir_node *get_Conv_op (ir_node *node);
 INLINE void     set_Conv_op (ir_node *node, ir_node *op);
 
+INLINE ir_node *get_Cast_op (ir_node *node);
+INLINE void     set_Cast_op (ir_node *node, ir_node *op);
+INLINE type    *get_Cast_type (ir_node *node);
+INLINE void     set_Cast_type (ir_node *node, type *to_tp);
+
 INLINE ir_node **get_Phi_preds_arr (ir_node *node);
 INLINE int       get_Phi_n_preds (ir_node *node);
 INLINE ir_node  *get_Phi_pred (ir_node *node, int pos);
@@ -566,7 +593,8 @@ ir_node *get_fragile_op_mem(ir_node *node);
 
 /* !!!!!!!!! @@@
    Don't format with "\", firmjni gets problems */
-
+/** Output location */
+#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
 /** Output the firm kind of the node */
 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (X));
 /** Output information about a node */
@@ -576,7 +604,7 @@ ir_node *get_fragile_op_mem(ir_node *node);
 /** Output information about a type */
 #define DDMT(X)  printf("%s(l.%i) %s %s: %ld (%p)\n",        __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (X))
 /** Output information about an entity */
-#define DDME(X)  printf("%s(l.%i) %s: %ld (%p\n",            __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
+#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
 /** Output information about an entity and its owner */
 #define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (X))
 /** Output information about a graph */
@@ -585,6 +613,10 @@ ir_node *get_fragile_op_mem(ir_node *node);
 #define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (X))
 /** Output information about a mode */
 #define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (X))
+/** Output information about a loop */
+#define DDML(X)  printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (X))
+/** Output information about a tarVal */
+#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (X));
 
 /*@}*/ /* end of ir_node group definition */