1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
4 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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, or (at your option) any later version.
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.
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
21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 import os, glob, string, sys, re
29 from salome_utils import verbose, getPortNumber, getHomeDir
31 # names of tags in XML configuration file
37 # names of attributes in XML configuration file
41 # certain values in XML configuration file ("launch" section)
49 portkill_nam = "portkill"
50 killall_nam = "killall"
51 modules_nam = "modules"
52 embedded_nam = "embedded"
53 standalone_nam = "standalone"
55 terminal_nam = "terminal"
57 except_nam = "noexcepthandler"
58 terminal_nam = "terminal"
64 gdb_session_nam = "gdb_session"
65 ddd_session_nam = "ddd_session"
66 valgrind_session_nam = "valgrind_session"
67 shutdown_servers_nam = "shutdown_servers"
68 foreground_nam = "foreground"
69 wake_up_session_nam = "wake_up_session"
71 # values in XML configuration file giving specific module parameters (<module_name> section)
72 # which are stored in opts with key <module_name>_<parameter> (eg SMESH_plugins)
73 plugins_nam = "plugins"
75 # values passed as arguments, NOT read from XML config file, but set from within this script
76 appname_nam = "appname"
78 useport_nam = "useport"
79 salomecfgname = "salome"
80 salomeappname = "SalomeApp"
81 script_nam = "pyscript"
83 # possible choices for the "embedded" and "standalone" parameters
84 embedded_choices = [ "registry", "study", "moduleCatalog", "cppContainer", "SalomeAppEngine" ]
85 standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer"]
87 # values of boolean type (must be '0' or '1').
88 # xml_parser.boolValue() is used for correct setting
89 boolKeys = ( gui_nam, splash_nam, logger_nam, file_nam, xterm_nam, portkill_nam, killall_nam, except_nam, pinter_nam, shutdown_servers_nam )
90 intKeys = ( interp_nam, )
93 listKeys = ( embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )
96 # Get the application version
97 # Uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION file
102 root_dir = os.environ.get( 'KERNEL_ROOT_DIR', '' ) # KERNEL_ROOT_DIR or "" if not found
103 version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
104 if root_dir and os.path.exists( version_file ):
105 filename = version_file
106 root_dir = os.environ.get( 'GUI_ROOT_DIR', '' ) # GUI_ROOT_DIR "" if not found
107 version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
108 if root_dir and os.path.exists( version_file ):
109 filename = version_file
111 str = open( filename, "r" ).readline() # str = "THIS IS SALOME - SALOMEGUI VERSION: 3.0.0"
112 match = re.search( r':\s+([a-zA-Z0-9.]+)\s*$', str )
114 return match.group( 1 )
120 # Calculate and return configuration file unique ID
121 # For example: for SALOME version 3.1.0a1 the id is 300999701
123 def version_id(fname):
124 major = minor = release = dev1 = dev2 = 0
125 vers = fname.split(".")
130 # If salome version given is DEV, the call to int('DEV') will fail with
131 # a ValueError exception
134 if len(vers) > 1: minor = int(vers[1])
136 # If salome version given is 7.DEV, the call to int('DEV') will fail with
137 # a ValueError exception
140 mr = re.search(r'^([0-9]+)([A-Z]|RC)?([0-9]*)',vers[2], re.I)
142 release = int(mr.group(1))
144 tag = mr.group(2).strip().lower()
146 dev1 = 49 # release candidate
148 dev1 = ord(tag)-ord('a')+1
151 dev2 = int(mr.group(3).strip())
154 dev = dev1 * 100 + dev2
156 ver = ver * 100 + minor
157 ver = ver * 100 + release
159 if dev > 0: ver = ver - dev
163 # Get default user configuration file name
165 # - on Linux: ~/.config/salome/SalomeApprc[.<version>]
166 # - on Windows: ~/SalomeApp.xml[.<version>]
167 # where <version> is an optional version number
169 def defaultUserFile(appname=salomeappname, cfgname=salomecfgname):
171 filetmpl = sys.platform == "win32" and "{0}.xml.{1}" or "{0}rc.{1}"
173 paths.append(getHomeDir())
174 paths.append(".config")
175 if cfgname: paths.append(cfgname)
176 paths.append(filetmpl.format(appname, v))
177 return os.path.join(*paths)
180 # Get user configuration file name
182 def userFile(appname, cfgname):
185 if not v: return None # unknown version
187 # get default user file name
188 filename = defaultUserFile(appname, cfgname)
189 if not filename: return None # default user file name is bad
191 # check that default user file exists
192 if os.path.exists(filename): return filename # user file is found
194 # otherwise try to detect any appropriate user file
196 # ... calculate default version id
198 if not id0: return None # bad version id -> can't detect appropriate file
200 # ... get all existing user preferences files
201 filetmpl1 = sys.platform == "win32" and "{0}.xml.*" or "{0}rc.*"
202 filetmpl2 = sys.platform == "win32" and filetmpl1 or "." + filetmpl1
205 # Since v6.6.0 - in ~/.config/salome directory, without dot prefix
206 files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl1.format(appname)))
207 # Since v6.5.0 - in ~/.config/salome directory, dot-prefixed (backward compatibility)
208 if filetmpl2 and filetmpl2 != filetmpl1:
209 files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl2.format(appname)))
211 # old style (before v6.5.0) - in ~ directory, dot-prefixed
212 if filetmpl2 and filetmpl2 != filetmpl1:
213 files += glob.glob(os.path.join(getHomeDir(), filetmpl2.format(appname)))
216 # ... loop through all files and find most appopriate file (with closest id)
220 ff = os.path.basename( f )
221 if sys.platform == "win32":
222 match = re.search( r'^{0}\.xml\.([a-zA-Z0-9.]+)$'.format(appname), ff )
224 match = re.search( r'^\.?{0}rc\.([a-zA-Z0-9.]+)$'.format(appname), ff )
226 ver = version_id(match.group(1))
227 if not ver: continue # bad version id -> skip file
228 if appr_id < 0 or abs(appr_id-id0) > abs(ver-id0):
232 elif abs(appr_id-id0) == abs(ver-id0):
233 if not os.path.basename(f).startswith("."): appr_file = f
241 def process_containers_params( standalone, embedded ):
242 # 1. filter inappropriate containers names
243 if standalone is not None:
244 standalone = filter( lambda x: x in standalone_choices, standalone )
245 if embedded is not None:
246 embedded = filter( lambda x: x in embedded_choices, embedded )
248 # 2. remove containers appearing in 'standalone' parameter from the 'embedded'
249 # parameter --> i.e. 'standalone' parameter has higher priority
250 if standalone is not None and embedded is not None:
251 embedded = filter( lambda x: x not in standalone, embedded )
253 # 3. return corrected parameters values
254 return standalone, embedded
256 # -----------------------------------------------------------------------------
259 # XML reader for launch configuration file usage
265 def __init__(self, fileName, _opts, _importHistory):
266 #warning _importHistory=[] is NOT good: is NOT empty,reinitialized after first call
267 if verbose(): print "Configure parser: processing %s ..." % fileName
268 self.fileName = os.path.abspath(fileName)
269 self.importHistory = _importHistory
270 self.importHistory.append(self.fileName)
273 self.section = section_to_skip
274 parser = xml.sax.make_parser()
275 parser.setContentHandler(self)
276 parser.parse(fileName)
277 standalone, embedded = process_containers_params( self.opts.get( standalone_nam ),
278 self.opts.get( embedded_nam ) )
279 if standalone is not None:
280 self.opts[ standalone_nam ] = standalone
281 if embedded is not None:
282 self.opts[ embedded_nam ] = embedded
285 def boolValue( self, str ):
287 if isinstance(strloc, types.UnicodeType):
288 strloc = strloc.encode().strip()
289 if isinstance(strloc, types.StringType):
290 strlow = strloc.lower()
291 if strlow in ("1", "yes", "y", "on", "true", "ok"):
293 elif strlow in ("0", "no", "n", "off", "false", "cancel"):
298 def intValue( self, str ):
300 if isinstance(strloc, types.UnicodeType):
301 strloc = strloc.encode().strip()
302 if isinstance(strloc, types.StringType):
303 strlow = strloc.lower()
304 if strlow in ("1", "yes", "y", "on", "true", "ok"):
306 elif strlow in ("0", "no", "n", "off", "false", "cancel"):
309 return string.atoi(strloc)
313 def strValue( self, str ):
316 if isinstance(strloc, types.UnicodeType): strloc = strloc.encode().strip()
317 else: strloc = strloc.strip()
322 def startElement(self, name, attrs):
323 self.space.append(name)
326 # if we are importing file
327 if self.space == [doc_tag, import_tag] and nam_att in attrs.getNames():
328 self.importFile( attrs.getValue(nam_att) )
330 # if we are analyzing "section" element and its "name" attribute is
331 # either "launch" or module name -- set section_name
332 if self.space == [doc_tag, sec_tag] and nam_att in attrs.getNames():
333 section_name = attrs.getValue( nam_att )
334 if section_name in [lanch_nam, lang_nam]:
335 self.section = section_name # launch section
336 elif self.opts.has_key( modules_nam ) and \
337 section_name in self.opts[ modules_nam ]:
338 self.section = section_name # <module> section
340 self.section = section_to_skip # any other section
343 # if we are analyzing "parameter" elements - children of either
344 # "section launch" or "section "<module>"" element, then store them
345 # in self.opts assiciative array (key = [<module>_ + ] value of "name" attribute)
346 elif self.section != section_to_skip and \
347 self.space == [doc_tag, sec_tag, par_tag] and \
348 nam_att in attrs.getNames() and \
349 val_att in attrs.getNames():
350 nam = attrs.getValue( nam_att )
351 val = attrs.getValue( val_att )
352 if self.section == lanch_nam: # key for launch section
354 else: # key for <module> section
355 key = self.section + "_" + nam
356 key = self.strValue( key )
358 self.opts[key] = self.boolValue( val ) # assign boolean value: 0 or 1
360 self.opts[key] = self.intValue( val ) # assign integer value
361 elif nam in listKeys:
362 self.opts[key] = [ self.strValue( a ) for a in re.split( "[:;,]", val ) ] # assign list value: []
364 self.opts[key] = self.strValue( val ) # string value
368 def endElement(self, name):
371 if self.section != section_to_skip and name == sec_tag:
372 self.section = section_to_skip
375 def characters(self, content):
378 def processingInstruction(self, target, data):
381 def setDocumentLocator(self, locator):
384 def startDocument(self):
388 def endDocument(self):
392 def importFile(self, fname):
394 if os.path.isabs (fname) :
397 absfname = os.path.join(os.path.dirname(self.fileName), fname)
399 # check existing and registry file
400 for ext in ["", ".xml", ".XML"] :
401 if os.path.exists(absfname + ext) :
403 if absfname in self.importHistory :
404 if verbose(): print "Configure parser: Warning : file %s is already imported" % absfname
405 return # already imported
409 if verbose(): print "Configure parser: Error : file %s does not exist" % absfname
414 # copy current options
416 opts = copy.deepcopy(self.opts)
418 imp = xml_parser(absfname, opts, self.importHistory)
420 for key in imp.opts.keys():
421 if not self.opts.has_key(key):
422 self.opts[key] = imp.opts[key]
427 if verbose(): print "Configure parser: Error : can not read configuration file %s" % absfname
431 # -----------------------------------------------------------------------------
433 booleans = { '1': True , 'yes': True , 'y': True , 'on' : True , 'true' : True , 'ok' : True,
434 '0': False, 'no' : False, 'n': False, 'off': False, 'false': False, 'cancel' : False }
436 boolean_choices = booleans.keys()
438 def check_embedded(option, opt, value, parser):
439 from optparse import OptionValueError
440 assert value is not None
441 if parser.values.embedded:
442 embedded = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.embedded ) )
445 if parser.values.standalone:
446 standalone = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.standalone ) )
449 vals = filter( lambda a: a.strip(), re.split( "[:;,]", value ) )
451 if v not in embedded_choices:
452 raise OptionValueError( "option %s: invalid choice: %r (choose from %s)" % ( opt, v, ", ".join( map( repr, embedded_choices ) ) ) )
453 if v not in embedded:
456 del standalone[ standalone.index( v ) ]
458 parser.values.embedded = ",".join( embedded )
459 parser.values.standalone = ",".join( standalone )
462 def check_standalone(option, opt, value, parser):
463 from optparse import OptionValueError
464 assert value is not None
465 if parser.values.embedded:
466 embedded = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.embedded ) )
469 if parser.values.standalone:
470 standalone = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.standalone ) )
473 vals = filter( lambda a: a.strip(), re.split( "[:;,]", value ) )
475 if v not in standalone_choices:
476 raise OptionValueError( "option %s: invalid choice: %r (choose from %s)" % ( opt, v, ", ".join( map( repr, standalone_choices ) ) ) )
477 if v not in standalone:
478 standalone.append( v )
480 del embedded[ embedded.index( v ) ]
482 parser.values.embedded = ",".join( embedded )
483 parser.values.standalone = ",".join( standalone )
486 def store_boolean (option, opt, value, parser, *args):
487 if isinstance(value, types.StringType):
489 value_conv = booleans[value.strip().lower()]
490 for attribute in args:
491 setattr(parser.values, attribute, value_conv)
493 raise optparse.OptionValueError(
494 "option %s: invalid boolean value: %s (choose from %s)"
495 % (opt, value, boolean_choices))
497 for attribute in args:
498 setattr(parser.values, attribute, value)
500 def CreateOptionParser (theAdditionalOptions=None, exeName=None):
501 if theAdditionalOptions is None:
502 theAdditionalOptions = []
503 # GUI/Terminal. Default: GUI
504 help_str = "Launch without GUI (in the terminal mode)."
505 o_t = optparse.Option("-t",
507 action="store_false",
511 help_str = "Launch in Batch Mode. (Without GUI on batch machine)"
512 o_b = optparse.Option("-b",
518 help_str = "Launch in GUI mode [default]."
519 o_g = optparse.Option("-g",
525 # Show Desktop (inly in GUI mode). Default: True
526 help_str = "1 to activate GUI desktop [default], "
527 help_str += "0 to not activate GUI desktop (Session_Server starts, but GUI is not shown). "
528 help_str += "Ignored in the terminal mode."
529 o_d = optparse.Option("-d",
532 #type="choice", choices=boolean_choices,
534 action="callback", callback=store_boolean, callback_args=('desktop',),
537 help_str = "Do not activate GUI desktop (Session_Server starts, but GUI is not shown). "
538 help_str += "The same as --show-desktop=0."
539 o_o = optparse.Option("-o",
541 action="store_false",
545 # Use logger or log-file. Default: nothing.
546 help_str = "Redirect messages to the CORBA collector."
547 #o4 = optparse.Option("-l", "--logger", action="store_true", dest="logger", help=help_str)
548 o_l = optparse.Option("-l",
550 action="store_const", const="CORBA",
553 help_str = "Redirect messages to the <log-file>"
554 o_f = optparse.Option("-f",
556 metavar="<log-file>",
562 # Configuration XML file. Default: see defaultUserFile() function
563 help_str = "Parse application settings from the <file> "
564 help_str += "instead of default %s" % defaultUserFile()
565 o_r = optparse.Option("-r",
573 # Use own xterm for each server. Default: False.
574 help_str = "Launch each SALOME server in own xterm console"
575 o_x = optparse.Option("-x",
581 # Modules. Default: Like in configuration files.
582 help_str = "SALOME modules list (where <module1>, <module2> are the names "
583 help_str += "of SALOME modules which should be available in the SALOME session)"
584 o_m = optparse.Option("-m",
586 metavar="<module1,module2,...>",
592 # Embedded servers. Default: Like in configuration files.
593 help_str = "CORBA servers to be launched in the Session embedded mode. "
594 help_str += "Valid values for <serverN>: %s " % ", ".join( embedded_choices )
595 help_str += "[by default the value from the configuration files is used]"
596 o_e = optparse.Option("-e",
598 metavar="<server1,server2,...>",
602 callback=check_embedded,
605 # Standalone servers. Default: Like in configuration files.
606 help_str = "CORBA servers to be launched in the standalone mode (as separate processes). "
607 help_str += "Valid values for <serverN>: %s " % ", ".join( standalone_choices )
608 help_str += "[by default the value from the configuration files is used]"
609 o_s = optparse.Option("-s",
611 metavar="<server1,server2,...>",
615 callback=check_standalone,
618 # Kill with port. Default: False.
619 help_str = "Kill SALOME with the current port"
620 o_p = optparse.Option("-p",
626 # Kill all. Default: False.
627 help_str = "Kill all running SALOME sessions"
628 o_k = optparse.Option("-k",
634 # Additional python interpreters. Default: 0.
635 help_str = "The number of additional external python interpreters to run. "
636 help_str += "Each additional python interpreter is run in separate "
637 help_str += "xterm session with properly set SALOME environment"
638 o_i = optparse.Option("-i",
646 # Splash. Default: True.
647 help_str = "1 to display splash screen [default], "
648 help_str += "0 to disable splash screen. "
649 help_str += "This option is ignored in the terminal mode. "
650 help_str += "It is also ignored if --show-desktop=0 option is used."
651 o_z = optparse.Option("-z",
654 #type="choice", choices=boolean_choices,
656 action="callback", callback=store_boolean, callback_args=('splash',),
660 # Catch exceptions. Default: True.
661 help_str = "1 (yes,true,on,ok) to enable centralized exception handling [default], "
662 help_str += "0 (no,false,off,cancel) to disable centralized exception handling."
663 o_c = optparse.Option("-c",
664 "--catch-exceptions",
666 #type="choice", choices=boolean_choices,
668 action="callback", callback=store_boolean, callback_args=('catch_exceptions',),
669 dest="catch_exceptions",
672 # Print free port and exit
673 help_str = "Print free port and exit"
674 o_a = optparse.Option("--print-port",
676 dest="print_port", default=False,
679 # Do not relink ${HOME}/.omniORB_last.cfg
680 help_str = "Do not save current configuration ${HOME}/.omniORB_last.cfg"
681 o_n = optparse.Option("--nosave-config",
682 action="store_false",
683 dest="save_config", default=True,
686 # Launch with interactive python console. Default: False.
687 help_str = "Launch with interactive python console."
688 o_pi = optparse.Option("--pinter",
693 # Print Naming service port into a user file. Default: False.
694 help_str = "Print Naming Service Port into a user file."
695 o_nspl = optparse.Option("--ns-port-log",
696 metavar="<ns_port_log_file>",
699 dest="ns_port_log_file",
702 # Write/read test script file with help of TestRecorder. Default: False.
703 help_str = "Write/read test script file with help of TestRecorder."
704 o_test = optparse.Option("--test",
705 metavar="<test_script_file>",
708 dest="test_script_file",
711 # Reproducing test script with help of TestRecorder. Default: False.
712 help_str = "Reproducing test script with help of TestRecorder."
713 o_play = optparse.Option("--play",
714 metavar="<play_script_file>",
717 dest="play_script_file",
721 help_str = "Launch session with gdb"
722 o_gdb = optparse.Option("--gdb-session",
724 dest="gdb_session", default=False,
728 help_str = "Launch session with ddd"
729 o_ddd = optparse.Option("--ddd-session",
731 dest="ddd_session", default=False,
736 help_str = "Launch session with valgrind $VALGRIND_OPTIONS"
737 o_valgrind = optparse.Option("--valgrind-session",
739 dest="valgrind_session", default=False,
742 # shutdown-servers. Default: False.
743 help_str = "1 to shutdown standalone servers when leaving python interpreter, "
744 help_str += "0 to keep the standalone servers as daemon [default]. "
745 help_str += "This option is only useful in batchmode "
746 help_str += "(terminal mode or without showing desktop)."
747 o_shutdown = optparse.Option("-w",
748 "--shutdown-servers",
750 #type="choice", choices=boolean_choices,
752 action="callback", callback=store_boolean, callback_args=('shutdown_servers',),
753 dest="shutdown_servers",
756 # foreground. Default: True.
757 help_str = "0 and runSalome exits after have launched the gui, "
758 help_str += "1 to launch runSalome in foreground mode [default]."
759 o_foreground = optparse.Option("--foreground",
761 #type="choice", choices=boolean_choices,
763 action="callback", callback=store_boolean, callback_args=('foreground',),
768 help_str = "Wake up a previously closed session. "
769 help_str += "The session object is found in the naming service pointed by the variable OMNIORB_CONFIG. "
770 help_str += "If this variable is not set, the last configuration is taken. "
771 o_wake_up = optparse.Option("--wake-up-session",
773 dest="wake_up_session", default=False,
777 help_str = "Mode used to launch server processes (daemon or fork)."
778 o_slm = optparse.Option("--server-launch-mode",
779 metavar="<server_launch_mode>",
781 choices=["daemon","fork"],
783 dest="server_launch_mode",
787 help_str = "Preferable port SALOME to be started on. "
788 help_str += "If specified port is not busy, SALOME session will start on it; "
789 help_str += "otherwise, any available port will be searched and used."
790 o_port = optparse.Option("--port",
797 help_str = "Force application language. By default, a language specified in "
798 help_str += "the user's preferences is used."
799 o_lang = optparse.Option("-a",
806 opt_list = [o_t,o_g, # GUI/Terminal
809 o_l,o_f, # Use logger or log-file
810 o_r, # Configuration XML file
813 o_e, # Embedded servers
814 o_s, # Standalone servers
815 o_p, # Kill with port
817 o_i, # Additional python interpreters
819 o_c, # Catch exceptions
820 o_a, # Print free port and exit
821 o_n, # --nosave-config
822 o_pi, # Interactive python console
824 o_test, # Write/read test script file with help of TestRecorder
825 o_play, # Reproducing test script with help of TestRecorder
832 o_slm, # Server launch mode
837 #std_options = ["gui", "desktop", "log_file", "resources",
838 # "xterm", "modules", "embedded", "standalone",
839 # "portkill", "killall", "interp", "splash",
840 # "catch_exceptions", "print_port", "save_config", "ns_port_log_file"]
842 opt_list += theAdditionalOptions
847 a_usage = """%s [options] [STUDY_FILE] [PYTHON_FILE [args] [PYTHON_FILE [args]...]]
848 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,...
850 version_str = "Salome %s" % version()
851 pars = optparse.OptionParser(usage=a_usage, version=version_str, option_list=opt_list)
855 # -----------------------------------------------------------------------------
858 # Get the environment
861 # this attribute is obsolete
865 def get_env(theAdditionalOptions=None, appname=salomeappname, cfgname=salomecfgname, exeName=None):
867 # Collect launch configuration files:
868 # - The environment variable "<appname>Config" (SalomeAppConfig) which can
869 # define a list of directories (separated by ':' or ';' symbol) is checked
870 # - If the environment variable "<appname>Config" is not set, only
871 # ${GUI_ROOT_DIR}/share/salome/resources/gui is inspected
872 # - ${GUI_ROOT_DIR}/share/salome/resources/gui directory is always inspected
873 # so it is not necessary to put it in the "<appname>Config" variable
874 # - The directories which are inspected are checked for files "<appname?salomeappname>.xml"
875 # (SalomeApp.xml) which define SALOME configuration
876 # - These directories are analyzed beginning from the last one in the list,
877 # so the first directory listed in "<appname>Config" environment variable
878 # has higher priority: it means that if some configuration options
879 # is found in the next analyzed cofiguration file - it will be replaced
880 # - The last configuration file which is parsed is user configuration file
881 # situated in the home directory (if it exists):
882 # * ~/.config/salome/.<appname>rc[.<version>]" for Linux (e.g. ~/.config/salome/.SalomeApprc.6.4.0)
883 # * ~/<appname>.xml[.<version>] for Windows (e.g. ~/SalomeApp.xml.6.4.0)
884 # - Command line options have the highest priority and replace options
885 # specified in configuration file(s)
888 if theAdditionalOptions is None:
889 theAdditionalOptions = []
892 config_var = appname+'Config'
894 # check KERNEL_ROOT_DIR
895 kernel_root_dir = os.environ.get("KERNEL_ROOT_DIR", None)
896 if kernel_root_dir is None:
898 For each SALOME module, the environment variable <moduleN>_ROOT_DIR must be set.
899 KERNEL_ROOT_DIR is mandatory.
903 ############################
904 # parse command line options
905 pars = CreateOptionParser(theAdditionalOptions, exeName=exeName)
906 (cmd_opts, cmd_args) = pars.parse_args(sys.argv[1:])
907 ############################
909 # Process --print-port option
910 if cmd_opts.print_port:
911 from searchFreePort import searchFreePort
913 print "port:%s"%(os.environ['NSPORT'])
917 PortManager.releasePort(os.environ['NSPORT'])
924 # set resources variable SalomeAppConfig if it is not set yet
926 if os.getenv(config_var):
927 if sys.platform == 'win32':
928 dirs += re.split(os.pathsep, os.getenv(config_var))
930 dirs += re.split('[;|:]', os.getenv(config_var))
932 gui_available = False
933 if os.getenv("GUI_ROOT_DIR"):
934 gui_resources_dir = os.path.join(os.getenv("GUI_ROOT_DIR"),'share','salome','resources','gui')
935 if os.path.isdir( gui_resources_dir ):
937 dirs.append(gui_resources_dir)
939 if not gui_available:
940 kernel_resources_dir = os.path.join(os.getenv("KERNEL_ROOT_DIR"),'bin','salome','appliskel')
941 if os.getenv("KERNEL_ROOT_DIR") and os.path.isdir( kernel_resources_dir ):
942 dirs.append(kernel_resources_dir)
944 os.environ[config_var] = os.pathsep.join(dirs)
946 dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
949 dirs.remove('') # to remove empty dirs if the variable terminate by ":" or if there are "::" inside
953 _opts = {} # associative array of options to be filled
955 # parse SalomeApp.xml files in directories specified by SalomeAppConfig env variable
957 filename = os.path.join(dir, appname+'.xml')
958 if not os.path.exists(filename):
959 if verbose(): print "Configure parser: Warning : can not find configuration file %s" % filename
962 p = xml_parser(filename, _opts, [])
965 if verbose(): print "Configure parser: Error : can not read configuration file %s" % filename
968 # parse user configuration file
969 # It can be set via --resources=<file> command line option
970 # or is given from default location (see defaultUserFile() function)
971 # If user file for the current version is not found the nearest to it is used
972 user_config = cmd_opts.resources
974 user_config = userFile(appname, cfgname)
975 if verbose(): print "Configure parser: user configuration file is", user_config
976 if not user_config or not os.path.exists(user_config):
977 if verbose(): print "Configure parser: Warning : can not find user configuration file"
980 p = xml_parser(user_config, _opts, [])
983 if verbose(): print 'Configure parser: Error : can not read user configuration file'
988 args['user_config'] = user_config
989 #print "User Configuration file: ", args['user_config']
991 # set default values for options which are NOT set in config files
992 for aKey in listKeys:
993 if not args.has_key( aKey ):
996 for aKey in boolKeys:
997 if not args.has_key( aKey ):
1001 afile=args[file_nam]
1002 args[file_nam] = [afile]
1004 args[appname_nam] = appname
1006 # get the port number
1007 my_port = getPortNumber()
1009 args[port_nam] = my_port
1011 ####################################################
1012 # apply command-line options to the arguments
1013 # each option given in command line overrides the option from xml config file
1015 # Options: gui, desktop, log_file, resources,
1016 # xterm, modules, embedded, standalone,
1017 # portkill, killall, interp, splash,
1018 # catch_exceptions, pinter
1020 # GUI/Terminal, Desktop, Splash, STUDY_HDF
1021 args["session_gui"] = False
1022 args[batch_nam] = False
1023 args["study_hdf"] = None
1024 if cmd_opts.gui is not None:
1025 args[gui_nam] = cmd_opts.gui
1026 if cmd_opts.batch is not None:
1027 args[batch_nam] = True
1029 if not gui_available:
1030 args[gui_nam] = False
1033 args["session_gui"] = True
1034 if cmd_opts.desktop is not None:
1035 args["session_gui"] = cmd_opts.desktop
1036 args[splash_nam] = cmd_opts.desktop
1037 if args["session_gui"]:
1038 if cmd_opts.splash is not None:
1039 args[splash_nam] = cmd_opts.splash
1041 args["session_gui"] = False
1042 args[splash_nam] = False
1045 if cmd_opts.log_file is not None:
1046 if cmd_opts.log_file == 'CORBA':
1047 args[logger_nam] = True
1049 args[file_nam] = [cmd_opts.log_file]
1051 # Naming Service port log file
1052 if cmd_opts.ns_port_log_file is not None:
1053 args["ns_port_log_file"] = cmd_opts.ns_port_log_file
1056 for arg in cmd_args:
1057 if arg[-4:] == ".hdf" and not args["study_hdf"]:
1058 args["study_hdf"] = arg
1061 from salomeContextUtils import getScriptsAndArgs, ScriptAndArgs
1062 args[script_nam] = getScriptsAndArgs(cmd_args)
1063 if args[gui_nam] and args["session_gui"]:
1065 for sa_obj in args[script_nam]: # args[script_nam] is a list of ScriptAndArgs objects
1066 script = re.sub(r'^python.*\s+', r'', sa_obj.script)
1067 new_args.append(ScriptAndArgs(script=script, args=sa_obj.args, out=sa_obj.out))
1069 args[script_nam] = new_args
1072 if cmd_opts.xterm is not None: args[xterm_nam] = cmd_opts.xterm
1075 if cmd_opts.modules is not None:
1076 args[modules_nam] = []
1077 listlist = cmd_opts.modules
1078 for listi in listlist:
1079 args[modules_nam] += re.split( "[:;,]", listi)
1081 # if --modules (-m) command line option is not given
1082 # try SALOME_MODULES environment variable
1083 if os.getenv( "SALOME_MODULES" ):
1084 args[modules_nam] = re.split( "[:;,]", os.getenv( "SALOME_MODULES" ) )
1088 if cmd_opts.embedded is not None:
1089 args[embedded_nam] = filter( lambda a: a.strip(), re.split( "[:;,]", cmd_opts.embedded ) )
1092 if cmd_opts.standalone is not None:
1093 args[standalone_nam] = filter( lambda a: a.strip(), re.split( "[:;,]", cmd_opts.standalone ) )
1095 # Normalize the '--standalone' and '--embedded' parameters
1096 standalone, embedded = process_containers_params( args.get( standalone_nam ),
1097 args.get( embedded_nam ) )
1098 if standalone is not None:
1099 args[ standalone_nam ] = standalone
1100 if embedded is not None:
1101 args[ embedded_nam ] = embedded
1104 if cmd_opts.portkill is not None: args[portkill_nam] = cmd_opts.portkill
1105 if cmd_opts.killall is not None: args[killall_nam] = cmd_opts.killall
1108 if cmd_opts.interp is not None:
1109 args[interp_nam] = cmd_opts.interp
1112 if cmd_opts.catch_exceptions is not None:
1113 args[except_nam] = not cmd_opts.catch_exceptions
1115 # Relink config file
1116 if cmd_opts.save_config is not None:
1117 args['save_config'] = cmd_opts.save_config
1119 # Interactive python console
1120 if cmd_opts.pinter is not None:
1121 args[pinter_nam] = cmd_opts.pinter
1123 # Gdb session in xterm
1124 if cmd_opts.gdb_session is not None:
1125 args[gdb_session_nam] = cmd_opts.gdb_session
1127 # Ddd session in xterm
1128 if cmd_opts.ddd_session is not None:
1129 args[ddd_session_nam] = cmd_opts.ddd_session
1132 if cmd_opts.valgrind_session is not None:
1133 args[valgrind_session_nam] = cmd_opts.valgrind_session
1136 if cmd_opts.shutdown_servers is None:
1137 args[shutdown_servers_nam] = 0
1139 args[shutdown_servers_nam] = cmd_opts.shutdown_servers
1143 if cmd_opts.foreground is None:
1144 args[foreground_nam] = 1
1146 args[foreground_nam] = cmd_opts.foreground
1150 if cmd_opts.wake_up_session is not None:
1151 args[wake_up_session_nam] = cmd_opts.wake_up_session
1153 ####################################################
1154 # Add <theAdditionalOptions> values to args
1155 for add_opt in theAdditionalOptions:
1156 cmd = "args[\"{0}\"] = cmd_opts.{0}".format(add_opt.dest)
1158 ####################################################
1160 # disable signals handling
1161 if args[except_nam] == 1:
1162 os.environ["NOT_INTERCEPT_SIGNALS"] = "1"
1165 # now modify SalomeAppConfig environment variable
1166 # to take into account the SALOME modules
1167 if os.sys.platform == 'win32':
1168 dirs = re.split('[;]', os.environ[config_var] )
1170 dirs = re.split('[;|:]', os.environ[config_var] )
1171 for module in args[modules_nam]:
1172 if module not in ["KERNEL", "GUI", ""] and os.getenv("{0}_ROOT_DIR".format(module)):
1173 d1 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources",module.lower())
1174 d2 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources")
1175 #if os.path.exists( "%s/%s.xml"%(d1, appname) ):
1176 if os.path.exists( os.path.join(d1,"{0}.xml".format(salomeappname)) ):
1178 #elif os.path.exists( "%s/%s.xml"%(d2, appname) ):
1179 elif os.path.exists( os.path.join(d2,"{0}.xml".format(salomeappname)) ):
1182 #print "* '"+m+"' should be deleted from ",args[modules_nam]
1186 if cmd_opts.test_script_file is not None:
1188 filename = cmd_opts.test_script_file
1189 args[test_nam] += re.split( "[:;,]", filename )
1192 if cmd_opts.play_script_file is not None:
1194 filename = cmd_opts.play_script_file
1195 args[play_nam] += re.split( "[:;,]", filename )
1197 # Server launch command
1198 if cmd_opts.server_launch_mode is not None:
1199 args["server_launch_mode"] = cmd_opts.server_launch_mode
1201 # Server launch command
1202 if cmd_opts.use_port is not None:
1204 max_port = min_port + 100
1205 if cmd_opts.use_port not in xrange(min_port, max_port+1):
1206 print "Error: port number should be in range [%d, %d])" % (min_port, max_port)
1208 args[useport_nam] = cmd_opts.use_port
1210 if cmd_opts.language is not None:
1211 langs = args["language_languages"] if "language_languages" in args else []
1212 if cmd_opts.language not in langs:
1213 print "Error: unsupported language: %s" % cmd_opts.language
1215 args[lang_nam] = cmd_opts.language
1218 os.environ[config_var] = os.pathsep.join(dirs)
1219 #print "Args: ", args