]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/Common/Expression.py
Sync BaseTools Trunk (version r2518) to EDKII main trunk.
[mirror_edk2.git] / 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, 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
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 ## SplitString
42 # Split string to list according double quote
43 # For example: abc"de\"f"ghi"jkl"mn will be: ['abc', '"de\"f"', 'ghi', '"jkl"', 'mn']
44 #
45 def SplitString(String):
46 # There might be escaped quote: "abc\"def\\\"ghi"
47 Str = String.replace('\\\\', '//').replace('\\\"', '\\\'')
48 RetList = []
49 InQuote = False
50 Item = ''
51 for i, ch in enumerate(Str):
52 if ch == '"':
53 InQuote = not InQuote
54 if not InQuote:
55 Item += String[i]
56 RetList.append(Item)
57 Item = ''
58 continue
59 if Item:
60 RetList.append(Item)
61 Item = ''
62 Item += String[i]
63 if InQuote:
64 raise BadExpression(ERR_STRING_TOKEN % Item)
65 if Item:
66 RetList.append(Item)
67 return RetList
68
69 ## ReplaceExprMacro
70 #
71 def ReplaceExprMacro(String, Macros, ExceptionList = None):
72 StrList = SplitString(String)
73 for i, String in enumerate(StrList):
74 InQuote = False
75 if String.startswith('"'):
76 InQuote = True
77 MacroStartPos = String.find('$(')
78 if MacroStartPos < 0:
79 continue
80 RetStr = ''
81 while MacroStartPos >= 0:
82 RetStr = String[0:MacroStartPos]
83 MacroEndPos = String.find(')', MacroStartPos)
84 if MacroEndPos < 0:
85 raise BadExpression(ERR_MACRO_TOKEN % String[MacroStartPos:])
86 Macro = String[MacroStartPos+2:MacroEndPos]
87 if Macro not in Macros:
88 # From C reference manual:
89 # If an undefined macro name appears in the constant-expression of
90 # !if or !elif, it is replaced by the integer constant 0.
91 RetStr += '0'
92 elif not InQuote:
93 Tklst = RetStr.split()
94 if Tklst and Tklst[-1] in ['IN', 'in'] and ExceptionList and Macro not in ExceptionList:
95 raise BadExpression(ERR_IN_OPERAND)
96 # Make sure the macro in exception list is encapsulated by double quote
97 # For example: DEFINE ARCH = IA32 X64
98 # $(ARCH) is replaced with "IA32 X64"
99 if ExceptionList and Macro in ExceptionList:
100 RetStr += '"' + Macros[Macro] + '"'
101 elif Macros[Macro].strip():
102 RetStr += Macros[Macro]
103 else:
104 RetStr += '""'
105 else:
106 RetStr += Macros[Macro]
107 RetStr += String[MacroEndPos+1:]
108 String = RetStr
109 MacroStartPos = String.find('$(')
110 StrList[i] = RetStr
111 return ''.join(StrList)
112
113 SupportedInMacroList = ['TARGET', 'TOOL_CHAIN_TAG', 'ARCH', 'FAMILY']
114
115 class ValueExpression(object):
116 # Logical operator mapping
117 LogicalOperators = {
118 '&&' : 'and', '||' : 'or',
119 '!' : 'not', 'AND': 'and',
120 'OR' : 'or' , 'NOT': 'not',
121 'XOR': '^' , 'xor': '^',
122 'EQ' : '==' , 'NE' : '!=',
123 'GT' : '>' , 'LT' : '<',
124 'GE' : '>=' , 'LE' : '<=',
125 'IN' : 'in'
126 }
127
128 NonLetterOpLst = ['+', '-', '&', '|', '^', '!', '=', '>', '<']
129
130 PcdPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_]*\.[_a-zA-Z][0-9A-Za-z_]*$')
131 HexPattern = re.compile(r'0[xX][0-9a-fA-F]+$')
132 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}')
133
134 SymbolPattern = re.compile("("
135 "\$\([A-Z][A-Z0-9_]*\)|\$\(\w+\.\w+\)|\w+\.\w+|"
136 "&&|\|\||!(?!=)|"
137 "(?<=\W)AND(?=\W)|(?<=\W)OR(?=\W)|(?<=\W)NOT(?=\W)|(?<=\W)XOR(?=\W)|"
138 "(?<=\W)EQ(?=\W)|(?<=\W)NE(?=\W)|(?<=\W)GT(?=\W)|(?<=\W)LT(?=\W)|(?<=\W)GE(?=\W)|(?<=\W)LE(?=\W)"
139 ")")
140
141 @staticmethod
142 def Eval(Operator, Oprand1, Oprand2 = None):
143 WrnExp = None
144
145 if Operator not in ["==", "!=", ">=", "<=", ">", "<", "in", "not in"] and \
146 (type(Oprand1) == type('') or type(Oprand2) == type('')):
147 raise BadExpression(ERR_STRING_EXPR % Operator)
148
149 TypeDict = {
150 type(0) : 0,
151 type(0L) : 0,
152 type('') : 1,
153 type(True) : 2
154 }
155
156 EvalStr = ''
157 if Operator in ["!", "NOT", "not"]:
158 if type(Oprand1) == type(''):
159 raise BadExpression(ERR_STRING_EXPR % Operator)
160 EvalStr = 'not Oprand1'
161 else:
162 if Operator in ["+", "-"] and (type(True) in [type(Oprand1), type(Oprand2)]):
163 # Boolean in '+'/'-' will be evaluated but raise warning
164 WrnExp = WrnExpression(WRN_BOOL_EXPR)
165 elif type('') in [type(Oprand1), type(Oprand2)] and type(Oprand1)!= type(Oprand2):
166 # == between string and number/boolean will always return False, != return True
167 if Operator == "==":
168 WrnExp = WrnExpression(WRN_EQCMP_STR_OTHERS)
169 WrnExp.result = False
170 raise WrnExp
171 elif Operator == "!=":
172 WrnExp = WrnExpression(WRN_NECMP_STR_OTHERS)
173 WrnExp.result = True
174 raise WrnExp
175 else:
176 raise BadExpression(ERR_RELCMP_STR_OTHERS % Operator)
177 elif TypeDict[type(Oprand1)] != TypeDict[type(Oprand2)]:
178 if Operator in ["==", "!=", ">=", "<=", ">", "<"] and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):
179 # comparison between number and boolean is allowed
180 pass
181 elif Operator in ['&', '|', '^', "and", "or"] and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):
182 # bitwise and logical operation between number and boolean is allowed
183 pass
184 else:
185 raise BadExpression(ERR_EXPR_TYPE)
186 if type(Oprand1) == type('') and type(Oprand2) == type(''):
187 if (Oprand1.startswith('L"') and not Oprand2.startswith('L"')) or \
188 (not Oprand1.startswith('L"') and Oprand2.startswith('L"')):
189 raise BadExpression(ERR_STRING_CMP % (Oprand1, Operator, Oprand2))
190 if 'in' in Operator and type(Oprand2) == type(''):
191 Oprand2 = Oprand2.split()
192 EvalStr = 'Oprand1 ' + Operator + ' Oprand2'
193
194 # Local symbols used by built in eval function
195 Dict = {
196 'Oprand1' : Oprand1,
197 'Oprand2' : Oprand2
198 }
199 try:
200 Val = eval(EvalStr, {}, Dict)
201 except Exception, Excpt:
202 raise BadExpression(str(Excpt))
203
204 if Operator in ['and', 'or']:
205 if Val:
206 Val = True
207 else:
208 Val = False
209
210 if WrnExp:
211 WrnExp.result = Val
212 raise WrnExp
213 return Val
214
215 def __init__(self, Expression, SymbolTable={}):
216 self._NoProcess = False
217 if type(Expression) != type(''):
218 self._Expr = Expression
219 self._NoProcess = True
220 return
221
222 self._Expr = ReplaceExprMacro(Expression.strip(),
223 SymbolTable,
224 SupportedInMacroList)
225
226 if not self._Expr.strip():
227 raise BadExpression(ERR_EMPTY_EXPR)
228
229 #
230 # The symbol table including PCD and macro mapping
231 #
232 self._Symb = SymbolTable
233 self._Symb.update(self.LogicalOperators)
234 self._Idx = 0
235 self._Len = len(self._Expr)
236 self._Token = ''
237 self._WarnExcept = None
238
239 # Literal token without any conversion
240 self._LiteralToken = ''
241
242 # Public entry for this class
243 # @param RealValue: False: only evaluate if the expression is true or false, used for conditional expression
244 # True : return the evaluated str(value), used for PCD value
245 #
246 # @return: True or False if RealValue is False
247 # Evaluated value of string format if RealValue is True
248 #
249 def __call__(self, RealValue=False):
250 if self._NoProcess:
251 return self._Expr
252
253 self._Expr = self._Expr.strip()
254 if RealValue:
255 self._Token = self._Expr
256 if self.__IsNumberToken():
257 return self._Expr
258
259 Token = self._GetToken()
260 if type(Token) == type('') and Token.startswith('{') and Token.endswith('}') and self._Idx >= self._Len:
261 return self._Expr
262
263 self._Idx = 0
264 self._Token = ''
265
266 Val = self._OrExpr()
267 RealVal = Val
268 if type(Val) == type(''):
269 if Val == 'L""':
270 Val = False
271 elif not Val:
272 Val = False
273 RealVal = '""'
274 elif not Val.startswith('L"') and not Val.startswith('{'):
275 Val = True
276 RealVal = '"' + RealVal + '"'
277
278 # The expression has been parsed, but the end of expression is not reached
279 # It means the rest does not comply EBNF of <Expression>
280 if self._Idx != self._Len:
281 raise BadExpression(ERR_SNYTAX % self._Expr[self._Idx:])
282
283 if RealValue:
284 RetVal = str(RealVal)
285 elif Val:
286 RetVal = True
287 else:
288 RetVal = False
289
290 if self._WarnExcept:
291 self._WarnExcept.result = RetVal
292 raise self._WarnExcept
293 else:
294 return RetVal
295
296 # Template function to parse binary operators which have same precedence
297 # Expr [Operator Expr]*
298 def _ExprFuncTemplate(self, EvalFunc, OpLst):
299 Val = EvalFunc()
300 while self._IsOperator(OpLst):
301 Op = self._Token
302 try:
303 Val = self.Eval(Op, Val, EvalFunc())
304 except WrnExpression, Warn:
305 self._WarnExcept = Warn
306 Val = Warn.result
307 return Val
308
309 # A [|| B]*
310 def _OrExpr(self):
311 return self._ExprFuncTemplate(self._AndExpr, ["OR", "or", "||"])
312
313 # A [&& B]*
314 def _AndExpr(self):
315 return self._ExprFuncTemplate(self._BitOr, ["AND", "and", "&&"])
316
317 # A [ | B]*
318 def _BitOr(self):
319 return self._ExprFuncTemplate(self._BitXor, ["|"])
320
321 # A [ ^ B]*
322 def _BitXor(self):
323 return self._ExprFuncTemplate(self._BitAnd, ["XOR", "xor", "^"])
324
325 # A [ & B]*
326 def _BitAnd(self):
327 return self._ExprFuncTemplate(self._EqExpr, ["&"])
328
329 # A [ == B]*
330 def _EqExpr(self):
331 Val = self._RelExpr()
332 while self._IsOperator(["==", "!=", "EQ", "NE", "IN", "in", "!", "NOT", "not"]):
333 Op = self._Token
334 if Op in ["!", "NOT", "not"]:
335 if not self._IsOperator(["IN", "in"]):
336 raise BadExpression(ERR_REL_NOT_IN)
337 Op += ' ' + self._Token
338 try:
339 Val = self.Eval(Op, Val, self._RelExpr())
340 except WrnExpression, Warn:
341 self._WarnExcept = Warn
342 Val = Warn.result
343 return Val
344
345 # A [ > B]*
346 def _RelExpr(self):
347 return self._ExprFuncTemplate(self._AddExpr, ["<=", ">=", "<", ">", "LE", "GE", "LT", "GT"])
348
349 # A [ + B]*
350 def _AddExpr(self):
351 return self._ExprFuncTemplate(self._UnaryExpr, ["+", "-"])
352
353 # [!]*A
354 def _UnaryExpr(self):
355 if self._IsOperator(["!", "NOT", "not"]):
356 Val = self._UnaryExpr()
357 try:
358 return self.Eval('not', Val)
359 except WrnExpression, Warn:
360 self._WarnExcept = Warn
361 return Warn.result
362 return self._IdenExpr()
363
364 # Parse identifier or encapsulated expression
365 def _IdenExpr(self):
366 Tk = self._GetToken()
367 if Tk == '(':
368 Val = self._OrExpr()
369 try:
370 # _GetToken may also raise BadExpression
371 if self._GetToken() != ')':
372 raise BadExpression(ERR_MATCH)
373 except BadExpression:
374 raise BadExpression(ERR_MATCH)
375 return Val
376 return Tk
377
378 # Skip whitespace or tab
379 def __SkipWS(self):
380 for Char in self._Expr[self._Idx:]:
381 if Char not in ' \t':
382 break
383 self._Idx += 1
384
385 # Try to convert string to number
386 def __IsNumberToken(self):
387 Radix = 10
388 if self._Token.lower()[0:2] == '0x' and len(self._Token) > 2:
389 Radix = 16
390 try:
391 self._Token = int(self._Token, Radix)
392 return True
393 except ValueError:
394 return False
395 except TypeError:
396 return False
397
398 # Parse array: {...}
399 def __GetArray(self):
400 Token = '{'
401 self._Idx += 1
402 self.__GetNList(True)
403 Token += self._LiteralToken
404 if self._Idx >= self._Len or self._Expr[self._Idx] != '}':
405 raise BadExpression(ERR_ARRAY_TOKEN % Token)
406 Token += '}'
407
408 # All whitespace and tabs in array are already stripped.
409 IsArray = IsGuid = False
410 if len(Token.split(',')) == 11 and len(Token.split(',{')) == 2 \
411 and len(Token.split('},')) == 1:
412 HexLen = [11,6,6,5,4,4,4,4,4,4,6]
413 HexList= Token.split(',')
414 if HexList[3].startswith('{') and \
415 not [Index for Index, Hex in enumerate(HexList) if len(Hex) > HexLen[Index]]:
416 IsGuid = True
417 if Token.lstrip('{').rstrip('}').find('{') == -1:
418 if not [Hex for Hex in Token.lstrip('{').rstrip('}').split(',') if len(Hex) > 4]:
419 IsArray = True
420 if not IsArray and not IsGuid:
421 raise BadExpression(ERR_ARRAY_TOKEN % Token)
422 self._Idx += 1
423 self._Token = self._LiteralToken = Token
424 return self._Token
425
426 # Parse string, the format must be: "..."
427 def __GetString(self):
428 Idx = self._Idx
429
430 # Skip left quote
431 self._Idx += 1
432
433 # Replace escape \\\", \"
434 Expr = self._Expr[self._Idx:].replace('\\\\', '//').replace('\\\"', '\\\'')
435 for Ch in Expr:
436 self._Idx += 1
437 if Ch == '"':
438 break
439 self._Token = self._LiteralToken = self._Expr[Idx:self._Idx]
440 if not self._Token.endswith('"'):
441 raise BadExpression(ERR_STRING_TOKEN % self._Token)
442 self._Token = self._Token[1:-1]
443 return self._Token
444
445 # Get token that is comprised by alphanumeric, underscore or dot(used by PCD)
446 # @param IsAlphaOp: Indicate if parsing general token or script operator(EQ, NE...)
447 def __GetIdToken(self, IsAlphaOp = False):
448 IdToken = ''
449 for Ch in self._Expr[self._Idx:]:
450 if not self.__IsIdChar(Ch):
451 break
452 self._Idx += 1
453 IdToken += Ch
454
455 self._Token = self._LiteralToken = IdToken
456 if not IsAlphaOp:
457 self.__ResolveToken()
458 return self._Token
459
460 # Try to resolve token
461 def __ResolveToken(self):
462 if not self._Token:
463 raise BadExpression(ERR_EMPTY_TOKEN)
464
465 # PCD token
466 if self.PcdPattern.match(self._Token):
467 if self._Token not in self._Symb:
468 Ex = BadExpression(ERR_PCD_RESOLVE % self._Token)
469 Ex.Pcd = self._Token
470 raise Ex
471 self._Token = ValueExpression(self._Symb[self._Token], self._Symb)(True)
472 if type(self._Token) != type(''):
473 self._LiteralToken = hex(self._Token)
474 return
475
476 if self._Token.startswith('"'):
477 self._Token = self._Token[1:-1]
478 elif self._Token in ["FALSE", "false", "False"]:
479 self._Token = False
480 elif self._Token in ["TRUE", "true", "True"]:
481 self._Token = True
482 else:
483 self.__IsNumberToken()
484
485 def __GetNList(self, InArray=False):
486 self._GetSingleToken()
487 if not self.__IsHexLiteral():
488 if InArray:
489 raise BadExpression(ERR_ARRAY_ELE % self._Token)
490 return self._Token
491
492 self.__SkipWS()
493 Expr = self._Expr[self._Idx:]
494 if not Expr.startswith(','):
495 return self._Token
496
497 NList = self._LiteralToken
498 while Expr.startswith(','):
499 NList += ','
500 self._Idx += 1
501 self.__SkipWS()
502 self._GetSingleToken()
503 if not self.__IsHexLiteral():
504 raise BadExpression(ERR_ARRAY_ELE % self._Token)
505 NList += self._LiteralToken
506 self.__SkipWS()
507 Expr = self._Expr[self._Idx:]
508 self._Token = self._LiteralToken = NList
509 return self._Token
510
511 def __IsHexLiteral(self):
512 if self._LiteralToken.startswith('{') and \
513 self._LiteralToken.endswith('}'):
514 return True
515
516 if self.HexPattern.match(self._LiteralToken):
517 Token = self._LiteralToken[2:]
518 Token = Token.lstrip('0')
519 if not Token:
520 self._LiteralToken = '0x0'
521 else:
522 self._LiteralToken = '0x' + Token.lower()
523 return True
524 return False
525
526 def _GetToken(self):
527 return self.__GetNList()
528
529 @staticmethod
530 def __IsIdChar(Ch):
531 return Ch in '._/:' or Ch.isalnum()
532
533 # Parse operand
534 def _GetSingleToken(self):
535 self.__SkipWS()
536 Expr = self._Expr[self._Idx:]
537 if Expr.startswith('L"'):
538 # Skip L
539 self._Idx += 1
540 UStr = self.__GetString()
541 self._Token = 'L"' + UStr + '"'
542 return self._Token
543
544 self._Token = ''
545 if Expr:
546 Ch = Expr[0]
547 Match = self.RegGuidPattern.match(Expr)
548 if Match and not Expr[Match.end():Match.end()+1].isalnum() \
549 and Expr[Match.end():Match.end()+1] != '_':
550 self._Idx += Match.end()
551 self._Token = ValueExpression(GuidStringToGuidStructureString(Expr[0:Match.end()]))(True)
552 return self._Token
553 elif self.__IsIdChar(Ch):
554 return self.__GetIdToken()
555 elif Ch == '"':
556 return self.__GetString()
557 elif Ch == '{':
558 return self.__GetArray()
559 elif Ch == '(' or Ch == ')':
560 self._Idx += 1
561 self._Token = Ch
562 return self._Token
563
564 raise BadExpression(ERR_VALID_TOKEN % Expr)
565
566 # Parse operator
567 def _GetOperator(self):
568 self.__SkipWS()
569 LegalOpLst = ['&&', '||', '!=', '==', '>=', '<='] + self.NonLetterOpLst
570
571 self._Token = ''
572 Expr = self._Expr[self._Idx:]
573
574 # Reach end of expression
575 if not Expr:
576 return ''
577
578 # Script operator: LT, GT, LE, GE, EQ, NE, and, or, xor, not
579 if Expr[0].isalpha():
580 return self.__GetIdToken(True)
581
582 # Start to get regular operator: +, -, <, > ...
583 if Expr[0] not in self.NonLetterOpLst:
584 return ''
585
586 OpToken = ''
587 for Ch in Expr:
588 if Ch in self.NonLetterOpLst:
589 if '!' == Ch and OpToken:
590 break
591 self._Idx += 1
592 OpToken += Ch
593 else:
594 break
595
596 if OpToken not in LegalOpLst:
597 raise BadExpression(ERR_OPERATOR_UNSUPPORT % OpToken)
598 self._Token = OpToken
599 return OpToken
600
601 # Check if current token matches the operators given from OpList
602 def _IsOperator(self, OpList):
603 Idx = self._Idx
604 self._GetOperator()
605 if self._Token in OpList:
606 if self._Token in self.LogicalOperators:
607 self._Token = self.LogicalOperators[self._Token]
608 return True
609 self._Idx = Idx
610 return False
611
612 if __name__ == '__main__':
613 pass
614 while True:
615 input = raw_input('Input expr: ')
616 if input in 'qQ':
617 break
618 try:
619 print ValueExpression(input)(True)
620 print ValueExpression(input)(False)
621 except WrnExpression, Ex:
622 print Ex.result
623 print str(Ex)
624 except Exception, Ex:
625 print str(Ex)