Add TextStream formatters for FillLayer and all it entails
[WebKit-https.git] / Source / WebCore / rendering / style / FillLayer.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  * Copyright (C) 2003, 2005, 2006, 2007, 2008, 2014 Apple Inc. All rights reserved.
6  * Copyright (C) 2006 Graham Dennis (graham.dennis@gmail.com)
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., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef FillLayer_h
26 #define FillLayer_h
27
28 #include "GraphicsTypes.h"
29 #include "LengthSize.h"
30 #include "RenderStyleConstants.h"
31 #include "StyleImage.h"
32 #include <wtf/RefPtr.h>
33
34 namespace WebCore {
35
36 class RenderElement;
37
38 struct FillSize {
39     FillSize()
40         : type(SizeLength)
41     {
42     }
43
44     FillSize(EFillSizeType type, const LengthSize& size)
45         : type(type)
46         , size(size)
47     {
48     }
49
50     EFillSizeType type;
51     LengthSize size;
52 };
53
54 inline bool operator==(const FillSize& a, const FillSize& b)
55 {
56     return a.type == b.type && a.size == b.size;
57 }
58
59 inline bool operator!=(const FillSize& a, const FillSize& b)
60 {
61     return !(a == b);
62 }
63
64 class FillLayer {
65     WTF_MAKE_FAST_ALLOCATED;
66 public:
67     explicit FillLayer(EFillLayerType);
68     ~FillLayer();
69
70     StyleImage* image() const { return m_image.get(); }
71     const Length& xPosition() const { return m_xPosition; }
72     const Length& yPosition() const { return m_yPosition; }
73     BackgroundEdgeOrigin backgroundXOrigin() const { return static_cast<BackgroundEdgeOrigin>(m_backgroundXOrigin); }
74     BackgroundEdgeOrigin backgroundYOrigin() const { return static_cast<BackgroundEdgeOrigin>(m_backgroundYOrigin); }
75     EFillAttachment attachment() const { return static_cast<EFillAttachment>(m_attachment); }
76     EFillBox clip() const { return static_cast<EFillBox>(m_clip); }
77     EFillBox origin() const { return static_cast<EFillBox>(m_origin); }
78     EFillRepeat repeatX() const { return static_cast<EFillRepeat>(m_repeatX); }
79     EFillRepeat repeatY() const { return static_cast<EFillRepeat>(m_repeatY); }
80     CompositeOperator composite() const { return static_cast<CompositeOperator>(m_composite); }
81     BlendMode blendMode() const { return static_cast<BlendMode>(m_blendMode); }
82     const LengthSize& sizeLength() const { return m_sizeLength; }
83     EFillSizeType sizeType() const { return static_cast<EFillSizeType>(m_sizeType); }
84     FillSize size() const { return FillSize(static_cast<EFillSizeType>(m_sizeType), m_sizeLength); }
85     EMaskSourceType maskSourceType() const { return static_cast<EMaskSourceType>(m_maskSourceType); }
86
87     const FillLayer* next() const { return m_next.get(); }
88     FillLayer* next() { return m_next.get(); }
89
90     bool isImageSet() const { return m_imageSet; }
91     bool isXPositionSet() const { return m_xPosSet; }
92     bool isYPositionSet() const { return m_yPosSet; }
93     bool isBackgroundOriginSet() const { return m_backgroundOriginSet; }
94     bool isAttachmentSet() const { return m_attachmentSet; }
95     bool isClipSet() const { return m_clipSet; }
96     bool isOriginSet() const { return m_originSet; }
97     bool isRepeatXSet() const { return m_repeatXSet; }
98     bool isRepeatYSet() const { return m_repeatYSet; }
99     bool isCompositeSet() const { return m_compositeSet; }
100     bool isBlendModeSet() const { return m_blendModeSet; }
101     bool isSizeSet() const { return m_sizeType != SizeNone; }
102     bool isMaskSourceTypeSet() const { return m_maskSourceTypeSet; }
103
104     void setImage(PassRefPtr<StyleImage> image) { m_image = image; m_imageSet = true; }
105     void setXPosition(Length length) { m_xPosition = WTF::move(length); m_xPosSet = true; }
106     void setYPosition(Length length) { m_yPosition = WTF::move(length); m_yPosSet = true; }
107     void setBackgroundXOrigin(BackgroundEdgeOrigin o) { m_backgroundXOrigin = o; m_backgroundOriginSet = true; }
108     void setBackgroundYOrigin(BackgroundEdgeOrigin o) { m_backgroundYOrigin = o; m_backgroundOriginSet = true; }
109     void setAttachment(EFillAttachment attachment) { m_attachment = attachment; m_attachmentSet = true; }
110     void setClip(EFillBox b) { m_clip = b; m_clipSet = true; }
111     void setOrigin(EFillBox b) { m_origin = b; m_originSet = true; }
112     void setRepeatX(EFillRepeat r) { m_repeatX = r; m_repeatXSet = true; }
113     void setRepeatY(EFillRepeat r) { m_repeatY = r; m_repeatYSet = true; }
114     void setComposite(CompositeOperator c) { m_composite = c; m_compositeSet = true; }
115     void setBlendMode(BlendMode b) { m_blendMode = b; m_blendModeSet = true; }
116     void setSizeType(EFillSizeType b) { m_sizeType = b; }
117     void setSizeLength(LengthSize l) { m_sizeLength = l; }
118     void setSize(FillSize f) { m_sizeType = f.type; m_sizeLength = f.size; }
119     void setMaskSourceType(EMaskSourceType m) { m_maskSourceType = m; m_maskSourceTypeSet = true; }
120
121     void clearImage() { m_image = nullptr; m_imageSet = false; }
122
123     void clearXPosition() { m_xPosSet = false; m_backgroundOriginSet = false; }
124     void clearYPosition() { m_yPosSet = false; m_backgroundOriginSet = false; }
125
126     void clearAttachment() { m_attachmentSet = false; }
127     void clearClip() { m_clipSet = false; }
128     void clearOrigin() { m_originSet = false; }
129     void clearRepeatX() { m_repeatXSet = false; }
130     void clearRepeatY() { m_repeatYSet = false; }
131     void clearComposite() { m_compositeSet = false; }
132     void clearBlendMode() { m_blendModeSet = false; }
133     void clearSize() { m_sizeType = SizeNone; }
134     void clearMaskSourceType() { m_maskSourceTypeSet = false; }
135
136     void setNext(std::unique_ptr<FillLayer> next) { m_next = WTF::move(next); }
137
138     FillLayer& operator=(const FillLayer&);
139     FillLayer(const FillLayer&);
140
141     bool operator==(const FillLayer&) const;
142     bool operator!=(const FillLayer& other) const { return !(*this == other); }
143
144     bool containsImage(StyleImage&) const;
145     bool imagesAreLoaded() const;
146     bool hasImage() const;
147     bool hasFixedImage() const;
148     bool hasOpaqueImage(const RenderElement&) const;
149     bool hasRepeatXY() const;
150     bool clipOccludesNextLayers(bool firstLayer) const;
151
152     EFillLayerType type() const { return static_cast<EFillLayerType>(m_type); }
153
154     void fillUnsetProperties();
155     void cullEmptyLayers();
156
157     static bool imagesIdentical(const FillLayer*, const FillLayer*);
158
159     static EFillAttachment initialFillAttachment(EFillLayerType) { return ScrollBackgroundAttachment; }
160     static EFillBox initialFillClip(EFillLayerType) { return BorderFillBox; }
161     static EFillBox initialFillOrigin(EFillLayerType type) { return type == BackgroundFillLayer ? PaddingFillBox : BorderFillBox; }
162     static EFillRepeat initialFillRepeatX(EFillLayerType) { return RepeatFill; }
163     static EFillRepeat initialFillRepeatY(EFillLayerType) { return RepeatFill; }
164     static CompositeOperator initialFillComposite(EFillLayerType) { return CompositeSourceOver; }
165     static BlendMode initialFillBlendMode(EFillLayerType) { return BlendModeNormal; }
166     static FillSize initialFillSize(EFillLayerType) { return FillSize(); }
167     static Length initialFillXPosition(EFillLayerType) { return Length(0.0f, Percent); }
168     static Length initialFillYPosition(EFillLayerType) { return Length(0.0f, Percent); }
169     static StyleImage* initialFillImage(EFillLayerType) { return nullptr; }
170     static EMaskSourceType initialFillMaskSourceType(EFillLayerType) { return MaskAlpha; }
171
172 private:
173     friend class RenderStyle;
174
175     void computeClipMax() const;
176
177     std::unique_ptr<FillLayer> m_next;
178
179     RefPtr<StyleImage> m_image;
180
181     Length m_xPosition;
182     Length m_yPosition;
183
184     LengthSize m_sizeLength;
185
186     unsigned m_attachment : 2; // EFillAttachment
187     unsigned m_clip : 2; // EFillBox
188     unsigned m_origin : 2; // EFillBox
189     unsigned m_repeatX : 3; // EFillRepeat
190     unsigned m_repeatY : 3; // EFillRepeat
191     unsigned m_composite : 4; // CompositeOperator
192     unsigned m_sizeType : 2; // EFillSizeType
193     unsigned m_blendMode : 5; // BlendMode
194     unsigned m_maskSourceType : 1; // EMaskSourceType
195
196     unsigned m_imageSet : 1;
197     unsigned m_attachmentSet : 1;
198     unsigned m_clipSet : 1;
199     unsigned m_originSet : 1;
200     unsigned m_repeatXSet : 1;
201     unsigned m_repeatYSet : 1;
202     unsigned m_xPosSet : 1;
203     unsigned m_yPosSet : 1;
204     unsigned m_backgroundOriginSet : 1;
205     unsigned m_backgroundXOrigin : 2; // BackgroundEdgeOrigin
206     unsigned m_backgroundYOrigin : 2; // BackgroundEdgeOrigin
207     unsigned m_compositeSet : 1;
208     unsigned m_blendModeSet : 1;
209     unsigned m_maskSourceTypeSet : 1;
210
211     unsigned m_type : 1; // EFillLayerType
212
213     mutable unsigned m_clipMax : 2; // EFillBox, maximum m_clip value from this to bottom layer
214 };
215
216 TextStream& operator<<(TextStream&, FillSize);
217 TextStream& operator<<(TextStream&, const FillLayer&);
218
219 } // namespace WebCore
220
221 #endif // FillLayer_h