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.3 2006/08/16 11:02:45 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))
103 (doc-string (when (stringp (first args)) (pop args)))
108 (expr type &optional (style :in) (out-type type)) arg
110 ((find style '(:in-out :return))
111 (warn "Deprecated argument style: ~S" style))
112 ((not (find style '(:in :out :in/out :in/return)))
113 (error "Bogus argument style: ~S" style)))
115 (not lambda-list-supplied-p)
116 (namep expr) (in-arg-p style))
117 (push expr lambda-list))
118 (let ((aux (unless (or (not (in-arg-p style)) (namep expr))
121 (push `(,aux ,expr) aux-vars))
124 ((and (namep expr) (not (in-arg-p style))) expr)
125 ((namep expr) (make-symbol (string expr)))
127 (or aux expr) type style out-type))))
130 (%defbinding c-name lisp-name
131 (if lambda-list-supplied-p lambda-list (nreverse lambda-list))
132 aux-vars return-type doc-string parsed-args))))
136 (defun foreign-funcall (cname args return-type)
138 for (var expr type style out-type) in args
139 collect (if (out-arg-p style)
143 for (var expr type style out-type) in args
144 collect (if (out-arg-p style)
145 `(* ,(alien-type out-type))
146 (alien-type out-type))))
147 (fname (make-symbol cname)))
148 `(with-alien ((,fname (function ,(alien-type return-type) ,@ftypes) :extern ,cname))
149 (alien-funcall ,fname ,@fparams))))
152 (defun foreign-funcall (cname args return-type)
153 (let* ((fparams (loop
154 for (var expr type style out-type) in args
155 collect (if (out-arg-p style)
156 `(ffi:c-var-address ,var)
159 for (var expr type style out-type) in args
160 collect (list var (if (out-arg-p style)
162 (alien-type out-type)))))
163 (c-function `(ffi:c-function
165 (:return-type ,(alien-type return-type))
169 (ffi::foreign-library-function ,cname (ffi::foreign-library :default)
170 nil (ffi:parse-c-type ',c-function)))
174 ;; TODO: check if in and out types (if different) translates to same
176 (defun %defbinding (cname lisp-name lambda-list aux-vars return-type doc args)
178 for (var expr type style out-type) in args
179 when (or (out-arg-p style) (return-arg-p style))
180 collect (from-alien-form out-type var)))
181 (fcall (from-alien-form return-type
182 (foreign-funcall cname args return-type))))
184 (labels ((create-wrapper (args body)
186 (destructuring-bind (var expr type style out-type) (first args)
187 (declare (ignore out-type))
188 (alien-arg-wrapper type var expr style
189 (create-wrapper (rest args) body)))
191 `(defun ,lisp-name ,lambda-list
195 (create-wrapper args `(values ,fcall ,@out))
196 (create-wrapper args `(progn ,fcall (values ,@out)))))))))
200 ;;;; Dynamic (runtime) bindings
202 (defun mkbinding (name return-type &rest arg-types)
203 #+cmu(declare (optimize (inhibit-warnings 3)))
204 #+sbcl(declare (muffle-conditions compiler-note))
207 `(function ,@(mapcar #'alien-type (cons return-type arg-types)))
210 (:arguments ,@(mapcar
212 (list (gensym) (alien-type type)))
214 (:return-type ,(alien-type return-type))
218 (handler-bind (#+sbcl(compiler-note #'(lambda (condition)
219 (declare (ignore condition))
222 (make-heap-alien-info
223 :type (parse-alien-type c-function #+sbcl nil)
224 :sap-form (let ((address (foreign-symbol-address name)))
226 (integer (int-sap address))
227 (system-area-pointer address))))))
229 (ffi::foreign-library-function name
230 (ffi::foreign-library :default)
231 nil (ffi:parse-c-type c-function)))
232 (return-value-translator (from-alien-function return-type)))
233 (multiple-value-bind (arg-translators cleanup-funcs)
234 (let ((translator/cleanup-pairs
237 (multiple-value-list (to-alien-function type)))
240 (mapcar #'first translator/cleanup-pairs)
241 (mapcar #'second translator/cleanup-pairs)))
242 #'(lambda (&rest args)
243 (let ((translated-args (mapcar #'funcall arg-translators args)))
245 (funcall return-value-translator
246 #+(or cmu sbcl)(apply #'alien-funcall foreign translated-args)
247 #+clisp(apply foreign translated-args))
249 #'(lambda (cleanup arg translated-arg)
251 (funcall cleanup arg translated-arg)))
252 cleanup-funcs args translated-args)))))))
258 (defun callback-body (args return-type body)
259 (labels ((create-wrappers (args body)
261 (destructuring-bind (var type) (first args)
262 (callback-wrapper type var var
263 (create-wrappers (rest args) body)))
265 (create-body (args body)
266 (to-alien-form return-type
267 (create-wrappers args `(progn ,@body)))))
268 (if (and (consp (first body)) (eq (caar body) 'declare))
270 for declaration in (cdar body)
271 when (eq (first declaration) 'ignore)
272 nconc (rest declaration))))
275 (remove-if #'(lambda (arg)
276 (find (first arg) ignored))
279 (list (create-body args body)))))
283 (defmacro define-callback (name return-type args &body body)
284 (let ((define-callback
285 #+cmu'alien:def-callback
286 #+(and sbcl alien-callbacks)'sb-alien::define-alien-callback
287 #+(and sbcl (not alien-callbacks))'sb-alien:define-alien-function))
289 #+cmu(defparameter ,name nil)
290 (,define-callback ,name
291 #+(and sbcl alien-callbacks) ,(alien-type return-type)
292 (#+(or cmu (and sbcl (not alien-callbacks))),(alien-type return-type)
294 for (name type) in args
295 collect `(,name ,(alien-type type))))
296 ,@(callback-body args return-type body)))))
299 (defun callback-address (callback)
300 #+cmu(alien::callback-trampoline callback)
301 #+(and sbcl (not alien-callbacks))(sb-alien:alien-function-sap callback)
302 #+(and sbcl alien-callbacks)(sb-alien:alien-sap callback))
306 #-alien-callbacks'sb-alien:alien-function
307 #+alien-callbacks'sb-alien:alien)
310 ;;; The callback code for CLISP is based on code from CFFI
311 ;;; Copyright (C) 2005, James Bielman <jamesjb@jamesjb.com>
312 ;;; (C) 2005, Joerg Hoehle <hoehle@users.sourceforge.net>
315 ;;; *CALLBACKS* contains the callbacks defined by the %DEFCALLBACK
316 ;;; macro. The symbol naming the callback is the key, and the value
317 ;;; is a list containing a Lisp function, the parsed CLISP FFI type of
318 ;;; the callback, and a saved pointer that should not persist across
322 (defvar *callbacks* (make-hash-table))
324 ;;; Return a CLISP FFI function type for a CFFI callback function
325 ;;; given a return type and list of argument names and types.
326 (eval-when (:compile-toplevel :load-toplevel :execute)
327 (defun callback-type (return-type arg-names arg-types)
330 (:arguments ,@(mapcar (lambda (sym type)
331 (list sym (alien-type type)))
332 arg-names arg-types))
333 (:return-type ,(alien-type return-type))
334 (:language :stdc)))))
336 ;;; Register and create a callback function.
337 (defun register-callback (name function parsed-type)
338 (setf (gethash name *callbacks*)
339 (list function parsed-type
340 (ffi:with-foreign-object (ptr 'ffi:c-pointer)
341 ;; Create callback by converting Lisp function to foreign
342 (setf (ffi:memory-as ptr parsed-type) function)
343 (ffi:foreign-value ptr)))))
345 ;;; Restore all saved callback pointers when restarting the Lisp
346 ;;; image. This is pushed onto CUSTOM:*INIT-HOOKS*.
347 ;;; Needs clisp > 2.35, bugfix 2005-09-29
348 (defun restore-callback-pointers ()
351 (register-callback name (first list) (second list)))
354 ;;; Add RESTORE-CALLBACK-POINTERS to the lists of functions to run
355 ;;; when an image is restarted.
356 (eval-when (:load-toplevel :execute)
357 (pushnew 'restore-callback-pointers custom:*init-hooks*))
359 ;;; Define a callback function NAME to run BODY with arguments
360 ;;; ARG-NAMES translated according to ARG-TYPES and the return type
361 ;;; translated according to RETTYPE. Obtain a pointer that can be
362 ;;; passed to C code for this callback by calling %CALLBACK.
363 (defmacro define-callback (name return-type args &body body)
364 (let ((arg-names (mapcar #'first args))
365 (arg-types (mapcar #'second args)))
367 (defvar ,name ',name)
368 (register-callback ',name
369 (lambda ,arg-names ,@(callback-body args return-type body))
370 ,(callback-type return-type arg-names arg-types)))))
372 ;;; Look up the name of a callback and return a pointer that can be
373 ;;; passed to a C function. Signals an error if no callback is
374 ;;; defined called NAME.
375 (defun callback-address (name)
376 (multiple-value-bind (list winp) (gethash name *callbacks*)
378 (error "Undefined callback: ~S" name))
381 (deftype callback () 'symbol))
387 (defun type-expand-1 (form)
389 (let ((def (cond ((symbolp form)
390 #+cmu(kernel::info type expander form)
391 #+sbcl(sb-impl::info :type :expander form))
392 ((and (consp form) (symbolp (car form)))
393 #+cmu(kernel::info type expander (car form))
394 #+sbcl(sb-impl::info :type :expander (car form)))
397 (values (funcall def (if (consp form) form (list form))) t)
399 #+clisp(ext:type-expand form t))
401 (defun type-expand-to (type form)
402 (labels ((expand (form0)
403 (if (eq (first (mklist form0)) type)
405 (multiple-value-bind (expanded-form expanded-p)
406 (type-expand-1 form0)
408 (expand expanded-form)
409 (error "~A can not be expanded to ~A" form type))))))
416 (defun find-next-type-method (name type-spec &optional (error-p t))
417 (let ((type-methods (get name 'type-methods)))
418 (labels ((search-method-in-cpl-order (classes)
421 (gethash (class-name (first classes)) type-methods)
422 (search-method-in-cpl-order (rest classes)))))
423 (lookup-method (type-spec)
424 (if (and (symbolp type-spec) (find-class type-spec nil))
425 (let ((class (find-class type-spec)))
426 #?(or (sbcl>= 0 9 15) (featurep :clisp))
427 (unless (class-finalized-p class)
428 (finalize-inheritance class))
429 (search-method-in-cpl-order
430 (rest (class-precedence-list class))))
431 (multiple-value-bind (expanded-type expanded-p)
432 (type-expand-1 type-spec)
435 (let ((specifier (etypecase expanded-type
436 (symbol expanded-type)
437 (list (first expanded-type)))))
438 (gethash specifier type-methods))
439 (lookup-method expanded-type))))))
440 (search-built-in-type-hierarchy (sub-tree)
441 (when (subtypep type-spec (first sub-tree))
443 (search-nodes (cddr sub-tree))
445 (search-nodes (nodes)
448 as method = (search-built-in-type-hierarchy node)
450 finally (return method))))
452 (lookup-method type-spec)
453 ;; This is to handle unexpandable types whichs doesn't name a
454 ;; class. It may cause infinite loops with illegal
455 ;; call-next-method calls
456 (unless (and (symbolp type-spec) (find-class type-spec nil))
457 (search-nodes (get name 'built-in-type-hierarchy)))
459 (error "No next type method ~A for type specifier ~A"
462 (defun find-applicable-type-method (name type-spec &optional (error-p t))
463 (let ((type-methods (get name 'type-methods))
464 (specifier (if (atom type-spec)
468 (gethash specifier type-methods)
469 (find-next-type-method name type-spec nil)
472 "No applicable type method for ~A when call width type specifier ~A"
475 (defun insert-type-in-hierarchy (specifier function nodes)
477 ((let ((node (find specifier nodes :key #'first)))
479 (setf (second node) function)
484 (subtypep specifier (first node)))
488 (insert-type-in-hierarchy specifier function (cddr node)))
490 ((let ((sub-nodes (remove-if-not
492 (subtypep (first node) specifier))
495 (list* specifier function sub-nodes)
496 (nset-difference nodes sub-nodes))))))
498 (defun add-type-method (name specifier function)
499 (setf (gethash specifier (get name 'type-methods)) function)
500 (when (typep (find-class specifier nil) 'built-in-class)
501 (setf (get name 'built-in-type-hierarchy)
502 (insert-type-in-hierarchy specifier function
503 (get name 'built-in-type-hierarchy)))))
506 (defmacro define-type-generic (name lambda-list &optional documentation)
507 (let ((type-spec (first lambda-list)))
510 (find type-spec '(&optional &key &rest &allow-other-keys)))
511 (error "A type generic needs at least one required argument")
513 (unless (get ',name 'type-methods)
514 (setf (get ',name 'type-methods) (make-hash-table))
515 (setf (get ',name 'built-in-type-hierarchy) ()))
516 ,(if (intersection '(&optional &key &rest &allow-other-keys) lambda-list)
517 (let ((args (make-symbol "ARGS")))
518 `(defun ,name (,type-spec &rest ,args)
521 (find-applicable-type-method ',name ,type-spec)
523 `(defun ,name ,lambda-list
526 (find-applicable-type-method ',name ,type-spec)
530 (defmacro define-type-method (name lambda-list &body body)
531 (let ((specifier (cadar lambda-list))
532 (args (make-symbol "ARGS")))
534 (add-type-method ',name ',specifier
535 #'(lambda (&rest ,args)
536 (flet ((call-next-method (&rest args)
537 (let ((next-method (find-next-type-method ',name ',specifier)))
538 (apply next-method (or args ,args)))))
539 (destructuring-bind (,(caar lambda-list) ,@(rest lambda-list)) ,args
544 ;;; Rules for auto-exporting symbols
546 (defexport defbinding (name &rest args)
547 (declare (ignore args))
552 (defexport define-type-generic (name &rest args)
553 (declare (ignore args))