2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2012 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_strings_lib.h
23 * @brief strings and string handling functions (including malloc
24 * and string tokenizing)
26 * @author Christian Grothoff
27 * @author Krista Bennett
28 * @author Gerd Knorr <kraxel@bytesex.org>
29 * @author Ioana Patrascu
30 * @author Tzvetan Horozov
33 #ifndef GNUNET_STRINGS_LIB_H
34 #define GNUNET_STRINGS_LIB_H
36 /* we need size_t, and since it can be both unsigned int
37 or unsigned long long, this IS platform dependent;
38 but "stdlib.h" should be portable 'enough' to be
39 unconditionally available... */
45 #if 0 /* keep Emacsens' auto-indent happy */
50 #include "gnunet_time_lib.h"
54 * Convert a given fancy human-readable size to bytes.
56 * @param fancy_size human readable string (i.e. 1 MB)
57 * @param size set to the size in bytes
58 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
61 GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
62 unsigned long long *size);
66 * Convert a given fancy human-readable time to our internal
69 * @param fancy_time human readable string (i.e. 1 minute)
70 * @param rtime set to the relative time
71 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
74 GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time,
75 struct GNUNET_TIME_Relative *rtime);
80 * Convert a given fancy human-readable time to our internal
81 * representation. The human-readable time is expected to be
82 * in local time, whereas the returned value will be in UTC.
84 * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S)
85 * @param atime set to the absolute time
86 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
89 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
90 struct GNUNET_TIME_Absolute *atime);
94 * Convert a given filesize into a fancy human-readable format.
96 * @param size number of bytes
97 * @return fancy representation of the size (possibly rounded) for humans
100 GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
104 * Convert the len characters long character sequence
105 * given in input that is in the given input charset
106 * to a string in given output charset.
108 * @param input input string
109 * @param len number of bytes in @a input
110 * @param input_charset character set used for @a input
111 * @param ouptut_charset desired character set for the return value
112 * @return the converted string (0-terminated),
113 * if conversion fails, a copy of the orignal
114 * string is returned.
117 GNUNET_STRINGS_conv (const char *input, size_t len,
118 const char *input_charset,
119 const char *output_charset);
123 * Convert the len characters long character sequence
124 * given in input that is in the given charset
127 * @param input the input string (not necessarily 0-terminated)
128 * @param len the number of bytes in the @a input
129 * @param charset character set to convert from
130 * @return the converted string (0-terminated)
133 GNUNET_STRINGS_to_utf8 (const char *input,
135 const char *charset);
139 * Convert the len bytes-long UTF-8 string
140 * given in input to the given charset.
142 * @param input the input string (not necessarily 0-terminated)
143 * @param len the number of bytes in the @a input
144 * @param charset character set to convert to
145 * @return the converted string (0-terminated),
146 * if conversion fails, a copy of the orignal
147 * string is returned.
150 GNUNET_STRINGS_from_utf8 (const char *input,
152 const char *charset);
156 * Convert the utf-8 input string to lowercase
157 * Output needs to be allocated appropriately
159 * @param input input string
160 * @param output output buffer
163 GNUNET_STRINGS_utf8_tolower (const char* input,
168 * Convert the utf-8 input string to lowercase
169 * Output needs to be allocated appropriately
171 * @param input input string
172 * @param output output buffer
175 GNUNET_STRINGS_utf8_toupper (const char* input,
180 * Complete filename (a la shell) from abbrevition.
182 * @param fil the name of the file, may contain ~/ or
183 * be relative to the current directory
184 * @return the full file name,
185 * NULL is returned on error
188 GNUNET_STRINGS_filename_expand (const char *fil);
192 * Fill a buffer of the given size with count 0-terminated strings
193 * (given as varargs). If "buffer" is NULL, only compute the amount
194 * of space required (sum of "strlen(arg)+1").
196 * Unlike using "snprintf" with "%s", this function will add
197 * 0-terminators after each string. The
198 * "GNUNET_string_buffer_tokenize" function can be used to parse the
199 * buffer back into individual strings.
201 * @param buffer the buffer to fill with strings, can
202 * be NULL in which case only the necessary
203 * amount of space will be calculated
204 * @param size number of bytes available in buffer
205 * @param count number of strings that follow
206 * @param ... count 0-terminated strings to copy to buffer
207 * @return number of bytes written to the buffer
208 * (or number of bytes that would have been written)
211 GNUNET_STRINGS_buffer_fill (char *buffer,
218 * Given a buffer of a given size, find "count" 0-terminated strings
219 * in the buffer and assign the count (varargs) of type "const char**"
220 * to the locations of the respective strings in the buffer.
222 * @param buffer the buffer to parse
223 * @param size size of the @a buffer
224 * @param count number of strings to locate
225 * @param ... pointers to where to store the strings
226 * @return offset of the character after the last 0-termination
227 * in the buffer, or 0 on error.
230 GNUNET_STRINGS_buffer_tokenize (const char *buffer,
232 unsigned int count, ...);
238 * Like `asctime`, except for GNUnet time. Converts a GNUnet internal
239 * absolute time (which is in UTC) to a string in local time.
240 * Note that the returned value will be overwritten if this function
243 * @param t the absolute time to convert
244 * @return timestamp in human-readable form in local time
247 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
252 * Give relative time in human-readable fancy format.
253 * This is one of the very few calls in the entire API that is
256 * @param delta time in milli seconds
257 * @param do_round are we allowed to round a bit?
258 * @return string in human-readable form
261 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
267 * Returns a pointer to a part of filename (allocates nothing)!
269 * @param filename filename to extract basename from
270 * @return short (base) name of the file (that is, everything following the
271 * last directory separator in filename. If filename ends with a
272 * directory separator, the result will be a zero-length string.
273 * If filename has no directory separators, the result is filename
277 GNUNET_STRINGS_get_short_name (const char *filename);
281 * Convert binary data to ASCII encoding. The ASCII encoding is rather
282 * GNUnet specific. It was chosen such that it only uses characters
283 * in [0-9A-V], can be produced without complex arithmetics and uses a
284 * small number of characters. The GNUnet encoding uses 103 characters.
285 * Does not append 0-terminator, but returns a pointer to the place where
286 * it should be placed, if needed.
288 * @param data data to encode
289 * @param size size of data (in bytes)
290 * @param out buffer to fill
291 * @param out_size size of the buffer. Must be large enough to hold
292 * ((size*8) + (((size*8) % 5) > 0 ? 5 - ((size*8) % 5) : 0)) / 5
293 * @return pointer to the next byte in 'out' or NULL on error.
296 GNUNET_STRINGS_data_to_string (const void *data,
303 * Convert ASCII encoding back to data
304 * out_size must match exactly the size of the data before it was encoded.
306 * @param enc the encoding
307 * @param enclen number of characters in 'enc' (without 0-terminator, which can be missing)
308 * @param out location where to store the decoded data
309 * @param out_size size of the output buffer @a out
310 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
313 GNUNET_STRINGS_string_to_data (const char *enc,
320 * Parse a path that might be an URI.
322 * @param path path to parse. Must be NULL-terminated.
323 * @param scheme_part a pointer to 'char *' where a pointer to a string that
324 * represents the URI scheme will be stored. Can be NULL. The string is
325 * allocated by the function, and should be freed by GNUNET_free() when
326 * it is no longer needed.
327 * @param path_part a pointer to 'const char *' where a pointer to the path
328 * part of the URI will be stored. Can be NULL. Points to the same block
329 * of memory as 'path', and thus must not be freed. Might point to '\0',
330 * if path part is zero-length.
331 * @return #GNUNET_YES if it's an URI, #GNUNET_NO otherwise. If 'path' is not
332 * an URI, '* scheme_part' and '*path_part' will remain unchanged
333 * (if they weren't NULL).
336 GNUNET_STRINGS_parse_uri (const char *path,
338 const char **path_part);
342 * Check whether filename is absolute or not, and if it's an URI
344 * @param filename filename to check
345 * @param can_be_uri #GNUNET_YES to check for being URI, #GNUNET_NO - to
346 * assume it's not URI
347 * @param r_is_uri a pointer to an int that is set to #GNUNET_YES if 'filename'
348 * is URI and to GNUNET_NO otherwise. Can be NULL. If 'can_be_uri' is
349 * not #GNUNET_YES, *r_is_uri is set to #GNUNET_NO.
350 * @param r_uri_scheme a pointer to a char * that is set to a pointer to URI scheme.
351 * The string is allocated by the function, and should be freed with
352 * GNUNET_free (). Can be NULL.
353 * @return #GNUNET_YES if 'filename' is absolute, #GNUNET_NO otherwise.
356 GNUNET_STRINGS_path_is_absolute (const char *filename,
359 char **r_uri_scheme);
363 * Flags for what we should check a file for.
365 enum GNUNET_STRINGS_FilenameCheck
368 * Check that it exists.
370 GNUNET_STRINGS_CHECK_EXISTS = 0x00000001,
373 * Check that it is a directory.
375 GNUNET_STRINGS_CHECK_IS_DIRECTORY = 0x00000002,
378 * Check that it is a link.
380 GNUNET_STRINGS_CHECK_IS_LINK = 0x00000004,
383 * Check that the path is an absolute path.
385 GNUNET_STRINGS_CHECK_IS_ABSOLUTE = 0x00000008
390 * Perform checks on @a filename. FIXME: some duplication with
391 * "GNUNET_DISK_"-APIs. We should unify those.
393 * @param filename file to check
394 * @param checks checks to perform
395 * @return GNUNET_YES if all checks pass, GNUNET_NO if at least one of them
396 * fails, GNUNET_SYSERR when a check can't be performed
399 GNUNET_STRINGS_check_filename (const char *filename,
400 enum GNUNET_STRINGS_FilenameCheck checks);
404 * Tries to convert @a zt_addr string to an IPv6 address.
405 * The string is expected to have the format "[ABCD::01]:80".
407 * @param zt_addr 0-terminated string. May be mangled by the function.
408 * @param addrlen length of zt_addr (not counting 0-terminator).
409 * @param r_buf a buffer to fill. Initially gets filled with zeroes,
410 * then its sin6_port, sin6_family and sin6_addr are set appropriately.
411 * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which
412 * case the contents of r_buf are undefined.
415 GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
417 struct sockaddr_in6 *r_buf);
421 * Tries to convert @a zt_addr string to an IPv4 address.
422 * The string is expected to have the format "1.2.3.4:80".
424 * @param zt_addr 0-terminated string. May be mangled by the function.
425 * @param addrlen length of zt_addr (not counting 0-terminator).
426 * @param r_buf a buffer to fill.
427 * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which case
428 * the contents of r_buf are undefined.
431 GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr,
433 struct sockaddr_in *r_buf);
437 * Tries to convert @a addr string to an IP (v4 or v6) address.
438 * Will automatically decide whether to treat 'addr' as v4 or v6 address.
440 * @param addr a string, may not be 0-terminated.
441 * @param addrlen number of bytes in @a addr (if addr is 0-terminated,
442 * 0-terminator should not be counted towards addrlen).
443 * @param r_buf a buffer to fill.
444 * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which
445 * case the contents of r_buf are undefined.
448 GNUNET_STRINGS_to_address_ip (const char *addr,
450 struct sockaddr_storage *r_buf);
454 * Returns utf-8 encoded arguments. Does nothing (returns a copy of
455 * @a argc and @a argv) on any platform other than W32. Returned @a
456 * argv has `u8argv[u8argc] == NULL`. Returned @a argv is a single
457 * memory block, and can be freed with a single GNUNET_free() call.
459 * @param argc argc (as given by main())
460 * @param argv argv (as given by main())
461 * @param u8argc a location to store new argc in (though it's th same as argc)
462 * @param u8argv a location to store new argv in
463 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
466 GNUNET_STRINGS_get_utf8_args (int argc,
469 char *const **u8argv);
472 #if 0 /* keep Emacsens' auto-indent happy */
480 /* ifndef GNUNET_UTIL_STRING_H */
482 /* end of gnunet_util_string.h */