commands/environ.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2013  CEA/DEN
   4 #
   5 #  This library is free software; you can redistribute it and/or
   6 #  modify it under the terms of the GNU Lesser General Public
   7 #  License as published by the Free Software Foundation; either
   8 #  version 2.1 of the License.
   9 #
  10 #  This library is distributed in the hope that it will be useful,
  11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 #  Lesser General Public License for more details.
  14 #
  15 #  You should have received a copy of the GNU Lesser General Public
  16 #  License along with this library; if not, write to the Free Software
  17 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18
  19 import os
  20
  21 import src
  22
  23 parser = src.options.Options()
  24 parser.add_option('', 'shell', 'list2', 'shell',
  25     _("Generates the environment files for the given format: "
  26       "bash (default), bat (for windows) or all."), [])
  27 parser.add_option('p', 'products', 'list2', 'products',
  28     _("Includes only the specified products."))
  29 parser.add_option('', 'prefix', 'string', 'prefix',
  30     _("Specifies the prefix for the environment files."), "env")
  31 parser.add_option('t', 'target', 'string', 'out_dir',
  32     _("Specifies the directory path where to put the environment files."),
  33     None)
  34
  35 # list of available shells with extensions
  36 C_SHELLS = { "bash": "sh", "bat": "bat" }
  37 C_ALL_SHELL = [ "bash", "bat" ]
  38
  39
  40 ##
  41 # Writes all the environment files
  42 def write_all_source_files(config, logger, out_dir=None, src_root=None,
  43                            silent=False, shells=["bash"], prefix="env", env_info=None):
  44
  45     if not out_dir:
  46         out_dir = config.APPLICATION.workdir
  47
  48     if not os.path.exists(out_dir):
  49         raise src.SatException(_("Target directory not found: %s") % out_dir)
  50
  51     if not silent:
  52         logger.write(_("Creating environment files for %s\n") % src.printcolors.printcLabel(config.APPLICATION.name), 2)
  53         src.printcolors.print_value(logger, _("Target"), src.printcolors.printcInfo(out_dir), 3)
  54         logger.write("\n", 3, False)
  55
  56     shells_list = []
  57     all_shells = C_ALL_SHELL
  58     if "all" in shells:
  59         shells = all_shells
  60     else:
  61         shells = filter(lambda l: l in all_shells, shells)
  62
  63     for shell in shells:
  64         if shell not in C_SHELLS:
  65             logger.write(_("Unknown shell: %s\n") % shell, 2)
  66         else:
  67             shells_list.append(src.environment.Shell(shell, C_SHELLS[shell]))
  68
  69     writer = src.environment.FileEnvWriter(config, logger, out_dir, src_root, env_info)
  70     writer.silent = silent
  71     files = []
  72     for_build = True
  73     for_launch = False
  74     for shell in shells_list:
  75         files.append(writer.write_env_file("%s_launch.%s" % (prefix, shell.extension), for_launch, shell.name))
  76         files.append(writer.write_env_file("%s_build.%s" % (prefix, shell.extension),  for_build,  shell.name))
  77
  78     return files
  79
  80 ##################################################
  81
  82 ##
  83 # Describes the command
  84 def description():
  85     return _("The environ command generates the "
  86                 "environment files of your application.")
  87
  88 ##
  89 # Runs the command.
  90 def run(args, runner, logger):
  91     (options, args) = parser.parse_args(args)
  92
  93     # check that the command was called with an application
  94     src.check_config_has_application( runner.cfg )
  95
  96     if options.products is None:
  97         environ_info = None
  98     else:
  99         # add products specified by user (only products included in the application)
 100         environ_info = filter(lambda l: l in runner.cfg.APPLICATION.products.keys(), options.products)
 101
 102     if options.shell == []:
 103         shell = ["bash"]
 104         if src.architecture.is_windows():
 105             shell = ["bat"]
 106     else:
 107         shell = options.shell
 108
 109     out_dir = options.out_dir
 110     if out_dir:
 111         out_dir = os.path.abspath(out_dir)
 112
 113     write_all_source_files(runner.cfg, logger, out_dir=out_dir, shells=shell,
 114                            prefix=options.prefix, env_info=environ_info)
 115     logger.write("\n", 3, False)