/sqlite3cc

To get this branch, use:
bzr branch http://bzr.ed.am/sqlite3cc

« back to all changes in this revision

Viewing changes to include/sqlite3cc/row.h

  • Committer: edam
  • Date: 2010-07-23 09:17:03 UTC
  • Revision ID: edam@waxworlds.org-20100723091703-3siqjj6eeux9hupz
- added NEWS
- added library checks to configure.ac
- added query::iterators
- remove dependency that rows have on querys (since querys have to be dependent on rows for boost::iterator_facade to work)
- rows now have the handle to the sqlite3 statement and know a count of their row number
- added convenience function tht can be used to detect presence of sqlite3cc in other packages
- updated test-main
- renamed all subdir.mk files to emake.mk

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/row.h
 
1
/*
 
2
 * row.h
 
3
 *
 
4
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
 
5
 *
 
6
 * This file is part of sqlite3cc (hereafter referred to as "this program").
 
7
 * See http://www.waxworlds.org/edam/software/sqlite3cc for more information.
 
8
 *
 
9
 * This program is free software: you can redistribute it and/or modify
 
10
 * it under the terms of the GNU Lesser General Public License as published
 
11
 * by the Free Software Foundation, either version 3 of the License, or
 
12
 * (at your option) any later version.
 
13
 *
 
14
 * This program is distributed in the hope that it will be useful,
 
15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
 * GNU Lesser General Public License for more details.
 
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
 
 
39
struct _null_t;
 
40
struct _set_index_t;
 
41
class query;
 
42
 
 
43
 
 
44
/**
 
45
 * A result row from a query.
 
46
 *
 
47
 * The row is only valid until the next call to step() or reset() on the parent
 
48
 * query object, or until the parent query object is destructed. This may change
 
49
 * in future versions.
 
50
 */
 
51
class row
 
52
{
 
53
//______________________________________________________________________________
 
54
//                                                                 instantiation
 
55
protected:
 
56
 
 
57
        friend class query;
 
58
 
 
59
        /**
 
60
         * Constructor that produces a valid row.
 
61
         * @param the handle of the statement (query) that created this row
 
62
         * @oaram the result index that is this row
 
63
         */
 
64
        explicit row(
 
65
                sqlite3_stmt *handle,
 
66
                unsigned long long index );
 
67
 
 
68
        /**
 
69
         * Constructor that produces an invalid row.
 
70
         * @param the handle of the statement (query) that created this row
 
71
         */
 
72
        explicit row();
 
73
 
 
74
//______________________________________________________________________________
 
75
//                                                              public interface
 
76
public:
 
77
 
 
78
        /**
 
79
         * Determine if this row is valid or not. If it is not valid, there are no
 
80
         * more rows in the results of the query.
 
81
         */
 
82
        inline operator bool() const
 
83
        {
 
84
                return _index != std::numeric_limits< unsigned long long >::max();
 
85
        }
 
86
 
 
87
        /**
 
88
         * get the index in to the results that is this row
 
89
         * @return index
 
90
         */
 
91
        inline unsigned long long index()
 
92
        {
 
93
                return _index;
 
94
        }
 
95
 
 
96
        /**
 
97
         * Ascertain a column's type.
 
98
         * @param index column index
 
99
         * @return sqlite datatype code
 
100
         * @see sqlite3_column_type()
 
101
         */
 
102
        int column_type(
 
103
                unsigned int index );
 
104
 
 
105
        /**
 
106
         * get the number of bytes in the result for a given column.
 
107
         * @param index column index
 
108
         * @return number of bytes in result
 
109
         * @see sqlite3_column_bytes()
 
110
         */
 
111
        unsigned int column_bytes(
 
112
                unsigned int index );
 
113
 
 
114
        /**
 
115
         * Get a value from the row.
 
116
         * @param index column index
 
117
         * @param value reference to object to set with the value
 
118
         * @see sqlite3_column_*()
 
119
         */
 
120
        template< class T >
 
121
        void column(
 
122
                unsigned int index,
 
123
                T &value )
 
124
        {
 
125
                assert( index <
 
126
                        static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
 
127
                const char *text = reinterpret_cast< const char * >(
 
128
                        sqlite3_column_text( _handle, index ) );
 
129
                if( text )
 
130
                        value = boost::lexical_cast< T >( text );
 
131
                else
 
132
                        value = boost::get( boost::value_initialized< T >() );
 
133
        }
 
134
 
 
135
        /**
 
136
         * Get a value from the row and return it.
 
137
         * @param index column index
 
138
         * @return the value
 
139
         * @see sqlite3_column_*()
 
140
         */
 
141
        template< class T >
 
142
        T column(
 
143
                unsigned int index )
 
144
        {
 
145
                T value;
 
146
                column( index, value );
 
147
                return value;
 
148
        }
 
149
 
 
150
        /**
 
151
         * Stream operator is used to obtain values from a result row, fetching from
 
152
         * each column in turn. In addition, the null and set_index() auto-column-
 
153
         * getting manipulators can be used.
 
154
         * @param value is a variable to store the retrieved data in
 
155
         */
 
156
        template< class T >
 
157
        row &operator >>(
 
158
                T &value )
 
159
        {
 
160
                column( _column_index, value );
 
161
                _column_index++;
 
162
                return *this;
 
163
        }
 
164
 
 
165
        /**
 
166
         * Stream operator for use with set_index().
 
167
         */
 
168
        row &operator >>(
 
169
                _set_index_t t );
 
170
 
 
171
//______________________________________________________________________________
 
172
//                                                                implementation
 
173
protected:
 
174
 
 
175
        /** the query's handle */
 
176
        sqlite3_stmt *_handle;
 
177
 
 
178
private:
 
179
 
 
180
        /** index used when auto-column-getting */
 
181
        unsigned int _column_index;
 
182
 
 
183
        /** the index of thi row */
 
184
        unsigned long long _index;
 
185
 
 
186
};
 
187
 
 
188
 
 
189
// template specialisations
 
190
template< >
 
191
row &row::operator >> < _null_t >(
 
192
        _null_t & );
 
193
 
 
194
 
 
195
} // namespace sqlite
 
196
 
 
197
 
 
198
#endif /* SQLITE3CC_ROW_H_ */