febf3c36d911e680d5ca85a46a7b2891ea17abeb
[WebKit-https.git] / Source / WebCore / rendering / RenderRubyRun.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #pragma once
32
33 #include "RenderBlockFlow.h"
34
35 namespace WebCore {
36
37 class RenderRubyBase;
38 class RenderRubyText;
39
40 // RenderRubyRuns are 'inline-block/table' like objects, and wrap a single pairing of a ruby base with its ruby text(s).
41 // See RenderRuby.h for further comments on the structure
42
43 class RenderRubyRun final : public RenderBlockFlow {
44     WTF_MAKE_ISO_ALLOCATED(RenderRubyRun);
45 public:
46     RenderRubyRun(Document&, RenderStyle&&);
47     virtual ~RenderRubyRun();
48
49     bool hasRubyText() const;
50     bool hasRubyBase() const;
51     RenderRubyText* rubyText() const;
52     RenderRubyBase* rubyBase() const;
53     RenderRubyBase* rubyBaseSafe(); // creates the base if it doesn't already exist
54
55     void layoutExcludedChildren(bool relayoutChildren) override;
56     void layout() override;
57     void layoutBlock(bool relayoutChildren, LayoutUnit pageHeight = 0) override;
58
59     bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
60     void addChild(RenderPtr<RenderObject> child, RenderObject* beforeChild = 0) override;
61     RenderPtr<RenderObject> takeChild(RenderObject&) override;
62
63     RenderBlock* firstLineBlock() const override;
64
65     void getOverhang(bool firstLine, RenderObject* startRenderer, RenderObject* endRenderer, float& startOverhang, float& endOverhang) const;
66
67     static RenderPtr<RenderRubyRun> staticCreateRubyRun(const RenderObject* parentRuby);
68     
69     void updatePriorContextFromCachedBreakIterator(LazyLineBreakIterator&) const;
70     void setCachedPriorCharacters(UChar last, UChar secondToLast)
71     {
72         m_lastCharacter = last;
73         m_secondToLastCharacter = secondToLast;
74     }
75     bool canBreakBefore(const LazyLineBreakIterator&) const;
76     
77 protected:
78     RenderPtr<RenderRubyBase> createRubyBase() const;
79
80 private:
81     bool isRubyRun() const override { return true; }
82     const char* renderName() const override { return "RenderRubyRun (anonymous)"; }
83     bool createsAnonymousWrapper() const override { return true; }
84     void removeLeftoverAnonymousBlock(RenderBlock*) override { }
85
86 private:
87     UChar m_lastCharacter;
88     UChar m_secondToLastCharacter;
89 };
90
91 } // namespace WebCore
92
93 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderRubyRun, isRubyRun())