Michael Heilmann's Runtime Mark 1

This is the documentation for Michael Heilmann's Runtime Mark 1, henceforth R1. R1 facilates the creation of C programs - in particular interpreters - that are portable, maintainable, as well as safe. R1 is available at michaelheilmann.com/repository/R1.

Files

You can find the sources of R1 in my GitHub repository https://github.com/michaelheilmann/michaelheilmann.com. The subdirectory of R1 in the repository is here https://github.com/michaelheilmann/michaelheilmann.com/tree/main/repository/R1.

• The (sources of the) library resides in the directory https://github.com/michaelheilmann/michaelheilmann.com/tree/main/repository/R1/Sources
• The (sources of) tests reside in the directory https://github.com/michaelheilmann/michaelheilmann.com/tree/main/repository/R1/Tests
• The (sources of) demos reside in the directory https://github.com/michaelheilmann/michaelheilmann.com/tree/main/repository/R1/Demos
• The (sources of this very documentation you are reading) documentation reside in the directory https://github.com/michaelheilmann/michaelheilmann.com/tree/main/repository/R1/Documentation

You can compile and run these under various platforms (including but not restricted to Windows, Linux, and many more), however, we currently only officially support Windows. To build and run all these, simply checkout the repository to the and outside of the repository directory create a build folder. Invoke from the the build folder

cmake path-to-repository-directory

Documentation

Boolean Type

R1 provides a boolean type.

typedef implementation detail R_BooleanValue

#define R_BooleanValue_True implementation detail

is a value of the type denoting logically true. It converts to 1 in arithmetic expressions.

#define R_BooleanValue_False implementation detail

is a value of the type denoting logically false. It converts to 0 in arithmetic expressions.

Foreign Procedure Type

R provides the R_ForeignProcedureValue type.

typedef implementation detail R_ForeignProcedureValue;

which is a pointer to a function adhering to the calling conventions for C functions of the runtime.

A valid value of the R_ForeignProcedureValue is the null value

#define R_ForeignProcedureValue_Null implementation detail

#define R_ForeignProcedureValue_NumberOfBits implementation detail

denotes the number of Bits of the type.

#define R_ForeignProcedureValue_NumberOfBytes implementation detail

denotes the number of Bytes of the type which is usually R_ForeignProcedureValue_NumberOfBits divided by 8.

Integer Types

R provides a two's complement integer number types.

typedef implementation detail R_IntegerSuffixValue

where Suffix denotes the number of Bits of the two's complement integer and can be one of 8, 16, 32, or 64.

The macros in this section all include the Suffix metavariable and are defined for the values 8, 16, 32, and 64 of that meta variable.

#define R_IntegerSuffixValue_NumberOfBits implementation detail

denotes the number of Bits of the type. The value is always equal to the value of the respective Suffix.

#define R_IntegerSuffixValue_NumberOfBytes implementation detail

denotes the number of Bytes of the type which is usually R_IntegerSuffixValue_NumberOfBits divided by 8.

#define R_IntegerSuffixValue_Minimum implementation detail

denotes the least value (in terms of its magnitude) representable by a the R_IntegerSuffixValue type. The following table denotes the value of the constant for the respective Suffix

#define R_IntegerSuffixValue_Maximum implementation detail

denotes the greatest value (in terms of its magnitude) representable by a the R_IntegerSuffixValue type. The following table denotes the value of the constant for the respective Suffix

#define R_IntegerSuffixValue_Literal(x) implementation detail

is used to write a literal of the type R_IntegerSuffix in C source code. The following table denotes the expansions of the macro:

Natural Types

R provides natural number types.

typedef implementation detail R_NaturalSuffixValue

where Suffix denotes the number of Bits of the integer and can be one of 8, 16, 32, or 64.

The macros in this section all include the Suffix metavariable and are defined for the values 8, 16, 32, and 64 of that meta variable.

