json_value.h

#ifndef SOURCEMETA_CORE_JSON_VALUE_H_
#define SOURCEMETA_CORE_JSON_VALUE_H_
 
#ifndef SOURCEMETA_CORE_JSON_EXPORT
#include <sourcemeta/core/json_export.h>
#endif
 
#include <sourcemeta/core/json_array.h>
#include <sourcemeta/core/json_hash.h>
#include <sourcemeta/core/json_object.h>
 
#include <sourcemeta/core/numeric.h>
#include <sourcemeta/core/preprocessor.h>
 
#include <algorithm>        // std::any_of
#include <bitset>           // std::bitset
#include <cassert>          // assert
#include <cmath>            // std::modf, std::trunc, std::isinf, std::isnan
#include <concepts>         // std::same_as
#include <cstddef>          // std::size_t
#include <cstdint>          // std::int64_t, std::uint8_t
#include <functional>       // std::less, std::reference_wrapper, std::function
#include <initializer_list> // std::initializer_list
#include <limits>           // std::numeric_limits
#include <memory>           // std::allocator
#include <set>              // std::set
#include <span>             // std::span
#include <sstream>          // std::basic_istringstream
#include <stdexcept>        // std::out_of_range
#include <string>           // std::basic_string, std::char_traits
#include <string_view>      // std::basic_string_view
#include <type_traits>      // std::is_same_v, std::remove_cvref_t
#include <utility>          // std::pair
 
namespace sourcemeta::core {

class SOURCEMETA_CORE_JSON_EXPORT JSON {
public:
  using Char = char;
  using CharTraits = std::char_traits<Char>;
  using Integer = std::int64_t;
  using Real = double;
  template <typename T> using Allocator = std::allocator<T>;
  using String = std::basic_string<Char, CharTraits, Allocator<Char>>;
  using StringView = std::basic_string_view<Char, CharTraits>;
  using Array = JSONArray<JSON>;
  using Object = JSONObject<String, JSON, PropertyHashJSON<JSON::String>>;
  enum class ParsePhase : std::uint8_t {
    Pre,
    Post
  };
 
  // The enumeration indexes must stay in sync with the internal variant
  enum class Type : std::uint8_t {
    Null = 0,
    Boolean = 1,
    Integer = 2,
    Real = 3,
    String = 4,
    Array = 5,
    Object = 6,
    Decimal = 7
  };

  using TypeSet = std::bitset<8>;

  enum class ParseContext : std::uint8_t {
    Root,
    Property,
    Index
  };

  using ParseCallback = std::function<void(
      const ParsePhase phase, const Type type, const std::uint64_t line,
      const std::uint64_t column, const ParseContext context,
      const std::size_t index, const String &property)>;

  using KeyComparison = std::function<bool(const String &, const String &)>;
 
  /*
    Constructors
   */

  explicit JSON(const std::int64_t value);

  explicit JSON(const std::size_t value);

  explicit JSON(const int value);
 
  // On some systems, `std::int64_t` might be equal to `long`
  template <typename T = std::int64_t>
  explicit JSON(const long value)
    requires(!std::is_same_v<T, std::int64_t>)
      : current_type{Type::Integer} {
    this->data_integer = value;
  }

  explicit JSON(const double value);

  explicit JSON(const float value);

  explicit JSON(const bool value);

  explicit JSON(const std::nullptr_t);

  explicit JSON(const String &value);

  explicit JSON(String &&value);

  explicit JSON(const std::basic_string_view<Char, CharTraits> &value);

  explicit JSON(const Char *const value);

  explicit JSON(const Array &value);

  explicit JSON(std::initializer_list<typename Object::pair_value_type> values);

  explicit JSON(const Object &value);

  explicit JSON(const Decimal &value);

  explicit JSON(Decimal &&value);

  JSON(const JSON &);
  JSON(JSON &&) noexcept;
  auto operator=(const JSON &) -> JSON &;
  auto operator=(JSON &&) noexcept -> JSON &;

  ~JSON();

  static auto make_array() -> JSON;

  static auto make_array(std::initializer_list<JSON> values) -> JSON;

  static auto make_object() -> JSON;

