launchConfigureParser Namespace Reference

Data Structures
class	xml_parser
class	CheckEmbeddedAction
class	CheckStandaloneAction
class	StoreBooleanAction

Functions
def	version ()
	Get the application version Uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION file. More...
def	version_id (fname)
	Calculate and return configuration file unique ID For example: for SALOME version 3.1.0a1 the id is 300999701. More...
def	defaultUserFile (appname=salomeappname, cfgname=salomecfgname)
	Get default user configuration file name For SALOME, it is: More...
def	userFile (appname, cfgname)
	Get user configuration file name. More...
def	process_containers_params (standalone, embedded)
def	CreateOptionParser (exeName=None)
def	get_env (appname=salomeappname, cfgname=salomecfgname, exeName=None, keepEnvironment=True)

Variables
string	doc_tag = "document"
string	sec_tag = "section"
string	par_tag = "parameter"
string	import_tag = "import"
string	nam_att = "name"
string	val_att = "value"
string	lanch_nam = "launch"
string	help_nam = "help"
string	gui_nam = "gui"
string	splash_nam = "splash"
string	logger_nam = "logger"
string	xterm_nam = "xterm"
string	file_nam = "file"
string	portkill_nam = "portkill"
string	killall_nam = "killall"
string	modules_nam = "modules"
string	embedded_nam = "embedded"
string	standalone_nam = "standalone"
string	key_nam = "key"
string	terminal_nam = "terminal"
string	interp_nam = "interp"
string	except_nam = "noexcepthandler"
string	pinter_nam = "pinter"
string	batch_nam = "batch"
string	test_nam = "test"
string	play_nam = "play"
string	lang_nam = "language"
string	gdb_session_nam = "gdb_session"
string	ddd_session_nam = "ddd_session"
string	valgrind_session_nam = "valgrind_session"
string	shutdown_servers_nam = "shutdown_servers"
string	foreground_nam = "foreground"
string	wake_up_session_nam = "wake_up_session"
string	launcher_only_nam = "launcher_only"
string	launcher_nam = "launcher"
string	plugins_nam = "plugins"
string	appname_nam = "appname"
string	port_nam = "port"
string	useport_nam = "useport"
string	salomecfgname = "salome"
string	salomeappname = "SalomeApp"
string	script_nam = "pyscript"
string	verbosity_nam = "verbosity"
string	on_demand_nam = "on_demand"
list	embedded_choices = [ "registry", "study", "moduleCatalog", "cppContainer", "SalomeAppEngine" ]
list	standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer"]
tuple	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 )
tuple	intKeys = ( interp_nam, )
tuple	strKeys = ( launcher_nam )
tuple	listKeys = ( embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )
string	section_to_skip = ""
	XML reader for launch configuration file usage. More...
dictionary	booleans
	boolean_choices = list(booleans.keys())
dictionary	args = {}
	Get the environment. More...

Function Documentation

CreateOptionParser()

def launchConfigureParser.CreateOptionParser

(

exeName = None

)

References defaultUserFile(), and version().

Referenced by get_env().

defaultUserFile()

def launchConfigureParser.defaultUserFile	(		appname = salomeappname,
			cfgname = salomecfgname
	)

Get default user configuration file name For SALOME, it is:

• on Linux: ~/.config/salome/SalomeApprc[.<version>]
• on Windows: ~/SalomeApp.xml[.<version>] where <version> is an optional version number

References salome_utils.getHomeDir(), and version().

Referenced by CreateOptionParser(), and userFile().

get_env()

def launchConfigureParser.get_env	(		appname = salomeappname,
			cfgname = salomecfgname,
			exeName = None,
			keepEnvironment = True
	)

References CreateOptionParser(), SalomeOnDemandTK.extension_utilities.format, salome_utils.getPortNumber(), salomeContextUtils.getScriptsAndArgs(), process_containers_params(), PortManager.releasePort(), userFile(), and virtual_salome.verbose.

Referenced by setenv.get_config().

process_containers_params()

def launchConfigureParser.process_containers_params	(		standalone,
			embedded
	)

Referenced by get_env().

userFile()

def launchConfigureParser.userFile	(		appname,
			cfgname
	)

Get user configuration file name.

References defaultUserFile(), SalomeOnDemandTK.extension_utilities.format, salome_utils.getHomeDir(), version(), and version_id().

Referenced by get_env().

version()

def launchConfigureParser.version

(

)

Get the application version Uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION file.

Referenced by CreateOptionParser(), defaultUserFile(), and userFile().

