]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/Common/Expression.py
BaseTools: Use absolute import in Common
[mirror_edk2.git] / BaseTools / Source / Python / Common / Expression.py
index 99b01012a0cb1c18c826cb86a432f72dfedef2c8..ccc736846afa94cd70dbfd0237acd7e3b6e35d91 100644 (file)
 \r
 ## Import Modules\r
 #\r
+from __future__ import print_function\r
+from __future__ import absolute_import\r
 from Common.GlobalData import *\r
 from CommonDataClass.Exceptions import BadExpression\r
 from CommonDataClass.Exceptions import WrnExpression\r
-from Misc import GuidStringToGuidStructureString, ParseFieldValue, IsFieldValueAnArray\r
+from .Misc import GuidStringToGuidStructureString, ParseFieldValue, IsFieldValueAnArray\r
 import Common.EdkLogger as EdkLogger\r
 import copy\r
 from Common.DataType import *\r
+import sys\r
 \r
 ERR_STRING_EXPR         = 'This operator cannot be used in string expression: [%s].'\r
 ERR_SNYTAX              = 'Syntax error, the rest of expression cannot be evaluated: [%s].'\r
@@ -171,7 +174,7 @@ def ReplaceExprMacro(String, Macros, ExceptionList = None):
                 RetStr += '0'\r
             elif not InQuote:\r
                 Tklst = RetStr.split()\r
-                if Tklst and Tklst[-1] in ['IN', 'in'] and ExceptionList and Macro not in ExceptionList:\r
+                if Tklst and Tklst[-1] in {'IN', 'in'} and ExceptionList and Macro not in ExceptionList:\r
                     raise BadExpression(ERR_IN_OPERAND)\r
                 # Make sure the macro in exception list is encapsulated by double quote\r
                 # For example: DEFINE ARCH = IA32 X64\r
@@ -201,7 +204,22 @@ def IntToStr(Value):
 \r
 SupportedInMacroList = ['TARGET', 'TOOL_CHAIN_TAG', 'ARCH', 'FAMILY']\r
 \r
-class ValueExpression(object):\r
+class BaseExpression(object):\r
+    def __init__(self, *args, **kwargs):\r
+        super(BaseExpression, self).__init__()\r
+\r
+    # Check if current token matches the operators given from parameter\r
+    def _IsOperator(self, OpSet):\r
+        Idx = self._Idx\r
+        self._GetOperator()\r
+        if self._Token in OpSet:\r
+            if self._Token in self.LogicalOperators:\r
+                self._Token = self.LogicalOperators[self._Token]\r
+            return True\r
+        self._Idx = Idx\r
+        return False\r
+\r
+class ValueExpression(BaseExpression):\r
     # Logical operator mapping\r
     LogicalOperators = {\r
         '&&' : 'and', '||' : 'or',\r
@@ -228,35 +246,36 @@ class ValueExpression(object):
     def Eval(Operator, Oprand1, Oprand2 = None):\r
         WrnExp = None\r
 \r
-        if Operator not in ["==", "!=", ">=", "<=", ">", "<", "in", "not in"] and \\r
-            (type(Oprand1) == type('') or type(Oprand2) == type('')):\r
+        if Operator not in {"==", "!=", ">=", "<=", ">", "<", "in", "not in"} and \\r
+            (isinstance(Oprand1, type('')) or isinstance(Oprand2, type(''))):\r
             raise BadExpression(ERR_STRING_EXPR % Operator)\r
-        if Operator in ['in', 'not in']:\r
-            if type(Oprand1) != type(''):\r
+        if Operator in {'in', 'not in'}:\r
+            if not isinstance(Oprand1, type('')):\r
                 Oprand1 = IntToStr(Oprand1)\r
-            if type(Oprand2) != type(''):\r
+            if not isinstance(Oprand2, type('')):\r
                 Oprand2 = IntToStr(Oprand2)\r
         TypeDict = {\r
             type(0)  : 0,\r
-            type(0L) : 0,\r
+            # For python2 long type\r
+            type(sys.maxsize + 1) : 0,\r
             type('') : 1,\r
             type(True) : 2\r
         }\r
 \r
         EvalStr = ''\r
-        if Operator in ["!", "NOT", "not"]:\r
-            if type(Oprand1) == type(''):\r
+        if Operator in {"!", "NOT", "not"}:\r
+            if isinstance(Oprand1, type('')):\r
                 raise BadExpression(ERR_STRING_EXPR % Operator)\r
             EvalStr = 'not Oprand1'\r
-        elif Operator in ["~"]:\r
-            if type(Oprand1) == type(''):\r
+        elif Operator in {"~"}:\r
+            if isinstance(Oprand1, type('')):\r
                 raise BadExpression(ERR_STRING_EXPR % Operator)\r
             EvalStr = '~ Oprand1'\r
         else:\r
-            if Operator in ["+", "-"] and (type(True) in [type(Oprand1), type(Oprand2)]):\r
+            if Operator in {"+", "-"} and (type(True) in {type(Oprand1), type(Oprand2)}):\r
                 # Boolean in '+'/'-' will be evaluated but raise warning\r
                 WrnExp = WrnExpression(WRN_BOOL_EXPR)\r
-            elif type('') in [type(Oprand1), type(Oprand2)] and type(Oprand1)!= type(Oprand2):\r
+            elif type('') in {type(Oprand1), type(Oprand2)} and not isinstance(Oprand1, type(Oprand2)):\r
                 # == between string and number/boolean will always return False, != return True\r
                 if Operator == "==":\r
                     WrnExp = WrnExpression(WRN_EQCMP_STR_OTHERS)\r
@@ -269,19 +288,19 @@ class ValueExpression(object):
                 else:\r
                     raise BadExpression(ERR_RELCMP_STR_OTHERS % Operator)\r
             elif TypeDict[type(Oprand1)] != TypeDict[type(Oprand2)]:\r
-                if Operator in ["==", "!=", ">=", "<=", ">", "<"] and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):\r
+                if Operator in {"==", "!=", ">=", "<=", ">", "<"} and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):\r
                     # comparison between number and boolean is allowed\r
                     pass\r
