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

21 lines
1.1 KiB
Factor

USING: compiler.tree help.markup help.syntax kernel quotations words ;
IN: compiler.tree.propagation.inlining
HELP: custom-inlining?
{ $values { "word" word } { "quot/f" "a quotation or " { $link f } } }
{ $description "Returns the custom inlining " { $link quotation } " for a word if it has one." } ;
HELP: (do-inlining)
{ $values { "#call" #call } { "word" word } { "?" boolean } }
{ $description
"Performs inlining of a word."
$nl
"If the generic was defined in an outer compilation unit, then it doesn't have a definition yet; the definition is built at the end of the compilation unit. We do not attempt inlining at this stage since the stack discipline is not finalized yet, so dispatch# might return an out of bounds value. This case comes up if a parsing word calls the compiler at parse time (doing so is discouraged, but it should still work.)"
} ;
ARTICLE: "compiler.tree.propagation.inlining" "Method inlining and dispatch elimination"
"Splicing nodes:"
{ $subsections splicing-call open-code-#call splicing-body } ;
ABOUT: "compiler.tree.propagation.inlining"