Apply FINAL to the RenderObject hierarchy.
[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 #ifndef RenderRubyRun_h
32 #define RenderRubyRun_h
33
34 #include "RenderBlock.h"
35
36 namespace WebCore {
37
38 class RenderRubyBase;
39 class RenderRubyText;
40
41 // RenderRubyRun are 'inline-block/table' like objects,and wrap a single pairing of a ruby base with its ruby text(s).
42 // See RenderRuby.h for further comments on the structure
43
44 class RenderRubyRun FINAL : public RenderBlock {
45 public:
46     virtual ~RenderRubyRun();
47
48     bool hasRubyText() const;
49     bool hasRubyBase() const;
50     bool isEmpty() const;
51     RenderRubyText* rubyText() const;
52     RenderRubyBase* rubyBase() const;
53     RenderRubyBase* rubyBaseSafe(); // creates the base if it doesn't already exist
54
55     virtual RenderObject* layoutSpecialExcludedChild(bool relayoutChildren);
56     virtual void layout();
57
58     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const;
59     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0);
60     virtual void removeChild(RenderObject* child);
61
62     virtual RenderBlock* firstLineBlock() const;
63     virtual void updateFirstLetter();
64
65     void getOverhang(bool firstLine, RenderObject* startRenderer, RenderObject* endRenderer, int& startOverhang, int& endOverhang) const;
66
67     static RenderRubyRun* staticCreateRubyRun(const RenderObject* parentRuby);
68
69 protected:
70     RenderRubyBase* createRubyBase() const;
71
72 private:
73     RenderRubyRun();
74
75     virtual bool isRubyRun() const { return true; }
76     virtual const char* renderName() const { return "RenderRubyRun (anonymous)"; }
77     virtual bool createsAnonymousWrapper() const { return true; }
78     virtual void removeLeftoverAnonymousBlock(RenderBlock*) { }
79 };
80
81 inline RenderRubyRun* toRenderRubyRun(RenderObject* object)
82 {
83     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRubyRun());
84     return static_cast<RenderRubyRun*>(object);
85 }
86
87 inline const RenderRubyRun* toRenderRubyRun(const RenderObject* object)
88 {
89     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isBox());
90     return static_cast<const RenderRubyRun*>(object);
91 }
92
93 void toRenderRubyRun(const RenderRubyRun*);
94
95 } // namespace WebCore
96
97 #endif // RenderRubyRun_h