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

## @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
# 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
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
##\r
# Import Modules\r
#\r
import re\r
import DataType\r
import os.path\r
import string\r
import EdkLogger as EdkLogger\r
\r
import GlobalData\r
from BuildToolError import *\r
from CommonDataClass.Exceptions import *\r
\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
# Get a value list from a string with multiple values splited with SplitTag\r
# The default SplitTag is DataType.TAB_VALUE_SPLIT\r
# 'AAA|BBB|CCC' -> ['AAA', 'BBB', 'CCC']\r
#\r
# @param String:    The input string to be splitted\r
# @param SplitTag:  The split key, default is DataType.TAB_VALUE_SPLIT\r
# @param MaxSplit:  The max number of split values, default is -1\r
#\r
# @retval list() A list for splitted string\r
#\r
def GetSplitValueList(String, SplitTag=DataType.TAB_VALUE_SPLIT, MaxSplit= -1):\r
    ValueList = []\r
    Last = 0\r
    Escaped = False\r
    InString = False\r
    for Index in range(0, len(String)):\r
        Char = String[Index]\r
\r
        if not Escaped:\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
                if MaxSplit > 0 and len(ValueList) >= MaxSplit:\r
                    break\r
\r
            if Char == '\\' and InString:\r
                Escaped = True\r
            elif Char == '"':\r
                if not InString:\r
                    InString = True\r
                else:\r
                    InString = False\r
        else:\r
            Escaped = False\r
\r
    if Last < len(String):\r
        ValueList.append(String[Last:].strip())\r
    elif Last == len(String):\r
        ValueList.append('')\r
\r
    return ValueList\r
\r
## GetSplitList\r
#\r
# Get a value list from a string with multiple values splited with SplitString\r
# The default SplitTag is DataType.TAB_VALUE_SPLIT\r
# 'AAA|BBB|CCC' -> ['AAA', 'BBB', 'CCC']\r
#\r
# @param String:    The input string to be splitted\r
# @param SplitStr:  The split key, default is DataType.TAB_VALUE_SPLIT\r
# @param MaxSplit:  The max number of split values, default is -1\r
#\r
# @retval list() A list for splitted string\r
#\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
# Find a key's all arches in dict, add the new arch to the list\r
# If not exist any arch, set the arch directly\r
#\r
# @param Dict:  The input value for Dict\r
# @param Key:   The input value for Key\r
# @param Arch:  The Arch to be added or merged\r
#\r
def MergeArches(Dict, Key, Arch):\r
    if Key in Dict.keys():\r
        Dict[Key].append(Arch)\r
    else:\r
        Dict[Key] = Arch.split()\r
\r
## GenDefines\r
#\r
# Parse a string with format "DEFINE <VarName> = <PATH>"\r
# Generate a map Defines[VarName] = PATH\r
# Return False if invalid format\r
#\r
# @param String:   String with DEFINE statement\r
# @param Arch:     Supportted Arch\r
# @param Defines:  DEFINE statement to be parsed\r
#\r
# @retval 0   DEFINE statement found, and valid\r
# @retval 1   DEFINE statement found, but not valid\r
# @retval -1  DEFINE statement not found\r
#\r
def GenDefines(String, Arch, Defines):\r
    if String.find(DataType.TAB_DEFINE + ' ') > -1:\r
        List = String.replace(DataType.TAB_DEFINE + ' ', '').split(DataType.TAB_EQUAL_SPLIT)\r
        if len(List) == 2:\r
            Defines[(CleanString(List[0]), Arch)] = CleanString(List[1])\r
            return 0\r
        else:\r
            return -1\r
\r
    return 1\r
\r
## GenInclude\r
#\r
# Parse a string with format "!include <Filename>"\r
# Return the file path\r
# Return False if invalid format or NOT FOUND\r
#\r
# @param String:        String with INCLUDE statement\r
# @param IncludeFiles:  INCLUDE statement to be parsed\r
# @param Arch:          Supportted Arch\r
#\r
# @retval True\r
# @retval False\r
#\r
def GenInclude(String, IncludeFiles, Arch):\r
    if String.upper().find(DataType.TAB_INCLUDE.upper() + ' ') > -1:\r
        IncludeFile = CleanString(String[String.upper().find(DataType.TAB_INCLUDE.upper() + ' ') + len(DataType.TAB_INCLUDE + ' ') : ])\r
        MergeArches(IncludeFiles, IncludeFile, Arch)\r
        return True\r
    else:\r
        return False\r
