1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2022 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
31 from salome_utils import verbose, getPortNumber, getHomeDir
34 # names of tags in XML configuration file
40 # names of attributes in XML configuration file
44 # certain values in XML configuration file ("launch" section)
52 portkill_nam = "portkill"
53 killall_nam = "killall"
54 modules_nam = "modules"
55 embedded_nam = "embedded"
56 standalone_nam = "standalone"
58 terminal_nam = "terminal"
60 except_nam = "noexcepthandler"
61 terminal_nam = "terminal"
67 gdb_session_nam = "gdb_session"
68 ddd_session_nam = "ddd_session"
69 valgrind_session_nam = "valgrind_session"
70 shutdown_servers_nam = "shutdown_servers"
71 foreground_nam = "foreground"
72 wake_up_session_nam = "wake_up_session"
73 launcher_only_nam = "launcher_only"
74 launcher_nam = "launcher"
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"
80 # values passed as arguments, NOT read from XML config file, but set from within this script
81 appname_nam = "appname"
83 useport_nam = "useport"
84 salomecfgname = "salome"
85 salomeappname = "SalomeApp"
86 script_nam = "pyscript"
87 verbosity_nam = "verbosity"
88 on_demand_nam = "on_demand"
90 # possible choices for the "embedded" and "standalone" parameters
91 embedded_choices = [ "registry", "study", "moduleCatalog", "cppContainer", "SalomeAppEngine" ]
92 standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer"]
94 # values of boolean type (must be '0' or '1').
95 # xml_parser.boolValue() is used for correct setting
96 boolKeys = ( gui_nam, splash_nam, logger_nam, file_nam, xterm_nam, portkill_nam, killall_nam, except_nam, pinter_nam, shutdown_servers_nam, launcher_only_nam, on_demand_nam )
97 intKeys = ( interp_nam, )
98 strKeys = ( launcher_nam )
100 # values of list type
101 listKeys = ( embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )
104 # Get the application version
105 # Uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION file
110 root_dir = os.environ.get( 'KERNEL_ROOT_DIR', '' ) # KERNEL_ROOT_DIR or "" if not found
111 version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
112 if root_dir and os.path.exists( version_file ):
113 filename = version_file
114 root_dir = os.environ.get( 'GUI_ROOT_DIR', '' ) # GUI_ROOT_DIR "" if not found
115 version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
116 if root_dir and os.path.exists( version_file ):
117 filename = version_file
119 with open(filename, "r") as f:
120 v = f.readline() # v = "THIS IS SALOME - SALOMEGUI VERSION: 3.0.0"
121 match = re.search( r':\s+([a-zA-Z0-9.]+)\s*$', v )
123 return match.group( 1 )
129 # Calculate and return configuration file unique ID
130 # For example: for SALOME version 3.1.0a1 the id is 300999701
132 def version_id(fname):
133 major = minor = release = dev1 = dev2 = 0
134 vers = fname.split(".")
139 # If salome version given is DEV, the call to int('DEV') will fail with
140 # a ValueError exception
143 if len(vers) > 1: minor = int(vers[1])
145 # If salome version given is 7.DEV, the call to int('DEV') will fail with
146 # a ValueError exception
149 mr = re.search(r'^([0-9]+)([A-Z]|RC)?([0-9]*)',vers[2], re.I)
151 release = int(mr.group(1))
153 tag = mr.group(2).strip().lower()
155 dev1 = 49 # release candidate
157 dev1 = ord(tag)-ord('a')+1
160 dev2 = int(mr.group(3).strip())
163 dev = dev1 * 100 + dev2
165 ver = ver * 100 + minor
166 ver = ver * 100 + release
168 if dev > 0: ver = ver - dev
172 # Get default user configuration file name
174 # - on Linux: ~/.config/salome/SalomeApprc[.<version>]
175 # - on Windows: ~/SalomeApp.xml[.<version>]
176 # where <version> is an optional version number
178 def defaultUserFile(appname=salomeappname, cfgname=salomecfgname):
180 filetmpl = sys.platform == "win32" and "{0}.xml.{1}" or "{0}rc.{1}"
182 paths.append(getHomeDir())
183 paths.append(".config")
184 if cfgname: paths.append(cfgname)
185 paths.append(filetmpl.format(appname, v))
186 return os.path.join(*paths)
189 # Get user configuration file name
191 def userFile(appname, cfgname):
194 if not v: return None # unknown version
196 # get default user file name
197 filename = defaultUserFile(appname, cfgname)
198 if not filename: return None # default user file name is bad
200 # check that default user file exists
201 if os.path.exists(filename): return filename # user file is found
203 # otherwise try to detect any appropriate user file
205 # ... calculate default version id
207 if not id0: return None # bad version id -> can't detect appropriate file
209 # ... get all existing user preferences files
210 filetmpl1 = sys.platform == "win32" and "{0}.xml.*" or "{0}rc.*"
211 filetmpl2 = sys.platform == "win32" and filetmpl1 or "." + filetmpl1
214 # Since v6.6.0 - in ~/.config/salome directory, without dot prefix
215 files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl1.format(appname)))
216 # Since v6.5.0 - in ~/.config/salome directory, dot-prefixed (backward compatibility)
217 if filetmpl2 and filetmpl2 != filetmpl1:
218 files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl2.format(appname)))
220 # old style (before v6.5.0) - in ~ directory, dot-prefixed
221 if filetmpl2 and filetmpl2 != filetmpl1:
222 files += glob.glob(os.path.join(getHomeDir(), filetmpl2.format(appname)))
225 # ... loop through all files and find most appropriate file (with closest id)
229 ff = os.path.basename( f )
230 if sys.platform == "win32":
231 match = re.search( r'^{0}\.xml\.([a-zA-Z0-9.]+)$'.format(appname), ff )
233 match = re.search( r'^\.?{0}rc\.([a-zA-Z0-9.]+)$'.format(appname), ff )
235 ver = version_id(match.group(1))
236 if not ver: continue # bad version id -> skip file
237 if appr_id < 0 or abs(appr_id-id0) > abs(ver-id0):
241 elif abs(appr_id-id0) == abs(ver-id0):
242 if not os.path.basename(f).startswith("."): appr_file = f
250 def process_containers_params( standalone, embedded ):
251 # 1. filter inappropriate containers names
252 if standalone is not None:
253 standalone = [x for x in standalone if x in standalone_choices]
254 if embedded is not None:
255 embedded = [x for x in embedded if x in embedded_choices]
257 # 2. remove containers appearing in 'standalone' parameter from the 'embedded'
258 # parameter --> i.e. 'standalone' parameter has higher priority
259 if standalone is not None and embedded is not None:
260 embedded = [x for x in embedded if x not in standalone]
262 # 3. return corrected parameters values
263 return standalone, embedded
265 # -----------------------------------------------------------------------------
268 # XML reader for launch configuration file usage
274 def __init__(self, fileName, _opts, _importHistory):
275 #warning _importHistory=[] is NOT good: is NOT empty,reinitialized after first call
276 if verbose(): print("Configure parser: processing %s ..." % fileName)
277 self.fileName = os.path.abspath(fileName)
278 self.importHistory = _importHistory
279 self.importHistory.append(self.fileName)
282 self.section = section_to_skip
283 parser = xml.sax.make_parser()
284 parser.setContentHandler(self)
285 parser.parse(fileName)
286 standalone, embedded = process_containers_params( self.opts.get( standalone_nam ),
287 self.opts.get( embedded_nam ) )
288 if standalone is not None:
289 self.opts[ standalone_nam ] = standalone
290 if embedded is not None:
291 self.opts[ embedded_nam ] = embedded
294 def boolValue( self, item):
296 if isinstance(strloc, str):
297 strloc = strloc.encode().strip()
298 if isinstance(strloc, bytes):
299 strlow = strloc.decode().lower()
300 if strlow in ("1", "yes", "y", "on", "true", "ok"):
302 elif strlow in ("0", "no", "n", "off", "false", "cancel"):
307 def intValue( self, item):
309 if isinstance(strloc, str):
310 strloc = strloc.encode().strip()
311 if isinstance(strloc, bytes):
312 strlow = strloc.decode().lower()
313 if strlow in ("1", "yes", "y", "on", "true", "ok"):
315 elif strlow in ("0", "no", "n", "off", "false", "cancel"):
318 return int(strloc.decode())
322 def strValue( self, item):
325 if isinstance( strloc, str):
326 strloc = strloc.strip()
328 if isinstance( strloc, bytes):
329 strloc = strloc.decode().strip()
334 def startElement(self, name, attrs):
335 self.space.append(name)
338 # if we are importing file
339 if self.space == [doc_tag, import_tag] and nam_att in attrs.getNames():
340 self.importFile( attrs.getValue(nam_att) )
342 # if we are analyzing "section" element and its "name" attribute is
343 # either "launch" or module name -- set section_name
344 if self.space == [doc_tag, sec_tag] and nam_att in attrs.getNames():
345 section_name = attrs.getValue( nam_att )
346 if section_name in [lanch_nam, lang_nam]:
347 self.section = section_name # launch section
348 elif modules_nam in self.opts and \
349 section_name in self.opts[ modules_nam ]:
350 self.section = section_name # <module> section
352 self.section = section_to_skip # any other section
355 # if we are analyzing "parameter" elements - children of either
356 # "section launch" or "section "<module>"" element, then store them
357 # in self.opts assiciative array (key = [<module>_ + ] value of "name" attribute)
358 elif self.section != section_to_skip and \
359 self.space == [doc_tag, sec_tag, par_tag] and \
360 nam_att in attrs.getNames() and \
361 val_att in attrs.getNames():
362 nam = attrs.getValue( nam_att )
363 val = attrs.getValue( val_att )
364 if self.section == lanch_nam: # key for launch section
366 else: # key for <module> section
367 key = self.section + "_" + nam
368 key = self.strValue( key )
370 self.opts[key] = self.boolValue( val ) # assign boolean value: 0 or 1
372 self.opts[key] = self.intValue( val ) # assign integer value
374 self.opts[key] = val # assign value
375 elif nam in listKeys:
376 self.opts[key] = [ self.strValue( a ) for a in re.split( "[:;,]", val ) ] # assign list value: []
378 self.opts[key] = self.strValue( val ) # string value
382 def endElement(self, name):
385 if self.section != section_to_skip and name == sec_tag:
386 self.section = section_to_skip
389 def characters(self, content):
392 def processingInstruction(self, target, data):
395 def setDocumentLocator(self, locator):
398 def startDocument(self):
402 def endDocument(self):
406 def importFile(self, fname):
408 if os.path.isabs (fname) :
411 absfname = os.path.join(os.path.dirname(self.fileName), fname)
413 # check existing and registry file
414 for ext in ["", ".xml", ".XML"] :
415 if os.path.exists(absfname + ext) :
417 if absfname in self.importHistory :
418 if verbose(): print("Configure parser: Warning : file %s is already imported" % absfname)
419 return # already imported
423 if verbose(): print("Configure parser: Error : file %s does not exist" % absfname)
428 # copy current options
430 opts = copy.deepcopy(self.opts)
432 imp = xml_parser(absfname, opts, self.importHistory)
435 if key not in self.opts:
436 self.opts[key] = imp.opts[key]
441 if verbose(): print("Configure parser: Error : can not read configuration file %s" % absfname)
445 # -----------------------------------------------------------------------------
447 booleans = {'1': True , 'yes': True , 'y': True , 'on' : True , 'true' : True , 'ok' : True,
448 '0': False, 'no' : False, 'n': False, 'off': False, 'false': False, 'cancel' : False}
450 boolean_choices = list(booleans.keys())
453 class CheckEmbeddedAction(argparse.Action):
454 def __call__(self, parser, namespace, value, option_string=None):
455 assert value is not None
456 if namespace.embedded:
457 embedded = [a for a in re.split("[:;,]", namespace.embedded) if a.strip()]
460 if namespace.standalone:
461 standalone = [a for a in re.split("[:;,]", namespace.standalone) if a.strip()]
464 vals = [a for a in re.split("[:;,]", value) if a.strip()]
466 if v not in embedded_choices:
467 raise argparse.ArgumentError("option %s: invalid choice: %r (choose from %s)"
468 % (self.dest, v, ", ".join(map(repr, embedded_choices))))
469 if v not in embedded:
472 del standalone[standalone.index(v)]
474 namespace.embedded = ",".join(embedded)
475 namespace.standalone = ",".join(standalone)
479 class CheckStandaloneAction(argparse.Action):
480 def __call__(self, parser, namespace, value, option_string=None):
481 assert value is not None
482 if namespace.embedded:
483 embedded = [a for a in re.split("[:;,]", namespace.embedded) if a.strip()]
486 if namespace.standalone:
487 standalone = [a for a in re.split("[:;,]", namespace.standalone) if a.strip()]
490 vals = [a for a in re.split("[:;,]", value) if a.strip()]
492 if v not in standalone_choices:
493 raise argparse.ArgumentError("option %s: invalid choice: %r (choose from %s)"
494 % (self.dest, v, ", ".join(map(repr, standalone_choices))))
495 if v not in standalone:
498 del embedded[embedded.index(v)]
500 namespace.embedded = ",".join(embedded)
501 namespace.standalone = ",".join(standalone)
504 class StoreBooleanAction(argparse.Action):
505 def __call__(self, parser, namespace, value, option_string=None):
506 if isinstance(value, bytes):
507 value = value.decode()
508 if isinstance(value, str):
510 value_conv = booleans[value.strip().lower()]
511 setattr(namespace, self.dest, value_conv)
513 raise argparse.ArgumentError(
514 "option %s: invalid boolean value: %s (choose from %s)"
515 % (self.dest, value, boolean_choices))
517 setattr(namespace, self.dest, value)
520 def CreateOptionParser(exeName=None):
525 a_usage = """%s [options] [STUDY_FILE] [PYTHON_FILE [args] [PYTHON_FILE [args]...]]
526 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,...
528 version_str = "Salome %s" % version()
529 pars = argparse.ArgumentParser(usage=a_usage)
532 pars.add_argument('-v', '--version', action='version', version=version_str)
534 # GUI/Terminal. Default: GUI
535 help_str = "Launch without GUI (in the terminal mode)."
536 pars.add_argument("-t",
538 action="store_false",
542 help_str = "Launch in Batch Mode. (Without GUI on batch machine)"
543 pars.add_argument("-b",
549 help_str = "Launch in GUI mode [default]."
550 pars.add_argument("-g",
556 # Show Desktop (only in GUI mode). Default: True
557 help_str = "1 to activate GUI desktop [default], "
558 help_str += "0 to not activate GUI desktop (Session_Server starts, but GUI is not shown). "
559 help_str += "Ignored in the terminal mode."
560 pars.add_argument("-d",
563 action=StoreBooleanAction,
566 help_str = "Do not activate GUI desktop (Session_Server starts, but GUI is not shown). "
567 help_str += "The same as --show-desktop=0."
568 pars.add_argument("-o",
570 action="store_false",
574 # Use logger or log-file. Default: nothing.
575 help_str = "Redirect messages to the CORBA collector."
576 pars.add_argument("-l",
578 action="store_const", const="CORBA",
581 help_str = "Redirect messages to the <log-file>"
582 pars.add_argument("-f",
584 metavar="<log-file>",
588 # Configuration XML file. Default: see defaultUserFile() function
589 help_str = "Parse application settings from the <file> "
590 help_str += "instead of default %s" % defaultUserFile()
591 pars.add_argument("-r",
597 # Use own xterm for each server. Default: False.
598 help_str = "Launch each SALOME server in own xterm console"
599 pars.add_argument("-x",
605 # Modules. Default: Like in configuration files.
606 help_str = "SALOME modules list (where <module1>, <module2> are the names "
607 help_str += "of SALOME modules which should be available in the SALOME session)"
608 pars.add_argument("-m",
610 metavar="<module1,module2,...>",
615 # Embedded servers. Default: Like in configuration files.
616 help_str = "CORBA servers to be launched in the Session embedded mode. "
617 help_str += "Valid values for <serverN>: %s " % ", ".join( embedded_choices )
618 help_str += "[by default the value from the configuration files is used]"
619 pars.add_argument("-e",
621 metavar="<server1,server2,...>",
622 action=CheckEmbeddedAction,
626 # Standalone servers. Default: Like in configuration files.
627 help_str = "CORBA servers to be launched in the standalone mode (as separate processes). "
628 help_str += "Valid values for <serverN>: %s " % ", ".join( standalone_choices )
629 help_str += "[by default the value from the configuration files is used]"
630 pars.add_argument("-s",
632 metavar="<server1,server2,...>",
633 action=CheckStandaloneAction,
637 # Kill with port. Default: False.
638 help_str = "Kill SALOME with the current port"
639 pars.add_argument("-p",
645 # Kill all. Default: False.
646 help_str = "Kill all running SALOME sessions"
647 pars.add_argument("-k",
653 # Additional python interpreters. Default: 0.
654 help_str = "The number of additional external python interpreters to run. "
655 help_str += "Each additional python interpreter is run in separate "
656 help_str += "xterm session with properly set SALOME environment"
657 pars.add_argument("-i",
664 # Splash. Default: True.
665 help_str = "1 to display splash screen [default], "
666 help_str += "0 to disable splash screen. "
667 help_str += "This option is ignored in the terminal mode. "
668 help_str += "It is also ignored if --show-desktop=0 option is used."
669 pars.add_argument("-z",
672 action=StoreBooleanAction,
676 # Catch exceptions. Default: True.
677 help_str = "1 (yes,true,on,ok) to enable centralized exception handling [default], "
678 help_str += "0 (no,false,off,cancel) to disable centralized exception handling."
679 pars.add_argument("-c",
680 "--catch-exceptions",
682 action=StoreBooleanAction,
683 dest="catch_exceptions",
686 # Print free port and exit
687 help_str = "Print free port and exit"
688 pars.add_argument("--print-port",
693 # launch only omniNames and Launcher server
694 help_str = "launch only omniNames and Launcher server"
695 pars.add_argument("--launcher_only",
697 dest="launcher_only",
700 # machine and port where is the Launcher
701 help_str = "machine and port where is the Launcher. Usage: "
702 help_str += "--launcher=machine:port"
703 pars.add_argument("--launcher",
704 metavar="<=machine:port>",
709 # Do not relink ${HOME}/.omniORB_last.cfg
710 help_str = "Do not save current configuration ${HOME}/.omniORB_last.cfg"
711 pars.add_argument("--nosave-config",
712 action="store_false",
716 # Launch with interactive python console. Default: False.
717 help_str = "Launch with interactive python console."
718 pars.add_argument("--pinter",
723 # Print Naming service port into a user file. Default: False.
724 help_str = "Print Naming Service Port into a user file."
725 pars.add_argument("--ns-port-log",
726 metavar="<ns_port_log_file>",
727 dest="ns_port_log_file",
730 # Write/read test script file with help of TestRecorder. Default: False.
731 help_str = "Write/read test script file with help of TestRecorder."
732 pars.add_argument("--test",
733 metavar="<test_script_file>",
734 dest="test_script_file",
737 # Reproducing test script with help of TestRecorder. Default: False.
738 help_str = "Reproducing test script with help of TestRecorder."
739 pars.add_argument("--play",
740 metavar="<play_script_file>",
741 dest="play_script_file",
745 help_str = "Launch session with gdb"
746 pars.add_argument("--gdb-session",
752 help_str = "Launch session with ddd"
753 pars.add_argument("--ddd-session",
760 help_str = "Launch session with valgrind $VALGRIND_OPTIONS"
761 pars.add_argument("--valgrind-session",
763 dest="valgrind_session",
766 # shutdown-servers. Default: False.
767 help_str = "1 to shutdown standalone servers when leaving python interpreter, "
768 help_str += "0 to keep the standalone servers as daemon [default]. "
769 help_str += "This option is only useful in batchmode "
770 help_str += "(terminal mode or without showing desktop)."
771 pars.add_argument("-w",
772 "--shutdown-servers",
774 action=StoreBooleanAction,
775 dest="shutdown_servers",
778 # foreground. Default: True.
779 help_str = "0 and runSalome exits after have launched the gui, "
780 help_str += "1 to launch runSalome in foreground mode [default]."
781 pars.add_argument("--foreground",
783 action=StoreBooleanAction,
788 help_str = "Wake up a previously closed session. "
789 help_str += "The session object is found in the naming service pointed by the variable OMNIORB_CONFIG. "
790 help_str += "If this variable is not set, the last configuration is taken. "
791 pars.add_argument("--wake-up-session",
793 dest="wake_up_session", default=False,
797 help_str = "Mode used to launch server processes (daemon or fork)."
798 pars.add_argument("--server-launch-mode",
799 metavar="<server_launch_mode>",
800 choices=["daemon", "fork"],
801 dest="server_launch_mode",
805 help_str = "Preferable port SALOME to be started on. "
806 help_str += "If specified port is not busy, SALOME session will start on it; "
807 help_str += "otherwise, any available port will be searched and used."
808 pars.add_argument("--port",
815 help_str = "Force application language. By default, a language specified in "
816 help_str += "the user's preferences is used."
817 pars.add_argument("-a",
823 help_str = "Level of verbosity"
824 pars.add_argument("-V",
832 help_str = "Use installed salome on-demand extensions."
833 help_str += "0 to run without salome extensions [default], "
834 help_str += "1 to run only installed salome extensions. "
835 pars.add_argument("--on-demand",
838 action=StoreBooleanAction,
843 # Positional arguments (hdf file, python file)
844 pars.add_argument("arguments", nargs=argparse.REMAINDER)
848 # -----------------------------------------------------------------------------
851 # Get the environment
854 # this attribute is obsolete
858 def get_env(appname=salomeappname, cfgname=salomecfgname, exeName=None, keepEnvironment=True):
860 # Collect launch configuration files:
861 # - The environment variable "<appname>Config" (SalomeAppConfig) which can
862 # define a list of directories (separated by ':' or ';' symbol) is checked
863 # - If the environment variable "<appname>Config" is not set, only
864 # ${GUI_ROOT_DIR}/share/salome/resources/gui is inspected
865 # - ${GUI_ROOT_DIR}/share/salome/resources/gui directory is always inspected
866 # so it is not necessary to put it in the "<appname>Config" variable
867 # - The directories which are inspected are checked for files "<appname?salomeappname>.xml"
868 # (SalomeApp.xml) which define SALOME configuration
869 # - These directories are analyzed beginning from the last one in the list,
870 # so the first directory listed in "<appname>Config" environment variable
871 # has higher priority: it means that if some configuration options
872 # is found in the next analyzed configuration file - it will be replaced
873 # - The last configuration file which is parsed is user configuration file
874 # situated in the home directory (if it exists):
875 # * ~/.config/salome/.<appname>rc[.<version>]" for Linux (e.g. ~/.config/salome/.SalomeApprc.6.4.0)
876 # * ~/<appname>.xml[.<version>] for Windows (e.g. ~/SalomeApp.xml.6.4.0)
877 # - Command line options have the highest priority and replace options
878 # specified in configuration file(s)
881 config_var = appname+'Config'
883 ############################
884 # parse command line options
885 pars = CreateOptionParser(exeName=exeName)
886 cmd_opts = pars.parse_args(sys.argv[1:])
887 ############################
889 # check KERNEL_ROOT_DIR
890 kernel_root_dir = os.environ.get("KERNEL_ROOT_DIR", None)
891 if kernel_root_dir is None and not cmd_opts.on_demand:
893 For each SALOME module, the environment variable <moduleN>_ROOT_DIR must be set.
894 KERNEL_ROOT_DIR is mandatory.
898 # Process --print-port option
899 if cmd_opts.print_port:
900 from searchFreePort import searchFreePort
902 print("port:%s"%(os.environ['NSPORT']))
906 PortManager.releasePort(os.environ['NSPORT'])
913 # set resources variable SalomeAppConfig if it is not set yet
915 if os.getenv(config_var):
916 if sys.platform == 'win32':
917 dirs += re.split(os.pathsep, os.getenv(config_var))
919 dirs += re.split('[;|:]', os.getenv(config_var))
921 if not keepEnvironment and not cmd_opts.on_demand:
922 if os.getenv("GUI_ROOT_DIR") and os.path.isdir(os.getenv("GUI_ROOT_DIR")):
923 gui_resources_dir = os.path.join(os.getenv("GUI_ROOT_DIR"),'share','salome','resources','gui')
924 if os.path.isdir(gui_resources_dir):
925 dirs.append(gui_resources_dir)
928 kernel_resources_dir = os.path.join(os.getenv("KERNEL_ROOT_DIR"),'bin','salome','appliskel')
929 if os.getenv("KERNEL_ROOT_DIR") and os.path.isdir( kernel_resources_dir ):
930 dirs.append(kernel_resources_dir)
932 os.environ[config_var] = os.pathsep.join(dirs)
934 dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
937 dirs.remove('') # to remove empty dirs if the variable terminate by ":" or if there are "::" inside
941 _opts = {} # associative array of options to be filled
943 # parse SalomeApp.xml files in directories specified by SalomeAppConfig env variable
944 for directory in dirs:
945 filename = os.path.join(directory, appname + '.xml')
946 if not os.path.exists(filename):
947 if verbose(): print("Configure parser: Warning : can not find configuration file %s" % filename)
950 p = xml_parser(filename, _opts, [])
953 if verbose(): print("Configure parser: Error : can not read configuration file %s" % filename)
956 # parse user configuration file
957 # It can be set via --resources=<file> command line option
958 # or is given from default location (see defaultUserFile() function)
959 # If user file for the current version is not found the nearest to it is used
960 user_config = cmd_opts.resources
962 user_config = userFile(appname, cfgname)
963 if verbose(): print("Configure parser: user configuration file is", user_config)
964 if not user_config or not os.path.exists(user_config):
965 if verbose(): print("Configure parser: Warning : can not find user configuration file")
968 p = xml_parser(user_config, _opts, [])
971 if verbose(): print('Configure parser: Error : can not read user configuration file')
976 args['user_config'] = user_config
977 # print("User Configuration file: ", args['user_config'])
979 # set default values for options which are NOT set in config files
980 for aKey in listKeys:
984 for aKey in boolKeys:
989 afile = args[file_nam]
990 args[file_nam] = [afile]
992 args[appname_nam] = appname
994 # get the port number
995 my_port = getPortNumber()
997 args[port_nam] = my_port
999 ####################################################
1000 # apply command-line options to the arguments
1001 # each option given in command line overrides the option from xml config file
1003 # Options: gui, desktop, log_file, resources,
1004 # xterm, modules, embedded, standalone,
1005 # portkill, killall, interp, splash,
1006 # catch_exceptions, pinter
1008 # GUI/Terminal, Desktop, Splash, STUDY_HDF
1009 args["session_gui"] = False
1010 args[batch_nam] = False
1011 args["study_hdf"] = None
1012 if cmd_opts.gui is not None:
1013 args[gui_nam] = cmd_opts.gui
1014 if cmd_opts.batch is not None:
1015 args[batch_nam] = True
1017 if ( not os.getenv("GUI_ROOT_DIR") or not os.path.isdir(os.getenv("GUI_ROOT_DIR")) ) and not cmd_opts.on_demand:
1018 args[gui_nam] = False
1021 args["session_gui"] = True
1022 if cmd_opts.desktop is not None:
1023 args["session_gui"] = cmd_opts.desktop
1024 args[splash_nam] = cmd_opts.desktop
1025 if args["session_gui"]:
1026 if cmd_opts.splash is not None:
1027 args[splash_nam] = cmd_opts.splash
1029 args["session_gui"] = False
1030 args[splash_nam] = False
1033 if cmd_opts.log_file is not None:
1034 if cmd_opts.log_file == 'CORBA':
1035 args[logger_nam] = True
1037 args[file_nam] = [cmd_opts.log_file]
1039 # Naming Service port log file
1040 if cmd_opts.ns_port_log_file is not None:
1041 args["ns_port_log_file"] = cmd_opts.ns_port_log_file
1044 for arg in cmd_opts.arguments:
1045 file_extension = os.path.splitext(arg)[-1]
1046 if file_extension == ".hdf" and not args["study_hdf"]:
1047 args["study_hdf"] = arg
1050 from salomeContextUtils import getScriptsAndArgs, ScriptAndArgs
1051 args[script_nam] = getScriptsAndArgs(cmd_opts.arguments)
1052 if args[gui_nam] and args["session_gui"]:
1054 for sa_obj in args[script_nam]: # args[script_nam] is a list of ScriptAndArgs objects
1055 script = re.sub(r'^python. *\s+', r'', sa_obj.script)
1056 new_args.append(ScriptAndArgs(script=script, args=sa_obj.args, out=sa_obj.out))
1058 args[script_nam] = new_args
1060 args[verbosity_nam] = cmd_opts.verbosity
1061 args[on_demand_nam] = cmd_opts.on_demand
1064 if cmd_opts.xterm is not None:
1065 args[xterm_nam] = cmd_opts.xterm
1068 if cmd_opts.modules is not None:
1069 args[modules_nam] = []
1070 listlist = cmd_opts.modules
1071 for listi in listlist:
1072 args[modules_nam] += re.split( "[:;,]", listi)
1074 # if --modules (-m) command line option is not given
1075 # try SALOME_MODULES environment variable
1076 if os.getenv( "SALOME_MODULES" ):
1077 args[modules_nam] = re.split( "[:;,]", os.getenv( "SALOME_MODULES" ) )
1081 if cmd_opts.embedded is not None:
1082 args[embedded_nam] = [a for a in re.split( "[:;,]", cmd_opts.embedded ) if a.strip()]
1085 if cmd_opts.standalone is not None:
1086 args[standalone_nam] = [a for a in re.split( "[:;,]", cmd_opts.standalone ) if a.strip()]
1088 # Normalize the '--standalone' and '--embedded' parameters
1089 standalone, embedded = process_containers_params( args.get( standalone_nam ),
1090 args.get( embedded_nam ) )
1091 if standalone is not None:
1092 args[ standalone_nam ] = standalone
1093 if embedded is not None:
1094 args[ embedded_nam ] = embedded
1097 if cmd_opts.portkill is not None: args[portkill_nam] = cmd_opts.portkill
1098 if cmd_opts.killall is not None: args[killall_nam] = cmd_opts.killall
1101 if cmd_opts.interp is not None:
1102 args[interp_nam] = cmd_opts.interp
1105 if cmd_opts.catch_exceptions is not None:
1106 args[except_nam] = not cmd_opts.catch_exceptions
1108 # Relink config file
1109 if cmd_opts.save_config is not None:
1110 args['save_config'] = cmd_opts.save_config
1112 # Interactive python console
1113 if cmd_opts.pinter is not None:
1114 args[pinter_nam] = cmd_opts.pinter
1116 # Gdb session in xterm
1117 if cmd_opts.gdb_session is not None:
1118 args[gdb_session_nam] = cmd_opts.gdb_session
1120 # Ddd session in xterm
1121 if cmd_opts.ddd_session is not None:
1122 args[ddd_session_nam] = cmd_opts.ddd_session
1125 if cmd_opts.valgrind_session is not None:
1126 args[valgrind_session_nam] = cmd_opts.valgrind_session
1129 if cmd_opts.shutdown_servers is None:
1130 args[shutdown_servers_nam] = 0
1132 args[shutdown_servers_nam] = cmd_opts.shutdown_servers
1136 if cmd_opts.launcher_only is not None:
1137 args[launcher_only_nam] = cmd_opts.launcher_only
1139 # machine and port where is the Launcher
1140 if cmd_opts.launcher is not None:
1141 args[launcher_nam] = cmd_opts.launcher
1144 if cmd_opts.foreground is None:
1145 args[foreground_nam] = 1
1147 args[foreground_nam] = cmd_opts.foreground
1151 if cmd_opts.wake_up_session is not None:
1152 args[wake_up_session_nam] = cmd_opts.wake_up_session
1154 # disable signals handling
1155 if args[except_nam] == 1:
1156 os.environ["NOT_INTERCEPT_SIGNALS"] = "1"
1159 # now modify SalomeAppConfig environment variable
1160 # to take into account the SALOME modules
1161 if not args[on_demand_nam]:
1162 if os.sys.platform == 'win32':
1163 dirs = re.split('[;]', os.environ[config_var] )
1165 dirs = re.split('[;|:]', os.environ[config_var] )
1166 for module in args[modules_nam]:
1167 if module not in ["KERNEL", "GUI", ""] and os.getenv("{0}_ROOT_DIR".format(module)):
1168 d1 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources",module.lower())
1169 d2 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources")
1170 #if os.path.exists( "%s/%s.xml"%(d1, appname) ):
1171 if os.path.exists( os.path.join(d1,"{0}.xml".format(salomeappname)) ):
1173 #elif os.path.exists( "%s/%s.xml"%(d2, appname) ):
1174 elif os.path.exists( os.path.join(d2,"{0}.xml".format(salomeappname)) ):
1177 # print("* '"+m+"' should be deleted from ",args[modules_nam])
1181 if cmd_opts.test_script_file is not None:
1183 filename = cmd_opts.test_script_file
1184 args[test_nam] += re.split( "[:;,]", filename )
1187 if cmd_opts.play_script_file is not None:
1189 filename = cmd_opts.play_script_file
1190 args[play_nam] += re.split( "[:;,]", filename )
1192 # Server launch command
1193 if cmd_opts.server_launch_mode is not None:
1194 args["server_launch_mode"] = cmd_opts.server_launch_mode
1196 # Server launch command
1197 if cmd_opts.use_port is not None:
1199 max_port = min_port + 100
1200 if cmd_opts.use_port not in range(min_port, max_port+1):
1201 print("Error: port number should be in range [%d, %d])" % (min_port, max_port))
1203 args[useport_nam] = cmd_opts.use_port
1205 if cmd_opts.language is not None:
1206 langs = args["language_languages"] if "language_languages" in args else []
1207 if cmd_opts.language not in langs:
1208 print("Error: unsupported language: %s" % cmd_opts.language)
1210 args[lang_nam] = cmd_opts.language
1213 if not keepEnvironment:
1214 os.environ[config_var] = os.pathsep.join(dirs)
1216 # print("Args: ", args)