gimp/app/tools/gimprectselecttool.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#include "config.h"

#include <stdlib.h>

#include <gtk/gtk.h>
#include <gdk/gdkkeysyms.h>

#include "libgimpwidgets/gimpwidgets.h"

#include "tools-types.h"

#include "core/gimp-utils.h"
#include "core/gimpchannel.h"
#include "core/gimpchannel-select.h"
#include "core/gimpimage.h"
#include "core/gimpimage-crop.h"
#include "core/gimplayer-floating-sel.h"
#include "core/gimpmarshal.h"
#include "core/gimptoolinfo.h"
#include "core/gimpunit.h"

#include "widgets/gimphelp-ids.h"

#include "display/gimpdisplay.h"
#include "display/gimpdisplayshell.h"

#include "gimprectselecttool.h"
#include "gimpselectionoptions.h"
#include "gimptoolcontrol.h"

#include "gimp-intl.h"


static void   gimp_rect_select_tool_class_init (GimpRectSelectToolClass *klass);
static void   gimp_rect_select_tool_init       (GimpRectSelectTool      *rect_select);

static void   gimp_rect_select_tool_button_press     (GimpTool        *tool,
                                                      GimpCoords      *coords,
                                                      guint32          time,
                                                      GdkModifierType  state,
                                                      GimpDisplay     *gdisp);
static void   gimp_rect_select_tool_button_release   (GimpTool        *tool,
                                                      GimpCoords      *coords,
                                                      guint32          time,
                                                      GdkModifierType  state,
                                                      GimpDisplay     *gdisp);
static void   gimp_rect_select_tool_motion           (GimpTool        *tool,
                                                      GimpCoords      *coords,
                                                      guint32          time,
                                                      GdkModifierType  state,
                                                      GimpDisplay     *gdisp);

static void   gimp_rect_select_tool_draw             (GimpDrawTool    *draw_tool);

static void   gimp_rect_select_tool_real_rect_select (GimpRectSelectTool *rect_tool,
                                                      gint                x,
                                                      gint                y,
                                                      gint                w,
                                                      gint                h);

static void   gimp_rect_select_tool_update_options   (GimpRectSelectTool *rect_sel,
                                                      GimpDisplay        *display);

static GimpSelectionToolClass *parent_class = NULL;


/*  public functions  */

void
gimp_rect_select_tool_register (GimpToolRegisterCallback  callback,
                                gpointer                  data)
{
  (* callback) (GIMP_TYPE_RECT_SELECT_TOOL,
                GIMP_TYPE_SELECTION_OPTIONS,
                gimp_selection_options_gui,
                0,
                "gimp-rect-select-tool",
                _("Rect Select"),
                _("Select rectangular regions"),
                N_("_Rect Select"), "R",
                NULL, GIMP_HELP_TOOL_RECT_SELECT,
                GIMP_STOCK_TOOL_RECT_SELECT,
                data);
}

GType
gimp_rect_select_tool_get_type (void)
{
  static GtkType tool_type = 0;

  if (! tool_type)
    {
      static const GTypeInfo tool_info =
      {
        sizeof (GimpRectSelectToolClass),
        (GBaseInitFunc) NULL,
        (GBaseFinalizeFunc) NULL,
        (GClassInitFunc) gimp_rect_select_tool_class_init,
        NULL,           /* class_finalize */
        NULL,           /* class_data     */
        sizeof (GimpRectSelectTool),
        0,              /* n_preallocs    */
        (GInstanceInitFunc) gimp_rect_select_tool_init,
      };

      tool_type = g_type_register_static (GIMP_TYPE_SELECTION_TOOL,
                                          "GimpRectSelectTool",
                                          &tool_info, 0);
    }

  return tool_type;
}


/*  private functions  */

