28832
|
1 ;;; woman.el --- browse UN*X manual pages `wo (without) man'
|
|
2
|
|
3 ;; Copyright (C) 2000 Free Software Foundation, Inc.
|
|
4
|
38436
|
5 ;; Author: Francis J. Wright <F.J.Wright@Maths.QMW.ac.uk>
|
|
6 ;; Maintainer: Francis J. Wright <F.J.Wright@Maths.QMW.ac.uk>
|
|
7 ;; Keywords: help, man, UN*X, manual
|
|
8 ;; Adapted-By: Eli Zaretskii <eliz@is.elta.co.il>
|
|
9 ;; Version: see `woman-version'
|
|
10 ;; URL: http://centaur.maths.qmw.ac.uk/Emacs/WoMan/
|
28832
|
11
|
|
12 ;; This file is part of GNU Emacs.
|
|
13
|
|
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
15 ;; it under the terms of the GNU General Public License as published by
|
|
16 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
17 ;; any later version.
|
|
18
|
|
19 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
22 ;; GNU General Public License for more details.
|
|
23
|
|
24 ;; You should have received a copy of the GNU General Public License
|
|
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
27 ;; Boston, MA 02111-1307, USA.
|
|
28
|
|
29 ;;; Commentary:
|
|
30
|
|
31 ;; WoMan implements a subset of the formatting performed by the Emacs
|
|
32 ;; `man' (or `manual-entry') command to format a UN*X manual `page'
|
|
33 ;; for display, but without calling any external programs. It is
|
|
34 ;; intended to emulate the whole of the -man macro package, plus those
|
|
35 ;; ?roff requests that are most commonly used in man pages. However,
|
|
36 ;; the emulation is modified to include the reformatting done by the
|
|
37 ;; Emacs `man' command. No hyphenation is performed.
|
|
38
|
|
39 ;; Advantages
|
|
40
|
|
41 ;; Much more direct, does not require any external programs.
|
|
42 ;; Supports completion on man page names.
|
|
43
|
|
44 ;; Disadvantages
|
|
45
|
|
46 ;; Not a complete emulation. Currently no support for eqn or tbl.
|
|
47 ;; Slightly slower for large man pages (but usually faster for
|
|
48 ;; small- and medium-size pages).
|
|
49
|
|
50 ;; This browser works quite well on simple well-written man files. It
|
|
51 ;; works less well on idiosyncratic files that `break the rules' or
|
|
52 ;; use the more obscure ?roff requests directly. Current test results
|
|
53 ;; are available in the file woman.status.
|
|
54
|
|
55 ;; WoMan supports the use of compressed man files via
|
|
56 ;; `auto-compression-mode' by turning it on if necessary. But you may
|
|
57 ;; need to adjust the user option `woman-file-compression-regexp'.
|
|
58
|
|
59 ;; Read on for (currently) the only documentation for WoMan!
|
|
60
|
|
61 ;; See also the documentation for the WoMan interactive commands and
|
|
62 ;; user option variables, all of which begin with the prefix `woman-'.
|
|
63 ;; This can be done most easily by loading WoMan and then running the
|
|
64 ;; command `woman-mini-help', or selecting the WoMan menu option `Mini
|
|
65 ;; Help' when WoMan is running.
|
|
66
|
|
67 ;; WoMan is still under development! Please let me know what doesn't
|
|
68 ;; work -- I am adding and improving functionality as testing shows
|
|
69 ;; that it is necessary. See below for guidance on reporting bugs.
|
|
70
|
|
71 ;; Recommended use
|
|
72 ;; ===============
|
|
73
|
|
74 ;; Put this in your .emacs:
|
|
75 ;; (autoload 'woman "woman"
|
|
76 ;; "Decode and browse a UN*X man page." t)
|
|
77 ;; (autoload 'woman-find-file "woman"
|
|
78 ;; "Find, decode and browse a specific UN*X man-page file." t)
|
|
79
|
|
80 ;; Then either (1 -- *RECOMMENDED*): If the `MANPATH' environment
|
|
81 ;; variable is set then WoMan will use it; otherwise you may need to
|
|
82 ;; reset the Lisp variable `woman-manpath', and you may also want to
|
|
83 ;; set the Lisp variable `woman-path'. Please see the online
|
|
84 ;; documentation for these variables. Now you can execute the
|
|
85 ;; extended command `woman', enter or select a manual entry topic,
|
|
86 ;; using completion, and if necessary select a filename, using
|
|
87 ;; completion. By default, WoMan suggests the word nearest to the
|
|
88 ;; cursor in the current buffer as the topic.
|
|
89
|
|
90 ;; Or (2): Execute the extended command `woman-find-file' and enter a
|
|
91 ;; filename, using completion. This mode of execution may be useful
|
|
92 ;; for temporary files outside the standard UN*X manual directory
|
|
93 ;; structure.
|
|
94
|
|
95 ;; Or (3): Put the next two sexpr's in your .emacs:
|
|
96 ;; (autoload 'woman-dired-find-file "woman"
|
|
97 ;; "In dired, run the WoMan man-page browser on this file." t)
|
|
98 ;; (add-hook 'dired-mode-hook
|
29074
|
99 ;; (lambda ()
|
|
100 ;; (define-key dired-mode-map "W" 'woman-dired-find-file)))
|
28832
|
101 ;; and open the directory containing the man page file using dired,
|
|
102 ;; put the cursor on the file, and press `W'.
|
|
103
|
|
104 ;; In each case, the result should (!) be a buffer in Man mode showing
|
|
105 ;; a formatted manual entry. When called from WoMan, Man mode should
|
|
106 ;; work as advertised, but modified where necessary in the context of
|
|
107 ;; WoMan. (However, `Man' will still invoke the standard Emacs
|
|
108 ;; manual-browsing facility rather than `WoMan' -- this is
|
|
109 ;; intentional!)
|
|
110
|
|
111 ;; (By default, WoMan will automatically define the dired keys "W" and
|
|
112 ;; "w" when it loads, but only if they are not already defined. This
|
|
113 ;; behaviour is controlled by the user option `woman-dired-keys'.
|
|
114 ;; Note that the `dired-x' (dired extra) package binds
|
|
115 ;; `dired-copy-filename-as-kill' to the key "w" (as pointed out by Jim
|
|
116 ;; Davidson), although "W" appears to be really unused. The `dired-x'
|
|
117 ;; package will over-write the WoMan binding to "w", whereas (by
|
|
118 ;; default) WoMan will not overwrite the `dired-x' binding.)
|
|
119
|
|
120 ;; The following is based on suggestions by Guy Gascoigne-Piggford and
|
|
121 ;; Juanma Barranquero. If you really want to square the man-woman
|
|
122 ;; circle then you might care to define the following bash function in
|
|
123 ;; .bashrc:
|
|
124
|
|
125 ;; man() { gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; }
|
|
126
|
|
127 ;; If you use Microsoft COMMAND.COM then you can create a file called
|
|
128 ;; man.bat somewhere in your path containing the two lines:
|
|
129
|
|
130 ;; @echo off
|
|
131 ;; gnudoit -q (raise-frame (selected-frame)) (woman \"%1\")
|
|
132
|
|
133 ;; and then (e.g. from a command prompt or the Run... option in the
|
|
134 ;; Start menu) just execute
|
|
135
|
|
136 ;; man man_page_name
|
|
137
|
|
138
|
|
139 ;; Using the `word at point' as a topic suggestion
|
|
140 ;; ===============================================
|
|
141
|
|
142 ;; By default, the `woman' command uses the word nearest to point in
|
|
143 ;; the current buffer as a suggestion for the topic to look up. The
|
|
144 ;; topic must be confirmed or edited in the minibuffer. This
|
|
145 ;; suggestion can be turned off, or `woman' can use the suggested
|
|
146 ;; topic without confirmation* if possible, by setting the user-option
|
|
147 ;; `woman-topic-at-point' to nil or t respectively. (Its default
|
|
148 ;; value is neither nil nor t, meaning ask for confirmation.)
|
|
149
|
|
150 ;; [* Thanks to Benjamin Riefenstahl for suggesting this
|
|
151 ;; functionality.]
|
|
152
|
|
153 ;; The variable `woman-topic-at-point' can be rebound locally, which
|
|
154 ;; may be useful to provide special private key bindings, e.g.
|
|
155
|
|
156 ;; (global-set-key "\C-cw"
|
29074
|
157 ;; (lambda ()
|
28832
|
158 ;; (interactive)
|
|
159 ;; (let ((woman-topic-at-point t))
|
|
160 ;; (woman)))))
|
|
161
|
|
162
|
|
163 ;; Customization, Hooks and Imenu
|
|
164 ;; ==============================
|
|
165
|
|
166 ;; WoMan supports the GNU Emacs 20+ customization facility, and puts
|
|
167 ;; a customization group called `WoMan' in the `Help' group under the
|
|
168 ;; top-level `Emacs' group. In order to be able to customize WoMan
|
|
169 ;; without first loading it, add the following sexp to your .emacs:
|
|
170
|
|
171 ;; (defgroup woman nil
|
|
172 ;; "Browse UNIX manual pages `wo (without) man'."
|
|
173 ;; :tag "WoMan" :group 'help :load "woman")
|
|
174
|
|
175
|
|
176 ;; WoMan currently runs two hooks: `woman-pre-format-hook' immediately
|
|
177 ;; before formatting a buffer and `woman-post-format-hook' immediately
|
|
178 ;; after formatting a buffer. These hooks can be used for special
|
|
179 ;; customizations that require code to be executed, etc., although
|
|
180 ;; most customization should be possible by setting WoMan user option
|
|
181 ;; variables, e.g. in `.emacs' and should NOT require the use of the
|
|
182 ;; hooks. `woman-pre-format-hook' might be appropriate for face
|
|
183 ;; customization, whereas `woman-post-format-hook' might be
|
|
184 ;; appropriate for installing a dynamic menu using `imenu' (although
|
|
185 ;; it is better to use the built-in WoMan imenu support).
|
|
186
|
|
187 ;; The WoMan menu provides an option to make a contents menu for the
|
|
188 ;; current man page (using imenu). Alternatively, if you set the
|
|
189 ;; variable `woman-imenu' to `t' then WoMan will do it automatically
|
|
190 ;; for every man page. The menu title is the value of the variable
|
|
191 ;; `woman-imenu-title', which is "CONTENTS" by default. By default,
|
|
192 ;; the menu shows manual sections and subsections, but you can change
|
|
193 ;; this by changing the value of `woman-imenu-generic-expression'.
|
|
194 ;; This facility is not yet widely tested and may be fooled by obscure
|
|
195 ;; man pages that `break the rules'.
|
|
196
|
|
197 ;; WoMan is configured not to replace spaces in an imenu *Completion*
|
|
198 ;; buffer. For further documentation of the use of imenu, such as
|
|
199 ;; menu sorting, see the source file imenu.el, which is distributed
|
|
200 ;; with GNU Emacs.
|
|
201
|
|
202 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
203
|
|
204 ;; Howard Melman made (essentially) the following suggestions, which
|
|
205 ;; are slightly different from the expression that I currently use.
|
|
206 ;; You may prefer one of Howard's suggestions, which I think assume
|
|
207 ;; that `case-fold-search' is `t' (which it is by default):
|
|
208
|
|
209 ;; (setq woman-imenu-generic-expression
|
|
210 ;; '((nil "^\\( \\)?\\([A-Z][A-Z ]+[A-Z]\\)[ \t]*$" 2)))
|
|
211
|
|
212 ;; will give support for .SH and .SS, though it won't show the heading
|
|
213 ;; name hierarchy. If you just want .SH in the imenu then use:
|
|
214
|
|
215 ;; (setq woman-imenu-generic-expression
|
|
216 ;; '((nil "^\\([A-Z][A-Z ]+[A-Z]\\)[ \t]*$" 1)))
|
|
217
|
|
218 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
219
|
|
220
|
|
221 ;; Vertical spacing and blank lines
|
|
222 ;; ================================
|
|
223
|
|
224 ;; The number of consecutive blank lines in the formatted buffer
|
|
225 ;; should be either 0 or 1. A blank line should leave a space like
|
|
226 ;; .sp 1 (p. 14). Current policy is to output vertical space only
|
|
227 ;; immediately before text is output.
|
|
228
|
|
229
|
|
230 ;; Horizontal and vertical spacing and resolution
|
|
231 ;; ==============================================
|
|
232
|
|
233 ;; WoMan currently assumes 10 characters per inch horizontally, hence
|
|
234 ;; a horizontal resolution of 24 basic units, and 5 lines per inch
|
|
235 ;; vertically, hence a vertical resolution of 48 basic units. (nroff
|
|
236 ;; uses 240 per inch).
|
|
237
|
|
238
|
|
239 ;; The *WoMan-Log* buffer
|
|
240 ;; ======================
|
|
241
|
|
242 ;; This is modelled on the byte-compiler. It logs all files formatted
|
|
243 ;; by WoMan, and if WoMan finds anything that it cannot handle then it
|
|
244 ;; writes a warning to this buffer. If the variable `woman-show-log'
|
|
245 ;; is non-nil (by default it is `nil') then WoMan automatically
|
|
246 ;; displays this buffer. Many WoMan warnings can be completely
|
|
247 ;; ignored, because they are reporting the fact that WoMan has ignored
|
|
248 ;; requests that it is correct to ignore. In some future version this
|
|
249 ;; level of paranoia will be reduced, but not until WoMan is more
|
|
250 ;; reliable. At present, all warnings should be treated with some
|
|
251 ;; suspicion. Uninterpreted escape sequences are also logged (in some
|
|
252 ;; cases).
|
|
253
|
|
254 ;; Uninterpreted ?roff requests can optionally be left in the
|
|
255 ;; formatted buffer to indicate precisely where they occur by
|
|
256 ;; resetting the variable `woman-ignore' to `nil' (by default it is
|
|
257 ;; `t').
|
|
258
|
|
259 ;; Automatic initiation of woman decoding
|
|
260
|
|
261 ;; (Probably not a good idea. If you use it, be careful!)
|
|
262
|
|
263 ;; Put something like this in your .emacs. The call to
|
|
264 ;; set-visited-file-name is to avoid font-locking triggered by
|
|
265 ;; automatic major mode selection.
|
|
266
|
|
267 ;; (autoload 'woman-decode-region "woman")
|
|
268
|
|
269 ;; (setq format-alist
|
|
270 ;; (cons
|
|
271 ;; '(man "UN*X man-page source format" "\\.\\(TH\\|ig\\) "
|
|
272 ;; woman-decode-region nil nil
|
29074
|
273 ;; (lambda (arg)
|
|
274 ;; set-visited-file-name
|
|
275 ;; (file-name-sans-extension buffer-file-name)))))
|
28832
|
276 ;; format-alist))
|
|
277
|
|
278
|
|
279 ;; Reporting Bugs
|
|
280 ;; ==============
|
|
281
|
|
282 ;; If WoMan fails completely, or formats a file incorrectly
|
|
283 ;; (i.e. obviously wrongly or significantly differently from man) or
|
|
284 ;; inelegantly, then please
|
|
285
|
|
286 ;; (a) check that you are running the latest version of woman.el
|
|
287 ;; available from my web site (see above),
|
|
288
|
|
289 ;; (b) check that the problem is not already described in the file
|
|
290 ;; woman.status, also available from my web site.
|
|
291
|
|
292 ;; If both of the above are true then please email me the entry from
|
|
293 ;; the *WoMan-Log* buffer relating to the problem file, together with
|
|
294 ;; a brief description of the problem. Please indicate where you got
|
|
295 ;; the source file from, but do not send it to me unless I ask you to!
|
|
296 ;; Thanks. (There is at present no automated bug-reporting facility
|
|
297 ;; for WoMan.)
|
|
298
|
|
299 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
300
|
|
301 ;; NOTE:
|
|
302
|
|
303 ;; CASE-DEPENDENCE OF FILENAMES. By default, WoMan ignores case in
|
|
304 ;; file pathnames only when it seems appropriate. MS-Windows users
|
|
305 ;; who want complete case independence should set the NTEmacs variable
|
|
306 ;; `w32-downcase-file-names' to `t' and use all lower case when
|
|
307 ;; setting WoMan file paths.
|
|
308
|
|
309 ;; (1) INCOMPATIBLE CHANGE! WoMan no longer uses a persistent topic
|
|
310 ;; cache by default. (It caused too much confusion!) Explicitly set
|
|
311 ;; the variable `woman-cache-filename' to save the cache between Emacs
|
|
312 ;; sessions. This is recommended only if the command `woman' is too
|
|
313 ;; slow the first time that it is run in an Emacs session, while it
|
|
314 ;; builds its cache in main memory, which MAY be VERY slow.
|
|
315
|
|
316 ;; (2) The user option `woman-cache-level' controls the amount of
|
|
317 ;; information cached (in main memory and, optionally, saved to disc).
|
|
318
|
|
319 ;; (3) UPDATING THE CACHE. A prefix argument always causes the
|
|
320 ;; `woman' command (only) to rebuild its topic cache, and to re-save
|
|
321 ;; it to `woman-cache-filename' if this variable has a non-nil value.
|
|
322 ;; This is necessary if the NAMES (not contents) of any of the
|
|
323 ;; directories or files in the paths specified by `woman-manpath' or
|
|
324 ;; `woman-path' change. If WoMan user options that affect the cache
|
|
325 ;; are changed then WoMan will automatically update its cache file on
|
|
326 ;; disc (if one is in use) the next time it is run in a new Emacs
|
|
327 ;; session.
|
|
328
|
|
329 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
330
|
|
331
|
|
332 ;; TO DO
|
|
333 ;; =====
|
|
334
|
29074
|
335 ;; Reconsider case sensitivity of file names.
|
28832
|
336 ;; MUST PROCESS .if, .nr IN ORDER ENCOUNTERED IN FILE! (rcsfile, mf).
|
|
337 ;; Allow general delimiter in `\v', cf. `\h'.
|
|
338 ;; Improve major-mode documentation.
|
|
339 ;; Pre-process conditionals in macro bodies if possible for speed?
|
|
340 ;; Emulate some preprocessor support for tbl (.TS/.TE) and eqn (.EQ/.EN)
|
|
341 ;; Re-write filling and adjusting code!
|
|
342 ;; Allow word wrap at comma (for long option lists)?
|
|
343 ;; Buffer list handling not quite right.
|
|
344 ;; Make 10 or 12 pitch (cpi) optional -- 12 => ll = 78
|
|
345 ;; Use unpaddable space for tabbing?
|
|
346 ;; Tidy up handling of fonts when filling and adjusting
|
|
347 ;; -- see text/text properties?
|
|
348 ;; Improve speed
|
|
349 ;; Add font-lock support (for quoted strings, etc.)?
|
|
350 ;; Optionally save large files in enriched format?
|
|
351 ;; Add apropos facility by searching NAME (?) entry in man files?
|
|
352 ;; Documentation -- optional auto-display of formatted WoMan man page?
|
|
353 ;; Implement a bug reporter?
|
|
354 ;; Support diversion and traps (to some extent) - for Tcl/tk pages?
|
|
355 ;; Add a menu of WoMan buffers?
|
29074
|
356 ;; Fix .fc properly?
|
28832
|
357
|
|
358
|
|
359 ;; Implementation strategy [this description is now well out of date!]
|
|
360 ;; -- three main passes, each to process respectively:
|
|
361
|
|
362 ;; 1) non-breaking `.' requests including font macros
|
|
363 ;; 2) \ escape sequences, mainly special characters and font changes
|
|
364 ;; 3) breaking `.' requests, mainly filling and justification
|
|
365
|
|
366 ;; For each pass, a control function finds and pre-processes the
|
|
367 ;; escape or request and then calls the appropriate function to
|
|
368 ;; perform the required formatting. Based originally on enriched.el
|
|
369 ;; and format.el.
|
|
370
|
29074
|
371 ;; The background information that made this project possible is
|
|
372 ;; freely available courtesy of Bell Labs from
|
|
373 ;; http://cm.bell-labs.com/7thEdMan/
|
28832
|
374
|
|
375
|
|
376 ;; Acknowledgements
|
|
377 ;; ================
|
|
378
|
|
379 ;; For Heather, Kathryn and Madelyn, the women in my life
|
|
380 ;; (although they will probably never use it)!
|
|
381
|
|
382 ;; I also thank the following for helpful suggestions, bug reports,
|
|
383 ;; code fragments, general interest, etc.:
|
|
384 ;; Jari Aalto <jari.aalto@cs.tpu.fi>
|
|
385 ;; Dean Andrews <dean@dra.com>
|
|
386 ;; Juanma Barranquero <barranquero@laley-actualidad.es>
|
|
387 ;; Karl Berry <kb@cs.umb.edu>
|
|
388 ;; Jim Chapman <jchapman@netcomuk.co.uk>
|
|
389 ;; Frederic Corne <frederic.corne@erli.fr>
|
|
390 ;; Peter Craft <craft@alacritech.com>
|
|
391 ;; Charles Curley <ccurley@trib.com>
|
|
392 ;; Jim Davidson <jdavidso@teknowledge.com>
|
|
393 ;; Kevin D'Elia <Kevin.DElia@mci.com>
|
|
394 ;; John Fitch <jpff@maths.bath.ac.uk>
|
|
395 ;; Hans Frosch <jwfrosch@rish.b17c.ingr.com>
|
|
396 ;; Guy Gascoigne-Piggford <ggp@informix.com>
|
|
397 ;; Brian Gorka <gorkab@sanchez.com>
|
|
398 ;; Nicolai Henriksen <nhe@lyngso-industri.dk>
|
|
399 ;; Thomas Herchenroeder <the@software-ag.de>
|
|
400 ;; Alexander Hinds <ahinds@thegrid.net>
|
|
401 ;; Stefan Hornburg <sth@hacon.de>
|
|
402 ;; Theodore Jump <tjump@cais.com>
|
|
403 ;; Paul Kinnucan <paulk@mathworks.com>
|
|
404 ;; Jonas Linde <jonas@init.se>
|
|
405 ;; Andrew McRae <andrewm@optimation.co.nz>
|
|
406 ;; Howard Melman <howard@silverstream.com>
|
|
407 ;; Dennis Pixton <dennis@math.binghamton.edu>
|
|
408 ;; T. V. Raman <raman@Adobe.COM>
|
|
409 ;; Bruce Ravel <bruce.ravel@nist.gov>
|
|
410 ;; Benjamin Riefenstahl <benny@crocodial.de>
|
|
411 ;; Kevin Ruland <kruland@seistl.com>
|
|
412 ;; Tom Schutter <tom@platte.com>
|
|
413 ;; Wei-Xue Shi <wxshi@ma.neweb.ne.jp>
|
|
414 ;; Fabio Somenzi <fabio@joplin.colorado.edu>
|
|
415 ;; Karel Sprenger <ks@ic.uva.nl>
|
|
416 ;; Chris Szurgot <szurgot@itribe.net>
|
|
417 ;; Paul A. Thompson <pat@po.cwru.edu>
|
29074
|
418 ;; Arrigo Triulzi <arrigo@maths.qmw.ac.uk>
|
28832
|
419 ;; Geoff Voelker <voelker@cs.washington.edu>
|
29147
|
420 ;; Eli Zaretskii <eliz@is.elta.co.il>
|
28832
|
421
|
29074
|
422 (defvar woman-version "0.54 (beta)" "WoMan version information.")
|
|
423
|
|
424 ;;; History:
|
|
425 ;; For recent change log see end of file.
|
28832
|
426
|
|
427
|
|
428 ;;; Code:
|
|
429
|
|
430 (require 'man)
|
|
431 (eval-when-compile ; to avoid compiler warnings
|
|
432 (require 'dired)
|
|
433 (require 'apropos))
|
|
434
|
29074
|
435 (defun woman-mapcan (fn x)
|
29147
|
436 "Return concatenated list of FN applied to successive `car' elements of X.
|
29074
|
437 FN must return a list, cons or nil. Useful for splicing into a list."
|
|
438 ;; Based on the Standard Lisp function MAPCAN but with args swapped!
|
|
439 (and x (nconc (funcall fn (car x)) (woman-mapcan fn (cdr x)))))
|
|
440
|
28832
|
441 (defun woman-parse-colon-path (cd-path)
|
|
442 "Explode a search path CD-PATH into a list of directory names.
|
29147
|
443 Replace null components by calling `woman-parse-man.conf'.
|
|
444 Allow UN*X-style search paths on Microsoft platforms, i.e. allow path
|
|
445 elements to be separated by colons and convert Cygwin-style drive
|
|
446 specifiers `//x/' to `x:'."
|
|
447 ;; Based on suggestions by Jari Aalto and Eli Zaretskii.
|
|
448 (mapcar
|
|
449 (lambda (path) ; //a/b -> a:/b
|
|
450 (when (and path (string-match "\\`//./" path))
|
|
451 (setq path (substring path 1)) ; //a/b -> /a/b
|
|
452 (aset path 0 (aref path 1)) ; /a/b -> aa/b
|
|
453 (aset path 1 ?:)) ; aa/b -> a:/b
|
|
454 path)
|
|
455 (woman-mapcan ; splice into list...
|
|
456 (lambda (path)
|
|
457 ;; parse-colon-path returns nil for a null path component and
|
|
458 ;; an empty substring of MANPATH denotes the default list...
|
|
459 (if path (list path) (woman-parse-man.conf)))
|
|
460 (if (and (memq system-type '(windows-nt ms-dos))
|
|
461 (not (string-match ";" cd-path)))
|
|
462 (let ((path-separator ":"))
|
|
463 (parse-colon-path cd-path))
|
|
464 (parse-colon-path cd-path)))))
|
28832
|
465
|
|
466
|
|
467 ;;; User options:
|
|
468
|
|
469 ;; NB: Group identifiers must be lowercase!
|
|
470
|
|
471 (defgroup woman nil
|
|
472 "Browse UNIX manual pages `wo (without) man'."
|
|
473 :tag "WoMan"
|
|
474 :group 'help)
|
|
475
|
|
476 (defcustom woman-show-log nil
|
|
477 "*If non-nil then show the *WoMan-Log* buffer if appropriate.
|
|
478 I.e. if any warning messages are written to it. Default is nil."
|
|
479 :type 'boolean
|
|
480 :group 'woman)
|
|
481
|
|
482 (defcustom woman-pre-format-hook nil
|
|
483 "*Hook run by WoMan immediately before formatting a buffer.
|
|
484 Change only via `Customization' or the function `add-hook'."
|
|
485 :type 'hook
|
|
486 :group 'woman)
|
|
487
|
|
488 (defcustom woman-post-format-hook nil
|
|
489 "*Hook run by WoMan immediately after formatting a buffer.
|
|
490 Change only via `Customization' or the function `add-hook'."
|
|
491 :type 'hook
|
|
492 :group 'woman)
|
|
493
|
|
494
|
|
495 ;; Interface options
|
|
496
|
|
497 (defgroup woman-interface nil
|
|
498 "Interface options for browsing UNIX manual pages `wo (without) man'."
|
|
499 :tag "WoMan Interface"
|
|
500 :group 'woman)
|
|
501
|
29074
|
502 (defcustom woman-man.conf-path
|
30018
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
503 '("/etc" "/etc/manpath.config" "/usr/local/lib")
|
29074
|
504 "*List of dirs to search and/or files to try for man config file.
|
|
505 Default is '(\"/etc\" \"/usr/local/lib\") [for GNU/Linux, Cygwin resp.]
|
|
506 A trailing separator (`/' for UNIX etc.) on directories is optional
|
|
507 and the filename matched if a directory is specified is the first to
|
|
508 contain the string \"man.conf\".
|
|
509 If MANPATH is not set but a config file is found then it is parsed
|
|
510 instead to provide a default value for `woman-manpath'."
|
|
511 :type '(repeat string)
|
|
512 :group 'woman-interface)
|
|
513
|
|
514 (defun woman-parse-man.conf ()
|
29147
|
515 "Parse if possible Linux-style configuration file for man command.
|
|
516 Used only if MANPATH is not set or contains null components.
|
29074
|
517 Look in `woman-man.conf-path' and return a value for `woman-manpath'.
|
|
518 Concatenate data from all lines in the config file of the form
|
29147
|
519
|
30018
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
520 MANPATH /usr/man
|
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
521
|
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
522 or
|
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
523
|
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
524 MANDATORY_MANPATH /usr/man"
|
29074
|
525 ;; Functionality suggested by Charles Curley.
|
|
526 (let ((path woman-man.conf-path)
|
|
527 file manpath)
|
|
528 (while (and
|
|
529 path
|
|
530 (not (and
|
|
531 (file-readable-p (setq file (car path)))
|
|
532 ;; If not a file then find the file:
|
|
533 (or (not (file-directory-p file))
|
|
534 (and
|
|
535 (setq file
|
|
536 (directory-files file t "man\\.conf" t))
|
|
537 (file-readable-p (setq file (car file)))))
|
|
538 ;; Parse the file -- if no MANPATH data ignore it:
|
|
539 (with-temp-buffer
|
|
540 (insert-file-contents file)
|
|
541 (while (re-search-forward
|
30018
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
542 "^[ \t]*\\(MANDATORY_\\)?MANPATH[ \t]+\\(\\S-+\\)" nil t)
|
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
543 (setq manpath (cons (match-string 2) manpath)))
|
29074
|
544 manpath))
|
|
545 ))
|
|
546 (setq path (cdr path)))
|
|
547 (nreverse manpath)))
|
|
548
|
28832
|
549 (defcustom woman-manpath
|
|
550 (let ((manpath (getenv "MANPATH")))
|
29074
|
551 (or
|
|
552 (and manpath (woman-parse-colon-path manpath))
|
|
553 (woman-parse-man.conf)
|
30018
c7243fc7bcb6
(woman-man.conf-path): Explicitly include the debian man-db config file
Miles Bader <miles@gnu.org>
diff
changeset
|
554 '("/usr/man" "/usr/share/man" "/usr/local/man")
|
29074
|
555 ))
|
28832
|
556 "*List of DIRECTORY TREES to search for UN*X manual files.
|
|
557 Each element should be the name of a directory that contains
|
|
558 subdirectories of the form `man?', or more precisely subdirectories
|
|
559 selected by the value of `woman-manpath-man-regexp'. Non-directory
|
29074
|
560 and unreadable files are ignored.
|
|
561
|
|
562 If not set then the environment variable MANPATH is used. If no such
|
|
563 environment variable is found, the default list is determined by
|
|
564 consulting the man configuration file if found. By default this is
|
|
565 either `/etc/man.config' or `/usr/local/lib/man.conf', which is
|
|
566 determined by the user option `woman-man.conf-path'. An empty
|
|
567 substring of MANPATH denotes the default list. Otherwise, the default
|
|
568 value of this variable is
|
28832
|
569
|
|
570 (\"/usr/man\" \"/usr/local/man\").
|
|
571
|
29074
|
572 Any environment variables (names must have the UN*X-style form $NAME,
|
28832
|
573 e.g. $HOME, $EMACSDATA, $EMACS_DIR) are evaluated first but each
|
|
574 element must evaluate to a SINGLE directory name. Trailing `/'s are
|
|
575 ignored. (Specific directories in `woman-path' are also searched.)
|
|
576
|
|
577 Microsoft platforms:
|
|
578 I recommend including drive letters explicitly, e.g.
|
|
579
|
|
580 (\"C:/Cygnus/cygwin-b20/man\" \"C:/usr/man\" \"C:/usr/local/man\").
|
|
581
|
|
582 The MANPATH environment variable may be set using DOS semi-colon-
|
|
583 separated or UN*X / Cygwin colon-separated syntax (but not mixed)."
|
|
584 :type '(repeat string)
|
|
585 :group 'woman-interface)
|
|
586
|
|
587 (defcustom woman-manpath-man-regexp "[Mm][Aa][Nn]"
|
|
588 "Regexp to match man directories UNDER `woman-manpath' directories.
|
|
589 These normally have names of the form `man?'. Its default value is
|
|
590 \"[Mm][Aa][Nn]\", which is case-insensitive mainly for the benefit of
|
|
591 Microsoft platforms. Its purpose is to avoid `cat?', `.', `..', etc."
|
|
592 ;; Based on a suggestion by Wei-Xue Shi.
|
|
593 :type 'string
|
|
594 :group 'woman-interface)
|
|
595
|
|
596 (defcustom woman-path
|
|
597 (if (eq system-type 'ms-dos) '("$DJDIR/info" "$DJDIR/man/cat[1-9onlp]"))
|
|
598 "*List of SPECIFIC DIRECTORIES to search for UN*X manual files.
|
|
599 For example
|
|
600
|
|
601 (\"/emacs/etc\").
|
|
602
|
|
603 These directories are searched in addition to the directory trees
|
|
604 specified in `woman-manpath'. Each element should be a directory
|
|
605 string or nil, which represents the current directory when the path is
|
|
606 expanded and cached. However, the last component (only) of each
|
|
607 directory string is treated as a regexp \(Emacs, not shell) and the
|
|
608 string is expanded into a list of matching directories. Non-directory
|
|
609 and unreadable files are ignored. The default value is nil.
|
|
610
|
|
611 Any environment variables (which must have the UN*X-style form $NAME,
|
|
612 e.g. $HOME, $EMACSDATA, $EMACS_DIR) are evaluated first but each
|
|
613 element must evaluate to a SINGLE directory name (regexp, see above).
|
|
614 For example
|
|
615
|
|
616 (\"$EMACSDATA\") [or equivalently (\"$EMACS_DIR/etc\")].
|
|
617
|
|
618 Trailing `/'s are discarded. (The directory trees in `woman-manpath'
|
|
619 are also searched.) On Microsoft platforms I recommend including
|
|
620 drive letters explicitly."
|
|
621 :type '(repeat (choice string (const nil)))
|
|
622 :group 'woman-interface)
|
|
623
|
|
624 (defcustom woman-cache-level 2
|
|
625 "*The level of topic caching.
|
|
626 1 - cache only the topic and directory lists
|
|
627 (the only level before version 0.34 - only for compatibility);
|
|
628 2 - cache also the directories for each topic
|
|
629 (faster, without using much more memory);
|
|
630 3 - cache also the actual filenames for each topic
|
|
631 (fastest, but uses twice as much memory).
|
|
632 The default value is currently 2, a good general compromise.
|
|
633 If the `woman' command is slow to find files then try 3, which may be
|
|
634 particularly beneficial with large remote-mounted man directories.
|
|
635 Run the `woman' command with a prefix argument or delete the cache
|
|
636 file `woman-cache-filename' for a change to take effect.
|
|
637 \(Values < 1 behave like 1; values > 3 behave like 3.)"
|
|
638 :type '(choice (const :tag "Minimal" 1)
|
|
639 (const :tag "Default" 2)
|
|
640 (const :tag "Maximal" 3))
|
|
641 :group 'woman-interface)
|
|
642
|
|
643 (defcustom woman-cache-filename nil
|
|
644 "*The full pathname of the WoMan directory and topic cache file.
|
|
645 It is used to save and restore the cache between sessions. This is
|
|
646 especially useful with remote-mounted man page files! The default
|
|
647 value of nil suppresses this action. The `standard' non-nil
|
|
648 filename is \"~/.wmncach.el\". Remember that a prefix argument forces
|
|
649 the `woman' command to update and re-write the cache."
|
|
650 :type '(choice (const :tag "None" nil)
|
|
651 (const :tag "~/.wmncach.el" "~/.wmncach.el")
|
|
652 file)
|
|
653 :group 'woman-interface)
|
|
654
|
|
655 (defcustom woman-dired-keys t
|
|
656 "*List of `dired' mode keys to define to run WoMan on current file.
|
|
657 E.g. '(\"w\" \"W\"), or any non-null atom to automatically define
|
|
658 \"w\" and \"W\" if they are unbound, or nil to do nothing.
|
|
659 Default is t."
|
|
660 :type '(choice (const :tag "None" nil)
|
|
661 (repeat string)
|
|
662 (other :tag "Auto" t))
|
|
663 :group 'woman-interface)
|
|
664
|
|
665 (defcustom woman-imenu-generic-expression
|
|
666 '((nil "\n\\([A-Z].*\\)" 1) ; SECTION, but not TITLE
|
|
667 ("*Subsections*" "^ \\([A-Z].*\\)" 1))
|
|
668 "*Imenu support for Sections and Subsections.
|
|
669 An alist with elements of the form (MENU-TITLE REGEXP INDEX) --
|
|
670 see the documentation for `imenu-generic-expression'."
|
|
671 :type 'sexp
|
|
672 :group 'woman-interface)
|
|
673
|
|
674 (defcustom woman-imenu nil
|
29074
|
675 "*If non-nil then WoMan adds a Contents menu to the menubar.
|
|
676 It does this by calling `imenu-add-to-menubar'. Default is nil."
|
28832
|
677 :type 'boolean
|
|
678 :group 'woman-interface)
|
|
679
|
|
680 (defcustom woman-imenu-title "CONTENTS"
|
|
681 "*The title to use if WoMan adds a Contents menu to the menubar.
|
|
682 Default is \"CONTENTS\"."
|
|
683 :type 'string
|
|
684 :group 'woman-interface)
|
|
685
|
|
686 (defcustom woman-topic-at-point-default 'confirm
|
|
687 ;; `woman-topic-at-point' may be let-bound when woman is loaded, in
|
|
688 ;; which case its global value does not get defined.
|
|
689 ;; `woman-file-name' sets it to this value if it is unbound.
|
|
690 "*Default value for `woman-topic-at-point'."
|
|
691 :type '(choice (const :tag "Yes" t)
|
|
692 (const :tag "No" nil)
|
|
693 (other :tag "Confirm" confirm))
|
|
694 :group 'woman-interface)
|
|
695
|
|
696 (defcustom woman-topic-at-point woman-topic-at-point-default
|
|
697 "*Controls use by `woman' of `word at point' as a topic suggestion.
|
|
698 If non-nil then the `woman' command uses the word at point as an
|
|
699 initial topic suggestion when it reads a topic from the minibuffer; if
|
|
700 t then the `woman' command uses the word at point WITHOUT
|
|
701 INTERACTIVE CONFIRMATION if it exists as a topic. The default value
|
|
702 is `confirm', meaning suggest a topic and ask for confirmation."
|
|
703 :type '(choice (const :tag "Yes" t)
|
|
704 (const :tag "No" nil)
|
|
705 (other :tag "Confirm" confirm))
|
|
706 :group 'woman-interface)
|
|
707
|
|
708 (defvar woman-file-regexp nil
|
|
709 "Regexp used to select (possibly compressed) man source files, e.g.
|
|
710 \"\\.\\([0-9lmnt]\\w*\\)\\(\\.\\(g?z\\|bz2\\)\\)?\\'\".
|
|
711 Built automatically from the customizable user options
|
|
712 `woman-uncompressed-file-regexp' and `woman-file-compression-regexp'.")
|
|
713
|
|
714 (defvar woman-uncompressed-file-regexp) ; for the compiler
|
|
715 (defvar woman-file-compression-regexp) ; for the compiler
|
|
716
|
|
717 (defun set-woman-file-regexp (symbol value)
|
|
718 "Bind SYMBOL to VALUE and set `woman-file-regexp' as per user customizations.
|
29074
|
719 Used as :set cookie by Customize when customizing the user options
|
28832
|
720 `woman-uncompressed-file-regexp' and `woman-file-compression-regexp'."
|
|
721 (set-default symbol value)
|
|
722 (and (boundp 'woman-uncompressed-file-regexp)
|
|
723 (boundp 'woman-file-compression-regexp)
|
|
724 (setq woman-file-regexp
|
|
725 (concat woman-uncompressed-file-regexp
|
|
726 "\\("
|
|
727 (substring woman-file-compression-regexp 0 -2)
|
|
728 "\\)?\\'"))))
|
|
729
|
|
730 (defcustom woman-uncompressed-file-regexp
|
|
731 "\\.\\([0-9lmnt]\\w*\\)" ; disallow no extension
|
|
732 "*Do not change this unless you are sure you know what you are doing!
|
|
733 Regexp used to select man source files (ignoring any compression extension).
|
|
734
|
|
735 The SysV standard man pages use two character suffixes, and this is
|
|
736 becoming more common in the GNU world. For example, the man pages
|
|
737 in the ncurses package include `toe.1m', `form.3x', etc.
|
|
738
|
|
739 Note: an optional compression regexp will be appended, so this regexp
|
|
740 MUST NOT end with any kind of string terminator such as $ or \\'."
|
|
741 :type 'regexp
|
|
742 :set 'set-woman-file-regexp
|
|
743 :group 'woman-interface)
|
|
744
|
|
745 (defcustom woman-file-compression-regexp
|
|
746 "\\.\\(g?z\\|bz2\\)\\'"
|
|
747 "*Do not change this unless you are sure you know what you are doing!
|
|
748 Regexp used to match compressed man file extensions for which
|
29074
|
749 decompressors are available and handled by auto-compression mode,
|
28832
|
750 e.g. \"\\\\.\\\\(g?z\\\\|bz2\\\\)\\\\'\" for `gzip' or `bzip2'.
|
|
751 Should begin with \\. and end with \\' and MUST NOT be optional."
|
29074
|
752 ;; Should be compatible with car of
|
|
753 ;; `jka-compr-file-name-handler-entry', but that is unduly
|
|
754 ;; complicated, includes an inappropriate extension (.tgz) and is
|
|
755 ;; not loaded by default!
|
28832
|
756 :type 'regexp
|
|
757 :set 'set-woman-file-regexp
|
|
758 :group 'woman-interface)
|
|
759
|
29147
|
760 (defcustom woman-use-own-frame ; window-system
|
|
761 (or (and (fboundp 'display-graphic-p) (display-graphic-p)) ; Emacs 21
|
|
762 (memq window-system '(x w32))) ; Emacs 20
|
29074
|
763 "*If non-nil then use a dedicated frame for displaying WoMan windows.
|
|
764 Only useful when run on a graphic display such as X or MS-Windows."
|
|
765 :type 'boolean
|
|
766 :group 'woman-interface)
|
|
767
|
28832
|
768
|
|
769 ;; Formatting options
|
|
770
|
|
771 (defgroup woman-formatting nil
|
|
772 "Formatting options for browsing UNIX manual pages `wo (without) man'."
|
|
773 :tag "WoMan Formatting"
|
|
774 :group 'woman)
|
|
775
|
|
776 (defcustom woman-fill-column 65
|
|
777 "*Right margin for formatted text -- default is 65."
|
|
778 :type 'integer
|
|
779 :group 'woman-formatting)
|
|
780
|
|
781 (defcustom woman-fill-frame nil
|
|
782 ;; Based loosely on a suggestion by Theodore Jump:
|
|
783 "*If non-nil then most of the frame width is used."
|
|
784 :type 'boolean
|
|
785 :group 'woman-formatting)
|
|
786
|
|
787 (defcustom woman-default-indent 5
|
|
788 "*Default prevailing indent set by -man macros -- default is 5.
|
|
789 Set this variable to 7 to emulate Linux man formatting."
|
|
790 :type 'integer
|
|
791 :group 'woman-formatting)
|
|
792
|
|
793 (defcustom woman-bold-headings t
|
|
794 "*If non-nil then embolden section and subsection headings. Default is t.
|
|
795 Heading emboldening is NOT standard `man' behaviour."
|
|
796 :type 'boolean
|
|
797 :group 'woman-formatting)
|
|
798
|
|
799 (defcustom woman-ignore t
|
29074
|
800 "*If non-nil then unrecognised requests etc. are ignored. Default is t.
|
28832
|
801 This gives the standard ?roff behaviour. If nil then they are left in
|
|
802 the buffer, which may aid debugging."
|
|
803 :type 'boolean
|
|
804 :group 'woman-formatting)
|
|
805
|
|
806 (defcustom woman-preserve-ascii nil
|
|
807 "*If non-nil then preserve ASCII characters in the WoMan buffer.
|
|
808 Otherwise, non-ASCII characters (that display as ASCII) may remain.
|
|
809 This is irrelevant unless the buffer is to be saved to a file."
|
|
810 :type 'boolean
|
|
811 :group 'woman-formatting)
|
|
812
|
29074
|
813 (defcustom woman-emulation 'nroff
|
|
814 "*WoMan emulation, currently either nroff or troff. Default is nroff.
|
|
815 Troff emulation is experimental and largely untested.
|
|
816 \(Add groff later?)"
|
|
817 :type '(choice (const nroff) (const troff))
|
|
818 :group 'woman-formatting)
|
|
819
|
28832
|
820
|
|
821 ;; Faces:
|
|
822
|
|
823 (defgroup woman-faces nil
|
|
824 "Face options for browsing UNIX manual pages `wo (without) man'."
|
|
825 :tag "WoMan Faces"
|
|
826 :group 'woman
|
|
827 :group 'faces)
|
|
828
|
|
829 (defcustom woman-fontify
|
|
830 (or (and (fboundp 'display-color-p) (display-color-p))
|
|
831 (and (fboundp 'display-graphic-p) (display-graphic-p))
|
|
832 (x-display-color-p))
|
|
833 "*If non-nil then WoMan assumes that face support is available.
|
|
834 It defaults to a non-nil value if the display supports either colors
|
|
835 or different fonts."
|
|
836 :type 'boolean
|
|
837 :group 'woman-faces)
|
|
838
|
32759
|
839 ;; This is overkill! Troff uses just italic; Nroff uses just underline.
|
|
840 ;; You should probably select either italic or underline as you prefer, but
|
|
841 ;; not both, although italic and underline work together perfectly well!
|
28832
|
842 (defface woman-italic-face
|
32759
|
843 `((((background light)) (:italic t :underline t :foreground "red"))
|
|
844 (((background dark)) (:italic t :underline t)))
|
|
845 "Face for italic font in man pages."
|
28832
|
846 :group 'woman-faces)
|
|
847
|
|
848 (defface woman-bold-face
|
32759
|
849 '((((background light)) (:bold t :foreground "blue"))
|
|
850 (((background dark)) (:bold t :foreground "green2")))
|
|
851 "Face for bold font in man pages."
|
28832
|
852 :group 'woman-faces)
|
|
853
|
32759
|
854 ;; Brown is a good compromise: it is distinguishable from the default
|
|
855 ;; but not enough so to make font errors look terrible. (Files that use
|
|
856 ;; non-standard fonts seem to do so badly or in idiosyncratic ways!)
|
28832
|
857 (defface woman-unknown-face
|
32759
|
858 '((((background light)) (:foreground "brown"))
|
|
859 (((background dark)) (:foreground "cyan")))
|
|
860 "Face for all unknown fonts in man pages."
|
28832
|
861 :group 'woman-faces)
|
|
862
|
|
863 (defface woman-addition-face
|
|
864 '((t (:foreground "orange")))
|
|
865 "Face for all additions made by WoMan to man pages.
|
|
866 Default: foreground orange."
|
|
867 :group 'woman-faces)
|
|
868
|
32759
|
869 (defun woman-default-faces ()
|
|
870 "Set foreground colours of italic and bold faces to their default values."
|
28832
|
871 (interactive)
|
32759
|
872 (face-spec-set 'woman-italic-face
|
|
873 (face-user-default-spec 'woman-italic-face))
|
|
874 (face-spec-set 'woman-bold-face (face-user-default-spec 'woman-bold-face)))
|
|
875
|
|
876 (defun woman-monochrome-faces ()
|
|
877 "Set foreground colours of italic and bold faces to that of the default face.
|
|
878 This is usually either black or white."
|
28832
|
879 (interactive)
|
32759
|
880 (set-face-foreground 'woman-italic-face 'unspecified)
|
|
881 (set-face-foreground 'woman-bold-face 'unspecified))
|
28832
|
882
|
|
883 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
29074
|
884 ;; Experimental font support, initially only for MS-Windows.
|
|
885 (defconst woman-font-support
|
29147
|
886 (eq window-system 'w32) ; Support X later!
|
29074
|
887 "If non-nil then non-ASCII characters and symbol font supported.")
|
|
888
|
|
889 (defun woman-select-symbol-fonts (fonts)
|
|
890 "Select symbol fonts from a list FONTS of font name strings."
|
|
891 (let (symbol-fonts)
|
|
892 ;; With NTEmacs 20.5, the PATTERN option to `x-list-fonts' does
|
|
893 ;; not seem to work and fonts may be repeated, so ...
|
|
894 (while fonts
|
|
895 (and (string-match "-Symbol-" (car fonts))
|
|
896 (not (member (car fonts) symbol-fonts))
|
|
897 (setq symbol-fonts (cons (car fonts) symbol-fonts)))
|
|
898 (setq fonts (cdr fonts)))
|
|
899 symbol-fonts))
|
|
900
|
|
901 (when woman-font-support
|
28832
|
902 (make-face 'woman-symbol-face)
|
|
903
|
29074
|
904 ;; Set the symbol font only if `woman-use-symbol-font' is true, to
|
28832
|
905 ;; avoid unnecessarily upsetting the line spacing in NTEmacs 20.5!
|
|
906
|
29074
|
907 (defcustom woman-use-extended-font t
|
|
908 "*If non-nil then may use non-ASCII characters from the default font."
|
28832
|
909 :type 'boolean
|
29074
|
910 :group 'woman-faces)
|
|
911
|
|
912 (defcustom woman-use-symbol-font nil
|
|
913 "*If non-nil then may use the symbol font. It is off by default,
|
|
914 mainly because it may change the line spacing (in NTEmacs 20.5)."
|
|
915 :type 'boolean
|
28832
|
916 :group 'woman-faces)
|
|
917
|
|
918 (defconst woman-symbol-font-list
|
29074
|
919 (or (woman-select-symbol-fonts (x-list-fonts "*" 'default))
|
|
920 (woman-select-symbol-fonts (x-list-fonts "*")))
|
|
921 "Symbol font(s), preferably same size as default when WoMan was loaded.")
|
28832
|
922
|
|
923 (defcustom woman-symbol-font (car woman-symbol-font-list)
|
|
924 "*A string describing the symbol font to use for special characters.
|
|
925 It should be compatible with, and the same size as, the default text font.
|
|
926 Under MS-Windows, the default is
|
|
927 \"-*-Symbol-normal-r-*-*-*-*-96-96-p-*-ms-symbol\"."
|
|
928 :type `(choice
|
29074
|
929 ,@(mapcar (lambda (x) (list 'const x))
|
28832
|
930 woman-symbol-font-list)
|
|
931 string)
|
|
932 :group 'woman-faces)
|
|
933
|
|
934 )
|
|
935
|
29074
|
936 ;; For non windows-nt ...
|
|
937 (defvar woman-use-extended-font nil)
|
|
938 (defvar woman-use-symbol-font nil)
|
|
939 (defvar woman-symbol-font nil)
|
28832
|
940 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
941
|
|
942
|
|
943 ;;; Internal variables:
|
|
944
|
|
945 (defconst woman-justify-list
|
|
946 '(left right center full)
|
|
947 "Justify styles for `fill-region-as-paragraph'.")
|
|
948 (defconst woman-adjust-left 0 ; == adjust off, noadjust
|
|
949 "Adjustment indicator `l' -- adjust left margin only.")
|
|
950 (defconst woman-adjust-right 1
|
|
951 "Adjustment indicator `r' -- adjust right margin only.")
|
|
952 (defconst woman-adjust-center 2
|
|
953 "Adjustment indicator `c' -- center.")
|
|
954 (defconst woman-adjust-both 3 ; default -- adj,both
|
|
955 "Adjustment indicator `b' or `n' -- adjust both margins.")
|
|
956
|
|
957 (defvar woman-adjust woman-adjust-both
|
|
958 "Current adjustment number-register value.")
|
|
959 (defvar woman-adjust-previous woman-adjust
|
|
960 "Previous adjustment number-register value.")
|
|
961 (defvar woman-justify
|
|
962 (nth woman-adjust woman-justify-list) ; use vector?
|
|
963 "Current justification style for `fill-region-as-paragraph'.")
|
|
964 (defvar woman-justify-previous woman-justify
|
|
965 "Previous justification style for `fill-region-as-paragraph'.")
|
|
966
|
|
967 (defvar woman-left-margin woman-default-indent
|
|
968 "Current left margin.")
|
|
969 (defvar woman-prevailing-indent woman-default-indent
|
|
970 "Current prevailing indent.")
|
|
971 (defvar woman-interparagraph-distance 1
|
|
972 "Interparagraph distance in lines.
|
|
973 Set by .PD; used by .SH, .SS, .TP, .LP, .PP, .P, .IP, .HP.")
|
|
974 (defvar woman-leave-blank-lines nil
|
|
975 "Blank lines to leave as vertical space.")
|
|
976 (defconst woman-tab-width 5
|
|
977 "Default tab width set by -man macros.")
|
|
978 (defvar woman-nofill nil
|
|
979 "Current fill mode: nil for filling.")
|
|
980 (defvar woman-RS-left-margin nil
|
|
981 "Left margin stack for nested use of `.RS/.RE'.")
|
|
982 (defvar woman-RS-prevailing-indent nil
|
|
983 "Prevailing indent stack for nested use of `.RS/.RE'.")
|
|
984 (defvar woman-nospace nil
|
|
985 "Current no-space mode: nil for normal spacing.
|
|
986 Set by `.ns' request; reset by any output or `.rs' request")
|
|
987
|
|
988 (defsubst woman-reset-nospace ()
|
29074
|
989 "Set `woman-nospace' to nil."
|
28832
|
990 (setq woman-nospace nil))
|
|
991
|
|
992 (defconst woman-mode-line-format
|
|
993 ;; This is essentially the Man-mode format with page numbers removed
|
|
994 ;; and line numbers added. (Online documents do not have pages, but
|
|
995 ;; they do have lines!)
|
|
996 '("-" mode-line-mule-info mode-line-modified
|
|
997 mode-line-frame-identification mode-line-buffer-identification
|
|
998 " " global-mode-string
|
|
999 " %[(WoMan" mode-line-process minor-mode-alist ")%]--"
|
|
1000 (line-number-mode "L%l--")
|
|
1001 (-3 . "%p") "-%-")
|
|
1002 "Mode line format for WoMan buffer.")
|
|
1003
|
|
1004 (defconst woman-request-regexp "^[.'][ \t]*\\(\\S +\\) *"
|
|
1005 ;; Was "^\\.[ \t]*\\([a-z0-9]+\\) *" but cvs.1 uses a macro named
|
|
1006 ;; "`" and CGI.man uses a macro named "''"!
|
|
1007 ;; CGI.man uses ' as control character in places -- it *should*
|
|
1008 ;; suppress breaks!
|
|
1009 ;; Could end with "\\( +\\|$\\)" instead of " *"
|
|
1010 "Regexp to match a ?roff request plus trailing white space.")
|
|
1011
|
|
1012 (defvar woman-imenu-done nil
|
29074
|
1013 "Buffer-local: set to true if function `woman-imenu' has been called.")
|
28832
|
1014 (make-variable-buffer-local 'woman-imenu-done)
|
|
1015
|
|
1016 ;; From imenu.el -- needed when reformatting a file in its old buffer.
|
|
1017 ;; The latest buffer index used to update the menu bar menu.
|
|
1018 (eval-when-compile
|
|
1019 (require 'imenu))
|
|
1020 (make-variable-buffer-local 'imenu--last-menubar-index-alist)
|
|
1021
|
|
1022 (defvar woman-buffer-alist nil
|
29074
|
1023 "An alist representing WoMan buffers that are already decoded.
|
|
1024 Each element is of the form (FILE-NAME . BUFFER-NAME).")
|
28832
|
1025
|
|
1026 (defvar woman-buffer-number 0
|
|
1027 "Ordinal number of current buffer entry in `woman-buffer-alist'.
|
|
1028 The ordinal numbers start from 0.")
|
|
1029
|
29074
|
1030 (defvar woman-if-conditions-true '(?n ?e ?o)
|
|
1031 "List of one-character built-in condition names that are true.
|
|
1032 Should include ?e, ?o (page even/odd) and either ?n (nroff) or ?t (troff).
|
|
1033 Default is '(?n ?e ?o). Set via `woman-emulation'.")
|
|
1034
|
28832
|
1035
|
39653
|
1036 ;;; Button types:
|
|
1037
|
|
1038 (define-button-type 'woman-xref
|
|
1039 'action (lambda (button) (woman (button-label button)))
|
|
1040 'help-echo "RET, mouse-2: display this man page")
|
|
1041
|
|
1042
|
28832
|
1043 ;;; Specialized utility functions:
|
|
1044
|
|
1045 ;;; Fast deletion without saving on the kill ring (cf. simple.el):
|
|
1046
|
|
1047 (defun woman-delete-line (&optional arg)
|
29074
|
1048 "Delete rest of current line; if all blank then delete thru newline.
|
28832
|
1049 With a numeric argument ARG, delete that many lines from point.
|
|
1050 Negative arguments delete lines backward."
|
|
1051 ;; This is a non-interactive version of kill-line in simple.el that
|
|
1052 ;; deletes instead of killing and assumes kill-whole-line is nil,
|
|
1053 ;; which is essential!
|
|
1054 (delete-region (point)
|
|
1055 (progn
|
|
1056 (if arg
|
|
1057 (forward-line arg)
|
|
1058 (if (eobp)
|
|
1059 (signal 'end-of-buffer nil))
|
|
1060 (if (looking-at "[ \t]*$")
|
|
1061 (forward-line 1)
|
|
1062 (end-of-line)))
|
|
1063 (point))))
|
|
1064
|
|
1065 (defsubst woman-delete-whole-line ()
|
|
1066 "Delete current line from beginning including eol."
|
|
1067 (beginning-of-line)
|
|
1068 (woman-delete-line 1))
|
|
1069
|
|
1070 (defsubst woman-delete-following-space ()
|
|
1071 "Delete all spaces and tabs FOLLOWING point (cf. `delete-horizontal-space')."
|
|
1072 ;; cf. delete-horizontal-space in simple.el:
|
|
1073 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
|
|
1074
|
|
1075 (defsubst woman-delete-match (subexp)
|
|
1076 "Delete subexpression SUBEXP of buffer text matched by last search."
|
|
1077 (delete-region (match-beginning subexp) (match-end subexp)))
|
|
1078
|
|
1079 ;; delete-char does not kill by default
|
|
1080 ;; delete-backward-char does not kill by default
|
|
1081 ;; delete-horizontal-space does not kill
|
|
1082 ;; delete-blank-lines does not kill
|
|
1083
|
|
1084
|
|
1085 ;;; File handling:
|
|
1086
|
|
1087 (defvar woman-expanded-directory-path nil
|
|
1088 "Expanded directory list cache. Resetting to nil forces update.")
|
|
1089
|
|
1090 (defvar woman-topic-all-completions nil
|
|
1091 "Expanded topic alist cache. Resetting to nil forces update.")
|
|
1092
|
|
1093 ;;;###autoload
|
|
1094 (defun woman (&optional topic re-cache)
|
29074
|
1095 "Browse UN*X man page for TOPIC (Without using external Man program).
|
28832
|
1096 The major browsing mode used is essentially the standard Man mode.
|
|
1097 Choose the filename for the man page using completion, based on the
|
|
1098 topic selected from the directories specified in `woman-manpath' and
|
|
1099 `woman-path'. The directory expansions and topics are cached for
|
|
1100 speed, but a non-nil interactive argument forces the caches to be
|
|
1101 updated (e.g. to re-interpret the current directory).
|
|
1102
|
29074
|
1103 Used non-interactively, arguments are optional: if given then TOPIC
|
|
1104 should be a topic string and non-nil RE-CACHE forces re-caching."
|
28832
|
1105 (interactive (list nil current-prefix-arg))
|
|
1106 ;; The following test is for non-interactive calls via gnudoit etc.
|
|
1107 (if (or (interactive-p) (not (stringp topic)) (string-match "\\S " topic))
|
|
1108 (let ((file-name (woman-file-name topic re-cache)))
|
|
1109 (if file-name
|
|
1110 (woman-find-file file-name)
|
|
1111 (message
|
|
1112 "WoMan Error: No matching manual files found in search path")
|
|
1113 (ding))
|
|
1114 )
|
|
1115 (message "WoMan Error: No topic specified in non-interactive call")
|
|
1116 (ding))
|
|
1117 )
|
|
1118
|
29074
|
1119 ;; Allow WoMan to be called via the standard Help menu:
|
28832
|
1120 (define-key-after menu-bar-manuals-menu [woman]
|
|
1121 '(menu-item "Read Man Page (WoMan)..." woman
|
|
1122 :help "Man-page documentation Without Man") t)
|
|
1123
|
|
1124 (defvar woman-cached-data nil
|
|
1125 "A list of cached data used to determine cache validity.
|
|
1126 Set from the cache by `woman-read-directory-cache'.")
|
|
1127
|
|
1128 (defun woman-cached-data ()
|
|
1129 "Generate a list of data used to determine cache validity.
|
|
1130 Called both to generate and to check the cache!"
|
|
1131 ;; Must use substituted paths because values of env vars may change!
|
|
1132 (list woman-cache-level
|
|
1133 (mapcar 'substitute-in-file-name woman-manpath)
|
|
1134 (mapcar 'substitute-in-file-name woman-path)))
|
|
1135
|
|
1136 (defun woman-read-directory-cache ()
|
|
1137 "Load the directory and topic cache.
|
29074
|
1138 It is loaded from the file named by the variable `woman-cache-filename'.
|
|
1139 Return t if the file exists, nil otherwise."
|
28832
|
1140 (and
|
|
1141 woman-cache-filename
|
|
1142 (load woman-cache-filename t nil t) ; file exists
|
|
1143 (equal woman-cached-data (woman-cached-data)))) ; cache valid
|
|
1144
|
|
1145 (defun woman-write-directory-cache ()
|
|
1146 "Save the directory and topic cache.
|
29074
|
1147 It is saved to the file named by the variable `woman-cache-filename'."
|
28832
|
1148 (if woman-cache-filename
|
|
1149 (save-excursion ; to restore current buffer
|
|
1150 ;; Make a temporary buffer; name starting with space "hides" it.
|
|
1151 (let ((standard-output
|
|
1152 (set-buffer (generate-new-buffer "WoMan tmp buffer")))
|
|
1153 (backup-inhibited t))
|
|
1154 ;; (switch-to-buffer standard-output t) ; only for debugging
|
|
1155 (buffer-disable-undo standard-output)
|
|
1156 (princ
|
|
1157 ";;; WoMan directory and topic cache -- generated automatically\n")
|
|
1158 (print
|
|
1159 ;; For data validity check:
|
|
1160 `(setq woman-cached-data ',(woman-cached-data)))
|
|
1161 (print
|
|
1162 `(setq woman-expanded-directory-path
|
|
1163 ',woman-expanded-directory-path))
|
|
1164 (print
|
|
1165 `(setq woman-topic-all-completions
|
|
1166 ',woman-topic-all-completions))
|
|
1167 (write-file woman-cache-filename) ; write CURRENT buffer
|
|
1168 (kill-buffer standard-output)
|
|
1169 ))))
|
|
1170
|
|
1171 (defvar woman-topic-history nil "Topic read history.")
|
|
1172 (defvar woman-file-history nil "File-name read history.")
|
|
1173
|
|
1174 (defun woman-file-name (topic &optional re-cache)
|
|
1175 "Get the name of the UN*X man-page file describing a chosen TOPIC.
|
29074
|
1176 When `woman' is called interactively, the word at point may be used as
|
|
1177 the topic or initial topic suggestion, subject to the value of the
|
|
1178 user option `woman-topic-at-point'. Return nil if no file can be found.
|
|
1179 Optional argument RE-CACHE, if non-nil, forces the cache to be re-read."
|
28832
|
1180 ;; Handle the caching of the directory and topic lists:
|
|
1181 (if (and (not re-cache)
|
|
1182 (or
|
|
1183 (and woman-expanded-directory-path woman-topic-all-completions)
|
|
1184 (woman-read-directory-cache)))
|
|
1185 ()
|
|
1186 (message "Building list of manual directory expansions...")
|
|
1187 (setq woman-expanded-directory-path
|
|
1188 (woman-expand-directory-path woman-manpath woman-path))
|
|
1189 (message "Building completion list of all manual topics...")
|
|
1190 (setq woman-topic-all-completions
|
|
1191 (woman-topic-all-completions woman-expanded-directory-path))
|
|
1192 (woman-write-directory-cache))
|
|
1193 ;; There is a problem in that I want to offer case-insensitive
|
|
1194 ;; completions, but to return only a case-sensitive match. This
|
|
1195 ;; does not seem to work properly by default, so I re-do the
|
|
1196 ;; completion if necessary.
|
|
1197 (let (files)
|
|
1198 (or (stringp topic)
|
|
1199 (and (eq t
|
|
1200 (if (boundp 'woman-topic-at-point)
|
|
1201 woman-topic-at-point
|
|
1202 ;; Was let-bound when file loaded, so ...
|
|
1203 (setq woman-topic-at-point woman-topic-at-point-default)))
|
|
1204 (setq topic
|
|
1205 (current-word t)) ; only within or adjacent to word
|
|
1206 (assoc topic woman-topic-all-completions))
|
|
1207 (setq topic
|
|
1208 (completing-read
|
|
1209 "Manual entry: "
|
|
1210 woman-topic-all-completions nil 1
|
|
1211 ;; Initial input suggestion (was nil), with
|
|
1212 ;; cursor at left ready to kill suggestion!:
|
|
1213 (and woman-topic-at-point
|
|
1214 (cons (current-word) 0)) ; nearest word
|
|
1215 'woman-topic-history)))
|
|
1216 ;; Note that completing-read always returns a string.
|
|
1217 (if (= (length topic) 0)
|
|
1218 nil ; no topic, so no file!
|
|
1219 (cond
|
|
1220 ((setq files (woman-file-name-all-completions topic)))
|
|
1221 ;; Complete topic more carefully, i.e. use the completion
|
|
1222 ;; rather than the string entered by the user:
|
|
1223 ((setq files (all-completions topic woman-topic-all-completions))
|
|
1224 (while (/= (length topic) (length (car files)))
|
|
1225 (setq files (cdr files)))
|
|
1226 (setq files (woman-file-name-all-completions (car files)))))
|
|
1227 (cond
|
|
1228 ((null files) nil) ; no file found for topic.
|
|
1229 ((null (cdr files)) (car (car files))) ; only 1 file for topic.
|
|
1230 (t
|
|
1231 ;; Multiple files for topic, so must select 1.
|
|
1232 ;; Unread the command event (TAB = ?\t = 9) that runs the command
|
|
1233 ;; `minibuffer-complete' in order to automatically complete the
|
|
1234 ;; minibuffer contents as far as possible.
|
|
1235 (setq unread-command-events '(9)) ; and delete any type-ahead!
|
|
1236 (completing-read "Manual file: " files nil 1
|
|
1237 (try-completion "" files) 'woman-file-history)))
|
|
1238 )))
|
|
1239
|
|
1240 (defun woman-select (predicate list)
|
|
1241 "Select unique elements for which PREDICATE is true in LIST.
|
|
1242 \(Note that this function changes the value of LIST.)"
|
|
1243 ;; Intended to be fast by avoiding recursion and list copying.
|
|
1244 (while (and list
|
|
1245 (or
|
|
1246 (member (car list) (cdr list))
|
|
1247 (not (funcall predicate (car list)))))
|
|
1248 (setq list (cdr list)))
|
|
1249 (if list
|
|
1250 (let ((newlist list) cdr_list)
|
|
1251 (while (setq cdr_list (cdr list))
|
|
1252 (if (and
|
|
1253 (not (member (car cdr_list) (cdr cdr_list)))
|
|
1254 (funcall predicate (car cdr_list)))
|
|
1255 (setq list cdr_list)
|
|
1256 (setcdr list (cdr cdr_list)))
|
|
1257 )
|
|
1258 newlist)))
|
|
1259
|
|
1260 (defun woman-file-readable-p (dir)
|
|
1261 "Return t if DIR is readable, otherwise log a warning."
|
|
1262 (or (file-readable-p dir)
|
|
1263 (WoMan-warn "Ignoring unreadable `manpath' directory tree `%s'!" dir)))
|
|
1264
|
|
1265 (defun woman-directory-files (head dir)
|
29074
|
1266 "Return a sorted list of files in directory HEAD matching regexp in DIR.
|
28832
|
1267 Value is a sorted list of the absolute pathnames of all the files in
|
|
1268 directory HEAD, or the current directory if HEAD is nil, that match the
|
|
1269 regexp that is the final component of DIR. Log a warning if list is empty."
|
|
1270 (or (directory-files
|
|
1271 (or head (directory-file-name default-directory)) ; was "."
|
|
1272 t
|
|
1273 (file-name-nondirectory dir))
|
|
1274 (WoMan-warn "No directories match `woman-path' entry `%s'!" dir)))
|
|
1275
|
|
1276 (defun woman-file-accessible-directory-p (dir)
|
|
1277 "Return t if DIR is accessible, otherwise log a warning."
|
|
1278 (or (file-accessible-directory-p dir)
|
|
1279 (WoMan-warn "Ignoring inaccessible `man-page' directory `%s'!" dir)))
|
|
1280
|
|
1281 (defun woman-expand-directory-path (woman-manpath woman-path)
|
29074
|
1282 "Expand the manual directories in WOMAN-MANPATH and WOMAN-PATH.
|
|
1283 WOMAN-MANPATH should be a list of general manual directories, while
|
|
1284 WOMAN-PATH should be a list of specific manual directory regexps.
|
28832
|
1285 Ignore any paths that are unreadable or not directories."
|
|
1286 ;; Allow each path to be a single string or a list of strings:
|
|
1287 (if (not (listp woman-manpath)) (setq woman-manpath (list woman-manpath)))
|
|
1288 (if (not (listp woman-path)) (setq woman-path (list woman-path)))
|
|
1289 (let (dir head dirs)
|
|
1290 (while woman-manpath
|
|
1291 (setq dir (car woman-manpath)
|
|
1292 woman-manpath (cdr woman-manpath))
|
|
1293 (if (and dir (woman-file-readable-p dir))
|
|
1294 ;; NB: `parse-colon-path' creates null elements for
|
|
1295 ;; redundant (semi-)colons and trailing `/'s!
|
|
1296 ;; If does not actually matter here if dir ends with `/'.
|
|
1297 ;; Need regexp "man" here to avoid "cat?", `.', `..', etc.
|
|
1298 (setq dir (woman-canonicalize-dir dir)
|
|
1299 dirs (nconc dirs (directory-files
|
|
1300 dir t woman-manpath-man-regexp)))))
|
|
1301 (while woman-path
|
|
1302 (setq dir (car woman-path)
|
|
1303 woman-path (cdr woman-path))
|
|
1304 (if (or (null dir)
|
|
1305 (null (setq dir (woman-canonicalize-dir dir)
|
|
1306 head (file-name-directory dir)))
|
|
1307 (woman-file-readable-p head))
|
|
1308 (setq dirs
|
|
1309 (if dir
|
|
1310 (nconc dirs (woman-directory-files head dir))
|
|
1311 (cons (directory-file-name default-directory) dirs))
|
|
1312 ;; was "." -- at head of list for later filtering
|
|
1313 )))
|
|
1314 (woman-select 'woman-file-accessible-directory-p dirs)))
|
|
1315
|
|
1316 (defun woman-canonicalize-dir (dir)
|
29074
|
1317 "Canonicalize the directory name DIR.
|
28832
|
1318 Any UN*X-style environment variables are evaluated first."
|
|
1319 (setq dir (expand-file-name (substitute-in-file-name dir)))
|
|
1320 ;; A path that ends with / matches all directories in it,
|
|
1321 ;; including `.' and `..', so remove any trailing / !!!
|
|
1322 (if (string= (substring dir -1) "/")
|
|
1323 (setq dir (substring dir 0 -1)))
|
29074
|
1324 (if (memq system-type '(windows-nt ms-dos)) ; what else?
|
28832
|
1325 ;; Match capitalization used by `file-name-directory':
|
|
1326 (setq dir (concat (file-name-directory dir)
|
|
1327 (file-name-nondirectory dir))))
|
|
1328 dir)
|
|
1329
|
|
1330 (defsubst woman-not-member (dir path)
|
29074
|
1331 "Return t if DIR is not a member of the list PATH, nil otherwise.
|
28832
|
1332 If DIR is `.' it is first replaced by the current directory."
|
|
1333 (not (member dir path)))
|
|
1334
|
|
1335 (defun woman-topic-all-completions (path)
|
|
1336 "Return an alist of the man files in all man directories in the list PATH.
|
|
1337 The cdr of each alist element is the path-index / filename."
|
|
1338 ;; Support 3 levels of caching: each element of the alist `files'
|
|
1339 ;; will be a list of the first `woman-cache-level' elements of the
|
|
1340 ;; following list: (topic path-index filename). This alist `files'
|
|
1341 ;; is re-processed by `woman-topic-all-completions-merge'.
|
|
1342 (let (dir files (path-index 0)) ; indexing starts at zero
|
|
1343 (while path
|
|
1344 (setq dir (car path)
|
|
1345 path (cdr path))
|
|
1346 (if (woman-not-member dir path) ; use each directory only once!
|
|
1347 (setq files
|
|
1348 (nconc files
|
|
1349 (woman-topic-all-completions-1 dir path-index))))
|
|
1350 (setq path-index (1+ path-index)))
|
|
1351 ;; Uniquefy topics:
|
|
1352 (woman-topic-all-completions-merge files)))
|
|
1353
|
|
1354 (defun woman-topic-all-completions-1 (dir path-index)
|
29147
|
1355 "Return an alist of the man topics in directory DIR with index PATH-INDEX.
|
|
1356 A topic is a filename sans type-related extensions.
|
|
1357 Support 3 levels of caching: each element of the alist will be a list
|
|
1358 of the first `woman-cache-level' elements from the following list:
|
|
1359 \(topic path-index filename)."
|
|
1360 ;; This function used to check that each file in the directory was
|
|
1361 ;; not itself a directory, but this is very slow and should be
|
|
1362 ;; unnecessary. So let us assume that `woman-file-regexp' will
|
|
1363 ;; filter out any directories, which probably should not be there
|
|
1364 ;; anyway, i.e. it is a user error!
|
|
1365 (mapcar
|
|
1366 (lambda (file)
|
|
1367 (cons
|
|
1368 (file-name-sans-extension
|
|
1369 (if (string-match woman-file-compression-regexp file)
|
|
1370 (file-name-sans-extension file)
|
|
1371 file))
|
|
1372 (if (> woman-cache-level 1)
|
|
1373 (cons
|
|
1374 path-index
|
|
1375 (if (> woman-cache-level 2)
|
|
1376 (cons file nil))))))
|
|
1377 (directory-files dir nil woman-file-regexp)))
|
28832
|
1378
|
|
1379 (defun woman-topic-all-completions-merge (alist)
|
|
1380 "Merge the alist ALIST so that the keys are unique.
|
29074
|
1381 Also make each path-info component into a list.
|
28832
|
1382 \(Note that this function changes the value of ALIST.)"
|
|
1383 ;; Intended to be fast by avoiding recursion and list copying.
|
|
1384 (if (> woman-cache-level 1)
|
|
1385 (let ((newalist alist))
|
|
1386 (while newalist
|
|
1387 (let ((tail newalist) (topic (car (car newalist))))
|
|
1388 ;; Make the path-info into a list:
|
|
1389 (setcdr (car newalist) (list (cdr (car newalist))))
|
|
1390 (while tail
|
|
1391 (while (and tail (not (string= topic (car (car (cdr tail))))))
|
|
1392 (setq tail (cdr tail)))
|
|
1393 (if tail ; merge path-info into (car newalist)
|
|
1394 (let ((path-info (cdr (car (cdr tail)))))
|
|
1395 (if (member path-info (cdr (car newalist)))
|
|
1396 ()
|
|
1397 ;; Make the path-info into a list:
|
|
1398 (nconc (car newalist) (list path-info)))
|
|
1399 (setcdr tail (cdr (cdr tail))))
|
|
1400 ))
|
|
1401 (setq newalist (cdr newalist))))
|
|
1402 alist)
|
|
1403 ;; woman-cache-level = 1 => elements are single-element lists ...
|
|
1404 (while (and alist (member (car alist) (cdr alist)))
|
|
1405 (setq alist (cdr alist)))
|
|
1406 (if alist
|
|
1407 (let ((newalist alist) cdr_alist)
|
|
1408 (while (setq cdr_alist (cdr alist))
|
|
1409 (if (not (member (car cdr_alist) (cdr cdr_alist)))
|
|
1410 (setq alist cdr_alist)
|
|
1411 (setcdr alist (cdr cdr_alist)))
|
|
1412 )
|
|
1413 newalist))))
|
|
1414
|
|
1415 (defun woman-file-name-all-completions (topic)
|
|
1416 "Return an alist of the files in all man directories that match TOPIC."
|
|
1417 ;; Support 3 levels of caching: each element of
|
|
1418 ;; woman-topic-all-completions is a list of one of the forms:
|
|
1419 ;; (topic)
|
|
1420 ;; (topic (path-index) (path-index) ... )
|
|
1421 ;; (topic (path-index filename) (path-index filename) ... )
|
|
1422 ;; where the are no duplicates in the value lists.
|
|
1423 ;; Topic must match first `word' of filename, so ...
|
|
1424 (let ((topic-regexp
|
|
1425 (concat
|
|
1426 "\\`" (regexp-quote topic) ; first `word'
|
|
1427 "\\(\\..+\\)*" ; optional subsequent `words'
|
|
1428 woman-file-regexp)) ; extension
|
|
1429 (topics woman-topic-all-completions)
|
|
1430 (path woman-expanded-directory-path)
|
|
1431 dir files)
|
|
1432 (if (cdr (car topics))
|
|
1433 ;; Use cached path-info to locate files for each topic:
|
|
1434 (let ((path-info (cdr (assoc topic topics)))
|
|
1435 filename)
|
|
1436 (while path-info
|
|
1437 (setq dir (nth (car (car path-info)) path)
|
|
1438 filename (car (cdr (car path-info)))
|
|
1439 path-info (cdr path-info)
|
|
1440 files (nconc files
|
|
1441 ;; Find the actual file name:
|
|
1442 (if filename
|
|
1443 (list (concat dir "/" filename))
|
|
1444 (directory-files dir t topic-regexp)
|
|
1445 )))))
|
|
1446 ;; Search path for the files for each topic:
|
|
1447 (while path
|
|
1448 (setq dir (car path)
|
|
1449 path (cdr path))
|
|
1450 (if (woman-not-member dir path) ; use each directory only once!
|
|
1451 (setq files (nconc files
|
|
1452 (directory-files dir t topic-regexp))))
|
|
1453 ))
|
|
1454 (mapcar 'list files)
|
|
1455 ))
|
|
1456
|
29147
|
1457
|
28832
|
1458 ;;; dired support
|
|
1459
|
|
1460 (defun woman-dired-define-key (key)
|
|
1461 "Bind the argument KEY to the command `woman-dired-find-file'."
|
|
1462 (define-key dired-mode-map key 'woman-dired-find-file))
|
|
1463
|
|
1464 (defsubst woman-dired-define-key-maybe (key)
|
|
1465 "If KEY is undefined in Dired, bind it to command `woman-dired-find-file'."
|
|
1466 (if (eq (lookup-key dired-mode-map key) 'undefined)
|
|
1467 (woman-dired-define-key key)))
|
|
1468
|
|
1469 (defun woman-dired-define-keys ()
|
|
1470 "Define dired keys to run WoMan according to `woman-dired-keys'."
|
|
1471 (if woman-dired-keys
|
|
1472 (if (listp woman-dired-keys)
|
|
1473 (mapcar 'woman-dired-define-key woman-dired-keys)
|
|
1474 (woman-dired-define-key-maybe "w")
|
|
1475 (woman-dired-define-key-maybe "W")))
|
|
1476 (define-key-after (lookup-key dired-mode-map [menu-bar immediate])
|
|
1477 [woman] '("Read Man Page (WoMan)" . woman-dired-find-file) 'view))
|
|
1478
|
|
1479 (if (featurep 'dired)
|
|
1480 (woman-dired-define-keys)
|
|
1481 (add-hook 'dired-mode-hook 'woman-dired-define-keys))
|
|
1482
|
|
1483 ;;;###autoload
|
|
1484 (defun woman-dired-find-file ()
|
|
1485 "In dired, run the WoMan man-page browser on this file."
|
|
1486 (interactive)
|
|
1487 ;; dired-get-filename is defined in dired.el
|
|
1488 (woman-find-file (dired-get-filename)))
|
|
1489
|
|
1490
|
|
1491 ;;; tar-mode support
|
|
1492
|
|
1493 (defun woman-tar-extract-file ()
|
|
1494 "In tar mode, run the WoMan man-page browser on this file."
|
|
1495 (interactive)
|
|
1496 (or (eq major-mode 'tar-mode)
|
|
1497 (error "`woman-tar-extract-file' can be used only in `tar-mode'"))
|
|
1498 (buffer-disable-undo)
|
|
1499 (let (global-font-lock-mode)
|
|
1500 (funcall (symbol-function 'tar-extract)) ; defined in tar-mode
|
|
1501 (let ((WoMan-current-file buffer-file-name)) ; used for message logging
|
|
1502 (rename-buffer
|
|
1503 (woman-make-bufname (file-name-nondirectory buffer-file-name)))
|
|
1504 (woman-process-buffer)
|
|
1505 (goto-char (point-min)))))
|
|
1506
|
|
1507 ;; There is currently no `tar-mode-hook' so use ...
|
|
1508 (eval-after-load "tar-mode"
|
|
1509 '(progn
|
|
1510 (define-key tar-mode-map "w" 'woman-tar-extract-file)
|
|
1511 (define-key-after (lookup-key tar-mode-map [menu-bar immediate])
|
|
1512 [woman] '("Read Man Page (WoMan)" . woman-tar-extract-file) 'view)))
|
|
1513
|
|
1514
|
|
1515 (defvar woman-last-file-name nil
|
|
1516 "The full pathname of the last file formatted by WoMan.")
|
|
1517
|
|
1518 (defun woman-reformat-last-file ()
|
|
1519 "Reformat last file, e.g. after changing fill column."
|
|
1520 (interactive)
|
|
1521 (if woman-last-file-name
|
|
1522 (woman-find-file woman-last-file-name t)
|
|
1523 (call-interactively 'woman-find-file)))
|
|
1524
|
|
1525 ;;;###autoload
|
|
1526 (defun woman-find-file (file-name &optional reformat)
|
|
1527 "Find, decode and browse a specific UN*X man-page source file FILE-NAME.
|
|
1528 Use existing buffer if possible; reformat only if prefix arg given.
|
|
1529 When called interactively, optional argument REFORMAT forces reformatting
|
29074
|
1530 of an existing WoMan buffer formatted earlier.
|
28832
|
1531 No external programs are used, except that `gunzip' will be used to
|
|
1532 decompress the file if appropriate. See the documentation for the
|
|
1533 `woman' command for further details."
|
|
1534 (interactive "fBrowse UN*X manual file: \nP")
|
|
1535 (setq woman-last-file-name
|
|
1536 (setq file-name (expand-file-name file-name))) ; to canonicalize
|
|
1537 (let ((alist-tail woman-buffer-alist) exists)
|
|
1538 (setq woman-buffer-number 0)
|
|
1539 (while (and alist-tail (not (string= file-name (car (car alist-tail)))))
|
|
1540 (setq alist-tail (cdr alist-tail)
|
|
1541 woman-buffer-number (1+ woman-buffer-number)))
|
|
1542 (or (and (setq exists
|
|
1543 (and alist-tail (WoMan-find-buffer))) ; buffer exists
|
|
1544 (not reformat))
|
|
1545 ;; Format new buffer or reformat current buffer:
|
|
1546 (let* ((bufname (file-name-nondirectory file-name))
|
|
1547 (case-fold-search t)
|
|
1548 (compressed
|
|
1549 (not (not (string-match woman-file-compression-regexp bufname)))))
|
|
1550 (if compressed
|
|
1551 (setq bufname (file-name-sans-extension bufname)))
|
|
1552 (setq bufname (if exists
|
|
1553 (buffer-name)
|
|
1554 (woman-make-bufname bufname)))
|
|
1555 (woman-really-find-file file-name compressed bufname)
|
|
1556 (or exists
|
|
1557 (setq woman-buffer-alist
|
|
1558 (cons (cons file-name bufname) woman-buffer-alist)
|
|
1559 woman-buffer-number 0))
|
|
1560 )))
|
|
1561 (Man-build-section-alist)
|
|
1562 (Man-build-references-alist)
|
|
1563 (goto-char (point-min)))
|
|
1564
|
|
1565 (defun woman-make-bufname (bufname)
|
|
1566 "Create an unambiguous buffer name from BUFNAME."
|
|
1567 (let ((dot (string-match "\\." bufname)))
|
|
1568 (if dot (setq bufname (concat
|
|
1569 (substring bufname (1+ dot)) " "
|
|
1570 (substring bufname 0 dot))))
|
|
1571 (generate-new-buffer-name ; ensure uniqueness
|
|
1572 (concat "*WoMan " bufname "*"))))
|
|
1573
|
29074
|
1574 (defvar woman-frame nil
|
|
1575 "Dedicated frame used for displaying WoMan windows.")
|
|
1576
|
28832
|
1577 (defun woman-really-find-file (filename compressed bufname)
|
|
1578 "Find, decompress, and decode a UN*X man page FILENAME.
|
29074
|
1579 If COMPRESSED is non-nil, turn on auto-compression mode to decompress
|
|
1580 the file if necessary. Set buffer name BUFNAME and major mode.
|
28832
|
1581 Do not call directly!"
|
|
1582 (let ((WoMan-current-file filename)) ; used for message logging
|
29074
|
1583 (if woman-use-own-frame
|
|
1584 (select-frame
|
|
1585 (or (and (frame-live-p woman-frame) woman-frame)
|
|
1586 (setq woman-frame (make-frame)))))
|
28832
|
1587 (switch-to-buffer (get-buffer-create bufname))
|
|
1588 (buffer-disable-undo)
|
|
1589 (setq buffer-read-only nil)
|
|
1590 (erase-buffer) ; NEEDED for reformat
|
|
1591 (woman-insert-file-contents filename compressed)
|
|
1592 ;; Set buffer's default directory to that of the file.
|
|
1593 (setq default-directory (file-name-directory filename))
|
|
1594 (set (make-local-variable 'backup-inhibited) t)
|
|
1595 (set-visited-file-name "")
|
|
1596 (woman-process-buffer)))
|
|
1597
|
|
1598 (defun woman-process-buffer ()
|
|
1599 "The second half of `woman-really-find-file'!"
|
|
1600 (interactive)
|
|
1601 ;; Check (crudely) that this really is likely to be in UN*X
|
|
1602 ;; man-page source format, assuming we are at point-min:
|
|
1603 (goto-char (point-min))
|
|
1604 (if (re-search-forward "^[.']" 1000 t)
|
|
1605 (woman-decode-buffer)
|
|
1606 (message
|
|
1607 "File appears to be pre-formatted -- using source file may be better.")
|
|
1608 (woman-man-buffer))
|
|
1609 (woman-mode))
|
|
1610
|
|
1611 (defun woman-man-buffer ()
|
|
1612 "Post-process an nroff-preformatted man buffer."
|
|
1613 ;; Kill all leading whitespace:
|
|
1614 (if (looking-at "\\s-+") (woman-delete-match 0))
|
|
1615 ;; Delete all page footer/header pairs:
|
|
1616 (re-search-forward ".*") ; match header
|
|
1617 ;; Footer conventionally has page number at right, so ...
|
|
1618 (let ((regex (concat
|
|
1619 "^.*[0-9]\n\\s-*" ; footer and following blank lines
|
|
1620 (regexp-quote (match-string 0)) ; header
|
|
1621 "\\s-*\n"))) ; following blank lines
|
|
1622 (while (re-search-forward regex nil 1) ; finish at eob
|
|
1623 (woman-delete-match 0)))
|
|
1624 ;; Delete last text line (footer) and all following blank lines:
|
|
1625 (re-search-backward "\\S-")
|
|
1626 (beginning-of-line)
|
|
1627 (if (looking-at ".*[0-9]$")
|
|
1628 (delete-region (point) (point-max)))
|
|
1629
|
|
1630 ;; Squeeze multiple blank lines:
|
|
1631 (goto-char (point-min))
|
|
1632 (while (re-search-forward "^[ \t]*\n\\([ \t]*\n\\)+" nil t)
|
|
1633 (replace-match "\n" t t))
|
|
1634
|
29669
|
1635 ;; CJK characters are underlined by double-sized "__".
|
|
1636 ;; (Code lifted from man.el, with trivial changes.)
|
|
1637 (if (< (buffer-size) (position-bytes (point-max)))
|
|
1638 ;; Multibyte characters exist.
|
|
1639 (progn
|
|
1640 (goto-char (point-min))
|
|
1641 (while (search-forward "__\b\b" nil t)
|
|
1642 (backward-delete-char 4)
|
|
1643 (woman-set-face (point) (1+ (point)) 'woman-italic-face))
|
|
1644 (goto-char (point-min))
|
|
1645 (while (search-forward "\b\b__" nil t)
|
|
1646 (backward-delete-char 4)
|
|
1647 (woman-set-face (1- (point)) (point) 'woman-italic-face))))
|
|
1648
|
28832
|
1649 ;; Interpret overprinting to indicate bold face:
|
|
1650 (goto-char (point-min))
|
29669
|
1651 (while (re-search-forward "\\(.\\)\\(\\(+\\1\\)+\\)" nil t)
|
28832
|
1652 (woman-delete-match 2)
|
|
1653 (woman-set-face (1- (point)) (point) 'woman-bold-face))
|
|
1654
|
|
1655 ;; Interpret underlining to indicate italic face:
|
|
1656 ;; (Must be AFTER emboldening to interpret bold _ correctly!)
|
|
1657 (goto-char (point-min))
|
|
1658 (while (search-forward "_" nil t)
|
|
1659 (delete-char -2)
|
|
1660 (woman-set-face (point) (1+ (point)) 'woman-italic-face))
|
|
1661
|
|
1662 ;; Leave any other uninterpreted ^H's in the buffer for now! (They
|
|
1663 ;; might indicate composite special characters, which could be
|
|
1664 ;; interpreted if I knew what to expect.)
|
|
1665
|
|
1666 ;; Optionally embolden section and subsection headings
|
|
1667 ;; (cf. `woman-imenu-generic-expression'):
|
|
1668 (cond
|
|
1669 (woman-bold-headings
|
|
1670 (goto-char (point-min))
|
|
1671 (forward-line)
|
|
1672 (while (re-search-forward "^\\( \\)?\\([A-Z].*\\)" nil t)
|
|
1673 (woman-set-face (match-beginning 2) (match-end 2) 'woman-bold-face))))
|
|
1674 )
|
|
1675
|
|
1676 (defun woman-insert-file-contents (filename compressed)
|
|
1677 "Insert file FILENAME into the current buffer.
|
|
1678 If COMPRESSED is t, or is non-nil and the filename implies compression,
|
29074
|
1679 then turn on auto-compression mode to decompress the file.
|
28832
|
1680 Leave point at end of new text. Return length of inserted text."
|
|
1681 ;; Leaves point at end of inserted text in GNU Emacs 20.3, but at
|
|
1682 ;; start in 19.34!
|
|
1683 (save-excursion
|
|
1684 (let ((case-fold-search t))
|
|
1685 ;; Co-operate with auto-compression mode:
|
|
1686 (if (and compressed
|
|
1687 (or (eq compressed t)
|
|
1688 (string-match woman-file-compression-regexp filename))
|
|
1689 ;; (not auto-compression-mode)
|
|
1690 (not (rassq 'jka-compr-handler file-name-handler-alist)) )
|
|
1691 ;; (error "Compressed file requires Auto File Decompression turned on")
|
|
1692 (auto-compression-mode 1))
|
|
1693 (nth 1
|
|
1694 (condition-case ()
|
|
1695 (insert-file-contents filename nil)
|
|
1696 (file-error
|
|
1697 ;; Run find-file-not-found-hooks until one returns non-nil.
|
|
1698 ;; (run-hook-with-args-until-success 'find-file-not-found-hooks)
|
|
1699 (insert "\n***** File " filename " not found! *****\n\n")
|
|
1700 )))
|
|
1701 )))
|
|
1702
|
|
1703
|
|
1704 ;;; Major mode (Man) interface:
|
|
1705
|
|
1706 (defvar woman-mode-map nil "Keymap for woman mode.")
|
|
1707
|
|
1708 (if woman-mode-map
|
|
1709 ()
|
39653
|
1710 ;; Set up the keymap, mostly inherited from Man-mode-map. Normally
|
|
1711 ;; button-buffer-map is used as a parent keymap, but we can't have two
|
|
1712 ;; parents, so we just copy it.
|
|
1713 (setq woman-mode-map (copy-keymap button-buffer-map))
|
28832
|
1714 (set-keymap-parent woman-mode-map Man-mode-map)
|
|
1715 ;; Above two lines were
|
|
1716 ;; (setq woman-mode-map (cons 'keymap Man-mode-map))
|
|
1717 (define-key woman-mode-map "R" 'woman-reformat-last-file)
|
|
1718 (define-key woman-mode-map "w" 'woman)
|
|
1719 (define-key woman-mode-map "\en" 'WoMan-next-manpage)
|
|
1720 (define-key woman-mode-map "\ep" 'WoMan-previous-manpage)
|
39653
|
1721 (define-key woman-mode-map [M-mouse-2] 'woman-follow-word))
|
|
1722
|
|
1723 (defun woman-follow-word (event)
|
28832
|
1724 "Run WoMan with word under mouse as topic.
|
|
1725 Argument EVENT is the invoking mouse event."
|
|
1726 (interactive "e") ; mouse event
|
39653
|
1727 (goto-char (posn-point (event-start event)))
|
|
1728 (woman (current-word t)))
|
28832
|
1729
|
|
1730 ;; WoMan menu bar and pop-up menu:
|
|
1731 (easy-menu-define ; (SYMBOL MAPS DOC MENU)
|
|
1732 woman-menu
|
|
1733 woman-mode-map
|
|
1734 "WoMan Menu"
|
|
1735 `("WoMan"
|
|
1736 ["WoMan..." woman t] ; [NAME CALLBACK ENABLE]
|
|
1737 "--"
|
|
1738 ["Next Section" Man-next-section t]
|
|
1739 ["Previous Section" Man-previous-section t]
|
|
1740 ["Goto Section..." Man-goto-section t]
|
|
1741 ["Goto See-Also Section" Man-goto-see-also-section t]
|
|
1742 ["Follow Reference..." Man-follow-manual-reference t]
|
|
1743 "--"
|
|
1744 ["Previous WoMan Buffer" WoMan-previous-manpage t]
|
|
1745 ["Next WoMan Buffer" WoMan-next-manpage t]
|
|
1746 ["Bury WoMan Buffer" Man-quit t]
|
|
1747 ["Kill WoMan Buffer" Man-kill t]
|
|
1748 "--"
|
|
1749 ;; ["Toggle Fill Frame Width" woman-toggle-fill-frame t]
|
|
1750 ["Use Full Frame Width" woman-toggle-fill-frame
|
|
1751 :active t :style toggle :selected woman-fill-frame]
|
29074
|
1752 ["Reformat Last Man Page" woman-reformat-last-file t]
|
32759
|
1753 ["Use Monochrome Main Faces" woman-monochrome-faces t]
|
|
1754 ["Use Default Main Faces" woman-default-faces t]
|
28832
|
1755 ["Make Contents Menu" (woman-imenu t) (not woman-imenu-done)]
|
|
1756 "--"
|
|
1757 ["Describe (Wo)Man Mode" describe-mode t]
|
|
1758 ["Mini Help" woman-mini-help t]
|
|
1759 ,@(if (fboundp 'customize-group)
|
|
1760 '(["Customize..." (customize-group 'woman) t]))
|
|
1761 ["Show Version" (message "WoMan %s" woman-version) t]
|
29074
|
1762 "--"
|
|
1763 ("Advanced"
|
|
1764 ["View Source" (view-file woman-last-file-name) woman-last-file-name]
|
|
1765 ["Show Log" (switch-to-buffer-other-window "*WoMan-Log*" t) t]
|
|
1766 ["Extended Font" woman-toggle-use-extended-font
|
|
1767 :included woman-font-support
|
|
1768 :active t :style toggle :selected woman-use-extended-font]
|
|
1769 ["Symbol Font" woman-toggle-use-symbol-font
|
|
1770 :included woman-font-support
|
|
1771 :active t :style toggle :selected woman-use-symbol-font]
|
|
1772 ["Font Map" woman-display-extended-fonts
|
|
1773 :included woman-font-support
|
|
1774 :active woman-use-symbol-font]
|
|
1775 "--"
|
|
1776 "Emulation"
|
|
1777 ["nroff" (woman-reset-emulation 'nroff)
|
|
1778 :active t :style radio :selected (eq woman-emulation 'nroff)]
|
|
1779 ["troff" (woman-reset-emulation 'troff)
|
|
1780 :active t :style radio :selected (eq woman-emulation 'troff)]
|
|
1781 )
|
28832
|
1782 ))
|
|
1783
|
29074
|
1784 (defun woman-toggle-use-extended-font ()
|
|
1785 "Toggle `woman-use-extended-font' and reformat, for menu use."
|
|
1786 (interactive)
|
|
1787 (setq woman-use-extended-font (not woman-use-extended-font))
|
|
1788 (woman-reformat-last-file))
|
|
1789
|
|
1790 (defun woman-toggle-use-symbol-font ()
|
|
1791 "Toggle `woman-use-symbol-font' and reformat, for menu use."
|
|
1792 (interactive)
|
|
1793 (setq woman-use-symbol-font (not woman-use-symbol-font))
|
|
1794 (woman-reformat-last-file))
|
|
1795
|
|
1796 (defun woman-reset-emulation (value)
|
|
1797 "Reset `woman-emulation' to VALUE and reformat, for menu use."
|
|
1798 (interactive)
|
|
1799 (setq woman-emulation value)
|
|
1800 (woman-reformat-last-file))
|
|
1801
|
28832
|
1802 (defun woman-mode ()
|
|
1803 "Turn on (most of) Man mode to browse a buffer formatted by WoMan.
|
|
1804 WoMan is an ELisp emulation of much of the functionality of the Emacs
|
|
1805 `man' command running the standard UN*X man and ?roff programs.
|
|
1806 WoMan author: F.J.Wright@Maths.QMW.ac.uk
|
|
1807 WoMan version: see `woman-version'.
|
|
1808 See `Man-mode' for additional details."
|
|
1809 (let ((Man-build-page-list (symbol-function 'Man-build-page-list))
|
|
1810 (Man-strip-page-headers (symbol-function 'Man-strip-page-headers))
|
|
1811 (Man-unindent (symbol-function 'Man-unindent))
|
|
1812 (Man-goto-page (symbol-function 'Man-goto-page)))
|
|
1813 ;; Prevent inappropriate operations:
|
|
1814 (fset 'Man-build-page-list 'ignore)
|
|
1815 (fset 'Man-strip-page-headers 'ignore)
|
|
1816 (fset 'Man-unindent 'ignore)
|
|
1817 (fset 'Man-goto-page 'ignore)
|
|
1818 (unwind-protect
|
|
1819 (progn
|
|
1820 (set (make-local-variable 'Man-mode-map) woman-mode-map)
|
|
1821 ;; Install Man mode:
|
|
1822 (Man-mode)
|
|
1823 ;; Reset inappropriate definitions:
|
|
1824 (setq mode-line-format woman-mode-line-format)
|
|
1825 (put 'Man-mode 'mode-class 'special))
|
|
1826 ;; Restore the status quo:
|
|
1827 (fset 'Man-build-page-list Man-build-page-list)
|
|
1828 (fset 'Man-strip-page-headers Man-strip-page-headers)
|
|
1829 (fset 'Man-unindent Man-unindent)
|
|
1830 (fset 'Man-goto-page Man-goto-page)
|
|
1831 )
|
|
1832 ;; Imenu support:
|
|
1833 (set (make-local-variable 'imenu-generic-expression)
|
|
1834 ;; `make-local-variable' in case imenu not yet loaded!
|
|
1835 woman-imenu-generic-expression)
|
|
1836 (set (make-local-variable 'imenu-space-replacement) " ")
|
|
1837 ;; For reformat ...
|
|
1838 ;; necessary when reformatting a file in its old buffer:
|
|
1839 (setq imenu--last-menubar-index-alist nil)
|
|
1840 ;; necessary to avoid re-installing the same imenu:
|
|
1841 (setq woman-imenu-done nil)
|
|
1842 (if woman-imenu (woman-imenu))
|
|
1843 (setq buffer-read-only nil)
|
|
1844 (WoMan-highlight-references)
|
|
1845 (setq buffer-read-only t)
|
|
1846 (set-buffer-modified-p nil)))
|
|
1847
|
|
1848 (defun woman-imenu (&optional redraw)
|
|
1849 "Add a \"Contents\" menu to the menubar.
|
|
1850 Optional argument REDRAW, if non-nil, forces mode line to be updated."
|
|
1851 (interactive)
|
|
1852 (if woman-imenu-done
|
|
1853 ;; This is PRIMARILY to avoid a bug in imenu-add-to-menubar that
|
|
1854 ;; causes it to corrupt the menu bar if it is run more than once
|
|
1855 ;; in the same buffer.
|
|
1856 ()
|
|
1857 (setq woman-imenu-done t)
|
|
1858 (imenu-add-to-menubar woman-imenu-title)
|
|
1859 (if redraw (force-mode-line-update))))
|
|
1860
|
|
1861 (defun woman-toggle-fill-frame ()
|
|
1862 "Toggle formatting to fill (most of) the width of the current frame."
|
|
1863 (interactive)
|
|
1864 (setq woman-fill-frame (not woman-fill-frame))
|
|
1865 (message "Woman fill column set to %s."
|
|
1866 (if woman-fill-frame "frame width" woman-fill-column)
|
|
1867 ))
|
|
1868
|
|
1869 (defun woman-mini-help ()
|
|
1870 "Display WoMan commands and user options in an `apropos' buffer."
|
|
1871 ;; Based on apropos-command in apropos.el
|
|
1872 (interactive)
|
|
1873 (require 'apropos)
|
|
1874 (let ((message
|
|
1875 (let ((standard-output (get-buffer-create "*Apropos*")))
|
|
1876 (print-help-return-message 'identity))))
|
|
1877 (setq apropos-accumulator
|
|
1878 (apropos-internal "woman"
|
29074
|
1879 (lambda (symbol)
|
|
1880 (or (commandp symbol)
|
|
1881 (user-variable-p symbol)))))
|
28832
|
1882 ;; Filter out any inhibited symbols:
|
|
1883 (let ((tem apropos-accumulator))
|
|
1884 (while tem
|
|
1885 (if (get (car tem) 'apropos-inhibit)
|
|
1886 (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
|
|
1887 (setq tem (cdr tem))))
|
|
1888 ;; Find documentation strings:
|
|
1889 (let ((p apropos-accumulator)
|
|
1890 doc symbol)
|
|
1891 (while p
|
|
1892 (setcar p (list ; must have 3 elements:
|
|
1893 (setq symbol (car p)) ; 1. name
|
|
1894 (if (functionp symbol) ; 2. command doc
|
|
1895 (if (setq doc (documentation symbol t))
|
|
1896 (substring doc 0 (string-match "\n" doc))
|
|
1897 "(not documented)"))
|
|
1898 (if (user-variable-p symbol) ; 3. variable doc
|
|
1899 (if (setq doc (documentation-property
|
|
1900 symbol 'variable-documentation t))
|
|
1901 (substring doc 0 (string-match "\n" doc))))))
|
|
1902 (setq p (cdr p))))
|
|
1903 ;; Output the result:
|
|
1904 (and (apropos-print t nil)
|
|
1905 message
|
|
1906 (message message))))
|
|
1907
|
|
1908
|
|
1909 (defun WoMan-getpage-in-background (topic)
|
|
1910 "Use TOPIC to start WoMan from `Man-follow-manual-reference'."
|
|
1911 ;; topic is a string, generally of the form "section topic"
|
|
1912 (let ((s (string-match " " topic)))
|
|
1913 (if s (setq topic (substring topic (1+ s))))
|
|
1914 (woman topic)))
|
|
1915
|
|
1916 (defvar WoMan-Man-start-time nil
|
|
1917 "Used to record formatting time used by the `man' command.")
|
|
1918
|
|
1919 (defadvice Man-getpage-in-background
|
|
1920 (around Man-getpage-in-background-advice (topic) activate)
|
|
1921 "Use WoMan unless invoked outside a WoMan buffer or invoked explicitly.
|
|
1922 Otherwise use Man and record start of formatting time."
|
|
1923 (if (and (eq mode-line-format woman-mode-line-format)
|
|
1924 (not (eq (caar command-history) 'man)))
|
|
1925 (WoMan-getpage-in-background topic)
|
|
1926 ;; Initiates man processing
|
|
1927 (setq WoMan-Man-start-time (current-time))
|
|
1928 ad-do-it))
|
|
1929
|
|
1930 (defadvice Man-bgproc-sentinel
|
|
1931 (after Man-bgproc-sentinel-advice activate)
|
|
1932 ;; Terminates man processing
|
|
1933 "Report formatting time."
|
|
1934 (let* ((time (current-time))
|
|
1935 (time (+ (* (- (car time) (car WoMan-Man-start-time)) 65536)
|
|
1936 (- (cadr time) (cadr WoMan-Man-start-time)))))
|
|
1937 (message "Man formatting done in %d seconds" time)))
|
|
1938
|
|
1939 (defun WoMan-highlight-references ()
|
|
1940 "Highlight the references (in the SEE ALSO section) on mouse-over."
|
|
1941 ;; Based on `Man-build-references-alist' in `man'.
|
|
1942 (when (Man-find-section Man-see-also-regexp)
|
|
1943 (forward-line 1)
|
|
1944 (let ((end (save-excursion
|
|
1945 (Man-next-section 1)
|
|
1946 (point))))
|
|
1947 (back-to-indentation)
|
|
1948 (while (re-search-forward Man-reference-regexp end t)
|
|
1949 ;; Highlight reference when mouse is over it.
|
|
1950 ;; (NB: WoMan does not hyphenate!)
|
39653
|
1951 (make-text-button (match-beginning 1) (match-end 1)
|
|
1952 'type 'woman-xref)))))
|
28832
|
1953
|
|
1954
|
|
1955 ;;; Buffer handling:
|
|
1956
|
|
1957 (defun WoMan-previous-manpage ()
|
|
1958 "Find the previous WoMan buffer."
|
|
1959 ;; Assumes currently in a WoMan buffer!
|
|
1960 (interactive)
|
|
1961 (WoMan-find-buffer) ; find current existing buffer
|
|
1962 (if (null (cdr woman-buffer-alist))
|
|
1963 (error "No previous WoMan buffer"))
|
|
1964 (if (>= (setq woman-buffer-number (1+ woman-buffer-number))
|
|
1965 (length woman-buffer-alist))
|
|
1966 (setq woman-buffer-number 0))
|
|
1967 (if (WoMan-find-buffer)
|
|
1968 ()
|
|
1969 (if (< (setq woman-buffer-number (1- woman-buffer-number)) 0)
|
|
1970 (setq woman-buffer-number (1- (length woman-buffer-alist))))
|
|
1971 (WoMan-previous-manpage)))
|
|
1972
|
|
1973 (defun WoMan-next-manpage ()
|
|
1974 "Find the next WoMan buffer."
|
|
1975 ;; Assumes currently in a WoMan buffer!
|
|
1976 (interactive)
|
|
1977 (WoMan-find-buffer) ; find current existing buffer
|
|
1978 (if (null (cdr woman-buffer-alist))
|
|
1979 (error "No next WoMan buffer"))
|
|
1980 (if (< (setq woman-buffer-number (1- woman-buffer-number)) 0)
|
|
1981 (setq woman-buffer-number (1- (length woman-buffer-alist))))
|
|
1982 (if (WoMan-find-buffer)
|
|
1983 ()
|
|
1984 (WoMan-next-manpage)))
|
|
1985
|
|
1986 (defun WoMan-find-buffer ()
|
|
1987 "Switch to buffer corresponding to `woman-buffer-number' and return it.
|
29074
|
1988 If such a buffer does not exist then remove its association from the
|
|
1989 alist in `woman-buffer-alist' and return nil."
|
28832
|
1990 (if (zerop woman-buffer-number)
|
|
1991 (let ((buffer (get-buffer (cdr (car woman-buffer-alist)))))
|
|
1992 (if buffer
|
|
1993 (switch-to-buffer buffer)
|
|
1994 ;; Delete alist element:
|
|
1995 (setq woman-buffer-alist (cdr woman-buffer-alist))
|
|
1996 nil))
|
|
1997 (let* ((prev-ptr (nthcdr (1- woman-buffer-number) woman-buffer-alist))
|
|
1998 (buffer (get-buffer (cdr (car (cdr prev-ptr))))))
|
|
1999 (if buffer
|
|
2000 (switch-to-buffer buffer)
|
|
2001 ;; Delete alist element:
|
|
2002 (setcdr prev-ptr (cdr (cdr prev-ptr)))
|
|
2003 (if (>= woman-buffer-number (length woman-buffer-alist))
|
|
2004 (setq woman-buffer-number 0))
|
|
2005 nil)
|
|
2006 )))
|
|
2007
|
|
2008
|
|
2009 ;;; Syntax and display tables:
|
|
2010
|
|
2011 (defconst woman-escaped-escape-char ?
|
|
2012 ;; An arbitrary unused control character
|
|
2013 "Internal character representation of escaped escape characters.")
|
|
2014 (defconst woman-escaped-escape-string
|
|
2015 (char-to-string woman-escaped-escape-char)
|
|
2016 "Internal string representation of escaped escape characters.")
|
|
2017
|
|
2018 (defconst woman-unpadded-space-char ?
|
|
2019 ;; An arbitrary unused control character
|
|
2020 "Internal character representation of unpadded space characters.")
|
|
2021 (defconst woman-unpadded-space-string
|
|
2022 (char-to-string woman-unpadded-space-char)
|
|
2023 "Internal string representation of unpadded space characters.")
|
|
2024
|
|
2025 (defvar woman-syntax-table nil
|
|
2026 "Syntax table to support special characters used internally by WoMan.")
|
|
2027
|
|
2028 (if woman-syntax-table
|
|
2029 ()
|
|
2030 (setq woman-syntax-table (make-syntax-table))
|
|
2031 ;; The following internal chars must NOT have whitespace syntax:
|
|
2032 (modify-syntax-entry woman-unpadded-space-char "." woman-syntax-table)
|
|
2033 (modify-syntax-entry woman-escaped-escape-char "." woman-syntax-table)
|
|
2034 )
|
|
2035
|
|
2036 (defun woman-set-buffer-display-table ()
|
|
2037 "Set up a display table for a WoMan buffer.
|
|
2038 This display table is used for displaying internal special characters, but
|
|
2039 does not interfere with any existing display table, e.g. for displaying
|
|
2040 European characters."
|
|
2041 (setq buffer-display-table
|
|
2042 ;; The following test appears to be necessary on some
|
|
2043 ;; non-Windows platforms, e.g. Solaris 2.6 when running on a
|
|
2044 ;; tty. Thanks to T. V. Raman <raman@Adobe.COM>.
|
|
2045 ;; The MS-DOS terminal also sets standard-display-table to
|
|
2046 ;; a non-nil value.
|
|
2047 (if standard-display-table ; default is nil !!!
|
|
2048 (copy-sequence standard-display-table)
|
|
2049 (make-display-table)))
|
|
2050 ;; Display the following internal chars correctly:
|
|
2051 (aset buffer-display-table woman-unpadded-space-char [?\ ])
|
|
2052 (aset buffer-display-table woman-escaped-escape-char [?\\]))
|
|
2053
|
|
2054
|
|
2055 ;;; The main decoding driver:
|
|
2056
|
|
2057 (defvar font-lock-mode) ; for the compiler
|
|
2058
|
|
2059 (defun woman-decode-buffer ()
|
|
2060 "Decode a buffer in UN*X man-page source format.
|
|
2061 No external programs are used."
|
|
2062 (interactive) ; mainly for testing
|
|
2063 (WoMan-log-begin)
|
|
2064 (run-hooks 'woman-pre-format-hook)
|
|
2065 (and (boundp 'font-lock-mode) font-lock-mode (font-lock-mode -1))
|
|
2066 ;; (fundamental-mode)
|
|
2067 (let ((start-time (current-time)) ; (HIGH LOW MICROSEC)
|
|
2068 time) ; HIGH * 2**16 + LOW seconds
|
|
2069 (message "WoMan formatting buffer...")
|
|
2070 ; (goto-char (point-min))
|
|
2071 ; (cond
|
|
2072 ; ((re-search-forward "^\\.[ \t]*TH" nil t) ; wrong format if not found?
|
|
2073 ; (beginning-of-line)
|
|
2074 ; (delete-region (point-min) (point))) ; potentially dangerous!
|
|
2075 ; (t (message "WARNING: .TH request not found -- not man-page format?")))
|
|
2076 (woman-decode-region (point-min) (point-max))
|
|
2077 (setq time (current-time)
|
|
2078 time (+ (* (- (car time) (car start-time)) 65536)
|
|
2079 (- (cadr time) (cadr start-time))))
|
|
2080 (message "WoMan formatting buffer...done in %d seconds" time)
|
|
2081 (WoMan-log-end time))
|
|
2082 (run-hooks 'woman-post-format-hook))
|
|
2083
|
|
2084 (defvar woman-string-alist ; rebound in woman-decode-region
|
|
2085 '(("S" . "") ("R" . "(Reg.)") ("Tm" . "(TM)")
|
|
2086 ("lq" . "\"") ("rq" . "\"")
|
|
2087 ("''" . "\"") ; needed for gcc.1
|
|
2088 (".T" . "") ; output device from -T option?
|
|
2089 )
|
|
2090 "Alist of strings predefined in the -man macro package `tmac.an'.")
|
|
2091
|
|
2092 (defvar woman-negative-vertical-space nil ; rebound in woman-decode-region
|
|
2093 "Set to t if .sp N with N < 0 encountered.")
|
|
2094
|
|
2095 (defun woman-pre-process-region (from to)
|
|
2096 "Pre-process escapes and comments in the region of text between FROM and TO.
|
|
2097 To be called on original buffer and any .so insertions."
|
|
2098 ;; Hide escaped escapes \\ and printable escapes \e very early
|
|
2099 ;; (to be re-instated as just \ very late!):
|
|
2100 (goto-char from)
|
|
2101 ;; .eo turns off escape character processing
|
|
2102 (while (re-search-forward "\\(\\\\[\\e]\\)\\|^\\.eo" to t) ; \\
|
|
2103 (if (match-string 1)
|
|
2104 (replace-match woman-escaped-escape-string t t)
|
|
2105 (woman-delete-whole-line)
|
|
2106 ;; .ec turns on escape character processing (and sets the
|
|
2107 ;; escape character to its argument, if any, which I'm ignoring
|
|
2108 ;; for now!)
|
|
2109 (while (and (re-search-forward "\\(\\\\\\)\\|^\\.ec" to t) ; \
|
|
2110 (match-string 1))
|
|
2111 (replace-match woman-escaped-escape-string t t))
|
|
2112 ;; ***** Need test for .ec arg and warning here! *****
|
|
2113 (woman-delete-whole-line)))
|
|
2114
|
|
2115 ;; Delete comments .\"<anything>, \"<anything>, pre-processor
|
|
2116 ;; directives '\"<anything> (should give warning?) and null
|
|
2117 ;; requests. (However, should null . requests cause a break?)
|
|
2118 (goto-char from)
|
|
2119 (while (re-search-forward "^[.'][ \t]*\\(\\\\\".*\\)?\n\\|\\\\\".*" to t)
|
|
2120 (woman-delete-match 0))
|
|
2121 )
|
|
2122
|
|
2123 (defun woman-non-underline-faces ()
|
|
2124 "Prepare non-underlined versions of underlined faces."
|
|
2125 (let ((face-list (face-list)))
|
|
2126 (while face-list
|
|
2127 (let* ((face (car face-list))
|
|
2128 (face-name (symbol-name face)))
|
|
2129 (if (and (string-match "\\`woman-" face-name)
|
|
2130 (face-underline-p face))
|
|
2131 (let ((face-no-ul (intern (concat face-name "-no-ul"))))
|
|
2132 (copy-face face face-no-ul)
|
|
2133 (set-face-underline-p face-no-ul nil))))
|
|
2134 (setq face-list (cdr face-list)))))
|
|
2135
|
|
2136 (defun woman-decode-region (from to)
|
|
2137 "Decode the region between FROM and TO in UN*X man-page source format."
|
|
2138 ;; Suitable for use in format-alist.
|
|
2139 ;; But this requires care to control major mode implied font locking.
|
|
2140 ;; Must return the new end of file. See format.el for details.
|
|
2141 ;; NB: The `to' argument is bogus: it is not currently used, and if
|
|
2142 ;; it were it would need to be a marker rather than a position!
|
|
2143 ;; First force the correct environment:
|
|
2144 (let ((case-fold-search nil) ; This is necessary!
|
|
2145 (woman-string-alist woman-string-alist)
|
|
2146 (woman-fill-column woman-fill-column)
|
|
2147 woman-negative-vertical-space)
|
|
2148 (setq woman-left-margin woman-default-indent
|
|
2149 woman-prevailing-indent woman-default-indent
|
|
2150 woman-interparagraph-distance 1
|
|
2151 woman-leave-blank-lines nil
|
|
2152 woman-RS-left-margin nil
|
|
2153 woman-RS-prevailing-indent nil
|
|
2154 woman-adjust woman-adjust-both
|
|
2155 woman-justify (nth woman-adjust woman-justify-list)
|
|
2156 woman-nofill nil)
|
|
2157
|
29074
|
2158 (setq woman-if-conditions-true
|
|
2159 (cons (string-to-char (symbol-name woman-emulation)) '(?e ?o)))
|
|
2160
|
28832
|
2161 ;; Prepare non-underlined versions of underlined faces:
|
|
2162 (woman-non-underline-faces)
|
29074
|
2163 ;; Set font of `woman-symbol-face' to `woman-symbol-font' if
|
|
2164 ;; `woman-symbol-font' is well defined.
|
|
2165 (and woman-use-symbol-font
|
|
2166 (stringp woman-symbol-font)
|
|
2167 (set-face-font 'woman-symbol-face woman-symbol-font
|
|
2168 (and (frame-live-p woman-frame) woman-frame)))
|
28832
|
2169
|
|
2170 ;; Set syntax and display tables:
|
|
2171 (set-syntax-table woman-syntax-table)
|
|
2172 (woman-set-buffer-display-table)
|
|
2173
|
|
2174 ;; Based loosely on a suggestion by Theodore Jump:
|
|
2175 (if (or woman-fill-frame
|
|
2176 (not (and (integerp woman-fill-column) (> woman-fill-column 0))))
|
|
2177 (setq woman-fill-column (- (frame-width) woman-default-indent)))
|
|
2178
|
|
2179 (woman-pre-process-region from nil)
|
|
2180 ;; Process ignore requests, macro definitions,
|
|
2181 ;; conditionals and switch source requests:
|
|
2182 (woman0-roff-buffer from)
|
|
2183
|
|
2184 ;; Process \k escapes BEFORE changing tab width (?):
|
|
2185 (goto-char from)
|
|
2186 (woman-mark-horizonal-position)
|
|
2187
|
|
2188 ;; Set buffer-local variables:
|
|
2189 (setq fill-column woman-fill-column
|
|
2190 tab-width woman-tab-width)
|
|
2191
|
|
2192 ;; Hide unpaddable and digit-width spaces \(space) and \0:
|
|
2193 (goto-char from)
|
|
2194 (while (re-search-forward "\\\\[ 0]" nil t)
|
|
2195 (replace-match woman-unpadded-space-string t t))
|
|
2196
|
|
2197 ;; Discard optional hyphen \%; concealed newlines \<newline>;
|
|
2198 ;; point-size change function \sN,\s+N, \s-N:
|
|
2199 (goto-char from)
|
|
2200 (while (re-search-forward "\\\\\\([%\n]\\|s[-+]?[0-9]+\\)" nil t)
|
|
2201 (woman-delete-match 0))
|
|
2202
|
|
2203 ;; BEWARE: THIS SHOULD PROBABLY ALL BE DONE MUCH LATER!!!!!
|
|
2204 ;; Process trivial escapes \-, \`, \.
|
|
2205 ;; (\' must be done after tab processing!):
|
|
2206 (goto-char from)
|
|
2207 (while (re-search-forward "\\\\\\([-`.]\\)" nil t)
|
|
2208 (replace-match "\\1"))
|
|
2209 ;; NB: Must keep ALL zero-width characters \&, \|, and \^ until
|
|
2210 ;; ALL requests processed!
|
|
2211
|
|
2212 ;; Process no-break requests and macros (including font-change macros):
|
|
2213 (goto-char from)
|
|
2214 (woman1-roff-buffer)
|
|
2215
|
|
2216 ;; Process strings and special character escapes \(xx:
|
|
2217 ;; (Must do this BEFORE fontifying!)
|
|
2218 (goto-char from)
|
|
2219 (woman-strings)
|
|
2220 ;; Special chars moved after translation in
|
|
2221 ;; `woman2-process-escapes' (for pic.1):
|
|
2222 ; (goto-char from)
|
|
2223 ; (woman-special-characters)
|
|
2224
|
|
2225 ;; Process standard font-change requests and escapes:
|
|
2226 (goto-char from)
|
|
2227 (woman-change-fonts)
|
|
2228
|
|
2229 ;; 1/2 em vertical motion \d, \u and general local vertical motion
|
|
2230 ;; \v'+/-N' simulated using TeX ^ and _ symbols for now.
|
|
2231 (goto-char from)
|
|
2232 (let ((first t)) ; assume no nesting!
|
|
2233 (while (re-search-forward "\\\\\\([du]\\|v'[^']*'\\)" nil t)
|
|
2234 (let* ((esc (match-string 1))
|
|
2235 (repl (if (or (= (aref esc 0) ?u)
|
|
2236 (and (>= (length esc) 2) (= (aref esc 2) ?-)))
|
|
2237 "^" "_")))
|
|
2238 (cond (first
|
|
2239 (replace-match repl nil t)
|
|
2240 (put-text-property (1- (point)) (point)
|
|
2241 'face 'woman-addition-face)
|
|
2242 (WoMan-warn
|
|
2243 "Initial vertical motion escape \\%s simulated" esc)
|
|
2244 (WoMan-log
|
|
2245 " by TeX `%s' in woman-addition-face!" repl))
|
|
2246 (t
|
|
2247 (woman-delete-match 0)
|
|
2248 (WoMan-warn
|
|
2249 "Terminal vertical motion escape \\%s ignored!" esc)))
|
|
2250 (setq first (not first))
|
|
2251 )))
|
|
2252
|
|
2253 ; ;; \h'+/-N' local horizontal motion.
|
|
2254 ; ;; N may include width escape \w'...'
|
|
2255 ; ;; Implement arbitrary forward motion and non-overlapping backward
|
|
2256 ; ;; motion.
|
|
2257 ; (goto-char from)
|
|
2258 ; (while (re-search-forward
|
|
2259 ; ;; Delimiter can be a special char escape sequence \(.. or
|
|
2260 ; ;; a single normal char (usually '):
|
|
2261 ; "\\\\h\\(\\\\(..\\|.\\)\\(|\\)?"
|
|
2262 ; nil t)
|
|
2263 ; (let ((from (match-beginning 0))
|
|
2264 ; (delim (regexp-quote (match-string 1)))
|
|
2265 ; (absolute (match-string 2)) ; absolute position?
|
|
2266 ; (N (woman-parse-numeric-arg)) ; distance
|
|
2267 ; to
|
|
2268 ; msg) ; for warning
|
|
2269 ; (if (not (looking-at delim))
|
|
2270 ; ;; Warn but leave escape in buffer unprocessed:
|
|
2271 ; (WoMan-warn
|
|
2272 ; "Local horizontal motion (%s) delimiter error!"
|
|
2273 ; (buffer-substring from (1+ (point)))) ; point at end of arg
|
|
2274 ; (setq to (match-end 0)
|
|
2275 ; ;; For possible warning -- save before deleting:
|
|
2276 ; msg (buffer-substring from to))
|
|
2277 ; (delete-region from to)
|
|
2278 ; (if absolute ; make relative
|
|
2279 ; (setq N (- N (current-column))))
|
|
2280 ; (if (>= N 0)
|
|
2281 ; ;; Move forward by inserting hard spaces:
|
|
2282 ; (insert-char woman-unpadded-space-char N)
|
|
2283 ; ;; Move backwards by deleting space,
|
|
2284 ; ;; first backwards then forwards:
|
|
2285 ; (while (and
|
|
2286 ; (<= (setq N (1+ N)) 0)
|
|
2287 ; (cond ((memq (preceding-char) '(?\ ?\t))
|
|
2288 ; (delete-backward-char 1) t)
|
|
2289 ; ((memq (following-char) '(?\ ?\t))
|
|
2290 ; (delete-char 1) t)
|
|
2291 ; (t nil))))
|
|
2292 ; (if (<= N 0)
|
|
2293 ; (WoMan-warn
|
|
2294 ; "Negative horizontal motion (%s) would overwrite!" msg))))
|
|
2295 ; ))
|
|
2296
|
|
2297 ;; Process formatting macros
|
|
2298 (goto-char from)
|
|
2299 (woman2-roff-buffer)
|
|
2300
|
|
2301 ;; Go back and process negative vertical space if necessary:
|
|
2302 (if woman-negative-vertical-space
|
|
2303 (woman-negative-vertical-space from))
|
|
2304
|
|
2305 (if woman-preserve-ascii
|
|
2306 ;; Re-instate escaped escapes to just `\' and unpaddable
|
|
2307 ;; spaces to just `space', without inheriting any text
|
|
2308 ;; properties. This is not necessary, UNLESS the buffer is to
|
|
2309 ;; be saved as ASCII.
|
|
2310 (progn
|
|
2311 (goto-char from)
|
|
2312 (while (search-forward woman-escaped-escape-string nil t)
|
|
2313 (delete-char -1) (insert ?\\))
|
|
2314 (goto-char from)
|
|
2315 (while (search-forward woman-unpadded-space-string nil t)
|
|
2316 (delete-char -1) (insert ?\ ))
|
|
2317 ))
|
|
2318
|
|
2319 ;; Must return the new end of file if used in format-alist.
|
|
2320 (point-max)))
|
|
2321
|
|
2322 (defun woman-horizontal-escapes (to)
|
29074
|
2323 "Process \\h'+/-N' local horizontal motion escapes upto TO.
|
|
2324 Implements arbitrary forward and non-overlapping backward motion.
|
|
2325 Preserves location of `point'."
|
28832
|
2326 ;; Moved from `woman-decode-region' for version 0.50.
|
|
2327 ;; N may include width escape \w'...' (but may already be processed!
|
|
2328 (let ((from (point)))
|
|
2329 (while (re-search-forward
|
|
2330 ;; Delimiter can be a special char escape sequence \(.. or
|
|
2331 ;; a single normal char (usually '):
|
|
2332 "\\\\h\\(\\\\(..\\|.\\)\\(|\\)?"
|
|
2333 to t)
|
|
2334 (let ((from (match-beginning 0))
|
|
2335 (delim (regexp-quote (match-string 1)))
|
|
2336 (absolute (match-string 2)) ; absolute position?
|
|
2337 (N (woman-parse-numeric-arg)) ; distance
|
|
2338 to
|
|
2339 msg) ; for warning
|
|
2340 (if (not (looking-at delim))
|
|
2341 ;; Warn but leave escape in buffer unprocessed:
|
|
2342 (WoMan-warn
|
|
2343 "Local horizontal motion (%s) delimiter error!"
|
|
2344 (buffer-substring from (1+ (point)))) ; point at end of arg
|
|
2345 (setq to (match-end 0)
|
|
2346 ;; For possible warning -- save before deleting:
|
|
2347 msg (buffer-substring from to))
|
|
2348 (delete-region from to)
|
|
2349 (if absolute ; make relative
|
|
2350 (setq N (- N (current-column))))
|
|
2351 (if (>= N 0)
|
|
2352 ;; Move forward by inserting hard spaces:
|
|
2353 (insert-char woman-unpadded-space-char N)
|
|
2354 ;; Move backwards by deleting space,
|
|
2355 ;; first backwards then forwards:
|
|
2356 (while (and
|
|
2357 (<= (setq N (1+ N)) 0)
|
|
2358 (cond ((memq (preceding-char) '(?\ ?\t))
|
|
2359 (delete-backward-char 1) t)
|
|
2360 ((memq (following-char) '(?\ ?\t))
|
|
2361 (delete-char 1) t)
|
|
2362 (t nil))))
|
|
2363 (if (<= N 0)
|
|
2364 (WoMan-warn
|
|
2365 "Negative horizontal motion (%s) would overwrite!" msg))))
|
|
2366 ))
|
|
2367 (goto-char from)))
|
|
2368
|
|
2369
|
|
2370
|
29074
|
2371 ;; Process ignore requests (.ig), conditionals (.if etc.),
|
|
2372 ;; source-switch (.so), macro definitions (.de etc.) and macro
|
|
2373 ;; expansions.
|
28832
|
2374
|
|
2375 (defvar woman0-if-to) ; marker bound in woman0-roff-buffer
|
|
2376 (defvar woman0-macro-alist) ; bound in woman0-roff-buffer
|
|
2377 (defvar woman0-search-regex) ; bound in woman0-roff-buffer
|
|
2378 (defvar woman0-search-regex-start ; bound in woman0-roff-buffer
|
|
2379 "^[.'][ \t]*\\(ig\\|if\\|ie\\|el\\|so\\|rn\\|de\\|am")
|
|
2380 (defconst woman0-search-regex-end "\\)\\([ \t]+\\|$\\)")
|
|
2381 ;; May need other terminal characters, e.g. \, but NOT \n!
|
|
2382 ;; Alternatively, force maximal match (Posix?)
|
|
2383
|
|
2384 (defvar woman0-rename-alist) ; bound in woman0-roff-buffer
|
|
2385
|
|
2386 (defun woman0-roff-buffer (from)
|
29074
|
2387 "Process conditional-type requests and user-defined macros.
|
|
2388 Start at FROM and re-scan new text as appropriate."
|
28832
|
2389 (goto-char from)
|
|
2390 (let ((woman0-if-to (make-marker))
|
|
2391 request woman0-macro-alist
|
|
2392 (woman0-search-regex-start woman0-search-regex-start)
|
|
2393 (woman0-search-regex
|
|
2394 (concat woman0-search-regex-start woman0-search-regex-end))
|
|
2395 woman0-rename-alist)
|
|
2396 (while (re-search-forward woman0-search-regex nil t)
|
|
2397 (setq request (match-string 1))
|
|
2398 (cond ((string= request "ig") (woman0-ig))
|
|
2399 ((string= request "if") (woman0-if "if"))
|
|
2400 ((string= request "ie") (woman0-if "ie"))
|
|
2401 ((string= request "el") (woman0-el))
|
|
2402 ((string= request "so") (woman0-so))
|
|
2403 ((string= request "rn") (woman0-rn))
|
|
2404 ((string= request "de") (woman0-de))
|
|
2405 ((string= request "am") (woman0-de 'append))
|
|
2406 (t (woman0-macro request))))
|
|
2407 (set-marker woman0-if-to nil)
|
|
2408 (woman0-rename)
|
|
2409 ;; Should now re-run `woman0-roff-buffer' if any renaming was
|
|
2410 ;; done, but let's just hope this is not necessary for now!
|
|
2411 ))
|
|
2412
|
|
2413 (defun woman0-ig ()
|
|
2414 ".ig yy -- Discard input up to `.yy', which defaults to `..')."
|
|
2415 ;; The terminal request MUST begin with . (not ')!
|
|
2416 (looking-at "\\(\\S +\\)?")
|
|
2417 (beginning-of-line)
|
|
2418 (let ((yy (or (match-string 1) "."))
|
|
2419 (from (point)))
|
|
2420 (if (re-search-forward
|
|
2421 (concat "^\\.[ \t]*" (regexp-quote yy) ".*\n") nil t)
|
|
2422 (delete-region from (point))
|
|
2423 (WoMan-warn
|
|
2424 "ig request ignored -- terminator `.%s' not found!" yy)
|
|
2425 (woman-delete-line 1))
|
|
2426 ))
|
|
2427
|
|
2428 (defsubst woman0-process-escapes (from to)
|
|
2429 "Process escapes within an if/ie condition between FROM and TO."
|
|
2430 (woman-strings to)
|
|
2431 (goto-char from) ; necessary!
|
|
2432 ;; Strip font-change escapes:
|
|
2433 (while (re-search-forward "\\\\f\\((..\\|.\\)" to t)
|
|
2434 (woman-delete-match 0))
|
|
2435 (goto-char from) ; necessary!
|
|
2436 (woman2-process-escapes to 'numeric))
|
|
2437
|
|
2438 (defun woman0-if (request)
|
|
2439 ".if/ie c anything -- Discard unless c evaluates to true.
|
|
2440 Remember condition for use by a subsequent `.el'.
|
|
2441 REQUEST is the invoking directive without the leading dot."
|
|
2442 ;; c evaluates to a one-character built-in condition name or
|
|
2443 ;; 'string1'string2' or a number > 0, prefix ! negates.
|
|
2444 ;; \{ ... \} for multi-line use.
|
|
2445 ;; Leaves point at start of new text.
|
|
2446 (woman-delete-match 0)
|
|
2447 ;; (delete-horizontal-space)
|
|
2448 ;; Process escapes in condition:
|
|
2449 (let ((from (point)) negated n (c 0))
|
|
2450 (set-marker woman0-if-to
|
|
2451 (save-excursion (skip-syntax-forward "^ ") (point)))
|
|
2452 ;; Process condition:
|
|
2453 (if (setq negated (= (following-char) ?!)) (delete-char 1))
|
|
2454 (cond
|
29074
|
2455 ;; ((looking-at "[no]") (setq c t)) ; accept n(roff) and o(dd page)
|
|
2456 ;; ((looking-at "[te]") (setq c nil)) ; reject t(roff) and e(ven page)
|
|
2457 ((looking-at "[ntoe]")
|
|
2458 (setq c (memq (following-char) woman-if-conditions-true)))
|
28832
|
2459 ;; Unrecognised letter so reject:
|
|
2460 ((looking-at "[A-Za-z]") (setq c nil)
|
|
2461 (WoMan-warn "%s %s -- unrecognised condition name rejected!"
|
|
2462 request (match-string 0)))
|
|
2463 ;; Accept strings if identical:
|
|
2464 ((save-restriction
|
|
2465 (narrow-to-region from woman0-if-to)
|
|
2466 ;; String delimiter can be any non-numeric character,
|
|
2467 ;; including a special character escape:
|
|
2468 (looking-at "\\(\\\\(..\\|[^0-9]\\)\\(.*\\)\\1\\(.*\\)\\1\\'"))
|
|
2469 (let ((end1 (copy-marker (match-end 2)))) ; end of first string
|
|
2470 ;; Delete 2nd and 3rd delimiters to avoid processing them:
|
|
2471 (delete-region (match-end 3) woman0-if-to)
|
|
2472 (delete-region (match-end 2) (match-beginning 3))
|
|
2473 (goto-char (match-end 1))
|
|
2474 (woman0-process-escapes (point) woman0-if-to)
|
|
2475 (setq c (string= (buffer-substring (point) end1)
|
|
2476 (buffer-substring end1 woman0-if-to)))
|
|
2477 (set-marker end1 nil)
|
|
2478 (goto-char from)))
|
|
2479 ;; Accept numeric value if > 0:
|
|
2480 ((numberp (setq n (progn
|
|
2481 (woman0-process-escapes from woman0-if-to)
|
|
2482 (woman-parse-numeric-arg))))
|
|
2483 (setq c (> n 0))
|
|
2484 (goto-char from))
|
|
2485 )
|
|
2486 (if (eq c 0)
|
|
2487 (woman-if-ignore woman0-if-to request) ; ERROR!
|
|
2488 (woman-if-body request woman0-if-to (eq c negated)))
|
|
2489 ))
|
|
2490
|
|
2491 (defun woman-if-body (request to delete) ; should be reversed as `accept'?
|
29074
|
2492 "Process if-body, including \\{ ... \\}.
|
|
2493 REQUEST is the invoking directive without the leading dot.
|
|
2494 If TO is non-nil then delete the if-body.
|
|
2495 If DELETE is non-nil then delete from point."
|
28832
|
2496 ;; Assume concealed newlines already processed.
|
|
2497 (let ((from (point)))
|
|
2498 (if to (delete-region (point) to))
|
|
2499 (delete-horizontal-space)
|
|
2500 (cond (;;(looking-at "[^{\n]*\\\\{\\s *") ; multi-line
|
|
2501 ;; allow escaped newlines:
|
|
2502 (looking-at "[^{\n]*\\(\\\\\n\\)*\\\\{\\s *\\(\\\\\n\\)*") ; multi-line
|
|
2503 ;; including preceding .if(s) and following newline
|
|
2504 (let ((from (point)))
|
|
2505 (woman-delete-match 0)
|
|
2506 ;; Allow for nested \{ ... \} -- BUT BEWARE that this
|
|
2507 ;; algorithm only supports one level of nesting!
|
|
2508 (while
|
|
2509 (and (re-search-forward
|
|
2510 ;; "\\(\\\\{\\)\\|\\(\n[.']\\)?[ \t]*\\\\}[ \t]*"
|
|
2511 ;; Interpret bogus `el \}' as `el \{',
|
|
2512 ;; especially for Tcl/Tk man pages:
|
|
2513 "\\(\\\\{\\|el[ \t]*\\\\}\\)\\|\\(\n[.']\\)?[ \t]*\\\\}[ \t]*")
|
|
2514 (match-string 1))
|
|
2515 (re-search-forward "\\\\}"))
|
|
2516 (delete-region (if delete from (match-beginning 0)) (point))
|
|
2517 (if (looking-at "^$") (delete-char 1))
|
|
2518 ))
|
|
2519 (delete (woman-delete-line 1)) ; single-line
|
|
2520 )
|
|
2521 ;; Process matching .el anything:
|
|
2522 (cond ((string= request "ie")
|
|
2523 ;; Discard unless previous .ie c `evaluated to false'.
|
|
2524 (cond ((re-search-forward "^[.'][ \t]*el[ \t]*" nil t)
|
|
2525 (woman-delete-match 0)
|
|
2526 (woman-if-body "el" nil (not delete)))))
|
|
2527 ;; Got here after processing a single-line `.ie' as a body
|
|
2528 ;; clause to be discarded:
|
|
2529 ((string= request "el")
|
|
2530 (cond ((re-search-forward "^[.'][ \t]*el[ \t]*" nil t)
|
|
2531 (woman-delete-match 0)
|
|
2532 (woman-if-body "el" nil t))))
|
|
2533 )
|
|
2534 (goto-char from)
|
|
2535 ))
|
|
2536
|
|
2537 (defun woman0-el ()
|
|
2538 "Isolated .el request -- should not happen!"
|
|
2539 (WoMan-warn "el request without matching `ie' rejected!")
|
|
2540 (cond (woman-ignore
|
|
2541 (woman-delete-match 0)
|
|
2542 (delete-horizontal-space)
|
|
2543 (woman-if-body "el" nil t))
|
|
2544 (t ; Ignore -- leave in buffer
|
|
2545 ;; This does not work too well, but it's only for debugging!
|
|
2546 (skip-chars-forward "^ \t")
|
|
2547 (if (looking-at "[ \t]*\\{") (search-forward "\\}"))
|
|
2548 (forward-line 1))))
|
|
2549
|
|
2550 (defun woman-if-ignore (to request)
|
29074
|
2551 "Ignore but warn about an if request ending at TO, named REQUEST."
|
28832
|
2552 (WoMan-warn-ignored request "ignored -- condition not handled!")
|
|
2553 (if woman-ignore
|
|
2554 (woman-if-body request to t)
|
|
2555 ;; Ignore -- leave in buffer
|
|
2556 ;; This does not work too well, but it's only for debugging!
|
|
2557 (skip-chars-forward "^ \t")
|
|
2558 (if (looking-at "[ \t]*\\{") (search-forward "\\}"))
|
|
2559 (forward-line 1)))
|
|
2560
|
|
2561 (defun woman0-so ()
|
|
2562 ".so filename -- Switch source file. `.so' requests may be nested."
|
|
2563 ;; Leaves point at start of new text.
|
|
2564 ;; (skip-chars-forward " \t")
|
|
2565 (let* ((beg (point))
|
|
2566 (end (progn (woman-forward-arg 'unquote) (point)))
|
|
2567 (name (buffer-substring beg end))
|
|
2568 (filename name))
|
|
2569 ;; If the specified file does not exist in this ...
|
|
2570 (or (file-exists-p filename)
|
|
2571 ;; or the parent directory ...
|
|
2572 (file-exists-p
|
|
2573 (setq filename (concat "../" name)))
|
|
2574 ;; then use the WoMan search mechanism to find the filename ...
|
|
2575 (setq filename
|
|
2576 (woman-file-name
|
|
2577 (file-name-sans-extension
|
|
2578 (file-name-nondirectory name))))
|
|
2579 ;; Cannot find the file, so ...
|
|
2580 (kill-buffer (current-buffer))
|
|
2581 (error "File `%s' not found" name))
|
|
2582 (beginning-of-line)
|
|
2583 (woman-delete-line 1)
|
|
2584 (let ((from (point))
|
|
2585 (to (make-marker))
|
|
2586 (length (woman-insert-file-contents filename 0)))
|
|
2587 (set-marker to (+ from length))
|
|
2588 (woman-pre-process-region from to)
|
|
2589 (set-marker to nil)
|
|
2590 (goto-char from)
|
|
2591 )))
|
|
2592
|
|
2593
|
|
2594 ;;; Process macro definitions:
|
|
2595
|
|
2596 (defun woman0-rn ()
|
|
2597 "Process .rn xx yy -- rename macro xx to yy."
|
|
2598 ;; For now, done backwards AFTER all macro expansion.
|
|
2599 ;; Should also allow requests and strings to be renamed!
|
|
2600 (if (eolp) ; ignore if no argument
|
|
2601 ()
|
|
2602 (let* ((beg (point))
|
|
2603 (end (progn (woman-forward-arg 'unquote 'concat) (point)))
|
|
2604 (old (buffer-substring beg end))
|
|
2605 new)
|
|
2606 (if (eolp) ; ignore if no argument
|
|
2607 ()
|
|
2608 (setq beg (point)
|
|
2609 end (progn (woman-forward-arg 'unquote) (point))
|
|
2610 new (buffer-substring beg end)
|
|
2611 woman0-rename-alist (cons (cons new old) woman0-rename-alist)))
|
|
2612 ))
|
|
2613 (woman-delete-whole-line))
|
|
2614
|
|
2615 (defun woman0-rename ()
|
|
2616 "Effect renaming required by .rn requests."
|
|
2617 ;; For now, do this backwards AFTER all macro expansion.
|
|
2618 (while woman0-rename-alist
|
|
2619 (let* ((new (car woman0-rename-alist))
|
|
2620 (old (cdr new))
|
|
2621 (new (car new)))
|
|
2622 (setq woman0-rename-alist (cdr woman0-rename-alist))
|
|
2623 (goto-char (point-min))
|
|
2624 (setq new (concat "^[.'][ \t]*" (regexp-quote new)))
|
|
2625 (setq old (concat "." old))
|
|
2626 (while (re-search-forward new nil t)
|
|
2627 (replace-match old nil t)))))
|
|
2628
|
|
2629 (defconst woman-unescape-regex
|
|
2630 (concat woman-escaped-escape-string
|
|
2631 "\\(" woman-escaped-escape-string "\\)?"))
|
|
2632
|
|
2633 (defsubst woman-unescape (macro)
|
29074
|
2634 "Replace escape sequences in the body of MACRO.
|
28832
|
2635 Replaces || by |, but | by \, where | denotes the internal escape."
|
|
2636 (let (start)
|
|
2637 (while (setq start (string-match woman-unescape-regex macro start))
|
|
2638 (setq macro
|
|
2639 (if (match-string 1 macro)
|
|
2640 (replace-match "" t t macro 1)
|
|
2641 (replace-match "\\" t t macro))
|
|
2642 start (1+ start)))
|
|
2643 macro))
|
|
2644
|
|
2645 (defun woman0-de (&optional append)
|
|
2646 "Process .de/am xx yy -- (re)define/append macro xx; end at `..'.
|
|
2647 \(Should be up to call of yy, which defaults to `.')
|
|
2648 Optional argument APPEND, if non-nil, means append macro."
|
|
2649 ;; Modelled on woman-strings. BEWARE: Processing of .am is a hack!
|
|
2650 ;; Add support for .rm?
|
|
2651 ;; (skip-chars-forward " \t")
|
|
2652 (if (eolp) ; ignore if no argument
|
|
2653 ()
|
|
2654 (looking-at "[^ \t\n]+") ; macro name
|
|
2655 (let* ((macro (match-string 0)) from
|
|
2656 (previous (assoc macro woman0-macro-alist)))
|
|
2657 (if (not previous)
|
|
2658 (setq woman0-search-regex-start
|
|
2659 (concat woman0-search-regex-start "\\|" (regexp-quote macro))
|
|
2660 woman0-search-regex
|
|
2661 (concat woman0-search-regex-start woman0-search-regex-end)
|
|
2662 ))
|
|
2663 ;; Macro body runs from start of next line to line
|
|
2664 ;; beginning with `..'."
|
|
2665 ;; The terminal request MUST begin with `.' (not ')!
|
|
2666 (forward-line)
|
|
2667 (setq from (point))
|
|
2668 (re-search-forward "^\\.[ \t]*\\.")
|
|
2669 (beginning-of-line)
|
|
2670 (let ((body (woman-unescape (buffer-substring from (point)))))
|
|
2671 (if (and append previous)
|
|
2672 (setq previous (cdr previous)
|
|
2673 body (concat body (cdr previous))
|
|
2674 append (car previous)
|
|
2675 ))
|
|
2676 (setq macro (cons macro (cons append body))))
|
|
2677 ;; This should be an update, but consing a new string
|
|
2678 ;; onto the front of the alist has the same effect:
|
|
2679 (setq woman0-macro-alist (cons macro woman0-macro-alist))
|
|
2680 (forward-line)
|
|
2681 (delete-region from (point))
|
|
2682 (backward-char) ; return to end of .de/am line
|
|
2683 ))
|
|
2684 (beginning-of-line) ; delete .de/am line
|
|
2685 (woman-delete-line 1))
|
|
2686
|
|
2687 (defun woman0-macro (request)
|
29074
|
2688 "Process the macro call named REQUEST."
|
28832
|
2689 ;; Leaves point at start of new text.
|
|
2690 (let ((macro (assoc request woman0-macro-alist)))
|
|
2691 (if macro
|
|
2692 (woman-interpolate-macro (cdr macro))
|
|
2693 ;; SHOULD DELETE THE UNINTERPRETED REQUEST!!!!!
|
|
2694 ;; Output this message once only per call (cf. strings)?
|
|
2695 (WoMan-warn "Undefined macro %s not interpolated!" request))))
|
|
2696
|
|
2697 (defun woman-interpolate-macro (macro)
|
29074
|
2698 "Interpolate (.de) or append (.am) expansion of MACRO into the buffer."
|
28832
|
2699 ;; Could make this more efficient by checking which arguments are
|
|
2700 ;; actually used in the expansion!
|
|
2701 (skip-chars-forward " \t")
|
|
2702 ;; Process arguments:
|
|
2703 (let ((argno 0) (append (car macro))
|
|
2704 argno-string formal-arg from actual-arg start)
|
|
2705 (setq macro (cdr macro))
|
|
2706 (while (not (eolp))
|
|
2707 ;; Get next actual arg:
|
|
2708 (setq argno (1+ argno))
|
|
2709 (setq argno-string (format "%d" argno))
|
|
2710 (setq formal-arg (concat "\\\\\\$" argno-string)) ; regexp
|
|
2711 (setq from (point))
|
|
2712 (woman-forward-arg 'unquote 'noskip)
|
|
2713 (setq actual-arg (buffer-substring from (point)))
|
|
2714 (skip-chars-forward " \t") ; now skip following whitespace!
|
|
2715 ;; Replace formal arg with actual arg:
|
|
2716 (setq start nil)
|
|
2717 (while (setq start (string-match formal-arg macro start))
|
|
2718 (setq macro (replace-match actual-arg t t macro)))
|
|
2719 )
|
|
2720 ;; Delete any remaining formal arguments:
|
|
2721 (setq start nil)
|
|
2722 (while
|
|
2723 (setq start (string-match "\\\\\\$." macro start))
|
|
2724 (setq macro (replace-match "" t t macro)))
|
|
2725 ;; Replace .$ number register with actual arg:
|
|
2726 ;; (Do this properly via register mechanism later!)
|
|
2727 (setq start nil)
|
|
2728 (while
|
|
2729 (setq start (string-match "\\\\n(\\.\\$" macro start)) ; regexp
|
|
2730 (setq macro (replace-match argno-string t t macro)))
|
|
2731 (if append
|
|
2732 (forward-char)
|
|
2733 (beginning-of-line)
|
|
2734 (woman-delete-line 1))
|
|
2735 (save-excursion ; leave point at start of new text
|
|
2736 (insert macro))))
|
|
2737
|
|
2738
|
|
2739 ;;; Process strings:
|
|
2740
|
|
2741 (defun woman-strings (&optional to)
|
29074
|
2742 "Process ?roff string requests and escape sequences up to buffer position TO.
|
|
2743 Strings are defined/updated by `.ds xx string' requests and
|
|
2744 interpolated by `\*x' and `\*(xx' escapes."
|
28832
|
2745 ;; Add support for .as and .rm?
|
|
2746 (while
|
|
2747 ;; Find .ds requests and \* escapes:
|
|
2748 (re-search-forward "\\(^[.'][ \t]*ds\\)\\|\\\\\\*" to t)
|
|
2749 (cond ((match-string 1) ; .ds
|
|
2750 (skip-chars-forward " \t")
|
|
2751 (if (eolp) ; ignore if no argument
|
|
2752 ()
|
|
2753 (re-search-forward "[^ \t\n]+")
|
|
2754 (let ((string (match-string 0)))
|
|
2755 (skip-chars-forward " \t")
|
|
2756 ; (setq string
|
|
2757 ; (cons string
|
|
2758 ; ;; hack (?) for CGI.man!
|
|
2759 ; (cond ((looking-at "\"\"") "\"")
|
|
2760 ; ((looking-at ".*") (match-string 0)))
|
|
2761 ; ))
|
|
2762 ;; Above hack causes trouble in arguments!
|
|
2763 (looking-at ".*")
|
|
2764 (setq string (cons string (match-string 0)))
|
|
2765 ;; This should be an update, but consing a new string
|
|
2766 ;; onto the front of the alist has the same effect:
|
|
2767 (setq woman-string-alist (cons string woman-string-alist))
|
|
2768 ))
|
|
2769 (beginning-of-line)
|
|
2770 (woman-delete-line 1))
|
|
2771 (t ; \*
|
|
2772 (let ((beg (match-beginning 0)))
|
|
2773 (cond ((= (following-char) ?\( )
|
|
2774 (forward-char)
|
|
2775 (re-search-forward ".."))
|
|
2776 (t (re-search-forward ".")))
|
|
2777 (let* ((stringname (match-string 0))
|
|
2778 (string (assoc stringname woman-string-alist)))
|
|
2779 (cond (string
|
|
2780 (delete-region beg (point))
|
|
2781 ;; Temporary hack in case string starts with a
|
|
2782 ;; control character:
|
|
2783 (if (bolp) (insert-before-markers "\\&"))
|
|
2784 (insert-before-markers (cdr string)))
|
|
2785 (t
|
|
2786 (WoMan-warn "Undefined string %s not interpolated!"
|
|
2787 stringname)
|
|
2788 (cond (woman-ignore
|
|
2789 ;; Output above message once only per call
|
|
2790 (delete-region beg (point))
|
|
2791 (setq woman-string-alist
|
|
2792 (cons (cons stringname "")
|
|
2793 woman-string-alist))))
|
|
2794 ))
|
|
2795 ))
|
|
2796 ))
|
|
2797 ))
|
|
2798
|
|
2799
|
|
2800 ;;; Process special character escapes \(xx:
|
|
2801
|
|
2802 (defconst woman-special-characters
|
|
2803 ;; To be built heuristically as required!
|
|
2804 ;; MUST insert all characters as strings for correct conversion to
|
|
2805 ;; multibyte representation!
|
|
2806 '(("em" "--" "\276" . t) ; 3/4 Em dash
|
|
2807 ("bu" "*" "\267" . t) ; bullet
|
|
2808 ("fm" "'") ; foot mark
|
|
2809 ("co" "(C)" "\251") ; copyright
|
|
2810
|
|
2811 ("pl" "+" "+" . t) ; math plus
|
|
2812 ("mi" "-" "-" . t) ; math minus
|
|
2813 ("**" "*" "*" . t) ; math star
|
|
2814 ("aa" "'" "\242" . t) ; acute accent
|
|
2815 ("ul" "_") ; underrule
|
|
2816
|
|
2817 ("*S" "Sigma" "S" . t) ; Sigma
|
|
2818
|
|
2819 (">=" ">=" "\263" . t) ; >=
|
|
2820 ("<=" "<=" "\243" . t) ; <=
|
|
2821 ("->" "->" "\256" . t) ; right arrow
|
|
2822 ("<-" "<-" "\254" . t) ; left arrow
|
|
2823 ("mu" " x " "\264" . t) ; multiply
|
|
2824 ("+-" "+/-" "\261" . t) ; plus-minus
|
|
2825 ("bv" "|") ; bold vertical
|
|
2826
|
|
2827 ;; groff etc. extensions:
|
|
2828 ("lq" "\"")
|
|
2829 ("rq" "\"")
|
|
2830 ("aq" "'")
|
|
2831 ("ha" "^")
|
|
2832 ("ti" "~")
|
|
2833 )
|
|
2834 "Alist of special character codes with ASCII and extended-font equivalents.
|
|
2835 Each alist elements has the form
|
|
2836 (input-string ascii-string extended-font-string . use-symbol-font)
|
|
2837 where
|
|
2838 * `\\(input-string' is the ?roff encoding,
|
|
2839 * `ascii-string' is the (multi-character) ASCII simulation,
|
|
2840 * `extended-font-string' is the single-character string representing
|
|
2841 the character position in the extended 256-character font, and
|
|
2842 * `use-symbol-font' is t to indicate use of the symbol font or nil,
|
|
2843 i.e. omitted, to indicate use of the default font.
|
|
2844 Any element may be nil. Avoid control character codes (0 to \\37, \\180
|
|
2845 to \\237) in `extended-font-string' for now, since they can be
|
|
2846 displayed only with a modified display table.
|
|
2847
|
29074
|
2848 Use the WoMan command `woman-display-extended-fonts' or a character
|
28832
|
2849 map accessory to help construct this alist.")
|
|
2850
|
29074
|
2851 (defsubst woman-replace-match (newtext &optional face)
|
|
2852 "Replace text matched by last search with NEWTEXT and return t.
|
|
2853 Set NEWTEXT in face FACE if specified."
|
|
2854 (woman-delete-match 0)
|
|
2855 (insert-before-markers newtext)
|
|
2856 (if face (put-text-property (1- (point)) (point)
|
|
2857 'face 'woman-symbol-face))
|
|
2858 t)
|
|
2859
|
28832
|
2860 (defun woman-special-characters (to)
|
29074
|
2861 "Process special character escapes \(xx up to buffer position TO.
|
|
2862 \(This must be done AFTER translation, which may use special characters.)"
|
28832
|
2863 (while (re-search-forward "\\\\(\\(..\\)" to t)
|
|
2864 (let ((replacement
|
|
2865 (assoc (match-string-no-properties 1) woman-special-characters)))
|
|
2866 (if (and
|
|
2867 replacement
|
29074
|
2868 (cond ((and (cddr replacement)
|
|
2869 (if (nthcdr 3 replacement)
|
|
2870 ;; Need symbol font:
|
|
2871 (if woman-use-symbol-font
|
|
2872 (woman-replace-match (nth 2 replacement)
|
|
2873 'woman-symbol-face))
|
|
2874 ;; Need extended font:
|
|
2875 (if woman-use-extended-font
|
|
2876 (woman-replace-match (nth 2 replacement))))))
|
28832
|
2877 ((cadr replacement) ; Use ASCII simulation
|
29074
|
2878 (woman-replace-match (cadr replacement)))))
|
28832
|
2879 ()
|
|
2880 (WoMan-warn "Special character \\(%s not interpolated!"
|
|
2881 (match-string-no-properties 1))
|
|
2882 (if woman-ignore (woman-delete-match 0))))
|
|
2883 ))
|
|
2884
|
|
2885 (defun woman-display-extended-fonts ()
|
29074
|
2886 "Display table of glyphs of graphic characters and their octal codes.
|
|
2887 All the octal codes in the ranges [32..127] and [160..255] are displayed
|
28832
|
2888 together with the corresponding glyphs from the default and symbol fonts.
|
29074
|
2889 Useful for constructing the alist variable `woman-special-characters'."
|
28832
|
2890 (interactive)
|
|
2891 (with-output-to-temp-buffer "*WoMan Extended Font Map*"
|
|
2892 (save-excursion
|
|
2893 (set-buffer standard-output)
|
|
2894 (let ((i 32))
|
|
2895 (while (< i 256)
|
|
2896 (insert (format "\\%03o " i) (string i) " " (string i))
|
|
2897 (put-text-property (1- (point)) (point)
|
|
2898 'face 'woman-symbol-face)
|
|
2899 (insert " ")
|
|
2900 (setq i (1+ i))
|
|
2901 (when (= i 128) (setq i 160) (insert "\n"))
|
|
2902 (if (zerop (% i 8)) (insert "\n")))
|
|
2903 ))
|
|
2904 (print-help-return-message)))
|
|
2905
|
|
2906
|
|
2907 ;;; Formatting macros that do not cause a break:
|
|
2908
|
|
2909 (defvar request) ; Bound locally by woman1-roff-buffer
|
|
2910 (defvar unquote) ; Bound locally by woman1-roff-buffer
|
|
2911
|
|
2912 (defun woman-unquote (to)
|
|
2913 "Delete any double-quote characters between point and TO.
|
|
2914 Leave point at TO (which should be a marker)."
|
|
2915 (let (in-quote)
|
|
2916 (while (search-forward "\"" to 1)
|
|
2917 (if (and in-quote (looking-at "\""))
|
|
2918 ;; Repeated double-quote represents single double-quote
|
|
2919 (delete-char 1)
|
|
2920 (if (or in-quote (looking-at ".*\"")) ; paired
|
|
2921 (delete-char -1))
|
|
2922 (setq in-quote (not in-quote))
|
|
2923 ))
|
|
2924 (if in-quote
|
|
2925 (WoMan-warn "Unpaired \" in .%s arguments." request))
|
|
2926 ))
|
|
2927
|
|
2928 (defsubst woman-unquote-args ()
|
|
2929 "Delete any double-quote characters up to the end of the line."
|
|
2930 (woman-unquote (save-excursion (end-of-line) (point-marker))))
|
|
2931
|
|
2932 (defun woman1-roff-buffer ()
|
|
2933 "Process non-breaking requests."
|
|
2934 (let ((case-fold-search t)
|
|
2935 request fn unquote)
|
|
2936 (while
|
|
2937 ;; Find next control line:
|
|
2938 (re-search-forward woman-request-regexp nil t)
|
|
2939 (cond
|
|
2940 ;; Construct woman function to call:
|
|
2941 ((setq fn (intern-soft
|
|
2942 (concat "woman1-"
|
|
2943 (setq request (match-string 1)))))
|
|
2944 (if (get fn 'notfont) ; not a font-change request
|
|
2945 (funcall fn)
|
|
2946 ;; Delete request or macro name:
|
|
2947 (woman-delete-match 0)
|
|
2948 ;; If no args then apply to next line else unquote args
|
|
2949 ;; (unquote is used by called function):
|
|
2950 (setq unquote (not (eolp)))
|
|
2951 (if (eolp) (delete-char 1))
|
|
2952 ; ;; Hide leading control character in unquoted argument:
|
|
2953 ; (cond ((memq (following-char) '(?. ?'))
|
|
2954 ; (insert "\\&")
|
|
2955 ; (beginning-of-line)))
|
|
2956 ;; Call the appropriate function:
|
|
2957 (funcall fn)
|
|
2958 ;; Hide leading control character in quoted argument (only):
|
|
2959 (if (and unquote (memq (following-char) '(?. ?')))
|
|
2960 (insert "\\&"))
|
|
2961 )
|
|
2962 )))))
|
|
2963
|
|
2964 ;;; Font-changing macros:
|
|
2965
|
|
2966 (defun woman1-B ()
|
|
2967 ".B -- Set words of current line in bold font."
|
|
2968 (woman1-B-or-I ".ft B\n"))
|
|
2969
|
|
2970 (defun woman1-I ()
|
|
2971 ".I -- Set words of current line in italic font."
|
|
2972 (woman1-B-or-I ".ft I\n"))
|
|
2973
|
|
2974 (defun woman1-B-or-I (B-or-I)
|
|
2975 ".B/I -- Set words of current line in bold/italic font.
|
29074
|
2976 B-OR-I is the appropriate complete control line."
|
28832
|
2977 ;; Should NOT concatenate the arguments!
|
|
2978 (insert B-or-I) ; because it might be a control line
|
|
2979 ;; Return to bol to process .SM/.B, .B/.if etc.
|
|
2980 ;; or start of first arg to hide leading control char.
|
|
2981 (save-excursion
|
|
2982 (if unquote
|
|
2983 (woman-unquote-args)
|
|
2984 (while (looking-at "^[.']") (forward-line))
|
|
2985 (end-of-line)
|
|
2986 (delete-horizontal-space))
|
|
2987 (insert "\\fR")))
|
|
2988
|
|
2989 (defun woman1-SM ()
|
|
2990 ".SM -- Set the current line in small font, i.e. IGNORE!"
|
|
2991 nil)
|
|
2992
|
|
2993 (defalias 'woman1-SB 'woman1-B)
|
|
2994 ;; .SB -- Set the current line in small bold font, i.e. just embolden!
|
29074
|
2995 ;; (This is what /usr/local/share/groff/tmac/tmac.an does. The
|
28832
|
2996 ;; Linux man.7 is wrong about this!)
|
|
2997
|
|
2998 (defun woman1-BI ()
|
|
2999 ".BI -- Join words of current line alternating bold and italic fonts."
|
|
3000 (woman1-alt-fonts (list "\\fB" "\\fI")))
|
|
3001
|
|
3002 (defun woman1-BR ()
|
|
3003 ".BR -- Join words of current line alternating bold and Roman fonts."
|
|
3004 (woman1-alt-fonts (list "\\fB" "\\fR")))
|
|
3005
|
|
3006 (defun woman1-IB ()
|
|
3007 ".IB -- Join words of current line alternating italic and bold fonts."
|
|
3008 (woman1-alt-fonts (list "\\fI" "\\fB")))
|
|
3009
|
|
3010 (defun woman1-IR ()
|
|
3011 ".IR -- Join words of current line alternating italic and Roman fonts."
|
|
3012 (woman1-alt-fonts (list "\\fI" "\\fR")))
|
|
3013
|
|
3014 (defun woman1-RB ()
|
|
3015 ".RB -- Join words of current line alternating Roman and bold fonts."
|
|
3016 (woman1-alt-fonts (list "\\fR" "\\fB")))
|
|
3017
|
|
3018 (defun woman1-RI ()
|
|
3019 ".RI -- Join words of current line alternating Roman and italic fonts."
|
|
3020 (woman1-alt-fonts (list "\\fR" "\\fI")))
|
|
3021
|
|
3022 (defun woman1-alt-fonts (fonts)
|
|
3023 "Join words using alternating fonts in FONTS, which MUST be a dynamic list."
|
|
3024 (nconc fonts fonts) ; circular list!
|
|
3025 (insert (car fonts))
|
|
3026 ;; Return to start of first arg to hide leading control char:
|
|
3027 (save-excursion
|
|
3028 (setq fonts (cdr fonts))
|
|
3029 (woman-forward-arg unquote 'concat) ; unquote is bound above
|
|
3030 (while (not (eolp))
|
|
3031 (insert (car fonts))
|
|
3032 (setq fonts (cdr fonts))
|
|
3033 (woman-forward-arg unquote 'concat)) ; unquote is bound above
|
|
3034 (insert "\\fR")
|
|
3035 ))
|
|
3036
|
|
3037 (defun woman-forward-arg (&optional unquote concat)
|
29074
|
3038 "Move forward over one ?roff argument, optionally unquoting and/or joining.
|
|
3039 If optional arg UNQUOTE is non-nil then delete any argument quotes.
|
|
3040 If optional arg CONCAT is non-nil then join arguments."
|
28832
|
3041 (if (eq (following-char) ?\")
|
|
3042 (progn
|
|
3043 (if unquote (delete-char 1) (forward-char))
|
|
3044 (re-search-forward "\"\\|$")
|
|
3045 ;; Repeated double-quote represents single double-quote
|
|
3046 (while (eq (following-char) ?\") ; paired
|
|
3047 (if unquote (delete-char 1) (forward-char))
|
|
3048 (re-search-forward "\"\\|$"))
|
|
3049 (if (eq (preceding-char) ?\")
|
|
3050 (if unquote (delete-backward-char 1))
|
|
3051 (WoMan-warn "Unpaired \" in .%s arguments." request)
|
|
3052 ))
|
|
3053 ;; (re-search-forward "[^\\\n] \\|$") ; inconsistent
|
|
3054 (skip-syntax-forward "^ "))
|
|
3055 (cond ((null concat) (skip-chars-forward " \t")) ; don't skip eol!
|
|
3056 ((eq concat 'noskip)) ; do not skip following whitespace
|
|
3057 (t (woman-delete-following-space)))
|
|
3058 )
|
|
3059
|
|
3060
|
29074
|
3061 ;; The following requests are not explicit font-change requests and
|
|
3062 ;; so are flagged `notfont' to turn off automatic request deletion
|
|
3063 ;; and further processing.
|
28832
|
3064
|
|
3065 (put 'woman1-TP 'notfont t)
|
|
3066 (defun woman1-TP ()
|
|
3067 ".TP -- After tag line, reset font to Roman for paragraph body."
|
|
3068 ;; Same for .IP, but forward only 1 line?
|
|
3069 (save-excursion
|
|
3070 ;; May be an `irrelevant' control line in the way, so ...
|
|
3071 (forward-line)
|
|
3072 (forward-line (if (looking-at "\\.\\S-+[ \t]*$") 2 1))
|
|
3073 ;; May be looking at control line, so ...
|
|
3074 (insert ".ft R\n")))
|
|
3075
|
|
3076 (put 'woman1-ul 'notfont t)
|
|
3077 (defun woman1-ul ()
|
|
3078 ".ul N -- Underline (italicize) the next N input lines, default N = 1."
|
|
3079 (let ((N (if (eolp) 1 (woman-parse-numeric-arg)))) ; woman-get-numeric-arg ?
|
|
3080 (woman-delete-whole-line)
|
|
3081 (insert ".ft I\n")
|
|
3082 (forward-line N)
|
|
3083 (insert ".ft R\n")
|
|
3084 ))
|
|
3085
|
29074
|
3086 ;;; Other non-breaking requests:
|
28832
|
3087
|
|
3088 ;; Hyphenation
|
|
3089 ;; Warnings commented out.
|
|
3090
|
|
3091 (put 'woman1-nh 'notfont t)
|
|
3092 (defun woman1-nh ()
|
|
3093 ".nh -- No hyphenation, i.e. IGNORE!"
|
|
3094 ;; Must be handled here to avoid breaking!
|
|
3095 ;; (WoMan-log-1 ".nh request ignored -- hyphenation not supported!")
|
|
3096 (woman-delete-whole-line))
|
|
3097
|
|
3098 (put 'woman1-hy 'notfont t)
|
|
3099 (defun woman1-hy ()
|
|
3100 ".hy N -- Set hyphenation mode to N, i.e. IGNORE!"
|
|
3101 ;; (WoMan-log-1 ".hy request ignored -- hyphenation not supported!")
|
|
3102 (woman-delete-whole-line))
|
|
3103
|
|
3104 (put 'woman1-hc 'notfont t)
|
|
3105 (defun woman1-hc ()
|
|
3106 ".hc c -- Set hyphenation character to c, i.e. delete it!"
|
|
3107 (let ((c (char-to-string (following-char))))
|
|
3108 ;; (WoMan-log
|
|
3109 ;; "Hyphenation character %s deleted -- hyphenation not supported!" c)
|
|
3110 (woman-delete-whole-line)
|
|
3111 (setq c (concat "\\(" c "\\)\\|^[.'][ \t]*hc"))
|
|
3112 (save-excursion
|
|
3113 (while (and (re-search-forward c nil t)
|
|
3114 (match-string 1))
|
|
3115 (delete-char -1)))
|
|
3116 ))
|
|
3117
|
|
3118 (put 'woman1-hw 'notfont t)
|
|
3119 (defun woman1-hw ()
|
|
3120 ".hw words -- Set hyphenation exception words, i.e. IGNORE!"
|
|
3121 ;; (WoMan-log-1 ".hw request ignored -- hyphenation not supported!")
|
|
3122 (woman-delete-whole-line))
|
|
3123
|
29074
|
3124 ;;; Other non-breaking requests correctly ignored by nroff:
|
28832
|
3125
|
|
3126 (put 'woman1-ps 'notfont t)
|
|
3127 (defalias 'woman1-ps 'woman-delete-whole-line)
|
|
3128 ;; .ps -- Point size -- IGNORE!
|
|
3129
|
|
3130 (put 'woman1-ss 'notfont t)
|
|
3131 (defalias 'woman1-ss 'woman-delete-whole-line)
|
|
3132 ;; .ss -- Space-character size -- IGNORE!
|
|
3133
|
|
3134 (put 'woman1-cs 'notfont t)
|
|
3135 (defalias 'woman1-cs 'woman-delete-whole-line)
|
|
3136 ;; .cs -- Constant character space (width) mode -- IGNORE!
|
|
3137
|
|
3138 (put 'woman1-ne 'notfont t)
|
|
3139 (defalias 'woman1-ne 'woman-delete-whole-line)
|
|
3140 ;; .ne -- Need vertical space -- IGNORE!
|
|
3141
|
|
3142 (put 'woman1-vs 'notfont t)
|
|
3143 (defalias 'woman1-vs 'woman-delete-whole-line)
|
|
3144 ;; .vs -- Vertical base line spacing -- IGNORE!
|
|
3145
|
|
3146 (put 'woman1-bd 'notfont t)
|
|
3147 (defalias 'woman1-bd 'woman-delete-whole-line)
|
|
3148 ;; .bd -- Embolden font -- IGNORE!
|
|
3149
|
29074
|
3150 ;;; Non-breaking SunOS-specific macros:
|
28832
|
3151
|
|
3152 (defun woman1-TX ()
|
|
3153 ".TX t p -- Resolve SunOS abbrev t and join to p (usually punctuation)."
|
|
3154 (insert "SunOS ")
|
|
3155 (woman-forward-arg 'unquote 'concat))
|
|
3156
|
|
3157 (put 'woman1-IX 'notfont t)
|
|
3158 (defalias 'woman1-IX 'woman-delete-whole-line)
|
|
3159 ;; .IX -- Index macro, for Sun internal use -- IGNORE!
|
|
3160
|
|
3161
|
|
3162 ;;; Direct font selection:
|
|
3163
|
|
3164 (defconst woman-font-alist
|
|
3165 '(("R" . default)
|
|
3166 ("I" . woman-italic-face)
|
|
3167 ("B" . woman-bold-face)
|
|
3168 ("P" . previous)
|
|
3169 ("1" . default)
|
|
3170 ("2" . woman-italic-face)
|
|
3171 ("3" . woman-bold-face) ; used in bash.1
|
|
3172 )
|
|
3173 "Alist of ?roff font indicators and woman font variables and names.")
|
|
3174
|
|
3175 (defun woman-change-fonts ()
|
|
3176 "Process font changes."
|
|
3177 ;; ***** NEEDS REVISING IF IT WORKS OK *****
|
|
3178 ;; Paragraph .LP/PP/HP/IP/TP and font .B/.BI etc. macros reset font.
|
|
3179 ;; Should .SH/.SS reset font?
|
|
3180 ;; Font size setting macros (?) should reset font.
|
|
3181 (let ((woman-font-alist woman-font-alist) ; for local updating
|
|
3182 (previous-pos (point))
|
|
3183 (previous-font 'default)
|
|
3184 (current-font 'default))
|
|
3185 (while
|
|
3186 ;; Find font requests, paragraph macros and font escapes:
|
|
3187 (re-search-forward
|
|
3188 "^[.'][ \t]*\\(\\(\\ft\\)\\|\\(.P\\)\\)\\|\\(\\\\f\\)" nil 1)
|
|
3189 (let (font beg notfont)
|
|
3190 ;; Match font indicator and leave point at end of sequence:
|
|
3191 (cond ((match-string 2)
|
|
3192 ;; .ft request found
|
|
3193 (setq beg (match-beginning 0))
|
|
3194 (skip-chars-forward " \t")
|
|
3195 (if (eolp) ; default is previous font
|
|
3196 (setq font previous-font)
|
|
3197 (looking-at "[^ \t\n]+"))
|
|
3198 (forward-line)) ; end of control line and \n
|
|
3199 ((match-string 3)
|
|
3200 ;; Macro that resets font found
|
|
3201 (setq font 'default))
|
|
3202 ((match-string 4)
|
|
3203 ;; \f escape found
|
|
3204 (setq beg (match-beginning 0))
|
|
3205 (cond ((= (following-char) ?\( )
|
|
3206 (forward-char)
|
|
3207 (re-search-forward ".."))
|
|
3208 (t (re-search-forward ".")))
|
|
3209 )
|
|
3210 (t (setq notfont t)))
|
|
3211 (if notfont
|
|
3212 ()
|
|
3213 ;; Get font name:
|
|
3214 (or font
|
|
3215 (let ((fontstring (match-string 0)))
|
|
3216 (setq font (assoc fontstring woman-font-alist)
|
|
3217 ;; NB: woman-font-alist contains VARIABLE NAMES.
|
|
3218 font (if font
|
|
3219 (cdr font)
|
|
3220 (WoMan-warn "Unknown font %s." fontstring)
|
|
3221 ;; Output this message once only per call ...
|
|
3222 (setq woman-font-alist
|
|
3223 (cons (cons fontstring 'woman-unknown-face)
|
|
3224 woman-font-alist))
|
|
3225 'woman-unknown-face)
|
|
3226 )))
|
|
3227 ;; Delete font control line or escape sequence:
|
|
3228 (cond (beg (delete-region beg (point))
|
|
3229 (if (eq font 'previous) (setq font previous-font))))
|
|
3230 (woman-set-face previous-pos (point) current-font)
|
|
3231 (if beg
|
|
3232 ;; Explicit font control
|
|
3233 (setq previous-pos (point)
|
|
3234 previous-font current-font)
|
|
3235 ;; Macro that resets font
|
|
3236 ;; (forward-line) ; DOES NOT WORK! but unnecessary?
|
|
3237 ;; Must process font changes in any paragraph tag!
|
|
3238 (setq previous-pos (point)
|
|
3239 previous-font 'default))
|
|
3240 (setq current-font font)
|
|
3241 )))
|
|
3242 ;; Set font after last request up to eob:
|
|
3243 (woman-set-face previous-pos (point) current-font)
|
|
3244 ))
|
|
3245
|
|
3246 (defun woman-set-face (from to face)
|
|
3247 "Set the face of the text from FROM to TO to face FACE.
|
|
3248 Ignore the default face and underline only word characters."
|
|
3249 (or (eq face 'default) ; ignore
|
|
3250 (not woman-fontify)
|
|
3251 (if (face-underline-p face)
|
|
3252 (save-excursion
|
|
3253 (let ((face-no-ul (intern (concat (symbol-name face) "-no-ul"))))
|
|
3254 (goto-char from)
|
|
3255 (while (< (point) to)
|
|
3256 (skip-syntax-forward "w" to)
|
|
3257 (put-text-property from (point) 'face face)
|
|
3258 (setq from (point))
|
|
3259 (skip-syntax-forward "^w" to)
|
|
3260 (put-text-property from (point) 'face face-no-ul)
|
|
3261 (setq from (point))
|
|
3262 )))
|
|
3263 (put-text-property from to 'face face))
|
|
3264 ))
|
|
3265
|
|
3266
|
|
3267 ;;; Output translation:
|
|
3268
|
|
3269 (defvar translations nil) ; Also bound locally by woman2-roff-buffer
|
|
3270 ;; A list of the form (\"[ace]\" (a . b) (c . d) (e . ?\ )) or nil.
|
|
3271
|
|
3272 (defun woman-get-next-char ()
|
|
3273 "Return and delete next char in buffer, including special chars."
|
|
3274 (if ;;(looking-at "\\\\(\\(..\\)")
|
|
3275 ;; Match special \(xx and strings \*x, \*(xx:
|
|
3276 (looking-at "\\\\\\((..\\|\\*\\((..\\|.\\)\\)")
|
|
3277 (prog1 (match-string 0)
|
|
3278 (woman-delete-match 0))
|
|
3279 (prog1 (char-to-string (following-char))
|
|
3280 (delete-char 1))))
|
|
3281
|
|
3282 (defun woman2-tr (to)
|
|
3283 ".tr abcde -- Translate a -> b, c -> d, ..., e -> space.
|
29074
|
3284 Format paragraphs upto TO. Supports special chars.
|
|
3285 \(Breaks, but should not.)"
|
28832
|
3286 ;; This should be an update, but consing onto the front of the alist
|
|
3287 ;; has the same effect and match duplicates should not matter.
|
|
3288 ;; Initialize translation data structures:
|
|
3289 (let ((matches (car translations))
|
|
3290 (alist (cdr translations))
|
|
3291 a b)
|
|
3292 ;; `matches' must be a string:
|
|
3293 (setq matches
|
|
3294 (concat (if matches (substring matches 1 -1)) "]"))
|
|
3295 ;; Process .tr arguments:
|
|
3296 (while (not (eolp)) ; (looking-at "[ \t]*$") ???
|
|
3297 (setq a (woman-get-next-char))
|
|
3298 (if (eolp)
|
|
3299 (setq b " ")
|
|
3300 (setq b (woman-get-next-char)))
|
|
3301 (setq matches
|
|
3302 (if (= (length a) 1)
|
|
3303 (concat a matches)
|
|
3304 (concat matches "\\|\\" a))
|
|
3305 alist (cons (cons a b) alist)))
|
|
3306 (delete-char 1) ; no blank line
|
|
3307 ;; Rebuild translations list:
|
|
3308 (setq matches
|
|
3309 (if (= (string-to-char matches) ?\])
|
|
3310 (substring matches 3)
|
|
3311 (concat "[" matches))
|
|
3312 translations (cons matches alist))
|
|
3313 ;; Format any following text:
|
|
3314 (woman2-format-paragraphs to)
|
|
3315 ))
|
|
3316
|
|
3317 (defsubst woman-translate (to)
|
|
3318 "Translate up to marker TO. Do this last of all transformations."
|
|
3319 (if translations
|
|
3320 (let ((matches (car translations))
|
|
3321 (alist (cdr translations)))
|
|
3322 (while (re-search-forward matches to t)
|
|
3323 ;; Done like this to retain text properties and
|
|
3324 ;; support translation of special characters:
|
|
3325 (insert-before-markers-and-inherit
|
|
3326 (cdr (assoc
|
|
3327 (buffer-substring-no-properties
|
|
3328 (match-beginning 0) (match-end 0))
|
|
3329 alist)))
|
|
3330 (woman-delete-match 0))
|
|
3331 )))
|
|
3332
|
|
3333
|
|
3334 ;;; Registers:
|
|
3335
|
|
3336 (defvar woman-registers ; these are all read-only
|
|
3337 '((".H" 24) (".V" 48) ; resolution in basic units
|
|
3338 (".g" 0) ; not groff
|
|
3339 ;; (Iff emulating groff need to implement groff italic correction
|
|
3340 ;; \/, e.g. for pic.1)
|
|
3341 (".i" left-margin) ; current indent
|
|
3342 (".j" woman-adjust) ; current adjustment
|
|
3343 (".l" fill-column) ; current line length
|
|
3344 (".s" 12) ; current point size
|
|
3345 (".u" (if woman-nofill 0 1)) ; 1/0 in fill/nofill mode
|
|
3346 (".v" 48) ; current vertical line spacing
|
|
3347 )
|
|
3348 "Register alist: the key is the register name as a string.
|
|
3349 Each element has the form (KEY VALUE . INC) -- inc may be nil.
|
|
3350 Also bound locally in `woman2-roff-buffer'.")
|
|
3351
|
|
3352 (defun woman-mark-horizonal-position ()
|
|
3353 "\\kx -- Store current horizontal position in INPUT LINE in register x."
|
|
3354 (while (re-search-forward "\\\\k\\(.\\)" nil t)
|
|
3355 (goto-char (match-beginning 0))
|
|
3356 (setq woman-registers
|
|
3357 (cons (list (match-string 1) (current-column))
|
|
3358 woman-registers))
|
|
3359 (woman-delete-match 0)))
|
|
3360
|
|
3361 (defsubst woman2-process-escapes-to-eol (&optional numeric)
|
|
3362 "Process remaining escape sequences up to eol.
|
|
3363 Handle numeric arguments specially if optional argument NUMERIC is non-nil."
|
|
3364 (woman2-process-escapes
|
|
3365 (save-excursion (end-of-line) (point-marker))
|
|
3366 numeric))
|
|
3367
|
|
3368 (defun woman2-nr (to)
|
29074
|
3369 ".nr R +/-N M -- Assign +/-N (wrt to previous value, if any) to register R.
|
28832
|
3370 The increment for auto-incrementing is set to M.
|
29074
|
3371 Format paragraphs upto TO. (Breaks, but should not!)"
|
28832
|
3372 (let* ((name (buffer-substring
|
|
3373 (point)
|
|
3374 (progn (skip-syntax-forward "^ ") (point))))
|
|
3375 (pm (progn ; increment
|
|
3376 (skip-chars-forward " \t")
|
|
3377 (when (memq (char-after) '(?+ ?-))
|
|
3378 (forward-char) (char-before))))
|
|
3379 (value (if (eolp) ; no value
|
|
3380 nil ; to be interpreted as zero
|
|
3381 (woman2-process-escapes-to-eol 'numeric)
|
|
3382 (woman-parse-numeric-arg)))
|
|
3383 (inc (progn ; auto-increment
|
|
3384 (skip-chars-forward " \t")
|
|
3385 (if (eolp) ; no value
|
|
3386 nil ; to be interpreted as zero ???
|
|
3387 (woman-parse-numeric-arg))))
|
|
3388 (oldvalue (assoc name woman-registers)))
|
|
3389 (when oldvalue
|
|
3390 (setq oldvalue (cdr oldvalue)) ; (value . inc)
|
|
3391 (unless inc (setq inc (cdr oldvalue))))
|
|
3392 (cond ((null value)
|
|
3393 (setq value 0) ; correct?
|
|
3394 (WoMan-warn "nr %s -- null value assigned as zero!" name))
|
|
3395 ((symbolp value)
|
|
3396 (setq value (list 'quote value))))
|
|
3397 (if pm ; increment old value
|
|
3398 (setq oldvalue (if oldvalue (car oldvalue) 0)
|
|
3399 value (if (eq pm ?+)
|
|
3400 (+ oldvalue value)
|
|
3401 (- oldvalue value))))
|
|
3402 (setq woman-registers
|
|
3403 (cons (cons name (cons value inc)) woman-registers))
|
|
3404 (woman-delete-whole-line)
|
|
3405 (woman2-format-paragraphs to)))
|
|
3406
|
|
3407
|
|
3408 ;;; Numeric (and "non-text") request arguments:
|
|
3409
|
|
3410 (defsubst woman-get-numeric-arg ()
|
29074
|
3411 "Get the value of a numeric argument at or after point.
|
28832
|
3412 The argument can include the width function and scale indicators.
|
29074
|
3413 Assumes 10 characters per inch. Does not move point."
|
28832
|
3414 (woman2-process-escapes-to-eol 'numeric)
|
|
3415 (save-excursion (woman-parse-numeric-arg)))
|
|
3416
|
|
3417 (defun woman-parse-numeric-arg ()
|
|
3418 "Get the value of a numeric expression at or after point.
|
|
3419 Unlike `woman-get-numeric-arg', leaves point after the argument.
|
|
3420 The expression may be an argument in quotes."
|
|
3421 (if (= (following-char) ?\") (forward-char))
|
|
3422 ;; Allow leading +/-:
|
|
3423 (let ((value (if (looking-at "[+-]") 0 (woman-parse-numeric-value)))
|
|
3424 op)
|
|
3425 (while (cond
|
|
3426 ((looking-at "[+-/*%]") ; arithmetic operators
|
|
3427 (forward-char)
|
|
3428 (setq op (intern-soft (match-string 0)))
|
|
3429 (setq value (funcall op value (woman-parse-numeric-value))))
|
|
3430 ((looking-at "[<=>]=?") ; relational operators
|
|
3431 (goto-char (match-end 0))
|
|
3432 (setq op (or (intern-soft (match-string 0))
|
|
3433 (intern-soft "=")))
|
|
3434 (setq value (if (funcall op value (woman-parse-numeric-value))
|
|
3435 1 0)))
|
|
3436 ((memq (setq op (following-char)) '(?& ?:)) ; Boolean and / or
|
|
3437 (forward-char)
|
|
3438 (setq value
|
|
3439 ;; and / or are special forms, not functions, in ELisp
|
|
3440 (if (eq op ?&)
|
|
3441 ;; and
|
|
3442 (if (> value 0)
|
|
3443 (if (> (woman-parse-numeric-value) 0) 1 0)
|
|
3444 ;; skip second operand
|
|
3445 (prog1 0 (woman-parse-numeric-value)))
|
|
3446 ;; or
|
|
3447 (if (> value 0)
|
|
3448 ;; skip second operand
|
|
3449 (prog1 1 (woman-parse-numeric-value))
|
|
3450 (if (> (woman-parse-numeric-value) 0) 1 0))
|
|
3451 )))
|
|
3452 ))
|
|
3453 ; (if (looking-at "[ \t\nRC\)\"]") ; R, C are tab types
|
|
3454 ; ()
|
|
3455 ; (WoMan-warn "Unimplemented numerical operator `%c' in %s"
|
|
3456 ; (following-char)
|
|
3457 ; (buffer-substring
|
|
3458 ; (save-excursion (beginning-of-line) (point))
|
|
3459 ; (save-excursion (end-of-line) (point))))
|
|
3460 ; (skip-syntax-forward "^ "))
|
|
3461 value
|
|
3462 ))
|
|
3463
|
|
3464 (defun woman-parse-numeric-value ()
|
|
3465 "Get a single numeric value at or after point.
|
29074
|
3466 The value can be a number register or width function (which assumes 10
|
|
3467 characters per inch) and can include scale indicators. It may be an
|
|
3468 expression in parentheses. Leaves point after the value."
|
28832
|
3469 ;; Must replace every \' by some different single character first
|
|
3470 ;; before calling this function by calling
|
|
3471 ;; (woman2-process-escapes-to-eol 'numeric)
|
|
3472 (if (eq (following-char) ?\()
|
|
3473 ;; Treat parenthesized expression as a single value.
|
|
3474 (let (n)
|
|
3475 (forward-char)
|
|
3476 (setq n (woman-parse-numeric-arg))
|
|
3477 (skip-syntax-forward " ")
|
|
3478 (if (eq (following-char) ?\))
|
|
3479 (forward-char)
|
|
3480 (WoMan-warn "Parenthesis confusion in numeric expression!"))
|
|
3481 n)
|
|
3482 (let ((n (cond ((looking-at "[-+]?[.0-9]+") ; single number
|
|
3483 ;; currently needed to set match-end, even though
|
|
3484 ;; string-to-number returns 0 if number not parsed.
|
|
3485 (string-to-number (match-string 0)))
|
|
3486 ((looking-at "\\\\n\\([-+]\\)?\\(\(\\(..\\)\\|\\(.\\)\\)")
|
|
3487 ;; interpolate number register, maybe auto-incremented
|
|
3488 (let* ((pm (match-string-no-properties 1))
|
|
3489 (name (or (match-string-no-properties 3)
|
|
3490 (match-string-no-properties 4)))
|
|
3491 (value (assoc name woman-registers)))
|
|
3492 (if value
|
|
3493 (let (inc)
|
|
3494 (setq value (cdr value) ; (value . inc)
|
|
3495 inc (cdr value)
|
|
3496 ;; eval internal (.X) registers
|
|
3497 ;; stored as lisp variable names:
|
|
3498 value (eval (car value)))
|
|
3499 (if (and pm inc) ; auto-increment
|
|
3500 (setq value
|
|
3501 (funcall (intern-soft pm) value inc)
|
|
3502 woman-registers
|
|
3503 (cons (cons name (cons value inc))
|
|
3504 woman-registers)))
|
|
3505 value)
|
|
3506 (WoMan-warn "Undefined register %s defaulted to 0."
|
|
3507 name)
|
|
3508 0) ; default to zero
|
|
3509 ))
|
|
3510 ((re-search-forward
|
|
3511 ;; Delimiter can be special char escape \(.. or
|
|
3512 ;; single normal char (usually '):
|
|
3513 "\\=\\\\w\\(\\\\(..\\|.\\)" nil t)
|
|
3514 (let ((from (match-end 0))
|
|
3515 (delim (regexp-quote (match-string 1))))
|
|
3516 (if (re-search-forward delim nil t)
|
|
3517 ;; Return width of string:
|
|
3518 (- (match-beginning 0) from)
|
|
3519 (WoMan-warn "Width escape delimiter error!"))))
|
|
3520 )))
|
|
3521 (if (null n)
|
|
3522 ;; ERROR -- should handle this better!
|
|
3523 (progn
|
|
3524 (WoMan-warn "Numeric/register argument error: %s"
|
|
3525 (buffer-substring
|
|
3526 (point)
|
|
3527 (save-excursion (end-of-line) (point))))
|
|
3528 (skip-syntax-forward "^ ")
|
|
3529 0)
|
|
3530 (goto-char (match-end 0))
|
|
3531 ;; Check for scale factor:
|
|
3532 (if
|
|
3533 (cond
|
|
3534 ((looking-at "\\s ") nil) ; stay put!
|
|
3535 ((looking-at "[mnuv]")) ; ignore for now
|
|
3536 ((looking-at "i") (setq n (* n 10))) ; inch
|
|
3537 ((looking-at "c") (setq n (* n 3.9))) ; cm
|
|
3538 ((looking-at "P") (setq n (* n 1.7))) ; Pica
|
|
3539 ((looking-at "p") (setq n (* n 0.14))) ; point
|
|
3540 ;; NB: May be immediately followed by + or -, etc.,
|
|
3541 ;; in which case do nothing and return nil.
|
|
3542 )
|
|
3543 (goto-char (match-end 0)))
|
|
3544 (if (numberp n) (round n) n))
|
|
3545 )))
|
|
3546
|
|
3547
|
|
3548 ;;; VERTICAL FORMATTING -- Formatting macros that cause a break:
|
|
3549
|
29074
|
3550 ;; Vertical spacing philosophy:
|
|
3551 ;; Delete all vertical space as it is encountered. Then insert
|
|
3552 ;; vertical space only before text, as required.
|
28832
|
3553
|
|
3554 (defun woman2-roff-buffer ()
|
|
3555 "Process breaks. Format paragraphs and headings."
|
|
3556 (let ((case-fold-search t)
|
|
3557 (to (make-marker))
|
|
3558 (canonically-space-region
|
|
3559 (symbol-function 'canonically-space-region))
|
|
3560 (insert-and-inherit (symbol-function 'insert-and-inherit))
|
|
3561 (set-text-properties (symbol-function 'set-text-properties))
|
|
3562 (woman-registers woman-registers)
|
|
3563 fn request translations
|
|
3564 tab-stop-list)
|
|
3565 ;; ?roff does not squeeze multiple spaces, but does fill, so...
|
|
3566 (fset 'canonically-space-region 'ignore)
|
|
3567 ;; Try to avoid spaces inheriting underlines from preceding text!
|
|
3568 (fset 'insert-and-inherit (symbol-function 'insert))
|
|
3569 (fset 'set-text-properties 'ignore)
|
|
3570 (unwind-protect
|
|
3571 (while
|
|
3572 ;; Find next control line:
|
|
3573 (re-search-forward woman-request-regexp nil t)
|
|
3574 (cond
|
|
3575 ;; Construct woman function to call:
|
|
3576 ((setq fn (intern-soft
|
|
3577 (concat "woman2-"
|
|
3578 (setq request (match-string 1)))))
|
|
3579 ;; Delete request or macro name:
|
|
3580 (woman-delete-match 0))
|
|
3581 ;; Unrecognised request:
|
|
3582 ((prog1 nil
|
|
3583 ;; (WoMan-warn ".%s request ignored!" request)
|
|
3584 (WoMan-warn-ignored request "ignored!")
|
|
3585 ;; (setq fn 'woman2-LP)
|
|
3586 ;; AVOID LEAVING A BLANK LINE!
|
|
3587 ;; (setq fn 'woman2-format-paragraphs)
|
|
3588 ))
|
|
3589 ;; .LP assumes it is at eol and leaves a (blank) line,
|
|
3590 ;; so leave point at end of line before paragraph:
|
|
3591 ((or (looking-at "[ \t]*$") ; no argument
|
|
3592 woman-ignore) ; ignore all
|
|
3593 ;; (beginning-of-line) (kill-line)
|
|
3594 ;; AVOID LEAVING A BLANK LINE!
|
|
3595 (beginning-of-line) (woman-delete-line 1))
|
|
3596 (t (end-of-line) (insert ?\n))
|
|
3597 )
|
|
3598 (if (not (or fn
|
|
3599 (and (not (memq (following-char) '(?. ?')))
|
|
3600 (setq fn 'woman2-format-paragraphs))))
|
|
3601 ()
|
|
3602 ;; Find next control line:
|
|
3603 (set-marker to (woman-find-next-control-line))
|
|
3604 ;; Call the appropriate function:
|
|
3605 (funcall fn to)))
|
|
3606 (if (not (eobp)) ; This should not happen, but ...
|
|
3607 (woman2-format-paragraphs (point-max-marker) woman-left-margin))
|
|
3608 (fset 'canonically-space-region canonically-space-region)
|
|
3609 (fset 'set-text-properties set-text-properties)
|
|
3610 (fset 'insert-and-inherit insert-and-inherit)
|
|
3611 (set-marker to nil))))
|
|
3612
|
|
3613 (defun woman-find-next-control-line ()
|
|
3614 "Find and return start of next control line."
|
|
3615 ; (let ((to (save-excursion
|
|
3616 ; (re-search-forward "^\\." nil t))))
|
|
3617 ; (if to (1- to) (point-max)))
|
|
3618 (let (to)
|
|
3619 (save-excursion
|
|
3620 ;; Must handle
|
|
3621 ;; ...\c
|
|
3622 ;; .br (and other requests?)
|
|
3623 ;; by deleting both the \c and the following request.
|
|
3624 ;; BEWARE THAT THIS CODE MAY BE UNRELIABLE!!!!!
|
|
3625 (while
|
|
3626 (and
|
|
3627 (setq to (re-search-forward "\\(\\\\c\\)?\n[.']" nil t))
|
|
3628 (match-string 1)
|
|
3629 (looking-at "br"))
|
|
3630 (goto-char (match-beginning 0))
|
|
3631 (woman-delete-line 2)))
|
|
3632 (if to (1- to) (point-max))))
|
|
3633
|
|
3634 (defun woman2-PD (to)
|
|
3635 ".PD d -- Set the interparagraph distance to d.
|
29074
|
3636 Round to whole lines, default 1 line. Format paragraphs upto TO.
|
|
3637 (Breaks, but should not.)"
|
28832
|
3638 ;; .ie \\n[.$] .nr PD (v;\\$1)
|
|
3639 ;; .el .nr PD .4v>?\n[.V]
|
|
3640 (woman-set-interparagraph-distance)
|
|
3641 (woman2-format-paragraphs to))
|
|
3642
|
|
3643 (defun woman-set-interparagraph-distance ()
|
29074
|
3644 "Set the interparagraph distance from a .PD request at point."
|
28832
|
3645 (setq woman-interparagraph-distance
|
|
3646 (if (eolp) 1 (woman-get-numeric-arg)))
|
|
3647 ;; Should allow .PD 0 to set zero line spacing
|
|
3648 (woman-delete-line 1)) ; ignore remaining args
|
|
3649
|
|
3650 (defsubst woman-interparagraph-space ()
|
29074
|
3651 "Set variable `woman-leave-blank-lines' from `woman-interparagraph-distance'."
|
28832
|
3652 ; (if (> woman-interparagraph-distance 0)
|
|
3653 ; (forward-line 1) ; leave 1 blank line
|
|
3654 ; (woman-delete-line 1)) ; do not leave blank line
|
|
3655 (setq woman-leave-blank-lines woman-interparagraph-distance)
|
|
3656 )
|
|
3657
|
|
3658 (defun woman2-TH (to)
|
29074
|
3659 ".TH n c x v m -- Begin a man page. Format paragraphs upto TO.
|
|
3660 n is the name of the page in chapter c\; x is extra commentary\;
|
|
3661 v alters page foot left; m alters page head center.
|
|
3662 \(Should set prevailing indent and tabs to 5.)"
|
28832
|
3663 (woman-forward-arg 'unquote 'concat)
|
|
3664 (insert ?\()
|
|
3665 (woman-forward-arg 'unquote 'concat)
|
|
3666 (insert ?\))
|
|
3667 (let ((start (point)) here)
|
|
3668 (while (not (eolp))
|
|
3669 (cond ((looking-at "\"\"[ \t]")
|
|
3670 (delete-char 2)
|
|
3671 ;; (delete-horizontal-space)
|
|
3672 ))
|
|
3673 (delete-horizontal-space)
|
|
3674 (setq here (point))
|
|
3675 (insert " -- ")
|
|
3676 (woman-forward-arg 'unquote 'concat)
|
|
3677 ;; Delete repeated arguments:
|
|
3678 (if (string-match (buffer-substring here (point))
|
|
3679 (buffer-substring start here))
|
|
3680 (delete-region here (point)))
|
|
3681 ))
|
|
3682 ;; Embolden heading (point is at end of heading):
|
|
3683 (woman-set-face
|
|
3684 (save-excursion (beginning-of-line) (point)) (point) 'woman-bold-face)
|
|
3685 (forward-line)
|
|
3686 (delete-blank-lines)
|
|
3687 (setq woman-left-margin woman-default-indent)
|
|
3688 (setq woman-prevailing-indent woman-default-indent)
|
|
3689 (woman2-format-paragraphs to woman-left-margin))
|
|
3690
|
|
3691 (defun woman2-SH (to)
|
29074
|
3692 ".SH -- Sub-head. Leave blank line and subhead.
|
|
3693 Format paragraphs upto TO. Set prevailing indent to 5."
|
28832
|
3694 (if (eolp) ; If no args then
|
|
3695 (delete-char 1) ; apply to next line
|
|
3696 (woman-unquote-args) ; else unquote to end of heading
|
|
3697 (beginning-of-line))
|
|
3698 (woman2-process-escapes-to-eol)
|
|
3699 (woman-leave-blank-lines woman-interparagraph-distance)
|
|
3700 (setq woman-leave-blank-lines nil)
|
|
3701 ;; Optionally embolden heading (point is at beginning of heading):
|
|
3702 (if woman-bold-headings
|
|
3703 (woman-set-face
|
|
3704 (point) (save-excursion (end-of-line) (point)) 'woman-bold-face))
|
|
3705 (forward-line)
|
|
3706 (setq woman-left-margin woman-default-indent
|
|
3707 woman-nofill nil) ; fill output lines
|
|
3708 (setq woman-prevailing-indent woman-default-indent)
|
|
3709 (woman2-format-paragraphs to woman-left-margin))
|
|
3710
|
|
3711 (defun woman2-SS (to)
|
29074
|
3712 ".SS -- Sub-sub-head. Like .SH but indent heading 3 spaces.
|
|
3713 Format paragraphs upto TO."
|
28832
|
3714 (if (eolp) ; If no args then
|
|
3715 (delete-char 1)) ; apply to next line.
|
|
3716 (insert " ")
|
|
3717 (beginning-of-line)
|
|
3718 (woman2-SH to))
|
|
3719
|
|
3720 (defun woman2-LP (to)
|
29074
|
3721 ".LP,.PP -- Begin paragraph. Set prevailing indent to 5.
|
|
3722 Leave 1 blank line. Format paragraphs upto TO."
|
28832
|
3723 (woman-delete-line 1) ; ignore any arguments
|
|
3724 (woman-interparagraph-space)
|
|
3725 (setq woman-prevailing-indent woman-default-indent)
|
|
3726 (woman2-format-paragraphs to woman-left-margin))
|
|
3727
|
|
3728 (defalias 'woman2-PP 'woman2-LP)
|
|
3729 (defalias 'woman2-P 'woman2-LP)
|
|
3730
|
|
3731 (defun woman2-ns (to)
|
29074
|
3732 ".ns -- Turn on no-space mode. Format paragraphs upto TO."
|
28832
|
3733 ;; Should not cause a break!
|
|
3734 (woman-delete-line 1) ; ignore argument(s)
|
|
3735 (setq woman-nospace t)
|
|
3736 (woman2-format-paragraphs to))
|
|
3737
|
|
3738 (defun woman2-rs (to)
|
29074
|
3739 ".rs -- Turn off no-space mode. Format paragraphs upto TO."
|
28832
|
3740 ;; Should not cause a break!
|
|
3741 (woman-delete-line 1) ; ignore argument(s)
|
|
3742 (setq woman-nospace nil)
|
|
3743 (woman2-format-paragraphs to))
|
|
3744
|
|
3745 (defun woman2-sp (to)
|
29074
|
3746 ".sp N -- If N > 0 then leave 1 blank line. Format paragraphs upto TO."
|
28832
|
3747 (let ((N (if (eolp) 1 (woman-get-numeric-arg))))
|
|
3748 (if (>= N 0)
|
|
3749 (woman-delete-line 1) ; ignore argument(s)
|
|
3750 (setq woman-negative-vertical-space t)
|
|
3751 (insert ".sp ")
|
|
3752 (forward-line))
|
|
3753 (setq woman-leave-blank-lines N)
|
|
3754 (woman2-format-paragraphs to)))
|
|
3755
|
|
3756 (defun woman-negative-vertical-space (from)
|
|
3757 ".sp N with N < 0 => overlap following with preceding lines at FROM."
|
|
3758 ;; Run by woman-decode-region if necessary -- not usually required.
|
|
3759 (WoMan-warn "Negative vertical spacing support is experimental!")
|
|
3760 (goto-char from)
|
|
3761 (while
|
|
3762 ;; Find next control line:
|
|
3763 (re-search-forward "^\\.sp " nil t)
|
|
3764 (let ((N (woman-get-numeric-arg))
|
|
3765 overlap overwritten)
|
|
3766 (woman-delete-whole-line)
|
|
3767 (setq from (point)
|
|
3768 overlap (buffer-substring from
|
|
3769 (progn (forward-line (- N)) (point))))
|
|
3770 (delete-region from (point))
|
|
3771 (forward-line N)
|
|
3772 (let ((imax (length overlap))
|
|
3773 (i 0) c)
|
|
3774 (while (< i imax)
|
|
3775 (setq c (aref overlap i))
|
|
3776 (cond ((eq c ?\n) ; skip
|
|
3777 (forward-line))
|
|
3778 ((eolp) ; extend line
|
|
3779 ;; Insert character INCLUDING TEXT PROPERTIES:
|
|
3780 ;; (insert (substring overlap i (1+ i)))
|
|
3781 (let ((eol (string-match "\n" overlap i)))
|
|
3782 (insert (substring overlap i eol))
|
|
3783 (setq i (or eol imax)))
|
|
3784 )
|
|
3785 ((eq c ?\ ) ; skip
|
|
3786 (forward-char))
|
|
3787 ((eq c ?\t) ; skip
|
|
3788 (if (eq (following-char) ?\t)
|
|
3789 (forward-char) ; both tabs, just skip
|
|
3790 (let ((i woman-tab-width))
|
|
3791 (while (> i 0)
|
|
3792 (if (eolp)
|
|
3793 (insert ?\ ) ; extend line
|
|
3794 (forward-char)) ; skip
|
|
3795 (setq i (1- i)))
|
|
3796 )))
|
|
3797 (t
|
|
3798 (if (or (eq (following-char) ?\ ) ; overwrite OK
|
|
3799 overwritten) ; warning only once per ".sp -"
|
|
3800 ()
|
|
3801 (setq overwritten t)
|
|
3802 (WoMan-warn
|
|
3803 "Character(s) overwritten by negative vertical spacing in line %d"
|
|
3804 (count-lines 1 (point))))
|
|
3805 (delete-char 1) (insert (substring overlap i (1+ i)))))
|
|
3806 (setq i (1+ i))
|
|
3807 ))
|
|
3808 )))
|
|
3809
|
|
3810
|
|
3811 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
3812 ;; The following function should probably do ALL width and number
|
|
3813 ;; register interpolation.
|
|
3814 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
3815
|
|
3816 (defun woman2-process-escapes (to &optional numeric)
|
|
3817 "Process remaining escape sequences up to marker TO, preserving point.
|
|
3818 Optional argument NUMERIC, if non-nil, means the argument is numeric."
|
|
3819 ;; The first two cases below could be merged (maybe)!
|
|
3820 (let ((from (point)))
|
|
3821 ;; Discard zero width filler character used to hide leading dots
|
|
3822 ;; and zero width characters \|, \^:
|
|
3823 (while (re-search-forward "\\\\[&|^]" to t)
|
|
3824 (woman-delete-match 0))
|
|
3825 (goto-char from)
|
|
3826 ;; Interrupt text processing -- CONTINUE current text with the
|
|
3827 ;; next text line (after any control lines, unless processing to
|
|
3828 ;; eol):
|
|
3829 (while (re-search-forward "\\\\c.*\n?" to t)
|
|
3830 (woman-delete-match 0))
|
|
3831 ;; but do not delete the final newline ...
|
|
3832 (if (and (or (eobp) (= (point) to)) (not (bolp)))
|
|
3833 (insert-before-markers ?\n))
|
|
3834 (goto-char from)
|
|
3835 (woman-translate to)
|
|
3836 (goto-char from)
|
|
3837 (woman-special-characters to)
|
|
3838 (goto-char from)
|
|
3839 ;; Printable version of the current escape character, ASSUMED to be `\'
|
|
3840 ;; This must be done LAST of all escape processing!
|
|
3841 ;; Done like this to preserve any text properties of the `\'
|
|
3842 (while (search-forward "\\" to t)
|
|
3843 (let ((c (following-char)))
|
|
3844 (cond ((eq c ?') ; \' -> '
|
|
3845 (delete-char -1)
|
|
3846 (cond (numeric ; except in numeric args, \' -> `
|
|
3847 (delete-char 1)
|
|
3848 (insert ?`))))
|
|
3849 ((eq c ?\( )) ; uninterpreted special character
|
|
3850 ; \(.. -- do nothing
|
|
3851 ((eq c ?t) ; non-interpreted tab \t
|
|
3852 (delete-char 1)
|
|
3853 (delete-char -1)
|
|
3854 (insert "\t"))
|
|
3855 ((and numeric
|
|
3856 (memq c '(?w ?n ?h)))) ; leave \w, \n, \h (?????)
|
|
3857 ((eq c ?l) (woman-horizontal-line))
|
|
3858 (t
|
|
3859 ;; \? -> ? where ? is any remaining character
|
|
3860 (WoMan-warn "Escape ignored: \\%c -> %c" c c)
|
|
3861 (delete-char -1))
|
|
3862 )))
|
|
3863 (goto-char from)
|
|
3864 ;; Process non-default tab settings:
|
|
3865 (cond (tab-stop-list
|
|
3866 (while (search-forward "\t" to t)
|
|
3867 (woman-tab-to-tab-stop))
|
|
3868 (goto-char from)))
|
|
3869
|
|
3870 ;; Must replace \' by something before processing \w, done above.
|
|
3871
|
|
3872 ;; Replace all `\w' and `\n' escapes:
|
|
3873 ;; (This may be a bit too recursive!)
|
|
3874 (while (re-search-forward "\\\\[nw]" to t)
|
|
3875 (let ((from (match-beginning 0)) N)
|
|
3876 (goto-char from)
|
|
3877 (setq N (woman-parse-numeric-value))
|
|
3878 (delete-region from (point))
|
|
3879 ;; Interpolate value:
|
|
3880 (insert-before-markers (number-to-string N))))
|
|
3881 (goto-char from)))
|
|
3882
|
|
3883 (defun woman-horizontal-line ()
|
|
3884 "\\l'Nc' -- Draw a horizontal line of length N using character c, default _."
|
|
3885 (delete-char -1)
|
|
3886 (delete-char 1)
|
|
3887 (looking-at "\\(.\\)\\(.*\\)\\1")
|
|
3888 (let ((to (make-marker)) from N c)
|
|
3889 (set-marker to (match-end 2))
|
|
3890 (delete-char 1)
|
|
3891 (setq from (point)
|
|
3892 N (woman-parse-numeric-arg))
|
|
3893 (setq c (if (< (point) to) (following-char) ?_))
|
|
3894 (delete-region from to)
|
|
3895 (delete-char 1)
|
|
3896 (set-marker to nil)
|
|
3897 (insert (make-string N c))
|
|
3898 ))
|
|
3899
|
|
3900 ;;; 4. Text Filling, Adjusting, and Centering
|
|
3901
|
|
3902 (defun woman2-br (to)
|
29074
|
3903 ".br -- Break. Leave no blank line. Format paragraphs upto TO."
|
28832
|
3904 (woman-delete-line 1) ; ignore any arguments
|
|
3905 (woman2-format-paragraphs to))
|
|
3906
|
|
3907 (defun woman2-fi (to)
|
29074
|
3908 ".fi -- Fill subsequent output lines. Leave no blank line.
|
|
3909 Format paragraphs upto TO."
|
28832
|
3910 (setq woman-nofill nil)
|
|
3911 (woman-delete-line 1) ; ignore any arguments
|
|
3912 ;; Preserve any final blank line in the nofill region:
|
|
3913 (save-excursion
|
|
3914 (forward-line -1)
|
|
3915 (if (looking-at "[ \t]*$") (setq woman-leave-blank-lines 1)))
|
|
3916 (woman2-format-paragraphs to))
|
|
3917
|
|
3918 (defun woman2-nf (to)
|
29074
|
3919 ".nf -- Nofill. Subsequent lines are neither filled nor adjusted.
|
|
3920 Input text lines are copied directly to output lines without regard
|
|
3921 for the current line length. Format paragraphs upto TO."
|
28832
|
3922 (setq woman-nofill t)
|
|
3923 (woman-delete-line 1) ; ignore any arguments
|
|
3924 (woman2-format-paragraphs to))
|
|
3925
|
|
3926 (defun woman2-ad (to)
|
29074
|
3927 ".ad c -- Line adjustment is begun (once fill mode is on).
|
|
3928 Set justification mode to c if specified.
|
|
3929 Format paragraphs upto TO. (Breaks, but should not.)"
|
28832
|
3930 ;; c = l -- left, r -- right, c -- center, b or n -- both,
|
|
3931 ;; absent -- unchanged. Initial mode adj,both.
|
|
3932 (setq woman-adjust
|
|
3933 (cond ((eolp) woman-adjust-previous)
|
|
3934 ((eq (following-char) ?l) woman-adjust-left)
|
|
3935 ((eq (following-char) ?r) woman-adjust-right)
|
|
3936 ((eq (following-char) ?c) woman-adjust-center)
|
|
3937 ((memq (following-char) '(?b ?n)) woman-adjust-both)
|
|
3938 (t (woman-get-numeric-arg))
|
|
3939 )
|
|
3940 woman-justify (nth woman-adjust woman-justify-list))
|
|
3941 (woman-delete-line 1) ; ignore any remaining arguments
|
|
3942 (woman2-format-paragraphs to))
|
|
3943
|
|
3944 (defun woman2-na (to)
|
29074
|
3945 ".na -- No adjusting. Format paragraphs upto TO.
|
28832
|
3946 (Breaks, but should not.)"
|
|
3947 (setq woman-adjust-previous woman-adjust
|
|
3948 woman-justify-previous woman-justify
|
|
3949 woman-adjust woman-adjust-left ; fill but do not adjust
|
|
3950 woman-justify (nth woman-adjust woman-justify-list))
|
|
3951 (woman-delete-line 1) ; ignore any arguments
|
|
3952 (woman2-format-paragraphs to))
|
|
3953
|
|
3954 ;;; The main formatting functions:
|
|
3955
|
|
3956 (defun woman-leave-blank-lines (&optional leave)
|
|
3957 "Delete all blank lines around point.
|
29074
|
3958 Leave one blank line if optional argument LEAVE is non-nil and
|
|
3959 non-zero, or if LEAVE is nil and variable `woman-leave-blank-lines' is
|
|
3960 non-nil and non-zero."
|
28832
|
3961 ;; ***** It may suffice to delete only lines ABOVE point! *****
|
|
3962 ;; NOTE: Function arguments are evaluated left to right
|
|
3963 ;; (*note (elisp)Function Forms::.).
|
|
3964 (delete-region
|
|
3965 (save-excursion
|
|
3966 (if (not (eq (skip-syntax-backward " ") 0))
|
|
3967 (forward-line)) ; forward-char ?
|
|
3968 (point))
|
|
3969 (progn (skip-syntax-forward " ")
|
|
3970 (beginning-of-line)
|
|
3971 (point)))
|
|
3972 (if woman-nospace
|
|
3973 ()
|
|
3974 (if (or (null leave) (eq leave 0))
|
|
3975 ;; output any `pending' vertical space ...
|
|
3976 (setq leave woman-leave-blank-lines))
|
|
3977 (if (and leave (> leave 0)) (insert-before-markers ?\n))
|
|
3978 )
|
|
3979 (setq woman-leave-blank-lines nil)
|
|
3980 )
|
|
3981
|
|
3982 ;; `fill-region-as-paragraph' in `fill.el' appears to be the principal
|
|
3983 ;; text filling function, so that is what I use here.
|
|
3984
|
|
3985 (defvar woman-temp-indent nil)
|
|
3986
|
|
3987 (defun woman2-format-paragraphs (to &optional new-left)
|
29074
|
3988 "Indent, fill and adjust paragraphs upto TO to current left margin.
|
|
3989 If optional arg NEW-LEFT is non-nil then reset current left margin.
|
|
3990 If `woman-nofill' is non-nil then indent without filling or adjusting."
|
28832
|
3991 ;; Blank space should only ever be output before text.
|
|
3992 (if new-left (setq left-margin new-left))
|
|
3993 (if (looking-at "^\\s *$")
|
|
3994 ;; A blank line should leave a space like .sp 1 (p. 14).
|
|
3995 (setq woman-leave-blank-lines 1))
|
|
3996 (skip-syntax-forward " ")
|
|
3997 ;; Successive control lines are sufficiently common to be worth a
|
|
3998 ;; special case (maybe):
|
|
3999 (if (>= (point) to) ; >= as a precaution!
|
|
4000 ()
|
|
4001 ;; (woman-leave-blank-lines)
|
|
4002 (woman-reset-nospace)
|
|
4003 ;; (woman2-process-escapes to) ; 7 October 1999
|
|
4004 (woman2-process-escapes to 'numeric)
|
|
4005 (if woman-nofill
|
|
4006 ;; Indent without filling or adjusting ...
|
|
4007 (progn
|
|
4008 (woman-leave-blank-lines)
|
|
4009 (cond (woman-temp-indent
|
|
4010 (indent-to woman-temp-indent)
|
|
4011 (forward-line)))
|
|
4012 (indent-rigidly (point) to left-margin)
|
|
4013 (woman-horizontal-escapes to)) ; 7 October 1999
|
|
4014 ;; Fill and justify ...
|
|
4015 ;; Blank lines and initial spaces cause a break.
|
|
4016 ; (cond ((and (= (point) to) (not (looking-at ".nf"))) ; Yuk!!!
|
|
4017 ; ;; No text after a request that caused a break, so delete
|
|
4018 ; ;; any spurious blank line left:
|
|
4019 ; (forward-line -1)
|
|
4020 ; (if (looking-at "^\\s *$") (kill-line) (forward-line))))
|
|
4021 (while (< (point) to)
|
|
4022 (woman-leave-blank-lines)
|
|
4023 (let ((from (point)))
|
|
4024 ;; Indent first lin of paragraph:
|
|
4025 (indent-to (or woman-temp-indent left-margin))
|
|
4026 (woman-horizontal-escapes to) ; 7 October 1999
|
|
4027 ;; Find the beginning of the next paragraph:
|
|
4028 (forward-line)
|
|
4029 ; (if (re-search-forward "\\(^\\s *$\\)\\|\\(^\\s +\\)" to 1)
|
|
4030 ; ;; A blank line should leave a space like .sp 1 (p. 14).
|
|
4031 ; (if (eolp)
|
|
4032 ; (progn
|
|
4033 ; (skip-syntax-forward " ")
|
|
4034 ; (setq woman-leave-blank-lines 1))
|
|
4035 ; (setq woman-leave-blank-lines nil)))
|
|
4036 (and (re-search-forward "\\(^\\s *$\\)\\|\\(^\\s +\\)" to 1)
|
|
4037 ;; A blank line should leave a space like .sp 1 (p. 14).
|
|
4038 (eolp)
|
|
4039 (skip-syntax-forward " ")
|
|
4040 (setq woman-leave-blank-lines 1))
|
|
4041 (beginning-of-line)
|
|
4042 ;; If a single short line then just leave it.
|
|
4043 ;; This is necessary to preserve some table layouts.
|
|
4044 ;; PROBABLY NOT NECESSARY WITH SQUEEZE MODIFICATION !!!!!
|
|
4045 (if (or (> (count-lines from (point)) 1)
|
|
4046 (save-excursion
|
|
4047 (backward-char)
|
|
4048 (> (current-column) fill-column)))
|
|
4049 ;; ?roff does not squeeze multiple spaces
|
|
4050 ;; (fill-region-as-paragraph from (point) woman-justify t)
|
|
4051 ;; NOSQUEEZE has no effect if JUSTIFY is full, so
|
|
4052 ;; redefine canonically-space-region, see above.
|
|
4053 (progn
|
|
4054 ;; Needs a re-write of the paragraph formatter to
|
|
4055 ;; avoid this nonsense to handle temporary indents!
|
|
4056 (if (and woman-temp-indent (< woman-temp-indent left-margin))
|
|
4057 (let ((left-margin woman-temp-indent))
|
|
4058 (fill-region-as-paragraph from (point) woman-justify)
|
|
4059 (save-excursion
|
|
4060 (goto-char from)
|
|
4061 (forward-line)
|
|
4062 (setq from (point)))))
|
|
4063 (fill-region-as-paragraph from (point) woman-justify))
|
|
4064 )
|
|
4065 ;; A blank line should leave a space like .sp 1 (p. 14).
|
|
4066 ;; Delete all but 1 trailing blank lines:
|
|
4067 ;;(woman-leave-blank-lines 1)
|
|
4068 ))
|
|
4069 )
|
|
4070 (setq woman-temp-indent nil)
|
|
4071 ;; Non-white-space text has been processed, so ...
|
|
4072 ;;(setq woman-leave-blank-lines nil)
|
|
4073 ))
|
|
4074
|
|
4075
|
|
4076 ;;; Tagged, indented and hanging paragraphs:
|
|
4077
|
|
4078 (defun woman2-TP (to)
|
29074
|
4079 ".TP i -- Set prevailing indent to i. Format paragraphs upto TO.
|
28832
|
4080 Begin indented paragraph with hanging tag given by next text line.
|
|
4081 If tag doesn't fit, place it on a separate line."
|
|
4082 (let ((i (woman2-get-prevailing-indent)))
|
|
4083 (woman-leave-blank-lines woman-interparagraph-distance)
|
|
4084 (woman2-tagged-paragraph to i)))
|
|
4085
|
|
4086 (defun woman2-IP (to)
|
29074
|
4087 ".IP x i -- Same as .TP with tag x. Format paragraphs upto TO."
|
28832
|
4088 (woman-interparagraph-space)
|
|
4089 (if (eolp) ; no args
|
|
4090 ;; Like LP without resetting prevailing indent
|
|
4091 (woman2-format-paragraphs to (+ woman-left-margin
|
|
4092 woman-prevailing-indent))
|
|
4093 (woman-forward-arg 'unquote)
|
|
4094 (let ((i (woman2-get-prevailing-indent 'leave-eol)))
|
|
4095 (beginning-of-line)
|
|
4096 (woman-leave-blank-lines) ; must be here,
|
|
4097 (woman2-tagged-paragraph to i))))
|
|
4098
|
|
4099 (defun woman-find-next-control-line-carefully ()
|
|
4100 "Find and return start of next control line, even if already there!"
|
|
4101 (if (looking-at "^[.']")
|
|
4102 (point)
|
|
4103 (woman-find-next-control-line)))
|
|
4104
|
|
4105 (defun woman2-tagged-paragraph (to i)
|
29074
|
4106 "Begin indented paragraph with hanging tag given by current text line.
|
|
4107 If tag doesn't fit, leave it on separate line.
|
|
4108 Format paragraphs upto TO. Set prevailing indent to I."
|
28832
|
4109 (if (not (looking-at "\\s *$")) ; non-empty tag
|
|
4110 (setq woman-leave-blank-lines nil))
|
|
4111
|
|
4112 ;; Temporary hack for bash.1 and groff_mmse.7 until code is revised
|
|
4113 ;; to process all requests uniformly:
|
|
4114 (cond ((and (= (point) to) (looking-at "^[.'][ \t]*\\(PD\\|br\\|ta\\) *"))
|
|
4115 (if (string= (match-string 1) "br")
|
|
4116 (woman-delete-line 1)
|
|
4117 (woman-delete-match 0)
|
|
4118 (if (string= (match-string 1) "ta") ; for GetInt.3
|
|
4119 (woman2-ta to)
|
|
4120 (woman-set-interparagraph-distance)))
|
|
4121 (set-marker to (woman-find-next-control-line-carefully))
|
|
4122 ))
|
|
4123
|
|
4124 (let ((tag (point)))
|
|
4125 (woman-reset-nospace)
|
|
4126 ;; Format the tag:
|
|
4127 (woman2-process-escapes-to-eol)
|
|
4128 ;; TIDY UP THE FOLLOWING CODE
|
|
4129 ;; (indent-to woman-left-margin)
|
|
4130 (setq left-margin woman-left-margin)
|
|
4131 (forward-line)
|
|
4132 (fill-region-as-paragraph (save-excursion (forward-line -1) (point))
|
|
4133 (point) woman-justify)
|
|
4134
|
|
4135 ;; Temporary hack for bash.1 until all requests processed uniformly:
|
|
4136 (cond ((and (= (point) to) (looking-at "^[.'][ \t]*PD *"))
|
|
4137 (woman-delete-match 0)
|
|
4138 (woman-set-interparagraph-distance)
|
|
4139 (set-marker to (woman-find-next-control-line-carefully))
|
|
4140 ))
|
|
4141
|
|
4142 ;; Format the paragraph body, if there is one! Set indented left
|
|
4143 ;; margin anyway, because the paragraph body may begin with a
|
|
4144 ;; control line:
|
|
4145 (setq left-margin (+ woman-left-margin i))
|
|
4146 (cond ((< (point) to)
|
|
4147 (woman2-format-paragraphs to)
|
|
4148 (goto-char tag) (end-of-line)
|
|
4149 (cond ((> (setq i (- left-margin (current-column))) 0)
|
|
4150 (delete-char 1)
|
|
4151 (delete-horizontal-space)
|
|
4152 ;; Necessary to avoid spaces inheriting underlines.
|
|
4153 ;; Cannot simply delete (current-column) whitespace
|
|
4154 ;; characters because some may be tabs!
|
|
4155 (while (> i 0) (insert ? ) (setq i (1- i)))))
|
|
4156 (goto-char to) ; necessary ???
|
|
4157 ))
|
|
4158 ))
|
|
4159
|
|
4160 (defun woman2-HP (to)
|
29074
|
4161 ".HP i -- Set prevailing indent to i. Format paragraphs upto TO.
|
28832
|
4162 Begin paragraph with hanging indent."
|
|
4163 (let ((i (woman2-get-prevailing-indent)))
|
|
4164 (woman-interparagraph-space)
|
|
4165 (setq woman-temp-indent woman-left-margin)
|
|
4166 (woman2-format-paragraphs to (+ woman-left-margin i))
|
|
4167 ))
|
|
4168
|
|
4169 (defun woman2-get-prevailing-indent (&optional leave-eol)
|
29074
|
4170 "Set prevailing indent to integer argument at point, and return it.
|
|
4171 If no argument then return the existing prevailing indent.
|
28832
|
4172 Delete line from point and eol unless LEAVE-EOL is non-nil."
|
|
4173 (if (eolp)
|
|
4174 (or leave-eol (delete-char 1))
|
|
4175 (let ((i (woman-get-numeric-arg)))
|
|
4176 (woman-delete-line) (or leave-eol (delete-char 1))
|
|
4177 ;; i = 0 if the argument was not a number
|
|
4178 (if (> i 0) (setq woman-prevailing-indent i))))
|
|
4179 woman-prevailing-indent)
|
|
4180
|
|
4181 (defmacro woman-push (value stack)
|
|
4182 "Push VALUE onto STACK."
|
|
4183 `(setq ,stack (cons ,value ,stack)))
|
|
4184
|
|
4185 (defmacro woman-pop (variable stack)
|
29074
|
4186 "Pop into VARIABLE the value at the top of STACK.
|
28832
|
4187 Allow for mismatched requests!"
|
|
4188 `(if ,stack
|
|
4189 (setq ,variable (car ,stack)
|
|
4190 ,stack (cdr ,stack))))
|
|
4191
|
|
4192 (defun woman2-RS (to)
|
29074
|
4193 ".RS i -- Start relative indent, move left margin in distance i.
|
|
4194 Set prevailing indent to 5 for nested indents. Format paragraphs upto TO."
|
28832
|
4195 (woman-push woman-left-margin woman-RS-left-margin)
|
|
4196 (woman-push woman-prevailing-indent woman-RS-prevailing-indent)
|
|
4197 (setq woman-left-margin (+ woman-left-margin
|
|
4198 (woman2-get-prevailing-indent))
|
|
4199 woman-prevailing-indent woman-default-indent)
|
|
4200 (woman2-format-paragraphs to woman-left-margin))
|
|
4201
|
|
4202 (defun woman2-RE (to)
|
29074
|
4203 ".RE -- End of relative indent. Format paragraphs upto TO.
|
28832
|
4204 Set prevailing indent to amount of starting .RS."
|
|
4205 (woman-pop woman-left-margin woman-RS-left-margin)
|
|
4206 (woman-pop woman-prevailing-indent woman-RS-prevailing-indent)
|
|
4207 (woman-delete-line 1) ; ignore any arguments
|
|
4208 (woman2-format-paragraphs to woman-left-margin))
|
|
4209
|
|
4210
|
|
4211 ;;; Line Length and Indenting:
|
|
4212
|
|
4213 (defun woman-set-arg (arg &optional previous)
|
29074
|
4214 "Reset, increment or decrement argument ARG, which must be quoted.
|
|
4215 If no argument then use value of optional arg PREVIOUS if non-nil,
|
|
4216 otherwise set PREVIOUS. Delete the whole remaining control line."
|
28832
|
4217 (if (eolp) ; space already skipped
|
|
4218 (set arg (if previous (eval previous) 0))
|
|
4219 (if previous (set previous (eval arg)))
|
|
4220 (woman2-process-escapes-to-eol 'numeric)
|
|
4221 (let ((pm (if (looking-at "[+-]")
|
|
4222 (prog1 (following-char)
|
|
4223 (forward-char 1))))
|
|
4224 (i (woman-parse-numeric-arg)))
|
|
4225 (cond ((null pm) (set arg i))
|
|
4226 ((= pm ?+) (set arg (+ (eval arg) i)))
|
|
4227 ((= pm ?-) (set arg (- (eval arg) i)))
|
|
4228 ))
|
|
4229 (beginning-of-line))
|
|
4230 (woman-delete-line 1)) ; ignore any remaining arguments
|
|
4231
|
|
4232 ;; NEED TO RATIONALIZE NAMES FOR PREVIOUS VALUES!
|
|
4233 (defvar woman-ll-fill-column woman-fill-column)
|
|
4234 (defvar woman-in-left-margin woman-left-margin)
|
|
4235
|
|
4236 (defun woman2-ll (to)
|
29074
|
4237 ".ll +/-N -- Set, increment or decrement line length.
|
|
4238 Format paragraphs upto TO. (Breaks, but should not.)"
|
28832
|
4239 (woman-set-arg 'fill-column 'woman-ll-fill-column)
|
|
4240 (woman2-format-paragraphs to))
|
|
4241
|
|
4242 (defun woman2-in (to)
|
29074
|
4243 ".in +/-N -- Set, increment or decrement the indent.
|
|
4244 Format paragraphs upto TO."
|
28832
|
4245 (woman-set-arg 'left-margin 'woman-in-left-margin)
|
|
4246 (woman2-format-paragraphs to))
|
|
4247
|
|
4248 (defun woman2-ti (to)
|
29074
|
4249 ".ti +/-N -- Temporary indent. Format paragraphs upto TO."
|
28832
|
4250 ;; Ignore if no argument.
|
|
4251 ;; Indent next output line only wrt current indent.
|
|
4252 ;; Current indent is not changed.
|
|
4253 (setq woman-temp-indent left-margin)
|
|
4254 (woman-set-arg 'woman-temp-indent)
|
|
4255 (woman2-format-paragraphs to nil))
|
|
4256
|
|
4257
|
|
4258 ;;; Tabs, Leaders, and Fields:
|
|
4259
|
|
4260 (defun woman2-ta (to)
|
29074
|
4261 ".ta Nt ... -- Set tabs, left type, unless t=R(right), C(centered).
|
|
4262 \(Breaks, but should not.) The tab stops are separated by spaces\;
|
|
4263 a value preceded by + represents an increment to the previous stop value.
|
|
4264 Format paragraphs upto TO."
|
28832
|
4265 (setq tab-stop-list nil)
|
|
4266 (woman2-process-escapes-to-eol 'numeric)
|
|
4267 (save-excursion
|
|
4268 (let ((tab-stop 0))
|
|
4269 (while (not (eolp))
|
|
4270 (let ((plus (cond ((eq (following-char) ?+) (forward-char 1) t)))
|
|
4271 (i (woman-parse-numeric-arg)))
|
|
4272 (setq tab-stop (if plus (+ tab-stop i) i)))
|
|
4273 (if (memq (following-char) '(?R ?C))
|
|
4274 (setq tab-stop (cons tab-stop (following-char))))
|
|
4275 (setq tab-stop-list (cons tab-stop tab-stop-list))
|
|
4276 (skip-syntax-forward "^ ") ; skip following R, C, `;', etc.
|
|
4277 (skip-chars-forward " \t")
|
|
4278 )))
|
|
4279 (woman-delete-line 1) ; ignore any remaining arguments
|
|
4280 (setq tab-stop-list (reverse tab-stop-list))
|
|
4281 (woman2-format-paragraphs to))
|
|
4282
|
|
4283 (defsubst woman-get-tab-stop (tab-stop-list)
|
|
4284 "If TAB-STOP-LIST is a cons, return its car, else return TAB-STOP-LIST."
|
|
4285 (if (consp tab-stop-list) (car tab-stop-list) tab-stop-list))
|
|
4286
|
|
4287 (defun woman-tab-to-tab-stop ()
|
|
4288 "Insert spaces to next defined tab-stop column.
|
29074
|
4289 The variable `tab-stop-list' is a list whose elements are either left
|
|
4290 tab stop columns or pairs (COLUMN . TYPE) where TYPE is R or C."
|
28832
|
4291 ;; Based on tab-to-tab-stop in indent.el.
|
|
4292 ;; R & C tabs probably not quite right!
|
|
4293 (delete-backward-char 1)
|
|
4294 (let ((tabs tab-stop-list))
|
|
4295 (while (and tabs (>= (current-column)
|
|
4296 (woman-get-tab-stop (car tabs))))
|
|
4297 (setq tabs (cdr tabs)))
|
|
4298 (if tabs
|
|
4299 (let* ((tab (car tabs))
|
|
4300 (type (and (consp tab) (cdr tab)))
|
|
4301 eol n)
|
|
4302 (if type
|
|
4303 (setq tab (woman-get-tab-stop tab)
|
|
4304 eol (save-excursion (end-of-line) (point))
|
|
4305 n (save-excursion
|
|
4306 (search-forward "\t" eol t))
|
|
4307 n (- (if n (1- n) eol) (point))
|
|
4308 tab (- tab (if (eq type ?C) (/ n 2) n))) )
|
|
4309 (setq n (- tab (current-column)))
|
|
4310 (while (> n 0)
|
|
4311 (insert ?\ )
|
|
4312 (setq n (1- n))))
|
|
4313 (insert ?\ ))))
|
|
4314
|
|
4315 (defun woman2-DT (to)
|
29074
|
4316 ".DT -- Restore default tabs. Format paragraphs upto TO.
|
|
4317 \(Breaks, but should not.)"
|
28832
|
4318 ;; Currently just terminates special tab processing.
|
|
4319 (setq tab-stop-list nil)
|
|
4320 (woman-delete-line 1) ; ignore any arguments
|
|
4321 (woman2-format-paragraphs to))
|
|
4322
|
|
4323 (defun woman2-fc (to)
|
29074
|
4324 ".fc a b -- Set field delimiter a and pad character b.
|
|
4325 Format paragraphs upto TO.
|
28832
|
4326 A VERY FIRST ATTEMPT to make fields at least readable!
|
|
4327 Needs doing properly!"
|
|
4328 (if (eolp)
|
|
4329 (woman-delete-whole-line) ; ignore!
|
|
4330 (let ((delim (following-char))
|
|
4331 (pad ?\ ) end) ; pad defaults to space
|
|
4332 (forward-char)
|
|
4333 (skip-chars-forward " \t")
|
|
4334 (or (eolp) (setq pad (following-char)))
|
|
4335 (woman-delete-whole-line)
|
|
4336 (save-excursion
|
|
4337 (if (re-search-forward "^[.'][ \t]*fc\\s " nil t)
|
|
4338 (setq end (match-beginning 0))))
|
|
4339 ;; A field is contained between a pair of field delimiter
|
|
4340 ;; characters and consists of sub-strings separated by padding
|
|
4341 ;; indicator characters:
|
|
4342 (setq delim (string delim ?[ ?^ delim ?] ?* delim))
|
|
4343 (save-excursion
|
|
4344 (while (re-search-forward delim end t)
|
|
4345 (goto-char (match-beginning 0))
|
|
4346 (delete-char 1)
|
|
4347 (insert woman-unpadded-space-char)
|
|
4348 (goto-char (match-end 0))
|
|
4349 (delete-backward-char 1)
|
|
4350 (insert-before-markers woman-unpadded-space-char)
|
|
4351 (subst-char-in-region
|
|
4352 (match-beginning 0) (match-end 0)
|
|
4353 pad woman-unpadded-space-char t)
|
|
4354 ))
|
|
4355 ))
|
|
4356 (woman2-format-paragraphs to))
|
|
4357
|
|
4358
|
|
4359 ;;; WoMan message logging:
|
|
4360
|
29074
|
4361 ;; The basis for this logging code was shamelessly pirated from bytecomp.el
|
|
4362 ;; by Jamie Zawinski <jwz@lucid.com> & Hallvard Furuseth <hbf@ulrik.uio.no>
|
28832
|
4363
|
|
4364 (defvar WoMan-current-file nil) ; bound in woman-really-find-file
|
|
4365 (defvar WoMan-Log-header-point-max nil)
|
|
4366
|
|
4367 (defun WoMan-log-begin ()
|
|
4368 "Log the beginning of formatting in *WoMan-Log*."
|
|
4369 (let ((WoMan-current-buffer (buffer-name)))
|
|
4370 (save-excursion
|
|
4371 (set-buffer (get-buffer-create "*WoMan-Log*"))
|
|
4372 (or (eq major-mode 'view-mode) (view-mode 1))
|
|
4373 (setq buffer-read-only nil)
|
|
4374 (goto-char (point-max))
|
|
4375 (insert "\n\^L\nFormatting "
|
|
4376 (if (stringp WoMan-current-file)
|
|
4377 (concat "file " WoMan-current-file)
|
|
4378 (concat "buffer " WoMan-current-buffer))
|
|
4379 " at " (current-time-string) "\n")
|
|
4380 (setq WoMan-Log-header-point-max (point-max))
|
|
4381 )))
|
|
4382
|
|
4383 (defun WoMan-log (format &rest args)
|
|
4384 "Log a message out of FORMAT control string and optional ARGS."
|
|
4385 (WoMan-log-1 (apply 'format format args)))
|
|
4386
|
|
4387 (defun WoMan-warn (format &rest args)
|
|
4388 "Log a warning message out of FORMAT control string and optional ARGS."
|
|
4389 (setq format (apply 'format format args))
|
|
4390 (WoMan-log-1 (concat "** " format)))
|
|
4391
|
|
4392 (defun WoMan-warn-ignored (request ignored)
|
|
4393 "Log a warning message about ignored directive REQUEST.
|
|
4394 IGNORED is a string appended to the log message."
|
|
4395 (let ((tail
|
|
4396 (buffer-substring (point)
|
|
4397 (save-excursion (end-of-line) (point)))))
|
|
4398 (if (and (> (length tail) 0)
|
|
4399 (/= (string-to-char tail) ?\ ))
|
|
4400 (setq tail (concat " " tail)))
|
|
4401 (WoMan-log-1
|
|
4402 (concat "** " request tail " request " ignored))))
|
|
4403
|
|
4404 (defun WoMan-log-end (time)
|
|
4405 "Log the end of formatting in *WoMan-Log*.
|
|
4406 TIME specifies the time it took to format the man page, to be printed
|
|
4407 with the message."
|
|
4408 (WoMan-log-1 (format "Formatting time %d seconds." time) 'end))
|
|
4409
|
|
4410 (defun WoMan-log-1 (string &optional end)
|
|
4411 "Log a message STRING in *WoMan-Log*.
|
29074
|
4412 If optional argument END is non-nil then make buffer read-only after
|
|
4413 logging the message."
|
28832
|
4414 (save-excursion
|
|
4415 (set-buffer (get-buffer-create "*WoMan-Log*"))
|
35690
|
4416 (setq buffer-read-only nil)
|
28832
|
4417 (goto-char (point-max))
|
|
4418 (or end (insert " ")) (insert string "\n")
|
|
4419 (if end
|
|
4420 (setq buffer-read-only t)
|
|
4421 (if woman-show-log
|
|
4422 (select-window ; to return to
|
|
4423 (prog1 (selected-window) ; WoMan window
|
|
4424 (select-window (display-buffer (current-buffer)))
|
|
4425 (cond (WoMan-Log-header-point-max
|
|
4426 (goto-char WoMan-Log-header-point-max)
|
|
4427 (forward-line -1)
|
|
4428 (recenter 0)))
|
|
4429 )))))
|
|
4430 nil) ; for woman-file-readable-p etc.
|
|
4431
|
|
4432 (provide 'woman)
|
|
4433
|
29074
|
4434 ;; RECENT CHANGE LOG
|
|
4435 ;; =================
|
|
4436
|
|
4437 ;; Changes in version 0.50 ([*] => user interface change)
|
|
4438 ;; [*] Requires GNU Emacs 20.3+.
|
|
4439 ;; [*] `defface' used to define faces.
|
|
4440 ;; [*] Follow `see also' references with mouse-2 click.
|
|
4441 ;; Number register increment support added (woman-registers).
|
|
4442 ;; .j must be a NUMBER acceptable by .ad request.
|
|
4443 ;; Very crude field support added.
|
|
4444 ;; Vertical unit specifier `v' added to register handling.
|
|
4445 ;; Improvement to local horizontal motion processing.
|
|
4446 ;; Minor fix to handle negative numeric arguments.
|
|
4447 ;; Handle horizontal motion escapes `\h' better.
|
|
4448 ;; Allow arbitrary delimiters in `.if', inc. special character escapes.
|
|
4449 ;; Allow `\n' within `.if' string comparisons.
|
|
4450 ;; Allow arbitrary delimiters in `\w', inc. special character escapes.
|
|
4451 ;; Processing of `\h' moved much later -- after indenting etc!
|
|
4452
|
|
4453 ;; Changes in version 0.51 ([*] => user interface change)
|
|
4454 ;; [*] Improved handling of underlined faces (mainly for "italics").
|
|
4455 ;; [*] Allow environment variables in directory path elements.
|
|
4456 ;; Display of pre-formatted files improved.
|
|
4457 ;; [*] Unintentional interaction with standard Man mode reduced.
|
|
4458 ;; [*] bzip2 decompression support added. All decompression now
|
|
4459 ;; works by turning on `auto-compression-mode' to decompress the
|
|
4460 ;; file if necessary, rather than decompressing explicitly.
|
|
4461 ;; Filename and compression regexps are now customizable user
|
|
4462 ;; options.
|
|
4463
|
|
4464 ;; Changes in version 0.52 ([*] => user interface change)
|
|
4465 ;; Speeded up handling of underlined faces (mainly for "italics").
|
|
4466 ;; [*] WoMan formatting time display and log added. Emacs `man'
|
|
4467 ;; formatting time display advice added. (This suggests that
|
|
4468 ;; WoMan formatting is faster than Emacs `man' *formatting*,
|
|
4469 ;; i.e. when man is not using `catman' caching. E.g. `woman
|
|
4470 ;; bash' takes 27s whereas `man bash' takes 35s and for smaller
|
|
4471 ;; files `woman' can be relatively much faster than `man'.)
|
|
4472 ;; [*] Experimental support for non-ASCII characters from the
|
|
4473 ;; default and symbol fonts added, initially only for MS-Windows.
|
|
4474 ;; NOTE: It is off by default, mainly because it may increase the
|
|
4475 ;; line spacing; customize `woman-use-symbols' to `on' to use it.
|
|
4476 ;; Pad character handling for .fc fixed.
|
|
4477 ;; Tested: see `woman.status'.
|
|
4478
|
|
4479 ;; Changes in version 0.53 ([*] => user interface change)
|
|
4480 ;; [*] Customization option to use a separate frame for WoMan windows.
|
|
4481 ;; [*] Experimental option to emulate nroff (default) or troff (not tested).
|
|
4482 ;; [*] Separation of extended and symbol font options.
|
|
4483 ;; Only symbol font size 16 seems to work, and only with Win 95, not NT!
|
|
4484 ;; [*] `Advanced' sub-menu containing:
|
|
4485 ;; `View Source' option;
|
|
4486 ;; `Show Log' option;
|
|
4487 ;; `Extended Font' toggle and reformat;
|
|
4488 ;; `Symbol Font' toggle and reformat;
|
|
4489 ;; `Font Map' option;
|
|
4490 ;; `Emulation' radio buttons.
|
|
4491 ;; [*] Support for man config file added for default manpath.
|
|
4492
|
|
4493 ;; Changes in version 0.54
|
|
4494 ;; Revised for distribution with Emacs 21.
|
|
4495 ;; Comment order and doc strings changed substantially.
|
|
4496 ;; MS-DOS support added (by Eli Zaretskii).
|
|
4497 ;; checkdoc run: no real errors.
|
29147
|
4498 ;; woman topic interface speeded up.
|
29074
|
4499
|
28832
|
4500 ;;; woman.el ends here
|