1/*
2 * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public License
15 * along with this library; see the file COPYING.LIB.  If not, write to
16 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20#ifndef RenderSVGResource_h
21#define RenderSVGResource_h
22
23#include "core/rendering/svg/RenderSVGShape.h"
24#include "core/svg/SVGDocumentExtensions.h"
25
26namespace WebCore {
27
28enum RenderSVGResourceType {
29    MaskerResourceType,
30    MarkerResourceType,
31    PatternResourceType,
32    LinearGradientResourceType,
33    RadialGradientResourceType,
34    SolidColorResourceType,
35    FilterResourceType,
36    ClipperResourceType
37};
38
39// If this enum changes change the unsigned bitfields using it.
40enum RenderSVGResourceMode {
41    ApplyToDefaultMode = 1 << 0, // used for all resources except gradient/pattern
42    ApplyToFillMode    = 1 << 1,
43    ApplyToStrokeMode  = 1 << 2,
44    ApplyToTextMode    = 1 << 3 // used in combination with ApplyTo{Fill|Stroke}Mode
45};
46typedef unsigned RenderSVGResourceModeFlags;
47
48class GraphicsContext;
49class Path;
50class RenderObject;
51class RenderStyle;
52class RenderSVGResourceSolidColor;
53
54class RenderSVGResource {
55public:
56    RenderSVGResource() { }
57    virtual ~RenderSVGResource() { }
58
59    virtual void removeAllClientsFromCache(bool markForInvalidation = true) = 0;
60    virtual void removeClientFromCache(RenderObject*, bool markForInvalidation = true) = 0;
61
62    virtual bool applyResource(RenderObject*, RenderStyle*, GraphicsContext*&, unsigned short resourceMode) = 0;
63    virtual void postApplyResource(RenderObject*, GraphicsContext*&, unsigned short, const Path*, const RenderSVGShape*) { }
64
65    virtual RenderSVGResourceType resourceType() const = 0;
66
67    template<class Renderer>
68    Renderer* cast()
69    {
70        if (Renderer::s_resourceType == resourceType())
71            return static_cast<Renderer*>(this);
72
73        return 0;
74    }
75
76    // Helper utilities used in the render tree to access resources used for painting shapes/text (gradients & patterns & solid colors only)
77    // If hasFallback gets set to true, the sharedSolidPaintingResource is set to a fallback color.
78    static RenderSVGResource* fillPaintingResource(RenderObject*, const RenderStyle*, bool& hasFallback);
79    static RenderSVGResource* strokePaintingResource(RenderObject*, const RenderStyle*, bool& hasFallback);
80    static RenderSVGResourceSolidColor* sharedSolidPaintingResource();
81
82    static void markForLayoutAndParentResourceInvalidation(RenderObject*, bool needsLayout = true);
83};
84
85#define DEFINE_RENDER_SVG_RESOURCE_TYPE_CASTS(thisType, typeName) \
86    DEFINE_TYPE_CASTS(thisType, RenderSVGResource, resource, resource->resourceType() == typeName, resource.resourceType() == typeName)
87
88}
89
90#endif
91