-                elif Operator in ['&', '|', '^', "and", "or"] and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):\r
+                elif Operator in {'&', '|', '^', "and", "or"} and set((TypeDict[type(Oprand1)], TypeDict[type(Oprand2)])) == set((TypeDict[type(True)], TypeDict[type(0)])):\r
                     # bitwise and logical operation between number and boolean is allowed\r
                     pass\r
                 else:\r
                     raise BadExpression(ERR_EXPR_TYPE)\r
-            if type(Oprand1) == type('') and type(Oprand2) == type(''):\r
+            if isinstance(Oprand1, type('')) and isinstance(Oprand2, type('')):\r
                 if (Oprand1.startswith('L"') and not Oprand2.startswith('L"')) or \\r
                     (not Oprand1.startswith('L"') and Oprand2.startswith('L"')):\r
                     raise BadExpression(ERR_STRING_CMP % (Oprand1, Operator, Oprand2))\r
-            if 'in' in Operator and type(Oprand2) == type(''):\r
+            if 'in' in Operator and isinstance(Oprand2, type('')):\r
                 Oprand2 = Oprand2.split()\r
             EvalStr = 'Oprand1 ' + Operator + ' Oprand2'\r
 \r
@@ -292,10 +311,10 @@ class ValueExpression(object):
         }\r
         try:\r
             Val = eval(EvalStr, {}, Dict)\r
-        except Exception, Excpt:\r
+        except Exception as Excpt:\r
             raise BadExpression(str(Excpt))\r
 \r
-        if Operator in ['and', 'or']:\r
+        if Operator in {'and', 'or'}:\r
             if Val:\r
                 Val = True\r
             else:\r
@@ -307,8 +326,9 @@ class ValueExpression(object):
         return Val\r
 \r
     def __init__(self, Expression, SymbolTable={}):\r
+        super(ValueExpression, self).__init__(self, Expression, SymbolTable)\r
         self._NoProcess = False\r
-        if type(Expression) != type(''):\r
+        if not isinstance(Expression, type('')):\r
             self._Expr = Expression\r
             self._NoProcess = True\r
             return\r
@@ -356,7 +376,7 @@ class ValueExpression(object):
                 Token = self._GetToken()\r
             except BadExpression:\r
                 pass\r
