nroff-mode.el 9.86 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1
;;; nroff-mode.el --- GNU Emacs major mode for editing nroff source
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1985, 1986, 1994, 1995 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: wp
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Joseph Arceneaux's avatar
Joseph Arceneaux committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
13 14 15 16 17 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
24

25 26 27 28 29 30 31 32
;;; Commentary:

;; This package is a major mode for editing nroff source code.  It knows
;; about various nroff constructs, ms, mm, and me macros, and will fill
;; and indent paragraphs properly in their presence.  It also includes
;; a command to count text lines (excluding nroff constructs), a command
;; to center a line, and movement commands that know how to skip macros.

33 34 35
;; Paragraph filling and line-counting currently don't respect comments,
;; as they should.

Eric S. Raymond's avatar
Eric S. Raymond committed
36 37
;;; Code:

Richard M. Stallman's avatar
Richard M. Stallman committed
38 39
(defgroup nroff nil
  "Nroff mode."
40
  :group 'wp
Richard M. Stallman's avatar
Richard M. Stallman committed
41 42
  :prefix "nroff-")

Joseph Arceneaux's avatar
Joseph Arceneaux committed
43 44
(defvar nroff-mode-abbrev-table nil
  "Abbrev table used while in nroff mode.")
45
(define-abbrev-table 'nroff-mode-abbrev-table ())
Joseph Arceneaux's avatar
Joseph Arceneaux committed
46

Richard M. Stallman's avatar
Richard M. Stallman committed
47 48 49 50
(defcustom nroff-electric-mode nil
  "*Non-nil means automatically closing requests when you insert an open."
  :group 'nroff
  :type 'boolean)
51

Joseph Arceneaux's avatar
Joseph Arceneaux committed
52
(defvar nroff-mode-map nil
Brian Preble's avatar
Brian Preble committed
53
     "Major mode keymap for nroff mode.")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
54 55 56 57 58 59 60 61 62 63
(if (not nroff-mode-map)
    (progn
      (setq nroff-mode-map (make-sparse-keymap))
      (define-key nroff-mode-map "\t"  'tab-to-tab-stop)
      (define-key nroff-mode-map "\es" 'center-line)
      (define-key nroff-mode-map "\e?" 'count-text-lines)
      (define-key nroff-mode-map "\n"  'electric-nroff-newline)
      (define-key nroff-mode-map "\en" 'forward-text-line)
      (define-key nroff-mode-map "\ep" 'backward-text-line)))

64 65 66
(defvar nroff-mode-syntax-table nil
  "Syntax table used while in nroff mode.")

Richard M. Stallman's avatar
Richard M. Stallman committed
67
(defcustom nroff-font-lock-keywords
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
  (list
   ;; Directives are . or ' at start of line, followed by
   ;; optional whitespace, then command (which my be longer than
   ;; 2 characters in groff).  Perhaps the arguments should be
   ;; fontified as well.
   "^[.']\\s-*\\sw+"
   ;; There are numerous groff escapes; the following get things
   ;; like \-, \(em (standard troff) and \f[bar] (groff
   ;; variants).  This won't currently do groff's \A'foo' and
   ;; the like properly.  One might expect it to highlight an escape's
   ;; arguments in common cases, like \f.
   (concat "\\\\"                     ; backslash
         "\\("                        ; followed by various possibilities
         (mapconcat 'identity
                    '("[f*n]*\\[.+]"  ; some groff extensions
                      "(.."           ; two chars after (
                      "[^(\"]"        ; single char escape
                      ) "\\|")
         "\\)")
   )
Richard M. Stallman's avatar
Richard M. Stallman committed
88 89 90
  "Font-lock highlighting control in nroff-mode."
  :group 'nroff
  :type '(repeat regexp))
91

Eric S. Raymond's avatar
Eric S. Raymond committed
92
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
93 94 95
(defun nroff-mode ()
  "Major mode for editing text intended for nroff to format.
\\{nroff-mode-map}
Brian Preble's avatar
Brian Preble committed
96 97
Turning on Nroff mode runs `text-mode-hook', then `nroff-mode-hook'.
Also, try `nroff-electric-mode', for automatically inserting
Joseph Arceneaux's avatar
Joseph Arceneaux committed
98 99 100 101 102 103
closing requests for requests that are used in matched pairs."
  (interactive)
  (kill-all-local-variables)
  (use-local-map nroff-mode-map)
  (setq mode-name "Nroff")
  (setq major-mode 'nroff-mode)
104 105 106 107 108 109 110 111 112 113 114 115
  (if nroff-mode-syntax-table
      ()
    (setq nroff-mode-syntax-table (copy-syntax-table text-mode-syntax-table))
    ;; " isn't given string quote syntax in text-mode but it
    ;; (arguably) should be for use round nroff arguments (with ` and
    ;; ' used otherwise).
    (modify-syntax-entry ?\" "\"  2" nroff-mode-syntax-table)
    ;; Comments are delimited by \" and newline.
    (modify-syntax-entry ?\\ "\\  1" nroff-mode-syntax-table)
    (modify-syntax-entry ?\n ">  1" nroff-mode-syntax-table))
  (set-syntax-table nroff-mode-syntax-table)
  (make-local-variable 'font-lock-defaults)
116 117 118 119 120
  (setq font-lock-defaults
	;; SYNTAX-BEGIN is set to backward-paragraph to avoid slow-down
	;; near the end of large buffers due to searching to buffer's
	;; beginning.
	'(nroff-font-lock-keywords nil t nil backward-paragraph))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
121 122
  (setq local-abbrev-table nroff-mode-abbrev-table)
  (make-local-variable 'nroff-electric-mode)
123
  (setq nroff-electric-mode nil)
124 125 126
  (make-local-variable 'outline-regexp)
  (setq outline-regexp "\\.H[ ]+[1-7]+ ")
  (make-local-variable 'outline-level)
127
  (setq outline-level 'nroff-outline-level)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
128 129 130 131
  ;; now define a bunch of variables for use by commands in this mode
  (make-local-variable 'page-delimiter)
  (setq page-delimiter "^\\.\\(bp\\|SK\\|OP\\)")
  (make-local-variable 'paragraph-start)
132
  (setq paragraph-start (concat "[.']\\|" paragraph-start))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
133
  (make-local-variable 'paragraph-separate)
134
  (setq paragraph-separate (concat "[.']\\|" paragraph-separate))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
135 136 137 138 139 140 141
  ;; comment syntax added by mit-erl!gildea 18 Apr 86
  (make-local-variable 'comment-start)
  (setq comment-start "\\\" ")
  (make-local-variable 'comment-start-skip)
  (setq comment-start-skip "\\\\\"[ \t]*")
  (make-local-variable 'comment-column)
  (setq comment-column 24)
142 143
  (make-local-variable 'comment-indent-function)
  (setq comment-indent-function 'nroff-comment-indent)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
144 145
  (run-hooks 'text-mode-hook 'nroff-mode-hook))

146 147 148 149 150 151
(defun nroff-outline-level ()
  (save-excursion
    (looking-at outline-regexp)
    (skip-chars-forward ".H ")
    (string-to-int (buffer-substring (point) (+ 1 (point))))))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
;;; Compute how much to indent a comment in nroff/troff source.
;;; By mit-erl!gildea April 86
(defun nroff-comment-indent ()
  "Compute indent for an nroff/troff comment.
Puts a full-stop before comments on a line by themselves."
  (let ((pt (point)))
    (unwind-protect
	(progn
	  (skip-chars-backward " \t")
	  (if (bolp)
	      (progn
		(setq pt (1+ pt))
		(insert ?.)
		1)
	    (if (save-excursion
		  (backward-char 1)
		  (looking-at "^[.']"))
		1
	      (max comment-column
		   (* 8 (/ (+ (current-column)
			      9) 8)))))) ; add 9 to ensure at least two blanks
      (goto-char pt))))

(defun count-text-lines (start end &optional print)
  "Count lines in region, except for nroff request lines.
All lines not starting with a period are counted up.
Interactively, print result in echo area.
Noninteractively, return number of non-request lines from START to END."
  (interactive "r\np")
  (if print
      (message "Region has %d text lines" (count-text-lines start end))
    (save-excursion
      (save-restriction
	(narrow-to-region start end)
	(goto-char (point-min))
	(- (buffer-size) (forward-text-line (buffer-size)))))))

(defun forward-text-line (&optional cnt)
  "Go forward one nroff text line, skipping lines of nroff requests.
An argument is a repeat count; if negative, move backward."
  (interactive "p")
  (if (not cnt) (setq cnt 1))
  (while (and (> cnt 0) (not (eobp)))
    (forward-line 1)
    (while (and (not (eobp)) (looking-at "[.']."))
      (forward-line 1))
    (setq cnt (- cnt 1)))
  (while (and (< cnt 0) (not (bobp)))
    (forward-line -1)
    (while (and (not (bobp))
		(looking-at "[.']."))
      (forward-line -1))
    (setq cnt (+ cnt 1)))
  cnt)

(defun backward-text-line (&optional cnt)
  "Go backward one nroff text line, skipping lines of nroff requests.
An argument is a repeat count; negative means move forward."
  (interactive "p")
  (forward-text-line (- cnt)))

(defconst nroff-brace-table
  '((".(b" . ".)b")
    (".(l" . ".)l")
    (".(q" . ".)q")
    (".(c" . ".)c")
    (".(x" . ".)x")
    (".(z" . ".)z")
    (".(d" . ".)d")
    (".(f" . ".)f")
    (".LG" . ".NL")
    (".SM" . ".NL")
    (".LD" . ".DE")
    (".CD" . ".DE")
    (".BD" . ".DE")
    (".DS" . ".DE")
    (".DF" . ".DE")
    (".FS" . ".FE")
    (".KS" . ".KE")
    (".KF" . ".KE")
    (".LB" . ".LE")
    (".AL" . ".LE")
    (".BL" . ".LE")
    (".DL" . ".LE")
    (".ML" . ".LE")
    (".RL" . ".LE")
    (".VL" . ".LE")
    (".RS" . ".RE")
    (".TS" . ".TE")
    (".EQ" . ".EN")
    (".PS" . ".PE")
    (".BS" . ".BE")
    (".G1" . ".G2")			; grap
    (".na" . ".ad b")
    (".nf" . ".fi")
    (".de" . "..")))

(defun electric-nroff-newline (arg)
  "Insert newline for nroff mode; special if electric-nroff mode.
Brian Preble's avatar
Brian Preble committed
251
In `electric-nroff-mode', if ending a line containing an nroff opening request,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
automatically inserts the matching closing request after point."
  (interactive "P")
  (let ((completion (save-excursion
		      (beginning-of-line)
		      (and (null arg)
			   nroff-electric-mode
			   (<= (point) (- (point-max) 3))
			   (cdr (assoc (buffer-substring (point)
							 (+ 3 (point)))
				       nroff-brace-table)))))
	(needs-nl (not (looking-at "[ \t]*$"))))
    (if (null completion)
	(newline (prefix-numeric-value arg))
      (save-excursion
	(insert "\n\n" completion)
	(if needs-nl (insert "\n")))
      (forward-char 1))))

(defun electric-nroff-mode (&optional arg)
Brian Preble's avatar
Brian Preble committed
271 272 273 274 275
  "Toggle `nroff-electric-newline' minor mode.
`nroff-electric-newline' forces Emacs to check for an nroff request at the
beginning of the line, and insert the matching closing request if necessary.
This command toggles that mode (off->on, on->off), with an argument,
turns it on iff arg is positive, otherwise off."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
276 277 278 279 280 281 282 283 284 285
  (interactive "P")
  (or (eq major-mode 'nroff-mode) (error "Must be in nroff mode"))
  (or (assq 'nroff-electric-mode minor-mode-alist)
      (setq minor-mode-alist (append minor-mode-alist
				     (list '(nroff-electric-mode
					     " Electric")))))
  (setq nroff-electric-mode
	(cond ((null arg) (null nroff-electric-mode))
	      (t (> (prefix-numeric-value arg) 0)))))

Richard M. Stallman's avatar
Richard M. Stallman committed
286 287
(provide 'nroff-mode)

Eric S. Raymond's avatar
Eric S. Raymond committed
288
;;; nroff-mode.el ends here