Wireshark  4.3.0
The Wireshark network protocol analyzer
decode_as.h
Go to the documentation of this file.
1 /* decode_as.h
2  * Routines for dissector Decode As handlers
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * SPDX-License-Identifier: GPL-2.0-or-later
9  */
10 
11 #ifndef __DECODE_AS_H__
12 #define __DECODE_AS_H__
13 
14 #include "ws_symbol_export.h"
15 
16 #include "ftypes/ftypes.h"
17 #include "packet_info.h"
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif /* __cplusplus */
22 
26 #define MAX_DECODE_AS_PROMPT_LEN 200
27 #define DECODE_AS_ENTRY "decode_as_entry"
28 #define DECODE_AS_NONE "(none)"
29 
30 /*
31  * Filename of the "decode as" entry preferences
32  */
33 #define DECODE_AS_ENTRIES_FILE_NAME "decode_as_entries"
34 
35 
37 typedef void (*build_label_func)(packet_info *pinfo, gchar* result);
38 
40 typedef gpointer (*build_valid_func)(packet_info *pinfo);
41 
42 typedef void (*decode_as_add_to_list_func)(const gchar *table_name, const gchar *proto_name, gpointer value, gpointer user_data);
43 typedef void (*decode_as_populate_list_func)(const gchar *table_name, decode_as_add_to_list_func add_to_list, gpointer ui_element);
44 typedef void (*decode_as_free_func)(gpointer value);
45 
47 typedef bool (*decode_as_reset_func)(const gchar *name, gconstpointer pattern);
49 typedef bool (*decode_as_change_func)(const gchar *name, gconstpointer pattern, gconstpointer handle, const gchar *list_name);
50 
56 typedef struct decode_as_value_s {
58  guint num_values;
61 
71 typedef struct decode_as_s {
72  const char *name;
73  const gchar *table_name;
74  guint num_items;
77  const char* pre_value_str;
78  const char* post_value_str;
79  decode_as_populate_list_func populate_list;
82  decode_as_free_func free_func;
85 
87 WS_DLL_PUBLIC void register_decode_as(decode_as_t* reg);
88 
89 /* Forward declaration to prevent requiring packet.h */
90 struct dissector_table;
91 
106 WS_DLL_PUBLIC struct dissector_table* register_decode_as_next_proto(int proto, const gchar *table_name, const gchar *ui_name, build_label_func label_func);
107 
108 /* Walk though the dissector table and provide dissector_handle_t for each item in the table */
109 WS_DLL_PUBLIC void decode_as_default_populate_list(const gchar *table_name, decode_as_add_to_list_func add_to_list, gpointer ui_element);
110 /* Clear a FT_UINT32 value from dissector table list */
111 WS_DLL_PUBLIC bool decode_as_default_reset(const gchar *name, gconstpointer pattern);
112 /* Add a FT_UINT32 value to dissector table list */
113 WS_DLL_PUBLIC bool decode_as_default_change(const gchar *name, gconstpointer pattern, gconstpointer handle, const gchar *list_name);
114 
118 WS_DLL_PUBLIC GList *decode_as_list;
119 
120 /* Some useful utilities for Decode As */
121 
126 extern void load_decode_as_entries(void);
127 
130 WS_DLL_PUBLIC int save_decode_as_entries(gchar** err);
131 
134 WS_DLL_PUBLIC void decode_clear_all(void);
135 
138 WS_DLL_PUBLIC void decode_cleanup(void);
139 
162 WS_DLL_PUBLIC void decode_build_reset_list (const gchar *table_name, ftenum_t selector_type,
163  gpointer key, gpointer value,
164  gpointer user_data);
165 
166 
167 #ifdef __cplusplus
168 }
169 #endif /* __cplusplus */
170 
171 #endif /* decode_as.h */
struct decode_as_s decode_as_t
struct decode_as_value_s decode_as_value_t
WS_DLL_PUBLIC void register_decode_as(decode_as_t *reg)
Definition: decode_as.c:29
WS_DLL_PUBLIC void decode_cleanup(void)
Definition: decode_as.c:533
bool(* decode_as_change_func)(const gchar *name, gconstpointer pattern, gconstpointer handle, const gchar *list_name)
Definition: decode_as.h:49
WS_DLL_PUBLIC void decode_clear_all(void)
Definition: decode_as.c:487
WS_DLL_PUBLIC void decode_build_reset_list(const gchar *table_name, ftenum_t selector_type, gpointer key, gpointer value, gpointer user_data)
Definition: decode_as.c:448
WS_DLL_PUBLIC struct dissector_table * register_decode_as_next_proto(int proto, const gchar *table_name, const gchar *ui_name, build_label_func label_func)
Definition: decode_as.c:61
gpointer(* build_valid_func)(packet_info *pinfo)
Definition: decode_as.h:40
WS_DLL_PUBLIC int save_decode_as_entries(gchar **err)
Definition: decode_as.c:390
void load_decode_as_entries(void)
Definition: decode_as.c:285
bool(* decode_as_reset_func)(const gchar *name, gconstpointer pattern)
Definition: decode_as.h:47
void(* build_label_func)(packet_info *pinfo, gchar *result)
Definition: decode_as.h:37
WS_DLL_PUBLIC GList * decode_as_list
Definition: decode_as.h:118
Definition: packet_info.h:44
Definition: decode_as.h:71
guint num_items
Definition: decode_as.h:74
const char * post_value_str
Definition: decode_as.h:78
const char * name
Definition: decode_as.h:72
guint default_index_value
Definition: decode_as.h:75
decode_as_value_t * values
Definition: decode_as.h:76
decode_as_populate_list_func populate_list
Definition: decode_as.h:79
decode_as_change_func change_value
Definition: decode_as.h:81
decode_as_free_func free_func
Definition: decode_as.h:82
decode_as_reset_func reset_value
Definition: decode_as.h:80
const gchar * table_name
Definition: decode_as.h:73
const char * pre_value_str
Definition: decode_as.h:77
Definition: decode_as.h:56
guint num_values
Definition: decode_as.h:58
build_valid_func * build_values
Definition: decode_as.h:59
build_label_func label_func
Definition: decode_as.h:57
Definition: packet.c:86