static void
gimp_rect_select_tool_class_init (GimpRectSelectToolClass *klass)
{
  GimpToolClass     *tool_class      = GIMP_TOOL_CLASS (klass);
  GimpDrawToolClass *draw_tool_class = GIMP_DRAW_TOOL_CLASS (klass);

  parent_class = g_type_class_peek_parent (klass);

  tool_class->button_press   = gimp_rect_select_tool_button_press;
  tool_class->button_release = gimp_rect_select_tool_button_release;
  tool_class->motion         = gimp_rect_select_tool_motion;

  draw_tool_class->draw      = gimp_rect_select_tool_draw;

  klass->rect_select         = gimp_rect_select_tool_real_rect_select;
}

static void
gimp_rect_select_tool_init (GimpRectSelectTool *rect_select)
{
  GimpTool *tool = GIMP_TOOL (rect_select);

  gimp_tool_control_set_tool_cursor (tool->control,
                                     GIMP_TOOL_CURSOR_RECT_SELECT);

  rect_select->x = rect_select->y = 0.0;
  rect_select->w = rect_select->h = 0.0;
}

static void
gimp_rect_select_tool_button_press (GimpTool        *tool,
                                    GimpCoords      *coords,
                                    guint32          time,
                                    GdkModifierType  state,
                                    GimpDisplay     *gdisp)
{
  GimpRectSelectTool   *rect_sel = GIMP_RECT_SELECT_TOOL (tool);
  GimpSelectionTool    *sel_tool = GIMP_SELECTION_TOOL (tool);
  GimpSelectionOptions *options;
  GimpUnit              unit     = GIMP_UNIT_PIXEL;
  gdouble               unit_factor;

  options = GIMP_SELECTION_OPTIONS (tool->tool_info->tool_options);

  rect_sel->x      = coords->x;
  rect_sel->y      = coords->y;
  rect_sel->w      = 0.0;
  rect_sel->h      = 0.0;
  rect_sel->center = FALSE;
  rect_sel->moved  = FALSE;

  rect_sel->last_coords = *coords;

  rect_sel->fixed_mode   = options->fixed_mode;
  rect_sel->fixed_width  = options->fixed_width;
  rect_sel->fixed_height = options->fixed_height;
  unit                   = options->fixed_unit;

  switch (unit)
    {
    case GIMP_UNIT_PIXEL:
      break;
    case GIMP_UNIT_PERCENT:
      rect_sel->fixed_width =
        gdisp->gimage->width * rect_sel->fixed_width / 100;
      rect_sel->fixed_height =
        gdisp->gimage->height * rect_sel->fixed_height / 100;
      break;
    default:
      unit_factor = _gimp_unit_get_factor (tool->tool_info->gimp, unit);
      rect_sel->fixed_width =
        rect_sel->fixed_width * gdisp->gimage->xresolution / unit_factor;
      rect_sel->fixed_height =
        rect_sel->fixed_height * gdisp->gimage->yresolution / unit_factor;
      break;
    }

  rect_sel->fixed_width  = MAX (1, rect_sel->fixed_width);
  rect_sel->fixed_height = MAX (1, rect_sel->fixed_height);

  gimp_tool_control_activate (tool->control);
  tool->gdisp = gdisp;

  if (gimp_selection_tool_start_edit (sel_tool, coords))
    return;

  switch (sel_tool->op)
    {
    case SELECTION_ADD:
      gimp_tool_push_status (tool, _("Selection: ADD"));
      break;
    case SELECTION_SUBTRACT:
      gimp_tool_push_status (tool, _("Selection: SUBTRACT"));
      break;
    case SELECTION_INTERSECT:
      gimp_tool_push_status (tool, _("Selection: INTERSECT"));
      break;
    case SELECTION_REPLACE:
      gimp_tool_push_status (tool, _("Selection: REPLACE"));
      break;
    default:
      break;
    }

  gimp_draw_tool_start (GIMP_DRAW_TOOL (tool), gdisp);
}

