src/package.lisp

   1 ;;;; -*- Mode: lisp; indent-tabs-mode: nil -*-
   2 ;;;
   3 ;;; package.lisp --- Package definition for CFFI.
   4 ;;;
   5 ;;; Copyright (C) 2005, James Bielman  <jamesjb@jamesjb.com>
   6 ;;;
   7 ;;; Permission is hereby granted, free of charge, to any person
   8 ;;; obtaining a copy of this software and associated documentation
   9 ;;; files (the "Software"), to deal in the Software without
  10 ;;; restriction, including without limitation the rights to use, copy,
  11 ;;; modify, merge, publish, distribute, sublicense, and/or sell copies
  12 ;;; of the Software, and to permit persons to whom the Software is
  13 ;;; furnished to do so, subject to the following conditions:
  14 ;;;
  15 ;;; The above copyright notice and this permission notice shall be
  16 ;;; included in all copies or substantial portions of the Software.
  17 ;;;
  18 ;;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  19 ;;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20 ;;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21 ;;; NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  22 ;;; HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23 ;;; WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24 ;;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25 ;;; DEALINGS IN THE SOFTWARE.
  26 ;;;
  27
  28 (defpackage #:cffi
  29   (:use #:common-lisp #:cffi-sys)
  30   (:export
  31    ;; Primitive pointer operations.
  32    #:foreign-free
  33    #:foreign-alloc
  34    #:foreign-aref
  35    #:mem-ref
  36    #:pointerp
  37    #:null-ptr
  38    #:null-ptr-p
  39    #:inc-ptr
  40    #:with-foreign-ptr
  41
  42    ;; Shareable vectors.
  43    #:make-shareable-vector
  44    #:with-pointer-to-vector-data
  45
  46    ;; Foreign string operations.
  47    #:foreign-string-alloc
  48    #:foreign-string-free
  49    #:foreign-string-to-lisp
  50    #:lisp-string-to-foreign
  51    #:with-foreign-string
  52    #:with-foreign-ptr-as-string
  53
  54    ;; Foreign function operations.
  55    #:defcfun
  56    #:foreign-funcall
  57    #:load-foreign-library
  58
  59    ;; Foreign type operations.
  60    #:defcstruct
  61    #:defctype
  62    #:defcenum
  63    #:define-type-translator
  64    #:foreign-enum-keyword
  65    #:foreign-enum-value
  66    #:foreign-object-alloc
  67    #:foreign-object-free
  68    #:foreign-slot-value
  69    #:foreign-type-alignment
  70    #:foreign-type-size
  71    #:with-foreign-object
  72    #:with-foreign-slots))