gimp/app/undo_history.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995-1999 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.
 *
 * Undo history browser by Austin Donnelly <austin@gimp.org>
 */


/* TODO:
 *
 *  - previews of the image on each line (reuse the L&C previews?)
 *
 *  - work out which (if any) is the clean image, and mark it as such
 *         (eg floppy disk icon) Currently, its a "*" and it's on the
 *         wrong line.
 *
 *  - scroll to keep current selection visible.  Can some GTK guru
 *         help out?
 *
 *  - window looks butt-ugly.  As usual, my (lack) of graphic design
 *         skills are showing through.  Someone please prettify it!
 *
 *  - undo names are less than useful.  This isn't a problem with
 *         undo_history.c itself, more with the rather chaotic way
 *         people have of picking an undo type when pushing undos, and
 *         inconsistent use of undo groups.  Maybe rather than
 *         specifying an (enum) type, it should be a const char * ?
 *
 * BUGS:
 *  - clean star in wrong place
 *  - window title not updated on image title change
 *
 *  Initial rev 0.01, (c) 19 Sept 1999 Austin Donnelly <austin@gimp.org>
 *
 */


#include <gtk/gtk.h>
#include "undo.h"
#include "actionarea.h"

#include "libgimp/gimpintl.h"




typedef struct {
    GImage    *gimage;		/* image we're tracking undo info for */
    GtkWidget *shell;		/* dialog window */
    GtkWidget *clist;		/* list of undo actions */
    GtkWidget *undo_button;	/* button to undo an operation */
    GtkWidget *redo_button;	/* button to redo an operation */
    int        old_selection;   /* previous selection in the clist */
} undo_history_st;



/*
 * Theory of operation.
 *
 * Keep a clist.  Each row of the clist corresponds to an image as it
 * was at some time in the past, present or future.  The selected row
 * is the present image.  Rows below the selected one are in the
 * future - as redo operations are performed, they become the current
 * image.  Rows above the selected one are in the past - undo
 * operations move the highlight up.
 *
 * The slight fly in the ointment is that if rows are images, then how
 * should they be labelled?  An undo or redo operation goes _between_
 * two image states - it isn't an image state.  It's a pretty
 * arbitrary decision, but I've chosen to label a row with the name of
 * the action that brought the image into the state represented by
 * that row.  Thus, there is a special first row without a meaningful
 * label, which represents the image state before the first action has
 * been done to it.  The choice is between a special first row or a
 * special last row.  Since people mostly work near the leading edge,
 * not often going all the way back, I've chosen to put the special
 * case out of common sight.
 *
 * So, the undo stack contents appear above the selected row, and the
 * redo stack below it.
 *
 * The clist is initialised by mapping over the undo and redo stack.
 *
 * Once initialised, the dialog listens to undo_event signals from the
 * gimage.  These undo events allow us to track changes to the undo
 * and redo stacks.  We follow the events, making parallel changes to
 * the clist.  If we ever get out of sync, there is no mechanism to
 * notice or re-sync.  A few g_return_if_fails should catch some of
 * these cases.
 *
 * User clicks changing the selected row in the clist turn into
 * multiple calls to undo_pop or undo_redo, with appropriate signals
 * blocked so we don't get our own events back.
 *
 * The "Close" button hides the dialog, rather than destroying it.
 * This may well need to be changed, since the dialog will continue to
 * track updates, and if it's generating previews this might take too
 * long for large images.
 *
 * The dialog is destroyed when the gimage it is tracking is
 * destroyed.  Note that a File/Revert destroys the current gimage and
 * so blows the undo/redo stacks.
 *
 * --austin, 19/9/1999
 */


/**************************************************************/
/* Local functions */


/* close button clicked */
static void
undo_history_close_callback (GtkWidget *w,
			     gpointer   data)
{
    undo_history_st *st = data;
    gtk_widget_hide (GTK_WIDGET (st->shell));
}