version_id()

def launchConfigureParser.version_id

(

fname

)

Calculate and return configuration file unique ID For example: for SALOME version 3.1.0a1 the id is 300999701.

Referenced by userFile().

Variable Documentation

appname_nam

string launchConfigureParser.appname_nam = "appname"

args

dictionary launchConfigureParser.args = {}

Get the environment.

batch_nam

string launchConfigureParser.batch_nam = "batch"

boolean_choices

launchConfigureParser.boolean_choices = list(booleans.keys())

booleans

dictionary launchConfigureParser.booleans

Initial value:

=  {'1': True , 'yes': True , 'y': True , 'on' : True , 'true' : True , 'ok'     : True,
            '0': False, 'no' : False, 'n': False, 'off': False, 'false': False, 'cancel' : False}

boolKeys

tuple launchConfigureParser.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 )

ddd_session_nam

string launchConfigureParser.ddd_session_nam = "ddd_session"

doc_tag

string launchConfigureParser.doc_tag = "document"

embedded_choices

list launchConfigureParser.embedded_choices = [ "registry", "study", "moduleCatalog", "cppContainer", "SalomeAppEngine" ]

embedded_nam

string launchConfigureParser.embedded_nam = "embedded"

except_nam

string launchConfigureParser.except_nam = "noexcepthandler"

file_nam

string launchConfigureParser.file_nam = "file"

foreground_nam

string launchConfigureParser.foreground_nam = "foreground"

gdb_session_nam

string launchConfigureParser.gdb_session_nam = "gdb_session"

gui_nam

string launchConfigureParser.gui_nam = "gui"

help_nam

string launchConfigureParser.help_nam = "help"

import_tag

string launchConfigureParser.import_tag = "import"

interp_nam

string launchConfigureParser.interp_nam = "interp"

intKeys

tuple launchConfigureParser.intKeys = ( interp_nam, )

key_nam

string launchConfigureParser.key_nam = "key"

killall_nam

string launchConfigureParser.killall_nam = "killall"

lanch_nam

string launchConfigureParser.lanch_nam = "launch"

lang_nam

string launchConfigureParser.lang_nam = "language"

launcher_nam

string launchConfigureParser.launcher_nam = "launcher"

launcher_only_nam

string launchConfigureParser.launcher_only_nam = "launcher_only"

listKeys

tuple launchConfigureParser.listKeys = ( embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )

logger_nam

string launchConfigureParser.logger_nam = "logger"

modules_nam

string launchConfigureParser.modules_nam = "modules"

nam_att

string launchConfigureParser.nam_att = "name"

on_demand_nam

string launchConfigureParser.on_demand_nam = "on_demand"

par_tag

string launchConfigureParser.par_tag = "parameter"

pinter_nam

string launchConfigureParser.pinter_nam = "pinter"

play_nam

string launchConfigureParser.play_nam = "play"

plugins_nam

string launchConfigureParser.plugins_nam = "plugins"

port_nam

string launchConfigureParser.port_nam = "port"

portkill_nam

string launchConfigureParser.portkill_nam = "portkill"

salomeappname

string launchConfigureParser.salomeappname = "SalomeApp"

salomecfgname

string launchConfigureParser.salomecfgname = "salome"

script_nam

string launchConfigureParser.script_nam = "pyscript"

sec_tag

string launchConfigureParser.sec_tag = "section"

section_to_skip

string launchConfigureParser.section_to_skip = ""

XML reader for launch configuration file usage.

shutdown_servers_nam

string launchConfigureParser.shutdown_servers_nam = "shutdown_servers"

splash_nam

string launchConfigureParser.splash_nam = "splash"

standalone_choices

list launchConfigureParser.standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer"]

standalone_nam

string launchConfigureParser.standalone_nam = "standalone"

strKeys

tuple launchConfigureParser.strKeys = ( launcher_nam )

terminal_nam

string launchConfigureParser.terminal_nam = "terminal"

test_nam

string launchConfigureParser.test_nam = "test"

useport_nam

string launchConfigureParser.useport_nam = "useport"

val_att

string launchConfigureParser.val_att = "value"

valgrind_session_nam

string launchConfigureParser.valgrind_session_nam = "valgrind_session"

verbosity_nam

string launchConfigureParser.verbosity_nam = "verbosity"

wake_up_session_nam

string launchConfigureParser.wake_up_session_nam = "wake_up_session"

xterm_nam

string launchConfigureParser.xterm_nam = "xterm"