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.

Files

You can find the sources of Arcadia Ring 2 in my GitHub repository https://github.com/michaelheilmann/michaelheilmann.com. The subdirectory of Arcadia Ring 2 in the repository is here https://github.com/michaelheilmann/michaelheilmann.com/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_ByteBuffer

Arcadia_ByteBuffer extends Arcadia_Object.

Arcadia_ByteBuffer represents a mutable sequence of Bytes.

Arcadia_ByteBuffer_create

Arcadia_ByteBuffer*
Arcadia_ByteBuffer_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_ByteBuffer object.

Arcadia_ByteBuffer_clear

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

Parameters

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

Arcadia_ByteBuffer_endsWith_pn

Arcadia_BooleanValue
Arcadia_ByteBuffer_endsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer 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_ByteBuffer* 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_ByteBuffer_startsWith_pn

Arcadia_BooleanValue
Arcadia_ByteBuffer_startsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer* 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_ByteBuffer* 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_ByteBuffer_isEqualTo_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer* 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_ByteBuffer* 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_ByteBuffer_append_pn

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* 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_ByteBuffer_prepend_pn

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* 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_ByteBuffer_insert_pn

void
Arcadia_ByteBuffer_insert_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer* 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_ByteBuffer* 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_ByteBuffer_isEqualTo

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer const* self
A pointer to this Byte buffer.
Arcadia_ByteBuffer 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_ByteBuffer_getSize

Arcadia_SizeValue
Arcadia_ByteBuffer_getSize
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer const* self
  ) Get the size of this Byte buffer. 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_ByteBuffer* self
A pointer to this Byte buffer.

Return value

The size of this Byte buffer.

Arcadia_ByteBuffer_getAt

Arcadia_Natural8Value
Arcadia_ByteBuffer_getAt
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer 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_ByteBuffer* 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_ByteBuffer_isEmpty

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* 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_ByteBuffer_swap

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* self
A pointer to this Byte buffer.
Arcadia_ByteBuffer* 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_ExistingFilePolicy

typedef enum Arcadia_ExistingFilePolicy Arcadia_ExistingFilePolicy; An enumeration of policies for opening a file in case of that the file exists. The enumeration elements cannot be combined.

Elements

Arcadia_ExistingFilePolicy_Retain
Retain the file contents.
Arcadia_ExistingFilePolicy_Truncate
Truncate the file contants.

Arcadia_FileAccessMode

typedef enum Arcadia_FileAccessMode Arcadia_FileAccessMode; An enumeration of file access modes. The enumeration elements can be combined.

Elements

Arcadia_FileAccessMode_Read
Read access. Can be combined with Arcadia_FileAccessMode_Write.
Arcadia_FileAccessMode_Write
Write access. Can be combined with Arcadia_FileAccessMode_Read.
Arcadia_FileAccessMode_ReadWrite
Read and write access. Alias for Arcadia_FileAccessMode_Read|Arcadia_FileAccessMode_Write and for Arcadia_FileAccessMode_WriteRead.
Arcadia_FileAccessMode_WriteRead
Write and read access. Alias for Arcadia_FileAccessMode_Write|Arcadia_FileAccessMode_Read and for Arcadia_FileAccessMode_ReadWrite.

Arcadia_FileHandle

Arcadia_FileHandle extends Arcadia_Object.

Arcadia_FileHandle represents a operating system file handle.

Arcadia_FileHandle_create

Arcadia_FileHandle*
Arcadia_FileHandle_create
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* fileSystem
  ) Create a file handle. The file handle is closed.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_FileSystem* self
A pointer to the backing Arcadia_FileSystem object.

Return value

A pointer to the file handle.

Arcadia_FileHandle_close

void
Arcadia_FileHandle_close
  (
    Arcadia_Thread* thread,
    Arcadia_FileHandle* self
  ) Close this file handle.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_FileHandle* self
A pointer to this file handle.

Arcadia_FileHandle_openForReading

void
Arcadia_FileHandle_openForReading
  (
    Arcadia_Thread* thread,
    Arcadia_FileHandle* self,
    Arcadia_FilePath* path
  ) Open a file for reading. If the file is open, it is closed before trying to re-open it.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_FileHandle* self
A pointer to this file handle.
Arcadia_FilePath* path
The file path of the file to read from.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
path is a null pointer.
Arcadia_Status_FileSystemOperationFailed
Opening the file failed.

Arcadia_FileHandle_openForWriting

void
Arcadia_FileHandle_openForWriting
  (
    Arcadia_FileHandle* self,
    Arcadia_FilePath* path
  ) Open a file for writing. If the file is open, it is closed before trying to re-open it.

Parameters

Arcadia_FileHandle* self
A pointer to this file handle.
Arcadia_FilePath* path
The file path of the file to write to.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
path is a null pointer.
Arcadia_Status_FileSystemOperationFailed
Opening the file failed.

Arcadia_FileHandle_isClosed

Arcadia_BooleanValue
Arcadia_FileHandle_isClosed
  (
    Arcadia_FileHandle const* self
  ) Get if this file handle is closed.

Parameters

Arcadia_FileHandle const* self
A pointer to this file handle.

Return value

Arcadia_BooleanValue_True if this file handle is closed. Arcadia_BooleanValue_False otherwise.

Arcadia_FileHandle_isOpened

Arcadia_BooleanValue
Arcadia_FileHandle_isOpened
  (
    Arcadia_FileHandle const* self
  ) Get if this file handle is opened.

Parameters

Arcadia_FileHandle const* self
A pointer to this file handle.

Return value

Arcadia_BooleanValue_True if this file handle is opened. Arcadia_BooleanValue_False otherwise.

Arcadia_FileHandle_isOpenedForReading

Arcadia_BooleanValue
Arcadia_FileHandle_isOpenedForReading
  (
    Arcadia_FileHandle const* self
  ) Get if this file handle is opened for reading.

Parameters

Arcadia_FileHandle const* self
A pointer to this file handle.

Return value

Arcadia_BooleanValue_True if this file handle is opened for reading. Arcadia_BooleanValue_False otherwise.

Arcadia_FileHandle_isOpenedForWriting

Arcadia_BooleanValue
Arcadia_FileHandle_isOpenedForWriting
  (
    Arcadia_FileHandle const* self
  ) Get if this file handle is opened for writing.

Parameters

Arcadia_FileHandle const* self
A pointer to this file handle.

Return value

Arcadia_BooleanValue_True if this file handle is opened for writing. Arcadia_BooleanValue_False otherwise.

Arcadia_FileHandle_write

void
Arcadia_FileHandle_write
  (
    Arcadia_FileHandle* self,
    void const* p,
    Arcadia_SizeValue bytesToWrite
  ) Write Bytes to this file handle.

Parameters

Arcadia_FileHandle* self
A pointer to this file handle.
void const* bytes
A pointer to an array of bytesToWrite Bytes.
Arcadia_SizeValue bytesToWrite
The number of Bytes in the array pointed to by bytes.
Arcadia_SizeValue* bytesWritten
A pointer to a Arcadia_SizeValue variable.

Success

*bytesWritten is assigned the actual number of Bytes written.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
bytes is a null pointer.
Arcadia_Status_OperationInvalid
The file is not opened for writing.
Arcadia_Status_FileSystemOperationFailed
Writing failed.

Arcadia_FileHandle_read

void
Arcadia_FileHandle_read
  (
  Arcadia_FileHandle* self,
  void const* bytes,
  Arcadia_SizeValue bytesToRead,
  Arcadia_SizeValue* bytesRead
  ) Read Bytes from this file handle.

Parameters

Arcadia_FileHandle* self
A pointer to this file handle.
void const* bytes
A pointer to an array of bytesToWrite Bytes.
Arcadia_SizeValue bytesToRead
The number of Bytes to read from the the array pointed to by bytes.
Arcadia_SizeValue* bytesRead
A pointer to a Arcadia_SizeValue variable.

Success

*bytesRead is assigned the actual number of Bytes read. The number of Bytes read is 0 if the end of the file was reached.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
bytes is a null pointer.
Arcadia
bytesRead is a null pointer.
Arcadia_Status_OperationInvalid
The file is not opened for writing.
Arcadia_Status_FileSystemOperationFailed
Writing failed.

Arcadia_FilePath

