/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-27 15:46:42 UTC
  • Revision ID: edam@waxworlds.org-20100727154642-1uxrjkpxhp7xl6hq
- moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace
- added immediate transation

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
class query;
 
40
namespace detail {
 
41
        struct null_t;
 
42
        struct set_index_t;
 
43
}
 
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
 
50
 * query object, or until the parent query object is destructed. This may change
 
51
 * in future versions.
 
52
 */
 
53
class row
 
54
{
 
55
//______________________________________________________________________________
 
56
//                                                                 instantiation
 
57
protected:
 
58
 
 
59
        friend class query;
 
60
 
 
61
        /**
 
62
         * Constructor that produces a valid row.
 
63
         * @param the handle of the statement (query) that created this row
 
64
         * @oaram the result index that is this row
 
65
         */
 
66
        explicit row(
 
67
                sqlite3_stmt *handle,
 
68
                unsigned long long index );
 
69
 
 
70
        /**
 
71
         * Constructor that produces an invalid row.
 
72
         * @param the handle of the statement (query) that created this row
 
73
         */
 
74
        explicit row();
 
75
 
 
76
//______________________________________________________________________________
 
77
//                                                              public interface
 
78
public:
 
79
 
 
80
        /**
 
81
         * Determine if this row is valid or not. If it is not valid, there are no
 
82
         * more rows in the results of the query.
 
83
         */
 
84
        inline operator bool() const
 
85
        {
 
86
                return _index != std::numeric_limits< unsigned long long >::max();
 
87
        }
 
88
 
 
89
        /**
 
90
         * get the index in to the results that is this row
 
91
         * @return index
 
92
         */
 
93
        inline unsigned long long index()
 
94
        {
 
95
                return _index;
 
96
        }
 
97
 
 
98
        /**
 
99
         * Ascertain a column's type.
 
100
         * @param index column index
 
101
         * @return sqlite datatype code
 
102
         * @see sqlite3_column_type()
 
103
         */
 
104
        int column_type(
 
105
                unsigned int index );
 
106
 
 
107
        /**
 
108
         * get the number of bytes in the result for a given column.
 
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
        /**
 
117
         * Get a value from the row.
 
118
         * @param index column index
 
119
         * @param value reference to object to set with the value
 
120
         * @see sqlite3_column_*()
 
121
         */
 
122
        template< class T >
 
123
        void column(
 
124
                unsigned int index,
 
125
                T &value )
 
126
        {
 
127
                assert( index <
 
128
                        static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
 
129
                const char *text = reinterpret_cast< const char * >(
 
130
                        sqlite3_column_text( _handle, index ) );
 
131
                if( text )
 
132
                        value = boost::lexical_cast< T >( text );
 
133
                else
 
134
                        value = boost::get( boost::value_initialized< T >() );
 
135
        }
 
136
 
 
137
        /**
 
138
         * Get a value from the row and return it.
 
139
         * @param index column index
 
140
         * @return the value
 
141
         * @see sqlite3_column_*()
 
142
         */
 
143
        template< class T >
 
144
        T column(
 
145
                unsigned int index )
 
146
        {
 
147
                T value;
 
148
                column( index, value );
 
149
                return value;
 
150
        }
 
151
 
 
152
        /**
 
153
         * Stream operator is used to obtain values from a result row, fetching from
 
154
         * each column in turn. In addition, the null and set_index() auto-column-
 
155
         * getting manipulators can be used.
 
156
         * @param value is a variable to store the retrieved data in
 
157
         */
 
158
        template< class T >
 
159
        row &operator >>(
 
160
                T &value )
 
161
        {
 
162
                column( _column_index, value );
 
163
                _column_index++;
 
164
                return *this;
 
165
        }
 
166
 
 
167
        /**
 
168
         * Stream operator for use with set_index().
 
169
         */
 
170
        row &operator >>(
 
171
                detail::set_index_t t );
 
172
 
 
173
//______________________________________________________________________________
 
174
//                                                                implementation
 
175
protected:
 
176
 
 
177
        /** the query's handle */
 
178
        sqlite3_stmt *_handle;
 
179
 
 
180
private:
 
181
 
 
182
        /** index used when auto-column-getting */
 
183
        unsigned int _column_index;
 
184
 
 
185
        /** the index of this row */
 
186
        unsigned long long _index;
 
187
 
 
188
};
 
189
 
 
190
 
 
191
// template specialisations
 
192
template< >
 
193
row &row::operator >> < detail::null_t >(
 
194
        detail::null_t & );
 
195
 
 
196
 
 
197
} // namespace sqlite
 
198
 
 
199
 
 
200
#endif /* SQLITE3CC_ROW_H_ */