/
pgl.lisp
2303 lines (1967 loc) · 93.5 KB
/
pgl.lisp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;;; -*- mode:lisp;coding:utf-8 -*-
;;;;**************************************************************************
;;;;FILE: pgl.lisp
;;;;LANGUAGE: Common-Lisp
;;;;SYSTEM: Common-Lisp
;;;;USER-INTERFACE: NONE
;;;;DESCRIPTION
;;;;
;;;; This package implements a Portable Graphics Library using the
;;;; JavaBackEnd from the Stanford Portable Library.
;;;; http://cs.stanford.edu/~eroberts/papers/ITiCSE-2013/PortableGraphicsLibrary.pdf
;;;; https://github.com/cs50/spl
;;;; https://cs.stanford.edu/people/eroberts/jtf/tutorial/UsingTheGraphicsPackage.html
;;;;
;;;; The spl must be installed:
;;;;
;;;; # Required system packages:
;;;; # bash binutils coreutils findutils gcc java-1.?.0-openjdk-devel
;;;;
;;;; cd /usr/local/src
;;;; git clone git@github.com:cs50/spl.git
;;;; cd spl
;;;; make
;;;; make install
;;;;
;;;;
;;;;AUTHORS
;;;; <PJB> Pascal J. Bourguignon <pjb@informatimago.com>
;;;;MODIFICATIONS
;;;; 2017-03-10 <PJB> Added support for clisp.
;;;; 2016-01-30 <PJB> Moved SLOTED-OBJECT to UTLITY; renamed SLOTS to
;;;; SLOTS-FOR-PRINT, use EXTRACT-SLOTS.
;;;; 2015-11-12 <PJB> Created.
;;;;BUGS
;;;; Currently only implemented on CCL using CCL:RUN-PROGRAM.
;;;;LEGAL
;;;; AGPL3
;;;;
;;;; Copyright Pascal J. Bourguignon 2015 - 2017
;;;;
;;;; This program is free software: you can redistribute it and/or modify
;;;; it under the terms of the GNU Affero General Public License as published by
;;;; the Free Software Foundation, either version 3 of the License, or
;;;; (at your option) any later version.
;;;;
;;;; This program is distributed in the hope that it will be useful,
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;;; GNU Affero General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU Affero General Public License
;;;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;;;**************************************************************************
(eval-when (:compile-toplevel :load-toplevel :execute)
(setf *readtable* (copy-readtable nil)))
(defpackage "COM.INFORMATIMAGO.PORTABLE-GRAPHICS-LIBRARY.LOW-LEVEL"
(:nicknames "PGL.LOW-LEVEL")
(:use)
(:documentation "
This package exports the low-level functions
that send messages to the JavaBackEnd.
There shouldn't be a need to use them directly.
Copyright Pascal J. Bourguignon 2015 - 2015
Licensed under the AGPL3.
")
(:export
;; The JavaBackEnd API functions.
"FILE.OPEN-FILE-DIALOG" "3D-RECT.CREATE" "3D-RECT.SET-RAISED"
"ARC.CREATE" "ARC.SET-FRAME-RECTANGLE" "ARC.SET-START-ANGLE"
"ARC.SET-SWEEP-ANGLE" "BUTTON.CREATE" "CHECK-BOX.CREATE"
"CHECK-BOX.IS-SELECTED" "CHECK-BOX.SET-SELECTED" "COMPOUND.ADD"
"COMPOUND.CREATE" "EVENT.GET-NEXT-EVENT" "EVENT.WAIT-FOR-EVENT"
"IMAGE.CREATE" "INTERACTOR.SET-ACTION-COMMAND" "INTERACTOR.GET-SIZE"
"LABEL.CREATE" "LABEL.GET-FONT-ASCENT" "LABEL.GET-FONT-DESCENT"
"LABEL.GET-SIZE" "LABEL.SET-FONT" "LABEL.SET-LABEL" "LINE.CREATE"
"LINE.SET-END-POINT" "LINE.SET-START-POINT" "OBJECT.CONTAINS"
"OBJECT.DELETE" "OBJECT.GET-BOUNDS" "OBJECT.REMOVE" "OBJECT.ROTATE"
"OBJECT.SCALE" "OBJECT.SEND-BACKWARD" "OBJECT.SEND-FORWARD"
"OBJECT.SEND-TO-BACK" "OBJECT.SEND-TO-FRONT" "OBJECT.SET-COLOR"
"OBJECT.SET-FILL-COLOR" "OBJECT.SET-FILLED" "OBJECT.SET-LINE-WIDTH"
"OBJECT.SET-LOCATION" "OBJECT.SET-SIZE" "OBJECT.SET-VISIBLE"
"OVAL.CREATE" "POLYGON.ADD-VERTEX" "POLYGON.CREATE" "RECT.CREATE"
"ROUND-RECT.CREATE" "SLIDER.CREATE" "SLIDER.GET-VALUE"
"SLIDER.SET-VALUE" "TEXT-FIELD.CREATE" "TEXT-FIELD.GET-TEXT"
"TEXT-FIELD.SET-TEXT" "CHOOSER.CREATE" "CHOOSER.ADD-ITEM"
"CHOOSER.GET-SELECTED-ITEM" "CHOOSER.SET-SELECTED-ITEM" "TIMER.CREATE"
"TIMER.DELETE" "TIMER.PAUSE" "TIMER.START" "TIMER.STOP"
"WINDOW.ADD-TO-REGION" "WINDOW.SET-REGION-ALIGNMENT" "WINDOW.CLEAR"
"WINDOW.CLOSE" "WINDOW.CREATE" "WINDOW.DELETE" "WINDOW.DRAW"
"WINDOW.EXIT-GRAPHICS" "WINDOW.GET-SCREEN-HEIGHT"
"WINDOW.GET-SCREEN-WIDTH" "WINDOW.REPAINT" "WINDOW.REQUEST-FOCUS"
"WINDOW.SET-RESIZABLE" "WINDOW.SET-TITLE" "WINDOW.SET-VISIBLE"
"TOP-COMPOUND.CREATE" "CONSOLE.CLEAR" "CONSOLE.GET-LINE"
"CONSOLE.PRINT" "CONSOLE.PRINTLN" "CONSOLE.SET-FONT"
"CONSOLE.SET-SIZE" "SOUND.CREATE" "SOUND.DELETE" "SOUND.PLAY"))
(defpackage "COM.INFORMATIMAGO.PORTABLE-GRAPHICS-LIBRARY"
(:nicknames "PGL" "COM.INFORMATIMAGO.PGL")
(:documentation "
This package implements a Portable Graphics Library using the
JavaBackEnd from the Stanford Portable Library.
http://cs.stanford.edu/~eroberts/papers/ITiCSE-2013/PortableGraphicsLibrary.pdf
https://github.com/cs50/spl
It defines and export a set of CLOS classes to represent the GUI
objects of the JavaBackEnd, along with methods to send the requests
and process the results.
The access to the JavaBackEnd is guarded by a mutex, so it should be
possible to accessed from multiple threads. However, the objects
defined in this library are not thread-safe, so care should be taken
when mutating the same object from several threads. It is assumed
that distinct threads will work with different objects.
Copyright Pascal J. Bourguignon 2015 - 2017
Licensed under the AGPL3.
")
(:use "COMMON-LISP"
"TRIVIAL-GRAY-STREAMS"
"BORDEAUX-THREADS"
"ORG.MAPCAR.PARSE-NUMBER"
"COM.INFORMATIMAGO.COMMON-LISP.CESARUM.STRING"
"COM.INFORMATIMAGO.COMMON-LISP.CESARUM.UTILITY"
"COM.INFORMATIMAGO.COMMON-LISP.CESARUM.QUEUE"
"COM.INFORMATIMAGO.PORTABLE-GRAPHICS-LIBRARY.LOW-LEVEL")
(:import-from "UIOP" "GETENV")
(:export
;; The base types and structures:
"INT" "DOUBLE"
"DIMENSION" "MAKE-DIMENSION" "COPY-DIMENSION" "DIMENSION-P"
"DIMENSION-WIDTH" "DIMENSION-HEIGHT"
"POINT" "MAKE-POINT" "COPY-POINT" "POINT-P" "X" "Y"
"RECTANGLE" "MAKE-RECTANGLE" "COPY-RECTANGLE" "RECTANGLE-P"
"X" "Y" "WIDTH" "HEIGHT"
"RECTANGLE-EMPTYP" "RECTANGLE-CONTAINS-POINT-P")
(:export
;; Event Masks:
"+ACTION-EVENT+" "+KEY-EVENT+" "+TIMER-EVENT+" "+WINDOW-EVENT+"
"+MOUSE-EVENT+" "+CLICK-EVENT+" "+ANY-EVENT+"
;; Event Types:
"+WINDOW-CLOSED+" "+WINDOW-RESIZED+" "+ACTION-PERFORMED+"
"+MOUSE-CLICKED+" "+MOUSE-PRESSED+" "+MOUSE-RELEASED+" "+MOUSE-MOVED+"
"+MOUSE-DRAGGED+" "+KEY-PRESSED+" "+KEY-RELEASED+" "+KEY-TYPED+"
"+TIMER-TICKED+"
;; Event class:
"EVENT" "EVENT-TYPE" "EVENT-MODIFIERS" "EVENT-TIME" "EVENT-WINDOW"
"EVENT-SOURCE" "EVENT-ACTION-COMMAND" "EVENT-X" "EVENT-Y"
"EVENT-KEY-CHAR" "EVENT-KEY-CODE" "EVENT-TIMER"
"EVENT-TYPE-KEYWORD"
;; Event functions:
"WAIT-FOR-CLICK" "WAIT-FOR-EVENT" "GET-NEXT-EVENT")
(:export
"*DEFAULT-LABEL-FONT*" "*DEFAULT-CORNER*" "*ARC-TOLERANCE*"
"*LINE-TOLERANCE*"
"SQUARE" "DEGREE-TO-RADIAN" "RADIAN-TO-DEGREE" "COS-DEGREE" "SIN-DEGREE"
"SCREEN-WIDTH" "SCREEN-HEIGHT" "PAUSE")
(:export
;; Portable Graphic Library classes and methods:
"TIMER" "DURATION-MS" "START-TIMER" "STOP-TIMER"
"OBJECT" "ID" "X" "Y" "WIDTH" "HEIGHT" "COLOR" "FILL-COLOR"
"LINE-WIDTH" "FILLED" "VISIBLE" "SET-LOCATION" "SET-SIZE"
"SET-COLOR" "SET-FILL-COLOR" "SET-LINE-WIDTH" "SET-FILLED"
"SET-VISIBLE" "ROTATE" "SCALE" "SEND-BACKWARD" "SEND-FORWARD"
"SEND-TO-BACK" "SEND-TO-FRONT"
"RECT" "3DRECT" "RAISED" "ROUND-RECT" "CORNER" "OVAL" "CONTAINS"
"LINE" "START-POINT" "END-POINT" "SET-START-POINT" "SET-END-POINT"
"ARC" "START" "SWEEP" "SET-FRAME-RECTANGLE" "CONTAINS-ANGLE"
"BOUNDS" "POLYGON" "VERTICES" "CX" "CY" "ADD-VERTEX" "ADD-VERTICES"
"ADD-EDGE" "ADD-POLAR-EDGE" "COMPONENTS" "COMPOUND-ADD"
"COMPOUND-REMOVE" "GET-OBJECT-AT" "COMPOUND" "TOP-COMPOUND" "LABEL"
"FONT" "TEXT" "ASCENT" "DESCENT" "SET-FONT" "SET-TEXT" "IMAGE"
"FILENAME" "INTERACTOR" "ACTION-COMMAND" "LABEL"
"SET-ACTION-COMMAND" "GET-SIZE" "BUTTON" "CHECK-BOX" "SELECTED"
"SELECTED" "SET-SELECTED" "SLIDER" "MINIMUM" "MAXIMUM" "VALUE"
"SET-VALUE" "TEXT-FIELD" "NCHARS" "CHOOSER" "ITEMS" "SELECTED-ITEM"
"ADD-ITEM" "SET-SELECTED-ITEM" "WINDOW" "COLOR" "TITLE" "RESIZABLE"
"TOP-COMPOUND" "CLOSE-WINDOW" "REQUEST-FOCUS" "REPAINT-WINDOW" "CLEAR-WINDOW"
"SET-VISIBLE" "SET-RESIZABLE" "SET-TITLE" "DRAW-LINE"
"DRAW-POLAR-LINE" "DRAW-OVAL" "FILL-OVAL" "DRAW-RECT" "FILL-RECT"
"DRAW" "DRAW-AT" "COMPOUND-ADD-AT" "COMPOUND-ADD-TO-REGION" "FREE"
"LOCATION")
(:export
;; The *console-io* stream:
"*CONSOLE-IO*" "CONSOLE-STREAM" "CONSOLE-SET-SIZE"
"CONSOLE-SET-FONT" "CONSOLE-CLEAR")
(:export
"*COLORS*" "*BLACK*" "*DARK-GRAY*" "*GRAY*" "*LIGHT-GRAY*"
"*WHITE*" "*RED*" "*YELLOW*" "*GREEN*" "*CYAN*" "*BLUE*"
"*MAGENTA*" "*ORANGE*" "*PINK*")
(:export
;; Backend.
"OPEN-BACKEND" "CLOSE-BACKEND" "*PROGRAM-NAME*" "*JAVA-PROGRAM*"
"*SPL-PATH*" "JBE-ERROR" "JBE-SYNTAX-ERROR")
(:export
;; Extensions
"WINDOWS" "INTERACTORS" "TIMERS"))
(in-package "COM.INFORMATIMAGO.PORTABLE-GRAPHICS-LIBRARY")
(declaim (declaration stepper))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Basic types and geometric structures
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(deftype int () `(integer ,(- (expt 2 31)) ,(- (expt 2 31) 1)))
(deftype double () 'double-float)
(defun int (real) (round real))
(defun double (real) (coerce real 'double))
(defstruct point (x 0.0d0) (y 0.0d0))
(defstruct dimension (width 0.0d0) (height 0.0d0))
(defstruct rectangle (x 0.0d0) (y 0.0d0) (width 0.0d0) (height 0.0d0))
(defgeneric x (object)
(:method ((p point)) (point-x p))
(:method ((r rectangle)) (rectangle-x r)))
(defgeneric y (object)
(:method ((p point)) (point-y p))
(:method ((r rectangle)) (rectangle-y r)))
(defgeneric width (object)
(:method ((p point)) 0)
(:method ((r rectangle)) (rectangle-width r))
(:method ((d dimension)) (dimension-width d)))
(defgeneric height (object)
(:method ((p point)) 0)
(:method ((r rectangle)) (rectangle-height r))
(:method ((d dimension)) (dimension-height d)))
(defun rectangle-emptyp (r)
"Whether the rectangle R is empty (null area)."
(or (not (plusp (width r)))
(not (plusp (height r)))))
(defun rectangle-contains-point-p (r p)
"Whether the point P is inside the rectangle R (inclusive of the perimeter."
(and (<= (x r) (x p) (+ (x r) (width r)))
(<= (y r) (y p) (+ (y r) (height r)))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Events
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(eval-when (:compile-toplevel :load-toplevel :execute)
(defconstant +action-event+ #x010)
(defconstant +key-event+ #x020)
(defconstant +timer-event+ #x040)
(defconstant +window-event+ #x080)
(defconstant +mouse-event+ #x100)
(defconstant +click-event+ #x200)
(defconstant +any-event+ #x3f0))
(eval-when (:compile-toplevel :load-toplevel :execute)
(defconstant +window-closed+ (+ +window-event+ 1))
(defconstant +window-resized+ (+ +window-event+ 2))
(defconstant +last-window-closed+ (+ +window-event+ 15))
(defconstant +action-performed+ (+ +action-event+ 1))
(defconstant +mouse-clicked+ (+ +mouse-event+ 1))
(defconstant +mouse-pressed+ (+ +mouse-event+ 2))
(defconstant +mouse-released+ (+ +mouse-event+ 3))
(defconstant +mouse-moved+ (+ +mouse-event+ 4))
(defconstant +mouse-dragged+ (+ +mouse-event+ 5))
(defconstant +key-pressed+ (+ +key-event+ 1))
(defconstant +key-released+ (+ +key-event+ 2))
(defconstant +key-typed+ (+ +key-event+ 3))
(defconstant +timer-ticked+ (+ +timer-event+ 1)))
(defclass event ()
((type :initarg :type :initform 0 :type int :reader event-type)
(modifiers :initarg :modifiers :initform 0 :type int :reader event-modifiers)
(time :initarg :time :initform 0.0d0 :type double :reader event-time)
(window :initarg :window :initform nil :type (or null window) :reader event-window)
(source :initarg :source :initform nil :type (or null object) :reader event-source)
(action-command :initarg :action-command :initform nil :type (or null string) :reader event-action-command)
(x :initarg :x :initform 0.0d0 :type double :reader event-x)
(y :initarg :y :initform 0.0d0 :type double :reader event-y)
(key-char :initarg :key-char :initform nil :type (or null character) :reader event-key-char)
(key-code :initarg :key-code :initform 0 :type int :reader event-key-code)
(timer :initarg :timer :initform nil :type (or null timer) :reader event-timer)))
(defmethod print-object ((self event) stream)
(declare (stepper disable))
(print-unreadable-object (self stream :identity t :type t)
(format stream "~{~S~^ ~}" (list :type (event-type-keyword self)
:modifiers (event-modifiers self)
:time (event-time self)
:window (event-window self)))
(case (logand +any-event+ (event-type self))
((#.+action-event+)
(format stream "~{ ~S~}" (list :source (event-source self)
:action-command (event-action-command self))))
((#.+key-event+)
(format stream "~{ ~S~}" (list :key-char (event-key-char self)
:key-code (event-key-code self))))
((#.+timer-event+)
(format stream "~{ ~S~}" (list :timer (event-timer self))))
((#.+window-event+))
((#.+mouse-event+ #.+click-event+)
(format stream "~{ ~S~}" (list :x (event-x self)
:y (event-y self))))))
self)
(defmethod event-type ((self null)) 0)
(defgeneric event-type-keyword (event)
(:documentation "
RETURN: the event type as a lisp keyword, one of:
:WINDOW-CLOSED :WINDOW-RESIZED :LAST-WINDOW-CLOSED
:ACTION-PERFORMED :MOUSE-CLICKED :MOUSE-PRESSED
:MOUSE-RELEASED :MOUSE-MOVED :MOUSE-DRAGGED :KEY-PRESSED
:KEY-RELEASED :KEY-TYPED :TIMER-TICKED
")
(:method ((event null))
nil)
(:method ((event event))
(ecase (event-type event)
((#.+window-closed+) :window-closed)
((#.+window-resized+) :window-resized)
((#.+last-window-closed+) :last-window-closed)
((#.+action-performed+) :action-performed)
((#.+mouse-clicked+) :mouse-clicked)
((#.+mouse-pressed+) :mouse-pressed)
((#.+mouse-released+) :mouse-released)
((#.+mouse-moved+) :mouse-moved)
((#.+mouse-dragged+) :mouse-dragged)
((#.+key-pressed+) :key-pressed)
((#.+key-released+) :key-released)
((#.+key-typed+) :key-typed)
((#.+timer-ticked+) :timer-ticked))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Backend
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar *backend-lock* (bt:make-lock "*BACKEND*"))
(defvar *backend* nil)
(defstruct backend
output
input
process
lock)
;; TODO: deal with encodings explicitely in ccl.
#+clisp (defparameter *command-encoding*
;; Note: on MS-Windows you may need to use another charset.
(ext:make-encoding :charset charset:utf-8
:line-terminator :unix
:input-error-action :ignore
:output-error-action #\uFFFD)
"This is the encoding for the java command (we pass the *program-name*
on the command line so it may be outside of ASCII.")
#+clisp (defparameter *jbe-encoding*
(ext:make-encoding :charset charset:utf-8
:line-terminator :dos
:input-error-action #\uFFFD
:output-error-action #\uFFFD)
"This is the encoding for the data exchanged with the java backend.
It shall be UTF-8.")
(defun shell-quote-argument (argument)
"Quote ARGUMENT for passing as argument to an inferior shell."
#+(or MSWINDOWS WIN32)
;; Quote using double quotes, but escape any existing quotes in
;; the argument with backslashes.
(let ((result "")
(start 0)
(end)
(match-beginning)
(match-end))
(when (or (null (setf match-end (position #\" argument)))
(< match-end (length argument)))
(loop
:while (setf match-beginning (position #\" argument :start start))
:do (setf end (1+ match-beginning)
result (concatenate 'string result (subseq argument start end)
"\\" (subseq argument end (1+ end)))
start (1+ end))))
(concatenate 'string "\"" result (subseq argument start) "\""))
#-(or MSWINDOWS WIN32)
(if (equal argument "")
"''"
;; Quote everything except POSIX filename characters.
;; This should be safe enough even for really weird shells.
(let ((result "")
(start 0)
(end)
(match-beginning)
(match-end))
(loop
:while (setf match-end (position-if-not (lambda (ch) (or (alphanumericp ch) (position ch "-_./"))) argument :start start))
:do (setf end match-end
result (concatenate 'string result (subseq argument start end)
"\\" (subseq argument end (1+ end)))
start (1+ end)))
(concatenate 'string result (subseq argument start)))))
(defun make-backend-pipe (command arguments)
(let ((process (progn
#+ccl (ccl:run-program command arguments
:wait nil :pty t
:input :stream
:output :stream
:error *error-output*
:sharing :lock)
#-(and) (multiple-value-list
(ext:letf ((custom:*misc-encoding* *command-encoding*)
(custom:*default-file-encoding* *jbe-encoding*))
(ext:run-program command
:arguments arguments
:wait nil
:input :stream
:output :stream)))
#+clisp (multiple-value-list
(ext:letf ((custom:*misc-encoding* *command-encoding*)
(custom:*default-file-encoding* *jbe-encoding*))
(ext:make-pipe-io-stream (format nil "~A ~{~A~^ ~}"
command
(mapcar (function shell-quote-argument)
arguments))
:element-type 'character
:external-format custom:*default-file-encoding*
:buffered nil)))
#-(or ccl clisp) (progn
(warn "~S not implemented yet." 'make-backend-pipe)
t))))
#+clisp (close (first process))
(make-backend
:process (progn
#+ccl process
#+clisp nil
#-(or ccl clisp) (progn
(warn "~S not implemented yet." 'backend-process)
process))
:output (progn
#+ccl (ccl::external-process-input process)
#+clisp (third process)
#-(or ccl clisp) (progn
(warn "~S not implemented yet." 'backend-output)
*standard-output*))
:input (progn
#+ccl (ccl::external-process-output process)
#+clisp (second process)
#-(or ccl clisp) (progn
(warn "~S not implemented yet." 'backend-input)
*standard-output*))
:lock (bt:make-lock "JBEBackend"))))
(defmacro with-backend-locked (backend &body body)
`(bt:with-lock-held ((backend-lock ,backend))
,@body))
(defvar *java-program* "java"
"The path to the java program.")
(defvar *spl-path* "/usr/local/lib/spl.jar"
"The path to the spl.jar; used unless OPEN-BACKEND :CLASSPATH
argument or the CLASSPATH environment variable says otherwise.")
(defvar *program-name* "Untitled"
"The default program name, displayed in the back-end GUI menubar.")
(defun open-backend (&key (program-name *program-name*) classpath)
"
Launches the JavaBackEnd GUI.
If the backend is already open, nothing is done.
CLASSPATH: If given, then it should be the path to the spl.jar file.
else if the environment variable CLASSPATH is set,
then use it to find the spl.jar,
otherwise use *SPL-PATH* by default.
PROGRAM-NAME: (defaults to *PROGRAM-NAME*) gives the name of
the program to be displayed in the GUI menubar.
"
(bt:with-lock-held (*backend-lock*)
(unless *backend*
(setf *program-name* program-name)
(let ((classpath (or classpath (getenv "CLASSPATH") *spl-path*)))
(setf *backend* (make-backend-pipe *java-program*
(list (format nil "-Xdock:name=~A" program-name)
"-classpath"
classpath
"stanford/spl/JavaBackEnd"
program-name)))))))
(defvar *closing* nil)
(defun close-backend ()
"
Quits the JavaBackEnd GUI.
If the backend is not open, nothing is done.
"
(unless *closing*
(let ((*closing* t))
(bt:with-lock-held (*backend-lock*)
(when *backend*
(unwind-protect
(progn
(ignore-errors (window.exit-graphics))
;; #+ccl (ignore-errors (ccl:signal-external-process (backend-process *backend*) 9 :error-if-exited nil))
(close (backend-output *backend*))
(close (backend-input *backend*)))
(clear-registers)
(setf *backend* nil)))))))
(eval-when (:compile-toplevel :load-toplevel :execute)
(defun decode-boolean (value)
(and (not (null value))
(plusp (length value))
(char-equal #\t (aref value 0)))))
(defvar *jbetrace* (decode-boolean (getenv "JBETRACE")))
(defun send (command &rest arguments)
"Sends a Java Back End command to the Java Back End."
(let ((stream (if *backend*
(backend-output *backend*)
*standard-output*))
(cmd (format nil "~A(~{~A~^,~})" command arguments)))
(when *jbetrace* (format *trace-output* "~&-> ~A~%" cmd))
(clear-input (backend-input *backend*))
(write-line cmd stream)
(force-output stream)))
(define-condition jbe-error (simple-error)
()
(:documentation "Condition for Java Back End errors."))
(define-condition jbe-syntax-error (jbe-error)
()
(:documentation "Condition for Java Back End errors in parsing responses."))
(defvar *event-queue* (make-queue))
(defvar *source-registry* (make-hash-table))
(defvar *window-registry* (make-hash-table))
(defvar *timer-registry* (make-hash-table))
(defun clear-registers ()
(clrhash *source-registry*)
(clrhash *window-registry*)
(clrhash *timer-registry*)
(setf *event-queue* (make-queue)))
(defun get-source (id) (gethash id *source-registry*))
(defun get-window (id) (gethash id *window-registry*))
(defun get-timer (id) (gethash id *timer-registry*))
(defun windows () (hash-table-values *window-registry*))
(defun interactors () (hash-table-values *source-registry*))
(defun timers () (hash-table-values *timer-registry*))
(defgeneric register (self))
(defgeneric unregister (self))
(defun string-unescape (string)
(with-output-to-string (*standard-output*)
(with-input-from-string (*standard-input* string)
(let ((ch (read-char *standard-input* nil)))
(unless (char= ch #\")
(error 'jbe-syntax-error
:format-control "Unexpected character ~S found in string literal ~S"
:format-arguments (list ch string))))
(loop
:with escaped := nil
:for ch := (read-char *standard-input* nil)
:do (if escaped
(progn
(case ch
((#\a) (princ #\Bel))
((#\b) (princ #\bs))
((#\f) (princ #\page))
((#\n) (princ #\newline))
((#\r) (princ #\return))
((#\t) (princ #\tab))
((#\v) (princ #\vt))
((#\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7)
(let ((buffer (make-string 3)))
(setf (aref buffer 0) ch
(aref buffer 1) (read-char *standard-input*)
(aref buffer 2) (read-char *standard-input*))
(unless (and (digit-char-p (aref buffer 1) 8)
(digit-char-p (aref buffer 2) 8))
(error 'jbe-syntax-error
:format-control "Unexpected character ~S found in escape sequence in string literal ~S"
:format-arguments (list ch string)))
(princ (code-char (parse-integer buffer :radix 8)))))
(otherwise (princ ch)))
(setf escaped nil))
(case ch
((#\\) (setf escaped t))
((#\") (loop-finish))
(otherwise (princ ch))))))))
(defun string-escape (string)
(with-output-to-string (*standard-output*)
(with-input-from-string (*standard-input* string)
(princ "\"")
(loop
:for ch := (read-char *standard-input* nil nil)
:while ch
:do (case ch
((#\Bel) (princ "\\a"))
((#\bs) (princ "\\b"))
((#\page) (princ "\\f"))
((#\newline) (princ "\\n"))
((#\return) (princ "\\r"))
((#\tab) (princ "\\t"))
((#\vt) (princ "\\v"))
((#\") (format t "\\~3,'0o" (char-code ch)))
((#\\) (princ "\\\\"))
(otherwise
(if (= 3 (length (prin1-to-string ch)))
(princ ch)
;; bug for bug compatible with spl:
(format t "\\~3,'0o" (logand #xff (char-code ch)))))))
(princ "\""))))
(defun gid (id) (format nil "\"0x~X\"" id))
(defun decode-id (id)
(assert (prefixp "0x" id))
(parse-integer id :start 2 :radix 16))
(defun encode-double (value)
;; We must generate Java floating points.
(substitute #\e #\D (format nil "~:@(~,,,,,,'dE~)" value)
:test (function char-equal)))
(defun get-result ()
(let ((stream (backend-input *backend*)))
(handler-case
(loop
(let ((line (read-line stream)))
(when *jbetrace* (format *trace-output* "~&<- ~A~%" line))
(cond ((prefixp "result:" line)
(return-from get-result (subseq line 7)))
((prefixp "event:" line)
(queue-enqueue *event-queue* (parse-event (subseq line 6)))))))
(error (err)
(princ-to-string err)))))
(defun get-error ()
(let ((result (get-result)))
(unless (or (string-equal result "ok") (string-equal result "ack"))
(error 'jbe-error :format-control "~A" :format-arguments (list result)))))
(defun get-int ()
(parse-integer (get-result)))
(defun parse-double (string)
(let ((*read-default-float-format* 'double-float))
(parse-number (substitute #\d #\e string :test (function char-equal)))))
(defun get-double ()
(parse-double (get-result)))
(defun get-boolean ()
(decode-boolean (get-result)))
(defun get-dimension ()
(let ((scanner (make-scanner (get-result)))
width height)
(eat-token scanner '(symbol . "GDimension"))
(eat-token scanner #\()
(setf width (ensure-token (next-token scanner) 'double))
(eat-token scanner #\,)
(setf height (ensure-token (next-token scanner) 'double))
(eat-token scanner #\))
(make-dimension :width width :height height)))
(defun get-rectangle ()
(let ((scanner (make-scanner (get-result)))
x y width height)
(eat-token scanner '(symbol . "GRectangle"))
(eat-token scanner #\()
(setf x (ensure-token (next-token scanner) 'double))
(eat-token scanner #\,)
(setf y (ensure-token (next-token scanner) 'double))
(eat-token scanner #\,)
(setf width (ensure-token (next-token scanner) 'double))
(eat-token scanner #\,)
(setf height (ensure-token (next-token scanner) 'double))
(eat-token scanner #\))
(make-instance 'rectangle :x (double x)
:y (double y)
:width (double width)
:height (double height))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Scanner
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defun make-scanner (string)
(cons 0 string))
(defun next-char (scanner)
(with-accessors ((pos car) (src cdr)) scanner
(when (< pos (length src)) (aref src pos))))
(defun eat-char (scanner)
(with-accessors ((pos car) (src cdr)) scanner
(when (< pos (length src)) (incf pos))))
(declaim (inline whitespacep))
(defun whitespacep (ch)
(find ch #(#\space #\tab #\newline #\return #\page #\vt)))
(defun skip-spaces (scanner)
(loop :while (whitespacep (next-char scanner))
:do (eat-char scanner)))
(defun next-token (scanner)
(skip-spaces scanner)
(let ((ch (next-char scanner)))
(with-accessors ((pos car) (src cdr)) scanner
(case ch
((nil) ch)
((#\( #\, #\)) (eat-char scanner) ch)
((#\") (let ((start pos))
(eat-char scanner)
(loop
:for ch := (next-char scanner)
:while ch
:do (eat-char scanner)
(case ch
((#\\) (eat-char scanner))
((#\") (loop-finish)))
:finally (return (string-unescape (nsubseq src start pos))))))
((#\+ #\- #\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7 #\8 #\9)
(let ((start pos)
(dot nil)
(exp nil))
(eat-char scanner)
(loop
:for ch := (next-char scanner)
:while ch
:do (case ch
((#\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7 #\8 #\9)
(eat-char scanner))
((#\.)
(if dot
(loop-finish)
(setf dot t))
(eat-char scanner))
((#\e #\E)
(if exp
(loop-finish)
(setf exp '+))
(eat-char scanner))
((#\+ #\-)
(if (eql exp '+)
(setf exp t)
(loop-finish))
(eat-char scanner))
(otherwise
(loop-finish)))
:finally (return (funcall (if (or dot exp)
(function parse-double)
(function parse-integer))
(nsubseq src start pos))))))
((#\A #\a #\B #\b #\C #\c #\D #\d #\E #\e #\F #\f #\G #\g #\H
#\h #\I #\i #\J #\j #\K #\k #\L #\l #\M #\m #\N #\n #\O #\o
#\P #\p #\Q #\q #\R #\r #\S #\s #\T #\t #\U #\u #\V #\v #\W
#\w #\X #\x #\Y #\y #\Z #\z)
(let ((start pos))
(loop
:while (and ch (or (alphanumericp ch) (find ch "_.")))
:do (eat-char scanner)
(setf ch (next-char scanner)))
(let ((token (nsubseq src start pos)))
(cond
((string-equal token "true") '(boolean . t))
((string-equal token "false") '(boolean . nil))
(t (cons 'symbol token))))))
(otherwise (error 'jbe-syntax-error
:format-control "Unexpected character ~S found in reponse ~S"
:format-arguments (list ch src)))))))
(defun expect (scanner expected)
(let ((token (next-token scanner)))
(unless (eql token expected)
(with-accessors ((pos car) (src cdr)) scanner
(error 'jbe-syntax-error
:format-control "Unexpected token ~S found in reponse ~S; expected ~S"
:format-arguments (list token src expected))))))
(defun ensure-token (token expected)
(flet ((e1 () (error 'jbe-syntax-error
:format-control "Expected a ~S, got the ~S ~A"
:format-arguments (list expected (type-of token) token)))
(e2 () (error 'jbe-syntax-error
:format-control "Expected a ~S, got the ~S ~A"
:format-arguments (list expected (car token) (cdr token)))))
(case expected
((symbol boolean)
(if (and (consp token)
(eq expected (car token)))
(cdr token)
(e2)))
((int) (if (typep token 'int) token (e1)))
((double) (if (typep token 'double) token (e1)))
((string) (if (typep token 'string) (string-unescape token) (e1)))
((special) (if (typep token 'character) token (e1)))
(otherwise (cond
((equal token expected) token)
((consp expected) (e2))
(t (e1)))))))
(defun eat-token (scanner expected)
(let ((token (next-token scanner)))
(ensure-token token expected)))
(defun parse-mouse-event (parameters type)
(destructuring-bind (id time modifiers x y) parameters
(make-instance 'event :type type
:window (get-window (decode-id id))
:time time
:modifiers modifiers
:x (double x)
:y (double y))))
(defun parse-key-event (parameters type)
(destructuring-bind (id time modifiers key-char key-code) parameters
(make-instance 'event :type type
:window (get-window (decode-id id))
:time time
:modifiers modifiers
:key-char (code-char key-char)
:key-code key-code)))
(defun parse-timer-event (parameters type)
(destructuring-bind (id time) parameters
(make-instance 'event :type type
:timer (get-timer (decode-id id))
:time time)))
(defun parse-window-event (parameters type)
(destructuring-bind (id time) parameters
(make-instance 'event :type type
:window (get-window (decode-id id))
:time time)))
(defun parse-action-event (parameters type)
(destructuring-bind (id action time) parameters
(make-instance 'event :type type
:window (get-window (decode-id id))
:time time
:action-command action)))
(defun parse-parameters (scanner)
(let ((token (next-token scanner)))
(flet ((ep () (error 'jbe-syntax-error
:format-control "Expected a ( or nothing, got ~S"
:format-arguments (list token)))
(eu () (error 'jbe-syntax-error
:format-control "Expected a , or a ) got ~S"
:format-arguments (list token)))
(ef () (error 'jbe-syntax-error
:format-control "Missing a )")))
(case token
((nil) nil)
((#\()
(loop :for token := (next-token scanner)
:until (eql #\) token)
:collect token
:do (setf token (next-token scanner))
(case token
((#\,))
((#\)) (loop-finish))
((nil) (ef))
(otherwise (eu)))))
(otherwise (ep))))))
(defun parse-event (line)
(let* ((scanner (make-scanner line))
(name (ensure-token (next-token scanner) 'symbol))
(parameters (parse-parameters scanner)))
(scase name
(("mousePressed") (parse-mouse-event parameters +MOUSE-PRESSED+))
(("mouseReleased") (parse-mouse-event parameters +MOUSE-RELEASED+))
(("mouseClicked") (parse-mouse-event parameters +MOUSE-CLICKED+))
(("mouseMoved") (parse-mouse-event parameters +MOUSE-MOVED+))
(("mouseDragged") (parse-mouse-event parameters +MOUSE-DRAGGED+))
(("keyPressed") (parse-key-event parameters +KEY-PRESSED+))
(("keyReleased") (parse-key-event parameters +KEY-RELEASED+))
(("keyTyped") (parse-key-event parameters +KEY-TYPED+))
(("actionPerformed") (parse-action-event parameters +ACTION-PERFORMED+))
(("timerTicked") (parse-timer-event parameters +TIMER-TICKED+))
(("windowClosed") (let ((e (parse-window-event parameters +WINDOW-CLOSED+)))
(close-window (event-window e))
e))
(("windowResized") (parse-window-event parameters +WINDOW-RESIZED+))
(("lastWindowClosed") (parse-window-event parameters +LAST-WINDOW-CLOSED+)))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; The JavaBackEnd Protocol.
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar *c*)
(defun handle-pipe-error (err)
(setf *c* err)
(princ err) (terpri)
(if (and *backend*
(or (eql (stream-error-stream err) (backend-output *backend*))
(eql (stream-error-stream err) (backend-input *backend*)))
(find-restart 'retry err))
(invoke-restart 'retry)
(error err)))
(defmacro with-jbe-pipe-error-handler (&body forms)
(let ((continue (gensym)))
`(loop :named ,continue
:do (handler-bind
((stream-error (function handle-pipe-error)))
(with-simple-restart (retry "Retry after closing and re-opening the backend")
(return-from ,continue (progn ,@forms))))
(ignore-errors (close-backend))
(open-backend))))
(defmacro generate-JBE-functions (&rest definitions)
`(progn
,@(mapcar (lambda (definition)
(destructuring-bind (name jbe-name lambda-list &rest options)
definition
(let ((nolock (find :nolock options))
(errorp (find :error options))
(result-type (first (remove :error (remove :nolock options))))
(parameters (mapcar (function first) lambda-list)))
`(defun ,name ,parameters
(declare (stepper disable))
(let ,(mapcar (lambda (parameter)
(destructuring-bind (name type) parameter
`(,name ,(ecase type
(id `(gid (id ,name)))
(string `(string-escape (string ,name)))
(boolean `(cond (,name "true")
(t "false")))
(int `(round ,name))
(double `(encode-double (coerce ,name 'double)))))))
lambda-list)
(with-jbe-pipe-error-handler
,@(let ((body `((send ,jbe-name ,@parameters)
,@(when errorp
'((get-error)))
,@(ecase result-type
((nil) '((values)))
((string) '((get-result)))
((boolean) '((get-boolean)))
((int) '((get-int)))
((double) '((get-double)))
((dimension) '((get-dimension)))
((rectangle) '((get-rectangle)))))))
(if nolock
body