BaseTools: Add new RegExp for future use

[mirror_edk2.git] / BaseTools / Source / Python / Common / Misc.py

diff --git a/BaseTools/Source/Python/Common/Misc.py b/BaseTools/Source/Python/Common/Misc.py
index f44000829aacfe5dacc7090d6a1fc1506946ee59..7d44fdcf8ba73b42107299e65e36a7b4379659fb 100644 (file)
--- a/BaseTools/Source/Python/Common/Misc.py
+++ b/BaseTools/Source/Python/Common/Misc.py
@@ -1,7 +1,7 @@
 ## @file\r
 # Common routines used by all tools\r
 #\r
 ## @file\r
 # Common routines used by all tools\r
 #\r

-# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r

 # This program and the accompanying materials\r
 # are licensed and made available under the terms and conditions of the BSD License\r
 # which accompanies this distribution.  The full text of the license may be found at\r
 # This program and the accompanying materials\r
 # are licensed and made available under the terms and conditions of the BSD License\r
 # which accompanies this distribution.  The full text of the license may be found at\r


@@ -37,7 +37,8 @@ from Parsing import GetSplitValueList
 from Common.LongFilePathSupport import OpenLongFilePath as open\r
 from Common.MultipleWorkspace import MultipleWorkspace as mws\r
 import uuid\r
 from Common.LongFilePathSupport import OpenLongFilePath as open\r
 from Common.MultipleWorkspace import MultipleWorkspace as mws\r
 import uuid\r

-\r
+from CommonDataClass.Exceptions import BadExpression\r
+import subprocess\r

 ## Regular expression used to find out place holders in string template\r
 gPlaceholderPattern = re.compile("\$\{([^$()\s]+)\}", re.MULTILINE | re.UNICODE)\r
 \r
 ## Regular expression used to find out place holders in string template\r
 gPlaceholderPattern = re.compile("\$\{([^$()\s]+)\}", re.MULTILINE | re.UNICODE)\r
 \r


@@ -1440,23 +1441,44 @@ def ParseConsoleLog(Filename):
     Opr.close()\r
     Opw.close()\r
 \r
     Opr.close()\r
     Opw.close()\r
 \r

+def IsFieldValueAnArray (Value):\r
+    Value = Value.strip()\r
+    if Value.startswith('GUID') and Value.endswith(')'):\r
+        return True\r
+    if Value.startswith('L"') and Value.endswith('"')  and len(list(Value[2:-1])) > 1:\r
+        return True\r
+    if Value[0] == '"' and Value[-1] == '"' and len(list(Value[1:-1])) > 1:\r
+        return True\r
+    if Value[0] == '{' and Value[-1] == '}':\r
+        return True\r
+    if Value.startswith("L'") and Value.endswith("'") and len(list(Value[2:-1])) > 1:\r
+        return True\r
+    if Value[0] == "'" and Value[-1] == "'" and len(list(Value[1:-1])) > 1:\r
+        return True\r
+    return False\r
+\r

 def AnalyzePcdExpression(Setting):\r
     Setting = Setting.strip()\r
 def AnalyzePcdExpression(Setting):\r
     Setting = Setting.strip()\r

-    # There might be escaped quote in a string: \", \\\"\r
-    Data = Setting.replace('\\\\', '//').replace('\\\"', '\\\'')\r
+    # There might be escaped quote in a string: \", \\\" , \', \\\'\r
+    Data = Setting\r

     # There might be '|' in string and in ( ... | ... ), replace it with '-'\r
     NewStr = ''\r
     # There might be '|' in string and in ( ... | ... ), replace it with '-'\r
     NewStr = ''\r

-    InStr = False\r
+    InSingleQuoteStr = False\r
+    InDoubleQuoteStr = False\r

     Pair = 0\r
     Pair = 0\r

-    for ch in Data:\r
-        if ch == '"':\r
-            InStr = not InStr\r
-        elif ch == '(' and not InStr:\r
+    for Index, ch in enumerate(Data):\r
+        if ch == '"' and not InSingleQuoteStr:\r
+            if Data[Index - 1] != '\\':\r
+                InDoubleQuoteStr = not InDoubleQuoteStr\r
+        elif ch == "'" and not InDoubleQuoteStr:\r
+            if Data[Index - 1] != '\\':\r
+                InSingleQuoteStr = not InSingleQuoteStr\r
+        elif ch == '(' and not (InSingleQuoteStr or InDoubleQuoteStr):\r

             Pair += 1\r
             Pair += 1\r

