The funneled GUI mini API.

A very reduced set of gui ops (by now just a text window) that can be funneled to dissectors (even plugins) via epan.


svn path=/trunk/; revision=17149

6 files changed, 424 insertions, 0 deletions

diff --git a/epan/Makefile.common b/epan/Makefile.common
index 4179bcdd19..013622241f 100644
--- a/epan/Makefile.common
+++ b/epan/Makefile.common
@@ -53,6 +53,7 @@ LIBETHEREAL_SRC = 		\
 	filesystem.c		\
 	follow.c		\
 	frame_data.c		\
+	funnel.c    \
 	h225-persistentdata.c	\
 	in_cksum.c		\
 	ipproto.c		\
@@ -127,6 +128,7 @@ LIBETHEREAL_INCLUDES = 		\
 	filesystem.h		\
 	follow.h		\
 	frame_data.h		\
+	funnel.h		\
 	gnuc_format_check.h	\
 	greproto.h		\
 	h225-persistentdata.h	\
diff --git a/epan/funnel.c b/epan/funnel.c
new file mode 100644
index 0000000000..4d74496be3
--- /dev/null
+++ b/epan/funnel.c
@@ -0,0 +1,81 @@
+/*
+ *  funnel.c
+ *
+ * EPAN's GUI mini-API
+ *
+ * (c) 2006, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
+ *
+ * $Id$
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@ethereal.com>
+ * 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. 
+ */
+
+#include <epan/funnel.h>
+
+typedef struct _funnel_menu_t {
+    const char *name;
+    REGISTER_STAT_GROUP_E group;
+    void (*callback)(gpointer);
+    gpointer callback_data;
+    struct _funnel_menu_t* next;
+} funnel_menu_t;
+
+
+static const funnel_ops_t* ops = NULL;
+static funnel_menu_t* menus = NULL;
+
+const funnel_ops_t* funnel_get_funnel_ops() { return ops;  }
+void funnel_set_funnel_ops(const funnel_ops_t* o) { ops = o; }
+
+extern void funnel_register_menu(const char *name,
+                                 REGISTER_STAT_GROUP_E group,
+                                 void (*callback)(gpointer),
+                                 gpointer callback_data) {
+    funnel_menu_t* m = g_malloc(sizeof(funnel_menu_t));
+    m->name = g_strdup(name);
+    m->group = group;
+    m->callback = callback;
+    m->callback_data = callback_data;
+    m->next = NULL;
+    
+    if (!menus)  {
+        menus = m;
+    } else {
+        funnel_menu_t* c;
+        for (c = menus; c->next; c = c->next);
+        c->next = m;
+    }
+}
+
+#if 0
+extern void funnel_register_field_menu(const char *name,
+                                       const char *field_abbrev,
+                                       REGISTER_STAT_GROUP_E group,
+                                       void (*callback)(gpointer),
+                                       gpointer callback_data) {
+}
+#endif
+
+extern void funnel_register_all_menus(funnel_registration_cb_t r_cb) {
+    funnel_menu_t* c;
+    for (c = menus; c; c = c->next) {
+        r_cb(c->name,c->group,c->callback,c->callback_data);
+    }
+}
+
diff --git a/epan/funnel.h b/epan/funnel.h
new file mode 100644
index 0000000000..cfef7c04df
--- /dev/null
+++ b/epan/funnel.h
@@ -0,0 +1,95 @@
+/*
+ *  funnel.h
+ *
+ * EPAN's GUI mini-API
+ *
+ * (c) 2006, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
+ *
+ * $Id$
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@ethereal.com>
+ * 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. 
+ */
+#ifndef _FUNNEL_H
+#define _FUNNEL_H
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <glib.h>
+#include "../stat_menu.h"
+
+
+typedef struct _funnel_text_window_t funnel_text_window_t ;
+typedef struct _funnel_tree_window_t funnel_tree_window_t ;
+typedef struct _funnel_node_t funnel_node_t ;
+typedef struct _funnel_dialog_t funnel_dialog_t;
+
+typedef void (*funnel_dlg_cb_t)(const gchar** user_input);
+
+typedef struct _funnel_ops_t {
+    funnel_text_window_t* (*new_text_window)(const gchar* label);
+    void (*set_text)(funnel_text_window_t*  win, const gchar* text);
+    void (*append_text)(funnel_text_window_t*  win, const gchar* text);
+    void (*prepend_text)(funnel_text_window_t*  win, const gchar* text);
+    void (*clear_text)(funnel_text_window_t*  win);
+    const gchar* (*get_text)(funnel_text_window_t*  win);
+    void (*destroy_text_window)(funnel_text_window_t*  win);
+#if 0
+    funnel_node_t* (*new_tree_window)(const gchar* title, gchar** columns);
+    funnel_node_t* (*add_node)(funnel_node_t* node, gchar** values);
+    void  (*remove_node)(funnel_node_t* node);
+    void  (*set_cell)(funnel_node_t* node, gchar* column, const gchar* text);
+    
+    funnel_dialog_t* (*new_dialog)(const gchar* title,
+                                   const gchar* text,
+                                   guint32 buttonmask,
+                                   const gchar** fieldnames,
+                                   funnel_dlg_cb_t dlg_cb );
+    
+    void (*set_filter)(const gchar* filter_string);
+#endif
+} funnel_ops_t;
+
+
+extern const funnel_ops_t* funnel_get_funnel_ops(void);
+extern void funnel_set_funnel_ops(const funnel_ops_t*);
+
+
+extern void funnel_register_menu(const char *name,
+                               REGISTER_STAT_GROUP_E group,
+                               void (*callback)(gpointer),
+                               gpointer callback_data);
+#if 0
+extern void funnel_register_field_menu(const char *name,
+                                const char *field_abbrev,
+                                REGISTER_STAT_GROUP_E group,
+                                void (*callback)(gpointer),
+                                gpointer callback_data);
+#endif
+
+
+typedef void (*funnel_registration_cb_t)(const char *name,
+                 REGISTER_STAT_GROUP_E group,
+                 void (*callback)(gpointer),
+                 gpointer callback_data);
+
+extern void funnel_register_all_menus(funnel_registration_cb_t r_cb);
+
+#endif
diff --git a/epan/libethereal.def b/epan/libethereal.def
index 7a33dc50c2..c4a380099a 100644
--- a/epan/libethereal.def
+++ b/epan/libethereal.def
@@ -280,6 +280,11 @@ fvalue_get_floating
 fvalue_get_integer
 fvalue_get_integer64
 fvalue_to_string_repr
+funnel_get_funnel_ops
+funnel_set_funnel_ops
+funnel_register_menu
+funnel_register_field_menu
+funnel_register_all_menus
 GatekeeperRejectReason_vals     DATA
 get_addr_name
 get_basename
diff --git a/gtk/Makefile.common b/gtk/Makefile.common
index 5b46a702ab..93c14065e6 100644
--- a/gtk/Makefile.common
+++ b/gtk/Makefile.common
@@ -128,6 +128,7 @@ ETHEREAL_TAP_SRC = \
 	expert_dlg.c	\
 	fc_stat.c	\
 	flow_graph.c	\
+	funnel_stat.c	\
 	gsm_a_stat.c	\
 	gsm_map_stat.c	\
 	gsm_map_summary.c	\
diff --git a/gtk/funnel_stat.c b/gtk/funnel_stat.c
new file mode 100644
index 0000000000..c6d2d6f6ae
--- /dev/null
+++ b/gtk/funnel_stat.c
@@ -0,0 +1,240 @@
+/*
+ * funnel_stat.c
+ *
+ * EPAN's funneled GUI mini-API
+ *
+ * (c) 2006, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
+ * 
+ * $Id: ncp_stat.c 00000 2005-09-22 11:09:36Z xxx $
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@ethereal.com>
+ * 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
+
+#ifdef HAVE_SYS_TYPES_H
+# include <sys/types.h>
+#endif
+
+#include <string.h>
+
+#include <gtk/gtk.h>
+
+#include "../register.h"
+#include "../timestats.h"
+#include "compat_macros.h"
+#include "../simple_dialog.h"
+#include "gui_utils.h"
+#include "dlg_utils.h"
+#include "../file.h"
+#include "../globals.h"
+#include "filter_dlg.h"
+#include "../stat_menu.h"
+#include "../tap_dfilter_dlg.h"
+#include "font_utils.h"
+#include "../stat_menu.h"
+#include "gui_stat_menu.h"
+
+#include "gtkglobals.h"
+
+#include <epan/funnel.h>
+
+struct _funnel_text_window_t {
+	GtkWidget* win;
+    GtkWidget* txt;
+};
+
+struct _funnel_tree_window_t {
+	GtkWidget *win;
+
+};
+struct _funnel_node_t {};
+struct _funnel_dialog_t {};
+
+static void text_window_cancel_button_cb(GtkWidget *bt _U_, gpointer data) {
+    funnel_text_window_t* tw = data;
+    
+    window_destroy(GTK_WIDGET(tw->win));
+    tw->win = NULL;
+
+}
+
+static funnel_text_window_t* new_text_window(const gchar* title) {
+    funnel_text_window_t* tw = g_malloc(sizeof(funnel_text_window_t));
+	GtkWidget *txt_scrollw, *main_vb, *bbox, *bt_close;
+
+    printf("funnel: new_text_window('%s')\n",title);
+    tw->win = window_new(GTK_WINDOW_TOPLEVEL,title);
+    txt_scrollw = scrolled_window_new(NULL, NULL);
+    main_vb = gtk_vbox_new(FALSE, 3);
+	gtk_container_border_width(GTK_CONTAINER(main_vb), 12);
+	gtk_container_add(GTK_CONTAINER(tw->win), main_vb);
+    
+    gtk_container_add(GTK_CONTAINER(main_vb), txt_scrollw);
+
+#if GTK_MAJOR_VERSION < 2
+    gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(txt_scrollw),
+                                   GTK_POLICY_NEVER, GTK_POLICY_ALWAYS);
+    tv->txt = gtk_text_new(NULL, NULL);
+    gtk_text_set_editable(GTK_TEXT(tv->txt), FALSE);
+    gtk_text_set_word_wrap(GTK_TEXT(tv->txt), TRUE);
+    gtk_text_set_line_wrap(GTK_TEXT(tv->txt), TRUE);
+#else
+    gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(txt_scrollw), 
+                                        GTK_SHADOW_IN);
+
+    gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(txt_scrollw),
+                                   GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
+    tw->txt = gtk_text_view_new();
+    gtk_text_view_set_editable(GTK_TEXT_VIEW(tw->txt), FALSE);
+    gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(tw->txt), GTK_WRAP_WORD);
+    gtk_text_view_set_cursor_visible(GTK_TEXT_VIEW(tw->txt), FALSE);
+    /* XXX: there seems to be no way to add a small border *around* the whole text,
+        * so the text will be "bump" against the edges.
+        * the following is only working for left and right edges,
+        * there is no such thing for top and bottom :-( */
+    gtk_text_view_set_left_margin(GTK_TEXT_VIEW(tw->txt), 4);
+    gtk_text_view_set_right_margin(GTK_TEXT_VIEW(tw->txt), 4);
+#endif
+    
+    
+    bbox = dlg_button_row_new(GTK_STOCK_CLOSE, NULL);
+	gtk_box_pack_start(GTK_BOX(main_vb), bbox, FALSE, FALSE, 0);
+
+    bt_close = OBJECT_GET_DATA(bbox, GTK_STOCK_CLOSE);
+    SIGNAL_CONNECT(bt_close, "clicked", text_window_cancel_button_cb, tw);
+    gtk_widget_grab_default(bt_close);
+
+    gtk_container_add(GTK_CONTAINER(txt_scrollw), tw->txt);
+    gtk_window_resize(GTK_WINDOW(tw->win),400,300);
+    gtk_widget_show_all(tw->win);
+    
+    return tw;
+}
+
+
+static void text_window_clear(funnel_text_window_t*  tw)
+{
+    if (! tw->win) return; 
+    
+#if GTK_MAJOR_VERSION < 2
+    GtkText *txt = tw->txt;
+    
+    gtk_text_set_point(txt, 0);
+    /* Keep GTK+ 1.2.3 through 1.2.6 from dumping core - see
+http://www.ethereal.com/lists/ethereal-dev/199912/msg00312.html and
+http://www.gnome.org/mailing-lists/archives/gtk-devel-list/1999-October/0051.shtml
+        for more information */
+    gtk_adjustment_set_value(txt->vadj, 0.0);
+    gtk_text_forward_delete(txt, gtk_text_get_length(txt));
+#else
+    GtkTextBuffer *buf = gtk_text_view_get_buffer(GTK_TEXT_VIEW(tw->txt));
+    
+    gtk_text_buffer_set_text(buf, "", 0);
+#endif
+}
+
+
+static void text_window_append(funnel_text_window_t*  tw, const char *str)
+{
+    GtkWidget *txt;
+    int nchars = strlen(str);
+ 
+    if (! tw->win) return; 
+
+    txt = tw->txt;
+    nchars = strlen(str);
+    
+    
+#if GTK_MAJOR_VERSION < 2
+    gtk_text_insert(GTK_TEXT(txt), user_font_get_regular(), NULL, NULL, str, nchars);
+#else
+    GtkTextBuffer *buf= gtk_text_view_get_buffer(GTK_TEXT_VIEW(txt));
+    GtkTextIter    iter;
+    
+    gtk_text_buffer_get_end_iter(buf, &iter);
+    gtk_widget_modify_font(GTK_WIDGET(txt), user_font_get_regular());
+    
+    if (!g_utf8_validate(str, -1, NULL))
+        printf("Invalid utf8 encoding: %s\n", str);
+    
+    gtk_text_buffer_insert(buf, &iter, str, nchars);
+#endif
+}
+
+
+static void text_window_set_text(funnel_text_window_t*  tw, const gchar* text)
+{
+    
+    if (! tw->win) return; 
+    
+#if GTK_MAJOR_VERSION < 2
+    gtk_text_freeze(tw->txt);
+#endif
+
+    text_window_clear(tw);
+    text_window_append(tw, text);
+
+#if GTK_MAJOR_VERSION < 2
+    gtk_text_thaw(tw->txt);
+#endif
+}
+
+
+static void text_window_prepend(funnel_text_window_t*  tw, const char *str _U_) {
+    if (! tw->win) return; 
+
+}
+
+static const gchar* text_window_get_text(funnel_text_window_t*  tw) {
+
+    if (! tw->win) return ""; 
+
+    return "";
+}
+
+static void text_window_destroy(funnel_text_window_t*  tw) {
+    if (tw->win) {
+        window_destroy(tw->win);
+    }
+    g_free(tw);
+}
+
+static const funnel_ops_t ops = {
+    new_text_window,
+    text_window_set_text,
+    text_window_append,
+    text_window_prepend,
+    text_window_clear,
+    text_window_get_text,
+    text_window_destroy
+};
+
+static void register_tap_cb(const char *name, REGISTER_STAT_GROUP_E group, void (*callback)(gpointer), gpointer callback_data) {
+    register_stat_menu_item(name, group, callback, NULL, NULL, callback_data);
+}
+
+void
+register_tap_listener_gtkfunnel(void)
+{
+    funnel_set_funnel_ops(&ops);
+    funnel_register_all_menus(register_tap_cb);
+}