ui/gtk/prefs_filter_expressions.c

   1 /* prefs_filter_expressions.c
   2  * Submitted by Edwin Groothuis <wireshark@mavetju.org>
   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 <string.h>
  30
  31 #include <gtk/gtk.h>
  32
  33 #include <epan/prefs.h>
  34 #include <epan/column_info.h>
  35 #include <epan/column.h>
  36 #include <epan/strutil.h>
  37 #include <epan/filter_expressions.h>
  38
  39 #include "../globals.h"
  40
  41 #include "ui/gtk/gtkglobals.h"
  42 #include "ui/gtk/gui_utils.h"
  43 #include "ui/gtk/new_packet_list.h"
  44 #include "ui/gtk/filter_dlg.h"
  45 #include "ui/gtk/filter_autocomplete.h"
  46 #include "ui/gtk/filter_expression_save_dlg.h"
  47 #include "ui/gtk/old-gtk-compat.h"
  48
  49 static void filter_expressions_list_new_cb(GtkWidget *, gpointer);
  50 static void filter_expressions_list_remove_cb(GtkWidget *, gpointer);
  51 static gboolean filter_expressions_label_changed_cb(GtkCellRendererText *, const gchar *, const gchar *, gpointer);
  52 static gboolean filter_expressions_expression_changed_cb(GtkCellRendererText *, const gchar *, const gchar *, gpointer);
  53
  54 #define E_FILTER_EXPRESSION_COLUMNL     "filter_expression_columnl"
  55 #define E_FILTER_EXPRESSION_STORE       "filter_expression_store"
  56
  57 enum {
  58     ENABLED_COLUMN,
  59     LABEL_COLUMN,
  60     EXPRESSION_COLUMN,
  61     DATA_COLUMN,
  62     N_COLUMN /* The number of columns */
  63 };
  64
  65 /* Visible toggled */
  66 static void
  67 enable_toggled(GtkCellRendererToggle *cell _U_, gchar *path_str, gpointer data)
  68 {
  69     GtkTreeModel    *model = (GtkTreeModel *)data;
  70     GtkTreeIter      iter;
  71     GtkTreePath     *path = gtk_tree_path_new_from_string(path_str);
  72     struct filter_expression *fe;
  73
  74     gtk_tree_model_get_iter(model, &iter, path);
  75     gtk_tree_model_get(model, &iter, DATA_COLUMN, &fe, -1);
  76
  77     fe->enabled = !fe->enabled;
  78
  79     gtk_list_store_set(GTK_LIST_STORE(model), &iter, ENABLED_COLUMN,
  80         fe->enabled, -1);
  81
  82     gtk_tree_path_free(path);
  83 } /* visible_toggled */
  84
  85 /*
  86  * Create and display the column selection widgets.
  87  * Called as part of the creation of the Preferences notebook ( Edit ! Preferences )
  88  */
  89 GtkWidget *
  90 filter_expressions_prefs_show(void) {
  91     GtkWidget         *main_vb, *bottom_hb, *column_l, *add_bt, *remove_bt;
  92     GtkWidget         *list_vb, *list_lb, *list_sc;
  93     GtkWidget         *add_remove_hb;
  94     GtkListStore      *store;
  95     GtkCellRenderer   *renderer;
  96     GtkTreeViewColumn *column;
  97     GtkTreeSelection  *sel;
  98     GtkTreeIter        iter;
  99     GtkTreeIter        first_iter;
 100     gint               first_row = TRUE;
 101     struct filter_expression *fe;
 102     const gchar       *column_titles[] = {"Enabled", "Label",
 103                                           "Filter Expression"};
 104
 105     /* Container for each row of widgets */
 106     main_vb = gtk_vbox_new(FALSE, 5);
 107     gtk_container_set_border_width(GTK_CONTAINER(main_vb), 5);
 108     gtk_widget_show(main_vb);
 109
 110     list_vb = gtk_vbox_new(FALSE, 0);
 111     gtk_container_set_border_width(GTK_CONTAINER(list_vb), 5);
 112     gtk_widget_show(list_vb);
 113     gtk_box_pack_start(GTK_BOX(main_vb), list_vb, TRUE, TRUE, 0);
 114
 115     list_lb = gtk_label_new(("[The first list entry will be displayed as the "
 116         "first button right of the Save button - Drag and drop entries to "
 117         "change column order]"));
 118     gtk_widget_show(list_lb);
 119     gtk_box_pack_start(GTK_BOX(list_vb), list_lb, FALSE, FALSE, 0);
 120
 121     list_sc = scrolled_window_new(NULL, NULL);
 122     gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(list_sc),
 123         GTK_SHADOW_IN);
 124     gtk_container_add(GTK_CONTAINER(list_vb), list_sc);
 125     gtk_widget_show(list_sc);
 126
 127     store = gtk_list_store_new(N_COLUMN,
 128                                G_TYPE_BOOLEAN, G_TYPE_STRING, G_TYPE_STRING,
 129                                G_TYPE_POINTER);
 130
 131     column_l = tree_view_new(GTK_TREE_MODEL(store));
 132     gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(column_l), TRUE);
 133     gtk_tree_view_set_headers_clickable(GTK_TREE_VIEW(column_l), FALSE);
 134     gtk_tree_view_set_reorderable(GTK_TREE_VIEW(column_l), TRUE);
 135     gtk_widget_set_tooltip_text(column_l, "Click on a label or expression to "
 136         "change its name.\nDrag an item to change its order.\nTick 'Enable' "
 137         "to enable the filter in the buttons.");
 138
 139     /* Enabled buton */
 140     renderer = gtk_cell_renderer_toggle_new();
 141     g_signal_connect(renderer, "toggled", G_CALLBACK(enable_toggled), store);
 142     column = gtk_tree_view_column_new_with_attributes(
 143         column_titles[ENABLED_COLUMN], renderer, "active", ENABLED_COLUMN,
 144         NULL);
 145     gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
 146     gtk_tree_view_append_column(GTK_TREE_VIEW(column_l), column);
 147
 148     /* Label editor */
 149     renderer = gtk_cell_renderer_text_new();
 150     g_object_set(G_OBJECT(renderer), "editable", TRUE, NULL);
 151     g_signal_connect(renderer, "edited",
 152         G_CALLBACK(filter_expressions_label_changed_cb), GTK_TREE_MODEL(store));
 153     column = gtk_tree_view_column_new_with_attributes(
 154         column_titles[LABEL_COLUMN], renderer, "text", LABEL_COLUMN, NULL);
 155     gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
 156     gtk_tree_view_append_column(GTK_TREE_VIEW(column_l), column);
 157
 158     /* Expression editor */
 159     renderer = gtk_cell_renderer_text_new();
 160     g_object_set(G_OBJECT(renderer), "editable", TRUE, NULL);
 161     g_signal_connect(renderer, "edited",
 162         G_CALLBACK(filter_expressions_expression_changed_cb),
 163         GTK_TREE_MODEL(store));
 164     column = gtk_tree_view_column_new_with_attributes(
 165         column_titles[EXPRESSION_COLUMN], renderer, "text", EXPRESSION_COLUMN,
 166         NULL);
 167     gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
 168     gtk_tree_view_append_column(GTK_TREE_VIEW(column_l), column);
 169
 170     /* XXX - make this match the packet list prefs? */
 171     sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(column_l));
 172     gtk_tree_selection_set_mode(sel, GTK_SELECTION_SINGLE);
 173
 174     gtk_container_add(GTK_CONTAINER(list_sc), column_l);
 175     gtk_widget_show(column_l);
 176
 177     fe = *pfilter_expression_head;
 178     while (fe != NULL) {
 179         fe->index = -1;
 180         gtk_list_store_insert_with_values(store, &iter, G_MAXINT,
 181             ENABLED_COLUMN, fe->enabled,
 182             LABEL_COLUMN, fe->label,
 183             EXPRESSION_COLUMN, fe->expression,
 184             DATA_COLUMN, fe,
 185             -1);
 186
 187         if (first_row) {
 188             first_iter = iter;
 189             first_row = FALSE;
 190         }
 191         fe = fe->next;
 192     }
 193     g_object_unref(G_OBJECT(store));
 194
 195     /* Bottom row: Add/remove buttons */
 196     bottom_hb = gtk_hbox_new(FALSE, 5);
 197     gtk_box_pack_start(GTK_BOX(main_vb), bottom_hb, FALSE, TRUE, 0);
 198     gtk_widget_show(bottom_hb);
 199
 200     /* Add button */
 201     add_remove_hb = gtk_hbox_new(TRUE, 0);
 202     gtk_container_set_border_width(GTK_CONTAINER(add_remove_hb), 5);
 203     gtk_box_pack_start(GTK_BOX(bottom_hb), add_remove_hb, FALSE, FALSE, 0);
 204     gtk_widget_show(add_remove_hb);
 205
 206     add_bt = gtk_button_new_from_stock(GTK_STOCK_ADD);
 207     g_signal_connect(add_bt, "clicked",
 208         G_CALLBACK(filter_expressions_list_new_cb), column_l);
 209     gtk_box_pack_start(GTK_BOX(add_remove_hb), add_bt, FALSE, FALSE, 0);
 210     gtk_widget_set_tooltip_text(add_bt,
 211         "Add a new row at the end of the list.");
 212     gtk_widget_show(add_bt);
 213
 214     /* Remove button */
 215     remove_bt = gtk_button_new_from_stock(GTK_STOCK_REMOVE);
 216     g_signal_connect(remove_bt, "clicked",
 217         G_CALLBACK(filter_expressions_list_remove_cb), column_l);
 218     gtk_box_pack_start(GTK_BOX(add_remove_hb), remove_bt, FALSE, FALSE, 0);
 219     gtk_widget_set_tooltip_text(remove_bt, "Remove the selected row.");
 220     gtk_widget_show(remove_bt);
 221
 222     /* select the first menu list row.             */
 223     /*  Triggers call to column_list_select_cb().  */
 224     if (first_row == FALSE)
 225         gtk_tree_selection_select_iter(sel, &first_iter);
 226
 227     g_object_set_data(G_OBJECT(main_vb), E_FILTER_EXPRESSION_COLUMNL,
 228         column_l);
 229     g_object_set_data(G_OBJECT(main_vb), E_FILTER_EXPRESSION_STORE,
 230         store);
 231
 232     return(main_vb);
 233 }
 234
 235 static void
 236 filter_expressions_list_remove_cb(GtkWidget *w _U_, gpointer data)
 237 {
 238     GtkTreeView      *column_l = GTK_TREE_VIEW(data);
 239     GtkTreeSelection *sel;
 240     GtkTreeModel     *model;
 241     GtkTreeIter       iter;
 242     struct filter_expression *fe;
 243
 244     sel = gtk_tree_view_get_selection(column_l);
 245     if (!gtk_tree_selection_get_selected(sel, &model, &iter))
 246         return;
 247
 248     gtk_tree_model_get(model, &iter, DATA_COLUMN, &fe, -1);
 249     fe->deleted = TRUE;
 250
 251     gtk_list_store_remove(GTK_LIST_STORE(model), &iter);
 252 }
 253
 254 static void
 255 filter_expressions_list_new_cb(GtkWidget *w _U_, gpointer data _U_)
 256 {
 257     const gchar       *label = "New Label";
 258     const gchar       *expression = "New Expression";
 259     GtkTreeView       *fe_l = GTK_TREE_VIEW(data);
 260     GtkTreeModel      *model;
 261     GtkTreeIter        iter;
 262     GtkTreePath       *path;
 263     GtkTreeViewColumn *label_column;
 264     struct filter_expression *fe;
 265
 266     fe = filter_expression_new(label, expression, TRUE);
 267
 268     model = gtk_tree_view_get_model(fe_l);
 269     gtk_list_store_insert_with_values(GTK_LIST_STORE(model), &iter, G_MAXINT,
 270         ENABLED_COLUMN, fe->enabled,
 271         LABEL_COLUMN, fe->label,
 272         EXPRESSION_COLUMN, fe->expression,
 273         DATA_COLUMN, fe,
 274         -1);
 275
 276     /* Triggers call to column_list_select_cb()   */
 277     gtk_tree_selection_select_iter(gtk_tree_view_get_selection(fe_l), &iter);
 278
 279     /* Set the cursor to the 'Title' column of the newly added row and enable
 280      * editing
 281      * XXX: If displaying the new title ["New column"] widens the title column
 282      * of the treeview, then the set_cursor below doesn't properly generate an
 283      * entry box around the title text. The width of the box appears to be the
 284      * column width before the treeview title column was widened. Seems like a
 285      * bug...
 286      *
 287      *      I haven't found a work-around.
 288      */
 289     path = gtk_tree_model_get_path(model, &iter);
 290     label_column = gtk_tree_view_get_column(fe_l, 2);
 291     gtk_tree_view_set_cursor(fe_l, path, label_column, TRUE);
 292     gtk_tree_path_free(path);
 293 }
 294
 295
 296 static gboolean
 297 filter_expressions_expression_changed_cb(GtkCellRendererText *cell _U_, const gchar *str_path, const gchar *new_expression, gpointer data)
 298 {
 299     struct filter_expression *fe;
 300     GtkTreeModel *model = (GtkTreeModel *)data;
 301     GtkTreePath  *path = gtk_tree_path_new_from_string(str_path);
 302     GtkTreeIter   iter;
 303
 304     gtk_tree_model_get_iter(model, &iter, path);
 305     gtk_list_store_set(GTK_LIST_STORE(model), &iter, EXPRESSION_COLUMN,
 306         new_expression, -1);
 307
 308     gtk_tree_model_get(model, &iter, DATA_COLUMN, &fe, -1);
 309     if (fe != NULL) {
 310         g_free(fe->expression);
 311         fe->expression = g_strdup(new_expression);
 312     }
 313
 314     gtk_tree_path_free(path);
 315     return(TRUE);
 316 }
 317
 318 static gboolean
 319 filter_expressions_label_changed_cb(GtkCellRendererText *cell _U_, const gchar *str_path, const gchar *new_label, gpointer data)
 320 {
 321     struct filter_expression *fe;
 322     GtkTreeModel *model = (GtkTreeModel *)data;
 323     GtkTreePath  *path = gtk_tree_path_new_from_string(str_path);
 324     GtkTreeIter   iter;
 325
 326     gtk_tree_model_get_iter(model, &iter, path);
 327     gtk_list_store_set(GTK_LIST_STORE(model), &iter, LABEL_COLUMN, new_label,
 328         -1);
 329
 330     gtk_tree_model_get(model, &iter, DATA_COLUMN, &fe, -1);
 331     if (fe != NULL) {
 332         g_free(fe->label);
 333         fe->label = g_strdup(new_label);
 334     }
 335
 336     gtk_tree_path_free(path);
 337     return TRUE;
 338 }
 339
 340
 341 void
 342 filter_expressions_prefs_fetch(GtkWidget *w)
 343 {
 344     gboolean      items_left;
 345     GtkTreeModel *model;
 346     GtkTreeView  *column_l;
 347     GtkTreeIter   iter;
 348     GtkListStore *store;
 349     struct filter_expression *fe;
 350     gint          first_row = TRUE;
 351     gint          index = 0;
 352
 353     column_l = (GtkTreeView *)g_object_get_data(G_OBJECT(w),
 354         E_FILTER_EXPRESSION_COLUMNL);
 355     model = gtk_tree_view_get_model(column_l);
 356     store = (GtkListStore *)g_object_get_data(G_OBJECT(w),
 357         E_FILTER_EXPRESSION_STORE);
 358
 359     /* Record the order of the items in the list.  */
 360     items_left = gtk_tree_model_get_iter_first(model, &iter);
 361     while (items_left) {
 362         gtk_tree_model_get(model, &iter, DATA_COLUMN, &fe, -1);
 363         if (fe != NULL)
 364             fe->index = index++;
 365         items_left = gtk_tree_model_iter_next (model, &iter);
 366     }
 367
 368     filter_expression_reinit(FILTER_EXPRESSION_REINIT_DESTROY | FILTER_EXPRESSION_REINIT_CREATE);
 369
 370     gtk_list_store_clear(store);
 371     fe = *pfilter_expression_head;
 372     while (fe != NULL) {
 373         fe->index = -1;
 374         gtk_list_store_insert_with_values(store, &iter, G_MAXINT,
 375             ENABLED_COLUMN, fe->enabled,
 376             LABEL_COLUMN, fe->label,
 377             EXPRESSION_COLUMN, fe->expression,
 378             DATA_COLUMN, fe,
 379             -1);
 380
 381         if (first_row) {
 382             first_row = FALSE;
 383         }
 384         fe = fe->next;
 385     }
 386 }