#define R_NaturalSuffixValue_NumberOfBits implementation detail

denotes the number of Bits of the type. The value is always equal to the value of the respective Suffix.

#define R_IntegerSuffixValue_NumberOfBytes implementation detail

denotes the number of Bytes of the type which is usually R_IntegerSuffixValue_NumberOfBits divided by 8.

#define R_NaturalSuffixValue_Minimum implementation detail

denotes the least value (in terms of its magnitude) representable by a the R_NaturalSuffixValue type. The following table denotes the value of the constant for the respective Suffix

#define R_NaturalSuffixValue_Maximum implementation detail

denotes the greatest value (in terms of its magnitude) representable by a the R_NaturalSuffixValue type. The following table denotes the value of the constant for the respective Suffix

#define R_NatualSuffixValue_Literal(x) implementation detail

is used to write a literal of the type R_NaturalSuffix in C source code. The following table denotes the expansions of the macro:

Object Reference Type

R provides a ObjectReference type.

typedef implementation detail R_ObjectReferenceValue

The R_ObjectReferenceValue type is a pointer.

A valid value of the R_ObjectReferenceValue is the null reference

#define R_ObjectReferenceValue_Null implementation detail

#define R_ObjectReferenceValue_NumberOfBits implementation detail

denotes the number of Bits of the type.

#define R_ObjectReferenceValue_NumberOfBytes implementation detail

denotes the number of Bytes of the type which is usually R_ObjectReferenceValue_NumberOfBits divided by 8.

Size Type

R provides an alias for builtin size_t type.

typedef implementation detail R_SizeValue

#define R_SizeValue_NumberOfBits implementation detail

denotes the number of Bits of the type. This number must one of 32 or 64, otherwise the environment is not supported by R. This restriction may be relaxed in future versions of R.

#define R_SizeValue_NumberOfBytes implementation detail

denotes the number of Bytes of the type which is usually R_SizeValue_NumberOfBits divided by 8.

#define R_SizeValue_Minimum implementation detail

denotes the least value (in terms of its magnitude) representable by a the R_Size type.

#define R_SizeValue_Literal(x) implementation detail

is used to write a literal of type R_SizeValue in C source code.

Void Type

R provides a void type.

typedef implementation detail R_VoidValue

The only value of this type is R_VoidValue_Void. R_VoidValue is an unsigned integral type.

#define R_VoidValue_Void implementation detail

The single value of the type.

#define R_VoidValue_NumberOfBits implementation detail

denotes the number of Bits of the type.

#define R_VoidValue_NumberOfBytes implementation detail

denotes the number of Bytes of the type which is usually R_VoidValue_NumberOfBits divided by 8.

Value Type

R_Value is a tagged union of values supported by the runtime. It consists of a tag indicating the value stored in the union and the union of the values. The following table lists all possible tags and their corresponding type.

For each type, R_Value has three functions associated:

Type R_Value_getSuffix(R_Value const* value)
bool R_Value_isSuffix(R_Value const* value)
void R_Value_setSuffix(R_Value* value, R_SuffixValue VariableValue)

The following table lists the valid combinations of Suffix and Variable

R_Value_isSuffix returns true if the R_Value stores a value of the type corresponding to Suffix. Otherwise it returns false.

R_Value_setSuffix assigns the R_Value a value of the type corresponding to Suffix.

R_Value_getType get the value stored in the R_Value. The behavior of R_Value_setSuffix is undefined if the value does not store a value of the type corresponding to Suffix.

Status Codes

R provides a status type and symbolic constants for its values. That type denotes success or failure of program (or a part of it) as well as information on the reason for the failure.

typedef implementation detail R_Status

R_Status is a natural number type of a width of 32 Bit.

#definer R_Status_Success implementation detail

is the symbolic constant of the type R_Status has the value ((R_Status)0). It denotes success and is guaranteed to be defined to the value 0 of the underlaying natural number type of R_Status as well as to be the only symbolic constant starting with R_Status_ having defined to that value.

