-;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 2000 Espen S. Johnsen <esj@stud.cs.uit.no>
+;; Common Lisp bindings for GTK+ v2.x
+;; Copyright 2000 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: gcallback.lisp,v 1.11 2004-11-01 00:08:49 espen Exp $
+;; $Id: gcallback.lisp,v 1.35 2006-06-07 13:16:11 espen Exp $
(in-package "GLIB")
(use-prefix "g")
-;;;; Callback mechanism
+;;;; Callback invokation
(deftype gclosure () 'pointer)
-
-(defbinding (callback-closure-new "clg_callback_closure_new") () gclosure
- (callback-id unsigned-int)
- (callback pointer)
- (destroy-notify pointer))
+(register-type 'gclosure '|g_closure_get_type|)
(defun register-callback-function (function)
(check-type function (or null symbol function))
(register-user-data function))
-(def-callback closure-callback-marshal
- (void (gclosure system-area-pointer) (return-value system-area-pointer)
- (n-params unsigned-int) (param-values system-area-pointer)
- (invocation-hint system-area-pointer) (callback-id unsigned-int))
+;; Callback marshal for regular signal handlers
+(define-callback closure-marshal nil
+ ((gclosure gclosure) (return-value gvalue) (n-params unsigned-int)
+ (param-values pointer) (invocation-hint pointer)
+ (callback-id unsigned-int))
+ (declare (ignore gclosure invocation-hint))
(callback-trampoline callback-id n-params param-values return-value))
-(def-callback %destroy-user-data (void (id unsigned-int))
- (destroy-user-data id))
-
-(defun make-callback-closure (function)
- (callback-closure-new
- (register-callback-function function)
- (callback closure-callback-marshal) (callback %destroy-user-data)))
+;; Callback function for emission hooks
+(define-callback signal-emission-hook nil
+ ((invocation-hint pointer) (n-params unsigned-int) (param-values pointer)
+ (callback-id unsigned-int))
+ (declare (ignore invocation-hint))
+ (callback-trampoline callback-id n-params param-values))
-
-(defun callback-trampoline (callback-id n-params param-values return-value)
+(defun callback-trampoline (callback-id n-params param-values &optional
+ (return-value (make-pointer 0)))
(let* ((return-type (unless (null-pointer-p return-value)
(gvalue-type return-value)))
(args (loop
for n from 0 below n-params
- collect (gvalue-get (sap+ param-values (* n +gvalue-size+))))))
- (let ((result (apply #'invoke-callback callback-id return-type args)))
- (when return-type
- (gvalue-set return-value result)))))
-
-
-(defun invoke-callback (callback-id type &rest args)
+ for offset from 0 by +gvalue-size+
+ collect (gvalue-peek (pointer+ param-values offset)))))
+ (unwind-protect
+ (let ((result (apply #'invoke-callback callback-id return-type args)))
+ (when return-type
+ (gvalue-set return-value result)))
+ ;; TODO: this should be made more general, by adding a type
+ ;; method to return invalidate functions.
+ (loop
+ for arg in args
+ when (typep arg 'struct)
+ do (invalidate-instance arg)))))
+
+
+(defun invoke-callback (callback-id return-type &rest args)
(restart-case
(apply (find-user-data callback-id) args)
(continue nil :report "Return from callback function"
- (when type
- (format *query-io* "Enter return value of type ~S: " type)
+ (when return-type
+ (format *query-io* "Enter return value of type ~S: " return-type)
(force-output *query-io*)
(eval (read *query-io*))))
(re-invoke nil :report "Re-invoke callback function"
- (apply #'invoke-callback callback-id type args))))
+ (apply #'invoke-callback callback-id return-type args))))
;;;; Timeouts and idle functions
-(def-callback source-callback-marshal (void (callback-id unsigned-int))
- (callback-trampoline callback-id 0 nil (make-pointer 0)))
+(defconstant +priority-high+ -100)
+(defconstant +priority-default+ 0)
+(defconstant +priority-high-idle+ 100)
+(defconstant +priority-default-idle+ 200)
+(defconstant +priority-low+ 300)
+
+(defbinding source-remove () boolean
+ (tag unsigned-int))
+
+(define-callback source-callback-marshal nil ((callback-id unsigned-int))
+ (callback-trampoline callback-id 0 nil))
(defbinding (timeout-add "g_timeout_add_full")
- (function interval &optional (priority 0)) unsigned-int
+ (interval function &optional (priority +priority-default+)) unsigned-int
(priority int)
(interval unsigned-int)
- (*source-callback-marshal* pointer)
+ (source-callback-marshal callback)
((register-callback-function function) unsigned-long)
- ((callback %destroy-user-data) pointer))
+ (user-data-destroy-callback callback))
+
+(defun timeout-remove (timeout)
+ (source-remove timeout))
(defbinding (idle-add "g_idle_add_full")
- (function &optional (priority 0)) unsigned-int
+ (function &optional (priority +priority-default-idle+)) unsigned-int
(priority int)
- (*source-callback-marshal* pointer)
+ (source-callback-marshal callback)
((register-callback-function function) unsigned-long)
- ((callback %destroy-user-data) pointer))
+ (user-data-destroy-callback callback))
+(defun idle-remove (idle)
+ (source-remove idle))
-;;;; Signals
+;;;; Signal information querying
-(defbinding signal-lookup (name itype) unsigned-int
+(defbinding signal-lookup (name type) unsigned-int
((signal-name-to-string name) string)
- (itype type-number))
+ ((find-type-number type t) type-number))
-(defbinding signal-name () string
+(defbinding signal-name () (copy-of string)
(signal-id unsigned-int))
-(defun ensure-signal-id (signal-id instance)
+(defbinding signal-list-ids (type) (vector unsigned-int n-ids)
+ ((find-type-number type t) type-number)
+ (n-ids unsigned-int :out))
+
+(defun signal-list-names (type)
+ (map 'list #'signal-name (signal-list-ids type)))
+
+(defun ensure-signal-id-from-type (signal-id type)
(etypecase signal-id
- (integer signal-id)
- (string (signal-lookup signal-id (type-number-of instance)))
- (symbol (signal-lookup signal-id (type-number-of instance)))))
+ (integer (if (signal-name signal-id)
+ signal-id
+ (error "Invalid signal id: ~D" signal-id)))
+ ((or symbol string)
+ (let ((numeric-id (signal-lookup signal-id type)))
+ (if (zerop numeric-id)
+ (error "Invalid signal name for ~S: ~D" type signal-id)
+ numeric-id)))))
+
+(defun ensure-signal-id (signal-id instance)
+ (ensure-signal-id-from-type signal-id (type-of instance)))
-(defbinding signal-stop-emission (instance signal-id) nil
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (deftype signal-flags ()
+ '(flags :run-first :run-last :run-cleanup :no-recurse
+ :detailed :action :no-hooks))
+
+ (defclass signal-query (struct)
+ ((id :allocation :alien :type unsigned-int)
+ (name :allocation :alien :type (copy-of string))
+ (type :allocation :alien :type type-number)
+ (flags :allocation :alien :type signal-flags)
+ (return-type :allocation :alien :type type-number)
+ (n-params :allocation :alien :type unsigned-int)
+ (param-types :allocation :alien :type pointer))
+ (:metaclass struct-class)))
+
+(defbinding signal-query
+ (signal-id &optional (signal-query (make-instance 'signal-query))) nil
+ (signal-id unsigned-int)
+ (signal-query signal-query :in/return))
+
+(defun signal-param-types (info)
+ (with-slots (n-params param-types) info
+ (map-c-vector 'list
+ #'(lambda (type-number)
+ (type-from-number type-number))
+ param-types 'type-number n-params)))
+
+
+(defun describe-signal (signal-id &optional type)
+ (let ((info (signal-query (ensure-signal-id-from-type signal-id type))))
+ (with-slots (id name type flags return-type n-params) info
+ (format t "The signal with id ~D is named '~A' and may be emitted on instances of type ~S~%~%" id name (type-from-number type t))
+ (format t "Signal handlers should return ~A and take ~A~%"
+ (cond
+ ((= return-type (find-type-number "void")) "no values")
+ ((not (type-from-number return-type)) "values of unknown type")
+ ((format nil "values of type ~S" (type-from-number return-type))))
+ (if (zerop n-params)
+ "no arguments"
+ (format nil "arguments with the following types: ~A"
+ (signal-param-types info)))))))
+
+
+;;;; Signal connecting and controlling
+
+(defvar *overridden-signals* (make-hash-table :test 'equalp))
+
+(defbinding %signal-override-class-closure () nil
+ (signal-id unsigned-int)
+ (type-number type-number)
+ (callback-closure pointer))
+
+
+(defun signal-override-class-closure (name type function)
+ (let* ((signal-id (ensure-signal-id-from-type name type))
+ (type-number (find-type-number type t))
+ (callback-id (gethash (cons type-number signal-id) *overridden-signals*)))
+ (if callback-id
+ (update-user-data callback-id function)
+ (multiple-value-bind (callback-closure callback-id)
+ (make-callback-closure function)
+ (%signal-override-class-closure signal-id type-number callback-closure)
+ (setf
+ (gethash (cons type-number signal-id) *overridden-signals*)
+ callback-id)))))
+
+
+(defbinding %signal-chain-from-overridden () nil
+ (args pointer)
+ (return-value (or null gvalue)))
+
+
+(defun %call-next-handler (n-params types args return-type)
+ (let ((params (allocate-memory (* n-params +gvalue-size+))))
+ (loop
+ for arg in args
+ for type in types
+ for offset from 0 by +gvalue-size+
+ do (gvalue-init (pointer+ params offset) type arg))
+
+ (unwind-protect
+ (if return-type
+ (with-gvalue (return-value return-type)
+ (%signal-chain-from-overridden params return-value))
+ (%signal-chain-from-overridden params nil))
+ (progn
+ (loop
+ repeat n-params
+ for offset from 0 by +gvalue-size+
+ do (gvalue-unset (pointer+ params offset)))
+ (deallocate-memory params)))))
+
+
+(defmacro define-signal-handler (name ((object class) &rest args) &body body)
+ (let* ((info (signal-query (ensure-signal-id-from-type name class)))
+ (types (cons class (signal-param-types info)))
+ (n-params (1+ (slot-value info 'n-params)))
+ (return-type (type-from-number (slot-value info 'return-type)))
+ (vars (loop
+ for arg in args
+ until (eq arg '&rest)
+ collect arg))
+ (rest (cadr (member '&rest args)))
+ (next (make-symbol "ARGS"))
+ (default (make-symbol "DEFAULT")))
+
+ `(progn
+ (signal-override-class-closure ',name ',class
+ #'(lambda (,object ,@args)
+ (let ((,default (list* ,object ,@vars ,rest)))
+ (flet ((call-next-handler (&rest ,next)
+ (%call-next-handler
+ ,n-params ',types (or ,next ,default) ',return-type)))
+ ,@body))))
+ ',name)))
+
+
+(defbinding %signal-stop-emission () nil
(instance ginstance)
- ((ensure-signal-id signal-id instance) unsigned-int))
+ (signal-id unsigned-int)
+ (detail quark))
+
+(defvar *signal-stop-emission* nil)
+(declaim (special *signal-stop-emission*))
+
+(defun signal-stop-emission ()
+ (if *signal-stop-emission*
+ (funcall *signal-stop-emission*)
+ (error "Not inside a signal handler")))
+
-; (defbinding (signal-add-emisson-hook "g_signal_add_emission_hook_full")
-; () unsigned-int
-; (signal-id unsigned-int)
-; (closure gclosure))
+(defbinding signal-add-emission-hook (type signal function &key (detail 0))
+ unsigned-int
+ ((ensure-signal-id-from-type signal type) unsigned-int)
+ (detail quark)
+ (signal-emission-hook callback)
+ ((register-callback-function function) unsigned-int)
+ (user-data-destroy-callback callback))
+
+(defbinding signal-remove-emission-hook (type signal hook-id) nil
+ ((ensure-signal-id-from-type signal type) unsigned-int)
+ (hook-id unsigned-int))
-; (defbinding signal-remove-emisson-hook () nil
-; (signal-id unsigned-int)
-; (hook-id unsigned-int))
(defbinding (signal-has-handler-pending-p "g_signal_has_handler_pending")
(instance signal-id &key detail blocked) boolean
((or detail 0) quark)
(blocked boolean))
-(defbinding (signal-connect-closure "g_signal_connect_closure_by_id")
- (instance signal-id closure &key detail after) unsigned-int
+(defbinding %signal-connect-closure-by-id () unsigned-int
(instance ginstance)
- ((ensure-signal-id signal-id instance) unsigned-int)
- ((or detail 0) quark)
- (closure gclosure)
+ (signal-id unsigned-int)
+ (detail quark)
+ (closure pointer)
(after boolean))
(defbinding signal-handler-block () nil
(instance ginstance)
- (handler unsigned-int))
+ (handler-id unsigned-int))
(defbinding signal-handler-unblock () nil
(instance ginstance)
- (handler unsigned-int))
+ (handler-id unsigned-int))
(defbinding signal-handler-disconnect () nil
(instance ginstance)
- (handler unsigned-int))
-
-
-(defmethod signal-connect ((gobject gobject) signal function &key after object)
-"Connects a callback function to a signal for a particular object. If :OBJECT
- is T, the object connected to is passed as the first argument to the callback
- function, or if :OBJECT is any other non NIL value, it is passed as the first
- argument instead. If :AFTER is non NIL, the handler will be called after the
- default handler of the signal."
- (let ((callback-id
- (make-callback-closure
- (cond
- ((or (eq object t) (eq object gobject)) function)
- ((not object)
- #'(lambda (&rest args) (apply function (cdr args))))
- (t
- #'(lambda (&rest args) (apply function object (rest args))))))))
- (signal-connect-closure gobject signal callback-id :after after)))
-
-
-;;; Message logging
-
-;; TODO: define and signal conditions based on log-level
-;(defun log-handler (domain log-level message)
-(def-callback log-handler (void (domain c-string) (log-level int)
- (message c-string))
- (error "~A: ~A" domain message))
-
-(setf (extern-alien "log_handler" system-area-pointer) (callback log-handler))
+ (handler-id unsigned-int))
+
+(defbinding signal-handler-is-connected-p () boolean
+ (instance ginstance)
+ (handler-id unsigned-int))
+
+(defbinding (callback-closure-new "clg_callback_closure_new") () gclosure
+ (callback-id unsigned-int)
+ (callback callback)
+ (destroy-notify callback))
+
+(defun make-callback-closure (function)
+ (let ((callback-id (register-callback-function function)))
+ (values
+ (callback-closure-new callback-id closure-marshal user-data-destroy-callback)
+ callback-id)))
+
+(defgeneric compute-signal-function (gobject signal function object))
+
+(defmethod compute-signal-function ((gobject gobject) signal function object)
+ (declare (ignore signal))
+ (cond
+ ((or (eq object t) (eq object gobject)) function)
+ ((not object)
+ #'(lambda (&rest args) (apply function (rest args))))
+ (t
+ #'(lambda (&rest args) (apply function object (rest args))))))
+
+
+(defgeneric compute-signal-id (gobject signal))
+
+(defmethod compute-signal-id ((gobject gobject) signal)
+ (ensure-signal-id signal gobject))
+
+
+(defgeneric signal-connect (gobject signal function &key detail after object remove))
+
+(defmethod signal-connect :around ((gobject gobject) signal function &rest args)
+ (declare (ignore gobject signal args))
+ (when function
+ (call-next-method)))
+
+
+(defmethod signal-connect ((gobject gobject) signal function
+ &key detail after object remove)
+"Connects a callback function to a signal for a particular object. If
+:OBJECT is T, the object connected to is passed as the first argument
+to the callback function, or if :OBJECT is any other non NIL value, it
+is passed as the first argument instead. If :AFTER is non NIL, the
+handler will be called after the default handler for the signal. If
+:REMOVE is non NIL, the handler will be removed after beeing invoked
+once."
+(let* ((signal-id (compute-signal-id gobject signal))
+ (detail-quark (if detail (quark-intern detail) 0))
+ (signal-stop-emission
+ #'(lambda ()
+ (%signal-stop-emission gobject signal-id detail-quark)))
+ (callback (compute-signal-function gobject signal function object))
+ (wrapper #'(lambda (&rest args)
+ (let ((*signal-stop-emission* signal-stop-emission))
+ (apply callback args)))))
+ (multiple-value-bind (closure-id callback-id)
+ (make-callback-closure wrapper)
+ (let ((handler-id (%signal-connect-closure-by-id
+ gobject signal-id detail-quark closure-id after)))
+ (when remove
+ (update-user-data callback-id
+ #'(lambda (&rest args)
+ (unwind-protect
+ (let ((*signal-stop-emission* signal-stop-emission))
+ (apply callback args))
+ (signal-handler-disconnect gobject handler-id)))))
+ handler-id))))
+
+
+;;;; Signal emission
+
+(defbinding %signal-emitv () nil
+ (gvalues pointer)
+ (signal-id unsigned-int)
+ (detail quark)
+ (return-value gvalue))
+
+(defvar *signal-emit-functions* (make-hash-table))
+
+(defun create-signal-emit-function (signal-id)
+ (let ((info (signal-query signal-id)))
+ (let* ((type (type-from-number (slot-value info 'type)))
+ (param-types (cons type (signal-param-types info)))
+ (return-type (type-from-number (slot-value info 'return-type)))
+ (n-params (1+ (slot-value info 'n-params)))
+ (params (allocate-memory (* n-params +gvalue-size+))))
+ #'(lambda (detail object &rest args)
+ (unless (= (length args) (1- n-params))
+ (error "Invalid number of arguments: ~A" (+ 2 (length args))))
+ (unwind-protect
+ (loop
+ for arg in (cons object args)
+ for type in param-types
+ as tmp = params then (pointer+ tmp +gvalue-size+)
+ do (gvalue-init tmp type arg)
+ finally
+ (if return-type
+ (return
+ (with-gvalue (return-value)
+ (%signal-emitv params signal-id detail return-value)))
+ (%signal-emitv params signal-id detail (make-pointer 0))))
+ (loop
+ repeat n-params
+ as tmp = params then (pointer+ tmp +gvalue-size+)
+ while (gvalue-p tmp)
+ do (gvalue-unset tmp)))))))
+
+(defun signal-emit-with-detail (object signal detail &rest args)
+ (let* ((signal-id (ensure-signal-id signal object))
+ (function (or
+ (gethash signal-id *signal-emit-functions*)
+ (setf
+ (gethash signal-id *signal-emit-functions*)
+ (create-signal-emit-function signal-id)))))
+ (apply function detail object args)))
+
+(defun signal-emit (object signal &rest args)
+ (apply #'signal-emit-with-detail object signal 0 args))
+
+
+;;;; Convenient macros
+
+(defmacro define-callback-marshal (name return-type args &key (callback-id :last))
+ (let* ((ignore ())
+ (params ())
+ (names (loop
+ for arg in args
+ collect (if (or
+ (eq arg :ignore)
+ (and (consp arg) (eq (first arg) :ignore)))
+ (let ((name (gensym "IGNORE")))
+ (push name ignore)
+ name)
+ (let ((name (if (atom arg)
+ (gensym (string arg))
+ (first arg))))
+ (push name params)
+ name))))
+ (types (loop
+ for arg in args
+ collect (cond
+ ((eq arg :ignore) 'pointer)
+ ((atom arg) arg)
+ (t (second arg))))))
+ `(define-callback ,name ,return-type
+ ,(ecase callback-id
+ (:first `((callback-id unsigned-int) ,@(mapcar #'list names types)))
+ (:last `(,@(mapcar #'list names types) (callback-id unsigned-int))))
+ (declare (ignore ,@ignore))
+ (invoke-callback callback-id ',return-type ,@(nreverse params)))))
+
+(defmacro with-callback-function ((id function) &body body)
+ `(let ((,id (register-callback-function ,function)))
+ (unwind-protect
+ (progn ,@body)
+ (destroy-user-data ,id))))
~mdw / clg / blobdiff