[Chromium] Remove unused header files in chromium/public/platform/
[WebKit-https.git] / Source / WebKit / chromium / public / WebApplicationCacheHost.h
1 /*
2  * Copyright (C) 2010 Google 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
31 #ifndef WebApplicationCacheHost_h
32 #define WebApplicationCacheHost_h
33
34 #include "../../../Platform/chromium/public/WebCommon.h"
35 #include "../../../Platform/chromium/public/WebURL.h"
36 #include "../../../Platform/chromium/public/WebVector.h"
37
38 namespace WebKit {
39
40 class WebApplicationCacheHostClient;
41 class WebFrame;
42 class WebURL;
43 class WebURLRequest;
44 class WebURLResponse;
45 struct WebURLError;
46
47 // This interface is used by webkit to call out to the embedder. Webkit uses
48 // the WebFrameClient::createApplicationCacheHost method to create instances,
49 // and calls delete when the instance is no longer needed.
50 class WebApplicationCacheHost {
51 public:
52     // These values must match WebCore::ApplicationCacheHost::Status values
53     enum Status {
54         Uncached,
55         Idle,
56         Checking,
57         Downloading,
58         UpdateReady,
59         Obsolete
60     };
61
62     // These values must match WebCore::ApplicationCacheHost::EventID values
63     enum EventID {
64         CheckingEvent,
65         ErrorEvent,
66         NoUpdateEvent,
67         DownloadingEvent,
68         ProgressEvent,
69         UpdateReadyEvent,
70         CachedEvent,
71         ObsoleteEvent
72     };
73
74     virtual ~WebApplicationCacheHost() { }
75
76     // Called for every request made within the context.
77     virtual void willStartMainResourceRequest(WebURLRequest& r, const WebFrame*) { }
78     virtual void willStartSubResourceRequest(WebURLRequest&) { }
79
80     // One or the other selectCache methods is called after having parsed the <html> tag.
81     // The latter returns false if the current document has been identified as a "foreign"
82     // entry, in which case the frame navigation will be restarted by webkit.
83     virtual void selectCacheWithoutManifest() { }
84     virtual bool selectCacheWithManifest(const WebURL& manifestURL) { return true; }
85
86     // Called as the main resource is retrieved.
87     virtual void didReceiveResponseForMainResource(const WebURLResponse&) { }
88     virtual void didReceiveDataForMainResource(const char* data, int len) { }
89     virtual void didFinishLoadingMainResource(bool success) { }
90
91     // Called on behalf of the scriptable interface.
92     virtual Status status() { return Uncached; }
93     virtual bool startUpdate() { return false; }
94     virtual bool swapCache() { return false; }
95     virtual void abort() { }
96
97     // Structures and methods to support inspecting Application Caches.
98     struct CacheInfo {
99         WebURL manifestURL; // Empty if there is no associated cache.
100         double creationTime;
101         double updateTime;
102         long long totalSize;
103         CacheInfo() : creationTime(0), updateTime(0), totalSize(0) { }
104     };
105     struct ResourceInfo {
106         WebURL url;
107         long long size;
108         bool isMaster;
109         bool isManifest;
110         bool isExplicit;
111         bool isForeign;
112         bool isFallback;
113         ResourceInfo() : size(0), isMaster(false), isManifest(false), isExplicit(false), isForeign(false), isFallback(false) { }
114     };
115     virtual void getAssociatedCacheInfo(CacheInfo*) { }
116     virtual void getResourceList(WebVector<ResourceInfo>*) { }
117     virtual void deleteAssociatedCacheGroup() { }
118 };
119
120 }  // namespace WebKit
121
122 #endif  // WebApplicationCacheHost_h