-        elif ch == ')' and not InStr:\r
+        elif ch == ')' and not (InSingleQuoteStr or InDoubleQuoteStr):\r

             Pair -= 1\r
 \r
             Pair -= 1\r
 \r

-        if (Pair > 0 or InStr) and ch == TAB_VALUE_SPLIT:\r
+        if (Pair > 0 or InSingleQuoteStr or InDoubleQuoteStr) and ch == TAB_VALUE_SPLIT:\r

             NewStr += '-'\r
         else:\r
             NewStr += ch\r
             NewStr += '-'\r
         else:\r
             NewStr += ch\r


@@ -1472,99 +1494,170 @@ def AnalyzePcdExpression(Setting):
 \r
     return FieldList\r
 \r
 \r
     return FieldList\r
 \r

+def ParseDevPathValue (Value):\r
+    DevPathList = [ "Path","HardwarePath","Pci","PcCard","MemoryMapped","VenHw","Ctrl","BMC","AcpiPath","Acpi","PciRoot",\r
+                    "PcieRoot","Floppy","Keyboard","Serial","ParallelPort","AcpiEx","AcpiExp","AcpiAdr","Msg","Ata","Scsi",\r
+                    "Fibre","FibreEx","I1394","USB","I2O","Infiniband","VenMsg","VenPcAnsi","VenVt100","VenVt100Plus",\r
+                    "VenUtf8","UartFlowCtrl","SAS","SasEx","NVMe","UFS","SD","eMMC","DebugPort","MAC","IPv4","IPv6","Uart",\r
+                    "UsbClass","UsbAudio","UsbCDCControl","UsbHID","UsbImage","UsbPrinter","UsbMassStorage","UsbHub",\r
+                    "UsbCDCData","UsbSmartCard","UsbVideo","UsbDiagnostic","UsbWireless","UsbDeviceFirmwareUpdate",\r
+                    "UsbIrdaBridge","UsbTestAndMeasurement","UsbWwid","Unit","iSCSI","Vlan","Uri","Bluetooth","Wi-Fi",\r
+                    "MediaPath","HD","CDROM","VenMedia","Media","Fv","FvFile","Offset","RamDisk","VirtualDisk","VirtualCD",\r
+                    "PersistentVirtualDisk","PersistentVirtualCD","BbsPath","BBS","Sata" ]\r
+    if '\\' in Value:\r
+        Value.replace('\\', '/').replace(' ', '')\r
+    for Item in Value.split('/'):\r
+        Key = Item.strip().split('(')[0]\r
+        if Key not in DevPathList:\r
+            pass\r
+\r
+    Cmd = 'DevicePath ' + '"' + Value + '"'\r
+    try:\r
+        p = subprocess.Popen(Cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r
+        out, err = p.communicate()\r
+    except Exception, X:\r
+        raise BadExpression("DevicePath: %s" % (str(X)) )\r
+    finally:\r
+        subprocess._cleanup()\r
+        p.stdout.close()\r
+        p.stderr.close()\r
+    if err:\r
+        raise BadExpression("DevicePath: %s" % str(err))\r
+    Size = len(out.split())\r
+    out = ','.join(out.split())\r
+    return '{' + out + '}', Size\r
+\r

 def ParseFieldValue (Value):\r
 def ParseFieldValue (Value):\r

-  if type(Value) == type(0):\r
-    return Value, (Value.bit_length() + 7) / 8\r
-  if type(Value) <> type(''):\r
-    raise ValueError\r
-  Value = Value.strip()\r
-  if Value.startswith('UINT8') and Value.endswith(')'):\r
-    Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
-    if Size > 1:\r
-      raise ValueError\r
+    if type(Value) == type(0):\r
+        return Value, (Value.bit_length() + 7) / 8\r
+    if type(Value) <> type(''):\r
+        raise BadExpression('Type %s is %s' %(Value, type(Value)))\r
+    Value = Value.strip()\r
+    if Value.startswith('UINT8') and Value.endswith(')'):\r
+        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
+        if Size > 1:\r
+            raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))\r
+        return Value, 1\r
+    if Value.startswith('UINT16') and Value.endswith(')'):\r
+        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
+        if Size > 2:\r
+            raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))\r
+        return Value, 2\r
+    if Value.startswith('UINT32') and Value.endswith(')'):\r
+        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
+        if Size > 4:\r
+            raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))\r
+        return Value, 4\r
+    if Value.startswith('UINT64') and Value.endswith(')'):\r
+        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
+        if Size > 8:\r
+            raise BadExpression('Value (%s) Size larger than %d' % (Value, Size))\r
+        return Value, 8\r
+    if Value.startswith('GUID') and Value.endswith(')'):\r
+        Value = Value.split('(', 1)[1][:-1].strip()\r
+        if Value[0] == '{' and Value[-1] == '}':\r
+            TmpValue = GuidStructureStringToGuidString(Value)\r
+            if len(TmpValue) == 0:\r
+                raise BadExpression("Invalid GUID value string %s" % Value)\r
+            Value = TmpValue\r
+        if Value[0] == '"' and Value[-1] == '"':\r
+            Value = Value[1:-1]\r
+        try:\r
+            Value = "'" + uuid.UUID(Value).get_bytes_le() + "'"\r
+        except ValueError, Message:\r
+            raise BadExpression('%s' % Message)\r
+        Value, Size = ParseFieldValue(Value)\r
+        return Value, 16\r
+    if Value.startswith('L"') and Value.endswith('"'):\r
+        # Unicode String\r
+        # translate escape character\r
+        Value = Value[1:]\r
+        try:\r
+            Value = eval(Value)\r
+        except:\r
+            Value = Value[1:-1]\r
+        List = list(Value)\r
+        List.reverse()\r
+        Value = 0\r
+        for Char in List:\r
+            Value = (Value << 16) | ord(Char)\r
+        return Value, (len(List) + 1) * 2\r
+    if Value.startswith('"') and Value.endswith('"'):\r
+        # ASCII String\r
+        # translate escape character\r
+        try:\r
+            Value = eval(Value)\r
+        except:\r
+            Value = Value[1:-1]\r
+        List = list(Value)\r
+        List.reverse()\r
+        Value = 0\r
+        for Char in List:\r
+            Value = (Value << 8) | ord(Char)\r
+        return Value, len(List) + 1\r
+    if Value.startswith("L'") and Value.endswith("'"):\r
+        # Unicode Character Constant\r
+        # translate escape character\r
+        Value = Value[1:]\r
+        try:\r
+            Value = eval(Value)\r
+        except:\r
+            Value = Value[1:-1]\r
+        List = list(Value)\r
+        if len(List) == 0:\r
+            raise BadExpression('Length %s is %s' % (Value, len(List)))\r
+        List.reverse()\r
+        Value = 0\r
+        for Char in List:\r
+            Value = (Value << 16) | ord(Char)\r
+        return Value, len(List) * 2\r
+    if Value.startswith("'") and Value.endswith("'"):\r
+        # Character constant\r
+        # translate escape character\r
+        try:\r
+            Value = eval(Value)\r
+        except:\r
+            Value = Value[1:-1]\r
+        List = list(Value)\r
+        if len(List) == 0:\r
+            raise BadExpression('Length %s is %s' % (Value, len(List)))\r
+        List.reverse()\r
+        Value = 0\r
+        for Char in List:\r
+            Value = (Value << 8) | ord(Char)\r
+        return Value, len(List)\r
+    if Value.startswith('{') and Value.endswith('}'):\r
+        # Byte array\r
+        Value = Value[1:-1]\r
+        List = [Item.strip() for Item in Value.split(',')]\r
+        List.reverse()\r
+        Value = 0\r
+        RetSize = 0\r
+        for Item in List:\r
+            ItemValue, Size = ParseFieldValue(Item)\r
+            RetSize += Size\r
+            for I in range(Size):\r
+                Value = (Value << 8) | ((ItemValue >> 8 * I) & 0xff)\r
+        return Value, RetSize\r
+    if Value.startswith('DEVICE_PATH(') and Value.endswith(')'):\r
+        Value = Value.replace("DEVICE_PATH(", '').rstrip(')')\r
+        Value = Value.strip().strip('"')\r
+        return ParseDevPathValue(Value)\r
+    if Value.lower().startswith('0x'):\r
+        Value = int(Value, 16)\r
+        if Value == 0:\r
+            return 0, 1\r
+        return Value, (Value.bit_length() + 7) / 8\r
+    if Value[0].isdigit():\r
+        Value = int(Value, 10)\r
+        if Value == 0:\r
+            return 0, 1\r
+        return Value, (Value.bit_length() + 7) / 8\r
+    if Value.lower() == 'true':\r
+        return 1, 1\r
+    if Value.lower() == 'false':\r
+        return 0, 1\r

     return Value, 1\r
     return Value, 1\r

