#!/usr/bin/python -u # # Indexes the examples and build an XML description # import string import glob import sys try: import libxml2 except: sys.exit(1) sys.path.insert(0, "..") from apibuild import CParser, escape examples = [] extras = ['examples.xsl', 'index.py'] tests = [] sections = {} symbols = {} api_dict = None api_doc = None def load_api(): global api_dict global api_doc if api_dict != None: return api_dict = {} try: print "loading ../libvirt-api.xml" api_doc = libxml2.parseFile("../libvirt-api.xml") except: print "failed to parse ../libvirt-api.xml" sys.exit(1) def find_symbol(name): global api_dict global api_doc if api_doc == None: load_api() if name == None: return if api_dict.has_key(name): return api_dict[name] ctxt = api_doc.xpathNewContext() res = ctxt.xpathEval("/api/symbols/*[@name = '%s']" % (name)) if type(res) == type([]) and len(res) >= 1: if len(res) > 1: print "Found %d references to %s in the API" % (len(res), name) node = res[0] typ = node.name file = node.xpathEval("string(@file)") info = node.xpathEval("string(info)") else: print "Reference %s not found in the API" % (name) return None ret = (typ, file, info) api_dict[name] = ret return ret def parse_top_comment(filename, comment): res = {} lines = string.split(comment, "\n") item = None for line in lines: while line != "" and (line[0] == ' ' or line[0] == '\t'): line = line[1:] while line != "" and line[0] == '*': line = line[1:] while line != "" and (line[0] == ' ' or line[0] == '\t'): line = line[1:] try: (it, line) = string.split(line, ":", 1) item = it while line != "" and (line[0] == ' ' or line[0] == '\t'): line = line[1:] if res.has_key(item): res[item] = res[item] + " " + line else: res[item] = line except: if item != None: if res.has_key(item): res[item] = res[item] + " " + line else: res[item] = line return res def parse(filename, output): global symbols global sections parser = CParser(filename) parser.collect_references() idx = parser.parse() info = parse_top_comment(filename, parser.top_comment) output.write(" \n" % filename) try: synopsis = info['synopsis'] output.write(" %s\n" % escape(synopsis)); except: print "Example %s lacks a synopsis description" % (filename) try: purpose = info['purpose'] output.write(" %s\n" % escape(purpose)); except: print "Example %s lacks a purpose description" % (filename) try: usage = info['usage'] output.write(" %s\n" % escape(usage)); except: print "Example %s lacks an usage description" % (filename) try: test = info['test'] output.write(" %s\n" % escape(test)); progname=filename[0:-2] command=string.replace(test, progname, './' + progname, 1) tests.append(command) except: pass try: author = info['author'] output.write(" %s\n" % escape(author)); except: print "Example %s lacks an author description" % (filename) try: copy = info['copy'] output.write(" %s\n" % escape(copy)); except: print "Example %s lacks a copyright description" % (filename) try: section = info['section'] output.write("
%s
\n" % escape(section)); if sections.has_key(section): sections[section].append(filename) else: sections[section] = [filename] except: print "Example %s lacks a section description" % (filename) for topic in info.keys(): if topic != "purpose" and topic != "usage" and \ topic != "author" and topic != "copy" and \ topic != "section" and topic != "synopsis" and topic != "test": str = info[topic] output.write(" %s\n" % ( escape(topic), escape(str))) output.write(" \n") for include in idx.includes.keys(): if include.find("libxml") != -1: output.write(" %s\n" % (escape(include))) output.write(" \n") output.write(" \n") for ref in idx.references.keys(): id = idx.references[ref] name = id.get_name() line = id.get_lineno() if symbols.has_key(name): sinfo = symbols[name] refs = sinfo[0] # gather at most 5 references per symbols if refs > 5: continue sinfo.append(filename) sinfo[0] = refs + 1 else: symbols[name] = [1, filename] info = find_symbol(name) if info != None: type = info[0] file = info[1] output.write(" <%s line='%d' file='%s' name='%s'/>\n" % (type, line, file, name)) else: type = id.get_type() output.write(" <%s line='%d' name='%s'/>\n" % (type, line, name)) output.write(" \n") output.write("
\n") return idx def dump_symbols(output): global symbols output.write(" \n") keys = symbols.keys() keys.sort() for symbol in keys: output.write(" \n" % (symbol)) info = symbols[symbol] i = 1 while i < len(info): output.write(" \n" % (info[i])) i = i + 1 output.write(" \n") output.write(" \n") def dump_sections(output): global sections output.write(" \n") keys = sections.keys() keys.sort() for section in keys: output.write("
\n" % (section)) info = sections[section] i = 0 while i < len(info): output.write(" \n" % (info[i])) i = i + 1 output.write("
\n") output.write("
\n") def dump_Makefile(): for file in glob.glob('*.xml'): extras.append(file) for file in glob.glob('*.res'): extras.append(file) Makefile="""# -*- buffer-read-only: t -*- vi: set ro: # Beware this is autogenerated by index.py SUBDIRS=python INCLUDES = -I$(top_builddir)/include -I$(top_srcdir)/include -I@srcdir@/include DEPS = $(top_builddir)/src/libvirt.la LDADDS = @STATIC_BINARIES@ $(WARN_CFLAGS) $(top_builddir)/src/libvirt.la \ $(COVERAGE_LDFLAGS) rebuild: examples.xml index.html examples.xml: index.py __C_SOURCES__ -@($(srcdir)/index.py) index.html: examples.xml examples.xsl $(top_srcdir)/docs/site.xsl -@(if [ -x $(XSLTPROC) ] ; then \\ $(XSLTPROC) examples.xsl examples.xml \\ && echo "Rebuilt web page" \\ && xmllint --valid --noout index.html; \\ fi) install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) -@INSTALL@ -m 0644 $(srcdir)/*.html $(srcdir)/*.c $(srcdir)/*.xml \\ $(srcdir)/*.xsl $(srcdir)/*.res $(DESTDIR)$(HTML_DIR) """ EXTRA_DIST= string.join(extras, ' ') Makefile = Makefile + "EXTRA_DIST=%s\n\n" % (EXTRA_DIST) noinst_PROGRAMS= string.join(examples, ' ') Makefile = Makefile + "noinst_PROGRAMS=%s\n\n" % (noinst_PROGRAMS) for example in examples: Makefile = Makefile + "%s_SOURCES=%s.c\n%s_LDFLAGS=\n%s_DEPENDENCIES= $(DEPS)\n%s_LDADD= $(LDADDS)\n\n" % (example, example, example, example, example) Makefile = Makefile + "valgrind:\n\t$(MAKE) CHECKER='valgrind' tests\n\n" Makefile = Makefile + "tests: $(noinst_PROGRAMS)\n" Makefile = Makefile + "\t@(echo '## examples regression tests')\n" # Makefile = Makefile + "\t@(echo > .memdump)\n" for test in tests: Makefile = Makefile + "\t@($(CHECKER) %s)\n" % (test) # Makefile = Makefile + '\t@(grep "MORY ALLO" .memdump | grep -v "MEMORY ALLOCATED : 0" ; exit 0)\n' c_src = [("%s.c" % x) for x in examples] Makefile = Makefile.replace("__C_SOURCES__", string.join(c_src, ' ')) try: old = open("Makefile.am", "r").read() if old != Makefile: n = open("Makefile.am", "w").write(Makefile) print "Updated Makefile.am" except: print "Failed to read or save Makefile.am" # # Autogenerate the .cvsignore too ... # ignore = """.memdump Makefile.in Makefile .deps .libs """ for example in examples: ignore = ignore + "%s\n" % (example) try: old = open(".cvsignore", "r").read() if old != ignore: n = open(".cvsignore", "w").write(ignore) print "Updated .cvsignore" except: print "Failed to read or save .cvsignore" if __name__ == "__main__": load_api() output = open("examples.xml", "w") output.write("\n") c_src = glob.glob('*.c') c_src.sort() for file in c_src: parse(file, output) examples.append(file[:-2]) dump_symbols(output) dump_sections(output) output.write("\n") output.close() dump_Makefile()