/* WM_DELETE */
static gint
undo_history_delete_callback (GtkWidget *w,
			      GdkEvent *e,
			      gpointer data)
{
    undo_history_close_callback (w, data);
    return TRUE;
}


static ActionAreaItem action_items[] =
{
  { N_("Close"), undo_history_close_callback, NULL, NULL }
};




/* The gimage and shell destroy callbacks are split so we can:
 *   a) blow the shell when the image dissappears
 *   b) disconnect from the image if the shell dissappears (we don't
 *        want signals from the image to carry on using "st" once it's
 *        been freed.
 */

/* gimage destroyed */
static void
undo_history_gimage_destroy_callback (GtkWidget *w, gpointer data)
{
    undo_history_st *st = data;

    st->gimage = NULL;  /* not allowed to use this any more */
    gtk_widget_destroy (GTK_WIDGET (st->shell));
    /* which continues in the function below: */
}

static void
undo_history_shell_destroy_callback (GtkWidget *w, gpointer data)
{
    undo_history_st *st = data;

    if (st->gimage)
	gtk_signal_disconnect_by_data (GTK_OBJECT (st->gimage), st);
    g_free (st);
}



/* undo button clicked */
static void
undo_history_undo_callback (GtkWidget *widget, gpointer data)
{
    undo_history_st *st = data;

    undo_pop (st->gimage);
}

/* redo button clicked */
static void
undo_history_redo_callback (GtkWidget *widget, gpointer data)
{
    undo_history_st *st = data;

    undo_redo (st->gimage);
}




/* Always start clist with dummy entry for image state before
 * the first action on the undo stack */
static void
undo_history_append_special (GtkCList *clist)
{
    char *name = _("[ base image ]");
    char *namelist[] = { NULL, name };

    gtk_clist_append (clist, namelist);
}



/* Recalculate which of the undo and redo buttons are meant to be sensitive */
static void
undo_history_set_sensitive (undo_history_st *st, int rows)
{
    gtk_widget_set_sensitive (st->undo_button, (st->old_selection != 0));
    gtk_widget_set_sensitive (st->redo_button, (st->old_selection != rows-1));
}


/* Track undo_event signals, telling us of changes to the undo and
 * redo stacks. */
static void
undo_history_undo_event (GtkWidget *widget, int ev, gpointer data)
{
    undo_history_st *st = data;
    undo_event_t event = ev;
    const char *name;
    char *namelist[2];
    GList *list;
    int cur_selection;
    GtkCList *clist;

    list = GTK_CLIST(st->clist)->selection;
    g_return_if_fail (list != NULL);
    cur_selection = GPOINTER_TO_INT (list->data);

    clist = GTK_CLIST (st->clist); 

    /* block select events */
    gtk_signal_handler_block_by_data (GTK_OBJECT (st->clist), st);

    switch (event) {
    case UNDO_PUSHED:
	/* clip everything after the current selection (ie, the
         * actions that are from the redo stack) */
	gtk_clist_freeze (clist);
	while (clist->rows > cur_selection + 1)
	    gtk_clist_remove (clist, cur_selection + 1);

	/* find out what's new */
	name = undo_get_undo_name (st->gimage);
	namelist[0] = NULL;
	namelist[1] = (char *) name;
	gtk_clist_append (clist, namelist);

	g_assert (clist->rows == cur_selection+2);

	/* always force selection to bottom, and scroll to it */
	gtk_clist_select_row (clist, clist->rows-1, -1);
	gtk_clist_moveto (clist, clist->rows-1, 0, 1.0, 0.0);
	gtk_clist_thaw (clist);
	cur_selection = clist->rows-1;
	break;


    case UNDO_EXPIRED:
	/* remove earliest row, but not our special first one */
	gtk_clist_remove (clist, 1);
	break;


    case UNDO_POPPED:
	/* move hilight up one */
	g_return_if_fail (cur_selection >= 1);
	gtk_clist_select_row (clist, cur_selection-1, -1);
	cur_selection--;
	break;

 
    case UNDO_REDO:
	/* move hilight down one */
	g_return_if_fail (cur_selection+1 < clist->rows);
	gtk_clist_select_row (clist, cur_selection+1, -1);
	cur_selection++;
	break;


    case UNDO_FREE:
	/* clear all info other that the special first line */
	gtk_clist_freeze (clist);
	gtk_clist_clear (clist);
	undo_history_append_special (clist);
	gtk_clist_thaw (clist);
	cur_selection = 0;
	break;
    }

    gtk_signal_handler_unblock_by_data (GTK_OBJECT (st->clist), st);

    st->old_selection = cur_selection;
    undo_history_set_sensitive (st, clist->rows);
}