static void
gimp_rect_select_tool_button_release (GimpTool        *tool,
                                      GimpCoords      *coords,
                                      guint32          time,
                                      GdkModifierType  state,
                                      GimpDisplay     *gdisp)
{
  GimpRectSelectTool *rect_sel = GIMP_RECT_SELECT_TOOL (tool);
  gdouble             x, y;
  gdouble             w, h;
  gint                ix, iy;
  gint                iw, ih;

  gimp_tool_pop_status (tool);

  gimp_draw_tool_stop (GIMP_DRAW_TOOL (tool));

  gimp_tool_control_halt (tool->control);

  /*  First take care of the case where the user "cancels" the action  */
  if (! (state & GDK_BUTTON3_MASK))
    {
      x = (rect_sel->w < 0) ? rect_sel->x + rect_sel->w : rect_sel->x;
      y = (rect_sel->h < 0) ? rect_sel->y + rect_sel->h : rect_sel->y;

      w = ABS (rect_sel->w);
      h = ABS (rect_sel->h);

      gimp_rect_select_tool_coords_to_integer (gdisp,
                                               x, y, w, h,
                                               &ix, &iy, &iw, &ih);

      if ((!rect_sel->moved || !iw || !ih)
          && rect_sel->fixed_mode == GIMP_RECT_SELECT_MODE_FREE)
        {
          /*  If there is a floating selection, anchor it  */
          if (gimp_image_floating_sel (gdisp->gimage))
            floating_sel_anchor (gimp_image_floating_sel (gdisp->gimage));
          /*  Otherwise, clear the selection mask  */
          else
            gimp_channel_clear (gimp_image_get_mask (gdisp->gimage), NULL,
                                TRUE);

          gimp_image_flush (gdisp->gimage);
          return;
        }

      gimp_rect_select_tool_rect_select (rect_sel,
                                         ix, iy, iw, ih);

      /*  show selection on all views  */
      gimp_image_flush (gdisp->gimage);
    }
}