Symbolic constants of the form

#definer R_Status_Name implementation detail

where Name is not Success provide information on failure of a program (or a part of it). The following table denotes the value of the constant for the respective Name

Status Variable

R provides a global status variable.

R_Status R_getStatus ( );

gets the value of the status variable. The initial value of the status variable is R_Status_Success.

void R_setStatus ( R_Status status );

sets the value of the status variable to the value status.

Jumps and Jump Targets

R provides non-local jumps by allowing to save and restore the C program state.

typedef implementation detail R_JumpTarget;

is a type of which its values are stack allocated.

void R_pushJumpTarget(R_JumpTarget* jumpTarget);

Push a jump target on top of the jump target stack. Initially, the jump target stack is empty.

void R_popJumpTarget();

Pop the jump target on top of the jump target stack. The jump target stack must not be empty.

void R_jump();

Jump to the jump target on top of the jump target stack. The jump target stack must not be empty.

#define R_JumpTarget_save(jumpTarget) implementation detail

Macro to save the current C program state into a jump target.

The canonical way of using R_pushJumpTarget, R_popJumpTarget, and R_jump is the following.

R_pushJumpTarget(&jumpTarget);
if (R_JumpTarget_save(&jumpTarget)) {
 (1)
 R_popJumpTarget();(2)
} else {
 R_popJumpTarget();(3)
 (4)
}
(5)

The if-branch is always entered at first as the R_JumpTarget_save() at its first invocation returns logically true. If the program at (1) does not jump to the jump target (using R_jump()), then R_popJumpTarget(); (2) and (5) are executed. If the program at (1) jumps to the jump target, then R_JumpTarget_save() is re-evaluated and returns logically false and R_popJumpTarget();(2) and (4) is executed.

One usage example is the implementation of the R_safeExecute function.

void R_safeExecute(void (*f)()) {
 R_JumpTarget jumpTarget;
 R_pushJumpTarget(&jumpTarget);
 if (R_JumpTarget_save(&jumpTarget)) {
  f();
  R_popJumpTarget();
 }
}

Numeric functions

R_clamp

Clamp a value to a range.

Type R_clampSuffix(Type value, Type lower, Type upper)

The following table lists the combinations of Type and Suffix for which the above functions are defined

Parameters

This function returns the value value clamped to the range [lower, upper].

Errors

Return value

The value value clamped to the range [lower, upper].

R_countLeadingZeroes

Return the number of leadin gzeroes of the binary representation of a value.

R_SizeValue R_countLeadingZeroesSuffix(Type value)

The following table lists the combinations of Type and Suffix for which the above functions are defined

This function returns the number of leading zeroes of the binary representation of value.

Return value

The number of leading zeroes.

R_hash

Return the hash of a value.

R_SizeValue R_hashSuffix(Type x)

The following table lists the combinations of Type and Suffix for which the above functions are defined

Parameters

Return value

Return hash of x.

R_maximum

Return the maximum of two values.

Type R_maximumSuffix(Type x, Typemv> y)

The following table lists the combinations of Type and Suffix for which the above functions are defined

Parameters

Return value

Return the maximum of x and y.

R_minimum

Return the minimum of two values.

Type R_minimumSuffix(Type x, Type y)

The following table lists the combinations of Type and Suffix for which the above functions are defined

Parameters

Return value

Return the minimum of x and y.

R_nextPowerOfTwoGt

R provides functions returning the next power of two greater than a value.

Type R_nextPowerOfTwoGtSuffix(Type x)

The following table lists the combinations of Type and Suffix for which the above functions are defined

Parameters

Errors

Return value

Return the next power of two greater than x.

R_nextPowerOfTwoGte

R provides functions returning the next power of two greater or equal to a value.

Type R_nextPowerOfTwoGteSuffix(Type x)

The following table lists the combinations of Type and Suffix for which the above functions are defined