static void
undo_history_select_row_callback (GtkWidget *w,
				  gint row, gint column, gpointer event,
				  gpointer data)
{
    undo_history_st *st = data;
    int cur_selection;

    cur_selection = row;

    if (cur_selection == st->old_selection)
	return;

    /* Disable undo_event signals while we do these multiple undo or
     * redo actions. */
    gtk_signal_handler_block_by_func (GTK_OBJECT (st->gimage),
				      undo_history_undo_event, st);

    while (cur_selection < st->old_selection)
    {
	undo_pop (st->gimage);
	st->old_selection--;
    }
    while (cur_selection > st->old_selection)
    {
	undo_redo (st->gimage);
	st->old_selection++;
    }

    gtk_signal_handler_unblock_by_func (GTK_OBJECT (st->gimage),
					undo_history_undo_event, st);    

    undo_history_set_sensitive (st, GTK_CLIST(st->clist)->rows);
}


static void
undo_history_clean_callback (GtkWidget *w, gpointer data)
{
    undo_history_st *st = data;
    int i;
    int nrows;
    GtkCList *clist;

    if (st->gimage->dirty != 0)
	return;

    /* The image is clean, so this is the version on disc.  Remove the
     * clean star from all other entries, and add it to the current
     * one. */

    /* XXX currently broken, since "clean" signal is emitted before
     * UNDO_POPPED event.  I don't want to change the order of the
     * signals.  So I'm a little stuck. --austin */

    clist = GTK_CLIST (st->clist);
    nrows = clist->rows;

    gtk_clist_freeze (clist);
    for (i=0; i < nrows; i++)
	gtk_clist_set_text (clist, i, 0, NULL);
    gtk_clist_set_text (clist, st->old_selection, 0, "*");
    gtk_clist_thaw (clist);
}



/* Used to build up initial contents of clist */
static int
undo_history_init_undo (const char *undoitemname, void *data)
{
    undo_history_st *st = data;
    char *namelist[2];

    namelist[0] = NULL;
    namelist[1] = (char *) undoitemname;
    gtk_clist_append (GTK_CLIST (st->clist), namelist);

    /* force selection to bottom */
    gtk_clist_select_row (GTK_CLIST (st->clist),
			  GTK_CLIST (st->clist)->rows - 1, -1);
    st->old_selection = GTK_CLIST(st->clist)->rows - 1;

    return 0;
}

/* Ditto, but doesn't change selection */
static int
undo_history_init_redo (const char *undoitemname, void *data)
{
    undo_history_st *st = data;
    char *namelist[2];

    namelist[0] = NULL;
    namelist[1] = (char *) undoitemname;
    gtk_clist_append (GTK_CLIST (st->clist), namelist);

    return 0;
}





/*************************************************************/
/* Publicly exported function */

