WebCore:
[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     class DocumentMarker;
42 };
43
44 // Define a constant for soft hyphen's unicode value.
45 #define SOFT_HYPHEN 173
46
47 const int cNoTruncation = -1;
48 const int cFullTruncation = -2;
49
50 namespace khtml
51 {
52     class RenderText;
53     class RenderStyle;
54
55 class InlineTextBox : public InlineRunBox
56 {
57 public:
58     InlineTextBox(RenderObject* obj)
59     :InlineRunBox(obj)
60     {
61         m_start = 0;
62         m_len = 0;
63         m_reversed = false;
64         m_treatAsText = true;
65         m_toAdd = 0;
66         m_truncation = cNoTruncation;
67     }
68     
69     InlineTextBox* nextTextBox() const { return static_cast<InlineTextBox*>(nextLineBox()); }
70     InlineTextBox* prevTextBox() const { return static_cast<InlineTextBox*>(prevLineBox()); }
71     
72     uint start() const { return m_start; }
73     uint end() const { return m_len ? m_start+m_len-1 : m_start; }
74     uint len() const { return m_len; }
75
76     void offsetRun(int d) { m_start += d; }
77
78     void detach(RenderArena* arena);
79     
80     QRect selectionRect(int absx, int absy, int startPos, int endPos);
81     bool isSelected(int startPos, int endPos) const;
82     
83     RenderText* textObject();
84     
85     virtual void deleteLine(RenderArena* arena);
86     virtual void extractLine();
87     virtual void attachLine();
88
89     virtual RenderObject::SelectionState selectionState();
90
91     virtual void clearTruncation() { m_truncation = cNoTruncation; }
92     virtual int placeEllipsisBox(bool ltr, int blockEdge, int ellipsisWidth, bool& foundBox);
93
94     // Overloaded new operator.  Derived classes must override operator new
95     // in order to allocate out of the RenderArena.
96     void* operator new(size_t sz, RenderArena* renderArena) throw();    
97
98     // Overridden to prevent the normal delete from being called.
99     void operator delete(void* ptr, size_t sz);
100         
101 private:
102     // The normal operator new is disallowed.
103     void* operator new(size_t sz) throw();
104
105 public:
106     void setSpaceAdd(int add) { m_width -= m_toAdd; m_toAdd = add; m_width += m_toAdd; }
107     int spaceAdd() { return m_toAdd; }
108
109     virtual bool isInlineTextBox() { return true; }    
110     virtual bool isText() const { return m_treatAsText; }
111     void setIsText(bool b) { m_treatAsText = b; }
112     
113     void paintDecoration( QPainter *pt, int _tx, int _ty, int decoration);
114     void paintSelection(const Font *f, RenderText *text, QPainter *p, RenderStyle* style, int tx, int ty, int startPos, int endPos);
115 #if APPLE_CHANGES
116     void paintMarkedTextBackground(const Font *f, RenderText *text, QPainter *p, RenderStyle* style, int tx, int ty, int startPos, int endPos);
117 #endif
118     void paintMarker(QPainter *pt, int _tx, int _ty, DOM::DocumentMarker marker);
119
120     virtual long caretMinOffset() const;
121     virtual long caretMaxOffset() const;
122     virtual unsigned long caretMaxRenderedOffset() const;
123     
124     int offsetForPosition(int _x, bool includePartialGlyphs = true);
125     
126     /**
127      * if this text run was rendered @ref _ty pixels below the upper edge
128      * of a view, would the @ref _y -coordinate be inside the vertical range
129      * of this object's representation?
130      */
131     bool checkVerticalPoint(int _y, int _ty, int _h);
132
133     int m_start;
134     unsigned short m_len;
135     
136     int m_truncation; // Where to truncate when text overflow is applied.  We use special constants to
137                       // denote no truncation (the whole run paints) and full truncation (nothing paints at all).
138
139     bool m_reversed : 1;
140     bool m_treatAsText : 1; // Whether or not to treat a <br> as text for the purposes of line height.
141     int m_toAdd : 14; // for justified text
142
143 private:
144     friend class RenderText;
145 };
146
147 class RenderText : public RenderObject
148 {
149     friend class InlineTextBox;
150
151 public:
152     RenderText(DOM::NodeImpl* node, DOM::DOMStringImpl *_str);
153     virtual ~RenderText();
154
155     virtual bool isTextFragment() const;
156     virtual DOM::DOMStringImpl* originalString() const;
157     
158     virtual const char *renderName() const { return "RenderText"; }
159
160     virtual void setStyle(RenderStyle *style);
161     
162     virtual void paint(PaintInfo& i, int tx, int ty);
163
164     void extractTextBox(InlineTextBox* textBox);
165     void attachTextBox(InlineTextBox* textBox);
166     void removeTextBox(InlineTextBox* textBox);
167     void deleteTextBoxes();
168     virtual void detach();
169     
170     DOM::DOMString data() const { return str; }
171     DOM::DOMStringImpl *string() const { return str; }
172
173     virtual InlineBox* createInlineBox(bool,bool, bool isOnlyRun = false);
174     virtual void dirtyLineBoxes(bool fullLayout, bool isRootInlineBox = false);
175     
176     virtual void layout() {assert(false);}
177
178     virtual bool nodeAtPoint(NodeInfo& info, int x, int y, int tx, int ty,
179                              HitTestAction hitTestAction = HitTestAll, bool inside=false);
180
181     virtual void absoluteRects(QValueList<QRect>& rects, int _tx, int _ty);
182
183     virtual DOM::Position positionForCoordinates(int x, int y, EAffinity * = 0);
184
185     unsigned int length() const { return str->l; }
186     QChar *text() const { return str->s; }
187     unsigned int stringLength() const { return str->l; } // non virtual implementation of length()
188     virtual void position(InlineBox* box, int from, int len, bool reverse);
189
190     virtual unsigned int width(unsigned int from, unsigned int len, const Font *f) const;
191     virtual unsigned int width(unsigned int from, unsigned int len, bool firstLine = false) const;
192     virtual int width() const;
193     virtual int height() const;
194
195     // height of the contents (without paddings, margins and borders)
196     virtual short lineHeight( bool firstLine, bool isRootLineBox=false ) const;
197     virtual short baselinePosition( bool firstLine, bool isRootLineBox=false ) const;
198
199     // overrides
200     virtual void calcMinMaxWidth();
201     virtual int minWidth() const { return m_minWidth; }
202     virtual int maxWidth() const { return m_maxWidth; }
203     virtual void trimmedMinMaxWidth(int& beginMinW, bool& beginWS, 
204                                     int& endMinW, bool& endWS,
205                                     bool& hasBreakableChar, bool& hasBreak,
206                                     int& beginMaxW, int& endMaxW,
207                                     int& minW, int& maxW, bool& stripFrontSpaces);
208     
209     bool containsOnlyWhitespace(unsigned int from, unsigned int len) const;
210     
211     // returns the minimum x position of all runs relative to the parent.
212     // defaults to 0.
213     int minXPos() const;
214
215     virtual int xPos() const;
216     virtual int yPos() const;
217
218     virtual const QFont &font();
219     virtual short verticalPositionHint( bool firstLine ) const;
220
221     void setText(DOM::DOMStringImpl *text, bool force=false);
222     void setTextWithOffset(DOM::DOMStringImpl *text, uint offset, uint len, bool force=false);
223
224     virtual bool canBeSelectionLeaf() const { return true; }
225     virtual SelectionState selectionState() const {return m_selectionState;}
226     virtual void setSelectionState(SelectionState s);
227     virtual QRect selectionRect();
228     virtual QRect caretRect(int offset, EAffinity affinity, int *extraWidthToEndOfLine = 0);
229     void posOfChar(int ch, int &x, int &y);
230
231     virtual int marginLeft() const { return style()->marginLeft().minWidth(0); }
232     virtual int marginRight() const { return style()->marginRight().minWidth(0); }
233
234     virtual QRect getAbsoluteRepaintRect();
235
236     const QFontMetrics &metrics(bool firstLine) const;
237     const Font *htmlFont(bool firstLine) const;
238
239     DOM::TextImpl *element() const
240     { return static_cast<DOM::TextImpl*>(RenderObject::element()); }
241
242     InlineTextBox* firstTextBox() const { return m_firstTextBox; }
243     InlineTextBox* lastTextBox() const { return m_lastTextBox; }
244     
245     virtual InlineBox *inlineBox(long offset, EAffinity affinity = UPSTREAM);
246
247 #if APPLE_CHANGES
248     int widthFromCache(const Font *, int start, int len) const;
249     bool shouldUseMonospaceCache(const Font *) const;
250     void cacheWidths();
251     bool allAscii() const;
252 #endif
253
254     virtual long caretMinOffset() const;
255     virtual long caretMaxOffset() const;
256     virtual unsigned long caretMaxRenderedOffset() const;
257     
258 #if APPLE_CHANGES
259 public:
260 #endif
261     InlineTextBox * findNextInlineTextBox( int offset, int &pos );
262
263 protected: // members
264     DOM::DOMStringImpl *str;
265     
266     InlineTextBox* m_firstTextBox;
267     InlineTextBox* m_lastTextBox;
268     
269     int m_minWidth;
270     int m_maxWidth;
271     int m_beginMinWidth;
272     int m_endMinWidth;
273     
274     SelectionState m_selectionState : 3 ;
275     bool m_hasBreakableChar : 1; // Whether or not we can be broken into multiple lines.
276     bool m_hasBreak : 1; // Whether or not we have a hard break (e.g., <pre> with '\n').
277     bool m_hasBeginWS : 1; // Whether or not we begin with WS (only true if we aren't pre)
278     bool m_hasEndWS : 1; // Whether or not we end with WS (only true if we aren't pre)
279     
280     bool m_linesDirty : 1; // This bit indicates that the text run has already dirtied specific
281                            // line boxes, and this hint will enable layoutInlineChildren to avoid
282                            // just dirtying everything when character data is modified (e.g., appended/inserted
283                            // or removed).
284
285     // 22 bits left
286 #if APPLE_CHANGES
287     mutable bool m_allAsciiChecked:1;
288     mutable bool m_allAscii:1;
289     int m_monospaceCharacterWidth;
290 #endif
291 };
292
293 // Used to represent a text substring of an element, e.g., for text runs that are split because of
294 // first letter and that must therefore have different styles (and positions in the render tree).
295 // We cache offsets so that text transformations can be applied in such a way that we can recover
296 // the original unaltered string from our corresponding DOM node.
297 class RenderTextFragment : public RenderText
298 {
299 public:
300     RenderTextFragment(DOM::NodeImpl* _node, DOM::DOMStringImpl* _str,
301                        int startOffset, int endOffset);
302     RenderTextFragment(DOM::NodeImpl* _node, DOM::DOMStringImpl* _str);
303     ~RenderTextFragment();
304     
305     virtual bool isTextFragment() const;
306     
307     uint start() const { return m_start; }
308     uint end() const { return m_end; }
309     
310     DOM::DOMStringImpl* contentString() const { return m_generatedContentStr; }
311     virtual DOM::DOMStringImpl* originalString() const;
312     
313 private:
314     uint m_start;
315     uint m_end;
316     DOM::DOMStringImpl* m_generatedContentStr;
317 };
318 };
319 #endif