\[ \newcommand{\ListType}{{\text{List}}} \newcommand{\ListEmpty}{{\left[\right]}} \newcommand{\ListLength}[1]{{\ell\left(#1\right)}} \newcommand{\ListAt}[2]{{{#1}_{#2}}} \]
Home

Michael Heilmann's Arcadia Ring 2

This is the documentation for Michael Heilmann's Arcadia Ring 2. Arcadia Ring 2 facilitates the creation of C programs - in particular interpreters - that are portable, maintainable, as well as safe. Arcadia Ring 2 is available at michaelheilmann.com/Arcadia/Ring2.

Features:

Files

You can find the sources of Arcadia Ring 2 in my GitHub repository https://github.com/michaelheilmann/arcadia. The subdirectory of Arcadia Ring 2 in the repository is here https://github.com/michaelheilmann/arcadia/tree/main/Runtime/Ring2.

Arcadia Ring 2 supports various platforms (including but not restricted to Windows, Linux, and many more), however, we currently only officially support Windows. For instructions on how to build, test, and use Arcadia Ring 1, refer to README.md in the root folder of the repository.

Further References

Arcadia Ring 2 relies on Arcadia Ring 1 and Arcadia ARMS.

Documentation

Objects

Arcadia_Object

Arcadia_Object is the ancestor type from which so called object types derive from.

Arcadia_Object types are allocated on the heap and can are referenced by Arcadia_Object* pointers.

Arcadia_Object_getHash

Arcadia_SizeValue
Arcadia_Object_getHash
  (
    Arcadia_Thread* thread,
    Arcadia_Object* self
  ) Get the hash of this Arcadia_Object or derived type value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_Object* self
A pointer to this code>Arcadia_Object or derived type value.

Return value

The hash of this code>Arcadia_Object or derived type value.

Arcadia_Object_isEqualTo

Arcadia_BooleanValue
Arcadia_Object_isEqualTo_pn
  (
    Arcadia_Thread* thread,
    Arcadia_Object* self,
    Arcadia_Value other
  ) Get if this Arcadia_Object or derived type value is equal to the specified value other.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_Object* self
A pointer to this code>Arcadia_Object or derived type value.
Arcadia_Value other
The other value.

Return value

Arcadia_BooleanValue_True if this code>Arcadia_Object or derived type value is equal to the other value. Arcadia_BooleanValue_False otherwise.

Arcadia_Object_isNotEqualTo

Arcadia_BooleanValue
Arcadia_Object_isEqualTo_pn
  (
    Arcadia_Thread* thread,
    Arcadia_Object* self,
    Arcadia_Value other
  ) Get if this Arcadia_Object or derived type value is not equal to the specified value other.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_Object* self
A pointer to this code>Arcadia_Object or derived type value.
Arcadia_Value other
The other value.

Return value

Arcadia_BooleanValue_True if this code>Arcadia_Object or derived type value is not equal to the other value. Arcadia_BooleanValue_False otherwise.

Arcadia_ByteArray

Arcadia_ByteArray extends Arcadia_Object.

Arcadia_ByteArray represents a mutable sequence of Bytes.

Arcadia_ByteArray_getAt

Arcadia_Natural8Value
Arcadia_ByteArray_getAt
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArray const* self,
    Arcadia_SizeValue index
  ) Get the Byte value at the specified index. Remarks: The size of a Byte array is the length of the Byte sequence it contains.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArray* self
A pointer to this Byte array.
Arcadia_SizeValue index
The index. Must be within the bounds [0,n) where n is the size of this Byte array.

Return value

The Byte value.

Arcadia_ByteArray_getBytes

void const*
Arcadia_ByteArray_getBytes
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArray const* self
  ) Get a pointer to the Bytes in this Byte array. Warning: The Bytes must not be modified. The pointer is valid only as long as the Byte array object is valid and is not modified.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArray* self
A pointer to this Byte array.

Return value

A pointer to the Bytes in this Byte array.

Arcadia_ByteArray_getNumberOfBytes

Arcadia_SizeValue
Arcadia_ByteArray_getNumberOfBytes
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArray const* self
  ) Get the number of Bytes in this Byte array. Remarks: This is an alias of Arcadia_ByteArray_getSize.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArray* self
A pointer to this Byte array.

Return value

The size of this Byte array.

Arcadia_ByteArray_getSize

Arcadia_SizeValue
Arcadia_ByteArray_getSize
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArray const* self
  ) Get the size of this Byte array. Remarks: The size of a Byte array is the number of Bytes in that Byte array. This is an alias of Arcadia_ByteArray_getNumberOfBytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArray* self
A pointer to this Byte array.

Return value

The size of this Byte array.

Arcadia_ByteArray_isEmpty

Arcadia_BooleanValue
Arcadia_ByteArray_isEmpty
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArray* self
  ) Get if this Byte array is empty.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArray* self
A pointer to this Byte array.

Return value

Arcadia_BooleanValue_True if this Byte array is empty. Arcadia_BooleanValue_False otherwise.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_ByteArrayBuilder_create

Arcadia_ByteArrayBuilder*
Arcadia_ByteArrayBuilder_create
  (
    Arcadia_Thread* thread
  ) Create a Byte buffer.

Parameters

A pointer to the Arcadia_Thread object.

Errors

Arcadia_Status_AllocationFailed
An allocation failed.

Return value

A pointer to the Arcadia_ByteArrayBuilder object.

Arcadia_ByteArrayBuilder

Arcadia_ByteArrayBuilder extends Arcadia_Object.

Arcadia_ByteArrayBuilder represents a mutable sequence of Bytes.

Arcadia_ByteArrayBuilder_clear

void
Arcadia_ByteArrayBuilder_clear
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self
  ) Set the number of elements of this Byte buffer to zero.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.

Arcadia_ByteArrayBuilder_create

Arcadia_ByteArrayBuilder*
Arcadia_ByteArrayBuilder_create
  (
    Arcadia_Thread* thread
  ) Create a Byte buffer.

Parameters

A pointer to the Arcadia_Thread object.

Errors

Arcadia_Status_AllocationFailed
An allocation failed.

Return value

A pointer to the Arcadia_ByteArrayBuilder object.

Arcadia_ByteArrayBuilder_getBytes

void const*
Arcadia_ByteArrayBuilder_getBytes
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder const* self
  ) Get a pointer to the Bytes in this Byte buffer. Warning: The Bytes must not be modified. The pointer is valid only as long as the Byte buffer object is valid and is not modified.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.

Return value

A pointer to the Bytes in this Byte buffer.

Arcadia_ByteArrayBuilder_getNumberOfBytes

Arcadia_SizeValue
Arcadia_ByteArrayBuilder_getNumberOfBytes
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder const* self
  ) Get the number of Bytes in this Byte buffer. Remarks: This is an alias of Arcadia_ByteArrayBuilder_getSize.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.

Return value

The size of this Byte buffer.

Arcadia_ByteArrayBuilder_getSize

Arcadia_SizeValue
Arcadia_ByteArrayBuilder_getSize
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder const* self
  ) Get the size of this Byte buffer. Remarks: The size of a Byte buffer is the number of Bytes in that Byte buffer. This is an alias of Arcadia_ByteArrayBuilder_getNumberOfBytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.

Return value

The size of this Byte buffer.

Arcadia_ByteArrayBuilder_insertBackBytes

void
Arcadia_ByteArrayBuilder_insertBackBytes
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Append Bytes to this Byte buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
void const* bytes
A pointer to an array of n Bytes.
Arcadia_SizeValue numberOfBytes
The number of Bytes in the array pointed to by p.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
bytes is a null pointer.
Arcadia_Status_AllocationFailed
An allocation failed.

Arcadia_ByteArrayBuilder_insertBytes

