gimp/libgimpwidgets/gimpvruler.c

/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include "config.h"

#include <string.h>

#include <gtk/gtk.h>

#include "libgimpmath/gimpmath.h"

#include "gimpwidgetstypes.h"

#include "gimpvruler.h"


#define RULER_WIDTH   13
#define MINIMUM_INCR   5

static const struct
{
  gdouble  ruler_scale[16];
  gint     subdivide[5];
} ruler_metric =
{
  { 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, 50000, 100000 },
  { 1, 5, 10, 50, 100 }
};


typedef struct
{
  gint xsrc;
  gint ysrc;
} GimpVRulerPrivate;


static gint gimp_vruler_motion_notify (GtkWidget      *widget,
                                       GdkEventMotion *event);
static void gimp_vruler_draw_ticks    (GimpRuler      *ruler);
static void gimp_vruler_draw_pos      (GimpRuler      *ruler);

G_DEFINE_TYPE (GimpVRuler, gimp_vruler, GIMP_TYPE_RULER)

#define GIMP_VRULER_GET_PRIVATE(ruler) \
  G_TYPE_INSTANCE_GET_PRIVATE (ruler, GIMP_TYPE_VRULER, GimpVRulerPrivate)



static void
gimp_vruler_class_init (GimpVRulerClass *klass)
{
  GObjectClass   *object_class = G_OBJECT_CLASS (klass);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
  GimpRulerClass *ruler_class  = GIMP_RULER_CLASS (klass);

  widget_class->motion_notify_event = gimp_vruler_motion_notify;

  ruler_class->draw_ticks = gimp_vruler_draw_ticks;
  ruler_class->draw_pos   = gimp_vruler_draw_pos;

  g_type_class_add_private (object_class, sizeof (GimpVRulerPrivate));
}

static void
gimp_vruler_init (GimpVRuler *vruler)
{
  GtkWidget *widget = GTK_WIDGET (vruler);

  widget->requisition.width  = widget->style->xthickness * 2 + RULER_WIDTH;
  widget->requisition.height = widget->style->ythickness * 2 + 1;
}

/**
 * gimp_vruler_new:
 *
 * Creates a new vertical ruler.
 *
 * Return value: a new #GimpVRuler widget.
 *
 * Since: GIMP 2.8
 **/
GtkWidget*
gimp_vruler_new (void)
{
  return g_object_new (GIMP_TYPE_VRULER, NULL);
}

static gint
gimp_vruler_motion_notify (GtkWidget      *widget,
                          GdkEventMotion *event)
{
  GimpRuler *ruler = GIMP_RULER (widget);
  gdouble    lower;
  gdouble    upper;
  gint       y;

  gdk_event_request_motions (event);
  y = event->y;

  gimp_ruler_get_range (ruler, &lower, &upper, NULL);

  gimp_ruler_set_position (ruler,
                           lower +
                           ((upper - lower) * y) / widget->allocation.height);

  return FALSE;
}

