More const in CSSToStyleMap
[WebKit-https.git] / Source / WebCore / css / CSSPrimitiveValue.h
1 /*
2  * (C) 1999-2003 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.
4  * Copyright (C) 2007 Alexey Proskuryakov <ap@webkit.org>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef CSSPrimitiveValue_h
23 #define CSSPrimitiveValue_h
24
25 #include "CSSPropertyNames.h"
26 #include "CSSValue.h"
27 #include "CSSValueKeywords.h"
28 #include "Color.h"
29 #include "LayoutUnit.h"
30 #include <utility>
31 #include <wtf/Forward.h>
32 #include <wtf/MathExtras.h>
33 #include <wtf/PassRefPtr.h>
34
35 namespace WebCore {
36
37 class CSSCalcValue;
38 class CSSToLengthConversionData;
39 class Counter;
40 class DashboardRegion;
41 class Pair;
42 class Quad;
43 class RGBColor;
44 class Rect;
45 class RenderStyle;
46 class CSSBasicShape;
47
48 #if ENABLE(CSS_SCROLL_SNAP)
49 class LengthRepeat;
50 #endif
51
52 struct CSSFontFamily;
53 struct Length;
54 struct LengthSize;
55
56 // Max/min values for CSS, needs to slightly smaller/larger than the true max/min values to allow for rounding without overflowing.
57 // Subtract two (rather than one) to allow for values to be converted to float and back without exceeding the LayoutUnit::max.
58 const int maxValueForCssLength = intMaxForLayoutUnit - 2;
59 const int minValueForCssLength = intMinForLayoutUnit + 2;
60
61 // Dimension calculations are imprecise, often resulting in values of e.g.
62 // 44.99998. We need to go ahead and round if we're really close to the next
63 // integer value.
64 template<typename T> inline T roundForImpreciseConversion(double value)
65 {
66     value += (value < 0) ? -0.01 : +0.01;
67     return ((value > std::numeric_limits<T>::max()) || (value < std::numeric_limits<T>::min())) ? 0 : static_cast<T>(value);
68 }
69
70 template<> inline float roundForImpreciseConversion(double value)
71 {
72     double ceiledValue = ceil(value);
73     double proximityToNextInt = ceiledValue - value;
74     if (proximityToNextInt <= 0.01 && value > 0)
75         return static_cast<float>(ceiledValue);
76     if (proximityToNextInt >= 0.99 && value < 0)
77         return static_cast<float>(floor(value));
78     return static_cast<float>(value);
79 }
80
81 class CSSPrimitiveValue : public CSSValue {
82 public:
83     enum UnitTypes {
84         CSS_UNKNOWN = 0,
85         CSS_NUMBER = 1,
86         CSS_PERCENTAGE = 2,
87         CSS_EMS = 3,
88         CSS_EXS = 4,
89         CSS_PX = 5,
90         CSS_CM = 6,
91         CSS_MM = 7,
92         CSS_IN = 8,
93         CSS_PT = 9,
94         CSS_PC = 10,
95         CSS_DEG = 11,
96         CSS_RAD = 12,
97         CSS_GRAD = 13,
98         CSS_MS = 14,
99         CSS_S = 15,
100         CSS_HZ = 16,
101         CSS_KHZ = 17,
102         CSS_DIMENSION = 18,
103         CSS_STRING = 19,
104         CSS_URI = 20,
105         CSS_IDENT = 21,
106         CSS_ATTR = 22,
107         CSS_COUNTER = 23,
108         CSS_RECT = 24,
109         CSS_RGBCOLOR = 25,
110         // From CSS Values and Units. Viewport-percentage Lengths (vw/vh/vmin/vmax).
111         CSS_VW = 26,
112         CSS_VH = 27,
113         CSS_VMIN = 28,
114         CSS_VMAX = 29,
115         CSS_DPPX = 30,
116         CSS_DPI = 31,
117         CSS_DPCM = 32,
118         CSS_FR = 33,
119 #if ENABLE(CSS_SCROLL_SNAP)
120         CSS_LENGTH_REPEAT = 34,
121 #endif
122         CSS_PAIR = 100, // We envision this being exposed as a means of getting computed style values for pairs (border-spacing/radius, background-position, etc.)
123 #if ENABLE(DASHBOARD_SUPPORT)
124         CSS_DASHBOARD_REGION = 101, // FIXME: Dashboard region should not be a primitive value.
125 #endif
126         CSS_UNICODE_RANGE = 102,
127
128         // These next types are just used internally to allow us to translate back and forth from CSSPrimitiveValues to CSSParserValues.
129         CSS_PARSER_OPERATOR = 103,
130         CSS_PARSER_INTEGER = 104,
131         CSS_PARSER_HEXCOLOR = 105,
132
133         // This is used internally for unknown identifiers
134         CSS_PARSER_IDENTIFIER = 106,
135
136         // These are from CSS3 Values and Units, but that isn't a finished standard yet
137         CSS_TURN = 107,
138         CSS_REMS = 108,
139         CSS_CHS = 109,
140
141         // This is used internally for counter names (as opposed to counter values)
142         CSS_COUNTER_NAME = 110,
143
144         // This is used by the CSS Shapes draft
145         CSS_SHAPE = 111,
146
147         // Used by border images.
148         CSS_QUAD = 112,
149
150         CSS_CALC = 113,
151         CSS_CALC_PERCENTAGE_WITH_NUMBER = 114,
152         CSS_CALC_PERCENTAGE_WITH_LENGTH = 115,
153
154         CSS_FONT_FAMILY = 116,
155
156         CSS_PROPERTY_ID = 117,
157         CSS_VALUE_ID = 118
158     };
159
160     // This enum follows the CSSParser::Units enum augmented with UNIT_FREQUENCY for frequencies.
161     enum UnitCategory {
162         UNumber,
163         UPercent,
164         ULength,
165         UAngle,
166         UTime,
167         UFrequency,
168 #if ENABLE(CSS_IMAGE_RESOLUTION) || ENABLE(RESOLUTION_MEDIA_QUERY)
169         UResolution,
170 #endif
171         UOther
172     };
173     static UnitCategory unitCategory(CSSPrimitiveValue::UnitTypes);
174
175     bool isAngle() const
176     {
177         return m_primitiveUnitType == CSS_DEG
178                || m_primitiveUnitType == CSS_RAD
179                || m_primitiveUnitType == CSS_GRAD
180                || m_primitiveUnitType == CSS_TURN;
181     }
182     bool isAttr() const { return m_primitiveUnitType == CSS_ATTR; }
183     bool isCounter() const { return m_primitiveUnitType == CSS_COUNTER; }
184     bool isFontIndependentLength() const { return m_primitiveUnitType >= CSS_PX && m_primitiveUnitType <= CSS_PC; }
185     bool isFontRelativeLength() const
186     {
187         return m_primitiveUnitType == CSS_EMS
188             || m_primitiveUnitType == CSS_EXS
189             || m_primitiveUnitType == CSS_REMS
190             || m_primitiveUnitType == CSS_CHS;
191     }
192     bool isLength() const
193     {
194         unsigned short type = primitiveType();
195         return (type >= CSS_EMS && type <= CSS_PC) || type == CSS_REMS || type == CSS_CHS || isViewportPercentageLength();
196     }
197     bool isNumber() const { return primitiveType() == CSS_NUMBER; }
198     bool isPercentage() const { return primitiveType() == CSS_PERCENTAGE; }
199     bool isPx() const { return primitiveType() == CSS_PX; }
200     bool isRect() const { return m_primitiveUnitType == CSS_RECT; }
201 #if ENABLE(CSS_SCROLL_SNAP)
202     bool isLengthRepeat() const { return m_primitiveUnitType == CSS_LENGTH_REPEAT; }
203 #endif
204     bool isRGBColor() const { return m_primitiveUnitType == CSS_RGBCOLOR; }
205     bool isShape() const { return m_primitiveUnitType == CSS_SHAPE; }
206     bool isString() const { return m_primitiveUnitType == CSS_STRING; }
207     bool isFontFamily() const { return m_primitiveUnitType == CSS_FONT_FAMILY; }
208     bool isTime() const { return m_primitiveUnitType == CSS_S || m_primitiveUnitType == CSS_MS; }
209     bool isURI() const { return m_primitiveUnitType == CSS_URI; }
210     bool isCalculated() const { return m_primitiveUnitType == CSS_CALC; }
211     bool isCalculatedPercentageWithNumber() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_NUMBER; }
212     bool isCalculatedPercentageWithLength() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_LENGTH; }
213     bool isDotsPerInch() const { return primitiveType() == CSS_DPI; }
214     bool isDotsPerPixel() const { return primitiveType() == CSS_DPPX; }
215     bool isDotsPerCentimeter() const { return primitiveType() == CSS_DPCM; }
216     bool isResolution() const
217     {
218         unsigned short type = primitiveType();
219         return type >= CSS_DPPX && type <= CSS_DPCM;
220     }
221
222     bool isViewportPercentageLength() const { return m_primitiveUnitType >= CSS_VW && m_primitiveUnitType <= CSS_VMAX; }
223     bool isViewportPercentageWidth() const { return m_primitiveUnitType == CSS_VW; }
224     bool isViewportPercentageHeight() const { return m_primitiveUnitType == CSS_VH; }
225     bool isViewportPercentageMax() const { return m_primitiveUnitType == CSS_VMAX; }
226     bool isViewportPercentageMin() const { return m_primitiveUnitType == CSS_VMIN; }
227     bool isValueID() const { return m_primitiveUnitType == CSS_VALUE_ID; }
228     bool isFlex() const { return primitiveType() == CSS_FR; }
229
230     static Ref<CSSPrimitiveValue> createIdentifier(CSSValueID valueID) { return adoptRef(*new CSSPrimitiveValue(valueID)); }
231     static Ref<CSSPrimitiveValue> createIdentifier(CSSPropertyID propertyID) { return adoptRef(*new CSSPrimitiveValue(propertyID)); }
232     static Ref<CSSPrimitiveValue> createParserOperator(int parserOperator) { return adoptRef(*new CSSPrimitiveValue(parserOperator)); }
233
234     static Ref<CSSPrimitiveValue> createColor(unsigned rgbValue) { return adoptRef(*new CSSPrimitiveValue(rgbValue)); }
235     static Ref<CSSPrimitiveValue> create(double value, UnitTypes type) { return adoptRef(*new CSSPrimitiveValue(value, type)); }
236     static Ref<CSSPrimitiveValue> create(const String& value, UnitTypes type) { return adoptRef(*new CSSPrimitiveValue(value, type)); }
237     static Ref<CSSPrimitiveValue> create(const Length& value, const RenderStyle* style) { return adoptRef(*new CSSPrimitiveValue(value, style)); }
238     static Ref<CSSPrimitiveValue> create(const LengthSize& value, const RenderStyle* style) { return adoptRef(*new CSSPrimitiveValue(value, style)); }
239
240     template<typename T> static Ref<CSSPrimitiveValue> create(T&& value)
241     {
242         return adoptRef(*new CSSPrimitiveValue(std::forward<T>(value)));
243     }
244
245     // This value is used to handle quirky margins in reflow roots (body, td, and th) like WinIE.
246     // The basic idea is that a stylesheet can use the value __qem (for quirky em) instead of em.
247     // When the quirky value is used, if you're in quirks mode, the margin will collapse away
248     // inside a table cell.
249     static Ref<CSSPrimitiveValue> createAllowingMarginQuirk(double value, UnitTypes type)
250     {
251         CSSPrimitiveValue* quirkValue = new CSSPrimitiveValue(value, type);
252         quirkValue->m_isQuirkValue = true;
253         return adoptRef(*quirkValue);
254     }
255
256     ~CSSPrimitiveValue();
257
258     void cleanup();
259
260     unsigned short primitiveType() const;
261
262     double computeDegrees() const;
263
264     enum TimeUnit { Seconds, Milliseconds };
265     template <typename T, TimeUnit timeUnit> T computeTime() const
266     {
267         if (timeUnit == Seconds && primitiveType() == CSS_S)
268             return getValue<T>();
269         if (timeUnit == Seconds && primitiveType() == CSS_MS)
270             return getValue<T>() / 1000;
271         if (timeUnit == Milliseconds && primitiveType() == CSS_MS)
272             return getValue<T>();
273         if (timeUnit == Milliseconds && primitiveType() == CSS_S)
274             return getValue<T>() * 1000;
275         ASSERT_NOT_REACHED();
276         return 0;
277     }
278
279     /*
280      * computes a length in pixels out of the given CSSValue. Need the RenderStyle to get
281      * the fontinfo in case val is defined in em or ex.
282      *
283      * The metrics have to be a bit different for screen and printer output.
284      * For screen output we assume 1 inch == 72 px, for printer we assume 300 dpi
285      *
286      * this is screen/printer dependent, so we probably need a config option for this,
287      * and some tool to calibrate.
288      */
289     template<typename T> T computeLength(const CSSToLengthConversionData&) const;
290
291     // Converts to a Length, mapping various unit types appropriately.
292     template<int> Length convertToLength(const CSSToLengthConversionData&) const;
293
294     bool convertingToLengthRequiresNonNullStyle(int lengthConversion) const;
295
296     // use with care!!!
297     void setPrimitiveType(unsigned short type) { m_primitiveUnitType = type; }
298
299     double getDoubleValue(unsigned short unitType, ExceptionCode&) const;
300     double getDoubleValue(unsigned short unitType) const;
301     double getDoubleValue() const;
302
303     void setFloatValue(unsigned short unitType, double floatValue, ExceptionCode&);
304     float getFloatValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<float>(unitType, ec); }
305     float getFloatValue(unsigned short unitType) const { return getValue<float>(unitType); }
306     float getFloatValue() const { return getValue<float>(); }
307
308     int getIntValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<int>(unitType, ec); }
309     int getIntValue(unsigned short unitType) const { return getValue<int>(unitType); }
310     int getIntValue() const { return getValue<int>(); }
311
312     template<typename T> inline T getValue(unsigned short unitType, ExceptionCode& ec) const { return clampTo<T>(getDoubleValue(unitType, ec)); }
313     template<typename T> inline T getValue(unsigned short unitType) const { return clampTo<T>(getDoubleValue(unitType)); }
314     template<typename T> inline T getValue() const { return clampTo<T>(getDoubleValue()); }
315
316     void setStringValue(unsigned short stringType, const String& stringValue, ExceptionCode&);
317     String getStringValue(ExceptionCode&) const;
318     String getStringValue() const;
319
320     Counter* getCounterValue(ExceptionCode&) const;
321     Counter* getCounterValue() const { return m_primitiveUnitType != CSS_COUNTER ? 0 : m_value.counter; }
322
323     Rect* getRectValue(ExceptionCode&) const;
324     Rect* getRectValue() const { return m_primitiveUnitType != CSS_RECT ? 0 : m_value.rect; }
325
326     Quad* getQuadValue(ExceptionCode&) const;
327     Quad* getQuadValue() const { return m_primitiveUnitType != CSS_QUAD ? 0 : m_value.quad; }
328
329 #if ENABLE(CSS_SCROLL_SNAP)
330     LengthRepeat* getLengthRepeatValue(ExceptionCode&) const;
331     LengthRepeat* getLengthRepeatValue() const { return m_primitiveUnitType != CSS_LENGTH_REPEAT ? 0 : m_value.lengthRepeat; }
332 #endif
333
334     PassRefPtr<RGBColor> getRGBColorValue(ExceptionCode&) const;
335     RGBA32 getRGBA32Value() const { return m_primitiveUnitType != CSS_RGBCOLOR ? 0 : m_value.rgbcolor; }
336
337     Pair* getPairValue(ExceptionCode&) const;
338     Pair* getPairValue() const { return m_primitiveUnitType != CSS_PAIR ? nullptr : m_value.pair; }
339
340 #if ENABLE(DASHBOARD_SUPPORT)
341     DashboardRegion* getDashboardRegionValue() const { return m_primitiveUnitType != CSS_DASHBOARD_REGION ? nullptr : m_value.region; }
342 #endif
343
344     CSSBasicShape* getShapeValue() const { return m_primitiveUnitType != CSS_SHAPE ? nullptr : m_value.shape; }
345
346     const CSSFontFamily& fontFamily() const { ASSERT(m_primitiveUnitType == CSS_FONT_FAMILY); return *m_value.fontFamily; }
347
348     CSSCalcValue* cssCalcValue() const { return m_primitiveUnitType != CSS_CALC ? nullptr : m_value.calc; }
349
350     CSSPropertyID getPropertyID() const { return m_primitiveUnitType == CSS_PROPERTY_ID ? m_value.propertyID : CSSPropertyInvalid; }
351     CSSValueID getValueID() const { return m_primitiveUnitType == CSS_VALUE_ID ? m_value.valueID : CSSValueInvalid; }
352
353     template<typename T> inline operator T() const; // Defined in CSSPrimitiveValueMappings.h
354
355     String customCSSText() const;
356
357     bool isQuirkValue() { return m_isQuirkValue; }
358
359     void addSubresourceStyleURLs(ListHashSet<URL>&, const StyleSheetContents*) const;
360
361     PassRefPtr<CSSPrimitiveValue> cloneForCSSOM() const;
362     void setCSSOMSafe() { m_isCSSOMSafe = true; }
363
364     bool equals(const CSSPrimitiveValue&) const;
365
366     static UnitTypes canonicalUnitTypeForCategory(UnitCategory);
367     static double conversionToCanonicalUnitsScaleFactor(unsigned short unitType);
368
369 private:
370     CSSPrimitiveValue(CSSValueID);
371     CSSPrimitiveValue(CSSPropertyID);
372     // FIXME: int vs. unsigned overloading is too subtle to distinguish the color and operator cases.
373     CSSPrimitiveValue(int parserOperator);
374     CSSPrimitiveValue(unsigned color); // RGB value
375     CSSPrimitiveValue(const Length&);
376     CSSPrimitiveValue(const Length&, const RenderStyle*);
377     CSSPrimitiveValue(const LengthSize&, const RenderStyle*);
378     CSSPrimitiveValue(const String&, UnitTypes);
379     CSSPrimitiveValue(double, UnitTypes);
380
381     template<typename T> CSSPrimitiveValue(T); // Defined in CSSPrimitiveValueMappings.h
382     template<typename T> CSSPrimitiveValue(T* val)
383         : CSSValue(PrimitiveClass)
384     {
385         init(PassRefPtr<T>(val));
386     }
387
388     template<typename T> CSSPrimitiveValue(PassRefPtr<T> value)
389         : CSSValue(PrimitiveClass)
390     {
391         init(value);
392     }
393
394     template<typename T> CSSPrimitiveValue(Ref<T>&& value)
395         : CSSValue(PrimitiveClass)
396     {
397         init(WTF::move(value));
398     }
399
400     static void create(int); // compile-time guard
401     static void create(unsigned); // compile-time guard
402     template<typename T> operator T*(); // compile-time guard
403
404     void init(const Length&);
405     void init(const LengthSize&, const RenderStyle*);
406     void init(Ref<Counter>&&);
407     void init(PassRefPtr<Rect>);
408     void init(PassRefPtr<Pair>);
409     void init(PassRefPtr<Quad>);
410 #if ENABLE(CSS_SCROLL_SNAP)
411     void init(PassRefPtr<LengthRepeat>);
412 #endif
413     void init(PassRefPtr<DashboardRegion>); // FIXME: Dashboard region should not be a primitive value.
414     void init(PassRefPtr<CSSBasicShape>);
415     void init(PassRefPtr<CSSCalcValue>);
416     bool getDoubleValueInternal(UnitTypes targetUnitType, double* result) const;
417
418     double computeLengthDouble(const CSSToLengthConversionData&) const;
419
420     ALWAYS_INLINE String formatNumberForCustomCSSText() const;
421     template <unsigned characterCount>
422     ALWAYS_INLINE Ref<StringImpl> formatNumberValue(const char (&characters)[characterCount]) const;
423     NEVER_INLINE Ref<StringImpl> formatNumberValue(const char* suffix, unsigned suffixLength) const;
424
425     union {
426         CSSPropertyID propertyID;
427         CSSValueID valueID;
428         int parserOperator;
429         double num;
430         StringImpl* string;
431         Counter* counter;
432         Rect* rect;
433         Quad* quad;
434 #if ENABLE(CSS_SCROLL_SNAP)
435         LengthRepeat* lengthRepeat;
436 #endif
437         unsigned rgbcolor;
438         Pair* pair;
439         DashboardRegion* region;
440         CSSBasicShape* shape;
441         CSSCalcValue* calc;
442         const CSSFontFamily* fontFamily;
443     } m_value;
444 };
445
446 } // namespace WebCore
447
448 SPECIALIZE_TYPE_TRAITS_CSS_VALUE(CSSPrimitiveValue, isPrimitiveValue())
449
450 #endif // CSSPrimitiveValue_h