/
dep-lispworks.lisp
1334 lines (1129 loc) · 46.9 KB
/
dep-lispworks.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; Package: Xlib; Log: clx.log -*-
;; This file contains some of the system dependent code for CLX
;;;
;;; TEXAS INSTRUMENTS INCORPORATED
;;; P.O. BOX 2909
;;; AUSTIN, TEXAS 78769
;;;
;;; Copyright (C) 1987 Texas Instruments Incorporated.
;;;
;;; Permission is granted to any individual or institution to use, copy, modify,
;;; and distribute this software, provided that this complete copyright and
;;; permission notice is maintained, intact, in all copies and supporting
;;; documentation.
;;;
;;; Texas Instruments Incorporated provides this software "as is" without
;;; express or implied warranty.
;;;
(in-package :xlib)
;;; NOTE: This was: #-(or lispworks6 lispworks7), i.e. for LW 6.x and 7.x only.
;;; Now LW 8.x is confirmed working (by running McCLIM), thus we should
;;; enable LW 8.x and all future versions by default, and only very old
;;; LW versions (4.x and 5.x) are disabled here. -- binghe, 2023/12/29
#+(or lispworks4 lispworks5)
(error "Sorry, your ~S lisp version ~S is not currently supported. ~
Patches are welcome."
(lisp-implementation-type) (lisp-implementation-version))
(eval-when (:compile-toplevel :load-toplevel :execute)
(require "comm"))
(proclaim '(declaration array-register))
;;; The size of the output buffer. Must be a multiple of 4.
(defparameter *output-buffer-size* 8192)
;;; Number of seconds to wait for a reply to a server request
(defparameter *reply-timeout* nil)
(defconstant +word-0+ 0)
(defconstant +word-1+ 1)
(defconstant +long-0+ 0)
(defconstant +long-1+ 1)
(defconstant +long-2+ 2)
(defconstant +long-3+ 3)
;;; Set some compiler-options for often used code
(eval-when (:compile-toplevel :load-toplevel :execute)
(defconstant +buffer-speed+ #+clx-debugging 1 #-clx-debugging 3
"Speed compiler option for buffer code.")
(defconstant +buffer-safety+ #+clx-debugging 3 #-clx-debugging 0
"Safety compiler option for buffer code.")
(defconstant +buffer-debug+ #+clx-debugging 2 #-clx-debugging 1
"Debug compiler option for buffer code>")
(defun declare-bufmac ()
`(declare (optimize
(speed ,+buffer-speed+)
(safety ,+buffer-safety+)
(debug ,+buffer-debug+))))
;; It's my impression that in lucid there's some way to make a
;; declaration called fast-entry or something that causes a function
;; to not do some checking on args. Sadly, we have no lucid manuals
;; here. If such a declaration is available, it would be a good
;; idea to make it here when +buffer-speed+ is 3 and +buffer-safety+
;; is 0.
(defun declare-buffun ()
`(declare (optimize
(speed ,+buffer-speed+)
(safety ,+buffer-safety+)
(debug ,+buffer-debug+)))))
(declaim (inline card8->int8 int8->card8
card16->int16 int16->card16
card32->int32 int32->card32))
(defun card8->int8 (x)
(declare (type card8 x))
(declare (clx-values int8))
#.(declare-buffun)
(the int8 (if (logbitp 7 x)
(the int8 (- x #x100))
x)))
(defun int8->card8 (x)
(declare (type int8 x))
(declare (clx-values card8))
#.(declare-buffun)
(the card8 (ldb (byte 8 0) x)))
(defun card16->int16 (x)
(declare (type card16 x))
(declare (clx-values int16))
#.(declare-buffun)
(the int16 (if (logbitp 15 x)
(the int16 (- x #x10000))
x)))
(defun int16->card16 (x)
(declare (type int16 x))
(declare (clx-values card16))
#.(declare-buffun)
(the card16 (ldb (byte 16 0) x)))
(defun card32->int32 (x)
(declare (type card32 x))
(declare (clx-values int32))
#.(declare-buffun)
(the int32 (if (logbitp 31 x)
(the int32 (- x #x100000000))
x)))
(defun int32->card32 (x)
(declare (type int32 x))
(declare (clx-values card32))
#.(declare-buffun)
(the card32 (ldb (byte 32 0) x)))
(declaim (inline aref-card8 aset-card8 aref-int8 aset-int8))
(defun aref-card8 (a i)
(declare (type buffer-bytes a)
(type array-index i))
(declare (clx-values card8))
#.(declare-buffun)
(the card8 (aref a i)))
(defun aset-card8 (v a i)
(declare (type card8 v)
(type buffer-bytes a)
(type array-index i))
#.(declare-buffun)
(setf (aref a i) v))
(defun aref-int8 (a i)
(declare (type buffer-bytes a)
(type array-index i))
(declare (clx-values int8))
#.(declare-buffun)
(card8->int8 (aref a i)))
(defun aset-int8 (v a i)
(declare (type int8 v)
(type buffer-bytes a)
(type array-index i))
#.(declare-buffun)
(setf (aref a i) (int8->card8 v)))
(defun aref-card16 (a i)
(declare (type buffer-bytes a)
(type array-index i))
(declare (clx-values card16))
#.(declare-buffun)
(the card16
(logior (the card16
(ash (the card8 (aref a (index+ i +word-1+))) 8))
(the card8
(aref a (index+ i +word-0+))))))
(defun aset-card16 (v a i)
(declare (type card16 v)
(type buffer-bytes a)
(type array-index i))
#.(declare-buffun)
(setf (aref a (index+ i +word-1+)) (the card8 (ldb (byte 8 8) v))
(aref a (index+ i +word-0+)) (the card8 (ldb (byte 8 0) v)))
v)
(defun aref-int16 (a i)
(declare (type buffer-bytes a)
(type array-index i))
(declare (clx-values int16))
#.(declare-buffun)
(the int16
(logior (the int16
(ash (the int8 (aref-int8 a (index+ i +word-1+))) 8))
(the card8
(aref a (index+ i +word-0+))))))
(defun aset-int16 (v a i)
(declare (type int16 v)
(type buffer-bytes a)
(type array-index i))
#.(declare-buffun)
(setf (aref a (index+ i +word-1+)) (the card8 (ldb (byte 8 8) v))
(aref a (index+ i +word-0+)) (the card8 (ldb (byte 8 0) v)))
v)
(defun aref-card32 (a i)
(declare (type buffer-bytes a)
(type array-index i))
(declare (clx-values card32))
#.(declare-buffun)
(the card32
(logior (the card32
(ash (the card8 (aref a (index+ i +long-3+))) 24))
(the card29
(ash (the card8 (aref a (index+ i +long-2+))) 16))
(the card16
(ash (the card8 (aref a (index+ i +long-1+))) 8))
(the card8
(aref a (index+ i +long-0+))))))
(defun aset-card32 (v a i)
(declare (type card32 v)
(type buffer-bytes a)
(type array-index i))
#.(declare-buffun)
(setf (aref a (index+ i +long-3+)) (the card8 (ldb (byte 8 24) v))
(aref a (index+ i +long-2+)) (the card8 (ldb (byte 8 16) v))
(aref a (index+ i +long-1+)) (the card8 (ldb (byte 8 8) v))
(aref a (index+ i +long-0+)) (the card8 (ldb (byte 8 0) v)))
v)
(defun aref-int32 (a i)
(declare (type buffer-bytes a)
(type array-index i))
(declare (clx-values int32))
#.(declare-buffun)
(the int32
(logior (the int32
(ash (the int8 (aref-int8 a (index+ i +long-3+))) 24))
(the card29
(ash (the card8 (aref a (index+ i +long-2+))) 16))
(the card16
(ash (the card8 (aref a (index+ i +long-1+))) 8))
(the card8
(aref a (index+ i +long-0+))))))
(defun aset-int32 (v a i)
(declare (type int32 v)
(type buffer-bytes a)
(type array-index i))
#.(declare-buffun)
(setf (aref a (index+ i +long-3+)) (the card8 (ldb (byte 8 24) v))
(aref a (index+ i +long-2+)) (the card8 (ldb (byte 8 16) v))
(aref a (index+ i +long-1+)) (the card8 (ldb (byte 8 8) v))
(aref a (index+ i +long-0+)) (the card8 (ldb (byte 8 0) v)))
v)
(defun aref-card29 (a i)
(declare (type buffer-bytes a)
(type array-index i))
(declare (clx-values card29))
#.(declare-buffun)
(the card29
(logior (the card29
(ash (the card8 (aref a (index+ i +long-3+))) 24))
(the card29
(ash (the card8 (aref a (index+ i +long-2+))) 16))
(the card16
(ash (the card8 (aref a (index+ i +long-1+))) 8))
(the card8
(aref a (index+ i +long-0+))))))
(defun aset-card29 (v a i)
(declare (type card29 v)
(type buffer-bytes a)
(type array-index i))
#.(declare-buffun)
(setf (aref a (index+ i +long-3+)) (the card8 (ldb (byte 8 24) v))
(aref a (index+ i +long-2+)) (the card8 (ldb (byte 8 16) v))
(aref a (index+ i +long-1+)) (the card8 (ldb (byte 8 8) v))
(aref a (index+ i +long-0+)) (the card8 (ldb (byte 8 0) v)))
v)
(defsetf aref-card8 (a i) (v)
`(aset-card8 ,v ,a ,i))
(defsetf aref-int8 (a i) (v)
`(aset-int8 ,v ,a ,i))
(defsetf aref-card16 (a i) (v)
`(aset-card16 ,v ,a ,i))
(defsetf aref-int16 (a i) (v)
`(aset-int16 ,v ,a ,i))
(defsetf aref-card32 (a i) (v)
`(aset-card32 ,v ,a ,i))
(defsetf aref-int32 (a i) (v)
`(aset-int32 ,v ,a ,i))
(defsetf aref-card29 (a i) (v)
`(aset-card29 ,v ,a ,i))
;;; Other random conversions
(defun rgb-val->card16 (value)
;; Short floats are good enough
(declare (type rgb-val value))
(declare (clx-values card16))
#.(declare-buffun)
;; Convert VALUE from float to card16
(the card16 (values (round (the rgb-val value) #.(/ 1.0s0 #xffff)))))
(defun card16->rgb-val (value)
;; Short floats are good enough
(declare (type card16 value))
(declare (clx-values short-float))
#.(declare-buffun)
;; Convert VALUE from card16 to float
(the short-float (* (the card16 value) #.(/ 1.0s0 #xffff))))
(defun radians->int16 (value)
;; Short floats are good enough
(declare (type angle value))
(declare (clx-values int16))
#.(declare-buffun)
(the int16 (values (round (the angle value) #.(float (/ pi 180.0s0 64.0s0) 0.0s0)))))
(defun int16->radians (value)
;; Short floats are good enough
(declare (type int16 value))
(declare (clx-values short-float))
#.(declare-buffun)
(the short-float (* (the int16 value) #.(coerce (/ pi 180.0 64.0) 'short-float))))
;;; This overrides the (probably incorrect) definition in clx.lisp. Since PI
;;; is irrational, there can't be a precise rational representation. In
;;; particular, the different float approximations will always be /=. This
;;; causes problems with type checking, because people might compute an
;;; argument in any precision. What we do is discard all the excess precision
;;; in the value, and see if the protocol encoding falls in the desired range
;;; (64'ths of a degree.)
;;;
(deftype angle () '(satisfies anglep))
(defun anglep (x)
(and (typep x 'real)
(<= (* -360 64) (radians->int16 x) (* 360 64))))
;;-----------------------------------------------------------------------------
;; Character transformation
;;-----------------------------------------------------------------------------
;;; This stuff transforms chars to ascii codes in card8's and back.
;;; You might have to hack it a little to get it to work for your machine.
(declaim (inline char->card8 card8->char))
(macrolet ((char-translators ()
(let ((alist
`(;; The normal ascii codes for the control characters.
,@`((#\Return . 13)
(#\Linefeed . 10)
(#\Rubout . 127)
(#\Page . 12)
(#\Tab . 9)
(#\Backspace . 8)
(#\Newline . 10)
(#\Space . 32))
;; The rest of the common lisp charater set with the normal
;; ascii codes for them.
(#\! . 33) (#\" . 34) (#\# . 35) (#\$ . 36)
(#\% . 37) (#\& . 38) (#\' . 39) (#\( . 40)
(#\) . 41) (#\* . 42) (#\+ . 43) (#\, . 44)
(#\- . 45) (#\. . 46) (#\/ . 47) (#\0 . 48)
(#\1 . 49) (#\2 . 50) (#\3 . 51) (#\4 . 52)
(#\5 . 53) (#\6 . 54) (#\7 . 55) (#\8 . 56)
(#\9 . 57) (#\: . 58) (#\; . 59) (#\< . 60)
(#\= . 61) (#\> . 62) (#\? . 63) (#\@ . 64)
(#\A . 65) (#\B . 66) (#\C . 67) (#\D . 68)
(#\E . 69) (#\F . 70) (#\G . 71) (#\H . 72)
(#\I . 73) (#\J . 74) (#\K . 75) (#\L . 76)
(#\M . 77) (#\N . 78) (#\O . 79) (#\P . 80)
(#\Q . 81) (#\R . 82) (#\S . 83) (#\T . 84)
(#\U . 85) (#\V . 86) (#\W . 87) (#\X . 88)
(#\Y . 89) (#\Z . 90) (#\[ . 91) (#\\ . 92)
(#\] . 93) (#\^ . 94) (#\_ . 95) (#\` . 96)
(#\a . 97) (#\b . 98) (#\c . 99) (#\d . 100)
(#\e . 101) (#\f . 102) (#\g . 103) (#\h . 104)
(#\i . 105) (#\j . 106) (#\k . 107) (#\l . 108)
(#\m . 109) (#\n . 110) (#\o . 111) (#\p . 112)
(#\q . 113) (#\r . 114) (#\s . 115) (#\t . 116)
(#\u . 117) (#\v . 118) (#\w . 119) (#\x . 120)
(#\y . 121) (#\z . 122) (#\{ . 123) (#\| . 124)
(#\} . 125) (#\~ . 126))))
(cond ((dolist (pair alist nil)
(when (not (= (char-code (car pair)) (cdr pair)))
(return t)))
`(progn
(defconstant *char-to-card8-translation-table*
',(let ((array (make-array
(let ((max-char-code 255))
(dolist (pair alist)
(setq max-char-code
(max max-char-code
(char-code (car pair)))))
(1+ max-char-code))
:element-type 'card8)))
(dotimes (i (length array))
(setf (aref array i) (mod i 256)))
(dolist (pair alist)
(setf (aref array (char-code (car pair)))
(cdr pair)))
array))
(defconstant *card8-to-char-translation-table*
',(let ((array (make-array 256)))
(dotimes (i (length array))
(setf (aref array i) (code-char i)))
(dolist (pair alist)
(setf (aref array (cdr pair)) (car pair)))
array))
(progn
(defun char->card8 (char)
(declare (type base-char char))
#.(declare-buffun)
(the card8 (aref (the (simple-array card8 (*))
*char-to-card8-translation-table*)
(the array-index (char-code char)))))
(defun card8->char (card8)
(declare (type card8 card8))
#.(declare-buffun)
(the base-char
(or (aref (the simple-vector *card8-to-char-translation-table*)
card8)
(error "Invalid CHAR code ~D." card8))))
)
(dotimes (i 256)
(unless (= i (char->card8 (card8->char i)))
(warn "The card8->char mapping is not invertible through char->card8. Info:~%~S"
(list i
(card8->char i)
(char->card8 (card8->char i))))
(return nil)))
(dotimes (i (length *char-to-card8-translation-table*))
(let ((char (code-char i)))
(unless (eql char (card8->char (char->card8 char)))
(warn "The char->card8 mapping is not invertible through card8->char. Info:~%~S"
(list char
(char->card8 char)
(card8->char (char->card8 char))))
(return nil))))))
(t
`(progn
(defun char->card8 (char)
(declare (type base-char char))
#.(declare-buffun)
(the card8 (char-code char)))
(defun card8->char (card8)
(declare (type card8 card8))
#.(declare-buffun)
(the base-char (code-char card8)))
))))))
(char-translators))
;;-----------------------------------------------------------------------------
;; Process Locking
;;
;; Common-Lisp doesn't provide process locking primitives, so we define
;; our own here, based on Zetalisp primitives. Holding-Lock is very
;; similar to with-lock on The TI Explorer, and a little more efficient
;; than with-process-lock on a Symbolics.
;;-----------------------------------------------------------------------------
;;; MAKE-PROCESS-LOCK: Creating a process lock.
(defun make-process-lock (name)
(mp:make-lock :name name))
;;; HOLDING-LOCK: Execute a body of code with a lock held.
;;; The holding-lock macro takes a timeout keyword argument. EVENT-LISTEN
;;; passes its timeout to the holding-lock macro, so any timeout you want to
;;; work for event-listen you should do for holding-lock.
;; If you're not sharing DISPLAY objects within a multi-processing
;; shared-memory environment, this is sufficient
(defmacro holding-lock ((lock display &optional (whostate "CLX wait") &key timeout) &body body)
(declare (ignore display))
`(mp:with-lock (,lock ,whostate ,timeout)
,@body))
;;; WITHOUT-ABORTS
;;; If you can inhibit asynchronous keyboard aborts inside the body of this
;;; macro, then it is a good idea to do this. This macro is wrapped around
;;; request writing and reply reading to ensure that requests are atomically
;;; written and replies are atomically read from the stream.
(defmacro without-aborts (&body body)
`(progn ,@body))
;;; PROCESS-BLOCK: Wait until a given predicate returns a non-NIL value.
;;; Caller guarantees that PROCESS-WAKEUP will be called after the predicate's
;;; value changes.
(defun process-block (whostate predicate &rest predicate-args)
(declare (dynamic-extent predicate-args))
(apply #'mp:process-wait whostate predicate predicate-args))
;;; PROCESS-WAKEUP: Check some other process' wait function.
(declaim (inline process-wakeup))
(defun process-wakeup (process)
(declare (ignore process))
(mp:process-allow-scheduling))
;;; CURRENT-PROCESS: Return the current process object for input locking and
;;; for calling PROCESS-WAKEUP.
(declaim (inline current-process))
(defun current-process ()
(mp:get-current-process))
;;; WITHOUT-INTERRUPTS -- provide for atomic operations.
(defvar *without-interrupts-sic-lock*
(mp:make-lock :name "Lock simulating *without-interrupts*"))
(defmacro without-interrupts (&body body)
`(mp:with-lock (*without-interrupts-sic-lock*)
,@body))
;;; CONDITIONAL-STORE:
(defvar *conditional-store-lock*
(mp:make-lock :name "Conditional store lock"))
(defmacro conditional-store (place old-value new-value)
`(mp:with-lock (*conditional-store-lock*)
(cond ((eq ,place ,old-value)
(setf ,place ,new-value)
t))))
;;;----------------------------------------------------------------------------
;;; IO Error Recovery
;;; All I/O operations are done within a WRAP-BUF-OUTPUT macro.
;;; It prevents multiple mindless errors when the network craters.
;;;
;;;----------------------------------------------------------------------------
(defmacro wrap-buf-output ((buffer) &body body)
;; Error recovery wrapper
`(unless (buffer-dead ,buffer)
,@body))
(defmacro wrap-buf-input ((buffer) &body body)
(declare (ignore buffer))
;; Error recovery wrapper
`(progn ,@body))
;;;----------------------------------------------------------------------------
;;; System dependent IO primitives
;;; Functions for opening, reading writing forcing-output and closing
;;; the stream to the server.
;;;----------------------------------------------------------------------------
;;; OPEN-X-STREAM - create a stream for communicating to the appropriate X
;;; server
;;; NOTE: OPEN-UNIX-STREAM and HOST-ADDRESS implementation are borrowed from
;;; http://www.bew.org.uk/Lisp/
;;; Original license of UNIX Domain Socket support for LispWorks:
;;;
;;; Copyright 2001, Barry Wilkes <bew@bcs.org.uk>
;;; uk.org.bew.comm-ext, an extension to the network interface for LispWorks/Linux
;;;
;;; uk.org.bew.comm-ext is licensed under the terms of the Lisp Lesser GNU
;;; Public License (http://opensource.franz.com/preamble.html), known as
;;; the LLGPL. The LLGPL consists of a preamble (see above URL) and the
;;; LGPL. Where these conflict, the preamble takes precedence.
;;; uk.org.bew.comm-ext is referenced in the preamble as the "LIBRARY."
;;; NOTE: %CREATE-UNIX-DOMAIN-SOCKET implementation ideas are borrowed from
;;; http://common-lisp.net/project/cl-net-snmp/lispworks.html
;;; Original license of LispWorks-UDP:
;;;
;;; The MIT License
;;;
;;; Copyright (c) 2007-2008, Chun Tian (binghe)
;;;
;;; Permission is hereby granted, free of charge, to any person obtaining a copy
;;; of this software and associated documentation files (the "Software"), to deal
;;; in the Software without restriction, including without limitation the rights
;;; to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
;;; copies of the Software, and to permit persons to whom the Software is
;;; furnished to do so, subject to the following conditions:
;;;
;;; The above copyright notice and this permission notice shall be included in
;;; all copies or substantial portions of the Software.
;;;
;;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
;;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
;;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
;;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
;;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
;;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
;;; THE SOFTWARE.
(eval-when (:compile-toplevel :load-toplevel :execute)
(defconstant +max-unix-path-length+
#+darwin 104 #-darwin 108))
(fli:define-c-struct %sockaddr-un
#+darwin (sun-len (:unsigned :byte))
(sun-family (:unsigned #+darwin :byte #-darwin :short))
(sun-path (:c-array (:unsigned :byte) #.+max-unix-path-length+)))
(defun %create-unix-domain-socket (pathname error)
(let ((sock-fd (comm::socket comm::*socket_af_unix* comm::*socket_sock_stream* comm::*socket_pf_unspec*)))
(if (null sock-fd)
(and error (error "Failed to create unix domain socket at ~S." pathname))
(fli:with-dynamic-foreign-objects ((sock-addr (:struct %sockaddr-un)))
(let ((pathname-string (namestring (translate-logical-pathname (truename pathname)))))
(fli:fill-foreign-object sock-addr :byte 0)
(let* ((code (ef:encode-lisp-string pathname-string :utf-8))
(len (length code)))
(fli:with-foreign-slots (#+darwin sun-len sun-family) sock-addr
#+darwin (setf sun-len (+ len 2))
(setf sun-family comm::*socket_af_unix*))
(fli:replace-foreign-array (fli:foreign-slot-pointer sock-addr 'sun-path)
code
:start1 0 :end1 (min len +max-unix-path-length+))
(setf (fli:foreign-aref (fli:foreign-slot-pointer sock-addr 'sun-path)
(min len (1- +max-unix-path-length+))) 0)))
(if (comm::connect sock-fd
(fli:copy-pointer sock-addr :type '(:struct comm::sockaddr))
(fli:pointer-element-size sock-addr))
sock-fd
(progn
(comm::close-socket sock-fd)
(and error (error "Failed to connect unix domain socket at ~S." pathname))))))))
(defun open-unix-stream (service &key
(direction :io)
(element-type 'base-char)
(errorp t))
(let ((socket (%create-unix-domain-socket service errorp)))
(when socket
(make-instance 'comm:socket-stream
:socket socket
:element-type element-type
:direction direction))))
(defun open-x-stream (host display protocol)
(declare (ignore protocol)
(type (integer 0) display))
(if (or (null host) (string= host "") (string= host "unix"))
(open-unix-stream (unix-socket-path-from-host host display)
:direction :io
:element-type '(unsigned-byte 8)
:errorp t)
(comm:open-tcp-stream host (+ *x-tcp-port* display)
:direction :io
:element-type '(unsigned-byte 8)
:errorp t)))
;;; BUFFER-INPUT-WAIT-DEFAULT - wait for for input to be available for the
;;; buffer. This is called in read-input between requests, so that a process
;;; waiting for input is abortable when between requests. Should return
;;; :TIMEOUT if it times out, NIL otherwise.
(defun buffer-input-wait-default (display timeout)
(declare (type display display)
(type (or null (real 0 *)) timeout))
(let ((stream (display-input-stream display)))
(declare (type (or null stream) stream))
(cond ((null stream))
((listen stream) nil)
((eql timeout 0) :timeout)
(t
(if (sys:wait-for-input-streams-returning-first
(list stream) :timeout timeout)
nil
:timeout)))))
;;;----------------------------------------------------------------------------
;;; System dependent speed hacks
;;;----------------------------------------------------------------------------
;;
;; WITH-STACK-LIST is used by WITH-STATE as a memory saving feature.
;; If your lisp doesn't have stack-lists, and you're worried about
;; consing garbage, you may want to re-write this to allocate and
;; initialize lists from a resource.
;;
(defmacro with-stack-list ((var &rest elements) &body body)
;; SYNTAX: (WITH-STACK-LIST (var exp1 ... expN) body)
;; Equivalent to (LET ((var (MAPCAR #'EVAL '(exp1 ... expN)))) body)
;; except that the list produced by MAPCAR resides on the stack and
;; therefore DISAPPEARS when WITH-STACK-LIST is exited.
`(let ((,var (list ,@elements)))
(declare (type cons ,var)
(dynamic-extent ,var))
,@body))
(defmacro with-stack-list* ((var &rest elements) &body body)
;; SYNTAX: (WITH-STACK-LIST* (var exp1 ... expN) body)
;; Equivalent to (LET ((var (APPLY #'LIST* (MAPCAR #'EVAL '(exp1 ... expN))))) body)
;; except that the list produced by MAPCAR resides on the stack and
;; therefore DISAPPEARS when WITH-STACK-LIST is exited.
`(let ((,var (list* ,@elements)))
(declare (type cons ,var)
(dynamic-extent ,var))
,@body))
(declaim (inline buffer-replace))
(defun buffer-replace (buf1 buf2 start1 end1 &optional (start2 0))
(declare (type buffer-bytes buf1 buf2)
(type array-index start1 end1 start2))
(replace buf1 buf2 :start1 start1 :end1 end1 :start2 start2))
(defmacro with-gcontext-bindings ((gc saved-state indexes ts-index temp-mask temp-gc)
&body body)
(let ((local-state (gensym))
(resets nil))
(dolist (index indexes)
(push `(setf (svref ,local-state ,index) (svref ,saved-state ,index))
resets))
`(unwind-protect
(progn
,@body)
(let ((,local-state (gcontext-local-state ,gc)))
(declare (type gcontext-state ,local-state))
,@resets
(setf (svref ,local-state ,ts-index) 0))
(when ,temp-gc
(restore-gcontext-temp-state ,gc ,temp-mask ,temp-gc))
(deallocate-gcontext-state ,saved-state))))
;;;----------------------------------------------------------------------------
;;; How much error detection should CLX do?
;;; Several levels are possible:
;;;
;;; 1. Do the equivalent of check-type on every argument.
;;;
;;; 2. Simply report TYPE-ERROR. This eliminates overhead of all the format
;;; strings generated by check-type.
;;;
;;; 3. Do error checking only on arguments that are likely to have errors
;;; (like keyword names)
;;;
;;; 4. Do error checking only where not doing so may dammage the envirnment
;;; on a non-tagged machine (i.e. when storing into a structure that has
;;; been passed in)
;;;
;;; 5. No extra error detection code. On lispm's, ASET may barf trying to
;;; store a non-integer into a number array.
;;;
;;; How extensive should the error checking be? For example, if the server
;;; expects a CARD16, is is sufficient for CLX to check for integer, or
;;; should it also check for non-negative and less than 65536?
;;;----------------------------------------------------------------------------
;; The +TYPE-CHECK?+ constant controls how much error checking is done.
;; Possible values are:
;; NIL - Don't do any error checking
;; t - Do the equivalent of checktype on every argument
;; :minimal - Do error checking only where errors are likely
;;; This controls macro expansion, and isn't changable at run-time You will
;;; probably want to set this to nil if you want good performance at
;;; production time.
(defconstant +type-check?+ nil)
;; TYPE? is used to allow the code to do error checking at a different level from
;; the declarations. It also does some optimizations for systems that don't have
;; good compiler support for TYPEP. The definitions for CARD32, CARD16, INT16, etc.
;; include range checks. You can modify TYPE? to do less extensive checking
;; for these types if you desire.
;;
;; ### This comment is a lie! TYPE? is really also used for run-time type
;; dispatching, not just type checking. -- Ram.
(defmacro type? (object type)
`(typep ,object ,type))
;; X-TYPE-ERROR is the function called for type errors.
;; If you want lots of checking, but are concerned about code size,
;; this can be made into a macro that ignores some parameters.
(defun x-type-error (object type &optional error-string)
(x-error 'x-type-error
:datum object
:expected-type type
:type-string error-string))
;;-----------------------------------------------------------------------------
;; Error handlers
;; Hack up KMP error signaling using zetalisp until the real thing comes
;; along
;;-----------------------------------------------------------------------------
(defun default-error-handler (display error-key &rest key-vals
&key asynchronous &allow-other-keys)
(declare (type generalized-boolean asynchronous)
(dynamic-extent key-vals))
;; The default display-error-handler.
;; It signals the conditions listed in the DISPLAY file.
(if asynchronous
(apply #'x-cerror "Ignore" error-key :display display :error-key error-key key-vals)
(apply #'x-error error-key :display display :error-key error-key key-vals)))
(defun x-error (condition &rest keyargs)
(declare (dynamic-extent keyargs))
(apply #'error condition keyargs))
(defun x-cerror (proceed-format-string condition &rest keyargs)
(declare (dynamic-extent keyargs))
(apply #'cerror proceed-format-string condition keyargs))
;; version 15 of Pitman error handling defines the syntax for define-condition to be:
;; DEFINE-CONDITION name (parent-type) [({slot}*) {option}*]
;; Where option is one of: (:documentation doc-string) (:conc-name symbol-or-string)
;; or (:report exp)
(define-condition x-error (error) ())
;;-----------------------------------------------------------------------------
;; HOST hacking
;;-----------------------------------------------------------------------------
(defun host-address (host &optional (family :internet))
;; Return a list whose car is the family keyword (:internet :DECnet :Chaos)
;; and cdr is a list of network address bytes.
(declare (type stringable host)
(type (or null (member :internet :decnet :chaos) card8) family))
(declare (values list))
(labels ((no-host-error ()
(error "Unknown host ~S" host))
(no-address-error ()
(error "Host ~S has no ~S address" host family)))
(let ((addr (comm:get-host-entry (string host) :fields '(:address))))
(when (not addr)
(no-host-error))
(ecase family
((:internet 0)
(list :internet
(ldb (byte 8 24) addr)
(ldb (byte 8 16) addr)
(ldb (byte 8 8) addr)
(ldb (byte 8 0) addr)))))))
;;-----------------------------------------------------------------------------
;; Whether to use closures for requests or not.
;;-----------------------------------------------------------------------------
;;; If this macro expands to non-NIL, then request and locking code is
;;; compiled in a much more compact format, as the common code is shared, and
;;; the specific code is built into a closure that is funcalled by the shared
;;; code. If your compiler makes efficient use of closures then you probably
;;; want to make this expand to T, as it makes the code more compact.
(defmacro use-closures ()
nil)
(defun clx-macroexpand (form env)
(macroexpand form env))
;;-----------------------------------------------------------------------------
;; Resource stuff
;;-----------------------------------------------------------------------------
;;; Utilities
(defun getenv (name)
(hcl:getenv name))
(defun get-host-name ()
"Return the same hostname as gethostname(3) would"
;; machine-instance probably works on a lot of lisps, but clisp is not
;; one of them
(machine-instance))
(defun homedir-file-pathname (name)
(merge-pathnames (user-homedir-pathname) (pathname name)))
;;; DEFAULT-RESOURCES-PATHNAME - The pathname of the resources file to load if
;;; a resource manager isn't running.
(defun default-resources-pathname ()
(homedir-file-pathname ".Xdefaults"))
;;; RESOURCES-PATHNAME - The pathname of the resources file to load after the
;;; defaults have been loaded.
(defun resources-pathname ()
(or (let ((string (getenv "XENVIRONMENT")))
(and string
(pathname string)))
(homedir-file-pathname
(concatenate 'string ".Xdefaults-" (get-host-name)))))
;;; AUTHORITY-PATHNAME - The pathname of the authority file.
(defun authority-pathname ()
(or (let ((xauthority (getenv "XAUTHORITY")))
(and xauthority
(pathname xauthority)))
(homedir-file-pathname ".Xauthority")))
;;; this particular defaulting behaviour is typical to most Unices, I think
(defun get-default-display (&optional display-name)
"Parse the argument DISPLAY-NAME, or the environment variable $DISPLAY
if it is NIL. Display names have the format
[protocol/] [hostname] : [:] displaynumber [.screennumber]
There are two special cases in parsing, to match that done in the Xlib
C language bindings
- If the hostname is ``unix'' or the empty string, any supplied
protocol is ignored and a connection is made using the :local
transport.
- If a double colon separates hostname from displaynumber, the
protocol is assumed to be decnet.
Returns a list of (host display-number screen protocol)."
(let* ((name (or display-name
(getenv "DISPLAY")
(error "DISPLAY environment variable is not set")))
(slash-i (or (position #\/ name) -1))
(colon-i (position #\: name :start (1+ slash-i)))
(decnet-colon-p (eql (elt name (1+ colon-i)) #\:))
(host (subseq name (1+ slash-i) (if decnet-colon-p
(1+ colon-i)
colon-i)))
(dot-i (and colon-i (position #\. name :start colon-i)))
(display (when colon-i
(parse-integer name
:start (if decnet-colon-p
(+ colon-i 2)
(1+ colon-i))
:end dot-i)))
(screen (when dot-i
(parse-integer name :start (1+ dot-i))))
(protocol
(cond ((or (string= host "") (string-equal host "unix")) :local)
(decnet-colon-p :decnet)
((> slash-i -1) (intern
(string-upcase (subseq name 0 slash-i))
:keyword))
(t :internet))))
(list host (or display 0) (or screen 0) protocol)))
;;-----------------------------------------------------------------------------
;; GC stuff
;;-----------------------------------------------------------------------------
(defun gc-cleanup ()
(declare (special *event-free-list*
*pending-command-free-list*
*reply-buffer-free-lists*
*gcontext-local-state-cache*
*temp-gcontext-cache*))
(setq *event-free-list* nil)
(setq *pending-command-free-list* nil)
(when (boundp '*reply-buffer-free-lists*)
(fill *reply-buffer-free-lists* nil))
(setq *gcontext-local-state-cache* nil)
(setq *temp-gcontext-cache* nil)
nil)
;;-----------------------------------------------------------------------------
;; DEFAULT-KEYSYM-TRANSLATE
;;-----------------------------------------------------------------------------
;;; If object is a character, char-bits are set from state.
;;;
;;; [the following isn't implemented (should it be?)]
;;; If object is a list, it is an alist with entries:
;;; (base-char [modifiers] [mask-modifiers])