]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/Common/Expression.py
BaseTools: replace 'UINT8','UINT16','UINT32','UINT64','VOID*' with shared constants.
[mirror_edk2.git] / BaseTools / Source / Python / Common / Expression.py
index e76f09c367c19a102d06a6ee94d4061a4e33fcc3..99b01012a0cb1c18c826cb86a432f72dfedef2c8 100644 (file)
@@ -18,6 +18,7 @@ from CommonDataClass.Exceptions import WrnExpression
 from Misc import GuidStringToGuidStructureString, ParseFieldValue, IsFieldValueAnArray\r
 import Common.EdkLogger as EdkLogger\r
 import copy\r
+from Common.DataType import *\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
@@ -40,20 +41,24 @@ ERR_ARRAY_ELE           = 'This must be HEX value for NList or Array: [%s].'
 ERR_EMPTY_EXPR          = 'Empty expression is not allowed.'\r
 ERR_IN_OPERAND          = 'Macro after IN operator can only be: $(FAMILY), $(ARCH), $(TOOL_CHAIN_TAG) and $(TARGET).'\r
 \r
+__ValidString = re.compile(r'[_a-zA-Z][_0-9a-zA-Z]*$')\r
+_ReLabel = re.compile('LABEL\((\w+)\)')\r
+_ReOffset = re.compile('OFFSET_OF\((\w+)\)')\r
+PcdPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_]*\.[_a-zA-Z][0-9A-Za-z_]*$')\r
+\r
 ## SplitString\r
 #  Split string to list according double quote\r
 #  For example: abc"de\"f"ghi"jkl"mn will be: ['abc', '"de\"f"', 'ghi', '"jkl"', 'mn']\r
 #\r
 def SplitString(String):\r
     # There might be escaped quote: "abc\"def\\\"ghi", 'abc\'def\\\'ghi'\r
-    Str = String\r
     RetList = []\r
     InSingleQuote = False\r
     InDoubleQuote = False\r
     Item = ''\r
-    for i, ch in enumerate(Str):\r
+    for i, ch in enumerate(String):\r
         if ch == '"' and not InSingleQuote:\r
-            if Str[i - 1] != '\\':\r
+            if String[i - 1] != '\\':\r
                 InDoubleQuote = not InDoubleQuote\r
             if not InDoubleQuote:\r
                 Item += String[i]\r
@@ -64,7 +69,7 @@ def SplitString(String):
                 RetList.append(Item)\r
                 Item = ''\r
         elif ch == "'" and not InDoubleQuote:\r
-            if Str[i - 1] != '\\':\r
+            if String[i - 1] != '\\':\r
                 InSingleQuote = not InSingleQuote\r
             if not InSingleQuote:\r
                 Item += String[i]\r
@@ -84,27 +89,26 @@ def SplitString(String):
 def SplitPcdValueString(String):\r
     # There might be escaped comma in GUID() or DEVICE_PATH() or " "\r
     # or ' ' or L' ' or L" "\r
-    Str = String\r
     RetList = []\r
     InParenthesis = 0\r
     InSingleQuote = False\r
     InDoubleQuote = False\r
     Item = ''\r
-    for i, ch in enumerate(Str):\r
+    for i, ch in enumerate(String):\r
         if ch == '(':\r
             InParenthesis += 1\r
-        if ch == ')':\r
+        elif ch == ')':\r
             if InParenthesis:\r
                 InParenthesis -= 1\r
             else:\r
                 raise BadExpression(ERR_STRING_TOKEN % Item)\r
-        if ch == '"' and not InSingleQuote:\r
+        elif ch == '"' and not InSingleQuote:\r
             if String[i-1] != '\\':\r
                 InDoubleQuote = not InDoubleQuote\r
-        if ch == "'" and not InDoubleQuote:\r
+        elif ch == "'" and not InDoubleQuote:\r
             if String[i-1] != '\\':\r
                 InSingleQuote = not InSingleQuote\r
-        if ch == ',':\r
+        elif ch == ',':\r
             if InParenthesis or InSingleQuote or InDoubleQuote:\r
                 Item += String[i]\r
                 continue\r
@@ -119,14 +123,10 @@ def SplitPcdValueString(String):
         RetList.append(Item)\r
     return RetList\r
 \r
