suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix uses of _ in foreign docs, and document the _ escape in 'schemblock'

Browse Source 
svn: r10189
This commit is contained in:
Matthew Flatt 2008-06-08 11:46:07 +00:00
parent 31d9571a47
commit ec714113a4
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
collects/scribblings/foreign/types.scrbl
View File

@ -612,7 +612,7 @@ of the super-cstruct can be used with the new sub-cstruct. See the
example below. example below.
Providing a @scheme[super-id] is shorthand for using an initial field Providing a @scheme[super-id] is shorthand for using an initial field
named @scheme[super-id] and using @schemeidfont{_}@scheme[super-id]] named @scheme[super-id] and using @schemeidfont{_}@scheme[super-id]
as its type. Thus, the new struct will use as its type. Thus, the new struct will use
@schemeidfont{_}@scheme[super-id]'s tag in addition to its own tag, @schemeidfont{_}@scheme[super-id]'s tag in addition to its own tag,
meaning that instances of @scheme[_id] can be used as instances of meaning that instances of @scheme[_id] can be used as instances of
@ -682,10 +682,10 @@ efficiency is not an issue. We continue using @scheme[define-cstruct], first
define a type for @cpp{A} which makes it possible to use `@cpp{makeA}: define a type for @cpp{A} which makes it possible to use `@cpp{makeA}:
@schemeblock[ @schemeblock[
(define-cstruct _A ([x _int] [y _byte])) (define-cstruct #,(schemeidfont "_A") ([x _int] [y _byte]))
(define makeA (define makeA
(get-ffi-obj 'makeA "foo.so" (get-ffi-obj 'makeA "foo.so"
(_fun -> _A-pointer))) (code:comment #, @t{using @scheme[_A] is a memory-corrupting bug!}) (_fun -> #,(schemeidfont "_A-pointer")))) (code:comment #, @t{using @schemeidfont{_A} is a memory-corrupting bug!})
(define a (makeA)) (define a (makeA))
(list a (A-x a) (A-y a)) (list a (A-x a) (A-y a))
(code:comment #, @t{produces an @scheme[A] containing @scheme[1] and @scheme[2]}) (code:comment #, @t{produces an @scheme[A] containing @scheme[1] and @scheme[2]})
@ -696,7 +696,7 @@ Using @cpp{gety} is also simple:
@schemeblock[ @schemeblock[
(define gety (define gety
(get-ffi-obj 'gety "foo.so" (get-ffi-obj 'gety "foo.so"
(_fun _A-pointer -> _byte))) (_fun #,(schemeidfont "_A-pointer") -> _byte)))
(gety a) (code:comment #, @t{produces @scheme[2]}) (gety a) (code:comment #, @t{produces @scheme[2]})
] ]
@ -704,10 +704,10 @@ We now define another C struct for @cpp{B}, and expose @cpp{makeB}
using it: using it:
@schemeblock[ @schemeblock[
(define-cstruct _B ([a _A] [z _int])) (define-cstruct #,(schemeidfont "_B") ([a #,(schemeidfont "_A")] [z _int]))
(define makeB (define makeB
(get-ffi-obj 'makeB "foo.so" (get-ffi-obj 'makeB "foo.so"
(_fun -> _B-pointer))) (_fun -> #,(schemeidfont "_B-pointer"))))
(define b (makeB)) (define b (makeB))
] ]
@ -740,7 +740,7 @@ To make this more efficient, we switch to the alternative
expects arguments for both the super fields ands the new ones: expects arguments for both the super fields ands the new ones:
@schemeblock[ @schemeblock[
(define-cstruct (_B _A) ([z _int])) (define-cstruct (#,(schemeidfont "_B") #,(schemeidfont "_A")) ([z _int]))
(define b (make-B 1 2 3)) (define b (make-B 1 2 3))
]} ]}

7
collects/scribblings/scribble/manual.scrbl
View File

@ -97,6 +97,13 @@ A few other escapes are recognized symbolically:
@item{@schemeidfont{code:blank} typesets as a blank space.} @item{@schemeidfont{code:blank} typesets as a blank space.}
@item{@schemeidfont{_}@scheme[_id] typesets as @scheme[id], but
colored as a variable (like @scheme[schemevarfont]); this
escape applies only if @schemeidfont{_}@scheme[_id] has no
for-label binding and is not specifically colored as a subform
non-terminal via @scheme[defform], a variable via
@scheme[defproc], etc.}
} }
} }