void
Arcadia_ByteArrayBuilder_insertBytes
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self,
    Arcadia_SizeValue index,
    void const* p,
    Arcadia_SizeValue n
  ) Insert Bytes into this Byte buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
Arcadia_SizeValue index
The index at which to insert the Bytes. Must be within the bounds of [0,n) where n is the size of this Byte buffer.
void const* p
A pointer to an array of n Bytes.
Arcadia_SizeValue n
The number of Bytes in the array pointed to by p.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
bytes is a null pointer.
Arcadia_Status_AllocationFailed
An allocation failed.

Arcadia_ByteArrayBuilder_insertFrontBytes

void
Arcadia_ByteArrayBuilder_insertFrontBytes
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self,
    void const* p,
    Arcadia_SizeValue n
  ) Prepend Bytes to this Byte buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
void const* p
A pointer to an array of n Bytes.
Arcadia_SizeValue n
The number of Bytes in the array pointed to by p.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
bytes is a null pointer.
Arcadia_Status_AllocationFailed
An allocation failed.

Arcadia_ByteArrayBuilder_endsWith_pn

Arcadia_BooleanValue
Arcadia_ByteArrayBuilder_endsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder const* self,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Get if a sequence of Bytes is a suffix of this Byte buffer's sequence of Bytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
void const* bytes
A pointer to an array of n Bytes.
Arcadia_SizeValue numberOfBytes
The number of Bytes in the array pointed to by p.

Return value

Arcadia_BooleanValue_True if the sequence of Bytes is a suffix of this byte buffer's sequence of Bytes. Arcadia_BooleanValue_False otherwise.

Arcadia_ByteArrayBuilder_startsWith_pn

Arcadia_BooleanValue
Arcadia_ByteArrayBuilder_startsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Get if a sequence of Bytes is a prefix of this Byte buffer's sequence of Bytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
void const* bytes
A pointer to an array of n Bytes.
Arcadia_SizeValue numberOfBytes
The number of Bytes in the array pointed to by p.

Return value

Arcadia_BooleanValue_True if the sequence of Bytes is a prefix of this byte buffer's sequence of Bytes. Arcadia_BooleanValue_False otherwise.

Arcadia_isEqualTo_pn

Arcadia_BooleanValue
Arcadia_ByteArrayBuilder_isEqualTo_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Get if a sequence of Bytes is this Byte buffer's sequence of Bytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
void const* bytes
A pointer to an array of n Bytes.
Arcadia_SizeValue numberOfBytes
The number of Bytes in the array pointed to by p.

Return value

Arcadia_BooleanValue_True if the sequence of Bytes is this byte buffer's sequence of Bytes. Arcadia_BooleanValue_False otherwise.

Arcadia_ByteArrayBuilder_isEqualTo

Arcadia_BooleanValue
Arcadia_ByteArrayBuilder_isEqualTo
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder const* self,
    Arcadia_ByteArrayBuilder const* other
  ) Compare this Byte buffer with another Byte buffer for equality.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder const* self
A pointer to this Byte buffer.
Arcadia_ByteArrayBuilder const* other
A pointer to the other Byte buffer.

Return value

Arcadia_BooleanValue_True if this Byte buffer is equal to the other Byte buffer. Arcadia_BooleanValue_False otherwise.

Arcadia_ByteArrayBuilder_getAt

Arcadia_Natural8Value
Arcadia_ByteArrayBuilder_getAt
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder const* self,
    Arcadia_SizeValue index
  ) Get the Byte value at the specified index. Remarks: The size of a Byte buffer is the length of the Byte sequence it contains.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
Arcadia_SizeValue index
The index. Must be within the bounds [0,n) where n is the size of this Byte buffer.

Return value

The Byte value.

Arcadia_ByteArrayBuilder_isEmpty

Arcadia_BooleanValue
Arcadia_ByteArrayBuilder_isEmpty
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self
  ) Get if this Byte buffer is empty.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.

