blakeridgway/supercell-wx
1
0
Fork 0
mirror of https://github.com/ciphervance/supercell-wx.git synced 2025-10-30 15:20:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add [[nodiscard]] to functions which need it in settings files

Browse source
This commit is contained in:
AdenKoperczak 2025-01-29 10:06:46 -05:00
parent ba62004002
commit 36339e613f
14 changed files with 96 additions and 88 deletions
Download patch file Download diff file Expand all files Collapse all files

8
scwx-qt/source/scwx/qt/settings/alert_palette_settings.hpp
View file

@ -23,11 +23,11 @@ public:
AlertPaletteSettings(AlertPaletteSettings&&) noexcept;
AlertPaletteSettings& operator=(AlertPaletteSettings&&) noexcept;
LineSettings&
[[nodiscard]] LineSettings&
threat_category(awips::ibw::ThreatCategory threatCategory) const;
LineSettings& inactive() const;
LineSettings& observed() const;
LineSettings& tornado_possible() const;
[[nodiscard]] LineSettings& inactive() const;
[[nodiscard]] LineSettings& observed() const;
[[nodiscard]] LineSettings& tornado_possible() const;
friend bool operator==(const AlertPaletteSettings& lhs,
const AlertPaletteSettings& rhs);

21
scwx-qt/source/scwx/qt/settings/audio_settings.hpp
View file

@ -22,16 +22,17 @@ public:
AudioSettings(AudioSettings&&) noexcept;
AudioSettings& operator=(AudioSettings&&) noexcept;
SettingsVariable<std::string>& alert_sound_file() const;
SettingsVariable<std::string>& alert_location_method() const;
SettingsVariable<double>& alert_latitude() const;
SettingsVariable<double>& alert_longitude() const;
SettingsVariable<double>& alert_radius() const;
SettingsVariable<std::string>& alert_radar_site() const;
SettingsVariable<std::string>& alert_county() const;
SettingsVariable<std::string>& alert_wfo() const;
SettingsVariable<bool>& alert_enabled(awips::Phenomenon phenomenon) const;
SettingsVariable<bool>& ignore_missing_codecs() const;
[[nodiscard]] SettingsVariable<std::string>& alert_sound_file() const;
[[nodiscard]] SettingsVariable<std::string>& alert_location_method() const;
[[nodiscard]] SettingsVariable<double>& alert_latitude() const;
[[nodiscard]] SettingsVariable<double>& alert_longitude() const;
[[nodiscard]] SettingsVariable<double>& alert_radius() const;
[[nodiscard]] SettingsVariable<std::string>& alert_radar_site() const;
[[nodiscard]] SettingsVariable<std::string>& alert_county() const;
[[nodiscard]] SettingsVariable<std::string>& alert_wfo() const;
[[nodiscard]] SettingsVariable<bool>&
alert_enabled(awips::Phenomenon phenomenon) const;
[[nodiscard]] SettingsVariable<bool>& ignore_missing_codecs() const;
static AudioSettings& Instance();

66
scwx-qt/source/scwx/qt/settings/general_settings.hpp
View file

@ -21,38 +21,40 @@ public:
GeneralSettings(GeneralSettings&&) noexcept;
GeneralSettings& operator=(GeneralSettings&&) noexcept;
SettingsVariable<bool>& anti_aliasing_enabled() const;
SettingsVariable<std::string>& clock_format() const;
SettingsVariable<std::string>& custom_style_draw_layer() const;
SettingsVariable<std::string>& custom_style_url() const;
SettingsVariable<bool>& debug_enabled() const;
SettingsVariable<std::string>& default_alert_action() const;
SettingsVariable<std::string>& default_radar_site() const;
SettingsVariable<std::string>& default_time_zone() const;
SettingsContainer<std::vector<std::int64_t>>& font_sizes() const;
SettingsVariable<std::int64_t>& grid_height() const;
SettingsVariable<std::int64_t>& grid_width() const;
SettingsVariable<std::int64_t>& loop_delay() const;
SettingsVariable<double>& loop_speed() const;
SettingsVariable<std::int64_t>& loop_time() const;
SettingsVariable<std::string>& map_provider() const;
SettingsVariable<std::string>& mapbox_api_key() const;
SettingsVariable<std::string>& maptiler_api_key() const;
SettingsVariable<std::int64_t>& nmea_baud_rate() const;
SettingsVariable<std::string>& nmea_source() const;
SettingsVariable<std::string>& positioning_plugin() const;
SettingsVariable<bool>& process_module_warnings_enabled() const;
SettingsVariable<bool>& show_map_attribution() const;
SettingsVariable<bool>& show_map_center() const;
SettingsVariable<bool>& show_map_logo() const;
SettingsVariable<std::string>& theme() const;
SettingsVariable<std::string>& theme_file() const;
SettingsVariable<bool>& track_location() const;
SettingsVariable<bool>& update_notifications_enabled() const;
SettingsVariable<std::string>& warnings_provider() const;
SettingsVariable<bool>& cursor_icon_always_on() const;
SettingsVariable<double>& radar_site_threshold() const;
SettingsVariable<bool>& high_privilege_warning_enabled() const;
[[nodiscard]] SettingsVariable<bool>& anti_aliasing_enabled() const;
[[nodiscard]] SettingsVariable<std::string>& clock_format() const;
[[nodiscard]] SettingsVariable<std::string>& custom_style_draw_layer() const;
[[nodiscard]] SettingsVariable<std::string>& custom_style_url() const;
[[nodiscard]] SettingsVariable<bool>& debug_enabled() const;
[[nodiscard]] SettingsVariable<std::string>& default_alert_action() const;
[[nodiscard]] SettingsVariable<std::string>& default_radar_site() const;
[[nodiscard]] SettingsVariable<std::string>& default_time_zone() const;
[[nodiscard]] SettingsContainer<std::vector<std::int64_t>>&
font_sizes() const;
[[nodiscard]] SettingsVariable<std::int64_t>& grid_height() const;
[[nodiscard]] SettingsVariable<std::int64_t>& grid_width() const;
[[nodiscard]] SettingsVariable<std::int64_t>& loop_delay() const;
[[nodiscard]] SettingsVariable<double>& loop_speed() const;
[[nodiscard]] SettingsVariable<std::int64_t>& loop_time() const;
[[nodiscard]] SettingsVariable<std::string>& map_provider() const;
[[nodiscard]] SettingsVariable<std::string>& mapbox_api_key() const;
[[nodiscard]] SettingsVariable<std::string>& maptiler_api_key() const;
[[nodiscard]] SettingsVariable<std::int64_t>& nmea_baud_rate() const;
[[nodiscard]] SettingsVariable<std::string>& nmea_source() const;
[[nodiscard]] SettingsVariable<std::string>& positioning_plugin() const;
[[nodiscard]] SettingsVariable<bool>&
process_module_warnings_enabled() const;
[[nodiscard]] SettingsVariable<bool>& show_map_attribution() const;
[[nodiscard]] SettingsVariable<bool>& show_map_center() const;
[[nodiscard]] SettingsVariable<bool>& show_map_logo() const;
[[nodiscard]] SettingsVariable<std::string>& theme() const;
[[nodiscard]] SettingsVariable<std::string>& theme_file() const;
[[nodiscard]] SettingsVariable<bool>& track_location() const;
[[nodiscard]] SettingsVariable<bool>& update_notifications_enabled() const;
[[nodiscard]] SettingsVariable<std::string>& warnings_provider() const;
[[nodiscard]] SettingsVariable<bool>& cursor_icon_always_on() const;
[[nodiscard]] SettingsVariable<double>& radar_site_threshold() const;
[[nodiscard]] SettingsVariable<bool>& high_privilege_warning_enabled() const;
static GeneralSettings& Instance();

3
scwx-qt/source/scwx/qt/settings/hotkey_settings.hpp
View file

@ -22,7 +22,8 @@ public:
HotkeySettings(HotkeySettings&&) noexcept;
HotkeySettings& operator=(HotkeySettings&&) noexcept;
SettingsVariable<std::string>& hotkey(scwx::qt::types::Hotkey hotkey) const;
[[nodiscard]] SettingsVariable<std::string>&
hotkey(scwx::qt::types::Hotkey hotkey) const;
static HotkeySettings& Instance();

18
scwx-qt/source/scwx/qt/settings/line_settings.hpp
View file

