irdom: move some functions to private API

[libfirm] / include / libfirm / irloop.h

diff --git a/include/libfirm/irloop.h b/include/libfirm/irloop.h
index f0d9cbe..1b4b5ce 100644 (file)
--- a/include/libfirm/irloop.h
+++ b/include/libfirm/irloop.h
@@ -22,7 +22,6 @@
  * @brief    Loop datastructure and access functions.
  * @author   Goetz Lindenmaier
  * @date     7.2002
- * @version  $Id$
  * @brief
  *  Computes backedges in the control and data flow.
  *
@@ -37,16 +36,10 @@
 #include "firm_common.h"
 #include "begin.h"
 
-/* ------------------------------------------------------------------- */
-/*
- * Backedge information.
- *
- * Predecessors of Block and Phi nodes can have  backedges.
- * If loop information is computed, this information is computed, too.
- * The backedge information can only be used if the graph is not in
- * phase phase_building.
+/** @ingroup irana
+ * @defgroup ir_loop Loops
+ * @{
  */
-/* ------------------------------------------------------------------- */
 
 /** Returns non-zero if the predecessor pos is a backedge. */
 FIRM_API int is_backedge(const ir_node *n, int pos);
@@ -72,7 +65,7 @@ FIRM_API int is_ir_loop(const void *thing);
 /** Set the outermost loop in ir graph as basic access to loop tree. */
 FIRM_API void set_irg_loop(ir_graph *irg, ir_loop *l);
 
-/* Returns the root loop info (if exists) for an irg. */
+/** Returns the root loop info (if exists) for an irg. */
 FIRM_API ir_loop *get_irg_loop(const ir_graph *irg);
 
 /** Returns the loop n is contained in.  NULL if node is in no loop. */
@@ -83,21 +76,6 @@ FIRM_API ir_loop *get_loop_outer_loop(const ir_loop *loop);
 /** Returns nesting depth of this loop */
 FIRM_API unsigned get_loop_depth(const ir_loop *loop);
 
-/* Sons are the inner loops contained in this loop. */
-/** Returns the number of inner loops */
-FIRM_API size_t get_loop_n_sons(const ir_loop *loop);
-
-/** Returns the pos`th son loop (inner loop) of a loop.
-Returns NULL if there is not a pos`th loop_node. */
-FIRM_API ir_loop *get_loop_son(ir_loop *loop, size_t pos);
-
-/** Returns the number of nodes contained in loop.  */
-FIRM_API size_t get_loop_n_nodes(const ir_loop *loop);
-
-/** Returns the pos`th ir_node of a loop.
-Returns NULL if there is not a pos`th ir_node. */
-FIRM_API ir_node *get_loop_node(const ir_loop *loop, size_t pos);
-
 /** Returns the number of elements contained in loop.  */
 FIRM_API size_t get_loop_n_elements(const ir_loop *loop);
 
@@ -105,12 +83,6 @@ FIRM_API size_t get_loop_n_elements(const ir_loop *loop);
 kind pointer, an ir_node* or an ir_loop*. */
 FIRM_API loop_element get_loop_element(const ir_loop *loop, size_t pos);
 
-#define INVALID_LOOP_POS ((size_t)-1)
-
-/** Returns the element number of the loop son in loop.
-*  Returns INVALID_LOOP_POS if not found. O(|elements|). */
-FIRM_API size_t get_loop_element_pos(const ir_loop *loop, void *le);
-
 /** Returns a unique node number for the loop node to make output
 readable. If libfirm_debug is not set it returns the loop cast to
 int. */
@@ -120,10 +92,6 @@ FIRM_API long get_loop_loop_nr(const ir_loop *loop);
 FIRM_API void set_loop_link(ir_loop *loop, void *link);
 FIRM_API void *get_loop_link(const ir_loop *loop);
 
-/* ------------------------------------------------------------------- */
-/* Constructing and destructing the loop/backedge information.         */
-/* ------------------------------------------------------------------- */
-
 /** Constructs backedge information and loop tree for a graph.
  *
  *  The algorithm views the program representation as a pure graph.
@@ -169,7 +137,7 @@ FIRM_API int construct_cf_backedges(ir_graph *irg);
  *
  * @param irg  the graph
  */
-FIRM_API void assure_cf_loop(ir_graph *irg);
+FIRM_API void assure_loopinfo(ir_graph *irg);
 
 /**
  * Removes all loop information.
@@ -178,11 +146,6 @@ FIRM_API void assure_cf_loop(ir_graph *irg);
 FIRM_API void free_loop_information(ir_graph *irg);
 FIRM_API void free_all_loop_information (void);
 
-
-/* ------------------------------------------------------------------- */
-/* Simple analyses based on the loop information                       */
-/* ------------------------------------------------------------------- */
-
 /** Test whether a value is loop invariant.
  *
  * @param n      The node to be tested.
@@ -192,6 +155,8 @@ FIRM_API void free_all_loop_information (void);
  * belongs to or in inner loops of this block. */
 FIRM_API int is_loop_invariant(const ir_node *n, const ir_node *block);
 
+/** @} */
+
 #include "end.h"
 
 #endif