nsz Git - libfirm/blob - include/libfirm/firm.h

   1 /*
   2  * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief     Central firm header.
  23  * @author    Martin Trapp, Christian Schaefer, Goetz Lindenmaier
  24  * This header includes all other firm headers and can be included conveniently
  25  * by users of the library.
  26  */
  27
  28 /** @mainpage
  29  *
  30  *  FIRM is a full graph based intermediate representation in SSA Form
  31  *  with a novel concept to model side effects.  It allows fast, aggressive
  32  *  optimizations.
  33  *
  34  *  The internal representation of a program in firm is separated into five
  35  *  different modules:
  36  *   - Firm Graphs representing the code of a program. (Subdirectory ir.)
  37  *     Firm Graphs are assembled out of several data structures:
  38  *     irprog: represents a program.  Allows access to all types and all
  39  *       FIRM graphs for procedures and other global things.
  40  *     irgraph: represents a procedure.  Allows access to the code of the
  41  *       procedure, the actual FIRM graph.
  42  *     irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
  43  *   and represent instructions in a program.
  44  *     irop: The opcode of FIRM nodes.
  45  *     irmode: The mode of FIRM nodes.  Most modes correspond to machine known
  46  *       data types (int, float, pointer).
  47  *   - Entities representing program known objects. (Subdirectory tr.)
  48  *     All variables and procedures are entities.
  49  *   - Types describing the type system for the program. (Subdirectory tr.)
  50  *   - Target Values representing program known constants. (Subdirectory tv.)
  51  *   - Identifiers representing any Strings used in the program. (Subdirectory ident.)
  52  *
  53  *   Further this library supplies functionality to build and optimize FIRM graphs
  54  *   and further functionality needed in a compiler.  Finally there is more
  55  *   generic functionality to support implementations using firm.
  56  *   (Code generation, further optimizations).
  57  */
  58
  59 /** @defgroup irana Analyses */
  60
  61 /** @defgroup adt Abstract Data Structures
  62  * This module contains abstract datatypes. The firm API is fully functional
  63  * without these abstract datatypes. They're provided as a convenience.
  64  */
  65
  66 /** @defgroup algorithms Algorithms
  67  * This module contains generic algorithms. The firm API is fully functional
  68  * without them. They're provided as a convenience.
  69  */
  70 #ifndef FIRM_COMMON_FIRM_H
  71 #define FIRM_COMMON_FIRM_H
  72
  73 #include "analyze_irg_args.h"
  74 #include "be.h"
  75 #include "callgraph.h"
  76 #include "cdep.h"
  77 #include "cgana.h"
  78 #include "dbginfo.h"
  79 #include "execfreq.h"
  80 #include "firm_common.h"
  81 #include "firmstat.h"
  82 #include "firm_types.h"
  83 #include "heights.h"
  84 #include "ident.h"
  85 #include "irarch.h"
  86 #include "ircgopt.h"
  87 #include "irconsconfirm.h"
  88 #include "ircons.h"
  89 #include "irdom.h"
  90 #include "vrp.h"
  91 #include "irdump.h"
  92 #include "iredgekinds.h"
  93 #include "iredges.h"
  94 #include "irextbb.h"
  95 #include "irflag.h"
  96 #include "irgmod.h"
  97 #include "irgopt.h"
  98 #include "irgraph.h"
  99 #include "irgwalk.h"
 100 #include "irhooks.h"
 101 #include "irio.h"
 102 #include "irloop.h"
 103 #include "irmemory.h"
 104 #include "irmode.h"
 105 #include "irnode.h"
 106 #include "irop.h"
 107 #include "iropt.h"
 108 #include "iroptimize.h"
 109 #include "irouts.h"
 110 #include "irpass.h"
 111 #include "irprintf.h"
 112 #include "irprog.h"
 113 #include "irtypeinfo.h"
 114 #include "irverify.h"
 115 #include "lowering.h"
 116 #include "timing.h"
 117 #include "trouts.h"
 118 #include "tv.h"
 119 #include "typerep.h"
 120
 121 #endif