/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: Tim Marston
  • Date: 2014-01-03 12:33:22 UTC
  • Revision ID: tim@ed.am-20140103123322-7f00jlfhpfhs7hen
removed more stuff from version control that shouldn't be there

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/sqlite3cc/row.h
1
1
/*
2
2
 * row.h
3
3
 *
4
 
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
5
5
 *
6
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.
 
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.
18
18
 *
19
19
 * You should have received a copy of the GNU Lesser General Public License
20
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
24
24
#define SQLITE3CC_ROW_H_
25
25
 
26
26
 
27
 
#include <sqlite3cc/query.h>
28
27
#include <sqlite3.h>
29
28
#include <boost/utility.hpp>
30
29
#include <boost/lexical_cast.hpp>
37
36
{
38
37
 
39
38
 
40
 
struct _null_t;
41
 
struct _set_index_t;
 
39
class query;
 
40
namespace detail {
 
41
        struct null_t;
 
42
        struct set_index_t;
 
43
}
42
44
 
43
45
 
44
46
/**
45
47
 * A result row from a query.
46
48
 *
47
49
 * 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
 * query object, or until the parent query object is destructed.  This may
 
51
 * change in future versions.
50
52
 */
51
53
class row
52
54
{
54
56
//                                                                 instantiation
55
57
protected:
56
58
 
 
59
        friend class query;
 
60
 
57
61
        /**
58
 
         * Constructor that provides the database that we were extracted from.
59
 
         * @param the query that this row belongs to
60
 
         * @oaram true if this row represents there being no more rows
 
62
         * Constructor that produces a valid row.
 
63
         *
 
64
         * @param handle of the statement (query) that created this row
 
65
         * @oaram row_number the index of this row
61
66
         */
62
67
        explicit row(
63
 
                query &query,
64
 
                bool valid = true );
 
68
                sqlite3_stmt *handle,
 
69
                unsigned long long row_number );
 
70
 
 
71
        /**
 
72
         * Constructor that produces an invalid row.
 
73
         */
 
74
        explicit row();
65
75
 
66
76
//______________________________________________________________________________
67
77
//                                                              public interface
68
78
public:
69
79
 
70
80
        /**
71
 
         * Determine if this row is valid or not. If it is not valid, there are no
 
81
         * Determine if this row is valid or not.  If it is not valid, there are no
72
82
         * more rows in the results of the query.
73
83
         */
74
 
        inline operator bool()
 
84
        operator bool() const;
 
85
 
 
86
        /**
 
87
         * Get the index in to the results that is this row.
 
88
         *
 
89
         * @return index
 
90
         */
 
91
        inline unsigned long long row_number()
75
92
        {
76
 
                return _valid;
 
93
                return _row_number;
77
94
        }
78
95
 
79
96
        /**
80
97
         * Ascertain a column's type.
 
98
         *
81
99
         * @param index column index
82
100
         * @return sqlite datatype code
83
101
         * @see sqlite3_column_type()
86
104
                unsigned int index );
87
105
 
88
106
        /**
89
 
         * get the number of bytes in the result for a given column.
 
107
         * Get the number of bytes in the result for a given column.
 
108
         *
90
109
         * @param index column index
91
110
         * @return number of bytes in result
92
111
         * @see sqlite3_column_bytes()
95
114
                unsigned int index );
96
115
 
97
116
        /**
98
 
         * Get a value from the row
 
117
         * Get a value from the row.
 
118
         *
99
119
         * @param index column index
100
120
         * @param value reference to object to set with the value
101
121
         * @see sqlite3_column_*()
105
125
                unsigned int index,
106
126
                T &value )
107
127
        {
108
 
                assert( index < _query.column_count() );
 
128
                assert( index <
 
129
                        static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
109
130
                const char *text = reinterpret_cast< const char * >(
110
 
                        sqlite3_column_text( _query._handle, index ) );
 
131
                        sqlite3_column_text( _handle, index ) );
111
132
                if( text )
112
133
                        value = boost::lexical_cast< T >( text );
113
134
                else
115
136
        }
116
137
 
117
138
        /**
 
139
         * Get a value from the row and return it.
 
140
         *
 
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
        /**
118
155
         * Stream operator is used to obtain values from a result row, fetching from
119
 
         * each column in turn. In addition, the null and set_index() auto-column-
 
156
         * each column in turn.  In addition, the null and set_index() auto-column-
120
157
         * getting manipulators can be used.
 
158
         *
121
159
         * @param value is a variable to store the retrieved data in
122
160
         */
123
161
        template< class T >
133
171
         * Stream operator for use with set_index().
134
172
         */
135
173
        row &operator >>(
136
 
                _set_index_t t );
 
174
                detail::set_index_t t );
137
175
 
138
176
        /**
139
 
         * Check of this row is valid
140
 
         * @return true if it is
 
177
         * Test to see if two rows are the same.
 
178
         *
 
179
         * @param other the row to compare this one to
 
180
         * @return true if they are
141
181
         */
142
 
        operator bool() const
143
 
        {
144
 
                return _valid;
145
 
        }
 
182
        bool operator ==(
 
183
                const row &other )
 
184
                const;
146
185
 
147
186
//______________________________________________________________________________
148
187
//                                                                implementation
149
188
protected:
150
189
 
151
 
        friend class query;
152
 
 
153
 
        /** the parent query */
154
 
        query &_query;
 
190
        /** the query's handle, or NULL */
 
191
        sqlite3_stmt *_handle;
155
192
 
156
193
private:
157
194
 
158
195
        /** index used when auto-column-getting */
159
196
        unsigned int _column_index;
160
197
 
161
 
        /** is this row valid? */
162
 
        bool _valid;
 
198
        /** the index of this row */
 
199
        unsigned long long _row_number;
163
200
 
164
201
};
165
202
 
166
203
 
167
204
// template specialisations
168
205
template< >
169
 
row &row::operator >> < _null_t >(
170
 
        _null_t & );
171
 
 
172
 
 
173
 
} // namespace row
 
206
row &row::operator >> < detail::null_t >(
 
207
        detail::null_t & );
 
208
 
 
209
 
 
210
} // namespace sqlite
174
211
 
175
212
 
176
213
#endif /* SQLITE3CC_ROW_H_ */