/*

 * Copyright (C) 2007, 2008 Apple 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.

 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of

 *     its contributors may be used to endorse or promote products derived

 *     from this software without specific prior written permission.

 *

 * 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 DatabaseTask_h

#define DatabaseTask_h

#if ENABLE(DATABASE)

#include "Database.h"

#include "ExceptionCode.h"

#include "PlatformString.h"

#include "SQLTransaction.h"

#include <wtf/OwnPtr.h>

#include <wtf/PassOwnPtr.h>

#include <wtf/PassRefPtr.h>

#include <wtf/Threading.h>

#include <wtf/Vector.h>

namespace WebCore {

// Can be used to wait until DatabaseTask is completed.

// Has to be passed into DatabaseTask::create to be associated with the task.

class DatabaseTaskSynchronizer : public Noncopyable {

public:

    DatabaseTaskSynchronizer();

    // Called from main thread to wait until task is completed.

    void waitForTaskCompletion();

    // Called by the task.

    void taskCompleted();

private:

    bool m_taskCompleted;

    Mutex m_synchronousMutex;

    ThreadCondition m_synchronousCondition;

};

class DatabaseTask : public Noncopyable {

public:

    virtual ~DatabaseTask();

    void performTask();

    Database* database() const { return m_database; }

protected:

    DatabaseTask(Database*, DatabaseTaskSynchronizer*);

private:

    virtual void doPerformTask() = 0;

    Database* m_database;

    DatabaseTaskSynchronizer* m_synchronizer;

#ifndef NDEBUG

     virtual const char* debugTaskName() const = 0;

     bool m_complete;

#endif

};

class Database::DatabaseOpenTask : public DatabaseTask {

public:

    static PassOwnPtr<DatabaseOpenTask> create(Database* db, bool setVersionInNewDatabase, DatabaseTaskSynchronizer* synchronizer, ExceptionCode& code, bool& success)

    {

        return new DatabaseOpenTask(db, setVersionInNewDatabase, synchronizer, code, success);

    }

private:

    DatabaseOpenTask(Database*, bool setVersionInNewDatabase, DatabaseTaskSynchronizer*, ExceptionCode&, bool& success);

    virtual void doPerformTask();

#ifndef NDEBUG

    virtual const char* debugTaskName() const;

#endif

    bool m_setVersionInNewDatabase;

    ExceptionCode& m_code;

    bool& m_success;

};

class Database::DatabaseCloseTask : public DatabaseTask {

public:

    static PassOwnPtr<DatabaseCloseTask> create(Database* db, DatabaseTaskSynchronizer* synchronizer)

    {

        return new DatabaseCloseTask(db, synchronizer);

    }

private:

    DatabaseCloseTask(Database*, DatabaseTaskSynchronizer*);

    virtual void doPerformTask();

#ifndef NDEBUG

    virtual const char* debugTaskName() const;

#endif

};

class Database::DatabaseTransactionTask : public DatabaseTask {

public:

    // Transaction task is never synchronous, so no 'synchronizer' parameter.

    static PassOwnPtr<DatabaseTransactionTask> create(PassRefPtr<SQLTransaction> transaction)

    {

        return new DatabaseTransactionTask(transaction);

    }

    SQLTransaction* transaction() const { return m_transaction.get(); }

private:

    DatabaseTransactionTask(PassRefPtr<SQLTransaction>);

    virtual void doPerformTask();

#ifndef NDEBUG

    virtual const char* debugTaskName() const;

#endif

    RefPtr<SQLTransaction> m_transaction;

};

class Database::DatabaseTableNamesTask : public DatabaseTask {

public:

    static PassOwnPtr<DatabaseTableNamesTask> create(Database* db, DatabaseTaskSynchronizer* synchronizer, Vector<String>& names)

    {

        return new DatabaseTableNamesTask(db, synchronizer, names);

    }

private:

    DatabaseTableNamesTask(Database*, DatabaseTaskSynchronizer*, Vector<String>& names);

    virtual void doPerformTask();

#ifndef NDEBUG

    virtual const char* debugTaskName() const;

#endif

    Vector<String>& m_tableNames;

};

} // namespace WebCore

#endif // ENABLE(DATABASE)

#endif // DatabaseTask_h