1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/* wsutil/to_str.h
* Definitions for utilities to convert various other types to strings.
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __WSUTIL_TO_STR_H__
#define __WSUTIL_TO_STR_H__
#include <glib.h>
#include <ws_symbol_export.h>
#include <wsutil/wmem/wmem.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* bytes_to_hexstr()
*
* Output hex represetation of guint8 ad array, and return pointer after last character.
* It always output full representation (padded with 0).
*
* String is not NUL terminated by this routine.
* There needs to be at least len * 2 bytes in the buffer.
*/
WS_DLL_PUBLIC char *bytes_to_hexstr(char *out, const guint8 *ad, size_t len);
/**
* bytes_to_hexstr_punct()
*
* Output hex represetation of guint8 ad array, and return pointer after last character.
* Each byte will be separated with punct character (cannot be NUL).
* It always output full representation (padded with 0).
*
* String is not NUL terminated by this routine.
* There needs to be at least len * 3 - 1 bytes in the buffer.
*/
WS_DLL_PUBLIC char *bytes_to_hexstr_punct(char *out, const guint8 *ad, size_t len, char punct);
/* Max string length for displaying byte string. */
#define MAX_BYTE_STR_LEN 72
/** Turn an array of bytes into a string showing the bytes in hex,
* separated by a punctuation character.
*
* @param scope memory allocation scheme used
* @param ad A pointer to the byte array
* @param len The length of the byte array
* @param punct The punctuation character
* @param max Maximum string length, plus ellipsis if present
* @return A pointer to the formatted string
*
* @see bytes_to_str()
*/
WS_DLL_PUBLIC gchar *bytes_to_str_punct_max(wmem_allocator_t *scope, const guint8 *ad, size_t len, const char punct, size_t max);
#define bytes_to_str_punct(scope, ad, len, punct) bytes_to_str_punct_max(scope, ad, len, punct, MAX_BYTE_STR_LEN)
/** Turn an array of bytes into a string showing the bytes in hex.
*
* @param scope memory allocation scheme used
* @param bd A pointer to the byte array
* @param bd_len The length of the byte array
* @param max Maximum string length, plus ellipsis if present
* @return A pointer to the formatted string
*/
WS_DLL_PUBLIC char *bytes_to_str_max(wmem_allocator_t *scope, const guint8 *bd, size_t bd_len, size_t max);
#define bytes_to_str(scope, bd, len) bytes_to_str_max(scope, bd, len, MAX_BYTE_STR_LEN)
/**
* oct_to_str_back()
*
* Output guint32 octal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
*
* String is not NUL terminated by this routine.
* There needs to be at least 12 bytes in the buffer.
*/
WS_DLL_PUBLIC char *oct_to_str_back(char *ptr, guint32 value);
/**
* oct64_to_str_back()
*
* Output guint64 octal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
*
* String is not NUL terminated by this routine.
* There needs to be at least 12 bytes in the buffer.
*/
WS_DLL_PUBLIC char *oct64_to_str_back(char *ptr, guint64 value);
/**
* hex_to_str_back()
*
* Output guint32 hex representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
* This routine will output for sure (can output more) 'len' decimal characters (number padded with '0').
*
* String is not NUL terminated by this routine.
* There needs to be at least 2 + MAX(8, len) bytes in the buffer.
*/
WS_DLL_PUBLIC char *hex_to_str_back_len(char *ptr, guint32 value, int len);
/**
* hex64_to_str_back()
*
* Output guint64 hex representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
* This routine will output for sure (can output more) 'len' decimal characters (number padded with '0').
*
* String is not NUL terminated by this routine.
* There needs to be at least 2 + MAX(16, len) bytes in the buffer.
*/
WS_DLL_PUBLIC char *hex64_to_str_back_len(char *ptr, guint64 value, int len);
/**
* uint_to_str_back()
*
* Output guint32 decimal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
*
* String is not NUL terminated by this routine.
* There needs to be at least 10 bytes in the buffer.
*/
WS_DLL_PUBLIC char *uint_to_str_back(char *ptr, guint32 value);
/**
* uint64_str_back()
*
* Output guint64 decimal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
*
* String is not NUL terminated by this routine.
* There needs to be at least 20 bytes in the buffer.
*/
WS_DLL_PUBLIC char *uint64_to_str_back(char *ptr, guint64 value);
/**
* uint_to_str_back_len()
*
* Output guint32 decimal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
* This routine will output for sure (can output more) 'len' decimal characters (number padded with '0').
*
* String is not NUL terminated by this routine.
* There needs to be at least MAX(10, len) bytes in the buffer.
*/
WS_DLL_PUBLIC char *uint_to_str_back_len(char *ptr, guint32 value, int len);
/**
* uint64_to_str_back_len()
*
* Output guint64 decimal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
* This routine will output for sure (can output more) 'len' decimal characters (number padded with '0').
*
* String is not NUL terminated by this routine.
* There needs to be at least MAX(20, len) bytes in the buffer.
*/
WS_DLL_PUBLIC char *uint64_to_str_back_len(char *ptr, guint64 value, int len);
/**
* int_to_str_back()
*
* Output gint32 decimal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
*
* String is not NUL terminated by this routine.
* There needs to be at least 11 bytes in the buffer.
*/
WS_DLL_PUBLIC char *int_to_str_back(char *ptr, gint32 value);
/**
* int64_to_str_back()
*
* Output gint64 decimal representation backward (last character will be written on ptr - 1),
* and return pointer to first character.
*
* String is not NUL terminated by this routine.
* There needs to be at least 21 bytes in the buffer.
*/
WS_DLL_PUBLIC char *int64_to_str_back(char *ptr, gint64 value);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __TO_STR_H__ */
|
