indent.el 21.2 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; indent.el --- indentation commands for Emacs

3
;; Copyright (C) 1985, 1995, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
5

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

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 52
or in the line's indentation, otherwise it inserts a \"real\" TAB character.
Some programming language modes have their own variable to control this,
Eli Zaretskii's avatar
Eli Zaretskii committed
53
e.g., `c-tab-always-indent', and do not respect this variable."
Stefan Monnier's avatar
Stefan Monnier committed
54
  :group 'indent
55
  :type '(choice (const nil) (const t) (const always)))
Stefan Monnier's avatar
Stefan Monnier committed
56

Roland McGrath's avatar
Roland McGrath committed
57
(defun indent-according-to-mode ()
58 59 60 61
  "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."
Roland McGrath's avatar
Roland McGrath committed
62
  (interactive)
63 64 65 66 67 68 69 70 71 72 73 74 75 76
  (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)))
Roland McGrath's avatar
Roland McGrath committed
77

78
(defun indent-for-tab-command (&optional arg)
79
  "Indent line or region in proper way for current major mode or insert a tab.
Stefan Monnier's avatar
Stefan Monnier committed
80
Depending on `tab-always-indent', either insert a tab or indent.
81 82
If initial point was within line's indentation, position after
the indentation.  Else stay at same point in text.
83 84

If a prefix argument is given, also rigidly indent the entire
85
balanced expression which starts at the beginning of the current
86 87
line to reflect the current line's change in indentation.

88
If `transient-mark-mode' is turned on and the region is active,
89 90
indent the region (in this case, any prefix argument is ignored).

91
The function actually called to indent the line is determined by the value of
92
`indent-line-function'."
93
  (interactive "P")
94
  (cond
95
   ;; The region is active, indent it.
96
   ((use-region-p)
97
    (indent-region (region-beginning) (region-end)))
98
   ((or ;; indent-to-left-margin is only meant for indenting,
99 100 101
	;; so we force it to always insert a tab here.
	(eq indent-line-function 'indent-to-left-margin)
	(and (not tab-always-indent)
102 103
	     (or (> (current-column) (current-indentation))
		 (eq this-command last-command))))
104
    (insert-tab arg))
105
   (t
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    (let ((end-marker
	   (and arg
		(save-excursion
		  (forward-line 0) (forward-sexp) (point-marker))))
	  (old-indent
	   (current-indentation)))

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

      ;; If a prefix argument was given, rigidly indent the following
      ;; sexp to match the change in the current line's indentation.
      ;;
      (when arg
	(let ((indentation-change (- (current-indentation) old-indent)))
	  (unless (zerop indentation-change)
	    (save-excursion
	      (forward-line 1)
	      (when (< (point) end-marker)
		(indent-rigidly (point) end-marker indentation-change))))))))))
126 127 128

(defun insert-tab (&optional arg)
  (let ((count (prefix-numeric-value arg)))
129 130
    (if (and abbrev-mode
	     (eq (char-syntax (preceding-char)) ?w))
131 132
	(expand-abbrev))
    (if indent-tabs-mode
133
	(insert-char ?\t count)
134
      (indent-to (* tab-width (+ count (/ (current-column) tab-width)))))))
Roland McGrath's avatar
Roland McGrath committed
135 136 137

(defun indent-rigidly (start end arg)
  "Indent all lines starting in the region sideways by ARG columns.
138 139
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."
Roland McGrath's avatar
Roland McGrath committed
140 141 142 143 144 145 146
  (interactive "r\np")
  (save-excursion
    (goto-char end)
    (setq end (point-marker))
    (goto-char start)
    (or (bolp) (forward-line 1))
    (while (< (point) end)
147 148 149 150 151 152 153 154
      (let ((indent (current-indentation))
	    eol-flag)
	(save-excursion
	  (skip-chars-forward " \t")
	  (setq eol-flag (eolp)))
	(or eol-flag
	    (indent-to (max 0 (+ indent arg)) 0))
	(delete-region (point) (progn (skip-chars-forward " \t") (point))))
Roland McGrath's avatar
Roland McGrath committed
155 156 157
      (forward-line 1))
    (move-marker end nil)))

