/*
 * Copyright (C) 2024 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <WebCore/CSSValueKeywords.h>
#include <WebCore/EventTarget.h>
#include <WebCore/LayoutPoint.h>
#include <WebCore/LayoutSize.h>
#include <WebCore/LayoutUnit.h>
#include <WebCore/PositionTryOrder.h>
#include <WebCore/PseudoElementIdentifier.h>
#include <WebCore/ResolvedScopedName.h>
#include <WebCore/ScopedName.h>
#include <WebCore/Styleable.h>
#include <WebCore/WritingMode.h>
#include <wtf/HashMap.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/Vector.h>
#include <wtf/WeakHashMap.h>
#include <wtf/WeakHashSet.h>
#include <wtf/text/AtomStringHash.h>

namespace WebCore {

class Document;
class Element;
class LayoutPoint;
class LayoutRect;
class LayoutSize;
class RenderBlock;
class RenderBox;
class RenderBoxModelObject;
class RenderLayerModelObject;
class RenderElement;
class RenderView;

enum CSSPropertyID : uint16_t;

namespace Style {
class ComputedStyle;
}

struct AnchorScrollSnapshot {
    SingleThreadWeakPtr<const RenderBox> m_scroller;
    LayoutPoint m_scrollSnapshot { };
    inline LayoutSize adjustmentForCurrentScrollPosition() const;
    AnchorScrollSnapshot(const RenderBox& scroller, LayoutPoint snapshot);
    AnchorScrollSnapshot(LayoutPoint snapshot);
    bool operator==(const AnchorScrollSnapshot&) const = default;
};

class AnchorStickySnapshot {
    SingleThreadWeakPtr<const RenderBoxModelObject> m_sticky;
    LayoutSize m_stickySnapshot { };
public:
    inline LayoutSize adjustmentForCurrentScrollPosition() const;
    AnchorStickySnapshot(const RenderBoxModelObject& sticky, LayoutSize snapshot);
    bool operator==(const AnchorStickySnapshot&) const = default;
};

class AnchorScrollAdjuster {
public:
    AnchorScrollAdjuster(RenderBox& anchored, const RenderBoxModelObject& defaultAnchor);
    RenderBox* NODELETE anchored() const;

    inline bool NODELETE isEmpty() const;
    bool mayNeedAdjustment() const { return m_needsXAdjustment | m_needsYAdjustment; }
    bool mayNeedXAdjustment() const { return m_needsXAdjustment; }
    bool mayNeedYAdjustment() const { return m_needsYAdjustment; }

    bool isHidden() const { return m_isHidden; }
    void setHidden(bool hide) { m_isHidden = hide; }

    inline void addScrollSnapshot(const RenderBox& scroller);
    enum Direction : int8_t { Normal = 1, Reverse = -1 };
    inline void addViewportSnapshot(const RenderView&, Direction = Reverse);
    bool hasViewportSnapshot() const { return m_adjustmentForViewport; }

    inline void addStickySnapshot(const RenderBoxModelObject& sticky);

    enum Diff : uint8_t { New, SnapshotsDiffer, SnapshotsMatch };
    bool NODELETE recaptureDiffers(const AnchorScrollAdjuster&) const; // Snapshot differences can require invalidation.
    void removeMatchingSnapshots(const AnchorScrollAdjuster&);

    void setFallbackLimits(const RenderBox& anchored);
    bool hasFallbackLimits() const { return m_hasFallback; }
    bool exceedsFallbackLimits(LayoutSize adjustment) { return !m_fallbackLimits.fits(adjustment); }

    LayoutSize accumulateAdjustments(const RenderView&, const RenderBox& anchored) const;

    bool invalidateForScroller(const RenderBox& scroller);
private:
    LayoutSize adjustmentForViewport(const RenderView&) const;

    CheckedRef<RenderBox> m_anchored;
    Vector<AnchorScrollSnapshot, 1> m_scrollSnapshots;
    Vector<AnchorStickySnapshot> m_stickySnapshots;
    int8_t m_adjustmentForViewport { 0 }; /* Boolean and directional multiplier. */
    bool m_needsXAdjustment : 1 { false };
    bool m_needsYAdjustment : 1 { false };
    bool m_hasChainedAnchor : 1 { false };
    bool m_isHidden : 1 { false };
    bool m_hasFallback : 1 { false };
    LayoutSizeLimits m_fallbackLimits;
};

namespace Style {

class BuilderState;
struct BuilderPositionTryFallback;

enum class AnchorPositionResolutionStage : uint8_t {
    // Initial state, we've found which anchors the element uses, but we haven't
    // resolved anchor names to the concrete elements.
    FindAnchors,

    // State when an anchor-positioned element has resolved its anchors,
    // but its anchor(s) is/are also anchor-positioned. The element waits
    // here until the its anchor(s) is/are Positioned, in which case it'll
    // transition to Resolved.
    WaitingForAnchorToBePositioned,

    // The anchor-positioned element has resolved the anchors it refers to, and
    // the anchors are also at Positioned stage, if they themselves are anchor-positioned.
    Resolved,