Parameters

Errors

Return value

Return the next power of two greater than or equal to x.

R_getTickCount

Get the time, in milliseconds, since the start of the process.

R_Natural64Value R_getTickCount()

Return value

The time, in milliseconds, since the start of the process.

Objects

Byte Buffer

R_ByteBuffer represents a mutable sequence of Bytes. This type is allocated on the heap and values of this type are referenced by R_ByteBuffer pointers. A R_ByteBuffer pointer can be safely cast into a R_ObjectReferenceValue values. An R_ObjectReferenceValue pointing to a R_ByteBuffer value can be safely cast into a R_ByteBuffer pointer.

create

R_ByteBuffer* R_ByteBuffer_create()

Create an empty Byte buffer.

Return Value

A pointer to the Byte buffer.

clear

void R_ByteBuffer_clear(R_ByteBuffer* self)

Set the number of elements of this Byte buffer to zero.

Parameters

endsWith_pn

R_BooleanValue R_ByteBuffer_endsWith_pn(R_ByteBuffer const* self, void const* bytes, R_SizeValue numberOfBytes)

Get if a sequence of Bytes is a suffix of this Byte buffer's sequence of Bytes.

Parameters

Return Value

R_BooleanValue_True if the sequence of Bytes is a suffix of this byte buffer's sequence of Bytes. R_BooleanValue_False otherwise.

startsWith_pn

R_BooleanValue R_ByteBuffer_startsWith_pn(R_ByteBuffer const* self, void const* bytes, R_SizeValue numberOfBytes)

Get if a sequence of Bytes is a prefix of this Byte buffer's sequence of Bytes.

Parameters

Return Value

R_BooleanValue_True if the sequence of Bytes is a prefix of this byte buffer's sequence of Bytes. R_BooleanValue_False otherwise.

isEqualTo_pn

R_BooleanValue R_ByteBuffer_isEqualTo_pn(R_ByteBuffer const* self, void const* bytes, R_SizeValue numberOfBytes)

Get if a sequence of Bytes is this Byte buffer's sequence of Bytes.

Parameters

Return Value

R_BooleanValue_True if the sequence of Bytes is this byte buffer's sequence of Bytes. R_BooleanValue_False otherwise.

append_pn

void R_ByteBuffer_append_pn(R_ByteBuffer* self, void const* bytes, R_SizeValue numberOfBytes)

Append Bytes to this Byte buffer.

Parameters

Errors

prepend_pn

void R_ByteBuffer_prepend_pn(R_ByteBuffer* self, void const* p, R_SizeValue n)

Prepend Bytes to this Byte buffer.

Parameters

Errors

insert_pn

void R_ByteBuffer_insert_pn(R_ByteBuffer* self, R_SizeValue index, void const* p, R_SizeValue n)

Insert Bytes into this Byte buffer.

Parameters

Errors

isEqualTo

R_BooleanValue R_ByteBuffer_isEqualTo(R_ByteBuffer const* self, R_ByteBuffer const* other)

Compare this Byte buffer with another Byte buffer for equality.

Parameters

Return Value

R_BooleanValue_True if this Byte buffer is equal to the other Byte buffer. R_BooleanValue_False otherwise.

getSize

R_SizeValue R_ByteBuffer_getSize(R_ByteBuffer const* self)

Get the size of this Byte buffer.

Parameters

Return Value

The size of this Byte buffer.

Remarks

The size of a Byte buffer is the length of the Byte sequence it contains.

getat

R_Natural8Value R_ByteBuffer_getAt(R_ByteBuffer const* self, R_SizeValue index)

Get the Byte value at the specified index.

Parameters

Return Value

The Byte value.

Remarks

The size of a Byte buffer is the length of the Byte sequence it contains.

isEmpty

R_BooleanValue R_ByteBuffer_isEmpty(R_ByteBuffer* self)

Get if this Byte buffer is empty.

