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