Return value

Arcadia_BooleanValue_True if this Byte buffer is empty. Arcadia_BooleanValue_False otherwise.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_ByteArrayBuilder_swap

void
Arcadia_ByteArrayBuilder_swap
  (
    Arcadia_Thread* thread,
    Arcadia_ByteArrayBuilder* self,
    Arcadia_ByteArrayBuilder* other
  ) Swap the contents of this Byte buffer with the contents of another Byte buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteArrayBuilder* self
A pointer to this Byte buffer.
Arcadia_ByteArrayBuilder* self
A pointer to the other Byte buffer.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
other is a null pointer.

Arcadia_String

Arcadia_String extends Arcadia_Object.

Arcadia_String represents an immutable sequence of Unicode code points in UTF8 encoding.

Arcadia_String derives fro Arcadia_Object and overrides the following methods:

  • Arcadia_Object_isEqualTo
  • Arcadia_Object_isNotEqualTo
  • Arcadia_Object_getHash

Arcadia_String_createFromBoolean

Arcadia_String*
Arcadia_String_createFromBoolean
  (
    Arcadia_Thread* thread,
    Arcadia_BooleanValue booleanValue
  ) Create a string from an Arcadia_BooleanValue value. The Arcadia_BooleanValue value is converted to the strings true, if its value is Arcadia_BooleanValue_True, and false, if its value is Arcadia_BooleanValue_False, respectively.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_BooleanValue booleanValueThe Arcadia_BooleanValue to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromInteger16

Arcadia_String*
Arcadia_String_createFromInteger16
  (
    Arcadia_Thread* thread,
    Arcadia_Integer16Value integer16Value
  ) Create a string from an Arcadia_Integer16Value value. The Arcadia_Integer16Value value is converted to the decimal integer number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Integer16Value integer16ValueThe Arcadia_Integer16Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromInteger32

Arcadia_String*
Arcadia_String_createFromInteger32
  (
    Arcadia_Thread* thread,
    Arcadia_Integer32Value integer32Value
  ) Create a string from an Arcadia_Integer32Value value. The Arcadia_Integer32Value value is converted to the decimal integer number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Integer32Value integer32ValueThe Arcadia_Integer32Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromInteger64

Arcadia_String*
Arcadia_String_createFromInteger64
  (
    Arcadia_Thread* thread,
    Arcadia_Integer64Value integer64Value
  ) Create a string from an Arcadia_Integer64Value value. The Arcadia_Integer64Value value is converted to the decimal integer number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Integer64Value integer64ValueThe Arcadia_Integer64Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromInteger8

Arcadia_String*
Arcadia_String_createFromInteger8
  (
    Arcadia_Thread* thread,
    Arcadia_Integer8Value integer8Value
  ) Create a string from an Arcadia_Integer8Value value. The Arcadia_Integer8Value value is converted to the decimal integer number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Integer8Value integer8ValueThe Arcadia_Integer8Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromNatural16

Arcadia_String*
Arcadia_String_createFromNatural16
  (
    Arcadia_Thread* thread,
    Arcadia_Natural16Value natural64Value
  ) Create a string from an Arcadia_Natural16Value value. The Arcadia_Natural16Value value is converted to the decimal natural number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Natural16Value natural16ValueThe Arcadia_Natural16Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromNatural32

Arcadia_String*
Arcadia_String_createFromNatural32
  (
    Arcadia_Thread* thread,
    Arcadia_Natural32Value natural64Value
  ) Create a string from an Arcadia_Natural32Value value. The Arcadia_Natural32Value value is converted to the decimal natural number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Natural32Value natural32ValueThe Arcadia_Natural32Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromNatural64

Arcadia_String*
Arcadia_String_createFromNatural64
  (
    Arcadia_Thread* thread,
    Arcadia_Natural64Value natural64Value
  ) Create a string from an Arcadia_Natural64Value value. The Arcadia_Natural64Value value is converted to the decimal natural number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Natural64Value natural64ValueThe Arcadia_Natural64Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromNatural8

