ui/gtk/prefs_filter_expressions.c

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