-;; GNU Emacs major mode for editing nroff source
-;; Copyright (C) 1985, 1986 Free Software Foundation, Inc.
+;;; 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 1, or (at your option)
+;; 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,
;; 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.
+;; 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-")
(defvar nroff-mode-abbrev-table nil
"Abbrev table used while in nroff mode.")
+(define-abbrev-table 'nroff-mode-abbrev-table ())
+
+(defcustom nroff-electric-mode nil
+ "*Non-nil means automatically closing requests when you insert an open."
+ :group 'nroff
+ :type 'boolean)
(defvar nroff-mode-map nil
- "Major mode keymap for nroff-mode buffers")
+ "Major mode keymap for nroff mode.")
(if (not nroff-mode-map)
(progn
(setq nroff-mode-map (make-sparse-keymap))
(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.")
+
+(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))
+
+;;;###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
+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)
- (set-syntax-table text-mode-syntax-table)
+ (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
+ ;; 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))
(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))
+ (setq paragraph-start (concat "[.']\\|" paragraph-start))
(make-local-variable 'paragraph-separate)
- (setq paragraph-separate (concat "^[.']\\|" 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 "\\\" ")
(setq comment-start-skip "\\\\\"[ \t]*")
(make-local-variable 'comment-column)
(setq comment-column 24)
- (make-local-variable 'comment-indent-hook)
- (setq comment-indent-hook 'nroff-comment-indent)
+ (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 ()
(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,
+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
(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."
+ "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)
(cond ((null arg) (null nroff-electric-mode))
(t (> (prefix-numeric-value arg) 0)))))
+(provide 'nroff-mode)
+
+;;; nroff-mode.el ends here
HCoop / bpt / emacs.git / blobdiff