[Content Extensions] Move compiling of content extensions to the UIProcess
[WebKit-https.git] / Source / WebCore / contentextensions / ContentExtensionRule.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 #ifndef ContentExtensionRule_h
27 #define ContentExtensionRule_h
28
29 #if ENABLE(CONTENT_EXTENSIONS)
30
31 #include "ContentExtensionActions.h"
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 namespace ContentExtensions {
37
38 // A ContentExtensionRule is the smallest unit in a ContentExtension.
39 //
40 // It is composed of a trigger and an action. The trigger defines on what kind of content this extension should apply.
41 // The action defines what to perform on that content.
42
43 struct Trigger {
44     String urlFilter;
45     bool urlFilterIsCaseSensitive { false };
46 };
47     
48 struct Action {
49     Action()
50         : m_type(ActionType::InvalidAction)
51     {
52     }
53     Action(ActionType type, const String& cssSelector)
54         : m_type(type)
55         , m_cssSelector(cssSelector)
56     {
57         ASSERT(type == ActionType::CSSDisplayNone);
58     }
59     Action(ActionType type)
60         : m_type(type)
61     {
62         ASSERT(type != ActionType::CSSDisplayNone);
63     }
64     bool operator==(const Action& other) const
65     {
66         return m_type == other.m_type
67             && m_cssSelector == other.m_cssSelector;
68     }
69     static Action deserialize(const SerializedActionByte* actions, const unsigned actionsLength, unsigned location);
70
71     ActionType type() const { return m_type; }
72     const String& cssSelector() const { return m_cssSelector; }
73         
74 private:
75     ActionType m_type;
76     String m_cssSelector;
77 };
78     
79 class ContentExtensionRule {
80 public:
81     ContentExtensionRule(const Trigger&, const Action&);
82
83     const Trigger& trigger() const { return m_trigger; }
84     const Action& action() const { return m_action; }
85
86 private:
87     Trigger m_trigger;
88     Action m_action;
89 };
90
91 } // namespace ContentExtensions
92
93 } // namespace WebCore
94
95 #endif // ENABLE(CONTENT_EXTENSIONS)
96
97 #endif // ContentExtensionRule_h