Mercurial > cpython-lru_cache-weakref
annotate Tools/scripts/texi2html.py @ 2800:ab3dca97ffbe legacy-trunk
new grammar for 3rd raise arg and keyword parameters
| author | Guido van Rossum <guido@python.org> |
|---|---|
| date | Fri, 07 Jul 1995 22:26:23 +0000 |
| parents | 9ed45dbf2765 |
| children | 7ae332472629 |
| rev | line source |
|---|---|
| 2551 | 1 #! /usr/local/bin/python |
| 2 | |
| 3 # Convert GNU texinfo files into HTML, one file per node. | |
| 4 # Based on Texinfo 2.14. | |
| 5 # Usage: texi2html [-d] [-d] inputfile outputdirectory | |
| 6 # The input file must be a complete texinfo file, e.g. emacs.texi. | |
| 7 # This creates many files (one per info node) in the output directory, | |
| 8 # overwriting existing files of the same name. All files created have | |
| 9 # ".html" as their extension. | |
| 10 | |
| 11 | |
| 12 # XXX To do: | |
| 13 # - handle @comment*** correctly | |
| 14 # - handle @xref {some words} correctly | |
| 15 # - handle @ftable correctly (items aren't indexed?) | |
| 16 # - handle @itemx properly | |
| 17 # - handle @exdent properly | |
| 18 # - add links directly to the proper line from indices | |
| 19 # - check against the definitive list of @-cmds; we still miss (among others): | |
| 20 # - @set, @clear, @ifset, @ifclear | |
| 21 # - @defindex (hard) | |
| 22 # - @c(omment) in the middle of a line (rarely used) | |
| 23 # - @this* (not really needed, only used in headers anyway) | |
| 24 # - @today{} (ever used outside title page?) | |
| 25 | |
| 26 | |
| 27 import os | |
| 28 import regex | |
| 29 import regsub | |
| 30 import string | |
| 31 | |
| 32 MAGIC = '\\input texinfo' | |
| 33 | |
| 34 cmprog = regex.compile('^@\([a-z]+\)\([ \t]\|$\)') # Command (line-oriented) | |
| 35 blprog = regex.compile('^[ \t]*$') # Blank line | |
| 36 kwprog = regex.compile('@[a-z]+') # Keyword (embedded, usually with {} args) | |
| 37 spprog = regex.compile('[\n@{}&<>]') # Special characters in running text | |
| 38 miprog = regex.compile( \ | |
| 39 '^\* \([^:]*\):\(:\|[ \t]*\([^\t,\n.]+\)\([^ \t\n]*\)\)[ \t\n]*') | |
| 40 # menu item (Yuck!) | |
| 41 | |
| 42 class TexinfoParser: | |
| 43 | |
| 44 # Initialize an instance | |
| 45 def __init__(self): | |
| 46 self.unknown = {} # statistics about unknown @-commands | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
47 self.filenames = {} # Check for identical filenames |
| 2551 | 48 self.debugging = 0 # larger values produce more output |
| 49 self.nodefp = None # open file we're writing to | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
50 self.nodelineno = 0 # Linenumber relative to node |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
51 self.links = None # Links from current node |
| 2551 | 52 self.savetext = None # If not None, save text head instead |
| 53 self.dirname = 'tmp' # directory where files are created | |
| 54 self.includedir = '.' # directory to search @include files | |
| 55 self.nodename = '' # name of current node | |
| 56 self.topname = '' # name of top node (first node seen) | |
| 57 self.title = '' # title of this whole Texinfo tree | |
| 58 self.resetindex() # Reset all indices | |
| 59 self.contents = [] # Reset table of contents | |
| 60 self.numbering = [] # Reset section numbering counters | |
| 61 self.nofill = 0 # Normal operation: fill paragraphs | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
62 self.goodset=['html'] # Names that should be parsed in ifset |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
63 self.stackinfo={} # Keep track of state in the stack |
| 2551 | 64 # XXX The following should be reset per node?! |
| 65 self.footnotes = [] # Reset list of footnotes | |
| 66 self.itemarg = None # Reset command used by @item | |
| 67 self.itemnumber = None # Reset number for @item in @enumerate | |
| 68 self.itemindex = None # Reset item index name | |
| 69 | |
| 70 # Set (output) directory name | |
| 71 def setdirname(self, dirname): | |
| 72 self.dirname = dirname | |
| 73 | |
| 74 # Set include directory name | |
| 75 def setincludedir(self, includedir): | |
| 76 self.includedir = includedir | |
| 77 | |
| 78 # Parse the contents of an entire file | |
| 79 def parse(self, fp): | |
| 80 line = fp.readline() | |
| 81 lineno = 1 | |
| 82 while line and (line[0] == '%' or blprog.match(line) >= 0): | |
| 83 line = fp.readline() | |
| 84 lineno = lineno + 1 | |
| 85 if line[:len(MAGIC)] <> MAGIC: | |
| 86 raise SyntaxError, 'file does not begin with '+`MAGIC` | |
| 87 self.parserest(fp, lineno) | |
| 88 | |
| 89 # Parse the contents of a file, not expecting a MAGIC header | |
| 90 def parserest(self, fp, initial_lineno): | |
| 91 lineno = initial_lineno | |
| 92 self.done = 0 | |
| 93 self.skip = 0 | |
| 94 self.stack = [] | |
| 95 accu = [] | |
| 96 while not self.done: | |
| 97 line = fp.readline() | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
98 self.nodelineno = self.nodelineno + 1 |
| 2551 | 99 if not line: |
| 100 if accu: | |
| 101 if not self.skip: self.process(accu) | |
| 102 accu = [] | |
| 103 if initial_lineno > 0: | |
| 104 print '*** EOF before @bye' | |
| 105 break | |
| 106 lineno = lineno + 1 | |
| 107 if cmprog.match(line) >= 0: | |
| 108 a, b = cmprog.regs[1] | |
| 109 cmd = line[a:b] | |
| 110 if cmd in ('noindent', 'refill'): | |
| 111 accu.append(line) | |
| 112 else: | |
| 113 if accu: | |
| 114 if not self.skip: | |
| 115 self.process(accu) | |
| 116 accu = [] | |
| 117 self.command(line) | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
118 elif blprog.match(line) >= 0 and \ |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
119 'format' not in self.stack and \ |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
120 'example' not in self.stack: |
| 2551 | 121 if accu: |
| 122 if not self.skip: | |
| 123 self.process(accu) | |
| 124 self.write('<P>\n') | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
125 accu = [] |
| 2551 | 126 else: |
| 127 # Append the line including trailing \n! | |
| 128 accu.append(line) | |
| 129 # | |
| 130 if self.skip: | |
| 131 print '*** Still skipping at the end' | |
| 132 if self.stack: | |
| 133 print '*** Stack not empty at the end' | |
| 134 print '***', self.stack | |
| 135 | |
| 136 # Start saving text in a buffer instead of writing it to a file | |
| 137 def startsaving(self): | |
| 138 if self.savetext <> None: | |
| 139 print '*** Recursively saving text, expect trouble' | |
| 140 self.savetext = '' | |
| 141 | |
| 142 # Return the text saved so far and start writing to file again | |
| 143 def collectsavings(self): | |
| 144 savetext = self.savetext | |
| 145 self.savetext = None | |
| 146 return savetext or '' | |
| 147 | |
| 148 # Write text to file, or save it in a buffer, or ignore it | |
| 149 def write(self, *args): | |
| 150 text = string.joinfields(args, '') | |
| 151 if self.savetext <> None: | |
| 152 self.savetext = self.savetext + text | |
| 153 elif self.nodefp: | |
| 154 self.nodefp.write(text) | |
| 155 | |
| 156 # Complete the current node -- write footnotes and close file | |
| 157 def endnode(self): | |
| 158 if self.savetext <> None: | |
| 159 print '*** Still saving text at end of node' | |
| 160 dummy = self.collectsavings() | |
| 161 if self.footnotes: | |
| 162 self.writefootnotes() | |
| 163 if self.nodefp: | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
164 if self.nodelineno > 20: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
165 self.write ('<HR>\n') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
166 [name, next, prev, up] = self.nodelinks[:4] |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
167 self.link('Next', next) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
168 self.link('Prev', prev) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
169 self.link('Up', up) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
170 if self.nodename <> self.topname: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
171 self.link('Top', self.topname) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
172 self.write ('<HR>\n') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
173 self.write('</BODY>\n') |
| 2551 | 174 self.nodefp.close() |
| 175 self.nodefp = None | |
| 176 self.nodename = '' | |
| 177 | |
| 178 # Process a list of lines, expanding embedded @-commands | |
| 179 # This mostly distinguishes between menus and normal text | |
| 180 def process(self, accu): | |
| 181 if self.debugging > 1: | |
| 182 print self.skip, self.stack, | |
| 183 if accu: print accu[0][:30], | |
| 184 if accu[0][30:] or accu[1:]: print '...', | |
| 185 print | |
| 186 if self.stack and self.stack[-1] == 'menu': | |
| 187 # XXX should be done differently | |
| 188 for line in accu: | |
| 189 if miprog.match(line) < 0: | |
| 190 line = string.strip(line) + '\n' | |
| 191 self.expand(line) | |
| 192 continue | |
| 193 (bgn, end), (a, b), (c, d), (e, f), (g, h) = \ | |
| 194 miprog.regs[:5] | |
| 195 label = line[a:b] | |
| 196 nodename = line[c:d] | |
| 197 if nodename[0] == ':': nodename = label | |
| 198 else: nodename = line[e:f] | |
| 199 punct = line[g:h] | |
| 200 self.write('<DT><A HREF="', \ | |
| 201 makefile(nodename), \ | |
| 202 '" TYPE=Menu>', nodename, \ | |
| 203 '</A>', punct, '\n<DD>') | |
| 204 self.expand(line[end:]) | |
| 205 else: | |
| 206 text = string.joinfields(accu, '') | |
| 207 self.expand(text) | |
| 208 | |
| 209 # Write a string, expanding embedded @-commands | |
| 210 def expand(self, text): | |
| 211 stack = [] | |
| 212 i = 0 | |
| 213 n = len(text) | |
| 214 while i < n: | |
| 215 start = i | |
| 216 i = spprog.search(text, i) | |
| 217 if i < 0: | |
| 218 self.write(text[start:]) | |
| 219 break | |
| 220 self.write(text[start:i]) | |
| 221 c = text[i] | |
| 222 i = i+1 | |
| 223 if c == '\n': | |
| 224 if self.nofill > 0: | |
| 225 self.write('<P>\n') | |
| 226 else: | |
| 227 self.write('\n') | |
| 228 continue | |
| 229 if c == '<': | |
| 230 self.write('<') | |
| 231 continue | |
| 232 if c == '>': | |
| 233 self.write('>') | |
| 234 continue | |
| 235 if c == '&': | |
| 236 self.write('&') | |
| 237 continue | |
| 238 if c == '{': | |
| 239 stack.append('') | |
| 240 continue | |
| 241 if c == '}': | |
| 242 if not stack: | |
| 243 print '*** Unmatched }' | |
| 244 self.write('}') | |
| 245 continue | |
| 246 cmd = stack[-1] | |
| 247 del stack[-1] | |
| 248 try: | |
| 249 method = getattr(self, 'close_' + cmd) | |
| 250 except AttributeError: | |
| 251 self.unknown_close(cmd) | |
| 252 continue | |
| 253 method() | |
| 254 continue | |
| 255 if c <> '@': | |
| 256 # Cannot happen unless spprog is changed | |
| 257 raise RuntimeError, 'unexpected funny '+`c` | |
| 258 start = i | |
| 259 while i < n and text[i] in string.letters: i = i+1 | |
| 260 if i == start: | |
| 261 # @ plus non-letter: literal next character | |
| 262 i = i+1 | |
| 263 c = text[start:i] | |
| 264 if c == ':': | |
| 265 # `@:' means no extra space after | |
| 266 # preceding `.', `?', `!' or `:' | |
| 267 pass | |
| 268 else: | |
| 269 # `@.' means a sentence-ending period; | |
| 270 # `@@', `@{', `@}' quote `@', `{', `}' | |
| 271 self.write(c) | |
| 272 continue | |
| 273 cmd = text[start:i] | |
| 274 if i < n and text[i] == '{': | |
| 275 i = i+1 | |
| 276 stack.append(cmd) | |
| 277 try: | |
| 278 method = getattr(self, 'open_' + cmd) | |
| 279 except AttributeError: | |
| 280 self.unknown_open(cmd) | |
| 281 continue | |
| 282 method() | |
| 283 continue | |
| 284 try: | |
| 285 method = getattr(self, 'handle_' + cmd) | |
| 286 except AttributeError: | |
| 287 self.unknown_handle(cmd) | |
| 288 continue | |
| 289 method() | |
| 290 if stack: | |
| 291 print '*** Stack not empty at para:', stack | |
| 292 | |
| 293 # --- Handle unknown embedded @-commands --- | |
| 294 | |
| 295 def unknown_open(self, cmd): | |
| 296 print '*** No open func for @' + cmd + '{...}' | |
| 297 cmd = cmd + '{' | |
| 298 self.write('@', cmd) | |
| 299 if not self.unknown.has_key(cmd): | |
| 300 self.unknown[cmd] = 1 | |
| 301 else: | |
| 302 self.unknown[cmd] = self.unknown[cmd] + 1 | |
| 303 | |
| 304 def unknown_close(self, cmd): | |
| 305 print '*** No close func for @' + cmd + '{...}' | |
| 306 cmd = '}' + cmd | |
| 307 self.write('}') | |
| 308 if not self.unknown.has_key(cmd): | |
| 309 self.unknown[cmd] = 1 | |
| 310 else: | |
| 311 self.unknown[cmd] = self.unknown[cmd] + 1 | |
| 312 | |
| 313 def unknown_handle(self, cmd): | |
| 314 print '*** No handler for @' + cmd | |
| 315 self.write('@', cmd) | |
| 316 if not self.unknown.has_key(cmd): | |
| 317 self.unknown[cmd] = 1 | |
| 318 else: | |
| 319 self.unknown[cmd] = self.unknown[cmd] + 1 | |
| 320 | |
| 321 # XXX The following sections should be ordered as the texinfo docs | |
| 322 | |
| 323 # --- Embedded @-commands without {} argument list -- | |
| 324 | |
| 325 def handle_noindent(self): pass | |
| 326 | |
| 327 def handle_refill(self): pass | |
| 328 | |
| 329 # --- Include file handling --- | |
| 330 | |
| 331 def do_include(self, args): | |
| 332 file = args | |
| 333 file = os.path.join(self.includedir, file) | |
| 334 try: | |
| 335 fp = open(file, 'r') | |
| 336 except IOError, msg: | |
| 337 print '*** Can\'t open include file', `file` | |
| 338 return | |
| 339 if self.debugging: | |
| 340 print '--> file', `file` | |
| 341 save_done = self.done | |
| 342 save_skip = self.skip | |
| 343 save_stack = self.stack | |
| 344 self.parserest(fp, 0) | |
| 345 fp.close() | |
| 346 self.done = save_done | |
| 347 self.skip = save_skip | |
| 348 self.stack = save_stack | |
| 349 if self.debugging: | |
| 350 print '<-- file', `file` | |
| 351 | |
| 352 # --- Special Insertions --- | |
| 353 | |
| 354 def open_dmn(self): pass | |
| 355 def close_dmn(self): pass | |
| 356 | |
| 357 def open_dots(self): self.write('...') | |
| 358 def close_dots(self): pass | |
| 359 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
360 def open_bullet(self): pass |
| 2551 | 361 def close_bullet(self): pass |
| 362 | |
| 363 def open_TeX(self): self.write('TeX') | |
| 364 def close_TeX(self): pass | |
| 365 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
366 def handle_copyright(self): self.write('(C)') |
| 2551 | 367 |
| 368 def open_minus(self): self.write('-') | |
| 369 def close_minus(self): pass | |
| 370 | |
| 371 # --- Special Glyphs for Examples --- | |
| 372 | |
| 373 def open_result(self): self.write('=>') | |
| 374 def close_result(self): pass | |
| 375 | |
| 376 def open_expansion(self): self.write('==>') | |
| 377 def close_expansion(self): pass | |
| 378 | |
| 379 def open_print(self): self.write('-|') | |
| 380 def close_print(self): pass | |
| 381 | |
| 382 def open_error(self): self.write('error-->') | |
| 383 def close_error(self): pass | |
| 384 | |
| 385 def open_equiv(self): self.write('==') | |
| 386 def close_equiv(self): pass | |
| 387 | |
| 388 def open_point(self): self.write('-!-') | |
| 389 def close_point(self): pass | |
| 390 | |
| 391 # --- Cross References --- | |
| 392 | |
| 393 def open_pxref(self): | |
| 394 self.write('see ') | |
| 395 self.startsaving() | |
| 396 def close_pxref(self): | |
| 397 self.makeref() | |
| 398 | |
| 399 def open_xref(self): | |
| 400 self.write('See ') | |
| 401 self.startsaving() | |
| 402 def close_xref(self): | |
| 403 self.makeref() | |
| 404 | |
| 405 def open_ref(self): | |
| 406 self.startsaving() | |
| 407 def close_ref(self): | |
| 408 self.makeref() | |
| 409 | |
| 410 def open_inforef(self): | |
| 411 self.write('See info file ') | |
| 412 self.startsaving() | |
| 413 def close_inforef(self): | |
| 414 text = self.collectsavings() | |
| 415 args = string.splitfields(text, ',') | |
| 416 n = len(args) | |
| 417 for i in range(n): | |
| 418 args[i] = string.strip(args[i]) | |
| 419 while len(args) < 3: args.append('') | |
| 420 node = args[0] | |
| 421 file = args[2] | |
| 422 self.write('`', file, '\', node `', node, '\'') | |
| 423 | |
| 424 def makeref(self): | |
| 425 text = self.collectsavings() | |
| 426 args = string.splitfields(text, ',') | |
| 427 n = len(args) | |
| 428 for i in range(n): | |
| 429 args[i] = string.strip(args[i]) | |
| 430 while len(args) < 5: args.append('') | |
| 431 nodename = label = args[0] | |
| 432 if args[2]: label = args[2] | |
| 433 file = args[3] | |
| 434 title = args[4] | |
| 435 href = makefile(nodename) | |
| 436 if file: | |
| 437 href = '../' + file + '/' + href | |
| 438 self.write('<A HREF="', href, '">', label, '</A>') | |
| 439 | |
| 440 # --- Marking Words and Phrases --- | |
| 441 | |
| 442 # --- Other @xxx{...} commands --- | |
| 443 | |
| 444 def open_(self): pass # Used by {text enclosed in braces} | |
| 445 def close_(self): pass | |
| 446 | |
| 447 open_asis = open_ | |
| 448 close_asis = close_ | |
| 449 | |
| 450 def open_cite(self): self.write('<CITE>') | |
| 451 def close_cite(self): self.write('</CITE>') | |
| 452 | |
| 453 def open_code(self): self.write('<CODE>') | |
| 454 def close_code(self): self.write('</CODE>') | |
| 455 | |
| 456 open_t = open_code | |
| 457 close_t = close_code | |
| 458 | |
| 459 def open_dfn(self): self.write('<DFN>') | |
| 460 def close_dfn(self): self.write('</DFN>') | |
| 461 | |
| 462 def open_emph(self): self.write('<I>') | |
| 463 def close_emph(self): self.write('</I>') | |
| 464 | |
| 465 open_i = open_emph | |
| 466 close_i = close_emph | |
| 467 | |
| 468 def open_footnote(self): | |
| 469 if self.savetext <> None: | |
| 470 print '*** Recursive footnote -- expect weirdness' | |
| 471 id = len(self.footnotes) + 1 | |
| 472 self.write('<A NAME="footnoteref', `id`, \ | |
| 473 '" HREF="#footnotetext', `id`, '">(', `id`, ')</A>') | |
| 474 self.savetext = '' | |
| 475 | |
| 476 def close_footnote(self): | |
| 477 id = len(self.footnotes) + 1 | |
| 478 self.footnotes.append(`id`, self.savetext) | |
| 479 self.savetext = None | |
| 480 | |
| 481 def writefootnotes(self): | |
| 482 self.write('<H2>---------- Footnotes ----------</H2>\n') | |
| 483 for id, text in self.footnotes: | |
| 484 self.write('<A NAME="footnotetext', id, \ | |
| 485 '" HREF="#footnoteref', id, '">(', \ | |
| 486 id, ')</A>\n', text, '<P>\n') | |
| 487 self.footnotes = [] | |
| 488 | |
| 489 def open_file(self): self.write('<FILE>') | |
| 490 def close_file(self): self.write('</FILE>') | |
| 491 | |
| 492 def open_kbd(self): self.write('<KBD>') | |
| 493 def close_kbd(self): self.write('</KBD>') | |
| 494 | |
| 495 def open_key(self): self.write('<KEY>') | |
| 496 def close_key(self): self.write('</KEY>') | |
| 497 | |
| 498 def open_r(self): self.write('<R>') | |
| 499 def close_r(self): self.write('</R>') | |
| 500 | |
| 501 def open_samp(self): self.write('`<SAMP>') | |
| 502 def close_samp(self): self.write('</SAMP>\'') | |
| 503 | |
| 504 def open_sc(self): self.write('<SMALLCAPS>') | |
| 505 def close_sc(self): self.write('</SMALLCAPS>') | |
| 506 | |
| 507 def open_strong(self): self.write('<B>') | |
| 508 def close_strong(self): self.write('</B>') | |
| 509 | |
| 510 open_b = open_strong | |
| 511 close_b = close_strong | |
| 512 | |
| 513 def open_var(self): self.write('<VAR>') | |
| 514 def close_var(self): self.write('</VAR>') | |
| 515 | |
| 516 def open_w(self): self.write('<NOBREAK>') | |
| 517 def close_w(self): self.write('</NOBREAK>') | |
| 518 | |
| 519 open_titlefont = open_ | |
| 520 close_titlefont = close_ | |
| 521 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
522 def open_small(self): pass |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
523 def close_small(self): pass |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
524 |
| 2551 | 525 def command(self, line): |
| 526 a, b = cmprog.regs[1] | |
| 527 cmd = line[a:b] | |
| 528 args = string.strip(line[b:]) | |
| 529 if self.debugging > 1: | |
| 530 print self.skip, self.stack, '@' + cmd, args | |
| 531 try: | |
| 532 func = getattr(self, 'do_' + cmd) | |
| 533 except AttributeError: | |
| 534 try: | |
| 535 func = getattr(self, 'bgn_' + cmd) | |
| 536 except AttributeError: | |
| 537 self.unknown_cmd(cmd, args) | |
| 538 return | |
| 539 self.stack.append(cmd) | |
| 540 func(args) | |
| 541 return | |
| 542 if not self.skip or cmd == 'end': | |
| 543 func(args) | |
| 544 | |
| 545 def unknown_cmd(self, cmd, args): | |
| 546 print '*** unknown', '@' + cmd, args | |
| 547 if not self.unknown.has_key(cmd): | |
| 548 self.unknown[cmd] = 1 | |
| 549 else: | |
| 550 self.unknown[cmd] = self.unknown[cmd] + 1 | |
| 551 | |
| 552 def do_end(self, args): | |
| 553 words = string.split(args) | |
| 554 if not words: | |
| 555 print '*** @end w/o args' | |
| 556 else: | |
| 557 cmd = words[0] | |
| 558 if not self.stack or self.stack[-1] <> cmd: | |
| 559 print '*** @end', cmd, 'unexpected' | |
| 560 else: | |
| 561 del self.stack[-1] | |
| 562 try: | |
| 563 func = getattr(self, 'end_' + cmd) | |
| 564 except AttributeError: | |
| 565 self.unknown_end(cmd) | |
| 566 return | |
| 567 func() | |
| 568 | |
| 569 def unknown_end(self, cmd): | |
| 570 cmd = 'end ' + cmd | |
| 571 print '*** unknown', '@' + cmd | |
| 572 if not self.unknown.has_key(cmd): | |
| 573 self.unknown[cmd] = 1 | |
| 574 else: | |
| 575 self.unknown[cmd] = self.unknown[cmd] + 1 | |
| 576 | |
| 577 # --- Comments --- | |
| 578 | |
| 579 def do_comment(self, args): pass | |
| 580 do_c = do_comment | |
| 581 | |
| 582 # --- Conditional processing --- | |
| 583 | |
| 584 def bgn_ifinfo(self, args): pass | |
| 585 def end_ifinfo(self): pass | |
| 586 | |
| 587 def bgn_iftex(self, args): self.skip = self.skip + 1 | |
| 588 def end_iftex(self): self.skip = self.skip - 1 | |
| 589 | |
| 590 def bgn_ignore(self, args): self.skip = self.skip + 1 | |
| 591 def end_ignore(self): self.skip = self.skip - 1 | |
| 592 | |
| 593 def bgn_tex(self, args): self.skip = self.skip + 1 | |
| 594 def end_tex(self): self.skip = self.skip - 1 | |
| 595 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
596 def bgn_set(self, args): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
597 if args not in self.goodset: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
598 self.gooset.append(args) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
599 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
600 def bgn_clear(self, args): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
601 if args in self.goodset: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
602 self.gooset.remove(args) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
603 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
604 def bgn_ifset(self, args): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
605 if args not in self.goodset: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
606 self.skip = self.skip + 1 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
607 self.stackinfo[len(self.stack)] = 1 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
608 else: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
609 self.stackinfo[len(self.stack)] = 0 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
610 def end_ifset(self): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
611 print self.stack |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
612 print self.stackinfo |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
613 if self.stackinfo[len(self.stack) + 1]: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
614 self.skip = self.skip - 1 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
615 del self.stackinfo[len(self.stack) + 1] |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
616 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
617 def bgn_ifclear(self, args): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
618 if args in self.goodset: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
619 self.skip = self.skip + 1 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
620 self.stackinfo[len(self.stack)] = 1 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
621 else: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
622 self.stackinfo[len(self.stack)] = 0 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
623 |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
624 end_ifclear = end_ifset |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
625 |
| 2551 | 626 # --- Beginning a file --- |
| 627 | |
| 628 do_finalout = do_comment | |
| 629 do_setchapternewpage = do_comment | |
| 630 do_setfilename = do_comment | |
| 631 | |
| 632 def do_settitle(self, args): | |
| 633 self.title = args | |
| 634 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
635 def do_parskip(self, args): pass |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
636 |
| 2551 | 637 # --- Ending a file --- |
| 638 | |
| 639 def do_bye(self, args): | |
| 640 self.done = 1 | |
| 641 | |
| 642 # --- Title page --- | |
| 643 | |
| 644 def bgn_titlepage(self, args): self.skip = self.skip + 1 | |
| 645 def end_titlepage(self): self.skip = self.skip - 1 | |
| 646 | |
| 647 def do_center(self, args): | |
| 648 # Actually not used outside title page... | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
649 self.write('<H1>') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
650 self.expand (args) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
651 self.write ('</H1>\n') |
| 2551 | 652 do_title = do_center |
| 653 do_subtitle = do_center | |
| 654 do_author = do_center | |
| 655 | |
| 656 do_vskip = do_comment | |
| 657 do_vfill = do_comment | |
| 658 do_smallbook = do_comment | |
| 659 | |
| 660 do_paragraphindent = do_comment | |
| 661 do_setchapternewpage = do_comment | |
| 662 do_headings = do_comment | |
| 663 do_footnotestyle = do_comment | |
| 664 | |
| 665 do_evenheading = do_comment | |
| 666 do_evenfooting = do_comment | |
| 667 do_oddheading = do_comment | |
| 668 do_oddfooting = do_comment | |
| 669 do_everyheading = do_comment | |
| 670 do_everyfooting = do_comment | |
| 671 | |
| 672 # --- Nodes --- | |
| 673 | |
| 674 def do_node(self, args): | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
675 self.endnode() |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
676 self.nodelineno = 0 |
| 2551 | 677 parts = string.splitfields(args, ',') |
| 678 while len(parts) < 4: parts.append('') | |
| 679 for i in range(4): parts[i] = string.strip(parts[i]) | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
680 self.nodelinks = parts |
| 2551 | 681 [name, next, prev, up] = parts[:4] |
| 682 file = self.dirname + '/' + makefile(name) | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
683 if self.filenames.has_key(file): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
684 print '*** Filename already in use: ', file |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
685 else: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
686 if self.debugging: print '--- writing', file |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
687 self.filenames[file] = 1 |
| 2551 | 688 self.nodefp = open(file, 'w') |
| 689 self.nodename = name | |
| 690 if not self.topname: self.topname = name | |
| 691 title = name | |
| 692 if self.title: title = title + ' -- ' + self.title | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
693 # No idea what this means, but this is what latex2html writes |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
694 self.write('<!DOCTYPE HTML PUBLIC "-//W3O//DTD W3 HTML 2.0//EN">\n') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
695 self.write('<!- Converted with texi2html and Python>\n') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
696 self.write ('<P>\n<HEAD>\n') |
| 2551 | 697 self.write('<TITLE>', title, '</TITLE>\n') |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
698 self.write ('</HEAD>\n<BODY>\n<P>\n<BR> <HR>\n') |
| 2551 | 699 self.link('Next', next) |
| 700 self.link('Prev', prev) | |
| 701 self.link('Up', up) | |
| 702 if self.nodename <> self.topname: | |
| 703 self.link('Top', self.topname) | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
704 self.write ('<BR> <HR> <P>\n') |
| 2551 | 705 |
| 706 def link(self, label, nodename): | |
| 707 if nodename: | |
| 708 if string.lower(nodename) == '(dir)': | |
| 709 addr = '../dir.html' | |
| 710 else: | |
| 711 addr = makefile(nodename) | |
| 712 self.write(label, ': <A HREF="', addr, '" TYPE="', \ | |
| 713 label, '">', nodename, '</A> \n') | |
| 714 | |
| 715 # --- Sectioning commands --- | |
| 716 | |
| 717 def do_chapter(self, args): | |
| 718 self.heading('H1', args, 0) | |
| 719 def do_unnumbered(self, args): | |
| 720 self.heading('H1', args, -1) | |
| 721 def do_appendix(self, args): | |
| 722 self.heading('H1', args, -1) | |
| 723 def do_top(self, args): | |
| 724 self.heading('H1', args, -1) | |
| 725 def do_chapheading(self, args): | |
| 726 self.heading('H1', args, -1) | |
| 727 def do_majorheading(self, args): | |
| 728 self.heading('H1', args, -1) | |
| 729 | |
| 730 def do_section(self, args): | |
| 731 self.heading('H1', args, 1) | |
| 732 def do_unnumberedsec(self, args): | |
| 733 self.heading('H1', args, -1) | |
| 734 def do_appendixsec(self, args): | |
| 735 self.heading('H1', args, -1) | |
| 736 do_appendixsection = do_appendixsec | |
| 737 def do_heading(self, args): | |
| 738 self.heading('H1', args, -1) | |
| 739 | |
| 740 def do_subsection(self, args): | |
| 741 self.heading('H2', args, 2) | |
| 742 def do_unnumberedsubsec(self, args): | |
| 743 self.heading('H2', args, -1) | |
| 744 def do_appendixsubsec(self, args): | |
| 745 self.heading('H2', args, -1) | |
| 746 def do_subheading(self, args): | |
| 747 self.heading('H2', args, -1) | |
| 748 | |
| 749 def do_subsubsection(self, args): | |
| 750 self.heading('H3', args, 3) | |
| 751 def do_unnumberedsubsubsec(self, args): | |
| 752 self.heading('H3', args, -1) | |
| 753 def do_appendixsubsubsec(self, args): | |
| 754 self.heading('H3', args, -1) | |
| 755 def do_subsubheading(self, args): | |
| 756 self.heading('H3', args, -1) | |
| 757 | |
| 758 def heading(self, type, args, level): | |
| 759 if level >= 0: | |
| 760 while len(self.numbering) <= level: | |
| 761 self.numbering.append(0) | |
| 762 del self.numbering[level+1:] | |
| 763 self.numbering[level] = self.numbering[level] + 1 | |
| 764 x = '' | |
| 765 for i in self.numbering: | |
| 766 x = x + `i` + '.' | |
| 767 args = x + ' ' + args | |
| 768 self.contents.append(level, args, self.nodename) | |
| 769 self.write('<', type, '>') | |
| 770 self.expand(args) | |
| 771 self.write('</', type, '>\n') | |
| 772 if self.debugging: | |
| 773 print '---', args | |
| 774 | |
| 775 def do_contents(self, args): | |
| 776 pass | |
| 777 # self.listcontents('Table of Contents', 999) | |
| 778 | |
| 779 def do_shortcontents(self, args): | |
| 780 pass | |
| 781 # self.listcontents('Short Contents', 0) | |
| 782 do_summarycontents = do_shortcontents | |
| 783 | |
| 784 def listcontents(self, title, maxlevel): | |
| 785 self.write('<H1>', title, '</H1>\n<UL COMPACT>\n') | |
| 786 for level, title, node in self.contents: | |
| 787 if level <= maxlevel: | |
| 788 self.write('<LI>', '. '*level, '<A HREF="', \ | |
| 789 makefile(node), '">') | |
| 790 self.expand(title) | |
| 791 self.write('</A> ', node, '\n') | |
| 792 self.write('</UL>\n') | |
| 793 | |
| 794 # --- Page lay-out --- | |
| 795 | |
| 796 # These commands are only meaningful in printed text | |
| 797 | |
| 798 def do_page(self, args): pass | |
| 799 | |
| 800 def do_need(self, args): pass | |
| 801 | |
| 802 def bgn_group(self, args): pass | |
| 803 def end_group(self): pass | |
| 804 | |
| 805 # --- Line lay-out --- | |
| 806 | |
| 807 def do_sp(self, args): | |
| 808 # Insert <args> blank lines | |
| 809 if args: | |
| 810 try: | |
| 811 n = string.atoi(args) | |
| 812 except string.atoi_error: | |
| 813 n = 1 | |
| 814 else: | |
| 815 n = 1 | |
| 816 self.write('<P>\n'*max(n, 0)) | |
| 817 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
818 def do_hline(self, args): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
819 self.write ('<HR>') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
820 |
| 2551 | 821 # --- Function and variable definitions --- |
| 822 | |
| 823 def bgn_deffn(self, args): | |
| 824 self.write('<DL><DT>') | |
| 825 words = splitwords(args, 2) | |
| 826 [category, name], rest = words[:2], words[2:] | |
| 827 self.expand('@b{' + name + '}') | |
| 828 for word in rest: self.expand(' ' + makevar(word)) | |
| 829 self.expand(' -- ' + category) | |
| 830 self.write('<DD>\n') | |
| 831 self.index('fn', name) | |
| 832 | |
| 833 def end_deffn(self): | |
| 834 self.write('</DL>\n') | |
| 835 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
836 def do_deffnx(self, args): |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
837 self.write('<DT>') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
838 words = splitwords(args, 2) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
839 [category, name], rest = words[:2], words[2:] |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
840 self.expand('@b{' + name + '}') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
841 for word in rest: self.expand(' ' + makevar(word)) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
842 self.expand(' -- ' + category) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
843 self.write('<DD>\n') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
844 self.index('fn', name) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
845 |
| 2551 | 846 def bgn_defun(self, args): self.bgn_deffn('Function ' + args) |
| 847 end_defun = end_deffn | |
| 848 | |
| 849 def bgn_defmac(self, args): self.bgn_deffn('Macro ' + args) | |
| 850 end_defmac = end_deffn | |
| 851 | |
| 852 def bgn_defspec(self, args): self.bgn_deffn('{Special Form} ' + args) | |
| 853 end_defspec = end_deffn | |
| 854 | |
| 855 def bgn_defvr(self, args): | |
| 856 self.write('<DL><DT>') | |
| 857 words = splitwords(args, 2) | |
| 858 [category, name], rest = words[:2], words[2:] | |
| 859 self.expand('@code{' + name + '}') | |
| 860 # If there are too many arguments, show them | |
| 861 for word in rest: self.expand(' ' + word) | |
| 862 self.expand(' -- ' + category) | |
| 863 self.write('<DD>\n') | |
| 864 self.index('vr', name) | |
| 865 | |
| 866 end_defvr = end_deffn | |
| 867 | |
| 868 def bgn_defvar(self, args): self.bgn_defvr('Variable ' + args) | |
| 869 end_defvar = end_defvr | |
| 870 | |
| 871 def bgn_defopt(self, args): self.bgn_defvr('{User Option} ' + args) | |
| 872 end_defopt = end_defvr | |
| 873 | |
| 874 # --- Ditto for typed languages --- | |
| 875 | |
| 876 def bgn_deftypefn(self, args): | |
| 877 self.write('<DL><DT>') | |
| 878 words = splitwords(args, 3) | |
| 879 [category, datatype, name], rest = words[:3], words[3:] | |
| 880 self.expand('@code{' + datatype + '} @b{' + name + '}') | |
| 881 for word in rest: self.expand(' ' + makevar(word)) | |
| 882 self.expand(' -- ' + category) | |
| 883 self.write('<DD>\n') | |
| 884 self.index('fn', name) | |
| 885 | |
| 886 end_deftypefn = end_deffn | |
| 887 | |
| 888 def bgn_deftypefun(self, args): self.bgn_deftypefn('Function ' + args) | |
| 889 end_deftypefun = end_deftypefn | |
| 890 | |
| 891 def bgn_deftypevr(self, args): | |
| 892 words = splitwords(args, 3) | |
| 893 [category, datatype, name], rest = words[:3], words[3:] | |
| 894 self.write('<DL><DT>') | |
| 895 self.expand('@code{' + datatype + '} @b{' + name + '}') | |
| 896 # If there are too many arguments, show them | |
| 897 for word in rest: self.expand(' ' + word) | |
| 898 self.expand(' -- ' + category) | |
| 899 self.write('<DD>\n') | |
| 900 self.index('fn', name) | |
| 901 | |
| 902 end_deftypevr = end_deftypefn | |
| 903 | |
| 904 def bgn_deftypevar(self, args): | |
| 905 self.bgn_deftypevr('Variable ' + args) | |
| 906 end_deftypevar = end_deftypevr | |
| 907 | |
| 908 # --- Ditto for object-oriented languages --- | |
| 909 | |
| 910 def bgn_defcv(self, args): | |
| 911 words = splitwords(args, 3) | |
| 912 [category, classname, name], rest = words[:3], words[3:] | |
| 913 self.write('<DL><DT>') | |
| 914 self.expand('@b{' + name + '}') | |
| 915 # If there are too many arguments, show them | |
| 916 for word in rest: self.expand(' ' + word) | |
| 917 self.expand(' -- ' + category + ' of ' + classname) | |
| 918 self.write('<DD>\n') | |
| 919 self.index('vr', name + ' @r{of ' + classname + '}') | |
| 920 | |
| 921 end_defcv = end_deftypevr | |
| 922 | |
| 923 def bgn_defivar(self, args): | |
| 924 self.bgn_defcv('{Instance Variable} ' + args) | |
| 925 end_defivar = end_defcv | |
| 926 | |
| 927 def bgn_defop(self, args): | |
| 928 self.write('<DL><DT>') | |
| 929 words = splitwords(args, 3) | |
| 930 [category, classname, name], rest = words[:3], words[3:] | |
| 931 self.expand('@b{' + name + '}') | |
| 932 for word in rest: self.expand(' ' + makevar(word)) | |
| 933 self.expand(' -- ' + category + ' on ' + classname) | |
| 934 self.write('<DD>\n') | |
| 935 self.index('fn', name + ' @r{on ' + classname + '}') | |
| 936 | |
| 937 end_defop = end_defcv | |
| 938 | |
| 939 def bgn_defmethod(self, args): | |
| 940 self.bgn_defop('Method ' + args) | |
| 941 end_defmethod = end_defop | |
| 942 | |
| 943 # --- Ditto for data types --- | |
| 944 | |
| 945 def bgn_deftp(self, args): | |
| 946 self.write('<DL><DT>') | |
| 947 words = splitwords(args, 2) | |
| 948 [category, name], rest = words[:2], words[2:] | |
| 949 self.expand('@b{' + name + '}') | |
| 950 for word in rest: self.expand(' ' + word) | |
| 951 self.expand(' -- ' + category) | |
| 952 self.write('<DD>\n') | |
| 953 self.index('tp', name) | |
| 954 | |
| 955 end_deftp = end_defcv | |
| 956 | |
| 957 # --- Making Lists and Tables | |
| 958 | |
| 959 def bgn_enumerate(self, args): | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
960 if not args: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
961 self.write('<OL>\n') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
962 self.stackinfo[len(self.stack)] = '</OL>\n' |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
963 else: |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
964 self.itemnumber = args |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
965 self.write('<UL>\n') |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
966 self.stackinfo[len(self.stack)] = '</UL>\n' |
| 2551 | 967 def end_enumerate(self): |
| 968 self.itemnumber = None | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
969 self.write(self.stackinfo[len(self.stack) + 1]) |
|
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
970 del self.stackinfo[len(self.stack) + 1] |
| 2551 | 971 |
| 972 def bgn_itemize(self, args): | |
| 973 self.itemarg = args | |
| 974 self.write('<UL>\n') | |
| 975 def end_itemize(self): | |
| 976 self.itemarg = None | |
| 977 self.write('</UL>\n') | |
| 978 | |
| 979 def bgn_table(self, args): | |
| 980 self.itemarg = args | |
| 981 self.write('<DL>\n') | |
| 982 def end_table(self): | |
| 983 self.itemarg = None | |
| 984 self.write('</DL>\n') | |
| 985 | |
| 986 def bgn_ftable(self, args): | |
| 987 self.itemindex = 'fn' | |
| 988 self.bgn_table(args) | |
| 989 def end_ftable(self): | |
| 990 self.itemindex = None | |
| 991 self.end_table() | |
| 992 | |
| 993 def do_item(self, args): | |
| 994 if self.itemindex: self.index(self.itemindex, args) | |
| 995 if self.itemarg: | |
| 996 if self.itemarg[0] == '@' and self.itemarg[1:2] and \ | |
| 997 self.itemarg[1] in string.letters: | |
| 998 args = self.itemarg + '{' + args + '}' | |
| 999 else: | |
| 1000 # some other character, e.g. '-' | |
| 1001 args = self.itemarg + ' ' + args | |
| 1002 if self.itemnumber <> None: | |
| 1003 args = self.itemnumber + '. ' + args | |
| 1004 self.itemnumber = increment(self.itemnumber) | |
| 1005 if self.stack and self.stack[-1] == 'table': | |
| 1006 self.write('<DT>') | |
| 1007 self.expand(args) | |
| 1008 self.write('<DD>') | |
| 1009 else: | |
| 1010 self.write('<LI>') | |
| 1011 self.expand(args) | |
| 1012 self.write(' ') | |
| 1013 do_itemx = do_item # XXX Should suppress leading blank line | |
| 1014 | |
| 1015 # --- Enumerations, displays, quotations --- | |
| 1016 # XXX Most of these should increase the indentation somehow | |
| 1017 | |
| 1018 def bgn_quotation(self, args): self.write('<P>') | |
| 1019 def end_quotation(self): self.write('<P>\n') | |
| 1020 | |
| 1021 def bgn_example(self, args): | |
| 1022 self.nofill = self.nofill + 1 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1023 self.write('<PRE><CODE>') |
| 2551 | 1024 def end_example(self): |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1025 self.write('</CODE></PRE>') |
| 2551 | 1026 self.nofill = self.nofill - 1 |
| 1027 | |
| 1028 bgn_lisp = bgn_example # Synonym when contents are executable lisp code | |
| 1029 end_lisp = end_example | |
| 1030 | |
| 1031 bgn_smallexample = bgn_example # XXX Should use smaller font | |
| 1032 end_smallexample = end_example | |
| 1033 | |
| 1034 bgn_smalllisp = bgn_lisp # Ditto | |
| 1035 end_smalllisp = end_lisp | |
| 1036 | |
| 1037 def bgn_display(self, args): | |
| 1038 self.nofill = self.nofill + 1 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1039 self.write('<PRE>\n') |
| 2551 | 1040 def end_display(self): |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1041 self.write('</PRE>\n') |
| 2551 | 1042 self.nofill = self.nofill - 1 |
| 1043 | |
| 1044 def bgn_format(self, args): | |
| 1045 self.nofill = self.nofill + 1 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1046 self.write('<PRE><CODE>\n') |
| 2551 | 1047 def end_format(self): |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1048 self.write('</CODE></PRE>\n') |
| 2551 | 1049 self.nofill = self.nofill - 1 |
| 1050 | |
| 1051 def do_exdent(self, args): self.expand(args + '\n') | |
| 1052 # XXX Should really mess with indentation | |
| 1053 | |
| 1054 def bgn_flushleft(self, args): | |
| 1055 self.nofill = self.nofill + 1 | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1056 self.write('<PRE>\n') |
| 2551 | 1057 def end_flushleft(self): |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1058 self.write('</PRE>\n') |
| 2551 | 1059 self.nofill = self.nofill - 1 |
| 1060 | |
| 1061 def bgn_flushright(self, args): | |
| 1062 self.nofill = self.nofill + 1 | |
| 1063 self.write('<ADDRESS COMPACT>\n') | |
| 1064 def end_flushright(self): | |
| 1065 self.write('</ADDRESS>\n') | |
| 1066 self.nofill = self.nofill - 1 | |
| 1067 | |
| 1068 def bgn_menu(self, args): self.write('<H2>Menu</H2><DL COMPACT>\n') | |
| 1069 def end_menu(self): self.write('</DL>\n') | |
| 1070 | |
| 1071 def bgn_cartouche(self, args): pass | |
| 1072 def end_cartouche(self): pass | |
| 1073 | |
| 1074 # --- Indices --- | |
| 1075 | |
| 1076 def resetindex(self): | |
| 1077 self.noncodeindices = ['cp'] | |
| 1078 self.indextitle = {} | |
| 1079 self.indextitle['cp'] = 'Concept' | |
| 1080 self.indextitle['fn'] = 'Function' | |
| 1081 self.indextitle['ky'] = 'Keyword' | |
| 1082 self.indextitle['pg'] = 'Program' | |
| 1083 self.indextitle['tp'] = 'Type' | |
| 1084 self.indextitle['vr'] = 'Variable' | |
| 1085 # | |
| 1086 self.whichindex = {} | |
| 1087 for name in self.indextitle.keys(): | |
| 1088 self.whichindex[name] = [] | |
| 1089 | |
| 1090 def user_index(self, name, args): | |
| 1091 if self.whichindex.has_key(name): | |
| 1092 self.index(name, args) | |
| 1093 else: | |
| 1094 print '*** No index named', `name` | |
| 1095 | |
| 1096 def do_cindex(self, args): self.index('cp', args) | |
| 1097 def do_findex(self, args): self.index('fn', args) | |
| 1098 def do_kindex(self, args): self.index('ky', args) | |
| 1099 def do_pindex(self, args): self.index('pg', args) | |
| 1100 def do_tindex(self, args): self.index('tp', args) | |
| 1101 def do_vindex(self, args): self.index('vr', args) | |
| 1102 | |
| 1103 def index(self, name, args): | |
| 1104 self.whichindex[name].append(args, self.nodename) | |
| 1105 | |
| 1106 def do_synindex(self, args): | |
| 1107 words = string.split(args) | |
| 1108 if len(words) <> 2: | |
| 1109 print '*** bad @synindex', args | |
| 1110 return | |
| 1111 [old, new] = words | |
| 1112 if not self.whichindex.has_key(old) or \ | |
| 1113 not self.whichindex.has_key(new): | |
| 1114 print '*** bad key(s) in @synindex', args | |
| 1115 return | |
| 1116 if old <> new and \ | |
| 1117 self.whichindex[old] is not self.whichindex[new]: | |
| 1118 inew = self.whichindex[new] | |
| 1119 inew[len(inew):] = self.whichindex[old] | |
| 1120 self.whichindex[old] = inew | |
| 1121 do_syncodeindex = do_synindex # XXX Should use code font | |
| 1122 | |
| 1123 def do_printindex(self, args): | |
| 1124 words = string.split(args) | |
| 1125 for name in words: | |
| 1126 if self.whichindex.has_key(name): | |
| 1127 self.prindex(name) | |
| 1128 else: | |
| 1129 print '*** No index named', `name` | |
| 1130 | |
| 1131 def prindex(self, name): | |
| 1132 iscodeindex = (name not in self.noncodeindices) | |
| 1133 index = self.whichindex[name] | |
| 1134 if not index: return | |
| 1135 if self.debugging: | |
| 1136 print '--- Generating', self.indextitle[name], 'index' | |
| 1137 # The node already provides a title | |
| 1138 index1 = [] | |
| 1139 junkprog = regex.compile('^\(@[a-z]+\)?{') | |
| 1140 for key, node in index: | |
| 1141 sortkey = string.lower(key) | |
| 1142 # Remove leading `@cmd{' from sort key | |
| 1143 # -- don't bother about the matching `}' | |
| 1144 oldsortkey = sortkey | |
| 1145 while 1: | |
| 1146 i = junkprog.match(sortkey) | |
| 1147 if i < 0: break | |
| 1148 sortkey = sortkey[i:] | |
| 1149 index1.append(sortkey, key, node) | |
| 1150 del index[:] | |
| 1151 index1.sort() | |
| 1152 self.write('<DL COMPACT>\n') | |
| 1153 for sortkey, key, node in index1: | |
| 1154 if self.debugging > 1: print key, ':', node | |
| 1155 self.write('<DT>') | |
| 1156 if iscodeindex: key = '@code{' + key + '}' | |
| 1157 self.expand(key) | |
| 1158 self.write('<DD><A HREF="', makefile(node), \ | |
| 1159 '">', node, '</A>\n') | |
| 1160 self.write('</DL>\n') | |
| 1161 | |
| 1162 # --- Final error reports --- | |
| 1163 | |
| 1164 def report(self): | |
| 1165 if self.unknown: | |
| 1166 print '--- Unrecognized commands ---' | |
| 1167 cmds = self.unknown.keys() | |
| 1168 cmds.sort() | |
| 1169 for cmd in cmds: | |
| 1170 print string.ljust(cmd, 20), self.unknown[cmd] | |
| 1171 | |
| 1172 | |
| 1173 # Put @var{} around alphabetic substrings | |
| 1174 def makevar(str): | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1175 return '@var{'+str+'}' |
| 2551 | 1176 |
| 1177 | |
| 1178 # Split a string in "words" according to findwordend | |
| 1179 def splitwords(str, minlength): | |
| 1180 words = [] | |
| 1181 i = 0 | |
| 1182 n = len(str) | |
| 1183 while i < n: | |
| 1184 while i < n and str[i] in ' \t\n': i = i+1 | |
| 1185 if i >= n: break | |
| 1186 start = i | |
| 1187 i = findwordend(str, i, n) | |
| 1188 words.append(str[start:i]) | |
| 1189 while len(words) < minlength: words.append('') | |
| 1190 return words | |
| 1191 | |
| 1192 | |
| 1193 # Find the end of a "word", matching braces and interpreting @@ @{ @} | |
| 1194 fwprog = regex.compile('[@{} ]') | |
| 1195 def findwordend(str, i, n): | |
| 1196 level = 0 | |
| 1197 while i < n: | |
| 1198 i = fwprog.search(str, i) | |
| 1199 if i < 0: break | |
| 1200 c = str[i]; i = i+1 | |
| 1201 if c == '@': i = i+1 # Next character is not special | |
| 1202 elif c == '{': level = level+1 | |
| 1203 elif c == '}': level = level-1 | |
| 1204 elif c == ' ' and level <= 0: return i-1 | |
| 1205 return n | |
| 1206 | |
| 1207 | |
| 1208 # Convert a node name into a file name | |
| 1209 def makefile(nodename): | |
|
2705
9ed45dbf2765
mods by Gregor Schmid -- very nice!
Guido van Rossum <guido@python.org>
parents:
2551
diff
changeset
|
1210 return fixfunnychars(nodename) + '.html' |
| 2551 | 1211 |
| 1212 | |
| 1213 # Characters that are perfectly safe in filenames and hyperlinks | |
| 1214 goodchars = string.letters + string.digits + '!@-_=+.' | |
| 1215 | |
| 1216 # Replace characters that aren't perfectly safe by underscores | |
| 1217 def fixfunnychars(addr): | |
| 1218 i = 0 | |
| 1219 while i < len(addr): | |
| 1220 c = addr[i] | |
| 1221 if c not in goodchars: | |
| 1222 c = '_' | |
| 1223 addr = addr[:i] + c + addr[i+1:] | |
| 1224 i = i + len(c) | |
| 1225 return addr | |
| 1226 | |
| 1227 | |
| 1228 # Increment a string used as an enumeration | |
| 1229 def increment(s): | |
| 1230 if not s: | |
| 1231 return '1' | |
| 1232 for sequence in string.digits, string.lowercase, string.uppercase: | |
| 1233 lastc = s[-1] | |
| 1234 if lastc in sequence: | |
| 1235 i = string.index(sequence, lastc) + 1 | |
| 1236 if i >= len(sequence): | |
| 1237 if len(s) == 1: | |
| 1238 s = sequence[0]*2 | |
| 1239 if s == '00': | |
| 1240 s = '10' | |
| 1241 else: | |
| 1242 s = increment(s[:-1]) + sequence[0] | |
| 1243 else: | |
| 1244 s = s[:-1] + sequence[i] | |
| 1245 return s | |
| 1246 return s # Don't increment | |
| 1247 | |
| 1248 | |
| 1249 def test(): | |
| 1250 import sys | |
| 1251 parser = TexinfoParser() | |
| 1252 while sys.argv[1:2] == ['-d']: | |
| 1253 parser.debugging = parser.debugging + 1 | |
| 1254 del sys.argv[1:2] | |
| 1255 if len(sys.argv) <> 3: | |
| 1256 print 'usage: texi2html [-d] [-d] inputfile outputdirectory' | |
| 1257 sys.exit(2) | |
| 1258 file = sys.argv[1] | |
| 1259 parser.setdirname(sys.argv[2]) | |
| 1260 if file == '-': | |
| 1261 fp = sys.stdin | |
| 1262 else: | |
| 1263 parser.setincludedir(os.path.dirname(file)) | |
| 1264 try: | |
| 1265 fp = open(file, 'r') | |
| 1266 except IOError, msg: | |
| 1267 print file, ':', msg | |
| 1268 sys.exit(1) | |
| 1269 parser.parse(fp) | |
| 1270 fp.close() | |
| 1271 parser.report() | |
| 1272 | |
| 1273 | |
| 1274 test() |
