1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2016 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
27 import string, sys, fpformat, re, os
31 from xml.sax.handler import *
32 from omniidl import idlast, idltype, idlvisitor, idlutil, output
33 from salome_utils import getUserName
35 # parameters not found in IDL file, user's specified in optional parameters
36 common_data={"AUTHOR" : "",
47 #--------------------------------------------------
48 # extract value of <param_name> from <args> list
49 # it's proposed that the matching <args> item
50 # looks like <param_name>=<value>, for example,
51 # catalog=/tmp/myxml.xml
52 #--------------------------------------------------
53 def getParamValue( param_name, default_value, args ):
54 pattern="^"+param_name+"="
56 res = default_value #initial value
58 s = re.compile(pattern).search(opt)
66 #--------------------------------------------------
68 #--------------------------------------------------
70 print("ERROR : ", message)
73 #--------------------------------------------------
74 # base class implementing tree
75 #--------------------------------------------------
78 def __init__(self, name = '', content = '', key = None):
80 self.content = content
87 def addChild(self, tree):
89 self.childs.append(tree)
93 def addNamedChild(self, name, content = ''):
94 return self.addChild(Tree(name, content))
96 def replaceChild(self, tree):
100 if (i.name == tree.name) & ((i.key is None) | (i.key == tree.key)):
102 self.childs.insert(pos, tree)
106 return self.addChild(tree)
108 def insertFirstChild(self, tree):
110 self.childs.insert(0, tree)
113 def insertFirstNamedChild(self, name, content = ''):
114 return self.insertFirstChild(Tree(name, content))
116 def output_xml(self, f, depth=0):
119 s = string.ljust('', 4*depth)
121 for k,v in list(self.attrs.items()):
122 s += ' ' + k + '="' + v + '"'
124 if self.content != '':
127 if len(self.childs) > 0:
132 for i in self.childs:
136 s = '</' + self.name + '>\n'
137 if len(self.childs) > 0 :
138 s = string.ljust('', 4*depth) + s
141 def Dump(self, levels=-1, depth=0):
142 #Dumps the tree contents
144 if levels == 0: return
146 s = string.ljust('', 4*depth)
147 print(s, self, self.content)
148 for i in self.childs:
149 i.Dump(levels-1, depth+1)
152 #Returns list of the parents
161 def getChild(self, name, content=None):
162 # return child node with a given name
163 # if content == None, don't compare contents
164 for i in self.childs:
166 if (content is None) | (i.content == content):
170 def getNode(self, name, content='', depth=-1):
171 # recursive search of a node with a given name
172 # content == None, don't compare content
173 if (self.name == name):
174 if (content is None) | (self.content == content):
178 for i in self.childs:
179 n = i.getNode(name, content, depth-1)
196 def mergeChilds(self, t, list):
197 L_ext = t.getChild(list)
198 L_int = self.getChild(list)
202 for i_ext in L_ext.childs:
204 if k_ext is None: continue
207 for i_int in L_int.childs:
209 if k_int is None: continue
217 L_merge.addChild(i_int)
219 L_merge.addChild(i_ext)
221 self.replaceChild(L_merge)
223 def setAttrib(self, name,value):
224 self.attrs[name]=value
227 #--------------------------------------------------
228 # implements parameter tree
229 #--------------------------------------------------
230 class parameter(Tree):
232 def __init__(self, name=None, mode = 'in', type='', comment='unknown'):
233 Tree.__init__(self, mode + 'Parameter', key=name)
235 if name is None: return
237 self.addNamedChild(mode + 'Parameter-name', name)
238 self.addNamedChild(mode + 'Parameter-type', type)
239 self.addNamedChild(mode + 'Parameter-comment', comment)
244 self.replaceChild(P.getChild(P.mode + 'Parameter-name'))
245 self.replaceChild(P.getChild(P.mode + 'Parameter-type'))
246 C = P.getChild(P.mode + 'Parameter-comment')
247 if C.content != 'unkonwn':
250 #--------------------------------------------------
251 # implements dataStreamParameter tree
252 #--------------------------------------------------
253 class dataStreamParameter(parameter):
255 def __init__(self, name=None, mode='in', type='', dependency='', comment='unknown'):
256 parameter.__init__(self, name, mode, type, comment)
257 if name is None: return
259 self.addNamedChild(mode + 'Parameter-dependency', dependency)
264 parameter.merge(self, P)
265 self.replaceChild(P.getChild(mode + 'Parameter-dependency'))
268 def parseComment(comment):
271 word = spaces + '([a-zA-Z][a-zA-Z0-9_]*)' + spaces
277 ## match : // followed by a 'DataStreamPorts' string,
278 ## the service name, and a list of ports
279 pattern = '// *DataStreamPorts{,1}' + word
280 m = re.match(pattern, comment)
282 ## if there is a match, parse remaining part of comment
285 type = 'DataStreamPorts'
288 sPorts = comment[m.end():]
289 pattern = word + '\('+word+','+word +','+word+'\)' \
290 + spaces + ',{,1}' + spaces
291 while len(sPorts) > 0:
292 ## process next DataStreamPort
293 ## match a definition like xx(a,b,c) with a possible trailing ,
294 ## returns a tuple (xx, a, b, c) and
295 ## the remaining part of input string
296 m = re.match(pattern, sPorts)
298 raise LookupError('format error in DataStreamPort definition : '+sPorts)
299 sPorts = sPorts[m.end():]
300 result.append(m.groups())
302 return type, key, result;
304 #--------------------------------------------------
305 # implements service tree
306 #--------------------------------------------------
309 def __init__(self, name=None, comment = 'unknown'):
311 Tree.__init__(self, 'component-service', key=name)
312 if name is None: return
314 self.addNamedChild('service-name', name)
315 self.addNamedChild('service-author',common_data["AUTHOR"])
316 self.addNamedChild('service-version',common_data["VERSION"])
317 self.addNamedChild('service-comment', comment)
318 self.addNamedChild('service-by-default', "0")
319 self.addNamedChild('inParameter-list')
320 self.addNamedChild('outParameter-list')
321 self.addNamedChild('DataStream-list')
323 def createInParameter(self, name, type):
324 L = self.getChild('inParameter-list')
325 p = parameter(name, 'in', type)
329 def createOutParameter(self, name, type):
330 L = self.getChild('outParameter-list')
331 p = parameter(name, 'out', type)
335 def createDataStreamParameter(self, p):
336 L = self.getChild('DataStream-list')
337 p = dataStreamParameter(p[0], p[2], p[1], p[3])
343 self.replaceChild(S.getChild('service-author'))
344 self.replaceChild(S.getChild('service-version'))
345 self.replaceChild(S.getChild('service-by-default'))
346 C = S.getChild('service-comment')
347 if C.content != 'unkonwn':
350 for L in ['inParameter-list', 'outParameter-list', 'DataStream-list']:
351 self.mergeChilds(S, L)
354 #--------------------------------------------------
355 # implements interface tree
356 #--------------------------------------------------
357 class Interface(Tree):
359 def __init__(self, name=None, comment='unknown'):
361 Tree.__init__(self, key=name)
363 if name is None: return
365 self.addNamedChild('component-interface-name', name)
366 self.addNamedChild('component-interface-comment', comment);
367 self.addNamedChild('component-service-list')
369 def createService(self, name):
370 L = self.getChild('component-service-list')
373 error ("Interface.createService() : 'component-service-list' is not found")
380 def findService(self, key):
381 L = self.getChild('component-service-list')
389 C = S.getChild('component-interface-comment')
390 if C.content != 'unkonwn':
393 self.mergeChilds(I, 'component-service-list')
395 def processDataStreams(self):
396 for sComment in self.comments:
398 type, key, result = parseComment(sComment)
400 if type == 'DataStreamPorts':
401 Service = self.findService(key)
403 raise LookupError('service ' + key + \
404 ' not found in interface : ' + self.key)
406 ## process next DataStreamPort
407 Service.createDataStreamParameter(p)
410 #--------------------------------------------------
411 # implements Component tree
412 #--------------------------------------------------
413 class Component(Tree):
414 def __init__(self, name=None):
415 Tree.__init__(self, 'component', key=name)
416 if name is None: return
418 # ASV : fix for bug PAL8922 (Component name indicated by user in GUI is not taken into account
419 if common_data["COMP_NAME"] != '':
420 self.addNamedChild('component-name', common_data["COMP_NAME"])
422 self.addNamedChild('component-name', name)
424 # ASV : if user name is NOT set, then use component-name instead. Else - default.
425 if common_data["COMP_UNAME"] != '':
426 self.addNamedChild('component-username', common_data["COMP_UNAME"])
428 if common_data["COMP_NAME"] != '':
429 self.addNamedChild('component-username', common_data["COMP_NAME"] )
431 self.addNamedChild('component-username', name)
433 self.addNamedChild('component-type', common_data["COMP_TYPE"])
434 self.addNamedChild('component-author', common_data["AUTHOR"])
435 self.addNamedChild('component-version', common_data["VERSION"])
436 self.addNamedChild('component-comment', 'unknown')
437 self.addNamedChild('component-impltype', common_data["COMP_IMPL"])
438 self.addNamedChild('component-icone', common_data["ICON"])
439 self.addNamedChild('constraint')
440 self.addNamedChild('component-interface-list')
442 def createInterface(self, name):
443 L = self.getChild('component-interface-list')
445 error("createInterface: No component-interface-list is found")
453 for i in ['component-username', 'component-author',
454 'component-type', 'component-icone', 'component-version',
455 'component-impltype', 'constraint']:
457 int = self.getChild(i)
460 elif ext is not None and len(ext.content):
461 int.content = ext.content
463 Cc = C.getChild('component-comment')
464 if Cc.content != 'unkonwn':
465 self.replaceChild(Cc)
467 self.mergeChilds(C, 'component-interface-list')
469 #--------------------------------------------------
470 # implements document tree
471 #--------------------------------------------------
472 class Catalog(ContentHandler, Tree):
473 def __init__(self, filename = None):
478 parser = xml.sax.make_parser()
479 parser.setContentHandler(self)
480 parser.parse(filename)
482 t = self.addNamedChild('begin-catalog')
483 t.addNamedChild('type-list')
484 t.addNamedChild('component-list')
486 n = self.getChild('begin-catalog')
488 error("Catalog.__init__ : No 'begin-catalog' is found!")
490 if n.getChild('path-prefix-list') is None:
491 n.insertFirstNamedChild('path-prefix-list')
492 if n.getChild('type-list') is None:
493 p=n.childs.index(n.getChild('path-prefix-list'))
494 n.childs.insert(p+1,Tree('type-list'))
495 if n.getChild('component-list') is None:
496 n.addNamedChild('component-list')
498 def removeComponent(self, name):
499 complist = self.getNode('component-list')
502 print("Catalog.removeComponent() : 'component-list' is not found")
504 for comp in complist.childs:
505 cname = comp.getChild('component-name')
506 if cname is not None:
507 if cname.content == name:
508 complist.childs.pop(idx)
509 print("Component " + name + " is removed")
512 def startDocument(self):
513 self.list.append(self)
515 def startElement(self, name, attrs):
516 p = self.list[len(self.list)-1]
517 if name == 'component':
518 e = p.addChild(Component())
519 elif name == 'component-interface-name':
520 e = p.addNamedChild(name)
521 elif name == 'component-service':
522 e = p.addChild(Service())
523 elif name == 'inParameter':
524 e = p.addChild(parameter(mode='in'))
525 elif name == 'outParameter':
526 e = p.addChild(parameter(mode='out'))
527 elif name == 'sequence':
528 e = p.addChild(SeqType(attrs["name"],attrs["content"]))
529 elif name == 'objref':
530 e = p.addChild(ObjType(attrs["name"]))
531 elif name == 'struct':
532 e = p.addChild(StructType(attrs["name"]))
534 e = p.addChild(Type(attrs["name"],attrs["kind"]))
535 elif name == 'member':
536 e = p.addChild(Member(attrs["name"],attrs["type"]))
538 e = p.addNamedChild(name)
542 def endElement(self, name):
543 self.buffer = string.join(string.split(self.buffer), ' ')
544 p = self.list[len(self.list)-1]
545 p.content = self.buffer
546 if name == 'component':
547 p.key = p.getChild('component-name').content
551 def characters(self, ch):
554 def mergeComponent(self, comp):
556 L_int = self.getNode('component-list')
558 error("Catalog.mergeComponent : 'component-list' is not found")
564 for i_int in L_int.childs:
565 if (i_int.key == n_ext):
570 print(' add component', i_ext.getChild('component-name').content)
571 L_int.addChild(i_ext)
573 print(' replace component', i_ext.getChild('component-name').content)
576 def mergeType(self, type):
577 L_int = self.getNode('type-list')
579 error("Catalog.mergeType : 'type-list' is not found")
581 for t in L_int.childs:
582 if t.attrs["name"] == type.attrs["name"]:
589 def __init__(self, name,type):
590 Tree.__init__(self, 'member')
591 self.setAttrib("name",name)
592 self.setAttrib("type",type)
595 def __init__(self, name,kind):
596 Tree.__init__(self, 'type')
597 self.setAttrib("name",name)
598 self.setAttrib("kind",kind)
601 self.setAttrib("kind",t.attrs["kind"])
604 def __init__(self, name,content):
605 Tree.__init__(self, 'sequence')
606 self.setAttrib("name",name)
607 self.setAttrib("content",content)
610 self.setAttrib("content",t.attrs["content"])
612 class StructType(Tree):
613 def __init__(self, name):
614 Tree.__init__(self, 'struct')
615 self.setAttrib("name",name)
618 #remove childs and replace by t childs
621 self.childs.append(c)
624 def __init__(self, name):
625 Tree.__init__(self, 'objref')
626 self.setAttrib("name",name)
629 RepoId=t.attrs.get("id")
631 self.setAttrib("id",RepoId)
632 #remove childs and replace by t childs
635 self.childs.append(c)
640 idltype.tk_void: "void",
641 idltype.tk_short: "short",
642 idltype.tk_long: "long",
643 idltype.tk_ushort: "unsigned short",
644 idltype.tk_ulong: "unsigned long",
645 idltype.tk_float: "float",
646 idltype.tk_double: "double",
647 idltype.tk_boolean: "boolean",
648 idltype.tk_char: "char",
649 idltype.tk_octet: "octet",
650 idltype.tk_any: "any",
651 idltype.tk_TypeCode: "CORBA::TypeCode",
652 idltype.tk_Principal: "CORBA::Principal",
653 idltype.tk_longlong: "long long",
654 idltype.tk_ulonglong: "unsigned long long",
655 idltype.tk_longdouble: "long double",
656 idltype.tk_wchar: "wchar"
660 #--------------------------------------------------
661 # class ModuleCatalogVisitor
662 #--------------------------------------------------
663 class ModuleCatalogVisitor (idlvisitor.AstVisitor):
665 def __init__(self, catalog):
666 self.catalog = catalog
668 self.currentScope=None
670 def visitAST(self, node):
671 for n in node.declarations():
675 def visitModule(self, node):
676 self.currentScope=node
677 for n in node.definitions():
680 def visitInterface(self, node):
685 for i in node.inherits():
687 if s[0] == "Engines":
688 if s[1] == "EngineComponent":
689 self.EngineType = 1; break
690 if s[1] == "Superv_Component":
691 self.EngineType = 2; break
694 #This interface is a SALOME component
695 Comp = Component(node.identifier())
697 self.currentInterface = Comp.createInterface(node.identifier())
699 for c in node.callables():
700 if isinstance(c, idlast.Operation):
703 for c in node.declarations():
704 if isinstance(c, idlast.Struct):
707 for i in node.comments():
708 self.currentInterface.comments.append(str(i))
710 if self.EngineType == 2:
711 self.currentInterface.processDataStreams()
714 nb_components = nb_components + 1
715 self.catalog.mergeComponent(Comp)
718 #This interface is not a component : use it as a DataType
719 t=ObjType("/".join(node.scopedName()))
720 for i in node.inherits():
721 t.addNamedChild("base","/".join(i.scopedName()))
722 self.catalog.mergeType(t)
727 def visitOperation(self, node):
729 self.currentService = self.currentInterface.createService \
732 node.returnType().accept(self)
733 if (self.currentType != "void"):
734 self.currentService.createOutParameter \
735 ("return", self.currentType)
737 for c in node.parameters():
740 for i in node.comments():
741 self.currentInterface.comments.append(str(i))
744 def visitDeclaredType(self, type):
746 scoped_name="/".join(type.scopedName())
747 self.currentType = scoped_name
749 def visitBaseType(self, type):
750 self.currentType = ttsMap[type.kind()]
752 def visitStringType(self, type):
753 self.currentType = "string"
755 def visitParameter(self, node):
756 node.paramType().accept(self)
758 self.currentService.createInParameter \
759 (node.identifier(), self.currentType)
761 self.currentService.createOutParameter \
762 (node.identifier(), self.currentType)
764 def visitSequenceType(self,type):
765 type.seqType().accept(self)
766 if type.bound() == 0:
767 self.contentType=self.currentType
768 self.currentType = "sequence"
770 self.currentType = None
772 def visitTypedef(self, node):
773 if node.constrType():
774 node.aliasType().decl().accept(self)
776 node.aliasType().accept(self)
777 type = self.currentType
781 for d in node.declarators():
783 if self.__result_declarator:
784 decll.append(self.__result_declarator)
785 if type == "sequence":
786 #it's a sequence type
788 scoped_name="/".join(self.currentScope.scopedName()+[name])
789 self.catalog.mergeType(SeqType(scoped_name,self.contentType))
793 # scoped_name="/".join(self.currentScope.scopedName()+[name])
794 # self.catalog.mergeType(Type(scoped_name,type))
796 def visitStruct(self, node):
797 t=StructType("/".join(node.scopedName()))
798 for m in node.members():
800 m.memberType().decl().accept(self)
802 m.memberType().accept(self)
803 type = self.currentType
804 for d in m.declarators():
806 t.addChild(Member(self.__result_declarator,type))
808 self.catalog.mergeType(t)
810 def visitDeclarator(self, node):
812 self.__result_declarator =None
814 self.__result_declarator =node.identifier()
816 #--------------------------------------------------
817 # parse idl and store xml file
818 #--------------------------------------------------
821 CatalogFileName=getParamValue("catalog", "CatalogModulePersonnel.xml", args)
822 if re.compile(".*?.xml$").match(CatalogFileName, 1) is None:
823 CatalogFileName = CatalogFileName + '.xml'
825 #========= Read parameters ======================
826 common_data["ICON"] = getParamValue("icon", "", args)
827 common_data["AUTHOR"] = getParamValue("author", getUserName(), args)
828 common_data["VERSION"] = getParamValue("version", "1", args)
829 common_data["COMP_NAME"] = getParamValue("name", "", args)
830 common_data["COMP_UNAME"] = getParamValue("username", "", args)
831 common_data["COMP_TYPE"] = getParamValue("type", "OTHER", args)
832 common_data["COMP_IMPL"] = getParamValue("impltype", "1", args)
836 remove_comp = getParamValue("remove", "", args)
838 #==================================================
840 if (os.path.exists(CatalogFileName)):
841 print("Importing", CatalogFileName)
842 C = Catalog(CatalogFileName)
844 print("Creating ",CatalogFileName)
847 print("Reading idl file")
849 visitor = ModuleCatalogVisitor(C)
855 C.removeComponent(remove_comp)
857 if (os.path.exists(CatalogFileName)):
858 print("Updating", CatalogFileName)
859 CatalogFileName_old = CatalogFileName + '_old'
860 os.rename(CatalogFileName, CatalogFileName_old)
862 CatalogFileName_old = ""
863 print("Writing", CatalogFileName)
865 CatalogFileName_new = CatalogFileName + '_new'
866 f=open(CatalogFileName_new, 'w')
867 f.write("<?xml version='1.0' encoding='us-ascii' ?>\n\n")
871 os.rename(CatalogFileName_new, CatalogFileName)
872 if ((CatalogFileName_old != "") & os.path.exists(CatalogFileName_old)):
873 os.unlink(CatalogFileName_old)
878 if __name__ == "__main__":
880 print("Usage : omniidl -bIDLparser [-I<catalog files directory>]* -Wbcatalog=<my_catalog.xml>[,icon=<pngfile>][,version=<num>][,author=<name>][,name=<component_name>][,username=<component_username>][,impltype=<implementation type : 0 (python), 1 (C++)>] <file.idl>")