bzr branch
http://bzr.ed.am/sqlite3cc
2
by edam
- further initial development |
1 |
/* |
2 |
* row.h |
|
3 |
* |
|
22
by edam
updated email and web addresses |
4 |
* Copyright (C) 2009 Tim Marston <tim@ed.am> |
2
by edam
- further initial development |
5 |
* |
6 |
* This file is part of sqlite3cc (hereafter referred to as "this program"). |
|
22
by edam
updated email and web addresses |
7 |
* See http://ed.am/dev/sqlite3cc for more information. |
8 |
* |
|
9 |
* This program is free software: you can redistribute it and/or modify it under |
|
10 |
* the terms of the GNU Lesser General Public License as published by the Free |
|
11 |
* Software Foundation, either version 3 of the License, or (at your option) any |
|
12 |
* later version. |
|
13 |
* |
|
14 |
* This program is distributed in the hope that it will be useful, but WITHOUT |
|
15 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
|
16 |
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more |
|
17 |
* details. |
|
2
by edam
- further initial development |
18 |
* |
19 |
* You should have received a copy of the GNU Lesser General Public License |
|
20 |
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
21 |
*/ |
|
22 |
||
23 |
#ifndef SQLITE3CC_ROW_H_ |
|
24 |
#define SQLITE3CC_ROW_H_ |
|
25 |
||
26 |
||
27 |
#include <sqlite3.h> |
|
28 |
#include <boost/utility.hpp> |
|
29 |
#include <boost/lexical_cast.hpp> |
|
30 |
#include <boost/utility/value_init.hpp> |
|
31 |
#include <cassert> |
|
32 |
#include <iostream> |
|
33 |
||
34 |
||
35 |
namespace sqlite |
|
36 |
{ |
|
37 |
||
38 |
||
9
by edam
- added NEWS |
39 |
class query; |
12
by edam
- moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace |
40 |
namespace detail { |
41 |
struct null_t; |
|
42 |
struct set_index_t; |
|
43 |
} |
|
2
by edam
- further initial development |
44 |
|
45 |
||
46 |
/** |
|
47 |
* A result row from a query. |
|
48 |
* |
|
49 |
* The row is only valid until the next call to step() or reset() on the parent |
|
22
by edam
updated email and web addresses |
50 |
* query object, or until the parent query object is destructed. This may |
51 |
* change in future versions. |
|
2
by edam
- further initial development |
52 |
*/ |
53 |
class row |
|
54 |
{ |
|
55 |
//______________________________________________________________________________ |
|
56 |
// instantiation |
|
57 |
protected: |
|
58 |
||
9
by edam
- added NEWS |
59 |
friend class query; |
60 |
||
2
by edam
- further initial development |
61 |
/** |
9
by edam
- added NEWS |
62 |
* Constructor that produces a valid row. |
22
by edam
updated email and web addresses |
63 |
* |
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
64 |
* @param handle of the statement (query) that created this row |
65 |
* @oaram row_number the index of this row |
|
2
by edam
- further initial development |
66 |
*/ |
67 |
explicit row( |
|
9
by edam
- added NEWS |
68 |
sqlite3_stmt *handle, |
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
69 |
unsigned long long row_number ); |
9
by edam
- added NEWS |
70 |
|
71 |
/** |
|
72 |
* Constructor that produces an invalid row. |
|
73 |
*/ |
|
74 |
explicit row(); |
|
2
by edam
- further initial development |
75 |
|
76 |
//______________________________________________________________________________ |
|
77 |
// public interface |
|
78 |
public: |
|
79 |
||
80 |
/** |
|
22
by edam
updated email and web addresses |
81 |
* Determine if this row is valid or not. If it is not valid, there are no |
2
by edam
- further initial development |
82 |
* more rows in the results of the query. |
83 |
*/ |
|
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
84 |
operator bool() const; |
9
by edam
- added NEWS |
85 |
|
86 |
/** |
|
22
by edam
updated email and web addresses |
87 |
* Get the index in to the results that is this row. |
88 |
* |
|
9
by edam
- added NEWS |
89 |
* @return index |
90 |
*/ |
|
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
91 |
inline unsigned long long row_number() |
9
by edam
- added NEWS |
92 |
{ |
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
93 |
return _row_number; |
2
by edam
- further initial development |
94 |
} |
95 |
||
96 |
/** |
|
97 |
* Ascertain a column's type. |
|
22
by edam
updated email and web addresses |
98 |
* |
2
by edam
- further initial development |
99 |
* @param index column index |
100 |
* @return sqlite datatype code |
|
101 |
* @see sqlite3_column_type() |
|
102 |
*/ |
|
103 |
int column_type( |
|
104 |
unsigned int index ); |
|
105 |
||
106 |
/** |
|
22
by edam
updated email and web addresses |
107 |
* Get the number of bytes in the result for a given column. |
108 |
* |
|
2
by edam
- further initial development |
109 |
* @param index column index |
110 |
* @return number of bytes in result |
|
111 |
* @see sqlite3_column_bytes() |
|
112 |
*/ |
|
113 |
unsigned int column_bytes( |
|
114 |
unsigned int index ); |
|
115 |
||
116 |
/** |
|
9
by edam
- added NEWS |
117 |
* Get a value from the row. |
22
by edam
updated email and web addresses |
118 |
* |
2
by edam
- further initial development |
119 |
* @param index column index |
120 |
* @param value reference to object to set with the value |
|
121 |
* @see sqlite3_column_*() |
|
122 |
*/ |
|
123 |
template< class T > |
|
124 |
void column( |
|
125 |
unsigned int index, |
|
126 |
T &value ) |
|
127 |
{ |
|
9
by edam
- added NEWS |
128 |
assert( index < |
129 |
static_cast< unsigned int >( sqlite3_column_count( _handle ) ) ); |
|
2
by edam
- further initial development |
130 |
const char *text = reinterpret_cast< const char * >( |
9
by edam
- added NEWS |
131 |
sqlite3_column_text( _handle, index ) ); |
2
by edam
- further initial development |
132 |
if( text ) |
133 |
value = boost::lexical_cast< T >( text ); |
|
134 |
else |
|
135 |
value = boost::get( boost::value_initialized< T >() ); |
|
136 |
} |
|
137 |
||
138 |
/** |
|
9
by edam
- added NEWS |
139 |
* Get a value from the row and return it. |
22
by edam
updated email and web addresses |
140 |
* |
9
by edam
- added NEWS |
141 |
* @param index column index |
142 |
* @return the value |
|
143 |
* @see sqlite3_column_*() |
|
144 |
*/ |
|
145 |
template< class T > |
|
146 |
T column( |
|
147 |
unsigned int index ) |
|
148 |
{ |
|
149 |
T value; |
|
150 |
column( index, value ); |
|
151 |
return value; |
|
152 |
} |
|
153 |
||
154 |
/** |
|
2
by edam
- further initial development |
155 |
* Stream operator is used to obtain values from a result row, fetching from |
22
by edam
updated email and web addresses |
156 |
* each column in turn. In addition, the null and set_index() auto-column- |
2
by edam
- further initial development |
157 |
* getting manipulators can be used. |
22
by edam
updated email and web addresses |
158 |
* |
2
by edam
- further initial development |
159 |
* @param value is a variable to store the retrieved data in |
160 |
*/ |
|
161 |
template< class T > |
|
162 |
row &operator >>( |
|
163 |
T &value ) |
|
164 |
{ |
|
165 |
column( _column_index, value ); |
|
166 |
_column_index++; |
|
167 |
return *this; |
|
168 |
} |
|
169 |
||
170 |
/** |
|
171 |
* Stream operator for use with set_index(). |
|
172 |
*/ |
|
173 |
row &operator >>( |
|
12
by edam
- moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace |
174 |
detail::set_index_t t ); |
2
by edam
- further initial development |
175 |
|
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
176 |
/** |
22
by edam
updated email and web addresses |
177 |
* Test to see if two rows are the same. |
178 |
* |
|
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
179 |
* @param other the row to compare this one to |
180 |
* @return true if they are |
|
181 |
*/ |
|
182 |
bool operator ==( |
|
183 |
const row &other ) |
|
184 |
const; |
|
185 |
||
2
by edam
- further initial development |
186 |
//______________________________________________________________________________ |
187 |
// implementation |
|
188 |
protected: |
|
189 |
||
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
190 |
/** the query's handle, or NULL */ |
9
by edam
- added NEWS |
191 |
sqlite3_stmt *_handle; |
2
by edam
- further initial development |
192 |
|
193 |
private: |
|
194 |
||
195 |
/** index used when auto-column-getting */ |
|
196 |
unsigned int _column_index; |
|
197 |
||
10
by edam
- cleaned up test-main |
198 |
/** the index of this row */ |
16
by edam
- renamed database to connection to better identify what it is (would database_connection be better though?) |
199 |
unsigned long long _row_number; |
2
by edam
- further initial development |
200 |
|
201 |
}; |
|
202 |
||
203 |
||
204 |
// template specialisations |
|
205 |
template< > |
|
12
by edam
- moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace |
206 |
row &row::operator >> < detail::null_t >( |
207 |
detail::null_t & ); |
|
2
by edam
- further initial development |
208 |
|
209 |
||
9
by edam
- added NEWS |
210 |
} // namespace sqlite |
2
by edam
- further initial development |
211 |
|
212 |
||
213 |
#endif /* SQLITE3CC_ROW_H_ */ |