X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b752e4c0bf35563ab1cae8af2940258327f1d415..4d6fd2c990da1abfa2eee1cf0427f0cf53913ad6:/include/xbt/str.h

diff --git a/include/xbt/str.h b/include/xbt/str.h
index 36c4bdc54c..14ed93222c 100644
--- a/include/xbt/str.h
+++ b/include/xbt/str.h
@@ -8,27 +8,50 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "xbt/misc.h"
-#include "xbt/dynar.h"
-
-
-
 #ifndef XBT_STR_H
 #define XBT_STR_H
 
-#if defined(_WIN32)
-#include <stdio.h>
-#endif
+#include <stdarg.h> /* va_* */
+#include "xbt/misc.h"
+#include "xbt/dynar.h"
+#include "xbt/dict.h"
+#include <stdio.h> /* FILE for getline */
 
 SG_BEGIN_DECL()
 
+/** @addtogroup XBT_str
+ *  @brief String manipulation functions
+ *
+ * This module defines several string related functions. We redefine some quite classical
+ * functions on the platforms were they are not nativaly defined (such as getline() or
+ * asprintf()), while some other are a bit more exotic.
+ * @{
+ */
+
 /* snprintf related functions */
+/** @brief print to allocated string (reimplemented when not provided by the system)
+ *
+ * The functions asprintf() and vasprintf() are analogues of
+ * sprintf() and vsprintf(), except that they allocate a string large
+ * enough to hold the output including the terminating null byte, and
+ * return a pointer to it via the first parameter.  This pointer
+ * should be passed to free(3) to release the allocated storage when
+ * it is no longer needed.
+ */
 XBT_PUBLIC(int) asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
+/** @brief print to allocated string (reimplemented when not provided by the system)
+ *
+ * See asprintf()
+ */
 XBT_PUBLIC(int) vasprintf (char **ptr, const char *fmt, va_list ap);
+/** @brief print to allocated string
+ *
+ * Works just like asprintf(), but returns a pointer to the newly created string
+ */
 XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
 
 /* the gettext function. It gets redefined here only if not yet available */
-#if defined(_WIN32) || !defined(__GNUC__)
+#if !defined(__USE_GNU) || defined(DOXYGEN)
 XBT_PUBLIC(long) getline(char **lineptr, size_t *n, FILE *stream);
 #endif
 
@@ -37,13 +60,28 @@ XBT_PUBLIC(void) xbt_str_rtrim(char* s, const char* char_list);
 XBT_PUBLIC(void) xbt_str_ltrim( char* s, const char* char_list);
 XBT_PUBLIC(void) xbt_str_trim(char* s, const char* char_list);
 
-XBT_PUBLIC(xbt_dynar_t) xbt_str_split(char *s, const char *sep);
+XBT_PUBLIC(xbt_dynar_t) xbt_str_split(const char *s, const char *sep);
+XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted(const char *s);
+XBT_PUBLIC(xbt_dynar_t) xbt_str_split_str(const char *s, const char *sep);
+
 XBT_PUBLIC(char *) xbt_str_join(xbt_dynar_t dynar, const char *sep);
 
+/* */
+XBT_PUBLIC(void) xbt_str_subst(char *str, char from, char to, int amount);
+XBT_PUBLIC(char *)xbt_str_varsubst(char *str, xbt_dict_t patterns);
+
 /* */
 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
 XBT_PUBLIC(char *) xbt_str_diff(char *a, char *b);
 
+/** @brief Classical alias to (char*)
+ *
+ * This of almost no use, beside cosmetics and the GRAS parsing macro (see \ref GRAS_dd_auto).
+ */
+typedef char *xbt_string_t;
+
+/**@}*/
+
 SG_END_DECL()
 
 #endif /* XBT_STR_H */