169ce30549fbfcc25aba09c2006a074e308662c0
[WebKit-https.git] / WebCore / khtml / rendering / render_text.h
1 /*
2  * This file is part of the DOM implementation for KDE.
3  *
4  * (C) 1999 Lars Knoll (knoll@kde.org)
5  * (C) 2000 Dirk Mueller (mueller@kde.org)
6  * Copyright (C) 2004 Apple Computer, Inc.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  *
23  */
24 #ifndef RENDERTEXT_H
25 #define RENDERTEXT_H
26
27 #include "dom/dom_string.h"
28 #include "xml/dom_stringimpl.h"
29 #include "xml/dom_textimpl.h"
30 #include "rendering/render_object.h"
31 #include "rendering/render_flow.h"
32
33 #include <qptrvector.h>
34 #include <assert.h>
35
36 class QPainter;
37 class QFontMetrics;
38
39 namespace DOM {
40     class Position;
41 };
42
43 // Define a constant for soft hyphen's unicode value.
44 #define SOFT_HYPHEN 173
45
46 namespace khtml
47 {
48     class RenderText;
49     class RenderStyle;
50
51 class InlineTextBox : public InlineRunBox
52 {
53 public:
54     InlineTextBox(RenderObject* obj)
55     :InlineRunBox(obj)
56     {
57         m_start = 0;
58         m_len = 0;
59         m_reversed = false;
60         m_toAdd = 0;
61     }
62     
63     InlineTextBox* nextTextBox() const { return static_cast<InlineTextBox*>(nextLineBox()); }
64     InlineTextBox* prevTextBox() const { return static_cast<InlineTextBox*>(prevLineBox()); }
65     
66     uint start() const { return m_start; }
67     uint end() const { return m_len ? m_start+m_len-1 : m_start; }
68     uint len() const { return m_len; }
69
70     void offsetRun(int d) { m_start += d; }
71
72     void detach(RenderArena* arena);
73     
74     virtual void deleteLine(RenderArena* arena);
75     virtual void extractLine();
76     virtual void attachLine();
77
78     // Overloaded new operator.  Derived classes must override operator new
79     // in order to allocate out of the RenderArena.
80     void* operator new(size_t sz, RenderArena* renderArena) throw();    
81
82     // Overridden to prevent the normal delete from being called.
83     void operator delete(void* ptr, size_t sz);
84         
85 private:
86     // The normal operator new is disallowed.
87     void* operator new(size_t sz) throw();
88
89 public:
90     void setSpaceAdd(int add) { m_width -= m_toAdd; m_toAdd = add; m_width += m_toAdd; }
91     int spaceAdd() { return m_toAdd; }
92
93     virtual bool isInlineTextBox() { return true; }
94     
95     void paintDecoration( QPainter *pt, int _tx, int _ty, int decoration);
96     void paintSelection(const Font *f, RenderText *text, QPainter *p, RenderStyle* style, int tx, int ty, int startPos, int endPos, bool extendSelection);
97
98     virtual long caretMinOffset() const;
99     virtual long caretMaxOffset() const;
100     virtual unsigned long caretMaxRenderedOffset() const;
101     
102     int offsetForPosition(int _x, int _tx, const Font *f, const RenderText *text);
103     
104     /**
105      * if this text run was rendered @ref _ty pixels below the upper edge
106      * of a view, would the @ref _y -coordinate be inside the vertical range
107      * of this object's representation?
108      */
109     bool checkVerticalPoint(int _y, int _ty, int _h)
110     { if((_ty + m_y > _y + _h) || (_ty + m_y + m_baseline + height() < _y)) return false; return true; }
111
112     int m_start;
113     unsigned short m_len;
114     
115     bool m_reversed : 1;
116     int m_toAdd : 14; // for justified text
117 private:
118     friend class RenderText;
119 };
120
121 class RenderText : public RenderObject
122 {
123     friend class InlineTextBox;
124
125 public:
126     RenderText(DOM::NodeImpl* node, DOM::DOMStringImpl *_str);
127     virtual ~RenderText();
128
129     virtual bool isTextFragment() const;
130     virtual DOM::DOMStringImpl* originalString() const;
131     
132     virtual const char *renderName() const { return "RenderText"; }
133
134     virtual void setStyle(RenderStyle *style);
135     
136     virtual void paint(PaintInfo& i, int tx, int ty);
137
138     void extractTextBox(InlineTextBox* textBox);
139     void attachTextBox(InlineTextBox* textBox);
140     void removeTextBox(InlineTextBox* textBox);
141     void deleteTextBoxes();
142     virtual void detach();
143     
144     DOM::DOMString data() const { return str; }
145     DOM::DOMStringImpl *string() const { return str; }
146
147     virtual InlineBox* createInlineBox(bool,bool, bool isOnlyRun = false);
148     virtual void dirtyLineBoxes(bool fullLayout, bool isRootInlineBox = false);
149     
150     virtual void layout() {assert(false);}
151
152     virtual bool nodeAtPoint(NodeInfo& info, int x, int y, int tx, int ty,
153                              HitTestAction hitTestAction = HitTestAll, bool inside=false);
154
155     virtual void absoluteRects(QValueList<QRect>& rects, int _tx, int _ty);
156
157     virtual DOM::Position positionForCoordinates(int _x, int _y);
158
159     unsigned int length() const { return str->l; }
160     QChar *text() const { return str->s; }
161     unsigned int stringLength() const { return str->l; } // non virtual implementation of length()
162     virtual void position(InlineBox* box, int from, int len, bool reverse);
163
164     virtual unsigned int width(unsigned int from, unsigned int len, const Font *f) const;
165     virtual unsigned int width(unsigned int from, unsigned int len, bool firstLine = false) const;
166     virtual int width() const;
167     virtual int height() const;
168
169     // height of the contents (without paddings, margins and borders)
170     virtual short lineHeight( bool firstLine, bool isRootLineBox=false ) const;
171     virtual short baselinePosition( bool firstLine, bool isRootLineBox=false ) const;
172
173     // overrides
174     virtual void calcMinMaxWidth();
175     virtual int minWidth() const { return m_minWidth; }
176     virtual int maxWidth() const { return m_maxWidth; }
177     virtual void trimmedMinMaxWidth(int& beginMinW, bool& beginWS, 
178                                     int& endMinW, bool& endWS,
179                                     bool& hasBreakableChar, bool& hasBreak,
180                                     int& beginMaxW, int& endMaxW,
181                                     int& minW, int& maxW, bool& stripFrontSpaces);
182     
183     bool containsOnlyWhitespace(unsigned int from, unsigned int len) const;
184     
185     // returns the minimum x position of all runs relative to the parent.
186     // defaults to 0.
187     int minXPos() const;
188
189     virtual int xPos() const;
190     virtual int yPos() const;
191
192     virtual const QFont &font();
193     virtual short verticalPositionHint( bool firstLine ) const;
194
195     void setText(DOM::DOMStringImpl *text, bool force=false);
196     void setTextWithOffset(DOM::DOMStringImpl *text, uint offset, uint len, bool force=false);
197
198     virtual SelectionState selectionState() const {return m_selectionState;}
199     virtual void setSelectionState(SelectionState s) {m_selectionState = s; }
200     virtual void caretPos(int offset, bool override, int &_x, int &_y, int &width, int &height);
201     void posOfChar(int ch, int &x, int &y);
202
203     virtual short marginLeft() const { return style()->marginLeft().minWidth(0); }
204     virtual short marginRight() const { return style()->marginRight().minWidth(0); }
205
206     virtual QRect getAbsoluteRepaintRect();
207
208     const QFontMetrics &metrics(bool firstLine) const;
209     const Font *htmlFont(bool firstLine) const;
210
211     DOM::TextImpl *element() const
212     { return static_cast<DOM::TextImpl*>(RenderObject::element()); }
213
214     InlineTextBox* firstTextBox() const { return m_firstTextBox; }
215     InlineTextBox* lastTextBox() const { return m_lastTextBox; }
216     
217     virtual InlineBox *inlineBox(long offset);
218     
219     void clearTextOverflowTruncation();
220
221 #if APPLE_CHANGES
222     int widthFromCache(const Font *, int start, int len) const;
223     bool shouldUseMonospaceCache(const Font *) const;
224     void cacheWidths();
225     bool allAscii() const;
226 #endif
227
228     virtual long caretMinOffset() const;
229     virtual long caretMaxOffset() const;
230     virtual unsigned long caretMaxRenderedOffset() const;
231     
232 #if APPLE_CHANGES
233 public:
234 #endif
235     InlineTextBox * findNextInlineTextBox( int offset, int &pos );
236
237 protected: // members
238     DOM::DOMStringImpl *str;
239     
240     InlineTextBox* m_firstTextBox;
241     InlineTextBox* m_lastTextBox;
242     
243     int m_minWidth;
244     int m_maxWidth;
245     int m_beginMinWidth;
246     int m_endMinWidth;
247     
248     SelectionState m_selectionState : 3 ;
249     bool m_hasBreakableChar : 1; // Whether or not we can be broken into multiple lines.
250     bool m_hasBreak : 1; // Whether or not we have a hard break (e.g., <pre> with '\n').
251     bool m_hasBeginWS : 1; // Whether or not we begin with WS (only true if we aren't pre)
252     bool m_hasEndWS : 1; // Whether or not we end with WS (only true if we aren't pre)
253     
254     bool m_linesDirty : 1; // This bit indicates that the text run has already dirtied specific
255                            // line boxes, and this hint will enable layoutInlineChildren to avoid
256                            // just dirtying everything when character data is modified (e.g., appended/inserted
257                            // or removed).
258
259     // 22 bits left
260 #if APPLE_CHANGES
261     mutable bool m_allAsciiChecked:1;
262     mutable bool m_allAscii:1;
263     int m_monospaceCharacterWidth;
264 #endif
265 };
266
267 // Used to represent a text substring of an element, e.g., for text runs that are split because of
268 // first letter and that must therefore have different styles (and positions in the render tree).
269 // We cache offsets so that text transformations can be applied in such a way that we can recover
270 // the original unaltered string from our corresponding DOM node.
271 class RenderTextFragment : public RenderText
272 {
273 public:
274     RenderTextFragment(DOM::NodeImpl* _node, DOM::DOMStringImpl* _str,
275                        int startOffset, int endOffset);
276     RenderTextFragment(DOM::NodeImpl* _node, DOM::DOMStringImpl* _str);
277     ~RenderTextFragment();
278     
279     virtual bool isTextFragment() const;
280     
281     uint start() const { return m_start; }
282     uint end() const { return m_end; }
283     
284     DOM::DOMStringImpl* contentString() const { return m_generatedContentStr; }
285     virtual DOM::DOMStringImpl* originalString() const;
286     
287 private:
288     uint m_start;
289     uint m_end;
290     DOM::DOMStringImpl* m_generatedContentStr;
291 };
292 };
293 #endif