/*

 * Copyright (c) 2022, Daniel Ehrenberg <dan@littledan.dev>

 * Copyright (c) 2022, Andrew Kaster <akaster@serenityos.org>

 * Copyright (c) 2024, Kenneth Myhra <kennethmyhra@serenityos.org>

 *

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

 */

#pragma once

#include <AK/Result.h>

#include <AK/Types.h>

#include <AK/Vector.h>

#include <LibIPC/Forward.h>

#include <LibJS/Forward.h>

#include <LibWeb/WebIDL/ExceptionOr.h>

// Structured serialize is an entirely different format from IPC because:

// - It contains representation of type information

// - It may contain circularities

// - It is restricted to JS values

namespace Web::HTML {

using SerializationRecord = Vector<u32>;

using SerializationMemory = HashMap<JS::Handle<JS::Value>, u32>;

using DeserializationMemory = JS::MarkedVector<JS::Value>;

struct TransferDataHolder {

    Vector<u8> data;

    Vector<IPC::File> fds;

};

struct SerializedTransferRecord {

    SerializationRecord serialized;

    Vector<TransferDataHolder> transfer_data_holders;

};

struct DeserializedTransferRecord {

    JS::Value deserialized;

    Vector<JS::Handle<JS::Object>> transferred_values;

};

struct DeserializedRecord {

    Optional<JS::Value> value;

    size_t position;

};

enum class TransferType : u8 {

    MessagePort,

};

WebIDL::ExceptionOr<SerializationRecord> structured_serialize(JS::VM& vm, JS::Value);

WebIDL::ExceptionOr<SerializationRecord> structured_serialize_for_storage(JS::VM& vm, JS::Value);

WebIDL::ExceptionOr<SerializationRecord> structured_serialize_internal(JS::VM& vm, JS::Value, bool for_storage, SerializationMemory&);

WebIDL::ExceptionOr<JS::Value> structured_deserialize(JS::VM& vm, SerializationRecord const& serialized, JS::Realm& target_realm, Optional<DeserializationMemory>);

WebIDL::ExceptionOr<DeserializedRecord> structured_deserialize_internal(JS::VM& vm, ReadonlySpan<u32> const& serialized, JS::Realm& target_realm, DeserializationMemory& memory, Optional<size_t> position = {});

void serialize_boolean_primitive(SerializationRecord& serialized, JS::Value& value);

void serialize_number_primitive(SerializationRecord& serialized, JS::Value& value);

WebIDL::ExceptionOr<void> serialize_big_int_primitive(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);

WebIDL::ExceptionOr<void> serialize_string_primitive(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);

void serialize_boolean_object(SerializationRecord& serialized, JS::Value& value);

void serialize_number_object(SerializationRecord& serialized, JS::Value& value);

WebIDL::ExceptionOr<void> serialize_big_int_object(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);

WebIDL::ExceptionOr<void> serialize_string_object(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);

void serialize_date_object(SerializationRecord& serialized, JS::Value& value);

WebIDL::ExceptionOr<void> serialize_reg_exp_object(JS::VM& vm, SerializationRecord& serialized, JS::Value& value);

template<typename T>

requires(IsIntegral<T> || IsFloatingPoint<T>)

void serialize_primitive_type(SerializationRecord& serialized, T value)

{

    if constexpr (sizeof(T) < sizeof(u32)) {

        // NOTE: If the value is smaller than a u32, we can just store it directly.

        serialized.append(static_cast<u32>(value));

        return;

    }

    serialized.append(bit_cast<u32*>(&value), sizeof(T) / 4);

}

Unexecuted instantiation: _ZN3Web4HTML24serialize_primitive_typeIjQoo10IsIntegralIT_E15IsFloatingPointIS2_EEEvRN2AK6VectorIjLm0EEES2_

Unexecuted instantiation: _ZN3Web4HTML24serialize_primitive_typeIbQoo10IsIntegralIT_E15IsFloatingPointIS2_EEEvRN2AK6VectorIjLm0EEES2_

Unexecuted instantiation: _ZN3Web4HTML24serialize_primitive_typeIdQoo10IsIntegralIT_E15IsFloatingPointIS2_EEEvRN2AK6VectorIjLm0EEES2_

Unexecuted instantiation: _ZN3Web4HTML24serialize_primitive_typeIlQoo10IsIntegralIT_E15IsFloatingPointIS2_EEEvRN2AK6VectorIjLm0EEES2_

Unexecuted instantiation: _ZN3Web4HTML24serialize_primitive_typeImQoo10IsIntegralIT_E15IsFloatingPointIS2_EEEvRN2AK6VectorIjLm0EEES2_

template<typename T>

requires(IsEnum<T>)

void serialize_enum(SerializationRecord& serialized, T value)

{

    serialize_primitive_type<UnderlyingType<T>>(serialized, to_underlying(value));

}

Unexecuted instantiation: _ZN3Web4HTML14serialize_enumINS0_9ErrorTypeEQ6IsEnumIT_EEEvRN2AK6VectorIjLm0EEES3_

Unexecuted instantiation: _ZN3Web4HTML14serialize_enumINS0_8ValueTagEQ6IsEnumIT_EEEvRN2AK6VectorIjLm0EEES3_

WebIDL::ExceptionOr<void> serialize_bytes(JS::VM& vm, Vector<u32>& vector, ReadonlyBytes bytes);

WebIDL::ExceptionOr<void> serialize_string(JS::VM& vm, Vector<u32>& vector, DeprecatedFlyString const& string);

WebIDL::ExceptionOr<void> serialize_string(JS::VM& vm, Vector<u32>& vector, String const& string);

WebIDL::ExceptionOr<void> serialize_string(JS::VM& vm, Vector<u32>& vector, JS::PrimitiveString const& primitive_string);

WebIDL::ExceptionOr<void> serialize_array_buffer(JS::VM& vm, Vector<u32>& vector, JS::ArrayBuffer const& array_buffer, bool for_storage);

template<OneOf<JS::TypedArrayBase, JS::DataView> ViewType>

WebIDL::ExceptionOr<void> serialize_viewed_array_buffer(JS::VM& vm, Vector<u32>& vector, ViewType const& view, bool for_storage, SerializationMemory& memory);

bool deserialize_boolean_primitive(ReadonlySpan<u32> const& serialized, size_t& position);

double deserialize_number_primitive(ReadonlySpan<u32> const& serialized, size_t& position);

JS::NonnullGCPtr<JS::BooleanObject> deserialize_boolean_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);

