indent.el 27.5 KB
Newer Older
1
;;; indent.el --- indentation commands for Emacs  -*- lexical-binding:t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1985, 1995, 2001-2014 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
6
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Roland McGrath's avatar
Roland McGrath committed
8 9
;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Roland McGrath's avatar
Roland McGrath committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Roland McGrath's avatar
Roland McGrath committed
14 15 16 17 18 19 20

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Roland McGrath's avatar
Roland McGrath committed
22

23 24 25 26 27
;;; Commentary:

;; Commands for making and changing indentation in text.  These are
;; described in the Emacs manual.

Eric S. Raymond's avatar
Eric S. Raymond committed
28
;;; Code:
Roland McGrath's avatar
Roland McGrath committed
29

Richard M. Stallman's avatar
Richard M. Stallman committed
30
(defgroup indent nil
31
  "Indentation commands."
Richard M. Stallman's avatar
Richard M. Stallman committed
32
  :group 'editing)
33

Richard M. Stallman's avatar
Richard M. Stallman committed
34
(defcustom standard-indent 4
Lute Kamstra's avatar
Lute Kamstra committed
35
  "Default number of columns for margin-changing functions to indent."
Richard M. Stallman's avatar
Richard M. Stallman committed
36 37 38
  :group 'indent
  :type 'integer)

39
(defvar indent-line-function 'indent-relative
40 41 42
  "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
43
\(e.g. inside a string), the function should simply return `noindent'.
44 45
Setting this function is all you need to make TAB indent appropriately.
Don't rebind TAB unless you really need to.")
Roland McGrath's avatar
Roland McGrath committed
46

Stefan Monnier's avatar
Stefan Monnier committed
47
(defcustom tab-always-indent t
Lute Kamstra's avatar
Lute Kamstra committed
48
  "Controls the operation of the TAB key.
Stefan Monnier's avatar
Stefan Monnier committed
49 50
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
51
or in the line's indentation, otherwise it inserts a \"real\" TAB character.
52 53 54
If `complete', TAB first tries to indent the current line, and if the line
was already indented, then try to complete the thing at point.

55
Some programming language modes have their own variable to control this,
Eli Zaretskii's avatar
Eli Zaretskii committed
56
e.g., `c-tab-always-indent', and do not respect this variable."
Stefan Monnier's avatar
Stefan Monnier committed
57
  :group 'indent
58 59 60 61 62
  :type '(choice
	  (const :tag "Always indent" t)
	  (const :tag "Indent if inside indentation, else TAB" nil)
	  (const :tag "Indent, or if already indented complete" complete)))

Stefan Monnier's avatar
Stefan Monnier committed
63

Roland McGrath's avatar
Roland McGrath committed
64
(defun indent-according-to-mode ()
65
  "Indent line in proper way for current major mode.
66 67 68 69 70
Normally, this is done by calling the function specified by the
variable `indent-line-function'.  However, if the value of that
variable is `indent-relative' or `indent-relative-maybe', handle
it specially (since those functions are used for tabbing); in
that case, indent by aligning to the previous non-blank line."
Roland McGrath's avatar
Roland McGrath committed
71
  (interactive)
72
  (syntax-propertize (line-end-position))
73 74 75 76 77 78
  (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)
79 80 81 82
		      (if (bobp) 0
                        (beginning-of-line 0)
                        (if (looking-at "[ \t]*$") 0
                          (current-indentation))))))
83 84 85 86 87
	(if (<= (current-column) (current-indentation))
	    (indent-line-to column)
	  (save-excursion (indent-line-to column))))
    ;; The normal case.
    (funcall indent-line-function)))
Roland McGrath's avatar
Roland McGrath committed
88

