47 lines
2.9 KiB
Factor
47 lines
2.9 KiB
Factor
! Copyright (C) 2009 Daniel Ehrenberg.
|
|
! See http://factorcode.org/license.txt for BSD license.
|
|
USING: help.markup help.syntax quotations effects words call.private ;
|
|
IN: call
|
|
|
|
ABOUT: "call"
|
|
|
|
ARTICLE: "call" "Calling code with known stack effects"
|
|
"The " { $vocab-link "call" } " vocabulary allows for arbitrary quotations to be called from code accepted by the optimizing compiler. This is done by specifying the stack effect of the quotation literally. It is checked at runtime that the stack effect is accurate."
|
|
$nl
|
|
"Quotations:"
|
|
{ $subsection POSTPONE: call( }
|
|
{ $subsection call-effect }
|
|
"Words:"
|
|
{ $subsection POSTPONE: execute( }
|
|
{ $subsection execute-effect }
|
|
"Unsafe calls:"
|
|
{ $subsection POSTPONE: execute-unsafe( }
|
|
{ $subsection execute-effect-unsafe } ;
|
|
|
|
HELP: call(
|
|
{ $syntax "call( stack -- effect )" }
|
|
{ $description "Calls the quotation on the top of the stack, asserting that it has the given stack effect. The quotation does not need to be known at compile time." } ;
|
|
|
|
HELP: call-effect
|
|
{ $values { "quot" quotation } { "effect" effect } }
|
|
{ $description "Given a quotation and a stack effect, calls the quotation, asserting at runtime that it has the given stack effect. This is a macro which expands given a literal effect parameter, and an arbitrary quotation which is not required at compile time." } ;
|
|
|
|
HELP: execute(
|
|
{ $syntax "execute( stack -- effect )" }
|
|
{ $description "Calls the word on the top of the stack, asserting that it has the given stack effect. The word does not need to be known at compile time." } ;
|
|
|
|
HELP: execute-effect
|
|
{ $values { "word" word } { "effect" effect } }
|
|
{ $description "Given a word and a stack effect, executes the word, asserting at runtime that it has the given stack effect. This is a macro which expands given a literal effect parameter, and an arbitrary word which is not required at compile time." } ;
|
|
|
|
HELP: execute-unsafe(
|
|
{ $syntax "execute-unsafe( stack -- effect )" }
|
|
{ $description "Calls the word on the top of the stack, blindly declaring that it has the given stack effect. The word does not need to be known at compile time." }
|
|
{ $warning "If the word being executed has an incorrect stack effect, undefined behavior will result. User code should use " { $link POSTPONE: execute( } " instead." } ;
|
|
HELP: execute-effect-unsafe
|
|
{ $values { "word" word } { "effect" effect } }
|
|
{ $description "Given a word and a stack effect, executes the word, blindly declaring at runtime that it has the given stack effect. This is a macro which expands given a literal effect parameter, and an arbitrary word which is not required at compile time." }
|
|
{ $warning "If the word being executed has an incorrect stack effect, undefined behavior will result. User code should use " { $link execute-effect-unsafe } " instead." } ;
|
|
|
|
{ call-effect execute-effect execute-effect-unsafe } related-words
|
|
{ POSTPONE: call( POSTPONE: execute( POSTPONE: execute-unsafe( } related-words |