Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / css / parser / CSSPropertyParserHelpers.h
1 // Copyright 2016 The Chromium Authors. All rights reserved.
2 // Copyright (C) 2016 Apple Inc. All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 //    * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //    * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //    * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 #pragma once
31
32 #include "CSSCustomIdentValue.h"
33 #include "CSSParserMode.h"
34 #include "CSSParserTokenRange.h"
35 #include "CSSPrimitiveValue.h"
36 #include "Length.h" // For ValueRange
37
38 namespace WebCore {
39
40 // When these functions are successful, they will consume all the relevant
41 // tokens from the range and also consume any whitespace which follows. When
42 // the start of the range doesn't match the type we're looking for, the range
43 // will not be modified.
44 namespace CSSPropertyParserHelpers {
45
46 // FIXME: These should probably just be consumeComma and consumeSlash.
47 bool consumeCommaIncludingWhitespace(CSSParserTokenRange&);
48 bool consumeSlashIncludingWhitespace(CSSParserTokenRange&);
49 // consumeFunction expects the range starts with a FunctionToken.
50 CSSParserTokenRange consumeFunction(CSSParserTokenRange&);
51
52 enum class UnitlessQuirk {
53     Allow,
54     Forbid
55 };
56
57 RefPtr<CSSPrimitiveValue> consumeInteger(CSSParserTokenRange&, double minimumValue = -std::numeric_limits<double>::max());
58 RefPtr<CSSPrimitiveValue> consumePositiveInteger(CSSParserTokenRange&);
59 bool consumeNumberRaw(CSSParserTokenRange&, double& result);
60 RefPtr<CSSPrimitiveValue> consumeNumber(CSSParserTokenRange&, ValueRange);
61 RefPtr<CSSPrimitiveValue> consumeLength(CSSParserTokenRange&, CSSParserMode, ValueRange, UnitlessQuirk = UnitlessQuirk::Forbid);
62 RefPtr<CSSPrimitiveValue> consumePercent(CSSParserTokenRange&, ValueRange);
63 RefPtr<CSSPrimitiveValue> consumeLengthOrPercent(CSSParserTokenRange&, CSSParserMode, ValueRange, UnitlessQuirk = UnitlessQuirk::Forbid);
64 RefPtr<CSSPrimitiveValue> consumeAngle(CSSParserTokenRange&, CSSParserMode, UnitlessQuirk = UnitlessQuirk::Forbid);
65 RefPtr<CSSPrimitiveValue> consumeTime(CSSParserTokenRange&, CSSParserMode, ValueRange, UnitlessQuirk = UnitlessQuirk::Forbid);
66
67 RefPtr<CSSPrimitiveValue> consumeIdent(CSSParserTokenRange&);
68 RefPtr<CSSPrimitiveValue> consumeIdentRange(CSSParserTokenRange&, CSSValueID lower, CSSValueID upper);
69 template<CSSValueID, CSSValueID...> inline bool identMatches(CSSValueID id);
70 template<CSSValueID... allowedIdents> RefPtr<CSSPrimitiveValue> consumeIdent(CSSParserTokenRange&);
71
72 RefPtr<CSSPrimitiveValue> consumeCustomIdent(CSSParserTokenRange&);
73 RefPtr<CSSPrimitiveValue> consumeString(CSSParserTokenRange&);
74 StringView consumeUrlAsStringView(CSSParserTokenRange&);
75 RefPtr<CSSPrimitiveValue> consumeUrl(CSSParserTokenRange&);
76
77 RefPtr<CSSPrimitiveValue> consumeColor(CSSParserTokenRange&, CSSParserMode, bool acceptQuirkyColors = false);
78
79 RefPtr<CSSPrimitiveValue> consumePosition(CSSParserTokenRange&, CSSParserMode, UnitlessQuirk);
80 bool consumePosition(CSSParserTokenRange&, CSSParserMode, UnitlessQuirk, RefPtr<CSSPrimitiveValue>& resultX, RefPtr<CSSPrimitiveValue>& resultY);
81 bool consumeOneOrTwoValuedPosition(CSSParserTokenRange&, CSSParserMode, UnitlessQuirk, RefPtr<CSSPrimitiveValue>& resultX, RefPtr<CSSPrimitiveValue>& resultY);
82
83 enum class ConsumeGeneratedImage {
84     Allow,
85     Forbid
86 };
87
88 RefPtr<CSSValue> consumeImage(CSSParserTokenRange&, CSSParserContext, ConsumeGeneratedImage = ConsumeGeneratedImage::Allow);
89 RefPtr<CSSValue> consumeImageOrNone(CSSParserTokenRange&, CSSParserContext);
90
91 // Template implementations are at the bottom of the file for readability.
92
93 template<typename... emptyBaseCase> inline bool identMatches(CSSValueID) { return false; }
94 template<CSSValueID head, CSSValueID... tail> inline bool identMatches(CSSValueID id)
95 {
96     return id == head || identMatches<tail...>(id);
97 }
98
99 // FIXME-NEWPARSER - converted to a RefPtr return type from a raw ptr.
100 template<CSSValueID... names> RefPtr<CSSPrimitiveValue> consumeIdent(CSSParserTokenRange& range)
101 {
102     if (range.peek().type() != IdentToken || !identMatches<names...>(range.peek().id()))
103         return nullptr;
104     return CSSPrimitiveValue::createIdentifier(range.consumeIncludingWhitespace().id());
105 }
106
107 static inline bool isCSSWideKeyword(const CSSValueID& id)
108 {
109     return id == CSSValueInitial || id == CSSValueInherit || id == CSSValueUnset || id == CSSValueRevert || id == CSSValueDefault;
110 }
111
112 } // namespace CSSPropertyParserHelpers
113
114 } // namespace WebCore