-def IsValidCString(Str):\r
-    ValidString = re.compile(r'[_a-zA-Z][_0-9a-zA-Z]*$')\r
-    if not ValidString.match(Str):\r
-        return False\r
-    return True\r
+def IsValidCName(Str):\r
+    return True if __ValidString.match(Str) else False\r
 \r
 def BuildOptionValue(PcdValue, GuidDict):\r
-    IsArray = False\r
     if PcdValue.startswith('H'):\r
         InputValue = PcdValue[1:]\r
     elif PcdValue.startswith("L'") or PcdValue.startswith("'"):\r
@@ -136,10 +136,8 @@ def BuildOptionValue(PcdValue, GuidDict):
     else:\r
         InputValue = PcdValue\r
     if IsFieldValueAnArray(InputValue):\r
-        IsArray = True\r
-    if IsArray:\r
         try:\r
-            PcdValue = ValueExpressionEx(InputValue, 'VOID*', GuidDict)(True)\r
+            PcdValue = ValueExpressionEx(InputValue, TAB_VOID, GuidDict)(True)\r
         except:\r
             pass\r
     return PcdValue\r
@@ -154,7 +152,7 @@ def ReplaceExprMacro(String, Macros, ExceptionList = None):
             InQuote = True\r
         MacroStartPos = String.find('$(')\r
         if MacroStartPos < 0:\r
-            for Pcd in gPlatformPcds.keys():\r
+            for Pcd in gPlatformPcds:\r
                 if Pcd in String:\r
                     if Pcd not in gConditionalPcds:\r
                         gConditionalPcds.append(Pcd)\r
@@ -218,9 +216,6 @@ class ValueExpression(object):
 \r
     NonLetterOpLst = ['+', '-', '*', '/', '%', '&', '|', '^', '~', '<<', '>>', '!', '=', '>', '<', '?', ':']\r
 \r
