Remove an unused PageGroup function
[WebKit-https.git] / Source / WebCore / page / PageGroup.h
1 /*
2  * Copyright (C) 2008 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef PageGroup_h
27 #define PageGroup_h
28
29 #include "LinkHash.h"
30 #include "SecurityOriginHash.h"
31 #include "Supplementable.h"
32 #include "UserScript.h"
33 #include "UserStyleSheet.h"
34 #include <wtf/HashSet.h>
35 #include <wtf/Noncopyable.h>
36
37 namespace WebCore {
38
39     class URL;
40     class GroupSettings;
41     class IDBFactoryBackendInterface;
42     class Page;
43     class SecurityOrigin;
44     class StorageNamespace;
45     class UserContentController;
46
47 #if ENABLE(VIDEO_TRACK)
48     class CaptionPreferencesChangedListener;
49     class CaptionUserPreferences;
50 #endif
51
52     class PageGroup : public Supplementable<PageGroup> {
53         WTF_MAKE_NONCOPYABLE(PageGroup); WTF_MAKE_FAST_ALLOCATED;
54     public:
55         explicit PageGroup(const String& name);
56         explicit PageGroup(Page&);
57         ~PageGroup();
58
59         static PageGroup* pageGroup(const String& groupName);
60
61         static void closeLocalStorage();
62
63         static void clearLocalStorageForAllOrigins();
64         static void clearLocalStorageForOrigin(SecurityOrigin*);
65         static void closeIdleLocalStorageDatabases();
66         // DumpRenderTree helper that triggers a StorageArea sync.
67         static void syncLocalStorage();
68
69         const HashSet<Page*>& pages() const { return m_pages; }
70
71         void addPage(Page&);
72         void removePage(Page&);
73
74         bool isLinkVisited(LinkHash);
75
76         void addVisitedLink(const URL&);
77         void addVisitedLink(const UChar*, size_t);
78         void addVisitedLinkHash(LinkHash);
79         void removeVisitedLink(const URL&);
80         void removeVisitedLinks();
81
82         static void setShouldTrackVisitedLinks(bool);
83         static void removeAllVisitedLinks();
84
85         const String& name() { return m_name; }
86         unsigned identifier() { return m_identifier; }
87
88         StorageNamespace* localStorage();
89         bool hasLocalStorage() { return m_localStorage; }
90
91         StorageNamespace* transientLocalStorage(SecurityOrigin* topOrigin);
92
93         void addUserScriptToWorld(DOMWrapperWorld&, const String& source, const URL&, const Vector<String>& whitelist, const Vector<String>& blacklist, UserScriptInjectionTime, UserContentInjectedFrames);
94         void addUserStyleSheetToWorld(DOMWrapperWorld&, const String& source, const URL&, const Vector<String>& whitelist, const Vector<String>& blacklist, UserContentInjectedFrames, UserStyleLevel = UserStyleUserLevel, UserStyleInjectionTime = InjectInExistingDocuments);
95         void removeUserStyleSheetFromWorld(DOMWrapperWorld&, const URL&);
96         void removeUserScriptFromWorld(DOMWrapperWorld&, const URL&);
97         void removeUserScriptsFromWorld(DOMWrapperWorld&);
98         void removeUserStyleSheetsFromWorld(DOMWrapperWorld&);
99         void removeAllUserContent();
100
101         GroupSettings& groupSettings() const { return *m_groupSettings; }
102
103 #if ENABLE(VIDEO_TRACK)
104         void captionPreferencesChanged();
105         CaptionUserPreferences* captionPreferences();
106 #endif
107
108     private:
109         void addVisitedLink(LinkHash);
110
111         String m_name;
112         HashSet<Page*> m_pages;
113
114         HashSet<LinkHash, LinkHashHash> m_visitedLinkHashes;
115         bool m_visitedLinksPopulated;
116
117         unsigned m_identifier;
118         RefPtr<StorageNamespace> m_localStorage;
119         HashMap<RefPtr<SecurityOrigin>, RefPtr<StorageNamespace>> m_transientLocalStorageMap;
120
121         RefPtr<UserContentController> m_userContentController;
122
123         const std::unique_ptr<GroupSettings> m_groupSettings;
124
125 #if ENABLE(VIDEO_TRACK)
126         std::unique_ptr<CaptionUserPreferences> m_captionPreferences;
127 #endif
128     };
129
130 } // namespace WebCore
131     
132 #endif // PageGroup_h