89
(defun indent-for-tab-command (&optional arg)
90 91 92 93 94 95 96 97
  "Indent the current line or region, or insert a tab, as appropriate.
This function either inserts a tab, or indents the current line,
or performs symbol completion, depending on `tab-always-indent'.
The function called to actually indent the line or insert a tab
is given by the variable `indent-line-function'.

If a prefix argument is given, after this function indents the
current line or inserts a tab, it also rigidly indents the entire
98
balanced expression which starts at the beginning of the current
99
line, to reflect the current line's indentation.
100

101 102 103 104
In most major modes, if point was in the current line's
indentation, it is moved to the first non-whitespace character
after indenting; otherwise it stays at the same position relative
to the text.
105

106 107 108
If `transient-mark-mode' is turned on and the region is active,
this function instead calls `indent-region'.  In this case, any
prefix argument is ignored."
109
  (interactive "P")
110
  (cond
111
   ;; The region is active, indent it.
112
   ((use-region-p)
113
    (indent-region (region-beginning) (region-end)))
114
   ((or ;; indent-to-left-margin is only meant for indenting,
115 116 117
	;; so we force it to always insert a tab here.
	(eq indent-line-function 'indent-to-left-margin)
	(and (not tab-always-indent)
118 119
	     (or (> (current-column) (current-indentation))
		 (eq this-command last-command))))
120
    (insert-tab arg))
121
   (t
122 123 124
    (let ((old-tick (buffer-chars-modified-tick))
          (old-point (point))
	  (old-indent (current-indentation)))
125 126 127 128

      ;; Indent the line.
      (funcall indent-line-function)

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
      (cond
       ;; If the text was already indented right, try completion.
       ((and (eq tab-always-indent 'complete)
             (eq old-point (point))
             (eq old-tick (buffer-chars-modified-tick)))
        (completion-at-point))

       ;; If a prefix argument was given, rigidly indent the following
       ;; sexp to match the change in the current line's indentation.
       (arg
        (let ((end-marker
               (save-excursion
                 (forward-line 0) (forward-sexp) (point-marker)))
              (indentation-change (- (current-indentation) old-indent)))
          (save-excursion
            (forward-line 1)
            (when (and (not (zerop indentation-change))
                       (< (point) end-marker))
              (indent-rigidly (point) end-marker indentation-change))))))))))
148 149 150

(defun insert-tab (&optional arg)
  (let ((count (prefix-numeric-value arg)))
151 152
    (if (and abbrev-mode
	     (eq (char-syntax (preceding-char)) ?w))
153 154
	(expand-abbrev))
    (if indent-tabs-mode
155
	(insert-char ?\t count)
156
      (indent-to (* tab-width (+ count (/ (current-column) tab-width)))))))
Roland McGrath's avatar
Roland McGrath committed
157

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
(defun indent-rigidly--current-indentation (beg end)
  "Return the smallest indentation in range from BEG to END.
Blank lines are ignored."
  (save-excursion
    (save-match-data
      (let ((beg (progn (goto-char beg) (line-beginning-position)))
            indent)
        (goto-char beg)
        (while (re-search-forward "^\\s-*[[:print:]]" end t)
          (setq indent (min (or indent (current-indentation))
                            (current-indentation))))
        indent))))

(defvar indent-rigidly-map
  (let ((map (make-sparse-keymap)))
173 174 175 176 177 178 179
    (define-key map [left]  'indent-rigidly-left)
    (define-key map [right] 'indent-rigidly-right)
    (define-key map [S-left]  'indent-rigidly-left-to-tab-stop)
    (define-key map [S-right] 'indent-rigidly-right-to-tab-stop)
    map)
  "Transient keymap for adjusting indentation interactively.
It is activated by calling `indent-rigidly' interactively.")
180

181 182 183 184 185 186
(defun indent-rigidly (start end arg &optional interactive)
  "Indent all lines starting in the region.
If called interactively with no prefix argument, activate a
transient mode in which the indentation can be adjusted interactively
by typing \\<indent-rigidly-map>\\[indent-rigidly-left], \\[indent-rigidly-right], \\[indent-rigidly-left-to-tab-stop], or \\[indent-rigidly-right-to-tab-stop].
Typing any other key deactivates the transient mode.
187

188 189 190 191
If called from a program, or interactively with prefix ARG,
indent all lines starting in the region forward by ARG columns.
If called from a program, START and END specify the beginning and
end of the text to act on, in place of the region.
192

193 194
Negative values of ARG indent backward, so you can remove all
indentation by specifying a large negative ARG."
195 196 197
  (interactive "r\nP\np")
  (if (and (not arg) interactive)
      (progn
198 199 200
        (message
	 (substitute-command-keys
	  "Indent region with \\<indent-rigidly-map>\\[indent-rigidly-left], \\[indent-rigidly-right], \\[indent-rigidly-left-to-tab-stop], or \\[indent-rigidly-right-to-tab-stop]."))
201
        (set-transient-map indent-rigidly-map t))
202 203 204 205 206 207 208 209 210 211 212 213
    (save-excursion
      (goto-char end)
      (setq end (point-marker))
      (goto-char start)
      (or (bolp) (forward-line 1))
      (while (< (point) end)
        (let ((indent (current-indentation))
              eol-flag)
          (save-excursion
            (skip-chars-forward " \t")
            (setq eol-flag (eolp)))
          (or eol-flag
214
              (indent-to (max 0 (+ indent (prefix-numeric-value arg))) 0))
215 216
          (delete-region (point) (progn (skip-chars-forward " \t") (point))))
        (forward-line 1))
217 218 219 220
      (move-marker end nil)
      ;; Keep the active region in transient mode.
      (when (eq (cadr overriding-terminal-local-map) indent-rigidly-map)
	(setq deactivate-mark nil)))))
Roland McGrath's avatar
Roland McGrath committed
221

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
(defun indent-rigidly--pop-undo ()
  (and (memq last-command '(indent-rigidly-left indent-rigidly-right
			    indent-rigidly-left-to-tab-stop
			    indent-rigidly-right-to-tab-stop))
       (consp buffer-undo-list)
       (eq (car buffer-undo-list) nil)
       (pop buffer-undo-list)))

(defun indent-rigidly-left (beg end)
  "Indent all lines between BEG and END leftward by one space."
  (interactive "r")
  (indent-rigidly--pop-undo)
  (indent-rigidly
   beg end
   (if (eq (current-bidi-paragraph-direction) 'right-to-left) 1 -1)))

(defun indent-rigidly-right (beg end)
  "Indent all lines between BEG and END rightward by one space."
  (interactive "r")
  (indent-rigidly--pop-undo)
  (indent-rigidly
   beg end
   (if (eq (current-bidi-paragraph-direction) 'right-to-left) -1 1)))

(defun indent-rigidly-left-to-tab-stop (beg end)
  "Indent all lines between BEG and END leftward to a tab stop."
  (interactive "r")
  (indent-rigidly--pop-undo)
  (let* ((current (indent-rigidly--current-indentation beg end))
	 (rtl (eq (current-bidi-paragraph-direction) 'right-to-left))
	 (next (indent--next-tab-stop current (if rtl nil 'prev))))
    (indent-rigidly beg end (- next current))))

(defun indent-rigidly-right-to-tab-stop (beg end)
  "Indent all lines between BEG and END rightward to a tab stop."
  (interactive "r")
  (indent-rigidly--pop-undo)
  (let* ((current (indent-rigidly--current-indentation beg end))
	 (rtl (eq (current-bidi-paragraph-direction) 'right-to-left))
	 (next (indent--next-tab-stop current (if rtl 'prev))))
    (indent-rigidly beg end (- next current))))

264 265 266 267
(defun indent-line-to (column)
  "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."
268
  (backward-to-indentation 0)
269 270
  (let ((cur-col (current-column)))
    (cond ((< cur-col column)
271
	   (if (>= (- column (* (/ cur-col tab-width) tab-width)) tab-width)
272 273
	       (delete-region (point)
			      (progn (skip-chars-backward " ") (point))))
274 275
	   (indent-to column))
	  ((> cur-col column) ; too far right (after tab?)
276
	   (delete-region (progn (move-to-column column t) (point))
277
			  (progn (backward-to-indentation 0) (point)))))))
278 279 280 281 282 283 284 285

(defun current-left-margin ()
  "Return the left margin to use for this line.
This is the value of the buffer-local variable `left-margin' plus the value
of the `left-margin' text-property at the start of the line."
  (save-excursion
    (back-to-indentation)
    (max 0
286 287 288 289
	 (+ left-margin (or (get-text-property
			     (if (and (eobp) (not (bobp)))
				 (1- (point)) (point))
			     'left-margin) 0)))))
290

291
(defun move-to-left-margin (&optional n force)
292 293
  "Move to the left margin of the current line.
With optional argument, move forward N-1 lines first.
294 295 296 297
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))
298
  (beginning-of-line n)
299
  (skip-chars-forward " \t")
300 301 302 303 304 305 306 307 308 309 310 311
  (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
		 (backward-char 1)))
	    ((and force (< cc lm))
	     (indent-to-left-margin))))))
312

313
;; This used to be the default indent-line-function,
Roland McGrath's avatar
Roland McGrath committed
314 315
;; used in Fundamental Mode, Text Mode, etc.
(defun indent-to-left-margin ()
316
  "Indent current line to the column given by `current-left-margin'."
317 318 319 320 321 322
  (save-excursion (indent-line-to (current-left-margin)))
  ;; If we are within the indentation, move past it.
  (when (save-excursion
	  (skip-chars-backward " \t")
	  (bolp))
    (skip-chars-forward " \t")))
323

324 325 326 327 328
(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."
329
  (save-excursion
330
    (goto-char (or to (point-max)))
331
    (setq to (point-marker))
332
    (goto-char (or from (point-min)))
333 334
    (or (bolp) (forward-line 1))
    (while (< (point) to)
335
      (delete-region (point) (progn (move-to-left-margin nil t) (point)))
336 337 338
      (forward-line 1))
    (move-marker to nil)))

339
(defun set-left-margin (from to width)
340
  "Set the left margin of the region to WIDTH.
341 342 343 344
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."
345 346 347 348 349 350
  (interactive "r\nNSet left margin to column: ")
  (save-excursion
    ;; If inside indentation, start from BOL.
    (goto-char from)
    (skip-chars-backward " \t")
    (if (bolp) (setq from (point)))
351
    ;; Place end after whitespace
352
    (goto-char to)
353
    (skip-chars-forward " \t")
354
    (setq to (point-marker)))
355 356
  ;; Delete margin indentation first, but keep paragraph indentation.
  (delete-to-left-margin from to)
357 358
  (put-text-property from to 'left-margin width)
  (indent-rigidly from to width)
359
  (if auto-fill-function (save-excursion (fill-region from to nil t t)))
360 361
  (move-marker to nil))

362
(defun set-right-margin (from to width)
363
  "Set the right margin of the region to WIDTH.
364 365 366 367
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."
368
  (interactive "r\nNSet right margin to width: ")
369 370 371 372
  (save-excursion
    (goto-char from)
    (skip-chars-backward " \t")
    (if (bolp) (setq from (point))))
373
  (put-text-property from to 'right-margin width)
374
  (if auto-fill-function (save-excursion (fill-region from to nil t t))))
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404

(defun alter-text-property (from to prop func &optional object)
  "Programmatically change value of a text-property.
For each region between FROM and TO that has a single value for PROPERTY,
apply FUNCTION to that value and sets the property to the function's result.
Optional fifth argument OBJECT specifies the string or buffer to operate on."
  (let ((begin from)
	end val)
    (while (setq val (get-text-property begin prop object)
		 end (text-property-not-all begin to prop val object))
      (put-text-property begin end prop (funcall func val) object)
      (setq begin end))
    (if (< begin to)
	(put-text-property begin to prop (funcall func val) object))))

(defun increase-left-margin (from to inc)
  "Increase or decrease the left-margin of the region.
With no prefix argument, this adds `standard-indent' of indentation.
A prefix arg (optional third arg INC noninteractively) specifies the amount
to change the margin by, in characters.
If `auto-fill-mode' is active, re-fill the region to fit the new margin."
  (interactive "*r\nP")
  (setq inc (if inc (prefix-numeric-value inc) standard-indent))
  (save-excursion
    (goto-char from)
    (skip-chars-backward " \t")
    (if (bolp) (setq from (point)))
    (goto-char to)
    (setq to (point-marker)))
  (alter-text-property from to 'left-margin
405 406 407
		       (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)))
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
  (move-marker to nil))

(defun decrease-left-margin (from to inc)
  "Make the left margin of the region smaller.
With no prefix argument, decrease the indentation by `standard-indent'.
A prefix arg (optional third arg INC noninteractively) specifies the amount
to change the margin by, in characters.
If `auto-fill-mode' is active, re-fill the region to fit the new margin."
  (interactive "*r\nP")
  (setq inc (if inc (prefix-numeric-value inc) standard-indent))
  (increase-left-margin from to (- inc)))

(defun increase-right-margin (from to inc)
  "Increase the right-margin of the region.
With no prefix argument, increase the right margin by `standard-indent'.
A prefix arg (optional third arg INC noninteractively) specifies the amount
to change the margin by, in characters.  A negative argument decreases
the right margin width.
If `auto-fill-mode' is active, re-fill the region to fit the new margin."
  (interactive "r\nP")
428
  (setq inc (if inc (prefix-numeric-value inc) standard-indent))
429 430
  (save-excursion
    (alter-text-property from to 'right-margin
431
			 (lambda (v) (+ inc (or v 0))))
432 433 434 435 436 437 438 439 440 441 442 443 444
    (if auto-fill-function
	(fill-region from to nil t t))))

(defun decrease-right-margin (from to inc)
  "Make the right margin of the region smaller.
With no prefix argument, decrease the right margin by `standard-indent'.
A prefix arg (optional third arg INC noninteractively) specifies the amount
of width to remove, in characters.  A negative argument increases
the right margin width.
If `auto-fill-mode' is active, re-fills region to fit in new margin."
  (interactive "*r\nP")
  (setq inc (if inc (prefix-numeric-value inc) standard-indent))
  (increase-right-margin from to (- inc)))
Roland McGrath's avatar
Roland McGrath committed
445

446 447 448 449 450
(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
451
line, but does not move past any whitespace that was explicitly inserted
452 453 454 455 456
\(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.
457
  (if (and fill-prefix
458 459
	   (not (string-equal fill-prefix "")))
      (if (equal fill-prefix
460
		 (buffer-substring
461 462
		  (point) (min (point-max) (+ (length fill-prefix) (point)))))
	  (forward-char (length fill-prefix)))
463
    (if (and adaptive-fill-mode adaptive-fill-regexp
464 465 466 467 468 469
	     (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")))

Roland McGrath's avatar
Roland McGrath committed
470
(defvar indent-region-function nil
471 472
  "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.")
Roland McGrath's avatar
Roland McGrath committed
473

474
(defun indent-region (start end &optional column)
Roland McGrath's avatar
Roland McGrath committed
475
  "Indent each nonblank line in the region.
476 477 478 479 480 481 482 483 484 485
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.
486
  3) Indent each line via `indent-according-to-mode'.
487 488 489 490

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."
Roland McGrath's avatar
Roland McGrath committed
491
  (interactive "r\nP")
492
  (cond
493
   ;; If a numeric prefix is given, indent to that column.
494
   (column
495
    (setq column (prefix-numeric-value column))
Roland McGrath's avatar
Roland McGrath committed
496 497 498 499 500 501 502 503
    (save-excursion
      (goto-char end)
      (setq end (point-marker))
      (goto-char start)
      (or (bolp) (forward-line 1))
      (while (< (point) end)
	(delete-region (point) (progn (skip-chars-forward " \t") (point)))
	(or (eolp)
504
	    (indent-to column 0))
505
        (forward-line 1))
506
      (move-marker end nil)))
507
   ;; If a fill-prefix is specified, use it.
508 509 510 511 512 513 514 515 516 517 518
   (fill-prefix
    (save-excursion
      (goto-char end)
      (setq end (point-marker))
      (goto-char start)
      (let ((regexp (regexp-quote fill-prefix)))
	(while (< (point) end)
	  (or (looking-at regexp)
	      (and (bolp) (eolp))
	      (insert fill-prefix))
	  (forward-line 1)))))
519
   ;; Use indent-region-function is available.
520 521
   (indent-region-function
    (funcall indent-region-function start end))
522 523
   ;; Else, use a default implementation that calls indent-line-function on
   ;; each line.
524 525 526 527
   (t
    (save-excursion
      (setq end (copy-marker end))
      (goto-char start)
528 529 530 531 532
      (let ((pr (unless (minibufferp)
		  (make-progress-reporter "Indenting region..." (point) end))))
	(while (< (point) end)
	  (or (and (bolp) (eolp))
	      (indent-according-to-mode))
533
          (forward-line 1)
534 535
          (and pr (progress-reporter-update pr (point))))
	(and pr (progress-reporter-done pr))
536
        (move-marker end nil)))))
537 538 539 540
  ;; In most cases, reindenting modifies the buffer, but it may also
  ;; leave it unmodified, in which case we have to deactivate the mark
  ;; by hand.
  (deactivate-mark))
Roland McGrath's avatar
Roland McGrath committed
541 542

(defun indent-relative-maybe ()
543 544 545 546 547
  "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'."
Roland McGrath's avatar
Roland McGrath committed
548 549 550 551 552 553
  (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.
554 555
The following line shows the indentation points in this line.
    ^         ^    ^     ^   ^           ^      ^  ^    ^
Roland McGrath's avatar
Roland McGrath committed
556
If the previous nonblank line has no indent points beyond the
557 558 559 560 561
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'."
Roland McGrath's avatar
Roland McGrath committed
562
  (interactive "P")
563 564 565
  (if (and abbrev-mode
	   (eq (char-syntax (preceding-char)) ?w))
      (expand-abbrev))
Roland McGrath's avatar
Roland McGrath committed
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  (let ((start-column (current-column))
	indent)
    (save-excursion
      (beginning-of-line)
      (if (re-search-backward "^[^\n]" nil t)
	  (let ((end (save-excursion (forward-line 1) (point))))
	    (move-to-column start-column)
	    ;; Is start-column inside a tab on this line?
	    (if (> (current-column) start-column)
		(backward-char 1))
	    (or (looking-at "[ \t]")
		unindented-ok
		(skip-chars-forward "^ \t" end))
	    (skip-chars-forward " \t" end)
	    (or (= (point) end) (setq indent (current-column))))))
    (if indent
	(let ((opoint (point-marker)))
	  (indent-to indent 0)
	  (if (> opoint (point))
	      (goto-char opoint))
	  (move-marker opoint nil))
      (tab-to-tab-stop))))

Glenn Morris's avatar
Glenn Morris committed
589
(defcustom tab-stop-list nil
Lute Kamstra's avatar
Lute Kamstra committed
590
  "List of tab stop positions used by `tab-to-tab-stop'.
Glenn Morris's avatar
Glenn Morris committed
591 592 593 594 595
This should be nil, or a list of integers, ordered from smallest to largest.
It implicitly extends to infinity through repetition of the last step.
For example, '(1 2 5) is equivalent to '(1 2 5 8 11 ...).  If the list has
fewer than 2 elements, `tab-width' is used as the \"last step\".
A value of nil means a tab stop every `tab-width' columns."
Richard M. Stallman's avatar
Richard M. Stallman committed
596
  :group 'indent
Glenn Morris's avatar
Glenn Morris committed
597 598
  :version "24.4"                       ; from explicit list to nil
  :safe 'listp
Richard M. Stallman's avatar
Richard M. Stallman committed
599
  :type '(repeat integer))
Roland McGrath's avatar
Roland McGrath committed
600

601 602 603 604 605 606
(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'.")
Roland McGrath's avatar
Roland McGrath committed
607 608

(defvar edit-tab-stops-buffer nil
609 610
  "Buffer whose tab stops are being edited.
This matters if the variable `tab-stop-list' is local in that buffer.")
Roland McGrath's avatar
Roland McGrath committed
611 612 613 614 615 616 617 618 619 620

(defun edit-tab-stops ()
  "Edit the tab stops used by `tab-to-tab-stop'.
Creates a buffer *Tab Stops* containing text describing the tab stops.
A colon indicates a column where there is a tab stop.
You can add or remove colons and then do \\<edit-tab-stops-map>\\[edit-tab-stops-note-changes] to make changes take effect."
  (interactive)
  (setq edit-tab-stops-buffer (current-buffer))
  (switch-to-buffer (get-buffer-create "*Tab Stops*"))
  (use-local-map edit-tab-stops-map)
621
  (setq-local indent-tabs-mode nil)
Roland McGrath's avatar
Roland McGrath committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  (overwrite-mode 1)
  (setq truncate-lines t)
  (erase-buffer)
  (let ((tabs tab-stop-list))
    (while tabs
      (indent-to (car tabs) 0)
      (insert ?:)
      (setq tabs (cdr tabs))))
  (let ((count 0))
    (insert ?\n)
    (while (< count 8)
      (insert (+ count ?0))
    (insert "         ")
      (setq count (1+ count)))
    (insert ?\n)
    (while (> count 0)
      (insert "0123456789")
      (setq count (1- count))))
  (insert "\nTo install changes, type C-c C-c")
  (goto-char (point-min)))

(defun edit-tab-stops-note-changes ()
  "Put edited tab stops into effect."
  (interactive)
    (let (tabs)
      (save-excursion
	(goto-char 1)
	(end-of-line)
	(while (search-backward ":" nil t)
	  (setq tabs (cons (current-column) tabs))))
      (bury-buffer (prog1 (current-buffer)
			  (switch-to-buffer edit-tab-stops-buffer)))
      (setq tab-stop-list tabs))
  (message "Tab stops installed"))

657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
(defun indent--next-tab-stop (column &optional prev)
  "Return the next tab stop after COLUMN.
If PREV is non-nil, return the previous one instead."
  (let ((tabs tab-stop-list))
    (while (and tabs (>= column (car tabs)))
      (setq tabs (cdr tabs)))
    (if tabs
        (if (not prev)
            (car tabs)
          (let ((prevtabs (cdr (memq (car tabs) (reverse tab-stop-list)))))
            (if (null prevtabs) 0
              (if (= column (car prevtabs))
                  (or (nth 1 prevtabs) 0)
                (car prevtabs)))))
      ;; We passed the end of tab-stop-list: guess a continuation.
      (let* ((last2 (last tab-stop-list 2))
             (step (if (cdr last2) (- (cadr last2) (car last2)) tab-width))
             (last (or (cadr last2) (car last2) 0)))
        ;; Repeat the last tab's length.
        (+ last (* step (if prev
                            (if (<= column last) -1 (/ (- column last 1) step))
                          (1+ (/ (- column last) step)))))))))

Roland McGrath's avatar
Roland McGrath committed
680 681 682 683 684
(defun tab-to-tab-stop ()
  "Insert spaces or tabs to next defined tab-stop column.
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)
685 686
  (and abbrev-mode (= (char-syntax (preceding-char)) ?w)
       (expand-abbrev))
687 688 689
  (let ((nexttab (indent--next-tab-stop (current-column))))
    (delete-horizontal-space t)
    (indent-to nexttab)))
Roland McGrath's avatar
Roland McGrath committed
690 691 692

(defun move-to-tab-stop ()
  "Move point to next defined tab-stop column.
693 694 695
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)
696 697 698 699 700 701 702 703 704 705 706 707 708 709
  (let ((nexttab (indent--next-tab-stop (current-column))))
    (let ((before (point)))
      (move-to-column nexttab t)
      (save-excursion
        (goto-char before)
        ;; If we just added a tab, or moved over one,
        ;; delete any superfluous spaces before the old point.
        (if (and (eq (preceding-char) ?\s)
                 (eq (following-char) ?\t))
            (let ((tabend (* (/ (current-column) tab-width) tab-width)))
              (while (and (> (current-column) tabend)
                          (eq (preceding-char) ?\s))
                (forward-char -1))
              (delete-region (point) before)))))))
710

Roland McGrath's avatar
Roland McGrath committed
711
(define-key global-map "\t" 'indent-for-tab-command)
712
(define-key esc-map "\C-\\" 'indent-region)
Roland McGrath's avatar
Roland McGrath committed
713 714
(define-key ctl-x-map "\t" 'indent-rigidly)
(define-key esc-map "i" 'tab-to-tab-stop)
Eric S. Raymond's avatar
Eric S. Raymond committed
715 716

;;; indent.el ends here