;;; indent.el --- indentation commands for Emacs
-;; Copyright (C) 1985 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1995, 2001, 2004 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.")
-
-(defvar indent-line-function 'indent-to-left-margin "\
-Function to indent current line.")
+(defgroup indent nil
+ "Indentation commands"
+ :group 'editing)
+
+(defcustom standard-indent 4
+ "*Default number of columns for margin-changing functions to indent."
+ :group 'indent
+ :type 'integer)
+
+(defvar indent-line-function 'indent-relative
+ "Function to indent the current line.
+This function will be called with no arguments.
+If it is called somewhere where auto-indentation cannot be done
+\(f.ex. inside a string), the function should simply return `noindent'.
+Setting this function is all you need to make TAB indent appropriately.
+Don't rebind TAB unless you really need to.")
+
+(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 '(choice (const nil) (const t) (const always)))
(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."
+ "Indent line in proper way for current major mode.
+The buffer-local variable `indent-line-function' determines how to do this,
+but the functions `indent-relative' and `indent-relative-maybe' are
+special; we don't actually use them here."
(interactive)
- (if (eq indent-line-function 'indent-to-left-margin)
- (insert-tab)
+ (if (memq indent-line-function
+ '(indent-relative indent-relative-maybe))
+ ;; These functions are used for tabbing, but can't be used for
+ ;; indenting. Replace with something ad-hoc.
+ (let ((column (save-excursion
+ (beginning-of-line)
+ (skip-chars-backward "\n \t")
+ (beginning-of-line)
+ (current-indentation))))
+ (if (<= (current-column) (current-indentation))
+ (indent-line-to column)
+ (save-excursion (indent-line-to column))))
+ ;; The normal case.
(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 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")
+ (cond
+ ((or ;; indent-to-left-margin is only meant for indenting,
+ ;; so we force it to always insert a tab here.
+ (eq indent-line-function 'indent-to-left-margin)
+ (and (not tab-always-indent)
+ (or (> (current-column) (current-indentation))
+ (eq this-command last-command))))
+ (insert-tab arg))
+ ;; Those functions are meant specifically for tabbing and not for
+ ;; indenting, so we can't pass them to indent-according-to-mode.
+ ((memq indent-line-function '(indent-relative indent-relative-maybe))
+ (funcall indent-line-function))
+ (t ;; The normal case.
+ (indent-according-to-mode))))
+
+(defun insert-tab (&optional arg)
+ (let ((count (prefix-numeric-value 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.
-Called from a program, takes three arguments, START, END and ARG."
+Called from a program, takes three arguments, START, END and ARG.
+You can remove all indentation from a region by giving a large negative ARG."
(interactive "r\np")
(save-excursion
(goto-char end)
"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?)
+ (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))))
- ((< cur-col column)
- (back-to-indentation)
- (indent-to column)))))
+ (progn (back-to-indentation) (point)))))))
(defun current-left-margin ()
"Return the left margin to use for this line.
interactively or with optional argument FORCE, it will be fixed."
(interactive (list (prefix-numeric-value current-prefix-arg) t))
(beginning-of-line n)
- (let ((lm (current-left-margin)))
- (if (memq (current-justification) '(right center))
- (move-to-column lm)
- (skip-chars-forward " \t"))
- (let ((cc (current-column)))
+ (skip-chars-forward " \t")
+ (if (minibufferp (current-buffer))
+ (if (save-excursion (beginning-of-line) (bobp))
+ (goto-char (minibuffer-prompt-end))
+ (beginning-of-line))
+ (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
((and force (< cc lm))
(indent-to-left-margin))))))
-;; This is the default indent-line-function,
+;; This used to be the default indent-line-function,
;; used in Fundamental Mode, Text Mode, etc.
(defun indent-to-left-margin ()
"Indent current line to the column given by `current-left-margin'."
(forward-line 1))
(move-marker to nil)))
-(defun set-left-margin (from to lm)
+(defun set-left-margin (from to width)
"Set the left margin of the region to WIDTH.
-If `auto-fill-mode' is active, re-fill the region to fit the new margin."
+If `auto-fill-mode' is active, re-fill the region to fit the new margin.
+
+Interactively, WIDTH is the prefix argument, if specified.
+Without prefix argument, the command prompts for WIDTH."
(interactive "r\nNSet left margin to column: ")
- (if (interactive-p) (setq lm (prefix-numeric-value lm)))
(save-excursion
;; If inside indentation, start from BOL.
(goto-char from)
(setq to (point-marker)))
;; Delete margin indentation first, but keep paragraph indentation.
(delete-to-left-margin from to)
- (put-text-property from to 'left-margin lm)
- (indent-rigidly from to lm)
+ (put-text-property from to 'left-margin width)
+ (indent-rigidly from to width)
(if auto-fill-function (save-excursion (fill-region from to nil t t)))
(move-marker to nil))
-(defun set-right-margin (from to lm)
+(defun set-right-margin (from to width)
"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: ")
- (if (interactive-p) (setq lm (prefix-numeric-value lm)))
+If `auto-fill-mode' is active, re-fill the region to fit the new margin.
+
+Interactively, WIDTH is the prefix argument, if specified.
+Without prefix argument, the command prompts for WIDTH."
+ (interactive "r\nNSet right margin to width: ")
(save-excursion
(goto-char from)
(skip-chars-backward " \t")
(if (bolp) (setq from (point))))
- (put-text-property from to 'right-margin lm)
+ (put-text-property from to 'right-margin width)
(if auto-fill-function (save-excursion (fill-region from to nil t t))))
(defun alter-text-property (from to prop func &optional object)
the right margin width.
If `auto-fill-mode' is active, re-fill the region to fit the new margin."
(interactive "r\nP")
- (if (interactive-p)
- (setq inc (if inc (prefix-numeric-value current-prefix-arg)
- standard-indent)))
+ (setq inc (if inc (prefix-numeric-value inc) standard-indent))
(save-excursion
(alter-text-property from to 'right-margin
- (lambda (v) (+ inc (or v 0))))
+ (lambda (v) (+ inc (or v 0))))
(if auto-fill-function
(fill-region from to nil t t))))
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
+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
+ (if (and fill-prefix
(not (string-equal fill-prefix "")))
(if (equal fill-prefix
- (buffer-substring
+ (buffer-substring
(point) (min (point-max) (+ (length fill-prefix) (point)))))
(forward-char (length fill-prefix)))
- (if (and adaptive-fill-mode
+ (if (and adaptive-fill-mode adaptive-fill-regexp
(looking-at adaptive-fill-regexp))
(goto-char (match-end 0))))
;; Skip centering or flushright indentation
(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)
+(defun indent-region (start end &optional column)
"Indent each nonblank line in the region.
-With 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."
+A numeric prefix argument specifies a column: indent each line to that column.
+
+With no prefix argument, the command chooses one of these methods and
+indents all the lines with it:
+
+ 1) If `fill-prefix' is non-nil, insert `fill-prefix' at the
+ beginning of each line in the region that does not already begin
+ with it.
+ 2) If `indent-region-function' is non-nil, call that function
+ to indent the region.
+ 3) Indent each line as specified by the variable `indent-line-function'.
+
+Called from a program, START and END specify the region to indent.
+If the third argument COLUMN is an integer, it specifies the
+column to indent to; if it is nil, use one of the three methods above."
(interactive "r\nP")
(if (null column)
(if fill-prefix
(if indent-region-function
(funcall indent-region-function start end)
(save-excursion
- (goto-char end)
- (setq end (point-marker))
+ (setq end (copy-marker end))
(goto-char start)
- (or (bolp) (forward-line 1))
(while (< (point) end)
(or (and (bolp) (eolp))
(funcall indent-line-function))
(move-marker end nil))))
(defun indent-relative-maybe ()
- "Indent a new line like previous nonblank line."
+ "Indent a new line like previous nonblank line.
+If the previous nonblank line has no indent points beyond the
+column point starts at, this command does nothing.
+
+See also `indent-relative'."
(interactive)
(indent-relative t))
(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."
+column point starts at, `tab-to-tab-stop' is done instead, unless
+this command is invoked with a numeric argument, in which case it
+does nothing.
+
+See also `indent-relative-maybe'."
(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
(or (= (point) end) (setq indent (current-column))))))
(if indent
(let ((opoint (point-marker)))
- (delete-region (point) (progn (skip-chars-backward " \t") (point)))
(indent-to indent 0)
(if (> opoint (point))
(goto-char opoint))
(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.")
-
-(defvar edit-tab-stops-map nil "Keymap used in `edit-tab-stops'.")
-(if edit-tab-stops-map
- nil
- (setq edit-tab-stops-map (make-sparse-keymap))
- (define-key edit-tab-stops-map "\C-x\C-s" 'edit-tab-stops-note-changes)
- (define-key edit-tab-stops-map "\C-c\C-c" 'edit-tab-stops-note-changes))
+ "*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
+ (let ((map (make-sparse-keymap)))
+ (define-key map "\C-x\C-s" 'edit-tab-stops-note-changes)
+ (define-key map "\C-c\C-c" 'edit-tab-stops-note-changes)
+ map)
+ "Keymap used in `edit-tab-stops'.")
(defvar edit-tab-stops-buffer nil
- "Buffer whose tab stops are being edited--in case
-the variable `tab-stop-list' is local in that buffer.")
+ "Buffer whose tab stops are being edited.
+This matters if the variable `tab-stop-list' is local in that buffer.")
(defun edit-tab-stops ()
"Edit the tab stops used by `tab-to-tab-stop'.
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)))
(if tabs
(let ((opoint (point)))
- (skip-chars-backward " \t")
- (delete-region (point) opoint)
+ (delete-horizontal-space t)
(indent-to (car tabs)))
(insert ?\ ))))
(delete-region (point) before))))))))
(define-key global-map "\t" 'indent-for-tab-command)
-(define-key esc-map "\034" 'indent-region)
+(define-key esc-map "\C-\\" 'indent-region)
(define-key ctl-x-map "\t" 'indent-rigidly)
(define-key esc-map "i" 'tab-to-tab-stop)
+;;; arch-tag: f402b2a7-e44f-492f-b5b8-38996020b7c3
;;; indent.el ends here