Merge lp:~brandontschaefer/overlay-scrollbar/hidpi-support into lp:overlay-scrollbar

[Brandon Schaefer]

Scale up the overlay-scrollbars correctly when the DPI changes. Does not work very nice when the gtk-scaling-factor is changed.

Scale up the overlay-scrollbars correctly when the DPI changes. Does not work very nice when the gtk-scaling-factor is changed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:387
http://jenkins.qa.ubuntu.com/job/overlay-scrollbar-ci/14/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/overlay-scrollbar-trusty-amd64-ci/5
    SUCCESS: http://jenkins.qa.ubuntu.com/job/overlay-scrollbar-trusty-armhf-ci/5
    SUCCESS: http://jenkins.qa.ubuntu.com/job/overlay-scrollbar-trusty-i386-ci/5

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/overlay-scrollbar-ci/14/rebuild

review: Approve (continuous-integration)

[Christopher Townsend (townsend)]

Seems to work fine for < 2. That's good enough for now.

review: Approve

[Christopher Townsend (townsend)]

Ok, update looks fine as well.

review: Approve

[lp:~brandontschaefer/overlay-scrollbar/hidpi-support]

389. By Brandon Schaefer on 2014-05-09

* Fix problem if a newly mapped monitor is plugged in and left
  to the default scale value.

Unmerged revisions

389. By Brandon Schaefer on 2014-05-09

* Fix problem if a newly mapped monitor is plugged in and left
  to the default scale value.

388. By Brandon Schaefer on 2014-04-04

* Increase the prox check by the DPI!

387. By Brandon Schaefer on 2014-03-27

* Move the setting the device scale code, becuase if we are not on gtk3 we crash!
* Fix the grip not being drawn when divison of the w/h changed the w/h to be off by 1

386. By Brandon Schaefer on 2014-03-27

* Dynamically update the scrollbar gtk allocation if we change
  monitors. (Only when are attempting to use the scrollbar do we check)

385. By Brandon Schaefer on 2014-03-27

* Set the monitor when it changes. Need to find a good way to tell gtk to re-do
  gtk allocation.

384. By Brandon Schaefer on 2014-03-25

* Add HiDPI Support for the overlay scrollbars

=== modified file 'os/Makefile.am'
--- os/Makefile.am	2012-04-26 14:44:19 +0000
+++ os/Makefile.am	2014-05-09 17:06:57 +0000
@@ -5,10 +5,12 @@
 endif
 
 source_h = \
+	$(srcdir)/em-converter.h \
 	$(srcdir)/os-private.h \
 	$(srcdir)/os-scrollbar.h
 
 source_c = \
+	$(srcdir)/em-converter.c \
 	$(srcdir)/os-animation.c \
 	$(srcdir)/os-bar.c \
 	$(srcdir)/os-log.c \
 
