1 ;;; nroff-mode.el --- GNU Emacs major mode for editing nroff source
3 ;; Copyright (C) 1985, 86, 94, 95, 97, 2001 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; This package is a major mode for editing nroff source code. It knows
28 ;; about various nroff constructs, ms, mm, and me macros, and will fill
29 ;; and indent paragraphs properly in their presence. It also includes
30 ;; a command to count text lines (excluding nroff constructs), a command
31 ;; to center a line, and movement commands that know how to skip macros.
33 ;; Paragraph filling and line-counting currently don't respect comments,
43 (defcustom nroff-electric-mode nil
44 "*Non-nil means automatically closing requests when you insert an open."
48 (defvar nroff-mode-map
49 (let ((map (make-sparse-keymap)))
50 (define-key map
"\t" 'tab-to-tab-stop
)
51 (define-key map
"\es" 'center-line
)
52 (define-key map
"\e?" 'count-text-lines
)
53 (define-key map
"\n" 'electric-nroff-newline
)
54 (define-key map
"\en" 'forward-text-line
)
55 (define-key map
"\ep" 'backward-text-line
)
57 "Major mode keymap for `nroff-mode'.")
59 (defvar nroff-mode-syntax-table
60 (let ((st (copy-syntax-table text-mode-syntax-table
)))
61 ;; " isn't given string quote syntax in text-mode but it
62 ;; (arguably) should be for use round nroff arguments (with ` and
64 (modify-syntax-entry ?
\" "\" 2" st
)
65 ;; Comments are delimited by \" and newline.
66 (modify-syntax-entry ?
\\ "\\ 1" st
)
67 (modify-syntax-entry ?
\n "> 1" st
)
69 "Syntax table used while in `nroff-mode'.")
71 (defvar nroff-imenu-expression
73 '((nil "^\\.SH \"?\\([^\"\n]*\\)\"?$" 1)))
75 (defcustom nroff-font-lock-keywords
77 ;; Directives are . or ' at start of line, followed by
78 ;; optional whitespace, then command (which my be longer than
79 ;; 2 characters in groff). Perhaps the arguments should be
82 ;; There are numerous groff escapes; the following get things
83 ;; like \-, \(em (standard troff) and \f[bar] (groff
84 ;; variants). This won't currently do groff's \A'foo' and
85 ;; the like properly. One might expect it to highlight an escape's
86 ;; arguments in common cases, like \f.
87 (concat "\\\\" ; backslash
88 "\\(" ; followed by various possibilities
90 '("[f*n]*\\[.+]" ; some groff extensions
91 "(.." ; two chars after (
92 "[^(\"]" ; single char escape
96 "Font-lock highlighting control in `nroff-mode'."
98 :type
'(repeat regexp
))
100 (defcustom nroff-mode-hook nil
101 "Hook run by function `nroff-mode'."
106 (define-derived-mode nroff-mode text-mode
"Nroff"
107 "Major mode for editing text intended for nroff to format.
109 Turning on Nroff mode runs `text-mode-hook', then `nroff-mode-hook'.
110 Also, try `nroff-electric-mode', for automatically inserting
111 closing requests for requests that are used in matched pairs."
112 (set (make-local-variable 'font-lock-defaults
)
113 ;; SYNTAX-BEGIN is set to backward-paragraph to avoid slow-down
114 ;; near the end of large buffers due to searching to buffer's
116 '(nroff-font-lock-keywords nil t nil backward-paragraph
))
117 (set (make-local-variable 'nroff-electric-mode
) nil
)
118 (set (make-local-variable 'outline-regexp
) "\\.H[ ]+[1-7]+ ")
119 (set (make-local-variable 'outline-level
) 'nroff-outline-level
)
120 ;; now define a bunch of variables for use by commands in this mode
121 (set (make-local-variable 'page-delimiter
) "^\\.\\(bp\\|SK\\|OP\\)")
122 (set (make-local-variable 'paragraph-start
)
123 (concat "[.']\\|" paragraph-start
))
124 (set (make-local-variable 'paragraph-separate
)
125 (concat "[.']\\|" paragraph-separate
))
126 ;; comment syntax added by mit-erl!gildea 18 Apr 86
127 (set (make-local-variable 'comment-start
) "\\\" ")
128 (set (make-local-variable 'comment-start-skip
) "\\\\\"[ \t]*")
129 (set (make-local-variable 'comment-column
) 24)
130 (set (make-local-variable 'comment-indent-function
) 'nroff-comment-indent
)
131 (set (make-local-variable 'imenu-generic-expression
) nroff-imenu-expression
))
133 (defun nroff-outline-level ()
135 (looking-at outline-regexp
)
136 (skip-chars-forward ".H ")
137 (string-to-int (buffer-substring (point) (+ 1 (point))))))
139 ;;; Compute how much to indent a comment in nroff/troff source.
140 ;;; By mit-erl!gildea April 86
141 (defun nroff-comment-indent ()
142 "Compute indent for an nroff/troff comment.
143 Puts a full-stop before comments on a line by themselves."
147 (skip-chars-backward " \t")
155 (looking-at "^[.']"))
158 (* 8 (/ (+ (current-column)
159 9) 8)))))) ; add 9 to ensure at least two blanks
162 (defun count-text-lines (start end
&optional print
)
163 "Count lines in region, except for nroff request lines.
164 All lines not starting with a period are counted up.
165 Interactively, print result in echo area.
166 Noninteractively, return number of non-request lines from START to END."
169 (message "Region has %d text lines" (count-text-lines start end
))
172 (narrow-to-region start end
)
173 (goto-char (point-min))
174 (- (buffer-size) (forward-text-line (buffer-size)))))))
176 (defun forward-text-line (&optional cnt
)
177 "Go forward one nroff text line, skipping lines of nroff requests.
178 An argument is a repeat count; if negative, move backward."
180 (if (not cnt
) (setq cnt
1))
181 (while (and (> cnt
0) (not (eobp)))
183 (while (and (not (eobp)) (looking-at "[.']."))
185 (setq cnt
(- cnt
1)))
186 (while (and (< cnt
0) (not (bobp)))
188 (while (and (not (bobp))
189 (looking-at "[.']."))
191 (setq cnt
(+ cnt
1)))
194 (defun backward-text-line (&optional cnt
)
195 "Go backward one nroff text line, skipping lines of nroff requests.
196 An argument is a repeat count; negative means move forward."
198 (forward-text-line (- cnt
)))
200 (defconst nroff-brace-table
231 (".G1" .
".G2") ; grap
236 (defun electric-nroff-newline (arg)
237 "Insert newline for nroff mode; special if electric-nroff mode.
238 In `electric-nroff-mode', if ending a line containing an nroff opening request,
239 automatically inserts the matching closing request after point."
241 (let ((completion (save-excursion
245 (<= (point) (- (point-max) 3))
246 (cdr (assoc (buffer-substring (point)
248 nroff-brace-table
)))))
249 (needs-nl (not (looking-at "[ \t]*$"))))
250 (if (null completion
)
251 (newline (prefix-numeric-value arg
))
253 (insert "\n\n" completion
)
254 (if needs-nl
(insert "\n")))
257 (defun electric-nroff-mode (&optional arg
)
258 "Toggle `nroff-electric-newline' minor mode.
259 `nroff-electric-newline' forces Emacs to check for an nroff request at the
260 beginning of the line, and insert the matching closing request if necessary.
261 This command toggles that mode (off->on, on->off), with an argument,
262 turns it on iff arg is positive, otherwise off."
264 (or (eq major-mode
'nroff-mode
) (error "Must be in nroff mode"))
265 (or (assq 'nroff-electric-mode minor-mode-alist
)
266 (setq minor-mode-alist
(append minor-mode-alist
267 (list '(nroff-electric-mode
269 (setq nroff-electric-mode
270 (cond ((null arg
) (null nroff-electric-mode
))
271 (t (> (prefix-numeric-value arg
) 0)))))
273 (provide 'nroff-mode
)
275 ;;; nroff-mode.el ends here