1 ;; Common Lisp bindings for GTK+ v2.x
2 ;; Copyright 2000 Espen S. Johnsen <espen@users.sf.net>
4 ;; Permission is hereby granted, free of charge, to any person obtaining
5 ;; a copy of this software and associated documentation files (the
6 ;; "Software"), to deal in the Software without restriction, including
7 ;; without limitation the rights to use, copy, modify, merge, publish,
8 ;; distribute, sublicense, and/or sell copies of the Software, and to
9 ;; permit persons to whom the Software is furnished to do so, subject to
10 ;; the following conditions:
12 ;; The above copyright notice and this permission notice shall be
13 ;; included in all copies or substantial portions of the Software.
15 ;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 ;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 ;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18 ;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19 ;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20 ;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21 ;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 ;; $Id: gcallback.lisp,v 1.45 2007/06/25 13:49:05 espen Exp $
30 ;;;; Callback invocation
32 (deftype gclosure () 'pointer)
33 (register-type 'gclosure '|g_closure_get_type|)
35 (defun register-callback-function (function)
36 (check-type function (or null symbol function))
37 (register-user-data function))
39 ;; Callback marshaller for regular signal handlers
40 (define-callback signal-handler-marshal nil
41 ((gclosure gclosure) (return-value gvalue) (n-params unsigned-int)
42 (param-values pointer) (invocation-hint pointer)
43 (callback-id pointer-data))
44 (declare (ignore gclosure invocation-hint))
45 (callback-trampoline #'invoke-signal-handler callback-id n-params param-values return-value))
47 ;; Callback marshaller for class handlers
48 (define-callback class-handler-marshal nil
49 ((gclosure gclosure) (return-value gvalue) (n-params unsigned-int)
50 (param-values pointer) (invocation-hint pointer)
51 (callback-id pointer-data))
52 (declare (ignore gclosure invocation-hint))
53 (callback-trampoline #'invoke-callback callback-id n-params param-values return-value))
55 ;; Callback marshaller for emission hooks
56 (define-callback emission-hook-marshal nil
57 ((invocation-hint pointer) (n-params unsigned-int) (param-values pointer)
58 (callback-id pointer-data))
59 (declare (ignore invocation-hint))
60 (callback-trampoline #'invoke-callback callback-id n-params param-values))
62 (defun callback-trampoline (restart-wrapper callback-id n-params param-values
63 &optional (return-value (make-pointer 0)))
64 (let* ((return-type (unless (null-pointer-p return-value)
65 (gvalue-type return-value)))
67 for n from 0 below n-params
68 for offset from 0 by +gvalue-size+
69 collect (gvalue-peek (pointer+ param-values offset)))))
71 (multiple-value-bind (result aborted-p)
72 (apply restart-wrapper callback-id nil args)
73 (when (and return-type (not aborted-p))
74 (gvalue-set return-value result)))
75 ;; TODO: this should be made more general, by adding a type
76 ;; method to return invalidating functions.
79 when (typep arg 'struct)
80 do (invalidate-instance arg)))))
82 (defun invoke-signal-handler (callback-id return-type &rest args)
83 (declare (ignore return-type))
84 (let* ((instance (first args))
85 (handler-id (signal-handler-find instance '(:data)
86 0 0 nil nil callback-id)))
87 (signal-handler-block instance handler-id)
89 (restart-case (apply #'invoke-callback callback-id nil args)
90 (disconnect () :report "Disconnect and exit signal handler"
91 (when (signal-handler-is-connected-p instance handler-id)
92 (signal-handler-disconnect instance handler-id))
94 (when (signal-handler-is-connected-p instance handler-id)
95 (signal-handler-unblock instance handler-id))))
97 (defun invoke-callback (callback-id return-type &rest args)
98 (restart-case (apply (find-user-data callback-id) args)
99 (continue nil :report "Return from callback function"
102 (format *query-io* "Enter return value of type ~S: " return-type)
103 (force-output *query-io*)
104 (eval (read *query-io*)))
106 (re-invoke nil :report "Re-invoke callback function"
107 (apply #'invoke-callback callback-id return-type args))))
110 ;;;; Timeouts and idle functions
112 (defconstant +priority-high+ -100)
113 (defconstant +priority-default+ 0)
114 (defconstant +priority-high-idle+ 100)
115 (defconstant +priority-default-idle+ 200)
116 (defconstant +priority-low+ 300)
118 (defbinding source-remove () boolean
121 (define-callback source-callback-marshal boolean ((callback-id unsigned-int))
122 (invoke-source-callback callback-id))
124 (defun invoke-source-callback (callback-id &rest args)
125 (restart-case (apply (find-user-data callback-id) args)
126 (remove () :report "Exit and remove source callback"
128 (continue () :report "Return from source callback"
130 (re-invoke nil :report "Re-invoke source callback"
131 (apply #'invoke-source-callback callback-id args))))
134 (defbinding (timeout-add "g_timeout_add_full")
135 (interval function &optional (priority +priority-default+)) unsigned-int
137 (interval unsigned-int)
138 (source-callback-marshal callback)
139 ((register-callback-function function) unsigned-long)
140 (user-data-destroy-callback callback))
142 (defun timeout-remove (timeout)
143 (source-remove timeout))
145 (defbinding (idle-add "g_idle_add_full")
146 (function &optional (priority +priority-default-idle+)) unsigned-int
148 (source-callback-marshal callback)
149 ((register-callback-function function) unsigned-long)
150 (user-data-destroy-callback callback))
152 (defun idle-remove (idle)
153 (source-remove idle))
156 ;;;; Signal information querying
158 (defbinding signal-lookup (name type) unsigned-int
159 ((signal-name-to-string name) string)
160 ((find-type-number type t) type-number))
162 (defbinding signal-name () (copy-of string)
163 (signal-id unsigned-int))
165 (defbinding signal-list-ids (type) (vector unsigned-int n-ids)
166 ((find-type-number type t) type-number)
167 (n-ids unsigned-int :out))
169 (defun signal-list-names (type)
170 (map 'list #'signal-name (signal-list-ids type)))
172 (defun ensure-signal-id-from-type (signal-id type)
174 (integer (if (signal-name signal-id)
176 (error "Invalid signal id: ~D" signal-id)))
178 (let ((numeric-id (signal-lookup signal-id type)))
179 (if (zerop numeric-id)
180 (error "Invalid signal name for ~S: ~D" type signal-id)
183 (defun ensure-signal-id (signal-id instance)
184 (ensure-signal-id-from-type signal-id (type-of instance)))
186 (eval-when (:compile-toplevel :load-toplevel :execute)
187 (deftype signal-flags ()
188 '(flags :run-first :run-last :run-cleanup :no-recurse
189 :detailed :action :no-hooks))
191 (define-flags-type signal-match-type
192 :id :detail :closure :func :data :unblocked)
194 (defclass signal-query (struct)
195 ((id :allocation :alien :type unsigned-int)
196 (name :allocation :alien :type (copy-of string))
197 (type :allocation :alien :type type-number)
198 (flags :allocation :alien :type signal-flags)
199 (return-type :allocation :alien :type type-number)
200 (n-params :allocation :alien :type unsigned-int)
201 (param-types :allocation :alien :type pointer))
202 (:metaclass struct-class)))
204 (defbinding signal-query
205 (signal-id &optional (signal-query (make-instance 'signal-query))) nil
206 (signal-id unsigned-int)
207 (signal-query signal-query :in/return))
209 (defun signal-param-types (info)
210 (with-slots (n-params param-types) info
212 #'(lambda (type-number)
213 (type-from-number type-number))
214 param-types 'type-number n-params)))
217 (defun describe-signal (signal-id &optional type)
218 (let ((info (signal-query (ensure-signal-id-from-type signal-id type))))
219 (with-slots (id name type flags return-type n-params) info
220 (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))
222 (format t " It has the followin invocation flags: ~{~S ~}" flags))
223 (format t "~%~%Signal handlers should take ~A and return ~A~%"
226 (format nil "arguments with the following types: ~A"
227 (signal-param-types info)))
229 ((= return-type (find-type-number "void")) "no values")
230 ((not (type-from-number return-type)) "values of unknown type")
231 ((format nil "values of type ~S" (type-from-number return-type))))))))
234 ;;;; Signal connecting and controlling
236 (defvar *overridden-signals* (make-hash-table :test 'equalp))
238 (defbinding %signal-override-class-closure () nil
239 (signal-id unsigned-int)
240 (type-number type-number)
241 (callback-closure pointer))
244 (defun signal-override-class-closure (name type function)
245 (let* ((signal-id (ensure-signal-id-from-type name type))
246 (type-number (find-type-number type t))
247 (callback-id (gethash (cons type-number signal-id) *overridden-signals*)))
249 (update-user-data callback-id function)
250 (multiple-value-bind (callback-closure callback-id)
251 (make-callback-closure function class-handler-marshal)
252 (%signal-override-class-closure signal-id type-number callback-closure)
254 (gethash (cons type-number signal-id) *overridden-signals*)
258 (defbinding %signal-chain-from-overridden () nil
260 (return-value (or null gvalue)))
263 (defun %call-next-handler (n-params types args return-type)
264 (let ((params (allocate-memory (* n-params +gvalue-size+))))
268 for offset from 0 by +gvalue-size+
269 do (gvalue-init (pointer+ params offset) type arg))
273 (with-gvalue (return-value return-type)
274 (%signal-chain-from-overridden params return-value))
275 (%signal-chain-from-overridden params nil))
279 for offset from 0 by +gvalue-size+
280 do (gvalue-unset (pointer+ params offset)))
281 (deallocate-memory params)))))
284 (defmacro define-signal-handler (name ((object class) &rest args) &body body)
285 (let* ((info (signal-query (ensure-signal-id-from-type name class)))
286 (types (cons class (signal-param-types info)))
287 (n-params (1+ (slot-value info 'n-params)))
288 (return-type (type-from-number (slot-value info 'return-type)))
291 until (eq arg '&rest)
293 (rest (cadr (member '&rest args)))
294 (next (make-symbol "ARGS"))
295 (default (make-symbol "DEFAULT")))
298 (signal-override-class-closure ',name ',class
299 #'(lambda (,object ,@args)
300 (let ((,default (list* ,object ,@vars ,rest)))
301 (flet ((call-next-handler (&rest ,next)
303 ,n-params ',types (or ,next ,default) ',return-type)))
308 (defbinding %signal-stop-emission () nil
310 (signal-id unsigned-int)
313 (defvar *signal-stop-emission* nil)
314 (declaim (special *signal-stop-emission*))
316 (defun signal-stop-emission ()
317 (if *signal-stop-emission*
318 (funcall *signal-stop-emission*)
319 (error "Not inside a signal handler")))
322 (defbinding signal-add-emission-hook (type signal function &key (detail 0))
324 ((ensure-signal-id-from-type signal type) unsigned-int)
326 (emission-hook-marshal callback)
327 ((register-callback-function function) unsigned-int)
328 (user-data-destroy-callback callback))
330 (defbinding signal-remove-emission-hook (type signal hook-id) nil
331 ((ensure-signal-id-from-type signal type) unsigned-int)
332 (hook-id unsigned-long))
335 (defbinding (signal-has-handler-pending-p "g_signal_has_handler_pending")
336 (instance signal-id &key detail blocked) boolean
338 ((ensure-signal-id signal-id instance) unsigned-int)
339 ((or detail 0) quark)
342 (defbinding %signal-connect-closure-by-id () unsigned-long
344 (signal-id unsigned-int)
349 (defbinding signal-handler-block () nil
351 (handler-id unsigned-long))
353 (defbinding signal-handler-unblock () nil
355 (handler-id unsigned-long))
358 (defbinding signal-handler-find () unsigned-long
360 (mask signal-match-type)
361 (signal-id unsigned-int)
363 (closure (or null pointer))
364 (func (or null pointer))
367 (defbinding signal-handler-disconnect () nil
369 (handler-id unsigned-long))
371 (defbinding signal-handler-is-connected-p () boolean
373 (handler-id unsigned-long))
375 (defbinding (closure-new "g_cclosure_new") () gclosure
376 ((make-pointer #xFFFFFFFF) pointer)
377 (callback-id unsigned-int)
378 (destroy-notify callback))
380 (defbinding closure-set-meta-marshal () nil
382 (callback-id unsigned-int)
385 (defun callback-closure-new (callback-id callback destroy-notify)
386 (let ((gclosure (closure-new callback-id destroy-notify)))
387 (closure-set-meta-marshal gclosure callback-id callback)
390 (defun make-callback-closure (function &optional (marshaller signal-handler-marshal))
391 (let ((callback-id (register-callback-function function)))
393 (callback-closure-new callback-id marshaller user-data-destroy-callback)
396 (defgeneric compute-signal-function (gobject signal function object args))
398 (defmethod compute-signal-function ((gobject gobject) signal function object args)
399 (declare (ignore signal))
401 ((or (eq object t) (eq object gobject))
403 #'(lambda (&rest emission-args)
404 (apply function (nconc emission-args args)))
408 #'(lambda (&rest emission-args)
409 (apply function object (nconc (rest emission-args) args)))
410 #'(lambda (&rest emission-args)
411 (apply function object (rest emission-args)))))
413 #'(lambda (&rest emission-args)
414 (apply function (nconc (rest emission-args) args))))
416 #'(lambda (&rest emission-args)
417 (apply function (rest emission-args))))))
419 (defgeneric compute-signal-id (gobject signal))
421 (defmethod compute-signal-id ((gobject gobject) signal)
422 (ensure-signal-id signal gobject))
425 (defgeneric signal-connect (gobject signal function &key detail after object remove args))
427 (defmethod signal-connect :around ((gobject gobject) signal function &rest args)
428 (declare (ignore gobject signal args))
433 (defmethod signal-connect ((gobject gobject) signal function
434 &key detail after object remove args)
435 "Connects a callback function to a signal for a particular object. If
436 :OBJECT is T, the object connected to is passed as the first argument
437 to the callback function, or if :OBJECT is any other non NIL value, it
438 is passed as the first argument instead. If :AFTER is non NIL, the
439 handler will be called after the default handler for the signal. If
440 :REMOVE is non NIL, the handler will be removed after beeing invoked
441 once. ARGS is a list of additional arguments passed to the callback
443 (let* ((signal-id (compute-signal-id gobject signal))
444 (detail-quark (if detail (quark-intern detail) 0))
445 (signal-stop-emission
447 (%signal-stop-emission gobject signal-id detail-quark)))
448 (callback (compute-signal-function gobject signal function object args))
449 (wrapper #'(lambda (&rest args)
450 (let ((*signal-stop-emission* signal-stop-emission))
451 (apply callback args)))))
452 (multiple-value-bind (closure-id callback-id)
453 (make-callback-closure wrapper signal-handler-marshal)
454 (let ((handler-id (%signal-connect-closure-by-id
455 gobject signal-id detail-quark closure-id after)))
457 (update-user-data callback-id
458 #'(lambda (&rest args)
460 (let ((*signal-stop-emission* signal-stop-emission))
461 (apply callback args))
462 (when (signal-handler-is-connected-p gobject handler-id)
463 (signal-handler-disconnect gobject handler-id))))))
469 (defbinding %signal-emitv () nil
471 (signal-id unsigned-int)
473 (return-value gvalue))
475 (defvar *signal-emit-functions* (make-hash-table))
477 (defun create-signal-emit-function (signal-id)
478 (let ((info (signal-query signal-id)))
479 (let* ((type (type-from-number (slot-value info 'type)))
480 (param-types (cons type (signal-param-types info)))
481 (return-type (type-from-number (slot-value info 'return-type)))
482 (n-params (1+ (slot-value info 'n-params)))
483 (params (allocate-memory (* n-params +gvalue-size+))))
484 #'(lambda (detail object &rest args)
485 (unless (= (length args) (1- n-params))
486 (error "Invalid number of arguments in emmision of signal ~A: ~A" signal-id (length args)))
489 for arg in (cons object args)
490 for type in param-types
491 as tmp = params then (pointer+ tmp +gvalue-size+)
492 do (gvalue-init tmp type arg)
496 (with-gvalue (return-value)
497 (%signal-emitv params signal-id detail return-value)))
498 (%signal-emitv params signal-id detail (make-pointer 0))))
501 as tmp = params then (pointer+ tmp +gvalue-size+)
503 do (gvalue-unset tmp)))))))
505 (defun signal-emit-with-detail (object signal detail &rest args)
506 (let* ((signal-id (ensure-signal-id signal object))
508 (gethash signal-id *signal-emit-functions*)
510 (gethash signal-id *signal-emit-functions*)
511 (create-signal-emit-function signal-id)))))
512 (apply function detail object args)))
514 (defun signal-emit (object signal &rest args)
515 (apply #'signal-emit-with-detail object signal 0 args))
518 ;;;; Signal registration
520 (defbinding %signal-newv (name itype flags return-type param-types)
522 ((signal-name-to-string name) string)
525 (nil null) ; class closure
526 (nil null) ; accumulator
527 (nil null) ; accumulator data
528 (nil null) ; c marshaller
530 ((length param-types) unsigned-int)
531 (param-types (vector gtype)))
533 (defun signal-new (name itype flags return-type param-types)
534 (when (zerop (signal-lookup name itype))
535 (%signal-newv name itype flags return-type param-types)))
537 ;;;; Convenient macros
539 (defmacro define-callback-marshal (name return-type args &key (callback-id :last))
546 (and (consp arg) (eq (first arg) :ignore)))
547 (let ((name (gensym "IGNORE")))
550 (let ((name (if (atom arg)
551 (gensym (string arg))
558 ((eq arg :ignore) 'pointer)
561 `(define-callback ,name ,return-type
563 (:first `((callback-id pointer-data) ,@(mapcar #'list names types)))
564 (:last `(,@(mapcar #'list names types) (callback-id pointer-data))))
565 (declare (ignore ,@ignore))
566 (invoke-callback callback-id ',return-type ,@(nreverse params)))))
568 (defmacro with-callback-function ((id function) &body body)
569 `(let ((,id (register-callback-function ,function)))
572 (destroy-user-data ,id))))