\r
## GetLibraryClassesWithModuleType\r
#\r
# Get Library Class definition when no module type defined\r
#\r
# @param Lines:             The content to be parsed\r
# @param Key:               Reserved\r
# @param KeyValues:         To store data after parsing\r
# @param CommentCharacter:  Comment char, used to ignore comment content\r
#\r
# @retval True Get library classes successfully\r
#\r
def GetLibraryClassesWithModuleType(Lines, Key, KeyValues, CommentCharacter):\r
    newKey = SplitModuleType(Key)\r
    Lines = Lines.split(DataType.TAB_SECTION_END, 1)[1]\r
    LineList = Lines.splitlines()\r
    for Line in LineList:\r
        Line = CleanString(Line, CommentCharacter)\r
        if Line != '' and Line[0] != CommentCharacter:\r
            KeyValues.append([CleanString(Line, CommentCharacter), newKey[1]])\r
\r
    return True\r
\r
## GetDynamics\r
#\r
# Get Dynamic Pcds\r
#\r
# @param Lines:             The content to be parsed\r
# @param Key:               Reserved\r
# @param KeyValues:         To store data after parsing\r
# @param CommentCharacter:  Comment char, used to ignore comment content\r
#\r
# @retval True Get Dynamic Pcds successfully\r
#\r
def GetDynamics(Lines, Key, KeyValues, CommentCharacter):\r
    #\r
    # Get SkuId Name List\r
    #\r
    SkuIdNameList = SplitModuleType(Key)\r
\r
    Lines = Lines.split(DataType.TAB_SECTION_END, 1)[1]\r
    LineList = Lines.splitlines()\r
    for Line in LineList:\r
        Line = CleanString(Line, CommentCharacter)\r
        if Line != '' and Line[0] != CommentCharacter:\r
            KeyValues.append([CleanString(Line, CommentCharacter), SkuIdNameList[1]])\r
\r
    return True\r
\r
## SplitModuleType\r
#\r
# Split ModuleType out of section defien to get key\r
# [LibraryClass.Arch.ModuleType|ModuleType|ModuleType] -> [ 'LibraryClass.Arch', ['ModuleType', 'ModuleType', 'ModuleType'] ]\r
#\r
# @param Key:  String to be parsed\r
#\r
# @retval ReturnValue A list for module types\r
#\r
def SplitModuleType(Key):\r
    KeyList = Key.split(DataType.TAB_SPLIT)\r
    #\r
    # Fill in for arch\r
    #\r
    KeyList.append('')\r
    #\r
    # Fill in for moduletype\r
    #\r
    KeyList.append('')\r
    ReturnValue = []\r
    KeyValue = KeyList[0]\r
    if KeyList[1] != '':\r
        KeyValue = KeyValue + DataType.TAB_SPLIT + KeyList[1]\r
    ReturnValue.append(KeyValue)\r
    ReturnValue.append(GetSplitValueList(KeyList[2]))\r
\r
    return ReturnValue\r
\r
## Replace macro in strings list\r
#\r
# This method replace macros used in a given string list. The macros are\r
# given in a dictionary.\r
#\r
# @param StringList         StringList to be processed\r
# @param MacroDefinitions   The macro definitions in the form of dictionary\r
# @param SelfReplacement    To decide whether replace un-defined macro to ''\r
#\r
# @retval NewList           A new string list whose macros are replaced\r
#\r
def ReplaceMacros(StringList, MacroDefinitions={}, SelfReplacement=False):\r
    NewList = []\r
    for String in StringList:\r
        if type(String) == type(''):\r
            NewList.append(ReplaceMacro(String, MacroDefinitions, SelfReplacement))\r
        else:\r
            NewList.append(String)\r
\r
    return NewList\r
\r
## Replace macro in string\r
#\r
# This method replace macros used in given string. The macros are given in a\r
# dictionary.\r
#\r
# @param String             String to be processed\r
# @param MacroDefinitions   The macro definitions in the form of dictionary\r
# @param SelfReplacement    To decide whether replace un-defined macro to ''\r
#\r
# @retval string            The string whose macros are replaced\r
#\r
def ReplaceMacro(String, MacroDefinitions={}, SelfReplacement=False, RaiseError=False):\r
    LastString = String\r
    while String and MacroDefinitions:\r
        MacroUsed = GlobalData.gMacroRefPattern.findall(String)\r
        # no macro found in String, stop replacing\r
        if len(MacroUsed) == 0:\r
            break\r
\r
        for Macro in MacroUsed:\r
            if Macro not in MacroDefinitions:\r
                if RaiseError:\r
                    raise SymbolNotFound("%s not defined" % Macro)\r
                if SelfReplacement:\r
                    String = String.replace("$(%s)" % Macro, '')\r
                continue\r
            String = String.replace("$(%s)" % Macro, MacroDefinitions[Macro])\r
        # in case there's macro not defined\r
        if String == LastString:\r
            break\r
        LastString = String\r
\r
    return String\r
\r
## NormPath\r
#\r
# Create a normal path\r
# And replace DFEINE in the path\r
#\r
# @param Path:     The input value for Path to be converted\r
# @param Defines:  A set for DEFINE statement\r
#\r
# @retval Path Formatted path\r
#\r
def NormPath(Path, Defines={}):\r
    IsRelativePath = False\r
    if Path:\r
        if Path[0] == '.':\r
            IsRelativePath = True\r
        #\r
        # Replace with Define\r
        #\r
        if Defines:\r
            Path = ReplaceMacro(Path, Defines)\r
        #\r
        # To local path format\r
        #\r
        Path = os.path.normpath(Path)\r
\r
    if IsRelativePath and Path[0] != '.':\r
        Path = os.path.join('.', Path)\r
\r
    return Path\r
\r
## CleanString\r
#\r
# Remove comments in a string\r
# Remove spaces\r
#\r
# @param Line:              The string to be cleaned\r
# @param CommentCharacter:  Comment char, used to ignore comment content, default is DataType.TAB_COMMENT_SPLIT\r
#\r
# @retval Path Formatted path\r
#\r
def CleanString(Line, CommentCharacter=DataType.TAB_COMMENT_SPLIT, AllowCppStyleComment=False, BuildOption=False):\r
    #\r
    # remove whitespace\r
    #\r
    Line = Line.strip();\r
    #\r
    # Replace Edk's comment character\r
    #\r
    if AllowCppStyleComment:\r
        Line = Line.replace(DataType.TAB_COMMENT_EDK_SPLIT, CommentCharacter)\r
    #\r
    # remove comments, but we should escape comment character in string\r
    #\r
    InString = False\r
    CommentInString = False\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
            Line = Line[0: Index]\r
            break\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
                    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
                    Line = Line[0:ChIndex] + '\\' + Line[ChIndex:]\r
                    ChIndex = Line.find('#', ChIndex + 2)\r
                else:\r
                    ChIndex = Line.find('#', ChIndex + 1)\r
    #\r
    # remove whitespace again\r
    #\r
    Line = Line.strip();\r
\r
    return Line\r
\r
## CleanString2\r
#\r
# Split statement with comments in a string\r
# Remove spaces\r
#\r
# @param Line:              The string to be cleaned\r
# @param CommentCharacter:  Comment char, used to ignore comment content, default is DataType.TAB_COMMENT_SPLIT\r
#\r
# @retval Path Formatted path\r
#\r
def CleanString2(Line, CommentCharacter=DataType.TAB_COMMENT_SPLIT, AllowCppStyleComment=False):\r
    #\r
    # remove whitespace\r
    #\r
    Line = Line.strip();\r
    #\r
    # Replace Edk's comment character\r
    #\r
    if AllowCppStyleComment:\r
        Line = Line.replace(DataType.TAB_COMMENT_EDK_SPLIT, CommentCharacter)\r
    #\r
    # separate comments and statements, but we should escape comment character in string\r
    #\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
    if Comment:\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
\r
    return Line, Comment\r
\r
## GetMultipleValuesOfKeyFromLines\r
#\r
# Parse multiple strings to clean comment and spaces\r
# The result is saved to KeyValues\r
#\r
# @param Lines:             The content to be parsed\r
# @param Key:               Reserved\r
# @param KeyValues:         To store data after parsing\r
# @param CommentCharacter:  Comment char, used to ignore comment content\r
#\r
# @retval True Successfully executed\r
#\r
def GetMultipleValuesOfKeyFromLines(Lines, Key, KeyValues, CommentCharacter):\r
    Lines = Lines.split(DataType.TAB_SECTION_END, 1)[1]\r
    LineList = Lines.split('\n')\r
    for Line in LineList:\r
        Line = CleanString(Line, CommentCharacter)\r
        if Line != '' and Line[0] != CommentCharacter:\r
            KeyValues += [Line]\r
