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