-            if type(Token) == type('') and Token.startswith('{') and Token.endswith('}') and self._Idx >= self._Len:\r
+            if isinstance(Token, type('')) and Token.startswith('{') and Token.endswith('}') and self._Idx >= self._Len:\r
                 return self._Expr\r
 \r
             self._Idx = 0\r
@@ -364,7 +384,7 @@ class ValueExpression(object):
 \r
         Val = self._ConExpr()\r
         RealVal = Val\r
-        if type(Val) == type(''):\r
+        if isinstance(Val, type('')):\r
             if Val == 'L""':\r
                 Val = False\r
             elif not Val:\r
@@ -394,13 +414,13 @@ class ValueExpression(object):
 \r
     # Template function to parse binary operators which have same precedence\r
     # Expr [Operator Expr]*\r
-    def _ExprFuncTemplate(self, EvalFunc, OpLst):\r
+    def _ExprFuncTemplate(self, EvalFunc, OpSet):\r
         Val = EvalFunc()\r
-        while self._IsOperator(OpLst):\r
+        while self._IsOperator(OpSet):\r
             Op = self._Token\r
             if Op == '?':\r
                 Val2 = EvalFunc()\r
-                if self._IsOperator(':'):\r
+                if self._IsOperator({':'}):\r
                     Val3 = EvalFunc()\r
                 if Val:\r
                     Val = Val2\r
@@ -409,79 +429,79 @@ class ValueExpression(object):
                 continue\r
             try:\r
                 Val = self.Eval(Op, Val, EvalFunc())\r
-            except WrnExpression, Warn:\r
+            except WrnExpression as Warn:\r
                 self._WarnExcept = Warn\r
                 Val = Warn.result\r
         return Val\r
     # A [? B]*\r
     def _ConExpr(self):\r
-        return self._ExprFuncTemplate(self._OrExpr, ['?', ':'])\r
+        return self._ExprFuncTemplate(self._OrExpr, {'?', ':'})\r
 \r
     # A [|| B]*\r
     def _OrExpr(self):\r
-        return self._ExprFuncTemplate(self._AndExpr, ["OR", "or", "||"])\r
+        return self._ExprFuncTemplate(self._AndExpr, {"OR", "or", "||"})\r
 \r
     # A [&& B]*\r
     def _AndExpr(self):\r
-        return self._ExprFuncTemplate(self._BitOr, ["AND", "and", "&&"])\r
+        return self._ExprFuncTemplate(self._BitOr, {"AND", "and", "&&"})\r
 \r
     # A [ | B]*\r
     def _BitOr(self):\r
-        return self._ExprFuncTemplate(self._BitXor, ["|"])\r
+        return self._ExprFuncTemplate(self._BitXor, {"|"})\r
 \r
     # A [ ^ B]*\r
     def _BitXor(self):\r
-        return self._ExprFuncTemplate(self._BitAnd, ["XOR", "xor", "^"])\r
+        return self._ExprFuncTemplate(self._BitAnd, {"XOR", "xor", "^"})\r
 \r
     # A [ & B]*\r
     def _BitAnd(self):\r
-        return self._ExprFuncTemplate(self._EqExpr, ["&"])\r
+        return self._ExprFuncTemplate(self._EqExpr, {"&"})\r
 \r
     # A [ == B]*\r
     def _EqExpr(self):\r
         Val = self._RelExpr()\r
-        while self._IsOperator(["==", "!=", "EQ", "NE", "IN", "in", "!", "NOT", "not"]):\r
+        while self._IsOperator({"==", "!=", "EQ", "NE", "IN", "in", "!", "NOT", "not"}):\r
             Op = self._Token\r
-            if Op in ["!", "NOT", "not"]:\r
-                if not self._IsOperator(["IN", "in"]):\r
+            if Op in {"!", "NOT", "not"}:\r
+                if not self._IsOperator({"IN", "in"}):\r
                     raise BadExpression(ERR_REL_NOT_IN)\r
                 Op += ' ' + self._Token\r
             try:\r
                 Val = self.Eval(Op, Val, self._RelExpr())\r
