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 ARTICLE: "ascii" "ASCII character classes"\r
  41 "The " { $vocab-link "ascii" } " vocabulary implements traditional ASCII character classes:"\r
  42 { $subsection blank? }\r
  43 { $subsection letter? }\r
  44 { $subsection LETTER? }\r
  45 { $subsection digit? }\r
  46 { $subsection printable? }\r
  47 { $subsection control? }\r
  48 { $subsection quotable? }\r
  49 "Modern applications should use Unicode 5.0 instead (" { $vocab-link "unicode.categories" } ")." ;\r
  50 \r
  51 ABOUT: "ascii"\r