Home | History | Annotate | Download | only in public 
      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
      6  * are met:
      7  *
      8  * 1.  Redistributions of source code must retain the above copyright
      9  *     notice, this list of conditions and the following disclaimer.
     10  * 2.  Redistributions in binary form must reproduce the above copyright
     11  *     notice, this list of conditions and the following disclaimer in the
     12  *     documentation and/or other materials provided with the distribution.
     13  *
     14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
     15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef WebIDBDatabase_h
     27 #define WebIDBDatabase_h
     28 
     29 #include "WebCommon.h"
     30 #include "WebDOMStringList.h"
     31 #include "WebExceptionCode.h"
     32 
     33 namespace WebKit {
     34 
     35 class WebFrame;
     36 class WebIDBCallbacks;
     37 class WebIDBDatabaseCallbacks;
     38 class WebIDBObjectStore;
     39 class WebIDBTransaction;
     40 
     41 // See comment in WebIDBFactory for a high level overview of these classes.
     42 class WebIDBDatabase {
     43 public:
     44     virtual ~WebIDBDatabase() { }
     45 
     46     virtual WebString name() const
     47     {
     48         WEBKIT_ASSERT_NOT_REACHED();
     49         return WebString();
     50     }
     51     virtual WebString version() const
     52     {
     53         WEBKIT_ASSERT_NOT_REACHED();
     54         return WebString();
     55     }
     56     virtual WebDOMStringList objectStoreNames() const
     57     {
     58         WEBKIT_ASSERT_NOT_REACHED();
     59         return WebDOMStringList();
     60     }
     61     virtual WebIDBObjectStore* createObjectStore(const WebString& name, const WebString& keyPath, bool autoIncrement, const WebIDBTransaction&, WebExceptionCode&)
     62     {
     63         WEBKIT_ASSERT_NOT_REACHED();
     64         return 0;
     65     }
     66     virtual void deleteObjectStore(const WebString& name, const WebIDBTransaction& transaction, WebExceptionCode& ec) { WEBKIT_ASSERT_NOT_REACHED(); }
     67     virtual void setVersion(const WebString& version, WebIDBCallbacks* callbacks, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
     68     // Transfers ownership of the WebIDBTransaction to the caller.
     69     virtual WebIDBTransaction* transaction(const WebDOMStringList& names, unsigned short mode, WebExceptionCode& ec)
     70     {
     71         return transaction(names, mode, 0, ec);
     72     }
     73     // FIXME: Remove.
     74     virtual WebIDBTransaction* transaction(const WebDOMStringList& names, unsigned short mode, unsigned long, WebExceptionCode& ec)
     75     {
     76         return transaction(names, mode, ec);
     77     }
     78     virtual void close() { WEBKIT_ASSERT_NOT_REACHED(); }
     79 
     80     virtual void open(WebIDBDatabaseCallbacks*) { WEBKIT_ASSERT_NOT_REACHED(); }
     81 
     82 protected:
     83     WebIDBDatabase() { }
     84 };
     85 
     86 } // namespace WebKit
     87 
     88 #endif // WebIDBDatabase_h
     89