* @brief Reverse edges that reference types/entities.
* @author Goetz Lindenmaier
* @date 29.10.2004
- * @version $Id$
- * @brief
- * Trouts list all uses of types and entities.
- * Each type gets a list of all Alloc nodes allocating it.
- * Each entity gets two lists:
- * - one containing all accesses (Load, (Call), Store),
- * - and one containing all uses to get a reference (Sel, SymConst).
*/
#ifndef FIRM_ANA_TROUTS_H
#define FIRM_ANA_TROUTS_H
#include "begin.h"
-/*-----------------------------------------------------------------*/
-/* Accessing the trout datastructures. */
-/* These routines only work properly if firm is in state */
-/* trouts_consistent or trouts_inconsistent. */
-/*-----------------------------------------------------------------*/
-
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-/* entities */
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
+/**
+ * @ingroup ir_type
+ * @defgroup trouts Reverse Type Edges
+ * Trouts list all uses of types and entities.
+ * Each type gets a list of all Alloc nodes allocating it.
+ * Each entity gets two lists:
+ * - one containing all accesses (Load, (Call), Store),
+ * - and one containing all uses to get a reference (Sel, SymConst).
+ * @{
+ */
/** Number of Load/Store nodes that possibly access this entity. */
FIRM_API size_t get_entity_n_accesses(const ir_entity *ent);
* Including references from constants. */
FIRM_API ir_node *get_entity_reference(const ir_entity *ent, size_t pos);
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-/* types */
-/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
-
/** Number of Alloc nodes that create an instance of this type. */
FIRM_API size_t get_type_n_allocs(const ir_type *tp);
/** Alloc node that create an instance of this type. */
/** Return number of downcasts. O(\#casts). */
FIRM_API size_t get_class_n_downcasts(const ir_type *clss);
-/* Access all pointer types that point to tp. */
FIRM_API size_t get_type_n_pointertypes_to(const ir_type *tp);
FIRM_API ir_type *get_type_pointertype_to(const ir_type *tp, size_t pos);
FIRM_API void add_type_pointertype_to(const ir_type *tp, ir_type *ptp);
-/* Access all array types that contain elements of type tp.
- * Does not find subarrays, e.g., int[] being element of int[][]
- * for multi dimensional arrays. */
FIRM_API size_t get_type_n_arraytypes_of(const ir_type *tp);
FIRM_API ir_type *get_type_arraytype_of(const ir_type *tp, size_t pos);
FIRM_API void add_type_arraytype_of(const ir_type *tp, ir_type *atp);
-/*------------------------------------------------------------------*/
-/* Building and Removing the trout datastructure */
-/*------------------------------------------------------------------*/
-
/** Compute the outs of types and entities.
*
* Collects all reference from irnodes to types or entities in the
/** Free trout data. */
FIRM_API void free_trouts(void);
+/** @} */
+
#include "end.h"
#endif