PIKApp/libpikawidgets/pikamemsizeentry.c

/* LIBPIKA - The PIKA Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * pikamemsizeentry.c
 * Copyright (C) 2000-2003  Sven Neumann <sven@gimp.org>
 *
 * 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 3 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
 * Library 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, see
 * <https://www.gnu.org/licenses/>.
 */

#include "config.h"

#include <gegl.h>
#include <gtk/gtk.h>

#include "pikawidgetstypes.h"

#include "pikamemsizeentry.h"
#include "pikawidgets.h"

#include "libpika/libpika-intl.h"


/**
 * SECTION: pikamemsizeentry
 * @title: PikaMemSizeEntry
 * @short_description: A composite widget to enter a memory size.
 *
 * Similar to a #PikaSizeEntry but instead of lengths, this widget is
 * used to let the user enter memory sizes. A combo box allows one to
 * switch between Kilobytes, Megabytes and Gigabytes. Used in the PIKA
 * preferences dialog.
 **/


enum
{
  VALUE_CHANGED,
  LAST_SIGNAL
};


struct _PikaMemsizeEntryPrivate
{
  guint64        value;
  guint64        lower;
  guint64        upper;

  guint          shift;

  /* adjustment is owned by spinbutton. Do not unref() it. */
  GtkAdjustment *adjustment;
  GtkWidget     *spinbutton;
  GtkWidget     *menu;
};

#define GET_PRIVATE(obj) (((PikaMemsizeEntry *) (obj))->priv)


static void  pika_memsize_entry_adj_callback  (GtkAdjustment    *adj,
                                               PikaMemsizeEntry *entry);
static void  pika_memsize_entry_unit_callback (GtkWidget        *widget,
                                               PikaMemsizeEntry *entry);

static guint64 pika_memsize_entry_get_rounded_value (PikaMemsizeEntry *entry,
                                                     guint64           value);

G_DEFINE_TYPE_WITH_PRIVATE (PikaMemsizeEntry, pika_memsize_entry, GTK_TYPE_BOX)

#define parent_class pika_memsize_entry_parent_class

static guint pika_memsize_entry_signals[LAST_SIGNAL] = { 0 };


static void
pika_memsize_entry_class_init (PikaMemsizeEntryClass *klass)
{
  klass->value_changed = NULL;

  pika_memsize_entry_signals[VALUE_CHANGED] =
    g_signal_new ("value-changed",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (PikaMemsizeEntryClass, value_changed),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 0);
}

static void
pika_memsize_entry_init (PikaMemsizeEntry *entry)
{
  entry->priv = pika_memsize_entry_get_instance_private (entry);

  gtk_orientable_set_orientation (GTK_ORIENTABLE (entry),
                                  GTK_ORIENTATION_HORIZONTAL);

  gtk_box_set_spacing (GTK_BOX (entry), 4);
}

static void
pika_memsize_entry_adj_callback (GtkAdjustment    *adj,
                                 PikaMemsizeEntry *entry)
{
  PikaMemsizeEntryPrivate *private = GET_PRIVATE (entry);
  guint64                  size    = gtk_adjustment_get_value (adj);

  if (pika_memsize_entry_get_rounded_value (entry, private->value) != size)
    /* Do not allow losing accuracy if the converted/displayed value
     * stays the same.
     */
    private->value = size << private->shift;

  g_signal_emit (entry, pika_memsize_entry_signals[VALUE_CHANGED], 0);
}

static void
pika_memsize_entry_unit_callback (GtkWidget        *widget,
                                  PikaMemsizeEntry *entry)
{
  PikaMemsizeEntryPrivate *private = GET_PRIVATE (entry);
  guint                    shift;

  pika_int_combo_box_get_active (PIKA_INT_COMBO_BOX (widget), (gint *) &shift);

#if _MSC_VER < 1300
#  define CAST (gint64)
#else
#  define CAST
#endif

  if (shift != private->shift)
    {
      private->shift = shift;

      gtk_adjustment_configure (private->adjustment,
                                pika_memsize_entry_get_rounded_value (entry, private->value),
                                CAST private->lower >> shift,
                                CAST private->upper >> shift,
                                gtk_adjustment_get_step_increment (private->adjustment),
                                gtk_adjustment_get_page_increment (private->adjustment),
                                gtk_adjustment_get_page_size (private->adjustment));
    }

#undef CAST
}

/**
 * pika_memsize_entry_get_rounded_value:
 * @entry: #PikaMemsizeEntry whose set unit is used.
 * @value: value to convert to @entry unit, and rounded.
 *
 * Returns: the proper integer value to be displayed for current unit.
 *          This value has been appropriately rounded to the nearest
 *          integer, away from zero.
 */
static guint64
pika_memsize_entry_get_rounded_value (PikaMemsizeEntry *entry,
                                      guint64           value)
{
  PikaMemsizeEntryPrivate *private = GET_PRIVATE (entry);
  guint64                  converted;

#if _MSC_VER < 1300
#  define CAST (gint64)
#else
#  define CAST
#endif

  converted = (CAST value >> private->shift) +
              ((CAST private->value >> (private->shift - 1)) & 1);

#undef CAST

  return converted;
}


