various code cleanup:
[obnox/wireshark/wip.git] / epan / to_str.h
1 /* to_str.h
2  * Definitions for utilities to convert various other types to strings.
3  *
4  * $Id$
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@ethereal.com>
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 MAX_OID_STR_LEN 256
34 #define GUID_STR_LEN 37
35
36 /*
37  * Resolution of a time stamp.
38  */
39 typedef enum {
40         MSECS,  /* milliseconds */
41         USECS,  /* microseconds */
42         NSECS   /* nanoseconds */
43 } time_res_t;
44
45 /*
46  * These are utility functions which convert various types to strings,
47  * but for which no more specific module applies.
48  */
49
50 struct     e_in6_addr;
51
52 extern gchar*   address_to_str(const address *);
53 extern void     address_to_str_buf(const address *addr, gchar *buf, int buf_len);
54 extern gchar*   ether_to_str(const guint8 *);
55 extern gchar*   ip_to_str(const guint8 *);
56 extern void     ip_to_str_buf(const guint8 *, gchar *);
57 extern gchar*   fc_to_str(const guint8 *);
58 extern gchar*   fcwwn_to_str (const guint8 *);
59 extern gchar*   ip6_to_str(const struct e_in6_addr *);
60 extern void     ip6_to_str_buf(const struct e_in6_addr *, gchar *);
61 extern gchar*   ipx_addr_to_str(guint32, const guint8 *);
62 extern gchar*   ipxnet_to_string(const guint8 *ad);
63 extern gchar*   ipxnet_to_str_punct(const guint32 ad, char punct);
64 extern gchar*   vines_addr_to_str(const guint8 *addrp);
65 extern void     vines_addr_to_str_buf(const guint8 *addrp, gchar *buf);
66 extern gchar*   time_secs_to_str(gint32);
67 extern gchar*   time_msecs_to_str(gint32);
68 extern gchar*   abs_time_to_str(nstime_t*);
69 extern gchar*   abs_time_secs_to_str(time_t);
70 extern void     display_signed_time(gchar *, int, gint32, gint32, time_res_t);
71 extern gchar*   rel_time_to_str(nstime_t*);
72 extern gchar*   rel_time_to_secs_str(nstime_t*);
73 extern gchar*   oid_to_str(const guint8*, gint);
74 extern gchar*   oid_to_str_buf(const guint8*, gint, gchar*);
75 extern gchar*   guid_to_str(const guint8*);
76 extern gchar*   guid_to_str_buf(const guint8*, gchar*);
77
78
79 extern char     *other_decode_bitfield_value(char *buf, guint32 val, guint32 mask,
80     int width);
81 extern char     *decode_bitfield_value(char *buf, guint32 val, guint32 mask,
82     int width);
83 extern const char *decode_boolean_bitfield(guint32 val, guint32 mask, int width,
84   const char *truedesc, const char *falsedesc);
85 extern const char *decode_numeric_bitfield(guint32 val, guint32 mask, int width,
86   const char *fmt);
87
88 #endif /* __TO_STR_H__  */