epan/dissector_filters.h

   1 /* dissector_filters.h
   2  * Routines for dissector generated display filters
   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __DISSECTOR_FILTERS_H__
  26 #define __DISSECTOR_FILTERS_H__
  27
  28 #include "ws_symbol_export.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 /** @file
  35  */
  36
  37 /** callback function definition: is a filter available for this packet? */
  38 typedef gboolean (*is_filter_valid_func)(packet_info *pinfo);
  39
  40 /** callback function definition: return the available filter for this packet or NULL if no filter is available */
  41 typedef const gchar* (*build_filter_string_func)(packet_info *pinfo);
  42
  43
  44 /** register a dissector filter */
  45 WS_DLL_PUBLIC void register_dissector_filter(const char *name, is_filter_valid_func is_filter_valid, build_filter_string_func build_filter_string);
  46
  47
  48
  49 /*** THE FOLLOWING SHOULD NOT BE USED BY ANY DISSECTORS!!! ***/
  50
  51 typedef struct dissector_filter_s {
  52     const char *                name;
  53     is_filter_valid_func        is_filter_valid;
  54     build_filter_string_func    build_filter_string;
  55 } dissector_filter_t;
  56
  57 WS_DLL_PUBLIC GList *dissector_filter_list;
  58
  59 #ifdef __cplusplus
  60 }
  61 #endif /* __cplusplus */
  62
  63 #endif /* dissector_filters.h */