Arcadia_String*
Arcadia_String_createFromNatural8
  (
    Arcadia_Thread* thread,
    Arcadia_Natural8Value natural64Value
  ) Create a string from an Arcadia_Natural8Value value. The Arcadia_Natural8Value value is converted to the decimal natural number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Natural8Value natural8ValueThe Arcadia_Natural8Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromReal32

Arcadia_String*
Arcadia_String_createFromReal32
  (
    Arcadia_Thread* thread,
    Arcadia_Real32Value real32Value
  ) Create a string from an Arcadia_Real3lValue value. The Arcadia_Real32Value value is converted to the decimal real number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Real32Value real32ValueThe Arcadia_Real32Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromReal64

Arcadia_String*
Arcadia_String_createFromReal64
  (
    Arcadia_Thread* thread,
    Arcadia_Real64Value real64Value
  ) Create a string from an Arcadia_Real64Value value. The Arcadia_Real64Value value is converted to the decimal real number literal string.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_Real64Value real64ValueThe Arcadia_Real64Value to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_createFromVoid

Arcadia_String*
Arcadia_String_createFromBoolean
  (
    Arcadia_Thread* thread,
    Arcadia_VoidValue voidValue
  ) Create a string from an Arcadia_VoidValue value. The Arcadia_VoidValue value is converted to the string void.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_VoidValue voidValueThe Arcadia_VoidValue to be converted into the string value.

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_String_create_pn

Arcadia_String*
Arcadia_String_create_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ImmutableByteArray* immutableByteArray
  ) Create a string from an immutable Byte array.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_ImmutableByteBuffer* immutableByteArrayA pointer to the Arcadia_ImmutableByteArray object

Return value

A pointer to the Arcadia_String object.

Errors

Arcadia_Status_ArgumentValueInvalidimmutableByteArray is a null pointer. Arcadia_Status_EncodingInvalid The sequence of Bytes does not represented a UTF-8-NO-BOM string.

Arcadia_String_create

Arcadia_String*
Arcadia_String_create
  (
    Arcadia_Thread* thread,
    Arcadia_Value value
  )

Create a string from a value.

The following values are accepted:

The specified value may contain a Arcadia_ByteBuffer object. In that case, the string is created from the Bytes of the Byte buffer object. A Arcadia_Status_EncodingInvalid is raised if the Byte sequence of that Arcada_ByteBuffer object is not a UTF8 Byte sequence.

The specified value may contain a Arcadia_ImmutableByteArray object. In that case, the string is created from the Arcadia_ImmutableByteArray object. A Arcadia_Status_EncodingInvalid is raised if the Byte sequence of that Arcada_ImmutableByteArray object is not a UTF8 Byte sequence.

The specified value may contain a Arcadia_String object. In that case, the string is created from the Arcadia_String object.

The specified value may contain a Arcadia_StringBuffer object. In that case, the string is created from the Arcadia_StringBuffer object.

The specified value may contain a Arcadia_ImmutableUtf8String object. In that case, the string is created from the Arcadia_ImmutableUtf8String object.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Value value
The value.

Return value

A pointer to the string.

Errors

Arcadia_Status_ArgumentTypeInvalid
The value is not of type Arcadia_ByteBuffer, Arcadia_String, Arcadia_StringBuffer, or Arcadia_ImmutableByteArray.
Arcadia_Status_EncodingInvalid
The value is a Arcadia_ByteBuffer or Arcadia_ImmutableByteArray. However, the Byte sequence of that Arcadia_ByteBuffer or Arcadia_ImmutableByteArray object is not a UTF8 Byte sequence.

Arcadia_String_endsWith_pn

Arcadia_BooleanValue
Arcadia_String_endsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Get if a sequence of Bytes is a suffix of this string's sequence of Bytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.
void const* bytes
A pointer to an array of n Bytes.
Arcadia_SizeValue numberOfBytes
The number of Bytes in the array pointed to by p.

