(defgroup nroff nil
"Nroff mode."
:link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
: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?" '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)
map)
"Major mode keymap for `nroff-mode'.")
(defvar nroff-mode-syntax-table
(let ((st (copy-syntax-table text-mode-syntax-table)))
(modify-syntax-entry ?\" "\" 2" st)
(modify-syntax-entry ?\\ "\\ 1" st)
(modify-syntax-entry ?\n ">" st)
st)
"Syntax table used while in `nroff-mode'.")
(defvar nroff-imenu-expression
'((nil "^\\.SH \"?\\([^\"\n]*\\)\"?$" 1)))
(defcustom nroff-font-lock-keywords
(list
"^[.']\\s-*\\sw+"
(concat "\\\\" "\\(" (mapconcat 'identity
'("[f*n]*\\[.+?]" "(.." "[^(\"]" ) "\\|")
"\\)")
)
"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)
(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)
'(nroff-font-lock-keywords nil t nil backward-paragraph))
(set (make-local-variable 'outline-regexp) "\\.H[ ]+[1-7]+ ")
(set (make-local-variable 'outline-level) 'nroff-outline-level)
(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))
(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-number (buffer-substring (point) (+ 1 (point))))))
(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)))))) (goto-char pt))))
(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.
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" (nroff-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 nroff-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 nroff-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")
(nroff-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") (".na" . ".ad b")
(".nf" . ".fi")
(".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,
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))))
(define-minor-mode nroff-electric-mode
"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."
:lighter " Electric"
(or (derived-mode-p 'nroff-mode) (error "Must be in nroff mode")))
(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")
(define-obsolete-function-alias 'backward-text-line 'nroff-backward-text-line "22.1")
(define-obsolete-function-alias 'electric-nroff-newline 'nroff-electric-newline "22.1")
(define-obsolete-function-alias 'electric-nroff-mode 'nroff-electric-mode "22.1")
(provide 'nroff-mode)