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