core/classes/classes-docs.factor

   1 USING: help.markup help.syntax kernel kernel.private
   2 namespaces sequences words arrays effects math
   3 classes.private classes.union classes.mixin
   4 classes.predicate quotations ;
   5 IN: classes
   6
   7 ARTICLE: "class-predicates" "Class predicate words"
   8 "With a handful of exceptions, each class has a membership predicate word, named " { $snippet { $emphasis "class" } "?" } ". A quotation calling this predicate is stored in the " { $snippet "\"predicate\"" } " word property."
   9 $nl
  10 "When it comes to predicates, the exceptional classes are:"
  11 { $table
  12     { "Class" "Predicate" "Explanation" }
  13     { { $link f } { $snippet "[ not ]" } { "The conventional name for a word which outputs true when given false is " { $link not } "; " { $snippet "f?" } " would be confusing." } }
  14     { { $link object } { $snippet "[ drop t ]" } { "All objects are instances of " { $link object } } }
  15     { { $link null } { $snippet "[ drop f ]" } { "No object is an instance of " { $link null } } }
  16 }
  17 "The set of class predicate words is a class:"
  18 { $subsections
  19     predicate
  20     predicate?
  21 }
  22 "A predicate word holds a reference to the class it is predicating over in the " { $snippet "\"predicating\"" } " word property." $nl
  23 "Implementation of class reloading:"
  24 { $subsections reset-class forget-class forget-methods } ;
  25
  26 ARTICLE: "classes" "Classes"
  27 "Conceptually, a " { $snippet "class" } " is a set of objects whose members can be identified with a predicate, and on which generic words can specialize methods. Classes are organized into a general partial order, and an object may be an instance of more than one class."
  28 $nl
  29 "At the implementation level, a class is a word with certain word properties set."
  30 $nl
  31 "Words for working with classes are found in the " { $vocab-link "classes" } " vocabulary."
  32 $nl
  33 "Classes themselves form a class:"
  34 { $subsections class? }
  35 "You can ask an object for its class:"
  36 { $subsections class-of }
  37 "Testing if an object is an instance of a class:"
  38 { $subsections instance? }
  39 "You can ask a class for its superclass:"
  40 { $subsections
  41     superclass
  42     superclasses
  43     subclass-of?
  44 }
  45 "Class predicates can be used to test instances directly:"
  46 { $subsections "class-predicates" }
  47 "There is a universal class which all objects are an instance of, and an empty class with no instances:"
  48 { $subsections
  49     object
  50     null
  51 }
  52 "Obtaining a list of all defined classes:"
  53 { $subsections classes }
  54 "There are several sorts of classes:"
  55 { $subsections
  56     "builtin-classes"
  57     "unions"
  58     "intersections"
  59     "mixins"
  60     "predicates"
  61     "singletons"
  62 }
  63 { $link "tuples" } " are documented in their own section."
  64 $nl
  65 "Classes can be inspected and operated upon:"
  66 { $subsections
  67     "class-operations"
  68     "class-linearization"
  69 }
  70 { $see-also "class-index" } ;
  71
  72 ABOUT: "classes"
  73
  74 HELP: class
  75 { $class-description "The class of all class words." } ;
  76
  77 HELP: class-of
  78 { $values { "object" object } { "class" class } }
  79 { $description "Outputs an object's canonical class. While an object may be an instance of more than one class, the canonical class is either its built-in class, or if the object is a tuple, its tuple class." }
  80 { $examples { $example "USING: classes prettyprint ;" "1.0 class-of ." "float" } { $example "USING: classes prettyprint ;" "IN: scratchpad" "TUPLE: point x y z ;\nT{ point f 1 2 3 } class-of ." "point" } } ;
  81
  82 HELP: classes
  83 { $values { "seq" "a sequence of class words" } }
  84 { $description "Finds all class words in the dictionary." } ;
  85
  86 HELP: update-map
  87 { $var-description "Assoc mapping each class to a set of classes defined in terms of this class. The " { $link define-class } " word uses this information to update generic words when classes are redefined." } ;
  88
  89 HELP: predicate-word
  90 { $values { "word" "a word" } { "predicate" "a predicate word" } }
  91 { $description "Suffixes the word's name with \"?\" and creates a word with that name in the same vocabulary as the word itself." } ;
  92
  93 HELP: define-predicate
  94 { $values { "class" class } { "quot" quotation } }
  95 { $description "Defines a predicate word for a class." }
  96 $low-level-note ;
  97
  98 HELP: superclass
  99 { $values { "class" class } { "super" class } }
 100 { $description "Outputs the superclass of a class. All instances of this class are also instances of the superclass." }
 101 { $examples
 102     { $example "USING: classes prettyprint ;"
 103                "t superclass ."
 104                "word"
 105     }
 106 } ;
 107
 108 HELP: superclasses
 109 { $values
 110      { "class" class }
 111      { "supers" sequence } }
 112 { $description "Outputs a sequence of superclasses of a class along with the class itself." }
 113 { $examples
 114     { $example "USING: classes prettyprint ;"
 115                "t superclasses ."
 116                "{ word t }"
 117     }
 118 } ;
 119
 120 HELP: subclass-of?
 121 { $values
 122     { "class" class }
 123     { "superclass" class }
 124     { "?" boolean }
 125 }
 126 { $description "Outputs a boolean value indicating whether " { $snippet "class" } " is at any level a subclass of " { $snippet "superclass" } "." }
 127 { $examples
 128     { $example "USING: classes classes.tuple prettyprint words ;"
 129                "tuple-class \\ class subclass-of? ."
 130                "t"
 131     }
 132 } ;
 133
 134 { superclass superclasses subclass-of? } related-words
 135
 136 HELP: members
 137 { $values { "class" class } { "seq" "a sequence of union members, or " { $link f } } }
 138 { $description "If " { $snippet "class" } " is a union class, outputs a sequence of its member classes, otherwise outputs " { $link f } "." } ;
 139
 140 HELP: participants
 141 { $values { "class" class } { "seq" "a sequence of intersection participants, or " { $link f } } }
 142 { $description "If " { $snippet "class" } " is an intersection class, outputs a sequence of its participant classes, otherwise outputs " { $link f } "." } ;
 143
 144 HELP: define-class
 145 { $values { "word" word } { "superclass" class } { "members" "a sequence of class words" } { "participants" "a sequence of class words" } { "metaclass" class } }
 146 { $description "Sets a property indicating this word is a class word, thus making it an instance of " { $link class } ", and registers it with " { $link update-map } "." }
 147 $low-level-note ;
 148
 149 HELP: implementors
 150 { $values { "class/classes" "a class or a sequence of classes" } { "seq" "a sequence of generic words" } }
 151 { $description "Finds all generic words in the dictionary implementing methods for the given set of classes." } ;
 152
 153 HELP: instance?
 154 { $values
 155      { "object" object } { "class" class }
 156      { "?" "a boolean" } }
 157 { $description "Tests whether the input object is a member of the class." } ;
 158
 159 HELP: reset-class
 160 { $values { "class" class } }
 161 { $description "Forgets all of words that the class defines, but not words that are defined on the class. For instance, on a tuple class, this word should reset all of the tuple accessors but not things like " { $link nth } " that may be defined on the class elsewhere." } ;
 162
 163 HELP: forget-class
 164 { $values { "class" class } }
 165 { $description "Removes a class by forgetting all of the methods defined on that class and all of the methods generated when that class was defined. Also resets any caches that may contain that class." } ;
 166
 167 HELP: forget-methods
 168 { $values { "class" class } }
 169 { $description "Forgets all methods defined on a class. In contrast to " { $link reset-class } ", this not only forgets accessors but also any methods at all on the class." } ;
 170