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
36namespace WebCore {
37
38class RenderRubyBase;
39class 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
44class RenderRubyRun : public RenderBlock {
45public:
46    RenderRubyRun(Node*);
47    virtual ~RenderRubyRun();
48
49    bool hasRubyText() const;
50    bool hasRubyBase() const;
51    bool isEmpty() const;
52    RenderRubyText* rubyText() const;
53    RenderRubyBase* rubyBase() const;
54    RenderRubyBase* rubyBaseSafe(); // creates the base if it doesn't already exist
55
56    virtual RenderObject* layoutSpecialExcludedChild(bool relayoutChildren);
57    virtual void layout();
58
59    virtual bool isChildAllowed(RenderObject*, RenderStyle*) const;
60    virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0);
61    virtual void removeChild(RenderObject* child);
62
63    virtual RenderBlock* firstLineBlock() const;
64    virtual void updateFirstLetter();
65
66    void getOverhang(bool firstLine, RenderObject* startRenderer, RenderObject* endRenderer, int& startOverhang, int& endOverhang) const;
67
68    static RenderRubyRun* staticCreateRubyRun(const RenderObject* parentRuby);
69
70protected:
71    RenderRubyBase* createRubyBase() const;
72
73private:
74    virtual bool isRubyRun() const { return true; }
75    virtual const char* renderName() const { return "RenderRubyRun (anonymous)"; }
76    virtual bool createsAnonymousWrapper() const { return true; }
77    virtual void removeLeftoverAnonymousBlock(RenderBlock*) { }
78};
79
80inline RenderRubyRun* toRenderRubyRun(RenderObject* object)
81{
82    ASSERT(!object || object->isRubyRun());
83    return static_cast<RenderRubyRun*>(object);
84}
85
86inline const RenderRubyRun* toRenderRubyRun(const RenderObject* object)
87{
88    ASSERT(!object || object->isBox());
89    return static_cast<const RenderRubyRun*>(object);
90}
91
92void toRenderRubyRun(const RenderRubyRun*);
93
94} // namespace WebCore
95
96#endif // RenderRubyRun_h
97