4 * EPAN's funneled GUI mini-API
6 * (c) 2006, Luis E. Garcia Ontanon <luis@ontanon.org>
10 * Wireshark - Network traffic analyzer
11 * By Gerald Combs <gerald@wireshark.org>
12 * Copyright 1998 Gerald Combs
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 * Most of the code here has been harvested from other Wireshark gtk modules.
31 * most from prefs_dlg.c and about_dlg.c
33 * (From original checkin message:
34 * The funneled GUI mini API.
35 * A very reduced set of gui ops (by now just a text window)
36 * that can be funneled to dissectors (even plugins) via epan.
46 #include <epan/prefs.h>
47 #include <epan/funnel.h>
50 #include "../stat_menu.h"
51 #include "ui/progress_dlg.h"
52 #include "../color_filters.h"
54 #include "ui/gtk/gui_utils.h"
55 #include "ui/gtk/dlg_utils.h"
56 #include "ui/gtk/tap_param_dlg.h"
57 #include "ui/gtk/font_utils.h"
58 #include "ui/gtk/gui_stat_menu.h"
59 #include "ui/gtk/prefs_dlg.h"
60 #include "ui/gtk/main.h"
61 #include "ui/gtk/webbrowser.h"
62 #include "ui/gtk/gtkglobals.h"
63 #include "ui/gtk/old-gtk-compat.h"
65 void register_tap_listener_gtkfunnel(void);
67 struct _funnel_text_window_t {
70 GtkWidget* button_hbox;
72 text_win_close_cb_t close_cb;
77 struct _funnel_tree_window_t {
82 struct _funnel_node_t {
86 static void text_window_cancel_button_cb(GtkWidget *bt _U_, gpointer data) {
87 funnel_text_window_t* tw = (funnel_text_window_t *)data;
89 window_destroy(GTK_WIDGET(tw->win));
93 tw->close_cb(tw->close_data);
96 static void unref_text_win_cancel_bt_cb(GtkWidget *bt _U_, gpointer data) {
97 funnel_text_window_t* tw = (funnel_text_window_t *)data;
100 window_destroy(GTK_WIDGET(tw->win));
104 tw->close_cb(tw->close_data);
106 for (i = 0; i < tw->buttons->len; i++) {
107 funnel_bt_t* cbd = (funnel_bt_t *)g_ptr_array_index(tw->buttons,i);
108 /* XXX a free cb should be passed somehow */
109 if (cbd->data && cbd->free_data_fcn) cbd->free_data_fcn(cbd->data);
110 if (cbd->free_fcn) cbd->free_fcn(cbd);
112 g_ptr_array_free(tw->buttons,TRUE);
117 static gboolean text_window_unref_del_event_cb(GtkWidget *win _U_, GdkEvent *event _U_, gpointer user_data) {
118 funnel_text_window_t* tw = (funnel_text_window_t *)user_data;
121 window_destroy(GTK_WIDGET(tw->win));
125 tw->close_cb(tw->close_data);
127 for (i = 0; i < tw->buttons->len; i++) {
128 funnel_bt_t* cbd = (funnel_bt_t *)g_ptr_array_index(tw->buttons,i);
129 /* XXX a free cb should be passed somehow */
130 if (cbd->data && cbd->free_data_fcn) cbd->free_data_fcn(cbd->data);
131 if (cbd->free_fcn) cbd->free_fcn(cbd);
133 g_ptr_array_free(tw->buttons,TRUE);
139 static gboolean text_window_delete_event_cb(GtkWidget *win _U_, GdkEvent *event _U_, gpointer user_data)
141 funnel_text_window_t* tw = (funnel_text_window_t *)user_data;
143 window_destroy(GTK_WIDGET(tw->win));
147 tw->close_cb(tw->close_data);
152 static funnel_text_window_t* new_text_window(const gchar* title) {
153 funnel_text_window_t* tw = (funnel_text_window_t *)g_malloc(sizeof(funnel_text_window_t));
154 GtkWidget *txt_scrollw, *main_vb, *hbox;
157 tw->close_data = NULL;
158 tw->buttons = g_ptr_array_new();
160 tw->win = dlg_window_new(title); /* transient_for top_level */
161 gtk_window_set_destroy_with_parent (GTK_WINDOW(tw->win), TRUE);
163 g_signal_connect(tw->win, "delete-event", G_CALLBACK(text_window_delete_event_cb), tw);
165 txt_scrollw = scrolled_window_new(NULL, NULL);
166 main_vb = ws_gtk_box_new(GTK_ORIENTATION_VERTICAL, 3, FALSE);
167 gtk_container_set_border_width(GTK_CONTAINER(main_vb), 6);
168 gtk_container_add(GTK_CONTAINER(tw->win), main_vb);
170 gtk_box_pack_start(GTK_BOX (main_vb), txt_scrollw, TRUE, TRUE, 0);
172 gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(txt_scrollw),
175 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(txt_scrollw),
176 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
177 tw->txt = gtk_text_view_new();
178 gtk_text_view_set_editable(GTK_TEXT_VIEW(tw->txt), FALSE);
179 gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(tw->txt), GTK_WRAP_WORD);
180 gtk_text_view_set_cursor_visible(GTK_TEXT_VIEW(tw->txt), FALSE);
182 gtk_text_view_set_left_margin(GTK_TEXT_VIEW(tw->txt), 4);
183 gtk_text_view_set_right_margin(GTK_TEXT_VIEW(tw->txt), 4);
185 hbox = ws_gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0, FALSE);
186 gtk_widget_show(hbox);
188 tw->button_hbox = gtk_button_box_new(GTK_ORIENTATION_HORIZONTAL);
189 gtk_button_box_set_layout(GTK_BUTTON_BOX(tw->button_hbox), GTK_BUTTONBOX_START);
191 gtk_box_pack_start(GTK_BOX(hbox), tw->button_hbox, TRUE, TRUE, 0);
192 gtk_widget_show(tw->button_hbox);
194 gtk_box_pack_start(GTK_BOX(main_vb), hbox, FALSE, FALSE, 0);
196 tw->bt_close = gtk_button_new_with_label("Close");
197 gtk_widget_set_can_default(tw->bt_close, TRUE);
198 g_object_set_data(G_OBJECT(hbox), "Close", tw->bt_close);
200 gtk_box_pack_end(GTK_BOX(hbox), tw->bt_close, FALSE, FALSE, 0);
201 gtk_widget_show(tw->bt_close);
203 g_signal_connect(tw->bt_close, "clicked", G_CALLBACK(text_window_cancel_button_cb), tw);
204 gtk_widget_grab_default(tw->bt_close);
206 gtk_container_add(GTK_CONTAINER(txt_scrollw), tw->txt);
207 gtk_window_resize(GTK_WINDOW(tw->win),400,300);
208 gtk_widget_show_all(tw->win);
214 static void text_window_clear(funnel_text_window_t* tw)
218 if (! tw->win) return;
220 buf = gtk_text_view_get_buffer(GTK_TEXT_VIEW(tw->txt));
222 gtk_text_buffer_set_text(buf, "", 0);
226 static void text_window_append(funnel_text_window_t* tw, const char *str)
233 if (! tw->win) return;
236 nchars = (int) strlen(str);
239 buf= gtk_text_view_get_buffer(GTK_TEXT_VIEW(txt));
241 gtk_text_buffer_get_end_iter(buf, &iter);
242 #if GTK_CHECK_VERSION(3,0,0)
243 gtk_widget_override_font(GTK_WIDGET(txt), user_font_get_regular());
245 gtk_widget_modify_font(GTK_WIDGET(txt), user_font_get_regular());
247 if (!g_utf8_validate(str, -1, NULL))
248 printf("Invalid utf8 encoding: %s\n", str);
250 gtk_text_buffer_insert(buf, &iter, str, nchars);
254 static void text_window_set_text(funnel_text_window_t* tw, const gchar* text)
256 if (! tw->win) return;
258 text_window_clear(tw);
259 text_window_append(tw, text);
263 static void text_window_prepend(funnel_text_window_t* tw, const char *str _U_) {
269 if (! tw->win) return;
272 nchars = (int) strlen(str);
275 buf= gtk_text_view_get_buffer(GTK_TEXT_VIEW(txt));
277 gtk_text_buffer_get_start_iter(buf, &iter);
278 #if GTK_CHECK_VERSION(3,0,0)
279 gtk_widget_override_font(GTK_WIDGET(txt), user_font_get_regular());
281 gtk_widget_modify_font(GTK_WIDGET(txt), user_font_get_regular());
283 if (!g_utf8_validate(str, -1, NULL))
284 printf("Invalid utf8 encoding: %s\n", str);
286 gtk_text_buffer_insert(buf, &iter, str, nchars);
289 static const gchar* text_window_get_text(funnel_text_window_t* tw) {
295 if (! tw->win) return "";
299 buf= gtk_text_view_get_buffer(GTK_TEXT_VIEW(txt));
300 gtk_text_buffer_get_start_iter(buf, &start);
301 gtk_text_buffer_get_end_iter(buf, &end);
303 return gtk_text_buffer_get_text(buf, &start, &end, FALSE);
308 static void text_window_set_close_cb(funnel_text_window_t* tw, text_win_close_cb_t cb, void* data) {
310 tw->close_data = data;
313 static void text_window_destroy(funnel_text_window_t* tw) {
316 * the window is still there and its callbacks refer to this data structure
317 * we need to change the callback so that they free tw.
319 g_signal_connect(tw->bt_close, "clicked", G_CALLBACK(unref_text_win_cancel_bt_cb), tw);
320 g_signal_connect(tw->win, "delete-event", G_CALLBACK(text_window_unref_del_event_cb), tw);
324 * we have no window anymore a human user closed
325 * the window already just free the container
327 for (i = 0; i < tw->buttons->len; i++) {
328 funnel_bt_t* cbd = (funnel_bt_t *)g_ptr_array_index(tw->buttons,i);
329 /* XXX a free cb should be passed somehow */
330 if (cbd->data && cbd->free_data_fcn) cbd->free_data_fcn(cbd->data);
331 if (cbd->free_fcn) cbd->free_fcn(cbd);
333 g_ptr_array_free(tw->buttons,TRUE);
338 static void text_window_set_editable(funnel_text_window_t* tw, gboolean editable){
339 gtk_text_view_set_editable(GTK_TEXT_VIEW(tw->txt), editable);
340 gtk_text_view_set_cursor_visible(GTK_TEXT_VIEW(tw->txt), editable);
343 static gboolean text_window_button_cb(GtkWidget *bt _U_, gpointer user_data)
345 funnel_bt_t* cbd = (funnel_bt_t *)user_data;
348 return cbd->func(cbd->tw,cbd->data);
354 static void text_window_add_button(funnel_text_window_t* tw, funnel_bt_t* cbd, const gchar* label) {
358 g_ptr_array_add(tw->buttons,cbd);
360 button = gtk_button_new_with_label(label);
361 gtk_widget_set_can_default(button, TRUE);
363 gtk_box_pack_start(GTK_BOX(tw->button_hbox), button, FALSE, FALSE, 0);
365 gtk_widget_show(button);
366 g_signal_connect(button, "clicked", G_CALLBACK(text_window_button_cb), cbd);
371 struct _funnel_dlg_data {
374 funnel_dlg_cb_t dlg_cb;
378 static gboolean funnel_dlg_cb(GtkWidget *win _U_, gpointer user_data)
380 struct _funnel_dlg_data* dd = (struct _funnel_dlg_data *)user_data;
382 guint len = dd->entries->len;
383 GPtrArray* returns = g_ptr_array_new();
385 for(i=0; i<len; i++) {
386 GtkEntry* entry = (GtkEntry *)g_ptr_array_index(dd->entries,i);
387 g_ptr_array_add(returns,g_strdup(gtk_entry_get_text(entry)));
390 g_ptr_array_add(returns,NULL);
393 dd->dlg_cb((gchar**)returns->pdata,dd->data);
395 window_destroy(GTK_WIDGET(dd->win));
397 g_ptr_array_free(returns,FALSE);
402 static void funnel_cancel_btn_cb(GtkWidget *bt _U_, gpointer data) {
403 GtkWidget* win = (GtkWidget *)data;
405 window_destroy(GTK_WIDGET(win));
408 static void funnel_new_dialog(const gchar* title,
409 const gchar** fieldnames,
410 funnel_dlg_cb_t dlg_cb,
412 GtkWidget *win, *main_grid, *main_vb, *bbox, *bt_cancel, *bt_ok;
414 const gchar* fieldname;
415 struct _funnel_dlg_data* dd = (struct _funnel_dlg_data *)g_malloc(sizeof(struct _funnel_dlg_data));
417 dd->entries = g_ptr_array_new();
421 for (i=0; fieldnames[i]; i++);
423 win = dlg_window_new(title);
427 gtk_window_resize(GTK_WINDOW(win),400,10*(i+2));
429 main_vb = ws_gtk_box_new(GTK_ORIENTATION_VERTICAL, 5, FALSE);
430 gtk_container_add(GTK_CONTAINER(win), main_vb);
431 gtk_container_set_border_width(GTK_CONTAINER(main_vb), 6);
433 main_grid = ws_gtk_grid_new();
434 gtk_box_pack_start(GTK_BOX(main_vb), main_grid, FALSE, FALSE, 0);
435 ws_gtk_grid_set_row_spacing(GTK_GRID(main_grid), 10);
436 ws_gtk_grid_set_column_spacing(GTK_GRID(main_grid), 15);
438 for (i = 0; (fieldname = fieldnames[i]) ; i++) {
439 GtkWidget *entry, *label;
441 label = gtk_label_new(fieldname);
442 gtk_misc_set_alignment(GTK_MISC(label), 1.0f, 0.5f);
443 ws_gtk_grid_attach_defaults(GTK_GRID(main_grid), label, 0, i+1, 1, 1);
444 gtk_widget_show(label);
446 entry = gtk_entry_new();
447 g_ptr_array_add(dd->entries,entry);
448 ws_gtk_grid_attach_defaults(GTK_GRID(main_grid), entry, 1, i+1, 1, 1);
449 gtk_widget_show(entry);
452 bbox = dlg_button_row_new(GTK_STOCK_CANCEL,GTK_STOCK_OK, NULL);
453 gtk_box_pack_start(GTK_BOX(main_vb), bbox, FALSE, FALSE, 0);
455 bt_ok = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), GTK_STOCK_OK);
456 g_signal_connect(bt_ok, "clicked", G_CALLBACK(funnel_dlg_cb), dd);
457 gtk_widget_grab_default(bt_ok);
459 bt_cancel = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CANCEL);
460 g_signal_connect(bt_cancel, "clicked", G_CALLBACK(funnel_cancel_btn_cb), win);
461 gtk_widget_grab_default(bt_cancel);
463 gtk_widget_show(main_grid);
464 gtk_widget_show(main_vb);
465 gtk_widget_show(win);
468 static gchar * funnel_get_filter(void) {
469 return (gchar *)gtk_entry_get_text(GTK_ENTRY(main_display_filter_widget));
472 static void funnel_set_filter(const char* filter_string) {
473 gtk_entry_set_text(GTK_ENTRY(main_display_filter_widget), filter_string);
476 static void funnel_set_color_filter_slot(guint8 filt_nr, const gchar* filter_string) {
477 color_filters_set_tmp(filt_nr, (gchar *)filter_string, FALSE);
480 static void funnel_apply_filter(void) {
481 const char* filter_string = gtk_entry_get_text(GTK_ENTRY(main_display_filter_widget));
482 main_filter_packets(&cfile, filter_string, FALSE);
485 /* XXX: finish this */
486 static void funnel_logger(const gchar *log_domain _U_,
487 GLogLevelFlags log_level _U_,
488 const gchar *message,
489 gpointer user_data _U_) {
490 fputs(message,stderr);
493 static void funnel_retap_packets(void) {
494 cf_retap_packets(&cfile);
497 static gboolean funnel_open_file(const char* fname, const char* filter, const char** err_str) {
499 dfilter_t *rfcode = NULL;
501 *err_str = "no error";
503 switch (cfile.state) {
506 case FILE_READ_ABORTED:
508 case FILE_READ_IN_PROGRESS:
509 *err_str = "file read in progress";
514 if (!dfilter_compile(filter, &rfcode)) {
515 *err_str = dfilter_error_msg ? dfilter_error_msg : "cannot compile filter";
521 if (cf_open(&cfile, fname, FALSE, &err) != CF_OK) {
522 *err_str = g_strerror(err);
523 if (rfcode != NULL) dfilter_free(rfcode);
527 cfile.rfcode = rfcode;
529 switch (cf_read(&cfile, FALSE)) {
534 *err_str = "problem while reading file";
541 static funnel_progress_window_t* funnel_new_progress_window(const gchar* label, const gchar* task, gboolean terminate_is_stop, gboolean *stop_flag) {
542 return (funnel_progress_window_t*)create_progress_dlg(top_level, label, task, terminate_is_stop, stop_flag);
545 static void funnel_update_progress(funnel_progress_window_t* win, float pr, const gchar* task) {
546 update_progress_dlg((progdlg_t*)win, pr, task);
549 static void funnel_destroy_progress_window(funnel_progress_window_t* win) {
550 destroy_progress_dlg((progdlg_t*)win);
553 static void funnel_reload(void) {
554 if (cfile.state == FILE_READ_DONE) cf_reload(&cfile);
557 static const funnel_ops_t funnel_ops = {
559 text_window_set_text,
563 text_window_get_text,
564 text_window_set_close_cb,
565 text_window_set_editable,
567 text_window_add_button,
571 funnel_retap_packets,
575 funnel_set_color_filter_slot,
580 browser_open_data_file,
581 funnel_new_progress_window,
582 funnel_update_progress,
583 funnel_destroy_progress_window
587 typedef struct _menu_cb_t {
588 void (*callback)(gpointer);
593 static void our_menu_callback(void* unused _U_, gpointer data) {
594 menu_cb_t* mcb = (menu_cb_t *)data;
595 mcb->callback(mcb->callback_data);
596 if (mcb->retap) cf_retap_packets(&cfile);
599 static void register_menu_cb(const char *name,
600 register_stat_group_t group,
601 void (*callback)(gpointer),
602 gpointer callback_data,
605 menu_cb_t* mcb = (menu_cb_t *)g_malloc(sizeof(menu_cb_t));
606 const char *label = NULL, *str = NULL;
608 mcb->callback = callback;
609 mcb->callback_data = callback_data;
612 str = strrchr(name,'/');
619 register_menu_bar_menu_items(
620 stat_group_name(group), /* GUI path to the place holder in the menu */
621 name, /* Action name */
624 NULL, /* Accelerator */
626 our_menu_callback, /* Callback */
627 mcb, /* callback data */
633 void initialize_funnel_ops(void) {
634 funnel_set_funnel_ops(&funnel_ops);
638 register_tap_listener_gtkfunnel(void)
640 funnel_register_all_menus(register_menu_cb);