-            except WrnExpression, Warn:\r
+            except WrnExpression as Warn:\r
                 self._WarnExcept = Warn\r
                 Val = Warn.result\r
         return Val\r
 \r
     # A [ > B]*\r
     def _RelExpr(self):\r
-        return self._ExprFuncTemplate(self._ShiftExpr, ["<=", ">=", "<", ">", "LE", "GE", "LT", "GT"])\r
+        return self._ExprFuncTemplate(self._ShiftExpr, {"<=", ">=", "<", ">", "LE", "GE", "LT", "GT"})\r
 \r
     def _ShiftExpr(self):\r
-        return self._ExprFuncTemplate(self._AddExpr, ["<<", ">>"])\r
+        return self._ExprFuncTemplate(self._AddExpr, {"<<", ">>"})\r
 \r
     # A [ + B]*\r
     def _AddExpr(self):\r
-        return self._ExprFuncTemplate(self._MulExpr, ["+", "-"])\r
+        return self._ExprFuncTemplate(self._MulExpr, {"+", "-"})\r
 \r
     # A [ * B]*\r
     def _MulExpr(self):\r
-        return self._ExprFuncTemplate(self._UnaryExpr, ["*", "/", "%"])\r
+        return self._ExprFuncTemplate(self._UnaryExpr, {"*", "/", "%"})\r
 \r
     # [!]*A\r
     def _UnaryExpr(self):\r
-        if self._IsOperator(["!", "NOT", "not"]):\r
+        if self._IsOperator({"!", "NOT", "not"}):\r
             Val = self._UnaryExpr()\r
             try:\r
                 return self.Eval('not', Val)\r
-            except WrnExpression, Warn:\r
+            except WrnExpression as Warn:\r
                 self._WarnExcept = Warn\r
                 return Warn.result\r
-        if self._IsOperator(["~"]):\r
+        if self._IsOperator({"~"}):\r
             Val = self._UnaryExpr()\r
             try:\r
                 return self.Eval('~', Val)\r
-            except WrnExpression, Warn:\r
+            except WrnExpression as Warn:\r
                 self._WarnExcept = Warn\r
                 return Warn.result\r
         return self._IdenExpr()\r
@@ -515,7 +535,7 @@ class ValueExpression(object):
         if self._Token.startswith('"') or self._Token.startswith('L"'):\r
             Flag = 0\r
             for Index in range(len(self._Token)):\r
-                if self._Token[Index] in ['"']:\r
+                if self._Token[Index] in {'"'}:\r
                     if self._Token[Index - 1] == '\\':\r
                         continue\r
                     Flag += 1\r
@@ -524,7 +544,7 @@ class ValueExpression(object):
         if self._Token.startswith("'") or self._Token.startswith("L'"):\r
             Flag = 0\r
             for Index in range(len(self._Token)):\r
-                if self._Token[Index] in ["'"]:\r
+                if self._Token[Index] in {"'"}:\r
                     if self._Token[Index - 1] == '\\':\r
                         continue\r
                     Flag += 1\r
@@ -552,7 +572,7 @@ class ValueExpression(object):
         IsArray = IsGuid = False\r
         if len(Token.split(',')) == 11 and len(Token.split(',{')) == 2 \\r
             and len(Token.split('},')) == 1:\r
-            HexLen = [11,6,6,5,4,4,4,4,4,4,6]\r
+            HexLen = [11, 6, 6, 5, 4, 4, 4, 4, 4, 4, 6]\r
             HexList= Token.split(',')\r
             if HexList[3].startswith('{') and \\r
                 not [Index for Index, Hex in enumerate(HexList) if len(Hex) > HexLen[Index]]:\r
@@ -623,15 +643,15 @@ class ValueExpression(object):
                 Ex.Pcd = self._Token\r
                 raise Ex\r
             self._Token = ValueExpression(self._Symb[self._Token], self._Symb)(True, self._Depth+1)\r
-            if type(self._Token) != type(''):\r
+            if not isinstance(self._Token, type('')):\r
                 self._LiteralToken = hex(self._Token)\r
                 return\r
 \r
         if self._Token.startswith('"'):\r
             self._Token = self._Token[1:-1]\r
