## @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
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
import uuid\r
from CommonDataClass.Exceptions import BadExpression\r
-\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
def _parseForXcode(lines, efifilepath, varnames):\r
status = 0\r
ret = []\r
- for index, line in enumerate(lines):\r
+ for line in lines:\r
line = line.strip()\r
if status == 0 and line == "# Symbols:":\r
status = 1\r
for varname in varnames:\r
if varname in line:\r
m = re.match('^([\da-fA-FxX]+)([\s\S]*)([_]*%s)$' % varname, line)\r
- if m != None:\r
+ if m is not None:\r
ret.append((varname, m.group(1)))\r
return ret\r
\r
# status handler\r
if status == 3:\r
m = re.match('^([\w_\.]+) +([\da-fA-Fx]+) +([\da-fA-Fx]+)$', line)\r
- if m != None:\r
+ if m is not None:\r
sections.append(m.groups(0))\r
for varname in varnames:\r
Str = ''\r
m = re.match("^.data.(%s)" % varname, line)\r
- if m != None:\r
+ if m is not None:\r
m = re.match(".data.(%s)$" % varname, line)\r
- if m != None:\r
+ if m is not None:\r
Str = lines[index + 1]\r
else:\r
Str = line[len(".data.%s" % varname):]\r
if Str:\r
m = re.match('^([\da-fA-Fx]+) +([\da-fA-Fx]+)', Str.strip())\r
- if m != None:\r
+ if m is not None:\r
varoffset.append((varname, int(m.groups(0)[0], 16) , int(sections[-1][1], 16), sections[-1][0]))\r
\r
if not varoffset:\r
return []\r
# get section information from efi file\r
efisecs = PeImageClass(efifilepath).SectionHeaderList\r
- if efisecs == None or len(efisecs) == 0:\r
+ if efisecs is None or len(efisecs) == 0:\r
return []\r
#redirection\r
redirection = 0\r
continue \r
if status == 1 and len(line) != 0:\r
m = secRe.match(line)\r
- assert m != None, "Fail to parse the section in map file , line is %s" % line\r
+ assert m is not None, "Fail to parse the section in map file , line is %s" % line\r
sec_no, sec_start, sec_length, sec_name, sec_class = m.groups(0)\r
secs.append([int(sec_no, 16), int(sec_start, 16), int(sec_length, 16), sec_name, sec_class])\r
if status == 2 and len(line) != 0:\r
for varname in varnames:\r
m = symRe.match(line)\r
- assert m != None, "Fail to parse the symbol in map file, line is %s" % line\r
+ assert m is not None, "Fail to parse the symbol in map file, line is %s" % line\r
sec_no, sym_offset, sym_name, vir_addr = m.groups(0)\r
sec_no = int(sec_no, 16)\r
sym_offset = int(sym_offset, 16)\r
vir_addr = int(vir_addr, 16)\r
m2 = re.match('^[_]*(%s)' % varname, sym_name)\r
- if m2 != None:\r
+ if m2 is not None:\r
# fond a binary pcd entry in map file\r
for sec in secs:\r
if sec[0] == sec_no and (sym_offset >= sec[1] and sym_offset < sec[1] + sec[2]):\r
\r
# get section information from efi file\r
efisecs = PeImageClass(efifilepath).SectionHeaderList\r
- if efisecs == None or len(efisecs) == 0:\r
+ if efisecs is None or len(efisecs) == 0:\r
return []\r
\r
ret = []\r
# @param Directory The directory name\r
#\r
def CreateDirectory(Directory):\r
- if Directory == None or Directory.strip() == "":\r
+ if Directory is None or Directory.strip() == "":\r
return True\r
try:\r
if not os.access(Directory, os.F_OK):\r
# @param Directory The directory name\r
#\r
def RemoveDirectory(Directory, Recursively=False):\r
- if Directory == None or Directory.strip() == "" or not os.path.exists(Directory):\r
+ if Directory is None or Directory.strip() == "" or not os.path.exists(Directory):\r
return\r
if Recursively:\r
CurrentDirectory = os.getcwd()\r
except:\r
EdkLogger.error("", FILE_OPEN_FAILURE, ExtraData=File, RaiseError=False)\r
finally:\r
- if Fd != None:\r
+ if Fd is not None:\r
Fd.close()\r
\r
## Restore a Python object from a file\r
EdkLogger.verbose("Failed to load [%s]\n\t%s" % (File, str(e)))\r
Data = None\r
finally:\r
- if Fd != None:\r
+ if Fd is not None:\r
Fd.close()\r
return Data\r
\r
# @retval False if file doesn't exists\r
#\r
def ValidFile(File, Ext=None):\r
- if Ext != None:\r
+ if Ext is not None:\r
Dummy, FileExt = os.path.splitext(File)\r
if FileExt.lower() != Ext.lower():\r
return False\r
#\r
def ValidFile2(AllFiles, File, Ext=None, Workspace='', EfiSource='', EdkSource='', Dir='.', OverrideDir=''):\r
NewFile = File\r
- if Ext != None:\r
+ if Ext is not None:\r
Dummy, FileExt = os.path.splitext(File)\r
if FileExt.lower() != Ext.lower():\r
return False, File\r
\r
# Replace the Edk macros\r
- if OverrideDir != '' and OverrideDir != None:\r
+ if OverrideDir != '' and OverrideDir is not None:\r
if OverrideDir.find('$(EFI_SOURCE)') > -1:\r
OverrideDir = OverrideDir.replace('$(EFI_SOURCE)', EfiSource)\r
if OverrideDir.find('$(EDK_SOURCE)') > -1:\r
NewFile = File.replace('$(EFI_SOURCE)', EfiSource)\r
NewFile = NewFile.replace('$(EDK_SOURCE)', EdkSource)\r
NewFile = AllFiles[os.path.normpath(NewFile)]\r
- if NewFile != None:\r
+ if NewFile is not None:\r
return True, NewFile\r
\r
# Second check the path with override value\r
- if OverrideDir != '' and OverrideDir != None:\r
+ if OverrideDir != '' and OverrideDir is not None:\r
NewFile = AllFiles[os.path.normpath(os.path.join(OverrideDir, File))]\r
- if NewFile != None:\r
+ if NewFile is not None:\r
return True, NewFile\r
\r
# Last check the path with normal definitions\r
File = os.path.join(Dir, File)\r
NewFile = AllFiles[os.path.normpath(File)]\r
- if NewFile != None:\r
+ if NewFile is not None:\r
return True, NewFile\r
\r
return False, File\r
#\r
def ValidFile3(AllFiles, File, Workspace='', EfiSource='', EdkSource='', Dir='.', OverrideDir=''):\r
# Replace the Edk macros\r
- if OverrideDir != '' and OverrideDir != None:\r
+ if OverrideDir != '' and OverrideDir is not None:\r
if OverrideDir.find('$(EFI_SOURCE)') > -1:\r
OverrideDir = OverrideDir.replace('$(EFI_SOURCE)', EfiSource)\r
if OverrideDir.find('$(EDK_SOURCE)') > -1:\r
File = File.replace('$(EFI_SOURCE)', EfiSource)\r
File = File.replace('$(EDK_SOURCE)', EdkSource)\r
NewFile = AllFiles[os.path.normpath(File)]\r
- if NewFile != None:\r
+ if NewFile is not None:\r
NewRelaPath = os.path.dirname(NewFile)\r
File = os.path.basename(NewFile)\r
#NewRelaPath = NewFile[:len(NewFile) - len(File.replace("..\\", '').replace("../", '')) - 1]\r
break\r
\r
# Second check the path with override value\r
- if OverrideDir != '' and OverrideDir != None:\r
+ if OverrideDir != '' and OverrideDir is not None:\r
NewFile = AllFiles[os.path.normpath(os.path.join(OverrideDir, File))]\r
- if NewFile != None:\r
+ if NewFile is not None:\r
#NewRelaPath = os.path.dirname(NewFile)\r
NewRelaPath = NewFile[:len(NewFile) - len(File.replace("..\\", '').replace("../", '')) - 1]\r
break\r
\r
# Last check the path with normal definitions\r
NewFile = AllFiles[os.path.normpath(os.path.join(Dir, File))]\r
- if NewFile != None:\r
+ if NewFile is not None:\r
break\r
\r
# No file found\r
self.CodaMessage = CloseMessage\r
self.ProgressChar = ProgressChar\r
self.Interval = Interval\r
- if Progressor._StopFlag == None:\r
+ if Progressor._StopFlag is None:\r
Progressor._StopFlag = threading.Event()\r
\r
## Start to print progress charater\r
# @param OpenMessage The string printed before progress charaters\r
#\r
def Start(self, OpenMessage=None):\r
- if OpenMessage != None:\r
+ if OpenMessage is not None:\r
self.PromptMessage = OpenMessage\r
Progressor._StopFlag.clear()\r
- if Progressor._ProgressThread == None:\r
+ if Progressor._ProgressThread is None:\r
Progressor._ProgressThread = threading.Thread(target=self._ProgressThreadEntry)\r
Progressor._ProgressThread.setDaemon(False)\r
Progressor._ProgressThread.start()\r
#\r
def Stop(self, CloseMessage=None):\r
OriginalCodaMessage = self.CodaMessage\r
- if CloseMessage != None:\r
+ if CloseMessage is not None:\r
self.CodaMessage = CloseMessage\r
self.Abort()\r
self.CodaMessage = OriginalCodaMessage\r
## Abort the progress display\r
@staticmethod\r
def Abort():\r
- if Progressor._StopFlag != None:\r
+ if Progressor._StopFlag is not None:\r
Progressor._StopFlag.set()\r
- if Progressor._ProgressThread != None:\r
+ if Progressor._ProgressThread is not None:\r
Progressor._ProgressThread.join()\r
Progressor._ProgressThread = None\r
\r
return key, value\r
\r
def update(self, dict=None, **kwargs):\r
- if dict != None:\r
+ if dict is not None:\r
for k, v in dict.items():\r
self[k] = v\r
if len(kwargs):\r
if self._Level_ > 1:\r
RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]\r
\r
- if FirstKey == None or str(FirstKey).upper() in self._ValidWildcardList:\r
+ if FirstKey is None or str(FirstKey).upper() in self._ValidWildcardList:\r
FirstKey = self._Wildcard\r
\r
if self._Single_:\r
if FirstKey == self._Wildcard:\r
if FirstKey in self.data:\r
Value = self.data[FirstKey][RestKeys]\r
- if Value == None:\r
+ if Value is None:\r
for Key in self.data:\r
Value = self.data[Key][RestKeys]\r
- if Value != None: break\r
+ if Value is not None: break\r
else:\r
if FirstKey in self.data:\r
Value = self.data[FirstKey][RestKeys]\r
- if Value == None and self._Wildcard in self.data:\r
+ if Value is None and self._Wildcard in self.data:\r
#print "Value=None"\r
Value = self.data[self._Wildcard][RestKeys]\r
else:\r
if FirstKey == self._Wildcard:\r
if FirstKey in self.data:\r
Value = self.data[FirstKey]\r
- if Value == None:\r
+ if Value is None:\r
for Key in self.data:\r
Value = self.data[Key]\r
- if Value != None: break\r
+ if Value is not None: break\r
else:\r
if FirstKey in self.data:\r
Value = self.data[FirstKey]\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
- # 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
- InStr = False\r
+ InSingleQuoteStr = False\r
+ InDoubleQuoteStr = False\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
- elif ch == ')' and not InStr:\r
+ elif ch == ')' and not (InSingleQuoteStr or InDoubleQuoteStr):\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
return FieldList\r
\r
def ParseDevPathValue (Value):\r
- pass\r
+ if '\\' in Value:\r
+ Value.replace('\\', '/').replace(' ', '')\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
if type(Value) == type(0):\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 = ['%02x' % int(Item, 16) for Item in (Value[0] + Value[1][:-1]).split(',')]\r
- if len(Value[0]) != 8:\r
- Value[0] = '%08X' % int(Value[0], 16)\r
- if len(Value[1]) != 4:\r
- Value[1] = '%04X' % int(Value[1], 16)\r
- if len(Value[2]) != 4:\r
- Value[2] = '%04X' % int(Value[2], 16)\r
- Value = '-'.join(Value[0:3]) + '-' + ''.join(Value[3:5]) + '-' + ''.join(Value[5:11])\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
return Value, 16\r
if Value.startswith('L"') and Value.endswith('"'):\r
# Unicode String\r
- List = list(Value[2:-1])\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
return Value, (len(List) + 1) * 2\r
if Value.startswith('"') and Value.endswith('"'):\r
# ASCII String\r
- List = list(Value[1:-1])\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
return Value, len(List) + 1\r
if Value.startswith("L'") and Value.endswith("'"):\r
# Unicode Character Constant\r
- List = list(Value[2:-1])\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
return Value, len(List) * 2\r
if Value.startswith("'") and Value.endswith("'"):\r
# Character constant\r
- List = list(Value[1:-1])\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) | ((ItemValue >> 8 * I) & 0xff)\r
return Value, RetSize\r
if Value.startswith('DEVICE_PATH(') and Value.endswith(')'):\r
- Value = Value.split('"')[1]\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
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 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
- ", 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
return hash(self.Path)\r
\r
def _GetFileKey(self):\r
- if self._Key == None:\r
+ if self._Key is None:\r
self._Key = self.Path.upper() # + self.ToolChainFamily + self.TagName + self.ToolCode + self.Target\r
return self._Key\r
\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
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
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