basis/help/definitions/definitions.factor

   1 ! Copyright (C) 2007, 2008 Slava Pestov.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: accessors definitions help help.topics help.syntax
   4 prettyprint.backend prettyprint words kernel effects ;
   5 IN: help.definitions
   6
   7 ! Definition protocol implementation
   8
   9 M: link definer drop \ ARTICLE: \ ; ;
  10
  11 M: link where name>> article loc>> ;
  12
  13 M: link set-where name>> article (>>loc) ;
  14
  15 M: link forget* name>> remove-article ;
  16
  17 M: link definition article-content ;
  18
  19 M: link synopsis*
  20     dup definer.
  21     dup name>> pprint*
  22     article-title pprint* ;
  23
  24 M: word-link definer drop \ HELP: \ ; ;
  25
  26 M: word-link where name>> "help-loc" word-prop ;
  27
  28 M: word-link set-where name>> swap "help-loc" set-word-prop ;
  29
  30 M: word-link definition name>> "help" word-prop ;
  31
  32 M: word-link synopsis*
  33     dup definer.
  34     name>> dup pprint-word
  35     stack-effect. ;
  36
  37 M: word-link forget* name>> remove-word-help ;