src/gtk/assertdlg_gtk.cpp

   1 /* ///////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/assertdlg_gtk.cpp
   3 // Purpose:     GtkAssertDialog
   4 // Author:      Francesco Montorsi
   5 // Id:          $Id$
   6 // Copyright:   (c) 2006 Francesco Montorsi
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////// */
   9
  10 #include "wx/wxprec.h"
  11
  12 #include "wx/platform.h"
  13 #include <gtk/gtk.h>
  14 #include "wx/gtk/assertdlg_gtk.h"
  15 #include "wx/gtk/private/gtk2-compat.h"
  16
  17 #include <stdio.h>
  18
  19 /* ----------------------------------------------------------------------------
  20    Constants
  21  ---------------------------------------------------------------------------- */
  22
  23 /*
  24    NB: when changing order of the columns also update the gtk_list_store_new() call
  25        in gtk_assert_dialog_create_backtrace_list_model() function
  26  */
  27 #define STACKFRAME_LEVEL_COLIDX        0
  28 #define FUNCTION_PROTOTYPE_COLIDX      1
  29 #define SOURCE_FILE_COLIDX             2
  30 #define LINE_NUMBER_COLIDX             3
  31
  32 /* ----------------------------------------------------------------------------
  33    GtkAssertDialog helpers
  34  ---------------------------------------------------------------------------- */
  35
  36 GtkWidget *gtk_assert_dialog_add_button_to (GtkBox *box, const gchar *label,
  37                                             const gchar *stock)
  38 {
  39     /* create the button */
  40     GtkWidget *button = gtk_button_new_with_mnemonic (label);
  41     gtk_widget_set_can_default(button, true);
  42
  43     /* add a stock icon inside it */
  44     GtkWidget *image = gtk_image_new_from_stock (stock, GTK_ICON_SIZE_BUTTON);
  45     gtk_button_set_image (GTK_BUTTON (button), image);
  46
  47     /* add to the given (container) widget */
  48     if (box)
  49         gtk_box_pack_end (box, button, FALSE, TRUE, 8);
  50
  51     return button;
  52 }
  53
  54 GtkWidget *gtk_assert_dialog_add_button (GtkAssertDialog *dlg, const gchar *label,
  55                                          const gchar *stock, gint response_id)
  56 {
  57     /* create the button */
  58     GtkWidget* button = gtk_assert_dialog_add_button_to(NULL, label, stock);
  59
  60     /* add the button to the dialog's action area */
  61     gtk_dialog_add_action_widget (GTK_DIALOG (dlg), button, response_id);
  62
  63     return button;
  64 }
  65
  66 void gtk_assert_dialog_append_text_column (GtkWidget *treeview, const gchar *name, int index)
  67 {
  68     GtkCellRenderer *renderer;
  69     GtkTreeViewColumn *column;
  70
  71     renderer = gtk_cell_renderer_text_new ();
  72     column = gtk_tree_view_column_new_with_attributes (name, renderer,
  73                                                        "text", index, NULL);
  74     gtk_tree_view_insert_column (GTK_TREE_VIEW (treeview), column, index);
  75     gtk_tree_view_column_set_resizable (column, TRUE);
  76     gtk_tree_view_column_set_reorderable (column, TRUE);
  77 }
  78
  79 GtkWidget *gtk_assert_dialog_create_backtrace_list_model ()
  80 {
  81     GtkListStore *store;
  82     GtkWidget *treeview;
  83
  84     /* create list store */
  85     store = gtk_list_store_new (4,
  86                                 G_TYPE_UINT,        /* stack frame number */
  87                                 G_TYPE_STRING,      /* function prototype */
  88                                 G_TYPE_STRING,      /* source file name   */
  89                                 G_TYPE_STRING);     /* line number        */
  90
  91     /* create the tree view */
  92     treeview = gtk_tree_view_new_with_model (GTK_TREE_MODEL(store));
  93     g_object_unref (store);
  94     gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (treeview), TRUE);
  95
  96     /* append columns */
  97     gtk_assert_dialog_append_text_column(treeview, "#", STACKFRAME_LEVEL_COLIDX);
  98     gtk_assert_dialog_append_text_column(treeview, "Function Prototype", FUNCTION_PROTOTYPE_COLIDX);
  99     gtk_assert_dialog_append_text_column(treeview, "Source file", SOURCE_FILE_COLIDX);
 100     gtk_assert_dialog_append_text_column(treeview, "Line #", LINE_NUMBER_COLIDX);
 101
 102     return treeview;
 103 }
 104
 105 void gtk_assert_dialog_process_backtrace (GtkAssertDialog *dlg)
 106 {
 107     /* set busy cursor */
 108     GdkWindow *parent = gtk_widget_get_window(GTK_WIDGET(dlg));
 109     GdkCursor *cur = gdk_cursor_new (GDK_WATCH);
 110     gdk_window_set_cursor (parent, cur);
 111     gdk_flush ();
 112
 113     (*dlg->callback)(dlg->userdata);
 114
 115     /* toggle busy cursor */
 116     gdk_window_set_cursor (parent, NULL);
 117 #ifdef __WXGTK3__
 118     g_object_unref(cur);
 119 #else
 120     gdk_cursor_unref (cur);
 121 #endif
 122 }
 123
 124 extern "C" {
 125 /* ----------------------------------------------------------------------------
 126    GtkAssertDialog signal handlers
 127  ---------------------------------------------------------------------------- */
 128
 129 static void gtk_assert_dialog_expander_callback(GtkWidget*, GtkAssertDialog* dlg)
 130 {
 131     /* status is not yet updated so we need to invert it to get the new one */
 132     gboolean expanded = !gtk_expander_get_expanded (GTK_EXPANDER(dlg->expander));
 133     gtk_window_set_resizable (GTK_WINDOW (dlg), expanded);
 134
 135     if (dlg->callback == NULL)      /* was the backtrace already processed? */
 136         return;
 137
 138     gtk_assert_dialog_process_backtrace (dlg);
 139
 140     /* mark the work as done (so that next activate we won't call the callback again) */
 141     dlg->callback = NULL;
 142 }
 143
 144 static void gtk_assert_dialog_save_backtrace_callback(GtkWidget*, GtkAssertDialog* dlg)
 145 {
 146     GtkWidget *dialog;
 147
 148     dialog = gtk_file_chooser_dialog_new ("Save assert info to file", GTK_WINDOW(dlg),
 149                                           GTK_FILE_CHOOSER_ACTION_SAVE,
 150                                           GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 151                                           GTK_STOCK_SAVE, GTK_RESPONSE_ACCEPT,
 152                                           NULL);
 153
 154     if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
 155     {
 156         char *filename, *msg, *backtrace;
 157         FILE *fp;
 158
 159         filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog));
 160         if ( filename )
 161         {
 162             msg = gtk_assert_dialog_get_message (dlg);
 163             backtrace = gtk_assert_dialog_get_backtrace (dlg);
 164
 165             /* open the file and write all info inside it */
 166             fp = fopen (filename, "w");
 167             if (fp)
 168             {
 169                 fprintf (fp, "ASSERT INFO:\n%s\n\nBACKTRACE:\n%s", msg, backtrace);
 170                 fclose (fp);
 171             }
 172
 173             g_free (filename);
 174             g_free (msg);
 175             g_free (backtrace);
 176         }
 177     }
 178
 179     gtk_widget_destroy (dialog);
 180 }
 181
 182 static void gtk_assert_dialog_copy_callback(GtkWidget*, GtkAssertDialog* dlg)
 183 {
 184     char *msg, *backtrace;
 185     GtkClipboard *clipboard;
 186     GString *str;
 187
 188     msg = gtk_assert_dialog_get_message (dlg);
 189     backtrace = gtk_assert_dialog_get_backtrace (dlg);
 190
 191     /* combine both in a single string */
 192     str = g_string_new("");
 193     g_string_printf (str, "ASSERT INFO:\n%s\n\nBACKTRACE:\n%s\n\n", msg, backtrace);
 194
 195     /* copy everything in default clipboard */
 196     clipboard = gtk_clipboard_get (GDK_SELECTION_CLIPBOARD);
 197     gtk_clipboard_set_text (clipboard, str->str, str->len);
 198
 199     /* copy everything in primary clipboard too */
 200     clipboard = gtk_clipboard_get (GDK_SELECTION_PRIMARY);
 201     gtk_clipboard_set_text (clipboard, str->str, str->len);
 202
 203     g_free (msg);
 204     g_free (backtrace);
 205     g_string_free (str, TRUE);
 206 }
 207
 208 static void gtk_assert_dialog_continue_callback(GtkWidget*, GtkAssertDialog* dlg)
 209 {
 210     gint response =
 211         gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(dlg->shownexttime)) ?
 212             GTK_ASSERT_DIALOG_CONTINUE : GTK_ASSERT_DIALOG_CONTINUE_SUPPRESSING;
 213
 214     gtk_dialog_response (GTK_DIALOG(dlg), response);
 215 }
 216 } // extern "C"
 217
 218 /* ----------------------------------------------------------------------------
 219    GtkAssertDialogClass implementation
 220  ---------------------------------------------------------------------------- */
 221
 222 static void     gtk_assert_dialog_init              (GtkAssertDialog        *self);
 223 static void     gtk_assert_dialog_class_init        (GtkAssertDialogClass *klass);
 224
 225 GType gtk_assert_dialog_get_type()
 226 {
 227     static GType assert_dialog_type;
 228
 229     if (!assert_dialog_type)
 230     {
 231         const GTypeInfo assert_dialog_info =
 232         {
 233             sizeof (GtkAssertDialogClass),
 234             NULL,           /* base_init */
 235             NULL,           /* base_finalize */
 236             (GClassInitFunc) gtk_assert_dialog_class_init,
 237             NULL,           /* class_finalize */
 238             NULL,           /* class_data */
 239             sizeof (GtkAssertDialog),
 240             16,             /* n_preallocs */
 241             (GInstanceInitFunc) gtk_assert_dialog_init,
 242             NULL
 243         };
 244         assert_dialog_type = g_type_register_static (GTK_TYPE_DIALOG, "GtkAssertDialog", &assert_dialog_info, (GTypeFlags)0);
 245     }
 246
 247     return assert_dialog_type;
 248 }
 249
 250 static void gtk_assert_dialog_class_init(GtkAssertDialogClass*)
 251 {
 252     /* no special initializations required */
 253 }
 254
 255 static void gtk_assert_dialog_init(GtkAssertDialog* dlg)
 256 {
 257     GtkWidget *continuebtn;
 258
 259     {
 260         GtkWidget *vbox, *hbox, *image;
 261
 262         /* start the main vbox */
 263         gtk_widget_push_composite_child ();
 264         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8);
 265         gtk_container_set_border_width (GTK_CONTAINER(vbox), 8);
 266         gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dlg))), vbox, true, true, 5);
 267
 268
 269         /* add the icon+message hbox */
 270         hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
 271         gtk_box_pack_start (GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 272
 273         /* icon */
 274         image = gtk_image_new_from_stock (GTK_STOCK_DIALOG_ERROR, GTK_ICON_SIZE_DIALOG);
 275         gtk_box_pack_start (GTK_BOX(hbox), image, FALSE, FALSE, 12);
 276
 277         {
 278             GtkWidget *vbox2, *info;
 279
 280             /* message */
 281             vbox2 = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
 282             gtk_box_pack_start (GTK_BOX (hbox), vbox2, TRUE, TRUE, 0);
 283             info = gtk_label_new ("An assertion failed!");
 284             gtk_box_pack_start (GTK_BOX(vbox2), info, TRUE, TRUE, 8);
 285
 286             /* assert message */
 287             dlg->message = gtk_label_new (NULL);
 288             gtk_label_set_selectable (GTK_LABEL (dlg->message), TRUE);
 289             gtk_label_set_line_wrap (GTK_LABEL (dlg->message), TRUE);
 290             gtk_label_set_justify (GTK_LABEL (dlg->message), GTK_JUSTIFY_LEFT);
 291             gtk_widget_set_size_request (GTK_WIDGET(dlg->message), 450, -1);
 292
 293             gtk_box_pack_end (GTK_BOX(vbox2), GTK_WIDGET(dlg->message), TRUE, TRUE, 8);
 294         }
 295
 296         /* add the expander */
 297         dlg->expander = gtk_expander_new_with_mnemonic ("Back_trace:");
 298         gtk_box_pack_start (GTK_BOX(vbox), dlg->expander, TRUE, TRUE, 0);
 299         g_signal_connect (dlg->expander, "activate",
 300                             G_CALLBACK(gtk_assert_dialog_expander_callback), dlg);
 301     }
 302
 303     {
 304         GtkWidget *hbox, *vbox, *button, *sw;
 305
 306         /* create expander's vbox */
 307         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
 308         gtk_container_add (GTK_CONTAINER (dlg->expander), vbox);
 309
 310         /* add a scrollable window under the expander */
 311         sw = gtk_scrolled_window_new (NULL, NULL);
 312         gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (sw), GTK_SHADOW_ETCHED_IN);
 313         gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sw), GTK_POLICY_AUTOMATIC,
 314                                         GTK_POLICY_AUTOMATIC);
 315         gtk_box_pack_start (GTK_BOX(vbox), sw, TRUE, TRUE, 8);
 316
 317         /* add the treeview to the scrollable window */
 318         dlg->treeview = gtk_assert_dialog_create_backtrace_list_model ();
 319         gtk_widget_set_size_request (GTK_WIDGET(dlg->treeview), -1, 180);
 320         gtk_container_add (GTK_CONTAINER (sw), dlg->treeview);
 321
 322         /* create button's hbox */
 323         hbox = gtk_button_box_new(GTK_ORIENTATION_HORIZONTAL);
 324         gtk_box_pack_end (GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 325         gtk_button_box_set_layout (GTK_BUTTON_BOX(hbox), GTK_BUTTONBOX_END);
 326
 327         /* add the buttons */
 328         button = gtk_assert_dialog_add_button_to (GTK_BOX(hbox), "Save to _file",
 329                                                 GTK_STOCK_SAVE);
 330         g_signal_connect (button, "clicked",
 331                             G_CALLBACK(gtk_assert_dialog_save_backtrace_callback), dlg);
 332
 333         button = gtk_assert_dialog_add_button_to (GTK_BOX(hbox), "Copy to clip_board",
 334                                                   GTK_STOCK_COPY);
 335         g_signal_connect (button, "clicked", G_CALLBACK(gtk_assert_dialog_copy_callback), dlg);
 336     }
 337
 338     /* add the checkbutton */
 339     dlg->shownexttime = gtk_check_button_new_with_mnemonic("Show this _dialog the next time");
 340     gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON(dlg->shownexttime), TRUE);
 341     gtk_box_pack_end(GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(dlg))), dlg->shownexttime, false, true, 8);
 342
 343     /* add the stop button */
 344     gtk_assert_dialog_add_button (dlg, "_Stop", GTK_STOCK_QUIT, GTK_ASSERT_DIALOG_STOP);
 345
 346     /* add the continue button */
 347     continuebtn = gtk_assert_dialog_add_button (dlg, "_Continue", GTK_STOCK_YES, GTK_ASSERT_DIALOG_CONTINUE);
 348     gtk_dialog_set_default_response (GTK_DIALOG (dlg), GTK_ASSERT_DIALOG_CONTINUE);
 349     g_signal_connect (continuebtn, "clicked", G_CALLBACK(gtk_assert_dialog_continue_callback), dlg);
 350
 351     /* complete creation */
 352     dlg->callback = NULL;
 353     dlg->userdata = NULL;
 354
 355     /* the resizable property of this window is modified by the expander:
 356        when it's collapsed, the window must be non-resizable! */
 357     gtk_window_set_resizable (GTK_WINDOW (dlg), FALSE);
 358     gtk_widget_pop_composite_child ();
 359     gtk_widget_show_all (GTK_WIDGET(dlg));
 360 }
 361
 362 /* ----------------------------------------------------------------------------
 363    GtkAssertDialog public API
 364  ---------------------------------------------------------------------------- */
 365
 366 gchar *gtk_assert_dialog_get_message (GtkAssertDialog *dlg)
 367 {
 368     /* NOTES:
 369        1) returned string must g_free()d !
 370        2) Pango markup is automatically stripped off by GTK
 371     */
 372     return g_strdup (gtk_label_get_text (GTK_LABEL(dlg->message)));
 373 }
 374
 375 gchar *gtk_assert_dialog_get_backtrace (GtkAssertDialog *dlg)
 376 {
 377     gchar *function, *sourcefile, *linenum;
 378     guint count;
 379
 380     GtkTreeModel *model;
 381     GtkTreeIter iter;
 382     GString *string;
 383
 384     g_return_val_if_fail (GTK_IS_ASSERT_DIALOG (dlg), NULL);
 385     model = gtk_tree_view_get_model (GTK_TREE_VIEW(dlg->treeview));
 386     string = g_string_new("");
 387
 388     /* iterate over the list */
 389     if (!gtk_tree_model_get_iter_first (model, &iter))
 390         return NULL;
 391
 392     do
 393     {
 394         /* append this stack frame's info to the string */
 395         gtk_tree_model_get(model, &iter,
 396                             STACKFRAME_LEVEL_COLIDX, &count,
 397                             FUNCTION_PROTOTYPE_COLIDX, &function,
 398                             SOURCE_FILE_COLIDX, &sourcefile,
 399                             LINE_NUMBER_COLIDX, &linenum,
 400                             -1);
 401
 402         g_string_append_printf(string, "[%u] %s",
 403                                 count, function);
 404         if (sourcefile[0] != '\0')
 405             g_string_append_printf (string, " %s", sourcefile);
 406         if (linenum[0] != '\0')
 407             g_string_append_printf (string, ":%s", linenum);
 408         g_string_append (string, "\n");
 409
 410         g_free (function);
 411         g_free (sourcefile);
 412         g_free (linenum);
 413
 414     } while (gtk_tree_model_iter_next (model, &iter));
 415
 416     /* returned string must g_free()d */
 417     return g_string_free (string, FALSE);
 418 }
 419
 420 void gtk_assert_dialog_set_message(GtkAssertDialog *dlg, const gchar *msg)
 421 {
 422     /* prepend and append the <b> tag
 423        NOTE: g_markup_printf_escaped() is not used because it's available
 424              only for glib >= 2.4 */
 425     gchar *escaped_msg = g_markup_escape_text (msg, -1);
 426     gchar *decorated_msg = g_strdup_printf ("<b>%s</b>", escaped_msg);
 427
 428     g_return_if_fail (GTK_IS_ASSERT_DIALOG (dlg));
 429     gtk_label_set_markup (GTK_LABEL(dlg->message), decorated_msg);
 430
 431     g_free (decorated_msg);
 432     g_free (escaped_msg);
 433 }
 434
 435 void gtk_assert_dialog_set_backtrace_callback(GtkAssertDialog *assertdlg,
 436                                               GtkAssertDialogStackFrameCallback callback,
 437                                               void *userdata)
 438 {
 439     assertdlg->callback = callback;
 440     assertdlg->userdata = userdata;
 441 }
 442
 443 void gtk_assert_dialog_append_stack_frame(GtkAssertDialog *dlg,
 444                                           const gchar *function,
 445                                           const gchar *sourcefile,
 446                                           guint line_number)
 447 {
 448     GtkTreeModel *model;
 449     GtkTreeIter iter;
 450     GString *linenum;
 451     gint count;
 452
 453     g_return_if_fail (GTK_IS_ASSERT_DIALOG (dlg));
 454     model = gtk_tree_view_get_model (GTK_TREE_VIEW(dlg->treeview));
 455
 456     /* how many items are in the list up to now ? */
 457     count = gtk_tree_model_iter_n_children (model, NULL);
 458
 459     linenum = g_string_new("");
 460     if ( line_number != 0 )
 461         g_string_printf (linenum, "%u", line_number);
 462
 463     /* add data to the list store */
 464     gtk_list_store_append (GTK_LIST_STORE(model), &iter);
 465     gtk_list_store_set (GTK_LIST_STORE(model), &iter,
 466                         STACKFRAME_LEVEL_COLIDX, count+1,     /* start from 1 and not from 0 */
 467                         FUNCTION_PROTOTYPE_COLIDX, function,
 468                         SOURCE_FILE_COLIDX, sourcefile,
 469                         LINE_NUMBER_COLIDX, linenum->str,
 470                         -1);
 471
 472     g_string_free (linenum, TRUE);
 473 }
 474
 475 GtkWidget *gtk_assert_dialog_new(void)
 476 {
 477     void* dialog = g_object_new(GTK_TYPE_ASSERT_DIALOG, NULL);
 478
 479     return GTK_WIDGET (dialog);
 480 }