\r
    return True\r
\r
## GetDefineValue\r
#\r
# Parse a DEFINE statement to get defined value\r
# DEFINE Key Value\r
#\r
# @param String:            The content to be parsed\r
# @param Key:               The key of DEFINE statement\r
# @param CommentCharacter:  Comment char, used to ignore comment content\r
#\r
# @retval string The defined value\r
#\r
def GetDefineValue(String, Key, CommentCharacter):\r
    String = CleanString(String)\r
    return String[String.find(Key + ' ') + len(Key + ' ') : ]\r
\r
## GetHexVerValue\r
#\r
# Get a Hex Version Value\r
#\r
# @param VerString:         The version string to be parsed\r
#\r
#\r
# @retval:      If VerString is incorrectly formatted, return "None" which will break the build.\r
#               If VerString is correctly formatted, return a Hex value of the Version Number (0xmmmmnnnn)\r
#                   where mmmm is the major number and nnnn is the adjusted minor number.\r
#\r
def GetHexVerValue(VerString):\r
    VerString = CleanString(VerString)\r
\r
    if gHumanReadableVerPatt.match(VerString):\r
        ValueList = VerString.split('.')\r
        Major = ValueList[0]\r
        Minor = ValueList[1]\r
        if len(Minor) == 1:\r
            Minor += '0'\r
        DeciValue = (int(Major) << 16) + int(Minor);\r
        return "0x%08x" % DeciValue\r
    elif gHexVerPatt.match(VerString):\r
        return VerString\r
    else:\r
        return None\r
\r
\r
## GetSingleValueOfKeyFromLines\r
#\r
# Parse multiple strings as below to get value of each definition line\r
# Key1 = Value1\r
# Key2 = Value2\r
# The result is saved to Dictionary\r
#\r
# @param Lines:                The content to be parsed\r
# @param Dictionary:           To store data after parsing\r
# @param CommentCharacter:     Comment char, be used to ignore comment content\r
# @param KeySplitCharacter:    Key split char, between key name and key value. Key1 = Value1, '=' is the key split char\r
# @param ValueSplitFlag:       Value split flag, be used to decide if has multiple values\r
# @param ValueSplitCharacter:  Value split char, be used to split multiple values. Key1 = Value1|Value2, '|' is the value split char\r
#\r
# @retval True Successfully executed\r
#\r
def GetSingleValueOfKeyFromLines(Lines, Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter):\r
    Lines = Lines.split('\n')\r
    Keys = []\r
    Value = ''\r
    DefineValues = ['']\r
    SpecValues = ['']\r
\r
    for Line in Lines:\r
        #\r
        # Handle DEFINE and SPEC\r
        #\r
        if Line.find(DataType.TAB_INF_DEFINES_DEFINE + ' ') > -1:\r
            if '' in DefineValues:\r
                DefineValues.remove('')\r
            DefineValues.append(GetDefineValue(Line, DataType.TAB_INF_DEFINES_DEFINE, CommentCharacter))\r
            continue\r
        if Line.find(DataType.TAB_INF_DEFINES_SPEC + ' ') > -1:\r
            if '' in SpecValues:\r
                SpecValues.remove('')\r
            SpecValues.append(GetDefineValue(Line, DataType.TAB_INF_DEFINES_SPEC, CommentCharacter))\r
            continue\r
\r
        #\r
        # Handle Others\r
        #\r
        LineList = Line.split(KeySplitCharacter, 1)\r
        if len(LineList) >= 2:\r
            Key = LineList[0].split()\r
            if len(Key) == 1 and Key[0][0] != CommentCharacter:\r
                #\r
                # Remove comments and white spaces\r
                #\r
                LineList[1] = CleanString(LineList[1], CommentCharacter)\r
                if ValueSplitFlag:\r
                    Value = map(string.strip, LineList[1].split(ValueSplitCharacter))\r
                else:\r
                    Value = CleanString(LineList[1], CommentCharacter).splitlines()\r
