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