/*

 * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>

 * Copyright (c) 2020-2022, Linus Groh <linusg@serenityos.org>

 *

 * SPDX-License-Identifier: BSD-2-Clause

 */

#pragma once

#include <AK/Assertions.h>

#include <AK/Concepts.h>

#include <AK/Function.h>

#include <AK/Span.h>

#include <AK/Vector.h>

#include <LibJS/Runtime/Completion.h>

#include <LibJS/Runtime/GlobalObject.h>

#include <LibJS/Runtime/Object.h>

#include <LibJS/Runtime/VM.h>

namespace JS {

class Array : public Object {

    JS_OBJECT(Array, Object);

    JS_DECLARE_ALLOCATOR(Array);

public:

    static ThrowCompletionOr<NonnullGCPtr<Array>> create(Realm&, u64 length, Object* prototype = nullptr);

    static NonnullGCPtr<Array> create_from(Realm&, Vector<Value> const&);

    static NonnullGCPtr<Array> create_from(Realm&, ReadonlySpan<Value> const&);

    // Non-standard but equivalent to CreateArrayFromList.

    template<typename T>

    static NonnullGCPtr<Array> create_from(Realm& realm, ReadonlySpan<T> elements, Function<Value(T const&)> map_fn)

    {

        auto values = MarkedVector<Value> { realm.heap() };

        values.ensure_capacity(elements.size());

        for (auto const& element : elements)

            values.append(map_fn(element));

        return Array::create_from(realm, values);

    }

Unexecuted instantiation: JS::NonnullGCPtr<JS::Array> JS::Array::create_from<AK::String>(JS::Realm&, AK::Span<AK::String const>, AK::Function<JS::Value (AK::String const&)>)

Unexecuted instantiation: JS::NonnullGCPtr<JS::Array> JS::Array::create_from<unsigned char>(JS::Realm&, AK::Span<unsigned char const>, AK::Function<JS::Value (unsigned char const&)>)

Unexecuted instantiation: JS::NonnullGCPtr<JS::Array> JS::Array::create_from<AK::StringView>(JS::Realm&, AK::Span<AK::StringView const>, AK::Function<JS::Value (AK::StringView const&)>)

Unexecuted instantiation: JS::NonnullGCPtr<JS::Array> JS::Array::create_from<Locale::PluralCategory>(JS::Realm&, AK::Span<Locale::PluralCategory const>, AK::Function<JS::Value (Locale::PluralCategory const&)>)

Unexecuted instantiation: JS::NonnullGCPtr<JS::Array> JS::Array::create_from<Web::Bindings::KeyUsage>(JS::Realm&, AK::Span<Web::Bindings::KeyUsage const>, AK::Function<JS::Value (Web::Bindings::KeyUsage const&)>)

    virtual ~Array() override = default;

    virtual ThrowCompletionOr<Optional<PropertyDescriptor>> internal_get_own_property(PropertyKey const&) const override final;

    virtual ThrowCompletionOr<bool> internal_define_own_property(PropertyKey const&, PropertyDescriptor const&, Optional<PropertyDescriptor>* precomputed_get_own_property = nullptr) override final;

    virtual ThrowCompletionOr<bool> internal_delete(PropertyKey const&) override;

    virtual ThrowCompletionOr<MarkedVector<Value>> internal_own_property_keys() const override final;

    [[nodiscard]] bool length_is_writable() const { return m_length_writable; }

protected:

    explicit Array(Object& prototype);

private:

    ThrowCompletionOr<bool> set_length(PropertyDescriptor const&);

    bool m_length_writable { true };

};

enum class Holes {

    SkipHoles,

    ReadThroughHoles,

};

ThrowCompletionOr<MarkedVector<Value>> sort_indexed_properties(VM&, Object const&, size_t length, Function<ThrowCompletionOr<double>(Value, Value)> const& sort_compare, Holes holes);

ThrowCompletionOr<double> compare_array_elements(VM&, Value x, Value y, FunctionObject* comparefn);

}