\r
                if Key[0] in Dictionary:\r
                    if Key[0] not in Keys:\r
                        Dictionary[Key[0]] = Value\r
                        Keys.append(Key[0])\r
                    else:\r
                        Dictionary[Key[0]].extend(Value)\r
                else:\r
                    Dictionary[DataType.TAB_INF_DEFINES_MACRO][Key[0]] = Value[0]\r
\r
    if DefineValues == []:\r
        DefineValues = ['']\r
    if SpecValues == []:\r
        SpecValues = ['']\r
    Dictionary[DataType.TAB_INF_DEFINES_DEFINE] = DefineValues\r
    Dictionary[DataType.TAB_INF_DEFINES_SPEC] = SpecValues\r
\r
    return True\r
\r
## The content to be parsed\r
#\r
# Do pre-check for a file before it is parsed\r
# Check $()\r
# Check []\r
#\r
# @param FileName:       Used for error report\r
# @param FileContent:    File content to be parsed\r
# @param SupSectionTag:  Used for error report\r
#\r
def PreCheck(FileName, FileContent, SupSectionTag):\r
    LineNo = 0\r
    IsFailed = False\r
    NewFileContent = ''\r
    for Line in FileContent.splitlines():\r
        LineNo = LineNo + 1\r
        #\r
        # Clean current line\r
        #\r
        Line = CleanString(Line)\r
\r
        #\r
        # Remove commented line\r
        #\r
        if Line.find(DataType.TAB_COMMA_SPLIT) == 0:\r
            Line = ''\r
        #\r
        # Check $()\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
\r
        #\r
        # Check []\r
        #\r
        if Line.find('[') > -1 or Line.find(']') > -1:\r
            #\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
\r
        #\r
        # Regenerate FileContent\r
        #\r
        NewFileContent = NewFileContent + Line + '\r\n'\r
\r
    if IsFailed:\r
       EdkLogger.error("Parser", FORMAT_INVALID, Line=LineNo, File=FileName, RaiseError=EdkLogger.IsRaiseError)\r
\r
    return NewFileContent\r
\r
## CheckFileType\r
#\r
# Check if the Filename is including ExtName\r
# Return True if it exists\r
# Raise a error message if it not exists\r
#\r
# @param CheckFilename:      Name of the file to be checked\r
# @param ExtName:            Ext name of the file to be checked\r
# @param ContainerFilename:  The container file which describes the file to be checked, used for error report\r
# @param SectionName:        Used for error report\r
# @param Line:               The line in container file which defines the file to be checked\r
#\r
# @retval True The file type is correct\r
#\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
            ContainerFile = open(ContainerFilename, 'r').read()\r
            if LineNo == -1:\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
\r
    return True\r
\r
## CheckFileExist\r
#\r
# Check if the file exists\r
# Return True if it exists\r
# Raise a error message if it not exists\r
#\r
# @param CheckFilename:      Name of the file to be checked\r
# @param WorkspaceDir:       Current workspace dir\r
# @param ContainerFilename:  The container file which describes the file to be checked, used for error report\r
# @param SectionName:        Used for error report\r
# @param Line:               The line in container file which defines the file to be checked\r
#\r
# @retval The file full path if the file exists\r
#\r
def CheckFileExist(WorkspaceDir, CheckFilename, ContainerFilename, SectionName, Line, LineNo= -1):\r
    CheckFile = ''\r
    if CheckFilename != '' and CheckFilename != None:\r
        CheckFile = WorkspaceFile(WorkspaceDir, CheckFilename)\r
        if not os.path.isfile(CheckFile):\r
            ContainerFile = open(ContainerFilename, 'r').read()\r
            if LineNo == -1:\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
\r
    return CheckFile\r
\r
## GetLineNo\r
#\r
# Find the index of a line in a file\r
#\r
# @param FileContent:  Search scope\r
# @param Line:         Search key\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
    LineList = FileContent.splitlines()\r
    for Index in range(len(LineList)):\r
        if LineList[Index].find(Line) > -1:\r
            #\r
            # Ignore statement in comment\r
            #\r
            if IsIgnoreComment:\r
                if LineList[Index].strip()[0] == DataType.TAB_COMMENT_SPLIT:\r
                    continue\r
            return Index + 1\r
\r
    return -1\r