static void
gimp_vruler_draw_ticks (GimpRuler *ruler)
{
  GtkWidget      *widget = GTK_WIDGET (ruler);
  GdkDrawable    *backing_store;
  cairo_t        *cr;
  gint            i, j;
  gint            width, height;
  gint            xthickness;
  gint            ythickness;
  gint            length, ideal_length;
  gdouble         lower, upper; /* Upper and lower limits, in ruler units */
  gdouble         increment;     /* Number of pixels per unit */
  gint            scale;        /* Number of units per major unit */
  gdouble         start, end, cur;
  gchar           unit_str[32];
  gint            digit_height;
  gint            digit_offset;
  gint            text_height;
  gint            pos;
  gdouble         max_size;
  GimpUnit        unit;
  PangoLayout    *layout;
  PangoRectangle  logical_rect, ink_rect;

  if (! GTK_WIDGET_DRAWABLE (widget))
    return;

  backing_store = _gimp_ruler_get_backing_store (ruler);

  xthickness = widget->style->xthickness;
  ythickness = widget->style->ythickness;

  layout = _gimp_ruler_create_pango_layout (widget, "012456789");
  pango_layout_get_extents (layout, &ink_rect, &logical_rect);

  digit_height = PANGO_PIXELS (ink_rect.height) + 2;
  digit_offset = ink_rect.y;

  width  = widget->allocation.height;
  height = widget->allocation.width - ythickness * 2;

  gtk_paint_box (widget->style, backing_store,
                 GTK_STATE_NORMAL, GTK_SHADOW_OUT,
                 NULL, widget, "vruler",
                 0, 0,
                  widget->allocation.width, widget->allocation.height);

  cr = gdk_cairo_create (backing_store);
  gdk_cairo_set_source_color (cr, &widget->style->fg[widget->state]);

  cairo_rectangle (cr,
                   height + xthickness,
                   ythickness,
                   1,
                   widget->allocation.height - 2 * ythickness);

  gimp_ruler_get_range (ruler, &lower, &upper, &max_size);

  if ((upper - lower) == 0)
    goto out;

  increment = (gdouble) width / (upper - lower);

  /* determine the scale
   *   use the maximum extents of the ruler to determine the largest
   *   possible number to be displayed.  Calculate the height in pixels
   *   of this displayed text. Use this height to find a scale which
   *   leaves sufficient room for drawing the ruler.
   */
  scale = ceil (max_size);
  g_snprintf (unit_str, sizeof (unit_str), "%d", scale);
  text_height = strlen (unit_str) * digit_height + 1;

  for (scale = 0; scale <  G_N_ELEMENTS (ruler_metric.ruler_scale); scale++)
    if (ruler_metric.ruler_scale[scale] * fabs (increment) > 2 * text_height)
      break;

  if (scale ==  G_N_ELEMENTS (ruler_metric.ruler_scale))
    scale = G_N_ELEMENTS (ruler_metric.ruler_scale) - 1;

  unit = gimp_ruler_get_unit (ruler);

  /* drawing starts here */
  length = 0;
  for (i = G_N_ELEMENTS (ruler_metric.subdivide) - 1; i >= 0; i--)
    {
      gdouble subd_incr;

      /* hack to get proper subdivisions at full pixels */
      if (unit == GIMP_UNIT_PIXEL && scale == 1 && i == 1)
        subd_incr = 1.0;
      else
        subd_incr = ((gdouble) ruler_metric.ruler_scale[scale] /
                     (gdouble) ruler_metric.subdivide[i]);

      if (subd_incr * fabs (increment) <= MINIMUM_INCR)
        continue;

      /* don't subdivide pixels */
      if (unit == GIMP_UNIT_PIXEL && subd_incr < 1)
        continue;

      /* Calculate the length of the tickmarks. Make sure that
       * this length increases for each set of ticks
       */
      ideal_length = height / (i + 1) - 1;
      if (ideal_length > ++length)
        length = ideal_length;

      if (lower < upper)
        {
          start = floor (lower / subd_incr) * subd_incr;
          end   = ceil  (upper / subd_incr) * subd_incr;
        }
      else
        {
          start = floor (upper / subd_incr) * subd_incr;
          end   = ceil  (lower / subd_incr) * subd_incr;
        }

      for (cur = start; cur <= end; cur += subd_incr)
        {
          pos = ROUND ((cur - lower) * increment);

          cairo_rectangle (cr,
                           height + xthickness - length, pos,
                           length,                       1);

          /* draw label */
          if (i == 0)
            {
              g_snprintf (unit_str, sizeof (unit_str), "%d", (int) cur);

              for (j = 0; j < (int) strlen (unit_str); j++)
                {
                  pango_layout_set_text (layout, unit_str + j, 1);
                  pango_layout_get_extents (layout, NULL, &logical_rect);

                  gtk_paint_layout (widget->style,
                                    backing_store,
                                    GTK_WIDGET_STATE (widget),
                                    FALSE,
                                    NULL,
                                    widget,
                                    "vruler",
                                    xthickness + 1,
                                    pos + digit_height * j + 2 + PANGO_PIXELS (logical_rect.y - digit_offset),
                                    layout);
                }
            }
        }
    }

  cairo_fill (cr);
out:
  cairo_destroy (cr);

  g_object_unref (layout);
}


static void
gimp_vruler_draw_pos (GimpRuler *ruler)
{
  GtkWidget *widget = GTK_WIDGET (ruler);

  if (GTK_WIDGET_DRAWABLE (ruler))
    {
      GimpVRulerPrivate *priv = GIMP_VRULER_GET_PRIVATE (ruler);
      gint               x, y;
      gint               width, height;
      gint               bs_width, bs_height;
      gint               xthickness;
      gint               ythickness;

      xthickness = widget->style->xthickness;
      ythickness = widget->style->ythickness;
      width  = widget->allocation.width - xthickness * 2;
      height = widget->allocation.height;

      bs_height = width / 2 + 2;
      bs_height |= 1;  /* make sure it's odd */
      bs_width = bs_height / 2 + 1;

      if ((bs_width > 0) && (bs_height > 0))
        {
          GdkDrawable *backing_store = _gimp_ruler_get_backing_store (ruler);
          cairo_t     *cr            = gdk_cairo_create (widget->window);
          gdouble      lower;
          gdouble      upper;
          gdouble      position;
          gdouble      increment;

          /*  If a backing store exists, restore the ruler  */
          if (backing_store)
            gdk_draw_drawable (widget->window,
                               widget->style->black_gc,
                               backing_store,
                               priv->xsrc, priv->ysrc,
                               priv->xsrc, priv->ysrc,
                               bs_width, bs_height);

          position = gimp_ruler_get_position (ruler);

          gimp_ruler_get_range (ruler, &lower, &upper, NULL);

          increment = (gdouble) height / (upper - lower);

          x = (width + bs_width) / 2 + xthickness;
          y = ROUND ((position - lower) * increment) + (ythickness - bs_height) / 2 - 1;

          gdk_cairo_set_source_color (cr, &widget->style->fg[widget->state]);

          cairo_move_to (cr, x,            y);
          cairo_line_to (cr, x + bs_width, y + bs_height / 2.);
          cairo_line_to (cr, x,            y + bs_height);
          cairo_fill (cr);

          cairo_destroy (cr);

          priv->xsrc = x;
          priv->ysrc = y;
        }
    }
}