]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Common/Expression.py
BaseTools: report error if flag in LABEL() invalid
[mirror_edk2.git] / BaseTools / Source / Python / Common / Expression.py
CommitLineData
0d2711a6
LG
1## @file\r
2# This file is used to parse and evaluate expression in directive or PCD value.\r
3#\r
35f613d9 4# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
0d2711a6
LG
5# This program and the accompanying materials\r
6# are licensed and made available under the terms and conditions of the BSD License\r
7# which accompanies this distribution. The full text of the license may be found at\r
8# http://opensource.org/licenses/bsd-license.php\r
9#\r
10# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13## Import Modules\r
14#\r
15from Common.GlobalData import *\r
16from CommonDataClass.Exceptions import BadExpression\r
0d2711a6 17from CommonDataClass.Exceptions import WrnExpression\r
726c501c
YZ
18from Misc import GuidStringToGuidStructureString, ParseFieldValue\r
19import Common.EdkLogger as EdkLogger\r
20import copy\r
0d2711a6
LG
21\r
22ERR_STRING_EXPR = 'This operator cannot be used in string expression: [%s].'\r
23ERR_SNYTAX = 'Syntax error, the rest of expression cannot be evaluated: [%s].'\r
24ERR_MATCH = 'No matching right parenthesis.'\r
25ERR_STRING_TOKEN = 'Bad string token: [%s].'\r
26ERR_MACRO_TOKEN = 'Bad macro token: [%s].'\r
27ERR_EMPTY_TOKEN = 'Empty token is not allowed.'\r
28ERR_PCD_RESOLVE = 'PCD token cannot be resolved: [%s].'\r
29ERR_VALID_TOKEN = 'No more valid token found from rest of string: [%s].'\r
30ERR_EXPR_TYPE = 'Different types found in expression.'\r
31ERR_OPERATOR_UNSUPPORT = 'Unsupported operator: [%s]'\r
32ERR_REL_NOT_IN = 'Expect "IN" after "not" operator.'\r
33WRN_BOOL_EXPR = 'Operand of boolean type cannot be used in arithmetic expression.'\r
34WRN_EQCMP_STR_OTHERS = '== Comparison between Operand of string type and Boolean/Number Type always return False.'\r
35WRN_NECMP_STR_OTHERS = '!= Comparison between Operand of string type and Boolean/Number Type always return True.'\r
36ERR_RELCMP_STR_OTHERS = 'Operator taking Operand of string type and Boolean/Number Type is not allowed: [%s].'\r
37ERR_STRING_CMP = 'Unicode string and general string cannot be compared: [%s %s %s]'\r
38ERR_ARRAY_TOKEN = 'Bad C array or C format GUID token: [%s].'\r
39ERR_ARRAY_ELE = 'This must be HEX value for NList or Array: [%s].'\r
d0acc87a 40ERR_EMPTY_EXPR = 'Empty expression is not allowed.'\r
64b2609f 41ERR_IN_OPERAND = 'Macro after IN operator can only be: $(FAMILY), $(ARCH), $(TOOL_CHAIN_TAG) and $(TARGET).'\r
0d2711a6
LG
42\r
43## SplitString\r
44# Split string to list according double quote\r
45# For example: abc"de\"f"ghi"jkl"mn will be: ['abc', '"de\"f"', 'ghi', '"jkl"', 'mn']\r
46#\r
47def SplitString(String):\r
ea927d2f
FY
48 # There might be escaped quote: "abc\"def\\\"ghi", 'abc\'def\\\'ghi'\r
49 Str = String\r
0d2711a6 50 RetList = []\r
ea927d2f
FY
51 InSingleQuote = False\r
52 InDoubleQuote = False\r
0d2711a6
LG
53 Item = ''\r
54 for i, ch in enumerate(Str):\r
ea927d2f
FY
55 if ch == '"' and not InSingleQuote:\r
56 if Str[i - 1] != '\\':\r
57 InDoubleQuote = not InDoubleQuote\r
58 if not InDoubleQuote:\r
59 Item += String[i]\r
60 RetList.append(Item)\r
61 Item = ''\r
62 continue\r
63 if Item:\r
64 RetList.append(Item)\r
65 Item = ''\r
66 elif ch == "'" and not InDoubleQuote:\r
67 if Str[i - 1] != '\\':\r
68 InSingleQuote = not InSingleQuote\r
69 if not InSingleQuote:\r
0d2711a6
LG
70 Item += String[i]\r
71 RetList.append(Item)\r
72 Item = ''\r
73 continue\r
74 if Item:\r
75 RetList.append(Item)\r
76 Item = ''\r
77 Item += String[i]\r
ea927d2f 78 if InSingleQuote or InDoubleQuote:\r
0d2711a6
LG
79 raise BadExpression(ERR_STRING_TOKEN % Item)\r
80 if Item:\r
81 RetList.append(Item)\r
82 return RetList\r
83\r
3be421e9
FY
84def SplitPcdValueString(String):\r
85 # There might be escaped comma in GUID() or DEVICE_PATH() or " "\r
86 # or ' ' or L' ' or L" "\r
87 Str = String\r
88 RetList = []\r
89 InParenthesis = 0\r
90 InSingleQuote = False\r
91 InDoubleQuote = False\r
92 Item = ''\r
93 for i, ch in enumerate(Str):\r
94 if ch == '(':\r
95 InParenthesis += 1\r
96 if ch == ')':\r
97 if InParenthesis:\r
98 InParenthesis -= 1\r
99 else:\r
100 raise BadExpression(ERR_STRING_TOKEN % Item)\r
101 if ch == '"' and not InSingleQuote:\r
102 if String[i-1] != '\\':\r
103 InDoubleQuote = not InDoubleQuote\r
104 if ch == "'" and not InDoubleQuote:\r
105 if String[i-1] != '\\':\r
106 InSingleQuote = not InSingleQuote\r
107 if ch == ',':\r
108 if InParenthesis or InSingleQuote or InDoubleQuote:\r
109 Item += String[i]\r
110 continue\r
111 elif Item:\r
112 RetList.append(Item)\r
113 Item = ''\r
114 continue\r
115 Item += String[i]\r
116 if InSingleQuote or InDoubleQuote or InParenthesis:\r
117 raise BadExpression(ERR_STRING_TOKEN % Item)\r
118 if Item:\r
119 RetList.append(Item)\r
120 return RetList\r
121\r
5ac0a545
FY
122def IsValidCString(Str):\r
123 ValidString = re.compile(r'[_a-zA-Z][_0-9a-zA-Z]*$')\r
124 if not ValidString.match(Str):\r
125 return False\r
126 return True\r
127\r
0d2711a6
LG
128## ReplaceExprMacro\r
129#\r
130def ReplaceExprMacro(String, Macros, ExceptionList = None):\r
131 StrList = SplitString(String)\r
132 for i, String in enumerate(StrList):\r
133 InQuote = False\r
134 if String.startswith('"'):\r
135 InQuote = True\r
136 MacroStartPos = String.find('$(')\r
137 if MacroStartPos < 0:\r
c8d07c5e
YZ
138 for Pcd in gPlatformPcds.keys():\r
139 if Pcd in String:\r
140 if Pcd not in gConditionalPcds:\r
141 gConditionalPcds.append(Pcd)\r
0d2711a6
LG
142 continue\r
143 RetStr = ''\r
144 while MacroStartPos >= 0:\r
145 RetStr = String[0:MacroStartPos]\r
146 MacroEndPos = String.find(')', MacroStartPos)\r
147 if MacroEndPos < 0:\r
148 raise BadExpression(ERR_MACRO_TOKEN % String[MacroStartPos:])\r
149 Macro = String[MacroStartPos+2:MacroEndPos]\r
150 if Macro not in Macros:\r
151 # From C reference manual:\r
152 # If an undefined macro name appears in the constant-expression of\r
153 # !if or !elif, it is replaced by the integer constant 0.\r
154 RetStr += '0'\r
64b2609f
LG
155 elif not InQuote:\r
156 Tklst = RetStr.split()\r
157 if Tklst and Tklst[-1] in ['IN', 'in'] and ExceptionList and Macro not in ExceptionList:\r
158 raise BadExpression(ERR_IN_OPERAND)\r
0d2711a6
LG
159 # Make sure the macro in exception list is encapsulated by double quote\r
160 # For example: DEFINE ARCH = IA32 X64\r
161 # $(ARCH) is replaced with "IA32 X64"\r
64b2609f
LG
162 if ExceptionList and Macro in ExceptionList:\r
163 RetStr += '"' + Macros[Macro] + '"'\r
164 elif Macros[Macro].strip():\r
0d2711a6
LG
165 RetStr += Macros[Macro]\r
166 else:\r
167 RetStr += '""'\r
64b2609f
LG
168 else:\r
169 RetStr += Macros[Macro]\r
0d2711a6
LG
170 RetStr += String[MacroEndPos+1:]\r
171 String = RetStr\r
172 MacroStartPos = String.find('$(')\r
173 StrList[i] = RetStr\r
174 return ''.join(StrList)\r
175\r
726c501c
YZ
176# transfer int to string for in/not in expression\r
177def IntToStr(Value):\r
178 StrList = []\r
179 while Value > 0:\r
180 StrList.append(chr(Value & 0xff))\r
181 Value = Value >> 8\r
182 Value = '"' + ''.join(StrList) + '"'\r
183 return Value\r
184\r
64b2609f
LG
185SupportedInMacroList = ['TARGET', 'TOOL_CHAIN_TAG', 'ARCH', 'FAMILY']\r
186\r
0d2711a6
LG
187class ValueExpression(object):\r
188 # Logical operator mapping\r
189 LogicalOperators = {\r
190 '&&' : 'and', '||' : 'or',\r
191 '!' : 'not', 'AND': 'and',\r
192 'OR' : 'or' , 'NOT': 'not',\r
193 'XOR': '^' , 'xor': '^',\r
194 'EQ' : '==' , 'NE' : '!=',\r
195 'GT' : '>' , 'LT' : '<',\r
196 'GE' : '>=' , 'LE' : '<=',\r
197 'IN' : 'in'\r
198 }\r
199\r
bc0d7233 200 NonLetterOpLst = ['+', '-', '*', '/', '%', '&', '|', '^', '~', '<<', '>>', '!', '=', '>', '<', '?', ':']\r
0d2711a6
LG
201\r
202 PcdPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_]*\.[_a-zA-Z][0-9A-Za-z_]*$')\r
203 HexPattern = re.compile(r'0[xX][0-9a-fA-F]+$')\r
204 RegGuidPattern = re.compile(r'[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}')\r
205\r
206 SymbolPattern = re.compile("("\r
207 "\$\([A-Z][A-Z0-9_]*\)|\$\(\w+\.\w+\)|\w+\.\w+|"\r
208 "&&|\|\||!(?!=)|"\r
209 "(?<=\W)AND(?=\W)|(?<=\W)OR(?=\W)|(?<=\W)NOT(?=\W)|(?<=\W)XOR(?=\W)|"\r
210 "(?<=\W)EQ(?=\W)|(?<=\W)NE(?=\W)|(?<=\W)GT(?=\W)|(?<=\W)LT(?=\W)|(?<=\W)GE(?=\W)|(?<=\W)LE(?=\W)"\r
211 ")")\r
212\r
213 @staticmethod\r
214 def Eval(Operator, Oprand1, Oprand2 = None):\r
215 WrnExp = None\r
d0acc87a 216\r
9efe8d60
YF
217 if Operator not in ["==", "!=", ">=", "<=", ">", "<", "in", "not in"] and \\r
218 (type(Oprand1) == type('') or type(Oprand2) == type('')):\r
219 raise BadExpression(ERR_STRING_EXPR % Operator)\r
726c501c
YZ
220 if Operator in ['in', 'not in']:\r
221 if type(Oprand1) != type(''):\r
222 Oprand1 = IntToStr(Oprand1)\r
223 if type(Oprand2) != type(''):\r
224 Oprand2 = IntToStr(Oprand2)\r
0d2711a6
LG
225 TypeDict = {\r
226 type(0) : 0,\r
227 type(0L) : 0,\r
228 type('') : 1,\r
229 type(True) : 2\r
230 }\r
231\r
232 EvalStr = ''\r
233 if Operator in ["!", "NOT", "not"]:\r
234 if type(Oprand1) == type(''):\r
235 raise BadExpression(ERR_STRING_EXPR % Operator)\r
236 EvalStr = 'not Oprand1'\r
5e06f1a0
YZ
237 elif Operator in ["~"]:\r
238 if type(Oprand1) == type(''):\r
239 raise BadExpression(ERR_STRING_EXPR % Operator)\r
240 EvalStr = '~ Oprand1'\r
0d2711a6
LG
241 else:\r
242 if Operator in ["+", "-"] and (type(True) in [type(Oprand1), type(Oprand2)]):\r
243 # Boolean in '+'/'-' will be evaluated but raise warning\r
244 WrnExp = WrnExpression(WRN_BOOL_EXPR)\r
245 elif type('') in [type(Oprand1), type(Oprand2)] and type(Oprand1)!= type(Oprand2):\r
246 # == between string and number/boolean will always return False, != return True\r
247 if Operator == "==":\r
248 WrnExp = WrnExpression(WRN_EQCMP_STR_OTHERS)\r
249 WrnExp.result = False\r
250 raise WrnExp\r
251 elif Operator == "!=":\r
252 WrnExp = WrnExpression(WRN_NECMP_STR_OTHERS)\r
253 WrnExp.result = True\r
254 raise WrnExp\r
255 else:\r
256 raise BadExpression(ERR_RELCMP_STR_OTHERS % Operator)\r
d0acc87a 257 elif TypeDict[type(Oprand1)] != TypeDict[type(Oprand2)]:\r
0d2711a6
LG
258 if Operator in ["==", "!=", ">=", "<=", ">", "<"] and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):\r
259 # comparison between number and boolean is allowed\r
260 pass\r
d0acc87a 261 elif Operator in ['&', '|', '^', "and", "or"] and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):\r
0d2711a6 262 # bitwise and logical operation between number and boolean is allowed\r
d0acc87a 263 pass\r
0d2711a6
LG
264 else:\r
265 raise BadExpression(ERR_EXPR_TYPE)\r
266 if type(Oprand1) == type('') and type(Oprand2) == type(''):\r
267 if (Oprand1.startswith('L"') and not Oprand2.startswith('L"')) or \\r
268 (not Oprand1.startswith('L"') and Oprand2.startswith('L"')):\r
269 raise BadExpression(ERR_STRING_CMP % (Oprand1, Operator, Oprand2))\r
270 if 'in' in Operator and type(Oprand2) == type(''):\r
271 Oprand2 = Oprand2.split()\r
272 EvalStr = 'Oprand1 ' + Operator + ' Oprand2'\r
273\r
274 # Local symbols used by built in eval function\r
275 Dict = {\r
276 'Oprand1' : Oprand1,\r
277 'Oprand2' : Oprand2\r
278 }\r
279 try:\r
280 Val = eval(EvalStr, {}, Dict)\r
281 except Exception, Excpt:\r
282 raise BadExpression(str(Excpt))\r
283\r
284 if Operator in ['and', 'or']:\r
285 if Val:\r
286 Val = True\r
287 else:\r
288 Val = False\r
d0acc87a 289\r
0d2711a6
LG
290 if WrnExp:\r
291 WrnExp.result = Val\r
292 raise WrnExp\r
293 return Val\r
294\r
295 def __init__(self, Expression, SymbolTable={}):\r
296 self._NoProcess = False\r
297 if type(Expression) != type(''):\r
298 self._Expr = Expression\r
299 self._NoProcess = True\r
300 return\r
301\r
302 self._Expr = ReplaceExprMacro(Expression.strip(),\r
303 SymbolTable,\r
64b2609f 304 SupportedInMacroList)\r
0d2711a6
LG
305\r
306 if not self._Expr.strip():\r
d0acc87a 307 raise BadExpression(ERR_EMPTY_EXPR)\r
0d2711a6
LG
308\r
309 #\r
310 # The symbol table including PCD and macro mapping\r
311 #\r
726c501c 312 self._Symb = copy.deepcopy(SymbolTable)\r
0d2711a6
LG
313 self._Symb.update(self.LogicalOperators)\r
314 self._Idx = 0\r
315 self._Len = len(self._Expr)\r
316 self._Token = ''\r
d0acc87a 317 self._WarnExcept = None\r
0d2711a6
LG
318\r
319 # Literal token without any conversion\r
320 self._LiteralToken = ''\r
321\r
322 # Public entry for this class\r
d0acc87a
LG
323 # @param RealValue: False: only evaluate if the expression is true or false, used for conditional expression\r
324 # True : return the evaluated str(value), used for PCD value\r
325 #\r
326 # @return: True or False if RealValue is False\r
327 # Evaluated value of string format if RealValue is True\r
328 #\r
4afd3d04 329 def __call__(self, RealValue=False, Depth=0):\r
0d2711a6
LG
330 if self._NoProcess:\r
331 return self._Expr\r
332\r
4afd3d04
LG
333 self._Depth = Depth\r
334\r
d0acc87a 335 self._Expr = self._Expr.strip()\r
4afd3d04 336 if RealValue and Depth == 0:\r
d0acc87a
LG
337 self._Token = self._Expr\r
338 if self.__IsNumberToken():\r
339 return self._Expr\r
35f613d9 340 Token = ''\r
25918452
LG
341 try:\r
342 Token = self._GetToken()\r
25918452
LG
343 except BadExpression:\r
344 pass\r
35f613d9 345 if type(Token) == type('') and Token.startswith('{') and Token.endswith('}') and self._Idx >= self._Len:\r
35f613d9 346 return self._Expr\r
d0acc87a
LG
347\r
348 self._Idx = 0\r
349 self._Token = ''\r
350\r
bc0d7233 351 Val = self._ConExpr()\r
d0acc87a
LG
352 RealVal = Val\r
353 if type(Val) == type(''):\r
354 if Val == 'L""':\r
355 Val = False\r
356 elif not Val:\r
357 Val = False\r
358 RealVal = '""'\r
726c501c 359 elif not Val.startswith('L"') and not Val.startswith('{') and not Val.startswith("L'"):\r
d0acc87a
LG
360 Val = True\r
361 RealVal = '"' + RealVal + '"'\r
0d2711a6
LG
362\r
363 # The expression has been parsed, but the end of expression is not reached\r
364 # It means the rest does not comply EBNF of <Expression>\r
365 if self._Idx != self._Len:\r
366 raise BadExpression(ERR_SNYTAX % self._Expr[self._Idx:])\r
367\r
d0acc87a
LG
368 if RealValue:\r
369 RetVal = str(RealVal)\r
370 elif Val:\r
371 RetVal = True\r
372 else:\r
373 RetVal = False\r
374\r
375 if self._WarnExcept:\r
376 self._WarnExcept.result = RetVal\r
377 raise self._WarnExcept\r
378 else:\r
379 return RetVal\r
0d2711a6
LG
380\r
381 # Template function to parse binary operators which have same precedence\r
382 # Expr [Operator Expr]*\r
383 def _ExprFuncTemplate(self, EvalFunc, OpLst):\r
384 Val = EvalFunc()\r
385 while self._IsOperator(OpLst):\r
386 Op = self._Token\r
bc0d7233
YF
387 if Op == '?':\r
388 Val2 = EvalFunc()\r
389 if self._IsOperator(':'):\r
390 Val3 = EvalFunc()\r
391 if Val:\r
392 Val = Val2\r
393 else:\r
394 Val = Val3\r
395 continue\r
d0acc87a
LG
396 try:\r
397 Val = self.Eval(Op, Val, EvalFunc())\r
398 except WrnExpression, Warn:\r
399 self._WarnExcept = Warn\r
400 Val = Warn.result\r
0d2711a6 401 return Val\r
bc0d7233
YF
402 # A [? B]*\r
403 def _ConExpr(self):\r
404 return self._ExprFuncTemplate(self._OrExpr, ['?', ':'])\r
0d2711a6
LG
405\r
406 # A [|| B]*\r
407 def _OrExpr(self):\r
408 return self._ExprFuncTemplate(self._AndExpr, ["OR", "or", "||"])\r
409\r
410 # A [&& B]*\r
411 def _AndExpr(self):\r
412 return self._ExprFuncTemplate(self._BitOr, ["AND", "and", "&&"])\r
413\r
414 # A [ | B]*\r
415 def _BitOr(self):\r
416 return self._ExprFuncTemplate(self._BitXor, ["|"])\r
417\r
418 # A [ ^ B]*\r
419 def _BitXor(self):\r
420 return self._ExprFuncTemplate(self._BitAnd, ["XOR", "xor", "^"])\r
421\r
422 # A [ & B]*\r
423 def _BitAnd(self):\r
424 return self._ExprFuncTemplate(self._EqExpr, ["&"])\r
425\r
426 # A [ == B]*\r
427 def _EqExpr(self):\r
428 Val = self._RelExpr()\r
429 while self._IsOperator(["==", "!=", "EQ", "NE", "IN", "in", "!", "NOT", "not"]):\r
430 Op = self._Token\r
431 if Op in ["!", "NOT", "not"]:\r
432 if not self._IsOperator(["IN", "in"]):\r
433 raise BadExpression(ERR_REL_NOT_IN)\r
434 Op += ' ' + self._Token\r
d0acc87a
LG
435 try:\r
436 Val = self.Eval(Op, Val, self._RelExpr())\r
437 except WrnExpression, Warn:\r
438 self._WarnExcept = Warn\r
439 Val = Warn.result\r
0d2711a6
LG
440 return Val\r
441\r
442 # A [ > B]*\r
443 def _RelExpr(self):\r
5e06f1a0
YZ
444 return self._ExprFuncTemplate(self._ShiftExpr, ["<=", ">=", "<", ">", "LE", "GE", "LT", "GT"])\r
445\r
446 def _ShiftExpr(self):\r
447 return self._ExprFuncTemplate(self._AddExpr, ["<<", ">>"])\r
0d2711a6
LG
448\r
449 # A [ + B]*\r
450 def _AddExpr(self):\r
5e06f1a0
YZ
451 return self._ExprFuncTemplate(self._MulExpr, ["+", "-"])\r
452\r
453 # A [ * B]*\r
454 def _MulExpr(self):\r
455 return self._ExprFuncTemplate(self._UnaryExpr, ["*", "/", "%"])\r
0d2711a6
LG
456\r
457 # [!]*A\r
458 def _UnaryExpr(self):\r
459 if self._IsOperator(["!", "NOT", "not"]):\r
460 Val = self._UnaryExpr()\r
d0acc87a
LG
461 try:\r
462 return self.Eval('not', Val)\r
463 except WrnExpression, Warn:\r
464 self._WarnExcept = Warn\r
465 return Warn.result\r
5e06f1a0
YZ
466 if self._IsOperator(["~"]):\r
467 Val = self._UnaryExpr()\r
468 try:\r
469 return self.Eval('~', Val)\r
470 except WrnExpression, Warn:\r
471 self._WarnExcept = Warn\r
472 return Warn.result\r
0d2711a6
LG
473 return self._IdenExpr()\r
474\r
475 # Parse identifier or encapsulated expression\r
476 def _IdenExpr(self):\r
477 Tk = self._GetToken()\r
478 if Tk == '(':\r
bc0d7233 479 Val = self._ConExpr()\r
0d2711a6
LG
480 try:\r
481 # _GetToken may also raise BadExpression\r
482 if self._GetToken() != ')':\r
483 raise BadExpression(ERR_MATCH)\r
484 except BadExpression:\r
485 raise BadExpression(ERR_MATCH)\r
486 return Val\r
487 return Tk\r
488\r
489 # Skip whitespace or tab\r
490 def __SkipWS(self):\r
491 for Char in self._Expr[self._Idx:]:\r
492 if Char not in ' \t':\r
493 break\r
494 self._Idx += 1\r
495\r
496 # Try to convert string to number\r
497 def __IsNumberToken(self):\r
498 Radix = 10\r
499 if self._Token.lower()[0:2] == '0x' and len(self._Token) > 2:\r
500 Radix = 16\r
35f613d9
YF
501 if self._Token.startswith('"') or self._Token.startswith('L"'):\r
502 Flag = 0\r
503 for Index in range(len(self._Token)):\r
504 if self._Token[Index] in ['"']:\r
ea927d2f
FY
505 if self._Token[Index - 1] == '\\':\r
506 continue\r
35f613d9
YF
507 Flag += 1\r
508 if Flag == 2 and self._Token.endswith('"'):\r
35f613d9
YF
509 return True\r
510 if self._Token.startswith("'") or self._Token.startswith("L'"):\r
726c501c
YZ
511 Flag = 0\r
512 for Index in range(len(self._Token)):\r
35f613d9 513 if self._Token[Index] in ["'"]:\r
ea927d2f
FY
514 if self._Token[Index - 1] == '\\':\r
515 continue\r
726c501c 516 Flag += 1\r
35f613d9 517 if Flag == 2 and self._Token.endswith("'"):\r
726c501c 518 return True\r
0d2711a6
LG
519 try:\r
520 self._Token = int(self._Token, Radix)\r
521 return True\r
522 except ValueError:\r
523 return False\r
524 except TypeError:\r
525 return False\r
526\r
527 # Parse array: {...}\r
528 def __GetArray(self):\r
529 Token = '{'\r
530 self._Idx += 1\r
531 self.__GetNList(True)\r
532 Token += self._LiteralToken\r
533 if self._Idx >= self._Len or self._Expr[self._Idx] != '}':\r
534 raise BadExpression(ERR_ARRAY_TOKEN % Token)\r
535 Token += '}'\r
536\r
537 # All whitespace and tabs in array are already stripped.\r
538 IsArray = IsGuid = False\r
539 if len(Token.split(',')) == 11 and len(Token.split(',{')) == 2 \\r
540 and len(Token.split('},')) == 1:\r
541 HexLen = [11,6,6,5,4,4,4,4,4,4,6]\r
542 HexList= Token.split(',')\r
543 if HexList[3].startswith('{') and \\r
544 not [Index for Index, Hex in enumerate(HexList) if len(Hex) > HexLen[Index]]:\r
545 IsGuid = True\r
546 if Token.lstrip('{').rstrip('}').find('{') == -1:\r
547 if not [Hex for Hex in Token.lstrip('{').rstrip('}').split(',') if len(Hex) > 4]:\r
548 IsArray = True\r
549 if not IsArray and not IsGuid:\r
550 raise BadExpression(ERR_ARRAY_TOKEN % Token)\r
551 self._Idx += 1\r
552 self._Token = self._LiteralToken = Token\r
553 return self._Token\r
554\r
555 # Parse string, the format must be: "..."\r
556 def __GetString(self):\r
557 Idx = self._Idx\r
558\r
559 # Skip left quote\r
560 self._Idx += 1\r
561\r
562 # Replace escape \\\", \"\r
ea927d2f
FY
563 if self._Expr[Idx] == '"':\r
564 Expr = self._Expr[self._Idx:].replace('\\\\', '//').replace('\\\"', '\\\'')\r
565 for Ch in Expr:\r
566 self._Idx += 1\r
567 if Ch == '"':\r
568 break\r
569 self._Token = self._LiteralToken = self._Expr[Idx:self._Idx]\r
570 if not self._Token.endswith('"'):\r
571 raise BadExpression(ERR_STRING_TOKEN % self._Token)\r
572 #Replace escape \\\', \'\r
573 elif self._Expr[Idx] == "'":\r
574 Expr = self._Expr[self._Idx:].replace('\\\\', '//').replace("\\\'", "\\\"")\r
575 for Ch in Expr:\r
576 self._Idx += 1\r
577 if Ch == "'":\r
578 break\r
579 self._Token = self._LiteralToken = self._Expr[Idx:self._Idx]\r
580 if not self._Token.endswith("'"):\r
581 raise BadExpression(ERR_STRING_TOKEN % self._Token)\r
0d2711a6
LG
582 self._Token = self._Token[1:-1]\r
583 return self._Token\r
584\r
585 # Get token that is comprised by alphanumeric, underscore or dot(used by PCD)\r
586 # @param IsAlphaOp: Indicate if parsing general token or script operator(EQ, NE...)\r
587 def __GetIdToken(self, IsAlphaOp = False):\r
588 IdToken = ''\r
589 for Ch in self._Expr[self._Idx:]:\r
bc0d7233 590 if not self.__IsIdChar(Ch) or ('?' in self._Expr and Ch == ':'):\r
0d2711a6
LG
591 break\r
592 self._Idx += 1\r
593 IdToken += Ch\r
594\r
595 self._Token = self._LiteralToken = IdToken\r
596 if not IsAlphaOp:\r
597 self.__ResolveToken()\r
598 return self._Token\r
599\r
600 # Try to resolve token\r
601 def __ResolveToken(self):\r
602 if not self._Token:\r
603 raise BadExpression(ERR_EMPTY_TOKEN)\r
604\r
605 # PCD token\r
606 if self.PcdPattern.match(self._Token):\r
607 if self._Token not in self._Symb:\r
64b2609f
LG
608 Ex = BadExpression(ERR_PCD_RESOLVE % self._Token)\r
609 Ex.Pcd = self._Token\r
610 raise Ex\r
4afd3d04 611 self._Token = ValueExpression(self._Symb[self._Token], self._Symb)(True, self._Depth+1)\r
0d2711a6
LG
612 if type(self._Token) != type(''):\r
613 self._LiteralToken = hex(self._Token)\r
614 return\r
615\r
616 if self._Token.startswith('"'):\r
617 self._Token = self._Token[1:-1]\r
618 elif self._Token in ["FALSE", "false", "False"]:\r
619 self._Token = False\r
620 elif self._Token in ["TRUE", "true", "True"]:\r
621 self._Token = True\r
622 else:\r
623 self.__IsNumberToken()\r
624\r
625 def __GetNList(self, InArray=False):\r
626 self._GetSingleToken()\r
627 if not self.__IsHexLiteral():\r
628 if InArray:\r
629 raise BadExpression(ERR_ARRAY_ELE % self._Token)\r
630 return self._Token\r
631\r
632 self.__SkipWS()\r
633 Expr = self._Expr[self._Idx:]\r
634 if not Expr.startswith(','):\r
635 return self._Token\r
636\r
637 NList = self._LiteralToken\r
638 while Expr.startswith(','):\r
639 NList += ','\r
640 self._Idx += 1\r
641 self.__SkipWS()\r
642 self._GetSingleToken()\r
643 if not self.__IsHexLiteral():\r
644 raise BadExpression(ERR_ARRAY_ELE % self._Token)\r
645 NList += self._LiteralToken\r
646 self.__SkipWS()\r
647 Expr = self._Expr[self._Idx:]\r
648 self._Token = self._LiteralToken = NList\r
649 return self._Token\r
650\r
651 def __IsHexLiteral(self):\r
652 if self._LiteralToken.startswith('{') and \\r
653 self._LiteralToken.endswith('}'):\r
654 return True\r
655\r
656 if self.HexPattern.match(self._LiteralToken):\r
657 Token = self._LiteralToken[2:]\r
0d2711a6
LG
658 if not Token:\r
659 self._LiteralToken = '0x0'\r
660 else:\r
35f613d9 661 self._LiteralToken = '0x' + Token\r
0d2711a6
LG
662 return True\r
663 return False\r
664\r
665 def _GetToken(self):\r
666 return self.__GetNList()\r
667\r
668 @staticmethod\r
669 def __IsIdChar(Ch):\r
5e06f1a0 670 return Ch in '._:' or Ch.isalnum()\r
0d2711a6
LG
671\r
672 # Parse operand\r
673 def _GetSingleToken(self):\r
674 self.__SkipWS()\r
675 Expr = self._Expr[self._Idx:]\r
676 if Expr.startswith('L"'):\r
677 # Skip L\r
678 self._Idx += 1\r
679 UStr = self.__GetString()\r
680 self._Token = 'L"' + UStr + '"'\r
726c501c
YZ
681 return self._Token\r
682 elif Expr.startswith("L'"):\r
683 # Skip L\r
684 self._Idx += 1\r
685 UStr = self.__GetString()\r
686 self._Token = "L'" + UStr + "'"\r
0d2711a6 687 return self._Token\r
726c501c
YZ
688 elif Expr.startswith("'"):\r
689 UStr = self.__GetString()\r
690 self._Token = "'" + UStr + "'"\r
726c501c
YZ
691 return self._Token\r
692 elif Expr.startswith('UINT'):\r
693 Re = re.compile('(?:UINT8|UINT16|UINT32|UINT64)\((.+)\)')\r
694 try:\r
695 RetValue = Re.search(Expr).group(1)\r
696 except:\r
697 raise BadExpression('Invalid Expression %s' % Expr)\r
698 Idx = self._Idx\r
699 for Ch in Expr:\r
700 self._Idx += 1\r
701 if Ch == '(':\r
702 Prefix = self._Expr[Idx:self._Idx - 1]\r
703 Idx = self._Idx\r
704 if Ch == ')':\r
705 TmpValue = self._Expr[Idx :self._Idx - 1]\r
706 TmpValue = ValueExpression(TmpValue)(True)\r
707 TmpValue = '0x%x' % int(TmpValue) if type(TmpValue) != type('') else TmpValue\r
708 break\r
709 self._Token, Size = ParseFieldValue(Prefix + '(' + TmpValue + ')')\r
710 return self._Token\r
0d2711a6
LG
711\r
712 self._Token = ''\r
713 if Expr:\r
714 Ch = Expr[0]\r
715 Match = self.RegGuidPattern.match(Expr)\r
716 if Match and not Expr[Match.end():Match.end()+1].isalnum() \\r
717 and Expr[Match.end():Match.end()+1] != '_':\r
718 self._Idx += Match.end()\r
4afd3d04 719 self._Token = ValueExpression(GuidStringToGuidStructureString(Expr[0:Match.end()]))(True, self._Depth+1)\r
0d2711a6
LG
720 return self._Token\r
721 elif self.__IsIdChar(Ch):\r
722 return self.__GetIdToken()\r
723 elif Ch == '"':\r
724 return self.__GetString()\r
725 elif Ch == '{':\r
726 return self.__GetArray()\r
727 elif Ch == '(' or Ch == ')':\r
728 self._Idx += 1\r
729 self._Token = Ch\r
730 return self._Token\r
731\r
732 raise BadExpression(ERR_VALID_TOKEN % Expr)\r
733\r
734 # Parse operator\r
735 def _GetOperator(self):\r
736 self.__SkipWS()\r
bc0d7233 737 LegalOpLst = ['&&', '||', '!=', '==', '>=', '<='] + self.NonLetterOpLst + ['?',':']\r
0d2711a6
LG
738\r
739 self._Token = ''\r
740 Expr = self._Expr[self._Idx:]\r
741\r
742 # Reach end of expression\r
743 if not Expr:\r
744 return ''\r
745\r
746 # Script operator: LT, GT, LE, GE, EQ, NE, and, or, xor, not\r
747 if Expr[0].isalpha():\r
748 return self.__GetIdToken(True)\r
749\r
750 # Start to get regular operator: +, -, <, > ...\r
751 if Expr[0] not in self.NonLetterOpLst:\r
752 return ''\r
753\r
754 OpToken = ''\r
755 for Ch in Expr:\r
756 if Ch in self.NonLetterOpLst:\r
d0acc87a 757 if '!' == Ch and OpToken:\r
0d2711a6
LG
758 break\r
759 self._Idx += 1\r
760 OpToken += Ch\r
761 else:\r
762 break\r
763\r
764 if OpToken not in LegalOpLst:\r
765 raise BadExpression(ERR_OPERATOR_UNSUPPORT % OpToken)\r
766 self._Token = OpToken\r
767 return OpToken\r
768\r
769 # Check if current token matches the operators given from OpList\r
770 def _IsOperator(self, OpList):\r
771 Idx = self._Idx\r
772 self._GetOperator()\r
773 if self._Token in OpList:\r
774 if self._Token in self.LogicalOperators:\r
775 self._Token = self.LogicalOperators[self._Token]\r
776 return True\r
777 self._Idx = Idx\r
778 return False\r
779\r
726c501c
YZ
780class ValueExpressionEx(ValueExpression):\r
781 def __init__(self, PcdValue, PcdType, SymbolTable={}):\r
782 ValueExpression.__init__(self, PcdValue, SymbolTable)\r
783 self.PcdValue = PcdValue\r
784 self.PcdType = PcdType\r
785\r
786 def __call__(self, RealValue=False, Depth=0):\r
787 PcdValue = self.PcdValue\r
788 try:\r
789 PcdValue = ValueExpression.__call__(self, RealValue, Depth)\r
35f613d9 790 if self.PcdType == 'VOID*' and (PcdValue.startswith("'") or PcdValue.startswith("L'")):\r
0e6b8673
FY
791 PcdValue, Size = ParseFieldValue(PcdValue)\r
792 PcdValueList = []\r
793 for I in range(Size):\r
794 PcdValueList.append('0x%02X'%(PcdValue & 0xff))\r
795 PcdValue = PcdValue >> 8\r
796 PcdValue = '{' + ','.join(PcdValueList) + '}'\r
35f613d9
YF
797 elif self.PcdType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN'] and (PcdValue.startswith("'") or \\r
798 PcdValue.startswith('"') or PcdValue.startswith("L'") or PcdValue.startswith('L"') or PcdValue.startswith('{')):\r
799 raise BadExpression\r
726c501c
YZ
800 except WrnExpression, Value:\r
801 PcdValue = Value.result\r
9efe8d60 802 except BadExpression, Value:\r
35f613d9
YF
803 if self.PcdType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:\r
804 PcdValue = PcdValue.strip()\r
805 if type(PcdValue) == type('') and PcdValue.startswith('{') and PcdValue.endswith('}'):\r
3be421e9 806 PcdValue = SplitPcdValueString(PcdValue[1:-1])\r
35f613d9
YF
807 if type(PcdValue) == type([]):\r
808 TmpValue = 0\r
726c501c 809 Size = 0\r
3be421e9 810 ValueType = ''\r
35f613d9 811 for Item in PcdValue:\r
3be421e9 812 Item = Item.strip()\r
0e6b8673
FY
813 if Item.startswith('UINT8'):\r
814 ItemSize = 1\r
3be421e9
FY
815 ValueType = 'UINT8'\r
816 elif Item.startswith('UINT16'):\r
35f613d9 817 ItemSize = 2\r
3be421e9 818 ValueType = 'UINT16'\r
35f613d9
YF
819 elif Item.startswith('UINT32'):\r
820 ItemSize = 4\r
3be421e9 821 ValueType = 'UINT32'\r
35f613d9
YF
822 elif Item.startswith('UINT64'):\r
823 ItemSize = 8\r
3be421e9
FY
824 ValueType = 'UINT64'\r
825 elif Item.startswith('"') or Item.startswith("'") or Item.startswith('L'):\r
826 ItemSize = 0\r
827 ValueType = 'VOID*'\r
35f613d9
YF
828 else:\r
829 ItemSize = 0\r
3be421e9
FY
830 ValueType = 'UINT8'\r
831 Item = ValueExpressionEx(Item, ValueType, self._Symb)(True)\r
35f613d9
YF
832\r
833 if ItemSize == 0:\r
3be421e9
FY
834 try:\r
835 tmpValue = int(Item, 16) if Item.upper().startswith('0X') else int(Item, 0)\r
836 if tmpValue > 255:\r
837 raise BadExpression("Byte array number %s should less than 0xFF." % Item)\r
838 except BadExpression, Value:\r
839 raise BadExpression(Value)\r
840 except ValueError:\r
841 pass\r
35f613d9
YF
842 ItemValue, ItemSize = ParseFieldValue(Item)\r
843 else:\r
844 ItemValue = ParseFieldValue(Item)[0]\r
845\r
846 if type(ItemValue) == type(''):\r
847 ItemValue = int(ItemValue, 16) if ItemValue.startswith('0x') else int(ItemValue)\r
848\r
849 TmpValue = (ItemValue << (Size * 8)) | TmpValue\r
850 Size = Size + ItemSize\r
851 else:\r
0e6b8673
FY
852 try:\r
853 TmpValue, Size = ParseFieldValue(PcdValue)\r
9efe8d60
YF
854 except BadExpression, Value:\r
855 raise BadExpression("Type: %s, Value: %s, %s" % (self.PcdType, PcdValue, Value))\r
35f613d9 856 if type(TmpValue) == type(''):\r
9efe8d60
YF
857 try:\r
858 TmpValue = int(TmpValue)\r
859 except:\r
860 raise BadExpression(Value)\r
35f613d9
YF
861 else:\r
862 PcdValue = '0x%0{}X'.format(Size) % (TmpValue)\r
863 if TmpValue < 0:\r
864 raise BadExpression('Type %s PCD Value is negative' % self.PcdType)\r
865 if self.PcdType == 'UINT8' and Size > 1:\r
866 raise BadExpression('Type %s PCD Value Size is Larger than 1 byte' % self.PcdType)\r
867 if self.PcdType == 'UINT16' and Size > 2:\r
868 raise BadExpression('Type %s PCD Value Size is Larger than 2 byte' % self.PcdType)\r
869 if self.PcdType == 'UINT32' and Size > 4:\r
870 raise BadExpression('Type %s PCD Value Size is Larger than 4 byte' % self.PcdType)\r
871 if self.PcdType == 'UINT64' and Size > 8:\r
872 raise BadExpression('Type %s PCD Value Size is Larger than 8 byte' % self.PcdType)\r
6f49996c 873 else:\r
35f613d9
YF
874 try:\r
875 TmpValue = long(PcdValue)\r
876 TmpList = []\r
877 if TmpValue.bit_length() == 0:\r
878 PcdValue = '{0x00}'\r
726c501c 879 else:\r
35f613d9
YF
880 for I in range((TmpValue.bit_length() + 7) / 8):\r
881 TmpList.append('0x%02x' % ((TmpValue >> I * 8) & 0xff))\r
882 PcdValue = '{' + ', '.join(TmpList) + '}'\r
883 except:\r
884 if PcdValue.strip().startswith('{'):\r
3be421e9
FY
885 PcdValueList = SplitPcdValueString(PcdValue.strip()[1:-1])\r
886 LabelDict = {}\r
887 NewPcdValueList = []\r
888 ReLabel = re.compile('LABEL\((\w+)\)')\r
889 ReOffset = re.compile('OFFSET_OF\((\w+)\)')\r
890 LabelOffset = 0\r
891 for Index, Item in enumerate(PcdValueList):\r
892 # compute byte offset of every LABEL\r
893 Item = Item.strip()\r
5ac0a545
FY
894 LabelList = ReLabel.findall(Item)\r
895 if LabelList:\r
3be421e9 896 for Label in LabelList:\r
5ac0a545
FY
897 if not IsValidCString(Label):\r
898 raise BadExpression('%s is not a valid c variable name' % Label)\r
3be421e9
FY
899 if Label not in LabelDict.keys():\r
900 LabelDict[Label] = str(LabelOffset)\r
3be421e9
FY
901 if Item.startswith('UINT8'):\r
902 LabelOffset = LabelOffset + 1\r
903 elif Item.startswith('UINT16'):\r
904 LabelOffset = LabelOffset + 2\r
905 elif Item.startswith('UINT32'):\r
906 LabelOffset = LabelOffset + 4\r
907 elif Item.startswith('UINT64'):\r
908 LabelOffset = LabelOffset + 8\r
909 else:\r
8bd72d7c 910 try:\r
8bd72d7c
KM
911 ItemValue, ItemSize = ParseFieldValue(Item)\r
912 LabelOffset = LabelOffset + ItemSize\r
35f613d9 913 except:\r
3be421e9
FY
914 LabelOffset = LabelOffset + 1\r
915\r
916 for Index, Item in enumerate(PcdValueList):\r
917 # for LABEL parse\r
918 Item = Item.strip()\r
919 try:\r
920 Item = ReLabel.sub('', Item)\r
921 except:\r
922 pass\r
923 try:\r
924 OffsetList = ReOffset.findall(Item)\r
925 except:\r
926 pass\r
927 for Offset in OffsetList:\r
928 if Offset in LabelDict.keys():\r
929 Re = re.compile('OFFSET_OF\(%s\)' % Offset)\r
930 Item = Re.sub(LabelDict[Offset], Item)\r
931 else:\r
932 raise BadExpression('%s not defined' % Offset)\r
933 NewPcdValueList.append(Item)\r
934\r
935 AllPcdValueList = []\r
936 for Item in NewPcdValueList:\r
937 Size = 0\r
938 ValueStr = ''\r
939 TokenSpaceGuidName = ''\r
940 if Item.startswith('GUID') and Item.endswith(')'):\r
35f613d9 941 try:\r
3be421e9 942 TokenSpaceGuidName = re.search('GUID\((\w+)\)', Item).group(1)\r
35f613d9
YF
943 except:\r
944 pass\r
3be421e9
FY
945 if TokenSpaceGuidName and TokenSpaceGuidName in self._Symb:\r
946 Item = 'GUID(' + self._Symb[TokenSpaceGuidName] + ')'\r
947 elif TokenSpaceGuidName:\r
948 raise BadExpression('%s not found in DEC file' % TokenSpaceGuidName)\r
949 Item, Size = ParseFieldValue(Item)\r
950 for Index in range(0, Size):\r
951 ValueStr = '0x%02X' % (int(Item) & 255)\r
952 Item >>= 8\r
953 AllPcdValueList.append(ValueStr)\r
954 continue\r
955 elif Item.startswith('DEVICE_PATH') and Item.endswith(')'):\r
956 Item, Size = ParseFieldValue(Item)\r
957 AllPcdValueList.append(Item[1:-1])\r
958 continue\r
959 else:\r
35f613d9 960 ValueType = ""\r
0e6b8673 961 if Item.startswith('UINT8'):\r
35f613d9
YF
962 ItemSize = 1\r
963 ValueType = "UINT8"\r
964 elif Item.startswith('UINT16'):\r
965 ItemSize = 2\r
966 ValueType = "UINT16"\r
967 elif Item.startswith('UINT32'):\r
968 ItemSize = 4\r
a35918ca 969 ValueType = "UINT32"\r
35f613d9
YF
970 elif Item.startswith('UINT64'):\r
971 ItemSize = 8\r
a35918ca 972 ValueType = "UINT64"\r
35f613d9
YF
973 else:\r
974 ItemSize = 0\r
975 if ValueType:\r
976 TmpValue = ValueExpressionEx(Item, ValueType, self._Symb)(True)\r
977 else:\r
978 TmpValue = ValueExpressionEx(Item, self.PcdType, self._Symb)(True)\r
979 Item = '0x%x' % TmpValue if type(TmpValue) != type('') else TmpValue\r
980 if ItemSize == 0:\r
981 ItemValue, ItemSize = ParseFieldValue(Item)\r
3be421e9
FY
982 if not (Item.startswith('"') or Item.startswith('L') or Item.startswith('{')) and ItemSize > 1:\r
983 raise BadExpression("Byte array number %s should less than 0xFF." % Item)\r
35f613d9
YF
984 else:\r
985 ItemValue = ParseFieldValue(Item)[0]\r
986 for I in range(0, ItemSize):\r
3be421e9 987 ValueStr = '0x%02X' % (int(ItemValue) & 255)\r
35f613d9 988 ItemValue >>= 8\r
3be421e9 989 AllPcdValueList.append(ValueStr)\r
35f613d9
YF
990 Size += ItemSize\r
991\r
3be421e9
FY
992 if Size > 0:\r
993 PcdValue = '{' + ','.join(AllPcdValueList) + '}'\r
0e6b8673 994 else:\r
9efe8d60 995 raise BadExpression("Type: %s, Value: %s, %s"%(self.PcdType, PcdValue, Value))\r
0e6b8673 996\r
35f613d9
YF
997 if PcdValue == 'True':\r
998 PcdValue = '1'\r
999 if PcdValue == 'False':\r
1000 PcdValue = '0'\r
726c501c 1001\r
726c501c
YZ
1002 if RealValue:\r
1003 return PcdValue\r
1004\r
0d2711a6
LG
1005if __name__ == '__main__':\r
1006 pass\r
d0acc87a
LG
1007 while True:\r
1008 input = raw_input('Input expr: ')\r
1009 if input in 'qQ':\r
1010 break\r
1011 try:\r
1012 print ValueExpression(input)(True)\r
1013 print ValueExpression(input)(False)\r
1014 except WrnExpression, Ex:\r
1015 print Ex.result\r
1016 print str(Ex)\r
1017 except Exception, Ex:\r
1018 print str(Ex)\r