1 /* str.h - XBT string related functions. */
3 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
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. */
12 #include <stdarg.h> /* va_* */
14 #include "xbt/dynar.h"
16 #include "simgrid_config.h" /* FILE for getline */
20 /** @addtogroup XBT_str
21 * @brief String manipulation functions
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.
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);
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);
37 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_str(const char *s, const char *sep);
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);
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);
47 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
48 XBT_PUBLIC(char *) xbt_str_diff(const char *a, const char *b);
50 XBT_PUBLIC(char *) xbt_str_from_file(FILE * file);
52 #define DJB2_HASH_FUNCTION
53 //#define FNV_HASH_FUNCTION
56 * @brief Returns the hash code of a string.
58 static XBT_INLINE unsigned int xbt_str_hash_ext(const char *str, int str_len)
61 #ifdef DJB2_HASH_FUNCTION
62 /* fast implementation of djb2 algorithm */
64 register unsigned int hash = 5381;
68 hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
70 # elif defined(FNV_HASH_FUNCTION)
71 register unsigned int hash = 0x811c9dc5;
72 unsigned char *bp = (unsigned char *) str; /* start of buffer */
73 unsigned char *be = bp + str_len; /* beyond end of buffer */
76 /* multiply by the 32 bit FNV magic prime mod 2^32 */
78 (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
81 /* xor the bottom with the current octet */
82 hash ^= (unsigned int) *bp++;
86 register unsigned int hash = 0;
89 hash += (*str) * (*str);
98 * @brief Returns the hash code of a string.
100 static XBT_INLINE unsigned int xbt_str_hash(const char *str)
102 #ifdef DJB2_HASH_FUNCTION
103 /* fast implementation of djb2 algorithm */
105 register unsigned int hash = 5381;
107 while ((c = *str++)) {
108 hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
111 # elif defined(FNV_HASH_FUNCTION)
112 register unsigned int hash = 0x811c9dc5;
115 /* multiply by the 32 bit FNV magic prime mod 2^32 */
117 (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
120 /* xor the bottom with the current byte */
121 hash ^= (unsigned int) *str++;
125 register unsigned int hash = 0;
128 hash += (*str) * (*str);
135 /** @brief Classical alias to (char*)
137 * This of almost no use, beside cosmetics and the XBT datadesc parsing macro (see \ref XBT_dd_auto).
139 typedef char *xbt_string_t;
144 #endif /* XBT_STR_H */