1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/* decode_as.h
* Routines for dissector Decode As handlers
*
* 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 __DECODE_AS_H__
#define __DECODE_AS_H__
#include "ws_symbol_export.h"
#include "ftypes/ftypes.h"
#include "packet_info.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** @file
*/
#define MAX_DECODE_AS_PROMPT_LEN 200
#define DECODE_AS_ENTRY "decode_as_entry"
#define DECODE_AS_NONE "(none)"
/*
* Filename of the "decode as" entry preferences
*/
#define DECODE_AS_ENTRIES_FILE_NAME "decode_as_entries"
/** callback function definition: return formatted label string */
typedef void (*build_label_func)(packet_info *pinfo, gchar* result);
/** callback function definition: return value used to pass to dissector table */
typedef gpointer (*build_valid_func)(packet_info *pinfo);
typedef void (*decode_as_add_to_list_func)(const gchar *table_name, const gchar *proto_name, gpointer value, gpointer user_data);
typedef void (*decode_as_populate_list_func)(const gchar *table_name, decode_as_add_to_list_func add_to_list, gpointer ui_element);
typedef void (*decode_as_free_func)(gpointer value);
/** callback function definition: Clear value from dissector table */
typedef gboolean (*decode_as_reset_func)(const gchar *name, gconstpointer pattern);
/** callback function definition: Apply value to dissector table */
typedef gboolean (*decode_as_change_func)(const gchar *name, gconstpointer pattern, gpointer handle, gchar *list_name);
typedef struct decode_as_value_s {
build_label_func label_func;
guint num_values;
build_valid_func* build_values;
} decode_as_value_t;
typedef struct decode_as_s {
const char *name;
const gchar *title;
const gchar *table_name;
guint num_items;
guint default_index_value;
decode_as_value_t* values;
const char* pre_value_str;
const char* post_value_str;
decode_as_populate_list_func populate_list;
decode_as_reset_func reset_value;
decode_as_change_func change_value;
decode_as_free_func free_func;
} decode_as_t;
/** register a "Decode As". A copy of the decode_as_t will be maintained by the decode_as module */
WS_DLL_PUBLIC void register_decode_as(decode_as_t* reg);
/* Walk though the dissector table and provide dissector_handle_t for each item in the table */
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);
/* Clear a FT_UINT32 value from dissector table list */
WS_DLL_PUBLIC gboolean decode_as_default_reset(const gchar *name, gconstpointer pattern);
/* Add a FT_UINT32 value to dissector table list */
WS_DLL_PUBLIC gboolean decode_as_default_change(const gchar *name, gconstpointer pattern, gpointer handle, gchar *list_name);
/** List of registered decode_as_t structs.
* For UI code only. Should not be directly accessed by dissectors.
*/
WS_DLL_PUBLIC GList *decode_as_list;
/* Some useful utilities for Decode As */
/** Reset the "decode as" entries and reload ones of the current profile.
*/
WS_DLL_PUBLIC void load_decode_as_entries(void);
/** Write out the "decode as" entries of the current profile.
*/
WS_DLL_PUBLIC int save_decode_as_entries(gchar** err);
/** Clear all "decode as" settings.
*/
WS_DLL_PUBLIC void decode_clear_all(void);
/** This routine creates one entry in the list of protocol dissector
* that need to be reset. It is called by the g_hash_table_foreach
* routine once for each changed entry in a dissector table.
* Unfortunately it cannot delete the entry immediately as this screws
* up the foreach function, so it builds a list of dissectors to be
* reset once the foreach routine finishes.
*
* @param table_name The table name in which this dissector is found.
*
* @param key A pointer to the key for this entry in the dissector
* hash table. This is generally the numeric selector of the
* protocol, i.e. the ethernet type code, IP port number, TCP port
* number, etc.
*
* @param selector_type The type of the selector in that dissector table
*
* @param value A pointer to the value for this entry in the dissector
* hash table. This is an opaque pointer that can only be handed back
* to routine in the file packet.c - but it's unused.
*
* @param user_data Unused.
*/
WS_DLL_PUBLIC void decode_build_reset_list (const gchar *table_name, ftenum_t selector_type,
gpointer key, gpointer value _U_,
gpointer user_data _U_);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* decode_as.h */
|
