Source/WebCore/rendering/RenderText.h

   1 /*
   2  * (C) 1999 Lars Knoll (knoll@kde.org)
   3  * (C) 2000 Dirk Mueller (mueller@kde.org)
   4  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2013 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 RenderText_h
  24 #define RenderText_h
  25
  26 #include "RenderElement.h"
  27 #include "RenderTextLineBoxes.h"
  28 #include "SimpleLineLayout.h"
  29 #include "Text.h"
  30 #include <wtf/Forward.h>
  31
  32 namespace WebCore {
  33
  34 class InlineTextBox;
  35
  36 class RenderText : public RenderObject {
  37 public:
  38     RenderText(Text&, const String&);
  39     RenderText(Document&, const String&);
  40
  41     virtual ~RenderText();
  42
  43     virtual const char* renderName() const override;
  44
  45     Text* textNode() const;
  46
  47     virtual bool isTextFragment() const;
  48
  49     RenderStyle& style() const;
  50     RenderStyle& firstLineStyle() const;
  51
  52     virtual String originalText() const;
  53
  54     void extractTextBox(InlineTextBox& box) { m_lineBoxes.extract(box); }
  55     void attachTextBox(InlineTextBox& box) { m_lineBoxes.attach(box); }
  56     void removeTextBox(InlineTextBox& box) { m_lineBoxes.remove(box); }
  57
  58     StringImpl* text() const { return m_text.impl(); }
  59     String textWithoutConvertingBackslashToYenSymbol() const;
  60
  61     InlineTextBox* createInlineTextBox() { return m_lineBoxes.createAndAppendLineBox(*this); }
  62     void dirtyLineBoxes(bool fullLayout);
  63
  64     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override final;
  65     Vector<IntRect> absoluteRectsForRange(unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false, bool* wasFixed = nullptr) const;
  66 #if PLATFORM(IOS)
  67     virtual void collectSelectionRects(Vector<SelectionRect>&, unsigned startOffset = 0, unsigned endOffset = std::numeric_limits<unsigned>::max()) override;
  68 #endif
  69
  70     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override final;
  71     Vector<FloatQuad> absoluteQuadsForRange(unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false, bool* wasFixed = nullptr) const;
  72
  73     Vector<FloatQuad> absoluteQuadsClippedToEllipsis() const;
  74
  75     virtual VisiblePosition positionForPoint(const LayoutPoint&, const RenderRegion*) override;
  76
  77     bool is8Bit() const { return m_text.impl()->is8Bit(); }
  78     const LChar* characters8() const { return m_text.impl()->characters8(); }
  79     const UChar* characters16() const { return m_text.impl()->characters16(); }
  80     UChar characterAt(unsigned) const;
  81     UChar uncheckedCharacterAt(unsigned) const;
  82     UChar operator[](unsigned i) const { return uncheckedCharacterAt(i); }
  83     unsigned textLength() const { return m_text.impl()->length(); } // non virtual implementation of length()
  84     void positionLineBox(InlineTextBox&);
  85
  86     virtual float width(unsigned from, unsigned len, const Font&, float xPos, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
  87     virtual float width(unsigned from, unsigned len, float xPos, bool firstLine = false, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
  88
  89     float minLogicalWidth() const;
  90     float maxLogicalWidth() const;
  91
  92     void trimmedPrefWidths(float leadWidth,
  93                            float& beginMinW, bool& beginWS,
  94                            float& endMinW, bool& endWS,
  95                            bool& hasBreakableChar, bool& hasBreak,
  96                            float& beginMaxW, float& endMaxW,
  97                            float& minW, float& maxW, bool& stripFrontSpaces);
  98
  99     WEBCORE_EXPORT virtual IntRect linesBoundingBox() const;
 100     LayoutRect linesVisualOverflowBoundingBox() const;
 101
 102     WEBCORE_EXPORT IntPoint firstRunLocation() const;
 103
 104     virtual void setText(const String&, bool force = false);
 105     void setTextWithOffset(const String&, unsigned offset, unsigned len, bool force = false);
 106
 107     virtual bool canBeSelectionLeaf() const override { return true; }
 108     virtual void setSelectionState(SelectionState) override final;
 109     virtual LayoutRect selectionRectForRepaint(const RenderLayerModelObject* repaintContainer, bool clipToVisibleContent = true) override;
 110     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0) override;
 111
 112     LayoutRect collectSelectionRectsForLineBoxes(const RenderLayerModelObject* repaintContainer, bool clipToVisibleContent, Vector<LayoutRect>& rects);
 113
 114     LayoutUnit marginLeft() const { return minimumValueForLength(style().marginLeft(), 0); }
 115     LayoutUnit marginRight() const { return minimumValueForLength(style().marginRight(), 0); }
 116
 117     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override final;
 118
 119     InlineTextBox* firstTextBox() const { return m_lineBoxes.first(); }
 120     InlineTextBox* lastTextBox() const { return m_lineBoxes.last(); }
 121
 122     virtual int caretMinOffset() const override;
 123     virtual int caretMaxOffset() const override;
 124     unsigned countRenderedCharacterOffsetsUntil(unsigned) const;
 125     bool containsRenderedCharacterOffset(unsigned) const;
 126     bool containsCaretOffset(unsigned) const;
 127     bool hasRenderedText() const;
 128
 129     virtual int previousOffset(int current) const override final;
 130     virtual int previousOffsetForBackwardDeletion(int current) const override final;
 131     virtual int nextOffset(int current) const override final;
 132
 133     bool containsReversedText() const { return m_containsReversedText; }
 134
 135     bool isSecure() const { return style().textSecurity() != TSNONE; }
 136     void momentarilyRevealLastTypedCharacter(unsigned lastTypedCharacterOffset);
 137
 138     InlineTextBox* findNextInlineTextBox(int offset, int& pos) const { return m_lineBoxes.findNext(offset, pos); }
 139
 140     bool isAllCollapsibleWhitespace() const;
 141
 142     bool canUseSimpleFontCodePath() const { return m_canUseSimpleFontCodePath; }
 143
 144     void removeAndDestroyTextBoxes();
 145
 146     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
 147
 148     virtual std::unique_ptr<InlineTextBox> createTextBox(); // Subclassed by RenderSVGInlineText.
 149
 150 #if ENABLE(IOS_TEXT_AUTOSIZING)
 151     float candidateComputedTextSize() const { return m_candidateComputedTextSize; }
 152     void setCandidateComputedTextSize(float s) { m_candidateComputedTextSize = s; }
 153 #endif
 154
 155     void ensureLineBoxes();
 156     void deleteLineBoxesBeforeSimpleLineLayout();
 157     const SimpleLineLayout::Layout* simpleLineLayout() const;
 158
 159     StringView stringView(int start, int stop) const;
 160
 161 protected:
 162     virtual void computePreferredLogicalWidths(float leadWidth);
 163     virtual void willBeDestroyed() override;
 164
 165     virtual void setRenderedText(const String&);
 166     virtual UChar previousCharacter() const;
 167
 168 private:
 169     RenderText(Node&, const String&);
 170
 171     virtual bool canHaveChildren() const override final { return false; }
 172
 173     void computePreferredLogicalWidths(float leadWidth, HashSet<const SimpleFontData*>& fallbackFonts, GlyphOverflow&);
 174
 175     bool computeCanUseSimpleFontCodePath() const;
 176
 177     // Make length() private so that callers that have a RenderText*
 178     // will use the more efficient textLength() instead, while
 179     // callers with a RenderObject* can continue to use length().
 180     virtual unsigned length() const override final { return textLength(); }
 181
 182     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation&, const LayoutPoint&, HitTestAction) override final { ASSERT_NOT_REACHED(); return false; }
 183
 184     bool containsOnlyWhitespace(unsigned from, unsigned len) const;
 185     float widthFromCache(const Font&, int start, int len, float xPos, HashSet<const SimpleFontData*>* fallbackFonts, GlyphOverflow*, const RenderStyle&) const;
 186     bool isAllASCII() const { return m_isAllASCII; }
 187     bool computeUseBackslashAsYenSymbol() const;
 188
 189     void secureText(UChar mask);
 190
 191     LayoutRect collectSelectionRectsForLineBoxes(const RenderLayerModelObject* repaintContainer, bool clipToVisibleContent, Vector<LayoutRect>*);
 192
 193     void node() const = delete;
 194
 195     // We put the bitfield first to minimize padding on 64-bit.
 196     bool m_hasBreakableChar : 1; // Whether or not we can be broken into multiple lines.
 197     bool m_hasBreak : 1; // Whether or not we have a hard break (e.g., <pre> with '\n').
 198     bool m_hasTab : 1; // Whether or not we have a variable width tab character (e.g., <pre> with '\t').
 199     bool m_hasBeginWS : 1; // Whether or not we begin with WS (only true if we aren't pre)
 200     bool m_hasEndWS : 1; // Whether or not we end with WS (only true if we aren't pre)
 201     bool m_linesDirty : 1; // This bit indicates that the text run has already dirtied specific
 202                            // line boxes, and this hint will enable layoutInlineChildren to avoid
 203                            // just dirtying everything when character data is modified (e.g., appended/inserted
 204                            // or removed).
 205     bool m_containsReversedText : 1;
 206     bool m_isAllASCII : 1;
 207     bool m_canUseSimpleFontCodePath : 1;
 208     mutable bool m_knownToHaveNoOverflowAndNoFallbackFonts : 1;
 209     bool m_useBackslashAsYenSymbol : 1;
 210     bool m_originalTextDiffersFromRendered : 1;
 211
 212 #if ENABLE(IOS_TEXT_AUTOSIZING)
 213     // FIXME: This should probably be part of the text sizing structures in Document instead. That would save some memory.
 214     float m_candidateComputedTextSize;
 215 #endif
 216     float m_minWidth;
 217     float m_maxWidth;
 218     float m_beginMinWidth;
 219     float m_endMinWidth;
 220
 221     String m_text;
 222
 223     RenderTextLineBoxes m_lineBoxes;
 224 };
 225
 226 RENDER_OBJECT_TYPE_CASTS(RenderText, isText())
 227
 228 inline UChar RenderText::uncheckedCharacterAt(unsigned i) const
 229 {
 230     ASSERT_WITH_SECURITY_IMPLICATION(i < textLength());
 231     return is8Bit() ? characters8()[i] : characters16()[i];
 232 }
 233
 234 inline UChar RenderText::characterAt(unsigned i) const
 235 {
 236     if (i >= textLength())
 237         return 0;
 238
 239     return uncheckedCharacterAt(i);
 240 }
 241
 242 inline RenderStyle& RenderText::style() const
 243 {
 244     return parent()->style();
 245 }
 246
 247 inline RenderStyle& RenderText::firstLineStyle() const
 248 {
 249     return parent()->firstLineStyle();
 250 }
 251
 252 void applyTextTransform(const RenderStyle&, String&, UChar);
 253 void makeCapitalized(String*, UChar previous);
 254
 255 inline RenderText* Text::renderer() const
 256 {
 257     return toRenderText(Node::renderer());
 258 }
 259
 260 } // namespace WebCore
 261
 262 #endif // RenderText_h