WebCore/rendering/InlineTextBox.h

   1 /*
   2  * (C) 1999 Lars Knoll (knoll@kde.org)
   3  * (C) 2000 Dirk Mueller (mueller@kde.org)
   4  * Copyright (C) 2004, 2005, 2006, 2009 Apple Inc. All rights reserved.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public License
  17  * along with this library; see the file COPYING.LIB.  If not, write to
  18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  *
  21  */
  22
  23 #ifndef InlineTextBox_h
  24 #define InlineTextBox_h
  25
  26 #include "InlineBox.h"
  27 #include "RenderText.h" // so textRenderer() can be inline
  28
  29 namespace WebCore {
  30
  31 struct CompositionUnderline;
  32
  33 const unsigned short cNoTruncation = USHRT_MAX;
  34 const unsigned short cFullTruncation = USHRT_MAX - 1;
  35
  36 // Helper functions shared by InlineTextBox / SVGRootInlineBox
  37 void updateGraphicsContext(GraphicsContext*, const Color& fillColor, const Color& strokeColor, float strokeThickness, ColorSpace);
  38 Color correctedTextColor(Color textColor, Color backgroundColor);
  39
  40 class InlineTextBox : public InlineBox {
  41 public:
  42     InlineTextBox(RenderObject* obj)
  43         : InlineBox(obj)
  44         , m_prevTextBox(0)
  45         , m_nextTextBox(0)
  46         , m_start(0)
  47         , m_len(0)
  48         , m_truncation(cNoTruncation)
  49     {
  50     }
  51
  52     InlineTextBox* prevTextBox() const { return m_prevTextBox; }
  53     InlineTextBox* nextTextBox() const { return m_nextTextBox; }
  54     void setNextTextBox(InlineTextBox* n) { m_nextTextBox = n; }
  55     void setPreviousTextBox(InlineTextBox* p) { m_prevTextBox = p; }
  56
  57     unsigned start() const { return m_start; }
  58     unsigned end() const { return m_len ? m_start + m_len - 1 : m_start; }
  59     unsigned len() const { return m_len; }
  60
  61     void setStart(unsigned start) { m_start = start; }
  62     void setLen(unsigned len) { m_len = len; }
  63
  64     void offsetRun(int d) { m_start += d; }
  65
  66     unsigned short truncation() { return m_truncation; }
  67
  68     bool hasHyphen() const { return m_hasEllipsisBoxOrHyphen; }
  69     void setHasHyphen(bool hasHyphen) { m_hasEllipsisBoxOrHyphen = hasHyphen; }
  70
  71 private:
  72     virtual int selectionTop();
  73     virtual int selectionHeight();
  74
  75 public:
  76     virtual IntRect calculateBoundaries() const { return IntRect(x(), y(), width(), height()); }
  77
  78     virtual IntRect selectionRect(int absx, int absy, int startPos, int endPos);
  79     bool isSelected(int startPos, int endPos) const;
  80     virtual void selectionStartEnd(int& sPos, int& ePos);
  81
  82 protected:
  83     virtual void paint(RenderObject::PaintInfo&, int tx, int ty);
  84     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty);
  85
  86 public:
  87     RenderText* textRenderer() const;
  88
  89 private:
  90     virtual void deleteLine(RenderArena*);
  91     virtual void extractLine();
  92     virtual void attachLine();
  93
  94 public:
  95     virtual RenderObject::SelectionState selectionState();
  96
  97 private:
  98     virtual void clearTruncation() { m_truncation = cNoTruncation; }
  99     virtual int placeEllipsisBox(bool flowIsLTR, int visibleLeftEdge, int visibleRightEdge, int ellipsisWidth, bool& foundBox);
 100
 101 public:
 102     virtual bool isLineBreak() const;
 103
 104     void setSpaceAdd(int add) { m_width -= m_toAdd; m_toAdd = add; m_width += m_toAdd; }
 105
 106 private:
 107     virtual bool isInlineTextBox() const { return true; }
 108
 109 public:
 110     virtual int caretMinOffset() const;
 111     virtual int caretMaxOffset() const;
 112
 113 private:
 114     virtual unsigned caretMaxRenderedOffset() const;
 115
 116     int textPos() const;
 117
 118 public:
 119     virtual int offsetForPosition(int x, bool includePartialGlyphs = true) const;
 120     virtual int positionForOffset(int offset) const;
 121
 122     bool containsCaretOffset(int offset) const; // false for offset after line break
 123
 124 private:
 125     InlineTextBox* m_prevTextBox; // The previous box that also uses our RenderObject
 126     InlineTextBox* m_nextTextBox; // The next box that also uses our RenderObject
 127
 128     int m_start;
 129     unsigned short m_len;
 130
 131     unsigned short m_truncation; // Where to truncate when text overflow is applied.  We use special constants to
 132                       // denote no truncation (the whole run paints) and full truncation (nothing paints at all).
 133
 134 protected:
 135     void paintCompositionBackground(GraphicsContext*, int tx, int ty, RenderStyle*, const Font&, int startPos, int endPos);
 136     void paintDocumentMarkers(GraphicsContext*, int tx, int ty, RenderStyle*, const Font&, bool background);
 137     void paintCompositionUnderline(GraphicsContext*, int tx, int ty, const CompositionUnderline&);
 138 #if PLATFORM(MAC)
 139     void paintCustomHighlight(int tx, int ty, const AtomicString& type);
 140 #endif
 141
 142 private:
 143     void paintDecoration(GraphicsContext*, int tx, int ty, int decoration, const ShadowData*);
 144     void paintSelection(GraphicsContext*, int tx, int ty, RenderStyle*, const Font&);
 145     void paintSpellingOrGrammarMarker(GraphicsContext*, int tx, int ty, const DocumentMarker&, RenderStyle*, const Font&, bool grammar);
 146     void paintTextMatchMarker(GraphicsContext*, int tx, int ty, const DocumentMarker&, RenderStyle*, const Font&);
 147     void computeRectForReplacementMarker(int tx, int ty, const DocumentMarker&, RenderStyle*, const Font&);
 148 };
 149
 150 inline RenderText* InlineTextBox::textRenderer() const
 151 {
 152     return toRenderText(renderer());
 153 }
 154
 155 } // namespace WebCore
 156
 157 #endif // InlineTextBox_h