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 __future__ import print_function
  16 from Common.GlobalData import *
  17 from CommonDataClass.Exceptions import BadExpression
  18 from CommonDataClass.Exceptions import WrnExpression
  19 from Misc import GuidStringToGuidStructureString, ParseFieldValue, IsFieldValueAnArray
  20 import Common.EdkLogger as EdkLogger
  21 import copy
  22 from Common.DataType import *
  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         = 'PCD token cannot be resolved: [%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     if IsFieldValueAnArray(InputValue):
 140         try:
 141             PcdValue = ValueExpressionEx(InputValue, TAB_VOID, GuidDict)(True)
 142         except:
 143             pass
 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(BaseExpression, self).__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             (type(Oprand1) == type('') or type(Oprand2) == type('')):
 249             raise BadExpression(ERR_STRING_EXPR % Operator)
 250         if Operator in {'in', 'not in'}:
 251             if type(Oprand1) != type(''):
 252                 Oprand1 = IntToStr(Oprand1)
 253             if type(Oprand2) != type(''):
 254                 Oprand2 = IntToStr(Oprand2)
 255         TypeDict = {
 256             type(0)  : 0,
 257             type(0L) : 0,
 258             type('') : 1,
 259             type(True) : 2
 260         }
 261
 262         EvalStr = ''
 263         if Operator in {"!", "NOT", "not"}:
 264             if type(Oprand1) == type(''):
 265                 raise BadExpression(ERR_STRING_EXPR % Operator)
 266             EvalStr = 'not Oprand1'
 267         elif Operator in {"~"}:
 268             if type(Oprand1) == type(''):
 269                 raise BadExpression(ERR_STRING_EXPR % Operator)
 270             EvalStr = '~ Oprand1'
 271         else:
 272             if Operator in {"+", "-"} and (type(True) in {type(Oprand1), type(Oprand2)}):
 273                 # Boolean in '+'/'-' will be evaluated but raise warning
 274                 WrnExp = WrnExpression(WRN_BOOL_EXPR)
 275             elif type('') in {type(Oprand1), type(Oprand2)} and type(Oprand1)!= type(Oprand2):
 276                 # == between string and number/boolean will always return False, != return True
 277                 if Operator == "==":
 278                     WrnExp = WrnExpression(WRN_EQCMP_STR_OTHERS)
 279                     WrnExp.result = False
 280                     raise WrnExp
 281                 elif Operator == "!=":
 282                     WrnExp = WrnExpression(WRN_NECMP_STR_OTHERS)
 283                     WrnExp.result = True
 284                     raise WrnExp
 285                 else:
 286                     raise BadExpression(ERR_RELCMP_STR_OTHERS % Operator)
 287             elif TypeDict[type(Oprand1)] != TypeDict[type(Oprand2)]:
 288                 if Operator in {"==", "!=", ">=", "<=", ">", "<"} and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):
 289                     # comparison between number and boolean is allowed
 290                     pass
 291                 elif Operator in {'&', '|', '^', "and", "or"} and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):
 292                     # bitwise and logical operation between number and boolean is allowed
 293                     pass
 294                 else:
 295                     raise BadExpression(ERR_EXPR_TYPE)
 296             if type(Oprand1) == type('') and type(Oprand2) == type(''):
 297                 if (Oprand1.startswith('L"') and not Oprand2.startswith('L"')) or \
 298                     (not Oprand1.startswith('L"') and Oprand2.startswith('L"')):
 299                     raise BadExpression(ERR_STRING_CMP % (Oprand1, Operator, Oprand2))
 300             if 'in' in Operator and type(Oprand2) == type(''):
 301                 Oprand2 = Oprand2.split()
 302             EvalStr = 'Oprand1 ' + Operator + ' Oprand2'
 303
 304         # Local symbols used by built in eval function
 305         Dict = {
 306             'Oprand1' : Oprand1,
 307             'Oprand2' : Oprand2
 308         }
 309         try:
 310             Val = eval(EvalStr, {}, Dict)
 311         except Exception as Excpt:
 312             raise BadExpression(str(Excpt))
 313
 314         if Operator in {'and', 'or'}:
 315             if Val:
 316                 Val = True
 317             else:
 318                 Val = False
 319
 320         if WrnExp:
 321             WrnExp.result = Val
 322             raise WrnExp
 323         return Val
 324
 325     def __init__(self, Expression, SymbolTable={}):
 326         super(ValueExpression, self).__init__(self, Expression, SymbolTable)
 327         self._NoProcess = False
 328         if type(Expression) != type(''):
 329             self._Expr = Expression
 330             self._NoProcess = True
 331             return
 332
 333         self._Expr = ReplaceExprMacro(Expression.strip(),
 334                                   SymbolTable,
 335                                   SupportedInMacroList)
 336
 337         if not self._Expr.strip():
 338             raise BadExpression(ERR_EMPTY_EXPR)
 339
 340         #
 341         # The symbol table including PCD and macro mapping
 342         #
 343         self._Symb = copy.deepcopy(SymbolTable)
 344         self._Symb.update(self.LogicalOperators)
 345         self._Idx = 0
 346         self._Len = len(self._Expr)
 347         self._Token = ''
 348         self._WarnExcept = None
 349
 350         # Literal token without any conversion
 351         self._LiteralToken = ''
 352
 353     # Public entry for this class
 354     #   @param RealValue: False: only evaluate if the expression is true or false, used for conditional expression
 355     #                     True : return the evaluated str(value), used for PCD value
 356     #
 357     #   @return: True or False if RealValue is False
 358     #            Evaluated value of string format if RealValue is True
 359     #
 360     def __call__(self, RealValue=False, Depth=0):
 361         if self._NoProcess:
 362             return self._Expr
 363
 364         self._Depth = Depth
 365
 366         self._Expr = self._Expr.strip()
 367         if RealValue and Depth == 0:
 368             self._Token = self._Expr
 369             if self.__IsNumberToken():
 370                 return self._Expr
 371             Token = ''
 372             try:
 373                 Token = self._GetToken()
 374             except BadExpression:
 375                 pass
 376             if type(Token) == type('') and Token.startswith('{') and Token.endswith('}') and self._Idx >= self._Len:
 377                 return self._Expr
 378
 379             self._Idx = 0
 380             self._Token = ''
 381
 382         Val = self._ConExpr()
 383         RealVal = Val
 384         if type(Val) == type(''):
 385             if Val == 'L""':
 386                 Val = False
 387             elif not Val:
 388                 Val = False
 389                 RealVal = '""'
 390             elif not Val.startswith('L"') and not Val.startswith('{') and not Val.startswith("L'"):
 391                 Val = True
 392                 RealVal = '"' + RealVal + '"'
 393
 394         # The expression has been parsed, but the end of expression is not reached
 395         # It means the rest does not comply EBNF of <Expression>
 396         if self._Idx != self._Len:
 397             raise BadExpression(ERR_SNYTAX % self._Expr[self._Idx:])
 398
 399         if RealValue:
 400             RetVal = str(RealVal)
 401         elif Val:
 402             RetVal = True
 403         else:
 404             RetVal = False
 405
 406         if self._WarnExcept:
 407             self._WarnExcept.result = RetVal
 408             raise self._WarnExcept
 409         else:
 410             return RetVal
 411
 412     # Template function to parse binary operators which have same precedence
 413     # Expr [Operator Expr]*
 414     def _ExprFuncTemplate(self, EvalFunc, OpSet):
 415         Val = EvalFunc()
 416         while self._IsOperator(OpSet):
 417             Op = self._Token
 418             if Op == '?':
 419                 Val2 = EvalFunc()
 420                 if self._IsOperator({':'}):
 421                     Val3 = EvalFunc()
 422                 if Val:
 423                     Val = Val2
 424                 else:
 425                     Val = Val3
 426                 continue
 427             try:
 428                 Val = self.Eval(Op, Val, EvalFunc())
 429             except WrnExpression as Warn:
 430                 self._WarnExcept = Warn
 431                 Val = Warn.result
 432         return Val
 433     # A [? B]*
 434     def _ConExpr(self):
 435         return self._ExprFuncTemplate(self._OrExpr, {'?', ':'})
 436
 437     # A [|| B]*
 438     def _OrExpr(self):
 439         return self._ExprFuncTemplate(self._AndExpr, {"OR", "or", "||"})
 440
 441     # A [&& B]*
 442     def _AndExpr(self):
 443         return self._ExprFuncTemplate(self._BitOr, {"AND", "and", "&&"})
 444
 445     # A [ | B]*
 446     def _BitOr(self):
 447         return self._ExprFuncTemplate(self._BitXor, {"|"})
 448
 449     # A [ ^ B]*
 450     def _BitXor(self):
 451         return self._ExprFuncTemplate(self._BitAnd, {"XOR", "xor", "^"})
 452
 453     # A [ & B]*
 454     def _BitAnd(self):
 455         return self._ExprFuncTemplate(self._EqExpr, {"&"})
 456
 457     # A [ == B]*
 458     def _EqExpr(self):
 459         Val = self._RelExpr()
 460         while self._IsOperator({"==", "!=", "EQ", "NE", "IN", "in", "!", "NOT", "not"}):
 461             Op = self._Token
 462             if Op in {"!", "NOT", "not"}:
 463                 if not self._IsOperator({"IN", "in"}):
 464                     raise BadExpression(ERR_REL_NOT_IN)
 465                 Op += ' ' + self._Token
 466             try:
 467                 Val = self.Eval(Op, Val, self._RelExpr())
 468             except WrnExpression as Warn:
 469                 self._WarnExcept = Warn
 470                 Val = Warn.result
 471         return Val
 472
 473     # A [ > B]*
 474     def _RelExpr(self):
 475         return self._ExprFuncTemplate(self._ShiftExpr, {"<=", ">=", "<", ">", "LE", "GE", "LT", "GT"})
 476
 477     def _ShiftExpr(self):
 478         return self._ExprFuncTemplate(self._AddExpr, {"<<", ">>"})
 479
 480     # A [ + B]*
 481     def _AddExpr(self):
 482         return self._ExprFuncTemplate(self._MulExpr, {"+", "-"})
 483
 484     # A [ * B]*
 485     def _MulExpr(self):
 486         return self._ExprFuncTemplate(self._UnaryExpr, {"*", "/", "%"})
 487
 488     # [!]*A
 489     def _UnaryExpr(self):
 490         if self._IsOperator({"!", "NOT", "not"}):
 491             Val = self._UnaryExpr()
 492             try:
 493                 return self.Eval('not', Val)
 494             except WrnExpression as Warn:
 495                 self._WarnExcept = Warn
 496                 return Warn.result
 497         if self._IsOperator({"~"}):
 498             Val = self._UnaryExpr()
 499             try:
 500                 return self.Eval('~', Val)
 501             except WrnExpression as Warn:
 502                 self._WarnExcept = Warn
 503                 return Warn.result
 504         return self._IdenExpr()
 505
 506     # Parse identifier or encapsulated expression
 507     def _IdenExpr(self):
 508         Tk = self._GetToken()
 509         if Tk == '(':
 510             Val = self._ConExpr()
 511             try:
 512                 # _GetToken may also raise BadExpression
 513                 if self._GetToken() != ')':
 514                     raise BadExpression(ERR_MATCH)
 515             except BadExpression:
 516                 raise BadExpression(ERR_MATCH)
 517             return Val
 518         return Tk
 519
 520     # Skip whitespace or tab
 521     def __SkipWS(self):
 522         for Char in self._Expr[self._Idx:]:
 523             if Char not in ' \t':
 524                 break
 525             self._Idx += 1
 526
 527     # Try to convert string to number
 528     def __IsNumberToken(self):
 529         Radix = 10
 530         if self._Token.lower()[0:2] == '0x' and len(self._Token) > 2:
 531             Radix = 16
 532         if self._Token.startswith('"') or self._Token.startswith('L"'):
 533             Flag = 0
 534             for Index in range(len(self._Token)):
 535                 if self._Token[Index] in {'"'}:
 536                     if self._Token[Index - 1] == '\\':
 537                         continue
 538                     Flag += 1
 539             if Flag == 2 and self._Token.endswith('"'):
 540                 return True
 541         if self._Token.startswith("'") or self._Token.startswith("L'"):
 542             Flag = 0
 543             for Index in range(len(self._Token)):
 544                 if self._Token[Index] in {"'"}:
 545                     if self._Token[Index - 1] == '\\':
 546                         continue
 547                     Flag += 1
 548             if Flag == 2 and self._Token.endswith("'"):
 549                 return True
 550         try:
 551             self._Token = int(self._Token, Radix)
 552             return True
 553         except ValueError:
 554             return False
 555         except TypeError:
 556             return False
 557
 558     # Parse array: {...}
 559     def __GetArray(self):
 560         Token = '{'
 561         self._Idx += 1
 562         self.__GetNList(True)
 563         Token += self._LiteralToken
 564         if self._Idx >= self._Len or self._Expr[self._Idx] != '}':
 565             raise BadExpression(ERR_ARRAY_TOKEN % Token)
 566         Token += '}'
 567
 568         # All whitespace and tabs in array are already stripped.
 569         IsArray = IsGuid = False
 570         if len(Token.split(',')) == 11 and len(Token.split(',{')) == 2 \
 571             and len(Token.split('},')) == 1:
 572             HexLen = [11,6,6,5,4,4,4,4,4,4,6]
 573             HexList= Token.split(',')
 574             if HexList[3].startswith('{') and \
 575                 not [Index for Index, Hex in enumerate(HexList) if len(Hex) > HexLen[Index]]:
 576                 IsGuid = True
 577         if Token.lstrip('{').rstrip('}').find('{') == -1:
 578             if not [Hex for Hex in Token.lstrip('{').rstrip('}').split(',') if len(Hex) > 4]:
 579                 IsArray = True
 580         if not IsArray and not IsGuid:
 581             raise BadExpression(ERR_ARRAY_TOKEN % Token)
 582         self._Idx += 1
 583         self._Token = self._LiteralToken = Token
 584         return self._Token
 585
 586     # Parse string, the format must be: "..."
 587     def __GetString(self):
 588         Idx = self._Idx
 589
 590         # Skip left quote
 591         self._Idx += 1
 592
 593         # Replace escape \\\", \"
 594         if self._Expr[Idx] == '"':
 595             Expr = self._Expr[self._Idx:].replace('\\\\', '//').replace('\\\"', '\\\'')
 596             for Ch in Expr:
 597                 self._Idx += 1
 598                 if Ch == '"':
 599                     break
 600             self._Token = self._LiteralToken = self._Expr[Idx:self._Idx]
 601             if not self._Token.endswith('"'):
 602                 raise BadExpression(ERR_STRING_TOKEN % self._Token)
 603         #Replace escape \\\', \'
 604         elif self._Expr[Idx] == "'":
 605             Expr = self._Expr[self._Idx:].replace('\\\\', '//').replace("\\\'", "\\\"")
 606             for Ch in Expr:
 607                 self._Idx += 1
 608                 if Ch == "'":
 609                     break
 610             self._Token = self._LiteralToken = self._Expr[Idx:self._Idx]
 611             if not self._Token.endswith("'"):
 612                 raise BadExpression(ERR_STRING_TOKEN % self._Token)
 613         self._Token = self._Token[1:-1]
 614         return self._Token
 615
 616     # Get token that is comprised by alphanumeric, underscore or dot(used by PCD)
 617     # @param IsAlphaOp: Indicate if parsing general token or script operator(EQ, NE...)
 618     def __GetIdToken(self, IsAlphaOp = False):
 619         IdToken = ''
 620         for Ch in self._Expr[self._Idx:]:
 621             if not self.__IsIdChar(Ch) or ('?' in self._Expr and Ch == ':'):
 622                 break
 623             self._Idx += 1
 624             IdToken += Ch
 625
 626         self._Token = self._LiteralToken = IdToken
 627         if not IsAlphaOp:
 628             self.__ResolveToken()
 629         return self._Token
 630
 631     # Try to resolve token
 632     def __ResolveToken(self):
 633         if not self._Token:
 634             raise BadExpression(ERR_EMPTY_TOKEN)
 635
 636         # PCD token
 637         if PcdPattern.match(self._Token):
 638             if self._Token not in self._Symb:
 639                 Ex = BadExpression(ERR_PCD_RESOLVE % self._Token)
 640                 Ex.Pcd = self._Token
 641                 raise Ex
 642             self._Token = ValueExpression(self._Symb[self._Token], self._Symb)(True, self._Depth+1)
 643             if type(self._Token) != type(''):
 644                 self._LiteralToken = hex(self._Token)
 645                 return
 646
 647         if self._Token.startswith('"'):
 648             self._Token = self._Token[1:-1]
 649         elif self._Token in {"FALSE", "false", "False"}:
 650             self._Token = False
 651         elif self._Token in {"TRUE", "true", "True"}:
 652             self._Token = True
 653         else:
 654             self.__IsNumberToken()
 655
 656     def __GetNList(self, InArray=False):
 657         self._GetSingleToken()
 658         if not self.__IsHexLiteral():
 659             if InArray:
 660                 raise BadExpression(ERR_ARRAY_ELE % self._Token)
 661             return self._Token
 662
 663         self.__SkipWS()
 664         Expr = self._Expr[self._Idx:]
 665         if not Expr.startswith(','):
 666             return self._Token
 667
 668         NList = self._LiteralToken
 669         while Expr.startswith(','):
 670             NList += ','
 671             self._Idx += 1
 672             self.__SkipWS()
 673             self._GetSingleToken()
 674             if not self.__IsHexLiteral():
 675                 raise BadExpression(ERR_ARRAY_ELE % self._Token)
 676             NList += self._LiteralToken
 677             self.__SkipWS()
 678             Expr = self._Expr[self._Idx:]
 679         self._Token = self._LiteralToken = NList
 680         return self._Token
 681
 682     def __IsHexLiteral(self):
 683         if self._LiteralToken.startswith('{') and \
 684             self._LiteralToken.endswith('}'):
 685             return True
 686
 687         if gHexPattern.match(self._LiteralToken):
 688             Token = self._LiteralToken[2:]
 689             if not Token:
 690                 self._LiteralToken = '0x0'
 691             else:
 692                 self._LiteralToken = '0x' + Token
 693             return True
 694         return False
 695
 696     def _GetToken(self):
 697         return self.__GetNList()
 698
 699     @staticmethod
 700     def __IsIdChar(Ch):
 701         return Ch in '._:' or Ch.isalnum()
 702
 703     # Parse operand
 704     def _GetSingleToken(self):
 705         self.__SkipWS()
 706         Expr = self._Expr[self._Idx:]
 707         if Expr.startswith('L"'):
 708             # Skip L
 709             self._Idx += 1
 710             UStr = self.__GetString()
 711             self._Token = 'L"' + UStr + '"'
 712             return self._Token
 713         elif Expr.startswith("L'"):
 714             # Skip L
 715             self._Idx += 1
 716             UStr = self.__GetString()
 717             self._Token = "L'" + UStr + "'"
 718             return self._Token
 719         elif Expr.startswith("'"):
 720             UStr = self.__GetString()
 721             self._Token = "'" + UStr + "'"
 722             return self._Token
 723         elif Expr.startswith('UINT'):
 724             Re = re.compile('(?:UINT8|UINT16|UINT32|UINT64)\((.+)\)')
 725             try:
 726                 RetValue = Re.search(Expr).group(1)
 727             except:
 728                  raise BadExpression('Invalid Expression %s' % Expr)
 729             Idx = self._Idx
 730             for Ch in Expr:
 731                 self._Idx += 1
 732                 if Ch == '(':
 733                     Prefix = self._Expr[Idx:self._Idx - 1]
 734                     Idx = self._Idx
 735                 if Ch == ')':
 736                     TmpValue = self._Expr[Idx :self._Idx - 1]
 737                     TmpValue = ValueExpression(TmpValue)(True)
 738                     TmpValue = '0x%x' % int(TmpValue) if type(TmpValue) != type('') else TmpValue
 739                     break
 740             self._Token, Size = ParseFieldValue(Prefix + '(' + TmpValue + ')')
 741             return  self._Token
 742
 743         self._Token = ''
 744         if Expr:
 745             Ch = Expr[0]
 746             Match = gGuidPattern.match(Expr)
 747             if Match and not Expr[Match.end():Match.end()+1].isalnum() \
 748                 and Expr[Match.end():Match.end()+1] != '_':
 749                 self._Idx += Match.end()
 750                 self._Token = ValueExpression(GuidStringToGuidStructureString(Expr[0:Match.end()]))(True, self._Depth+1)
 751                 return self._Token
 752             elif self.__IsIdChar(Ch):
 753                 return self.__GetIdToken()
 754             elif Ch == '"':
 755                 return self.__GetString()
 756             elif Ch == '{':
 757                 return self.__GetArray()
 758             elif Ch == '(' or Ch == ')':
 759                 self._Idx += 1
 760                 self._Token = Ch
 761                 return self._Token
 762
 763         raise BadExpression(ERR_VALID_TOKEN % Expr)
 764
 765     # Parse operator
 766     def _GetOperator(self):
 767         self.__SkipWS()
 768         LegalOpLst = ['&&', '||', '!=', '==', '>=', '<='] + self.NonLetterOpLst + ['?',':']
 769
 770         self._Token = ''
 771         Expr = self._Expr[self._Idx:]
 772
 773         # Reach end of expression
 774         if not Expr:
 775             return ''
 776
 777         # Script operator: LT, GT, LE, GE, EQ, NE, and, or, xor, not
 778         if Expr[0].isalpha():
 779             return self.__GetIdToken(True)
 780
 781         # Start to get regular operator: +, -, <, > ...
 782         if Expr[0] not in self.NonLetterOpLst:
 783             return ''
 784
 785         OpToken = ''
 786         for Ch in Expr:
 787             if Ch in self.NonLetterOpLst:
 788                 if '!' == Ch and OpToken:
 789                     break
 790                 self._Idx += 1
 791                 OpToken += Ch
 792             else:
 793                 break
 794
 795         if OpToken not in LegalOpLst:
 796             raise BadExpression(ERR_OPERATOR_UNSUPPORT % OpToken)
 797         self._Token = OpToken
 798         return OpToken
 799
 800 class ValueExpressionEx(ValueExpression):
 801     def __init__(self, PcdValue, PcdType, SymbolTable={}):
 802         ValueExpression.__init__(self, PcdValue, SymbolTable)
 803         self.PcdValue = PcdValue
 804         self.PcdType = PcdType
 805
 806     def __call__(self, RealValue=False, Depth=0):
 807         PcdValue = self.PcdValue
 808         try:
 809             PcdValue = ValueExpression.__call__(self, RealValue, Depth)
 810             if self.PcdType == TAB_VOID and (PcdValue.startswith("'") or PcdValue.startswith("L'")):
 811                 PcdValue, Size = ParseFieldValue(PcdValue)
 812                 PcdValueList = []
 813                 for I in range(Size):
 814                     PcdValueList.append('0x%02X'%(PcdValue & 0xff))
 815                     PcdValue = PcdValue >> 8
 816                 PcdValue = '{' + ','.join(PcdValueList) + '}'
 817             elif self.PcdType in TAB_PCD_NUMERIC_TYPES and (PcdValue.startswith("'") or \
 818                       PcdValue.startswith('"') or PcdValue.startswith("L'") or PcdValue.startswith('L"') or PcdValue.startswith('{')):
 819                 raise BadExpression
 820         except WrnExpression as Value:
 821             PcdValue = Value.result
 822         except BadExpression as Value:
 823             if self.PcdType in TAB_PCD_NUMERIC_TYPES:
 824                 PcdValue = PcdValue.strip()
 825                 if PcdValue.startswith('{') and PcdValue.endswith('}'):
 826                     PcdValue = SplitPcdValueString(PcdValue[1:-1])
 827                 if type(PcdValue) == type([]):
 828                     TmpValue = 0
 829                     Size = 0
 830                     ValueType = ''
 831                     for Item in PcdValue:
 832                         Item = Item.strip()
 833                         if Item.startswith(TAB_UINT8):
 834                             ItemSize = 1
 835                             ValueType = TAB_UINT8
 836                         elif Item.startswith(TAB_UINT16):
 837                             ItemSize = 2
 838                             ValueType = TAB_UINT16
 839                         elif Item.startswith(TAB_UINT32):
 840                             ItemSize = 4
 841                             ValueType = TAB_UINT32
 842                         elif Item.startswith(TAB_UINT64):
 843                             ItemSize = 8
 844                             ValueType = TAB_UINT64
 845                         elif Item[0] in {'"',"'",'L'}:
 846                             ItemSize = 0
 847                             ValueType = TAB_VOID
 848                         else:
 849                             ItemSize = 0
 850                             ValueType = TAB_UINT8
 851                         Item = ValueExpressionEx(Item, ValueType, self._Symb)(True)
 852
 853                         if ItemSize == 0:
 854                             try:
 855                                 tmpValue = int(Item, 0)
 856                                 if tmpValue > 255:
 857                                     raise BadExpression("Byte  array number %s should less than 0xFF." % Item)
 858                             except BadExpression as Value:
 859                                 raise BadExpression(Value)
 860                             except ValueError:
 861                                 pass
 862                             ItemValue, ItemSize = ParseFieldValue(Item)
 863                         else:
 864                             ItemValue = ParseFieldValue(Item)[0]
 865
 866                         if type(ItemValue) == type(''):
 867                             ItemValue = int(ItemValue, 0)
 868
 869                         TmpValue = (ItemValue << (Size * 8)) | TmpValue
 870                         Size = Size + ItemSize
 871                 else:
 872                     try:
 873                         TmpValue, Size = ParseFieldValue(PcdValue)
 874                     except BadExpression as Value:
 875                         raise BadExpression("Type: %s, Value: %s, %s" % (self.PcdType, PcdValue, Value))
 876                 if type(TmpValue) == type(''):
 877                     try:
 878                         TmpValue = int(TmpValue)
 879                     except:
 880                         raise  BadExpression(Value)
 881                 else:
 882                     PcdValue = '0x%0{}X'.format(Size) % (TmpValue)
 883                 if TmpValue < 0:
 884                     raise  BadExpression('Type %s PCD Value is negative' % self.PcdType)
 885                 if self.PcdType == TAB_UINT8 and Size > 1:
 886                     raise BadExpression('Type %s PCD Value Size is Larger than 1 byte' % self.PcdType)
 887                 if self.PcdType == TAB_UINT16 and Size > 2:
 888                     raise BadExpression('Type %s PCD Value Size is Larger than 2 byte' % self.PcdType)
 889                 if self.PcdType == TAB_UINT32 and Size > 4:
 890                     raise BadExpression('Type %s PCD Value Size is Larger than 4 byte' % self.PcdType)
 891                 if self.PcdType == TAB_UINT64 and Size > 8:
 892                     raise BadExpression('Type %s PCD Value Size is Larger than 8 byte' % self.PcdType)
 893             else:
 894                 try:
 895                     TmpValue = long(PcdValue)
 896                     TmpList = []
 897                     if TmpValue.bit_length() == 0:
 898                         PcdValue = '{0x00}'
 899                     else:
 900                         for I in range((TmpValue.bit_length() + 7) / 8):
 901                             TmpList.append('0x%02x' % ((TmpValue >> I * 8) & 0xff))
 902                         PcdValue = '{' + ', '.join(TmpList) + '}'
 903                 except:
 904                     if PcdValue.strip().startswith('{'):
 905                         PcdValueList = SplitPcdValueString(PcdValue.strip()[1:-1])
 906                         LabelDict = {}
 907                         NewPcdValueList = []
 908                         LabelOffset = 0
 909                         for Item in PcdValueList:
 910                             # compute byte offset of every LABEL
 911                             LabelList = _ReLabel.findall(Item)
 912                             Item = _ReLabel.sub('', Item)
 913                             Item = Item.strip()
 914                             if LabelList:
 915                                 for Label in LabelList:
 916                                     if not IsValidCName(Label):
 917                                         raise BadExpression('%s is not a valid c variable name' % Label)
 918                                     if Label not in LabelDict:
 919                                         LabelDict[Label] = str(LabelOffset)
 920                             if Item.startswith(TAB_UINT8):
 921                                 LabelOffset = LabelOffset + 1
 922                             elif Item.startswith(TAB_UINT16):
 923                                 LabelOffset = LabelOffset + 2
 924                             elif Item.startswith(TAB_UINT32):
 925                                 LabelOffset = LabelOffset + 4
 926                             elif Item.startswith(TAB_UINT64):
 927                                 LabelOffset = LabelOffset + 8
 928                             else:
 929                                 try:
 930                                     ItemValue, ItemSize = ParseFieldValue(Item)
 931                                     LabelOffset = LabelOffset + ItemSize
 932                                 except:
 933                                     LabelOffset = LabelOffset + 1
 934
 935                         for Item in PcdValueList:
 936                             # for LABEL parse
 937                             Item = Item.strip()
 938                             try:
 939                                 Item = _ReLabel.sub('', Item)
 940                             except:
 941                                 pass
 942                             try:
 943                                 OffsetList = _ReOffset.findall(Item)
 944                             except:
 945                                 pass
 946                             # replace each offset, except errors
 947                             for Offset in OffsetList:
 948                                 try:
 949                                     Item = Item.replace('OFFSET_OF({})'.format(Offset),LabelDict[Offset])
 950                                 except:
 951                                     raise BadExpression('%s not defined' % Offset)
 952
 953                             NewPcdValueList.append(Item)
 954
 955                         AllPcdValueList = []
 956                         for Item in NewPcdValueList:
 957                             Size = 0
 958                             ValueStr = ''
 959                             TokenSpaceGuidName = ''
 960                             if Item.startswith(TAB_GUID) and Item.endswith(')'):
 961                                 try:
 962                                     TokenSpaceGuidName = re.search('GUID\((\w+)\)', Item).group(1)
 963                                 except:
 964                                     pass
 965                                 if TokenSpaceGuidName and TokenSpaceGuidName in self._Symb:
 966                                     Item = 'GUID(' + self._Symb[TokenSpaceGuidName] + ')'
 967                                 elif TokenSpaceGuidName:
 968                                     raise BadExpression('%s not found in DEC file' % TokenSpaceGuidName)
 969                                 Item, Size = ParseFieldValue(Item)
 970                                 for Index in range(0, Size):
 971                                     ValueStr = '0x%02X' % (int(Item) & 255)
 972                                     Item >>= 8
 973                                     AllPcdValueList.append(ValueStr)
 974                                 continue
 975                             elif Item.startswith('DEVICE_PATH') and Item.endswith(')'):
 976                                 Item, Size = ParseFieldValue(Item)
 977                                 AllPcdValueList.append(Item[1:-1])
 978                                 continue
 979                             else:
 980                                 ValueType = ""
 981                                 if Item.startswith(TAB_UINT8):
 982                                     ItemSize = 1
 983                                     ValueType = TAB_UINT8
 984                                 elif Item.startswith(TAB_UINT16):
 985                                     ItemSize = 2
 986                                     ValueType = TAB_UINT16
 987                                 elif Item.startswith(TAB_UINT32):
 988                                     ItemSize = 4
 989                                     ValueType = TAB_UINT32
 990                                 elif Item.startswith(TAB_UINT64):
 991                                     ItemSize = 8
 992                                     ValueType = TAB_UINT64
 993                                 else:
 994                                     ItemSize = 0
 995                                 if ValueType:
 996                                     TmpValue = ValueExpressionEx(Item, ValueType, self._Symb)(True)
 997                                 else:
 998                                     TmpValue = ValueExpressionEx(Item, self.PcdType, self._Symb)(True)
 999                                 Item = '0x%x' % TmpValue if type(TmpValue) != type('') else TmpValue
