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

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

;; Copyright (C) 1985, 86, 94, 95, 97, 2001  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, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, 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:

(defgroup nroff nil
  "Nroff mode."
  :group 'wp
  :prefix "nroff-")

(defcustom nroff-electric-mode nil
  "*Non-nil means automatically closing requests when you insert an open."
  :group 'nroff
  :type 'boolean)

(defvar nroff-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map "\t"  'tab-to-tab-stop)
    (define-key map "\es" 'center-line)
    (define-key map "\e?" 'count-text-lines)
    (define-key map "\n"  'electric-nroff-newline)
    (define-key map "\en" 'forward-text-line)
    (define-key map "\ep" 'backward-text-line)
    map)
  "Major mode keymap for `nroff-mode'.")

(defvar nroff-mode-syntax-table
  (let ((st (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" st)
    ;; Comments are delimited by \" and newline.
    (modify-syntax-entry ?\\ "\\  1" st)
    (modify-syntax-entry ?\n ">  1" st)
    st)
  "Syntax table used while in `nroff-mode'.")

(defvar nroff-imenu-expression
  ;; man headers:
  '((nil "^\\.SH \"?\\([^\"\n]*\\)\"?$" 1)))

(defcustom 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'."
  :group 'nroff
  :type '(repeat regexp))

(defcustom nroff-mode-hook nil
  "Hook run by function `nroff-mode'."
  :type 'hook
  :group 'nroff)

;;;###autoload
(define-derived-mode nroff-mode text-mode "Nroff"
  "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."
  (set (make-local-variable '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))
  (set (make-local-variable 'nroff-electric-mode) nil)
  (set (make-local-variable 'outline-regexp) "\\.H[ ]+[1-7]+ ")
  (set (make-local-variable 'outline-level) 'nroff-outline-level)
  ;; now define a bunch of variables for use by commands in this mode
  (set (make-local-variable 'page-delimiter) "^\\.\\(bp\\|SK\\|OP\\)")
  (set (make-local-variable 'paragraph-start)
       (concat "[.']\\|" paragraph-start))
  (set (make-local-variable 'paragraph-separate)
       (concat "[.']\\|" paragraph-separate))
  ;; comment syntax added by mit-erl!gildea 18 Apr 86
  (set (make-local-variable 'comment-start) "\\\" ")
  (set (make-local-variable 'comment-start-skip) "\\\\\"[ \t]*")
  (set (make-local-variable 'comment-column) 24)
  (set (make-local-variable 'comment-indent-function) 'nroff-comment-indent)
  (set (make-local-variable 'imenu-generic-expression) nroff-imenu-expression))

(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)))))

(provide 'nroff-mode)

;;; arch-tag: 6e276340-6c65-4f65-b4e3-0ca431ddfb6c
;;; nroff-mode.el ends here
Commit	Line	Data
6594deb0	1	;;; nroff-mode.el --- GNU Emacs major mode for editing nroff source
4821e2af	2
500acb79	3	;; Copyright (C) 1985, 86, 94, 95, 97, 2001 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
b578f267 EN	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.
a2535589	24
edbd2f74 ER	25	;;; Commentary:
	26
	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.
	32
878c1d73 RS	33	;; Paragraph filling and line-counting currently don't respect comments,
	34	;; as they should.
	35
4821e2af ER	36	;;; Code:
4821e2af ER	37
e4550233 RS	38	(defgroup nroff nil
e4550233 RS	39	"Nroff mode."
e8955f1d	40	:group 'wp
e4550233 RS	41	:prefix "nroff-")
e4550233 RS	42
e4550233 RS	43	(defcustom nroff-electric-mode nil
	44	"*Non-nil means automatically closing requests when you insert an open."
	45	:group 'nroff
	46	:type 'boolean)
934b4e4f	47
74ac2467 GM	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)
	56	map)
	57	"Major mode keymap for `nroff-mode'.")
	58
	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
	63	;; ' used otherwise).
	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)
	68	st)
	69	"Syntax table used while in `nroff-mode'.")
878c1d73	70
500acb79 DL	71	(defvar nroff-imenu-expression
	72	;; man headers:
	73	'((nil "^\\.SH \"?\\([^\"\n]*\\)\"?$" 1)))
	74
e4550233	75	(defcustom nroff-font-lock-keywords
878c1d73 RS	76	(list
	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
	80	;; fontified as well.
	81	"^[.']\\s-*\\sw+"
	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
	89	(mapconcat 'identity
	90	'("[fn]\\[.+]" ; some groff extensions
	91	"(.." ; two chars after (
	92	"[^(\"]" ; single char escape
	93	) "\\\|")
	94	"\\)")
	95	)
74ac2467	96	"Font-lock highlighting control in `nroff-mode'."
e4550233 RS	97	:group 'nroff
e4550233 RS	98	:type '(repeat regexp))
878c1d73	99
500acb79 DL	100	(defcustom nroff-mode-hook nil
	101	"Hook run by function `nroff-mode'."
	102	:type 'hook
	103	:group 'nroff)
	104
6594deb0	105	;;;###autoload
74ac2467	106	(define-derived-mode nroff-mode text-mode "Nroff"
a2535589 JA	107	"Major mode for editing text intended for nroff to format.
a2535589 JA	108	\\{nroff-mode-map}
6d1f885f BP	109	Turning on Nroff mode runs `text-mode-hook', then `nroff-mode-hook'.
6d1f885f BP	110	Also, try `nroff-electric-mode', for automatically inserting
a2535589	111	closing requests for requests that are used in matched pairs."
74ac2467 GM	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
	115	;; beginning.
	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)
a2535589	120	;; now define a bunch of variables for use by commands in this mode
74ac2467 GM	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))
a2535589	126	;; comment syntax added by mit-erl!gildea 18 Apr 86
74ac2467 GM	127	(set (make-local-variable 'comment-start) "\\\" ")
	128	(set (make-local-variable 'comment-start-skip) "\\\\\"[ \t]*")
	129	(set (make-local-variable 'comment-column) 24)
500acb79 DL	130	(set (make-local-variable 'comment-indent-function) 'nroff-comment-indent)
500acb79 DL	131	(set (make-local-variable 'imenu-generic-expression) nroff-imenu-expression))
a2535589	132
a6234246 RS	133	(defun nroff-outline-level ()
	134	(save-excursion
	135	(looking-at outline-regexp)
	136	(skip-chars-forward ".H ")
	137	(string-to-int (buffer-substring (point) (+ 1 (point))))))
	138
a2535589 JA	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."
	144	(let ((pt (point)))
	145	(unwind-protect
	146	(progn
	147	(skip-chars-backward " \t")
	148	(if (bolp)
	149	(progn
	150	(setq pt (1+ pt))
	151	(insert ?.)
	152	1)
	153	(if (save-excursion
	154	(backward-char 1)
	155	(looking-at "^[.']"))
	156	1
	157	(max comment-column
	158	(* 8 (/ (+ (current-column)
	159	9) 8)))))) ; add 9 to ensure at least two blanks
	160	(goto-char pt))))
	161
	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."
	167	(interactive "r\np")
	168	(if print
	169	(message "Region has %d text lines" (count-text-lines start end))
	170	(save-excursion
	171	(save-restriction
	172	(narrow-to-region start end)
	173	(goto-char (point-min))
	174	(- (buffer-size) (forward-text-line (buffer-size)))))))
	175
	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."
	179	(interactive "p")
	180	(if (not cnt) (setq cnt 1))
	181	(while (and (> cnt 0) (not (eobp)))
	182	(forward-line 1)
	183	(while (and (not (eobp)) (looking-at "[.']."))
	184	(forward-line 1))
	185	(setq cnt (- cnt 1)))
	186	(while (and (< cnt 0) (not (bobp)))
	187	(forward-line -1)
	188	(while (and (not (bobp))
	189	(looking-at "[.']."))
	190	(forward-line -1))
	191	(setq cnt (+ cnt 1)))
	192	cnt)
	193
	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."
	197	(interactive "p")
	198	(forward-text-line (- cnt)))
	199
	200	(defconst nroff-brace-table
	201	'((".(b" . ".)b")
	202	(".(l" . ".)l")
203	(".(q" . ".)q")
204	(".(c" . ".)c")
205	(".(x" . ".)x")
206	(".(z" . ".)z")
207	(".(d" . ".)d")
208	(".(f" . ".)f")
209	(".LG" . ".NL")
210	(".SM" . ".NL")
211	(".LD" . ".DE")
212	(".CD" . ".DE")
213	(".BD" . ".DE")
214	(".DS" . ".DE")
215	(".DF" . ".DE")
216	(".FS" . ".FE")
217	(".KS" . ".KE")
218	(".KF" . ".KE")
219	(".LB" . ".LE")
220	(".AL" . ".LE")
221	(".BL" . ".LE")
222	(".DL" . ".LE")
223	(".ML" . ".LE")
224	(".RL" . ".LE")
225	(".VL" . ".LE")
226	(".RS" . ".RE")
227	(".TS" . ".TE")
228	(".EQ" . ".EN")
229	(".PS" . ".PE")
230	(".BS" . ".BE")
231	(".G1" . ".G2") ; grap
232	(".na" . ".ad b")
233	(".nf" . ".fi")
234	(".de" . "..")))
235
236	(defun electric-nroff-newline (arg)
237	"Insert newline for nroff mode; special if electric-nroff mode.
6d1f885f	238	In `electric-nroff-mode', if ending a line containing an nroff opening request,
a2535589 JA	239	automatically inserts the matching closing request after point."
	240	(interactive "P")
	241	(let ((completion (save-excursion
	242	(beginning-of-line)
	243	(and (null arg)
	244	nroff-electric-mode
	245	(<= (point) (- (point-max) 3))
	246	(cdr (assoc (buffer-substring (point)
	247	(+ 3 (point)))
	248	nroff-brace-table)))))
	249	(needs-nl (not (looking-at "[ \t]*$"))))
	250	(if (null completion)
	251	(newline (prefix-numeric-value arg))
	252	(save-excursion
	253	(insert "\n\n" completion)
	254	(if needs-nl (insert "\n")))
	255	(forward-char 1))))
	256
	257	(defun electric-nroff-mode (&optional arg)
6d1f885f BP	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."
a2535589 JA	263	(interactive "P")
	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
	268	" Electric")))))
	269	(setq nroff-electric-mode
	270	(cond ((null arg) (null nroff-electric-mode))
	271	(t (> (prefix-numeric-value arg) 0)))))
	272
896546cd RS	273	(provide 'nroff-mode)
896546cd RS	274
6b61353c	275	;;; arch-tag: 6e276340-6c65-4f65-b4e3-0ca431ddfb6c
6594deb0	276	;;; nroff-mode.el ends here