AngelScript: Strings

# Strings

Strings are a special type of data that can be used only if the application registers support for them. They hold an array of bytes or 16bit words depending on the application settings. The only limit to how large this array can be is the memory available on the computer.

There are two types of string constants supported in the AngelScript language, the normal double quoted string, and the documentation strings, called heredoc strings.

The normal strings are written between double quotation marks (`"`) or single quotation marks (`'`)1. Inside the constant strings some escape sequences can be used to write exact byte values that might not be possible to write in your normal editor.

sequence | value | description
`\0` | 0 | null character
`\\` | 92 | back-slash
`\'` | 39 | single quotation mark (apostrophe)
`\"` | 34 | double quotation mark
`\n` | 10 | new line feed
`\r` | 13 | carriage return
`\t` | 9 | tab character
`\xFFFF` | 0xFFFF | FFFF should be exchanged for a 1 to 4 digit hexadecimal number representing the value wanted. If the application uses 8bit strings then only values up to 255 is accepted.
`\uFFFF` | 0xFFFF | FFFF should be exchanged for the hexadecimal number representing the unicode code point
`\UFFFFFFFF` | 0xFFFFFFFF | FFFFFFFF should be exchanged for the hexadecimal number representing the unicode code point

      string str1 = "This is a string with \"escape sequences\".";
      string str2 = 'If single quotes are used then double quotes can be included without "escape sequences".';

The heredoc strings are designed for inclusion of large portions of text without processing of escape sequences. A heredoc string is surrounded by triple double-quotation marks (`"""`), and can span multiple lines of code. If the characters following the start of the string until the first linebreak only contains white space, it is automatically removed by the compiler. Likewise if the characters following the last line break until the end of the string only contains white space this is also remove, including the linebreak.

      string str = """
      This is some text without "escape sequences". This is some text.
      This is some text. This is some text. This is some text. This is
      some text. This is some text. This is some text. This is some
      text. This is some text. This is some text. This is some text.
      This is some text.
      """;

If more than one string constants are written in sequence with only whitespace or comments between them the compiler will concatenate them into one constant.

      string str = "First line.\n"
                   "Second line.\n"
                   "Third line.\n";

The escape sequences \u and \U will add the specified unicode code point as a UTF-8 or UTF-16 encoded sequence depending on the application settings. Only valid unicode 5.1 code points are accepted, i.e. code points between U+D800 and U+DFFF (reserved for surrogate pairs) or above U+10FFFF are not accepted.

1) The application can change the interpretation of single quoted strings by setting an engine property. If this is done the first character in the single quoted string will be interpreted as a single uint value instead of a string literal.