basis/compiler/tree/tree-docs.factor

   1 USING: assocs help.markup help.syntax kernel sequences stack-checker.visitor ;
   2 IN: compiler.tree
   3
   4 HELP: #call
   5 { $class-description "SSA tree node that calls a word." } ;
   6
   7 HELP: #introduce
   8 { $class-description "SSA tree node that puts an input value from the \"outside\" on the stack." } ;
   9
  10 HELP: #push
  11 { $class-description "SSA tree node that puts a literal value on the stack." }
  12 { $notes "A quotation is also a literal." } ;
  13
  14 HELP: #shuffle
  15 { $class-description "SSA tree node that represents a stack shuffling operation such as " { $link swap } ". It has the following slots:"
  16   { $table
  17     { { $slot "mapping" } { "An " { $link assoc } " that shows how the shuffle output values (the keys) correspond to their inputs (the values)." } }
  18   }
  19 } ;
  20
  21 HELP: node,
  22 { $values { "node" node } }
  23 { $description "Emits a node to the " { $link stack-visitor } " variable." } ;