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