flutter_flutter/sky/engine/core/rendering/InlineBox.h

/*
 * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2011 Apple Inc. All
 * rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef SKY_ENGINE_CORE_RENDERING_INLINEBOX_H_
#define SKY_ENGINE_CORE_RENDERING_INLINEBOX_H_

#include "flutter/sky/engine/core/rendering/RenderBoxModelObject.h"
#include "flutter/sky/engine/core/rendering/RenderObjectInlines.h"
#include "flutter/sky/engine/platform/text/TextDirection.h"

namespace blink {

class HitTestRequest;
class HitTestResult;
class RootInlineBox;

enum MarkLineBoxes { MarkLineBoxesDirty, DontMarkLineBoxes };

// InlineBox represents a rectangle that occurs on a line.  It corresponds to
// some RenderObject (i.e., it represents a portion of that RenderObject).
class InlineBox {
  WTF_MAKE_NONCOPYABLE(InlineBox);

 public:
  InlineBox(RenderObject& obj)
      : m_next(0),
        m_prev(0),
        m_parent(0),
        m_renderer(obj),
        m_logicalWidth(0)
#if ENABLE(ASSERT)
        ,
        m_hasBadParent(false)
#endif
  {
  }

  InlineBox(RenderObject& obj,
            FloatPoint topLeft,
            float logicalWidth,
            bool firstLine,
            bool constructed,
            bool dirty,
            bool extracted,
            InlineBox* next,
            InlineBox* prev,
            InlineFlowBox* parent)
      : m_next(next),
        m_prev(prev),
        m_parent(parent),
        m_renderer(obj),
        m_topLeft(topLeft),
        m_logicalWidth(logicalWidth),
        m_bitfields(firstLine, constructed, dirty, extracted)
#if ENABLE(ASSERT)
        ,
        m_hasBadParent(false)
#endif
  {
  }

  virtual ~InlineBox();

  virtual void destroy() { delete this; }

  virtual void deleteLine();
  virtual void extractLine();
  virtual void attachLine();

  virtual bool isLineBreak() const { return false; }

  virtual void adjustPosition(float dx, float dy);
  void adjustLogicalPosition(float deltaLogicalLeft, float deltaLogicalTop) {
    // FIXME(sky): Remove
    adjustPosition(deltaLogicalLeft, deltaLogicalTop);
  }
  void adjustLineDirectionPosition(float delta) { adjustPosition(delta, 0); }
  void adjustBlockDirectionPosition(float delta) { adjustPosition(0, delta); }

  virtual void paint(PaintInfo&,
                     const LayoutPoint&,
                     LayoutUnit lineTop,
                     LayoutUnit lineBottom,
                     Vector<RenderBox*>& layers);
  virtual bool nodeAtPoint(const HitTestRequest&,
                           HitTestResult&,
                           const HitTestLocation& locationInContainer,
                           const LayoutPoint& accumulatedOffset,
                           LayoutUnit lineTop,
                           LayoutUnit lineBottom);

  // InlineBoxes are allocated out of the rendering partition.
  void* operator new(size_t);
  void operator delete(void*);

#ifndef NDEBUG
  void showTreeForThis() const;
  void showLineTreeForThis() const;

  virtual void showBox(int = 0) const;
  virtual void showLineTreeAndMark(const InlineBox* = 0,
                                   const char* = 0,
                                   const InlineBox* = 0,
                                   const char* = 0,
                                   const RenderObject* = 0,
                                   int = 0) const;
  virtual const char* boxName() const;
#endif

  bool isText() const { return m_bitfields.isText(); }
  void setIsText(bool isText) { m_bitfields.setIsText(isText); }

  virtual bool isInlineFlowBox() const { return false; }
  virtual bool isInlineTextBox() const { return false; }
  virtual bool isRootInlineBox() const { return false; }

  virtual bool isSVGInlineTextBox() const { return false; }
  virtual bool isSVGInlineFlowBox() const { return false; }
  virtual bool isSVGRootInlineBox() const { return false; }

  bool hasVirtualLogicalHeight() const {
    return m_bitfields.hasVirtualLogicalHeight();
  }
  void setHasVirtualLogicalHeight() {
    m_bitfields.setHasVirtualLogicalHeight(true);
  }
  virtual float virtualLogicalHeight() const {
    ASSERT_NOT_REACHED();
    return 0;
  }

  virtual FloatRect calculateBoundaries() const {
    ASSERT_NOT_REACHED();
    return FloatRect();
  }

  bool isConstructed() { return m_bitfields.constructed(); }
  virtual void setConstructed() { m_bitfields.setConstructed(true); }

  void setExtracted(bool extracted = true) {
    m_bitfields.setExtracted(extracted);
  }

  void setFirstLineStyleBit(bool firstLine) {
    m_bitfields.setFirstLine(firstLine);
  }
  bool isFirstLineStyle() const { return m_bitfields.firstLine(); }

  void remove(MarkLineBoxes = MarkLineBoxesDirty);

  InlineBox* nextOnLine() const { return m_next; }
  InlineBox* prevOnLine() const { return m_prev; }
  void setNextOnLine(InlineBox* next) {
    ASSERT(m_parent || !next);
    m_next = next;
  }
  void setPrevOnLine(InlineBox* prev) {
    ASSERT(m_parent || !prev);
    m_prev = prev;
  }
  bool nextOnLineExists() const;

  virtual bool isLeaf() const { return true; }

  InlineBox* nextLeafChild() const;
  InlineBox* prevLeafChild() const;

  // Helper functions for editing and hit-testing code.
  // FIXME: These two functions should be moved to RenderedPosition once the
  // code to convert between Position and inline box, offset pair is moved to
  // RenderedPosition.
  InlineBox* nextLeafChildIgnoringLineBreak() const;
  InlineBox* prevLeafChildIgnoringLineBreak() const;

  RenderObject& renderer() const { return m_renderer; }

  InlineFlowBox* parent() const {
    ASSERT(!m_hasBadParent);
    return m_parent;
  }
  void setParent(InlineFlowBox* par) { m_parent = par; }

  const RootInlineBox& root() const;
  RootInlineBox& root();

  // x() is the left side of the box in the containing block's coordinate
  // system.
  void setX(float x) { m_topLeft.setX(x); }
  float x() const { return m_topLeft.x(); }
  float left() const { return m_topLeft.x(); }

  // y() is the top side of the box in the containing block's coordinate system.
  void setY(float y) { m_topLeft.setY(y); }
  float y() const { return m_topLeft.y(); }
  float top() const { return m_topLeft.y(); }

  const FloatPoint& topLeft() const { return m_topLeft; }

  float width() const { return logicalWidth(); }
  float height() const {
    return hasVirtualLogicalHeight() ? virtualLogicalHeight() : logicalHeight();
  }
  FloatSize size() const { return FloatSize(width(), height()); }
  float right() const { return left() + width(); }
  float bottom() const { return top() + height(); }

  // The logicalLeft position is the left edge of the line box in a horizontal
  // line and the top edge in a vertical line.
  float logicalLeft() const { return m_topLeft.x(); }
  float logicalRight() const { return logicalLeft() + logicalWidth(); }
  void setLogicalLeft(float left) {
    // FIXME(sky): Remove
    setX(left);
  }
  int pixelSnappedLogicalLeft() const { return logicalLeft(); }
  int pixelSnappedLogicalRight() const { return ceilf(logicalRight()); }
  int pixelSnappedLogicalTop() const { return logicalTop(); }
  int pixelSnappedLogicalBottom() const { return ceilf(logicalBottom()); }

  // The logicalTop[ position is the top edge of the line box in a horizontal
  // line and the left edge in a vertical line.
  float logicalTop() const { return m_topLeft.y(); }
  float logicalBottom() const { return logicalTop() + logicalHeight(); }
  void setLogicalTop(float top) { setY(top); }

  // The logical width is our extent in the line's overall inline direction,
  // i.e., width for horizontal text and height for vertical text.
  void setLogicalWidth(float w) { m_logicalWidth = w; }
  float logicalWidth() const { return m_logicalWidth; }

  // The logical height is our extent in the block flow direction, i.e., height
  // for horizontal text and width for vertical text.
  float logicalHeight() const;

  FloatRect logicalFrameRect() const {
    return FloatRect(m_topLeft.x(), m_topLeft.y(), m_logicalWidth,
                     logicalHeight());
  }

  virtual int baselinePosition(FontBaseline baselineType) const;
  virtual LayoutUnit lineHeight() const;

  virtual int caretMinOffset() const;
  virtual int caretMaxOffset() const;

  unsigned char bidiLevel() const { return m_bitfields.bidiEmbeddingLevel(); }
  void setBidiLevel(unsigned char level) {
    m_bitfields.setBidiEmbeddingLevel(level);
  }
  TextDirection direction() const { return bidiLevel() % 2 ? RTL : LTR; }
  bool isLeftToRightDirection() const { return direction() == LTR; }
  int caretLeftmostOffset() const {
    return isLeftToRightDirection() ? caretMinOffset() : caretMaxOffset();
  }
  int caretRightmostOffset() const {
    return isLeftToRightDirection() ? caretMaxOffset() : caretMinOffset();
  }

  virtual void clearTruncation() {}

  bool isDirty() const { return m_bitfields.dirty(); }
  virtual void markDirty() { m_bitfields.setDirty(true); }

  virtual void dirtyLineBoxes();

  virtual RenderObject::SelectionState selectionState();

#if ENABLE(ASSERT)
  void setHasBadParent();
#endif

  int expansion() const { return m_bitfields.expansion(); }

  bool visibleToHitTestRequest(const HitTestRequest& request) const {
    return renderer().visibleToHitTestRequest(request);
  }

  EVerticalAlign verticalAlign() const {
    return renderer().style(m_bitfields.firstLine())->verticalAlign();
  }

  // Use with caution! The type is not checked!
  RenderBoxModelObject* boxModelObject() const {
    if (!renderer().isText())
      return toRenderBoxModelObject(&renderer());
    return 0;
  }

  FloatPoint locationIncludingFlipping();

  bool knownToHaveNoOverflow() const {
    return m_bitfields.knownToHaveNoOverflow();
  }
  void clearKnownToHaveNoOverflow();

  bool dirOverride() const { return m_bitfields.dirOverride(); }
  void setDirOverride(bool dirOverride) {
    m_bitfields.setDirOverride(dirOverride);
  }

#define ADD_BOOLEAN_BITFIELD(name, Name) \
 private:                                \
  unsigned m_##name : 1;                 \
                                         \
 public:                                 \
  bool name() const { return m_##name; } \
  void set##Name(bool name) { m_##name = name; }

  class InlineBoxBitfields {
   public:
    InlineBoxBitfields(bool firstLine = false,
                       bool constructed = false,
                       bool dirty = false,
                       bool extracted = false)
        : m_firstLine(firstLine),
          m_constructed(constructed),
          m_bidiEmbeddingLevel(0),
          m_dirty(dirty),
          m_extracted(extracted),
          m_hasVirtualLogicalHeight(false),
          m_endsWithBreak(false),
          m_hasSelectedChildrenOrCanHaveLeadingExpansion(false),
          m_knownToHaveNoOverflow(true),
          m_hasEllipsisBoxOrHyphen(false),
          m_dirOverride(false),
          m_isText(false),
          m_hasAddedEllipsis(false),
          m_determinedIfNextOnLineExists(false),
          m_nextOnLineExists(false),
          m_expansion(0) {}

    // Some of these bits are actually for subclasses and moved here to compact
    // the structures. for this class
    ADD_BOOLEAN_BITFIELD(firstLine, FirstLine);
    ADD_BOOLEAN_BITFIELD(constructed, Constructed);

   private:
    unsigned
        m_bidiEmbeddingLevel : 6;  // The maximium bidi level is 62:
                                   // http://unicode.org/reports/tr9/#Explicit_Levels_and_Directions

   public:
    unsigned char bidiEmbeddingLevel() const { return m_bidiEmbeddingLevel; }
    void setBidiEmbeddingLevel(unsigned char bidiEmbeddingLevel) {
      m_bidiEmbeddingLevel = bidiEmbeddingLevel;
    }

    ADD_BOOLEAN_BITFIELD(dirty, Dirty);
    ADD_BOOLEAN_BITFIELD(extracted, Extracted);
    ADD_BOOLEAN_BITFIELD(hasVirtualLogicalHeight, HasVirtualLogicalHeight);
    // for RootInlineBox
    ADD_BOOLEAN_BITFIELD(endsWithBreak,
                         EndsWithBreak);  // Whether the line ends with a <br>.
    // shared between RootInlineBox and InlineTextBox
    ADD_BOOLEAN_BITFIELD(hasSelectedChildrenOrCanHaveLeadingExpansion,
                         HasSelectedChildrenOrCanHaveLeadingExpansion);
    ADD_BOOLEAN_BITFIELD(knownToHaveNoOverflow, KnownToHaveNoOverflow);
    ADD_BOOLEAN_BITFIELD(hasEllipsisBoxOrHyphen, HasEllipsisBoxOrHyphen);
    // for InlineTextBox
    ADD_BOOLEAN_BITFIELD(dirOverride, DirOverride);
    ADD_BOOLEAN_BITFIELD(isText, IsText);  // Whether or not this object
                                           // represents text with a non-zero
                                           // height. Includes non-image list
                                           // markers, text boxes.
    ADD_BOOLEAN_BITFIELD(hasAddedEllipsis, HasAddedEllipsis)

   private:
    mutable unsigned m_determinedIfNextOnLineExists : 1;

   public:
    bool determinedIfNextOnLineExists() const {
      return m_determinedIfNextOnLineExists;
    }
    void setDeterminedIfNextOnLineExists(
        bool determinedIfNextOnLineExists) const {
      m_determinedIfNextOnLineExists = determinedIfNextOnLineExists;
    }

   private:
    mutable unsigned m_nextOnLineExists : 1;

   public:
    bool nextOnLineExists() const { return m_nextOnLineExists; }
    void setNextOnLineExists(bool nextOnLineExists) const {
      m_nextOnLineExists = nextOnLineExists;
    }

   private:
    signed m_expansion : 12;  // for justified text

   public:
    signed expansion() const { return m_expansion; }
    void setExpansion(signed expansion) { m_expansion = expansion; }
  };
#undef ADD_BOOLEAN_BITFIELD

 private:
  InlineBox* m_next;  // The next element on the same line as us.
  InlineBox* m_prev;  // The previous element on the same line as us.

  InlineFlowBox* m_parent;  // The box that contains us.
  RenderObject& m_renderer;

 protected:
  // For RootInlineBox
  bool endsWithBreak() const { return m_bitfields.endsWithBreak(); }
  void setEndsWithBreak(bool endsWithBreak) {
    m_bitfields.setEndsWithBreak(endsWithBreak);
  }
  bool hasEllipsisBox() const { return m_bitfields.hasEllipsisBoxOrHyphen(); }
  bool hasSelectedChildren() const {
    return m_bitfields.hasSelectedChildrenOrCanHaveLeadingExpansion();
  }
  void setHasSelectedChildren(bool hasSelectedChildren) {
    m_bitfields.setHasSelectedChildrenOrCanHaveLeadingExpansion(
        hasSelectedChildren);
  }
  void setHasEllipsisBox(bool hasEllipsisBox) {
    m_bitfields.setHasEllipsisBoxOrHyphen(hasEllipsisBox);
  }

  // For InlineTextBox
  bool hasHyphen() const { return m_bitfields.hasEllipsisBoxOrHyphen(); }
  void setHasHyphen(bool hasHyphen) {
    m_bitfields.setHasEllipsisBoxOrHyphen(hasHyphen);
  }
  bool canHaveLeadingExpansion() const {
    return m_bitfields.hasSelectedChildrenOrCanHaveLeadingExpansion();
  }
  void setCanHaveLeadingExpansion(bool canHaveLeadingExpansion) {
    m_bitfields.setHasSelectedChildrenOrCanHaveLeadingExpansion(
        canHaveLeadingExpansion);
  }
  signed expansion() { return m_bitfields.expansion(); }
  void setExpansion(signed expansion) { m_bitfields.setExpansion(expansion); }
  bool hasAddedEllipsis() const { return m_bitfields.hasAddedEllipsis(); }
  void setHasAddedEllipsis(bool hasAddedEllipsis) {
    m_bitfields.setHasAddedEllipsis(hasAddedEllipsis);
  }

  // For InlineFlowBox and InlineTextBox
  bool extracted() const { return m_bitfields.extracted(); }

  FloatPoint m_topLeft;
  float m_logicalWidth;

 private:
  InlineBoxBitfields m_bitfields;

#if ENABLE(ASSERT)
  bool m_hasBadParent;
#endif
};

#if !ENABLE(ASSERT)
inline InlineBox::~InlineBox() {}
#endif

#if ENABLE(ASSERT)
inline void InlineBox::setHasBadParent() {
  m_hasBadParent = true;
}
#endif

#define DEFINE_INLINE_BOX_TYPE_CASTS(typeName)                     \
  DEFINE_TYPE_CASTS(typeName, InlineBox, box, box->is##typeName(), \
                    box.is##typeName())

// Allow equality comparisons of InlineBox's by reference or pointer,
// interchangeably.
DEFINE_COMPARISON_OPERATORS_WITH_REFERENCES(InlineBox)

}  // namespace blink

#ifndef NDEBUG
// Outside the WebCore namespace for ease of invocation from gdb.
void showTree(const blink::InlineBox*);
void showLineTree(const blink::InlineBox*);
#endif

#endif  // SKY_ENGINE_CORE_RENDERING_INLINEBOX_H_