Parameters

Return Value

R_BooleanValue_True if this Byte buffer is empty. R_BooleanValue_False otherwise.

Errors

swap

void R_ByteBuffer_swap(R_ByteBuffer* self, R_ByteBuffer* other)

Swap the contents of this Byte buffer with the contents of another Byte buffer.

Parameters

Errors

File Handle

R_FileHandle represents a operating system file handle. This type is allocated on the heap and values of this type are referenced by R_FileHandle pointers. A R_FileHandle pointer can be safely cast into a R_ObjectReferenceValue values. An R_ObjectReferenceValue pointing to a R_FileHandle value can be safely cast into a R_FileHandle pointer.

create

R_FileHandle* R_FileHandle_create()

Create a file handle. The file handle is closed.

Return Value

A pointer to the file handle.

close

void R_FileHandle_close(R_FileHandle* self)

Close this file handle.

Parameters

openForReading

void R_FileHandle_openForReading(R_FileHandle* self, R_FilePath* path)

Open a file for reading. If the file is open, it is closed before trying to re-open it.

Parameters

Errors

openForWriting

void R_FileHandle_openForWriting(R_FileHandle* self, R_FilePath* path)

Open a file for writing. If the file is open, it is closed before trying to re-open it.

Parameters

Errors

isClosed

R_BooleanValue R_FileHandle_isClosed(R_FileHandle const* self)

Get if this file handle is closed.

Parameters

isOpened

R_BooleanValue R_FileHandle_isOpened(R_FileHandle const* self)

Get if this file handle is opened.

Parameters

isOpenedForReading

R_BooleanValue R_FileHandle_isOpenedForReading(R_FileHandle const* self)

Get if this file handle is opened for reading.

Parameters

isOpenedForWriting

R_BooleanValue R_FileHandle_isOpenedForWriting(R_FileHandle const* self)

Get if this file handle is opened for writing.

Parameters

write

void R_FileHandle_write(R_FileHandle* self, void const* p, R_SizeValue bytesToWrite)

Write Bytes to this file handle.

Parameters

Success

On success *bytesWritten is assigned the actual number of Bytes written.

Errors

read

void R_FileHandle_read(R_FileHandle* self, void const* bytes, R_SizeValue bytesToRead, R_SizeValue* bytesRead)

Read Bytes from this file handle.

Parameters

Success

On 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

File Path

R_FilePath represents a file path. This type is allocated on the heap and values of this type are referenced by R_FilePath pointers. A R_FilePath pointer can be safely cast into a R_ObjectReferenceValue values. An R_ObjectReferenceValue pointing to a R_FilePath value can be safely cast into a R_FilePath pointer.

create

R_FilePath* R_Path_create()

Create the empty file path.

Return Value

A pointer to the file path.

parseWindowsFilePath

R_FilePath* R_FilePath_parseWindowsFilePath(void const* bytes, R_SizeValue numberOfBytes)

Parse a file path in the Windows format.

Parameters

Return Value

A pointer to the file path.

parseUnixFilePath

R_FilePath* R_FilePath_parseUnixFilePath(void const* bytes, R_SizeValue numberOfBytes)

Parse a file path in the Unix format.

Parameters

Return Value

A pointer to the file path.

parseNativeFilePath

R_FilePath* R_FilePath_parseNativeFilePath(void const* bytes, R_SizeValue numberOfBytes)

Parse a file path in the native format.

Parameters

Return Value

A pointer to the file path.

toNative

R_String* R_FilePath_toNative(R_FilePath* self)

Convert a file path to the native format.

Parameters

Return Value

A pointer to the string.

FileSystem

R_FileSystem provides access to the file system. This type is allocated on the heap and values of this type are referenced by R_String pointers. A R_FileSystem pointer can be safely cast into a R_ObjectReferenceValue values. An R_ObjectReferenceValue pointing to a R_String value can be safely cast into a R_String pointer.

