/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:45:31 UTC
  • Revision ID: tim@ed.am-20140103124531-ehrcs7qw7rf6b1iu
updated bzrignore

Show diffs side-by-side

added added

removed removed

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/>.
36
36
{
37
37
 
38
38
 
39
 
struct _null_t;
40
 
struct _set_index_t;
41
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
{
58
60
 
59
61
        /**
60
62
         * 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
         * @param handle of the statement (query) that created this row
 
65
         * @oaram row_number the index of this row
63
66
         */
64
67
        explicit row(
65
68
                sqlite3_stmt *handle,
66
 
                unsigned long long index );
 
69
                unsigned long long row_number );
67
70
 
68
71
        /**
69
72
         * Constructor that produces an invalid row.
70
 
         * @param the handle of the statement (query) that created this row
71
73
         */
72
74
        explicit row();
73
75
 
76
78
public:
77
79
 
78
80
        /**
79
 
         * 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
80
82
         * more rows in the results of the query.
81
83
         */
82
 
        inline operator bool() const
83
 
        {
84
 
                return _index != std::numeric_limits< unsigned long long >::max();
85
 
        }
 
84
        operator bool() const;
86
85
 
87
86
        /**
88
 
         * get the index in to the results that is this row
 
87
         * Get the index in to the results that is this row.
 
88
         *
89
89
         * @return index
90
90
         */
91
 
        inline unsigned long long index()
 
91
        inline unsigned long long row_number()
92
92
        {
93
 
                return _index;
 
93
                return _row_number;
94
94
        }
95
95
 
96
96
        /**
97
97
         * Ascertain a column's type.
 
98
         *
98
99
         * @param index column index
99
100
         * @return sqlite datatype code
100
101
         * @see sqlite3_column_type()
103
104
                unsigned int index );
104
105
 
105
106
        /**
106
 
         * 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
         *
107
109
         * @param index column index
108
110
         * @return number of bytes in result
109
111
         * @see sqlite3_column_bytes()
113
115
 
114
116
        /**
115
117
         * Get a value from the row.
 
118
         *
116
119
         * @param index column index
117
120
         * @param value reference to object to set with the value
118
121
         * @see sqlite3_column_*()
134
137
 
135
138
        /**
136
139
         * Get a value from the row and return it.
 
140
         *
137
141
         * @param index column index
138
142
         * @return the value
139
143
         * @see sqlite3_column_*()
149
153
 
150
154
        /**
151
155
         * 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-
 
156
         * each column in turn.  In addition, the null and set_index() auto-column-
153
157
         * getting manipulators can be used.
 
158
         *
154
159
         * @param value is a variable to store the retrieved data in
155
160
         */
156
161
        template< class T >
166
171
         * Stream operator for use with set_index().
167
172
         */
168
173
        row &operator >>(
169
 
                _set_index_t t );
 
174
                detail::set_index_t t );
 
175
 
 
176
        /**
 
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
 
181
         */
 
182
        bool operator ==(
 
183
                const row &other )
 
184
                const;
170
185
 
171
186
//______________________________________________________________________________
172
187
//                                                                implementation
173
188
protected:
174
189
 
175
 
        /** the query's handle */
 
190
        /** the query's handle, or NULL */
176
191
        sqlite3_stmt *_handle;
177
192
 
178
193
private:
180
195
        /** index used when auto-column-getting */
181
196
        unsigned int _column_index;
182
197
 
183
 
        /** the index of thi row */
184
 
        unsigned long long _index;
 
198
        /** the index of this row */
 
199
        unsigned long long _row_number;
185
200
 
186
201
};
187
202
 
188
203
 
189
204
// template specialisations
190
205
template< >
191
 
row &row::operator >> < _null_t >(
192
 
        _null_t & );
 
206
row &row::operator >> < detail::null_t >(
 
207
        detail::null_t & );
193
208
 
194
209
 
195
210
} // namespace sqlite