CFFI User Manual - Common Lisp.net

More documents

Recommendations

Info

Copyright c○ 2005 James Bielman Copyright c○ 2005-2010 Luís Oliveira Copyright c○ 2005-2006 Dan Knapp Copyright c○ 2005-2006 Emily Backes Copyright c○ 2006 Stephen Compall 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.
i Table of Contents 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 3 Implementation Support . . . . . . . . . . . . . . . . . . . . . . . 3 3.1 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4 An Introduction to Foreign Interfaces and CFFI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 4.1 What makes Lisp different. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 4.2 Getting a URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.3 Loading foreign libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.4 Initializing libcurl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 4.5 Setting download options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 4.6 Breaking the abstraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 4.7 Option functions in Lisp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4.8 Memory management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4.9 Calling Lisp from C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 4.10 A complete FFI? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.11 Defining new types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.12 What’s next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5 Wrapper generators . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 6 Foreign Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 6.1 Built-In Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 6.2 Other Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 6.3 Defining Foreign Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 6.4 Foreign Type Translators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 6.5 Optimizing Type Translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.6 Foreign Structure Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.7 Allocating Foreign Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 7 Pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 7.1 Basic Pointer Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 7.2 Allocating Foreign Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 7.3 Accessing Foreign Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 8 Strings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Page 1: CFFI User Manual
Page 5 and 6: Chapter 1: Introduction 1 1 Introdu
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 53 and 54:
Chapter 6: Foreign Types 49 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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?