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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/* value_string.h
* Definitions for value_string structures and routines
*
* $Id$
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __VALUE_STRING_H__
#define __VALUE_STRING_H__
#include <glib.h>
/* Struct for the val_to_str, match_strval_idx, and match_strval functions */
typedef struct _value_string {
guint32 value;
const gchar *strptr;
} value_string;
/* Struct for the str_to_str, match_strstr_idx, and match_strstr functions */
typedef struct _string_string {
const gchar *value;
const gchar *strptr;
} string_string;
/* Struct for the rval_to_str, match_strrval_idx, and match_strrval functions */
typedef struct _range_string {
guint32 value_min;
guint32 value_max;
const gchar *strptr;
} range_string;
/* #define VS_DEF(x) { x, #x } */
/* #define VS_END { 0, NULL } */
/* Tries to match val against each element in the value_string array vs.
Returns the associated string ptr, and sets "*idx" to the index in
that table, on a match, and returns NULL, and sets "*idx" to -1,
on failure. */
extern const gchar* match_strval_idx(const guint32 val, const value_string *vs, gint *idx);
/* Like match_strval_idx(), but doesn't return the index. */
extern const gchar* match_strval(const guint32 val, const value_string *vs);
/* Tries to match val against each element in the value_string array vs.
Returns the associated string ptr on a match.
Formats val with fmt, and returns the resulting string, on failure. */
extern const gchar* val_to_str(const guint32 val, const value_string *vs, const char *fmt);
/* Tries to match val against each element in the value_string array vs.
Returns the associated string ptr on a match.
Returns 'unknown_str', on failure. */
extern const gchar* val_to_str_const(const guint32 val, const value_string *vs, const char *unknown_str);
/* Tries to match val against each element in the string_string array vs.
Returns the associated string ptr, and sets "*idx" to the index in
that table, on a match, and returns NULL, and sets "*idx" to -1,
on failure. */
extern const gchar* match_strstr_idx(const gchar *val, const string_string *vs, gint *idx);
/* Like match_strstr_idx(), but doesn't return the index. */
extern const gchar* match_strstr(const gchar *val, const string_string *vs);
/* Tries to match val against each element in the string_string array vs.
Returns the associated string ptr on a match.
Formats val with fmt, and returns the resulting string, on failure. */
extern const gchar* str_to_str(const gchar *val, const string_string *vs, const char *fmt);
/* --------------------------------------------------------------------*/
/* value_string_ext functions
*
* Extended value strings allow fast(er) value_string array lookups by
* using (if possible) direct access or a binary search of the array.
*
* If the values in the value_string array are a contiguous range of values
* from min to max, the value will be used as as a direct index into the array.
*
* If the values in the array are not contiguous (ie: there are "gaps"),
* but are in assending order a binary search will be used.
*
* If direct access or binary search cannot be used, then a linear search
* is used.
*
* Note that the value_string array used with VALUE_STRING_EXT_INIT
* *must* be terminated with {0, NULL}).
*
* Extended value strings are defined at compile time as follows:
* static const value_string vs[] = { {value1, "string1"}, {value2, "string2"}, ..., {0, NULL}};
* static value_string_ext vse = VALUE_STRING_EXT_INIT(vs);
*
* Extended value strings can be created at runtime by calling
* value_string_ext_new(<ptr to value_string array>,
* <total number of entries in the value_string_array>,
* <value_string_name>);
* Note: <total number of entries in the value_string_array> should include the {0, NULL} entry
*/
/* --------------------------------------------------------------------*/
struct _value_string_ext;
typedef const char *(*_value_string_match_t)(const guint32, const struct _value_string_ext *, gint *idx);
typedef struct _value_string_ext {
_value_string_match_t _vs_match;
guint32 _vs_first_value; /* first value of the value_string array */
guint _vs_num_entries; /* number of entries in the value_string array */
/* (excluding final {0, NULL}) */
const value_string *_vs_p; /* the value string array address */
const gchar *_vs_name; /* vse "Name" (for error messages) */
} value_string_ext;
/* "Acessors" */
#define VALUE_STRING_EXT_VS_P(x) (x)->_vs_p
#define VALUE_STRING_EXT_VS_NUM_ENTRIES(x) (x)->_vs_num_entries
#define VALUE_STRING_EXT_VS_NAME(x) (x)->_vs_name
/* (Fcns for use by proto_registrar_dump_values() [See proto.c]) */
gboolean value_string_ext_validate(value_string_ext *vse);
gchar *value_string_ext_match_type_str(value_string_ext *vse);
/* --- --- */
extern const gchar *_match_strval_ext_init(const guint32 val, value_string_ext *vse);
#define VALUE_STRING_EXT_INIT(x) { (_value_string_match_t) _match_strval_ext_init, 0, array_length(x)-1, x, #x }
/* Create a value_string_ext given a ptr to a value_string array and the total number of entries. */
/* Note: vs_tot_num_entries should include the required {0, NULL} terminating entry of the array. */
/* Return: a pointer to a gmalloc'd and initialized value_string_ext struct. */
extern value_string_ext *value_string_ext_new(value_string *vs, guint vs_tot_num_entries, gchar *vs_name);
/* Looks up val in a value_string array using access method (direct, binary search
* or linear) determined at rutime during the initial access); (see _match_strval_ext_init)
* Returns the associated string ptr on a match or NULL on failure.
*/
extern const gchar* match_strval_ext(const guint32 val, const value_string_ext *vse);
/* Tries to match val against each element in the value_string array vs.
* Returns the associated string ptr, and sets "*idx" to the index in
* that table, on a match, and returns NULL, and sets "*idx" to -1,
* on failure.
*/
extern const gchar* match_strval_idx_ext(const guint32 val, value_string_ext *vse, gint *idx);
/* Similar to match_strval_ext except that on failure
* Formats val with fmt, and returns the resulting string
*/
extern const gchar* val_to_str_ext(const guint32 val, const value_string_ext *vs, const char *fmt);
/* Similar to match_strval_ext except that on failure
* Returns 'unknown_str'
*/
extern const gchar* val_to_str_ext_const(const guint32 val, const value_string_ext *vs, const char *unknown_str);
/* ---- ---- */
/* Generate a string describing an enumerated bitfield (an N-bit field
with various specific values having particular names). */
extern const char *decode_enumerated_bitfield(const guint32 val, const guint32 mask,
const int width, const value_string *tab, const char *fmt);
/* Generate a string describing an enumerated bitfield (an N-bit field
with various specific values having particular names). */
extern const char *decode_enumerated_bitfield_shifted(const guint32 val, const guint32 mask,
const int width, const value_string *tab, const char *fmt);
/* ranges aware versions */
/* Tries to match val against each range in the range_string array rs.
Returns the associated string ptr on a match.
Formats val with fmt, and returns the resulting string, on failure. */
extern const gchar* rval_to_str(const guint32 val, const range_string *rs, const char *fmt);
/* Tries to match val against each range in the range_string array rs.
Returns the associated string ptr, and sets "*idx" to the index in
that table, on a match, and returns NULL, and sets "*idx" to -1,
on failure. */
extern const gchar *match_strrval_idx(const guint32 val, const range_string *rs, gint *idx);
/* Like match_strrval_idx(), but doesn't return the index. */
extern const gchar *match_strrval(const guint32 val, const range_string *rs);
#endif /* __VALUE_STRING_H__ */
|
