Introduce RenderTreeBuilder
[WebKit-https.git] / Source / WebCore / rendering / RenderRuby.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 #include "RenderInline.h"
35
36 namespace WebCore {
37
38 // Following the HTML 5 spec, the box object model for a <ruby> element allows several runs of ruby
39 // bases with their respective ruby texts looks as follows:
40 //
41 // 1 RenderRuby object, corresponding to the whole <ruby> HTML element
42 //      1+ RenderRubyRun (anonymous)
43 //          0 or 1 RenderRubyText - shuffled to the front in order to re-use existing block layouting
44 //              0-n inline object(s)
45 //          0 or 1 RenderRubyBase - contains the inline objects that make up the ruby base
46 //              1-n inline object(s)
47 //
48 // Note: <rp> elements are defined as having 'display:none' and thus normally are not assigned a renderer.
49 //
50 // Generated :before/:after content is shunted into anonymous inline blocks
51
52 // <ruby> when used as 'display:inline'
53 class RenderRubyAsInline final : public RenderInline {
54     WTF_MAKE_ISO_ALLOCATED(RenderRubyAsInline);
55 public:
56     RenderRubyAsInline(Element&, RenderStyle&&);
57     virtual ~RenderRubyAsInline();
58
59     void addChild(RenderTreeBuilder&, RenderPtr<RenderObject> child, RenderObject* beforeChild = 0) override;
60     RenderPtr<RenderObject> takeChild(RenderObject& child) override;
61
62 protected:
63     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
64
65 private:
66     bool isRubyInline() const final { return true; }
67     const char* renderName() const override { return "RenderRuby (inline)"; }
68     bool createsAnonymousWrapper() const override { return true; }
69 };
70
71 // <ruby> when used as 'display:block' or 'display:inline-block'
72 class RenderRubyAsBlock final : public RenderBlockFlow {
73     WTF_MAKE_ISO_ALLOCATED(RenderRubyAsBlock);
74 public:
75     RenderRubyAsBlock(Element&, RenderStyle&&);
76     virtual ~RenderRubyAsBlock();
77
78     Element& element() const { return downcast<Element>(nodeForNonAnonymous()); }
79
80     void addChild(RenderTreeBuilder&, RenderPtr<RenderObject> child, RenderObject* beforeChild = 0) override;
81     RenderPtr<RenderObject> takeChild(RenderObject& child) override;
82
83 protected:
84     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
85
86 private:
87     bool isRubyBlock() const final { return true; }
88     const char* renderName() const override { return "RenderRuby (block)"; }
89     bool createsAnonymousWrapper() const override { return true; }
90     void removeLeftoverAnonymousBlock(RenderBlock*) override { ASSERT_NOT_REACHED(); }
91 };
92
93
94 inline bool isRuby(const RenderObject& renderer) { return (is<RenderRubyAsInline>(renderer) || is<RenderRubyAsBlock>(renderer)); }
95 inline bool isRuby(const RenderObject* renderer) { return (renderer && isRuby(*renderer)); }
96
97 } // namespace WebCore
98
99 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderRubyAsInline, isRubyInline())
100 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderRubyAsBlock, isRubyBlock())