CFFI User Manual - Common Lisp.net

More documents

Recommendations

Info

9 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 ii 10 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 11 Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 11.1 Defining a library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 11.2 Library definition style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 12 Callbacks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 13 The Groveller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 13.1 Building FFIs with CFFI-Grovel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 13.2 Specification File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 13.3 ASDF Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 13.4 Implementation Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 14 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Appendix A Platform-specific features. . . . . . . 119 Appendix B Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . 120 Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Chapter 1: Introduction 1 1 Introduction CFFI is the Common Foreign Function Interface for ANSI Common Lisp systems. By foreign function we mean a function written in another programming language and having different data and calling conventions than Common Lisp, namely, C. CFFI allows you to call foreign functions and access foreign variables, all without leaving the Lisp image. We consider this manual ever a work in progress. If you have difficulty with anything CFFI-specific presented in the manual, please contact the developers with details. Motivation See Section 4.1 [What makes Lisp different], page 4, for an argument in favor of FFI in general. CFFI’s primary role in any image is to mediate between Lisp developers and the widely varying FFIs present in the various Lisp implementations it supports. With CFFI, you can define foreign function interfaces while still maintaining portability between implementations. It is not the first Common Lisp package with this objective; however, it is meant to be a more malleable framework than similar packages. Design Philosophy • Pointers do not carry around type information. Instead, type information is supplied when pointers are dereferenced. • A type safe pointer interface can be developed on top of an untyped one. It is difficult to do the opposite. • Functions are better than macros. When a macro could be used for performance, use a compiler-macro instead.
Page 1 and 2: CFFI User Manual
Page 3: i Table of Contents 1 Introduction.
Page 7 and 8: Chapter 3: Implementation Support 3
Page 9 and 10: Chapter 4: An Introduction to Forei
Page 25 and 26: Chapter 5: Wrapper generators 21 5
Page 27 and 28: Chapter 6: Foreign Types 23 :int64
Page 29 and 30: Chapter 6: Foreign Types 25 (define
Page 31 and 32: Chapter 6: Foreign Types 27 (defmet
Page 33 and 34: Chapter 6: Foreign Types 29 convert
Page 35 and 36: Chapter 6: Foreign Types 31 defbitf
Page 37 and 38: Chapter 6: Foreign Types 33 defcstr
Page 39 and 40: Chapter 6: Foreign Types 35 defcuni
Page 41 and 42: Chapter 6: Foreign Types 37 defcenu
Page 43 and 44: Chapter 6: Foreign Types 39 define-
Page 45 and 46: Chapter 6: Foreign Types 41 foreign
Page 55 and 56:
Chapter 6: Foreign Types 51 free-tr
Page 57 and 58:
Chapter 6: Foreign Types 53 transla
Page 59 and 60:
Chapter 6: Foreign Types 55 with-fo
Page 61 and 62:
Chapter 7: Pointers 57 7 Pointers A
Page 63 and 64:
Chapter 7: Pointers 59 foreign-free
Page 65 and 66:
Chapter 7: Pointers 61 CFFI> (mem-r
Page 67 and 68:
Chapter 7: Pointers 63 inc-pointer
Page 69 and 70:
Chapter 7: Pointers 65 make-pointer
Page 71 and 72:
Chapter 7: Pointers 67 mem-aref Syn
Page 73 and 74:
Chapter 7: Pointers 69 null-pointer
Page 75 and 76:
Chapter 7: Pointers 71 pointerp Syn
Page 77 and 78:
Chapter 7: Pointers 73 pointer-eq S
Page 79 and 80:
Chapter 7: Pointers 75 with-foreign
Page 81 and 82:
Chapter 8: Strings 77 *default-fore
Page 83 and 84:
Chapter 8: Strings 79 foreign-strin
Page 85 and 86:
Chapter 8: Strings 81 lisp-string-t
Page 87 and 88:
Chapter 8: Strings 83 with-foreign-
Page 89 and 90:
Chapter 9: Variables 85 defcvar Syn
Page 91 and 92:
Chapter 9: Variables 87 get-var-poi
Page 93 and 94:
Chapter 10: Functions 89 defcfun Sy
Page 95 and 96:
Chapter 10: Functions 91 foreign-fu
Page 97 and 98:
Chapter 10: Functions 93 foreign-fu
Page 99 and 100:
Chapter 10: Functions 95 translate-
Page 101 and 102:
Chapter 10: Functions 97 translate-
Page 103 and 104:
Chapter 11: Libraries 99 close-fore
Page 105 and 106:
Chapter 11: Libraries 101 define-fo
Page 107 and 108:
Chapter 11: Libraries 103 *foreign-
Page 109 and 110:
Chapter 11: Libraries 105 load-fore
Page 111 and 112:
Chapter 11: Libraries 107 load-fore
Page 113 and 114:
Chapter 12: Callbacks 109 12 Callba
Page 115 and 116:
Chapter 12: Callbacks 111 defcallba
Page 117 and 118:
Chapter 12: Callbacks 113 get-callb
Page 119 and 120:
Chapter 13: The Groveller 115 The t
Page 121 and 122:
Chapter 13: The Groveller 117 (defp
Page 123 and 124:
Appendix A: Platform-specific featu
Page 125 and 126:
Index 121 Index : :boolean &optiona
Page 127:
Index 123 translate-into-foreign-me
show all

CFFI User Manual - Common Lisp.net

Create successful ePaper yourself

Delete template?

Save as template?