158 159 160 161
(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."
162 163 164
  (back-to-indentation)
  (let ((cur-col (current-column)))
    (cond ((< cur-col column)
165
	   (if (>= (- column (* (/ cur-col tab-width) tab-width)) tab-width)
166 167
	       (delete-region (point)
			      (progn (skip-chars-backward " ") (point))))
168 169
	   (indent-to column))
	  ((> cur-col column) ; too far right (after tab?)
170
	   (delete-region (progn (move-to-column column t) (point))
171
			  (progn (back-to-indentation) (point)))))))
172 173 174 175 176 177 178 179

(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
180 181 182 183
	 (+ left-margin (or (get-text-property
			     (if (and (eobp) (not (bobp)))
				 (1- (point)) (point))
			     'left-margin) 0)))))
184

185
(defun move-to-left-margin (&optional n force)
186 187
  "Move to the left margin of the current line.
With optional argument, move forward N-1 lines first.
188 189 190 191
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))
192
  (beginning-of-line n)
193
  (skip-chars-forward " \t")
194 195 196 197 198 199 200 201 202 203 204 205
  (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))))))
206

207
;; This used to be the default indent-line-function,
Roland McGrath's avatar
Roland McGrath committed
208 209
;; used in Fundamental Mode, Text Mode, etc.
(defun indent-to-left-margin ()
210
  "Indent current line to the column given by `current-left-margin'."
211 212 213 214 215 216
  (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")))
217

218 219 220 221 222
(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."
223
  (save-excursion
224
    (goto-char (or to (point-max)))
225
    (setq to (point-marker))
226
    (goto-char (or from (point-min)))
227 228
    (or (bolp) (forward-line 1))
    (while (< (point) to)
229
      (delete-region (point) (progn (move-to-left-margin nil t) (point)))
230 231 232
      (forward-line 1))
    (move-marker to nil)))

233
(defun set-left-margin (from to width)
234
  "Set the left margin of the region to WIDTH.
235 236 237 238
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."
239 240 241 242 243 244
  (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)))
245
    ;; Place end after whitespace
246
    (goto-char to)
247
    (skip-chars-forward " \t")
248
    (setq to (point-marker)))
249 250
  ;; Delete margin indentation first, but keep paragraph indentation.
  (delete-to-left-margin from to)
251 252
  (put-text-property from to 'left-margin width)
  (indent-rigidly from to width)
253
  (if auto-fill-function (save-excursion (fill-region from to nil t t)))
254 255
  (move-marker to nil))

