WebCore/khtml/rendering/render_block.h

   1 /*
   2  * This file is part of the render object implementation for KHTML.
   3  *
   4  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
   5  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
   6  * Copyright (C) 2003 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
  25 #ifndef RENDER_BLOCK_H
  26 #define RENDER_BLOCK_H
  27
  28 #include <qptrlist.h>
  29
  30 #include "render_flow.h"
  31
  32 namespace DOM {
  33     class Position;
  34 }
  35
  36 namespace khtml {
  37
  38 class RenderBlock : public RenderFlow
  39 {
  40 public:
  41     RenderBlock(DOM::NodeImpl* node);
  42     virtual ~RenderBlock();
  43
  44     virtual const char *renderName() const;
  45
  46     // These two functions are overridden for inline-block.
  47     virtual short lineHeight(bool b, bool isRootLineBox=false) const;
  48     virtual short baselinePosition(bool b, bool isRootLineBox=false) const;
  49
  50     virtual bool isRenderBlock() const { return true; }
  51     virtual bool isBlockFlow() const { return (!isInline() || isReplaced()) && !isTable(); }
  52     virtual bool isInlineFlow() const { return isInline() && !isReplaced(); }
  53     virtual bool isInlineBlockOrInlineTable() const { return isInline() && isReplaced(); }
  54
  55     virtual bool childrenInline() const { return m_childrenInline; }
  56     virtual void setChildrenInline(bool b) { m_childrenInline = b; }
  57     void makeChildrenNonInline(RenderObject* insertionPoint = 0);
  58
  59     // The height (and width) of a block when you include overflow spillage out of the bottom
  60     // of the block (e.g., a <div style="height:25px"> that has a 100px tall image inside
  61     // it would have an overflow height of borderTop() + paddingTop() + 100px.
  62     virtual int overflowHeight(bool includeInterior=true) const;
  63     virtual int overflowWidth(bool includeInterior=true) const;
  64     virtual int overflowLeft(bool includeInterior=true) const;
  65     virtual int overflowTop(bool includeInterior=true) const;
  66     virtual QRect overflowRect(bool includeInterior=true) const;
  67     virtual void setOverflowHeight(int h) { m_overflowHeight = h; }
  68     virtual void setOverflowWidth(int w) { m_overflowWidth = w; }
  69
  70     virtual bool isSelfCollapsingBlock() const;
  71     virtual bool isTopMarginQuirk() const { return m_topMarginQuirk; }
  72     virtual bool isBottomMarginQuirk() const { return m_bottomMarginQuirk; }
  73
  74     virtual int maxTopMargin(bool positive) const {
  75         if (positive)
  76             return m_maxTopPosMargin;
  77         else
  78             return m_maxTopNegMargin;
  79     }
  80     virtual int maxBottomMargin(bool positive) const {
  81         if (positive)
  82             return m_maxBottomPosMargin;
  83         else
  84             return m_maxBottomNegMargin;
  85     }
  86
  87     void initMaxMarginValues() {
  88         if (m_marginTop >= 0)
  89             m_maxTopPosMargin = m_marginTop;
  90         else
  91             m_maxTopNegMargin = -m_marginTop;
  92         if (m_marginBottom >= 0)
  93             m_maxBottomPosMargin = m_marginBottom;
  94         else
  95             m_maxBottomNegMargin = -m_marginBottom;
  96     }
  97
  98     virtual void addChildToFlow(RenderObject* newChild, RenderObject* beforeChild);
  99     virtual void removeChild(RenderObject *oldChild);
 100
 101     virtual void repaintObjectsBeforeLayout();
 102     virtual void repaintFloatingDescendants();
 103     virtual void getAbsoluteRepaintRectIncludingFloats(QRect& bounds, QRect& fullBounds);
 104
 105     virtual void setStyle(RenderStyle* _style);
 106
 107     virtual void layout();
 108     virtual void layoutBlock(bool relayoutChildren);
 109     void layoutBlockChildren(bool relayoutChildren);
 110     QRect layoutInlineChildren(bool relayoutChildren);
 111
 112     void layoutPositionedObjects( bool relayoutChildren );
 113     void insertPositionedObject(RenderObject *o);
 114     void removePositionedObject(RenderObject *o);
 115
 116     // Called to lay out the legend for a fieldset.
 117     virtual RenderObject* layoutLegend(bool relayoutChildren) { return 0; };
 118
 119     // the implementation of the following functions is in bidi.cpp
 120     void bidiReorderLine(const BidiIterator &start, const BidiIterator &end, BidiState &bidi );
 121     RootInlineBox* determineStartPosition(bool fullLayout, BidiIterator &start, BidiState &bidi);
 122     RootInlineBox* determineEndPosition(RootInlineBox* startBox, BidiIterator& cleanLineStart, int& yPos);
 123     bool matchedEndLine(const BidiIterator& start, const BidiIterator& endLineStart,
 124                         RootInlineBox*& endLine, int& endYPos);
 125     int skipWhitespace(BidiIterator &, BidiState &);
 126     BidiIterator findNextLineBreak(BidiIterator &start, BidiState &info );
 127     RootInlineBox* constructLine(const BidiIterator& start, const BidiIterator& end);
 128     InlineFlowBox* createLineBoxes(RenderObject* obj);
 129     void computeHorizontalPositionsForLine(RootInlineBox* lineBox, BidiState &bidi);
 130     void computeVerticalPositionsForLine(RootInlineBox* lineBox);
 131     void checkLinesForOverflow();
 132     void deleteEllipsisLineBoxes();
 133     void checkLinesForTextOverflow();
 134     // end bidi.cpp functions
 135
 136     virtual void paint(PaintInfo& i, int tx, int ty);
 137     void paintObject(PaintInfo& i, int tx, int ty);
 138     void paintFloats(PaintInfo& i, int _tx, int _ty, bool paintSelection = false);
 139     void paintChildren(PaintInfo& i, int _tx, int _ty);
 140     void paintEllipsisBoxes(PaintInfo& i, int _tx, int _ty);
 141     void paintSelection(PaintInfo& i, int _tx, int _ty);
 142
 143     void insertFloatingObject(RenderObject *o);
 144     void removeFloatingObject(RenderObject *o);
 145
 146     // called from lineWidth, to position the floats added in the last line.
 147     void positionNewFloats();
 148     void clearFloats();
 149     int getClearDelta(RenderObject *child);
 150     virtual void markAllDescendantsWithFloatsForLayout(RenderObject* floatToRemove = 0);
 151     void markPositionedObjectsForLayout();
 152
 153     virtual bool containsFloats() { return m_floatingObjects!=0; }
 154     virtual bool containsFloat(RenderObject* o);
 155
 156     virtual bool hasOverhangingFloats() { return floatBottom() > m_height; }
 157     void addIntrudingFloats(RenderBlock* prev, int xoffset, int yoffset);
 158     void addOverhangingFloats(RenderBlock* child, int xoffset, int yoffset);
 159
 160     int nearestFloatBottom(int height) const;
 161     int floatBottom() const;
 162     inline int leftBottom();
 163     inline int rightBottom();
 164     virtual QRect floatRect() const;
 165
 166     virtual int lineWidth(int y) const;
 167     virtual int lowestPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
 168     virtual int rightmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
 169     virtual int leftmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
 170
 171     int rightOffset() const;
 172     int rightRelOffset(int y, int fixedOffset, bool applyTextIndent = true,
 173                        int *heightRemaining = 0) const;
 174     int rightOffset(int y) const { return rightRelOffset(y, rightOffset(), true); }
 175
 176     int leftOffset() const;
 177     int leftRelOffset(int y, int fixedOffset, bool applyTextIndent = true,
 178                       int *heightRemaining = 0) const;
 179     int leftOffset(int y) const { return leftRelOffset(y, leftOffset(), true); }
 180
 181     virtual bool nodeAtPoint(NodeInfo& info, int x, int y, int tx, int ty,
 182                              HitTestAction hitTestAction);
 183
 184     bool isPointInScrollbar(int x, int y, int tx, int ty);
 185
 186     virtual DOM::Position positionForCoordinates(int x, int y, EAffinity * = 0);
 187
 188     virtual void calcMinMaxWidth();
 189     void calcInlineMinMaxWidth();
 190     void calcBlockMinMaxWidth();
 191
 192     virtual int getBaselineOfFirstLineBox() const;
 193
 194     RootInlineBox* firstRootBox() { return static_cast<RootInlineBox*>(m_firstLineBox); }
 195     RootInlineBox* lastRootBox() { return static_cast<RootInlineBox*>(m_lastLineBox); }
 196
 197     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
 198     // children.
 199     virtual RenderBlock* firstLineBlock() const;
 200     virtual void updateFirstLetter();
 201
 202     bool inRootBlockContext() const;
 203
 204     void setHasMarkupTruncation(bool b=true) { m_hasMarkupTruncation = b; }
 205     bool hasMarkupTruncation() const { return m_hasMarkupTruncation; }
 206
 207     virtual bool hasSelectedChildren() const { return m_selectionState != SelectionNone; }
 208     virtual SelectionState selectionState() const { return m_selectionState; }
 209     virtual void setSelectionState(SelectionState s);
 210
 211     struct BlockSelectionInfo {
 212         RenderBlock* m_block;
 213         GapRects m_rects;
 214         SelectionState m_state;
 215
 216         BlockSelectionInfo() { m_block = 0; m_state = SelectionNone; }
 217         BlockSelectionInfo(RenderBlock* b) {
 218             m_block = b;
 219             m_state = m_block->selectionState();
 220             m_rects = m_block->selectionGapRects();
 221         }
 222
 223         GapRects rects() const { return m_rects; }
 224         SelectionState state() const { return m_state; }
 225         RenderBlock* block() const { return m_block; }
 226     };
 227
 228     virtual QRect selectionRect() { return selectionGapRects(); }
 229     GapRects selectionGapRects();
 230     virtual bool shouldPaintSelectionGaps() const;
 231     bool isSelectionRoot() const;
 232     GapRects fillSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
 233                                int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* i = 0);
 234     GapRects fillInlineSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
 235                                      int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* i);
 236     GapRects fillBlockSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
 237                                     int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* i);
 238     QRect fillVerticalSelectionGap(int lastTop, int lastLeft, int lastRight,
 239                                    int bottomY, RenderBlock* rootBlock, int blockX, int blockY, const PaintInfo* i);
 240     QRect fillLeftSelectionGap(RenderObject* selObj, int xPos, int yPos, int height, RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty, const PaintInfo* i);
 241     QRect fillRightSelectionGap(RenderObject* selObj, int xPos, int yPos, int height, RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty, const PaintInfo* i);
 242     QRect fillHorizontalSelectionGap(RenderObject* selObj, int xPos, int yPos, int width, int height, const PaintInfo* i);
 243
 244     void getHorizontalSelectionGapInfo(SelectionState state, bool& leftGap, bool& rightGap);
 245     int leftSelectionOffset(RenderBlock* rootBlock, int y);
 246     int rightSelectionOffset(RenderBlock* rootBlock, int y);
 247
 248 #ifndef NDEBUG
 249     virtual void printTree(int indent=0) const;
 250     virtual void dump(QTextStream *stream, QString ind = "") const;
 251 #endif
 252
 253     // Helper methods for computing line counts and heights for line counts.
 254     RootInlineBox* lineAtIndex(int i);
 255     int lineCount();
 256     int heightForLineCount(int l);
 257     void clearTruncation();
 258
 259 protected:
 260     void newLine();
 261
 262 private:
 263     DOM::Position positionForBox(InlineBox *box, bool start=true) const;
 264     DOM::Position positionForRenderer(RenderObject *renderer, bool start=true) const;
 265     bool skipNonBreakingSpace(BidiIterator &it);
 266
 267 protected:
 268     struct FloatingObject {
 269         enum Type {
 270             FloatLeft,
 271             FloatRight
 272         };
 273
 274         FloatingObject(Type _type) {
 275             node = 0;
 276             startY = 0;
 277             endY = 0;
 278             type = _type;
 279             left = 0;
 280             width = 0;
 281             noPaint = false;
 282
 283         }
 284         RenderObject* node;
 285         int startY;
 286         int endY;
 287         int left;
 288         int width;
 289         Type type : 1; // left or right aligned
 290         bool noPaint : 1;
 291     };
 292
 293     // The following helper functions and structs are used by layoutBlockChildren.
 294     class CompactInfo {
 295         // A compact child that needs to be collapsed into the margin of the following block.
 296         RenderObject* m_compact;
 297
 298         // The block with the open margin that the compact child is going to place itself within.
 299         RenderObject* m_block;
 300
 301     public:
 302         RenderObject* compact() const { return m_compact; }
 303         RenderObject* block() const { return m_block; }
 304         bool matches(RenderObject* child) const { return m_compact && m_block == child; }
 305
 306         void clear() { set(0, 0);  }
 307         void set(RenderObject* c, RenderObject* b) { m_compact = c; m_block = b; }
 308
 309         CompactInfo() { clear(); }
 310     };
 311
 312     class MarginInfo {
 313         // Collapsing flags for whether we can collapse our margins with our children's margins.
 314         bool m_canCollapseWithChildren : 1;
 315         bool m_canCollapseTopWithChildren : 1;
 316         bool m_canCollapseBottomWithChildren : 1;
 317
 318         // Whether or not we are a quirky container, i.e., do we collapse away top and bottom
 319         // margins in our container.  Table cells and the body are the common examples. We
 320         // also have a custom style property for Safari RSS to deal with TypePad blog articles.
 321         bool m_quirkContainer : 1;
 322
 323         // This flag tracks whether we are still looking at child margins that can all collapse together at the beginning of a block.
 324         // They may or may not collapse with the top margin of the block (|m_canCollapseTopWithChildren| tells us that), but they will
 325         // always be collapsing with one another.  This variable can remain set to true through multiple iterations
 326         // as long as we keep encountering self-collapsing blocks.
 327         bool m_atTopOfBlock : 1;
 328
 329         // This flag is set when we know we're examining bottom margins and we know we're at the bottom of the block.
 330         bool m_atBottomOfBlock : 1;
 331
 332         // If our last normal flow child was a self-collapsing block that cleared a float,
 333         // we track it in this variable.
 334         bool m_selfCollapsingBlockClearedFloat : 1;
 335
 336         // These variables are used to detect quirky margins that we need to collapse away (in table cells
 337         // and in the body element).
 338         bool m_topQuirk : 1;
 339         bool m_bottomQuirk : 1;
 340         bool m_determinedTopQuirk : 1;
 341
 342         // These flags track the previous maximal positive and negative margins.
 343         int m_posMargin;
 344         int m_negMargin;
 345
 346     public:
 347         MarginInfo(RenderBlock* b, int top, int bottom);
 348
 349         void setAtTopOfBlock(bool b) { m_atTopOfBlock = b; }
 350         void setAtBottomOfBlock(bool b) { m_atBottomOfBlock = b; }
 351         void clearMargin() { m_posMargin = m_negMargin = 0; }
 352         void setSelfCollapsingBlockClearedFloat(bool b) { m_selfCollapsingBlockClearedFloat = false; }
 353         void setTopQuirk(bool b) { m_topQuirk = b; }
 354         void setBottomQuirk(bool b) { m_bottomQuirk = b; }
 355         void setDeterminedTopQuirk(bool b) { m_determinedTopQuirk = b; }
 356         void setPosMargin(int p) { m_posMargin = p; }
 357         void setNegMargin(int n) { m_negMargin = n; }
 358         void setPosMarginIfLarger(int p) { if (p > m_posMargin) m_posMargin = p; }
 359         void setNegMarginIfLarger(int n) { if (n > m_negMargin) m_negMargin = n; }
 360
 361         void setMargin(int p, int n) { m_posMargin = p; m_negMargin = n; }
 362
 363         bool atTopOfBlock() const { return m_atTopOfBlock; }
 364         bool canCollapseWithTop() const { return m_atTopOfBlock && m_canCollapseTopWithChildren; }
 365         bool canCollapseWithBottom() const { return m_atBottomOfBlock && m_canCollapseBottomWithChildren; }
 366         bool canCollapseTopWithChildren() const { return m_canCollapseTopWithChildren; }
 367         bool canCollapseBottomWithChildren() const { return m_canCollapseBottomWithChildren; }
 368         bool selfCollapsingBlockClearedFloat() const { return m_selfCollapsingBlockClearedFloat; }
 369         bool quirkContainer() const { return m_quirkContainer; }
 370         bool determinedTopQuirk() const { return m_determinedTopQuirk; }
 371         bool topQuirk() const { return m_topQuirk; }
 372         bool bottomQuirk() const { return m_bottomQuirk; }
 373         int posMargin() const { return m_posMargin; }
 374         int negMargin() const { return m_negMargin; }
 375         int margin() const { return m_posMargin - m_negMargin; }
 376     };
 377
 378     void adjustPositionedBlock(RenderObject* child, const MarginInfo& marginInfo);
 379     void adjustFloatingBlock(const MarginInfo& marginInfo);
 380     RenderObject* handleSpecialChild(RenderObject* child, const MarginInfo& marginInfo, CompactInfo& compactInfo, bool& handled);
 381     RenderObject* handleFloatingChild(RenderObject* child, const MarginInfo& marginInfo, bool& handled);
 382     RenderObject* handlePositionedChild(RenderObject* child, const MarginInfo& marginInfo, bool& handled);
 383     RenderObject* handleCompactChild(RenderObject* child, CompactInfo& compactInfo, bool& handled);
 384     RenderObject* handleRunInChild(RenderObject* child, bool& handled);
 385     void collapseMargins(RenderObject* child, MarginInfo& marginInfo, int yPosEstimate);
 386     void clearFloatsIfNeeded(RenderObject* child, MarginInfo& marginInfo, int oldTopPosMargin, int oldTopNegMargin);
 387     void insertCompactIfNeeded(RenderObject* child, CompactInfo& compactInfo);
 388     int estimateVerticalPosition(RenderObject* child, const MarginInfo& info);
 389     void determineHorizontalPosition(RenderObject* child);
 390     void handleBottomOfBlock(int top, int bottom, MarginInfo& marginInfo);
 391     void setCollapsedBottomMargin(const MarginInfo& marginInfo);
 392     // End helper functions and structs used by layoutBlockChildren.
 393
 394 protected:
 395     QPtrList<FloatingObject>* m_floatingObjects;
 396     QPtrList<RenderObject>* m_positionedObjects;
 397
 398     bool m_childrenInline : 1;
 399     bool m_pre            : 1;
 400     bool m_firstLine      : 1;
 401     EClear m_clearStatus  : 2;
 402     bool m_topMarginQuirk : 1;
 403     bool m_bottomMarginQuirk : 1;
 404     bool m_hasMarkupTruncation : 1;
 405     SelectionState m_selectionState : 3;
 406
 407     int m_maxTopPosMargin;
 408     int m_maxTopNegMargin;
 409     int m_maxBottomPosMargin;
 410     int m_maxBottomNegMargin;
 411
 412     // How much content overflows out of our block vertically or horizontally (all we support
 413     // for now is spillage out of the bottom and the right, which are the common cases).
 414     // XXX Generalize to work with top and left as well.
 415     int m_overflowHeight;
 416     int m_overflowWidth;
 417
 418     // Left and top overflow.  Does not affect scrolling dimensions, but we do at least use it
 419     // when dirty rect checking and hit testing.
 420     int m_overflowLeft;
 421     int m_overflowTop;
 422 };
 423
 424 }; // namespace
 425
 426 #endif // RENDER_BLOCK_H
 427