R_FileSystem_create

R_FileSystem* R_FileSystem_create()

Create a file system.

Errors

getFileContents

R_ByteBuffer* R_ByteBuffer_getFileContents(R_FilePath *path)

Get the contents of a file.

Parameters

Return Value

A pointer to a R_ByteBuffer object with the file contents.

Errors

setFileContents

void R_FileSystem_setFileContents(R_FilePath* path, R_ByteBuffer* contents)

Get if a sequence of Bytes is a prefix of this string's sequence of Bytes.

Parameters

Errors

List

R_List represents a list of R_Value objects. This type is allocated on the heap and values of this type are referenced by R_List pointers. A R_List pointer can be safely cast into a R_ObjectReferenceValue values. An R_ObjectReferenceValue pointing to a R_List value can be safely cast into a R_List pointer.

R_List_create

R_List* R_List_create()

Create a list.

Parameters

Errors

Return value

A pointer to the R_List value.

append

void R_List_append(R_List* self, R_Value value)

Append a R_Value to a list.

Parameters

clear

void R_List_clear(R_List* self)

Clear this list.

Parameters

getAt

R_Value R_List_getAt(R_List* self, R_SizeValue index)

Get the value at the specifie index in this list.

Parameters

Return Value

The value.

getSize

R_SizeValue R_List_getSize(R_List const* self)

Get the size of this list.

Parameters

Return Value

The size of this list.

insert

void R_List_insertAt(R_List* self, R_SizeValue index, R_Value value)

Compare this string with another string for equality.

Parameters

isEmpty

R_BooleanValue R_List_isEmpty(R_List* self)

Get if this list is empty.

Parameters

Return Value

R_BooleanValue_True if this list is empty. R_BooleanValue_False otherwise.

Errors

prepend

void R_List_prepend(R_List* self, R_Value value)

Get if a sequence of Bytes is a prefix of this string's sequence of Bytes.

Prepend a R_Value to a list.

Parameters

remove

void R_List_remove(R_List* self, R_SizeValue index, R_SizeValue count)

Remove length elements starting with element at index index.

Parameters

Errors

Stack

R_Stack represents a stack of R_Value objects. This type is allocated on the heap and values of this type are referenced by R_Stack pointers. A R_Stack pointer can be safely cast into a R_ObjectReferenceValue values. An R_ObjectReferenceValue pointing to a R_Stack value can be safely cast into a R_Stack pointer.

R_Stack_create

R_Stack* R_Stack_create()

Create a stack.

Errors

Return value

A pointer to the R_Stack value.

clear

void R_Stack_clear(R_Stack* self)

Clear this stack.

Parameters

getSize

R_SizeValue R_Stack_getSize(R_Stack const* self)

Get the size of this stack.

Parameters

Return Value

The size of this stack.

isEmpty

R_BooleanValue R_Stack_isEmpty(R_Stack* self)

Get if this stack is empty.

Parameters

Return Value

R_BooleanValue_True if this stack is empty. R_BooleanValue_False otherwise.

Errors

peek

R_Value R_Stack_peek(R_Stack* self)

Peek at the value on top of this stack.

Parameters

Return Value

The value.

pop

R_Value R_Stack_pop(R_Stack* self)

Pop the value from the top of this stack.

Parameters

Return Value

The value.

push

void R_Stack_push(R_Stack* self, R_Value value)

Push a value on the top of this stack.

Parameters

String

R_String represents an Unicode string encoded as UTF-8-NO-BOM. This type is allocated on the heap and values of this type are referenced by R_String pointers. A R_String pointer can be safely cast into a R_ObjectReferenceValue values. An R_ObjectReferenceValue pointing to a R_String value can be safely cast into a R_String pointer.

R_String_create_pn

R_String* R_String_create_pn(void const* bytes, R_SizeValue numberOfBytes)

Create a string from a sequence of Bytes.

Parameters

Return value

