Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'Adrien.Gougeon/simgrid-master'
[simgrid.git] / include / xbt / str.h
1 /* str.h - XBT string related functions.                                    */
2
3 /* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved.          */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef XBT_STR_H
9 #define XBT_STR_H
10
11 #include <xbt/dict.h>
12 #include <xbt/dynar.h>
13 #include <xbt/misc.h>
14
15 #include <stdarg.h> /* va_* */
16
17 SG_BEGIN_DECL
18
19 /** @addtogroup XBT_str
20  *  @brief String manipulation functions
21  *
22  * This module defines several string related functions. Looking at the diversity of string manipulation functions that
23  * are provided, you can see that several SimGrid core developers actually like Perl.
24  * @{
25  */
26
27 XBT_PUBLIC xbt_dynar_t xbt_str_split_quoted(const char* s);
28 XBT_PUBLIC xbt_dynar_t xbt_str_split_quoted_in_place(char* s);
29
30 XBT_PUBLIC long int xbt_str_parse_int(const char* str, const char* error_mesg);
31 XBT_PUBLIC double xbt_str_parse_double(const char* str, const char* error_mesg);
32
33 #define XBT_DJB2_HASH_FUNCTION
34 //#define XBT_FNV_HASH_FUNCTION
35
36 /**
37  * @brief Returns the hash code of a string.
38  */
39 static inline unsigned int xbt_str_hash_ext(const char* str, int str_len)
40 {
41 #ifdef XBT_DJB2_HASH_FUNCTION
42   /* fast implementation of djb2 algorithm */
43   unsigned int hash = 5381;
44
45   while (str_len--) {
46     int c = *str++;
47     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
48   }
49 # elif defined(XBT_FNV_HASH_FUNCTION)
50   unsigned int hash = 0x811c9dc5;
51   unsigned char *bp = (unsigned char *) str;    /* start of buffer */
52   unsigned char *be = bp + str_len;     /* beyond end of buffer */
53
54   while (bp < be) {
55     /* multiply by the 32 bit FNV magic prime mod 2^32 */
56     hash +=
57         (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
58         (hash << 24);
59
60     /* xor the bottom with the current octet */
61     hash ^= (unsigned int) *bp++;
62   }
63
64 # else
65   unsigned int hash = 0;
66
67   while (str_len--) {
68     hash += (*str) * (*str);
69     str++;
70   }
71 #endif
72
73   return hash;
74 }
75
76 /**
77  * @brief Returns the hash code of a string.
78  */
79 static inline unsigned int xbt_str_hash(const char *str)
80 {
81 #ifdef XBT_DJB2_HASH_FUNCTION
82   /* fast implementation of djb2 algorithm */
83   int c;
84   unsigned int hash = 5381;
85
86   while ((c = *str++)) {
87     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
88   }
89
90 # elif defined(XBT_FNV_HASH_FUNCTION)
91   unsigned int hash = 0x811c9dc5;
92
93   while (*str) {
94     /* multiply by the 32 bit FNV magic prime mod 2^32 */
95     hash += (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) + (hash << 24);
96
97     /* xor the bottom with the current byte */
98     hash ^= (unsigned int) *str++;
99   }
100
101 # else
102   unsigned int hash = 0;
103
104   while (*str) {
105     hash += (*str) * (*str);
106     str++;
107   }
108 #endif
109   return hash;
110 }
111
112 /**@}*/
113 SG_END_DECL
114 #endif                          /* XBT_STR_H */