=== added file 'os/em-converter.c'
--- os/em-converter.c	1970-01-01 00:00:00 +0000
+++ os/em-converter.c	2014-05-09 17:06:57 +0000
@@ -0,0 +1,153 @@
+/* overlay-scrollbar
+ *
+ * Copyright © 2014 Canonical Ltd
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA
+ *
+ * Authored by Brandon Schaefer <[e-mail]>
+ */
+
+#include "em-converter.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#define BASE_DPI         96.0
+#define PIXELS_PER_INCH  72.0
+#define CONVERT_TO_SCALE  8.0
+
+#define SCALE_FATOR            "scale-factor"
+#define UNITY_GSETTINGS_SCHEMA "com.ubuntu.user-interface"
+
+static void
+update_dpi_value(EMConverter* converter, double scale_value)
+{
+  if (!converter)
+    return;
+
+  converter->dpi     = BASE_DPI * scale_value;
+}
+
+static void
+parse_font_scale_factor (EMConverter* converter)
+{
+  float value;
+  int raw_value;
+  GVariant* dict;
+  GdkScreen *screen;
+  gchar* monitor_name;
+
+  g_settings_get(converter->unity_settings, SCALE_FATOR, "@a{si}", &dict);
+
+  screen = gtk_widget_get_screen (converter->parent);
+
+
+  monitor_name = gdk_screen_get_monitor_plug_name (screen, converter->monitor);
+  if (g_variant_lookup(dict, monitor_name, "i", &raw_value))
+    value = raw_value / CONVERT_TO_SCALE;
+  else
+    value = BASE_DPI;
+
+  g_free (monitor_name);
+
+  update_dpi_value(converter, value);
+}
+
+gboolean
+set_converter_monitor (EMConverter* converter, int monitor)
+{
+  if (converter->monitor != monitor)
+  {
+    converter->monitor = monitor;
+    parse_font_scale_factor(converter);
+
+    return TRUE;
+  }
+
+  return FALSE;
+}
+
+static void
+font_scale_changed_callback (GSettings* settings, gchar *key, gpointer data)
+{
+  EMConverter* converter = (EMConverter*)data;
+
+  parse_font_scale_factor(converter);
+}
+
+static void
+get_unity_settings (EMConverter* converter)
+{
+  converter->unity_settings = g_settings_new(UNITY_GSETTINGS_SCHEMA);
+
+  g_signal_connect (converter->unity_settings, "changed::"SCALE_FATOR,
+                      G_CALLBACK (font_scale_changed_callback), converter);
+}
+
+
+EMConverter*
+new_converter (GtkWidget *parent)
+{
+  EMConverter* converter = (EMConverter*)malloc(sizeof(EMConverter));
+
+  converter->monitor        = 0;
+  converter->dpi            = BASE_DPI;
+  converter->unity_settings = NULL;
+  converter->parent         = parent;
+
+  get_unity_settings(converter);
+  parse_font_scale_factor(converter);
+
+  return converter;
+}
+
+void
+cleanup_converter (EMConverter* converter)
+{
+  if (converter)
+    {
+      if (converter->unity_settings != NULL)
+      {
+        g_object_unref(converter->unity_settings);
+        converter->unity_settings = NULL;
+      }
+
+      converter = NULL;
+    }
+}
+
+double
+convert_pixels (EMConverter* converter, double pixel)
+{
+  if (!converter || BASE_DPI == converter->dpi)
+    return pixel;
+
+  double base_ppe = BASE_DPI / PIXELS_PER_INCH;
+  double pixels_em = pixel / base_ppe;
+
+  double current_ppe = converter->dpi / PIXELS_PER_INCH;
+  double new_pixels = pixels_em * current_ppe;
+
+  return new_pixels;
+}
+
+double
+dpi_scale (EMConverter* converter)
+{
+  if (!converter)
+    return 1.0;
+
+  return converter->dpi / BASE_DPI;
+}
 
=== added file 'os/em-converter.h'
--- os/em-converter.h	1970-01-01 00:00:00 +0000
+++ os/em-converter.h	2014-05-09 17:06:57 +0000
@@ -0,0 +1,43 @@
+/* overlay-scrollbar
+ *
+ * Copyright © 2014 Canonical Ltd
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA
+ *
+ * Authored by Brandon Schaefer <[e-mail]>
+ */
+
+#ifndef EM_CONVERTER_H
+#define EM_CONVERTER_H
+
+#include <gtk/gtk.h>
+
+typedef struct {
+  int monitor;
+  int dpi;
+  GSettings *unity_settings;
+  GtkWidget *parent;
+
+} EMConverter;
+
+extern double convert_pixels (EMConverter* converter, double pixel);
+extern double dpi_scale (EMConverter* converter);
+extern gboolean set_converter_monitor (EMConverter* converter, int monitor);
+
+extern EMConverter* new_converter (GtkWidget *parent);
+extern void cleanup_converter (EMConverter* converter);
+
+
+#endif /* EM_CONVERTER_H */
 
=== modified file 'os/os-private.h'
--- os/os-private.h	2012-11-26 14:35:24 +0000
+++ os/os-private.h	2014-05-09 17:06:57 +0000
@@ -23,6 +23,7 @@
 #define __OS_PRIVATE_H__
 
 #include <gtk/gtk.h>
+#include "em-converter.h"
 
 /* Tell GCC not to export internal functions. */
 #ifdef __GNUC__
@@ -235,16 +236,19 @@
   GtkWindowClass parent_class;
 };
 
-GType      os_thumb_get_type     (void) G_GNUC_CONST;
-
-GtkWidget* os_thumb_new          (GtkOrientation orientation);
-
-void       os_thumb_resize       (OsThumb *thumb,
-                                  gint     width,
-                                  gint     height);
-
-void       os_thumb_set_detached (OsThumb *thumb,
-                                  gboolean detached);
+GType      os_thumb_get_type      (void) G_GNUC_CONST;
+
+GtkWidget* os_thumb_new           (GtkOrientation orientation);
+
+void       os_thumb_resize        (OsThumb *thumb,
+                                   gint     width,
+                                   gint     height);
+
+void       os_thumb_set_detached  (OsThumb *thumb,
+                                   gboolean detached);
+
+void       os_thumb_set_converter (OsThumb *thumb,
+                                   EMConverter *converter);
 
 G_END_DECLS
 
 
=== modified file 'os/os-scrollbar.c'
--- os/os-scrollbar.c	2013-12-12 10:17:22 +0000
+++ os/os-scrollbar.c	2014-05-09 17:06:57 +0000
@@ -116,6 +116,7 @@
   GtkWindowGroup *window_group;
   OsAnimation *animation;
   OsBar *bar;