/**
 * pika_memsize_entry_new:
 * @value: the initial value (in Bytes)
 * @lower: the lower limit for the value (in Bytes)
 * @upper: the upper limit for the value (in Bytes)
 *
 * Creates a new #PikaMemsizeEntry which is a #GtkHBox with a #GtkSpinButton
 * and a #GtkOptionMenu all setup to allow the user to enter memory sizes.
 *
 * Returns: Pointer to the new #PikaMemsizeEntry.
 **/
GtkWidget *
pika_memsize_entry_new (guint64  value,
                        guint64  lower,
                        guint64  upper)
{
  PikaMemsizeEntry        *entry;
  PikaMemsizeEntryPrivate *private;
  guint                    shift;

#if _MSC_VER < 1300
#  define CAST (gint64)
#else
#  define CAST
#endif

  g_return_val_if_fail (value >= lower && value <= upper, NULL);

  entry = g_object_new (PIKA_TYPE_MEMSIZE_ENTRY, NULL);

  private = GET_PRIVATE (entry);

  for (shift = 30; shift > 10; shift -= 10)
    {
      if (value > (G_GUINT64_CONSTANT (1) << shift) &&
          value % (G_GUINT64_CONSTANT (1) << shift) == 0)
        break;
    }

  private->value = value;
  private->lower = lower;
  private->upper = upper;
  private->shift = shift;

  private->adjustment = gtk_adjustment_new (pika_memsize_entry_get_rounded_value (entry,
                                                                                  private->value),
                                            CAST (lower >> shift),
                                            CAST (upper >> shift),
                                            1, 8, 0);

  private->spinbutton = pika_spin_button_new (private->adjustment, 1.0, 0);
  gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (private->spinbutton), TRUE);

#undef CAST

  gtk_entry_set_width_chars (GTK_ENTRY (private->spinbutton), 7);
  gtk_box_pack_start (GTK_BOX (entry), private->spinbutton, FALSE, FALSE, 0);
  gtk_widget_show (private->spinbutton);

  g_signal_connect (private->adjustment, "value-changed",
                    G_CALLBACK (pika_memsize_entry_adj_callback),
                    entry);

  private->menu = pika_int_combo_box_new (_("Kibibyte"), 10,
                                          _("Mebibyte"), 20,
                                          _("Gibibyte"), 30,
                                          NULL);

  pika_int_combo_box_set_active (PIKA_INT_COMBO_BOX (private->menu), shift);

  g_signal_connect (private->menu, "changed",
                    G_CALLBACK (pika_memsize_entry_unit_callback),
                    entry);

  gtk_box_pack_start (GTK_BOX (entry), private->menu, FALSE, FALSE, 0);
  gtk_widget_show (private->menu);

  return GTK_WIDGET (entry);
}

/**
 * pika_memsize_entry_set_value:
 * @entry: a #PikaMemsizeEntry
 * @value: the new value (in Bytes)
 *
 * Sets the @entry's value. Please note that the #PikaMemsizeEntry rounds
 * the value to full Kilobytes.
 **/
void
pika_memsize_entry_set_value (PikaMemsizeEntry *entry,
                              guint64           value)
{
  PikaMemsizeEntryPrivate *private;
  guint                    shift;

  g_return_if_fail (PIKA_IS_MEMSIZE_ENTRY (entry));

  private = GET_PRIVATE (entry);

  g_return_if_fail (value >= private->lower && value <= private->upper);

  for (shift = 30; shift > 10; shift -= 10)
    {
      if (value > (G_GUINT64_CONSTANT (1) << shift) &&
          value % (G_GUINT64_CONSTANT (1) << shift) == 0)
        break;
    }

  if (shift != private->shift)
    pika_int_combo_box_set_active (PIKA_INT_COMBO_BOX (private->menu), shift);

  gtk_adjustment_set_value (private->adjustment,
                            (gdouble) pika_memsize_entry_get_rounded_value (entry, value));

#undef CASE
}

/**
 * pika_memsize_entry_get_value:
 * @entry: a #PikaMemsizeEntry
 *
 * Retrieves the current value from a #PikaMemsizeEntry.
 *
 * Returns: the current value of @entry (in Bytes).
 **/
guint64
pika_memsize_entry_get_value (PikaMemsizeEntry *entry)
{
  g_return_val_if_fail (PIKA_IS_MEMSIZE_ENTRY (entry), 0);

  return GET_PRIVATE (entry)->value;
}

/**
 * pika_memsize_entry_get_spinbutton:
 * @entry: a #PikaMemsizeEntry
 *
 * Returns: (transfer none) (type GtkSpinButton): the entry's #GtkSpinbutton.
 *
 * Since: 3.0
 **/
GtkWidget *
pika_memsize_entry_get_spinbutton (PikaMemsizeEntry *entry)
{
  g_return_val_if_fail (PIKA_IS_MEMSIZE_ENTRY (entry), 0);

  return GET_PRIVATE (entry)->spinbutton;
}