613f792c7bb42fbe33686bb8a5f00636a00c955b
[WebKit-https.git] / Source / WebCore / css / parser / CSSParserImpl.h
1 // Copyright 2014 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 "CSSDeferredParser.h"
33 #include "CSSParser.h"
34 #include "CSSParserMode.h"
35 #include "CSSParserTokenRange.h"
36 #include "CSSProperty.h"
37 #include "CSSPropertyNames.h"
38 #include "CSSPropertySourceData.h"
39 #include "StyleRule.h"
40
41 #include <memory>
42 #include <wtf/Vector.h>
43 #include <wtf/text/WTFString.h>
44
45 namespace WebCore {
46
47 class CSSParserObserver;
48 class CSSParserObserverWrapper;
49 class CSSSelectorList;
50 class CSSTokenizer;
51 class StyleKeyframe;
52 class StyleRule;
53 class StyleRuleBase;
54 class StyleRuleCharset;
55 class StyleRuleFontFace;
56 class StyleRuleImport;
57 class StyleRuleKeyframes;
58 class StyleRuleMedia;
59 class StyleRuleNamespace;
60 class StyleRulePage;
61 class StyleRuleSupports;
62 class StyleRuleViewport;
63 class StyleSheetContents;
64 class ImmutableStyleProperties;
65 class Element;
66 class MutableStyleProperties;
67     
68 class CSSParserImpl {
69     WTF_MAKE_NONCOPYABLE(CSSParserImpl);
70 public:
71     CSSParserImpl(const CSSParserContext&, const String&, StyleSheetContents* = nullptr, CSSParserObserverWrapper* = nullptr, CSSParser::RuleParsing = CSSParser::RuleParsing::Normal);
72
73     enum AllowedRulesType {
74         // As per css-syntax, css-cascade and css-namespaces, @charset rules
75         // must come first, followed by @import then @namespace.
76         // AllowImportRules actually means we allow @import and any rules thay
77         // may follow it, i.e. @namespace rules and regular rules.
78         // AllowCharsetRules and AllowNamespaceRules behave similarly.
79         AllowCharsetRules,
80         AllowImportRules,
81         AllowNamespaceRules,
82         RegularRules,
83         KeyframeRules,
84         ApplyRules, // For @apply inside style rules
85         NoRules, // For parsing at-rules inside declaration lists
86     };
87
88     static CSSParser::ParseResult parseValue(MutableStyleProperties*, CSSPropertyID, const String&, bool important, const CSSParserContext&);
89     static CSSParser::ParseResult parseCustomPropertyValue(MutableStyleProperties*, const AtomicString& propertyName, const String&, bool important, const CSSParserContext&);
90     static Ref<ImmutableStyleProperties> parseInlineStyleDeclaration(const String&, Element*);
91     static bool parseDeclarationList(MutableStyleProperties*, const String&, const CSSParserContext&);
92     static RefPtr<StyleRuleBase> parseRule(const String&, const CSSParserContext&, StyleSheetContents*, AllowedRulesType);
93     static void parseStyleSheet(const String&, const CSSParserContext&, StyleSheetContents*, CSSParser::RuleParsing);
94     static CSSSelectorList parsePageSelector(CSSParserTokenRange, StyleSheetContents*);
95
96     static std::unique_ptr<Vector<double>> parseKeyframeKeyList(const String&);
97
98     bool supportsDeclaration(CSSParserTokenRange&);
99
100     static void parseDeclarationListForInspector(const String&, const CSSParserContext&, CSSParserObserver&);
101     static void parseStyleSheetForInspector(const String&, const CSSParserContext&, StyleSheetContents*, CSSParserObserver&);
102
103     static Ref<ImmutableStyleProperties> parseDeferredDeclaration(CSSParserTokenRange, const CSSParserContext&, StyleSheetContents*);
104     static void parseDeferredRuleList(CSSParserTokenRange, CSSDeferredParser&, Vector<RefPtr<StyleRuleBase>>&);
105     static void parseDeferredKeyframeList(CSSParserTokenRange, CSSDeferredParser&, StyleRuleKeyframes&);
106
107     CSSTokenizer* tokenizer() const { return m_tokenizer.get(); };
108     CSSDeferredParser* deferredParser() const { return m_deferredParser.get(); }
109
110 private:
111     CSSParserImpl(const CSSParserContext&, StyleSheetContents*);
112     CSSParserImpl(CSSDeferredParser&);
113
114     enum RuleListType {
115         TopLevelRuleList,
116         RegularRuleList,
117         KeyframesRuleList
118     };
119
120     // Returns whether the first encountered rule was valid
121     template<typename T>
122     bool consumeRuleList(CSSParserTokenRange, RuleListType, T callback);
123
124     // These two functions update the range they're given
125     RefPtr<StyleRuleBase> consumeAtRule(CSSParserTokenRange&, AllowedRulesType);
126     RefPtr<StyleRuleBase> consumeQualifiedRule(CSSParserTokenRange&, AllowedRulesType);
127
128     static RefPtr<StyleRuleCharset> consumeCharsetRule(CSSParserTokenRange prelude);
129     RefPtr<StyleRuleImport> consumeImportRule(CSSParserTokenRange prelude);
130     RefPtr<StyleRuleNamespace> consumeNamespaceRule(CSSParserTokenRange prelude);
131     RefPtr<StyleRuleMedia> consumeMediaRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
132     RefPtr<StyleRuleSupports> consumeSupportsRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
133     RefPtr<StyleRuleViewport> consumeViewportRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
134     RefPtr<StyleRuleFontFace> consumeFontFaceRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
135     RefPtr<StyleRuleKeyframes> consumeKeyframesRule(bool webkitPrefixed, CSSParserTokenRange prelude, CSSParserTokenRange block);
136     RefPtr<StyleRulePage> consumePageRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
137 #if ENABLE(CSS_REGIONS)
138     RefPtr<StyleRuleRegion> consumeRegionRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
139 #endif
140     // Updates m_parsedProperties
141     
142     // FIXME-NEWPARSER: Support "apply"
143     // void consumeApplyRule(CSSParserTokenRange prelude);
144
145     RefPtr<StyleKeyframe> consumeKeyframeStyleRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
146     RefPtr<StyleRule> consumeStyleRule(CSSParserTokenRange prelude, CSSParserTokenRange block);
147
148     void consumeDeclarationList(CSSParserTokenRange, StyleRule::Type);
149     void consumeDeclaration(CSSParserTokenRange, StyleRule::Type);
150     void consumeDeclarationValue(CSSParserTokenRange, CSSPropertyID, bool important, StyleRule::Type);
151     void consumeCustomPropertyValue(CSSParserTokenRange, const AtomicString& propertyName, bool important);
152
153     static std::unique_ptr<Vector<double>> consumeKeyframeKeyList(CSSParserTokenRange);
154
155     Ref<DeferredStyleProperties> createDeferredStyleProperties(const CSSParserTokenRange& propertyRange);
156     
157     void adoptTokenizerEscapedStrings();
158
159     // FIXME: Can we build StylePropertySets directly?
160     // FIXME: Investigate using a smaller inline buffer
161     ParsedPropertyVector m_parsedProperties;
162     const CSSParserContext& m_context;
163
164     RefPtr<StyleSheetContents> m_styleSheet;
165
166     // For deferred property parsing.
167     RefPtr<CSSDeferredParser> m_deferredParser;
168     
169     // For normal parsing.
170     std::unique_ptr<CSSTokenizer> m_tokenizer;
171
172     // For the inspector
173     CSSParserObserverWrapper* m_observerWrapper { nullptr };
174 };
175
176 } // namespace WebCore