Sync EDKII BaseTools to BaseTools project r1971

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

## @file\r
# This file is used to define each component of Target.txt file\r
#\r
# Copyright (c) 2007, 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 os\r
import EdkLogger\r
import DataType\r
from BuildToolError import *\r
import GlobalData\r
\r
gDefaultTargetTxtFile = "Conf/target.txt"\r
\r
## TargetTxtClassObject\r
#\r
# This class defined content used in file target.txt\r
#\r
# @param object:             Inherited from object class\r
# @param Filename:           Input value for full path of target.txt\r
#\r
# @var TargetTxtDictionary:  To store keys and values defined in target.txt\r
#\r
class TargetTxtClassObject(object):\r
    def __init__(self, Filename = None):\r
        self.TargetTxtDictionary = {\r
            DataType.TAB_TAT_DEFINES_ACTIVE_PLATFORM                            : '',\r
            DataType.TAB_TAT_DEFINES_ACTIVE_MODULE                              : '',\r
            DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF                            : '',\r
            DataType.TAB_TAT_DEFINES_MULTIPLE_THREAD                            : '',\r
            DataType.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER               : '',\r
            DataType.TAB_TAT_DEFINES_TARGET                                     : [],\r
            DataType.TAB_TAT_DEFINES_TOOL_CHAIN_TAG                             : [],\r
            DataType.TAB_TAT_DEFINES_TARGET_ARCH                                : [],\r
            DataType.TAB_TAT_DEFINES_BUILD_RULE_CONF                            : '',\r
        }\r
        if Filename != None:\r
            self.LoadTargetTxtFile(Filename)\r
\r
    ## LoadTargetTxtFile\r
    #\r
    # Load target.txt file and parse it, return a set structure to store keys and values\r
    #\r
    # @param Filename:  Input value for full path of target.txt\r
    #\r
    # @retval set() A set structure to store keys and values\r
    # @retval 1     Error happenes in parsing\r
    #\r
    def LoadTargetTxtFile(self, Filename):\r
        if os.path.exists(Filename) and os.path.isfile(Filename):\r
             return self.ConvertTextFileToDict(Filename, '#', '=')\r
        else:\r
            EdkLogger.error("Target.txt Parser", FILE_NOT_FOUND, ExtraData=Filename)\r
            return 1\r
\r
    ## ConvertTextFileToDict\r
    #\r
    # Convert a text file to a dictionary of (name:value) pairs.\r
    # The data is saved to self.TargetTxtDictionary\r
    #\r
    # @param FileName:             Text filename\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
    #\r
    # @retval 0 Convert successfully\r
    # @retval 1 Open file failed\r
    #\r
    def ConvertTextFileToDict(self, FileName, CommentCharacter, KeySplitCharacter):\r
        F = None\r
        try:\r
            F = open(FileName,'r')\r
        except:\r
            EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=FileName)\r
            if F != None:\r
                F.close()\r
\r
        for Line in F:\r
            Line = Line.strip()\r
            if Line.startswith(CommentCharacter) or Line == '':\r
                continue\r
\r
            LineList = Line.split(KeySplitCharacter, 1)\r
            Key = LineList[0].strip()\r
            if len(LineList) == 2:\r
                Value = LineList[1].strip()\r
            else:\r
                Value = ""\r
\r
            if Key in [DataType.TAB_TAT_DEFINES_ACTIVE_PLATFORM, DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF, \\r
                       DataType.TAB_TAT_DEFINES_ACTIVE_MODULE, DataType.TAB_TAT_DEFINES_BUILD_RULE_CONF]:\r
                self.TargetTxtDictionary[Key] = Value.replace('\\', '/')\r
            elif Key in [DataType.TAB_TAT_DEFINES_TARGET, DataType.TAB_TAT_DEFINES_TARGET_ARCH, \\r
                         DataType.TAB_TAT_DEFINES_TOOL_CHAIN_TAG]:\r
                self.TargetTxtDictionary[Key] = Value.split()\r
            elif Key == DataType.TAB_TAT_DEFINES_MULTIPLE_THREAD:\r
                if Value not in ["Enable", "Disable"]:\r
                    EdkLogger.error("build", FORMAT_INVALID, "Invalid setting of [%s]: %s." % (Key, Value),\r
                                    ExtraData="\tSetting must be one of [Enable, Disable]",\r
                                    File=FileName)\r
                self.TargetTxtDictionary[Key] = Value\r
            elif Key == DataType.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER:\r
                try:\r
                    V = int(Value, 0)\r
                except:\r
                    EdkLogger.error("build", FORMAT_INVALID, "Invalid number of [%s]: %s." % (Key, Value),\r
                                    File=FileName)\r
                self.TargetTxtDictionary[Key] = Value\r
            #elif Key not in GlobalData.gGlobalDefines:\r
            #    GlobalData.gGlobalDefines[Key] = Value\r
\r
        F.close()\r
        return 0\r
\r
    ## Print the dictionary\r
    #\r
    # Print all items of dictionary one by one\r
    #\r
    # @param Dict:  The dictionary to be printed\r
    #\r
    def printDict(Dict):\r
        if Dict != None:\r
            KeyList = Dict.keys()\r
            for Key in KeyList:\r
                if Dict[Key] != '':\r
                    print Key + ' = ' + str(Dict[Key])\r
\r
    ## Print the dictionary\r
    #\r
    # Print the items of dictionary which matched with input key\r
    #\r
    # @param list:  The dictionary to be printed\r
    # @param key:   The key of the item to be printed\r
    #\r
    def printList(Key, List):\r
        if type(List) == type([]):\r
            if len(List) > 0:\r
                if Key.find(TAB_SPLIT) != -1:\r
                    print "\n" + Key\r
                    for Item in List:\r
                        print Item\r
## TargetTxtDict\r
#\r
# Load target.txt in input workspace dir\r
#\r
# @param WorkSpace:  Workspace dir\r
#\r
# @retval Target An instance of TargetTxtClassObject() with loaded target.txt\r
#\r
def TargetTxtDict(WorkSpace):\r
    Target = TargetTxtClassObject()\r
    Target.LoadTargetTxtFile(os.path.normpath(os.path.join(WorkSpace, gDefaultTargetTxtFile)))\r
    return Target\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
    Target = TargetTxtDict(os.getenv("WORKSPACE"))\r
    print Target.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER]\r
    print Target.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_TARGET]\r
    print Target.TargetTxtDictionary\r