Logo AND Algorithmique Numérique Distribuée

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