src/base/hash_tables.h

// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//

//
// Deal with the differences between Microsoft and GNU implemenations
// of hash_map. Allows all platforms to use |base::hash_map| and
// |base::hash_set|.
//  eg:
//   base::hash_map<int> my_map;
//   base::hash_set<int> my_set;
//
// NOTE: It is an explicit non-goal of this class to provide a generic hash
// function for pointers.  If you want to hash a pointers to a particular class,
// please define the template specialization elsewhere (for example, in its
// header file) and keep it specific to just pointers to that class.  This is
// because identity hashes are not desirable for all types that might show up
// in containers as pointers.

#ifndef BASE_HASH_TABLES_H_
#define BASE_HASH_TABLES_H_

#include <string>

#include "build/build_config.h"

#include "base/string16.h"

#if defined(OS_STARBOARD)
#include "starboard/configuration.h"
#if SB_HAS(STD_UNORDERED_HASH)
#define BASE_HASH_DEFINE_LONG_LONG_HASHES 0
#define BASE_HASH_DEFINE_STRING_HASHES 0
#define BASE_HASH_USE_HASH 0
#define BASE_HASH_MAP_INCLUDE <unordered_map>
#define BASE_HASH_NAMESPACE std
#define BASE_HASH_SET_INCLUDE <unordered_set>
#define BASE_HASH_USE_HASH_STRUCT

#else  // SB_HAS(STD_UNORDERED_HASH)
#define BASE_HASH_DEFINE_LONG_LONG_HASHES !SB_HAS(LONG_LONG_HASH)
#define BASE_HASH_DEFINE_STRING_HASHES !SB_HAS(STRING_HASH)
#define BASE_HASH_USE_HASH !SB_HAS(HASH_USING)
#define BASE_HASH_MAP_INCLUDE SB_HASH_MAP_INCLUDE
#define BASE_HASH_NAMESPACE SB_HASH_NAMESPACE
#define BASE_HASH_SET_INCLUDE SB_HASH_SET_INCLUDE
#if !SB_HAS(HASH_VALUE)
#define BASE_HASH_USE_HASH_STRUCT
#endif
#endif // SB_HAS(STD_UNORDERED_HASH)
#elif defined(COMPILER_MSVC)
#define BASE_HASH_DEFINE_LONG_LONG_HASHES 0
#define BASE_HASH_DEFINE_STRING_HASHES 0
#define BASE_HASH_USE_HASH 0
#define BASE_HASH_MAP_INCLUDE <hash_map>
#define BASE_HASH_NAMESPACE stdext
#define BASE_HASH_SET_INCLUDE <hash_set>
#elif defined(COMPILER_GCC)
#if defined(OS_ANDROID) || (defined(__LB_SHELL__) && !defined(__LB_LINUX__))
#define BASE_HASH_DEFINE_LONG_LONG_HASHES 0
#define BASE_HASH_DEFINE_STRING_HASHES !defined(__LB_SHELL__)
#define BASE_HASH_MAP_INCLUDE <hash_map>
#define BASE_HASH_NAMESPACE std
#define BASE_HASH_SET_INCLUDE <hash_set>
#else
#define BASE_HASH_DEFINE_LONG_LONG_HASHES 1
#define BASE_HASH_DEFINE_STRING_HASHES 1
#define BASE_HASH_MAP_INCLUDE <ext/hash_map>
#define BASE_HASH_NAMESPACE __gnu_cxx
#define BASE_HASH_SET_INCLUDE <ext/hash_set>
#define BASE_HASH_USE_HASH_STRUCT
#endif
#if defined(__LB_LINUX__)
#define BASE_HASH_USE_HASH 1
#else
#define BASE_HASH_USE_HASH 0
#endif
#else  // COMPILER
#error define BASE_HASH_NAMESPACE for your compiler
#endif  // COMPILER

// This is a hack to disable the gcc 4.4 warning about hash_map and hash_set
// being deprecated.  We can get rid of this when we upgrade to VS2008 and we
// can use <tr1/unordered_map> and <tr1/unordered_set>.
#ifdef __DEPRECATED
#define CHROME_OLD__DEPRECATED __DEPRECATED
#undef __DEPRECATED
#endif

