More work on modernizing the column prefs.
[obnox/wireshark/wip.git] / gtk / prefs_column.c
1 /* column_prefs.c
2  * Dialog box for column preferences
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifdef HAVE_CONFIG_H
26 #include "config.h"
27 #endif
28
29 #include <gtk/gtk.h>
30
31 #include <epan/prefs.h>
32 #include <epan/column_info.h>
33 #include <epan/column.h>
34
35 #include "../globals.h"
36
37 #include "gtk/prefs_column.h"
38 #include "gtk/gtkglobals.h"
39 #include "gtk/gui_utils.h"
40 #include "gtk/main_packet_list.h"
41 #include "gtk/filter_dlg.h"
42 #include "gtk/filter_autocomplete.h"
43
44
45 static GtkWidget *remove_bt, *field_te, *field_lb, *fmt_cmb;
46 static gint       cur_fmt, cur_row;
47
48 static void column_list_select_cb(GtkTreeSelection *, gpointer);
49 static void column_field_changed_cb(GtkEditable *, gpointer);
50 static void column_list_new_cb(GtkWidget *, gpointer);
51 static void column_menu_changed_cb(GtkWidget *, gpointer);
52 static void column_list_delete_cb(GtkWidget *, gpointer);
53 static void column_dnd_row_deleted_cb(GtkTreeModel *, GtkTreePath *, gpointer);
54 static gboolean column_title_changed_cb(GtkCellRendererText *, const gchar *, const gchar *, gpointer);
55
56 #define E_COL_NAME_KEY "column_name"
57 #define E_COL_LBL_KEY  "column_label"
58 #define E_COL_CM_KEY   "in_col_cancel_mode"
59
60 /* Create and display the column selection widgets. */
61 /* Called when the 'Columns' preference notebook page is selected. */
62 GtkWidget *
63 column_prefs_show(GtkWidget *prefs_window) {
64   GtkWidget         *main_vb, *bottom_hb, *column_l, *add_bt,
65                     *tb, *lb;
66   GtkWidget         *list_vb, *list_lb, *list_sc;
67   GtkWidget         *add_remove_vb;
68   GtkWidget         *props_fr, *props_hb;
69   GList             *clp = NULL;
70   fmt_data          *cfmt;
71   gint               i;
72   gchar             *fmt;
73   const gchar       *column_titles[] = {"Title", "Format"};
74   GtkListStore      *store;
75   GtkCellRenderer   *renderer;
76   GtkTreeViewColumn *column;
77   GtkTreeSelection  *sel;
78   GtkTreeIter        iter;
79   GtkTreeIter        first_iter;
80   gint               first_row = TRUE;
81
82   /* Container for each row of widgets */
83   main_vb = gtk_vbox_new(FALSE, 5);
84   gtk_container_set_border_width(GTK_CONTAINER(main_vb), 5);
85   gtk_widget_show(main_vb);
86   g_object_set_data(G_OBJECT(GTK_OBJECT(main_vb)), E_COL_CM_KEY, (gpointer)FALSE);
87
88   /* Top row: Columns list frame */
89   //list_fr = gtk_frame_new("Columns");
90   //gtk_box_pack_start (GTK_BOX (main_vb), list_fr, TRUE, TRUE, 0);
91   //gtk_widget_show(list_fr);
92
93   list_vb = gtk_vbox_new (FALSE, 0);
94   gtk_container_set_border_width  (GTK_CONTAINER (list_vb), 5);
95   gtk_widget_show (list_vb);
96   gtk_box_pack_start (GTK_BOX (main_vb), list_vb, TRUE, TRUE, 0);
97   //gtk_container_add(GTK_CONTAINER(list_fr), list_vb);
98
99   list_lb = gtk_label_new (("[First list entry will be displayed left]"));
100   gtk_widget_show (list_lb);
101   gtk_box_pack_start (GTK_BOX (list_vb), list_lb, FALSE, FALSE, 0);
102
103   list_sc = scrolled_window_new(NULL, NULL);
104   gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(list_sc), 
105                                    GTK_SHADOW_IN);
106   gtk_container_add(GTK_CONTAINER(list_vb), list_sc);
107   gtk_widget_show(list_sc);
108
109   store = gtk_list_store_new(3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_POINTER);
110   g_signal_connect(GTK_TREE_MODEL(store), "row-deleted", G_CALLBACK(column_dnd_row_deleted_cb), NULL);
111
112   column_l = tree_view_new(GTK_TREE_MODEL(store));
113   gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(column_l), TRUE);
114   gtk_tree_view_set_headers_clickable(GTK_TREE_VIEW(column_l), FALSE);
115   gtk_tree_view_set_reorderable(GTK_TREE_VIEW(column_l), TRUE);
116   renderer = gtk_cell_renderer_text_new();
117   g_object_set(G_OBJECT(renderer), "editable", TRUE, NULL);
118   g_signal_connect (renderer, "edited", G_CALLBACK(column_title_changed_cb), GTK_TREE_MODEL(store));
119   column = gtk_tree_view_column_new_with_attributes(column_titles[0], renderer,
120                                                     "text", 0, NULL);
121   gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
122   gtk_tree_view_append_column(GTK_TREE_VIEW(column_l), column);
123   renderer = gtk_cell_renderer_text_new();
124   column = gtk_tree_view_column_new_with_attributes(column_titles[1], renderer,
125                                                     "text", 1, NULL);
126   gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
127   gtk_tree_view_append_column(GTK_TREE_VIEW(column_l), column);
128   /* XXX - make this match the packet list prefs? */
129   sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(column_l));
130   gtk_tree_selection_set_mode(sel, GTK_SELECTION_SINGLE);
131   g_signal_connect(sel, "changed", G_CALLBACK(column_list_select_cb), column_l);
132
133   gtk_container_add(GTK_CONTAINER(list_sc), column_l);
134   gtk_widget_show(column_l);
135
136   clp = g_list_first(prefs.col_list);
137   while (clp) {
138     cfmt    = (fmt_data *) clp->data;
139     cur_fmt = get_column_format_from_str(cfmt->fmt);
140     if (cur_fmt == COL_CUSTOM) {
141       fmt = g_strdup_printf("%s (%s)", col_format_desc(cur_fmt), cfmt->custom_field);
142     } else {
143       fmt = g_strdup_printf("%s", col_format_desc(cur_fmt));
144     }
145     gtk_list_store_append(store, &iter);
146     gtk_list_store_set(store, &iter, 0, cfmt->title, 1, fmt, 2, clp, -1);
147     if (first_row) {
148         first_iter = iter;
149         first_row = FALSE;
150     }
151     clp = clp->next;
152     g_free (fmt);
153   }
154   g_object_unref(G_OBJECT(store));
155
156   
157   /* Bottom row: Add/remove buttons and properties */
158   bottom_hb = gtk_hbox_new(FALSE, 5);
159   gtk_box_pack_start (GTK_BOX (main_vb), bottom_hb, FALSE, TRUE, 0);
160   //gtk_container_add(GTK_CONTAINER(main_vb), bottom_hb);
161   gtk_widget_show(bottom_hb);
162
163
164   /* Add / remove buttons */
165   add_remove_vb = gtk_vbox_new (FALSE, 0);
166   gtk_container_set_border_width  (GTK_CONTAINER (add_remove_vb), 5);
167   gtk_box_pack_start (GTK_BOX (bottom_hb), add_remove_vb, FALSE, TRUE, 0);
168   //gtk_container_add(GTK_CONTAINER(bottom_hb), add_remove_vb);
169   gtk_widget_show(add_remove_vb);
170
171   add_bt = gtk_button_new_from_stock(GTK_STOCK_ADD);
172   g_signal_connect(add_bt, "clicked", G_CALLBACK(column_list_new_cb), column_l);
173   gtk_box_pack_start (GTK_BOX (add_remove_vb), add_bt, FALSE, FALSE, 5);
174   gtk_widget_show(add_bt);
175
176   remove_bt = gtk_button_new_from_stock(GTK_STOCK_REMOVE);
177   gtk_widget_set_sensitive(remove_bt, FALSE);
178   g_signal_connect(remove_bt, "clicked", G_CALLBACK(column_list_delete_cb), column_l);
179   gtk_box_pack_start (GTK_BOX (add_remove_vb), remove_bt, FALSE, FALSE, 5);
180   gtk_widget_show(remove_bt);
181   
182   /* properties frame */
183   props_fr = gtk_frame_new("Properties");
184   gtk_box_pack_start (GTK_BOX (bottom_hb), props_fr, TRUE, TRUE, 0);
185   gtk_widget_show(props_fr);
186
187   /* Column name entry and format selection */
188   tb = gtk_table_new(1, 4, FALSE);
189   gtk_container_set_border_width(GTK_CONTAINER(tb), 5);
190   gtk_container_add(GTK_CONTAINER(props_fr), tb);
191   gtk_table_set_row_spacings(GTK_TABLE(tb), 10);
192   gtk_table_set_col_spacings(GTK_TABLE(tb), 15);
193   gtk_widget_show(tb);
194
195   lb = gtk_label_new("Format:");
196   gtk_misc_set_alignment(GTK_MISC(lb), 1.0, 0.5);
197   gtk_table_attach_defaults(GTK_TABLE(tb), lb, 0, 1, 0, 1);
198   gtk_widget_show(lb);
199
200   props_hb = gtk_hbox_new(FALSE, 5);
201   gtk_table_attach(GTK_TABLE(tb), props_hb, 1, 2, 0, 1, GTK_FILL,
202                    GTK_SHRINK, 0, 0);
203   gtk_widget_show(props_hb);
204
205   field_lb = gtk_label_new("Field name:");
206   gtk_misc_set_alignment(GTK_MISC(field_lb), 1.0, 0.5);
207   gtk_table_attach_defaults(GTK_TABLE(tb), field_lb, 2, 3, 0, 1);
208   gtk_widget_hide(field_lb);
209
210   field_te = gtk_entry_new();
211   g_object_set_data (G_OBJECT(field_te), E_FILT_FIELD_NAME_ONLY_KEY, "");
212   g_signal_connect(field_te, "changed", G_CALLBACK(filter_te_syntax_check_cb), NULL);
213   g_object_set_data(G_OBJECT(main_vb), E_FILT_AUTOCOMP_PTR_KEY, NULL);
214   g_signal_connect(field_te, "key-press-event", G_CALLBACK (filter_string_te_key_pressed_cb), NULL);
215   g_signal_connect(prefs_window, "key-press-event", G_CALLBACK (filter_parent_dlg_key_pressed_cb), NULL);
216   colorize_filter_te_as_empty(field_te);
217   gtk_table_attach_defaults(GTK_TABLE(tb), field_te, 3, 4, 0, 1);
218   gtk_widget_set_sensitive(field_te, FALSE);
219   gtk_widget_hide(field_te);
220
221   fmt_cmb = gtk_combo_box_new_text();
222
223   for (i = 0; i < NUM_COL_FMTS; i++)
224     gtk_combo_box_append_text(GTK_COMBO_BOX(fmt_cmb), col_format_desc(i));
225
226   g_signal_connect(fmt_cmb, "changed", G_CALLBACK(column_menu_changed_cb), column_l);
227
228   cur_fmt = 0;
229   gtk_combo_box_set_active(GTK_COMBO_BOX(fmt_cmb), cur_fmt);
230   gtk_widget_set_sensitive(fmt_cmb, FALSE);
231   gtk_box_pack_start(GTK_BOX(props_hb), fmt_cmb, FALSE, FALSE, 0);
232   gtk_widget_show(fmt_cmb);
233
234   /* select the first row */
235   gtk_tree_selection_select_iter(sel, &first_iter);
236
237   return(main_vb);
238 }
239
240 /* For each selection, set the entry and option menu widgets to match
241    the currently selected item.  Set the up/down button sensitivity.
242    Draw focus to the entry widget. */
243 static void
244 column_list_select_cb(GtkTreeSelection *sel, gpointer data)
245 {
246     GtkTreeView  *column_l = GTK_TREE_VIEW(data);
247     fmt_data     *cfmt;
248     GList        *clp;
249     GtkTreeModel *model;
250     GtkTreeIter   iter;
251     GtkTreePath  *path;
252     gchar        *str_path;
253
254     /* if something was selected */
255     if (gtk_tree_selection_get_selected(sel, &model, &iter))
256     {
257         gtk_tree_model_get(model, &iter, 2, &clp, -1);
258         g_assert(clp != NULL);
259         cfmt   = (fmt_data *) clp->data;
260         cur_fmt = get_column_format_from_str(cfmt->fmt);
261         g_assert(cur_fmt != -1);     /* It should always be valid */
262
263         path = gtk_tree_model_get_path(model, &iter);
264         str_path = gtk_tree_path_to_string(path);
265         cur_row = atoi(str_path);
266         g_free(str_path);
267         gtk_tree_path_free(path);
268
269         if (cur_fmt == COL_CUSTOM) {
270             gtk_entry_set_text(GTK_ENTRY(field_te), cfmt->custom_field);
271             gtk_widget_show(field_lb);
272             gtk_widget_show(field_te);
273         } else {
274             gtk_widget_hide(field_lb);
275             gtk_widget_hide(field_te);
276         }
277         g_signal_connect(field_te, "changed", G_CALLBACK(column_field_changed_cb), column_l);
278
279         gtk_combo_box_set_active(GTK_COMBO_BOX(fmt_cmb), cur_fmt);
280
281         gtk_widget_set_sensitive(remove_bt, TRUE);
282         gtk_widget_set_sensitive(field_te, TRUE);
283         gtk_widget_set_sensitive(fmt_cmb, TRUE);
284     }
285     else
286     {
287         cur_row = -1;
288         gtk_editable_delete_text(GTK_EDITABLE(field_te), 0, -1);
289
290         gtk_widget_set_sensitive(remove_bt, FALSE);
291         gtk_widget_set_sensitive(field_te, FALSE);
292         gtk_widget_set_sensitive(fmt_cmb, FALSE);
293     }
294 }
295
296 /* To do: add input checking to each of these callbacks */
297
298 static void
299 column_list_new_cb(GtkWidget *w _U_, gpointer data) {
300     fmt_data          *cfmt;
301     const gchar       *title = "New Column";
302     GtkTreeView       *column_l = GTK_TREE_VIEW(data);
303     GtkTreeModel      *model;
304     GtkTreeIter        iter;
305     GtkTreePath       *path;
306     GtkTreeViewColumn *title_column;
307     gchar             *str_path;
308
309     cur_fmt        = COL_NUMBER;
310     cfmt           = (fmt_data *) g_malloc(sizeof(fmt_data));
311     cfmt->title    = g_strdup(title);
312     cfmt->fmt      = g_strdup(col_format_to_string(cur_fmt));
313     cfmt->custom_field = NULL;
314     prefs.col_list = g_list_append(prefs.col_list, cfmt);
315
316     model = gtk_tree_view_get_model(column_l);
317     gtk_list_store_append(GTK_LIST_STORE(model), &iter);
318     gtk_list_store_set(GTK_LIST_STORE(model), &iter, 0, title, 1,
319                        col_format_desc(cur_fmt), 2, g_list_last(prefs.col_list),
320                        -1);
321
322     path = gtk_tree_model_get_path(model, &iter);
323     str_path = gtk_tree_path_to_string(path);
324     cur_row = atoi(str_path);
325
326     gtk_tree_selection_select_iter(gtk_tree_view_get_selection(column_l),
327                                    &iter);
328     title_column = gtk_tree_view_get_column(column_l, 0);
329     gtk_tree_view_set_cursor(column_l, path, title_column, TRUE);
330
331     g_free(str_path);
332     gtk_tree_path_free(path);
333     cfile.cinfo.columns_changed = TRUE;
334 }
335
336 static void
337 column_list_delete_cb(GtkWidget *w _U_, gpointer data) {
338     GtkTreeView      *column_l = GTK_TREE_VIEW(data);
339     GList            *clp;
340     fmt_data         *cfmt;
341     GtkTreeSelection *sel;
342     GtkTreeModel     *model;
343     GtkTreeIter       iter;
344
345     sel = gtk_tree_view_get_selection(column_l);
346     if (gtk_tree_selection_get_selected(sel, &model, &iter))
347     {
348         gtk_tree_model_get(model, &iter, 2, &clp, -1);
349
350         cfmt = (fmt_data *) clp->data;
351         g_free(cfmt->title);
352         g_free(cfmt->fmt);
353         if (cfmt->custom_field) {
354           g_free (cfmt->custom_field);
355         }
356         g_free(cfmt);
357         prefs.col_list = g_list_remove_link(prefs.col_list, clp);
358
359         gtk_list_store_remove(GTK_LIST_STORE(model), &iter);
360     }
361     cfile.cinfo.columns_changed = TRUE;
362 }
363
364 static gboolean
365 column_title_changed_cb(GtkCellRendererText *cell _U_, const gchar *str_path, const gchar *new_title, gpointer data) {
366   fmt_data     *cfmt;
367   GList        *clp;
368   GtkTreeModel *model = (GtkTreeModel *)data;
369   GtkTreePath  *path = gtk_tree_path_new_from_string (str_path);
370   GtkTreeIter   iter;
371
372   gtk_tree_model_get_iter(model, &iter, path); 
373   
374   gtk_list_store_set(GTK_LIST_STORE(model), &iter, 0, new_title, -1);
375
376   gtk_tree_model_get(model, &iter, 2, &clp, -1);
377   if (clp) {    
378     cfmt  = (fmt_data *) clp->data;
379     g_free(cfmt->title);
380     cfmt->title = g_strdup(new_title);
381   }
382
383   gtk_tree_path_free (path);
384   cfile.cinfo.columns_changed = TRUE; 
385   return TRUE;  
386 }
387
388 /* The user changed the custom field entry box. */
389 static void
390 column_field_changed_cb(GtkEditable *te, gpointer data) {
391     fmt_data         *cfmt;
392     GList            *clp;
393     gchar            *field, *fmt;
394     GtkTreeView      *tree = (GtkTreeView *)data;
395     GtkTreeSelection *sel;
396     GtkTreeModel     *model;
397     GtkTreeIter       iter;
398
399     sel = gtk_tree_view_get_selection(tree);
400     if (gtk_tree_selection_get_selected(sel, &model, &iter))
401     {
402         field = gtk_editable_get_chars(te, 0, -1);
403         gtk_tree_model_get(model, &iter, 2, &clp, -1);
404         cfmt  = (fmt_data *) clp->data;
405         fmt = g_strdup_printf("%s (%s)", col_format_desc(cur_fmt), field);
406         gtk_list_store_set(GTK_LIST_STORE(model), &iter, 1, fmt, -1);
407         g_free(fmt);
408         if (cfmt->custom_field) {
409           g_free(cfmt->custom_field);
410         }
411         cfmt->custom_field = field;
412     }
413     cfile.cinfo.columns_changed = TRUE;
414 }
415
416 /* The user changed the format menu. */
417 static void
418 column_menu_changed_cb(GtkWidget *w, gpointer data) {
419     GtkTreeView      *column_l = GTK_TREE_VIEW(data);
420     fmt_data         *cfmt;
421     GList            *clp;
422     const gchar      *fmt;
423     GtkTreeSelection *sel;
424     GtkTreeModel     *model;
425     GtkTreeIter       iter;
426
427     sel = gtk_tree_view_get_selection(column_l);
428     if (gtk_tree_selection_get_selected(sel, &model, &iter))
429     {
430         cur_fmt = gtk_combo_box_get_active(GTK_COMBO_BOX(w));
431         gtk_tree_model_get(model, &iter, 2, &clp, -1);
432         cfmt    = (fmt_data *) clp->data;
433
434         if (cur_fmt == COL_CUSTOM) {
435           if (cfmt->custom_field == NULL) {
436             cfmt->custom_field = g_strdup("");
437           }
438           gtk_entry_set_text(GTK_ENTRY(field_te), cfmt->custom_field);
439           fmt = g_strdup_printf("%s (%s)", col_format_desc(cur_fmt), cfmt->custom_field);
440           gtk_widget_show(field_lb);
441           gtk_widget_show(field_te);
442         } else {
443           fmt = g_strdup_printf("%s", col_format_desc(cur_fmt));
444           gtk_widget_hide(field_lb);
445           gtk_widget_hide(field_te);
446         }
447
448         gtk_list_store_set(GTK_LIST_STORE(model), &iter, 1, fmt, -1);
449         g_free(cfmt->fmt);
450         cfmt->fmt = g_strdup(col_format_to_string(cur_fmt));
451     }
452     cfile.cinfo.columns_changed = TRUE;
453 }
454
455 /*
456  * Callback for the "row-deleted" signal emitted when a list item is dragged.
457  * http://library.gnome.org/devel/gtk/stable/GtkTreeModel.html#GtkTreeModel-rows-reordered
458  * says that DND deletes, THEN inserts the row. If this isn't the case, we'll
459  * have to find another way to do this (e.g. by rebuilding prefs.col_list by
460  * iterating over the tree model.
461  */
462 static void
463 column_dnd_row_deleted_cb(GtkTreeModel *model, GtkTreePath *path _U_, gpointer data _U_) {
464   GtkTreeIter       iter;
465   /* gpointer          cfmt; */
466   GList            *clp, *new_col_list = NULL;
467   gchar            *title, *format;
468   gboolean     items_left;
469
470   /*
471    * XXX - This rebuilds prefs.col_list based on the current model. We
472    * might just want to do this when the prefs are applied
473    */
474   for (items_left = gtk_tree_model_get_iter_first (model, &iter);
475        items_left;
476        items_left = gtk_tree_model_iter_next (model, &iter)) {
477
478     gtk_tree_model_get(model, &iter, 0, &title, 1, &format, 2, &clp, -1);
479     if (clp) {
480       prefs.col_list = g_list_remove_link(prefs.col_list, clp);
481       new_col_list = g_list_concat(new_col_list, clp);
482     }
483   }
484   if (prefs.col_list) {
485     g_warning("column_dnd_row_deleted_cb: prefs.col_list has %d leftover data",
486       g_list_length(prefs.col_list));
487     g_list_free(prefs.col_list);
488   }
489   prefs.col_list = new_col_list;
490   cfile.cinfo.columns_changed = TRUE;
491 }
492
493 void
494 column_prefs_fetch(GtkWidget *w _U_) {
495 }
496
497 void
498 column_prefs_apply(GtkWidget *w _U_)
499 {
500     /* Redraw the packet list if the columns were changed */
501     if(cfile.cinfo.columns_changed) {
502         packet_list_recreate();
503         cfile.cinfo.columns_changed = FALSE; /* Reset value */
504     }
505 }
506
507 void
508 column_prefs_destroy(GtkWidget *w) {
509     /* Let the list cb know we're about to destroy the widget tree, so it */
510     /* doesn't operate on widgets that don't exist. */
511     g_object_set_data(G_OBJECT(w), E_COL_CM_KEY, (gpointer)TRUE);
512 }