/*
 * Copyright (c) 2020-2022, Andreas Kling <andreas@ladybird.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/OwnPtr.h>
#include <LibWeb/Forward.h>
#include <LibWeb/Layout/AvailableSpace.h>
#include <LibWeb/Layout/LayoutInput.h>
#include <LibWeb/Layout/LayoutState.h>

namespace Web::Layout {

// NOTE: We use a custom clamping function here instead of AK::clamp(), since the AK version
//       will VERIFY(max >= min) and CSS explicitly allows that (see css-values-4.)
template<typename T>
[[nodiscard]] constexpr T css_clamp(T const& value, T const& min, T const& max)
{
    return ::max(min, ::min(value, max));
}

enum class Alignment {
    Baseline,
    Center,
    End,
    Normal,
    Safe,
    SelfEnd,
    SelfStart,
    SpaceAround,
    SpaceBetween,
    SpaceEvenly,
    Start,
    Stretch,
    Unsafe,
};

enum class AbsposAxisMode {
    // Both insets auto: offset = static_position + margin
    StaticPosition,
    // At least one explicit inset: offset = rect.origin + inset + margin
    InsetFromRect,
};

enum class TableWrapperWidthMode {
    ClampToAvailableWidth,
    UseTableUsedWidthIfNotAuto,
};

struct AbsposContainingBlockInfo {
    // Containing block rect in CB Box's content-edge coordinates.
    CSSPixelRect rect;
    AbsposAxisMode horizontal_axis_mode;
    AbsposAxisMode vertical_axis_mode;
    // Grid alignment for axes with auto CSS insets.
    // When set, the base method applies alignment-driven insets after sizing.
    Optional<Alignment> horizontal_alignment;
    Optional<Alignment> vertical_alignment;
};

class FormattingContext {
#if FORMATTING_CONTEXT_TRACE_DEBUG
    friend class FormattingContextTracer;
#endif

public:
    virtual ~FormattingContext();

    enum class Type {
        Block,
        Inline,
        Flex,
        Grid,
        Table,
        SVG,
        ReplacedWithChildren,
        InternalReplaced, // Internal hack formatting context for replaced elements. FIXME: Get rid of this.
        InternalDummy,    // Internal hack formatting context for unimplemented things. FIXME: Get rid of this.
    };

    static constexpr StringView type_name(Type type)
    {
        switch (type) {
        case Type::Block:
            return "BFC"sv;
        case Type::Inline:
            return "IFC"sv;
        case Type::Flex:
            return "FFC"sv;
        case Type::Grid:
            return "GFC"sv;
        case Type::Table:
            return "TFC"sv;
        case Type::SVG:
            return "SVG"sv;
        case Type::ReplacedWithChildren:
            return "Replaced, with children"sv;
        case Type::InternalReplaced:
            return "Replaced"sv;
        case Type::InternalDummy:
            return "Dummy"sv;
        }
        VERIFY_NOT_REACHED();
    }

    // https://drafts.csswg.org/css-align-3/#baseline-export
    enum class BaselineSet : u8 {
        First,
        Last,
    };

    virtual void run(LayoutInput const&) = 0;

    // These functions return the automatic content dimensions of the context's root box.
    virtual CSSPixels automatic_content_width() const = 0;
    virtual CSSPixels automatic_content_height() const = 0;

    Box const& context_box() const { return m_context_box; }

    FormattingContext* parent() { return m_parent; }
    FormattingContext const* parent() const { return m_parent; }

    Type type() const { return m_type; }

    virtual bool inhibits_floating() const { return false; }

    [[nodiscard]] static Optional<Type> formatting_context_type_created_by_box(Box const&);

    // The box whose formatting context lays out `child` if `child` is absolutely
    // positioned: the closest formatting context root at or above its containing block.
    [[nodiscard]] static Box const& box_establishing_containing_formatting_context(Box const& child);

    static bool creates_block_formatting_context(Box const&);

    CSSPixels compute_table_box_width_inside_table_wrapper(Box const&, AvailableSpace const&,
        ContainingBlockConstraints const& table_wrapper_constraints,
        Optional<CSSPixels> table_wrapper_containing_block_width = {},
        TableWrapperWidthMode = TableWrapperWidthMode::ClampToAvailableWidth);
    CSSPixels compute_table_box_height_inside_table_wrapper(Box const&, AvailableSpace const&, ContainingBlockConstraints const& table_wrapper_constraints);

    CSSPixels compute_width_for_replaced_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&) const;
    CSSPixels compute_height_for_replaced_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&) const;

    OwnPtr<FormattingContext> create_independent_formatting_context_if_needed(LayoutState&, LayoutMode, Box const& child_box);
    NonnullOwnPtr<FormattingContext> create_independent_formatting_context(LayoutState&, LayoutMode, Box const& child_box);

    [[nodiscard]] static ContainingBlockConstraints constraints_for_child_context(
        LayoutState::UsedValues const& containing_block_used_values,
        ContainingBlockConstraints const& containing_block_constraints);

    [[nodiscard]] static LayoutInput layout_input_for_child_context(
        LayoutState::UsedValues const& containing_block_used_values,
        LayoutInput const& containing_block_layout_input,
        AvailableSpace available_space);

    virtual void parent_context_did_dimension_child_root_box() { }

    void place_child(Box const& child, CSSPixelPoint content_offset);

    CSSPixels calculate_min_content_width(Layout::Box const&, ContainingBlockConstraints const&) const;
    CSSPixels calculate_max_content_width(Layout::Box const&, ContainingBlockConstraints const&) const;
    CSSPixels calculate_min_content_height(Layout::Box const&, CSSPixels width, ContainingBlockConstraints const&) const;
    CSSPixels calculate_max_content_height(Layout::Box const&, CSSPixels width, ContainingBlockConstraints const&) const;

    CSSPixels calculate_fit_content_height(Layout::Box const&, AvailableSpace const&, ContainingBlockConstraints const&) const;
    CSSPixels calculate_fit_content_width(Layout::Box const&, AvailableSpace const&, ContainingBlockConstraints const&) const;

    CSSPixels calculate_inner_width(Layout::Box const&, AvailableSize const&, CSS::Size const& width, ContainingBlockConstraints const&) const;
    [[nodiscard]] CSSPixels calculate_inner_height(Box const&, AvailableSpace const&, CSS::Size const& height, ContainingBlockConstraints const&) const;

    virtual CSSPixels greatest_child_width(Box const&) const;

    [[nodiscard]] static CSSPixelRect margin_box_rect(LayoutState::UsedValues const&);
    [[nodiscard]] CSSPixelRect margin_box_rect_in_ancestor_coordinate_space(Box const&, Box const& ancestor_box) const;
    [[nodiscard]] CSSPixelRect margin_box_rect_in_ancestor_coordinate_space(LayoutState::UsedValues const&, Box const& ancestor_box) const;
    [[nodiscard]] CSSPixelRect content_box_rect(Box const&) const;
    [[nodiscard]] CSSPixelRect content_box_rect(LayoutState::UsedValues const&) const;
    [[nodiscard]] CSSPixelRect content_box_rect_in_ancestor_coordinate_space(LayoutState::UsedValues const&, Box const& ancestor_box) const;
    [[nodiscard]] CSSPixels box_baseline(Box const&, BaselineSet) const;
    void compute_and_store_baselines(LayoutState::UsedValues&) const;

    [[nodiscard]] CSSPixels calculate_stretch_fit_width(Box const&, AvailableSize const&) const;
    [[nodiscard]] CSSPixels calculate_stretch_fit_height(Box const&, AvailableSize const&) const;

    bool can_skip_is_anonymous_text_run(Box&);

    void compute_inset(NodeWithStyleAndBoxModelMetrics const&, CSSPixelSize containing_block_size);

protected:
    FormattingContext(Type, LayoutMode, LayoutState&, Box const&, FormattingContext* parent = nullptr);

    [[nodiscard]] static bool computed_height_establishes_definite_containing_block_height(CSS::Size const&);
    [[nodiscard]] Optional<CSSPixels> calculate_transferred_width_for_replaced_element(Layout::Box const&, ContainingBlockConstraints const&) const;

    [[nodiscard]] bool should_treat_width_as_auto(Box const&, AvailableSpace const&) const;
    [[nodiscard]] bool should_treat_height_as_auto(Box const&, AvailableSpace const&, ContainingBlockConstraints const&) const;

    [[nodiscard]] bool should_treat_max_width_as_none(Box const&, AvailableSize const&, ContainingBlockConstraints const&) const;
    [[nodiscard]] bool should_treat_max_height_as_none(Box const&, AvailableSize const&, ContainingBlockConstraints const&) const;

    [[nodiscard]] bool box_is_sized_as_replaced_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&) const;

    enum class CyclicPercentageIntrinsicContribution {
        NotCyclic,
        ResolveAsZero,
        TreatAsInitialValue,
    };
    // CSS Sizing resolves cyclic percentages differently for minimum sizes than for preferred/max sizes.
    // In particular, replaced boxes resolve cyclic preferred/max sizes against zero for min-content
    // contributions, while cyclic min sizes are treated as their initial value.
    enum class CyclicPercentageSizeProperty {
        PreferredOrMaxSize,
        MinSize,
    };
    [[nodiscard]] CyclicPercentageIntrinsicContribution cyclic_percentage_intrinsic_contribution(Box const&, CSS::Size const&, AvailableSize const&, CyclicPercentageSizeProperty) const;

    OwnPtr<FormattingContext> layout_inside(Box const&, LayoutMode, LayoutInput const&);

    struct SpaceUsedByFloats {
        CSSPixels left { 0 };
        CSSPixels right { 0 };
    };

    struct ShrinkToFitResult {
        CSSPixels preferred_width { 0 };
        CSSPixels preferred_minimum_width { 0 };
    };

    CSSPixels tentative_width_for_replaced_element(Box const&, CSS::Size const& computed_width, AvailableSpace const&, ContainingBlockConstraints const&) const;
    CSSPixels tentative_height_for_replaced_element(Box const&, CSS::Size const& computed_height, AvailableSpace const&, ContainingBlockConstraints const&) const;
    CSSPixels compute_auto_height_for_block_formatting_context_root(Box const&) const;
    static CSSPixels line_box_physical_width(Box const&, LineBox const&);

    CSSPixels measure_automatic_content_height(Box const&, AvailableSpace const& inner_available_space, ContainingBlockConstraints const&);
    void make_button_content_box_definite(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, Optional<CSSPixels> measured_content_height = {});

    [[nodiscard]] CSSPixelSize solve_replaced_size_constraint(CSSPixels input_width, CSSPixels input_height, Box const&, AvailableSpace const&, ContainingBlockConstraints const&) const;

    ShrinkToFitResult calculate_shrink_to_fit_widths(Box const&, ContainingBlockConstraints const&);

    void layout_absolutely_positioned_element(Box&, StaticPositionRect const&);

    CSSPixels gap_to_px(Variant<CSS::LengthPercentage, CSS::NormalGap> const& gap, CSSPixels reference_value) const;

    void register_contained_abspos_child(Box const& child, StaticPositionRect const&);
    [[nodiscard]] static CSSPixelPoint aligned_static_position(StaticPositionRect const&, LayoutState::UsedValues const&);
    void layout_absolutely_positioned_children();
    void layout_absolutely_positioned_children(Box const&);
    virtual AbsposContainingBlockInfo resolve_abspos_containing_block_info(Box const&);
    void resolve_anchor_insets(Box&) const;
    void compute_width_for_absolutely_positioned_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, StaticPositionRect const&);
    void compute_width_for_absolutely_positioned_non_replaced_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, StaticPositionRect const&);
    void compute_width_for_absolutely_positioned_replaced_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, StaticPositionRect const&);

    enum class BeforeOrAfterInsideLayout {
        Before,
        After,
    };
    void compute_height_for_absolutely_positioned_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, StaticPositionRect const&, BeforeOrAfterInsideLayout);
    void compute_height_for_absolutely_positioned_non_replaced_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, StaticPositionRect const&, BeforeOrAfterInsideLayout);
    void compute_height_for_absolutely_positioned_replaced_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, StaticPositionRect const&, BeforeOrAfterInsideLayout);

    [[nodiscard]] Optional<CSSPixels> compute_auto_height_for_absolutely_positioned_element(Box const&, AvailableSpace const&, ContainingBlockConstraints const&, BeforeOrAfterInsideLayout) const;

    Type m_type {};
    LayoutMode m_layout_mode;

    FormattingContext* m_parent { nullptr };
    Box const& m_context_box;

    LayoutState& m_state;
};

#if FORMATTING_CONTEXT_TRACE_DEBUG
class FormattingContextTracer {
public:
    FormattingContextTracer(FormattingContext const& fc, AvailableSpace const& available_space)
    {
        StringBuilder indent_builder;
        for (int i = 0; i < s_depth; ++i)
            indent_builder.append("| "sv);
        auto intrinsic_marker = fc.m_layout_mode == LayoutMode::IntrinsicSizing ? " [intrinsic]"sv : ""sv;
        dbgln("{}|- {} <{}> run({}){}", indent_builder.string_view(), FormattingContext::type_name(fc.m_type), fc.m_context_box.debug_description(), available_space, intrinsic_marker);
        ++s_depth;
    }

    ~FormattingContextTracer()
    {
        --s_depth;
    }

private:
    inline static int s_depth = 0;
};

#    define FORMATTING_CONTEXT_TRACE() FormattingContextTracer _formatting_context_tracer(*this, available_space)
#else
#    define FORMATTING_CONTEXT_TRACE()
#endif

}