  static auto size(const String &value) noexcept -> std::size_t;
 
  /*
   * Operators
   */
 
  auto operator<(const JSON &other) const -> bool;
  auto operator<=(const JSON &other) const -> bool;
  auto operator>(const JSON &other) const -> bool;
  auto operator>=(const JSON &other) const -> bool;

  auto operator==(const JSON &other) const -> bool;
  auto operator!=(const JSON &) const -> bool = default;

  auto operator+(const JSON &other) const -> JSON;

  auto operator-(const JSON &other) const -> JSON;

  auto operator+=(const JSON &additive) -> JSON &;

  auto operator-=(const JSON &substractive) -> JSON &;
 
  /*
   * Type checking
   */

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_boolean() const noexcept
      -> bool {
    return this->current_type == Type::Boolean;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_null() const noexcept
      -> bool {
    return this->current_type == Type::Null;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_integer() const noexcept
      -> bool {
    return this->current_type == Type::Integer;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_real() const noexcept
      -> bool {
    return this->current_type == Type::Real;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_integral() const noexcept
      -> bool {
    switch (this->type()) {
      case Type::Integer:
        return true;
      case Type::Real: {
        Real integral_part = 0.0;
        return std::modf(this->to_real(), &integral_part) == 0.0;
      }
      case Type::Decimal:
        return this->to_decimal().is_integral();
      default:
        return false;
    }
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_number() const noexcept
      -> bool {
    return this->is_integer() || this->is_real() || this->is_decimal();
  }

  [[nodiscard]] auto is_positive() const noexcept -> bool;

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_string() const noexcept
      -> bool {
    return this->current_type == Type::String;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_array() const noexcept
      -> bool {
    return this->current_type == Type::Array;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_object() const noexcept
      -> bool {
    return this->current_type == Type::Object;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto is_decimal() const noexcept
      -> bool {
    return this->current_type == Type::Decimal;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto type() const noexcept
      -> Type {
    return this->current_type;
  }
 
  /*
   * Type conversion
   */

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto to_boolean() const noexcept
      -> bool {
    assert(this->is_boolean());
    return this->data_boolean;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto to_integer() const noexcept
      -> Integer {
    assert(this->is_integer());
    return this->data_integer;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto to_real() const noexcept
      -> Real {
    assert(this->is_real());
    assert(!std::isinf(this->data_real));
    assert(!std::isnan(this->data_real));
    return this->data_real;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto to_decimal() const noexcept
      -> const Decimal & {
    assert(this->is_decimal());
    assert(this->data_decimal.is_finite());
    assert(!this->data_decimal.is_nan());
    return this->data_decimal;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto to_string() const noexcept
      -> const String & {
    assert(this->is_string());
    return this->data_string;
  }

  [[nodiscard]] auto to_stringstream() const
      -> std::basic_istringstream<Char, CharTraits, Allocator<Char>>;

  // TODO: Merge const/non-const overloads of as_array, as_object, at, front,
  // back using deducing this once Apple Clang supports it
  // (__cpp_explicit_this_parameter)
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto as_array() const noexcept
      -> const Array & {
    assert(this->is_array());
    return this->data_array;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto as_array() noexcept
      -> Array & {
    assert(this->is_array());
    return this->data_array;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto as_object() noexcept
      -> Object & {
    assert(this->is_object());
    return this->data_object;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto as_object() const noexcept
      -> const Object & {
    assert(this->is_object());
    return this->data_object;
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto as_real() const -> Real {
    assert(this->is_number());
    if (this->is_real()) {
      return this->to_real();
    } else if (this->is_integer()) {
      return static_cast<Real>(this->to_integer());
    } else {
      return this->to_decimal().to_double();
    }
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto as_integer() const
      -> Integer {
    assert(this->is_number());
    if (this->is_integer()) {
      return this->to_integer();
    } else if (this->is_real()) {
      const auto truncated{std::trunc(this->to_real())};
      if (truncated < static_cast<Real>(std::numeric_limits<Integer>::min()) ||
          truncated >= static_cast<Real>(std::numeric_limits<Integer>::max())) {
        throw std::out_of_range{
            "The real number does not fit in a 64-bit integer"};
      }
 
      return static_cast<Integer>(truncated);
    } else {
      const auto integral{this->to_decimal().to_integral()};
      if (!integral.is_int64()) {
        throw std::out_of_range{
            "The decimal number does not fit in a 64-bit integer"};
      }
 
      return integral.to_int64();
    }
  }
 
  /*
   * Getters
   */

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  at(const typename Array::size_type index) const -> const JSON & {
    assert(this->is_array());
    assert(index < this->size());
    return this->data_array.data.at(index);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  at(const typename Array::size_type index) -> JSON & {
    assert(this->is_array());
    assert(index < this->size());
    return this->data_array.data.at(index);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto at(const String &key) const
      -> const JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    const auto &object{this->data_object};
    return object.at(key, object.hash(key));
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto at(T key) const
      -> const JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    const auto &object{this->data_object};
    return object.at(key, object.hash(key));
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  at(const String &key, const typename Object::hash_type hash) const
      -> const JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    return this->data_object.at(key, hash);
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  at(T key, const typename Object::hash_type hash) const -> const JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    return this->data_object.at(key, hash);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto at(const String &key)
      -> JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    auto &object{this->data_object};
    return object.at(key, object.hash(key));
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto at(T key) -> JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    auto &object{this->data_object};
    return object.at(key, object.hash(key));
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  at(const String &key, const typename Object::hash_type hash) -> JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    return this->data_object.at(key, hash);
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  at(T key, const typename Object::hash_type hash) -> JSON & {
    assert(this->is_object());
    assert(this->defines(key));
    return this->data_object.at(key, hash);
  }

  [[nodiscard]] auto at_or(const String &key, const JSON &otherwise) const
      -> const JSON &;

  [[nodiscard]] auto at_or(const String &key, JSON &&otherwise) const
      -> const JSON & = delete;

  [[nodiscard]] auto at_or(const String &key,
                           const typename Object::hash_type hash,
                           const JSON &otherwise) const -> const JSON &;

  [[nodiscard]] auto at_or(const String &key,
                           const typename Object::hash_type hash,
                           JSON &&otherwise) const -> const JSON & = delete;

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto front() -> JSON & {
    assert(this->is_array());
    assert(!this->empty());
    return this->data_array.data.front();
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto front() const
      -> const JSON & {
    assert(this->is_array());
    assert(!this->empty());
    return this->data_array.data.front();
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto back() -> JSON & {
    assert(this->is_array());
    assert(!this->empty());
    return this->data_array.data.back();
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto back() const
      -> const JSON & {
    assert(this->is_array());
    assert(!this->empty());
    return this->data_array.data.back();
  }
 
  /*
   * Read operations
   */

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto size() const -> std::size_t {
    if (this->is_object()) {
      return this->object_size();
    } else if (this->is_array()) {
      return this->array_size();
    } else {
      return this->string_size();
    }
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto string_size() const
      -> std::size_t {
    assert(this->is_string());
    return JSON::size(this->data_string);
  }

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

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto object_size() const
      -> std::size_t {
    assert(this->is_object());
    return this->data_object.size();
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto byte_size() const
      -> std::size_t {
    assert(this->is_string());
    return this->data_string.size();
  }

  [[nodiscard]] auto estimated_byte_size() const -> std::uint64_t;

  [[nodiscard]] auto fast_hash() const -> std::uint64_t;

  [[nodiscard]] auto divisible_by(const JSON &divisor) const -> bool;

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto empty() const -> bool {
    if (this->is_object()) {
      return this->data_object.empty();
    } else if (this->is_array()) {
      return this->data_array.data.empty();
    } else {
      return this->data_string.empty();
    }
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  try_at(const String &key) const -> const JSON * {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.try_at(key, object.hash(key));
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto try_at(T key) const
      -> const JSON * {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.try_at(key, object.hash(key));
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  try_at(const String &key, const typename Object::hash_type hash) const
      -> const JSON * {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.try_at(key, hash);
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  try_at(T key, const typename Object::hash_type hash) const -> const JSON * {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.try_at(key, hash);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto try_at(const String &key)
      -> JSON * {
    assert(this->is_object());
    auto &object{this->data_object};
    return object.try_at(key, object.hash(key));
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto try_at(T key) -> JSON * {
    assert(this->is_object());
    auto &object{this->data_object};
    return object.try_at(key, object.hash(key));
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  try_at(const String &key, const typename Object::hash_type hash) -> JSON * {
    assert(this->is_object());
    return this->data_object.try_at(key, hash);
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  try_at(T key, const typename Object::hash_type hash) -> JSON * {
    assert(this->is_object());
    return this->data_object.try_at(key, hash);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  try_at(const String &key, const typename Object::hash_type hash,
         typename Object::size_type &start) const -> const JSON * {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.try_at(key, hash, start);
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  try_at(T key, const typename Object::hash_type hash,
         typename Object::size_type &start) const -> const JSON * {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.try_at(key, hash, start);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  defines(const String &key) const -> bool {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.defines(key, object.hash(key));
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto defines(T key) const
      -> bool {
    assert(this->is_object());
    const auto &object{this->data_object};
    return object.defines(key, object.hash(key));
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  defines(const String &key, const typename Object::hash_type hash) const
      -> bool {
    assert(this->is_object());
    return this->data_object.defines(key, hash);
  }

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  defines(T key, const typename Object::hash_type hash) const -> bool {
    assert(this->is_object());
    return this->data_object.defines(key, hash);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  defines(const typename Array::size_type index) const -> bool {
    return this->defines(std::to_string(index));
  }

  template <typename Iterator>
  [[nodiscard]] auto defines_any(Iterator begin, Iterator end) const -> bool {
    assert(this->is_object());
    return std::any_of(begin, end, [this](const auto &key) -> auto {
      return this->defines(key);
    });
  }

  [[nodiscard]] auto defines_any(std::initializer_list<String> keys) const
      -> bool;

  [[nodiscard]] auto contains(const JSON &element) const -> bool;

  [[nodiscard]] auto contains(const StringView element) const -> bool;

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  array_member_contains(const StringView key,
                        const typename Object::hash_type hash,
                        const StringView value) const -> bool {
    assert(this->is_object());
    const auto *member{this->try_at(key, hash)};
    return member != nullptr && member->is_array() && member->contains(value);
  }

  [[nodiscard]] SOURCEMETA_FORCEINLINE inline auto
  array_member_contains(const StringView key, const StringView value) const
      -> bool {
    return this->array_member_contains(key, Object::hash(key), value);
  }

  [[nodiscard]] auto is_array_of_strings() const -> bool {
    if (!this->is_array()) {
      return false;
    }
 
    for (const auto &element : this->as_array()) {
      if (!element.is_string()) {
        return false;
      }
    }
 
    return true;
  }

  [[nodiscard]] auto includes(const String &input) const -> bool;

  [[nodiscard]] auto includes(const String::value_type input) const -> bool;

  [[nodiscard]] auto unique() const -> bool;

  [[nodiscard]] auto unique_keys() const -> bool;
 
  /*
   * Write operations
   */

  auto push_back(const JSON &value) -> void;

  auto push_back(JSON &&value) -> void;

  auto push_back_if_unique(const JSON &value)
      -> std::pair<std::reference_wrapper<const JSON>, bool>;

  auto push_back_if_unique(JSON &&value)
      -> std::pair<std::reference_wrapper<const JSON>, bool>;

  auto assign(const String &key, const JSON &value) -> void;

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  auto assign(T key, const JSON &value) -> void {
    assert(this->is_object());
    this->data_object.emplace(String{key}, value);
  }

  auto assign(const String &key, JSON &&value) -> void;

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  auto assign(T key, JSON &&value) -> void {
    assert(this->is_object());
    this->data_object.emplace(String{key}, std::move(value));
  }

  auto try_assign_before(const String &key, const JSON &value,
                         const String &other) -> void;

  auto assign_if_missing(const String &key, const JSON &value) -> void;

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  auto assign_if_missing(T key, const JSON &value) -> void {
    assert(this->is_object());
    if (!this->defines(key)) {
      this->assign(key, value);
    }
  }

  auto assign_if_missing(const String &key, JSON &&value) -> void;

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  auto assign_if_missing(T key, JSON &&value) -> void {
    assert(this->is_object());
    if (!this->defines(key)) {
      this->assign(key, std::move(value));
    }
  }

  auto assign_assume_new(const String &key, JSON &&value) -> void;

  auto assign_assume_new(String &&key, JSON &&value) -> void;

  auto assign_assume_new(String &&key, JSON &&value, Object::hash_type hash)
      -> JSON &;

  SOURCEMETA_FORCEINLINE inline auto
  assign_if_nonempty(const StringView key,
                     const typename Object::hash_type hash,
                     const StringView value) -> void {
    if (!value.empty()) {
      this->assign_assume_new(String{key}, JSON{value}, hash);
    }
  }

  SOURCEMETA_FORCEINLINE inline auto assign_if_nonempty(const StringView key,
                                                        const StringView value)
      -> void {
    this->assign_if_nonempty(key, Object::hash(key), value);
  }

  auto assign_if_nonempty(const StringView key,
                          const typename Object::hash_type hash,
                          const std::span<const StringView> values) -> void {
    if (values.empty()) {
      return;
    }
 
    auto array{JSON::make_array()};
    for (const auto value : values) {
      array.push_back(JSON{value});
    }
 
    this->assign_assume_new(String{key}, std::move(array), hash);
  }

  auto assign_if_nonempty(const StringView key,
                          const std::span<const StringView> values) -> void {
    this->assign_if_nonempty(key, Object::hash(key), values);
  }

  auto erase(const String &key) -> typename Object::size_type;

  template <typename T>
    requires std::same_as<std::remove_cvref_t<T>, StringView>
  auto erase(T key) -> typename Object::size_type {
    assert(this->is_object());
    return this->data_object.erase(key);
  }

  template <typename Iterator>
  auto erase_keys(Iterator first, Iterator last) -> void {
    assert(this->is_object());
    for (auto iterator = first; iterator != last; ++iterator) {
      this->data_object.erase(*iterator);
    }
  }

  auto erase_keys(std::initializer_list<String> keys) -> void;

  auto erase(typename Array::const_iterator position) ->
      typename Array::iterator;

  auto erase(typename Array::const_iterator first,
             typename Array::const_iterator last) -> typename Array::iterator;

  auto erase_if(const std::function<bool(const JSON &)> &predicate) -> void;

  auto clear() -> void;

  template <typename Iterator>
  auto clear_except(Iterator first, Iterator last) -> void {
    assert(this->is_object());
    std::set<String, std::less<>, Allocator<String>> whitelist;
    for (auto iterator = first; iterator != last; ++iterator) {
      whitelist.insert(*iterator);
    }
 
    std::set<String, std::less<>, Allocator<String>> blacklist;
    for (const auto &pair : this->as_object()) {
      if (!whitelist.contains(pair.first)) {
        blacklist.insert(pair.first);
      }
    }
 
    this->erase_keys(blacklist.cbegin(), blacklist.cend());
  }

  auto clear_except(std::initializer_list<String> keys) -> void;

  auto merge(const JSON::Object &other) -> void;

  [[nodiscard]] auto trim() const -> JSON::String;

  auto trim() -> const JSON::String &;

  [[nodiscard]] auto is_trimmed() const noexcept -> bool;

  auto reorder(const KeyComparison &compare) -> void;
 
  /*
   * Transform operations
   */

  auto rename(const JSON::String &key, JSON::String &&to) -> void;

  auto into(const JSON &other) -> void;

  auto into(JSON &&other) noexcept -> void;

  auto into_array() -> void;

  auto into_object() -> void;
 
private:
  Type current_type = Type::Null;
 
// 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
  union {
    bool data_boolean;
    Integer data_integer;
    Real data_real;
    String data_string;
    Array data_array;
    Object data_object;
    Decimal data_decimal;
  };
 
  // Storing the decimal inline must not grow the union beyond its existing
  // footprint
  static_assert(sizeof(Decimal) <= sizeof(String));
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif
  auto maybe_destruct_union() -> void;
};
 
} // namespace sourcemeta::core
 
#endif