adjusted the tools docs that the contracts on the tool units are extracted from the same place that the documentation is extracted from, namely tool-lib.ss
svn: r9777
This commit is contained in:
Robby Findler
parent
2bf93a2fa0
commit
5b3a61460b
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -20,7 +20,8 @@ all of the names in the tools library, for use defining keybindings
|
|||
framework
|
||||
framework/splash
|
||||
|
||||
scribble/srcdoc)
|
||||
scribble/srcdoc
|
||||
drscheme/private/language-object-contract)
|
||||
|
||||
(require (for-syntax scheme/base))
|
||||
|
||||
|
|
@ -38,67 +39,8 @@ all of the names in the tools library, for use defining keybindings
|
|||
#'((drscheme:unit:get-program-editor-mixin) a ...)]
|
||||
[_ #'(drscheme:unit:get-program-editor-mixin)]))
|
||||
|
||||
(define-syntax (language-object-abstraction stx)
|
||||
(syntax-case stx ()
|
||||
[(_ id)
|
||||
(with-syntax ([ctc
|
||||
#'(object-contract
|
||||
(config-panel (-> (is-a?/c area-container<%>)
|
||||
(case-> (-> any/c void?)
|
||||
(-> any/c))))
|
||||
(create-executable (-> any/c
|
||||
(or/c (is-a?/c dialog%) (is-a?/c frame%))
|
||||
path?
|
||||
void?))
|
||||
(default-settings (-> any/c))
|
||||
(default-settings? (-> any/c boolean?))
|
||||
(order-manuals (-> (listof bytes?)
|
||||
(values (listof bytes?) boolean?)))
|
||||
(front-end/complete-program (-> input-port?
|
||||
any/c
|
||||
(-> any/c)))
|
||||
(front-end/interaction (-> input-port?
|
||||
any/c
|
||||
(-> any/c)))
|
||||
(get-language-name (-> string?))
|
||||
(get-language-numbers (-> (cons/c number? (listof number?))))
|
||||
(get-language-position (-> (cons/c string? (listof string?))))
|
||||
(get-language-url (-> (or/c false/c string?)))
|
||||
(get-one-line-summary (-> string?))
|
||||
(get-comment-character (-> (values string? char?)))
|
||||
(get-style-delta
|
||||
(-> (or/c false/c
|
||||
(is-a?/c style-delta%)
|
||||
(listof
|
||||
(list/c (is-a?/c style-delta%)
|
||||
number?
|
||||
number?)))))
|
||||
(marshall-settings (-> any/c printable/c))
|
||||
(on-execute (-> any/c (-> (-> any) any) any))
|
||||
(render-value (-> any/c
|
||||
any/c
|
||||
output-port?
|
||||
void?))
|
||||
(render-value/format (-> any/c
|
||||
any/c
|
||||
output-port?
|
||||
(or/c number? (symbols 'infinity))
|
||||
any))
|
||||
(unmarshall-settings (-> printable/c any))
|
||||
|
||||
(capability-value
|
||||
(->d ([s (and/c symbol?
|
||||
drscheme:language:capability-registered?)])
|
||||
()
|
||||
[res (drscheme:language:get-capability-contract s)])))])
|
||||
#'(begin
|
||||
(define id ctc)
|
||||
(provide/doc
|
||||
(thing-doc id
|
||||
contract?
|
||||
@{@schemeblock[ctc]}))))]))
|
||||
(provide drscheme:language:object/c)
|
||||
|
||||
(language-object-abstraction drscheme:language:object/c)
|
||||
|
||||
(provide/doc
|
||||
|
||||
|
|
@ -120,9 +62,9 @@ all of the names in the tools library, for use defining keybindings
|
|||
;
|
||||
|
||||
|
||||
(proc-doc/names
|
||||
drscheme:eval:set-basic-parameters
|
||||
(-> (listof (is-a?/c snip-class%)) void?)
|
||||
(proc-doc/names
|
||||
drscheme:eval:set-basic-parameters
|
||||
(-> (listof (is-a?/c snip-class%)) void?)
|
||||
(snipclasses)
|
||||
@{sets the parameters that are shared between the repl's
|
||||
initialization and @scheme[drscheme:eval:build-user-eventspace/custodian]
|
||||
|
|
@ -159,25 +101,23 @@ all of the names in the tools library, for use defining keybindings
|
|||
|
||||
}}})
|
||||
|
||||
(proc-doc/names
|
||||
drscheme:eval:get-snip-classes
|
||||
(proc-doc/names
|
||||
drscheme:eval:get-snip-classes
|
||||
(-> (listof (is-a?/c snip-class%)))
|
||||
()
|
||||
@{Returns a list of all of the snipclasses in the current eventspace.})
|
||||
|
||||
(proc-doc/names
|
||||
drscheme:eval:expand-program
|
||||
((or/c port? drscheme:language:text/pos?)
|
||||
drscheme:language-configuration:language-settings?
|
||||
boolean?
|
||||
(-> void?)
|
||||
(-> void?)
|
||||
((or/c eof-object? syntax? (cons/c string? any/c))
|
||||
(-> any)
|
||||
. -> .
|
||||
any)
|
||||
. -> .
|
||||
void?)
|
||||
(-> (or/c port? drscheme:language:text/pos?)
|
||||
drscheme:language-configuration:language-settings?
|
||||
boolean?
|
||||
(-> void?)
|
||||
(-> void?)
|
||||
(-> (or/c eof-object? syntax? (cons/c string? any/c))
|
||||
(-> any)
|
||||
any)
|
||||
void?)
|
||||
(input language-settings eval-compile-time-part? init kill-termination iter)
|
||||
|
||||
@{Use this function to expand the contents of the definitions
|
||||
|
|
|
|||
|
|
@ -1008,4 +1008,5 @@ Translates a Scheme value into a settings, returning
|
|||
|
||||
}}
|
||||
|
||||
@(include-extracted (lib "language-object-contract.ss" "drscheme" "private") #rx"^drscheme:language:")
|
||||
@(include-extracted (lib "tool-lib.ss" "drscheme") #rx"^drscheme:language:")
|
||||
|
|
|
|||
|
|
@ -15,6 +15,13 @@
|
|||
@title{@bold{Plugins}: Extending DrScheme}
|
||||
@(defmodule drscheme/tool-lib)
|
||||
|
||||
|
||||
@bold{TODO}
|
||||
|
||||
@itemize{@item{contract for capability-value method is wrong (commented out version is right, but has circular dependencies)}}
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
@bold{This Manual}
|
||||
|
||||
This manual describes DrScheme's tools interface. It assumes
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user