Return value

Arcadia_BooleanValue_True if the sequence of Bytes is a suffix of this string's sequence of Bytes. Arcadia_BooleanValue_False otherwise.

Arcadia_String_startsWith_pn

Arcadia_BooleanValue
Arcadia_String_startsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Get if a sequence of Bytes is a prefix of this string's sequence of Bytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.
void const* bytes
A pointer to an array of n Bytes.
Arcadia_SizeValue numberOfBytes
The number of Bytes in the array pointed to by p.

Return value

Arcadia_BooleanValue_True if the sequence of Bytes is a prefix of this string's sequence of Bytes. Arcadia_BooleanValue_False otherwise.

Arcadia_String_isEqualTo_pn

Arcadia_BooleanValue
Arcadia_String_isEqualTo_pn
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Get if a sequence of Bytes is this string's sequence of Bytes.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.
void const* bytes
A pointer to an array of n Bytes.
Arcadia_SizeValue numberOfBytes
The number of Bytes in the array pointed to by p.

Return value

Arcadia_BooleanValue_True if the sequence of Bytes is this string's sequence of Bytes. Arcadia_BooleanValue_False otherwise.

Arcadia_String_getNumberOfBytes

Arcadia_SizeValue
Arcadia_String_getNumberOfBytes
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Get the size, in Bytes, of this string.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The size, in Bytes, of this string.

Arcadia_String_getByteAt

Arcadia_Natural8Value
Arcadia_String_getByteAt
  (
    Arcadia_String const* self,
    Arcadia_SizeValue index
  ) Get the Byte value at the specified index.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.
Arcadia_SizeValue index
The index. Must be within the bounds [0,n) where n is the size, in Bytes, of this string.

Return value

The Byte value.

Arcadia_String_toBoolean

Arcadia_BooleanValue
Arcadia_String_toBoolean
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as boolean literal and convert the boolean represented by that literal into an Arcadia_BooleanValue.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The boolean value.

Errors

Arcadia_Status_ArgumentTypeInvalid self is a null pointer. Arcadia_Status_ConversionFailed The symbols of this string cannot be interpreted as a boolean literal. Valid boolean literals are true and false, both case sensitve.

Arcadia_String_toInteger16

Arcadia_Integer16Value
Arcadia_String_toInteger16
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as decimal integer literal and convert the number represented by that integer literal into an Arcadia_Integer16Value.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_String* selfA pointer to this string.

Return value

The integer value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal integer literal or the number represented by the literal cannot be represented a value of type Arcadia_Integer16Value.

Arcadia_String_toInteger32

Arcadia_Integer32Value
Arcadia_String_toInteger32
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as decimal integer literal and convert the number represented by that literal into an Arcadia_Integer32Value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The integer value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal integer literal or the number represented by the literal cannot be represented a value of type Arcadia_Integer32Value.

Arcadia_String_toInteger64

Arcadia_Integer64Value
Arcadia_String_toInteger64
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as decimal integer literal and convert the number represented by that literal into an Arcadia_Integer64Value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The integer value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal integer literal or the number represented by the literal cannot be represented a value of type Arcadia_Integer64Value.

Arcadia_String_toInteger8

Arcadia_Integer8Value
Arcadia_String_toInteger8
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as decimal integer literal and convert the number represented by that literal into an Arcadia_Integer8Value.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The integer value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal integer literal or the number represented by the integer literal cannot be represented a value of type Arcadia_Integer8Value.

Arcadia_String_toNatural16

Arcadia_Natural16Value
Arcadia_Stringg_toNatural16
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as decimal natural literal and convert the number represented by that literal into an Arcadia_Natural16Value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The natural value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal natural literal or the number represented by the literal cannot be represented a value of type Arcadia_Natural16Value.

Arcadia_String_toNatural32

