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

Eric S. Raymond's avatar
Eric S. Raymond committed
3 4
;; Copyright (C) 1985 Free Software Foundation, Inc.

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

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

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

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

Eric S. Raymond's avatar
Eric S. Raymond committed
24
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

(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)
48
	(setq startcol (prog1 endcol (setq endcol startcol))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
49 50 51 52 53
    (if (/= endcol startcol)
	(save-excursion
	 (goto-char startlinepos)
	 (while (< (point) endlinepos)
	   (let (startpos begextra endextra)
54
	     (move-to-column startcol coerce-tabs)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
55 56
	     (setq begextra (- (current-column) startcol))
	     (setq startpos (point))
57
	     (move-to-column endcol coerce-tabs)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
	     (setq endextra (- endcol (current-column)))
	     (if (< begextra 0)
		 (setq endextra (+ endextra begextra)
		       begextra 0))
	     (funcall function startpos begextra endextra))
	   (forward-line 1))))
    (- endcol startcol)))

(defun delete-rectangle-line (startdelpos ignore ignore)
  (delete-region startdelpos (point)))

(defun delete-extract-rectangle-line (startdelpos begextra endextra)
  (save-excursion
   (extract-rectangle-line startdelpos begextra endextra))
  (delete-region startdelpos (point)))

(defun extract-rectangle-line (startdelpos begextra endextra)
  (let ((line (buffer-substring startdelpos (point)))
	(end (point)))
    (goto-char startdelpos)
    (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)
			   (substring line (+ (length line) (- (point) end)))))))
    (if (or (> begextra 0) (> endextra 0))
	(setq line (concat (spaces-string begextra)
			   line
			   (spaces-string endextra))))
    (setq lines (cons line lines))))

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

(defun spaces-string (n)
  (if (<= n 8) (aref spaces-strings n)
    (let ((val ""))
      (while (> n 8)
	(setq val (concat "        " val)
	      n (- n 8)))
      (concat val (aref spaces-strings n)))))
    
Jim Blandy's avatar
Jim Blandy committed
102
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
103 104
(defun delete-rectangle (start end)
  "Delete (don't save) text in rectangle with point and mark as corners.
105 106
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."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
107 108 109
  (interactive "r")
  (operate-on-rectangle 'delete-rectangle-line start end t))

Jim Blandy's avatar
Jim Blandy committed
110
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
111 112 113 114 115 116 117 118 119
(defun delete-extract-rectangle (start end)
  "Delete contents of rectangle and return it as a list of strings.
Arguments START and END are the corners of the rectangle.
The value is list of strings, one for each line of the rectangle."
  (let (lines)
    (operate-on-rectangle 'delete-extract-rectangle-line
			  start end t)
    (nreverse lines)))

Jim Blandy's avatar
Jim Blandy committed
120
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
121 122 123 124 125 126 127 128 129 130
(defun extract-rectangle (start end)
  "Return contents of rectangle with corners at START and END.
Value is list of strings, one for each line of the rectangle."
  (let (lines)
    (operate-on-rectangle 'extract-rectangle-line start end nil)
    (nreverse lines)))

(defvar killed-rectangle nil
  "Rectangle for yank-rectangle to insert.")

Jim Blandy's avatar
Jim Blandy committed
131
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
132 133 134
(defun kill-rectangle (start end)
  "Delete rectangle with corners at point and mark; save as last killed one.
Calling from program, supply two args START and END, buffer positions.
135
But in programs you might prefer to use `delete-extract-rectangle'."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
136 137 138
  (interactive "r")
  (setq killed-rectangle (delete-extract-rectangle start end)))

Jim Blandy's avatar
Jim Blandy committed
139
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
140 141 142 143 144
(defun yank-rectangle ()
  "Yank the last killed rectangle with upper left corner at point."
  (interactive)
  (insert-rectangle killed-rectangle))

Jim Blandy's avatar
Jim Blandy committed
145
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
146 147
(defun insert-rectangle (rectangle)
  "Insert text of RECTANGLE with upper left corner at point.
148 149
RECTANGLE's first line is inserted at point, its second
line is inserted at a point vertically under point, etc.
150 151 152
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
153 154 155
  (let ((lines rectangle)
	(insertcolumn (current-column))
	(first t))
156
    (push-mark)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
157 158 159 160 161
    (while lines
      (or first
	  (progn
	   (forward-line 1)
	   (or (bolp) (insert ?\n))
162
	   (move-to-column insertcolumn t)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
163 164 165 166
      (setq first nil)
      (insert (car lines))
      (setq lines (cdr lines)))))

Jim Blandy's avatar
Jim Blandy committed
167
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
168 169 170
(defun open-rectangle (start end)
  "Blank out rectangle with corners at point and mark, shifting text right.
The text previously in the region is not overwritten by the blanks,
171
but instead winds up to the right of the rectangle."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
172
  (interactive "r")
173 174
  (operate-on-rectangle 'open-rectangle-line start end nil)
  (goto-char start))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
175 176 177 178 179 180 181 182

(defun open-rectangle-line (startpos begextra endextra)
  (let ((column (+ (current-column) begextra endextra)))
    (goto-char startpos)
    (let ((ocol (current-column)))
      (skip-chars-forward " \t")
      (setq column (+ column (- (current-column) ocol))))
    (delete-region (point)
183 184 185
		   ;; Use skip-chars-backward's LIM argument to leave
		   ;; characters before STARTPOS undisturbed.
                   (progn (skip-chars-backward " \t" startpos)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
186 187 188
			  (point)))
    (indent-to column)))

Jim Blandy's avatar
Jim Blandy committed
189
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
(defun clear-rectangle (start end)
  "Blank out rectangle with corners at point and mark.
The text previously in the region is overwritten by the blanks.
When called from a program, requires two args which specify the corners."
  (interactive "r")
  (operate-on-rectangle 'clear-rectangle-line start end t))

(defun clear-rectangle-line (startpos begextra endextra)
  (skip-chars-forward " \t")
  (let ((column (+ (current-column) endextra)))
    (delete-region (point)
                   (progn (goto-char startpos)
			  (skip-chars-backward " \t")
			  (point)))
    (indent-to column)))

206
(provide 'rect)
Eric S. Raymond's avatar
Eric S. Raymond committed
207 208

;;; rect.el ends here