Commit | Line | Data |
---|---|---|
6594deb0 ER |
1 | ;;; rect.el --- rectangle functions for GNU Emacs. |
2 | ||
d733c5ec | 3 | ;; Copyright (C) 1985, 1994 Free Software Foundation, Inc. |
9750e079 | 4 | |
4821e2af | 5 | ;; Maintainer: FSF |
d7b4d18f | 6 | ;; Keywords: internal |
4821e2af | 7 | |
a2535589 JA |
8 | ;; This file is part of GNU Emacs. |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
e5167999 | 12 | ;; the Free Software Foundation; either version 2, or (at your option) |
a2535589 JA |
13 | ;; any later version. |
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 | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
22 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
23 | ||
edbd2f74 ER |
24 | ;;; Commentary: |
25 | ||
26 | ;; This package provides the operations on rectangles that are ocumented | |
27 | ;; in the Emacs manual. | |
28 | ||
4821e2af | 29 | ;;; Code: |
a2535589 JA |
30 | |
31 | (defun operate-on-rectangle (function start end coerce-tabs) | |
32 | "Call FUNCTION for each line of rectangle with corners at START, END. | |
33 | If COERCE-TABS is non-nil, convert multi-column characters | |
34 | that span the starting or ending columns on any line | |
35 | to multiple spaces before calling FUNCTION. | |
36 | FUNCTION is called with three arguments: | |
37 | position of start of segment of this line within the rectangle, | |
38 | number of columns that belong to rectangle but are before that position, | |
39 | number of columns that belong to rectangle but are after point. | |
40 | Point is at the end of the segment of this line within the rectangle." | |
41 | (let (startcol startlinepos endcol endlinepos) | |
42 | (save-excursion | |
43 | (goto-char start) | |
44 | (setq startcol (current-column)) | |
45 | (beginning-of-line) | |
46 | (setq startlinepos (point))) | |
47 | (save-excursion | |
48 | (goto-char end) | |
49 | (setq endcol (current-column)) | |
50 | (forward-line 1) | |
51 | (setq endlinepos (point-marker))) | |
52 | (if (< endcol startcol) | |
08ce70d1 | 53 | (setq startcol (prog1 endcol (setq endcol startcol)))) |
bc8ea543 RS |
54 | (save-excursion |
55 | (goto-char startlinepos) | |
56 | (while (< (point) endlinepos) | |
57 | (let (startpos begextra endextra) | |
58 | (move-to-column startcol coerce-tabs) | |
59 | (setq begextra (- (current-column) startcol)) | |
60 | (setq startpos (point)) | |
61 | (move-to-column endcol coerce-tabs) | |
62 | (setq endextra (- endcol (current-column))) | |
63 | (if (< begextra 0) | |
64 | (setq endextra (+ endextra begextra) | |
65 | begextra 0)) | |
66 | (funcall function startpos begextra endextra)) | |
67 | (forward-line 1))) | |
a2535589 JA |
68 | (- endcol startcol))) |
69 | ||
70 | (defun delete-rectangle-line (startdelpos ignore ignore) | |
71 | (delete-region startdelpos (point))) | |
72 | ||
73 | (defun delete-extract-rectangle-line (startdelpos begextra endextra) | |
74 | (save-excursion | |
75 | (extract-rectangle-line startdelpos begextra endextra)) | |
76 | (delete-region startdelpos (point))) | |
77 | ||
78 | (defun extract-rectangle-line (startdelpos begextra endextra) | |
79 | (let ((line (buffer-substring startdelpos (point))) | |
80 | (end (point))) | |
81 | (goto-char startdelpos) | |
82 | (while (search-forward "\t" end t) | |
83 | (let ((width (- (current-column) | |
84 | (save-excursion (forward-char -1) | |
85 | (current-column))))) | |
86 | (setq line (concat (substring line 0 (- (point) end 1)) | |
87 | (spaces-string width) | |
88 | (substring line (+ (length line) (- (point) end))))))) | |
89 | (if (or (> begextra 0) (> endextra 0)) | |
90 | (setq line (concat (spaces-string begextra) | |
91 | line | |
92 | (spaces-string endextra)))) | |
93 | (setq lines (cons line lines)))) | |
94 | ||
95 | (defconst spaces-strings | |
96 | '["" " " " " " " " " " " " " " " " "]) | |
97 | ||
98 | (defun spaces-string (n) | |
99 | (if (<= n 8) (aref spaces-strings n) | |
100 | (let ((val "")) | |
101 | (while (> n 8) | |
102 | (setq val (concat " " val) | |
103 | n (- n 8))) | |
104 | (concat val (aref spaces-strings n))))) | |
105 | ||
f9f9507e | 106 | ;;;###autoload |
a2535589 JA |
107 | (defun delete-rectangle (start end) |
108 | "Delete (don't save) text in rectangle with point and mark as corners. | |
573f9b32 RS |
109 | The same range of columns is deleted in each line starting with the line |
110 | where the region begins and ending with the line where the region ends." | |
a2535589 JA |
111 | (interactive "r") |
112 | (operate-on-rectangle 'delete-rectangle-line start end t)) | |
113 | ||
f9f9507e | 114 | ;;;###autoload |
a2535589 JA |
115 | (defun delete-extract-rectangle (start end) |
116 | "Delete contents of rectangle and return it as a list of strings. | |
117 | Arguments START and END are the corners of the rectangle. | |
118 | The value is list of strings, one for each line of the rectangle." | |
119 | (let (lines) | |
120 | (operate-on-rectangle 'delete-extract-rectangle-line | |
121 | start end t) | |
122 | (nreverse lines))) | |
123 | ||
f9f9507e | 124 | ;;;###autoload |
a2535589 JA |
125 | (defun extract-rectangle (start end) |
126 | "Return contents of rectangle with corners at START and END. | |
127 | Value is list of strings, one for each line of the rectangle." | |
128 | (let (lines) | |
129 | (operate-on-rectangle 'extract-rectangle-line start end nil) | |
130 | (nreverse lines))) | |
131 | ||
132 | (defvar killed-rectangle nil | |
133 | "Rectangle for yank-rectangle to insert.") | |
134 | ||
f9f9507e | 135 | ;;;###autoload |
a2535589 JA |
136 | (defun kill-rectangle (start end) |
137 | "Delete rectangle with corners at point and mark; save as last killed one. | |
138 | Calling from program, supply two args START and END, buffer positions. | |
573f9b32 | 139 | But in programs you might prefer to use `delete-extract-rectangle'." |
a2535589 | 140 | (interactive "r") |
db03492e RS |
141 | (if buffer-read-only |
142 | (progn | |
143 | (setq killed-rectangle (extract-rectangle start end)) | |
144 | (barf-if-buffer-read-only))) | |
a2535589 JA |
145 | (setq killed-rectangle (delete-extract-rectangle start end))) |
146 | ||
f9f9507e | 147 | ;;;###autoload |
a2535589 JA |
148 | (defun yank-rectangle () |
149 | "Yank the last killed rectangle with upper left corner at point." | |
150 | (interactive) | |
151 | (insert-rectangle killed-rectangle)) | |
152 | ||
f9f9507e | 153 | ;;;###autoload |
a2535589 JA |
154 | (defun insert-rectangle (rectangle) |
155 | "Insert text of RECTANGLE with upper left corner at point. | |
573f9b32 RS |
156 | RECTANGLE's first line is inserted at point, its second |
157 | line is inserted at a point vertically under point, etc. | |
23317eac RS |
158 | RECTANGLE should be a list of strings. |
159 | After this command, the mark is at the upper left corner | |
160 | and point is at the lower right corner." | |
a2535589 JA |
161 | (let ((lines rectangle) |
162 | (insertcolumn (current-column)) | |
163 | (first t)) | |
23317eac | 164 | (push-mark) |
a2535589 JA |
165 | (while lines |
166 | (or first | |
167 | (progn | |
168 | (forward-line 1) | |
169 | (or (bolp) (insert ?\n)) | |
08ce70d1 | 170 | (move-to-column insertcolumn t))) |
a2535589 JA |
171 | (setq first nil) |
172 | (insert (car lines)) | |
173 | (setq lines (cdr lines))))) | |
174 | ||
f9f9507e | 175 | ;;;###autoload |
a2535589 JA |
176 | (defun open-rectangle (start end) |
177 | "Blank out rectangle with corners at point and mark, shifting text right. | |
178 | The text previously in the region is not overwritten by the blanks, | |
08ce70d1 | 179 | but instead winds up to the right of the rectangle." |
a2535589 | 180 | (interactive "r") |
08ce70d1 JB |
181 | (operate-on-rectangle 'open-rectangle-line start end nil) |
182 | (goto-char start)) | |
a2535589 JA |
183 | |
184 | (defun open-rectangle-line (startpos begextra endextra) | |
bc8ea543 RS |
185 | ;; Column where rectangle ends. |
186 | (let ((endcol (+ (current-column) endextra)) | |
187 | whitewidth) | |
a2535589 | 188 | (goto-char startpos) |
bc8ea543 RS |
189 | ;; Column where rectangle begins. |
190 | (let ((begcol (- (current-column) begextra))) | |
a2535589 | 191 | (skip-chars-forward " \t") |
bc8ea543 RS |
192 | ;; Width of whitespace to be deleted and recreated. |
193 | (setq whitewidth (- (current-column) begcol))) | |
194 | ;; Delete the whitespace following the start column. | |
195 | (delete-region startpos (point)) | |
196 | ;; Open the desired width, plus same amount of whitespace we just deleted. | |
197 | (indent-to (+ endcol whitewidth)))) | |
a2535589 | 198 | |
131ca136 | 199 | ;;;###autoload |
ccb629e4 RS |
200 | (defun string-rectangle (start end string) |
201 | "Insert STRING on each line of the region-rectangle, shifting text right. | |
202 | The left edge of the rectangle specifies the column for insertion. | |
203 | This command does not delete or overwrite any existing text. | |
204 | ||
205 | Called from a program, takes three args; START, END and STRING." | |
206 | (interactive "r\nsString rectangle: ") | |
b6c1b08c | 207 | (operate-on-rectangle 'string-rectangle-line start end t)) |
131ca136 | 208 | |
ccb629e4 | 209 | (defun string-rectangle-line (startpos begextra endextra) |
bc8ea543 | 210 | (let (whitespace) |
131ca136 | 211 | (goto-char startpos) |
bc8ea543 | 212 | ;; Compute horizontal width of following whitespace. |
131ca136 ER |
213 | (let ((ocol (current-column))) |
214 | (skip-chars-forward " \t") | |
bc8ea543 RS |
215 | (setq whitespace (- (current-column) ocol))) |
216 | ;; Delete the following whitespace. | |
217 | (delete-region startpos (point)) | |
218 | ;; Insert the desired string. | |
219 | (insert string) | |
220 | ;; Insert the same width of whitespace that we had before. | |
221 | (indent-to (+ (current-column) whitespace)))) | |
131ca136 | 222 | |
f9f9507e | 223 | ;;;###autoload |
a2535589 JA |
224 | (defun clear-rectangle (start end) |
225 | "Blank out rectangle with corners at point and mark. | |
226 | The text previously in the region is overwritten by the blanks. | |
227 | When called from a program, requires two args which specify the corners." | |
228 | (interactive "r") | |
229 | (operate-on-rectangle 'clear-rectangle-line start end t)) | |
230 | ||
231 | (defun clear-rectangle-line (startpos begextra endextra) | |
bc8ea543 | 232 | ;; Find end of whitespace after the rectangle. |
a2535589 JA |
233 | (skip-chars-forward " \t") |
234 | (let ((column (+ (current-column) endextra))) | |
bc8ea543 | 235 | ;; Delete the text in the rectangle, and following whitespace. |
a2535589 JA |
236 | (delete-region (point) |
237 | (progn (goto-char startpos) | |
238 | (skip-chars-backward " \t") | |
239 | (point))) | |
bc8ea543 | 240 | ;; Reindent out to same column that we were at. |
a2535589 JA |
241 | (indent-to column))) |
242 | ||
08ce70d1 | 243 | (provide 'rect) |
6594deb0 ER |
244 | |
245 | ;;; rect.el ends here |