2 * Copyright (C) 2010 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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
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.
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.
31 #ifndef WebApplicationCacheHost_h
32 #define WebApplicationCacheHost_h
34 #include "WebCommon.h"
36 #include "WebVector.h"
40 class WebApplicationCacheHostClient;
46 // This interface is used by webkit to call out to the embedder. Webkit uses
47 // the WebFrameClient::createApplicationCacheHost method to create instances,
48 // and calls delete when the instance is no longer needed.
49 class WebApplicationCacheHost {
51 // These values must match WebCore::ApplicationCacheHost::Status values
61 // These values must match WebCore::ApplicationCacheHost::EventID values
84 virtual ~WebApplicationCacheHost() { }
86 // Called for every request made within the context.
87 virtual void willStartMainResourceRequest(WebURLRequest& r, const WebApplicationCacheHost* spawningHost) { }
88 virtual void willStartSubResourceRequest(WebURLRequest&) { }
90 // One or the other selectCache methods is called after having parsed the <html> tag.
91 // The latter returns false if the current document has been identified as a "foreign"
92 // entry, in which case the frame navigation will be restarted by webkit.
93 virtual void selectCacheWithoutManifest() { }
94 virtual bool selectCacheWithManifest(const WebURL& manifestURL) { return true; }
96 // Called as the main resource is retrieved.
97 virtual void didReceiveResponseForMainResource(const WebURLResponse&) { }
98 virtual void didReceiveDataForMainResource(const char* data, int len) { }
99 virtual void didFinishLoadingMainResource(bool success) { }
101 // Called on behalf of the scriptable interface.
102 virtual Status status() { return Uncached; }
103 virtual bool startUpdate() { return false; }
104 virtual bool swapCache() { return false; }
105 virtual void abort() { }
107 // Structures and methods to support inspecting Application Caches.
109 WebURL manifestURL; // Empty if there is no associated cache.
113 CacheInfo() : creationTime(0), updateTime(0), totalSize(0) { }
115 struct ResourceInfo {
123 ResourceInfo() : size(0), isMaster(false), isManifest(false), isExplicit(false), isForeign(false), isFallback(false) { }
125 virtual void getAssociatedCacheInfo(CacheInfo*) { }
126 virtual void getResourceList(WebVector<ResourceInfo>*) { }
127 virtual void deleteAssociatedCacheGroup() { }
132 #endif // WebApplicationCacheHost_h