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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 <epan/packet_info.h>
  32
  33 #define GUID_STR_LEN 37
  34 #define MAX_IP_STR_LEN 16
  35 #define MAX_ADDR_STR_LEN 256
  36
  37 /*
  38  * Resolution of a time stamp.
  39  */
  40 typedef enum {
  41         SECS,   /* seconds */
  42         DSECS,  /* deciseconds */
  43         CSECS,  /* centiseconds */
  44         MSECS,  /* milliseconds */
  45         USECS,  /* microseconds */
  46         NSECS   /* nanoseconds */
  47 } time_res_t;
  48
  49 /*
  50  * These are utility functions which convert various types to strings,
  51  * but for which no more specific module applies.
  52  */
  53
  54 struct     e_in6_addr;
  55
  56 /* !!Deprecated!! - use ep_address_to_str() */
  57 #define address_to_str ep_address_to_str
  58 extern gchar*   ep_address_to_str(const address *);
  59 extern gchar*   se_address_to_str(const address *);
  60 extern void     address_to_str_buf(const address *addr, gchar *buf, int buf_len);
  61 extern gchar*   bytestring_to_str(const guint8 *, guint32, char);
  62 extern gchar*   ether_to_str(const guint8 *);
  63 extern const gchar*     ip_to_str(const guint8 *);
  64 extern void     ip_to_str_buf(const guint8 *ad, gchar *buf, int buf_len);
  65 extern gchar*   fc_to_str(const guint8 *);
  66 extern gchar*   fcwwn_to_str (const guint8 *);
  67 extern gchar*   ip6_to_str(const struct e_in6_addr *);
  68 extern void     ip6_to_str_buf(const struct e_in6_addr *, gchar *);
  69 extern gchar*   ipx_addr_to_str(guint32, const guint8 *);
  70 extern gchar*   ipxnet_to_string(const guint8 *ad);
  71 extern gchar*   ipxnet_to_str_punct(const guint32 ad, char punct);
  72 extern gchar*   vines_addr_to_str(const guint8 *addrp);
  73 extern void     vines_addr_to_str_buf(const guint8 *addrp, gchar *buf, int buf_len);
  74 extern gchar*   time_secs_to_str(gint32);
  75 extern gchar*   time_secs_to_str_unsigned(guint32);
  76 extern gchar*   time_msecs_to_str(gint32);
  77 extern gchar*   abs_time_to_str(nstime_t*);
  78 extern gchar*   abs_time_secs_to_str(time_t);
  79 extern void     display_signed_time(gchar *, int, gint32, gint32, time_res_t);
  80 extern void     display_epoch_time(gchar *, int, time_t,  gint32, time_res_t);
  81
  82 extern gchar*   rel_time_to_str(nstime_t*);
  83 extern gchar*   rel_time_to_secs_str(nstime_t*);
  84 extern gchar*   guid_to_str(const e_guid_t*);
  85 extern gchar*   guid_to_str_buf(const e_guid_t*, gchar*, int);
  86
  87 void tipc_addr_to_str_buf( const guint8 *data, gchar *buf, int buf_len);
  88
  89 extern char *decode_bits_in_field(gint bit_offset, gint no_of_bits, guint64 value);
  90
  91 extern char     *other_decode_bitfield_value(char *buf, guint32 val, guint32 mask,
  92     int width);
  93 extern char     *decode_bitfield_value(char *buf, guint32 val, guint32 mask,
  94     int width);
  95 extern const char *decode_boolean_bitfield(guint32 val, guint32 mask, int width,
  96   const char *truedesc, const char *falsedesc);
  97 extern const char *decode_numeric_bitfield(guint32 val, guint32 mask, int width,
  98   const char *fmt);
  99
 100 #endif /* __TO_STR_H__  */