Settings variable abstract base, additional validation, and reading/writing JSON

This commit is contained in:
Dan Paulat 2022-12-17 00:38:20 -06:00
parent 1ad67de71b
commit 46c4dd3780
7 changed files with 408 additions and 17 deletions

View file

@ -24,25 +24,83 @@ public:
SettingsContainer(SettingsContainer&&) noexcept;
SettingsContainer& operator=(SettingsContainer&&) noexcept;
/**
* Sets the current value of the settings variable. If the value is out of
* range, the value is set to the minimum or maximum. If the value fails
* validation, the value is set to default.
*
* @param c Container value to set
*
* @return true if the value is valid, false if the value was modified.
*/
bool SetValueOrDefault(const Container& c) override;
/**
* Validate the container value against the defined parameters of the
* settings variable.
*
* @param c Container value to validate
*
* @return true if the value is valid, false if the value failed validation.
*/
bool Validate(const Container& c) const override;
/**
* Validate the element value against the defined parameters of the settings
* variable.
*
* @param value Element value to validate
*
* @return true if the value is valid, false if the value failed validation.
*/
bool ValidateElement(const T& value) const;
/**
* Gets the default element value of the settings variable.
*
* @return Default element value
*/
T GetElementDefault() const;
/**
* Sets the default element value of the settings variable.
*
* @param value Default element value
*/
void SetElementDefault(const T& value);
/**
* Sets the minimum element value of the settings variable.
*
* @param value Minimum element value
*/
void SetElementMinimum(const T& value);
/**
* Sets the maximum element value of the settings variable.
*
* @param value Maximum element value
*/
void SetElementMaximum(const T& value);
/**
* Sets a custom validator function for each element of the settings
* variable.
*
* @param validator Element validator function
*/
void SetElementValidator(std::function<bool(const T&)> validator);
protected:
virtual bool Equals(const SettingsVariableBase& o) const override;
private:
class Impl;
std::unique_ptr<Impl> p;
};
#ifdef SETTINGS_CONTAINER_IMPLEMENTATION
template class SettingsContainer<std::vector<int64_t>>;
template class SettingsContainer<std::vector<std::int64_t>>;
#endif
} // namespace settings