-
Notifications
You must be signed in to change notification settings - Fork 6
/
panes.lisp
3002 lines (2655 loc) · 120 KB
/
panes.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: CLIM-INTERNALS -*-
;;; (c) copyright 1998,1999,2000,2001 by Michael McDonald ([email protected])
;;; (c) copyright 2000 by
;;; Iban Hatchondo ([email protected])
;;; Julien Boninfante ([email protected])
;;; (c) copyright 2000, 2001 by
;;; Robert Strandh ([email protected])
;;; (c) copyright 2001 by
;;; Lionel Salabartan ([email protected])
;;; Arnaud Rouanet ([email protected])
;;; (c) copyright 2002, 2003 by
;;; Gilbert Baumann <[email protected]>
;;; This library is free software; you can redistribute it and/or
;;; modify it under the terms of the GNU Library General Public
;;; License as published by the Free Software Foundation; either
;;; version 2 of the License, or (at your option) any later version.
;;;
;;; This library 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
;;; Library General Public License for more details.
;;;
;;; You should have received a copy of the GNU Library General Public
;;; License along with this library; if not, write to the
;;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;;; Boston, MA 02111-1307 USA.
;;; $Id: panes.lisp,v 1.197 2009-08-01 22:11:06 gbaumann Exp $
(in-package :clim-internals)
;;;;
;;;; Ambiguities and Obmissions
;;;;
;; This is a scratch pad, were we can document, what the spec doesn't
;; tells us about CLIM. Reason: While coding, one sees were the spec
;; is vague or wrong; later when the task to update the spec is due,
;; things might be forgotten. --GB
;;
;; - Default of :equalize-width / :equalize-height is T
;;
;; - LAYOUT-PANE is mentioned in the spec's example, but not in the
;; text.
;;
;; - Behaviour of :align-x, :align-y is uncertain.
;; (Should it be specifed on the childs? on the parents?)
;;
;; - BORDER-PANE is not in the spec and just a different name of
;; OUTLINED-PANE, where is it from? --GB
;;
;; - RAISED-PANE, where form? --GB
;;
;; - In XBOX-PANE: I would like to also allow for (1 <pane>) being a
;; proportional content.
;;;; TODO
;; - VBOX/HBOX/VRACK/HRACK:
;; . should align its children
;; Q: Should we cope with proportional content differently?
;; . test units for spacing and fixed width
;; Q: When to resolve?
;; . adopt/disown/enable/disable
;;
;; - TABLE-PANE
;; . test units
;; . adopt/disown/enable/disable
;; . allow for partially filled rows/cols?
;;
;; - GRID-PANE
;; . align children
;; . test units
;; . adopt/disown/enable/disable
;;
;; - SPACING-PANE
;; . align child
;; Or: expand them as we did?
;; . adopt/disown/enable/disable
;;
;; - RESTRAINING-PANE
;; . ???
;;
;; - LABEL-PANE
;; . test units
;; . adopt/disown/enable/disable
;; . expand child? leave it?
;;
;; - SCROLLER-PANE
;; . much!
;;
;; - we still need to think about what should happen when children
;; get disabled or adopted or disowned.
;;
;; - adjust class names.
;;
;; - advertise layout-child et al
;;
;; - reuse single-child-composite-pane
;;
;; - MAKE-SPACE-REQUIREMENT right?
;; . default arguments in the spec are different
;; . DUIM's default for maxima is not +fill+ but the dimension
;;
;; - what are the appropriate default values for align?
;;
;; - for layout purposes the list of children should be considered in
;; reverse: The first element of children should come last.
;;--GB 2002-02-27
;;;; CLIM Layout Protocol for Dummies
;; Here is how I interpret the relevant sections of the specification:
;;
;; COMPOSE-SPACE
;;
;; This is called by CLIM, when it wants to find out what the pane
;; thinks are its space requirements. The result of COMPOSE-SPACE is
;; cached by CLIM.
;;
;; ALLOCATE-SPACE
;;
;; This method is called by CLIM when a pane is allocate space. It
;; should layout its possible children.
;;
;; CHANGE-SPACE-REQUIREMENTS
;;
;; This is called by the application programmer to a) indicate that
;; COMPOSE-SPACE may now return something different from previous
;; invocations and/or b) to update the user space requirements
;; options (the :width, :height etc keywords as upon pane creation).
;;
;; NOTE-SPACE-REQUIREMENTS-CHANGED
;;
;; Called by CLIM when the space requirements of a pane have
;; changed. Not called to layout a pane; This is only a kind of signal.
;;
;; LAYOUT-FRAME
;;
;; Maybe called by both CLIM and the application programmer to
;; "invoke the space allocation protocol", that is CLIM calls
;; ALLOCATE-SPACE on the top level sheet. This in turn will probably
;; call COMPOSE-SPACE on its children and layout then accordingly by
;; calling ALLOCATE-SPACE again.
;;
;; The effect is that ALLOCATE-SPACE propagate down the sheet
;; hierarchy.
;;
;; --GB 2003-08-06
;; For each of the builtin CLIM gadgets there is an abstract gadget class
;; and at least one "concrete" subclass which can be chosen by the
;; frame manager. The CLIM 2.0 spec names one concrete class for each
;; abstract class. Frame managers need a mechanism to look up these
;; concrete classes. The current practice of the CLX backend is to
;; search for classes of various names based on the name of the abstract
;; class. This mostly works as all but two of the specified concrete
;; class names can be produced by appending "-PANE" to the abstract class
;; name. The classes GENERIC-LIST-PANE and GENERIC-OPTION-PANE break this
;; convention.
;; I've extended the CLX frame manager to additionally search the property
;; list of the pane class name when searching for a concrete pane class. The
;; function below can be used where needed to place the concrete class name
;; where it needs to go.
;; This could be easily extended to allow mappings for specific backends..
(defun define-abstract-pane-mapping (abstract-class-name concrete-class-name)
(setf (get abstract-class-name 'concrete-pane-class-name)
concrete-class-name))
;;; Default Color Scheme Options
#||
;; Motif-ish
(defparameter *3d-dark-color* (make-gray-color .45))
(defparameter *3d-normal-color* (make-gray-color .75))
(defparameter *3d-light-color* (make-gray-color .92))
(defparameter *3d-inner-color* (make-gray-color .65))
||#
;; Gtk-ish
(defparameter *3d-dark-color* (make-gray-color .59))
(defparameter *3d-normal-color* (make-gray-color .84))
(defparameter *3d-light-color* (make-gray-color 1.0))
(defparameter *3d-inner-color* (make-gray-color .75))
;;; Gadget "Feel"
(defparameter *double-click-delay* 0.25
"Maximum time in seconds between clicks in order to produce a double-click")
(defparameter *double-click-max-travel* 7
"Maximum distance in device units that the cursor may move between clicks in
order to produce a double-click")
;;;
;;; gadgets look
;;;
;; Only used by some gadgets, I suggest using my more flexible and
;; general DRAW-BORDERED-POLYGON.
(defun display-gadget-background (gadget color x1 y1 x2 y2)
(draw-rectangle* gadget x1 y1 x2 y2 :ink color :filled t))
(defun draw-edges-lines* (pane ink1 x1 y1 ink2 x2 y2)
(draw-line* pane x1 y1 x2 y1 :ink ink1)
(draw-line* pane x1 y1 x1 y2 :ink ink1)
(draw-line* pane x1 y2 x2 y2 :ink ink2)
(draw-line* pane x2 y1 x2 y2 :ink ink2))
;;; Space Requirements
(defconstant +fill+ (expt 10 (floor (log most-positive-fixnum 10))))
(defclass space-requirement () ())
(defclass standard-space-requirement (space-requirement)
((width :initform 1
:initarg :width
:reader space-requirement-width)
(max-width :initform 1
:initarg :max-width
:reader space-requirement-max-width)
(min-width :initform 1
:initarg :min-width
:reader space-requirement-min-width)
(height :initform 1
:initarg :height
:reader space-requirement-height)
(max-height :initform 1
:initarg :max-height
:reader space-requirement-max-height)
(min-height :initform 1
:initarg :min-height
:reader space-requirement-min-height) ) )
(defmethod print-object ((space standard-space-requirement) stream)
(with-slots (width height min-width max-width min-height max-height) space
(print-unreadable-object (space stream :type t :identity nil)
(format stream "width: ~S [~S,~S] height: ~S [~S,~S]"
width
min-width
max-width
height
min-height
max-height))))
(defun make-space-requirement (&key (width 1) (height 1)
(min-width 0) (min-height 0)
(max-width +fill+) (max-height +fill+))
(assert (<= 0 min-width width max-width) (min-width width max-width))
(assert (<= 0 min-height height max-height) (min-height height max-height))
(make-instance 'standard-space-requirement
:width width
:max-width max-width
:min-width min-width
:height height
:max-height max-height
:min-height min-height))
(defmethod space-requirement-components ((space-req standard-space-requirement))
(with-slots (width min-width max-width height min-height max-height) space-req
(values width min-width max-width height min-height max-height)))
(defun space-requirement-combine* (function sr1 &key (width 0) (min-width 0) (max-width 0)
(height 0) (min-height 0) (max-height 0))
(apply #'make-space-requirement
(mapcan #'(lambda (c1 c2 keyword)
(list keyword (funcall function c1 c2)))
(multiple-value-list (space-requirement-components sr1))
(list width min-width max-width height min-height max-height)
'(:width :min-width :max-width :height :min-height :max-height))))
(defun space-requirement-combine (function sr1 sr2)
(multiple-value-bind (width min-width max-width height min-height max-height)
(space-requirement-components sr2)
(space-requirement-combine* function sr1
:width width
:min-width min-width
:max-width max-width
:height height
:min-height min-height
:max-height max-height)))
(defun space-requirement+ (sr1 sr2)
(space-requirement-combine #'+ sr1 sr2))
(defun space-requirement+* (space-req &key (width 0) (min-width 0) (max-width 0)
(height 0) (min-height 0) (max-height 0))
(space-requirement-combine* #'+ space-req
:width width
:min-width min-width
:max-width max-width
:height height
:min-height min-height
:max-height max-height))
(eval-when (:compile-toplevel :load-toplevel :execute)
(defun spacing-value-p (x)
(or (and (realp x) (>= x 0))
(and (consp x)
(realp (car x))
(consp (cdr x))
(member (cadr x) '(:point :pixel :mm :character :line))
(null (cddr x)))
;; For clim-stream-pane
(eq x :compute)))
)
(deftype spacing-value ()
;; just for documentation
`(satisfies spacing-value-p))
;;; PANES
;; Macros for quick access to space-requirement slots.
(defmacro sr-width (pane)
`(space-requirement-width (pane-space-requirement ,pane)))
(defmacro sr-height (pane)
`(space-requirement-height (pane-space-requirement ,pane)))
(defmacro sr-max-width (pane)
`(space-requirement-max-width (pane-space-requirement ,pane)))
(defmacro sr-max-height (pane)
`(space-requirement-max-height (pane-space-requirement ,pane)))
(defmacro sr-min-width (pane)
`(space-requirement-min-width (pane-space-requirement ,pane)))
(defmacro sr-min-height (pane)
`(space-requirement-min-height (pane-space-requirement ,pane)))
(defclass layout-protocol-mixin ()
((space-requirement :accessor pane-space-requirement
:initform nil
:documentation "The cache of the space requirements of the pane. NIL means: need to recompute.")
(current-width :accessor pane-current-width
:initform nil)
(current-height :accessor pane-current-height
:initform nil) ))
;;; XXX Move to protocol-classes.lisp. Should this really have all these
;;; superclasses?
(define-protocol-class pane (clim-repainting-mixin
clim-sheet-input-mixin
sheet-transformation-mixin
layout-protocol-mixin
basic-sheet)
(
(text-style :initarg :text-style :initform nil :reader pane-text-style)
(name :initarg :name :initform "(Unnamed Pane)" :reader pane-name)
(manager :initarg :manager)
(port :initarg :port)
(frame :initarg :frame :initform *application-frame* :reader pane-frame)
(enabledp :initform nil :initarg :enabledp :accessor pane-enabledp)
(space-requirement :initform nil :accessor pane-space-requirement)
;; New sizes, for allocating protocol
(new-width :initform nil)
(new-height :initform nil)
(redisplay-needed :accessor pane-redisplay-needed
:initarg :redisplay-needed :initform nil))
(:documentation ""))
(defmethod print-object ((pane pane) sink)
(print-unreadable-object (pane sink :type t :identity t)
(prin1 (pane-name pane) sink)))
(defun make-pane (type &rest args)
(when (eql (symbol-package type)
(symbol-package :foo))
(setf type (or (find-symbol (symbol-name type) (find-package :clim))
type)))
(apply #'make-pane-1 *pane-realizer* *application-frame* type args))
(defmethod medium-foreground ((pane pane))
(medium-foreground (sheet-medium pane)))
(defmethod (setf medium-foreground) (ink (pane pane))
(setf (medium-foreground (sheet-medium pane)) ink))
(defmethod medium-background ((pane pane))
(medium-background (sheet-medium pane)))
(defmethod (setf medium-background) (ink (pane pane))
(setf (medium-background (sheet-medium pane)) ink))
(defmethod compose-space ((pane pane) &key width height)
(make-space-requirement :width (or width 200)
:height (or height 200)))
(defmethod allocate-space ((pane pane) width height)
(declare (ignorable pane width height))
)
(defmethod pane-needs-redisplay ((pane pane))
(let ((do-redisplay (pane-redisplay-needed pane)))
(values do-redisplay
(and do-redisplay (not (eq do-redisplay :no-clear))))))
(defmethod (setf pane-needs-redisplay) (value (pane pane))
(setf (pane-redisplay-needed pane) value))
(defmethod window-clear ((pane pane))
nil)
;;; WINDOW STREAM
;; ???
(defclass window-stream (standard-extended-output-stream
standard-extended-input-stream)
() )
;;;
;;; Utilities
;;;
;; Since, I hate to duplicate code for HBOX and VBOX, I define this
;; evil macro:
(defmacro dada ((&rest substs) &body body)
"This is an evil macro."
(setf substs (sort substs #'> :key (lambda (s) (length (symbol-name (first s))))))
`(progn
,@(loop for k from 1 below (length (first substs)) collect
(labels ((subst-one (new old sym)
(let ((p (search (symbol-name old) (symbol-name sym))))
(cond ((not (null p))
(let ((pack (if (eq (symbol-package sym)
(find-package :keyword))
(symbol-package sym)
*package*)))
(intern (concatenate 'string
(subseq (symbol-name sym) 0 p)
(symbol-name new)
(subseq (symbol-name sym)
(+ p (length (symbol-name old)))))
pack)))
(t
sym))))
(walk (x)
(cond ((symbolp x)
(dolist (subst substs)
(setf x (subst-one (elt subst k) (first subst) x)))
x)
((atom x) x)
((consp x)
(cons (walk (car x)) (walk (cdr x)))))))
`(locally
,@(walk body))))))
;;;; Layout Utilities
(defun layout-child (child align-x align-y x y width height)
"Allocates space to a child of a pane.
x, y, width, height designate the area of available space.
align-x, align-y name the desired child alignment.
If the child does not have enough strechability to cover all of the
given area, it is aligned within that area according to the given
options.
As a special option we allow align-x or align-y be :expand, which
means that the child wouldn't be aligned in that direction but its
size would be forced."
(let* ((sr (compose-space child))
;; The child's dimension is clamped within its min/max space requirement
(child-width (if (eql :expand align-x)
width
(clamp width
(space-requirement-min-width sr)
(space-requirement-max-width sr))))
(child-height (if (eql :expand align-y)
height
(clamp height
(space-requirement-min-height sr)
(space-requirement-max-height sr))))
;; Align the child within the available area
(child-x (ecase align-x
((:left) x)
((:center) (+ x (/ (- width child-width) 2)))
((:right) (+ x (- width child-width)))
((:expand) x) ))
(child-y (ecase align-y
((:top) y)
((:center) (+ y (/ (- height child-height) 2)))
((:bottom) (+ y (- height child-height)))
((:expand) y) )))
;; Actually layout the child
(move-sheet child child-x child-y)
(resize-sheet child child-width child-height)
(allocate-space child child-width child-height)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; User Space Requirements
(defclass space-requirement-options-mixin ()
((user-width
:initarg :width
:initform nil
:reader pane-user-width
:type (or null spacing-value))
(user-min-width
:initarg :min-width
:initform nil
:reader pane-user-min-width
:type (or null spacing-value))
(user-max-width
:initarg :max-width
:initform nil
:reader pane-user-max-width
:type (or null spacing-value))
(user-height
:initarg :height
:initform nil
:reader pane-user-height
:type (or null spacing-value))
(user-min-height
:initarg :min-height
:initform nil
:reader pane-user-min-height
:type (or null spacing-value))
(user-max-height
:initarg :max-height
:initform nil
:reader pane-user-max-height
:type (or null spacing-value))
(x-spacing
:initarg :x-spacing
:initform 0
:reader pane-x-spacing
:type (or null spacing-value))
(y-spacing
:initarg :y-spacing
:initform 0
:reader pane-y-spacing
:type (or null spacing-value)))
(:documentation
"Mixin class for panes which offer the standard user space requirements options."))
(defclass standard-space-requirement-options-mixin (space-requirement-options-mixin)
())
(defun merge-one-option
(pane foo user-foo user-min-foo user-max-foo min-foo max-foo)
;; NOTE: The defaulting for :min-foo and :max-foo is different from MAKE-SPACE-REQUIREMENT.
;; MAKE-SPACE-REQUIREMENT has kind of &key foo (min-foo 0) (max-foo +fill+)
;; While user space requirements has &key foo (min-foo foo) (max-foo foo).
;; I as a user would pretty much expect the same behavior, therefore I'll take the
;; following route:
;; When the :foo option is given, I'll let MAKE-SPACE-REQUIREMENT decide.
;;
;; old code:
;;
;; ;; Then we resolve defaulting. sec 29.3.1 says:
;; ;; | If either of the :max-width or :min-width options is not
;; ;; | supplied, it defaults to the value of the :width option. If
;; ;; | either of the :max-height or :min-height options is not
;; ;; | supplied, it defaults to the value of the :height option.
;; (setf user-max-foo (or user-max-foo user-foo)
;; user-min-foo (or user-min-foo user-foo))
;; --GB 2003-01-23
(when (and (null user-max-foo) (not (null user-foo)))
(setf user-max-foo (space-requirement-max-width
(make-space-requirement
:width (spacing-value-to-device-units pane foo)))))
(when (and (null user-min-foo) (not (null user-foo)))
(setf user-min-foo (space-requirement-min-width
(make-space-requirement
:width (spacing-value-to-device-units pane foo)))))
;; when the user has no idea about the preferred size just take the
;; panes preferred size.
(setf user-foo (or user-foo foo))
(setf user-foo (spacing-value-to-device-units pane user-foo))
;; dito for min/max
(setf user-min-foo (or user-min-foo min-foo)
user-max-foo (or user-max-foo max-foo))
;; | :max-width, :min-width, :max-height, and :min-height can
;; | also be specified as a relative size by supplying a list of
;; | the form (number :relative). In this case, the number
;; | indicates the number of device units that the pane is
;; | willing to stretch or shrink.
(labels ((resolve-relative (dimension sign base)
(if (and (consp dimension) (eq (car dimension) :relative))
(+ base (* sign (cadr dimension)))
(spacing-value-to-device-units pane dimension))))
(setf user-min-foo (and user-min-foo
(resolve-relative user-min-foo -1 user-foo))
user-max-foo (and user-max-foo
(resolve-relative user-max-foo +1 user-foo))))
;; Now we have two space requirements which need to be 'merged'.
(setf min-foo (clamp user-min-foo min-foo max-foo)
max-foo (clamp user-max-foo min-foo max-foo)
foo (clamp user-foo min-foo max-foo))
(values foo min-foo max-foo))
(defmethod merge-user-specified-options ((pane space-requirement-options-mixin)
sr)
;; ### I want proper error checking and in case there is an error we
;; should just emit a warning and move on. CLIM should not die from
;; garbage passed in here.
(multiple-value-bind (width min-width max-width height min-height max-height)
(space-requirement-components sr)
(multiple-value-bind (new-width new-min-width new-max-width)
(merge-one-option pane
width
(pane-user-width pane)
(pane-user-min-width pane)
(pane-user-max-width pane)
min-width
max-width)
(multiple-value-bind (new-height new-min-height new-max-height)
(merge-one-option pane
height
(pane-user-height pane)
(pane-user-min-height pane)
(pane-user-max-height pane)
min-height
max-height)
(make-space-requirement
:width new-width
:min-width new-min-width
:max-width new-max-width
:height new-height
:min-height new-min-height
:max-height new-max-height)))))
(defmethod compose-space :around ((pane space-requirement-options-mixin)
&key width height)
(declare (ignore width height))
;; merge user specified options.
(let ((sr (call-next-method)))
(unless sr
(warn "~S has no idea about its space-requirements." pane)
(setf sr (make-space-requirement :width 100 :height 100)))
(merge-user-specified-options pane sr)))
(defmethod change-space-requirements :before ((pane space-requirement-options-mixin)
&key (width :nochange) (min-width :nochange) (max-width :nochange)
(height :nochange) (min-height :nochange) (max-height :nochange)
(x-spacing :nochange) (y-spacing :nochange)
&allow-other-keys)
(with-slots (user-width user-min-width user-max-width
user-height user-min-height user-max-height
(user-x-spacing x-spacing)
(user-y-spacing y-spacing))
pane
(unless (eq width :nochange) (setf user-width width))
(unless (eq min-width :nochange) (setf user-min-width min-width))
(unless (eq max-width :nochange) (setf user-max-width max-width))
(unless (eq height :nochange) (setf user-height height))
(unless (eq min-height :nochange) (setf user-min-height min-height))
(unless (eq max-height :nochange) (setf user-max-height max-height))
(unless (eq x-spacing :nochange) (setf user-x-spacing x-spacing))
(unless (eq y-spacing :nochange) (setf user-y-spacing y-spacing)) ))
;;;; LAYOUT-PROTOCOL-MIXIN
;;; Note
;; This is how I read the relevant section of the specification:
;;
;; - space is only allocated / composed when the space allocation
;; protocol is invoked, that is when layout-frame is called.
;;
;; - CHANGE-SPACE-REQUIREMENTS is only for
;; . reparsing the user space options
;; . flushing the space requirement cache of that pane.
;;
;; - when within CHANGING-SPACE-REQUIREMENTS, the method for
;; CHANGING-SPACE-REQUIREMENTS on the top level sheet should not
;; invoke the layout protocol but remember that the SR of the frame
;; LAYOUT-FRAME then is then called when leaving
;; CHANGING-SPACE-REQUIREMENTS.
;;
;; - NOTE-SPACE-REQUIREMENTS-CHANGED is solely for the user.
;;
;; --GB 2003-03-16
(defmethod allocate-space :around ((pane layout-protocol-mixin) width height)
(unless (and (eql (pane-current-width pane) width)
(eql (pane-current-height pane) height))
(setf (pane-current-width pane) width
(pane-current-height pane) height)
(unless (typep pane 'top-level-sheet-pane)
(resize-sheet pane width height))
(call-next-method)))
(defmethod compose-space :around ((pane layout-protocol-mixin) &key width height)
(declare (ignore width height))
(or (pane-space-requirement pane)
(setf (pane-space-requirement pane)
(call-next-method))))
;;; changing space requirements
;; Here is what we do:
;;
;; change-space-requirements (pane) :=
;; clear space requirements cache
;; call change-space-requirements on parent pane
;; call note-space-requirements-changed
;;
;; This is split into :before, primary and :after method to allow for
;; easy overriding of change-space-requirements without needing to
;; know the details of the space requirement cache and the
;; note-space-requirements-changed notifications.
;;
;; The calls to change-space-requirements travel all the way up to the
;; top-level-sheet-pane which then invokes the layout protocol calling
;; layout-frame.
;;
;; In case this happens within changing-space-requirements layout
;; frame is not called but simply recorded and then called when
;; changing-space-requirements is left.
;;
;; No action is taken in note-space-requirements-changed. We leave
;; that to the user.
(defvar *changing-space-requirements* nil
"Bound to non-NIL while within the execution of CHANGING-SPACE-REQUIREMENTS.")
(defvar *changed-space-requirements* nil
"A list of (frame pane resize-frame) tuples recording frames and their panes which
changed during the current execution of CHANGING-SPACE-REQUIREMENTS.
[This is expected to change]")
(defmethod change-space-requirements :before ((pane layout-protocol-mixin)
&rest space-req-keys
&key resize-frame &allow-other-keys)
(declare (ignore resize-frame space-req-keys))
;; Clear the space requirements cache
(setf (pane-space-requirement pane) nil)
(setf (pane-current-width pane) nil)
(setf (pane-current-height pane) nil) )
(defmethod change-space-requirements ((pane layout-protocol-mixin)
&key resize-frame &allow-other-keys)
(when (sheet-parent pane)
(change-space-requirements (sheet-parent pane)
:resize-frame resize-frame)))
(defmethod change-space-requirements :after ((pane layout-protocol-mixin)
&key resize-frame &allow-other-keys)
(declare (ignore resize-frame))
(note-space-requirements-changed (sheet-parent pane) pane))
(defmethod note-space-requirements-changed (pane client)
"Just a no-op fallback method."
nil)
;;; CHANGING-SPACE-REQUIREMENTS macro
(defmacro changing-space-requirements ((&key resize-frame layout) &body body)
`(invoke-with-changing-space-requirements (lambda () ,@body) :resize-frame ,resize-frame :layout ,layout))
(defun invoke-with-changing-space-requirements (continuation &key resize-frame layout)
(cond (*changed-space-requirements*
;; We are already within changing-space-requirements, so just
;; call the body. This might however lead to surprising
;; behavior in case the outer changing-space-requirements has
;; resize-frame = NIL while the inner has resize-frame = T.
(funcall continuation))
(t
(let ((*changed-space-requirements* nil))
(let ((*changing-space-requirements* t))
(funcall continuation))
;;
;; Note: That 'resize-frame' and especially 'layout' are
;; options to this strongly suggests that the authors of
;; the clim specification may have meant that
;; changing-space-requirements records space requirements
;; of the *application-frame* only.
;;
;; We solve this by recording all frames but applying
;; resize-frame and layout only to *application-frame*.
;;
(dolist (q *changed-space-requirements*)
(destructuring-bind (frame pane resize-frame-2) q
(cond ((eq frame *application-frame*)
(when layout
(setf (frame-current-layout frame) layout))
(cond (resize-frame
(layout-frame frame))
(t
(layout-frame frame (bounding-rectangle-width pane) (bounding-rectangle-height pane)))))
(t
(cond (resize-frame-2
(layout-frame frame))
(t
(layout-frame frame (bounding-rectangle-width pane) (bounding-rectangle-height pane)))))))) ))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; BASIC PANE
(defclass basic-pane (;; layout-protocol-mixin
standard-space-requirement-options-mixin
sheet-parent-mixin mirrored-sheet-mixin
pane)
((foreground :initarg :foreground
:reader pane-foreground)
(background :initarg :background
:reader pane-background)
(text-style :initarg :text-style
:reader pane-text-style)
(align-x :initarg :align-x
:type (member :left :center :right)
:reader pane-align-x)
(align-y :initarg :align-y
:type (member :top :center :bottom)
:reader pane-align-y))
(:default-initargs
:foreground +black+
:background *3d-normal-color*
:text-style *default-text-style*
:align-x :left
:align-y :top))
(defmethod initialize-instance :after ((obj basic-pane) &key text-style)
(when (consp text-style)
(setf (slot-value obj 'text-style) (apply #'make-text-style text-style))))
(defmethod engraft-medium :after (medium port (pane basic-pane))
(declare (ignore port))
;; implements 29.2.2, last sentence.
(setf (medium-foreground medium) (pane-foreground pane)
(medium-background medium) (pane-background pane)
(medium-text-style medium) (pane-text-style pane)))
;;;;
;;;; Composite Panes
;;;;
(defclass composite-pane (sheet-multiple-child-mixin
basic-pane)
()
(:documentation "protocol class"))
(defmethod spacing-value-to-device-units (pane x)
(cond ((realp x) x)
((consp x)
(ecase (cadr x)
(:pixels (car x))
(:point (* (car x) (graft-pixels-per-inch (graft pane)) 1/72))
(:mm (* (car x) (graft-pixels-per-millimeter (graft pane))))
(:character (* (car x) (text-style-character-width (pane-text-style pane)
(sheet-medium pane)
#\m)))
(:line (* (car x)
(stream-line-height pane)))))))
;;; SINGLE-CHILD-COMPOSITE PANE
(defclass single-child-composite-pane (sheet-single-child-mixin basic-pane) ())
(defmethod initialize-instance :after ((pane single-child-composite-pane)
&rest args
&key contents
&allow-other-keys)
(declare (ignore args))
(when contents
(sheet-adopt-child pane (first contents))))
(defmethod compose-space ((pane single-child-composite-pane) &key width height)
(if (sheet-child pane)
(compose-space (sheet-child pane)
:width width :height height)
(make-space-requirement)))
(defmethod allocate-space ((pane single-child-composite-pane) width height)
(when (sheet-child pane)
(allocate-space (sheet-child pane) width height)))
;;;; TOP-LEVEL-SHEET
(defclass top-level-sheet-pane (composite-pane)
()
(:documentation "For the first pane in the architecture"))
(defun top-level-sheet-pane-p (pane)
(typep pane 'top-level-sheet-pane))
(defmethod change-space-requirements ((pane top-level-sheet-pane)
&rest space-req-keys
&key resize-frame &allow-other-keys)
(declare (ignore space-req-keys))
(cond (*changing-space-requirements*
;; Record changed space requirements.
;; What happens if we change the requirements successively
;; with different values? Only the first takes effect?
;; -Hefner
(unless (find pane *changed-space-requirements* :key #'second)
(push (list (pane-frame pane) pane resize-frame)
*changed-space-requirements*)))
(t
(let ((frame (pane-frame pane)))
;; ### we miss the :resize-frame option
(cond (resize-frame
(layout-frame frame))
(t
(layout-frame frame (bounding-rectangle-width pane) (bounding-rectangle-height pane))))))))
(defmethod compose-space ((pane top-level-sheet-pane) &key width height)
(declare (ignore width height))
(compose-space (first (sheet-children pane))))
(defmethod allocate-space ((pane top-level-sheet-pane) width height)
(unless (pane-space-requirement pane)
(setf (pane-space-requirement pane)
(compose-space pane)))
(when (first (sheet-children pane))
(allocate-space
(first (sheet-children pane))
(clamp width (sr-min-width pane) (sr-max-width pane))
(clamp height (sr-min-height pane) (sr-max-height pane)))))
#+nil ; old
(defmethod handle-event ((pane top-level-sheet-pane)
(event window-configuration-event))
(let ((x (window-configuration-event-x event))
(y (window-configuration-event-y event))
(width (window-configuration-event-width event))
(height (window-configuration-event-height event)))
;; avoid going into an infinite loop by not using (setf sheet-transformation)
(setf (slot-value pane 'transformation)
(make-translation-transformation x y))
(invalidate-cached-transformations pane)
;; avoid going into an infinite loop by not using (setf sheet-region)
(setf (slot-value pane 'region)
(make-bounding-rectangle 0 0 width height))
(invalidate-cached-regions pane)
(allocate-space pane width height)))
(defmethod handle-event ((pane top-level-sheet-pane)
(event window-configuration-event))
(let ((x (window-configuration-event-x event))
(y (window-configuration-event-y event))
(width (window-configuration-event-width event))
(height (window-configuration-event-height event)))
(with-bounding-rectangle* (old-x1 old-y1 old-x2 old-y2) (sheet-region pane)
(let ((old-width (- old-x2 old-x1))
(old-height (- old-y2 old-y1)))
;; avoid going into an infinite loop by not using (setf sheet-transformation)
(setf (slot-value pane 'transformation)
(make-translation-transformation x y))
(invalidate-cached-transformations pane)
;; avoid going into an infinite loop by not using (setf sheet-region)
(setf (slot-value pane 'region)
(make-bounding-rectangle 0 0 width height))
(when (or (/= width old-width)
(/= height old-height))
(invalidate-cached-regions pane)
(allocate-space pane width height))))))
(defmethod handle-event ((pane top-level-sheet-pane)
(event window-manager-delete-event))
(frame-exit (pane-frame (event-sheet event))))
;;;; UNMANAGED-TOP-LEVEL-SHEET PANE
(defclass unmanaged-top-level-sheet-pane (top-level-sheet-pane)
()
(:documentation "Top-level sheet without window manager intervention"))
(defmethod sheet-native-transformation ((sheet top-level-sheet-pane))
+identity-transformation+)
(defmethod change-space-requirements ((pane unmanaged-top-level-sheet-pane)
&rest space-req-keys
&key resize-frame &allow-other-keys)
;; Special variant for unmanaged-top-level-sheet-pane. Since the
;; pane is unmanaged there is no window manager which can offer the
;; user options to resize this top level pane.
;;
;; This should however be changed by turning on the :resize-frame
;; option of the frame of the unmanaged-top-level-sheet-pane and
;; handle it in the method on top-level-sheet.
;;
;; This is currently not done, since: