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