aboutsummaryrefslogtreecommitdiffstats
path: root/ui/filters.h
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2014-06-30 14:47:22 -0700
committerGuy Harris <guy@alum.mit.edu>2014-06-30 21:47:58 +0000
commitc1d2b29d01df216e7a36584692aa0c3082a3aafe (patch)
tree80ee93355c611dae93ddac1f944b0264a48a8c55 /ui/filters.h
parent5e283865403d02c4a1139ad70eabeb2c35d6a88d (diff)
Move filters.[ch] to libui.
Change-Id: I32f04016498dfe8f54b0480f30a84ffe5ef7868f Reviewed-on: https://code.wireshark.org/review/2727 Reviewed-by: Guy Harris <guy@alum.mit.edu>
Diffstat (limited to 'ui/filters.h')
-rw-r--r--ui/filters.h96
1 files changed, 96 insertions, 0 deletions
diff --git a/ui/filters.h b/ui/filters.h
new file mode 100644
index 0000000000..bc8e797258
--- /dev/null
+++ b/ui/filters.h
@@ -0,0 +1,96 @@
+/* filters.h
+ * Declarations of routines for reading and writing the filters file.
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef __UI_FILTERS_H__
+#define __UI_FILTERS_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/*
+ * Filter lists.
+ */
+typedef enum {
+ CFILTER_LIST, /* capture filter list - saved */
+ DFILTER_LIST, /* display filter list - saved */
+ CFILTER_EDITED_LIST, /* capture filter list - currently edited */
+ DFILTER_EDITED_LIST /* display filter list - currently edited */
+} filter_list_type_t;
+
+/*
+ * Item in a list of filters.
+ */
+typedef struct {
+ char *name; /* filter name */
+ char *strval; /* filter expression */
+} filter_def;
+
+/*
+ * Read in a list of filters.
+ *
+ * On success, "*pref_path_return" is set to NULL.
+ * On error, "*pref_path_return" is set to point to the pathname of
+ * the file we tried to read - it should be freed by our caller -
+ * and "*errno_return" is set to the error.
+ */
+void read_filter_list(filter_list_type_t list_type, char **pref_path_return,
+ int *errno_return);
+
+/*
+ * Get a pointer to the first entry in a filter list.
+ */
+GList *get_filter_list_first(filter_list_type_t list);
+
+/*
+ * Add a new filter to the end of a list.
+ * Returns a pointer to the newly-added entry.
+ */
+GList *add_to_filter_list(filter_list_type_t list, const char *name,
+ const char *expression);
+
+/*
+ * Remove a filter from a list.
+ */
+void remove_from_filter_list(filter_list_type_t list, GList *fl_entry);
+
+/*
+ * Write out a list of filters.
+ *
+ * On success, "*pref_path_return" is set to NULL.
+ * On error, "*pref_path_return" is set to point to the pathname of
+ * the file we tried to read - it should be freed by our caller -
+ * and "*errno_return" is set to the error.
+ */
+void save_filter_list(filter_list_type_t list_type, char **pref_path_return,
+ int *errno_return);
+
+/*
+ * Clone the filter list so it can be edited.
+ */
+void copy_filter_list(filter_list_type_t dest_type, filter_list_type_t src_type);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* __UI_FILTERS_H__ */