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 WebIDBKey_h
     27 #define WebIDBKey_h
     28 
     29 #include "WebCommon.h"
     30 #include "WebPrivatePtr.h"
     31 #include "WebString.h"
     32 
     33 namespace WebCore { class IDBKey; }
     34 
     35 namespace WebKit {
     36 
     37 class WebIDBKeyPath;
     38 class WebSerializedScriptValue;
     39 
     40 class WebIDBKey {
     41 public:
     42     // Please use one of the factory methods. This is public only to allow WebVector.
     43     WebIDBKey() { }
     44     ~WebIDBKey() { reset(); }
     45 
     46     WEBKIT_API static WebIDBKey createNull();
     47     WEBKIT_API static WebIDBKey createString(const WebString&);
     48     WEBKIT_API static WebIDBKey createDate(double);
     49     WEBKIT_API static WebIDBKey createNumber(double);
     50     WEBKIT_API static WebIDBKey createInvalid();
     51     WEBKIT_API static WebIDBKey createFromValueAndKeyPath(const WebSerializedScriptValue&, const WebIDBKeyPath&);
     52     WEBKIT_API static WebSerializedScriptValue injectIDBKeyIntoSerializedValue(const WebIDBKey&, const WebSerializedScriptValue&, const WebIDBKeyPath&);
     53 
     54     WebIDBKey(const WebIDBKey& e) { assign(e); }
     55     WebIDBKey& operator=(const WebIDBKey& e)
     56     {
     57         assign(e);
     58         return *this;
     59     }
     60 
     61     WEBKIT_API void assign(const WebIDBKey&);
     62     WEBKIT_API void assignNull();
     63     WEBKIT_API void assignString(const WebString&);
     64     WEBKIT_API void assignDate(double);
     65     WEBKIT_API void assignNumber(double);
     66     WEBKIT_API void assignInvalid();
     67     WEBKIT_API void reset();
     68 
     69     enum Type {
     70         NullType = 0,
     71         StringType,
     72         DateType,
     73         NumberType,
     74         // Types not in WebCore::IDBKey:
     75         InvalidType
     76     };
     77 
     78     WEBKIT_API Type type() const;
     79     WEBKIT_API WebString string() const; // Only valid for StringType.
     80     WEBKIT_API double date() const; // Only valid for DateType.
     81     WEBKIT_API double number() const; // Only valid for NumberType.
     82 
     83 #if WEBKIT_IMPLEMENTATION
     84     WebIDBKey(const WTF::PassRefPtr<WebCore::IDBKey>&);
     85     WebIDBKey& operator=(const WTF::PassRefPtr<WebCore::IDBKey>&);
     86     operator WTF::PassRefPtr<WebCore::IDBKey>() const;
     87 #endif
     88 
     89 private:
     90     WebPrivatePtr<WebCore::IDBKey> m_private;
     91 };
     92 
     93 } // namespace WebKit
     94 
     95 #endif // WebIDBKey_h
     96