[bpt/emacs.git] / lisp / textmodes / nroff-mode.el

;;; nroff-mode.el --- GNU Emacs major mode for editing nroff source

;; Copyright (C) 1985, 1986, 1994, 1995 Free Software Foundation, Inc.

;; Maintainer: FSF
;; Keywords: wp

;; 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
;; the Free Software Foundation; either version 2, or (at your option)
;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

;;; 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.

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

;;; Code:

(defvar nroff-mode-abbrev-table nil
  "Abbrev table used while in nroff mode.")
(define-abbrev-table 'nroff-mode-abbrev-table ())

(defvar nroff-mode-map nil
     "Major mode keymap for nroff mode.")
(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)))

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

(defvar nroff-font-lock-keywords
  (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
                      ) "\\|")
         "\\)")
   )
  "Font-lock highlighting control in nroff-mode.")

;;;###autoload
(defun nroff-mode ()
  "Major mode for editing text intended for nroff to format.
\\{nroff-mode-map}
Turning on Nroff mode runs `text-mode-hook', then `nroff-mode-hook'.
Also, try `nroff-electric-mode', for automatically inserting
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)
  (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)
  (setq font-lock-defaults '(nroff-font-lock-keywords nil t))
  (setq local-abbrev-table nroff-mode-abbrev-table)
  (make-local-variable 'nroff-electric-mode)
  (setq nroff-electric-mode nil)
  (make-local-variable 'outline-regexp)
  (setq outline-regexp "\\.H[ ]+[1-7]+ ")
  (make-local-variable 'outline-level)
  (setq outline-level 'nroff-outline-level)
  ;; 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)
  (setq paragraph-start (concat "[.']\\|" paragraph-start))
  (make-local-variable 'paragraph-separate)
  (setq paragraph-separate (concat "[.']\\|" paragraph-separate))
  ;; 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)
  (make-local-variable 'comment-indent-function)
  (setq comment-indent-function 'nroff-comment-indent)
  (run-hooks 'text-mode-hook 'nroff-mode-hook))

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

;;; 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.
In `electric-nroff-mode', if ending a line containing an nroff opening request,
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)
  "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."
  (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)))))

;;; nroff-mode.el ends here
Commit	Line	Data
6594deb0	1	;;; nroff-mode.el --- GNU Emacs major mode for editing nroff source
4821e2af	2
878c1d73	3	;; Copyright (C) 1985, 1986, 1994, 1995 Free Software Foundation, Inc.
9750e079	4
4821e2af	5	;; Maintainer: FSF
d7b4d18f	6	;; Keywords: wp
4821e2af	7
a2535589 JA	8	;; This file is part of GNU Emacs.
	9
	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
e5167999	12	;; the Free Software Foundation; either version 2, or (at your option)
a2535589 JA	13	;; any later version.
	14
	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.
	19
	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
	22	;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
	23
edbd2f74 ER	24	;;; Commentary:
	25
	26	;; This package is a major mode for editing nroff source code. It knows
	27	;; about various nroff constructs, ms, mm, and me macros, and will fill
	28	;; and indent paragraphs properly in their presence. It also includes
	29	;; a command to count text lines (excluding nroff constructs), a command
	30	;; to center a line, and movement commands that know how to skip macros.
	31
878c1d73 RS	32	;; Paragraph filling and line-counting currently don't respect comments,
	33	;; as they should.
	34
