include/xbt/str.h

   1 /* $Id$ */
   2
   3 /* str.h - XBT string related functions.                                    */
   4
   5 /* Copyright (c) 2004-7, Martin Quinson, Arnaud Legrand and  Cherier Malek. */
   6 /* All rights reserved.                                                     */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef XBT_STR_H
  12 #define XBT_STR_H
  13
  14 #include <stdarg.h> /* va_* */
  15 #include "xbt/misc.h"
  16 #include "xbt/dynar.h"
  17 #include <stdio.h> /* FILE for getline */
  18
  19 SG_BEGIN_DECL()
  20
  21 /** @addtogroup XBT_str
  22  *  @brief String manipulation functions
  23  *
  24  * This module defines several string related functions. We redefine some quite classical
  25  * functions on the platforms were they are not nativaly defined (such as getline() or
  26  * asprintf()), while some other are a bit more exotic.
  27  * @{
  28  */
  29
  30 /* snprintf related functions */
  31 /** @brief print to allocated string (reimplemented when not provided by the system)
  32  *
  33  * The functions asprintf() and vasprintf() are analogues of
  34  * sprintf() and vsprintf(), except that they allocate a string large
  35  * enough to hold the output including the terminating null byte, and
  36  * return a pointer to it via the first parameter.  This pointer
  37  * should be passed to free(3) to release the allocated storage when
  38  * it is no longer needed.
  39  */
  40 XBT_PUBLIC(int) asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
  41 /** @brief print to allocated string (reimplemented when not provided by the system)
  42  *
  43  * See asprintf()
  44  */
  45 XBT_PUBLIC(int) vasprintf (char **ptr, const char *fmt, va_list ap);
  46 /** @brief print to allocated string
  47  *
  48  * Works just like asprintf(), but returns a pointer to the newly created string
  49  */
  50 XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
  51
  52 /* the gettext function. It gets redefined here only if not yet available */
  53 #if !defined(__USE_GNU) || defined(DOXYGEN)
  54 XBT_PUBLIC(long) getline(char **lineptr, size_t *n, FILE *stream);
  55 #endif
  56
  57 /* Trim related functions */
  58 XBT_PUBLIC(void) xbt_str_rtrim(char* s, const char* char_list);
  59 XBT_PUBLIC(void) xbt_str_ltrim( char* s, const char* char_list);
  60 XBT_PUBLIC(void) xbt_str_trim(char* s, const char* char_list);
  61
  62 XBT_PUBLIC(xbt_dynar_t) xbt_str_split(const char *s, const char *sep);
  63 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted(const char *s);
  64 XBT_PUBLIC(char *) xbt_str_join(xbt_dynar_t dynar, const char *sep);
  65
  66 /* */
  67 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
  68 XBT_PUBLIC(char *) xbt_str_diff(char *a, char *b);
  69
  70 /** @brief Classical alias to (char*)
  71  *
  72  * This of almost no use, beside cosmetics and the GRAS parsing macro (see \ref GRAS_dd_auto).
  73  */
  74 typedef char *xbt_string_t;
  75
  76 /**@}*/
  77
  78 SG_END_DECL()
  79
  80 #endif /* XBT_STR_H */
  81
  82
  83
  84