X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firprog.h;h=03c3edf06d5a80af4d56008d29dc34a311bcaaea;hb=c3c48d7bd83f042cc2951754377de928d66fe51e;hp=d60043a78211005815df72f841f0518d9964b255;hpb=6023590e8c7b401803f9b805886277de002efa19;p=libfirm

diff --git a/ir/ir/irprog.h b/ir/ir/irprog.h
index d60043a78..03c3edf06 100644
--- a/ir/ir/irprog.h
+++ b/ir/ir/irprog.h
@@ -1,6 +1,14 @@
-/* Copyright (C) 2000 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/irprog.h
+ * Purpose:     Entry point to the representation of a whole program.
+ * Author:      Goetz Lindenmaier
+ * Modified by:
+ * Created:     2000
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2000-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
 /**
 * @file irprog.h
@@ -11,41 +19,53 @@
 *
 * This file defines a construct that keeps all information about a
 * program:
+*   - A reference point to the method to be executed on program start.
 *   - A list of all procedures.
 *   - A list of all types.
-*   - A global type that can be thought of as a god-class containing all
-*     global variables and procedures.  This is not the base class of
+*   - A global type that contais all global variables and procedures that do
+*     not belong to a class.  This type represents the data segment of the
+*     program.  It is not the base class of
 *     all classes in a class hierarchy (as, e.g., "object" in java).
-*   - (An obstack containing global things, e.g., the above mentioned lists.)
+*   - A degenerated graph that contains constant expressions.
+*   - interprocedural outs state.
+*   - a flag indicating validity of the interprocedural representation.
+*   - the output file name
 */
 
-/* $Id$ */
-
 # ifndef _IRPROG_H_
 # define _IRPROG_H_
 
 # include "irnode.h"
 # include "type.h"
 
+
 /**
  * Datastructure that holds central information about a program
  *
- *   Preliminary documentation ;-)
+ * Preliminary documentation ;-)
  *
- *  - main_irg  The ir graph that is the entry point to the program.
+ * - main_irg:  The ir graph that is the entry point to the program.
  *              (Anything not reachable from here may be optimized away.
  *              If we want to translate libraries or the like correctly
  *              we must replace this by a list.)
- *  - irg       List of all ir graphs in the program.
- *  - type      A list containing all types known to the translated program.
+ * - irg:       List of all ir graphs in the program.
+ * - type:      A list containing all types known to the translated program.
  *              Some types can have several entries in this list (as a result of
  *              using exchange_types()).
- *  - glob_type The unique global type that is owner of all global entities.
+ * - glob_type: The unique global type that is owner of all global entities.
  *
  */
 typedef struct ir_prog ir_prog;
 
-/** A variable from where everything in the ir can be accessed. */
+/**
+ * A variable from where everything in the ir can be accessed.
+ * This variable contains the irp, the "immediate representation program".
+ * This variable should be considered constant. Moreover, one should use get_irp()
+ * to get access the the irp.
+ *
+ * @note
+ * 	Think of the irp as the "handle" of libFirm.
+ */
 extern ir_prog *irp;
 
 /**
@@ -62,6 +82,10 @@ void init_irprog(void);
    Automatically called by init_firm() through init_irprog.  */
 ir_prog *new_ir_prog (void);
 
+/** frees all memory used by irp.  Types in type list and irgs in irg
+    list must be freed by hand before. */
+void     free_ir_prog(void);
+
 /** Gets the main routine of the compiled program. */
 ir_graph *get_irp_main_irg(void);
 
@@ -70,29 +94,46 @@ void      set_irp_main_irg(ir_graph *main_irg);
 
 /** Adds irg to the list of ir graphs in irp. */
 void      add_irp_irg(ir_graph *irg);
+
 /** Removes irg from the list of irgs, deallocates it and
-   shrinks the list by one. */
+    shrinks the list by one. */
 void      remove_irp_irg(ir_graph *irg);
+
+/** Returns the number of ir graphs in the irp. */
 int       get_irp_n_irgs(void);
+
+/** Returns the ir graph at position pos in the irp. */
 ir_graph *get_irp_irg(int pos);
+
+/** Sets the ir graph at position pos. */
 void      set_irp_irg(int pos, ir_graph *irg);
 
 /** Adds type to the list of types in irp. */
 void  add_irp_type(type *typ);
-/* Removes type from the list of types, deallocates it and
+
+/** Removes type from the list of types, deallocates it and
    shrinks the list by one. */
 void  remove_irp_type(type *typ);
+
+/** Returns the number of all types in the irp. */
 int   get_irp_n_types(void);
+
+/** Returns the type at position pos in the irp. */
 type *get_irp_type(int pos);
+
+/** Overwrites the type at position pos with another type. */
 void  set_irp_type(int pos, type *typ);
 
-/* --- Functions to access the fields of ir_prog --- */
+/** Returns the "global" type of the irp. */
 type *get_glob_type(void);
 
+/** File name / executable name or the like. Initially NULL! **/
+void   set_irp_prog_name (ident *name);
+ident *get_irp_prog_ident(void);
+const char  *get_irp_prog_name (void);
 
 /**
  *   Returns an irgraph that only contains constant
- *
  *   expressions for constant entities.
  *   Do not use any access function for this graph, do not generate code
  *   for this graph.  This graph contains only one block.  The constant
@@ -101,4 +142,11 @@ type *get_glob_type(void);
  */
 ir_graph *get_const_code_irg(void);
 
+irg_outs_state get_irp_ip_outs_state(void);
+void           set_irp_ip_outs_inconsistent(void);
+
+/* @@@ Must this be global visible? */
+void           set_irp_ip_outedges(ir_node ** ip_outedges);
+ir_node**      get_irp_ip_outedges(void);
+
 #endif /* ifndef _IRPROG_H_ */