+  EMConverter *converter;
   OsCoordinate pointer;
   OsCoordinate thumb_win;
   OsEventFlags event;
@@ -676,6 +677,7 @@
       qdata->fine_scroll_multiplier = 1.0;
       qdata->bar = os_bar_new ();
       qdata->window_group = gtk_window_group_new ();
+      qdata->converter = new_converter (widget);
       qdata->animation = os_animation_new (RATE_ANIMATION, MAX_DURATION_SCROLLING,
                                            scrolling_cb, scrolling_end_cb, widget);
 
@@ -823,6 +825,15 @@
   priv->state &= ~(OS_STATE_RECONNECTING);
 }
 
+static void
+update_scrollbar_size_allocation(GtkScrollbar *scrollbar)
+{
+  /* Hack to update the size allocation if the monitor changes */
+  GtkAllocation allocation;
+  gtk_widget_get_allocation ((GTK_WIDGET (scrollbar)), &allocation);
+  hijacked_scrollbar_size_allocate (GTK_WIDGET(scrollbar), &allocation);
+}
+
 /* Sanitize x coordinate of thumb window. */
 static gint
 sanitize_x (GtkScrollbar *scrollbar,
@@ -845,6 +856,10 @@
 
   screen = gtk_widget_get_screen (GTK_WIDGET (scrollbar));
   n_monitor = gdk_screen_get_monitor_at_point (screen, monitor_x, y);
+
+  if (set_converter_monitor(priv->converter, n_monitor))
+    update_scrollbar_size_allocation(scrollbar);
+
 #ifdef USE_GTK3
   gdk_screen_get_monitor_geometry (screen, n_monitor, &rect);
 #else
@@ -988,6 +1003,10 @@
 
   screen = gtk_widget_get_screen (GTK_WIDGET (scrollbar));
   n_monitor = gdk_screen_get_monitor_at_point (screen, x, monitor_y);
+
+  if (set_converter_monitor(priv->converter, n_monitor))
+    update_scrollbar_size_allocation(scrollbar);
+
 #ifdef USE_GTK3
   gdk_screen_get_monitor_geometry (screen, n_monitor, &rect);
 #else
@@ -1259,6 +1278,8 @@
                         G_CALLBACK (thumb_scroll_event_cb), scrollbar);
       g_signal_connect (G_OBJECT (priv->thumb), "unmap",
                         G_CALLBACK (thumb_unmap_cb), scrollbar);
+
+      os_thumb_set_converter (OS_THUMB(priv->thumb), priv->converter);
     }
 }
 
@@ -2820,7 +2841,7 @@
 
   priv = get_private (GTK_WIDGET (scrollbar));
 
-  proximity_size = PROXIMITY_SIZE;
+  proximity_size = convert_pixels (priv->converter, PROXIMITY_SIZE);
 
   /* If the thumb is internal, enlarge the proximity area. */
   if (priv->state & OS_STATE_INTERNAL)
@@ -3325,6 +3346,11 @@
               priv->animation = NULL;
             }
 
