PIKApp/app/actions/edit-actions.c

/* PIKA - Photo and Image Kooker Application
 * a rebranding of The GNU Image Manipulation Program (created with heckimp)
 * A derived work which may be trivial. However, any changes may be (C)2023 by Aldercone Studio
 *
 * Original copyright, applying to most contents (license remains unchanged): 
 * 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 3 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, see <https://www.gnu.org/licenses/>.
 */

#include "config.h"

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

#include "libpikawidgets/pikawidgets.h"

#include "actions-types.h"

#include "core/pika.h"
#include "core/pikachannel.h"
#include "core/pikacontext.h"
#include "core/pikaimage.h"
#include "core/pikaimage-undo.h"
#include "core/pikalayer.h"
#include "core/pikalist.h"
#include "core/pikatoolinfo.h"
#include "core/pikaundostack.h"

#include "widgets/pikaaction.h"
#include "widgets/pikaactiongroup.h"
#include "widgets/pikahelp-ids.h"

#include "tools/tool_manager.h"

#include "actions.h"
#include "edit-actions.h"
#include "edit-commands.h"

#include "pika-intl.h"


/*  local function prototypes  */

static void   edit_actions_foreground_changed (PikaContext     *context,
                                               const PikaRGB   *color,
                                               PikaActionGroup *group);
static void   edit_actions_background_changed (PikaContext     *context,
                                               const PikaRGB   *color,
                                               PikaActionGroup *group);
static void   edit_actions_pattern_changed    (PikaContext     *context,
                                               PikaPattern     *pattern,
                                               PikaActionGroup *group);


static const PikaActionEntry edit_actions[] =
{
  { "edit-undo", PIKA_ICON_EDIT_UNDO,
    NC_("edit-action", "_Undo"), NULL, { "<primary>Z", NULL },
    NC_("edit-action", "Undo the last operation"),
    edit_undo_cmd_callback,
    PIKA_HELP_EDIT_UNDO },

  { "edit-redo", PIKA_ICON_EDIT_REDO,
    NC_("edit-action", "_Redo"), NULL, { "<primary>Y", NULL },
    NC_("edit-action", "Redo the last operation that was undone"),
    edit_redo_cmd_callback,
    PIKA_HELP_EDIT_REDO },

  { "edit-strong-undo", PIKA_ICON_EDIT_UNDO,
    NC_("edit-action", "Strong Undo"), NULL, { "<primary><shift>Z", NULL },
    NC_("edit-action", "Undo the last operation, skipping visibility changes"),
    edit_strong_undo_cmd_callback,
    PIKA_HELP_EDIT_STRONG_UNDO },

  { "edit-strong-redo", PIKA_ICON_EDIT_REDO,
    NC_("edit-action", "Strong Redo"), NULL, { "<primary><shift>Y", NULL },
    NC_("edit-action",
        "Redo the last operation that was undone, skipping visibility changes"),
    edit_strong_redo_cmd_callback,
    PIKA_HELP_EDIT_STRONG_REDO },

  { "edit-undo-clear", PIKA_ICON_SHRED,
    NC_("edit-action", "_Clear Undo History"), NULL, { NULL },
    NC_("edit-action", "Remove all operations from the undo history"),
    edit_undo_clear_cmd_callback,
    PIKA_HELP_EDIT_UNDO_CLEAR },

  { "edit-cut", PIKA_ICON_EDIT_CUT,
    NC_("edit-action", "Cu_t"), NULL, { "<primary>X", "Cut", NULL },
    NC_("edit-action", "Move the selected pixels to the clipboard"),
    edit_cut_cmd_callback,
    PIKA_HELP_EDIT_CUT },

  { "edit-copy", PIKA_ICON_EDIT_COPY,
    NC_("edit-action", "_Copy"), NULL, { "<primary>C", "Copy", NULL },
    NC_("edit-action", "Copy the selected pixels to the clipboard"),
    edit_copy_cmd_callback,
    PIKA_HELP_EDIT_COPY },

  { "edit-copy-visible", NULL, /* PIKA_ICON_COPY_VISIBLE, */
    NC_("edit-action", "Copy _Visible"), NULL, { "<primary><shift>C", "<shift>Copy", NULL },
    NC_("edit-action", "Copy what is visible in the selected region"),
    edit_copy_visible_cmd_callback,
    PIKA_HELP_EDIT_COPY_VISIBLE },

  { "edit-paste-as-new-image", PIKA_ICON_EDIT_PASTE_AS_NEW,
    NC_("edit-action", "Paste as _New Image"),
    NC_("edit-action", "From _Clipboard"),
    { "<primary><shift>V", "<shift>Paste", NULL },
    NC_("edit-action", "Create a new image from the content of the clipboard"),
    edit_paste_as_new_image_cmd_callback,
    PIKA_HELP_EDIT_PASTE_AS_NEW_IMAGE },

  { "edit-named-cut", PIKA_ICON_EDIT_CUT,
    NC_("edit-action", "Cu_t Named..."), NULL, { NULL },
    NC_("edit-action", "Move the selected pixels to a named buffer"),
    edit_named_cut_cmd_callback,
    PIKA_HELP_BUFFER_CUT },

  { "edit-named-copy", PIKA_ICON_EDIT_COPY,
    NC_("edit-action", "_Copy Named..."), NULL, { NULL },
    NC_("edit-action", "Copy the selected pixels to a named buffer"),
    edit_named_copy_cmd_callback,
    PIKA_HELP_BUFFER_COPY },

  { "edit-named-copy-visible", NULL, /* PIKA_ICON_COPY_VISIBLE, */
    NC_("edit-action", "Copy _Visible Named..."), NULL, { NULL },
    NC_("edit-action",
        "Copy what is visible in the selected region to a named buffer"),
    edit_named_copy_visible_cmd_callback,
    PIKA_HELP_BUFFER_COPY },

  { "edit-named-paste", PIKA_ICON_EDIT_PASTE,
    NC_("edit-action", "_Paste Named..."), NULL, { NULL },
    NC_("edit-action", "Paste the content of a named buffer"),
    edit_named_paste_cmd_callback,
    PIKA_HELP_BUFFER_PASTE },

  { "edit-clear", PIKA_ICON_EDIT_CLEAR,
    NC_("edit-action", "Cl_ear"), NULL, { "Delete", NULL },
    NC_("edit-action", "Clear the selected pixels"),
    edit_clear_cmd_callback,
    PIKA_HELP_EDIT_CLEAR }
};

