6e44e326e6b5905dc2afc7602b995d9356364eed
[WebKit-https.git] / 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 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 "RenderObject.h"
27 #include "RenderView.h"
28 #include <wtf/Forward.h>
29
30 namespace WebCore {
31
32 class InlineTextBox;
33
34 class RenderText : public RenderObject {
35 public:
36     RenderText(Node*, PassRefPtr<StringImpl>);
37 #ifndef NDEBUG
38     virtual ~RenderText();
39 #endif
40
41     virtual const char* renderName() const;
42
43     virtual bool isTextFragment() const;
44     virtual bool isWordBreak() const;
45
46     virtual PassRefPtr<StringImpl> originalText() const;
47
48     void extractTextBox(InlineTextBox*);
49     void attachTextBox(InlineTextBox*);
50     void removeTextBox(InlineTextBox*);
51
52     StringImpl* text() const { return m_text.impl(); }
53     String textWithoutTranscoding() const;
54
55     InlineTextBox* createInlineTextBox();
56     void dirtyLineBoxes(bool fullLayout);
57
58     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const;
59     void absoluteRectsForRange(Vector<IntRect>&, unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false, bool* wasFixed = 0);
60
61     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const;
62     void absoluteQuadsForRange(Vector<FloatQuad>&, unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false, bool* wasFixed = 0);
63
64     enum ClippingOption { NoClipping, ClipToEllipsis };
65     void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed = 0, ClippingOption = NoClipping) const;
66
67     virtual VisiblePosition positionForPoint(const LayoutPoint&);
68
69     bool is8Bit() const { return m_text.is8Bit(); }
70     const LChar* characters8() const { return m_text.impl()->characters8(); }
71     const UChar* characters16() const { return m_text.impl()->characters16(); }
72     const UChar* characters() const { return m_text.characters(); }
73     UChar characterAt(unsigned i) const { return is8Bit() ? characters8()[i] : characters16()[i]; }
74     UChar operator[](unsigned i) const { return characterAt(i); }
75     unsigned textLength() const { return m_text.length(); } // non virtual implementation of length()
76     void positionLineBox(InlineBox*);
77
78     virtual float width(unsigned from, unsigned len, const Font&, float xPos, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
79     virtual float width(unsigned from, unsigned len, float xPos, bool firstLine = false, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
80
81     float minLogicalWidth() const;
82     float maxLogicalWidth() const;
83
84     void trimmedPrefWidths(float leadWidth,
85                            float& beginMinW, bool& beginWS,
86                            float& endMinW, bool& endWS,
87                            bool& hasBreakableChar, bool& hasBreak,
88                            float& beginMaxW, float& endMaxW,
89                            float& minW, float& maxW, bool& stripFrontSpaces);
90
91     virtual IntRect linesBoundingBox() const;
92     LayoutRect linesVisualOverflowBoundingBox() const;
93
94     FloatPoint firstRunOrigin() const;
95     float firstRunX() const;
96     float firstRunY() const;
97
98     virtual void setText(PassRefPtr<StringImpl>, bool force = false);
99     void setTextWithOffset(PassRefPtr<StringImpl>, unsigned offset, unsigned len, bool force = false);
100
101     virtual void transformText();
102
103     virtual bool canBeSelectionLeaf() const { return true; }
104     virtual void setSelectionState(SelectionState s);
105     virtual LayoutRect selectionRectForRepaint(const RenderLayerModelObject* repaintContainer, bool clipToVisibleContent = true) OVERRIDE;
106     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0);
107
108     virtual LayoutUnit marginLeft() const { return minimumValueForLength(style()->marginLeft(), 0, view()); }
109     virtual LayoutUnit marginRight() const { return minimumValueForLength(style()->marginRight(), 0, view()); }
110
111     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const OVERRIDE;
112
113     InlineTextBox* firstTextBox() const { return m_firstTextBox; }
114     InlineTextBox* lastTextBox() const { return m_lastTextBox; }
115
116     virtual int caretMinOffset() const;
117     virtual int caretMaxOffset() const;
118     virtual unsigned renderedTextLength() const;
119
120     virtual int previousOffset(int current) const;
121     virtual int previousOffsetForBackwardDeletion(int current) const;
122     virtual int nextOffset(int current) const;
123
124     bool containsReversedText() const { return m_containsReversedText; }
125
126     bool isSecure() const { return style()->textSecurity() != TSNONE; }
127     void momentarilyRevealLastTypedCharacter(unsigned lastTypedCharacterOffset);
128
129     InlineTextBox* findNextInlineTextBox(int offset, int& pos) const;
130
131     void checkConsistency() const;
132
133     bool isAllCollapsibleWhitespace() const;
134
135     bool canUseSimpleFontCodePath() const { return m_canUseSimpleFontCodePath; }
136     bool knownToHaveNoOverflowAndNoFallbackFonts() const { return m_knownToHaveNoOverflowAndNoFallbackFonts; }
137
138     void removeAndDestroyTextBoxes();
139
140 protected:
141     virtual void computePreferredLogicalWidths(float leadWidth);
142     virtual void willBeDestroyed();
143
144     virtual void styleWillChange(StyleDifference, const RenderStyle*) { }
145     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
146
147     virtual void setTextInternal(PassRefPtr<StringImpl>);
148     virtual UChar previousCharacter() const;
149     
150     virtual InlineTextBox* createTextBox(); // Subclassed by SVG.
151
152 private:
153     void computePreferredLogicalWidths(float leadWidth, HashSet<const SimpleFontData*>& fallbackFonts, GlyphOverflow&);
154
155     bool computeCanUseSimpleFontCodePath() const;
156     
157     // Make length() private so that callers that have a RenderText*
158     // will use the more efficient textLength() instead, while
159     // callers with a RenderObject* can continue to use length().
160     virtual unsigned length() const { return textLength(); }
161
162     virtual void paint(PaintInfo&, const LayoutPoint&) { ASSERT_NOT_REACHED(); }
163     virtual void layout() { ASSERT_NOT_REACHED(); }
164     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation&, const LayoutPoint&, HitTestAction) OVERRIDE { ASSERT_NOT_REACHED(); return false; }
165
166     void deleteTextBoxes();
167     bool containsOnlyWhitespace(unsigned from, unsigned len) const;
168     float widthFromCache(const Font&, int start, int len, float xPos, HashSet<const SimpleFontData*>* fallbackFonts, GlyphOverflow*) const;
169     bool isAllASCII() const { return m_isAllASCII; }
170     void updateNeedsTranscoding();
171
172     void secureText(UChar mask);
173
174     // We put the bitfield first to minimize padding on 64-bit.
175     bool m_hasBreakableChar : 1; // Whether or not we can be broken into multiple lines.
176     bool m_hasBreak : 1; // Whether or not we have a hard break (e.g., <pre> with '\n').
177     bool m_hasTab : 1; // Whether or not we have a variable width tab character (e.g., <pre> with '\t').
178     bool m_hasBeginWS : 1; // Whether or not we begin with WS (only true if we aren't pre)
179     bool m_hasEndWS : 1; // Whether or not we end with WS (only true if we aren't pre)
180     bool m_linesDirty : 1; // This bit indicates that the text run has already dirtied specific
181                            // line boxes, and this hint will enable layoutInlineChildren to avoid
182                            // just dirtying everything when character data is modified (e.g., appended/inserted
183                            // or removed).
184     bool m_containsReversedText : 1;
185     bool m_isAllASCII : 1;
186     bool m_canUseSimpleFontCodePath : 1;
187     mutable bool m_knownToHaveNoOverflowAndNoFallbackFonts : 1;
188     bool m_needsTranscoding : 1;
189     
190     float m_minWidth;
191     float m_maxWidth;
192     float m_beginMinWidth;
193     float m_endMinWidth;
194
195     String m_text;
196
197     InlineTextBox* m_firstTextBox;
198     InlineTextBox* m_lastTextBox;
199 };
200
201 inline RenderText* toRenderText(RenderObject* object)
202
203     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isText());
204     return static_cast<RenderText*>(object);
205 }
206
207 inline const RenderText* toRenderText(const RenderObject* object)
208
209     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isText());
210     return static_cast<const RenderText*>(object);
211 }
212
213 // This will catch anyone doing an unnecessary cast.
214 void toRenderText(const RenderText*);
215
216 #ifdef NDEBUG
217 inline void RenderText::checkConsistency() const
218 {
219 }
220 #endif
221
222 void applyTextTransform(const RenderStyle*, String&, UChar);
223
224 } // namespace WebCore
225
226 #endif // RenderText_h