@ -23,17 +23,17 @@ public:
LineSettings(LineSettings&&) noexcept;
LineSettings& operator=(LineSettings&&) noexcept;
SettingsVariable<std::string>& border_color() const;
SettingsVariable<std::string>& highlight_color() const;
SettingsVariable<std::string>& line_color() const;
[[nodiscard]] SettingsVariable<std::string>& border_color() const;
[[nodiscard]] SettingsVariable<std::string>& highlight_color() const;
[[nodiscard]] SettingsVariable<std::string>& line_color() const;
SettingsVariable<std::int64_t>& border_width() const;
SettingsVariable<std::int64_t>& highlight_width() const;
SettingsVariable<std::int64_t>& line_width() const;
[[nodiscard]] SettingsVariable<std::int64_t>& border_width() const;
[[nodiscard]] SettingsVariable<std::int64_t>& highlight_width() const;
[[nodiscard]] SettingsVariable<std::int64_t>& line_width() const;
boost::gil::rgba32f_pixel_t GetBorderColorRgba32f() const;
boost::gil::rgba32f_pixel_t GetHighlightColorRgba32f() const;
boost::gil::rgba32f_pixel_t GetLineColorRgba32f() const;
[[nodiscard]] boost::gil::rgba32f_pixel_t GetBorderColorRgba32f() const;
[[nodiscard]] boost::gil::rgba32f_pixel_t GetHighlightColorRgba32f() const;
[[nodiscard]] boost::gil::rgba32f_pixel_t GetLineColorRgba32f() const;
void StageValues(boost::gil::rgba8_pixel_t borderColor,
boost::gil::rgba8_pixel_t highlightColor,

2
scwx-qt/source/scwx/qt/settings/map_settings.hpp
View file

@ -21,7 +21,7 @@ public:
MapSettings(MapSettings&&) noexcept;
MapSettings& operator=(MapSettings&&) noexcept;
std::size_t count() const;
[[nodiscard]] std::size_t count() const;
SettingsVariable<std::string>& map_style(std::size_t i);
SettingsVariable<std::string>& radar_site(std::size_t i);
SettingsVariable<std::string>& radar_product_group(std::size_t i);

7
scwx-qt/source/scwx/qt/settings/palette_settings.hpp
View file

@ -24,9 +24,10 @@ public:
PaletteSettings(PaletteSettings&&) noexcept;
PaletteSettings& operator=(PaletteSettings&&) noexcept;
SettingsVariable<std::string>& palette(const std::string& name) const;
SettingsVariable<std::string>& alert_color(awips::Phenomenon phenomenon,
bool active) const;
[[nodiscard]] SettingsVariable<std::string>&
palette(const std::string& name) const;
[[nodiscard]] SettingsVariable<std::string>&
alert_color(awips::Phenomenon phenomenon, bool active) const;
AlertPaletteSettings& alert_palette(awips::Phenomenon);
static const std::vector<awips::Phenomenon>& alert_phenomena();

6
scwx-qt/source/scwx/qt/settings/settings_category.hpp
View file

@ -23,7 +23,7 @@ public:
SettingsCategory(SettingsCategory&&) noexcept;
SettingsCategory& operator=(SettingsCategory&&) noexcept;
std::string name() const;
[[nodiscard]] std::string name() const;
/**
* Gets the signal invoked when a variable within the category is changed.
@ -46,7 +46,7 @@ public:
* @return true if all settings variables are currently set to default
* values, otherwise false.
*/
bool IsDefault() const;
[[nodiscard]] bool IsDefault() const;
/**
* Gets whether or not all settings variables currently have staged values
@ -55,7 +55,7 @@ public:
* @return true if all settings variables currently have staged values set
* to default, otherwise false.
*/
bool IsDefaultStaged() const;
[[nodiscard]] bool IsDefaultStaged() const;
/**
* Set all variables to their defaults.

3
scwx-qt/source/scwx/qt/settings/settings_container.hpp
View file

@ -88,7 +88,8 @@ public:
void SetElementValidator(std::function<bool(const T&)> validator);
protected:
virtual bool Equals(const SettingsVariableBase& o) const override;
[[nodiscard]] virtual bool
Equals(const SettingsVariableBase& o) const override;
private:
class Impl;

3
scwx-qt/source/scwx/qt/settings/settings_variable.hpp
View file

@ -246,7 +246,8 @@ public:
void UnregisterValueStagedCallback(boost::uuids::uuid uuid);
protected:
virtual bool Equals(const SettingsVariableBase& o) const override;
[[nodiscard]] virtual bool
Equals(const SettingsVariableBase& o) const override;
private:
class Impl;

8
scwx-qt/source/scwx/qt/settings/settings_variable_base.hpp
View file

@ -25,7 +25,7 @@ public:
SettingsVariableBase(SettingsVariableBase&&) noexcept;
SettingsVariableBase& operator=(SettingsVariableBase&&) noexcept;
std::string name() const;
[[nodiscard]] std::string name() const;
/**
* Gets the signal invoked when the settings variable is changed.
@ -48,7 +48,7 @@ public:
* @return true if the settings variable is currently set to its default
* value, otherwise false.
*/
virtual bool IsDefault() const = 0;
[[nodiscard]] virtual bool IsDefault() const = 0;
/**
* Gets whether or not the settings variable currently has its staged value
@ -57,7 +57,7 @@ public:
* @return true if the settings variable currently has its staged value set
* to default, otherwise false.
*/
virtual bool IsDefaultStaged() const = 0;
[[nodiscard]] virtual bool IsDefaultStaged() const = 0;
/**
* Sets the current value of the settings variable to default.
@ -103,7 +103,7 @@ public:
protected:
friend bool operator==(const SettingsVariableBase& lhs,
const SettingsVariableBase& rhs);
virtual bool Equals(const SettingsVariableBase& o) const;
[[nodiscard]] virtual bool Equals(const SettingsVariableBase& o) const;
private:
class Impl;

15
scwx-qt/source/scwx/qt/settings/text_settings.hpp
View file

@ -22,17 +22,18 @@ public:
TextSettings(TextSettings&&) noexcept;
TextSettings& operator=(TextSettings&&) noexcept;
SettingsVariable<std::string>&
[[nodiscard]] SettingsVariable<std::string>&
font_family(types::FontCategory fontCategory) const;
SettingsVariable<std::string>&
[[nodiscard]] SettingsVariable<std::string>&
font_style(types::FontCategory fontCategory) const;
SettingsVariable<double>&
[[nodiscard]] SettingsVariable<double>&
font_point_size(types::FontCategory fontCategory) const;
SettingsVariable<std::int64_t>& hover_text_wrap() const;
SettingsVariable<bool>& placefile_text_drop_shadow_enabled() const;
SettingsVariable<bool>& radar_site_hover_text_enabled() const;
SettingsVariable<std::string>& tooltip_method() const;
[[nodiscard]] SettingsVariable<std::int64_t>& hover_text_wrap() const;
[[nodiscard]] SettingsVariable<bool>&
placefile_text_drop_shadow_enabled() const;
[[nodiscard]] SettingsVariable<bool>& radar_site_hover_text_enabled() const;
[[nodiscard]] SettingsVariable<std::string>& tooltip_method() const;
static TextSettings& Instance();

14
scwx-qt/source/scwx/qt/settings/ui_settings.hpp
View file

@ -23,13 +23,13 @@ public:
UiSettings(UiSettings&&) noexcept;
UiSettings& operator=(UiSettings&&) noexcept;
SettingsVariable<bool>& level2_products_expanded() const;
SettingsVariable<bool>& level2_settings_expanded() const;
SettingsVariable<bool>& level3_products_expanded() const;
SettingsVariable<bool>& map_settings_expanded() const;
SettingsVariable<bool>& timeline_expanded() const;
SettingsVariable<std::string>& main_ui_state() const;
SettingsVariable<std::string>& main_ui_geometry() const;
[[nodiscard]] SettingsVariable<bool>& level2_products_expanded() const;
[[nodiscard]] SettingsVariable<bool>& level2_settings_expanded() const;
[[nodiscard]] SettingsVariable<bool>& level3_products_expanded() const;
[[nodiscard]] SettingsVariable<bool>& map_settings_expanded() const;
[[nodiscard]] SettingsVariable<bool>& timeline_expanded() const;
[[nodiscard]] SettingsVariable<std::string>& main_ui_state() const;
[[nodiscard]] SettingsVariable<std::string>& main_ui_geometry() const;
bool Shutdown();

10
scwx-qt/source/scwx/qt/settings/unit_settings.hpp
View file

@ -21,11 +21,11 @@ public:
UnitSettings(UnitSettings&&) noexcept;
UnitSettings& operator=(UnitSettings&&) noexcept;
SettingsVariable<std::string>& accumulation_units() const;
SettingsVariable<std::string>& echo_tops_units() const;
SettingsVariable<std::string>& other_units() const;
SettingsVariable<std::string>& speed_units() const;
SettingsVariable<std::string>& distance_units() const;
[[nodiscard]] SettingsVariable<std::string>& accumulation_units() const;
[[nodiscard]] SettingsVariable<std::string>& echo_tops_units() const;
[[nodiscard]] SettingsVariable<std::string>& other_units() const;
[[nodiscard]] SettingsVariable<std::string>& speed_units() const;
[[nodiscard]] SettingsVariable<std::string>& distance_units() const;
static UnitSettings& Instance();