src/include/gnunet_strings_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file include/gnunet_strings_lib.h
  23  * @brief strings and string handling functions (including malloc
  24  *        and string tokenizing)
  25  *
  26  * @author Christian Grothoff
  27  * @author Krista Bennett
  28  * @author Gerd Knorr <kraxel@bytesex.org>
  29  * @author Ioana Patrascu
  30  * @author Tzvetan Horozov
  31  */
  32
  33 #ifndef GNUNET_STRINGS_LIB_H
  34 #define GNUNET_STRINGS_LIB_H
  35
  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... */
  40 #include <stdlib.h>
  41
  42 #ifdef __cplusplus
  43 extern "C"
  44 {
  45 #if 0                           /* keep Emacsens' auto-indent happy */
  46 }
  47 #endif
  48 #endif
  49
  50 #include "gnunet_time_lib.h"
  51
  52
  53 /**
  54  * Convert a given fancy human-readable size to bytes.
  55  *
  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
  59  */
  60 int
  61 GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
  62                                     unsigned long long *size);
  63
  64
  65 /**
  66  * Convert a given fancy human-readable time to our internal
  67  * representation.
  68  *
  69  * @param fancy_size 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
  72  */
  73 int
  74 GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_size,
  75                                        struct GNUNET_TIME_Relative *rtime);
  76
  77
  78 /**
  79  * Convert a given filesize into a fancy human-readable format.
  80  *
  81  * @param size number of bytes
  82  * @return fancy representation of the size (possibly rounded) for humans
  83  */
  84 char *
  85 GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
  86
  87
  88 /**
  89  * Convert the len characters long character sequence
  90  * given in input that is in the given input charset
  91  * to a string in given output charset.
  92  * @return the converted string (0-terminated),
  93  *  if conversion fails, a copy of the orignal
  94  *  string is returned.
  95  */
  96 char *
  97 GNUNET_STRINGS_conv (const char *input, size_t len,
  98     const char *input_charset, const char *output_charset);
  99
 100 /**
 101  * Convert the len characters long character sequence
 102  * given in input that is in the given charset
 103  * to UTF-8.
 104  *
 105  * @param input the input string (not necessarily 0-terminated)
 106  * @param len the number of bytes in the input
 107  * @param charset character set to convert from
 108  * @return the converted string (0-terminated)
 109  */
 110 char *
 111 GNUNET_STRINGS_to_utf8 (const char *input, size_t len, const char *charset);
 112
 113 /**
 114  * Convert the len bytes-long UTF-8 string
 115  * given in input to the given charset.
 116
 117  * @return the converted string (0-terminated),
 118  *  if conversion fails, a copy of the orignal
 119  *  string is returned.
 120  */
 121 char *
 122 GNUNET_STRINGS_from_utf8 (const char *input, size_t len, const char *charset);
 123
 124
 125 /**
 126  * Complete filename (a la shell) from abbrevition.
 127  *
 128  * @param fil the name of the file, may contain ~/ or
 129  *        be relative to the current directory
 130  * @return the full file name,
 131  *          NULL is returned on error
 132  */
 133 char *
 134 GNUNET_STRINGS_filename_expand (const char *fil);
 135
 136
 137 /**
 138  * Fill a buffer of the given size with
 139  * count 0-terminated strings (given as varargs).
 140  * If "buffer" is NULL, only compute the amount of
 141  * space required (sum of "strlen(arg)+1").
 142  *
 143  * Unlike using "snprintf" with "%s", this function
 144  * will add 0-terminators after each string.  The
 145  * "GNUNET_string_buffer_tokenize" function can be
 146  * used to parse the buffer back into individual
 147  * strings.
 148  *
 149  * @param buffer the buffer to fill with strings, can
 150  *               be NULL in which case only the necessary
 151  *               amount of space will be calculated
 152  * @param size number of bytes available in buffer
 153  * @param count number of strings that follow
 154  * @param ... count 0-terminated strings to copy to buffer
 155  * @return number of bytes written to the buffer
 156  *         (or number of bytes that would have been written)
 157  */
 158 size_t
 159 GNUNET_STRINGS_buffer_fill (char *buffer, size_t size, unsigned int count, ...);
 160
 161
 162 /**
 163  * Given a buffer of a given size, find "count"
 164  * 0-terminated strings in the buffer and assign
 165  * the count (varargs) of type "const char**" to the
 166  * locations of the respective strings in the
 167  * buffer.
 168  *
 169  * @param buffer the buffer to parse
 170  * @param size size of the buffer
 171  * @param count number of strings to locate
 172  * @param ... pointers to where to store the strings
 173  * @return offset of the character after the last 0-termination
 174  *         in the buffer, or 0 on error.
 175  */
 176 unsigned int
 177 GNUNET_STRINGS_buffer_tokenize (const char *buffer, size_t size,
 178                                 unsigned int count, ...);
 179
 180
 181
 182 /**
 183  * "man ctime_r", except for GNUnet time; also, unlike ctime, the
 184  * return value does not include the newline character.
 185  *
 186  * @param t the absolute time to convert
 187  * @return timestamp in human-readable form
 188  */
 189 char *
 190 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
 191
 192
 193 /**
 194  * Give relative time in human-readable fancy format.
 195  *
 196  * @param delta time in milli seconds
 197  * @return string in human-readable form
 198  */
 199 char *
 200 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta);
 201
 202 /**
 203  * "man basename"
 204  * Returns a pointer to a part of filename (allocates nothing)!
 205  *
 206  * @param filename filename to extract basename from
 207  * @return short (base) name of the file (that is, everything following the
 208  *         last directory separator in filename. If filename ends with a
 209  *         directory separator, the result will be a zero-length string.
 210  *         If filename has no directory separators, the result is filename
 211  *         itself.
 212  */
 213 const char *
 214 GNUNET_STRINGS_get_short_name (const char *filename);
 215
 216
 217 /**
 218  * Convert binary data to ASCII encoding.  The ASCII encoding is rather
 219  * GNUnet specific.  It was chosen such that it only uses characters
 220  * in [0-9A-V], can be produced without complex arithmetics and uses a
 221  * small number of characters.  The GNUnet encoding uses 103 characters.
 222  * Does not append 0-terminator, but returns a pointer to the place where
 223  * it should be placed, if needed.
 224  *
 225  * @param data data to encode
 226  * @param size size of data (in bytes)
 227  * @param out buffer to fill
 228  * @param out_size size of the buffer. Must be large enough to hold
 229  * ((size*8) + (((size*8) % 5) > 0 ? 5 - ((size*8) % 5) : 0)) / 5
 230  * @return pointer to the next byte in 'out' or NULL on error.
 231  */
 232 char *
 233 GNUNET_STRINGS_data_to_string (unsigned char *data, size_t size,
 234                               char *out, size_t out_size);
 235
 236
 237 /**
 238  * Convert ASCII encoding back to data
 239  * out_size must match exactly the size of the data before it was encoded.
 240  *
 241  * @param enc the encoding
 242  * @param enclen number of characters in 'enc' (without 0-terminator, which can be missing)
 243  * @param out location where to store the decoded data
 244  * @param out_size sizeof the output buffer
 245  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 246  */
 247 int
 248 GNUNET_STRINGS_string_to_data (const char *enc, size_t enclen,
 249                               unsigned char *out, size_t out_size);
 250
 251
 252 #if 0                           /* keep Emacsens' auto-indent happy */
 253 {
 254 #endif
 255 #ifdef __cplusplus
 256 }
 257 #endif
 258
 259 enum GNUNET_STRINGS_FilenameCheck
 260 {
 261   GNUNET_STRINGS_CHECK_EXISTS = 0x00000001,
 262   GNUNET_STRINGS_CHECK_IS_DIRECTORY = 0x00000002,
 263   GNUNET_STRINGS_CHECK_IS_LINK = 0x00000004,
 264   GNUNET_STRINGS_CHECK_IS_ABSOLUTE = 0x00000008
 265 };
 266
 267 /**
 268  * Parse a path that might be an URI.
 269  *
 270  * @param path path to parse. Must be NULL-terminated.
 271  * @param scheme_part a pointer to 'char *' where a pointer to a string that
 272  *        represents the URI scheme will be stored. Can be NULL. The string is
 273  *        allocated by the function, and should be freed by GNUNET_free() when
 274  *        it is no longer needed.
 275  * @param path_part a pointer to 'const char *' where a pointer to the path
 276  *        part of the URI will be stored. Can be NULL. Points to the same block
 277  *        of memory as 'path', and thus must not be freed. Might point to '\0',
 278  *        if path part is zero-length.
 279  * @return GNUNET_YES if it's an URI, GNUNET_NO otherwise. If 'path' is not
 280  *         an URI, '* scheme_part' and '*path_part' will remain unchanged
 281  *         (if they weren't NULL).
 282  */
 283 int
 284 GNUNET_STRINGS_parse_uri (const char *path, char **scheme_part,
 285     const char **path_part);
 286
 287 /**
 288  * Check whether @filename is absolute or not, and if it's an URI
 289  *
 290  * @param filename filename to check
 291  * @param can_be_uri GNUNET_YES to check for being URI, GNUNET_NO - to
 292  *        assume it's not URI
 293  * @param r_is_uri a pointer to an int that is set to GNUNET_YES if @filename
 294  *        is URI and to GNUNET_NO otherwise. Can be NULL. If @can_be_uri is
 295  *        not GNUNET_YES, *r_is_uri is set to GNUNET_NO.
 296  * @param r_uri a pointer to a char * that is set to a pointer to URI scheme.
 297  *        The string is allocated by the function, and should be freed with
 298  *        GNUNET_free (). Can be NULL.
 299  * @return GNUNET_YES if @filaneme is absolute, GNUNET_NO otherwise.
 300  */
 301 int
 302 GNUNET_STRINGS_path_is_absolute (const char *filename, int can_be_uri,
 303     int *r_is_uri, char **r_uri_scheme);
 304
 305 /**
 306  * Perform @checks on @filename
 307  *
 308  * @param filename file to check
 309  * @param checks checks to perform
 310  * @return GNUNET_YES if all @checks pass, GNUNET_NO if at least one of them
 311  *         fails, GNUNET_SYSERR when a check can't be performed
 312  */
 313 int
 314 GNUNET_STRINGS_check_filename (const char *filename,
 315     enum GNUNET_STRINGS_FilenameCheck checks);
 316
 317
 318 /* ifndef GNUNET_UTIL_STRING_H */
 319 #endif
 320 /* end of gnunet_util_string.h */