Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / css / StyleSheetContents.h
1 /*
2  * (C) 1999-2003 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #pragma once
22
23 #include "CSSParserMode.h"
24 #include "CachePolicy.h"
25 #include "URL.h"
26 #include <wtf/HashMap.h>
27 #include <wtf/ListHashSet.h>
28 #include <wtf/RefCounted.h>
29 #include <wtf/Vector.h>
30 #include <wtf/text/AtomicStringHash.h>
31 #include <wtf/text/TextPosition.h>
32
33 namespace WebCore {
34
35 class CSSStyleSheet;
36 class CachedCSSStyleSheet;
37 class CachedResource;
38 class Document;
39 class Node;
40 class SecurityOrigin;
41 class StyleRuleBase;
42 class StyleRuleImport;
43 class StyleRuleNamespace;
44
45 class StyleSheetContents final : public RefCounted<StyleSheetContents> {
46 public:
47     static Ref<StyleSheetContents> create(const CSSParserContext& context = CSSParserContext(HTMLStandardMode))
48     {
49         return adoptRef(*new StyleSheetContents(0, String(), context));
50     }
51     static Ref<StyleSheetContents> create(const String& originalURL, const CSSParserContext& context)
52     {
53         return adoptRef(*new StyleSheetContents(0, originalURL, context));
54     }
55     static Ref<StyleSheetContents> create(StyleRuleImport* ownerRule, const String& originalURL, const CSSParserContext& context)
56     {
57         return adoptRef(*new StyleSheetContents(ownerRule, originalURL, context));
58     }
59
60     WEBCORE_EXPORT ~StyleSheetContents();
61     
62     const CSSParserContext& parserContext() const { return m_parserContext; }
63     
64     const AtomicString& defaultNamespace() { return m_defaultNamespace; }
65     const AtomicString& namespaceURIFromPrefix(const AtomicString& prefix);
66
67     void parseAuthorStyleSheet(const CachedCSSStyleSheet*, const SecurityOrigin*);
68     WEBCORE_EXPORT bool parseString(const String&);
69     bool parseStringAtPosition(const String&, const TextPosition&, bool createdByParser);
70
71     bool isCacheable() const;
72
73     bool isLoading() const;
74     bool subresourcesAllowReuse(CachePolicy) const;
75     WEBCORE_EXPORT bool isLoadingSubresources() const;
76
77     void checkLoaded();
78     void startLoadingDynamicSheet();
79
80     StyleSheetContents* rootStyleSheet() const;
81     Node* singleOwnerNode() const;
82     Document* singleOwnerDocument() const;
83
84     const String& charset() const { return m_parserContext.charset; }
85
86     bool loadCompleted() const { return m_loadCompleted; }
87
88     URL completeURL(const String& url) const;
89     bool traverseSubresources(const std::function<bool (const CachedResource&)>& handler) const;
90
91     void setIsUserStyleSheet(bool b) { m_isUserStyleSheet = b; }
92     bool isUserStyleSheet() const { return m_isUserStyleSheet; }
93     void setHasSyntacticallyValidCSSHeader(bool b) { m_hasSyntacticallyValidCSSHeader = b; }
94     bool hasSyntacticallyValidCSSHeader() const { return m_hasSyntacticallyValidCSSHeader; }
95
96     void parserAddNamespace(const AtomicString& prefix, const AtomicString& uri);
97     void parserAppendRule(Ref<StyleRuleBase>&&);
98     void parserSetEncodingFromCharsetRule(const String& encoding); 
99     void parserSetUsesStyleBasedEditability() { m_usesStyleBasedEditability = true; }
100
101     void clearRules();
102
103     String encodingFromCharsetRule() const { return m_encodingFromCharsetRule; }
104     // Rules other than @charset and @import.
105     const Vector<RefPtr<StyleRuleBase>>& childRules() const { return m_childRules; }
106     const Vector<RefPtr<StyleRuleImport>>& importRules() const { return m_importRules; }
107     const Vector<RefPtr<StyleRuleNamespace>>& namespaceRules() const { return m_namespaceRules; }
108
109     void notifyLoadedSheet(const CachedCSSStyleSheet*);
110     
111     StyleSheetContents* parentStyleSheet() const;
112     StyleRuleImport* ownerRule() const { return m_ownerRule; }
113     void clearOwnerRule() { m_ownerRule = 0; }
114     
115     // Note that href is the URL that started the redirect chain that led to
116     // this style sheet. This property probably isn't useful for much except
117     // the JavaScript binding (which needs to use this value for security).
118     String originalURL() const { return m_originalURL; }
119     const URL& baseURL() const { return m_parserContext.baseURL; }
120
121     unsigned ruleCount() const;
122     StyleRuleBase* ruleAt(unsigned index) const;
123
124     bool usesStyleBasedEditability() const { return m_usesStyleBasedEditability; }
125
126     unsigned estimatedSizeInBytes() const;
127     
128     bool wrapperInsertRule(Ref<StyleRuleBase>&&, unsigned index);
129     void wrapperDeleteRule(unsigned index);
130
131     Ref<StyleSheetContents> copy() const { return adoptRef(*new StyleSheetContents(*this)); }
132
133     void registerClient(CSSStyleSheet*);
134     void unregisterClient(CSSStyleSheet*);
135     bool hasOneClient() { return m_clients.size() == 1; }
136
137     bool isMutable() const { return m_isMutable; }
138     void setMutable() { m_isMutable = true; }
139
140     bool isInMemoryCache() const { return m_inMemoryCacheCount; }
141     void addedToMemoryCache();
142     void removedFromMemoryCache();
143
144     void shrinkToFit();
145
146 private:
147     WEBCORE_EXPORT StyleSheetContents(StyleRuleImport* ownerRule, const String& originalURL, const CSSParserContext&);
148     StyleSheetContents(const StyleSheetContents&);
149
150     void clearCharsetRule();
151
152     StyleRuleImport* m_ownerRule;
153
154     String m_originalURL;
155
156     String m_encodingFromCharsetRule;
157     Vector<RefPtr<StyleRuleImport>> m_importRules;
158     Vector<RefPtr<StyleRuleNamespace>> m_namespaceRules;
159     Vector<RefPtr<StyleRuleBase>> m_childRules;
160     typedef HashMap<AtomicString, AtomicString> PrefixNamespaceURIMap;
161     PrefixNamespaceURIMap m_namespaces;
162     AtomicString m_defaultNamespace;
163
164     bool m_isUserStyleSheet;
165     bool m_loadCompleted { false };
166     bool m_hasSyntacticallyValidCSSHeader { true };
167     bool m_didLoadErrorOccur { false };
168     bool m_usesStyleBasedEditability { false };
169     bool m_isMutable { false };
170     unsigned m_inMemoryCacheCount { 0 };
171
172     CSSParserContext m_parserContext;
173
174     Vector<CSSStyleSheet*> m_clients;
175 };
176
177 } // namespace WebCore