[LFC][IFC] Construct dedicated runs when the inline element requires it (part 2)
[WebKit-https.git] / Source / WebCore / layout / inlineformatting / InlineFormattingState.h
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
29
30 #include "FormattingState.h"
31 #include "InlineItem.h"
32 #include "InlineRun.h"
33 #include <wtf/IsoMalloc.h>
34 #include <wtf/OptionSet.h>
35
36 namespace WebCore {
37 namespace Layout {
38
39 // InlineFormattingState holds the state for a particular inline formatting context tree.
40 class InlineFormattingState : public FormattingState {
41     WTF_MAKE_ISO_ALLOCATED(InlineFormattingState);
42 public:
43     InlineFormattingState(Ref<FloatingState>&&, LayoutState&);
44     virtual ~InlineFormattingState();
45
46     std::unique_ptr<FormattingContext> formattingContext(const Box& formattingContextRoot) override;
47
48     InlineContent& inlineContent() { return m_inlineContent; }
49     InlineItem* lastInlineItem() const { return m_inlineContent.isEmpty() ? nullptr : m_inlineContent.last().get(); }
50
51     // DetachingRule indicates whether the inline element needs to be wrapped in a dediceted run or break from previous/next runs.
52     // <span>start</span><span style="position: relative;"> middle </span><span>end</span>
53     // input to line breaking -> <start middle end>
54     // output of line breaking (considering infinite constraint) -> <start middle end>
55     // due to the in-flow positioning, the final runs are: <start>< middle ><end>
56     // "start" -> n/a
57     // " middle " -> BreakAtStart and BreakAtEnd
58     // "end" -> n/a
59     //
60     // <span>parent </span><span style="padding: 10px;">start<span> middle </span>end</span><span> parent</span>
61     // input to line breaking -> <parent start middle end parent>
62     // output of line breaking (considering infinite constraint) -> <parent start middle end parent>
63     // due to padding, final runs -> <parent><start middle end><parent>
64     // "parent" -> n/a
65     // "start" -> BreakAtStart
66     // " middle " -> n/a
67     // "end" -> BreakAtEnd
68     // "parent" -> n/a
69     enum class DetachingRule {
70         BreakAtStart = 1 << 0,
71         BreakAtEnd = 1 << 1
72     };
73     using DetachingRules = OptionSet<DetachingRule>;
74     std::optional<DetachingRules> detachingRules(const Box& layoutBox) const;
75     void addDetachingRule(const Box& layoutBox, DetachingRules detachingRules) { m_detachingRules.set(&layoutBox, detachingRules); }
76
77     // Temp
78     InlineRuns& inlineRuns() { return m_inlineRuns; }
79     void appendInlineRun(InlineRun inlineRun) { m_inlineRuns.append(inlineRun); }
80
81 private:
82     using DetachingRulesForInlineItems = HashMap<const Box*, DetachingRules>;
83
84     InlineContent m_inlineContent;
85     InlineRuns m_inlineRuns;
86     DetachingRulesForInlineItems m_detachingRules;
87 };
88
89 }
90 }
91
92 SPECIALIZE_TYPE_TRAITS_LAYOUT_FORMATTING_STATE(InlineFormattingState, isInlineFormattingState())
93
94 #endif