-    PcdPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_]*\.[_a-zA-Z][0-9A-Za-z_]*$')\r
-    HexPattern = re.compile(r'0[xX][0-9a-fA-F]+$')\r
-    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}')\r
 \r
     SymbolPattern = re.compile("("\r
                                  "\$\([A-Z][A-Z0-9_]*\)|\$\(\w+\.\w+\)|\w+\.\w+|"\r
@@ -622,7 +617,7 @@ class ValueExpression(object):
             raise BadExpression(ERR_EMPTY_TOKEN)\r
 \r
         # PCD token\r
-        if self.PcdPattern.match(self._Token):\r
+        if PcdPattern.match(self._Token):\r
             if self._Token not in self._Symb:\r
                 Ex = BadExpression(ERR_PCD_RESOLVE % self._Token)\r
                 Ex.Pcd = self._Token\r
@@ -672,7 +667,7 @@ class ValueExpression(object):
             self._LiteralToken.endswith('}'):\r
             return True\r
 \r
-        if self.HexPattern.match(self._LiteralToken):\r
+        if gHexPattern.match(self._LiteralToken):\r
             Token = self._LiteralToken[2:]\r
             if not Token:\r
                 self._LiteralToken = '0x0'\r
@@ -731,7 +726,7 @@ class ValueExpression(object):
         self._Token = ''\r
         if Expr:\r
             Ch = Expr[0]\r
-            Match = self.RegGuidPattern.match(Expr)\r
+            Match = gGuidPattern.match(Expr)\r
             if Match and not Expr[Match.end():Match.end()+1].isalnum() \\r
                 and Expr[Match.end():Match.end()+1] != '_':\r
                 self._Idx += Match.end()\r
@@ -806,20 +801,20 @@ class ValueExpressionEx(ValueExpression):
         PcdValue = self.PcdValue\r
         try:\r
             PcdValue = ValueExpression.__call__(self, RealValue, Depth)\r
-            if self.PcdType == 'VOID*' and (PcdValue.startswith("'") or PcdValue.startswith("L'")):\r
+            if self.PcdType == TAB_VOID and (PcdValue.startswith("'") or PcdValue.startswith("L'")):\r
                 PcdValue, Size = ParseFieldValue(PcdValue)\r
                 PcdValueList = []\r
                 for I in range(Size):\r
                     PcdValueList.append('0x%02X'%(PcdValue & 0xff))\r
                     PcdValue = PcdValue >> 8\r
                 PcdValue = '{' + ','.join(PcdValueList) + '}'\r
-            elif self.PcdType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN'] and (PcdValue.startswith("'") or \\r
+            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
             PcdValue = Value.result\r
         except BadExpression, Value:\r
-            if self.PcdType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:\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
                     PcdValue = SplitPcdValueString(PcdValue[1:-1])\r
@@ -829,29 +824,29 @@ class ValueExpressionEx(ValueExpression):
                     ValueType = ''\r
                     for Item in PcdValue:\r
                         Item = Item.strip()\r
-                        if Item.startswith('UINT8'):\r
+                        if Item.startswith(TAB_UINT8):\r
                             ItemSize = 1\r
-                            ValueType = 'UINT8'\r
-                        elif Item.startswith('UINT16'):\r
+                            ValueType = TAB_UINT8\r
+                        elif Item.startswith(TAB_UINT16):\r
                             ItemSize = 2\r
-                            ValueType = 'UINT16'\r
-                        elif Item.startswith('UINT32'):\r
+                            ValueType = TAB_UINT16\r
+                        elif Item.startswith(TAB_UINT32):\r
                             ItemSize = 4\r
-                            ValueType = 'UINT32'\r
-                        elif Item.startswith('UINT64'):\r
+                            ValueType = TAB_UINT32\r
+                        elif Item.startswith(TAB_UINT64):\r
                             ItemSize = 8\r
-                            ValueType = 'UINT64'\r
-                        elif Item.startswith('"') or Item.startswith("'") or Item.startswith('L'):\r
+                            ValueType = TAB_UINT64\r
+                        elif Item[0] in ['"',"'",'L']:\r
                             ItemSize = 0\r
-                            ValueType = 'VOID*'\r
+                            ValueType = TAB_VOID\r
                         else:\r
                             ItemSize = 0\r
-                            ValueType = 'UINT8'\r
+                            ValueType = TAB_UINT8\r
                         Item = ValueExpressionEx(Item, ValueType, self._Symb)(True)\r
 \r
                         if ItemSize == 0:\r
                             try:\r
-                                tmpValue = int(Item, 16) if Item.upper().startswith('0X') else int(Item, 0)\r
+                                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
@@ -863,7 +858,7 @@ class ValueExpressionEx(ValueExpression):
                             ItemValue = ParseFieldValue(Item)[0]\r
 \r
                         if type(ItemValue) == type(''):\r
-                            ItemValue = int(ItemValue, 16) if ItemValue.startswith('0x') else int(ItemValue)\r
+                            ItemValue = int(ItemValue, 0)\r
 \r
                         TmpValue = (ItemValue << (Size * 8)) | TmpValue\r
                         Size = Size + ItemSize\r
@@ -881,13 +876,13 @@ class ValueExpressionEx(ValueExpression):
                     PcdValue = '0x%0{}X'.format(Size) % (TmpValue)\r
                 if TmpValue < 0:\r
                     raise  BadExpression('Type %s PCD Value is negative' % self.PcdType)\r
-                if self.PcdType == 'UINT8' and Size > 1:\r
+                if self.PcdType == TAB_UINT8 and Size > 1:\r
                     raise BadExpression('Type %s PCD Value Size is Larger than 1 byte' % self.PcdType)\r
-                if self.PcdType == 'UINT16' and Size > 2:\r
+                if self.PcdType == TAB_UINT16 and Size > 2:\r
                     raise BadExpression('Type %s PCD Value Size is Larger than 2 byte' % self.PcdType)\r
-                if self.PcdType == 'UINT32' and Size > 4:\r
+                if self.PcdType == TAB_UINT32 and Size > 4:\r
                     raise BadExpression('Type %s PCD Value Size is Larger than 4 byte' % self.PcdType)\r
-                if self.PcdType == 'UINT64' and Size > 8:\r
+                if self.PcdType == TAB_UINT64 and Size > 8:\r
                     raise BadExpression('Type %s PCD Value Size is Larger than 8 byte' % self.PcdType)\r
             else:\r
                 try:\r
@@ -904,27 +899,25 @@ class ValueExpressionEx(ValueExpression):
                         PcdValueList = SplitPcdValueString(PcdValue.strip()[1:-1])\r
                         LabelDict = {}\r
                         NewPcdValueList = []\r
-                        ReLabel = re.compile('LABEL\((\w+)\)')\r
-                        ReOffset = re.compile('OFFSET_OF\((\w+)\)')\r
                         LabelOffset = 0\r
-                        for Index, Item in enumerate(PcdValueList):\r
+                        for Item in PcdValueList:\r
                             # compute byte offset of every LABEL\r
-                            LabelList = ReLabel.findall(Item)\r
-                            Item = ReLabel.sub('', Item)\r
+                            LabelList = _ReLabel.findall(Item)\r
+                            Item = _ReLabel.sub('', Item)\r
                             Item = Item.strip()\r
                             if LabelList:\r
                                 for Label in LabelList:\r
-                                    if not IsValidCString(Label):\r
+                                    if not IsValidCName(Label):\r
                                         raise BadExpression('%s is not a valid c variable name' % Label)\r
-                                    if Label not in LabelDict.keys():\r
+                                    if Label not in LabelDict:\r
                                         LabelDict[Label] = str(LabelOffset)\r
-                            if Item.startswith('UINT8'):\r
+                            if Item.startswith(TAB_UINT8):\r
                                 LabelOffset = LabelOffset + 1\r
-                            elif Item.startswith('UINT16'):\r
+                            elif Item.startswith(TAB_UINT16):\r
                                 LabelOffset = LabelOffset + 2\r
-                            elif Item.startswith('UINT32'):\r
+                            elif Item.startswith(TAB_UINT32):\r
                                 LabelOffset = LabelOffset + 4\r
-                            elif Item.startswith('UINT64'):\r
+                            elif Item.startswith(TAB_UINT64):\r
                                 LabelOffset = LabelOffset + 8\r
                             else:\r
                                 try:\r
@@ -933,23 +926,24 @@ class ValueExpressionEx(ValueExpression):
                                 except:\r
                                     LabelOffset = LabelOffset + 1\r
 \r
-                        for Index, Item in enumerate(PcdValueList):\r
+                        for Item in PcdValueList:\r
                             # for LABEL parse\r
                             Item = Item.strip()\r
                             try:\r
-                                Item = ReLabel.sub('', Item)\r
+                                Item = _ReLabel.sub('', Item)\r
                             except:\r
                                 pass\r
                             try:\r
-                                OffsetList = ReOffset.findall(Item)\r
+                                OffsetList = _ReOffset.findall(Item)\r
                             except:\r
                                 pass\r
+                            # replace each offset, except errors\r
                             for Offset in OffsetList:\r
-                                if Offset in LabelDict.keys():\r
-                                    Re = re.compile('OFFSET_OF\(%s\)' % Offset)\r
-                                    Item = Re.sub(LabelDict[Offset], Item)\r
-                                else:\r
+                                try:\r
+                                    Item = Item.replace('OFFSET_OF({})'.format(Offset),LabelDict[Offset])\r
+                                except:\r
                                     raise BadExpression('%s not defined' % Offset)\r
+\r
                             NewPcdValueList.append(Item)\r
 \r
                         AllPcdValueList = []\r
@@ -978,18 +972,18 @@ class ValueExpressionEx(ValueExpression):
                                 continue\r
                             else:\r
                                 ValueType = ""\r
-                                if Item.startswith('UINT8'):\r
+                                if Item.startswith(TAB_UINT8):\r
                                     ItemSize = 1\r
-                                    ValueType = "UINT8"\r
-                                elif Item.startswith('UINT16'):\r
+                                    ValueType = TAB_UINT8\r
+                                elif Item.startswith(TAB_UINT16):\r
                                     ItemSize = 2\r
-                                    ValueType = "UINT16"\r
-                                elif Item.startswith('UINT32'):\r
+                                    ValueType = TAB_UINT16\r
+                                elif Item.startswith(TAB_UINT32):\r
                                     ItemSize = 4\r
-                                    ValueType = "UINT32"\r
-                                elif Item.startswith('UINT64'):\r
+                                    ValueType = TAB_UINT32\r
+                                elif Item.startswith(TAB_UINT64):\r
                                     ItemSize = 8\r
-                                    ValueType = "UINT64"\r
+                                    ValueType = TAB_UINT64\r
                                 else:\r
                                     ItemSize = 0\r
                                 if ValueType:\r
@@ -999,7 +993,7 @@ class ValueExpressionEx(ValueExpression):
                                 Item = '0x%x' % TmpValue if type(TmpValue) != type('') else TmpValue\r
                                 if ItemSize == 0:\r
                                     ItemValue, ItemSize = ParseFieldValue(Item)\r
-                                    if not (Item.startswith('"') or Item.startswith('L') or Item.startswith('{')) 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