+          if (priv->converter != NULL)
+            {
+              cleanup_converter (priv->converter);
+            }
+
           if (priv->bar != NULL)
             {
               g_object_unref (priv->bar);
@@ -3383,8 +3409,8 @@
         *minimal_width = *natural_width = 0;
       else
         {
-          *minimal_width = MIN_THUMB_HEIGHT;
-          *natural_width = THUMB_HEIGHT;
+          *minimal_width = convert_pixels(priv->converter, MIN_THUMB_HEIGHT);
+          *natural_width = convert_pixels(priv->converter, THUMB_HEIGHT);
         }
 
       return;
@@ -3408,8 +3434,8 @@
         *minimal_height = *natural_height = 0;
       else
         {
-          *minimal_height = MIN_THUMB_HEIGHT;
-          *natural_height = THUMB_HEIGHT;
+          *minimal_height = convert_pixels(priv->converter, MIN_THUMB_HEIGHT);
+          *natural_height = convert_pixels(priv->converter, THUMB_HEIGHT);
         }
 
       return;
@@ -3720,6 +3746,10 @@
       scrollbar = GTK_SCROLLBAR (widget);
       priv = get_private (widget);
 
+      int thumb_width  = convert_pixels(priv->converter, THUMB_WIDTH);
+      int thumb_height = convert_pixels(priv->converter, THUMB_HEIGHT);
+      int bar_size     = convert_pixels(priv->converter, BAR_SIZE);
+
       /* Get the side, then move thumb and bar accordingly. */
       retrieve_side (scrollbar);
 
@@ -3733,19 +3763,19 @@
 
       if (priv->orientation == GTK_ORIENTATION_VERTICAL)
         {
-          priv->slider.width = THUMB_WIDTH;
-          if (priv->slider.height != MIN (THUMB_HEIGHT, allocation->height))
+          priv->slider.width = thumb_width;
+          if (priv->slider.height != MIN (thumb_height, allocation->height))
             {
-              priv->slider.height = MIN (THUMB_HEIGHT, allocation->height);
+              priv->slider.height = MIN (thumb_height, allocation->height);
               os_thumb_resize (OS_THUMB (priv->thumb), priv->slider.width, priv->slider.height);
             }
 
           if (priv->side == OS_SIDE_RIGHT)
-            priv->bar_all.x = allocation->x - BAR_SIZE;
-
-          priv->bar_all.width = BAR_SIZE;
-
-          priv->thumb_all.width = THUMB_WIDTH;
+            priv->bar_all.x = allocation->x - bar_size;
+
+          priv->bar_all.width = bar_size;
+
+          priv->thumb_all.width = thumb_width;
 
           if (priv->side == OS_SIDE_RIGHT)
             priv->thumb_all.x = allocation->x - priv->bar_all.width;
@@ -3756,19 +3786,19 @@
         }
       else
         {
-          priv->slider.height = THUMB_WIDTH;
-          if (priv->slider.width != MIN (THUMB_HEIGHT, allocation->width))
+          priv->slider.height = thumb_width;
+          if (priv->slider.width != MIN (thumb_height, allocation->width))
             {
-              priv->slider.width = MIN (THUMB_HEIGHT, allocation->width);
+              priv->slider.width = MIN (thumb_height, allocation->width);
               os_thumb_resize (OS_THUMB (priv->thumb), priv->slider.width, priv->slider.height);
             }
 
           if (priv->side == OS_SIDE_BOTTOM)
-            priv->bar_all.y = allocation->y - BAR_SIZE;
-
-          priv->bar_all.height = BAR_SIZE;
-
-          priv->thumb_all.height = THUMB_WIDTH;
+            priv->bar_all.y = allocation->y - bar_size;
+
+          priv->bar_all.height = bar_size;
+
+          priv->thumb_all.height = thumb_width;
 
           if (priv->side == OS_SIDE_BOTTOM)
             priv->thumb_all.y = allocation->y - priv->bar_all.height;
 
=== modified file 'os/os-thumb.c'
--- os/os-thumb.c	2013-02-02 00:46:51 +0000
+++ os/os-thumb.c	2014-05-09 17:06:57 +0000
@@ -53,6 +53,7 @@
   GtkOrientation orientation;
   GtkWidget *grabbed_widget;
   OsAnimation *animation;
+  EMConverter *converter;
   OsCoordinate pointer;
   OsCoordinate pointer_root;
   OsEventFlags event;
@@ -679,6 +680,13 @@
   cr = gdk_cairo_create (gtk_widget_get_window (widget));
 #endif
 
+  cairo_surface_t *surface = cairo_get_target(cr);
+  float scale = dpi_scale(priv->converter);
+  cairo_surface_set_device_scale(surface, scale, scale);
+
+  width /= scale;
+  height /= scale;
+
   cairo_save (cr);
 
   cairo_set_operator (cr, CAIRO_OPERATOR_CLEAR);
@@ -815,8 +823,8 @@
   cairo_stroke (cr);
 
   /* Only draw the grip when the thumb is at full height. */
-  if ((priv->orientation == GTK_ORIENTATION_VERTICAL && height == THUMB_HEIGHT - 1) ||
-      (priv->orientation == GTK_ORIENTATION_HORIZONTAL && width == THUMB_HEIGHT - 1) )
+  if ((priv->orientation == GTK_ORIENTATION_VERTICAL && height < THUMB_HEIGHT) ||
+      (priv->orientation == GTK_ORIENTATION_HORIZONTAL && width < THUMB_HEIGHT) )
     {
       if (priv->orientation == GTK_ORIENTATION_VERTICAL)
         pat = cairo_pattern_create_linear (0, 0, 0, height);
@@ -1268,3 +1276,24 @@
       gtk_widget_queue_draw (GTK_WIDGET (thumb));
     }
 }
+
+/**
+* os_thumb_set_converter:
+* @thumb: a #OsThumb
+* @converter: an #EMConveter
+*
+* Sets the thumbs EMConverter, needed to scale DPI dynamically
+**/
+
+void
+os_thumb_set_converter (OsThumb* thumb,
+                        EMConverter* converter)
+{
+  OsThumbPrivate *priv;
+
+  g_return_if_fail (OS_IS_THUMB (thumb));
+
+  priv = thumb->priv;
+
+  priv->converter = converter;
+}