rect.el 14.8 KB
Newer Older
1
;;; rect.el --- rectangle functions for GNU Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1985, 1999, 2000, 2001, 2002, 2003, 2004
4
;;   2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Maintainer: Didier Verna <didier@xemacs.org>
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: internal
8
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Joseph Arceneaux's avatar
Joseph Arceneaux committed
10 11
;; This file is part of GNU Emacs.

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

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
24

25 26
;;; Commentary:

27
;; This package provides the operations on rectangles that are documented
28 29
;; in the Emacs manual.

30 31
;; ### NOTE: this file was almost completely rewritten by Didier Verna
;; <didier@xemacs.org> in July 1999.
32

33 34 35 36 37 38 39 40
;;; Global key bindings

;;;###autoload (define-key ctl-x-r-map "c" 'clear-rectangle)
;;;###autoload (define-key ctl-x-r-map "k" 'kill-rectangle)
;;;###autoload (define-key ctl-x-r-map "d" 'delete-rectangle)
;;;###autoload (define-key ctl-x-r-map "y" 'yank-rectangle)
;;;###autoload (define-key ctl-x-r-map "o" 'open-rectangle)
;;;###autoload (define-key ctl-x-r-map "t" 'string-rectangle)
41
;;;###autoload (define-key ctl-x-r-map "N" 'rectangle-number-lines)
42

Eric S. Raymond's avatar
Eric S. Raymond committed
43
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
44

