updated header
[libfirm] / ir / ana / irloop.h
index aa45469..9426dce 100644 (file)
@@ -1,28 +1,37 @@
 /*
- * 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.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
 /**
-* @file irloop.h
-*
-*  Computes backedges in the control and data flow.
-*
-*  @author Goetz Lindenmaier
-*
-*  Only Block and Phi/Filter nodes can have incoming backedges.
-*  Constructs loops data structure: indicates loop nesting.
-*/
-
-# ifndef _IRLOOP_H_
-# define _IRLOOP_H_
+ * @file
+ * @brief    Loop datastructure and access functions.
+ * @author   Goetz Lindenmaier
+ * @date     7.2002
+ * @version  $Id$
+ * @summary
+ *  Computes backedges in the control and data flow.
+ *
+ * @note
+ *  Only Block and Phi/Filter nodes can have incoming backedges.
+ *  Constructs loops data structure: indicates loop nesting.
+ */
+# ifndef FIRM_ANA_IRLOOP_H
+# define FIRM_ANA_IRLOOP_H
 
 # include "irgraph.h"
 # include "irnode.h"
@@ -93,16 +102,16 @@ 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.  NULL if node is in no loop. */
-ir_loop *get_irn_loop(ir_node *n);
+ir_loop *get_irn_loop(const ir_node *n);
 
 /** Returns outer loop, itself if outermost. */
-ir_loop *get_loop_outer_loop (ir_loop *loop);
+ir_loop *get_loop_outer_loop (const ir_loop *loop);
 /** Returns nesting depth of this loop */
-int      get_loop_depth (ir_loop *loop);
+int      get_loop_depth (const ir_loop *loop);
 
 /* Sons are the inner loops contained in this loop. */
 /** Returns the number of inner loops */
-int      get_loop_n_sons (ir_loop *loop);
+int      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. */
@@ -116,19 +125,20 @@ int      get_loop_n_nodes (ir_loop *loop);
 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);
+int      get_loop_n_elements (const ir_loop *loop);
+
 /** Returns a loop element.  A loop element can be interpreted as a
     kind pointer, an ir_node* or an ir_loop*. */
-loop_element get_loop_element (ir_loop *loop, int pos);
+loop_element get_loop_element (const 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);
+int 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. */
-int get_loop_loop_nr(ir_loop *loop);
+int get_loop_loop_nr(const ir_loop *loop);
 
 /** A field to connect additional information to a loop.  Only valid
     if libfirm_debug is set, else returns NULL.  */
@@ -146,6 +156,8 @@ void *get_loop_link (const ir_loop *loop);
  *  The resulting loop tree is a possible visiting order for dataflow
  *  analysis.
  *
+ *  This algorithm destoyes the link field of block nodes.
+ *
  *  @returns Maximal depth of loop tree.
  *
  *  @remark
@@ -183,7 +195,10 @@ int construct_ip_backedges(void);
  *  This algorithm computes only back edge information for Block nodes, not
  *  for Phi nodes.
  *
- * @returns Maximal depth of loop tree. */
+ *  This algorithm destoyes the link field of block nodes.
+ *
+ * @returns Maximal depth of loop tree.
+ */
 int construct_cf_backedges(ir_graph *irg);
 
 /** Construct interprocedural loop tree for control flow.
@@ -214,5 +229,4 @@ void free_all_loop_information (void);
  * belongs to or in inner loops of this block. */
 int is_loop_invariant(ir_node *n, ir_node *block);
 
-
-#endif /* _IRLOOP_H_ */
+#endif