GtkWidget *
undo_history_new (GImage *gimage)
{
    undo_history_st *st;
    GtkWidget *vbox;
    GtkWidget *hbox;
    GtkWidget *button;
    GtkWidget *scrolled_win;

    st = g_new0 (undo_history_st, 1);
    st->gimage = gimage;

    /* gimage signals */
    gtk_signal_connect (GTK_OBJECT (gimage), "undo_event",
			undo_history_undo_event, st);
    gtk_signal_connect (GTK_OBJECT (gimage), "destroy",
			undo_history_gimage_destroy_callback, st);
    gtk_signal_connect (GTK_OBJECT (gimage), "clean",
			undo_history_clean_callback, st);

    /*  The shell and main vbox  */
    st->shell = gtk_dialog_new ();

    gtk_window_set_wmclass (GTK_WINDOW (st->shell), "undohistory", "Gimp");
    gtk_window_set_policy (GTK_WINDOW (st->shell), FALSE, TRUE, FALSE);

    {
	char *title = g_strdup_printf (_("%s: undo history"),
				       g_basename (gimage_filename (gimage)));
	gtk_window_set_title (GTK_WINDOW (st->shell), title);
	g_free (title);
    }

    vbox = gtk_vbox_new (FALSE, 1);
    gtk_container_set_border_width (GTK_CONTAINER (vbox), 1);
    gtk_box_pack_start (GTK_BOX (GTK_DIALOG (st->shell)->vbox),
			vbox, TRUE, TRUE, 0);
    gtk_widget_show (vbox);

    /* handle the wm close event */
    gtk_signal_connect (GTK_OBJECT (st->shell), "delete_event",
			GTK_SIGNAL_FUNC (undo_history_delete_callback), st);
    gtk_signal_connect (GTK_OBJECT (st->shell), "destroy",
			GTK_SIGNAL_FUNC (undo_history_shell_destroy_callback),
			st);
    
    scrolled_win = gtk_scrolled_window_new (NULL, NULL);

    /* clist of undo actions */
    st->clist = gtk_clist_new (2);
    gtk_clist_set_shadow_type (GTK_CLIST (st->clist), GTK_SHADOW_IN);
    gtk_clist_set_selection_mode (GTK_CLIST (st->clist), GTK_SELECTION_BROWSE);
    gtk_clist_set_reorderable (GTK_CLIST (st->clist), FALSE);
    gtk_clist_set_column_width (GTK_CLIST (st->clist), 0, 52);
    undo_history_append_special (GTK_CLIST (st->clist));

    /* work out the initial contents */
    undo_map_over_undo_stack (st->gimage, undo_history_init_undo, st);
    undo_map_over_redo_stack (st->gimage, undo_history_init_redo, st);

    st->old_selection = GPOINTER_TO_INT(GTK_CLIST(st->clist)->selection->data);

    gtk_signal_connect (GTK_OBJECT (st->clist), "select_row",
			undo_history_select_row_callback, st);
    
    gtk_widget_show (GTK_WIDGET (st->clist));

    gtk_box_pack_start (GTK_BOX (vbox), scrolled_win, TRUE, TRUE, 0);
    gtk_widget_show (GTK_WIDGET (scrolled_win));
    gtk_container_add (GTK_CONTAINER (scrolled_win), st->clist);
    gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolled_win),
				    GTK_POLICY_AUTOMATIC,
				    GTK_POLICY_ALWAYS);

    hbox = gtk_hbox_new (FALSE, 8);
    gtk_container_set_border_width (GTK_CONTAINER (hbox), 0);
    gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
    gtk_widget_show (hbox);

    button = gtk_button_new_with_label (_("<< Undo"));
    st->undo_button = button;
    gtk_widget_show (GTK_WIDGET (button));
    gtk_signal_connect (GTK_OBJECT (button), "clicked",
			undo_history_undo_callback, st);
    gtk_box_pack_start (GTK_BOX (hbox), button, TRUE, TRUE, 0);

    button = gtk_button_new_with_label (_("Redo >>"));
    st->redo_button = button;
    gtk_widget_show (GTK_WIDGET (button));
    gtk_signal_connect (GTK_OBJECT (button), "clicked",
			undo_history_redo_callback, st);
    gtk_box_pack_start (GTK_BOX (hbox), button, TRUE, TRUE, 0);

    action_items[0].user_data = st;
    build_action_area (GTK_DIALOG (st->shell), action_items, 1, 0);

    undo_history_set_sensitive (st, GTK_CLIST (st->clist)->rows);

    gtk_widget_show (GTK_WIDGET (st->shell));

    return st->shell;
}