From Jakub Zawadzki via bug 4273:
[obnox/wireshark/wip.git] / gtk / simple_dialog.c
index 62cd109921eca7e40d436fdec1c1d5df8e9eaf8a..e4586fd452dbebf7f7c0a0e245c6b997bb7901e1 100644 (file)
@@ -1,23 +1,22 @@
 /* simple_dialog.c
  * Simple message dialog box routines.
  *
- * $Id: simple_dialog.c,v 1.10 2002/06/04 11:24:35 guy Exp $
+ * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
- * 
  * 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 2
  * 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, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
-
-#include <glib.h>
+#include <stdio.h>
 
 #include <gtk/gtk.h>
 
-#include <stdarg.h>
-#include <stdio.h>
+#include <epan/strutil.h>
 
-#ifdef NEED_SNPRINTF_H
-# include "snprintf.h"
-#endif
+#include "../simple_dialog.h"
+
+#include "gtk/gtkglobals.h"
+#include "gtk/dlg_utils.h"
+#include "gtk/gui_utils.h"
+#include "gtk/stock_icons.h"
+
+#include "main_statusbar.h"
 
-#include "gtkglobals.h"
-#include "simple_dialog.h"
-#include "dlg_utils.h"
+#include "image/stock_dialog_error_48.xpm"
+#include "image/stock_dialog_info_48.xpm"
+#include "image/stock_dialog_warning_48.xpm"
+#include "image/stock_dialog_stop_48.xpm"
 
-#include "image/eexcl3d64.xpm"
-#include "image/eicon3d64.xpm"
 
 static void simple_dialog_cancel_cb(GtkWidget *, gpointer);
 
-static const gchar bm_key[] = "button mask";
+#define CALLBACK_FCT_KEY    "ESD_Callback_Fct"
+#define CALLBACK_BTN_KEY    "ESD_Callback_Btn"
+#define CALLBACK_DATA_KEY   "ESD_Callback_Data"
+#define CHECK_BUTTON        "ESD_Check_Button"
 
-/* Simple dialog function - Displays a dialog box with the supplied message
- * text.
- * 
- * Args:
- * type       : One of ESD_TYPE_*.
- * btn_mask   : The address of a gint.  The value passed in determines if
- *              the 'Cancel' button is displayed.  The button pressed by the 
- *              user is passed back.
- * msg_format : Sprintf-style format of the text displayed in the dialog.
- * ...        : Argument list for msg_format
- *
+/*
+ * Queue for messages requested before we have a main window.
  */
