BaseTools: Add new RegExp for future use

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

## @file\r
# This is the base class for applications that operate on an EDK II Workspace \r
#\r
# Copyright (c) 2007 - 2014, 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 Common.LongFilePathOs as os, sys, time\r
from DataType import *\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
\r
## EdkIIWorkspace\r
#\r
# Collect WorkspaceDir from the environment, the Verbose command line flag, and detect an icon bitmap file.\r
# \r
# @var StartTime:       Time of build system starting\r
# @var PrintRunTime:    Printable time of build system running\r
# @var PrintRunStatus:  Printable status of build system running\r
# @var RunStatus:       Status of build system running\r
#\r
class EdkIIWorkspace:\r
    def __init__(self):\r
        self.StartTime = time.time()\r
        self.PrintRunTime = False\r
        self.PrintRunStatus = False\r
        self.RunStatus = ''\r
        \r
        #\r
        # Check environment valiable 'WORKSPACE'\r
        #\r
        if os.environ.get('WORKSPACE') == None:\r
            print 'ERROR: WORKSPACE not defined.    Please run EdkSetup from the EDK II install directory.'\r
            return False\r
\r
        self.CurrentWorkingDir = os.getcwd()\r
        \r
        self.WorkspaceDir = os.path.realpath(os.environ.get('WORKSPACE'))\r
        (Drive, Path) = os.path.splitdrive(self.WorkspaceDir)\r
        if Drive == '':\r
            (Drive, CwdPath) = os.path.splitdrive(self.CurrentWorkingDir)\r
            if Drive != '':\r
                self.WorkspaceDir = Drive + Path\r
        else:\r
            self.WorkspaceDir = Drive.upper() + Path\r
\r
        self.WorkspaceRelativeWorkingDir = self.WorkspaceRelativePath (self.CurrentWorkingDir)\r
            \r
        try:\r
            #\r
            # Load TianoCoreOrgLogo, used for GUI tool\r
            #\r
            self.Icon = wx.Icon(self.WorkspaceFile('tools/Python/TianoCoreOrgLogo.gif'), wx.BITMAP_TYPE_GIF)\r
        except:\r
            self.Icon = None\r
            \r
        self.Verbose = False\r
        for Arg in sys.argv:\r
            if Arg.lower() == '-v':\r
                self.Verbose = True\r
    \r
    ## Close build system\r
    #\r
    # Close build system and print running time and status\r
    #\r
    def Close(self):\r
        if self.PrintRunTime:\r
            Seconds = int(time.time() - self.StartTime)\r
            if Seconds < 60:\r
                print 'Run Time: %d seconds' % (Seconds)\r
            else:\r
                Minutes = Seconds / 60\r
                Seconds = Seconds % 60\r
                if Minutes < 60:\r
                    print 'Run Time: %d minutes %d seconds' % (Minutes, Seconds)\r
                else:\r
                    Hours = Minutes / 60\r
                    Minutes = Minutes % 60\r
                    print 'Run Time: %d hours %d minutes %d seconds' % (Hours, Minutes, Seconds)\r
        if self.RunStatus != '':\r
            print self.RunStatus\r
\r
    ## Convert to a workspace relative filename\r
    #\r
    # Convert a full path filename to a workspace relative filename.\r
    #\r
    # @param FileName:  The filename to be Converted\r
    #\r
    # @retval None    Workspace dir is not found in the full path\r
    # @retval string  The relative filename\r
    #\r
    def WorkspaceRelativePath(self, FileName):\r
        FileName = os.path.realpath(FileName)\r
        if FileName.find(self.WorkspaceDir) != 0:\r
            return None\r
        return FileName.replace (self.WorkspaceDir, '').strip('\\').strip('/')\r
\r
    ## Convert to a full path filename\r
    #\r
    # Convert a workspace relative filename to a full path filename.\r
    #\r
    # @param FileName:  The filename to be Converted\r
    #\r
    # @retval string  The full path filename\r
    #\r
    def WorkspaceFile(self, FileName):\r
        return os.path.realpath(mws.join(self.WorkspaceDir,FileName))\r
\r
    ## Convert to a real path filename\r
    #\r
    # Convert ${WORKSPACE} to real path\r
    #\r
    # @param FileName:  The filename to be Converted\r
    #\r
    # @retval string  The full path filename\r
    #\r
    def WorkspacePathConvert(self, FileName):\r
        return os.path.realpath(FileName.replace(TAB_WORKSPACE, self.WorkspaceDir))\r
\r
    ## Convert XML into a DOM\r
    #\r
    # Parse an XML file into a DOM and return the DOM.\r
    #\r
    # @param FileName:  The filename to be parsed\r
    #\r
    # @retval XmlParseFile (self.WorkspaceFile(FileName))\r
    #\r
    def XmlParseFile (self, FileName):\r
        if self.Verbose:\r
            print FileName\r
        return XmlParseFile (self.WorkspaceFile(FileName))\r
\r
    ## Convert a XML section\r
    #\r
    # Parse a section of an XML file into a DOM(Document Object Model) and return the DOM.\r
    #\r
    # @param FileName:    The filename to be parsed\r
    # @param SectionTag:  The tag name of the section to be parsed\r
    #\r
    # @retval XmlParseFileSection (self.WorkspaceFile(FileName), SectionTag)\r
    #\r
    def XmlParseFileSection (self, FileName, SectionTag):\r
        if self.Verbose:\r
            print FileName\r
        return XmlParseFileSection (self.WorkspaceFile(FileName), SectionTag)\r
