xemacs-beta: lisp/rect.el comparison

comparison lisp/rect.el @ 398:74fd4e045ea6 r21-2-29

Import from CVS: tag r21-2-29

author	cvs
date	Mon, 13 Aug 2007 11:13:30 +0200
parents	262b8bb4a523
children	2f8bb876ab1d

comparison

equal deleted inserted replaced

-:f4aeb21a5bad
+:74fd4e045ea6
 ;;; rect.el --- rectangle functions for XEmacs.
-;; Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1993, 1994, 1999 Free Software Foundation, Inc.
-;; Maintainer: FSF
+;; Maintainer: Didier Verna <verna@inf.enst.fr>
 ;; Keywords: internal
 ;; This file is part of XEmacs.
 ;; XEmacs is free software; you can redistribute it and/or modify it
 ;; You should have received a copy of the GNU General Public License
 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 ;; 02111-1307, USA.
-;;; Synched up with: FSF 19.34.
+;;; Synched up with: to be incorporated in a forthcoming GNU Emacs
 ;;; Commentary:
-;; This package provides the operations on rectangles that are ocumented
+;; This package provides the operations on rectangles that are documented
 ;; in the XEmacs Reference Manual.
+;; #### NOTE: this file has been almost completely rewritten by Didier Verna
+;; <verna@inf.enst.fr>, Jul 99. The purpose of this rewrite is to be less
+;; intrusive and fill lines with whitespaces only when needed. A few functions
+;; are untouched though, as noted above their definition.
 ;;; Code:
+;; #### NOTE: this function is untouched, but not used anymore.
+;; `apply-on-rectangle' is used instead. It's still there because it's
+;; documented so people might use it in their code, so I've decided not to
+;; touch it. --dv
 ;; XEmacs: extra-args
 (defun operate-on-rectangle (function start end coerce-tabs &rest extra-args)
 "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
 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)
 	;; XEmacs
 	(let ((tem startcol))
 	  (setq startcol endcol endcol tem)))
 (save-excursion
 	  (if (< endextra 0) (setq endextra 0))
 	  (apply function startpos begextra endextra extra-args))
 	(forward-line 1)))
 (- endcol startcol)))
-(defun delete-rectangle-line (startdelpos ignore ignore)
+;; The replacement for `operate-on-rectangle' -- dv
-(delete-region startdelpos (point)))
+(defun apply-on-rectangle (function start end &rest args)
+"Call FUNCTION for each line of rectangle with corners at START and END.
-;; XEmacs: added lines arg
+FUNCTION is called with two arguments: the start and end columns of the
-(defun delete-extract-rectangle-line (startdelpos begextra endextra lines)
+rectangle, plus ARGS extra arguments. Point is at the beginning of line
-(save-excursion
+when the function is called."
-(extract-rectangle-line startdelpos begextra endextra lines))
+(let (startcol startpt endcol endpt)
-(delete-region startdelpos (point)))
+(save-excursion
+(goto-char start)
-;; XEmacs: added lines arg
+(setq startcol (current-column))
-(defun extract-rectangle-line (startdelpos begextra endextra lines)
+(beginning-of-line)
-(let ((line (buffer-substring startdelpos (point)))
+(setq startpt (point))
-	(end (point)))
+(goto-char end)
-(goto-char startdelpos)
+(setq endcol (current-column))
-(while (search-forward "\t" end t)
+(forward-line 1)
-(let ((width (- (current-column)
+(setq endpt (point-marker))
-		      (save-excursion (forward-char -1)
+;; ensure the start column is the left one.
-				      (current-column)))))
+(if (< endcol startcol)
-	(setq line (concat (substring line 0 (- (point) end 1))
+	  (let ((col startcol))
-			   (spaces-string width)
+	    (setq startcol endcol endcol col)))
-			   (substring line (+ (length line) (- (point) end)))))))
+;; start looping over lines
-(if (or (> begextra 0) (> endextra 0))
+(goto-char startpt)
-	(setq line (concat (spaces-string begextra)
+(while (< (point) endpt)
-			   line
+	(apply function startcol endcol args)
-			   (spaces-string endextra))))
+	(forward-line 1)))
-(setcdr lines (cons line (cdr lines))))) ; XEmacs
+))
-(defconst spaces-strings
+;; I love ascii art ;-)
-(purecopy '["" " " "  " "   " "    " "     " "      " "       " "        "]))
+(defconst spaces-strings '[""
+			   " "
+			   "  "
+			   "   "
+			   "    "
+			   "     "
+			   "      "
+			   "       "
+			   "        "])
+;; This function is untouched --dv
 (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)))))
 ;;;###autoload