45
;; FIXME: this function should be replaced by `apply-on-rectangle'
Joseph Arceneaux's avatar
Joseph Arceneaux committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
(defun operate-on-rectangle (function start end coerce-tabs)
  "Call FUNCTION for each line of rectangle with corners at START, END.
If COERCE-TABS is non-nil, convert multi-column characters
that span the starting or ending columns on any line
to multiple spaces before calling FUNCTION.
FUNCTION is called with three arguments:
 position of start of segment of this line within the rectangle,
 number of columns that belong to rectangle but are before that position,
 number of columns that belong to rectangle but are after point.
Point is at the end of the segment of this line within the rectangle."
  (let (startcol startlinepos endcol endlinepos)
    (save-excursion
     (goto-char start)
     (setq startcol (current-column))
     (beginning-of-line)
     (setq startlinepos (point)))
    (save-excursion
     (goto-char end)
     (setq endcol (current-column))
     (forward-line 1)
     (setq endlinepos (point-marker)))
    (if (< endcol startcol)
68
	(setq startcol (prog1 endcol (setq endcol startcol))))
69 70 71 72
    (save-excursion
     (goto-char startlinepos)
     (while (< (point) endlinepos)
       (let (startpos begextra endextra)
73
	 (if coerce-tabs
74
	     (move-to-column startcol t)
75
	   (move-to-column startcol))
76 77
	 (setq begextra (- (current-column) startcol))
	 (setq startpos (point))
78
	 (if coerce-tabs
79
	     (move-to-column endcol t)
80
	   (move-to-column endcol))
81 82 83 84
	 ;; If we overshot, move back one character
	 ;; so that endextra will be positive.
	 (if (and (not coerce-tabs) (> (current-column) endcol))
	     (backward-char 1))
85 86 87 88 89 90
	 (setq endextra (- endcol (current-column)))
	 (if (< begextra 0)
	     (setq endextra (+ endextra begextra)
		   begextra 0))
	 (funcall function startpos begextra endextra))
       (forward-line 1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
91 92
    (- endcol startcol)))

93 94 95
(defun apply-on-rectangle (function start end &rest args)
  "Call FUNCTION for each line of rectangle with corners at START, END.
FUNCTION is called with two arguments: the start and end columns of the
96
rectangle, plus ARGS extra arguments.  Point is at the beginning of line when
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
the function is called."
  (let (startcol startpt endcol endpt)
    (save-excursion
      (goto-char start)
      (setq startcol (current-column))
      (beginning-of-line)
      (setq startpt (point))
      (goto-char end)
      (setq endcol (current-column))
      (forward-line 1)
      (setq endpt (point-marker))
      ;; ensure the start column is the left one.
      (if (< endcol startcol)
	  (let ((col startcol))
	    (setq startcol endcol endcol col)))
      ;; start looping over lines
      (goto-char startpt)
      (while (< (point) endpt)
	(apply function startcol endcol args)
	(forward-line 1)))
    ))

(defun delete-rectangle-line (startcol endcol fill)
120
  (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
121 122 123
    (delete-region (point)
		   (progn (move-to-column endcol 'coerce)
			  (point)))))
124 125 126

(defun delete-extract-rectangle-line (startcol endcol lines fill)
  (let ((pt (point-at-eol)))
127
    (if (< (move-to-column startcol (if fill t 'coerce)) startcol)
128 129 130 131
	(setcdr lines (cons (spaces-string (- endcol startcol))
			    (cdr lines)))
      ;; else
      (setq pt (point))
132
      (move-to-column endcol t)
133
      (setcdr lines (cons (filter-buffer-substring pt (point) t) (cdr lines))))
134 135
    ))

136 137 138
;; This is actually the only function that needs to do complicated
;; stuff like what's happening in `operate-on-rectangle', because the
;; buffer might be read-only.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
(defun extract-rectangle-line (startcol endcol lines)
  (let (start end begextra endextra line)
    (move-to-column startcol)
    (setq start (point)
	  begextra (- (current-column) startcol))
    (move-to-column endcol)
    (setq end (point)
	  endextra (- endcol (current-column)))
    (setq line (buffer-substring start (point)))
    (if (< begextra 0)
	(setq endextra (+ endextra begextra)
	      begextra 0))
    (if (< endextra 0)
	(setq endextra 0))
    (goto-char start)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
154 155 156 157 158 159
    (while (search-forward "\t" end t)
      (let ((width (- (current-column)
		      (save-excursion (forward-char -1)
				      (current-column)))))
	(setq line (concat (substring line 0 (- (point) end 1))
			   (spaces-string width)
160 161
			   (substring line (+ (length line)
					      (- (point) end)))))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
162 163 164 165
    (if (or (> begextra 0) (> endextra 0))
	(setq line (concat (spaces-string begextra)
			   line
			   (spaces-string endextra))))
166
    (setcdr lines (cons line (cdr lines)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
167 168 169 170 171

(defconst spaces-strings
  '["" " " "  " "   " "    " "     " "      " "       " "        "])

(defun spaces-string (n)
Juanma Barranquero's avatar
Juanma Barranquero committed
172
  "Return a string with N spaces."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
173
  (if (<= n 8) (aref spaces-strings n)
Juanma Barranquero's avatar
Juanma Barranquero committed
174
    (make-string n ?\s)))
175

Jim Blandy's avatar
Jim Blandy committed
176
;;;###autoload
177
(defun delete-rectangle (start end &optional fill)
178 179 180 181 182 183 184 185 186
  "Delete (don't save) text in the region-rectangle.
The same range of columns is deleted in each line starting with the
line where the region begins and ending with the line where the region
ends.

When called from a program the rectangle's corners are START and END.
With a prefix (or a FILL) argument, also fill lines where nothing has
to be deleted."
  (interactive "*r\nP")
187
  (apply-on-rectangle 'delete-rectangle-line start end fill))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
188

Jim Blandy's avatar
Jim Blandy committed
189
;;;###autoload
190
(defun delete-extract-rectangle (start end &optional fill)
191
  "Delete the contents of the rectangle with corners at START and END.
192
Return it as a list of strings, one for each line of the rectangle.
193

194
When called from a program the rectangle's corners are START and END.
195 196 197 198 199
With an optional FILL argument, also fill lines where nothing has to be
deleted."
  (let ((lines (list nil)))
    (apply-on-rectangle 'delete-extract-rectangle-line start end lines fill)
    (nreverse (cdr lines))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
200

Jim Blandy's avatar
Jim Blandy committed
201
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
202
(defun extract-rectangle (start end)
203 204
  "Return the contents of the rectangle with corners at START and END.
Return it as a list of strings, one for each line of the rectangle."
205 206 207
  (let ((lines (list nil)))
    (apply-on-rectangle 'extract-rectangle-line start end lines)
    (nreverse (cdr lines))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
208 209

(defvar killed-rectangle nil
210
  "Rectangle for `yank-rectangle' to insert.")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
211

Jim Blandy's avatar
Jim Blandy committed
212
;;;###autoload
213
(defun kill-rectangle (start end &optional fill)
214 215 216 217
  "Delete the region-rectangle and save it as the last killed one.

When called from a program the rectangle's corners are START and END.
You might prefer to use `delete-extract-rectangle' from a program.
218 219

With a prefix (or a FILL) argument, also fill lines where nothing has to be
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
deleted.

If the buffer is read-only, Emacs will beep and refrain from deleting
the rectangle, but put it in the kill ring anyway.  This means that
you can use this command to copy text from a read-only buffer.
\(If the variable `kill-read-only-ok' is non-nil, then this won't
even beep.)"
  (interactive "r\nP")
  (condition-case nil
      (setq killed-rectangle (delete-extract-rectangle start end fill))
    ((buffer-read-only text-read-only)
     (setq killed-rectangle (extract-rectangle start end))
     (if kill-read-only-ok
	 (progn (message "Read only text copied to kill ring") nil)
       (barf-if-buffer-read-only)
       (signal 'text-read-only (list (current-buffer)))))))
236

Jim Blandy's avatar
Jim Blandy committed
237
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
238 239
(defun yank-rectangle ()
  "Yank the last killed rectangle with upper left corner at point."
240
  (interactive "*")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
241 242
  (insert-rectangle killed-rectangle))

Jim Blandy's avatar
Jim Blandy committed
243
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
244 245
(defun insert-rectangle (rectangle)
  "Insert text of RECTANGLE with upper left corner at point.
246 247
RECTANGLE's first line is inserted at point, its second
line is inserted at a point vertically under point, etc.
248 249 250
RECTANGLE should be a list of strings.
After this command, the mark is at the upper left corner
and point is at the lower right corner."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
251 252 253
  (let ((lines rectangle)
	(insertcolumn (current-column))
	(first t))
254
    (push-mark)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
255 256 257 258 259
    (while lines
      (or first
	  (progn
	   (forward-line 1)
	   (or (bolp) (insert ?\n))
260
	   (move-to-column insertcolumn t)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
261
      (setq first nil)
262
      (insert-for-yank (car lines))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
263 264
      (setq lines (cdr lines)))))

Jim Blandy's avatar
Jim Blandy committed
265
;;;###autoload
266
(defun open-rectangle (start end &optional fill)
267 268 269 270
  "Blank out the region-rectangle, shifting text right.

The text previously in the region is not overwritten by the blanks,
but instead winds up to the right of the rectangle.
271

272
When called from a program the rectangle's corners are START and END.
Juanma Barranquero's avatar
Juanma Barranquero committed
273 274
With a prefix (or a FILL) argument, fill with blanks even if there is
no text on the right side of the rectangle."
275
  (interactive "*r\nP")
276
  (apply-on-rectangle 'open-rectangle-line start end fill)
277
  (goto-char start))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
278

279
(defun open-rectangle-line (startcol endcol fill)
280
  (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
281 282 283
    (unless (and (not fill)
		 (= (point) (point-at-eol)))
      (indent-to endcol))))
284 285

(defun delete-whitespace-rectangle-line (startcol endcol fill)
286
  (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
287
    (unless (= (point) (point-at-eol))
288
      (delete-region (point) (progn (skip-syntax-forward " ") (point))))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
289

290 291 292
;;;###autoload
(defalias 'close-rectangle 'delete-whitespace-rectangle) ;; Old name

293
;;;###autoload
294
(defun delete-whitespace-rectangle (start end &optional fill)
295 296 297
  "Delete all whitespace following a specified column in each line.
The left edge of the rectangle specifies the position in each line
at which whitespace deletion should begin.  On each line in the
298
rectangle, all continuous whitespace starting at that column is deleted.
299

300
When called from a program the rectangle's corners are START and END.
301
With a prefix (or a FILL) argument, also fill too short lines."
302
  (interactive "*r\nP")
303 304
  (apply-on-rectangle 'delete-whitespace-rectangle-line start end fill))

305
(defvar string-rectangle-history nil)
306
(defun string-rectangle-line (startcol endcol string delete)
307
  (move-to-column startcol t)
308 309
  (if delete
      (delete-rectangle-line startcol endcol nil))
310
  (insert string))
311

312
;;;###autoload
313 314 315 316 317
(defun string-rectangle (start end string)
  "Replace rectangle contents with STRING on each line.
The length of STRING need not be the same as the rectangle width.

Called from a program, takes three args; START, END and STRING."
318 319 320 321 322
  (interactive
   (progn (barf-if-buffer-read-only)
	  (list
	   (region-beginning)
	   (region-end)
323
	   (read-string (format "String rectangle (default %s): "
324 325 326
				(or (car string-rectangle-history) ""))
			nil 'string-rectangle-history
			(car string-rectangle-history)))))
327
  (apply-on-rectangle 'string-rectangle-line start end string t))
328

329
;;;###autoload
330 331 332 333 334 335 336 337 338
(defalias 'replace-rectangle 'string-rectangle)

;;;###autoload
(defun string-insert-rectangle (start end string)
  "Insert STRING on each line of region-rectangle, shifting text right.

When called from a program, the rectangle's corners are START and END.
The left edge of the rectangle specifies the column for insertion.
This command does not delete or overwrite any existing text."
339 340 341 342 343
  (interactive
   (progn (barf-if-buffer-read-only)
	  (list
	   (region-beginning)
	   (region-end)
344
	   (read-string (format "String insert rectangle (default %s): "
345 346 347
				(or (car string-rectangle-history) ""))
			nil 'string-rectangle-history
			(car string-rectangle-history)))))
348 349
  (apply-on-rectangle 'string-rectangle-line start end string nil))

Jim Blandy's avatar
Jim Blandy committed
350
;;;###autoload
351
(defun clear-rectangle (start end &optional fill)
352 353
  "Blank out the region-rectangle.
The text previously in the region is overwritten with blanks.
354

355
When called from a program the rectangle's corners are START and END.
356 357
With a prefix (or a FILL) argument, also fill with blanks the parts of the
rectangle which were empty."
358
  (interactive "*r\nP")
359 360 361
  (apply-on-rectangle 'clear-rectangle-line start end fill))

(defun clear-rectangle-line (startcol endcol fill)
362
  (let ((pt (point-at-eol)))
363
    (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
364 365 366 367 368
      (if (and (not fill)
	       (<= (save-excursion (goto-char pt) (current-column)) endcol))
	  (delete-region (point) pt)
	;; else
	(setq pt (point))
369
	(move-to-column endcol t)
370
	(setq endcol (current-column))
371
	(delete-region pt (point))
372
	(indent-to endcol)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
373

374 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 405 406 407 408 409 410 411 412
;; Line numbers for `rectangle-number-line-callback'.
(defvar rectangle-number-line-counter)

(defun rectangle-number-line-callback (start end format-string)
  (move-to-column start t)
  (insert (format format-string rectangle-number-line-counter))
  (setq rectangle-number-line-counter
	(1+ rectangle-number-line-counter)))

(defun rectange--default-line-number-format (start end start-at)
  (concat "%"
	  (int-to-string (length (int-to-string (+ (count-lines start end)
						   start-at))))
	  "d "))

;;;###autoload
(defun rectangle-number-lines (start end start-at &optional format)
  "Insert numbers in front of the region-rectangle.

START-AT, if non-nil, should be a number from which to begin
counting.  FORMAT, if non-nil, should be a format string to pass
to `format' along with the line count.  When called interactively
with a prefix argument, prompt for START-AT and FORMAT."
  (interactive
   (if current-prefix-arg
       (let* ((start (region-beginning))
	      (end   (region-end))
	      (start-at (read-number "Number to count from: " 1)))
	 (list start end start-at
	       (read-string "Format string: "
			    (rectange--default-line-number-format
			     start end start-at))))
     (list (region-beginning) (region-end) 1 nil)))
  (unless format
    (setq format (rectange--default-line-number-format start end start-at)))
  (let ((rectangle-number-line-counter start-at))
    (apply-on-rectangle 'rectangle-number-line-callback
			start end format)))

413
(provide 'rect)
Eric S. Raymond's avatar
Eric S. Raymond committed
414 415

;;; rect.el ends here