3 # Copyright (C) 2010-2013 CEA/DEN
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.
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.
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
27 parser = src.options.Options()
28 parser.add_option('p', 'products', 'list2', 'products',
29 _("the list of products to generate"))
30 parser.add_option('', 'yacsgen', 'string', 'yacsgen',
31 _("path to YACSGEN's module_generator package"))
33 def generate_component_list(config, product_info, context, logger):
36 for compo in src.product.get_product_components(product_info):
37 header = " %s %s " % (src.printcolors.printcLabel(compo),
38 "." * (20 - len(compo)))
39 res = generate_component(config,
45 if config.USER.output_verbose_level == 3:
46 logger.write("\r%s%s\r%s" % (header, " " * 20, header), 3)
47 logger.write(src.printcolors.printc(res), 3, False)
48 logger.write("\n", 3, False)
51 def generate_component(config, compo, product_info, context, header, logger):
52 hxxfile = compo + ".hxx"
53 cpplib = "lib" + compo + "CXX.so"
54 cpp_path = product_info.install_dir
56 logger.write("%s\n" % header, 4, False)
57 src.printcolors.print_value(logger, "hxxfile", hxxfile, 4)
58 src.printcolors.print_value(logger, "cpplib", cpplib, 4)
59 src.printcolors.print_value(logger, "cpp_path", cpp_path, 4)
61 # create a product_info at runtime
62 pp = src.pyconf.Mapping(config)
65 generate_dir = os.path.join(config.APPLICATION.workdir, "GENERATED")
66 install_dir = os.path.join(config.APPLICATION.workdir, "INSTALL")
67 build_dir = os.path.join(config.APPLICATION.workdir, "BUILD")
68 pp.source_dir = os.path.join(generate_dir, compo + "_SRC")
69 pp.install_dir = os.path.join(install_dir, compo)
70 pp.build_dir = os.path.join(build_dir, compo)
71 pp.depend = product_info.depend
72 pp.depend.append(product_info.name, "") # add cpp module
73 pp.opt_depend = product_info.opt_depend
75 config.PRODUCTS[compo].default = pp
77 builder = src.compilation.Builder(config, logger, pp, check_src=False)
78 builder.header = header
80 # generate the component
81 # create GENERETE dir if necessary
82 if not os.path.exists(generate_dir):
83 os.mkdir(generate_dir)
85 # delete previous generated directory if it already exists
86 if os.path.exists(pp.source_dir):
87 logger.write(" delete %s\n" % pp.source_dir, 4)
88 shutil.rmtree(pp.source_dir)
90 # generate generates in the current directory => change for generate dir
92 os.chdir(generate_dir)
94 # inline class to override bootstrap method
95 import module_generator
96 class sat_generator(module_generator.Generator):
97 # old bootstrap for automake (used if salome version <= 7.4)
98 def bootstrap(self, source_dir, log_file):
99 # replace call to default bootstrap() by using subprocess call (cleaner)
100 command = "sh autogen.sh"
101 ier = subprocess.call(command, shell=True, cwd=source_dir,
102 stdout=log_file, stderr=subprocess.STDOUT)
104 raise src.SatException("bootstrap has ended in error")
107 # determine salome version
108 VersionSalome = src.get_salome_version(config)
109 if VersionSalome >= 750 :
111 builder.log_step('USE CMAKE')
114 builder.log_step('USE AUTOTOOLS')
117 builder.log_step('GENERATE')
119 prevstdout = sys.stdout
120 prevstderr = sys.stderr
123 sys.stdout = logger.logTxtFile
124 sys.stderr = logger.logTxtFile
126 if src.product.product_is_mpi(product_info):
127 salome_compo = module_generator.HXX2SALOMEParaComponent(hxxfile,
131 salome_compo = module_generator.HXX2SALOMEComponent(hxxfile,
135 if product_info.has_gui == "yes":
136 # get files to build a template GUI
137 gui_files = salome_compo.getGUIfilesTemplate()
141 mg = module_generator.Module(compo, components=[salome_compo],
142 prefix=generate_dir, gui=gui_files)
143 g = sat_generator(mg, context)
147 result = "BUID_CONFIGURE"
148 builder.log_step('BUID_CONFIGURE (no bootstrap)')
149 g.bootstrap(pp.source_dir, logger.logTxtFile)
151 result = src.OK_STATUS
153 sys.stdout = prevstdout
154 sys.stderr = prevstderr
156 # go back to previous directory
159 # do the compilation using the builder object
160 if not builder.prepare(): return "Error in prepare"
162 if not builder.configure(): return "Error in configure"
164 if not builder.cmake(): return "Error in cmake"
166 if not builder.make(): return "Error in make"
167 if not builder.install(): return "Error in make install"
169 # copy specified logo in generated component install directory
170 # rem : logo is not copied in source dir because this would require
171 # to modify the generated makefile
172 logo_path = src.product.product_has_logo(product_info)
174 destlogo = os.path.join(pp.install_dir, "share", "salome",
175 "resources", compo.lower(), compo + ".png")
176 src.Path(logo_path).copyfile(destlogo)
180 def build_context(config, logger):
181 products_list = [ 'KERNEL', 'GUI' ]
182 ctxenv = src.environment.SalomeEnviron(config,
183 src.environment.Environ(dict(
187 ctxenv.set_full_environ(logger, config.APPLICATION.products.keys())
190 for p in products_list:
191 prod_env = p + "_ROOT_DIR"
192 val = os.getenv(prod_env)
193 if os.getenv(prod_env) is None:
194 if p not in config.APPLICATION.products:
195 warn = _("product %(product)s is not defined. Include it in the"
196 " application or define $%(env)s.") % \
197 { "product": p, "env": prod_env}
198 logger.write(src.printcolors.printcWarning(warn), 1)
199 logger.write("\n", 3, False)
201 val = ctxenv.environ.environ[prod_env]
204 # the dictionary requires all keys
205 # but the generation requires only values for KERNEL and GUI
209 "kernel": dicdir["KERNEL"],
210 "gui": dicdir["GUI"],
219 def check_module_generator(directory=None):
220 """Check if module_generator is available.
222 :param directory str: The directory of YACSGEN.
223 :return: The YACSGEN path if the module_generator is available, else None
227 if directory is not None and directory not in sys.path:
228 sys.path.insert(0, directory)
233 #import module_generator
234 info = imp.find_module("module_generator")
238 sys.path.remove(directory)
243 def check_yacsgen(config, directory, logger):
244 """Check if YACSGEN is available.
246 :param config Config: The global configuration.
247 :param directory str: The directory given by option --yacsgen
248 :param logger Logger: The logger instance
249 :return: The path to yacsgen directory
252 # first check for YACSGEN (command option, then product, then environment)
255 if directory is not None:
256 yacsgen_dir = directory
257 yacs_src = _("Using YACSGEN from command line")
258 elif 'YACSGEN' in config.APPLICATION.products:
259 yacsgen_info = src.product.get_product_config(config, 'YACSGEN')
260 yacsgen_dir = yacsgen_info.install_dir
261 yacs_src = _("Using YACSGEN from application")
262 elif os.environ.has_key("YACSGEN_ROOT_DIR"):
263 yacsgen_dir = os.getenv("YACSGEN_ROOT_DIR")
264 yacs_src = _("Using YACSGEN from environment")
266 if yacsgen_dir is None:
267 return (False, _("The generate command requires YACSGEN."))
269 logger.write(" %s\n" % yacs_src, 2, True)
270 logger.write(" %s\n" % yacsgen_dir, 5, True)
272 if not os.path.exists(yacsgen_dir):
273 message = _("YACSGEN directory not found: '%s'") % yacsgen_dir
274 return (False, _(message))
276 # load module_generator
277 c = check_module_generator(yacsgen_dir)
281 pv = os.getenv("PYTHON_VERSION")
283 python_info = src.product.get_product_config(config, "Python")
284 pv = '.'.join(python_info.version.split('.')[:2])
285 assert pv is not None, "$PYTHON_VERSION not defined"
286 yacsgen_dir = os.path.join(yacsgen_dir, "lib", "python%s" % pv,
288 c = check_module_generator(yacsgen_dir)
293 _("The python module module_generator was not found in YACSGEN"))
297 '''method that is called when salomeTools is called with --help option.
299 :return: The text to display for the generate command description.
302 return _("The generate command generates SALOME modules from 'pure cpp' "
303 "products.\nWARNING this command NEEDS YACSGEN to run!")
306 def run(args, runner, logger):
307 '''method that is called when salomeTools is called with generate parameter.
310 # Check that the command has been called with an application
311 src.check_config_has_application(runner.cfg)
313 logger.write(_('Generation of SALOME modules for application %s\n') % \
314 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
316 (options, args) = parser.parse_args(args)
318 status = src.KO_STATUS
320 # verify that YACSGEN is available
321 yacsgen_dir = check_yacsgen(runner.cfg, options.yacsgen, logger)
323 if isinstance(yacsgen_dir, tuple):
325 __, error = yacsgen_dir
326 msg = _("Error: %s" % error)
327 logger.write(src.printcolors.printcError(msg), 1)
328 logger.write("\n", 1)
331 # Make the generator module visible by python
332 sys.path.insert(0, yacsgen_dir)
334 src.printcolors.print_value(logger, _("YACSGEN dir"), yacsgen_dir, 3)
335 logger.write("\n", 2)
336 products = runner.cfg.APPLICATION.products
338 products = options.products
343 context = build_context(runner.cfg, logger)
344 for product in products:
345 header = _("Generating %s") % src.printcolors.printcLabel(product)
346 header += " %s " % ("." * (20 - len(product)))
347 logger.write(header, 3)
350 if product not in runner.cfg.PRODUCTS:
351 logger.write(_("Unknown product\n"), 3, False)
354 pi = src.product.get_product_config(runner.cfg, product)
355 if not src.product.product_is_generated(pi):
356 logger.write(_("not a generated product\n"), 3, False)
361 result = generate_component_list(runner.cfg,
365 except Exception as exc:
368 if result != src.OK_STATUS:
369 result = _("ERROR: %s") % result
370 details.append([product, result])
372 if len(details) == 0:
373 status = src.OK_STATUS
374 else: #if config.USER.output_level != 3:
375 logger.write("\n", 2, False)
376 logger.write(_("The following modules were not generated correctly:\n"), 2)
378 logger.write(" %s: %s\n" % (d[0], d[1]), 2, False)
379 logger.write("\n", 2, False)
381 if status == src.OK_STATUS: