X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/clg/blobdiff_plain/4e94e04b3254f38fa8ce7b43261058cd3b671025..a666b391b604d3afe86079e064e648d9062430ef:/glib/glib.lisp diff --git a/glib/glib.lisp b/glib/glib.lisp index 891196a..43eb8bc 100644 --- a/glib/glib.lisp +++ b/glib/glib.lisp @@ -1,195 +1,490 @@ -;; Common Lisp bindings for GTK+ v1.2.x -;; Copyright (C) 1999 Espen S. Johnsen +;; Common Lisp bindings for GTK+ 2.x +;; Copyright 1999-2005 Espen S. Johnsen ;; -;; 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: glib.lisp,v 1.2 2000-08-15 23:25:18 espen Exp $ +;; $Id: glib.lisp,v 1.44 2008-10-08 18:11:12 espen Exp $ (in-package "GLIB") + (use-prefix "g") +#-sb-thread +(progn + (defun make-mutex () + nil) + + (defmacro with-mutex ((mutex) &body body) + (declare (ignore mutex)) + `(progn ,@body))) + ;;;; Memory management -(define-foreign ("g_malloc0" allocate-memory) () pointer - (size unsigned-long)) +(deftype gsize () 'unsigned-int) -(define-foreign ("g_realloc" reallocate-memory) () pointer - (address pointer) - (size unsigned-long)) +(defbinding malloc0 () pointer + (size gsize)) -(define-foreign ("g_free" deallocate-memory) () nil +(defbinding free () nil (address pointer)) -(defun copy-memory (from length &optional (to (allocate-memory length))) - (kernel:system-area-copy from 0 to 0 (* 8 length)) - to) - - - -;;;; Linked list - -(deftype glist () 'pointer) -(deftype double-list (type) `(or (null (cons ,type list)))) - - -(define-foreign ("g_list_append" %glist-append) () glist - (glist glist) - (data unsigned)) - -(defmacro glist-append (glist value type-spec) - (ecase (first (mklist (translate-type-spec type-spec))) - (unsigned `(%glist-append ,glist ,value)) -; (signed `(%glist-append ,glist (signed-to-unsigned ,value))) - (system-area-pointer `(%glist-append ,glist (system:sap-int ,value))))) - - -(defmacro glist-data (glist type-spec) - (ecase (first (mklist (translate-type-spec type-spec))) - (unsigned `(sap-ref-unsigned ,glist 0)) - (signed `(sap-ref-signed ,glist 0)) - (system-area-pointer `(sap-ref-sap ,glist 0)))) +(setf *memory-allocator* #'malloc0) +(setf *memory-deallocator* #'free) +(defbinding (reallocate-memory "g_realloc") () pointer + (address pointer) + (size gsize)) + +(defbinding (slice-alloc "g_slice_alloc0") () pointer + (block-size gsize)) + +;;;; User data is a mechanism to store references to lisp objects in +;;;; foreign code + +(defvar *user-data-lock* (make-mutex)) +(defvar *user-data* (make-hash-table)) +(defvar *user-data-next-id* 1) + +(defun register-user-data (object &optional destroy-function) + (check-type destroy-function (or null symbol function)) + (with-mutex (*user-data-lock*) + (setf + (gethash *user-data-next-id* *user-data*) + (cons object destroy-function)) + (1- (incf *user-data-next-id*)))) + +(defun find-user-data (id) + (check-type id fixnum) + (with-mutex (*user-data-lock*) + (multiple-value-bind (user-data p) (gethash id *user-data*) + (values (car user-data) p)))) + +(defun user-data-exists-p (id) + (nth-value 1 (find-user-data id))) + +(defun update-user-data (id object) + (check-type id fixnum) + (with-mutex (*user-data-lock*) + (multiple-value-bind (user-data exists-p) (gethash id *user-data*) + (cond + ((not exists-p) (error "User data id ~A does not exist" id)) + (t + (when (cdr user-data) + (funcall (cdr user-data) (car user-data))) + (setf (car user-data) object)))))) + +(defun destroy-user-data (id) + (check-type id fixnum) + (with-mutex (*user-data-lock*) + (multiple-value-bind (user-data exists-p) (gethash id *user-data*) + (cond +; ((not exists-p) (error "User data id ~A does not exist" id)) + (t + (when (cdr user-data) + (funcall (cdr user-data) (car user-data))) + (remhash id *user-data*)))))) + +(defun take-user-data (id) + (check-type id fixnum) + (multiple-value-bind (user-data exists-p) (gethash id *user-data*) + (cond + ((not exists-p) (error "User data id ~A does not exist" id)) + (t + (when (cdr user-data) + (funcall (cdr user-data) (car user-data))) + (remhash id *user-data*) + (car user-data))))) + +(defmacro with-user-data ((var object) &body body) + `(let ((,var (register-user-data ,object))) + (unwind-protect + ,@body + (destroy-user-data ,var)))) + + +(deftype user-data-id () 'pointer-data) + + +;;;; Quarks + +(deftype quark () 'unsigned) + +(defbinding %quark-from-string () quark + (string string)) + +(defun quark-intern (object) + (etypecase object + (quark object) + (string (%quark-from-string object)) + (symbol (%quark-from-string (format nil "clg-~A:~A" + (package-name (symbol-package object)) + object))))) + +(defbinding quark-to-string () (static string) + (quark quark)) + + +;;;; Linked list (GList) + +(deftype glist (type) + `(or null (cons ,type list))) + +(defbinding (%glist-prepend "g_list_prepend") () pointer + (glist (or null pointer)) + (nil null)) + +(defbinding (%glist-reverse "g_list_reverse") () pointer + (glist (or null pointer))) + +(defun make-glist (element-type list &optional temp-p) + (let ((writer (if (functionp element-type) + element-type + (writer-function element-type :temp temp-p)))) + (loop + for element in list + as glist = (%glist-prepend nil) then (%glist-prepend glist) + do (funcall writer element glist) + finally (return (%glist-reverse glist))))) (defun glist-next (glist) (unless (null-pointer-p glist) - (sap-ref-sap glist +size-of-sap+))) - + (ref-pointer glist #.(size-of 'pointer)))) -(define-foreign ("g_list_free" glist-free) () nil +;; Also used for gslists +(defun map-glist (seqtype function glist element-type &optional (ref :read)) + (let ((reader (if (functionp element-type) + element-type + (reader-function element-type :ref ref)))) + (case seqtype + ((nil) + (loop + as element = glist then (glist-next element) + until (null-pointer-p element) + do (funcall function (funcall reader element)))) + (list + (loop + as element = glist then (glist-next element) + until (null-pointer-p element) + collect (funcall function (funcall reader element)))) + (t + (coerce + (loop + as element = glist then (glist-next element) + until (null-pointer-p element) + collect (funcall function (funcall reader element))) + seqtype))))) + +(defbinding (glist-free "g_list_free") () nil (glist pointer)) - -(deftype-method translate-type-spec double-list (type-spec) - (declare (ignore type-spec)) - 'system-area-pointer) - -(deftype-method translate-to-alien double-list (type-spec list &optional copy) - (declare (ignore copy)) - (let* ((element-type-spec (second (type-expand-to 'double-list type-spec))) - (to-alien (translate-to-alien element-type-spec 'element t))) - `(let ((glist (make-pointer 0))) - (dolist (element ,list glist) - (setq glist (glist-append glist ,to-alien ,element-type-spec)))))) - -(deftype-method - translate-from-alien - double-list (type-spec glist &optional (alloc :dynamic)) - (let ((element-type-spec (second (type-expand-to 'double-list type-spec)))) - `(let ((glist ,glist) - (list nil)) - (do ((tmp glist (glist-next tmp))) - ((null-pointer-p tmp)) - (push - ,(translate-from-alien - element-type-spec `(glist-data tmp ,element-type-spec) alloc) - list)) - ,(when (eq alloc :dynamic) - '(glist-free glist)) - (nreverse list)))) - -(deftype-method cleanup-alien double-list (type-spec glist &optional copied) - (declare (ignore copied)) - (let* ((element-type-spec (second (type-expand-to 'double-list type-spec))) - (alien-type-spec (translate-type-spec element-type-spec))) - `(let ((glist ,glist)) - (unless (null-pointer-p glist) - ,(when (eq alien-type-spec 'system-area-pointer) - `(do ((tmp glist (glist-next tmp))) - ((null-pointer-p tmp)) - ,(cleanup-alien - element-type-spec `(glist-data tmp ,element-type-spec) t))) - (glist-free glist))))) - - - -;;; Array -#| -(define-foreign ("g_array_new" %array-new) () garray - (zero-terminated boolean) - (clear boolean) - (element-size unsigned-int)) - -(defun array-new (&key zero-terminated clear (element-size 4) initial-contents) - (let ((array (%array-new zero-terminated clear element-size))) - (when initial-contents - (dolist (element initial-contents) - (array-append array element))) - array)) - -(define-foreign ("g_array_free" %array-free) () none - (array garray) - (free-segment boolean)) - -(defun array-free (array &optional free-data (free-segment t)) - (when free-data - (dotimes (i (array-get-size array)) - (free (array-get-pointer array i)))) - (%array-free array free-segment)) - -(defmacro with-array (binding &body body) - (let ((array (gensym))) - (destructuring-bind (var &rest args - &key (free-contents nil) (free-segment t) - &allow-other-keys ) - binding - (remf args :free-contents) - (remf args :free-segment) - `(let* ((,array (array-new ,@args)) - (,var (array-get-data ,array))) - (unwind-protect - ,@body - (array-free ,array ,free-contents ,free-segment)))))) - -;; cl-gtk.c -(define-foreign ("g_array_insert_int" array-insert-int) () garray - (array garray) - (index unsigned-int) - (value int)) - -(defun array-insert-value (array index value) - (etypecase value - (null (array-insert-int array index 0)) - (integer (array-insert-int array index value)) - (string (array-insert-int array index (sap-int (gforeign::pointer-to-sap (%strdup value))))) - (pointer (array-insert-int array index (sap-int (gforeign::pointer-to-sap value)))))) - -(defun array-prepend (array value) - (array-insert-value array 0 value)) - -(defun array-append (array value) - (array-insert-value array (array-get-size array) value)) - -;; cl-gtk.c -(define-foreign ("g_array_get_int" array-get-int) () int - (array garray) - (index unsigned-int)) - -(defun array-get-pointer (array index) - (gforeign::sap-to-pointer (int-sap (array-get-int array index)))) - -;; cl-gtk.c -(define-foreign ("g_array_get_data" array-get-data) () pointer - (array garray)) - -(define-foreign ("g_array_set_size" array-set-size) () garray - (array garray) - (size unsigned-int)) - -;; cl-gtk.c -(define-foreign ("g_array_get_size" array-get-size) () int - (array garray)) -|# \ No newline at end of file +(defun destroy-glist (glist element-type &optional temp-p) + (let ((destroy (if (functionp element-type) + element-type + (destroy-function element-type :temp temp-p)))) + (loop + as element = glist then (glist-next element) + until (null-pointer-p element) + do (funcall destroy element))) + (glist-free glist)) + +(define-type-method alien-type ((type glist)) + (declare (ignore type)) + (alien-type 'pointer)) + +(define-type-method argument-type ((type glist)) + 'list) + +(define-type-method return-type ((type glist)) + 'list) + +(define-type-method size-of ((type glist) &key inlined) + (assert-not-inlined type inlined) + (size-of 'pointer)) + +(define-type-method type-alignment ((type glist) &key inlined) + (assert-not-inlined type inlined) + (type-alignment 'pointer)) + +(define-type-method alien-arg-wrapper ((type glist) var list style form &optional copy-in-p) + (destructuring-bind (element-type) (rest (type-expand-to 'glist type)) + (cond + ((and (in-arg-p style) (not (out-arg-p style))) + `(with-pointer (,var (make-glist ',element-type ,list ,(not copy-in-p))) + (unwind-protect + ,form + ,(unless copy-in-p + `(destroy-glist ,var ',element-type t))))) + ((and (in-arg-p style) (out-arg-p style)) + (let ((glist (make-symbol "GLIST"))) + `(with-pointer (,glist (make-glist ',element-type ,list ,(not copy-in-p))) + (with-pointer (,var ,glist) + (unwind-protect + ,form + ,(unless copy-in-p + `(destroy-glist ,glist ',element-type t))))))) + ((and (out-arg-p style) (not (in-arg-p style))) + `(with-pointer (,var) + ,form))))) + +(define-type-method to-alien-form ((type glist) list &optional copy-p) + (declare (ignore copy-p)) + (destructuring-bind (element-type) (rest (type-expand-to 'glist type)) + `(make-glist ',element-type ,list))) + +(define-type-method to-alien-function ((type glist) &optional copy-p) + (destructuring-bind (element-type) (rest (type-expand-to 'glist type)) + (values + #'(lambda (list) + (make-glist element-type list (not copy-p))) + (unless copy-p + #'(lambda (list glist) + (declare (ignore list)) + (destroy-glist glist element-type t)))))) + +(define-type-method from-alien-form ((type glist) form &key (ref :free)) + (destructuring-bind (element-type) (rest (type-expand-to 'glist type)) + `(let ((glist ,form)) + (unwind-protect + (map-glist 'list #'identity glist ',element-type + ,(ecase ref (:free :get) ((:static :temp) :peek) (:copy :read))) + ,(when (eq ref :free) + `(destroy-glist glist ',element-type)))))) + +(define-type-method from-alien-function ((type glist) &key (ref :free)) + (destructuring-bind (element-type) (rest (type-expand-to 'glist type)) + (ecase ref + (:free + #'(lambda (glist) + (prog1 + (map-glist 'list #'identity glist element-type :get) + (glist-free glist)))) + (:copy + #'(lambda (glist) + (map-glist 'list #'identity glist element-type :read))) + ((:static :temp) + #'(lambda (glist) + (map-glist 'list #'identity glist element-type :peek)))))) + +(define-type-method writer-function ((type glist) &key temp inlined) + (assert-not-inlined type inlined) + (let ((element-type (second (type-expand-to 'glist type)))) + #'(lambda (list location &optional (offset 0)) + (setf + (ref-pointer location offset) + (make-glist element-type list temp))))) + +(define-type-method reader-function ((type glist) &key (ref :read) inlined) + (assert-not-inlined type inlined) + (let ((element-type (second (type-expand-to 'glist type)))) + (ecase ref + ((:read :peek) + #'(lambda (location &optional (offset 0)) + (unless (null-pointer-p (ref-pointer location offset)) + (map-glist 'list #'identity (ref-pointer location offset) element-type ref)))) + (:get + #'(lambda (location &optional (offset 0)) + (unless (null-pointer-p (ref-pointer location offset)) + (prog1 + (map-glist 'list #'identity (ref-pointer location offset) element-type :get) + (glist-free (ref-pointer location offset)) + (setf (ref-pointer location offset) (make-pointer 0))))))))) + +(define-type-method destroy-function ((type glist) &key temp inlined) + (assert-not-inlined type inlined) + (let ((element-type (second (type-expand-to 'glist type)))) + #'(lambda (location &optional (offset 0)) + (unless (null-pointer-p (ref-pointer location offset)) + (destroy-glist (ref-pointer location offset) element-type temp) + (setf (ref-pointer location offset) (make-pointer 0)))))) + +(define-type-method copy-function ((type glist) &key inlined) + (assert-not-inlined type inlined) + (destructuring-bind (element-type) (rest (type-expand-to 'glist type)) + (let ((copy-element (copy-function element-type))) + #'(lambda (from to &optional (offset 0)) + (unless (null-pointer-p (ref-pointer from offset)) + (loop + as from-list = (ref-pointer from offset) then (glist-next from-list) + as to-list = (%glist-prepend nil) then (%glist-prepend to-list) + do (funcall copy-element from-list to-list) + while (glist-next from-list) + finally (setf (ref-pointer to offset) (%glist-reverse to-list)))))))) + + +;;;; Single linked list (GSList) + +(deftype gslist (type) `(or null (cons ,type list))) + +(defbinding (%gslist-prepend "g_slist_prepend") () pointer + (gslist pointer) + (nil null)) + +(defbinding (%gslist-append "g_slist_append") () pointer + (glist (or null pointer)) + (nil null)) + + +(defun make-gslist (element-type list &optional temp-p) + (let ((writer (if (functionp element-type) + element-type + (writer-function element-type :temp temp-p)))) + (loop + for element in (reverse list) + as gslist = (%gslist-prepend (make-pointer 0)) then (%gslist-prepend gslist) + do (funcall writer element gslist) + finally (return gslist)))) + +(defbinding (gslist-free "g_slist_free") () nil + (gslist pointer)) + +(defun destroy-gslist (gslist element-type &optional temp-p) + (loop + with destroy = (destroy-function element-type :temp temp-p) + as element = gslist then (glist-next element) + until (null-pointer-p element) + do (funcall destroy element 0)) + (gslist-free gslist)) + +(define-type-method alien-type ((type gslist)) + (declare (ignore type)) + (alien-type 'pointer)) + +(define-type-method argument-type ((type gslist)) + 'list) + +(define-type-method return-type ((type gslist)) + 'list) + +(define-type-method size-of ((type gslist) &key inlined) + (assert-not-inlined type inlined) + (size-of 'pointer)) + +(define-type-method type-alignment ((type gslist) &key inlined) + (assert-not-inlined type inlined) + (type-alignment 'pointer)) + +(define-type-method alien-arg-wrapper ((type gslist) var list style form &optional copy-in-p) + (destructuring-bind (element-type) (rest (type-expand-to 'gslist type)) + (cond + ((and (in-arg-p style) (not (out-arg-p style))) + `(with-pointer (,var (make-gslist ',element-type ,list ,(not copy-in-p))) + (unwind-protect + ,form + ,(unless copy-in-p + `(destroy-gslist ,var ',element-type t))))) + ((and (in-arg-p style) (out-arg-p style)) + (let ((gslist (make-symbol "GSLIST"))) + `(with-pointer (,gslist (make-gslist ',element-type ,list ,(not copy-in-p))) + (with-pointer (,var ,gslist) + (unwind-protect + ,form + ,(unless copy-in-p + `(destroy-gslist ,gslist ',element-type t))))))) + ((and (out-arg-p style) (not (in-arg-p style))) + `(with-pointer (,var) + ,form))))) + +(define-type-method to-alien-form ((type gslist) list &optional copy-p) + (declare (ignore copy-p)) + (destructuring-bind (element-type) (rest (type-expand-to 'gslist type)) + `(make-gslist ',element-type ,list))) + +(define-type-method to-alien-function ((type gslist) &optional copy-p) + (destructuring-bind (element-type) (rest (type-expand-to 'gslist type)) + (values + #'(lambda (list) + (make-gslist element-type list (not copy-p))) + (unless copy-p + #'(lambda (list gslist) + (declare (ignore list)) + (destroy-gslist gslist element-type t)))))) + +(define-type-method from-alien-form ((type gslist) form &key (ref :free)) + (destructuring-bind (element-type) (rest (type-expand-to 'gslist type)) + `(let ((gslist ,form)) + (unwind-protect + (map-glist 'list #'identity gslist ',element-type + ,(ecase ref (:free :get) ((:static :temp) :peek) (:copy :read))) + ,(when (eq ref :free) + `(destroy-gslist gslist ',element-type)))))) + +(define-type-method from-alien-function ((type gslist) &key (ref :free)) + (destructuring-bind (element-type) (rest (type-expand-to 'gslist type)) + (ecase ref + (:free + #'(lambda (glist) + (prog1 + (map-glist 'list #'identity glist element-type :get) + (gslist-free glist)))) + (:copy + #'(lambda (glist) + (map-glist 'list #'identity glist element-type :read))) + ((:static :temp) + #'(lambda (glist) + (map-glist 'list #'identity glist element-type :peek)))))) + +(define-type-method writer-function ((type gslist) &key temp inlined) + (assert-not-inlined type inlined) + (destructuring-bind (element-type) (rest (type-expand-to 'gslist type)) + (let ((element-writer (writer-function element-type :temp temp))) + #'(lambda (list location &optional (offset 0)) + (setf + (ref-pointer location offset) + (make-gslist element-writer list)))))) + +(define-type-method reader-function ((type gslist) &key (ref :read) inlined) + (assert-not-inlined type inlined) + (let ((element-type (second (type-expand-to 'gslist type)))) + (ecase ref + ((:read :peek) + #'(lambda (location &optional (offset 0)) + (unless (null-pointer-p (ref-pointer location offset)) + (map-glist 'list #'identity (ref-pointer location offset) element-type ref)))) + (:get + #'(lambda (location &optional (offset 0)) + (unless (null-pointer-p (ref-pointer location offset)) + (prog1 + (map-glist 'list #'identity (ref-pointer location offset) element-type :get) + (gslist-free (ref-pointer location offset)) + (setf (ref-pointer location offset) (make-pointer 0))))))))) + +(define-type-method destroy-function ((type gslist) &key temp inlined) + (assert-not-inlined type inlined) + (let ((element-type (second (type-expand-to 'gslist type)))) + #'(lambda (location &optional (offset 0)) + (unless (null-pointer-p (ref-pointer location offset)) + (destroy-gslist (ref-pointer location offset) element-type temp) + (setf (ref-pointer location offset) (make-pointer 0)))))) + +(define-type-method copy-function ((type gslist) &key inlined) + (assert-not-inlined type inlined) + (destructuring-bind (element-type) (rest (type-expand-to 'gslist type)) + (let ((copy-element (copy-function element-type))) + #'(lambda (from to &optional (offset 0)) + (unless (null-pointer-p (ref-pointer from offset)) + (loop + as from-list = (ref-pointer from offset) + then (glist-next from-list) + as to-list = (setf (ref-pointer to offset) (%gslist-append nil)) + then (%gslist-append to-list) + do (funcall copy-element from-list to-list) + while (glist-next from-list)))))))