src/third_party/WebKit/public/platform/WebIDBMetadata.h

   1 /*
   2  * Copyright (C) 2012 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 WebIDBMetadata_h
  27 #define WebIDBMetadata_h
  28
  29 #include "WebCommon.h"
  30 #include "WebIDBKeyPath.h"
  31 #include "WebString.h"
  32 #include "WebVector.h"
  33
  34 namespace WebCore {
  35 struct IDBDatabaseMetadata;
  36 }
  37
  38 namespace blink {
  39
  40 struct WebIDBMetadata {
  41     enum {
  42         NoIntVersion = -1
  43     };
  44     struct Index;
  45     struct ObjectStore;
  46
  47     WebString name;
  48     // FIXME: Both version members need to be present while we support both the
  49     // old setVersion and new upgradeneeded API. Once we no longer support
  50     // setVersion, WebString version can be removed.
  51     WebString version;
  52     long long intVersion;
  53     long long id;
  54     long long maxObjectStoreId;
  55     WebVector<ObjectStore> objectStores;
  56     WebIDBMetadata()
  57         : intVersion(NoIntVersion) { }
  58
  59     struct ObjectStore {
  60         WebString name;
  61         WebIDBKeyPath keyPath;
  62         bool autoIncrement;
  63         long long id;
  64         long long maxIndexId;
  65         WebVector<Index> indexes;
  66         ObjectStore()
  67             : keyPath(WebIDBKeyPath::createNull())
  68             , autoIncrement(false) { }
  69     };
  70
  71     struct Index {
  72         WebString name;
  73         WebIDBKeyPath keyPath;
  74         bool unique;
  75         bool multiEntry;
  76         long long id;
  77         Index()
  78             : keyPath(WebIDBKeyPath::createNull())
  79             , unique(false)
  80             , multiEntry(false) { }
  81     };
  82
  83 #if BLINK_IMPLEMENTATION
  84     WebIDBMetadata(const WebCore::IDBDatabaseMetadata&);
  85     operator WebCore::IDBDatabaseMetadata() const;
  86 #endif
  87 };
  88
  89
  90 } // namespace blink
  91
  92 #endif // WebIDBMetadata_h