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
|
/* strutil.h
* String utility definitions
*
* $Id$
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __STRUTIL_H__
#define __STRUTIL_H__
/* ... thus, config.h needs to be #included */
/** @file
* String handling and conversion utilities.
*/
/** Given a pointer into a data buffer, and to the end of the buffer,
* find the end of the (putative) line at that position in the data
* buffer.
*
* @param data A pointer to the beginning of the data
* @param dataend A pointer to the end of the data
* @param eol A pointer that will receive the EOL location
* @return A pointer to the EOL character(s) in "*eol".
*/
const guchar *find_line_end(const guchar *data, const guchar *dataend,
const guchar **eol);
/** Get the length of the next token in a line, and the beginning of the
* next token after that (if any).
* @param linep A pointer to the beginning of the line
* @param lineend A pointer to the end of the line
* @param next_token Receives the location of the next token
* @return 0 if there is no next token.
*/
int get_token_len(const guchar *linep, const guchar *lineend,
const guchar **next_token);
/** Given a string, generate a string from it that shows non-printable
* characters as C-style escapes, and return a pointer to it.
*
* @param line A pointer to the input string
* @param len The length of the input string
* @return A pointer to the formatted string
*
* @see tvb_format_text()
*/
gchar* format_text(const guchar *line, int len);
/** Turn an array of bytes into a string showing the bytes in hex.
*
* @param bd A pointer to the byte array
* @param bd_len The length of the byte array
* @return A pointer to the formatted string
*
* @see bytes_to_str_punct()
*/
gchar* bytes_to_str(const guint8 *bd, int bd_len);
/** Turn an array of bytes into a string showing the bytes in hex,
* separated by a punctuation character.
*
* @param bd A pointer to the byte array
* @param bd_len The length of the byte array
* @param punct The punctuation character
* @return A pointer to the formatted string
*
* @see bytes_to_str()
*/
gchar* bytes_to_str_punct(const guint8 *bd, int bd_len, gchar punct);
/** Turn a string of hex digits with optional separators (defined by
* is_byte_sep() into a byte array.
*
* @param hex_str The string of hex digits.
* @param bytes The GByteArray that will receive the bytes. This
* must be initialized by the caller.
* @param force_separators If set to TRUE, separators MUST exist between
* bytes.
* @return True if the string was converted successfully
*/
gboolean hex_str_to_bytes(const char *hex_str, GByteArray *bytes,
gboolean force_separators);
/** Return a XML escaped representation of the unescaped string.
* The returned string must be freed when no longer in use.
*
* @param unescaped The unescaped string
* @return An XML-escaped representation of the input string
*/
gchar* xml_escape(const gchar *unescaped);
/* Return the first occurrence of needle in haystack.
* Algorithm copied from GNU's glibc 2.3.2 memcmp()
*
* @param haystack The data to search
* @param haystack_len The length of the search data
* @param needle The string to look for
* @param needle_len The length of the search string
* @return A pointer to the first occurrence of "needle" in
* "haystack". If "needle" isn't found or is NULL, or if
* "needle_len" is 0, NULL is returned.
*/
const guint8 * epan_memmem(const guint8 *haystack, guint haystack_len,
const guint8 *needle, guint needle_len);
/* Surround a string or a macro, resolved to a string, with double quotes */
#define _STRINGIFY(a) # a
#define STRINGIFY(a) _STRINGIFY(a)
#endif /* __STRUTIL_H__ */
|
