BaseTools/Source/Python/Common/Expression.py

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