X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firprog.h;h=21f8e5e5e7a42ac262510a7e2198a48ee17071d3;hb=003979e6f8a15a2e380407134af0092268ce2bbc;hp=70eb657486d1a838f4a1a33d36b151abbf4852f4;hpb=1731adad254287e7f373c1c37d297e6adee76288;p=libfirm diff --git a/ir/ir/irprog.h b/ir/ir/irprog.h index 70eb65748..21f8e5e5e 100644 --- a/ir/ir/irprog.h +++ b/ir/ir/irprog.h @@ -1,76 +1,126 @@ /* Copyright (C) 2000 by Universitaet Karlsruhe -** All rights reserved. -** -** Authors: Goetz Lindenmaier -** -** irprog.h: ir representation of a program -** -** This file defines a construct that keeps all information about a -** program: -** - 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 -** all classes in a class hierarchy (as, e.g., "object" in java). -** - (An obstack containing global things, e.g., the above mentioned lists.) +* All rights reserved. */ +/** +* @file irprog.h +* +* ir representation of a program. +* +* @author Goetz Lindenmaier +* +* This file defines a construct that keeps all information about a +* program: +* - 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 +* all classes in a class hierarchy (as, e.g., "object" in java). +* - (An obstack containing global things, e.g., the above mentioned lists.) +*/ + +/* $Id$ */ + # ifndef _IRPROG_H_ # define _IRPROG_H_ # include "irnode.h" # include "type.h" -struct ir_prog { - firm_kind kind; - ir_graph *main_irg; /* entry point to the compiled program */ - /* or a list, in case we compile a library or the like? */ - ir_graph **graphs; /* all graphs in the ir */ - type_class *glob_type; /* global type. Class as it can have - fields and procedures. Does this work? - Better name??? @@@ */ - type **types; /* all types in the ir */ - /*struct obstack *obst; * @@@ Should we place all types and - entities on an obstack, too? */ -#ifdef DEBUG_libfirm - long max_node_nr; /* to generate unique numbers for nodes. */ -#endif -}; - +/** + * Datastructure that holds central information about a program + * + * Preliminary documentation ;-) + * + * - 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. + * 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. + * + */ 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; -/* initializes ir_prog. Calles the constructor for an ir_prog. */ +/** + * Returns the access points from where everything in the ir can be accessed. + * + * @see irp + */ +ir_prog *get_irp(void); + +/** initializes ir_prog. Calls the constructor for an ir_prog. */ void init_irprog(void); -/* Creates a new ir_prog, returns it and sets irp with it. - Automatically called by init_firm through init_irprog. */ +/** Creates a new ir_prog, returns it and sets irp with it. + Automatically called by init_firm() through init_irprog. */ ir_prog *new_ir_prog (void); -/* Access the main routine of the compiled program. */ -ir_graph *get_irp_main_irg(); +/** Gets the main routine of the compiled program. */ +ir_graph *get_irp_main_irg(void); + +/** Sets the main routine of the compiled program. */ void set_irp_main_irg(ir_graph *main_irg); -/* Adds irg to the list of ir graphs in irp. */ +/** Adds irg to the list of ir graphs in irp. */ void add_irp_irg(ir_graph *irg); -int get_irp_n_irgs(); + +/** Removes irg from the list of irgs, deallocates it and + 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. */ +/** Adds type to the list of types in irp. */ void add_irp_type(type *typ); -int get_irp_n_types(); + +/** 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 **/ -type_class *get_glob_type(void); +/** Returns the "global" type of the irp. */ +type *get_glob_type(void); + -#ifdef DEBUG_libfirm -/* Returns a new, unique number to number nodes or the like. */ -int get_irp_new_node_nr(); -#endif +/** + * 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 + * expressions may not contain control flow. See also copy_const_code() + * in entity.h. + */ +ir_graph *get_const_code_irg(void); #endif /* ifndef _IRPROG_H_ */