-        elif self._Token in ["FALSE", "false", "False"]:\r
+        elif self._Token in {"FALSE", "false", "False"}:\r
             self._Token = False\r
-        elif self._Token in ["TRUE", "true", "True"]:\r
+        elif self._Token in {"TRUE", "true", "True"}:\r
             self._Token = True\r
         else:\r
             self.__IsNumberToken()\r
@@ -718,7 +738,7 @@ class ValueExpression(object):
                 if Ch == ')':\r
                     TmpValue = self._Expr[Idx :self._Idx - 1]\r
                     TmpValue = ValueExpression(TmpValue)(True)\r
-                    TmpValue = '0x%x' % int(TmpValue) if type(TmpValue) != type('') else TmpValue\r
+                    TmpValue = '0x%x' % int(TmpValue) if not isinstance(TmpValue, type('')) else TmpValue\r
                     break\r
             self._Token, Size = ParseFieldValue(Prefix + '(' + TmpValue + ')')\r
             return  self._Token\r
@@ -748,7 +768,7 @@ class ValueExpression(object):
     # Parse operator\r
     def _GetOperator(self):\r
         self.__SkipWS()\r
-        LegalOpLst = ['&&', '||', '!=', '==', '>=', '<='] + self.NonLetterOpLst + ['?',':']\r
+        LegalOpLst = ['&&', '||', '!=', '==', '>=', '<='] + self.NonLetterOpLst + ['?', ':']\r
 \r
         self._Token = ''\r
         Expr = self._Expr[self._Idx:]\r
@@ -780,17 +800,6 @@ class ValueExpression(object):
         self._Token = OpToken\r
         return OpToken\r
 \r
-    # Check if current token matches the operators given from OpList\r
-    def _IsOperator(self, OpList):\r
-        Idx = self._Idx\r
-        self._GetOperator()\r
-        if self._Token in OpList:\r
-            if self._Token in self.LogicalOperators:\r
-                self._Token = self.LogicalOperators[self._Token]\r
-            return True\r
-        self._Idx = Idx\r
-        return False\r
-\r
 class ValueExpressionEx(ValueExpression):\r
     def __init__(self, PcdValue, PcdType, SymbolTable={}):\r
         ValueExpression.__init__(self, PcdValue, SymbolTable)\r
@@ -811,14 +820,14 @@ class ValueExpressionEx(ValueExpression):
             elif self.PcdType in TAB_PCD_NUMERIC_TYPES and (PcdValue.startswith("'") or \\r
                       PcdValue.startswith('"') or PcdValue.startswith("L'") or PcdValue.startswith('L"') or PcdValue.startswith('{')):\r
                 raise BadExpression\r
-        except WrnExpression, Value:\r
+        except WrnExpression as Value:\r
             PcdValue = Value.result\r
-        except BadExpression, Value:\r
+        except BadExpression as Value:\r
             if self.PcdType in TAB_PCD_NUMERIC_TYPES:\r
                 PcdValue = PcdValue.strip()\r
-                if type(PcdValue) == type('') and PcdValue.startswith('{') and PcdValue.endswith('}'):\r
+                if PcdValue.startswith('{') and PcdValue.endswith('}'):\r
                     PcdValue = SplitPcdValueString(PcdValue[1:-1])\r
-                if type(PcdValue) == type([]):\r
+                if isinstance(PcdValue, type([])):\r
                     TmpValue = 0\r
                     Size = 0\r
                     ValueType = ''\r
@@ -836,7 +845,7 @@ class ValueExpressionEx(ValueExpression):
                         elif Item.startswith(TAB_UINT64):\r
                             ItemSize = 8\r
                             ValueType = TAB_UINT64\r
-                        elif Item[0] in ['"',"'",'L']:\r
+                        elif Item[0] in {'"', "'", 'L'}:\r
                             ItemSize = 0\r
                             ValueType = TAB_VOID\r
                         else:\r
@@ -849,7 +858,7 @@ class ValueExpressionEx(ValueExpression):
                                 tmpValue = int(Item, 0)\r
                                 if tmpValue > 255:\r
                                     raise BadExpression("Byte  array number %s should less than 0xFF." % Item)\r
-                            except BadExpression, Value:\r
+                            except BadExpression as Value:\r
                                 raise BadExpression(Value)\r
                             except ValueError:\r
                                 pass\r
