/*
 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
 * Copyright (C) 2003-2021 Apple Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#pragma once

#include "RenderBox.h"

namespace WebCore {

class CSSRegisteredCounterStyle;
class RenderBlockFlow;
class RenderListItem;
class StyleRuleCounterStyle;

struct ListMarkerTextContent {
    String textWithSuffix;
    uint32_t textWithoutSuffixLength { 0 };
    TextDirection textDirection { TextDirection::LTR };
    bool isEmpty() const
    {
        return textWithSuffix.isEmpty();
    }

    StringView textWithoutSuffix() const LIFETIME_BOUND
    {
        return StringView { textWithSuffix }.left(textWithoutSuffixLength);
    }

    StringView suffix() const LIFETIME_BOUND
    {
        return StringView { textWithSuffix }.substring(textWithoutSuffixLength);
    }
};

// Used to render the list item's marker.
// The RenderListMarker always has to be a child of a RenderListItem.
class RenderListMarker final : public RenderBox {
    WTF_MAKE_TZONE_ALLOCATED(RenderListMarker);
    WTF_OVERRIDE_DELETE_FOR_CHECKED_PTR(RenderListMarker);
public:
    RenderListMarker(RenderListItem&, Style::ComputedStyle&&);
    virtual ~RenderListMarker();

    String textWithoutSuffix() const { return m_textContent.textWithoutSuffix().toString(); };
    String textWithSuffix() const { return m_textContent.textWithSuffix; };

    bool NODELETE isInside() const;
    bool isDisclosureMarker() const;

    void updateInlineMarginsAndContent();

    bool isImage() const final;

    // True when the ::marker's `content` property generates the marker box contents
    // (css-lists-3 §3.3). In that case the contents live in an anonymous inline-block
    // child (contentContainer()) that this marker lays out and paints itself.
    bool hasContent() const;
    RenderBlockFlow* contentContainer() const;

    LayoutUnit lineLogicalOffsetForListItem() const { return m_lineLogicalOffsetForListItem; }
    const RenderListItem* NODELETE listItem() const;

    std::pair<float, float> layoutBounds() const { return m_layoutBounds; }

    bool shouldCollapseAnonymousBlockParent() const { return m_shouldCollapseAnonymousBlockParent; }
    void setShouldCollapseAnonymousBlockParent(bool value)
    {
        if (value) {
            ASSERT(parent());
            ASSERT(parent()->isAnonymousBlock());
            ASSERT(!isInside());
        }
        m_shouldCollapseAnonymousBlockParent = value;
    }

private:
    void willBeDestroyed() final;
    ASCIILiteral renderName() const final { return "RenderListMarker"_s; }
    void computeIntrinsicLogicalWidthContributions() final;
    bool canHaveChildren() const final { return hasContent(); }
    void paint(PaintInfo&, const LayoutPoint&) final;
    void layout() final;
    void imageChanged(WrappedImagePtr, const IntRect*) final;
    LayoutRect NODELETE selectionRectForRepaint(const RenderLayerModelObject* repaintContainer, bool clipToVisibleContent) final;
    bool canBeSelectionLeaf() const final { return true; }
    void styleWillChange(Style::Difference, const Style::ComputedStyle& newStyle) final;
    void styleDidChange(Style::Difference, const Style::ComputedStyle* oldStyle) final;
    Node* nodeForHitTest() const final;
    std::pair<LayoutUnit, LayoutUnit> computeIntrinsicLogicalWidths() const override { ASSERT_NOT_REACHED(); return { }; }
    std::pair<float, float> layoutBoundForTextContent(String) const;

    void element() const = delete;

    void updateInlineMargins();
    void updateContent();
    RenderBox* parentBox(RenderBox&);
    void layoutContentContainer(RenderBlockFlow&);

    FloatRect relativeMarkerRect();
    LayoutRect NODELETE localSelectionRect();
    void paintDisclosureMarker(GraphicsContext&, const FloatRect& markerRect);

    RefPtr<CSSRegisteredCounterStyle> counterStyle() const;
    bool widthUsesMetricsOfPrimaryFont() const;

private:
    ListMarkerTextContent m_textContent;
    RefPtr<Style::Image> m_image;

    SingleThreadWeakPtr<RenderListItem> m_listItem;
    LayoutUnit m_lineOffsetForListItem;
    LayoutUnit m_lineLogicalOffsetForListItem;
    std::pair<float, float> m_layoutBounds;
    bool m_shouldCollapseAnonymousBlockParent { false };
};

} // namespace WebCore

SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderListMarker, isRenderListMarker())
