;;; nroff-mode.el --- GNU Emacs major mode for editing nroff source
;; Copyright (C) 1985, 1986, 1994, 1995, 1997, 2001, 2002, 2003,
-;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
+;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 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
+;; 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 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, 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
;; 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., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
:type 'boolean)
(defvar nroff-mode-map
- (let ((map (make-sparse-keymap)))
+ (let ((map (make-sparse-keymap))
+ (menu-map (make-sparse-keymap)))
(define-key map "\t" 'tab-to-tab-stop)
(define-key map "\es" 'center-line)
(define-key map "\e?" 'nroff-count-text-lines)
(define-key map "\n" 'nroff-electric-newline)
(define-key map "\en" 'nroff-forward-text-line)
(define-key map "\ep" 'nroff-backward-text-line)
+ (define-key map "\C-c\C-c" 'nroff-view)
+ (define-key map [menu-bar nroff-mode] (cons "Nroff" menu-map))
+ (define-key menu-map [nn]
+ '(menu-item "Newline" nroff-electric-newline
+ :help "Insert newline for nroff mode; special if nroff-electric mode"))
+ (define-key menu-map [nc]
+ '(menu-item "Count text lines" nroff-count-text-lines
+ :help "Count lines in region, except for nroff request lines."))
+ (define-key menu-map [nf]
+ '(menu-item "Forward text line" nroff-forward-text-line
+ :help "Go forward one nroff text line, skipping lines of nroff requests"))
+ (define-key menu-map [nb]
+ '(menu-item "Backward text line" nroff-backward-text-line
+ :help "Go backward one nroff text line, skipping lines of nroff requests"))
+ (define-key menu-map [ne]
+ '(menu-item "Electric newline mode"
+ nroff-electric-mode
+ :help "Auto insert closing requests if necessary"
+ :button (:toggle . nroff-electric-mode)))
+ (define-key menu-map [npm]
+ '(menu-item "Preview as man page" nroff-view
+ :help "Run man on this file."))
map)
"Major mode keymap for `nroff-mode'.")
(concat "[.']\\|" paragraph-start))
(set (make-local-variable 'paragraph-separate)
(concat "[.']\\|" paragraph-separate))
+ ;; Don't auto-fill directive lines starting . or ' since they normally
+ ;; have to be one line. But do auto-fill comments .\" .\# and '''.
+ ;; Comment directives (those starting . or ') are [.'][ \t]*\\[#"]
+ ;; or ''', and this regexp is everything except those. So [.']
+ ;; followed by not backslash and not ' or followed by backslash but
+ ;; then not # or "
+ (set (make-local-variable 'auto-fill-inhibit-regexp)
+ "[.'][ \t]*\\([^ \t\\']\\|\\\\[^#\"]\\)")
;; 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 'comment-insert-comment-function)
+ 'nroff-insert-comment-function)
(set (make-local-variable 'imenu-generic-expression) nroff-imenu-expression))
(defun nroff-outline-level ()
(skip-chars-backward " \t")
(if (bolp)
(progn
+ ;; FIXME delete-horizontal-space?
(setq pt (1+ pt))
(insert ?.)
1)
9) 8)))))) ; add 9 to ensure at least two blanks
(goto-char pt))))
+;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg01869.html
+(defun nroff-insert-comment-function ()
+ "Function for `comment-insert-comment-function' in `nroff-mode'."
+ (indent-to (nroff-comment-indent))
+ (insert comment-start))
+
(defun nroff-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.
(save-restriction
(narrow-to-region start end)
(goto-char (point-min))
- (- (buffer-size) (forward-text-line (buffer-size)))))))
+ (- (buffer-size) (nroff-forward-text-line (buffer-size)))))))
(defun nroff-forward-text-line (&optional cnt)
"Go forward one nroff text line, skipping lines of nroff requests.
(".de" . "..")))
(defun nroff-electric-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,
+ "Insert newline for nroff mode; special if nroff-electric mode.
+In `nroff-electric-mode', if ending a line containing an nroff opening request,
automatically inserts the matching closing request after point."
(interactive "P")
(let ((completion (save-excursion
:lighter " Electric"
(or (derived-mode-p 'nroff-mode) (error "Must be in nroff mode")))
+(declare-function Man-getpage-in-background "man" (topic))
+
+(defun nroff-view ()
+ "Run man on this file."
+ (interactive)
+ (require 'man)
+ (let* ((file (buffer-file-name))
+ (viewbuf (get-buffer (concat "*Man " file "*"))))
+ (unless file
+ (error "Buffer is not associated with any file"))
+ (and (buffer-modified-p)
+ (y-or-n-p (format "Save buffer %s first? " (buffer-name)))
+ (save-buffer))
+ (if viewbuf
+ (kill-buffer viewbuf))
+ (Man-getpage-in-background file)))
+
;; Old names that were not namespace clean.
(define-obsolete-function-alias 'count-text-lines 'nroff-count-text-lines "22.1")
(define-obsolete-function-alias 'forward-text-line 'nroff-forward-text-line "22.1")
HCoop / bpt / emacs.git / blobdiff