/*
 * Copyright (C) 2010 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:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS 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 APPLE OR ITS 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 IDBKey_h
#define IDBKey_h

#include "PlatformString.h"
#include <wtf/Forward.h>

#if ENABLE(INDEXED_DATABASE)

namespace WebCore {

class SQLiteStatement;

// FIXME: Add dates.
class IDBKey : public RefCounted<IDBKey> {
public:
    static PassRefPtr<IDBKey> create()
    {
        return adoptRef(new IDBKey());
    }
    static PassRefPtr<IDBKey> create(int32_t number)
    {
        return adoptRef(new IDBKey(number));
    }
    static PassRefPtr<IDBKey> create(const String& string)
    {
        return adoptRef(new IDBKey(string));
    }
    ~IDBKey();

    // In order of the least to the highest precedent in terms of sort order.
    enum Type {
        NullType = 0,
        StringType,
        NumberType
    };

    Type type() const { return m_type; }

    const String& string() const
    {
        ASSERT(m_type == StringType);
        return m_string;
    }

    int32_t number() const
    {
        ASSERT(m_type == NumberType);
        return m_number;
    }

    static PassRefPtr<IDBKey> fromQuery(SQLiteStatement& query, int baseColumn);

    bool isEqual(IDBKey* other);
    String whereSyntax(String qualifiedTableName = "") const;
    String leftCursorWhereFragment(String comparisonOperator, String qualifiedTableName = "");
    String rightCursorWhereFragment(String comparisonOperator, String qualifiedTableName = "");
    int bind(SQLiteStatement& query, int column) const;
    void bindWithNulls(SQLiteStatement& query, int baseColumn) const;

private:
    IDBKey();
    explicit IDBKey(int32_t);
    explicit IDBKey(const String&);

    Type m_type;
    String m_string;
    int32_t m_number;
};

}

#endif // ENABLE(INDEXED_DATABASE)

#endif // IDBKey_h