summaryrefslogtreecommitdiffstats
path: root/app/gui/gui-message.c
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--app/gui/gui-message.c501
1 files changed, 501 insertions, 0 deletions
diff --git a/app/gui/gui-message.c b/app/gui/gui-message.c
new file mode 100644
index 0000000..90e6314
--- /dev/null
+++ b/app/gui/gui-message.c
@@ -0,0 +1,501 @@
+/* GIMP - The GNU Image Manipulation Program
+ * Copyright (C) 1995 Spencer Kimball and Peter Mattis
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include <gegl.h>
+#include <gtk/gtk.h>
+
+#include "libgimpbase/gimpbase.h"
+#include "libgimpwidgets/gimpwidgets.h"
+
+#include "gui-types.h"
+
+#include "config/gimpguiconfig.h"
+
+#include "core/gimp.h"
+#include "core/gimpprogress.h"
+
+#include "plug-in/gimpplugin.h"
+
+#include "widgets/gimpcriticaldialog.h"
+#include "widgets/gimpdialogfactory.h"
+#include "widgets/gimpdockable.h"
+#include "widgets/gimperrorconsole.h"
+#include "widgets/gimperrordialog.h"
+#include "widgets/gimpprogressdialog.h"
+#include "widgets/gimpsessioninfo.h"
+#include "widgets/gimpwidgets-utils.h"
+#include "widgets/gimpwindowstrategy.h"
+
+#include "about.h"
+
+#include "gui-message.h"
+
+#include "gimp-intl.h"
+
+
+#define MAX_TRACES 3
+#define MAX_ERRORS 10
+
+
+typedef struct
+{
+ Gimp *gimp;
+ gchar *domain;
+ gchar *message;
+ gchar *trace;
+ GObject *handler;
+ GimpMessageSeverity severity;
+} GimpLogMessageData;
+
+
+static gboolean gui_message_idle (gpointer user_data);
+static gboolean gui_message_error_console (Gimp *gimp,
+ GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message);
+static gboolean gui_message_error_dialog (Gimp *gimp,
+ GObject *handler,
+ GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message,
+ const gchar *trace);
+static void gui_message_console (GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message);
+static gchar * gui_message_format (GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message);
+
+static GtkWidget * global_error_dialog (void);
+static GtkWidget * global_critical_dialog (void);
+
+static void gui_message_reset_errors (GObject *object,
+ gpointer user_data);
+
+
+static GMutex mutex;
+static gint n_traces = 0;
+static gint n_errors = 0;
+
+
+void
+gui_message (Gimp *gimp,
+ GObject *handler,
+ GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message)
+{
+ gchar *trace = NULL;
+ gboolean gen_trace = FALSE;
+
+ switch (gimp->message_handler)
+ {
+ case GIMP_ERROR_CONSOLE:
+ if (gui_message_error_console (gimp, severity, domain, message))
+ return;
+
+ gimp->message_handler = GIMP_MESSAGE_BOX;
+ /* fallthru */
+
+ case GIMP_MESSAGE_BOX:
+ if (severity >= GIMP_MESSAGE_BUG_WARNING)
+ {
+ g_mutex_lock (&mutex);
+ /* Trace creation can be time consuming so don't block the
+ * mutex for too long and only increment and set a boolean
+ * here.
+ */
+ if (n_traces < MAX_TRACES)
+ {
+ gen_trace = TRUE;
+ n_traces++;
+ }
+ g_mutex_unlock (&mutex);
+ }
+
+ if (gen_trace)
+ {
+ /* We need to create the trace here because for multi-thread
+ * errors (i.e. non-GIMP ones), the backtrace after a idle
+ * function will simply be useless. It needs to happen in the
+ * buggy thread to be meaningful.
+ */
+ gimp_stack_trace_print (NULL, NULL, &trace);
+ }
+
+ if (g_strcmp0 (GIMP_ACRONYM, domain) != 0)
+ {
+ /* Handle non-GIMP messages in a multi-thread safe way,
+ * because we can't know for sure whether the log message may
+ * not have been called from a thread other than the main one.
+ */
+ GimpLogMessageData *data;
+
+ data = g_new0 (GimpLogMessageData, 1);
+ data->gimp = gimp;
+ data->domain = g_strdup (domain);
+ data->message = g_strdup (message);
+ data->trace = trace;
+ data->handler = handler? g_object_ref (handler) : NULL;
+ data->severity = severity;
+
+ gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
+ gui_message_idle,
+ data, g_free);
+ return;
+ }
+ if (gui_message_error_dialog (gimp, handler, severity,
+ domain, message, trace))
+ break;
+
+ gimp->message_handler = GIMP_CONSOLE;
+ /* fallthru */
+
+ case GIMP_CONSOLE:
+ gui_message_console (severity, domain, message);
+ break;
+ }
+ if (trace)
+ g_free (trace);
+}
+
+static gboolean
+gui_message_idle (gpointer user_data)
+{
+ GimpLogMessageData *data = (GimpLogMessageData *) user_data;
+
+ if (! gui_message_error_dialog (data->gimp,
+ data->handler,
+ data->severity,
+ data->domain,
+ data->message,
+ data->trace))
+ {
+ gui_message_console (data->severity,
+ data->domain,
+ data->message);
+ }
+ g_free (data->domain);
+ g_free (data->message);
+ if (data->trace)
+ g_free (data->trace);
+ if (data->handler)
+ g_object_unref (data->handler);
+
+ return FALSE;
+}
+
+static gboolean
+gui_message_error_console (Gimp *gimp,
+ GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message)
+{
+ GtkWidget *dockable;
+
+ dockable = gimp_dialog_factory_find_widget (gimp_dialog_factory_get_singleton (),
+ "gimp-error-console");
+
+ /* avoid raising the error console for unhighlighted messages */
+ if (dockable)
+ {
+ GtkWidget *child = gtk_bin_get_child (GTK_BIN (dockable));
+
+ if (GIMP_ERROR_CONSOLE (child)->highlight[severity])
+ dockable = NULL;
+ }
+
+ if (! dockable)
+ {
+ GdkScreen *screen;
+ gint monitor;
+
+ monitor = gimp_get_monitor_at_pointer (&screen);
+
+ dockable =
+ gimp_window_strategy_show_dockable_dialog (GIMP_WINDOW_STRATEGY (gimp_get_window_strategy (gimp)),
+ gimp,
+ gimp_dialog_factory_get_singleton (),
+ screen, monitor,
+ "gimp-error-console");
+ }
+
+ if (dockable)
+ {
+ GtkWidget *child = gtk_bin_get_child (GTK_BIN (dockable));
+
+ gimp_error_console_add (GIMP_ERROR_CONSOLE (child),
+ severity, domain, message);
+
+ return TRUE;
+ }
+
+ return FALSE;
+}
+
+static void
+progress_error_dialog_unset (GimpProgress *progress)
+{
+ g_object_set_data (G_OBJECT (progress), "gimp-error-dialog", NULL);
+}
+
+static GtkWidget *
+progress_error_dialog (GimpProgress *progress)
+{
+ GtkWidget *dialog;
+
+ g_return_val_if_fail (GIMP_IS_PROGRESS (progress), NULL);
+
+ dialog = g_object_get_data (G_OBJECT (progress), "gimp-error-dialog");
+
+ if (! dialog)
+ {
+ dialog = gimp_error_dialog_new (_("GIMP Message"));
+
+ g_object_set_data (G_OBJECT (progress), "gimp-error-dialog", dialog);
+
+ g_signal_connect_object (dialog, "destroy",
+ G_CALLBACK (progress_error_dialog_unset),
+ progress, G_CONNECT_SWAPPED);
+
+ if (GTK_IS_WIDGET (progress))
+ {
+ GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (progress));
+
+ if (GTK_IS_WINDOW (toplevel))
+ gtk_window_set_transient_for (GTK_WINDOW (dialog),
+ GTK_WINDOW (toplevel));
+ }
+ else
+ {
+ guint32 window_id = gimp_progress_get_window_id (progress);
+
+ if (window_id)
+ gimp_window_set_transient_for (GTK_WINDOW (dialog), window_id);
+ }
+ }
+
+ return dialog;
+}
+
+static gboolean
+gui_message_error_dialog (Gimp *gimp,
+ GObject *handler,
+ GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message,
+ const gchar *trace)
+{
+ GtkWidget *dialog;
+ GtkMessageType type = GTK_MESSAGE_ERROR;
+
+ switch (severity)
+ {
+ case GIMP_MESSAGE_INFO:
+ type = GTK_MESSAGE_INFO;
+ break;
+ case GIMP_MESSAGE_WARNING:
+ type = GTK_MESSAGE_WARNING;
+ break;
+ case GIMP_MESSAGE_ERROR:
+ type = GTK_MESSAGE_ERROR;
+ break;
+ case GIMP_MESSAGE_BUG_WARNING:
+ case GIMP_MESSAGE_BUG_CRITICAL:
+ type = GTK_MESSAGE_OTHER;
+ break;
+ }
+
+ if (severity >= GIMP_MESSAGE_BUG_WARNING)
+ {
+ /* Process differently programming errors.
+ * The reason is that we will generate traces, which will take
+ * significant place, and cannot be processed as a progress
+ * message or in the global dialog. It will require its own
+ * dedicated dialog which will encourage people to report the bug.
+ */
+ gboolean gui_error = FALSE;
+
+ g_mutex_lock (&mutex);
+ if (n_errors < MAX_ERRORS)
+ {
+ gui_error = TRUE;
+ n_errors++;
+ }
+ g_mutex_unlock (&mutex);
+
+ if (gui_error || trace)
+ {
+ gchar *text;
+
+ dialog = global_critical_dialog ();
+
+ text = gui_message_format (severity, domain, message);
+ gimp_critical_dialog_add (dialog, text, trace, FALSE, NULL, 0);
+
+ gtk_widget_show (dialog);
+
+ g_free (text);
+
+ return TRUE;
+ }
+ else
+ {
+ const gchar *reason = "Message";
+
+ gimp_enum_get_value (GIMP_TYPE_MESSAGE_SEVERITY, severity,
+ NULL, NULL, &reason, NULL);
+
+ /* Since we overridden glib default's WARNING and CRITICAL
+ * handler, if we decide not to handle this error in the end,
+ * let's just print it in terminal in a similar fashion as
+ * glib's default handler (though without the fancy terminal
+ * colors right now).
+ */
+ g_printerr ("%s-%s: %s\n", domain, reason, message);
+
+ return TRUE;
+ }
+ }
+ else if (GIMP_IS_PROGRESS (handler))
+ {
+ /* If there's already an error dialog associated with this
+ * progress, then continue without trying gimp_progress_message().
+ */
+ if (! g_object_get_data (handler, "gimp-error-dialog") &&
+ gimp_progress_message (GIMP_PROGRESS (handler), gimp,
+ severity, domain, message))
+ {
+ return TRUE;
+ }
+ }
+ else if (GTK_IS_WIDGET (handler))
+ {
+ GtkWidget *parent = GTK_WIDGET (handler);
+
+ dialog =
+ gtk_message_dialog_new (GTK_WINDOW (gtk_widget_get_toplevel (parent)),
+ GTK_DIALOG_DESTROY_WITH_PARENT,
+ type, GTK_BUTTONS_OK,
+ "%s", message);
+
+ g_signal_connect (dialog, "response",
+ G_CALLBACK (gtk_widget_destroy),
+ NULL);
+
+ gtk_widget_show (dialog);
+
+ return TRUE;
+ }
+
+ if (GIMP_IS_PROGRESS (handler) && ! GIMP_IS_PROGRESS_DIALOG (handler))
+ dialog = progress_error_dialog (GIMP_PROGRESS (handler));
+ else
+ dialog = global_error_dialog ();
+
+ if (dialog)
+ {
+ gimp_error_dialog_add (GIMP_ERROR_DIALOG (dialog),
+ gimp_get_message_icon_name (severity),
+ domain, message);
+ gtk_window_present (GTK_WINDOW (dialog));
+
+ return TRUE;
+ }
+
+ return FALSE;
+}
+
+static void
+gui_message_console (GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message)
+{
+ gchar *formatted_message;
+
+ formatted_message = gui_message_format (severity, domain, message);
+ g_printerr ("%s\n\n", formatted_message);
+ g_free (formatted_message);
+}
+
+static gchar *
+gui_message_format (GimpMessageSeverity severity,
+ const gchar *domain,
+ const gchar *message)
+{
+ const gchar *desc = "Message";
+ gchar *formatted_message;
+
+ gimp_enum_get_value (GIMP_TYPE_MESSAGE_SEVERITY, severity,
+ NULL, NULL, &desc, NULL);
+
+ formatted_message = g_strdup_printf ("%s-%s: %s", domain, desc, message);
+
+ return formatted_message;
+}
+
+static GtkWidget *
+global_error_dialog (void)
+{
+ GdkScreen *screen;
+ gint monitor;
+
+ monitor = gimp_get_monitor_at_pointer (&screen);
+
+ return gimp_dialog_factory_dialog_new (gimp_dialog_factory_get_singleton (),
+ screen, monitor,
+ NULL /*ui_manager*/,
+ "gimp-error-dialog", -1,
+ FALSE);
+}
+
+static GtkWidget *
+global_critical_dialog (void)
+{
+ GtkWidget *dialog;
+ GdkScreen *screen;
+ gint monitor;
+
+ monitor = gimp_get_monitor_at_pointer (&screen);
+
+ dialog = gimp_dialog_factory_dialog_new (gimp_dialog_factory_get_singleton (),
+ screen, monitor,
+ NULL /*ui_manager*/,
+ "gimp-critical-dialog", -1,
+ FALSE);
+ g_signal_handlers_disconnect_by_func (dialog,
+ gui_message_reset_errors,
+ NULL);
+ g_signal_connect (dialog, "destroy",
+ G_CALLBACK (gui_message_reset_errors),
+ NULL);
+ return dialog;
+}
+
+static void
+gui_message_reset_errors (GObject *object,
+ gpointer user_data)
+{
+ g_mutex_lock (&mutex);
+ n_errors = 0;
+ n_traces = 0;
+ g_mutex_unlock (&mutex);
+}