Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython3 / 903a65d7f15d0e81fb622b7c42f93f9368bebbe5 / . / Tools / scripts / texi2html.py
blob: 86229f2ad36418c7535cffe4714f4c6c6c8e63d4 [file] [log] [blame]
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]1#! /usr/bin/env python
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]2
3# Convert GNU texinfo files into HTML, one file per node.
4# Based on Texinfo 2.14.
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]5# Usage: texi2html [-d] [-d] [-c] inputfile outputdirectory
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]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):
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]20# - @defindex (hard)
21# - @c(omment) in the middle of a line (rarely used)
22# - @this* (not really needed, only used in headers anyway)
23# - @today{} (ever used outside title page?)
24
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]25# More consistent handling of chapters/sections/etc.
26# Lots of documentation
27# Many more options:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]28# -top designate top node
29# -links customize which types of links are included
30# -split split at chapters or sections instead of nodes
31# -name Allow different types of filename handling. Non unix systems
32# will have problems with long node names
33# ...
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]34# Support the most recent texinfo version and take a good look at HTML 3.0
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]35# More debugging output (customizable) and more flexible error handling
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]36# How about icons ?
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]37
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]38# rpyron 2002-05-07
39# Robert Pyron <rpyron@alum.mit.edu>
40# 1. BUGFIX: In function makefile(), strip blanks from the nodename.
Mark Dickinson934896d2009-02-21 20:59:32 +0000[diff] [blame]41# This is necessary to match the behavior of parser.makeref() and
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]42# parser.do_node().
43# 2. BUGFIX fixed KeyError in end_ifset (well, I may have just made
44# it go away, rather than fix it)
45# 3. BUGFIX allow @menu and menu items inside @ifset or @ifclear
46# 4. Support added for:
47# @uref URL reference
48# @image image file reference (see note below)
49# @multitable output an HTML table
50# @vtable
51# 5. Partial support for accents, to match MAKEINFO output
52# 6. I added a new command-line option, '-H basename', to specify
53# HTML Help output. This will cause three files to be created
54# in the current directory:
55# `basename`.hhp HTML Help Workshop project file
56# `basename`.hhc Contents file for the project
57# `basename`.hhk Index file for the project
58# When fed into HTML Help Workshop, the resulting file will be
59# named `basename`.chm.
60# 7. A new class, HTMLHelp, to accomplish item 6.
61# 8. Various calls to HTMLHelp functions.
62# A NOTE ON IMAGES: Just as 'outputdirectory' must exist before
63# running this program, all referenced images must already exist
64# in outputdirectory.
65
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]66import os
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]67import sys
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]68import string
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]69import re
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]70
71MAGIC = '\\input texinfo'
72
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]73cmprog = re.compile('^@([a-z]+)([ \t]|$)') # Command (line-oriented)
74blprog = re.compile('^[ \t]*$') # Blank line
75kwprog = re.compile('@[a-z]+') # Keyword (embedded, usually
76 # with {} args)
77spprog = re.compile('[\n@{}&<>]') # Special characters in
Tim Peters70c43782001-01-17 08:48:39 +0000[diff] [blame]78 # running text
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]79 #
80 # menu item (Yuck!)
81miprog = re.compile('^\* ([^:]*):(:|[ \t]*([^\t,\n.]+)([^ \t\n]*))[ \t\n]*')
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]82# 0 1 1 2 3 34 42 0
83# ----- ---------- ---------
84# -|-----------------------------
85# -----------------------------------------------------
86
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]87
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]88
Tim Peters70c43782001-01-17 08:48:39 +0000[diff] [blame]89
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]90class HTMLNode:
91 """Some of the parser's functionality is separated into this class.
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]92
93 A Node accumulates its contents, takes care of links to other Nodes
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]94 and saves itself when it is finished and all links are resolved.
95 """
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]96
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]97 DOCTYPE = '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">'
98
99 type = 0
100 cont = ''
101 epilogue = '</BODY></HTML>\n'
102
103 def __init__(self, dir, name, topname, title, next, prev, up):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]104 self.dirname = dir
105 self.name = name
106 if topname:
107 self.topname = topname
108 else:
109 self.topname = name
110 self.title = title
111 self.next = next
112 self.prev = prev
113 self.up = up
114 self.lines = []
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]115
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]116 def write(self, *lines):
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]117 for line in lines:
118 self.lines.append(line)
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]119
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]120 def flush(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]121 fp = open(self.dirname + '/' + makefile(self.name), 'w')
122 fp.write(self.prologue)
123 fp.write(self.text)
124 fp.write(self.epilogue)
125 fp.close()
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]126
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]127 def link(self, label, nodename, rel=None, rev=None):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]128 if nodename:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]129 if nodename.lower() == '(dir)':
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]130 addr = '../dir.html'
131 title = ''
132 else:
133 addr = makefile(nodename)
134 title = ' TITLE="%s"' % nodename
135 self.write(label, ': <A HREF="', addr, '"', \
136 rel and (' REL=' + rel) or "", \
137 rev and (' REV=' + rev) or "", \
138 title, '>', nodename, '</A> \n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]139
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]140 def finalize(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]141 length = len(self.lines)
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]142 self.text = ''.join(self.lines)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]143 self.lines = []
144 self.open_links()
145 self.output_links()
146 self.close_links()
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]147 links = ''.join(self.lines)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]148 self.lines = []
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]149 self.prologue = (
150 self.DOCTYPE +
151 '\n<HTML><HEAD>\n'
152 ' <!-- Converted with texi2html and Python -->\n'
153 ' <TITLE>' + self.title + '</TITLE>\n'
154 ' <LINK REL=Next HREF="'
155 + makefile(self.next) + '" TITLE="' + self.next + '">\n'
156 ' <LINK REL=Previous HREF="'
157 + makefile(self.prev) + '" TITLE="' + self.prev + '">\n'
158 ' <LINK REL=Up HREF="'
159 + makefile(self.up) + '" TITLE="' + self.up + '">\n'
160 '</HEAD><BODY>\n' +
161 links)
162 if length > 20:
163 self.epilogue = '<P>\n%s</BODY></HTML>\n' % links
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]164
165 def open_links(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]166 self.write('<HR>\n')
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]167
168 def close_links(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]169 self.write('<HR>\n')
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]170
171 def output_links(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]172 if self.cont != self.next:
173 self.link(' Cont', self.cont)
174 self.link(' Next', self.next, rel='Next')
175 self.link(' Prev', self.prev, rel='Previous')
176 self.link(' Up', self.up, rel='Up')
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]177 if self.name != self.topname:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]178 self.link(' Top', self.topname)
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]179
180
181class HTML3Node(HTMLNode):
182
183 DOCTYPE = '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML Level 3//EN//3.0">'
184
185 def open_links(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]186 self.write('<DIV CLASS=Navigation>\n <HR>\n')
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]187
188 def close_links(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]189 self.write(' <HR>\n</DIV>\n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]190
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]191
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]192class TexinfoParser:
193
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]194 COPYRIGHT_SYMBOL = "&copy;"
195 FN_ID_PATTERN = "(%(id)s)"
196 FN_SOURCE_PATTERN = '<A NAME=footnoteref%(id)s' \
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]197 ' HREF="#footnotetext%(id)s">' \
198 + FN_ID_PATTERN + '</A>'
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]199 FN_TARGET_PATTERN = '<A NAME=footnotetext%(id)s' \
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]200 ' HREF="#footnoteref%(id)s">' \
201 + FN_ID_PATTERN + '</A>\n%(text)s<P>\n'
Fred Drake22f7f9e1996-10-11 16:54:00 +0000[diff] [blame]202 FN_HEADER = '\n<P>\n<HR NOSHADE SIZE=1 WIDTH=200>\n' \
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]203 '<STRONG><EM>Footnotes</EM></STRONG>\n<P>'
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]204
205
206 Node = HTMLNode
207
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]208 # Initialize an instance
209 def __init__(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]210 self.unknown = {} # statistics about unknown @-commands
211 self.filenames = {} # Check for identical filenames
212 self.debugging = 0 # larger values produce more output
213 self.print_headers = 0 # always print headers?
214 self.nodefp = None # open file we're writing to
215 self.nodelineno = 0 # Linenumber relative to node
216 self.links = None # Links from current node
217 self.savetext = None # If not None, save text head instead
218 self.savestack = [] # If not None, save text head instead
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]219 self.htmlhelp = None # html help data
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]220 self.dirname = 'tmp' # directory where files are created
221 self.includedir = '.' # directory to search @include files
222 self.nodename = '' # name of current node
223 self.topname = '' # name of top node (first node seen)
224 self.title = '' # title of this whole Texinfo tree
225 self.resetindex() # Reset all indices
226 self.contents = [] # Reset table of contents
227 self.numbering = [] # Reset section numbering counters
228 self.nofill = 0 # Normal operation: fill paragraphs
229 self.values={'html': 1} # Names that should be parsed in ifset
230 self.stackinfo={} # Keep track of state in the stack
231 # XXX The following should be reset per node?!
232 self.footnotes = [] # Reset list of footnotes
233 self.itemarg = None # Reset command used by @item
234 self.itemnumber = None # Reset number for @item in @enumerate
235 self.itemindex = None # Reset item index name
236 self.node = None
237 self.nodestack = []
238 self.cont = 0
239 self.includedepth = 0
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]240
241 # Set htmlhelp helper class
242 def sethtmlhelp(self, htmlhelp):
243 self.htmlhelp = htmlhelp
244
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]245 # Set (output) directory name
246 def setdirname(self, dirname):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]247 self.dirname = dirname
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]248
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]249 # Set include directory name
250 def setincludedir(self, includedir):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]251 self.includedir = includedir
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]252
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]253 # Parse the contents of an entire file
254 def parse(self, fp):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]255 line = fp.readline()
256 lineno = 1
257 while line and (line[0] == '%' or blprog.match(line)):
258 line = fp.readline()
259 lineno = lineno + 1
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]260 if line[:len(MAGIC)] != MAGIC:
Collin Wintera817e582007-08-22 23:05:06 +0000[diff] [blame]261 raise SyntaxError('file does not begin with %r' % (MAGIC,))
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]262 self.parserest(fp, lineno)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]263
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]264 # Parse the contents of a file, not expecting a MAGIC header
265 def parserest(self, fp, initial_lineno):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]266 lineno = initial_lineno
267 self.done = 0
268 self.skip = 0
269 self.stack = []
270 accu = []
271 while not self.done:
272 line = fp.readline()
273 self.nodelineno = self.nodelineno + 1
274 if not line:
275 if accu:
276 if not self.skip: self.process(accu)
277 accu = []
278 if initial_lineno > 0:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]279 print('*** EOF before @bye')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]280 break
281 lineno = lineno + 1
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]282 mo = cmprog.match(line)
283 if mo:
284 a, b = mo.span(1)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]285 cmd = line[a:b]
286 if cmd in ('noindent', 'refill'):
287 accu.append(line)
288 else:
289 if accu:
290 if not self.skip:
291 self.process(accu)
292 accu = []
293 self.command(line, mo)
294 elif blprog.match(line) and \
295 'format' not in self.stack and \
296 'example' not in self.stack:
297 if accu:
298 if not self.skip:
299 self.process(accu)
300 if self.nofill:
301 self.write('\n')
302 else:
303 self.write('<P>\n')
304 accu = []
305 else:
306 # Append the line including trailing \n!
307 accu.append(line)
308 #
309 if self.skip:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]310 print('*** Still skipping at the end')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]311 if self.stack:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]312 print('*** Stack not empty at the end')
313 print('***', self.stack)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]314 if self.includedepth == 0:
315 while self.nodestack:
316 self.nodestack[-1].finalize()
317 self.nodestack[-1].flush()
318 del self.nodestack[-1]
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]319
320 # Start saving text in a buffer instead of writing it to a file
321 def startsaving(self):
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]322 if self.savetext != None:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]323 self.savestack.append(self.savetext)
324 # print '*** Recursively saving text, expect trouble'
325 self.savetext = ''
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]326
327 # Return the text saved so far and start writing to file again
328 def collectsavings(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]329 savetext = self.savetext
330 if len(self.savestack) > 0:
331 self.savetext = self.savestack[-1]
332 del self.savestack[-1]
333 else:
334 self.savetext = None
335 return savetext or ''
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]336
337 # Write text to file, or save it in a buffer, or ignore it
338 def write(self, *args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]339 try:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]340 text = ''.join(args)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]341 except:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]342 print(args)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]343 raise TypeError
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]344 if self.savetext != None:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]345 self.savetext = self.savetext + text
346 elif self.nodefp:
347 self.nodefp.write(text)
348 elif self.node:
349 self.node.write(text)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]350
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]351 # Complete the current node -- write footnotes and close file
352 def endnode(self):
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]353 if self.savetext != None:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]354 print('*** Still saving text at end of node')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]355 dummy = self.collectsavings()
356 if self.footnotes:
357 self.writefootnotes()
358 if self.nodefp:
359 if self.nodelineno > 20:
360 self.write('<HR>\n')
361 [name, next, prev, up] = self.nodelinks[:4]
362 self.link('Next', next)
363 self.link('Prev', prev)
364 self.link('Up', up)
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]365 if self.nodename != self.topname:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]366 self.link('Top', self.topname)
367 self.write('<HR>\n')
368 self.write('</BODY>\n')
369 self.nodefp.close()
370 self.nodefp = None
371 elif self.node:
372 if not self.cont and \
373 (not self.node.type or \
374 (self.node.next and self.node.prev and self.node.up)):
375 self.node.finalize()
376 self.node.flush()
377 else:
378 self.nodestack.append(self.node)
379 self.node = None
380 self.nodename = ''
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]381
382 # Process a list of lines, expanding embedded @-commands
383 # This mostly distinguishes between menus and normal text
384 def process(self, accu):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]385 if self.debugging > 1:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]386 print('!'*self.debugging, 'process:', self.skip, self.stack, end=' ')
387 if accu: print(accu[0][:30], end=' ')
388 if accu[0][30:] or accu[1:]: print('...', end=' ')
389 print()
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]390 if self.inmenu():
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]391 # XXX should be done differently
392 for line in accu:
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]393 mo = miprog.match(line)
394 if not mo:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]395 line = line.strip() + '\n'
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]396 self.expand(line)
397 continue
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]398 bgn, end = mo.span(0)
399 a, b = mo.span(1)
400 c, d = mo.span(2)
401 e, f = mo.span(3)
402 g, h = mo.span(4)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]403 label = line[a:b]
404 nodename = line[c:d]
405 if nodename[0] == ':': nodename = label
406 else: nodename = line[e:f]
407 punct = line[g:h]
408 self.write(' <LI><A HREF="',
409 makefile(nodename),
410 '">', nodename,
411 '</A>', punct, '\n')
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]412 self.htmlhelp.menuitem(nodename)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]413 self.expand(line[end:])
414 else:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]415 text = ''.join(accu)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]416 self.expand(text)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]417
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]418 # find 'menu' (we might be inside 'ifset' or 'ifclear')
419 def inmenu(self):
420 #if 'menu' in self.stack:
421 # print 'inmenu :', self.skip, self.stack, self.stackinfo
422 stack = self.stack
423 while stack and stack[-1] in ('ifset','ifclear'):
424 try:
425 if self.stackinfo[len(stack)]:
426 return 0
427 except KeyError:
428 pass
429 stack = stack[:-1]
430 return (stack and stack[-1] == 'menu')
431
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]432 # Write a string, expanding embedded @-commands
433 def expand(self, text):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]434 stack = []
435 i = 0
436 n = len(text)
437 while i < n:
438 start = i
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]439 mo = spprog.search(text, i)
440 if mo:
441 i = mo.start()
442 else:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]443 self.write(text[start:])
444 break
445 self.write(text[start:i])
446 c = text[i]
447 i = i+1
448 if c == '\n':
449 self.write('\n')
450 continue
451 if c == '<':
452 self.write('&lt;')
453 continue
454 if c == '>':
455 self.write('&gt;')
456 continue
457 if c == '&':
458 self.write('&amp;')
459 continue
460 if c == '{':
461 stack.append('')
462 continue
463 if c == '}':
464 if not stack:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]465 print('*** Unmatched }')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]466 self.write('}')
467 continue
468 cmd = stack[-1]
469 del stack[-1]
470 try:
471 method = getattr(self, 'close_' + cmd)
472 except AttributeError:
473 self.unknown_close(cmd)
474 continue
475 method()
476 continue
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]477 if c != '@':
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]478 # Cannot happen unless spprog is changed
Collin Wintera817e582007-08-22 23:05:06 +0000[diff] [blame]479 raise RuntimeError('unexpected funny %r' % c)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]480 start = i
Fred Drake79e75e12001-07-20 19:05:50 +0000[diff] [blame]481 while i < n and text[i] in string.ascii_letters: i = i+1
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]482 if i == start:
483 # @ plus non-letter: literal next character
484 i = i+1
485 c = text[start:i]
486 if c == ':':
487 # `@:' means no extra space after
488 # preceding `.', `?', `!' or `:'
489 pass
490 else:
491 # `@.' means a sentence-ending period;
492 # `@@', `@{', `@}' quote `@', `{', `}'
493 self.write(c)
494 continue
495 cmd = text[start:i]
496 if i < n and text[i] == '{':
497 i = i+1
498 stack.append(cmd)
499 try:
500 method = getattr(self, 'open_' + cmd)
501 except AttributeError:
502 self.unknown_open(cmd)
503 continue
504 method()
505 continue
506 try:
507 method = getattr(self, 'handle_' + cmd)
508 except AttributeError:
509 self.unknown_handle(cmd)
510 continue
511 method()
512 if stack:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]513 print('*** Stack not empty at para:', stack)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]514
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]515 # --- Handle unknown embedded @-commands ---
516
517 def unknown_open(self, cmd):
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]518 print('*** No open func for @' + cmd + '{...}')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]519 cmd = cmd + '{'
520 self.write('@', cmd)
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]521 if cmd not in self.unknown:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]522 self.unknown[cmd] = 1
523 else:
524 self.unknown[cmd] = self.unknown[cmd] + 1
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]525
526 def unknown_close(self, cmd):
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]527 print('*** No close func for @' + cmd + '{...}')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]528 cmd = '}' + cmd
529 self.write('}')
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]530 if cmd not in self.unknown:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]531 self.unknown[cmd] = 1
532 else:
533 self.unknown[cmd] = self.unknown[cmd] + 1
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]534
535 def unknown_handle(self, cmd):
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]536 print('*** No handler for @' + cmd)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]537 self.write('@', cmd)
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]538 if cmd not in self.unknown:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]539 self.unknown[cmd] = 1
540 else:
541 self.unknown[cmd] = self.unknown[cmd] + 1
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]542
543 # XXX The following sections should be ordered as the texinfo docs
544
545 # --- Embedded @-commands without {} argument list --
546
547 def handle_noindent(self): pass
548
549 def handle_refill(self): pass
550
551 # --- Include file handling ---
552
553 def do_include(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]554 file = args
555 file = os.path.join(self.includedir, file)
556 try:
557 fp = open(file, 'r')
Guido van Rossumb940e112007-01-10 16:19:56 +0000[diff] [blame]558 except IOError as msg:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]559 print('*** Can\'t open include file', repr(file))
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]560 return
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]561 print('!'*self.debugging, '--> file', repr(file))
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]562 save_done = self.done
563 save_skip = self.skip
564 save_stack = self.stack
565 self.includedepth = self.includedepth + 1
566 self.parserest(fp, 0)
567 self.includedepth = self.includedepth - 1
568 fp.close()
569 self.done = save_done
570 self.skip = save_skip
571 self.stack = save_stack
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]572 print('!'*self.debugging, '<-- file', repr(file))
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]573
574 # --- Special Insertions ---
575
576 def open_dmn(self): pass
577 def close_dmn(self): pass
578
579 def open_dots(self): self.write('...')
580 def close_dots(self): pass
581
582 def open_bullet(self): pass
583 def close_bullet(self): pass
584
585 def open_TeX(self): self.write('TeX')
586 def close_TeX(self): pass
587
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]588 def handle_copyright(self): self.write(self.COPYRIGHT_SYMBOL)
589 def open_copyright(self): self.write(self.COPYRIGHT_SYMBOL)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]590 def close_copyright(self): pass
591
592 def open_minus(self): self.write('-')
593 def close_minus(self): pass
594
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]595 # --- Accents ---
596
597 # rpyron 2002-05-07
598 # I would like to do at least as well as makeinfo when
599 # it is producing HTML output:
600 #
601 # input output
602 # @"o @"o umlaut accent
603 # @'o 'o acute accent
604 # @,{c} @,{c} cedilla accent
605 # @=o @=o macron/overbar accent
606 # @^o @^o circumflex accent
607 # @`o `o grave accent
608 # @~o @~o tilde accent
609 # @dotaccent{o} @dotaccent{o} overdot accent
610 # @H{o} @H{o} long Hungarian umlaut
611 # @ringaccent{o} @ringaccent{o} ring accent
612 # @tieaccent{oo} @tieaccent{oo} tie-after accent
613 # @u{o} @u{o} breve accent
614 # @ubaraccent{o} @ubaraccent{o} underbar accent
615 # @udotaccent{o} @udotaccent{o} underdot accent
616 # @v{o} @v{o} hacek or check accent
617 # @exclamdown{} &#161; upside-down !
618 # @questiondown{} &#191; upside-down ?
619 # @aa{},@AA{} &#229;,&#197; a,A with circle
620 # @ae{},@AE{} &#230;,&#198; ae,AE ligatures
621 # @dotless{i} @dotless{i} dotless i
622 # @dotless{j} @dotless{j} dotless j
623 # @l{},@L{} l/,L/ suppressed-L,l
624 # @o{},@O{} &#248;,&#216; O,o with slash
625 # @oe{},@OE{} oe,OE oe,OE ligatures
626 # @ss{} &#223; es-zet or sharp S
627 #
628 # The following character codes and approximations have been
629 # copied from makeinfo's HTML output.
630
631 def open_exclamdown(self): self.write('&#161;') # upside-down !
632 def close_exclamdown(self): pass
633 def open_questiondown(self): self.write('&#191;') # upside-down ?
634 def close_questiondown(self): pass
635 def open_aa(self): self.write('&#229;') # a with circle
636 def close_aa(self): pass
637 def open_AA(self): self.write('&#197;') # A with circle
638 def close_AA(self): pass
639 def open_ae(self): self.write('&#230;') # ae ligatures
640 def close_ae(self): pass
641 def open_AE(self): self.write('&#198;') # AE ligatures
642 def close_AE(self): pass
643 def open_o(self): self.write('&#248;') # o with slash
644 def close_o(self): pass
645 def open_O(self): self.write('&#216;') # O with slash
646 def close_O(self): pass
647 def open_ss(self): self.write('&#223;') # es-zet or sharp S
648 def close_ss(self): pass
649 def open_oe(self): self.write('oe') # oe ligatures
650 def close_oe(self): pass
651 def open_OE(self): self.write('OE') # OE ligatures
652 def close_OE(self): pass
653 def open_l(self): self.write('l/') # suppressed-l
654 def close_l(self): pass
655 def open_L(self): self.write('L/') # suppressed-L
656 def close_L(self): pass
657
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]658 # --- Special Glyphs for Examples ---
659
660 def open_result(self): self.write('=&gt;')
661 def close_result(self): pass
662
663 def open_expansion(self): self.write('==&gt;')
664 def close_expansion(self): pass
665
666 def open_print(self): self.write('-|')
667 def close_print(self): pass
668
669 def open_error(self): self.write('error--&gt;')
670 def close_error(self): pass
671
672 def open_equiv(self): self.write('==')
673 def close_equiv(self): pass
674
675 def open_point(self): self.write('-!-')
676 def close_point(self): pass
677
678 # --- Cross References ---
679
680 def open_pxref(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]681 self.write('see ')
682 self.startsaving()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]683 def close_pxref(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]684 self.makeref()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]685
686 def open_xref(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]687 self.write('See ')
688 self.startsaving()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]689 def close_xref(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]690 self.makeref()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]691
692 def open_ref(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]693 self.startsaving()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]694 def close_ref(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]695 self.makeref()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]696
697 def open_inforef(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]698 self.write('See info file ')
699 self.startsaving()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]700 def close_inforef(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]701 text = self.collectsavings()
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]702 args = [s.strip() for s in text.split(',')]
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]703 while len(args) < 3: args.append('')
704 node = args[0]
705 file = args[2]
706 self.write('`', file, '\', node `', node, '\'')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]707
708 def makeref(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]709 text = self.collectsavings()
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]710 args = [s.strip() for s in text.split(',')]
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]711 while len(args) < 5: args.append('')
712 nodename = label = args[0]
713 if args[2]: label = args[2]
714 file = args[3]
715 title = args[4]
716 href = makefile(nodename)
717 if file:
718 href = '../' + file + '/' + href
719 self.write('<A HREF="', href, '">', label, '</A>')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]720
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]721 # rpyron 2002-05-07 uref support
722 def open_uref(self):
723 self.startsaving()
724 def close_uref(self):
725 text = self.collectsavings()
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]726 args = [s.strip() for s in text.split(',')]
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]727 while len(args) < 2: args.append('')
728 href = args[0]
729 label = args[1]
730 if not label: label = href
731 self.write('<A HREF="', href, '">', label, '</A>')
732
733 # rpyron 2002-05-07 image support
734 # GNU makeinfo producing HTML output tries `filename.png'; if
735 # that does not exist, it tries `filename.jpg'. If that does
736 # not exist either, it complains. GNU makeinfo does not handle
737 # GIF files; however, I include GIF support here because
738 # MySQL documentation uses GIF files.
739
740 def open_image(self):
741 self.startsaving()
742 def close_image(self):
743 self.makeimage()
744 def makeimage(self):
745 text = self.collectsavings()
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]746 args = [s.strip() for s in text.split(',')]
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]747 while len(args) < 5: args.append('')
748 filename = args[0]
749 width = args[1]
750 height = args[2]
751 alt = args[3]
752 ext = args[4]
753
754 # The HTML output will have a reference to the image
755 # that is relative to the HTML output directory,
756 # which is what 'filename' gives us. However, we need
757 # to find it relative to our own current directory,
758 # so we construct 'imagename'.
759 imagelocation = self.dirname + '/' + filename
760
761 if os.path.exists(imagelocation+'.png'):
762 filename += '.png'
763 elif os.path.exists(imagelocation+'.jpg'):
764 filename += '.jpg'
765 elif os.path.exists(imagelocation+'.gif'): # MySQL uses GIF files
766 filename += '.gif'
767 else:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]768 print("*** Cannot find image " + imagelocation)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]769 #TODO: what is 'ext'?
770 self.write('<IMG SRC="', filename, '"', \
771 width and (' WIDTH="' + width + '"') or "", \
772 height and (' HEIGHT="' + height + '"') or "", \
773 alt and (' ALT="' + alt + '"') or "", \
774 '/>' )
775 self.htmlhelp.addimage(imagelocation)
776
777
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]778 # --- Marking Words and Phrases ---
779
780 # --- Other @xxx{...} commands ---
781
782 def open_(self): pass # Used by {text enclosed in braces}
783 def close_(self): pass
784
785 open_asis = open_
786 close_asis = close_
787
788 def open_cite(self): self.write('<CITE>')
789 def close_cite(self): self.write('</CITE>')
790
791 def open_code(self): self.write('<CODE>')
792 def close_code(self): self.write('</CODE>')
793
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]794 def open_t(self): self.write('<TT>')
795 def close_t(self): self.write('</TT>')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]796
797 def open_dfn(self): self.write('<DFN>')
798 def close_dfn(self): self.write('</DFN>')
799
800 def open_emph(self): self.write('<EM>')
801 def close_emph(self): self.write('</EM>')
802
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]803 def open_i(self): self.write('<I>')
804 def close_i(self): self.write('</I>')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]805
806 def open_footnote(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]807 # if self.savetext <> None:
808 # print '*** Recursive footnote -- expect weirdness'
809 id = len(self.footnotes) + 1
Tim Peters4fba4522004-07-18 05:31:31 +0000[diff] [blame]810 self.write(self.FN_SOURCE_PATTERN % {'id': repr(id)})
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]811 self.startsaving()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]812
813 def close_footnote(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]814 id = len(self.footnotes) + 1
Guido van Rossum9c2c1e81998-10-08 15:24:48 +0000[diff] [blame]815 self.footnotes.append((id, self.collectsavings()))
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]816
817 def writefootnotes(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]818 self.write(self.FN_HEADER)
819 for id, text in self.footnotes:
820 self.write(self.FN_TARGET_PATTERN
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]821 % {'id': repr(id), 'text': text})
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]822 self.footnotes = []
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]823
824 def open_file(self): self.write('<CODE>')
825 def close_file(self): self.write('</CODE>')
826
827 def open_kbd(self): self.write('<KBD>')
828 def close_kbd(self): self.write('</KBD>')
829
830 def open_key(self): self.write('<KEY>')
831 def close_key(self): self.write('</KEY>')
832
833 def open_r(self): self.write('<R>')
834 def close_r(self): self.write('</R>')
835
836 def open_samp(self): self.write('`<SAMP>')
837 def close_samp(self): self.write('</SAMP>\'')
838
839 def open_sc(self): self.write('<SMALLCAPS>')
840 def close_sc(self): self.write('</SMALLCAPS>')
841
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]842 def open_strong(self): self.write('<STRONG>')
843 def close_strong(self): self.write('</STRONG>')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]844
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]845 def open_b(self): self.write('<B>')
846 def close_b(self): self.write('</B>')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]847
848 def open_var(self): self.write('<VAR>')
849 def close_var(self): self.write('</VAR>')
850
851 def open_w(self): self.write('<NOBREAK>')
852 def close_w(self): self.write('</NOBREAK>')
853
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]854 def open_url(self): self.startsaving()
855 def close_url(self):
856 text = self.collectsavings()
857 self.write('<A HREF="', text, '">', text, '</A>')
858
859 def open_email(self): self.startsaving()
860 def close_email(self):
861 text = self.collectsavings()
862 self.write('<A HREF="mailto:', text, '">', text, '</A>')
863
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]864 open_titlefont = open_
865 close_titlefont = close_
866
867 def open_small(self): pass
868 def close_small(self): pass
869
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]870 def command(self, line, mo):
871 a, b = mo.span(1)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]872 cmd = line[a:b]
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]873 args = line[b:].strip()
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]874 if self.debugging > 1:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]875 print('!'*self.debugging, 'command:', self.skip, self.stack, \
876 '@' + cmd, args)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]877 try:
878 func = getattr(self, 'do_' + cmd)
879 except AttributeError:
880 try:
881 func = getattr(self, 'bgn_' + cmd)
882 except AttributeError:
883 # don't complain if we are skipping anyway
884 if not self.skip:
885 self.unknown_cmd(cmd, args)
886 return
887 self.stack.append(cmd)
888 func(args)
889 return
890 if not self.skip or cmd == 'end':
891 func(args)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]892
893 def unknown_cmd(self, cmd, args):
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]894 print('*** unknown', '@' + cmd, args)
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]895 if cmd not in self.unknown:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]896 self.unknown[cmd] = 1
897 else:
898 self.unknown[cmd] = self.unknown[cmd] + 1
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]899
900 def do_end(self, args):
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]901 words = args.split()
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]902 if not words:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]903 print('*** @end w/o args')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]904 else:
905 cmd = words[0]
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]906 if not self.stack or self.stack[-1] != cmd:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]907 print('*** @end', cmd, 'unexpected')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]908 else:
909 del self.stack[-1]
910 try:
911 func = getattr(self, 'end_' + cmd)
912 except AttributeError:
913 self.unknown_end(cmd)
914 return
915 func()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]916
917 def unknown_end(self, cmd):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]918 cmd = 'end ' + cmd
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]919 print('*** unknown', '@' + cmd)
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]920 if cmd not in self.unknown:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]921 self.unknown[cmd] = 1
922 else:
923 self.unknown[cmd] = self.unknown[cmd] + 1
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]924
925 # --- Comments ---
926
927 def do_comment(self, args): pass
928 do_c = do_comment
929
930 # --- Conditional processing ---
931
932 def bgn_ifinfo(self, args): pass
933 def end_ifinfo(self): pass
934
935 def bgn_iftex(self, args): self.skip = self.skip + 1
936 def end_iftex(self): self.skip = self.skip - 1
937
938 def bgn_ignore(self, args): self.skip = self.skip + 1
939 def end_ignore(self): self.skip = self.skip - 1
940
941 def bgn_tex(self, args): self.skip = self.skip + 1
942 def end_tex(self): self.skip = self.skip - 1
943
944 def do_set(self, args):
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]945 fields = args.split(' ')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]946 key = fields[0]
947 if len(fields) == 1:
948 value = 1
949 else:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]950 value = ' '.join(fields[1:])
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]951 self.values[key] = value
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]952
953 def do_clear(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]954 self.values[args] = None
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]955
956 def bgn_ifset(self, args):
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]957 if args not in self.values or self.values[args] is None:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]958 self.skip = self.skip + 1
959 self.stackinfo[len(self.stack)] = 1
960 else:
961 self.stackinfo[len(self.stack)] = 0
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]962 def end_ifset(self):
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]963 try:
964 if self.stackinfo[len(self.stack) + 1]:
965 self.skip = self.skip - 1
966 del self.stackinfo[len(self.stack) + 1]
967 except KeyError:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]968 print('*** end_ifset: KeyError :', len(self.stack) + 1)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]969
970 def bgn_ifclear(self, args):
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]971 if args in self.values and self.values[args] is not None:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]972 self.skip = self.skip + 1
973 self.stackinfo[len(self.stack)] = 1
974 else:
975 self.stackinfo[len(self.stack)] = 0
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]976 def end_ifclear(self):
977 try:
978 if self.stackinfo[len(self.stack) + 1]:
979 self.skip = self.skip - 1
980 del self.stackinfo[len(self.stack) + 1]
981 except KeyError:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]982 print('*** end_ifclear: KeyError :', len(self.stack) + 1)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]983
984 def open_value(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]985 self.startsaving()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]986
987 def close_value(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]988 key = self.collectsavings()
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]989 if key in self.values:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]990 self.write(self.values[key])
991 else:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]992 print('*** Undefined value: ', key)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]993
994 # --- Beginning a file ---
995
996 do_finalout = do_comment
997 do_setchapternewpage = do_comment
998 do_setfilename = do_comment
999
1000 def do_settitle(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1001 self.startsaving()
1002 self.expand(args)
1003 self.title = self.collectsavings()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1004 def do_parskip(self, args): pass
1005
1006 # --- Ending a file ---
1007
1008 def do_bye(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1009 self.endnode()
1010 self.done = 1
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1011
1012 # --- Title page ---
1013
1014 def bgn_titlepage(self, args): self.skip = self.skip + 1
1015 def end_titlepage(self): self.skip = self.skip - 1
1016 def do_shorttitlepage(self, args): pass
1017
1018 def do_center(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1019 # Actually not used outside title page...
1020 self.write('<H1>')
1021 self.expand(args)
1022 self.write('</H1>\n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1023 do_title = do_center
1024 do_subtitle = do_center
1025 do_author = do_center
1026
1027 do_vskip = do_comment
1028 do_vfill = do_comment
1029 do_smallbook = do_comment
1030
1031 do_paragraphindent = do_comment
1032 do_setchapternewpage = do_comment
1033 do_headings = do_comment
1034 do_footnotestyle = do_comment
1035
1036 do_evenheading = do_comment
1037 do_evenfooting = do_comment
1038 do_oddheading = do_comment
1039 do_oddfooting = do_comment
1040 do_everyheading = do_comment
1041 do_everyfooting = do_comment
1042
1043 # --- Nodes ---
1044
1045 def do_node(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1046 self.endnode()
1047 self.nodelineno = 0
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]1048 parts = [s.strip() for s in args.split(',')]
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1049 while len(parts) < 4: parts.append('')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1050 self.nodelinks = parts
1051 [name, next, prev, up] = parts[:4]
1052 file = self.dirname + '/' + makefile(name)
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1053 if file in self.filenames:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1054 print('*** Filename already in use: ', file)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1055 else:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1056 if self.debugging: print('!'*self.debugging, '--- writing', file)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1057 self.filenames[file] = 1
1058 # self.nodefp = open(file, 'w')
1059 self.nodename = name
1060 if self.cont and self.nodestack:
1061 self.nodestack[-1].cont = self.nodename
1062 if not self.topname: self.topname = name
1063 title = name
1064 if self.title: title = title + ' -- ' + self.title
1065 self.node = self.Node(self.dirname, self.nodename, self.topname,
1066 title, next, prev, up)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1067 self.htmlhelp.addnode(self.nodename,next,prev,up,file)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1068
1069 def link(self, label, nodename):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1070 if nodename:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]1071 if nodename.lower() == '(dir)':
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1072 addr = '../dir.html'
1073 else:
1074 addr = makefile(nodename)
1075 self.write(label, ': <A HREF="', addr, '" TYPE="',
1076 label, '">', nodename, '</A> \n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1077
1078 # --- Sectioning commands ---
1079
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1080 def popstack(self, type):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1081 if (self.node):
1082 self.node.type = type
1083 while self.nodestack:
1084 if self.nodestack[-1].type > type:
1085 self.nodestack[-1].finalize()
1086 self.nodestack[-1].flush()
1087 del self.nodestack[-1]
1088 elif self.nodestack[-1].type == type:
1089 if not self.nodestack[-1].next:
1090 self.nodestack[-1].next = self.node.name
1091 if not self.node.prev:
1092 self.node.prev = self.nodestack[-1].name
1093 self.nodestack[-1].finalize()
1094 self.nodestack[-1].flush()
1095 del self.nodestack[-1]
1096 else:
1097 if type > 1 and not self.node.up:
1098 self.node.up = self.nodestack[-1].name
1099 break
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1100
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1101 def do_chapter(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1102 self.heading('H1', args, 0)
1103 self.popstack(1)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1104
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1105 def do_unnumbered(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1106 self.heading('H1', args, -1)
1107 self.popstack(1)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1108 def do_appendix(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1109 self.heading('H1', args, -1)
1110 self.popstack(1)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1111 def do_top(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1112 self.heading('H1', args, -1)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1113 def do_chapheading(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1114 self.heading('H1', args, -1)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1115 def do_majorheading(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1116 self.heading('H1', args, -1)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1117
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1118 def do_section(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1119 self.heading('H1', args, 1)
1120 self.popstack(2)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1121
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1122 def do_unnumberedsec(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1123 self.heading('H1', args, -1)
1124 self.popstack(2)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1125 def do_appendixsec(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1126 self.heading('H1', args, -1)
1127 self.popstack(2)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1128 do_appendixsection = do_appendixsec
1129 def do_heading(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1130 self.heading('H1', args, -1)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1131
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1132 def do_subsection(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1133 self.heading('H2', args, 2)
1134 self.popstack(3)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1135 def do_unnumberedsubsec(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1136 self.heading('H2', args, -1)
1137 self.popstack(3)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1138 def do_appendixsubsec(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1139 self.heading('H2', args, -1)
1140 self.popstack(3)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1141 def do_subheading(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1142 self.heading('H2', args, -1)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1143
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1144 def do_subsubsection(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1145 self.heading('H3', args, 3)
1146 self.popstack(4)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1147 def do_unnumberedsubsubsec(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1148 self.heading('H3', args, -1)
1149 self.popstack(4)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1150 def do_appendixsubsubsec(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1151 self.heading('H3', args, -1)
1152 self.popstack(4)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1153 def do_subsubheading(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1154 self.heading('H3', args, -1)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1155
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1156 def heading(self, type, args, level):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1157 if level >= 0:
1158 while len(self.numbering) <= level:
1159 self.numbering.append(0)
1160 del self.numbering[level+1:]
1161 self.numbering[level] = self.numbering[level] + 1
1162 x = ''
1163 for i in self.numbering:
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]1164 x = x + repr(i) + '.'
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1165 args = x + ' ' + args
Guido van Rossum9c2c1e81998-10-08 15:24:48 +0000[diff] [blame]1166 self.contents.append((level, args, self.nodename))
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1167 self.write('<', type, '>')
1168 self.expand(args)
1169 self.write('</', type, '>\n')
1170 if self.debugging or self.print_headers:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1171 print('---', args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1172
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1173 def do_contents(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1174 # pass
1175 self.listcontents('Table of Contents', 999)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1176
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1177 def do_shortcontents(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1178 pass
1179 # self.listcontents('Short Contents', 0)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1180 do_summarycontents = do_shortcontents
Guido van Rossuma12bbff1995-05-03 14:17:36 +0000[diff] [blame]1181
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1182 def listcontents(self, title, maxlevel):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1183 self.write('<H1>', title, '</H1>\n<UL COMPACT PLAIN>\n')
1184 prevlevels = [0]
1185 for level, title, node in self.contents:
1186 if level > maxlevel:
1187 continue
1188 if level > prevlevels[-1]:
1189 # can only advance one level at a time
1190 self.write(' '*prevlevels[-1], '<UL PLAIN>\n')
1191 prevlevels.append(level)
1192 elif level < prevlevels[-1]:
1193 # might drop back multiple levels
1194 while level < prevlevels[-1]:
1195 del prevlevels[-1]
1196 self.write(' '*prevlevels[-1],
1197 '</UL>\n')
1198 self.write(' '*level, '<LI> <A HREF="',
1199 makefile(node), '">')
1200 self.expand(title)
1201 self.write('</A>\n')
1202 self.write('</UL>\n' * len(prevlevels))
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1203
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1204 # --- Page lay-out ---
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1205
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1206 # These commands are only meaningful in printed text
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1207
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1208 def do_page(self, args): pass
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1209
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1210 def do_need(self, args): pass
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1211
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1212 def bgn_group(self, args): pass
1213 def end_group(self): pass
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1214
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1215 # --- Line lay-out ---
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1216
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1217 def do_sp(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1218 if self.nofill:
1219 self.write('\n')
1220 else:
1221 self.write('<P>\n')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1222
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1223 def do_hline(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1224 self.write('<HR>')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1225
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1226 # --- Function and variable definitions ---
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1227
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1228 def bgn_deffn(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1229 self.write('<DL>')
1230 self.do_deffnx(args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1231
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1232 def end_deffn(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1233 self.write('</DL>\n')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1234
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1235 def do_deffnx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1236 self.write('<DT>')
1237 words = splitwords(args, 2)
1238 [category, name], rest = words[:2], words[2:]
1239 self.expand('@b{%s}' % name)
1240 for word in rest: self.expand(' ' + makevar(word))
1241 #self.expand(' -- ' + category)
1242 self.write('\n<DD>')
1243 self.index('fn', name)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1244
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1245 def bgn_defun(self, args): self.bgn_deffn('Function ' + args)
1246 end_defun = end_deffn
1247 def do_defunx(self, args): self.do_deffnx('Function ' + args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1248
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1249 def bgn_defmac(self, args): self.bgn_deffn('Macro ' + args)
1250 end_defmac = end_deffn
1251 def do_defmacx(self, args): self.do_deffnx('Macro ' + args)
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1252
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1253 def bgn_defspec(self, args): self.bgn_deffn('{Special Form} ' + args)
1254 end_defspec = end_deffn
1255 def do_defspecx(self, args): self.do_deffnx('{Special Form} ' + args)
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1256
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1257 def bgn_defvr(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1258 self.write('<DL>')
1259 self.do_defvrx(args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1260
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1261 end_defvr = end_deffn
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1262
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1263 def do_defvrx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1264 self.write('<DT>')
1265 words = splitwords(args, 2)
1266 [category, name], rest = words[:2], words[2:]
1267 self.expand('@code{%s}' % name)
1268 # If there are too many arguments, show them
1269 for word in rest: self.expand(' ' + word)
1270 #self.expand(' -- ' + category)
1271 self.write('\n<DD>')
1272 self.index('vr', name)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1273
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1274 def bgn_defvar(self, args): self.bgn_defvr('Variable ' + args)
1275 end_defvar = end_defvr
1276 def do_defvarx(self, args): self.do_defvrx('Variable ' + args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1277
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1278 def bgn_defopt(self, args): self.bgn_defvr('{User Option} ' + args)
1279 end_defopt = end_defvr
1280 def do_defoptx(self, args): self.do_defvrx('{User Option} ' + args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1281
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1282 # --- Ditto for typed languages ---
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1283
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1284 def bgn_deftypefn(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1285 self.write('<DL>')
1286 self.do_deftypefnx(args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1287
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1288 end_deftypefn = end_deffn
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1289
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1290 def do_deftypefnx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1291 self.write('<DT>')
1292 words = splitwords(args, 3)
1293 [category, datatype, name], rest = words[:3], words[3:]
1294 self.expand('@code{%s} @b{%s}' % (datatype, name))
1295 for word in rest: self.expand(' ' + makevar(word))
1296 #self.expand(' -- ' + category)
1297 self.write('\n<DD>')
1298 self.index('fn', name)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1299
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1300
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1301 def bgn_deftypefun(self, args): self.bgn_deftypefn('Function ' + args)
1302 end_deftypefun = end_deftypefn
1303 def do_deftypefunx(self, args): self.do_deftypefnx('Function ' + args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1304
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1305 def bgn_deftypevr(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1306 self.write('<DL>')
1307 self.do_deftypevrx(args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1308
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1309 end_deftypevr = end_deftypefn
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1310
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1311 def do_deftypevrx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1312 self.write('<DT>')
1313 words = splitwords(args, 3)
1314 [category, datatype, name], rest = words[:3], words[3:]
1315 self.expand('@code{%s} @b{%s}' % (datatype, name))
1316 # If there are too many arguments, show them
1317 for word in rest: self.expand(' ' + word)
1318 #self.expand(' -- ' + category)
1319 self.write('\n<DD>')
1320 self.index('fn', name)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1321
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1322 def bgn_deftypevar(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1323 self.bgn_deftypevr('Variable ' + args)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1324 end_deftypevar = end_deftypevr
1325 def do_deftypevarx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1326 self.do_deftypevrx('Variable ' + args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1327
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1328 # --- Ditto for object-oriented languages ---
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1329
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1330 def bgn_defcv(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1331 self.write('<DL>')
1332 self.do_defcvx(args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1333
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1334 end_defcv = end_deftypevr
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1335
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1336 def do_defcvx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1337 self.write('<DT>')
1338 words = splitwords(args, 3)
1339 [category, classname, name], rest = words[:3], words[3:]
1340 self.expand('@b{%s}' % name)
1341 # If there are too many arguments, show them
1342 for word in rest: self.expand(' ' + word)
1343 #self.expand(' -- %s of @code{%s}' % (category, classname))
1344 self.write('\n<DD>')
1345 self.index('vr', '%s @r{on %s}' % (name, classname))
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1346
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1347 def bgn_defivar(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1348 self.bgn_defcv('{Instance Variable} ' + args)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1349 end_defivar = end_defcv
1350 def do_defivarx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1351 self.do_defcvx('{Instance Variable} ' + args)
Guido van Rossuma12bbff1995-05-03 14:17:36 +0000[diff] [blame]1352
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1353 def bgn_defop(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1354 self.write('<DL>')
1355 self.do_defopx(args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1356
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1357 end_defop = end_defcv
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1358
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1359 def do_defopx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1360 self.write('<DT>')
1361 words = splitwords(args, 3)
1362 [category, classname, name], rest = words[:3], words[3:]
1363 self.expand('@b{%s}' % name)
1364 for word in rest: self.expand(' ' + makevar(word))
1365 #self.expand(' -- %s of @code{%s}' % (category, classname))
1366 self.write('\n<DD>')
1367 self.index('fn', '%s @r{on %s}' % (name, classname))
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1368
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1369 def bgn_defmethod(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1370 self.bgn_defop('Method ' + args)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1371 end_defmethod = end_defop
1372 def do_defmethodx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1373 self.do_defopx('Method ' + args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1374
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1375 # --- Ditto for data types ---
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1376
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1377 def bgn_deftp(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1378 self.write('<DL>')
1379 self.do_deftpx(args)
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1380
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1381 end_deftp = end_defcv
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1382
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1383 def do_deftpx(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1384 self.write('<DT>')
1385 words = splitwords(args, 2)
1386 [category, name], rest = words[:2], words[2:]
1387 self.expand('@b{%s}' % name)
1388 for word in rest: self.expand(' ' + word)
1389 #self.expand(' -- ' + category)
1390 self.write('\n<DD>')
1391 self.index('tp', name)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1392
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1393 # --- Making Lists and Tables
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1394
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1395 def bgn_enumerate(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1396 if not args:
1397 self.write('<OL>\n')
1398 self.stackinfo[len(self.stack)] = '</OL>\n'
1399 else:
1400 self.itemnumber = args
1401 self.write('<UL>\n')
1402 self.stackinfo[len(self.stack)] = '</UL>\n'
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1403 def end_enumerate(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1404 self.itemnumber = None
1405 self.write(self.stackinfo[len(self.stack) + 1])
1406 del self.stackinfo[len(self.stack) + 1]
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1407
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1408 def bgn_itemize(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1409 self.itemarg = args
1410 self.write('<UL>\n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1411 def end_itemize(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1412 self.itemarg = None
1413 self.write('</UL>\n')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1414
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1415 def bgn_table(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1416 self.itemarg = args
1417 self.write('<DL>\n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1418 def end_table(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1419 self.itemarg = None
1420 self.write('</DL>\n')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1421
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1422 def bgn_ftable(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1423 self.itemindex = 'fn'
1424 self.bgn_table(args)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1425 def end_ftable(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1426 self.itemindex = None
1427 self.end_table()
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1428
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1429 def bgn_vtable(self, args):
1430 self.itemindex = 'vr'
1431 self.bgn_table(args)
1432 def end_vtable(self):
1433 self.itemindex = None
1434 self.end_table()
1435
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1436 def do_item(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1437 if self.itemindex: self.index(self.itemindex, args)
1438 if self.itemarg:
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1439 if self.itemarg[0] == '@' and self.itemarg[1] and \
Fred Drake79e75e12001-07-20 19:05:50 +0000[diff] [blame]1440 self.itemarg[1] in string.ascii_letters:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1441 args = self.itemarg + '{' + args + '}'
1442 else:
1443 # some other character, e.g. '-'
1444 args = self.itemarg + ' ' + args
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1445 if self.itemnumber != None:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1446 args = self.itemnumber + '. ' + args
1447 self.itemnumber = increment(self.itemnumber)
1448 if self.stack and self.stack[-1] == 'table':
1449 self.write('<DT>')
1450 self.expand(args)
1451 self.write('\n<DD>')
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1452 elif self.stack and self.stack[-1] == 'multitable':
1453 self.write('<TR><TD>')
1454 self.expand(args)
1455 self.write('</TD>\n</TR>\n')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1456 else:
1457 self.write('<LI>')
1458 self.expand(args)
1459 self.write(' ')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1460 do_itemx = do_item # XXX Should suppress leading blank line
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1461
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1462 # rpyron 2002-05-07 multitable support
1463 def bgn_multitable(self, args):
1464 self.itemarg = None # should be handled by columnfractions
1465 self.write('<TABLE BORDER="">\n')
1466 def end_multitable(self):
1467 self.itemarg = None
1468 self.write('</TABLE>\n<BR>\n')
1469 def handle_columnfractions(self):
1470 # It would be better to handle this, but for now it's in the way...
1471 self.itemarg = None
1472 def handle_tab(self):
1473 self.write('</TD>\n <TD>')
1474
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1475 # --- Enumerations, displays, quotations ---
1476 # XXX Most of these should increase the indentation somehow
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1477
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1478 def bgn_quotation(self, args): self.write('<BLOCKQUOTE>')
1479 def end_quotation(self): self.write('</BLOCKQUOTE>\n')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1480
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1481 def bgn_example(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1482 self.nofill = self.nofill + 1
1483 self.write('<PRE>')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1484 def end_example(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1485 self.write('</PRE>\n')
1486 self.nofill = self.nofill - 1
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1487
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1488 bgn_lisp = bgn_example # Synonym when contents are executable lisp code
1489 end_lisp = end_example
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1490
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1491 bgn_smallexample = bgn_example # XXX Should use smaller font
1492 end_smallexample = end_example
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1493
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1494 bgn_smalllisp = bgn_lisp # Ditto
1495 end_smalllisp = end_lisp
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1496
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1497 bgn_display = bgn_example
1498 end_display = end_example
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1499
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1500 bgn_format = bgn_display
1501 end_format = end_display
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1502
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1503 def do_exdent(self, args): self.expand(args + '\n')
1504 # XXX Should really mess with indentation
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1505
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1506 def bgn_flushleft(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1507 self.nofill = self.nofill + 1
1508 self.write('<PRE>\n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1509 def end_flushleft(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1510 self.write('</PRE>\n')
1511 self.nofill = self.nofill - 1
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1512
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1513 def bgn_flushright(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1514 self.nofill = self.nofill + 1
1515 self.write('<ADDRESS COMPACT>\n')
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1516 def end_flushright(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1517 self.write('</ADDRESS>\n')
1518 self.nofill = self.nofill - 1
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1519
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1520 def bgn_menu(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1521 self.write('<DIR>\n')
1522 self.write(' <STRONG><EM>Menu</EM></STRONG><P>\n')
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1523 self.htmlhelp.beginmenu()
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1524 def end_menu(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1525 self.write('</DIR>\n')
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1526 self.htmlhelp.endmenu()
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1527
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1528 def bgn_cartouche(self, args): pass
1529 def end_cartouche(self): pass
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1530
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1531 # --- Indices ---
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1532
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1533 def resetindex(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1534 self.noncodeindices = ['cp']
1535 self.indextitle = {}
1536 self.indextitle['cp'] = 'Concept'
1537 self.indextitle['fn'] = 'Function'
1538 self.indextitle['ky'] = 'Keyword'
1539 self.indextitle['pg'] = 'Program'
1540 self.indextitle['tp'] = 'Type'
1541 self.indextitle['vr'] = 'Variable'
1542 #
1543 self.whichindex = {}
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1544 for name in self.indextitle:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1545 self.whichindex[name] = []
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1546
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1547 def user_index(self, name, args):
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1548 if name in self.whichindex:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1549 self.index(name, args)
1550 else:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1551 print('*** No index named', repr(name))
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1552
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1553 def do_cindex(self, args): self.index('cp', args)
1554 def do_findex(self, args): self.index('fn', args)
1555 def do_kindex(self, args): self.index('ky', args)
1556 def do_pindex(self, args): self.index('pg', args)
1557 def do_tindex(self, args): self.index('tp', args)
1558 def do_vindex(self, args): self.index('vr', args)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1559
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1560 def index(self, name, args):
Guido van Rossum9c2c1e81998-10-08 15:24:48 +0000[diff] [blame]1561 self.whichindex[name].append((args, self.nodename))
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1562 self.htmlhelp.index(args, self.nodename)
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1563
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1564 def do_synindex(self, args):
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]1565 words = args.split()
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1566 if len(words) != 2:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1567 print('*** bad @synindex', args)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1568 return
1569 [old, new] = words
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1570 if old not in self.whichindex or \
1571 new not in self.whichindex:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1572 print('*** bad key(s) in @synindex', args)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1573 return
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1574 if old != new and \
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1575 self.whichindex[old] is not self.whichindex[new]:
1576 inew = self.whichindex[new]
1577 inew[len(inew):] = self.whichindex[old]
1578 self.whichindex[old] = inew
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1579 do_syncodeindex = do_synindex # XXX Should use code font
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1580
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1581 def do_printindex(self, args):
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]1582 words = args.split()
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1583 for name in words:
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1584 if name in self.whichindex:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1585 self.prindex(name)
1586 else:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1587 print('*** No index named', repr(name))
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1588
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1589 def prindex(self, name):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1590 iscodeindex = (name not in self.noncodeindices)
1591 index = self.whichindex[name]
1592 if not index: return
1593 if self.debugging:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1594 print('!'*self.debugging, '--- Generating', \
1595 self.indextitle[name], 'index')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1596 # The node already provides a title
1597 index1 = []
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]1598 junkprog = re.compile('^(@[a-z]+)?{')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1599 for key, node in index:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]1600 sortkey = key.lower()
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1601 # Remove leading `@cmd{' from sort key
1602 # -- don't bother about the matching `}'
1603 oldsortkey = sortkey
1604 while 1:
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]1605 mo = junkprog.match(sortkey)
1606 if not mo:
1607 break
1608 i = mo.end()
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1609 sortkey = sortkey[i:]
Guido van Rossum9c2c1e81998-10-08 15:24:48 +0000[diff] [blame]1610 index1.append((sortkey, key, node))
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1611 del index[:]
1612 index1.sort()
1613 self.write('<DL COMPACT>\n')
1614 prevkey = prevnode = None
1615 for sortkey, key, node in index1:
1616 if (key, node) == (prevkey, prevnode):
1617 continue
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1618 if self.debugging > 1: print('!'*self.debugging, key, ':', node)
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1619 self.write('<DT>')
1620 if iscodeindex: key = '@code{' + key + '}'
1621 if key != prevkey:
1622 self.expand(key)
1623 self.write('\n<DD><A HREF="%s">%s</A>\n' % (makefile(node), node))
1624 prevkey, prevnode = key, node
1625 self.write('</DL>\n')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1626
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1627 # --- Final error reports ---
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1628
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1629 def report(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1630 if self.unknown:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1631 print('--- Unrecognized commands ---')
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1632 cmds = sorted(self.unknown.keys())
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1633 for cmd in cmds:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1634 print(cmd.ljust(20), self.unknown[cmd])
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1635
1636
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1637class TexinfoParserHTML3(TexinfoParser):
1638
1639 COPYRIGHT_SYMBOL = "&copy;"
1640 FN_ID_PATTERN = "[%(id)s]"
1641 FN_SOURCE_PATTERN = '<A ID=footnoteref%(id)s ' \
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1642 'HREF="#footnotetext%(id)s">' + FN_ID_PATTERN + '</A>'
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1643 FN_TARGET_PATTERN = '<FN ID=footnotetext%(id)s>\n' \
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1644 '<P><A HREF="#footnoteref%(id)s">' + FN_ID_PATTERN \
1645 + '</A>\n%(text)s</P></FN>\n'
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1646 FN_HEADER = '<DIV CLASS=footnotes>\n <HR NOSHADE WIDTH=200>\n' \
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1647 ' <STRONG><EM>Footnotes</EM></STRONG>\n <P>\n'
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1648
1649 Node = HTML3Node
1650
1651 def bgn_quotation(self, args): self.write('<BQ>')
1652 def end_quotation(self): self.write('</BQ>\n')
1653
1654 def bgn_example(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1655 # this use of <CODE> would not be legal in HTML 2.0,
1656 # but is in more recent DTDs.
1657 self.nofill = self.nofill + 1
1658 self.write('<PRE CLASS=example><CODE>')
Fred Drakeabcb3821996-10-25 22:13:59 +0000[diff] [blame]1659 def end_example(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1660 self.write("</CODE></PRE>\n")
1661 self.nofill = self.nofill - 1
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1662
1663 def bgn_flushleft(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1664 self.nofill = self.nofill + 1
1665 self.write('<PRE CLASS=flushleft>\n')
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1666
1667 def bgn_flushright(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1668 self.nofill = self.nofill + 1
1669 self.write('<DIV ALIGN=right CLASS=flushright><ADDRESS COMPACT>\n')
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1670 def end_flushright(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1671 self.write('</ADDRESS></DIV>\n')
1672 self.nofill = self.nofill - 1
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1673
1674 def bgn_menu(self, args):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1675 self.write('<UL PLAIN CLASS=menu>\n')
1676 self.write(' <LH>Menu</LH>\n')
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1677 def end_menu(self):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1678 self.write('</UL>\n')
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]1679
1680
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1681# rpyron 2002-05-07
1682class HTMLHelp:
1683 """
1684 This class encapsulates support for HTML Help. Node names,
1685 file names, menu items, index items, and image file names are
1686 accumulated until a call to finalize(). At that time, three
1687 output files are created in the current directory:
1688
1689 `helpbase`.hhp is a HTML Help Workshop project file.
1690 It contains various information, some of
1691 which I do not understand; I just copied
1692 the default project info from a fresh
1693 installation.
1694 `helpbase`.hhc is the Contents file for the project.
1695 `helpbase`.hhk is the Index file for the project.
1696
1697 When these files are used as input to HTML Help Workshop,
1698 the resulting file will be named:
1699
1700 `helpbase`.chm
1701
1702 If none of the defaults in `helpbase`.hhp are changed,
1703 the .CHM file will have Contents, Index, Search, and
1704 Favorites tabs.
1705 """
1706
1707 codeprog = re.compile('@code{(.*?)}')
1708
1709 def __init__(self,helpbase,dirname):
1710 self.helpbase = helpbase
1711 self.dirname = dirname
1712 self.projectfile = None
1713 self.contentfile = None
1714 self.indexfile = None
1715 self.nodelist = []
1716 self.nodenames = {} # nodename : index
1717 self.nodeindex = {}
1718 self.filenames = {} # filename : filename
1719 self.indexlist = [] # (args,nodename) == (key,location)
1720 self.current = ''
1721 self.menudict = {}
1722 self.dumped = {}
1723
1724
1725 def addnode(self,name,next,prev,up,filename):
1726 node = (name,next,prev,up,filename)
1727 # add this file to dict
1728 # retrieve list with self.filenames.values()
1729 self.filenames[filename] = filename
1730 # add this node to nodelist
1731 self.nodeindex[name] = len(self.nodelist)
1732 self.nodelist.append(node)
1733 # set 'current' for menu items
1734 self.current = name
1735 self.menudict[self.current] = []
1736
1737 def menuitem(self,nodename):
1738 menu = self.menudict[self.current]
1739 menu.append(nodename)
1740
1741
1742 def addimage(self,imagename):
1743 self.filenames[imagename] = imagename
1744
1745 def index(self, args, nodename):
1746 self.indexlist.append((args,nodename))
1747
1748 def beginmenu(self):
1749 pass
1750
1751 def endmenu(self):
1752 pass
1753
1754 def finalize(self):
1755 if not self.helpbase:
1756 return
1757
1758 # generate interesting filenames
1759 resultfile = self.helpbase + '.chm'
1760 projectfile = self.helpbase + '.hhp'
1761 contentfile = self.helpbase + '.hhc'
1762 indexfile = self.helpbase + '.hhk'
1763
1764 # generate a reasonable title
1765 title = self.helpbase
1766
1767 # get the default topic file
1768 (topname,topnext,topprev,topup,topfile) = self.nodelist[0]
1769 defaulttopic = topfile
1770
1771 # PROJECT FILE
1772 try:
1773 fp = open(projectfile,'w')
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1774 print('[OPTIONS]', file=fp)
1775 print('Auto Index=Yes', file=fp)
1776 print('Binary TOC=No', file=fp)
1777 print('Binary Index=Yes', file=fp)
1778 print('Compatibility=1.1', file=fp)
1779 print('Compiled file=' + resultfile + '', file=fp)
1780 print('Contents file=' + contentfile + '', file=fp)
1781 print('Default topic=' + defaulttopic + '', file=fp)
1782 print('Error log file=ErrorLog.log', file=fp)
1783 print('Index file=' + indexfile + '', file=fp)
1784 print('Title=' + title + '', file=fp)
1785 print('Display compile progress=Yes', file=fp)
1786 print('Full-text search=Yes', file=fp)
1787 print('Default window=main', file=fp)
1788 print('', file=fp)
1789 print('[WINDOWS]', file=fp)
1790 print('main=,"' + contentfile + '","' + indexfile
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1791 + '","","",,,,,0x23520,222,0x1046,[10,10,780,560],'
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1792 '0xB0000,,,,,,0', file=fp)
1793 print('', file=fp)
1794 print('[FILES]', file=fp)
1795 print('', file=fp)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1796 self.dumpfiles(fp)
1797 fp.close()
Guido van Rossumb940e112007-01-10 16:19:56 +0000[diff] [blame]1798 except IOError as msg:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1799 print(projectfile, ':', msg)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1800 sys.exit(1)
1801
1802 # CONTENT FILE
1803 try:
1804 fp = open(contentfile,'w')
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1805 print('<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">', file=fp)
1806 print('<!-- This file defines the table of contents -->', file=fp)
1807 print('<HTML>', file=fp)
1808 print('<HEAD>', file=fp)
1809 print('<meta name="GENERATOR"'
1810 'content="Microsoft&reg; HTML Help Workshop 4.1">', file=fp)
1811 print('<!-- Sitemap 1.0 -->', file=fp)
1812 print('</HEAD>', file=fp)
1813 print('<BODY>', file=fp)
1814 print(' <OBJECT type="text/site properties">', file=fp)
1815 print(' <param name="Window Styles" value="0x800025">', file=fp)
1816 print(' <param name="comment" value="title:">', file=fp)
1817 print(' <param name="comment" value="base:">', file=fp)
1818 print(' </OBJECT>', file=fp)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1819 self.dumpnodes(fp)
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1820 print('</BODY>', file=fp)
1821 print('</HTML>', file=fp)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1822 fp.close()
Guido van Rossumb940e112007-01-10 16:19:56 +0000[diff] [blame]1823 except IOError as msg:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1824 print(contentfile, ':', msg)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1825 sys.exit(1)
1826
1827 # INDEX FILE
1828 try:
1829 fp = open(indexfile ,'w')
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1830 print('<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">', file=fp)
1831 print('<!-- This file defines the index -->', file=fp)
1832 print('<HTML>', file=fp)
1833 print('<HEAD>', file=fp)
1834 print('<meta name="GENERATOR"'
1835 'content="Microsoft&reg; HTML Help Workshop 4.1">', file=fp)
1836 print('<!-- Sitemap 1.0 -->', file=fp)
1837 print('</HEAD>', file=fp)
1838 print('<BODY>', file=fp)
1839 print('<OBJECT type="text/site properties">', file=fp)
1840 print('</OBJECT>', file=fp)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1841 self.dumpindex(fp)
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1842 print('</BODY>', file=fp)
1843 print('</HTML>', file=fp)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1844 fp.close()
Guido van Rossumb940e112007-01-10 16:19:56 +0000[diff] [blame]1845 except IOError as msg:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1846 print(indexfile , ':', msg)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1847 sys.exit(1)
1848
1849 def dumpfiles(self, outfile=sys.stdout):
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1850 filelist = sorted(self.filenames.values())
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1851 for filename in filelist:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1852 print(filename, file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1853
1854 def dumpnodes(self, outfile=sys.stdout):
1855 self.dumped = {}
1856 if self.nodelist:
Tim Peters4fba4522004-07-18 05:31:31 +0000[diff] [blame]1857 nodename, dummy, dummy, dummy, dummy = self.nodelist[0]
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1858 self.topnode = nodename
1859
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1860 print('<UL>', file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1861 for node in self.nodelist:
1862 self.dumpnode(node,0,outfile)
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1863 print('</UL>', file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1864
1865 def dumpnode(self, node, indent=0, outfile=sys.stdout):
1866 if node:
1867 # Retrieve info for this node
1868 (nodename,next,prev,up,filename) = node
1869 self.current = nodename
1870
1871 # Have we been dumped already?
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]1872 if nodename in self.dumped:
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1873 return
1874 self.dumped[nodename] = 1
1875
1876 # Print info for this node
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1877 print(' '*indent, end=' ', file=outfile)
1878 print('<LI><OBJECT type="text/sitemap">', end=' ', file=outfile)
1879 print('<param name="Name" value="' + nodename +'">', end=' ', file=outfile)
1880 print('<param name="Local" value="'+ filename +'">', end=' ', file=outfile)
1881 print('</OBJECT>', file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1882
1883 # Does this node have menu items?
1884 try:
1885 menu = self.menudict[nodename]
1886 self.dumpmenu(menu,indent+2,outfile)
1887 except KeyError:
1888 pass
1889
1890 def dumpmenu(self, menu, indent=0, outfile=sys.stdout):
1891 if menu:
1892 currentnode = self.current
1893 if currentnode != self.topnode: # XXX this is a hack
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1894 print(' '*indent + '<UL>', file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1895 indent += 2
1896 for item in menu:
1897 menunode = self.getnode(item)
1898 self.dumpnode(menunode,indent,outfile)
1899 if currentnode != self.topnode: # XXX this is a hack
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1900 print(' '*indent + '</UL>', file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1901 indent -= 2
1902
1903 def getnode(self, nodename):
1904 try:
1905 index = self.nodeindex[nodename]
1906 return self.nodelist[index]
1907 except KeyError:
1908 return None
1909 except IndexError:
1910 return None
1911
1912 # (args,nodename) == (key,location)
1913 def dumpindex(self, outfile=sys.stdout):
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1914 print('<UL>', file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1915 for (key,location) in self.indexlist:
1916 key = self.codeexpand(key)
1917 location = makefile(location)
1918 location = self.dirname + '/' + location
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]1919 print('<LI><OBJECT type="text/sitemap">', end=' ', file=outfile)
1920 print('<param name="Name" value="' + key + '">', end=' ', file=outfile)
1921 print('<param name="Local" value="' + location + '">', end=' ', file=outfile)
1922 print('</OBJECT>', file=outfile)
1923 print('</UL>', file=outfile)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]1924
1925 def codeexpand(self, line):
1926 co = self.codeprog.match(line)
1927 if not co:
1928 return line
1929 bgn, end = co.span(0)
1930 a, b = co.span(1)
1931 line = line[:bgn] + line[a:b] + line[end:]
1932 return line
1933
1934
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1935# Put @var{} around alphabetic substrings
1936def makevar(str):
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1937 return '@var{'+str+'}'
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1938
1939
1940# Split a string in "words" according to findwordend
1941def splitwords(str, minlength):
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1942 words = []
1943 i = 0
1944 n = len(str)
1945 while i < n:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1946 while i < n and str[i] in ' \t\n': i = i+1
1947 if i >= n: break
1948 start = i
1949 i = findwordend(str, i, n)
1950 words.append(str[start:i])
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1951 while len(words) < minlength: words.append('')
1952 return words
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1953
1954
1955# Find the end of a "word", matching braces and interpreting @@ @{ @}
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]1956fwprog = re.compile('[@{} ]')
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1957def findwordend(str, i, n):
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1958 level = 0
1959 while i < n:
Barry Warsaw6a508ae1998-04-23 22:59:33 +0000[diff] [blame]1960 mo = fwprog.search(str, i)
1961 if not mo:
1962 break
1963 i = mo.start()
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1964 c = str[i]; i = i+1
1965 if c == '@': i = i+1 # Next character is not special
1966 elif c == '{': level = level+1
1967 elif c == '}': level = level-1
1968 elif c == ' ' and level <= 0: return i-1
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1969 return n
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1970
1971
1972# Convert a node name into a file name
1973def makefile(nodename):
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]1974 nodename = nodename.strip()
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1975 return fixfunnychars(nodename) + '.html'
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1976
1977
1978# Characters that are perfectly safe in filenames and hyperlinks
Fred Drake79e75e12001-07-20 19:05:50 +0000[diff] [blame]1979goodchars = string.ascii_letters + string.digits + '!@-=+.'
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1980
Guido van Rossum06f42891995-08-28 03:01:00 +0000[diff] [blame]1981# Replace characters that aren't perfectly safe by dashes
1982# Underscores are bad since Cern HTTPD treats them as delimiters for
1983# encoding times, so you get mismatches if you compress your files:
1984# a.html.gz will map to a_b.html.gz
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1985def fixfunnychars(addr):
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1986 i = 0
1987 while i < len(addr):
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1988 c = addr[i]
1989 if c not in goodchars:
1990 c = '-'
1991 addr = addr[:i] + c + addr[i+1:]
1992 i = i + len(c)
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1993 return addr
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]1994
1995
1996# Increment a string used as an enumeration
1997def increment(s):
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]1998 if not s:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]1999 return '1'
Martin v. Löwis967f1e32007-08-14 09:23:10 +0000[diff] [blame]2000 for sequence in string.digits, string.ascii_lowercase, string.ascii_uppercase:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2001 lastc = s[-1]
2002 if lastc in sequence:
Fred Drakeae39ddd2002-06-18 15:37:05 +0000[diff] [blame]2003 i = sequence.index(lastc) + 1
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2004 if i >= len(sequence):
2005 if len(s) == 1:
2006 s = sequence[0]*2
2007 if s == '00':
2008 s = '10'
2009 else:
2010 s = increment(s[:-1]) + sequence[0]
2011 else:
2012 s = s[:-1] + sequence[i]
2013 return s
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]2014 return s # Don't increment
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]2015
2016
2017def test():
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]2018 import sys
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]2019 debugging = 0
2020 print_headers = 0
2021 cont = 0
2022 html3 = 0
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2023 htmlhelp = ''
Tim Peters70c43782001-01-17 08:48:39 +0000[diff] [blame]2024
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2025 while sys.argv[1] == ['-d']:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2026 debugging = debugging + 1
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2027 del sys.argv[1]
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]2028 if sys.argv[1] == '-p':
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2029 print_headers = 1
2030 del sys.argv[1]
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]2031 if sys.argv[1] == '-c':
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2032 cont = 1
2033 del sys.argv[1]
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]2034 if sys.argv[1] == '-3':
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2035 html3 = 1
2036 del sys.argv[1]
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2037 if sys.argv[1] == '-H':
2038 helpbase = sys.argv[2]
2039 del sys.argv[1:3]
Georg Brandl8efadf52008-05-16 15:23:30 +0000[diff] [blame]2040 if len(sys.argv) != 3:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]2041 print('usage: texi2hh [-d [-d]] [-p] [-c] [-3] [-H htmlhelp]', \
2042 'inputfile outputdirectory')
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2043 sys.exit(2)
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]2044
2045 if html3:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2046 parser = TexinfoParserHTML3()
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]2047 else:
Guido van Rossumcaf9fca1998-09-14 16:03:02 +0000[diff] [blame]2048 parser = TexinfoParser()
Fred Drake02827261996-10-09 19:05:12 +0000[diff] [blame]2049 parser.cont = cont
2050 parser.debugging = debugging
2051 parser.print_headers = print_headers
2052
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]2053 file = sys.argv[1]
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2054 dirname = sys.argv[2]
2055 parser.setdirname(dirname)
Tim Peters4fba4522004-07-18 05:31:31 +0000[diff] [blame]2056 parser.setincludedir(os.path.dirname(file))
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2057
2058 htmlhelp = HTMLHelp(helpbase, dirname)
2059 parser.sethtmlhelp(htmlhelp)
2060
Tim Peters4fba4522004-07-18 05:31:31 +0000[diff] [blame]2061 try:
2062 fp = open(file, 'r')
Guido van Rossumb940e112007-01-10 16:19:56 +0000[diff] [blame]2063 except IOError as msg:
Collin Winter6afaeb72007-08-03 17:06:41 +0000[diff] [blame]2064 print(file, ':', msg)
Tim Peters4fba4522004-07-18 05:31:31 +0000[diff] [blame]2065 sys.exit(1)
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2066
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]2067 parser.parse(fp)
2068 fp.close()
2069 parser.report()
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]2070
Fred Drakeef5864e2002-06-18 15:21:21 +0000[diff] [blame]2071 htmlhelp.finalize()
2072
Guido van Rossum26a9d371995-03-15 11:26:05 +0000[diff] [blame]2073
Fred Drakea39a25e1996-09-13 14:44:34 +0000[diff] [blame]2074if __name__ == "__main__":
2075 test()