Patch written mostly by Ken Kraisler, but also by me.
[WebKit-https.git] / WebCore / rendering / RenderObject.h
1 /*
2  * This file is part of the html renderer for KDE.
3  *
4  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
5  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
6  *           (C) 2000 Dirk Mueller (mueller@kde.org)
7  *           (C) 2004 Allan Sandfeld Jensen (kde@carewolf.com)
8  * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 02111-1307, USA.
24  *
25  */
26
27 #ifndef RenderObject_h
28 #define RenderObject_h
29
30 #include "CachedResourceClient.h"
31 #include "DeprecatedValueList.h"
32 #include "Document.h"
33 #include "RenderStyle.h"
34 #include "ScrollBar.h"
35 #include "VisiblePosition.h"
36 #include <wtf/HashMap.h>
37
38 /*
39  *  The painting of a layer occurs in three distinct phases.  Each phase involves
40  *  a recursive descent into the layer's render objects. The first phase is the background phase.
41  *  The backgrounds and borders of all blocks are painted.  Inlines are not painted at all.
42  *  Floats must paint above block backgrounds but entirely below inline content that can overlap them.
43  *  In the foreground phase, all inlines are fully painted.  Inline replaced elements will get all
44  *  three phases invoked on them during this phase.
45  */
46
47 namespace WebCore {
48
49 class AffineTransform;
50 class CollapsedBorderValue;
51 class Color;
52 class CounterNode;
53 class Document;
54 class Element;
55 class Event;
56 class FloatRect;
57 class FrameView;
58 class HTMLAreaElement;
59 class InlineBox;
60 class InlineFlowBox;
61 class PlatformScrollbar;
62 class Position;
63 class RenderArena;
64 class RenderBlock;
65 class RenderFlow;
66 class RenderFrameSet;
67 class RenderLayer;
68 class RenderTable;
69 class RenderText;
70 class RenderView;
71 class String;
72 class TextStream;
73 class VisiblePosition;
74
75 enum PaintPhase {
76     PaintPhaseBlockBackground,
77     PaintPhaseChildBlockBackground,
78     PaintPhaseChildBlockBackgrounds,
79     PaintPhaseFloat,
80     PaintPhaseForeground,
81     PaintPhaseOutline,
82     PaintPhaseChildOutlines,
83     PaintPhaseSelfOutline,
84     PaintPhaseSelection,
85     PaintPhaseCollapsedTableBorders
86 };
87
88 enum PaintRestriction {
89     PaintRestrictionNone,
90     PaintRestrictionSelectionOnly,
91     PaintRestrictionSelectionOnlyWhiteText
92 };
93
94 enum HitTestFilter {
95     HitTestAll,
96     HitTestSelf,
97     HitTestDescendants
98 };
99
100 enum HitTestAction {
101     HitTestBlockBackground,
102     HitTestChildBlockBackground,
103     HitTestChildBlockBackgrounds,
104     HitTestFloat,
105     HitTestForeground
106 };
107
108 struct DashboardRegionValue
109 {
110     String label;
111     IntRect bounds;
112     IntRect clip;
113     int type;
114
115     bool operator==(const DashboardRegionValue& o) const
116     {
117         return type == o.type && bounds == o.bounds && label == o.label;
118     }
119 };
120
121 // FIXME: This should be a HashSequencedSet, but we don't have that data structure yet.
122 // This means the paint order of outlines will be wrong, although this is a minor issue.
123 typedef HashSet<RenderFlow*> RenderFlowSequencedSet;
124
125 /**
126  * Base Class for all rendering tree objects.
127  */
128 class RenderObject : public CachedResourceClient
129 {
130 public:
131     // Anonymous objects should pass the document as their node, and they will then automatically be
132     // marked as anonymous in the constructor.
133     RenderObject(Node* node);
134     virtual ~RenderObject();
135
136     RenderObject *parent() const { return m_parent; }
137     bool isDescendantOf(const RenderObject *obj) const;
138
139     RenderObject *previousSibling() const { return m_previous; }
140     RenderObject *nextSibling() const { return m_next; }
141
142     virtual RenderObject *firstChild() const { return 0; }
143     virtual RenderObject *lastChild() const { return 0; }
144
145     RenderObject* nextInPreOrder() const;
146     RenderObject* nextInPreOrderAfterChildren() const;
147     RenderObject* previousInPreOrder() const;
148     RenderObject* childAt(unsigned) const;
149
150     RenderObject *nextEditable() const; 
151     RenderObject *previousEditable() const; 
152
153     RenderObject *firstLeafChild() const;
154     RenderObject *lastLeafChild() const;
155     
156     virtual RenderLayer* layer() const { return 0; }
157     RenderLayer* enclosingLayer() const;
158     void addLayers(RenderLayer* parentLayer, RenderObject* newObject);
159     void removeLayers(RenderLayer* parentLayer);
160     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
161     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint,
162                                bool checkParent=true);
163     virtual void positionChildLayers() { }
164     virtual bool requiresLayer();
165     
166     virtual IntRect getOverflowClipRect(int tx, int ty) { return IntRect(0,0,0,0); }
167     virtual IntRect getClipRect(int tx, int ty) { return IntRect(0,0,0,0); }
168     bool hasClip() { return isPositioned() &&  style()->hasClip(); }
169     
170     virtual int getBaselineOfFirstLineBox() const { return -1; } 
171     virtual int getBaselineOfLastLineBox() const { return -1; }
172     virtual bool isEmpty() const { return firstChild() == 0; }
173         
174     virtual bool isEdited() const { return false; }
175     virtual void setEdited(bool) { return; };
176     
177     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
178     // children.
179     virtual RenderBlock* firstLineBlock() const;
180     virtual void updateFirstLetter();
181     
182     // Called when an object that was floating or positioned becomes a normal flow object
183     // again.  We have to make sure the render tree updates as needed to accommodate the new
184     // normal flow object.
185     void handleDynamicFloatPositionChange();
186
187     // This function is a convenience helper for creating an anonymous block that inherits its
188     // style from this RenderObject.
189     RenderBlock* createAnonymousBlock();
190     
191     // Whether or not a positioned element requires normal flow x/y to be computed
192     // to determine its position.
193     bool hasStaticX() const;
194     bool hasStaticY() const;
195     virtual void setStaticX(int staticX) {};
196     virtual void setStaticY(int staticY) {};
197     virtual int staticX() const { return 0; }
198     virtual int staticY() const { return 0; }
199     
200     CounterNode* findCounter(const String& counterName, bool willNeedLayout = false,
201         bool usesSeparator = false, bool createIfNotFound = true);
202
203 public:
204     // RenderObject tree manipulation
205     //////////////////////////////////////////
206     virtual bool canHaveChildren() const;
207     virtual void addChild(RenderObject *newChild, RenderObject *beforeChild = 0);
208     virtual void removeChild(RenderObject *oldChild);
209     virtual bool createsAnonymousWrapper() const { return false; }
210
211     // raw tree manipulation
212     virtual RenderObject* removeChildNode(RenderObject* child);
213     virtual void appendChildNode(RenderObject* child);
214     virtual void insertChildNode(RenderObject* child, RenderObject* before);
215     //////////////////////////////////////////
216
217 protected:
218     //////////////////////////////////////////
219     // Helper functions. Dangerous to use!
220     void setPreviousSibling(RenderObject *previous) { m_previous = previous; }
221     void setNextSibling(RenderObject *next) { m_next = next; }
222     void setParent(RenderObject *parent) { m_parent = parent; }
223     //////////////////////////////////////////
224 private:
225     void addAbsoluteRectForLayer(IntRect& result);
226
227 public:
228     virtual const char *renderName() const { return "RenderObject"; }
229 #ifndef NDEBUG
230     DeprecatedString information() const;
231     virtual void dump(TextStream *stream, DeprecatedString ind = "") const;
232     void showTreeForThis() const;
233 #endif
234
235     static RenderObject *createObject(Node* node, RenderStyle* style);
236
237     // Overloaded new operator.  Derived classes must override operator new
238     // in order to allocate out of the RenderArena.
239     void* operator new(size_t sz, RenderArena* renderArena) throw();    
240
241     // Overridden to prevent the normal delete from being called.
242     void operator delete(void* ptr, size_t sz);
243         
244 private:
245     // The normal operator new is disallowed on all render objects.
246     void* operator new(size_t sz) throw();
247     
248 public:
249     RenderArena* renderArena() const;
250     
251     // some helper functions...
252     virtual bool isRenderBlock() const { return false; }
253     virtual bool isRenderInline() const { return false; }
254     virtual bool isInlineFlow() const { return false; }
255     virtual bool isBlockFlow() const { return false; }
256     virtual bool isInlineBlockOrInlineTable() const { return false; }
257     virtual bool childrenInline() const { return false; }
258     virtual void setChildrenInline(bool b) { };
259
260     virtual RenderFlow* continuation() const;
261     virtual bool isInlineContinuation() const;
262     
263     virtual bool isListItem() const { return false; }
264     virtual bool isListMarker() const { return false; }
265     virtual bool isCounter() const { return false; }
266     virtual bool isRenderView() const { return false; }
267     bool isRoot() const;
268     bool isBody() const;
269     bool isHR() const;
270     virtual bool isBR() const { return false; }
271     virtual bool isTableCell() const { return false; }
272     virtual bool isTableRow() const { return false; }
273     virtual bool isTableSection() const { return false; }
274     virtual bool isTableCol() const { return false; }
275     virtual bool isTable() const { return false; }
276     virtual bool isWidget() const { return false; }
277     virtual bool isFormElement() const { return false; }
278     virtual bool isImage() const { return false; }
279     virtual bool isTextArea() const { return false; }
280     virtual bool isTextField() const { return false; }
281     virtual bool isFrameSet() const { return false; }
282     virtual bool isApplet() const { return false; }
283     virtual bool isMenuList() const { return false; }
284     virtual bool isListBox() const { return false; }
285     
286 #ifdef SVG_SUPPORT
287     virtual bool isKCanvasContainer() const { return false; }
288     virtual bool isRenderPath() const { return false; }
289     virtual FloatRect relativeBBox(bool includeStroke = true) const;
290     // We may eventually want to make these non-virtual
291     virtual AffineTransform localTransform() const;
292     virtual void setLocalTransform(const AffineTransform&);
293     virtual AffineTransform absoluteTransform() const;
294 #endif
295     
296     virtual bool isEditable() const;
297
298     bool isHTMLMarquee() const;
299     
300     bool isAnonymous() const { return m_isAnonymous; }
301     void setIsAnonymous(bool b) { m_isAnonymous = b; }
302     bool isAnonymousBlock() const { return m_isAnonymous && 
303                                            style()->display() == BLOCK && 
304                                            style()->styleType() == RenderStyle::NOPSEUDO &&
305                                            !isListMarker(); }
306     
307     bool isFloating() const { return m_floating; }
308     bool isPositioned() const { return m_positioned; } // absolute or fixed positioning
309     bool isRelPositioned() const { return m_relPositioned; } // relative positioning
310     bool isText() const  { return m_isText; }
311     bool isInline() const { return m_inline; }  // inline object
312     bool isCompact() const { return style()->display() == COMPACT; } // compact object
313     bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
314     bool isDragging() const;
315     bool isReplaced() const { return m_replaced; } // a "replaced" element (see CSS)
316     bool shouldPaintBackgroundOrBorder() const { return m_paintBackground; }
317     bool mustRepaintBackgroundOrBorder() const;
318     bool needsLayout() const   { return m_needsLayout || m_normalChildNeedsLayout || m_posChildNeedsLayout; }
319     bool selfNeedsLayout() const { return m_needsLayout; }
320     bool posChildNeedsLayout() const { return m_posChildNeedsLayout; }
321     bool normalChildNeedsLayout() const { return m_normalChildNeedsLayout; }
322     bool minMaxKnown() const{ return m_minMaxKnown; }
323     bool recalcMinMax() const { return m_recalcMinMax; }
324     bool isSelectionBorder() const;
325     
326     bool hasOverflowClip() const { return m_hasOverflowClip; }
327     
328     bool hasAutoVerticalScrollbar() const { return hasOverflowClip() && (style()->overflowY() == OAUTO || style()->overflowY() == OOVERLAY); }
329     bool hasAutoHorizontalScrollbar() const { return hasOverflowClip() && (style()->overflowX() == OAUTO || style()->overflowX() == OOVERLAY); }
330
331     bool scrollsOverflow() const { return scrollsOverflowX() || scrollsOverflowY(); }
332     bool scrollsOverflowX() const { return hasOverflowClip() && (style()->overflowX() == OSCROLL || hasAutoHorizontalScrollbar()); }
333     bool scrollsOverflowY() const { return hasOverflowClip() && (style()->overflowY() == OSCROLL || hasAutoVerticalScrollbar()); }
334     
335     bool includeVerticalScrollbarSize() const { return hasOverflowClip() && (style()->overflowY() == OSCROLL || style()->overflowY() == OAUTO); }
336     bool includeHorizontalScrollbarSize() const { return hasOverflowClip() && (style()->overflowX() == OSCROLL || style()->overflowX() == OAUTO); }
337
338     RenderStyle* getPseudoStyle(RenderStyle::PseudoId pseudo, RenderStyle* parentStyle = 0) const;
339     
340     void updateDragState(bool dragOn);
341
342     RenderView* view() const;
343
344     // don't even think about making this method virtual!
345     Node* element() const { return m_isAnonymous ? 0 : m_node; }
346     Document* document() const { return m_node->document(); }
347     void setNode(Node* node) { m_node = node; }
348     Node* node() const { return m_node; }
349     
350     bool hasOutlineAnnotation() { return element() && element()->isLink() && document()->printing(); }
351     bool hasOutline() { return style()->hasOutline() || hasOutlineAnnotation(); }
352    
353    /**
354      * returns the object containing this one. can be different from parent for
355      * positioned elements
356      */
357     RenderObject *container() const;
358     RenderObject* hoverAncestor() const;
359
360     virtual void markAllDescendantsWithFloatsForLayout(RenderObject* floatToRemove = 0);
361     void markContainingBlocksForLayout(bool scheduleRelayout = true);
362     void setNeedsLayout(bool b, bool markParents = true);
363     void setChildNeedsLayout(bool b, bool markParents = true);
364     void setMinMaxKnown(bool b=true) {
365         m_minMaxKnown = b;
366         if ( !b ) {
367             RenderObject *o = this;
368             RenderObject *root = this;
369             while( o ) { // ### && !o->m_recalcMinMax ) {
370                 o->m_recalcMinMax = true;
371                 root = o;
372                 o = o->m_parent;
373             }
374         }
375     }
376
377     void setNeedsLayoutAndMinMaxRecalc() {
378         setMinMaxKnown(false);
379         setNeedsLayout(true);
380     }
381     
382     void setPositioned(bool b=true)  { m_positioned = b;  }
383     void setRelPositioned(bool b=true) { m_relPositioned = b; }
384     void setFloating(bool b=true) { m_floating = b; }
385     void setInline(bool b=true) { m_inline = b; }
386     void setShouldPaintBackgroundOrBorder(bool b=true) { m_paintBackground = b; }
387     void setRenderText() { m_isText = true; }
388     void setReplaced(bool b=true) { m_replaced = b; }
389     void setHasOverflowClip(bool b = true) { m_hasOverflowClip = b; }
390
391     void scheduleRelayout();
392     
393     void updateBackgroundImages(RenderStyle* oldStyle);
394
395     virtual InlineBox* createInlineBox(bool makePlaceHolderBox, bool isRootLineBox, bool isOnlyRun=false);
396     virtual void dirtyLineBoxes(bool fullLayout, bool isRootLineBox=false);
397     
398     // For inline replaced elements, this function returns the inline box that owns us.  Enables
399     // the replaced RenderObject to quickly determine what line it is contained on and to easily
400     // iterate over structures on the line.
401     virtual InlineBox* inlineBoxWrapper() const;
402     virtual void setInlineBoxWrapper(InlineBox* b);
403     virtual void deleteLineBoxWrapper();
404
405     virtual InlineBox *inlineBox(int offset=0, EAffinity affinity = UPSTREAM);
406     
407     // for discussion of lineHeight see CSS2 spec
408     virtual short lineHeight( bool firstLine, bool isRootLineBox=false ) const;
409     // for the vertical-align property of inline elements
410     // the difference between this objects baseline position and the lines baseline position.
411     virtual short verticalPositionHint( bool firstLine ) const;
412     // the offset of baseline from the top of the object.
413     virtual short baselinePosition( bool firstLine, bool isRootLineBox=false ) const;
414     // width of tab character
415     int tabWidth() const;
416
417     /*
418      * Paint the object and its children, clipped by (x|y|w|h).
419      * (tx|ty) is the calculated position of the parent
420      */
421     struct PaintInfo {
422         PaintInfo(GraphicsContext* _p, const IntRect& _r, PaintPhase _phase, bool _forceWhiteText, RenderObject* _paintingRoot, RenderFlowSequencedSet* _outlineObjects)
423             : p(_p), r(_r), phase(_phase), forceWhiteText(_forceWhiteText), paintingRoot(_paintingRoot), outlineObjects(_outlineObjects) {}
424         GraphicsContext* p;
425         IntRect r;
426         PaintPhase phase;
427         bool forceWhiteText;
428         RenderObject* paintingRoot; // used to draw just one element and its visual kids
429         RenderFlowSequencedSet* outlineObjects; // used to list outlines that should be painted by a block with inline children
430     };
431     virtual void paint(PaintInfo&, int tx, int ty);
432     void paintBorder(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, bool begin = true, bool end = true);
433     bool paintBorderImage(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle* style);
434     void paintOutline(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle* style);
435
436     // RenderBox implements this.
437     virtual void paintBoxDecorations(PaintInfo&, int tx, int ty) {}
438
439     virtual void paintBackgroundExtended(GraphicsContext*, const Color&, const BackgroundLayer*, int clipy, int cliph,
440         int tx, int ty, int w, int height, int bleft, int bright, int pleft, int pright) {}
441
442     /*
443      * This function calculates the minimum & maximum width that the object
444      * can be set to.
445      *
446      * when the Element calls setMinMaxKnown(true), calcMinMaxWidth() will
447      * be no longer called.
448      *
449      * when a element has a fixed size, m_minWidth and m_maxWidth should be
450      * set to the same value. This has the special meaning that m_width,
451      * contains the actual value.
452      *
453      * assumes calcMinMaxWidth has already been called for all children.
454      */
455     virtual void calcMinMaxWidth() { }
456
457     /*
458      * Does the min max width recalculations after changes.
459      */
460     void recalcMinMaxWidths();
461
462     /*
463      * Calculates the actual width of the object (only for non inline
464      * objects)
465      */
466     virtual void calcWidth() {}
467
468     /*
469      * This function should cause the Element to calculate its
470      * width and height and the layout of its content
471      *
472      * when the Element calls setNeedsLayout(false), layout() is no
473      * longer called during relayouts, as long as there is no
474      * style sheet change. When that occurs, m_needsLayout will be
475      * set to true and the Element receives layout() calls
476      * again.
477      */
478     virtual void layout() = 0;
479
480     /* This function performs a layout only if one is needed. */
481     void layoutIfNeeded() { if (needsLayout()) layout(); }
482
483     // used for element state updates that can not be fixed with a
484     // repaint and do not need a relayout
485     virtual void updateFromElement() {};
486
487     virtual int availableHeight() const { return 0; }
488
489     virtual void updateWidgetPosition();
490     
491     void addDashboardRegions(Vector<DashboardRegionValue>&);
492     void collectDashboardRegions(Vector<DashboardRegionValue>&);
493
494     // does a query on the rendertree and finds the innernode
495     // and overURL for the given position
496     // if readonly == false, it will recalc hover styles accordingly
497     class NodeInfo {
498     public:
499         NodeInfo(bool readonly, bool active, bool mouseMove = false)
500             : m_innerNode(0), m_innerNonSharedNode(0), m_innerURLElement(0), 
501               m_scrollbar(0), m_readonly(readonly), m_active(active), m_mouseMove(mouseMove)
502             { }
503
504         Node* innerNode() const { return m_innerNode; }
505         Node* innerNonSharedNode() const { return m_innerNonSharedNode; }
506         Element* URLElement() const { return m_innerURLElement; }
507         PlatformScrollbar* scrollbar() const { return m_scrollbar; }
508         bool readonly() const { return m_readonly; }
509         bool active() const { return m_active; }
510         bool mouseMove() const { return m_mouseMove; }
511         
512         void setInnerNode(Node* n) { m_innerNode = n; }
513         void setInnerNonSharedNode(Node* n) { m_innerNonSharedNode = n; }
514         void setURLElement(Element* n) { m_innerURLElement = n; }
515         void setScrollbar(PlatformScrollbar* s) { m_scrollbar = s; }
516
517     private:
518         Node* m_innerNode;
519         Node* m_innerNonSharedNode;
520         Element* m_innerURLElement;
521         PlatformScrollbar* m_scrollbar;
522         bool m_readonly;
523         bool m_active;
524         bool m_mouseMove;
525     };
526
527     // Used to signal a specific subrect within an object that must be repainted after
528     // layout is complete.
529     struct RepaintInfo {
530         RenderObject* m_object;
531         IntRect m_repaintRect;
532     
533         RepaintInfo(RenderObject* o, const IntRect& r) :m_object(o), m_repaintRect(r) {}
534     };
535     
536     bool hitTest(NodeInfo& info, int x, int y, int tx, int ty, HitTestFilter hitTestFilter = HitTestAll);
537     virtual bool nodeAtPoint(NodeInfo& info, int x, int y, int tx, int ty,
538                              HitTestAction hitTestAction);
539     void setInnerNode(NodeInfo& info);
540
541     virtual VisiblePosition positionForCoordinates(int x, int y);
542     VisiblePosition positionForPoint(const IntPoint& point) { return positionForCoordinates(point.x(), point.y()); }
543     
544     virtual void dirtyLinesFromChangedChild(RenderObject* child);
545     
546     // Set the style of the object and update the state of the object accordingly.
547     virtual void setStyle(RenderStyle* style);
548
549     // Updates only the local style ptr of the object.  Does not update the state of the object,
550     // and so only should be called when the style is known not to have changed (or from setStyle).
551     void setStyleInternal(RenderStyle* style);
552
553     // returns the containing block level element for this element.
554     RenderBlock *containingBlock() const;
555
556     // return just the width of the containing block
557     virtual int containingBlockWidth() const;
558     // return just the height of the containing block
559     virtual int containingBlockHeight() const;
560
561     // size of the content area (box size minus padding/border)
562     virtual int contentWidth() const { return 0; }
563     virtual int contentHeight() const { return 0; }
564
565     // intrinsic extend of replaced elements. undefined otherwise
566     virtual int intrinsicWidth() const { return 0; }
567     virtual int intrinsicHeight() const { return 0; }
568
569     // used by flexible boxes to impose a flexed width/height override
570     virtual int overrideSize() const { return 0; }
571     virtual int overrideWidth() const { return 0; }
572     virtual int overrideHeight() const { return 0; }
573     virtual void setOverrideSize(int s) {}
574
575     // relative to parent node
576     virtual void setPos( int /*xPos*/, int /*yPos*/ ) { }
577     virtual void setWidth( int /*width*/ ) { }
578     virtual void setHeight( int /*height*/ ) { }
579
580     virtual int xPos() const { return 0; }
581     virtual int yPos() const { return 0; }
582
583     // calculate client position of box
584     virtual bool absolutePosition(int &/*xPos*/, int &/*yPos*/, bool fixed = false);
585     
586     // This function is used to deal with the extra top space that can occur in table cells (called borderTopExtra).
587     // The children of the cell do not factor this space in, so we have to add it in.  Any code that wants to
588     // accurately deal with the contents of a cell must call this function instad of absolutePosition.
589     void absolutePositionForContent(int& xPos, int& yPos, bool fixed = false) {
590         absolutePosition(xPos, yPos, fixed);
591         yPos += borderTopExtra();
592     }
593
594     // width and height are without margins but include paddings and borders
595     virtual int width() const { return 0; }
596     virtual int height() const { return 0; }
597
598     virtual IntRect borderBox() const { return IntRect(0, 0, width(), height()); }
599
600     // The height of a block when you include normal flow overflow spillage out of the bottom
601     // of the block (e.g., a <div style="height:25px"> that has a 100px tall image inside
602     // it would have an overflow height of borderTop() + paddingTop() + 100px.
603     virtual int overflowHeight(bool includeInterior=true) const { return height(); }
604     virtual int overflowWidth(bool includeInterior=true) const { return width(); }
605     virtual void setOverflowHeight(int) {}
606     virtual void setOverflowWidth(int) {}
607     virtual int overflowLeft(bool includeInterior=true) const { return 0; }
608     virtual int overflowTop(bool includeInterior=true) const { return 0; }
609     virtual IntRect overflowRect(bool includeInterior=true) const { return borderBox(); }
610
611     // IE extensions. Used to calculate offsetWidth/Height.  Overridden by inlines (RenderFlow) 
612     // to return the remaining width on a given line (and the height of a single line). -dwh
613     virtual int offsetWidth() const { return width(); }
614     virtual int offsetHeight() const { return height() + borderTopExtra() + borderBottomExtra(); }
615     
616     // IE exxtensions.  Also supported by Gecko.  We override in render flow to get the
617     // left and top correct. -dwh
618     virtual int offsetLeft() const;
619     virtual int offsetTop() const;
620     virtual RenderObject* offsetParent() const;
621
622     // More IE extensions.  clientWidth and clientHeight represent the interior of an object
623     // excluding border and scrollbar.  clientLeft/Top are just the borderLeftWidth and borderTopWidth.
624     int clientLeft() const { return borderLeft(); }
625     int clientTop() const { return borderTop(); }
626     int clientWidth() const;
627     int clientHeight() const;
628
629     // scrollWidth/scrollHeight will be the same as clientWidth/clientHeight unless the
630     // object has overflow:hidden/scroll/auto specified and also has overflow.
631     // scrollLeft/Top return the current scroll position.  These methods are virtual so that objects like
632     // textareas can scroll shadow content (but pretend that they are the objects that are
633     // scrolling).
634     virtual int scrollLeft() const;
635     virtual int scrollTop() const;
636     virtual int scrollWidth() const;
637     virtual int scrollHeight() const;
638     virtual void setScrollLeft(int);
639     virtual void setScrollTop(int);
640
641     virtual bool scroll(ScrollDirection direction, ScrollGranularity granularity, float multiplier=1.0);
642     virtual bool shouldAutoscroll() const;
643     virtual void autoscroll();
644
645     // The following seven functions are used to implement collapsing margins.
646     // All objects know their maximal positive and negative margins.  The
647     // formula for computing a collapsed margin is |maxPosMargin|-|maxNegmargin|.
648     // For a non-collapsing, e.g., a leaf element, this formula will simply return
649     // the margin of the element.  Blocks override the maxTopMargin and maxBottomMargin
650     // methods.
651     virtual bool isSelfCollapsingBlock() const { return false; }
652     virtual int collapsedMarginTop() const 
653         { return maxTopMargin(true)-maxTopMargin(false); }
654     virtual int collapsedMarginBottom() const 
655         { return maxBottomMargin(true)-maxBottomMargin(false); }
656     virtual bool isTopMarginQuirk() const { return false; }
657     virtual bool isBottomMarginQuirk() const { return false; }
658     virtual int maxTopMargin(bool positive) const {
659         if (positive)
660             if (marginTop() > 0)
661                 return marginTop();
662             else
663                 return 0;
664         else
665             if (marginTop() < 0)
666                 return 0 - marginTop();
667             else
668                 return 0;
669     }
670     virtual int maxBottomMargin(bool positive) const {
671         if (positive)
672             if (marginBottom() > 0)
673                 return marginBottom();
674             else
675                 return 0;
676         else
677             if (marginBottom() < 0)
678                 return 0 - marginBottom();
679             else
680                 return 0;
681     }
682
683     virtual int marginTop() const { return 0; }
684     virtual int marginBottom() const { return 0; }
685     virtual int marginLeft() const { return 0; }
686     virtual int marginRight() const { return 0; }
687
688     // Virtual since table cells override 
689     virtual int paddingTop() const;
690     virtual int paddingBottom() const;
691     virtual int paddingLeft() const;
692     virtual int paddingRight() const;
693     
694     virtual int borderTop() const { return style()->borderTopWidth(); }
695     virtual int borderBottom() const { return style()->borderBottomWidth(); }
696     virtual int borderTopExtra() const { return 0; }
697     virtual int borderBottomExtra() const { return 0; }
698     virtual int borderLeft() const { return style()->borderLeftWidth(); }
699     virtual int borderRight() const { return style()->borderRightWidth(); }
700
701     virtual void lineBoxRects(Vector<IntRect>&);
702
703     virtual void absoluteRects(Vector<IntRect>&, int tx, int ty);
704     IntRect absoluteBoundingBoxRect();
705     
706     // the rect that will be painted if this object is passed as the paintingRoot
707     IntRect paintingRootRect(IntRect& topLevelRect);
708
709     void addPDFURLRect(GraphicsContext* p, IntRect rect);
710
711     virtual void addFocusRingRects(GraphicsContext*, int tx, int ty);
712
713     virtual int minWidth() const { return 0; }
714     virtual int maxWidth() const { return 0; }
715
716     RenderStyle* style() const { return m_style; }
717     RenderStyle* firstLineStyle() const;
718     RenderStyle* style(bool firstLine) const { return firstLine ? firstLineStyle() : style(); }
719
720
721     void getTextDecorationColors(int decorations, Color& underline, Color& overline,
722                                  Color& linethrough, bool quirksMode=false);
723
724     enum BorderSide {
725         BSTop, BSBottom, BSLeft, BSRight
726     };
727     void drawBorderArc(GraphicsContext*, int x, int y, float thickness, IntSize radius, int angleStart,
728         int angleSpan, BorderSide, Color, const Color& textcolor, EBorderStyle, bool firstCorner);
729     void drawBorder(GraphicsContext*, int x1, int y1, int x2, int y2, BorderSide,
730         Color, const Color& textcolor, EBorderStyle, int adjbw1, int adjbw2);
731
732     virtual void setTable(RenderTable*) {};
733
734     // Used by collapsed border tables.
735     virtual void collectBorders(DeprecatedValueList<CollapsedBorderValue>&);
736
737     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
738     // style changes.
739     void repaint(bool immediate = false);
740
741     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
742     void repaintRectangle(const IntRect& r, bool immediate = false);
743     
744     // Repaint only if our old bounds and new bounds are different.
745     bool repaintAfterLayoutIfNeeded(const IntRect& oldBounds, const IntRect& oldFullBounds);
746
747     // Repaint only if the object moved.
748     virtual void repaintDuringLayoutIfMoved(int oldX, int oldY);
749
750     // Called to repaint a block's floats.
751     virtual void repaintOverhangingFloats(bool paintAllDescendants = false);
752
753     // Called before layout to repaint all dirty children (with selfNeedsLayout() set).
754     virtual void repaintObjectsBeforeLayout();
755
756     bool checkForRepaintDuringLayout() const;
757
758     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
759     // coordinate space.  This method deals with outlines and overflow.
760     virtual IntRect getAbsoluteRepaintRect();
761
762     IntRect getAbsoluteRepaintRectWithOutline(int ow);
763
764     virtual void getAbsoluteRepaintRectIncludingFloats(IntRect& bounds, IntRect& boundsWithChildren);
765
766     // Given a rect in the object's coordinate space, this method converts the rectangle to the view's
767     // coordinate space.
768     virtual void computeAbsoluteRepaintRect(IntRect& r, bool f=false);
769     
770     virtual unsigned int length() const { return 1; }
771
772     bool isFloatingOrPositioned() const { return (isFloating() || isPositioned()); };
773     virtual bool containsFloats() { return false; }
774     virtual bool containsFloat(RenderObject* o) { return false; }
775     virtual bool hasOverhangingFloats() { return false; }
776     virtual bool expandsToEncloseOverhangingFloats() const { return isFloating() && style()->height().isAuto(); }
777     virtual IntRect floatRect() const { return borderBox(); }
778
779     virtual void removePositionedObjects(RenderBlock*) { }
780
781     virtual bool avoidsFloats() const;
782     bool usesLineWidth() const;
783
784     // positioning of inline children (bidi)
785     virtual void position(InlineBox*) { }
786
787     bool isTransparent() const { return style()->opacity() < 1.0f; }
788     float opacity() const { return style()->opacity(); }
789
790     // Applied as a "slop" to dirty rect checks during the outline painting phase's dirty-rect checks.
791     int maximalOutlineSize(PaintPhase p) const;
792
793     enum SelectionState {
794         SelectionNone, // The object is not selected.
795         SelectionStart, // The object either contains the start of a selection run or is the start of a run
796         SelectionInside, // The object is fully encompassed by a selection run
797         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
798         SelectionBoth // The object contains an entire run or is the sole selected object in that run
799     };
800
801     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
802     // descendants (as described above in the SelectionState enum declaration).
803     virtual SelectionState selectionState() const { return SelectionNone; }
804     
805     // Sets the selection state for an object.
806     virtual void setSelectionState(SelectionState s) { if (parent()) parent()->setSelectionState(s); }
807
808     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
809     // possible bounding box for the selection.
810     virtual IntRect selectionRect() { return IntRect(); }
811     
812     // Whether or not an object can be part of the leaf elements of the selection.
813     virtual bool canBeSelectionLeaf() const { return false; }
814
815     // Whether or not a block has selected children.
816     virtual bool hasSelectedChildren() const { return false; }
817
818     // Whether or not a selection can be attempted on this object.
819     bool canSelect() const;
820
821     // Whether or not a selection can be attempted on this object.  Should only be called right before actually beginning a selection,
822     // since it fires the selectstart DOM event.
823     bool shouldSelect() const;
824     
825     // Obtains the selection colors that should be used when painting a selection.
826     Color selectionBackgroundColor() const;
827     Color selectionForegroundColor() const;
828
829     // Whether or not a given block needs to paint selection gaps.
830     virtual bool shouldPaintSelectionGaps() const { return false; }
831
832     // This struct is used when the selection changes to cache the old and new state of the selection for each RenderObject.
833     struct SelectionInfo {
834         RenderObject* m_object;
835         IntRect m_rect;
836         RenderObject::SelectionState m_state;
837
838         RenderObject* object() const { return m_object; }
839         IntRect rect() const { return m_rect; }
840         SelectionState state() const { return m_state; }
841         
842         SelectionInfo() { m_object = 0; m_state = SelectionNone; }
843         SelectionInfo(RenderObject* o) :m_object(o), m_rect(o->selectionRect()), m_state(o->selectionState()) {}
844     };
845
846     Node* draggableNode(bool dhtmlOK, bool uaOK, int x, int y, bool& dhtmlWillDrag) const;
847
848     /**
849      * Returns the content coordinates of the caret within this render object.
850      * @param offset zero-based offset determining position within the render object.
851      * @param override @p true if input overrides existing characters,
852      * @p false if it inserts them. The width of the caret depends on this one.
853      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
854      * useful for character range rect computations
855      */
856     virtual IntRect caretRect(int offset, EAffinity affinity = UPSTREAM, int *extraWidthToEndOfLine = 0);
857
858     virtual int lowestPosition(bool includeOverflowInterior=true, bool includeSelf=true) const { return 0; }
859     virtual int rightmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const { return 0; }
860     virtual int leftmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const { return 0; }
861     
862     virtual void calcVerticalMargins() {}
863     void removeFromObjectLists();
864
865     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
866     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
867     bool documentBeingDestroyed() const;
868
869     virtual void destroy();
870
871     const Font& font(bool firstLine) const {
872         return style(firstLine)->font();
873     }
874
875     // Virtual function helpers for CSS3 Flexible Box Layout
876     virtual bool isFlexibleBox() const { return false; }
877     virtual bool isFlexingChildren() const { return false; }
878     virtual bool isStretchingChildren() const { return false; }
879
880     // Convenience, to avoid repeating the code to dig down to get this.
881     UChar backslashAsCurrencySymbol() const;
882
883     virtual int caretMinOffset() const;
884     virtual int caretMaxOffset() const;
885     virtual unsigned caretMaxRenderedOffset() const;
886
887     virtual int previousOffset (int current) const;
888     virtual int nextOffset (int current) const;
889
890     virtual void imageChanged(CachedImage*);
891     virtual bool willRenderImage(CachedImage*);
892
893     virtual void selectionStartEnd(int& spos, int& epos);
894
895     RenderObject* paintingRootForChildren(PaintInfo &i) const {
896         // if we're the painting root, kids draw normally, and see root of 0
897         return (!i.paintingRoot || i.paintingRoot == this) ? 0 : i.paintingRoot;
898     }
899
900     bool shouldPaintWithinRoot(PaintInfo &i) const {
901         return !i.paintingRoot || i.paintingRoot == this;
902     }
903     
904 protected:
905     virtual void printBoxDecorations(GraphicsContext*, int /*x*/, int /*y*/,
906         int /*w*/, int /*h*/, int /*tx*/, int /*ty*/) {}
907
908     virtual IntRect viewRect() const;
909
910     void remove() { if (parent()) parent()->removeChild(this); }
911
912     void invalidateVerticalPositions();
913     short getVerticalPosition(bool firstLine) const;
914
915     virtual void removeLeftoverAnonymousBoxes();
916     
917     void arenaDelete(RenderArena*, void* objectBase);
918
919 private:
920     RenderStyle* m_style;
921
922     Node* m_node;
923
924     RenderObject *m_parent;
925     RenderObject *m_previous;
926     RenderObject *m_next;
927
928     mutable short m_verticalPosition;
929
930     bool m_needsLayout               : 1;
931     bool m_normalChildNeedsLayout    : 1;
932     bool m_posChildNeedsLayout       : 1;
933     bool m_minMaxKnown               : 1;
934     bool m_floating                  : 1;
935
936     bool m_positioned                : 1;
937     bool m_relPositioned             : 1;
938     bool m_paintBackground           : 1; // if the box has something to paint in the
939                                           // background painting phase (background, border, etc)
940
941     bool m_isAnonymous               : 1;
942     bool m_recalcMinMax              : 1;
943     bool m_isText                    : 1;
944     bool m_inline                    : 1;
945     bool m_replaced                  : 1;
946     bool m_isDragging                : 1;
947     
948     bool m_hasOverflowClip           : 1;
949     
950     bool m_hasCounterNodeMap         : 1;
951
952     friend class RenderListItem;
953     friend class RenderContainer;
954     friend class RenderView;
955 };
956
957
958 enum VerticalPositionHint {
959     PositionTop = -0x4000,
960     PositionBottom = 0x4000,
961     PositionUndefined = 0x3fff
962 };
963
964 } //namespace
965
966 #ifndef NDEBUG
967 // Outside the WebCore namespace for ease of invocation from gdb.
968 void showTree(const WebCore::RenderObject*);
969 #endif
970
971
972 #endif