-  if Value.startswith('UINT16') and Value.endswith(')'):\r
-    Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
-    if Size > 2:\r
-      raise ValueError\r
-    return Value, 2\r
-  if Value.startswith('UINT32') and Value.endswith(')'):\r
-    Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
-    if Size > 4:\r
-      raise ValueError\r
-    return Value, 4\r
-  if Value.startswith('UINT64') and Value.endswith(')'):\r
-    Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
-    if Size > 8:\r
-      raise ValueError\r
-    return Value, 8\r
-  if Value.startswith('GUID') and Value.endswith(')'):\r
-    Value = Value.split('(', 1)[1][:-1].strip()\r
-    if Value[0] == '{' and Value[-1] == '}':\r
-      Value = Value[1:-1].strip()\r
-      Value = Value.split('{', 1)\r
-      Value = [Item.strip()[2:] for Item in (Value[0] + Value[1][:-1]).split(',')]\r
-      Value = '-'.join(Value[0:3]) + '-' + ''.join(Value[3:5]) + '-' + ''.join(Value[5:11])\r
-    if Value[0] == '"' and Value[-1] == '"':\r
-      Value = Value[1:-1]\r
-    Value = "'" + uuid.UUID(Value).get_bytes_le() + "'"\r
-    Value, Size = ParseFieldValue(Value)\r
-    return Value, 16\r
-  if Value.startswith('L"') and Value.endswith('"'):\r
-    # Unicode String\r
-    List = list(Value[2:-1])\r
-    List.reverse()\r
-    Value = 0\r
-    for Char in List:\r
-      Value = (Value << 16) | ord(Char)\r
-    return Value, (len(List) + 1) * 2\r
-  if Value.startswith('"') and Value.endswith('"'):\r
-    # ASCII String\r
-    List = list(Value[1:-1])\r
-    List.reverse()\r
-    Value = 0\r
-    for Char in List:\r
-      Value = (Value << 8) | ord(Char)\r
-    return Value, len(List) + 1\r
-  if Value.startswith("L'") and Value.endswith("'"):\r
-    # Unicode Character Constant\r
-    List = list(Value[2:-1])\r
-    List.reverse()\r
-    Value = 0\r
-    for Char in List:\r
-      Value = (Value << 16) | ord(Char)\r
-    return Value, len(List) * 2\r
-  if Value.startswith("'") and Value.endswith("'"):\r
-    # Character constant\r
-    List = list(Value[1:-1])\r
-    List.reverse()\r
-    Value = 0\r
-    for Char in List:\r
-      Value = (Value << 8) | ord(Char)\r
-    return Value, len(List)\r
-  if Value.startswith('{') and Value.endswith('}'):\r
-    # Byte array\r
-    Value = Value[1:-1]\r
-    List = [Item.strip() for Item in Value.split(',')]\r
-    List.reverse()\r
-    Value = 0\r
-    for Item in List:\r
-      ItemValue, Size = ParseFieldValue(Item)\r
-      if Size > 1:\r
-        raise ValueError\r
-      Value = (Value << 8) | ItemValue\r
-    return Value, len(List)\r
-  if Value.lower().startswith('0x'):\r
-    Value = int(Value, 16)\r
-    return Value, (Value.bit_length() + 7) / 8\r
-  if Value[0].isdigit():\r
-    Value = int(Value, 10)\r
-    return Value, (Value.bit_length() + 7) / 8\r
-  if Value.lower() == 'true':\r
-    return 1, 1\r
-  if Value.lower() == 'false':\r
-    return 0, 1\r
-  return Value, 1\r

 \r
 ## AnalyzeDscPcd\r
 #\r
 \r
 ## AnalyzeDscPcd\r
 #\r


