tkman.py 6.91 KB
Newer Older
1
#! /usr/bin/env python
Guido van Rossum's avatar
Guido van Rossum committed
2 3 4 5 6 7 8 9 10 11

# Tk man page browser -- currently only shows the Tcl/Tk man pages

import sys
import os
import string
import regex
from Tkinter import *
from ManPage import ManPage

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
MANNDIRLIST = ['/depot/sundry/man/mann','/usr/local/man/mann']
MAN3DIRLIST = ['/depot/sundry/man/man3','/usr/local/man/man3']

foundmanndir = 0
for dir in MANNDIRLIST:
    if os.path.exists(dir):
	MANNDIR = dir
	foundmanndir = 1

foundman3dir = 0
for dir in MAN3DIRLIST:
    if os.path.exists(dir):
	MAN3DIR = dir
	foundman3dir =  1

if not foundmanndir or not foundman3dir:
    sys.stderr.write('\n')
    if not foundmanndir:
	msg = """\
Failed to find mann directory.
Please add the correct entry to the MANNDIRLIST 
at the top of %s script.""" % \
sys.argv[0]
	sys.stderr.write("%s\n\n" % msg)
    if not foundman3dir:
	msg = """\
Failed to find man3 directory.
Please add the correct entry to the MAN3DIRLIST 
at the top of %s script.""" % \
sys.argv[0]
	sys.stderr.write("%s\n\n" % msg)
    sys.exit(1)

del foundmanndir
del foundman3dir
Guido van Rossum's avatar
Guido van Rossum committed
47

48
def listmanpages(mandir):
Guido van Rossum's avatar
Guido van Rossum committed
49 50 51
	files = os.listdir(mandir)
	names = []
	for file in files:
52
		if file[-2:-1] == '.' and  (file[-1] in 'ln123456789'):
Guido van Rossum's avatar
Guido van Rossum committed
53 54 55 56 57 58 59 60 61
			names.append(file[:-2])
	names.sort()
	return names

class SelectionBox:

	def __init__(self, master=None):
		self.choices = []

62 63
		self.frame = Frame(master, name="frame")
		self.frame.pack(expand=1, fill=BOTH)
Guido van Rossum's avatar
Guido van Rossum committed
64
		self.master = self.frame.master
65 66 67 68 69 70
		self.subframe = Frame(self.frame, name="subframe")
		self.subframe.pack(expand=0, fill=BOTH)
		self.leftsubframe = Frame(self.subframe, name='leftsubframe')
		self.leftsubframe.pack(side=LEFT, expand=1, fill=BOTH)
		self.rightsubframe = Frame(self.subframe, name='rightsubframe')
		self.rightsubframe.pack(side=RIGHT, expand=1, fill=BOTH)
71
		self.chaptervar = StringVar(master)
72 73 74 75 76 77 78 79 80 81 82 83 84
		self.chapter = Menubutton(self.rightsubframe, name='chapter',
					  text='Directory', relief=RAISED,
					  borderwidth=2)
		self.chapter.pack(side=TOP)
		self.chaptermenu = Menu(self.chapter, name='chaptermenu')
		self.chaptermenu.add_radiobutton(label='C functions',
						 value=MAN3DIR,
						 variable=self.chaptervar,
						 command=self.newchapter)
		self.chaptermenu.add_radiobutton(label='Tcl/Tk functions',
						 value=MANNDIR,
						 variable=self.chaptervar,
						 command=self.newchapter)
85
		self.chapter['menu'] = self.chaptermenu
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
		self.listbox = Listbox(self.rightsubframe, name='listbox',
				       relief=SUNKEN, borderwidth=2,
				       width=20, height=5)
		self.listbox.pack(expand=1, fill=BOTH)
		self.l1 = Button(self.leftsubframe, name='l1',
				 text='Display manual page named:',
				 command=self.entry_cb)
		self.l1.pack(side=TOP)
		self.entry = Entry(self.leftsubframe, name='entry',
				    relief=SUNKEN, borderwidth=2,
				    width=20)
		self.entry.pack(expand=0, fill=X)
		self.l2frame = Frame(self.leftsubframe, name='l2frame')
		self.l2frame.pack(expand=0, fill=NONE)
		self.l2 = Button(self.l2frame, name='l2',
				 text='Search regexp:',
				 command=self.search_cb)
		self.l2.pack(side=LEFT)
		self.casevar = BooleanVar()
		self.casesense = Checkbutton(self.l2frame, name='casesense',
					     text='Case sensitive',
					     variable=self.casevar,
					     relief=FLAT)
		self.casesense.pack(side=LEFT)
		self.search = Entry(self.leftsubframe, name='search',
				    relief=SUNKEN, borderwidth=2,
				    width=20)
		self.search.pack(expand=0, fill=X)
		self.title = Label(self.leftsubframe, name='title',
				   text='(none)')
		self.title.pack(side=BOTTOM)
		self.text = ManPage(self.frame, name='text',
				    relief=SUNKEN, borderwidth=2,
				    wrap=NONE, width=72,
				    selectbackground='pink')
		self.text.pack(expand=1, fill=BOTH)
Guido van Rossum's avatar
Guido van Rossum committed
122 123 124 125 126

		self.entry.bind('<Return>', self.entry_cb)
		self.search.bind('<Return>', self.search_cb)
		self.listbox.bind('<Double-1>', self.listbox_cb)

