src/third_party/WebKit/Source/core/rendering/PaintInfo.h

   1 /*
   2  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
   3  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
   4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
   5  *           (C) 2004 Allan Sandfeld Jensen (kde@carewolf.com)
   6  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
   7  * Copyright (C) 2009 Google Inc. All rights reserved.
   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., 51 Franklin Street, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  *
  24  */
  25
  26 #ifndef PaintInfo_h
  27 #define PaintInfo_h
  28
  29 #include <limits>
  30 #include "core/rendering/PaintPhase.h"
  31 #include "platform/geometry/IntRect.h"
  32 #include "platform/geometry/LayoutRect.h"
  33 #include "platform/graphics/GraphicsContext.h"
  34 #include "platform/transforms/AffineTransform.h"
  35 #include "wtf/HashMap.h"
  36 #include "wtf/ListHashSet.h"
  37
  38 namespace WebCore {
  39
  40 class RenderInline;
  41 class RenderLayerModelObject;
  42 class RenderObject;
  43 class RenderWidget;
  44
  45 typedef HashMap<RenderWidget*, IntRect> OverlapTestRequestMap;
  46
  47 /*
  48  * Paint the object and its children, clipped by (x|y|w|h).
  49  * (tx|ty) is the calculated position of the parent
  50  */
  51 struct PaintInfo {
  52     PaintInfo(GraphicsContext* newContext, const IntRect& newRect, PaintPhase newPhase, PaintBehavior newPaintBehavior,
  53         RenderObject* newPaintingRoot = 0, ListHashSet<RenderInline*>* newOutlineObjects = 0,
  54         OverlapTestRequestMap* overlapTestRequests = 0, const RenderLayerModelObject* newPaintContainer = 0)
  55         : context(newContext)
  56         , rect(newRect)
  57         , phase(newPhase)
  58         , paintBehavior(newPaintBehavior)
  59         , paintingRoot(newPaintingRoot)
  60         , overlapTestRequests(overlapTestRequests)
  61         , m_paintContainer(newPaintContainer)
  62         , m_outlineObjects(newOutlineObjects)
  63     {
  64     }
  65
  66     void updatePaintingRootForChildren(const RenderObject* renderer)
  67     {
  68         if (!paintingRoot)
  69             return;
  70
  71         // If we're the painting root, kids draw normally, and see root of 0.
  72         if (paintingRoot == renderer) {
  73             paintingRoot = 0;
  74             return;
  75         }
  76     }
  77
  78     bool shouldPaintWithinRoot(const RenderObject* renderer) const
  79     {
  80         return !paintingRoot || paintingRoot == renderer;
  81     }
  82
  83     bool forceBlackText() const { return paintBehavior & PaintBehaviorForceBlackText; }
  84
  85     bool skipRootBackground() const { return paintBehavior & PaintBehaviorSkipRootBackground; }
  86     bool paintRootBackgroundOnly() const { return paintBehavior & PaintBehaviorRootBackgroundOnly; }
  87
  88     void applyTransform(const AffineTransform& localToAncestorTransform, bool identityStatusUnknown = true)
  89     {
  90         if (identityStatusUnknown && localToAncestorTransform.isIdentity())
  91             return;
  92
  93         context->concatCTM(localToAncestorTransform);
  94
  95         if (rect == infiniteRect())
  96             return;
  97
  98         rect = localToAncestorTransform.inverse().mapRect(rect);
  99     }
 100
 101     static IntRect infiniteRect() { return IntRect(LayoutRect::infiniteRect()); }
 102     const RenderLayerModelObject* paintContainer() const { return m_paintContainer; }
 103
 104     ListHashSet<RenderInline*>* outlineObjects() { return m_outlineObjects; }
 105     void setOutlineObjects(ListHashSet<RenderInline*>* objects) { m_outlineObjects = objects; }
 106
 107     // FIXME: Introduce setters/getters at some point. Requires a lot of changes throughout rendering/.
 108     GraphicsContext* context;
 109     IntRect rect;
 110     PaintPhase phase;
 111     PaintBehavior paintBehavior;
 112     RenderObject* paintingRoot; // used to draw just one element and its visual kids
 113     OverlapTestRequestMap* overlapTestRequests;
 114
 115 private:
 116
 117     const RenderLayerModelObject* m_paintContainer; // the layer object that originates the current painting
 118     ListHashSet<RenderInline*>* m_outlineObjects; // used to list outlines that should be painted by a block with inline children
 119 };
 120
 121 } // namespace WebCore
 122
 123 #endif // PaintInfo_h