\r
    ## Save a XML file\r
    #\r
    # Save a DOM(Document Object Model) into an XML file.\r
    #\r
    # @param Dom:       The Dom to be saved\r
    # @param FileName:  The filename\r
    #\r
    # @retval XmlSaveFile (Dom, self.WorkspaceFile(FileName))\r
    #\r
    def XmlSaveFile (self, Dom, FileName):\r
        if self.Verbose:\r
            print FileName\r
        return XmlSaveFile (Dom, self.WorkspaceFile(FileName))\r
\r
    ## Convert Text File To Dictionary\r
    #\r
    # Convert a workspace relative text file to a dictionary of (name:value) pairs.\r
    #\r
    # @param FileName:             Text filename\r
    # @param Dictionary:           Dictionary to store data\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 ConvertTextFileToDictionary(self.WorkspaceFile(FileName), Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter)\r
    #\r
    def ConvertTextFileToDictionary(self, FileName, Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter):\r
        if self.Verbose:\r
            print FileName\r
        return ConvertTextFileToDictionary(self.WorkspaceFile(FileName), Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter)\r
\r
    ## Convert Dictionary To Text File\r
    #\r
    # Convert a dictionary of (name:value) pairs to a workspace relative text file.\r
    #\r
    # @param FileName:             Text filename\r
    # @param Dictionary:           Dictionary to store data\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 ConvertDictionaryToTextFile(self.WorkspaceFile(FileName), Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter)\r
    #\r
    def ConvertDictionaryToTextFile(self, FileName, Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter):\r
        if self.Verbose:\r
            print FileName\r
        return ConvertDictionaryToTextFile(self.WorkspaceFile(FileName), Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter)\r
\r
## Convert Text File To Dictionary\r
#\r
# Convert a text file to a dictionary of (name:value) pairs.\r
#\r
# @param FileName:             Text filename\r
# @param Dictionary:           Dictionary to store data\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  Convert successfully\r
# @retval False Open file failed\r
#\r
def ConvertTextFileToDictionary(FileName, Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter):\r
    try:\r
        F = open(FileName, 'r')\r
    except:\r
        return False\r
    Keys = []\r
    for Line in F:\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 and Key[0] not in Keys:\r
                if ValueSplitFlag:\r
                    Dictionary[Key[0]] = LineList[1].replace('\\', '/').split(ValueSplitCharacter)\r
                else:\r
                    Dictionary[Key[0]] = LineList[1].strip().replace('\\', '/')\r
                Keys += [Key[0]]\r
    F.close()\r
    return True\r
\r
## Convert Dictionary To Text File\r
#\r
# Convert a dictionary of (name:value) pairs to a text file.\r
#\r
# @param FileName:             Text filename\r
# @param Dictionary:           Dictionary to store data\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  Convert successfully\r
# @retval False Open file failed\r
#\r
def ConvertDictionaryToTextFile(FileName, Dictionary, CommentCharacter, KeySplitCharacter, ValueSplitFlag, ValueSplitCharacter):\r
    try:\r
        F = open(FileName, 'r')\r
        Lines = []\r
        Lines = F.readlines()\r
        F.close()\r
    except:\r
        Lines = []\r
    Keys = Dictionary.keys()\r
    MaxLength = 0\r
    for Key in Keys:\r
        if len(Key) > MaxLength:\r
            MaxLength = len(Key)\r
    Index = 0\r
    for Line in Lines:\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 and Key[0] in Dictionary:\r
                if ValueSplitFlag:\r
                    Line = '%-*s %c %s\n' % (MaxLength, Key[0], KeySplitCharacter, ' '.join(Dictionary[Key[0]]))\r
                else:\r
                    Line = '%-*s %c %s\n' % (MaxLength, Key[0], KeySplitCharacter, Dictionary[Key[0]])\r
                Lines.pop(Index)\r
                if Key[0] in Keys:\r
                    Lines.insert(Index, Line)\r
                    Keys.remove(Key[0])\r
        Index += 1\r
    for RemainingKey in Keys:\r
        if ValueSplitFlag:\r
            Line = '%-*s %c %s\n' % (MaxLength, RemainingKey, KeySplitCharacter, ' '.join(Dictionary[RemainingKey]))\r
        else:\r
            Line = '%-*s %c %s\n' % (MaxLength, RemainingKey, KeySplitCharacter, Dictionary[RemainingKey])\r
        Lines.append(Line)\r
    try:\r
        F = open(FileName, 'w')\r
    except:\r
        return False\r
    F.writelines(Lines)\r
    F.close()\r
    return True\r
\r
## Create a new directory\r
#\r
# @param Directory:           Directory to be created\r
#\r
def CreateDirectory(Directory):\r
    if not os.access(Directory, os.F_OK):\r
        os.makedirs (Directory)\r
\r
## Create a new file\r
#\r
# @param Directory:  Directory to be created\r
# @param FileName:   Filename to be created\r
# @param Mode:       The mode of open file, defautl is 'w'\r
#\r
def CreateFile(Directory, FileName, Mode='w'):\r
    CreateDirectory (Directory)\r
    return open(os.path.join(Directory, FileName), Mode)\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
    # Nothing to do here. Could do some unit tests\r
    pass