BaseTools: Clean up source files

[mirror_edk2.git] / BaseTools / Source / Python / TargetTool / TargetTool.py

## @file\r
# Target Tool Parser\r
#\r
#  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\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
from __future__ import print_function\r
import Common.LongFilePathOs as os\r
import sys\r
import traceback\r
from optparse import OptionParser\r
\r
import Common.EdkLogger as EdkLogger\r
import Common.BuildToolError as BuildToolError\r
from Common.DataType import *\r
from Common.BuildVersion import gBUILD_VERSION\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
\r
# To Do 1.set clean, 2. add item, if the line is disabled.\r
\r
class TargetTool():\r
    def __init__(self, opt, args):\r
        self.WorkSpace = os.path.normpath(os.getenv('WORKSPACE'))\r
        self.Opt       = opt\r
        self.Arg       = args[0]\r
        self.FileName  = os.path.normpath(os.path.join(self.WorkSpace, 'Conf', 'target.txt'))\r
        if os.path.isfile(self.FileName) == False:\r
            print("%s does not exist." % self.FileName)\r
            sys.exit(1)\r
        self.TargetTxtDictionary = {\r
            TAB_TAT_DEFINES_ACTIVE_PLATFORM                            : None,\r
            TAB_TAT_DEFINES_TOOL_CHAIN_CONF                            : None,\r
            TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER               : None,\r
            TAB_TAT_DEFINES_TARGET                                     : None,\r
            TAB_TAT_DEFINES_TOOL_CHAIN_TAG                             : None,\r
            TAB_TAT_DEFINES_TARGET_ARCH                                : None,\r
            TAB_TAT_DEFINES_BUILD_RULE_CONF                            : None,\r
        }\r
        self.LoadTargetTxtFile(self.FileName)\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
            raise ParseError('LoadTargetTxtFile() : No Target.txt file exists.')\r
            return 1\r
\r
#\r
# Convert a text file to a dictionary\r
#\r
    def ConvertTextFileToDict(self, FileName, CommentCharacter, KeySplitCharacter):\r
        """Convert a text file to a dictionary of (name:value) pairs."""\r
        try:\r
            f = open(FileName, 'r')\r
            for Line in f:\r
                if Line.startswith(CommentCharacter) or Line.strip() == '':\r
                    continue\r
                LineList = Line.split(KeySplitCharacter, 1)\r
                if len(LineList) >= 2:\r
                    Key = LineList[0].strip()\r
                    if Key.startswith(CommentCharacter) == False and Key in self.TargetTxtDictionary:\r
                        if Key == TAB_TAT_DEFINES_ACTIVE_PLATFORM or Key == TAB_TAT_DEFINES_TOOL_CHAIN_CONF \\r
                          or Key == TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER \\r
                          or Key == TAB_TAT_DEFINES_ACTIVE_MODULE:\r
                            self.TargetTxtDictionary[Key] = LineList[1].replace('\\', '/').strip()\r
                        elif Key == TAB_TAT_DEFINES_TARGET or Key == TAB_TAT_DEFINES_TARGET_ARCH \\r
                          or Key == TAB_TAT_DEFINES_TOOL_CHAIN_TAG or Key == TAB_TAT_DEFINES_BUILD_RULE_CONF:\r
                            self.TargetTxtDictionary[Key] = LineList[1].split()\r
            f.close()\r
            return 0\r
        except:\r
            last_type, last_value, last_tb = sys.exc_info()\r
            traceback.print_exception(last_type, last_value, last_tb)\r
\r
    def Print(self):\r
        errMsg  = ''\r
        for Key in self.TargetTxtDictionary:\r
            if isinstance(self.TargetTxtDictionary[Key], type([])):\r
                print("%-30s = %s" % (Key, ''.join(elem + ' ' for elem in self.TargetTxtDictionary[Key])))\r
            elif self.TargetTxtDictionary[Key] is None:\r
                errMsg += "  Missing %s configuration information, please use TargetTool to set value!" % Key + os.linesep\r
            else:\r
                print("%-30s = %s" % (Key, self.TargetTxtDictionary[Key]))\r
\r
        if errMsg != '':\r
            print(os.linesep + 'Warning:' + os.linesep + errMsg)\r
\r
    def RWFile(self, CommentCharacter, KeySplitCharacter, Num):\r
        try:\r
            fr = open(self.FileName, 'r')\r
            fw = open(os.path.normpath(os.path.join(self.WorkSpace, 'Conf\\targetnew.txt')), 'w')\r
\r
            existKeys = []\r
            for Line in fr:\r
                if Line.startswith(CommentCharacter) or Line.strip() == '':\r
                    fw.write(Line)\r
                else:\r
                    LineList = Line.split(KeySplitCharacter, 1)\r
                    if len(LineList) >= 2:\r
                        Key = LineList[0].strip()\r
                        if Key.startswith(CommentCharacter) == False and Key in self.TargetTxtDictionary:\r
                            if Key not in existKeys:\r
                                existKeys.append(Key)\r
                            else:\r
                                print("Warning: Found duplicate key item in original configuration files!")\r
