Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python |
| 2 | # -*- Python -*- |
| 3 | """usage: %(program)s [options...] file ... |
| 4 | |
| 5 | Options specifying formats to build: |
Fred Drake | 5599441 | 2001-01-30 22:30:01 +0000 | [diff] [blame] | 6 | --html HyperText Markup Language (default) |
| 7 | --pdf Portable Document Format |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 8 | --ps PostScript |
| 9 | --dvi 'DeVice Indepentent' format from TeX |
| 10 | --text ASCII text (requires lynx) |
| 11 | |
| 12 | More than one output format may be specified, or --all. |
| 13 | |
| 14 | HTML options: |
| 15 | --address, -a Specify an address for page footers. |
| 16 | --link Specify the number of levels to include on each page. |
| 17 | --split, -s Specify a section level for page splitting, default: %(max_split_depth)s. |
| 18 | --iconserver, -i Specify location of icons (default: ../). |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 19 | --image-type Specify the image type to use in HTML output; |
| 20 | values: gif (default), png. |
Fred Drake | 9a257b4 | 2000-03-31 20:27:36 +0000 | [diff] [blame] | 21 | --numeric Don't rename the HTML files; just keep node#.html for |
| 22 | the filenames. |
Fred Drake | fcb8725 | 2000-08-29 18:15:05 +0000 | [diff] [blame] | 23 | --style Specify the CSS file to use for the output (filename, |
| 24 | not a URL). |
Fred Drake | dfa539d | 2000-08-31 06:58:34 +0000 | [diff] [blame] | 25 | --up-link URL to a parent document. |
| 26 | --up-title Title of a parent document. |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 27 | |
| 28 | Other options: |
| 29 | --a4 Format for A4 paper. |
| 30 | --letter Format for US letter paper (the default). |
| 31 | --help, -H Show this text. |
| 32 | --logging, -l Log stdout and stderr to a file (*.how). |
| 33 | --debugging, -D Echo commands as they are executed. |
| 34 | --keep, -k Keep temporary files around. |
| 35 | --quiet, -q Do not print command output to stdout. |
| 36 | (stderr is also lost, sorry; see *.how for errors) |
| 37 | """ |
| 38 | |
| 39 | import getopt |
| 40 | import glob |
| 41 | import os |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 42 | import re |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 43 | import shutil |
| 44 | import string |
| 45 | import sys |
| 46 | import tempfile |
| 47 | |
| 48 | |
Fred Drake | 964c074 | 2001-05-29 16:10:07 +0000 | [diff] [blame] | 49 | if not hasattr(os.path, "abspath"): |
Fred Drake | bfd80dd | 2001-06-23 03:06:01 +0000 | [diff] [blame] | 50 | # Python 1.5.1 or earlier |
Fred Drake | 964c074 | 2001-05-29 16:10:07 +0000 | [diff] [blame] | 51 | def abspath(path): |
| 52 | """Return an absolute path.""" |
| 53 | if not os.path.isabs(path): |
| 54 | path = os.path.join(os.getcwd(), path) |
| 55 | return os.path.normpath(path) |
| 56 | |
| 57 | os.path.abspath = abspath |
| 58 | |
| 59 | |
Fred Drake | fcb8725 | 2000-08-29 18:15:05 +0000 | [diff] [blame] | 60 | MYDIR = os.path.abspath(sys.path[0]) |
| 61 | TOPDIR = os.path.dirname(MYDIR) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 62 | |
| 63 | ISTFILE = os.path.join(TOPDIR, "texinputs", "python.ist") |
| 64 | NODE2LABEL_SCRIPT = os.path.join(MYDIR, "node2label.pl") |
| 65 | L2H_INIT_FILE = os.path.join(TOPDIR, "perl", "l2hinit.perl") |
| 66 | |
| 67 | BIBTEX_BINARY = "bibtex" |
| 68 | DVIPS_BINARY = "dvips" |
| 69 | LATEX_BINARY = "latex" |
| 70 | LATEX2HTML_BINARY = "latex2html" |
| 71 | LYNX_BINARY = "lynx" |
| 72 | MAKEINDEX_BINARY = "makeindex" |
| 73 | PDFLATEX_BINARY = "pdflatex" |
| 74 | PERL_BINARY = "perl" |
| 75 | PYTHON_BINARY = "python" |
| 76 | |
| 77 | |
| 78 | def usage(options): |
| 79 | print __doc__ % options |
| 80 | |
| 81 | def error(options, message, err=2): |
| 82 | sys.stdout = sys.stderr |
| 83 | print message |
| 84 | print |
| 85 | usage(options) |
| 86 | sys.exit(2) |
| 87 | |
| 88 | |
| 89 | class Options: |
| 90 | program = os.path.basename(sys.argv[0]) |
| 91 | # |
| 92 | address = '' |
Fred Drake | 50d1fcf | 2001-02-19 19:18:09 +0000 | [diff] [blame] | 93 | builddir = None |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 94 | debugging = 0 |
| 95 | discard_temps = 1 |
| 96 | have_temps = 0 |
| 97 | icon_server = None |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 98 | image_type = "gif" |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 99 | logging = 0 |
| 100 | max_link_depth = 3 |
| 101 | max_split_depth = 6 |
| 102 | paper = "letter" |
| 103 | quiet = 0 |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 104 | runs = 0 |
Fred Drake | 9a257b4 | 2000-03-31 20:27:36 +0000 | [diff] [blame] | 105 | numeric = 0 |
Fred Drake | 42181db | 2001-01-09 22:02:10 +0000 | [diff] [blame] | 106 | global_module_index = None |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 107 | style_file = os.path.join(TOPDIR, "html", "style.css") |
Fred Drake | cf1b06e | 1999-09-23 16:55:09 +0000 | [diff] [blame] | 108 | about_file = os.path.join(TOPDIR, "html", "about.dat") |
Fred Drake | dfa539d | 2000-08-31 06:58:34 +0000 | [diff] [blame] | 109 | up_link = None |
| 110 | up_title = None |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 111 | # |
Fred Drake | 3ce28e4 | 2001-10-30 16:09:51 +0000 | [diff] [blame] | 112 | # 'dvips_safe' is a weird option. It is used mostly to make |
| 113 | # LaTeX2HTML not try to be too smart about protecting the user |
| 114 | # from a bad version of dvips -- some versions would core dump if |
| 115 | # the path to the source DVI contained a dot, and it's appearantly |
| 116 | # difficult to determine if the version available has that bug. |
| 117 | # This option gets set when PostScript output is requested |
| 118 | # (because we're going to run dvips regardless, and we'll either |
| 119 | # know it succeeds before LaTeX2HTML is run, or we'll have |
| 120 | # detected the failure and bailed), or the user asserts that it's |
| 121 | # safe from the command line. |
| 122 | # |
| 123 | # So, why does LaTeX2HTML think it appropriate to protect the user |
| 124 | # from a dvips that's only potentially going to core dump? Only |
| 125 | # because they want to avoid doing a lot of work just to have to |
| 126 | # bail later with no useful intermediates. Unfortunately, they |
| 127 | # bail *before* they know whether dvips will be needed at all. |
| 128 | # I've gone around the bush a few times with the LaTeX2HTML |
| 129 | # developers over whether this is appropriate behavior, and they |
| 130 | # don't seem interested in changing their position. |
| 131 | # |
| 132 | dvips_safe = 0 |
| 133 | # |
Fred Drake | 5599441 | 2001-01-30 22:30:01 +0000 | [diff] [blame] | 134 | DEFAULT_FORMATS = ("html",) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 135 | ALL_FORMATS = ("dvi", "html", "pdf", "ps", "text") |
| 136 | |
| 137 | def __init__(self): |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 138 | self.formats = [] |
Fred Drake | 8bc627a | 2000-08-31 06:14:38 +0000 | [diff] [blame] | 139 | self.l2h_init_files = [] |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 140 | |
| 141 | def __getitem__(self, key): |
| 142 | # This is used when formatting the usage message. |
| 143 | try: |
| 144 | return getattr(self, key) |
| 145 | except AttributeError: |
| 146 | raise KeyError, key |
| 147 | |
| 148 | def parse(self, args): |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 149 | opts, args = getopt.getopt(args, "Hi:a:s:lDkqr:", |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 150 | ["all", "postscript", "help", "iconserver=", |
Fred Drake | 8bc627a | 2000-08-31 06:14:38 +0000 | [diff] [blame] | 151 | "address=", "a4", "letter", "l2h-init=", |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 152 | "link=", "split=", "logging", "debugging", |
Fred Drake | cf1b06e | 1999-09-23 16:55:09 +0000 | [diff] [blame] | 153 | "keep", "quiet", "runs=", "image-type=", |
Fred Drake | 50d1fcf | 2001-02-19 19:18:09 +0000 | [diff] [blame] | 154 | "about=", "numeric", "style=", "paper=", |
| 155 | "up-link=", "up-title=", "dir=", |
Fred Drake | 3ce28e4 | 2001-10-30 16:09:51 +0000 | [diff] [blame] | 156 | "global-module-index=", "dvips-safe"] |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 157 | + list(self.ALL_FORMATS)) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 158 | for opt, arg in opts: |
| 159 | if opt == "--all": |
| 160 | self.formats = list(self.ALL_FORMATS) |
Fred Drake | 3ce28e4 | 2001-10-30 16:09:51 +0000 | [diff] [blame] | 161 | self.dvips_safe = "ps" in self.formats |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 162 | elif opt in ("-H", "--help"): |
| 163 | usage(self) |
| 164 | sys.exit() |
| 165 | elif opt == "--iconserver": |
| 166 | self.icon_server = arg |
| 167 | elif opt in ("-a", "--address"): |
| 168 | self.address = arg |
| 169 | elif opt == "--a4": |
| 170 | self.paper = "a4" |
| 171 | elif opt == "--letter": |
| 172 | self.paper = "letter" |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 173 | elif opt == "--link": |
| 174 | self.max_link_depth = int(arg) |
| 175 | elif opt in ("-s", "--split"): |
| 176 | self.max_split_depth = int(arg) |
| 177 | elif opt in ("-l", "--logging"): |
| 178 | self.logging = self.logging + 1 |
| 179 | elif opt in ("-D", "--debugging"): |
| 180 | self.debugging = self.debugging + 1 |
| 181 | elif opt in ("-k", "--keep"): |
| 182 | self.discard_temps = 0 |
| 183 | elif opt in ("-q", "--quiet"): |
| 184 | self.quiet = 1 |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 185 | elif opt in ("-r", "--runs"): |
| 186 | self.runs = int(arg) |
| 187 | elif opt == "--image-type": |
| 188 | self.image_type = arg |
Fred Drake | cf1b06e | 1999-09-23 16:55:09 +0000 | [diff] [blame] | 189 | elif opt == "--about": |
| 190 | # always make this absolute: |
| 191 | self.about_file = os.path.normpath( |
Fred Drake | fcb8725 | 2000-08-29 18:15:05 +0000 | [diff] [blame] | 192 | os.path.abspath(arg)) |
Fred Drake | 9a257b4 | 2000-03-31 20:27:36 +0000 | [diff] [blame] | 193 | elif opt == "--numeric": |
| 194 | self.numeric = 1 |
Fred Drake | fcb8725 | 2000-08-29 18:15:05 +0000 | [diff] [blame] | 195 | elif opt == "--style": |
| 196 | self.style_file = os.path.abspath(arg) |
Fred Drake | 8bc627a | 2000-08-31 06:14:38 +0000 | [diff] [blame] | 197 | elif opt == "--l2h-init": |
| 198 | self.l2h_init_files.append(os.path.abspath(arg)) |
Fred Drake | dfa539d | 2000-08-31 06:58:34 +0000 | [diff] [blame] | 199 | elif opt == "--up-link": |
| 200 | self.up_link = arg |
| 201 | elif opt == "--up-title": |
| 202 | self.up_title = arg |
Fred Drake | 42181db | 2001-01-09 22:02:10 +0000 | [diff] [blame] | 203 | elif opt == "--global-module-index": |
| 204 | self.global_module_index = arg |
Fred Drake | 50d1fcf | 2001-02-19 19:18:09 +0000 | [diff] [blame] | 205 | elif opt == "--dir": |
Fred Drake | 1cb560a | 2001-08-10 20:17:09 +0000 | [diff] [blame] | 206 | if os.sep == "\\": |
| 207 | arg = re.sub("/", "\\", arg) |
Fred Drake | 50d1fcf | 2001-02-19 19:18:09 +0000 | [diff] [blame] | 208 | self.builddir = arg |
| 209 | elif opt == "--paper": |
| 210 | self.paper = arg |
Fred Drake | 3ce28e4 | 2001-10-30 16:09:51 +0000 | [diff] [blame] | 211 | elif opt == "--dvips-safe": |
| 212 | self.dvips_safe = 1 |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 213 | # |
| 214 | # Format specifiers: |
| 215 | # |
| 216 | elif opt[2:] in self.ALL_FORMATS: |
| 217 | self.add_format(opt[2:]) |
| 218 | elif opt == "--postscript": |
| 219 | # synonym for --ps |
| 220 | self.add_format("ps") |
| 221 | self.initialize() |
| 222 | # |
| 223 | # return the args to allow the caller access: |
| 224 | # |
| 225 | return args |
| 226 | |
| 227 | def add_format(self, format): |
| 228 | """Add a format to the formats list if not present.""" |
| 229 | if not format in self.formats: |
Fred Drake | 3ce28e4 | 2001-10-30 16:09:51 +0000 | [diff] [blame] | 230 | if format == "ps": |
| 231 | # assume this is safe since we're going to run it anyway |
| 232 | self.dvips_safe = 1 |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 233 | self.formats.append(format) |
| 234 | |
| 235 | def initialize(self): |
| 236 | """Complete initialization. This is needed if parse() isn't used.""" |
| 237 | # add the default format if no formats were specified: |
| 238 | if not self.formats: |
| 239 | self.formats = self.DEFAULT_FORMATS |
| 240 | # determine the base set of texinputs directories: |
| 241 | texinputs = string.split(os.environ.get("TEXINPUTS", ""), os.pathsep) |
| 242 | if not texinputs: |
| 243 | texinputs = [''] |
| 244 | self.base_texinputs = [ |
| 245 | os.path.join(TOPDIR, "paper-" + self.paper), |
| 246 | os.path.join(TOPDIR, "texinputs"), |
| 247 | ] + texinputs |
Fred Drake | bfd80dd | 2001-06-23 03:06:01 +0000 | [diff] [blame] | 248 | if self.builddir: |
| 249 | self.builddir = os.path.abspath(self.builddir) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 250 | |
| 251 | |
| 252 | class Job: |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 253 | latex_runs = 0 |
| 254 | |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 255 | def __init__(self, options, path): |
| 256 | self.options = options |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 257 | self.doctype = get_doctype(path) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 258 | self.filedir, self.doc = split_pathname(path) |
Fred Drake | bfd80dd | 2001-06-23 03:06:01 +0000 | [diff] [blame] | 259 | self.builddir = os.path.abspath(options.builddir or self.doc) |
Fred Drake | aebbca3 | 2001-07-17 14:46:09 +0000 | [diff] [blame] | 260 | if ("html" in options.formats or "text" in options.formats): |
| 261 | if not os.path.exists(self.builddir): |
| 262 | os.mkdir(self.builddir) |
| 263 | self.log_filename = os.path.join(self.builddir, self.doc + ".how") |
| 264 | else: |
| 265 | self.log_filename = os.path.abspath(self.doc + ".how") |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 266 | if os.path.exists(self.log_filename): |
| 267 | os.unlink(self.log_filename) |
| 268 | if os.path.exists(self.doc + ".l2h"): |
| 269 | self.l2h_aux_init_file = tempfile.mktemp() |
| 270 | else: |
| 271 | self.l2h_aux_init_file = self.doc + ".l2h" |
| 272 | self.write_l2h_aux_init_file() |
| 273 | |
| 274 | def build(self): |
| 275 | self.setup_texinputs() |
| 276 | formats = self.options.formats |
| 277 | if "dvi" in formats or "ps" in formats: |
| 278 | self.build_dvi() |
| 279 | if "pdf" in formats: |
| 280 | self.build_pdf() |
| 281 | if "ps" in formats: |
| 282 | self.build_ps() |
| 283 | if "html" in formats: |
| 284 | self.require_temps() |
Fred Drake | bfd80dd | 2001-06-23 03:06:01 +0000 | [diff] [blame] | 285 | self.build_html(self.builddir) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 286 | if self.options.icon_server == ".": |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 287 | pattern = os.path.join(TOPDIR, "html", "icons", |
| 288 | "*." + self.options.image_type) |
| 289 | imgs = glob.glob(pattern) |
| 290 | if not imgs: |
| 291 | self.warning( |
| 292 | "Could not locate support images of type %s." |
| 293 | % `self.options.image_type`) |
| 294 | for fn in imgs: |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 295 | new_fn = os.path.join(self.doc, os.path.basename(fn)) |
| 296 | shutil.copyfile(fn, new_fn) |
| 297 | if "text" in formats: |
| 298 | self.require_temps() |
| 299 | tempdir = self.doc |
| 300 | need_html = "html" not in formats |
| 301 | if self.options.max_split_depth != 1: |
| 302 | fp = open(self.l2h_aux_init_file, "a") |
| 303 | fp.write("# re-hack this file for --text:\n") |
| 304 | l2hoption(fp, "MAX_SPLIT_DEPTH", "1") |
| 305 | fp.write("1;\n") |
| 306 | fp.close() |
| 307 | tempdir = self.doc + "-temp-html" |
| 308 | need_html = 1 |
| 309 | if need_html: |
| 310 | self.build_html(tempdir, max_split_depth=1) |
| 311 | self.build_text(tempdir) |
| 312 | if self.options.discard_temps: |
| 313 | self.cleanup() |
| 314 | |
| 315 | def setup_texinputs(self): |
| 316 | texinputs = [self.filedir] + list(self.options.base_texinputs) |
| 317 | os.environ["TEXINPUTS"] = string.join(texinputs, os.pathsep) |
Fred Drake | aaa0d9a | 1999-03-03 21:57:58 +0000 | [diff] [blame] | 318 | self.message("TEXINPUTS=" + os.environ["TEXINPUTS"]) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 319 | |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 320 | def build_aux(self, binary=None): |
| 321 | if binary is None: |
| 322 | binary = LATEX_BINARY |
| 323 | new_index( "%s.ind" % self.doc, "genindex") |
| 324 | new_index("mod%s.ind" % self.doc, "modindex") |
| 325 | self.run("%s %s" % (binary, self.doc)) |
| 326 | self.use_bibtex = check_for_bibtex(self.doc + ".aux") |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 327 | self.latex_runs = 1 |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 328 | |
| 329 | def build_dvi(self): |
| 330 | self.use_latex(LATEX_BINARY) |
| 331 | |
| 332 | def build_pdf(self): |
| 333 | self.use_latex(PDFLATEX_BINARY) |
| 334 | |
| 335 | def use_latex(self, binary): |
| 336 | self.require_temps(binary=binary) |
Fred Drake | df84fac | 2000-09-20 05:49:09 +0000 | [diff] [blame] | 337 | if self.latex_runs < 2: |
| 338 | if os.path.isfile("mod%s.idx" % self.doc): |
| 339 | self.run("%s mod%s.idx" % (MAKEINDEX_BINARY, self.doc)) |
Fred Drake | 9dce7b3 | 2000-11-03 02:57:31 +0000 | [diff] [blame] | 340 | use_indfix = 0 |
Fred Drake | df84fac | 2000-09-20 05:49:09 +0000 | [diff] [blame] | 341 | if os.path.isfile(self.doc + ".idx"): |
Fred Drake | 9dce7b3 | 2000-11-03 02:57:31 +0000 | [diff] [blame] | 342 | use_indfix = 1 |
Fred Drake | df84fac | 2000-09-20 05:49:09 +0000 | [diff] [blame] | 343 | # call to Doc/tools/fix_hack omitted; doesn't appear necessary |
| 344 | self.run("%s %s.idx" % (MAKEINDEX_BINARY, self.doc)) |
| 345 | import indfix |
| 346 | indfix.process(self.doc + ".ind") |
| 347 | if self.use_bibtex: |
| 348 | self.run("%s %s" % (BIBTEX_BINARY, self.doc)) |
| 349 | self.process_synopsis_files() |
| 350 | # |
| 351 | # let the doctype-specific handler do some intermediate work: |
| 352 | # |
| 353 | self.run("%s %s" % (binary, self.doc)) |
Fred Drake | b258bed | 2001-02-12 15:30:22 +0000 | [diff] [blame] | 354 | self.latex_runs = self.latex_runs + 1 |
Fred Drake | df84fac | 2000-09-20 05:49:09 +0000 | [diff] [blame] | 355 | if os.path.isfile("mod%s.idx" % self.doc): |
| 356 | self.run("%s -s %s mod%s.idx" |
| 357 | % (MAKEINDEX_BINARY, ISTFILE, self.doc)) |
Fred Drake | 9dce7b3 | 2000-11-03 02:57:31 +0000 | [diff] [blame] | 358 | if use_indfix: |
Fred Drake | df84fac | 2000-09-20 05:49:09 +0000 | [diff] [blame] | 359 | self.run("%s -s %s %s.idx" |
| 360 | % (MAKEINDEX_BINARY, ISTFILE, self.doc)) |
Fred Drake | 9dce7b3 | 2000-11-03 02:57:31 +0000 | [diff] [blame] | 361 | indfix.process(self.doc + ".ind") |
Fred Drake | df84fac | 2000-09-20 05:49:09 +0000 | [diff] [blame] | 362 | self.process_synopsis_files() |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 363 | # |
| 364 | # and now finish it off: |
| 365 | # |
| 366 | if os.path.isfile(self.doc + ".toc") and binary == PDFLATEX_BINARY: |
| 367 | import toc2bkm |
Fred Drake | 239e1d5 | 2000-09-05 21:45:11 +0000 | [diff] [blame] | 368 | if self.doctype == "manual": |
| 369 | bigpart = "chapter" |
| 370 | else: |
| 371 | bigpart = "section" |
| 372 | toc2bkm.process(self.doc + ".toc", self.doc + ".bkm", bigpart) |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 373 | if self.use_bibtex: |
| 374 | self.run("%s %s" % (BIBTEX_BINARY, self.doc)) |
| 375 | self.run("%s %s" % (binary, self.doc)) |
Fred Drake | b258bed | 2001-02-12 15:30:22 +0000 | [diff] [blame] | 376 | self.latex_runs = self.latex_runs + 1 |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 377 | |
| 378 | def process_synopsis_files(self): |
| 379 | synopsis_files = glob.glob(self.doc + "*.syn") |
| 380 | for path in synopsis_files: |
| 381 | uniqify_module_table(path) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 382 | |
| 383 | def build_ps(self): |
| 384 | self.run("%s -N0 -o %s.ps %s" % (DVIPS_BINARY, self.doc, self.doc)) |
| 385 | |
Fred Drake | aebbca3 | 2001-07-17 14:46:09 +0000 | [diff] [blame] | 386 | def build_html(self, builddir, max_split_depth=None): |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 387 | if max_split_depth is None: |
| 388 | max_split_depth = self.options.max_split_depth |
| 389 | texfile = None |
| 390 | for p in string.split(os.environ["TEXINPUTS"], os.pathsep): |
| 391 | fn = os.path.join(p, self.doc + ".tex") |
| 392 | if os.path.isfile(fn): |
| 393 | texfile = fn |
| 394 | break |
| 395 | if not texfile: |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 396 | self.warning("Could not locate %s.tex; aborting." % self.doc) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 397 | sys.exit(1) |
| 398 | # remove leading ./ (or equiv.); might avoid problems w/ dvips |
| 399 | if texfile[:2] == os.curdir + os.sep: |
| 400 | texfile = texfile[2:] |
| 401 | # build the command line and run LaTeX2HTML: |
Fred Drake | ba82878 | 2000-04-03 04:19:14 +0000 | [diff] [blame] | 402 | if not os.path.isdir(builddir): |
| 403 | os.mkdir(builddir) |
Fred Drake | f3d4127 | 2000-09-14 22:25:47 +0000 | [diff] [blame] | 404 | else: |
| 405 | for fname in glob.glob(os.path.join(builddir, "*.html")): |
| 406 | os.unlink(fname) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 407 | args = [LATEX2HTML_BINARY, |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 408 | "-init_file", self.l2h_aux_init_file, |
| 409 | "-dir", builddir, |
| 410 | texfile |
| 411 | ] |
| 412 | self.run(string.join(args)) # XXX need quoting! |
| 413 | # ... postprocess |
| 414 | shutil.copyfile(self.options.style_file, |
| 415 | os.path.join(builddir, self.doc + ".css")) |
Fred Drake | 4437fdf | 1999-05-03 14:29:07 +0000 | [diff] [blame] | 416 | shutil.copyfile(os.path.join(builddir, self.doc + ".html"), |
| 417 | os.path.join(builddir, "index.html")) |
Fred Drake | cfef0096 | 2001-03-02 16:26:45 +0000 | [diff] [blame] | 418 | if max_split_depth != 1: |
Fred Drake | af92218 | 2001-05-09 04:03:16 +0000 | [diff] [blame] | 419 | label_file = os.path.join(builddir, "labels.pl") |
| 420 | fp = open(label_file) |
| 421 | about_node = None |
| 422 | target = " = q/about/;\n" |
| 423 | x = len(target) |
| 424 | while 1: |
| 425 | line = fp.readline() |
| 426 | if not line: |
| 427 | break |
| 428 | if line[-x:] == target: |
Fred Drake | cfef0096 | 2001-03-02 16:26:45 +0000 | [diff] [blame] | 429 | line = fp.readline() |
Fred Drake | af92218 | 2001-05-09 04:03:16 +0000 | [diff] [blame] | 430 | m = re.search(r"\|(node\d+\.[a-z]+)\|", line) |
| 431 | about_node = m.group(1) |
| 432 | shutil.copyfile(os.path.join(builddir, about_node), |
| 433 | os.path.join(builddir, "about.html")) |
| 434 | break |
| 435 | if not self.options.numeric: |
Fred Drake | cfef0096 | 2001-03-02 16:26:45 +0000 | [diff] [blame] | 436 | pwd = os.getcwd() |
| 437 | try: |
| 438 | os.chdir(builddir) |
| 439 | self.run("%s %s *.html" % (PERL_BINARY, NODE2LABEL_SCRIPT)) |
| 440 | finally: |
| 441 | os.chdir(pwd) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 442 | |
| 443 | def build_text(self, tempdir=None): |
| 444 | if tempdir is None: |
| 445 | tempdir = self.doc |
| 446 | indexfile = os.path.join(tempdir, "index.html") |
| 447 | self.run("%s -nolist -dump %s >%s.txt" |
| 448 | % (LYNX_BINARY, indexfile, self.doc)) |
| 449 | |
| 450 | def require_temps(self, binary=None): |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 451 | if not self.latex_runs: |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 452 | self.build_aux(binary=binary) |
| 453 | |
| 454 | def write_l2h_aux_init_file(self): |
Fred Drake | 8bc627a | 2000-08-31 06:14:38 +0000 | [diff] [blame] | 455 | options = self.options |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 456 | fp = open(self.l2h_aux_init_file, "w") |
Fred Drake | 1915754 | 2000-07-31 17:47:49 +0000 | [diff] [blame] | 457 | d = string_to_perl(os.path.dirname(L2H_INIT_FILE)) |
| 458 | fp.write("package main;\n" |
| 459 | "push (@INC, '%s');\n" |
| 460 | "$mydir = '%s';\n" |
| 461 | % (d, d)) |
Fred Drake | 498c18f | 2000-07-24 23:03:32 +0000 | [diff] [blame] | 462 | fp.write(open(L2H_INIT_FILE).read()) |
Fred Drake | 8bc627a | 2000-08-31 06:14:38 +0000 | [diff] [blame] | 463 | for filename in options.l2h_init_files: |
| 464 | fp.write("\n# initialization code incorporated from:\n# ") |
| 465 | fp.write(filename) |
| 466 | fp.write("\n") |
| 467 | fp.write(open(filename).read()) |
Fred Drake | 498c18f | 2000-07-24 23:03:32 +0000 | [diff] [blame] | 468 | fp.write("\n" |
| 469 | "# auxillary init file for latex2html\n" |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 470 | "# generated by mkhowto\n" |
Fred Drake | 4437fdf | 1999-05-03 14:29:07 +0000 | [diff] [blame] | 471 | "$NO_AUTO_LINK = 1;\n" |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 472 | ) |
Fred Drake | cf1b06e | 1999-09-23 16:55:09 +0000 | [diff] [blame] | 473 | l2hoption(fp, "ABOUT_FILE", options.about_file) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 474 | l2hoption(fp, "ICONSERVER", options.icon_server) |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 475 | l2hoption(fp, "IMAGE_TYPE", options.image_type) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 476 | l2hoption(fp, "ADDRESS", options.address) |
| 477 | l2hoption(fp, "MAX_LINK_DEPTH", options.max_link_depth) |
| 478 | l2hoption(fp, "MAX_SPLIT_DEPTH", options.max_split_depth) |
Fred Drake | dfa539d | 2000-08-31 06:58:34 +0000 | [diff] [blame] | 479 | l2hoption(fp, "EXTERNAL_UP_LINK", options.up_link) |
| 480 | l2hoption(fp, "EXTERNAL_UP_TITLE", options.up_title) |
Fred Drake | 42181db | 2001-01-09 22:02:10 +0000 | [diff] [blame] | 481 | l2hoption(fp, "GLOBAL_MODULE_INDEX", options.global_module_index) |
Fred Drake | 3ce28e4 | 2001-10-30 16:09:51 +0000 | [diff] [blame] | 482 | l2hoption(fp, "DVIPS_SAFE", options.dvips_safe) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 483 | fp.write("1;\n") |
| 484 | fp.close() |
| 485 | |
| 486 | def cleanup(self): |
| 487 | self.__have_temps = 0 |
| 488 | for pattern in ("%s.aux", "%s.log", "%s.out", "%s.toc", "%s.bkm", |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 489 | "%s.idx", "%s.ilg", "%s.ind", "%s.pla", |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 490 | "%s.bbl", "%s.blg", |
| 491 | "mod%s.idx", "mod%s.ind", "mod%s.ilg", |
| 492 | ): |
| 493 | safe_unlink(pattern % self.doc) |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 494 | map(safe_unlink, glob.glob(self.doc + "*.syn")) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 495 | for spec in ("IMG*", "*.pl", "WARNINGS", "index.dat", "modindex.dat"): |
| 496 | pattern = os.path.join(self.doc, spec) |
| 497 | map(safe_unlink, glob.glob(pattern)) |
| 498 | if "dvi" not in self.options.formats: |
| 499 | safe_unlink(self.doc + ".dvi") |
| 500 | if os.path.isdir(self.doc + "-temp-html"): |
| 501 | shutil.rmtree(self.doc + "-temp-html", ignore_errors=1) |
| 502 | if not self.options.logging: |
| 503 | os.unlink(self.log_filename) |
| 504 | if not self.options.debugging: |
| 505 | os.unlink(self.l2h_aux_init_file) |
| 506 | |
| 507 | def run(self, command): |
Fred Drake | aaa0d9a | 1999-03-03 21:57:58 +0000 | [diff] [blame] | 508 | self.message(command) |
Fred Drake | 1cb560a | 2001-08-10 20:17:09 +0000 | [diff] [blame] | 509 | if sys.platform.startswith("win"): |
| 510 | rc = os.system(command) |
| 511 | else: |
| 512 | rc = os.system("(%s) </dev/null >>%s 2>&1" |
| 513 | % (command, self.log_filename)) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 514 | if rc: |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 515 | self.warning( |
| 516 | "Session transcript and error messages are in %s." |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 517 | % self.log_filename) |
Fred Drake | 1cb560a | 2001-08-10 20:17:09 +0000 | [diff] [blame] | 518 | if hasattr(os, "WIFEXITED"): |
| 519 | if os.WIFEXITED(rc): |
| 520 | self.warning("Exited with status %s." % os.WEXITSTATUS(rc)) |
| 521 | else: |
| 522 | self.warning("Killed by signal %s." % os.WSTOPSIG(rc)) |
| 523 | else: |
| 524 | self.warning("Return code: %s" % rc) |
Fred Drake | 4e3f275 | 2001-02-04 15:20:26 +0000 | [diff] [blame] | 525 | sys.stderr.write("The relevant lines from the transcript are:\n") |
| 526 | sys.stderr.write("-" * 72 + "\n") |
| 527 | sys.stderr.writelines(get_run_transcript(self.log_filename)) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 528 | sys.exit(rc) |
| 529 | |
Fred Drake | aaa0d9a | 1999-03-03 21:57:58 +0000 | [diff] [blame] | 530 | def message(self, msg): |
| 531 | msg = "+++ " + msg |
| 532 | if not self.options.quiet: |
| 533 | print msg |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 534 | self.log(msg + "\n") |
| 535 | |
| 536 | def warning(self, msg): |
| 537 | msg = "*** %s\n" % msg |
| 538 | sys.stderr.write(msg) |
| 539 | self.log(msg) |
| 540 | |
| 541 | def log(self, msg): |
Fred Drake | aaa0d9a | 1999-03-03 21:57:58 +0000 | [diff] [blame] | 542 | fp = open(self.log_filename, "a") |
Fred Drake | 52ea0ce | 1999-09-22 19:55:35 +0000 | [diff] [blame] | 543 | fp.write(msg) |
Fred Drake | aaa0d9a | 1999-03-03 21:57:58 +0000 | [diff] [blame] | 544 | fp.close() |
| 545 | |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 546 | |
Fred Drake | 4e3f275 | 2001-02-04 15:20:26 +0000 | [diff] [blame] | 547 | def get_run_transcript(filename): |
| 548 | """Return lines from the transcript file for the most recent run() call.""" |
| 549 | fp = open(filename) |
| 550 | lines = fp.readlines() |
| 551 | fp.close() |
| 552 | lines.reverse() |
| 553 | L = [] |
| 554 | for line in lines: |
| 555 | L.append(line) |
| 556 | if line[:4] == "+++ ": |
| 557 | break |
| 558 | L.reverse() |
| 559 | return L |
| 560 | |
| 561 | |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 562 | def safe_unlink(path): |
Fred Drake | 4e3f275 | 2001-02-04 15:20:26 +0000 | [diff] [blame] | 563 | """Unlink a file without raising an error if it doesn't exist.""" |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 564 | try: |
| 565 | os.unlink(path) |
| 566 | except os.error: |
| 567 | pass |
| 568 | |
| 569 | |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 570 | def split_pathname(path): |
Fred Drake | bfd80dd | 2001-06-23 03:06:01 +0000 | [diff] [blame] | 571 | path = os.path.abspath(path) |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 572 | dirname, basename = os.path.split(path) |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 573 | if basename[-4:] == ".tex": |
| 574 | basename = basename[:-4] |
| 575 | return dirname, basename |
| 576 | |
| 577 | |
Fred Drake | a871c2e | 1999-05-06 19:37:38 +0000 | [diff] [blame] | 578 | _doctype_rx = re.compile(r"\\documentclass(?:\[[^]]*\])?{([a-zA-Z]*)}") |
| 579 | def get_doctype(path): |
| 580 | fp = open(path) |
| 581 | doctype = None |
| 582 | while 1: |
| 583 | line = fp.readline() |
| 584 | if not line: |
| 585 | break |
| 586 | m = _doctype_rx.match(line) |
| 587 | if m: |
| 588 | doctype = m.group(1) |
| 589 | break |
| 590 | fp.close() |
| 591 | return doctype |
| 592 | |
| 593 | |
Fred Drake | 8b88093 | 1999-03-03 20:24:30 +0000 | [diff] [blame] | 594 | def main(): |
| 595 | options = Options() |
| 596 | try: |
| 597 | args = options.parse(sys.argv[1:]) |
| 598 | except getopt.error, msg: |
| 599 | error(options, msg) |
| 600 | if not args: |
| 601 | # attempt to locate single .tex file in current directory: |
| 602 | args = glob.glob("*.tex") |
| 603 | if not args: |
| 604 | error(options, "No file to process.") |
| 605 | if len(args) > 1: |
| 606 | error(options, "Could not deduce which files should be processed.") |
| 607 | # |
| 608 | # parameters are processed, let's go! |
| 609 | # |
| 610 | for path in args: |
| 611 | Job(options, path).build() |
| 612 | |
| 613 | |
| 614 | def l2hoption(fp, option, value): |
| 615 | if value: |
| 616 | fp.write('$%s = "%s";\n' % (option, string_to_perl(str(value)))) |
| 617 | |
| 618 | |
| 619 | _to_perl = {} |
| 620 | for c in map(chr, range(1, 256)): |
| 621 | _to_perl[c] = c |
| 622 | _to_perl["@"] = "\\@" |
| 623 | _to_perl["$"] = "\\$" |
| 624 | _to_perl['"'] = '\\"' |
| 625 | |
| 626 | def string_to_perl(s): |
| 627 | return string.join(map(_to_perl.get, s), '') |
| 628 | |
| 629 | |
| 630 | def check_for_bibtex(filename): |
| 631 | fp = open(filename) |
| 632 | pos = string.find(fp.read(), r"\bibdata{") |
| 633 | fp.close() |
| 634 | return pos >= 0 |
| 635 | |
| 636 | def uniqify_module_table(filename): |
| 637 | lines = open(filename).readlines() |
| 638 | if len(lines) > 1: |
| 639 | if lines[-1] == lines[-2]: |
| 640 | del lines[-1] |
| 641 | open(filename, "w").writelines(lines) |
| 642 | |
| 643 | |
| 644 | def new_index(filename, label="genindex"): |
| 645 | fp = open(filename, "w") |
| 646 | fp.write(r"""\ |
| 647 | \begin{theindex} |
| 648 | \label{%s} |
| 649 | \end{theindex} |
| 650 | """ % label) |
| 651 | fp.close() |
| 652 | |
| 653 | |
| 654 | if __name__ == "__main__": |
| 655 | main() |