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

doc clarifications

Browse Source 
Merge to 5.2
This commit is contained in:
Matthew Flatt 2011-10-10 14:45:53 -06:00
parent 6aaa0d44c0
commit 5724aa1d1b
2 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
collects/scribblings/foreign/cpointer.scrbl
View File

@ -22,20 +22,21 @@ to Racket, and accept only such tagged pointers when going to C. An
optional @racket[ptr-type] can be given to be used as the base pointer optional @racket[ptr-type] can be given to be used as the base pointer
type, instead of @racket[_pointer]. type, instead of @racket[_pointer].
By convention, tags are symbols named after the Although any value can be used as a tag, by convention the symbol form
type they point to. For example, the cpointer @racket[_car] would of a type name---without a leading underscore---is used as the
be created using @racket['car] as the key. However, any symbol can be tag. For example, a pointer type @racketidfont{_animal}
used as the tag. would normally use @racket['animal] as the key.
Pointer tags are checked with @racket[cpointer-has-tag?] and changed
with @racket[cpointer-push-tag!] which means that other tags are
preserved. Specifically, if a base @racket[ptr-type] is given and is
itself a @racket[_cpointer], then the new type will handle pointers
that have the new tag in addition to @racket[ptr-type]'s tag(s). When
the tag is a pair, its first value is used for printing, so the most
recently pushed tag which corresponds to the inheriting type will be
displayed.
@racket[_cpointer/null] is similar to @racket[_cpointer] except that Pointer tags are checked with @racket[cpointer-has-tag?] and changed
with @racket[cpointer-push-tag!], which means that other tags are
preserved on an existing pointer value. Specifically, if a base
@racket[ptr-type] is given and is itself a @racket[_cpointer], then
the new type will handle pointers that have the new tag in addition to
@racket[ptr-type]'s tag(s). When the tag is a pair, its first value
is used for printing, so the most recently pushed tag which
corresponds to the inheriting type is displayed.
The @racket[_cpointer/null] function is similar to @racket[_cpointer], except that
it tolerates @cpp{NULL} pointers both going to C and back. Note that it tolerates @cpp{NULL} pointers both going to C and back. Note that
@cpp{NULL} pointers are represented as @racket[#f] in Racket, so they @cpp{NULL} pointers are represented as @racket[#f] in Racket, so they
are not tagged.} are not tagged.}

7
collects/scribblings/reference/places.scrbl
View File

@ -267,12 +267,13 @@ If any pumping threads were created to connect a non-@tech{file-stream
} }
@defproc[(place-channel-get [pch place-channel?]) place-message-allowed?]{ @defproc[(place-channel-get [pch place-channel?]) place-message-allowed?]{
Returns a message received on channel @racket[pch]. Returns a message received on channel @racket[pch], blocking until a
message is available.
} }
@defproc[(place-channel-put/get [pch place-channel?] [v any/c]) void]{ @defproc[(place-channel-put/get [pch place-channel?] [v any/c]) any/c]{
Sends an immutable message @racket[v] on channel @racket[pch] and then Sends an immutable message @racket[v] on channel @racket[pch] and then
waits for a reply message on the same channel. waits for a message (perhaps a reply) on the same channel.
} }
@defproc[(place-message-allowed? [v any/c]) boolean?]{ @defproc[(place-message-allowed? [v any/c]) boolean?]{