\r
                            if Num == 0:\r
                                Line = "%-30s = \n" % Key\r
                            else:\r
                                ret = GetConfigureKeyValue(self, Key)\r
                                if ret is not None:\r
                                    Line = ret\r
                            fw.write(Line)\r
            for key in self.TargetTxtDictionary:\r
                if key not in existKeys:\r
                    print("Warning: %s does not exist in original configuration file" % key)\r
                    Line = GetConfigureKeyValue(self, key)\r
                    if Line is None:\r
                        Line = "%-30s = " % key\r
                    fw.write(Line)\r
\r
            fr.close()\r
            fw.close()\r
            os.remove(self.FileName)\r
            os.rename(os.path.normpath(os.path.join(self.WorkSpace, 'Conf\\targetnew.txt')), self.FileName)\r
\r
        except:\r
            last_type, last_value, last_tb = sys.exc_info()\r
            traceback.print_exception(last_type, last_value, last_tb)\r
\r
def GetConfigureKeyValue(self, Key):\r
    Line = None\r
    if Key == TAB_TAT_DEFINES_ACTIVE_PLATFORM and self.Opt.DSCFILE is not None:\r
        dscFullPath = os.path.join(self.WorkSpace, self.Opt.DSCFILE)\r
        if os.path.exists(dscFullPath):\r
            Line = "%-30s = %s\n" % (Key, self.Opt.DSCFILE)\r
        else:\r
            EdkLogger.error("TagetTool", BuildToolError.FILE_NOT_FOUND,\r
                            "DSC file %s does not exist!" % self.Opt.DSCFILE, RaiseError=False)\r
    elif Key == TAB_TAT_DEFINES_TOOL_CHAIN_CONF and self.Opt.TOOL_DEFINITION_FILE is not None:\r
        tooldefFullPath = os.path.join(self.WorkSpace, self.Opt.TOOL_DEFINITION_FILE)\r
        if os.path.exists(tooldefFullPath):\r
            Line = "%-30s = %s\n" % (Key, self.Opt.TOOL_DEFINITION_FILE)\r
        else:\r
            EdkLogger.error("TagetTool", BuildToolError.FILE_NOT_FOUND,\r
                            "Tooldef file %s does not exist!" % self.Opt.TOOL_DEFINITION_FILE, RaiseError=False)\r
\r
    elif self.Opt.NUM >= 2:\r
        Line = "%-30s = %s\n" % (Key, 'Enable')\r
    elif self.Opt.NUM <= 1:\r
        Line = "%-30s = %s\n" % (Key, 'Disable')\r
    elif Key == TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER and self.Opt.NUM is not None:\r
        Line = "%-30s = %s\n" % (Key, str(self.Opt.NUM))\r
    elif Key == TAB_TAT_DEFINES_TARGET and self.Opt.TARGET is not None:\r
        Line = "%-30s = %s\n" % (Key, ''.join(elem + ' ' for elem in self.Opt.TARGET))\r
    elif Key == TAB_TAT_DEFINES_TARGET_ARCH and self.Opt.TARGET_ARCH is not None:\r
        Line = "%-30s = %s\n" % (Key, ''.join(elem + ' ' for elem in self.Opt.TARGET_ARCH))\r
    elif Key == TAB_TAT_DEFINES_TOOL_CHAIN_TAG and self.Opt.TOOL_CHAIN_TAG is not None:\r
        Line = "%-30s = %s\n" % (Key, self.Opt.TOOL_CHAIN_TAG)\r
    elif Key == TAB_TAT_DEFINES_BUILD_RULE_CONF and self.Opt.BUILD_RULE_FILE is not None:\r
        buildruleFullPath = os.path.join(self.WorkSpace, self.Opt.BUILD_RULE_FILE)\r
        if os.path.exists(buildruleFullPath):\r
            Line = "%-30s = %s\n" % (Key, self.Opt.BUILD_RULE_FILE)\r
        else:\r
            EdkLogger.error("TagetTool", BuildToolError.FILE_NOT_FOUND,\r
                            "Build rule file %s does not exist!" % self.Opt.BUILD_RULE_FILE, RaiseError=False)\r
    return Line\r
\r
VersionNumber = ("0.01" + " " + gBUILD_VERSION)\r
__version__ = "%prog Version " + VersionNumber\r
__copyright__ = "Copyright (c) 2007 - 2018, Intel Corporation  All rights reserved."\r
__usage__ = "%prog [options] {args} \\r
\nArgs:                                                  \\r
\n Clean  clean the all default configuration of target.txt. \\r
\n Print  print the all default configuration of target.txt. \\r
\n Set    replace the default configuration with expected value specified by option."\r
\r
gParamCheck = []\r
def SingleCheckCallback(option, opt_str, value, parser):\r
    if option not in gParamCheck:\r
        setattr(parser.values, option.dest, value)\r
        gParamCheck.append(option)\r
    else:\r
        parser.error("Option %s only allows one instance in command line!" % option)\r
