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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*
This file is part of GNUnet.
(C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
GNUnet 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, or (at your
option) any later version.
GNUnet 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 GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file include/gnunet_strings_lib.h
* @brief strings and string handling functions (including malloc
* and string tokenizing)
*
* @author Christian Grothoff
* @author Krista Bennett
* @author Gerd Knorr <kraxel@bytesex.org>
* @author Ioana Patrascu
* @author Tzvetan Horozov
*/
#ifndef GNUNET_STRINGS_LIB_H
#define GNUNET_STRINGS_LIB_H
/* we need size_t, and since it can be both unsigned int
or unsigned long long, this IS platform dependent;
but "stdlib.h" should be portable 'enough' to be
unconditionally available... */
#include <stdlib.h>
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_time_lib.h"
/**
* Convert a given fancy human-readable size to bytes.
*
* @param fancy_size human readable string (i.e. 1 MB)
* @param size set to the size in bytes
* @return GNUNET_OK on success, GNUNET_SYSERR on error
*/
int
GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
unsigned long long *size);
/**
* Convert a given fancy human-readable time to our internal
* representation.
*
* @param fancy_size human readable string (i.e. 1 minute)
* @param rtime set to the relative time
* @return GNUNET_OK on success, GNUNET_SYSERR on error
*/
int
GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_size,
struct GNUNET_TIME_Relative *rtime);
/**
* Convert a given filesize into a fancy human-readable format.
*
* @param size number of bytes
* @return fancy representation of the size (possibly rounded) for humans
*/
char *
GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
/**
* Convert the len characters long character sequence
* given in input that is in the given input charset
* to a string in given output charset.
* @return the converted string (0-terminated),
* if conversion fails, a copy of the orignal
* string is returned.
*/
char *
GNUNET_STRINGS_conv (const char *input, size_t len,
const char *input_charset, const char *output_charset);
/**
* Convert the len characters long character sequence
* given in input that is in the given charset
* to UTF-8.
*
* @param input the input string (not necessarily 0-terminated)
* @param len the number of bytes in the input
* @param charset character set to convert from
* @return the converted string (0-terminated)
*/
char *
GNUNET_STRINGS_to_utf8 (const char *input, size_t len, const char *charset);
/**
* Convert the len bytes-long UTF-8 string
* given in input to the given charset.
* @return the converted string (0-terminated),
* if conversion fails, a copy of the orignal
* string is returned.
*/
char *
GNUNET_STRINGS_from_utf8 (const char *input, size_t len, const char *charset);
/**
* Complete filename (a la shell) from abbrevition.
*
* @param fil the name of the file, may contain ~/ or
* be relative to the current directory
* @return the full file name,
* NULL is returned on error
*/
char *
GNUNET_STRINGS_filename_expand (const char *fil);
/**
* Fill a buffer of the given size with
* count 0-terminated strings (given as varargs).
* If "buffer" is NULL, only compute the amount of
* space required (sum of "strlen(arg)+1").
*
* Unlike using "snprintf" with "%s", this function
* will add 0-terminators after each string. The
* "GNUNET_string_buffer_tokenize" function can be
* used to parse the buffer back into individual
* strings.
*
* @param buffer the buffer to fill with strings, can
* be NULL in which case only the necessary
* amount of space will be calculated
* @param size number of bytes available in buffer
* @param count number of strings that follow
* @param ... count 0-terminated strings to copy to buffer
* @return number of bytes written to the buffer
* (or number of bytes that would have been written)
*/
size_t
GNUNET_STRINGS_buffer_fill (char *buffer, size_t size, unsigned int count, ...);
/**
* Given a buffer of a given size, find "count"
* 0-terminated strings in the buffer and assign
* the count (varargs) of type "const char**" to the
* locations of the respective strings in the
* buffer.
*
* @param buffer the buffer to parse
* @param size size of the buffer
* @param count number of strings to locate
* @param ... pointers to where to store the strings
* @return offset of the character after the last 0-termination
* in the buffer, or 0 on error.
*/
unsigned int
GNUNET_STRINGS_buffer_tokenize (const char *buffer, size_t size,
unsigned int count, ...);
/**
* "man ctime_r", except for GNUnet time; also, unlike ctime, the
* return value does not include the newline character.
*
* @param t the absolute time to convert
* @return timestamp in human-readable form
*/
char *
GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
/**
* Give relative time in human-readable fancy format.
*
* @param delta time in milli seconds
* @return string in human-readable form
*/
char *
GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta);
/**
* "man basename"
* Returns a pointer to a part of filename (allocates nothing)!
*
* @param filename filename to extract basename from
* @return short (base) name of the file (that is, everything following the
* last directory separator in filename. If filename ends with a
* directory separator, the result will be a zero-length string.
* If filename has no directory separators, the result is filename
* itself.
*/
const char *
GNUNET_STRINGS_get_short_name (const char *filename);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_UTIL_STRING_H */
#endif
/* end of gnunet_util_string.h */
|
