summaryrefslogtreecommitdiffstats
path: root/Demo/tkinter/guido/ManPage.py
blob: 993a3db41d7536f8108cd775ec7b08c59b528784 (plain)
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
# Widget to display a man page

import regex
from Tkinter import *
from ScrolledText import ScrolledText

# XXX These fonts may have to be changed to match your system
BOLDFONT = '*-Courier-Bold-R-Normal-*-120-*'
ITALICFONT = '*-Courier-Medium-O-Normal-*-120-*'

# XXX Recognizing footers is system dependent
# (This one works for IRIX 5.2 and Solaris 2.2)
footerprog = regex.compile(
	'^     Page [1-9][0-9]*[ \t]+\|^.*Last change:.*[1-9][0-9]*\n')
emptyprog = regex.compile('^[ \t]*\n')
ulprog = regex.compile('^[ \t]*[Xv!_][Xv!_ \t]*\n')

# Basic Man Page class -- does not disable editing
class EditableManPage(ScrolledText):

	def __init__(self, master=None, cnf={}):
		# Initialize base class
		ScrolledText.__init__(self, master, cnf)

		# Define tags for formatting styles
		self.text.tag_config('bold', {'font': BOLDFONT})
		self.text.tag_config('italic', {'font': ITALICFONT})
		self.text.tag_config('underline', {'underline': 1})

		# Create mapping from characters to tags
		self.tagmap = {
			'X': 'bold',
			'_': 'underline',
			'!': 'italic',
			}

	# Parse nroff output piped through ul -i and append it to the
	# text widget
	def parsefile(self, fp):
		save_cursor = self.text['cursor']
		self.text['cursor'] = 'watch'
		self.text.update()
		ok = 0
		empty = 0
		nextline = None
		while 1:
			if nextline:
				line = nextline
				nextline = None
			else:
				line = fp.readline()
				if not line:
					break
			if emptyprog.match(line) >= 0:
				empty = 1
				continue
			nextline = fp.readline()
			if nextline and ulprog.match(nextline) >= 0:
				propline = nextline
				nextline = None
			else:
				propline = ''
			if not ok:
				ok = 1
				empty = 0
				continue
			if footerprog.match(line) >= 0:
				ok = 0
				empty = 0
				continue
			if empty:
				self.insert_prop('\n')
				empty = 0
			p = ''
			j = 0
			for i in range(min(len(propline), len(line))):
				if propline[i] != p:
					if j < i:
						self.insert_prop(line[j:i], p)
						j = i
					p = propline[i]
			self.insert_prop(line[j:])
		self.text['cursor'] = save_cursor

	def insert_prop(self, str, prop = ' '):
		here = self.text.index(AtInsert())
		self.text.insert(AtInsert(), str)
		for tag in self.tagmap.values():
			self.text.tag_remove(tag, here, AtInsert())
		if self.tagmap.has_key(prop):
			self.text.tag_add(self.tagmap[prop], here, AtInsert())

# Readonly Man Page class -- disables editing, otherwise the same
class ReadonlyManPage(EditableManPage):

	def __init__(self, master=None, cnf={}):
		# Initialize base class
		EditableManPage.__init__(self, master, cnf)

		# Make the text readonly
		self.text.bind('<Any-KeyPress>', self.modify_cb)
		self.text.bind('<Return>', self.modify_cb)
		self.text.bind('<BackSpace>', self.modify_cb)
		self.text.bind('<Delete>', self.modify_cb)
		self.text.bind('<Control-h>', self.modify_cb)
		self.text.bind('<Control-d>', self.modify_cb)
		self.text.bind('<Control-v>', self.modify_cb)

	def modify_cb(self, e):
		pass

# Alias
ManPage = ReadonlyManPage

# Test program.
# usage: ManPage [manpage]; or ManPage [-f] file
# -f means that the file is nroff -man output run through ul -i
def test():
	import os
	import sys
	# XXX This directory may be different on your system
	MANDIR = '/usr/local/man/mann'
	DEFAULTPAGE = 'Tcl'
	formatted = 0
	if sys.argv[1:] and sys.argv[1] == '-f':
		formatted = 1
		del sys.argv[1]
	if sys.argv[1:]:
		name = sys.argv[1]
	else:
		name = DEFAULTPAGE
	if not formatted:
		if name[-2:-1] != '.':
			name = name + '.n'
		name = os.path.join(MANDIR, name)
	root = Tk()
	root.minsize(1, 1)
	manpage = ManPage(root, {'relief': 'sunken', 'bd': 2,
				 Pack: {'expand': 1, 'fill': 'both'}})
	if formatted:
		fp = open(name, 'r')
	else:
		fp = os.popen('nroff -man %s | ul -i' % name, 'r')
	manpage.parsefile(fp)
	root.mainloop()

# Run the test program when called as a script
if __name__ == '__main__':
	test()