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 "xbt/dict.h"
  18 #include <stdio.h>              /* FILE for getline */
  19
  20 SG_BEGIN_DECL()
  21
  22 /** @addtogroup XBT_str
  23  *  @brief String manipulation functions
  24  *
  25  * This module defines several string related functions. We redefine some quite classical
  26  * functions on the platforms were they are not nativaly defined (such as getline() or
  27  * asprintf()), while some other are a bit more exotic.
  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 */
  41                          ...) _XBT_GNUC_PRINTF(2, 3);
  42 /** @brief print to allocated string (reimplemented when not provided by the system)
  43  *
  44  * See asprintf()
  45  */
  46 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
  47 /** @brief print to allocated string
  48  *
  49  * Works just like asprintf(), but returns a pointer to the newly created string
  50  */
  51 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
  52
  53 /* the gettext function. It gets redefined here only if not yet available */
  54 #if !defined(__USE_GNU) || defined(DOXYGEN)
  55 XBT_PUBLIC(long) getline(char **lineptr, size_t * n, FILE * stream);
  56 #endif
  57
  58 /* Trim related functions */
  59 XBT_PUBLIC(void) xbt_str_rtrim(char *s, const char *char_list);
  60 XBT_PUBLIC(void) xbt_str_ltrim(char *s, const char *char_list);
  61 XBT_PUBLIC(void) xbt_str_trim(char *s, const char *char_list);
  62
  63 XBT_PUBLIC(xbt_dynar_t) xbt_str_split(const char *s, const char *sep);
  64 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted(const char *s);
  65 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_str(const char *s, const char *sep);
  66
  67 XBT_PUBLIC(char *) xbt_str_join(xbt_dynar_t dynar, const char *sep);
  68
  69 /* */
  70 XBT_PUBLIC(void) xbt_str_subst(char *str, char from, char to, int amount);
  71 XBT_PUBLIC(char *) xbt_str_varsubst(char *str, xbt_dict_t patterns);
  72
  73 /* */
  74 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
  75 XBT_PUBLIC(char *) xbt_str_diff(char *a, char *b);
  76
  77
  78 XBT_PUBLIC(char*)xbt_str_from_file(FILE *file);
  79
  80 /** @brief Classical alias to (char*)
  81  *
  82  * This of almost no use, beside cosmetics and the GRAS parsing macro (see \ref GRAS_dd_auto).
  83  */
  84      typedef char *xbt_string_t;
  85
  86 /**@}*/
  87
  88 SG_END_DECL()
  89 #endif /* XBT_STR_H */