aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/sqlite/Util.hxx
blob: 151eac6c27d7e70ad0f3cca9f51ef7553a736eed (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
 * Copyright (C) 2003-2015 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPD_SQLITE_UTIL_HXX
#define MPD_SQLITE_UTIL_HXX

#include "Domain.hxx"
#include "util/Error.hxx"

#include <sqlite3.h>

#include <assert.h>

static void
SetError(Error &error, sqlite3 *db, int code, const char *msg)
{
	error.Format(sqlite_domain, code, "%s: %s",
		     msg, sqlite3_errmsg(db));
}

static void
SetError(Error &error, sqlite3_stmt *stmt, int code, const char *msg)
{
	SetError(error, sqlite3_db_handle(stmt), code, msg);
}

static bool
Bind(sqlite3_stmt *stmt, unsigned i, const char *value, Error &error)
{
	int result = sqlite3_bind_text(stmt, i, value, -1, nullptr);
	if (result != SQLITE_OK) {
		SetError(error, stmt, result, "sqlite3_bind_text() failed");
		return false;
	}

	return true;
}

template<typename... Args>
static bool
BindAll2(gcc_unused Error &error, gcc_unused sqlite3_stmt *stmt,
	 gcc_unused unsigned i)
{
	assert(int(i - 1) == sqlite3_bind_parameter_count(stmt));

	return true;
}

template<typename... Args>
static bool
BindAll2(Error &error, sqlite3_stmt *stmt, unsigned i,
	 const char *value, Args&&... args)
{
	return Bind(stmt, i, value, error) &&
		BindAll2(error, stmt, i + 1, std::forward<Args>(args)...);
}

template<typename... Args>
static bool
BindAll(Error &error, sqlite3_stmt *stmt, Args&&... args)
{
	assert(int(sizeof...(args)) == sqlite3_bind_parameter_count(stmt));

	return BindAll2(error, stmt, 1, std::forward<Args>(args)...);
}

/**
 * Wrapper for BindAll() that returns the specified sqlite3_stmt* on
 * success and nullptr on error.
 */
template<typename... Args>
static sqlite3_stmt *
BindAllOrNull(Error &error, sqlite3_stmt *stmt, Args&&... args)
{
	return BindAll(error, stmt, std::forward<Args>(args)...)
		? stmt
		: nullptr;
}

/**
 * Call sqlite3_stmt() repepatedly until something other than
 * SQLITE_BUSY is returned.
 */
static int
ExecuteBusy(sqlite3_stmt *stmt)
{
	int result;
	do {
		result = sqlite3_step(stmt);
	} while (result == SQLITE_BUSY);

	return result;
}

/**
 * Wrapper for ExecuteBusy() that returns true on SQLITE_ROW.
 */
static bool
ExecuteRow(sqlite3_stmt *stmt, Error &error)
{
	int result = ExecuteBusy(stmt);
	if (result == SQLITE_ROW)
		return true;

	if (result != SQLITE_DONE)
		SetError(error, stmt, result, "sqlite3_step() failed");

	return false;
}

/**
 * Wrapper for ExecuteBusy() that interprets everything other than
 * SQLITE_DONE as error.
 */
static bool
ExecuteCommand(sqlite3_stmt *stmt, Error &error)
{
	int result = ExecuteBusy(stmt);
	if (result != SQLITE_DONE) {
		SetError(error, stmt, result, "sqlite3_step() failed");
		return false;
	}

	return true;
}

/**
 * Wrapper for ExecuteCommand() that returns the number of rows
 * modified via sqlite3_changes().  Returns -1 on error.
 */
static inline int
ExecuteChanges(sqlite3_stmt *stmt, Error &error)
{
	if (!ExecuteCommand(stmt, error))
		return -1;

	return sqlite3_changes(sqlite3_db_handle(stmt));
}

/**
 * Wrapper for ExecuteChanges() that returns true if at least one row
 * was modified.  Returns false if nothing was modified or if an error
 * occurred.
 */
static inline bool
ExecuteModified(sqlite3_stmt *stmt, Error &error)
{
	return ExecuteChanges(stmt, error) > 0;
}

template<typename F>
static inline bool
ExecuteForEach(sqlite3_stmt *stmt, Error &error, F &&f)
{
	while (true) {
		int result = ExecuteBusy(stmt);
		switch (result) {
		case SQLITE_ROW:
			f();
			break;

		case SQLITE_DONE:
			return true;

		default:
			SetError(error, stmt, result, "sqlite3_step() failed");
			return false;
		}
	}
}

#endif