chiark / gitweb /
Changes necessary to allow saving of core images with clg.
[clg] / glib / gtype.lisp
CommitLineData
560af5c5 1;; Common Lisp bindings for GTK+ v2.0
d4b21b08 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
dfa4f314 18;; $Id: gtype.lisp,v 1.27 2005-03-06 17:26:23 espen Exp $
560af5c5 19
20(in-package "GLIB")
21
22(use-prefix "g")
23
e0349dbd 24;; Initialize the glib type system
25(defbinding type-init () nil)
26(type-init)
560af5c5 27
28(deftype type-number () '(unsigned 32))
29
e74cfcab 30(deftype gtype () 'symbol)
31
32(defmethod alien-type ((type (eql 'gtype)) &rest args)
33 (declare (ignore type args))
34 (alien-type 'type-number))
35
36(defmethod size-of ((type (eql 'gtype)) &rest args)
37 (declare (ignore type args))
38 (size-of 'type-number))
39
40(defmethod to-alien-form (gtype (type (eql 'gtype)) &rest args)
41 (declare (ignore type args))
42 `(find-type-number ,gtype t))
43
44(defmethod to-alien-function ((type (eql 'gtype)) &rest args)
45 (declare (ignore type args))
46 #'(lambda (gtype)
47 (find-type-number gtype t)))
48
49(defmethod from-alien-form (type-number (type (eql 'gtype)) &rest args)
50 (declare (ignore type args))
63752532 51 `(type-from-number ,type-number))
e74cfcab 52
53(defmethod from-alien-function ((type (eql 'gtype)) &rest args)
54 (declare (ignore type args))
55 #'(lambda (type-number)
63752532 56 (type-from-number type-number)))
e74cfcab 57
58(defmethod writer-function ((type (eql 'gtype)) &rest args)
73572c12 59 (declare (ignore type args))
e74cfcab 60 (let ((writer (writer-function 'type-number)))
61 #'(lambda (gtype location &optional (offset 0))
62 (funcall writer (find-type-number gtype t) location offset))))
63
64(defmethod reader-function ((type (eql 'gtype)) &rest args)
73572c12 65 (declare (ignore type args))
e74cfcab 66 (let ((reader (reader-function 'type-number)))
67 #'(lambda (location &optional (offset 0))
63752532 68 (type-from-number (funcall reader location offset)))))
e74cfcab 69
70
93aa67db 71(eval-when (:compile-toplevel :load-toplevel :execute)
d4b21b08 72 (defclass type-query (struct)
93aa67db 73 ((type-number :allocation :alien :type type-number)
74 (name :allocation :alien :type string)
75 (class-size :allocation :alien :type unsigned-int)
76 (instance-size :allocation :alien :type unsigned-int))
d168bafd 77 (:metaclass struct-class)))
93aa67db 78
79
e74cfcab 80(defbinding type-query (type) nil
81 ((find-type-number type t) type-number)
82 ((make-instance 'type-query) type-query :return))
93aa67db 83
84(defun type-instance-size (type)
85 (slot-value (type-query type) 'instance-size))
86
87(defun type-class-size (type)
88 (slot-value (type-query type) 'class-size))
560af5c5 89
d4b21b08 90(defbinding type-class-ref (type) pointer
91 ((find-type-number type t) type-number))
560af5c5 92
d4b21b08 93(defbinding type-class-unref (type) nil
94 ((find-type-number type t) type-number))
93aa67db 95
d4b21b08 96(defbinding type-class-peek (type) pointer
97 ((find-type-number type t) type-number))
93aa67db 98
560af5c5 99
d4b21b08 100;;;; Mapping between lisp types and glib types
560af5c5 101
dfa4f314 102(defvar *registered-types* ())
103(defvar *registered-type-aliases* ())
104(defvar *lisp-type-to-type-number* (make-hash-table))
105(defvar *type-number-to-lisp-type* (make-hash-table))
d4b21b08 106
107(defbinding %type-from-name () type-number
108 (name string))
109
dfa4f314 110(defun type-number-from-glib-name (name &optional (error-p t))
111 (let ((type-number (%type-from-name name)))
112 (cond
113 ((not (zerop type-number)) type-number)
114 (error-p (error "Invalid gtype name: ~A" name)))))
115
116(defun register-type (type id)
117 (pushnew (cons type id) *registered-types* :key #'car)
118 (let ((type-number
119 (typecase id
120 (string (type-number-from-glib-name id))
121 (symbol (funcall id)))))
122 (setf (gethash type *lisp-type-to-type-number*) type-number)
123 (setf (gethash type-number *type-number-to-lisp-type*) type)
124 type-number))
125
126(defun register-type-alias (type alias)
127 (pushnew (cons type alias) *registered-type-aliases* :key #'car)
128 (setf
129 (gethash type *lisp-type-to-type-number*)
130 (find-type-number alias t)))
131
132(defun reinitialize-all-types ()
133 (clrhash *lisp-type-to-type-number*)
134 (clrhash *type-number-to-lisp-type*)
135 (type-init) ; initialize the glib type system
136 (mapc #'(lambda (type)
137 (register-type (car type) (cdr type)))
138 *registered-types*)
139 (mapc #'(lambda (type)
140 (register-type-alias (car type) (cdr type)))
141 *registered-type-aliases*))
142
143(pushnew 'reinitialize-all-types
144 #+cmu *after-save-initializations*
145 #+sbcl *init-hooks*)
146
147#+cmu
148(pushnew 'system::reinitialize-global-table ; we shouldn't have to do this?
149 *after-save-initializations*)
150
151
152(defun find-type-number (type &optional error-p)
560af5c5 153 (etypecase type
154 (integer type)
dfa4f314 155 (string (type-number-from-glib-name type error-p))
d4b21b08 156 (symbol
dfa4f314 157 (or
158 (gethash type *lisp-type-to-type-number*)
159 (and error-p (error "Type not registered: ~A" type))))
160 (class (find-type-number (class-name type) error-p))))
560af5c5 161
4de90d10 162(defun type-from-number (type-number &optional error)
163 (multiple-value-bind (type found)
dfa4f314 164 (gethash type-number *type-number-to-lisp-type*)
4de90d10 165 (when (and error (not found))
dfa4f314 166 (let ((name (find-foreign-type-name type-number)))
4de90d10 167 (if name
168 (error "Type number not registered: ~A (~A)" type-number name)
169 (error "Invalid type number: ~A" type-number))))
170 type))
560af5c5 171
dfa4f314 172(defbinding (find-foreign-type-name "g_type_name") (type) (copy-of string)
d4b21b08 173 ((find-type-number type t) type-number))
174
175(defun type-number-of (object)
176 (find-type-number (type-of object) t))
177
21299acf 178(eval-when (:compile-toplevel :load-toplevel :execute)
dfa4f314 179 (defvar *type-initializers* ())
180 (defun %find-types-in-library (pathname prefixes ignore)
21299acf 181 (let ((process (run-program
182 "/usr/bin/nm" (list "--defined-only" "-D" (namestring (truename pathname)))
183 :output :stream :wait nil)))
184 (unwind-protect
185 (loop
186 as symbol = (let ((line (read-line (process-output process) nil)))
187 (when line (subseq line 11)))
188 while symbol
189 when (and
dfa4f314 190 (> (length symbol) 9)
191 (or
192 (not prefixes)
193 (some #'(lambda (prefix)
194 (and
195 (> (length symbol) (length prefix))
196 (string= prefix symbol :end2 (length prefix))))
197 (mklist prefixes)))
198 (string= "_get_type" symbol :start2 (- (length symbol) 9))
21299acf 199 (not (member symbol ignore :test #'string=)))
200 collect symbol)
201 (process-close process)))))
202
560af5c5 203
d168bafd 204(defmacro init-types-in-library (filename &key (prefix "") ignore)
21299acf 205 (let ((names (%find-types-in-library filename prefix ignore)))
206 `(progn
207 ,@(mapcar #'(lambda (name)
208 `(progn
209 (defbinding (,(intern name) ,name) () type-number)
dfa4f314 210 (,(intern name))
211 (pushnew ',(intern name) *type-initializers*)))
21299acf 212 names))))
213
dfa4f314 214(defun find-type-init-function (type-number)
215 (or
216 (loop
217 for type-init in *type-initializers*
218 when (= type-number (funcall type-init))
219 do (return type-init))
220 (error "Can't find init function for type number ~D" type-number)))
221
222(defun default-type-init-name (type)
223 (find-symbol (format nil "~A_~A_get_type"
224 (package-prefix *package*)
225 (substitute #\_ #\- (string-downcase type)))))
226
21299acf 227
228
229;;;; Metaclass for subclasses of ginstance
230
231(eval-when (:compile-toplevel :load-toplevel :execute)
232 (defclass ginstance-class (proxy-class)
233 ()))
234
235
dfa4f314 236(defmethod shared-initialize ((class ginstance-class) names &key name gtype)
21299acf 237 (declare (ignore names))
238 (let* ((class-name (or name (class-name class)))
dfa4f314 239 (type-number
240 (or
241 (find-type-number class-name)
242 (register-type class-name
243 (or (first gtype) (default-type-init-name class-name))))))
244 (call-next-method)
245 (when (slot-boundp class 'size)
246 (setf (slot-value class 'size) (type-instance-size type-number)))))
4de90d10 247
248
21299acf 249(defmethod validate-superclass ((class ginstance-class) (super standard-class))
250 (subtypep (class-name super) 'ginstance))
251
560af5c5 252
93aa67db 253;;;; Superclass for wrapping types in the glib type system
560af5c5 254
255(eval-when (:compile-toplevel :load-toplevel :execute)
93aa67db 256 (defclass ginstance (proxy)
d4b21b08 257 ((class :allocation :alien :type pointer))
258 (:metaclass proxy-class)))
560af5c5 259
93aa67db 260(defun %type-of-ginstance (location)
261 (let ((class (sap-ref-sap location 0)))
d168bafd 262 (type-from-number (sap-ref-32 class 0))))
560af5c5 263
d168bafd 264(defmethod ensure-proxy-instance ((class ginstance-class) location)
265 (declare (ignore class))
266 (let ((class (find-class (%type-of-ginstance location))))
267 (if class
268 (make-instance class :location (reference-foreign class location))
269 ;; TODO: (make-instance 'ginstance ...)
270 location)))
560af5c5 271
9ca5565a 272(defmethod copy-from-alien-form (location (class ginstance-class) &rest args)
273 (declare (ignore location class args))
274 (error "Doing copy-from-alien on a ref. counted class is most certainly an error, but if it really is what you want you should use REFERENCE-FOREIGN on the returned instance instead."))
275
276(defmethod copy-from-alien-function ((class ginstance-class) &rest args)
277 (declare (ignore class args))
278 (error "Doing copy-from-alien on a ref. counted class is most certainly an error, but if it really is what you want you should use REFERENCE-FOREIGN on the returned instance instead."))
279
280(defmethod reader-function ((class ginstance-class) &rest args)
281 (declare (ignore args))
282 #'(lambda (location &optional (offset 0))
283 (ensure-proxy-instance class (sap-ref-sap location offset))))
284
560af5c5 285
d4b21b08 286;;;; Registering fundamental types
287
63752532 288(register-type 'nil "void")
d4b21b08 289(register-type 'pointer "gpointer")
290(register-type 'char "gchar")
291(register-type 'unsigned-char "guchar")
292(register-type 'boolean "gboolean")
d4b21b08 293(register-type 'int "gint")
dfa4f314 294(register-type-alias 'fixnum 'int)
d4b21b08 295(register-type 'unsigned-int "guint")
296(register-type 'long "glong")
297(register-type 'unsigned-long "gulong")
298(register-type 'single-float "gfloat")
299(register-type 'double-float "gdouble")
a8cb9408 300(register-type 'pathname "gchararray")
4de90d10 301(register-type 'string "gchararray")
d4b21b08 302
303
62f12808 304;;;; Introspection of type information
d4b21b08 305
e77e7713 306(defvar *derivable-type-info* (make-hash-table))
d4b21b08 307
62f12808 308(defun register-derivable-type (type id expander &optional dependencies)
d4b21b08 309 (register-type type id)
e77e7713 310 (let ((type-number (register-type type id)))
62f12808 311 (setf
312 (gethash type-number *derivable-type-info*)
313 (list expander dependencies))))
d4b21b08 314
4de90d10 315(defun find-type-info (type)
316 (dolist (super (cdr (type-hierarchy type)))
e77e7713 317 (let ((info (gethash super *derivable-type-info*)))
4de90d10 318 (return-if info))))
319
62f12808 320(defun expand-type-definition (type forward-p options)
321 (let ((expander (first (find-type-info type))))
322 (funcall expander (find-type-number type t) forward-p options)))
d4b21b08 323
d4b21b08 324(defbinding type-parent (type) type-number
325 ((find-type-number type t) type-number))
326
327(defun supertype (type)
328 (type-from-number (type-parent type)))
329
337933d8 330(defbinding %type-interfaces (type) pointer
331 ((find-type-number type t) type-number)
332 (n-interfaces unsigned-int :out))
333
334(defun type-interfaces (type)
335 (multiple-value-bind (array length) (%type-interfaces type)
336 (unwind-protect
d168bafd 337 (map-c-vector 'list #'identity array 'type-number length)
337933d8 338 (deallocate-memory array))))
339
340(defun implements (type)
341 (mapcar #'type-from-number (type-interfaces type)))
342
d4b21b08 343(defun type-hierarchy (type)
344 (let ((type-number (find-type-number type t)))
345 (unless (= type-number 0)
346 (cons type-number (type-hierarchy (type-parent type-number))))))
347
348(defbinding (type-is-p "g_type_is_a") (type super) boolean
349 ((find-type-number type) type-number)
350 ((find-type-number super) type-number))
351
352(defbinding %type-children () pointer
353 (type-number type-number)
354 (num-children unsigned-int :out))
355
356(defun map-subtypes (function type &optional prefix)
357 (let ((type-number (find-type-number type t)))
358 (multiple-value-bind (array length) (%type-children type-number)
359 (unwind-protect
d168bafd 360 (map-c-vector
d4b21b08 361 'nil
362 #'(lambda (type-number)
363 (when (or
364 (not prefix)
dfa4f314 365 (string-prefix-p prefix (find-foreign-type-name type-number)))
d4b21b08 366 (funcall function type-number))
367 (map-subtypes function type-number prefix))
368 array 'type-number length)
369 (deallocate-memory array)))))
370
371(defun find-types (prefix)
372 (let ((type-list nil))
e77e7713 373 (maphash
374 #'(lambda (type-number expander)
375 (declare (ignore expander))
376 (map-subtypes
377 #'(lambda (type-number)
378 (pushnew type-number type-list))
379 type-number prefix))
380 *derivable-type-info*)
d4b21b08 381 type-list))
382
62f12808 383(defun find-type-dependencies (type)
384 (let ((list-dependencies (second (find-type-info type))))
385 (when list-dependencies
386 (funcall list-dependencies (find-type-number type t)))))
387
388(defun %sort-types-topologicaly (types)
21299acf 389 (let ((partial-sorted
390 (sort
391 (mapcar
392 #'(lambda (type)
393 (cons type (remove-if #'(lambda (dep)
394 (not (find dep types)))
395 (find-type-dependencies type))))
396 types)
397 #'(lambda (type1 type2) (type-is-p type2 type1)) :key #'car))
62f12808 398 (sorted ()))
399
400 (loop
21299acf 401 as tmp = partial-sorted then (or (rest tmp) partial-sorted)
62f12808 402 while tmp
403 do (destructuring-bind (type . dependencies) (first tmp)
d4b21b08 404 (cond
62f12808 405 ((every #'(lambda (dep)
21299acf 406 (assoc dep sorted))
62f12808 407 dependencies)
21299acf 408 (push (cons type nil) sorted) ; no forward definition needed
409 (setq partial-sorted (delete type partial-sorted :key #'first)))
62f12808 410 ((some #'(lambda (dep)
411 (find type (find-type-dependencies dep)))
412 dependencies)
21299acf 413 (push (cons type t) sorted) ; forward definition needed
414 (setq partial-sorted (delete type partial-sorted :key #'first))))))
415 (nreverse sorted)))
d4b21b08 416
417
418(defun expand-type-definitions (prefix &optional args)
dfa4f314 419 (flet ((type-options (type-number)
420 (let ((name (find-foreign-type-name type-number)))
4de90d10 421 (cdr (assoc name args :test #'string=)))))
d4b21b08 422
e77e7713 423 (let ((type-list
424 (delete-if
425 #'(lambda (type-number)
dfa4f314 426 (let ((name (find-foreign-type-name type-number)))
e77e7713 427 (or
428 (getf (type-options type-number) :ignore)
429 (find-if
430 #'(lambda (options)
431 (and
432 (string-prefix-p (first options) name)
80a09c29 433 (getf (cdr options) :ignore-prefix)
434 (not (some
435 #'(lambda (exception)
436 (string= name exception))
437 (getf (cdr options) :except)))))
e77e7713 438 args))))
439 (find-types prefix))))
21299acf 440
e77e7713 441 (dolist (type-number type-list)
dfa4f314 442 (let ((name (find-foreign-type-name type-number)))
e77e7713 443 (register-type
444 (getf (type-options type-number) :type (default-type-name name))
dfa4f314 445 (find-type-init-function type-number))))
21299acf 446
447 (let ((sorted-type-list (%sort-types-topologicaly type-list)))
62f12808 448 `(progn
449 ,@(mapcar
21299acf 450 #'(lambda (pair)
451 (destructuring-bind (type . forward-p) pair
452 (expand-type-definition type forward-p (type-options type))))
453 sorted-type-list)
62f12808 454 ,@(mapcar
21299acf 455 #'(lambda (pair)
456 (destructuring-bind (type . forward-p) pair
457 (when forward-p
458 (expand-type-definition type nil (type-options type)))))
62f12808 459 sorted-type-list))))))
e77e7713 460
d4b21b08 461(defmacro define-types-by-introspection (prefix &rest args)
4de90d10 462 (expand-type-definitions prefix args))
21299acf 463
464
465;;;; Initialize all non static types in GObject
466
467(init-types-in-library #.(concatenate 'string (pkg-config:pkg-variable "glib-2.0" "libdir") "/libgobject-2.0.so"))