## @file\r
# This file is used to define common string related functions used in parsing process\r
#\r
-# Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2007 - 2015, 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
#\r
import re\r
import DataType\r
-import os.path\r
+import Common.LongFilePathOs as os\r
import string\r
import EdkLogger as EdkLogger\r
\r
import GlobalData\r
from BuildToolError import *\r
from CommonDataClass.Exceptions import *\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Common.MultipleWorkspace import MultipleWorkspace as mws\r
\r
-gHexVerPatt = re.compile('0x[a-f0-9]{4}[a-f0-9]{4}$',re.IGNORECASE)\r
+gHexVerPatt = re.compile('0x[a-f0-9]{4}[a-f0-9]{4}$', re.IGNORECASE)\r
gHumanReadableVerPatt = re.compile(r'([1-9][0-9]*|0)\.[0-9]{1,2}$')\r
\r
## GetSplitValueList\r
#\r
# @retval list() A list for splitted string\r
#\r
-def GetSplitValueList(String, SplitTag = DataType.TAB_VALUE_SPLIT, MaxSplit = -1):\r
+def GetSplitValueList(String, SplitTag=DataType.TAB_VALUE_SPLIT, MaxSplit= -1):\r
ValueList = []\r
Last = 0\r
Escaped = False\r
# Found a splitter not in a string, split it\r
if not InString and Char == SplitTag:\r
ValueList.append(String[Last:Index].strip())\r
- Last = Index+1\r
+ Last = Index + 1\r
if MaxSplit > 0 and len(ValueList) >= MaxSplit:\r
break\r
\r
#\r
# @retval list() A list for splitted string\r
#\r
-def GetSplitList(String, SplitStr = DataType.TAB_VALUE_SPLIT, MaxSplit = -1):\r
+def GetSplitList(String, SplitStr=DataType.TAB_VALUE_SPLIT, MaxSplit= -1):\r
return map(lambda l: l.strip(), String.split(SplitStr, MaxSplit))\r
\r
## MergeArches\r
#\r
# @retval NewList A new string list whose macros are replaced\r
#\r
-def ReplaceMacros(StringList, MacroDefinitions={}, SelfReplacement = False):\r
+def ReplaceMacros(StringList, MacroDefinitions={}, SelfReplacement=False):\r
NewList = []\r
for String in StringList:\r
if type(String) == type(''):\r
if SelfReplacement:\r
String = String.replace("$(%s)" % Macro, '')\r
continue\r
- String = String.replace("$(%s)" % Macro, MacroDefinitions[Macro])\r
+ if "$(%s)" % Macro not in MacroDefinitions[Macro]:\r
+ String = String.replace("$(%s)" % Macro, MacroDefinitions[Macro])\r
# in case there's macro not defined\r
if String == LastString:\r
break\r
#\r
# @retval Path Formatted path\r
#\r
-def NormPath(Path, Defines = {}):\r
+def NormPath(Path, Defines={}):\r
IsRelativePath = False\r
if Path:\r
if Path[0] == '.':\r
# To local path format\r
#\r
Path = os.path.normpath(Path)\r
+ if Path.startswith(GlobalData.gWorkspace) and not os.path.exists(Path):\r
+ Path = Path[len (GlobalData.gWorkspace):]\r
+ if Path[0] == os.path.sep:\r
+ Path = Path[1:]\r
+ Path = mws.join(GlobalData.gWorkspace, Path)\r
\r
if IsRelativePath and Path[0] != '.':\r
Path = os.path.join('.', Path)\r
#\r
# @retval Path Formatted path\r
#\r
-def CleanString(Line, CommentCharacter = DataType.TAB_COMMENT_SPLIT, AllowCppStyleComment=False):\r
+def CleanString(Line, CommentCharacter=DataType.TAB_COMMENT_SPLIT, AllowCppStyleComment=False, BuildOption=False):\r
#\r
# remove whitespace\r
#\r
elif Line[Index] == CommentCharacter and not InString :\r
Line = Line[0: Index]\r
break\r
- \r
- if CommentInString:\r
+\r
+ if CommentInString and BuildOption:\r
Line = Line.replace('"', '')\r
ChIndex = Line.find('#')\r
while ChIndex >= 0:\r
if GlobalData.gIsWindows:\r
- if ChIndex == 0 or Line[ChIndex-1] != '^':\r
+ if ChIndex == 0 or Line[ChIndex - 1] != '^':\r
Line = Line[0:ChIndex] + '^' + Line[ChIndex:]\r
ChIndex = Line.find('#', ChIndex + 2)\r
else:\r
ChIndex = Line.find('#', ChIndex + 1)\r
else:\r
- if ChIndex == 0 or Line[ChIndex-1] != '\\':\r
+ if ChIndex == 0 or Line[ChIndex - 1] != '\\':\r
Line = Line[0:ChIndex] + '\\' + Line[ChIndex:]\r
ChIndex = Line.find('#', ChIndex + 2)\r
else:\r
\r
## CleanString2\r
#\r
-# Split comments in a string\r
+# Split statement with comments in a string\r
# Remove spaces\r
#\r
# @param Line: The string to be cleaned\r
#\r
# @retval Path Formatted path\r
#\r
-def CleanString2(Line, CommentCharacter = DataType.TAB_COMMENT_SPLIT, AllowCppStyleComment=False):\r
+def CleanString2(Line, CommentCharacter=DataType.TAB_COMMENT_SPLIT, AllowCppStyleComment=False):\r
#\r
# remove whitespace\r
#\r
if AllowCppStyleComment:\r
Line = Line.replace(DataType.TAB_COMMENT_EDK_SPLIT, CommentCharacter)\r
#\r
- # separate comments and statements\r
- #\r
- LineParts = Line.split(CommentCharacter, 1);\r
- #\r
- # remove whitespace again\r
+ # separate comments and statements, but we should escape comment character in string\r
#\r
- Line = LineParts[0].strip();\r
- if len(LineParts) > 1:\r
- Comment = LineParts[1].strip()\r
- # Remove prefixed and trailing comment characters\r
- Start = 0\r
- End = len(Comment)\r
- while Start < End and Comment.startswith(CommentCharacter, Start, End):\r
- Start += 1\r
- while End >= 0 and Comment.endswith(CommentCharacter, Start, End):\r
- End -= 1\r
- Comment = Comment[Start:End]\r
- Comment = Comment.strip()\r
- else:\r
- Comment = ''\r
+ InString = False\r
+ CommentInString = False\r
+ Comment = ''\r
+ for Index in range(0, len(Line)):\r
+ if Line[Index] == '"':\r
+ InString = not InString\r
+ elif Line[Index] == CommentCharacter and InString:\r
+ CommentInString = True\r
+ elif Line[Index] == CommentCharacter and not InString:\r
+ Comment = Line[Index:].strip()\r
+ Line = Line[0:Index].strip()\r
+ break\r
\r
return Line, Comment\r
\r
if len(Minor) == 1:\r
Minor += '0'\r
DeciValue = (int(Major) << 16) + int(Minor);\r
- return "0x%08x"%DeciValue\r
+ return "0x%08x" % DeciValue\r
elif gHexVerPatt.match(VerString):\r
return VerString\r
else:\r
#\r
if Line.find('$') > -1:\r
if Line.find('$(') < 0 or Line.find(')') < 0:\r
- EdkLogger.error("Parser", FORMAT_INVALID, Line=LineNo, File=FileName, RaiseError = EdkLogger.IsRaiseError)\r
+ EdkLogger.error("Parser", FORMAT_INVALID, Line=LineNo, File=FileName, RaiseError=EdkLogger.IsRaiseError)\r
\r
#\r
# Check []\r
# Only get one '[' or one ']'\r
#\r
if not (Line.find('[') > -1 and Line.find(']') > -1):\r
- EdkLogger.error("Parser", FORMAT_INVALID, Line=LineNo, File=FileName, RaiseError = EdkLogger.IsRaiseError)\r
+ EdkLogger.error("Parser", FORMAT_INVALID, Line=LineNo, File=FileName, RaiseError=EdkLogger.IsRaiseError)\r
\r
#\r
# Regenerate FileContent\r
NewFileContent = NewFileContent + Line + '\r\n'\r
\r
if IsFailed:\r
- EdkLogger.error("Parser", FORMAT_INVALID, Line=LineNo, File=FileName, RaiseError = EdkLogger.IsRaiseError)\r
+ EdkLogger.error("Parser", FORMAT_INVALID, Line=LineNo, File=FileName, RaiseError=EdkLogger.IsRaiseError)\r
\r
return NewFileContent\r
\r
#\r
# @retval True The file type is correct\r
#\r
-def CheckFileType(CheckFilename, ExtName, ContainerFilename, SectionName, Line, LineNo = -1):\r
+def CheckFileType(CheckFilename, ExtName, ContainerFilename, SectionName, Line, LineNo= -1):\r
if CheckFilename != '' and CheckFilename != None:\r
(Root, Ext) = os.path.splitext(CheckFilename)\r
if Ext.upper() != ExtName.upper():\r
LineNo = GetLineNo(ContainerFile, Line)\r
ErrorMsg = "Invalid %s. '%s' is found, but '%s' file is needed" % (SectionName, CheckFilename, ExtName)\r
EdkLogger.error("Parser", PARSER_ERROR, ErrorMsg, Line=LineNo,\r
- File=ContainerFilename, RaiseError = EdkLogger.IsRaiseError)\r
+ File=ContainerFilename, RaiseError=EdkLogger.IsRaiseError)\r
\r
return True\r
\r
#\r
# @retval The file full path if the file exists\r
#\r
-def CheckFileExist(WorkspaceDir, CheckFilename, ContainerFilename, SectionName, Line, LineNo = -1):\r
+def CheckFileExist(WorkspaceDir, CheckFilename, ContainerFilename, SectionName, Line, LineNo= -1):\r
CheckFile = ''\r
if CheckFilename != '' and CheckFilename != None:\r
CheckFile = WorkspaceFile(WorkspaceDir, CheckFilename)\r
LineNo = GetLineNo(ContainerFile, Line)\r
ErrorMsg = "Can't find file '%s' defined in section '%s'" % (CheckFile, SectionName)\r
EdkLogger.error("Parser", PARSER_ERROR, ErrorMsg,\r
- File=ContainerFilename, Line = LineNo, RaiseError = EdkLogger.IsRaiseError)\r
+ File=ContainerFilename, Line=LineNo, RaiseError=EdkLogger.IsRaiseError)\r
\r
return CheckFile\r
\r
# @retval int Index of the line\r
# @retval -1 The line is not found\r
#\r
-def GetLineNo(FileContent, Line, IsIgnoreComment = True):\r
+def GetLineNo(FileContent, Line, IsIgnoreComment=True):\r
LineList = FileContent.splitlines()\r
for Index in range(len(LineList)):\r
if LineList[Index].find(Line) > -1:\r
# @param File: File which has the string\r
# @param Format: Correct format\r
#\r
-def RaiseParserError(Line, Section, File, Format = '', LineNo = -1):\r
+def RaiseParserError(Line, Section, File, Format='', LineNo= -1):\r
if LineNo == -1:\r
LineNo = GetLineNo(open(os.path.normpath(File), 'r').read(), Line)\r
ErrorMsg = "Invalid statement '%s' is found in section '%s'" % (Line, Section)\r
if Format != '':\r
Format = "Correct format is " + Format\r
- EdkLogger.error("Parser", PARSER_ERROR, ErrorMsg, File=File, Line=LineNo, ExtraData=Format, RaiseError = EdkLogger.IsRaiseError)\r
+ EdkLogger.error("Parser", PARSER_ERROR, ErrorMsg, File=File, Line=LineNo, ExtraData=Format, RaiseError=EdkLogger.IsRaiseError)\r
\r
## WorkspaceFile\r
#\r
# @retval string A full path\r
#\r
def WorkspaceFile(WorkspaceDir, Filename):\r
- return os.path.join(NormPath(WorkspaceDir), NormPath(Filename))\r
+ return mws.join(NormPath(WorkspaceDir), NormPath(Filename))\r
\r
## Split string\r
#\r
# Remove comment block\r
#\r
if Line.find(DataType.TAB_COMMENT_EDK_START) > -1:\r
- ReservedLine = GetSplitValueList(Line, DataType.TAB_COMMENT_EDK_START, 1)[0]\r
+ ReservedLine = GetSplitList(Line, DataType.TAB_COMMENT_EDK_START, 1)[0]\r
IsFindBlockComment = True\r
if Line.find(DataType.TAB_COMMENT_EDK_END) > -1:\r
- Line = ReservedLine + GetSplitValueList(Line, DataType.TAB_COMMENT_EDK_END, 1)[1]\r
+ Line = ReservedLine + GetSplitList(Line, DataType.TAB_COMMENT_EDK_END, 1)[1]\r
ReservedLine = ''\r
IsFindBlockComment = False\r
if IsFindBlockComment:\r
#\r
# Get String of a List\r
#\r
-def GetStringOfList(List, Split = ' '):\r
+def GetStringOfList(List, Split=' '):\r
if type(List) != type([]):\r
return List\r
Str = ''\r
\r
def StringToArray(String):\r
if isinstance(String, unicode):\r
- if len(unicode) ==0:\r
+ if len(unicode) == 0:\r
return "{0x00, 0x00}"\r
return "{%s, 0x00, 0x00}" % ", ".join(["0x%02x, 0x00" % ord(C) for C in String])\r
elif String.startswith('L"'):\r
return "{%s, 0x00, 0x00}" % ", ".join(["0x%02x, 0x00" % ord(C) for C in String[2:-1]])\r
elif String.startswith('"'):\r
if String == "\"\"":\r
- return "{0x00}";\r
+ return "{0x00,0x00}"\r
else:\r
- return "{%s, 0x00}" % ", ".join(["0x%02x" % ord(C) for C in String[1:-1]])\r
+ StringLen = len(String[1:-1])\r
+ if StringLen % 2:\r
+ return "{%s, 0x00}" % ", ".join(["0x%02x" % ord(C) for C in String[1:-1]])\r
+ else:\r
+ return "{%s, 0x00,0x00}" % ", ".join(["0x%02x" % ord(C) for C in String[1:-1]])\r
+ elif String.startswith('{'):\r
+ StringLen = len(String.split(","))\r
+ if StringLen % 2:\r
+ return "{%s, 0x00}" % ", ".join([ C for C in String[1:-1].split(',')])\r
+ else:\r
+ return "{%s}" % ", ".join([ C for C in String[1:-1].split(',')])\r
+ \r
else:\r
- return '{%s, 0}' % ', '.join(String.split())\r
+ if len(String.split()) % 2:\r
+ return '{%s, 0}' % ', '.join(String.split())\r
+ else:\r
+ return '{%s, 0,0}' % ', '.join(String.split())\r
\r
def StringArrayLength(String):\r
if isinstance(String, unicode):\r
return (len(String) - 2 + 1)\r
else:\r
return len(String.split()) + 1\r
- \r
+\r
def RemoveDupOption(OptionString, Which="/I", Against=None):\r
OptionList = OptionString.split()\r
ValueList = []\r