File: html2man.py

package info (click to toggle)
ftplib 3.1-1-4
  • links: PTS
  • area: main
  • in suites: woody
  • size: 648 kB
  • ctags: 597
  • sloc: ansic: 2,990; python: 152; makefile: 149; sh: 30
file content (189 lines) | stat: -rw-r--r-- 4,831 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#! /usr/bin/python
# HTML to manpage converter, written for ftplib.
# This program was written by Richard Braakman <dark@xs4all.nl>
# The author places it in the public domain.

import time
import sys
import string
import os
import stat
from sgmllib import SGMLParser

class PageParser(SGMLParser):
    def __init__(self, receiver):
	SGMLParser.__init__(self, 0)
	self.receiver = receiver
	self.data = None

    # Data-handling mechanism borrowed from HTMLParser

    def handle_data(self, data):
	if self.data is not None:
	    self.data = self.data + data
	else:
	    self.receiver.add_text(data)

    def save_bgn(self):
        self.data = ''

    def save_end(self):
        data = self.data
        self.data = None
        return string.join(string.split(data))

    def start_html(self, attrs):
	pass
    def end_html(self):
	self.receiver.finish()

    def start_title(self, attrs):
	self.save_bgn()
    def end_title(self):
	# This used to set the title, but it will be the same as
	# the title in the <h1> block anyway, which is more convenient.
	self.save_end()

    def start_h1(self, attrs):
	self.save_bgn()
    def end_h1(self):
	self.receiver.set_title(self.save_end())
	self.receiver.write_intro()

    def start_h2(self, attrs):
	self.save_bgn()
    def end_h2(self):
	self.receiver.make_header(self.save_end())

    def do_p(self, attrs):
	self.receiver.start_paragraph()

    def do_dt(self, attrs):
	self.save_bgn()
    def do_dd(self, attrs):
	self.receiver.start_tab(self.save_end())

    def start_pre(self, attrs):
	self.save_bgn()
    def end_pre(self):
	self.receiver.preformatted(self.save_end())

class PageWriter:
    def __init__(self, outfile):
	self.out = outfile
	self.title = None
	self.mtime = None
	self.need_newline = 0
	self.suppress_paragraph = 0

    def writeout(self, data):
	self.out.write(data)

    def set_time(self, time):
	self.mtime = time

    def prettydate(self):
	return time.strftime('"%d %B %Y"', time.localtime(self.mtime))

    def opt_newline(self):
	if self.need_newline:
	    self.writeout("\n")
	self.need_newline = 0

    def add_text(self, data):
	if len(data) == 0:
	    return
	if data[-1] == " ":
	    data = string.join(string.split(data)) + " "
	else:
	    data = string.join(string.split(data))
	if len(data) == 0:
	    return
        self.writeout(data)
	self.need_newline = 1

    def set_title(self, title):
	self.title = title

    def write_intro(self):
	self.writeout(".\\\" This manual page was generated from the file " +
		      self.title + ".html.\n")
	self.writeout(".TH " + self.title + " 3 " + self.prettydate() +
                      " FTPlib\n")
	self.writeout(".SH NAME\n" + self.title + " \- ");
	self.suppress_paragraph = 1
	self.need_newline = 1

    def preformatted(self, text):
	self.opt_newline
	# Parse include directives
	rb = string.find(text, ">")
	while rb >= 0:
	    self.writeout('.B "' + text[:rb+1] + '"\n.br\n')
	    text = text[rb+2:]
	    rb = string.find(text, ">")
	self.writeout('.sp\n')
	# Next comes a function prototype.
	parmstart = string.index(text, "(")
	if text[parmstart:] == "(void);":
	    self.writeout('.B "' + text + '"\n')
	    return
	parms = string.split(text[parmstart+1:-2], ", ")
	self.writeout('.BI "' + text[:parmstart+1])
	length = parmstart+1
	for i in range(len(parms)):
	    parm = parms[i]
	    if length + len(parm) > 55:
		self.writeout('"\n.RS\n.BI "')
		length = 8
	    else:
		length = length + len(parm) + 2
	    end = string.rindex(parm, " ")
	    while parm[end+1] == "*":
		end = end + 1
	    self.writeout(parm[:end+1] + '" ' + parm[end+1:] + ' "')
	    if i + 1 < len(parms):
		self.writeout(', ')
	self.writeout(text[-2:] + '"\n')

    def make_header(self, header):
	self.opt_newline()
	self.writeout('.SH "' + header + '"\n');

    def start_paragraph(self):
	if self.suppress_paragraph:
	    self.suppress_paragraph = 0
	else:
	    self.opt_newline()
	    self.writeout(".LP\n")

    def start_tab(self, heading):
	self.opt_newline()
	self.writeout('.TP\n.B "' + heading + '"\n')

    def finish(self):
	self.opt_newline()

def convert(filename):
    begin = string.rfind(filename, "/")
    if begin >= 0:
	filename = filename[begin+1:]
    end = string.rindex(filename, ".html")
    return filename[:end] + ".3"

if len(sys.argv) < 3:
    sys.stderr.write("Usage: html2man filenames... dirname\n")
else:
    dirname = sys.argv[-1]
    for filename in sys.argv[1:-1]:
	outfilename = os.path.join(dirname, convert(filename))
        infile = open(filename, "r")
	outfile = open(outfilename, "w")
	timestamp = os.fstat(infile.fileno())[stat.ST_MTIME]
        receiver = PageWriter(outfile)
        receiver.set_time(timestamp)
        parser = PageParser(receiver)
        parser.feed(infile.read())
	infile.close()
	outfile.close()
	os.utime(outfilename, (timestamp, timestamp))