Salome HOME
Fix CPPUNIT detection when its library directory contains -l (like -L/usr/lib/x86_64...
[modules/kernel.git] / bin / launchConfigureParser.py
1 #  -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
3 #
4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 #
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License.
11 #
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 # Lesser General Public License for more details.
16 #
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
20 #
21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 #
23
24 import os, glob, string, sys, re
25 import xml.sax
26 import optparse
27 import types
28
29 from salome_utils import verbose, setVerbose, getPortNumber, getHomeDir
30
31 from salomeLauncherUtils import getScriptsAndArgs
32
33 # names of tags in XML configuration file
34 doc_tag = "document"
35 sec_tag = "section"
36 par_tag = "parameter"
37 import_tag = "import"
38
39 # names of attributes in XML configuration file
40 nam_att = "name"
41 val_att = "value"
42
43 # certain values in XML configuration file ("launch" section)
44 lanch_nam      = "launch"
45 help_nam       = "help"
46 gui_nam        = "gui"
47 splash_nam     = "splash"
48 logger_nam     = "logger"
49 xterm_nam      = "xterm"
50 file_nam       = "file"
51 portkill_nam   = "portkill"
52 killall_nam    = "killall"
53 modules_nam    = "modules"
54 embedded_nam   = "embedded"
55 standalone_nam = "standalone"
56 key_nam        = "key"
57 terminal_nam   = "terminal"
58 interp_nam     = "interp"
59 except_nam     = "noexcepthandler"
60 terminal_nam   = "terminal"
61 pinter_nam     = "pinter"
62 batch_nam      = "batch"
63 test_nam       = "test"
64 play_nam       = "play"
65 gdb_session_nam = "gdb_session"
66 ddd_session_nam = "ddd_session"
67 valgrind_session_nam = "valgrind_session"
68 shutdown_servers_nam = "shutdown_servers"
69 foreground_nam = "foreground"
70 wake_up_session_nam = "wake_up_session"
71 siman_nam = "siman"
72 siman_study_nam = "siman_study"
73 siman_scenario_nam = "siman_scenario"
74 siman_user_nam = "siman_user"
75
76 # values in XML configuration file giving specific module parameters (<module_name> section)
77 # which are stored in opts with key <module_name>_<parameter> (eg SMESH_plugins)
78 plugins_nam    = "plugins"
79
80 # values passed as arguments, NOT read from XML config file, but set from within this script
81 appname_nam    = "appname"
82 port_nam       = "port"
83 useport_nam    = "useport"
84 salomecfgname  = "salome"
85 salomeappname  = "SalomeApp"
86 script_nam     = "pyscript"
87
88 # possible choices for the "embedded" and "standalone" parameters
89 embedded_choices   = [ "registry", "study", "moduleCatalog", "cppContainer", "SalomeAppEngine" ]
90 standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer"]
91
92 # values of boolean type (must be '0' or '1').
93 # xml_parser.boolValue() is used for correct setting
94 boolKeys = ( gui_nam, splash_nam, logger_nam, file_nam, xterm_nam, portkill_nam, killall_nam, except_nam, pinter_nam, shutdown_servers_nam )
95 intKeys = ( interp_nam, )
96
97 # values of list type
98 listKeys = ( embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )
99
100 ###
101 # Get the application version
102 # Uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION file
103 ###
104 def version():
105     try:
106         filename = None
107         root_dir = os.environ.get( 'KERNEL_ROOT_DIR', '' ) # KERNEL_ROOT_DIR or "" if not found
108         if root_dir and os.path.exists( root_dir + "/bin/salome/VERSION" ):
109             filename = root_dir + "/bin/salome/VERSION"
110         root_dir = os.environ.get( 'GUI_ROOT_DIR', '' )    # GUI_ROOT_DIR "" if not found
111         if root_dir and os.path.exists( root_dir + "/bin/salome/VERSION" ):
112             filename = root_dir + "/bin/salome/VERSION"
113         if filename:
114             str = open( filename, "r" ).readline() # str = "THIS IS SALOME - SALOMEGUI VERSION: 3.0.0"
115             match = re.search( r':\s+([a-zA-Z0-9.]+)\s*$', str )
116             if match :
117                 return match.group( 1 )
118     except:
119         pass
120     return ''
121
122 ###
123 # Calculate and return configuration file unique ID
124 # For example: for SALOME version 3.1.0a1 the id is 300999701
125 ###
126 def version_id(fname):
127     major = minor = release = dev1 = dev2 = 0
128     vers = fname.split(".")
129     if len(vers) > 0: major = int(vers[0])
130     if len(vers) > 1: minor = int(vers[1])
131     if len(vers) > 2:
132         mr = re.search(r'^([0-9]+)([A-Z]|RC)?([0-9]*)',vers[2], re.I)
133         if mr:
134             release = int(mr.group(1))
135             if mr.group(2):
136                 tag = mr.group(2).strip().lower()
137                 if tag == "rc":
138                     dev1 = 49 # release candidate
139                 elif tag:
140                     dev1 = ord(tag)-ord('a')+1
141                 pass
142             if mr.group(3):
143                 dev2 = int(mr.group(3).strip())
144             pass
145         pass
146     dev = dev1 * 100 + dev2
147     ver = major
148     ver = ver * 100 + minor
149     ver = ver * 100 + release
150     ver = ver * 10000
151     if dev > 0: ver = ver - dev
152     return ver
153
154 ###
155 # Get default user configuration file name
156 # For SALOME, it is:
157 # - on Linux:   ~/.config/salome/SalomeApprc[.<version>]
158 # - on Windows: ~/SalomeApp.xml[.<version>]
159 # where <version> is an optional version number
160 ###
161 def defaultUserFile(appname=salomeappname, cfgname=salomecfgname):
162     v = version()
163     if v: v = ".%s" % v
164     if sys.platform == "win32":
165       filename = os.path.join(getHomeDir(), "%s.xml%s" % (appname, v))
166     else:
167         if cfgname:
168             filename = os.path.join(getHomeDir(), ".config", cfgname, "%src%s" % (appname, v))
169             pass
170         else:
171             filename = os.path.join(getHomeDir(), ".%src%s" % (appname, v))
172             pass
173         pass
174     return filename
175
176 ###
177 # Get user configuration file name
178 ###
179 def userFile(appname, cfgname):
180     # get app version
181     v = version()
182     if not v: return None                        # unknown version
183
184     # get default user file name
185     filename = defaultUserFile(appname, cfgname)
186     if not filename: return None                 # default user file name is bad
187
188     # check that default user file exists
189     if os.path.exists(filename): return filename # user file is found
190
191     # otherwise try to detect any appropriate user file
192
193     # ... calculate default version id
194     id0 = version_id(v)
195     if not id0: return None                      # bad version id -> can't detect appropriate file
196
197     # ... get all existing user preferences files
198     if sys.platform == "win32":
199         files = glob.glob(os.path.join(getHomeDir(), "%s.xml.*" % appname))
200     else:
201         files = []
202         if cfgname:
203             # Since v6.6.0 - in ~/.config/salome directory, without dot prefix
204             files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, "%src.*" % appname))
205             # Since v6.5.0 - in ~/.config/salome directory, dot-prefixed (backward compatibility)
206             files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, ".%src.*" % appname))
207             pass
208         # old style (before v6.5.0) - in ~ directory, dot-prefixed
209         files += glob.glob(os.path.join(getHomeDir(), ".%src.*" % appname))
210         pass
211
212     # ... loop through all files and find most appopriate file (with closest id)
213     appr_id   = -1
214     appr_file = ""
215     for f in files:
216         ff = os.path.basename( f )
217         if sys.platform == "win32":
218             match = re.search( r'^%s\.xml\.([a-zA-Z0-9.]+)$'%appname, ff )
219         else:
220             match = re.search( r'^\.?%src\.([a-zA-Z0-9.]+)$'%appname, ff )
221         if match:
222             ver = version_id(match.group(1))
223             if not ver: continue                 # bad version id -> skip file
224             if appr_id < 0 or abs(appr_id-id0) > abs(ver-id0):
225                 appr_id   = ver
226                 appr_file = f
227                 pass
228             elif abs(appr_id-id0) == abs(ver-id0):
229                 if not os.path.basename(f).startswith("."): appr_file = f
230                 pass
231             pass
232         pass
233     return appr_file
234
235 # --
236
237 def process_containers_params( standalone, embedded ):
238     # 1. filter inappropriate containers names
239     if standalone is not None:
240         standalone = filter( lambda x: x in standalone_choices, standalone )
241     if embedded is not None:
242         embedded   = filter( lambda x: x in embedded_choices,   embedded )
243
244     # 2. remove containers appearing in 'standalone' parameter from the 'embedded'
245     # parameter --> i.e. 'standalone' parameter has higher priority
246     if standalone is not None and embedded is not None:
247         embedded = filter( lambda x: x not in standalone, embedded )
248
249     # 3. return corrected parameters values
250     return standalone, embedded
251
252 # -----------------------------------------------------------------------------
253
254 ###
255 # XML reader for launch configuration file usage
256 ###
257
258 section_to_skip = ""
259
260 class xml_parser:
261     def __init__(self, fileName, _opts, _importHistory):
262         #warning _importHistory=[] is NOT good: is NOT empty,reinitialized after first call
263         if verbose(): print "Configure parser: processing %s ..." % fileName
264         self.fileName = os.path.abspath(fileName)
265         self.importHistory = _importHistory
266         self.importHistory.append(self.fileName)
267         self.space = []
268         self.opts = _opts
269         self.section = section_to_skip
270         parser = xml.sax.make_parser()
271         parser.setContentHandler(self)
272         parser.parse(fileName)
273         standalone, embedded = process_containers_params( self.opts.get( standalone_nam ),
274                                                           self.opts.get( embedded_nam ) )
275         if standalone is not None:
276             self.opts[ standalone_nam ] = standalone
277         if embedded is not None:
278             self.opts[ embedded_nam ] = embedded
279         pass
280
281     def boolValue( self, str ):
282         strloc = str
283         if isinstance(strloc, types.UnicodeType):
284             strloc = strloc.encode().strip()
285         if isinstance(strloc, types.StringType):
286             strlow = strloc.lower()
287             if strlow in   ("1", "yes", "y", "on", "true", "ok"):
288                 return True
289             elif strlow in ("0", "no", "n", "off", "false", "cancel"):
290                 return False
291         return strloc
292         pass
293
294     def intValue( self, str ):
295         strloc = str
296         if isinstance(strloc, types.UnicodeType):
297             strloc = strloc.encode().strip()
298         if isinstance(strloc, types.StringType):
299             strlow = strloc.lower()
300             if strlow in   ("1", "yes", "y", "on", "true", "ok"):
301                 return 1
302             elif strlow in ("0", "no", "n", "off", "false", "cancel"):
303                 return 0
304             else:
305                 return string.atoi(strloc)
306         return strloc
307         pass
308
309     def startElement(self, name, attrs):
310         self.space.append(name)
311         self.current = None
312
313         # if we are importing file
314         if self.space == [doc_tag, import_tag] and nam_att in attrs.getNames():
315             self.importFile( attrs.getValue(nam_att) )
316
317         # if we are analyzing "section" element and its "name" attribute is
318         # either "launch" or module name -- set section_name
319         if self.space == [doc_tag, sec_tag] and nam_att in attrs.getNames():
320             section_name = attrs.getValue( nam_att )
321             if section_name == lanch_nam:
322                 self.section = section_name # launch section
323             elif self.opts.has_key( modules_nam ) and \
324                  section_name in self.opts[ modules_nam ]:
325                 self.section = section_name # <module> section
326             else:
327                 self.section = section_to_skip # any other section
328             pass
329
330         # if we are analyzing "parameter" elements - children of either
331         # "section launch" or "section "<module>"" element, then store them
332         # in self.opts assiciative array (key = [<module>_ + ] value of "name" attribute)
333         elif self.section != section_to_skip           and \
334              self.space == [doc_tag, sec_tag, par_tag] and \
335              nam_att in attrs.getNames()               and \
336              val_att in attrs.getNames():
337             nam = attrs.getValue( nam_att )
338             val = attrs.getValue( val_att )
339             if self.section == lanch_nam: # key for launch section
340                 key = nam
341             else:                         # key for <module> section
342                 key = self.section + "_" + nam
343             if nam in boolKeys:
344                 self.opts[key] = self.boolValue( val )  # assign boolean value: 0 or 1
345             elif nam in intKeys:
346                 self.opts[key] = self.intValue( val )   # assign integer value
347             elif nam in listKeys:
348                 self.opts[key] = filter( lambda a: a.strip(), re.split( "[:;,]", val ) ) # assign list value: []
349             else:
350                 self.opts[key] = val
351             pass
352         pass
353
354     def endElement(self, name):
355         p = self.space.pop()
356         self.current = None
357         if self.section != section_to_skip and name == sec_tag:
358             self.section = section_to_skip
359         pass
360
361     def characters(self, content):
362         pass
363
364     def processingInstruction(self, target, data):
365         pass
366
367     def setDocumentLocator(self, locator):
368         pass
369
370     def startDocument(self):
371         self.read = None
372         pass
373
374     def endDocument(self):
375         self.read = None
376         pass
377
378     def importFile(self, fname):
379         # get absolute name
380         if os.path.isabs (fname) :
381             absfname = fname
382         else:
383             absfname = os.path.join(os.path.dirname(self.fileName), fname)
384
385         # check existing and registry file
386         for ext in ["", ".xml", ".XML"] :
387             if os.path.exists(absfname + ext) :
388                 absfname += ext
389                 if absfname in self.importHistory :
390                     if verbose(): print "Configure parser: Warning : file %s is already imported" % absfname
391                     return # already imported
392                 break
393             pass
394         else:
395             if verbose(): print "Configure parser: Error : file %s does not exist" % absfname
396             return
397
398         # importing file
399         try:
400             # copy current options
401             import copy
402             opts = copy.deepcopy(self.opts)
403             # import file
404             imp = xml_parser(absfname, opts, self.importHistory)
405             # merge results
406             for key in imp.opts.keys():
407                 if not self.opts.has_key(key):
408                     self.opts[key] = imp.opts[key]
409                     pass
410                 pass
411             pass
412         except:
413             if verbose(): print "Configure parser: Error : can not read configuration file %s" % absfname
414         pass
415
416
417 # -----------------------------------------------------------------------------
418
419 booleans = { '1': True , 'yes': True , 'y': True , 'on' : True , 'true' : True , 'ok'     : True,
420              '0': False, 'no' : False, 'n': False, 'off': False, 'false': False, 'cancel' : False }
421
422 boolean_choices = booleans.keys()
423
424 def check_embedded(option, opt, value, parser):
425     from optparse import OptionValueError
426     assert value is not None
427     if parser.values.embedded:
428         embedded = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.embedded ) )
429     else:
430         embedded = []
431     if parser.values.standalone:
432         standalone = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.standalone ) )
433     else:
434         standalone = []
435     vals = filter( lambda a: a.strip(), re.split( "[:;,]", value ) )
436     for v in vals:
437         if v not in embedded_choices:
438             raise OptionValueError( "option %s: invalid choice: %r (choose from %s)" % ( opt, v, ", ".join( map( repr, embedded_choices ) ) ) )
439         if v not in embedded:
440             embedded.append( v )
441             if v in standalone:
442                 del standalone[ standalone.index( v ) ]
443                 pass
444     parser.values.embedded = ",".join( embedded )
445     parser.values.standalone = ",".join( standalone )
446     pass
447
448 def check_standalone(option, opt, value, parser):
449     from optparse import OptionValueError
450     assert value is not None
451     if parser.values.embedded:
452         embedded = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.embedded ) )
453     else:
454         embedded = []
455     if parser.values.standalone:
456         standalone = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.standalone ) )
457     else:
458         standalone = []
459     vals = filter( lambda a: a.strip(), re.split( "[:;,]", value ) )
460     for v in vals:
461         if v not in standalone_choices:
462             raise OptionValueError( "option %s: invalid choice: %r (choose from %s)" % ( opt, v, ", ".join( map( repr, standalone_choices ) ) ) )
463         if v not in standalone:
464             standalone.append( v )
465             if v in embedded:
466                 del embedded[ embedded.index( v ) ]
467                 pass
468     parser.values.embedded = ",".join( embedded )
469     parser.values.standalone = ",".join( standalone )
470     pass
471
472 def store_boolean (option, opt, value, parser, *args):
473     if isinstance(value, types.StringType):
474         try:
475             value_conv = booleans[value.strip().lower()]
476             for attribute in args:
477                 setattr(parser.values, attribute, value_conv)
478         except KeyError:
479             raise optparse.OptionValueError(
480                 "option %s: invalid boolean value: %s (choose from %s)"
481                 % (opt, value, boolean_choices))
482     else:
483         for attribute in args:
484             setattr(parser.values, attribute, value)
485
486 def CreateOptionParser (theAdditionalOptions=[]):
487     # GUI/Terminal. Default: GUI
488     help_str = "Launch without GUI (in the terminal mode)."
489     o_t = optparse.Option("-t",
490                           "--terminal",
491                           action="store_false",
492                           dest="gui",
493                           help=help_str)
494
495     help_str = "Launch in Batch Mode. (Without GUI on batch machine)"
496     o_b = optparse.Option("-b",
497                           "--batch",
498                           action="store_true",
499                           dest="batch",
500                           help=help_str)
501
502     help_str = "Launch in GUI mode [default]."
503     o_g = optparse.Option("-g",
504                           "--gui",
505                           action="store_true",
506                           dest="gui",
507                           help=help_str)
508
509     # Show Desktop (inly in GUI mode). Default: True
510     help_str  = "1 to activate GUI desktop [default], "
511     help_str += "0 to not activate GUI desktop (Session_Server starts, but GUI is not shown). "
512     help_str += "Ignored in the terminal mode."
513     o_d = optparse.Option("-d",
514                           "--show-desktop",
515                           metavar="<1/0>",
516                           #type="choice", choices=boolean_choices,
517                           type="string",
518                           action="callback", callback=store_boolean, callback_args=('desktop',),
519                           dest="desktop",
520                           help=help_str)
521     help_str  = "Do not activate GUI desktop (Session_Server starts, but GUI is not shown). "
522     help_str += "The same as --show-desktop=0."
523     o_o = optparse.Option("-o",
524                           "--hide-desktop",
525                           action="store_false",
526                           dest="desktop",
527                           help=help_str)
528
529     # Use logger or log-file. Default: nothing.
530     help_str = "Redirect messages to the CORBA collector."
531     #o4 = optparse.Option("-l", "--logger", action="store_true", dest="logger", help=help_str)
532     o_l = optparse.Option("-l",
533                           "--logger",
534                           action="store_const", const="CORBA",
535                           dest="log_file",
536                           help=help_str)
537     help_str = "Redirect messages to the <log-file>"
538     o_f = optparse.Option("-f",
539                           "--log-file",
540                           metavar="<log-file>",
541                           type="string",
542                           action="store",
543                           dest="log_file",
544                           help=help_str)
545
546     # Configuration XML file. Default: see defaultUserFile() function
547     help_str  = "Parse application settings from the <file> "
548     help_str += "instead of default %s" % defaultUserFile()
549     o_r = optparse.Option("-r",
550                           "--resources",
551                           metavar="<file>",
552                           type="string",
553                           action="store",
554                           dest="resources",
555                           help=help_str)
556
557     # Use own xterm for each server. Default: False.
558     help_str = "Launch each SALOME server in own xterm console"
559     o_x = optparse.Option("-x",
560                           "--xterm",
561                           action="store_true",
562                           dest="xterm",
563                           help=help_str)
564
565     # Modules. Default: Like in configuration files.
566     help_str  = "SALOME modules list (where <module1>, <module2> are the names "
567     help_str += "of SALOME modules which should be available in the SALOME session)"
568     o_m = optparse.Option("-m",
569                           "--modules",
570                           metavar="<module1,module2,...>",
571                           type="string",
572                           action="append",
573                           dest="modules",
574                           help=help_str)
575
576     # Embedded servers. Default: Like in configuration files.
577     help_str  = "CORBA servers to be launched in the Session embedded mode. "
578     help_str += "Valid values for <serverN>: %s " % ", ".join( embedded_choices )
579     help_str += "[by default the value from the configuration files is used]"
580     o_e = optparse.Option("-e",
581                           "--embedded",
582                           metavar="<server1,server2,...>",
583                           type="string",
584                           action="callback",
585                           dest="embedded",
586                           callback=check_embedded,
587                           help=help_str)
588
589     # Standalone servers. Default: Like in configuration files.
590     help_str  = "CORBA servers to be launched in the standalone mode (as separate processes). "
591     help_str += "Valid values for <serverN>: %s " % ", ".join( standalone_choices )
592     help_str += "[by default the value from the configuration files is used]"
593     o_s = optparse.Option("-s",
594                           "--standalone",
595                           metavar="<server1,server2,...>",
596                           type="string",
597                           action="callback",
598                           dest="standalone",
599                           callback=check_standalone,
600                           help=help_str)
601
602     # Kill with port. Default: False.
603     help_str = "Kill SALOME with the current port"
604     o_p = optparse.Option("-p",
605                           "--portkill",
606                           action="store_true",
607                           dest="portkill",
608                           help=help_str)
609
610     # Kill all. Default: False.
611     help_str = "Kill all running SALOME sessions"
612     o_k = optparse.Option("-k",
613                           "--killall",
614                           action="store_true",
615                           dest="killall",
616                           help=help_str)
617
618     # Additional python interpreters. Default: 0.
619     help_str  = "The number of additional external python interpreters to run. "
620     help_str += "Each additional python interpreter is run in separate "
621     help_str += "xterm session with properly set SALOME environment"
622     o_i = optparse.Option("-i",
623                           "--interp",
624                           metavar="<N>",
625                           type="int",
626                           action="store",
627                           dest="interp",
628                           help=help_str)
629
630     # Splash. Default: True.
631     help_str  = "1 to display splash screen [default], "
632     help_str += "0 to disable splash screen. "
633     help_str += "This option is ignored in the terminal mode. "
634     help_str += "It is also ignored if --show-desktop=0 option is used."
635     o_z = optparse.Option("-z",
636                           "--splash",
637                           metavar="<1/0>",
638                           #type="choice", choices=boolean_choices,
639                           type="string",
640                           action="callback", callback=store_boolean, callback_args=('splash',),
641                           dest="splash",
642                           help=help_str)
643
644     # Catch exceptions. Default: True.
645     help_str  = "1 (yes,true,on,ok) to enable centralized exception handling [default], "
646     help_str += "0 (no,false,off,cancel) to disable centralized exception handling."
647     o_c = optparse.Option("-c",
648                           "--catch-exceptions",
649                           metavar="<1/0>",
650                           #type="choice", choices=boolean_choices,
651                           type="string",
652                           action="callback", callback=store_boolean, callback_args=('catch_exceptions',),
653                           dest="catch_exceptions",
654                           help=help_str)
655
656     # Print free port and exit
657     help_str = "Print free port and exit"
658     o_a = optparse.Option("--print-port",
659                           action="store_true",
660                           dest="print_port", default=False,
661                           help=help_str)
662
663     # Do not relink ${HOME}/.omniORB_last.cfg
664     help_str = "Do not save current configuration ${HOME}/.omniORB_last.cfg"
665     o_n = optparse.Option("--nosave-config",
666                           action="store_false",
667                           dest="save_config", default=True,
668                           help=help_str)
669
670     # Launch with interactive python console. Default: False.
671     help_str = "Launch with interactive python console."
672     o_pi = optparse.Option("--pinter",
673                           action="store_true",
674                           dest="pinter",
675                           help=help_str)
676
677     # Print Naming service port into a user file. Default: False.
678     help_str = "Print Naming Service Port into a user file."
679     o_nspl = optparse.Option("--ns-port-log",
680                              metavar="<ns_port_log_file>",
681                              type="string",
682                              action="store",
683                              dest="ns_port_log_file",
684                              help=help_str)
685
686     # Write/read test script file with help of TestRecorder. Default: False.
687     help_str = "Write/read test script file with help of TestRecorder."
688     o_test = optparse.Option("--test",
689                              metavar="<test_script_file>",
690                              type="string",
691                              action="store",
692                              dest="test_script_file",
693                              help=help_str)
694
695     # Reproducing test script with help of TestRecorder. Default: False.
696     help_str = "Reproducing test script with help of TestRecorder."
697     o_play = optparse.Option("--play",
698                              metavar="<play_script_file>",
699                              type="string",
700                              action="store",
701                              dest="play_script_file",
702                              help=help_str)
703
704     # gdb session
705     help_str = "Launch session with gdb"
706     o_gdb = optparse.Option("--gdb-session",
707                             action="store_true",
708                             dest="gdb_session", default=False,
709                             help=help_str)
710
711     # ddd session
712     help_str = "Launch session with ddd"
713     o_ddd = optparse.Option("--ddd-session",
714                             action="store_true",
715                             dest="ddd_session", default=False,
716                             help=help_str)
717
718
719     # valgrind session
720     help_str = "Launch session with valgrind $VALGRIND_OPTIONS"
721     o_valgrind = optparse.Option("--valgrind-session",
722                                  action="store_true",
723                                  dest="valgrind_session", default=False,
724                                  help=help_str)
725
726     # shutdown-servers. Default: False.
727     help_str  = "1 to shutdown standalone servers when leaving python interpreter, "
728     help_str += "0 to keep the standalone servers as daemon [default]. "
729     help_str += "This option is only useful in batchmode "
730     help_str += "(terminal mode or without showing desktop)."
731     o_shutdown = optparse.Option("--shutdown-servers",
732                                  metavar="<1/0>",
733                                  #type="choice", choices=boolean_choices,
734                                  type="string",
735                                  action="callback", callback=store_boolean, callback_args=('shutdown_servers',),
736                                  dest="shutdown_servers",
737                                  help=help_str)
738
739     # foreground. Default: True.
740     help_str  = "0 and runSalome exits after have launched the gui, "
741     help_str += "1 to launch runSalome in foreground mode [default]."
742     o_foreground = optparse.Option("--foreground",
743                                    metavar="<1/0>",
744                                    #type="choice", choices=boolean_choices,
745                                    type="string",
746                                    action="callback", callback=store_boolean, callback_args=('foreground',),
747                                    dest="foreground",
748                                    help=help_str)
749
750     # wake up session
751     help_str  = "Wake up a previously closed session. "
752     help_str += "The session object is found in the naming service pointed by the variable OMNIORB_CONFIG. "
753     help_str += "If this variable is not setted, the last configuration is taken. "
754     o_wake_up = optparse.Option("--wake-up-session",
755                                 action="store_true",
756                                 dest="wake_up_session", default=False,
757                                 help=help_str)
758
759     # server launch mode
760     help_str = "Mode used to launch server processes (daemon or fork)."
761     o_slm = optparse.Option("--server-launch-mode",
762                             metavar="<server_launch_mode>",
763                             type="choice",
764                             choices=["daemon","fork"],
765                             action="store",
766                             dest="server_launch_mode",
767                             help=help_str)
768
769     # use port
770     help_str  = "Preferable port SALOME to be started on. "
771     help_str += "If specified port is not busy, SALOME session will start on it; "
772     help_str += "otherwise, any available port will be searched and used."
773     o_port = optparse.Option("--port",
774                              metavar="<port>",
775                              type="int",
776                                    action="store",
777                              dest="use_port",
778                                    help=help_str)
779
780     # SIMAN launch mode
781     help_str = "Special mode for interacting with SIMAN."
782     o_siman = optparse.Option("--siman",
783                               action="store_true",
784                               dest="siman",
785                               help=help_str)
786
787     # SIMAN study
788     help_str = "SIMAN study identifier."
789     o_siman_study = optparse.Option("--siman-study",
790                                     metavar="<id>",
791                                     type="string",
792                                     action="store",
793                                     dest="siman_study",
794                                     help=help_str)
795
796     # SIMAN scenario
797     help_str = "SIMAN scenario identifier."
798     o_siman_scenario = optparse.Option("--siman-scenario",
799                                        metavar="<id>",
800                                        type="string",
801                                        action="store",
802                                        dest="siman_scenario",
803                                        help=help_str)
804
805     # SIMAN user
806     help_str = "SIMAN user identifier."
807     o_siman_user = optparse.Option("--siman-user",
808                                    metavar="<id>",
809                                    type="string",
810                                    action="store",
811                                    dest="siman_user",
812                                    help=help_str)
813
814     # All options
815     opt_list = [o_t,o_g, # GUI/Terminal
816                 o_d,o_o, # Desktop
817                 o_b,     # Batch
818                 o_l,o_f, # Use logger or log-file
819                 o_r,     # Configuration XML file
820                 o_x,     # xterm
821                 o_m,     # Modules
822                 o_e,     # Embedded servers
823                 o_s,     # Standalone servers
824                 o_p,     # Kill with port
825                 o_k,     # Kill all
826                 o_i,     # Additional python interpreters
827                 o_z,     # Splash
828                 o_c,     # Catch exceptions
829                 o_a,     # Print free port and exit
830                 o_n,     # --nosave-config
831                 o_pi,    # Interactive python console
832                 o_nspl,
833                 o_test,  # Write/read test script file with help of TestRecorder
834                 o_play,  # Reproducing test script with help of TestRecorder
835                 o_gdb,
836                 o_ddd,
837                 o_valgrind,
838                 o_shutdown,
839                 o_foreground,
840                 o_wake_up,
841                 o_slm,   # Server launch mode
842                 o_port,  # Use port
843                 o_siman,         # Siman launch mode
844                 o_siman_study,   # Siman study
845                 o_siman_scenario,# Siman scenario
846                 o_siman_user,    # Siman user
847                 ]
848
849     #std_options = ["gui", "desktop", "log_file", "resources",
850     #               "xterm", "modules", "embedded", "standalone",
851     #               "portkill", "killall", "interp", "splash",
852     #               "catch_exceptions", "print_port", "save_config", "ns_port_log_file"]
853
854     opt_list += theAdditionalOptions
855
856     a_usage = """%prog [options] [STUDY_FILE] [PYTHON_FILE [args] [PYTHON_FILE [args]...]]
857 Python file arguments, if any, must be comma-separated (without blank characters) and prefixed by "args:" (without quotes), e.g. myscript.py args:arg1,arg2=val,...
858 """
859     version_str = "Salome %s" % version()
860     pars = optparse.OptionParser(usage=a_usage, version=version_str, option_list=opt_list)
861
862     return pars
863
864 # -----------------------------------------------------------------------------
865
866 ###
867 # Get the environment
868 ###
869
870 # this attribute is obsolete
871 args = {}
872 #def get_env():
873 #args = []
874 def get_env(theAdditionalOptions=[], appname=salomeappname, cfgname=salomecfgname):
875     ###
876     # Collect launch configuration files:
877     # - The environment variable "<appname>Config" (SalomeAppConfig) which can
878     #   define a list of directories (separated by ':' or ';' symbol) is checked
879     # - If the environment variable "<appname>Config" is not set, only
880     #   ${GUI_ROOT_DIR}/share/salome/resources/gui is inspected
881     # - ${GUI_ROOT_DIR}/share/salome/resources/gui directory is always inspected
882     #   so it is not necessary to put it in the "<appname>Config" variable
883     # - The directories which are inspected are checked for files "<appname?salomeappname>.xml"
884     #  (SalomeApp.xml) which define SALOME configuration
885     # - These directories are analyzed beginning from the last one in the list,
886     #   so the first directory listed in "<appname>Config" environment variable
887     #   has higher priority: it means that if some configuration options
888     #   is found in the next analyzed cofiguration file - it will be replaced
889     # - The last configuration file which is parsed is user configuration file
890     #   situated in the home directory (if it exists):
891     #   * ~/.config/salome/.<appname>rc[.<version>]" for Linux (e.g. ~/.config/salome/.SalomeApprc.6.4.0)
892     #   * ~/<appname>.xml[.<version>] for Windows (e.g. ~/SalomeApp.xml.6.4.0)
893     # - Command line options have the highest priority and replace options
894     #   specified in configuration file(s)
895     ###
896
897     global args
898     config_var = appname+'Config'
899
900     separator = ":"
901     if os.sys.platform == 'win32':
902         separator = ";"
903
904     # check KERNEL_ROOT_DIR
905     try:
906         kernel_root_dir=os.environ["KERNEL_ROOT_DIR"]
907     except:
908         print """
909         For each SALOME module, the environment variable <moduleN>_ROOT_DIR must be set.
910         KERNEL_ROOT_DIR is mandatory.
911         """
912         sys.exit(1)
913         pass
914
915     ############################
916     # parse command line options
917     pars = CreateOptionParser(theAdditionalOptions)
918     (cmd_opts, cmd_args) = pars.parse_args(sys.argv[1:])
919     ############################
920
921     # Process --print-port option
922     if cmd_opts.print_port:
923         from searchFreePort import searchFreePort
924         searchFreePort({})
925         print "port:%s"%(os.environ['NSPORT'])
926         sys.exit(0)
927         pass
928
929     # set resources variable SalomeAppConfig if it is not set yet
930     dirs = []
931     if os.getenv(config_var):
932         if sys.platform == 'win32':
933             dirs += re.split(';', os.getenv(config_var))
934         else:
935             dirs += re.split('[;|:]', os.getenv(config_var))
936
937     gui_available = True
938     if os.getenv("GUI_ROOT_DIR") and os.path.isdir( os.getenv("GUI_ROOT_DIR") + "/share/salome/resources/gui" ):
939         dirs += [os.getenv("GUI_ROOT_DIR") + "/share/salome/resources/gui"]
940         pass
941     else:
942         gui_available = False
943         if os.getenv("KERNEL_ROOT_DIR") and os.path.isdir( os.getenv("KERNEL_ROOT_DIR") + "/bin/salome/appliskel" ):
944             dirs += [os.getenv("KERNEL_ROOT_DIR") + "/bin/salome/appliskel"]
945         pass
946     os.environ[config_var] = separator.join(dirs)
947
948     dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
949
950     try:
951         dirs.remove('') # to remove empty dirs if the variable terminate by ":" or if there are "::" inside
952     except:
953         pass
954
955     _opts = {} # associative array of options to be filled
956
957     # parse SalomeApp.xml files in directories specified by SalomeAppConfig env variable
958     for dir in dirs:
959         filename = os.path.join(dir, appname+'.xml')
960         if not os.path.exists(filename):
961             if verbose(): print "Configure parser: Warning : can not find configuration file %s" % filename
962         else:
963             try:
964                 p = xml_parser(filename, _opts, [])
965                 _opts = p.opts
966             except:
967                 if verbose(): print "Configure parser: Error : can not read configuration file %s" % filename
968             pass
969
970     # parse user configuration file
971     # It can be set via --resources=<file> command line option
972     # or is given from default location (see defaultUserFile() function)
973     # If user file for the current version is not found the nearest to it is used
974     user_config = cmd_opts.resources
975     if not user_config:
976         user_config = userFile(appname, cfgname)
977         if verbose(): print "Configure parser: user configuration file is", user_config
978     if not user_config or not os.path.exists(user_config):
979         if verbose(): print "Configure parser: Warning : can not find user configuration file"
980     else:
981         try:
982             p = xml_parser(user_config, _opts, [])
983             _opts = p.opts
984         except:
985             if verbose(): print 'Configure parser: Error : can not read user configuration file'
986             user_config = ""
987
988     args = _opts
989
990     args['user_config'] = user_config
991     #print "User Configuration file: ", args['user_config']
992
993     # set default values for options which are NOT set in config files
994     for aKey in listKeys:
995         if not args.has_key( aKey ):
996             args[aKey]=[]
997
998     for aKey in boolKeys:
999         if not args.has_key( aKey ):
1000             args[aKey]=0
1001
1002     if args[file_nam]:
1003         afile=args[file_nam]
1004         args[file_nam]=[afile]
1005
1006     args[appname_nam] = appname
1007
1008     # get the port number
1009     my_port = getPortNumber()
1010
1011     args[port_nam] = my_port
1012
1013     ####################################################
1014     # apply command-line options to the arguments
1015     # each option given in command line overrides the option from xml config file
1016     #
1017     # Options: gui, desktop, log_file, resources,
1018     #          xterm, modules, embedded, standalone,
1019     #          portkill, killall, interp, splash,
1020     #          catch_exceptions, pinter
1021
1022     # GUI/Terminal, Desktop, Splash, STUDY_HDF
1023     args["session_gui"] = False
1024     args[batch_nam] = False
1025     args["study_hdf"] = None
1026     if cmd_opts.gui is not None:
1027         args[gui_nam] = cmd_opts.gui
1028     if cmd_opts.batch is not None:
1029         args[batch_nam] = True
1030
1031     if not gui_available:
1032         args[gui_nam] = False
1033
1034     if args[gui_nam]:
1035         args["session_gui"] = True
1036         if cmd_opts.desktop is not None:
1037             args["session_gui"] = cmd_opts.desktop
1038             args[splash_nam]    = cmd_opts.desktop
1039         if args["session_gui"]:
1040             if cmd_opts.splash is not None:
1041                 args[splash_nam] = cmd_opts.splash
1042     else:
1043         args["session_gui"] = False
1044         args[splash_nam] = False
1045
1046     # Logger/Log file
1047     if cmd_opts.log_file is not None:
1048         if cmd_opts.log_file == 'CORBA':
1049             args[logger_nam] = True
1050         else:
1051             args[file_nam] = [cmd_opts.log_file]
1052
1053     # Naming Service port log file
1054     if cmd_opts.ns_port_log_file is not None:
1055       args["ns_port_log_file"] = cmd_opts.ns_port_log_file
1056
1057     # Study files
1058     for arg in cmd_args:
1059         if arg[-4:] == ".hdf" and not args["study_hdf"]:
1060             args["study_hdf"] = arg
1061
1062     # Python scripts
1063     args[script_nam] = getScriptsAndArgs(cmd_args)
1064     new_args = []
1065     if args[gui_nam]:
1066         for d in args[script_nam]:
1067             for s, a in d.items():
1068                 v = re.sub(r'^python.*\s+', r'', s)
1069                 new_args.append({v:a})
1070         #
1071         args[script_nam] = new_args
1072
1073     # xterm
1074     if cmd_opts.xterm is not None: args[xterm_nam] = cmd_opts.xterm
1075
1076     # Modules
1077     if cmd_opts.modules is not None:
1078         args[modules_nam] = []
1079         listlist = cmd_opts.modules
1080         for listi in listlist:
1081             args[modules_nam] += re.split( "[:;,]", listi)
1082     else:
1083         # if --modules (-m) command line option is not given
1084         # try SALOME_MODULES environment variable
1085         if os.getenv( "SALOME_MODULES" ):
1086             args[modules_nam] = re.split( "[:;,]", os.getenv( "SALOME_MODULES" ) )
1087             pass
1088
1089     # Embedded
1090     if cmd_opts.embedded is not None:
1091         args[embedded_nam] = filter( lambda a: a.strip(), re.split( "[:;,]", cmd_opts.embedded ) )
1092
1093     # Standalone
1094     if cmd_opts.standalone is not None:
1095         args[standalone_nam] = filter( lambda a: a.strip(), re.split( "[:;,]", cmd_opts.standalone ) )
1096
1097     # Normalize the '--standalone' and '--embedded' parameters
1098     standalone, embedded = process_containers_params( args.get( standalone_nam ),
1099                                                       args.get( embedded_nam ) )
1100     if standalone is not None:
1101         args[ standalone_nam ] = standalone
1102     if embedded is not None:
1103         args[ embedded_nam ] = embedded
1104
1105     # Kill
1106     if cmd_opts.portkill is not None: args[portkill_nam] = cmd_opts.portkill
1107     if cmd_opts.killall  is not None: args[killall_nam]  = cmd_opts.killall
1108
1109     # Interpreter
1110     if cmd_opts.interp is not None:
1111         args[interp_nam] = cmd_opts.interp
1112
1113     # Exceptions
1114     if cmd_opts.catch_exceptions is not None:
1115         args[except_nam] = not cmd_opts.catch_exceptions
1116
1117     # Relink config file
1118     if cmd_opts.save_config is not None:
1119         args['save_config'] = cmd_opts.save_config
1120
1121     # Interactive python console
1122     if cmd_opts.pinter is not None:
1123         args[pinter_nam] = cmd_opts.pinter
1124
1125     # Gdb session in xterm
1126     if cmd_opts.gdb_session is not None:
1127         args[gdb_session_nam] = cmd_opts.gdb_session
1128
1129     # Ddd session in xterm
1130     if cmd_opts.ddd_session is not None:
1131         args[ddd_session_nam] = cmd_opts.ddd_session
1132
1133     # valgrind session
1134     if cmd_opts.valgrind_session is not None:
1135         args[valgrind_session_nam] = cmd_opts.valgrind_session
1136
1137     # Shutdown servers
1138     if cmd_opts.shutdown_servers is None:
1139         args[shutdown_servers_nam] = 0
1140     else:
1141         args[shutdown_servers_nam] = cmd_opts.shutdown_servers
1142         pass
1143
1144     # Foreground
1145     if cmd_opts.foreground is None:
1146         args[foreground_nam] = 1
1147     else:
1148         args[foreground_nam] = cmd_opts.foreground
1149         pass
1150
1151     # wake up session
1152     if cmd_opts.wake_up_session is not None:
1153         args[wake_up_session_nam] = cmd_opts.wake_up_session
1154
1155     # siman options
1156     if cmd_opts.siman is not None:
1157         args[siman_nam] = cmd_opts.siman
1158     if cmd_opts.siman_study is not None:
1159         args[siman_study_nam] = cmd_opts.siman_study
1160     if cmd_opts.siman_scenario is not None:
1161         args[siman_scenario_nam] = cmd_opts.siman_scenario
1162     if cmd_opts.siman_user is not None:
1163         args[siman_user_nam] = cmd_opts.siman_user
1164
1165     ####################################################
1166     # Add <theAdditionalOptions> values to args
1167     for add_opt in theAdditionalOptions:
1168         cmd = "args[\"%s\"] = cmd_opts.%s"%(add_opt.dest,add_opt.dest)
1169         exec(cmd)
1170     ####################################################
1171
1172     # disable signals handling
1173     if args[except_nam] == 1:
1174         os.environ["NOT_INTERCEPT_SIGNALS"] = "1"
1175         pass
1176
1177     # now modify SalomeAppConfig environment variable
1178     # to take into account the SALOME modules
1179     if os.sys.platform == 'win32':
1180         dirs = re.split('[;]', os.environ[config_var] )
1181     else:
1182         dirs = re.split('[;|:]', os.environ[config_var] )
1183     for m in args[modules_nam]:
1184         if m not in ["KERNEL", "GUI", ""] and os.getenv("%s_ROOT_DIR"%m):
1185             d1 = os.getenv("%s_ROOT_DIR"%m) + "/share/salome/resources/" + m.lower()
1186             d2 = os.getenv("%s_ROOT_DIR"%m) + "/share/salome/resources"
1187             #if os.path.exists( "%s/%s.xml"%(d1, appname) ):
1188             if os.path.exists( "%s/%s.xml"%(d1, salomeappname) ):
1189                 dirs.append( d1 )
1190             #elif os.path.exists( "%s/%s.xml"%(d2, appname) ):
1191             elif os.path.exists( "%s/%s.xml"%(d2, salomeappname) ):
1192                 dirs.append( d2 )
1193         else:
1194             #print "* '"+m+"' should be deleted from ",args[modules_nam]
1195             pass
1196
1197     # Test
1198     if cmd_opts.test_script_file is not None:
1199         args[test_nam] = []
1200         filename = cmd_opts.test_script_file
1201         args[test_nam] += re.split( "[:;,]", filename )
1202
1203     # Play
1204     if cmd_opts.play_script_file is not None:
1205         args[play_nam] = []
1206         filename = cmd_opts.play_script_file
1207         args[play_nam] += re.split( "[:;,]", filename )
1208
1209     # Server launch command
1210     if cmd_opts.server_launch_mode is not None:
1211         args["server_launch_mode"] = cmd_opts.server_launch_mode
1212
1213     # Server launch command
1214     if cmd_opts.use_port is not None:
1215         min_port = 2810
1216         max_port = min_port + 100
1217         if cmd_opts.use_port not in xrange(min_port, max_port+1):
1218             print "Error: port number should be in range [%d, %d])" % (min_port, max_port)
1219             sys.exit(1)
1220         args[useport_nam] = cmd_opts.use_port
1221
1222     # return arguments
1223     os.environ[config_var] = separator.join(dirs)
1224     #print "Args: ", args
1225     return args