src/dialogs/dialog-stf.c

   1 /*
   2  * dialog-stf.c: implementation of the STF import dialog
   3  *
   4  * Copyright 2001 Almer S. Tigelaar <almer@gnome.org>
   5  * Copyright 2003 Morten Welinder <terra@gnome.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <gnumeric-config.h>
  22 #include <glib/gi18n-lib.h>
  23 #include <gnumeric.h>
  24 #include "dialog-stf.h"
  25
  26 #include <gnm-format.h>
  27 #include <wbc-gtk.h>
  28 #include <command-context.h>
  29 #include <gui-util.h>
  30 #include <sheet-style.h>
  31 #include <mstyle.h>
  32 #include <clipboard.h>
  33 #include <gtk/gtk.h>
  34 #include <string.h>
  35
  36 /**********************************************************************************************
  37  * DIALOG CONTROLLING CODE
  38  **********************************************************************************************/
  39
  40 /**
  41  * stf_dialog_set_initial_keyboard_focus
  42  * @pagedata: mother struct
  43  *
  44  * Sets keyboard focus to an appropriate widget on the page.
  45  *
  46  * returns: nothing
  47  **/
  48 static void
  49 stf_dialog_set_initial_keyboard_focus (StfDialogData *pagedata)
  50 {
  51         GtkWidget *focus_widget = NULL;
  52         GtkWidget *default_widget = pagedata->next_button;
  53
  54         switch (gtk_notebook_get_current_page (pagedata->notebook)) {
  55         case DPG_MAIN:
  56                 focus_widget = GTK_WIDGET (pagedata->main.main_separated);
  57                 break;
  58         case DPG_CSV:
  59                 focus_widget = GTK_WIDGET (pagedata->csv.csv_space);
  60                 break;
  61         case DPG_FIXED:
  62                 focus_widget = GTK_WIDGET (pagedata->fixed.fixed_auto);
  63                 break;
  64         case DPG_FORMAT:
  65                 focus_widget = pagedata->finish_button;
  66                 default_widget = pagedata->finish_button;
  67                 break;
  68         default:
  69                 g_assert_not_reached ();
  70         }
  71
  72         if (focus_widget)
  73                 gtk_widget_grab_focus (focus_widget);
  74
  75         if (default_widget)
  76                 gtk_widget_grab_default (default_widget);
  77
  78 }
  79
  80 static void
  81 frob_buttons (StfDialogData *pagedata)
  82 {
  83         StfDialogPage pos =
  84                 gtk_notebook_get_current_page (pagedata->notebook);
  85
  86         gtk_widget_set_sensitive (pagedata->back_button, pos != DPG_MAIN);
  87         gtk_widget_set_sensitive (pagedata->next_button, pos != DPG_FORMAT);
  88 }
  89
  90 static void
  91 prepare_page (StfDialogData *data)
  92 {
  93         switch (gtk_notebook_get_current_page (data->notebook)) {
  94         case DPG_MAIN:   stf_dialog_main_page_prepare (data); break;
  95         case DPG_CSV:    stf_dialog_csv_page_prepare (data); break;
  96         case DPG_FIXED:  stf_dialog_fixed_page_prepare (data); break;
  97         case DPG_FORMAT: stf_dialog_format_page_prepare (data); break;
  98         }
  99 }
 100
 101
 102
 103 static void
 104 next_clicked (G_GNUC_UNUSED GtkWidget *widget, StfDialogData *data)
 105 {
 106         StfDialogPage newpos;
 107
 108         switch (gtk_notebook_get_current_page (data->notebook)) {
 109         case DPG_MAIN:
 110                 stf_preview_set_lines (data->main.renderdata, NULL, NULL);
 111                 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (data->main.main_separated))) {
 112                         newpos = DPG_CSV;
 113                 } else {
 114                         newpos = DPG_FIXED;
 115                 }
 116                 break;
 117
 118         case DPG_CSV:
 119                 stf_preview_set_lines (data->csv.renderdata, NULL, NULL);
 120                 newpos = DPG_FORMAT;
 121                 break;
 122
 123         case DPG_FIXED:
 124                 stf_preview_set_lines (data->fixed.renderdata, NULL, NULL);
 125                 newpos = DPG_FORMAT;
 126                 break;
 127
 128         default:
 129                 g_assert_not_reached ();
 130                 return;
 131         }
 132
 133         gtk_notebook_set_current_page (data->notebook, newpos);
 134         prepare_page (data);
 135         frob_buttons (data);
 136         stf_dialog_set_initial_keyboard_focus (data);
 137 }
 138
 139 static void
 140 back_clicked (G_GNUC_UNUSED GtkWidget *widget, StfDialogData *data)
 141 {
 142         StfDialogPage newpos;
 143
 144         switch (gtk_notebook_get_current_page (data->notebook)) {
 145         case DPG_FORMAT:
 146                 stf_preview_set_lines (data->format.renderdata, NULL, NULL);
 147                 if (data->parseoptions->parsetype == PARSE_TYPE_CSV)
 148                         newpos = DPG_CSV;
 149                 else
 150                         newpos = DPG_FIXED;
 151                 break;
 152
 153         case DPG_FIXED:
 154                 stf_preview_set_lines (data->fixed.renderdata, NULL, NULL);
 155                 newpos = DPG_MAIN;
 156                 break;
 157
 158         case DPG_CSV:
 159                 stf_preview_set_lines (data->csv.renderdata, NULL, NULL);
 160                 newpos = DPG_MAIN;
 161                 break;
 162
 163         default:
 164                 g_assert_not_reached ();
 165                 return;
 166         }
 167
 168         gtk_notebook_set_current_page (data->notebook, newpos);
 169         prepare_page (data);
 170         frob_buttons (data);
 171         stf_dialog_set_initial_keyboard_focus (data);
 172 }
 173
 174
 175 /**
 176  * stf_dialog_attach_page_signals
 177  * @gui: the GtkBuilder gui of the dialog
 178  * @pagedata: mother struct
 179  *
 180  * Connects all signals to all pages and fills the mother struct
 181  * The page flow looks like:
 182  *
 183  * main_page /- csv_page   -\ format_page
 184  *           \- fixed_page -/
 185  *
 186  * returns: nothing
 187  **/
 188 static void
 189 stf_dialog_attach_page_signals (GtkBuilder *gui, StfDialogData *pagedata)
 190 {
 191         frob_buttons (pagedata);
 192         /* Signals for individual pages */
 193
 194         g_signal_connect (G_OBJECT (pagedata->next_button),
 195                           "clicked",
 196                           G_CALLBACK (next_clicked), pagedata);
 197
 198         g_signal_connect (G_OBJECT (pagedata->back_button),
 199                           "clicked",
 200                           G_CALLBACK (back_clicked), pagedata);
 201 }
 202
 203 /**
 204  * stf_dialog_editables_enter
 205  * @pagedata: mother struct
 206  *
 207  * Make <Ret> in text fields activate default.
 208  *
 209  * returns: nothing
 210  **/
 211 static void
 212 stf_dialog_editables_enter (StfDialogData *pagedata)
 213 {
 214 #if 0
 215         gnm_editable_enters
 216                 (pagedata->window,
 217                  GTK_WIDGET (&pagedata->main.main_startrow->entry));
 218         gnm_editable_enters
 219                 (pagedata->window,
 220                  GTK_WIDGET (&pagedata->main.main_stoprow->entry));
 221         gnm_editable_enters
 222                 (pagedata->window,
 223                  GTK_WIDGET (pagedata->csv.csv_customseparator));
 224         gnumeric_combo_enters
 225                 (pagedata->window,
 226                  pagedata->csv.csv_textindicator);
 227         gnm_editable_enters
 228                 (pagedata->window,
 229                  GTK_WIDGET (&pagedata->fixed.fixed_colend->entry));
 230         go_format_sel_editable_enters
 231                 (pagedata->format.format_selector,
 232                  pagedata->window);
 233 #endif
 234 }
 235
 236 /**
 237  * stf_dialog
 238  * @wbcg: a Commandcontext (can be NULL)
 239  * @source: name of the file we are importing (or data) in UTF-8
 240  * @data: the data itself
 241  *
 242  * This will start the import.
 243  * (NOTE: you have to free the DialogStfResult_t that this function returns yourself)
 244  *
 245  * returns: A DialogStfResult_t struct on success, NULL otherwise.
 246  **/
 247 DialogStfResult_t*
 248 stf_dialog (WBCGtk *wbcg,
 249             const char *opt_encoding,
 250             gboolean fixed_encoding,
 251             const char *opt_locale,
 252             gboolean fixed_locale,
 253             const char *source,
 254             const char *data,
 255             int data_len)
 256 {
 257         GtkBuilder *gui;
 258         DialogStfResult_t *dialogresult;
 259         StfDialogData pagedata;
 260         GtkResponseType resp;
 261
 262         g_return_val_if_fail (opt_encoding != NULL || !fixed_encoding, NULL);
 263         g_return_val_if_fail (opt_locale != NULL || !fixed_locale, NULL);
 264         g_return_val_if_fail (source != NULL, NULL);
 265         g_return_val_if_fail (data != NULL, NULL);
 266
 267         gui = gnm_gtk_builder_load ("res:ui/dialog-stf.ui", NULL, GO_CMD_CONTEXT (wbcg));
 268         if (gui == NULL)
 269                 return NULL;
 270
 271         pagedata.encoding = g_strdup (opt_encoding);
 272         pagedata.fixed_encoding = fixed_encoding;
 273         pagedata.locale = g_strdup (opt_locale);
 274         pagedata.fixed_locale = fixed_locale;
 275         pagedata.wbcg = wbcg;
 276         pagedata.source = source;
 277         pagedata.raw_data = data;
 278         pagedata.raw_data_len = data_len < 0 ? (int)strlen (data) : data_len;
 279         pagedata.utf8_data = NULL;
 280         pagedata.cur = NULL;
 281
 282         pagedata.dialog         = GTK_DIALOG  (go_gtk_builder_get_widget (gui, "stf_dialog"));
 283         pagedata.notebook       = GTK_NOTEBOOK (go_gtk_builder_get_widget (gui, "stf_notebook"));
 284         pagedata.next_button    = go_gtk_builder_get_widget (gui, "forward_button");
 285         pagedata.back_button    = go_gtk_builder_get_widget (gui, "back_button");
 286         pagedata.cancel_button    = go_gtk_builder_get_widget (gui, "cancel_button");
 287         pagedata.help_button    = go_gtk_builder_get_widget (gui, "help_button");
 288         pagedata.finish_button    = go_gtk_builder_get_widget (gui, "finish_button");
 289         pagedata.parseoptions = NULL;
 290
 291         gtk_widget_set_name (GTK_WIDGET (pagedata.dialog), "stf-import");
 292
 293         stf_dialog_main_page_init   (gui, &pagedata);
 294         stf_dialog_csv_page_init    (gui, &pagedata);
 295         stf_dialog_fixed_page_init  (gui, &pagedata);
 296         stf_dialog_format_page_init (gui, &pagedata);
 297
 298         stf_dialog_attach_page_signals (gui, &pagedata);
 299
 300         stf_dialog_editables_enter (&pagedata);
 301
 302         stf_dialog_set_initial_keyboard_focus (&pagedata);
 303
 304         prepare_page (&pagedata);
 305         frob_buttons (&pagedata);
 306
 307         resp = go_gtk_dialog_run (pagedata.dialog, wbcg_toplevel (wbcg));
 308
 309         if (resp == GTK_RESPONSE_OK) {
 310                 dialogresult = g_new (DialogStfResult_t, 1);
 311
 312                 dialogresult->text = pagedata.utf8_data;
 313                 *((char *)pagedata.cur_end) = 0;
 314                 if (dialogresult->text != pagedata.cur)
 315                         strcpy (dialogresult->text, pagedata.cur);
 316                 pagedata.cur = pagedata.utf8_data = NULL;
 317
 318                 dialogresult->encoding = pagedata.encoding;
 319                 pagedata.encoding = NULL;
 320
 321                 dialogresult->colcount = pagedata.format.col_import_count;
 322                 dialogresult->rowcount = pagedata.rowcount;
 323
 324                 dialogresult->parseoptions = pagedata.parseoptions;
 325                 pagedata.parseoptions = NULL;
 326                 g_free (dialogresult->parseoptions->locale);
 327                 dialogresult->parseoptions->locale = pagedata.locale;
 328                 pagedata.locale = NULL;
 329
 330                 if (pagedata.format.formats) {
 331                         g_ptr_array_free (dialogresult->parseoptions->formats, TRUE);
 332                         dialogresult->parseoptions->formats = pagedata.format.formats;
 333                         pagedata.format.formats = NULL;
 334                 } else
 335                         g_ptr_array_set_size (dialogresult->parseoptions->formats, 0);
 336                 dialogresult->parseoptions->col_import_array
 337                         =  pagedata.format.col_import_array;
 338                 dialogresult->parseoptions->col_import_array_len
 339                         =  pagedata.format.col_import_array_len;
 340                 pagedata.format.col_import_array = NULL;
 341                 dialogresult->parseoptions->col_autofit_array
 342                         =  pagedata.format.col_autofit_array;
 343                 pagedata.format.col_autofit_array = NULL;
 344                 pagedata.format.col_import_count = 0;
 345                 pagedata.format.col_import_array_len = 0;
 346         } else {
 347                 dialogresult = NULL;
 348         }
 349
 350         stf_dialog_main_page_cleanup   (&pagedata);
 351         stf_dialog_csv_page_cleanup    (&pagedata);
 352         stf_dialog_fixed_page_cleanup  (&pagedata);
 353         stf_dialog_format_page_cleanup (&pagedata);
 354
 355         g_object_unref (gui);
 356         g_free (pagedata.encoding);
 357         g_free (pagedata.locale);
 358         g_free (pagedata.utf8_data);
 359         if (pagedata.parseoptions)
 360                 stf_parse_options_free (pagedata.parseoptions);
 361
 362         return dialogresult;
 363 }
 364
 365 /**
 366  * stf_dialog_result_free
 367  * @dialogresult: a dialogresult struct
 368  *
 369  * This routine will properly free the members of @dialogresult and
 370  * @dialogresult itself
 371  *
 372  * returns: nothing
 373  **/
 374 void
 375 stf_dialog_result_free (DialogStfResult_t *dialogresult)
 376 {
 377         g_return_if_fail (dialogresult != NULL);
 378
 379         stf_parse_options_free (dialogresult->parseoptions);
 380
 381         g_free (dialogresult->text);
 382         g_free (dialogresult->encoding);
 383
 384         g_free (dialogresult);
 385 }
 386
 387 /**
 388  * stf_dialog_result_attach_formats_to_cr
 389  * @dialogresult: a dialogresult struct
 390  * @cr: a cell region
 391  *
 392  * Attach the formats of the dialogresult to the given cell region.
 393  *
 394  * returns: nothing
 395  **/
 396 void
 397 stf_dialog_result_attach_formats_to_cr (DialogStfResult_t *dialogresult,
 398                                         GnmCellRegion *cr)
 399 {
 400         unsigned int col, targetcol;
 401
 402         g_return_if_fail (dialogresult != NULL);
 403         g_return_if_fail (cr != NULL);
 404
 405         targetcol = 0;
 406         for (col = 0; col < dialogresult->parseoptions->formats->len; col++) {
 407                 if (dialogresult->parseoptions->col_import_array[col]) {
 408                         GOFormat *sf = g_ptr_array_index
 409                                 (dialogresult->parseoptions->formats, col);
 410                         GnmStyleRegion *sr = g_new (GnmStyleRegion, 1);
 411
 412                         sr->range.start.col = targetcol;
 413                         sr->range.start.row = 0;
 414                         sr->range.end.col   = targetcol;
 415                         sr->range.end.row   = dialogresult->rowcount - 1;
 416                         sr->style = gnm_style_new_default ();
 417                         gnm_style_set_format (sr->style, sf);
 418                         targetcol++;
 419
 420                         cr->styles = g_slist_prepend (cr->styles, sr);
 421                 }
 422         }
 423 }