racket/collects/scribblings/foreign/foreign.scrbl
2010-04-26 18:05:29 -06:00

29 lines
874 B
Racket

#lang scribble/doc
@(require "utils.ss")
@title{@bold{FFI}: Racket Foreign Interface}
@author["Eli Barzilay"]
@defmodule[ffi/unsafe #:use-sources ('#%foreign)]
The @schememodname[ffi/unsafe] library enables the direct use of
C-based APIs within Racket programs---without writing any new C
code. From the Racket perspective, functions and data with a C-based
API are @idefterm{foreign}, hence the term @defterm{foreign
interface}. Furthermore, since most APIs consist mostly of functions,
the foreign interface is sometimes called a @defterm{foreign function
interface}, abbreviated @deftech{FFI}.
@table-of-contents[]
@include-section["intro.scrbl"]
@include-section["libs.scrbl"]
@include-section["types.scrbl"]
@include-section["pointers.scrbl"]
@include-section["derived.scrbl"]
@include-section["misc.scrbl"]
@include-section["unexported.scrbl"]
@index-section[]