typos fixed

[libfirm] / ir / ir / ircgcons.h

diff --git a/ir/ir/ircgcons.h b/ir/ir/ircgcons.h
index 4c2bd41..84c195f 100644 (file)
--- a/ir/ir/ircgcons.h
+++ b/ir/ir/ircgcons.h
@@ -1,11 +1,15 @@
-/* -------------------------------------------------------------------
- * $Id$
- * -------------------------------------------------------------------
- * Auf- und Abbau der interprozeduralen Darstellung (Explizite
- * interprozedurale Abhängigkeiten).
- *
- * Erstellt: Hubert Schmid, 09.06.2002
- * ---------------------------------------------------------------- */
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/ircgcons.h
+ * Purpose:     Construction and removal of interprocedural representation
+ *              (explicit interprocedural dependencies).
+ * Author:      Hubert Schmid
+ * Modified by:
+ * Created:     09.06.2002
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2002-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
 
 #ifndef _CONSTRUCT_H_
@@ -14,14 +18,38 @@
 
 #include "entity.h"
 
-
-/* Aufbau der interprozeduralen Darstellung. Das Analyseergebnis muss
- * in den Call-Operationen gespeichert sein. */
-void cg_construct(int arr_len, entity ** free_methods_arr);
+/** The state of the interprocedural view.
+ *
+ * This value indicates the state of the interprocedural view.
+ */
+typedef enum {
+  ip_view_no,       /**< The interprocedural view is not constructed.  There are no
+                         view specific nodes (EndReg, Filter, Break ...) in any graph.  */
+  ip_view_valid,    /**< The interprocedural view is valid.  */
+  ip_view_invalid   /**< The interprocedural view is invalid.  Specific nodes are
+                         all still in the representation, but the graph is no more complete. */
+} ip_view_state;
+
+/** Return the current state of the interprocedural view. */
+ip_view_state get_irp_ip_view_state(void);
+/** Set the state of the interprocedural view to invalid. */
+void set_irp_ip_view_invalid(void);
+
+/** Construction of the interprocedural view.
+ *
+ * Construction of the interprocedural view.  A prior analysis must have set
+ * all possible callees in the corresponding fields of Call nodes.  Sets
+ * ip_view_valid in irp.
+ *
+ * @arg free_methods_arr: An array of all free methods, i.e., methods that
+ *                        are external visible.  These methods get an 'Unknown'
+ *                        caller.
+ * @arg arr_len           The number of free methods. */
+void cg_construct(int arr_len, entity *free_methods_arr[]);
 
 
-/* Abbau der interprozeduralen (Sichten-) Darstellung, in eine
- * gewöhnliche intraprozedurale Darstellung */
+/** Deconstruction of the interprocedural view.  Reduces memory consumption of
+    the ir. Sets ip_view_no in irp. */
 void cg_destruct(void);