Mercurial > hg > orthanc
annotate OrthancFramework/Sources/SQLite/Statement.h @ 5158:02cfd23a556a
CppCheck
author | Alain Mazy <am@osimis.io> |
---|---|
date | Thu, 02 Feb 2023 10:33:15 +0100 |
parents | 43e613a7756b |
children | 0ea402b4d901 |
rev | line source |
---|---|
0 | 1 /** |
59 | 2 * Orthanc - A Lightweight, RESTful DICOM Store |
1220
9b9026560a5f
SQLite wrapper is now fully independent of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
724
diff
changeset
|
3 * |
3063 | 4 * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@orthanc-labs.com>, |
1220
9b9026560a5f
SQLite wrapper is now fully independent of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
724
diff
changeset
|
5 * Medical Physics Department, CHU of Liege, Belgium |
4870
43e613a7756b
upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4831
diff
changeset
|
6 * Copyright (C) 2017-2022 Osimis S.A., Belgium |
43e613a7756b
upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4831
diff
changeset
|
7 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
0 | 8 * |
17 | 9 * Copyright (c) 2012 The Chromium Authors. All rights reserved. |
10 * | |
11 * Redistribution and use in source and binary forms, with or without | |
12 * modification, are permitted provided that the following conditions are | |
13 * met: | |
0 | 14 * |
17 | 15 * * Redistributions of source code must retain the above copyright |
16 * notice, this list of conditions and the following disclaimer. | |
17 * * Redistributions in binary form must reproduce the above | |
18 * copyright notice, this list of conditions and the following disclaimer | |
19 * in the documentation and/or other materials provided with the | |
20 * distribution. | |
21 * * Neither the name of Google Inc., the name of the CHU of Liege, | |
22 * nor the names of its contributors may be used to endorse or promote | |
23 * products derived from this software without specific prior written | |
24 * permission. | |
25 * | |
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
27 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
28 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
29 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
30 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
31 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
36 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
0 | 37 **/ |
38 | |
39 | |
40 #pragma once | |
41 | |
1221
2255e66da726
getting rid of the dependency against Boost in the SQLite C++ wrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1220
diff
changeset
|
42 #include "NonCopyable.h" |
1220
9b9026560a5f
SQLite wrapper is now fully independent of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
724
diff
changeset
|
43 #include "OrthancSQLiteException.h" |
0 | 44 #include "StatementId.h" |
45 #include "StatementReference.h" | |
46 | |
47 #include <vector> | |
48 #include <stdint.h> | |
265 | 49 |
50 #if ORTHANC_BUILD_UNIT_TESTS == 1 | |
2388
50cde8246542
CMake to build the Orthanc framework without the Orthanc server
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2302
diff
changeset
|
51 # include <gtest/gtest_prod.h> |
265 | 52 #endif |
0 | 53 |
54 | |
59 | 55 namespace Orthanc |
0 | 56 { |
57 namespace SQLite | |
58 { | |
59 class Connection; | |
60 | |
61 // Possible return values from ColumnType in a statement. These | |
62 // should match the values in sqlite3.h. | |
63 enum ColumnType | |
64 { | |
65 COLUMN_TYPE_INTEGER = 1, | |
66 COLUMN_TYPE_FLOAT = 2, | |
67 COLUMN_TYPE_TEXT = 3, | |
68 COLUMN_TYPE_BLOB = 4, | |
69 COLUMN_TYPE_NULL = 5 | |
70 }; | |
71 | |
3992
f9863630ec7f
working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3063
diff
changeset
|
72 class ORTHANC_PUBLIC Statement : public NonCopyable |
0 | 73 { |
74 friend class Connection; | |
265 | 75 |
76 #if ORTHANC_BUILD_UNIT_TESTS == 1 | |
138 | 77 FRIEND_TEST(SQLStatementTest, Run); |
78 FRIEND_TEST(SQLStatementTest, Reset); | |
265 | 79 #endif |
0 | 80 |
81 private: | |
82 StatementReference reference_; | |
83 | |
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
84 int CheckError(int err, |
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
85 ErrorCode code) const; |
0 | 86 |
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
87 void CheckOk(int err, |
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
88 ErrorCode code) const; |
0 | 89 |
90 struct sqlite3_stmt* GetStatement() const | |
91 { | |
92 return reference_.GetWrappedObject(); | |
93 } | |
94 | |
95 public: | |
96 Statement(Connection& database, | |
97 const std::string& sql); | |
98 | |
99 Statement(Connection& database, | |
100 const StatementId& id, | |
101 const std::string& sql); | |
102 | |
103 Statement(Connection& database, | |
104 const char* sql); | |
105 | |
106 Statement(Connection& database, | |
107 const StatementId& id, | |
108 const char* sql); | |
109 | |
4304 | 110 ~Statement(); |
137
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
80
diff
changeset
|
111 |
0 | 112 bool Run(); |
113 | |
114 bool Step(); | |
115 | |
116 // Diagnostics -------------------------------------------------------------- | |
117 | |
118 std::string GetOriginalSQLStatement(); | |
119 | |
120 | |
121 // Binding ------------------------------------------------------------------- | |
122 | |
123 // These all take a 0-based argument index | |
124 void BindNull(int col); | |
125 void BindBool(int col, bool val); | |
126 void BindInt(int col, int val); | |
127 void BindInt64(int col, int64_t val); | |
128 void BindDouble(int col, double val); | |
129 void BindCString(int col, const char* val); | |
130 void BindString(int col, const std::string& val); | |
131 //void BindString16(int col, const string16& value); | |
132 void BindBlob(int col, const void* value, int value_len); | |
133 | |
134 | |
135 // Retrieving ---------------------------------------------------------------- | |
136 | |
137 // Returns the number of output columns in the result. | |
138 int ColumnCount() const; | |
139 | |
140 // Returns the type associated with the given column. | |
141 // | |
142 // Watch out: the type may be undefined if you've done something to cause a | |
143 // "type conversion." This means requesting the value of a column of a type | |
144 // where that type is not the native type. For safety, call ColumnType only | |
145 // on a column before getting the value out in any way. | |
146 ColumnType GetColumnType(int col) const; | |
147 ColumnType GetDeclaredColumnType(int col) const; | |
148 | |
149 // These all take a 0-based argument index. | |
80 | 150 bool ColumnIsNull(int col) const ; |
0 | 151 bool ColumnBool(int col) const; |
152 int ColumnInt(int col) const; | |
153 int64_t ColumnInt64(int col) const; | |
154 double ColumnDouble(int col) const; | |
155 std::string ColumnString(int col) const; | |
156 //string16 ColumnString16(int col) const; | |
157 | |
158 // When reading a blob, you can get a raw pointer to the underlying data, | |
159 // along with the length, or you can just ask us to copy the blob into a | |
160 // vector. Danger! ColumnBlob may return NULL if there is no data! | |
161 int ColumnByteLength(int col) const; | |
162 const void* ColumnBlob(int col) const; | |
163 bool ColumnBlobAsString(int col, std::string* blob); | |
164 //bool ColumnBlobAsString16(int col, string16* val) const; | |
724 | 165 //bool ColumnBlobAsVector(int col, std::vector<char>* val) const; |
166 //bool ColumnBlobAsVector(int col, std::vector<unsigned char>* val) const; | |
0 | 167 |
724 | 168 // Resets the statement to its initial condition. This includes any current |
169 // result row, and also the bound variables if the |clear_bound_vars| is true. | |
170 void Reset(bool clear_bound_vars = true); | |
0 | 171 }; |
172 } | |
173 } |