560af5c5 |
1 | ;; Common Lisp bindings for GTK+ v2.0 |
82747bbd |
2 | ;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no> |
560af5c5 |
3 | ;; |
4 | ;; This library is free software; you can redistribute it and/or |
5 | ;; modify it under the terms of the GNU Lesser General Public |
6 | ;; License as published by the Free Software Foundation; either |
7 | ;; version 2 of the License, or (at your option) any later version. |
8 | ;; |
9 | ;; This library is distributed in the hope that it will be useful, |
10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
12 | ;; Lesser General Public License for more details. |
13 | ;; |
14 | ;; You should have received a copy of the GNU Lesser General Public |
15 | ;; License along with this library; if not, write to the Free Software |
16 | ;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
17 | |
2176a9c7 |
18 | ;; $Id: gobject.lisp,v 1.19 2004-11-07 15:58:08 espen Exp $ |
560af5c5 |
19 | |
20 | (in-package "GLIB") |
21 | |
22 | |
2176a9c7 |
23 | ;;;; Metaclass used for subclasses of gobject |
24 | |
25 | (eval-when (:compile-toplevel :load-toplevel :execute) |
26 | (defclass gobject-class (ginstance-class) |
27 | ()) |
28 | |
29 | (defmethod validate-superclass ((class gobject-class) |
30 | (super pcl::standard-class)) |
31 | ; (subtypep (class-name super) 'gobject) |
32 | t)) |
33 | |
34 | (defclass direct-property-slot-definition (direct-virtual-slot-definition) |
35 | ((pname :reader slot-definition-pname :initarg :pname) |
36 | (readable :initform t :reader slot-readable-p :initarg :readable) |
37 | (writable :initform t :reader slot-writable-p :initarg :writable) |
38 | (construct :initform nil :initarg :construct))) |
39 | |
40 | (defclass effective-property-slot-definition (effective-virtual-slot-definition) |
41 | ((pname :reader slot-definition-pname :initarg :pname) |
42 | (readable :reader slot-readable-p :initarg :readable) |
43 | (writable :reader slot-writable-p :initarg :writable) |
44 | (construct :initarg :construct)));) |
45 | |
46 | (defbinding %object-ref () pointer |
47 | (location pointer)) |
48 | |
49 | (defbinding %object-unref () nil |
50 | (location pointer)) |
51 | |
52 | (defmethod reference-foreign ((class gobject-class) location) |
53 | (declare (ignore class)) |
54 | (%object-ref location)) |
55 | |
56 | (defmethod unreference-foreign ((class gobject-class) location) |
57 | (declare (ignore class)) |
58 | (%object-unref location)) |
59 | |
60 | |
61 | ; (defbinding object-class-install-param () nil |
62 | ; (class pointer) |
63 | ; (id unsigned-int) |
64 | ; (parameter parameter)) |
65 | |
66 | ; (defbinding object-class-find-param-spec () parameter |
67 | ; (class pointer) |
68 | ; (name string)) |
69 | |
70 | (defun signal-name-to-string (name) |
71 | (substitute #\_ #\- (string-downcase (string name)))) |
72 | |
73 | |
74 | (defmethod direct-slot-definition-class ((class gobject-class) &rest initargs) |
75 | (case (getf initargs :allocation) |
76 | (:property (find-class 'direct-property-slot-definition)) |
77 | (t (call-next-method)))) |
78 | |
79 | (defmethod effective-slot-definition-class ((class gobject-class) &rest initargs) |
80 | (case (getf initargs :allocation) |
81 | (:property (find-class 'effective-property-slot-definition)) |
82 | (t (call-next-method)))) |
83 | |
84 | (defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds) |
85 | (if (eq (most-specific-slot-value direct-slotds 'allocation) :property) |
86 | (nconc |
87 | (list :pname (signal-name-to-string |
88 | (most-specific-slot-value direct-slotds 'pname)) |
89 | :readable (most-specific-slot-value direct-slotds 'readable) |
90 | :writable (most-specific-slot-value direct-slotds 'writable) |
91 | :construct (most-specific-slot-value direct-slotds 'construct)) |
92 | (call-next-method)) |
93 | (call-next-method))) |
94 | |
95 | |
96 | (defmethod initialize-internal-slot-functions ((slotd effective-property-slot-definition)) |
97 | (let* ((type (slot-definition-type slotd)) |
98 | (pname (slot-definition-pname slotd)) |
99 | (type-number (find-type-number type))) |
100 | (unless (slot-boundp slotd 'reader-function) |
101 | (setf |
102 | (slot-value slotd 'reader-function) |
103 | (if (slot-readable-p slotd) |
104 | (let () ;(reader (reader-function (type-from-number type-number)))) |
105 | #'(lambda (object) |
106 | (let ((gvalue (gvalue-new type-number))) |
107 | (%object-get-property object pname gvalue) |
108 | (unwind-protect |
109 | (funcall #|reader|# (reader-function (type-from-number type-number)) gvalue +gvalue-value-offset+) |
110 | (gvalue-free gvalue t))))) |
111 | #'(lambda (value object) |
112 | (error "Slot is not readable: ~A" (slot-definition-name slotd)))))) |
113 | |
114 | (unless (slot-boundp slotd 'writer-function) |
115 | (setf |
116 | (slot-value slotd 'writer-function) |
117 | (if (slot-writable-p slotd) |
118 | (let ();; (writer (writer-function (type-from-number type-number))) |
119 | ;; (destroy (destroy-function (type-from-number type-number)))) |
120 | #'(lambda (value object) |
121 | (let ((gvalue (gvalue-new type-number))) |
122 | (funcall #|writer|# (writer-function (type-from-number type-number)) value gvalue +gvalue-value-offset+) |
123 | (%object-set-property object pname gvalue) |
124 | ; (funcall #|destroy|#(destroy-function (type-from-number type-number)) gvalue +gvalue-value-offset+) |
125 | (gvalue-free gvalue t) |
126 | value))) |
127 | #'(lambda (value object) |
128 | (error "Slot is not writable: ~A" (slot-definition-name slotd)))))) |
129 | |
130 | (unless (slot-boundp slotd 'boundp-function) |
131 | (setf |
132 | (slot-value slotd 'boundp-function) |
133 | #'(lambda (object) |
134 | (declare (ignore object)) |
135 | t)))) |
136 | (call-next-method)) |
137 | |
138 | |
139 | ;;;; Super class for all classes in the GObject type hierarchy |
140 | |
560af5c5 |
141 | (eval-when (:compile-toplevel :load-toplevel :execute) |
c8c48a4c |
142 | (defclass gobject (ginstance) |
560af5c5 |
143 | () |
2176a9c7 |
144 | (:metaclass gobject-class) |
9adccb27 |
145 | (:alien-name "GObject"))) |
146 | |
147 | (defmethod print-object ((instance gobject) stream) |
148 | (print-unreadable-object (instance stream :type t :identity nil) |
149 | (if (slot-boundp instance 'location) |
150 | (format stream "at 0x~X" (sap-int (proxy-location instance))) |
151 | (write-string "(destroyed)" stream)))) |
560af5c5 |
152 | |
4d83a8a6 |
153 | |
82747bbd |
154 | (defmethod initialize-instance ((object gobject) &rest initargs) |
9adccb27 |
155 | ;; Extract initargs which we should pass directly to the GObeject |
156 | ;; constructor |
157 | (let* ((slotds (class-slots (class-of object))) |
158 | (args (loop |
159 | as tmp = initargs then (cddr tmp) while tmp |
160 | as key = (first tmp) |
161 | as value = (second tmp) |
162 | as slotd = (find-if |
163 | #'(lambda (slotd) |
164 | (member key (slot-definition-initargs slotd))) |
165 | slotds) |
166 | when (and (typep slotd 'effective-property-slot-definition) |
167 | (slot-value slotd 'construct)) |
168 | collect (progn |
169 | (remf initargs key) |
170 | (list |
171 | (slot-definition-pname slotd) |
172 | (slot-definition-type slotd) |
173 | value))))) |
174 | (if args |
175 | (let* ((string-size (size-of 'string)) |
176 | (string-writer (writer-function 'string)) |
177 | (string-destroy (destroy-function 'string)) |
178 | (params (allocate-memory |
179 | (* (length args) (+ string-size +gvalue-size+))))) |
180 | (loop |
181 | for (pname type value) in args |
182 | as tmp = params then (sap+ tmp (+ string-size +gvalue-size+)) |
183 | do (funcall string-writer pname tmp) |
8755b1a5 |
184 | (gvalue-init (sap+ tmp string-size) type value)) |
9adccb27 |
185 | (unwind-protect |
186 | (setf |
187 | (slot-value object 'location) |
188 | (%gobject-newv (type-number-of object) (length args) params)) |
189 | (loop |
190 | repeat (length args) |
191 | as tmp = params then (sap+ tmp (+ string-size +gvalue-size+)) |
192 | do (funcall string-destroy tmp) |
8755b1a5 |
193 | (gvalue-unset (sap+ tmp string-size))) |
9adccb27 |
194 | (deallocate-memory params))) |
8755b1a5 |
195 | (setf |
196 | (slot-value object 'location) |
197 | (%gobject-new (type-number-of object))))) |
198 | |
0f134a29 |
199 | (%object-weak-ref object) |
4d83a8a6 |
200 | (apply #'call-next-method object initargs)) |
201 | |
202 | |
9adccb27 |
203 | (defmethod initialize-instance :around ((object gobject) &rest initargs) |
0f134a29 |
204 | (declare (ignore initargs)) |
205 | (call-next-method) |
9adccb27 |
206 | (%object-weak-ref object)) |
0f134a29 |
207 | |
9adccb27 |
208 | |
8755b1a5 |
209 | (defcallback weak-notify (nil (data int) (location pointer)) |
9adccb27 |
210 | (let ((object (find-cached-instance location))) |
211 | (when object |
212 | ;; (warn "~A being finalized by the GObject system while still in existence in lisp" object) |
213 | (slot-makunbound object 'location) |
214 | (remove-cached-instance location)))) |
0f134a29 |
215 | |
216 | (defbinding %object-weak-ref (object) nil |
217 | (object gobject) |
218 | ((callback weak-notify) pointer) |
219 | (0 unsigned-int)) |
220 | |
d4b21b08 |
221 | (defbinding (%gobject-new "g_object_new") () pointer |
a9044181 |
222 | (type type-number) |
223 | (nil null)) |
560af5c5 |
224 | |
9adccb27 |
225 | (defbinding (%gobject-newv "g_object_newv") () pointer |
4d83a8a6 |
226 | (type type-number) |
227 | (n-parameters unsigned-int) |
9adccb27 |
228 | (params pointer)) |
de8516ca |
229 | |
230 | |
d4b21b08 |
231 | |
323d4265 |
232 | ;;;; Property stuff |
560af5c5 |
233 | |
26b133ed |
234 | (defbinding %object-set-property () nil |
c8c48a4c |
235 | (object gobject) |
236 | (name string) |
237 | (value gvalue)) |
86d9d6ab |
238 | |
26b133ed |
239 | (defbinding %object-get-property () nil |
c8c48a4c |
240 | (object gobject) |
241 | (name string) |
a9044181 |
242 | (value gvalue)) |
86d9d6ab |
243 | |
26b133ed |
244 | (defbinding %object-notify () nil |
c8c48a4c |
245 | (object gobject) |
246 | (name string)) |
86d9d6ab |
247 | |
26b133ed |
248 | (defbinding object-freeze-notify () nil |
a9044181 |
249 | (object gobject)) |
86d9d6ab |
250 | |
26b133ed |
251 | (defbinding object-thaw-notify () nil |
a9044181 |
252 | (object gobject)) |
86d9d6ab |
253 | |
26b133ed |
254 | (defbinding %object-set-qdata-full () nil |
86d9d6ab |
255 | (object gobject) |
256 | (id quark) |
257 | (data unsigned-long) |
258 | (destroy-marshal pointer)) |
259 | |
a9044181 |
260 | |
261 | ;;;; User data |
262 | |
86d9d6ab |
263 | (defun (setf object-data) (data object key &key (test #'eq)) |
264 | (%object-set-qdata-full |
265 | object (quark-from-object key :test test) |
0f134a29 |
266 | (register-user-data data) (callback %destroy-user-data)) |
86d9d6ab |
267 | data) |
268 | |
26b133ed |
269 | (defbinding %object-get-qdata () unsigned-long |
86d9d6ab |
270 | (object gobject) |
271 | (id quark)) |
272 | |
273 | (defun object-data (object key &key (test #'eq)) |
274 | (find-user-data |
275 | (%object-get-qdata object (quark-from-object key :test test)))) |
276 | |
277 | |
d4b21b08 |
278 | ;;;; |
279 | |
323d4265 |
280 | (defbinding %object-class-list-properties () pointer |
d4b21b08 |
281 | (class pointer) |
282 | (n-properties unsigned-int :out)) |
283 | |
9c03a07c |
284 | |
285 | (defun %map-params (params length type inherited-p) |
286 | (if inherited-p |
9adccb27 |
287 | (map-c-vector 'list #'identity params 'param length) |
9c03a07c |
288 | (let ((properties ())) |
9adccb27 |
289 | (map-c-vector 'list |
9c03a07c |
290 | #'(lambda (param) |
291 | (when (eql (param-owner-type param) type) |
292 | (push param properties))) |
293 | params 'param length) |
294 | (nreverse properties)))) |
295 | |
296 | (defun query-object-class-properties (type &optional inherited-p) |
297 | (let* ((type-number (find-type-number type)) |
298 | (class (type-class-ref type-number))) |
299 | (unwind-protect |
300 | (multiple-value-bind (array length) |
301 | (%object-class-list-properties class) |
302 | (unwind-protect |
303 | (%map-params array length type-number inherited-p) |
304 | (deallocate-memory array))) |
305 | ; (type-class-unref type-number) |
306 | ))) |
d4b21b08 |
307 | |
308 | |
309 | (defun default-slot-name (name) |
310 | (intern (substitute #\- #\_ (string-upcase (string-upcase name))))) |
311 | |
312 | (defun default-slot-accessor (class-name slot-name type) |
313 | (intern |
314 | (format |
315 | nil "~A-~A~A" class-name slot-name |
4d83a8a6 |
316 | (if (eq type 'boolean) "-P" "")))) |
d4b21b08 |
317 | |
323d4265 |
318 | |
9c03a07c |
319 | (defun slot-definition-from-property (class property) |
320 | (with-slots (name flags value-type documentation) property |
321 | (let* ((slot-name (default-slot-name name)) |
322 | (slot-type (or (type-from-number value-type) value-type)) |
323 | (accessor (default-slot-accessor class slot-name slot-type))) |
324 | |
325 | `(,slot-name |
326 | :allocation :property :pname ,name |
327 | |
328 | ;; accessors |
329 | ,@(cond |
330 | ((and |
331 | (member :writable flags) (member :readable flags) |
332 | (not (member :construct-only flags))) |
333 | (list :accessor accessor)) |
334 | ((and (member :writable flags) (not (member :construct-only flags))) |
335 | (list :writer `(setf ,accessor))) |
336 | ((member :readable flags) |
337 | (list :reader accessor))) |
338 | |
339 | ;; readable/writable/construct |
340 | ,@(when (or (not (member :writable flags)) |
341 | (member :construct-only flags)) |
342 | '(:writable nil)) |
343 | ,@(when (not (member :readable flags)) |
344 | '(:readable nil)) |
345 | ,@(when (or (member :construct flags) |
346 | (member :construct-only flags)) |
347 | '(:construct t)) |
348 | |
349 | ;; initargs |
350 | ,@(when (or (member :construct flags) |
351 | (member :construct-only flags) |
352 | (member :writable flags)) |
353 | (list :initarg (intern (string slot-name) "KEYWORD"))) |
354 | |
355 | :type ,slot-type |
356 | :documentation ,documentation)))) |
357 | |
358 | |
359 | (defun slot-definitions (class properties slots) |
360 | (loop |
361 | with manual-slots = slots |
362 | for property in properties |
363 | unless (find-if |
364 | #'(lambda (slot) |
365 | (destructuring-bind (name &rest args) slot |
366 | (or |
367 | (equal (param-name property) (getf args :pname)) |
368 | (eq (default-slot-name (param-name property)) name)))) |
369 | manual-slots) |
370 | do (push (slot-definition-from-property class property) slots)) |
371 | (delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots)) |
372 | |
373 | |
374 | (defun expand-gobject-type (type &optional options (metaclass 'gobject-class)) |
375 | (let ((supers (cons (supertype type) (implements type))) |
376 | (class (type-from-number type)) |
377 | (slots (getf options :slots))) |
378 | `(defclass ,class ,supers |
379 | ,(slot-definitions class (query-object-class-properties type) slots) |
380 | (:metaclass ,metaclass) |
381 | (:alien-name ,(find-type-name type))))) |
323d4265 |
382 | |
d4b21b08 |
383 | |
9c03a07c |
384 | (register-derivable-type 'gobject "GObject" 'expand-gobject-type) |