-;;; picture.el --- "Picture mode" -- editing using quarter-plane screen model.
+;;; picture.el --- "Picture mode" -- editing using quarter-plane screen model
-;; Copyright (C) 1985 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1994 Free Software Foundation, Inc.
;; Author: K. Shane Hartman
;; Maintainer: FSF
+;; Keywords: convenience wp
;; This file is part of GNU Emacs.
;; 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; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
;;; Commentary:
-;; This code provides the picture-mode commands documented in the Emacs
+;; This code provides the picture-mode commands documented in the Emacs
;; manual. The screen is treated as a semi-infinite quarter-plane with
;; support for rectangle operations and `etch-a-sketch' character
;; insertion in any of eight directions.
;;; Code:
-(defun move-to-column-force (column)
- "Move to column COLUMN in current line.
-Differs from `move-to-column' in that it creates or modifies whitespace
-if necessary to attain exactly the specified column."
- (or (natnump column) (setq column 0))
- (move-to-column column)
- (let ((col (current-column)))
- (if (< col column)
- (indent-to column)
- (if (and (/= col column)
- (= (preceding-char) ?\t))
- (let (indent-tabs-mode)
- (delete-char -1)
- (indent-to col)
- (move-to-column column))))
- ;; This call will go away when Emacs gets real horizontal autoscrolling
- (hscroll-point-visible)))
+(defgroup picture nil
+ "Picture mode --- editing using quarter-plane screen model."
+ :prefix "picture-"
+ :group 'editing)
+
+(defcustom picture-rectangle-ctl ?+
+ "*Character `picture-draw-rectangle' uses for top left corners."
+ :type 'character
+ :group 'picture)
+(defcustom picture-rectangle-ctr ?+
+ "*Character `picture-draw-rectangle' uses for top right corners."
+ :type 'character
+ :group 'picture)
+(defcustom picture-rectangle-cbr ?+
+ "*Character `picture-draw-rectangle' uses for bottom right corners."
+ :type 'character
+ :group 'picture)
+(defcustom picture-rectangle-cbl ?+
+ "*Character `picture-draw-rectangle' uses for bottom left corners."
+ :type 'character
+ :group 'picture)
+(defcustom picture-rectangle-v ?|
+ "*Character `picture-draw-rectangle' uses for vertical lines."
+ :type 'character
+ :group 'picture)
+(defcustom picture-rectangle-h ?-
+ "*Character `picture-draw-rectangle' uses for horizontal lines."
+ :type 'character
+ :group 'picture)
+
-\f
;; Picture Movement Commands
+;; When a cursor is on a wide-column character (e.g. Chinese,
+;; Japanese, Korean), this variable tells the desired current column
+;; which may be different from (current-column).
+(defvar picture-desired-column 0)
+
+;; If the value of picture-desired-column is far from the current
+;; column, or if the arg ADJUST-TO-CURRENT is non-nil, set it to the
+;; current column. Return the current column.
+(defun picture-update-desired-column (adjust-to-current)
+ (let ((current-column (current-column)))
+ (if (or adjust-to-current
+ (< picture-desired-column (1- current-column))
+ (> picture-desired-column (1+ current-column)))
+ (setq picture-desired-column current-column))
+ current-column))
+
(defun picture-beginning-of-line (&optional arg)
"Position point at the beginning of the line.
With ARG not nil, move forward ARG - 1 lines first.
(interactive "P")
(if arg (forward-line (1- (prefix-numeric-value arg))))
(beginning-of-line)
- ;; This call will go away when Emacs gets real horizontal autoscrolling
- (hscroll-point-visible))
+ (setq picture-desired-column 0))
(defun picture-end-of-line (&optional arg)
"Position point after last non-blank character on current line.
(if arg (forward-line (1- (prefix-numeric-value arg))))
(beginning-of-line)
(skip-chars-backward " \t" (prog1 (point) (end-of-line)))
- ;; This call will go away when Emacs gets real horizontal autoscrolling
- (hscroll-point-visible))
+ (setq picture-desired-column (current-column)))
-(defun picture-forward-column (arg)
+(defun picture-forward-column (arg &optional interactive)
"Move cursor right, making whitespace if necessary.
With argument, move that many columns."
- (interactive "p")
- (move-to-column-force (+ (current-column) arg)))
-
-(defun picture-backward-column (arg)
+ (interactive "p\nd")
+ (picture-update-desired-column interactive)
+ (setq picture-desired-column (max 0 (+ picture-desired-column arg)))
+ (let ((current-column (move-to-column picture-desired-column t)))
+ (if (and (> current-column picture-desired-column)
+ (< arg 0))
+ ;; It seems that we have just tried to move to the right
+ ;; column of a multi-column character.
+ (forward-char -1))))
+
+(defun picture-backward-column (arg &optional interactive)
"Move cursor left, making whitespace if necessary.
With argument, move that many columns."
- (interactive "p")
- (move-to-column-force (- (current-column) arg)))
+ (interactive "p\nd")
+ (picture-update-desired-column interactive)
+ (picture-forward-column (- arg)))
(defun picture-move-down (arg)
"Move vertically down, making whitespace if necessary.
With argument, move that many lines."
(interactive "p")
- (let ((col (current-column)))
- (picture-newline arg)
- (move-to-column-force col)))
+ (picture-update-desired-column nil)
+ (picture-newline arg)
+ (let ((current-column (move-to-column picture-desired-column t)))
+ (if (> current-column picture-desired-column)
+ (forward-char -1))))
-(defconst picture-vertical-step 0
+(defvar picture-vertical-step 0
"Amount to move vertically after text character in Picture mode.")
-(defconst picture-horizontal-step 1
+(defvar picture-horizontal-step 1
"Amount to move horizontally after text character in Picture mode.")
(defun picture-move-up (arg)
"Move vertically up, making whitespace if necessary.
With argument, move that many lines."
(interactive "p")
+ (picture-update-desired-column nil)
(picture-move-down (- arg)))
(defun picture-movement-right ()
(interactive)
(picture-set-motion 1 0))
-(defun picture-movement-nw ()
- "Move up and left after self-inserting character in Picture mode."
- (interactive)
- (picture-set-motion -1 -1))
+(defun picture-movement-nw (&optional arg)
+ "Move up and left after self-inserting character in Picture mode.
+With prefix argument, move up and two-column left."
+ (interactive "P")
+ (picture-set-motion -1 (if arg -2 -1)))
-(defun picture-movement-ne ()
- "Move up and right after self-inserting character in Picture mode."
- (interactive)
- (picture-set-motion -1 1))
+(defun picture-movement-ne (&optional arg)
+ "Move up and right after self-inserting character in Picture mode.
+With prefix argument, move up and two-column right."
+ (interactive "P")
+ (picture-set-motion -1 (if arg 2 1)))
-(defun picture-movement-sw ()
- "Move down and left after self-inserting character in Picture mode."
- (interactive)
- (picture-set-motion 1 -1))
+(defun picture-movement-sw (&optional arg)
+ "Move down and left after self-inserting character in Picture mode.
+With prefix argument, move down and two-column left."
+ (interactive "P")
+ (picture-set-motion 1 (if arg -2 -1)))
-(defun picture-movement-se ()
- "Move down and right after self-inserting character in Picture mode."
- (interactive)
- (picture-set-motion 1 1))
+(defun picture-movement-se (&optional arg)
+ "Move down and right after self-inserting character in Picture mode.
+With prefix argument, move down and two-column right."
+ (interactive "P")
+ (picture-set-motion 1 (if arg 2 1)))
(defun picture-set-motion (vert horiz)
"Set VERTICAL and HORIZONTAL increments for movement in Picture mode.
picture-horizontal-step horiz)
(setq mode-name
(format "Picture:%s"
- (car (nthcdr (+ 1 (% horiz 2) (* 3 (1+ (% vert 2))))
- '(nw up ne left none right sw down se)))))
- ;; Kludge - force the mode line to be updated. Is there a better
- ;; way to this?
- (set-buffer-modified-p (buffer-modified-p))
+ (nth (+ 2 (% horiz 3) (* 5 (1+ (% vert 2))))
+ '(wnw nw up ne ene Left left none right Right
+ wsw sw down se ese))))
+ (force-mode-line-update)
(message ""))
(defun picture-move ()
"Move in direction of `picture-vertical-step' and `picture-horizontal-step'."
- (picture-move-down picture-vertical-step)
- (picture-forward-column picture-horizontal-step))
+ (if (/= picture-vertical-step 0)
+ (picture-move-down picture-vertical-step))
+ (if (/= picture-horizontal-step 0)
+ (picture-forward-column picture-horizontal-step)))
(defun picture-motion (arg)
"Move point in direction of current picture motion in Picture mode.
\f
;; Picture insertion and deletion.
+(defun picture-insert (ch arg)
+ (let* ((width (char-width ch))
+ ;; We must be sure that the succeeding insertion won't delete
+ ;; the just inserted character.
+ (picture-horizontal-step
+ (if (and (= picture-vertical-step 0)
+ (> width 1)
+ (< (abs picture-horizontal-step) 2))
+ (* picture-horizontal-step 2)
+ picture-horizontal-step)))
+ (while (> arg 0)
+ (setq arg (1- arg))
+ (if (/= picture-desired-column (current-column))
+ (move-to-column picture-desired-column t))
+ (let ((col (+ picture-desired-column width)))
+ (or (eolp)
+ (let ((pos (point)))
+ (move-to-column col t)
+ (delete-region pos (point)))))
+ (insert ch)
+ (forward-char -1)
+ (picture-move))))
+
(defun picture-self-insert (arg)
"Insert this character in place of character previously at the cursor.
The cursor then moves in the direction you previously specified
with the commands `picture-movement-right', `picture-movement-up', etc.
Do \\[command-apropos] `picture-movement' to see those commands."
(interactive "p")
- (while (> arg 0)
- (setq arg (1- arg))
- (move-to-column-force (1+ (current-column)))
- (delete-char -1)
- (insert last-input-char)
- (forward-char -1)
- (picture-move)))
+ (picture-update-desired-column (not (eq this-command last-command)))
+ (picture-insert last-command-event arg)) ; Always a character in this case.
(defun picture-clear-column (arg)
"Clear out ARG columns after point without moving."
(interactive "p")
- (let* ((opoint (point))
- (original-col (current-column))
- (target-col (+ original-col arg)))
- (move-to-column-force target-col)
- (delete-region opoint (point))
+ (let* ((original-col (current-column))
+ (target-col (max 0 (+ original-col arg)))
+ pos)
+ (move-to-column target-col t)
+ (setq pos (point))
+ (move-to-column original-col)
+ (delete-region pos (point))
(save-excursion
- (indent-to (max target-col original-col)))))
+ (indent-to (max target-col original-col))))
+ (setq picture-desired-column (current-column)))
(defun picture-backward-clear-column (arg)
"Clear out ARG columns before point, moving back over them."
(while (> arg 0)
(end-of-line)
(if (eobp) (newline) (forward-char 1))
- (setq arg (1- arg))))
- ;; This call will go away when Emacs gets real horizontal autoscrolling
- (hscroll-point-visible))
+ (setq arg (1- arg)))))
(defun picture-open-line (arg)
"Insert an empty line after the current line.
(interactive "p")
(save-excursion
(end-of-line)
- (open-line arg))
- ;; This call will go away when Emacs gets real horizontal autoscrolling
- (hscroll-point-visible))
+ (open-line arg)))
(defun picture-duplicate-line ()
"Insert a duplicate of the current line, below it."
(if (> change 0)
(delete-region (point)
(progn
- (move-to-column-force (+ change (current-column)))
+ (move-to-column (+ change (current-column)) t)
(point))))
(replace-match newtext fixedcase literal)
(if (< change 0)
\f
;; Picture Tabs
-(defvar picture-tab-chars "!-~"
- "*A character set which controls behavior of commands
+(defcustom picture-tab-chars "!-~"
+ "*A character set which controls behavior of commands.
\\[picture-set-tab-stops] and \\[picture-tab-search]. It is NOT a
regular expression, any regexp special characters will be quoted.
It defines a set of \"interesting characters\" to look for when setting
character `\\' in the set it must be preceded by itself: \"\\\\\".
The command \\[picture-tab-search] is defined to move beneath (or to) a
-character belonging to this set independent of the tab stops list.")
+character belonging to this set independent of the tab stops list."
+ :type 'string
+ :group 'picture)
(defun picture-set-tab-stops (&optional arg)
"Set value of `tab-stop-list' according to context of this line.
(skip-chars-forward " \t")
(setq tabs (cons (current-column) tabs)))
(if (null tabs)
- (error "No characters in set %s on this line."
+ (error "No characters in set %s on this line"
(regexp-quote picture-tab-chars))))))
(setq tab-stop-list tabs)
(let ((blurb (make-string (1+ (nth (1- (length tabs)) tabs)) ?\ )))
(setq target (1- (current-column)))
(setq target nil)))
(if target
- (move-to-column-force target)
+ (move-to-column target t)
(beginning-of-line))))
(defun picture-tab (&optional arg)
\f
;; Picture Rectangles
-(defconst picture-killed-rectangle nil
+(defvar picture-killed-rectangle nil
"Rectangle killed or copied by \\[picture-clear-rectangle] in Picture mode.
The contents can be retrieved by \\[picture-yank-rectangle]")
(delete-extract-rectangle start end)
(prog1 (extract-rectangle start end)
(clear-rectangle start end))))
- (move-to-column-force column))))
+ (move-to-column column t))))
(defun picture-yank-rectangle (&optional insertp)
"Overlay rectangle saved by \\[picture-clear-rectangle]
point at the other (diagonally opposed) corner."
(interactive "P")
(if (not (consp picture-killed-rectangle))
- (error "No rectangle saved.")
+ (error "No rectangle saved")
(picture-insert-rectangle picture-killed-rectangle insertp)))
+(defun picture-yank-at-click (click arg)
+ "Insert the last killed rectangle at the position clicked on.
+Also move point to one end of the text thus inserted (normally the end).
+Prefix arguments are interpreted as with \\[yank].
+If `mouse-yank-at-point' is non-nil, insert at point
+regardless of where you click."
+ (interactive "e\nP")
+ (or mouse-yank-at-point (mouse-set-point click))
+ (picture-yank-rectangle arg))
+
(defun picture-yank-rectangle-from-register (register &optional insertp)
"Overlay rectangle saved in REGISTER.
The rectangle is positioned with upper left corner at point, overwriting
(interactive "cRectangle from register: \nP")
(let ((rectangle (get-register register)))
(if (not (consp rectangle))
- (error "Register %c does not contain a rectangle." register)
+ (error "Register %c does not contain a rectangle" register)
(picture-insert-rectangle rectangle insertp))))
(defun picture-insert-rectangle (rectangle &optional insertp)
(push-mark)
(insert-rectangle rectangle)))
+(defun picture-current-line ()
+ "Return the vertical position of point. Top line is 1."
+ (+ (count-lines (point-min) (point))
+ (if (= (current-column) 0) 1 0)))
+
+(defun picture-draw-rectangle (start end)
+ "Draw a rectangle around region."
+ (interactive "*r") ; start will be less than end
+ (let* ((sl (picture-current-line))
+ (sc (current-column))
+ (pvs picture-vertical-step)
+ (phs picture-horizontal-step)
+ (c1 (progn (goto-char start) (current-column)))
+ (r1 (picture-current-line))
+ (c2 (progn (goto-char end) (current-column)))
+ (r2 (picture-current-line))
+ (right (max c1 c2))
+ (left (min c1 c2))
+ (top (min r1 r2))
+ (bottom (max r1 r2)))
+ (goto-line top)
+ (move-to-column left t)
+ (picture-update-desired-column t)
+
+ (picture-movement-right)
+ (picture-insert picture-rectangle-ctl 1)
+ (picture-insert picture-rectangle-h (- right picture-desired-column))
+
+ (picture-movement-down)
+ (picture-insert picture-rectangle-ctr 1)
+ (picture-insert picture-rectangle-v (- bottom (picture-current-line)))
+
+ (picture-movement-left)
+ (picture-insert picture-rectangle-cbr 1)
+ (picture-insert picture-rectangle-h (- picture-desired-column left))
+
+ (picture-movement-up)
+ (picture-insert picture-rectangle-cbl 1)
+ (picture-insert picture-rectangle-v (- (picture-current-line) top))
+
+ (picture-set-motion pvs phs)
+ (goto-line sl)
+ (move-to-column sc t)))
+
\f
;; Picture Keymap, entry and exit points.
-(defconst picture-mode-map nil)
+(defvar picture-mode-map nil)
(defun picture-substitute (oldfun newfun)
(substitute-key-definition oldfun newfun picture-mode-map global-map))
(if (not picture-mode-map)
- (let ((i ?\ ))
+ (progn
(setq picture-mode-map (make-keymap))
- (while (< i ?\177)
- (define-key picture-mode-map (make-string 1 i) 'picture-self-insert)
- (setq i (1+ i)))
-
+ (picture-substitute 'self-insert-command 'picture-self-insert)
+ (picture-substitute 'completion-separator-self-insert-command
+ 'picture-self-insert)
+ (picture-substitute 'completion-separator-self-insert-autofilling
+ 'picture-self-insert)
(picture-substitute 'forward-char 'picture-forward-column)
(picture-substitute 'backward-char 'picture-backward-column)
(picture-substitute 'delete-char 'picture-clear-column)
+ ;; There are two possibilities for what is normally on DEL.
(picture-substitute 'backward-delete-char-untabify 'picture-backward-clear-column)
+ (picture-substitute 'delete-backward-char 'picture-backward-clear-column)
(picture-substitute 'kill-line 'picture-clear-line)
(picture-substitute 'open-line 'picture-open-line)
(picture-substitute 'newline 'picture-newline)
- (picture-substitute 'newline-andindent 'picture-duplicate-line)
+ (picture-substitute 'newline-and-indent 'picture-duplicate-line)
(picture-substitute 'next-line 'picture-move-down)
(picture-substitute 'previous-line 'picture-move-up)
(picture-substitute 'beginning-of-line 'picture-beginning-of-line)
(define-key picture-mode-map "\C-c\C-w" 'picture-clear-rectangle-to-register)
(define-key picture-mode-map "\C-c\C-y" 'picture-yank-rectangle)
(define-key picture-mode-map "\C-c\C-x" 'picture-yank-rectangle-from-register)
+ (define-key picture-mode-map "\C-c\C-r" 'picture-draw-rectangle)
(define-key picture-mode-map "\C-c\C-c" 'picture-mode-exit)
(define-key picture-mode-map "\C-c\C-f" 'picture-motion)
(define-key picture-mode-map "\C-c\C-b" 'picture-motion-reverse)
(define-key picture-mode-map "\C-c/" 'picture-movement-sw)
(define-key picture-mode-map "\C-c\\" 'picture-movement-se)))
-(defvar picture-mode-hook nil
+(defcustom picture-mode-hook nil
"If non-nil, its value is called on entry to Picture mode.
-Picture mode is invoked by the command \\[picture-mode].")
+Picture mode is invoked by the command \\[picture-mode]."
+ :type 'hook
+ :group 'picture)
(defvar picture-mode-old-local-map)
(defvar picture-mode-old-mode-name)
C-c ' Move northeast (ne) after insertion.
C-c / Move southwest (sw) after insertion.
C-c \\ Move southeast (se) after insertion.
+ C-u C-c ` Move westnorthwest (wnw) after insertion.
+ C-u C-c ' Move eastnortheast (ene) after insertion.
+ C-u C-c / Move westsouthwest (wsw) after insertion.
+ C-u C-c \\ Move eastsoutheast (ese) after insertion.
The current direction is displayed in the mode line. The initial
direction is right. Whitespace is inserted and tabs are changed to
spaces when required by movement. You can move around in the buffer
C-c C-w Like C-c C-k except rectangle is saved in named register.
C-c C-y Overlay (or insert) currently saved rectangle at point.
C-c C-x Like C-c C-y except rectangle is taken from named register.
+ C-c C-r Draw a rectangular box around mark and point.
\\[copy-rectangle-to-register] Copies a rectangle to a register.
\\[advertised-undo] Can undo effects of rectangle overlay commands
commands if invoked soon enough.
C-c C-c Which also strips trailing whitespace from every line.
Stripping is suppressed by supplying an argument.
-Entry to this mode calls the value of picture-mode-hook if non-nil.
+Entry to this mode calls the value of `picture-mode-hook' if non-nil.
Note that Picture mode commands will work outside of Picture mode, but
they are not defaultly assigned to keys."
(interactive)
(if (eq major-mode 'picture-mode)
- (error "You are already editing a picture.")
- (make-local-variable 'picture-mode-old-local-map)
- (setq picture-mode-old-local-map (current-local-map))
+ (error "You are already editing a picture")
+ (set (make-local-variable 'picture-mode-old-local-map) (current-local-map))
(use-local-map picture-mode-map)
- (make-local-variable 'picture-mode-old-mode-name)
- (setq picture-mode-old-mode-name mode-name)
- (make-local-variable 'picture-mode-old-major-mode)
- (setq picture-mode-old-major-mode major-mode)
+ (set (make-local-variable 'picture-mode-old-mode-name) mode-name)
+ (set (make-local-variable 'picture-mode-old-major-mode) major-mode)
(setq major-mode 'picture-mode)
- (make-local-variable 'picture-killed-rectangle)
- (setq picture-killed-rectangle nil)
- (make-local-variable 'tab-stop-list)
- (setq tab-stop-list (default-value 'tab-stop-list))
- (make-local-variable 'picture-tab-chars)
- (setq picture-tab-chars (default-value 'picture-tab-chars))
+ (set (make-local-variable 'picture-killed-rectangle) nil)
+ (set (make-local-variable 'tab-stop-list) (default-value 'tab-stop-list))
+ (set (make-local-variable 'picture-tab-chars)
+ (default-value 'picture-tab-chars))
(make-local-variable 'picture-vertical-step)
(make-local-variable 'picture-horizontal-step)
- (make-local-variable 'picture-mode-old-truncate-lines)
- (setq picture-mode-old-truncate-lines truncate-lines)
+ (set (make-local-variable 'picture-mode-old-truncate-lines) truncate-lines)
(setq truncate-lines t)
(picture-set-motion 0 1)
;; edit-picture-hook is what we used to run, picture-mode-hook is in doc.
(run-hooks 'edit-picture-hook 'picture-mode-hook)
- (message
- (substitute-command-keys
- "Type \\[picture-mode-exit] in this buffer to return it to %s mode.")
- picture-mode-old-mode-name)))
+ (message "Type %s in this buffer to return it to %s mode."
+ (substitute-command-keys "\\[picture-mode-exit]")
+ picture-mode-old-mode-name)))
;;;###autoload
(defalias 'edit-picture 'picture-mode)
(defun picture-mode-exit (&optional nostrip)
- "Undo picture-mode and return to previous major mode.
+ "Undo `picture-mode' and return to previous major mode.
With no argument strips whitespace from end of every line in Picture buffer
otherwise just return to previous mode."
(interactive "P")
(if (not (eq major-mode 'picture-mode))
- (error "You aren't editing a Picture.")
- (if (not nostrip) (picture-clean))
+ (error "You aren't editing a Picture")
+ (if (not nostrip) (delete-trailing-whitespace))
(setq mode-name picture-mode-old-mode-name)
(use-local-map picture-mode-old-local-map)
(setq major-mode picture-mode-old-major-mode)
(kill-local-variable 'tab-stop-list)
(setq truncate-lines picture-mode-old-truncate-lines)
- ;; Kludge - force the mode line to be updated. Is there a better
- ;; way to do this?
- (set-buffer-modified-p (buffer-modified-p))))
-
-(defun picture-clean ()
- "Eliminate whitespace at ends of lines."
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "[ \t][ \t]*$" nil t)
- (delete-region (match-beginning 0) (point)))))
+ (force-mode-line-update)))
(provide 'picture)
HCoop / bpt / emacs.git / blobdiff