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