-;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
+;; Common Lisp bindings for GTK+ v2.x
+;; Copyright 2000-2005 Espen S. Johnsen <espen@users.sf.net>
;;
-;; This library is free software; you can redistribute it and/or
-;; modify it under the terms of the GNU Lesser General Public
-;; License as published by the Free Software Foundation; either
-;; version 2 of the License, or (at your option) any later version.
+;; Permission is hereby granted, free of charge, to any person obtaining
+;; a copy of this software and associated documentation files (the
+;; "Software"), to deal in the Software without restriction, including
+;; without limitation the rights to use, copy, modify, merge, publish,
+;; distribute, sublicense, and/or sell copies of the Software, and to
+;; permit persons to whom the Software is furnished to do so, subject to
+;; the following conditions:
;;
-;; 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
-;; Lesser General Public License for more details.
+;; The above copyright notice and this permission notice shall be
+;; included in all copies or substantial portions of the Software.
;;
-;; You should have received a copy of the GNU Lesser 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
+;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-;; $Id: gtype.lisp,v 1.24 2005/02/01 15:24:52 espen Exp $
+;; $Id: gtype.lisp,v 1.48 2006/02/26 16:12:25 espen Exp $
(in-package "GLIB")
(defbinding type-init () nil)
(type-init)
-(deftype type-number () '(unsigned 32))
+(deftype type-number () 'unsigned-long)
(deftype gtype () 'symbol)
-(defmethod alien-type ((type (eql 'gtype)) &rest args)
- (declare (ignore type args))
+(define-type-method alien-type ((type gtype))
+ (declare (ignore type))
(alien-type 'type-number))
-(defmethod size-of ((type (eql 'gtype)) &rest args)
- (declare (ignore type args))
+(define-type-method size-of ((type gtype))
+ (declare (ignore type))
(size-of 'type-number))
-(defmethod to-alien-form (gtype (type (eql 'gtype)) &rest args)
- (declare (ignore type args))
+(define-type-method to-alien-form ((type gtype) gtype)
+ (declare (ignore type))
`(find-type-number ,gtype t))
-(defmethod to-alien-function ((type (eql 'gtype)) &rest args)
- (declare (ignore type args))
+(define-type-method to-alien-function ((type gtype))
+ (declare (ignore type))
#'(lambda (gtype)
(find-type-number gtype t)))
-(defmethod from-alien-form (type-number (type (eql 'gtype)) &rest args)
- (declare (ignore type args))
+(define-type-method from-alien-form ((type gtype) type-number)
+ (declare (ignore type))
`(type-from-number ,type-number))
-(defmethod from-alien-function ((type (eql 'gtype)) &rest args)
- (declare (ignore type args))
+(define-type-method from-alien-function ((type gtype))
+ (declare (ignore type))
#'(lambda (type-number)
(type-from-number type-number)))
-(defmethod writer-function ((type (eql 'gtype)) &rest args)
+(define-type-method writer-function ((type gtype))
(declare (ignore type))
(let ((writer (writer-function 'type-number)))
#'(lambda (gtype location &optional (offset 0))
(funcall writer (find-type-number gtype t) location offset))))
-(defmethod reader-function ((type (eql 'gtype)) &rest args)
+(define-type-method reader-function ((type gtype))
(declare (ignore type))
(let ((reader (reader-function 'type-number)))
- #'(lambda (location &optional (offset 0))
+ #'(lambda (location &optional (offset 0) weak-p)
+ (declare (ignore weak-p))
(type-from-number (funcall reader location offset)))))
;;;; Mapping between lisp types and glib types
-(defvar *type-to-number-hash* (make-hash-table))
-(defvar *number-to-type-hash* (make-hash-table))
-
-(defun register-type (type id)
- (let ((type-number
- (etypecase id
- (integer id)
- (string (find-type-number id t))
- (symbol (gethash id *type-to-number-hash*)))))
- (setf (gethash type *type-to-number-hash*) type-number)
- (unless (symbolp id)
- (setf (gethash type-number *number-to-type-hash*) type))
- type-number))
+(defvar *registered-types* ())
+(defvar *registered-type-aliases* ())
+(defvar *registered-static-types* ())
+(defvar *lisp-type-to-type-number* (make-hash-table))
+(defvar *type-number-to-lisp-type* (make-hash-table))
(defbinding %type-from-name () type-number
(name string))
-(defun find-type-number (type &optional error)
+(defun type-number-from-glib-name (name &optional (error-p t))
+ (let ((type-number (%type-from-name name)))
+ (cond
+ ((not (zerop type-number)) type-number)
+ (error-p (error "Invalid gtype name: ~A" name)))))
+
+(defun register-type (type id)
+ (pushnew (cons type id) *registered-types* :key #'car)
+ (let ((type-number
+ (typecase id
+ (string (type-number-from-glib-name id))
+ (symbol (funcall id)))))
+ (setf (gethash type *lisp-type-to-type-number*) type-number)
+ (setf (gethash type-number *type-number-to-lisp-type*) type)
+ type-number))
+
+(defun register-type-alias (type alias)
+ (pushnew (cons type alias) *registered-type-aliases* :key #'car)
+ (setf
+ (gethash type *lisp-type-to-type-number*)
+ (find-type-number alias t)))
+
+(defun reinitialize-all-types ()
+ (clrhash *lisp-type-to-type-number*)
+ (clrhash *type-number-to-lisp-type*)
+ (type-init) ; initialize the glib type system
+ (mapc #'(lambda (type)
+ (register-type (car type) (cdr type)))
+ *registered-types*)
+ (mapc #'(lambda (type)
+ (register-type-alias (car type) (cdr type)))
+ *registered-type-aliases*))
+
+(pushnew 'reinitialize-all-types
+ #+cmu *after-save-initializations*
+ #+sbcl *init-hooks*)
+
+#+cmu
+(pushnew 'system::reinitialize-global-table ; we shouldn't have to do this?
+ *after-save-initializations*)
+
+
+(defun find-type-number (type &optional error-p)
(etypecase type
(integer type)
- (string
- (let ((type-number (%type-from-name type)))
- (cond
- ((and (zerop type-number) error)
- (error "Invalid gtype name: ~A" type))
- ((zerop type-number) nil)
- (t type-number))))
+ (string (type-number-from-glib-name type error-p))
(symbol
- (let ((type-number (gethash type *type-to-number-hash*)))
- (or
- type-number
- (and error (error "Type not registered: ~A" type)))))
- (pcl::class (find-type-number (class-name type) error))))
+ (or
+ (gethash type *lisp-type-to-type-number*)
+ (and error-p (error "Type not registered: ~A" type))))
+ (class (find-type-number (class-name type) error-p))))
(defun type-from-number (type-number &optional error)
(multiple-value-bind (type found)
- (gethash type-number *number-to-type-hash*)
- (when (and error (not found))
- (let ((name (find-type-name type-number)))
- (if name
- (error "Type number not registered: ~A (~A)" type-number name)
- (error "Invalid type number: ~A" type-number))))
- type))
-
-(defun type-from-name (name)
- (etypecase name
- (string (type-from-number (find-type-number name t)))))
-
-(defbinding (find-type-name "g_type_name") (type) (copy-of string)
+ (gethash type-number *type-number-to-lisp-type*)
+ (if found
+ type
+ (let ((name (find-foreign-type-name type-number)))
+ (cond
+ ((and name (not (= (type-number-from-glib-name name nil) type-number)))
+ ;; This is a hack because GdkEvent seems to be registered
+ ;; multiple times
+ (type-from-number (type-number-from-glib-name name)))
+ ((and error name)
+ (error "Type number not registered: ~A (~A)" type-number name))
+ ((and error)
+ (error "Invalid type number: ~A" type-number)))))))
+
+(defbinding (find-foreign-type-name "g_type_name") (type) (copy-of string)
((find-type-number type t) type-number))
(defun type-number-of (object)
(find-type-number (type-of object) t))
-(defun init-type (init)
- (mapc
- #'(lambda (fname)
- (funcall (mkbinding fname 'type-number)))
- (mklist init)))
-
-(defun %init-types-in-library (pathname prefix ignore)
- (let ((process (ext:run-program
- "nm" (list "-D" (namestring (truename pathname)))
- :output :stream :wait nil))
- (fnames ()))
- (labels ((read-symbols ()
- (let ((line (read-line (ext:process-output process) nil)))
- (when line
- (let ((symbol (subseq line 11)))
- (when (and
- (> (length symbol) (length prefix))
- (string= prefix symbol :end2 (length prefix))
- (search "_get_type" symbol)
- (not (member symbol ignore :test #'string=)))
- (push symbol fnames)))
- (read-symbols)))))
- (read-symbols)
- (ext:process-close process)
- `(init-type ',fnames))))
-
-(defmacro init-types-in-library (filename &key (prefix "") ignore)
- (%init-types-in-library filename prefix ignore))
-
-
-
-;;;; Superclass for wrapping types in the glib type system
-
(eval-when (:compile-toplevel :load-toplevel :execute)
- (defclass ginstance (proxy)
- ((class :allocation :alien :type pointer))
- (:metaclass proxy-class)))
+ (defvar *type-initializers* ())
+ (defun %find-types-in-library (pathname prefixes ignore)
+ (let ((process (run-program
+ "/usr/bin/nm" (list "--defined-only" "-D" (namestring (truename pathname)))
+ :output :stream :wait nil)))
+ (unwind-protect
+ (loop
+ as symbol = (let ((line (read-line (process-output process) nil)))
+ (when line
+ (subseq line (1+ (position #\Space line :from-end t)))))
+ while symbol
+ when (and
+ (> (length symbol) 9)
+ (or
+ (not prefixes)
+ (some #'(lambda (prefix)
+ (and
+ (> (length symbol) (length prefix))
+ (string= prefix symbol :end2 (length prefix))))
+ (mklist prefixes)))
+ (string= "_get_type" symbol :start2 (- (length symbol) 9))
+ (not (member symbol ignore :test #'string=)))
+ collect symbol)
+ (process-close process)))))
+
+
+(defmacro init-types-in-library (filename &key prefix ignore)
+ (let ((names (%find-types-in-library filename prefix ignore)))
+ `(progn
+ ,@(mapcar #'(lambda (name)
+ `(progn
+ (defbinding (,(intern name) ,name) () type-number)
+ (,(intern name))
+ (pushnew ',(intern name) *type-initializers*)))
+ names))))
+
+(defun find-type-init-function (type-number)
+ (loop
+ for type-init in *type-initializers*
+ when (= type-number (funcall type-init))
+ do (return type-init)))
+
+(defun register-type-as (type-number)
+ (or
+ (find-type-init-function type-number)
+ (find-foreign-type-name type-number)
+ (error "Unknown type-number: ~A" type-number)))
+
+(defun default-type-init-name (type)
+ (find-symbol (format nil "~A_~A_get_type"
+ (package-prefix *package*)
+ (substitute #\_ #\- (string-downcase type)))))
-(defun %type-of-ginstance (location)
- (let ((class (sap-ref-sap location 0)))
- (type-from-number (sap-ref-32 class 0))))
-(defmethod ensure-proxy-instance ((class ginstance-class) location)
- (declare (ignore class))
- (let ((class (find-class (%type-of-ginstance location))))
- (if class
- (make-instance class :location (reference-foreign class location))
- ;; TODO: (make-instance 'ginstance ...)
- location)))
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (defclass type-info (struct)
+ ((class-size :allocation :alien :type (unsigned 16) :initarg :class-size)
+ (base-init :allocation :alien :type pointer)
+ (base-finalize :allocation :alien :type pointer)
+ (class-init :allocation :alien :type pointer)
+ (class-finalize :allocation :alien :type pointer)
+ (class-data :allocation :alien :type pointer)
+ (instance-size :allocation :alien :type (unsigned 16)
+ :initarg :instance-size)
+ (n-preallocs :allocation :alien :type (unsigned 16))
+ (instance-init :allocation :alien :type pointer)
+ (value-table :allocation :alien :type pointer))
+ (:metaclass struct-class)))
-(defmethod copy-from-alien-form (location (class ginstance-class) &rest args)
- (declare (ignore location class args))
- (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."))
+(defbinding %type-register-static () type-number
+ (parent-type type-number)
+ (name string)
+ (info type-info)
+ (0 unsigned-int))
-(defmethod copy-from-alien-function ((class ginstance-class) &rest args)
- (declare (ignore class args))
- (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."))
+(defun register-new-type (type parent &optional foreign-name)
+ (let ((parent-info (type-query parent)))
+ (with-slots ((parent-number type-number) class-size instance-size) parent-info
+ (let ((type-number
+ (%type-register-static
+ parent-number
+ (or foreign-name (default-alien-type-name type))
+ (make-instance 'type-info :class-size class-size :instance-size instance-size))))
+ (pushnew (list type parent foreign-name) *registered-static-types* :key #'car)
+ (setf (gethash type *lisp-type-to-type-number*) type-number)
+ (setf (gethash type-number *type-number-to-lisp-type*) type)
+ type-number))))
-(defmethod reader-function ((class ginstance-class) &rest args)
- (declare (ignore args))
- #'(lambda (location &optional (offset 0))
- (ensure-proxy-instance class (sap-ref-sap location offset))))
;;;; Metaclass for subclasses of ginstance
(eval-when (:compile-toplevel :load-toplevel :execute)
(defclass ginstance-class (proxy-class)
- ()))
+ ((gtype :initarg :gtype :initform nil :reader ginstance-class-gtype))))
+
+
+(defun update-size (class)
+ (let ((type-number (find-type-number class)))
+ (cond
+ ((not (slot-boundp class 'size))
+ (setf (slot-value class 'size) (type-instance-size type-number)))
+ ((and
+ (slot-boundp class 'size)
+ (not (= (type-instance-size type-number) (slot-value class 'size))))
+ (warn "Size mismatch for class ~A" class)))))
+
+
+(defmethod finalize-inheritance ((class ginstance-class))
+ (call-next-method)
+ (let* ((class-name (class-name class))
+ (super (most-specific-proxy-superclass class))
+ (gtype (or
+ (first (ginstance-class-gtype class))
+ (default-alien-type-name class-name)))
+ (type-number
+ (or
+ (find-type-number class-name)
+ (let ((type-number
+ (if (or
+ (symbolp gtype)
+ (type-number-from-glib-name gtype nil))
+ (register-type class-name gtype)
+ (register-new-type class-name (class-name super) gtype))))
+ (type-class-ref type-number)
+ type-number))))
+ (when (and
+ (supertype type-number)
+ (not (eq (class-name super) (supertype type-number))))
+ (warn "Super class mismatch between CLOS and GObject for ~A"
+ class-name)))
+
+ (update-size class))
-(defmethod shared-initialize ((class ginstance-class) names
- &rest initargs &key name alien-name)
- (declare (ignore names))
- (let* ((class-name (or name (class-name class)))
- (type-number
- (find-type-number
- (or (first alien-name) (default-alien-type-name class-name)) t)))
- (register-type class-name type-number)
- (if (getf initargs :size)
- (call-next-method)
- (let ((size (type-instance-size type-number)))
- (apply #'call-next-method class names :size (list size) initargs)))))
+(defmethod shared-initialize ((class ginstance-class) names &rest initargs)
+ (declare (ignore initargs))
+ (call-next-method)
+ (when (class-finalized-p class)
+ (update-size class)))
(defmethod validate-superclass ((class ginstance-class) (super standard-class))
(subtypep (class-name super) 'ginstance))
+;;;; Superclass for wrapping types in the glib type system
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (defclass ginstance (proxy)
+ (;(class :allocation :alien :type pointer :offset 0)
+ )
+ (:metaclass proxy-class)
+ (:size #.(size-of 'pointer))))
+
+(defun %type-number-of-ginstance (location)
+ (let ((class (sap-ref-sap location 0)))
+ (sap-ref-32 class 0)))
+
+(defmethod make-proxy-instance :around ((class ginstance-class) location &rest initargs)
+ (declare (ignore class))
+ (let ((class (labels ((find-known-class (type-number)
+ (or
+ (find-class (type-from-number type-number) nil)
+ (unless (zerop type-number)
+ (find-known-class (type-parent type-number))))))
+ (find-known-class (%type-number-of-ginstance location)))))
+ ;; Note that chancing the class argument must not alter "the
+ ;; ordered set of applicable methods" as specified in the
+ ;; Hyperspec
+ (if class
+ (apply #'call-next-method class location initargs)
+ (error "Object at ~A has an unkown type number: ~A"
+ location (%type-number-of-ginstance location)))))
+
+(defmethod make-proxy-instance ((class ginstance-class) location &rest initargs)
+ (declare (ignore initargs))
+ (reference-foreign class location)
+ ;; Since we make an explicit reference to the foreign object, we
+ ;; always have to release it when the proxy is garbage collected
+ ;; and therefor ignore the weak-p argument.
+ (call-next-method class location :weak nil))
+
+(defmethod invalidate-instance ((instance ginstance))
+ (declare (ignore instance))
+ ;; A ginstance should never be invalidated since it is ref counted
+ nil)
+
+(define-type-method copy-from-alien-form ((type ginstance) location)
+ (declare (ignore location type))
+ (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."))
+
+(define-type-method copy-from-alien-function ((type ginstance))
+ (declare (ignore type))
+ (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."))
+
+(define-type-method reader-function ((type ginstance))
+ #'(lambda (location &optional (offset 0) weak-p)
+ (declare (ignore weak-p))
+ (ensure-proxy-instance type (sap-ref-sap location offset))))
+
+
;;;; Registering fundamental types
(register-type 'nil "void")
(register-type 'char "gchar")
(register-type 'unsigned-char "guchar")
(register-type 'boolean "gboolean")
-(register-type 'fixnum "gint")
(register-type 'int "gint")
+(register-type-alias 'integer 'int)
+(register-type-alias 'fixnum 'int)
(register-type 'unsigned-int "guint")
(register-type 'long "glong")
(register-type 'unsigned-long "gulong")
#'(lambda (type-number)
(when (or
(not prefix)
- (string-prefix-p prefix (find-type-name type-number)))
+ (string-prefix-p prefix (find-foreign-type-name type-number)))
(funcall function type-number))
(map-subtypes function type-number prefix))
array 'type-number length)
(funcall list-dependencies (find-type-number type t)))))
(defun %sort-types-topologicaly (types)
- (let ((unsorted (mapcar
- #'(lambda (type)
- (cons type (remove-if #'(lambda (dep)
- (not (find dep types)))
- (find-type-dependencies type))))
- types))
- (forward-define ())
+ (let ((partial-sorted
+ (sort
+ (mapcar
+ #'(lambda (type)
+ (cons type (remove-if #'(lambda (dep)
+ (not (find dep types)))
+ (find-type-dependencies type))))
+ types)
+ #'(lambda (type1 type2) (type-is-p type2 type1)) :key #'car))
(sorted ()))
(loop
- as tmp = unsorted then (or (rest tmp) unsorted)
+ as tmp = partial-sorted then (or (rest tmp) partial-sorted)
while tmp
do (destructuring-bind (type . dependencies) (first tmp)
(cond
((every #'(lambda (dep)
- (or (find dep forward-define) (find dep sorted)))
+ (assoc dep sorted))
dependencies)
- (push type sorted)
- (setq unsorted (delete type unsorted :key #'first)))
+ (push (cons type nil) sorted) ; no forward definition needed
+ (setq partial-sorted (delete type partial-sorted :key #'first)))
((some #'(lambda (dep)
(find type (find-type-dependencies dep)))
dependencies)
- (push type forward-define)))))
-
- (values (nreverse sorted) forward-define)))
+ (push (cons type t) sorted) ; forward definition needed
+ (setq partial-sorted (delete type partial-sorted :key #'first))))))
+ (nreverse sorted)))
(defun expand-type-definitions (prefix &optional args)
- (flet ((type-options (type-number)
- (let ((name (find-type-name type-number)))
+ (flet ((type-options (type-number)
+ (let ((name (find-foreign-type-name type-number)))
(cdr (assoc name args :test #'string=)))))
(let ((type-list
(delete-if
#'(lambda (type-number)
- (let ((name (find-type-name type-number)))
+ (let ((name (find-foreign-type-name type-number)))
(or
(getf (type-options type-number) :ignore)
(find-if
(getf (cdr options) :except)))))
args))))
(find-types prefix))))
-
+
(dolist (type-number type-list)
- (let ((name (find-type-name type-number)))
+ (let ((name (find-foreign-type-name type-number)))
(register-type
(getf (type-options type-number) :type (default-type-name name))
- type-number)))
-
- (multiple-value-bind (sorted-type-list forward-define)
- (%sort-types-topologicaly type-list)
+ (register-type-as type-number))))
+
+ (let ((sorted-type-list (%sort-types-topologicaly type-list)))
`(progn
,@(mapcar
- #'(lambda (type)
- (expand-type-definition type t (type-options type)))
- forward-define)
+ #'(lambda (pair)
+ (destructuring-bind (type . forward-p) pair
+ (expand-type-definition type forward-p (type-options type))))
+ sorted-type-list)
,@(mapcar
- #'(lambda (type)
- (expand-type-definition type nil (type-options type)))
+ #'(lambda (pair)
+ (destructuring-bind (type . forward-p) pair
+ (when forward-p
+ (expand-type-definition type nil (type-options type)))))
sorted-type-list))))))
(defmacro define-types-by-introspection (prefix &rest args)
(expand-type-definitions prefix args))
+
+
+;;;; Initialize all non static types in GObject
+
+(init-types-in-library #.(concatenate 'string (pkg-config:pkg-variable "glib-2.0" "libdir") "/libgobject-2.0.so"))