JS::NonnullGCPtr<JS::NumberObject> deserialize_number_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);

WebIDL::ExceptionOr<JS::NonnullGCPtr<JS::BigIntObject>> deserialize_big_int_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);

WebIDL::ExceptionOr<JS::NonnullGCPtr<JS::StringObject>> deserialize_string_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);

JS::NonnullGCPtr<JS::Date> deserialize_date_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);

WebIDL::ExceptionOr<JS::NonnullGCPtr<JS::RegExpObject>> deserialize_reg_exp_object(JS::Realm& realm, ReadonlySpan<u32> const& serialized, size_t& position);

template<typename T>

requires(IsIntegral<T> || IsFloatingPoint<T> || IsEnum<T>)

T deserialize_primitive_type(ReadonlySpan<u32> const& serialized, size_t& position)

{

    T value;

    // NOTE: Make sure we always round up, otherwise Ts that are less than 32 bit will end up with a size of 0.

    auto size = 1 + ((sizeof(value) - 1) / 4);

    VERIFY(position + size <= serialized.size());

    memcpy(&value, serialized.offset_pointer(position), sizeof(value));

    position += size;

    return value;

}

Unexecuted instantiation: _ZN3Web4HTML26deserialize_primitive_typeIjQoooo10IsIntegralIT_E15IsFloatingPointIS2_E6IsEnumIS2_EEES2_RKN2AK4SpanIKjEERm

Unexecuted instantiation: _ZN3Web4HTML26deserialize_primitive_typeIbQoooo10IsIntegralIT_E15IsFloatingPointIS2_E6IsEnumIS2_EEES2_RKN2AK4SpanIKjEERm

Unexecuted instantiation: _ZN3Web4HTML26deserialize_primitive_typeIdQoooo10IsIntegralIT_E15IsFloatingPointIS2_E6IsEnumIS2_EEES2_RKN2AK4SpanIKjEERm

Unexecuted instantiation: _ZN3Web4HTML26deserialize_primitive_typeIlQoooo10IsIntegralIT_E15IsFloatingPointIS2_E6IsEnumIS2_EEES2_RKN2AK4SpanIKjEERm

Unexecuted instantiation: _ZN3Web4HTML26deserialize_primitive_typeImQoooo10IsIntegralIT_E15IsFloatingPointIS2_E6IsEnumIS2_EEES2_RKN2AK4SpanIKjEERm

Unexecuted instantiation: _ZN3Web4HTML26deserialize_primitive_typeINS0_8ValueTagEQoooo10IsIntegralIT_E15IsFloatingPointIS3_E6IsEnumIS3_EEES3_RKN2AK4SpanIKjEERm

Unexecuted instantiation: _ZN3Web4HTML26deserialize_primitive_typeINS0_9ErrorTypeEQoooo10IsIntegralIT_E15IsFloatingPointIS3_E6IsEnumIS3_EEES3_RKN2AK4SpanIKjEERm

WebIDL::ExceptionOr<ByteBuffer> deserialize_bytes(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);

WebIDL::ExceptionOr<String> deserialize_string(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);

WebIDL::ExceptionOr<JS::NonnullGCPtr<JS::PrimitiveString>> deserialize_string_primitive(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);

WebIDL::ExceptionOr<JS::NonnullGCPtr<JS::BigInt>> deserialize_big_int_primitive(JS::VM& vm, ReadonlySpan<u32> vector, size_t& position);

WebIDL::ExceptionOr<SerializedTransferRecord> structured_serialize_with_transfer(JS::VM& vm, JS::Value value, Vector<JS::Handle<JS::Object>> const& transfer_list);

WebIDL::ExceptionOr<DeserializedTransferRecord> structured_deserialize_with_transfer(JS::VM& vm, SerializedTransferRecord&);

}

namespace IPC {

template<>

ErrorOr<void> encode(Encoder&, ::Web::HTML::SerializedTransferRecord const&);

template<>

ErrorOr<void> encode(Encoder&, ::Web::HTML::TransferDataHolder const&);

template<>

ErrorOr<::Web::HTML::SerializedTransferRecord> decode(Decoder&);

template<>

ErrorOr<::Web::HTML::TransferDataHolder> decode(Decoder&);

}