sl@0: 
sl@0: # Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: # All rights reserved.
sl@0: # This component and the accompanying materials are made available
sl@0: # under the terms of "Eclipse Public License v1.0"
sl@0: # which accompanies this distribution, and is available
sl@0: # at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: #
sl@0: # Initial Contributors:
sl@0: # Nokia Corporation - initial contribution.
sl@0: #
sl@0: # Contributors:
sl@0: #
sl@0: # Description:
sl@0: # mmbuild2 - python script intended to replace mmbuild.pl
sl@0: #
sl@0: 
sl@0: from optparse import (make_option,OptionParser)
sl@0: import sys
sl@0: import os
sl@0: import subprocess
sl@0: import MbcUtils
sl@0: 
sl@0: # some literals. TODO - use explicit type?
sl@0: _KAll = "all"
sl@0: _KMmf = "mmf"
sl@0: _KMisc = "misc"
sl@0: _KIcl = "icl"
sl@0: 
sl@0: _KMainTempConfig = ".config.xml"
sl@0: _KTestTempConfig = ".testconfig.xml"
sl@0: _KTestBuildTempConfig = ".testbuildconfig.xml"
sl@0: 
sl@0: class Unimplemented(Exception):
sl@0:     """Raised for invalid commands"""
sl@0: 
sl@0:     def __init__(self, msg):
sl@0:         self.__msg = msg
sl@0: 
sl@0:     def __str__(self):
sl@0:         return self.__msg
sl@0: 
sl@0: class Script(object):
sl@0: 
sl@0: 
sl@0:     # TODO this option_list should be replaced by add_option calls to parameter
sl@0:     # option_list parameter to OptionParser is down as deprecated
sl@0:     option_table = [
sl@0:         make_option ("-t", "--test",
sl@0:                      action="store_true", dest="buildTest", default=False,
sl@0:                      help="""build test code rather than main code (without -b, that built by "abld build" or equiv)"""),
sl@0:         make_option ("-b", "--testBuild",
sl@0:                      action="store_true", dest="buildTestBuild", default=False,
sl@0:                      help="""when given with -t, build that code that requires "abld test build" """),
sl@0:          make_option ("-x", "--additional", "--opt", "--extra",
sl@0:                      action="store_true", dest="extra", default=False,
sl@0:                      help="build additional modules (from Xopt.mbc files)"),
sl@0:         make_option ("-i", "--icl",
sl@0:                      action="store_const", const=_KIcl, dest="toBuild", default=_KAll,
sl@0:                      help="build icl modules only"),
sl@0:         make_option ("-m", "--mmf",
sl@0:                      action="store_const", const=_KMmf, dest="toBuild", default=_KAll,
sl@0:                      help="build mmf modules only"),
sl@0:         make_option ("-c", "--misc",
sl@0:                      action="store_const", const=_KMisc, dest="toBuild", default=_KAll,
sl@0:                      help="build misc modules only"),
sl@0:         make_option ("-f", "--full", "--all",
sl@0:                      action="store_const", const=_KAll, dest="toBuild", default=_KAll,
sl@0:                      help="build all modules (which depends on if -x is given too)"),
sl@0:         make_option ("-k", "--keepgoing",
sl@0:                      action="store_true", dest="keepgoing", default=False,
sl@0:                      help="keep going if errors are found"),
sl@0:         make_option ("-g", "--gccxml",
sl@0:                      action="store_true", dest="gccxml", default=False,
sl@0:                      help="build for gccxml"),
sl@0:         make_option ("-s", "--skipmake",
sl@0:                      action="store_true", dest="skipmake", default=False,
sl@0:                      help="skip building makefile (ignored)"),
sl@0:         make_option ("--iclTestdata",
sl@0:                      action="store_true", dest="icl_tests", default=False,
sl@0:                      help="build ICL Tests"),
sl@0:         ]
sl@0: 
sl@0:     description = \
sl@0: """Script for selection appropriate set of multimedia
sl@0: components and build them together, so build order does not matter.
sl@0: One, and only one of "setup", "build" or "clean" must be given.
sl@0: """
sl@0: 
sl@0:     def __init__(self):
sl@0:         # need to implement commands as property and not class constant or
sl@0:         # we get a forward declaration problem
sl@0:         self.iCommands = {"setup": self.doSetup, "build": self.doBuild, "clean": self.doClean}
sl@0:         self.iOptions = None
sl@0:         self.iProdCodeList = []
sl@0:         self.iTestCodeList = []
sl@0:         self.iTestBuildCodeList = []
sl@0:         self.iOptionParser = None
sl@0:         self.iDebug = False
sl@0: 
sl@0:     def main(self):
sl@0:         "main function of script"
sl@0:         self.iOptionParser = OptionParser(
sl@0:             option_list = Script.option_table,
sl@0:             usage="%prog [-t [-b]] [-i|-m|-c|-f] (setup|build [winscw]|clean)",
sl@0:             description = Script.description
sl@0:             )
sl@0:         (self.iOptions, args) = self.iOptionParser.parse_args()
sl@0: 
sl@0:         self.DebugPrint (str(self.iOptions))
sl@0:         self.DebugPrint (str(args))
sl@0: 
sl@0:         if (len(args)==0 or not args[0] in self.iCommands or
sl@0:                 not self.CheckOptions()):
sl@0:             self.iOptionParser.print_usage()
sl@0:             return -1
sl@0: 
sl@0:         remainingArgs = args[1:len(args)]
sl@0: 
sl@0:         return self.iCommands[args[0]](remainingArgs) # effective switch to doBuild, doSetup or doClean
sl@0: 
sl@0:     def CheckOptions(self):
sl@0:         "Check for any invalid option combinations. Warn about ignored ones etc"
sl@0:         if self.iOptions.skipmake:
sl@0:             print ("Warning ignoring -s - option is no longer valid in raptor version")
sl@0:         if not self.iOptions.buildTest and self.iOptions.buildTestBuild:
sl@0:             return False # can't do -b without -t
sl@0:         return True # all other combinations OK
sl@0: 
sl@0:     def doBuild(self, remainingArgs):
sl@0:         # if we have a remainingArg, only "winscw" is allowed
sl@0:         if not (len(remainingArgs)==0 or len(remainingArgs)==1 and remainingArgs[0]=="winscw"):
sl@0:             self.iOptionParser.print_usage()
sl@0:             return -1
sl@0: 
sl@0:         # for normal build need to run "sbs -s .config.xml build"
sl@0:         # for test build need to run "sbs -s .testconfig.xml build"
sl@0:         # use --logfile=- to send output to stdout instead of log file
sl@0:         configFile = _KMainTempConfig
sl@0:         testBuild = False
sl@0:         if self.iOptions.buildTest:
sl@0:             if not self.iOptions.buildTestBuild:
sl@0:                 # build test config instead when -t etc given
sl@0:                 configFile = _KTestTempConfig
sl@0:             else:
sl@0:                 # build test config instead when -t -b etc given
sl@0:                 configFile = _KTestBuildTempConfig
sl@0:                 testBuild = True
sl@0:         sbs_command = self.sbsCommand()
sl@0:         commands = [sbs_command, "-s", configFile]
sl@0:         commands += ["--logfile=-"] # send output to stdout
sl@0:         if self.iOptions.keepgoing:
sl@0:             commands += ["--keepgoing"]
sl@0:         if testBuild:
sl@0:             commands += ["--config=winscw.test"]
sl@0:         else:
sl@0:             commands += ["--config=winscw"]
sl@0:         if not(len(remainingArgs)>0 and remainingArgs[0]=="winscw"):
sl@0:             # not the winscw scenario - we want both winscw and armv5
sl@0:             if testBuild:
sl@0:                 commands += ["--config=armv5.test"]
sl@0:             else:
sl@0:                 commands += ["--config=armv5"]
sl@0:         commands += ["--filters=FilterSquashLog"] # reduce log size
sl@0:         commands += ["--tries=2"] # retry on failure - e.g. for license fails
sl@0:         commands += ["build"]
sl@0:         self.DebugPrint("""command="%s" """ % str(commands))
sl@0:         print "------------------ sbs start : %s" % str(commands)
sl@0:         sys.stdout.flush() # flush any output here so appears correct in log
sl@0:         subprocess.check_call(commands) # raises exception on error
sl@0:         print "------------------ sbs end"
sl@0:         return 0
sl@0: 
sl@0:     def sbsCommand(self):
sl@0:         "sbs command - that can be used by subprocess"
sl@0:         # For some reason, have to work out batch file to run by longhand
sl@0:         # rather than just saying "sbs" and letting command work it out.
sl@0:         # Could use sys.command() instead, but that is deprecated
sl@0:         sbs_home = os.getenv("SBS_HOME")
sl@0:         assert sbs_home, "SBS_HOME must be defined to use this script"
sl@0:         sbs_command = os.path.join(sbs_home, "bin", "sbs.bat")
sl@0:         return sbs_command
sl@0: 
sl@0:     def doSetup(self, remainingArgs):
sl@0:         if len(remainingArgs)!=0:
sl@0:             self.iOptionParser.print_usage()
sl@0:             return -1
sl@0: 
sl@0:         self.buildMbcLists()
sl@0: 
sl@0:         self.DebugPrint ("prodCodeList=%s" % str(self.iProdCodeList))
sl@0:         self.DebugPrint ("testCodeList=%s" % str(self.iTestCodeList))
sl@0:         self.DebugPrint ("testBuildCodeList=%s" % str(self.iTestBuildCodeList))
sl@0: 
sl@0:         mbcParser = MbcUtils.MbcParser(self.iProdCodeList)
sl@0:         folders = mbcParser()
sl@0:         self.DebugPrint ("folders=%s" % str (folders))
sl@0:         getFolderList = MbcUtils.GetFolderList(folders)
sl@0:         groupFolders = getFolderList()
sl@0:         self.DebugPrint ("prodCodeFolderList=%s" % str(groupFolders))
sl@0: 
sl@0:         generator = MbcUtils.ConfigFileGenerator(groupFolders, _KMainTempConfig)
sl@0:         generator.write()
sl@0: 
sl@0:         mbcParser = MbcUtils.MbcParser(self.iTestCodeList)
sl@0:         folders = mbcParser()
sl@0:         self.DebugPrint ("testfolders=%s" % str (folders))
sl@0:         getFolderList = MbcUtils.GetFolderList(folders)
sl@0:         groupFolders = getFolderList()
sl@0:         self.DebugPrint ("testCodeFolderList=%s" % str(groupFolders))
sl@0: 
sl@0:         generator = MbcUtils.ConfigFileGenerator(groupFolders, _KTestTempConfig)
sl@0:         generator.write()
sl@0: 
sl@0:         mbcParser = MbcUtils.MbcParser(self.iTestBuildCodeList)
sl@0:         folders = mbcParser()
sl@0:         self.DebugPrint ("testBuildfolders=%s" % str (folders))
sl@0:         getFolderList = MbcUtils.GetFolderList(folders)
sl@0:         groupFolders = getFolderList()
sl@0:         self.DebugPrint ("testBuildCodeFolderList=%s" % str(groupFolders))
sl@0: 
sl@0:         generator = MbcUtils.ConfigFileGenerator(groupFolders, _KTestBuildTempConfig)
sl@0:         generator.write()
sl@0:         return 0
sl@0: 
sl@0:     def buildMbcLists(self):
sl@0:         # some boolean values
sl@0:         want_mmf = self.iOptions.toBuild in [_KAll, _KMmf];
sl@0:         want_icl = self.iOptions.toBuild in [_KAll, _KIcl];
sl@0:         want_misc = self.iOptions.toBuild in [_KAll, _KMisc];
sl@0:         want_extra = self.iOptions.extra
sl@0:         want_icl_tests = self.iOptions.icl_tests
sl@0: 
sl@0:         # now build up the lists depending on which "component" we want
sl@0:         # perhaps this should be reworked as a table, but not obvious as to how
sl@0:         self.iTestCodeList += ["AllTests.mbc", "TestFrameworkTest.mbc",
sl@0:                                "targettools.mbc"]
sl@0:         if want_mmf:
sl@0:             self.iProdCodeList += ["mmf.mbc"]
sl@0:             self.iTestCodeList += ["mmfTest.mbc"]
sl@0:             self.iTestBuildCodeList += ["mmfTestBuild.mbc"]
sl@0:             # assume mmfPhys and mmfOptPhys can currently be ignored
sl@0:             # they should generate another list and be built as special cases
sl@0:             # self.iProdCodeList += ["mmfPhys.mbc"]
sl@0:             if want_extra:
sl@0:                 self.iProdCodeList += ["mmfOpt.mbc"]
sl@0:                 self.iTestCodeList += ["mmfOptTest.mbc"]
sl@0:                 self.iTestBuildCodeList += ["mmfOptTestBuild.mbc"]
sl@0:                 # self.iProdCodeList += ["mmfOptPhys.mbc"]
sl@0:             else:
sl@0:                 self.iTestCodeList += ["mmfNotOptTest.mbc"]
sl@0:         if want_icl:
sl@0:             self.iProdCodeList += ["icl.mbc"]
sl@0:             if want_icl_tests:
sl@0:             	self.iTestCodeList += ["iclTest.mbc"]
sl@0:             	self.iTestBuildCodeList += ["iclTestBuild.mbc"]
sl@0:             	if want_extra:
sl@0:             		self.iTestCodeList += ["iclOptTest.mbc"]
sl@0:             		self.iTestBuildCodeList += ["iclOptTestBuild.mbc"]
sl@0:             if want_extra:
sl@0:                 self.iProdCodeList += ["iclOpt.mbc"]   
sl@0:         if want_misc:
sl@0:             self.iProdCodeList += ["misc.mbc"]
sl@0:             self.iTestCodeList += ["miscTest.mbc"]
sl@0:             self.iTestBuildCodeList += ["miscTestBuild.mbc"]
sl@0:             if want_extra:
sl@0:                 self.iProdCodeList += ["miscOpt.mbc"]
sl@0:                 self.iTestCodeList += ["miscOptTest.mbc"]
sl@0:                 self.iTestBuildCodeList += ["miscOptTestBuild.mbc"]
sl@0: 
sl@0:     def doClean(self, remainingArgs):
sl@0:         "clean is called. Note -t clean means clean test code too, not instead"
sl@0:         # for normal clean need to run "sbs -s .config.xml clean"
sl@0:         # for test clean need to run "sbs -s .testconfig.xml clean"
sl@0:         # use --logfile=- to send output to stdout instead of log file
sl@0:         whatToClean = [_KMainTempConfig]
sl@0:         if self.iOptions.buildTest:
sl@0:             whatToClean += [_KTestTempConfig]
sl@0:         for configFile in whatToClean:
sl@0:             sbs_command = self.sbsCommand()
sl@0:             commands = [sbs_command, "-s", configFile]
sl@0:             commands += ["--logfile=-"] # send output to stdout
sl@0:             commands += ["reallyclean"]
sl@0:             self.DebugPrint ("""command="%s" """ % str(commands))
sl@0:             subprocess.check_call(commands) # raises exception on error
sl@0:         return 0
sl@0: 
sl@0:     def DebugPrint(self, str):
sl@0:         "print a string if self.iDebug is set - would be turned on manually"
sl@0:         if self.iDebug:
sl@0:             print(str)
sl@0: 
sl@0: if __name__ == "__main__":
sl@0:     script = Script()
sl@0:     sys.exit(script.main())