A pointer to the string.

Errors

R_String_create

R_String* R_String_create_pn(R_Value value)

Create a string from a value.

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

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

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

Parameters

Return value

A pointer to the string.

Errors

endsWith_pn

R_BooleanValue R_String_endsWith_pn(R_String const* self, void const* bytes, R_SizeValue numberOfBytes)

Get if a sequence of Bytes is a suffix of this string's sequence of Bytes.

Parameters

Return Value

R_BooleanValue_True if the sequence of Bytes is a suffix of this string's sequence of Bytes. R_BooleanValue_False otherwise.

startsWith_pn

R_BooleanValue R_String_startsWith_pn(R_String const* self, void const* bytes, R_SizeValue numberOfBytes)

Get if a sequence of Bytes is a prefix of this string's sequence of Bytes.

Parameters

Return Value

R_BooleanValue_True if the sequence of Bytes is a prefix of this string's sequence of Bytes. R_BooleanValue_False otherwise.

isEqualTo

R_BooleanValue R_String_isEqualTo(R_String const* self, R_String const* other)

Compare this string with another string for equality.

Parameters

Return Value

R_BooleanValue_True if this string is equal to the other string. R_BooleanValue_False otherwise.

isEqualTo_pn

R_BooleanValue R_String_isEqualTo_pn(R_String const* self, void const* bytes, R_SizeValue numberOfBytes)

Get if a sequence of Bytes is this string's sequence of Bytes.

Parameters

Return Value

R_BooleanValue_True if the sequence of Bytes is this string's sequence of Bytes. R_BooleanValue_False otherwise.

getNumberOfBytes

R_SizeValue R_String_getNumberOfBytes(R_String const* self)

Get the size, in Bytes, of this string.

Parameters

Return Value

The size, in Bytes, of this string.

getByteAt

R_Natural8Value R_String_getByteAt(R_String const* self, R_SizeValue index)

Get the Byte value at the specified index.

Parameters

Return Value

The Byte value.

toInteger8

R_Integer8Value R_String_toInteger8(R_String const* self)

Interprete the symbols of this string as decimal integer literal and convert the number represented by that integer literal into an R_Integer8Value.

Parameters

Return Value

The integer value.

Errors

toInteger16

R_Integer16Value R_String_toInteger16(R_String const* self)

Interprete the symbols of this string as decimal integer literal and convert the number represented by that integer literal into an R_Integer16Value.

Parameters

Return Value

The integer value.

Errors

toInteger32

R_Integer32Value R_String_toInteger32(R_String const* self)

Interprete the symbols of this string as decimal integer literal and convert the number represented by that integer literal into an R_Integer32Value.

Parameters

Return Value

The integer value.

Errors

toInteger64

R_Integer64Value R_String_toInteger64(R_String const* self)

Interprete the symbols of this string as decimal integer literal and convert the number represented by that integer literal into an R_Integer64Value.

Parameters

Return Value

The integer value.

Errors

toNatural8

R_Natural8Value R_String_toNatural8(R_String const* self)

Interprete the symbols of this string as decimal natural literal and convert the number represented by that natural literal into an R_Natural8Value.

Parameters

Return Value

The natural value.

Errors

toNatural16

R_Natural16Value R_String_toNatural16(R_String const* self)

Interprete the symbols of this string as decimal natural literal and convert the number represented by that natural literal into an R_Natural16Value.

Parameters

Return Value

The natural value.

Errors

toNatural32

R_Natural32Value R_String_toNatural16(R_String const* self)

Interprete the symbols of this string as decimal natural literal and convert the number represented by that natural literal into an R_Natural32Value.

Parameters

Return Value

The natural value.

Errors

toNatural64

R_Natural64Value R_String_toNatural16(R_String const* self)

Interprete the symbols of this string as decimal natural literal and convert the number represented by that natural literal into an R_Natural64Value.

Parameters

Return Value

The natural value.

Errors