-import os, glob, string, sys
+# Copyright (C) 2005 OPEN CASCADE, CEA, EDF R&D, LEG
+# PRINCIPIA R&D, EADS CCR, Lip6, BV, CEDRAT
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License.
+#
+# This library is distributed in the hope that it will be useful
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+import os, glob, string, sys, re
import xml.sax
+# names of tags in XML configuration file
+doc_tag = "document"
+sec_tag = "section"
+par_tag = "parameter"
+
+# names of attributes in XML configuration file
+nam_att = "name"
+val_att = "value"
+
+# certain values in XML configuration file ("launch" section)
+lanch_nam = "launch"
+gui_nam = "gui"
+splash_nam = "splash"
+logger_nam = "logger"
+xterm_nam = "xterm"
+file_nam = "file"
+portkill_nam = "portkill"
+killall_nam = "killall"
+modules_nam = "modules"
+embedded_nam = "embedded"
+standalone_nam = "standalone"
+containers_nam = "containers"
+key_nam = "key"
+interp_nam = "interp"
+except_nam = "noexcepthandler"
+
+# values in XML configuration file giving specific module parameters (<module_name> section)
+# which are stored in opts with key <module_name>_<parameter> (eg SMESH_plugins)
+plugins_nam = "plugins"
+
+# values passed as arguments, NOT read from XML config file, but set from within this script
+appname_nam = "appname"
+port_nam = "port"
+appname = "SalomeApp"
+script_nam = "pyscript"
+
+# values of boolean type (must be '0' or '1').
+# xml_parser.boolValue() is used for correct setting
+boolKeys = ( gui_nam, splash_nam, logger_nam, file_nam, xterm_nam, portkill_nam, killall_nam, interp_nam, except_nam )
+
+# values of list type
+listKeys = ( containers_nam, embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )
+
+# return application version (uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION)
+def version():
+ root_dir = os.environ.get( 'KERNEL_ROOT_DIR', '' ) # KERNEL_ROOT_DIR or "" if not found
+ root_dir = os.environ.get( 'GUI_ROOT_DIR', root_dir ) # GUI_ROOT_DIR or KERNEL_ROOT_DIR or "" if both not found
+ filename = root_dir+'/bin/salome/VERSION'
+ str = open( filename, "r" ).readline() # str = "THIS IS SALOME - SALOMEGUI VERSION: 3.0.0"
+ match = re.search( r':\s+([a-zA-Z0-9.]+)\s*$', str )
+ if match :
+ return match.group( 1 )
+ return ''
+
+# calculate and return configuration file id in order to unically identify it
+# for example: for 3.1.0a1 the id is 301000101
+def version_id( fname ):
+ vers = fname.split(".")
+ major = int(vers[0])
+ minor = int(vers[1])
+ mr = re.search(r'^([0-9]+)([A-Za-z]?)([0-9]*)',vers[2])
+ release = dev = 0
+ if mr:
+ release = int(mr.group(1))
+ dev1 = dev2 = 0
+ if len(mr.group(2)): dev1 = ord(mr.group(2))
+ if len(mr.group(3)): dev2 = int(mr.group(3))
+ dev = dev1 * 100 + dev2
+ else:
+ return None
+ ver = major
+ ver = ver * 100 + minor
+ ver = ver * 100 + release
+ ver = ver * 10000
+ if dev > 0: ver = ver - 10000 + dev
+ return ver
+
+# get user configuration file name
+def userFile():
+ v = version()
+ if not v:
+ return "" # not unknown version
+ filename = "%s/.%src.%s" % (os.environ['HOME'], appname, v)
+ if os.path.exists(filename):
+ return filename # user preferences file for the current version exists
+ # initial id
+ id0 = version_id( v )
+ # get all existing user preferences files
+ files = glob.glob( os.environ['HOME'] + "/." + appname + "rc.*" )
+ f2v = {}
+ for file in files:
+ match = re.search( r'\.%src\.([a-zA-Z0-9.]+)$'%appname, file )
+ if match: f2v[file] = match.group(1)
+ last_file = ""
+ last_version = 0
+ for file in f2v:
+ ver = version_id( f2v[file] )
+ if ver and abs(last_version-id0) > abs(ver-id0):
+ last_version = ver
+ last_file = file
+ return last_file
+
# -----------------------------------------------------------------------------
### xml reader for launch configuration file usage
+section_to_skip = ""
+
class xml_parser:
- def __init__(self, fileName):
+ def __init__(self, fileName, _opts ):
+ print "Configure parser: processing %s ..." % fileName
self.space = []
- self.opts = {}
+ self.opts = _opts
+ self.section = section_to_skip
parser = xml.sax.make_parser()
parser.setContentHandler(self)
parser.parse(fileName)
pass
- def CorrectBoolean(self, str):
+ def boolValue( self, str ):
if str in ("yes", "y", "1"):
return 1
elif str in ("no", "n", "0"):
pass
def startElement(self, name, attrs):
- #print "startElement name=",name
- #print "startElement attrs=",attrs.getNames()
self.space.append(name)
self.current = None
- if self.space[:2] == ["Configuration-list","launchoptions"] and len(self.space) == 3:
- self.current = name
- elif self.space == ["Configuration-list","modules-list"]:
- self.opts["modules"] = []
- elif self.space == ["Configuration-list","modules-list","module"] and "name" in attrs.getNames():
- for field in attrs.getNames():
- if field == "name":
- self.currentModuleName = str(attrs.getValue("name"))
- self.opts["modules"].append(self.currentModuleName)
- else:
- self.opts[str(attrs.getValue("name"))+"_"+str(field)] = self.CorrectBoolean(attrs.getValue(field))
- pass
- pass
- elif self.space == ["Configuration-list","modules-list","module","plugin"] and "name" in attrs.getNames():
- key = str(self.currentModuleName)+"_plugins"
- if not self.opts.has_key(key):
- self.opts[key]=[]
- pass
- self.opts[key].append(attrs.getValue("name"))
- elif self.space == ["Configuration-list","embedded-list"]:
- self.opts["embedded"] = []
+ # if we are analyzing "section" element and its "name" attribute is
+ # either "launch" or module name -- set section_name
+ if self.space == [doc_tag, sec_tag] and nam_att in attrs.getNames():
+ section_name = attrs.getValue( nam_att )
+ if section_name == lanch_nam:
+ self.section = section_name # launch section
+ elif self.opts.has_key( modules_nam ) and \
+ section_name in self.opts[ modules_nam ]:
+ self.section = section_name # <module> section
+ else:
+ self.section = section_to_skip # any other section
pass
- elif self.space == ["Configuration-list","standalone-list"]:
- self.opts["standalone"] = []
- pass
- elif self.space == ["Configuration-list","containers-list"]:
- self.opts["containers"] = []
+
+ # if we are analyzing "parameter" elements - children of either
+ # "section launch" or "section "<module>"" element, then store them
+ # in self.opts assiciative array (key = [<module>_ + ] value of "name" attribute)
+ elif self.section != section_to_skip and \
+ self.space == [doc_tag, sec_tag, par_tag] and \
+ nam_att in attrs.getNames() and \
+ val_att in attrs.getNames():
+ nam = attrs.getValue( nam_att )
+ val = attrs.getValue( val_att )
+ if self.section == lanch_nam: # key for launch section
+ key = nam
+ else: # key for <module> section
+ key = self.section + "_" + nam
+ if nam in boolKeys:
+ self.opts[key] = self.boolValue( val ) # assign boolean value: 0 or 1
+ elif nam in listKeys:
+ self.opts[key] = val.split( ',' ) # assign list value: []
+ else:
+ self.opts[key] = val;
pass
pass
def endElement(self, name):
p = self.space.pop()
self.current = None
+ if self.section != section_to_skip and name == sec_tag:
+ self.section = section_to_skip
pass
def characters(self, content):
- #print "Characters content:",content
- if self.current:
- self.opts[self.current] = self.CorrectBoolean(content)
- elif self.space == ["Configuration-list","embedded-list", "embeddedserver"]:
- self.opts["embedded"].append(content)
- elif self.space == ["Configuration-list","standalone-list", "standaloneserver"]:
- self.opts["standalone"].append(content)
- elif self.space == ["Configuration-list","containers-list", "containertype"]:
- self.opts["containers"].append(content)
pass
def processingInstruction(self, target, data):
# -----------------------------------------------------------------------------
-### searching for launch configuration file : $HOME/applipath()/salome.launch
+### searching for launch configuration files
+# the rule:
+# - environment variable {'appname'+'Config'} (SalomeAppConfig) contains list of directories (';' as devider)
+# - these directories contain 'appname'+'.xml' (SalomeApp.xml) configuration files
+# - these files are analyzed beginning with the last one (last directory in the list)
+# - if a key is found in next analyzed cofiguration file - it will be replaced
+# - the last configuration file to be analyzed - ~/.'appname'+'rc' (~/SalomeApprc) (if it exists)
+# - but anyway, if user specifies a certain option in a command line - it will replace the values
+# - specified in configuration file(s)
+# - once again the order of settings (next setting replaces the previous ones):
+# - SalomeApp.xml files in directories specified by SalomeAppConfig env variable
+# - .SalomeApprc file in user's catalogue
+# - command line
+
+config_var = appname+'Config'
+# set resources variables if not yet set
+dirs = []
+if os.getenv(config_var):
+ dirs += re.split('[;|:]', os.getenv(config_var))
+if os.getenv("GUI_ROOT_DIR"):
+ dirs += [os.getenv("GUI_ROOT_DIR") + "/share/salome/resources/gui"]
+os.environ[config_var] = ":".join(dirs)
+
+dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
+
+_opts = {} # assiciative array of options to be filled
+
+# SalomeApp.xml files in directories specified by SalomeAppConfig env variable
+for dir in dirs:
+ filename = dir+'/'+appname+'.xml'
+ if not os.path.exists(filename):
+ print "Configure parser: Warning : could not find configuration file %s" % filename
+ else:
+ try:
+ p = xml_parser(filename, _opts)
+ _opts = p.opts
+ except:
+ print "Configure parser: Error : can not read configuration file %s" % filename
+ pass
-appname="salome"
-import Utils_Identity
-versnb=Utils_Identity.version()
-dirname = os.path.join(os.environ["HOME"],Utils_Identity.getapplipath())
-filename=os.path.join(dirname,"salome.launch")
+# SalomeApprc file in user's catalogue
+filename = userFile()
+if not filename or not os.path.exists(filename):
+ print "Configure parser: Warning : could not find user configuration file"
+else:
+ try:
+ p = xml_parser(filename, _opts)
+ _opts = p.opts
+ except:
+ print 'Configure parser: Error : can not read user configuration file'
-if not os.path.exists(filename):
- print "Launch configuration file does not exist. Create default:",filename
- os.system("mkdir -p "+dirname)
- os.system("cp -f "+os.environ["KERNEL_ROOT_DIR"]+"/bin/salome/salome.launch "+filename)
+args = _opts
-### get options from launch configuration file
+# --- setting default values of keys if they were NOT set in config files ---
+for aKey in listKeys:
+ if not args.has_key( aKey ):
+ args[aKey]=[]
-try:
- p = xml_parser(filename)
-except:
- print 'Can not read launch configuration file ', filename
- filename = None
- pass
+for aKey in boolKeys:
+ if not args.has_key( aKey ):
+ args[aKey]=0
-if filename:
- args = p.opts
-else:
- args = {}
- pass
+if args[file_nam]:
+ afile=args[file_nam]
+ args[file_nam]=[afile]
-# --- args completion
-for aKey in ("containers","embedded","key","modules","standalone"):
- if not args.has_key(aKey):
- args[aKey]=[]
-for aKey in ("gui","logger","file","xterm","portkill","killall"):
- if not args.has_key(aKey):
- args[aKey]=0
-if args["file"]:
- afile=args["file"]
- args["file"]=[afile]
-args["appname"] = appname
+args[appname_nam] = appname
### searching for my port
s = file.read()
while len(s):
l = string.split(s, ":")
- if string.split(l[0], " ")[0] == "ORBInitRef":
+ if string.split(l[0], " ")[0] == "ORBInitRef" or string.split(l[0], " ")[0] == "InitRef" :
my_port = int(l[len(l)-1])
pass
s = file.read()
except:
pass
-args["port"] = my_port
+args[port_nam] = my_port
# -----------------------------------------------------------------------------
list = []
pass
- print "source=",source
-
result = {}
i = 0
while i < len(source):
else:
key = source[i][1]
pass
-
+
result[key] = []
if key:
i += 1
# -----------------------------------------------------------------------------
### read command-line options : each arg given in command line supersedes arg from xml config file
-
+cmd_opts = {}
try:
- opts = options_parser(sys.argv[1:])
- print "opts=",opts
+ cmd_opts = options_parser(sys.argv[1:])
kernel_root_dir=os.environ["KERNEL_ROOT_DIR"]
except:
- opts["h"] = 1
+ cmd_opts["h"] = 1
pass
### check all options are right
opterror=0
-for opt in opts:
- if not opt in ("h","g","l","f","x","m","e","s","c","p","k","t"):
- print "command line error: -", opt
+for opt in cmd_opts:
+ if not opt in ("h","g","l","f","x","m","e","s","c","p","k","t","i","r"):
+ print "Configure parser: Error : command line error : -%s" % opt
opterror=1
if opterror == 1:
- opts["h"] = 1
+ cmd_opts["h"] = 1
-if opts.has_key("h"):
+if cmd_opts.has_key("h"):
print """USAGE: runSalome.py [options]
[command line options] :
--help or -h : print this help
--gui or -g : launching with GUI
--terminal -t : launching without gui (to deny --gui)
+ or -t=PythonScript[,...]
+ : import of PythonScript(s)
--logger or -l : redirect messages in a CORBA collector
- --file=filename or -f=filename: redirect messages in a log file
+ --file=filename or -f=filename: redirect messages in a log file
--xterm or -x : execute servers in xterm console (messages appear in xterm windows)
--modules=module1,module2,... : salome module list (modulen is the name of Salome module to load)
or -m=module1,module2,...
--containers=cpp,python,superv: (obsolete) launching of containers cpp, python and supervision
or -c=cpp,python,superv : = get default from -e and -s
--portkill or -p : kill the salome with current port
- --killall or -k : kill salome
-
+ --killall or -k : kill all salome sessions
+ --interp=n or -i=n : number of additional xterm to open, with session environment
+ -z : display splash screen
+ -r : disable centralized exception handling mechanism
+
For each Salome module, the environment variable <modulen>_ROOT_DIR must be set.
The module name (<modulen>) must be uppercase.
KERNEL_ROOT_DIR is mandatory.
pass
### apply command-line options to the arguments
-for opt in opts:
+for opt in cmd_opts:
if opt == 'g':
- args['gui'] = 1
+ args[gui_nam] = 1
+ elif opt == 'z':
+ args[splash_nam] = 1
+ elif opt == 'r':
+ args[except_nam] = 1
elif opt == 'l':
- args['logger'] = 1
+ args[logger_nam] = 1
elif opt == 'f':
- args['file'] = opts['f']
+ args[file_nam] = cmd_opts['f']
elif opt == 'x':
- args['xterm'] = 1
+ args[xterm_nam] = 1
+ elif opt == 'i':
+ args[interp_nam] = cmd_opts['i']
elif opt == 'm':
- args['modules'] = opts['m']
+ args[modules_nam] = cmd_opts['m']
elif opt == 'e':
- args['embedded'] = opts['e']
+ args[embedded_nam] = cmd_opts['e']
elif opt == 's':
- args['standalone'] = opts['s']
+ args[standalone_nam] = cmd_opts['s']
elif opt == 'c':
- args['containers'] = opts['c']
+ args[containers_nam] = cmd_opts['c']
elif opt == 'p':
- args['portkill'] = 1
+ args[portkill_nam] = 1
elif opt == 'k':
- args['killall'] = 1
+ args[killall_nam] = 1
pass
pass
+# if --modules (-m) command line option is not given
+# try SALOME_MODULES environment variable
+if not cmd_opts.has_key( "m" ) and os.getenv( "SALOME_MODULES" ):
+ args[modules_nam] = re.split( "[:;,]", os.getenv( "SALOME_MODULES" ) )
+ pass
+
# 'terminal' must be processed in the end: to deny any 'gui' options
-if 't' in opts:
- args['gui'] = 0
+args[script_nam] = []
+if 't' in cmd_opts:
+ args[gui_nam] = 0
+ args[script_nam] = cmd_opts['t']
+ pass
+
+if args[except_nam] == 1:
+ os.environ["DISABLE_FPE"] = "1"
pass
-print "args=",args
+# now modify SalomeAppConfig environment variable
+dirs = re.split('[;|:]', os.environ[config_var] )
+
+for m in args[modules_nam]:
+ if m not in ["KERNEL", "GUI", ""] and os.getenv("%s_ROOT_DIR"%m):
+ d1 = os.getenv("%s_ROOT_DIR"%m) + "/share/salome/resources/" + m.lower()
+ d2 = os.getenv("%s_ROOT_DIR"%m) + "/share/salome/resources"
+ if os.path.exists( "%s/%s.xml"%(d1, appname) ):
+ dirs.append( d1 )
+ elif os.path.exists( "%s/%s.xml"%(d2, appname) ):
+ dirs.append( d2 )
+os.environ[config_var] = ":".join(dirs)
