2001-04-01 03:18:41 +00:00
|
|
|
/* value_string.h
|
|
|
|
* Definitions for value_string structures and routines
|
|
|
|
*
|
2004-07-18 00:24:25 +00:00
|
|
|
* $Id$
|
2001-04-01 03:18:41 +00:00
|
|
|
*
|
2006-05-21 05:12:17 +00:00
|
|
|
* Wireshark - Network traffic analyzer
|
|
|
|
* By Gerald Combs <gerald@wireshark.org>
|
2001-04-01 03:18:41 +00:00
|
|
|
* 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.
|
2002-08-28 20:41:00 +00:00
|
|
|
*
|
2001-04-01 03:18:41 +00:00
|
|
|
* 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.
|
2002-08-28 20:41:00 +00:00
|
|
|
*
|
2001-04-01 03:18:41 +00:00
|
|
|
* 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>
|
|
|
|
|
2005-06-26 19:56:52 +00:00
|
|
|
/* Struct for the val_to_str, match_strval_idx, and match_strval functions */
|
2001-04-01 03:18:41 +00:00
|
|
|
|
|
|
|
typedef struct _value_string {
|
|
|
|
guint32 value;
|
2005-06-16 17:23:34 +00:00
|
|
|
const gchar *strptr;
|
2001-04-01 03:18:41 +00:00
|
|
|
} value_string;
|
|
|
|
|
2009-05-26 00:49:38 +00:00
|
|
|
/* 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;
|
|
|
|
|
2006-12-07 20:29:40 +00:00
|
|
|
/* 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;
|
|
|
|
|
2004-05-07 11:34:10 +00:00
|
|
|
/* #define VS_DEF(x) { x, #x } */
|
|
|
|
/* #define VS_END { 0, NULL } */
|
2004-02-22 22:45:21 +00:00
|
|
|
|
2004-05-07 11:34:10 +00:00
|
|
|
/* Tries to match val against each element in the value_string array vs.
|
2005-06-26 19:56:52 +00:00
|
|
|
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. */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const gchar* match_strval_idx(const guint32 val, const value_string *vs, gint *idx);
|
2005-06-26 19:56:52 +00:00
|
|
|
|
|
|
|
/* Like match_strval_idx(), but doesn't return the index. */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const gchar* match_strval(const guint32 val, const value_string *vs);
|
2001-04-01 03:18:41 +00:00
|
|
|
|
2004-05-07 11:34:10 +00:00
|
|
|
/* 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. */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const gchar* val_to_str(const guint32 val, const value_string *vs, const char *fmt);
|
2004-05-07 11:34:10 +00:00
|
|
|
|
2009-09-06 04:26:50 +00:00
|
|
|
/* 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. */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const gchar* val_to_str_const(const guint32 val, const value_string *vs, const char *unknown_str);
|
2009-09-06 04:26:50 +00:00
|
|
|
|
2009-05-26 00:49:38 +00:00
|
|
|
/* 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_strstr_idx(const gchar *val, const string_string *vs, gint *idx);
|
|
|
|
|
|
|
|
/* Like match_strval_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 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* str_to_str(const gchar *val, const string_string *vs, const char *fmt);
|
|
|
|
|
2004-05-07 11:34:10 +00:00
|
|
|
/* Generate a string describing an enumerated bitfield (an N-bit field
|
|
|
|
with various specific values having particular names). */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const char *decode_enumerated_bitfield(const guint32 val, const guint32 mask,
|
|
|
|
const int width, const value_string *tab, const char *fmt);
|
2004-05-07 11:34:10 +00:00
|
|
|
|
|
|
|
/* Generate a string describing an enumerated bitfield (an N-bit field
|
|
|
|
with various specific values having particular names). */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const char *decode_enumerated_bitfield_shifted(const guint32 val, const guint32 mask,
|
|
|
|
const int width, const value_string *tab, const char *fmt);
|
2001-04-01 03:18:41 +00:00
|
|
|
|
2006-12-07 20:29:40 +00:00
|
|
|
|
|
|
|
/* 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. */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const gchar* rval_to_str(const guint32 val, const range_string *rs, const char *fmt);
|
2006-12-07 20:29:40 +00:00
|
|
|
|
|
|
|
/* 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. */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const gchar *match_strrval_idx(const guint32 val, const range_string *rs, gint *idx);
|
2006-12-07 20:29:40 +00:00
|
|
|
|
|
|
|
/* Like match_strrval_idx(), but doesn't return the index. */
|
2010-04-03 18:18:50 +00:00
|
|
|
extern const gchar *match_strrval(const guint32 val, const range_string *rs);
|
2006-12-07 20:29:40 +00:00
|
|
|
|
2001-04-01 03:18:41 +00:00
|
|
|
#endif /* __VALUE_STRING_H__ */
|