summaryrefslogtreecommitdiff
path: root/Core/windowing/repaint.lisp
blob: 182d1b05ee6d161130c3ec6b14dd5595ac38fde2 (plain)
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
;;; ---------------------------------------------------------------------------
;;;   License: LGPL-2.1+ (See file 'Copyright' for details).
;;; ---------------------------------------------------------------------------
;;;
;;;  (c) Copyright 1998-2000 by Michael McDonald <mikemac@mikemac.com>
;;;  (c) Copyright 2000 by Iban Hatchondo <hatchond@emi.u-bordeaux.fr>
;;;  (c) Copyright 2000 by Julien Boninfante <boninfan@emi.u-bordeaux.fr>
;;;  (c) Copyright 2000,2014 by Robert Strandh <robert.strandh@gmail.com>
;;;  (c) Copyright 2022 by Daniel Kochmański <daniel@turtleware.eu>
;;;
;;; ---------------------------------------------------------------------------
;;;
;;; The Repaint Protocol.
;;;

(in-package #:clim-internals)


;;; Input protocol functions.

(defmethod handle-event ((sheet basic-sheet) (event window-repaint-event))
  (dispatch-repaint sheet (window-event-region event)))

;;; Backward compatibility.
(defmethod queue-repaint ((sheet basic-sheet) (event window-repaint-event))
  (dispatch-repaint sheet (window-event-region event)))


;;; Repaint protocol functions.

(defmethod handle-repaint ((sheet basic-sheet) region)
  (declare (ignore region))
  nil)

(defmethod repaint-sheet :around ((sheet basic-sheet) region)
  (declare (ignore region))
  (when (and (sheet-mirror sheet)
             (sheet-viewable-p sheet))
    (call-next-method)))

(defmethod handle-repaint :around ((sheet sheet-with-medium-mixin) region)
  (typecase region
    (nowhere-region)
    (everywhere-region
     (call-next-method))
    (otherwise
     (with-sheet-medium (medium sheet)
       (letf (((medium-clipping-region medium) region))
         (call-next-method))))))

;;; NOTE the native region may be smaller than the sheet region.
;;; NOTE see #1280 to learn why SHEET-NATIVE-REGION* is introduced.
;;; FIXME caching.
(defgeneric sheet-native-region* (sheet)
  (:method ((sheet graft))
    +everywhere+)
  (:method ((sheet mirrored-sheet-mixin))
    (if-let ((parent (sheet-parent sheet)))
      (region-intersection
       (sheet-region sheet)
       (untransform-region (sheet-transformation sheet)
                           (sheet-native-region* parent)))
      (sheet-region sheet)))
  (:method ((sheet basic-sheet))
    (if-let ((parent (sheet-parent sheet)))
      (region-intersection
       (transform-region (sheet-native-transformation sheet) (sheet-region sheet))
       (sheet-native-region* (sheet-parent sheet)))
      (sheet-region sheet))))

(defun sheet-visible-region (sheet)
  (if (sheet-direct-mirror sheet)
      (sheet-native-region* sheet)
      (untransform-region (sheet-native-transformation sheet)
                          (sheet-native-region* sheet))))

(defun sheet-repaint-region (sheet region)
  (let ((visible (sheet-visible-region sheet)))
    (region-intersection visible region)))

(defmethod repaint-sheet ((sheet basic-sheet) region)
  (setf region (sheet-repaint-region sheet region))
  (unless (region-equal region +nowhere+)
    (with-output-buffered (sheet)
      (handle-repaint sheet region)
      (loop for child in (reverse (sheet-children sheet))
            unless (sheet-direct-mirror child)
              do (let* ((tr (sheet-transformation child))
                        (cr (untransform-region tr region)))
                   (repaint-sheet child cr))))))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Repaint protocol classes.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Class STANDARD-REPAINTING-MIXIN.

(defclass standard-repainting-mixin () ())

(defmethod queue-repaint
    ((sheet standard-repainting-mixin) (region region))
  (when-let ((msheet (sheet-mirrored-ancestor sheet)))
    (error "Not implemented yet!")
    ;; Only repaint when the sheet has a mirror. Repaint directly from the
    ;; mirror to ensure, that transparent parts are rendered correctly.
    #+ (or)
    (if (eq msheet sheet)
        (error "IMPLEMENTME")
        (let* ((delta (sheet-delta-transformation sheet msheet))
               (mregion (transform-region delta region)))
          (error "IMPLEMENTME")))))

(defmethod dispatch-repaint ((sheet standard-repainting-mixin) region)
  (queue-repaint sheet region))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Class IMMEDIATE-REPAINTING-MIXIN.

(defclass immediate-repainting-mixin () ())

;;; Backward compatibility.
(defmethod queue-repaint
    ((sheet immediate-repainting-mixin) (region region))
  (dispatch-repaint sheet region))

(defmethod dispatch-repaint ((sheet immediate-repainting-mixin) region)
  ;; Only repaint when the sheet has a mirror. Repaint directly from the mirror
  ;; to ensure, that transparent parts are rendered correctly.
  (when-let ((msheet (sheet-mirrored-ancestor sheet)))
    (setf region (sheet-repaint-region sheet region))
    (if (eq msheet sheet)
        (repaint-sheet sheet region)
        (let ((transf (sheet-delta-transformation sheet msheet)))
          (dispatch-repaint msheet (transform-region transf region))))))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Class SHEET-MUTE-REPAINTING-MIXIN.

(defclass sheet-mute-repainting-mixin () ())

(defmethod dispatch-repaint ((sheet sheet-mute-repainting-mixin) region)
  (declare (ignore sheet region))
  (values))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; No Standard.

;; as present in silica's implementation
(defclass always-repaint-background-mixin () ())

;; never repaint the background (only for speed)
(defclass never-repaint-background-mixin () ())

(defmethod handle-repaint :before ((sheet always-repaint-background-mixin) region)
  (when (typep sheet 'never-repaint-background-mixin)
    (return-from handle-repaint))
  (with-sheet-medium (medium sheet)
    (with-bounding-rectangle* (x1 y1 x2 y2)
        (region-intersection region (sheet-visible-region sheet))
      (medium-clear-area medium x1 y1 x2 y2))))

;;; Integration with region and transformation changes
(defparameter *skip-repaint-p* nil)

(defun dispatch-repaint-region (sheet
                                old-transformation old-region
                                new-transformation new-region)
  (when (and (not *skip-repaint-p*)
             (sheet-viewable-p sheet))
    (if (sheet-direct-mirror sheet)
        (dispatch-repaint sheet new-region)
        (dispatch-repaint (sheet-parent sheet)
                          (region-union
                           (rounded-bounding-rectangle
                            (transform-region old-transformation old-region))
                           (rounded-bounding-rectangle
                            (transform-region new-transformation new-region)))))))

(defmethod (setf sheet-region) :around (new-region (sheet basic-sheet))
  (let ((old-region (sheet-region sheet)))
    (unless (region-equal new-region old-region)
      (let ((*skip-repaint-p* t))
        (call-next-method))
      (let ((transformation (sheet-transformation sheet)))
        (dispatch-repaint-region sheet
                                 transformation old-region
                                 transformation new-region))))
  new-region)

(defmethod (setf sheet-transformation) :around (new-transformation (sheet basic-sheet))
  (let ((old-transformation (sheet-transformation sheet)))
    (unless (transformation-equal new-transformation old-transformation)
      (let ((*skip-repaint-p* t))
        (call-next-method))
      (let ((region (sheet-region sheet)))
        (dispatch-repaint-region sheet
                                 old-transformation region
                                 new-transformation region))))
  new-transformation)

(defun %set-sheet-region-and-transformation (sheet new-region new-transformation)
  (let ((old-transformation (sheet-transformation sheet))
        (old-region (sheet-region sheet)))
    (unless (and (region-equal new-region old-region)
                 (transformation-equal new-transformation old-transformation))
      (let ((*skip-repaint-p* t))
        (setf (sheet-region sheet) new-region
              (sheet-transformation sheet) new-transformation))
      (dispatch-repaint-region sheet
                               old-transformation old-region
                               new-transformation new-region))))