lisp/text-mode.el

   1 ;;; text-mode.el --- text mode, and its idiosyncratic commands.
   2
   3 ;; Copyright (C) 1985, 1992, 1994, 1997 Free Software Foundation, Inc.
   4
   5 ;; Maintainer: FSF
   6 ;; Keywords: wp, dumped
   7
   8 ;; This file is part of XEmacs.
   9
  10 ;; XEmacs is free software; you can redistribute it and/or modify it
  11 ;; under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; XEmacs is distributed in the hope that it will be useful, but
  16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 ;; General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
  22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  23 ;; 02111-1307, USA.
  24
  25 ;;; Synched up with: FSF 20.2.
  26
  27 ;;; Commentary:
  28
  29 ;; This file is dumped with XEmacs.
  30
  31 ;; This package provides the fundamental text mode documented in the
  32 ;; Emacs user's manual.
  33
  34 ;;; Code:
  35
  36 (defvar text-mode-hook nil
  37   "Normal hook run when entering Text mode and many related modes.")
  38
  39 (defvar text-mode-variant nil
  40   "Non-nil if this buffer's major mode is a variant of Text mode.")
  41
  42 (defvar text-mode-syntax-table nil
  43   "Syntax table used while in text mode.")
  44
  45 (defvar text-mode-abbrev-table nil
  46   "Abbrev table used while in text mode.")
  47 (define-abbrev-table 'text-mode-abbrev-table ())
  48
  49 (if text-mode-syntax-table
  50     ()
  51   (setq text-mode-syntax-table (make-syntax-table))
  52   (modify-syntax-entry ?\" ".   " text-mode-syntax-table)
  53   (modify-syntax-entry ?\\ ".   " text-mode-syntax-table)
  54   (modify-syntax-entry ?' "w   " text-mode-syntax-table))
  55
  56 (defvar text-mode-map nil
  57   "Keymap for Text mode.
  58 Many other modes, such as Mail mode, Outline mode and Indented Text mode,
  59 inherit all the commands defined in this map.")
  60
  61 (if text-mode-map
  62     ()
  63   (setq text-mode-map (make-sparse-keymap))
  64   ;; XEmacs change
  65   (set-keymap-name text-mode-map 'text-mode-map)
  66   (define-key text-mode-map "\e\t" 'ispell-complete-word)
  67   (define-key text-mode-map "\t" 'indent-relative)
  68   (define-key text-mode-map "\es" 'center-line)
  69   (define-key text-mode-map "\eS" 'center-paragraph))
  70
  71 \f
  72 (defun text-mode ()
  73   "Major mode for editing text written for humans to read.
  74 In this mode, paragraphs are delimited only by blank or white lines.
  75 You can thus get the full benefit of adaptive filling
  76  (see the variable `adaptive-fill-mode').
  77 \\{text-mode-map}
  78 Turning on Text mode runs the normal hook `text-mode-hook'."
  79   (interactive)
  80   (kill-all-local-variables)
  81   (use-local-map text-mode-map)
  82   (setq local-abbrev-table text-mode-abbrev-table)
  83   (set-syntax-table text-mode-syntax-table)
  84   (make-local-variable 'paragraph-start)
  85   (setq paragraph-start (concat page-delimiter "\\|[ \t]*$"))
  86   (make-local-variable 'paragraph-separate)
  87   (setq paragraph-separate paragraph-start)
  88   (setq mode-name "Text")
  89   (setq major-mode 'text-mode)
  90   (run-hooks 'text-mode-hook))
  91
  92 (defun paragraph-indent-text-mode ()
  93   "Major mode for editing text, with leading spaces starting a paragraph.
  94 In this mode, you do not need blank lines between paragraphs
  95 when the first line of the following paragraph starts with whitespace.
  96 Special commands:
  97 \\{text-mode-map}
  98 Turning on Paragraph-Indent Text mode runs the normal hooks
  99 `text-mode-hook' and `paragraph-indent-text-mode-hook'."
 100   (interactive)
 101   (kill-all-local-variables)
 102   (use-local-map text-mode-map)
 103   (setq mode-name "Parindent")
 104   (setq major-mode 'paragraph-indent-text-mode)
 105   (setq local-abbrev-table text-mode-abbrev-table)
 106   (set-syntax-table text-mode-syntax-table)
 107   (run-hooks 'text-mode-hook 'paragraph-indent-text-mode-hook))
 108
 109 (defalias 'indented-text-mode 'text-mode)
 110
 111 (defun text-mode-hook-identify ()
 112   "Mark that this mode has run `text-mode-hook'.
 113 This is how `toggle-text-mode-auto-fill' knows which buffers to operate on."
 114   (make-local-variable 'text-mode-variant)
 115   (setq text-mode-variant t))
 116
 117 (add-hook 'text-mode-hook 'text-mode-hook-identify)
 118
 119 (defun toggle-text-mode-auto-fill ()
 120   "Toggle whether to use Auto Fill in Text mode and related modes.
 121 This command affects all buffers that use modes related to Text mode,
 122 both existing buffers and buffers that you subsequently create."
 123   (interactive)
 124   (let ((enable-mode (not (memq 'turn-on-auto-fill text-mode-hook)))
 125         (buffers (buffer-list)))
 126     (if enable-mode
 127         (add-hook 'text-mode-hook 'turn-on-auto-fill)
 128       (remove-hook 'text-mode-hook 'turn-on-auto-fill))
 129     (while buffers
 130       (with-current-buffer (car buffers)
 131         (if text-mode-variant
 132             (auto-fill-mode (if enable-mode 1 0))))
 133       (setq buffers (cdr buffers)))
 134     (message "Auto Fill %s in Text modes"
 135              (if enable-mode "enabled" "disabled"))))
 136 \f
 137 (defun center-paragraph ()
 138   "Center each nonblank line in the paragraph at or after point.
 139 See `center-line' for more info."
 140   (interactive)
 141   (save-excursion
 142     (forward-paragraph)
 143     (or (bolp) (newline 1))
 144     (let ((end (point)))
 145       (backward-paragraph)
 146       (center-region (point) end))))
 147
 148 (defun center-region (from to)
 149   "Center each nonblank line starting in the region.
 150 See `center-line' for more info."
 151   (interactive "r")
 152   (if (> from to)
 153       (let ((tem to))
 154         (setq to from from tem)))
 155   (save-excursion
 156     (save-restriction
 157       (narrow-to-region from to)
 158       (goto-char from)
 159       (while (not (eobp))
 160         (or (save-excursion (skip-chars-forward " \t") (eolp))
 161             (center-line))
 162         (forward-line 1)))))
 163
 164 (defun center-line (&optional nlines)
 165   "Center the line point is on, within the width specified by `fill-column'.
 166 This means adjusting the indentation so that it equals
 167 the distance between the end of the text and `fill-column'.
 168 The argument NLINES says how many lines to center."
 169   (interactive "P")
 170   (if nlines (setq nlines (prefix-numeric-value nlines)))
 171   (while (not (eq nlines 0))
 172     (save-excursion
 173       (let ((lm (current-left-margin))
 174             line-length)
 175         (beginning-of-line)
 176         (delete-horizontal-space)
 177         (end-of-line)
 178         (delete-horizontal-space)
 179         (setq line-length (current-column))
 180         (if (> (- fill-column lm line-length) 0)
 181             (indent-line-to
 182              (+ lm (/ (- fill-column lm line-length) 2))))))
 183     (cond ((null nlines)
 184            (setq nlines 0))
 185           ((> nlines 0)
 186            (setq nlines (1- nlines))
 187            (forward-line 1))
 188           ((< nlines 0)
 189            (setq nlines (1+ nlines))
 190            (forward-line -1)))))
 191
 192 ;;; text-mode.el ends here