/core/generic/standard/standard-docs.factor

http://github.com/abeaumont/factor · Factor · 22 lines · 20 code · 2 blank · 0 comment · 0 complexity · 66eac893c8ee55e5297869e30ad5276f MD5 · raw file

  1. USING: generic generic.single help.markup help.syntax sequences math
  2. math.parser effects ;
  3. IN: generic.standard
  4. HELP: standard-combination
  5. { $class-description
  6. "Performs standard method combination."
  7. $nl
  8. "Generic words using the standard method combination dispatch on the class of the object at the given stack position, where 0 is the top of the stack, 1 is the object underneath, and 2 is the next one under that. A " { $link no-method } " error is thrown if no suitable method is defined on the class."
  9. }
  10. { $examples
  11. "A generic word for append strings and characters to a sequence, dispatching on the object underneath the top of the stack:"
  12. { $code
  13. "GENERIC# build-string 1 ( elt str -- )"
  14. "M: string build-string swap push-all ;"
  15. "M: integer build-string push ;"
  16. }
  17. } ;
  18. HELP: define-simple-generic
  19. { $values { "word" "a word" } { "effect" effect } }
  20. { $description "Defines a generic word with the " { $link standard-combination } " method combination and a dispatch position of 0." } ;