@@ -857,7 +866,7 @@ class ValueExpressionEx(ValueExpression):
                         else:\r
                             ItemValue = ParseFieldValue(Item)[0]\r
 \r
-                        if type(ItemValue) == type(''):\r
+                        if isinstance(ItemValue, type('')):\r
                             ItemValue = int(ItemValue, 0)\r
 \r
                         TmpValue = (ItemValue << (Size * 8)) | TmpValue\r
@@ -865,9 +874,9 @@ class ValueExpressionEx(ValueExpression):
                 else:\r
                     try:\r
                         TmpValue, Size = ParseFieldValue(PcdValue)\r
-                    except BadExpression, Value:\r
+                    except BadExpression as Value:\r
                         raise BadExpression("Type: %s, Value: %s, %s" % (self.PcdType, PcdValue, Value))\r
-                if type(TmpValue) == type(''):\r
+                if isinstance(TmpValue, type('')):\r
                     try:\r
                         TmpValue = int(TmpValue)\r
                     except:\r
@@ -886,7 +895,7 @@ class ValueExpressionEx(ValueExpression):
                     raise BadExpression('Type %s PCD Value Size is Larger than 8 byte' % self.PcdType)\r
             else:\r
                 try:\r
-                    TmpValue = long(PcdValue)\r
+                    TmpValue = int(PcdValue)\r
                     TmpList = []\r
                     if TmpValue.bit_length() == 0:\r
                         PcdValue = '{0x00}'\r
@@ -940,7 +949,7 @@ class ValueExpressionEx(ValueExpression):
                             # replace each offset, except errors\r
                             for Offset in OffsetList:\r
                                 try:\r
-                                    Item = Item.replace('OFFSET_OF({})'.format(Offset),LabelDict[Offset])\r
+                                    Item = Item.replace('OFFSET_OF({})'.format(Offset), LabelDict[Offset])\r
                                 except:\r
                                     raise BadExpression('%s not defined' % Offset)\r
 \r
@@ -951,7 +960,7 @@ class ValueExpressionEx(ValueExpression):
                             Size = 0\r
                             ValueStr = ''\r
                             TokenSpaceGuidName = ''\r
-                            if Item.startswith('GUID') and Item.endswith(')'):\r
+                            if Item.startswith(TAB_GUID) and Item.endswith(')'):\r
                                 try:\r
                                     TokenSpaceGuidName = re.search('GUID\((\w+)\)', Item).group(1)\r
                                 except:\r
@@ -990,10 +999,10 @@ class ValueExpressionEx(ValueExpression):
                                     TmpValue = ValueExpressionEx(Item, ValueType, self._Symb)(True)\r
                                 else:\r
                                     TmpValue = ValueExpressionEx(Item, self.PcdType, self._Symb)(True)\r
-                                Item = '0x%x' % TmpValue if type(TmpValue) != type('') else TmpValue\r
+                                Item = '0x%x' % TmpValue if not isinstance(TmpValue, type('')) else TmpValue\r
                                 if ItemSize == 0:\r
                                     ItemValue, ItemSize = ParseFieldValue(Item)\r
-                                    if Item[0] not in ['"','L','{'] and ItemSize > 1:\r
+                                    if Item[0] not in {'"', 'L', '{'} and ItemSize > 1:\r
                                         raise BadExpression("Byte  array number %s should less than 0xFF." % Item)\r
                                 else:\r
                                     ItemValue = ParseFieldValue(Item)[0]\r
@@ -1023,10 +1032,10 @@ if __name__ == '__main__':
         if input in 'qQ':\r
             break\r
         try:\r
-            print ValueExpression(input)(True)\r
-            print ValueExpression(input)(False)\r
-        except WrnExpression, Ex:\r
-            print Ex.result\r
-            print str(Ex)\r
-        except Exception, Ex:\r
-            print str(Ex)\r
+            print(ValueExpression(input)(True))\r
+            print(ValueExpression(input)(False))\r
+        except WrnExpression as Ex:\r
+            print(Ex.result)\r
+            print(str(Ex))\r
+        except Exception as Ex:\r
+            print(str(Ex))\r