@@ -1627,14 +1720,6 @@ def AnalyzeDscPcd(Setting, PcdType, DataType=''):
             Type = DataType\r
         if len(FieldList) > 2:\r
             Size = FieldList[2]\r
             Type = DataType\r
         if len(FieldList) > 2:\r
             Size = FieldList[2]\r

-        else:\r
-            if Type == 'VOID*':\r
-                if Value.startswith("L"):\r
-                    Size = str((len(Value)- 3 + 1) * 2)\r
-                elif Value.startswith("{"):\r
-                    Size = str(len(Value.split(",")))\r
-                else:\r
-                    Size = str(len(Value) -2 + 1 )\r

         if DataType == "":\r
             IsValid = (len(FieldList) <= 1)\r
         else:\r
         if DataType == "":\r
             IsValid = (len(FieldList) <= 1)\r
         else:\r


@@ -1767,10 +1852,10 @@ def CheckPcdDatum(Type, Value):
     if Type == "VOID*":\r
         ValueRe = re.compile(r'\s*L?\".*\"\s*$')\r
         if not (((Value.startswith('L"') or Value.startswith('"')) and Value.endswith('"'))\r
     if Type == "VOID*":\r
         ValueRe = re.compile(r'\s*L?\".*\"\s*$')\r
         if not (((Value.startswith('L"') or Value.startswith('"')) and Value.endswith('"'))\r

-                or (Value.startswith('{') and Value.endswith('}'))\r
+                or (Value.startswith('{') and Value.endswith('}')) or (Value.startswith("L'") or Value.startswith("'") and Value.endswith("'"))\r

                ):\r
             return False, "Invalid value [%s] of type [%s]; must be in the form of {...} for array"\\r
                ):\r
             return False, "Invalid value [%s] of type [%s]; must be in the form of {...} for array"\\r

