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 classmethods::
  12
  13 method::nl
  14 Returns code::($\n)::
  15 method::ff
  16 Returns code::($\f)::
  17 method::tab
  18 Returns code::($\t)::
  19 method::space
  20 Returns code::($ )::
  21 method::comma
  22 Returns code::($\,)::
  23 method::bullet
  24 Returns a bullet character (•) in SuperCollider.app on OSX, but a simple asterix (*) on other frontends.
  25 This method is not recommended, since it's actually not cross-platform.
  26
  27 instancemethods::
  28 private:: archiveAsCompileString
  29
  30 subsection::conversion
  31
  32 method::ascii
  33
  34 returns:: the integer ascii value of a Char.
  35
  36 method::digit
  37
  38 returns:: an integer value from 0 to 9 for chars $0 to $9, and values 10 to 35 for chars $a to $z
  39 or $A to $Z.
  40
  41 method::toUpper
  42
  43 returns:: the upper case version of a char. Nonalphabetic chars return themselves.
  44
  45 method::toLower
  46
  47 returns:: a lower case version of a char. Nonalphabetic chars return themselves.
  48
  49 subsection:: Testing
  50
  51 method::isAlpha
  52
  53 returns:: whether the char is an alphabetic character.
  54
  55 method::isAlphaNum
  56
  57 returns:: whether the char is an alphabetic or numeric character.
  58
  59 method::isPrint
  60
  61 returns:: whether the char is printable.
  62
  63 method::isPunct
  64
  65 returns:: whether the char is a punctuation character
  66
  67 method::isSpace
  68
  69 returns:: true if the char is white space.
  70
  71 method::isDecDigit
  72
  73 returns:: true if the char is a decimal digit $0 to $9.
  74
  75 method::isFileSafe
  76
  77 returns:: true if the char is safe for use as in a filename.
  78 excludes the path separators / and :
  79 discussion::
  80 code::
  81  for(0,255,{ arg i;
  82         var a;
  83         [i,a = i.asAscii,a.isAlphaNum,a.isPrint,a.isPunct,a.isControl].postln;
  84 });
  85 ::