;;; nroff-mode.el --- GNU Emacs major mode for editing nroff source
-;; Copyright (C) 1985, 1986 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 86, 94, 95, 97, 2001 Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: wp
;; 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:
;; 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.")
-
-(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)))
+(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
-(defun nroff-mode ()
+(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."
- (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)
- (setq local-abbrev-table nroff-mode-abbrev-table)
- (make-local-variable 'nroff-electric-mode)
+ (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
- (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))
+ (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
- (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))
+ (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
(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
HCoop / bpt / emacs.git / blobdiff