/sqlite3cc

To get this branch, use:
bzr branch http://bzr.ed.am/sqlite3cc
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
/*
 * row.h
 *
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
 *
 * This file is part of sqlite3cc (hereafter referred to as "this program").
 * See http://www.waxworlds.org/edam/software/sqlite3cc for more information.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SQLITE3CC_ROW_H_
#define SQLITE3CC_ROW_H_


#include <sqlite3cc/query.h>
#include <sqlite3.h>
#include <boost/utility.hpp>
#include <boost/lexical_cast.hpp>
#include <boost/utility/value_init.hpp>
#include <cassert>
#include <iostream>


namespace sqlite
{


struct _null_t;
struct _set_index_t;


/**
 * A result row from a query.
 *
 * The row is only valid until the next call to step() or reset() on the parent
 * query object, or until the parent query object is destructed. This may change
 * in future versions.
 */
class row
{
//______________________________________________________________________________
//                                                                 instantiation
protected:

	/**
	 * Constructor that provides the database that we were extracted from.
	 * @param the query that this row belongs to
	 * @oaram true if this row represents there being no more rows
	 */
	explicit row(
		query &query,
		bool valid = true );

//______________________________________________________________________________
//                                                              public interface
public:

	/**
	 * Determine if this row is valid or not. If it is not valid, there are no
	 * more rows in the results of the query.
	 */
	inline operator bool()
	{
		return _valid;
	}

	/**
	 * Ascertain a column's type.
	 * @param index column index
	 * @return sqlite datatype code
	 * @see sqlite3_column_type()
	 */
	int column_type(
		unsigned int index );

	/**
	 * get the number of bytes in the result for a given column.
	 * @param index column index
	 * @return number of bytes in result
	 * @see sqlite3_column_bytes()
	 */
	unsigned int column_bytes(
		unsigned int index );

	/**
	 * Get a value from the row
	 * @param index column index
	 * @param value reference to object to set with the value
	 * @see sqlite3_column_*()
	 */
	template< class T >
	void column(
		unsigned int index,
		T &value )
	{
		assert( index < _query.column_count() );
		const char *text = reinterpret_cast< const char * >(
			sqlite3_column_text( _query._handle, index ) );
		if( text )
			value = boost::lexical_cast< T >( text );
		else
			value = boost::get( boost::value_initialized< T >() );
	}

	/**
	 * Stream operator is used to obtain values from a result row, fetching from
	 * each column in turn. In addition, the null and set_index() auto-column-
	 * getting manipulators can be used.
	 * @param value is a variable to store the retrieved data in
	 */
	template< class T >
	row &operator >>(
		T &value )
	{
		column( _column_index, value );
		_column_index++;
		return *this;
	}

	/**
	 * Stream operator for use with set_index().
	 */
	row &operator >>(
		_set_index_t t );

	/**
	 * Check of this row is valid
	 * @return true if it is
	 */
	operator bool() const
	{
		return _valid;
	}

//______________________________________________________________________________
//                                                                implementation
protected:

	friend class query;

	/** the parent query */
	query &_query;

private:

	/** index used when auto-column-getting */
	unsigned int _column_index;

	/** is this row valid? */
	bool _valid;

};


// template specialisations
template< >
row &row::operator >> < _null_t >(
	_null_t & );


} // namespace row


#endif /* SQLITE3CC_ROW_H_ */