epan/value_string.h

   1 /* value_string.h
   2  * Definitions for value_string structures and routines
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@zing.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 #ifndef __VALUE_STRING_H__
  27 #define __VALUE_STRING_H__
  28
  29 #include <glib.h>
  30
  31 /* Struct for the match_strval function */
  32
  33 typedef struct _value_string {
  34   guint32  value;
  35   const gchar   *strptr;
  36 } value_string;
  37
  38 /* #define VS_DEF(x) { x, #x } */
  39 /* #define VS_END    { 0, NULL } */
  40
  41 /* Tries to match val against each element in the value_string array vs.
  42    Returns the associated string ptr on a match, or NULL on failure. */
  43 extern gchar*     match_strval(guint32 val, const value_string *vs);
  44
  45 /* Tries to match val against each element in the value_string array vs.
  46    Returns the associated string ptr on a match.
  47    Formats val with fmt, and returns the resulting string, on failure. */
  48 extern gchar*     val_to_str(guint32 val, const value_string *vs, const char *fmt);
  49
  50 /* Generate a string describing an enumerated bitfield (an N-bit field
  51    with various specific values having particular names). */
  52 extern const char *decode_enumerated_bitfield(guint32 val, guint32 mask,
  53   int width, const value_string *tab, const char *fmt);
  54
  55 /* Generate a string describing an enumerated bitfield (an N-bit field
  56    with various specific values having particular names). */
  57 extern const char *decode_enumerated_bitfield_shifted(guint32 val, guint32 mask,
  58   int width, const value_string *tab, const char *fmt);
  59
  60 #endif /* __VALUE_STRING_H__ */