static const PikaEnumActionEntry edit_paste_actions[] =
{
  { "edit-paste", PIKA_ICON_EDIT_PASTE,
    NC_("edit-action", "_Paste"), NULL, { "<primary>V", "Paste", NULL },
    NC_("edit-action", "Paste the content of the clipboard"),
    PIKA_PASTE_TYPE_NEW_LAYER_OR_FLOATING, FALSE,
    PIKA_HELP_EDIT_PASTE },

  { "edit-paste-in-place", PIKA_ICON_EDIT_PASTE,
    NC_("edit-action", "Paste In P_lace"), NULL, { "<primary><alt>V", "<alt>Paste", NULL },
    NC_("edit-action",
        "Paste the content of the clipboard at its original position"),
    PIKA_PASTE_TYPE_NEW_LAYER_OR_FLOATING_IN_PLACE, FALSE,
    PIKA_HELP_EDIT_PASTE_IN_PLACE },

  { "edit-paste-merged", PIKA_ICON_EDIT_PASTE,
    NC_("edit-action", "_Paste as Single Layer"), NULL, { NULL },
    NC_("edit-action", "Paste the content of the clipboard as a single layer"),
    PIKA_PASTE_TYPE_NEW_MERGED_LAYER_OR_FLOATING, FALSE,
    PIKA_HELP_EDIT_PASTE },

  { "edit-paste-merged-in-place", PIKA_ICON_EDIT_PASTE,
    NC_("edit-action", "Paste as Single Layer In P_lace"), NULL, { NULL },
    NC_("edit-action",
        "Paste the content of the clipboard at its original position as a single layer"),
    PIKA_PASTE_TYPE_NEW_MERGED_LAYER_OR_FLOATING_IN_PLACE, FALSE,
    PIKA_HELP_EDIT_PASTE_IN_PLACE },

  { "edit-paste-into", PIKA_ICON_EDIT_PASTE_INTO,
    NC_("edit-action", "Paste as Floating Data _Into Selection"), NULL, { NULL },
    NC_("edit-action",
        "Paste the content of the clipboard into the current selection"),
    PIKA_PASTE_TYPE_FLOATING_INTO, FALSE,
    PIKA_HELP_EDIT_PASTE_INTO },

  { "edit-paste-into-in-place", PIKA_ICON_EDIT_PASTE_INTO,
    NC_("edit-action", "Paste as Floating Data Int_o Selection In Place"), NULL, { NULL },
    NC_("edit-action",
        "Paste the content of the clipboard into the current selection "
        "at its original position"),
    PIKA_PASTE_TYPE_FLOATING_INTO_IN_PLACE, FALSE,
    PIKA_HELP_EDIT_PASTE_INTO_IN_PLACE },

  { "edit-paste-float", PIKA_ICON_EDIT_PASTE,
    NC_("edit-action", "Paste as _Floating Data"), NULL, { NULL },
    NC_("edit-action", "Paste the content of the clipboard as Floating Data"),
    PIKA_PASTE_TYPE_FLOATING, FALSE,
    PIKA_HELP_EDIT_PASTE },

  { "edit-paste-float-in-place", PIKA_ICON_EDIT_PASTE,
    NC_("edit-action", "Paste as Floa_ting Data In Place"), NULL, { NULL },
    NC_("edit-action", "Paste the content of the clipboard as Floating Data at its original position"),
    PIKA_PASTE_TYPE_FLOATING_IN_PLACE, FALSE,
    PIKA_HELP_EDIT_PASTE }
};

static const PikaEnumActionEntry edit_fill_actions[] =
{
  { "edit-fill-fg", PIKA_ICON_TOOL_BUCKET_FILL,
    NC_("edit-action", "Fill with _FG Color"), NULL, { "<primary>comma", NULL },
    NC_("edit-action", "Fill the selection using the foreground color"),
    PIKA_FILL_FOREGROUND, FALSE,
    PIKA_HELP_EDIT_FILL_FG },

  { "edit-fill-bg", PIKA_ICON_TOOL_BUCKET_FILL,
    NC_("edit-action", "Fill with B_G Color"), NULL, { "<primary>period", NULL },
    NC_("edit-action", "Fill the selection using the background color"),
    PIKA_FILL_BACKGROUND, FALSE,
    PIKA_HELP_EDIT_FILL_BG },

  { "edit-fill-pattern", PIKA_ICON_PATTERN,
    NC_("edit-action", "Fill _with Pattern"), NULL, { "<primary>semicolon", NULL },
    NC_("edit-action", "Fill the selection using the active pattern"),
    PIKA_FILL_PATTERN, FALSE,
    PIKA_HELP_EDIT_FILL_PATTERN }
};


void
edit_actions_setup (PikaActionGroup *group)
{
  PikaContext *context = pika_get_user_context (group->pika);
  PikaRGB      color;
  PikaPattern *pattern;

  pika_action_group_add_actions (group, "edit-action",
                                 edit_actions,
                                 G_N_ELEMENTS (edit_actions));

  pika_action_group_add_enum_actions (group, "edit-action",
                                      edit_paste_actions,
                                      G_N_ELEMENTS (edit_paste_actions),
                                      edit_paste_cmd_callback);

  pika_action_group_add_enum_actions (group, "edit-action",
                                      edit_fill_actions,
                                      G_N_ELEMENTS (edit_fill_actions),
                                      edit_fill_cmd_callback);

  g_signal_connect_object (context, "foreground-changed",
                           G_CALLBACK (edit_actions_foreground_changed),
                           group, 0);
  g_signal_connect_object (context, "background-changed",
                           G_CALLBACK (edit_actions_background_changed),
                           group, 0);
  g_signal_connect_object (context, "pattern-changed",
                           G_CALLBACK (edit_actions_pattern_changed),
                           group, 0);

  pika_context_get_foreground (context, &color);
  edit_actions_foreground_changed (context, &color, group);

  pika_context_get_background (context, &color);
  edit_actions_background_changed (context, &color, group);

  pattern = pika_context_get_pattern (context);
  edit_actions_pattern_changed (context, pattern, group);
}

