Use X-macros to simplify new setting creation in SettingsModel (#11416)

Introduces X-macros to reduce the number of places we need to write essentially the same line of code but for a different setting (declaring it in the header file, in `Copy`, `LayerJson`, `ToJson`, etc).
microsoft · Nov 3, 2021 · 726b428 · 726b428
1 parent 27e042b
commit 726b428
Show file tree

Hide file tree

Showing 11 changed files with 190 additions and 378 deletions.
diff --git a/src/cascadia/TerminalSettingsModel/AppearanceConfig.cpp b/src/cascadia/TerminalSettingsModel/AppearanceConfig.cpp
@@ -16,17 +16,6 @@ static constexpr std::string_view ForegroundKey{ "foreground" };
 static constexpr std::string_view BackgroundKey{ "background" };
 static constexpr std::string_view SelectionBackgroundKey{ "selectionBackground" };
 static constexpr std::string_view CursorColorKey{ "cursorColor" };
-static constexpr std::string_view CursorShapeKey{ "cursorShape" };
-static constexpr std::string_view CursorHeightKey{ "cursorHeight" };
-static constexpr std::string_view BackgroundImageKey{ "backgroundImage" };
-static constexpr std::string_view ColorSchemeKey{ "colorScheme" };
-static constexpr std::string_view BackgroundImageOpacityKey{ "backgroundImageOpacity" };
-static constexpr std::string_view BackgroundImageStretchModeKey{ "backgroundImageStretchMode" };
-static constexpr std::string_view BackgroundImageAlignmentKey{ "backgroundImageAlignment" };
-static constexpr std::string_view RetroTerminalEffectKey{ "experimental.retroTerminalEffect" };
-static constexpr std::string_view PixelShaderPathKey{ "experimental.pixelShaderPath" };
-static constexpr std::string_view IntenseTextStyleKey{ "intenseTextStyle" };
-static constexpr std::string_view AdjustIndistinguishableColorsKey{ "adjustIndistinguishableColors" };
 static constexpr std::string_view LegacyAcrylicTransparencyKey{ "acrylicOpacity" };
 static constexpr std::string_view OpacityKey{ "opacity" };
 
@@ -38,22 +27,17 @@ AppearanceConfig::AppearanceConfig(winrt::weak_ref<Profile> sourceProfile) :
 winrt::com_ptr<AppearanceConfig> AppearanceConfig::CopyAppearance(const AppearanceConfig* source, winrt::weak_ref<Profile> sourceProfile)
 {
     auto appearance{ winrt::make_self<AppearanceConfig>(std::move(sourceProfile)) };
-    appearance->_BackgroundImagePath = source->_BackgroundImagePath;
-    appearance->_BackgroundImageOpacity = source->_BackgroundImageOpacity;
-    appearance->_BackgroundImageStretchMode = source->_BackgroundImageStretchMode;
-    appearance->_ColorSchemeName = source->_ColorSchemeName;
     appearance->_Foreground = source->_Foreground;
     appearance->_Background = source->_Background;
     appearance->_SelectionBackground = source->_SelectionBackground;
     appearance->_CursorColor = source->_CursorColor;
-    appearance->_CursorShape = source->_CursorShape;
-    appearance->_CursorHeight = source->_CursorHeight;
-    appearance->_BackgroundImageAlignment = source->_BackgroundImageAlignment;
-    appearance->_RetroTerminalEffect = source->_RetroTerminalEffect;
-    appearance->_PixelShaderPath = source->_PixelShaderPath;
-    appearance->_IntenseTextStyle = source->_IntenseTextStyle;
     appearance->_Opacity = source->_Opacity;
-    appearance->_AdjustIndistinguishableColors = source->_AdjustIndistinguishableColors;
+
+#define APPEARANCE_SETTINGS_COPY(type, name, jsonKey, ...) \
+    appearance->_##name = source->_##name;
+    MTSM_APPEARANCE_SETTINGS(APPEARANCE_SETTINGS_COPY)
+#undef APPEARANCE_SETTINGS_COPY
+
     return appearance;
 }
 
@@ -65,19 +49,13 @@ Json::Value AppearanceConfig::ToJson() const
     JsonUtils::SetValueForKey(json, BackgroundKey, _Background);
     JsonUtils::SetValueForKey(json, SelectionBackgroundKey, _SelectionBackground);
     JsonUtils::SetValueForKey(json, CursorColorKey, _CursorColor);
-    JsonUtils::SetValueForKey(json, ColorSchemeKey, _ColorSchemeName);
-    JsonUtils::SetValueForKey(json, CursorHeightKey, _CursorHeight);
-    JsonUtils::SetValueForKey(json, CursorShapeKey, _CursorShape);
-    JsonUtils::SetValueForKey(json, BackgroundImageKey, _BackgroundImagePath);
-    JsonUtils::SetValueForKey(json, BackgroundImageOpacityKey, _BackgroundImageOpacity);
-    JsonUtils::SetValueForKey(json, BackgroundImageStretchModeKey, _BackgroundImageStretchMode);
-    JsonUtils::SetValueForKey(json, BackgroundImageAlignmentKey, _BackgroundImageAlignment);
-    JsonUtils::SetValueForKey(json, RetroTerminalEffectKey, _RetroTerminalEffect);
-    JsonUtils::SetValueForKey(json, PixelShaderPathKey, _PixelShaderPath);
-    JsonUtils::SetValueForKey(json, IntenseTextStyleKey, _IntenseTextStyle);
-    JsonUtils::SetValueForKey(json, AdjustIndistinguishableColorsKey, _AdjustIndistinguishableColors);
     JsonUtils::SetValueForKey(json, OpacityKey, _Opacity, JsonUtils::OptionalConverter<double, IntAsFloatPercentConversionTrait>{});
 
+#define APPEARANCE_SETTINGS_TO_JSON(type, name, jsonKey, ...) \
+    JsonUtils::SetValueForKey(json, jsonKey, _##name);
+    MTSM_APPEARANCE_SETTINGS(APPEARANCE_SETTINGS_TO_JSON)
+#undef APPEARANCE_SETTINGS_TO_JSON
+
     return json;
 }
 
@@ -98,19 +76,14 @@ void AppearanceConfig::LayerJson(const Json::Value& json)
     JsonUtils::GetValueForKey(json, BackgroundKey, _Background);
     JsonUtils::GetValueForKey(json, SelectionBackgroundKey, _SelectionBackground);
     JsonUtils::GetValueForKey(json, CursorColorKey, _CursorColor);
-    JsonUtils::GetValueForKey(json, CursorHeightKey, _CursorHeight);
-    JsonUtils::GetValueForKey(json, ColorSchemeKey, _ColorSchemeName);
-    JsonUtils::GetValueForKey(json, CursorShapeKey, _CursorShape);
-    JsonUtils::GetValueForKey(json, BackgroundImageKey, _BackgroundImagePath);
-    JsonUtils::GetValueForKey(json, BackgroundImageOpacityKey, _BackgroundImageOpacity);
-    JsonUtils::GetValueForKey(json, BackgroundImageStretchModeKey, _BackgroundImageStretchMode);
-    JsonUtils::GetValueForKey(json, BackgroundImageAlignmentKey, _BackgroundImageAlignment);
-    JsonUtils::GetValueForKey(json, RetroTerminalEffectKey, _RetroTerminalEffect);
-    JsonUtils::GetValueForKey(json, PixelShaderPathKey, _PixelShaderPath);
-    JsonUtils::GetValueForKey(json, IntenseTextStyleKey, _IntenseTextStyle);
-    JsonUtils::GetValueForKey(json, AdjustIndistinguishableColorsKey, _AdjustIndistinguishableColors);
+
     JsonUtils::GetValueForKey(json, LegacyAcrylicTransparencyKey, _Opacity);
     JsonUtils::GetValueForKey(json, OpacityKey, _Opacity, JsonUtils::OptionalConverter<double, IntAsFloatPercentConversionTrait>{});
+
+#define APPEARANCE_SETTINGS_LAYER_JSON(type, name, jsonKey, ...) \
+    JsonUtils::GetValueForKey(json, jsonKey, _##name);
+    MTSM_APPEARANCE_SETTINGS(APPEARANCE_SETTINGS_LAYER_JSON)
+#undef APPEARANCE_SETTINGS_LAYER_JSON
 }
 
 winrt::Microsoft::Terminal::Settings::Model::Profile AppearanceConfig::SourceProfile()

diff --git a/src/cascadia/TerminalSettingsModel/AppearanceConfig.h b/src/cascadia/TerminalSettingsModel/AppearanceConfig.h
@@ -19,6 +19,7 @@ Author(s):
 #include "AppearanceConfig.g.h"
 #include "JsonUtils.h"
 #include "IInheritable.h"
+#include "MTSMSettings.h"
 #include <DefaultSettings.h>
 
 namespace winrt::Microsoft::Terminal::Settings::Model::implementation
@@ -35,26 +36,16 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
         winrt::hstring ExpandedBackgroundImagePath();
 
-        INHERITABLE_SETTING(Model::IAppearanceConfig, ConvergedAlignment, BackgroundImageAlignment, ConvergedAlignment::Horizontal_Center | ConvergedAlignment::Vertical_Center);
-
-        INHERITABLE_SETTING(Model::IAppearanceConfig, uint32_t, CursorHeight, DEFAULT_CURSOR_HEIGHT);
-        INHERITABLE_SETTING(Model::IAppearanceConfig, hstring, ColorSchemeName, L"Campbell");
         INHERITABLE_NULLABLE_SETTING(Model::IAppearanceConfig, Microsoft::Terminal::Core::Color, Foreground, nullptr);
         INHERITABLE_NULLABLE_SETTING(Model::IAppearanceConfig, Microsoft::Terminal::Core::Color, Background, nullptr);
         INHERITABLE_NULLABLE_SETTING(Model::IAppearanceConfig, Microsoft::Terminal::Core::Color, SelectionBackground, nullptr);
         INHERITABLE_NULLABLE_SETTING(Model::IAppearanceConfig, Microsoft::Terminal::Core::Color, CursorColor, nullptr);
-        INHERITABLE_SETTING(Model::IAppearanceConfig, Microsoft::Terminal::Core::CursorStyle, CursorShape, Microsoft::Terminal::Core::CursorStyle::Bar);
-        INHERITABLE_SETTING(Model::IAppearanceConfig, hstring, BackgroundImagePath);
-
-        INHERITABLE_SETTING(Model::IAppearanceConfig, double, BackgroundImageOpacity, 1.0);
-        INHERITABLE_SETTING(Model::IAppearanceConfig, Windows::UI::Xaml::Media::Stretch, BackgroundImageStretchMode, Windows::UI::Xaml::Media::Stretch::UniformToFill);
-
-        INHERITABLE_SETTING(Model::IAppearanceConfig, bool, RetroTerminalEffect, false);
-        INHERITABLE_SETTING(Model::IAppearanceConfig, hstring, PixelShaderPath, L"");
-        INHERITABLE_SETTING(Model::IAppearanceConfig, Model::IntenseStyle, IntenseTextStyle, Model::IntenseStyle::Bright);
         INHERITABLE_SETTING(Model::IAppearanceConfig, double, Opacity, 1.0);
 
-        INHERITABLE_SETTING(Model::IAppearanceConfig, bool, AdjustIndistinguishableColors, true);
+#define APPEARANCE_SETTINGS_INITIALIZE(type, name, jsonKey, ...) \
+    INHERITABLE_SETTING(Model::IAppearanceConfig, type, name, ##__VA_ARGS__)
+        MTSM_APPEARANCE_SETTINGS(APPEARANCE_SETTINGS_INITIALIZE)
+#undef APPEARANCE_SETTINGS_INITIALIZE
 
     private:
         winrt::weak_ref<Profile> _sourceProfile;

diff --git a/src/cascadia/TerminalSettingsModel/FontConfig.cpp b/src/cascadia/TerminalSettingsModel/FontConfig.cpp
@@ -12,11 +12,6 @@ using namespace Microsoft::Terminal::Settings::Model;
 using namespace winrt::Microsoft::Terminal::Settings::Model::implementation;
 
 static constexpr std::string_view FontInfoKey{ "font" };
-static constexpr std::string_view FontFaceKey{ "face" };
-static constexpr std::string_view FontSizeKey{ "size" };
-static constexpr std::string_view FontWeightKey{ "weight" };
-static constexpr std::string_view FontFeaturesKey{ "features" };
-static constexpr std::string_view FontAxesKey{ "axes" };
 static constexpr std::string_view LegacyFontFaceKey{ "fontFace" };
 static constexpr std::string_view LegacyFontSizeKey{ "fontSize" };
 static constexpr std::string_view LegacyFontWeightKey{ "fontWeight" };
@@ -29,23 +24,23 @@ winrt::Microsoft::Terminal::Settings::Model::implementation::FontConfig::FontCon
 winrt::com_ptr<FontConfig> FontConfig::CopyFontInfo(const FontConfig* source, winrt::weak_ref<Profile> sourceProfile)
 {
     auto fontInfo{ winrt::make_self<FontConfig>(std::move(sourceProfile)) };
-    fontInfo->_FontFace = source->_FontFace;
-    fontInfo->_FontSize = source->_FontSize;
-    fontInfo->_FontWeight = source->_FontWeight;
-    fontInfo->_FontAxes = source->_FontAxes;
-    fontInfo->_FontFeatures = source->_FontFeatures;
+
+#define FONT_SETTINGS_COPY(type, name, jsonKey, ...) \
+    fontInfo->_##name = source->_##name;
+    MTSM_FONT_SETTINGS(FONT_SETTINGS_COPY)
+#undef FONT_SETTINGS_COPY
+
     return fontInfo;
 }
 
 Json::Value FontConfig::ToJson() const
 {
     Json::Value json{ Json::ValueType::objectValue };
 
-    JsonUtils::SetValueForKey(json, FontFaceKey, _FontFace);
-    JsonUtils::SetValueForKey(json, FontSizeKey, _FontSize);
-    JsonUtils::SetValueForKey(json, FontWeightKey, _FontWeight);
-    JsonUtils::SetValueForKey(json, FontAxesKey, _FontAxes);
-    JsonUtils::SetValueForKey(json, FontFeaturesKey, _FontFeatures);
+#define FONT_SETTINGS_TO_JSON(type, name, jsonKey, ...) \
+    JsonUtils::SetValueForKey(json, jsonKey, _##name);
+    MTSM_FONT_SETTINGS(FONT_SETTINGS_TO_JSON)
+#undef FONT_SETTINGS_TO_JSON
 
     return json;
 }
@@ -69,11 +64,10 @@ void FontConfig::LayerJson(const Json::Value& json)
     {
         // A font object is defined, use that
         const auto fontInfoJson = json[JsonKey(FontInfoKey)];
-        JsonUtils::GetValueForKey(fontInfoJson, FontFaceKey, _FontFace);
-        JsonUtils::GetValueForKey(fontInfoJson, FontSizeKey, _FontSize);
-        JsonUtils::GetValueForKey(fontInfoJson, FontWeightKey, _FontWeight);
-        JsonUtils::GetValueForKey(fontInfoJson, FontFeaturesKey, _FontFeatures);
-        JsonUtils::GetValueForKey(fontInfoJson, FontAxesKey, _FontAxes);
+#define FONT_SETTINGS_LAYER_JSON(type, name, jsonKey, ...) \
+    JsonUtils::GetValueForKey(fontInfoJson, jsonKey, _##name);
+        MTSM_FONT_SETTINGS(FONT_SETTINGS_LAYER_JSON)
+#undef FONT_SETTINGS_LAYER_JSON
     }
     else
     {

diff --git a/src/cascadia/TerminalSettingsModel/FontConfig.h b/src/cascadia/TerminalSettingsModel/FontConfig.h
@@ -19,6 +19,7 @@ Author(s):
 #include "pch.h"
 #include "FontConfig.g.h"
 #include "JsonUtils.h"
+#include "MTSMSettings.h"
 #include "../inc/cppwinrt_utils.h"
 #include "IInheritable.h"
 #include <DefaultSettings.h>
@@ -39,11 +40,10 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
         Model::Profile SourceProfile();
 
-        INHERITABLE_SETTING(Model::FontConfig, hstring, FontFace, DEFAULT_FONT_FACE);
-        INHERITABLE_SETTING(Model::FontConfig, int32_t, FontSize, DEFAULT_FONT_SIZE);
-        INHERITABLE_SETTING(Model::FontConfig, Windows::UI::Text::FontWeight, FontWeight, DEFAULT_FONT_WEIGHT);
-        INHERITABLE_SETTING(Model::FontConfig, IFontAxesMap, FontAxes);
-        INHERITABLE_SETTING(Model::FontConfig, IFontFeatureMap, FontFeatures);
+#define FONT_SETTINGS_INITIALIZE(type, name, jsonKey, ...) \
+    INHERITABLE_SETTING(Model::FontConfig, type, name, ##__VA_ARGS__)
+        MTSM_FONT_SETTINGS(FONT_SETTINGS_INITIALIZE)
+#undef FONT_SETTINGS_INITIALIZE
 
     private:
         winrt::weak_ref<Profile> _sourceProfile;