epan/disabled_protos.h

   1 /** @file
   2  * Declarations of routines for reading and writing protocols file that determine
   3  * enabling and disabling of protocols.
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef DISABLED_PROTOS_H
  13 #define DISABLED_PROTOS_H
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif /* __cplusplus */
  18
  19 #include <ws_symbol_export.h>
  20
  21 /*
  22  * Tell if protocols have been enabled/disabled since
  23  * we've last loaded (or saved) the lists.
  24  */
  25 WS_DLL_PUBLIC bool
  26 enabled_protos_unsaved_changes(void);
  27
  28 /*
  29  * Disable a particular protocol by name
  30  * On success (found the protocol), return true.
  31  * On failure (didn't find the protocol), return false.
  32  */
  33 WS_DLL_PUBLIC bool
  34 proto_disable_proto_by_name(const char *name);
  35
  36 /*
  37  * Enable a particular protocol by name
  38  * On success (found the protocol), return true.
  39  * On failure (didn't find the protocol), return false.
  40  */
  41 WS_DLL_PUBLIC bool
  42 proto_enable_proto_by_name(const char *name);
  43
  44 /*
  45  * Enable a particular heuristic dissector by name
  46  * On success (found the protocol), return true.
  47  * On failure (didn't find the protocol), return false.
  48  */
  49 WS_DLL_PUBLIC bool
  50 proto_enable_heuristic_by_name(const char *name);
  51
  52 /*
  53  * Disable a particular heuristic dissector by name
  54  * On success (found the protocol), return true.
  55  * On failure (didn't find the protocol), return false.
  56  */
  57 WS_DLL_PUBLIC bool
  58 proto_disable_heuristic_by_name(const char *name);
  59
  60 /*
  61  * Read the files that enable and disable protocols and heuristic
  62  * dissectors.  Report errors through the UI.
  63  *
  64  * This is called by epan_load_settings(); programs should call that
  65  * rather than individually calling the routines it calls.
  66  * This is only public (instead of extern) to allow users who temporarily
  67  * disable protocols in the PHS GUI to re-enable them.
  68  */
  69 WS_DLL_PUBLIC void
  70 read_enabled_and_disabled_lists(void);
  71
  72 /*
  73  * Write out the lists of enabled and disabled protocols and heuristic
  74  * dissectors to the corresponding files.  Report errors through the UI.
  75  */
  76 WS_DLL_PUBLIC void
  77 save_enabled_and_disabled_lists(void);
  78
  79 /*
  80  * Free the internal structures
  81  */
  82 extern void
  83 cleanup_enabled_and_disabled_lists(void);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif /* __cplusplus */
  88
  89 #endif /* DISABLED_PROTOS_H */