/* /////////////////////////////////////////////////////////////////////////// // Name: src/gtk/assertdlg_gtk.cpp // Purpose: GtkAssertDialog // Author: Francesco Montorsi // Copyright: (c) 2006 Francesco Montorsi // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////// */ #include "wx/wxprec.h" #if wxDEBUG_LEVEL #include "wx/gtk/private.h" #include "wx/gtk/assertdlg_gtk.h" #include "wx/gtk/private/mnemonics.h" #include "wx/translation.h" #include "wx/stockitem.h" #include /* ---------------------------------------------------------------------------- Constants ---------------------------------------------------------------------------- */ /* NB: when changing order of the columns also update the gtk_list_store_new() call in gtk_assert_dialog_create_backtrace_list_model() function */ #define STACKFRAME_LEVEL_COLIDX 0 #define FUNCTION_PROTOTYPE_COLIDX 1 #define SOURCE_FILE_COLIDX 2 #define LINE_NUMBER_COLIDX 3 /* ---------------------------------------------------------------------------- GtkAssertDialog helpers ---------------------------------------------------------------------------- */ // This function is called only for GTK+ < 3.10 static GtkWidget *gtk_assert_dialog_add_button_to (GtkBox *box, const gchar *label, const gchar *stock) { /* create the button */ GtkWidget *button = gtk_button_new_with_mnemonic (label); gtk_widget_set_can_default(button, true); /* add a stock icon inside it */ #ifdef __WXGTK4__ gtk_button_set_icon_name (GTK_BUTTON (button), stock); #else wxGCC_WARNING_SUPPRESS(deprecated-declarations) GtkWidget *image = gtk_image_new_from_stock (stock, GTK_ICON_SIZE_BUTTON); wxGCC_WARNING_RESTORE() gtk_button_set_image (GTK_BUTTON (button), image); #endif /* add to the given (container) widget */ if (box) #ifdef __WXGTK4__ gtk_box_pack_end (box, button); #else gtk_box_pack_end (box, button, FALSE, TRUE, 8); #endif return button; } // This function is called only for GTK+ < 3.10 static GtkWidget *gtk_assert_dialog_add_button (GtkAssertDialog *dlg, const gchar *label, const gchar *stock, gint response_id) { /* create the button */ GtkWidget* button = gtk_assert_dialog_add_button_to(NULL, label, stock); /* add the button to the dialog's action area */ gtk_dialog_add_action_widget (GTK_DIALOG (dlg), button, response_id); return button; } #if wxUSE_STACKWALKER // This function is called only for GTK+ < 3.10 static void gtk_assert_dialog_append_text_column (GtkWidget *treeview, const gchar *name, int index) { GtkCellRenderer *renderer; GtkTreeViewColumn *column; renderer = gtk_cell_renderer_text_new (); column = gtk_tree_view_column_new_with_attributes (name, renderer, "text", index, NULL); gtk_tree_view_insert_column (GTK_TREE_VIEW (treeview), column, index); gtk_tree_view_column_set_resizable (column, TRUE); gtk_tree_view_column_set_reorderable (column, TRUE); } // This function is called only for GTK+ < 3.10 static GtkWidget *gtk_assert_dialog_create_backtrace_list_model () { GtkListStore *store; GtkWidget *treeview; /* create list store */ store = gtk_list_store_new (4, G_TYPE_UINT, /* stack frame number */ G_TYPE_STRING, /* function prototype */ G_TYPE_STRING, /* source file name */ G_TYPE_STRING); /* line number */ /* create the tree view */ treeview = gtk_tree_view_new_with_model (GTK_TREE_MODEL(store)); g_object_unref (store); #ifndef __WXGTK4__ wxGCC_WARNING_SUPPRESS(deprecated-declarations) gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (treeview), TRUE); wxGCC_WARNING_RESTORE() #endif /* append columns */ gtk_assert_dialog_append_text_column(treeview, "#", STACKFRAME_LEVEL_COLIDX); gtk_assert_dialog_append_text_column(treeview, "Function Prototype", FUNCTION_PROTOTYPE_COLIDX); gtk_assert_dialog_append_text_column(treeview, "Source file", SOURCE_FILE_COLIDX); gtk_assert_dialog_append_text_column(treeview, "Line #", LINE_NUMBER_COLIDX); return treeview; } static void gtk_assert_dialog_process_backtrace (GtkAssertDialog *dlg) { /* set busy cursor */ GdkWindow *parent = gtk_widget_get_window(GTK_WIDGET(dlg)); GdkDisplay* display = gdk_window_get_display(parent); GdkCursor* cur = gdk_cursor_new_for_display(display, GDK_WATCH); gdk_window_set_cursor (parent, cur); gdk_flush (); (*dlg->callback)(dlg->userdata); /* toggle busy cursor */ gdk_window_set_cursor (parent, NULL); #ifdef __WXGTK3__ g_object_unref(cur); #else gdk_cursor_unref (cur); #endif } extern "C" { /* ---------------------------------------------------------------------------- GtkAssertDialog signal handlers ---------------------------------------------------------------------------- */ static void gtk_assert_dialog_expander_callback(GtkWidget*, GtkAssertDialog* dlg) { /* status is not yet updated so we need to invert it to get the new one */ gboolean expanded = !gtk_expander_get_expanded (GTK_EXPANDER(dlg->expander)); gtk_window_set_resizable (GTK_WINDOW (dlg), expanded); if (dlg->callback == NULL) /* was the backtrace already processed? */ return; gtk_assert_dialog_process_backtrace (dlg); /* mark the work as done (so that next activate we won't call the callback again) */ dlg->callback = NULL; } static void gtk_assert_dialog_save_backtrace_callback(GtkWidget*, GtkAssertDialog* dlg) { GtkWidget *dialog; dialog = gtk_file_chooser_dialog_new ("Save assert info to file", GTK_WINDOW(dlg), GTK_FILE_CHOOSER_ACTION_SAVE, static_cast(wxConvertMnemonicsToGTK(wxGetStockLabel(wxID_CANCEL)).utf8_str()), GTK_RESPONSE_CANCEL, static_cast(wxConvertMnemonicsToGTK(wxGetStockLabel(wxID_SAVE)).utf8_str()), GTK_RESPONSE_ACCEPT, NULL); if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT) { char *filename, *msg, *backtrace; FILE *fp; filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog)); if ( filename ) { msg = gtk_assert_dialog_get_message (dlg); backtrace = gtk_assert_dialog_get_backtrace (dlg); /* open the file and write all info inside it */ fp = fopen (filename, "w"); if (fp) { fprintf (fp, "ASSERT INFO:\n%s\n\nBACKTRACE:\n%s", msg, backtrace); fclose (fp); } g_free (filename); g_free (msg); g_free (backtrace); } } gtk_widget_destroy (dialog); } static void gtk_assert_dialog_copy_callback(GtkWidget*, GtkAssertDialog* dlg) { char *msg, *backtrace; GtkClipboard *clipboard; GString *str; msg = gtk_assert_dialog_get_message (dlg); backtrace = gtk_assert_dialog_get_backtrace (dlg); /* combine both in a single string */ str = g_string_new(""); g_string_printf (str, "ASSERT INFO:\n%s\n\nBACKTRACE:\n%s\n\n", msg, backtrace); /* copy everything in default clipboard */ clipboard = gtk_clipboard_get (GDK_SELECTION_CLIPBOARD); gtk_clipboard_set_text (clipboard, str->str, str->len); /* copy everything in primary clipboard too */ clipboard = gtk_clipboard_get (GDK_SELECTION_PRIMARY); gtk_clipboard_set_text (clipboard, str->str, str->len); g_free (msg); g_free (backtrace); g_string_free (str, TRUE); } } // extern "C" #endif // wxUSE_STACKWALKER extern "C" { static void gtk_assert_dialog_continue_callback(GtkWidget*, GtkAssertDialog* dlg) { gint response = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(dlg->shownexttime)) ? GTK_ASSERT_DIALOG_CONTINUE : GTK_ASSERT_DIALOG_CONTINUE_SUPPRESSING; gtk_dialog_response (GTK_DIALOG(dlg), response); } } // extern "C" /* ---------------------------------------------------------------------------- GtkAssertDialogClass implementation ---------------------------------------------------------------------------- */ extern "C" { #if GTK_CHECK_VERSION(3,10,0) static void gtk_assert_dialog_class_init(gpointer g_class, void*); #endif // GTK+ >= 3.10 static void gtk_assert_dialog_init(GTypeInstance* instance, void*); } GType gtk_assert_dialog_get_type() { static GType assert_dialog_type; if (!assert_dialog_type) { const GTypeInfo assert_dialog_info = { sizeof (GtkAssertDialogClass), NULL, /* base_init */ NULL, /* base_finalize */ #if GTK_CHECK_VERSION(3,10,0) gtk_assert_dialog_class_init, /* class init */ #else NULL, #endif // GTK+ >= 3.10 / < 3.10 NULL, /* class_finalize */ NULL, /* class_data */ sizeof (GtkAssertDialog), 16, /* n_preallocs */ gtk_assert_dialog_init, NULL }; assert_dialog_type = g_type_register_static (GTK_TYPE_DIALOG, "GtkAssertDialog", &assert_dialog_info, (GTypeFlags)0); } return assert_dialog_type; } extern "C" { // For GTK+ >= 3.10, Composite Widget Templates are used to define composite widgets. #if GTK_CHECK_VERSION(3,10,0) static void gtk_assert_dialog_class_init(gpointer g_class, void*) { if (gtk_check_version(3,10,0) == NULL) { // GtkBuilder XML to be bound to the dialog class data static const char dlgTempl[] = "" "" "" "" "" "" "" "" "" "" "" "" "" "" "True" "False" "go-next" "" "" "True" "False" "edit-copy" "" "" "True" "False" "document-save" "" "" "True" "False" "application-exit" "" "" ""; // Verify numeric values of response codes hard-coded in the XML wxASSERT(GTK_ASSERT_DIALOG_STOP == 0); wxASSERT(GTK_ASSERT_DIALOG_CONTINUE == 1); GtkWidgetClass* widgetClass = GTK_WIDGET_CLASS(g_class); GBytes* templBytes = g_bytes_new_static(dlgTempl, sizeof(dlgTempl)-1); gtk_widget_class_set_template(widgetClass, templBytes); // Define the relationship of the entries in GtkAssertDialog and entries defined in the XML gtk_widget_class_bind_template_child(widgetClass, GtkAssertDialog, message); #if wxUSE_STACKWALKER gtk_widget_class_bind_template_child(widgetClass, GtkAssertDialog, expander); gtk_widget_class_bind_template_child(widgetClass, GtkAssertDialog, treeview); #endif // wxUSE_STACKWALKER gtk_widget_class_bind_template_child(widgetClass, GtkAssertDialog, shownexttime); // Bind connections defined in the GtkBuilder XML // with callbacks exposed by GtkAssertDialog. #if wxUSE_STACKWALKER gtk_widget_class_bind_template_callback(widgetClass, gtk_assert_dialog_expander_callback); gtk_widget_class_bind_template_callback(widgetClass, gtk_assert_dialog_save_backtrace_callback); gtk_widget_class_bind_template_callback(widgetClass, gtk_assert_dialog_copy_callback); #endif // wxUSE_STACKWALKER gtk_widget_class_bind_template_callback(widgetClass, gtk_assert_dialog_continue_callback); } } #endif // GTK+ >= 3.10 static void gtk_assert_dialog_init(GTypeInstance* instance, void*) { // For GTK+ >= 3.10 create and initialize the dialog from the already assigned template // or create the dialog "manually" otherwise. #if GTK_CHECK_VERSION(3,10,0) if (gtk_check_version(3,10,0) == NULL) { GtkAssertDialog* dlg = GTK_ASSERT_DIALOG(instance); gtk_widget_init_template(GTK_WIDGET(dlg)); /* complete creation */ dlg->callback = NULL; dlg->userdata = NULL; } else #endif // GTK+ >= 3.10 { GtkAssertDialog* dlg = GTK_ASSERT_DIALOG(instance); GtkWidget *continuebtn; // This code is called only for GTK+ < 3.10 { GtkWidget *vbox, *hbox, *image; /* start the main vbox */ wxGCC_WARNING_SUPPRESS(deprecated-declarations) gtk_widget_push_composite_child (); wxGCC_WARNING_RESTORE() vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8); gtk_container_set_border_width (GTK_CONTAINER(vbox), 8); gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dlg))), vbox, true, true, 5); /* add the icon+message hbox */ hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0); gtk_box_pack_start (GTK_BOX(vbox), hbox, FALSE, FALSE, 0); /* icon */ wxGCC_WARNING_SUPPRESS(deprecated-declarations) image = gtk_image_new_from_stock("gtk-dialog-error", GTK_ICON_SIZE_DIALOG); wxGCC_WARNING_RESTORE() gtk_box_pack_start (GTK_BOX(hbox), image, FALSE, FALSE, 12); { GtkWidget *vbox2, *info; /* message */ vbox2 = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0); gtk_box_pack_start (GTK_BOX (hbox), vbox2, TRUE, TRUE, 0); info = gtk_label_new ("An assertion failed!"); gtk_box_pack_start (GTK_BOX(vbox2), info, TRUE, TRUE, 8); /* assert message */ dlg->message = gtk_label_new (NULL); gtk_label_set_selectable (GTK_LABEL (dlg->message), TRUE); gtk_label_set_line_wrap (GTK_LABEL (dlg->message), TRUE); gtk_label_set_justify (GTK_LABEL (dlg->message), GTK_JUSTIFY_LEFT); gtk_widget_set_size_request (GTK_WIDGET(dlg->message), 450, -1); gtk_box_pack_end (GTK_BOX(vbox2), GTK_WIDGET(dlg->message), TRUE, TRUE, 8); } #if wxUSE_STACKWALKER /* add the expander */ dlg->expander = gtk_expander_new_with_mnemonic ("Back_trace:"); gtk_box_pack_start (GTK_BOX(vbox), dlg->expander, TRUE, TRUE, 0); g_signal_connect (dlg->expander, "activate", G_CALLBACK(gtk_assert_dialog_expander_callback), dlg); #endif // wxUSE_STACKWALKER } #if wxUSE_STACKWALKER { GtkWidget *hbox, *vbox, *button, *sw; /* create expander's vbox */ vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0); gtk_container_add (GTK_CONTAINER (dlg->expander), vbox); /* add a scrollable window under the expander */ sw = gtk_scrolled_window_new (NULL, NULL); gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (sw), GTK_SHADOW_ETCHED_IN); gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sw), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC); gtk_widget_set_size_request(GTK_WIDGET(sw), -1, 180); gtk_box_pack_start (GTK_BOX(vbox), sw, TRUE, TRUE, 8); /* add the treeview to the scrollable window */ dlg->treeview = gtk_assert_dialog_create_backtrace_list_model (); gtk_container_add (GTK_CONTAINER (sw), dlg->treeview); /* create button's hbox */ hbox = gtk_button_box_new(GTK_ORIENTATION_HORIZONTAL); gtk_box_pack_end (GTK_BOX(vbox), hbox, FALSE, FALSE, 0); gtk_button_box_set_layout (GTK_BUTTON_BOX(hbox), GTK_BUTTONBOX_END); /* add the buttons */ button = gtk_assert_dialog_add_button_to(GTK_BOX(hbox), "Save to _file", "gtk-save"); g_signal_connect (button, "clicked", G_CALLBACK(gtk_assert_dialog_save_backtrace_callback), dlg); button = gtk_assert_dialog_add_button_to(GTK_BOX(hbox), "Copy to clip_board", "gtk-copy"); g_signal_connect (button, "clicked", G_CALLBACK(gtk_assert_dialog_copy_callback), dlg); } #endif // wxUSE_STACKWALKER /* add the checkbutton */ dlg->shownexttime = gtk_check_button_new_with_mnemonic("Show this _dialog the next time"); gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON(dlg->shownexttime), TRUE); wxGCC_WARNING_SUPPRESS(deprecated-declarations) gtk_box_pack_end(GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(dlg))), dlg->shownexttime, false, true, 8); wxGCC_WARNING_RESTORE() /* add the stop button */ gtk_assert_dialog_add_button(dlg, "_Stop", "gtk-quit", GTK_ASSERT_DIALOG_STOP); /* add the continue button */ continuebtn = gtk_assert_dialog_add_button(dlg, "_Continue", "gtk-yes", GTK_ASSERT_DIALOG_CONTINUE); gtk_dialog_set_default_response (GTK_DIALOG (dlg), GTK_ASSERT_DIALOG_CONTINUE); g_signal_connect (continuebtn, "clicked", G_CALLBACK(gtk_assert_dialog_continue_callback), dlg); /* complete creation */ dlg->callback = NULL; dlg->userdata = NULL; /* the resizable property of this window is modified by the expander: when it's collapsed, the window must be non-resizable! */ gtk_window_set_resizable (GTK_WINDOW (dlg), FALSE); wxGCC_WARNING_SUPPRESS(deprecated-declarations) gtk_widget_pop_composite_child (); wxGCC_WARNING_RESTORE() gtk_widget_show_all (GTK_WIDGET(dlg)); } } } /* ---------------------------------------------------------------------------- GtkAssertDialog public API ---------------------------------------------------------------------------- */ gchar *gtk_assert_dialog_get_message (GtkAssertDialog *dlg) { /* NOTES: 1) returned string must g_free()d ! 2) Pango markup is automatically stripped off by GTK */ return g_strdup (gtk_label_get_text (GTK_LABEL(dlg->message))); } #if wxUSE_STACKWALKER gchar *gtk_assert_dialog_get_backtrace (GtkAssertDialog *dlg) { gchar *function, *sourcefile, *linenum; guint count; GtkTreeModel *model; GtkTreeIter iter; GString *string; g_return_val_if_fail (GTK_IS_ASSERT_DIALOG (dlg), NULL); model = gtk_tree_view_get_model (GTK_TREE_VIEW(dlg->treeview)); /* iterate over the list */ if (!gtk_tree_model_get_iter_first (model, &iter)) return NULL; string = g_string_new(""); do { /* append this stack frame's info to the string */ gtk_tree_model_get(model, &iter, STACKFRAME_LEVEL_COLIDX, &count, FUNCTION_PROTOTYPE_COLIDX, &function, SOURCE_FILE_COLIDX, &sourcefile, LINE_NUMBER_COLIDX, &linenum, -1); g_string_append_printf(string, "[%u] %s", count, function); if (sourcefile[0] != '\0') g_string_append_printf (string, " %s", sourcefile); if (linenum[0] != '\0') g_string_append_printf (string, ":%s", linenum); g_string_append (string, "\n"); g_free (function); g_free (sourcefile); g_free (linenum); } while (gtk_tree_model_iter_next (model, &iter)); /* returned string must g_free()d */ return g_string_free (string, FALSE); } #endif // wxUSE_STACKWALKER void gtk_assert_dialog_set_message(GtkAssertDialog *dlg, const gchar *msg) { g_return_if_fail (GTK_IS_ASSERT_DIALOG (dlg)); /* prepend and append the tag NOTE: g_markup_printf_escaped() is not used because it's available only for glib >= 2.4 */ gchar *escaped_msg = g_markup_escape_text (msg, -1); gchar *decorated_msg = g_strdup_printf ("%s", escaped_msg); gtk_label_set_markup (GTK_LABEL(dlg->message), decorated_msg); g_free (decorated_msg); g_free (escaped_msg); } #if wxUSE_STACKWALKER void gtk_assert_dialog_set_backtrace_callback(GtkAssertDialog *assertdlg, GtkAssertDialogStackFrameCallback callback, void *userdata) { assertdlg->callback = callback; assertdlg->userdata = userdata; } void gtk_assert_dialog_append_stack_frame(GtkAssertDialog *dlg, const gchar *function, const gchar *sourcefile, guint line_number) { GtkTreeModel *model; GtkTreeIter iter; GString *linenum; gint count; g_return_if_fail (GTK_IS_ASSERT_DIALOG (dlg)); model = gtk_tree_view_get_model (GTK_TREE_VIEW(dlg->treeview)); /* how many items are in the list up to now ? */ count = gtk_tree_model_iter_n_children (model, NULL); linenum = g_string_new(""); if ( line_number != 0 ) g_string_printf (linenum, "%u", line_number); /* add data to the list store */ gtk_list_store_append (GTK_LIST_STORE(model), &iter); gtk_list_store_set (GTK_LIST_STORE(model), &iter, STACKFRAME_LEVEL_COLIDX, count+1, /* start from 1 and not from 0 */ FUNCTION_PROTOTYPE_COLIDX, function, SOURCE_FILE_COLIDX, sourcefile, LINE_NUMBER_COLIDX, linenum->str, -1); g_string_free (linenum, TRUE); } #endif // wxUSE_STACKWALKER GtkWidget *gtk_assert_dialog_new(void) { void* dialog = g_object_new(GTK_TYPE_ASSERT_DIALOG, NULL); return GTK_WIDGET (dialog); } #endif // wxDEBUG_LEVEL