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