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