void
edit_actions_update (PikaActionGroup *group,
                     gpointer         data)
{
  PikaImage    *image        = action_data_get_image (data);
  PikaDisplay  *display      = action_data_get_display (data);
  GList        *drawables    = NULL;
  gchar        *undo_name    = NULL;
  gchar        *redo_name    = NULL;
  gboolean      undo_enabled = FALSE;

  gboolean      have_no_groups = FALSE; /* At least 1 selected layer is not a group.         */
  gboolean      have_writable  = FALSE; /* At least 1 selected layer has no contents lock.   */

  if (image)
    {
      GList *iter;

      drawables = pika_image_get_selected_drawables (image);

      for (iter = drawables; iter; iter = iter->next)
        {
          if (! pika_viewable_get_children (PIKA_VIEWABLE (iter->data)))
            have_no_groups = TRUE;

          if (! pika_item_is_content_locked (PIKA_ITEM (iter->data), NULL))
            have_writable = TRUE;

          if (have_no_groups && have_writable)
            break;
        }

      undo_enabled = pika_image_undo_is_enabled (image);

      if (undo_enabled)
        {
          PikaUndoStack *undo_stack = pika_image_get_undo_stack (image);
          PikaUndoStack *redo_stack = pika_image_get_redo_stack (image);
          PikaUndo      *undo       = pika_undo_stack_peek (undo_stack);
          PikaUndo      *redo       = pika_undo_stack_peek (redo_stack);
          const gchar   *tool_undo  = NULL;
          const gchar   *tool_redo  = NULL;

          if (display)
            {
              tool_undo = tool_manager_can_undo_active (image->pika, display);
              tool_redo = tool_manager_can_redo_active (image->pika, display);
            }

          if (tool_undo)
            undo_name = g_strdup_printf (_("_Undo %s"), tool_undo);
          else if (undo)
            undo_name = g_strdup_printf (_("_Undo %s"),
                                         pika_object_get_name (undo));

          if (tool_redo)
            redo_name = g_strdup_printf (_("_Redo %s"), tool_redo);
          else if (redo)
            redo_name = g_strdup_printf (_("_Redo %s"),
                                         pika_object_get_name (redo));
        }
    }


#define SET_LABEL(action,label) \
        pika_action_group_set_action_label (group, action, (label))
#define SET_SENSITIVE(action,condition) \
        pika_action_group_set_action_sensitive (group, action, (condition) != 0, NULL)

  SET_LABEL ("edit-undo", undo_name ? undo_name : _("_Undo"));
  SET_LABEL ("edit-redo", redo_name ? redo_name : _("_Redo"));

  SET_SENSITIVE ("edit-undo",        undo_enabled && undo_name);
  SET_SENSITIVE ("edit-redo",        undo_enabled && redo_name);
  SET_SENSITIVE ("edit-strong-undo", undo_enabled && undo_name);
  SET_SENSITIVE ("edit-strong-redo", undo_enabled && redo_name);
  SET_SENSITIVE ("edit-undo-clear",  undo_enabled && (undo_name || redo_name));

  g_free (undo_name);
  g_free (redo_name);

  SET_SENSITIVE ("edit-cut",                         have_writable && have_no_groups);
  SET_SENSITIVE ("edit-copy",                        drawables);
  SET_SENSITIVE ("edit-copy-visible",                image);
  /*             "edit-paste" is always active */
  SET_SENSITIVE ("edit-paste-in-place",              image);
  SET_SENSITIVE ("edit-paste-into",                  image);
  SET_SENSITIVE ("edit-paste-into-in-place",         image);

  SET_SENSITIVE ("edit-named-cut",          have_writable && have_no_groups);
  SET_SENSITIVE ("edit-named-copy",         drawables);
  SET_SENSITIVE ("edit-named-copy-visible", drawables);
  /*             "edit-named-paste" is always active */

  SET_SENSITIVE ("edit-clear",              have_writable && have_no_groups);
  SET_SENSITIVE ("edit-fill-fg",            have_writable && have_no_groups);
  SET_SENSITIVE ("edit-fill-bg",            have_writable && have_no_groups);
  SET_SENSITIVE ("edit-fill-pattern",       have_writable && have_no_groups);

#undef SET_LABEL
#undef SET_SENSITIVE

  g_list_free (drawables);
}


/*  private functions  */

static void
edit_actions_foreground_changed (PikaContext     *context,
                                 const PikaRGB   *color,
                                 PikaActionGroup *group)
{
  pika_action_group_set_action_color (group, "edit-fill-fg", color, FALSE);
}

static void
edit_actions_background_changed (PikaContext     *context,
                                 const PikaRGB   *color,
                                 PikaActionGroup *group)
{
  pika_action_group_set_action_color (group, "edit-fill-bg", color, FALSE);
}

static void
edit_actions_pattern_changed (PikaContext     *context,
                              PikaPattern     *pattern,
                              PikaActionGroup *group)
{
  pika_action_group_set_action_viewable (group, "edit-fill-pattern",
                                         PIKA_VIEWABLE (pattern));
}