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

fix scheme/sandbox docs

Browse Source
This commit is contained in:
Matthew Flatt 2010-04-26 16:07:19 -06:00
parent e6e06bb1a3
commit e4f736c6a5
1 changed files with 54 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
collects/scribblings/scheme/scheme.scrbl
View File

@ -1,21 +1,33 @@
#lang scribble/manual #lang scribble/manual
@(require (for-syntax racket) @(require (for-syntax racket)
(for-label (only-in scheme/foreign unsafe! provide* define-unsafer) (for-label (only-in scheme/foreign unsafe! provide* define-unsafer)
(only-in racket/base make-base-namespace make-base-empty-namespace))) (only-in scheme/base make-base-namespace make-base-empty-namespace)
scheme/gui/base
scheme/sandbox))
@(define-syntax-rule (def-extras unit-struct @(define-syntax-rule (def-extras unit-struct
make-base-namespace-id make-base-namespace-id
make-base-empty-namespace-id) make-base-empty-namespace-id
sandbox-namespace-specs-id
make-evaluator-id
make-module-evaluator-id)
(begin (begin
(require (for-label (only-in scheme struct) (require (for-label (only-in scheme struct)
(only-in racket/base make-base-namespace (only-in racket/base make-base-namespace
make-base-empty-namespace))) make-base-empty-namespace)
racket/sandbox))
(define unit-struct (racket struct)) (define unit-struct (racket struct))
(define make-base-namespace-id (racket make-base-namespace)) (define make-base-namespace-id (racket make-base-namespace))
(define make-base-empty-namespace-id (racket make-base-empty-namespace)))) (define make-base-empty-namespace-id (racket make-base-empty-namespace))
(define sandbox-namespace-specs-id (racket sandbox-namespace-specs))
(define make-evaluator-id (racket make-evaluator))
(define make-module-evaluator-id (racket make-module-evaluator))))
@(def-extras unit-struct @(def-extras unit-struct
make-base-namespace-id make-base-namespace-id
make-base-empty-namespace-id) make-base-empty-namespace-id
sandbox-namespace-specs-id
make-evaluator-id
make-module-evaluator-id)
@(define-syntax-rule (compat-except sid rid . rest) @(define-syntax-rule (compat-except sid rid . rest)
(begin (begin
@ -114,7 +126,7 @@ must occur after all the @scheme[provide*] forms to which it refers.}
@compat[scheme/mpair racket/mpair] @compat[scheme/mpair racket/mpair]
@;------------------------------------------------------------------------ @;------------------------------------------------------------------------
@section[#:tag "nest"]{schememodname[scheme/nest]} @section[#:tag "nest"]{@schememodname[scheme/nest]}
@defmodule[scheme/nest] @defmodule[scheme/nest]
@ -175,6 +187,42 @@ than a precise prose description:
@compat[scheme/require-syntax racket/require-syntax] @compat[scheme/require-syntax racket/require-syntax]
@compat[scheme/require-transform racket/require-transform] @compat[scheme/require-transform racket/require-transform]
@compat[scheme/runtime-path racket/runtime-path] @compat[scheme/runtime-path racket/runtime-path]
@; ----------------------------------------
@compat-except[scheme/sandbox racket/sandbox]{, except that
@|sandbox-namespace-specs-id|, @|make-evaluator-id|, and
@|make-module-evaluator-id| are replaced}
@defparam[sandbox-namespace-specs spec (cons/c (-> namespace?)
(listof module-path?))]{
Like @|sandbox-namespace-specs-id| from
@racketmodname[racket/sandbox], but the default is @racket[(list
make-base-namespace)] if @racket[gui?] is @racket[#f], @racket[(list
make-gui-namespace)] if @racket[gui?] is @racket[#t].}
@defproc*[([(make-evaluator [language (or/c module-path?
(list/c 'special symbol?)
(cons/c 'begin list?))]
[input-program any/c] ...
[#:requires requires (listof (or/c module-path? path?))]
[#:allow-read allow (listof (or/c module-path? path?))])
(any/c . -> . any)]
[(make-module-evaluator [module-decl (or/c syntax? pair?)]
[#:language lang (or/c #f module-path?)]
[#:allow-read allow (listof (or/c module-path? path?))])
(any/c . -> . any)])]{
Like @|make-evaluator-id| and @|make-module-evaluator-id| from
@racketmodname[racket/sandbox], but the value of the
@racket[sandbox-namespace-specs] parameter is installed as the
value of @|sandbox-namespace-specs-id| from
@racketmodname[racket/sandbox] before chaining to @|make-evaluator-id|
and @|make-module-evaluator-id| from @racketmodname[racket/sandbox].}
@; ----------------------------------------
@compat[scheme/serialize racket/serialize] @compat[scheme/serialize racket/serialize]
@compat[scheme/set racket/set] @compat[scheme/set racket/set]
@compat[scheme/signature racket/signature] @compat[scheme/signature racket/signature]