+booleans = {'1': True , 'yes': True , 'y': True , 'on' : True , 'true' : True , 'ok' : True,
+ '0': False, 'no' : False, 'n': False, 'off': False, 'false': False, 'cancel' : False}
+
+boolean_choices = list(booleans.keys())
+
+
+class CheckEmbeddedAction(argparse.Action):
+ def __call__(self, parser, namespace, value, option_string=None):
+ assert value is not None
+ if namespace.embedded:
+ embedded = [a for a in re.split("[:;,]", namespace.embedded) if a.strip()]
+ else:
+ embedded = []
+ if namespace.standalone:
+ standalone = [a for a in re.split("[:;,]", namespace.standalone) if a.strip()]
+ else:
+ standalone = []
+ vals = [a for a in re.split("[:;,]", value) if a.strip()]
+ for v in vals:
+ if v not in embedded_choices:
+ raise argparse.ArgumentError("option %s: invalid choice: %r (choose from %s)"
+ % (self.dest, v, ", ".join(map(repr, embedded_choices))))
+ if v not in embedded:
+ embedded.append(v)
+ if v in standalone:
+ del standalone[standalone.index(v)]
+ pass
+ namespace.embedded = ",".join(embedded)
+ namespace.standalone = ",".join(standalone)
+ pass
+
+
+class CheckStandaloneAction(argparse.Action):
+ def __call__(self, parser, namespace, value, option_string=None):
+ assert value is not None
+ if namespace.embedded:
+ embedded = [a for a in re.split("[:;,]", namespace.embedded) if a.strip()]
+ else:
+ embedded = []
+ if namespace.standalone:
+ standalone = [a for a in re.split("[:;,]", namespace.standalone) if a.strip()]
+ else:
+ standalone = []
+ vals = [a for a in re.split("[:;,]", value) if a.strip()]
+ for v in vals:
+ if v not in standalone_choices:
+ raise argparse.ArgumentError("option %s: invalid choice: %r (choose from %s)"
+ % (self.dest, v, ", ".join(map(repr, standalone_choices))))
+ if v not in standalone:
+ standalone.append(v)
+ if v in embedded:
+ del embedded[embedded.index(v)]
+ pass
+ namespace.embedded = ",".join(embedded)
+ namespace.standalone = ",".join(standalone)
+
+
+class StoreBooleanAction(argparse.Action):
+ def __call__(self, parser, namespace, value, option_string=None):
+ if isinstance(value, bytes):
+ value = value.decode()
+ if isinstance(value, str):
+ try:
+ value_conv = booleans[value.strip().lower()]
+ setattr(namespace, self.dest, value_conv)
+ except KeyError:
+ raise argparse.ArgumentError(
+ "option %s: invalid boolean value: %s (choose from %s)"
+ % (self.dest, value, boolean_choices))
+ else:
+ setattr(namespace, self.dest, value)
+
+
+def CreateOptionParser(exeName=None):
+
+ if not exeName:
+ exeName = "%(prog)s"
+
+ a_usage = """%s [options] [STUDY_FILE] [PYTHON_FILE [args] [PYTHON_FILE [args]...]]
+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,...
+""" % exeName
+ version_str = "Salome %s" % version()
+ pars = argparse.ArgumentParser(usage=a_usage)
+
+ # Version
+ pars.add_argument('-v', '--version', action='version', version=version_str)
+
+ # GUI/Terminal. Default: GUI
+ help_str = "Launch without GUI (in the terminal mode)."
+ pars.add_argument("-t",
+ "--terminal",
+ action="store_false",
+ dest="gui",
+ help=help_str)
+
+ help_str = "Launch in Batch Mode. (Without GUI on batch machine)"
+ pars.add_argument("-b",
+ "--batch",
+ action="store_true",
+ dest="batch",
+ help=help_str)
+
+ help_str = "Launch in GUI mode [default]."
+ pars.add_argument("-g",
+ "--gui",
+ action="store_true",
+ dest="gui",
+ help=help_str)
+
+ # Show Desktop (only in GUI mode). Default: True
+ help_str = "1 to activate GUI desktop [default], "
+ help_str += "0 to not activate GUI desktop (Session_Server starts, but GUI is not shown). "
+ help_str += "Ignored in the terminal mode."
+ pars.add_argument("-d",
+ "--show-desktop",
+ metavar="<1/0>",
+ action=StoreBooleanAction,
+ dest="desktop",
+ help=help_str)
+ help_str = "Do not activate GUI desktop (Session_Server starts, but GUI is not shown). "
+ help_str += "The same as --show-desktop=0."
+ pars.add_argument("-o",
+ "--hide-desktop",
+ action="store_false",
+ dest="desktop",
+ help=help_str)
+
+ # Use logger or log-file. Default: nothing.
+ help_str = "Redirect messages to the CORBA collector."
+ pars.add_argument("-l",
+ "--logger",
+ action="store_const", const="CORBA",
+ dest="log_file",
+ help=help_str)
+ help_str = "Redirect messages to the <log-file>"
+ pars.add_argument("-f",
+ "--log-file",
+ metavar="<log-file>",
+ dest="log_file",
+ help=help_str)
+
+ # Configuration XML file. Default: see defaultUserFile() function
+ help_str = "Parse application settings from the <file> "
+ help_str += "instead of default %s" % defaultUserFile()
+ pars.add_argument("-r",
+ "--resources",
+ metavar="<file>",
+ dest="resources",
+ help=help_str)
+
+ # Use own xterm for each server. Default: False.
+ help_str = "Launch each SALOME server in own xterm console"
+ pars.add_argument("-x",
+ "--xterm",
+ action="store_true",
+ dest="xterm",
+ help=help_str)
+
+ # Modules. Default: Like in configuration files.
+ help_str = "SALOME modules list (where <module1>, <module2> are the names "
+ help_str += "of SALOME modules which should be available in the SALOME session)"
+ pars.add_argument("-m",
+ "--modules",
+ metavar="<module1,module2,...>",
+ action="append",
+ dest="modules",
+ help=help_str)
+
+ # Embedded servers. Default: Like in configuration files.
+ help_str = "CORBA servers to be launched in the Session embedded mode. "
+ help_str += "Valid values for <serverN>: %s " % ", ".join( embedded_choices )
+ help_str += "[by default the value from the configuration files is used]"
+ pars.add_argument("-e",
+ "--embedded",
+ metavar="<server1,server2,...>",
+ action=CheckEmbeddedAction,
+ dest="embedded",
+ help=help_str)
+
+ # Standalone servers. Default: Like in configuration files.
+ help_str = "CORBA servers to be launched in the standalone mode (as separate processes). "
+ help_str += "Valid values for <serverN>: %s " % ", ".join( standalone_choices )
+ help_str += "[by default the value from the configuration files is used]"
+ pars.add_argument("-s",
+ "--standalone",
+ metavar="<server1,server2,...>",
+ action=CheckStandaloneAction,
+ dest="standalone",
+ help=help_str)
+
+ # Kill with port. Default: False.
+ help_str = "Kill SALOME with the current port"
+ pars.add_argument("-p",
+ "--portkill",
+ action="store_true",
+ dest="portkill",
+ help=help_str)
+
+ # Kill all. Default: False.
+ help_str = "Kill all running SALOME sessions"
+ pars.add_argument("-k",
+ "--killall",
+ action="store_true",
+ dest="killall",
+ help=help_str)
+
+ # Additional python interpreters. Default: 0.
+ help_str = "The number of additional external python interpreters to run. "
+ help_str += "Each additional python interpreter is run in separate "
+ help_str += "xterm session with properly set SALOME environment"
+ pars.add_argument("-i",
+ "--interp",
+ metavar="<N>",
+ type=int,
+ dest="interp",
+ help=help_str)
+
+ # Splash. Default: True.
+ help_str = "1 to display splash screen [default], "
+ help_str += "0 to disable splash screen. "
+ help_str += "This option is ignored in the terminal mode. "
+ help_str += "It is also ignored if --show-desktop=0 option is used."
+ pars.add_argument("-z",
+ "--splash",
+ metavar="<1/0>",
+ action=StoreBooleanAction,
+ dest="splash",
+ help=help_str)
+
+ # Catch exceptions. Default: True.
+ help_str = "1 (yes,true,on,ok) to enable centralized exception handling [default], "
+ help_str += "0 (no,false,off,cancel) to disable centralized exception handling."
+ pars.add_argument("-c",
+ "--catch-exceptions",
+ metavar="<1/0>",
+ action=StoreBooleanAction,
+ dest="catch_exceptions",
+ help=help_str)
+
+ # Print free port and exit
+ help_str = "Print free port and exit"
+ pars.add_argument("--print-port",
+ action="store_true",
+ dest="print_port",
+ help=help_str)
+
+ # launch only omniNames and Launcher server
+ help_str = "launch only omniNames and Launcher server"
+ pars.add_argument("--launcher_only",
+ action="store_true",
+ dest="launcher_only",
+ help=help_str)
+
+ # machine and port where is the Launcher
+ help_str = "machine and port where is the Launcher. Usage: "
+ help_str += "--launcher=machine:port"
+ pars.add_argument("--launcher",
+ metavar="<=machine:port>",
+ type=str,
+ dest="launcher",
+ help=help_str)
+
+ # Do not relink ${HOME}/.omniORB_last.cfg
+ help_str = "Do not save current configuration ${HOME}/.omniORB_last.cfg"
+ pars.add_argument("--nosave-config",
+ action="store_false",
+ dest="save_config",
+ help=help_str)
+
+ # Launch with interactive python console. Default: False.
+ help_str = "Launch with interactive python console."
+ pars.add_argument("--pinter",
+ action="store_true",
+ dest="pinter",
+ help=help_str)
+
+ # Print Naming service port into a user file. Default: False.
+ help_str = "Print Naming Service Port into a user file."
+ pars.add_argument("--ns-port-log",
+ metavar="<ns_port_log_file>",
+ dest="ns_port_log_file",
+ help=help_str)
+
+ # Write/read test script file with help of TestRecorder. Default: False.
+ help_str = "Write/read test script file with help of TestRecorder."
+ pars.add_argument("--test",
+ metavar="<test_script_file>",
+ dest="test_script_file",
+ help=help_str)
+
+ # Reproducing test script with help of TestRecorder. Default: False.
+ help_str = "Reproducing test script with help of TestRecorder."
+ pars.add_argument("--play",
+ metavar="<play_script_file>",
+ dest="play_script_file",
+ help=help_str)
+
+ # gdb session
+ help_str = "Launch session with gdb"
+ pars.add_argument("--gdb-session",
+ action="store_true",
+ dest="gdb_session",
+ help=help_str)
+
+ # ddd session
+ help_str = "Launch session with ddd"
+ pars.add_argument("--ddd-session",
+ action="store_true",
+ dest="ddd_session",
+ help=help_str)
+
+
+ # valgrind session
+ help_str = "Launch session with valgrind $VALGRIND_OPTIONS"
+ pars.add_argument("--valgrind-session",
+ action="store_true",
+ dest="valgrind_session",
+ help=help_str)
+
+ # shutdown-servers. Default: False.
+ help_str = "1 to shutdown standalone servers when leaving python interpreter, "
+ help_str += "0 to keep the standalone servers as daemon [default]. "
+ help_str += "This option is only useful in batchmode "
+ help_str += "(terminal mode or without showing desktop)."
+ pars.add_argument("-w",
+ "--shutdown-servers",
+ metavar="<1/0>",
+ action=StoreBooleanAction,
+ dest="shutdown_servers",
+ help=help_str)
+
+ # foreground. Default: True.
+ help_str = "0 and runSalome exits after have launched the gui, "
+ help_str += "1 to launch runSalome in foreground mode [default]."
+ pars.add_argument("--foreground",
+ metavar="<1/0>",
+ action=StoreBooleanAction,
+ dest="foreground",
+ help=help_str)
+
+ # wake up session
+ help_str = "Wake up a previously closed session. "
+ help_str += "The session object is found in the naming service pointed by the variable OMNIORB_CONFIG. "
+ help_str += "If this variable is not set, the last configuration is taken. "
+ pars.add_argument("--wake-up-session",
+ action="store_true",
+ dest="wake_up_session", default=False,
+ help=help_str)
+
+ # server launch mode
+ help_str = "Mode used to launch server processes (daemon or fork)."
+ pars.add_argument("--server-launch-mode",
+ metavar="<server_launch_mode>",
+ choices=["daemon", "fork"],
+ dest="server_launch_mode",
+ help=help_str)
+
+ # use port
+ help_str = "Preferable port SALOME to be started on. "
+ help_str += "If specified port is not busy, SALOME session will start on it; "
+ help_str += "otherwise, any available port will be searched and used."
+ pars.add_argument("--port",
+ metavar="<port>",
+ type=int,
+ dest="use_port",
+ help=help_str)
+
+ # Language
+ help_str = "Force application language. By default, a language specified in "
+ help_str += "the user's preferences is used."
+ pars.add_argument("-a",
+ "--language",
+ dest="language",
+ help=help_str)
+
+ # Positional arguments (hdf file, python file)
+ pars.add_argument("arguments", nargs=argparse.REMAINDER)
+
+ return pars
+
+# -----------------------------------------------------------------------------
+
+###
+# Get the environment
+###
+
+# this attribute is obsolete
+args = {}
+#def get_env():
+#args = []
+def get_env(appname=salomeappname, cfgname=salomecfgname, exeName=None, keepEnvironment=True):
+ ###
+ # Collect launch configuration files:
+ # - The environment variable "<appname>Config" (SalomeAppConfig) which can
+ # define a list of directories (separated by ':' or ';' symbol) is checked
+ # - If the environment variable "<appname>Config" is not set, only
+ # ${GUI_ROOT_DIR}/share/salome/resources/gui is inspected
+ # - ${GUI_ROOT_DIR}/share/salome/resources/gui directory is always inspected
+ # so it is not necessary to put it in the "<appname>Config" variable
+ # - The directories which are inspected are checked for files "<appname?salomeappname>.xml"
+ # (SalomeApp.xml) which define SALOME configuration
+ # - These directories are analyzed beginning from the last one in the list,
+ # so the first directory listed in "<appname>Config" environment variable
+ # has higher priority: it means that if some configuration options
+ # is found in the next analyzed configuration file - it will be replaced
+ # - The last configuration file which is parsed is user configuration file
+ # situated in the home directory (if it exists):
+ # * ~/.config/salome/.<appname>rc[.<version>]" for Linux (e.g. ~/.config/salome/.SalomeApprc.6.4.0)
+ # * ~/<appname>.xml[.<version>] for Windows (e.g. ~/SalomeApp.xml.6.4.0)
+ # - Command line options have the highest priority and replace options
+ # specified in configuration file(s)
+ ###
+ global args
+ config_var = appname+'Config'
+
+ # check KERNEL_ROOT_DIR
+ kernel_root_dir = os.environ.get("KERNEL_ROOT_DIR", None)
+ if kernel_root_dir is None:
+ print("""
+ For each SALOME module, the environment variable <moduleN>_ROOT_DIR must be set.
+ KERNEL_ROOT_DIR is mandatory.
+ """)
+ sys.exit(1)
+
+ ############################
+ # parse command line options
+ pars = CreateOptionParser(exeName=exeName)
+ cmd_opts = pars.parse_args(sys.argv[1:])
+ ############################
+
+ # Process --print-port option
+ if cmd_opts.print_port:
+ from searchFreePort import searchFreePort
+ searchFreePort({})
+ print("port:%s"%(os.environ['NSPORT']))
+
+ try:
+ import PortManager
+ PortManager.releasePort(os.environ['NSPORT'])
+ except ImportError:
+ pass
+
+ sys.exit(0)
+ pass
+
+ # set resources variable SalomeAppConfig if it is not set yet
+ dirs = []
+ if os.getenv(config_var):
+ if sys.platform == 'win32':
+ dirs += re.split(os.pathsep, os.getenv(config_var))
+ else:
+ dirs += re.split('[;|:]', os.getenv(config_var))
+
+ if not keepEnvironment:
+ if os.getenv("GUI_ROOT_DIR") and os.path.isdir(os.getenv("GUI_ROOT_DIR")):
+ gui_resources_dir = os.path.join(os.getenv("GUI_ROOT_DIR"),'share','salome','resources','gui')
+ if os.path.isdir(gui_resources_dir):
+ dirs.append(gui_resources_dir)
+ pass
+ else:
+ kernel_resources_dir = os.path.join(os.getenv("KERNEL_ROOT_DIR"),'bin','salome','appliskel')
+ if os.getenv("KERNEL_ROOT_DIR") and os.path.isdir( kernel_resources_dir ):
+ dirs.append(kernel_resources_dir)
+ pass
+ os.environ[config_var] = os.pathsep.join(dirs)
+
+ dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
+