1 ;; Common Lisp bindings for GTK+ v2.x
2 ;; Copyright 1999-2006 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: interface.lisp,v 1.7 2007/10/17 17:04:15 espen Exp $
28 ;;;; Foreign function call interface
30 (defvar *package-prefix* nil)
32 (defun set-package-prefix (prefix &optional (package *package*))
33 (let ((package (find-package package)))
34 (setq *package-prefix* (delete package *package-prefix* :key #'car))
35 (push (cons package prefix) *package-prefix*))
38 (defun package-prefix (&optional (package *package*))
39 (let ((package (find-package package)))
41 (cdr (assoc package *package-prefix*))
42 (substitute #\_ #\- (string-downcase (package-name package))))))
44 (defun find-prefix-package (prefix)
46 (car (rassoc (string-downcase prefix) *package-prefix* :test #'string=))
47 (find-package (string-upcase prefix))))
49 (defmacro use-prefix (prefix &optional (package *package*))
50 `(eval-when (:compile-toplevel :load-toplevel :execute)
51 (set-package-prefix ,prefix ,package)))
54 (defun default-alien-fname (lisp-name)
55 (let* ((name (substitute #\_ #\- (string-downcase lisp-name)))
56 (start (position-if-not #'(lambda (char) (char= char #\%)) name))
57 (end (if (string= "_p" name :start2 (- (length name) 2))
60 (stripped-name (subseq name start end))
61 (prefix (package-prefix *package*)))
62 (if (or (not prefix) (string= prefix ""))
64 (format nil "~A_~A" prefix stripped-name))))
66 (defun default-alien-type-name (type-name)
67 (let ((prefix (package-prefix *package*)))
73 (cons prefix (split-string (symbol-name type-name) :delimiter #\-))))))
75 (defun default-type-name (alien-name)
79 (split-string-if alien-name #'upper-case-p))))
81 (concatenate-strings (rest parts) #\-)
82 (find-prefix-package (first parts)))))
85 (defun in-arg-p (style)
86 (find style '(:in :in/out :in/return :in-out :return)))
88 (defun out-arg-p (style)
89 (find style '(:out :in/out :in-out)))
91 (defun return-arg-p (style)
92 (find style '(:in/return :return)))
94 (defmacro defbinding (name lambda-list return-type &rest args)
95 (multiple-value-bind (lisp-name c-name)
97 (values name (default-alien-fname name))
100 (let* ((lambda-list-supplied-p lambda-list)
101 (lambda-list (unless (equal lambda-list '(nil)) lambda-list))
104 (doc-string (when (stringp (first args)) (pop args)))
109 (expr type &optional (style :in) (out-type type))
114 ((find style '(:in-out :return))
115 (warn "Deprecated argument style: ~S" style))
116 ((not (find style '(:in :out :in/out :in/return)))
117 (error "Bogus argument style: ~S" style)))
119 (not lambda-list-supplied-p)
120 (namep expr) (in-arg-p style)
121 (not (find expr lambda-list)))
122 (push expr lambda-list)
123 (push type arg-types))
124 (let ((aux (unless (or (not (in-arg-p style)) (namep expr))
127 (push (list aux expr) aux-bindings))
130 ((and (namep expr) (not (in-arg-p style))) expr)
131 ((namep expr) (make-symbol (string expr)))
133 (or aux expr) type style out-type))))
136 (%defbinding c-name lisp-name
137 (if lambda-list-supplied-p lambda-list (nreverse lambda-list))
138 (not lambda-list-supplied-p) (nreverse arg-types)
139 aux-bindings return-type doc-string parsed-args))))
143 (defun foreign-funcall (cname args return-type)
145 for (var expr type style out-type) in args
146 collect (if (out-arg-p style)
150 for (var expr type style out-type) in args
151 collect (if (out-arg-p style)
152 `(* ,(alien-type out-type))
153 (alien-type out-type))))
154 (fname (make-symbol cname)))
155 `(with-alien ((,fname (function ,(alien-type return-type) ,@ftypes) :extern ,cname))
156 (alien-funcall ,fname ,@fparams))))
159 (defun foreign-funcall (cname args return-type)
160 (let* ((fparams (loop
161 for (var expr type style out-type) in args
162 collect (if (out-arg-p style)
163 `(ffi:c-var-address ,var)
166 for (var expr type style out-type) in args
167 collect (list var (if (out-arg-p style)
169 (alien-type out-type)))))
170 (c-function `(ffi:c-function
172 (:return-type ,(alien-type return-type))
176 (ffi::foreign-library-function
177 ,cname (ffi::foreign-library :default) #?(clisp>= 2 40)nil
178 nil (ffi:parse-c-type ',c-function)))
182 ;; TODO: check if in and out types (if different) translates to same
184 (defun %defbinding (cname lisp-name lambda-list declare-p arg-types aux-bindings return-type doc args)
186 for (var expr type style out-type) in args
187 when (or (out-arg-p style) (return-arg-p style))
188 collect (from-alien-form out-type var)))
189 (fcall (from-alien-form return-type
190 (foreign-funcall cname args return-type))))
192 (labels ((create-wrapper (args body)
194 (destructuring-bind (var expr type style out-type) (first args)
195 (declare (ignore out-type))
196 (alien-arg-wrapper type var expr style
197 (create-wrapper (rest args) body)))
204 ,(mapcar #'argument-type arg-types)
206 ,@(when return-type (list (return-type return-type)))
208 for (var expr type style out-type) in args
209 when (out-arg-p style)
210 collect (return-type out-type)
211 when (return-arg-p style)
212 collect (return-type type)))))))
213 (defun ,lisp-name ,lambda-list
217 (create-wrapper args `(values ,fcall ,@out))
218 (create-wrapper args `(progn ,fcall (values ,@out))))))))))
222 ;;;; Dynamic (runtime) bindings
224 (defun mkbinding (name return-type &rest arg-types)
225 #+cmu(declare (optimize (inhibit-warnings 3)))
226 #+sbcl(declare (muffle-conditions compiler-note))
229 `(function ,@(mapcar #'alien-type (cons return-type arg-types)))
232 (:arguments ,@(mapcar
234 (list (gensym) (alien-type type)))
236 (:return-type ,(alien-type return-type))
240 (handler-bind (#+sbcl(compiler-note #'(lambda (condition)
241 (declare (ignore condition))
244 (make-heap-alien-info
245 :type (parse-alien-type c-function #+sbcl nil)
246 :sap-form (let ((address (foreign-symbol-address name)))
248 (integer (int-sap address))
249 (system-area-pointer address))))))
251 (ffi::foreign-library-function name
252 (ffi::foreign-library :default) #?(clisp>= 2 40)nil
253 nil (ffi:parse-c-type c-function)))
254 (return-value-translator (from-alien-function return-type)))
255 (multiple-value-bind (arg-translators cleanup-funcs)
256 (let ((translator/cleanup-pairs
259 (multiple-value-list (to-alien-function type)))
262 (mapcar #'first translator/cleanup-pairs)
263 (mapcar #'second translator/cleanup-pairs)))
264 #'(lambda (&rest args)
265 (let ((translated-args (mapcar #'funcall arg-translators args)))
267 (funcall return-value-translator
268 #+(or cmu sbcl)(apply #'alien-funcall foreign translated-args)
269 #+clisp(apply foreign translated-args))
271 #'(lambda (cleanup arg translated-arg)
273 (funcall cleanup arg translated-arg)))
274 cleanup-funcs args translated-args)))))))
280 (defun callback-body (args return-type body)
281 (labels ((create-wrappers (args body)
283 (destructuring-bind (var type) (first args)
284 (callback-wrapper type var var
285 (create-wrappers (rest args) body)))
287 (create-body (args body)
288 (to-alien-form return-type
289 (create-wrappers args `(progn ,@body)))))
290 (if (and (consp (first body)) (eq (caar body) 'declare))
292 for declaration in (cdar body)
293 when (eq (first declaration) 'ignore)
294 nconc (rest declaration))))
297 (remove-if #'(lambda (arg)
298 (find (first arg) ignored))
301 (list (create-body args body)))))
305 (defmacro define-callback (name return-type args &body body)
306 (let ((define-callback
307 #+cmu'alien:def-callback
308 #+(and sbcl alien-callbacks)'sb-alien::define-alien-callback
309 #+(and sbcl (not alien-callbacks))'sb-alien:define-alien-function)
310 (args (mapcar #'(lambda (arg)
311 (if (atom arg) (list arg arg) arg))
314 #+cmu(defparameter ,name nil)
315 (,define-callback ,name
316 #+(and sbcl alien-callbacks) ,(alien-type return-type)
317 (#+(or cmu (and sbcl (not alien-callbacks))),(alien-type return-type)
319 for (name type) in args
320 collect `(,name ,(alien-type type))))
321 ,@(callback-body args return-type body)))))
324 (defun callback-address (callback)
325 #+cmu(alien::callback-trampoline callback)
326 #+(and sbcl (not alien-callbacks))(sb-alien:alien-function-sap callback)
327 #+(and sbcl alien-callbacks)(sb-alien:alien-sap callback))
331 #-alien-callbacks'sb-alien:alien-function
332 #+alien-callbacks'sb-alien:alien)
335 ;;; The callback code for CLISP is based on code from CFFI
336 ;;; Copyright (C) 2005, James Bielman <jamesjb@jamesjb.com>
337 ;;; (C) 2005, Joerg Hoehle <hoehle@users.sourceforge.net>
340 ;;; *CALLBACKS* contains the callbacks defined by the %DEFCALLBACK
341 ;;; macro. The symbol naming the callback is the key, and the value
342 ;;; is a list containing a Lisp function, the parsed CLISP FFI type of
343 ;;; the callback, and a saved pointer that should not persist across
347 (defvar *callbacks* (make-hash-table))
349 ;;; Return a CLISP FFI function type for a CFFI callback function
350 ;;; given a return type and list of argument names and types.
351 (eval-when (:compile-toplevel :load-toplevel :execute)
352 (defun callback-type (return-type arg-names arg-types)
355 (:arguments ,@(mapcar (lambda (sym type)
356 (list sym (alien-type type)))
357 arg-names arg-types))
358 (:return-type ,(alien-type return-type))
359 (:language :stdc)))))
361 ;;; Register and create a callback function.
362 (defun register-callback (name function parsed-type)
363 (setf (gethash name *callbacks*)
364 (list function parsed-type
365 (ffi:with-foreign-object (ptr 'ffi:c-pointer)
366 ;; Create callback by converting Lisp function to foreign
367 (setf (ffi:memory-as ptr parsed-type) function)
368 (ffi:foreign-value ptr)))))
370 ;;; Restore all saved callback pointers when restarting the Lisp
371 ;;; image. This is pushed onto CUSTOM:*INIT-HOOKS*.
372 ;;; Needs clisp > 2.35, bugfix 2005-09-29
373 (defun restore-callback-pointers ()
376 (register-callback name (first list) (second list)))
379 ;;; Add RESTORE-CALLBACK-POINTERS to the lists of functions to run
380 ;;; when an image is restarted.
381 (eval-when (:load-toplevel :execute)
382 (pushnew 'restore-callback-pointers custom:*init-hooks*))
384 ;;; Define a callback function NAME to run BODY with arguments
385 ;;; ARG-NAMES translated according to ARG-TYPES and the return type
386 ;;; translated according to RETTYPE. Obtain a pointer that can be
387 ;;; passed to C code for this callback by calling %CALLBACK.
388 (defmacro define-callback (name return-type args &body body)
389 (let* ((args (mapcar #'(lambda (arg)
390 (if (atom arg) (list arg arg) arg))
392 (arg-names (mapcar #'first args))
393 (arg-types (mapcar #'second args)))
395 (defvar ,name ',name)
396 (register-callback ',name
397 (lambda ,arg-names ,@(callback-body args return-type body))
398 ,(callback-type return-type arg-names arg-types)))))
400 ;;; Look up the name of a callback and return a pointer that can be
401 ;;; passed to a C function. Signals an error if no callback is
402 ;;; defined called NAME.
403 (defun callback-address (name)
404 (multiple-value-bind (list winp) (gethash name *callbacks*)
406 (error "Undefined callback: ~S" name))
409 (deftype callback () 'symbol))
415 (defun type-expand-1 (form)
417 (let ((def (cond ((symbolp form)
418 #+cmu(kernel::info type expander form)
419 #+sbcl(sb-impl::info :type :expander form))
420 ((and (consp form) (symbolp (car form)))
421 #+cmu(kernel::info type expander (car form))
422 #+sbcl(sb-impl::info :type :expander (car form)))
425 (values (funcall def (if (consp form) form (list form))) t)
427 #+clisp(ext:type-expand form t))
429 (defun type-expand-to (type form)
430 (labels ((expand (form0)
431 (if (eq (first (mklist form0)) type)
433 (multiple-value-bind (expanded-form expanded-p)
434 (type-expand-1 form0)
436 (expand expanded-form)
437 (error "~A can not be expanded to ~A" form type))))))
444 (defun find-type-method (name type-spec &optional (error-p t))
445 (let ((type-methods (get name 'type-methods))
446 (specifier (if (atom type-spec)
450 (gethash specifier type-methods)
453 "No explicit type method for ~A when call width type specifier ~A found"
456 (defun find-next-type-method (name type-spec &optional (error-p t))
457 (let ((type-methods (get name 'type-methods)))
458 (labels ((search-method-in-cpl-order (classes)
461 (gethash (class-name (first classes)) type-methods)
462 (search-method-in-cpl-order (rest classes)))))
463 (lookup-method (type-spec)
464 (if (and (symbolp type-spec) (find-class type-spec nil))
465 (let ((class (find-class type-spec)))
466 #?(or (sbcl>= 0 9 15) (featurep :clisp))
467 (unless (class-finalized-p class)
468 (finalize-inheritance class))
469 (search-method-in-cpl-order
470 (rest (class-precedence-list class))))
471 (multiple-value-bind (expanded-type expanded-p)
472 (type-expand-1 type-spec)
475 (let ((specifier (etypecase expanded-type
476 (symbol expanded-type)
477 (list (first expanded-type)))))
478 (gethash specifier type-methods))
479 (lookup-method expanded-type))))))
480 (search-built-in-type-hierarchy (sub-tree)
481 (when (subtypep type-spec (first sub-tree))
483 (search-nodes (cddr sub-tree))
485 (search-nodes (nodes)
488 as method = (search-built-in-type-hierarchy node)
490 finally (return method))))
492 (lookup-method type-spec)
493 ;; This is to handle unexpandable types whichs doesn't name a
494 ;; class. It may cause infinite loops with illegal
495 ;; call-next-method calls
498 (and (symbolp type-spec) (find-class type-spec nil)))
499 (search-nodes (get name 'built-in-type-hierarchy)))
501 (error "No next type method ~A for type specifier ~A"
504 (defun find-applicable-type-method (name type-spec &optional (error-p t))
506 (find-type-method name type-spec nil)
507 (find-next-type-method name type-spec nil)
510 "No applicable type method for ~A when call width type specifier ~A"
514 (defun insert-type-in-hierarchy (specifier function nodes)
516 ((let ((node (find specifier nodes :key #'first)))
518 (setf (second node) function)
523 (subtypep specifier (first node)))
527 (insert-type-in-hierarchy specifier function (cddr node)))
529 ((let ((sub-nodes (remove-if-not
531 (subtypep (first node) specifier))
534 (list* specifier function sub-nodes)
535 (nset-difference nodes sub-nodes))))))
537 (defun add-type-method (name specifier function)
538 (setf (gethash specifier (get name 'type-methods)) function)
539 (when (typep (find-class specifier nil) 'built-in-class)
540 (setf (get name 'built-in-type-hierarchy)
541 (insert-type-in-hierarchy specifier function
542 (get name 'built-in-type-hierarchy)))))
545 (defmacro define-type-generic (name lambda-list &optional documentation)
546 (let ((type-spec (first lambda-list)))
549 (find type-spec '(&optional &key &rest &allow-other-keys)))
550 (error "A type generic needs at least one required argument")
552 (unless (get ',name 'type-methods)
553 (setf (get ',name 'type-methods) (make-hash-table))
554 (setf (get ',name 'built-in-type-hierarchy) ()))
555 ,(if (intersection '(&optional &key &rest &allow-other-keys) lambda-list)
556 (let ((args (make-symbol "ARGS")))
557 `(defun ,name (,type-spec &rest ,args)
560 (find-applicable-type-method ',name ,type-spec)
562 `(defun ,name ,lambda-list
565 (find-applicable-type-method ',name ,type-spec)
569 (defmacro define-type-method (name lambda-list &body body)
570 (let ((specifier (cadar lambda-list))
571 (args (make-symbol "ARGS")))
573 (add-type-method ',name ',specifier
574 #'(lambda (&rest ,args)
575 (flet ((call-next-method (&rest args)
576 (let ((next-method (find-next-type-method ',name ',specifier)))
577 (apply next-method (or args ,args)))))
578 (destructuring-bind (,(caar lambda-list) ,@(rest lambda-list)) ,args
583 ;;; Rules for auto-exporting symbols
585 (defexport defbinding (name &rest args)
586 (declare (ignore args))
591 (defexport define-type-generic (name &rest args)
592 (declare (ignore args))