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

   1 /*
   2  * Copyright (C) 1995-2008 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    common firm declarations
  23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier
  24  * @version  $Id$
  25  */
  26 #ifndef FIRM_COMMON_FIRM_COMMON_H
  27 #define FIRM_COMMON_FIRM_COMMON_H
  28
  29 #include "firm_types.h"
  30 #include "begin.h"
  31
  32 /**
  33  * libFirm initialization parameters.
  34  */
  35 struct _firm_parameter_t {
  36         /**
  37          * The size of this structure. init_firm() will only initialize
  38          * this amount of data. This allows to add more fields to this structure
  39          * without breaking compatibility to older source.
  40          */
  41         unsigned int size;
  42
  43         /**
  44          * Statistic options. If statistic function where enabled, these
  45          * flags configure it, see enum firmstat_options_t.
  46          */
  47         unsigned enable_statistics;
  48
  49         /**
  50          * This function is called, whenever a local variable is
  51          * used before definition. The function should insert a default value,
  52          * and/or raise a compiler error/warning. Note that returning
  53          * an Unknown is allowed here.
  54          */
  55         uninitialized_local_variable_func_t *initialize_local_func;
  56
  57         /**
  58          * The interface functions for the type identification module.
  59          * If not set, the default implementation with compare_strict() and
  60          * firm_hash_name() will be used.
  61          */
  62         type_identify_if_t *ti_if;
  63
  64         /**
  65          * dummy parameter
  66          * (this used to hold an identifier module structure)
  67          */
  68         void *id_if;
  69
  70         /**
  71          * dummy parameter
  72          * (this used to hold a default calling convention, but this concept is no
  73          *  more. You should always set the calling convention manually after
  74          *  creating the method entity if you need something else)
  75          */
  76         unsigned cc_mask;
  77
  78         /**
  79          * dummy (here was dbg_info *builtin_dbg before)
  80          */
  81         void *dummy;
  82 };
  83
  84 typedef struct _firm_parameter_t firm_parameter_t;
  85
  86 /**
  87  * Initialize the firm library.
  88  *
  89  * Initializes the firm library.  Allocates default data structures.
  90  * Initializes configurable behavior of the library.
  91  *
  92  * @param params   A structure containing the parameters of the libFirm.
  93  *
  94  * The parameter struct may be NULL. In that case, the original FIRM behavior
  95  * is conserved.
  96  */
  97 FIRM_API void ir_init(const firm_parameter_t *params);
  98
  99 /**
 100  * Frees all memory occupied by the firm library.
 101  */
 102 FIRM_API void ir_finish(void);
 103
 104 /** returns the libFirm major version number */
 105 FIRM_API unsigned ir_get_version_major(void);
 106 /** returns libFirm minor version number */
 107 FIRM_API unsigned ir_get_version_minor(void);
 108 /** returns string describing libFirm revision */
 109 FIRM_API const char *ir_get_version_revision(void);
 110 /** returns string describing libFirm build */
 111 FIRM_API const char *ir_get_version_build(void);
 112
 113
 114
 115 /** a list of firm kinds
 116  @@@ not all datatypes are tagged yet. */
 117 typedef enum {
 118         k_BAD = 0,                /**< An invalid firm node. */
 119         k_entity,                 /**< An entity. */
 120         k_type,                   /**< A type. */
 121         k_ir_graph,               /**< An IR graph. */
 122         k_ir_node,                /**< An IR node. */
 123         k_ir_mode,                /**< An IR mode. */
 124         k_ir_op,                  /**< An IR opcode. */
 125         k_tarval,                 /**< A tarval. */
 126         k_ir_loop,                /**< A loop. */
 127         k_ir_compound_graph_path, /**< A compound graph path, see entity.h. */
 128         k_ir_extblk,              /**< An extended basic block. */
 129         k_ir_prog,                /**< A program representation (irp). */
 130         k_ir_region,              /**< A region. */
 131         k_ir_graph_pass,          /**< An ir_graph pass. */
 132         k_ir_prog_pass,           /**< An ir_prog pass. */
 133         k_ir_graph_pass_mgr,      /**< An ir_graph pass manager. */
 134         k_ir_prog_pass_mgr,       /**< An ir_prog pass manager. */
 135         k_ir_max                  /**< maximum value -- illegal for firm nodes. */
 136 } firm_kind;
 137
 138 /**
 139  * Returns the kind of a thing.
 140  *
 141  * @param firm_thing  pointer representing a firm object
 142  */
 143 FIRM_API firm_kind get_kind(const void *firm_thing);
 144
 145 /** Returns the kind of a thing as a string. */
 146 FIRM_API const char *print_firm_kind(void *firm_thing);
 147
 148 /** Print an identification of a firm thing. */
 149 FIRM_API void firm_identify_thing(void *X);
 150
 151 #include "end.h"
 152
 153 #endif