1 ;; Common Lisp bindings for GTK+ v2.0
2 ;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
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.
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.
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
18 ;; $Id: gtype.lisp,v 1.10 2001/05/11 16:04:33 espen Exp $
26 (deftype type-number () '(unsigned 32))
28 (eval-when (:compile-toplevel :load-toplevel :execute)
29 (defclass type-query (struct)
30 ((type-number :allocation :alien :type type-number)
31 (name :allocation :alien :type string)
32 (class-size :allocation :alien :type unsigned-int)
33 (instance-size :allocation :alien :type unsigned-int))
34 (:metaclass proxy-class)))
37 (defbinding %type-query () nil
41 (defun type-query (type)
42 (let ((query (make-instance 'type-query)))
43 (%type-query (find-type-number type t) query)
46 (defun type-instance-size (type)
47 (slot-value (type-query type) 'instance-size))
49 (defun type-class-size (type)
50 (slot-value (type-query type) 'class-size))
52 (defbinding type-class-ref (type) pointer
53 ((find-type-number type t) type-number))
55 (defbinding type-class-unref (type) nil
56 ((find-type-number type t) type-number))
58 (defbinding type-class-peek (type) pointer
59 ((find-type-number type t) type-number))
62 ;;;; Mapping between lisp types and glib types
64 (defvar *type-to-number-hash* (make-hash-table))
65 (defvar *number-to-type-hash* (make-hash-table))
67 (defun register-type (type id)
71 (string (find-type-number id t)))))
72 (setf (gethash type *type-to-number-hash*) type-number)
73 (setf (gethash type-number *number-to-type-hash*) type)
76 (defbinding %type-from-name () type-number
79 (defun find-type-number (type &optional error)
83 (let ((type-number (%type-from-name type)))
85 ((and (zerop type-number) error)
86 (error "Invalid alien type name: ~A" type))
87 ((zerop type-number) nil)
90 (let ((type-number (gethash type *type-to-number-hash*)))
93 (and error (error "Type not registered: ~A" type)))))
94 (pcl::class (find-type-number (class-name type) error))))
96 (defun type-from-number (type-number)
97 (gethash type-number *number-to-type-hash*))
99 (defun type-from-name (name)
101 (string (type-from-number (find-type-number name t)))))
103 (defbinding (find-type-name "g_type_name") (type) string
104 ((find-type-number type t) type-number))
106 (defun type-number-of (object)
107 (find-type-number (type-of object) t))
109 (defun init-type (init)
112 (funcall (mkbinding fname 'type-number)))
115 (defmacro init-types-in-library (pathname)
116 (let ((process (ext:run-program
117 "nm" (list (namestring (truename pathname)))
118 :output :stream :wait nil))
120 (labels ((read-symbols ()
121 (let ((line (read-line (ext:process-output process) nil)))
123 (when (search "_get_type" line)
124 (push (subseq line 11) fnames))
127 (ext:process-close process)
128 `(init-type ',fnames))))
131 ;;;; Superclass for wrapping types in the glib type system
133 (eval-when (:compile-toplevel :load-toplevel :execute)
134 (defclass ginstance (proxy)
135 ((class :allocation :alien :type pointer))
136 (:metaclass proxy-class)))
138 (defun %type-of-ginstance (location)
139 (let ((class (sap-ref-sap location 0)))
140 (type-from-number (sap-ref-unsigned class 0))))
142 (deftype-method translate-from-alien
143 ginstance (type-spec location &optional weak-ref)
144 (declare (ignore type-spec))
145 `(let ((location ,location))
146 (unless (null-pointer-p location)
147 (ensure-proxy-instance
148 (%type-of-ginstance location) location ,weak-ref))))
152 ;;;; Metaclass for subclasses of ginstance
154 (eval-when (:compile-toplevel :load-toplevel :execute)
155 (defclass ginstance-class (proxy-class)))
158 (defmethod shared-initialize ((class ginstance-class) names
159 &rest initargs &key name alien-name
161 (declare (ignore initargs names))
162 (let* ((class-name (or name (class-name class)))
165 (or (first alien-name) (default-alien-type-name class-name)))))
166 (register-type class-name type-number)
167 (let ((size (or size (type-instance-size type-number))))
171 (let ((ref (mkbinding (first ref) 'pointer 'pointer)))
173 (slot-value class 'copy)
174 #'(lambda (type location)
175 (declare (ignore type))
176 (funcall ref location)))))
178 (let ((unref (mkbinding (first unref) 'nil 'pointer)))
180 (slot-value class 'free)
181 #'(lambda (type location)
182 (declare (ignore type))
183 (funcall unref location))))))
186 (defmethod validate-superclass
187 ((class ginstance-class) (super pcl::standard-class))
188 (subtypep (class-name super) 'ginstance))
191 ;;;; Registering fundamental types
193 (register-type 'pointer "gpointer")
194 (register-type 'char "gchar")
195 (register-type 'unsigned-char "guchar")
196 (register-type 'boolean "gboolean")
197 (register-type 'fixnum "gint")
198 (register-type 'int "gint")
199 (register-type 'unsigned-int "guint")
200 (register-type 'long "glong")
201 (register-type 'unsigned-long "gulong")
202 (register-type 'single-float "gfloat")
203 (register-type 'double-float "gdouble")
204 (register-type 'string "GString")
209 (defvar *derivable-type-info* ())
211 (defun register-derivable-type (type id &key query expand)
212 (register-type type id)
213 (let* ((type-number (register-type type id))
214 (info (assoc type-number *derivable-type-info*)))
216 (setf (cdr info) (list query expand))
218 (list type-number query expand)
219 *derivable-type-info*))))
221 (defun type-dependencies (type)
222 (let ((query (second (assoc (car (last (type-hierarchy type)))
223 *derivable-type-info*))))
225 (funcall query (find-type-number type t)))))
227 (defun expand-type-definition (type)
228 (let ((expander (third (assoc (car (last (type-hierarchy type)))
229 *derivable-type-info*))))
230 (funcall expander (find-type-number type t))))
233 (defbinding type-parent (type) type-number
234 ((find-type-number type t) type-number))
236 (defun supertype (type)
237 (type-from-number (type-parent type)))
239 (defun type-hierarchy (type)
240 (let ((type-number (find-type-number type t)))
241 (unless (= type-number 0)
242 (cons type-number (type-hierarchy (type-parent type-number))))))
244 (defbinding (type-is-p "g_type_is_a") (type super) boolean
245 ((find-type-number type) type-number)
246 ((find-type-number super) type-number))
248 (defbinding %type-children () pointer
249 (type-number type-number)
250 (num-children unsigned-int :out))
252 (defun map-subtypes (function type &optional prefix)
253 (let ((type-number (find-type-number type t)))
254 (multiple-value-bind (array length) (%type-children type-number)
258 #'(lambda (type-number)
261 (string-prefix-p prefix (find-type-name type-number)))
262 (funcall function type-number))
263 (map-subtypes function type-number prefix))
264 array 'type-number length)
265 (deallocate-memory array)))))
267 (defun find-types (prefix)
268 (let ((type-list nil))
269 (dolist (type-info *derivable-type-info*)
271 #'(lambda (type-number)
272 (push type-number type-list))
273 (first type-info) prefix))
276 (defun %sort-types-topologicaly (unsorted)
278 (loop while unsorted do
279 (dolist (type unsorted)
280 (let ((dependencies (type-dependencies type)))
284 (setq unsorted (delete type unsorted)))
286 (unless (dolist (dep dependencies)
287 (when (find type (type-dependencies dep))
288 (error "Cyclic type dependencies not yet supported"))
289 (return-if (find dep unsorted)))
291 (setq unsorted (delete type unsorted))))))))
295 (defun expand-type-definitions (prefix &optional args)
296 (flet ((type-options (type-number)
297 (let ((name (find-type-name type-number)))
298 (cdr (assoc name argss :test #'string=)))))
302 #'(lambda (type-number)
303 (getf (type-options type-number) :ignore nil))
304 (find-types prefix))))
306 (dolist (type-number type-list)
307 (let ((name (find-type-name type-number)))
309 (getf (type-options type-number) :type (default-type-name name))
314 #'expand-type-definition
315 (%sort-types-topologicaly type-list))))))
317 (defmacro define-types-by-introspection (prefix &rest args)
318 `(eval-when (:compile-toplevel :load-toplevel :execute)
319 ,(expand-type-definitions prefix args)))