    // The anchor-positioned element has been laid out and its position determined.
    // This occurs after a Resolved element went through the layout process.
    Positioned,
};

using AnchorElements = HashMap<ResolvedScopedName, WeakPtr<Element, WeakPtrImplWithEventTargetData>>;

struct AnchorPositionedState {
    AnchorElements anchorElements;
    HashSet<ResolvedScopedName> anchorNames;
    AnchorPositionResolutionStage stage;

    WTF_MAKE_STRUCT_TZONE_ALLOCATED(AnchorPositionedState);
};

using AnchorPositionedStates = HashMap<WeakStyleable, UniqueRef<AnchorPositionedState>>;

using AnchorsForAnchorName = HashMap<ResolvedScopedName, Vector<SingleThreadWeakRef<const RenderBoxModelObject>>>;

// https://drafts.csswg.org/css-anchor-position-1/#typedef-anchor-size
enum class AnchorSizeDimension : uint8_t {
    Width,
    Height,
    Block,
    Inline,
    SelfBlock,
    SelfInline
};

struct ResolvedAnchor {
    SingleThreadWeakPtr<RenderBoxModelObject> renderer;
    ResolvedScopedName name;
};

struct AnchorPositionedToAnchorEntry {
    Vector<ResolvedAnchor> anchors;

    // True if all anchors above have been laid out and positioned.
    // Only then can this anchor-positioned element be positioned.
    bool allAnchorsPositioned { false };

    WTF_MAKE_STRUCT_TZONE_ALLOCATED(AnchorPositionedToAnchorEntry);
};

using AnchorPositionedToAnchorMap = HashMap<WeakStyleable, AnchorPositionedToAnchorEntry>;
using AnchorToAnchorPositionedMap = SingleThreadWeakHashMap<const RenderBoxModelObject, Vector<Ref<Element>>>;

class AnchorPositionEvaluator {
public:
    using Side = Variant<CSSValueID, double>;
    static bool propertyAllowsAnchorFunction(CSSPropertyID);
    static std::optional<double> evaluate(BuilderState&, std::optional<ScopedName> elementName, Side);

    static bool propertyAllowsAnchorSizeFunction(CSSPropertyID);
    static std::optional<double> evaluateSize(BuilderState&, std::optional<ScopedName> elementName, std::optional<AnchorSizeDimension>);

    static void updateAnchorPositioningStatesAfterInterleavedLayout(Document&, AnchorPositionedStates&);
    static void updateScrollAdjustments(RenderView&);
    static void updateAnchorPositionedStateForDefaultAnchorAndPositionVisibility(Element&, const Style::ComputedStyle&, AnchorPositionedStates&);

    static LayoutRect computeAnchorRectRelativeToContainingBlock(CheckedRef<const RenderBoxModelObject> anchorBox, const RenderLayerModelObject& containingBlock, const RenderBox& anchoredBox);
    static void captureScrollSnapshots(RenderBox& anchored, bool invalidateStyleForScrollPositionChanges = true);

    static AnchorToAnchorPositionedMap makeAnchorPositionedForAnchorMap(AnchorPositionedToAnchorMap&);

    static bool NODELETE isAnchorPositioned(const Style::ComputedStyle&);
    static bool NODELETE isStyleTimeAnchorPositioned(const Style::ComputedStyle&);
    static bool NODELETE isLayoutTimeAnchorPositioned(const Style::ComputedStyle&);

    static CSSPropertyID resolvePositionTryFallbackProperty(CSSPropertyID, WritingMode, const BuilderPositionTryFallback&);
    static CSSValueID resolvePositionTryFallbackValueForSelfPosition(CSSPropertyID, CSSValueID, WritingMode, const BuilderPositionTryFallback&);

    static bool overflowsInsetModifiedContainingBlock(const RenderBox& anchoredBox);
    static bool isDefaultAnchorInvisibleOrClippedByInterveningBoxes(const RenderBox& anchoredBox);

    static ScopedName defaultAnchorName(const Style::ComputedStyle&);
    static bool isAnchor(const Style::ComputedStyle&);
    static bool isImplicitAnchor(const Style::ComputedStyle&);

    static CheckedPtr<RenderBoxModelObject> defaultAnchorForBox(const RenderBox&);

    static HashMap<WeakStyleable, size_t> recordLastSuccessfulPositionOptions(const SingleThreadWeakHashSet<const RenderBox>& positionTryBoxes);

private:
    static CheckedPtr<RenderBoxModelObject> findAnchorForAnchorFunctionAndAttemptResolution(BuilderState&, std::optional<ScopedName> elementName);
    static RefPtr<const Element> anchorPositionedElementOrPseudoElement(BuilderState&);
    static void addAnchorFunctionScrollCompensatedAxis(Style::ComputedStyle&, const RenderBox& anchored, const RenderBoxModelObject& anchor, BoxAxis);
    static LayoutSize scrollOffsetFromAnchor(const RenderBoxModelObject& anchor, const RenderBox& anchored);
};

} // namespace Style

} // namespace WebCore
