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