2009-11-09 Nate Chapin <japhet@chromium.org>
[WebKit-https.git] / WebKit / chromium / public / WebApplicationCacheHost.h
1 /*
2  * Copyright (C) 2009 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 "WebCommon.h"
35
36 namespace WebKit {
37
38 class WebApplicationCacheHostClient;
39 class WebURL;
40 class WebURLRequest;
41 class WebURLResponse;
42 struct WebURLError;
43
44 // This interface is used by webkit to call out to the embedder. Webkit uses
45 // the WebKitClient::createApplicationCacheHost method to create instances,
46 // and calls delete when the instance is no longer needed.
47 class WebApplicationCacheHost {
48 public:
49     // These values must match WebCore::ApplicationCacheHost::Status values
50     enum Status {
51         Uncached,
52         Idle,
53         Checking,
54         Downloading,
55         UpdateReady,
56         Obsolete
57     };
58
59     // These values must match WebCore::ApplicationCacheHost::EventID values
60     enum EventID {
61         CheckingEvent,
62         ErrorEvent,
63         NoUpdateEvent,
64         DownloadingEvent,
65         ProgressEvent,
66         UpdateReadyEvent,
67         CachedEvent,
68         ObsoleteEvent
69     };
70
71     virtual ~WebApplicationCacheHost() { }
72
73     // Called for every request made within the context.
74     virtual void willStartMainResourceRequest(WebURLRequest&) = 0;
75     virtual void willStartSubResourceRequest(WebURLRequest&) = 0;
76
77     // One or the other selectCache methods is called after having parsed the <html> tag.
78     // The latter returns false if the current document has been identified as a "foreign"
79     // entry, in which case the frame navigation will be restarted by webkit.
80     virtual void selectCacheWithoutManifest() = 0;
81     virtual bool selectCacheWithManifest(const WebURL& manifestURL) = 0;
82
83     // Called as the main resource is retrieved.
84     virtual void didReceiveResponseForMainResource(const WebURLResponse&) = 0;
85     virtual void didReceiveDataForMainResource(const char* data, int len) = 0;
86     virtual void didFinishLoadingMainResource(bool success) = 0;
87
88     // Called on behalf of the scriptable interface.
89     virtual Status status() = 0;
90     virtual bool startUpdate() = 0;
91     virtual bool swapCache() = 0;
92 };
93
94 }  // namespace WebKit
95
96 #endif  // WebApplicationCacheHost_h
97