basis/ascii/ascii-docs.factor

   1 USING: help.markup help.syntax ;\r
   2 IN: ascii\r
   3 \r
   4 HELP: blank?\r
   5 { $values { "ch" "a character" } { "?" "a boolean" } }\r
   6 { $description "Tests for an ASCII whitespace character." } ;\r
   7 \r
   8 HELP: letter?\r
   9 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  10 { $description "Tests for a lowercase alphabet ASCII character." } ;\r
  11 \r
  12 HELP: LETTER?\r
  13 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  14 { $description "Tests for a uppercase alphabet ASCII character." } ;\r
  15 \r
  16 HELP: digit?\r
  17 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  18 { $description "Tests for an ASCII decimal digit character." } ;\r
  19 \r
  20 HELP: Letter?\r
  21 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  22 { $description "Tests for an ASCII alphabet character, both upper and lower case." } ;\r
  23 \r
  24 HELP: alpha?\r
  25 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  26 { $description "Tests for an alphanumeric ASCII character." } ;\r
  27 \r
  28 HELP: printable?\r
  29 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  30 { $description "Tests for a printable ASCII character." } ;\r
  31 \r
  32 HELP: control?\r
  33 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  34 { $description "Tests for an ASCII control character." } ;\r
  35 \r
  36 HELP: quotable?\r
  37 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  38 { $description "Tests for characters which may appear in a Factor string literal without escaping." } ;\r
  39 \r
  40 HELP: ascii?\r
  41 { $values { "ch" "a character" } { "?" "a boolean" } }\r
  42 { $description "Tests for whether a number is an ASCII character." } ;\r
  43 \r
  44 HELP: ch>lower\r
  45 { $values { "ch" "a character" } { "lower" "a character" } }\r
  46 { $description "Converts an ASCII character to lower case." } ;\r
  47 \r
  48 HELP: ch>upper\r
  49 { $values { "ch" "a character" } { "upper" "a character" } }\r
  50 { $description "Converts an ASCII character to upper case." } ;\r
  51 \r
  52 HELP: >lower\r
  53 { $values { "str" "a string" } { "lower" "a string" } }\r
  54 { $description "Converts an ASCII string to lower case." } ;\r
  55 \r
  56 HELP: >upper\r
  57 { $values { "str" "a string" } { "upper" "a string" } }\r
  58 { $description "Converts an ASCII string to upper case." } ;\r
  59 \r
  60 ARTICLE: "ascii" "ASCII character classes"\r
  61 "The " { $vocab-link "ascii" } " vocabulary implements traditional ASCII character classes:"\r
  62 { $subsection blank? }\r
  63 { $subsection letter? }\r
  64 { $subsection LETTER? }\r
  65 { $subsection digit? }\r
  66 { $subsection printable? }\r
  67 { $subsection control? }\r
  68 { $subsection quotable? }\r
  69 { $subsection ascii? }\r
  70 "ASCII case conversion is also implemented:"\r
  71 { $subsection ch>lower }\r
  72 { $subsection ch>upper }\r
  73 { $subsection >lower }\r
  74 { $subsection >upper }\r
  75 "Modern applications should use Unicode 5.1 instead (" { $vocab-link "unicode.categories" } ")." ;\r
  76 \r
  77 ABOUT: "ascii"\r