annotate lisp/tabify.el @ 66122:d61c5c1cd4c6

*** empty log message ***
author Stefan Monnier <monnier@iro.umontreal.ca>
date Sun, 16 Oct 2005 15:34:32 +0000
parents 41bb365f41c4
children 3bd95f4f2941 2d92f5c9d6ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
658
7cbd4fcd8b0f *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 258
diff changeset
1 ;;; tabify.el --- tab conversion commands for Emacs
7cbd4fcd8b0f *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 258
diff changeset
2
64762
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64091
diff changeset
3 ;; Copyright (C) 1985, 1994, 2002, 2003, 2004,
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64091
diff changeset
4 ;; 2005 Free Software Foundation, Inc.
841
2cdce064065f entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 807
diff changeset
5
775
1ca26ccad38e *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 658
diff changeset
6 ;; Maintainer: FSF
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
7
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
9
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 775
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
13 ;; any later version.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
14
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
18 ;; GNU General Public License for more details.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
19
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 11421
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64091
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
23 ;; Boston, MA 02110-1301, USA.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
24
2315
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 1497
diff changeset
25 ;;; Commentary:
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 1497
diff changeset
26
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 1497
diff changeset
27 ;; Commands to optimize spaces to tabs or expand tabs to spaces in a region
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 1497
diff changeset
28 ;; (`tabify' and `untabify'). The variable tab-width does the obvious.
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 1497
diff changeset
29
775
1ca26ccad38e *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 658
diff changeset
30 ;;; Code:
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
31
258
1e0bc00dca7a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 36
diff changeset
32 ;;;###autoload
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
33 (defun untabify (start end)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
34 "Convert all tabs in region to multiple spaces, preserving columns.
1497
7117a3826501 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 841
diff changeset
35 Called non-interactively, the region is specified by arguments
7117a3826501 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 841
diff changeset
36 START and END, rather than by the position of point and mark.
7117a3826501 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 841
diff changeset
37 The variable `tab-width' controls the spacing of tab stops."
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
38 (interactive "r")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
39 (save-excursion
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
40 (save-restriction
2467
a3bdf5ac2e9d (untabify): Don't really change where restriction starts.
Richard M. Stallman <rms@gnu.org>
parents: 2315
diff changeset
41 (narrow-to-region (point-min) end)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
42 (goto-char start)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
43 (while (search-forward "\t" nil t) ; faster than re-search
18344
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
44 (forward-char -1)
5715
a7f72ce7bac4 (tabify): Don't delete back before initial START.
Richard M. Stallman <rms@gnu.org>
parents: 5165
diff changeset
45 (let ((tab-beg (point))
18344
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
46 (indent-tabs-mode nil)
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
47 column)
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
48 (skip-chars-forward "\t")
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
49 (setq column (current-column))
5715
a7f72ce7bac4 (tabify): Don't delete back before initial START.
Richard M. Stallman <rms@gnu.org>
parents: 5165
diff changeset
50 (delete-region tab-beg (point))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
51 (indent-to column))))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
52
18344
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
53 (defvar tabify-regexp "[ \t][ \t]+"
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
54 "Regexp matching whitespace that tabify should consider.
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
55 Usually this will be \"[ \\t][ \\t]+\" to match two or more spaces or tabs.
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
56 \"^[ \\t]+\" is also useful, for tabifying only initial whitespace.")
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
57
258
1e0bc00dca7a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 36
diff changeset
58 ;;;###autoload
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
59 (defun tabify (start end)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
60 "Convert multiple spaces in region to tabs when possible.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
61 A group of spaces is partially replaced by tabs
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
62 when this can be done without changing the column they end at.
1497
7117a3826501 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 841
diff changeset
63 Called non-interactively, the region is specified by arguments
7117a3826501 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 841
diff changeset
64 START and END, rather than by the position of point and mark.
7117a3826501 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 841
diff changeset
65 The variable `tab-width' controls the spacing of tab stops."
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
66 (interactive "r")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
67 (save-excursion
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
68 (save-restriction
11421
c53961dfba50 (tabify): Include entire first line in narrowing.
Richard M. Stallman <rms@gnu.org>
parents: 7304
diff changeset
69 ;; Include the beginning of the line in the narrowing
c53961dfba50 (tabify): Include entire first line in narrowing.
Richard M. Stallman <rms@gnu.org>
parents: 7304
diff changeset
70 ;; since otherwise it will throw off current-column.
c53961dfba50 (tabify): Include entire first line in narrowing.
Richard M. Stallman <rms@gnu.org>
parents: 7304
diff changeset
71 (goto-char start)
c53961dfba50 (tabify): Include entire first line in narrowing.
Richard M. Stallman <rms@gnu.org>
parents: 7304
diff changeset
72 (beginning-of-line)
c53961dfba50 (tabify): Include entire first line in narrowing.
Richard M. Stallman <rms@gnu.org>
parents: 7304
diff changeset
73 (narrow-to-region (point) end)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
74 (goto-char start)
18344
dca9b4a8155e (untabify): Handle consecutive tabs all at once.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
75 (while (re-search-forward tabify-regexp nil t)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
76 (let ((column (current-column))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
77 (indent-tabs-mode t))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
78 (delete-region (match-beginning 0) (point))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
79 (indent-to column))))))
658
7cbd4fcd8b0f *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 258
diff changeset
80
5165
619c0a9ddf86 Add a provide.
Richard M. Stallman <rms@gnu.org>
parents: 2467
diff changeset
81 (provide 'tabify)
619c0a9ddf86 Add a provide.
Richard M. Stallman <rms@gnu.org>
parents: 2467
diff changeset
82
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 18344
diff changeset
83 ;;; arch-tag: c83893b1-e0cc-4e57-8a09-73fd03466416
658
7cbd4fcd8b0f *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 258
diff changeset
84 ;;; tabify.el ends here