256
(defun set-right-margin (from to width)
257
  "Set the right margin of the region to WIDTH.
258 259 260 261
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."
262
  (interactive "r\nNSet right margin to width: ")
263 264 265 266
  (save-excursion
    (goto-char from)
    (skip-chars-backward " \t")
    (if (bolp) (setq from (point))))
267
  (put-text-property from to 'right-margin width)
268
  (if auto-fill-function (save-excursion (fill-region from to nil t t))))
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298

(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
299 300 301
		       (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)))
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
  (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")
322
  (setq inc (if inc (prefix-numeric-value inc) standard-indent))
323 324
  (save-excursion
    (alter-text-property from to 'right-margin
325
			 (lambda (v) (+ inc (or v 0))))
326 327 328 329 330 331 332 333 334 335 336 337 338
    (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
339

340 341 342 343 344
(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
345
line, but does not move past any whitespace that was explicitly inserted
346 347 348 349 350
\(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.
351
  (if (and fill-prefix
352 353
	   (not (string-equal fill-prefix "")))
      (if (equal fill-prefix
354
		 (buffer-substring
355 356
		  (point) (min (point-max) (+ (length fill-prefix) (point)))))
	  (forward-char (length fill-prefix)))
357
    (if (and adaptive-fill-mode adaptive-fill-regexp
358 359 360 361 362 363
	     (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
364
(defvar indent-region-function nil
365 366
  "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
367

368
(defun indent-region (start end &optional column)
Roland McGrath's avatar
Roland McGrath committed
369
  "Indent each nonblank line in the region.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
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."
Roland McGrath's avatar
Roland McGrath committed
385
  (interactive "r\nP")
386
  (if (null column)
Roland McGrath's avatar
Roland McGrath committed
387 388 389 390 391 392
      (if fill-prefix
	  (save-excursion
	    (goto-char end)
	    (setq end (point-marker))
	    (goto-char start)
	    (let ((regexp (regexp-quote fill-prefix)))
393 394 395 396 397
	      (while (< (point) end)
		(or (looking-at regexp)
		    (and (bolp) (eolp))
		    (insert fill-prefix))
		(forward-line 1))))
Roland McGrath's avatar
Roland McGrath committed
398 399 400
	(if indent-region-function
	    (funcall indent-region-function start end)
	  (save-excursion
401
	    (setq end (copy-marker end))
402 403
	    (goto-char start)
	    (while (< (point) end)
404
	      (or (and (bolp) (eolp))
405 406 407 408
		  (funcall indent-line-function))
	      (forward-line 1))
	    (move-marker end nil))))
    (setq column (prefix-numeric-value column))
Roland McGrath's avatar
Roland McGrath committed
409 410 411 412 413 414 415 416
    (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)
417
	    (indent-to column 0))
Roland McGrath's avatar
Roland McGrath committed
418 419 420 421
	(forward-line 1))
      (move-marker end nil))))

(defun indent-relative-maybe ()
422 423 424 425 426
  "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
427 428 429 430 431 432
  (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.
433 434
The following line shows the indentation points in this line.
    ^         ^    ^     ^   ^           ^      ^  ^    ^
Roland McGrath's avatar
Roland McGrath committed
435
If the previous nonblank line has no indent points beyond the
436 437 438 439 440
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
441
  (interactive "P")
442 443 444
  (if (and abbrev-mode
	   (eq (char-syntax (preceding-char)) ?w))
      (expand-abbrev))
Roland McGrath's avatar
Roland McGrath committed
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
  (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))))

Richard M. Stallman's avatar
Richard M. Stallman committed
468
(defcustom tab-stop-list
Roland McGrath's avatar
Roland McGrath committed
469
  '(8 16 24 32 40 48 56 64 72 80 88 96 104 112 120)
Lute Kamstra's avatar
Lute Kamstra committed
470
  "List of tab stop positions used by `tab-to-tab-stop'.
Richard M. Stallman's avatar
Richard M. Stallman committed
471 472 473
This should be a list of integers, ordered from smallest to largest."
  :group 'indent
  :type '(repeat integer))
474
(put 'tab-stop-list 'safe-local-variable 'listp)
Roland McGrath's avatar
Roland McGrath committed
475

476 477 478 479 480 481
(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
482 483

(defvar edit-tab-stops-buffer nil
484 485
  "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
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537

(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)
  (make-local-variable 'indent-tabs-mode)
  (setq indent-tabs-mode nil)
  (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"))

(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)
538 539
  (and abbrev-mode (= (char-syntax (preceding-char)) ?w)
       (expand-abbrev))
Roland McGrath's avatar
Roland McGrath committed
540 541 542 543
  (let ((tabs tab-stop-list))
    (while (and tabs (>= (current-column) (car tabs)))
      (setq tabs (cdr tabs)))
    (if tabs
544
	(let ((opoint (point)))
545
	  (delete-horizontal-space t)
546
	  (indent-to (car tabs)))
547
      (insert ?\s))))
Roland McGrath's avatar
Roland McGrath committed
548 549 550

(defun move-to-tab-stop ()
  "Move point to next defined tab-stop column.
551 552 553 554 555 556 557 558 559 560 561 562 563
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)
  (let ((tabs tab-stop-list))
    (while (and tabs (>= (current-column) (car tabs)))
      (setq tabs (cdr tabs)))
    (if tabs
	(let ((before (point)))
	  (move-to-column (car tabs) t)
	  (save-excursion
	    (goto-char before)
	    ;; If we just added a tab, or moved over one,
	    ;; delete any superfluous spaces before the old point.
564
	    (if (and (eq (preceding-char) ?\s)
565 566 567
		     (eq (following-char) ?\t))
		(let ((tabend (* (/ (current-column) tab-width) tab-width)))
		  (while (and (> (current-column) tabend)
568
			      (eq (preceding-char) ?\s))
569 570 571
		    (forward-char -1))
		  (delete-region (point) before))))))))

Roland McGrath's avatar
Roland McGrath committed
572
(define-key global-map "\t" 'indent-for-tab-command)
573
(define-key esc-map "\C-\\" 'indent-region)
Roland McGrath's avatar
Roland McGrath committed
574 575
(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
576

577
;; arch-tag: f402b2a7-e44f-492f-b5b8-38996020b7c3
Eric S. Raymond's avatar
Eric S. Raymond committed
578
;;; indent.el ends here