127 128 129
		self.entry.bind('<Tab>', self.entry_tab)
		self.search.bind('<Tab>', self.search_tab)
		self.text.bind('<Tab>', self.text_tab)
Guido van Rossum's avatar
Guido van Rossum committed
130

131
		self.entry.focus_set()
Guido van Rossum's avatar
Guido van Rossum committed
132

133 134 135 136 137 138 139 140
		self.chaptervar.set(MANNDIR)
		self.newchapter()

	def newchapter(self):
		mandir = self.chaptervar.get()
		self.choices = []
		self.addlist(listmanpages(mandir))

Guido van Rossum's avatar
Guido van Rossum committed
141 142 143 144 145 146 147 148 149 150 151
	def addchoice(self, choice):
		if choice not in self.choices:
			self.choices.append(choice)
			self.choices.sort()
		self.update()

	def addlist(self, list):
		self.choices[len(self.choices):] = list
		self.choices.sort()
		self.update()

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
	def entry_cb(self, *e):
		self.update()

	def listbox_cb(self, e):
		selection = self.listbox.curselection()
		if selection and len(selection) == 1:
			name = self.listbox.get(selection[0])
			self.show_page(name)

	def search_cb(self, *e):
		self.search_string(self.search.get())

	def entry_tab(self, e):
		self.search.focus_set()

	def search_tab(self, e):
		self.entry.focus_set()

	def text_tab(self, e):
		self.entry.focus_set()

Guido van Rossum's avatar
Guido van Rossum committed
173 174 175 176
	def updatelist(self):
		key = self.entry.get()
		ok = filter(lambda name, key=key, n=len(key): name[:n]==key,
			 self.choices)
177 178
		if not ok:
			self.frame.bell()
Guido van Rossum's avatar
Guido van Rossum committed
179 180 181 182 183 184 185
		self.listbox.delete(0, AtEnd())
		exactmatch = 0
		for item in ok:
			if item == key: exactmatch = 1
			self.listbox.insert(AtEnd(), item)
		if exactmatch:
			return key
186 187
		n = self.listbox.size()
		if n == 1:
Guido van Rossum's avatar
Guido van Rossum committed
188
			return self.listbox.get(0)
189
		# Else return None, meaning not a unique selection
Guido van Rossum's avatar
Guido van Rossum committed
190 191

	def update(self):
192 193 194 195 196
		name = self.updatelist()
		if name:
			self.show_page(name)
			self.entry.delete(0, AtEnd())
			self.updatelist()
Guido van Rossum's avatar
Guido van Rossum committed
197 198

	def show_page(self, name):
199
		file = '%s/%s.?' % (self.chaptervar.get(), name)
200 201 202
		fp = os.popen('nroff -man %s | ul -i' % file, 'r')
		self.text.kill()
		self.title['text'] = name
Guido van Rossum's avatar
Guido van Rossum committed
203 204 205 206
		self.text.parsefile(fp)

	def search_string(self, search):
		if not search:
207
			self.frame.bell()
Guido van Rossum's avatar
Guido van Rossum committed
208 209
			print 'Empty search string'
			return
210
		if not self.casevar.get():
211 212 213
			map = regex.casefold
		else:
			map = None
Guido van Rossum's avatar
Guido van Rossum committed
214
		try:
215 216 217 218
			if map:
				prog = regex.compile(search, map)
			else:
				prog = regex.compile(search)
Guido van Rossum's avatar
Guido van Rossum committed
219
		except regex.error, msg:
220
			self.frame.bell()
Guido van Rossum's avatar
Guido van Rossum committed
221 222 223 224 225 226 227
			print 'Regex error:', msg
			return
		here = self.text.index(AtInsert())
		lineno = string.atoi(here[:string.find(here, '.')])
		end = self.text.index(AtEnd())
		endlineno = string.atoi(end[:string.find(end, '.')])
		wraplineno = lineno
228
		found = 0
Guido van Rossum's avatar
Guido van Rossum committed
229 230 231 232 233 234 235 236 237 238 239 240
		while 1:
			lineno = lineno + 1
			if lineno > endlineno:
				if wraplineno <= 0:
					break
				endlineno = wraplineno
				lineno = 0
				wraplineno = 0
			line = self.text.get('%d.0 linestart' % lineno,
					     '%d.0 lineend' % lineno)
			i = prog.search(line)
			if i >= 0:
241
				found = 1
Guido van Rossum's avatar
Guido van Rossum committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255
				n = max(1, len(prog.group(0)))
				try:
					self.text.tag_remove('sel',
							     AtSelFirst(),
							     AtSelLast())
				except TclError:
					pass
				self.text.tag_add('sel',
						  '%d.%d' % (lineno, i),
						  '%d.%d' % (lineno, i+n))
				self.text.mark_set(AtInsert(),
						   '%d.%d' % (lineno, i))
				self.text.yview_pickplace(AtInsert())
				break
256 257
		if not found:
			self.frame.bell()
Guido van Rossum's avatar
Guido van Rossum committed
258 259 260 261 262 263 264 265 266 267

def main():
	root = Tk()
	sb = SelectionBox(root)
	if sys.argv[1:]:
		sb.show_page(sys.argv[1])
	root.minsize(1, 1)
	root.mainloop()

main()