[gtk-doc] rebase: split into wrapper and module
- From: Stefan Sauer <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] rebase: split into wrapper and module
- Date: Mon, 3 Apr 2017 19:09:33 +0000 (UTC)
commit e65228a1bc7539c7dd89d502defd5afded72aad9
Author: Stefan Sauer <ensonic users sf net>
Date: Mon Apr 3 20:56:59 2017 +0200
rebase: split into wrapper and module
Makefile.am | 6 +-
gtkdoc-rebase.in | 259 +++-----------------------------------------------
gtkdoc/config.py.in | 3 +-
gtkdoc/rebase.py | 258 ++++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 280 insertions(+), 246 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index f7f16fc..9f071f2 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -42,7 +42,8 @@ pylibdata_DATA = \
gtkdoc/config.py \
gtkdoc/mkhtml.py \
gtkdoc/mkman.py \
- gtkdoc/mkpdf.py
+ gtkdoc/mkpdf.py \
+ gtkdoc/rebase.py
pkgconfigdir = $(datadir)/pkgconfig
pkgconfig_DATA = gtk-doc.pc
@@ -86,7 +87,8 @@ CLEANFILES = \
gtkdoc/config.pyc \
gtkdoc/mkhtml.pyc \
gtkdoc/mkman.pyc \
- gtkdoc/mkpdf.pyc
+ gtkdoc/mkpdf.pyc \
+ gtkdoc/rebase.pyc
DISTCLEANFILES = \
gtkdoc-check \
diff --git a/gtkdoc-rebase.in b/gtkdoc-rebase.in
index 1ce662f..3b703f5 100755
--- a/gtkdoc-rebase.in
+++ b/gtkdoc-rebase.in
@@ -21,252 +21,25 @@
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
-#############################################################################
-# Script : gtkdoc-rebase
-# Description : Rebases URI references in installed HTML documentation.
-#############################################################################
+import argparse, sys
+sys.path.append('@PYTHON_PACKAGE_DIR@')
-from __future__ import print_function
+from gtkdoc import config, rebase
-import os, sys, argparse, subprocess, re
-# Maps.
-# These two point to the last seen URI of given type for a package:
-# OnlineMap: package => on-line URI
-# LocalMap: package => local URI
-# This maps all seen URIs of a package to fix broken links in the process:
-# RevMap: URI => package
-OnLineMap = {}
-LocalMap = {}
-RevMap = {}
-# Remember what mangling we did.
-Mapped = {}
-
-
-parser = argparse.ArgumentParser()
-
-parser.add_argument('--version', action='version', version='@VERSION@')
-parser.add_argument('--html-dir', dest='html_dir', default='')
-parser.add_argument('--other-dir', dest='other_dir', default=[], action='append')
-parser.add_argument('--dest-dir', dest='dest_dir', default='')
-parser.add_argument('--aggressive', action='store_true', default=False)
-parser.add_argument('--verbose', action='store_true', default=False)
-group = parser.add_mutually_exclusive_group()
-group.add_argument('--online', action='store_true', default=False)
-group.add_argument('--relative', action='store_true', default=False)
-
-def log(options, *msg):
- if options.verbose:
- print(*msg)
+if __name__== '__main__':
+ parser = argparse.ArgumentParser(
+ description='gtkdoc-rebase version %s - rewrite links in html docs' % config.version)
+ parser.add_argument('--version', action='version', version='config.version')
+ parser.add_argument('--html-dir', dest='html_dir', default='')
+ parser.add_argument('--other-dir', dest='other_dir', default=[], action='append')
+ parser.add_argument('--dest-dir', dest='dest_dir', default='')
+ parser.add_argument('--aggressive', action='store_true', default=False)
+ parser.add_argument('--verbose', action='store_true', default=False)
+ group = parser.add_mutually_exclusive_group()
+ group.add_argument('--online', action='store_true', default=False)
+ group.add_argument('--relative', action='store_true', default=False)
-def Run():
options = parser.parse_args()
- other_dirs = []
-
- if (options.html_dir == ''):
- sys.exit("No HTML directory (--html-dir) given.")
-
- # We scan the directory containing GLib and any directories in GNOME2_PATH
- # first, but these will be overriden by any later scans.
- if "GNOME2_PATH" in os.environ:
- for dir in os.environ["GNOME2_PATH"].split(':'):
- dir = os.path.join(dir, "/share/gtk-doc/html")
- if os.path.isdir(dir):
- log(options, "Prepending GNOME2_PATH directory:", dir)
- other_dirs = [dir] + other_dirs
-
- dir = subprocess.check_output(['@PKG_CONFIG@', '--variable=prefix', 'glib-2.0'], universal_newlines=True)
- dir = dir.strip()
- dir = os.path.join(dir, "/share/gtk-doc/html")
- log(options, "Prepending GLib directory", dir)
- other_dirs = [dir] + other_dirs
-
- # Check all other dirs, but skip already scanned dirs ord subdirs of those
-
- for dir in other_dirs:
- ScanDirectory(dir, options);
-
- if options.relative:
- RelativizeLocalMap(options.html_dir, options);
-
- RebaseReferences(options.html_dir, options)
- PrintWhatWeHaveDone()
-
-
-def ScanDirectory(dir, options):
- # This array holds any subdirectories found.
- subdirs = []
- onlinedir = None
-
- log(options, "Scanning documentation directory " + dir)
-
- if dir == options.html_dir:
- log(options, "Excluding self")
- return
-
- if not os.path.isdir(dir):
- print('Cannot open dir "%s"' % dir)
- return
-
- have_index = False
- for entry in os.listdir(dir):
- if os.path.isdir(entry):
- subdirs.push_back(entry)
- continue
-
- if entry.endswith('.devhelp2'):
- log(options, "Reading index from " + entry)
- o = ReadDevhelp(dir, entry);
- # Prefer this location over possibly stale index.sgml
- if o is not None:
- onlinedir = o
- have_index = True
-
- if onlinedir and entry == "index.sgml":
- log(options, "Reading index from index.sgml")
- onlinedir = ReadIndex(dir, entry);
- have_index = True
- elif entry == "index.sgml.gz" and not os.path.exists(os.path.join(dir, 'index.sgml')):
- # debian/ubuntu started to compress this as index.sgml.gz :/
- print(''' Please fix https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138 . For now run:
-gunzip %s/%s
-''' % (dir, entry))
- elif entry.endswith('.devhelp2.gz') and not os.path.exists(os.path.join(dir, entry, 'devhelp2')):
- # debian/ubuntu started to compress this as *devhelp2.gz :/
- print('''Please fix https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/1466210 . For now run:
-gunzip %d/%s
-''' % (dir, entry))
- # we could consider supporting: gzip module
-
- if have_index:
- AddMap(dir, onlinedir);
-
- # Now recursively scan the subdirectories.
- for subdir in subdirs:
- ScanDirectory(os.path.join(dir, subdir), options);
-
-
-def ReadDevhelp(dir, file):
- onlinedir = None
-
- for line in open(os.path.join(dir, file)):
- # online must come before chapter/functions
- if '<chapters' in line or '<functions' in line:
- break
- match = re.search(r' online="([^"]*)"/')
- if match:
- # Remove trailing non-directory component.
- onlinedir = re.sub(r'(.*/).*', r'\1', match.groups(1))
- return onlinedir
-
-
-def ReadIndex(dir, file):
- onlinedir = None
-
- for line in open(os.path.join(dir, file)):
- # ONLINE must come before any ANCHORs
- if '<ANCHOR' in line:
- break
- match = re.match(r'''^<ONLINE\s+href\s*=\s*"([^"]+)"\s*>''', line)
- if match:
- # Remove trailing non-directory component.
- onlinedir = re.sub(r'''(.*/).*''', r'\1', match.groups(1))
- return onlinedir
-
-
-def AddMap(dir, onlinerdir, options):
- package = None
-
- package = os.path.split(dir)[1]
- if options.dest_dir != '' and dir.startswith(options.dest_dir):
- dir = dir[len(options.dest_dir)-1:]
-
- if onlinedir:
- log(options, "On-line location of %s." % onlinedir)
- OnlineMap[package] = onlinedir;
- RevMap[onlinedir] = package;
- else:
- log(options, "No On-line location for %s found" % package)
-
- log(options, "Local location of $package: " + dir)
- LocalMap[package] = dir;
- RevMap[dir] = package;
-
-
-def RelativizeLocalMap(dirname, options):
- prefix = None
- dir = None
-
- dirname = os.path.realpath(dirname)
- prefix = os.path.split(dirname)
- for package, dir in LocalMap.items():
- if dir.startswith(prefix):
- dir = os.path.join("..", dir[len(prefix):])
- LocalMap[package] = dir
- log(options, "Relativizing local location of $package to " + dir)
-
-def RebaseReferences(dirname, options):
- for ifile in os.listdir(dirname):
- if ifile.endswith('.html'):
- RebaseFile(os.path.join(dirname, ifile), options)
-
-
-def RebaseFile(filename, options):
- log(options, "Fixing file: " + filename)
- regex = re.compile(r'''(<a(?:\s+\w+=(?:"[^"]*"|'[^']*'))*\s+href=")([^"]*)(")''',
- flags=re.MULTILINE)
-
- def repl_func(match):
- return match.group(1) + RebaseLink(match.group(2), options) + match.group(3)
-
- contents = open(filename).read()
- processed = re.sub(regex, repl_func, contents)
- newfilename = filename + '.new'
- open(newfilename, 'w').write(processed)
- os.unlink(filename)
- os.rename(newfilename, filename)
-
-
-def RebaseLink(href, options):
- match = re.match(r'^(.*/)([^/]*)$', href)
- package = None
- origdir = 'INVALID'
-
- if match:
- dir = origdir = match.group(1)
- file = match.group(2)
- if dir in RevMap:
- package = RevMap[dir]
- else:
- match = re.match(r'\.\./([^/]+)', href)
- if match is not None:
- package = match.groups(1)
- elif options.aggressive:
- match = re.search(r'''([^/]+)/$''', href)
- package = match.groups(1);
-
- if package:
- if options.online and package in OnlineMap:
- dir = OnlineMap[package]
- elif package in LocalMap:
- dir = LocalMap[package]
- href = os.path.join(dir, file)
- else:
- log(options, "Can't determine package for '%s'" % href);
-
- if dir != origdir:
- if origdir in Mapped:
- Mapped[origdir][1] += 1
- else:
- Mapped[origdir] = [dir, 1]
- return href
-
-
-def PrintWhatWeHaveDone():
- for origdir in sorted(Mapped.keys()):
- info = Mapped[origdir]
- print(origdir, "->", info[0], "(%s)" % info[1])
-
-if __name__== '__main__':
- Run()
+ sys.exit(rebase.run(options))
diff --git a/gtkdoc/config.py.in b/gtkdoc/config.py.in
index 08dc7ec..5ef5fdd 100644
--- a/gtkdoc/config.py.in
+++ b/gtkdoc/config.py.in
@@ -1,9 +1,10 @@
version = "@VERSION@"
# tools
-xsltproc = '@XSLTPROC@'
dblatex = '@DBLATEX@'
fop = '@FOP@'
+pkg_config = '@PKG_CONFIG@'
+xsltproc = '@XSLTPROC@'
# configured directories
prefix='@prefix@'
diff --git a/gtkdoc/rebase.py b/gtkdoc/rebase.py
new file mode 100755
index 0000000..eaf9d02
--- /dev/null
+++ b/gtkdoc/rebase.py
@@ -0,0 +1,258 @@
+#!@PYTHON@
+# -*- python -*-
+#
+# gtk-doc - GTK DocBook documentation generator.
+# Copyright (C) 1998 Damon Chaplin
+# 2007 David Necas (Yeti)
+# 2007-2016 Stefan Sauer
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+
+#############################################################################
+# Script : gtkdoc-rebase
+# Description : Rebases URI references in installed HTML documentation.
+#############################################################################
+
+from __future__ import print_function
+
+import os, sys, argparse, subprocess, re
+
+from . import config
+
+# Maps.
+# These two point to the last seen URI of given type for a package:
+# OnlineMap: package => on-line URI
+# LocalMap: package => local URI
+# This maps all seen URIs of a package to fix broken links in the process:
+# RevMap: URI => package
+OnLineMap = {}
+LocalMap = {}
+RevMap = {}
+# Remember what mangling we did.
+Mapped = {}
+
+
+def log(options, *msg):
+ if options.verbose:
+ print(*msg)
+
+
+def Run(options):
+ other_dirs = []
+
+ if (options.html_dir == ''):
+ sys.exit("No HTML directory (--html-dir) given.")
+
+ # We scan the directory containing GLib and any directories in GNOME2_PATH
+ # first, but these will be overriden by any later scans.
+ if "GNOME2_PATH" in os.environ:
+ for dir in os.environ["GNOME2_PATH"].split(':'):
+ dir = os.path.join(dir, "/share/gtk-doc/html")
+ if os.path.isdir(dir):
+ log(options, "Prepending GNOME2_PATH directory:", dir)
+ other_dirs = [dir] + other_dirs
+
+ dir = subprocess.check_output([config.pkg_config, '--variable=prefix', 'glib-2.0'],
universal_newlines=True)
+ dir = dir.strip()
+ dir = os.path.join(dir, "/share/gtk-doc/html")
+ log(options, "Prepending GLib directory", dir)
+ other_dirs = [dir] + other_dirs
+
+ # Check all other dirs, but skip already scanned dirs ord subdirs of those
+
+ for dir in other_dirs:
+ ScanDirectory(dir, options);
+
+ if options.relative:
+ RelativizeLocalMap(options.html_dir, options);
+
+ RebaseReferences(options.html_dir, options)
+ PrintWhatWeHaveDone()
+
+
+def ScanDirectory(dir, options):
+ # This array holds any subdirectories found.
+ subdirs = []
+ onlinedir = None
+
+ log(options, "Scanning documentation directory " + dir)
+
+ if dir == options.html_dir:
+ log(options, "Excluding self")
+ return
+
+ if not os.path.isdir(dir):
+ print('Cannot open dir "%s"' % dir)
+ return
+
+ have_index = False
+ for entry in os.listdir(dir):
+ if os.path.isdir(entry):
+ subdirs.push_back(entry)
+ continue
+
+ if entry.endswith('.devhelp2'):
+ log(options, "Reading index from " + entry)
+ o = ReadDevhelp(dir, entry);
+ # Prefer this location over possibly stale index.sgml
+ if o is not None:
+ onlinedir = o
+ have_index = True
+
+ if onlinedir and entry == "index.sgml":
+ log(options, "Reading index from index.sgml")
+ onlinedir = ReadIndex(dir, entry);
+ have_index = True
+ elif entry == "index.sgml.gz" and not os.path.exists(os.path.join(dir, 'index.sgml')):
+ # debian/ubuntu started to compress this as index.sgml.gz :/
+ print(''' Please fix https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138 . For now run:
+gunzip %s/%s
+''' % (dir, entry))
+ elif entry.endswith('.devhelp2.gz') and not os.path.exists(os.path.join(dir, entry, 'devhelp2')):
+ # debian/ubuntu started to compress this as *devhelp2.gz :/
+ print('''Please fix https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/1466210 . For now run:
+gunzip %d/%s
+''' % (dir, entry))
+ # we could consider supporting: gzip module
+
+ if have_index:
+ AddMap(dir, onlinedir);
+
+ # Now recursively scan the subdirectories.
+ for subdir in subdirs:
+ ScanDirectory(os.path.join(dir, subdir), options);
+
+
+def ReadDevhelp(dir, file):
+ onlinedir = None
+
+ for line in open(os.path.join(dir, file)):
+ # online must come before chapter/functions
+ if '<chapters' in line or '<functions' in line:
+ break
+ match = re.search(r' online="([^"]*)"/')
+ if match:
+ # Remove trailing non-directory component.
+ onlinedir = re.sub(r'(.*/).*', r'\1', match.groups(1))
+ return onlinedir
+
+
+def ReadIndex(dir, file):
+ onlinedir = None
+
+ for line in open(os.path.join(dir, file)):
+ # ONLINE must come before any ANCHORs
+ if '<ANCHOR' in line:
+ break
+ match = re.match(r'''^<ONLINE\s+href\s*=\s*"([^"]+)"\s*>''', line)
+ if match:
+ # Remove trailing non-directory component.
+ onlinedir = re.sub(r'''(.*/).*''', r'\1', match.groups(1))
+ return onlinedir
+
+
+def AddMap(dir, onlinerdir, options):
+ package = None
+
+ package = os.path.split(dir)[1]
+ if options.dest_dir != '' and dir.startswith(options.dest_dir):
+ dir = dir[len(options.dest_dir)-1:]
+
+ if onlinedir:
+ log(options, "On-line location of %s." % onlinedir)
+ OnlineMap[package] = onlinedir;
+ RevMap[onlinedir] = package;
+ else:
+ log(options, "No On-line location for %s found" % package)
+
+ log(options, "Local location of $package: " + dir)
+ LocalMap[package] = dir;
+ RevMap[dir] = package;
+
+
+def RelativizeLocalMap(dirname, options):
+ prefix = None
+ dir = None
+
+ dirname = os.path.realpath(dirname)
+ prefix = os.path.split(dirname)
+ for package, dir in LocalMap.items():
+ if dir.startswith(prefix):
+ dir = os.path.join("..", dir[len(prefix):])
+ LocalMap[package] = dir
+ log(options, "Relativizing local location of $package to " + dir)
+
+def RebaseReferences(dirname, options):
+ for ifile in os.listdir(dirname):
+ if ifile.endswith('.html'):
+ RebaseFile(os.path.join(dirname, ifile), options)
+
+
+def RebaseFile(filename, options):
+ log(options, "Fixing file: " + filename)
+ regex = re.compile(r'''(<a(?:\s+\w+=(?:"[^"]*"|'[^']*'))*\s+href=")([^"]*)(")''',
+ flags=re.MULTILINE)
+
+ def repl_func(match):
+ return match.group(1) + RebaseLink(match.group(2), options) + match.group(3)
+
+ contents = open(filename).read()
+ processed = re.sub(regex, repl_func, contents)
+ newfilename = filename + '.new'
+ open(newfilename, 'w').write(processed)
+ os.unlink(filename)
+ os.rename(newfilename, filename)
+
+
+def RebaseLink(href, options):
+ match = re.match(r'^(.*/)([^/]*)$', href)
+ package = None
+ origdir = 'INVALID'
+
+ if match:
+ dir = origdir = match.group(1)
+ file = match.group(2)
+ if dir in RevMap:
+ package = RevMap[dir]
+ else:
+ match = re.match(r'\.\./([^/]+)', href)
+ if match is not None:
+ package = match.groups(1)
+ elif options.aggressive:
+ match = re.search(r'''([^/]+)/$''', href)
+ package = match.groups(1);
+
+ if package:
+ if options.online and package in OnlineMap:
+ dir = OnlineMap[package]
+ elif package in LocalMap:
+ dir = LocalMap[package]
+ href = os.path.join(dir, file)
+ else:
+ log(options, "Can't determine package for '%s'" % href);
+
+ if dir != origdir:
+ if origdir in Mapped:
+ Mapped[origdir][1] += 1
+ else:
+ Mapped[origdir] = [dir, 1]
+ return href
+
+
+def PrintWhatWeHaveDone():
+ for origdir in sorted(Mapped.keys()):
+ info = Mapped[origdir]
+ print(origdir, "->", info[0], "(%s)" % info[1])
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
