descriptionForeign Structures By Value
ownerlhealy@common-lisp.net
last changeWed, 27 Feb 2013 06:51:54 +0000
Content tags:
Add:
readme
FSBV, Foreign Structures By Value

OBSOLETE

FSBV is obsolete as of 2013-02-25. The functionality has been ported to make the cffi-libffi system included in CFFI as of release 0.11.0. The interface is simpler and better integrated into CFFI, but anything written using FSBV will need to be recoded. FSBV is no longer maintained.

OBSOLETE


Name

Foreign Structures By Value (FSBV)

Description

Call foreign functions when one or more arguments and/or the return value are structures. In CFFI and most Lisp foreign interfaces, structures must be passed by reference, that is, as pointers. FSBV permits calling them by value. It requires CFFI and libffi.

Example

For example, the complex type is defined in the GNU Scientific Library (GSL) as

typedef struct
  {
    double dat[2];
  }
gsl_complex;

The function gsl_complex_conjugate takes and returns a structure of this type by value,

gsl_complex gsl_complex_conjugate (gsl_complex z);

If we define

(defcstruct (complex :constructor complex :deconstructor (realpart imagpart))
  (dat :double :count 2))
(defcfun (complex-conjugate "gsl_complex_conjugate") complex
  (c complex))
then we can call this function from Lisp:
(complex-conjugate #c(3.0d0 4.0d0))
#C(3.0 -4.0)

Definitions

The following definitions provide the call by value capability, and provide a convenient way of making equivalent Lisp and foreign objects:

There are also functions fsbv:object and (setf fsbv:object) that create the Lisp object from the foreign pointer and type, and vice versa. They are used internally but are exported for the convenience of users. When FSBV is loaded, it will put :fsbv in *features*.

Note: all arguments to the function, and the return value, will gain an additional layer of indirection. This means that arguments normally sent by reference (as a pointer) will require a pointer to the pointer.

Installation note

Because different platforms and package managers install libffi in different places, it is hard to provide the proper path to ffi.h for every installation. If the file is not found, you will need to find it yourself (try pkg-config --cflags-only-I libffi) and specify the path in a cc-flags form in libffi-unix.lisp; note the Darwin example there. If yours is a common installation/platform and the path is not highly specific to a libffi version number (e.g. nothing like /usr/lib64/libffi-3.0.8/include which will be obsolete when 3.0.9 is installed), send the form to me at the address below and I will incorporate it into the file.

Copying

Copyright © 2009, 2010 Liam Healy <lhealy at common-lisp.net>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.



Time-stamp: <2013-02-26 22:48:11PST readme.html>
shortlog
2013-02-27 Liam M. HealyMark FSBV as obsoletemaster
2011-08-19 Liam M. HealyPush name onto *converter-types* in expanded form
2010-11-30 Liam M. HealySplit init.lisp into pkgdcl.lisp and init.lisp
2010-11-28 Liam HealyConversion between foreign and CL objects in its own...
2010-07-08 Liam M. HealyAccept an index to foreign-object-components and its...
2010-06-11 Liam M. HealyDon't make a defun if the function name is apparently...
2009-10-19 Liam HealyAdd "Installation note" about lost header files0.2
2009-08-23 Liam HealyHandle conditional cflags in the grovel file
2009-08-22 Liam HealyAdd include path for OSX
2009-08-19 Liam HealyRemove non-existent cbuiltin
2009-05-19 Liam HealyDirect get/set simple structure slots
2009-05-12 Liam HealyAdd support for OS X
2009-05-04 Liam HealyFunction defined-type-p
2009-05-03 Liam HealyBreak out defcfun-args-from-ff-args as a separate function0.1
2009-05-03 Liam HealyAdd :fsbv to *features*, rename/export error
2009-05-03 Liam HealyFix HTML fomatting
...
tags
5 years ago 0.2 Release 0.2.0
5 years ago 0.1 Release 0.1.0
heads
20 months ago master
3 years ago experimental
3 years ago convert