Enable setting an initial position and maximization launch for Terminal

src/cascadia/TerminalApp/App.cpp

@@ -342,6 +342,60 @@ namespace winrt::TerminalApp::implementation
         return TermControl::GetProposedDimensions(settings, dpi);
     }
 
+    // Method Description:
+    // - Get the launch mode in json settings file. Now there
+    //   two launch mode: default, maximized. Default means the window
+    //   will launch according to the launch dimensions provided. Maximized
+    //   means the window will launch as a maximized window
+    // Arguments:
+    // - <none>
+    // Return Value:
+    // - LaunchMode enum that indicates the launch mode
+    LaunchMode App::GetLaunchMode()
+    {
+        if (!_loadedInitialSettings)
+        {
+            // Load settings if we haven't already
+            LoadSettings();
+        }
+
+        return _settings->GlobalSettings().GetLaunchMode();
+    }
+
+    // Method Description:
+    // - Get the user defined initial position from Json settings file.
+    //   This position represents the top left corner of the Terminal window.
+    //   This setting is optional, if not provided, we will use the system
+    //   default size, which is provided in IslandWindow::MakeWindow.
+    // Arguments:
+    // - defaultInitialX: the system default x coordinate value
+    // - defaultInitialY: the system defualt y coordinate value
+    // Return Value:
+    // - a point containing the requested initial position in pixels.
+    winrt::Windows::Foundation::Point App::GetLaunchInitialPositions(int32_t defaultInitialX, int32_t defaultInitialY)
+    {
+        if (!_loadedInitialSettings)
+        {
+            // Load settings if we haven't already
+            LoadSettings();
+        }
+
+        winrt::Windows::Foundation::Point point((float)defaultInitialX, (float)defaultInitialY);
+
+        auto initialX = _settings->GlobalSettings().GetInitialX();
+        auto initialY = _settings->GlobalSettings().GetInitialY();
+        if (initialX.has_value())
+        {
+            point.X = gsl::narrow_cast<float>(initialX.value());
+        }
+        if (initialY.has_value())
+        {
+            point.Y = gsl::narrow_cast<float>(initialY.value());
+        }
+
+        return point;
+    }
+
     bool App::GetShowTabsInTitlebar()
     {
         if (!_loadedInitialSettings)

src/cascadia/TerminalApp/App.h

@@ -31,6 +31,8 @@ namespace winrt::TerminalApp::implementation
         void LoadSettings();
 
         Windows::Foundation::Point GetLaunchDimensions(uint32_t dpi);
+        winrt::Windows::Foundation::Point GetLaunchInitialPositions(int32_t defaultInitialX, int32_t defaultInitialY);
+        LaunchMode GetLaunchMode();
         bool GetShowTabsInTitlebar();
 
         Windows::UI::Xaml::UIElement GetRoot() noexcept;

src/cascadia/TerminalApp/App.idl

@@ -3,9 +3,16 @@
 
 namespace TerminalApp
 {
+    enum LaunchMode
+    {
+        DefaultMode,
+        MaximizedMode,
+    };
+
     delegate void LastTabClosedEventArgs();
     [default_interface] runtimeclass App : Microsoft.Toolkit.Win32.UI.XamlHost.XamlApplication
     {
+
         App();
 
         void Initialize();
@@ -18,12 +25,13 @@ namespace TerminalApp
         void Create();
 
         void LoadSettings();
-
         Windows.UI.Xaml.UIElement GetRoot();
 
         String Title { get; };
 
         Windows.Foundation.Point GetLaunchDimensions(UInt32 dpi);
+        Windows.Foundation.Point GetLaunchInitialPositions(Int32 defaultInitialX, Int32 defaultInitialY);
+        LaunchMode GetLaunchMode();
         Boolean GetShowTabsInTitlebar();
         void TitlebarClicked();
 

src/cascadia/TerminalApp/GlobalAppSettings.cpp

@@ -7,6 +7,7 @@
 #include "../../inc/DefaultSettings.h"
 #include "Utils.h"
 #include "JsonUtils.h"
+#include <sstream>
 
 using namespace TerminalApp;
 using namespace winrt::Microsoft::Terminal::Settings;
@@ -20,12 +21,15 @@ static constexpr std::string_view DefaultProfileKey{ "defaultProfile" };
 static constexpr std::string_view AlwaysShowTabsKey{ "alwaysShowTabs" };
 static constexpr std::string_view InitialRowsKey{ "initialRows" };
 static constexpr std::string_view InitialColsKey{ "initialCols" };
+static constexpr std::string_view InitialPositionKey{ "initialPosition" };
 static constexpr std::string_view ShowTitleInTitlebarKey{ "showTerminalTitleInTitlebar" };
 static constexpr std::string_view RequestedThemeKey{ "requestedTheme" };
 static constexpr std::string_view ShowTabsInTitlebarKey{ "showTabsInTitlebar" };
 static constexpr std::string_view WordDelimitersKey{ "wordDelimiters" };
 static constexpr std::string_view CopyOnSelectKey{ "copyOnSelect" };
-
+static constexpr std::string_view LaunchModeKey{ "launchMode" };
+static constexpr std::wstring_view DefaultLaunchModeValue{ L"default" };
+static constexpr std::wstring_view MaximizedLaunchModeValue{ L"maximized" };
 static constexpr std::wstring_view LightThemeValue{ L"light" };
 static constexpr std::wstring_view DarkThemeValue{ L"dark" };
 static constexpr std::wstring_view SystemThemeValue{ L"system" };
@@ -37,11 +41,14 @@ GlobalAppSettings::GlobalAppSettings() :
     _alwaysShowTabs{ true },
     _initialRows{ DEFAULT_ROWS },
     _initialCols{ DEFAULT_COLS },
+    _initialX{},
+    _initialY{},
     _showTitleInTitlebar{ true },
     _showTabsInTitlebar{ true },
     _requestedTheme{ ElementTheme::Default },
     _wordDelimiters{ DEFAULT_WORD_DELIMITERS },
-    _copyOnSelect{ false }
+    _copyOnSelect{ false },
+    _launchMode{ LaunchMode::DefaultMode }
 {
 }
 
@@ -124,6 +131,16 @@ void GlobalAppSettings::SetCopyOnSelect(const bool copyOnSelect) noexcept
     _copyOnSelect = copyOnSelect;
 }
 
+LaunchMode GlobalAppSettings::GetLaunchMode() const noexcept
+{
+    return _launchMode;
+}
+
+void GlobalAppSettings::SetLaunchMode(const LaunchMode launchMode)
+{
+    _launchMode = launchMode;
+}
+
 #pragma region ExperimentalSettings
 bool GlobalAppSettings::GetShowTabsInTitlebar() const noexcept
 {
@@ -134,6 +151,17 @@ void GlobalAppSettings::SetShowTabsInTitlebar(const bool showTabsInTitlebar) noe
 {
     _showTabsInTitlebar = showTabsInTitlebar;
 }
+
+std::optional<int32_t> GlobalAppSettings::GetInitialX() const noexcept
+{
+    return _initialX;
+}
+
+std::optional<int32_t> GlobalAppSettings::GetInitialY() const noexcept
+{
+    return _initialY;
+}
+
 #pragma endregion
 
 // Method Description:
@@ -147,6 +175,7 @@ void GlobalAppSettings::ApplyToSettings(TerminalSettings& settings) const noexce
     settings.KeyBindings(GetKeybindings());
     settings.InitialRows(_initialRows);
     settings.InitialCols(_initialCols);
+
     settings.WordDelimiters(_wordDelimiters);
     settings.CopyOnSelect(_copyOnSelect);
 }
@@ -164,11 +193,13 @@ Json::Value GlobalAppSettings::ToJson() const
     jsonObject[JsonKey(DefaultProfileKey)] = winrt::to_string(Utils::GuidToString(_defaultProfile));
     jsonObject[JsonKey(InitialRowsKey)] = _initialRows;
     jsonObject[JsonKey(InitialColsKey)] = _initialCols;
+    jsonObject[JsonKey(InitialPositionKey)] = _SerializeInitialPosition(_initialX, _initialY);
     jsonObject[JsonKey(AlwaysShowTabsKey)] = _alwaysShowTabs;
     jsonObject[JsonKey(ShowTitleInTitlebarKey)] = _showTitleInTitlebar;
     jsonObject[JsonKey(ShowTabsInTitlebarKey)] = _showTabsInTitlebar;
     jsonObject[JsonKey(WordDelimitersKey)] = winrt::to_string(_wordDelimiters);
     jsonObject[JsonKey(CopyOnSelectKey)] = _copyOnSelect;
+    jsonObject[JsonKey(LaunchModeKey)] = winrt::to_string(_SerializeLaunchMode(_launchMode));
     jsonObject[JsonKey(RequestedThemeKey)] = winrt::to_string(_SerializeTheme(_requestedTheme));
     jsonObject[JsonKey(KeybindingsKey)] = _keybindings->ToJson();
 
@@ -208,7 +239,10 @@ void GlobalAppSettings::LayerJson(const Json::Value& json)
     {
         _initialCols = initialCols.asInt();
     }
-
+    if (auto initialPosition{ json[JsonKey(InitialPositionKey)] })
+    {
+        _ParseInitialPosition(GetWstringFromJson(initialPosition), _initialX, _initialY);
+    }
     if (auto showTitleInTitlebar{ json[JsonKey(ShowTitleInTitlebarKey)] })
     {
         _showTitleInTitlebar = showTitleInTitlebar.asBool();
@@ -229,6 +263,11 @@ void GlobalAppSettings::LayerJson(const Json::Value& json)
         _copyOnSelect = copyOnSelect.asBool();
     }
 
+    if (auto launchMode{ json[JsonKey(LaunchModeKey)] })
+    {
+        _launchMode = _ParseLaunchMode(GetWstringFromJson(launchMode));
+    }
+
     if (auto requestedTheme{ json[JsonKey(RequestedThemeKey)] })
     {
         _requestedTheme = _ParseTheme(GetWstringFromJson(requestedTheme));
@@ -280,3 +319,115 @@ std::wstring_view GlobalAppSettings::_SerializeTheme(const ElementTheme theme) n
         return SystemThemeValue;
     }
 }
+
+// Method Description:
+// - Helper function for converting the initial position string into
+//   2 coordinate values. We allow users to only provide one coordinate,
+//   thus, we use comma as the separater:
+//   (100, 100): standard input string
+//   (, 100), (100, ): if a value is missing, we set this value as a default
+//   (,): both x and y are set to default
+//   (abc, 100): if a value is not valid, we treat it as default
+//   (100, 100, 100): we only read the first two values, this is equivalent to (100, 100)
+// Arguments:
+// - initialPosition: the initial position string from json
+//   initialX: reference to the _initialX member
+//   initialY: reference to the _initialY member
+// Return Value:
+// - None
+void GlobalAppSettings::_ParseInitialPosition(const std::wstring& initialPosition,
+                                              std::optional<int32_t>& initialX,
+                                              std::optional<int32_t>& initialY) noexcept
+{
+    const wchar_t singleCharDelim = L',';
+    std::wstringstream tokenStream(initialPosition.c_str());
+    std::wstring token;
+    uint8_t initialPosIndex = 0;
+    size_t* idx = nullptr;
+
+    // Get initial position values till we run out of delimiter separated values in the stream
+    // or we hit max number of allowable values (= 2)
+    // Non-numeral values or empty string will be caught as exception and we do not assign them
+    for (; std::getline(tokenStream, token, singleCharDelim) && (initialPosIndex < 2); initialPosIndex++)
+    {
+        try
+        {
+            int32_t position = std::stoi(token, idx);
+            if (initialPosIndex == 0)
+            {
+                initialX.emplace(position);
+            }
+
+            if (initialPosIndex == 1)
+            {
+                initialY.emplace(position);
+            }
+        }
+        catch (...)
+        {
+            // Do nothing
+        }
+    }
+}
+
+// Method Description:
+// - Helper function for converting X/Y initial positions to a string
+//   value.
+// Arguments:
+// - initialX: reference to the _initialX member
+//   initialY: reference to the _initialY member
+// Return Value:
+// - The concatenated string for the the current initialX and initialY
+std::string GlobalAppSettings::_SerializeInitialPosition(const std::optional<int32_t>& initialX,
+                                                         const std::optional<int32_t>& initialY) noexcept
+{
+    std::string serializedInitialPos = "(";
+    if (initialX.has_value())
+    {
+        serializedInitialPos += initialX.value();
+    }
+
+    serializedInitialPos += ", ";
+
+    if (initialY.has_value())
+    {
+        serializedInitialPos += initialY.value();
+    }
+
+    return serializedInitialPos;
+}
+
+// Method Description:
+// - Helper function for converting the user-specified launch mode
+//   to a LaunchMode enum value
+// Arguments:
+// - launchModeString: The string value from the settings file to parse
+// Return Value:
+// - The corresponding enum value which maps to the string provided by the user
+LaunchMode GlobalAppSettings::_ParseLaunchMode(const std::wstring& launchModeString) noexcept
+{
+    if (launchModeString == MaximizedLaunchModeValue)
+    {
+        return LaunchMode::MaximizedMode;
+    }
+
+    return LaunchMode::DefaultMode;
+}
+
+// Method Description:
+// - Helper function for converting a LaunchMode to its corresponding string
+//   value.
+// Arguments:
+// - launchMode: The enum value to convert to a string.
+// Return Value:
+// - The string value for the given LaunchMode
+std::wstring_view GlobalAppSettings::_SerializeLaunchMode(const LaunchMode launchMode) noexcept
+{
+    switch (launchMode)
+    {
+    case LaunchMode::MaximizedMode:
+        return MaximizedLaunchModeValue;
+    default:
+        return DefaultLaunchModeValue;
+    }
+}

src/cascadia/TerminalApp/GlobalAppSettings.h

@@ -58,6 +58,13 @@ class TerminalApp::GlobalAppSettings final
     bool GetCopyOnSelect() const noexcept;
     void SetCopyOnSelect(const bool copyOnSelect) noexcept;
 
+    std::optional<int32_t> GetInitialX() const noexcept;
+
+    std::optional<int32_t> GetInitialY() const noexcept;
+
+    winrt::TerminalApp::LaunchMode GetLaunchMode() const noexcept;
+    void SetLaunchMode(const winrt::TerminalApp::LaunchMode launchMode);
+
     winrt::Windows::UI::Xaml::ElementTheme GetRequestedTheme() const noexcept;
 
     Json::Value ToJson() const;
@@ -75,6 +82,9 @@ class TerminalApp::GlobalAppSettings final
     int32_t _initialRows;
     int32_t _initialCols;
 
+    std::optional<int32_t> _initialX;
+    std::optional<int32_t> _initialY;
+
     bool _showStatusline;
     bool _alwaysShowTabs;
     bool _showTitleInTitlebar;
@@ -84,8 +94,20 @@ class TerminalApp::GlobalAppSettings final
     bool _copyOnSelect;
     winrt::Windows::UI::Xaml::ElementTheme _requestedTheme;
 
+    winrt::TerminalApp::LaunchMode _launchMode;
+
     static winrt::Windows::UI::Xaml::ElementTheme _ParseTheme(const std::wstring& themeString) noexcept;
     static std::wstring_view _SerializeTheme(const winrt::Windows::UI::Xaml::ElementTheme theme) noexcept;
 
+    static void _ParseInitialPosition(const std::wstring& initialPosition,
+                                      std::optional<int32_t>& initialX,
+                                      std::optional<int32_t>& initialY) noexcept;
+
+    static std::string _SerializeInitialPosition(const std::optional<int32_t>& initialX,
+                                                 const std::optional<int32_t>& initialY) noexcept;
+
+    static std::wstring_view _SerializeLaunchMode(const winrt::TerminalApp::LaunchMode launchMode) noexcept;
+    static winrt::TerminalApp::LaunchMode _ParseLaunchMode(const std::wstring& launchModeString) noexcept;
+
     friend class TerminalAppLocalTests::SettingsTests;
 };