/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:12:55 UTC
  • Revision ID: edam@waxworlds.org-20100727151255-goaqgdz4kj13q7gz
- update TODO
- added some missing includes for <string>
- changed usage of database::exec() to not require return code!
- prevented transaction_guard destructor from throwing an exception

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