/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-02-08 22:08:57 UTC
  • Revision ID: edam@waxworlds.org-20100208220857-5up6fi4y6jh5bz4k
- removed "OK" from test-main when test is successful
- aranged for test/test-main to buld properly and be called from "make check"
- added include/Makefile.am to arrange for installation of library headers
- added project website to configure.ac
- added library interface configuration variable to configure.ac

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/>.
24
24
#define SQLITE3CC_ROW_H_
25
25
 
26
26
 
 
27
#include <sqlite3cc/query.h>
27
28
#include <sqlite3.h>
28
29
#include <boost/utility.hpp>
29
30
#include <boost/lexical_cast.hpp>
36
37
{
37
38
 
38
39
 
39
 
class query;
40
 
namespace detail {
41
 
        struct null_t;
42
 
        struct set_index_t;
43
 
}
 
40
struct _null_t;
 
41
struct _set_index_t;
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
{
56
54
//                                                                 instantiation
57
55
protected:
58
56
 
59
 
        friend class query;
60
 
 
61
57
        /**
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
 
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
66
61
         */
67
62
        explicit row(
68
 
                sqlite3_stmt *handle,
69
 
                unsigned long long row_number );
70
 
 
71
 
        /**
72
 
         * Constructor that produces an invalid row.
73
 
         */
74
 
        explicit row();
 
63
                query &query,
 
64
                bool valid = true );
75
65
 
76
66
//______________________________________________________________________________
77
67
//                                                              public interface
78
68
public:
79
69
 
80
70
        /**
81
 
         * Determine if this row is valid or not.  If it is not valid, there are no
 
71
         * Determine if this row is valid or not. If it is not valid, there are no
82
72
         * more rows in the results of the query.
83
73
         */
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()
 
74
        inline operator bool()
92
75
        {
93
 
                return _row_number;
 
76
                return _valid;
94
77
        }
95
78
 
96
79
        /**
97
80
         * Ascertain a column's type.
98
 
         *
99
81
         * @param index column index
100
82
         * @return sqlite datatype code
101
83
         * @see sqlite3_column_type()
104
86
                unsigned int index );
105
87
 
106
88
        /**
107
 
         * Get the number of bytes in the result for a given column.
108
 
         *
 
89
         * get the number of bytes in the result for a given column.
109
90
         * @param index column index
110
91
         * @return number of bytes in result
111
92
         * @see sqlite3_column_bytes()
114
95
                unsigned int index );
115
96
 
116
97
        /**
117
 
         * Get a value from the row.
118
 
         *
 
98
         * Get a value from the row
119
99
         * @param index column index
120
100
         * @param value reference to object to set with the value
121
101
         * @see sqlite3_column_*()
125
105
                unsigned int index,
126
106
                T &value )
127
107
        {
128
 
                assert( index <
129
 
                        static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
 
108
                assert( index < _query.column_count() );
130
109
                const char *text = reinterpret_cast< const char * >(
131
 
                        sqlite3_column_text( _handle, index ) );
 
110
                        sqlite3_column_text( _query._handle, index ) );
132
111
                if( text )
133
112
                        value = boost::lexical_cast< T >( text );
134
113
                else
136
115
        }
137
116
 
138
117
        /**
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
 
        /**
155
118
         * 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-
 
119
         * each column in turn. In addition, the null and set_index() auto-column-
157
120
         * getting manipulators can be used.
158
 
         *
159
121
         * @param value is a variable to store the retrieved data in
160
122
         */
161
123
        template< class T >
171
133
         * Stream operator for use with set_index().
172
134
         */
173
135
        row &operator >>(
174
 
                detail::set_index_t t );
 
136
                _set_index_t t );
175
137
 
176
138
        /**
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
 
139
         * Check of this row is valid
 
140
         * @return true if it is
181
141
         */
182
 
        bool operator ==(
183
 
                const row &other )
184
 
                const;
 
142
        operator bool() const
 
143
        {
 
144
                return _valid;
 
145
        }
185
146
 
186
147
//______________________________________________________________________________
187
148
//                                                                implementation
188
149
protected:
189
150
 
190
 
        /** the query's handle, or NULL */
191
 
        sqlite3_stmt *_handle;
 
151
        friend class query;
 
152
 
 
153
        /** the parent query */
 
154
        query &_query;
192
155
 
193
156
private:
194
157
 
195
158
        /** index used when auto-column-getting */
196
159
        unsigned int _column_index;
197
160
 
198
 
        /** the index of this row */
199
 
        unsigned long long _row_number;
 
161
        /** is this row valid? */
 
162
        bool _valid;
200
163
 
201
164
};
202
165
 
203
166
 
204
167
// template specialisations
205
168
template< >
206
 
row &row::operator >> < detail::null_t >(
207
 
        detail::null_t & );
208
 
 
209
 
 
210
 
} // namespace sqlite
 
169
row &row::operator >> < _null_t >(
 
170
        _null_t & );
 
171
 
 
172
 
 
173
} // namespace row
211
174
 
212
175
 
213
176
#endif /* SQLITE3CC_ROW_H_ */