epan/to_str.h

   1 /* to_str.h
   2  * Definitions for utilities to convert various other types to strings.
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __TO_STR_H__
  26 #define __TO_STR_H__
  27
  28 #include <glib.h>
  29
  30 #include "nstime.h"
  31 #include "time_fmt.h"
  32 #include <epan/packet_info.h>
  33
  34 #define GUID_STR_LEN 37
  35 #define MAX_IP_STR_LEN 16
  36 #define MAX_IP6_STR_LEN 40
  37 #define MAX_ADDR_STR_LEN 256
  38 #define VINES_ADDR_LEN  6
  39 #define EUI64_STR_LEN 24
  40
  41 /*
  42  * These are utility functions which convert various types to strings,
  43  * but for which no more specific module applies.
  44  */
  45
  46 struct     e_in6_addr;
  47
  48 /* !!Deprecated!! - use ep_address_to_str() */
  49 #define address_to_str ep_address_to_str
  50 extern gchar*   ep_address_to_str(const address *);
  51 extern gchar*   se_address_to_str(const address *);
  52 extern void     address_to_str_buf(const address *addr, gchar *buf, int buf_len);
  53 extern gchar*   bytestring_to_str(const guint8 *, const guint32, const char);
  54 extern gchar*   ether_to_str(const guint8 *);
  55 extern gchar*   tvb_ether_to_str(tvbuff_t *tvb, const gint offset);
  56 extern const gchar*     ip_to_str(const guint8 *);
  57 extern const gchar*     tvb_ip_to_str(tvbuff_t *tvb, const gint offset);
  58 extern void     ip_to_str_buf(const guint8 *ad, gchar *buf, const int buf_len);
  59 extern gchar*   fc_to_str(const guint8 *);
  60 extern gchar*   fcwwn_to_str (const guint8 *);
  61 extern gchar*   tvb_fc_to_str(tvbuff_t *tvb, const gint offset);
  62 extern gchar*   tvb_fcwwn_to_str (tvbuff_t *tvb, const gint offset);
  63 extern gchar*   ip6_to_str(const struct e_in6_addr *);
  64 extern gchar*   tvb_ip6_to_str(tvbuff_t *tvb, const gint offset);
  65 extern void     ip6_to_str_buf(const struct e_in6_addr *, gchar *);
  66 extern gchar*   ipx_addr_to_str(const guint32, const guint8 *);
  67 extern gchar*   ipxnet_to_string(const guint8 *ad);
  68 extern gchar*   ipxnet_to_str_punct(const guint32 ad, const char punct);
  69 extern gchar*   tvb_vines_addr_to_str(tvbuff_t *tvb, const gint offset);
  70 extern gchar*   eui64_to_str(const guint64 ad);
  71 extern gchar*   tvb_eui64_to_str(tvbuff_t *tvb, const gint offset, const guint encoding);
  72 extern gchar*   time_secs_to_str(const gint32 time_val);
  73 extern gchar*   time_secs_to_str_unsigned(const guint32);
  74 extern gchar*   time_msecs_to_str(gint32 time_val);
  75 extern gchar*   abs_time_to_str(const nstime_t*, const absolute_time_display_e fmt,
  76     gboolean show_zone);
  77 extern gchar*   abs_time_secs_to_str(const time_t, const absolute_time_display_e fmt,
  78     gboolean show_zone);
  79 extern void     display_signed_time(gchar *, int, const gint32, gint32, const to_str_time_res_t);
  80 extern void     display_epoch_time(gchar *, int, const time_t,  gint32, const to_str_time_res_t);
  81
  82 extern gchar*   guint32_to_str(const guint32 u);
  83 extern void     guint32_to_str_buf(guint32 u, gchar *buf, int buf_len);
  84
  85 extern gchar*   rel_time_to_str(const nstime_t*);
  86 extern gchar*   rel_time_to_secs_str(const nstime_t*);
  87 extern gchar*   guid_to_str(const e_guid_t*);
  88 extern gchar*   guid_to_str_buf(const e_guid_t*, gchar*, int);
  89
  90 extern char *decode_bits_in_field(const guint bit_offset, const gint no_of_bits, const guint64 value);
  91
  92 extern char     *other_decode_bitfield_value(char *buf, const guint32 val, const guint32 mask,
  93     const int width);
  94 extern char     *decode_bitfield_value(char *buf, const guint32 val, const guint32 mask,
  95     const int width);
  96 extern const char *decode_boolean_bitfield(const guint32 val, const guint32 mask, const int width,
  97   const char *truedesc, const char *falsedesc);
  98 extern const char *decode_numeric_bitfield(const guint32 val, const guint32 mask, const int width,
  99   const char *fmt);
 100
 101 #endif /* __TO_STR_H__  */