1000                                 if ItemSize == 0:
1001                                     ItemValue, ItemSize = ParseFieldValue(Item)
1002                                     if Item[0] not in {'"','L','{'} and ItemSize > 1:
1003                                         raise BadExpression("Byte  array number %s should less than 0xFF." % Item)
1004                                 else:
1005                                     ItemValue = ParseFieldValue(Item)[0]
1006                                 for I in range(0, ItemSize):
1007                                     ValueStr = '0x%02X' % (int(ItemValue) & 255)
1008                                     ItemValue >>= 8
1009                                     AllPcdValueList.append(ValueStr)
1010                                 Size += ItemSize
1011
1012                         if Size > 0:
1013                             PcdValue = '{' + ','.join(AllPcdValueList) + '}'
1014                     else:
1015                         raise  BadExpression("Type: %s, Value: %s, %s"%(self.PcdType, PcdValue, Value))
1016
1017         if PcdValue == 'True':
1018             PcdValue = '1'
1019         if PcdValue == 'False':
1020             PcdValue = '0'
1021
1022         if RealValue:
1023             return PcdValue
1024
1025 if __name__ == '__main__':
1026     pass
1027     while True:
1028         input = raw_input('Input expr: ')
1029         if input in 'qQ':
1030             break
1031         try:
1032             print(ValueExpression(input)(True))
1033             print(ValueExpression(input)(False))
1034         except WrnExpression as Ex:
1035             print(Ex.result)
1036             print(str(Ex))
1037         except Exception as Ex:
1038             print(str(Ex))