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
26 from src.versionMinorMajorPatch import MinorMajorPatch as MMP
27 import src.debug as DBG
29 parser = src.options.Options()
30 parser.add_option('p', 'products', 'list2', 'products',
31 _("Optional: the list of products to generate"))
32 parser.add_option('', 'yacsgen', 'string', 'yacsgen',
33 _("Optional: path to YACSGEN's module_generator package"))
35 def generate_component_list(config, product_name, product_info, context, logger):
38 for compo in src.product.get_product_components(product_info):
39 header = " %s %s " % (src.printcolors.printcLabel(compo),
40 "." * (20 - len(compo)))
41 res = generate_component(config,
48 if config.USER.output_verbose_level == 3:
49 logger.write("\r%s%s\r%s" % (header, " " * 20, header), 3)
50 logger.write(src.printcolors.printc(res), 3, False)
51 logger.write("\n", 3, False)
54 def generate_component(config, compo, product_name, product_info, context, header, logger):
55 # get from config include file name and librairy name, or take default value
56 if "hxxfile" in product_info:
57 hxxfile = product_info.hxxfile
59 hxxfile = compo + ".hxx"
60 if "cpplib" in product_info:
61 cpplib = product_info.cpplib
63 cpplib = "lib" + compo + "CXX.so"
64 cpp_path = product_info.install_dir
66 logger.write("%s\n" % header, 4, False)
67 src.printcolors.print_value(logger, "hxxfile", hxxfile, 4)
68 src.printcolors.print_value(logger, "cpplib", cpplib, 4)
69 src.printcolors.print_value(logger, "cpp_path", cpp_path, 4)
71 # create a product_info at runtime
72 compo_info = src.pyconf.Mapping(config)
73 compo_info.name = compo
74 compo_info.nb_proc = 1
75 generate_dir = os.path.join(config.APPLICATION.workdir, "GENERATED")
76 install_dir = os.path.join(config.APPLICATION.workdir, "INSTALL")
77 build_dir = os.path.join(config.APPLICATION.workdir, "BUILD")
78 compo_info.source_dir = os.path.join(generate_dir, compo + "_SRC")
79 compo_info.install_dir = os.path.join(install_dir, compo)
80 compo_info.build_dir = os.path.join(build_dir, compo)
81 compo_info.depend = product_info.depend
82 compo_info.depend.append(product_info.name, "") # add cpp module
83 compo_info.opt_depend = product_info.opt_depend
85 config.PRODUCTS.addMapping(compo, src.pyconf.Mapping(config), "")
86 config.PRODUCTS[compo].default = compo_info
88 builder = src.compilation.Builder(config, logger, product_name, compo_info, check_src=False)
89 builder.header = header
91 # generate the component
92 # create GENERATE dir if necessary
93 if not os.path.exists(generate_dir):
94 os.mkdir(generate_dir)
96 # delete previous generated directory if it already exists
97 if os.path.exists(compo_info.source_dir):
98 logger.write(" delete %s\n" % compo_info.source_dir, 4)
99 shutil.rmtree(compo_info.source_dir)
101 # generate generates in the current directory => change for generate dir
103 os.chdir(generate_dir)
105 # inline class to override bootstrap method
106 import module_generator
107 class sat_generator(module_generator.Generator):
108 # old bootstrap for automake (used if salome version <= 7.4)
109 def bootstrap(self, source_dir, log_file):
110 # replace call to default bootstrap() by using subprocess call (cleaner)
111 command = "sh autogen.sh"
112 ier = subprocess.call(command, shell=True, cwd=source_dir,
113 stdout=log_file, stderr=subprocess.STDOUT)
115 raise src.SatException("bootstrap has ended in error")
118 # determine salome version
119 VersionSalome = src.get_salome_version(config)
120 if VersionSalome >= MMP([7,5,0]) :
122 builder.log('USE CMAKE', 3)
125 builder.log('USE AUTOTOOLS', 3)
128 builder.log('GENERATE', 3)
130 prevstdout = sys.stdout
131 prevstderr = sys.stderr
134 sys.stdout = logger.logTxtFile
135 sys.stderr = logger.logTxtFile
137 if src.product.product_is_mpi(product_info):
138 salome_compo = module_generator.HXX2SALOMEParaComponent(hxxfile,
142 salome_compo = module_generator.HXX2SALOMEComponent(hxxfile,
146 if src.product.product_has_salome_gui(product_info):
147 # get files to build a template GUI
148 try: # try new yacsgen api
149 gui_files = salome_compo.getGUIfilesTemplate(compo)
150 except: # use old yacsgen api
151 gui_files = salome_compo.getGUIfilesTemplate()
155 mg = module_generator.Module(compo, components=[salome_compo],
156 prefix=generate_dir, gui=gui_files)
157 g = sat_generator(mg, context)
161 result = "BUID_CONFIGURE"
162 builder.log('BUID_CONFIGURE (no bootstrap)', 3)
163 g.bootstrap(compo_info.source_dir, logger.logTxtFile)
165 result = src.OK_STATUS
167 sys.stdout = prevstdout
168 sys.stderr = prevstderr
170 # go back to previous directory
173 # do the compilation using the builder object
174 if builder.prepare()!= 0: return "Error in prepare"
176 if builder.configure()!= 0: return "Error in configure"
178 if builder.cmake()!= 0: return "Error in cmake"
180 if builder.make(config.VARS.nb_proc, "")!=0: return "Error in make"
181 if builder.install()!=0: return "Error in make install"
183 # copy specified logo in generated component install directory
184 # rem : logo is not copied in source dir because this would require
185 # to modify the generated makefile
186 logo_path = src.product.product_has_logo(product_info)
188 destlogo = os.path.join(compo_info.install_dir, "share", "salome",
189 "resources", compo.lower(), compo + ".png")
190 src.Path(logo_path).copyfile(destlogo)
194 def build_context(config, logger):
195 products_list = [ 'KERNEL', 'GUI' ]
196 ctxenv = src.environment.SalomeEnviron(config,
197 src.environment.Environ(dict(
201 ctxenv.set_full_environ(logger, config.APPLICATION.products.keys())
204 for p in products_list:
205 prod_env = p + "_ROOT_DIR"
206 val = os.getenv(prod_env)
207 if os.getenv(prod_env) is None:
208 if p not in config.APPLICATION.products:
209 warn = _("product %(product)s is not defined. Include it in the"
210 " application or define $%(env)s.") % \
211 { "product": p, "env": prod_env}
212 logger.write(src.printcolors.printcWarning(warn), 1)
213 logger.write("\n", 3, False)
215 val = ctxenv.environ.environ[prod_env]
218 # the dictionary requires all keys
219 # but the generation requires only values for KERNEL and GUI
223 "kernel": dicdir["KERNEL"],
224 "gui": dicdir["GUI"],
233 def check_module_generator(directory=None):
234 """Check if module_generator is available.
236 :param directory str: The directory of YACSGEN.
237 :return: The YACSGEN path if the module_generator is available, else None
241 if directory is not None and directory not in sys.path:
242 sys.path.insert(0, directory)
247 #import module_generator
248 info = imp.find_module("module_generator")
252 sys.path.remove(directory)
257 def check_yacsgen(config, directory, logger):
258 """Check if YACSGEN is available.
260 :param config Config: The global configuration.
261 :param directory str: The directory given by option --yacsgen
262 :param logger Logger: The logger instance
263 :return: The path to yacsgen directory
266 # first check for YACSGEN (command option, then product, then environment)
269 if directory is not None:
270 yacsgen_dir = directory
271 yacs_src = _("Using YACSGEN from command line")
272 elif 'YACSGEN' in config.APPLICATION.products:
273 yacsgen_info = src.product.get_product_config(config, 'YACSGEN')
274 yacsgen_dir = yacsgen_info.install_dir
275 yacs_src = _("Using YACSGEN from application")
276 elif "YACSGEN_ROOT_DIR" in os.environ:
277 yacsgen_dir = os.getenv("YACSGEN_ROOT_DIR")
278 yacs_src = _("Using YACSGEN from environment")
280 if yacsgen_dir is None:
281 return (False, _("The generate command requires YACSGEN."))
283 logger.write(" %s\n" % yacs_src, 2, True)
284 logger.write(" %s\n" % yacsgen_dir, 5, True)
286 if not os.path.exists(yacsgen_dir):
287 message = _("YACSGEN directory not found: '%s'") % yacsgen_dir
288 return (False, _(message))
290 # load module_generator
291 c = check_module_generator(yacsgen_dir)
295 pv = os.getenv("PYTHON_VERSION")
297 python_info = src.product.get_product_config(config, "Python")
298 pv = '.'.join(python_info.version.split('.')[:2])
299 assert pv is not None, "$PYTHON_VERSION not defined"
300 yacsgen_dir = os.path.join(yacsgen_dir, "lib", "python%s" % pv,
302 c = check_module_generator(yacsgen_dir)
307 _("The python module module_generator was not found in YACSGEN"))
311 '''method that is called when salomeTools is called with --help option.
313 :return: The text to display for the generate command description.
316 return _("The generate command generates SALOME modules from 'pure cpp' "
317 "products.\nWARNING this command NEEDS YACSGEN to run!\n\nexample:"
318 "\nsat generate SALOME-master --products FLICACPP")
321 def run(args, runner, logger):
322 '''method that is called when salomeTools is called with generate parameter.
325 # Check that the command has been called with an application
326 src.check_config_has_application(runner.cfg)
328 logger.write(_('Generation of SALOME modules for application %s\n') % \
329 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
331 (options, args) = parser.parse_args(args)
333 status = src.KO_STATUS
335 # verify that YACSGEN is available
336 yacsgen_dir = check_yacsgen(runner.cfg, options.yacsgen, logger)
338 if isinstance(yacsgen_dir, tuple):
340 __, error = yacsgen_dir
341 msg = _("Error: %s" % error)
342 logger.write(src.printcolors.printcError(msg), 1)
343 logger.write("\n", 1)
346 # Make the generator module visible by python
347 sys.path.insert(0, yacsgen_dir)
349 src.printcolors.print_value(logger, _("YACSGEN dir"), yacsgen_dir, 3)
350 logger.write("\n", 2)
351 products = runner.cfg.APPLICATION.products
353 products = options.products
358 context = build_context(runner.cfg, logger)
359 for product in products:
360 header = _("Generating %s") % src.printcolors.printcLabel(product)
361 header += " %s " % ("." * (20 - len(product)))
362 logger.write(header, 3)
365 if product not in runner.cfg.PRODUCTS:
366 logger.write(_("Unknown product\n"), 3, False)
369 pi = src.product.get_product_config(runner.cfg, product)
370 if not src.product.product_is_generated(pi):
371 logger.write(_("not a generated product\n"), 3, False)
374 logger.write(_("\nCleaning generated directories\n"), 3, False)
375 # clean source, build and install directories of the generated product
376 # no verbosity to avoid warning at the first generation, for which dirs don't exist
377 runner.clean(runner.cfg.VARS.application +
378 " --products " + pi.name +
382 logger_add_link = logger)
385 result = generate_component_list(runner.cfg,
390 except Exception as exc:
393 if result != src.OK_STATUS:
394 result = _("ERROR: %s") % result
395 details.append([product, result])
397 if len(details) == 0:
398 status = src.OK_STATUS
399 else: #if config.USER.output_level != 3:
400 logger.write("\n", 2, False)
401 logger.write(_("The following modules were not generated correctly:\n"), 2)
403 logger.write(" %s: %s\n" % (d[0], d[1]), 2, False)
404 logger.write("\n", 2, False)
406 if status == src.OK_STATUS: