Merge lp:~alan-griffiths/miral/fix-1699084 into lp:miral

[Alan Griffiths]

Allow cursors that are not the default size (24x24) (LP: #1699084)

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:564
https://mir-jenkins.ubuntu.com/job/miral-ci/43/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-miral/65
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/4951
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=artful/4940
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/4940
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/4940
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=artful/69
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=artful/69/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=xenial/69
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=xenial/69/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=zesty/69
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=zesty/69/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=artful/69
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=artful/69/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=xenial/69
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=xenial/69/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=zesty/69
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=zesty/69/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/miral-ci/43/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

LGTM

review: Approve

[lp:~alan-griffiths/miral/fix-1699084]

564. By Alan Griffiths on 2017-07-20

Allow cursors that are not the default size (24x24) (LP: #1699084). Fixes: https://bugs.launchpad.net/bugs/1699084.

Approved by Gerry Boland, mir-ci-bot.

=== modified file 'miral/xcursor_loader.cpp'
--- miral/xcursor_loader.cpp	2016-09-28 10:38:36 +0000
+++ miral/xcursor_loader.cpp	2017-07-19 12:04:50 +0000
@@ -48,12 +48,6 @@
         : image(image),
           save_resource(save_resource)
     {
-        if (image->width != mi::default_cursor_size.width.as_uint32_t() ||
-            image->height != mi::default_cursor_size.height.as_uint32_t())
-        {
-            BOOST_THROW_EXCEPTION(
-                std::runtime_error("Somehow we got a cursor not of the default size (currently only 24x24 supported)"));
-        }
     }
 
     ~XCursorImage()
@@ -66,7 +60,7 @@
     }
     geom::Size size() const override
     {
-        return mi::default_cursor_size;
+        return {image->width, image->height};
     }
     geom::Displacement hotspot() const override
     {
@@ -161,39 +155,37 @@
 // Each XcursorImages represents images for the different sizes of a given symbolic cursor.
 void miral::XCursorLoader::load_appropriately_sized_image(_XcursorImages *images)
 {
-    // We would rather take this lock in load_cursor_theme but the Xcursor lib style 
+    // We would rather take this lock in load_cursor_theme but the Xcursor lib style
     // makes it difficult to use our standard 'pass the lg around to _locked members' pattern
     std::lock_guard<std::mutex> lg(guard);
 
     // We have to save all the images as XCursor expects us to free them.
-    // This contains the actual image data though, so we need to ensure they stay alive 
+    // This contains the actual image data though, so we need to ensure they stay alive
     // with the lifetime of the mg::CursorImage instance which refers to them.
     auto saved_xcursor_library_resource = std::shared_ptr<_XcursorImages>(images, [](_XcursorImages *images)
         {
             XcursorImagesDestroy(images);
         });
 
-    _XcursorImage *image_of_correct_size = nullptr;
     for (int i = 0; i < images->nimage; i++)
     {
         _XcursorImage *candidate = images->images[i];
         if (candidate->width == mi::default_cursor_size.width.as_uint32_t() &&
             candidate->height == mi::default_cursor_size.height.as_uint32_t())
         {
-            image_of_correct_size = candidate;
-            break;
+            loaded_images[std::string(images->name)] = std::make_shared<XCursorImage>(candidate, saved_xcursor_library_resource);
+            return;
         }
     }
-    if (!image_of_correct_size)
-        return;
-    loaded_images[std::string(images->name)] = std::make_shared<XCursorImage>(image_of_correct_size, saved_xcursor_library_resource);
+
+    loaded_images[std::string(images->name)] = std::make_shared<XCursorImage>(images->images[0], saved_xcursor_library_resource);
 }
 
 void miral::XCursorLoader::load_cursor_theme(std::string const& theme_name)
 {
     // Cursors are named by their square dimension...called the nominal size in XCursor terminology, so we just look up by width.
     // Later we verify the actual size.
-    xcursor_load_theme(theme_name.c_str(), mi::default_cursor_size.width.as_uint32_t(), 
+    xcursor_load_theme(theme_name.c_str(), mi::default_cursor_size.width.as_uint32_t(),
         [](XcursorImages* images, void *this_ptr)  -> void
         {
             // Can't use lambda capture as this lambda is thunked to a C function ptr
@@ -204,14 +196,10 @@
 
 std::shared_ptr<mg::CursorImage> miral::XCursorLoader::image(
     std::string const& cursor_name,
-    geom::Size const& size)
+    geom::Size const& /*size*/)
 {
     auto xcursor_name = xcursor_name_for_mir_cursor(cursor_name);
 
-    if (size != mi::default_cursor_size)
-        BOOST_THROW_EXCEPTION(
-            std::logic_error("Only the default cursor size is currently supported (mi::default_cursor_size)"));
-    
     std::lock_guard<std::mutex> lg(guard);
 
     auto it = loaded_images.find(xcursor_name);
@@ -222,6 +210,6 @@
     it = loaded_images.find("arrow");
     if (it != loaded_images.end())
         return it->second;
-    
+
     return nullptr;
 }