static void
gimp_rect_select_tool_motion (GimpTool        *tool,
                              GimpCoords      *coords,
                              guint32          time,
                              GdkModifierType  state,
                              GimpDisplay     *gdisp)
{
  GimpRectSelectTool *rect_sel = GIMP_RECT_SELECT_TOOL (tool);
  GimpSelectionTool  *sel_tool = GIMP_SELECTION_TOOL (tool);
  gdouble             ox, oy;
  gdouble             w, h;
  gdouble             tw, th;
  gdouble             ratio;
  gint                ix, iy;
  gint                iw, ih;

  if (coords->x != rect_sel->x || coords->y != rect_sel->y)
    rect_sel->moved = TRUE;

  if (sel_tool->op == SELECTION_ANCHOR)
    {
      sel_tool->op = SELECTION_REPLACE;

      gimp_tool_cursor_update (tool, coords, state, gdisp);
    }

  gimp_draw_tool_pause (GIMP_DRAW_TOOL (tool));

  if (state & GDK_MOD1_MASK)
    {
      /*  Just move the selection rectangle around  */

      rect_sel->x += coords->x - rect_sel->last_coords.x;
      rect_sel->y += coords->y - rect_sel->last_coords.y;
    }
  else
    {
      /*  Change the selection rectangle's size  */

      /*  Calculate starting point  */

      if (rect_sel->center)
        {
          ox = rect_sel->x + rect_sel->w / 2.0;
          oy = rect_sel->y + rect_sel->h / 2.0;
        }
      else
        {
          ox = rect_sel->x;
          oy = rect_sel->y;
        }

      switch (rect_sel->fixed_mode)
        {
        case GIMP_RECT_SELECT_MODE_FIXED_SIZE:
          w = ((coords->x - ox) > 0 ?
               rect_sel->fixed_width  : -rect_sel->fixed_width);

          h = ((coords->y - oy) > 0 ?
               rect_sel->fixed_height : -rect_sel->fixed_height);
          break;

        case GIMP_RECT_SELECT_MODE_FIXED_RATIO:
          ratio = ((gdouble) rect_sel->fixed_height /
                   (gdouble) rect_sel->fixed_width);
          tw = (coords->x - ox);
          th = (coords->y - oy);

          /* This is probably an inefficient way to do it, but it gives
           * nicer, more predictable results than the original algorithm
           */
          if ((abs (th) < (ratio * abs (tw))) &&
              (abs (tw) > (abs (th) / ratio)))
            {
              w = tw;
              h = (tw * ratio);
              /* h should have the sign of th */
              if ((th < 0 && h > 0) || (th > 0 && h < 0))
                h = -h;
            }
          else
            {
              h = th;
              w = (th / ratio);
              /* w should have the sign of tw */
              if ((tw < 0 && w > 0) || (tw > 0 && w < 0))
                w = -w;
            }
          break;

        default:
          w = (coords->x - ox);
          h = (coords->y - oy);
          break;
        }

      /* If the shift key is down, then make the rectangle square (or
       * ellipse circular)
       */
      if ((state & GDK_SHIFT_MASK) &&
          rect_sel->fixed_mode == GIMP_RECT_SELECT_MODE_FREE)
        {
          gint s = MAX (abs (w), abs (h));

          if (w < 0)
            w = -s;
          else
            w = s;

          if (h < 0)
            h = -s;
          else
            h = s;
        }

      /*  If the control key is down, create the selection from the center out
       */
      if (state & GDK_CONTROL_MASK)
        {
          rect_sel->center = TRUE;

          switch (rect_sel->fixed_mode)
            {
            case GIMP_RECT_SELECT_MODE_FIXED_SIZE:
              rect_sel->x = ox - w / 2.0;
              rect_sel->y = oy - h / 2.0;
              rect_sel->w = w;
              rect_sel->h = h;
              break;

            case GIMP_RECT_SELECT_MODE_FIXED_RATIO:
              rect_sel->x = ox - w;
              rect_sel->y = oy - h;
              rect_sel->w = w * 2.0;
              rect_sel->h = h * 2.0;
              break;

            default:
              w = abs (w);
              h = abs (h);

              rect_sel->x = ox - w;
              rect_sel->y = oy - h;
              rect_sel->w = 2.0 * w;
              rect_sel->h = 2.0 * h;
              break;
            }
        }
      else
        {
          rect_sel->center = FALSE;

          rect_sel->x = ox;
          rect_sel->y = oy;
          rect_sel->w = w;
          rect_sel->h = h;
        }
    }

  rect_sel->last_coords = *coords;

  gimp_rect_select_tool_update_options (rect_sel, gdisp);

  gimp_tool_pop_status (tool);

  gimp_rect_select_tool_coords_to_integer (gdisp,
                                           rect_sel->x, rect_sel->y,
                                           rect_sel->w, rect_sel->h,
                                           &ix, &iy,
                                           &iw, &ih);
  gimp_tool_push_status_coords (tool,
                                _("Selection: "),
                                iw,
                                " x ",
                                ih);

  gimp_draw_tool_resume (GIMP_DRAW_TOOL (tool));
}

static void
gimp_rect_select_tool_draw (GimpDrawTool *draw_tool)
{
  GimpRectSelectTool *rect_sel = GIMP_RECT_SELECT_TOOL (draw_tool);
  gint                ix, iy;
  gint                iw, ih;

  gimp_rect_select_tool_coords_to_integer (draw_tool->gdisp,
                                           rect_sel->x, rect_sel->y,
                                           rect_sel->w, rect_sel->h,
                                           &ix, &iy,
                                           &iw, &ih);
  gimp_draw_tool_draw_rectangle (draw_tool,
                                 FALSE,
                                 ix, iy, iw, ih,
                                 FALSE);
}

static void
gimp_rect_select_tool_real_rect_select (GimpRectSelectTool *rect_tool,
                                        gint                x,
                                        gint                y,
                                        gint                w,
                                        gint                h)
{
  GimpTool             *tool     = GIMP_TOOL (rect_tool);
  GimpSelectionTool    *sel_tool = GIMP_SELECTION_TOOL (rect_tool);
  GimpSelectionOptions *options;

  options = GIMP_SELECTION_OPTIONS (tool->tool_info->tool_options);

  gimp_channel_select_rectangle (gimp_image_get_mask (tool->gdisp->gimage),
                                 x, y, w, h,
                                 sel_tool->op,
                                 options->feather,
                                 options->feather_radius,
                                 options->feather_radius);
}

