src/third_party/WebKit/Source/core/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 "core/rendering/RenderBlockFlow.h"
  35
  36 namespace blink {
  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 RenderBlockFlow {
  45 public:
  46     virtual ~RenderRubyRun();
  47
  48     bool hasRubyText() const;
  49     bool hasRubyBase() const;
  50     RenderRubyText* rubyText() const;
  51     RenderRubyBase* rubyBase() const;
  52     RenderRubyBase* rubyBaseSafe(); // creates the base if it doesn't already exist
  53
  54     virtual RenderObject* layoutSpecialExcludedChild(bool relayoutChildren, SubtreeLayoutScope&) override;
  55     virtual void layout() override;
  56
  57     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const override;
  58     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0) override;
  59     virtual void removeChild(RenderObject* child) override;
  60
  61     void getOverhang(bool firstLine, RenderObject* startRenderer, RenderObject* endRenderer, int& startOverhang, int& endOverhang) const;
  62
  63     static RenderRubyRun* staticCreateRubyRun(const RenderObject* parentRuby);
  64
  65 protected:
  66     RenderRubyBase* createRubyBase() const;
  67
  68 private:
  69     RenderRubyRun();
  70
  71     virtual bool isOfType(RenderObjectType type) const override { return type == RenderObjectRubyRun || RenderBlockFlow::isOfType(type); }
  72     virtual const char* renderName() const override { return "RenderRubyRun (anonymous)"; }
  73     virtual bool createsAnonymousWrapper() const override { return true; }
  74     virtual void removeLeftoverAnonymousBlock(RenderBlock*) override { }
  75 };
  76
  77 DEFINE_RENDER_OBJECT_TYPE_CASTS(RenderRubyRun, isRubyRun());
  78
  79 } // namespace blink
  80
  81 #endif // RenderRubyRun_h