aura-x11: Add custom web cursor support.

ui/base/x/x11_util.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file defines utility functions for X11 (Linux only). This code has been
 // ported from XCB since we can't use XCB on Ubuntu while its 32-bit support
 // remains woefully incomplete.
 
 #include "ui/base/x/x11_util.h"
 
@@ skipping 17 matching lines @@
 #include "ui/base/keycodes/keyboard_code_conversion_x.h"
 #include "ui/base/x/x11_util_internal.h"
 #include "ui/gfx/rect.h"
 #include "ui/gfx/size.h"
 
 #if defined(OS_FREEBSD)
 #include <sys/types.h>
 #include <sys/sysctl.h>
 #endif
 
+#if defined(USE_AURA)
+#include <X11/Xcursor/Xcursor.h>
+#endif
+
 #if defined(TOOLKIT_USES_GTK)
 #include <gdk/gdk.h>
 #include <gdk/gdkx.h>
 #include <gtk/gtk.h>
 #include "ui/base/gtk/gtk_compat.h"
 #include "ui/base/gtk/gdk_x_compat.h"
 #else
 // TODO(sad): Use the new way of handling X errors when
 // http://codereview.chromium.org/7889040/ lands.
 #define gdk_error_trap_push()
@@ skipping 133 matching lines @@
     cache_.clear();
   }
 
  private:
   // Maps X11 font cursor shapes to Cursor IDs.
   std::map<int, Cursor> cache_;
 
   DISALLOW_COPY_AND_ASSIGN(XCursorCache);
 };
 
+#if defined(USE_AURA)
+// A process wide singleton cache for custom X cursors.
+class XCustomCursorCache {
+ public:
+  static XCustomCursorCache* GetInstance() {
+    return Singleton<XCustomCursorCache>::get();
+  }
+
+  Cursor InstallCustomCursor(XcursorImage* image) {
+    Cursor xcursor = XcursorImageLoadCursor(GetXDisplay(), image);
+    XCustomCursor* custom_cursor = new XCustomCursor(image);
+    cache_[xcursor] = custom_cursor;
+    return xcursor;
+  }
+
+  void Ref(Cursor cursor) {
+    cache_[cursor]->Ref();
+  }
+
+  void Unref(Cursor cursor) {
+    if (cache_[cursor]->Unref()) {
+      XFreeCursor(GetXDisplay(), cursor);
+      cache_.erase(cursor);
+    }
+  }
+
+  void Clear() {
+    cache_.clear();

[Daniel Erat, 2012/02/24 21:04:36]

do you need to call XFreeCursor() on all of the keys here?

[sadrul, 2012/02/24 22:48:49]

Good catch. This needs to happen. I have moved the Cursor ownership from
XCustomCursorCache to XCustomCursor, and the cursor is free'd from its
destructor.

+  }
+
+ private:
+  friend struct DefaultSingletonTraits<XCustomCursorCache>;
+
+  class XCustomCursor {
+   public:
+    XCustomCursor(XcursorImage* image)

[Daniel Erat, 2012/02/24 21:04:36]

nit: document that it takes ownership of |image|

[sadrul, 2012/02/24 22:48:49]

Done.

+        : image_(image),
+          ref_(1) {
+    }
+
+    ~XCustomCursor() {
+      XcursorImageDestroy(image_);
+    }
+
+    void Ref() {
+      ++ref_;
+    }
+
+    // Returns true if the cursor was destroyed because of the unref.
+    bool Unref() {
+      if (--ref_ == 0) {
+        delete this;
+        return true;
+      }
+      return false;
+    }
+
+   private:
+    XcursorImage* image_;
+    int ref_;
+
+    DISALLOW_COPY_AND_ASSIGN(XCustomCursor);
+  };
+
+  XCustomCursorCache() {}
+  ~XCustomCursorCache() {
+    Clear();
+  }
+
+  std::map<Cursor, XCustomCursor*> cache_;
+  DISALLOW_COPY_AND_ASSIGN(XCustomCursorCache);
+};
+#endif  // defined(USE_AURA)
+
 // A singleton object that remembers remappings of mouse buttons.
 class XButtonMap {
  public:
   static XButtonMap* GetInstance() {
     return Singleton<XButtonMap>::get();
   }
 
   void UpdateMapping() {
     count_ = XGetPointerMapping(ui::GetXDisplay(), map_, arraysize(map_));
   }
@@ skipping 109 matching lines @@
   CR_DEFINE_STATIC_LOCAL(XCursorCache, cache, ());
 
   if (cursor_shape == kCursorClearXCursorCache) {
     cache.Clear();
     return 0;
   }
 
   return cache.GetCursor(cursor_shape);
 }
 
+#if defined(USE_AURA)
+Cursor CreateReffedCustomXCursor(XcursorImage* image) {
+  return XCustomCursorCache::GetInstance()->InstallCustomCursor(image);
+}
+
+void RefCustomXCursor(Cursor cursor) {
+  XCustomCursorCache::GetInstance()->Ref(cursor);
+}
+
+void UnrefCustomXCursor(Cursor cursor) {
+  XCustomCursorCache::GetInstance()->Unref(cursor);
+}
+#endif
+
 XID GetX11RootWindow() {
   return DefaultRootWindow(GetXDisplay());
 }
 
 bool GetCurrentDesktop(int* desktop) {
   return GetIntProperty(GetX11RootWindow(), "_NET_CURRENT_DESKTOP", desktop);
 }
 
 #if defined(TOOLKIT_USES_GTK)
 XID GetX11WindowFromGtkWidget(GtkWidget* widget) {
@@ skipping 800 matching lines @@
       << "request_code " << static_cast<int>(error_event.request_code) << ", "
       << "minor_code " << static_cast<int>(error_event.minor_code)
       << " (" << request_str << ")";
 }
 
 // ----------------------------------------------------------------------------
 // End of x11_util_internal.h
 
 
 }  // namespace ui