src/undo.c

   1 /*
   2  * undo.c:
   3  *
   4  * Authors:
   5  * Andreas J. Guelzow  <aguelzow@pyrshep.ca>
   6  *
   7  * (C) Copyright 2010 by Andreas J. Guelzow  <aguelzow@pyrshep.ca>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, see <https://www.gnu.org/licenses/>.
  21  */
  22
  23 #include <gnumeric-config.h>
  24
  25 #include <undo.h>
  26 #include <sheet.h>
  27 #include <sheet-view.h>
  28 #include <sheet-control-gui.h>
  29 #include <wbc-gtk.h>
  30 #include <wbc-gtk-impl.h>
  31 #include <colrow.h>
  32
  33 #include <gsf/gsf-impl-utils.h>
  34 #include <glib/gi18n-lib.h>
  35
  36 /* ------------------------------------------------------------------------- */
  37
  38 static GObjectClass *gnm_undo_colrow_restore_state_group_parent_class;
  39
  40 static void
  41 gnm_undo_colrow_restore_state_group_finalize (GObject *o)
  42 {
  43         GnmUndoColrowRestoreStateGroup *ua = (GnmUndoColrowRestoreStateGroup *)o;
  44
  45         colrow_state_group_destroy (ua->saved_state);
  46         ua->saved_state = NULL;
  47         colrow_index_list_destroy (ua->selection);
  48         ua->selection = NULL;
  49
  50         G_OBJECT_CLASS (gnm_undo_colrow_restore_state_group_parent_class)->finalize (o);
  51 }
  52
  53 static void
  54 gnm_undo_colrow_restore_state_group_undo (GOUndo *u, G_GNUC_UNUSED gpointer data)
  55 {
  56         GnmUndoColrowRestoreStateGroup *ua = (GnmUndoColrowRestoreStateGroup *)u;
  57
  58         colrow_restore_state_group (ua->sheet, ua->is_cols, ua->selection, ua->saved_state);
  59 }
  60
  61 static void
  62 gnm_undo_colrow_restore_state_group_class_init (GObjectClass *gobject_class)
  63 {
  64         GOUndoClass *uclass = (GOUndoClass *)gobject_class;
  65
  66         gnm_undo_colrow_restore_state_group_parent_class = g_type_class_peek_parent (gobject_class);
  67
  68         gobject_class->finalize = gnm_undo_colrow_restore_state_group_finalize;
  69         uclass->undo = gnm_undo_colrow_restore_state_group_undo;
  70 }
  71
  72
  73 GSF_CLASS (GnmUndoColrowRestoreStateGroup, gnm_undo_colrow_restore_state_group,
  74            gnm_undo_colrow_restore_state_group_class_init, NULL, GO_TYPE_UNDO)
  75
  76 /**
  77  * gnm_undo_colrow_restore_state_group_new:
  78  *
  79  * Returns: a new undo object.
  80  **/
  81
  82 GOUndo *
  83 gnm_undo_colrow_restore_state_group_new (Sheet *sheet, gboolean is_cols,
  84                                         ColRowIndexList *selection,
  85                                         ColRowStateGroup *saved_state)
  86 {
  87         GnmUndoColrowRestoreStateGroup *ua = g_object_new (GNM_TYPE_UNDO_COLROW_RESTORE_STATE_GROUP, NULL);
  88
  89         ua->sheet = sheet;
  90         ua->is_cols = is_cols;
  91         ua->selection = selection;
  92         ua->saved_state = saved_state;
  93
  94         return (GOUndo *)ua;
  95 }
  96
  97 /* ------------------------------------------------------------------------- */
  98
  99 static GObjectClass *gnm_undo_colrow_set_sizes_parent_class;
 100
 101 static void
 102 gnm_undo_colrow_set_sizes_finalize (GObject *o)
 103 {
 104         GnmUndoColrowSetSizes *ua = (GnmUndoColrowSetSizes *)o;
 105
 106         colrow_index_list_destroy (ua->selection);
 107         ua->selection = NULL;
 108
 109         G_OBJECT_CLASS (gnm_undo_colrow_set_sizes_parent_class)->finalize (o);
 110 }
 111
 112 static void
 113 gnm_undo_colrow_set_sizes_undo (GOUndo *u, G_GNUC_UNUSED gpointer data)
 114 {
 115         GnmUndoColrowSetSizes *ua = (GnmUndoColrowSetSizes *)u;
 116         ColRowStateGroup *group;
 117
 118         group = colrow_set_sizes (ua->sheet, ua->is_cols, ua->selection, ua->new_size,
 119                                   ua->from, ua->to);
 120         colrow_state_group_destroy (group);
 121 }
 122
 123 static void
 124 gnm_undo_colrow_set_sizes_class_init (GObjectClass *gobject_class)
 125 {
 126         GOUndoClass *uclass = (GOUndoClass *)gobject_class;
 127
 128         gnm_undo_colrow_set_sizes_parent_class = g_type_class_peek_parent (gobject_class);
 129
 130         gobject_class->finalize = gnm_undo_colrow_set_sizes_finalize;
 131         uclass->undo = gnm_undo_colrow_set_sizes_undo;
 132 }
 133
 134
 135 GSF_CLASS (GnmUndoColrowSetSizes, gnm_undo_colrow_set_sizes,
 136            gnm_undo_colrow_set_sizes_class_init, NULL, GO_TYPE_UNDO)
 137
 138 /**
 139  * gnm_undo_colrow_set_sizes_new:
 140  *
 141  * If r is non-null and new_size < 0, selection is ignored.
 142  *
 143  * Returns: a new undo object.
 144  **/
 145
 146 GOUndo *
 147 gnm_undo_colrow_set_sizes_new (Sheet *sheet, gboolean is_cols,
 148                                ColRowIndexList *selection,
 149                                int new_size, GnmRange const *r)
 150 {
 151         GnmUndoColrowSetSizes *ua;
 152
 153         g_return_val_if_fail (selection != NULL || (r != NULL && new_size == -1), NULL);
 154
 155         ua = g_object_new (GNM_TYPE_UNDO_COLROW_SET_SIZES, NULL);
 156
 157         ua->sheet = sheet;
 158         ua->is_cols = is_cols;
 159         ua->new_size = new_size;
 160
 161         if (r == NULL || new_size >= 0) {
 162                 ua->selection = selection;
 163                 ua->from = 0;
 164                 ua->to = -1;
 165         } else {
 166                 int first, last;
 167
 168                 if (is_cols) {
 169                         first = r->start.col;
 170                         last = r->end.col;
 171                         ua->from =  r->start.row;
 172                         ua->to = r->end.row;
 173                 } else {
 174                         first = r->start.row;
 175                         last = r->end.row;
 176                         ua->from =  r->start.col;
 177                         ua->to = r->end.col;
 178                 }
 179                 ua->selection = colrow_get_index_list (first, last, NULL);
 180         }
 181
 182         return (GOUndo *)ua;
 183 }
 184
 185 /* ------------------------------------------------------------------------- */
 186
 187 static GObjectClass *gnm_undo_filter_set_condition_parent_class;
 188
 189 static void
 190 gnm_undo_filter_set_condition_finalize (GObject *o)
 191 {
 192         GnmUndoFilterSetCondition *ua = (GnmUndoFilterSetCondition *)o;
 193
 194         gnm_filter_condition_free (ua->cond);
 195         ua->cond = NULL;
 196
 197         G_OBJECT_CLASS (gnm_undo_filter_set_condition_parent_class)->finalize (o);
 198 }
 199
 200 static gboolean
 201 cb_filter_set_condition_undo (GnmColRowIter const *iter, gint *count)
 202 {
 203         if (iter->cri->visible)
 204                 (*count)++;
 205         return FALSE;
 206 }
 207
 208 static void
 209 cb_filter_set_condition_undo_set_pb (SheetControl *control, char *text)
 210 {
 211         SheetControlGUI *scg = (SheetControlGUI *) control;
 212         WBCGtk *wbcg = scg_wbcg (scg);
 213         if (wbcg != NULL)
 214                 gtk_progress_bar_set_text
 215                         (GTK_PROGRESS_BAR (wbcg->progress_bar), text);
 216 }
 217
 218 static void
 219 gnm_undo_filter_set_condition_undo (GOUndo *u, G_GNUC_UNUSED gpointer data)
 220 {
 221         GnmUndoFilterSetCondition *ua = (GnmUndoFilterSetCondition *)u;
 222         gint count = 0;
 223         char const *format;
 224         char *text;
 225
 226         gnm_filter_set_condition (ua->filter, ua->i,
 227                                   gnm_filter_condition_dup (ua->cond), TRUE);
 228         sheet_update (ua->filter->sheet);
 229
 230         sheet_colrow_foreach (ua->filter->sheet, FALSE,
 231                         ua->filter->r.start.row + 1,
 232                         ua->filter->r.end.row,
 233                         (ColRowHandler) cb_filter_set_condition_undo,
 234                         &count);
 235         if (ua->filter->r.end.row - ua->filter->r.start.row > 10) {
 236                 /* xgettext: The first %d gives the number of rows that match. */
 237                 /* The second %d gives the total number of rows. Assume that the */
 238                 /* total number of rows is always large (>10). */
 239                 /* Note that the english "matches" or "match" is the verb of this sentence! */
 240                 /* There is no explicit noun associated with the second %d in english, the */
 241                 /* meaning is really "%d rows of all %d rows match" */
 242                 /* This is input to ngettext. */
 243                 format = ngettext ("%d row of %d matches",
 244                                    "%d rows of %d match",
 245                                    count);
 246                 text = g_strdup_printf (format, count,
 247                                         ua->filter->r.end.row -
 248                                         ua->filter->r.start.row);
 249         } else {
 250                 /* xgettext: The %d gives the number of rows that match. */
 251                 /* This is input to ngettext. */
 252                 format = ngettext ("%d row matches",
 253                                    "%d rows match",
 254                                    count);
 255                 text = g_strdup_printf (format, count);
 256         }
 257
 258         SHEET_FOREACH_CONTROL (ua->filter->sheet, view, control, cb_filter_set_condition_undo_set_pb (control, text););
 259
 260         g_free (text);
 261 }
 262
 263 static void
 264 gnm_undo_filter_set_condition_class_init (GObjectClass *gobject_class)
 265 {
 266         GOUndoClass *uclass = (GOUndoClass *)gobject_class;
 267
 268         gnm_undo_filter_set_condition_parent_class = g_type_class_peek_parent
 269                 (gobject_class);
 270
 271         gobject_class->finalize = gnm_undo_filter_set_condition_finalize;
 272         uclass->undo = gnm_undo_filter_set_condition_undo;
 273 }
 274
 275
 276 GSF_CLASS (GnmUndoFilterSetCondition, gnm_undo_filter_set_condition,
 277            gnm_undo_filter_set_condition_class_init, NULL, GO_TYPE_UNDO)
 278
 279 /**
 280  * gnm_undo_filter_set_condition_new:
 281  *
 282  * if (retrieve_from_filter), cond is ignored
 283  *
 284  * Returns: a new undo object.
 285  **/
 286
 287 GOUndo *
 288 gnm_undo_filter_set_condition_new (GnmFilter *filter, unsigned i,
 289                                    GnmFilterCondition *cond,
 290                                    gboolean retrieve_from_filter)
 291 {
 292         GnmUndoFilterSetCondition *ua;
 293
 294         g_return_val_if_fail (filter != NULL, NULL);
 295         g_return_val_if_fail (i < filter->fields->len , NULL);
 296
 297         ua = g_object_new (GNM_TYPE_UNDO_FILTER_SET_CONDITION, NULL);
 298
 299         ua->filter = filter;
 300         ua->i = i;
 301
 302         if (retrieve_from_filter)
 303                 ua->cond = gnm_filter_condition_dup
 304                         (gnm_filter_get_condition (filter, i));
 305         else
 306                 ua->cond = cond;
 307
 308         return (GOUndo *)ua;
 309 }
 310 /* ------------------------------------------------------------------------- */