Commit | Line | Data |
---|---|---|
c88ab9ce ER |
1 | ;;; tabify.el --- tab conversion commands for Emacs |
2 | ||
c90f2757 | 3 | ;; Copyright (C) 1985, 1994, 2001, 2002, 2003, 2004, |
409cc4a3 | 4 | ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
a2535589 | 5 | |
58142744 ER |
6 | ;; Maintainer: FSF |
7 | ||
a2535589 JA |
8 | ;; This file is part of GNU Emacs. |
9 | ||
eb3fa2cf | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
a2535589 | 11 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
12 | ;; the Free Software Foundation, either version 3 of the License, or |
13 | ;; (at your option) any later version. | |
a2535589 JA |
14 | |
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
a2535589 | 22 | |
d9ecc911 ER |
23 | ;;; Commentary: |
24 | ||
25 | ;; Commands to optimize spaces to tabs or expand tabs to spaces in a region | |
26 | ;; (`tabify' and `untabify'). The variable tab-width does the obvious. | |
27 | ||
22a89ee8 | 28 | ;;; Code: |
a2535589 | 29 | |
f9f9507e | 30 | ;;;###autoload |
a2535589 JA |
31 | (defun untabify (start end) |
32 | "Convert all tabs in region to multiple spaces, preserving columns. | |
e47b2570 RS |
33 | Called non-interactively, the region is specified by arguments |
34 | START and END, rather than by the position of point and mark. | |
35 | The variable `tab-width' controls the spacing of tab stops." | |
a2535589 JA |
36 | (interactive "r") |
37 | (save-excursion | |
38 | (save-restriction | |
5119b412 | 39 | (narrow-to-region (point-min) end) |
a2535589 JA |
40 | (goto-char start) |
41 | (while (search-forward "\t" nil t) ; faster than re-search | |
bb8143d9 | 42 | (forward-char -1) |
2d8e81a5 | 43 | (let ((tab-beg (point)) |
bb8143d9 KH |
44 | (indent-tabs-mode nil) |
45 | column) | |
46 | (skip-chars-forward "\t") | |
47 | (setq column (current-column)) | |
2d8e81a5 | 48 | (delete-region tab-beg (point)) |
a2535589 JA |
49 | (indent-to column)))))) |
50 | ||
49c7d1ac | 51 | (defvar tabify-regexp " [ \t]+" |
bb8143d9 | 52 | "Regexp matching whitespace that tabify should consider. |
e5b1b45c | 53 | Usually this will be \" [ \\t]+\" to match a space followed by whitespace. |
49c7d1ac | 54 | \"^\\t* [ \\t]+\" is also useful, for tabifying only initial whitespace.") |
bb8143d9 | 55 | |
f9f9507e | 56 | ;;;###autoload |
a2535589 JA |
57 | (defun tabify (start end) |
58 | "Convert multiple spaces in region to tabs when possible. | |
59 | A group of spaces is partially replaced by tabs | |
60 | when this can be done without changing the column they end at. | |
e47b2570 RS |
61 | Called non-interactively, the region is specified by arguments |
62 | START and END, rather than by the position of point and mark. | |
63 | The variable `tab-width' controls the spacing of tab stops." | |
a2535589 JA |
64 | (interactive "r") |
65 | (save-excursion | |
66 | (save-restriction | |
7be313ea RS |
67 | ;; Include the beginning of the line in the narrowing |
68 | ;; since otherwise it will throw off current-column. | |
69 | (goto-char start) | |
70 | (beginning-of-line) | |
71 | (narrow-to-region (point) end) | |
a2535589 | 72 | (goto-char start) |
49c7d1ac SM |
73 | (let ((indent-tabs-mode t)) |
74 | (while (re-search-forward tabify-regexp nil t) | |
75 | ;; The region between (match-beginning 0) and (match-end 0) is just | |
76 | ;; spacing which we want to adjust to use TABs where possible. | |
77 | (let ((end-col (current-column)) | |
78 | (beg-col (save-excursion (goto-char (match-beginning 0)) | |
79 | (skip-chars-forward "\t") | |
80 | (current-column)))) | |
81 | (if (= (/ end-col tab-width) (/ beg-col tab-width)) | |
82 | ;; The spacing (after some leading TABs which we wouldn't | |
83 | ;; want to touch anyway) does not straddle a TAB boundary, | |
84 | ;; so it neither contains a TAB, nor will we be able to use | |
85 | ;; a TAB here anyway: there's nothing to do. | |
86 | nil | |
87 | (delete-region (match-beginning 0) (point)) | |
88 | (indent-to end-col)))))))) | |
c88ab9ce | 89 | |
85588571 RS |
90 | (provide 'tabify) |
91 | ||
49c7d1ac | 92 | ;; arch-tag: c83893b1-e0cc-4e57-8a09-73fd03466416 |
c88ab9ce | 93 | ;;; tabify.el ends here |