Refactor ContentExtensionParser
[WebKit-https.git] / Source / WebCore / contentextensions / ContentExtensionsBackend.h
1 /*
2  * Copyright (C) 2014, 2015 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(CONTENT_EXTENSIONS)
29
30 #include "ContentExtension.h"
31 #include "ContentExtensionRule.h"
32 #include <wtf/HashMap.h>
33 #include <wtf/text/StringHash.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class DocumentLoader;
39 class ResourceRequest;
40 class URL;
41
42 struct ResourceLoadInfo;
43
44 namespace ContentExtensions {
45
46 class CompiledContentExtension;
47
48 // The ContentExtensionsBackend is the internal model of all the content extensions.
49 //
50 // It provides two services:
51 // 1) It stores the rules for each content extension.
52 // 2) It provides APIs for the WebCore interfaces to use those rules efficiently.
53 class ContentExtensionsBackend {
54 public:
55     // - Rule management interface. This can be used by upper layer.
56
57     // Set a list of rules for a given name. If there were existing rules for the name, they are overriden.
58     // The identifier cannot be empty.
59     WEBCORE_EXPORT void addContentExtension(const String& identifier, RefPtr<CompiledContentExtension>);
60     WEBCORE_EXPORT void removeContentExtension(const String& identifier);
61     WEBCORE_EXPORT void removeAllContentExtensions();
62
63     // - Internal WebCore Interface.
64     WEBCORE_EXPORT Vector<Action> actionsForResourceLoad(const ResourceLoadInfo&) const;
65     WEBCORE_EXPORT StyleSheetContents* globalDisplayNoneStyleSheet(const String& identifier) const;
66
67     BlockedStatus processContentExtensionRulesForLoad(const URL&, ResourceType, DocumentLoader& initiatingDocumentLoader);
68
69     static const String& displayNoneCSSRule();
70
71 private:
72     HashMap<String, RefPtr<ContentExtension>> m_contentExtensions;
73 };
74
75 } // namespace ContentExtensions
76 } // namespace WebCore
77
78 #endif // ENABLE(CONTENT_EXTENSIONS)