libervia-backend: src/bridge/bridge_constructor/bridge

comparison src/bridge/bridge_constructor/bridge_contructor.py @ 587:952322b1d490

Remove trailing whitespaces.

author	Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date	Fri, 18 Jan 2013 17:55:34 +0100
parents	ca13633d3b6b
children	beaf6bec2fcd

comparison

equal deleted inserted replaced

-:6a718ede8be1
+:952322b1d490
 from datetime import datetime
 from xml.dom import minidom
 class ParseError(Exception):
 #Used when the signature parsing is going wrong (invalid signature ?)
 pass
 class Constructor:
 def __init__(self, bridge_template, options):
 self.bridge_template = bridge_template
 self.options = options
 def getValues(self, name):
 value = self.bridge_template.get(name, option)
 except NoOptionError:
 value = None
 function[option] = value
 return function
 def getDefault(self, name):
 """Return default values of a function in a dict
 @param name: Name of the function to get
 @return: dict, each key is the integer param number (no key if no default value)"""
 default_dict={}
 def_re = re.compile(r"param_(\d+)_default")
 for option in self.bridge_template.options(name):
 match = def_re.match(option)
 if match:
 try:
 idx = int(match.group(1))
 except ValueError:
 raise ParseError("Invalid value [%s] for parameter number" % match.group(1))
 default_dict[idx] = self.bridge_template.get(name, option)
 return default_dict
 def getFlags(self, name):
 """Return list of flags set for this function
 @param name: Name of the function to get
 flags=[]
 for option in self.bridge_template.options(name):
 if option in FLAGS:
 flags.append(option)
 return flags
 def getArgumentsDoc(self, name):
 """Return documentation of arguments
 @param name: Name of the function to get
 @return: dict, each key is the integer param number (no key if no argument doc), value is a tuple (name, doc)"""
 doc_dict={}
 """Return arguments to user given a signature
 @param signature: signature in the short form (using s,a,i,b etc)
 @param name: dictionary of arguments name like given by getArguments
 @param default: dictionary of default values, like given by getDefault
 @param unicode_protect: activate unicode protection on strings (return strings as unicode(str))
 @return: list of arguments that correspond to a signature (e.g.: "sss" return "arg1, arg2, arg3")"""
 idx=0
 attr_string=[]
 for arg in self.argumentsParser(signature):
 attr_string.append(("unicode(%(name)s)%(default)s" if (unicode_protect and arg=='s') else "%(name)s%(default)s") % {
 'name':name[idx][0] if (name and name.has_key(idx)) else "arg_%i" % idx,
 'default':"="+default[idx] if (default and default.has_key(idx)) else ''
 }) #give arg_1, arg2, etc or name1, name2=default, etc. \
 #give unicode(arg_1), unicode(arg_2), etc. if unicode_protect is set and arg is a string
 idx+=1
 return ", ".join(attr_string)
 def generateCoreSide(self):
 """create the constructor in SàT core side (backend)"""
 raise NotImplementedError
 try:
 if not os.path.exists(DEST_DIR):
 os.mkdir(DEST_DIR)
 full_path=os.path.join(DEST_DIR,filename)
 if os.path.exists(full_path) and not self.options.force:
 print ("The destination file [%s] already exists ! Use --force to overwrite it" % full_path)
 try:
 with open(full_path,'w') as dest_file:
 dest_file.write('\n'.join(file_buf))
 except IOError:
 print ("Can't open destination file [%s]" % full_path)
 class MediawikiConstructor(Constructor):
 def __init__(self, bridge_template, options):
 Constructor.__init__(self, bridge_template, options)
 self.core_template="mediawiki_template.tpl"
 self.core_dest="mediawiki.wiki"
 def _addTextDecorations(self, text):
 """Add text decorations like coloration or shortcuts"""
 def anchor_link(match):
 else:
 wiki.append("; arg_%d: " % i)
 if arg_default.has_key(i):
 wiki.append(":''DEFAULT: %s''" % arg_default[i])
 return "\n".join(wiki)
 def _wikiReturn(self, name):
 """Format return doc with the wiki syntax
 @param name: name of the function
 """
 arg_doc = self.getArgumentsDoc(name)
 ''%(doc)s''
 %(deprecated)s
 %(async)s
 {| class="wikitable" style="text-align:left; width:80%%;"
 ! scope=row | category
 | %(category)s
 |-
 %(signature)s
 ! scope=row | parameters
 |
 %(parameters)s%(return)s
 |}
 """ % completion)
 #at this point, signals_part, and methods_part should be filled,
 #we just have to place them in the right part of the template
 core_bridge = []
 try:
 with open(self.core_template) as core_template:
 core_bridge.append('Generated on %s' % datetime.now())
 else:
 core_bridge.append(line.replace('\n',''))
 except IOError:
 print ("Can't open template file [%s]" % self.core_template)
 sys.exit(1)
 #now we write to final file
 self.finalWrite(self.core_dest, core_bridge)
 class DbusConstructor(Constructor):
 def __init__(self, bridge_template, options):
 Constructor.__init__(self, bridge_template, options)
 self.core_template="dbus_core_template.py"
 self.frontend_template="dbus_frontend_template.py"
 self.frontend_dest = self.core_dest="DBus.py"
 def generateCoreSide(self):
 signals_part = []
 methods_part = []
 direct_calls = []
 async = "async" in self.getFlags(section)
 completion = {
 'sig_in':function['sig_in'] or '',
 'sig_out':function['sig_out'] or '',
 'category':'PLUGIN' if function['category'] == 'plugin' else 'CORE',
 'name':section,
 'args':self.getArguments(function['sig_in'], name=arg_doc, default=default )
 }
 if function["type"] == "signal":
 completion['body'] = "pass" if not self.options.debug else 'debug ("%s")' % section
 core_bridge.append('const_%s = %s' % (const_name, os.environ[ENV_OVERRIDE+const_name]))
 continue
 core_bridge.append(line.replace('\n',''))
 except IOError:
 print ("Can't open template file [%s]" % self.core_template)
 sys.exit(1)
 #now we write to final file
 self.finalWrite(self.core_dest, core_bridge)
 def generateFrontendSide(self):
 async = "async" in self.getFlags(section)
 completion = {
 'sig_in':function['sig_in'] or '',
 'sig_out':function['sig_out'] or '',
 'category':'plugin' if function['category'] == 'plugin' else 'core',
 'name':section,
 'args':self.getArguments(function['sig_in'], name=arg_doc, default=default)
 }
 if function["type"] == "method":
 completion['debug'] = "" if not self.options.debug else 'debug ("%s")\n%s' % (section,8*' ')
 frontend_bridge.append('const_%s = %s' % (const_name, os.environ[ENV_OVERRIDE+const_name]))
 continue
 frontend_bridge.append(line.replace('\n',''))
 except IOError:
 print ("Can't open template file [%s]" % self.frontend_template)
 sys.exit(1)
 #now we write to final file
 self.finalWrite(self.frontend_dest, frontend_bridge)
 class DbusXmlConstructor(Constructor):
 """Constructor for DBus XML syntaxt (used by Qt frontend)"""
 def __init__(self, bridge_template, options):
 Constructor.__init__(self, bridge_template, options)
 self.template="dbus_xml_template.xml"
 self.core_dest="org.goffi.sat.xml"
 self.default_annotation = { 'a{ss}': 'StringDict',
 'a(sa{ss}as)': 'QList<Contact>',
 'a{i(ss)}': 'HistoryT',
 'a(sss)': 'QList<MenuT>',
 annot_elt = doc.createElement("annotation")
 annot_elt.setAttribute('name', "com.trolltech.QtDBus.QtTypeName.In%d" % idx)
 annot_elt.setAttribute('value', self.default_annotation[arg])
 new_elt.appendChild(annot_elt)
 idx+=1
 if function['sig_out']:
 arg_elt = doc.createElement('arg')
 arg_elt.setAttribute('type', function['sig_out'])
 arg_elt.setAttribute('direction', 'out')
 new_elt.appendChild(arg_elt)
 raise ConstructorError('Unknown constructor type')
 class BridgeConstructor:
 def __init__(self):
 self.options = None
 def check_options(self):
 """Check command line options"""
 _usage="""
 %prog [options]
 help=("Force overwritting of existing files"))
 parser.add_option("-d", "--debug", action="store_true", default=False,
 help=("Add debug information printing"))
 parser.add_option("--no_unicode", action="store_false", dest="unicode", default=True,
 help=("Remove unicode type protection from string results"))
 parser.add_option("--flags", action="store", type="string",
 help=("Constructors' specific flags, comma separated"))
 (self.options, args) = parser.parse_args()
 self.options.flags = self.options.flags.split(',') if self.options.flags else []

Mercurial > libervia-backend

comparison src/bridge/bridge_constructor/bridge_contructor.py @ 587:952322b1d490