From 36339e613f333b1e56767aecbefbe96e69fda4a9 Mon Sep 17 00:00:00 2001 From: AdenKoperczak Date: Wed, 29 Jan 2025 10:06:46 -0500 Subject: [PATCH] Add [[nodiscard]] to functions which need it in settings files --- .../qt/settings/alert_palette_settings.hpp | 8 +-- .../scwx/qt/settings/audio_settings.hpp | 21 +++--- .../scwx/qt/settings/general_settings.hpp | 66 ++++++++++--------- .../scwx/qt/settings/hotkey_settings.hpp | 3 +- .../source/scwx/qt/settings/line_settings.hpp | 18 ++--- .../source/scwx/qt/settings/map_settings.hpp | 2 +- .../scwx/qt/settings/palette_settings.hpp | 7 +- .../scwx/qt/settings/settings_category.hpp | 6 +- .../scwx/qt/settings/settings_container.hpp | 3 +- .../scwx/qt/settings/settings_variable.hpp | 3 +- .../qt/settings/settings_variable_base.hpp | 8 +-- .../source/scwx/qt/settings/text_settings.hpp | 15 +++-- .../source/scwx/qt/settings/ui_settings.hpp | 14 ++-- .../source/scwx/qt/settings/unit_settings.hpp | 10 +-- 14 files changed, 96 insertions(+), 88 deletions(-) diff --git a/scwx-qt/source/scwx/qt/settings/alert_palette_settings.hpp b/scwx-qt/source/scwx/qt/settings/alert_palette_settings.hpp index 0741654a..ec77d060 100644 --- a/scwx-qt/source/scwx/qt/settings/alert_palette_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/alert_palette_settings.hpp @@ -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); diff --git a/scwx-qt/source/scwx/qt/settings/audio_settings.hpp b/scwx-qt/source/scwx/qt/settings/audio_settings.hpp index 539fde8a..c6e6befd 100644 --- a/scwx-qt/source/scwx/qt/settings/audio_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/audio_settings.hpp @@ -22,16 +22,17 @@ public: AudioSettings(AudioSettings&&) noexcept; AudioSettings& operator=(AudioSettings&&) noexcept; - SettingsVariable& alert_sound_file() const; - SettingsVariable& alert_location_method() const; - SettingsVariable& alert_latitude() const; - SettingsVariable& alert_longitude() const; - SettingsVariable& alert_radius() const; - SettingsVariable& alert_radar_site() const; - SettingsVariable& alert_county() const; - SettingsVariable& alert_wfo() const; - SettingsVariable& alert_enabled(awips::Phenomenon phenomenon) const; - SettingsVariable& ignore_missing_codecs() const; + [[nodiscard]] SettingsVariable& alert_sound_file() const; + [[nodiscard]] SettingsVariable& alert_location_method() const; + [[nodiscard]] SettingsVariable& alert_latitude() const; + [[nodiscard]] SettingsVariable& alert_longitude() const; + [[nodiscard]] SettingsVariable& alert_radius() const; + [[nodiscard]] SettingsVariable& alert_radar_site() const; + [[nodiscard]] SettingsVariable& alert_county() const; + [[nodiscard]] SettingsVariable& alert_wfo() const; + [[nodiscard]] SettingsVariable& + alert_enabled(awips::Phenomenon phenomenon) const; + [[nodiscard]] SettingsVariable& ignore_missing_codecs() const; static AudioSettings& Instance(); diff --git a/scwx-qt/source/scwx/qt/settings/general_settings.hpp b/scwx-qt/source/scwx/qt/settings/general_settings.hpp index 19938adf..8e890ce3 100644 --- a/scwx-qt/source/scwx/qt/settings/general_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/general_settings.hpp @@ -21,38 +21,40 @@ public: GeneralSettings(GeneralSettings&&) noexcept; GeneralSettings& operator=(GeneralSettings&&) noexcept; - SettingsVariable& anti_aliasing_enabled() const; - SettingsVariable& clock_format() const; - SettingsVariable& custom_style_draw_layer() const; - SettingsVariable& custom_style_url() const; - SettingsVariable& debug_enabled() const; - SettingsVariable& default_alert_action() const; - SettingsVariable& default_radar_site() const; - SettingsVariable& default_time_zone() const; - SettingsContainer>& font_sizes() const; - SettingsVariable& grid_height() const; - SettingsVariable& grid_width() const; - SettingsVariable& loop_delay() const; - SettingsVariable& loop_speed() const; - SettingsVariable& loop_time() const; - SettingsVariable& map_provider() const; - SettingsVariable& mapbox_api_key() const; - SettingsVariable& maptiler_api_key() const; - SettingsVariable& nmea_baud_rate() const; - SettingsVariable& nmea_source() const; - SettingsVariable& positioning_plugin() const; - SettingsVariable& process_module_warnings_enabled() const; - SettingsVariable& show_map_attribution() const; - SettingsVariable& show_map_center() const; - SettingsVariable& show_map_logo() const; - SettingsVariable& theme() const; - SettingsVariable& theme_file() const; - SettingsVariable& track_location() const; - SettingsVariable& update_notifications_enabled() const; - SettingsVariable& warnings_provider() const; - SettingsVariable& cursor_icon_always_on() const; - SettingsVariable& radar_site_threshold() const; - SettingsVariable& high_privilege_warning_enabled() const; + [[nodiscard]] SettingsVariable& anti_aliasing_enabled() const; + [[nodiscard]] SettingsVariable& clock_format() const; + [[nodiscard]] SettingsVariable& custom_style_draw_layer() const; + [[nodiscard]] SettingsVariable& custom_style_url() const; + [[nodiscard]] SettingsVariable& debug_enabled() const; + [[nodiscard]] SettingsVariable& default_alert_action() const; + [[nodiscard]] SettingsVariable& default_radar_site() const; + [[nodiscard]] SettingsVariable& default_time_zone() const; + [[nodiscard]] SettingsContainer>& + font_sizes() const; + [[nodiscard]] SettingsVariable& grid_height() const; + [[nodiscard]] SettingsVariable& grid_width() const; + [[nodiscard]] SettingsVariable& loop_delay() const; + [[nodiscard]] SettingsVariable& loop_speed() const; + [[nodiscard]] SettingsVariable& loop_time() const; + [[nodiscard]] SettingsVariable& map_provider() const; + [[nodiscard]] SettingsVariable& mapbox_api_key() const; + [[nodiscard]] SettingsVariable& maptiler_api_key() const; + [[nodiscard]] SettingsVariable& nmea_baud_rate() const; + [[nodiscard]] SettingsVariable& nmea_source() const; + [[nodiscard]] SettingsVariable& positioning_plugin() const; + [[nodiscard]] SettingsVariable& + process_module_warnings_enabled() const; + [[nodiscard]] SettingsVariable& show_map_attribution() const; + [[nodiscard]] SettingsVariable& show_map_center() const; + [[nodiscard]] SettingsVariable& show_map_logo() const; + [[nodiscard]] SettingsVariable& theme() const; + [[nodiscard]] SettingsVariable& theme_file() const; + [[nodiscard]] SettingsVariable& track_location() const; + [[nodiscard]] SettingsVariable& update_notifications_enabled() const; + [[nodiscard]] SettingsVariable& warnings_provider() const; + [[nodiscard]] SettingsVariable& cursor_icon_always_on() const; + [[nodiscard]] SettingsVariable& radar_site_threshold() const; + [[nodiscard]] SettingsVariable& high_privilege_warning_enabled() const; static GeneralSettings& Instance(); diff --git a/scwx-qt/source/scwx/qt/settings/hotkey_settings.hpp b/scwx-qt/source/scwx/qt/settings/hotkey_settings.hpp index f7b8a3cd..02371f59 100644 --- a/scwx-qt/source/scwx/qt/settings/hotkey_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/hotkey_settings.hpp @@ -22,7 +22,8 @@ public: HotkeySettings(HotkeySettings&&) noexcept; HotkeySettings& operator=(HotkeySettings&&) noexcept; - SettingsVariable& hotkey(scwx::qt::types::Hotkey hotkey) const; + [[nodiscard]] SettingsVariable& + hotkey(scwx::qt::types::Hotkey hotkey) const; static HotkeySettings& Instance(); diff --git a/scwx-qt/source/scwx/qt/settings/line_settings.hpp b/scwx-qt/source/scwx/qt/settings/line_settings.hpp index 28f82ccb..53d11681 100644 --- a/scwx-qt/source/scwx/qt/settings/line_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/line_settings.hpp @@ -23,17 +23,17 @@ public: LineSettings(LineSettings&&) noexcept; LineSettings& operator=(LineSettings&&) noexcept; - SettingsVariable& border_color() const; - SettingsVariable& highlight_color() const; - SettingsVariable& line_color() const; + [[nodiscard]] SettingsVariable& border_color() const; + [[nodiscard]] SettingsVariable& highlight_color() const; + [[nodiscard]] SettingsVariable& line_color() const; - SettingsVariable& border_width() const; - SettingsVariable& highlight_width() const; - SettingsVariable& line_width() const; + [[nodiscard]] SettingsVariable& border_width() const; + [[nodiscard]] SettingsVariable& highlight_width() const; + [[nodiscard]] SettingsVariable& 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, diff --git a/scwx-qt/source/scwx/qt/settings/map_settings.hpp b/scwx-qt/source/scwx/qt/settings/map_settings.hpp index 31956326..72eeac88 100644 --- a/scwx-qt/source/scwx/qt/settings/map_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/map_settings.hpp @@ -21,7 +21,7 @@ public: MapSettings(MapSettings&&) noexcept; MapSettings& operator=(MapSettings&&) noexcept; - std::size_t count() const; + [[nodiscard]] std::size_t count() const; SettingsVariable& map_style(std::size_t i); SettingsVariable& radar_site(std::size_t i); SettingsVariable& radar_product_group(std::size_t i); diff --git a/scwx-qt/source/scwx/qt/settings/palette_settings.hpp b/scwx-qt/source/scwx/qt/settings/palette_settings.hpp index 961b17d5..3c46f29a 100644 --- a/scwx-qt/source/scwx/qt/settings/palette_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/palette_settings.hpp @@ -24,9 +24,10 @@ public: PaletteSettings(PaletteSettings&&) noexcept; PaletteSettings& operator=(PaletteSettings&&) noexcept; - SettingsVariable& palette(const std::string& name) const; - SettingsVariable& alert_color(awips::Phenomenon phenomenon, - bool active) const; + [[nodiscard]] SettingsVariable& + palette(const std::string& name) const; + [[nodiscard]] SettingsVariable& + alert_color(awips::Phenomenon phenomenon, bool active) const; AlertPaletteSettings& alert_palette(awips::Phenomenon); static const std::vector& alert_phenomena(); diff --git a/scwx-qt/source/scwx/qt/settings/settings_category.hpp b/scwx-qt/source/scwx/qt/settings/settings_category.hpp index e5935636..c47bfdeb 100644 --- a/scwx-qt/source/scwx/qt/settings/settings_category.hpp +++ b/scwx-qt/source/scwx/qt/settings/settings_category.hpp @@ -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. diff --git a/scwx-qt/source/scwx/qt/settings/settings_container.hpp b/scwx-qt/source/scwx/qt/settings/settings_container.hpp index 1f57e0b3..0e378a81 100644 --- a/scwx-qt/source/scwx/qt/settings/settings_container.hpp +++ b/scwx-qt/source/scwx/qt/settings/settings_container.hpp @@ -88,7 +88,8 @@ public: void SetElementValidator(std::function validator); protected: - virtual bool Equals(const SettingsVariableBase& o) const override; + [[nodiscard]] virtual bool + Equals(const SettingsVariableBase& o) const override; private: class Impl; diff --git a/scwx-qt/source/scwx/qt/settings/settings_variable.hpp b/scwx-qt/source/scwx/qt/settings/settings_variable.hpp index 612f57e7..3fc0b81d 100644 --- a/scwx-qt/source/scwx/qt/settings/settings_variable.hpp +++ b/scwx-qt/source/scwx/qt/settings/settings_variable.hpp @@ -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; diff --git a/scwx-qt/source/scwx/qt/settings/settings_variable_base.hpp b/scwx-qt/source/scwx/qt/settings/settings_variable_base.hpp index 870a0c9d..d613da91 100644 --- a/scwx-qt/source/scwx/qt/settings/settings_variable_base.hpp +++ b/scwx-qt/source/scwx/qt/settings/settings_variable_base.hpp @@ -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; diff --git a/scwx-qt/source/scwx/qt/settings/text_settings.hpp b/scwx-qt/source/scwx/qt/settings/text_settings.hpp index c4cc64af..cbc96f4f 100644 --- a/scwx-qt/source/scwx/qt/settings/text_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/text_settings.hpp @@ -22,17 +22,18 @@ public: TextSettings(TextSettings&&) noexcept; TextSettings& operator=(TextSettings&&) noexcept; - SettingsVariable& + [[nodiscard]] SettingsVariable& font_family(types::FontCategory fontCategory) const; - SettingsVariable& + [[nodiscard]] SettingsVariable& font_style(types::FontCategory fontCategory) const; - SettingsVariable& + [[nodiscard]] SettingsVariable& font_point_size(types::FontCategory fontCategory) const; - SettingsVariable& hover_text_wrap() const; - SettingsVariable& placefile_text_drop_shadow_enabled() const; - SettingsVariable& radar_site_hover_text_enabled() const; - SettingsVariable& tooltip_method() const; + [[nodiscard]] SettingsVariable& hover_text_wrap() const; + [[nodiscard]] SettingsVariable& + placefile_text_drop_shadow_enabled() const; + [[nodiscard]] SettingsVariable& radar_site_hover_text_enabled() const; + [[nodiscard]] SettingsVariable& tooltip_method() const; static TextSettings& Instance(); diff --git a/scwx-qt/source/scwx/qt/settings/ui_settings.hpp b/scwx-qt/source/scwx/qt/settings/ui_settings.hpp index e052eb90..b5ffd745 100644 --- a/scwx-qt/source/scwx/qt/settings/ui_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/ui_settings.hpp @@ -23,13 +23,13 @@ public: UiSettings(UiSettings&&) noexcept; UiSettings& operator=(UiSettings&&) noexcept; - SettingsVariable& level2_products_expanded() const; - SettingsVariable& level2_settings_expanded() const; - SettingsVariable& level3_products_expanded() const; - SettingsVariable& map_settings_expanded() const; - SettingsVariable& timeline_expanded() const; - SettingsVariable& main_ui_state() const; - SettingsVariable& main_ui_geometry() const; + [[nodiscard]] SettingsVariable& level2_products_expanded() const; + [[nodiscard]] SettingsVariable& level2_settings_expanded() const; + [[nodiscard]] SettingsVariable& level3_products_expanded() const; + [[nodiscard]] SettingsVariable& map_settings_expanded() const; + [[nodiscard]] SettingsVariable& timeline_expanded() const; + [[nodiscard]] SettingsVariable& main_ui_state() const; + [[nodiscard]] SettingsVariable& main_ui_geometry() const; bool Shutdown(); diff --git a/scwx-qt/source/scwx/qt/settings/unit_settings.hpp b/scwx-qt/source/scwx/qt/settings/unit_settings.hpp index 403e2b9c..44be2f73 100644 --- a/scwx-qt/source/scwx/qt/settings/unit_settings.hpp +++ b/scwx-qt/source/scwx/qt/settings/unit_settings.hpp @@ -21,11 +21,11 @@ public: UnitSettings(UnitSettings&&) noexcept; UnitSettings& operator=(UnitSettings&&) noexcept; - SettingsVariable& accumulation_units() const; - SettingsVariable& echo_tops_units() const; - SettingsVariable& other_units() const; - SettingsVariable& speed_units() const; - SettingsVariable& distance_units() const; + [[nodiscard]] SettingsVariable& accumulation_units() const; + [[nodiscard]] SettingsVariable& echo_tops_units() const; + [[nodiscard]] SettingsVariable& other_units() const; + [[nodiscard]] SettingsVariable& speed_units() const; + [[nodiscard]] SettingsVariable& distance_units() const; static UnitSettings& Instance();