1 ;;; woman.el --- browse UN*X manual pages `wo (without) man'
3 ;; Copyright (C) 2000, 2002 Free Software Foundation, Inc.
5 ;; Author: Francis J. Wright <F.J.Wright@qmul.ac.uk>
6 ;; Maintainer: Francis J. Wright <F.J.Wright@qmul.ac.uk>
7 ;; Keywords: help, unix
8 ;; Adapted-By: Eli Zaretskii <eliz@is.elta.co.il>
9 ;; Version: see `woman-version'
10 ;; URL: http://centaur.maths.qmul.ac.uk/Emacs/WoMan/
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
31 ;; WoMan implements a subset of the formatting performed by the Emacs
32 ;; `man' (or `manual-entry') command to format a UN*X manual `page'
33 ;; for display, but without calling any external programs. It is
34 ;; intended to emulate the whole of the -man macro package, plus those
35 ;; ?roff requests that are most commonly used in man pages. However,
36 ;; the emulation is modified to include the reformatting done by the
37 ;; Emacs `man' command. No hyphenation is performed.
41 ;; Much more direct, does not require any external programs.
42 ;; Supports completion on man page names.
46 ;; Not a complete emulation. Currently no support for eqn or tbl.
47 ;; Slightly slower for large man pages (but usually faster for
48 ;; small- and medium-size pages).
50 ;; This browser works quite well on simple well-written man files. It
51 ;; works less well on idiosyncratic files that `break the rules' or
52 ;; use the more obscure ?roff requests directly. Current test results
53 ;; are available in the file woman.status.
55 ;; WoMan supports the use of compressed man files via
56 ;; `auto-compression-mode' by turning it on if necessary. But you may
57 ;; need to adjust the user option `woman-file-compression-regexp'.
59 ;; Read on for (currently) the only documentation for WoMan!
61 ;; See also the documentation for the WoMan interactive commands and
62 ;; user option variables, all of which begin with the prefix `woman-'.
63 ;; This can be done most easily by loading WoMan and then running the
64 ;; command `woman-mini-help', or selecting the WoMan menu option `Mini
65 ;; Help' when WoMan is running.
67 ;; WoMan is still under development! Please let me know what doesn't
68 ;; work -- I am adding and improving functionality as testing shows
69 ;; that it is necessary. See below for guidance on reporting bugs.
74 ;; Put this in your .emacs:
75 ;; (autoload 'woman "woman"
76 ;; "Decode and browse a UN*X man page." t)
77 ;; (autoload 'woman-find-file "woman"
78 ;; "Find, decode and browse a specific UN*X man-page file." t)
80 ;; Then either (1 -- *RECOMMENDED*): If the `MANPATH' environment
81 ;; variable is set then WoMan will use it; otherwise you may need to
82 ;; reset the Lisp variable `woman-manpath', and you may also want to
83 ;; set the Lisp variable `woman-path'. Please see the online
84 ;; documentation for these variables. Now you can execute the
85 ;; extended command `woman', enter or select a manual entry topic,
86 ;; using completion, and if necessary select a filename, using
87 ;; completion. By default, WoMan suggests the word nearest to the
88 ;; cursor in the current buffer as the topic.
90 ;; Or (2): Execute the extended command `woman-find-file' and enter a
91 ;; filename, using completion. This mode of execution may be useful
92 ;; for temporary files outside the standard UN*X manual directory
95 ;; Or (3): Put the next two sexpr's in your .emacs:
96 ;; (autoload 'woman-dired-find-file "woman"
97 ;; "In dired, run the WoMan man-page browser on this file." t)
98 ;; (add-hook 'dired-mode-hook
100 ;; (define-key dired-mode-map "W" 'woman-dired-find-file)))
101 ;; and open the directory containing the man page file using dired,
102 ;; put the cursor on the file, and press `W'.
104 ;; In each case, the result should (!) be a buffer in Man mode showing
105 ;; a formatted manual entry. When called from WoMan, Man mode should
106 ;; work as advertised, but modified where necessary in the context of
107 ;; WoMan. (However, `Man' will still invoke the standard Emacs
108 ;; manual-browsing facility rather than `WoMan' -- this is
111 ;; (By default, WoMan will automatically define the dired keys "W" and
112 ;; "w" when it loads, but only if they are not already defined. This
113 ;; behaviour is controlled by the user option `woman-dired-keys'.
114 ;; Note that the `dired-x' (dired extra) package binds
115 ;; `dired-copy-filename-as-kill' to the key "w" (as pointed out by Jim
116 ;; Davidson), although "W" appears to be really unused. The `dired-x'
117 ;; package will over-write the WoMan binding to "w", whereas (by
118 ;; default) WoMan will not overwrite the `dired-x' binding.)
120 ;; The following is based on suggestions by Guy Gascoigne-Piggford and
121 ;; Juanma Barranquero. If you really want to square the man-woman
122 ;; circle then you might care to define the following bash function in
125 ;; man() { gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; }
127 ;; If you use Microsoft COMMAND.COM then you can create a file called
128 ;; man.bat somewhere in your path containing the two lines:
131 ;; gnudoit -q (raise-frame (selected-frame)) (woman \"%1\")
133 ;; and then (e.g. from a command prompt or the Run... option in the
134 ;; Start menu) just execute
139 ;; Using the `word at point' as a topic suggestion
140 ;; ===============================================
142 ;; By default, the `woman' command uses the word nearest to point in
143 ;; the current buffer as a suggestion for the topic to look up. The
144 ;; topic must be confirmed or edited in the minibuffer. This
145 ;; suggestion can be turned off, or `woman' can use the suggested
146 ;; topic without confirmation* if possible, by setting the user-option
147 ;; `woman-topic-at-point' to nil or t respectively. (Its default
148 ;; value is neither nil nor t, meaning ask for confirmation.)
150 ;; [* Thanks to Benjamin Riefenstahl for suggesting this
153 ;; The variable `woman-topic-at-point' can be rebound locally, which
154 ;; may be useful to provide special private key bindings, e.g.
156 ;; (global-set-key "\C-cw"
159 ;; (let ((woman-topic-at-point t))
163 ;; Customization, Hooks and Imenu
164 ;; ==============================
166 ;; WoMan supports the GNU Emacs 20+ customization facility, and puts
167 ;; a customization group called `WoMan' in the `Help' group under the
168 ;; top-level `Emacs' group. In order to be able to customize WoMan
169 ;; without first loading it, add the following sexp to your .emacs:
171 ;; (defgroup woman nil
172 ;; "Browse UNIX manual pages `wo (without) man'."
173 ;; :tag "WoMan" :group 'help :load "woman")
176 ;; WoMan currently runs two hooks: `woman-pre-format-hook' immediately
177 ;; before formatting a buffer and `woman-post-format-hook' immediately
178 ;; after formatting a buffer. These hooks can be used for special
179 ;; customizations that require code to be executed, etc., although
180 ;; most customization should be possible by setting WoMan user option
181 ;; variables, e.g. in `.emacs' and should NOT require the use of the
182 ;; hooks. `woman-pre-format-hook' might be appropriate for face
183 ;; customization, whereas `woman-post-format-hook' might be
184 ;; appropriate for installing a dynamic menu using `imenu' (although
185 ;; it is better to use the built-in WoMan imenu support).
187 ;; The WoMan menu provides an option to make a contents menu for the
188 ;; current man page (using imenu). Alternatively, if you set the
189 ;; variable `woman-imenu' to `t' then WoMan will do it automatically
190 ;; for every man page. The menu title is the value of the variable
191 ;; `woman-imenu-title', which is "CONTENTS" by default. By default,
192 ;; the menu shows manual sections and subsections, but you can change
193 ;; this by changing the value of `woman-imenu-generic-expression'.
194 ;; This facility is not yet widely tested and may be fooled by obscure
195 ;; man pages that `break the rules'.
197 ;; WoMan is configured not to replace spaces in an imenu *Completion*
198 ;; buffer. For further documentation of the use of imenu, such as
199 ;; menu sorting, see the source file imenu.el, which is distributed
202 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
204 ;; Howard Melman made (essentially) the following suggestions, which
205 ;; are slightly different from the expression that I currently use.
206 ;; You may prefer one of Howard's suggestions, which I think assume
207 ;; that `case-fold-search' is `t' (which it is by default):
209 ;; (setq woman-imenu-generic-expression
210 ;; '((nil "^\\( \\)?\\([A-Z][A-Z ]+[A-Z]\\)[ \t]*$" 2)))
212 ;; will give support for .SH and .SS, though it won't show the heading
213 ;; name hierarchy. If you just want .SH in the imenu then use:
215 ;; (setq woman-imenu-generic-expression
216 ;; '((nil "^\\([A-Z][A-Z ]+[A-Z]\\)[ \t]*$" 1)))
218 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
221 ;; Vertical spacing and blank lines
222 ;; ================================
224 ;; The number of consecutive blank lines in the formatted buffer
225 ;; should be either 0 or 1. A blank line should leave a space like
226 ;; .sp 1 (p. 14). Current policy is to output vertical space only
227 ;; immediately before text is output.
230 ;; Horizontal and vertical spacing and resolution
231 ;; ==============================================
233 ;; WoMan currently assumes 10 characters per inch horizontally, hence
234 ;; a horizontal resolution of 24 basic units, and 5 lines per inch
235 ;; vertically, hence a vertical resolution of 48 basic units. (nroff
236 ;; uses 240 per inch).
239 ;; The *WoMan-Log* buffer
240 ;; ======================
242 ;; This is modelled on the byte-compiler. It logs all files formatted
243 ;; by WoMan, and if WoMan finds anything that it cannot handle then it
244 ;; writes a warning to this buffer. If the variable `woman-show-log'
245 ;; is non-nil (by default it is `nil') then WoMan automatically
246 ;; displays this buffer. Many WoMan warnings can be completely
247 ;; ignored, because they are reporting the fact that WoMan has ignored
248 ;; requests that it is correct to ignore. In some future version this
249 ;; level of paranoia will be reduced, but not until WoMan is more
250 ;; reliable. At present, all warnings should be treated with some
251 ;; suspicion. Uninterpreted escape sequences are also logged (in some
254 ;; Uninterpreted ?roff requests can optionally be left in the
255 ;; formatted buffer to indicate precisely where they occur by
256 ;; resetting the variable `woman-ignore' to `nil' (by default it is
259 ;; Automatic initiation of woman decoding
261 ;; (Probably not a good idea. If you use it, be careful!)
263 ;; Put something like this in your .emacs. The call to
264 ;; set-visited-file-name is to avoid font-locking triggered by
265 ;; automatic major mode selection.
267 ;; (autoload 'woman-decode-region "woman")
269 ;; (setq format-alist
271 ;; '(man "UN*X man-page source format" "\\.\\(TH\\|ig\\) "
272 ;; woman-decode-region nil nil
274 ;; set-visited-file-name
275 ;; (file-name-sans-extension buffer-file-name)))))
282 ;; If WoMan fails completely, or formats a file incorrectly
283 ;; (i.e. obviously wrongly or significantly differently from man) or
284 ;; inelegantly, then please
286 ;; (a) check that you are running the latest version of woman.el
287 ;; available from my web site (see above),
289 ;; (b) check that the problem is not already described in the file
290 ;; woman.status, also available from my web site.
292 ;; If both of the above are true then please email me the entry from
293 ;; the *WoMan-Log* buffer relating to the problem file, together with
294 ;; a brief description of the problem. Please indicate where you got
295 ;; the source file from, but do not send it to me unless I ask you to!
296 ;; Thanks. (There is at present no automated bug-reporting facility
299 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
303 ;; CASE-DEPENDENCE OF FILENAMES. By default, WoMan ignores case in
304 ;; file pathnames only when it seems appropriate. MS-Windows users
305 ;; who want complete case independence should set the NTEmacs variable
306 ;; `w32-downcase-file-names' to `t' and use all lower case when
307 ;; setting WoMan file paths.
309 ;; (1) INCOMPATIBLE CHANGE! WoMan no longer uses a persistent topic
310 ;; cache by default. (It caused too much confusion!) Explicitly set
311 ;; the variable `woman-cache-filename' to save the cache between Emacs
312 ;; sessions. This is recommended only if the command `woman' is too
313 ;; slow the first time that it is run in an Emacs session, while it
314 ;; builds its cache in main memory, which MAY be VERY slow.
316 ;; (2) The user option `woman-cache-level' controls the amount of
317 ;; information cached (in main memory and, optionally, saved to disc).
319 ;; (3) UPDATING THE CACHE. A prefix argument always causes the
320 ;; `woman' command (only) to rebuild its topic cache, and to re-save
321 ;; it to `woman-cache-filename' if this variable has a non-nil value.
322 ;; This is necessary if the NAMES (not contents) of any of the
323 ;; directories or files in the paths specified by `woman-manpath' or
324 ;; `woman-path' change. If WoMan user options that affect the cache
325 ;; are changed then WoMan will automatically update its cache file on
326 ;; disc (if one is in use) the next time it is run in a new Emacs
329 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
335 ;; Reconsider case sensitivity of file names.
336 ;; MUST PROCESS .if, .nr IN ORDER ENCOUNTERED IN FILE! (rcsfile, mf).
337 ;; Allow general delimiter in `\v', cf. `\h'.
338 ;; Improve major-mode documentation.
339 ;; Pre-process conditionals in macro bodies if possible for speed?
340 ;; Emulate more complete preprocessor support for tbl (.TS/.TE)
341 ;; Emulate some preprocessor support for eqn (.EQ/.EN)
342 ;; Re-write filling and adjusting code!
343 ;; Allow word wrap at comma (for long option lists)?
344 ;; Buffer list handling not quite right.
345 ;; Make 10 or 12 pitch (cpi) optional -- 12 => ll = 78
346 ;; Use unpaddable space for tabbing?
347 ;; Tidy up handling of fonts when filling and adjusting
348 ;; -- see text/text properties?
350 ;; Add font-lock support (for quoted strings, etc.)?
351 ;; Optionally save large files in enriched format?
352 ;; Add apropos facility by searching NAME (?) entry in man files?
353 ;; Documentation -- optional auto-display of formatted WoMan man page?
354 ;; Implement a bug reporter?
355 ;; Support diversion and traps (to some extent) - for Tcl/tk pages?
356 ;; Add a menu of WoMan buffers?
360 ;; Implementation strategy [this description is now well out of date!]
361 ;; -- three main passes, each to process respectively:
363 ;; 1) non-breaking `.' requests including font macros
364 ;; 2) \ escape sequences, mainly special characters and font changes
365 ;; 3) breaking `.' requests, mainly filling and justification
367 ;; For each pass, a control function finds and pre-processes the
368 ;; escape or request and then calls the appropriate function to
369 ;; perform the required formatting. Based originally on enriched.el
372 ;; The background information that made this project possible is
373 ;; freely available courtesy of Bell Labs from
374 ;; http://cm.bell-labs.com/7thEdMan/
380 ;; For Heather, Kathryn and Madelyn, the women in my life
381 ;; (although they will probably never use it)!
383 ;; I also thank the following for helpful suggestions, bug reports,
384 ;; code fragments, general interest, etc.:
385 ;; Jari Aalto <jari.aalto@cs.tpu.fi>
386 ;; Dean Andrews <dean@dra.com>
387 ;; Juanma Barranquero <barranquero@laley-actualidad.es>
388 ;; Karl Berry <kb@cs.umb.edu>
389 ;; Jim Chapman <jchapman@netcomuk.co.uk>
390 ;; Kin Cho <kin@neoscale.com>
391 ;; Frederic Corne <frederic.corne@erli.fr>
392 ;; Peter Craft <craft@alacritech.com>
393 ;; Charles Curley <ccurley@trib.com>
394 ;; Jim Davidson <jdavidso@teknowledge.com>
395 ;; Kevin D'Elia <Kevin.DElia@mci.com>
396 ;; John Fitch <jpff@maths.bath.ac.uk>
397 ;; Hans Frosch <jwfrosch@rish.b17c.ingr.com>
398 ;; Guy Gascoigne-Piggford <ggp@informix.com>
399 ;; Brian Gorka <gorkab@sanchez.com>
400 ;; Nicolai Henriksen <nhe@lyngso-industri.dk>
401 ;; Thomas Herchenroeder <the@software-ag.de>
402 ;; Alexander Hinds <ahinds@thegrid.net>
403 ;; Stefan Hornburg <sth@hacon.de>
404 ;; Theodore Jump <tjump@cais.com>
405 ;; Paul Kinnucan <paulk@mathworks.com>
406 ;; Jonas Linde <jonas@init.se>
407 ;; Andrew McRae <andrewm@optimation.co.nz>
408 ;; Howard Melman <howard@silverstream.com>
409 ;; Dennis Pixton <dennis@math.binghamton.edu>
410 ;; T. V. Raman <raman@Adobe.COM>
411 ;; Bruce Ravel <bruce.ravel@nist.gov>
412 ;; Benjamin Riefenstahl <benny@crocodial.de>
413 ;; Kevin Ruland <kruland@seistl.com>
414 ;; Tom Schutter <tom@platte.com>
415 ;; Wei-Xue Shi <wxshi@ma.neweb.ne.jp>
416 ;; Fabio Somenzi <fabio@joplin.colorado.edu>
417 ;; Karel Sprenger <ks@ic.uva.nl>
418 ;; Chris Szurgot <szurgot@itribe.net>
419 ;; Paul A. Thompson <pat@po.cwru.edu>
420 ;; Arrigo Triulzi <arrigo@maths.qmw.ac.uk>
421 ;; Geoff Voelker <voelker@cs.washington.edu>
422 ;; Eli Zaretskii <eliz@is.elta.co.il>
425 ;; For recent change log see end of file.
430 (defvar woman-version "0.551 (beta)" "WoMan version information.")
433 (eval-when-compile ; to avoid compiler warnings
437 (defun woman-mapcan (fn x)
438 "Return concatenated list of FN applied to successive `car' elements of X.
439 FN must return a list, cons or nil. Useful for splicing into a list."
440 ;; Based on the Standard Lisp function MAPCAN but with args swapped!
441 (and x (nconc (funcall fn (car x)) (woman-mapcan fn (cdr x)))))
443 (defun woman-parse-colon-path (paths)
444 "Explode search path string PATHS into a list of directory names.
445 Allow Cygwin colon-separated search paths on Microsoft platforms.
446 Replace null components by calling `woman-parse-man.conf'.
447 As a special case, if PATHS is nil then replace it by calling
448 `woman-parse-man.conf'."
449 ;; Based on suggestions by Jari Aalto and Eli Zaretskii.
450 ;; parse-colon-path returns nil for a null path component and
451 ;; an empty substring of MANPATH denotes the default list.
452 (if (memq system-type '(windows-nt ms-dos))
454 (mapcar 'woman-Cyg-to-Win (woman-parse-man.conf)))
455 ((string-match ";" paths)
456 ;; Assume DOS-style path-list...
457 (woman-mapcan ; splice list into list
461 (mapcar 'woman-Cyg-to-Win (woman-parse-man.conf))))
462 (parse-colon-path paths)))
463 ((string-match "\\`[a-zA-Z]:" paths)
464 ;; Assume single DOS-style path...
467 ;; Assume UNIX/Cygwin-style path-list...
468 (woman-mapcan ; splice list into list
470 (mapcar 'woman-Cyg-to-Win
471 (if x (list x) (woman-parse-man.conf))))
472 (let ((path-separator ":"))
473 (parse-colon-path paths)))))
474 ;; Assume host-default-style path-list...
475 (woman-mapcan ; splice list into list
476 (lambda (x) (if x (list x) (woman-parse-man.conf)))
477 (parse-colon-path (or paths "")))))
479 (defun woman-Cyg-to-Win (file)
480 "Convert an absolute filename FILE from Cygwin to Windows form."
481 ;; Code taken from w32-symlinks.el
482 (if (eq (aref file 0) ?/)
483 ;; Try to use Cygwin mount table via `cygpath.exe'.
487 (call-process "cygpath" nil t nil "-m" file)
488 (buffer-substring 1 (buffer-size)))
490 ;; Assume no `cygpath' program available.
491 ;; Hack /cygdrive/x/ or /x/ or (obsolete) //x/ to x:/
492 (when (string-match "\\`\\(/cygdrive\\|/\\)?/./" file)
493 (if (match-string 1) ; /cygdrive/x/ or //x/ -> /x/
494 (setq file (substring file (match-end 1))))
495 (aset file 0 (aref file 1)) ; /x/ -> xx/
496 (aset file 1 ?:)) ; xx/ -> x:/
503 ;; NB: Group identifiers must be lowercase!
506 "Browse UNIX manual pages `wo (without) man'."
510 (defcustom woman-show-log nil
511 "*If non-nil then show the *WoMan-Log* buffer if appropriate.
512 I.e. if any warning messages are written to it. Default is nil."
516 (defcustom woman-pre-format-hook nil
517 "*Hook run by WoMan immediately before formatting a buffer.
518 Change only via `Customization' or the function `add-hook'."
522 (defcustom woman-post-format-hook nil
523 "*Hook run by WoMan immediately after formatting a buffer.
524 Change only via `Customization' or the function `add-hook'."
531 (defgroup woman-interface nil
532 "Interface options for browsing UNIX manual pages `wo (without) man'."
533 :tag "WoMan Interface"
536 (defcustom woman-man.conf-path
537 (let ((path '("/usr/lib" "/etc")))
538 (if (eq system-type 'windows-nt)
539 (mapcar 'woman-Cyg-to-Win path)
541 "*List of dirs to search and/or files to try for man config file.
542 A trailing separator (`/' for UNIX etc.) on directories is optional,
543 and the filename is used if a directory specified is the first to
544 contain the strings \"man\" and \".conf\" (in that order).
545 If MANPATH is not set but a config file is found then it is parsed
546 instead to provide a default value for `woman-manpath'."
547 :type '(repeat string)
548 :group 'woman-interface)
550 (defun woman-parse-man.conf ()
551 "Parse if possible configuration file for man command.
552 Used only if MANPATH is not set or contains null components.
553 Look in `woman-man.conf-path' and return a value for `woman-manpath'.
554 Concatenate data from all lines in the config file of the form
557 MANDATORY_MANPATH /usr/man
559 OPTIONAL_MANPATH /usr/man"
560 ;; Functionality suggested by Charles Curley.
561 (let ((path woman-man.conf-path)
566 (file-readable-p (setq file (car path)))
567 ;; If not a file then find the file:
568 (or (not (file-directory-p file))
571 (directory-files file t "man.*\\.conf" t))
572 (file-readable-p (setq file (car file)))))
573 ;; Parse the file -- if no MANPATH data ignore it:
575 (insert-file-contents file)
576 (while (re-search-forward
577 ;; `\(?: ... \)' is a "shy group"
579 ^[ \t]*\\(?:MANDATORY_\\|OPTIONAL_\\)?MANPATH[ \t]+\\(\\S-+\\)" nil t)
580 (setq manpath (cons (match-string 1) manpath)))
583 (setq path (cdr path)))
586 (defcustom woman-manpath
587 (or (woman-parse-colon-path (getenv "MANPATH"))
588 '("/usr/man" "/usr/share/man" "/usr/local/man"))
589 "*List of DIRECTORY TREES to search for UN*X manual files.
590 Each element should be the name of a directory that contains
591 subdirectories of the form `man?', or more precisely subdirectories
592 selected by the value of `woman-manpath-man-regexp'. Non-directory
593 and unreadable files are ignored.
595 If not set then the environment variable MANPATH is used. If no such
596 environment variable is found, the default list is determined by
597 consulting the man configuration file if found, which is determined by
598 the user option `woman-man.conf-path'. An empty substring of MANPATH
599 denotes the default list.
601 Any environment variables (names must have the UN*X-style form $NAME,
602 e.g. $HOME, $EMACSDATA, $emacs_dir) are evaluated first but each
603 element must evaluate to a SINGLE directory name. Trailing `/'s are
604 ignored. (Specific directories in `woman-path' are also searched.)
607 I recommend including drive letters explicitly, e.g.
609 (\"C:/Cygwin/usr/man/\" \"C:/Cygwin/usr/local/man\").
611 The MANPATH environment variable may be set using DOS semi-colon-
612 separated or UN*X/Cygwin colon-separated syntax (but not mixed)."
613 :type '(repeat string)
614 :group 'woman-interface)
616 (defcustom woman-manpath-man-regexp "[Mm][Aa][Nn]"
617 "Regexp to match man directories UNDER `woman-manpath' directories.
618 These normally have names of the form `man?'. Its default value is
619 \"[Mm][Aa][Nn]\", which is case-insensitive mainly for the benefit of
620 Microsoft platforms. Its purpose is to avoid `cat?', `.', `..', etc."
621 ;; Based on a suggestion by Wei-Xue Shi.
623 :group 'woman-interface)
625 (defcustom woman-path
626 (if (eq system-type 'ms-dos) '("$DJDIR/info" "$DJDIR/man/cat[1-9onlp]"))
627 "*List of SPECIFIC DIRECTORIES to search for UN*X manual files.
632 These directories are searched in addition to the directory trees
633 specified in `woman-manpath'. Each element should be a directory
634 string or nil, which represents the current directory when the path is
635 expanded and cached. However, the last component (only) of each
636 directory string is treated as a regexp \(Emacs, not shell) and the
637 string is expanded into a list of matching directories. Non-directory
638 and unreadable files are ignored. The default value is nil.
640 Any environment variables (which must have the UN*X-style form $NAME,
641 e.g. $HOME, $EMACSDATA, $emacs_dir) are evaluated first but each
642 element must evaluate to a SINGLE directory name (regexp, see above).
645 (\"$EMACSDATA\") [or equivalently (\"$emacs_dir/etc\")].
647 Trailing `/'s are discarded. (The directory trees in `woman-manpath'
648 are also searched.) On Microsoft platforms I recommend including
649 drive letters explicitly."
650 :type '(repeat (choice string (const nil)))
651 :group 'woman-interface)
653 (defcustom woman-cache-level 2
654 "*The level of topic caching.
655 1 - cache only the topic and directory lists
656 (the only level before version 0.34 - only for compatibility);
657 2 - cache also the directories for each topic
658 (faster, without using much more memory);
659 3 - cache also the actual filenames for each topic
660 (fastest, but uses twice as much memory).
661 The default value is currently 2, a good general compromise.
662 If the `woman' command is slow to find files then try 3, which may be
663 particularly beneficial with large remote-mounted man directories.
664 Run the `woman' command with a prefix argument or delete the cache
665 file `woman-cache-filename' for a change to take effect.
666 \(Values < 1 behave like 1; values > 3 behave like 3.)"
667 :type '(choice (const :tag "Minimal" 1)
668 (const :tag "Default" 2)
669 (const :tag "Maximal" 3))
670 :group 'woman-interface)
672 (defcustom woman-cache-filename nil
673 "*The full pathname of the WoMan directory and topic cache file.
674 It is used to save and restore the cache between sessions. This is
675 especially useful with remote-mounted man page files! The default
676 value of nil suppresses this action. The `standard' non-nil
677 filename is \"~/.wmncach.el\". Remember that a prefix argument forces
678 the `woman' command to update and re-write the cache."
679 :type '(choice (const :tag "None" nil)
680 (const :tag "~/.wmncach.el" "~/.wmncach.el")
682 :group 'woman-interface)
684 (defcustom woman-dired-keys t
685 "*List of `dired' mode keys to define to run WoMan on current file.
686 E.g. '(\"w\" \"W\"), or any non-null atom to automatically define
687 \"w\" and \"W\" if they are unbound, or nil to do nothing.
689 :type '(choice (const :tag "None" nil)
691 (other :tag "Auto" t))
692 :group 'woman-interface)
694 (defcustom woman-imenu-generic-expression
695 '((nil "\n\\([A-Z].*\\)" 1) ; SECTION, but not TITLE
696 ("*Subsections*" "^ \\([A-Z].*\\)" 1))
697 "*Imenu support for Sections and Subsections.
698 An alist with elements of the form (MENU-TITLE REGEXP INDEX) --
699 see the documentation for `imenu-generic-expression'."
701 :group 'woman-interface)
703 (defcustom woman-imenu nil
704 "*If non-nil then WoMan adds a Contents menu to the menubar.
705 It does this by calling `imenu-add-to-menubar'. Default is nil."
707 :group 'woman-interface)
709 (defcustom woman-imenu-title "CONTENTS"
710 "*The title to use if WoMan adds a Contents menu to the menubar.
711 Default is \"CONTENTS\"."
713 :group 'woman-interface)
715 (defcustom woman-topic-at-point-default 'confirm
716 ;; `woman-topic-at-point' may be let-bound when woman is loaded, in
717 ;; which case its global value does not get defined.
718 ;; `woman-file-name' sets it to this value if it is unbound.
719 "*Default value for `woman-topic-at-point'."
720 :type '(choice (const :tag "Yes" t)
721 (const :tag "No" nil)
722 (other :tag "Confirm" confirm))
723 :group 'woman-interface)
725 (defcustom woman-topic-at-point woman-topic-at-point-default
726 "*Controls use by `woman' of `word at point' as a topic suggestion.
727 If non-nil then the `woman' command uses the word at point as an
728 initial topic suggestion when it reads a topic from the minibuffer; if
729 t then the `woman' command uses the word at point WITHOUT
730 INTERACTIVE CONFIRMATION if it exists as a topic. The default value
731 is `confirm', meaning suggest a topic and ask for confirmation."
732 :type '(choice (const :tag "Yes" t)
733 (const :tag "No" nil)
734 (other :tag "Confirm" confirm))
735 :group 'woman-interface)
737 (defvar woman-file-regexp nil
738 "Regexp used to select (possibly compressed) man source files, e.g.
739 \"\\.\\([0-9lmnt]\\w*\\)\\(\\.\\(g?z\\|bz2\\)\\)?\\'\".
740 Built automatically from the customizable user options
741 `woman-uncompressed-file-regexp' and `woman-file-compression-regexp'.")
743 (defvar woman-uncompressed-file-regexp) ; for the compiler
744 (defvar woman-file-compression-regexp) ; for the compiler
746 (defun set-woman-file-regexp (symbol value)
747 "Bind SYMBOL to VALUE and set `woman-file-regexp' as per user customizations.
748 Used as :set cookie by Customize when customizing the user options
749 `woman-uncompressed-file-regexp' and `woman-file-compression-regexp'."
750 (set-default symbol value)
751 (and (boundp 'woman-uncompressed-file-regexp)
752 (boundp 'woman-file-compression-regexp)
753 (setq woman-file-regexp
754 (concat woman-uncompressed-file-regexp
756 (substring woman-file-compression-regexp 0 -2)
759 (defcustom woman-uncompressed-file-regexp
760 "\\.\\([0-9lmnt]\\w*\\)" ; disallow no extension
761 "*Do not change this unless you are sure you know what you are doing!
762 Regexp used to select man source files (ignoring any compression extension).
764 The SysV standard man pages use two character suffixes, and this is
765 becoming more common in the GNU world. For example, the man pages
766 in the ncurses package include `toe.1m', `form.3x', etc.
768 Note: an optional compression regexp will be appended, so this regexp
769 MUST NOT end with any kind of string terminator such as $ or \\'."
771 :set 'set-woman-file-regexp
772 :group 'woman-interface)
774 (defcustom woman-file-compression-regexp
775 "\\.\\(g?z\\|bz2\\)\\'"
776 "*Do not change this unless you are sure you know what you are doing!
777 Regexp used to match compressed man file extensions for which
778 decompressors are available and handled by auto-compression mode,
779 e.g. \"\\\\.\\\\(g?z\\\\|bz2\\\\)\\\\'\" for `gzip' or `bzip2'.
780 Should begin with \\. and end with \\' and MUST NOT be optional."
781 ;; Should be compatible with car of
782 ;; `jka-compr-file-name-handler-entry', but that is unduly
783 ;; complicated, includes an inappropriate extension (.tgz) and is
784 ;; not loaded by default!
786 :set 'set-woman-file-regexp
787 :group 'woman-interface)
789 (defcustom woman-use-own-frame ; window-system
790 (or (and (fboundp 'display-graphic-p) (display-graphic-p)) ; Emacs 21
791 (memq window-system '(x w32))) ; Emacs 20
792 "*If non-nil then use a dedicated frame for displaying WoMan windows.
793 Only useful when run on a graphic display such as X or MS-Windows."
795 :group 'woman-interface)
798 ;; Formatting options
800 (defgroup woman-formatting nil
801 "Formatting options for browsing UNIX manual pages `wo (without) man'."
802 :tag "WoMan Formatting"
805 (defcustom woman-fill-column 65
806 "*Right margin for formatted text -- default is 65."
808 :group 'woman-formatting)
810 (defcustom woman-fill-frame nil
811 ;; Based loosely on a suggestion by Theodore Jump:
812 "*If non-nil then most of the frame width is used."
814 :group 'woman-formatting)
816 (defcustom woman-default-indent 5
817 "*Default prevailing indent set by -man macros -- default is 5.
818 Set this variable to 7 to emulate GNU man formatting."
820 :group 'woman-formatting)
822 (defcustom woman-bold-headings t
823 "*If non-nil then embolden section and subsection headings. Default is t.
824 Heading emboldening is NOT standard `man' behaviour."
826 :group 'woman-formatting)
828 (defcustom woman-ignore t
829 "*If non-nil then unrecognised requests etc. are ignored. Default is t.
830 This gives the standard ?roff behaviour. If nil then they are left in
831 the buffer, which may aid debugging."
833 :group 'woman-formatting)
835 (defcustom woman-preserve-ascii nil
836 "*If non-nil then preserve ASCII characters in the WoMan buffer.
837 Otherwise, non-ASCII characters (that display as ASCII) may remain.
838 This is irrelevant unless the buffer is to be saved to a file."
840 :group 'woman-formatting)
842 (defcustom woman-emulation 'nroff
843 "*WoMan emulation, currently either nroff or troff. Default is nroff.
844 Troff emulation is experimental and largely untested.
846 :type '(choice (const nroff) (const troff))
847 :group 'woman-formatting)
852 (defgroup woman-faces nil
853 "Face options for browsing UNIX manual pages `wo (without) man'."
858 (defcustom woman-fontify
859 (or (and (fboundp 'display-color-p) (display-color-p))
860 (and (fboundp 'display-graphic-p) (display-graphic-p))
862 "*If non-nil then WoMan assumes that face support is available.
863 It defaults to a non-nil value if the display supports either colors
868 ;; This is overkill! Troff uses just italic; Nroff uses just underline.
869 ;; You should probably select either italic or underline as you prefer, but
870 ;; not both, although italic and underline work together perfectly well!
871 (defface woman-italic-face
872 `((((background light)) (:slant italic :underline t :foreground "red"))
873 (((background dark)) (:slant italic :underline t)))
874 "Face for italic font in man pages."
877 (defface woman-bold-face
878 '((((background light)) (:weight bold :foreground "blue"))
879 (((background dark)) (:weight bold :foreground "green2")))
880 "Face for bold font in man pages."
883 ;; Brown is a good compromise: it is distinguishable from the default
884 ;; but not enough so to make font errors look terrible. (Files that use
885 ;; non-standard fonts seem to do so badly or in idiosyncratic ways!)
886 (defface woman-unknown-face
887 '((((background light)) (:foreground "brown"))
888 (((background dark)) (:foreground "cyan")))
889 "Face for all unknown fonts in man pages."
892 (defface woman-addition-face
893 '((t (:foreground "orange")))
894 "Face for all WoMan additions to man pages."
897 (defun woman-default-faces ()
898 "Set foreground colours of italic and bold faces to their default values."
900 (face-spec-set 'woman-italic-face
901 (face-user-default-spec 'woman-italic-face))
902 (face-spec-set 'woman-bold-face (face-user-default-spec 'woman-bold-face)))
904 (defun woman-monochrome-faces ()
905 "Set foreground colours of italic and bold faces to that of the default face.
906 This is usually either black or white."
908 (set-face-foreground 'woman-italic-face 'unspecified)
909 (set-face-foreground 'woman-bold-face 'unspecified))
911 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
912 ;; Experimental font support, initially only for MS-Windows.
913 (defconst woman-font-support
914 (eq window-system 'w32) ; Support X later!
915 "If non-nil then non-ASCII characters and symbol font supported.")
917 (defun woman-select-symbol-fonts (fonts)
918 "Select symbol fonts from a list FONTS of font name strings."
920 ;; With NTEmacs 20.5, the PATTERN option to `x-list-fonts' does
921 ;; not seem to work and fonts may be repeated, so ...
923 (and (string-match "-Symbol-" (car fonts))
924 (not (member (car fonts) symbol-fonts))
925 (setq symbol-fonts (cons (car fonts) symbol-fonts)))
926 (setq fonts (cdr fonts)))
929 (when woman-font-support
930 (make-face 'woman-symbol-face)
932 ;; Set the symbol font only if `woman-use-symbol-font' is true, to
933 ;; avoid unnecessarily upsetting the line spacing in NTEmacs 20.5!
935 (defcustom woman-use-extended-font t
936 "*If non-nil then may use non-ASCII characters from the default font."
940 (defcustom woman-use-symbol-font nil
941 "*If non-nil then may use the symbol font. It is off by default,
942 mainly because it may change the line spacing (in NTEmacs 20.5)."
946 (defconst woman-symbol-font-list
947 (or (woman-select-symbol-fonts (x-list-fonts "*" 'default))
948 (woman-select-symbol-fonts (x-list-fonts "*")))
949 "Symbol font(s), preferably same size as default when WoMan was loaded.")
951 (defcustom woman-symbol-font (car woman-symbol-font-list)
952 "*A string describing the symbol font to use for special characters.
953 It should be compatible with, and the same size as, the default text font.
954 Under MS-Windows, the default is
955 \"-*-Symbol-normal-r-*-*-*-*-96-96-p-*-ms-symbol\"."
957 ,@(mapcar (lambda (x) (list 'const x))
958 woman-symbol-font-list)
964 ;; For non windows-nt ...
965 (defvar woman-use-extended-font nil)
966 (defvar woman-use-symbol-font nil)
967 (defvar woman-symbol-font nil)
968 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
971 ;;; Internal variables:
973 (defconst woman-justify-list
974 '(left right center full)
975 "Justify styles for `fill-region-as-paragraph'.")
976 (defconst woman-adjust-left 0 ; == adjust off, noadjust
977 "Adjustment indicator `l' -- adjust left margin only.")
978 (defconst woman-adjust-right 1
979 "Adjustment indicator `r' -- adjust right margin only.")
980 (defconst woman-adjust-center 2
981 "Adjustment indicator `c' -- center.")
982 (defconst woman-adjust-both 3 ; default -- adj,both
983 "Adjustment indicator `b' or `n' -- adjust both margins.")
985 (defvar woman-adjust woman-adjust-both
986 "Current adjustment number-register value.")
987 (defvar woman-adjust-previous woman-adjust
988 "Previous adjustment number-register value.")
989 (defvar woman-justify
990 (nth woman-adjust woman-justify-list) ; use vector?
991 "Current justification style for `fill-region-as-paragraph'.")
992 (defvar woman-justify-previous woman-justify
993 "Previous justification style for `fill-region-as-paragraph'.")
995 (defvar woman-left-margin woman-default-indent
996 "Current left margin.")
997 (defvar woman-prevailing-indent woman-default-indent
998 "Current prevailing indent.")
999 (defvar woman-interparagraph-distance 1
1000 "Interparagraph distance in lines.
1001 Set by .PD; used by .SH, .SS, .TP, .LP, .PP, .P, .IP, .HP.")
1002 (defvar woman-leave-blank-lines nil
1003 "Blank lines to leave as vertical space.")
1004 (defconst woman-tab-width 5
1005 "Default tab width set by -man macros.")
1006 (defvar woman-nofill nil
1007 "Current fill mode: nil for filling.")
1008 (defvar woman-RS-left-margin nil
1009 "Left margin stack for nested use of `.RS/.RE'.")
1010 (defvar woman-RS-prevailing-indent nil
1011 "Prevailing indent stack for nested use of `.RS/.RE'.")
1012 (defvar woman-nospace nil
1013 "Current no-space mode: nil for normal spacing.
1014 Set by `.ns' request; reset by any output or `.rs' request")
1016 (defsubst woman-reset-nospace ()
1017 "Set `woman-nospace' to nil."
1018 (setq woman-nospace nil))
1020 (defconst woman-mode-line-format
1021 ;; This is essentially the Man-mode format with page numbers removed
1022 ;; and line numbers added. (Online documents do not have pages, but
1023 ;; they do have lines!)
1024 '("-" mode-line-mule-info mode-line-modified
1025 mode-line-frame-identification mode-line-buffer-identification
1026 " " global-mode-string
1027 " %[(WoMan" mode-line-process minor-mode-alist ")%]--"
1028 (line-number-mode "L%l--")
1030 "Mode line format for WoMan buffer.")
1032 (defconst woman-request-regexp "^[.'][ \t]*\\(\\S +\\) *"
1033 ;; Was "^\\.[ \t]*\\([a-z0-9]+\\) *" but cvs.1 uses a macro named
1034 ;; "`" and CGI.man uses a macro named "''"!
1035 ;; CGI.man uses ' as control character in places -- it *should*
1037 ;; Could end with "\\( +\\|$\\)" instead of " *"
1038 "Regexp to match a ?roff request plus trailing white space.")
1040 (defvar woman-imenu-done nil
1041 "Buffer-local: set to true if function `woman-imenu' has been called.")
1042 (make-variable-buffer-local 'woman-imenu-done)
1044 ;; From imenu.el -- needed when reformatting a file in its old buffer.
1045 ;; The latest buffer index used to update the menu bar menu.
1048 (make-variable-buffer-local 'imenu--last-menubar-index-alist)
1050 (defvar woman-buffer-alist nil
1051 "An alist representing WoMan buffers that are already decoded.
1052 Each element is of the form (FILE-NAME . BUFFER-NAME).")
1054 (defvar woman-buffer-number 0
1055 "Ordinal number of current buffer entry in `woman-buffer-alist'.
1056 The ordinal numbers start from 0.")
1058 (defvar woman-if-conditions-true '(?n ?e ?o)
1059 "List of one-character built-in condition names that are true.
1060 Should include ?e, ?o (page even/odd) and either ?n (nroff) or ?t (troff).
1061 Default is '(?n ?e ?o). Set via `woman-emulation'.")
1064 ;;; Specialized utility functions:
1066 ;;; Fast deletion without saving on the kill ring (cf. simple.el):
1068 (defun woman-delete-line (&optional arg)
1069 "Delete rest of current line; if all blank then delete thru newline.
1070 With a numeric argument ARG, delete that many lines from point.
1071 Negative arguments delete lines backward."
1072 ;; This is a non-interactive version of kill-line in simple.el that
1073 ;; deletes instead of killing and assumes kill-whole-line is nil,
1074 ;; which is essential!
1075 (delete-region (point)
1080 (signal 'end-of-buffer nil))
1081 (if (looking-at "[ \t]*$")
1086 (defsubst woman-delete-whole-line ()
1087 "Delete current line from beginning including eol."
1089 (woman-delete-line 1))
1091 (defsubst woman-delete-following-space ()
1092 "Delete all spaces and tabs FOLLOWING point (cf. `delete-horizontal-space')."
1093 ;; cf. delete-horizontal-space in simple.el:
1094 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
1096 (defsubst woman-delete-match (subexp)
1097 "Delete subexpression SUBEXP of buffer text matched by last search."
1098 (delete-region (match-beginning subexp) (match-end subexp)))
1100 ;; delete-char does not kill by default
1101 ;; delete-backward-char does not kill by default
1102 ;; delete-horizontal-space does not kill
1103 ;; delete-blank-lines does not kill
1108 (defvar woman-expanded-directory-path nil
1109 "Expanded directory list cache. Resetting to nil forces update.")
1111 (defvar woman-topic-all-completions nil
1112 "Expanded topic alist cache. Resetting to nil forces update.")
1115 (defun woman (&optional topic re-cache)
1116 "Browse UN*X man page for TOPIC (Without using external Man program).
1117 The major browsing mode used is essentially the standard Man mode.
1118 Choose the filename for the man page using completion, based on the
1119 topic selected from the directories specified in `woman-manpath' and
1120 `woman-path'. The directory expansions and topics are cached for
1121 speed, but a non-nil interactive argument forces the caches to be
1122 updated (e.g. to re-interpret the current directory).
1124 Used non-interactively, arguments are optional: if given then TOPIC
1125 should be a topic string and non-nil RE-CACHE forces re-caching."
1126 (interactive (list nil current-prefix-arg))
1127 ;; The following test is for non-interactive calls via gnudoit etc.
1128 (if (or (interactive-p) (not (stringp topic)) (string-match "\\S " topic))
1129 (let ((file-name (woman-file-name topic re-cache)))
1131 (woman-find-file file-name)
1133 "WoMan Error: No matching manual files found in search path")
1136 (message "WoMan Error: No topic specified in non-interactive call")
1140 ;; Allow WoMan to be called via the standard Help menu:
1141 (define-key-after menu-bar-manuals-menu [woman]
1142 '(menu-item "Read Man Page (WoMan)..." woman
1143 :help "Man-page documentation Without Man") t)
1145 (defvar woman-cached-data nil
1146 "A list of cached data used to determine cache validity.
1147 Set from the cache by `woman-read-directory-cache'.")
1149 (defun woman-cached-data ()
1150 "Generate a list of data used to determine cache validity.
1151 Called both to generate and to check the cache!"
1152 ;; Must use substituted paths because values of env vars may change!
1153 (list woman-cache-level
1154 (mapcar 'substitute-in-file-name woman-manpath)
1155 (mapcar 'substitute-in-file-name woman-path)))
1157 (defun woman-read-directory-cache ()
1158 "Load the directory and topic cache.
1159 It is loaded from the file named by the variable `woman-cache-filename'.
1160 Return t if the file exists, nil otherwise."
1162 woman-cache-filename
1163 (load woman-cache-filename t nil t) ; file exists
1164 (equal woman-cached-data (woman-cached-data)))) ; cache valid
1166 (defun woman-write-directory-cache ()
1167 "Save the directory and topic cache.
1168 It is saved to the file named by the variable `woman-cache-filename'."
1169 (if woman-cache-filename
1170 (save-excursion ; to restore current buffer
1171 ;; Make a temporary buffer; name starting with space "hides" it.
1172 (let ((standard-output
1173 (set-buffer (generate-new-buffer "WoMan tmp buffer")))
1174 (backup-inhibited t))
1175 ;; (switch-to-buffer standard-output t) ; only for debugging
1176 (buffer-disable-undo standard-output)
1178 ";;; WoMan directory and topic cache -- generated automatically\n")
1180 ;; For data validity check:
1181 `(setq woman-cached-data ',(woman-cached-data)))
1183 `(setq woman-expanded-directory-path
1184 ',woman-expanded-directory-path))
1186 `(setq woman-topic-all-completions
1187 ',woman-topic-all-completions))
1188 (write-file woman-cache-filename) ; write CURRENT buffer
1189 (kill-buffer standard-output)
1192 (defvar woman-topic-history nil "Topic read history.")
1193 (defvar woman-file-history nil "File-name read history.")
1195 (defun woman-file-name (topic &optional re-cache)
1196 "Get the name of the UN*X man-page file describing a chosen TOPIC.
1197 When `woman' is called interactively, the word at point may be used as
1198 the topic or initial topic suggestion, subject to the value of the
1199 user option `woman-topic-at-point'. Return nil if no file can be found.
1200 Optional argument RE-CACHE, if non-nil, forces the cache to be re-read."
1201 ;; Handle the caching of the directory and topic lists:
1202 (if (and (not re-cache)
1204 (and woman-expanded-directory-path woman-topic-all-completions)
1205 (woman-read-directory-cache)))
1207 (message "Building list of manual directory expansions...")
1208 (setq woman-expanded-directory-path
1209 (woman-expand-directory-path woman-manpath woman-path))
1210 (message "Building completion list of all manual topics...")
1211 (setq woman-topic-all-completions
1212 (woman-topic-all-completions woman-expanded-directory-path))
1213 (woman-write-directory-cache))
1214 ;; There is a problem in that I want to offer case-insensitive
1215 ;; completions, but to return only a case-sensitive match. This
1216 ;; does not seem to work properly by default, so I re-do the
1217 ;; completion if necessary.
1221 (if (boundp 'woman-topic-at-point)
1222 woman-topic-at-point
1223 ;; Was let-bound when file loaded, so ...
1224 (setq woman-topic-at-point woman-topic-at-point-default)))
1226 (or (current-word t) "")) ; only within or adjacent to word
1227 (assoc topic woman-topic-all-completions))
1231 woman-topic-all-completions nil 1
1232 ;; Initial input suggestion (was nil), with
1233 ;; cursor at left ready to kill suggestion!:
1234 (and woman-topic-at-point
1235 (cons (or (current-word) "") 0)) ; nearest word
1236 'woman-topic-history)))
1237 ;; Note that completing-read always returns a string.
1238 (if (= (length topic) 0)
1239 nil ; no topic, so no file!
1241 ((setq files (woman-file-name-all-completions topic)))
1242 ;; Complete topic more carefully, i.e. use the completion
1243 ;; rather than the string entered by the user:
1244 ((setq files (all-completions topic woman-topic-all-completions))
1245 (while (/= (length topic) (length (car files)))
1246 (setq files (cdr files)))
1247 (setq files (woman-file-name-all-completions (car files)))))
1249 ((null files) nil) ; no file found for topic.
1250 ((null (cdr files)) (car (car files))) ; only 1 file for topic.
1252 ;; Multiple files for topic, so must select 1.
1253 ;; Unread the command event (TAB = ?\t = 9) that runs the command
1254 ;; `minibuffer-complete' in order to automatically complete the
1255 ;; minibuffer contents as far as possible.
1256 (setq unread-command-events '(9)) ; and delete any type-ahead!
1257 (completing-read "Manual file: " files nil 1
1258 (try-completion "" files) 'woman-file-history)))
1261 (defun woman-select (predicate list)
1262 "Select unique elements for which PREDICATE is true in LIST.
1263 \(Note that this function changes the value of LIST.)"
1264 ;; Intended to be fast by avoiding recursion and list copying.
1267 (member (car list) (cdr list))
1268 (not (funcall predicate (car list)))))
1269 (setq list (cdr list)))
1271 (let ((newlist list) cdr_list)
1272 (while (setq cdr_list (cdr list))
1274 (not (member (car cdr_list) (cdr cdr_list)))
1275 (funcall predicate (car cdr_list)))
1276 (setq list cdr_list)
1277 (setcdr list (cdr cdr_list)))
1281 (defun woman-file-readable-p (dir)
1282 "Return t if DIR is readable, otherwise log a warning."
1283 (or (file-readable-p dir)
1284 (WoMan-warn "Ignoring unreadable `manpath' directory tree `%s'!" dir)))
1286 (defun woman-directory-files (head dir)
1287 "Return a sorted list of files in directory HEAD matching regexp in DIR.
1288 Value is a sorted list of the absolute pathnames of all the files in
1289 directory HEAD, or the current directory if HEAD is nil, that match the
1290 regexp that is the final component of DIR. Log a warning if list is empty."
1291 (or (directory-files
1292 (or head (directory-file-name default-directory)) ; was "."
1294 (file-name-nondirectory dir))
1295 (WoMan-warn "No directories match `woman-path' entry `%s'!" dir)))
1297 (defun woman-file-accessible-directory-p (dir)
1298 "Return t if DIR is accessible, otherwise log a warning."
1299 (or (file-accessible-directory-p dir)
1300 (WoMan-warn "Ignoring inaccessible `man-page' directory `%s'!" dir)))
1302 (defun woman-expand-directory-path (woman-manpath woman-path)
1303 "Expand the manual directories in WOMAN-MANPATH and WOMAN-PATH.
1304 WOMAN-MANPATH should be a list of general manual directories, while
1305 WOMAN-PATH should be a list of specific manual directory regexps.
1306 Ignore any paths that are unreadable or not directories."
1307 ;; Allow each path to be a single string or a list of strings:
1308 (if (not (listp woman-manpath)) (setq woman-manpath (list woman-manpath)))
1309 (if (not (listp woman-path)) (setq woman-path (list woman-path)))
1310 (let (dir head dirs)
1311 (while woman-manpath
1312 (setq dir (car woman-manpath)
1313 woman-manpath (cdr woman-manpath))
1314 (if (and dir (woman-file-readable-p dir))
1315 ;; NB: `parse-colon-path' creates null elements for
1316 ;; redundant (semi-)colons and trailing `/'s!
1317 ;; If does not actually matter here if dir ends with `/'.
1318 ;; Need regexp "man" here to avoid "cat?", `.', `..', etc.
1319 (setq dir (woman-canonicalize-dir dir)
1320 dirs (nconc dirs (directory-files
1321 dir t woman-manpath-man-regexp)))))
1323 (setq dir (car woman-path)
1324 woman-path (cdr woman-path))
1326 (null (setq dir (woman-canonicalize-dir dir)
1327 head (file-name-directory dir)))
1328 (woman-file-readable-p head))
1331 (nconc dirs (woman-directory-files head dir))
1332 (cons (directory-file-name default-directory) dirs))
1333 ;; was "." -- at head of list for later filtering
1335 (woman-select 'woman-file-accessible-directory-p dirs)))
1337 (defun woman-canonicalize-dir (dir)
1338 "Canonicalize the directory name DIR.
1339 Any UN*X-style environment variables are evaluated first."
1340 (setq dir (expand-file-name (substitute-in-file-name dir)))
1341 ;; A path that ends with / matches all directories in it,
1342 ;; including `.' and `..', so remove any trailing / !!!
1343 (if (string= (substring dir -1) "/")
1344 (setq dir (substring dir 0 -1)))
1345 (if (memq system-type '(windows-nt ms-dos cygwin)) ; what else?
1346 ;; Match capitalization used by `file-name-directory':
1347 (setq dir (concat (file-name-directory dir)
1348 (file-name-nondirectory dir))))
1351 (defsubst woman-not-member (dir path)
1352 "Return t if DIR is not a member of the list PATH, nil otherwise.
1353 If DIR is `.' it is first replaced by the current directory."
1354 (not (member dir path)))
1356 (defun woman-topic-all-completions (path)
1357 "Return an alist of the man files in all man directories in the list PATH.
1358 The cdr of each alist element is the path-index / filename."
1359 ;; Support 3 levels of caching: each element of the alist `files'
1360 ;; will be a list of the first `woman-cache-level' elements of the
1361 ;; following list: (topic path-index filename). This alist `files'
1362 ;; is re-processed by `woman-topic-all-completions-merge'.
1363 (let (dir files (path-index 0)) ; indexing starts at zero
1365 (setq dir (car path)
1367 (if (woman-not-member dir path) ; use each directory only once!
1370 (woman-topic-all-completions-1 dir path-index))))
1371 (setq path-index (1+ path-index)))
1373 (woman-topic-all-completions-merge files)))
1375 (defun woman-topic-all-completions-1 (dir path-index)
1376 "Return an alist of the man topics in directory DIR with index PATH-INDEX.
1377 A topic is a filename sans type-related extensions.
1378 Support 3 levels of caching: each element of the alist will be a list
1379 of the first `woman-cache-level' elements from the following list:
1380 \(topic path-index filename)."
1381 ;; This function used to check that each file in the directory was
1382 ;; not itself a directory, but this is very slow and should be
1383 ;; unnecessary. So let us assume that `woman-file-regexp' will
1384 ;; filter out any directories, which probably should not be there
1385 ;; anyway, i.e. it is a user error!
1389 (file-name-sans-extension
1390 (if (string-match woman-file-compression-regexp file)
1391 (file-name-sans-extension file)
1393 (if (> woman-cache-level 1)
1396 (if (> woman-cache-level 2)
1397 (cons file nil))))))
1398 (directory-files dir nil woman-file-regexp)))
1400 (defun woman-topic-all-completions-merge (alist)
1401 "Merge the alist ALIST so that the keys are unique.
1402 Also make each path-info component into a list.
1403 \(Note that this function changes the value of ALIST.)"
1404 ;; Intended to be fast by avoiding recursion and list copying.
1405 (if (> woman-cache-level 1)
1406 (let ((newalist alist))
1408 (let ((tail newalist) (topic (car (car newalist))))
1409 ;; Make the path-info into a list:
1410 (setcdr (car newalist) (list (cdr (car newalist))))
1412 (while (and tail (not (string= topic (car (car (cdr tail))))))
1413 (setq tail (cdr tail)))
1414 (if tail ; merge path-info into (car newalist)
1415 (let ((path-info (cdr (car (cdr tail)))))
1416 (if (member path-info (cdr (car newalist)))
1418 ;; Make the path-info into a list:
1419 (nconc (car newalist) (list path-info)))
1420 (setcdr tail (cdr (cdr tail))))
1422 (setq newalist (cdr newalist))))
1424 ;; woman-cache-level = 1 => elements are single-element lists ...
1425 (while (and alist (member (car alist) (cdr alist)))
1426 (setq alist (cdr alist)))
1428 (let ((newalist alist) cdr_alist)
1429 (while (setq cdr_alist (cdr alist))
1430 (if (not (member (car cdr_alist) (cdr cdr_alist)))
1431 (setq alist cdr_alist)
1432 (setcdr alist (cdr cdr_alist)))
1436 (defun woman-file-name-all-completions (topic)
1437 "Return an alist of the files in all man directories that match TOPIC."
1438 ;; Support 3 levels of caching: each element of
1439 ;; woman-topic-all-completions is a list of one of the forms:
1441 ;; (topic (path-index) (path-index) ... )
1442 ;; (topic (path-index filename) (path-index filename) ... )
1443 ;; where the are no duplicates in the value lists.
1444 ;; Topic must match first `word' of filename, so ...
1447 "\\`" (regexp-quote topic) ; first `word'
1448 "\\(\\..+\\)*" ; optional subsequent `words'
1449 woman-file-regexp)) ; extension
1450 (topics woman-topic-all-completions)
1451 (path woman-expanded-directory-path)
1453 (if (cdr (car topics))
1454 ;; Use cached path-info to locate files for each topic:
1455 (let ((path-info (cdr (assoc topic topics)))
1458 (setq dir (nth (car (car path-info)) path)
1459 filename (car (cdr (car path-info)))
1460 path-info (cdr path-info)
1462 ;; Find the actual file name:
1464 (list (concat dir "/" filename))
1465 (directory-files dir t topic-regexp)
1467 ;; Search path for the files for each topic:
1469 (setq dir (car path)
1471 (if (woman-not-member dir path) ; use each directory only once!
1472 (setq files (nconc files
1473 (directory-files dir t topic-regexp))))
1475 (mapcar 'list files)
1481 (defun woman-dired-define-key (key)
1482 "Bind the argument KEY to the command `woman-dired-find-file'."
1483 (define-key dired-mode-map key 'woman-dired-find-file))
1485 (defsubst woman-dired-define-key-maybe (key)
1486 "If KEY is undefined in Dired, bind it to command `woman-dired-find-file'."
1487 (if (eq (lookup-key dired-mode-map key) 'undefined)
1488 (woman-dired-define-key key)))
1490 (defun woman-dired-define-keys ()
1491 "Define dired keys to run WoMan according to `woman-dired-keys'."
1492 (if woman-dired-keys
1493 (if (listp woman-dired-keys)
1494 (mapcar 'woman-dired-define-key woman-dired-keys)
1495 (woman-dired-define-key-maybe "w")
1496 (woman-dired-define-key-maybe "W")))
1497 (define-key-after (lookup-key dired-mode-map [menu-bar immediate])
1498 [woman] '("Read Man Page (WoMan)" . woman-dired-find-file) 'view))
1500 (if (featurep 'dired)
1501 (woman-dired-define-keys)
1502 (add-hook 'dired-mode-hook 'woman-dired-define-keys))
1505 (defun woman-dired-find-file ()
1506 "In dired, run the WoMan man-page browser on this file."
1508 ;; dired-get-filename is defined in dired.el
1509 (woman-find-file (dired-get-filename)))
1512 ;;; tar-mode support
1514 (defun woman-tar-extract-file ()
1515 "In tar mode, run the WoMan man-page browser on this file."
1517 (or (eq major-mode 'tar-mode)
1518 (error "`woman-tar-extract-file' can be used only in `tar-mode'"))
1519 (buffer-disable-undo)
1520 (let (global-font-lock-mode)
1521 (funcall (symbol-function 'tar-extract)) ; defined in tar-mode
1522 (let ((WoMan-current-file buffer-file-name)) ; used for message logging
1524 (woman-make-bufname (file-name-nondirectory buffer-file-name)))
1525 (woman-process-buffer)
1526 (goto-char (point-min)))))
1528 ;; There is currently no `tar-mode-hook' so use ...
1529 (eval-after-load "tar-mode"
1531 (define-key tar-mode-map "w" 'woman-tar-extract-file)
1532 (define-key-after (lookup-key tar-mode-map [menu-bar immediate])
1533 [woman] '("Read Man Page (WoMan)" . woman-tar-extract-file) 'view)))
1536 (defvar woman-last-file-name nil
1537 "The full pathname of the last file formatted by WoMan.")
1539 (defun woman-reformat-last-file ()
1540 "Reformat last file, e.g. after changing fill column."
1542 (if woman-last-file-name
1543 (woman-find-file woman-last-file-name t)
1544 (call-interactively 'woman-find-file)))
1547 (defun woman-find-file (file-name &optional reformat)
1548 "Find, decode and browse a specific UN*X man-page source file FILE-NAME.
1549 Use existing buffer if possible; reformat only if prefix arg given.
1550 When called interactively, optional argument REFORMAT forces reformatting
1551 of an existing WoMan buffer formatted earlier.
1552 No external programs are used, except that `gunzip' will be used to
1553 decompress the file if appropriate. See the documentation for the
1554 `woman' command for further details."
1555 (interactive "fBrowse UN*X manual file: \nP")
1556 (setq woman-last-file-name
1557 (setq file-name (expand-file-name file-name))) ; to canonicalize
1558 (let ((alist-tail woman-buffer-alist) exists)
1559 (setq woman-buffer-number 0)
1560 (while (and alist-tail (not (string= file-name (car (car alist-tail)))))
1561 (setq alist-tail (cdr alist-tail)
1562 woman-buffer-number (1+ woman-buffer-number)))
1563 (or (and (setq exists
1564 (and alist-tail (WoMan-find-buffer))) ; buffer exists
1566 ;; Format new buffer or reformat current buffer:
1567 (let* ((bufname (file-name-nondirectory file-name))
1568 (case-fold-search t)
1570 (not (not (string-match woman-file-compression-regexp bufname)))))
1572 (setq bufname (file-name-sans-extension bufname)))
1573 (setq bufname (if exists
1575 (woman-make-bufname bufname)))
1576 (woman-really-find-file file-name compressed bufname)
1578 (setq woman-buffer-alist
1579 (cons (cons file-name bufname) woman-buffer-alist)
1580 woman-buffer-number 0))
1582 (Man-build-section-alist)
1583 (Man-build-references-alist)
1584 (goto-char (point-min)))
1586 (defun woman-make-bufname (bufname)
1587 "Create an unambiguous buffer name from BUFNAME."
1588 (let ((dot (string-match "\\." bufname)))
1589 (if dot (setq bufname (concat
1590 (substring bufname (1+ dot)) " "
1591 (substring bufname 0 dot))))
1592 (generate-new-buffer-name ; ensure uniqueness
1593 (concat "*WoMan " bufname "*"))))
1595 (defvar woman-frame nil
1596 "Dedicated frame used for displaying WoMan windows.")
1598 (defun woman-really-find-file (filename compressed bufname)
1599 "Find, decompress, and decode a UN*X man page FILENAME.
1600 If COMPRESSED is non-nil, turn on auto-compression mode to decompress
1601 the file if necessary. Set buffer name BUFNAME and major mode.
1602 Do not call directly!"
1603 (let ((WoMan-current-file filename)) ; used for message logging
1604 (if woman-use-own-frame
1606 (or (and (frame-live-p woman-frame) woman-frame)
1607 (setq woman-frame (make-frame)))))
1608 (switch-to-buffer (get-buffer-create bufname))
1609 (buffer-disable-undo)
1610 (setq buffer-read-only nil)
1611 (erase-buffer) ; NEEDED for reformat
1612 (woman-insert-file-contents filename compressed)
1613 ;; Set buffer's default directory to that of the file.
1614 (setq default-directory (file-name-directory filename))
1615 (set (make-local-variable 'backup-inhibited) t)
1616 (set-visited-file-name "")
1617 (woman-process-buffer)))
1619 (defun woman-process-buffer ()
1620 "The second half of `woman-really-find-file'!"
1622 ;; Check (crudely) that this really is likely to be in UN*X
1623 ;; man-page source format, assuming we are at point-min:
1624 (goto-char (point-min))
1625 (if (re-search-forward "^[.']" 1000 t)
1626 (woman-decode-buffer)
1628 "File appears to be pre-formatted -- using source file may be better.")
1632 (defun woman-man-buffer ()
1633 "Post-process an nroff-preformatted man buffer."
1634 ;; Kill all leading whitespace:
1635 (if (looking-at "\\s-+") (woman-delete-match 0))
1636 ;; Delete all page footer/header pairs:
1637 (re-search-forward ".*") ; match header
1638 ;; Footer conventionally has page number at right, so ...
1639 (let ((regex (concat
1640 "^.*[0-9]\n\\s-*" ; footer and following blank lines
1641 (regexp-quote (match-string 0)) ; header
1642 "\\s-*\n"))) ; following blank lines
1643 (while (re-search-forward regex nil 1) ; finish at eob
1644 (woman-delete-match 0)))
1645 ;; Delete last text line (footer) and all following blank lines:
1646 (re-search-backward "\\S-")
1648 (if (looking-at ".*[0-9]$")
1649 (delete-region (point) (point-max)))
1651 ;; Squeeze multiple blank lines:
1652 (goto-char (point-min))
1653 (while (re-search-forward "^[ \t]*\n\\([ \t]*\n\\)+" nil t)
1654 (replace-match "\n" t t))
1656 ;; CJK characters are underlined by double-sized "__".
1657 ;; (Code lifted from man.el, with trivial changes.)
1658 (if (< (buffer-size) (position-bytes (point-max)))
1659 ;; Multibyte characters exist.
1661 (goto-char (point-min))
1662 (while (search-forward "__\b\b" nil t)
1663 (backward-delete-char 4)
1664 (woman-set-face (point) (1+ (point)) 'woman-italic-face))
1665 (goto-char (point-min))
1666 (while (search-forward "\b\b__" nil t)
1667 (backward-delete-char 4)
1668 (woman-set-face (1- (point)) (point) 'woman-italic-face))))
1670 ;; Interpret overprinting to indicate bold face:
1671 (goto-char (point-min))
1672 (while (re-search-forward "\\(.\\)\\(\\(
\b+\\1\\)+\\)" nil t)
1673 (woman-delete-match 2)
1674 (woman-set-face (1- (point)) (point) 'woman-bold-face))
1676 ;; Interpret underlining to indicate italic face:
1677 ;; (Must be AFTER emboldening to interpret bold _ correctly!)
1678 (goto-char (point-min))
1679 (while (search-forward "_
\b" nil t)
1681 (woman-set-face (point) (1+ (point)) 'woman-italic-face))
1683 ;; Leave any other uninterpreted ^H's in the buffer for now! (They
1684 ;; might indicate composite special characters, which could be
1685 ;; interpreted if I knew what to expect.)
1687 ;; Optionally embolden section and subsection headings
1688 ;; (cf. `woman-imenu-generic-expression'):
1690 (woman-bold-headings
1691 (goto-char (point-min))
1693 (while (re-search-forward "^\\( \\)?\\([A-Z].*\\)" nil t)
1694 (woman-set-face (match-beginning 2) (match-end 2) 'woman-bold-face))))
1697 (defun woman-insert-file-contents (filename compressed)
1698 "Insert file FILENAME into the current buffer.
1699 If COMPRESSED is t, or is non-nil and the filename implies compression,
1700 then turn on auto-compression mode to decompress the file.
1701 Leave point at end of new text. Return length of inserted text."
1702 ;; Leaves point at end of inserted text in GNU Emacs 20.3, but at
1705 (let ((case-fold-search t))
1706 ;; Co-operate with auto-compression mode:
1708 (or (eq compressed t)
1709 (string-match woman-file-compression-regexp filename))
1710 ;; (not auto-compression-mode)
1711 (not (rassq 'jka-compr-handler file-name-handler-alist)) )
1712 ;; (error "Compressed file requires Auto File Decompression turned on")
1713 (auto-compression-mode 1))
1716 (insert-file-contents filename nil)
1718 ;; Run find-file-not-found-hooks until one returns non-nil.
1719 ;; (run-hook-with-args-until-success 'find-file-not-found-hooks)
1720 (insert "\n***** File " filename " not found! *****\n\n")
1725 ;;; Major mode (Man) interface:
1727 (defvar woman-mode-map nil "Keymap for woman mode.")
1731 ;; Set up the keymap, mostly inherited from Man-mode-map. Normally
1732 ;; button-buffer-map is used as a parent keymap, but we can't have two
1733 ;; parents, so we just copy it.
1734 (setq woman-mode-map (copy-keymap button-buffer-map))
1735 (set-keymap-parent woman-mode-map Man-mode-map)
1736 ;; Above two lines were
1737 ;; (setq woman-mode-map (cons 'keymap Man-mode-map))
1738 (define-key woman-mode-map "R" 'woman-reformat-last-file)
1739 (define-key woman-mode-map "w" 'woman)
1740 (define-key woman-mode-map "\en" 'WoMan-next-manpage)
1741 (define-key woman-mode-map "\ep" 'WoMan-previous-manpage)
1742 (define-key woman-mode-map [M-mouse-2] 'woman-follow-word))
1744 (defun woman-follow-word (event)
1745 "Run WoMan with word under mouse as topic.
1746 Argument EVENT is the invoking mouse event."
1747 (interactive "e") ; mouse event
1748 (goto-char (posn-point (event-start event)))
1749 (woman (or (current-word t) "")))
1751 ;; WoMan menu bar and pop-up menu:
1753 woman-menu ; (SYMBOL MAPS DOC MENU)
1754 ;; That comment was moved after the symbol `woman-menu' to make
1755 ;; find-function-search-for-symbol work. -- rost
1759 ["WoMan..." woman t] ; [NAME CALLBACK ENABLE]
1761 ["Next Section" Man-next-section t]
1762 ["Previous Section" Man-previous-section t]
1763 ["Goto Section..." Man-goto-section t]
1764 ["Goto See-Also Section" Man-goto-see-also-section t]
1765 ["Follow Reference..." Man-follow-manual-reference t]
1767 ["Previous WoMan Buffer" WoMan-previous-manpage t]
1768 ["Next WoMan Buffer" WoMan-next-manpage t]
1769 ["Bury WoMan Buffer" Man-quit t]
1770 ["Kill WoMan Buffer" Man-kill t]
1772 ;; ["Toggle Fill Frame Width" woman-toggle-fill-frame t]
1773 ["Use Full Frame Width" woman-toggle-fill-frame
1774 :active t :style toggle :selected woman-fill-frame]
1775 ["Reformat Last Man Page" woman-reformat-last-file t]
1776 ["Use Monochrome Main Faces" woman-monochrome-faces t]
1777 ["Use Default Main Faces" woman-default-faces t]
1778 ["Make Contents Menu" (woman-imenu t) (not woman-imenu-done)]
1780 ["Describe (Wo)Man Mode" describe-mode t]
1781 ["Mini Help" woman-mini-help t]
1782 ,@(if (fboundp 'customize-group)
1783 '(["Customize..." (customize-group 'woman) t]))
1784 ["Show Version" (message "WoMan %s" woman-version) t]
1787 ["View Source" (view-file woman-last-file-name) woman-last-file-name]
1788 ["Show Log" (switch-to-buffer-other-window "*WoMan-Log*" t) t]
1789 ["Extended Font" woman-toggle-use-extended-font
1790 :included woman-font-support
1791 :active t :style toggle :selected woman-use-extended-font]
1792 ["Symbol Font" woman-toggle-use-symbol-font
1793 :included woman-font-support
1794 :active t :style toggle :selected woman-use-symbol-font]
1795 ["Font Map" woman-display-extended-fonts
1796 :included woman-font-support
1797 :active woman-use-symbol-font]
1800 ["nroff" (woman-reset-emulation 'nroff)
1801 :active t :style radio :selected (eq woman-emulation 'nroff)]
1802 ["troff" (woman-reset-emulation 'troff)
1803 :active t :style radio :selected (eq woman-emulation 'troff)]
1807 (defun woman-toggle-use-extended-font ()
1808 "Toggle `woman-use-extended-font' and reformat, for menu use."
1810 (setq woman-use-extended-font (not woman-use-extended-font))
1811 (woman-reformat-last-file))
1813 (defun woman-toggle-use-symbol-font ()
1814 "Toggle `woman-use-symbol-font' and reformat, for menu use."
1816 (setq woman-use-symbol-font (not woman-use-symbol-font))
1817 (woman-reformat-last-file))
1819 (defun woman-reset-emulation (value)
1820 "Reset `woman-emulation' to VALUE and reformat, for menu use."
1822 (setq woman-emulation value)
1823 (woman-reformat-last-file))
1825 (defun woman-mode ()
1826 "Turn on (most of) Man mode to browse a buffer formatted by WoMan.
1827 WoMan is an ELisp emulation of much of the functionality of the Emacs
1828 `man' command running the standard UN*X man and ?roff programs.
1829 WoMan author: F.J.Wright@Maths.QMW.ac.uk
1830 WoMan version: see `woman-version'.
1831 See `Man-mode' for additional details."
1832 (let ((Man-build-page-list (symbol-function 'Man-build-page-list))
1833 (Man-strip-page-headers (symbol-function 'Man-strip-page-headers))
1834 (Man-unindent (symbol-function 'Man-unindent))
1835 (Man-goto-page (symbol-function 'Man-goto-page)))
1836 ;; Prevent inappropriate operations:
1837 (fset 'Man-build-page-list 'ignore)
1838 (fset 'Man-strip-page-headers 'ignore)
1839 (fset 'Man-unindent 'ignore)
1840 (fset 'Man-goto-page 'ignore)
1843 (set (make-local-variable 'Man-mode-map) woman-mode-map)
1844 ;; Install Man mode:
1846 ;; Reset inappropriate definitions:
1847 (setq mode-line-format woman-mode-line-format)
1848 (put 'Man-mode 'mode-class 'special))
1849 ;; Restore the status quo:
1850 (fset 'Man-build-page-list Man-build-page-list)
1851 (fset 'Man-strip-page-headers Man-strip-page-headers)
1852 (fset 'Man-unindent Man-unindent)
1853 (fset 'Man-goto-page Man-goto-page)
1856 (set (make-local-variable 'imenu-generic-expression)
1857 ;; `make-local-variable' in case imenu not yet loaded!
1858 woman-imenu-generic-expression)
1859 (set (make-local-variable 'imenu-space-replacement) " ")
1861 ;; necessary when reformatting a file in its old buffer:
1862 (setq imenu--last-menubar-index-alist nil)
1863 ;; necessary to avoid re-installing the same imenu:
1864 (setq woman-imenu-done nil)
1865 (if woman-imenu (woman-imenu))
1866 (setq buffer-read-only nil)
1867 (Man-highlight-references)
1868 (setq buffer-read-only t)
1869 (set-buffer-modified-p nil)))
1871 (defun woman-imenu (&optional redraw)
1872 "Add a \"Contents\" menu to the menubar.
1873 Optional argument REDRAW, if non-nil, forces mode line to be updated."
1875 (if woman-imenu-done
1876 ;; This is PRIMARILY to avoid a bug in imenu-add-to-menubar that
1877 ;; causes it to corrupt the menu bar if it is run more than once
1878 ;; in the same buffer.
1880 (setq woman-imenu-done t)
1881 (imenu-add-to-menubar woman-imenu-title)
1882 (if redraw (force-mode-line-update))))
1884 (defun woman-toggle-fill-frame ()
1885 "Toggle formatting to fill (most of) the width of the current frame."
1887 (setq woman-fill-frame (not woman-fill-frame))
1888 (message "Woman fill column set to %s."
1889 (if woman-fill-frame "frame width" woman-fill-column)
1892 (defun woman-mini-help ()
1893 "Display WoMan commands and user options in an `apropos' buffer."
1894 ;; Based on apropos-command in apropos.el
1898 (let ((standard-output (get-buffer-create "*Apropos*")))
1899 (print-help-return-message 'identity))))
1900 (setq apropos-accumulator
1901 (apropos-internal "woman"
1903 (or (commandp symbol)
1904 (user-variable-p symbol)))))
1905 ;; Filter out any inhibited symbols:
1906 (let ((tem apropos-accumulator))
1908 (if (get (car tem) 'apropos-inhibit)
1909 (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
1910 (setq tem (cdr tem))))
1911 ;; Find documentation strings:
1912 (let ((p apropos-accumulator)
1915 (setcar p (list ; must have 3 elements:
1916 (setq symbol (car p)) ; 1. name
1917 (if (functionp symbol) ; 2. command doc
1918 (if (setq doc (documentation symbol t))
1919 (substring doc 0 (string-match "\n" doc))
1920 "(not documented)"))
1921 (if (user-variable-p symbol) ; 3. variable doc
1922 (if (setq doc (documentation-property
1923 symbol 'variable-documentation t))
1924 (substring doc 0 (string-match "\n" doc))))))
1926 ;; Output the result:
1927 (and (apropos-print t nil)
1929 (message message))))
1932 (defun WoMan-getpage-in-background (topic)
1933 "Use TOPIC to start WoMan from `Man-follow-manual-reference'."
1934 ;; topic is a string, generally of the form "section topic"
1935 (let ((s (string-match " " topic)))
1936 (if s (setq topic (substring topic (1+ s))))
1939 (defvar WoMan-Man-start-time nil
1940 "Used to record formatting time used by the `man' command.")
1942 (defadvice Man-getpage-in-background
1943 (around Man-getpage-in-background-advice (topic) activate)
1944 "Use WoMan unless invoked outside a WoMan buffer or invoked explicitly.
1945 Otherwise use Man and record start of formatting time."
1946 (if (and (eq mode-line-format woman-mode-line-format)
1947 (not (eq (caar command-history) 'man)))
1948 (WoMan-getpage-in-background topic)
1949 ;; Initiates man processing
1950 (setq WoMan-Man-start-time (current-time))
1953 (defadvice Man-bgproc-sentinel
1954 (after Man-bgproc-sentinel-advice activate)
1955 ;; Terminates man processing
1956 "Report formatting time."
1957 (let* ((time (current-time))
1958 (time (+ (* (- (car time) (car WoMan-Man-start-time)) 65536)
1959 (- (cadr time) (cadr WoMan-Man-start-time)))))
1960 (message "Man formatting done in %d seconds" time)))
1963 ;;; Buffer handling:
1965 (defun WoMan-previous-manpage ()
1966 "Find the previous WoMan buffer."
1967 ;; Assumes currently in a WoMan buffer!
1969 (WoMan-find-buffer) ; find current existing buffer
1970 (if (null (cdr woman-buffer-alist))
1971 (error "No previous WoMan buffer"))
1972 (if (>= (setq woman-buffer-number (1+ woman-buffer-number))
1973 (length woman-buffer-alist))
1974 (setq woman-buffer-number 0))
1975 (if (WoMan-find-buffer)
1977 (if (< (setq woman-buffer-number (1- woman-buffer-number)) 0)
1978 (setq woman-buffer-number (1- (length woman-buffer-alist))))
1979 (WoMan-previous-manpage)))
1981 (defun WoMan-next-manpage ()
1982 "Find the next WoMan buffer."
1983 ;; Assumes currently in a WoMan buffer!
1985 (WoMan-find-buffer) ; find current existing buffer
1986 (if (null (cdr woman-buffer-alist))
1987 (error "No next WoMan buffer"))
1988 (if (< (setq woman-buffer-number (1- woman-buffer-number)) 0)
1989 (setq woman-buffer-number (1- (length woman-buffer-alist))))
1990 (if (WoMan-find-buffer)
1992 (WoMan-next-manpage)))
1994 (defun WoMan-find-buffer ()
1995 "Switch to buffer corresponding to `woman-buffer-number' and return it.
1996 If such a buffer does not exist then remove its association from the
1997 alist in `woman-buffer-alist' and return nil."
1998 (if (zerop woman-buffer-number)
1999 (let ((buffer (get-buffer (cdr (car woman-buffer-alist)))))
2001 (switch-to-buffer buffer)
2002 ;; Delete alist element:
2003 (setq woman-buffer-alist (cdr woman-buffer-alist))
2005 (let* ((prev-ptr (nthcdr (1- woman-buffer-number) woman-buffer-alist))
2006 (buffer (get-buffer (cdr (car (cdr prev-ptr))))))
2008 (switch-to-buffer buffer)
2009 ;; Delete alist element:
2010 (setcdr prev-ptr (cdr (cdr prev-ptr)))
2011 (if (>= woman-buffer-number (length woman-buffer-alist))
2012 (setq woman-buffer-number 0))
2017 ;;; Syntax and display tables:
2019 (defconst woman-escaped-escape-char ?
\1c
2020 ;; An arbitrary unused control character
2021 "Internal character representation of escaped escape characters.")
2022 (defconst woman-escaped-escape-string
2023 (char-to-string woman-escaped-escape-char)
2024 "Internal string representation of escaped escape characters.")
2026 (defconst woman-unpadded-space-char ?
\1d
2027 ;; An arbitrary unused control character
2028 "Internal character representation of unpadded space characters.")
2029 (defconst woman-unpadded-space-string
2030 (char-to-string woman-unpadded-space-char)
2031 "Internal string representation of unpadded space characters.")
2033 (defvar woman-syntax-table nil
2034 "Syntax table to support special characters used internally by WoMan.")
2036 (if woman-syntax-table
2038 (setq woman-syntax-table (make-syntax-table))
2039 ;; The following internal chars must NOT have whitespace syntax:
2040 (modify-syntax-entry woman-unpadded-space-char "." woman-syntax-table)
2041 (modify-syntax-entry woman-escaped-escape-char "." woman-syntax-table)
2044 (defun woman-set-buffer-display-table ()
2045 "Set up a display table for a WoMan buffer.
2046 This display table is used for displaying internal special characters, but
2047 does not interfere with any existing display table, e.g. for displaying
2048 European characters."
2049 (setq buffer-display-table
2050 ;; The following test appears to be necessary on some
2051 ;; non-Windows platforms, e.g. Solaris 2.6 when running on a
2052 ;; tty. Thanks to T. V. Raman <raman@Adobe.COM>.
2053 ;; The MS-DOS terminal also sets standard-display-table to
2055 (if standard-display-table ; default is nil !!!
2056 (copy-sequence standard-display-table)
2057 (make-display-table)))
2058 ;; Display the following internal chars correctly:
2059 (aset buffer-display-table woman-unpadded-space-char [?\ ])
2060 (aset buffer-display-table woman-escaped-escape-char [?\\]))
2063 ;;; The main decoding driver:
2065 (defvar font-lock-mode) ; for the compiler
2067 (defun woman-decode-buffer ()
2068 "Decode a buffer in UN*X man-page source format.
2069 No external programs are used."
2070 (interactive) ; mainly for testing
2072 (run-hooks 'woman-pre-format-hook)
2073 (and (boundp 'font-lock-mode) font-lock-mode (font-lock-mode -1))
2074 ;; (fundamental-mode)
2075 (let ((start-time (current-time)) ; (HIGH LOW MICROSEC)
2076 time) ; HIGH * 2**16 + LOW seconds
2077 (message "WoMan formatting buffer...")
2078 ; (goto-char (point-min))
2080 ; ((re-search-forward "^\\.[ \t]*TH" nil t) ; wrong format if not found?
2081 ; (beginning-of-line)
2082 ; (delete-region (point-min) (point))) ; potentially dangerous!
2083 ; (t (message "WARNING: .TH request not found -- not man-page format?")))
2084 (woman-decode-region (point-min) (point-max))
2085 (setq time (current-time)
2086 time (+ (* (- (car time) (car start-time)) 65536)
2087 (- (cadr time) (cadr start-time))))
2088 (message "WoMan formatting buffer...done in %d seconds" time)
2089 (WoMan-log-end time))
2090 (run-hooks 'woman-post-format-hook))
2092 (defvar woman-string-alist ; rebound in woman-decode-region
2093 '(("S" . "") ("R" . "(Reg.)") ("Tm" . "(TM)")
2094 ("lq" . "\"") ("rq" . "\"")
2095 ("''" . "\"") ; needed for gcc.1
2096 (".T" . "") ; output device from -T option?
2098 "Alist of strings predefined in the -man macro package `tmac.an'.")
2100 (defvar woman-negative-vertical-space nil ; rebound in woman-decode-region
2101 "Set to t if .sp N with N < 0 encountered.")
2103 (defun woman-pre-process-region (from to)
2104 "Pre-process escapes and comments in the region of text between FROM and TO.
2105 To be called on original buffer and any .so insertions."
2106 ;; Hide escaped escapes \\ and printable escapes \e very early
2107 ;; (to be re-instated as just \ very late!):
2109 ;; .eo turns off escape character processing
2110 (while (re-search-forward "\\(\\\\[\\e]\\)\\|^\\.eo" to t) ; \\
2111 (if (match-string 1)
2112 (replace-match woman-escaped-escape-string t t)
2113 (woman-delete-whole-line)
2114 ;; .ec turns on escape character processing (and sets the
2115 ;; escape character to its argument, if any, which I'm ignoring
2117 (while (and (re-search-forward "\\(\\\\\\)\\|^\\.ec" to t) ; \
2119 (replace-match woman-escaped-escape-string t t))
2120 ;; ***** Need test for .ec arg and warning here! *****
2121 (woman-delete-whole-line)))
2123 ;; Delete comments .\"<anything>, \"<anything> and null requests.
2124 ;; (However, should null . requests cause a break?)
2126 (while (re-search-forward "^[.'][ \t]*\\(\\\\\".*\\)?\n\\|\\\\\".*" to t)
2127 (woman-delete-match 0)))
2129 (defun woman-non-underline-faces ()
2130 "Prepare non-underlined versions of underlined faces."
2131 (let ((face-list (face-list)))
2133 (let* ((face (car face-list))
2134 (face-name (symbol-name face)))
2135 (if (and (string-match "\\`woman-" face-name)
2136 (face-underline-p face))
2137 (let ((face-no-ul (intern (concat face-name "-no-ul"))))
2138 (copy-face face face-no-ul)
2139 (set-face-underline-p face-no-ul nil))))
2140 (setq face-list (cdr face-list)))))
2145 ;; This information is based on documentation for the man command by
2146 ;; Graeme W. Wilford <G.Wilford@ee.surrey.ac.uk>
2148 ;; First, the environment variable $MANROFFSEQ is interrogated, and if
2149 ;; not set then the initial line of the nroff file is parsed for a
2150 ;; preprocessor string. To contain a valid preprocessor string, the
2151 ;; first line must resemble
2155 ;; where string can be any combination of the following letters that
2156 ;; specify the sequence of preprocessors to run before nroff or
2157 ;; troff/groff. Not all installations will have a full set of
2158 ;; preprocessors. Some of the preprocessors and the letters used to
2159 ;; designate them are: eqn (e), grap (g), pic (p), tbl (t), vgrind
2160 ;; (v), refer (r). This option overrides the $MANROFFSEQ environment
2161 ;; variable. zsoelim is always run as the very first preprocessor.
2163 (defvar woman-emulate-tbl nil
2164 "True if WoMan should emulate the tbl preprocessor.
2165 This applies to text between .TE and .TS directives.
2166 Currently set only from '\" t in the first line of the source file.")
2168 (defun woman-decode-region (from to)
2169 "Decode the region between FROM and TO in UN*X man-page source format."
2170 ;; Suitable for use in format-alist.
2171 ;; But this requires care to control major mode implied font locking.
2172 ;; Must return the new end of file. See format.el for details.
2173 ;; NB: The `to' argument is bogus: it is not currently used, and if
2174 ;; it were it would need to be a marker rather than a position!
2175 ;; First force the correct environment:
2176 (let ((case-fold-search nil) ; This is necessary!
2177 (woman-string-alist woman-string-alist)
2178 (woman-fill-column woman-fill-column)
2179 woman-negative-vertical-space)
2180 (setq woman-left-margin woman-default-indent
2181 woman-prevailing-indent woman-default-indent
2182 woman-interparagraph-distance 1
2183 woman-leave-blank-lines nil
2184 woman-RS-left-margin nil
2185 woman-RS-prevailing-indent nil
2186 woman-adjust woman-adjust-both
2187 woman-justify (nth woman-adjust woman-justify-list)
2190 (setq woman-if-conditions-true
2191 (cons (string-to-char (symbol-name woman-emulation)) '(?e ?o)))
2193 ;; Prepare non-underlined versions of underlined faces:
2194 (woman-non-underline-faces)
2195 ;; Set font of `woman-symbol-face' to `woman-symbol-font' if
2196 ;; `woman-symbol-font' is well defined.
2197 (and woman-use-symbol-font
2198 (stringp woman-symbol-font)
2199 (set-face-font 'woman-symbol-face woman-symbol-font
2200 (and (frame-live-p woman-frame) woman-frame)))
2202 ;; Set syntax and display tables:
2203 (set-syntax-table woman-syntax-table)
2204 (woman-set-buffer-display-table)
2206 ;; Based loosely on a suggestion by Theodore Jump:
2207 (if (or woman-fill-frame
2208 (not (and (integerp woman-fill-column) (> woman-fill-column 0))))
2209 (setq woman-fill-column (- (frame-width) woman-default-indent)))
2211 ;; Check for preprocessor requests:
2213 (if (looking-at "'\\\\\"[ \t]*\\([a-z]+\\)")
2214 (let ((letters (append (match-string 1) nil)))
2215 (if (memq ?t letters)
2216 (setq woman-emulate-tbl t
2217 letters (delete ?t letters)))
2219 (WoMan-warn "Unhandled preprocessor request letters %s"
2221 (woman-delete-line 1)))
2223 (woman-pre-process-region from nil)
2224 ;; Process ignore requests, macro definitions,
2225 ;; conditionals and switch source requests:
2226 (woman0-roff-buffer from)
2228 ;; Process \k escapes BEFORE changing tab width (?):
2230 (woman-mark-horizonal-position)
2232 ;; Set buffer-local variables:
2233 (setq fill-column woman-fill-column
2234 tab-width woman-tab-width)
2236 ;; Hide unpaddable and digit-width spaces \(space) and \0:
2238 (while (re-search-forward "\\\\[ 0]" nil t)
2239 (replace-match woman-unpadded-space-string t t))
2241 ;; Discard optional hyphen \%; concealed newlines \<newline>;
2242 ;; point-size change function \sN,\s+N, \s-N:
2244 (while (re-search-forward "\\\\\\([%\n]\\|s[-+]?[0-9]+\\)" nil t)
2245 (woman-delete-match 0))
2247 ;; BEWARE: THIS SHOULD PROBABLY ALL BE DONE MUCH LATER!!!!!
2248 ;; Process trivial escapes \-, \`, \.
2249 ;; (\' must be done after tab processing!):
2251 (while (re-search-forward "\\\\\\([-`.]\\)" nil t)
2252 (replace-match "\\1"))
2253 ;; NB: Must keep ALL zero-width characters \&, \|, and \^ until
2254 ;; ALL requests processed!
2256 ;; Process no-break requests and macros (including font-change macros):
2258 (woman1-roff-buffer)
2260 ;; Process strings and special character escapes \(xx:
2261 ;; (Must do this BEFORE fontifying!)
2264 ;; Special chars moved after translation in
2265 ;; `woman2-process-escapes' (for pic.1):
2267 ; (woman-special-characters)
2269 ;; Process standard font-change requests and escapes:
2271 (woman-change-fonts)
2273 ;; 1/2 em vertical motion \d, \u and general local vertical motion
2274 ;; \v'+/-N' simulated using TeX ^ and _ symbols for now.
2276 (let ((first t)) ; assume no nesting!
2277 (while (re-search-forward "\\\\\\([du]\\|v'[^']*'\\)" nil t)
2278 (let* ((esc (match-string 1))
2279 (repl (if (or (= (aref esc 0) ?u)
2280 (and (>= (length esc) 2) (= (aref esc 2) ?-)))
2283 (replace-match repl nil t)
2284 (put-text-property (1- (point)) (point)
2285 'face 'woman-addition-face)
2287 "Initial vertical motion escape \\%s simulated" esc)
2289 " by TeX `%s' in woman-addition-face!" repl))
2291 (woman-delete-match 0)
2293 "Terminal vertical motion escape \\%s ignored!" esc)))
2294 (setq first (not first))
2297 ; ;; \h'+/-N' local horizontal motion.
2298 ; ;; N may include width escape \w'...'
2299 ; ;; Implement arbitrary forward motion and non-overlapping backward
2302 ; (while (re-search-forward
2303 ; ;; Delimiter can be a special char escape sequence \(.. or
2304 ; ;; a single normal char (usually '):
2305 ; "\\\\h\\(\\\\(..\\|.\\)\\(|\\)?"
2307 ; (let ((from (match-beginning 0))
2308 ; (delim (regexp-quote (match-string 1)))
2309 ; (absolute (match-string 2)) ; absolute position?
2310 ; (N (woman-parse-numeric-arg)) ; distance
2312 ; msg) ; for warning
2313 ; (if (not (looking-at delim))
2314 ; ;; Warn but leave escape in buffer unprocessed:
2316 ; "Local horizontal motion (%s) delimiter error!"
2317 ; (buffer-substring from (1+ (point)))) ; point at end of arg
2318 ; (setq to (match-end 0)
2319 ; ;; For possible warning -- save before deleting:
2320 ; msg (buffer-substring from to))
2321 ; (delete-region from to)
2322 ; (if absolute ; make relative
2323 ; (setq N (- N (current-column))))
2325 ; ;; Move forward by inserting hard spaces:
2326 ; (insert-char woman-unpadded-space-char N)
2327 ; ;; Move backwards by deleting space,
2328 ; ;; first backwards then forwards:
2330 ; (<= (setq N (1+ N)) 0)
2331 ; (cond ((memq (preceding-char) '(?\ ?\t))
2332 ; (delete-backward-char 1) t)
2333 ; ((memq (following-char) '(?\ ?\t))
2334 ; (delete-char 1) t)
2338 ; "Negative horizontal motion (%s) would overwrite!" msg))))
2341 ;; Process formatting macros
2343 (woman2-roff-buffer)
2345 ;; Go back and process negative vertical space if necessary:
2346 (if woman-negative-vertical-space
2347 (woman-negative-vertical-space from))
2349 (if woman-preserve-ascii
2350 ;; Re-instate escaped escapes to just `\' and unpaddable
2351 ;; spaces to just `space', without inheriting any text
2352 ;; properties. This is not necessary, UNLESS the buffer is to
2353 ;; be saved as ASCII.
2356 (while (search-forward woman-escaped-escape-string nil t)
2357 (delete-char -1) (insert ?\\))
2359 (while (search-forward woman-unpadded-space-string nil t)
2360 (delete-char -1) (insert ?\ ))
2363 ;; Must return the new end of file if used in format-alist.
2366 (defun woman-horizontal-escapes (to)
2367 "Process \\h'+/-N' local horizontal motion escapes upto TO.
2368 Implements arbitrary forward and non-overlapping backward motion.
2369 Preserves location of `point'."
2370 ;; Moved from `woman-decode-region' for version 0.50.
2371 ;; N may include width escape \w'...' (but may already be processed!
2372 (let ((from (point)))
2373 (while (re-search-forward
2374 ;; Delimiter can be a special char escape sequence \(.. or
2375 ;; a single normal char (usually '):
2376 "\\\\h\\(\\\\(..\\|.\\)\\(|\\)?"
2378 (let ((from (match-beginning 0))
2379 (delim (regexp-quote (match-string 1)))
2380 (absolute (match-string 2)) ; absolute position?
2381 (N (woman-parse-numeric-arg)) ; distance
2384 (if (not (looking-at delim))
2385 ;; Warn but leave escape in buffer unprocessed:
2387 "Local horizontal motion (%s) delimiter error!"
2388 (buffer-substring from (1+ (point)))) ; point at end of arg
2389 (setq to (match-end 0)
2390 ;; For possible warning -- save before deleting:
2391 msg (buffer-substring from to))
2392 (delete-region from to)
2393 (if absolute ; make relative
2394 (setq N (- N (current-column))))
2396 ;; Move forward by inserting hard spaces:
2397 (insert-char woman-unpadded-space-char N)
2398 ;; Move backwards by deleting space,
2399 ;; first backwards then forwards:
2401 (<= (setq N (1+ N)) 0)
2402 (cond ((memq (preceding-char) '(?\ ?\t))
2403 (delete-backward-char 1) t)
2404 ((memq (following-char) '(?\ ?\t))
2409 "Negative horizontal motion (%s) would overwrite!" msg))))
2415 ;; Process ignore requests (.ig), conditionals (.if etc.),
2416 ;; source-switch (.so), macro definitions (.de etc.) and macro
2419 (defvar woman0-if-to) ; marker bound in woman0-roff-buffer
2420 (defvar woman0-macro-alist) ; bound in woman0-roff-buffer
2421 (defvar woman0-search-regex) ; bound in woman0-roff-buffer
2422 (defvar woman0-search-regex-start ; bound in woman0-roff-buffer
2423 "^[.'][ \t]*\\(ig\\|if\\|ie\\|el\\|so\\|rn\\|de\\|am")
2424 (defconst woman0-search-regex-end "\\)\\([ \t]+\\|$\\)")
2425 ;; May need other terminal characters, e.g. \, but NOT \n!
2426 ;; Alternatively, force maximal match (Posix?)
2428 (defvar woman0-rename-alist) ; bound in woman0-roff-buffer
2430 (defun woman0-roff-buffer (from)
2431 "Process conditional-type requests and user-defined macros.
2432 Start at FROM and re-scan new text as appropriate."
2434 (let ((woman0-if-to (make-marker))
2435 request woman0-macro-alist
2436 (woman0-search-regex-start woman0-search-regex-start)
2437 (woman0-search-regex
2438 (concat woman0-search-regex-start woman0-search-regex-end))
2439 woman0-rename-alist)
2440 (while (re-search-forward woman0-search-regex nil t)
2441 (setq request (match-string 1))
2442 (cond ((string= request "ig") (woman0-ig))
2443 ((string= request "if") (woman0-if "if"))
2444 ((string= request "ie") (woman0-if "ie"))
2445 ((string= request "el") (woman0-el))
2446 ((string= request "so") (woman0-so))
2447 ((string= request "rn") (woman0-rn))
2448 ((string= request "de") (woman0-de))
2449 ((string= request "am") (woman0-de 'append))
2450 (t (woman0-macro request))))
2451 (set-marker woman0-if-to nil)
2453 ;; Should now re-run `woman0-roff-buffer' if any renaming was
2454 ;; done, but let's just hope this is not necessary for now!
2458 ".ig yy -- Discard input up to `.yy', which defaults to `..')."
2459 ;; The terminal request MUST begin with . (not ')!
2460 (looking-at "\\(\\S +\\)?")
2462 (let ((yy (or (match-string 1) "."))
2464 (if (re-search-forward
2465 (concat "^\\.[ \t]*" (regexp-quote yy) ".*\n") nil t)
2466 (delete-region from (point))
2468 "ig request ignored -- terminator `.%s' not found!" yy)
2469 (woman-delete-line 1))
2472 (defsubst woman0-process-escapes (from to)
2473 "Process escapes within an if/ie condition between FROM and TO."
2475 (goto-char from) ; necessary!
2476 ;; Strip font-change escapes:
2477 (while (re-search-forward "\\\\f\\(\\[[^]]+\\]\\|(..\\|.\\)" to t)
2478 (woman-delete-match 0))
2479 (goto-char from) ; necessary!
2480 (woman2-process-escapes to 'numeric))
2482 (defun woman0-if (request)
2483 ".if/ie c anything -- Discard unless c evaluates to true.
2484 Remember condition for use by a subsequent `.el'.
2485 REQUEST is the invoking directive without the leading dot."
2486 ;; c evaluates to a one-character built-in condition name or
2487 ;; 'string1'string2' or a number > 0, prefix ! negates.
2488 ;; \{ ... \} for multi-line use.
2489 ;; Leaves point at start of new text.
2490 (woman-delete-match 0)
2491 ;; (delete-horizontal-space)
2492 ;; Process escapes in condition:
2493 (let ((from (point)) negated n (c 0))
2494 (set-marker woman0-if-to
2495 (save-excursion (skip-syntax-forward "^ ") (point)))
2496 ;; Process condition:
2497 (if (setq negated (= (following-char) ?!)) (delete-char 1))
2499 ;; ((looking-at "[no]") (setq c t)) ; accept n(roff) and o(dd page)
2500 ;; ((looking-at "[te]") (setq c nil)) ; reject t(roff) and e(ven page)
2501 ((looking-at "[ntoe]")
2502 (setq c (memq (following-char) woman-if-conditions-true)))
2503 ;; Unrecognised letter so reject:
2504 ((looking-at "[A-Za-z]") (setq c nil)
2505 (WoMan-warn "%s %s -- unrecognised condition name rejected!"
2506 request (match-string 0)))
2507 ;; Accept strings if identical:
2509 (narrow-to-region from woman0-if-to)
2510 ;; String delimiter can be any non-numeric character,
2511 ;; including a special character escape:
2512 (looking-at "\\(\\\\(..\\|[^0-9]\\)\\(.*\\)\\1\\(.*\\)\\1\\'"))
2513 (let ((end1 (copy-marker (match-end 2)))) ; end of first string
2514 ;; Delete 2nd and 3rd delimiters to avoid processing them:
2515 (delete-region (match-end 3) woman0-if-to)
2516 (delete-region (match-end 2) (match-beginning 3))
2517 (goto-char (match-end 1))
2518 (woman0-process-escapes (point) woman0-if-to)
2519 (setq c (string= (buffer-substring (point) end1)
2520 (buffer-substring end1 woman0-if-to)))
2521 (set-marker end1 nil)
2523 ;; Accept numeric value if > 0:
2524 ((numberp (setq n (progn
2525 (woman0-process-escapes from woman0-if-to)
2526 (woman-parse-numeric-arg))))
2531 (woman-if-ignore woman0-if-to request) ; ERROR!
2532 (woman-if-body request woman0-if-to (eq c negated)))
2535 (defun woman-if-body (request to delete) ; should be reversed as `accept'?
2536 "Process if-body, including \\{ ... \\}.
2537 REQUEST is the invoking directive without the leading dot.
2538 If TO is non-nil then delete the if-body.
2539 If DELETE is non-nil then delete from point."
2540 ;; Assume concealed newlines already processed.
2541 (let ((from (point)))
2542 (if to (delete-region (point) to))
2543 (delete-horizontal-space)
2544 (cond (;;(looking-at "[^{\n]*\\\\{\\s *") ; multi-line
2545 ;; allow escaped newlines:
2546 (looking-at "[^{\n]*\\(\\\\\n\\)*\\\\{\\s *\\(\\\\\n\\)*") ; multi-line
2547 ;; including preceding .if(s) and following newline
2548 (let ((from (point)))
2549 (woman-delete-match 0)
2550 ;; Allow for nested \{ ... \} -- BUT BEWARE that this
2551 ;; algorithm only supports one level of nesting!
2553 (and (re-search-forward
2554 ;; "\\(\\\\{\\)\\|\\(\n[.']\\)?[ \t]*\\\\}[ \t]*"
2555 ;; Interpret bogus `el \}' as `el \{',
2556 ;; especially for Tcl/Tk man pages:
2557 "\\(\\\\{\\|el[ \t]*\\\\}\\)\\|\\(\n[.']\\)?[ \t]*\\\\}[ \t]*")
2559 (re-search-forward "\\\\}"))
2560 (delete-region (if delete from (match-beginning 0)) (point))
2561 (if (looking-at "^$") (delete-char 1))
2563 (delete (woman-delete-line 1)) ; single-line
2565 ;; Process matching .el anything:
2566 (cond ((string= request "ie")
2567 ;; Discard unless previous .ie c `evaluated to false'.
2568 (cond ((re-search-forward "^[.'][ \t]*el[ \t]*" nil t)
2569 (woman-delete-match 0)
2570 (woman-if-body "el" nil (not delete)))))
2571 ;; Got here after processing a single-line `.ie' as a body
2572 ;; clause to be discarded:
2573 ((string= request "el")
2574 (cond ((re-search-forward "^[.'][ \t]*el[ \t]*" nil t)
2575 (woman-delete-match 0)
2576 (woman-if-body "el" nil t))))
2582 "Isolated .el request -- should not happen!"
2583 (WoMan-warn "el request without matching `ie' rejected!")
2585 (woman-delete-match 0)
2586 (delete-horizontal-space)
2587 (woman-if-body "el" nil t))
2588 (t ; Ignore -- leave in buffer
2589 ;; This does not work too well, but it's only for debugging!
2590 (skip-chars-forward "^ \t")
2591 (if (looking-at "[ \t]*\\{") (search-forward "\\}"))
2594 (defun woman-if-ignore (to request)
2595 "Ignore but warn about an if request ending at TO, named REQUEST."
2596 (WoMan-warn-ignored request "ignored -- condition not handled!")
2598 (woman-if-body request to t)
2599 ;; Ignore -- leave in buffer
2600 ;; This does not work too well, but it's only for debugging!
2601 (skip-chars-forward "^ \t")
2602 (if (looking-at "[ \t]*\\{") (search-forward "\\}"))
2606 ".so filename -- Switch source file. `.so' requests may be nested."
2607 ;; Leaves point at start of new text.
2608 ;; (skip-chars-forward " \t")
2609 (let* ((beg (point))
2610 (end (progn (woman-forward-arg 'unquote) (point)))
2611 (name (buffer-substring beg end))
2613 ;; If the specified file does not exist in this ...
2614 (or (file-exists-p filename)
2615 ;; or the parent directory ...
2617 (setq filename (concat "../" name)))
2618 ;; then use the WoMan search mechanism to find the filename ...
2621 (file-name-sans-extension
2622 (file-name-nondirectory name))))
2623 ;; Cannot find the file, so ...
2624 (kill-buffer (current-buffer))
2625 (error "File `%s' not found" name))
2627 (woman-delete-line 1)
2628 (let ((from (point))
2630 (length (woman-insert-file-contents filename 0)))
2631 (set-marker to (+ from length))
2632 (woman-pre-process-region from to)
2638 ;;; Process macro definitions:
2641 "Process .rn xx yy -- rename macro xx to yy."
2642 ;; For now, done backwards AFTER all macro expansion.
2643 ;; Should also allow requests and strings to be renamed!
2644 (if (eolp) ; ignore if no argument
2646 (let* ((beg (point))
2647 (end (progn (woman-forward-arg 'unquote 'concat) (point)))
2648 (old (buffer-substring beg end))
2650 (if (eolp) ; ignore if no argument
2653 end (progn (woman-forward-arg 'unquote) (point))
2654 new (buffer-substring beg end)
2655 woman0-rename-alist (cons (cons new old) woman0-rename-alist)))
2657 (woman-delete-whole-line))
2659 (defun woman0-rename ()
2660 "Effect renaming required by .rn requests."
2661 ;; For now, do this backwards AFTER all macro expansion.
2662 (while woman0-rename-alist
2663 (let* ((new (car woman0-rename-alist))
2666 (setq woman0-rename-alist (cdr woman0-rename-alist))
2667 (goto-char (point-min))
2668 (setq new (concat "^[.'][ \t]*" (regexp-quote new)))
2669 (setq old (concat "." old))
2670 (while (re-search-forward new nil t)
2671 (replace-match old nil t)))))
2673 (defconst woman-unescape-regex
2674 (concat woman-escaped-escape-string
2675 "\\(" woman-escaped-escape-string "\\)?"))
2677 (defsubst woman-unescape (macro)
2678 "Replace escape sequences in the body of MACRO.
2679 Replaces || by |, but | by \, where | denotes the internal escape."
2681 (while (setq start (string-match woman-unescape-regex macro start))
2683 (if (match-string 1 macro)
2684 (replace-match "" t t macro 1)
2685 (replace-match "\\" t t macro))
2689 (defun woman0-de (&optional append)
2690 "Process .de/am xx yy -- (re)define/append macro xx; end at `..'.
2691 \(Should be up to call of yy, which defaults to `.')
2692 Optional argument APPEND, if non-nil, means append macro."
2693 ;; Modelled on woman-strings. BEWARE: Processing of .am is a hack!
2694 ;; Add support for .rm?
2695 ;; (skip-chars-forward " \t")
2696 (if (eolp) ; ignore if no argument
2698 (looking-at "[^ \t\n]+") ; macro name
2699 (let* ((macro (match-string 0)) from
2700 (previous (assoc macro woman0-macro-alist)))
2702 (setq woman0-search-regex-start
2703 (concat woman0-search-regex-start "\\|" (regexp-quote macro))
2705 (concat woman0-search-regex-start woman0-search-regex-end)
2707 ;; Macro body runs from start of next line to line
2708 ;; beginning with `..'."
2709 ;; The terminal request MUST begin with `.' (not ')!
2712 (re-search-forward "^\\.[ \t]*\\.")
2714 (let ((body (woman-unescape (buffer-substring from (point)))))
2715 (if (and append previous)
2716 (setq previous (cdr previous)
2717 body (concat body (cdr previous))
2718 append (car previous)
2720 (setq macro (cons macro (cons append body))))
2721 ;; This should be an update, but consing a new string
2722 ;; onto the front of the alist has the same effect:
2723 (setq woman0-macro-alist (cons macro woman0-macro-alist))
2725 (delete-region from (point))
2726 (backward-char) ; return to end of .de/am line
2728 (beginning-of-line) ; delete .de/am line
2729 (woman-delete-line 1))
2731 (defun woman0-macro (request)
2732 "Process the macro call named REQUEST."
2733 ;; Leaves point at start of new text.
2734 (let ((macro (assoc request woman0-macro-alist)))
2736 (woman-interpolate-macro (cdr macro))
2737 ;; SHOULD DELETE THE UNINTERPRETED REQUEST!!!!!
2738 ;; Output this message once only per call (cf. strings)?
2739 (WoMan-warn "Undefined macro %s not interpolated!" request))))
2741 (defun woman-interpolate-macro (macro)
2742 "Interpolate (.de) or append (.am) expansion of MACRO into the buffer."
2743 ;; Could make this more efficient by checking which arguments are
2744 ;; actually used in the expansion!
2745 (skip-chars-forward " \t")
2746 ;; Process arguments:
2747 (let ((argno 0) (append (car macro))
2748 argno-string formal-arg from actual-arg start)
2749 (setq macro (cdr macro))
2751 ;; Get next actual arg:
2752 (setq argno (1+ argno))
2753 (setq argno-string (format "%d" argno))
2754 (setq formal-arg (concat "\\\\\\$" argno-string)) ; regexp
2756 (woman-forward-arg 'unquote 'noskip)
2757 (setq actual-arg (buffer-substring from (point)))
2758 (skip-chars-forward " \t") ; now skip following whitespace!
2759 ;; Replace formal arg with actual arg:
2761 (while (setq start (string-match formal-arg macro start))
2762 (setq macro (replace-match actual-arg t t macro)))
2764 ;; Delete any remaining formal arguments:
2767 (setq start (string-match "\\\\\\$." macro start))
2768 (setq macro (replace-match "" t t macro)))
2769 ;; Replace .$ number register with actual arg:
2770 ;; (Do this properly via register mechanism later!)
2773 (setq start (string-match "\\\\n(\\.\\$" macro start)) ; regexp
2774 (setq macro (replace-match argno-string t t macro)))
2778 (woman-delete-line 1))
2779 (save-excursion ; leave point at start of new text
2783 ;;; Process strings:
2785 (defun woman-match-name ()
2786 "Match and move over name of form: x, (xx or [xxx...].
2787 Applies to number registers, fonts, strings/macros/diversions, and
2788 special characters."
2789 (cond ((= (following-char) ?\[ )
2791 (re-search-forward "[^]]+")
2792 (forward-char)) ; skip closing ]
2793 ((= (following-char) ?\( )
2795 (re-search-forward ".."))
2796 (t (re-search-forward "."))))
2798 (defun woman-strings (&optional to)
2799 "Process ?roff string requests and escape sequences up to buffer position TO.
2800 Strings are defined/updated by `.ds xx string' requests and
2801 interpolated by `\*x' and `\*(xx' escapes."
2802 ;; Add support for .as and .rm?
2804 ;; Find .ds requests and \* escapes:
2805 (re-search-forward "\\(^[.'][ \t]*ds\\)\\|\\\\\\*" to t)
2806 (cond ((match-string 1) ; .ds
2807 (skip-chars-forward " \t")
2808 (if (eolp) ; ignore if no argument
2810 (re-search-forward "[^ \t\n]+")
2811 (let ((string (match-string 0)))
2812 (skip-chars-forward " \t")
2815 ; ;; hack (?) for CGI.man!
2816 ; (cond ((looking-at "\"\"") "\"")
2817 ; ((looking-at ".*") (match-string 0)))
2819 ;; Above hack causes trouble in arguments!
2821 (setq string (cons string (match-string 0)))
2822 ;; This should be an update, but consing a new string
2823 ;; onto the front of the alist has the same effect:
2824 (setq woman-string-alist (cons string woman-string-alist))
2827 (woman-delete-line 1))
2829 (let ((beg (match-beginning 0)))
2831 (let* ((stringname (match-string 0))
2832 (string (assoc stringname woman-string-alist)))
2834 (delete-region beg (point))
2835 ;; Temporary hack in case string starts with a
2836 ;; control character:
2837 (if (bolp) (insert-before-markers "\\&"))
2838 (insert-before-markers (cdr string)))
2840 (WoMan-warn "Undefined string %s not interpolated!"
2843 ;; Output above message once only per call
2844 (delete-region beg (point))
2845 (setq woman-string-alist
2846 (cons (cons stringname "")
2847 woman-string-alist))))
2854 ;;; Process special character escapes \(xx:
2856 (defconst woman-special-characters
2857 ;; To be built heuristically as required!
2858 ;; MUST insert all characters as strings for correct conversion to
2859 ;; multibyte representation!
2860 '(("em" "--" "\276" . t) ; 3/4 Em dash
2861 ("bu" "*" "\267" . t) ; bullet
2862 ("fm" "'") ; foot mark
2863 ("co" "(C)" "\251") ; copyright
2865 ("pl" "+" "+" . t) ; math plus
2866 ("mi" "-" "-" . t) ; math minus
2867 ("**" "*" "*" . t) ; math star
2868 ("aa" "'" "\242" . t) ; acute accent
2869 ("ul" "_") ; underrule
2871 ("*S" "Sigma" "S" . t) ; Sigma
2873 (">=" ">=" "\263" . t) ; >=
2874 ("<=" "<=" "\243" . t) ; <=
2875 ("->" "->" "\256" . t) ; right arrow
2876 ("<-" "<-" "\254" . t) ; left arrow
2877 ("mu" " x " "\264" . t) ; multiply
2878 ("+-" "+/-" "\261" . t) ; plus-minus
2879 ("bv" "|") ; bold vertical
2881 ;; groff etc. extensions:
2888 "Alist of special character codes with ASCII and extended-font equivalents.
2889 Each alist elements has the form
2890 (input-string ascii-string extended-font-string . use-symbol-font)
2892 * `\\(input-string' is the ?roff encoding,
2893 * `ascii-string' is the (multi-character) ASCII simulation,
2894 * `extended-font-string' is the single-character string representing
2895 the character position in the extended 256-character font, and
2896 * `use-symbol-font' is t to indicate use of the symbol font or nil,
2897 i.e. omitted, to indicate use of the default font.
2898 Any element may be nil. Avoid control character codes (0 to \\37, \\180
2899 to \\237) in `extended-font-string' for now, since they can be
2900 displayed only with a modified display table.
2902 Use the WoMan command `woman-display-extended-fonts' or a character
2903 map accessory to help construct this alist.")
2905 (defsubst woman-replace-match (newtext &optional face)
2906 "Replace text matched by last search with NEWTEXT and return t.
2907 Set NEWTEXT in face FACE if specified."
2908 (woman-delete-match 0)
2909 (insert-before-markers newtext)
2910 (if face (put-text-property (1- (point)) (point)
2911 'face 'woman-symbol-face))
2914 (defun woman-special-characters (to)
2915 "Process special character escapes \\(xx, \\[xxx] up to buffer position TO.
2916 \(This must be done AFTER translation, which may use special characters.)"
2917 (while (re-search-forward "\\\\\\(?:(\\(..\\)\\|\\[\\([[^]]+\\)\\]\\)" to t)
2918 (let* ((name (or (match-string-no-properties 1)
2919 (match-string-no-properties 2)))
2920 (replacement (assoc name woman-special-characters)))
2924 (cond ((and (cddr replacement)
2925 (if (nthcdr 3 replacement)
2926 ;; Need symbol font:
2927 (if woman-use-symbol-font
2928 (woman-replace-match (nth 2 replacement)
2929 'woman-symbol-face))
2930 ;; Need extended font:
2931 (if woman-use-extended-font
2932 (woman-replace-match (nth 2 replacement))))))
2933 ((cadr replacement) ; Use ASCII simulation
2934 (woman-replace-match (cadr replacement)))))
2935 (WoMan-warn (concat "Special character "
2936 (if (match-string 1) "\\(%s" "\\[%s]")
2937 " not interpolated!") name)
2938 (if woman-ignore (woman-delete-match 0))))
2941 (defun woman-display-extended-fonts ()
2942 "Display table of glyphs of graphic characters and their octal codes.
2943 All the octal codes in the ranges [32..127] and [160..255] are displayed
2944 together with the corresponding glyphs from the default and symbol fonts.
2945 Useful for constructing the alist variable `woman-special-characters'."
2947 (with-output-to-temp-buffer "*WoMan Extended Font Map*"
2949 (set-buffer standard-output)
2952 (insert (format "\\%03o " i) (string i) " " (string i))
2953 (put-text-property (1- (point)) (point)
2954 'face 'woman-symbol-face)
2957 (when (= i 128) (setq i 160) (insert "\n"))
2958 (if (zerop (% i 8)) (insert "\n")))
2960 (print-help-return-message)))
2963 ;;; Formatting macros that do not cause a break:
2965 (defvar request) ; Bound locally by woman1-roff-buffer
2966 (defvar unquote) ; Bound locally by woman1-roff-buffer
2968 (defun woman-unquote (to)
2969 "Delete any double-quote characters between point and TO.
2970 Leave point at TO (which should be a marker)."
2972 (while (search-forward "\"" to 1)
2973 (if (and in-quote (looking-at "\""))
2974 ;; Repeated double-quote represents single double-quote
2976 (if (or in-quote (looking-at ".*\"")) ; paired
2978 (setq in-quote (not in-quote))
2981 (WoMan-warn "Unpaired \" in .%s arguments." request))
2984 (defsubst woman-unquote-args ()
2985 "Delete any double-quote characters up to the end of the line."
2986 (woman-unquote (save-excursion (end-of-line) (point-marker))))
2988 (defun woman1-roff-buffer ()
2989 "Process non-breaking requests."
2990 (let ((case-fold-search t)
2993 ;; Find next control line:
2994 (re-search-forward woman-request-regexp nil t)
2996 ;; Construct woman function to call:
2997 ((setq fn (intern-soft
2999 (setq request (match-string 1)))))
3000 (if (get fn 'notfont) ; not a font-change request
3002 ;; Delete request or macro name:
3003 (woman-delete-match 0)
3004 ;; If no args then apply to next line else unquote args
3005 ;; (unquote is used by called function):
3006 (setq unquote (not (eolp)))
3007 (if (eolp) (delete-char 1))
3008 ; ;; Hide leading control character in unquoted argument:
3009 ; (cond ((memq (following-char) '(?. ?'))
3011 ; (beginning-of-line)))
3012 ;; Call the appropriate function:
3014 ;; Hide leading control character in quoted argument (only):
3015 (if (and unquote (memq (following-char) '(?. ?')))
3020 ;;; Font-changing macros:
3023 ".B -- Set words of current line in bold font."
3024 (woman1-B-or-I ".ft B\n"))
3027 ".I -- Set words of current line in italic font."
3028 (woman1-B-or-I ".ft I\n"))
3030 (defun woman1-B-or-I (B-or-I)
3031 ".B/I -- Set words of current line in bold/italic font.
3032 B-OR-I is the appropriate complete control line."
3033 ;; Should NOT concatenate the arguments!
3034 (insert B-or-I) ; because it might be a control line
3035 ;; Return to bol to process .SM/.B, .B/.if etc.
3036 ;; or start of first arg to hide leading control char.
3039 (woman-unquote-args)
3040 (while (looking-at "^[.']") (forward-line))
3042 (delete-horizontal-space))
3046 ".SM -- Set the current line in small font, i.e. IGNORE!"
3049 (defalias 'woman1-SB 'woman1-B)
3050 ;; .SB -- Set the current line in small bold font, i.e. just embolden!
3051 ;; (This is what /usr/local/share/groff/tmac/tmac.an does. The
3052 ;; Linux man.7 is wrong about this!)
3055 ".BI -- Join words of current line alternating bold and italic fonts."
3056 (woman1-alt-fonts (list "\\fB" "\\fI")))
3059 ".BR -- Join words of current line alternating bold and Roman fonts."
3060 (woman1-alt-fonts (list "\\fB" "\\fR")))
3063 ".IB -- Join words of current line alternating italic and bold fonts."
3064 (woman1-alt-fonts (list "\\fI" "\\fB")))
3067 ".IR -- Join words of current line alternating italic and Roman fonts."
3068 (woman1-alt-fonts (list "\\fI" "\\fR")))
3071 ".RB -- Join words of current line alternating Roman and bold fonts."
3072 (woman1-alt-fonts (list "\\fR" "\\fB")))
3075 ".RI -- Join words of current line alternating Roman and italic fonts."
3076 (woman1-alt-fonts (list "\\fR" "\\fI")))
3078 (defun woman1-alt-fonts (fonts)
3079 "Join words using alternating fonts in FONTS, which MUST be a dynamic list."
3080 (nconc fonts fonts) ; circular list!
3081 (insert (car fonts))
3082 ;; Return to start of first arg to hide leading control char:
3084 (setq fonts (cdr fonts))
3085 (woman-forward-arg unquote 'concat) ; unquote is bound above
3087 (insert (car fonts))
3088 (setq fonts (cdr fonts))
3089 (woman-forward-arg unquote 'concat)) ; unquote is bound above
3093 (defun woman-forward-arg (&optional unquote concat)
3094 "Move forward over one ?roff argument, optionally unquoting and/or joining.
3095 If optional arg UNQUOTE is non-nil then delete any argument quotes.
3096 If optional arg CONCAT is non-nil then join arguments."
3097 (if (eq (following-char) ?\")
3099 (if unquote (delete-char 1) (forward-char))
3100 (re-search-forward "\"\\|$")
3101 ;; Repeated double-quote represents single double-quote
3102 (while (eq (following-char) ?\") ; paired
3103 (if unquote (delete-char 1) (forward-char))
3104 (re-search-forward "\"\\|$"))
3105 (if (eq (preceding-char) ?\")
3106 (if unquote (delete-backward-char 1))
3107 (WoMan-warn "Unpaired \" in .%s arguments." request)
3109 ;; (re-search-forward "[^\\\n] \\|$") ; inconsistent
3110 (skip-syntax-forward "^ "))
3111 (cond ((null concat) (skip-chars-forward " \t")) ; don't skip eol!
3112 ((eq concat 'noskip)) ; do not skip following whitespace
3113 (t (woman-delete-following-space)))
3117 ;; The following requests are not explicit font-change requests and
3118 ;; so are flagged `notfont' to turn off automatic request deletion
3119 ;; and further processing.
3121 (put 'woman1-TP 'notfont t)
3123 ".TP -- After tag line, reset font to Roman for paragraph body."
3124 ;; Same for .IP, but forward only 1 line?
3126 ;; May be an `irrelevant' control line in the way, so ...
3128 (forward-line (if (looking-at "\\.\\S-+[ \t]*$") 2 1))
3129 ;; May be looking at control line, so ...
3130 (insert ".ft R\n")))
3132 (put 'woman1-ul 'notfont t)
3134 ".ul N -- Underline (italicize) the next N input lines, default N = 1."
3135 (let ((N (if (eolp) 1 (woman-parse-numeric-arg)))) ; woman-get-numeric-arg ?
3136 (woman-delete-whole-line)
3142 ;;; Other non-breaking requests:
3145 ;; Warnings commented out.
3147 (put 'woman1-nh 'notfont t)
3149 ".nh -- No hyphenation, i.e. IGNORE!"
3150 ;; Must be handled here to avoid breaking!
3151 ;; (WoMan-log-1 ".nh request ignored -- hyphenation not supported!")
3152 (woman-delete-whole-line))
3154 (put 'woman1-hy 'notfont t)
3156 ".hy N -- Set hyphenation mode to N, i.e. IGNORE!"
3157 ;; (WoMan-log-1 ".hy request ignored -- hyphenation not supported!")
3158 (woman-delete-whole-line))
3160 (put 'woman1-hc 'notfont t)
3162 ".hc c -- Set hyphenation character to c, i.e. delete it!"
3163 (let ((c (char-to-string (following-char))))
3165 ;; "Hyphenation character %s deleted -- hyphenation not supported!" c)
3166 (woman-delete-whole-line)
3167 (setq c (concat "\\(" c "\\)\\|^[.'][ \t]*hc"))
3169 (while (and (re-search-forward c nil t)
3174 (put 'woman1-hw 'notfont t)
3176 ".hw words -- Set hyphenation exception words, i.e. IGNORE!"
3177 ;; (WoMan-log-1 ".hw request ignored -- hyphenation not supported!")
3178 (woman-delete-whole-line))
3180 ;;; Other non-breaking requests correctly ignored by nroff:
3182 (put 'woman1-ps 'notfont t)
3183 (defalias 'woman1-ps 'woman-delete-whole-line)
3184 ;; .ps -- Point size -- IGNORE!
3186 (put 'woman1-ss 'notfont t)
3187 (defalias 'woman1-ss 'woman-delete-whole-line)
3188 ;; .ss -- Space-character size -- IGNORE!
3190 (put 'woman1-cs 'notfont t)
3191 (defalias 'woman1-cs 'woman-delete-whole-line)
3192 ;; .cs -- Constant character space (width) mode -- IGNORE!
3194 (put 'woman1-ne 'notfont t)
3195 (defalias 'woman1-ne 'woman-delete-whole-line)
3196 ;; .ne -- Need vertical space -- IGNORE!
3198 (put 'woman1-vs 'notfont t)
3199 (defalias 'woman1-vs 'woman-delete-whole-line)
3200 ;; .vs -- Vertical base line spacing -- IGNORE!
3202 (put 'woman1-bd 'notfont t)
3203 (defalias 'woman1-bd 'woman-delete-whole-line)
3204 ;; .bd -- Embolden font -- IGNORE!
3206 ;;; Non-breaking SunOS-specific macros:
3209 ".TX t p -- Resolve SunOS abbrev t and join to p (usually punctuation)."
3211 (woman-forward-arg 'unquote 'concat))
3213 (put 'woman1-IX 'notfont t)
3214 (defalias 'woman1-IX 'woman-delete-whole-line)
3215 ;; .IX -- Index macro, for Sun internal use -- IGNORE!
3218 ;;; Direct font selection:
3220 (defconst woman-font-alist
3222 ("I" . woman-italic-face)
3223 ("B" . woman-bold-face)
3226 ("2" . woman-italic-face)
3227 ("3" . woman-bold-face) ; used in bash.1
3229 "Alist of ?roff font indicators and woman font variables and names.")
3231 (defun woman-change-fonts ()
3232 "Process font changes."
3233 ;; ***** NEEDS REVISING IF IT WORKS OK *****
3234 ;; Paragraph .LP/PP/HP/IP/TP and font .B/.BI etc. macros reset font.
3235 ;; Should .SH/.SS reset font?
3236 ;; Font size setting macros (?) should reset font.
3237 (let ((woman-font-alist woman-font-alist) ; for local updating
3238 (previous-pos (point))
3239 (previous-font 'default)
3240 (current-font 'default))
3242 ;; Find font requests, paragraph macros and font escapes:
3244 "^[.'][ \t]*\\(\\(\\ft\\)\\|\\(.P\\)\\)\\|\\(\\\\f\\)" nil 1)
3245 (let (font beg notfont)
3246 ;; Match font indicator and leave point at end of sequence:
3247 (cond ((match-string 2)
3248 ;; .ft request found
3249 (setq beg (match-beginning 0))
3250 (skip-chars-forward " \t")
3251 (if (eolp) ; default is previous font
3252 (setq font previous-font)
3253 (looking-at "[^ \t\n]+"))
3254 (forward-line)) ; end of control line and \n
3256 ;; Macro that resets font found
3257 (setq font 'default))
3260 (setq beg (match-beginning 0))
3262 (t (setq notfont t)))
3267 (let ((fontstring (match-string 0)))
3268 (setq font (assoc fontstring woman-font-alist)
3269 ;; NB: woman-font-alist contains VARIABLE NAMES.
3272 (WoMan-warn "Unknown font %s." fontstring)
3273 ;; Output this message once only per call ...
3274 (setq woman-font-alist
3275 (cons (cons fontstring 'woman-unknown-face)
3277 'woman-unknown-face)
3279 ;; Delete font control line or escape sequence:
3280 (cond (beg (delete-region beg (point))
3281 (if (eq font 'previous) (setq font previous-font))))
3282 (woman-set-face previous-pos (point) current-font)
3284 ;; Explicit font control
3285 (setq previous-pos (point)
3286 previous-font current-font)
3287 ;; Macro that resets font
3288 ;; (forward-line) ; DOES NOT WORK! but unnecessary?
3289 ;; Must process font changes in any paragraph tag!
3290 (setq previous-pos (point)
3291 previous-font 'default))
3292 (setq current-font font)
3294 ;; Set font after last request up to eob:
3295 (woman-set-face previous-pos (point) current-font)
3298 (defun woman-set-face (from to face)
3299 "Set the face of the text from FROM to TO to face FACE.
3300 Ignore the default face and underline only word characters."
3301 (or (eq face 'default) ; ignore
3303 (if (face-underline-p face)
3305 (let ((face-no-ul (intern (concat (symbol-name face) "-no-ul"))))
3307 (while (< (point) to)
3308 (skip-syntax-forward "w" to)
3309 (put-text-property from (point) 'face face)
3311 (skip-syntax-forward "^w" to)
3312 (put-text-property from (point) 'face face-no-ul)
3315 (put-text-property from to 'face face))
3319 ;;; Output translation:
3321 (defvar translations nil) ; Also bound locally by woman2-roff-buffer
3322 ;; A list of the form (\"[ace]\" (a . b) (c . d) (e . ?\ )) or nil.
3324 (defun woman-get-next-char ()
3325 "Return and delete next char in buffer, including special chars."
3326 (if ;;(looking-at "\\\\(\\(..\\)")
3327 ;; Match special \(xx and strings \*[xxx], \*(xx, \*x:
3328 (looking-at "\\\\\\((..\\|\\*\\(\\[[^]]+\\]\\|(..\\|.\\)\\)")
3329 (prog1 (match-string 0)
3330 (woman-delete-match 0))
3331 (prog1 (char-to-string (following-char))
3334 (defun woman2-tr (to)
3335 ".tr abcde -- Translate a -> b, c -> d, ..., e -> space.
3336 Format paragraphs upto TO. Supports special chars.
3337 \(Breaks, but should not.)"
3338 ;; This should be an update, but consing onto the front of the alist
3339 ;; has the same effect and match duplicates should not matter.
3340 ;; Initialize translation data structures:
3341 (let ((matches (car translations))
3342 (alist (cdr translations))
3344 ;; `matches' must be a string:
3346 (concat (if matches (substring matches 1 -1)) "]"))
3347 ;; Process .tr arguments:
3348 (while (not (eolp)) ; (looking-at "[ \t]*$") ???
3349 (setq a (woman-get-next-char))
3352 (setq b (woman-get-next-char)))
3354 (if (= (length a) 1)
3356 (concat matches "\\|\\" a))
3357 alist (cons (cons a b) alist)))
3358 (delete-char 1) ; no blank line
3359 ;; Rebuild translations list:
3361 (if (= (string-to-char matches) ?\])
3362 (substring matches 3)
3363 (concat "[" matches))
3364 translations (cons matches alist))
3365 ;; Format any following text:
3366 (woman2-format-paragraphs to)
3369 (defsubst woman-translate (to)
3370 "Translate up to marker TO. Do this last of all transformations."
3372 (let ((matches (car translations))
3373 (alist (cdr translations)))
3374 (while (re-search-forward matches to t)
3375 ;; Done like this to retain text properties and
3376 ;; support translation of special characters:
3377 (insert-before-markers-and-inherit
3379 (buffer-substring-no-properties
3380 (match-beginning 0) (match-end 0))
3382 (woman-delete-match 0))
3388 (defvar woman-registers ; these are all read-only
3389 '((".H" 24) (".V" 48) ; resolution in basic units
3390 (".g" 0) ; not groff
3391 ;; (Iff emulating groff need to implement groff italic correction
3392 ;; \/, e.g. for pic.1)
3393 (".i" left-margin) ; current indent
3394 (".j" woman-adjust) ; current adjustment
3395 (".l" fill-column) ; current line length
3396 (".s" 12) ; current point size
3397 (".u" (if woman-nofill 0 1)) ; 1/0 in fill/nofill mode
3398 (".v" 48) ; current vertical line spacing
3400 "Register alist: the key is the register name as a string.
3401 Each element has the form (KEY VALUE . INC) -- inc may be nil.
3402 Also bound locally in `woman2-roff-buffer'.")
3404 (defun woman-mark-horizonal-position ()
3405 "\\kx -- Store current horizontal position in INPUT LINE in register x."
3406 (while (re-search-forward "\\\\k\\(.\\)" nil t)
3407 (goto-char (match-beginning 0))
3408 (setq woman-registers
3409 (cons (list (match-string 1) (current-column))
3411 (woman-delete-match 0)))
3413 (defsubst woman2-process-escapes-to-eol (&optional numeric)
3414 "Process remaining escape sequences up to eol.
3415 Handle numeric arguments specially if optional argument NUMERIC is non-nil."
3416 (woman2-process-escapes
3417 (save-excursion (end-of-line) (point-marker))
3420 (defun woman2-nr (to)
3421 ".nr R +/-N M -- Assign +/-N (wrt to previous value, if any) to register R.
3422 The increment for auto-incrementing is set to M.
3423 Format paragraphs upto TO. (Breaks, but should not!)"
3424 (let* ((name (buffer-substring
3426 (progn (skip-syntax-forward "^ ") (point))))
3427 (pm (progn ; increment
3428 (skip-chars-forward " \t")
3429 (when (memq (char-after) '(?+ ?-))
3430 (forward-char) (char-before))))
3431 (value (if (eolp) ; no value
3432 nil ; to be interpreted as zero
3433 (woman2-process-escapes-to-eol 'numeric)
3434 (woman-parse-numeric-arg)))
3435 (inc (progn ; auto-increment
3436 (skip-chars-forward " \t")
3437 (if (eolp) ; no value
3438 nil ; to be interpreted as zero ???
3439 (woman-parse-numeric-arg))))
3440 (oldvalue (assoc name woman-registers)))
3442 (setq oldvalue (cdr oldvalue)) ; (value . inc)
3443 (unless inc (setq inc (cdr oldvalue))))
3445 (setq value 0) ; correct?
3446 (WoMan-warn "nr %s -- null value assigned as zero!" name))
3448 (setq value (list 'quote value))))
3449 (if pm ; increment old value
3450 (setq oldvalue (if oldvalue (car oldvalue) 0)
3451 value (if (eq pm ?+)
3453 (- oldvalue value))))
3454 (setq woman-registers
3455 (cons (cons name (cons value inc)) woman-registers))
3456 (woman-delete-whole-line)
3457 (woman2-format-paragraphs to)))
3460 ;;; Numeric (and "non-text") request arguments:
3462 (defsubst woman-get-numeric-arg ()
3463 "Get the value of a numeric argument at or after point.
3464 The argument can include the width function and scale indicators.
3465 Assumes 10 characters per inch. Does not move point."
3466 (woman2-process-escapes-to-eol 'numeric)
3467 (save-excursion (woman-parse-numeric-arg)))
3469 (defun woman-parse-numeric-arg ()
3470 "Get the value of a numeric expression at or after point.
3471 Unlike `woman-get-numeric-arg', leaves point after the argument.
3472 The expression may be an argument in quotes."
3473 (if (= (following-char) ?\") (forward-char))
3474 ;; Allow leading +/-:
3475 (let ((value (if (looking-at "[+-]") 0 (woman-parse-numeric-value)))
3478 ((looking-at "[+-/*%]") ; arithmetic operators
3480 (setq op (intern-soft (match-string 0)))
3481 (setq value (funcall op value (woman-parse-numeric-value))))
3482 ((looking-at "[<=>]=?") ; relational operators
3483 (goto-char (match-end 0))
3484 (setq op (or (intern-soft (match-string 0))
3486 (setq value (if (funcall op value (woman-parse-numeric-value))
3488 ((memq (setq op (following-char)) '(?& ?:)) ; Boolean and / or
3491 ;; and / or are special forms, not functions, in ELisp
3495 (if (> (woman-parse-numeric-value) 0) 1 0)
3496 ;; skip second operand
3497 (prog1 0 (woman-parse-numeric-value)))
3500 ;; skip second operand
3501 (prog1 1 (woman-parse-numeric-value))
3502 (if (> (woman-parse-numeric-value) 0) 1 0))
3505 ; (if (looking-at "[ \t\nRC\)\"]") ; R, C are tab types
3507 ; (WoMan-warn "Unimplemented numerical operator `%c' in %s"
3510 ; (save-excursion (beginning-of-line) (point))
3511 ; (save-excursion (end-of-line) (point))))
3512 ; (skip-syntax-forward "^ "))
3516 (defun woman-parse-numeric-value ()
3517 "Get a single numeric value at or after point.
3518 The value can be a number register or width function (which assumes 10
3519 characters per inch) and can include scale indicators. It may be an
3520 expression in parentheses. Leaves point after the value."
3521 ;; Must replace every \' by some different single character first
3522 ;; before calling this function by calling
3523 ;; (woman2-process-escapes-to-eol 'numeric)
3524 (if (eq (following-char) ?\()
3525 ;; Treat parenthesized expression as a single value.
3528 (setq n (woman-parse-numeric-arg))
3529 (skip-syntax-forward " ")
3530 (if (eq (following-char) ?\))
3532 (WoMan-warn "Parenthesis confusion in numeric expression!"))
3534 (let ((n (cond ((looking-at "[-+]?[.0-9]+") ; single number
3535 ;; currently needed to set match-end, even though
3536 ;; string-to-number returns 0 if number not parsed.
3537 (string-to-number (match-string 0)))
3538 ((looking-at "\\\\n\\([-+]\\)?\\(?:\
3539 \\[\\([^]]+\\)\\]\\|\(\\(..\\)\\|\\(.\\)\\)")
3540 ;; interpolate number register, maybe auto-incremented
3541 (let* ((pm (match-string-no-properties 1))
3542 (name (or (match-string-no-properties 2)
3543 (match-string-no-properties 3)
3544 (match-string-no-properties 4)))
3545 (value (assoc name woman-registers)))
3548 (setq value (cdr value) ; (value . inc)
3550 ;; eval internal (.X) registers
3551 ;; stored as lisp variable names:
3552 value (eval (car value)))
3553 (if (and pm inc) ; auto-increment
3555 (funcall (intern-soft pm) value inc)
3557 (cons (cons name (cons value inc))
3560 (WoMan-warn "Undefined register %s defaulted to 0."
3562 0) ; default to zero
3565 ;; Delimiter can be special char escape \[xxx],
3566 ;; \(xx or single normal char (usually '):
3567 "\\=\\\\w\\(\\\\\\[[^]]+\\]\\|\\\\(..\\|.\\)" nil t)
3568 (let ((from (match-end 0))
3569 (delim (regexp-quote (match-string 1))))
3570 (if (re-search-forward delim nil t)
3571 ;; Return width of string:
3572 (- (match-beginning 0) from)
3573 (WoMan-warn "Width escape delimiter error!"))))
3576 ;; ERROR -- should handle this better!
3578 (WoMan-warn "Numeric/register argument error: %s"
3581 (save-excursion (end-of-line) (point))))
3582 (skip-syntax-forward "^ ")
3584 (goto-char (match-end 0))
3585 ;; Check for scale factor:
3588 ((looking-at "\\s ") nil) ; stay put!
3589 ((looking-at "[mnuv]")) ; ignore for now
3590 ((looking-at "i") (setq n (* n 10))) ; inch
3591 ((looking-at "c") (setq n (* n 3.9))) ; cm
3592 ((looking-at "P") (setq n (* n 1.7))) ; Pica
3593 ((looking-at "p") (setq n (* n 0.14))) ; point
3594 ;; NB: May be immediately followed by + or -, etc.,
3595 ;; in which case do nothing and return nil.
3597 (goto-char (match-end 0)))
3598 (if (numberp n) (round n) n))
3602 ;;; VERTICAL FORMATTING -- Formatting macros that cause a break:
3604 ;; Vertical spacing philosophy:
3605 ;; Delete all vertical space as it is encountered. Then insert
3606 ;; vertical space only before text, as required.
3608 (defun woman2-roff-buffer ()
3609 "Process breaks. Format paragraphs and headings."
3610 (let ((case-fold-search t)
3612 (canonically-space-region
3613 (symbol-function 'canonically-space-region))
3614 (insert-and-inherit (symbol-function 'insert-and-inherit))
3615 (set-text-properties (symbol-function 'set-text-properties))
3616 (woman-registers woman-registers)
3617 fn request translations
3619 ;; ?roff does not squeeze multiple spaces, but does fill, so...
3620 (fset 'canonically-space-region 'ignore)
3621 ;; Try to avoid spaces inheriting underlines from preceding text!
3622 (fset 'insert-and-inherit (symbol-function 'insert))
3623 (fset 'set-text-properties 'ignore)
3626 ;; Find next control line:
3627 (re-search-forward woman-request-regexp nil t)
3629 ;; Construct woman function to call:
3630 ((setq fn (intern-soft
3632 (setq request (match-string 1)))))
3633 ;; Delete request or macro name:
3634 (woman-delete-match 0))
3635 ;; Unrecognised request:
3637 ;; (WoMan-warn ".%s request ignored!" request)
3638 (WoMan-warn-ignored request "ignored!")
3639 ;; (setq fn 'woman2-LP)
3640 ;; AVOID LEAVING A BLANK LINE!
3641 ;; (setq fn 'woman2-format-paragraphs)
3643 ;; .LP assumes it is at eol and leaves a (blank) line,
3644 ;; so leave point at end of line before paragraph:
3645 ((or (looking-at "[ \t]*$") ; no argument
3646 woman-ignore) ; ignore all
3647 ;; (beginning-of-line) (kill-line)
3648 ;; AVOID LEAVING A BLANK LINE!
3649 (beginning-of-line) (woman-delete-line 1))
3650 (t (end-of-line) (insert ?\n))
3653 (and (not (memq (following-char) '(?. ?')))
3654 (setq fn 'woman2-format-paragraphs))))
3656 ;; Find next control line:
3657 (set-marker to (woman-find-next-control-line))
3658 ;; Call the appropriate function:
3660 (if (not (eobp)) ; This should not happen, but ...
3661 (woman2-format-paragraphs (point-max-marker) woman-left-margin))
3662 (fset 'canonically-space-region canonically-space-region)
3663 (fset 'set-text-properties set-text-properties)
3664 (fset 'insert-and-inherit insert-and-inherit)
3665 (set-marker to nil))))
3667 (defun woman-find-next-control-line ()
3668 "Find and return start of next control line."
3669 ; (let ((to (save-excursion
3670 ; (re-search-forward "^\\." nil t))))
3671 ; (if to (1- to) (point-max)))
3676 ;; .br (and other requests?)
3677 ;; by deleting both the \c and the following request.
3678 ;; BEWARE THAT THIS CODE MAY BE UNRELIABLE!!!!!
3681 (setq to (re-search-forward "\\(\\\\c\\)?\n[.']" nil t))
3684 (goto-char (match-beginning 0))
3685 (woman-delete-line 2)))
3686 (if to (1- to) (point-max))))
3688 (defun woman2-PD (to)
3689 ".PD d -- Set the interparagraph distance to d.
3690 Round to whole lines, default 1 line. Format paragraphs upto TO.
3691 \(Breaks, but should not.)"
3692 ;; .ie \\n[.$] .nr PD (v;\\$1)
3693 ;; .el .nr PD .4v>?\n[.V]
3694 (woman-set-interparagraph-distance)
3695 (woman2-format-paragraphs to))
3697 (defun woman-set-interparagraph-distance ()
3698 "Set the interparagraph distance from a .PD request at point."
3699 (setq woman-interparagraph-distance
3700 (if (eolp) 1 (woman-get-numeric-arg)))
3701 ;; Should allow .PD 0 to set zero line spacing
3702 (woman-delete-line 1)) ; ignore remaining args
3704 (defsubst woman-interparagraph-space ()
3705 "Set variable `woman-leave-blank-lines' from `woman-interparagraph-distance'."
3706 ; (if (> woman-interparagraph-distance 0)
3707 ; (forward-line 1) ; leave 1 blank line
3708 ; (woman-delete-line 1)) ; do not leave blank line
3709 (setq woman-leave-blank-lines woman-interparagraph-distance)
3712 (defun woman2-TH (to)
3713 ".TH n c x v m -- Begin a man page. Format paragraphs upto TO.
3714 n is the name of the page in chapter c\; x is extra commentary\;
3715 v alters page foot left; m alters page head center.
3716 \(Should set prevailing indent and tabs to 5.)"
3717 (woman-forward-arg 'unquote 'concat)
3719 (woman-forward-arg 'unquote 'concat)
3721 (let ((start (point)) here)
3723 (cond ((looking-at "\"\"[ \t]")
3725 ;; (delete-horizontal-space)
3727 (delete-horizontal-space)
3730 (woman-forward-arg 'unquote 'concat)
3731 ;; Delete repeated arguments:
3732 (if (string-match (buffer-substring here (point))
3733 (buffer-substring start here))
3734 (delete-region here (point)))
3736 ;; Embolden heading (point is at end of heading):
3738 (save-excursion (beginning-of-line) (point)) (point) 'woman-bold-face)
3740 (delete-blank-lines)
3741 (setq woman-left-margin woman-default-indent)
3742 (setq woman-prevailing-indent woman-default-indent)
3743 (woman2-format-paragraphs to woman-left-margin))
3745 (defun woman2-SH (to)
3746 ".SH -- Sub-head. Leave blank line and subhead.
3747 Format paragraphs upto TO. Set prevailing indent to 5."
3748 (if (eolp) ; If no args then
3749 (delete-char 1) ; apply to next line
3750 (woman-unquote-args) ; else unquote to end of heading
3751 (beginning-of-line))
3752 (woman2-process-escapes-to-eol)
3753 (woman-leave-blank-lines woman-interparagraph-distance)
3754 (setq woman-leave-blank-lines nil)
3755 ;; Optionally embolden heading (point is at beginning of heading):
3756 (if woman-bold-headings
3758 (point) (save-excursion (end-of-line) (point)) 'woman-bold-face))
3760 (setq woman-left-margin woman-default-indent
3761 woman-nofill nil) ; fill output lines
3762 (setq woman-prevailing-indent woman-default-indent)
3763 (woman2-format-paragraphs to woman-left-margin))
3765 (defun woman2-SS (to)
3766 ".SS -- Sub-sub-head. Like .SH but indent heading 3 spaces.
3767 Format paragraphs upto TO."
3768 (if (eolp) ; If no args then
3769 (delete-char 1)) ; apply to next line.
3774 (defun woman2-LP (to)
3775 ".LP,.PP -- Begin paragraph. Set prevailing indent to 5.
3776 Leave 1 blank line. Format paragraphs upto TO."
3777 (woman-delete-line 1) ; ignore any arguments
3778 (woman-interparagraph-space)
3779 (setq woman-prevailing-indent woman-default-indent)
3780 (woman2-format-paragraphs to woman-left-margin))
3782 (defalias 'woman2-PP 'woman2-LP)
3783 (defalias 'woman2-P 'woman2-LP)
3785 (defun woman2-ns (to)
3786 ".ns -- Turn on no-space mode. Format paragraphs upto TO."
3787 ;; Should not cause a break!
3788 (woman-delete-line 1) ; ignore argument(s)
3789 (setq woman-nospace t)
3790 (woman2-format-paragraphs to))
3792 (defun woman2-rs (to)
3793 ".rs -- Turn off no-space mode. Format paragraphs upto TO."
3794 ;; Should not cause a break!
3795 (woman-delete-line 1) ; ignore argument(s)
3796 (setq woman-nospace nil)
3797 (woman2-format-paragraphs to))
3799 (defun woman2-sp (to)
3800 ".sp N -- If N > 0 then leave 1 blank line. Format paragraphs upto TO."
3801 (let ((N (if (eolp) 1 (woman-get-numeric-arg))))
3803 (woman-delete-line 1) ; ignore argument(s)
3804 (setq woman-negative-vertical-space t)
3807 (setq woman-leave-blank-lines N)
3808 (woman2-format-paragraphs to)))
3810 (defun woman-negative-vertical-space (from)
3811 ".sp N with N < 0 => overlap following with preceding lines at FROM."
3812 ;; Run by woman-decode-region if necessary -- not usually required.
3813 (WoMan-warn "Negative vertical spacing support is experimental!")
3816 ;; Find next control line:
3817 (re-search-forward "^\\.sp " nil t)
3818 (let ((N (woman-get-numeric-arg))
3819 overlap overwritten)
3820 (woman-delete-whole-line)
3822 overlap (buffer-substring from
3823 (progn (forward-line (- N)) (point))))
3824 (delete-region from (point))
3826 (let ((imax (length overlap))
3829 (setq c (aref overlap i))
3830 (cond ((eq c ?\n) ; skip
3832 ((eolp) ; extend line
3833 ;; Insert character INCLUDING TEXT PROPERTIES:
3834 ;; (insert (substring overlap i (1+ i)))
3835 (let ((eol (string-match "\n" overlap i)))
3836 (insert (substring overlap i eol))
3837 (setq i (or eol imax)))
3842 (if (eq (following-char) ?\t)
3843 (forward-char) ; both tabs, just skip
3844 (let ((i woman-tab-width))
3847 (insert ?\ ) ; extend line
3848 (forward-char)) ; skip
3852 (if (or (eq (following-char) ?\ ) ; overwrite OK
3853 overwritten) ; warning only once per ".sp -"
3855 (setq overwritten t)
3857 "Character(s) overwritten by negative vertical spacing in line %d"
3858 (count-lines 1 (point))))
3859 (delete-char 1) (insert (substring overlap i (1+ i)))))
3865 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3866 ;; The following function should probably do ALL width and number
3867 ;; register interpolation.
3868 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3870 (defun woman2-process-escapes (to &optional numeric)
3871 "Process remaining escape sequences up to marker TO, preserving point.
3872 Optional argument NUMERIC, if non-nil, means the argument is numeric."
3873 ;; The first two cases below could be merged (maybe)!
3874 (let ((from (point)))
3875 ;; Discard zero width filler character used to hide leading dots
3876 ;; and zero width characters \|, \^:
3877 (while (re-search-forward "\\\\[&|^]" to t)
3878 (woman-delete-match 0))
3880 ;; Interrupt text processing -- CONTINUE current text with the
3881 ;; next text line (after any control lines, unless processing to
3883 (while (re-search-forward "\\\\c.*\n?" to t)
3884 (woman-delete-match 0))
3885 ;; but do not delete the final newline ...
3886 (if (and (or (eobp) (= (point) to)) (not (bolp)))
3887 (insert-before-markers ?\n))
3889 (woman-translate to)
3891 (woman-special-characters to)
3893 ;; Printable version of the current escape character, ASSUMED to be `\'
3894 ;; This must be done LAST of all escape processing!
3895 ;; Done like this to preserve any text properties of the `\'
3896 (while (search-forward "\\" to t)
3897 (let ((c (following-char)))
3898 (cond ((eq c ?') ; \' -> '
3900 (cond (numeric ; except in numeric args, \' -> `
3903 ((eq c ?\( )) ; uninterpreted special character
3904 ; \(.. -- do nothing
3905 ((eq c ?t) ; non-interpreted tab \t
3910 (memq c '(?w ?n ?h)))) ; leave \w, \n, \h (?????)
3911 ((eq c ?l) (woman-horizontal-line))
3913 ;; \? -> ? where ? is any remaining character
3914 (WoMan-warn "Escape ignored: \\%c -> %c" c c)
3918 ;; Process non-default tab settings:
3919 (cond (tab-stop-list
3920 (while (search-forward "\t" to t)
3921 (woman-tab-to-tab-stop))
3924 ;; Must replace \' by something before processing \w, done above.
3926 ;; Replace all `\w' and `\n' escapes:
3927 ;; (This may be a bit too recursive!)
3928 (while (re-search-forward "\\\\[nw]" to t)
3929 (let ((from (match-beginning 0)) N)
3931 (setq N (woman-parse-numeric-value))
3932 (delete-region from (point))
3933 ;; Interpolate value:
3934 (insert-before-markers (number-to-string N))))
3937 (defun woman-horizontal-line ()
3938 "\\l'Nc' -- Draw a horizontal line of length N using character c, default _."
3941 (looking-at "\\(.\\)\\(.*\\)\\1")
3942 (let ((to (make-marker)) from N c)
3943 (set-marker to (match-end 2))
3946 N (woman-parse-numeric-arg))
3947 (setq c (if (< (point) to) (following-char) ?_))
3948 (delete-region from to)
3951 (insert (make-string N c))
3954 ;;; 4. Text Filling, Adjusting, and Centering
3956 (defun woman2-br (to)
3957 ".br -- Break. Leave no blank line. Format paragraphs upto TO."
3958 (woman-delete-line 1) ; ignore any arguments
3959 (woman2-format-paragraphs to))
3961 (defun woman2-fi (to)
3962 ".fi -- Fill subsequent output lines. Leave no blank line.
3963 Format paragraphs upto TO."
3964 (setq woman-nofill nil)
3965 (woman-delete-line 1) ; ignore any arguments
3966 ;; Preserve any final blank line in the nofill region:
3969 (if (looking-at "[ \t]*$") (setq woman-leave-blank-lines 1)))
3970 (woman2-format-paragraphs to))
3972 (defun woman2-nf (to)
3973 ".nf -- Nofill. Subsequent lines are neither filled nor adjusted.
3974 Input text lines are copied directly to output lines without regard
3975 for the current line length. Format paragraphs upto TO."
3976 (setq woman-nofill t)
3977 (woman-delete-line 1) ; ignore any arguments
3978 (woman2-format-paragraphs to))
3980 (defun woman2-ad (to)
3981 ".ad c -- Line adjustment is begun (once fill mode is on).
3982 Set justification mode to c if specified.
3983 Format paragraphs upto TO. (Breaks, but should not.)"
3984 ;; c = l -- left, r -- right, c -- center, b or n -- both,
3985 ;; absent -- unchanged. Initial mode adj,both.
3987 (cond ((eolp) woman-adjust-previous)
3988 ((eq (following-char) ?l) woman-adjust-left)
3989 ((eq (following-char) ?r) woman-adjust-right)
3990 ((eq (following-char) ?c) woman-adjust-center)
3991 ((memq (following-char) '(?b ?n)) woman-adjust-both)
3992 (t (woman-get-numeric-arg))
3994 woman-justify (nth woman-adjust woman-justify-list))
3995 (woman-delete-line 1) ; ignore any remaining arguments
3996 (woman2-format-paragraphs to))
3998 (defun woman2-na (to)
3999 ".na -- No adjusting. Format paragraphs upto TO.
4000 \(Breaks, but should not.)"
4001 (setq woman-adjust-previous woman-adjust
4002 woman-justify-previous woman-justify
4003 woman-adjust woman-adjust-left ; fill but do not adjust
4004 woman-justify (nth woman-adjust woman-justify-list))
4005 (woman-delete-line 1) ; ignore any arguments
4006 (woman2-format-paragraphs to))
4008 ;;; The main formatting functions:
4010 (defun woman-leave-blank-lines (&optional leave)
4011 "Delete all blank lines around point.
4012 Leave one blank line if optional argument LEAVE is non-nil and
4013 non-zero, or if LEAVE is nil and variable `woman-leave-blank-lines' is
4014 non-nil and non-zero."
4015 ;; ***** It may suffice to delete only lines ABOVE point! *****
4016 ;; NOTE: Function arguments are evaluated left to right
4017 ;; (*note (elisp)Function Forms::.).
4020 (if (not (eq (skip-syntax-backward " ") 0))
4021 (forward-line)) ; forward-char ?
4023 (progn (skip-syntax-forward " ")
4028 (if (or (null leave) (eq leave 0))
4029 ;; output any `pending' vertical space ...
4030 (setq leave woman-leave-blank-lines))
4031 (if (and leave (> leave 0)) (insert-before-markers ?\n))
4033 (setq woman-leave-blank-lines nil)
4036 ;; `fill-region-as-paragraph' in `fill.el' appears to be the principal
4037 ;; text filling function, so that is what I use here.
4039 (defvar woman-temp-indent nil)
4041 (defun woman2-format-paragraphs (to &optional new-left)
4042 "Indent, fill and adjust paragraphs upto TO to current left margin.
4043 If optional arg NEW-LEFT is non-nil then reset current left margin.
4044 If `woman-nofill' is non-nil then indent without filling or adjusting."
4045 ;; Blank space should only ever be output before text.
4046 (if new-left (setq left-margin new-left))
4047 (if (looking-at "^\\s *$")
4048 ;; A blank line should leave a space like .sp 1 (p. 14).
4049 (setq woman-leave-blank-lines 1))
4050 (skip-syntax-forward " ")
4051 ;; Successive control lines are sufficiently common to be worth a
4052 ;; special case (maybe):
4053 (if (>= (point) to) ; >= as a precaution!
4055 ;; (woman-leave-blank-lines)
4056 (woman-reset-nospace)
4057 ;; (woman2-process-escapes to) ; 7 October 1999
4058 (woman2-process-escapes to 'numeric)
4060 ;; Indent without filling or adjusting ...
4062 (woman-leave-blank-lines)
4063 (cond (woman-temp-indent
4064 (indent-to woman-temp-indent)
4066 (indent-rigidly (point) to left-margin)
4067 (woman-horizontal-escapes to)) ; 7 October 1999
4068 ;; Fill and justify ...
4069 ;; Blank lines and initial spaces cause a break.
4070 ; (cond ((and (= (point) to) (not (looking-at ".nf"))) ; Yuk!!!
4071 ; ;; No text after a request that caused a break, so delete
4072 ; ;; any spurious blank line left:
4074 ; (if (looking-at "^\\s *$") (kill-line) (forward-line))))
4075 (while (< (point) to)
4076 (woman-leave-blank-lines)
4077 (let ((from (point)))
4078 ;; Indent first lin of paragraph:
4079 (indent-to (or woman-temp-indent left-margin))
4080 (woman-horizontal-escapes to) ; 7 October 1999
4081 ;; Find the beginning of the next paragraph:
4083 ; (if (re-search-forward "\\(^\\s *$\\)\\|\\(^\\s +\\)" to 1)
4084 ; ;; A blank line should leave a space like .sp 1 (p. 14).
4087 ; (skip-syntax-forward " ")
4088 ; (setq woman-leave-blank-lines 1))
4089 ; (setq woman-leave-blank-lines nil)))
4090 (and (re-search-forward "\\(^\\s *$\\)\\|\\(^\\s +\\)" to 1)
4091 ;; A blank line should leave a space like .sp 1 (p. 14).
4093 (skip-syntax-forward " ")
4094 (setq woman-leave-blank-lines 1))
4096 ;; If a single short line then just leave it.
4097 ;; This is necessary to preserve some table layouts.
4098 ;; PROBABLY NOT NECESSARY WITH SQUEEZE MODIFICATION !!!!!
4099 (if (or (> (count-lines from (point)) 1)
4102 (> (current-column) fill-column)))
4103 ;; ?roff does not squeeze multiple spaces
4104 ;; (fill-region-as-paragraph from (point) woman-justify t)
4105 ;; NOSQUEEZE has no effect if JUSTIFY is full, so
4106 ;; redefine canonically-space-region, see above.
4108 ;; Needs a re-write of the paragraph formatter to
4109 ;; avoid this nonsense to handle temporary indents!
4110 (if (and woman-temp-indent (< woman-temp-indent left-margin))
4111 (let ((left-margin woman-temp-indent))
4112 (fill-region-as-paragraph from (point) woman-justify)
4116 (setq from (point)))))
4117 (fill-region-as-paragraph from (point) woman-justify))
4119 ;; A blank line should leave a space like .sp 1 (p. 14).
4120 ;; Delete all but 1 trailing blank lines:
4121 ;;(woman-leave-blank-lines 1)
4124 (setq woman-temp-indent nil)
4125 ;; Non-white-space text has been processed, so ...
4126 ;;(setq woman-leave-blank-lines nil)
4130 ;;; Tagged, indented and hanging paragraphs:
4132 (defun woman2-TP (to)
4133 ".TP i -- Set prevailing indent to i. Format paragraphs upto TO.
4134 Begin indented paragraph with hanging tag given by next text line.
4135 If tag doesn't fit, place it on a separate line."
4136 (let ((i (woman2-get-prevailing-indent)))
4137 (woman-leave-blank-lines woman-interparagraph-distance)
4138 (woman2-tagged-paragraph to i)))
4140 (defun woman2-IP (to)
4141 ".IP x i -- Same as .TP with tag x. Format paragraphs upto TO."
4142 (woman-interparagraph-space)
4143 (if (eolp) ; no args
4144 ;; Like LP without resetting prevailing indent
4145 (woman2-format-paragraphs to (+ woman-left-margin
4146 woman-prevailing-indent))
4147 (woman-forward-arg 'unquote)
4148 (let ((i (woman2-get-prevailing-indent 'leave-eol)))
4150 (woman-leave-blank-lines) ; must be here,
4151 (woman2-tagged-paragraph to i))))
4153 (defun woman-find-next-control-line-carefully ()
4154 "Find and return start of next control line, even if already there!"
4155 (if (looking-at "^[.']")
4157 (woman-find-next-control-line)))
4159 (defun woman2-tagged-paragraph (to i)
4160 "Begin indented paragraph with hanging tag given by current text line.
4161 If tag doesn't fit, leave it on separate line.
4162 Format paragraphs upto TO. Set prevailing indent to I."
4163 (if (not (looking-at "\\s *$")) ; non-empty tag
4164 (setq woman-leave-blank-lines nil))
4166 ;; Temporary hack for bash.1 and groff_mmse.7 until code is revised
4167 ;; to process all requests uniformly:
4168 (cond ((and (= (point) to) (looking-at "^[.'][ \t]*\\(PD\\|br\\|ta\\) *"))
4169 (if (string= (match-string 1) "br")
4170 (woman-delete-line 1)
4171 (woman-delete-match 0)
4172 (if (string= (match-string 1) "ta") ; for GetInt.3
4174 (woman-set-interparagraph-distance)))
4175 (set-marker to (woman-find-next-control-line-carefully))
4178 (let ((tag (point)))
4179 (woman-reset-nospace)
4181 (woman2-process-escapes-to-eol)
4182 ;; TIDY UP THE FOLLOWING CODE
4183 ;; (indent-to woman-left-margin)
4184 (setq left-margin woman-left-margin)
4186 (fill-region-as-paragraph (save-excursion (forward-line -1) (point))
4187 (point) woman-justify)
4189 ;; Temporary hack for bash.1 until all requests processed uniformly:
4190 (cond ((and (= (point) to) (looking-at "^[.'][ \t]*PD *"))
4191 (woman-delete-match 0)
4192 (woman-set-interparagraph-distance)
4193 (set-marker to (woman-find-next-control-line-carefully))
4196 ;; Format the paragraph body, if there is one! Set indented left
4197 ;; margin anyway, because the paragraph body may begin with a
4199 (setq left-margin (+ woman-left-margin i))
4200 (cond ((< (point) to)
4201 (woman2-format-paragraphs to)
4202 (goto-char tag) (end-of-line)
4203 (cond ((> (setq i (- left-margin (current-column))) 0)
4205 (delete-horizontal-space)
4206 ;; Necessary to avoid spaces inheriting underlines.
4207 ;; Cannot simply delete (current-column) whitespace
4208 ;; characters because some may be tabs!
4209 (while (> i 0) (insert ? ) (setq i (1- i)))))
4210 (goto-char to) ; necessary ???
4214 (defun woman2-HP (to)
4215 ".HP i -- Set prevailing indent to i. Format paragraphs upto TO.
4216 Begin paragraph with hanging indent."
4217 (let ((i (woman2-get-prevailing-indent)))
4218 (woman-interparagraph-space)
4219 (setq woman-temp-indent woman-left-margin)
4220 (woman2-format-paragraphs to (+ woman-left-margin i))
4223 (defun woman2-get-prevailing-indent (&optional leave-eol)
4224 "Set prevailing indent to integer argument at point, and return it.
4225 If no argument then return the existing prevailing indent.
4226 Delete line from point and eol unless LEAVE-EOL is non-nil."
4228 (or leave-eol (delete-char 1))
4229 (let ((i (woman-get-numeric-arg)))
4230 (woman-delete-line) (or leave-eol (delete-char 1))
4231 ;; i = 0 if the argument was not a number
4232 (if (> i 0) (setq woman-prevailing-indent i))))
4233 woman-prevailing-indent)
4235 (defmacro woman-push (value stack)
4236 "Push VALUE onto STACK."
4237 `(setq ,stack (cons ,value ,stack)))
4239 (defmacro woman-pop (variable stack)
4240 "Pop into VARIABLE the value at the top of STACK.
4241 Allow for mismatched requests!"
4243 (setq ,variable (car ,stack)
4244 ,stack (cdr ,stack))))
4246 (defun woman2-RS (to)
4247 ".RS i -- Start relative indent, move left margin in distance i.
4248 Set prevailing indent to 5 for nested indents. Format paragraphs upto TO."
4249 (woman-push woman-left-margin woman-RS-left-margin)
4250 (woman-push woman-prevailing-indent woman-RS-prevailing-indent)
4251 (setq woman-left-margin (+ woman-left-margin
4252 (woman2-get-prevailing-indent))
4253 woman-prevailing-indent woman-default-indent)
4254 (woman2-format-paragraphs to woman-left-margin))
4256 (defun woman2-RE (to)
4257 ".RE -- End of relative indent. Format paragraphs upto TO.
4258 Set prevailing indent to amount of starting .RS."
4259 (woman-pop woman-left-margin woman-RS-left-margin)
4260 (woman-pop woman-prevailing-indent woman-RS-prevailing-indent)
4261 (woman-delete-line 1) ; ignore any arguments
4262 (woman2-format-paragraphs to woman-left-margin))
4265 ;;; Line Length and Indenting:
4267 (defun woman-set-arg (arg &optional previous)
4268 "Reset, increment or decrement argument ARG, which must be quoted.
4269 If no argument then use value of optional arg PREVIOUS if non-nil,
4270 otherwise set PREVIOUS. Delete the whole remaining control line."
4271 (if (eolp) ; space already skipped
4272 (set arg (if previous (eval previous) 0))
4273 (if previous (set previous (eval arg)))
4274 (woman2-process-escapes-to-eol 'numeric)
4275 (let ((pm (if (looking-at "[+-]")
4276 (prog1 (following-char)
4278 (i (woman-parse-numeric-arg)))
4279 (cond ((null pm) (set arg i))
4280 ((= pm ?+) (set arg (+ (eval arg) i)))
4281 ((= pm ?-) (set arg (- (eval arg) i)))
4283 (beginning-of-line))
4284 (woman-delete-line 1)) ; ignore any remaining arguments
4286 ;; NEED TO RATIONALIZE NAMES FOR PREVIOUS VALUES!
4287 (defvar woman-ll-fill-column woman-fill-column)
4288 (defvar woman-in-left-margin woman-left-margin)
4290 (defun woman2-ll (to)
4291 ".ll +/-N -- Set, increment or decrement line length.
4292 Format paragraphs upto TO. (Breaks, but should not.)"
4293 (woman-set-arg 'fill-column 'woman-ll-fill-column)
4294 (woman2-format-paragraphs to))
4296 (defun woman2-in (to)
4297 ".in +/-N -- Set, increment or decrement the indent.
4298 Format paragraphs upto TO."
4299 (woman-set-arg 'left-margin 'woman-in-left-margin)
4300 (woman2-format-paragraphs to))
4302 (defun woman2-ti (to)
4303 ".ti +/-N -- Temporary indent. Format paragraphs upto TO."
4304 ;; Ignore if no argument.
4305 ;; Indent next output line only wrt current indent.
4306 ;; Current indent is not changed.
4307 (setq woman-temp-indent left-margin)
4308 (woman-set-arg 'woman-temp-indent)
4309 (woman2-format-paragraphs to nil))
4312 ;;; Tabs, Leaders, and Fields:
4314 (defun woman2-ta (to)
4315 ".ta Nt ... -- Set tabs, left type, unless t=R(right), C(centered).
4316 \(Breaks, but should not.) The tab stops are separated by spaces\;
4317 a value preceded by + represents an increment to the previous stop value.
4318 Format paragraphs upto TO."
4319 (setq tab-stop-list nil)
4320 (woman2-process-escapes-to-eol 'numeric)
4324 (let ((plus (cond ((eq (following-char) ?+) (forward-char 1) t)))
4325 (i (woman-parse-numeric-arg)))
4326 (setq tab-stop (if plus (+ tab-stop i) i)))
4327 (if (memq (following-char) '(?R ?C))
4328 (setq tab-stop (cons tab-stop (following-char))))
4329 (setq tab-stop-list (cons tab-stop tab-stop-list))
4330 (skip-syntax-forward "^ ") ; skip following R, C, `;', etc.
4331 (skip-chars-forward " \t")
4333 (woman-delete-line 1) ; ignore any remaining arguments
4334 (setq tab-stop-list (reverse tab-stop-list))
4335 (woman2-format-paragraphs to))
4337 (defsubst woman-get-tab-stop (tab-stop-list)
4338 "If TAB-STOP-LIST is a cons, return its car, else return TAB-STOP-LIST."
4339 (if (consp tab-stop-list) (car tab-stop-list) tab-stop-list))
4341 (defun woman-tab-to-tab-stop ()
4342 "Insert spaces to next defined tab-stop column.
4343 The variable `tab-stop-list' is a list whose elements are either left
4344 tab stop columns or pairs (COLUMN . TYPE) where TYPE is R or C."
4345 ;; Based on tab-to-tab-stop in indent.el.
4346 ;; R & C tabs probably not quite right!
4347 (delete-backward-char 1)
4348 (let ((tabs tab-stop-list))
4349 (while (and tabs (>= (current-column)
4350 (woman-get-tab-stop (car tabs))))
4351 (setq tabs (cdr tabs)))
4353 (let* ((tab (car tabs))
4354 (type (and (consp tab) (cdr tab)))
4357 (setq tab (woman-get-tab-stop tab)
4358 eol (save-excursion (end-of-line) (point))
4360 (search-forward "\t" eol t))
4361 n (- (if n (1- n) eol) (point))
4362 tab (- tab (if (eq type ?C) (/ n 2) n))) )
4363 (setq n (- tab (current-column)))
4369 (defun woman2-DT (to)
4370 ".DT -- Restore default tabs. Format paragraphs upto TO.
4371 \(Breaks, but should not.)"
4372 ;; Currently just terminates special tab processing.
4373 (setq tab-stop-list nil)
4374 (woman-delete-line 1) ; ignore any arguments
4375 (woman2-format-paragraphs to))
4377 (defun woman2-fc (to)
4378 ".fc a b -- Set field delimiter a and pad character b.
4379 Format paragraphs upto TO.
4380 A VERY FIRST ATTEMPT to make fields at least readable!
4381 Needs doing properly!"
4383 (woman-delete-whole-line) ; ignore!
4384 (let ((delim (following-char))
4385 (pad ?\ ) end) ; pad defaults to space
4387 (skip-chars-forward " \t")
4388 (or (eolp) (setq pad (following-char)))
4389 (woman-delete-whole-line)
4391 (if (re-search-forward "^[.'][ \t]*fc\\s " nil t)
4392 (setq end (match-beginning 0))))
4393 ;; A field is contained between a pair of field delimiter
4394 ;; characters and consists of sub-strings separated by padding
4395 ;; indicator characters:
4396 (setq delim (string delim ?[ ?^ delim ?] ?* delim))
4398 (while (re-search-forward delim end t)
4399 (goto-char (match-beginning 0))
4401 (insert woman-unpadded-space-char)
4402 (goto-char (match-end 0))
4403 (delete-backward-char 1)
4404 (insert-before-markers woman-unpadded-space-char)
4405 (subst-char-in-region
4406 (match-beginning 0) (match-end 0)
4407 pad woman-unpadded-space-char t)
4410 (woman2-format-paragraphs to))
4413 ;;; Preliminary table support (.TS/.TE)
4415 (defun woman2-TS (to)
4416 ".TS -- Start of table code for the tbl processor.
4417 Format paragraphs upto TO."
4418 ;; This is a preliminary hack that seems to suffice for lilo.8.
4419 (woman-delete-line 1) ; ignore any arguments
4420 (when woman-emulate-tbl
4421 ;; Assumes column separator is \t and intercolumn spacing is 3.
4422 ;; The first line may optionally be a list of options terminated by
4423 ;; a semicolon. Currently, just delete it:
4424 (if (looking-at ".*;[ \t]*$") (woman-delete-line 1)) ;
4425 ;; The following lines must specify the format of each line of the
4426 ;; table and end with a period. Currently, just delete them:
4427 (while (not (looking-at ".*\\.[ \t]*$")) (woman-delete-line 1))
4428 (woman-delete-line 1)
4429 ;; For each column, find its width and align it:
4430 (let ((start (point)) (col 1))
4431 (while (prog1 (search-forward "\t" to t) (goto-char start))
4432 ;; Find current column width:
4433 (while (< (point) to)
4434 (when (search-forward "\t" to t)
4436 (if (> (current-column) col) (setq col (current-column))))
4438 ;; Align current column:
4440 (setq col (+ col 3)) ; intercolumn space
4441 (while (< (point) to)
4442 (when (search-forward "\t" to t)
4444 (insert-char ?\ (- col (current-column))))
4446 (goto-char start))))
4447 ;; Format table with no filling or adjusting (cf. woman2-nf):
4448 (setq woman-nofill t)
4449 (woman2-format-paragraphs to))
4451 (defalias 'woman2-TE 'woman2-fi)
4452 ;; ".TE -- End of table code for the tbl processor."
4453 ;; Turn filling and adjusting back on.
4456 ;;; WoMan message logging:
4458 ;; The basis for this logging code was shamelessly pirated from bytecomp.el
4459 ;; by Jamie Zawinski <jwz@lucid.com> & Hallvard Furuseth <hbf@ulrik.uio.no>
4461 (defvar WoMan-current-file nil) ; bound in woman-really-find-file
4462 (defvar WoMan-Log-header-point-max nil)
4464 (defun WoMan-log-begin ()
4465 "Log the beginning of formatting in *WoMan-Log*."
4466 (let ((WoMan-current-buffer (buffer-name)))
4468 (set-buffer (get-buffer-create "*WoMan-Log*"))
4469 (or (eq major-mode 'view-mode) (view-mode 1))
4470 (setq buffer-read-only nil)
4471 (goto-char (point-max))
4472 (insert "\n\^L\nFormatting "
4473 (if (stringp WoMan-current-file)
4474 (concat "file " WoMan-current-file)
4475 (concat "buffer " WoMan-current-buffer))
4476 " at " (current-time-string) "\n")
4477 (setq WoMan-Log-header-point-max (point-max))
4480 (defun WoMan-log (format &rest args)
4481 "Log a message out of FORMAT control string and optional ARGS."
4482 (WoMan-log-1 (apply 'format format args)))
4484 (defun WoMan-warn (format &rest args)
4485 "Log a warning message out of FORMAT control string and optional ARGS."
4486 (setq format (apply 'format format args))
4487 (WoMan-log-1 (concat "** " format)))
4489 (defun WoMan-warn-ignored (request ignored)
4490 "Log a warning message about ignored directive REQUEST.
4491 IGNORED is a string appended to the log message."
4493 (buffer-substring (point)
4494 (save-excursion (end-of-line) (point)))))
4495 (if (and (> (length tail) 0)
4496 (/= (string-to-char tail) ?\ ))
4497 (setq tail (concat " " tail)))
4499 (concat "** " request tail " request " ignored))))
4501 (defun WoMan-log-end (time)
4502 "Log the end of formatting in *WoMan-Log*.
4503 TIME specifies the time it took to format the man page, to be printed
4505 (WoMan-log-1 (format "Formatting time %d seconds." time) 'end))
4507 (defun WoMan-log-1 (string &optional end)
4508 "Log a message STRING in *WoMan-Log*.
4509 If optional argument END is non-nil then make buffer read-only after
4510 logging the message."
4512 (set-buffer (get-buffer-create "*WoMan-Log*"))
4513 (setq buffer-read-only nil)
4514 (goto-char (point-max))
4515 (or end (insert " ")) (insert string "\n")
4517 (setq buffer-read-only t)
4519 (select-window ; to return to
4520 (prog1 (selected-window) ; WoMan window
4521 (select-window (display-buffer (current-buffer)))
4522 (cond (WoMan-Log-header-point-max
4523 (goto-char WoMan-Log-header-point-max)
4527 nil) ; for woman-file-readable-p etc.
4531 ;;; arch-tag: eea35e90-552f-4712-a94b-d9ffd3db7651
4532 ;;; woman.el ends here