X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/46784b142aab6e4849a92709f781a09e0a567260..784dd701843ed092f51ac04a2958e81ab0a24bb9:/include/xbt/strbuff.h

diff --git a/include/xbt/strbuff.h b/include/xbt/strbuff.h
index 4a64e9202e..41bb52e435 100644
--- a/include/xbt/strbuff.h
+++ b/include/xbt/strbuff.h
@@ -1,9 +1,7 @@
-/* $Id: buff.h 3483 2007-05-07 11:18:56Z mquinson $ */
-
 /* strbuff -- string buffers                                                */
 
-/* Copyright (c) 2007 Martin Quinson.                                       */
-/* All rights reserved.                                                     */
+/* Copyright (c) 2007-2011, 2013-2014. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* 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. */
@@ -11,26 +9,43 @@
 #ifndef XBT_STRBUFF_H
 #define XBT_STRBUFF_H
 
-#include "portable.h"
 #include "xbt/sysdep.h"
 #include "xbt/function_types.h"
 #include "xbt/log.h"
 #include "xbt/str.h"
-
-/**
- ** Buffer code
- **/
-typedef struct {
+#include "xbt/dict.h"
+
+SG_BEGIN_DECL()
+
+/** @defgroup xbt_strbuff String buffers 
+ *  @ingroup XBT_adt
+ * 
+ *  This data container is very similar to the Java StringBuffer: 
+ *  that's a string to which you can add content with a lesser performance 
+ *  penalty than if you recreate a new string from scratch. Once done building 
+ *  your string, you must retrieve the content and free its container.
+ * 
+ *  @{
+ */
+
+/** @brief Buffer data container **/
+typedef struct xbt_strbuff {
   char *data;
-  int used,size;
-} s_xbt_strbuff_t, *xbt_strbuff_t;
+  int used;
+  int size;
+} s_xbt_strbuff_t;
+typedef s_xbt_strbuff_t* xbt_strbuff_t;
 
-
-XBT_PUBLIC(void)          xbt_strbuff_empty(xbt_strbuff_t b);
+XBT_PUBLIC(void) xbt_strbuff_clear(xbt_strbuff_t b);
 XBT_PUBLIC(xbt_strbuff_t) xbt_strbuff_new(void);
-XBT_PUBLIC(void)          xbt_strbuff_free(xbt_strbuff_t b);
-XBT_PUBLIC(void)          xbt_strbuff_append(xbt_strbuff_t b, const char *toadd);
-XBT_PUBLIC(void)          xbt_strbuff_chomp(xbt_strbuff_t b);
-XBT_PUBLIC(void)          xbt_strbuff_trim(xbt_strbuff_t b);
-
+XBT_PUBLIC(xbt_strbuff_t) xbt_strbuff_new_from(const char *s);
+XBT_PUBLIC(void) xbt_strbuff_free(xbt_strbuff_t b);
+XBT_PUBLIC(void) xbt_strbuff_free_container(xbt_strbuff_t b);
+XBT_PUBLIC(void) xbt_strbuff_append(xbt_strbuff_t b, const char *toadd);
+XBT_PUBLIC(void) xbt_strbuff_printf(xbt_strbuff_t b, const char *fmt, ...);
+XBT_PUBLIC(void) xbt_strbuff_chomp(xbt_strbuff_t b);
+XBT_PUBLIC(void) xbt_strbuff_trim(xbt_strbuff_t b);
+
+/** @} */
+SG_END_DECL()
 #endif