HelpSource/Classes/Char.schelp

   1 class::Char
   2 summary::ascii character
   3 categories:: Core
   4
   5 description::
   6 Chars may be written as literals using the $ sign. For example $a, $b, $c.
   7 See link::Reference/Literals::
   8
   9 Chars may be created from link::Classes/Integer::s using the methods link::Classes/Integer#-asAscii:: and link::Classes/Integer#-asDigit::.
  10
  11 instancemethods::
  12
  13 subsection::conversion
  14
  15 method::ascii
  16
  17 returns:: the integer ascii value of a Char.
  18
  19 method::digit
  20
  21 returns:: an integer value from 0 to 9 for chars $0 to $9, and values 10 to 35 for chars $a to $z
  22 or $A to $Z.
  23
  24 method::toUpper
  25
  26 returns:: the upper case version of a char. Nonalphabetic chars return themselves.
  27
  28 method::toLower
  29
  30 returns:: a lower case version of a char. Nonalphabetic chars return themselves.
  31
  32 subsection:: Testing
  33
  34 method::isAlpha
  35
  36 returns:: whether the char is an alphabetic character.
  37
  38 method::isAlphaNum
  39
  40 returns:: whether the char is an alphabetic or numeric character.
  41
  42 method::isPrint
  43
  44 returns:: whether the char is printable.
  45
  46 method::isPunct
  47
  48 returns:: whether the char is a punctuation character
  49
  50 method::isSpace
  51
  52 returns:: true if the char is white space.
  53
  54 method::isDecDigit
  55
  56 returns:: true if the char is a decimal digit $0 to $9.
  57
  58 method::isFileSafe
  59
  60 returns:: true if the char is safe for use as in a filename.
  61 excludes the path separators / and :
  62 discussion::
  63 code::
  64  for(0,255,{ arg i;
  65         var a;
  66         [i,a = i.asAscii,a.isAlphaNum,a.isPrint,a.isPunct,a.isControl].postln;
  67 });
  68 ::