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