src/third_party/WebKit/Source/modules/webdatabase/SQLTransaction.h

   1 /*
   2  * Copyright (C) 2007, 2013 Apple 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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef SQLTransaction_h
  30 #define SQLTransaction_h
  31
  32 #include "bindings/v8/ScriptWrappable.h"
  33 #include "heap/Handle.h"
  34 #include "modules/webdatabase/AbstractSQLTransaction.h"
  35 #include "modules/webdatabase/SQLCallbackWrapper.h"
  36 #include "modules/webdatabase/SQLStatement.h"
  37 #include "modules/webdatabase/SQLTransactionStateMachine.h"
  38 #include "wtf/PassRefPtr.h"
  39 #include "wtf/RefPtr.h"
  40
  41 namespace WebCore {
  42
  43 class AbstractSQLTransactionBackend;
  44 class Database;
  45 class ExceptionState;
  46 class SQLErrorData;
  47 class SQLStatementCallback;
  48 class SQLStatementErrorCallback;
  49 class SQLTransactionCallback;
  50 class SQLTransactionErrorCallback;
  51 class SQLValue;
  52 class VoidCallback;
  53
  54 class SQLTransaction FINAL : public AbstractSQLTransaction, public SQLTransactionStateMachine<SQLTransaction>, public ScriptWrappable {
  55 public:
  56     static PassRefPtrWillBeRawPtr<SQLTransaction> create(Database*, PassOwnPtr<SQLTransactionCallback>,
  57         PassOwnPtr<VoidCallback> successCallback, PassOwnPtr<SQLTransactionErrorCallback>,
  58         bool readOnly);
  59     virtual void trace(Visitor*) OVERRIDE;
  60
  61     void performPendingCallback();
  62
  63     void executeSQL(const String& sqlStatement, const Vector<SQLValue>& arguments,
  64         PassOwnPtr<SQLStatementCallback>, PassOwnPtr<SQLStatementErrorCallback>, ExceptionState&);
  65
  66     Database* database() { return m_database.get(); }
  67
  68     PassOwnPtr<SQLTransactionErrorCallback> releaseErrorCallback();
  69
  70 private:
  71     SQLTransaction(Database*, PassOwnPtr<SQLTransactionCallback>,
  72         PassOwnPtr<VoidCallback> successCallback, PassOwnPtr<SQLTransactionErrorCallback>,
  73         bool readOnly);
  74
  75     void clearCallbackWrappers();
  76
  77     // APIs called from the backend published via AbstractSQLTransaction:
  78     virtual void requestTransitToState(SQLTransactionState) OVERRIDE;
  79     virtual bool hasCallback() const OVERRIDE;
  80     virtual bool hasSuccessCallback() const OVERRIDE;
  81     virtual bool hasErrorCallback() const OVERRIDE;
  82     virtual void setBackend(AbstractSQLTransactionBackend*) OVERRIDE;
  83
  84     // State Machine functions:
  85     virtual StateFunction stateFunctionFor(SQLTransactionState) OVERRIDE;
  86     bool computeNextStateAndCleanupIfNeeded();
  87
  88     // State functions:
  89     SQLTransactionState deliverTransactionCallback();
  90     SQLTransactionState deliverTransactionErrorCallback();
  91     SQLTransactionState deliverStatementCallback();
  92     SQLTransactionState deliverQuotaIncreaseCallback();
  93     SQLTransactionState deliverSuccessCallback();
  94
  95     SQLTransactionState unreachableState();
  96     SQLTransactionState sendToBackendState();
  97
  98     SQLTransactionState nextStateForTransactionError();
  99
 100     RefPtrWillBeMember<Database> m_database;
 101     RefPtrWillBeMember<AbstractSQLTransactionBackend> m_backend;
 102     SQLCallbackWrapper<SQLTransactionCallback> m_callbackWrapper;
 103     SQLCallbackWrapper<VoidCallback> m_successCallbackWrapper;
 104     SQLCallbackWrapper<SQLTransactionErrorCallback> m_errorCallbackWrapper;
 105
 106     bool m_executeSqlAllowed;
 107     OwnPtr<SQLErrorData> m_transactionError;
 108
 109     bool m_readOnly;
 110 };
 111
 112 } // namespace WebCore
 113
 114 #endif // SQLTransaction_h