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/core/v8/ScriptWrappable.h"
  33 #include "modules/webdatabase/SQLStatement.h"
  34 #include "modules/webdatabase/SQLTransactionStateMachine.h"
  35 #include "platform/heap/Handle.h"
  36
  37 namespace blink {
  38
  39 class Database;
  40 class ExceptionState;
  41 class SQLErrorData;
  42 class SQLStatementCallback;
  43 class SQLStatementErrorCallback;
  44 class SQLTransactionBackend;
  45 class SQLTransactionCallback;
  46 class SQLTransactionErrorCallback;
  47 class SQLValue;
  48 class VoidCallback;
  49
  50 class SQLTransaction final
  51     : public GarbageCollectedFinalized<SQLTransaction>
  52     , public SQLTransactionStateMachine<SQLTransaction>
  53     , public ScriptWrappable {
  54     DEFINE_WRAPPERTYPEINFO();
  55 public:
  56     static SQLTransaction* create(Database*, SQLTransactionCallback*,
  57         VoidCallback* successCallback, SQLTransactionErrorCallback*, bool readOnly);
  58     ~SQLTransaction();
  59     void trace(Visitor*);
  60
  61     void performPendingCallback();
  62
  63     void executeSQL(const String& sqlStatement, const Vector<SQLValue>& arguments,
  64         SQLStatementCallback*, SQLStatementErrorCallback*, ExceptionState&);
  65
  66     Database* database() { return m_database.get(); }
  67
  68     SQLTransactionErrorCallback* releaseErrorCallback();
  69
  70     // APIs called from the backend published:
  71     void requestTransitToState(SQLTransactionState);
  72     bool hasCallback() const;
  73     bool hasSuccessCallback() const;
  74     bool hasErrorCallback() const;
  75     void setBackend(SQLTransactionBackend*);
  76
  77 private:
  78     SQLTransaction(Database*, SQLTransactionCallback*,
  79         VoidCallback* successCallback, SQLTransactionErrorCallback*,
  80         bool readOnly);
  81
  82     void clearCallbacks();
  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     Member<Database> m_database;
 101     Member<SQLTransactionBackend> m_backend;
 102     Member<SQLTransactionCallback> m_callback;
 103     Member<VoidCallback> m_successCallback;
 104     Member<SQLTransactionErrorCallback> m_errorCallback;
 105
 106     bool m_executeSqlAllowed;
 107     OwnPtr<SQLErrorData> m_transactionError;
 108
 109     bool m_readOnly;
 110     int m_asyncOperationId;
 111 };
 112
 113 } // namespace blink
 114
 115 #endif // SQLTransaction_h