include/xbt/str.h

   1 /* str.h - XBT string related functions.                                    */
   2
   3 /* Copyright (c) 2007-2015. 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 "xbt/misc.h"
  13 #include "xbt/dynar.h"
  14 #include "xbt/dict.h"
  15
  16 #include <stdarg.h>             /* va_* */
  17 #include <stdio.h>  /* FILE */
  18
  19 SG_BEGIN_DECL()
  20
  21 /** @addtogroup XBT_str
  22  *  @brief String manipulation functions
  23  *
  24  * This module defines several string related functions. Looking at the diversity of string manipulation functions that
  25  * are provided, you can see that several SimGrid core developers actually like Perl.
  26  * @{
  27  */
  28
  29 /* Trim related functions */
  30 XBT_PUBLIC(void) xbt_str_rtrim(char *s, const char *char_list);
  31 XBT_PUBLIC(void) xbt_str_ltrim(char *s, const char *char_list);
  32 XBT_PUBLIC(void) xbt_str_trim(char *s, const char *char_list);
  33
  34 XBT_PUBLIC(xbt_dynar_t) xbt_str_split(const char *s, const char *sep);
  35 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted(const char *s);
  36 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_quoted_in_place(char *s);
  37
  38 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_str(const char *s, const char *sep);
  39
  40 XBT_PUBLIC(char *) xbt_str_join(xbt_dynar_t dynar, const char *sep);
  41 XBT_PUBLIC(char *) xbt_str_join_array(const char *const *strs, const char *sep);
  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 XBT_PUBLIC(long int) xbt_str_parse_int(const char* str, const char* error_msg);
  47 XBT_PUBLIC(double) xbt_str_parse_double(const char* str, const char* error_msg);
  48
  49 #define XBT_DJB2_HASH_FUNCTION
  50 //#define XBT_FNV_HASH_FUNCTION
  51
  52 /**
  53  * @brief Returns the hash code of a string.
  54  */
  55 static inline unsigned int xbt_str_hash_ext(const char *str, int str_len)
  56 {
  57 #ifdef XBT_DJB2_HASH_FUNCTION
  58   /* fast implementation of djb2 algorithm */
  59   int c;
  60   unsigned int hash = 5381;
  61
  62   while (str_len--) {
  63     c = *str++;
  64     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
  65   }
  66 # elif defined(XBT_FNV_HASH_FUNCTION)
  67   unsigned int hash = 0x811c9dc5;
  68   unsigned char *bp = (unsigned char *) str;    /* start of buffer */
  69   unsigned char *be = bp + str_len;     /* beyond end of buffer */
  70
  71   while (bp < be) {
  72     /* multiply by the 32 bit FNV magic prime mod 2^32 */
  73     hash +=
  74         (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
  75         (hash << 24);
  76
  77     /* xor the bottom with the current octet */
  78     hash ^= (unsigned int) *bp++;
  79   }
  80
  81 # else
  82   unsigned int hash = 0;
  83
  84   while (str_len--) {
  85     hash += (*str) * (*str);
  86     str++;
  87   }
  88 #endif
  89
  90   return hash;
  91 }
  92
  93 /**
  94  * @brief Returns the hash code of a string.
  95  */
  96 static inline unsigned int xbt_str_hash(const char *str)
  97 {
  98 #ifdef XBT_DJB2_HASH_FUNCTION
  99   /* fast implementation of djb2 algorithm */
 100   int c;
 101   unsigned int hash = 5381;
 102
 103   while ((c = *str++)) {
 104     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
 105   }
 106
 107 # elif defined(XBT_FNV_HASH_FUNCTION)
 108   unsigned int hash = 0x811c9dc5;
 109
 110   while (*str) {
 111     /* multiply by the 32 bit FNV magic prime mod 2^32 */
 112     hash += (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) + (hash << 24);
 113
 114     /* xor the bottom with the current byte */
 115     hash ^= (unsigned int) *str++;
 116   }
 117
 118 # else
 119   unsigned int hash = 0;
 120
 121   while (*str) {
 122     hash += (*str) * (*str);
 123     str++;
 124   }
 125 #endif
 126   return hash;
 127 }
 128
 129 /**@}*/
 130 SG_END_DECL()
 131 #endif                          /* XBT_STR_H */