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