src/gtk/assertdlg_gtk.c

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