Merge #2349

2349: [x11-platform] Make window title a configuration option r=AlanGriffiths a=graysonguarino

Fixes #2219 by making the initialized title an argument in X11Window, and if the argument is an empty string, sets it to the previous default, "Mir on X".

Co-authored-by: Grayson Guarino <grayson.guarino@canonical.com>

src/platforms/x11/graphics/display.cpp

@@ -79,6 +79,7 @@ class XGLContext : public mir::renderer::gl::Context
 }
 
 mgx::X11Window::X11Window(mx::X11Resources* x11_resources,
+                          std::string title,
                           EGLDisplay egl_dpy,
                           geom::Size const size,
                           EGLConfig const egl_cfg)
@@ -111,9 +112,6 @@ mgx::X11Window::X11Window(mx::X11Resources* x11_resources,
     // Enable the WM_DELETE_WINDOW protocol for the window (causes a client message to be sent when window is closed)
     conn->change_property(win, x11_resources->WM_PROTOCOLS, XCB_ATOM_ATOM, 32, 1, &x11_resources->WM_DELETE_WINDOW);
 
-    // Set the window title
-    std::string title{"Mir on X"};
-
     // Include hostname in title when X-forwarding
     if (getenv("SSH_CONNECTION"))
     {
@@ -146,6 +144,7 @@ unsigned long mgx::X11Window::red_mask() const
 }
 
 mgx::Display::Display(std::shared_ptr<mir::X::X11Resources> const& x11_resources,
+                      std::string const title,
                       std::vector<X11OutputConfig> const& requested_sizes,
                       std::shared_ptr<DisplayConfigurationPolicy> const& initial_conf_policy,
                       std::shared_ptr<GLConfig> const& gl_config,
@@ -164,6 +163,7 @@ mgx::Display::Display(std::shared_ptr<mir::X::X11Resources> const& x11_resources
         auto actual_size = requested_size.size;
         auto window = std::make_unique<X11Window>(
             x11_resources.get(),
+            title,
             shared_egl.display(),
             actual_size,
             shared_egl.config());

src/platforms/x11/graphics/display.h

@@ -53,6 +53,7 @@ class X11Window
 {
 public:
     X11Window(mir::X::X11Resources* x11_resources,
+              std::string title,
               EGLDisplay egl_dpy,
               geometry::Size const size,
               EGLConfig const egl_cfg);
@@ -71,6 +72,7 @@ class Display : public graphics::Display
 {
 public:
     explicit Display(std::shared_ptr<mir::X::X11Resources> const& x11_resources,
+                     std::string const title,
                      std::vector<X11OutputConfig> const& requested_size,
                      std::shared_ptr<DisplayConfigurationPolicy> const& initial_conf_policy,
                      std::shared_ptr<GLConfig> const& gl_config,

src/platforms/x11/graphics/graphics.cpp

@@ -38,6 +38,7 @@ namespace geom = mir::geometry;
 namespace
 {
 char const* x11_displays_option_name{"x11-output"};
+char const* x11_window_title_option_name{"x11-window-title"};
 }
 
 mir::UniqueModulePtr<mg::DisplayPlatform> create_display_platform(
@@ -57,9 +58,11 @@ mir::UniqueModulePtr<mg::DisplayPlatform> create_display_platform(
     }
 
     auto output_sizes = mgx::Platform::parse_output_sizes(options->get<std::string>(x11_displays_option_name));
+    auto const title = options->get<std::string>(x11_window_title_option_name);
 
     return mir::make_module_ptr<mgx::Platform>(
         std::move(x11_resources),
+        std::move(title),
         move(output_sizes),
         report
     );
@@ -82,6 +85,11 @@ void add_graphics_platform_options(boost::program_options::options_description&
          boost::program_options::value<std::string>()->default_value("1280x1024"),
          "[mir-on-X specific] Colon separated list of WIDTHxHEIGHT sizes for \"output\" windows."
          " ^SCALE may also be appended to any output");
+
+    config.add_options()
+        (x11_window_title_option_name,
+         boost::program_options::value<std::string>()->default_value("Mir on X"),
+         "[mir-on-X specific] Title for the banner of the generated X11 window");
 }
 
 mg::PlatformPriority probe_graphics_platform()

src/platforms/x11/graphics/platform.cpp

@@ -108,9 +108,11 @@ auto mgx::Platform::parse_output_sizes(std::string output_sizes) -> std::vector<
 }
 
 mgx::Platform::Platform(std::shared_ptr<mir::X::X11Resources> const& x11_resources,
+                        std::string title,
                         std::vector<X11OutputConfig> output_sizes,
                         std::shared_ptr<mg::DisplayReport> const& report)
     : x11_resources{x11_resources},
+      title{std::move(title)},
       report{report},
       output_sizes{move(output_sizes)}
 {
@@ -128,5 +130,5 @@ mir::UniqueModulePtr<mg::Display> mgx::Platform::create_display(
     std::shared_ptr<DisplayConfigurationPolicy> const& initial_conf_policy,
     std::shared_ptr<GLConfig> const& gl_config)
 {
-    return make_module_ptr<mgx::Display>(x11_resources, output_sizes, initial_conf_policy, gl_config, report);
+    return make_module_ptr<mgx::Display>(x11_resources, title, output_sizes, initial_conf_policy, gl_config, report);
 }

src/platforms/x11/graphics/platform.h

@@ -61,6 +61,7 @@ class Platform : public graphics::DisplayPlatform
     static auto parse_output_sizes(std::string output_sizes) -> std::vector<X11OutputConfig>;
 
     explicit Platform(std::shared_ptr<mir::X::X11Resources> const& x11_resources,
+                      std::string const title,
                       std::vector<X11OutputConfig> output_sizes,
                       std::shared_ptr<DisplayReport> const& report);
     ~Platform() = default;
@@ -71,6 +72,7 @@ class Platform : public graphics::DisplayPlatform
         std::shared_ptr<GLConfig> const& gl_config) override;
 private:
     std::shared_ptr<mir::X::X11Resources> const x11_resources;
+    std::string const title;
     std::shared_ptr<DisplayReport> const report;
     std::vector<X11OutputConfig> const output_sizes;
 };

tests/unit-tests/platforms/x11/test_display.cpp

@@ -103,6 +103,7 @@ class X11DisplayTest : public ::testing::Test
     {
         return std::make_shared<mgx::Display>(
                    mt::fake_shared(x11_resources),
+                   "Mir on X",
                    sizes,
                    mt::fake_shared(null_display_configuration_policy),
                    mt::fake_shared(mock_gl_config),

tests/unit-tests/platforms/x11/test_display_generic.cpp

@@ -91,6 +91,7 @@ class DisplayTestGeneric : public ::testing::Test
     {
         auto const platform = std::make_shared<mg::X::Platform>(
             std::make_shared<mtd::MockX11Resources>(),
+            "Mir on X",
             std::vector<mg::X::X11OutputConfig>{{{1280, 1024}}},
             std::make_shared<mir::report::null::DisplayReport>());
         return platform->create_display(

tests/unit-tests/platforms/x11/test_platform.cpp

@@ -69,6 +69,7 @@ class X11GraphicsPlatformTest : public ::testing::Test
     {
         return std::make_shared<mg::X::Platform>(
             std::make_shared<mtd::MockX11Resources>(),
+            "Mir on X",
             std::vector<mg::X::X11OutputConfig>{{{1280, 1024}}},
             std::make_shared<mir::report::null::DisplayReport>());
     }
@@ -88,6 +89,7 @@ TEST_F(X11GraphicsPlatformTest, failure_to_open_x11_display_results_in_an_error)
         {
             std::make_shared<mg::X::Platform>(
                 nullptr,
+                "Mir on X",
                 std::vector<mg::X::X11OutputConfig>{{{1280, 1024}}},
                 std::make_shared<mir::report::null::DisplayReport>());
         }, std::exception);