Literals are values which have a direct syntactic representation. The following sections describe the types of literals that can be represented.
An integer is any series of digits optionally preceded by a minus sign:
They can also also be expressed in hexidecimal with the prefix 0x
and either uppercase or lowercase letters:
A float, or floating-point number, is one or more decimal digits, followed by a decimal point, followed by one or more decimal digits. You must have digits on both sides of the decimal point. In SuperCollider, floating-point numbers are always 64-bit, except within a FloatArray.
Examples of floats:
Exponential notation is also supported:
The keyword pi
can also be used by itself, or appended to a float or integer to create a floating point constant:
The keyword inf
represents infinity, and is also treated as an instance of Float.
Numbers can also be written in radices other than base 10 up to base 36. The radix is specified in base 10, followed by the letter 'r', followed by the value written in that radix using characters 0-9 and A-Z (or a-z) for digit values from 0 to 35. For example, you can write hexadecimal numbers as follows:
Binary numbers can be written as follows:
Floating point values may also be specified in any base. However, only uppercase letters may be used past the decimal point for bases greater than 10. This eliminates ambiguity: if lowercase letters were allowed, 36rA.bitNot
might be a function call, or it might be 36rA.BITNOT == 10.320080118934
.
Hexidecimal numbers notated with 0x
may only be expressed as integers.
Integer numbers as scale degrees supports accidentals notation by adding the suffixes s for sharp and b for flat. Accidentals are represented as floating point values.
Up to four:
With negative scale degrees it reverses:
Accidentals can also specify cents deviation up to 499 cents:
Characters are preceded by a dollar sign:
As in C and Java, backslash ('\') is the escape character. Escaping has two main purposes. First, to insert non-printing characters into a String. Secondly, to allow a String or Symbol delimiter to be included in the contents. For String, double-quote marks indicate the beginning and ending of the String literal. To put a double-quote in the middle of the string, the normal meaning of double-quote must be suspended ("escaped"), as in "He repeated, \"Madam, I'm Adam,\" only this time he had said it backward."
In all cases, the \ as an escape character does not appear in the String or Symbol. This is a frequent source of confusion for Windows file paths: e.g., "C:\Users\Somebody\SuperCollider"
translates into C:UsersSomebodySuperCollider
. The way to notate a literal backslash inside a String or Symbol is with a double-backslash: "C:\\Users\\Somebody\\SuperCollider"
. (Note, however, that it is preferable to write file paths using forward slashes, regardless of platform: "C:/Users/Somebody/SuperCollider"
.
The following are the recognized escape characters in SuperCollider. A backslash before any other character will simply produce that character.
A symbol can be written in two ways. One method is to enclose the contents in single quotes. Any printing character may be used within a symbol except for non-space whitespace characters (\f, \n, \r, \t, \v
). Any single quotes within the symbol must be escaped (\'
).
A second way of notating symbols is by prefixing the word with a backslash. This is only legal if the symbol consists of a single word (a sequence of alphanumeric and/or underscore characters).
Strings are written in double quotes:
If two or more strings are lexically adjacent, then they combine into a larger string:
Strings may span more than one line. The newline characters become part of the string:
The SuperCollider IDE uses UTF-8 to decode and display strings. See String: Character encodings for more information.
Names of methods and variables begin with a lower case alphabetic character, followed by zero or more alphanumeric or underscore characters.
Class names always begin with a capital letter followed by zero or more alphanumeric or underscore characters.
The singular instances of the classes True, False and Nil can be expressed with keywords true
, false
, and nil
.
Arrays of literals are created at compile time and are written with a # preceding the array as follows:
Literal Arrays must be used as is and may not be altered at run time.
In literal Arrays names are interpreted as symbols. This is not the case in regular Arrays, where they are interpreted as variable names:
Arrays and other collections may also be created dynamically which is explained in Collection. Using a literal Array is faster than building an array dynamically every time you need it.
When nesting literal arrays, only the outermost literal array needs the '#' character.
Literal Arrays can be useful for things such as tables of constants, for example note names:
There is no theoretical limit on the number of literals in a single function, if those literals are used as freestanding objects. (Of course, there remains the practical limits of system memory and the processor time required to keep track of all the objects.)
The following are a special category of literal, called selectors.
{ }
)Here, there are four selectors: SinOsc
, ar
, play
and the entire function containing SinOsc.
{ SinOsc.ar(440, 0, 0.1) }.play;
A single function may contain no more than 256 selectors. If this limit is exceeded, a compiler error is printed:
ERROR: Selector table too big: too many classes, method selectors or function definitions in this function. Simplify the function.
Selectors are counted only toward the function definition currently being compiled.
Both functions contain exactly one selector. They are separate functions. The use of "foo" in one function doesn't affect the number of selectors in another function.
The outer function includes only the selector value
. The other selectors -- >
, *
, -
-- belong to the inner function definition and don't affect the outer function's number of selectors.
So, one possible easy way to work around the limitation is to break up a large block of code into several functions that are value'd successively: