fixed doxygen comments, removed initialization for description entities

[libfirm] / ir / ana / irloop.h

diff --git a/ir/ana/irloop.h b/ir/ana/irloop.h
index b9fbd92..63b36b5 100644 (file)
--- a/ir/ana/irloop.h
+++ b/ir/ana/irloop.h
@@ -1,6 +1,14 @@
-/* Copyright (C) 2002 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ana/irloop_t.h
+ * Purpose:     Loop datastructure and access functions.
+ * Author:      Goetz Lindenmaier
+ * Modified by:
+ * Created:     7.2002
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2002-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
 /**
 * @file irloop.h
@@ -13,8 +21,6 @@
 *  Constructs loops data structure: indicates loop nesting.
 */
 
-/* $Id$ */
-
 # ifndef _IRLOOP_H_
 # define _IRLOOP_H_
 
@@ -73,8 +79,7 @@ typedef union {
 void     set_irg_loop(ir_graph *irg, ir_loop *l);
 ir_loop *get_irg_loop(ir_graph *irg);
 
-/** Returns the loop n is contained in.
-   assumes current_ir_graph set properly. */
+/** Returns the loop n is contained in.  NULL if node is in no loop. */
 ir_loop *get_irn_loop(ir_node *n);
 
 /** Returns outer loop, itself if outermost. */
@@ -93,21 +98,44 @@ ir_node *get_loop_node (ir_loop *loop, int pos);
 /** Returns the number of elements contained in loop.  */
 int      get_loop_n_elements (ir_loop *loop);
 /** Returns a loop element.  A loop element can be interpreted as a
-    kind poitner, an ir_node* or an ir_loop*. */
+    kind pointer, an ir_node* or an ir_loop*. */
 loop_element get_loop_element (ir_loop *loop, int pos);
 
+/** Returns the element number of the loop son in loop.
+ *  Returns -1 if not found. O(#elements). */
+int get_loop_element_pos(ir_loop *loop, void *le);
+
+/** Returns a unique node number for the loop node to make output
+    readable. Casten pointer if libfirm_debug not set. */
+int get_loop_loop_nr(ir_loop *loop);
+
+/** A field to connect additional information to a loop.  Only valid
+    if libfirm_debug is set, else returns NULL.  */
+void  set_loop_link (ir_loop *loop, void *link);
+void *get_loop_link (const ir_loop *loop);
+
 /*
  * Constructing and destructing the loop/backedge information.
  */
 
 /** Constructs backedge information for irg in intraprocedural view. */
+/* @@@ Well, maybe construct_loop_information or analyze_loops ? */
 void construct_backedges(ir_graph *irg);
 
 /** Constructs backedges for all irgs in interprocedural view.  All
-   loops in the graph will be marked as such, not only realizeable
-   loops and recursions in the program.  E.g., if the same funcion is
-   called twice, there is a loop between the first funcion return and
-   the second call.  */
+    loops in the graph will be marked as such, not only realizeable
+    loops and recursions in the program.  E.g., if the same funcion is
+    called twice, there is a loop between the first function return and
+    the second call.  */
 void construct_ip_backedges(void);
 
+/* Construct loop tree only for control flow. */
+void construct_cf_backedges(ir_graph *irg);
+void construct_ip_cf_backedges (void);
+
+/** Removes all loop information.
+    Resets all backedges */
+void free_loop_information(ir_graph *irg);
+void free_all_loop_information (void);
+
 #endif /* _IRLOOP_H_ */