json_object.h

#ifndef SOURCEMETA_CORE_JSON_OBJECT_H_
#define SOURCEMETA_CORE_JSON_OBJECT_H_
 
#include <algorithm>        // std::sort
#include <cassert>          // assert
#include <concepts>         // std::same_as
#include <cstddef>          // std::size_t
#include <initializer_list> // std::initializer_list
#include <iterator>         // std::advance
#include <string_view>      // std::basic_string_view
#include <type_traits>      // std::remove_cvref_t
#include <utility>          // std::pair, std::move, std::unreachable
#include <vector>           // std::vector
 
namespace sourcemeta::core {

template <typename Key, typename Value, typename Hash> class JSONObject {
public:
  JSONObject() = default;
 
  using key_type = Key;
  using mapped_type = Value;
  using hash_type = typename Hash::hash_type;
  using pair_value_type = std::pair<key_type, mapped_type>;
  using KeyView = std::basic_string_view<typename Key::value_type,
                                         typename Key::traits_type>;

  JSONObject(std::initializer_list<pair_value_type> entries) : data{} {
    this->data.reserve(entries.size());
    for (auto &&entry : entries) {
      this->emplace(std::move(entry.first), std::move(entry.second));
    }
  }

  struct Entry {
    key_type first;
    mapped_type second;
    hash_type hash;

    [[nodiscard]] inline auto key_equals(const KeyView key,
                                         const hash_type key_hash) const
        -> bool {
      assert(JSONObject::hash(key) == key_hash);
      // A perfect hash captures the key bytes but not its length, so two keys
      // that differ only by trailing NUL bytes hash equal. Comparing sizes
      // disambiguates them without the cost of a full string comparison
      return this->hash == key_hash &&
             (hasher.is_perfect(key_hash) ? this->first.size() == key.size()
                                          : this->first == key);
    }
  };
 
  using underlying_type = std::vector<Entry>;
  using value_type = typename underlying_type::value_type;
  using size_type = typename underlying_type::size_type;
  using difference_type = typename underlying_type::difference_type;
  using allocator_type = typename underlying_type::allocator_type;
  using reference = typename underlying_type::reference;
  using const_reference = typename underlying_type::const_reference;
  using pointer = typename underlying_type::pointer;
  using const_pointer = typename underlying_type::const_pointer;
  using const_iterator = typename underlying_type::const_iterator;
 
  // Operators
  // We cannot default given that this class references
  // a JSON "value" as an incomplete type
 
  auto operator<(const JSONObject<Key, Value, Hash> &other) const noexcept
      -> bool {
    // Objects have no inherent order, but a deterministic strict weak ordering
    // independent of insertion order is needed so that collections of objects
    // can be sorted. Smaller objects come first, and objects of equal size are
    // ordered as their entries would compare in key order. That outcome is
    // decided entirely by the smallest key at which the two objects differ,
    // which is found by scanning the entries in place to avoid allocating
    if (this->data.size() != other.data.size()) {
      return this->data.size() < other.data.size();
    }
 
    const Key *decisive_key{nullptr};
    bool decision{false};
    for (const auto &entry : this->data) {
      const auto match{other.find(entry.first)};
      const bool differs{match == other.cend() ||
                         !(entry.second == match->second)};
      if (differs && (decisive_key == nullptr || entry.first < *decisive_key)) {
        decisive_key = &entry.first;
        decision = match == other.cend() || entry.second < match->second;
      }
    }
 
    for (const auto &entry : other.data) {
      if (this->find(entry.first) == this->cend() &&
          (decisive_key == nullptr || entry.first < *decisive_key)) {
        decisive_key = &entry.first;
        decision = false;
      }
    }
 
    return decision;
  }
 
  auto operator<=(const JSONObject<Key, Value, Hash> &other) const noexcept
      -> bool {
    return !(other < *this);
  }
  auto operator>(const JSONObject<Key, Value, Hash> &other) const noexcept
      -> bool {
    return other < *this;
  }
  auto operator>=(const JSONObject<Key, Value, Hash> &other) const noexcept
      -> bool {
    return !(*this < other);
  }
 
  auto operator==(const JSONObject<Key, Value, Hash> &other) const noexcept
      -> bool {
    if (this->size() != other.size()) {
      return false;
    }
 
    for (const auto &entry : this->data) {
      const auto *result{other.try_at(entry.first, entry.hash)};
      if (!result || *result != entry.second) {
        return false;
      }
    }
 
    return true;
  }
 
  auto operator!=(const JSONObject<Key, Value, Hash> &other) const noexcept
      -> bool = default;
 
  [[nodiscard]] inline auto begin() const noexcept -> const_iterator {
    return this->data.begin();
  }
  [[nodiscard]] inline auto end() const noexcept -> const_iterator {
    return this->data.end();
  }
  [[nodiscard]] inline auto cbegin() const noexcept -> const_iterator {
    return this->data.cbegin();
  }
  [[nodiscard]] inline auto cend() const noexcept -> const_iterator {
    return this->data.cend();
  }
 
  // GCC does not optimise well across implicit type conversions such as
  // std::string to std::string_view, so we provide separate overloads with
  // duplicated logic instead of unifying on a single parameter type. The
  // `KeyView`-accepting overloads are constrained to actual `std::string_view`
  // arguments only, so callers passing a string literal continue to bind to
  // the `Key`-accepting overload as before.

  [[nodiscard]] static constexpr auto hash(const Key &key) noexcept
      -> hash_type {
    return hasher(key);
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  [[nodiscard]] static constexpr auto hash(T key) noexcept -> hash_type {
    return hasher(key.data(), key.size());
  }

  [[nodiscard]] static constexpr auto hash(const char *raw_data,
                                           const std::size_t raw_size) noexcept
      -> hash_type {
    return hasher(raw_data, raw_size);
  }

  [[nodiscard]] inline auto find(const Key &key) const -> const_iterator {
    const auto key_hash{this->hash(key)};
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first.size() == key.size()) {
          auto iterator{this->cbegin()};
          std::advance(iterator, index);
          return iterator;
        }
      }
    } else {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first == key) {
          auto iterator{this->cbegin()};
          std::advance(iterator, index);
          return iterator;
        }
      }
    }
 
    return this->cend();
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  [[nodiscard]] inline auto find(T key) const -> const_iterator {
    const auto key_hash{this->hash(key)};
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first.size() == key.size()) {
          auto iterator{this->cbegin()};
          std::advance(iterator, index);
          return iterator;
        }
      }
    } else {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first == key) {
          auto iterator{this->cbegin()};
          std::advance(iterator, index);
          return iterator;
        }
      }
    }
 
    return this->cend();
  }

  [[nodiscard]] inline auto defines(const Key &key, const hash_type hash) const
      -> bool {
    assert(this->hash(key) == hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(hash)) {
      for (const auto &entry : *this) {
        if (entry.hash == hash && entry.first.size() == key.size()) {
          return true;
        }
      }
    } else {
      for (const auto &entry : *this) {
        if (entry.hash == hash && entry.first == key) {
          return true;
        }
      }
    }
 
    return false;
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  [[nodiscard]] inline auto defines(T key, const hash_type hash) const -> bool {
    assert(this->hash(key) == hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(hash)) {
      for (const auto &entry : *this) {
        if (entry.hash == hash && entry.first.size() == key.size()) {
          return true;
        }
      }
    } else {
      for (const auto &entry : *this) {
        if (entry.hash == hash && entry.first == key) {
          return true;
        }
      }
    }
 
    return false;
  }

  [[nodiscard]] inline auto size() const -> std::size_t {
    return this->data.size();
  }

  [[nodiscard]] inline auto empty() const -> bool { return this->data.empty(); }

  inline auto reserve(const size_type capacity) -> void {
    this->data.reserve(capacity);
  }

  [[nodiscard]] inline auto at(const size_type index) const -> const Entry & {
    return this->data.at(index);
  }

  [[nodiscard]] inline auto at(const Key &key, const hash_type key_hash) const
      -> const mapped_type & {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (const auto &entry : *this) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          return entry.second;
        }
      }
    } else {
      for (const auto &entry : *this) {
        if (entry.hash == key_hash && entry.first == key) {
          return entry.second;
        }
      }
    }
 
    std::unreachable();
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  [[nodiscard]] inline auto at(T key, const hash_type key_hash) const
      -> const mapped_type & {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (const auto &entry : *this) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          return entry.second;
        }
      }
    } else {
      for (const auto &entry : *this) {
        if (entry.hash == key_hash && entry.first == key) {
          return entry.second;
        }
      }
    }
 
    std::unreachable();
  }

  inline auto at(const Key &key, const hash_type key_hash) -> mapped_type & {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          return entry.second;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          return entry.second;
        }
      }
    }
 
    std::unreachable();
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  inline auto at(T key, const hash_type key_hash) -> mapped_type & {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          return entry.second;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          return entry.second;
        }
      }
    }
 
    std::unreachable();
  }

  [[nodiscard]] inline auto try_at(const Key &key, const hash_type key_hash)
      -> mapped_type * {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          return &entry.second;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          return &entry.second;
        }
      }
    }
 
    return nullptr;
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  [[nodiscard]] inline auto try_at(T key, const hash_type key_hash)
      -> mapped_type * {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          return &entry.second;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          return &entry.second;
        }
      }
    }
 
    return nullptr;
  }

  [[nodiscard]] inline auto try_at(const Key &key,
                                   const hash_type key_hash) const
      -> const mapped_type * {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first.size() == key.size()) {
          return &this->data[index].second;
        }
      }
    } else {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first == key) {
          return &this->data[index].second;
        }
      }
    }
 
    return nullptr;
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  [[nodiscard]] inline auto try_at(T key, const hash_type key_hash) const
      -> const mapped_type * {
    assert(this->hash(key) == key_hash);
 
    // Move the perfect hash condition out of the loop for extra performance
    if (this->hasher.is_perfect(key_hash)) {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first.size() == key.size()) {
          return &this->data[index].second;
        }
      }
    } else {
      for (size_type index = 0; index < this->size(); index++) {
        if (this->data[index].hash == key_hash &&
            this->data[index].first == key) {
          return &this->data[index].second;
        }
      }
    }
 
    return nullptr;
  }

  [[nodiscard]] inline auto try_at(const Key &key, const hash_type key_hash,
                                   size_type &start) const
      -> const mapped_type * {
    assert(this->hash(key) == key_hash);
    const auto object_size{this->size()};
    assert(start <= object_size);
    if (this->hasher.is_perfect(key_hash)) {
      for (size_type count = 0; count < object_size; count++) {
        const auto index{(start + count) % object_size};
        if (this->data[index].hash == key_hash &&
            this->data[index].first.size() == key.size()) {
          start = index + 1;
          return &this->data[index].second;
        }
      }
    } else {
      for (size_type count = 0; count < object_size; count++) {
        const auto index{(start + count) % object_size};
        if (this->data[index].hash == key_hash &&
            this->data[index].first == key) {
          start = index + 1;
          return &this->data[index].second;
        }
      }
    }
 
    return nullptr;
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  [[nodiscard]] inline auto try_at(T key, const hash_type key_hash,
                                   size_type &start) const
      -> const mapped_type * {
    assert(this->hash(key) == key_hash);
    const auto object_size{this->size()};
    assert(start <= object_size);
    if (this->hasher.is_perfect(key_hash)) {
      for (size_type count = 0; count < object_size; count++) {
        const auto index{(start + count) % object_size};
        if (this->data[index].hash == key_hash &&
            this->data[index].first.size() == key.size()) {
          start = index + 1;
          return &this->data[index].second;
        }
      }
    } else {
      for (size_type count = 0; count < object_size; count++) {
        const auto index{(start + count) % object_size};
        if (this->data[index].hash == key_hash &&
            this->data[index].first == key) {
          start = index + 1;
          return &this->data[index].second;
        }
      }
    }
 
    return nullptr;
  }

  auto try_emplace_before(const Key &key, const mapped_type &value,
                          const Key &suffix) -> hash_type {
    const auto key_hash{this->hash(key)};
    const auto suffix_hash{this->hash(suffix)};
 
    if (this->hasher.is_perfect(key_hash)) {
      for (auto iterator = this->data.begin(); iterator != this->data.end();
           ++iterator) {
        if (iterator->hash == key_hash &&
            iterator->first.size() == key.size()) {
          iterator->second = value;
          return key_hash;
        } else if (iterator->hash == suffix_hash && iterator->first == suffix) {
          this->data.insert(iterator, {key, value, key_hash});
          return key_hash;
        }
      }
    } else {
      for (auto iterator = this->data.begin(); iterator != this->data.end();
           ++iterator) {
        if (iterator->hash == key_hash && iterator->first == key) {
          iterator->second = value;
          return key_hash;
        } else if (iterator->hash == suffix_hash && iterator->first == suffix) {
          this->data.insert(iterator, {key, value, key_hash});
          return key_hash;
        }
      }
    }
 
    this->data.push_back({key, value, key_hash});
    return key_hash;
  }

  inline auto emplace(Key &&key, mapped_type &&value) -> hash_type {
    const auto key_hash{this->hash(key)};
 
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          entry.second = std::move(value);
          return key_hash;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          entry.second = std::move(value);
          return key_hash;
        }
      }
    }
 
    this->data.push_back({std::move(key), std::move(value), key_hash});
    return key_hash;
  }

  inline auto emplace(const Key &key, mapped_type &&value) -> hash_type {
    const auto key_hash{this->hash(key)};
 
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          entry.second = std::move(value);
          return key_hash;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          entry.second = std::move(value);
          return key_hash;
        }
      }
    }
 
    this->data.push_back({key, std::move(value), key_hash});
    return key_hash;
  }

  inline auto emplace(const Key &key, const mapped_type &value) -> hash_type {
    const auto key_hash{this->hash(key)};
 
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          entry.second = value;
          return key_hash;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          entry.second = value;
          return key_hash;
        }
      }
    }
 
    this->data.push_back({key, value, key_hash});
    return key_hash;
  }

  inline auto emplace_assume_new(Key &&key, mapped_type &&value) -> hash_type {
    const auto key_hash{this->hash(key)};
    this->data.push_back({std::move(key), std::move(value), key_hash});
    return key_hash;
  }

  inline auto emplace_assume_new(const Key &key, mapped_type &&value)
      -> hash_type {
    const auto key_hash{this->hash(key)};
    this->data.push_back({key, std::move(value), key_hash});
    return key_hash;
  }

  inline auto emplace_assume_new(Key &&key, mapped_type &&value,
                                 const hash_type key_hash) -> mapped_type & {
    this->data.push_back({std::move(key), std::move(value), key_hash});
    return this->data.back().second;
  }

  inline auto emplace_assume_new(const Key &key, mapped_type &&value,
                                 const hash_type key_hash) -> void {
    this->data.push_back({key, std::move(value), key_hash});
  }

  [[nodiscard]] inline auto back_key() const noexcept -> const Key & {
    assert(!this->data.empty());
    return this->data.back().first;
  }

  inline auto clear() noexcept -> void { this->data.clear(); }

  auto rename(const Key &key, const hash_type key_hash, Key &&to,
              const hash_type to_hash) -> void {
    this->erase(to, to_hash);
 
    if (this->hasher.is_perfect(key_hash)) {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first.size() == key.size()) {
          entry.first = std::move(to);
          entry.hash = to_hash;
          break;
        }
      }
    } else {
      for (auto &entry : this->data) {
        if (entry.hash == key_hash && entry.first == key) {
          entry.first = std::move(to);
          entry.hash = to_hash;
          break;
        }
      }
    }
  }

  auto erase(const Key &key, const hash_type key_hash) -> size_type {
    const auto current_size{this->size()};
 
    if (this->hasher.is_perfect(key_hash)) {
      for (auto iterator = this->data.begin(); iterator != this->data.end();
           ++iterator) {
        if (iterator->hash == key_hash &&
            iterator->first.size() == key.size()) {
          this->data.erase(iterator);
          return current_size - 1;
        }
      }
    } else {
      for (auto iterator = this->data.begin(); iterator != this->data.end();
           ++iterator) {
        if (iterator->hash == key_hash && iterator->first == key) {
          this->data.erase(iterator);
          return current_size - 1;
        }
      }
    }
 
    return current_size;
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  auto erase(T key, const hash_type key_hash) -> size_type {
    const auto current_size{this->size()};
 
    if (this->hasher.is_perfect(key_hash)) {
      for (auto iterator = this->data.begin(); iterator != this->data.end();
           ++iterator) {
        if (iterator->hash == key_hash &&
            iterator->first.size() == key.size()) {
          this->data.erase(iterator);
          return current_size - 1;
        }
      }
    } else {
      for (auto iterator = this->data.begin(); iterator != this->data.end();
           ++iterator) {
        if (iterator->hash == key_hash && iterator->first == key) {
          this->data.erase(iterator);
          return current_size - 1;
        }
      }
    }
 
    return current_size;
  }

  inline auto erase(const Key &key) -> size_type {
    return this->erase(key, this->hash(key));
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, KeyView>
  inline auto erase(T key) -> size_type {
    return this->erase(key, this->hash(key));
  }

  template <typename Compare> auto reorder(const Compare &compare) -> void {
    std::sort(this->data.begin(), this->data.end(),
              [&compare](const auto &left, const auto &right) -> auto {
                return compare(left.first, right.first);
              });
  }
 
private:
  friend Value;
// Exporting symbols that depends on the standard C++ library is considered
// safe.
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-2-c4275?view=msvc-170&redirectedfrom=MSDN
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
#endif
  static constexpr Hash hasher{};
  underlying_type data;
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif
};
 
} // namespace sourcemeta::core
 
#endif