-;;; rect.el --- rectangle functions for GNU Emacs.
+;;; rect.el --- rectangle functions for GNU Emacs
-;; Copyright (C) 1985 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1999-2011 Free Software Foundation, Inc.
-;; Maintainer: FSF
+;; Maintainer: Didier Verna <didier@xemacs.org>
;; Keywords: internal
+;; Package: emacs
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) 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
;; 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.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
-;; This package provides the operations on rectangles that are ocumented
+;; This package provides the operations on rectangles that are documented
;; in the Emacs manual.
+;; ### NOTE: this file was almost completely rewritten by Didier Verna
+;; <didier@xemacs.org> in July 1999.
+
+;;; 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)
+;;;###autoload (define-key ctl-x-r-map "N" 'rectangle-number-lines)
+
;;; Code:
+;; FIXME: this function should be replaced by `apply-on-rectangle'
(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
(setq endlinepos (point-marker)))
(if (< endcol startcol)
(setq startcol (prog1 endcol (setq endcol startcol))))
- (if (/= endcol startcol)
- (save-excursion
- (goto-char startlinepos)
- (while (< (point) endlinepos)
- (let (startpos begextra endextra)
- (move-to-column startcol coerce-tabs)
- (setq begextra (- (current-column) startcol))
- (setq startpos (point))
- (move-to-column endcol coerce-tabs)
- (setq endextra (- endcol (current-column)))
- (if (< begextra 0)
- (setq endextra (+ endextra begextra)
- begextra 0))
- (funcall function startpos begextra endextra))
- (forward-line 1))))
+ (save-excursion
+ (goto-char startlinepos)
+ (while (< (point) endlinepos)
+ (let (startpos begextra endextra)
+ (if coerce-tabs
+ (move-to-column startcol t)
+ (move-to-column startcol))
+ (setq begextra (- (current-column) startcol))
+ (setq startpos (point))
+ (if coerce-tabs
+ (move-to-column endcol t)
+ (move-to-column endcol))
+ ;; If we overshot, move back one character
+ ;; so that endextra will be positive.
+ (if (and (not coerce-tabs) (> (current-column) endcol))
+ (backward-char 1))
+ (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 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
+rectangle, plus ARGS extra arguments. Point is at the beginning of line when
+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-extract-rectangle-line (startdelpos begextra endextra)
- (save-excursion
- (extract-rectangle-line startdelpos begextra endextra))
- (delete-region startdelpos (point)))
+(defun delete-rectangle-line (startcol endcol fill)
+ (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
+ (delete-region (point)
+ (progn (move-to-column endcol 'coerce)
+ (point)))))
+
+(defun delete-extract-rectangle-line (startcol endcol lines fill)
+ (let ((pt (point-at-eol)))
+ (if (< (move-to-column startcol (if fill t 'coerce)) startcol)
+ (setcdr lines (cons (spaces-string (- endcol startcol))
+ (cdr lines)))
+ ;; else
+ (setq pt (point))
+ (move-to-column endcol t)
+ (setcdr lines (cons (filter-buffer-substring pt (point) t) (cdr lines))))
+ ))
-(defun extract-rectangle-line (startdelpos begextra endextra)
- (let ((line (buffer-substring startdelpos (point)))
- (end (point)))
- (goto-char startdelpos)
+;; 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.
+(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)
(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)))))))
+ (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))))
+ (setcdr lines (cons line (cdr lines)))))
(defconst spaces-strings
'["" " " " " " " " " " " " " " " " "])
(defun spaces-string (n)
+ "Return a string with N spaces."
(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)))))
-
+ (make-string n ?\s)))
+
;;;###autoload
-(defun delete-rectangle (start end)
- "Delete (don't save) text in rectangle with point and mark as corners.
-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."
- (interactive "r")
- (operate-on-rectangle 'delete-rectangle-line start end t))
+(defun delete-rectangle (start end &optional fill)
+ "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")
+ (apply-on-rectangle 'delete-rectangle-line start end fill))
;;;###autoload
-(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)))
+(defun delete-extract-rectangle (start end &optional fill)
+ "Delete 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.
+
+When called from a program the rectangle's corners are START and END.
+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))))
;;;###autoload
(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)))
+ "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."
+ (let ((lines (list nil)))
+ (apply-on-rectangle 'extract-rectangle-line start end lines)
+ (nreverse (cdr lines))))
(defvar killed-rectangle nil
- "Rectangle for yank-rectangle to insert.")
+ "Rectangle for `yank-rectangle' to insert.")
;;;###autoload
-(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.
-But in programs you might prefer to use `delete-extract-rectangle'."
- (interactive "r")
- (setq killed-rectangle (delete-extract-rectangle start end)))
+(defun kill-rectangle (start end &optional fill)
+ "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.
+
+With a prefix (or a FILL) argument, also fill lines where nothing has to be
+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)))))))
;;;###autoload
(defun yank-rectangle ()
"Yank the last killed rectangle with upper left corner at point."
- (interactive)
+ (interactive "*")
(insert-rectangle killed-rectangle))
;;;###autoload
(or (bolp) (insert ?\n))
(move-to-column insertcolumn t)))
(setq first nil)
- (insert (car lines))
+ (insert-for-yank (car lines))
(setq lines (cdr lines)))))
;;;###autoload
-(defun open-rectangle (start end)
- "Blank out rectangle with corners at point and mark, shifting text right.
+(defun open-rectangle (start end &optional fill)
+ "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."
- (interactive "r")
- (operate-on-rectangle 'open-rectangle-line start end nil)
+but instead winds up to the right of the rectangle.
+
+When called from a program the rectangle's corners are START and END.
+With a prefix (or a FILL) argument, fill with blanks even if there is
+no text on the right side of the rectangle."
+ (interactive "*r\nP")
+ (apply-on-rectangle 'open-rectangle-line start end fill)
(goto-char start))
-(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)
- ;; Use skip-chars-backward's LIM argument to leave
- ;; characters before STARTPOS undisturbed.
- (progn (skip-chars-backward " \t" startpos)
- (point)))
- (indent-to column)))
+(defun open-rectangle-line (startcol endcol fill)
+ (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
+ (unless (and (not fill)
+ (= (point) (point-at-eol)))
+ (indent-to endcol))))
+
+(defun delete-whitespace-rectangle-line (startcol _endcol fill)
+ (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
+ (unless (= (point) (point-at-eol))
+ (delete-region (point) (progn (skip-syntax-forward " ") (point))))))
;;;###autoload
-(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)))
+(defalias 'close-rectangle 'delete-whitespace-rectangle) ;; Old name
+
+;;;###autoload
+(defun delete-whitespace-rectangle (start end &optional fill)
+ "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
+rectangle, all continuous whitespace starting at that column is deleted.
+
+When called from a program the rectangle's corners are START and END.
+With a prefix (or a FILL) argument, also fill too short lines."
+ (interactive "*r\nP")
+ (apply-on-rectangle 'delete-whitespace-rectangle-line start end fill))
+
+(defvar string-rectangle-history nil)
+(defun string-rectangle-line (startcol endcol string delete)
+ (move-to-column startcol t)
+ (if delete
+ (delete-rectangle-line startcol endcol nil))
+ (insert string))
+
+;;;###autoload
+(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."
+ (interactive
+ (progn (barf-if-buffer-read-only)
+ (list
+ (region-beginning)
+ (region-end)
+ (read-string (format "String rectangle (default %s): "
+ (or (car string-rectangle-history) ""))
+ nil 'string-rectangle-history
+ (car string-rectangle-history)))))
+ (apply-on-rectangle 'string-rectangle-line start end string t))
+
+;;;###autoload
+(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."
+ (interactive
+ (progn (barf-if-buffer-read-only)
+ (list
+ (region-beginning)
+ (region-end)
+ (read-string (format "String insert rectangle (default %s): "
+ (or (car string-rectangle-history) ""))
+ nil 'string-rectangle-history
+ (car string-rectangle-history)))))
+ (apply-on-rectangle 'string-rectangle-line start end string nil))
+
+;;;###autoload
+(defun clear-rectangle (start end &optional fill)
+ "Blank out the region-rectangle.
+The text previously in the region is overwritten with blanks.
+
+When called from a program the rectangle's corners are START and END.
+With a prefix (or a FILL) argument, also fill with blanks the parts of the
+rectangle which were empty."
+ (interactive "*r\nP")
+ (apply-on-rectangle 'clear-rectangle-line start end fill))
+
+(defun clear-rectangle-line (startcol endcol fill)
+ (let ((pt (point-at-eol)))
+ (when (= (move-to-column startcol (if fill t 'coerce)) startcol)
+ (if (and (not fill)
+ (<= (save-excursion (goto-char pt) (current-column)) endcol))
+ (delete-region (point) pt)
+ ;; else
+ (setq pt (point))
+ (move-to-column endcol t)
+ (setq endcol (current-column))
+ (delete-region pt (point))
+ (indent-to endcol)))))
+
+;; 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)))
(provide 'rect)