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