core/classes/builtin/builtin-docs.factor

   1 USING: help.syntax help.markup classes layouts ;
   2 IN: classes.builtin
   3
   4 ARTICLE: "builtin-classes" "Built-in classes"
   5 "Every object is an instance of exactly one canonical " { $emphasis "built-in class" } " which defines its layout in memory and basic behavior."
   6 $nl
   7 "The set of built-in classes is a class:"
   8 { $subsections
   9     builtin-class
  10     builtin-class?
  11 }
  12 "See " { $link "class-index" } " for a list of built-in classes." ;
  13
  14 HELP: builtin-class
  15 { $class-description "The class of built-in classes." }
  16 { $examples
  17     "The class of arrays is a built-in class:"
  18     { $example "USING: arrays classes.builtin prettyprint ;" "array builtin-class? ." "t" }
  19     "However, an instance of the array class is not a built-in class; it is not even a class:"
  20     { $example "USING: classes.builtin prettyprint ;" "{ 1 2 3 } builtin-class? ." "f" }
  21 } ;
  22
  23 HELP: builtins
  24 { $var-description "Vector mapping type numbers to builtin class words." } ;
  25
  26 HELP: type>class
  27 { $values { "n" "a non-negative integer" } { "class" class } }
  28 { $description "Outputs a builtin class whose instances are precisely those having a given pointer tag." }
  29 { $notes "The parameter " { $snippet "n" } " must be between 0 and the return value of " { $link num-types } "." } ;