[GNUnet-SVN] r23732 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2012-09-09 21:01:49 +0200 (Sun, 09 Sep 2012)
New Revision: 23732

Modified:
   gnunet/src/include/gnunet_strings_lib.h
Log:
-fixes

Modified: gnunet/src/include/gnunet_strings_lib.h
===================================================================
--- gnunet/src/include/gnunet_strings_lib.h     2012-09-09 18:37:05 UTC (rev 
23731)
+++ gnunet/src/include/gnunet_strings_lib.h     2012-09-09 19:01:49 UTC (rev 
23732)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff 
(and other contributing authors)
+     (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2012 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
@@ -108,8 +108,10 @@
  */
 char *
 GNUNET_STRINGS_conv (const char *input, size_t len,
-    const char *input_charset, const char *output_charset);
+                    const char *input_charset,
+                    const char *output_charset);
 
+
 /**
  * Convert the len characters long character sequence
  * given in input that is in the given charset
@@ -121,8 +123,11 @@
  * @return the converted string (0-terminated)
  */
 char *
-GNUNET_STRINGS_to_utf8 (const char *input, size_t len, const char *charset);
+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.
@@ -132,8 +137,11 @@
  *  string is returned.
  */
 char *
-GNUNET_STRINGS_from_utf8 (const char *input, size_t len, const char *charset);
+GNUNET_STRINGS_from_utf8 (const char *input, 
+                         size_t len, 
+                         const char *charset);
 
+
 /**
  * Convert the utf-8 input string to lowercase
  * Output needs to be allocated appropriately
@@ -142,7 +150,8 @@
  * @param output output buffer
  */
 void
-GNUNET_STRINGS_utf8_tolower(const char* input, char** output);
+GNUNET_STRINGS_utf8_tolower (const char* input, 
+                            char** output);
 
 
 /**
@@ -153,7 +162,8 @@
  * @param output output buffer
  */
 void
-GNUNET_STRINGS_utf8_toupper(const char* input, char** output);
+GNUNET_STRINGS_utf8_toupper (const char* input,
+                            char** output);
 
 
 /**
@@ -169,16 +179,14 @@
 
 
 /**
- * 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").
+ * 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.
+ * 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
@@ -190,15 +198,16 @@
  *         (or number of bytes that would have been written)
  */
 size_t
-GNUNET_STRINGS_buffer_fill (char *buffer, size_t size, unsigned int count, 
...);
+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.
+ * 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
@@ -232,6 +241,7 @@
 char *
 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta);
 
+
 /**
  * "man basename"
  * Returns a pointer to a part of filename (allocates nothing)!
@@ -263,8 +273,10 @@
  * @return pointer to the next byte in 'out' or NULL on error.
  */
 char *
-GNUNET_STRINGS_data_to_string (const unsigned char *data, size_t size,
-                              char *out, size_t out_size);
+GNUNET_STRINGS_data_to_string (const unsigned char *data, 
+                              size_t size,
+                              char *out, 
+                              size_t out_size);
 
 
 /**
@@ -278,25 +290,12 @@
  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
  */
 int
-GNUNET_STRINGS_string_to_data (const char *enc, size_t enclen,
-                              unsigned char *out, size_t out_size);
+GNUNET_STRINGS_string_to_data (const char *enc, 
+                              size_t enclen,
+                              unsigned char *out, 
+                              size_t out_size);
 
 
-#if 0                           /* keep Emacsens' auto-indent happy */
-{
-#endif
-#ifdef __cplusplus
-}
-#endif
-
-enum GNUNET_STRINGS_FilenameCheck
-{
-  GNUNET_STRINGS_CHECK_EXISTS = 0x00000001,
-  GNUNET_STRINGS_CHECK_IS_DIRECTORY = 0x00000002,
-  GNUNET_STRINGS_CHECK_IS_LINK = 0x00000004,
-  GNUNET_STRINGS_CHECK_IS_ABSOLUTE = 0x00000008
-};
-
 /**
  * Parse a path that might be an URI.
  *
@@ -314,8 +313,9 @@
  *         (if they weren't NULL).
  */
 int
-GNUNET_STRINGS_parse_uri (const char *path, char **scheme_part,
-    const char **path_part);
+GNUNET_STRINGS_parse_uri (const char *path, 
+                         char **scheme_part,
+                         const char **path_part);
 
 
 /**
@@ -340,7 +340,35 @@
 
 
 /**
- * Perform checks on 'filename;
+ * Flags for what we should check a file for.
+ */
+enum GNUNET_STRINGS_FilenameCheck
+{
+  /**
+   * Check that it exists.
+   */
+  GNUNET_STRINGS_CHECK_EXISTS = 0x00000001,
+
+  /**
+   * Check that it is a directory.
+   */
+  GNUNET_STRINGS_CHECK_IS_DIRECTORY = 0x00000002,
+
+  /**
+   * Check that it is a link.
+   */
+  GNUNET_STRINGS_CHECK_IS_LINK = 0x00000004,
+
+  /**
+   * Check that the path is an absolute path.
+   */ 
+  GNUNET_STRINGS_CHECK_IS_ABSOLUTE = 0x00000008
+};
+
+
+/**
+ * Perform checks on 'filename'.  FIXME: some duplication with
+ * "GNUNET_DISK_"-APIs.  We should unify those.
  * 
  * @param filename file to check
  * @param checks checks to perform
@@ -417,9 +445,20 @@
  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
  */
 int
-GNUNET_STRINGS_get_utf8_args (int argc, char *const *argv, int *u8argc,
+GNUNET_STRINGS_get_utf8_args (int argc, 
+                             char *const *argv, 
+                             int *u8argc,
                               char *const **u8argv);
 
+
+#if 0                           /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+
 /* ifndef GNUNET_UTIL_STRING_H */
 #endif
 /* end of gnunet_util_string.h */