basis/ascii/ascii-docs.factor

   1 USING: help.markup help.syntax kernel strings ;
   2 IN: ascii
   3
   4 HELP: blank?
   5 { $values { "ch" "a character" } { "?" boolean } }
   6 { $description "Tests for an ASCII whitespace character." } ;
   7
   8 HELP: letter?
   9 { $values { "ch" "a character" } { "?" boolean } }
  10 { $description "Tests for a lowercase alphabet ASCII character." } ;
  11
  12 HELP: LETTER?
  13 { $values { "ch" "a character" } { "?" boolean } }
  14 { $description "Tests for a uppercase alphabet ASCII character." } ;
  15
  16 HELP: digit?
  17 { $values { "ch" "a character" } { "?" boolean } }
  18 { $description "Tests for an ASCII decimal digit character." } ;
  19
  20 HELP: Letter?
  21 { $values { "ch" "a character" } { "?" boolean } }
  22 { $description "Tests for an ASCII alphabet character, both upper and lower case." } ;
  23
  24 HELP: alpha?
  25 { $values { "ch" "a character" } { "?" boolean } }
  26 { $description "Tests for an alphanumeric ASCII character." } ;
  27
  28 HELP: printable?
  29 { $values { "ch" "a character" } { "?" boolean } }
  30 { $description "Tests for a printable ASCII character." } ;
  31
  32 HELP: control?
  33 { $values { "ch" "a character" } { "?" boolean } }
  34 { $description "Tests for an ASCII control character." } ;
  35
  36 HELP: quotable?
  37 { $values { "ch" "a character" } { "?" boolean } }
  38 { $description "Tests for characters which may appear in a Factor string literal without escaping." } ;
  39
  40 HELP: ascii?
  41 { $values { "ch" "a character" } { "?" boolean } }
  42 { $description "Tests for whether a number is an ASCII character." } ;
  43
  44 HELP: ch>lower
  45 { $values { "ch" "a character" } { "lower" "a character" } }
  46 { $description "Converts an ASCII character to lower case." } ;
  47
  48 HELP: ch>upper
  49 { $values { "ch" "a character" } { "upper" "a character" } }
  50 { $description "Converts an ASCII character to upper case." } ;
  51
  52 HELP: >lower
  53 { $values { "str" string } { "lower" string } }
  54 { $description "Converts an ASCII string to lower case." } ;
  55
  56 HELP: >upper
  57 { $values { "str" string } { "upper" string } }
  58 { $description "Converts an ASCII string to upper case." } ;
  59
  60 HELP: >title
  61 { $values { "str" string } { "title" string } }
  62 { $description "Converts a string to title case." } ;
  63
  64 HELP: >words
  65 { $values { "str" string } { "words" "an array of slices" } }
  66 { $description "Divides the string up into words." } ;
  67
  68 HELP: capitalize
  69 { $values { "str" string } { "str'" string } }
  70 { $description "Capitalize all the words in a string." } ;
  71
  72 ARTICLE: "ascii" "ASCII"
  73 "The " { $vocab-link "ascii" } " vocabulary implements support for the legacy ASCII character set. Most applications should use " { $link "unicode" } " instead."
  74 $nl
  75 "ASCII character classes:"
  76 { $subsections
  77     blank?
  78     letter?
  79     LETTER?
  80     digit?
  81     printable?
  82     control?
  83     quotable?
  84     ascii?
  85 }
  86 "ASCII case conversion:"
  87 { $subsections
  88     ch>lower
  89     ch>upper
  90     >lower
  91     >upper
  92     >title
  93 } ;
  94
  95 ABOUT: "ascii"