-(defun delete-rectangle (start end)
+(defvar killed-rectangle nil
-"Delete (don't save) text in rectangle with point and mark as corners.
+"Rectangle for `yank-rectangle' to insert.")
+;;;###autoload
+(defun kill-rectangle (start end &optional fill)
+"Delete the region-rectangle and save it as the last killed one.
+You might prefer to use `delete-extract-rectangle' from a program.
+When called from a program, the rectangle's corners are START and END.
+With a prefix (or FILL) argument, also fill lines where nothing has to be
+deleted."
+(interactive "*r\nP")
+(when buffer-read-only
+(setq killed-rectangle (extract-rectangle start end))
+(barf-if-buffer-read-only))
+(setq killed-rectangle (delete-extract-rectangle start end fill)))
+;;;###autoload
+(defun delete-rectangle (start end &optional fill)
+"Delete the text in the region-rectangle without saving it.
 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."
+where the region begins and ending with the line where the region ends.
-(interactive "r")
-(operate-on-rectangle 'delete-rectangle-line start end t))
+When called from a program, the rectangle's corners are START and END.
+With a prefix (or FILL) argument, also fill lines where nothing has to be
-;;;###autoload
+deleted."
-(defun delete-extract-rectangle (start end)
+(interactive "*r\nP")
-"Delete contents of rectangle and return it as a list of strings.
+(apply-on-rectangle 'delete-rectangle-line start end fill))
-Arguments START and END are the corners of the rectangle.
-The value is list of strings, one for each line of the rectangle."
+(defun delete-rectangle-line (startcol endcol fill)
-(let ((lines (list nil))) ; XEmacs change
+(let ((pt (point-at-eol)))
-(operate-on-rectangle 'delete-extract-rectangle-line
+(when (= (move-to-column startcol (or fill 'coerce)) startcol)
-			  start end t lines)
+(if (and (not fill) (<= pt endcol))
+	  (delete-region (point) pt)
+	;; else
+	(setq pt (point))
+	(move-to-column endcol t)
+	(delete-region pt (point))))
+))
+;;;###autoload
+(defun delete-extract-rectangle (start end &optional fill)
+"Delete the contents of the rectangle with corners at START and END, and
+return it as a list of strings, one for each line of the rectangle.
+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))))
+(defun delete-extract-rectangle-line (startcol endcol lines fill)
+(let ((pt (point-at-eol)))
+(if (< (move-to-column startcol (or fill 'coerce)) startcol)
+	(setcdr lines (cons (spaces-string (- endcol startcol))
+			    (cdr lines)))
+;; else
+(setq pt (point))
+(move-to-column endcol t)
+(setcdr lines (cons (buffer-substring pt (point)) (cdr lines)))
+(delete-region pt (point)))
+))
 ;;;###autoload
 (defun extract-rectangle (start end)
-"Return contents of rectangle with corners at START and END.
+"Return the contents of the rectangle with corners at START and END,
-Value is list of strings, one for each line of the rectangle."
+as a list of strings, one for each line of the rectangle."
-(let ((lines (list nil))) ; XEmacs change
+(let ((lines (list nil)))
-(operate-on-rectangle 'extract-rectangle-line start end nil lines)
+(apply-on-rectangle 'extract-rectangle-line start end lines)
 (nreverse (cdr lines))))
-;;;###autoload
+;; #### NOTE: this is actually the only function that needs to do complicated
-(defvar killed-rectangle nil
+;; stuff like what's happening in `operate-on-rectangle', because the buffer
-"Rectangle for yank-rectangle to insert.")
+;; might be read-only. --dv
+(defun extract-rectangle-line (startcol endcol lines)
-;;;###autoload
+(let (start end begextra endextra line)
-(defun kill-rectangle (start end)
+(move-to-column startcol)
-"Delete rectangle with corners at point and mark; save as last killed one.
+(setq start (point)
-Calling from program, supply two args START and END, buffer positions.
+	  begextra (- (current-column) startcol))
-But in programs you might prefer to use `delete-extract-rectangle'."
+(move-to-column endcol)
-(interactive "r")
+(setq end (point)
-(if buffer-read-only
+	  endextra (- endcol (current-column)))
-(progn
+(setq line (buffer-substring start (point)))
-	(setq killed-rectangle (extract-rectangle start end))
+(if (< begextra 0)
-	(barf-if-buffer-read-only)))
+	(setq endextra (+ endextra begextra)
-(setq killed-rectangle (delete-extract-rectangle start end)))
+	      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)))))))
+(if (or (> begextra 0) (> endextra 0))
+	(setq line (concat (spaces-string begextra)
+			   line
+			   (spaces-string endextra))))
+(setcdr lines (cons line (cdr lines)))))
+;; This function is untouched --dv
 ;;;###autoload
 (defun yank-rectangle ()
 "Yank the last killed rectangle with upper left corner at point."
-(interactive)
+(interactive "*")
 (insert-rectangle killed-rectangle))
+;; This function is untouched --dv
 ;;;###autoload
 (defun insert-rectangle (rectangle)
 "Insert text of RECTANGLE with upper left corner at point.
 RECTANGLE's first line is inserted at point, its second
 line is inserted at a point vertically under point, etc.
 	(first t))
 (push-mark)
 (while lines
 (or first
 	  (progn
-	   (forward-line 1)
+	    (forward-line 1)
-	   (or (bolp) (insert ?\n))
+	    (or (bolp) (insert ?\n))
-	   (move-to-column insertcolumn t)))
+	    (move-to-column insertcolumn t)))
 (setq first nil)
 (insert (car lines))
 (setq lines (cdr lines)))))
 ;;;###autoload
-(defun open-rectangle (start end)
+(defun open-rectangle (start end &optional fill)
-"Blank out rectangle with corners at point and mark, shifting text right.
+"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."
+When called from a program, the rectangle's corners are START and END.
-(interactive "r")
+With a prefix (or FILL) argument, fill with blanks even if there is no text
-(operate-on-rectangle 'open-rectangle-line start end nil)
+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)
+(defun open-rectangle-line (startcol endcol fill)
-;; Column where rectangle ends.
+(let (spaces)
-(let ((endcol (+ (current-column) endextra))
+(when (= (move-to-column startcol (or fill 'coerce)) startcol)
-	whitewidth)
+(unless (and (not fill)
-(goto-char startpos)
+		   (= (point) (point-at-eol)))
-;; Column where rectangle begins.
+	(indent-to endcol)))
-(let ((begcol (- (current-column) begextra)))
+))
-(skip-chars-forward " \t")
-;; Width of whitespace to be deleted and recreated.
-(setq whitewidth (- (current-column) begcol)))
-;; Delete the whitespace following the start column.
-(delete-region startpos (point))
-;; Open the desired width, plus same amount of whitespace we just deleted.
-(indent-to (+ endcol whitewidth))))
 ;;;###autoload
 (defun string-rectangle (start end string)
 "Insert STRING on each line of the region-rectangle, shifting text right.
-The left edge of the rectangle specifies the column for insertion.
+The left edge of the rectangle specifies the column for insertion. This
-This command does not delete or overwrite any existing text.
+command does not delete or overwrite any existing text.
-Called from a program, takes three args; START, END and STRING."
+When called from a program, the rectangle's corners are START and END."
-(interactive "r\nsString rectangle: ")
+(interactive "*r\nsString rectangle: ")
-(operate-on-rectangle 'string-rectangle-line start end t string)) ; XEmacs
+(apply-on-rectangle 'string-rectangle-line start end string))
-;; XEmacs: add string arg
+(defun string-rectangle-line (startcol endcol string)
-(defun string-rectangle-line (startpos begextra endextra string)
+(move-to-column startcol t)
-(let (whitespace)
+(insert string))
-(goto-char startpos)
-;; Compute horizontal width of following whitespace.
+;;;###autoload
-(let ((ocol (current-column)))
+(defun clear-rectangle (start end &optional fill)
-(skip-chars-forward " \t")
+"Blank out the region-rectangle.
-(setq whitespace (- (current-column) ocol)))
+The text previously in the region is overwritten with blanks.
-;; Delete the following whitespace.
-(delete-region startpos (point))
+When called from a program, the rectangle's corners are START and END.
-;; Insert the desired string.
+With a prefix (or FILL) argument, also fill with blanks the parts of the
-(insert string)
+rectangle which were empty."
-;; Insert the same width of whitespace that we had before.
+(interactive "*r\nP")
-(indent-to (+ (current-column) whitespace))))
+(apply-on-rectangle 'clear-rectangle-line start end fill))
-;;;###autoload
+(defun clear-rectangle-line (startcol endcol fill)
-(defun clear-rectangle (start end)
+(let ((pt (point-at-eol))
-"Blank out rectangle with corners at point and mark.
+	spaces)
-The text previously in the region is overwritten by the blanks.
+(when (= (move-to-column startcol (or fill 'coerce)) startcol)
-When called from a program, requires two args which specify the corners."
+(if (and (not fill)
-(interactive "r")
+	       (<= (save-excursion (goto-char pt) (current-column)) endcol))
-(operate-on-rectangle 'clear-rectangle-line start end t))
+	  (delete-region (point) pt)
+	;; else
-(defun clear-rectangle-line (startpos begextra endextra)
+	(setq pt (point))
-;; Find end of whitespace after the rectangle.
+	(move-to-column endcol t)
-(skip-chars-forward " \t")
+	(setq spaces (- (point) pt))
-(let ((column (+ (current-column) endextra)))
+	(delete-region pt (point))
-;; Delete the text in the rectangle, and following whitespace.
+	(indent-to (+ (current-column) spaces))))
-(delete-region (point)
+))
-(progn (goto-char startpos)
-			  (skip-chars-backward " \t")
-			  (point)))
-;; Reindent out to same column that we were at.
-(indent-to column)))
 (provide 'rect)
 ;;; rect.el ends here

Mercurial > hg > xemacs-beta

comparison lisp/rect.el @ 398:74fd4e045ea6 r21-2-29