* textmodes/artist.el (artist-system): Allow make-temp-file to use
[bpt/emacs.git] / lisp / textmodes / artist.el
CommitLineData
b95b34e5
GM
1;;; artist.el --- draw ascii graphics with your mouse
2
3731a850 3;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
ae940284 4;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
b95b34e5
GM
5
6;; Author: Tomas Abrahamsson <tab@lysator.liu.se>
7;; Maintainer: Tomas Abrahamsson <tab@lysator.liu.se>
8;; Keywords: mouse
9d8b0f9c
RS
9;; Version: 1.2.6
10;; Release-date: 6-Aug-2004
b95b34e5
GM
11;; Location: http://www.lysator.liu.se/~tab/artist/
12
241760a3
SM
13;; Yoni Rabkin <yoni@rabkins.net> contacted the maintainer of this
14;; file on 19/3/2008, and the maintainer agreed that when a bug is filed in
15;; the Emacs bug reporting system against this file, a copy of the bug
16;; report be sent to the maintainer's email address.
17
b95b34e5
GM
18;; This file is part of GNU Emacs.
19
1fecc8fe 20;; GNU Emacs is free software: you can redistribute it and/or modify
b95b34e5 21;; it under the terms of the GNU General Public License as published by
1fecc8fe
GM
22;; the Free Software Foundation, either version 3 of the License, or
23;; (at your option) any later version.
b95b34e5
GM
24
25;; GNU Emacs is distributed in the hope that it will be useful,
26;; but WITHOUT ANY WARRANTY; without even the implied warranty of
27;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28;; GNU General Public License for more details.
29
30;; You should have received a copy of the GNU General Public License
1fecc8fe 31;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
b95b34e5
GM
32
33;;; Commentary:
34
35;; What is artist?
36;; ---------------
37;;
38;; Artist is an Emacs lisp package that allows you to draw lines,
b27a51db 39;; rectangles and ellipses by using your mouse and/or keyboard. The
b95b34e5
GM
40;; shapes are made up with the ascii characters |, -, / and \.
41;;
42;; Features are:
43;;
44;; * Intersecting: When a `|' intersects with a `-', a `+' is
45;; drawn, like this: | \ /
46;; --+-- X
47;; | / \
48;;
49;; * Rubber-banding: When drawing lines you can interactively see the
50;; result while holding the mouse button down and moving the mouse. If
51;; your machine is not fast enough (a 386 is a bit to slow, but a
52;; pentium is well enough), you can turn this feature off. You will
53;; then see 1's and 2's which mark the 1st and 2nd endpoint of the line
54;; you are drawing.
55;;
56;; * Drawing operations: The following drawing operations are implemented:
57;;
58;; lines straight-lines
59;; rectangles squares
60;; poly-lines straight poly-lines
61;; ellipses circles
62;; text (see-thru) text (overwrite)
63;; spray-can setting size for spraying
64;; vaporize line vaporize lines
65;; erase characters erase rectangles
66;;
67;; Straight lines are lines that go horizontally, vertically or
b27a51db 68;; diagonally. Plain lines go in any direction. The operations in
b95b34e5
GM
69;; the right column are accessed by holding down the shift key while
70;; drawing.
71;;
72;; It is possible to vaporize (erase) entire lines and connected lines
73;; (rectangles for example) as long as the lines being vaporized are
b27a51db 74;; straight and connected at their endpoints. Vaporizing is inspired
b95b34e5
GM
75;; by the drawrect package by Jari Aalto <jari.aalto@poboxes.com>.
76;;
77;; * Flood-filling: You can fill any area with a certain character by
78;; flood-filling.
79;;
80;; * Cut copy and paste: You can cut, copy and paste rectangular
b27a51db 81;; regions. Artist also interfaces with the rect package (this can be
b95b34e5
GM
82;; turned off if it causes you any trouble) so anything you cut in
83;; artist can be yanked with C-x r y and vice versa.
84;;
85;; * Drawing with keys: Everything you can do with the mouse, you can
86;; also do without the mouse.
87;;
88;; * Arrows: After having drawn a (straight) line or a (straight)
89;; poly-line, you can set arrows on the line-ends by typing < or >.
90;;
91;; * Aspect-ratio: You can set the variable artist-aspect-ratio to
b27a51db 92;; reflect the height-width ratio for the font you are using. Squares
b95b34e5
GM
93;; and circles are then drawn square/round. Note, that once your
94;; ascii-file is shown with font with a different height-width ratio,
95;; the squares won't be square and the circles won't be round.
96;;
97;; * Picture mode compatibility: Artist is picture mode compatible (this
98;; can be turned off).
99;;
100;; See the documentation for the function artist-mode for a detailed
101;; description on how to use artist.
102;;
103;;
104;; What about adding my own drawing modes?
105;; ---------------------------------------
106;;
107;; See the short guide at the end of this file.
108;; If you add a new drawing mode, send it to me, and I would gladly
109;; include in the next release!
110
b95b34e5
GM
111;;; Installation:
112
113;; To use artist, put this in your .emacs:
114;;
115;; (autoload 'artist-mode "artist" "Enter artist-mode" t)
116
117
118;;; Requirements:
119
120;; Artist requires Emacs 19.28 or higher.
121;;
122;; Artist requires the `rect' package (which comes with Emacs) to be
123;; loadable, unless the variable `artist-interface-with-rect' is set
124;; to nil.
125;;
126;; Artist also requires the Picture mode (which also comes with Emacs)
127;; to be loadable, unless the variable `artist-picture-compatibility'
128;; is set to nil.
129
130;;; Known bugs:
131
132;; The shifted operations are not available when drawing with the mouse
133;; in Emacs 19.29 and 19.30.
134;;
135;; It is not possible to change between shifted and unshifted operation
136;; while drawing with the mouse. (See the comment in the function
137;; artist-shift-has-changed for further details.)
138
139
140;;; ChangeLog:
141
9d8b0f9c
RS
142;; 1.2.6 6-Aug-2004
143;; New: Coerced with the artist.el that's in Emacs-21.3.
144;; (minor editorial changes)
145;;
146;; 1.2.5 4-Aug-2004
147;; New: Added tool selection via the mouse-wheel
148;; Function provided by Andreas Leue <al@sphenon.de>
149;;
63db25ed
GM
150;; 1.2.4 25-Oct-2001
151;; Bugfix: Some operations (the edit menu) got hidden
152;; Bugfix: The first arrow for poly-lines was always pointing
153;; to the right
154;; Changed: Updated with changes made for Emacs 21.1
155;;
156;; 1.2.3 20-Nov-2000
157;; Bugfix: Autoload cookie corrected
158;;
b95b34e5
GM
159;; 1.2.2 19-Nov-2000
160;; Changed: More documentation fixes.
a9645a66 161;; Bugfix: The arrow characters (`artist-arrows'), which
b95b34e5
GM
162;; got wrong in 1.1, are now corrected.
163;;
164;; 1.2.1 15-Nov-2000
165;; New: Documentation fixes.
166;; Bugfix: Sets next-line-add-newlines to t while in artist-mode.
167;; Drawing with keys was confusing without this fix, if
168;; next-line-add-newlines was set to nil.
169;; Thanks to Tatsuo Furukawa <tatsuo@kobe.hp.com> for this.
170;;
171;; 1.2 22-Oct-2000
172;; New: Updated to work with Emacs 21
173;;
174;; 1.1 15-Aug-2000
175;; Bugfix: Cursor follows mouse pointer more closely.
176;; New: Works with Emacs 20.x
177;; New: Variables are customizable
178;;
179;; 1.1-beta1 21-Apr-1998
180;; New: Spray-can (Utterly useless, I believe, but it was fun
181;; to implement :-) after an idea by Karl-Johan Karlsson
182;; <kj@lysator.liu.se>.
183;; New: Freehand drawing (with pen).
184;; New: Vaporizing lines.
185;; New: Text-rendering using figlet.
186;; New: Picture mode compatibility.
187;; Changed: All Artist keys now uses the prefix C-c C-a not to conflict
188;; with Picture mode.
189;; Bugfix: No longer leaves traces of lines when rubberbanding
190;; if the buffer auto-scrolls.
191;; Bugfix: Infinite loop sometimes when rubberbanding was turned
192;; off.
193;;
194;; 1.0 01-Mar-1998
195;; First official release.
196
197;;; Code:
198
199;; Variables
200
9d8b0f9c 201(defconst artist-version "1.2.6")
b95b34e5
GM
202(defconst artist-maintainer-address "tab@lysator.liu.se")
203
fe6e86db 204(defvar x-pointer-crosshair)
b95b34e5 205
b95b34e5
GM
206;; User options
207;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
208
209(defgroup artist nil
210 "Customization of the Artist mode."
211 :group 'mouse)
212
213(defgroup artist-text nil
214 "Customization of the text rendering."
215 :group 'artist)
216
217(defcustom artist-rubber-banding t
218 "Interactively do rubber-banding when non-nil."
219 :group 'artist
220 :type 'boolean)
221
222(defcustom artist-first-char ?1
223 "Character to set at first point when not rubber-banding."
224 :group 'artist
225 :type 'character)
226
227(defcustom artist-second-char ?2
228 "Character to set at second point when not rubber-banding."
229 :group 'artist
230 :type 'character)
231
232(defcustom artist-interface-with-rect t
233 "Whether to interface with the rect package or not.
234
235Interfacing to the rect package means that the Copy and Paste operations
236will use the rectangle buffer when accessing the copied area. This means
237that you can insert a rectangle which is copied using the artist package
238and vice versa.
239
240If this causes any problem for you (for example, if the implementation of
241the rectangle package changes), you can set this variable to nil, and the
242artist package will use its own copy buffer."
243 :group 'artist
244 :type 'boolean)
245
246(defvar artist-arrows [ ?> nil ?v ?L ?< nil ?^ nil ]
247 ;; This is a defvar, not a defcustom, since the custom
248 ;; package shows vectors of characters as a vector of integers,
249 ;; which is confusing
250 "A vector of characters to use as arrows.
251
252The vector is 8 elements long and contains a character for each
253direction, or nil if there is no suitable character to use for arrow
254in that direction.
255
256The directions are as follows:
257
258 5 6 7
259 \\ | /
260 4 - * - 0
261 / | \\
262 3 2 1")
263
264(defcustom artist-aspect-ratio 1
265 "Defines the character height-to-width aspect ratio.
98d92ce3 266This is used when drawing squares and circles."
b95b34e5
GM
267 :group 'artist
268 :type 'number)
269
270(defcustom artist-trim-line-endings t
271 "Whether or not to remove white-space at end of lines.
272
273If non-nil, line-endings are trimmed (that is, extraneous white-space
274at the end of the line is removed) when the shape is drawn."
275 :group 'artist
276 :type 'boolean)
277
278
279(defcustom artist-flood-fill-right-border 'window-width
280 "Right edge definition, used when flood-filling.
281
282When flood-filling, if the area is not closed off to the right, then
283flood-filling will fill no more to the right than specified by this
284variable. This limit is called the fill-border."
285 :group 'artist
286 :type '(choice (const :tag "limited to window" window-width)
287 (const :tag "limited to value of `fill-column'" fill-column)))
288
289(defcustom artist-flood-fill-show-incrementally t
290 "Whether or not to incrementally update display when flood-filling.
291
292If non-nil, incrementally update display when flood-filling.
293If set to non-nil, this currently implies discarding any input events
294during the flood-fill."
295 :group 'artist
296 :type 'boolean)
297
298
299(defcustom artist-ellipse-right-char ?\)
300 "Character to use at the rightmost position when drawing narrow ellipses.
301
302In this figure, it is the right parenthesis (the ``)'' character):
303 -----
304 ( )
305 -----"
306 :group 'artist
307 :type 'character)
308
309
310(defcustom artist-ellipse-left-char ?\(
311 "Character to use at the leftmost position when drawing narrow ellipses.
312
313In this figure, it is the left parenthesis (the ``('' character):
314 -----
315 ( )
316 -----"
317 :group 'artist
318 :type 'character)
319
320(defcustom artist-picture-compatibility t
321 "Whether or not picture mode compatibility is on."
322 :group 'artist
323 :type 'boolean)
324
325
326
327
328(defcustom artist-vaporize-fuzziness 1
329 "How to vaporize lines that are cut off.
330
331Accept this many characters cutting off a line and still treat
332it as one line.
333Example:
334 If `artist-vaporize-fuzziness' is 2, then those will be recognized as
335 lines from A to B (provided you start vaporizing them at the ``*''):
336 /
337 A----*------/-----------B
338 \\/
339 A----*----/\\------------B
340 / \\
341
342 but this one won't, since it is cut off by more than 2 characters:
343 \\/ /
344 A----*----/\\/----------B
345 / /\\
98d92ce3
JB
346 (in fact, only the left part [between the A and the leftmost ``/''
347 crossing the line] will be vaporized)."
b95b34e5
GM
348 :group 'artist
349 :type 'integer)
350
351
352(defvar artist-pointer-shape (if (eq window-system 'x) x-pointer-crosshair nil)
353 "*If in X Windows, use this pointer shape while drawing with the mouse.")
354
355
f904adbb 356(defcustom artist-text-renderer-function 'artist-figlet
b95b34e5
GM
357 "Function for doing text rendering."
358 :group 'artist-text
359 :type 'symbol)
f904adbb 360(defvaralias 'artist-text-renderer 'artist-text-renderer-function)
b95b34e5
GM
361
362
363(defcustom artist-figlet-program "figlet"
364 "Program to run for `figlet'."
365 :group 'artist-text
366 :type 'string)
367
368
369(defcustom artist-figlet-default-font "standard"
370 "Default font for `figlet'."
371 :group 'artist-text
372 :type 'string)
373
374
375(defcustom artist-figlet-list-fonts-command
376 ;; list files ending with *.flf in any directory printed by the
377 ;; ``figlet -I2'' command. I think this will not produce more than
378 ;; one directory, but it never hurts to be on the safe side...
379 "for dir in `figlet -I2`; do cd $dir; ls *.flf; done"
380 "Command to run to get list of available fonts."
381 :group 'artist-text
382 :type 'string)
383
384
385(defcustom artist-spray-interval 0.2
386 "Number of seconds between repeated spraying."
387 :group 'artist
388 :type 'number)
389
390
391(defcustom artist-spray-radius 4
392 "Size of the area for spraying."
393 :group 'artist
394 :type 'integer)
395
396
fe6e86db 397(defvar artist-spray-chars '(?\s ?. ?- ?+ ?m ?% ?* ?#)
b95b34e5
GM
398 ;; This is a defvar, not a defcustom, since the custom
399 ;; package shows lists of characters as a lists of integers,
400 ;; which is confusing
401 "*Characters (``color'') to use when spraying.
98d92ce3
JB
402They should be ordered from the ``lightest'' to the ``heaviest''
403since spraying replaces a light character with the next heavier one.")
b95b34e5
GM
404
405
406(defvar artist-spray-new-char ?.
407 "*Initial character to use when spraying.
98d92ce3
JB
408This character is used if spraying upon a character that is not in
409`artist-spray-chars'. The character defined by this variable should
410be in `artist-spray-chars', or spraying will behave strangely.")
b95b34e5
GM
411
412
413;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
414;; End of user options
415
416
417;; Internal variables
418;;
419(defvar artist-mode nil
420 "Non-nil to enable `artist-mode' and nil to disable.")
421(make-variable-buffer-local 'artist-mode)
422
423(defvar artist-mode-name " Artist"
98d92ce3 424 "Name of Artist mode beginning with a space (appears in the mode-line).")
b95b34e5
GM
425
426(defvar artist-curr-go 'pen-char
427 "Current selected graphics operation.")
428(make-variable-buffer-local 'artist-curr-go)
429
430(defvar artist-line-char-set nil
431 "Boolean to tell whether user has set some char to use when drawing lines.")
432(make-variable-buffer-local 'artist-line-char-set)
433
434(defvar artist-line-char nil
435 "Char to use when drawing lines.")
436(make-variable-buffer-local 'artist-line-char)
437
438(defvar artist-fill-char-set nil
439 "Boolean to tell whether user has set some char to use when filling.")
440(make-variable-buffer-local 'artist-fill-char-set)
441
442(defvar artist-fill-char nil
443 "Char to use when filling.")
444(make-variable-buffer-local 'artist-fill-char)
445
177f7c51 446(defvar artist-erase-char ?\s
b95b34e5
GM
447 "Char to use when erasing.")
448(make-variable-buffer-local 'artist-erase-char)
449
450(defvar artist-default-fill-char ?.
451 "Char to use when a fill-char is required but none is set.")
452(make-variable-buffer-local 'artist-default-fill-char)
453
454; This variable is not buffer local
455(defvar artist-copy-buffer nil
456 "Copy buffer.")
457
458(defvar artist-draw-region-min-y 0
459 "Line-number for top-most visited line for draw operation.")
460(make-variable-buffer-local 'artist-draw-region-min-y)
461
462(defvar artist-draw-region-max-y 0
463 "Line-number for bottom-most visited line for draw operation.")
464(make-variable-buffer-local 'artist-draw-region-max-y)
465
466(defvar artist-borderless-shapes nil
467 "When non-nil, draw shapes without border.
468The fill char is used instead, if it is set.")
469(make-variable-buffer-local 'artist-borderless-shapes)
470
9d8b0f9c
RS
471(defvar artist-prev-next-op-alist nil
472 "Assoc list for looking up next and/or previous draw operation.
473The structure is as follows: (OP . (PREV-OP . NEXT-OP))
474where the elements are as follows:
475* OP is an atom: the KEY-SYMBOL in the `artist-mt' structure
476* PREV-OP and NEXT-OP are strings: the KEYWORD in the `artist-mt' structure
477
98d92ce3 478This variable is initialized by the `artist-make-prev-next-op-alist' function.")
b95b34e5
GM
479
480(eval-when-compile
481 ;; Make rect available at compile-time
482 (require 'rect) ; for interfacing with rect
483 (require 'reporter) ; the bug-reporting tool
484 (require 'picture)) ; picture mode compatibility
485
486(if artist-interface-with-rect
487 (require 'rect))
488
489(require 'reporter)
490
491(if artist-picture-compatibility
492 (require 'picture))
493
44ee3fee
RS
494;; Variables that are made local in artist-mode-init
495(defvar artist-key-is-drawing nil)
496(defvar artist-key-endpoint1 nil)
497(defvar artist-key-poly-point-list nil)
498(defvar artist-key-shape nil)
499(defvar artist-key-draw-how nil)
500(defvar artist-popup-menu-table nil)
501(defvar artist-key-compl-table nil)
502(defvar artist-rb-save-data nil)
503(defvar artist-arrow-point-1 nil)
504(defvar artist-arrow-point-2 nil)
505\f
b95b34e5
GM
506(defvar artist-mode-map
507 (let ((map (make-sparse-keymap)))
508 (setq artist-mode-map (make-sparse-keymap))
509 (define-key map [down-mouse-1] 'artist-down-mouse-1)
510 (define-key map [S-down-mouse-1] 'artist-down-mouse-1)
511 (define-key map [down-mouse-2] 'artist-mouse-choose-operation)
512 (define-key map [S-down-mouse-2] 'artist-mouse-choose-operation)
513 (define-key map [down-mouse-3] 'artist-down-mouse-3)
514 (define-key map [S-down-mouse-3] 'artist-down-mouse-3)
9d8b0f9c
RS
515 (define-key map [C-mouse-4] 'artist-select-prev-op-in-list)
516 (define-key map [C-mouse-5] 'artist-select-next-op-in-list)
b95b34e5
GM
517 (define-key map "\r" 'artist-key-set-point) ; return
518 (define-key map [up] 'artist-previous-line)
519 (define-key map "\C-p" 'artist-previous-line)
520 (define-key map [down] 'artist-next-line)
521 (define-key map "\C-n" 'artist-next-line)
522 (define-key map [left] 'artist-backward-char)
523 (define-key map "\C-b" 'artist-backward-char)
524 (define-key map [right] 'artist-forward-char)
525 (define-key map "\C-f" 'artist-forward-char)
526 (define-key map "<" 'artist-toggle-first-arrow)
527 (define-key map ">" 'artist-toggle-second-arrow)
528 (define-key map "\C-c\C-a\C-e" 'artist-select-erase-char)
529 (define-key map "\C-c\C-a\C-f" 'artist-select-fill-char)
530 (define-key map "\C-c\C-a\C-l" 'artist-select-line-char)
531 (define-key map "\C-c\C-a\C-o" 'artist-select-operation)
532 (define-key map "\C-c\C-a\C-r" 'artist-toggle-rubber-banding)
533 (define-key map "\C-c\C-a\C-t" 'artist-toggle-trim-line-endings)
534 (define-key map "\C-c\C-a\C-s" 'artist-toggle-borderless-shapes)
535 (define-key map "\C-c\C-c" 'artist-mode-off)
536 (define-key map "\C-c\C-al" 'artist-select-op-line)
537 (define-key map "\C-c\C-aL" 'artist-select-op-straight-line)
538 (define-key map "\C-c\C-ar" 'artist-select-op-rectangle)
539 (define-key map "\C-c\C-aR" 'artist-select-op-square)
540 (define-key map "\C-c\C-as" 'artist-select-op-square)
541 (define-key map "\C-c\C-ap" 'artist-select-op-poly-line)
542 (define-key map "\C-c\C-aP" 'artist-select-op-straight-poly-line)
543 (define-key map "\C-c\C-ae" 'artist-select-op-ellipse)
544 (define-key map "\C-c\C-ac" 'artist-select-op-circle)
545 (define-key map "\C-c\C-at" 'artist-select-op-text-see-thru)
546 (define-key map "\C-c\C-aT" 'artist-select-op-text-overwrite)
547 (define-key map "\C-c\C-aS" 'artist-select-op-spray-can)
548 (define-key map "\C-c\C-az" 'artist-select-op-spray-set-size)
549 (define-key map "\C-c\C-a\C-d" 'artist-select-op-erase-char)
550 (define-key map "\C-c\C-aE" 'artist-select-op-erase-rectangle)
551 (define-key map "\C-c\C-av" 'artist-select-op-vaporize-line)
552 (define-key map "\C-c\C-aV" 'artist-select-op-vaporize-lines)
553 (define-key map "\C-c\C-a\C-k" 'artist-select-op-cut-rectangle)
554 (define-key map "\C-c\C-a\M-w" 'artist-select-op-copy-rectangle)
555 (define-key map "\C-c\C-a\C-y" 'artist-select-op-paste)
556 (define-key map "\C-c\C-af" 'artist-select-op-flood-fill)
557 (define-key map "\C-c\C-a\C-b" 'artist-submit-bug-report)
558 map)
559 "Keymap for `artist-minor-mode'.")
560
561(defvar artist-replacement-table (make-vector 256 0)
562 "Replacement table for `artist-replace-char'.")
563
564
565;;;
566;;; The table of graphic operations
567;;;
568(defvar artist-mt
569 ;; Implementation note: Maybe this should be done using a structure
570 ;; in the cl package?
571 ;;
572 '(
573 (menu
574 ("Drawing"
575 ((function-call
576 ( "Undo" do-undo undo))
577
578 (separator )
579 (graphics-operation
580 ("Pen" (("Pen" pen-char "pen-c"
581 artist-no-arrows nil
582 nil nil nil
583 artist-do-continously
584 artist-pen
585 (nil))
586 ("Pen Line" pen-line "pen-l"
587 artist-arrows artist-pen-set-arrow-points
588 artist-pen-reset-last-xy nil nil
589 artist-do-continously
590 artist-pen-line
591 (nil)))))
592
593 (graphics-operation
594 ("Line" (("line" line "line"
595 artist-arrows artist-set-arrow-points-for-2points
596 nil nil nil
597 2
598 artist-draw-line
599 (artist-undraw-line
600 artist-nil nil))
601 ("straight line" s-line "sline"
602 artist-arrows artist-set-arrow-points-for-2points
603 nil nil nil
604 2
605 artist-draw-sline
606 (artist-undraw-sline
607 artist-nil nil)))))
608
609 (graphics-operation
610 ("Rectangle" (("rectangle" rect "rect"
611 artist-no-arrows nil
612 nil nil nil
613 2
614 artist-draw-rect
615 (artist-undraw-rect
616 artist-t-if-fill-char-set artist-fill-rect))
617 ("square" square "square"
618 artist-no-arrows nil
619 nil nil nil
620 2
621 artist-draw-square
622 (artist-undraw-square
623 artist-t-if-fill-char-set artist-fill-square)))))
624
625 (graphics-operation
626 ("Poly-line" (("poly-line" polyline "poly"
627 artist-arrows artist-set-arrow-points-for-poly
628 nil nil nil
629 artist-do-poly
630 artist-draw-line
631 (artist-undraw-line
632 artist-nil nil))
633 ("straight poly-line" spolyline "s-poly"
634 artist-arrows artist-set-arrow-points-for-poly
635 nil nil nil
636 artist-do-poly
637 artist-draw-sline
638 (artist-undraw-sline
639 artist-nil nil)))))
640
641 (graphics-operation
642 ("Ellipse" (("ellipse" ellipse "ellipse"
643 artist-no-arrows nil
644 nil nil nil
645 2
646 artist-draw-ellipse
647 (artist-undraw-ellipse
648 artist-t-if-fill-char-set artist-fill-ellipse))
649 ("circle" circle "circle"
650 artist-no-arrows nil
651 nil nil nil
652 2
653 artist-draw-circle
654 (artist-undraw-circle
655 artist-t-if-fill-char-set artist-fill-circle)))))
656
657 (graphics-operation
658 ("Text" (("text see-thru" text-thru "text-thru"
659 artist-no-arrows nil
660 nil nil nil
661 1
662 artist-text-see-thru
663 nil)
664 ("text overwrite" text-ovwrt "text-ovwrt"
665 artist-no-arrows nil
666 nil nil nil
667 1
668 artist-text-overwrite
669 nil))))
670
671 (graphics-operation
672 ("Spray-can" (("spray-can" spray-can "spray-can"
673 artist-no-arrows nil
674 nil nil nil
675 artist-do-continously
676 artist-spray
677 (artist-spray-get-interval))
678 ("spray set size" spray-get-size "spray-size"
679 artist-no-arrows nil
680 nil artist-spray-clear-circle artist-spray-set-radius
681 2
682 artist-draw-circle
683 (artist-undraw-circle
684 artist-nil nil)))))
685
686 (graphics-operation
687 ("Erase" (("erase char" erase-char "erase-c"
688 artist-no-arrows nil
689 nil nil nil
690 artist-do-continously
691 artist-erase-char
692 (nil))
693 ("erase rectangle" erase-rect "erase-r"
694 artist-no-arrows nil
695 nil nil nil
696 2
697 artist-draw-rect
698 (artist-undraw-rect
699 artist-t artist-erase-rect)))))
700
701 (graphics-operation
702 ("Vaporize" (("vaporize line" vaporize-line "vaporize-1"
703 artist-no-arrows nil
704 nil nil nil
705 1
706 artist-vaporize-line
707 nil)
708 ("vaporize lines" vaporize-lines "vaporize-n"
709 artist-no-arrows nil
710 nil nil nil
711 1
712 artist-vaporize-lines
713 nil)))))))
714
715 (menu
716 ("Edit"
717 ((graphics-operation
718 ("Cut" (("cut rectangle" cut-r "cut-r"
719 artist-no-arrows nil
720 nil nil nil
721 2
722 artist-draw-rect
723 (artist-undraw-rect
921d84aa 724 artist-t artist-cut-rect))
b95b34e5
GM
725 ("cut square" cut-s "cut-s"
726 artist-no-arrows nil
727 nil nil nil
728 2
729 artist-draw-square
730 (artist-undraw-square
921d84aa 731 artist-t artist-cut-square)))))
b95b34e5
GM
732
733 (graphics-operation
734 ("Copy" (("copy rectangle" copy-r "copy-r"
735 artist-no-arrows nil
736 nil nil nil
737 2
738 artist-draw-rect
739 (artist-undraw-rect
921d84aa 740 artist-t artist-copy-rect))
b95b34e5
GM
741 ("copy square" copy-s "copy-s"
742 artist-no-arrows nil
743 nil nil nil
744 2
745 artist-draw-square
746 (artist-undraw-square
921d84aa 747 artist-t artist-copy-square)))))
b95b34e5
GM
748
749 (graphics-operation
750 ("Paste" (("paste" paste "paste"
751 artist-no-arrows nil
752 nil nil nil
753 1
754 artist-paste
755 nil)
756 ("paste" paste "paste"
757 artist-no-arrows nil
758 nil nil nil
759 1
760 artist-paste
761 nil))))
762
763 (graphics-operation
764 ("Flood-fill" (("flood-fill" flood-fill "flood"
765 artist-no-arrows nil
766 nil nil nil
767 1
768 artist-flood-fill
769 nil)
770 ("flood-fill" flood-fill "flood"
771 artist-no-arrows nil
772 nil nil nil
773 1
774 artist-flood-fill
63db25ed 775 nil)))))))
b95b34e5
GM
776
777 (menu
778 ("Settings"
779 ((function-call
780 ("Set Fill" set-fill artist-select-fill-char))
781
782 (function-call
783 ("Set Line" set-line artist-select-line-char))
784
785 (function-call
786 ("Set Erase" set-erase artist-select-erase-char))
787
788 (function-call
789 ("Rubber-banding" rubber-band artist-toggle-rubber-banding))
790
791 (function-call
792 ("Trimming" trimming artist-toggle-trim-line-endings))
793
794 (function-call
795 ("Borders" borders artist-toggle-borderless-shapes))
796
797 (function-call
798 ("Spray-chars" spray-chars artist-select-spray-chars)))))
799
800 ) ;; end of list
801
802 "Master Table for `artist-mode'.
803This table is primarily a table over the different graphics operations
98d92ce3 804available in Artist mode, but it also holds layout information for the
b95b34e5
GM
805popup menu.
806
807The master table is a list of table elements. The elements of this table
808have the layout
809
810 (TAG INFO-PART)
811
812There are three kinds of TAG:
813
814 `menu' -- a sub-menu
815 `separator' -- produce a separator in the popup menu
816 `function-call' -- call a function
817 `graphics-operation' -- a graphics operation
818
819The layout of the INFO-PART for `menu' is
820
821 (TITLE ((TAG-1 INFO-PART-1) (TAG-2 INFO-PART-2) ...))
822
823TITLE is the title of the submenu; this is followed by a list of
824menu items, each on the general form (TAG INFO-PART).
825
826
827The layout of the INFO-PART for `separator' is empty and not used.
828
829
830This is the layout of the INFO-PART for `function-call':
831
832 (KEYWORD SYMBOL FN)
833
834KEYWORD is a string naming the operation, and appears in the popup menu.
835SYMBOL is the symbol for the operations.
836FN is the function performing the operation. This function
837 is called with no arguments. Its return value is ignored.
838
839
840The layout of the INFO-PART for `graphics-operation' is
841
842 (TITLE (UNSHIFTED SHIFTED))
843
110c171f 844TITLE is the title that appears in the popup menu. UNSHIFTED
b95b34e5
GM
845and SHIFTED specify for unshifted and shifted operation. Both
846have the form
847
848 (KEYWORD KEY-SYMBOL MODE-LINE ARROW-PRED ARROW-SET-FN
849 INIT-FN PREP-FILL-FN EXIT-FN DRAW-HOW DRAW-FN EXTRA-DRAW-INFO)
850
851KEYWORD is a string specifying the name of the shape to draw.
852 This is used when selecting drawing operation.
853KEY-SYMBOL is the key which is used when looking up members
854 through the functions `artist-go-get-MEMBER-from-symbol'
855 and `artist-fc-get-MEMBER-from-symbol'.
856MODE-LINE is a string that appears in the mode-line when drawing
857 the shape.
858ARROW-PRED is a function that is called to find out if the shape
859 can have arrows. The function is called with no arguments and
860 must return nil or t.
861ARROW-SET-FN is a function that is called to set arrow end-points.
862 Arguments and return values for this funcion are described below.
863INIT-FN is, if non-nil, a function that is called when the first
864 point of the shape is set. Arguments and return values for
865 this funcion are described below.
866PREP-FILL-FN is, if non-nil, a function that is called after
867 the last point is set, but before the filling is done.
868 Arguments and return values for this funcion are described below.
869EXIT-FN is, if non-nil, a function that is called after filling
870 is done. Arguments and return values for this funcion are
871 described below.
872DRAW-HOW defines the kind of shape. The kinds of shapes are:
873 `artist-do-continously' -- Do drawing operation continously,
874 as long as the mouse button is held down.
875 `artist-do-poly' -- Do drawing operation many times.
876 1 -- Do drawing operation only once.
877 2 -- The drawing operation requires two points.
878DRAW-FN is the function to call for drawing. Arguments and
879 return values for this funcion are described below.
880EXTRA-DRAW-INFO the layout of this depends on the value of DRAW-HOW:
881 If DRAW-HOW is `artist-do-continously':
882
883 (INTERVAL-FN)
884
885 INTERVAL-FN is, if non-nil, a function to call for getting
886 an interval between repeated calls to the DRAW-FN.
887 This function is called with no arguments and must
888 return a number, the interval in seconds.
889 If nil, calls to DRAW-FN are done only when the mouse
890 or cursor is moved.
891
892 If DRAW-HOW is either `artist-do-poly' or 2:
893
894 (UNDRAW-FN FILL-PRED FILL-FN)
895
896 UNDRAW-FN is a function to call for undrawing the shape.
897 Arguments and return values for this funcion are
898 described below.
899 FILL-PRED is a function that is called to find out if the shape
900 can have arrows. The function must take no arguments and
901 return nil or t.
902 FILL-FN is a function to call for filling the shape.
903 Arguments and return values for this funcion are
904 described below.
905
906 If DRAW-HOW is 1:
907
908 ()
909
910Note! All symbols and keywords (both in the `funcion-call' INFO-PART
911 as well as in the `graphics-operation' INFO-PART) must be unique.
912
913The following table describe function arguments and return value
914for different functions and DRAW-HOWs.
915
916If DRAW-HOW is either `artist-do-continously' or 1:
917
918 INIT-FN X Y ==> ignored
919 PREP-FILL-FN X Y ==> ignored
920 EXIT-FN X Y ==> ignored
921 ARROW-SET-FN X Y ==> ignored
922 DRAW-FN X Y ==> ignored
923
924If DRAW-HOW is 2:
925
926 INIT-FN X1 Y1 ==> ignored
927 PREP-FILL-FN X1 Y1 X2 Y2 ==> ignored
928 EXIT-FN X1 Y1 X2 Y2 ==> ignored
929 ARROW-SET-FN X1 Y1 X2 Y2 ==> ignored
930 DRAW-FN X1 Y1 X2 Y2 ==> (ENDPOINT-1 ENDPOINT-2 SHAPE)
931 UNDRAW-FN (ENDPOINT-1 ENDPOINT-2 SHAPE) ==> ignored
932 FILL-FN (ENDPOINT-1 ENDPOINT-2 SHAPE) X1 Y1 X2 Y2 ==> ignored
933
934 ENDPOINT-1 and ENDPOINT-2 are endpoints which are created with
935 `artist-make-endpoint'
98d92ce3 936 SHAPE is an opaque structure, created by the DRAW-FN and intended
b95b34e5
GM
937 to be used only by the UNDRAW-FN.
938
939If DRAW-HOW is `artist-do-poly':
940
941 INIT-FN X1 Y1
942 PREP-FILL-FN POINT-LIST
943 ARROW-SET-FN POINT-LIST
944 EXIT-FN POINT-LIST
945 DRAW-FN X-LAST Y-LAST X-NEW Y-NEW ==> (ENDPOINT-1 ENDPOINT-2 SHAPE)
946 UNDRAW-FN (ENDPOINT-1 ENDPOINT-2 SHAPE)
947 FILL-FN POINT-LIST
948
949 ENDPOINT-1 and ENDPOINT-2 are endpoints which are created with
950 `artist-make-endpoint'.
98d92ce3 951 SHAPE is an opaque structure, created by the DRAW-FN and intended
b95b34e5
GM
952 to be used only by the UNDRAW-FN.
953 POINT-LIST is a list of vectors [X Y].")
954
955
956;;
957;; Accessors for the master table
958;;
959
960(defun artist-mt-get-tag (element)
961 "Retrieve the tag component from the master table ELEMENT."
962 (elt element 0))
963
964(defun artist-mt-get-info-part (element)
965 "Retrieve the info part component from the master table ELEMENT."
966 (elt element 1))
967
968;; For the 'graphics-operation info-parts
969;;
970(defsubst artist-go-get-desc (info-part)
971 "Retrieve the description component from a graphics operation INFO-PART."
972 (elt info-part 0))
973
974(defsubst artist-go-get-unshifted (info-part)
975 "Retrieve the unshifted info from a graphics operation INFO-PART."
976 (elt (elt info-part 1) 0))
977
978(defsubst artist-go-get-shifted (info-part)
979 "Retrieve the shifted info from a graphics operation INFO-PART."
980 (elt (elt info-part 1) 1))
981
982(defsubst artist-go-get-keyword (info-variant-part)
983 "Retrieve the keyword component from an INFO-VARIANT-PART.
984An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
985 (elt info-variant-part 0))
986
987(defsubst artist-go-get-symbol (info-variant-part)
988 "Retrieve the symbol component from an INFO-VARIANT-PART.
989An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
990 (elt info-variant-part 1))
991
992(defsubst artist-go-get-mode-line (info-variant-part)
993 "Retrieve the mode line component from an INFO-VARIANT-PART.
994An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
995 (elt info-variant-part 2))
996
997(defsubst artist-go-get-arrow-pred (info-variant-part)
998 "Retrieve the arrow predicate component from an INFO-VARIANT-PART.
999An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
1000 (elt info-variant-part 3))
1001
1002(defsubst artist-go-get-arrow-set-fn (info-variant-part)
1003 "Retrieve the arrow set component from an INFO-VARIANT-PART.
1004An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
1005 (elt info-variant-part 4))
1006
1007(defsubst artist-go-get-init-fn (info-variant-part)
1008 "Retrieve the init function component from an INFO-VARIANT-PART.
1009An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
1010 (elt info-variant-part 5))
1011
1012(defsubst artist-go-get-prep-fill-fn (info-variant-part)
1013 "Retrieve the fill preparation function component from an INFO-VARIANT-PART.
1014An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
1015 (elt info-variant-part 6))
1016
1017(defsubst artist-go-get-exit-fn (info-variant-part)
1018 "Retrieve the exit component from an INFO-VARIANT-PART.
1019An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
1020 (elt info-variant-part 7))
1021
1022(defsubst artist-go-get-draw-how (info-variant-part)
1023 "Retrieve the draw how component from an INFO-VARIANT-PART.
1024An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
1025 (elt info-variant-part 8))
1026
1027(defsubst artist-go-get-draw-fn (info-variant-part)
1028 "Retrieve the draw function component from an INFO-VARIANT-PART.
1029An INFO-VARIANT-PART is the shifted or unshifted info from a info-part."
1030 (elt info-variant-part 9))
1031
1032(defsubst artist-go-get-undraw-fn (info-variant-part)
1033 "Retrieve the undraw function component from an INFO-VARIANT-PART.
1034An INFO-VARIANT-PART is the shifted or unshifted info from a info-part.
1035This interval function component is available only if the `draw-how'
1036component is other than `artist-do-continously' or 1."
1037 (elt (elt info-variant-part 10) 0))
1038
1039(defsubst artist-go-get-interval-fn (info-variant-part)
1040 "Retrieve the interval function component from an INFO-VARIANT-PART.
1041An INFO-VARIANT-PART is the shifted or unshifted info from a info-part.
1042This interval function component is available only if the `draw-how'
1043component is `artist-do-continously'."
1044 (elt (elt info-variant-part 10) 0))
1045
1046(defsubst artist-go-get-fill-pred (info-variant-part)
1047 "Retrieve the fill predicate component from an INFO-VARIANT-PART.
1048An INFO-VARIANT-PART is the shifted or unshifted info from a info-part.
1049This interval function component is available only if the `draw-how'
1050component is other than `artist-do-continously' or 1."
1051 (elt (elt info-variant-part 10) 1))
1052
1053(defsubst artist-go-get-fill-fn (info-variant-part)
1054 "Retrieve the fill function component from an INFO-VARIANT-PART.
1055An INFO-VARIANT-PART is the shifted or unshifted info from a info-part.
1056This interval function component is available only if the `draw-how'
1057component is other than `artist-do-continously' or 1."
1058 (elt (elt info-variant-part 10) 2))
1059
1060;; For the 'function-call info-parts
1061;;
1062(defsubst artist-fc-get-keyword (info-part)
1063 "Retrieve the keyword component from a graphics operation INFO-PART."
1064 (elt info-part 0))
1065
1066(defsubst artist-fc-get-symbol (info-part)
1067 "Retrieve the symbol component from a graphics operation INFO-PART."
1068 (elt info-part 1))
1069
1070(defsubst artist-fc-get-fn (info-part)
1071 "Retrieve the function component from a graphics operation INFO-PART."
1072 (elt info-part 2))
1073
1074;; For the 'menu info-parts
1075;;
1076(defsubst artist-mn-get-title (info-part)
1077 "Retrieve the title component from a graphics operation INFO-PART."
1078 (elt info-part 0))
1079
1080(defsubst artist-mn-get-items (info-part)
1081 "Retrieve the items component from a graphics operation INFO-PART."
1082 (elt info-part 1))
1083
9d8b0f9c
RS
1084;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1085;; mouse wheel cyclic operation selection
1086
1087(defun artist-get-last-non-nil-op (op-list &optional last-non-nil)
1088 "Find the last non-nil draw operation in OP-LIST.
1089Optional LAST-NON-NIL will be returned if OP-LIST is nil."
1090 (if op-list
1091 (artist-get-last-non-nil-op (cdr op-list)
1092 (or (car (car op-list)) last-non-nil))
1093 last-non-nil))
1094
1095(defun artist-get-first-non-nil-op (op-list)
1096 "Find the first non-nil draw operation in OP-LIST."
1097 (or (car (car op-list)) (artist-get-first-non-nil-op (cdr op-list))))
1098
1099(defun artist-is-in-op-list-p (op op-list)
1100 "Check whether OP is in OP-LIST."
1101 (and op-list
1102 (or (and (car (car op-list)) (string= op (car (car op-list))))
1103 (artist-is-in-op-list-p op (cdr op-list)))))
1104
1105(defun artist-make-prev-next-op-alist (op-list
1106 &optional
1107 last-non-nil-arg first-non-nil-arg
1108 prev-entry prev-op-arg)
1109 "Build an assoc-list of OP-LIST.
1110The arguments LAST-NON-NIL-ARG, FIRST-NON-NIL-ARG, PREV-ENTRY and
1111PREV-OP-ARG are used when invoked recursively during the build-up."
1112 (let* ((last-non-nil (or last-non-nil-arg
1113 (artist-get-last-non-nil-op
1114 artist-key-compl-table)))
1115 (first-non-nil (or first-non-nil-arg
1116 (artist-get-first-non-nil-op
1117 artist-key-compl-table)))
1118 (prev-op (or prev-op-arg last-non-nil))
1119 (op (car (car op-list)))
1120 (opsym (artist-mt-get-symbol-from-keyword op))
1121 (entry (cons opsym (cons prev-op nil))))
1122 (if (or (and op-list (not op))
1123 (artist-is-in-op-list-p op (cdr op-list)))
1124 (artist-make-prev-next-op-alist (cdr op-list)
1125 last-non-nil first-non-nil
1126 prev-entry prev-op)
1127 (if prev-entry (setcdr (cdr prev-entry) op))
1128 (if op-list
1129 (cons entry (artist-make-prev-next-op-alist
1130 (cdr op-list)
1131 last-non-nil first-non-nil
1132 entry op))
1133 (progn (setcdr (cdr prev-entry) first-non-nil) nil)))))
1134
1135(defun artist-select-next-op-in-list ()
1136 "Cyclically select next drawing mode operation."
1137 (interactive)
1138 (let ((next-op (cdr (cdr (assoc artist-curr-go artist-prev-next-op-alist)))))
1139 (artist-select-operation next-op)
274f1353 1140 (message "%s" next-op)))
9d8b0f9c
RS
1141
1142(defun artist-select-prev-op-in-list ()
1143 "Cyclically select previous drawing mode operation."
1144 (interactive)
1145 (let ((prev-op (car (cdr (assoc artist-curr-go artist-prev-next-op-alist)))))
1146 (artist-select-operation prev-op)
274f1353 1147 (message "%s" prev-op)))
9d8b0f9c
RS
1148
1149;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1150
b95b34e5
GM
1151;;; ---------------------------------
1152;;; The artist-mode
1153;;; ---------------------------------
1154
fb39bbbd 1155;;;###autoload
b95b34e5 1156(defun artist-mode (&optional state)
98d92ce3
JB
1157 "Toggle Artist mode.
1158With argument STATE, turn Artist mode on if STATE is positive.
1159Artist lets you draw lines, squares, rectangles and poly-lines,
1160ellipses and circles with your mouse and/or keyboard.
b95b34e5 1161
98d92ce3 1162How to quit Artist mode
b95b34e5
GM
1163
1164 Type \\[artist-mode-off] to quit artist-mode.
1165
1166
1167How to submit a bug report
1168
1169 Type \\[artist-submit-bug-report] to submit a bug report.
1170
1171
1172Drawing with the mouse:
1173
1174 mouse-2
1175 shift mouse-2 Pops up a menu where you can select what to draw with
1176 mouse-1, and where you can do some settings (described
1177 below).
1178
1179 mouse-1
1180 shift mouse-1 Draws lines, rectangles or poly-lines, erases, cuts, copies
1181 or pastes:
1182
1183 Operation Not shifted Shifted
1184 --------------------------------------------------------------
1185 Pen fill-char at point line from last point
1186 to new point
1187 --------------------------------------------------------------
1188 Line Line in any direction Straight line
1189 --------------------------------------------------------------
1190 Rectangle Rectangle Square
1191 --------------------------------------------------------------
1192 Poly-line Poly-line in any dir Straight poly-lines
1193 --------------------------------------------------------------
1194 Ellipses Ellipses Circles
1195 --------------------------------------------------------------
1196 Text Text (see thru) Text (overwrite)
1197 --------------------------------------------------------------
1198 Spray-can Spray-can Set size for spray
1199 --------------------------------------------------------------
1200 Erase Erase character Erase rectangle
1201 --------------------------------------------------------------
1202 Vaporize Erase single line Erase connected
1203 lines
1204 --------------------------------------------------------------
1205 Cut Cut rectangle Cut square
1206 --------------------------------------------------------------
1207 Copy Copy rectangle Copy square
1208 --------------------------------------------------------------
1209 Paste Paste Paste
1210 --------------------------------------------------------------
1211 Flood-fill Flood-fill Flood-fill
1212 --------------------------------------------------------------
1213
bc984175 1214 * Straight lines can only go horizontally, vertically
b95b34e5
GM
1215 or diagonally.
1216
98d92ce3
JB
1217 * Poly-lines are drawn while holding mouse-1 down. When you
1218 release the button, the point is set. If you want a segment
b95b34e5 1219 to be straight, hold down shift before pressing the
98d92ce3 1220 mouse-1 button. Click mouse-2 or mouse-3 to stop drawing
b95b34e5
GM
1221 poly-lines.
1222
1223 * See thru for text means that text already in the buffer
1224 will be visible through blanks in the text rendered, while
1225 overwrite means the opposite.
1226
1227 * Vaporizing connected lines only vaporizes lines whose
98d92ce3 1228 _endpoints_ are connected. See also the variable
b95b34e5
GM
1229 `artist-vaporize-fuzziness'.
1230
1231 * Cut copies, then clears the rectangle/square.
1232
1233 * When drawing lines or poly-lines, you can set arrows.
1234 See below under ``Arrows'' for more info.
1235
1236 * The mode line shows the currently selected drawing operation.
1237 In addition, if it has an asterisk (*) at the end, you
1238 are currently drawing something.
1239
1240 * Be patient when flood-filling -- large areas take quite
1241 some time to fill.
1242
1243
1244 mouse-3 Erases character under pointer
1245 shift mouse-3 Erases rectangle
1246
1247
1248Settings
1249
1250 Set fill Sets the character used when filling rectangles/squares
1251
1252 Set line Sets the character used when drawing lines
1253
1254 Erase char Sets the character used when erasing
1255
1256 Rubber-banding Toggles rubber-banding
1257
1258 Trimming Toggles trimming of line-endings (that is: when the shape
1259 is drawn, extraneous white-space at end of lines is removed)
1260
98d92ce3 1261 Borders Toggles the drawing of line borders around filled shapes
b95b34e5
GM
1262
1263
1264Drawing with keys
1265
1266 \\[artist-key-set-point] Does one of the following:
1267 For lines/rectangles/squares: sets the first/second endpoint
1268 For poly-lines: sets a point (use C-u \\[artist-key-set-point] to set last point)
1269 When erase characters: toggles erasing
1270 When cutting/copying: Sets first/last endpoint of rect/square
1271 When pasting: Pastes
1272
1273 \\[artist-select-operation] Selects what to draw
1274
1275 Move around with \\[artist-next-line], \\[artist-previous-line], \\[artist-forward-char] and \\[artist-backward-char].
1276
f81b2db1
JB
1277 \\[artist-select-fill-char] Sets the character to use when filling
1278 \\[artist-select-line-char] Sets the character to use when drawing
1279 \\[artist-select-erase-char] Sets the character to use when erasing
b95b34e5
GM
1280 \\[artist-toggle-rubber-banding] Toggles rubber-banding
1281 \\[artist-toggle-trim-line-endings] Toggles trimming of line-endings
1282 \\[artist-toggle-borderless-shapes] Toggles borders on drawn shapes
1283
1284
1285Arrows
1286
1287 \\[artist-toggle-first-arrow] Sets/unsets an arrow at the beginning
1288 of the line/poly-line
1289
1290 \\[artist-toggle-second-arrow] Sets/unsets an arrow at the end
1291 of the line/poly-line
1292
1293
1294Selecting operation
1295
1296 There are some keys for quickly selecting drawing operations:
1297
1298 \\[artist-select-op-line] Selects drawing lines
1299 \\[artist-select-op-straight-line] Selects drawing straight lines
1300 \\[artist-select-op-rectangle] Selects drawing rectangles
1301 \\[artist-select-op-square] Selects drawing squares
1302 \\[artist-select-op-poly-line] Selects drawing poly-lines
1303 \\[artist-select-op-straight-poly-line] Selects drawing straight poly-lines
1304 \\[artist-select-op-ellipse] Selects drawing ellipses
1305 \\[artist-select-op-circle] Selects drawing circles
1306 \\[artist-select-op-text-see-thru] Selects rendering text (see thru)
1307 \\[artist-select-op-text-overwrite] Selects rendering text (overwrite)
1308 \\[artist-select-op-spray-can] Spray with spray-can
1309 \\[artist-select-op-spray-set-size] Set size for the spray-can
1310 \\[artist-select-op-erase-char] Selects erasing characters
1311 \\[artist-select-op-erase-rectangle] Selects erasing rectangles
1312 \\[artist-select-op-vaporize-line] Selects vaporizing single lines
1313 \\[artist-select-op-vaporize-lines] Selects vaporizing connected lines
1314 \\[artist-select-op-cut-rectangle] Selects cutting rectangles
1315 \\[artist-select-op-copy-rectangle] Selects copying rectangles
1316 \\[artist-select-op-paste] Selects pasting
1317 \\[artist-select-op-flood-fill] Selects flood-filling
1318
1319
1320Variables
1321
1322 This is a brief overview of the different varaibles. For more info,
1323 see the documentation for the variables (type \\[describe-variable] <variable> RET).
1324
1325 artist-rubber-banding Interactively do rubber-banding or not
1326 artist-first-char What to set at first/second point...
1327 artist-second-char ...when not rubber-banding
1328 artist-interface-with-rect If cut/copy/paste should interface with rect
1329 artist-arrows The arrows to use when drawing arrows
1330 artist-aspect-ratio Character height-to-width for squares
1331 artist-trim-line-endings Trimming of line endings
1332 artist-flood-fill-right-border Right border when flood-filling
1333 artist-flood-fill-show-incrementally Update display while filling
1334 artist-pointer-shape Pointer shape to use while drawing
1335 artist-ellipse-left-char Character to use for narrow ellipses
1336 artist-ellipse-right-char Character to use for narrow ellipses
1337 artist-borderless-shapes If shapes should have borders
1338 artist-picture-compatibility Whether or not to be picture mode compatible
1339 artist-vaporize-fuzziness Tolerance when recognizing lines
1340 artist-spray-interval Seconds between repeated sprayings
1341 artist-spray-radius Size of the spray-area
1342 artist-spray-chars The spray-``color''
1343 artist-spray-new-chars Initial spray-``color''
1344
1345Hooks
1346
1347 When entering artist-mode, the hook `artist-mode-init-hook' is called.
1348 When quitting artist-mode, the hook `artist-mode-exit-hook' is called.
1349
1350
1351Keymap summary
1352
1353\\{artist-mode-map}"
1354 (interactive)
1355 (if (setq artist-mode
1356 (if (null state) (not artist-mode)
1357 (> (prefix-numeric-value state) 0)))
1358 (artist-mode-init)
1359 (artist-mode-exit)))
1360
1361;; insert our minor mode string
1362(or (assq 'artist-mode minor-mode-alist)
1363 (setq minor-mode-alist
1364 (cons '(artist-mode artist-mode-name)
1365 minor-mode-alist)))
1366
1367;; insert our minor mode keymap
1368(or (assq 'artist-mode minor-mode-map-alist)
1369 (setq minor-mode-map-alist
1370 (cons (cons 'artist-mode artist-mode-map)
1371 minor-mode-map-alist)))
1372
1373
b95b34e5
GM
1374;; Init and exit
1375(defun artist-mode-init ()
1376 "Init Artist mode. This will call the hook `artist-mode-init-hook'."
921d84aa
CY
1377 ;; Set up a conversion table for mapping tabs and new-lines to spaces.
1378 ;; the last case, 0, is for the last position in buffer/region, where
1379 ;; the `following-char' function returns 0.
b95b34e5
GM
1380 (let ((i 0))
1381 (while (< i 256)
1382 (aset artist-replacement-table i i)
1383 (setq i (1+ i))))
fe6e86db
JB
1384 (aset artist-replacement-table ?\n ?\s)
1385 (aset artist-replacement-table ?\t ?\s)
1386 (aset artist-replacement-table 0 ?\s)
921d84aa 1387 ;; More setup
b95b34e5
GM
1388 (make-local-variable 'artist-key-is-drawing)
1389 (make-local-variable 'artist-key-endpoint1)
1390 (make-local-variable 'artist-key-poly-point-list)
1391 (make-local-variable 'artist-key-shape)
1392 (make-local-variable 'artist-key-draw-how)
1393 (make-local-variable 'artist-popup-menu-table)
1394 (make-local-variable 'artist-key-compl-table)
9d8b0f9c 1395 (make-local-variable 'artist-prev-next-op-alist)
b95b34e5
GM
1396 (make-local-variable 'artist-rb-save-data)
1397 (make-local-variable 'artist-arrow-point-1)
1398 (make-local-variable 'artist-arrow-point-2)
1399 (setq artist-key-is-drawing nil)
1400 (setq artist-key-endpoint1 nil)
1401 (setq artist-key-poly-point-list nil)
1402 (setq artist-key-shape nil)
1403 (setq artist-popup-menu-table (artist-compute-popup-menu-table artist-mt))
1404 (setq artist-key-compl-table (artist-compute-key-compl-table artist-mt))
9d8b0f9c
RS
1405 (setq artist-prev-next-op-alist
1406 (artist-make-prev-next-op-alist artist-key-compl-table))
b95b34e5
GM
1407 (setq artist-rb-save-data (make-vector 7 0))
1408 (setq artist-arrow-point-1 nil)
1409 (setq artist-arrow-point-2 nil)
1410 (make-local-variable 'next-line-add-newlines)
1411 (setq next-line-add-newlines t)
1412 (setq artist-key-draw-how
1413 (artist-go-get-draw-how-from-symbol artist-curr-go))
1414 (if (and artist-picture-compatibility (not (eq major-mode 'picture-mode)))
1415 (progn
1416 (picture-mode)
1417 (message "")))
1418 (run-hooks 'artist-mode-init-hook)
1419 (artist-mode-line-show-curr-operation artist-key-is-drawing))
1420
1421(defun artist-mode-exit ()
1422 "Exit Artist mode. This will call the hook `artist-mode-exit-hook'."
1423 (if (and artist-picture-compatibility (eq major-mode 'picture-mode))
1424 (picture-mode-exit))
1425 (kill-local-variable 'next-line-add-newlines)
1426 (run-hooks 'artist-mode-exit-hook))
1427
1428(defun artist-mode-off ()
1429 "Turn Artist mode off."
1430 (interactive)
1431 (artist-mode -1)
1432 (force-mode-line-update))
1433
1434;;
1435;; General routines
1436;;
1437
1438(defun artist-update-display ()
1439 "Repaint the display."
1440 (sit-for 0))
1441
1442(defun artist-mode-line-show-curr-operation (is-drawing)
98d92ce3 1443 "Show current operation in mode-line. If IS-DRAWING, show that."
b95b34e5
GM
1444 (let ((mtext (concat artist-mode-name "/"
1445 (artist-go-get-mode-line-from-symbol artist-curr-go)
1446 (if is-drawing "/*" ""))))
1447 (setcdr (assq 'artist-mode minor-mode-alist) (list mtext)))
1448 (force-mode-line-update))
1449
1450
1451(defun artist-t-if-fill-char-set ()
1452 "Return the value of the variable `artist-fill-char-set'."
1453 artist-fill-char-set)
1454
1455(defun artist-t ()
1456 "Always return t."
1457 t)
1458
1459(defun artist-nil ()
1460 "Always return nil."
1461 nil)
1462
1463(defun artist-arrows ()
1464 "Say yes to arrows!"
1465 t)
1466
1467(defun artist-no-arrows ()
1468 "Say no to arrows!"
1469 nil)
1470
1471;;
1472;; Auxiliary init-routines
1473;;
1474
1475;
1476; Computing the table for the x-popup-menu from the master table
1477;
1478
1479(defun artist-compute-popup-menu-table (menu-table)
1480 "Create a menu from from MENU-TABLE data.
1481The returned value is suitable for the `x-popup-menu' function."
1482 (cons "Artist menu"
1483 (artist-compute-popup-menu-table-sub menu-table)))
1484
1485(defun artist-compute-popup-menu-table-sub (menu-table)
1486 "Compute operation table suitable for `x-popup-menu' from MENU-TABLE."
1487 (mapcar
1488 (lambda (element)
1489 (let ((element-tag (artist-mt-get-tag element)))
1490 (cond ((eq element-tag 'graphics-operation)
1491 (let* ((info-part (artist-mt-get-info-part element))
1492 (descr (artist-go-get-desc info-part))
1493 (unshifted (artist-go-get-unshifted info-part))
1494 (symbol (artist-go-get-symbol unshifted)))
1495 (list descr symbol)))
1496
1497 ((eq element-tag 'function-call)
1498 (let* ((info-part (artist-mt-get-info-part element))
1499 (keyword (artist-fc-get-keyword info-part))
1500 (symbol (artist-fc-get-symbol info-part)))
1501 (list keyword symbol)))
1502
1503 ((eq element-tag 'separator)
1504 '("" ""))
1505
1506 ((eq element-tag 'menu)
1507 (let* ((info-part (artist-mt-get-info-part element))
1508 (title (artist-mn-get-title info-part))
1509 (items (artist-mn-get-items info-part)))
1510 (cons title (artist-compute-popup-menu-table-sub items))))
1511
1512 (t
1513 (error "Internal error: unknown element-tag: \"%s\""
1514 element-tag)))))
1515 menu-table))
1516
1517;
1518; Computing the completion table from the master table
1519;
1520
1521(defun artist-compute-key-compl-table (menu-table)
1522 "Compute completion table from MENU-TABLE, suitable for `completing-read'."
1523 (apply
1524 'nconc
a4a5aa2b 1525 (remq nil
b95b34e5
GM
1526 (mapcar
1527 (lambda (element)
1528 (let ((element-tag (artist-mt-get-tag element)))
1529 (cond ((eq element-tag 'graphics-operation)
1530 (let* ((info-part (artist-mt-get-info-part element))
1531 (unshifted (artist-go-get-unshifted info-part))
1532 (shifted (artist-go-get-shifted info-part))
1533 (unshifted-kwd (artist-go-get-keyword unshifted))
1534 (shifted-kwd (artist-go-get-keyword shifted)))
1535 (list (list unshifted-kwd) (list shifted-kwd))))
1536 ((eq element-tag 'menu)
1537 (let* ((info-part (artist-mt-get-info-part element))
1538 (items (artist-mn-get-items info-part)))
1539 (artist-compute-key-compl-table items)))
1540 (t
1541 nil))))
1542 menu-table))))
1543
1544
1545;
1546; Retrieving a symbol (graphics operation or function-call) from a keyword
1547;
1548
1549(defun artist-mt-get-symbol-from-keyword (kwd)
1550 "Search master table for keyword KWD and return its symbol."
1551 (artist-mt-get-symbol-from-keyword-sub artist-mt kwd))
1552
1553(defun artist-mt-get-symbol-from-keyword-sub (table kwd)
1554 "Search TABLE for keyword KWD and return its symbol."
1555 (catch 'found
b5242984 1556 (mapc
b95b34e5
GM
1557 (lambda (element)
1558 (let ((element-tag (artist-mt-get-tag element)))
1559 (cond ((eq element-tag 'graphics-operation)
1560 (let* ((info-part (artist-mt-get-info-part element))
1561 (unshifted (artist-go-get-unshifted info-part))
1562 (shifted (artist-go-get-shifted info-part))
1563 (unshifted-kwd (artist-go-get-keyword unshifted))
1564 (shifted-kwd (artist-go-get-keyword shifted))
1565 (unshifted-sym (artist-go-get-symbol unshifted))
1566 (shifted-sym (artist-go-get-symbol shifted)))
1567 (if (string-equal kwd unshifted-kwd)
1568 (throw 'found unshifted-sym))
1569 (if (string-equal kwd shifted-kwd)
1570 (throw 'found shifted-sym))))
1571
1572 ((eq element-tag 'function-call)
1573 (let* ((info-part (artist-mt-get-info-part element))
1574 (keyword (artist-fc-get-keyword info-part))
1575 (symbol (artist-fc-get-symbol info-part)))
1576 (if (string-equal kwd keyword)
1577 (throw 'found symbol))))
1578 ((eq element-tag 'menu)
1579 (let* ((info-part (artist-mt-get-info-part element))
1580 (items (artist-mn-get-items info-part))
1581 (answer (artist-mt-get-symbol-from-keyword-sub
1582 items kwd)))
1583 (if answer (throw 'found answer))))
1584 (t
1585 nil))))
1586 table)
1587 nil))
1588
1589
1590;
1591; Retrieving info from a graphics operation symbol
1592;
1593
1594(defun artist-go-retrieve-from-symbol (symbol retrieve-fn)
1595 "Search the master table for a graphics operation SYMBOL.
1596Calls RETRIEVE-FN to retrieve information from that symbol's
1597info-variant-part."
1598 (artist-go-retrieve-from-symbol-sub artist-mt symbol retrieve-fn))
1599
1600(defun artist-go-retrieve-from-symbol-sub (table symbol retrieve-fn)
1601 "Search the TABLE for a graphics operation SYMBOL.
1602Calls RETRIEVE-FN to retrieve information from that symbol's
1603info-variant-part."
1604 (catch 'found
b5242984 1605 (mapc
b95b34e5
GM
1606 (lambda (element)
1607 (let ((element-tag (artist-mt-get-tag element)))
1608 (cond ((eq element-tag 'graphics-operation)
1609 (let* ((info-part (artist-mt-get-info-part element))
1610 (unshifted (artist-go-get-unshifted info-part))
1611 (shifted (artist-go-get-shifted info-part))
1612 (unshifted-sym (artist-go-get-symbol unshifted))
1613 (shifted-sym (artist-go-get-symbol shifted))
1614 (variant-part (cond
1615 ((eq unshifted-sym symbol) unshifted)
1616 ((eq shifted-sym symbol) shifted)
1617 (t nil))))
1618 (if variant-part ; if found do:
1619 (throw 'found (funcall retrieve-fn variant-part)))))
1620
1621 ((eq element-tag 'menu)
1622 (let* ((info-part (artist-mt-get-info-part element))
1623 (items (artist-mn-get-items info-part))
1624 (answer (artist-go-retrieve-from-symbol-sub
1625 items symbol retrieve-fn)))
1626 (if answer (throw 'found answer)))))))
1627
1628 table)
1629 nil))
1630
1631(defun artist-go-get-keyword-from-symbol (symbol)
1632 "Search the master table, get keyword from a graphics operation SYMBOL."
1633 (artist-go-retrieve-from-symbol symbol 'artist-go-get-keyword))
1634
1635(defun artist-go-get-mode-line-from-symbol (symbol)
1636 "Search the master table, get mode-line from a graphics operation SYMBOL."
1637 (artist-go-retrieve-from-symbol symbol 'artist-go-get-mode-line))
1638
1639(defun artist-go-get-arrow-pred-from-symbol (symbol)
1640 "Search the master table, get arrow-pred from a graphics operation SYMBOL."
1641 (artist-go-retrieve-from-symbol symbol 'artist-go-get-arrow-pred))
1642
1643(defun artist-go-get-arrow-set-fn-from-symbol (symbol)
1644 "Search the master table, get arrow-set-fn from a graphics operation SYMBOL."
1645 (artist-go-retrieve-from-symbol symbol 'artist-go-get-arrow-set-fn))
1646
1647(defun artist-go-get-init-fn-from-symbol (symbol)
1648 "Search the master table, get init-fn from a graphics operation SYMBOL."
1649 (artist-go-retrieve-from-symbol symbol 'artist-go-get-init-fn))
1650
1651(defun artist-go-get-prep-fill-fn-from-symbol (symbol)
1652 "Search the master table, get prep-fill-fn from a graphics operation SYMBOL."
1653 (artist-go-retrieve-from-symbol symbol 'artist-go-get-prep-fill-fn))
1654
1655(defun artist-go-get-exit-fn-from-symbol (symbol)
1656 "Search the master table, get exit-fn from a graphics operation SYMBOL."
1657 (artist-go-retrieve-from-symbol symbol 'artist-go-get-exit-fn))
1658
1659(defun artist-go-get-draw-fn-from-symbol (symbol)
1660 "Search the master table, get draw-fn from a graphics operation SYMBOL."
1661 (artist-go-retrieve-from-symbol symbol 'artist-go-get-draw-fn))
1662
1663(defun artist-go-get-draw-how-from-symbol (symbol)
1664 "Search the master table, get draw-how from a graphics operation SYMBOL."
1665 (artist-go-retrieve-from-symbol symbol 'artist-go-get-draw-how))
1666
1667(defun artist-go-get-undraw-fn-from-symbol (symbol)
1668 "Search the master table, get undraw-fn from a graphics operation SYMBOL."
1669 (artist-go-retrieve-from-symbol symbol 'artist-go-get-undraw-fn))
1670
1671(defun artist-go-get-interval-fn-from-symbol (symbol)
1672 "Search the master table, get interval-fn from a graphics operation SYMBOL."
1673 (artist-go-retrieve-from-symbol symbol 'artist-go-get-interval-fn))
1674
1675(defun artist-go-get-fill-pred-from-symbol (symbol)
1676 "Search the master table, get fill-pred from a graphics operation SYMBOL."
1677 (artist-go-retrieve-from-symbol symbol 'artist-go-get-fill-pred))
1678
1679(defun artist-go-get-fill-fn-from-symbol (symbol)
1680 "Search the master table, get fill-fn from a graphics operation SYMBOL."
1681 (artist-go-retrieve-from-symbol symbol 'artist-go-get-fill-fn))
1682
1683(defun artist-go-get-symbol-shift (symbol is-shifted)
1684 "Search for (shifted or unshifted) graphics operation SYMBOL.
1685If IS-SHIFTED is non-nil, return the shifted symbol,
98d92ce3 1686otherwise the unshifted symbol."
b95b34e5
GM
1687 (artist-go-get-symbol-shift-sub artist-mt symbol is-shifted))
1688
1689(defun artist-go-get-symbol-shift-sub (table symbol is-shifted)
1690 "Search TABLE for (shifted or unshifted) graphics SYMBOL.
1691If IS-SHIFTED is non-nil, return the shifted symbol,
98d92ce3 1692otherwise the unshifted symbol."
b95b34e5 1693 (catch 'found
b5242984 1694 (mapc
b95b34e5
GM
1695 (lambda (element)
1696 (let ((element-tag (artist-mt-get-tag element)))
1697 (cond ((eq element-tag 'graphics-operation)
1698 (let* ((info-part (artist-mt-get-info-part element))
1699 (unshift-variant (artist-go-get-unshifted info-part))
1700 (shift-variant (artist-go-get-shifted info-part))
1701 (unshift-sym (artist-go-get-symbol unshift-variant))
1702 (shift-sym (artist-go-get-symbol shift-variant)))
1703 (if (or (eq symbol unshift-sym) (eq symbol shift-sym))
1704 (throw 'found (if is-shifted shift-sym unshift-sym)))))
1705
1706 ((eq element-tag 'menu)
1707 (let* ((info-part (artist-mt-get-info-part element))
1708 (items (artist-mn-get-items info-part))
1709 (answer (artist-go-get-symbol-shift-sub
1710 items symbol is-shifted)))
1711 (if answer (throw 'found answer)))))))
1712
1713 table)
1714 nil))
1715
1716;
1717; Retrieving info from a function-call symbol
1718;
1719
1720(defun artist-fc-retrieve-from-symbol (symbol retrieve-fn)
1721 "Search the master table for a function call SYMBOL.
1722Calls RETRIEVE-FN to retrieve information from that symbol's
1723info-variant-part."
1724 (artist-fc-retrieve-from-symbol-sub artist-mt symbol retrieve-fn))
1725
1726(defun artist-fc-retrieve-from-symbol-sub (table symbol retrieve-fn)
1727 "Search TABLE for a function-call SYMBOL.
1728Calls RETRIEVE-FN to retrieve information from that symbol's
1729info-variant-part."
1730 (catch 'found
b5242984 1731 (mapc
b95b34e5
GM
1732 (lambda (element)
1733 (let ((element-tag (artist-mt-get-tag element)))
1734 (cond ((eq element-tag 'function-call)
1735 (let* ((info-part (artist-mt-get-info-part element))
1736 (fc-symbol (artist-fc-get-symbol info-part)))
1737 (if (eq fc-symbol symbol)
1738 (throw 'found (funcall retrieve-fn info-part)))))
1739
1740 ((eq element-tag 'menu)
1741 (let* ((info-part (artist-mt-get-info-part element))
1742 (items (artist-mn-get-items info-part))
1743 (answer (artist-fc-retrieve-from-symbol-sub
1744 items symbol retrieve-fn)))
1745 (if answer (throw 'found answer)))))))
1746
1747 table)
1748 nil))
1749
1750(defun artist-fc-get-fn-from-symbol (symbol)
1751 "Search the master table to get function from a function call SYMBOL."
1752 (artist-fc-retrieve-from-symbol symbol 'artist-fc-get-fn))
1753
1754
1755;;
1756;; Utilities
1757;;
1758
1759;; Macro that won't funcall the function if it is nil.
1760;;
1761(defmacro artist-funcall (fn &rest args)
3ecd3a56 1762 "Call function FN with ARGS, if FN is not nil."
b95b34e5
GM
1763 (list 'if fn (cons 'funcall (cons fn args))))
1764
b95b34e5
GM
1765(defun artist-uniq (l)
1766 "Remove consecutive duplicates in list L. Comparison is done with `equal'."
1767 (cond ((null l) nil)
1768 ((null (cdr l)) l) ; only one element in list
1769 ((equal (car l) (car (cdr l))) (artist-uniq (cdr l))) ; first 2 equal
1770 (t (cons (car l) (artist-uniq (cdr l)))))) ; first 2 are different
1771
b95b34e5
GM
1772(defun artist-string-split (str r)
1773 "Split string STR at occurrences of regexp R, returning a list of strings."
1774 (let ((res nil)
1775 (start 0)
1776 (match-pos 0))
1777 (while (setq match-pos (string-match r str start))
1778 (setq res (cons (copy-sequence (substring str start match-pos)) res))
1779 (setq start (match-end 0)))
1780 (if (null res)
1781 (list str)
1782 (if (< (match-end 0) (- (length str) 1))
1783 (setq res (cons (substring str (match-end 0) (length str)) res)))
1784 (reverse res))))
1785
1786(defun artist-string-to-file (str file-name)
1787 "Write string STR to file FILE-NAME."
1788 (write-region str 'end-is-ignored file-name nil 'no-message))
1789
1790(defun artist-file-to-string (file-name)
1791 "Read from file FILE-NAME into a string."
1792 (save-excursion
1793 (let ((tmp-buffer (get-buffer-create (concat "*artist-" file-name "*"))))
1794 (set-buffer tmp-buffer)
1795 (goto-char (point-min))
1796 (insert-file-contents file-name nil nil nil t)
1797 (let ((str (copy-sequence (buffer-substring (point-min)
1798 (point-max)))))
1799 (kill-buffer tmp-buffer)
1800 str))))
1801
1802(defun artist-clear-buffer (buf)
1803 "Clear contents of buffer BUF."
1804 (save-excursion
1805 (set-buffer buf)
1806 (goto-char (point-min))
1807 (delete-char (- (point-max) (point-min)) nil)))
1808
a9645a66 1809
b95b34e5
GM
1810(defun artist-system (program stdin &optional program-args)
1811 "Run PROGRAM synchronously with the contents of string STDIN to stdin.
1812Optional args PROGRAM-ARGS are arguments to PROGRAM.
1813Return a list (RETURN-CODE STDOUT STDERR)."
1814 (save-excursion
1815 (let* ((tmp-stdin-file-name (if stdin
6320b362 1816 (make-temp-file
b95b34e5
GM
1817 (concat (file-name-as-directory
1818 (or (getenv "TMPDIR") "/tmp"))
1819 "artist-stdin."))
1820 nil))
1821 (tmp-stdout-buffer (get-buffer-create
1822 (concat "*artist-" program "*")))
6320b362 1823 (tmp-stderr-file-name (make-temp-file
b95b34e5
GM
1824 (concat (file-name-as-directory
1825 (or (getenv "TMPDIR") "/tmp"))
1826 "artist-stdout.")))
1827 (binary-process-input nil) ; for msdos
1828 (binary-process-output nil))
1829
1830 ;; Prepare stdin
1831 (if stdin (artist-string-to-file stdin tmp-stdin-file-name))
1832
1833 ;; Clear the buffer
1834 (artist-clear-buffer tmp-stdout-buffer)
1835
1836 ;; Start the program
1837 (unwind-protect
1838 (let ((res (if program-args
1839 (apply 'call-process
1840 program
1841 tmp-stdin-file-name
1842 (list tmp-stdout-buffer
1843 tmp-stderr-file-name)
1844 nil
1845 (if (stringp program-args)
1846 (list program-args)
1847 program-args))
1848 (apply 'call-process
1849 program
1850 tmp-stdin-file-name
1851 (list tmp-stdout-buffer
1852 tmp-stderr-file-name)
1853 nil))))
1854
1855 ;; the return value
1856 (list res
1857 (save-excursion
1858 (set-buffer tmp-stdout-buffer)
1859 (copy-sequence (buffer-substring (point-min)
1860 (point-max))))
1861 (artist-file-to-string tmp-stderr-file-name)))
1862
1863 ;; Unwind: remove temporary files and buffers
1864 (if (and stdin (file-exists-p tmp-stdin-file-name))
1865 (delete-file tmp-stdin-file-name))
1866 (if (file-exists-p tmp-stderr-file-name)
1867 (delete-file tmp-stderr-file-name))
1868 (if (memq tmp-stdout-buffer (buffer-list))
1869 (kill-buffer tmp-stdout-buffer))))))
1870
1871;; Routines that deal with the buffer
1872;;
1873;; artist-current-line get line number (top of buffer is 0)
1874;;
1875;; artist-move-to-xy move to (x,y) (0,0) is beg-of-buffer
1876;;
1877;; artist-get-char-at-xy get char in at (x,y)
1878;;
1879;; artist-replace-char overwrite (replace) char at point
1880;; artist-replace-chars overwrite (replace) chars at point
1881;;
1882
1883(defsubst artist-current-column ()
1884 "Return point's current column."
1885 (current-column))
1886
1887(defsubst artist-current-line ()
1888 "Return point's current line, buffer-relative. Top of buffer is 0."
1889 (+ (count-lines 1 (point))
1890 (if (= (current-column) 0) 1 0)
1891 -1))
1892
1893(defsubst artist-move-to-xy (x y)
1894 "Move to column X, at row Y from the top of buffer. Top line is 0."
1895 ;;
1896 ;; Q: Why do we do forward-line twice?
1897 ;; A: The documentation for forward-line says
1898 ;;
1899 ;; "... Returns the count of lines left to move. ... With
1900 ;; positive N, a non-empty line at the end counts as one
1901 ;; line successfully moved (for the return value)."
1902 ;;
1903 ;; This means that if we are trying to move forward past the end
1904 ;; of the buffer, and that last line happened to be longer than
1905 ;; the current column, then we end up at the end of that last
1906 ;; line, and forward-line returns one less than we actually
1907 ;; wanted to move.
1908 ;;
1909 ;; Example: In the figure below, the `X' is the very last
1910 ;; character in the buffer ("a non-empty line at the
1911 ;; end"). Suppose point is at at P. Then (forward-line 1)
1912 ;; returns 0 and puts point after the `X'.
1913 ;;
1914 ;; --------top of buffer--------
1915 ;;
1916 ;; P X
1917 ;; -------bottom of buffer------
1918 ;;
1919 ;; But, if we are at the end of buffer when trying to move
1920 ;; forward, then forward-line will return the (for us) correct
1921 ;; value, which is good, because we will come to the end of the
1922 ;; buffer by the first forward-line. The second forward-line
1923 ;; will then get us where we really wanted to go.
1924 ;;
1925 ;; If we are not moving past the end of the buffer, then the
1926 ;; second forward-line will return 0.
1927 ;;
1928 ;; Q: What happens if we are moving upwards?
1929 ;; A: That will work good. insert-char won't insert a negative
1930 ;; number of chars, and forward-line will fail silently if we are
1931 ;; moving past the beginning of the buffer.
1932 ;;
1933 (forward-line (- y (artist-current-line)))
1934 (insert-char ?\n (forward-line (- y (artist-current-line))))
1935 (move-to-column (max x 0) t)
1936 (let ((curr-y (artist-current-line)))
1937 (setq artist-draw-region-min-y (min curr-y artist-draw-region-min-y))
1938 (setq artist-draw-region-max-y (max curr-y artist-draw-region-max-y))))
1939
1940(defsubst artist-get-char-at-xy (x y)
1941 "Return the character found at column X, row Y.
1942Also updates the variables `artist-draw-min-y' and `artist-draw-max-y'."
1943 (artist-move-to-xy x y)
1944 (let ((curr-y (artist-current-line)))
1945 (setq artist-draw-region-min-y (min curr-y artist-draw-region-min-y))
1946 (setq artist-draw-region-max-y (max curr-y artist-draw-region-max-y)))
1947 (following-char))
1948
1949
921d84aa
CY
1950(defsubst artist-get-replacement-char (c)
1951 "Retrieve a replacement for character C from `artist-replacement-table'.
1952The replacement is used to convert tabs and new-lines to spaces."
1953 ;; Characters may be outside the range of the `artist-replacement-table',
1954 ;; for example if they are unicode code points >= 256.
1955 ;; Check so we don't attempt to access the array out of its bounds,
1956 ;; assuming no such character needs to be replaced.
1957 (if (< c (length artist-replacement-table))
1958 (aref artist-replacement-table c)
1959 c))
1960
b95b34e5
GM
1961(defun artist-get-char-at-xy-conv (x y)
1962 "Retrieve the character at X, Y, converting tabs and new-lines to spaces."
1963 (save-excursion
921d84aa 1964 (artist-get-replacement-char (artist-get-char-at-xy x y))))
b95b34e5
GM
1965
1966
1967(defun artist-replace-char (new-char)
1968 "Replace the character at point with NEW-CHAR."
1969 ;; Check that the variable exists first. The doc says it was added in 19.23.
5a047002 1970 (if (and (and (boundp 'emacs-major-version) (= emacs-major-version 20))
b95b34e5
GM
1971 (and (boundp 'emacs-minor-version) (<= emacs-minor-version 3)))
1972 ;; This is a bug workaround for Emacs 20, versions up to 20.3:
1973 ;; The self-insert-command doesn't care about the overwrite-mode,
1974 ;; so the insertion is done in the same way as in picture mode.
1975 ;; This seems to be a little bit slower.
1976 (progn
1977 (artist-move-to-xy (1+ (artist-current-column))
1978 (artist-current-line))
1979 (delete-char -1)
921d84aa 1980 (insert (artist-get-replacement-char new-char)))
b95b34e5
GM
1981 ;; In emacs-19, the self-insert-command works better and faster
1982 (let ((overwrite-mode 'overwrite-mode-textual)
1983 (fill-column 32765) ; Large :-)
1984 (blink-matching-paren nil))
921d84aa 1985 (setq last-command-event (artist-get-replacement-char new-char))
b95b34e5
GM
1986 (self-insert-command 1))))
1987
1988(defun artist-replace-chars (new-char count)
1989 "Replace characters at point with NEW-CHAR. COUNT chars are replaced."
1990 ;; Check that the variable exists first. The doc says it was added in 19.23.
5a047002 1991 (if (and (and (boundp 'emacs-major-version) (= emacs-major-version 20))
b95b34e5
GM
1992 (and (boundp 'emacs-minor-version) (<= emacs-minor-version 3)))
1993 ;; This is a bug workaround for Emacs 20, versions up to 20.3:
1994 ;; The self-insert-command doesn't care about the overwrite-mode,
1995 ;; so the insertion is done in the same way as in picture mode.
1996 ;; This seems to be a little bit slower.
921d84aa 1997 (let* ((replaced-c (artist-get-replacement-char new-char))
5a047002 1998 (replaced-s (make-string count replaced-c)))
b95b34e5
GM
1999 (artist-move-to-xy (+ (artist-current-column) count)
2000 (artist-current-line))
2001 (delete-char (- count))
2002 (insert replaced-s))
2003 ;; In emacs-19, the self-insert-command works better
2004 (let ((overwrite-mode 'overwrite-mode-textual)
2005 (fill-column 32765) ; Large :-)
2006 (blink-matching-paren nil))
921d84aa 2007 (setq last-command-event (artist-get-replacement-char new-char))
b95b34e5
GM
2008 (self-insert-command count))))
2009
2010(defsubst artist-replace-string (string &optional see-thru)
2011 "Replace contents at point with STRING.
98d92ce3 2012With optional argument SEE-THRU set to non-nil, text in the buffer
b95b34e5
GM
2013``shines thru'' blanks in the STRING."
2014 (let ((char-list (append string nil)) ; convert the string to a list
2015 (overwrite-mode 'overwrite-mode-textual)
2016 (fill-column 32765) ; Large :-)
2017 (blink-matching-paren nil))
2018 (while char-list
2019 (let ((c (car char-list)))
921d84aa 2020 (if (and see-thru (= (artist-get-replacement-char c) ?\s))
b95b34e5
GM
2021 (artist-move-to-xy (1+ (artist-current-column))
2022 (artist-current-line))
2023 (artist-replace-char c)))
2024 (setq char-list (cdr char-list)))))
2025
2026;;
2027;; Routines for setting and unsetting points
2028;; Used when not rubber-banding
2029;;
2030(defun artist-no-rb-unset-point1 ()
2031 "Unsets point 1 when not rubber-banding."
2032 (let ((x-now (artist-current-column))
2033 (y-now (artist-current-line))
2034 (x (aref artist-rb-save-data 0))
2035 (y (aref artist-rb-save-data 1)))
2036 (artist-move-to-xy x y)
2037 (artist-replace-char (aref artist-rb-save-data 2))
2038 (artist-move-to-xy x-now y-now)))
2039
2040(defun artist-no-rb-set-point1 (x y)
2041 "Set point 1 at X, Y when not rubber-banding."
2042 (let ((x-now (artist-current-column))
2043 (y-now (artist-current-line)))
2044 (aset artist-rb-save-data 0 x)
2045 (aset artist-rb-save-data 1 y)
2046 (aset artist-rb-save-data 2 (artist-get-char-at-xy x y))
2047 (artist-move-to-xy x y)
2048 (artist-replace-char artist-first-char)
2049 (artist-move-to-xy x-now y-now)
2050 (aset artist-rb-save-data 6 0)))
2051
2052(defun artist-no-rb-unset-point2 ()
2053 "This function unsets point 2 when not rubber-banding."
2054 (if (= (aref artist-rb-save-data 6) 1)
2055 (let ((x-now (artist-current-column))
2056 (y-now (artist-current-line))
2057 (x (aref artist-rb-save-data 3))
2058 (y (aref artist-rb-save-data 4)))
2059 (artist-move-to-xy x y)
2060 (artist-replace-char (aref artist-rb-save-data 5))
2061 (artist-move-to-xy x-now y-now))))
2062
2063(defun artist-no-rb-set-point2 (x y)
2064 "Set point 2 at X, Y when not rubber-banding."
2065 (let ((x-now (artist-current-column))
2066 (y-now (artist-current-line)))
2067 (aset artist-rb-save-data 3 x)
2068 (aset artist-rb-save-data 4 y)
2069 (aset artist-rb-save-data 5 (artist-get-char-at-xy x y))
2070 (artist-move-to-xy x y)
2071 (artist-replace-char artist-second-char)
2072 (artist-move-to-xy x-now y-now)
2073 (aset artist-rb-save-data 6 1)))
2074
2075(defun artist-no-rb-unset-points ()
2076 "This function unsets point 1 and 2 when not rubber-banding."
2077 (artist-no-rb-unset-point1)
2078 (artist-no-rb-unset-point2))
2079
2080
2081;; artist-intersection-char
2082;;
2083;; Note: If changing this, see the notes for artist-unintersection-char
2084;; and artist-vaporize-lines
2085;;
2086(defun artist-intersection-char (new-c old-c)
2087 "Calculates intersection character when drawing a NEW-C on top of an OLD-C.
2088Return character according to this scheme:
2089
2090 OLD-C NEW-C return
2091 - | +
2092 | - +
2093 + | +
2094 + - +
2095 \\ / X
2096 / \\ X
2097 X / X
2098 X \\ X
2099 other combinations NEW-C"
2100
2101 (cond ((and (= old-c ?- ) (= new-c ?| )) ?+ )
2102 ((and (= old-c ?| ) (= new-c ?- )) ?+ )
2103 ((and (= old-c ?+ ) (= new-c ?- )) ?+ )
2104 ((and (= old-c ?+ ) (= new-c ?| )) ?+ )
2105 ((and (= old-c ?\\ ) (= new-c ?/ )) ?X )
2106 ((and (= old-c ?/ ) (= new-c ?\\ )) ?X )
2107 ((and (= old-c ?X ) (= new-c ?/ )) ?X )
2108 ((and (= old-c ?X ) (= new-c ?\\ )) ?X )
2109 (t new-c)))
2110
2111;; artist-unintersection-char
2112;;
2113;; Note: If changing this, see the note for artist-vaporize-lines
2114;;
2115(defun artist-unintersection-char (line-c buffer-c)
2116 "Restore character to before intersection when removing LINE-C from BUFFER-C.
2117Return character according to this scheme:
2118
2119 LINE-C BUFFER-C return
2120 - + |
2121 | + -
2122 \\ X /
2123 / X \\
2124 other combinations `artist-erase-char'."
2125
2126 (cond ((and (= line-c ?- ) (= buffer-c ?+ )) ?| )
2127 ((and (= line-c ?| ) (= buffer-c ?+ )) ?- )
2128 ((and (= line-c ?\\ ) (= buffer-c ?X )) ?/ )
2129 ((and (= line-c ?/ ) (= buffer-c ?X )) ?\\ )
2130 ((= line-c buffer-c) artist-erase-char)
2131 (t buffer-c)))
2132
2133
2134;; Computing the line-char to use
2135;; for use with borderless shapes
2136;;
2137(defsubst artist-compute-line-char ()
2138 "Compute which character to use for lines, if any.
2139Return value is either nil for the default characters that make up lines, or
2140a character chosen depending on the variables `artist-borderless-shapes',
2141`artist-fill-char-set', `artist-fill-char' and
2142`artist-line-char-set' and `artist-line-char'."
2143 (if (and artist-borderless-shapes artist-fill-char-set)
2144 artist-fill-char
2145 (if artist-line-char-set
2146 artist-line-char
2147 nil)))
2148
2149
2150;; Things for drawing horizontal, vertical and diagonal (straight) lines.
2151;;
2152;; A line here is a vector:
2153;; [ start-x start-y length direction saved-char-1 saved-char-2 ... ]
2154;; directions start with 0 at the x-axis and counts anti clockwise.
2155;;
2156(defvar artist-direction-info
2157 ;; x y char
2158 [ [ 1 0 ?- ] ; direction 0
2159 [ 1 1 ?\\ ] ; direction 1
2160 [ 0 1 ?| ] ; direction 2
2161 [ -1 1 ?/ ] ; direction 3
2162 [ -1 0 ?- ] ; direction 4
2163 [ -1 -1 ?\\ ] ; direction 5
2164 [ 0 -1 ?| ] ; direction 6
2165 [ 1 -1 ?/ ] ] ; direction 7
2166 "Table used for stepping x and y coordinates in a specific direction.
2167This table is also used for determining which char to use for that direction.")
2168
2169(defsubst artist-direction-step-x (direction)
2170 "Return the x-step for DIRECTION from the `artist-direction-info' table."
2171 (aref (aref artist-direction-info direction) 0))
2172
2173(defsubst artist-direction-step-y (direction)
2174 "Return the y-step for DIRECTION from the `artist-direction-info' table."
2175 (aref (aref artist-direction-info direction) 1))
2176
2177(defun artist-direction-char (direction)
2178 "Return the character for DIRECTION from the `artist-direction-info' table."
2179 (aref (aref artist-direction-info direction) 2))
2180
2181;; artist-find-direction
2182;;
2183;;
2184;;
2185(defun artist-find-direction (x1 y1 x2 y2)
2186 "Find the direction from point X1,Y1 to X2,Y2.
2187Returns a DIRECTION, a number 0--7, coded as follows:
2188
2189 5 6 7
2190 \\ | /
2191 4 - * - 0
2192 / | \\
2193 3 2 1"
2194 (let ((delta-x (- x2 x1))
2195 (delta-y (- y2 y1)))
2196 (cond ((>= delta-x (* 2 (abs delta-y))) 0)
2197 ((>= delta-y (* 2 (abs delta-x))) 2)
2198 ((>= (- delta-x) (* 2 (abs delta-y))) 4)
2199 ((>= (- delta-y) (* 2 (abs delta-x))) 6)
2200 ((and (>= delta-x 0) (>= delta-y 0)) 1)
2201 ((and (<= delta-x 0) (>= delta-y 0)) 3)
2202 ((and (<= delta-x 0) (<= delta-y 0)) 5)
2203 ((and (>= delta-x 0) (<= delta-y 0)) 7))))
2204
2205(defun artist-straight-calculate-length (direction x1 y1 x2 y2)
2206 "Calculate length for a straight line in DIRECTION from X1,Y1 to X2,Y2."
2207 (cond ((or (= direction 7)
2208 (= direction 0)
2209 (= direction 1)) (1+ (- x2 x1)))
2210 ((or (= direction 3)
2211 (= direction 4)
2212 (= direction 5)) (1+ (- x1 x2)))
2213 (t (1+ (abs (- y2 y1))))))
2214
2215(defun artist-sline (x1 y1 x2 y2)
2216 "Create a straight line from X1,Y1 to X2,Y2."
2217 (let* ((direction (artist-find-direction x1 y1 x2 y2))
2218 (length (artist-straight-calculate-length direction x1 y1 x2 y2))
2219 (line (make-vector (+ length 4) x1)))
2220 ;; not needed:
2221 ;; (aset line 0 x1)
2222 ;; because we set all elements to x1
2223 (aset line 1 y1)
2224 (aset line 2 length)
2225 (aset line 3 direction)
2226 line))
2227
2228(defun artist-save-chars-under-sline (line)
2229 "Save characters under a LINE."
2230 (let ((x (aref line 0))
2231 (y (aref line 1))
2232 (length (+ (aref line 2) 4))
2233 (direction (aref line 3))
2234 (i 4))
2235 (while (< i length)
2236 (aset line i (artist-get-char-at-xy x y))
2237 (setq x (+ x (artist-direction-step-x direction)))
2238 (setq y (+ y (artist-direction-step-y direction)))
2239 (setq i (1+ i))))
2240 line)
2241
2242
2243
2244;; Things for drawing lines in all directions.
2245;; The line drawing engine is the eight-point alrogithm.
2246;;
2247;; A line is here a list of (x y saved-char new-char)s.
2248;;
2249(defvar artist-octant-info
2250 ;; Initial Step in Step in
2251 ;; coeffs x and y x and y
2252 ;; for if q >= 0 if g < 0
2253 ;; dfdx,dfdy
2254 [ [ 2 1 1 0 1 1 ] ; 1st octant
2255 [ 1 2 1 1 0 1 ] ; 2nd octant
2256 [ -1 2 0 1 -1 1 ] ; 3rd octant
2257 [ -2 1 -1 1 -1 0 ] ; 4th octant
2258 [ -2 -1 -1 0 -1 -1 ] ; 5th octant
2259 [ -1 -2 -1 -1 0 -1 ] ; 6th octant
2260 [ 1 -2 0 -1 1 -1 ] ; 7th octant
2261 [ 2 -1 1 -1 1 0 ] ] ; 8th octant
2262 "Table used by line drawing algorithm (eight point).")
2263
2264;; Primitives for the artist-octant-info.
2265;; Decrease octant by 1 since elt counts from 0 and octant counts from 1.
2266;;
2267(defsubst artist-get-dfdx-init-coeff (octant)
2268 "Retrieve dfdx component for OCTANT."
2269 (aref (aref artist-octant-info (- octant 1)) 0))
2270
2271(defsubst artist-get-dfdy-init-coeff (octant)
2272 "Retrieve dfdy component for OCTANT."
2273 (aref (aref artist-octant-info (- octant 1)) 1))
2274
2275(defsubst artist-get-x-step-q>=0 (octant)
2276 "Retrieve x-step component for OCTANT when q >= 0."
2277 (aref (aref artist-octant-info (- octant 1)) 2))
2278
2279(defsubst artist-get-y-step-q>=0 (octant)
2280 "Retrieve y-step component for OCTANT when q >= 0."
2281 (aref (aref artist-octant-info (- octant 1)) 3))
2282
2283(defsubst artist-get-x-step-q<0 (octant)
2284 "Retrieve x-step component for OCTANT for q < 0."
2285 (aref (aref artist-octant-info (- octant 1)) 4))
2286
2287(defsubst artist-get-y-step-q<0 (octant)
2288 "Retrieve y-step component for OCTANT for q < 0."
2289 (aref (aref artist-octant-info (- octant 1)) 5))
2290
2291
2292;; Find octant from x1 y1 x2 y2 coordinates.
2293;;
2294(defun artist-find-octant (x1 y1 x2 y2)
2295 "Find octant for a line from X1,Y1 to X2,Y2.
2296Octant are numbered 1--8, anti-clockwise as:
2297
2298 \\3|2/
2299 4\\|/1
2300 ---+---
2301 5/|\\8
2302 /6|7\\"
2303
2304 (if (<= x1 x2) ; quadrant 1 or 4
2305 (if (<= y1 y2) ; quadrant 1, octant 1 or 2
2306 (if (>= (- x2 x1) (- y2 y1))
2307 1
2308 2)
2309 (if (>= (- x2 x1) (- (- y2 y1))) ; quadrant 4, octant 7 or 8
2310 8
2311 7))
2312 (if (<= y1 y2) ; quadrant 2 or 3
2313 (if (>= (- (- x2 x1)) (- y2 y1)) ; quadrant 2, octant 3 or 4
2314 4
2315 3)
2316 (if (>= (- (- x2 x1)) (- (- y2 y1))) ; quadrant 3, octant 5 or 6
2317 5
2318 6))))
2319
2320;; Some inline funtions for creating, setting and reading
2321;; members of a coordinate
2322;;
98d92ce3 2323
b95b34e5
GM
2324(defsubst artist-new-coord (x y &optional new-char)
2325 "Create a new coordinate at X,Y for use in a line.
2326Optional argument NEW-CHAR can be used for setting the new-char component
2327in the coord."
2328 (let ((coord (make-vector 4 x)))
2329 (aset coord 1 y)
2330 (aset coord 3 new-char)
2331 coord))
2332
2333(defsubst artist-coord-get-x (coord)
2334 "Retrieve the x component of a COORD."
2335 (aref coord 0))
2336
2337(defsubst artist-coord-get-y (coord)
2338 "Retrieve the y component of a COORD."
2339 (aref coord 1))
2340
2341(defsubst artist-coord-set-x (coord new-x)
2342 "Set the x component of a COORD to NEW-X."
2343 (aset coord 0 new-x)
2344 coord)
2345
2346(defsubst artist-coord-set-y (coord new-y)
2347 "Set the y component of a COORD to NEW-Y."
2348 (aset coord 1 new-y)
2349 coord)
2350
2351(defsubst artist-coord-get-saved-char (coord)
2352 "Retrieve the saved char component of a COORD."
2353 (aref coord 2))
2354
2355(defsubst artist-coord-get-new-char (coord)
2356 "Retrieve the new char component of a COORD."
2357 (aref coord 3))
2358
2359(defsubst artist-coord-add-saved-char (coord saved-char)
2360 "Set the saved char component of a COORD to SAVED-CHAR."
2361 (aset coord 2 saved-char)
2362 coord)
2363
2364(defsubst artist-coord-add-new-char (coord new-char)
2365 "Set the new char component of a COORD to NEW-CHAR."
2366 (aset coord 3 new-char)
2367 coord)
2368
2369(defsubst artist-coord-set-new-char (coord new-char)
2370 "Set the new char component of a COORD to NEW-CHAR."
2371 (aset coord 3 new-char)
2372 coord)
2373
2374
2375;; Pretend we are plotting a pixel. Instead we just list it
2376;;
2377(defmacro artist-put-pixel (point-list x y)
2378 "In POINT-LIST, store a ``pixel'' at coord X,Y."
2379 (list 'setq point-list
2380 (list 'append point-list (list 'list (list 'artist-new-coord x y)))))
2381
2382;; Calculate list of points using eight point algorithm
2383;; return a list of coords
2384;;
2385(defun artist-eight-point (x1 y1 x2 y2)
2386 "Run the eight-point algorithm to get a list of coords from X1,Y1 to X2,Y2."
2387 (let* ((point-list nil)
2388 (octant (artist-find-octant x1 y1 x2 y2))
2389 (dfdx-coeff (artist-get-dfdx-init-coeff octant))
2390 (dfdy-coeff (artist-get-dfdy-init-coeff octant))
2391 (x-step-q>=0 (artist-get-x-step-q>=0 octant))
2392 (y-step-q>=0 (artist-get-y-step-q>=0 octant))
2393 (x-step-q<0 (artist-get-x-step-q<0 octant))
2394 (y-step-q<0 (artist-get-y-step-q<0 octant))
2395 (dfdx (- (- y2 y1)))
2396 (dfdy (- x2 x1))
2397 (x x1)
2398 (y y1)
2399 (f 0)
2400 (q (+ (* 2 f)
2401 (* dfdx-coeff dfdx)
2402 (* dfdy-coeff dfdy))))
2403 (artist-put-pixel point-list x y)
2404 (while (or (not (eq x x2)) (not (eq y y2)))
2405 (if (>= q 0)
2406 (progn
2407 (setq x (+ x x-step-q>=0))
2408 (setq y (+ y y-step-q>=0))
2409 (setq f (+ f (* x-step-q>=0 dfdx) (* y-step-q>=0 dfdy))))
2410 (progn
2411 (setq x (+ x x-step-q<0))
2412 (setq y (+ y y-step-q<0))
2413 (setq f (+ f (* x-step-q<0 dfdx) (* y-step-q<0 dfdy)))))
2414 (setq q (+ (* 2 f) (* dfdx-coeff dfdx) (* dfdy-coeff dfdy)))
2415 (artist-put-pixel point-list x y))
2416 point-list))
2417
2418;; artist-save-chars-under-point-list
2419;; Remebers the chars that were there before we did draw the line.
2420;; Returns point-list.
2421;;
2422(defun artist-save-chars-under-point-list (point-list)
2423 "Save characters originally under POINT-LIST."
2424 (mapcar
2425 (lambda (coord)
2426 (artist-coord-add-saved-char
2427 coord
2428 (artist-get-char-at-xy (artist-coord-get-x coord)
2429 (artist-coord-get-y coord))))
2430 point-list))
2431
2432;; artist-calculate-new-char, artist-calculate-new-chars
2433;; Calculates which char to insert depending on direction of point-list.
2434;;
2435;; Depending on new-coord's position relative to last-coord one of the
2436;; following chars are returned: \ | / - o, as indicated by this:
2437;;
2438;; \ | /
2439;; - o -
2440;; / | \
2441;;
2442;; artist-calculate-new-char works on one coordinate, returns char.
2443;; artist-calculate-new-chars works on a point-list, returns point-list.
2444;;
2445(defun artist-calculate-new-char (last-coord new-coord)
2446 "Return a line-char to use when moving from LAST-COORD to NEW-COORD."
2447 (let ((last-x (artist-coord-get-x last-coord))
2448 (last-y (artist-coord-get-y last-coord))
2449 (new-x (artist-coord-get-x new-coord))
2450 (new-y (artist-coord-get-y new-coord)))
2451 (cond ((> new-x last-x) (cond ((< new-y last-y) ?/ )
2452 ((> new-y last-y) ?\\ )
2453 (t ?- )))
2454 ((< new-x last-x) (cond ((< new-y last-y) ?\\ )
2455 ((> new-y last-y) ?/ )
2456 (t ?- )))
2457 ((eq new-y last-y) ?o)
2458 (t ?| ))))
2459
2460(defun artist-calculate-new-chars (point-list)
2461 "Return a list of coords with line-chars calculated. Input: POINT-LIST."
2462 (if (null (cdr point-list))
2463 (list (artist-coord-add-new-char (car point-list) ?o ))
2464 (let ((last-coord (car point-list)))
2465 (cons (artist-coord-add-new-char
2466 (car point-list)
2467 (artist-calculate-new-char (car (cdr point-list))
2468 (car point-list)))
2469 (mapcar
2470 (lambda (this-coord)
2471 (prog1
2472 (artist-coord-add-new-char
2473 this-coord
2474 (artist-calculate-new-char last-coord this-coord))
2475 (setq last-coord this-coord)))
2476 (cdr point-list))))))
2477
2478;; artist-modify-new-chars
2479;; Replaces some characters with some other characters.
2480;;
2481;; artist-modify-new-chars works on a point-list, returns point-list.
2482;;
2483(defun artist-modify-new-chars (point-list)
2484 "Replace intersecting characters in POINT-LIST.
2485This function returns a point-list."
2486 (mapcar
2487 (lambda (coord)
2488 (let* ((new-c (artist-coord-get-new-char coord))
2489 (saved-c (artist-coord-get-saved-char coord))
2490 (modified-c (artist-intersection-char new-c saved-c)))
2491 (artist-coord-set-new-char coord modified-c)))
2492 point-list))
2493
2494
2495;;
2496;; functions for accessing endoints and elements in object requiring
2497;; 2 endpoints
2498;;
2499
2500(defun artist-make-endpoint (x y)
2501 "Create an endpoint at X, Y."
2502 (let ((new-endpoint (make-vector 2 x)))
2503 (aset new-endpoint 1 y)
2504 new-endpoint))
2505
2506(defun artist-endpoint-get-x (endpoint)
2507 "Retrieve the x component of an ENDPOINT."
2508 (aref endpoint 0))
2509
2510(defun artist-endpoint-get-y (endpoint)
2511 "Retrieve the y component of an ENDPOINT."
2512 (aref endpoint 1))
2513
2514(defun artist-make-2point-object (endpoint1 endpoint2 shapeinfo)
2515 "Create a 2-point object of ENDPOINT1, ENDPOINT2 and SHAPEINFO."
2516 (list endpoint1 endpoint2 shapeinfo))
2517
2518(defun artist-2point-get-endpoint1 (obj)
2519 "Retrieve the first endpoint of a 2-point object OBJ."
2520 (elt obj 0))
2521
2522(defun artist-2point-get-endpoint2 (obj)
2523 "Retrieve the second endpoint of a 2-point object OBJ."
2524 (elt obj 1))
2525
2526(defun artist-2point-get-shapeinfo (obj)
2527 "Retrieve the shapeinfo component of a 2-point object OBJ."
2528 (elt obj 2))
2529
2530
2531;;
2532;; Drawing and undrawing lines (any direction)
2533;;
2534
2535(defun artist-draw-line (x1 y1 x2 y2)
98d92ce3 2536 "Draw a line from X1, Y1 to X2, Y2.
b95b34e5
GM
2537
2538Output is a line, which is a list (END-POINT-1 END-POINT-2 SHAPE-INFO).
2539
2540END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
2541SHAPE-INFO is a list of vectors [X Y SAVED-CHAR NEW-CHAR]."
2542 (let ((endpoint1 (artist-make-endpoint x1 y1))
2543 (endpoint2 (artist-make-endpoint x2 y2)))
2544 (artist-make-2point-object
2545 endpoint1
2546 endpoint2
2547 (mapcar
2548 (lambda (coord)
2549 (artist-move-to-xy (artist-coord-get-x coord)
2550 (artist-coord-get-y coord))
2551 (if artist-line-char-set
2552 (artist-replace-char artist-line-char)
2553 (artist-replace-char (artist-coord-get-new-char coord)))
2554 coord)
2555 (artist-modify-new-chars
2556 (artist-calculate-new-chars
2557 (artist-save-chars-under-point-list
2558 (artist-eight-point x1 y1 x2 y2))))))))
2559
2560(defun artist-undraw-line (line)
98d92ce3 2561 "Undraw LINE."
b95b34e5
GM
2562 (mapcar
2563 (lambda (coord)
2564 (artist-move-to-xy (artist-coord-get-x coord)
2565 (artist-coord-get-y coord))
2566 (artist-replace-char (artist-coord-get-saved-char coord))
2567 coord)
2568 (artist-2point-get-shapeinfo line)))
2569
2570;;
2571;; Drawing and undrawing straight lines
2572;;
2573
2574(defun artist-draw-sline (x1 y1 x2 y2)
98d92ce3 2575 "Draw a straight line from X1, Y1 to X2, Y2.
b95b34e5
GM
2576Straight lines are vertical, horizontal or diagonal lines.
2577They are faster to draw and most often they are what you need
2578when drawing a simple image.
2579
2580Output is a straight line, which is a list on the form
b27a51db 2581\(END-POINT-1 END-POINT-2 SHAPE-INFO).
b95b34e5
GM
2582
2583END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
2584SHAPE-INFO is a vector [START-X START-Y LENGTH-OF-LINE DIRECTION
2585 ORIGINAL-CHAR-1 ORIGINAL-CHAR-2 ... ]."
2586 (let* ((line (artist-save-chars-under-sline (artist-sline x1 y1 x2 y2)))
2587 (x (aref line 0))
2588 (y (aref line 1))
2589 (length (+ (aref line 2) 4))
2590 (direction (aref line 3))
2591 (line-char (artist-direction-char direction))
2592 (i 4)
2593 (endpoint1 (artist-make-endpoint x y))
2594 (endpoint2 nil))
2595 (while (< i length)
2596 (artist-move-to-xy x y)
2597 (if artist-line-char-set
2598 (artist-replace-char artist-line-char)
2599 (artist-replace-char (artist-intersection-char
2600 line-char
2601 (aref line i))))
2602 (if (not (< (1+ i) length))
2603 ;; This is the last element. Set the second endpoint
2604 (setq endpoint2 (artist-make-endpoint x y)))
2605 (setq x (+ x (artist-direction-step-x direction)))
2606 (setq y (+ y (artist-direction-step-y direction)))
2607 (setq i (1+ i)))
2608 (artist-make-2point-object endpoint1 endpoint2 line)))
2609
2610
2611(defun artist-undraw-sline (line)
2612 "Undraw a straight line LINE."
2613 (if line
2614 (let* ((shape-info (artist-2point-get-shapeinfo line))
2615 (x (aref shape-info 0))
2616 (y (aref shape-info 1))
2617 (length (+ (aref shape-info 2) 4))
2618 (direction (aref shape-info 3))
2619 (i 4))
2620 (while (< i length)
2621 (artist-move-to-xy x y)
2622 (artist-replace-char (aref shape-info i))
2623 (setq x (+ x (artist-direction-step-x direction)))
2624 (setq y (+ y (artist-direction-step-y direction)))
2625 (setq i (1+ i))))))
2626
2627
2628;;
2629;; Drawing and undrawing rectangles and squares
2630;;
2631
2632(defun artist-draw-rect (x1 y1 x2 y2)
98d92ce3 2633 "Draw a rectangle with corners at X1, Y1 and X2, Y2.
b95b34e5
GM
2634
2635Output is a rectangle, which is a list on the form
b27a51db 2636\(END-POINT-1 END-POINT-2 SHAPE-INFO).
b95b34e5
GM
2637
2638END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
2639SHAPE-INFO is a list of four straight lines."
2640 (let* ((artist-line-char (artist-compute-line-char))
2641 (artist-line-char-set artist-line-char)
2642 (line1 (artist-draw-sline x1 y1 x2 y1))
2643 (line2 (artist-draw-sline x2 y1 x2 y2))
2644 (line3 (artist-draw-sline x2 y2 x1 y2))
2645 (line4 (artist-draw-sline x1 y2 x1 y1))
2646 (endpoint1 (artist-make-endpoint x1 y1))
2647 (endpoint2 (artist-make-endpoint x2 y2)))
2648 (artist-make-2point-object endpoint1
2649 endpoint2
2650 (list line1 line2 line3 line4))))
2651
2652(defun artist-undraw-rect (rectangle)
98d92ce3 2653 "Undraw RECTANGLE."
b95b34e5
GM
2654 (if rectangle
2655 (let ((shape-info (artist-2point-get-shapeinfo rectangle)))
2656 (artist-undraw-sline (elt shape-info 3))
2657 (artist-undraw-sline (elt shape-info 2))
2658 (artist-undraw-sline (elt shape-info 1))
2659 (artist-undraw-sline (elt shape-info 0)))))
2660
2661
2662(defun artist-rect-corners-squarify (x1 y1 x2 y2)
2663 "Compute square corners from rectangle corners at X1, Y1 and X2, Y2.
98d92ce3
JB
2664The square's first corner will be X1, Y1. The position of the second
2665corner depends on which of X2 and Y2 is most far away from X1, Y1."
b95b34e5
GM
2666 (let* ((delta-x (- x2 x1))
2667 (delta-y (- y2 y1))
2668 (delta-x-sign (if (< delta-x 0) -1 1))
2669 (delta-y-sign (if (< delta-y 0) -1 1))
2670 (new-x2) ; set below
2671 (new-y2)) ; set below
2672
2673 ;; Check which of x2 and y2 is most distant
2674 ;; take care to the aspect ratio
2675 (if (> (abs delta-x) (abs delta-y))
2676
2677 ;; *** x2 more distant than y2 (with care taken to aspect ratio)
2678 (progn
2679 (setq new-x2 x2)
2680 (setq new-y2 (+ y1 (round (/ (* (abs delta-x) delta-y-sign)
2681 artist-aspect-ratio)))))
2682
2683 ;; *** y2 more distant than x2 (with care taken to aspect ratio)
2684 (progn
2685 (setq new-x2 (round (+ x1 (* (* (abs delta-y) delta-x-sign)
2686 artist-aspect-ratio))))
2687 (setq new-y2 y2)))
2688
2689 ;; Return this
2690 (list x1 y1 new-x2 new-y2)))
2691
2692
2693(defun artist-draw-square (x1 y1 x2 y2)
2694 "Draw a square with corners at X1, Y1 and X2, Y2.
2695
2696Output is a square, which is a list on the form
b27a51db 2697\(END-POINT-1 END-POINT-2 SHAPE-INFO).
b95b34e5
GM
2698
2699END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
2700SHAPE-INFO is a list of four straight lines."
2701 (let* ((artist-line-char (artist-compute-line-char))
2702 (artist-line-char-set artist-line-char)
2703 (square-corners (artist-rect-corners-squarify x1 y1 x2 y2))
2704 (new-x1 (elt square-corners 0))
2705 (new-y1 (elt square-corners 1))
2706 (new-x2 (elt square-corners 2))
2707 (new-y2 (elt square-corners 3))
2708 (endpoint1 (artist-make-endpoint new-x1 new-y1))
2709 (endpoint2 (artist-make-endpoint new-x2 new-y2))
2710 (line1 (artist-draw-sline new-x1 new-y1 new-x2 new-y1))
2711 (line2 (artist-draw-sline new-x2 new-y1 new-x2 new-y2))
2712 (line3 (artist-draw-sline new-x2 new-y2 new-x1 new-y2))
2713 (line4 (artist-draw-sline new-x1 new-y2 new-x1 new-y1)))
2714 (artist-make-2point-object endpoint1
2715 endpoint2
2716 (list line1 line2 line3 line4))))
2717
2718(defun artist-undraw-square (square)
98d92ce3 2719 "Undraw SQUARE."
b95b34e5
GM
2720 (if square
2721 (let ((shape-info (artist-2point-get-shapeinfo square)))
2722 (artist-undraw-sline (elt shape-info 3))
2723 (artist-undraw-sline (elt shape-info 2))
2724 (artist-undraw-sline (elt shape-info 1))
2725 (artist-undraw-sline (elt shape-info 0)))))
2726
2727;;
2728;; Filling rectangles and squares
2729;;
2730
2731(defun artist-fill-rect (rect x1 y1 x2 y2)
2732 "Fill rectangle RECT from X1,Y1 to X2,Y2."
2733 (let ((x (1+ (min x1 x2)))
2734 (y (1+ (min y1 y2)))
2735 (x-max (max x1 x2))
2736 (y-max (max y1 y2)))
2737 (let ((w (- x-max x)))
2738 (while (< y y-max)
2739 (artist-move-to-xy x y)
2740 (artist-replace-chars artist-fill-char w)
2741 (setq y (1+ y))))))
2742
2743(defun artist-fill-square (square x1 y1 x2 y2)
98d92ce3 2744 "Fill a SQUARE from X1,Y1 to X2,Y2."
b95b34e5
GM
2745 (let* ((square-corners (artist-rect-corners-squarify x1 y1 x2 y2))
2746 (new-x1 (elt square-corners 0))
2747 (new-y1 (elt square-corners 1))
2748 (new-x2 (elt square-corners 2))
2749 (new-y2 (elt square-corners 3))
2750 (x (1+ (min new-x1 new-x2)))
2751 (y (1+ (min new-y1 new-y2)))
2752 (x-max (max new-x1 new-x2))
2753 (y-max (max new-y1 new-y2))
2754 (w (- x-max x)))
2755 (while (< y y-max)
2756 (artist-move-to-xy x y)
2757 (artist-replace-chars artist-fill-char w)
2758 (setq y (1+ y)))))
2759
2760
2761;;
2762;; Pen drawing
2763;;
2764
2765(defun artist-pen (x1 y1)
98d92ce3 2766 "Draw a character at X1, Y1.
b95b34e5
GM
2767The character is replaced with the character in `artist-fill-char'."
2768 (artist-move-to-xy x1 y1)
2769 (artist-replace-char (if artist-line-char-set
2770 artist-line-char
2771 (if artist-fill-char-set
2772 artist-fill-char
2773 artist-default-fill-char))))
2774
2775
2776(defun artist-pen-line (x1 y1)
98d92ce3 2777 "Draw a line from last pen position to X1, Y1.
b95b34e5
GM
2778The character is replaced with the character in `artist-fill-char'.
2779This will store all points in `artist-key-poly-point-list' in reversed
2780order (I assume it is faster to cons to the beginning of the list than
2781to append to the end of the list, when doing free-hand drawing)."
2782 (let ((artist-line-char (if artist-line-char-set
2783 artist-line-char
2784 (if artist-fill-char-set
2785 artist-fill-char
2786 artist-default-fill-char))))
2787
2788 ;; Draw line from last point to this
2789 (let ((x-last (car (car artist-key-poly-point-list)))
2790 (y-last (cdr (car artist-key-poly-point-list))))
2791 (artist-move-to-xy x-last y-last)
2792 (artist-replace-char artist-line-char)
2793 (artist-draw-line x-last y-last x1 y1))
2794
2795 ;; Update the point-list
2796 (setq artist-key-poly-point-list
2797 (cons (cons x1 y1) artist-key-poly-point-list))))
2798
2799(defun artist-pen-reset-last-xy (x1 y1)
2800 "Reset the last x and y points to X1, Y1 when doing pen-drawing."
2801 (artist-clear-arrow-points)
2802 (setq artist-key-poly-point-list (list (cons x1 y1))))
2803
2804
2805(defun artist-pen-set-arrow-points (x1 y1)
2806 "Set arrow points for pen drawing using X1, Y1.
2807Also, the `artist-key-poly-point-list' is reversed."
2808
2809 (setq artist-key-poly-point-list
2810 (artist-uniq artist-key-poly-point-list))
2811
2812 (if (>= (length artist-key-poly-point-list) 2)
2813
2814 ;; Only set arrow-points if the point-list has two or more entries
2815 (let ((xn (car (car artist-key-poly-point-list)))
2816 (yn (cdr (car artist-key-poly-point-list)))
2817 (xn-1 (car (car (cdr artist-key-poly-point-list))))
2818 (yn-1 (cdr (car (cdr artist-key-poly-point-list))))
2819 (dirn)) ; direction for point n
2820 (setq artist-key-poly-point-list (reverse artist-key-poly-point-list))
2821 (let ((x0 (car (car artist-key-poly-point-list)))
2822 (y0 (cdr (car artist-key-poly-point-list)))
2823 (x1 (car (car (cdr artist-key-poly-point-list))))
2824 (y1 (cdr (car (cdr artist-key-poly-point-list))))
2825 (dir0)) ; direction for point 0
2826 (setq dir0 (artist-find-direction x1 y1 x0 y0))
2827 (setq dirn (artist-find-direction xn-1 yn-1 xn yn))
2828 (setq artist-arrow-point-1 (artist-make-arrow-point x0 y0 dir0))
2829 (setq artist-arrow-point-2 (artist-make-arrow-point xn yn dirn))))))
2830
2831
2832;;
2833;; Text rendering
2834;;
2835(defun artist-figlet-run (text font extra-args)
2836 "Run figlet rendering TEXT using FONT.
2837EXTRA-ARGS for figlet, for the command line, may be specified."
2838 (let* ((figlet-args (cond ((and font extra-args)
2839 (cons (concat "-f" font)
2840 (artist-string-split extra-args "[ \t]+")))
2841 (font (concat "-f" font))
2842 (extra-args
2843 (artist-string-split extra-args "[ \t]+"))
2844 (t nil)))
2845 (figlet-output (artist-system artist-figlet-program text figlet-args))
2846 (exit-code (elt figlet-output 0))
2847 (stdout (elt figlet-output 1))
2848 (stderr (elt figlet-output 2)))
2849 (if (not (= exit-code 0))
2850 (error "Failed to render font: %s (%d)" stderr exit-code))
2851 stdout))
2852
2853(defun artist-figlet-get-font-list ()
2854 "Read fonts in with the shell command.
2855Returns a list of strings."
2856 (let* ((cmd-interpreter "/bin/sh")
2857 (ls-cmd artist-figlet-list-fonts-command)
2858 (result (artist-system cmd-interpreter ls-cmd nil))
2859 (exit-code (elt result 0))
2860 (stdout (elt result 1))
2861 (stderr (elt result 2)))
2862 (if (not (= exit-code 0))
2863 (error "Failed to read available fonts: %s (%d)" stderr exit-code))
2864 (artist-string-split stdout ".flf\n")))
2865
2866(defun artist-figlet-choose-font ()
2867 "Read any extra arguments for figlet."
2868 (interactive)
2869 (let* ((avail-fonts (artist-figlet-get-font-list))
5b76833f 2870 (font (completing-read (concat "Select font (default "
b95b34e5 2871 artist-figlet-default-font
5b76833f 2872 "): ")
b95b34e5
GM
2873 (mapcar
2874 (lambda (font) (cons font font))
2875 avail-fonts))))
2876 (if (string= font "") artist-figlet-default-font font)))
2877
2878(defun artist-figlet-get-extra-args ()
2879 "Read any extra arguments for figlet."
e327a62d 2880 (let ((extra-args (read-string "Extra args to figlet: ")))
b95b34e5
GM
2881 (if (string= extra-args "")
2882 nil
2883 extra-args)))
2884
2885(defun artist-figlet (text)
2886 "Render TEXT using figlet."
2887 (let* ((figlet-font (artist-figlet-choose-font))
2888 (figlet-extra-args (artist-figlet-get-extra-args)))
2889 (artist-figlet-run text figlet-font figlet-extra-args)))
2890
2891
2892(defun artist-text-insert-common (x y text see-thru)
2893 "At position X, Y, insert text TEXT.
98d92ce3 2894If SEE-THRU is non-nil, then blanks in TEXT do not replace text
b95b34e5
GM
2895in the buffer."
2896 (let* ((string-list (artist-string-split text "\n"))
2897 (i 0)
2898 (len (length string-list)))
2899 (while (< i len)
2900 (artist-move-to-xy x (+ y i))
2901 (artist-replace-string (car string-list) see-thru)
2902 (setq string-list (cdr string-list))
2903 (setq i (1+ i)))))
a9645a66 2904
b95b34e5
GM
2905(defun artist-text-insert-see-thru (x y text)
2906 "At position X, Y, insert text TEXT.
2907Let text already in buffer shine thru the TEXT inserted."
2908 (artist-text-insert-common x y text t))
2909
2910(defun artist-text-insert-overwrite (x y text)
2911 "At position X, Y, insert text TEXT.
2912Let blanks in TEXT overwrite any text already in the buffer."
2913 (artist-text-insert-common x y text nil))
2914
2915(defun artist-text-see-thru (x y)
2916 "Prompt for text to render, render it at X,Y.
f904adbb
RW
2917This is done by calling the function specified by
2918`artist-text-renderer-function', which must return a list of strings,
2919to be inserted in the buffer.
b95b34e5
GM
2920
2921Text already in the buffer ``shines thru'' blanks in the rendered text."
e327a62d 2922 (let* ((input-text (read-string "Type text to render: "))
f904adbb 2923 (rendered-text (artist-funcall artist-text-renderer-function input-text)))
b95b34e5
GM
2924 (artist-text-insert-see-thru x y rendered-text)))
2925
2926
2927(defun artist-text-overwrite (x y)
2928 "Prompt for text to render, render it at X,Y.
f904adbb
RW
2929This is done by calling the function specified by
2930`artist-text-renderer-function', which must return a list of strings,
2931to be inserted in the buffer.
b95b34e5 2932
98d92ce3 2933Blanks in the rendered text overwrite any text in the buffer."
e327a62d 2934 (let* ((input-text (read-string "Type text to render: "))
f904adbb 2935 (rendered-text (artist-funcall artist-text-renderer-function input-text)))
b95b34e5
GM
2936 (artist-text-insert-overwrite x y rendered-text)))
2937
2938;;
2939;; Spraying
a9645a66 2940;;
b95b34e5
GM
2941
2942(defun artist-spray-get-interval ()
98d92ce3 2943 "Retrieve the interval for repeated spray."
b95b34e5
GM
2944 artist-spray-interval)
2945
2946(defun artist-spray-random-points (n radius)
2947 "Generate N random points within a radius of RADIUS.
2948Returns a list of points. Each point is on the form (X1 . Y1)."
2949 (let ((points))
2950 (while (> n 0)
2951 (let* ((angle (* (random 359) (/ pi 180)))
2952 (dist (random radius))
2953 (point (cons (round (* dist (cos angle)))
2954 (round (* dist (sin angle))))))
2955 (setq points (cons point points)))
2956 (setq n (- n 1)))
2957 points))
2958
2959(defun artist-spray (x1 y1)
2960 "Spray at X1, Y1."
2961 (let* ((num-points (* artist-spray-radius artist-spray-radius))
2962 (spray-points (artist-spray-random-points num-points
2963 artist-spray-radius)))
2964 (while spray-points
2965 ;; Replace one spray point
2966 (let* ((point (car spray-points))
2967 (x (+ x1 (car point)))
2968 (y (+ y1 (cdr point)))
2969 (buf-c (artist-get-char-at-xy-conv x y))
2970 (this-c (memq buf-c artist-spray-chars))
2971 (next-c (cond ((null this-c) artist-spray-new-char)
2972 ((null (cdr this-c)) (car this-c))
2973 (t (car (cdr this-c))))))
2974 (artist-move-to-xy x y)
2975 (artist-replace-char next-c))
2976
2977 ;; Step to next spray point
2978 (setq spray-points (cdr spray-points)))))
2979
2980(defun artist-spray-clear-circle (circle x1 y1 x2 y2)
98d92ce3 2981 "Clear circle CIRCLE at X1, Y1 through X2, Y2."
b95b34e5
GM
2982 (artist-undraw-circle circle))
2983
2984(defun artist-spray-set-radius (circle x1 y1 x2 y2)
2985 "Set spray radius from CIRCLE at X1, Y1 through X2, Y2."
2986 (let ((dx (- x2 x1))
2987 (dy (- y2 y1)))
2988 (setq artist-spray-radius (round (sqrt (+ (* dx dx) (* dy dy)))))
2989 (if (= 0 artist-spray-radius)
2990 (setq artist-spray-radius 1))))
2991
2992;;
2993;; Erasing
2994;;
2995
2996(defun artist-erase-char (x1 y1)
98d92ce3 2997 "Erase a character at X1, Y1.
b95b34e5
GM
2998The character is replaced with the character in `artist-erase-char'."
2999 (artist-move-to-xy x1 y1)
3000 (artist-replace-char artist-erase-char))
3001
3002(defun artist-erase-rect (rect x1 y1 x2 y2)
3003 "Erase rectangle RECT from X1, Y1, X2, Y2."
3004 (let ((artist-line-char-set t)
3005 (artist-fill-char-set t)
3006 (artist-line-char artist-erase-char)
3007 (artist-fill-char artist-erase-char))
3008 (artist-draw-rect x1 y1 x2 y2)
3009 (artist-fill-rect rect x1 y1 x2 y2)))
3010
3011
3012;;
3013;; Vaporizing (erasing) line and lines
3014;;
3015
3016
3017(defun artist-vap-find-endpoint (x1 y1 step-x step-y accept-set reject-set)
3018 "Find one endpoint for line through X1, Y1.
3019The endpoint is searched for in the direction defined by STEP-X, STEP-Y,
3020accepting characters in the list ACCEPT-SET, stopping immediately
3021when finding characters in the list REJECT-SET. Fuzziness, that is
3022the number of consecutive characters not in ACCEPT-SET to allow as
3023part of the line, is determined by the variable `artist-vaporize-fuzziness'.
3024An endpoint is a cons pair, (ENDPOINT-X . ENDPOINT-Y)."
3025 (let ((x x1)
3026 (y y1)
3027 (x-last x1)
3028 (y-last y1)
3029 (done nil))
3030 (while (not done)
3031 (let ((c (artist-get-char-at-xy-conv x y)))
3032 (cond ((memq c reject-set)
3033 (setq done t))
3034
3035 ;; We found a character we are accepting as part of the line.
3036 ;; Update position
3037 ((memq c accept-set)
3038 (setq x-last x
3039 y-last y
3040 x (+ x step-x)
3041 y (+ y step-y))
3042 (if (or (< x 0) (< y 0)) ;stop at the edge
3043 (setq done t)))
3044
3045 ;; We found a character we are not accepting as part of
3046 ;; the line Search `artist-vaporize-fuzziness'
3047 ;; characters away from this position in the same
3048 ;; direction to see if there are any characters in the
3049 ;; accept-set. If not, we have found the endpoint.
3050 (t
3051 (let ((fuzziness artist-vaporize-fuzziness)
3052 (x-tmp x)
3053 (y-tmp y))
3054
3055 ;; while we have more fuzziness left and we have not
3056 ;; found a character accepted as a line, move
3057 ;; forward!
3058 (while (and (> fuzziness 0) (not (memq c accept-set)))
3059 (setq x-tmp (+ x-tmp step-x))
3060 (setq y-tmp (+ y-tmp step-y))
3061 (setq c (artist-get-char-at-xy-conv x-tmp y-tmp))
3062 (setq fuzziness (- fuzziness 1)))
3063 (if (memq c accept-set)
3064
3065 ;; The line continues on the other side of the
3066 ;; not-accepted character.
3067 (setq x x-tmp
3068 y y-tmp)
3069
3070 ;; Else: We couldn't find any line on the other side.
3071 ;; That means we are done searching for the endpoint.
3072 (setq done t)))))))
3073 (cons x-last y-last)))
3074
3075
3076(defun artist-vap-find-endpoints-horiz (x y)
3077 "Find endpoints for a horizontal line through X, Y.
3078An endpoint is a cons pair, (ENDPOINT-X . ENDPOINT-Y)."
fe6e86db
JB
3079 (list (artist-vap-find-endpoint x y 1 0 '(?- ?+) '(?\s))
3080 (artist-vap-find-endpoint x y -1 0 '(?- ?+) '(?\s))))
b95b34e5
GM
3081
3082(defun artist-vap-find-endpoints-vert (x y)
3083 "Find endpoints for a vertical line through X, Y.
3084An endpoint is a cons pair, (ENDPOINT-X . ENDPOINT-Y)."
fe6e86db
JB
3085 (list (artist-vap-find-endpoint x y 0 1 '(?| ?+) '(?\s))
3086 (artist-vap-find-endpoint x y 0 -1 '(?| ?+) '(?\s))))
b95b34e5
GM
3087
3088(defun artist-vap-find-endpoints-swne (x y)
3089 "Find endpoints for a diagonal line (made by /'s) through X, Y.
3090An endpoint is a cons pair, (ENDPOINT-X . ENDPOINT-Y)."
fe6e86db
JB
3091 (list (artist-vap-find-endpoint x y 1 -1 '(?/ ?X) '(?\s))
3092 (artist-vap-find-endpoint x y -1 1 '(?/ ?X) '(?\s))))
b95b34e5
GM
3093
3094(defun artist-vap-find-endpoints-nwse (x y)
3095 "Find endpoints for a diagonal line (made by \\'s) through X, Y.
3096An endpoint is a cons pair, (ENDPOINT-X . ENDPOINT-Y)."
fe6e86db
JB
3097 (list (artist-vap-find-endpoint x y 1 1 '(?\\ ?X) '(?\s))
3098 (artist-vap-find-endpoint x y -1 -1 '(?\\ ?X) '(?\s))))
b95b34e5
GM
3099
3100
3101(defun artist-vap-find-endpoints (x y)
3102 "Given a point X1, Y1, return a list of endpoints of lines through X, Y.
3103An endpoint is a cons pair, (ENDPOINT-X . ENDPOINT-Y)."
3104 (if artist-line-char-set
3105 nil
3106 (let ((c (artist-get-char-at-xy-conv x y)))
3107 (cond ((eq c ?-) (artist-vap-find-endpoints-horiz x y))
3108 ((eq c ?|) (artist-vap-find-endpoints-vert x y))
3109 ((eq c ?/) (artist-vap-find-endpoints-swne x y))
3110 ((eq c ?\\) (artist-vap-find-endpoints-nwse x y))
3111 ((eq c ?+) (append (artist-vap-find-endpoints-horiz x y)
3112 (artist-vap-find-endpoints-vert x y)))
3113 ((eq c ?X) (append (artist-vap-find-endpoints-swne x y)
3114 (artist-vap-find-endpoints-nwse x y)))
3115
3116 ;; We don't know how to find directions when we are on
3117 ;; another character
3118 (t nil)))))
3119
3120
3121(defun artist-vap-group-in-pairs (l)
3122 "Group elements in list L in pairs."
3123 (cond ((null l) nil)
3124 ((null (cdr l)) l) ; unevent number of elements in list
3125 (t (append (list (list (car l) (car (cdr l))))
3126 (artist-vap-group-in-pairs (cdr (cdr l)))))))
3127
3128(defun artist-vaporize-by-endpoints (endpoint1 endpoint2)
3129 "Given ENDPOINT1 and ENDPOINT2, vaporize the line between them.
3130An endpoint is a pair (X . Y)."
3131 (let* ((x1 (car endpoint1))
3132 (y1 (cdr endpoint1))
3133 (x2 (car endpoint2))
3134 (y2 (cdr endpoint2))
3135 (dir (artist-find-direction x1 y1 x2 y2))
3136 (x-step (aref [1 1 0 -1 -1 -1 0 1] dir))
3137 (y-step (aref [0 1 1 1 0 -1 -1 -1] dir))
3138 (line-c (aref [?- ?\\ ?| ?/ ?- ?\\ ?| ?/] dir))
3139 (line-len (elt (list (abs (- x2 x1))
3140 (abs (- x2 x1))
3141 (abs (- y2 y1))
3142 (abs (- y2 y1))
3143 (abs (- x1 x2))
3144 (abs (- x1 x2))
3145 (abs (- y1 y2))
3146 (abs (- y1 y2)))
3147 dir))
3148 (x x1)
3149 (y y1))
3150 (while (>= line-len 0)
3151 (let* ((buffer-c (artist-get-char-at-xy-conv x y))
3152 (new-c (artist-unintersection-char line-c buffer-c)))
3153 (artist-move-to-xy x y)
3154 (artist-replace-char new-c))
3155 (setq x (+ x x-step)
3156 y (+ y y-step)
3157 line-len (- line-len 1)))))
3158
3159
3160(defun artist-vaporize-line (x1 y1)
3161 "Vaporize (erase) the straight line through X1, Y1.
3162Do this by replacing the characters that forms the line with
98d92ce3
JB
3163`artist-erase-char'. Output is a list of endpoints for lines through
3164X1, Y1. An endpoint is a cons pair, (ENDPOINT-X . ENDPOINT-Y)."
b95b34e5 3165 (let ((endpoints (artist-vap-find-endpoints x1 y1)))
b5242984 3166 (mapc
b95b34e5
GM
3167 (lambda (endpoints)
3168 (let ((ep1 (car endpoints))
3169 (ep2 (car (cdr endpoints))))
3170 (artist-vaporize-by-endpoints ep1 ep2)))
3171 (artist-vap-group-in-pairs endpoints))
3172 endpoints))
3173
3174
3175;; Implementation note: This depends on artist-vaporize-line doing
3176;; unintersections of intersecting lines.
3177;;
3178;; Example:
3179;; Suppose the buffer looks like this and that we start vaporizing
3180;; lines at (3,0) (at the ``*'').
3181;;
3182;; 0123456
3183;; 0+--*--+
3184;; 1| |
3185;; 2| |
3186;; 3+-----+
3187;;
3188;; We will then push (0,0) and (6,0) on the stack, and vaporize the
3189;; topmost horizontal line:
3190;;
3191;; 0123456
3192;; 0| |
3193;; 1| |
3194;; 2| |
3195;; 3+-----+
3196;;
3197;; We will then pop (0,0) and remove the left-most vertival line while
3198;; pushing the lower left corner (0,3) on the stack, and so on until
3199;; the entire rectangle is vaporized.
3200;;
3201;; Now, What if the `+' in the upper left and upper right corners,
a9645a66 3202;; had not been changed to `|' but to spaces instead? We would
b95b34e5
GM
3203;; have failed when popping (0,0) and vaporizing that line because
3204;; we wouldn't find any line at (0,0):
a9645a66 3205;;
b95b34e5 3206;; 0123456
a9645a66 3207;; 0
b95b34e5
GM
3208;; 1| |
3209;; 2| |
3210;; 3+-----+
3211;;
3212;; That's why we depend on artist-vaporize-line doing unintersecting
3213;; of crossing lines. There are alternative ways to handle this
3214;; if it becomes too much a trouble.
3215;;
3216(defun artist-vaporize-lines (x1 y1)
3217 "Vaporize lines reachable from point X1, Y1."
3218 (let ((ep-stack nil))
b5242984 3219 (mapc
a4a5aa2b 3220 (lambda (ep) (push ep ep-stack))
b95b34e5
GM
3221 (artist-vap-find-endpoints x1 y1))
3222 (while (not (null ep-stack))
a4a5aa2b 3223 (let* ((vaporize-point (pop ep-stack))
b95b34e5
GM
3224 (new-endpoints (artist-vaporize-line (car vaporize-point)
3225 (cdr vaporize-point))))
b5242984 3226 (mapc
a4a5aa2b 3227 (lambda (endpoint) (push endpoint ep-stack))
b95b34e5
GM
3228 new-endpoints)))))
3229
3230
3231;;
3232;; Circles and ellipses
3233;;
3234(defun artist-ellipse-generate-quadrant (x-radius y-radius)
3235 "Create a point-list for first quadrant.
3236Points go from (X-RADIUS, 0) to (0, Y-RADIUS).
98d92ce3 3237Quadrant is generated around origin."
b95b34e5
GM
3238 (let* ((rx2 (* x-radius x-radius))
3239 (ry2 (* y-radius y-radius))
3240 (2rx2 (* 2 rx2))
3241 (2ry2 (* 2 ry2))
3242 (p)
3243 (x 0)
3244 (y y-radius)
3245 (px 0)
3246 (py (* 2rx2 y))
3247 (point-list nil))
3248 (artist-put-pixel point-list x y)
3249 (setq p (round (+ ry2 (- (* rx2 y-radius)) (* 0.25 rx2))))
3250 (while (< px py)
3251 (setq x (1+ x)
3252 px (+ px 2ry2))
3253 (if (< p 0)
3254 (setq p (+ p ry2 px))
3255 (setq y (- y 1)
3256 py (- py 2rx2)
3257 p (+ p ry2 px (- py))))
3258 (artist-put-pixel point-list x y))
3259 (setq p (round (+ (* ry2 (+ x 0.5) (+ x 0.5))
3260 (* rx2 (- y 1) (- y 1))
3261 (- (* rx2 ry2)))))
3262 (while (> y 0)
3263 (setq y (- y 1)
3264 py (- py 2rx2))
3265 (if (> p 0)
3266 (setq p (+ p rx2 (- py)))
3267 (setq x (1+ x)
3268 px (+ px 2ry2)
3269 p (+ p rx2 (- py) px)))
3270 (artist-put-pixel point-list x y))
3271 point-list))
3272
3273(defsubst artist-new-fill-item (x y width)
3274 "Create a new item at X, Y, with WIDTH.
3275This is for use in fill-info in ellipses and circles."
3276 (let ((new-item (make-vector 3 x)))
3277 (aset new-item 1 y)
3278 (aset new-item 2 width)
3279 new-item))
3280
3281(defsubst artist-fill-item-get-x (fill-item)
3282 "Retrieve the x component of a FILL-ITEM."
3283 (aref fill-item 0))
3284
3285(defsubst artist-fill-item-set-x (fill-item new-x)
3286 "Set the x component of a FILL-ITEM to NEW-X."
3287 (aset fill-item 0 new-x)
3288 fill-item)
3289
3290(defsubst artist-fill-item-get-y (fill-item)
3291 "Retrieve the y component of a FILL-ITEM."
3292 (aref fill-item 1))
3293
3294(defsubst artist-fill-item-set-y (fill-item new-y)
3295 "Set the y component of a FILL-ITEM to NEW-Y."
3296 (aset fill-item 1 new-y)
3297 fill-item)
3298
3299(defsubst artist-fill-item-get-width (fill-item)
3300 "Retrieve the width component of a FILL-ITEM."
3301 (aref fill-item 2))
3302
3303(defsubst artist-fill-item-set-width (fill-item new-width)
3304 "Set the width component of a FILL-ITEM to NEW-WIDTH."
3305 (aset fill-item 2 new-width)
3306 fill-item)
3307
3308
3309(defun artist-ellipse-point-list-add-center (x-center y-center point-list)
3310 "Add offsets X-CENTER and Y-CENTER to coordinates in POINT-LIST."
3311 (mapcar
3312 (lambda (p)
3313 (artist-coord-set-x p (+ x-center (artist-coord-get-x p)))
3314 (artist-coord-set-y p (+ y-center (artist-coord-get-y p))))
3315 point-list))
3316
3317
3318(defun artist-ellipse-fill-info-add-center (x-center y-center fill-info)
3319 "Add offsets X-CENTER and Y-CENTER to fill-items in FILL-INFO."
3320 (mapcar
3321 (lambda (p)
3322 (artist-fill-item-set-x p (+ x-center (artist-fill-item-get-x p)))
3323 (artist-fill-item-set-y p (+ y-center (artist-fill-item-get-y p))))
3324 fill-info))
3325
3326(defun artist-ellipse-remove-0-fills (fill-info)
3327 "Remove fill-infos from FILL-INFO that fills a zero-width field."
3328 (cond ((null fill-info)
3329 nil)
3330 ((= 0 (artist-fill-item-get-width (car fill-info)))
3331 (artist-ellipse-remove-0-fills (cdr fill-info)))
3332 (t
3333 (append (list (car fill-info))
3334 (artist-ellipse-remove-0-fills (cdr fill-info))))))
3335
3336
3337(defun artist-ellipse-compute-fill-info (point-list)
3338 "Compute fill info for ellipse around 0,0 from POINT-LIST.
3339The POINT-LIST is expected to cover the first quadrant."
3340 (let ((first-half nil)
3341 (both-halves nil)
3342 (last-y nil))
3343
3344 ;; Create first half (the lower one (since y grows downwards)) from
3345 ;; the first quadrant.
b5242984 3346 (mapc
b95b34e5
GM
3347 (lambda (coord)
3348 (let* ((x (artist-coord-get-x coord))
3349 (y (artist-coord-get-y coord))
3350 (width (max (- (* 2 x) 1) 0))
3351 (left-edge (- x width)))
3352 (if (or (null last-y) (not (= y last-y)))
3353 ;; This was either the first time,
3354 ;; or it was the first time on a new line
3355 (setq first-half
3356 (append first-half
3357 ;; Fill info item starts at left-edge on line y
3358 (list (artist-new-fill-item left-edge y width)))))
3359 (setq last-y y)))
3360 point-list)
3361
3362 ;; Create the other half by mirroring the first half.
3363 (setq both-halves
3364 (append first-half
b5242984 3365 (mapc
b95b34e5
GM
3366 (lambda (i)
3367 (artist-new-fill-item (artist-fill-item-get-x i)
3368 (- (artist-fill-item-get-y i))
3369 (artist-fill-item-get-width i)))
3370 ;; The cdr below is so we don't include fill-info for
3371 ;;; the middle line twice
3372 (cdr (reverse first-half)))))
3373 (artist-ellipse-remove-0-fills both-halves)))
3374
3375
3376(defun artist-ellipse-mirror-quadrant (point-list)
3377 "Mirror a POINT-LIST describing first quadrant to create a complete ellipse."
3378 (let ((right-half nil)
3379 (left-half nil))
3380
3381 ;; First, if last char in that quadrant is `/', then replace it with `)'
3382 ;; This way we avoids things
3383 ;; --------- ---------
3384 ;; / \ / \
3385 ;; that look like: \ / instead we get: ( )
3386 ;; \ / \ /
3387 ;; --------- ---------
de4ce191 3388 (let ((last-coord (car (last point-list))))
b95b34e5
GM
3389 (if (= (artist-coord-get-new-char last-coord) ?/)
3390 (artist-coord-set-new-char last-coord artist-ellipse-right-char)))
3391
3392 ;; Create the other part of the right half by mirroring the first part
3393 (setq right-half
3394 (append
3395 point-list
3396 (mapcar
3397 (lambda (coord)
3398 (let ((c (artist-coord-get-new-char coord)))
3399 (artist-new-coord (artist-coord-get-x coord)
3400 (- (artist-coord-get-y coord))
3401 (cond ((= c ?/) ?\\)
3402 ((= c ?\\) ?/)
3403 (t c)))))
3404 ;; The cdr below is so we don't draw the middle right char twice
3405 (cdr (reverse point-list)))))
3406
3407 ;; Create the left half by mirroring the right half.
3408 (setq left-half
3409 (mapcar
3410 (lambda (coord)
3411 (let ((c (artist-coord-get-new-char coord)))
3412 (artist-new-coord (- (artist-coord-get-x coord))
3413 (artist-coord-get-y coord)
3414 (cond ((= c ?/) ?\\)
3415 ((= c ?\\) ?/)
3416 ((= c artist-ellipse-right-char)
3417 artist-ellipse-left-char)
3418 (t c)))))
3419 ;; The cdr and butlast below is so we don't draw the middle top
3420 ;; and middle bottom char twice.
a4a5aa2b 3421 (butlast (cdr (reverse right-half)))))
b95b34e5
GM
3422 (append right-half left-half)))
3423
3424
5445d287
JB
3425(defun artist-draw-ellipse-general (x1 y1 x-radius y-radius)
3426 "Draw an ellipse with center at X1, Y1 and X-RADIUS and Y-RADIUS.
b95b34e5
GM
3427
3428Output is an ellipse, which is a list (END-POINT-1 END-POINT-2 SHAPE-INFO).
3429
3430END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
3431SHAPE-INFO is a two-element vector on the form [POINT-LIST FILL-INFO].
3432
3433POINT-LIST is a list of vectors on the form [X Y SAVED-CHAR NEW-CHAR].
3434FILL-INFO is a list of vectors on the form [X Y ELLIPSE-WIDTH-ON-THIS-LINE].
3435
5445d287 3436Ellipses with zero Y-RADIUS are not drawn correctly."
b95b34e5
GM
3437 (let* ((point-list (artist-ellipse-generate-quadrant x-radius y-radius))
3438 (fill-info (artist-ellipse-compute-fill-info point-list))
3439 (shape-info (make-vector 2 0)))
3440
3441 (setq point-list (artist-calculate-new-chars point-list))
3442 (setq point-list (artist-ellipse-mirror-quadrant point-list))
5445d287
JB
3443 (setq point-list (artist-ellipse-point-list-add-center x1 y1 point-list))
3444 (setq fill-info (artist-ellipse-fill-info-add-center x1 y1 fill-info))
b95b34e5
GM
3445
3446 ;; Draw the ellipse
3447 (setq point-list
3448 (mapcar
3449 (lambda (coord)
3450 (artist-move-to-xy (artist-coord-get-x coord)
3451 (artist-coord-get-y coord))
3452 (if artist-line-char-set
3453 (artist-replace-char artist-line-char)
3454 (artist-replace-char (artist-coord-get-new-char coord)))
3455 coord)
3456 (artist-modify-new-chars
3457 (artist-save-chars-under-point-list point-list))))
3458
3459 (aset shape-info 0 point-list)
3460 (aset shape-info 1 fill-info)
5445d287 3461 (artist-make-2point-object (artist-make-endpoint x1 y1)
b95b34e5
GM
3462 (artist-make-endpoint x-radius y-radius)
3463 shape-info)))
3464
5445d287
JB
3465(defun artist-draw-ellipse-with-0-height (x1 y1 x-radius y-radius)
3466 "Draw an ellipse with center at X1, Y1 and X-RADIUS and Y-RADIUS.
b95b34e5
GM
3467
3468Output is an ellipse, which is a list (END-POINT-1 END-POINT-2 SHAPE-INFO).
3469
3470END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
3471SHAPE-INFO is a two-element vector on the form [POINT-LIST FILL-INFO].
3472
3473POINT-LIST is a list of vectors on the form [X Y SAVED-CHAR NEW-CHAR].
3474FILL-INFO is a list of vectors on the form [X Y ELLIPSE-WIDTH-ON-THIS-LINE].
3475
5445d287 3476The Y-RADIUS must be 0, but the X-RADIUS must not be 0."
b95b34e5
GM
3477 (let ((point-list nil)
3478 (width (max (- (abs (* 2 x-radius)) 1)))
5445d287 3479 (left-edge (1+ (- x1 (abs x-radius))))
b95b34e5
GM
3480 (line-char (if artist-line-char-set artist-line-char ?-))
3481 (i 0)
3482 (point-list nil)
3483 (fill-info nil)
3484 (shape-info (make-vector 2 0)))
3485 (while (< i width)
3486 (let* ((line-x (+ left-edge i))
5445d287 3487 (line-y y1)
b95b34e5
GM
3488 (new-coord (artist-new-coord line-x line-y)))
3489 (artist-coord-add-saved-char new-coord
3490 (artist-get-char-at-xy line-x line-y))
3491 (artist-move-to-xy line-x line-y)
3492 (artist-replace-char line-char)
3493 (setq point-list (append point-list (list new-coord)))
3494 (setq i (1+ i))))
3495 (aset shape-info 0 point-list)
3496 (aset shape-info 1 fill-info)
5445d287 3497 (artist-make-2point-object (artist-make-endpoint x1 y1)
b95b34e5
GM
3498 (artist-make-endpoint x-radius y-radius)
3499 shape-info)))
3500
3501(defun artist-draw-ellipse (x1 y1 x2 y2)
3502 "Draw an ellipse with center at X1, Y1 and point X2,Y2.
3503
3504Output is an ellipse, which is a list (END-POINT-1 END-POINT-2 SHAPE-INFO).
3505
3506END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
3507SHAPE-INFO is a two-element vector on the form [POINT-LIST FILL-INFO].
3508
3509POINT-LIST is a list of vectors on the form [X Y SAVED-CHAR NEW-CHAR].
3510FILL-INFO is a list of vectors on the form [X Y ELLIPSE-WIDTH-ON-THIS-LINE]."
3511 (let* ((artist-line-char (artist-compute-line-char))
3512 (artist-line-char-set artist-line-char)
3513 (width (abs (- x2 x1)))
3514 (height (abs (- y2 y1)))
3515 ;;
3516 ;; When we draw our ellipse, we want it to go through the cursor
3517 ;; position, but since x1,y1, x2,y2 marks the corners of one
3518 ;; of the quadrants, we have to enlarge the ellipse a bit.
3519 ;; Ok, so then why by sqrt(2)?
3520 ;; It comes from the equation for the ellipse (where a is the
3521 ;; x-radius and b is the y-radius):
3522 ;; f(x,y) = x^2 / a^2 + y^2 / b^2 - 1 = 0
3523 ;; and the fact that we want the enlarged ellipse to have the
3524 ;; same proportions as the smaller square, therefore we have:
3525 ;; a/b = x/y
3526 ;; Solving this yields a-in-larger-ellipse = a-in-smaller * sqrt(2)
3527 (x-radius (round (* width (sqrt 2))))
3528 (y-radius (round (* height (sqrt 2))))
3529 (x x1)
3530 (y y1))
3531 (if (and (= y1 y2) (not (= x1 x2)))
3532 (artist-draw-ellipse-with-0-height x y x-radius y-radius)
3533 (artist-draw-ellipse-general x y x-radius y-radius))))
3534
3535
3536(defun artist-undraw-ellipse (ellipse)
3537 "Undraw ELLIPSE."
3538 (if ellipse
3539 (let ((point-list (aref (artist-2point-get-shapeinfo ellipse) 0)))
3540 (mapcar
3541 (lambda (coord)
3542 (artist-move-to-xy (artist-coord-get-x coord)
3543 (artist-coord-get-y coord))
3544 (artist-replace-char (artist-coord-get-saved-char coord))
3545 coord)
3546 point-list))))
3547
3548
3549(defun artist-draw-circle (x1 y1 x2 y2)
3550 "Draw a circle with center at X1, Y1 and point X2,Y2.
3551
3552Output is an ellipse, which is a list (END-POINT-1 END-POINT-2 SHAPE-INFO).
3553
3554END-POINT-1 and END-POINT-2 are two-element vectors on the form [X Y].
3555SHAPE-INFO is a two-element vector on the form [POINT-LIST FILL-INFO].
3556
3557POINT-LIST is a list of vectors on the form [X Y SAVED-CHAR NEW-CHAR].
3558FILL-INFO is a list of vectors on the form [X Y ELLIPSE-WIDTH-ON-THIS-LINE]."
3559 (let* ((artist-line-char (artist-compute-line-char))
3560 (artist-line-char-set artist-line-char)
3561 (width (abs (- x2 x1)))
3562 (height (abs (- y2 y1)))
3563 ;; When drawing our circle, we want it to through the cursor
3564 ;; just as when drawing the ellispe, but we have to take
3565 ;; care for the aspect-ratio.
3566 ;; The equation for the ellipse (where a is the x-radius and
3567 ;; b is the y-radius):
3568 ;; f(x,y) = x^2 / a^2 + y^2 / b^2 - 1 = 0
3569 ;; together with the relationship
3570 ;; a = aspect-ratio * b
3571 ;; gives
3572 ;; a = sqrt( x^2 + (aspect-ratio * y)^2 ) and
3573 ;; b = a / aspect-ratio
3574 (x-radius (round (sqrt (+ (* width width)
3575 (* (* artist-aspect-ratio height)
3576 (* artist-aspect-ratio height))))))
3577 (y-radius (round (/ x-radius artist-aspect-ratio))))
3578 (artist-draw-ellipse-general x1 y1 x-radius y-radius)))
3579
3580(defalias 'artist-undraw-circle 'artist-undraw-ellipse)
3581
3582
3583;
3584; Filling ellipses
3585;
3586(defun artist-fill-ellipse (ellipse x y x-radius y-radius)
3587 "Fill an ELLIPSE centered at X,Y with radius X-RADIUS and Y-RADIUS."
3588 (let ((fill-info (aref (artist-2point-get-shapeinfo ellipse) 1)))
3589 (mapcar
3590 (lambda (fill-item)
3591 (artist-move-to-xy (artist-fill-item-get-x fill-item)
3592 (artist-fill-item-get-y fill-item))
3593 (artist-replace-chars artist-fill-char
3594 (artist-fill-item-get-width fill-item))
3595 fill-item)
3596 fill-info)))
3597
3598(defalias 'artist-fill-circle 'artist-fill-ellipse)
3599
3600
3601;;
3602;; Cutting, copying and pasting rectangles and squares
3603;; (filling functions)
3604;;
3605
3606(defun artist-cut-rect (rect x1 y1 x2 y2)
3607 "Copy rectangle RECT drawn from X1, Y1 to X2, Y2, then clear it."
3608 (artist-undraw-rect rect)
3609 (artist-copy-generic x1 y1 x2 y2)
3610 (artist-erase-rect rect x1 y1 x2 y2))
3611
3612(defun artist-cut-square (square x1 y1 x2 y2)
3613 "Copy a SQUARE drawn from X1, Y1 to X2, Y2 (made square), then clears it."
3614 (artist-undraw-square square)
3615 (let* ((square-corners (artist-rect-corners-squarify x1 y1 x2 y2))
3616 (new-x1 (elt square-corners 0))
3617 (new-y1 (elt square-corners 1))
3618 (new-x2 (elt square-corners 2))
3619 (new-y2 (elt square-corners 3)))
3620 (artist-copy-generic new-x1 new-y1 new-x2 new-y2)
3621 (artist-erase-rect square new-x1 new-y1 new-x2 new-y2)))
3622
3623
3624(defun artist-get-buffer-contents-at-xy (x y width)
3625 "Retrieve contents from the buffer at X, Y. WIDTH characters are returned."
3626 (artist-move-to-xy x y)
3627 (let ((here (point))
3628 (there (save-excursion (artist-move-to-xy (+ x width) y) (point))))
3629 (untabify here there)
3630 (setq there (save-excursion (artist-move-to-xy (+ x width) y) (point)))
3631 (buffer-substring here there)))
3632
3633
3634(defun artist-copy-generic (x1 y1 x2 y2)
3635 "Copy a rectangular area with corners at X1, Y1 and X2, Y2.
3636Output is a copy buffer, a list of strings, representing the
3637original contents of that area in the buffer."
3638 (let* ((x (min x1 x2))
3639 (y (min y1 y2))
3640 (x-max (max x1 x2))
3641 (y-max (max y1 y2))
3642 (w (+ (- x-max x) 1))
3643 (l nil))
3644 (while (<= y y-max)
3645 (setq l (cons (artist-get-buffer-contents-at-xy x y w) l))
3646 (setq y (1+ y)))
3647 (if artist-interface-with-rect
3648 (setq killed-rectangle (reverse l))
3649 (setq artist-copy-buffer (reverse l)))))
3650
3651
3652(defun artist-copy-rect (rect x1 y1 x2 y2)
3653 "Copy rectangle RECT drawn from X1, Y1 to X2, Y2."
3654 (artist-undraw-rect rect)
3655 (artist-copy-generic x1 y1 x2 y2))
3656
3657(defun artist-copy-square (square x1 y1 x2 y2)
98d92ce3 3658 "Copy a SQUARE drawn from X1, Y1 to X2, Y2 (but made square)."
b95b34e5
GM
3659 (artist-undraw-square square)
3660 (let* ((square-corners (artist-rect-corners-squarify x1 y1 x2 y2))
3661 (new-x1 (elt square-corners 0))
3662 (new-y1 (elt square-corners 1))
3663 (new-x2 (elt square-corners 2))
3664 (new-y2 (elt square-corners 3)))
3665 (artist-copy-generic new-x1 new-y1 new-x2 new-y2)))
3666
3667(defun artist-paste (x y)
98d92ce3 3668 "Paste the contents of the copy-buffer at X,Y."
b95b34e5
GM
3669 (let ((copy-buf (if artist-interface-with-rect
3670 killed-rectangle
3671 artist-copy-buffer)))
3672 (if (not (null copy-buf))
3673 (while (not (null copy-buf))
3674 (artist-move-to-xy x y)
3675 (artist-replace-string (car copy-buf))
3676 (setq copy-buf (cdr copy-buf))
3677 (setq y (1+ y)))
3678 (message "Nothing to paste"))))
3679
3680
3681;;
3682;; Flood filling
3683;;
3684(defun artist-ff-too-far-right (x)
3685 "Determine if the position X is too far to the right."
3686 (cond ((numberp artist-flood-fill-right-border)
3687 (> x artist-flood-fill-right-border))
3688 ((eq artist-flood-fill-right-border 'window-width)
3689 (> x (- (window-width) 2)))
3690 ((eq artist-flood-fill-right-border 'fill-column)
3691 (> x fill-column))
3692 (t (error "Invalid value for `artist-flood-fill-right-border'"))))
3693
3694(defun artist-ff-get-rightmost-from-xy (x y)
3695 "Find the rightmost position in this run, starting at X, Y."
3696 (save-excursion
3697 (let ((char-at-xy (artist-get-char-at-xy-conv x y))
3698 (last-x x))
3699 (setq x (1+ x))
3700 (while (and (not (artist-ff-too-far-right x))
3701 (= char-at-xy (artist-get-char-at-xy-conv x y)))
3702 (setq last-x x)
3703 (setq x (1+ x)))
3704 last-x)))
3705
3706(defun artist-ff-is-topmost-line (x y)
3707 "Determine whether the position X,Y is on the topmost line or not."
3708 (= y 0))
3709
3710(defun artist-ff-is-bottommost-line (x y)
3711 "Determine whether the position X,Y is on the bottommost line or not."
3712 (save-excursion
3713 (goto-char (point-max))
3714 (beginning-of-line)
3715 (let ((last-line (artist-current-line)))
3716 (if (= (point) (point-max))
3717
3718 ;; Last line is empty, don't paint on it, report previous line
3719 ;; as last line
a9645a66
JB
3720 (>= y (- last-line 1))
3721 (>= y last-line)))))
b95b34e5
GM
3722
3723(defun artist-flood-fill (x1 y1)
98d92ce3 3724 "Flood-fill starting at X1, Y1. Fill with the char in `artist-fill-char'."
b95b34e5
GM
3725 (let ((stack nil)
3726 (input-queue nil)
3727 ;; We are flood-filling the area that has this character.
3728 (c (artist-get-char-at-xy-conv x1 y1))
3729 (artist-fill-char (if artist-fill-char-set
3730 artist-fill-char
3731 artist-default-fill-char)))
3732
3733 ;; Fill only if the fill-char is not the same as the character whose
3734 ;; area we are about to fill, or, in other words, don't fill if we
3735 ;; needn't.
3736 (if (not (= c artist-fill-char))
a4a5aa2b 3737 (push (artist-new-coord x1 y1) stack))
b95b34e5
GM
3738
3739 (while (not (null stack))
a4a5aa2b 3740 (let* ((coord (pop stack))
b95b34e5
GM
3741 (x (artist-coord-get-x coord))
3742 (y (artist-coord-get-y coord))
3743
3744 ;; Here we keep track of the leftmost and rightmost position
3745 ;; for this run
3746 (x-leftmost 0)
3747 (x-rightmost 0)
3748 (last-x 0)
3749
3750 ;; Remember if line above and below are accessible
3751 ;; Lines below the last one, and prior to the first-one
3752 ;; are not accessible.
3753 (lines-above nil)
3754 (lines-below nil)
3755
3756 ;; Remember char for position on line above and below, so we
3757 ;; can find the rightmost positions on the runs.
3758 (last-c-above -1)
3759 (last-c-below -1))
3760
3761 (setq x-rightmost (artist-ff-get-rightmost-from-xy x y))
3762 (setq lines-above (not (artist-ff-is-topmost-line x y)))
3763 (setq lines-below (not (artist-ff-is-bottommost-line x y)))
3764 (setq last-x x-rightmost)
3765 (setq x x-rightmost)
3766
3767 ;; Search line above, push rightmost positions of runs for that line
3768 (while (and (>= x 0) (= c (artist-get-char-at-xy-conv x y)))
3769 (if lines-above
3770 (let ((c-above (artist-get-char-at-xy-conv x (- y 1))))
3771 (if (and (= c-above c) (/= c-above last-c-above))
a4a5aa2b 3772 (push (artist-new-coord x (- y 1)) stack))
b95b34e5
GM
3773 (setq last-c-above c-above)))
3774 (setq last-x x)
3775 (setq x (- x 1)))
3776
3777 ;; Remember the left-most position on this run
3778 (setq x-leftmost last-x)
3779
3780 ;; Search line below, push rightmost positions of runs for that line
3781 (setq x x-rightmost)
3782 (while (>= x x-leftmost)
3783 (if lines-below
3784 (let ((c-below (artist-get-char-at-xy-conv x (1+ y))))
3785 (if (and (= c-below c) (/= c-below last-c-below))
a4a5aa2b 3786 (push (artist-new-coord x (1+ y)) stack))
b95b34e5
GM
3787 (setq last-c-below c-below)))
3788 (setq x (- x 1)))
3789
3790 (artist-move-to-xy x-leftmost y)
3791 (artist-replace-chars artist-fill-char (1+ (- x-rightmost x-leftmost)))
3792
3793 ;; If we are to show incrementally, we have to remove any pending
3794 ;; input from the input queue, because processing of pending input
3795 ;; always has priority over display updates (although this input
3796 ;; won't be processed until we are done). Later on we will queue
3797 ;; the input on the input queue again.
3798 (if artist-flood-fill-show-incrementally
3799 (progn
3800 (if (input-pending-p)
3801 (discard-input))
3802 (artist-update-display)))))))
3803
3804;;
3805;; Accessors to arrow-points
3806;;
3807
3808(defun artist-make-arrow-point (x y direction &optional state)
3809 "Create an arrow point at X, Y for a line in direction DIRECTION.
3810Optional argument STATE can be used to set state (default is nil)."
3811 (save-excursion
3812 (let* ((arrow-point (make-vector 4 0))
3813 (arrow-marker (make-marker)))
3814 (artist-move-to-xy x y)
3815 (set-marker arrow-marker (point))
3816 (aset arrow-point 0 arrow-marker)
3817 (aset arrow-point 1 (artist-get-char-at-xy x y))
3818 (aset arrow-point 2 direction)
3819 (aset arrow-point 3 state)
3820 arrow-point)))
3821
3822(defsubst artist-arrow-point-get-marker (arrow-point)
3823 "Retrieve the marker component of an ARROW-POINT."
3824 (aref arrow-point 0))
3825
3826(defsubst artist-arrow-point-get-orig-char (arrow-point)
3827 "Retrieve the orig char component of an ARROW-POINT."
3828 (aref arrow-point 1))
3829
3830(defsubst artist-arrow-point-get-direction (arrow-point)
3831 "Retrieve the direction component of an ARROW-POINT."
3832 (aref arrow-point 2))
3833
3834(defsubst artist-arrow-point-get-state (arrow-point)
3835 "Retrieve the state component of an ARROW-POINT."
3836 (aref arrow-point 3))
3837
3838(defsubst artist-arrow-point-set-state (arrow-point new-state)
3839 "Set the state component of an ARROW-POINT to NEW-STATE."
3840 (aset arrow-point 3 new-state))
3841
3842
3843(defun artist-clear-arrow-points ()
3844 "Clear current endpoints."
3845 (setq artist-arrow-point-1 nil)
3846 (setq artist-arrow-point-2 nil))
3847
3848(defun artist-set-arrow-points-for-poly (point-list)
3849 "Generic function for setting arrow-points for poly-shapes from POINT-LIST."
3850 (let* ((ep1 (elt point-list 0))
3851 (ep2 (elt point-list 1))
3852 (x1 (artist-endpoint-get-x ep1))
3853 (y1 (artist-endpoint-get-y ep1))
3854 (x2 (artist-endpoint-get-x ep2))
3855 (y2 (artist-endpoint-get-y ep2))
3856 (dir1 (artist-find-direction x2 y2 x1 y1))
de4ce191
TTN
3857 (epn (car (last point-list)))
3858 (epn-1 (car (last point-list 2)))
b95b34e5
GM
3859 (xn (artist-endpoint-get-x epn))
3860 (yn (artist-endpoint-get-y epn))
3861 (xn-1 (artist-endpoint-get-x epn-1))
3862 (yn-1 (artist-endpoint-get-y epn-1))
3863 (dirn (artist-find-direction xn-1 yn-1 xn yn)))
3864 (setq artist-arrow-point-1 (artist-make-arrow-point x1 y1 dir1))
3865 (setq artist-arrow-point-2 (artist-make-arrow-point xn yn dirn))))
3866
3867
3868(defun artist-set-arrow-points-for-2points (shape x1 y1 x2 y2)
3869 "Generic function for setting arrow-points for 2-point shapes.
3870The 2-point shape SHAPE is drawn from X1, Y1 to X2, Y2."
3871 (let* ((endpoint1 (artist-2point-get-endpoint1 shape))
3872 (endpoint2 (artist-2point-get-endpoint2 shape))
3873 (x1 (artist-endpoint-get-x endpoint1))
3874 (y1 (artist-endpoint-get-y endpoint1))
3875 (x2 (artist-endpoint-get-x endpoint2))
3876 (y2 (artist-endpoint-get-y endpoint2)))
3877 (setq artist-arrow-point-1
3878 (artist-make-arrow-point x1 y1
3879 (artist-find-direction x2 y2 x1 y1)))
3880 (setq artist-arrow-point-2
3881 (artist-make-arrow-point x2 y2
3882 (artist-find-direction x1 y1 x2 y2)))))
3883
3884
3885;;
3886;; Common routine for drawing/undrawing shapes based
3887;; on the draw-how
3888;;
3889
3890(defun artist-key-undraw-continously (x y)
3891 "Undraw current continous shape with point at X, Y."
3892 ;; No undraw-info for continous shapes
3893 nil)
3894
3895(defun artist-key-undraw-poly (x y)
3896 "Undraw current poly shape with point at X, Y."
3897 (let ((undraw-fn (artist-go-get-undraw-fn-from-symbol artist-curr-go))
3898 (x1 (artist-endpoint-get-x artist-key-endpoint1))
3899 (y1 (artist-endpoint-get-y artist-key-endpoint1)))
3900 (artist-funcall undraw-fn artist-key-shape)))
3901
3902(defun artist-key-undraw-1point (x y)
3903 "Undraw current 1-point shape at X, Y."
3904 ;; No undraw-info for 1-point shapes
3905 nil)
3906
3907(defun artist-key-undraw-2points (x y)
3908 "Undraw current 2-point shape at X, Y."
3909 (let ((undraw-fn (artist-go-get-undraw-fn-from-symbol artist-curr-go))
3910 (x1 (artist-endpoint-get-x artist-key-endpoint1))
3911 (y1 (artist-endpoint-get-y artist-key-endpoint1)))
3912 (artist-funcall undraw-fn artist-key-shape)))
3913
3914(defun artist-key-undraw-common ()
3915 "Common routine undrawing current shape."
3916 (let ((draw-how (artist-go-get-draw-how-from-symbol artist-curr-go))
3917 (col (artist-current-column))
3918 (row (artist-current-line)))
3919
3920 ;; Depending on what we are currently drawing, call other routines
3921 ;; that knows how to do the job
3922 ;;
3923 (cond ((eq draw-how 'artist-do-continously)
3924 (artist-key-undraw-continously col row))
3925 ((eq draw-how 'artist-do-poly)
3926 (artist-key-undraw-poly col row))
3927 ((and (numberp draw-how) (= draw-how 1))
3928 (artist-key-undraw-1point col row))
3929 ((and (numberp draw-how) (= draw-how 2))
3930 (artist-key-undraw-2points col row))
3931 (t (message "Undrawing \"%s\"s is not yet implemented" draw-how)))
3932
3933 ;; Now restore the old position
3934 ;;
3935 (artist-move-to-xy col row)))
3936
3937
3938
3939;; Implementation note: This really should honor the interval-fn entry
3940;; in the master table, `artist-mt', which would mean leaving a timer
3941;; that calls `draw-fn' every now and then. That timer would then have
3942;; to be cancelled and reinstalled whenever the user moves the cursor.
3943;; This could be done, but what if the user suddenly switches to another
3944;; drawing mode, or even kills the buffer! In the mouse case, it is much
3945;; simpler: when at the end of `artist-mouse-draw-continously', the
3946;; user has released the button, so the timer will always be cancelled
3947;; at that point.
3948(defun artist-key-draw-continously (x y)
98d92ce3 3949 "Draw current continous shape at X,Y."
b95b34e5
GM
3950 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go)))
3951 (setq artist-key-shape (artist-funcall draw-fn x y))))
3952
3953(defun artist-key-draw-poly (x y)
98d92ce3 3954 "Draw current poly-point shape with nth point at X,Y."
b95b34e5
GM
3955 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
3956 (x1 (artist-endpoint-get-x artist-key-endpoint1))
3957 (y1 (artist-endpoint-get-y artist-key-endpoint1)))
3958 (setq artist-key-shape (artist-funcall draw-fn x1 y1 x y))))
3959
3960(defun artist-key-draw-1point (x y)
98d92ce3 3961 "Draw current 1-point shape at X,Y."
b95b34e5
GM
3962 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go)))
3963 (setq artist-key-shape (artist-funcall draw-fn x y))))
3964
3965
3966(defun artist-key-draw-2points (x y)
98d92ce3 3967 "Draw current 2-point shape at X,Y."
b95b34e5
GM
3968 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
3969 (x1 (artist-endpoint-get-x artist-key-endpoint1))
3970 (y1 (artist-endpoint-get-y artist-key-endpoint1)))
3971 (setq artist-key-shape (artist-funcall draw-fn x1 y1 x y))))
3972
3973(defun artist-key-draw-common ()
3974 "Common routine for drawing current shape."
3975 (let ((draw-how (artist-go-get-draw-how-from-symbol artist-curr-go))
3976 (col (artist-current-column))
3977 (row (artist-current-line)))
3978
3979 ;; Depending on what we are currently drawing, call other routines
3980 ;; that knows how to do the job
3981 ;;
3982 (cond ((eq draw-how 'artist-do-continously)
3983 (artist-key-draw-continously col row))
3984 ((eq draw-how 'artist-do-poly)
3985 (artist-key-draw-poly col row))
3986 ((and (numberp draw-how) (= draw-how 1))
3987 (artist-key-draw-1point col row))
3988 ((and (numberp draw-how) (= draw-how 2))
3989 (artist-key-draw-2points col row))
3990 (t (message "Drawing \"%s\"s is not yet implemented" draw-how)))
3991
3992 ;; Now restore the old position
3993 ;;
3994 (artist-move-to-xy col row)))
3995
3996
3997
3998;;
3999;; Functions related to trimming line-endings
4000;; The region between the topmost and bottommost visited line is
4001;; called a draw-region.
4002;;
4003
4004(defun artist-draw-region-reset ()
4005 "Reset the current draw-region."
4006 (setq artist-draw-region-max-y 0)
4007 (setq artist-draw-region-min-y 1000000))
4008
4009(defun artist-draw-region-trim-line-endings (min-y max-y)
4010 "Trim lines in current draw-region from MIN-Y to MAX-Y.
5445d287 4011Trimming here means removing white space at end of a line."
b95b34e5
GM
4012 ;; Safetyc check: switch min-y and max-y if if max-y is smaller
4013 (if (< max-y min-y)
4014 (let ((tmp min-y))
4015 (setq min-y max-y)
4016 (setq max-y tmp)))
4017 (save-excursion
4018 (let ((curr-y min-y))
4019 (while (<= curr-y max-y)
4020 (artist-move-to-xy 0 curr-y)
4021 (end-of-line)
4022 (delete-horizontal-space)
4023 (setq curr-y (1+ curr-y))))))
4024
4025;;
4026;; Drawing shapes by using keys
4027;;
4028
4029(defun artist-key-do-continously-continously (x y)
4030 "Update current continous shape at X,Y."
4031 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go)))
4032 (artist-funcall draw-fn x y)))
4033
4034
4035(defun artist-key-do-continously-poly (x y)
4036 "Update current poly-point shape with nth point at X,Y."
4037 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
4038 (undraw-fn (artist-go-get-undraw-fn-from-symbol artist-curr-go))
4039 (x1 (artist-endpoint-get-x artist-key-endpoint1))
4040 (y1 (artist-endpoint-get-y artist-key-endpoint1))
4041 (x2 x)
4042 (y2 y))
4043 ;; If not rubber-banding, then move the 2
4044 ;; Otherwise re-draw the shape to the new position
4045 ;;
4046 (if (not artist-rubber-banding)
4047 (progn
4048 (artist-no-rb-unset-point2)
4049 (artist-no-rb-set-point2 x y))
4050 (progn
4051 (artist-funcall undraw-fn artist-key-shape)
4052 (setq artist-key-shape (artist-funcall draw-fn x1 y1 x2 y2))))))
4053
4054
4055(defun artist-key-do-continously-1point (x y)
4056 "Update current 1-point shape at X,Y."
4057 ;; Nothing to do continously for operations
4058 ;; where we have only one input point
4059 nil)
4060
4061(defun artist-key-do-continously-2points (x y)
4062 "Update current 2-point shape with 2nd point at X,Y."
4063 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
4064 (undraw-fn (artist-go-get-undraw-fn-from-symbol artist-curr-go))
4065 (x1 (artist-endpoint-get-x artist-key-endpoint1))
4066 (y1 (artist-endpoint-get-y artist-key-endpoint1))
4067 (x2 x)
4068 (y2 y))
4069 ;; If not rubber-banding, then move the 2
4070 ;; Otherwise re-draw the shape to the new position
4071 ;;
4072 (if (not artist-rubber-banding)
4073 (progn
4074 (artist-no-rb-unset-point2)
4075 (artist-no-rb-set-point2 x y))
4076 (progn
4077 (artist-funcall undraw-fn artist-key-shape)
4078 (setq artist-key-shape (artist-funcall draw-fn x1 y1 x2 y2))))))
4079
4080
4081(defun artist-key-do-continously-common ()
4082 "Common routine for updating current shape."
4083 (let ((draw-how (artist-go-get-draw-how-from-symbol artist-curr-go))
4084 (col (artist-current-column))
4085 (row (artist-current-line)))
4086
4087 ;; Depending on what we are currently drawing, call other routines
4088 ;; that knows how to do the job
4089 ;;
4090 (cond ((eq draw-how 'artist-do-continously)
4091 (artist-key-do-continously-continously col row))
4092 ((eq draw-how 'artist-do-poly)
4093 (artist-key-do-continously-poly col row))
4094 ((and (numberp draw-how) (= draw-how 1))
4095 (artist-key-do-continously-1point col row))
4096 ((and (numberp draw-how) (= draw-how 2))
4097 (artist-key-do-continously-2points col row))
4098 (t (message "Drawing \"%s\"s is not yet implemented" draw-how)))
4099
4100 ;; Now restore the old position
4101 ;;
4102 (artist-move-to-xy col row)))
4103
4104
4105(defun artist-key-set-point-continously (x y)
4106 "Set point for current continous shape at X,Y."
4107 ;; Maybe set arrow-points for continous shapes
4108 (let ((arrow-pred (artist-go-get-arrow-pred-from-symbol artist-curr-go))
4109 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol artist-curr-go))
4110 (init-fn (artist-go-get-init-fn-from-symbol artist-curr-go))
4111 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol artist-curr-go))
4112 (exit-fn (artist-go-get-exit-fn-from-symbol artist-curr-go)))
4113
4114 (if (not artist-key-is-drawing)
4115 ;; *** We are about to begin drawing
4116 (progn
4117 (artist-funcall init-fn x y))
4118
4119 ;; *** We are about to stop drawing
4120 (progn
4121
4122 (artist-funcall prep-fill-fn x y)
4123 (if (artist-funcall arrow-pred)
4124 (artist-funcall arrow-set-fn x y)
4125 (artist-clear-arrow-points))
4126 (artist-funcall exit-fn x y))))
4127
4128 ;; Toggle the is-drawing flag
4129 (setq artist-key-is-drawing (not artist-key-is-drawing)))
4130
4131
4132
4133(defun artist-key-set-point-poly (x y &optional this-is-last-point)
4134 "Set point for current poly-point shape at X,Y.
4135If optional argument THIS-IS-LAST-POINT is non-nil, this point is the last."
4136 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
4137 (init-fn (artist-go-get-init-fn-from-symbol artist-curr-go))
4138 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol artist-curr-go))
4139 (exit-fn (artist-go-get-exit-fn-from-symbol artist-curr-go))
4140 (fill-pred (artist-go-get-fill-pred-from-symbol artist-curr-go))
4141 (fill-fn (artist-go-get-fill-fn-from-symbol artist-curr-go))
4142 (arrow-pred (artist-go-get-arrow-pred-from-symbol artist-curr-go))
4143 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol artist-curr-go)))
4144
4145 (if (not artist-key-is-drawing)
4146
4147 ;; *** We were not drawing ==> set first point
4148 (progn
4149
4150 (artist-funcall init-fn x y)
4151
4152 ;; If not rubber-banding, set first point.
4153 ;; Otherwise, draw the shape from x,y to x,y
4154 (if (not artist-rubber-banding)
4155 (artist-no-rb-set-point1 x y)
4156 (setq artist-key-shape (artist-funcall draw-fn x y x y)))
4157
4158 ;; Set first endpoint
4159 (setq artist-key-endpoint1 (artist-make-endpoint x y))
4160
4161 ;; Set point-list to contain start point
4162 (setq artist-key-poly-point-list (list (artist-make-endpoint x y)))
4163
4164 ;; Since we are not ready, set the arrow-points to nil
4165 (artist-clear-arrow-points)
4166
4167 ;; Change state to drawing
4168 (setq artist-key-is-drawing t)
4169
4170 ;; Feedback
5673af85 4171 (message "%s" (substitute-command-keys
b95b34e5
GM
4172 (concat "First point set. "
4173 "Set next with \\[artist-key-set-point], "
4174 "set last with C-u \\[artist-key-set-point]"))))
4175
4176
4177 ;; *** We were drawing ==> we are about to set nth point
4178 ;; (last point if the argument this-is-last-point is non-nil)
4179 ;;
4180 (let ((x1 (artist-endpoint-get-x artist-key-endpoint1))
4181 (y1 (artist-endpoint-get-y artist-key-endpoint1))
4182 (x2 x)
4183 (y2 y))
4184
4185 ;; If not rubber-banding, undraw the 1's and 2's, then
4186 ;; draw the shape (if we were rubber-banding, then the
4187 ;; shape is already drawn in artist-key-do-continously-2points.)
4188 ;;
4189 (if (not artist-rubber-banding)
4190 (progn
4191 (artist-no-rb-unset-points)
4192 (setq artist-key-shape (artist-funcall draw-fn x1 y1 x2 y2))))
4193
4194 ;; Set x2 and y2 from shape's second point
4195 ;; (which might be different from the mouse's second point,
4196 ;; if, for example, we are drawing a straight line)
4197 ;;
4198 (if (not (null artist-key-shape))
4199 (let ((endpoint2 (artist-2point-get-endpoint2 artist-key-shape)))
4200 (setq x2 (artist-endpoint-get-x endpoint2))
4201 (setq y2 (artist-endpoint-get-y endpoint2))))
4202
4203 ;; Add the endpoint to the list of poly-points
4204 (setq artist-key-poly-point-list
4205 (append artist-key-poly-point-list
4206 (list (artist-make-endpoint x2 y2))))
4207
4208 ;; Now do handle the case when this is the last point,
4209 ;; and the case when this point isn't the last
4210 ;;
4211 (if (not this-is-last-point)
4212 ;; ** This is not the last point
4213 (progn
4214 ;; Start drawing a new 2-point-shape from last endpoint.
4215
4216 ;; First set the start-point
4217 (setq x1 x2)
4218 (setq y1 y2)
4219 (setq artist-key-endpoint1 (artist-make-endpoint x1 y1))
4220
4221 ;; If we are not rubber-banding, then place the '1
4222 ;; Otherwise, draw the shape from x1,y1 to x1,y1
4223 (if (not artist-rubber-banding)
4224 (artist-no-rb-set-point1 x1 y1)
4225 (setq artist-key-shape (artist-funcall draw-fn x1 y1 x1 y1)))
4226
4227 ;; Feedback
4228 (message "Point set"))
4229
4230 ;; ** This is the last point
4231 (progn
4232
4233 (artist-funcall prep-fill-fn artist-key-poly-point-list)
4234
4235 ;; Maybe fill
4236 (if (artist-funcall fill-pred)
4237 (artist-funcall fill-fn artist-key-shape
4238 artist-key-poly-point-list))
4239
4240 ;; Set the arrow-points
4241 (if (artist-funcall arrow-pred)
4242 (artist-funcall arrow-set-fn artist-key-poly-point-list)
4243 (artist-clear-arrow-points))
4244
4245 (artist-funcall exit-fn artist-key-poly-point-list)
4246
4247 ;; Change state to not drawing
4248 (setq artist-key-shape nil)
4249 (setq artist-key-endpoint1 nil)
4250 (setq artist-key-is-drawing nil)))))))
4251
4252
4253(defun artist-key-set-point-1point (x y)
4254 "Set point for current 1-point shape at X,Y."
4255 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
4256 (init-fn (artist-go-get-init-fn-from-symbol artist-curr-go))
4257 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol artist-curr-go))
4258 (exit-fn (artist-go-get-exit-fn-from-symbol artist-curr-go))
4259 (draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
4260 (arrow-pred (artist-go-get-arrow-pred-from-symbol artist-curr-go))
4261 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol artist-curr-go)))
4262 (artist-funcall init-fn x y)
4263 (artist-funcall draw-fn x y)
4264 (artist-funcall prep-fill-fn x y)
4265 (if (artist-funcall arrow-pred)
4266 (artist-funcall arrow-set-fn x y)
4267 (artist-clear-arrow-points))
4268 (artist-funcall exit-fn x y))
4269 (setq artist-key-shape nil)
4270 (setq artist-key-is-drawing nil))
4271
4272
4273(defun artist-key-set-point-2points (x y)
4274 "Set first or second point in current 2-point shape at X,Y."
4275 (let ((draw-fn (artist-go-get-draw-fn-from-symbol artist-curr-go))
4276 (init-fn (artist-go-get-init-fn-from-symbol artist-curr-go))
4277 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol artist-curr-go))
4278 (exit-fn (artist-go-get-exit-fn-from-symbol artist-curr-go))
4279 (fill-pred (artist-go-get-fill-pred-from-symbol artist-curr-go))
4280 (fill-fn (artist-go-get-fill-fn-from-symbol artist-curr-go))
4281 (arrow-pred (artist-go-get-arrow-pred-from-symbol artist-curr-go))
4282 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol artist-curr-go)))
4283 (if (not artist-key-is-drawing)
4284
4285 ;; *** We were not drawing ==> set first point
4286 (progn
4287
4288 (artist-funcall init-fn x y)
4289
4290 ;; If not rubber-banding, set first point.
4291 ;; Otherwise, draw the shape from x,y to x,y
4292 (if (not artist-rubber-banding)
4293 (artist-no-rb-set-point1 x y)
4294 (setq artist-key-shape (artist-funcall draw-fn x y x y)))
4295
4296 ;; Set first endpoint
4297 (setq artist-key-endpoint1 (artist-make-endpoint x y))
4298
4299 ;; Since we are not ready, clear the arrow-points
4300 (artist-clear-arrow-points)
4301
4302 ;; Change state to drawing
4303 (setq artist-key-is-drawing t))
4304
4305 ;; *** We were drawing ==> we are about to set 2nd point
4306 ;; and end the drawing operation
4307
4308 (let ((x1 (artist-endpoint-get-x artist-key-endpoint1))
4309 (y1 (artist-endpoint-get-y artist-key-endpoint1))
4310 (x2 x)
4311 (y2 y))
4312
4313 ;; If not rubber-banding, undraw the 1's and 2's, then
4314 ;; draw the shape (if we were rubber-banding, then the
4315 ;; shape is already drawn in artist-key-do-continously-2points.)
4316 ;;
4317 (if (not artist-rubber-banding)
4318 (progn
4319 (artist-no-rb-unset-points)
4320 (setq artist-key-shape (artist-funcall draw-fn x1 y1 x2 y2))))
4321
4322 (artist-funcall prep-fill-fn artist-key-shape x1 y1 x2 y2)
4323
4324 ;; Maybe fill
4325 ;;
4326 (if (artist-funcall fill-pred)
4327 (artist-funcall fill-fn artist-key-shape x1 y1 x2 y2))
4328
4329 ;; Maybe set the arrow-points
4330 ;;
4331 (if (artist-funcall arrow-pred)
4332 (artist-funcall arrow-set-fn artist-key-shape x1 y1 x2 y2)
4333 (artist-clear-arrow-points))
4334
4335 (artist-funcall exit-fn artist-key-shape x1 y1 x2 y2)
4336
4337 ;; Change state to not drawing
4338 (setq artist-key-is-drawing nil)))))
4339
4340
4341(defun artist-key-set-point-common (arg)
4342 "Common routine for setting point in current shape.
5445d287 4343With non-nil ARG, set the last point."
b95b34e5
GM
4344 (let ((draw-how (artist-go-get-draw-how-from-symbol artist-curr-go))
4345 (col (artist-current-column))
4346 (row (artist-current-line))
4347 (was-drawing artist-key-is-drawing))
4348
4349 ;; First, if we are about to draw, then reset the draw-region
4350 (if (not artist-key-is-drawing)
4351 (artist-draw-region-reset))
4352
4353 ;; Depending on what we are currently drawing, call other routines
4354 ;; that knows how to do the job
4355 ;;
4356 (cond ((eq draw-how 'artist-do-continously)
4357 (artist-key-set-point-continously col row)
4358 ;; Do this now, otherwise nothing will happen until we move.
4359 (artist-key-do-continously-continously col row))
4360 ((eq draw-how 'artist-do-poly)
4361 (artist-key-set-point-poly col row arg))
4362 ((and (numberp draw-how) (= draw-how 1))
4363 (artist-key-set-point-1point col row))
4364 ((and (numberp draw-how) (= draw-how 2))
4365 (artist-key-set-point-2points col row))
4366 (t (message "Drawing \"%s\"s is not yet implemented" draw-how)))
4367
4368 ;; Maybe trim line endings
4369 (if (and artist-trim-line-endings
4370 was-drawing
4371 (not artist-key-is-drawing))
4372 (artist-draw-region-trim-line-endings artist-draw-region-min-y
4373 artist-draw-region-max-y))
4374
4375 ;; Now restore the old position
4376 ;;
4377 (artist-move-to-xy col row)
4378 (artist-mode-line-show-curr-operation artist-key-is-drawing)))
4379
4380;;
4381;; Key navigation
4382;;
4383
4384(defun artist-previous-line (&optional n)
98d92ce3 4385 "Move cursor up N lines (default is 1), updating current shape.
b95b34e5
GM
4386If N is negative, move cursor down."
4387 (interactive "p")
4388 (let ((col (artist-current-column)))
cb7bddf6
TTN
4389 (forward-line (- n))
4390 (move-to-column col t))
4391 (when artist-key-is-drawing
4392 (artist-key-do-continously-common)))
b95b34e5
GM
4393
4394
4395(defun artist-next-line (&optional n)
98d92ce3 4396 "Move cursor down N lines (default is 1), updating current shape.
b95b34e5
GM
4397If N is negative, move cursor up."
4398 (interactive "p")
4399 (let ((col (artist-current-column)))
cb7bddf6
TTN
4400 (forward-line n)
4401 (move-to-column col t))
4402 (when artist-key-is-drawing
4403 (artist-key-do-continously-common)))
b95b34e5
GM
4404
4405(defun artist-backward-char (&optional n)
98d92ce3 4406 "Move cursor backward N chars (default is 1), updating current shape.
b95b34e5
GM
4407If N is negative, move forward."
4408 (interactive "p")
4409 (if (> n 0)
4410 (artist-forward-char (- n))
4411 (artist-forward-char n)))
4412
4413(defun artist-forward-char (&optional n)
98d92ce3 4414 "Move cursor forward N chars (default is 1), updating current shape.
b95b34e5
GM
4415If N is negative, move backward."
4416 (interactive "p")
4417 (let* ((step-x (if (>= n 0) 1 -1))
4418 (distance (abs n))
4419 (curr-col (artist-current-column))
4420 (new-col (max 0 (+ curr-col (* distance step-x)))))
4421 (if (not artist-key-is-drawing)
4422 (move-to-column new-col t)
4423 (move-to-column new-col t)
4424 (artist-key-do-continously-common))))
4425
4426
4427(defun artist-key-set-point (&optional arg)
4428 "Set a point for the current shape. With optional ARG, set the last point."
4429 (interactive "P")
4430 (artist-key-set-point-common arg))
4431
4432
4433(defun artist-select-fill-char (c)
4434 "Set current fill character to be C."
4435 (interactive "cType fill char (type RET to turn off): ")
4436 (cond ((eq c ?\r) (setq artist-fill-char-set nil)
4437 (message "Fill cancelled"))
4438 (t (setq artist-fill-char-set t)
4439 (setq artist-fill-char c)
4440 (message "Fill set to \"%c\"" c))))
4441
4442
4443(defun artist-select-line-char (c)
4444 "Set current line character to be C."
4445 (interactive "cType line char (type RET to turn off): ")
4446 (cond ((eq c ?\r) (setq artist-line-char-set nil)
4447 (message "Normal lines"))
4448 (t (setq artist-line-char-set t)
4449 (setq artist-line-char c)
4450 (message "Line drawn with \"%c\"" c)))
4451 (if artist-key-is-drawing
4452 (artist-key-do-continously-common)))
4453
4454
4455(defun artist-select-erase-char (c)
4456 "Set current erase character to be C."
4457 (interactive "cType char to use when erasing (type RET for normal): ")
fe6e86db 4458 (cond ((eq c ?\r) (setq artist-erase-char ?\s)
b95b34e5
GM
4459 (message "Normal erasing"))
4460 (t (setq artist-erase-char c)
4461 (message "Erasing with \"%c\"" c)))
4462 (if artist-key-is-drawing
4463 (artist-key-do-continously-common)))
4464
4465(defun artist-charlist-to-string (char-list)
4466 "Convert a list of characters, CHAR-LIST, to a string."
98d92ce3 4467 (concat char-list))
b95b34e5
GM
4468
4469(defun artist-string-to-charlist (str)
4470 "Convert a string, STR, to list of characters."
4471 (append str nil))
4472
4473(defun artist-select-spray-chars (chars initial-char)
4474 "Set current spray characters to be CHARS, starting with INITIAL-CHAR."
4475 ;; This huge unreadable `interactive'-clause does the following
4476 ;; 1. Asks for a string of spray-characters
4477 ;; 2. Asks for the initial character (default is the first),
4478 ;; and loops if the answer is not a char within the string in 1.
4479 (interactive
4480 (let* ((str (read-string "Select spray-can characters, lightest first: "
4481 (artist-charlist-to-string artist-spray-chars)))
4482 (char-list (artist-string-to-charlist str))
4483 (initial (let* ((err-msg "")
4484 (ok nil)
4485 (first-char-as-str (char-to-string (car char-list)))
4486 (first-s) (first-c))
4487 (while (not ok)
4488 (setq first-s
4489 (read-string
4490 (format (concat "%sSelect initial-character, "
4491 "one of \"%s\" (%s): ")
4492 err-msg str first-char-as-str)))
4493 (if (equal first-s "")
4494 (setq first-s first-char-as-str))
4495 (setq first-c (car (artist-string-to-charlist first-s)))
4496 (setq ok (not (null (member first-c char-list))))
4497 (if (not ok)
4498 (setq err-msg (format
4499 "Not in spray-chars: \"%s\". "
4500 (char-to-string first-c)))))
4501 first-c)))
4502 (list char-list initial)))
4503 (setq artist-spray-chars chars)
4504 (setq artist-spray-new-char initial-char)
4505 (message "Spray-chars set to \"%s\", initial: \"%s\""
4506 (artist-charlist-to-string chars) (char-to-string initial-char)))
4507
4508
4509(defun artist-select-operation (op-str)
4510 "Select drawing operation OP-STR."
4511 (interactive (list (completing-read "Select operation: "
4512 artist-key-compl-table)))
4513 (let* ((op-symbol (artist-mt-get-symbol-from-keyword op-str))
4514 (draw-how (if op-symbol
4515 (artist-go-get-draw-how-from-symbol op-symbol)
4516 nil)))
4517 ;; First check that the string was valid
4518 (if (null op-symbol)
4519 (error "Unknown drawing method: %s" op-str))
4520
4521 ;; Second, check that we are not about to switch to a different
4522 ;; kind of shape (do that only if we are drawing with keys;
4523 ;; otherwise this function cannot get called).
4524 (if (and artist-key-is-drawing
4525 (not (equal artist-key-draw-how draw-how)))
4526 (error "Cannot switch to a different kind of shape while drawing"))
4527
4528 ;; If we were drawing, undraw the shape
4529 (if (and artist-key-is-drawing
4530 artist-rubber-banding)
4531 (artist-key-undraw-common))
4532
4533 ;; Set the current operation and draw-how
4534 (setq artist-curr-go op-symbol)
4535 (setq artist-key-draw-how draw-how)
4536
4537 ;; If we were drawing, redraw the shape (but don't if shape
4538 ;; is drawn by setting only one point)
4539 (if (and artist-key-is-drawing
4540 artist-rubber-banding
4541 (not (eq artist-key-draw-how 1)))
4542 (artist-key-draw-common)))
4543
4544 ;; Feedback
4545 (artist-mode-line-show-curr-operation artist-key-is-drawing))
4546
4547
4548(defun artist-toggle-rubber-banding (&optional state)
4549 "Toggle rubber-banding.
4550If optional argument STATE is positive, turn rubber-banding on."
4551 (interactive)
4552 (if artist-key-is-drawing
4553 (error "Cannot toggle rubber-banding while drawing"))
4554 (if (setq artist-rubber-banding
4555 (if (null state) (not artist-rubber-banding)
4556 (> (prefix-numeric-value state) 0)))
4557 (message "Rubber-banding is now on")
4558 (message "Rubber-banding is now off")))
4559
4560
4561(defun artist-toggle-trim-line-endings (&optional state)
4562 "Toggle trimming of line-endings.
4563If optional argument STATE is positive, turn trimming on."
4564 (interactive)
4565 (if (setq artist-trim-line-endings
4566 (if (null state) (not artist-trim-line-endings)
4567 (> (prefix-numeric-value state) 0)))
4568 (message "Trimming is now on")
4569 (message "Trimming is now off")))
4570
4571
4572(defun artist-toggle-borderless-shapes (&optional state)
4573 "Toggle borders of shapes.
4574If optional argument STATE is positive, turn borders on."
4575 (interactive)
4576 (if (setq artist-borderless-shapes
4577 (if (null state) (not artist-borderless-shapes)
4578 (> (prefix-numeric-value state) 0)))
4579 (message "Borders are now off")
4580 (message "Borders are now on")))
4581
4582
4583(defun artist-toggle-first-arrow ()
4584 "Toggle first arrow for shape, if possible."
4585 (interactive)
4586 (save-excursion
4587 (if (not (null artist-arrow-point-1))
4588 (let* ((arrow-point artist-arrow-point-1)
4589 (arrow-state (artist-arrow-point-get-state arrow-point))
4590 (arrow-marker (artist-arrow-point-get-marker arrow-point))
4591 (direction (artist-arrow-point-get-direction arrow-point))
4592 (orig-char (artist-arrow-point-get-orig-char arrow-point))
4593 (arrow-char (aref artist-arrows direction))
4594 (new-state (not arrow-state)))
4595
4596 (goto-char (marker-position arrow-marker))
4597
4598 (if new-state
4599 (if arrow-char
4600 (artist-replace-char arrow-char))
4601 (artist-replace-char orig-char))
4602
4603 (artist-arrow-point-set-state artist-arrow-point-1 new-state)))))
4604
4605(defun artist-toggle-second-arrow ()
4606 "Toggle second arrow for shape, if possible."
4607 (interactive)
4608 (save-excursion
4609 (if (not (null artist-arrow-point-2))
4610 (let* ((arrow-point artist-arrow-point-2)
4611 (arrow-state (artist-arrow-point-get-state arrow-point))
4612 (arrow-marker (artist-arrow-point-get-marker arrow-point))
4613 (direction (artist-arrow-point-get-direction arrow-point))
4614 (orig-char (artist-arrow-point-get-orig-char arrow-point))
4615 (arrow-char (aref artist-arrows direction))
4616 (new-state (not arrow-state)))
4617
4618 (goto-char (marker-position arrow-marker))
4619
4620 (if new-state
4621 (if arrow-char
4622 (artist-replace-char arrow-char))
4623 (artist-replace-char orig-char))
4624
4625 (artist-arrow-point-set-state artist-arrow-point-2 new-state)))))
4626
4627
4628(defun artist-select-op-line ()
4629 "Select drawing lines."
4630 (interactive)
4631 (artist-select-operation "line"))
4632
4633(defun artist-select-op-straight-line ()
4634 "Select drawing straight lines."
4635 (interactive)
4636 (artist-select-operation "straight line"))
4637
4638(defun artist-select-op-rectangle ()
4639 "Select drawing rectangles."
4640 (interactive)
4641 (artist-select-operation "rectangle"))
4642
4643(defun artist-select-op-square ()
4644 "Select drawing squares."
4645 (interactive)
4646 (artist-select-operation "square"))
4647
4648(defun artist-select-op-poly-line ()
4649 "Select drawing poly-lines."
4650 (interactive)
4651 (artist-select-operation "poly-line"))
4652
4653(defun artist-select-op-straight-poly-line ()
4654 "Select drawing straight poly-lines."
4655 (interactive)
4656 (artist-select-operation "straight poly-line"))
4657
4658(defun artist-select-op-ellipse ()
4659 "Select drawing ellipses."
4660 (interactive)
4661 (artist-select-operation "ellipse"))
4662
4663(defun artist-select-op-circle ()
4664 "Select drawing circles."
4665 (interactive)
4666 (artist-select-operation "circle"))
4667
4668(defun artist-select-op-text-see-thru ()
4669 "Select rendering text (see thru)."
4670 (interactive)
4671 (artist-select-operation "text see-thru"))
4672
4673(defun artist-select-op-text-overwrite ()
4674 "Select rendering text (overwrite)."
4675 (interactive)
4676 (artist-select-operation "text overwrite"))
4677
4678(defun artist-select-op-spray-can ()
4679 "Select spraying."
4680 (interactive)
4681 (artist-select-operation "spray-can"))
4682
4683(defun artist-select-op-spray-set-size ()
4684 "Select setting size for spraying."
4685 (interactive)
4686 (artist-select-operation "spray set size"))
4687
4688(defun artist-select-op-erase-char ()
4689 "Select erasing characters."
4690 (interactive)
4691 (artist-select-operation "erase char"))
4692
4693(defun artist-select-op-erase-rectangle ()
4694 "Select erasing rectangles."
4695 (interactive)
4696 (artist-select-operation "erase rectangle"))
4697
4698(defun artist-select-op-vaporize-line ()
4699 "Select vaporizing single lines."
4700 (interactive)
4701 (artist-select-operation "vaporize line"))
4702
4703(defun artist-select-op-vaporize-lines ()
4704 "Select vaporizing connected lines."
4705 (interactive)
4706 (artist-select-operation "vaporize lines"))
4707
4708(defun artist-select-op-cut-rectangle ()
4709 "Select cutting rectangles."
4710 (interactive)
4711 (artist-select-operation "cut rectangle"))
4712
4713(defun artist-select-op-cut-square ()
4714 "Select cutting squares."
4715 (interactive)
4716 (artist-select-operation "cut square"))
4717
4718(defun artist-select-op-copy-rectangle ()
4719 "Select copying rectangles."
4720 (interactive)
4721 (artist-select-operation "copy rectangle"))
4722
4723(defun artist-select-op-copy-square ()
4724 "Select copying squares."
4725 (interactive)
4726 (artist-select-operation "cut square"))
4727
4728(defun artist-select-op-paste ()
4729 "Select pasting."
4730 (interactive)
4731 (artist-select-operation "paste"))
4732
4733(defun artist-select-op-flood-fill ()
4734 "Select flood-filling."
4735 (interactive)
4736 (artist-select-operation "flood-fill"))
4737
4738
4739;; Drawing lines by using mouse
4740;; Mouse button actions
4741;;
4742
4743(defun artist-update-pointer-shape ()
4744 "Perform the update of the X Windows pointer shape."
4745 (set-mouse-color nil))
4746
aa360da1
GM
4747(defvar x-pointer-shape)
4748
b95b34e5
GM
4749(defun artist-set-pointer-shape (new-pointer-shape)
4750 "Set the shape of the X Windows pointer to NEW-POINTER-SHAPE."
4751 (setq x-pointer-shape new-pointer-shape)
4752 (artist-update-pointer-shape))
4753
4754(defsubst artist-event-is-shifted (ev)
4755 "Check whether the shift-key is pressed in event EV."
4756 (memq 'shift (event-modifiers ev)))
4757
4758(defun artist-do-nothing ()
4759 "Function that does nothing."
4760 (interactive))
4761
4762(defun artist-down-mouse-1 (ev)
4763 "Perform drawing action for event EV."
4764 (interactive "@e")
4765 (let* ((real (artist-go-get-symbol-shift
4766 artist-curr-go (artist-event-is-shifted ev)))
4767 (draw-how (artist-go-get-draw-how-from-symbol real))
4768 ;; Remember original values for draw-region-min-y and max-y
4769 ;; in case we are interrupting a key-draw operation.
4770 (orig-draw-region-min-y artist-draw-region-min-y)
4771 (orig-draw-region-max-y artist-draw-region-max-y)
4772 (orig-pointer-shape (if (eq window-system 'x) x-pointer-shape nil))
4773 (echo-keystrokes 10000) ; a lot of seconds
4774 ;; Remember original binding for the button-up event to this
4775 ;; button-down event.
4776 (key (let* ((basic (event-basic-type ev))
4777 (unshifted basic)
4778 (shifted (make-symbol (concat "S-" (symbol-name basic)))))
4779 (if (artist-event-is-shifted ev)
4780 (make-vector 1 shifted)
4781 (make-vector 1 unshifted))))
4782 (orig-button-up-binding (lookup-key (current-global-map) key)))
4783
4784 (unwind-protect
4785 (progn
4786 (if (eq window-system 'x)
4787 (artist-set-pointer-shape artist-pointer-shape))
4788
a9645a66 4789 ;; Redefine the button-up binding temporarily (the original
b95b34e5
GM
4790 ;; binding is restored in the unwind-forms below). This is to
4791 ;; avoid the phenomenon outlined in this scenario:
4792 ;;
4793 ;; 1. A routine which reads something from the mini-buffer (such
4794 ;; as the text renderer) is called from below.
4795 ;; 2. Meanwhile, the users releases the mouse button.
a9645a66 4796 ;; 3. As a (funny :-) coincidence, the binding for the
b95b34e5
GM
4797 ;; button-up event is often mouse-set-point, so Emacs
4798 ;; sets the point to where the button was released, which is
4799 ;; in the buffer where the user wants to place the text.
4800 ;; 4. The user types C-x o (or uses the mouse once again)
4801 ;; until he reaches the mini-buffer which is still prompting
4802 ;; for some text to render.
4803 ;;
4804 ;; To do this foolproof, all local and minor-mode maps should
4805 ;; be searched and temporarily changed as well, since they
4806 ;; too might have some binding for the button-up event,
4807 ;; but I hope dealing with the global map will suffice.
4808 (define-key (current-global-map) key 'artist-do-nothing)
4809
4810 (artist-draw-region-reset)
4811
4812 (artist-mode-line-show-curr-operation t)
4813
4814 (cond ((eq draw-how 'artist-do-continously)
4815 (artist-mouse-draw-continously ev))
4816 ((eq draw-how 'artist-do-poly)
4817 (artist-mouse-draw-poly ev))
4818 ((and (numberp draw-how) (= draw-how 1))
4819 (artist-mouse-draw-1point ev))
4820 ((and (numberp draw-how) (= draw-how 2))
4821 (artist-mouse-draw-2points ev))
4822 (t (message "Drawing \"%s\"s is not yet implemented"
4823 draw-how)))
4824
4825 (if artist-trim-line-endings
4826 (artist-draw-region-trim-line-endings artist-draw-region-min-y
4827 artist-draw-region-max-y))
4828 (setq artist-draw-region-min-y orig-draw-region-min-y)
4829 (setq artist-draw-region-max-y orig-draw-region-max-y))
4830
4831 ; This is protected
4832 (if (eq window-system 'x)
4833 (artist-set-pointer-shape orig-pointer-shape))
4834
4835 (if orig-button-up-binding
4836 (define-key (current-global-map) key orig-button-up-binding))
4837
4838 (artist-mode-line-show-curr-operation artist-key-is-drawing))))
4839
4840
4841(defun artist-mouse-choose-operation (ev op)
5445d287 4842 "Choose operation for event EV and operation OP."
b95b34e5
GM
4843 (interactive
4844 (progn
4845 (select-window (posn-window (event-start last-input-event)))
4846 (list last-input-event
4847 (x-popup-menu last-nonmenu-event artist-popup-menu-table))))
4848
4849 (let ((draw-fn (artist-go-get-draw-fn-from-symbol (car op)))
4850 (set-fn (artist-fc-get-fn-from-symbol (car op))))
4851 (cond
4852
4853 ;; *** It was a draw-function
4854 ((not (listp draw-fn))
4855 (let* ((unshifted (artist-go-get-symbol-shift (car op) nil))
4856 (shifted (artist-go-get-symbol-shift (car op) t))
4857 (shift-state (artist-event-is-shifted ev))
4858 (selected-op (if shift-state shifted unshifted))
4859 (keyword (artist-go-get-keyword-from-symbol selected-op)))
4860 (artist-select-operation keyword)))
4861
4862 ;; *** It was a set/unset function
4863 ((not (listp set-fn))
4864 (call-interactively set-fn)))))
4865
4866
4867(defun artist-down-mouse-3 (ev)
4868 "Erase character or rectangle, depending on event EV."
4869 (interactive "@e")
4870 (let ((artist-curr-go 'erase-char))
4871 (artist-down-mouse-1 ev))
4872 ;; Restore mode-line
4873 (artist-mode-line-show-curr-operation artist-key-is-drawing))
4874
4875
4876;;
4877;; Mouse routines
4878;;
4879
4880(defsubst artist-shift-has-changed (shift-state ev)
4881 "From the last SHIFT-STATE and EV, determine if the shift-state has changed."
4882 ;; This one simply doesn't work.
4883 ;;
4884 ;; There seems to be no way to tell whether the user has pressed shift
4885 ;; while dragging the cursor around when we are in a track-mouse
4886 ;; form. Calling (event-modifiers ev) yields nil :-( Neither is the
4887 ;; (event-basic-type ev) of any help (it is simply `mouse-movement').
4888 ;;
4889 ;; So this doesn't work:
4890 ;; (cond ((and shift-state (not (artist-event-is-shifted ev))) t)
4891 ;; ((and (not shift-state) (artist-event-is-shifted ev)) t)
4892 ;; (t nil))
4893 nil)
4894
4895(defun artist-coord-win-to-buf (coord)
4896 "Convert a window-relative coordinate COORD to a buffer-relative coordinate."
4897 (let ((window-x (car coord))
4898 (window-y (cdr coord))
4899 (window-start-x (window-hscroll))
4900 (window-start-y (save-excursion (goto-char (window-start))
4901 (artist-current-line))))
4902 (cons (+ window-x window-start-x)
4903 (+ window-y window-start-y))))
4904
4905
4906(defun artist-mouse-draw-continously (ev)
98d92ce3 4907 "Generic function for shapes that require 1 point as input.
b95b34e5
GM
4908Operation is done continously while the mouse button is hold down.
4909The event, EV, is the mouse event."
4910 (let* ((unshifted (artist-go-get-symbol-shift artist-curr-go nil))
4911 (shifted (artist-go-get-symbol-shift artist-curr-go t))
4912 (shift-state (artist-event-is-shifted ev))
4913 (op (if shift-state shifted unshifted))
4914 (draw-how (artist-go-get-draw-how-from-symbol op))
4915 (init-fn (artist-go-get-init-fn-from-symbol op))
4916 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol op))
4917 (exit-fn (artist-go-get-exit-fn-from-symbol op))
4918 (draw-fn (artist-go-get-draw-fn-from-symbol op))
4919 (interval-fn (artist-go-get-interval-fn-from-symbol op))
4920 (interval (artist-funcall interval-fn))
4921 (arrow-pred (artist-go-get-arrow-pred-from-symbol op))
4922 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol op))
4923 (ev-start (event-start ev))
4924 (initial-win (posn-window ev-start))
4925 (ev-start-pos (artist-coord-win-to-buf (posn-col-row ev-start)))
4926 (x1 (car ev-start-pos))
4927 (y1 (cdr ev-start-pos))
4928 (shape)
4929 (timer))
4930 (select-window (posn-window ev-start))
4931 (artist-funcall init-fn x1 y1)
4932 (if (not artist-rubber-banding)
4933 (artist-no-rb-set-point1 x1 y1))
4934 (track-mouse
4935 (while (or (mouse-movement-p ev)
4936 (member 'down (event-modifiers ev)))
4937 (setq ev-start-pos (artist-coord-win-to-buf
4938 (posn-col-row (event-start ev))))
4939 (setq x1 (car ev-start-pos))
4940 (setq y1 (cdr ev-start-pos))
4941
4942 ;; Cancel previous timer
4943 (if timer
4944 (cancel-timer timer))
4945
4946 (if (not (eq initial-win (posn-window (event-start ev))))
4947 ;; If we moved outside the window, do nothing
4948 nil
4949
4950 ;; Still in same window:
4951 ;;
4952 ;; Check if user presses or releases shift key
4953 (if (artist-shift-has-changed shift-state ev)
4954
4955 ;; First check that the draw-how is the same as we
4956 ;; already have. Otherwise, ignore the changed shift-state.
4957 (if (not (eq draw-how
4958 (artist-go-get-draw-how-from-symbol
4959 (if (not shift-state) shifted unshifted))))
4960 (message "Cannot switch to shifted operation")
4961
4962 ;; progn is "implicit" since this is the else-part
4963 (setq shift-state (not shift-state))
4964 (setq op (if shift-state shifted unshifted))
4965 (setq draw-how (artist-go-get-draw-how-from-symbol op))
4966 (setq draw-fn (artist-go-get-draw-fn-from-symbol op))))
4967
4968 ;; Draw the new shape
4969 (setq shape (artist-funcall draw-fn x1 y1))
4970 (artist-move-to-xy x1 y1)
4971
4972 ;; Start the timer to call `draw-fn' repeatedly every
4973 ;; `interval' second
4974 (if (and interval draw-fn)
4975 (setq timer (run-at-time interval interval draw-fn x1 y1))))
4976
4977 ;; Read next event
4978 (setq ev (read-event))))
4979
4980 ;; Cancel any timers
4981 (if timer
4982 (cancel-timer timer))
4983
4984 (artist-funcall prep-fill-fn x1 y1)
4985
4986 (if (artist-funcall arrow-pred)
4987 (artist-funcall arrow-set-fn x1 y1)
4988 (artist-clear-arrow-points))
4989
4990 (artist-funcall exit-fn x1 y1)
4991 (artist-move-to-xy x1 y1)))
4992
4993
4994
4995(defun artist-mouse-draw-poly (ev)
4996 "Generic function for shapes requiring several points as input.
4997The event, EV, is the mouse event."
4998 (interactive "@e")
4999 (message "Mouse-1: set new point, mouse-2: set last point")
5000 (let* ((unshifted (artist-go-get-symbol-shift artist-curr-go nil))
5001 (shifted (artist-go-get-symbol-shift artist-curr-go t))
5002 (shift-state (artist-event-is-shifted ev))
5003 (op (if shift-state shifted unshifted))
5004 (draw-how (artist-go-get-draw-how-from-symbol op))
5005 (init-fn (artist-go-get-init-fn-from-symbol op))
5006 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol op))
5007 (exit-fn (artist-go-get-exit-fn-from-symbol op))
5008 (draw-fn (artist-go-get-draw-fn-from-symbol op))
5009 (undraw-fn (artist-go-get-undraw-fn-from-symbol op))
5010 (fill-pred (artist-go-get-fill-pred-from-symbol op))
5011 (fill-fn (artist-go-get-fill-fn-from-symbol op))
5012 (arrow-pred (artist-go-get-arrow-pred-from-symbol op))
5013 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol op))
5014 (ev-start (event-start ev))
5015 (initial-win (posn-window ev-start))
5016 (ev-start-pos (artist-coord-win-to-buf (posn-col-row ev-start)))
5017 (x1-last (car ev-start-pos))
5018 (y1-last (cdr ev-start-pos))
5019 (x2 x1-last)
5020 (y2 y1-last)
5021 (is-down t)
5022 (shape nil)
63db25ed 5023 (point-list nil)
b95b34e5
GM
5024 (done nil))
5025 (select-window (posn-window ev-start))
5026 (artist-funcall init-fn x1-last y1-last)
5027 (if (not artist-rubber-banding)
5028 (artist-no-rb-set-point1 x1-last y1-last))
5029 (track-mouse
5030 (while (not done)
5031 ;; decide what to do
5032 (cond
5033
5034 ;; *** Mouse button is released.
5035 ((and is-down
5036 (or (member 'click (event-modifiers ev))
5037 (member 'drag (event-modifiers ev))))
5038 ;; First, if not rubber-banding, draw the line.
5039 ;;
5040 (if (not artist-rubber-banding)
5041 (progn
5042 (artist-no-rb-unset-points)
5043 (setq shape (artist-funcall draw-fn x1-last y1-last x2 y2))))
5044
5045 ;; Set the second point to the shape's second point
5046 ;; (which might be different from the mouse's second point,
5047 ;; if, for example, we are drawing a straight line)
5048 ;;
5049 (if (not (null shape))
5050 (let ((endpoint2 (artist-2point-get-endpoint2 shape)))
5051 (setq x1-last (artist-endpoint-get-x endpoint2))
5052 (setq y1-last (artist-endpoint-get-y endpoint2))))
5053 (setq point-list (cons (artist-make-endpoint x1-last y1-last)
5054 point-list))
5055 (setq shape nil)
5056 (setq is-down nil))
5057
5058 ;; *** Mouse button 2 or 3 down
5059 ((and (member 'down (event-modifiers ev))
5060 (or (equal (event-basic-type ev) 'mouse-2)
5061 (equal (event-basic-type ev) 'mouse-3)))
5062 ;; Ignore
5063 nil)
5064
5065 ;; *** Mouse button 2 or 3 released
5066 ((and (or (member 'click (event-modifiers ev))
5067 (member 'drag (event-modifiers ev)))
5068 (or (equal (event-basic-type ev) 'mouse-2)
5069 (equal (event-basic-type ev) 'mouse-3)))
5070
5071 ;; This means the end of our poly-line drawing-session.
5072 ;;
5073 (setq done t))
5074
5075 ;; *** Mouse button 1 went down
5076 ((and (not is-down)
5077 (member 'down (event-modifiers ev))
5078 (equal (event-basic-type ev) 'mouse-1))
5079 ;; Check whether the (possibly new, that depends on if shift
5080 ;; has been pressed or released) symbol has the same draw-how
5081 ;; information as the previous had. If it hasn't, we can't
5082 ;; proceed.
5083 ;;
5084 (if (not (eq draw-how
5085 (artist-go-get-draw-how-from-symbol
5086 (if (not shift-state) shifted unshifted))))
5087 (message "Cannot switch operation")
5088 (progn
5089 ;; Decide operation
5090 ;;
5091 (setq unshifted
5092 (artist-go-get-symbol-shift artist-curr-go nil)
5093 shifted
5094 (artist-go-get-symbol-shift artist-curr-go t)
5095 shift-state (artist-event-is-shifted ev)
5096 op (if shift-state shifted unshifted)
5097 draw-how (artist-go-get-draw-how-from-symbol op)
5098 draw-fn (artist-go-get-draw-fn-from-symbol op)
5099 undraw-fn (artist-go-get-undraw-fn-from-symbol op)
5100 fill-pred (artist-go-get-fill-pred-from-symbol op)
5101 fill-fn (artist-go-get-fill-fn-from-symbol op))
5102
5103 ;; Draw shape from last place to this place
5104
5105 ;; set x2 and y2
5106 ;;
5107 (setq ev-start-pos (artist-coord-win-to-buf
5108 (posn-col-row (event-start ev))))
5109 (setq x2 (car ev-start-pos))
5110 (setq y2 (cdr ev-start-pos))
5111
5112 ;; Draw the new shape (if not rubber-banding, place both marks)
5113 ;;
5114 (if artist-rubber-banding
5115 (setq shape (artist-funcall draw-fn x1-last y1-last x2 y2))
5116 (progn
5117 (artist-no-rb-set-point1 x1-last y1-last)
5118 (artist-no-rb-set-point2 x2 y2)))
5119
5120 ;; Show new operation in mode-line
5121 (let ((artist-curr-go op))
5122 (artist-mode-line-show-curr-operation t))))
5123
5124 (setq is-down t))
5125
5126
5127 ;; *** Mouse moved, button is down and we are still in orig window
5128 ((and (mouse-movement-p ev)
5129 is-down
5130 (eq initial-win (posn-window (event-start ev))))
5131 ;; Draw shape from last place to this place
5132 ;;
5133 ;; set x2 and y2
5134 (setq ev-start-pos (artist-coord-win-to-buf
5135 (posn-col-row (event-start ev))))
5136 (setq x2 (car ev-start-pos))
5137 (setq y2 (cdr ev-start-pos))
5138
5139 ;; First undraw last shape
5140 ;; (unset last point if not rubberbanding)
5141 ;;
5142 (artist-funcall undraw-fn shape)
5143
5144 ;; Draw the new shape (if not rubberbanding, set 2nd mark)
5145 ;;
5146 (if artist-rubber-banding
5147 (setq shape (artist-funcall draw-fn x1-last y1-last x2 y2))
5148 (progn
5149 (artist-no-rb-unset-point2)
5150 (artist-no-rb-set-point2 x2 y2)))
5151 ;; Move cursor
5152 (artist-move-to-xy x2 y2))
5153
5154 ;; *** Mouse moved, button is down but we are NOT in orig window
5155 ((and (mouse-movement-p ev)
5156 is-down
5157 (not (eq initial-win (posn-window (event-start ev)))))
5158 ;; Ignore
5159 nil)
5160
5161
5162 ;; *** Moving mouse while mouse button is not down
5163 ((and (mouse-movement-p ev) (not is-down))
5164 ;; don't do anything.
5165 nil)
5166
5167
5168 ;; *** Mouse button 1 went down, first time
5169 ((and is-down
5170 (member 'down (event-modifiers ev))
5171 (equal (event-basic-type ev) 'mouse-1))
5172 ;; don't do anything
5173 nil)
5174
5175
5176 ;; *** Another event
5177 (t
5178 ;; End drawing
5179 ;;
5180 (setq done t)))
5181
5182 ;; Read next event (only if we should not stop)
5183 (if (not done)
5184 (setq ev (read-event)))))
5185
5186 ;; Reverse point-list (last points are cond'ed first)
5187 (setq point-list (reverse point-list))
5188
5189 (artist-funcall prep-fill-fn point-list)
5190
5191 ;; Maybe fill
5192 (if (artist-funcall fill-pred)
5193 (artist-funcall fill-fn point-list))
5194
5195 ;; Maybe set arrow points
63db25ed 5196 (if (and point-list (artist-funcall arrow-pred))
b95b34e5
GM
5197 (artist-funcall arrow-set-fn point-list)
5198 (artist-clear-arrow-points))
5199
5200 (artist-funcall exit-fn point-list)
5201 (artist-move-to-xy x2 y2)))
5202
5203
5204(defun artist-mouse-draw-1point (ev)
5205 "Generic function for shapes requiring only 1 point as input.
5206Operation is done once. The event, EV, is the mouse event."
5207 (interactive "@e")
5208 (let* ((unshifted (artist-go-get-symbol-shift artist-curr-go nil))
5209 (shifted (artist-go-get-symbol-shift artist-curr-go t))
5210 (shift-state (artist-event-is-shifted ev))
5211 (op (if shift-state shifted unshifted))
5212 (draw-how (artist-go-get-draw-how-from-symbol op))
5213 (init-fn (artist-go-get-init-fn-from-symbol op))
5214 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol op))
5215 (exit-fn (artist-go-get-exit-fn-from-symbol op))
5216 (draw-fn (artist-go-get-draw-fn-from-symbol op))
5217 (arrow-pred (artist-go-get-arrow-pred-from-symbol op))
5218 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol op))
5219 (ev-start (event-start ev))
5220 (ev-start-pos (artist-coord-win-to-buf (posn-col-row ev-start)))
5221 (x1 (car ev-start-pos))
5222 (y1 (cdr ev-start-pos)))
5223 (select-window (posn-window ev-start))
5224 (artist-funcall init-fn x1 y1)
5225 (artist-funcall draw-fn x1 y1)
5226 (artist-funcall prep-fill-fn x1 y1)
5227 (if (artist-funcall arrow-pred)
5228 (artist-funcall arrow-set-fn x1 y1)
5229 (artist-clear-arrow-points))
5230 (artist-funcall exit-fn x1 y1)
5231 (artist-move-to-xy x1 y1)))
5232
5233
5234(defun artist-mouse-draw-2points (ev)
5235 "Generic function for shapes requiring 2 points as input.
5236The event, EV, is the mouse event."
5237 (interactive "@e")
5238 (let* ((unshifted (artist-go-get-symbol-shift artist-curr-go nil))
5239 (shifted (artist-go-get-symbol-shift artist-curr-go t))
5240 (shift-state (artist-event-is-shifted ev))
5241 (op (if shift-state shifted unshifted))
5242 (draw-how (artist-go-get-draw-how-from-symbol op))
5243 (init-fn (artist-go-get-init-fn-from-symbol op))
5244 (prep-fill-fn (artist-go-get-prep-fill-fn-from-symbol op))
5245 (exit-fn (artist-go-get-exit-fn-from-symbol op))
5246 (draw-fn (artist-go-get-draw-fn-from-symbol op))
5247 (undraw-fn (artist-go-get-undraw-fn-from-symbol op))
5248 (fill-pred (artist-go-get-fill-pred-from-symbol op))
5249 (fill-fn (artist-go-get-fill-fn-from-symbol op))
5250 (arrow-pred (artist-go-get-arrow-pred-from-symbol op))
5251 (arrow-set-fn (artist-go-get-arrow-set-fn-from-symbol op))
5252 (ev-start (event-start ev))
5253 (initial-win (posn-window ev-start))
5254 (ev-start-pos (artist-coord-win-to-buf (posn-col-row ev-start)))
5255 (x1 (car ev-start-pos))
5256 (y1 (cdr ev-start-pos))
5257 (x2)
5258 (y2)
5259 (shape))
5260 (select-window (posn-window ev-start))
5261 (artist-funcall init-fn x1 y1)
5262 (if (not artist-rubber-banding)
5263 (artist-no-rb-set-point1 x1 y1))
5264 (track-mouse
5265 (while (or (mouse-movement-p ev)
5266 (member 'down (event-modifiers ev)))
5267 (setq ev-start-pos (artist-coord-win-to-buf
5268 (posn-col-row (event-start ev))))
5269 (setq x2 (car ev-start-pos))
5270 (setq y2 (cdr ev-start-pos))
5271
5272 (if (not (eq initial-win (posn-window (event-start ev))))
5273 ;; If we moved outside the window, do nothing
5274 nil
5275
5276 ;; Still in same window:
5277 ;;
5278 ;; First undraw last shape (unset last point if not rubberbanding)
5279 (if artist-rubber-banding
5280 (artist-funcall undraw-fn shape)
5281 (artist-no-rb-unset-point2))
5282
5283 ;; Check if user presses or releases shift key
5284 (if (artist-shift-has-changed shift-state ev)
5285
5286 ;; First check that the draw-how is the same as we
5287 ;; already have. Otherwise, ignore the changed shift-state.
5288 (if (not (eq draw-how
5289 (artist-go-get-draw-how-from-symbol
5290 (if (not shift-state) shifted unshifted))))
5291 (message "Cannot switch to shifted operation")
5292
5293 (message "Switching")
5294 ;; progn is "implicit" since this is the else-part
5295 (setq shift-state (not shift-state))
5296 (setq op (if shift-state shifted unshifted))
5297 (setq draw-how (artist-go-get-draw-how-from-symbol op))
5298 (setq draw-fn (artist-go-get-draw-fn-from-symbol op))
5299 (setq undraw-fn (artist-go-get-undraw-fn-from-symbol op))
5300 (setq fill-pred (artist-go-get-fill-pred-from-symbol op))
5301 (setq fill-fn (artist-go-get-fill-fn-from-symbol op))))
5302
5303 ;; Draw the new shape
5304 (if artist-rubber-banding
5305 (setq shape (artist-funcall draw-fn x1 y1 x2 y2))
5306 (artist-no-rb-set-point2 x2 y2))
5307 ;; Move cursor
5308 (artist-move-to-xy x2 y2))
5309
5310
5311 ;; Read next event
5312 (setq ev (read-event))))
5313
5314 ;; If we are not rubber-banding (that is, we were moving around the `2')
5315 ;; draw the shape
5316 (if (not artist-rubber-banding)
5317 (progn
5318 (artist-no-rb-unset-points)
5319 (setq shape (artist-funcall draw-fn x1 y1 x2 y2))))
5320
5321 (artist-funcall prep-fill-fn shape x1 y1 x2 y2)
5322
5323 ;; Maybe fill
5324 (if (artist-funcall fill-pred)
5325 (artist-funcall fill-fn shape x1 y1 x2 y2))
5326
5327 ;; Maybe set arrow-points
5328 (if (artist-funcall arrow-pred)
5329 (artist-funcall arrow-set-fn shape x1 y1 x2 y2)
5330 (artist-clear-arrow-points))
5331
5332 (artist-funcall exit-fn shape x1 y1 x2 y2)
5333 (artist-move-to-xy x2 y2)))
5334
5335
5336;;
5337;; Bug-report-submitting
5338;;
5339(defun artist-submit-bug-report ()
5340 "Submit via mail a bug report on Artist."
5341 (interactive)
5342 (require 'reporter)
5343 (if (y-or-n-p "Do you want to submit a bug report on Artist? ")
5344 (let ((to artist-maintainer-address)
5345 (vars '(window-system
5346 window-system-version
5347 ;;
5348 artist-rubber-banding
5349 artist-interface-with-rect
5350 artist-aspect-ratio
5351 ;; Now the internal ones
5352 artist-curr-go
5353 artist-key-poly-point-list
5354 artist-key-shape
5355 artist-key-draw-how
5356 artist-arrow-point-1
5357 artist-arrow-point-2)))
5358 ;; Remove those variables from vars that are not bound
b5242984 5359 (mapc
b95b34e5
GM
5360 (function
5361 (lambda (x)
5362 (if (not (and (boundp x) (symbol-value x)))
5363 (setq vars (delq x vars))))) vars)
5364 (reporter-submit-bug-report
5365 artist-maintainer-address
5366 (concat "artist.el " artist-version)
5367 vars
5368 nil nil
5369 (concat "Hello Tomas,\n\n"
5370 "I have a nice bug report on Artist for you! Here it is:")))))
5371
5372
5373;;
5374;; Now provide this minor mode
5375;;
5376
5377(provide 'artist)
5378
5379
5380;;; About adding drawing modes
5381;;; --------------------------
5382
5383;; If you are going to add a new drawing mode, read the following
5384;; sketchy outlines to get started a bit easier.
5385;;
5386;; 1. If your new drawing mode falls into one of the following
5387;; categories, goto point 2, otherwise goto point 3.
5388;;
5389;; - Modes where the shapes are drawn continously, as long as
5390;; the mouse button is held down (continous modes).
5391;; Example: the erase-char mode, the pen and pen-line modes.
5392;;
5393;; - Modes where the shape is made up of from 2 points to an
5394;; arbitrary number of points (poly-point modes).
5395;; Example: the poly-line mode
5396;;
5397;; - Modes where the shape is made up of 2 points (2-point
5398;; modes).
5399;; Example: lines, rectangles
5400;;
5401;; - Modes where the shape is made up of 1 point (1-point
5402;; modes). This mode differs from the continous modes in
5403;; that the shape is drawn only once when the mouse button
5404;; is pressed.
5405;; Examples: paste, a flood-fill, vaporize modes
5406;;
5407;;
5408;; 2. To make it easier and more flexible to program new drawing
5409;; modes, you might choose to specify
5410;; init-fn: a function to be called at the very beginning
5411;; of the drawing phase,
5412;; prep-fill-fn: a function to be called before filling,
5413;; arrow-set-fn: a function for setting arrows, to be called
5414;; after filling, and
5415;; exit-fn: a function to be called at the very end of
5416;; the drawing phase.
5417;; For each of the cases below, the arguments given to the init-fn,
5418;; prep-fill-fn, arrow-set-fn and exit-fn are stated.
5419;;
5420;; If your mode matches the continous mode or the 1-point mode:
5421;;
5422;; a. Create a draw-function that draws your shape. Your function
5423;; must take x and y as arguments. The return value is not
5424;; used.
5425;;
5426;; b. Add your mode to the master table, `artist-mt'.
5427;;
5428;; init-fn: x y
5429;; prep-fill-fn: x y
5430;; arrow-set-fn: x y
5431;; exit-fn: x y
5432;;
5433;; If your mode matches the 2-point mode:
5434;;
5435;; a. Create one draw-function that draws your shape and one
5436;; undraw-function that undraws it.
5437;;
5438;; The draw-function must take x1, y1, x2 and y2 as
5439;; arguments. It must return a list with three elements:
5440;; Endpoint1: a vector [x1 y1]
5441;; Endpoint2: a vector [x2 y2]
5442;; Shapeinfo: all info necessary for your undraw-function to
5443;; be able to undraw the shape
5444;; Use the artist-endpoint-* accessors to create and inspect
5445;; the endpoints.
5446;;
5447;; If applicable, you must be able to draw your shape without
5448;; borders if the `artist-borderless-shapes' is non-nil.
5449;; See `artist-draw-rect' for an example.
5450;;
5451;; The undraw-function must take one argument: the list created
5452;; by your draw-function. The return value is not used.
5453;;
5454;; b. If you want to provide a fill-function, then create a
5455;; function that takes 5 arguments: the list created by your
5456;; draw-function, x1, y1, x2 and y2. The return value is not
5457;; used.
5458;;
5459;; c. Add your mode to the master table, `artist-mt'.
5460;;
5461;; init-fn: x1 y1
5462;; prep-fill-fn: shape x1 y1 x2 y2
5463;; arrow-set-fn: shape x1 y1 x2 y2
5464;; exit-fn: shape x1 y1 x2 y2
5465;;
5466;; If your mode matches the poly-point mode:
5467;;
5468;; a. Create one draw-function that draws your shape and one
5469;; undraw-function that undraws it. The draw- and
e6608c12 5470;; undraw-functions are used to draw/undraw a segment of
b95b34e5
GM
5471;; your poly-point mode between 2 points. The draw- and
5472;; undraw-functions are then really 2-point mode functions.
5473;; They must take the same arguments and return the same
5474;; values as those of the 2-point mode.
5475;;
5476;; If applicable, you must be able to draw your shape without
5477;; borders if the `artist-borderless-shapes' is non-nil.
5478;; See `artist-draw-rect' for an example.
5479;;
5480;; b. If you want to provide a fill-function, then create a
5481;; function that takes 1 argument: a list of points where each
5482;; point is a vector, [x, y].
5483;;
5484;; c. Add your mode to the master table, `artist-mt'.
5485;;
5486;; init-fn: x1 y1
5487;; prep-fill-fn: point-list
5488;; arrow-set-fn: point-list
5489;; exit-fn: point-list
5490;;
5491;; The arrow-set-fn must set the variables `artist-arrow-point-1'
5492;; and `artist-arrow-point-2'. If your mode does not take arrows,
5493;; you must set the variables to nil. Use the accessors
5494;; artist-arrow-point-* to create and inspect arrow-points.
5495;;
5496;;
5497;; 3. If your mode doesn't match any of the categories, you are facing
5498;; a bit more work, and I cannot be as detailed as above. Here is a
5499;; brief outline of what you have to do:
5500;;
5501;; a. Decide on a name for your type of mode. Let's assume that
5502;; you decided on `xxx'. Then you should use the draw-how
5503;; symbol artist-do-xxx.
5504;;
5505;; b. Create a function artist-mouse-draw-xxx for drawing with
5506;; mouse. It should be called from `artist-down-mouse-1'.
5507;;
5508;; The all coordinates must be converted from window-relative
5509;; to buffer relative before saved or handed over to
5510;; any other function. Converting is done with
5511;; the function `artist-coord-win-to-buf'.
5512;;
5513;; It must take care to the `artist-rubber-banding' variable
5514;; and perform rubber-banding accordingly. Use the
5515;; artist-no-rb-* functions if not rubber-banding.
5516;;
5517;; If applicable, you must be able to draw your shape without
5518;; borders if the `artist-borderless-shapes' is non-nil.
5519;; See `artist-draw-rect' for an example.
5520;;
5521;; You must call the init-fn, the prep-fill-fn, arrow-set-fn
5522;; and the exit-fn at the apropriate points.
5523;;
5524;; When artist-mouse-draw-xxx ends, the shape for your mode
5525;; must be completely drawn.
5526;;
5527;; c. Create functions for drawing with keys:
5528;;
5529;; - artist-key-set-point-xxx for setting a point in the
5530;; mode, to be called from `artist-key-set-point-common'.
5531;;
5532;; - artist-key-do-continously-xxx to be called from
5533;; `artist-key-do-continously-common' whenever the user
5534;; moves around.
5535;;
5536;; As for the artist-mouse-draw-xxx, these two functions must
5537;; take care to do rubber-banding, borderless shapes and to
5538;; set arrows.
5539;;
5540;; These functions should set the variable `artist-key-shape'
5541;; to the shape drawn.
5542;;
5543;; d. Create artist-key-draw-xxx and artist-key-undraw-xxx for
5544;; drawing and undrawing. These are needed when the user
5545;; switches operation to draw another shape of the same type
5546;; of drawing mode.
5547;;
5548;; You should provide these functions. You might think that
5549;; only you is using your type of mode, so noone will be able
5550;; to switch to another operation of the same type of mode,
5551;; but someone else might base a new drawing mode upon your
5552;; work.
5553;;
5554;; You must call the init-fn, the prep-fill-fn, arrow-set-fn
5555;; and the exit-fn at the apropriate points.
5556;;
5557;; e. Add your new mode to the master table, `artist-mt'.
5558;;
5559;;
5560;; Happy hacking! Please let me hear if you add any drawing modes!
5561;; Don't hesitate to ask me any questions.
5562
5563
cbee283d 5564;; arch-tag: 3e63b881-aaaa-4b83-a072-220d4661a8a3
e8af40ee 5565;;; artist.el ends here