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