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