basis/tools/annotations/annotations-docs.factor

   1 USING: help.markup help.syntax words parser quotations strings
   2 system sequences ;
   3 IN: tools.annotations
   4
   5 ARTICLE: "tools.annotations" "Word annotations"
   6 "The word annotation feature modifies word definitions to add debugging code. You can restore the old definition by calling " { $link reset } " on the word in question."
   7 $nl
   8 "Printing messages when a word is called or returns:"
   9 { $subsection watch }
  10 { $subsection watch-vars }
  11 "Starting the walker when a word is called:"
  12 { $subsection breakpoint }
  13 { $subsection breakpoint-if }
  14 "Timing words:"
  15 { $subsection reset-word-timing }
  16 { $subsection add-timing }
  17 { $subsection word-timing. }
  18 "All of the above words are implemented using a single combinator which applies a quotation to a word definition to yield a new definition:"
  19 { $subsection annotate } ;
  20
  21 ABOUT: "tools.annotations"
  22
  23 HELP: annotate
  24 { $values { "word" "a word" } { "quot" { $quotation "( word def -- def )" } } }
  25 { $description "Changes a word definition to the result of applying a quotation to the old definition." }
  26 { $notes "This word is used to implement " { $link watch } "." } ;
  27
  28 HELP: watch
  29 { $values { "word" word } }
  30 { $description "Annotates a word definition to print the data stack on entry and exit." } ;
  31
  32 { watch watch-vars reset } related-words
  33
  34 HELP: breakpoint
  35 { $values { "word" word } }
  36 { $description "Annotates a word definition to enter the single stepper when executed." } ;
  37
  38 HELP: breakpoint-if
  39 { $values { "quot" { $quotation "( -- ? )" } } { "word" word } }
  40 { $description "Annotates a word definition to enter the single stepper if the quotation yields true." } ;
  41
  42 HELP: annotate-methods
  43 { $values
  44      { "word" word } { "quot" quotation } }
  45 { $description "Annotates the word -- for generic words, all its methods -- with the quotation." } ;
  46
  47 HELP: entering
  48 { $values
  49      { "str" string } }
  50 { $description "Prints a message and the inputs to the word before the word has been called." } ;
  51
  52 HELP: leaving
  53 { $values
  54      { "str" string } }
  55 { $description "Prints a message and the outputs from a word after a word has been called." } ;
  56
  57 HELP: reset
  58 { $values
  59      { "word" word } }
  60 { $description "Resets any annotations on a word." }
  61 { $notes "This word will remove a " { $link watch } "." } ;
  62
  63 HELP: watch-vars
  64 { $values
  65      { "word" word } { "vars" "a sequence of symbols" } }
  66 { $description "Annotates a word definition to print the " { $snippet "vars" } " upon entering the word. This word is useful for debugging." } ;
  67
  68 HELP: word-inputs
  69 { $values
  70      { "word" word }
  71      { "seq" sequence } }
  72 { $description "Makes a sequence of the inputs to a word by counting the number of inputs in the stack effect and saving that many items from the datastack." } ;
  73
  74 HELP: add-timing
  75 { $values { "word" word } }
  76 { $description "Adds timing code to a word, which records its total running time, including that of words it calls, on every invocation." }
  77 { $see-also "timing" "profiling" } ;
  78
  79 HELP: reset-word-timing
  80 { $description "Resets the word timing table." } ;
  81
  82 HELP: word-timing.
  83 { $description "Prints the word timing table." } ;