2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 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 2, 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 filesize into a fancy human-readable format.
56 char *GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
59 * Convert the len characters long character sequence
60 * given in input that is in the given charset
63 * @return the converted string (0-terminated)
65 char *GNUNET_STRINGS_to_utf8 (const char *input,
66 size_t len, const char *charset);
69 * Complete filename (a la shell) from abbrevition.
71 * @param fil the name of the file, may contain ~/ or
72 * be relative to the current directory
73 * @returns the full file name,
74 * NULL is returned on error
76 char *GNUNET_STRINGS_filename_expand (const char *fil);
79 * Fill a buffer of the given size with
80 * count 0-terminated strings (given as varargs).
81 * If "buffer" is NULL, only compute the amount of
82 * space required (sum of "strlen(arg)+1").
84 * Unlike using "snprintf" with "%s", this function
85 * will add 0-terminators after each string. The
86 * "GNUNET_string_buffer_tokenize" function can be
87 * used to parse the buffer back into individual
90 * @return number of bytes written to the buffer
91 * (or number of bytes that would have been written)
93 unsigned int GNUNET_STRINGS_buffer_fill (char *buffer,
95 unsigned int count, ...);
98 * Given a buffer of a given size, find "count"
99 * 0-terminated strings in the buffer and assign
100 * the count (varargs) of type "const char**" to the
101 * locations of the respective strings in the
104 * @param buffer the buffer to parse
105 * @param size size of the buffer
106 * @param count number of strings to locate
107 * @return offset of the character after the last 0-termination
108 * in the buffer, or 0 on error.
110 unsigned int GNUNET_STRINGS_buffer_tokenize (const char *buffer,
112 unsigned int count, ...);
117 * "man ctime_r", except for GNUnet time; also, unlike ctime, the
118 * return value does not include the newline character.
120 char *GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
124 * Give relative time in human-readable fancy format.
125 * @param delta time in milli seconds
127 char *GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative
129 #if 0 /* keep Emacsens' auto-indent happy */
137 /* ifndef GNUNET_UTIL_STRING_H */
139 /* end of gnunet_util_string.h */