void
gimp_rect_select_tool_rect_select (GimpRectSelectTool *rect_tool,
                                   gint                x,
                                   gint                y,
                                   gint                w,
                                   gint                h)
{
  GimpTool             *tool;
  GimpSelectionOptions *options;

  g_return_if_fail (GIMP_IS_RECT_SELECT_TOOL (rect_tool));

  tool    = GIMP_TOOL (rect_tool);
  options = GIMP_SELECTION_OPTIONS (tool->tool_info->tool_options);

  if (options->auto_shrink)
    {
      gint off_x = 0;
      gint off_y = 0;
      gint x2, y2;

      if (! gimp_rectangle_intersect (x, y, w, h,
                                      0, 0,
                                      tool->gdisp->gimage->width,
                                      tool->gdisp->gimage->height,
                                      &x, &y, &w, &h))
        {
          return;
        }

      if (! options->shrink_merged)
        {
          GimpItem *item;
          gint      width, height;

          item = GIMP_ITEM (gimp_image_active_drawable (tool->gdisp->gimage));

          gimp_item_offsets (item, &off_x, &off_y);
          width  = gimp_item_width  (item);
          height = gimp_item_height (item);

          if (! gimp_rectangle_intersect (x, y, w, h,
                                          off_x, off_y, width, height,
                                          &x, &y, &w, &h))
            {
              return;
            }

          x -= off_x;
          y -= off_y;
        }

      if (gimp_image_crop_auto_shrink (tool->gdisp->gimage,
                                       x, y,
                                       x + w, y + h,
                                       ! options->shrink_merged,
                                       &x, &y,
                                       &x2, &y2))
        {
          w = x2 - x;
          h = y2 - y;
        }

      x += off_x;
      y += off_y;
    }

  GIMP_RECT_SELECT_TOOL_GET_CLASS (rect_tool)->rect_select (rect_tool,
                                                            x, y, w, h);
}

static void
gimp_rect_select_tool_update_options (GimpRectSelectTool *rect_sel,
                                      GimpDisplay        *gdisp)
{
  GimpDisplayShell *shell;
  gdouble           width;
  gdouble           height;

  if (rect_sel->fixed_mode != GIMP_RECT_SELECT_MODE_FREE)
    return;

  shell = GIMP_DISPLAY_SHELL (gdisp->shell);

  if (shell->unit == GIMP_UNIT_PIXEL)
    {
      width  = fabs (rect_sel->w);
      height = fabs (rect_sel->h);
    }
  else
    {
      GimpImage *image = gdisp->gimage;

      width  = (fabs (rect_sel->w) *
                _gimp_unit_get_factor (image->gimp,
                                       shell->unit) / image->xresolution);
      height = (fabs (rect_sel->h) *
                _gimp_unit_get_factor (image->gimp,
                                       shell->unit) / image->yresolution);
    }

  g_object_set (GIMP_TOOL (rect_sel)->tool_info->tool_options,
                "fixed-width",  width,
                "fixed-height", height,
                "fixed-unit",   shell->unit,
                NULL);
}

void
gimp_rect_select_tool_coords_to_integer (GimpDisplay *gdisp,
                                         gdouble      x,
                                         gdouble      y,
                                         gdouble      w,
                                         gdouble      h,
                                         gint        *ix,
                                         gint        *iy,
                                         gint        *iw,
                                         gint        *ih)
{
  x = MIN (x, x + w);
  y = MIN (y, y + h);
  w = ABS (w);
  h = ABS (h);

  *ix = RINT (x);
  *iy = RINT (y);
  *iw = RINT (w + (x - *ix));
  *ih = RINT (h + (y - *iy));
}