basis/tools/walker/walker-docs.factor

   1 IN: tools.walker
   2 USING: help.syntax help.markup tools.continuations sequences math words ;
   3
   4 HELP: breakpoint
   5 { $values { "word" word } }
   6 { $description "Annotates a word definition to enter the single stepper when executed." } ;
   7
   8 HELP: breakpoint-if
   9 { $values { "word" word } { "quot" { $quotation "( -- ? )" } } }
  10 { $description "Annotates a word definition to enter the single stepper if the quotation yields true." } ;
  11
  12 HELP: B
  13 { $description "An alias for " { $link break } ", defined in the " { $vocab-link "syntax" } " vocabulary so that it is always available." } ;
  14
  15 ARTICLE: "breakpoints" "Setting breakpoints"
  16 "In addition to invoking the walker explicitly through the UI, it is possible to set breakpoints on words using words in the " { $vocab-link "tools.walker" } " vocabulary."
  17 $nl
  18 "Annotating a word with a breakpoint (see " { $link "tools.annotations" } "):"
  19 { $subsections
  20     breakpoint
  21     breakpoint-if
  22 }
  23 "Breakpoints can be inserted directly into code:"
  24 { $subsections
  25     break
  26     POSTPONE: B
  27 }
  28 "Note that because the walker calls various core library and UI words while rendering its own user interface, setting a breakpoint on a word such as " { $link append } " or " { $link + } " will hang the UI." ;
  29
  30 ABOUT: "breakpoints"