core/classes/mixin/mixin-docs.factor

   1 USING: help.markup help.syntax help words compiler.units
   2 classes sequences ;
   3 IN: classes.mixin
   4
   5 ARTICLE: "mixins" "Mixin classes"
   6 "An object is an instance of a union class if it is an instance of one of its members. In this respect, mixin classes are identical to union classes. However, mixin classes have the additional property that they are " { $emphasis "open" } "; new classes can be added to the mixin after the original definition of the mixin."
   7 { $subsections
   8     POSTPONE: MIXIN:
   9     POSTPONE: INSTANCE:
  10     define-mixin-class
  11     add-mixin-instance
  12 }
  13 "The set of mixin classes is a class:"
  14 { $subsections
  15     mixin-class
  16     mixin-class?
  17 }
  18 "Mixins are used to defines suites of behavior which are generally useful and can be applied to user-defined classes. For example, the " { $link immutable-sequence } " mixin can be used with user-defined sequences to make them immutable."
  19 { $see-also "unions" "maybes" "tuple-subclassing" } ;
  20
  21 HELP: mixin-class
  22 { $class-description "The class of mixin classes." } ;
  23
  24 HELP: define-mixin-class
  25 { $values { "class" word } }
  26 { $description "Defines a mixin class. This is the run time equivalent of " { $link POSTPONE: MIXIN: } "." }
  27 { $notes "This word must be called from inside " { $link with-compilation-unit } "." }
  28 { $side-effects "class" } ;
  29
  30 HELP: add-mixin-instance
  31 { $values { "class" class } { "mixin" class } }
  32 { $description "Defines a class to be an instance of a mixin class. This is the run time equivalent of " { $link POSTPONE: INSTANCE: } "." }
  33 { $notes "This word must be called from inside " { $link with-compilation-unit } "." }
  34 { $side-effects "class" } ;
  35
  36 { mixin-class define-mixin-class add-mixin-instance POSTPONE: MIXIN: POSTPONE: INSTANCE: } related-words
  37
  38 ABOUT: "mixins"