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 filesize into a fancy human-readable format.
  67  *
  68  * @param size number of bytes
  69  * @return fancy representation of the size (possibly rounded) for humans
  70  */
  71 char *
  72 GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
  73
  74
  75 /**
  76  * Convert the len characters long character sequence
  77  * given in input that is in the given charset
  78  * to UTF-8.
  79  *
  80  * @param input the input string (not necessarily 0-terminated)
  81  * @param len the number of bytes in the input
  82  * @param charset character set to convert from
  83  * @return the converted string (0-terminated)
  84  */
  85 char *
  86 GNUNET_STRINGS_to_utf8 (const char *input, size_t len, const char *charset);
  87
  88
  89 /**
  90  * Complete filename (a la shell) from abbrevition.
  91  *
  92  * @param fil the name of the file, may contain ~/ or
  93  *        be relative to the current directory
  94  * @return the full file name,
  95  *          NULL is returned on error
  96  */
  97 char *
  98 GNUNET_STRINGS_filename_expand (const char *fil);
  99
 100
 101 /**
 102  * Fill a buffer of the given size with
 103  * count 0-terminated strings (given as varargs).
 104  * If "buffer" is NULL, only compute the amount of
 105  * space required (sum of "strlen(arg)+1").
 106  *
 107  * Unlike using "snprintf" with "%s", this function
 108  * will add 0-terminators after each string.  The
 109  * "GNUNET_string_buffer_tokenize" function can be
 110  * used to parse the buffer back into individual
 111  * strings.
 112  *
 113  * @param buffer the buffer to fill with strings, can
 114  *               be NULL in which case only the necessary
 115  *               amount of space will be calculated
 116  * @param size number of bytes available in buffer
 117  * @param count number of strings that follow
 118  * @param ... count 0-terminated strings to copy to buffer
 119  * @return number of bytes written to the buffer
 120  *         (or number of bytes that would have been written)
 121  */
 122 size_t
 123 GNUNET_STRINGS_buffer_fill (char *buffer, size_t size, unsigned int count, ...);
 124
 125
 126 /**
 127  * Given a buffer of a given size, find "count"
 128  * 0-terminated strings in the buffer and assign
 129  * the count (varargs) of type "const char**" to the
 130  * locations of the respective strings in the
 131  * buffer.
 132  *
 133  * @param buffer the buffer to parse
 134  * @param size size of the buffer
 135  * @param count number of strings to locate
 136  * @param ... pointers to where to store the strings
 137  * @return offset of the character after the last 0-termination
 138  *         in the buffer, or 0 on error.
 139  */
 140 unsigned int
 141 GNUNET_STRINGS_buffer_tokenize (const char *buffer, size_t size,
 142                                 unsigned int count, ...);
 143
 144
 145
 146 /**
 147  * "man ctime_r", except for GNUnet time; also, unlike ctime, the
 148  * return value does not include the newline character.
 149  *
 150  * @param t the absolute time to convert
 151  * @return timestamp in human-readable form
 152  */
 153 char *
 154 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
 155
 156
 157 /**
 158  * Give relative time in human-readable fancy format.
 159  *
 160  * @param delta time in milli seconds
 161  * @return string in human-readable form
 162  */
 163 char *
 164 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta);
 165
 166 #if 0                           /* keep Emacsens' auto-indent happy */
 167 {
 168 #endif
 169 #ifdef __cplusplus
 170 }
 171 #endif
 172
 173
 174 /* ifndef GNUNET_UTIL_STRING_H */
 175 #endif
 176 /* end of gnunet_util_string.h */