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.26 2006-02-01 14:18:49 espen Exp $
30 ;;;; Callback invokation
32 (defun register-callback-function (function)
33 (check-type function (or null symbol function))
34 (register-user-data function))
36 ;; Callback marshal for regular signal handlers
37 (defcallback closure-marshal (nil
40 (n-params unsigned-int)
41 (param-values pointer)
42 (invocation-hint pointer)
43 (callback-id unsigned-int))
44 (declare (ignore gclosure invocation-hint))
45 (callback-trampoline callback-id n-params param-values return-value))
47 ;; Callback function for emission hooks
48 (defcallback signal-emission-hook (nil
49 (invocation-hint pointer)
50 (n-params unsigned-int)
51 (param-values pointer)
52 (callback-id unsigned-int))
53 (callback-trampoline callback-id n-params param-values))
55 (defun callback-trampoline (callback-id n-params param-values &optional
56 (return-value (make-pointer 0)))
57 (let* ((return-type (unless (null-pointer-p return-value)
58 (gvalue-type return-value)))
60 for n from 0 below n-params
61 collect (gvalue-get (sap+ param-values (* n +gvalue-size+))))))
62 (let ((result (apply #'invoke-callback callback-id return-type args)))
64 (gvalue-set return-value result)))))
66 (defun invoke-callback (callback-id return-type &rest args)
68 (apply (find-user-data callback-id) args)
69 (continue nil :report "Return from callback function"
71 (format *query-io* "Enter return value of type ~S: " return-type)
72 (force-output *query-io*)
73 (eval (read *query-io*))))
74 (re-invoke nil :report "Re-invoke callback function"
75 (apply #'invoke-callback callback-id return-type args))))
78 ;;;; Timeouts and idle functions
80 (defconstant +priority-high+ -100)
81 (defconstant +priority-default+ 0)
82 (defconstant +priority-high-idle+ 100)
83 (defconstant +priority-default-idle+ 200)
84 (defconstant +priority-low+ 300)
86 (defbinding source-remove () boolean
89 (defcallback source-callback-marshal (nil (callback-id unsigned-int))
90 (callback-trampoline callback-id 0 nil))
92 (defbinding (timeout-add "g_timeout_add_full")
93 (interval function &optional (priority +priority-default+)) unsigned-int
95 (interval unsigned-int)
96 ((callback source-callback-marshal) pointer)
97 ((register-callback-function function) unsigned-long)
98 ((callback user-data-destroy-func) pointer))
100 (defun timeout-remove (timeout)
101 (source-remove timeout))
103 (defbinding (idle-add "g_idle_add_full")
104 (function &optional (priority +priority-default-idle+)) unsigned-int
106 ((callback source-callback-marshal) pointer)
107 ((register-callback-function function) unsigned-long)
108 ((callback user-data-destroy-func) pointer))
110 (defun idle-remove (idle)
111 (source-remove idle))
114 ;;;; Signal information querying
116 (defbinding signal-lookup (name type) unsigned-int
117 ((signal-name-to-string name) string)
118 ((find-type-number type t) type-number))
120 (defbinding signal-name () (copy-of string)
121 (signal-id unsigned-int))
123 (defbinding signal-list-ids (type) (vector unsigned-int n-ids)
124 ((find-type-number type t) type-number)
125 (n-ids unsigned-int :out))
127 (defun signal-list-names (type)
128 (map 'list #'signal-name (signal-list-ids type)))
130 (defun ensure-signal-id-from-type (signal-id type)
132 (integer (if (signal-name signal-id)
134 (error "Invalid signal id: ~D" signal-id)))
136 (let ((numeric-id (signal-lookup signal-id type)))
137 (if (zerop numeric-id)
138 (error "Invalid signal name for ~S: ~D" type signal-id)
141 (defun ensure-signal-id (signal-id instance)
142 (ensure-signal-id-from-type signal-id (type-of instance)))
144 (eval-when (:compile-toplevel :load-toplevel :execute)
145 (deftype signal-flags ()
146 '(flags :run-first :run-last :run-cleanup :no-recurse
147 :detailed :action :no-hooks))
149 (defclass signal-query (struct)
150 ((id :allocation :alien :type unsigned-int)
151 (name :allocation :alien :type (copy-of string))
152 (type :allocation :alien :type type-number)
153 (flags :allocation :alien :type signal-flags)
154 (return-type :allocation :alien :type type-number)
155 (n-params :allocation :alien :type unsigned-int)
156 (param-types :allocation :alien :type pointer))
157 (:metaclass struct-class)))
159 (defbinding signal-query
160 (signal-id &optional (signal-query (make-instance 'signal-query))) nil
161 (signal-id unsigned-int)
162 (signal-query signal-query :return))
164 (defun signal-param-types (info)
165 (with-slots (n-params param-types) info
167 #'(lambda (type-number)
168 (type-from-number type-number))
169 param-types 'type-number n-params)))
172 (defun describe-signal (signal-id &optional type)
173 (let ((info (signal-query (ensure-signal-id-from-type signal-id type))))
174 (with-slots (id name type flags return-type n-params) info
175 (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))
176 (format t "Signal handlers should return ~A and take ~A~%"
178 ((= return-type (find-type-number "void")) "no values")
179 ((not (type-from-number return-type)) "values of unknown type")
180 ((format nil "values of type ~S" (type-from-number return-type))))
183 (format nil "arguments with the following types: ~A"
184 (signal-param-types info)))))))
187 ;;;; Signal connecting and controlling
189 (defvar *overridden-signals* (make-hash-table :test 'equalp))
191 (defbinding %signal-override-class-closure () nil
192 (signal-id unsigned-int)
193 (type-number type-number)
194 (callback-closure pointer))
197 (defun signal-override-class-closure (name type function)
198 (let* ((signal-id (ensure-signal-id-from-type name type))
199 (type-number (find-type-number type t))
200 (callback-id (gethash (cons type-number signal-id) *overridden-signals*)))
202 (update-user-data callback-id function)
203 (multiple-value-bind (callback-closure callback-id)
204 (make-callback-closure function)
205 (%signal-override-class-closure signal-id type-number callback-closure)
207 (gethash (cons type-number signal-id) *overridden-signals*)
211 (defbinding %signal-chain-from-overridden () nil
213 (return-value (or null gvalue)))
216 (defun %call-next-handler (n-params types args defaults return-type)
217 (let ((params (allocate-memory (* n-params +gvalue-size+))))
219 as tmp = args then (rest tmp)
220 for default in defaults
222 for offset from 0 by +gvalue-size+
223 as arg = (if tmp (car tmp) default)
224 do (gvalue-init (sap+ params offset) type arg))
228 (with-gvalue (return-value return-type)
229 (%signal-chain-from-overridden params return-value))
230 (%signal-chain-from-overridden params nil))
234 for offset from 0 by +gvalue-size+
235 do (gvalue-unset (sap+ params offset)))
236 (deallocate-memory params)))))
239 (defmacro define-signal-handler (name ((object class) &rest args) &body body)
240 (let* ((info (signal-query (ensure-signal-id-from-type name class)))
241 (types (cons class (signal-param-types info)))
242 (n-params (1+ (slot-value info 'n-params)))
243 (return-type (type-from-number (slot-value info 'return-type)))
246 until (eq arg '&rest)
248 (rest (cadr (member '&rest args)))
249 (next (make-symbol "ARGS")))
252 (signal-override-class-closure ',name ',class
253 #'(lambda (,object ,@args)
254 (flet ((call-next-handler (&rest ,next)
255 (let ((defaults (list* ,object ,@vars ,rest)))
257 ,n-params ',types ,next defaults ',return-type))))
262 (defbinding %signal-stop-emission () nil
264 (signal-id unsigned-int)
267 (defvar *signal-stop-emission* nil)
268 (declaim (special *signal-stop-emission*))
270 (defun signal-stop-emission ()
271 (if *signal-stop-emission*
272 (funcall *signal-stop-emission*)
273 (error "Not inside a signal handler")))
276 (defbinding signal-add-emission-hook (type signal function &key (detail 0))
278 ((ensure-signal-id-from-type signal type) unsigned-int)
280 ((callback signal-emission-hook) pointer)
281 ((register-callback-function function) unsigned-int)
282 ((callback user-data-destroy-func) pointer))
284 (defbinding signal-remove-emission-hook (type signal hook-id) nil
285 ((ensure-signal-id-from-type signal type) unsigned-int)
286 (hook-id unsigned-int))
289 (defbinding (signal-has-handler-pending-p "g_signal_has_handler_pending")
290 (instance signal-id &key detail blocked) boolean
292 ((ensure-signal-id signal-id instance) unsigned-int)
293 ((or detail 0) quark)
296 (defbinding %signal-connect-closure-by-id () unsigned-int
298 (signal-id unsigned-int)
303 (defbinding signal-handler-block () nil
305 (handler-id unsigned-int))
307 (defbinding signal-handler-unblock () nil
309 (handler-id unsigned-int))
311 (defbinding signal-handler-disconnect () nil
313 (handler-id unsigned-int))
315 (defbinding signal-handler-is-connected-p () boolean
317 (handler-id unsigned-int))
319 (deftype gclosure () 'pointer)
320 (register-type 'gclosure "GClosure")
322 (defbinding (callback-closure-new "clg_callback_closure_new") () gclosure
323 (callback-id unsigned-int)
325 (destroy-notify pointer))
327 (defun make-callback-closure (function)
328 (let ((callback-id (register-callback-function function)))
330 (callback-closure-new
331 callback-id (callback closure-marshal)
332 (callback user-data-destroy-func))
335 (defgeneric compute-signal-function (gobject signal function object))
337 (defmethod compute-signal-function ((gobject gobject) signal function object)
338 (declare (ignore signal))
340 ((or (eq object t) (eq object gobject)) function)
342 #'(lambda (&rest args) (apply function (rest args))))
344 #'(lambda (&rest args) (apply function object (rest args))))))
347 (defgeneric compute-signal-id (gobject signal))
349 (defmethod compute-signal-id ((gobject gobject) signal)
350 (ensure-signal-id signal gobject))
353 (defgeneric signal-connect (gobject signal function &key detail after object remove))
355 (defmethod signal-connect :around ((gobject gobject) signal function &rest args)
356 (declare (ignore gobject signal args))
361 (defmethod signal-connect ((gobject gobject) signal function
362 &key detail after object remove)
363 "Connects a callback function to a signal for a particular object. If
364 :OBJECT is T, the object connected to is passed as the first argument
365 to the callback function, or if :OBJECT is any other non NIL value, it
366 is passed as the first argument instead. If :AFTER is non NIL, the
367 handler will be called after the default handler for the signal. If
368 :REMOVE is non NIL, the handler will be removed after beeing invoked
370 (let* ((signal-id (compute-signal-id gobject signal))
371 (detail-quark (if detail (quark-intern detail) 0))
372 (signal-stop-emission
374 (%signal-stop-emission gobject signal-id detail-quark)))
375 (callback (compute-signal-function gobject signal function object))
376 (wrapper #'(lambda (&rest args)
377 (let ((*signal-stop-emission* signal-stop-emission))
378 (apply callback args)))))
379 (multiple-value-bind (closure-id callback-id)
380 (make-callback-closure wrapper)
381 (let ((handler-id (%signal-connect-closure-by-id
382 gobject signal-id detail-quark closure-id after)))
384 (update-user-data callback-id
385 #'(lambda (&rest args)
387 (let ((*signal-stop-emission* signal-stop-emission))
388 (apply callback args))
389 (signal-handler-disconnect gobject handler-id)))))
395 (defbinding %signal-emitv () nil
397 (signal-id unsigned-int)
399 (return-value gvalue))
401 (defvar *signal-emit-functions* (make-hash-table))
403 (defun create-signal-emit-function (signal-id)
404 (let ((info (signal-query signal-id)))
405 (let* ((type (type-from-number (slot-value info 'type)))
406 (param-types (cons type (signal-param-types info)))
407 (return-type (type-from-number (slot-value info 'return-type)))
408 (n-params (1+ (slot-value info 'n-params)))
409 (params (allocate-memory (* n-params +gvalue-size+))))
410 #'(lambda (detail object &rest args)
411 (unless (= (length args) (1- n-params))
412 (error "Invalid number of arguments: ~A" (+ 2 (length args))))
415 for arg in (cons object args)
416 for type in param-types
417 as tmp = params then (sap+ tmp +gvalue-size+)
418 do (gvalue-init tmp type arg)
422 (with-gvalue (return-value)
423 (%signal-emitv params signal-id detail return-value)))
424 (%signal-emitv params signal-id detail (make-pointer 0))))
427 as tmp = params then (sap+ tmp +gvalue-size+)
429 do (gvalue-unset tmp)))))))
431 (defun signal-emit-with-detail (object signal detail &rest args)
432 (let* ((signal-id (ensure-signal-id signal object))
434 (gethash signal-id *signal-emit-functions*)
436 (gethash signal-id *signal-emit-functions*)
437 (create-signal-emit-function signal-id)))))
438 (apply function detail object args)))
440 (defun signal-emit (object signal &rest args)
441 (apply #'signal-emit-with-detail object signal 0 args))
444 ;;;; Convenient macros
446 (defmacro def-callback-marshal (name (return-type &rest args))
449 collect (if (atom arg) (gensym) (first arg))))
452 collect (if (atom arg) arg (second arg)))))
453 `(defcallback ,name (,return-type ,@(mapcar #'list names types)
454 (callback-id unsigned-int))
455 (invoke-callback callback-id ',return-type ,@names))))
457 (defmacro with-callback-function ((id function) &body body)
458 `(let ((,id (register-callback-function ,function)))
461 (destroy-user-data ,id))))