For local review prior to sending to webkit

loader/appcache2/ApplicationCacheBridge.h

+/*
+ * Copyright (c) 2009, Google Inc.  All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef ApplicationCacheBridge_h
+#define ApplicationCacheBridge_h
+
+#if ENABLE(APPLICATION_CACHE)
+
+#include "ApplicationCacheCommon.h"
+#include "KURL.h"
+#include <wtf/MessageQueue.h>
+
+namespace WebCore {
+
+    // This interface is used to by the bridge to call the frontend.
+    class ApplicationCacheBridgeClient {
+    public:
+        virtual ~ApplicationCacheBridgeClient() {}
+
+        // Completion callbacks delivered in response to one of the select cache calls
+        virtual void selectCacheComplete(const GlobalApplicationCacheContextID &contextID,
+                                         int cacheSequenceNumber,
+                                         ApplicationCacheStatus status) = 0;
+
+        // Event related callbacks that just happen, not in direct response
+        // to an async method call. These are broadcast to a collection of contexts.
+        virtual void notifyStatusChanged(const Vector<GlobalApplicationCacheContextID>& contextIDs,
+                                         int cacheSequenceNumber,
+                                         ApplicationCacheStatus statusValue)  = 0;
+        virtual void notifyEventListener(const Vector<GlobalApplicationCacheContextID>& contextIDs,
+                                         int cacheSequenceNumber,
+                                         ApplicationCacheEventType eventType) = 0;
+    };
+
+    // The class is used by the frontend to call the backend.
+    class ApplicationCacheBridge {
+    public:
+        ApplicationCacheBridge(ApplicationCacheBridgeClient* client)
+            : m_client(client)
+        {
+        }
+
+        virtual ~ApplicationCacheBridge()
+        {
+            if (m_instance == this)
+                setInstance(0);
+        }
+
+        // The following async methods schedule tasks to be performed in the
+        // backend and return immediately.
+
+        virtual void initializeContextAsync(const GlobalApplicationCacheContextID &contextID,
+                                            ApplicationCacheContextType contextType,
+                                            const GlobalApplicationCacheContextID& parentContextID) = 0;
+        virtual void uninitializeContextAsync(const GlobalApplicationCacheContextID &contextID) = 0;
+
+        virtual void selectInitialCacheAsync(const GlobalApplicationCacheContextID &contextID,
+                                             int cacheSequenceNumber,
+                                             const KURL& documentURL,
+                                             ApplicationCacheID cacheDocumentWasLoadedFrom) = 0;
+        virtual void selectCacheWithoutManifestAsync(const GlobalApplicationCacheContextID &contextID,
+                                                     int cacheSequenceNumber,
+                                                     const KURL& documentURL,
+                                                     ApplicationCacheID cacheDocumentWasLoadedFrom) = 0;
+        virtual void selectCacheWithManifestAsync(const GlobalApplicationCacheContextID &contextID,
+                                                  int cacheSequenceNumber,
+                                                  const KURL& documentURL,
+                                                  ApplicationCacheID cacheDocumentWasLoadedFrom,
+                                                  const KURL& manifestURLofCacheDocumentWasLoadedFrom,
+                                                  const KURL& manifestURL) = 0;
+
+        // The following methods schedule tasks to be performed in the backend
+        // and wait for completion prior to returning.
+
+        virtual ApplicationCacheStatus status(const GlobalApplicationCacheContextID &contextID) = 0;
+        virtual bool startUpdate(const GlobalApplicationCacheContextID &contextID) = 0;
+        virtual bool swapCache(const GlobalApplicationCacheContextID &contextID) = 0;
+
+        // The host browser may override the default implementation by creating
+        // a concrete impl in its startup sequence and calling setInstance prior
+        // to constructing any ApplicationCacheFrontend instance. Otherwise,
+        // on the first call to instance(), the default ApplicationCacheBridgeImpl
+        // will be started up.
+
+        static void setInstance(ApplicationCacheBridge* bridge);
+        static ApplicationCacheBridge* instance();
+
+    protected:
+        ApplicationCacheBridgeClient* m_client;
+        static ApplicationCacheBridge* m_instance;
+    };
+
+}  // namespace WebCore
+
+#endif  // ENABLE(APPLICATION_CACHE)
+#endif  // ApplicationCacheBridge_h