factor/core/classes/union/union-docs.factor

USING: classes classes.builtin classes.union.private compiler.units
help.markup help.syntax kernel ;
IN: classes.union

ARTICLE: "unions" "Union classes"
"An object is an instance of a union class if it is an instance of one of its members."
{ $subsections
    POSTPONE: UNION:
    define-union-class
}
"Union classes can be introspected:"
{ $subsections class-members }
"The set of union classes is a class:"
{ $subsections
    union-class
    union-class?
}
"Unions are used to define behavior shared between a fixed set of classes, as well as to conveniently define predicates."
{ $see-also "mixins" "maybes" "tuple-subclassing" } ;

ABOUT: "unions"

HELP: (define-union-class)
{ $values { "class" class } { "members" { $sequence class } } }
{ $description "Defines a union class." }
{ $errors "Throws " { $link cannot-reference-self } " if the definition references itself." } ;

HELP: define-union-class
{ $values { "class" class } { "members" { $sequence class } } }
{ $description "Defines a union class with specified members. This is the run time equivalent of " { $link POSTPONE: UNION: } "." }
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
{ $side-effects "class"
} ;

{ union-class define-union-class POSTPONE: UNION: } related-words

HELP: union-class
{ $class-description "The class of union classes." } ;

HELP: union-of-builtins?
{ $values { "class" class } { "?" boolean } }
{ $description { $link t } " if the class either is a " { $link builtin-class } " or only contains builtin classes." } ;