#include BASE_HASH_MAP_INCLUDE
#include BASE_HASH_SET_INCLUDE

#ifdef CHROME_OLD__DEPRECATED
#define __DEPRECATED CHROME_OLD__DEPRECATED
#undef CHROME_OLD__DEPRECATED
#endif

#if BASE_HASH_DEFINE_LONG_LONG_HASHES
// The GNU C++ library provides identity hash functions for many integral types,
// but not for |long long|.  This hash function will truncate if |size_t| is
// narrower than |long long|.  This is probably good enough for what we will
// use it for.

#define DEFINE_TRIVIAL_HASH(integral_type) \
    template<> \
    struct hash<integral_type> { \
      std::size_t operator()(integral_type value) const { \
        return static_cast<std::size_t>(value); \
      } \
    }

namespace BASE_HASH_NAMESPACE {
DEFINE_TRIVIAL_HASH(long long);
DEFINE_TRIVIAL_HASH(unsigned long long);

template <typename T>
struct hash<T*> {
  std::size_t operator()(T* value) const {
    return BASE_HASH_NAMESPACE::hash<uintptr_t>()(
        reinterpret_cast<uintptr_t>(value));
  }
};
}  // namespace BASE_HASH_NAMESPACE

#undef DEFINE_TRIVIAL_HASH
#endif  // BASE_HASH_DEFINE_LONG_LONG_HASHES


#if BASE_HASH_DEFINE_STRING_HASHES
// Implement string hash functions so that strings of various flavors can
// be used as keys in STL maps and sets.  The hash algorithm comes from the
// GNU C++ library, in <tr1/functional>.  It is duplicated here because GCC
// versions prior to 4.3.2 are unable to compile <tr1/functional> when RTTI
// is disabled, as it is in our build.

#define DEFINE_STRING_HASH(string_type) \
    template<> \
    struct hash<string_type> { \
      std::size_t operator()(const string_type& s) const { \
        std::size_t result = 0; \
        for (string_type::const_iterator i = s.begin(); i != s.end(); ++i) \
          result = (result * 131) + *i; \
        return result; \
      } \
    }

namespace BASE_HASH_NAMESPACE {
DEFINE_STRING_HASH(std::string);
DEFINE_STRING_HASH(string16);
}  // namespace BASE_HASH_NAMESPACE

#undef DEFINE_STRING_HASH
#endif  // BASE_HASH_DEFINE_STRING_HASHES


namespace base {
#if BASE_HASH_USE_HASH
using BASE_HASH_NAMESPACE::hash;
#endif
#if SB_HAS(STD_UNORDERED_HASH)
template <class K,
          class V,
          class Hash = std::hash<K>,
          class KeyEqual = std::equal_to<K>>
using hash_map = std::unordered_map<K, V, Hash, KeyEqual>;
template <class K,
          class V,
          class Hash = std::hash<K>,
          class KeyEqual = std::equal_to<K>>
using hash_multimap = std::unordered_multimap<K, V, Hash, KeyEqual>;
template <class K, class Hash = std::hash<K>, class KeyEqual = std::equal_to<K>>
using hash_multiset = std::unordered_multiset<K, Hash, KeyEqual>;
template <class K, class Hash = std::hash<K>, class KeyEqual = std::equal_to<K>>
using hash_set = std::unordered_set<K, Hash, KeyEqual>;
#else  // SB_HAS(STD_UNORDERED_HASH)
using BASE_HASH_NAMESPACE::hash_map;
using BASE_HASH_NAMESPACE::hash_multimap;
using BASE_HASH_NAMESPACE::hash_multiset;
using BASE_HASH_NAMESPACE::hash_set;
#endif  // SB_HAS(STD_UNORDERED_HASH)
}

#undef BASE_HASH_DEFINE_LONG_LONG_HASHES
#undef BASE_HASH_DEFINE_STRING_HASHES
#undef BASE_HASH_MAP_INCLUDE
#undef BASE_HASH_SET_INCLUDE
#undef BASE_HASH_USE_HASH

#endif  // BASE_HASH_TABLES_H_