basis/ascii/ascii-docs.factor

   1 USING: help.markup help.syntax kernel strings ;\r
   2 IN: ascii\r
   3 \r
   4 HELP: blank?\r
   5 { $values { "ch" "a character" } { "?" boolean } }\r
   6 { $description "Tests for an ASCII whitespace character." } ;\r
   7 \r
   8 HELP: letter?\r
   9 { $values { "ch" "a character" } { "?" boolean } }\r
  10 { $description "Tests for a lowercase alphabet ASCII character." } ;\r
  11 \r
  12 HELP: LETTER?\r
  13 { $values { "ch" "a character" } { "?" boolean } }\r
  14 { $description "Tests for a uppercase alphabet ASCII character." } ;\r
  15 \r
  16 HELP: digit?\r
  17 { $values { "ch" "a character" } { "?" boolean } }\r
  18 { $description "Tests for an ASCII decimal digit character." } ;\r
  19 \r
  20 HELP: Letter?\r
  21 { $values { "ch" "a character" } { "?" 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" } { "?" boolean } }\r
  26 { $description "Tests for an alphanumeric ASCII character." } ;\r
  27 \r
  28 HELP: printable?\r
  29 { $values { "ch" "a character" } { "?" boolean } }\r
  30 { $description "Tests for a printable ASCII character." } ;\r
  31 \r
  32 HELP: control?\r
  33 { $values { "ch" "a character" } { "?" boolean } }\r
  34 { $description "Tests for an ASCII control character." } ;\r
  35 \r
  36 HELP: quotable?\r
  37 { $values { "ch" "a character" } { "?" 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" } { "?" 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" string } { "lower" string } }\r
  54 { $description "Converts an ASCII string to lower case." } ;\r
  55 \r
  56 HELP: >upper\r
  57 { $values { "str" string } { "upper" string } }\r
  58 { $description "Converts an ASCII string to upper case." } ;\r
  59 \r
  60 HELP: >title\r
  61 { $values { "str" string } { "title" string } }\r
  62 { $description "Converts a string to title case." } ;\r
  63 \r
  64 HELP: >words\r
  65 { $values { "str" string } { "words" "an array of slices" } }\r
  66 { $description "Divides the string up into words." } ;\r
  67 \r
  68 HELP: capitalize\r
  69 { $values { "str" string } { "str'" string } }\r
  70 { $description "Capitalize all the words in a string." } ;\r
  71 \r
  72 ARTICLE: "ascii" "ASCII"\r
  73 "The " { $vocab-link "ascii" } " vocabulary implements support for the legacy ASCII character set. Most applications should use " { $link "unicode" } " instead."\r
  74 $nl\r
  75 "ASCII character classes:"\r
  76 { $subsections\r
  77     blank?\r
  78     letter?\r
  79     LETTER?\r
  80     digit?\r
  81     printable?\r
  82     control?\r
  83     quotable?\r
  84     ascii?\r
  85 }\r
  86 "ASCII case conversion:"\r
  87 { $subsections\r
  88     ch>lower\r
  89     ch>upper\r
  90     >lower\r
  91     >upper\r
  92     >title\r
  93 } ;\r
  94 \r
  95 ABOUT: "ascii"\r