-#define ESD_MAX_MSG_LEN 2048
-void
-simple_dialog(gint type, gint *btn_mask, gchar *msg_format, ...) {
-  GtkWidget   *win, *main_vb, *top_hb, *type_pm, *msg_label,
-              *bbox, *ok_btn, *cancel_btn;
+typedef struct {
+       gint    type;
+       gint    btn_mask;
+       char    *message;
+} queued_message_t;
+
+static GSList *message_queue;
+
+static GtkWidget *
+display_simple_dialog(gint type, gint btn_mask, char *message)
+{
+  GtkWidget   *win, *main_vb, *top_hb, *msg_vb, *type_pm, *msg_label, *ask_cb,
+              *bbox, *ok_bt, *yes_bt, *bt, *save_bt, *dont_save_bt;
   GdkPixmap   *pixmap;
   GdkBitmap   *mask;
   GtkStyle    *style;
   GdkColormap *cmap;
-  va_list      ap;
-  gchar        message[ESD_MAX_MSG_LEN];
-  gchar      **icon;
+  const gchar **icon;
 
   /* Main window */
-  switch (type & ~ESD_TYPE_MODAL) {
+  switch (type) {
   case ESD_TYPE_WARN :
-    icon = eexcl3d64_xpm;
-    win = dlg_window_new("Ethereal: Warning");
+    icon = stock_dialog_warning_48_xpm;
+    break;
+  case ESD_TYPE_CONFIRMATION:
+    icon = stock_dialog_warning_48_xpm;
+    break;
+  case ESD_TYPE_ERROR:
+    icon = stock_dialog_error_48_xpm;
     break;
-  case ESD_TYPE_CRIT :
-    icon = eexcl3d64_xpm;
-    win = dlg_window_new("Ethereal: Error");
+  case ESD_TYPE_STOP :
+    icon = stock_dialog_stop_48_xpm;
     break;
   case ESD_TYPE_INFO :
   default :
-    icon = eicon3d64_xpm;
-    win = dlg_window_new("Ethereal: Information");
+    icon = stock_dialog_info_48_xpm;
     break;
   }
 
-  if (type & ESD_TYPE_MODAL)
-    gtk_window_set_modal(GTK_WINDOW(win), TRUE);
-
-  gtk_container_border_width(GTK_CONTAINER(win), 7);
+  /*
+   * The GNOME HIG:
+   *
+   *   http://developer.gnome.org/projects/gup/hig/1.0/windows.html#alert-windows
+   *
+   * says that the title should be empty for alert boxes, so there's "less
+   * visual noise and confounding text."
+   *
+   * The Windows HIG:
+   *
+   *   http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwue/html/ch09f.asp
+   *
+   * says it should
+   *
+   *   ...appropriately identify the source of the message -- usually
+   *   the name of the object.  For example, if the message results
+   *   from editing a document, the title text is the name of the
+   *   document, optionally followed by the application name.  If the
+   *   message results from a non-document object, then use the
+   *   application name."
+   *
+   * and notes that the title is important "because message boxes might
+   * not always the the result of current user interaction" (e.g., some
+   * app might randomly pop something up, e.g. some browser letting you
+   * know that it couldn't fetch something because of a timeout).
+   *
+   * It also says not to use "warning" or "caution", as there's already
+   * an icon that tells you what type of alert it is, and that you
+   * shouldn't say "error", as that provides no useful information.
+   *
+   * So we give it a title on Win32, and don't give it one on UN*X.
+   * For now, we give it a Win32 title of just "Wireshark"; we should
+   * arguably take an argument for the title.
+   */
+  if(btn_mask == ESD_BTN_NONE) {
+       win = splash_window_new();
+  } else {
+#ifdef _WIN32
+    win = dlg_window_new("Wireshark");
+#else
+    win = dlg_window_new("");
+#endif
+  }
 
-  gtk_object_set_data(GTK_OBJECT(win), bm_key, btn_mask);
+  gtk_window_set_modal(GTK_WINDOW(win), TRUE);
+  gtk_container_set_border_width(GTK_CONTAINER(win), 6);
 
   /* Container for our rows */
-  main_vb = gtk_vbox_new(FALSE, 5);
-  gtk_container_border_width(GTK_CONTAINER(main_vb), 5);
+  main_vb = gtk_vbox_new(FALSE, 12);
   gtk_container_add(GTK_CONTAINER(win), main_vb);
   gtk_widget_show(main_vb);
 
   /* Top row: Icon and message text */
-  top_hb = gtk_hbox_new(FALSE, 10);
+  top_hb = gtk_hbox_new(FALSE, 12);
+  gtk_container_set_border_width(GTK_CONTAINER(main_vb), 6);
   gtk_container_add(GTK_CONTAINER(main_vb), top_hb);
   gtk_widget_show(top_hb);
-  
+
+  /* icon */
   style = gtk_widget_get_style(win);
   cmap  = gdk_colormap_get_system();
   pixmap = gdk_pixmap_colormap_create_from_xpm_d(NULL, cmap,  &mask,
-    &style->bg[GTK_STATE_NORMAL], icon);
-  type_pm = gtk_pixmap_new(pixmap, mask);
-  gtk_misc_set_alignment (GTK_MISC (type_pm), 0.5, 0.0);
+    &style->bg[GTK_STATE_NORMAL], (gchar **) icon);
+  type_pm = gtk_image_new_from_pixmap(pixmap, mask);
+  gtk_misc_set_alignment (GTK_MISC (type_pm), 0.5f, 0.0f);
   gtk_container_add(GTK_CONTAINER(top_hb), type_pm);
   gtk_widget_show(type_pm);
 
-  /* Load our vararg list into the message string */
-  va_start(ap, msg_format);
-  vsnprintf(message, ESD_MAX_MSG_LEN, msg_format, ap);
-  va_end(ap);
+  /* column for message and optional check button */
+  msg_vb = gtk_vbox_new(FALSE, 6);
+  gtk_box_set_spacing(GTK_BOX(msg_vb), 24);
+  gtk_container_add(GTK_CONTAINER(top_hb), msg_vb);
+  gtk_widget_show(msg_vb);
 
+  /* message */
   msg_label = gtk_label_new(message);
+
+  gtk_label_set_markup(GTK_LABEL(msg_label), message);
+  gtk_label_set_selectable(GTK_LABEL(msg_label), TRUE);
+#if GTK_CHECK_VERSION(2,9,0)
+  g_object_set(gtk_widget_get_settings(msg_label),
+    "gtk-label-select-on-focus", FALSE, NULL);
+#endif
+
   gtk_label_set_justify(GTK_LABEL(msg_label), GTK_JUSTIFY_FILL);
-  gtk_container_add(GTK_CONTAINER(top_hb), msg_label);
+  gtk_misc_set_alignment (GTK_MISC (type_pm), 0.5f, 0.0f);
+  gtk_container_add(GTK_CONTAINER(msg_vb), msg_label);
+  gtk_label_set_line_wrap(GTK_LABEL(msg_label), TRUE);
   gtk_widget_show(msg_label);
-  
+
+  if(btn_mask == ESD_BTN_NONE) {
+       gtk_widget_show(win);
+       return win;
+  }
+
+  /* optional check button */
+  ask_cb = gtk_check_button_new_with_label("replace with text...");
+  gtk_container_add(GTK_CONTAINER(msg_vb), ask_cb);
+  g_object_set_data(G_OBJECT(win), CHECK_BUTTON, ask_cb);
+
   /* Button row */
-  bbox = gtk_hbutton_box_new();
-  gtk_button_box_set_layout (GTK_BUTTON_BOX (bbox), GTK_BUTTONBOX_END);
+  switch(btn_mask) {
+  case(ESD_BTN_OK):
+    bbox = dlg_button_row_new(GTK_STOCK_OK, NULL);
+    break;
+  case(ESD_BTN_OK | ESD_BTN_CANCEL):
+    bbox = dlg_button_row_new(GTK_STOCK_OK, GTK_STOCK_CANCEL, NULL);
+    break;
+  case(ESD_BTN_CLEAR | ESD_BTN_CANCEL):
+    bbox = dlg_button_row_new(GTK_STOCK_CLEAR, GTK_STOCK_CANCEL, NULL);
+    break;
+  case(ESD_BTNS_YES_NO_CANCEL):
+    bbox = dlg_button_row_new(GTK_STOCK_YES, GTK_STOCK_NO, GTK_STOCK_CANCEL, NULL);
+    break;
+  case(ESD_BTNS_SAVE_DONTSAVE_CANCEL):
+    bbox = dlg_button_row_new(GTK_STOCK_SAVE, WIRESHARK_STOCK_DONT_SAVE, GTK_STOCK_CANCEL, NULL);
+    break;
+  case(ESD_BTNS_SAVE_QUIT_DONTSAVE_CANCEL):
+    bbox = dlg_button_row_new(GTK_STOCK_SAVE, WIRESHARK_STOCK_QUIT_DONT_SAVE, GTK_STOCK_CANCEL, NULL);
+    break;
+  case(ESD_BTNS_YES_NO):
+    bbox = dlg_button_row_new(GTK_STOCK_YES, GTK_STOCK_NO, NULL);
+    break;
+  default:
+    g_assert_not_reached();
+    bbox = NULL;
+    break;
+  }
   gtk_container_add(GTK_CONTAINER(main_vb), bbox);
   gtk_widget_show(bbox);
 
-  ok_btn = gtk_button_new_with_label ("OK");
-  gtk_signal_connect_object(GTK_OBJECT(ok_btn), "clicked",
-    GTK_SIGNAL_FUNC(gtk_widget_destroy), GTK_OBJECT (win)); 
-  gtk_container_add(GTK_CONTAINER(bbox), ok_btn);
-  GTK_WIDGET_SET_FLAGS(ok_btn, GTK_CAN_DEFAULT);
-  gtk_widget_grab_default(ok_btn);
-  gtk_widget_show(ok_btn);
-
-  if (btn_mask && *btn_mask == ESD_BTN_CANCEL) {
-    cancel_btn = gtk_button_new_with_label("Cancel");
-    gtk_signal_connect(GTK_OBJECT(cancel_btn), "clicked",
-      GTK_SIGNAL_FUNC(simple_dialog_cancel_cb), (gpointer) win);
-    gtk_container_add(GTK_CONTAINER(bbox), cancel_btn);
-    GTK_WIDGET_SET_FLAGS(cancel_btn, GTK_CAN_DEFAULT);
-    gtk_widget_show(cancel_btn);
-
-    /* Catch the "key_press_event" signal in the window, so that we can catch
-       the ESC key being pressed and act as if the "Cancel" button had
-       been selected. */
-    dlg_set_cancel(win, cancel_btn);
-  } else {
-    /* Catch the "key_press_event" signal in the window, so that we can catch
-       the ESC key being pressed and act as if the "OK" button had
-       been selected. */
-    dlg_set_cancel(win, ok_btn);
+  ok_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_OK);
+  if(ok_bt) {
+      g_object_set_data(G_OBJECT(ok_bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_OK));
+      g_signal_connect(ok_bt, "clicked", G_CALLBACK(simple_dialog_cancel_cb), win);
+  }
+
+  save_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_SAVE);
+  if (save_bt) {
+      g_object_set_data(G_OBJECT(save_bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_SAVE));
+      g_signal_connect(save_bt, "clicked", G_CALLBACK(simple_dialog_cancel_cb), win);
+  }
+
+  dont_save_bt = g_object_get_data(G_OBJECT(bbox), WIRESHARK_STOCK_DONT_SAVE);
+  if (dont_save_bt) {
+      g_object_set_data(G_OBJECT(dont_save_bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_DONT_SAVE));
+      g_signal_connect(dont_save_bt, "clicked", G_CALLBACK(simple_dialog_cancel_cb), win);
+  }
+  
+  dont_save_bt = g_object_get_data(G_OBJECT(bbox), WIRESHARK_STOCK_QUIT_DONT_SAVE);
+  if (dont_save_bt) {
+      g_object_set_data(G_OBJECT(dont_save_bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_QUIT_DONT_SAVE));
+      g_signal_connect(dont_save_bt, "clicked", G_CALLBACK(simple_dialog_cancel_cb), win);
+  }
+  bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CLEAR);
+  if(bt) {
+      g_object_set_data(G_OBJECT(bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_CLEAR));
+      g_signal_connect(bt, "clicked", G_CALLBACK(simple_dialog_cancel_cb), win);
+  }
+
+  yes_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_YES);
+  if(yes_bt) {
+      g_object_set_data(G_OBJECT(yes_bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_YES));
+      g_signal_connect(yes_bt, "clicked", G_CALLBACK(simple_dialog_cancel_cb), win);
+  }
+
+  bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_NO);
+  if(bt) {
+      g_object_set_data(G_OBJECT(bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_NO));
+      g_signal_connect(bt, "clicked", G_CALLBACK(simple_dialog_cancel_cb), win);
+  }
+
+  bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CANCEL);
+  if(bt) {
+      g_object_set_data(G_OBJECT(bt), CALLBACK_BTN_KEY, GINT_TO_POINTER(ESD_BTN_CANCEL));
+      window_set_cancel_button(win, bt, simple_dialog_cancel_cb);
+  }
+
+  if(!bt) {
+      if(yes_bt) {
+          window_set_cancel_button(win, yes_bt, simple_dialog_cancel_cb);
+      } else {
+          window_set_cancel_button(win, ok_bt, simple_dialog_cancel_cb);
+      }
   }
 