-                          ", or \"...\" for string, or L\"...\" for unicode string" % (Value, Type)\r
+                          ", \"...\" or \'...\' for string, L\"...\" or L\'...\' for unicode string" % (Value, Type)\r

         elif ValueRe.match(Value):\r
             # Check the chars in UnicodeString or CString is printable\r
             if Value.startswith("L"):\r
         elif ValueRe.match(Value):\r
             # Check the chars in UnicodeString or CString is printable\r
             if Value.startswith("L"):\r


@@ -2189,6 +2274,10 @@ class SkuClass():
             GlobalData.gSkuids = (self.SkuIdSet)\r
             if 'COMMON' in GlobalData.gSkuids:\r
                 GlobalData.gSkuids.remove('COMMON')\r
             GlobalData.gSkuids = (self.SkuIdSet)\r
             if 'COMMON' in GlobalData.gSkuids:\r
                 GlobalData.gSkuids.remove('COMMON')\r

+            if self.SkuUsageType == self.SINGLE:\r
+                if len(GlobalData.gSkuids) != 1:\r
+                    if 'DEFAULT' in GlobalData.gSkuids:\r
+                        GlobalData.gSkuids.remove('DEFAULT')\r

             if GlobalData.gSkuids:\r
                 GlobalData.gSkuids.sort()\r
 \r
             if GlobalData.gSkuids:\r
                 GlobalData.gSkuids.sort()\r
 \r


@@ -2200,6 +2289,8 @@ class SkuClass():
         return self.__SkuInherit.get(skuname,"DEFAULT")\r
 \r
     def GetSkuChain(self,sku):\r
         return self.__SkuInherit.get(skuname,"DEFAULT")\r
 \r
     def GetSkuChain(self,sku):\r

+        if sku == "DEFAULT":\r
+            return ["DEFAULT"]\r

         skulist = [sku]\r
         nextsku = sku\r
         while 1:\r
         skulist = [sku]\r
         nextsku = sku\r
         while 1:\r


@@ -2294,31 +2385,6 @@ def PackRegistryFormatGuid(Guid):
                 int(Guid[4][-2:], 16)\r
                 )\r
 \r
                 int(Guid[4][-2:], 16)\r
                 )\r
 \r

-def BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, Value):\r
-    if PcdDatumType == 'VOID*':\r
-        if Value.startswith('L'):\r
-            if not Value[1]:\r
-                EdkLogger.error("build", FORMAT_INVALID, 'For Void* type PCD, when specify the Value in the command line, please use the following format: "string", L"string", H"{...}"')\r
-            Value = Value[0] + '"' + Value[1:] + '"'\r
-        elif Value.startswith('H'):\r
-            if not Value[1]:\r
-                EdkLogger.error("build", FORMAT_INVALID, 'For Void* type PCD, when specify the Value in the command line, please use the following format: "string", L"string", H"{...}"')\r
-            Value = Value[1:]\r
-        else:\r
-            if not Value[0]:\r
-                EdkLogger.error("build", FORMAT_INVALID, 'For Void* type PCD, when specify the Value in the command line, please use the following format: "string", L"string", H"{...}"')\r
-            Value = '"' + Value + '"'\r
-\r
-    IsValid, Cause = CheckPcdDatum(PcdDatumType, Value)\r
-    if not IsValid:\r
-        EdkLogger.error("build", FORMAT_INVALID, Cause, ExtraData="%s.%s" % (TokenSpaceGuidCName, TokenCName))\r
-    if PcdDatumType == 'BOOLEAN':\r
-        Value = Value.upper()\r
-        if Value == 'TRUE' or Value == '1':\r
-            Value = '1'\r
-        elif Value == 'FALSE' or Value == '0':\r
-            Value = '0'\r
-    return  Value\r

 ##  Get the integer value from string like "14U" or integer like 2\r
 #\r
 #   @param      Input   The object that may be either a integer value or a string\r
 ##  Get the integer value from string like "14U" or integer like 2\r
 #\r
 #   @param      Input   The object that may be either a integer value or a string\r