base/hash_tables.h

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4 //
   5
   6 //
   7 // Deal with the differences between Microsoft and GNU implemenations
   8 // of hash_map. Allows all platforms to use |base::hash_map| and
   9 // |base::hash_set|.
  10 //  eg:
  11 //   base::hash_map<int> my_map;
  12 //   base::hash_set<int> my_set;
  13 //
  14 // NOTE: It is an explicit non-goal of this class to provide a generic hash
  15 // function for pointers.  If you want to hash a pointers to a particular class,
  16 // please define the template specialization elsewhere (for example, in its
  17 // header file) and keep it specific to just pointers to that class.  This is
  18 // because identity hashes are not desirable for all types that might show up
  19 // in containers as pointers.
  20
  21 #ifndef BASE_HASH_TABLES_H_
  22 #define BASE_HASH_TABLES_H_
  23 #pragma once
  24
  25 #include "build/build_config.h"
  26
  27 #include "base/string16.h"
  28
  29 #if defined(COMPILER_MSVC)
  30 #include <hash_map>
  31 #include <hash_set>
  32
  33 #define BASE_HASH_NAMESPACE stdext
  34
  35 #elif defined(COMPILER_GCC)
  36 #if defined(OS_ANDROID)
  37 #define BASE_HASH_NAMESPACE std
  38 #else
  39 #define BASE_HASH_NAMESPACE __gnu_cxx
  40 #endif
  41
  42 // This is a hack to disable the gcc 4.4 warning about hash_map and hash_set
  43 // being deprecated.  We can get rid of this when we upgrade to VS2008 and we
  44 // can use <tr1/unordered_map> and <tr1/unordered_set>.
  45 #ifdef __DEPRECATED
  46 #define CHROME_OLD__DEPRECATED __DEPRECATED
  47 #undef __DEPRECATED
  48 #endif
  49
  50 #if defined(OS_ANDROID)
  51 #include <hash_map>
  52 #include <hash_set>
  53 #else
  54 #include <ext/hash_map>
  55 #include <ext/hash_set>
  56 #endif
  57
  58 #include <string>
  59
  60 #ifdef CHROME_OLD__DEPRECATED
  61 #define __DEPRECATED CHROME_OLD__DEPRECATED
  62 #undef CHROME_OLD__DEPRECATED
  63 #endif
  64
  65 namespace BASE_HASH_NAMESPACE {
  66
  67 #if !defined(OS_ANDROID)
  68 // The GNU C++ library provides identity hash functions for many integral types,
  69 // but not for |long long|.  This hash function will truncate if |size_t| is
  70 // narrower than |long long|.  This is probably good enough for what we will
  71 // use it for.
  72
  73 #define DEFINE_TRIVIAL_HASH(integral_type) \
  74     template<> \
  75     struct hash<integral_type> { \
  76       std::size_t operator()(integral_type value) const { \
  77         return static_cast<std::size_t>(value); \
  78       } \
  79     }
  80
  81 DEFINE_TRIVIAL_HASH(long long);
  82 DEFINE_TRIVIAL_HASH(unsigned long long);
  83
  84 #undef DEFINE_TRIVIAL_HASH
  85 #endif  // !defined(OS_ANDROID)
  86
  87 // Implement string hash functions so that strings of various flavors can
  88 // be used as keys in STL maps and sets.  The hash algorithm comes from the
  89 // GNU C++ library, in <tr1/functional>.  It is duplicated here because GCC
  90 // versions prior to 4.3.2 are unable to compile <tr1/functional> when RTTI
  91 // is disabled, as it is in our build.
  92
  93 #define DEFINE_STRING_HASH(string_type) \
  94     template<> \
  95     struct hash<string_type> { \
  96       std::size_t operator()(const string_type& s) const { \
  97         std::size_t result = 0; \
  98         for (string_type::const_iterator i = s.begin(); i != s.end(); ++i) \
  99           result = (result * 131) + *i; \
 100         return result; \
 101       } \
 102     }
 103
 104 DEFINE_STRING_HASH(std::string);
 105 DEFINE_STRING_HASH(string16);
 106
 107 #undef DEFINE_STRING_HASH
 108
 109 }  // namespace BASE_HASH_NAMESPACE
 110
 111 #else  // COMPILER
 112 #error define BASE_HASH_NAMESPACE for your compiler
 113 #endif  // COMPILER
 114
 115 namespace base {
 116 using BASE_HASH_NAMESPACE::hash_map;
 117 using BASE_HASH_NAMESPACE::hash_set;
 118 }
 119
 120 #endif  // BASE_HASH_TABLES_H_