Commit | Line | Data |
---|---|---|
55535639 | 1 | ;;; picture.el --- "Picture mode" -- editing using quarter-plane screen model |
6594deb0 | 2 | |
e6ce8c42 | 3 | ;; Copyright (C) 1985, 1994, 2001, 2002, 2003, 2004, 2005, 2006, 2007, |
114f9c96 | 4 | ;; 2008, 2009, 2010 Free Software Foundation, Inc. |
3a801d0c | 5 | |
e5167999 ER |
6 | ;; Author: K. Shane Hartman |
7 | ;; Maintainer: FSF | |
82168689 | 8 | ;; Keywords: convenience wp |
695d13c7 BP |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
1fecc8fe | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
695d13c7 | 13 | ;; it under the terms of the GNU General Public License as published by |
1fecc8fe GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
695d13c7 BP |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
1fecc8fe | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
695d13c7 | 24 | |
edbd2f74 ER |
25 | ;;; Commentary: |
26 | ||
eaae8106 | 27 | ;; This code provides the picture-mode commands documented in the Emacs |
edbd2f74 ER |
28 | ;; manual. The screen is treated as a semi-infinite quarter-plane with |
29 | ;; support for rectangle operations and `etch-a-sketch' character | |
30 | ;; insertion in any of eight directions. | |
31 | ||
e5167999 | 32 | ;;; Code: |
695d13c7 | 33 | |
d1ebc62e | 34 | (defgroup picture nil |
381194d0 | 35 | "Picture mode --- editing using quarter-plane screen model." |
d1ebc62e | 36 | :prefix "picture-" |
eba5b4dd | 37 | :group 'wp) |
d1ebc62e SE |
38 | |
39 | (defcustom picture-rectangle-ctl ?+ | |
1fc7dabf | 40 | "Character `picture-draw-rectangle' uses for top left corners." |
d1ebc62e SE |
41 | :type 'character |
42 | :group 'picture) | |
43 | (defcustom picture-rectangle-ctr ?+ | |
1fc7dabf | 44 | "Character `picture-draw-rectangle' uses for top right corners." |
d1ebc62e SE |
45 | :type 'character |
46 | :group 'picture) | |
47 | (defcustom picture-rectangle-cbr ?+ | |
1fc7dabf | 48 | "Character `picture-draw-rectangle' uses for bottom right corners." |
d1ebc62e SE |
49 | :type 'character |
50 | :group 'picture) | |
51 | (defcustom picture-rectangle-cbl ?+ | |
1fc7dabf | 52 | "Character `picture-draw-rectangle' uses for bottom left corners." |
d1ebc62e SE |
53 | :type 'character |
54 | :group 'picture) | |
55 | (defcustom picture-rectangle-v ?| | |
1fc7dabf | 56 | "Character `picture-draw-rectangle' uses for vertical lines." |
d1ebc62e SE |
57 | :type 'character |
58 | :group 'picture) | |
59 | (defcustom picture-rectangle-h ?- | |
1fc7dabf | 60 | "Character `picture-draw-rectangle' uses for horizontal lines." |
d1ebc62e SE |
61 | :type 'character |
62 | :group 'picture) | |
63 | ||
695d13c7 | 64 | |
695d13c7 BP |
65 | ;; Picture Movement Commands |
66 | ||
2697c1f3 KH |
67 | ;; When a cursor is on a wide-column character (e.g. Chinese, |
68 | ;; Japanese, Korean), this variable tells the desired current column | |
69 | ;; which may be different from (current-column). | |
70 | (defvar picture-desired-column 0) | |
71 | ||
72 | ;; If the value of picture-desired-column is far from the current | |
73 | ;; column, or if the arg ADJUST-TO-CURRENT is non-nil, set it to the | |
74 | ;; current column. Return the current column. | |
75 | (defun picture-update-desired-column (adjust-to-current) | |
76 | (let ((current-column (current-column))) | |
77 | (if (or adjust-to-current | |
78 | (< picture-desired-column (1- current-column)) | |
79 | (> picture-desired-column (1+ current-column))) | |
80 | (setq picture-desired-column current-column)) | |
81 | current-column)) | |
82 | ||
ca9c7579 ER |
83 | (defun picture-beginning-of-line (&optional arg) |
84 | "Position point at the beginning of the line. | |
85 | With ARG not nil, move forward ARG - 1 lines first. | |
86 | If scan reaches end of buffer, stop there without error." | |
87 | (interactive "P") | |
88 | (if arg (forward-line (1- (prefix-numeric-value arg)))) | |
89 | (beginning-of-line) | |
5f6a0375 | 90 | (setq picture-desired-column 0)) |
ca9c7579 | 91 | |
695d13c7 BP |
92 | (defun picture-end-of-line (&optional arg) |
93 | "Position point after last non-blank character on current line. | |
94 | With ARG not nil, move forward ARG - 1 lines first. | |
95 | If scan reaches end of buffer, stop there without error." | |
96 | (interactive "P") | |
97 | (if arg (forward-line (1- (prefix-numeric-value arg)))) | |
98 | (beginning-of-line) | |
ca9c7579 | 99 | (skip-chars-backward " \t" (prog1 (point) (end-of-line))) |
5f6a0375 | 100 | (setq picture-desired-column (current-column))) |
695d13c7 | 101 | |
bac8c2e7 | 102 | (defun picture-forward-column (arg &optional interactive) |
695d13c7 BP |
103 | "Move cursor right, making whitespace if necessary. |
104 | With argument, move that many columns." | |
bac8c2e7 | 105 | (interactive "p\nd") |
4855897e RS |
106 | (let (deactivate-mark) |
107 | (picture-update-desired-column interactive) | |
108 | (setq picture-desired-column (max 0 (+ picture-desired-column arg))) | |
109 | (let ((current-column (move-to-column picture-desired-column t))) | |
110 | (if (and (> current-column picture-desired-column) | |
111 | (< arg 0)) | |
112 | ;; It seems that we have just tried to move to the right | |
113 | ;; column of a multi-column character. | |
114 | (forward-char -1))))) | |
695d13c7 | 115 | |
bac8c2e7 | 116 | (defun picture-backward-column (arg &optional interactive) |
695d13c7 BP |
117 | "Move cursor left, making whitespace if necessary. |
118 | With argument, move that many columns." | |
bac8c2e7 RS |
119 | (interactive "p\nd") |
120 | (picture-update-desired-column interactive) | |
ad8fb8ae | 121 | (picture-forward-column (- arg))) |
695d13c7 BP |
122 | |
123 | (defun picture-move-down (arg) | |
124 | "Move vertically down, making whitespace if necessary. | |
125 | With argument, move that many lines." | |
126 | (interactive "p") | |
4855897e RS |
127 | (let (deactivate-mark) |
128 | (picture-update-desired-column nil) | |
129 | (picture-newline arg) | |
130 | (let ((current-column (move-to-column picture-desired-column t))) | |
131 | (if (> current-column picture-desired-column) | |
132 | (forward-char -1))))) | |
695d13c7 | 133 | |
99b3bc61 | 134 | (defvar picture-vertical-step 0 |
695d13c7 BP |
135 | "Amount to move vertically after text character in Picture mode.") |
136 | ||
99b3bc61 | 137 | (defvar picture-horizontal-step 1 |
695d13c7 BP |
138 | "Amount to move horizontally after text character in Picture mode.") |
139 | ||
140 | (defun picture-move-up (arg) | |
141 | "Move vertically up, making whitespace if necessary. | |
142 | With argument, move that many lines." | |
143 | (interactive "p") | |
2697c1f3 | 144 | (picture-update-desired-column nil) |
695d13c7 BP |
145 | (picture-move-down (- arg))) |
146 | ||
147 | (defun picture-movement-right () | |
148 | "Move right after self-inserting character in Picture mode." | |
149 | (interactive) | |
150 | (picture-set-motion 0 1)) | |
151 | ||
152 | (defun picture-movement-left () | |
153 | "Move left after self-inserting character in Picture mode." | |
154 | (interactive) | |
155 | (picture-set-motion 0 -1)) | |
156 | ||
157 | (defun picture-movement-up () | |
158 | "Move up after self-inserting character in Picture mode." | |
159 | (interactive) | |
160 | (picture-set-motion -1 0)) | |
161 | ||
162 | (defun picture-movement-down () | |
163 | "Move down after self-inserting character in Picture mode." | |
164 | (interactive) | |
165 | (picture-set-motion 1 0)) | |
166 | ||
2697c1f3 KH |
167 | (defun picture-movement-nw (&optional arg) |
168 | "Move up and left after self-inserting character in Picture mode. | |
169 | With prefix argument, move up and two-column left." | |
170 | (interactive "P") | |
171 | (picture-set-motion -1 (if arg -2 -1))) | |
695d13c7 | 172 | |
2697c1f3 KH |
173 | (defun picture-movement-ne (&optional arg) |
174 | "Move up and right after self-inserting character in Picture mode. | |
175 | With prefix argument, move up and two-column right." | |
176 | (interactive "P") | |
177 | (picture-set-motion -1 (if arg 2 1))) | |
695d13c7 | 178 | |
2697c1f3 KH |
179 | (defun picture-movement-sw (&optional arg) |
180 | "Move down and left after self-inserting character in Picture mode. | |
181 | With prefix argument, move down and two-column left." | |
182 | (interactive "P") | |
183 | (picture-set-motion 1 (if arg -2 -1))) | |
695d13c7 | 184 | |
2697c1f3 KH |
185 | (defun picture-movement-se (&optional arg) |
186 | "Move down and right after self-inserting character in Picture mode. | |
187 | With prefix argument, move down and two-column right." | |
188 | (interactive "P") | |
189 | (picture-set-motion 1 (if arg 2 1))) | |
695d13c7 BP |
190 | |
191 | (defun picture-set-motion (vert horiz) | |
192 | "Set VERTICAL and HORIZONTAL increments for movement in Picture mode. | |
193 | The mode line is updated to reflect the current direction." | |
194 | (setq picture-vertical-step vert | |
195 | picture-horizontal-step horiz) | |
196 | (setq mode-name | |
197 | (format "Picture:%s" | |
2697c1f3 KH |
198 | (nth (+ 2 (% horiz 3) (* 5 (1+ (% vert 2)))) |
199 | '(wnw nw up ne ene Left left none right Right | |
200 | wsw sw down se ese)))) | |
00dbaf0a | 201 | (force-mode-line-update) |
695d13c7 BP |
202 | (message "")) |
203 | ||
204 | (defun picture-move () | |
205 | "Move in direction of `picture-vertical-step' and `picture-horizontal-step'." | |
2697c1f3 KH |
206 | (if (/= picture-vertical-step 0) |
207 | (picture-move-down picture-vertical-step)) | |
208 | (if (/= picture-horizontal-step 0) | |
209 | (picture-forward-column picture-horizontal-step))) | |
695d13c7 BP |
210 | |
211 | (defun picture-motion (arg) | |
212 | "Move point in direction of current picture motion in Picture mode. | |
213 | With ARG do it that many times. Useful for delineating rectangles in | |
214 | conjunction with diagonal picture motion. | |
215 | Do \\[command-apropos] picture-movement to see commands which control motion." | |
216 | (interactive "p") | |
217 | (picture-move-down (* arg picture-vertical-step)) | |
218 | (picture-forward-column (* arg picture-horizontal-step))) | |
219 | ||
220 | (defun picture-motion-reverse (arg) | |
221 | "Move point in direction opposite of current picture motion in Picture mode. | |
222 | With ARG do it that many times. Useful for delineating rectangles in | |
223 | conjunction with diagonal picture motion. | |
15693bc3 | 224 | Do \\[command-apropos] picture-movement to see commands which control motion." |
695d13c7 BP |
225 | (interactive "p") |
226 | (picture-motion (- arg))) | |
227 | ||
15693bc3 JPW |
228 | (defun picture-mouse-set-point (event) |
229 | "Move point to the position clicked on, making whitespace if necessary." | |
230 | (interactive "e") | |
231 | (let* ((pos (posn-col-row (event-start event))) | |
232 | (x (car pos)) | |
233 | (y (cdr pos)) | |
234 | (current-row (count-lines (window-start) (line-beginning-position)))) | |
235 | (unless (equal x (current-column)) | |
236 | (picture-forward-column (- x (current-column)))) | |
237 | (unless (equal y current-row) | |
238 | (picture-move-down (- y current-row))))) | |
239 | ||
695d13c7 BP |
240 | \f |
241 | ;; Picture insertion and deletion. | |
242 | ||
d792910f | 243 | (defun picture-insert (ch arg) |
2697c1f3 KH |
244 | (let* ((width (char-width ch)) |
245 | ;; We must be sure that the succeeding insertion won't delete | |
246 | ;; the just inserted character. | |
247 | (picture-horizontal-step | |
248 | (if (and (= picture-vertical-step 0) | |
249 | (> width 1) | |
250 | (< (abs picture-horizontal-step) 2)) | |
251 | (* picture-horizontal-step 2) | |
252 | picture-horizontal-step))) | |
253 | (while (> arg 0) | |
254 | (setq arg (1- arg)) | |
255 | (if (/= picture-desired-column (current-column)) | |
5ed5b2c2 | 256 | (move-to-column picture-desired-column t)) |
2697c1f3 KH |
257 | (let ((col (+ picture-desired-column width))) |
258 | (or (eolp) | |
259 | (let ((pos (point))) | |
5ed5b2c2 | 260 | (move-to-column col t) |
2697c1f3 KH |
261 | (delete-region pos (point))))) |
262 | (insert ch) | |
263 | (forward-char -1) | |
264 | (picture-move)))) | |
d792910f | 265 | |
695d13c7 BP |
266 | (defun picture-self-insert (arg) |
267 | "Insert this character in place of character previously at the cursor. | |
268 | The cursor then moves in the direction you previously specified | |
269 | with the commands `picture-movement-right', `picture-movement-up', etc. | |
270 | Do \\[command-apropos] `picture-movement' to see those commands." | |
271 | (interactive "p") | |
2697c1f3 | 272 | (picture-update-desired-column (not (eq this-command last-command))) |
d792910f | 273 | (picture-insert last-command-event arg)) ; Always a character in this case. |
695d13c7 BP |
274 | |
275 | (defun picture-clear-column (arg) | |
276 | "Clear out ARG columns after point without moving." | |
277 | (interactive "p") | |
2697c1f3 KH |
278 | (let* ((original-col (current-column)) |
279 | (target-col (max 0 (+ original-col arg))) | |
280 | pos) | |
5ed5b2c2 | 281 | (move-to-column target-col t) |
2697c1f3 KH |
282 | (setq pos (point)) |
283 | (move-to-column original-col) | |
284 | (delete-region pos (point)) | |
695d13c7 | 285 | (save-excursion |
2697c1f3 KH |
286 | (indent-to (max target-col original-col)))) |
287 | (setq picture-desired-column (current-column))) | |
695d13c7 BP |
288 | |
289 | (defun picture-backward-clear-column (arg) | |
290 | "Clear out ARG columns before point, moving back over them." | |
291 | (interactive "p") | |
292 | (picture-clear-column (- arg))) | |
293 | ||
294 | (defun picture-clear-line (arg) | |
295 | "Clear out rest of line; if at end of line, advance to next line. | |
296 | Cleared-out line text goes into the kill ring, as do newlines that are | |
297 | advanced over. With argument, clear out (and save in kill ring) that | |
298 | many lines." | |
299 | (interactive "P") | |
300 | (if arg | |
301 | (progn | |
302 | (setq arg (prefix-numeric-value arg)) | |
303 | (kill-line arg) | |
304 | (newline (if (> arg 0) arg (- arg)))) | |
305 | (if (looking-at "[ \t]*$") | |
306 | (kill-ring-save (point) (progn (forward-line 1) (point))) | |
307 | (kill-region (point) (progn (end-of-line) (point)))))) | |
308 | ||
309 | (defun picture-newline (arg) | |
310 | "Move to the beginning of the following line. | |
311 | With argument, moves that many lines (up, if negative argument); | |
312 | always moves to the beginning of a line." | |
313 | (interactive "p") | |
314 | (if (< arg 0) | |
315 | (forward-line arg) | |
316 | (while (> arg 0) | |
317 | (end-of-line) | |
318 | (if (eobp) (newline) (forward-char 1)) | |
5f6a0375 | 319 | (setq arg (1- arg))))) |
695d13c7 BP |
320 | |
321 | (defun picture-open-line (arg) | |
322 | "Insert an empty line after the current line. | |
323 | With positive argument insert that many lines." | |
324 | (interactive "p") | |
325 | (save-excursion | |
326 | (end-of-line) | |
5f6a0375 | 327 | (open-line arg))) |
695d13c7 BP |
328 | |
329 | (defun picture-duplicate-line () | |
330 | "Insert a duplicate of the current line, below it." | |
331 | (interactive) | |
332 | (save-excursion | |
333 | (let ((contents | |
334 | (buffer-substring | |
335 | (progn (beginning-of-line) (point)) | |
336 | (progn (picture-newline 1) (point))))) | |
337 | (forward-line -1) | |
338 | (insert contents)))) | |
339 | ||
5c927015 RS |
340 | ;; Like replace-match, but overwrites. |
341 | (defun picture-replace-match (newtext fixedcase literal) | |
342 | (let (ocolumn change pos) | |
343 | (goto-char (setq pos (match-end 0))) | |
344 | (setq ocolumn (current-column)) | |
345 | ;; Make the replacement and undo it, to see how it changes the length. | |
346 | (let ((buffer-undo-list nil) | |
347 | list1) | |
348 | (replace-match newtext fixedcase literal) | |
349 | (setq change (- (current-column) ocolumn)) | |
350 | (setq list1 buffer-undo-list) | |
351 | (while list1 | |
352 | (setq list1 (primitive-undo 1 list1)))) | |
353 | (goto-char pos) | |
354 | (if (> change 0) | |
355 | (delete-region (point) | |
356 | (progn | |
d792910f | 357 | (move-to-column (+ change (current-column)) t) |
5c927015 RS |
358 | (point)))) |
359 | (replace-match newtext fixedcase literal) | |
360 | (if (< change 0) | |
a64dc04f | 361 | (insert-char ?\s (- change))))) |
695d13c7 BP |
362 | \f |
363 | ;; Picture Tabs | |
364 | ||
d1ebc62e | 365 | (defcustom picture-tab-chars "!-~" |
1fc7dabf | 366 | "A character set which controls behavior of commands. |
695d13c7 BP |
367 | \\[picture-set-tab-stops] and \\[picture-tab-search]. It is NOT a |
368 | regular expression, any regexp special characters will be quoted. | |
369 | It defines a set of \"interesting characters\" to look for when setting | |
370 | \(or searching for) tab stops, initially \"!-~\" (all printing characters). | |
371 | For example, suppose that you are editing a table which is formatted thus: | |
372 | | foo | bar + baz | 23 * | |
373 | | bubbles | and + etc | 97 * | |
374 | and that `picture-tab-chars' is \"|+*\". Then invoking | |
375 | \\[picture-set-tab-stops] on either of the previous lines would result | |
376 | in the following tab stops | |
377 | : : : : | |
378 | Another example - \"A-Za-z0-9\" would produce the tab stops | |
379 | : : : : | |
380 | ||
381 | Note that if you want the character `-' to be in the set, it must be | |
382 | included in a range or else appear in a context where it cannot be | |
383 | taken for indicating a range (e.g. \"-A-Z\" declares the set to be the | |
384 | letters `A' through `Z' and the character `-'). If you want the | |
385 | character `\\' in the set it must be preceded by itself: \"\\\\\". | |
386 | ||
387 | The command \\[picture-tab-search] is defined to move beneath (or to) a | |
d1ebc62e SE |
388 | character belonging to this set independent of the tab stops list." |
389 | :type 'string | |
390 | :group 'picture) | |
695d13c7 BP |
391 | |
392 | (defun picture-set-tab-stops (&optional arg) | |
393 | "Set value of `tab-stop-list' according to context of this line. | |
394 | This controls the behavior of \\[picture-tab]. A tab stop is set at | |
395 | every column occupied by an \"interesting character\" that is preceded | |
396 | by whitespace. Interesting characters are defined by the variable | |
397 | `picture-tab-chars', see its documentation for an example of usage. | |
398 | With ARG, just (re)set `tab-stop-list' to its default value. The tab | |
399 | stops computed are displayed in the minibuffer with `:' at each stop." | |
400 | (interactive "P") | |
401 | (save-excursion | |
402 | (let (tabs) | |
403 | (if arg | |
404 | (setq tabs (default-value 'tab-stop-list)) | |
405 | (let ((regexp (concat "[ \t]+[" (regexp-quote picture-tab-chars) "]"))) | |
406 | (beginning-of-line) | |
407 | (let ((bol (point))) | |
408 | (end-of-line) | |
409 | (while (re-search-backward regexp bol t) | |
410 | (skip-chars-forward " \t") | |
411 | (setq tabs (cons (current-column) tabs))) | |
412 | (if (null tabs) | |
55535639 | 413 | (error "No characters in set %s on this line" |
695d13c7 BP |
414 | (regexp-quote picture-tab-chars)))))) |
415 | (setq tab-stop-list tabs) | |
416 | (let ((blurb (make-string (1+ (nth (1- (length tabs)) tabs)) ?\ ))) | |
417 | (while tabs | |
418 | (aset blurb (car tabs) ?:) | |
419 | (setq tabs (cdr tabs))) | |
420 | (message blurb))))) | |
421 | ||
422 | (defun picture-tab-search (&optional arg) | |
423 | "Move to column beneath next interesting char in previous line. | |
424 | With ARG move to column occupied by next interesting character in this | |
425 | line. The character must be preceded by whitespace. | |
426 | \"interesting characters\" are defined by variable `picture-tab-chars'. | |
427 | If no such character is found, move to beginning of line." | |
428 | (interactive "P") | |
429 | (let ((target (current-column))) | |
430 | (save-excursion | |
431 | (if (and (not arg) | |
432 | (progn | |
433 | (beginning-of-line) | |
434 | (skip-chars-backward | |
435 | (concat "^" (regexp-quote picture-tab-chars)) | |
436 | (point-min)) | |
437 | (not (bobp)))) | |
438 | (move-to-column target)) | |
439 | (if (re-search-forward | |
440 | (concat "[ \t]+[" (regexp-quote picture-tab-chars) "]") | |
441 | (save-excursion (end-of-line) (point)) | |
442 | 'move) | |
443 | (setq target (1- (current-column))) | |
444 | (setq target nil))) | |
445 | (if target | |
d792910f | 446 | (move-to-column target t) |
695d13c7 BP |
447 | (beginning-of-line)))) |
448 | ||
449 | (defun picture-tab (&optional arg) | |
450 | "Tab transparently (just move point) to next tab stop. | |
451 | With prefix arg, overwrite the traversed text with spaces. The tab stop | |
452 | list can be changed by \\[picture-set-tab-stops] and \\[edit-tab-stops]. | |
453 | See also documentation for variable `picture-tab-chars'." | |
454 | (interactive "P") | |
455 | (let* ((opoint (point))) | |
456 | (move-to-tab-stop) | |
457 | (if arg | |
458 | (let (indent-tabs-mode | |
459 | (column (current-column))) | |
460 | (delete-region opoint (point)) | |
461 | (indent-to column))))) | |
462 | \f | |
463 | ;; Picture Rectangles | |
464 | ||
238b647a | 465 | (defvar picture-killed-rectangle nil |
695d13c7 BP |
466 | "Rectangle killed or copied by \\[picture-clear-rectangle] in Picture mode. |
467 | The contents can be retrieved by \\[picture-yank-rectangle]") | |
468 | ||
469 | (defun picture-clear-rectangle (start end &optional killp) | |
470 | "Clear and save rectangle delineated by point and mark. | |
471 | The rectangle is saved for yanking by \\[picture-yank-rectangle] and replaced | |
472 | with whitespace. The previously saved rectangle, if any, is lost. With | |
473 | prefix argument, the rectangle is actually killed, shifting remaining text." | |
474 | (interactive "r\nP") | |
475 | (setq picture-killed-rectangle (picture-snarf-rectangle start end killp))) | |
476 | ||
477 | (defun picture-clear-rectangle-to-register (start end register &optional killp) | |
478 | "Clear rectangle delineated by point and mark into REGISTER. | |
479 | The rectangle is saved in REGISTER and replaced with whitespace. With | |
480 | prefix argument, the rectangle is actually killed, shifting remaining text." | |
481 | (interactive "r\ncRectangle to register: \nP") | |
482 | (set-register register (picture-snarf-rectangle start end killp))) | |
483 | ||
484 | (defun picture-snarf-rectangle (start end &optional killp) | |
485 | (let ((column (current-column)) | |
486 | (indent-tabs-mode nil)) | |
487 | (prog1 (save-excursion | |
488 | (if killp | |
489 | (delete-extract-rectangle start end) | |
490 | (prog1 (extract-rectangle start end) | |
491 | (clear-rectangle start end)))) | |
d792910f | 492 | (move-to-column column t)))) |
695d13c7 BP |
493 | |
494 | (defun picture-yank-rectangle (&optional insertp) | |
495 | "Overlay rectangle saved by \\[picture-clear-rectangle] | |
496 | The rectangle is positioned with upper left corner at point, overwriting | |
497 | existing text. With prefix argument, the rectangle is inserted instead, | |
498 | shifting existing text. Leaves mark at one corner of rectangle and | |
499 | point at the other (diagonally opposed) corner." | |
500 | (interactive "P") | |
501 | (if (not (consp picture-killed-rectangle)) | |
55535639 | 502 | (error "No rectangle saved") |
695d13c7 BP |
503 | (picture-insert-rectangle picture-killed-rectangle insertp))) |
504 | ||
2ee658c3 RS |
505 | (defun picture-yank-at-click (click arg) |
506 | "Insert the last killed rectangle at the position clicked on. | |
507 | Also move point to one end of the text thus inserted (normally the end). | |
508 | Prefix arguments are interpreted as with \\[yank]. | |
509 | If `mouse-yank-at-point' is non-nil, insert at point | |
510 | regardless of where you click." | |
511 | (interactive "e\nP") | |
512 | (or mouse-yank-at-point (mouse-set-point click)) | |
513 | (picture-yank-rectangle arg)) | |
514 | ||
695d13c7 BP |
515 | (defun picture-yank-rectangle-from-register (register &optional insertp) |
516 | "Overlay rectangle saved in REGISTER. | |
517 | The rectangle is positioned with upper left corner at point, overwriting | |
518 | existing text. With prefix argument, the rectangle is | |
519 | inserted instead, shifting existing text. Leaves mark at one corner | |
520 | of rectangle and point at the other (diagonally opposed) corner." | |
521 | (interactive "cRectangle from register: \nP") | |
522 | (let ((rectangle (get-register register))) | |
523 | (if (not (consp rectangle)) | |
55535639 | 524 | (error "Register %c does not contain a rectangle" register) |
695d13c7 BP |
525 | (picture-insert-rectangle rectangle insertp)))) |
526 | ||
527 | (defun picture-insert-rectangle (rectangle &optional insertp) | |
528 | "Overlay RECTANGLE with upper left corner at point. | |
529 | Optional argument INSERTP, if non-nil causes RECTANGLE to be inserted. | |
530 | Leaves the region surrounding the rectangle." | |
531 | (let ((indent-tabs-mode nil)) | |
532 | (if (not insertp) | |
533 | (save-excursion | |
534 | (delete-rectangle (point) | |
535 | (progn | |
536 | (picture-forward-column (length (car rectangle))) | |
537 | (picture-move-down (1- (length rectangle))) | |
538 | (point))))) | |
539 | (push-mark) | |
540 | (insert-rectangle rectangle))) | |
541 | ||
d792910f RS |
542 | (defun picture-current-line () |
543 | "Return the vertical position of point. Top line is 1." | |
544 | (+ (count-lines (point-min) (point)) | |
545 | (if (= (current-column) 0) 1 0))) | |
546 | ||
547 | (defun picture-draw-rectangle (start end) | |
548 | "Draw a rectangle around region." | |
549 | (interactive "*r") ; start will be less than end | |
550 | (let* ((sl (picture-current-line)) | |
551 | (sc (current-column)) | |
552 | (pvs picture-vertical-step) | |
553 | (phs picture-horizontal-step) | |
554 | (c1 (progn (goto-char start) (current-column))) | |
555 | (r1 (picture-current-line)) | |
556 | (c2 (progn (goto-char end) (current-column))) | |
557 | (r2 (picture-current-line)) | |
558 | (right (max c1 c2)) | |
559 | (left (min c1 c2)) | |
560 | (top (min r1 r2)) | |
561 | (bottom (max r1 r2))) | |
e6ce8c42 GM |
562 | (goto-char (point-min)) |
563 | (forward-line (1- top)) | |
5ed5b2c2 | 564 | (move-to-column left t) |
2697c1f3 | 565 | (picture-update-desired-column t) |
d792910f RS |
566 | |
567 | (picture-movement-right) | |
568 | (picture-insert picture-rectangle-ctl 1) | |
2697c1f3 | 569 | (picture-insert picture-rectangle-h (- right picture-desired-column)) |
d792910f RS |
570 | |
571 | (picture-movement-down) | |
572 | (picture-insert picture-rectangle-ctr 1) | |
573 | (picture-insert picture-rectangle-v (- bottom (picture-current-line))) | |
574 | ||
575 | (picture-movement-left) | |
576 | (picture-insert picture-rectangle-cbr 1) | |
2697c1f3 | 577 | (picture-insert picture-rectangle-h (- picture-desired-column left)) |
d792910f RS |
578 | |
579 | (picture-movement-up) | |
580 | (picture-insert picture-rectangle-cbl 1) | |
581 | (picture-insert picture-rectangle-v (- (picture-current-line) top)) | |
582 | ||
583 | (picture-set-motion pvs phs) | |
e6ce8c42 GM |
584 | (goto-char (point-min)) |
585 | (forward-line (1- sl)) | |
d792910f RS |
586 | (move-to-column sc t))) |
587 | ||
695d13c7 BP |
588 | \f |
589 | ;; Picture Keymap, entry and exit points. | |
590 | ||
2137e978 | 591 | (defvar picture-mode-map nil) |
695d13c7 | 592 | |
ca9c7579 | 593 | (defun picture-substitute (oldfun newfun) |
e70cccc0 | 594 | (define-key picture-mode-map (vector 'remap oldfun) newfun)) |
ca9c7579 | 595 | |
695d13c7 | 596 | (if (not picture-mode-map) |
0ad0f28f | 597 | (progn |
2697c1f3 | 598 | (setq picture-mode-map (make-keymap)) |
0ad0f28f | 599 | (picture-substitute 'self-insert-command 'picture-self-insert) |
2ae00b00 RS |
600 | (picture-substitute 'completion-separator-self-insert-command |
601 | 'picture-self-insert) | |
602 | (picture-substitute 'completion-separator-self-insert-autofilling | |
603 | 'picture-self-insert) | |
ca9c7579 ER |
604 | (picture-substitute 'forward-char 'picture-forward-column) |
605 | (picture-substitute 'backward-char 'picture-backward-column) | |
606 | (picture-substitute 'delete-char 'picture-clear-column) | |
47bad81c | 607 | ;; There are two possibilities for what is normally on DEL. |
ca9c7579 | 608 | (picture-substitute 'backward-delete-char-untabify 'picture-backward-clear-column) |
47bad81c | 609 | (picture-substitute 'delete-backward-char 'picture-backward-clear-column) |
ca9c7579 ER |
610 | (picture-substitute 'kill-line 'picture-clear-line) |
611 | (picture-substitute 'open-line 'picture-open-line) | |
612 | (picture-substitute 'newline 'picture-newline) | |
0ad0f28f | 613 | (picture-substitute 'newline-and-indent 'picture-duplicate-line) |
ca9c7579 ER |
614 | (picture-substitute 'next-line 'picture-move-down) |
615 | (picture-substitute 'previous-line 'picture-move-up) | |
616 | (picture-substitute 'beginning-of-line 'picture-beginning-of-line) | |
617 | (picture-substitute 'end-of-line 'picture-end-of-line) | |
15693bc3 | 618 | (picture-substitute 'mouse-set-point 'picture-mouse-set-point) |
ca9c7579 | 619 | |
695d13c7 | 620 | (define-key picture-mode-map "\C-c\C-d" 'delete-char) |
695d13c7 BP |
621 | (define-key picture-mode-map "\e\t" 'picture-toggle-tab-state) |
622 | (define-key picture-mode-map "\t" 'picture-tab) | |
623 | (define-key picture-mode-map "\e\t" 'picture-tab-search) | |
624 | (define-key picture-mode-map "\C-c\t" 'picture-set-tab-stops) | |
625 | (define-key picture-mode-map "\C-c\C-k" 'picture-clear-rectangle) | |
626 | (define-key picture-mode-map "\C-c\C-w" 'picture-clear-rectangle-to-register) | |
627 | (define-key picture-mode-map "\C-c\C-y" 'picture-yank-rectangle) | |
628 | (define-key picture-mode-map "\C-c\C-x" 'picture-yank-rectangle-from-register) | |
d792910f | 629 | (define-key picture-mode-map "\C-c\C-r" 'picture-draw-rectangle) |
695d13c7 BP |
630 | (define-key picture-mode-map "\C-c\C-c" 'picture-mode-exit) |
631 | (define-key picture-mode-map "\C-c\C-f" 'picture-motion) | |
632 | (define-key picture-mode-map "\C-c\C-b" 'picture-motion-reverse) | |
633 | (define-key picture-mode-map "\C-c<" 'picture-movement-left) | |
634 | (define-key picture-mode-map "\C-c>" 'picture-movement-right) | |
635 | (define-key picture-mode-map "\C-c^" 'picture-movement-up) | |
636 | (define-key picture-mode-map "\C-c." 'picture-movement-down) | |
637 | (define-key picture-mode-map "\C-c`" 'picture-movement-nw) | |
638 | (define-key picture-mode-map "\C-c'" 'picture-movement-ne) | |
639 | (define-key picture-mode-map "\C-c/" 'picture-movement-sw) | |
ffe2923b JL |
640 | (define-key picture-mode-map "\C-c\\" 'picture-movement-se) |
641 | (define-key picture-mode-map [(control ?c) left] 'picture-movement-left) | |
642 | (define-key picture-mode-map [(control ?c) right] 'picture-movement-right) | |
643 | (define-key picture-mode-map [(control ?c) up] 'picture-movement-up) | |
644 | (define-key picture-mode-map [(control ?c) down] 'picture-movement-down) | |
645 | (define-key picture-mode-map [(control ?c) home] 'picture-movement-nw) | |
646 | (define-key picture-mode-map [(control ?c) prior] 'picture-movement-ne) | |
647 | (define-key picture-mode-map [(control ?c) end] 'picture-movement-sw) | |
648 | (define-key picture-mode-map [(control ?c) next] 'picture-movement-se))) | |
695d13c7 | 649 | |
d1ebc62e | 650 | (defcustom picture-mode-hook nil |
ca9c7579 | 651 | "If non-nil, its value is called on entry to Picture mode. |
d1ebc62e SE |
652 | Picture mode is invoked by the command \\[picture-mode]." |
653 | :type 'hook | |
654 | :group 'picture) | |
695d13c7 | 655 | |
c4fc49b6 RS |
656 | (defvar picture-mode-old-local-map) |
657 | (defvar picture-mode-old-mode-name) | |
658 | (defvar picture-mode-old-major-mode) | |
b9911289 | 659 | (defvar picture-mode-old-truncate-lines) |
c4fc49b6 | 660 | |
7229064d | 661 | ;;;###autoload |
ca9c7579 | 662 | (defun picture-mode () |
695d13c7 | 663 | "Switch to Picture mode, in which a quarter-plane screen model is used. |
1aa545c1 | 664 | \\<picture-mode-map> |
695d13c7 BP |
665 | Printing characters replace instead of inserting themselves with motion |
666 | afterwards settable by these commands: | |
1aa545c1 CY |
667 | |
668 | Move left after insertion: \\[picture-movement-left] | |
669 | Move right after insertion: \\[picture-movement-right] | |
670 | Move up after insertion: \\[picture-movement-up] | |
671 | Move down after insertion: \\[picture-movement-down] | |
672 | ||
673 | Move northwest (nw) after insertion: \\[picture-movement-nw] | |
674 | Move northeast (ne) after insertion: \\[picture-movement-ne] | |
675 | Move southwest (sw) after insertion: \\[picture-movement-sw] | |
676 | Move southeast (se) after insertion: \\[picture-movement-se] | |
677 | ||
678 | Move westnorthwest (wnw) after insertion: C-u \\[picture-movement-nw] | |
679 | Move eastnortheast (ene) after insertion: C-u \\[picture-movement-ne] | |
680 | Move westsouthwest (wsw) after insertion: C-u \\[picture-movement-sw] | |
681 | Move eastsoutheast (ese) after insertion: C-u \\[picture-movement-se] | |
682 | ||
695d13c7 BP |
683 | The current direction is displayed in the mode line. The initial |
684 | direction is right. Whitespace is inserted and tabs are changed to | |
685 | spaces when required by movement. You can move around in the buffer | |
686 | with these commands: | |
1aa545c1 CY |
687 | |
688 | Move vertically to SAME column in previous line: \\[picture-move-down] | |
689 | Move vertically to SAME column in next line: \\[picture-move-up] | |
690 | Move to column following last | |
691 | non-whitespace character: \\[picture-end-of-line] | |
692 | Move right, inserting spaces if required: \\[picture-forward-column] | |
693 | Move left changing tabs to spaces if required: \\[picture-backward-column] | |
694 | Move in direction of current picture motion: \\[picture-motion] | |
695 | Move opposite to current picture motion: \\[picture-motion-reverse] | |
696 | Move to beginning of next line: \\[next-line] | |
697 | ||
695d13c7 | 698 | You can edit tabular text with these commands: |
1aa545c1 CY |
699 | |
700 | Move to column beneath (or at) next interesting | |
701 | character (see variable `picture-tab-chars'): \\[picture-tab-search] | |
702 | Move to next stop in tab stop list: \\[picture-tab] | |
703 | Set tab stops according to context of this line: \\[picture-set-tab-stops] | |
704 | (With ARG, resets tab stops to default value.) | |
705 | Change the tab stop list: \\[edit-tab-stops] | |
706 | ||
695d13c7 | 707 | You can manipulate text with these commands: |
1aa545c1 CY |
708 | Clear ARG columns after point without moving: \\[picture-clear-column] |
709 | Delete char at point: \\[delete-char] | |
710 | Clear ARG columns backward: \\[picture-backward-clear-column] | |
711 | Clear ARG lines, advancing over them: \\[picture-clear-line] | |
712 | (the cleared text is saved in the kill ring) | |
713 | Open blank line(s) beneath current line: \\[picture-open-line] | |
714 | ||
695d13c7 | 715 | You can manipulate rectangles with these commands: |
1aa545c1 CY |
716 | Clear a rectangle and save it: \\[picture-clear-rectangle] |
717 | Clear a rectangle, saving in a named register: \\[picture-clear-rectangle-to-register] | |
718 | Insert currently saved rectangle at point: \\[picture-yank-rectangle] | |
719 | Insert rectangle from named register: \\[picture-yank-rectangle-from-register] | |
720 | Draw a rectangular box around mark and point: \\[picture-draw-rectangle] | |
721 | Copies a rectangle to a register: \\[copy-rectangle-to-register] | |
8cb95edf | 722 | Undo effects of rectangle overlay commands: \\[undo] |
1aa545c1 CY |
723 | |
724 | You can return to the previous mode with \\[picture-mode-exit], which | |
725 | also strips trailing whitespace from every line. Stripping is suppressed | |
726 | by supplying an argument. | |
695d13c7 | 727 | |
e444e0d6 | 728 | Entry to this mode calls the value of `picture-mode-hook' if non-nil. |
695d13c7 BP |
729 | |
730 | Note that Picture mode commands will work outside of Picture mode, but | |
731 | they are not defaultly assigned to keys." | |
732 | (interactive) | |
ca9c7579 | 733 | (if (eq major-mode 'picture-mode) |
55535639 | 734 | (error "You are already editing a picture") |
e444e0d6 | 735 | (set (make-local-variable 'picture-mode-old-local-map) (current-local-map)) |
695d13c7 | 736 | (use-local-map picture-mode-map) |
e444e0d6 SM |
737 | (set (make-local-variable 'picture-mode-old-mode-name) mode-name) |
738 | (set (make-local-variable 'picture-mode-old-major-mode) major-mode) | |
ca9c7579 | 739 | (setq major-mode 'picture-mode) |
e444e0d6 SM |
740 | (set (make-local-variable 'picture-killed-rectangle) nil) |
741 | (set (make-local-variable 'tab-stop-list) (default-value 'tab-stop-list)) | |
742 | (set (make-local-variable 'picture-tab-chars) | |
743 | (default-value 'picture-tab-chars)) | |
695d13c7 BP |
744 | (make-local-variable 'picture-vertical-step) |
745 | (make-local-variable 'picture-horizontal-step) | |
e444e0d6 | 746 | (set (make-local-variable 'picture-mode-old-truncate-lines) truncate-lines) |
ca9c7579 | 747 | (setq truncate-lines t) |
695d13c7 | 748 | (picture-set-motion 0 1) |
ca9c7579 | 749 | |
e0dad66e RS |
750 | ;; edit-picture-hook is what we used to run, picture-mode-hook is in doc. |
751 | (run-hooks 'edit-picture-hook 'picture-mode-hook) | |
d55235bb KH |
752 | (message "Type %s in this buffer to return it to %s mode." |
753 | (substitute-command-keys "\\[picture-mode-exit]") | |
754 | picture-mode-old-mode-name))) | |
695d13c7 | 755 | |
6503cec3 | 756 | ;;;###autoload |
ca9c7579 | 757 | (defalias 'edit-picture 'picture-mode) |
695d13c7 BP |
758 | |
759 | (defun picture-mode-exit (&optional nostrip) | |
2137e978 | 760 | "Undo `picture-mode' and return to previous major mode. |
8803c4f4 RS |
761 | With no argument, strip whitespace from end of every line in Picture buffer; |
762 | otherwise, just return to previous mode. | |
763 | Runs `picture-mode-exit-hook' at the end." | |
695d13c7 | 764 | (interactive "P") |
ca9c7579 | 765 | (if (not (eq major-mode 'picture-mode)) |
55535639 | 766 | (error "You aren't editing a Picture") |
eaae8106 | 767 | (if (not nostrip) (delete-trailing-whitespace)) |
695d13c7 BP |
768 | (setq mode-name picture-mode-old-mode-name) |
769 | (use-local-map picture-mode-old-local-map) | |
770 | (setq major-mode picture-mode-old-major-mode) | |
771 | (kill-local-variable 'tab-stop-list) | |
b9911289 | 772 | (setq truncate-lines picture-mode-old-truncate-lines) |
8803c4f4 RS |
773 | (force-mode-line-update) |
774 | (run-hooks 'picture-mode-exit-hook))) | |
695d13c7 | 775 | |
49116ac0 JB |
776 | (provide 'picture) |
777 | ||
cbee283d | 778 | ;; arch-tag: e452d08d-a470-4fbf-896e-ea276698d1ca |
6594deb0 | 779 | ;;; picture.el ends here |