BaseTools/Source/Python/Common/Expression.py

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