WebCore/storage/IDBKey.h

   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 IDBKey_h
  27 #define IDBKey_h
  28
  29 #if ENABLE(INDEXED_DATABASE)
  30
  31 #include "PlatformString.h"
  32 #include <wtf/Forward.h>
  33 #include <wtf/Threading.h>
  34
  35 namespace WebCore {
  36
  37 class SQLiteStatement;
  38
  39 // FIXME: Add dates.
  40 class IDBKey : public ThreadSafeShared<IDBKey> {
  41 public:
  42     static PassRefPtr<IDBKey> create()
  43     {
  44         return adoptRef(new IDBKey());
  45     }
  46     static PassRefPtr<IDBKey> create(int32_t number)
  47     {
  48         return adoptRef(new IDBKey(number));
  49     }
  50     static PassRefPtr<IDBKey> create(const String& string)
  51     {
  52         return adoptRef(new IDBKey(string));
  53     }
  54     ~IDBKey();
  55
  56     // In order of the least to the highest precedent in terms of sort order.
  57     enum Type {
  58         NullType = 0, // FIXME: Phase out support for null keys.
  59         StringType,
  60         NumberType
  61     };
  62
  63     Type type() const { return m_type; }
  64
  65     const String& string() const
  66     {
  67         ASSERT(m_type == StringType);
  68         return m_string;
  69     }
  70
  71     int32_t number() const
  72     {
  73         ASSERT(m_type == NumberType);
  74         return m_number;
  75     }
  76
  77     static PassRefPtr<IDBKey> fromQuery(SQLiteStatement& query, int baseColumn);
  78
  79     bool isEqual(IDBKey* other);
  80     String whereSyntax(String qualifiedTableName = "") const;
  81     String lowerCursorWhereFragment(String comparisonOperator, String qualifiedTableName = "");
  82     String upperCursorWhereFragment(String comparisonOperator, String qualifiedTableName = "");
  83     int bind(SQLiteStatement& query, int column) const;
  84     void bindWithNulls(SQLiteStatement& query, int baseColumn) const;
  85
  86     using ThreadSafeShared<IDBKey>::ref;
  87     using ThreadSafeShared<IDBKey>::deref;
  88
  89 private:
  90     IDBKey();
  91     explicit IDBKey(int32_t);
  92     explicit IDBKey(const String&);
  93
  94     Type m_type;
  95     String m_string;
  96     int32_t m_number;
  97 };
  98
  99 }
 100
 101 #endif // ENABLE(INDEXED_DATABASE)
 102
 103 #endif // IDBKey_h