preprocess.h revision 1.1.1.1.10.2 1 1.1.1.1.10.2 tls /******************************************************************************
2 1.1.1.1.10.2 tls *
3 1.1.1.1.10.2 tls * Module Name: preprocess.h - header for iASL Preprocessor
4 1.1.1.1.10.2 tls *
5 1.1.1.1.10.2 tls *****************************************************************************/
6 1.1.1.1.10.2 tls
7 1.1.1.1.10.2 tls /*
8 1.1.1.1.10.2 tls * Copyright (C) 2000 - 2013, Intel Corp.
9 1.1.1.1.10.2 tls * All rights reserved.
10 1.1.1.1.10.2 tls *
11 1.1.1.1.10.2 tls * Redistribution and use in source and binary forms, with or without
12 1.1.1.1.10.2 tls * modification, are permitted provided that the following conditions
13 1.1.1.1.10.2 tls * are met:
14 1.1.1.1.10.2 tls * 1. Redistributions of source code must retain the above copyright
15 1.1.1.1.10.2 tls * notice, this list of conditions, and the following disclaimer,
16 1.1.1.1.10.2 tls * without modification.
17 1.1.1.1.10.2 tls * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.1.10.2 tls * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.1.10.2 tls * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.1.10.2 tls * including a substantially similar Disclaimer requirement for further
21 1.1.1.1.10.2 tls * binary redistribution.
22 1.1.1.1.10.2 tls * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.1.10.2 tls * of any contributors may be used to endorse or promote products derived
24 1.1.1.1.10.2 tls * from this software without specific prior written permission.
25 1.1.1.1.10.2 tls *
26 1.1.1.1.10.2 tls * Alternatively, this software may be distributed under the terms of the
27 1.1.1.1.10.2 tls * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.1.10.2 tls * Software Foundation.
29 1.1.1.1.10.2 tls *
30 1.1.1.1.10.2 tls * NO WARRANTY
31 1.1.1.1.10.2 tls * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.1.10.2 tls * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.1.10.2 tls * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.1.10.2 tls * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.1.10.2 tls * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.1.10.2 tls * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.1.10.2 tls * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.1.10.2 tls * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.1.10.2 tls * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.1.10.2 tls * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.1.10.2 tls * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.1.10.2 tls */
43 1.1.1.1.10.2 tls
44 1.1.1.1.10.2 tls #define __PREPROCESS_H__
45 1.1.1.1.10.2 tls
46 1.1.1.1.10.2 tls #ifndef _PREPROCESS
47 1.1.1.1.10.2 tls #define _PREPROCESS
48 1.1.1.1.10.2 tls
49 1.1.1.1.10.2 tls #undef PR_EXTERN
50 1.1.1.1.10.2 tls
51 1.1.1.1.10.2 tls #ifdef _DECLARE_PR_GLOBALS
52 1.1.1.1.10.2 tls #define PR_EXTERN
53 1.1.1.1.10.2 tls #define PR_INIT_GLOBAL(a,b) (a)=(b)
54 1.1.1.1.10.2 tls #else
55 1.1.1.1.10.2 tls #define PR_EXTERN extern
56 1.1.1.1.10.2 tls #define PR_INIT_GLOBAL(a,b) (a)
57 1.1.1.1.10.2 tls #endif
58 1.1.1.1.10.2 tls
59 1.1.1.1.10.2 tls
60 1.1.1.1.10.2 tls /*
61 1.1.1.1.10.2 tls * Configuration
62 1.1.1.1.10.2 tls */
63 1.1.1.1.10.2 tls #define PR_MAX_MACRO_ARGS 32 /* Max number of macro args */
64 1.1.1.1.10.2 tls #define PR_MAX_ARG_INSTANCES 24 /* Max instances of any one arg */
65 1.1.1.1.10.2 tls #define PR_LINES_PER_BLOCK 4096 /* Max input source lines per block */
66 1.1.1.1.10.2 tls
67 1.1.1.1.10.2 tls
68 1.1.1.1.10.2 tls /*
69 1.1.1.1.10.2 tls * Local defines and macros
70 1.1.1.1.10.2 tls */
71 1.1.1.1.10.2 tls #define PR_TOKEN_SEPARATORS " ,(){}\t\n"
72 1.1.1.1.10.2 tls #define PR_MACRO_SEPARATORS " ,(){}~!*/%+-<>=&^|\"\t\n"
73 1.1.1.1.10.2 tls #define PR_MACRO_ARGUMENTS " ,\t\n"
74 1.1.1.1.10.2 tls #define PR_EXPR_SEPARATORS " ,(){}~!*/%+-<>=&^|\"\t\n"
75 1.1.1.1.10.2 tls
76 1.1.1.1.10.2 tls #define PR_PREFIX_ID "Pr(%.4u) - " /* Used for debug output */
77 1.1.1.1.10.2 tls
78 1.1.1.1.10.2 tls #define THIS_TOKEN_OFFSET(t) ((t-Gbl_MainTokenBuffer) + 1)
79 1.1.1.1.10.2 tls
80 1.1.1.1.10.2 tls
81 1.1.1.1.10.2 tls /*
82 1.1.1.1.10.2 tls * Preprocessor structures
83 1.1.1.1.10.2 tls */
84 1.1.1.1.10.2 tls typedef struct pr_macro_arg
85 1.1.1.1.10.2 tls {
86 1.1.1.1.10.2 tls char *Name;
87 1.1.1.1.10.2 tls UINT32 Offset[PR_MAX_ARG_INSTANCES];
88 1.1.1.1.10.2 tls UINT16 UseCount;
89 1.1.1.1.10.2 tls
90 1.1.1.1.10.2 tls } PR_MACRO_ARG;
91 1.1.1.1.10.2 tls
92 1.1.1.1.10.2 tls typedef struct pr_define_info
93 1.1.1.1.10.2 tls {
94 1.1.1.1.10.2 tls struct pr_define_info *Previous;
95 1.1.1.1.10.2 tls struct pr_define_info *Next;
96 1.1.1.1.10.2 tls char *Identifier;
97 1.1.1.1.10.2 tls char *Replacement;
98 1.1.1.1.10.2 tls char *Body; /* Macro body */
99 1.1.1.1.10.2 tls PR_MACRO_ARG *Args; /* Macro arg list */
100 1.1.1.1.10.2 tls UINT16 ArgCount; /* Macro arg count */
101 1.1.1.1.10.2 tls BOOLEAN Persist; /* Keep for entire compiler run */
102 1.1.1.1.10.2 tls
103 1.1.1.1.10.2 tls } PR_DEFINE_INFO;
104 1.1.1.1.10.2 tls
105 1.1.1.1.10.2 tls typedef struct pr_directive_info
106 1.1.1.1.10.2 tls {
107 1.1.1.1.10.2 tls char *Name; /* Directive name */
108 1.1.1.1.10.2 tls UINT8 ArgCount; /* Required # of args */
109 1.1.1.1.10.2 tls
110 1.1.1.1.10.2 tls } PR_DIRECTIVE_INFO;
111 1.1.1.1.10.2 tls
112 1.1.1.1.10.2 tls typedef struct pr_operator_info
113 1.1.1.1.10.2 tls {
114 1.1.1.1.10.2 tls char *Op;
115 1.1.1.1.10.2 tls
116 1.1.1.1.10.2 tls } PR_OPERATOR_INFO;
117 1.1.1.1.10.2 tls
118 1.1.1.1.10.2 tls typedef struct pr_file_node
119 1.1.1.1.10.2 tls {
120 1.1.1.1.10.2 tls struct pr_file_node *Next;
121 1.1.1.1.10.2 tls FILE *File;
122 1.1.1.1.10.2 tls char *Filename;
123 1.1.1.1.10.2 tls UINT32 CurrentLineNumber;
124 1.1.1.1.10.2 tls
125 1.1.1.1.10.2 tls } PR_FILE_NODE;
126 1.1.1.1.10.2 tls
127 1.1.1.1.10.2 tls #define MAX_ARGUMENT_LENGTH 24
128 1.1.1.1.10.2 tls
129 1.1.1.1.10.2 tls typedef struct directive_info
130 1.1.1.1.10.2 tls {
131 1.1.1.1.10.2 tls struct directive_info *Next;
132 1.1.1.1.10.2 tls char Argument[MAX_ARGUMENT_LENGTH];
133 1.1.1.1.10.2 tls int Directive;
134 1.1.1.1.10.2 tls BOOLEAN IgnoringThisCodeBlock;
135 1.1.1.1.10.2 tls
136 1.1.1.1.10.2 tls } DIRECTIVE_INFO;
137 1.1.1.1.10.2 tls
138 1.1.1.1.10.2 tls
139 1.1.1.1.10.2 tls /*
140 1.1.1.1.10.2 tls * Globals
141 1.1.1.1.10.2 tls */
142 1.1.1.1.10.2 tls #if 0 /* TBD for macros */
143 1.1.1.1.10.2 tls PR_EXTERN char PR_INIT_GLOBAL (*XXXEvalBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
144 1.1.1.1.10.2 tls #endif
145 1.1.1.1.10.2 tls
146 1.1.1.1.10.2 tls PR_EXTERN char PR_INIT_GLOBAL (*Gbl_MainTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
147 1.1.1.1.10.2 tls PR_EXTERN char PR_INIT_GLOBAL (*Gbl_MacroTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
148 1.1.1.1.10.2 tls PR_EXTERN char PR_INIT_GLOBAL (*Gbl_ExpressionTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
149 1.1.1.1.10.2 tls
150 1.1.1.1.10.2 tls PR_EXTERN UINT32 Gbl_PreprocessorLineNumber;
151 1.1.1.1.10.2 tls PR_EXTERN int Gbl_IfDepth;
152 1.1.1.1.10.2 tls PR_EXTERN PR_FILE_NODE *Gbl_InputFileList;
153 1.1.1.1.10.2 tls PR_EXTERN PR_DEFINE_INFO PR_INIT_GLOBAL (*Gbl_DefineList, NULL);
154 1.1.1.1.10.2 tls PR_EXTERN BOOLEAN PR_INIT_GLOBAL (Gbl_PreprocessorError, FALSE);
155 1.1.1.1.10.2 tls PR_EXTERN BOOLEAN PR_INIT_GLOBAL (Gbl_IgnoringThisCodeBlock, FALSE);
156 1.1.1.1.10.2 tls PR_EXTERN DIRECTIVE_INFO PR_INIT_GLOBAL (*Gbl_DirectiveStack, NULL);
157 1.1.1.1.10.2 tls
158 1.1.1.1.10.2 tls /*
159 1.1.1.1.10.2 tls * prscan - Preprocessor entry
160 1.1.1.1.10.2 tls */
161 1.1.1.1.10.2 tls void
162 1.1.1.1.10.2 tls PrInitializePreprocessor (
163 1.1.1.1.10.2 tls void);
164 1.1.1.1.10.2 tls
165 1.1.1.1.10.2 tls void
166 1.1.1.1.10.2 tls PrInitializeGlobals (
167 1.1.1.1.10.2 tls void);
168 1.1.1.1.10.2 tls
169 1.1.1.1.10.2 tls void
170 1.1.1.1.10.2 tls PrTerminatePreprocessor (
171 1.1.1.1.10.2 tls void);
172 1.1.1.1.10.2 tls
173 1.1.1.1.10.2 tls void
174 1.1.1.1.10.2 tls PrDoPreprocess (
175 1.1.1.1.10.2 tls void);
176 1.1.1.1.10.2 tls
177 1.1.1.1.10.2 tls UINT64
178 1.1.1.1.10.2 tls PrIsDefined (
179 1.1.1.1.10.2 tls char *Identifier);
180 1.1.1.1.10.2 tls
181 1.1.1.1.10.2 tls UINT64
182 1.1.1.1.10.2 tls PrResolveDefine (
183 1.1.1.1.10.2 tls char *Identifier);
184 1.1.1.1.10.2 tls
185 1.1.1.1.10.2 tls int
186 1.1.1.1.10.2 tls PrInitLexer (
187 1.1.1.1.10.2 tls char *String);
188 1.1.1.1.10.2 tls
189 1.1.1.1.10.2 tls void
190 1.1.1.1.10.2 tls PrTerminateLexer (
191 1.1.1.1.10.2 tls void);
192 1.1.1.1.10.2 tls
193 1.1.1.1.10.2 tls
194 1.1.1.1.10.2 tls /*
195 1.1.1.1.10.2 tls * prmacros - Support for #defines and macros
196 1.1.1.1.10.2 tls */
197 1.1.1.1.10.2 tls void
198 1.1.1.1.10.2 tls PrDumpPredefinedNames (
199 1.1.1.1.10.2 tls void);
200 1.1.1.1.10.2 tls
201 1.1.1.1.10.2 tls PR_DEFINE_INFO *
202 1.1.1.1.10.2 tls PrAddDefine (
203 1.1.1.1.10.2 tls char *Token,
204 1.1.1.1.10.2 tls char *Token2,
205 1.1.1.1.10.2 tls BOOLEAN Persist);
206 1.1.1.1.10.2 tls
207 1.1.1.1.10.2 tls void
208 1.1.1.1.10.2 tls PrRemoveDefine (
209 1.1.1.1.10.2 tls char *DefineName);
210 1.1.1.1.10.2 tls
211 1.1.1.1.10.2 tls PR_DEFINE_INFO *
212 1.1.1.1.10.2 tls PrMatchDefine (
213 1.1.1.1.10.2 tls char *MatchString);
214 1.1.1.1.10.2 tls
215 1.1.1.1.10.2 tls void
216 1.1.1.1.10.2 tls PrAddMacro (
217 1.1.1.1.10.2 tls char *Name,
218 1.1.1.1.10.2 tls char **Next);
219 1.1.1.1.10.2 tls
220 1.1.1.1.10.2 tls void
221 1.1.1.1.10.2 tls PrDoMacroInvocation (
222 1.1.1.1.10.2 tls char *TokenBuffer,
223 1.1.1.1.10.2 tls char *MacroStart,
224 1.1.1.1.10.2 tls PR_DEFINE_INFO *DefineInfo,
225 1.1.1.1.10.2 tls char **Next);
226 1.1.1.1.10.2 tls
227 1.1.1.1.10.2 tls
228 1.1.1.1.10.2 tls /*
229 1.1.1.1.10.2 tls * prexpress - #if expression support
230 1.1.1.1.10.2 tls */
231 1.1.1.1.10.2 tls ACPI_STATUS
232 1.1.1.1.10.2 tls PrResolveIntegerExpression (
233 1.1.1.1.10.2 tls char *Line,
234 1.1.1.1.10.2 tls UINT64 *ReturnValue);
235 1.1.1.1.10.2 tls
236 1.1.1.1.10.2 tls char *
237 1.1.1.1.10.2 tls PrPrioritizeExpression (
238 1.1.1.1.10.2 tls char *OriginalLine);
239 1.1.1.1.10.2 tls
240 1.1.1.1.10.2 tls /*
241 1.1.1.1.10.2 tls * prparser - lex/yacc expression parser
242 1.1.1.1.10.2 tls */
243 1.1.1.1.10.2 tls UINT64
244 1.1.1.1.10.2 tls PrEvaluateExpression (
245 1.1.1.1.10.2 tls char *ExprString);
246 1.1.1.1.10.2 tls
247 1.1.1.1.10.2 tls
248 1.1.1.1.10.2 tls /*
249 1.1.1.1.10.2 tls * prutils - Preprocesor utilities
250 1.1.1.1.10.2 tls */
251 1.1.1.1.10.2 tls char *
252 1.1.1.1.10.2 tls PrGetNextToken (
253 1.1.1.1.10.2 tls char *Buffer,
254 1.1.1.1.10.2 tls char *MatchString,
255 1.1.1.1.10.2 tls char **Next);
256 1.1.1.1.10.2 tls
257 1.1.1.1.10.2 tls void
258 1.1.1.1.10.2 tls PrError (
259 1.1.1.1.10.2 tls UINT8 Level,
260 1.1.1.1.10.2 tls UINT8 MessageId,
261 1.1.1.1.10.2 tls UINT32 Column);
262 1.1.1.1.10.2 tls
263 1.1.1.1.10.2 tls void
264 1.1.1.1.10.2 tls PrReplaceData (
265 1.1.1.1.10.2 tls char *Buffer,
266 1.1.1.1.10.2 tls UINT32 LengthToRemove,
267 1.1.1.1.10.2 tls char *BufferToAdd,
268 1.1.1.1.10.2 tls UINT32 LengthToAdd);
269 1.1.1.1.10.2 tls
270 1.1.1.1.10.2 tls void
271 1.1.1.1.10.2 tls PrOpenIncludeFile (
272 1.1.1.1.10.2 tls char *Filename);
273 1.1.1.1.10.2 tls
274 1.1.1.1.10.2 tls FILE *
275 1.1.1.1.10.2 tls PrOpenIncludeWithPrefix (
276 1.1.1.1.10.2 tls char *PrefixDir,
277 1.1.1.1.10.2 tls char *Filename);
278 1.1.1.1.10.2 tls
279 1.1.1.1.10.2 tls void
280 1.1.1.1.10.2 tls PrPushInputFileStack (
281 1.1.1.1.10.2 tls FILE *InputFile,
282 1.1.1.1.10.2 tls char *Filename);
283 1.1.1.1.10.2 tls
284 1.1.1.1.10.2 tls BOOLEAN
285 1.1.1.1.10.2 tls PrPopInputFileStack (
286 1.1.1.1.10.2 tls void);
287 1.1.1.1.10.2 tls
288 1.1.1.1.10.2 tls #endif
289