don't mention LIBCORE in public headers
[libfirm] / include / libfirm / be.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       Generic backend types and interfaces.
23  * @author      Sebastian Hack
24  * @version     $Id$
25  */
26 #ifndef FIRM_BE_MAIN_H
27 #define FIRM_BE_MAIN_H
28
29 #include <stdio.h>
30 #include "irarch.h"
31 #include "archop.h"
32 #include "lowering.h"
33
34 /**
35  * This structure contains parameters that should be
36  * propagated to the libFirm parameter set.
37  */
38 typedef struct backend_params {
39         /** if set, the backend cannot handle DWORD access */
40         unsigned do_dw_lowering:1;
41         /** if set, the backend supports inline assembly */
42         unsigned support_inline_asm:1;
43
44         /** Additional opcodes settings. */
45         const arch_ops_info *arch_op_settings;
46
47         /** Settings for architecture dependent optimizations */
48         const ir_settings_arch_dep_t *dep_param;
49
50         /** the architecture specific intrinsic function creator */
51         create_intrinsic_fkt *arch_create_intrinsic_fkt;
52
53         /** the context parameter for the create intrinsic function */
54         void *create_intrinsic_ctx;
55
56         /** backend settings for if-conversion */
57         const ir_settings_if_conv_t *if_conv_info;
58 } backend_params;
59
60 /**
61  * Register the Firm backend command line options.
62  */
63 void be_opt_register(void);
64
65 /**
66  * Parse one backend argument.
67  */
68 int be_parse_arg(const char *arg);
69
70 /**
71  * Initialize the Firm backend. Must be run BEFORE init_firm()!
72  *
73  * @return libFirm configuration parameters for the selected
74  *         backend
75  */
76 const backend_params *be_init(void);
77
78 /**
79  * Main interface to the frontend.
80  */
81 void be_main(FILE *file_handle, const char *cup_name);
82
83 typedef struct be_main_env_t be_main_env_t;
84 typedef struct be_options_t  be_options_t;
85
86 #endif /* FIRM_BE_MAIN_H */