Ikarus/libikarus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

adjust values api to vector-esque interface

Browse source 
Signed-off-by: Folling <mail@folling.io>
This commit is contained in:
folling 2023-12-03 10:16:13 +01:00 • committed by Folling
parent 733b52575b
commit 3395eba331
Signed by: folling
SSH key fingerprint: SHA256:S9qEx5WCFFLK49tE/LKnKuJYM5sw+++Dn6qJbbyxnCY
13 changed files with 297 additions and 220 deletions
Download patch file Download diff file Expand all files Collapse all files

66
include/ikarus/values/toggle_value.h
View file

@ -14,42 +14,52 @@ IKARUS_BEGIN_HEADER
/// \brief A true/false boolean-esque value. For example "Is Dead".
struct IkarusToggleValue;
/// \brief Creates a toggle value from doubles.
/// \param data The toggle data or null if you wish to clear the data.
/// \details LibIkarus does not take ownership of this array.
/// \param data_size The size of the data array or 0 if you wish to clear the data.
/// \return The value.
/// \brief Creates a toggle value from booleans.
/// \return The value or null if an error occurs.
/// \remark Must be freed with #ikarus_free.
IKA_API IkarusToggleValue * ikarus_toggle_value_create(bool * data, size_t data_size);
IKA_API IkarusToggleValue * ikarus_toggle_value_create();
/// \brief Creates an indeterminate toggle value.
/// \return The value.
/// \remark Must be freed with #ikarus_free.
IKA_API IkarusToggleValue * ikarus_toggle_value_create_indeterminate();
/// \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 indeterminate.
IKA_API bool const * ikarus_toggle_value_get(IkarusToggleValue * value, size_t idx);
/// \brief Fetches the underlying data of a toggle value.
/// \details You may adjust the returned data as per your hearts desire.
/// If you need to grow the data, use #ikarus_toggle_value_set with a new array.
/// Just remember that IkarusValues are plain objects, so changing them won't affect any state.
/// They will need to be submitted to other functions such as #ikarus_entity_set_value to have any effect.
/// \brief Fetches the size of the underlying data of a toggle value.
/// \param value The toggle value.
/// \pre \li Must not be null.
/// \param data_size_out An out-parameter for the size of the returned array.
/// \remark Ignored if null.
/// \return The underlying data. Owned by LibIkarus, most not be freed.
/// \warning Undefined if the value is indeterminate.
IKA_API bool * ikarus_toggle_value_get(IkarusToggleValue * value, size_t * data_size_out);
/// \return The size of the underlying data or 0 if an error occurs or the value is indeterminate.
IKA_API size_t ikarus_toggle_value_get_size(IkarusToggleValue const * value);
/// \see ikarus_toggle_value_get
bool const * ikarus_toggle_value_get_const(IkarusToggleValue const * value, size_t * data_size_out);
/// \brief Sets the data of a toggle value.
/// \brief Sets the data of a toggle value at a specific index.
/// \param value The toggle value.
/// \pre \li Must not be null.
/// \param new_data The new data or null if you wish to clear the data.
/// \details LibIkarus does not take ownership of this array.
/// \param new_data_size The size of the new data array or 0 if you wish to clear the data.
IKA_API void ikarus_toggle_value_set(IkarusToggleValue * value, bool * new_data, size_t new_data_size);
/// \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);
/// \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);
/// \brief Inserts a data into a toggle value.
/// \param value The toggle 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_toggle_value_insert(IkarusToggleValue * value, size_t idx, bool new_data);
/// \brief Clears a toggle value.
/// \param value The toggle value.
/// \remark Noop if the value is indeterminate.
IKA_API void ikarus_toggle_value_clear(IkarusToggleValue * value);
/// \brief Converts a toggle value to an entity value.
/// \param value The toggle value to convert.