Arcadia_FilePath extends Arcadia_Object.

Arcadia_FilePath represents a file path.

create

Arcadia_FilePath*
Arcadia_FilePath_create
  (
    Arcadia_Thread* thread
  ) Create the empty file path.

Parameters

A pointer to the Arcadia_Thread object.

Return value

A pointer to the file path.

Arcadia_FilePath_parseGeneric

Arcadia_FilePath*
Arcadia_FilePath_parseGeneric
  (
    Arcadia_Thread* thread,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Parse a file path in the generic format.

Parameters

A pointer to the Arcadia_Thread object.
bytes
A pointer to an array of numberOfBytes Bytes.
numberOfBytes
The number of Bytes in the array pointed to by bytes Bytes.

Return value

A pointer to the file path.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
bytes is a null pointer.
Arcadia_Status_FileSystemOperationFailed
Opening the file failed.

Arcadia_FilePath_parseNative

Arcadia_FilePath*
Arcadia_FilePath_parseNative
  (
    Arcadia_Thread* thread,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Parse a file path in the native format.

Parameters

A pointer to the Arcadia_Thread object.
bytes
A pointer to an array of numberOfBytes Bytes.
numberOfBytes
The number of Bytes in the array pointed to by bytes Bytes.

Return value

A pointer to the file path.

Arcadi_FilePath_parseUnix

Arcadia_FilePath*
Arcadia_FilePath_parseUnix
  (
    Arcadia_Thread* thread,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Parse a file path in the Unix format.

Parameters

A pointer to the Arcadia_Thread object.
bytes
A pointer to an array of numberOfBytes Bytes.
numberOfBytes
The number of Bytes in the array pointed to by bytes Bytes.

Return value

A pointer to the file path.

Arcadia_FilePath_parseWindows

Arcadia_FilePath*
Arcadia_FilePath_parseWindows
  (
    Arcadia_Thread* thread,
    void const* bytes,
    Arcadia_SizeValue numberOfBytes
  ) Parse a file path in the Windows format.

Parameters

A pointer to the Arcadia_Thread object.
bytes
A pointer to an array of numberOfBytes Bytes.
numberOfBytes
The number of Bytes in the array pointed to by bytes Bytes.

Return value

A pointer to the file path.

Arcadia_FilePath_toNative

Arcadia_String*
Arcadia_FilePath_toNative
  (
    Arcadia_Thread* thread,
    Arcadia_FilePath* self
  ) Convert a file path to the native format.

Parameters

A pointer to the Arcadia_Thread object.
self
A pointer to this file path.

Return value

A pointer to the string.

Arcadia_FileSystem

Arcadia_FileSystem extends Arcadia_Object.

Arcadia_FileSystem provides access to the file system.

Arcadia_FileSystem_create

Arcadia_FileSystem*
Arcadia_FileSystem_create
  (
    Arcadia_Thread* thread
  ) Create a file system.

Parameters

A pointer to the Arcadia_Thread object.

Errors

Arcadia_Status_AllocationFailed
An allocation failed.

Return value

A pointer to a Arcadia_FileSystem object.

Remarks

Do not call this function. Call Arcadia_FileSystem_getOrCreate instead.

Arcadia_FileSystem_getOrCreate

Arcadia_FileSystem*
Arcadia_FileSystem_getOrCreate
  (
    Arcadia_Thread* thread
  ) Get or create the file system singleton.

Parameters

A pointer to the Arcadia_Thread object.

Errors

Arcadia_Status_AllocationFailed
An allocation failed.

Return value

A pointer to a Arcadia_FileSystem object.

Arcadia_FileSystem_getFileContents

Arcadia_ByteBuffer*
Arcadia_FileSystem_getFileContents
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self,
    Arcadia_FilePath* path
  ) Get the contents of a file.

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.
The file path of the file.

Return value

A pointer to a Arcadia_ByteBuffer object with the file contents.

Errors

self is a null pointer.
path is a null pointer.
Opening the file failed.

Arcadia_FileSystem_setFileContents

void
Arcadia_FileSystem_setFileContents
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self,
    Arcadia_FilePath* path,
    Arcadia_ByteBuffer* contents
  ) Get if a sequence of Bytes is a prefix of this string's sequence of Bytes.

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.
Arcadia_FilePath* path
The file path of the file.
Arcadia_ByteBuffer* contents
A poiner to the Byte buffer with the file contents.

Errors

Arcadia_Status_ArgumentValueInvalid
sekf is a null pointer.
Arcadia_Status_ArgumentValueInvalid
path is a null pointer.
Arcadia_Status_ArgumentValueInvalid
contents is a null pointer.
Arcadia_Status_FileSystemOperationFailed
Opening the file failed.

Arcadia_FileSystem_regularFileExists

Arcadia_BooleanValue
Arcadia_FileSystem_regularFileExists
  (     Arcadia_Thread* thread,
    Arcadia_FileSystem* self,
    Arcadia_FilePath* path
  ) Get if a file exists and is a regular file.

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.
Arcadia_FilePath* path
The file path of the file.

Return value

Arcadia_BooleanValue_True if the file exists and is a regular file. Arcadia_BooleanValue_False otherwise.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalidpath is a null pointer.

Arcadia_FileSystem_directoryFileExists

Arcadia_BooleanValue
Arcadia_FileSystem_directoryFileExists
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self,
    Arcadia_FilePath* path
  ) Get if a file exists and is a directory file.

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.
Arcadia_FilePath* path
The file path of the file.

Return value

Arcadia_BooleanValue_True if the file exists and is a directory file. Arcadia_BooleanValue_False otherwise.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
path is a null pointer.

Arcadia_FileSystem_getWorkingDirectory

Arcadia_FilePath*br> Arcadia_FileSystem_getWorkingDirectory
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self
  ) Get the working directory of this process.

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.

Return value

A pointer to the file path.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_FileSystem_createDirectoryIterator

Arcadia_DirectoryIterator*br> Arcadia_FileSystem_createDirectoryIterator
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self,
    Arcadia_FilePath* path
  ) Create a directory iterator.

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.
A pointer to the path of the directory to search in.

Return value

A pointer to the directory iterator.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
path is a null pointer.

Arcadia_FileSystem_createDirectoryIterator

Arcadia_DirectoryIterator*br> Arcadia_FileSystem_createDirectoryIterator
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self,
    Arcadia_FilePath* path
  ) Create a directory iterator.

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.
A pointer to the path of the directory to search in.

Return value

A pointer to the directory iterator.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
path is a null pointer.

Arcadia_FileSystem_getSaveFolder

Arcadia_FilePath*br> Arcadia_FileSystem_getSaveFolder
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self
  ) Get the path to the "save" folder. Get the folder in which save files are stored. The following table lists the values for a given operating system
  • Windows: C:\Users\<Username>\AppData\Roaming\<Organization Name>\<Game Name>
  • Linux: <Home>\<Organization Name>\<Game Name>

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.

Return value

A pointer to the the path of the "save" folder.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_FileSystem_getSaveFolder

Arcadia_FilePath*br> Arcadia_FileSystem_getSaveFolder
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self
  ) Get the path to the "save" folder. Get the folder in which save files are stored. The following table lists the values for a given operating system
  • Windows: C:\Users\<Username>\AppData\Roaming\<Organization Name>\<Game Name>
  • Linux: <Home>\<Organization Name>\<Game Name>

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.

Return value

A pointer to the the path of the "save" folder.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_FileSystem_getConfigurationFolder

Arcadia_FilePath*br> Arcadia_FileSystem_getConfigurationFolder
  (
    Arcadia_Thread* thread,
    Arcadia_FileSystem* self
  ) Get the path to the "configuration" folder. Get the folder in which configuration files are stored. The following table lists the values for a given operating system
  • Windows: C:\Users\<Username>\AppData\Local\<Organization Name>\<Game Name>
  • Linux: <Home>\<Organization Name>\<Game Name>

Parameters

A pointer to the Arcadia_Thread object.
A pointer to this Arcadia_FileSystem object.

Return value

A pointer to the the path of the "configuration" folder.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_FileType

typedef enum Arcadia_FileType Arcadia_FileType; An enumeration of file types. The enumeration elements cannot be combined.

Elements

Arcadia_FileType_Unknown
The file type of a file is not known.
Arcadia_FileType_Regular
A file is a regular file.
Arcadia_FileType_Directory
A file is a directory file.

Arcadia_NonExistingFilePolicy

typedef enum Arcadia_NonExistingFilePolicy Arcadia_NonExistingFilePolicy; An enumeration of policies for opening a file in case of that the file does not exist. The enumeration elements cannot be combined.

Elements

Arcadia_NonExistingFilePolicy_Fail
Fail if the file does not exist.
Arcadia_NonExistingFilePolicy_Create
Create the file if it does not exist.

Arcadia_ByteBuffer

Arcadia_ByteBuffer extends Arcadia_Object.

Arcadia_ByteBuffer represents a mutable sequence of Bytes.

Arcadia_ByteBuffer_create

Arcadia_ByteBuffer*
Arcadia_ByteBuffer_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_ByteBuffer object.

Arcadia_ByteBuffer_clear

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

Parameters

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

Arcadia_ByteBuffer_endsWith_pn

Arcadia_BooleanValue
Arcadia_ByteBuffer_endsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer 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_ByteBuffer* 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_ByteBuffer_startsWith_pn

Arcadia_BooleanValue
Arcadia_ByteBuffer_startsWith_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer* 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_ByteBuffer* 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_ByteBuffer_isEqualTo_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer* 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_ByteBuffer* 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_ByteBuffer_append_pn

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* 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_ByteBuffer_prepend_pn

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* 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_ByteBuffer_insert_pn

void
Arcadia_ByteBuffer_insert_pn
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer* 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_ByteBuffer* 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_ByteBuffer_isEqualTo

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer const* self
A pointer to this Byte buffer.
Arcadia_ByteBuffer 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_ByteBuffer_getSize

Arcadia_SizeValue
Arcadia_ByteBuffer_getSize
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer const* self
  ) Get the size of this Byte buffer. 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_ByteBuffer* self
A pointer to this Byte buffer.

Return value

The size of this Byte buffer.

Arcadia_ByteBuffer_getAt

