BaseTools/Source/Python/Common/RangeExpression.py

   1 # # @file
   2 # This file is used to parse and evaluate range expression in Pcd declaration.
   3 #
   4 # Copyright (c) 2015 - 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 import uuid
  19
  20 ERR_STRING_EXPR = 'This operator cannot be used in string expression: [%s].'
  21 ERR_SNYTAX = 'Syntax error, the rest of expression cannot be evaluated: [%s].'
  22 ERR_MATCH = 'No matching right parenthesis.'
  23 ERR_STRING_TOKEN = 'Bad string token: [%s].'
  24 ERR_MACRO_TOKEN = 'Bad macro token: [%s].'
  25 ERR_EMPTY_TOKEN = 'Empty token is not allowed.'
  26 ERR_PCD_RESOLVE = 'PCD token cannot be resolved: [%s].'
  27 ERR_VALID_TOKEN = 'No more valid token found from rest of string: [%s].'
  28 ERR_EXPR_TYPE = 'Different types found in expression.'
  29 ERR_OPERATOR_UNSUPPORT = 'Unsupported operator: [%s]'
  30 ERR_REL_NOT_IN = 'Expect "IN" after "not" operator.'
  31 WRN_BOOL_EXPR = 'Operand of boolean type cannot be used in arithmetic expression.'
  32 WRN_EQCMP_STR_OTHERS = '== Comparison between Operand of string type and Boolean/Number Type always return False.'
  33 WRN_NECMP_STR_OTHERS = '!= Comparison between Operand of string type and Boolean/Number Type always return True.'
  34 ERR_RELCMP_STR_OTHERS = 'Operator taking Operand of string type and Boolean/Number Type is not allowed: [%s].'
  35 ERR_STRING_CMP = 'Unicode string and general string cannot be compared: [%s %s %s]'
  36 ERR_ARRAY_TOKEN = 'Bad C array or C format GUID token: [%s].'
  37 ERR_ARRAY_ELE = 'This must be HEX value for NList or Array: [%s].'
  38 ERR_EMPTY_EXPR = 'Empty expression is not allowed.'
  39 ERR_IN_OPERAND = 'Macro after IN operator can only be: $(FAMILY), $(ARCH), $(TOOL_CHAIN_TAG) and $(TARGET).'
  40
  41 def MaxOfType(DataType):
  42     if DataType == 'UINT8':
  43         return int('0xFF', 16)
  44     if DataType == 'UINT16':
  45         return int('0xFFFF', 16)
  46     if DataType == 'UINT32':
  47         return int('0xFFFFFFFF', 16)
  48     if DataType == 'UINT64':
  49         return int('0xFFFFFFFFFFFFFFFF', 16)
  50
  51 class RangeObject(object):
  52     def __init__(self, start, end, empty = False):
  53
  54         if int(start) < int(end):
  55             self.start = int(start)
  56             self.end = int(end)
  57         else:
  58             self.start = int(end)
  59             self.end = int(start)
  60         self.empty = empty
  61
  62 class RangeContainer(object):
  63     def __init__(self):
  64         self.rangelist = []
  65
  66     def push(self, RangeObject):
  67         self.rangelist.append(RangeObject)
  68         self.rangelist = sorted(self.rangelist, key = lambda rangeobj : rangeobj.start)
  69         self.merge()
  70
  71     def pop(self):
  72         for item in self.rangelist:
  73             yield item
  74
  75     def __clean__(self):
  76         newrangelist = []
  77         for rangeobj in self.rangelist:
  78             if rangeobj.empty == True:
  79                 continue
  80             else:
  81                 newrangelist.append(rangeobj)
  82         self.rangelist = newrangelist
  83     def merge(self):
  84         self.__clean__()
  85         for i in range(0, len(self.rangelist) - 1):
  86             if self.rangelist[i + 1].start > self.rangelist[i].end:
  87                 continue
  88             else:
  89                 self.rangelist[i + 1].start = self.rangelist[i].start
  90                 self.rangelist[i + 1].end = self.rangelist[i + 1].end > self.rangelist[i].end and self.rangelist[i + 1].end or self.rangelist[i].end
  91                 self.rangelist[i].empty = True
  92
  93         self.__clean__()
  94
  95     def dump(self):
  96         print "----------------------"
  97         rangelist = ""
  98         for object in self.rangelist:
  99             rangelist = rangelist + "[%d , %d]" % (object.start, object.end)
 100         print rangelist
 101
 102
 103 class XOROperatorObject(object):
 104     def __init__(self):
 105         pass
 106     def Calculate(self, Operand, DataType, SymbolTable):
 107         if type(Operand) == type('') and not Operand.isalnum():
 108             Expr = "XOR ..."
 109             raise BadExpression(ERR_SNYTAX % Expr)
 110         rangeId = str(uuid.uuid1())
 111         rangeContainer = RangeContainer()
 112         rangeContainer.push(RangeObject(0, int(Operand) - 1))
 113         rangeContainer.push(RangeObject(int(Operand) + 1, MaxOfType(DataType)))
 114         SymbolTable[rangeId] = rangeContainer
 115         return rangeId
 116
 117 class LEOperatorObject(object):
 118     def __init__(self):
 119         pass
 120     def Calculate(self, Operand, DataType, SymbolTable):
 121         if type(Operand) == type('') and not Operand.isalnum():
 122             Expr = "LE ..."
 123             raise BadExpression(ERR_SNYTAX % Expr)
 124         rangeId1 = str(uuid.uuid1())
 125         rangeContainer = RangeContainer()
 126         rangeContainer.push(RangeObject(0, int(Operand)))
 127         SymbolTable[rangeId1] = rangeContainer
 128         return rangeId1
 129 class LTOperatorObject(object):
 130     def __init__(self):
 131         pass
 132     def Calculate(self, Operand, DataType, SymbolTable):
 133         if type(Operand) == type('') and not Operand.isalnum():
 134             Expr = "LT ..."
 135             raise BadExpression(ERR_SNYTAX % Expr)
 136         rangeId1 = str(uuid.uuid1())
 137         rangeContainer = RangeContainer()
 138         rangeContainer.push(RangeObject(0, int(Operand) - 1))
 139         SymbolTable[rangeId1] = rangeContainer
 140         return rangeId1
 141
 142 class GEOperatorObject(object):
 143     def __init__(self):
 144         pass
 145     def Calculate(self, Operand, DataType, SymbolTable):
 146         if type(Operand) == type('') and not Operand.isalnum():
 147             Expr = "GE ..."
 148             raise BadExpression(ERR_SNYTAX % Expr)
 149         rangeId1 = str(uuid.uuid1())
 150         rangeContainer = RangeContainer()
 151         rangeContainer.push(RangeObject(int(Operand), MaxOfType(DataType)))
 152         SymbolTable[rangeId1] = rangeContainer
 153         return rangeId1
 154
 155 class GTOperatorObject(object):
 156     def __init__(self):
 157         pass
 158     def Calculate(self, Operand, DataType, SymbolTable):
 159         if type(Operand) == type('') and not Operand.isalnum():
 160             Expr = "GT ..."
 161             raise BadExpression(ERR_SNYTAX % Expr)
 162         rangeId1 = str(uuid.uuid1())
 163         rangeContainer = RangeContainer()
 164         rangeContainer.push(RangeObject(int(Operand) + 1, MaxOfType(DataType)))
 165         SymbolTable[rangeId1] = rangeContainer
 166         return rangeId1
 167
 168 class EQOperatorObject(object):
 169     def __init__(self):
 170         pass
 171     def Calculate(self, Operand, DataType, SymbolTable):
 172         if type(Operand) == type('') and not Operand.isalnum():
 173             Expr = "EQ ..."
 174             raise BadExpression(ERR_SNYTAX % Expr)
 175         rangeId1 = str(uuid.uuid1())
 176         rangeContainer = RangeContainer()
 177         rangeContainer.push(RangeObject(int(Operand) , int(Operand)))
 178         SymbolTable[rangeId1] = rangeContainer
 179         return rangeId1
 180
 181 def GetOperatorObject(Operator):
 182     if Operator == '>':
 183         return GTOperatorObject()
 184     elif Operator == '>=':
 185         return GEOperatorObject()
 186     elif Operator == '<':
 187         return LTOperatorObject()
 188     elif Operator == '<=':
 189         return LEOperatorObject()
 190     elif Operator == '==':
 191         return EQOperatorObject()
 192     elif Operator == '^':
 193         return XOROperatorObject()
 194     else:
 195         raise BadExpression("Bad Operator")
 196
 197 class RangeExpression(object):
 198     # Logical operator mapping
 199     LogicalOperators = {
 200         '&&' : 'and', '||' : 'or',
 201         '!'  : 'not', 'AND': 'and',
 202         'OR' : 'or' , 'NOT': 'not',
 203         'XOR': '^'  , 'xor': '^',
 204         'EQ' : '==' , 'NE' : '!=',
 205         'GT' : '>'  , 'LT' : '<',
 206         'GE' : '>=' , 'LE' : '<=',
 207         'IN' : 'in'
 208     }
 209
 210     NonLetterOpLst = ['+', '-', '&', '|', '^', '!', '=', '>', '<']
 211
 212     PcdPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_]*\.[_a-zA-Z][0-9A-Za-z_]*$')
 213
 214     RangePattern = re.compile(r'[0-9]+ - [0-9]+')
 215
 216     def preProcessRangeExpr(self, expr):
 217         # convert hex to int
 218         # convert interval to object index. ex. 1 - 10 to a GUID
 219         expr = expr.strip()
 220         NumberDict = {}
 221         for HexNumber in gHexPattern.findall(expr):
 222             Number = str(int(HexNumber, 16))
 223             NumberDict[HexNumber] = Number
 224         for HexNum in NumberDict:
 225             expr = expr.replace(HexNum, NumberDict[HexNum])
 226
 227         rangedict = {}
 228         for validrange in self.RangePattern.findall(expr):
 229             start, end = validrange.split(" - ")
 230             start = start.strip()
 231             end = end.strip()
 232             rangeid = str(uuid.uuid1())
 233             rangeContainer = RangeContainer()
 234             rangeContainer.push(RangeObject(start, end))
 235             self.operanddict[str(rangeid)] = rangeContainer
 236             rangedict[validrange] = str(rangeid)
 237
 238         for validrange in rangedict:
 239             expr = expr.replace(validrange, rangedict[validrange])
 240
 241         self._Expr = expr
 242         return expr
 243
 244
 245     def EvalRange(self, Operator, Oprand):
 246
 247         operatorobj = GetOperatorObject(Operator)
 248         return operatorobj.Calculate(Oprand, self.PcdDataType, self.operanddict)
 249
 250     def Rangeintersection(self, Oprand1, Oprand2):
 251         rangeContainer1 = self.operanddict[Oprand1]
 252         rangeContainer2 = self.operanddict[Oprand2]
 253         rangeContainer = RangeContainer()
 254         for range1 in rangeContainer1.pop():
 255             for range2 in rangeContainer2.pop():
 256                 start1 = range1.start
 257                 end1 = range1.end
 258                 start2 = range2.start
 259                 end2 = range2.end
 260                 if start1 >= start2:
 261                     start1, start2 = start2, start1
 262                     end1, end2 = end2, end1
 263                 if range1.empty:
 264                     rangeid = str(uuid.uuid1())
 265                     rangeContainer.push(RangeObject(0, 0, True))
 266                 if end1 < start2:
 267                     rangeid = str(uuid.uuid1())
 268                     rangeContainer.push(RangeObject(0, 0, True))
 269                 elif end1 == start2:
 270                     rangeid = str(uuid.uuid1())
 271                     rangeContainer.push(RangeObject(end1, end1))
 272                 elif end1 <= end2 and end1 > start2:
 273                     rangeid = str(uuid.uuid1())
 274                     rangeContainer.push(RangeObject(start2, end1))
 275                 elif end1 >= end2:
 276                     rangeid = str(uuid.uuid1())
 277                     rangeContainer.push(RangeObject(start2, end2))
 278
 279         self.operanddict[rangeid] = rangeContainer
 280 #        rangeContainer.dump()
 281         return rangeid
 282
 283     def Rangecollections(self, Oprand1, Oprand2):
 284
 285         rangeContainer1 = self.operanddict[Oprand1]
 286         rangeContainer2 = self.operanddict[Oprand2]
 287         rangeContainer = RangeContainer()
 288
 289         for rangeobj in rangeContainer2.pop():
 290             rangeContainer.push(rangeobj)
 291         for rangeobj in rangeContainer1.pop():
 292             rangeContainer.push(rangeobj)
 293
 294         rangeid = str(uuid.uuid1())
 295         self.operanddict[rangeid] = rangeContainer
 296
 297 #        rangeContainer.dump()
 298         return rangeid
 299
 300
 301     def NegtiveRange(self, Oprand1):
 302         rangeContainer1 = self.operanddict[Oprand1]
 303
 304
 305         rangeids = []
 306
 307         for rangeobj in rangeContainer1.pop():
 308             rangeContainer = RangeContainer()
 309             rangeid = str(uuid.uuid1())
 310             if rangeobj.empty:
 311                 rangeContainer.push(RangeObject(0, MaxOfType(self.PcdDataType)))
 312             else:
 313                 if rangeobj.start > 0:
 314                     rangeContainer.push(RangeObject(0, rangeobj.start - 1))
 315                 if rangeobj.end < MaxOfType(self.PcdDataType):
 316                     rangeContainer.push(RangeObject(rangeobj.end + 1, MaxOfType(self.PcdDataType)))
 317             self.operanddict[rangeid] = rangeContainer
 318             rangeids.append(rangeid)
 319
 320         if len(rangeids) == 0:
 321             rangeContainer = RangeContainer()
 322             rangeContainer.push(RangeObject(0, MaxOfType(self.PcdDataType)))
 323             rangeid = str(uuid.uuid1())
 324             self.operanddict[rangeid] = rangeContainer
 325             return rangeid
 326
 327         if len(rangeids) == 1:
 328             return rangeids[0]
 329
 330         re = self.Rangeintersection(rangeids[0], rangeids[1])
 331         for i in range(2, len(rangeids)):
 332             re = self.Rangeintersection(re, rangeids[i])
 333
 334         rangeid2 = str(uuid.uuid1())
 335         self.operanddict[rangeid2] = self.operanddict[re]
 336         return rangeid2
 337
 338     def Eval(self, Operator, Oprand1, Oprand2 = None):
 339
 340         if Operator in ["!", "NOT", "not"]:
 341             if not gGuidPattern.match(Oprand1.strip()):
 342                 raise BadExpression(ERR_STRING_EXPR % Operator)
 343             return self.NegtiveRange(Oprand1)
 344         else:
 345             if Operator in ["==", ">=", "<=", ">", "<", '^']:
 346                 return self.EvalRange(Operator, Oprand1)
 347             elif Operator == 'and' :
 348                 if not gGuidPatternEnd.match(Oprand1.strip()) or not gGuidPatternEnd.match(Oprand2.strip()):
 349                     raise BadExpression(ERR_STRING_EXPR % Operator)
 350                 return self.Rangeintersection(Oprand1, Oprand2)
 351             elif Operator == 'or':
 352                 if not gGuidPatternEnd.match(Oprand1.strip()) or not gGuidPatternEnd.match(Oprand2.strip()):
 353                     raise BadExpression(ERR_STRING_EXPR % Operator)
 354                 return self.Rangecollections(Oprand1, Oprand2)
 355             else:
 356                 raise BadExpression(ERR_STRING_EXPR % Operator)
 357
 358
 359     def __init__(self, Expression, PcdDataType, SymbolTable = {}):
 360         self._NoProcess = False
 361         if type(Expression) != type(''):
 362             self._Expr = Expression
 363             self._NoProcess = True
 364             return
 365
 366         self._Expr = Expression.strip()
 367
 368         if not self._Expr.strip():
 369             raise BadExpression(ERR_EMPTY_EXPR)
 370
 371         #
 372         # The symbol table including PCD and macro mapping
 373         #
 374         self._Symb = SymbolTable
 375         self._Symb.update(self.LogicalOperators)
 376         self._Idx = 0
 377         self._Len = len(self._Expr)
 378         self._Token = ''
 379         self._WarnExcept = None
 380
 381
 382         # Literal token without any conversion
 383         self._LiteralToken = ''
 384
 385         # store the operand object
 386         self.operanddict = {}
 387         # The Pcd max value depends on PcdDataType
 388         self.PcdDataType = PcdDataType
 389
 390     # Public entry for this class
 391     #   @param RealValue: False: only evaluate if the expression is true or false, used for conditional expression
 392     #                     True : return the evaluated str(value), used for PCD value
 393     #
 394     #   @return: True or False if RealValue is False
 395     #            Evaluated value of string format if RealValue is True
 396     #
 397     def __call__(self, RealValue = False, Depth = 0):
 398         if self._NoProcess:
 399             return self._Expr
 400
 401         self._Depth = Depth
 402
 403         self._Expr = self._Expr.strip()
 404
 405         self.preProcessRangeExpr(self._Expr)
 406
 407         # check if the expression does not need to evaluate
 408         if RealValue and Depth == 0:
 409             self._Token = self._Expr
 410             if gGuidPatternEnd.match(self._Expr):
 411                 return [self.operanddict[self._Expr] ]
 412
 413             self._Idx = 0
 414             self._Token = ''
 415
 416         Val = self._OrExpr()
 417         RealVal = Val
 418
 419         RangeIdList = RealVal.split("or")
 420         RangeList = []
 421         for rangeid in RangeIdList:
 422             RangeList.append(self.operanddict[rangeid.strip()])
 423
 424         return RangeList
 425
 426     # Template function to parse binary operators which have same precedence
 427     # Expr [Operator Expr]*
 428     def _ExprFuncTemplate(self, EvalFunc, OpLst):
 429         Val = EvalFunc()
 430         while self._IsOperator(OpLst):
 431             Op = self._Token
 432             try:
 433                 Val = self.Eval(Op, Val, EvalFunc())
 434             except WrnExpression, Warn:
 435                 self._WarnExcept = Warn
 436                 Val = Warn.result
 437         return Val
 438
 439     # A [|| B]*
 440     def _OrExpr(self):
 441         return self._ExprFuncTemplate(self._AndExpr, ["OR", "or"])
 442
 443     # A [&& B]*
 444     def _AndExpr(self):
 445         return self._ExprFuncTemplate(self._NeExpr, ["AND", "and"])
 446
 447     def _NeExpr(self):
 448         Val = self._RelExpr()
 449         while self._IsOperator([ "!=", "NOT", "not"]):
 450             Op = self._Token
 451             if Op in ["!", "NOT", "not"]:
 452                 if not self._IsOperator(["IN", "in"]):
 453                     raise BadExpression(ERR_REL_NOT_IN)
 454                 Op += ' ' + self._Token
 455             try:
 456                 Val = self.Eval(Op, Val, self._RelExpr())
 457             except WrnExpression, Warn:
 458                 self._WarnExcept = Warn
 459                 Val = Warn.result
 460         return Val
 461
 462     # [!]*A
 463     def _RelExpr(self):
 464         if self._IsOperator(["NOT" , "LE", "GE", "LT", "GT", "EQ", "XOR"]):
 465             Token = self._Token
 466             Val = self._NeExpr()
 467             try:
 468                 return self.Eval(Token, Val)
 469             except WrnExpression, Warn:
 470                 self._WarnExcept = Warn
 471                 return Warn.result
 472         return self._IdenExpr()
 473
 474     # Parse identifier or encapsulated expression
 475     def _IdenExpr(self):
 476         Tk = self._GetToken()
 477         if Tk == '(':
 478             Val = self._OrExpr()
 479             try:
 480                 # _GetToken may also raise BadExpression
 481                 if self._GetToken() != ')':
 482                     raise BadExpression(ERR_MATCH)
 483             except BadExpression:
 484                 raise BadExpression(ERR_MATCH)
 485             return Val
 486         return Tk
 487
 488     # Skip whitespace or tab
 489     def __SkipWS(self):
 490         for Char in self._Expr[self._Idx:]:
 491             if Char not in ' \t':
 492                 break
 493             self._Idx += 1
 494
 495     # Try to convert string to number
 496     def __IsNumberToken(self):
 497         Radix = 10
 498         if self._Token.lower()[0:2] == '0x' and len(self._Token) > 2:
 499             Radix = 16
 500         try:
 501             self._Token = int(self._Token, Radix)
 502             return True
 503         except ValueError:
 504             return False
 505         except TypeError:
 506             return False
 507
 508     # Parse array: {...}
 509     def __GetArray(self):
 510         Token = '{'
 511         self._Idx += 1
 512         self.__GetNList(True)
 513         Token += self._LiteralToken
 514         if self._Idx >= self._Len or self._Expr[self._Idx] != '}':
 515             raise BadExpression(ERR_ARRAY_TOKEN % Token)
 516         Token += '}'
 517
 518         # All whitespace and tabs in array are already stripped.
 519         IsArray = IsGuid = False
 520         if len(Token.split(',')) == 11 and len(Token.split(',{')) == 2 \
 521             and len(Token.split('},')) == 1:
 522             HexLen = [11, 6, 6, 5, 4, 4, 4, 4, 4, 4, 6]
 523             HexList = Token.split(',')
 524             if HexList[3].startswith('{') and \
 525                 not [Index for Index, Hex in enumerate(HexList) if len(Hex) > HexLen[Index]]:
 526                 IsGuid = True
 527         if Token.lstrip('{').rstrip('}').find('{') == -1:
 528             if not [Hex for Hex in Token.lstrip('{').rstrip('}').split(',') if len(Hex) > 4]:
 529                 IsArray = True
 530         if not IsArray and not IsGuid:
 531             raise BadExpression(ERR_ARRAY_TOKEN % Token)
 532         self._Idx += 1
 533         self._Token = self._LiteralToken = Token
 534         return self._Token
 535
 536     # Parse string, the format must be: "..."
 537     def __GetString(self):
 538         Idx = self._Idx
 539
 540         # Skip left quote
 541         self._Idx += 1
 542
 543         # Replace escape \\\", \"
 544         Expr = self._Expr[self._Idx:].replace('\\\\', '//').replace('\\\"', '\\\'')
 545         for Ch in Expr:
 546             self._Idx += 1
 547             if Ch == '"':
 548                 break
 549         self._Token = self._LiteralToken = self._Expr[Idx:self._Idx]
 550         if not self._Token.endswith('"'):
 551             raise BadExpression(ERR_STRING_TOKEN % self._Token)
 552         self._Token = self._Token[1:-1]
 553         return self._Token
 554
 555     # Get token that is comprised by alphanumeric, underscore or dot(used by PCD)
 556     # @param IsAlphaOp: Indicate if parsing general token or script operator(EQ, NE...)
 557     def __GetIdToken(self, IsAlphaOp = False):
 558         IdToken = ''
 559         for Ch in self._Expr[self._Idx:]:
 560             if not self.__IsIdChar(Ch):
 561                 break
 562             self._Idx += 1
 563             IdToken += Ch
 564
 565         self._Token = self._LiteralToken = IdToken
 566         if not IsAlphaOp:
 567             self.__ResolveToken()
 568         return self._Token
 569
 570     # Try to resolve token
 571     def __ResolveToken(self):
 572         if not self._Token:
 573             raise BadExpression(ERR_EMPTY_TOKEN)
 574
 575         # PCD token
 576         if self.PcdPattern.match(self._Token):
 577             if self._Token not in self._Symb:
 578                 Ex = BadExpression(ERR_PCD_RESOLVE % self._Token)
 579                 Ex.Pcd = self._Token
 580                 raise Ex
 581             self._Token = RangeExpression(self._Symb[self._Token], self._Symb)(True, self._Depth + 1)
 582             if type(self._Token) != type(''):
 583                 self._LiteralToken = hex(self._Token)
 584                 return
 585
 586         if self._Token.startswith('"'):
 587             self._Token = self._Token[1:-1]
 588         elif self._Token in ["FALSE", "false", "False"]:
 589             self._Token = False
 590         elif self._Token in ["TRUE", "true", "True"]:
 591             self._Token = True
 592         else:
 593             self.__IsNumberToken()
 594
 595     def __GetNList(self, InArray = False):
 596         self._GetSingleToken()
 597         if not self.__IsHexLiteral():
 598             if InArray:
 599                 raise BadExpression(ERR_ARRAY_ELE % self._Token)
 600             return self._Token
 601
 602         self.__SkipWS()
 603         Expr = self._Expr[self._Idx:]
 604         if not Expr.startswith(','):
 605             return self._Token
 606
 607         NList = self._LiteralToken
 608         while Expr.startswith(','):
 609             NList += ','
 610             self._Idx += 1
 611             self.__SkipWS()
 612             self._GetSingleToken()
 613             if not self.__IsHexLiteral():
 614                 raise BadExpression(ERR_ARRAY_ELE % self._Token)
 615             NList += self._LiteralToken
 616             self.__SkipWS()
 617             Expr = self._Expr[self._Idx:]
 618         self._Token = self._LiteralToken = NList
 619         return self._Token
 620
 621     def __IsHexLiteral(self):
 622         if self._LiteralToken.startswith('{') and \
 623             self._LiteralToken.endswith('}'):
 624             return True
 625
 626         if gHexPattern.match(self._LiteralToken):
 627             Token = self._LiteralToken[2:]
 628             Token = Token.lstrip('0')
 629             if not Token:
 630                 self._LiteralToken = '0x0'
 631             else:
 632                 self._LiteralToken = '0x' + Token.lower()
 633             return True
 634         return False
 635
 636     def _GetToken(self):
 637         return self.__GetNList()
 638
 639     @staticmethod
 640     def __IsIdChar(Ch):
 641         return Ch in '._/:' or Ch.isalnum()
 642
 643     # Parse operand
 644     def _GetSingleToken(self):
 645         self.__SkipWS()
 646         Expr = self._Expr[self._Idx:]
 647         if Expr.startswith('L"'):
 648             # Skip L
 649             self._Idx += 1
 650             UStr = self.__GetString()
 651             self._Token = 'L"' + UStr + '"'
 652             return self._Token
 653
 654         self._Token = ''
 655         if Expr:
 656             Ch = Expr[0]
 657             Match = gGuidPattern.match(Expr)
 658             if Match and not Expr[Match.end():Match.end() + 1].isalnum() \
 659                 and Expr[Match.end():Match.end() + 1] != '_':
 660                 self._Idx += Match.end()
 661                 self._Token = Expr[0:Match.end()]
 662                 return self._Token
 663             elif self.__IsIdChar(Ch):
 664                 return self.__GetIdToken()
 665             elif Ch == '(' or Ch == ')':
 666                 self._Idx += 1
 667                 self._Token = Ch
 668                 return self._Token
 669
 670         raise BadExpression(ERR_VALID_TOKEN % Expr)
 671
 672     # Parse operator
 673     def _GetOperator(self):
 674         self.__SkipWS()
 675         LegalOpLst = ['&&', '||', '!=', '==', '>=', '<='] + self.NonLetterOpLst
 676
 677         self._Token = ''
 678         Expr = self._Expr[self._Idx:]
 679
 680         # Reach end of expression
 681         if not Expr:
 682             return ''
 683
 684         # Script operator: LT, GT, LE, GE, EQ, NE, and, or, xor, not
 685         if Expr[0].isalpha():
 686             return self.__GetIdToken(True)
 687
 688         # Start to get regular operator: +, -, <, > ...
 689         if Expr[0] not in self.NonLetterOpLst:
 690             return ''
 691
 692         OpToken = ''
 693         for Ch in Expr:
 694             if Ch in self.NonLetterOpLst:
 695                 if '!' == Ch and OpToken:
 696                     break
 697                 self._Idx += 1
 698                 OpToken += Ch
 699             else:
 700                 break
 701
 702         if OpToken not in LegalOpLst:
 703             raise BadExpression(ERR_OPERATOR_UNSUPPORT % OpToken)
 704         self._Token = OpToken
 705         return OpToken
 706
 707     # Check if current token matches the operators given from OpList
 708     def _IsOperator(self, OpList):
 709         Idx = self._Idx
 710         self._GetOperator()
 711         if self._Token in OpList:
 712             if self._Token in self.LogicalOperators:
 713                 self._Token = self.LogicalOperators[self._Token]
 714             return True
 715         self._Idx = Idx
 716         return False
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727 #    UTRangeList()