;;; indent.el --- indentation commands for Emacs
-;; Copyright (C) 1985 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1995 Free Software Foundation, Inc.
;; Maintainer: FSF
;; 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:
;;; Code:
-(defvar standard-indent 4 "\
-Default number of columns for margin-changing functions to indent.")
+(defgroup indent nil
+ "Indentation commands"
+ :group 'editing)
-(defvar indent-line-function 'indent-to-left-margin "\
-Function to indent current line.")
+(defcustom standard-indent 4
+ "*Default number of columns for margin-changing functions to indent."
+ :group 'indent
+ :type 'integer)
+
+(defvar indent-line-function 'indent-to-left-margin
+ "Function to indent current line.")
+
+(defcustom tab-always-indent t
+ "*Controls the operation of the TAB key.
+If t, hitting TAB always just indents the current line.
+If nil, hitting TAB indents the current line if point is at the left margin
+ or in the line's indentation, otherwise it insert a `real' tab character."
+ :group 'indent
+ :type 'boolean)
(defun indent-according-to-mode ()
"Indent line in proper way for current major mode."
(interactive)
(funcall indent-line-function))
-(defun indent-for-tab-command ()
- "Indent line in proper way for current major mode."
- (interactive)
- (if (eq indent-line-function 'indent-to-left-margin)
- (insert-tab)
- (funcall indent-line-function)))
-
-(defun insert-tab ()
- (if abbrev-mode
- (expand-abbrev))
- (if indent-tabs-mode
- (insert ?\t)
- (indent-to (* tab-width (1+ (/ (current-column) tab-width))))))
+(defun indent-for-tab-command (&optional prefix-arg)
+ "Indent line in proper way for current major mode or insert a tab.
+Depending on `tab-always-indent', either insert a tab or indent.
+If initial point was within line's indentation, position after
+the indentation. Else stay at same point in text.
+The function actually called to indent is determined by the value of
+`indent-line-function'."
+ (interactive "P")
+ (if (or (eq indent-line-function 'indent-to-left-margin)
+ (and (not tab-always-indent)
+ (> (current-column) (current-indentation))))
+ (insert-tab prefix-arg)
+ (if prefix-arg
+ (funcall indent-line-function prefix-arg)
+ (funcall indent-line-function))))
+
+(defun insert-tab (&optional prefix-arg)
+ (let ((count (prefix-numeric-value prefix-arg)))
+ (if (and abbrev-mode
+ (eq (char-syntax (preceding-char)) ?w))
+ (expand-abbrev))
+ (if indent-tabs-mode
+ (insert-char ?\t count)
+ (indent-to (* tab-width (+ count (/ (current-column) tab-width)))))))
(defun indent-rigidly (start end arg)
"Indent all lines starting in the region sideways by ARG columns.
"Indent current line to COLUMN.
This function removes or adds spaces and tabs at beginning of line
only if necessary. It leaves point at end of indentation."
- (beginning-of-line)
- (let ((bol (point))
- (cur-col (current-indentation)))
- (cond ((> cur-col column) ; too far right (after tab?)
- (let ((beg (progn (move-to-column column t) (point))))
- (back-to-indentation)
- (delete-region beg (point))))
- ((< cur-col column)
- (back-to-indentation)
- (indent-to column)))))
+ (back-to-indentation)
+ (let ((cur-col (current-column)))
+ (cond ((< cur-col column)
+ (if (>= (- column (* (/ cur-col tab-width) tab-width)) tab-width)
+ (delete-region (point)
+ (progn (skip-chars-backward " ") (point))))
+ (indent-to column))
+ ((> cur-col column) ; too far right (after tab?)
+ (delete-region (progn (move-to-column column t) (point))
+ (progn (back-to-indentation) (point)))))))
(defun current-left-margin ()
"Return the left margin to use for this line.
(save-excursion
(back-to-indentation)
(max 0
- (+ left-margin (or (get-text-property (point) 'left-margin) 0)))))
+ (+ left-margin (or (get-text-property
+ (if (and (eobp) (not (bobp)))
+ (1- (point)) (point))
+ 'left-margin) 0)))))
-(defun move-to-left-margin (&optional n)
+(defun move-to-left-margin (&optional n force)
"Move to the left margin of the current line.
With optional argument, move forward N-1 lines first.
-The column moved to is the one given by the `left-margin' function, or the
-column where text actually starts if the region is centered or right-justified.
-When called interactively, this function corrects the line's indentation
-if it appears to be incorrect.
-When called noninteractively, however, it just moves to the beginning of
-the text in this case."
- (interactive "p")
+The column moved to is the one given by the `current-left-margin' function.
+If the line's indentation appears to be wrong, and this command is called
+interactively or with optional argument FORCE, it will be fixed."
+ (interactive (list (prefix-numeric-value current-prefix-arg) t))
(beginning-of-line n)
(skip-chars-forward " \t")
- (if (not (memq (current-justification) '(right center)))
- (let ((cc (current-column))
- (lm (current-left-margin)))
- (cond ((> cc lm)
- (move-to-column lm t))
- ((and (< cc lm) (interactive-p))
- (indent-to-left-margin))))))
+ (let ((lm (current-left-margin))
+ (cc (current-column)))
+ (cond ((> cc lm)
+ (if (> (move-to-column lm force) lm)
+ ;; If lm is in a tab and we are not forcing, move before tab
+ (backward-char 1)))
+ ((and force (< cc lm))
+ (indent-to-left-margin)))))
;; This is the default indent-line-function,
;; used in Fundamental Mode, Text Mode, etc.
(defun indent-to-left-margin ()
- "Indent current line to `left-margin'."
+ "Indent current line to the column given by `current-left-margin'."
(indent-line-to (current-left-margin)))
-(defun delete-to-left-margin (from to)
- "Remove left-margin indentation from region.
-This is careful only to delete whitespace, and not to delete any more than
-the \(current-left-margin) value for each line."
+(defun delete-to-left-margin (&optional from to)
+ "Remove left margin indentation from a region.
+This deletes to the column given by `current-left-margin'.
+In no case will it delete non-whitespace.
+Args FROM and TO are optional; default is the whole buffer."
(save-excursion
- (goto-char to)
+ (goto-char (or to (point-max)))
(setq to (point-marker))
- (goto-char from)
+ (goto-char (or from (point-min)))
(or (bolp) (forward-line 1))
(while (< (point) to)
- (delete-region (point) (let ((lm (current-left-margin)))
- (skip-chars-forward " \t")
- (if (> (current-column) lm)
- (move-to-column lm))
- (point)))
+ (delete-region (point) (progn (move-to-left-margin nil t) (point)))
(forward-line 1))
(move-marker to nil)))
(goto-char from)
(skip-chars-backward " \t")
(if (bolp) (setq from (point)))
+ ;; Place end after whitespace
(goto-char to)
+ (skip-chars-forward " \t")
(setq to (point-marker)))
- ;; Delete indentation first, so that paragraph indentation is preserved.
- (if auto-fill-function (delete-to-left-margin from to))
+ ;; Delete margin indentation first, but keep paragraph indentation.
+ (delete-to-left-margin from to)
(put-text-property from to 'left-margin lm)
- (if auto-fill-function (fill-region from to nil t t))
+ (indent-rigidly from to lm)
+ (if auto-fill-function (save-excursion (fill-region from to nil t t)))
(move-marker to nil))
(defun set-right-margin (from to lm)
"Set the right margin of the region to WIDTH.
If `auto-fill-mode' is active, re-fill the region to fit the new margin."
- (interactive "r\nNSet left margin to column: ")
+ (interactive "r\nNSet right margin to width: ")
(if (interactive-p) (setq lm (prefix-numeric-value lm)))
(save-excursion
(goto-char from)
(skip-chars-backward " \t")
(if (bolp) (setq from (point))))
(put-text-property from to 'right-margin lm)
- (if auto-fill-function (fill-region from to nil t t)))
+ (if auto-fill-function (save-excursion (fill-region from to nil t t))))
(defun alter-text-property (from to prop func &optional object)
"Programmatically change value of a text-property.
(if (bolp) (setq from (point)))
(goto-char to)
(setq to (point-marker)))
- (if auto-fill-function (delete-to-left-margin from to))
(alter-text-property from to 'left-margin
- (lambda (v) (max 0 (+ inc (or v 0)))))
- (if auto-fill-function (fill-region from to nil t t))
+ (lambda (v) (max (- left-margin) (+ inc (or v 0)))))
+ (indent-rigidly from to inc)
+ (if auto-fill-function (save-excursion (fill-region from to nil t t)))
(move-marker to nil))
(defun decrease-left-margin (from to inc)
standard-indent)))
(save-excursion
(alter-text-property from to 'right-margin
- (lambda (v) (max 0 (+ inc (or v 0)))))
+ (lambda (v) (+ inc (or v 0))))
(if auto-fill-function
(fill-region from to nil t t))))
(setq inc (if inc (prefix-numeric-value inc) standard-indent))
(increase-right-margin from to (- inc)))
+(defun beginning-of-line-text (&optional n)
+ "Move to the beginning of the text on this line.
+With optional argument, move forward N-1 lines first.
+From the beginning of the line, moves past the left-margin indentation, the
+fill-prefix, and any indentation used for centering or right-justifying the
+line, but does not move past any whitespace that was explicitly inserted
+\(such as a tab used to indent the first line of a paragraph)."
+ (interactive "p")
+ (beginning-of-line n)
+ (skip-chars-forward " \t")
+ ;; Skip over fill-prefix.
+ (if (and fill-prefix
+ (not (string-equal fill-prefix "")))
+ (if (equal fill-prefix
+ (buffer-substring
+ (point) (min (point-max) (+ (length fill-prefix) (point)))))
+ (forward-char (length fill-prefix)))
+ (if (and adaptive-fill-mode adaptive-fill-regexp
+ (looking-at adaptive-fill-regexp))
+ (goto-char (match-end 0))))
+ ;; Skip centering or flushright indentation
+ (if (memq (current-justification) '(center right))
+ (skip-chars-forward " \t")))
+
(defvar indent-region-function nil
- "Function which is short cut to indent region using indent-according-to-mode.
-A value of nil means really run indent-according-to-mode on each line.")
+ "Short cut function to indent region using `indent-according-to-mode'.
+A value of nil means really run `indent-according-to-mode' on each line.")
(defun indent-region (start end column)
"Indent each nonblank line in the region.
-With no argument, indent each line using `indent-according-to-mode',
+With prefix no argument, indent each line using `indent-according-to-mode',
or use `indent-region-function' to do the whole region if that's non-nil.
If there is a fill prefix, make each line start with the fill prefix.
With argument COLUMN, indent each line to that column.
-Called from a program, takes three args: START, END and COLUMN."
+
+When you call this from a program, START and END specify
+the region to indent, and COLUMN specifies the indentation column.
+If COLUMN is nil, then indent each line according to the mode."
(interactive "r\nP")
(if (null column)
(if fill-prefix
(defun indent-relative (&optional unindented-ok)
"Space out to under next indent point in previous nonblank line.
An indent point is a non-whitespace character following whitespace.
+The following line shows the indentation points in this line.
+ ^ ^ ^ ^ ^ ^ ^ ^ ^
If the previous nonblank line has no indent points beyond the
column point starts at, `tab-to-tab-stop' is done instead."
(interactive "P")
- (if abbrev-mode (expand-abbrev))
+ (if (and abbrev-mode
+ (eq (char-syntax (preceding-char)) ?w))
+ (expand-abbrev))
(let ((start-column (current-column))
indent)
(save-excursion
(move-marker opoint nil))
(tab-to-tab-stop))))
-(defvar tab-stop-list
+(defcustom tab-stop-list
'(8 16 24 32 40 48 56 64 72 80 88 96 104 112 120)
- "*List of tab stop positions used by `tab-to-tab-stops'.
-This should be a list of integers, ordered from smallest to largest.")
+ "*List of tab stop positions used by `tab-to-tab-stop'.
+This should be a list of integers, ordered from smallest to largest."
+ :group 'indent
+ :type '(repeat integer))
(defvar edit-tab-stops-map nil "Keymap used in `edit-tab-stops'.")
(if edit-tab-stops-map
The variable `tab-stop-list' is a list of columns at which there are tab stops.
Use \\[edit-tab-stops] to edit them interactively."
(interactive)
- (if abbrev-mode (expand-abbrev))
+ (and abbrev-mode (= (char-syntax (preceding-char)) ?w)
+ (expand-abbrev))
(let ((tabs tab-stop-list))
(while (and tabs (>= (current-column) (car tabs)))
(setq tabs (cdr tabs)))
HCoop / bpt / emacs.git / blobdiff