Arcadia_Natural32Value
Arcadia_String_toNatural32
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as decimal natural literal and convert the number represented by that literal into an Arcadia_Natural32Value.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_String* selfA pointer to this string.

Return value

The natural value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal natural literal or the number represented by the literal cannot be represented a value of type Arcadia_Natural32Value.

Arcadia_String_toNatural64

Arcadia_Natural64Value
Arcadia_String_toNatural64
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as a decimal natural literal and convert the number represented by that literal into an Arcadia_Natural64Value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The natural value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal natural literal or the number represented by the literal cannot be represented a value of type Arcadia_Natural64Value.

Arcadia_String_toNatural8

Arcadia_Natural8Value
Arcadia_String_toNatural8
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as a decimal natural literal and convert the number represented by that literal into an Arcadia_Natural8Value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The natural value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal natural literal or the number represented by the literal cannot be represented a value of type Arcadia_Natural8Value.

Arcadia_String_toReal32

Arcadia_Real32Value
Arcadia_String_toReal32
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as a decimal real literal and convert the number represented by that literal into an Arcadia_Real32Value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The Arcadia_Real32Value value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal real literal or the number represented by the literal cannot be represented a value of type Arcadia_Real32Value.

Arcadia_String_toReal64

Arcadia_Real64Value
Arcadia_String_toReal64
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as a decimal real literal and convert the number represented by that literal into an Arcadia_Real64Value.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_String* self
A pointer to this string.

Return value

The Arcadia_Real64Value value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a decimal real literal or the number represented by the literal cannot be represented a value of type Arcadia_Real64Value.

Arcadia_String_toVoid

Arcadia_VoidValue
Arcadia_String_toVoid
  (
    Arcadia_Thread* thread,
    Arcadia_String const* self
  ) Interprete the symbols of this string as a void literal and convert the void value represented by that literal into an Arcadia_VoidValue.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_String* selfA pointer to this string.

Return value

The void value.

Errors

Arcadia_Status_ArgumentTypeInvalid
self is a null pointer.
Arcadia_Status_ConversionFailed
The symbols of this string cannot be interpreted as a void literal. The valid void literal is void, case sensitve.

Arcadia_StringBuilder

Arcadia_StringBuilder extends Arcadia_Object.

Arcadia_StringBuilder represents a mutable sequence of code points in UTF8 encoding.

Arcadia_StringBuilder_clear

void
Arcadia_StringBuilder_clear
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuilder* self
  ) Clear this string buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuilder self
A pointer to this string buffer.

Arcadia_StringBuilder_create

Arcadia_StringBuilder*
Arcadia_StringBuilder_create
  (
    Arcadia_Thread* thread
  ) Create a string buffer.

Parameters

A pointer to the Arcadia_Thread object.

Errors

Arcadia_Status_AllocationFailed
An allocation failed.

Return value

A pointer to the Arcadia_StringBuilder value.

Arcadia_StringBuilder_compareTo

Arcadia_Integer32Value*
Arcadia_StringBuilder_compareTo
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuilder* self,
    Arcadia_Value other
  ) Compare the string in this string buffer with another string lexicographically.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuilder* self
A pointer to this string buffer.
Arcadia_Value other
The value to compare the UTF-8 string in this string buffer to. The value must be one of Arcadia.ImmutableUtf8String, Arcadia.StringBuilder, or Arcadia.String.

Errors

Arcadia_Status_AllocationFailed
An allocation failed.

Return value

  • A negative value is returned if the string in this string buffer is lexicographically less than the other string.
  • A positive value is returned if the string in this string buffer is lexicographically greater than the other string.
  • If both strings are lexicographically equal, then zero is returned.

Remarks

Let a and b be UTF-8 strings of n and m Bytes, respectively. Denote the i-th Byte of a by a[i] (given a is not empty) and the i-th Byte of b by b[i] (given that b is not empty), respectively. Then comparing a and b lexicographically means: Let l := min(n,m). If l is 0 or a[i] = b[i] for all i in [0, l-1], then

  • a is lexicographically less than b if n < m
  • a is lexicographically greater than b if n > m
  • a and b are lexicographically equal if n = m

