examples/examples.lisp

   1 ;;;; -*- Mode: lisp; indent-tabs-mode: nil -*-
   2 ;;;
   3 ;;; examples.lisp --- Simple test examples of CFFI.
   4 ;;;
   5 ;;; Copyright (C) 2005-2006, 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-examples
  29   (:use #:cl #:cffi)
  30   (:export
  31    #:run-examples
  32    #:sqrtf
  33    #:getenv))
  34
  35 (in-package #:cffi-examples)
  36
  37 ;; A simple libc function.
  38 (defcfun "sqrtf" :float
  39   (n :float))
  40
  41 ;; This definition uses the STRING type translator to automatically
  42 ;; convert Lisp strings to foreign strings and vice versa.
  43 (defcfun "getenv" :string
  44   (name :string))
  45
  46 ;; Calling a varargs function.
  47 (defun sprintf-test ()
  48   "Test calling a varargs function."
  49   (with-foreign-pointer-as-string ((buf buf-size) 255)
  50     (foreign-funcall
  51      "snprintf" :pointer buf :int buf-size
  52      :string "%d %f #x%x!" :int 666
  53      :double (coerce pi 'double-float)
  54      :unsigned-int #xcafebabe
  55      :void)))
  56
  57 ;; Defining an emerated type.
  58 (defcenum test-enum
  59   (:invalid 0)
  60   (:positive 1)
  61   (:negative -1))
  62
  63 ;; Use the absolute value function to test keyword/enum translation.
  64 (defcfun ("abs" c-abs) test-enum
  65   (n test-enum))
  66
  67 (defun cffi-version ()
  68   (asdf:component-version (asdf:find-system 'cffi)))
  69
  70 (defun run-examples ()
  71   (format t "~&;;; CFFI version ~A on ~A ~A:~%"
  72           (cffi-version) (lisp-implementation-type)
  73           (lisp-implementation-version))
  74   (format t "~&;; shell:             ~A~%" (getenv "SHELL"))
  75   (format t "~&;; sprintf test:      ~A~%" (sprintf-test))
  76   (format t "~&;; (c-abs :positive): ~A~%" (c-abs :positive))
  77   (format t "~&;; (c-abs :negative): ~A~%" (c-abs :negative))
  78   (force-output))