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