#include "nodeops.h"
/**
- * @defgroup ir_node Declarations of an ir node.
- *
- * The type definition of ir_node is also in irgraph.h to resolve
- * recursion between irnode.h and irgraph.h
+ * @ingroup ir_graph
+ * @defgroup ir_node Nodes
*
* ir_node - a datatype representing a Firm node
*
ir_op *op, ir_mode *mode,
int arity, ir_node *const *in);
+/**
+ * @addtogroup Block
+ * @{
+ */
+
/**
* Return the block the node belongs to. This is only
* possible for pinned nodes or if the graph is in pinned state.
/** Sets the Block of a node. */
FIRM_API void set_nodes_block(ir_node *node, ir_node *block);
-/** Test whether arbitrary node is frame pointer.
- *
- * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
- * from Start. If so returns frame type, else Null. */
-FIRM_API ir_type *is_frame_pointer(const ir_node *n);
-
/** Return the number of control flow predecessors of a block. */
FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
/** Return the control flow predecessor of a block at a given position. */
FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
/** Returns the ir_graph this Block belongs to. */
FIRM_API ir_graph *get_Block_irg(const ir_node *block);
-/** Returns non-zero if the block has an entity assigned */
-FIRM_API int has_Block_entity(const ir_node *block);
-/** Returns the entity for a Block */
-FIRM_API ir_entity *get_Block_entity(const ir_node *block);
/** Returns the entity for a Block (creating it if necessary) */
FIRM_API ir_entity *create_Block_entity(ir_node *block);
-/** Set a new entity for a block */
-FIRM_API void set_Block_entity(ir_node *block, ir_entity *entity);
/** Gets the head of the Phi list for this block. */
FIRM_API ir_node *get_Block_phis(const ir_node *block);
/** Sets the head of the Phi list for this block. */
/** Set the Block mark (single bit). */
FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
+/** @} */
+
+/** Test whether arbitrary node is frame pointer.
+ *
+ * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
+ * from Start. If so returns frame type, else Null. */
+FIRM_API ir_type *is_frame_pointer(const ir_node *n);
+
+/** @addtogroup End
+ * @{
+ */
+
/** Return the number of Keep alive node. */
FIRM_API int get_End_n_keepalives(const ir_node *end);
/** Return the Keep alive node a position pos. */
free_End() frees these data structures. */
FIRM_API void free_End(ir_node *end);
+/** @} */
+
+/** @addtogroup Return
+ * @{
+ */
+
FIRM_API ir_node **get_Return_res_arr(ir_node *node);
FIRM_API size_t get_Return_n_ress(const ir_node *node);
FIRM_API ir_node *get_Return_res(const ir_node *node, int pos);
FIRM_API void set_Return_res(ir_node *node, int pos, ir_node *res);
+/** @} */
+
+/** @addtogroup Const
+ * @{
+ */
+
/** Return non-zero if the given Const node represents the 0 constant. */
FIRM_API int is_Const_null(const ir_node *node);
/** Return non-zero if the given Const node represents the constant with all bits set. */
FIRM_API int is_Const_all_one(const ir_node *node);
-/** Returns true if a node is a Conv node with strict attribute set. */
+/** @} */
+
+/**
+ * @ingroup Conv
+ * Returns true if a node is a Conv node with strict attribute set.
+ */
FIRM_API int is_strictConv(const ir_node *node);
-/** Returns true if node is a SymConst node with kind symconst_addr_ent. */
+/**
+ * @addtogroup SymConst
+ * @{
+ */
+
+/**
+ * Returns true if node is a SymConst node with kind symconst_addr_ent.
+ */
FIRM_API int is_SymConst_addr_ent(const ir_node *node);
/** Returns non-zero if s symconst kind has a type attribute */
/** Set the kind of the SymConst. */
FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
-/** Only to access SymConst of kind type_tag or size. Else assertion: */
+/** Only to access SymConst of kind type_size. Else assertion: */
FIRM_API ir_type *get_SymConst_type(const ir_node *node);
FIRM_API void set_SymConst_type(ir_node *node, ir_type *tp);
FIRM_API void set_SymConst_symbol(ir_node *node,
union symconst_symbol sym);
+/** @} */
+
+/** @addtogroup Sel
+ * @{
+ */
+
FIRM_API ir_node **get_Sel_index_arr(ir_node *node);
FIRM_API int get_Sel_n_indexs(const ir_node *node);
FIRM_API ir_node *get_Sel_index(const ir_node *node, int pos);
FIRM_API void set_Sel_index(ir_node *node, int pos, ir_node *index);
+/** @} */
+
+/** @addtogroup Call
+ * @{
+ */
+
FIRM_API ir_node **get_Call_param_arr(ir_node *node);
/** Gets the number of parameters of a call. */
FIRM_API size_t get_Call_n_params(const ir_node *node);
FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
FIRM_API void remove_Call_callee_arr(ir_node *node);
+/** @} */
+
+/** @addtogroup Builtin
+ * @{
+ */
+
FIRM_API ir_node **get_Builtin_param_arr(ir_node *node);
/** Gets the number of parameters of a Builtin. */
FIRM_API int get_Builtin_n_params(const ir_node *node);
FIRM_API ir_node *get_Builtin_param(const ir_node *node, int pos);
/** Sets the Builtin parameter at position pos. */
FIRM_API void set_Builtin_param(ir_node *node, int pos, ir_node *param);
+
+/** @} */
+
/** Returns a human readable string for the ir_builtin_kind. */
FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
/** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
FIRM_API ir_relation get_inversed_relation(ir_relation relation);
+/**
+ * @addtogroup Cast
+ * @{
+ */
+
/** Checks for upcast.
*
* Returns true if the Cast node casts a class type to a super type.
*/
FIRM_API int is_Cast_downcast(ir_node *node);
+/** @} */
+
+/**
+ * @addtogroup Phi
+ * @{
+ */
+
/** Returns true if irg in phase phase_building and the Phi has zero
predecessors. It's a Phi0 then. */
FIRM_API int is_Phi0(const ir_node *n);
*/
FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
-/** Return true if parameter is a memory operation.
+/** @} */
+
+/** Return true if @p node is a memory operation.
*
* A memory operation is an operation that changes the
* memory. I.e., a Load or a Store operation.
+ * memops have a memory input and output
*/
FIRM_API int is_memop(const ir_node *node);
FIRM_API ir_node *get_memop_mem(const ir_node *node);
FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);
-FIRM_API ir_node *get_memop_ptr(const ir_node *node);
-FIRM_API void set_memop_ptr(ir_node *node, ir_node *ptr);
FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
FIRM_API int get_Sync_n_preds(const ir_node *node);
*/
FIRM_API int is_arg_Proj(const ir_node *node);
+/** @addtogroup Tuple
+ * @{
+ */
+
FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
FIRM_API int get_Tuple_n_preds(const ir_node *node);
FIRM_API ir_node *get_Tuple_pred(const ir_node *node, int pos);
FIRM_API void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
+/** @} */
+
+/** @addtogroup ASM
+ * @{
+ */
+
/** Return the number of input constraints for an ASM node. */
-FIRM_API int get_ASM_n_input_constraints(const ir_node *node);
+FIRM_API size_t get_ASM_n_input_constraints(const ir_node *node);
/** Return the number of output constraints for an ASM node. */
-FIRM_API int get_ASM_n_output_constraints(const ir_node *node);
+FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
/** Return the number of clobbered registers for an ASM node. */
-FIRM_API int get_ASM_n_clobbers(const ir_node *node);
+FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
+
+/** @} */
/** Returns operand of node if node is a Proj. */
FIRM_API ir_node *skip_Proj(ir_node *node);
* Bad. Raise is not fragile, but a unconditional jump.
*/
FIRM_API int is_fragile_op(const ir_node *node);
-/** Returns the memory operand of fragile operations. */
-FIRM_API ir_node *get_fragile_op_mem(ir_node *node);
/** Returns true if the operation is a forking control flow
* operation: Cond. */
*/
FIRM_API int is_irn_start_block_placed(const ir_node *node);
-/**
- * Returns non-zero for nodes that are machine operations.
- */
-FIRM_API int is_irn_machine_op(const ir_node *node);
-
-/**
- * Returns non-zero for nodes that are machine operands.
- */
-FIRM_API int is_irn_machine_operand(const ir_node *node);
-
-/**
- * Returns non-zero for nodes that have the n'th user machine flag set.
- */
-FIRM_API int is_irn_machine_user(const ir_node *node, unsigned n);
-
/**
* Returns non-zero for nodes that are CSE neutral to its users.
*/
projects / libfirm / blobdiff