1berry/wireshark
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
wireshark/wsutil/plugins.h

72 lines
1.7 KiB
C
Raw Permalink Normal View History

Add files with WS_DLL_PUBLIC to Doxygen Add @file markers for most files that contain functions exported with WS_DLL_PUBLIC so that Doxygen will generate documentation for them.
2021-11-25 22:31:05 -05:00
/** @file
plugins support (i.e. Dynamically loadable dissectors) depends on dlopen() being available on the target platform svn path=/trunk/; revision=1263
1999-12-09 20:43:38 +00:00
* definitions for plugins structures
*
name change svn path=/trunk/; revision=18197
2006-05-21 05:12:17 +00:00
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
Load lua scripts in the plugins directory, both global and personal. List loaded lua scripts in Help->About->Plugins. svn path=/trunk/; revision=30675
2009-10-23 17:52:18 +00:00
* Copyright 1998 Gerald Combs
plugins support (i.e. Dynamically loadable dissectors) depends on dlopen() being available on the target platform svn path=/trunk/; revision=1263
1999-12-09 20:43:38 +00:00
*
replace SPDX identifier GPL-2.0+ with GPL-2.0-or-later. The first is deprecated, as per https://spdx.org/licenses/. Change-Id: I8e21e1d32d09b8b94b93a2dc9fbdde5ffeba6bed Reviewed-on: https://code.wireshark.org/review/25661 Petri-Dish: Anders Broman <a.broman58@gmail.com> Petri-Dish: Dario Lombardo <lomato@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-07 12:26:45 +01:00
* SPDX-License-Identifier: GPL-2.0-or-later
plugins support (i.e. Dynamically loadable dissectors) depends on dlopen() being available on the target platform svn path=/trunk/; revision=1263
1999-12-09 20:43:38 +00:00
*/
#ifndef __PLUGINS_H__
#define __PLUGINS_H__
Add new global header wireshark.h with guideline Remove ws_diag_control.h from config.h because that was a workaround for the lack of a public global header. Fix the resultant build errors.
2021-10-16 10:33:34 +01:00
#include <wireshark.h>
Move even more headers outside extern "C". If a header declares a function, or anything else requiring the extern "C" decoration, have it wrap the declaration itself; don't rely on the header itself being included inside extern "C".
2021-03-16 04:33:00 -07:00
Add extern "C" to more header files. svn path=/trunk/; revision=35093
2010-12-01 18:25:18 +00:00
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
Revert "Refactor plugin registration and add ABI/license check" This reverts commit 90b16b40921b737aadf9186685d866fd80e37ee6.
2023-12-19 22:02:04 +01:00
typedef void (*plugin_register_func)(void);
typedef uint32_t (*plugin_describe_func)(void);
typedef void plugins_t;
Use an enum for plugin types. Make plugins.c the source of truth for plugin names. Where plugins reside and what they do are two different things, so split the plugin directory and description into two separate elements. CMake creates portable[1] builds on Windows and macOS. That is, the build-time directory layout is the same as the installation directory layout. Adjust various plugin paths macOS accordingly. [1] You have to run osx-app.sh on macOS to prepare the application bundle, but the goal is to create a directory/bundle that can be moved or copied to a different system and run in the new location. Change-Id: Icf9d02e61918fdf1404468baf52542910edf2743 Reviewed-on: https://code.wireshark.org/review/25166 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-05 09:09:40 -08:00
typedef enum {
WS_PLUGIN_EPAN,
WS_PLUGIN_WIRETAP,
WS_PLUGIN_CODEC
} plugin_type_e;
plugins: Make flags unsigned
2023-10-29 23:05:54 +00:00
#define WS_PLUGIN_DESC_DISSECTOR (1UL << 0)
#define WS_PLUGIN_DESC_FILE_TYPE (1UL << 1)
#define WS_PLUGIN_DESC_CODEC (1UL << 2)
#define WS_PLUGIN_DESC_EPAN (1UL << 3)
#define WS_PLUGIN_DESC_TAP_LISTENER (1UL << 4)
Revert "plugins: Rename "dfilter" to "dfunction"" This reverts commit a7827322fc3c53e54befbffba3d6ab21fea6fc45.
2023-12-19 21:55:10 +01:00
#define WS_PLUGIN_DESC_DFILTER (1UL << 5)
plugins: Allow multiple types in description Allow plugins to declare their type, for the purpose of inserting a description in the UI. The type consist of one or more bit ORed flags. This fixes the 'stats_tree' plugin description in the UI. The plugin is not a dissector type plugin, as was being displayed before. Now it correctly shows "tap listener" plugin.
2023-10-25 20:11:01 +01:00
Use an enum for plugin types. Make plugins.c the source of truth for plugin names. Where plugins reside and what they do are two different things, so split the plugin directory and description into two separate elements. CMake creates portable[1] builds on Windows and macOS. That is, the build-time directory layout is the same as the installation directory layout. Adjust various plugin paths macOS accordingly. [1] You have to run osx-app.sh on macOS to prepare the application bundle, but the goal is to create a directory/bundle that can be moved or copied to a different system and run in the new location. Change-Id: Icf9d02e61918fdf1404468baf52542910edf2743 Reviewed-on: https://code.wireshark.org/review/25166 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-05 09:09:40 -08:00
WS_DLL_PUBLIC plugins_t *plugins_init(plugin_type_e type);
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-10-01 00:56:03 +01:00
plugins: Sort the descriptions Change-Id: I8113ba9782962856ce86475cddf40d69ed267fb4 Reviewed-on: https://code.wireshark.org/review/23733 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2017-09-25 20:42:29 +01:00
typedef void (*plugin_description_callback)(const char *name, const char *version,
Revert "Qt: Add plugin description/homepage fields to About dialog" This reverts commit 9c39c82cb1e1e8465889326f686b90c7ac536f6a.
2023-12-19 21:55:14 +01:00
uint32_t flags, const char *filename,
plugins: Sort the descriptions Change-Id: I8113ba9782962856ce86475cddf40d69ed267fb4 Reviewed-on: https://code.wireshark.org/review/23733 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2017-09-25 20:42:29 +01:00
void *user_data);
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-10-01 00:56:03 +01:00
Move most of the plugin code from epan to wsutil and remove all knowledge of particular types of plugins. Instead, let particular types of plugins register with the common plugin code, giving a name and a routine to recognize that type of plugin. In particular applications, only process the relevant plugin types. Add a Makefile.common to the codecs directory. svn path=/trunk/; revision=53710
2013-12-02 08:30:29 +00:00
WS_DLL_PUBLIC void plugins_get_descriptions(plugin_description_callback callback, void *user_data);
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-10-01 00:56:03 +01:00
Export libwireshark symbols using WS_DLL_PUBLIC define Also remove old WS_VAR_IMPORT define and related Makefile magic everywhere in the project. svn path=/trunk/; revision=47992
2013-03-01 23:53:11 +00:00
WS_DLL_PUBLIC void plugins_dump_all(void);
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-10-01 00:56:03 +01:00
Make plugin support a runtime property Keep the option to disable at compile-time but use AC_ARG_ENABLE instead. Change-Id: Ie8c3f5ba0db1eb6d9d4ffd742cd3aa049ead5007 Reviewed-on: https://code.wireshark.org/review/24026 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-10-22 20:30:07 +01:00
WS_DLL_PUBLIC int plugins_get_count(void);
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-10-01 00:56:03 +01:00
WS_DLL_PUBLIC void plugins_cleanup(plugins_t *plugins);
separate dir functions from the plugin init, put this and some other dirs in the about dialog svn path=/trunk/; revision=10928
2004-05-20 13:48:25 +00:00
Convert wsutil to C99 types Ping #19116
2023-09-22 13:42:49 -07:00
WS_DLL_PUBLIC bool plugins_supported(void);
CMake: Cleanup unnecessary linking with shared libraries
2023-01-30 20:27:06 +00:00
Add extern "C" to more header files. svn path=/trunk/; revision=35093
2010-12-01 18:25:18 +00:00
#ifdef __cplusplus
}
#endif /* __cplusplus */
plugins support (i.e. Dynamically loadable dissectors) depends on dlopen() being available on the target platform svn path=/trunk/; revision=1263
1999-12-09 20:43:38 +00:00
#endif /* __PLUGINS_H__ */
Fix indent (use 4 spaces) and add modelines svn path=/trunk/; revision=53388
2013-11-17 14:03:32 +00:00
/*
* Editor modelines
*
* Local Variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* ex: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/
Reference in New Issue Copy Permalink