d8226b6c28cf261133672d0f4c48977e119d58e3
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / shared / IDBResultData.h
1 /*
2  * Copyright (C) 2015 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IDBResultData_h
27 #define IDBResultData_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBDatabaseInfo.h"
32 #include "IDBError.h"
33 #include "IDBGetResult.h"
34 #include "IDBKeyData.h"
35 #include "IDBResourceIdentifier.h"
36 #include "IDBTransactionInfo.h"
37 #include "ThreadSafeDataBuffer.h"
38
39 namespace WebCore {
40
41 class IDBResourceIdentifier;
42 class ThreadSafeDataBuffer;
43
44 enum class IDBResultType {
45     Error,
46     OpenDatabaseSuccess,
47     OpenDatabaseUpgradeNeeded,
48     CreateObjectStoreSuccess,
49     DeleteObjectStoreSuccess,
50     ClearObjectStoreSuccess,
51     PutOrAddSuccess,
52     GetRecordSuccess,
53     GetCountSuccess,
54     DeleteRecordSuccess,
55     CreateIndexSuccess,
56 };
57
58 namespace IDBServer {
59 class UniqueIDBDatabaseConnection;
60 class UniqueIDBDatabaseTransaction;
61 }
62
63 class IDBResultData {
64 public:
65     static IDBResultData error(const IDBResourceIdentifier&, const IDBError&);
66     static IDBResultData openDatabaseSuccess(const IDBResourceIdentifier&, IDBServer::UniqueIDBDatabaseConnection&);
67     static IDBResultData openDatabaseUpgradeNeeded(const IDBResourceIdentifier&, IDBServer::UniqueIDBDatabaseTransaction&);
68     static IDBResultData createObjectStoreSuccess(const IDBResourceIdentifier&);
69     static IDBResultData deleteObjectStoreSuccess(const IDBResourceIdentifier&);
70     static IDBResultData clearObjectStoreSuccess(const IDBResourceIdentifier&);
71     static IDBResultData createIndexSuccess(const IDBResourceIdentifier&);
72     static IDBResultData putOrAddSuccess(const IDBResourceIdentifier&, const IDBKeyData&);
73     static IDBResultData getRecordSuccess(const IDBResourceIdentifier&, const IDBGetResult&);
74     static IDBResultData getCountSuccess(const IDBResourceIdentifier&, uint64_t count);
75     static IDBResultData deleteRecordSuccess(const IDBResourceIdentifier&);
76
77     IDBResultData(const IDBResultData&);
78
79     IDBResultType type() const { return m_type; }
80     IDBResourceIdentifier requestIdentifier() const { return m_requestIdentifier; }
81
82     const IDBError& error() const { return m_error; }
83     uint64_t databaseConnectionIdentifier() const { return m_databaseConnectionIdentifier; }
84
85     const IDBDatabaseInfo& databaseInfo() const;
86     const IDBTransactionInfo& transactionInfo() const;
87
88     const IDBKeyData* resultKey() const { return m_resultKey.get(); }
89     uint64_t resultInteger() const { return m_resultInteger; }
90
91     const IDBGetResult& getResult() const;
92
93 private:
94     IDBResultData(const IDBResourceIdentifier&);
95     IDBResultData(IDBResultType, const IDBResourceIdentifier&);
96
97     IDBResultType m_type;
98     IDBResourceIdentifier m_requestIdentifier;
99
100     IDBError m_error;
101     uint64_t m_databaseConnectionIdentifier { 0 };
102     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
103     std::unique_ptr<IDBTransactionInfo> m_transactionInfo;
104     std::unique_ptr<IDBKeyData> m_resultKey;
105     std::unique_ptr<IDBGetResult> m_getResult;
106     uint64_t m_resultInteger { 0 };
107 };
108
109 } // namespace WebCore
110
111 #endif // ENABLE(INDEXED_DATABASE)
112 #endif // IDBResultData_h