\r
def RangeCheckCallback(option, opt_str, value, parser):\r
    if option not in gParamCheck:\r
        gParamCheck.append(option)\r
        if value < 1 or value > 8:\r
            parser.error("The count of multi-thread is not in valid range of 1 ~ 8.")\r
        else:\r
            setattr(parser.values, option.dest, value)\r
    else:\r
        parser.error("Option %s only allows one instance in command line!" % option)\r
\r
def MyOptionParser():\r
    parser = OptionParser(version=__version__, prog="TargetTool.exe", usage=__usage__, description=__copyright__)\r
    parser.add_option("-a", "--arch", action="append", type="choice", choices=['IA32', 'X64', 'IPF', 'EBC', 'ARM', 'AARCH64', '0'], dest="TARGET_ARCH",\r
        help="ARCHS is one of list: IA32, X64, IPF, ARM, AARCH64 or EBC, which replaces target.txt's TARGET_ARCH definition. To specify more archs, please repeat this option. 0 will clear this setting in target.txt and can't combine with other value.")\r
    parser.add_option("-p", "--platform", action="callback", type="string", dest="DSCFILE", callback=SingleCheckCallback,\r
        help="Specify a DSC file, which replace target.txt's ACTIVE_PLATFORM definition. 0 will clear this setting in target.txt and can't combine with other value.")\r
    parser.add_option("-c", "--tooldef", action="callback", type="string", dest="TOOL_DEFINITION_FILE", callback=SingleCheckCallback,\r
        help="Specify the WORKSPACE relative path of tool_def.txt file, which replace target.txt's TOOL_CHAIN_CONF definition. 0 will clear this setting in target.txt and can't combine with other value.")\r
    parser.add_option("-t", "--target", action="append", type="choice", choices=['DEBUG', 'RELEASE', '0'], dest="TARGET",\r
        help="TARGET is one of list: DEBUG, RELEASE, which replaces target.txt's TARGET definition. To specify more TARGET, please repeat this option. 0 will clear this setting in target.txt and can't combine with other value.")\r
    parser.add_option("-n", "--tagname", action="callback", type="string", dest="TOOL_CHAIN_TAG", callback=SingleCheckCallback,\r
        help="Specify the Tool Chain Tagname, which replaces target.txt's TOOL_CHAIN_TAG definition. 0 will clear this setting in target.txt and can't combine with other value.")\r
    parser.add_option("-r", "--buildrule", action="callback", type="string", dest="BUILD_RULE_FILE", callback=SingleCheckCallback,\r
        help="Specify the build rule configure file, which replaces target.txt's BUILD_RULE_CONF definition. If not specified, the default value Conf/build_rule.txt will be set.")\r
    parser.add_option("-m", "--multithreadnum", action="callback", type="int", dest="NUM", callback=RangeCheckCallback,\r
        help="Specify the multi-thread number which replace target.txt's MAX_CONCURRENT_THREAD_NUMBER. If the value is less than 2, MULTIPLE_THREAD will be disabled. If the value is larger than 1, MULTIPLE_THREAD will be enabled.")\r
    (opt, args)=parser.parse_args()\r
    return (opt, args)\r
\r
if __name__ == '__main__':\r
    EdkLogger.Initialize()\r
    EdkLogger.SetLevel(EdkLogger.QUIET)\r
    if os.getenv('WORKSPACE') is None:\r
        print("ERROR: WORKSPACE should be specified or edksetup script should be executed before run TargetTool")\r
        sys.exit(1)\r
\r
    (opt, args) = MyOptionParser()\r
    if len(args) != 1 or (args[0].lower() != 'print' and args[0].lower() != 'clean' and args[0].lower() != 'set'):\r
        print("The number of args isn't 1 or the value of args is invalid.")\r
        sys.exit(1)\r
    if opt.NUM is not None and opt.NUM < 1:\r
        print("The MAX_CONCURRENT_THREAD_NUMBER must be larger than 0.")\r
        sys.exit(1)\r
    if opt.TARGET is not None and len(opt.TARGET) > 1:\r
        for elem in opt.TARGET:\r
            if elem == '0':\r
                print("0 will clear the TARGET setting in target.txt and can't combine with other value.")\r
                sys.exit(1)\r
    if opt.TARGET_ARCH is not None and len(opt.TARGET_ARCH) > 1:\r
        for elem in opt.TARGET_ARCH:\r
            if elem == '0':\r
                print("0 will clear the TARGET_ARCH setting in target.txt and can't combine with other value.")\r
                sys.exit(1)\r
\r
    try:\r
        FileHandle = TargetTool(opt, args)\r
        if FileHandle.Arg.lower() == 'print':\r
            FileHandle.Print()\r
            sys.exit(0)\r
        elif FileHandle.Arg.lower() == 'clean':\r
            FileHandle.RWFile('#', '=', 0)\r
        else:\r
            FileHandle.RWFile('#', '=', 1)\r
    except Exception as e:\r
        last_type, last_value, last_tb = sys.exc_info()\r
        traceback.print_exception(last_type, last_value, last_tb)\r
\r