#!/usr/bin/env python # -*- coding: utf-8 -*- # # lv2specgen, a documentation generator for LV2 specifications. # Copyright (c) 2009-2012 David Robillard # # Based on SpecGen: # # Copyright (c) 2003-2008 Christopher Schmidt # Copyright (c) 2005-2008 Uldis Bojars # Copyright (c) 2007-2008 Sergio Fernández # # This software is licensed under the terms of the MIT License. # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. __date__ = "2011-10-26" __version__ = __date__.replace('-', '.') __authors__ = """ Christopher Schmidt, Uldis Bojars, Sergio Fernández, David Robillard""" __license__ = "MIT License " __contact__ = "devel@lists.lv2plug.in" import datetime import os import re import sys import xml.sax.saxutils import xml.dom import xml.dom.minidom try: from lxml import etree have_lxml = True except: have_lxml = False try: import pygments import pygments.lexers import pygments.formatters from pygments.lexer import RegexLexer, include, bygroups from pygments.token import Text, Comment, Operator, Keyword, Name, String, Literal, Punctuation have_pygments = True except ImportError: print("Error importing pygments, syntax highlighting disabled") have_pygments = False try: import rdflib except ImportError: sys.exit("Error importing rdflib") # Global Variables classranges = {} classdomains = {} linkmap = {} spec_url = None spec_ns_str = None spec_ns = None spec_pre = None specgendir = None ns_list = { "http://www.w3.org/1999/02/22-rdf-syntax-ns#" : "rdf", "http://www.w3.org/2000/01/rdf-schema#" : "rdfs", "http://www.w3.org/2002/07/owl#" : "owl", "http://www.w3.org/2001/XMLSchema#" : "xsd", "http://rdfs.org/sioc/ns#" : "sioc", "http://xmlns.com/foaf/0.1/" : "foaf", "http://purl.org/dc/elements/1.1/" : "dc", "http://purl.org/dc/terms/" : "dct", "http://purl.org/rss/1.0/modules/content/" : "content", "http://www.w3.org/2003/01/geo/wgs84_pos#" : "geo", "http://www.w3.org/2004/02/skos/core#" : "skos", "http://lv2plug.in/ns/lv2core#" : "lv2", "http://usefulinc.com/ns/doap#" : "doap", "http://ontologi.es/doap-changeset#" : "dcs" } rdf = rdflib.Namespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#') rdfs = rdflib.Namespace('http://www.w3.org/2000/01/rdf-schema#') owl = rdflib.Namespace('http://www.w3.org/2002/07/owl#') lv2 = rdflib.Namespace('http://lv2plug.in/ns/lv2core#') doap = rdflib.Namespace('http://usefulinc.com/ns/doap#') dcs = rdflib.Namespace('http://ontologi.es/doap-changeset#') foaf = rdflib.Namespace('http://xmlns.com/foaf/0.1/') def findStatements(model, s, p, o): return model.triples([s, p, o]) def findOne(m, s, p, o): l = findStatements(m, s, p, o) try: return l.next() except: return None def getSubject(s): return s[0] def getPredicate(s): return s[1] def getObject(s): return s[2] def getLiteralString(s): return s def isResource(n): return type(n) == rdflib.URIRef def isBlank(n): return type(n) == rdflib.BNode def isLiteral(n): return type(n) == rdflib.Literal def niceName(uri): regexp = re.compile("^(.*[/#])([^/#]+)$") rez = regexp.search(uri) if not rez: return uri pref = rez.group(1) if pref in ns_list: return ns_list.get(pref, pref) + ":" + rez.group(2) else: print("warning: prefix %s not in ns list:" % pref) print(ns_list) return uri def termName(m, urinode): "Trims the namespace out of a term to give a name to the term." return str(urinode).replace(spec_ns_str, "") def getLabel(m, urinode): l = findOne(m, urinode, rdfs.label, None) if l: return getLiteralString(getObject(l)) else: return '' if have_pygments: # Based on sw.py by Philip Cooper class Notation3Lexer(RegexLexer): """ Lexer for N3 / Turtle / NT """ name = 'N3' aliases = ['n3', 'turtle'] filenames = ['*.n3', '*.ttl', '*.nt'] mimetypes = ['text/rdf+n3','application/x-turtle','application/n3'] tokens = { 'comments': [ (r'(\s*#.*)', Comment) ], 'root': [ include('comments'), (r'(\s*@(?:prefix|base|keywords)\s*)(\w*:\s+)?(<[^> ]*>\s*\.\s*)',bygroups(Keyword,Name.Variable,Name.Namespace)), (r'\s*(<[^>]*\>)', Name.Class, ('triple','predObj')), (r'(\s*[a-zA-Z_:][a-zA-Z0-9\-_:]*\s)', Name.Class, ('triple','predObj')), (r'\s*\[\]\s*', Name.Class, ('triple','predObj')), ], 'triple' : [ (r'\s*\.\s*', Text, '#pop') ], 'predObj': [ include('comments'), (r'\s*a\s*', Name.Keyword, 'object'), (r'\s*[a-zA-Z_:][a-zA-Z0-9\-_:]*\b\s*', Name.Tag, 'object'), (r'\s*(<[^>]*\>)', Name.Tag, 'object'), (r'\s*\]\s*', Text, '#pop'), (r'(?=\s*\.\s*)', Keyword, '#pop'), ], 'objList': [ include('comments'), (r'\s*\)', Text, '#pop'), include('object') ], 'object': [ include('comments'), (r'\s*\[', Text, 'predObj'), (r'\s*<[^> ]*>', Name.Tag), (r'\s*("""(?:.|\n)*?""")(\@[a-z]{2-4}|\^\^?)?\s*', bygroups(Literal.String,Text)), (r'\s*".*?[^\\]"(?:\@[a-z]{2-4}|\^\^?)?\s*', Literal.String), (r'\s*[0-9]+\.[0-9]*\s*\n?', Literal.Number), (r'\s*[0-9]+\s*\n?', Literal.Number), (r'\s*[a-zA-Z0-9\-_\:]+\s*', Name.Tag), (r'\s*\(', Text, 'objList'), (r'\s*;\s*\n?', Punctuation, '#pop'), (r'\s*,\s*\n?', Punctuation), # Added by drobilla so "," is not an error (r'(?=\s*\])', Text, '#pop'), (r'(?=\s*\.)', Text, '#pop'), ], } def linkify(string): "Add links to code documentation for identifiers" if string in linkmap.keys(): # Exact match for complete string return linkmap[string] rgx = re.compile('([^a-zA-Z0-9_:])(' + \ '|'.join(map(re.escape, linkmap)) + \ ')([^a-aA-Z0-9_:])') def translateCodeLink(match): return match.group(1) + linkmap[match.group(2)] + match.group(3) return rgx.sub(translateCodeLink, string) def getComment(m, urinode, classlist, proplist, instalist): c = findOne(m, urinode, lv2.documentation, None) if c: markup = getLiteralString(getObject(c)) # Syntax highlight all C code if have_pygments: code_rgx = re.compile('
(.*?)
', re.DOTALL) while True: code = code_rgx.search(markup) if not code: break match_str = xml.sax.saxutils.unescape(code.group(1)) code_str = pygments.highlight( match_str, pygments.lexers.CLexer(), pygments.formatters.HtmlFormatter()) markup = code_rgx.sub(code_str, markup, 1) # Syntax highlight all Turtle code if have_pygments: code_rgx = re.compile('
(.*?)
', re.DOTALL) while True: code = code_rgx.search(markup) if not code: break match_str = xml.sax.saxutils.unescape(code.group(1)) code_str = pygments.highlight( match_str, Notation3Lexer(), pygments.formatters.HtmlFormatter()) markup = code_rgx.sub(code_str, markup, 1) # Add links to code documentation for identifiers markup = linkify(markup) # Replace ext:ClassName with link to appropriate fragment rgx = re.compile(spec_pre + ':([A-Z][a-zA-Z0-9_-]*)') def translateClassLink(match): curie = match.group(0) name = curie[curie.find(':') + 1:] uri = spec_ns + name if rdflib.URIRef(uri) not in classlist: print("warning: Link to undefined class %s\n" % curie) return '%s' % (name, curie) markup = rgx.sub(translateClassLink, markup) # Replace ext:instanceName with link to appropriate fragment rgx = re.compile(spec_pre + ':([a-z][a-zA-Z0-9_-]*)') def translateInstanceLink(match): curie = match.group(0) name = curie[curie.find(':') + 1:] uri = spec_ns + name if (rdflib.URIRef(uri) not in instalist and rdflib.URIRef(uri) not in proplist): print("warning: Link to undefined instance/property %s\n" % curie) return '%s' % (name, curie) markup = rgx.sub(translateInstanceLink, markup) if have_lxml: try: # Parse and validate documentation as XHTML Basic 1.1 doc = """ Validation Skeleton Document %s """ % str(markup.decode()) oldcwd = os.getcwd() os.chdir(specgendir) parser = etree.XMLParser(dtd_validation=True, no_network=True) root = etree.fromstring(doc, parser) os.chdir(oldcwd) except Exception as e: print("Invalid lv2:documentation for %s\n%s" % (urinode, e)) return markup c = findOne(m, urinode, rdfs.comment, None) if c: text = getLiteralString(getObject(c)) return '

