factor/basis/compiler/tree/tree-docs.factor

24 lines
869 B
Factor
Raw Normal View History

USING: assocs help.markup help.syntax kernel sequences stack-checker.visitor ;
IN: compiler.tree
HELP: #call
{ $class-description "SSA tree node that calls a word." } ;
HELP: #introduce
{ $class-description "SSA tree node that puts an input value from the \"outside\" on the stack." } ;
HELP: #push
{ $class-description "SSA tree node that puts a literal value on the stack." }
{ $notes "A quotation is also a literal." } ;
HELP: #shuffle
{ $class-description "SSA tree node that represents a stack shuffling operation such as " { $link swap } ". It has the following slots:"
{ $table
{ { $slot "mapping" } { "An " { $link assoc } " that shows how the shuffle output values (the keys) correspond to their inputs (the values)." } }
}
} ;
HELP: node,
{ $values { "node" node } }
{ $description "Emits a node to the " { $link stack-visitor } " variable." } ;