-  if (btn_mask)
-    *btn_mask = ESD_BTN_OK;
+  dlg_button_focus_nth(bbox, 0);
 
   gtk_widget_show(win);
+
+  return win;
+}
+
+void
+display_queued_messages(void)
+{
+  queued_message_t *queued_message;
+
+  while (message_queue != NULL) {
+    queued_message = message_queue->data;
+    message_queue = g_slist_remove(message_queue, queued_message);
+
+    display_simple_dialog(queued_message->type, queued_message->btn_mask,
+                          queued_message->message);
+
+    g_free(queued_message->message);
+    g_free(queued_message);
+  }
+}
+
+/* Simple dialog function - Displays a dialog box with the supplied message
+ * text.
+ *
+ * Args:
+ * type       : One of ESD_TYPE_*.
+ * btn_mask   : The value passed in determines which buttons are displayed.
+ * msg_format : Sprintf-style format of the text displayed in the dialog.
+ * ...        : Argument list for msg_format
+ */
+
+gpointer
+vsimple_dialog(ESD_TYPE_E type, gint btn_mask, const gchar *msg_format, va_list ap)
+{
+  gchar             *vmessage;
+  gchar             *message;
+  queued_message_t *queued_message;
+  GtkWidget        *win;
+  GdkWindowState state = 0;
+
+  /* Format the message. */
+  vmessage = g_strdup_vprintf(msg_format, ap);
+
+  /* convert character encoding from locale to UTF8 (using iconv) */
+  message = g_locale_to_utf8(vmessage, -1, NULL, NULL, NULL);
+  g_free(vmessage);
+
+  if (top_level != NULL) {
+    state = gdk_window_get_state(top_level->window);
+  }
+
+  /* If we don't yet have a main window or it's iconified, don't show the
+     dialog. If showing up a dialog, while main window is iconified, program
+     will become unresponsive! */
+  if (top_level == NULL || state & GDK_WINDOW_STATE_ICONIFIED) {
+
+    queued_message = g_malloc(sizeof (queued_message_t));
+    queued_message->type = type;
+    queued_message->btn_mask = btn_mask;
+    queued_message->message = message;
+    message_queue = g_slist_append(message_queue, queued_message);
+    return NULL;
+  }
+
+  /*
+   * Do we have any queued up messages?  If so, pop them up.
+   */
+  display_queued_messages();
+
+  win = display_simple_dialog(type, btn_mask, message);
+
+  g_free(message);
+
+  return win;
+}
+
+gpointer
+simple_dialog(ESD_TYPE_E type, gint btn_mask, const gchar *msg_format, ...)
+{
+  va_list ap;
+  gpointer ret;
+
+  va_start(ap, msg_format);
+  ret = vsimple_dialog(type, btn_mask, msg_format, ap);
+  va_end(ap);
+  return ret;
 }
 
 static void
-simple_dialog_cancel_cb(GtkWidget *w _U_, gpointer win) {
-  gint *btn_mask = (gint *) gtk_object_get_data(win, bm_key);
-  
-  if (btn_mask)
-    *btn_mask = ESD_BTN_CANCEL;
-  gtk_widget_destroy(GTK_WIDGET(win));
+simple_dialog_cancel_cb(GtkWidget *w, gpointer win) {
+  gint button                           = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(w), CALLBACK_BTN_KEY));
+  simple_dialog_cb_t    callback_fct    = g_object_get_data(G_OBJECT(win), CALLBACK_FCT_KEY);
+  gpointer              data            = g_object_get_data(G_OBJECT(win), CALLBACK_DATA_KEY);
+
+  if (callback_fct)
+    (callback_fct) (win, button, data);
+
+    window_destroy(GTK_WIDGET(win));
+}
+
+void
+simple_dialog_close(gpointer dialog)
+{
+    window_destroy(GTK_WIDGET(dialog));
+}
+
+void simple_dialog_set_cb(gpointer dialog, simple_dialog_cb_t callback_fct, gpointer data)
+{
+
+    g_object_set_data(G_OBJECT(GTK_WIDGET(dialog)), CALLBACK_FCT_KEY, callback_fct);
+    g_object_set_data(G_OBJECT(GTK_WIDGET(dialog)), CALLBACK_DATA_KEY, data);
+}
+
+void simple_dialog_check_set(gpointer dialog, gchar *text _U_) {
+    GtkWidget *ask_cb = g_object_get_data(G_OBJECT(dialog), CHECK_BUTTON);
+
+    gtk_button_set_label(GTK_BUTTON(ask_cb), text);
+    gtk_widget_show(ask_cb);
+}
+
+gboolean simple_dialog_check_get(gpointer dialog) {
+    GtkWidget *ask_cb = g_object_get_data(G_OBJECT(GTK_WIDGET(dialog)), CHECK_BUTTON);
+
+    return gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(ask_cb));
+}
+
+char *
+simple_dialog_primary_start(void) {
+    return "<span weight=\"bold\" size=\"larger\">";
+}
+
+char *
+simple_dialog_primary_end(void) {
+    return "</span>";
+}
+
+char *
+simple_dialog_format_message(const char *msg)
+{
+    char *str;
+
+    if (msg) {
+       str = xml_escape(msg);
+    } else {
+       str = NULL;
+    }
+    return str;
+}
+
+/*
+ * This doesn't create a window, but it falls into the realm of "telling the
+ * user what happened" and having it here means it can be called from file.c.
+ */
+void
+simple_status(const gchar *msg_format, ...)
+{
+    va_list ap;
+    gchar *msg;
+    
+    va_start(ap, msg_format);
+    msg = g_strdup_vprintf(msg_format, ap);
+    va_end(ap);
+    
+    statusbar_push_temporary_msg(msg);
+    g_free(msg);
 }