\r
## RaiseParserError\r
#\r
# Raise a parser error\r
#\r
# @param Line:     String which has error\r
# @param Section:  Used for error report\r
# @param File:     File which has the string\r
# @param Format:   Correct format\r
#\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
\r
## WorkspaceFile\r
#\r
# Return a full path with workspace dir\r
#\r
# @param WorkspaceDir:  Workspace dir\r
# @param Filename:      Relative file name\r
#\r
# @retval string A full path\r
#\r
def WorkspaceFile(WorkspaceDir, Filename):\r
    return os.path.join(NormPath(WorkspaceDir), NormPath(Filename))\r
\r
## Split string\r
#\r
# Revmove '"' which startswith and endswith string\r
#\r
# @param String:  The string need to be splited\r
#\r
# @retval String: The string after removed '""'\r
#\r
def SplitString(String):\r
    if String.startswith('\"'):\r
        String = String[1:]\r
    if String.endswith('\"'):\r
        String = String[:-1]\r
\r
    return String\r
\r
## Convert To Sql String\r
#\r
# 1. Replace "'" with "''" in each item of StringList\r
#\r
# @param StringList:  A list for strings to be converted\r
#\r
def ConvertToSqlString(StringList):\r
    return map(lambda s: s.replace("'", "''") , StringList)\r
\r
## Convert To Sql String\r
#\r
# 1. Replace "'" with "''" in the String\r
#\r
# @param String:  A String to be converted\r
#\r
def ConvertToSqlString2(String):\r
    return String.replace("'", "''")\r
\r
#\r
# Remove comment block\r
#\r
def RemoveBlockComment(Lines):\r
    IsFindBlockComment = False\r
    IsFindBlockCode = False\r
    ReservedLine = ''\r
    NewLines = []\r
\r
    for Line in Lines:\r
        Line = Line.strip()\r
        #\r
        # Remove comment block\r
        #\r
        if Line.find(DataType.TAB_COMMENT_EDK_START) > -1:\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 + GetSplitList(Line, DataType.TAB_COMMENT_EDK_END, 1)[1]\r
            ReservedLine = ''\r
            IsFindBlockComment = False\r
        if IsFindBlockComment:\r
            NewLines.append('')\r
            continue\r
\r
        NewLines.append(Line)\r
    return NewLines\r
\r
#\r
# Get String of a List\r
#\r
def GetStringOfList(List, Split=' '):\r
    if type(List) != type([]):\r
        return List\r
    Str = ''\r
    for Item in List:\r
        Str = Str + Item + Split\r
\r
    return Str.strip()\r
\r
#\r
# Get HelpTextList from HelpTextClassList\r
#\r
def GetHelpTextList(HelpTextClassList):\r
    List = []\r
    if HelpTextClassList:\r
        for HelpText in HelpTextClassList:\r
            if HelpText.String.endswith('\n'):\r
                HelpText.String = HelpText.String[0: len(HelpText.String) - len('\n')]\r
                List.extend(HelpText.String.split('\n'))\r
\r
    return List\r
\r
def StringToArray(String):\r
    if isinstance(String, unicode):\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
        if String == "L\"\"":\r
            return "{0x00, 0x00}"\r
        else:\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
        else:\r
            return "{%s, 0x00}" % ", ".join(["0x%02x" % ord(C) for C in String[1:-1]])\r
    else:\r
        return '{%s, 0}' % ', '.join(String.split())\r
\r
def StringArrayLength(String):\r
    if isinstance(String, unicode):\r
        return (len(String) + 1) * 2 + 1;\r
    elif String.startswith('L"'):\r
        return (len(String) - 3 + 1) * 2\r
    elif String.startswith('"'):\r
        return (len(String) - 2 + 1)\r
    else:\r
        return len(String.split()) + 1\r
\r
def RemoveDupOption(OptionString, Which="/I", Against=None):\r
    OptionList = OptionString.split()\r
    ValueList = []\r
    if Against:\r
        ValueList += Against\r
    for Index in range(len(OptionList)):\r
        Opt = OptionList[Index]\r
        if not Opt.startswith(Which):\r
            continue\r
        if len(Opt) > len(Which):\r
            Val = Opt[len(Which):]\r
        else:\r
            Val = ""\r
        if Val in ValueList:\r
            OptionList[Index] = ""\r
        else:\r
            ValueList.append(Val)\r
    return " ".join(OptionList)\r
\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    pass\r
\r