Arcadia_Natural8Value
Arcadia_ByteBuffer_getAt
  (
    Arcadia_Thread* thread,
    Arcadia_ByteBuffer 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_ByteBuffer* 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_ByteBuffer_isEmpty

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* 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_ByteBuffer_swap

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_ByteBuffer* self
A pointer to this Byte buffer.
Arcadia_ByteBuffer* 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.

Collection

Arcadia_Collection extends Arcadia_Object.

Arcadia_Collection represents a collection of Arcadia_Value objects.

Arcadia_Collection_clear

void
Arcadia_Collection_clear
  (
    Arcadia_Thread* thread,
    Arcadia_Collection* self
  ) Clear this collection.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Collection* self
A pointer to this collection.

Arcadia_Collection_getSize

Arcadia_SizeValue
Arcadia_Collection_getSize
  (
    Arcadia_Thread* thread,
    Arcadia_Collection* self
  ) Get the size of this collection.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Collection* self
A pointer to this collection.

Return value

The size of this collection.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_Collection_isEmpty

Arcadia_BooleanValue
Arcadia_Collection_isEmpty
  (
    Arcadia_Thread* thread,
    Arcadia_Collection* self
  ) Get if this collection is empty.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Collection* self
A pointer to this collection.

Return value

Arcadia_BooleanValue_True if this collection is empty. Arcadia_BooleanValue_False otherwise.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.

Arcadia_List

Arcadia_List extends Arcadia_Collection.

Arcadia_List represents a list of Arcadia_Value objects.

Arcadia_List_getAt

Arcadia_Value
Arcadia_List_getAt
  (
    Arcadia_Thread* thread,
    Arcadia_List* self,
    Arcadia_SizeValue index
  ) Get the value at the specifie index in this list.

Parameters

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

Errors

Arcadia_Status_ArgumentValueInvalid
index is out of bounds.

Return value

The value.

Arcadia_List_insertAt

void
Arcadia_List_insertAt
  (
    Arcadia_Thread* thread,
    Arcadia_List* self,
    Arcadia_SizeValue index,
    Arcadia_Value value
  ) Insert a value at the specified position in this list. If the value is Void value, then the list is not modified.

Parameters

Arcadia_Thread* threadA pointer to the Arcadia_Thread object. Arcadia_List* self A pointer to this list. Arcadia_SizeValue index The index at which to insert the value. Must be within the bounds of [0,n] where n is the size of thie list. Arcadia_Value value The value to insert.

Errors

Arcadia_Status_ArgumentValueInvalid
index is out of bounds.
Arcadia_Status_ArgumentTypeInvalid
value is a Void value.

Arcadia_List_insertBack

void
Arcadia_List_insertBack
  (
    Arcadia_Thread* thread,
    Arcadia_List* self,
    Arcadia_Value value
  ) Insert a value at the back of this list.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_List* self
A pointer to this list.
Arcadia_Value value
The value to insert at the back of this list.

Errors

Arcadia_Status_ArgumentTypeInvalid
value is a Void value.

Arcadia_List_insertFront

void
Arcadia_List_insertFront
  (
    Arcadia_Thread* thread,
    Arcadia_List* self,
    Arcadia_Value value
  ) Insert a value at the front of this list.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_List* self
A pointer to this list.
Arcadia_Value value
The value to insert at the front of this list.

Errors

Arcadia_Status_ArgumentTypeInvalid
value is a Void value.

Arcadia_List_removeAt

void
Arcadia_List_removeAt
  (
    Arcadia_Thread* thread,
    Arcadia_List* self,
    Arcadia_SizeValue start,
    Arcadia_SizeValue length
  ) Remove length values starting with element at index start.

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_List* self
A pointer to this list.
Arcadia_SizeValue start
The index of the first element to remove.
Arcadia_SizeValue length
The number of elements to remove.

Errors

Arcadia_Status_ArgumentValueInvalid
self is a null pointer.
Arcadia_Status_ArgumentValueInvalid
index + length > n where n is the length of the list.

Map

Arcadia_Map extends Arcadia_Collection.

Arcadia_Map represents a map from Arcadia_Value objects, the keys, to Arcadia_Value objects, the values.

Arcadia_Map_get

Arcadia_Value
Arcadia_Map_get
  (
    Arcadia_Thread* thread,
    Arcadia_Map* self,
    Arcadia_Value key
  )

Get the value of an entry for a given key in this map.

More formally: Let \(x\) be the specified key.

  • If there exist an entry \(x' \mapsto y'\) in the map such that \(x\) is equivalent to \(x'\), then y' is returned.
  • Otherwise (if there exists no such entry in the map), then a Void value is returned.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Map* self
A pointer to this Arcadia_Map object.
Arcadia_Value key
The key \(k\).

Return value

The value for the given key if it was found. A Void value otherwise.

Errors

Arcadia_Status_ArgumentTypeInvalid
key is a Void value.

Arcadia_Map_remove

Arcadia_Value
Arcadia_Map_set   (
    Arcadia_Thread* thread,
    Arcadia_Stack* self,
    Arcadia_Value key
  )

Remove an entry for a given key from this map.

More formally: Let \(x\) be the specified key and \(y\) be the specified value.

  • If \(y\) is an Void value then there are two cases:
    • If there exist an entry \((x' \mapsto y')\) in the map such that \(x\) is equivalent to \(x'\), then this entry is removed and y' is returned.
    • Otherwise (if there exists no such entry in the map), then a Void value is returned.
    • Otherwise (\(y\) is not an Void value) then there are two cases:
    • If there exist one \((x' \mapsto y')\) in the map such that \(x\) is equivalent to \(x'\), then this entry is replaced by the entry \((x' \mapsto y)\) and y' is returned.
    • Otherwise the entry \((x \mapsto y)\) is added and an Void value is returned.

    Parameters

    Arcadia_Thread* thread
    A pointer to the Arcadia_Thread object.
    Arcadia_Map* self
    A pointer to this stack.
    Arcadia_Value key
    The key \(x\).
    Arcadia_Value value
    The value \(y\).

    Return value

    The value of the removed entry \((x \mapsto y)\) such an entry was found. A Void value otherwise.

    Errors

    Arcadia_Status_ArgumentTypeInvalid
    key is a Void value.

Arcadia_Map_set

void
Arcadia_Map_set   (
    Arcadia_Thread* thread,
    Arcadia_Stack* self,
    Arcadia_Value key,
    Arcadia_Value value
    Arcadia_Value* oldKey,
    Arcadia_Value* oldValue,
  )

Set the value for the given key in this map.

More formally: Let \(x\) be the specified key and \(y\) be the specified value.

  • If \(x\) is an Void value, then an Argument Type Invalid error is raised.
  • If \(y\) is an Void value then there are two cases:
    • If there exist an entry \((x' \mapsto y')\) in the map such that \(x\) is equivalent to \(x'\), then this entry is removed. \(x'\) is returned in *oldKey if oldKey is not null. \(y'\) is returned in *oldValue if oldValue is not null.
    • Otherwise (if there exists no such entry in the map): Void value is returned in *oldKey if oldKey is not null. Void value is returned in *oldValue if oldValue is not null.
    • Otherwise (\(y\) is not an Void value) then there are two cases:
    • If there exist one \(x' \mapsto y'\) in the map such that \(x\) is equivalent to \(x'\), then this entry is replaced by the entry \(x \mapsto y\). \(x'\) is returned in *oldKey if oldKey is not null. \(y'\) is returned in *oldValue if oldValue is not null.
    • Otherwise the entry \(x \mapsto y\) is added. Void value is returned in *oldKey if oldKey is not null. Void value is returned in *oldValue if oldValue is not null.

    Parameters

    Arcadia_Thread* thread
    A pointer to the Arcadia_Thread object.
    Arcadia_Map* self
    A pointer to this stack.
    Arcadia_Value key
    The key \(k\).
    Arcadia_Value value
    The value \(v\).

    Return value

    The value of the removed entry \((x' \mapsto y')\) if an entry for the given key if it was found. A Void value otherwise.

    Errors

    Arcadia_Status_ArgumentTypeInvalid
    key is a Void value.

Set

Arcadia_Set extends Arcadia_Collection.

Arcadia_Set represents a set of Arcadia_Value objects.

Arcadia_Set_contains

Arcadia_BooleanValue
Arcadia_Set_contains
  (
    Arcadia_Thread* thread,
    Arcadia_Set* self,
    Arcadia_Value value
  ) Get if this set contains a value. More formally: Let \(x\) be the value to be tested.

  • If \(x\) is an Void value, then an Argument Type Invalid error is raised.
  • Otherwise (that is, if \(x\) is not an Void value):
    • If there exist one \(x'\) in the map such that \(x\) is equivalent to \(x'\), then Arcadia_BooleanValue_True is returned.
    • Otherwise Arcadia_BooleanValue_False is returned.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Set* self
A pointer to this Arcadia_Set object.
Arcadia_Value value
The value \(x\).

Return value

Arcadia_BooleanValue_True if \(x\) contained in this set. Arcadia_BooleanValue_False otherwise.

Arcadia_Set_get

Arcadia_Value
Arcadia_Set_get   (
    Arcadia_Thread* thread,
    Arcadia_Set self,
    Arcadia_Value value
  )

Get the value in this set.

More formally: Let \(x\) be the value to get.

  • If \(x\) is an Void value, then an Argument Type Invalid error is raised.
  • Otherwise (\(x\) is not an Void value) then there are two cases:
  • If there exist one \(x'\) in the map such that \(x\) is equivalent to \(x'\), then \(x'\) is returned.
  • Otherwise the Void value is returned.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Set* self
A pointer to this set.
Arcadia_Value value
The value \(x\).

Return value

The value \(x'\) or the Void value.

Arcadia_Set_add

void
Arcadia_Set_add   (
    Arcadia_Thread* thread,
    Arcadia_Set self,
    Arcadia_Value value,
    Arcadia_Value* oldValue
  )

Add value to this set.

More formally: Let \(x\) be the value to be added.

  • If \(x\) is an Void value, then an Argument Type Invalid error is raised.
  • Otherwise (\(x\) is not an Void value) then there are two cases:
  • If there exist one \(x'\) in the map such that \(x\) is equivalent to \(x'\), \(x'\) is replaced by \(x\) in this set. \(x'\) is returned in *oldValue if oldValue is not null.
  • Otherwise \(x\) is added to this set. Void value is returned in *oldValue if oldValue is not a null pointer.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Set* self
A pointer to this set.
Arcadia_Value value
The value \(x\).
Arcadia_Value* oldValue
A pointer to a Arcadia_Value object or a null pointer.

Return value

Arcadia_BooleanValue_True if \(x\) was added to this set. Arcadia_BooleanValue_False otherwise.

Arcadia_Set_remove

void
Arcadia_Set_remove
  (
    Arcadia_Thread* thread,
    Arcadia_Set* self,
    Arcadia_Value value,
    Arcadia_Value *oldValue
  )

Remove a value from this set.

More formally: Let \(x\) be the value to be removed.

  • If \(x\) is an Void value, then an Argument Type Invalid error is raised.
  • Otherwise (\(x\) is not an Void value) then there are two cases:
  • If there exist one \(x'\) in the map such that \(x\) is equivalent to \(x'\), \(x'\) is removed from this set. \(x'\) is returned in *oldValue if oldValue is not null.
  • Void value is returned in *oldValue if oldValue is not a null pointer.
Otherwise an Void value is returned.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Set* self
A pointer to this set.
Arcadia_Value value
The value \(x\).
Arcadia_Value *oldValue
A pointer to an Arcadia_Value object or a null pointer.

Return value

Arcadia_BooleanValue_Trueif value was removed to this set. Arcadia_BooleanValue_False otherwise.

Stack

Arcadia_Stack extends Arcadia_Collection.

Arcadia_Stack represents a stack of Arcadia_Value objects.

Arcadia_Stack_create

Arcadia_Stack*
Arcadia_Stack_create
  (
    Arcadia_Thread* thread
  ) Create a stack.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.

Errors

Arcadia_Status_AllocationFailed
An allocation failed.

Return value

A pointer to the Arcadia_Stack value.

Arcadia_Stack_peek

Arcadia_Value
Arcadia_Stack_peek
  (
    Arcadia_Thread* thread,
    Arcadia_Stack* self
  ) Peek at the value on top of this stack.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Stack* self
A pointer to this stack.

Return value

The value.

Errors

Arcadia_Status_OperationInvalid
The stack is empty.

Arcadia_Stack_pop

Arcadia_Value
Arcadia_Stack_pop   (
    Arcadia_Thread* thread,
    Arcadia_Stack* self
  ) Pop the value from the top of this stack.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Stack* self
A pointer to this stack.

Return value

The value.

Errors

Arcadia_Status_OperationInvalid
The stack is empty.

Arcadia_Stack_push

void
Arcadia_Stack_push
  (
    Arcadia_Thread* thread,
    Arcadia_Stack* self,
    Arcadia_Value value
  ) Push a value on the top of this stack.

Parameters

Arcadia_Thread* thread
A pointer to the Arcadia_Thread object.
Arcadia_Stack* self
A pointer to this stack.
Arcadia_Value value
The value to push.

Errors

Arcadia_Status_ArgumentTypeInvalid
value is a Void value.

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_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_StringBuffer

Arcadia_StringBuffer extends Arcadia_Object.

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

Arcadia_StringBuffer_clear

void
Arcadia_StringBuffer_clear
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuffer* self
  ) Clear this string buffer.

Parameters

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

Arcadia_StringBuffer_create

Arcadia_StringBuffer*
Arcadia_StringBuffer_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_StringBuffer value.

Arcadia_StringBuffer_compareTo

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuffer* 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.StringBuffer, 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_StringBuffer_getNumberOfBytes

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

Parameters

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

Return value

The number of Bytes in this string buffer.

Arcadia_StringBuffer_insertAt

void
Arcadia_StringBuffer_insertAt
  (
    Arcadia_Thread* thread,
    Arcadia_StringBuffer* 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_StringBuffer* 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_StringBuffer_insertFront. If index is n, then this call is equivalent to a call to Arcadia_StringBuffer_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.StringBuffer, 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_StringBuffer_insertBack

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuffer* 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.StringBuffer, 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_StringBuffer_insertFront

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuffer* 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.StringBuffer, 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_StringBuffer_isEmpty

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

Parameters

A pointer to the Arcadia_Thread object.
Arcadia_StringBuffer* 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.