aboutsummaryrefslogtreecommitdiffstats
path: root/ui/filter_files.h
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2017-04-08 21:24:45 -0700
committerGuy Harris <guy@alum.mit.edu>2017-04-09 04:25:52 +0000
commit77cad8561cec1699d7a4317e34c5590d566c9eb8 (patch)
tree3f24eb8a1a898670b652d688157c50867d5e4617 /ui/filter_files.h
parent62b342443ddf2e5089c9cbaf137dc6a81b0b4678 (diff)
Move the filter file reading code to libui.
It doesn't belong in libwireshark, as it doesn't affect dissection, but it *does* belong in libui, as it's helper code for the UIs. Change-Id: I8a5e0640a299a08e9ec1917dd253197438ebfdbc Reviewed-on: https://code.wireshark.org/review/20974 Reviewed-by: Guy Harris <guy@alum.mit.edu>
Diffstat (limited to 'ui/filter_files.h')
-rw-r--r--ui/filter_files.h114
1 files changed, 114 insertions, 0 deletions
diff --git a/ui/filter_files.h b/ui/filter_files.h
new file mode 100644
index 0000000000..f953b2f506
--- /dev/null
+++ b/ui/filter_files.h
@@ -0,0 +1,114 @@
+/* filter_filess.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. GTK+ only. */
+ DFILTER_EDITED_LIST /* display filter list - currently edited. GTK+ only. */
+} 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. GTK+ only.
+ */
+void copy_filter_list(filter_list_type_t dest_type, filter_list_type_t src_type);
+
+/*
+ * Free all filter lists
+ */
+void free_filter_lists(void);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* __UI_FILTERS_H__ */
+
+/*
+ * Editor modelines - http://www.wireshark.org/tools/modelines.html
+ *
+ * Local Variables:
+ * c-basic-offset: 2
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * vi: set shiftwidth=2 tabstop=8 expandtab:
+ * :indentSize=2:tabSize=8:noTabs=true:
+ */