Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add an alias to (char*) to help the parsing macro
[simgrid.git] / 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
18 /* KILLME: Malek, are you sure you need this? */
19 #if defined(_WIN32)
20 #include <stdio.h>
21 #endif 
22
23 SG_BEGIN_DECL()
24
25 /** @addtogroup XBT_str
26  *  @brief String manipulation functions
27  * 
28  * This module defines several string related functions. We redefine some quite classical 
29  * functions on the platforms were they are not nativaly defined (such as getline() or 
30  * asprintf()), while some other are a bit more exotic. 
31  * @{
32  */
33   
34 /* snprintf related functions */
35 /** @brief print to allocated string (reimplemented when not provided by the system)
36  * 
37  * The functions asprintf() and vasprintf() are analogues of
38  * sprintf() and vsprintf(), except that they allocate a string large
39  * enough to hold the output including the terminating null byte, and
40  * return a pointer to it via the first parameter.  This pointer
41  * should be passed to free(3) to release the allocated storage when
42  * it is no longer needed.
43  */
44 XBT_PUBLIC(int) asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
45 /** @brief print to allocated string (reimplemented when not provided by the system)
46  * 
47  * See asprintf()
48  */
49 XBT_PUBLIC(int) vasprintf (char **ptr, const char *fmt, va_list ap);
50 /** @brief print to allocated string
51  * 
52  * Works just like asprintf(), but returns a pointer to the newly created string
53  */
54 XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
55
56 /* the gettext function. It gets redefined here only if not yet available */
57 #if defined(_WIN32) || !defined(__GNUC__) || defined(DOXYGEN)
58 XBT_PUBLIC(long) getline(char **lineptr, size_t *n, FILE *stream);
59 #endif
60
61 /* Trim related functions */
62 XBT_PUBLIC(void) xbt_str_rtrim(char* s, const char* char_list);
63 XBT_PUBLIC(void) xbt_str_ltrim( char* s, const char* char_list);
64 XBT_PUBLIC(void) xbt_str_trim(char* s, const char* char_list);
65
66 XBT_PUBLIC(xbt_dynar_t) xbt_str_split(const char *s, const char *sep);
67 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted(const char *s);
68 XBT_PUBLIC(char *) xbt_str_join(xbt_dynar_t dynar, const char *sep);
69
70 /* */
71 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
72 XBT_PUBLIC(char *) xbt_str_diff(char *a, char *b);
73
74 /** @brief Classical alias to (char*) 
75  *
76  * This of almost no use, beside cosmetics and the GRAS parsing macro (see \ref GRAS_dd_auto).
77  */
78 typedef char *xbt_string_t;
79
80 /**@}*/
81
82 SG_END_DECL()
83
84 #endif /* XBT_STR_H */
85
86
87
88