GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 59.7% 92 / 0 / 154
Functions: 69.2% 18 / 0 / 26
Branches: 28.3% 65 / 0 / 230

src/utilities/sql/PreparedStatement.hpp
Line Branch Exec Source
1 /***********************************************************************************************************************
2 * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC.
3 * See also https://openstudio.net/license
4 ***********************************************************************************************************************/
5
6 #ifndef UTILITIES_SQL_PREPAREDSTATEMENT_HPP
7 #define UTILITIES_SQL_PREPAREDSTATEMENT_HPP
8
9 #include "../UtilitiesAPI.hpp"
10 #include "../core/String.hpp"
11
12 #include <boost/optional.hpp>
13
14 #include <stdexcept>
15 #include <string>
16 #include <vector>
17
18 struct sqlite3;
19 struct sqlite3_stmt;
20
21 namespace openstudio {
22
23 class UTILITIES_API PreparedStatement
24 {
25 private:
26 sqlite3* m_db;
27 sqlite3_stmt* m_statement;
28 bool m_transaction;
29
30 struct InternalConstructor
31 {
32 };
33
34 // a helper constructor to delegate to. It has the first parameter as
35 // InternalConstructor so it's distinguishable from the on with the defaulted
36 // t_transaction
37 PreparedStatement(InternalConstructor, const std::string& t_stmt, sqlite3* t_db, bool t_transaction);
38
39 public:
40 PreparedStatement& operator=(const PreparedStatement&) = delete;
41 PreparedStatement(const PreparedStatement&) = delete;
42
43 338 PreparedStatement(const std::string& t_stmt, sqlite3* t_db, bool t_transaction = false)
44 338 : PreparedStatement(InternalConstructor{}, t_stmt, t_db, t_transaction) {}
45
46 template <typename... Args>
47 17160 PreparedStatement(const std::string& t_stmt, sqlite3* t_db, bool t_transaction, Args&&... args)
48 17160 : PreparedStatement(InternalConstructor{}, t_stmt, t_db, t_transaction) {
49
16/36
openstudio::PreparedStatement::PreparedStatement<int&, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, int&, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&):
✓ Branch 1 taken 1 time.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 time.
openstudio::PreparedStatement::PreparedStatement<int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double&, double&, double&, double&, double&, double&, double&, int&, double&, double&, double&, double&, double&, double&, double&, double&, double&, double&, int&, int&, double&, double&, double&, double&, bool&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double&, double&, double&, double&, double&, double&, double&, int&, double&, double&, double&, double&, double&, double&, double&, double&, double&, double&, int&, int&, double&, double&, double&, double&, bool&):
✓ Branch 1 taken 1 time.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 time.
openstudio::PreparedStatement::PreparedStatement<int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&, int&, int&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&, int&, int&):
✓ Branch 1 taken 1 time.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 time.
openstudio::PreparedStatement::PreparedStatement<int&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, int&):
✓ Branch 1 taken 4 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 4 times.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✓ Branch 1 taken 17136 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 17136 times.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&):
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&):
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✓ Branch 1 taken 3 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 3 times.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&):
✓ Branch 1 taken 6 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 6 times.
openstudio::PreparedStatement::PreparedStatement<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, sqlite3*, bool, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&):
✓ Branch 1 taken 8 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 8 times.
17160 if (!bindAll(args...)) {
50 ✗ throw std::runtime_error("Error bindings args with statement: " + t_stmt);
51 }
52 17160 }
53
54 ~PreparedStatement();
55
56 bool bind(int position, const std::string& t_str);
57
58 bool bind(int position, int val);
59
60 bool bind(int position, unsigned int val);
61
62 bool bind(int position, double val);
63
64 // Makes no sense
65 bool bind(int position, char val) = delete;
66
67 /** char* to std::string. */
68 264 bool bind(int position, const char* s) {
69
2/2
✓ Branch 1 taken 264 times.
✓ Branch 4 taken 264 times.
264 return bind(position, openstudio::toString(s));
70 }
71
72 /** wstring to std::string. */
73 bool bind(int position, const std::wstring& w) {
74 return bind(position, openstudio::toString(w));
75 }
76
77 /** wchar_t* to std::string. */
78 bool bind(int position, const wchar_t* w) {
79 return bind(position, openstudio::toString(w));
80 }
81
82 // This one would happen automatically, but I would rather be explicit
83 1 bool bind(int position, bool val) {
84 1 return bind(position, static_cast<int>(val));
85 }
86
87 [[nodiscard]] static int get_sqlite3_bind_parameter_count(sqlite3_stmt* statement);
88
89 template <typename... Args>
90 17160 bool bindAll(Args&&... args) {
91 17160 const std::size_t size = sizeof...(Args);
92 17160 int nPlaceholders = get_sqlite3_bind_parameter_count(m_statement);
93
6/18
bool openstudio::PreparedStatement::bindAll<int&, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&>(int&, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&):
✗ Branch 0 not taken.
✓ Branch 1 taken 1 time.
bool openstudio::PreparedStatement::bindAll<int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double&, double&, double&, double&, double&, double&, double&, int&, double&, double&, double&, double&, double&, double&, double&, double&, double&, double&, int&, int&, double&, double&, double&, double&, bool&>(int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double&, double&, double&, double&, double&, double&, double&, int&, double&, double&, double&, double&, double&, double&, double&, double&, double&, double&, int&, int&, double&, double&, double&, double&, bool&):
✗ Branch 0 not taken.
✓ Branch 1 taken 1 time.
bool openstudio::PreparedStatement::bindAll<int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&, int&, int&>(int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&, int&, int&):
✗ Branch 0 not taken.
✓ Branch 1 taken 1 time.
bool openstudio::PreparedStatement::bindAll<int&>(int&):
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✗ Branch 0 not taken.
✓ Branch 1 taken 17136 times.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
17160 if (nPlaceholders != size) {
94 ✗ throw std::runtime_error("Wrong number of placeholders [" + std::to_string(nPlaceholders) + "] versus bindArgs [" + std::to_string(size)
95 + "].");
96 } else {
97 17160 int i = 1;
98 // Call bind(i++, args[i]) until any returns false
99
40/92
bool openstudio::PreparedStatement::bindAll<int&, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&>(int&, int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&):
✓ Branch 1 taken 1 time.
✗ Branch 2 not taken.
✓ Branch 4 taken 1 time.
✗ Branch 5 not taken.
✓ Branch 7 taken 1 time.
✗ Branch 8 not taken.
✓ Branch 10 taken 1 time.
✗ Branch 11 not taken.
bool openstudio::PreparedStatement::bindAll<int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double&, double&, double&, double&, double&, double&, double&, int&, double&, double&, double&, double&, double&, double&, double&, double&, double&, double&, int&, int&, double&, double&, double&, double&, bool&>(int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double&, double&, double&, double&, double&, double&, double&, int&, double&, double&, double&, double&, double&, double&, double&, double&, double&, double&, int&, int&, double&, double&, double&, double&, bool&):
✓ Branch 1 taken 1 time.
✗ Branch 2 not taken.
✓ Branch 4 taken 1 time.
✗ Branch 5 not taken.
✓ Branch 7 taken 1 time.
✗ Branch 8 not taken.
✓ Branch 10 taken 1 time.
✗ Branch 11 not taken.
✓ Branch 13 taken 1 time.
✗ Branch 14 not taken.
✓ Branch 16 taken 1 time.
✗ Branch 17 not taken.
✓ Branch 19 taken 1 time.
✗ Branch 20 not taken.
✓ Branch 22 taken 1 time.
✗ Branch 23 not taken.
✓ Branch 25 taken 1 time.
✗ Branch 26 not taken.
✓ Branch 28 taken 1 time.
✗ Branch 29 not taken.
✓ Branch 31 taken 1 time.
✗ Branch 32 not taken.
✓ Branch 34 taken 1 time.
✗ Branch 35 not taken.
✓ Branch 37 taken 1 time.
✗ Branch 38 not taken.
✓ Branch 40 taken 1 time.
✗ Branch 41 not taken.
✓ Branch 43 taken 1 time.
✗ Branch 44 not taken.
✓ Branch 46 taken 1 time.
✗ Branch 47 not taken.
✓ Branch 49 taken 1 time.
✗ Branch 50 not taken.
✓ Branch 52 taken 1 time.
✗ Branch 53 not taken.
✓ Branch 55 taken 1 time.
✗ Branch 56 not taken.
✓ Branch 58 taken 1 time.
✗ Branch 59 not taken.
✓ Branch 61 taken 1 time.
✗ Branch 62 not taken.
✓ Branch 64 taken 1 time.
✗ Branch 65 not taken.
✓ Branch 67 taken 1 time.
✗ Branch 68 not taken.
✓ Branch 70 taken 1 time.
✗ Branch 71 not taken.
✓ Branch 73 taken 1 time.
✗ Branch 74 not taken.
✓ Branch 76 taken 1 time.
✗ Branch 77 not taken.
✓ Branch 79 taken 1 time.
✗ Branch 80 not taken.
bool openstudio::PreparedStatement::bindAll<int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&, int&, int&>(int&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, int&, int&, int&):
✓ Branch 1 taken 1 time.
✗ Branch 2 not taken.
✓ Branch 4 taken 1 time.
✗ Branch 5 not taken.
✓ Branch 7 taken 1 time.
✗ Branch 8 not taken.
✓ Branch 10 taken 1 time.
✗ Branch 11 not taken.
✓ Branch 13 taken 1 time.
✗ Branch 14 not taken.
✓ Branch 16 taken 1 time.
✗ Branch 17 not taken.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✓ Branch 1 taken 17136 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 17136 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 17136 times.
✗ Branch 8 not taken.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&):
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
bool openstudio::PreparedStatement::bindAll<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&):
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
17160 bool ok = (bind(i++, args) && ...);
100 17160 return ok;
101 }
102 }
103
104 // Executes a **SINGLE** statement
105 8805 void execAndThrowOnError() {
106 8805 int code = execute();
107 // copied in here to avoid including sqlite3 header everywhere
108 8805 constexpr auto SQLITE_DONE = 101;
109
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8805 times.
8805 if (code != SQLITE_DONE) {
110 ✗ throw std::runtime_error("Error executing SQL statement step");
111 }
112 8805 }
113
114 // Executes a **SINGLE** statement
115 int execute();
116
117 [[nodiscard]] boost::optional<double> execAndReturnFirstDouble() const;
118
119 [[nodiscard]] boost::optional<int> execAndReturnFirstInt() const;
120
121 ✗ static std::string columnText(const unsigned char* column) {
122 ✗ return {reinterpret_cast<const char*>(column)};
123 }
124
125 [[nodiscard]] boost::optional<std::string> execAndReturnFirstString() const;
126
127 /// execute a statement and return the results (if any) in a vector of double
128 [[nodiscard]] boost::optional<std::vector<double>> execAndReturnVectorOfDouble() const;
129
130 /// execute a statement and return the results (if any) in a vector of int
131 [[nodiscard]] boost::optional<std::vector<int>> execAndReturnVectorOfInt() const;
132
133 /// execute a statement and return the results (if any) in a vector of string
134 [[nodiscard]] boost::optional<std::vector<std::string>> execAndReturnVectorOfString() const;
135 };
136
137 } // namespace openstudio
138
139 #endif // UTILITIES_SQL_PREPAREDSTATEMENT_HPP
140