change error system & function signatures
Signed-off-by: Folling <mail@folling.io>
This commit is contained in:
parent
ee85c53354
commit
e17e346768
SSH key fingerprint:
SHA256:S9qEx5WCFFLK49tE/LKnKuJYM5sw+++Dn6qJbbyxnCY
28 changed files with 633 additions and 651 deletions
|
|
@ -3,8 +3,8 @@
|
|||
/// \file number_value.h
|
||||
/// \author Folling <folling@ikarus.world>
|
||||
|
||||
#include <ikarus/errors.h>
|
||||
#include <ikarus/macros.h>
|
||||
#include <ikarus/stdtypes.h>
|
||||
|
||||
/// \addtogroup values Values
|
||||
/// @{
|
||||
|
|
@ -14,24 +14,27 @@ IKARUS_BEGIN_HEADER
|
|||
/// \brief A numeric value. For example "Age" or "Height".
|
||||
struct IkarusNumberValue;
|
||||
|
||||
/// \brief Creates a number value.
|
||||
/// \brief Creates an empty number value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The value or null if an error occurs.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
IKA_API IkarusNumberValue * ikarus_number_value_create();
|
||||
IKA_API IkarusNumberValue * ikarus_number_value_create(IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Fetches the underlying data of a number value at a specific index.
|
||||
/// \param value The number value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to fetch.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
/// \return The underlying data or null if an error occurs or the value is undefined.
|
||||
IKA_API double const * ikarus_number_value_get(IkarusNumberValue * value, size_t idx);
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The underlying data or NaN if an error occurs or the value is undefined.
|
||||
IKA_API double ikarus_number_value_get(IkarusNumberValue const * value, size_t idx, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Fetches the size of the underlying data of a number value.
|
||||
/// \param value The number value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The size of the underlying data or 0 if an error occurs or the value is undefined.
|
||||
IKA_API size_t ikarus_number_value_get_size(IkarusNumberValue const * value);
|
||||
IKA_API size_t ikarus_number_value_get_size(IkarusNumberValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Sets the data of a number value at a specific index.
|
||||
/// \param value The number value.
|
||||
|
|
@ -39,14 +42,16 @@ IKA_API size_t ikarus_number_value_get_size(IkarusNumberValue const * value);
|
|||
/// \param idx The index of the data to set.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
/// \param new_data The new data.
|
||||
IKA_API void ikarus_number_value_set(IkarusNumberValue * value, size_t idx, double const * new_data);
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_number_value_set(IkarusNumberValue * value, size_t idx, double new_data, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Removes a data from a number value.
|
||||
/// \param value The number value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to remove.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
IKA_API void ikarus_number_value_remove(IkarusNumberValue * value, size_t idx);
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_number_value_remove(IkarusNumberValue * value, size_t idx, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Inserts a data into a number value.
|
||||
/// \param value The number value.
|
||||
|
|
@ -54,60 +59,68 @@ IKA_API void ikarus_number_value_remove(IkarusNumberValue * value, size_t idx);
|
|||
/// \param idx The index of the data to insert.
|
||||
/// \pre \li Must be less than or equal to the size of the value.
|
||||
/// \param new_data The new data.
|
||||
IKA_API void ikarus_number_value_insert(IkarusNumberValue * value, size_t idx, double const * new_data);
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_number_value_insert(IkarusNumberValue * value, size_t idx, double new_data, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Clears a number value.
|
||||
/// \param value The number value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \remark Noop if the value is undefined.
|
||||
IKA_API void ikarus_number_value_clear(IkarusNumberValue * value);
|
||||
IKA_API void ikarus_number_value_clear(IkarusNumberValue * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Checks if a number value is undefined.
|
||||
/// \param value The number value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return True if the value is undefined, false otherwise.
|
||||
IKA_API bool ikarus_number_value_is_undefined(IkarusNumberValue const * value);
|
||||
IKA_API bool ikarus_number_value_is_undefined(IkarusNumberValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Changes a number value's undefined state.
|
||||
/// \param value The number value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param undefined The new undefined state.
|
||||
/// \param error_out \see errors.h
|
||||
/// \remark Noop if the value is already undefined.
|
||||
/// \remark If the value is set to undefined, all data will be cleared.
|
||||
/// \remark If the value is set to not undefined, the value is as if newly created.
|
||||
IKA_API void ikarus_number_value_set_undefined(IkarusNumberValue * value, bool undefined);
|
||||
IKA_API void ikarus_number_value_set_undefined(IkarusNumberValue * value, bool undefined, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Converts a number value to a string.
|
||||
/// \param value The number value to convert.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The converted string.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
/// \remark Undefined if the value is undefined.
|
||||
IKA_API char const * ikarus_number_value_to_string(IkarusNumberValue const * value);
|
||||
IKA_API char const * ikarus_number_value_to_string(IkarusNumberValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Checks if two values are equal.
|
||||
/// \param lhs The left hand side value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param rhs The right hand side value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return True if the values' data are equal, false otherwise.
|
||||
IKA_API bool ikarus_number_value_is_equal(IkarusNumberValue const * lhs, IkarusNumberValue const * rhs);
|
||||
IKA_API bool ikarus_number_value_is_equal(IkarusNumberValue const * lhs, IkarusNumberValue const * rhs, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Creates a copy of a number value.
|
||||
/// \param value The value to copy.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The copied value.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
IKA_API IkarusNumberValue * ikarus_number_value_copy(IkarusNumberValue const * value);
|
||||
IKA_API IkarusNumberValue * ikarus_number_value_copy(IkarusNumberValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Converts a number value to an entity value.
|
||||
/// \param value The number value to convert.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The converted entity value.
|
||||
/// \remark This is the same pointer, so freeing it implies freeing the original value.
|
||||
IKA_API struct IkarusValue * ikarus_number_value_to_value(IkarusNumberValue * value);
|
||||
IKA_API struct IkarusValue * ikarus_number_value_to_value(IkarusNumberValue * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \see ikarus_toggle_value_to_value
|
||||
IKA_API struct IkarusValue const * ikarus_number_value_to_value_const(IkarusNumberValue const * value);
|
||||
IKA_API struct IkarusValue const * ikarus_number_value_to_value_const(IkarusNumberValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
IKARUS_END_HEADER
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
/// \file text_value.h
|
||||
/// \author Folling <folling@ikarus.world>
|
||||
|
||||
#include <ikarus/errors.h>
|
||||
#include <ikarus/macros.h>
|
||||
#include <ikarus/stdtypes.h>
|
||||
|
||||
|
|
@ -14,101 +15,115 @@ IKARUS_BEGIN_HEADER
|
|||
/// \brief A textual value. For example "Surname" or "Description"
|
||||
struct IkarusTextValue;
|
||||
|
||||
/// \brief Creates a text value.
|
||||
/// \brief Creates an empty text value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The value or null if an error occurs.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
IKA_API IkarusTextValue * ikarus_text_value_create();
|
||||
IKA_API IkarusTextValue * ikarus_text_value_create(IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Fetches the underlying data of a number value at a specific index.
|
||||
/// \param value The number value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to fetch.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The underlying data or null if an error occurs or the value is undefined.
|
||||
/// \remark This value is owned by LibIkarus and must not be freed.
|
||||
IKA_API char const * ikarus_text_value_get(IkarusTextValue * value, size_t idx);
|
||||
IKA_API char const * const * ikarus_text_value_get(IkarusTextValue const * value, size_t idx, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Fetches the size of the underlying data of a text value.
|
||||
/// \param value The text value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The size of the underlying data or 0 if an error occurs or the value is undefined.
|
||||
IKA_API size_t ikarus_text_value_get_size(IkarusTextValue const * value);
|
||||
IKA_API size_t ikarus_text_value_get_size(IkarusTextValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Sets the data of a text value at a specific index.
|
||||
/// \param value The text value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to set.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
/// \param new_data The new data. LibIkarus assumes ownership of this pointer.
|
||||
IKA_API void ikarus_text_value_set(IkarusTextValue * value, size_t idx, char const * new_data);
|
||||
/// \param new_data The new data. Ownership remains with the caller.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_text_value_set(IkarusTextValue * value, size_t idx, char const * new_data, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Removes a data from a text value.
|
||||
/// \param value The text value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to remove.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
IKA_API void ikarus_text_value_remove(IkarusTextValue * value, size_t idx);
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_text_value_remove(IkarusTextValue * value, size_t idx, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Inserts a data into a text value.
|
||||
/// \param value The text value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to insert.
|
||||
/// \pre \li Must be less than or equal to the size of the value.
|
||||
/// \param new_data The new data.
|
||||
IKA_API void ikarus_text_value_insert(IkarusTextValue * value, size_t idx, char const * new_data);
|
||||
/// \param new_data The new data. Ownership remains with the caller.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_text_value_insert(IkarusTextValue * value, size_t idx, char const * new_data, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Clears a text value.
|
||||
/// \param value The text value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \remark Noop if the value is undefined.
|
||||
IKA_API void ikarus_text_value_clear(IkarusTextValue * value);
|
||||
IKA_API void ikarus_text_value_clear(IkarusTextValue * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Checks if a text value is undefined.
|
||||
/// \param value The text value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return True if the value is undefined, false otherwise.
|
||||
IKA_API bool ikarus_text_value_is_undefined(IkarusTextValue const * value);
|
||||
IKA_API bool ikarus_text_value_is_undefined(IkarusTextValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Changes a text value's undefined state.
|
||||
/// \param value The text value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param undefined The new undefined state.
|
||||
/// \param error_out \see errors.h
|
||||
/// \remark Noop if the value is already undefined.
|
||||
/// \remark If the value is set to undefined, all data will be cleared.
|
||||
/// \remark If the value is set to not undefined, the value is as if newly created.
|
||||
IKA_API void ikarus_text_value_set_undefined(IkarusTextValue * value, bool undefined);
|
||||
IKA_API void ikarus_text_value_set_undefined(IkarusTextValue * value, bool undefined, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Converts a text value to a string.
|
||||
/// \param value The text value to convert.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The converted string.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
/// \remark Undefined if the value is undefined.
|
||||
IKA_API char const * ikarus_text_value_to_string(IkarusTextValue const * value);
|
||||
IKA_API char const * ikarus_text_value_to_string(IkarusTextValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Checks if two values are equal.
|
||||
/// \param lhs The left hand side value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param rhs The right hand side value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return True if the values' data are equal, false otherwise.
|
||||
IKA_API bool ikarus_text_value_is_equal(IkarusTextValue const * lhs, IkarusTextValue const * rhs);
|
||||
IKA_API bool ikarus_text_value_is_equal(IkarusTextValue const * lhs, IkarusTextValue const * rhs, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Creates a copy of a text value.
|
||||
/// \param value The value to copy.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The copied value.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
IKA_API IkarusTextValue * ikarus_text_value_copy(IkarusTextValue const * value);
|
||||
IKA_API IkarusTextValue * ikarus_text_value_copy(IkarusTextValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Converts a text value to an entity value.
|
||||
/// \param value The text value to convert.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The converted entity value.
|
||||
/// \remark This is the same pointer, so freeing it implies freeing the original value.
|
||||
IKA_API struct IkarusValue * ikarus_text_value_to_value(IkarusTextValue * value);
|
||||
IKA_API struct IkarusValue * ikarus_text_value_to_value(IkarusTextValue * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \see ikarus_toggle_value_to_value
|
||||
IKA_API struct IkarusValue const * ikarus_text_value_to_value_const(IkarusTextValue const * value);
|
||||
/// \see ikarus_text_value_to_value
|
||||
IKA_API struct IkarusValue const * ikarus_text_value_to_value_const(IkarusTextValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
IKARUS_END_HEADER
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
/// \file toggle_value.h
|
||||
/// \author Folling <folling@ikarus.world>
|
||||
|
||||
#include <ikarus/errors.h>
|
||||
#include <ikarus/macros.h>
|
||||
#include <ikarus/stdtypes.h>
|
||||
|
||||
|
|
@ -14,24 +15,27 @@ IKARUS_BEGIN_HEADER
|
|||
/// \brief A true/false boolean-esque value. For example "Is Dead".
|
||||
struct IkarusToggleValue;
|
||||
|
||||
/// \brief Creates a toggle.
|
||||
/// \brief Creates an empty toggle value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The value or null if an error occurs.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
IKA_API IkarusToggleValue * ikarus_toggle_value_create();
|
||||
IKA_API IkarusToggleValue * ikarus_toggle_value_create(IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Fetches the underlying data of a number value at a specific index.
|
||||
/// \param value The number value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to fetch.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The underlying data or null if an error occurs or the value is undefined.
|
||||
IKA_API bool const * ikarus_toggle_value_get(IkarusToggleValue * value, size_t idx);
|
||||
IKA_API bool const * ikarus_toggle_value_get(IkarusToggleValue const * value, size_t idx, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Fetches the size of the underlying data of a toggle value.
|
||||
/// \param value The toggle value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The size of the underlying data or 0 if an error occurs or the value is undefined.
|
||||
IKA_API size_t ikarus_toggle_value_get_size(IkarusToggleValue const * value);
|
||||
IKA_API size_t ikarus_toggle_value_get_size(IkarusToggleValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Sets the data of a toggle value at a specific index.
|
||||
/// \param value The toggle value.
|
||||
|
|
@ -39,14 +43,16 @@ IKA_API size_t ikarus_toggle_value_get_size(IkarusToggleValue const * value);
|
|||
/// \param idx The index of the data to set.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
/// \param new_data The new data.
|
||||
IKA_API void ikarus_toggle_value_set(IkarusToggleValue * value, size_t idx, bool new_data);
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_toggle_value_set(IkarusToggleValue * value, size_t idx, bool new_data, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Removes a data from a toggle value.
|
||||
/// \param value The toggle value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param idx The index of the data to remove.
|
||||
/// \pre \li Must be less than the size of the value.
|
||||
IKA_API void ikarus_toggle_value_remove(IkarusToggleValue * value, size_t idx);
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_toggle_value_remove(IkarusToggleValue * value, size_t idx, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Inserts a data into a toggle value.
|
||||
/// \param value The toggle value.
|
||||
|
|
@ -54,60 +60,68 @@ IKA_API void ikarus_toggle_value_remove(IkarusToggleValue * value, size_t idx);
|
|||
/// \param idx The index of the data to insert.
|
||||
/// \pre \li Must be less than or equal to the size of the value.
|
||||
/// \param new_data The new data.
|
||||
IKA_API void ikarus_toggle_value_insert(IkarusToggleValue * value, size_t idx, bool new_data);
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_toggle_value_insert(IkarusToggleValue * value, size_t idx, bool new_data, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Clears a toggle value.
|
||||
/// \param value The toggle value.
|
||||
/// \param error_out \see errors.h
|
||||
/// \remark Noop if the value is undefined.
|
||||
IKA_API void ikarus_toggle_value_clear(IkarusToggleValue * value);
|
||||
IKA_API void ikarus_toggle_value_clear(IkarusToggleValue * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Checks if a toggle value is undefined.
|
||||
/// \param value The toggle value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return True if the value is undefined, false otherwise.
|
||||
IKA_API bool ikarus_toggle_value_is_undefined(IkarusToggleValue const * value);
|
||||
IKA_API bool ikarus_toggle_value_is_undefined(IkarusToggleValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Changes a toggle value's undefined state.
|
||||
/// \param value The toggle value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param undefined The new undefined state.
|
||||
/// \param error_out \see errors.h
|
||||
/// \remark Noop if the value is already undefined.
|
||||
/// \remark If the value is set to undefined, all data will be cleared.
|
||||
/// \remark If the value is set to not undefined, the value is as if newly created.
|
||||
IKA_API void ikarus_toggle_value_set_undefined(IkarusToggleValue * value, bool undefined);
|
||||
IKA_API void ikarus_toggle_value_set_undefined(IkarusToggleValue * value, bool undefined, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Converts a toggle value to a string.
|
||||
/// \param value The toggle value to convert.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The converted string.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
/// \remark Undefined if the value is undefined.
|
||||
IKA_API char const * ikarus_toggle_value_to_string(IkarusToggleValue const * value);
|
||||
IKA_API char const * ikarus_toggle_value_to_string(IkarusToggleValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Checks if two values are equal.
|
||||
/// \param lhs The left hand side value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param rhs The right hand side value.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return True if the values' data are equal, false otherwise.
|
||||
IKA_API bool ikarus_toggle_value_is_equal(IkarusToggleValue const * lhs, IkarusToggleValue const * rhs);
|
||||
IKA_API bool ikarus_toggle_value_is_equal(IkarusToggleValue const * lhs, IkarusToggleValue const * rhs, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Creates a copy of a toggle value.
|
||||
/// \param value The value to copy.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The copied value.
|
||||
/// \remark Must be freed with #ikarus_free.
|
||||
IKA_API IkarusToggleValue * ikarus_toggle_value_copy(IkarusToggleValue const * value);
|
||||
IKA_API IkarusToggleValue * ikarus_toggle_value_copy(IkarusToggleValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \brief Converts a toggle value to an entity value.
|
||||
/// \param value The toggle value to convert.
|
||||
/// \pre \li Must not be null.
|
||||
/// \param error_out \see errors.h
|
||||
/// \return The converted entity value.
|
||||
/// \remark This is the same pointer, so freeing it implies freeing the original value.
|
||||
IKA_API struct IkarusValue * ikarus_toggle_value_to_value(IkarusToggleValue * value);
|
||||
IKA_API struct IkarusValue * ikarus_toggle_value_to_value(IkarusToggleValue * value, IkarusErrorData * error_out);
|
||||
|
||||
/// \see ikarus_toggle_value_to_value
|
||||
IKA_API struct IkarusValue const * ikarus_toggle_value_to_value_const(IkarusToggleValue const * value);
|
||||
IKA_API struct IkarusValue const * ikarus_toggle_value_to_value_const(IkarusToggleValue const * value, IkarusErrorData * error_out);
|
||||
|
||||
IKARUS_END_HEADER
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
/// \file value.h
|
||||
/// \author Folling <folling@ikarus.world>
|
||||
|
||||
#include <ikarus/errors.h>
|
||||
#include <ikarus/macros.h>
|
||||
|
||||
/// \defgroup values Values
|
||||
|
|
@ -11,7 +12,7 @@
|
|||
/// These value classes represent plain objects. They are not associated with any entity.
|
||||
/// Each value may be undefined. \see IkarusProperty
|
||||
/// Values are stored as lists. If a property is "singular" then its value is a list of size 1.
|
||||
/// Values are typed, with types existing for each of the corresponding property types.
|
||||
/// Values are typed, with types existing for each of the corresponding property types. The data of values starts with the index 0.
|
||||
/// When setting values for a property the type must match the property type and the value must be valid under the
|
||||
/// property's settings. \see PropertyType
|
||||
/// @{
|
||||
|
|
@ -28,12 +29,14 @@ struct IkarusValue;
|
|||
/// \param number_visitor The function to call if the value is a number value. Skipped if null.
|
||||
/// \param text_visitor The function to call if the value is a text value. Skipped if null.
|
||||
/// \param data The data passed to the visitor functions.
|
||||
/// \param error_out \see errors.h
|
||||
IKA_API void ikarus_value_visit(
|
||||
IkarusValue * value,
|
||||
void (*toggle_visitor)(struct IkarusToggleValue *, void *),
|
||||
void (*number_visitor)(struct IkarusNumberValue *, void *),
|
||||
void (*text_visitor)(struct IkarusTextValue *, void *),
|
||||
void * data
|
||||
void * data,
|
||||
IkarusErrorData * error_out
|
||||
);
|
||||
|
||||
/// \see ikarus_value_visit
|
||||
|
|
@ -42,7 +45,8 @@ IKA_API void ikarus_value_visit_const(
|
|||
void (*toggle_visitor)(struct IkarusToggleValue const *, void *),
|
||||
void (*number_visitor)(struct IkarusNumberValue const *, void *),
|
||||
void (*text_visitor)(struct IkarusTextValue const *, void *),
|
||||
void * data
|
||||
void * data,
|
||||
IkarusErrorData * error_out
|
||||
);
|
||||
|
||||
IKARUS_END_HEADER
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue