core/classes/singleton/singleton-docs.factor

   1 USING: help.markup help.syntax kernel words ;
   2 IN: classes.singleton
   3
   4 ARTICLE: "singletons" "Singleton classes"
   5 "A singleton is a class with only one instance and with no state."
   6 { $subsection POSTPONE: SINGLETON: }
   7 { $subsection define-singleton-class }
   8 "The set of all singleton classes is itself a class:"
   9 { $subsection singleton-class? }
  10 { $subsection singleton-class } ;
  11
  12 HELP: SINGLETON:
  13 { $syntax "SINGLETON: class" }
  14 { $values
  15     { "class" "a new singleton to define" }
  16 }
  17 { $description
  18     "Defines a new singleton class. The class word itself is the sole instance of the singleton class."
  19 }
  20 { $examples
  21     { $example "USING: classes.singleton kernel io ;" "IN: scratchpad" "SINGLETON: foo\nGENERIC: bar ( obj -- )\nM: foo bar drop \"a foo!\" print ;\nfoo bar" "a foo!" }
  22 } ;
  23
  24 HELP: define-singleton-class
  25 { $values { "word" "a new word" } }
  26 { $description
  27     "Defines a singleton class. This is the run-time equivalent of " { $link POSTPONE: SINGLETON: } "." } ;
  28
  29 { POSTPONE: SINGLETON: define-singleton-class } related-words
  30
  31 HELP: singleton-class
  32 { $class-description "The class of singleton classes." } ;
  33
  34 ABOUT: "singletons"