%s

' % xml.sax.saxutils.escape(text) return '' def getProperty(val, first=True): "Return a string representing a property value in a property table" doc = '' if not first: doc += '' # Empty cell in header column doc += '%s\n' % val return doc def endProperties(first): if first: return '' else: return '' def rdfsPropertyInfo(term, m): """Generate HTML for properties: Domain, range""" global classranges global classdomains doc = "" range = "" domain = "" # Find subPropertyOf information rlist = '' first = True for st in findStatements(m, term, rdfs.subPropertyOf, None): k = getTermLink(getObject(st), term, rdfs.subPropertyOf) rlist += getProperty(k, first) first = False if rlist != '': doc += 'Sub-property of' + rlist # Domain stuff domains = findStatements(m, term, rdfs.domain, None) domainsdoc = "" first = True for d in domains: union = findOne(m, getObject(d), owl.unionOf, None) if union: uris = parseCollection(m, getObject(union)) for uri in uris: domainsdoc += getProperty(getTermLink(uri, term, rdfs.domain), first) add(classdomains, uri, term) else: if not isBlank(getObject(d)): domainsdoc += getProperty(getTermLink(getObject(d), term, rdfs.domain), first) first = False if (len(domainsdoc) > 0): doc += "Domain%s" % domainsdoc # Range stuff ranges = findStatements(m, term, rdfs.range, None) rangesdoc = "" first = True for r in ranges: union = findOne(m, getObject(r), owl.unionOf, None) if union: uris = parseCollection(m, getObject(union)) for uri in uris: rangesdoc += getProperty(getTermLink(uri, term, rdfs.range), first) add(classranges, uri, term) first = False else: if not isBlank(getObject(r)): rangesdoc += getProperty(getTermLink(getObject(r), term, rdfs.range), first) first = False if (len(rangesdoc) > 0): doc += "Range%s" % rangesdoc return doc def parseCollection(model, node): uris = [] while node: first = findOne(model, node, rdf.first, None) rest = findOne(model, node, rdf.rest, None) if not first or not rest: break; uris.append(getObject(first)) node = getObject(rest) return uris def getTermLink(uri, subject=None, predicate=None): uri = str(uri) extra = '' if subject != None and predicate != None: extra = 'about="%s" rel="%s" resource="%s"' % (str(subject), niceName(str(predicate)), uri) if (uri.startswith(spec_ns_str)): return '%s' % (uri.replace(spec_ns_str, ""), extra, niceName(uri)) else: return '%s' % (uri, extra, niceName(uri)) def rdfsClassInfo(term, m): """Generate rdfs-type information for Classes: ranges, and domains.""" global classranges global classdomains doc = "" # Find subClassOf information restrictions = [] superclasses = [] for st in findStatements(m, term, rdfs.subClassOf, None): if not isBlank(getObject(st)): uri = getObject(st) if not uri in superclasses: superclasses.append(uri) else: meta_type = findOne(m, getObject(st), rdf.type, None) restrictions.append(getSubject(meta_type)) if len(superclasses) > 0: doc += "\nSub-class of" first = True for superclass in superclasses: doc += getProperty(getTermLink(superclass), first) first = False for r in restrictions: props = findStatements(m, r, None, None) onProp = None comment = None for p in props: if getPredicate(p) == owl.onProperty: onProp = getObject(p) elif getPredicate(p) == rdfs.comment: comment = getObject(p) if onProp != None: doc += 'Restriction on %s' % getTermLink(onProp) prop_str = '' last_pred = None first = True for p in findStatements(m, r, None, None): if (getPredicate(p) == owl.onProperty or getPredicate(p) == rdfs.comment or (getPredicate(p) == rdf.type and getObject(p) == owl.Restriction) or getPredicate(p) == lv2.documentation): last_pred = None continue if getPredicate(p) != last_pred: prop_str += '%s\n' % getTermLink(getPredicate(p)) first = True if isResource(getObject(p)): prop_str += getProperty(getTermLink(getObject(p)), first) first = False elif isLiteral(getObject(p)): prop_str += getProperty(getLiteralString(getObject(p)), first) first = False last_pred = getPredicate(p) prop_str += endProperties(first) if prop_str != '': doc += '%s
\n' % prop_str if comment != None: doc += "%s\n" % getLiteralString(comment) doc += '' # Find out about properties which have rdfs:domain of t d = classdomains.get(str(term), "") if d: dlist = '' first = True for k in d: dlist += getProperty(getTermLink(k), first) first = False doc += "In domain of%s" % dlist # Find out about properties which have rdfs:range of t r = classranges.get(str(term), "") if r: rlist = '' first = True for k in r: rlist += getProperty(getTermLink(k), first) first = False doc += "In range of%s" % rlist return doc def isSpecial(pred): """Return True if the predicate is "special" and shouldn't be emitted generically""" return pred in [rdf.type, rdfs.range, rdfs.domain, rdfs.label, rdfs.comment, rdfs.subClassOf, rdfs.subPropertyOf, lv2.documentation] def blankNodeDesc(node, m): properties = findStatements(m, node, None, None) doc = '' last_pred = '' for p in properties: if isSpecial(getPredicate(p)): continue doc += '' doc += '%s\n' % getTermLink(getPredicate(p)) if isResource(getObject(p)): doc += '%s\n' % getTermLink(getObject(p)) # getTermLink(str(getObject(p)), node, getPredicate(p)) elif isLiteral(getObject(p)): doc += '%s\n' % getLiteralString(getObject(p)) elif isBlank(getObject(p)): doc += '' + blankNodeDesc(getObject(p), m) + '\n' else: doc += '?\n' doc += '' if doc != '': doc = '\n%s\n
\n' % doc return doc def extraInfo(term, m): """Generate information about misc. properties of a term""" doc = "" properties = findStatements(m, term, None, None) last_pred = None first = True for p in properties: if isSpecial(getPredicate(p)): last_pred = None continue if getPredicate(p) != last_pred: doc += '%s\n' % getTermLink(getPredicate(p)) first = True if isResource(getObject(p)): doc += getProperty(getTermLink(getObject(p), term, getPredicate(p)), first) elif isLiteral(getObject(p)): doc += getProperty(linkify(str(getObject(p))), first) elif isBlank(getObject(p)): doc += getProperty(str(blankNodeDesc(getObject(p), m)), first) else: doc += getProperty('?', first) first = False last_pred = getPredicate(p) #doc += endProperties(first) return doc def rdfsInstanceInfo(term, m): """Generate rdfs-type information for instances""" doc = "" first = True for match in findStatements(m, term, rdf.type, None): doc += getProperty(getTermLink(getObject(match), term, rdf.type), first) first = False if doc != "": doc = "Type" + doc doc += endProperties(first) return doc def owlInfo(term, m): """Returns an extra information that is defined about a term using OWL.""" res = '' # Inverse properties ( owl:inverseOf ) first = True for st in findStatements(m, term, owl.inverseOf, None): res += getProperty(getTermLink(getObject(st)), first) first = False if res != "": res += endProperties(first) res = "Inverse:\n" + res def owlTypeInfo(term, propertyType, name): if findOne(m, term, rdf.type, propertyType): return "OWL Type%s\n" % name else: return "" res += owlTypeInfo(term, owl.DatatypeProperty, "Datatype Property") res += owlTypeInfo(term, owl.ObjectProperty, "Object Property") res += owlTypeInfo(term, owl.AnnotationProperty, "Annotation Property") res += owlTypeInfo(term, owl.InverseFunctionalProperty, "Inverse Functional Property") res += owlTypeInfo(term, owl.SymmetricProperty, "Symmetric Property") return res def docTerms(category, list, m, classlist, proplist, instalist): """ A wrapper class for listing all the terms in a specific class (either Properties, or Classes. Category is 'Property' or 'Class', list is a list of term names (strings), return value is a chunk of HTML. """ doc = "" nspre = spec_pre for item in list: t = termName(m, item) if (t.startswith(spec_ns_str)) and ( len(t[len(spec_ns_str):].split("/")) < 2): term = t t = t.split(spec_ns_str[-1])[1] curie = "%s:%s" % (nspre, t) else: if t.startswith("http://"): term = t curie = getShortName(t) t = getAnchor(t) else: term = spec_ns[t] curie = "%s:%s" % (nspre, t) term_uri = term doc += """
\n

%s %s

\n""" % (t, term_uri, category, getAnchor(str(term_uri)), curie) label = getLabel(m, term) comment = getComment(m, term, classlist, proplist, instalist) doc += '
' if label != '' or comment != '': doc += '
' if label != '': doc += "
%s
" % label if comment != '': doc += "
%s
" % comment if label != '' or comment != '': doc += "
" terminfo = "" if category == 'Property': terminfo += owlInfo(term, m) terminfo += rdfsPropertyInfo(term, m) if category == 'Class': terminfo += rdfsClassInfo(term, m) if category == 'Instance': terminfo += rdfsInstanceInfo(term, m) terminfo += extraInfo(term, m) if (len(terminfo) > 0): # to prevent empty list (bug #882) doc += '\n%s
\n' % terminfo doc += '
' doc += "\n
\n\n" return doc def getShortName(uri): uri = str(uri) if ("#" in uri): return uri.split("#")[-1] else: return uri.split("/")[-1] def getAnchor(uri): uri = str(uri) if (uri.startswith(spec_ns_str)): return uri[len(spec_ns_str):].replace("/", "_") else: return getShortName(uri) def buildIndex(m, classlist, proplist, instalist=None): """ Builds the A-Z list of terms. Args are a list of classes (strings) and a list of props (strings) """ if len(classlist) == 0 and len(proplist) == 0 and ( not instalist or len(instalist) == 0): return '' azlist = '
' if (len(classlist) > 0): azlist += "
Classes
    " classlist.sort() shown = {} for c in classlist: if c in shown: continue # Skip classes that are subclasses of classes defined in this spec local_subclass = False for p in findStatements(m, c, rdfs.subClassOf, None): parent = str(p[2]) if parent[0:len(spec_ns_str)] == spec_ns_str: local_subclass = True if local_subclass: continue shown[c] = True name = termName(m, c) if name.startswith(spec_ns_str): name = name.split(spec_ns_str[-1])[1] azlist += '
  • %s' % (name, name) def class_tree(c): tree = '' shown[c] = True subclasses = [] for s in findStatements(m, None, rdfs.subClassOf, c): subclasses += [getSubject(s)] subclasses.sort() for s in subclasses: s_name = termName(m, s) tree += '
  • %s\n' % (s_name, s_name) tree += class_tree(s) tree += '
  • ' if tree != '': tree = '
      ' + tree + '
    ' return tree azlist += class_tree(c) azlist += '' azlist += '
\n' if (len(proplist) > 0): azlist += "
Properties
" proplist.sort() props = [] for p in proplist: name = termName(m, p) if name.startswith(spec_ns_str): name = name.split(spec_ns_str[-1])[1] props += ['%s' % (name, name)] azlist += ', '.join(props) + '
\n' if (instalist != None and len(instalist) > 0): azlist += "
Instances
" instas = [] for i in instalist: p = getShortName(i) anchor = getAnchor(i) instas += ['%s' % (anchor, p)] azlist += ', '.join(instas) + '
\n' azlist += '\n
' return azlist def add(where, key, value): if not key in where: where[key] = [] if not value in where[key]: where[key].append(value) def specInformation(m, ns): """ Read through the spec (provided as a Redland model) and return classlist and proplist. Global variables classranges and classdomains are also filled as appropriate. """ global classranges global classdomains # Find the class information: Ranges, domains, and list of all names. classtypes = [rdfs.Class, owl.Class, rdfs.Datatype] classlist = [] for onetype in classtypes: for classStatement in findStatements(m, None, rdf.type, onetype): for range in findStatements(m, None, rdfs.range, getSubject(classStatement)): if not isBlank(getSubject(classStatement)): add(classranges, str(getSubject(classStatement)), str(getSubject(range))) for domain in findStatements(m, None, rdfs.domain, getSubject(classStatement)): if not isBlank(getSubject(classStatement)): add(classdomains, str(getSubject(classStatement)), str(getSubject(domain))) if not isBlank(getSubject(classStatement)): klass = getSubject(classStatement) if klass not in classlist and str(klass).startswith(ns): classlist.append(klass) # Create a list of properties in the schema. proptypes = [rdf.Property, owl.ObjectProperty, owl.DatatypeProperty, owl.AnnotationProperty] proplist = [] for onetype in proptypes: for propertyStatement in findStatements(m, None, rdf.type, onetype): prop = getSubject(propertyStatement) if prop not in proplist and str(prop).startswith(ns): proplist.append(prop) return classlist, proplist def specProperty(m, subject, predicate): "Return a property of the spec." for c in findStatements(m, subject, predicate, None): return getLiteralString(getObject(c)) return '' def specProperties(m, subject, predicate): "Return a property of the spec." properties = [] for c in findStatements(m, subject, predicate, None): properties += [getObject(c)] return properties def specAuthors(m, subject): "Return an HTML description of the authors of the spec." dev = set() for i in findStatements(m, subject, doap.developer, None): for j in findStatements(m, getObject(i), foaf.name, None): dev.add(getLiteralString(getObject(j))) maint = set() for i in findStatements(m, subject, doap.maintainer, None): for j in findStatements(m, getObject(i), foaf.name, None): maint.add(getLiteralString(getObject(j))) doc = '' devdoc = '' first = True for d in dev: if not first: devdoc += ', ' devdoc += '%s' % d first = False if len(dev) == 1: doc += 'Developer%s' % devdoc elif len(dev) > 0: doc += 'Developers%s' % devdoc maintdoc = '' first = True for m in maint: if not first: maintdoc += ', ' maintdoc += '%s' % m first = False if len(maint) == 1: doc += 'Maintainer%s' % maintdoc elif len(maint) > 0: doc += 'Maintainers%s' % maintdoc return doc def specHistory(m, subject): entries = {} for r in findStatements(m, subject, doap.release, None): release = getObject(r) revNode = findOne(m, release, doap.revision, None) if not revNode: print "error: doap:release has no doap:revision" continue rev = getLiteralString(getObject(revNode)) created = findOne(m, release, doap.created, None) dist = findOne(m, release, doap['file-release'], None) if dist: entry = '
Version %s' % (getObject(dist), rev) else: entry = '
Version %s' % rev #print "warning: doap:release has no doap:file-release" if created: entry += ' (%s)
' % getLiteralString(getObject(created)) else: entry += ' (EXPERIMENTAL)' changeset = findOne(m, release, dcs.changeset, None) if changeset: entry += '
    ' for i in findStatements(m, getObject(changeset), dcs.item, None): item = getObject(i) label = findOne(m, item, rdfs.label, None) if not label: print "error: dcs:item has no rdfs:label" continue entry += '
  • %s
  • ' % getLiteralString(getObject(label)) entry += '
\n' entries[rev] = entry if len(entries) > 0: history = '
' for e in sorted(entries.keys(), reverse=True): history += entries[e] history += '
' return history else: return '' def specVersion(m, subject): """ Return a (minorVersion, microVersion, date) tuple """ # Get the date from the latest doap release latest_doap_revision = "" latest_doap_release = None for i in findStatements(m, subject, doap.release, None): for j in findStatements(m, getObject(i), doap.revision, None): revision = getLiteralString(getObject(j)) if latest_doap_revision == "" or revision > latest_doap_revision: latest_doap_revision = revision latest_doap_release = getObject(i) date = "" if latest_doap_release != None: for i in findStatements(m, latest_doap_release, doap.created, None): date = getLiteralString(getObject(i)) # Get the LV2 version minor_version = 0 micro_version = 0 for i in findStatements(m, None, lv2.minorVersion, None): minor_version = int(getLiteralString(getObject(i))) for i in findStatements(m, None, lv2.microVersion, None): micro_version = int(getLiteralString(getObject(i))) return (minor_version, micro_version, date) def getInstances(model, classes, properties): """ Extract all resources instanced in the ontology (aka "everything that is not a class or a property") """ instances = [] for c in classes: for i in findStatements(model, None, rdf.type, c): if not isResource(getSubject(i)): continue inst = getSubject(i) if inst not in instances and str(inst) != spec_url: instances.append(inst) for i in findStatements(model, None, rdf.type, None): if ((not isResource(getSubject(i))) or (getSubject(i) in classes) or (getSubject(i) in instances) or (getSubject(i) in properties)): continue full_uri = str(getSubject(i)) if (full_uri.startswith(spec_ns_str)): instances.append(getSubject(i)) return instances def load_tags(path, docdir): "Build a (symbol => URI) map from a Doxygen tag file." def getChildText(elt, tagname): "Return the content of the first child node with a certain tag name." for e in elt.childNodes: if e.nodeType == xml.dom.Node.ELEMENT_NODE and e.tagName == tagname: return e.firstChild.nodeValue return '' def linkTo(sym, url): return '%s' % (docdir, url, sym) tagdoc = xml.dom.minidom.parse(path) root = tagdoc.documentElement linkmap = {} for cn in root.childNodes: if (cn.nodeType == xml.dom.Node.ELEMENT_NODE and cn.tagName == 'compound' and cn.getAttribute('kind') != 'page'): name = getChildText(cn, 'name') filename = getChildText(cn, 'filename') if not filename.endswith('.html'): filename += '.html' linkmap[name] = linkTo(name, filename) prefix = '' if cn.getAttribute('kind') != 'file': prefix = name + '::' members = cn.getElementsByTagName('member') for m in members: mname = prefix + getChildText(m, 'name') mafile = getChildText(m, 'anchorfile') manchor = getChildText(m, 'anchor') linkmap[mname] = linkTo( mname, '%s#%s' % (mafile, manchor)) return linkmap def specgen(specloc, indir, style_uri, docdir, tags, instances=False, mode="spec"): """The meat and potatoes: Everything starts here.""" global spec_url global spec_ns_str global spec_ns global spec_pre global ns_list global specgendir global linkmap specgendir = os.path.abspath(indir) # Template temploc = os.path.join(indir, "template.html") template = None f = open(temploc, "r") template = f.read() # Load code documentation link map from tags file linkmap = load_tags(tags, docdir) m = rdflib.ConjunctiveGraph() manifest_path = os.path.join(os.path.dirname(specloc), 'manifest.ttl') m.parse(manifest_path, format='n3') m.parse(specloc, format='n3') bundle_path = os.path.split(specloc[specloc.find(':') + 1:])[0] abs_bundle_path = os.path.abspath(bundle_path) spec_url = getOntologyNS(m) spec = rdflib.URIRef(spec_url) # Parse all seeAlso files in the bundle for uri in specProperties(m, spec, rdfs.seeAlso): if uri[:7] == 'file://': path = uri[7:] if (path != os.path.abspath(specloc) and path.endswith('.ttl')): m.parse(path, format='n3') spec_ns_str = spec_url if (spec_ns_str[-1] != "/" and spec_ns_str[-1] != "#"): spec_ns_str += "#" spec_ns = rdflib.Namespace(spec_ns_str) namespaces = getNamespaces(m) keys = namespaces.keys() keys.sort() prefixes_html = "" for i in keys: uri = namespaces[i] if uri.startswith('file:'): continue; ns_list[str(uri)] = i if str(uri) == spec_url + '#': spec_pre = i prefixes_html += '%s ' % (uri, i) prefixes_html += "" if spec_pre is None: print('No namespace prefix for %s defined' % specloc) sys.exit(1) ns_list[spec_ns_str] = spec_pre classlist, proplist = specInformation(m, spec_ns_str) classlist = sorted(classlist) proplist = sorted(proplist) instalist = None if instances: instalist = getInstances(m, classlist, proplist) instalist.sort(lambda x, y: cmp(getShortName(x).lower(), getShortName(y).lower())) azlist = buildIndex(m, classlist, proplist, instalist) # Generate Term HTML termlist = docTerms('Property', proplist, m, classlist, proplist, instalist) termlist = docTerms('Class', classlist, m, classlist, proplist, instalist) + termlist if instances: termlist += docTerms('Instance', instalist, m, classlist, proplist, instalist) template = template.replace('@NAME@', specProperty(m, spec, doap.name)) template = template.replace('@SUBTITLE@', specProperty(m, spec, doap.shortdesc)) template = template.replace('@URI@', spec) template = template.replace('@PREFIX@', spec_pre) if spec_pre == 'lv2': template = template.replace('@XMLNS@', '') else: template = template.replace('@XMLNS@', ' xmlns:%s="%s"' % (spec_pre, spec_ns_str)) filename = os.path.basename(specloc) basename = filename[0:filename.rfind('.')] template = template.replace('@STYLE_URI@', style_uri) template = template.replace('@PREFIXES@', str(prefixes_html)) template = template.replace('@BASE@', spec_ns_str) template = template.replace('@AUTHORS@', specAuthors(m, spec)) template = template.replace('@INDEX@', azlist) template = template.replace('@REFERENCE@', termlist.encode("utf-8")) template = template.replace('@FILENAME@', filename) template = template.replace('@HEADER@', basename + '.h') template = template.replace('@MAIL@', 'devel@lists.lv2plug.in') template = template.replace('@HISTORY@', specHistory(m, spec)) version = specVersion(m, spec) # (minor, micro, date) date_string = version[2] if date_string == "": date_string = "Undated" version_string = "%s.%s (%s)" % (version[0], version[1], date_string) experimental = (version[0] == 0 or version[1] % 2 == 1) if experimental: version_string += ' EXPERIMENTAL' deprecated = findOne(m, rdflib.URIRef(spec_url), owl.deprecated, None) if deprecated and str(deprecated[2]).find("true") > 0: version_string += ' DEPRECATED' template = template.replace('@REVISION@', version_string) header_files = '' other_files = '' see_also_files = specProperties(m, spec, rdfs.seeAlso) see_also_files.sort() for f in see_also_files: uri = str(f) if uri[:7] == 'file://': uri = uri[7:] if uri[:len(abs_bundle_path)] == abs_bundle_path: uri = uri[len(abs_bundle_path) + 1:] else: continue # Skip seeAlso file outside bundle entry = '%s' % (uri, uri) if uri.endswith('.h') or uri.endswith('.hpp'): name = os.path.basename(uri) entry += ' (Documentation) ' % ( docdir + '/' + name.replace('.', '_8') + '.html') header_files += '
  • %s
  • ' % entry else: other_files += '
  • %s
  • ' % entry files = '' if header_files: files += '
  • API
      %s
  • ' % header_files if other_files: files += '
  • Data
      %s
  • ' % other_files template = template.replace('@FILES@', files) comment = getComment(m, rdflib.URIRef(spec_url), classlist, proplist, instalist) if comment != '': template = template.replace('@COMMENT@', comment) else: template = template.replace('@COMMENT@', '') template = template.replace('@TIME@', datetime.datetime.utcnow().strftime('%F %H:%M UTC')) return template def save(path, text): try: f = open(path, "w") f.write(text) f.flush() f.close() except Exception: e = sys.exc_info()[1] print('Error writing to file "' + path + '": ' + str(e)) def getNamespaces(m): """Return a prefix:URI dictionary of all namespaces seen during parsing""" nspaces = {} for prefix, uri in m.namespaces(): if not re.match('default[0-9]*', prefix) and not prefix == 'xml': # Skip silly default namespaces added by rdflib nspaces[prefix] = uri return nspaces def getOntologyNS(m): ns = None s = findOne(m, None, rdf.type, lv2.Specification) if not s: s = findOne(m, None, rdf.type, owl.Ontology) if s: if not isBlank(getSubject(s)): ns = str(getSubject(s)) if (ns == None): sys.exit("Impossible to get ontology's namespace") else: return ns def usage(): script = os.path.basename(sys.argv[0]) print("""Usage: %s ONTOLOGY INDIR STYLE OUTPUT DOCDIR TAGS [FLAGS] ONTOLOGY : Path to ontology file INDIR : Input directory containing template.html and style.css STYLE : Stylesheet URI OUTPUT : HTML output path DOCDIR : Doxygen HTML directory TAGS : Doxygen tags file Optional flags: -i : Document class/property instances (disabled by default) -p PREFIX : Set ontology namespace prefix from command line Example: %s lv2_foos.ttl template.html style.css lv2_foos.html ../doc -i -p foos """ % (script, script)) sys.exit(-1) if __name__ == "__main__": """Ontology specification generator tool""" args = sys.argv[1:] if (len(args) < 3): usage() else: ontology = "file:" + str(args[0]) indir = args[1] style = args[2] output = args[3] docdir = args[4] tags = args[5] # Flags instances = False if len(args) > 7: flags = args[7:] i = 0 while i < len(flags): if flags[i] == '-i': instances = True elif flags[i] == '-p': spec_pre = flags[i + 1] i += 1 i += 1 try: save(output, specgen(specloc, indir, style, docdir, tags, instances=instances)) except: e = sys.exc_info()[1] print('error: ' + str(e)) sys.exit(1) sys.exit(0)