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.29 2006-02-08 19:56:25 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 for offset from 0 by +gvalue-size+
62 collect (gvalue-get (sap+ param-values offset) t))))
64 (let ((result (apply #'invoke-callback callback-id return-type args)))
66 (gvalue-set return-value result)))
69 when (typep arg 'proxy)
70 do (invalidate-instance arg)))))
73 (defun invoke-callback (callback-id return-type &rest args)
75 (apply (find-user-data callback-id) args)
76 (continue nil :report "Return from callback function"
78 (format *query-io* "Enter return value of type ~S: " return-type)
79 (force-output *query-io*)
80 (eval (read *query-io*))))
81 (re-invoke nil :report "Re-invoke callback function"
82 (apply #'invoke-callback callback-id return-type args))))
85 ;;;; Timeouts and idle functions
87 (defconstant +priority-high+ -100)
88 (defconstant +priority-default+ 0)
89 (defconstant +priority-high-idle+ 100)
90 (defconstant +priority-default-idle+ 200)
91 (defconstant +priority-low+ 300)
93 (defbinding source-remove () boolean
96 (defcallback source-callback-marshal (nil (callback-id unsigned-int))
97 (callback-trampoline callback-id 0 nil))
99 (defbinding (timeout-add "g_timeout_add_full")
100 (interval function &optional (priority +priority-default+)) unsigned-int
102 (interval unsigned-int)
103 ((callback source-callback-marshal) pointer)
104 ((register-callback-function function) unsigned-long)
105 ((callback user-data-destroy-func) pointer))
107 (defun timeout-remove (timeout)
108 (source-remove timeout))
110 (defbinding (idle-add "g_idle_add_full")
111 (function &optional (priority +priority-default-idle+)) unsigned-int
113 ((callback source-callback-marshal) pointer)
114 ((register-callback-function function) unsigned-long)
115 ((callback user-data-destroy-func) pointer))
117 (defun idle-remove (idle)
118 (source-remove idle))
121 ;;;; Signal information querying
123 (defbinding signal-lookup (name type) unsigned-int
124 ((signal-name-to-string name) string)
125 ((find-type-number type t) type-number))
127 (defbinding signal-name () (copy-of string)
128 (signal-id unsigned-int))
130 (defbinding signal-list-ids (type) (vector unsigned-int n-ids)
131 ((find-type-number type t) type-number)
132 (n-ids unsigned-int :out))
134 (defun signal-list-names (type)
135 (map 'list #'signal-name (signal-list-ids type)))
137 (defun ensure-signal-id-from-type (signal-id type)
139 (integer (if (signal-name signal-id)
141 (error "Invalid signal id: ~D" signal-id)))
143 (let ((numeric-id (signal-lookup signal-id type)))
144 (if (zerop numeric-id)
145 (error "Invalid signal name for ~S: ~D" type signal-id)
148 (defun ensure-signal-id (signal-id instance)
149 (ensure-signal-id-from-type signal-id (type-of instance)))
151 (eval-when (:compile-toplevel :load-toplevel :execute)
152 (deftype signal-flags ()
153 '(flags :run-first :run-last :run-cleanup :no-recurse
154 :detailed :action :no-hooks))
156 (defclass signal-query (struct)
157 ((id :allocation :alien :type unsigned-int)
158 (name :allocation :alien :type (copy-of string))
159 (type :allocation :alien :type type-number)
160 (flags :allocation :alien :type signal-flags)
161 (return-type :allocation :alien :type type-number)
162 (n-params :allocation :alien :type unsigned-int)
163 (param-types :allocation :alien :type pointer))
164 (:metaclass struct-class)))
166 (defbinding signal-query
167 (signal-id &optional (signal-query (make-instance 'signal-query))) nil
168 (signal-id unsigned-int)
169 (signal-query signal-query :return))
171 (defun signal-param-types (info)
172 (with-slots (n-params param-types) info
174 #'(lambda (type-number)
175 (type-from-number type-number))
176 param-types 'type-number n-params)))
179 (defun describe-signal (signal-id &optional type)
180 (let ((info (signal-query (ensure-signal-id-from-type signal-id type))))
181 (with-slots (id name type flags return-type n-params) info
182 (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))
183 (format t "Signal handlers should return ~A and take ~A~%"
185 ((= return-type (find-type-number "void")) "no values")
186 ((not (type-from-number return-type)) "values of unknown type")
187 ((format nil "values of type ~S" (type-from-number return-type))))
190 (format nil "arguments with the following types: ~A"
191 (signal-param-types info)))))))
194 ;;;; Signal connecting and controlling
196 (defvar *overridden-signals* (make-hash-table :test 'equalp))
198 (defbinding %signal-override-class-closure () nil
199 (signal-id unsigned-int)
200 (type-number type-number)
201 (callback-closure pointer))
204 (defun signal-override-class-closure (name type function)
205 (let* ((signal-id (ensure-signal-id-from-type name type))
206 (type-number (find-type-number type t))
207 (callback-id (gethash (cons type-number signal-id) *overridden-signals*)))
209 (update-user-data callback-id function)
210 (multiple-value-bind (callback-closure callback-id)
211 (make-callback-closure function)
212 (%signal-override-class-closure signal-id type-number callback-closure)
214 (gethash (cons type-number signal-id) *overridden-signals*)
218 (defbinding %signal-chain-from-overridden () nil
220 (return-value (or null gvalue)))
223 (defun %call-next-handler (n-params types args return-type)
224 (let ((params (allocate-memory (* n-params +gvalue-size+))))
228 for offset from 0 by +gvalue-size+
229 do (gvalue-init (sap+ params offset) type arg))
233 (with-gvalue (return-value return-type)
234 (%signal-chain-from-overridden params return-value))
235 (%signal-chain-from-overridden params nil))
239 for offset from 0 by +gvalue-size+
240 do (gvalue-unset (sap+ params offset)))
241 (deallocate-memory params)))))
244 (defmacro define-signal-handler (name ((object class) &rest args) &body body)
245 (let* ((info (signal-query (ensure-signal-id-from-type name class)))
246 (types (cons class (signal-param-types info)))
247 (n-params (1+ (slot-value info 'n-params)))
248 (return-type (type-from-number (slot-value info 'return-type)))
251 until (eq arg '&rest)
253 (rest (cadr (member '&rest args)))
254 (next (make-symbol "ARGS"))
255 (default (make-symbol "DEFAULT")))
258 (signal-override-class-closure ',name ',class
259 #'(lambda (,object ,@args)
260 (let ((,default (list* ,object ,@vars ,rest)))
261 (flet ((call-next-handler (&rest ,next)
263 ,n-params ',types (or ,next ,default) ',return-type))))
268 (defbinding %signal-stop-emission () nil
270 (signal-id unsigned-int)
273 (defvar *signal-stop-emission* nil)
274 (declaim (special *signal-stop-emission*))
276 (defun signal-stop-emission ()
277 (if *signal-stop-emission*
278 (funcall *signal-stop-emission*)
279 (error "Not inside a signal handler")))
282 (defbinding signal-add-emission-hook (type signal function &key (detail 0))
284 ((ensure-signal-id-from-type signal type) unsigned-int)
286 ((callback signal-emission-hook) pointer)
287 ((register-callback-function function) unsigned-int)
288 ((callback user-data-destroy-func) pointer))
290 (defbinding signal-remove-emission-hook (type signal hook-id) nil
291 ((ensure-signal-id-from-type signal type) unsigned-int)
292 (hook-id unsigned-int))
295 (defbinding (signal-has-handler-pending-p "g_signal_has_handler_pending")
296 (instance signal-id &key detail blocked) boolean
298 ((ensure-signal-id signal-id instance) unsigned-int)
299 ((or detail 0) quark)
302 (defbinding %signal-connect-closure-by-id () unsigned-int
304 (signal-id unsigned-int)
309 (defbinding signal-handler-block () nil
311 (handler-id unsigned-int))
313 (defbinding signal-handler-unblock () nil
315 (handler-id unsigned-int))
317 (defbinding signal-handler-disconnect () nil
319 (handler-id unsigned-int))
321 (defbinding signal-handler-is-connected-p () boolean
323 (handler-id unsigned-int))
325 (deftype gclosure () 'pointer)
326 (register-type 'gclosure "GClosure")
328 (defbinding (callback-closure-new "clg_callback_closure_new") () gclosure
329 (callback-id unsigned-int)
331 (destroy-notify pointer))
333 (defun make-callback-closure (function)
334 (let ((callback-id (register-callback-function function)))
336 (callback-closure-new
337 callback-id (callback closure-marshal)
338 (callback user-data-destroy-func))
341 (defgeneric compute-signal-function (gobject signal function object))
343 (defmethod compute-signal-function ((gobject gobject) signal function object)
344 (declare (ignore signal))
346 ((or (eq object t) (eq object gobject)) function)
348 #'(lambda (&rest args) (apply function (rest args))))
350 #'(lambda (&rest args) (apply function object (rest args))))))
353 (defgeneric compute-signal-id (gobject signal))
355 (defmethod compute-signal-id ((gobject gobject) signal)
356 (ensure-signal-id signal gobject))
359 (defgeneric signal-connect (gobject signal function &key detail after object remove))
361 (defmethod signal-connect :around ((gobject gobject) signal function &rest args)
362 (declare (ignore gobject signal args))
367 (defmethod signal-connect ((gobject gobject) signal function
368 &key detail after object remove)
369 "Connects a callback function to a signal for a particular object. If
370 :OBJECT is T, the object connected to is passed as the first argument
371 to the callback function, or if :OBJECT is any other non NIL value, it
372 is passed as the first argument instead. If :AFTER is non NIL, the
373 handler will be called after the default handler for the signal. If
374 :REMOVE is non NIL, the handler will be removed after beeing invoked
376 (let* ((signal-id (compute-signal-id gobject signal))
377 (detail-quark (if detail (quark-intern detail) 0))
378 (signal-stop-emission
380 (%signal-stop-emission gobject signal-id detail-quark)))
381 (callback (compute-signal-function gobject signal function object))
382 (wrapper #'(lambda (&rest args)
383 (let ((*signal-stop-emission* signal-stop-emission))
384 (apply callback args)))))
385 (multiple-value-bind (closure-id callback-id)
386 (make-callback-closure wrapper)
387 (let ((handler-id (%signal-connect-closure-by-id
388 gobject signal-id detail-quark closure-id after)))
390 (update-user-data callback-id
391 #'(lambda (&rest args)
393 (let ((*signal-stop-emission* signal-stop-emission))
394 (apply callback args))
395 (signal-handler-disconnect gobject handler-id)))))
401 (defbinding %signal-emitv () nil
403 (signal-id unsigned-int)
405 (return-value gvalue))
407 (defvar *signal-emit-functions* (make-hash-table))
409 (defun create-signal-emit-function (signal-id)
410 (let ((info (signal-query signal-id)))
411 (let* ((type (type-from-number (slot-value info 'type)))
412 (param-types (cons type (signal-param-types info)))
413 (return-type (type-from-number (slot-value info 'return-type)))
414 (n-params (1+ (slot-value info 'n-params)))
415 (params (allocate-memory (* n-params +gvalue-size+))))
416 #'(lambda (detail object &rest args)
417 (unless (= (length args) (1- n-params))
418 (error "Invalid number of arguments: ~A" (+ 2 (length args))))
421 for arg in (cons object args)
422 for type in param-types
423 as tmp = params then (sap+ tmp +gvalue-size+)
424 do (gvalue-init tmp type arg)
428 (with-gvalue (return-value)
429 (%signal-emitv params signal-id detail return-value)))
430 (%signal-emitv params signal-id detail (make-pointer 0))))
433 as tmp = params then (sap+ tmp +gvalue-size+)
435 do (gvalue-unset tmp)))))))
437 (defun signal-emit-with-detail (object signal detail &rest args)
438 (let* ((signal-id (ensure-signal-id signal object))
440 (gethash signal-id *signal-emit-functions*)
442 (gethash signal-id *signal-emit-functions*)
443 (create-signal-emit-function signal-id)))))
444 (apply function detail object args)))
446 (defun signal-emit (object signal &rest args)
447 (apply #'signal-emit-with-detail object signal 0 args))
450 ;;;; Convenient macros
452 (defmacro def-callback-marshal (name (return-type &rest args))
455 collect (if (atom arg) (gensym) (first arg))))
458 collect (if (atom arg) arg (second arg)))))
459 `(defcallback ,name (,return-type ,@(mapcar #'list names types)
460 (callback-id unsigned-int))
461 (invoke-callback callback-id ',return-type ,@names))))
463 (defmacro with-callback-function ((id function) &body body)
464 `(let ((,id (register-callback-function ,function)))
467 (destroy-user-data ,id))))