Otherwise there exists an i in [0, l - 1] such that for all a[j] = b[j] for all j < i holds and a[i] != b[i]. In that case:

  • a is lexicographically less than b if a[i] < b[i]
  • a is lexicographically greater than b if a[i] > b[i]

Arcadia_StringBuilder_getNumberOfBytes

Arcadia_SizeValue
Arcadia_StringBuilder_getNumberOfBytes
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuilder self
  ) Get the number of Bytes in this string buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuilder* self
A pointer to this string buffer.

Return value

The number of Bytes in this string buffer.

Arcadia_StringBuilder_insertAt

void
Arcadia_StringBuilder_insertAt
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuilder* self,
    Arcadia_SizeValue index,
    Arcadia_Value value
  ) Insert a value at a code point index of string buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuilder* self
A pointer to this string buffer.
Arcadia_SizeValue index
The code point index at which to insert the value. Must be within the bounds of [0,n] where n is the number of code points in this string buffer. If index is 0, then this call is equivalent to a call to Arcadia_StringBuilder_insertFront. If index is n, then this call is equivalent to a call to Arcadia_StringBuilder_insertBack.
Arcadia_Value value
The value to insert at the code point index. The value must be of one of the following types: Arcadia.ImmutableByteArray, Arcadia.ImmutableUtf8String, Arcadia.ByteBuffer, Arcadia.StringBuilder, or Arcadia.String.

Errors

Arcadia_Status_ArgumentTypeInvalid
value is not of an accepted type.
Arcadia_Status_ArgumentValueInvalid
index is not within the bounds of [0,n] where n is the number of code points in this string buffer.
Arcadia_Status_EncodingInvalid
value is of type Arcadia.ImmutableByteArray or Arcadia.ByteBuffer and the Bytes are not a valid UTF-8 Byte sequence.

Arcadia_StringBuilder_insertBack

void
Arcadia_StringBuilder_insertFront
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuilder* self,
    Arcadia_Value value
  ) Insert a value at the back of this string buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuilder* self
A pointer to this string buffer.
Arcadia_Value value
The value to insert at the back. The value must be of one of the following types: Arcadia.ImmutableByteArray, Arcadia.ImmutableUtf8String, Arcadia.ByteBuffer, Arcadia.StringBuilder, or Arcadia.String.

Errors

Arcadia_Status_ArgumentTypeInvalid
value is not of an accepted type.
Arcadia_Status_EncodingInvalid
value is of type Arcadia.ImmutableByteArray or Arcadia.ByteBuffer and the Bytes are not a valid UTF-8 Byte sequence.

Arcadia_StringBuilder_insertFront

void
Arcadia_StringBuilder_insertFront
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuilder* self,
    Arcadia_Value value
  ) Insert a value at the front of this string buffer.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuilder* self
A pointer to this string buffer.
Arcadia_Value value
The value to insert at the front. The value must be of one of the following types: Arcadia.ImmutableByteArray, Arcadia.ImmutableUtf8String, Arcadia.ByteBuffer, Arcadia.StringBuilder, or Arcadia.String.

Errors

Arcadia_Status_ArgumentTypeInvalid
value is not of an accepted type.
Arcadia_Status_EncodingInvalid
value is of type Arcadia.ImmutableByteArray or Arcadia.ByteBuffer and the Bytes are not a valid UTF-8 Byte sequence.

Arcadia_StringBuilder_isEmpty

Arcadia_BooleanValue
Arcadia_StringBuilder_isEmpty
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuilder* self
  ) Get if this string buffer is empty.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuilder* self
A pointer to this string buffer.

Return value

Arcadia_BooleanValue_True if this string buffer is empty. Arcadia_BooleanValue_False otherwise.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.