4821e2af ER	35	;;; Code:
4821e2af ER	36
a2535589 JA	37	(defvar nroff-mode-abbrev-table nil
a2535589 JA	38	"Abbrev table used while in nroff mode.")
fb314468	39	(define-abbrev-table 'nroff-mode-abbrev-table ())
a2535589 JA	40
a2535589 JA	41	(defvar nroff-mode-map nil
6d1f885f	42	"Major mode keymap for nroff mode.")
a2535589 JA	43	(if (not nroff-mode-map)
	44	(progn
	45	(setq nroff-mode-map (make-sparse-keymap))
	46	(define-key nroff-mode-map "\t" 'tab-to-tab-stop)
	47	(define-key nroff-mode-map "\es" 'center-line)
	48	(define-key nroff-mode-map "\e?" 'count-text-lines)
	49	(define-key nroff-mode-map "\n" 'electric-nroff-newline)
	50	(define-key nroff-mode-map "\en" 'forward-text-line)
	51	(define-key nroff-mode-map "\ep" 'backward-text-line)))
	52
878c1d73 RS	53	(defvar nroff-mode-syntax-table nil
	54	"Syntax table used while in nroff mode.")
	55
	56	(defvar nroff-font-lock-keywords
	57	(list
	58	;; Directives are . or ' at start of line, followed by
	59	;; optional whitespace, then command (which my be longer than
	60	;; 2 characters in groff). Perhaps the arguments should be
	61	;; fontified as well.
	62	"^[.']\\s-*\\sw+"
	63	;; There are numerous groff escapes; the following get things
	64	;; like \-, \(em (standard troff) and \f[bar] (groff
	65	;; variants). This won't currently do groff's \A'foo' and
	66	;; the like properly. One might expect it to highlight an escape's
	67	;; arguments in common cases, like \f.
	68	(concat "\\\\" ; backslash
	69	"\\(" ; followed by various possibilities
	70	(mapconcat 'identity
	71	'("[fn]\\[.+]" ; some groff extensions
	72	"(.." ; two chars after (
	73	"[^(\"]" ; single char escape
	74	) "\\\|")
	75	"\\)")
	76	)
	77	"Font-lock highlighting control in nroff-mode.")
	78
6594deb0	79	;;;###autoload
a2535589 JA	80	(defun nroff-mode ()
	81	"Major mode for editing text intended for nroff to format.
	82	\\{nroff-mode-map}
6d1f885f BP	83	Turning on Nroff mode runs `text-mode-hook', then `nroff-mode-hook'.
6d1f885f BP	84	Also, try `nroff-electric-mode', for automatically inserting
a2535589 JA	85	closing requests for requests that are used in matched pairs."
	86	(interactive)
	87	(kill-all-local-variables)
	88	(use-local-map nroff-mode-map)
	89	(setq mode-name "Nroff")
	90	(setq major-mode 'nroff-mode)
878c1d73 RS	91	(if nroff-mode-syntax-table
	92	()
	93	(setq nroff-mode-syntax-table (copy-syntax-table text-mode-syntax-table))
	94	;; " isn't given string quote syntax in text-mode but it
	95	;; (arguably) should be for use round nroff arguments (with ` and
	96	;; ' used otherwise).
	97	(modify-syntax-entry ?\" "\" 2" nroff-mode-syntax-table)
	98	;; Comments are delimited by \" and newline.
	99	(modify-syntax-entry ?\\ "\\ 1" nroff-mode-syntax-table)
	100	(modify-syntax-entry ?\n "> 1" nroff-mode-syntax-table))
	101	(set-syntax-table nroff-mode-syntax-table)
	102	(make-local-variable 'font-lock-defaults)
	103	(setq font-lock-defaults '(nroff-font-lock-keywords nil t))
a2535589 JA	104	(setq local-abbrev-table nroff-mode-abbrev-table)
a2535589 JA	105	(make-local-variable 'nroff-electric-mode)
b1ee6b34	106	(setq nroff-electric-mode nil)
a6234246 RS	107	(make-local-variable 'outline-regexp)
	108	(setq outline-regexp "\\.H[ ]+[1-7]+ ")
	109	(make-local-variable 'outline-level)
589479d1	110	(setq outline-level 'nroff-outline-level)
a2535589 JA	111	;; now define a bunch of variables for use by commands in this mode
	112	(make-local-variable 'page-delimiter)
	113	(setq page-delimiter "^\\.\\(bp\\\|SK\\\|OP\\)")
	114	(make-local-variable 'paragraph-start)
0608d57e	115	(setq paragraph-start (concat "[.']\\\|" paragraph-start))
a2535589	116	(make-local-variable 'paragraph-separate)
0608d57e	117	(setq paragraph-separate (concat "[.']\\\|" paragraph-separate))
a2535589 JA	118	;; comment syntax added by mit-erl!gildea 18 Apr 86
	119	(make-local-variable 'comment-start)
	120	(setq comment-start "\\\" ")
	121	(make-local-variable 'comment-start-skip)
	122	(setq comment-start-skip "\\\\\"[ \t]*")
	123	(make-local-variable 'comment-column)
	124	(setq comment-column 24)
e41b2db1 ER	125	(make-local-variable 'comment-indent-function)
e41b2db1 ER	126	(setq comment-indent-function 'nroff-comment-indent)
a2535589 JA	127	(run-hooks 'text-mode-hook 'nroff-mode-hook))
a2535589 JA	128
a6234246 RS	129	(defun nroff-outline-level ()
	130	(save-excursion
	131	(looking-at outline-regexp)
	132	(skip-chars-forward ".H ")
	133	(string-to-int (buffer-substring (point) (+ 1 (point))))))
	134
a2535589 JA	135	;;; Compute how much to indent a comment in nroff/troff source.
	136	;;; By mit-erl!gildea April 86
	137	(defun nroff-comment-indent ()
	138	"Compute indent for an nroff/troff comment.
	139	Puts a full-stop before comments on a line by themselves."
	140	(let ((pt (point)))
	141	(unwind-protect
	142	(progn
	143	(skip-chars-backward " \t")
	144	(if (bolp)
	145	(progn
	146	(setq pt (1+ pt))
	147	(insert ?.)
	148	1)
	149	(if (save-excursion
	150	(backward-char 1)
	151	(looking-at "^[.']"))
	152	1
	153	(max comment-column
	154	(* 8 (/ (+ (current-column)
	155	9) 8)))))) ; add 9 to ensure at least two blanks
	156	(goto-char pt))))
	157
	158	(defun count-text-lines (start end &optional print)
	159	"Count lines in region, except for nroff request lines.
	160	All lines not starting with a period are counted up.
	161	Interactively, print result in echo area.
	162	Noninteractively, return number of non-request lines from START to END."
	163	(interactive "r\np")
	164	(if print
	165	(message "Region has %d text lines" (count-text-lines start end))
	166	(save-excursion
	167	(save-restriction
	168	(narrow-to-region start end)
	169	(goto-char (point-min))
	170	(- (buffer-size) (forward-text-line (buffer-size)))))))
	171
	172	(defun forward-text-line (&optional cnt)
	173	"Go forward one nroff text line, skipping lines of nroff requests.
	174	An argument is a repeat count; if negative, move backward."
	175	(interactive "p")
	176	(if (not cnt) (setq cnt 1))
	177	(while (and (> cnt 0) (not (eobp)))
	178	(forward-line 1)
	179	(while (and (not (eobp)) (looking-at "[.']."))
	180	(forward-line 1))
	181	(setq cnt (- cnt 1)))
	182	(while (and (< cnt 0) (not (bobp)))
	183	(forward-line -1)
	184	(while (and (not (bobp))
	185	(looking-at "[.']."))
	186	(forward-line -1))
	187	(setq cnt (+ cnt 1)))
	188	cnt)
	189
	190	(defun backward-text-line (&optional cnt)
	191	"Go backward one nroff text line, skipping lines of nroff requests.
	192	An argument is a repeat count; negative means move forward."
	193	(interactive "p")
	194	(forward-text-line (- cnt)))
	195
	196	(defconst nroff-brace-table
	197	'((".(b" . ".)b")
	198	(".(l" . ".)l")
199	(".(q" . ".)q")
200	(".(c" . ".)c")
201	(".(x" . ".)x")
202	(".(z" . ".)z")
203	(".(d" . ".)d")
204	(".(f" . ".)f")
205	(".LG" . ".NL")
206	(".SM" . ".NL")
207	(".LD" . ".DE")
208	(".CD" . ".DE")
209	(".BD" . ".DE")
210	(".DS" . ".DE")
211	(".DF" . ".DE")
212	(".FS" . ".FE")
213	(".KS" . ".KE")
214	(".KF" . ".KE")
215	(".LB" . ".LE")
216	(".AL" . ".LE")
217	(".BL" . ".LE")
218	(".DL" . ".LE")
219	(".ML" . ".LE")
220	(".RL" . ".LE")
221	(".VL" . ".LE")
222	(".RS" . ".RE")
223	(".TS" . ".TE")
224	(".EQ" . ".EN")
225	(".PS" . ".PE")
226	(".BS" . ".BE")
227	(".G1" . ".G2") ; grap
228	(".na" . ".ad b")
229	(".nf" . ".fi")
230	(".de" . "..")))
231
232	(defun electric-nroff-newline (arg)
233	"Insert newline for nroff mode; special if electric-nroff mode.
6d1f885f	234	In `electric-nroff-mode', if ending a line containing an nroff opening request,
a2535589 JA	235	automatically inserts the matching closing request after point."
	236	(interactive "P")
	237	(let ((completion (save-excursion
	238	(beginning-of-line)
	239	(and (null arg)
	240	nroff-electric-mode
	241	(<= (point) (- (point-max) 3))
	242	(cdr (assoc (buffer-substring (point)
	243	(+ 3 (point)))
	244	nroff-brace-table)))))
	245	(needs-nl (not (looking-at "[ \t]*$"))))
	246	(if (null completion)
	247	(newline (prefix-numeric-value arg))
	248	(save-excursion
	249	(insert "\n\n" completion)
	250	(if needs-nl (insert "\n")))
	251	(forward-char 1))))
	252
	253	(defun electric-nroff-mode (&optional arg)
6d1f885f BP	254	"Toggle `nroff-electric-newline' minor mode.
	255	`nroff-electric-newline' forces Emacs to check for an nroff request at the
	256	beginning of the line, and insert the matching closing request if necessary.
	257	This command toggles that mode (off->on, on->off), with an argument,
	258	turns it on iff arg is positive, otherwise off."
a2535589 JA	259	(interactive "P")
	260	(or (eq major-mode 'nroff-mode) (error "Must be in nroff mode"))
	261	(or (assq 'nroff-electric-mode minor-mode-alist)
	262	(setq minor-mode-alist (append minor-mode-alist
	263	(list '(nroff-electric-mode
	264	" Electric")))))
	265	(setq nroff-electric-mode
	266	(cond ((null arg) (null nroff-electric-mode))
	267	(t (> (prefix-numeric-value arg) 0)))))
	268
6594deb0	269	;;; nroff-mode.el ends here