include/xbt/str.h

   1 /* str.h - XBT string related functions.                                    */
   2
   3 /* Copyright (c) 2007, 2008, 2009, 2010. 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 <stdarg.h>             /* va_* */
  13 #include "xbt/misc.h"
  14 #include "xbt/dynar.h"
  15 #include "xbt/dict.h"
  16 #include "simgrid_config.h"     /* FILE for getline */
  17
  18 SG_BEGIN_DECL()
  19
  20 /** @addtogroup XBT_str
  21  *  @brief String manipulation functions
  22  *
  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.
  26  * @{
  27  */
  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);
  32
  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);
  36
  37 XBT_PUBLIC(xbt_dynar_t) xbt_str_split_str(const char *s, const char *sep);
  38
  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);
  41
  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 /* */
  47 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
  48 XBT_PUBLIC(char *) xbt_str_diff(const char *a, const char *b);
  49
  50 XBT_PUBLIC(char *) xbt_str_from_file(FILE * file);
  51
  52 XBT_PUBLIC(int) xbt_str_start_with(const char* str, const char* start);
  53
  54 #define DJB2_HASH_FUNCTION
  55 //#define FNV_HASH_FUNCTION
  56
  57 /**
  58  * @brief Returns the hash code of a string.
  59  */
  60 static XBT_INLINE unsigned int xbt_str_hash_ext(const char *str, int str_len)
  61 {
  62
  63 #ifdef DJB2_HASH_FUNCTION
  64   /* fast implementation of djb2 algorithm */
  65   int c;
  66   register unsigned int hash = 5381;
  67
  68   while (str_len--) {
  69     c = *str++;
  70     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
  71   }
  72 # elif defined(FNV_HASH_FUNCTION)
  73   register unsigned int hash = 0x811c9dc5;
  74   unsigned char *bp = (unsigned char *) str;    /* start of buffer */
  75   unsigned char *be = bp + str_len;     /* beyond end of buffer */
  76
  77   while (bp < be) {
  78     /* multiply by the 32 bit FNV magic prime mod 2^32 */
  79     hash +=
  80         (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
  81         (hash << 24);
  82
  83     /* xor the bottom with the current octet */
  84     hash ^= (unsigned int) *bp++;
  85   }
  86
  87 # else
  88   register unsigned int hash = 0;
  89
  90   while (str_len--) {
  91     hash += (*str) * (*str);
  92     str++;
  93   }
  94 #endif
  95
  96   return hash;
  97 }
  98
  99 /**
 100  * @brief Returns the hash code of a string.
 101  */
 102 static XBT_INLINE unsigned int xbt_str_hash(const char *str)
 103 {
 104 #ifdef DJB2_HASH_FUNCTION
 105   /* fast implementation of djb2 algorithm */
 106   int c;
 107   register unsigned int hash = 5381;
 108
 109   while ((c = *str++)) {
 110     hash = ((hash << 5) + hash) + c;    /* hash * 33 + c */
 111   }
 112
 113 # elif defined(FNV_HASH_FUNCTION)
 114   register unsigned int hash = 0x811c9dc5;
 115
 116   while (*str) {
 117     /* multiply by the 32 bit FNV magic prime mod 2^32 */
 118     hash +=
 119         (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) +
 120         (hash << 24);
 121
 122     /* xor the bottom with the current byte */
 123     hash ^= (unsigned int) *str++;
 124   }
 125
 126 # else
 127   register unsigned int hash = 0;
 128
 129   while (*str) {
 130     hash += (*str) * (*str);
 131     str++;
 132   }
 133 #endif
 134   return hash;
 135 }
 136
 137 /**@}*/
 138
 139 SG_END_DECL()
 140 #endif                          /* XBT_STR_H */