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