include/xbt/str.h

   1 /* str.h - XBT string related functions.                                    */
   2
   3 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef XBT_STR_H
  10 #define XBT_STR_H
  11
  12 #include <stdarg.h>             /* va_* */
  13 #include "xbt/misc.h"
  14 #include "xbt/dynar.h"
  15 #include "xbt/dict.h"
  16 #include "simgrid_config.h"     /* FILE for getline */
  17
  18 SG_BEGIN_DECL()
  19
  20 /** @addtogroup XBT_str
  21  *  @brief String manipulation functions
  22  *
  23  * This module defines several string related functions. We redefine some quite classical
  24  * functions on the platforms were they are not nativaly defined (such as getline() or
  25  * asprintf()), while some other are a bit more exotic.
  26  * @{
  27  */
  28 /* Trim related functions */
  29 XBT_PUBLIC(void) xbt_str_rtrim(char *s, const char *char_list);
  30 XBT_PUBLIC(void) xbt_str_ltrim(char *s, const char *char_list);
  31 XBT_PUBLIC(void) xbt_str_trim(char *s, const char *char_list);
  32
  33 XBT_PUBLIC(xbt_dynar_t) xbt_str_split(const char *s, const char *sep);
  34 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted(const char *s);
  35 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted_in_place(char *s);
  36
  37 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_str(const char *s, const char *sep);
  38
  39 XBT_PUBLIC(char *) xbt_str_join(xbt_dynar_t dynar, const char *sep);
  40 XBT_PUBLIC(char *) xbt_str_join_array(const char *const *strs, const char *sep);
  41
  42 /* */
  43 XBT_PUBLIC(void) xbt_str_subst(char *str, char from, char to, int amount);
  44 XBT_PUBLIC(char *) xbt_str_varsubst(const char *str, xbt_dict_t patterns);
  45
  46 /* */
  47 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
  48 XBT_PUBLIC(char *) xbt_str_diff(const char *a, const char *b);
  49
  50 XBT_PUBLIC(char *) xbt_str_from_file(FILE * file);
  51
  52 /** @brief Classical alias to (char*)
  53  *
  54  * This of almost no use, beside cosmetics and the XBT datadesc parsing macro (see \ref XBT_dd_auto).
  55  */
  56 typedef char *xbt_string_t;
  57
  58 /**@}*/
  59
  60 SG_END_DECL()
  61 #endif                          /* XBT_STR_H */