/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-01-28 12:21:03 UTC
  • Revision ID: edam@waxworlds.org-20100128122103-v3gs6hro5h7ffnhb
- further initial development
- basic support for: queries, rows (query results)
- filename, comment header and project name consistency

Show diffs side-by-side

added added

removed removed

 
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 <sqlite3cc/query.h>
 
28
#include <sqlite3.h>
 
29
#include <boost/utility.hpp>
 
30
#include <boost/lexical_cast.hpp>
 
31
#include <boost/utility/value_init.hpp>
 
32
#include <cassert>
 
33
#include <iostream>
 
34
 
 
35
 
 
36
namespace sqlite
 
37
{
 
38
 
 
39
 
 
40
struct _null_t;
 
41
struct _set_index_t;
 
42
 
 
43
 
 
44
/**
 
45
 * A result row from a query.
 
46
 *
 
47
 * 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
 */
 
51
class row
 
52
{
 
53
//______________________________________________________________________________
 
54
//                                                                 instantiation
 
55
protected:
 
56
 
 
57
        /**
 
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
 
61
         */
 
62
        explicit row(
 
63
                query &query,
 
64
                bool valid = true );
 
65
 
 
66
//______________________________________________________________________________
 
67
//                                                              public interface
 
68
public:
 
69
 
 
70
        /**
 
71
         * Determine if this row is valid or not. If it is not valid, there are no
 
72
         * more rows in the results of the query.
 
73
         */
 
74
        inline operator bool()
 
75
        {
 
76
                return _valid;
 
77
        }
 
78
 
 
79
        /**
 
80
         * Ascertain a column's type.
 
81
         * @param index column index
 
82
         * @return sqlite datatype code
 
83
         * @see sqlite3_column_type()
 
84
         */
 
85
        int column_type(
 
86
                unsigned int index );
 
87
 
 
88
        /**
 
89
         * get the number of bytes in the result for a given column.
 
90
         * @param index column index
 
91
         * @return number of bytes in result
 
92
         * @see sqlite3_column_bytes()
 
93
         */
 
94
        unsigned int column_bytes(
 
95
                unsigned int index );
 
96
 
 
97
        /**
 
98
         * Get a value from the row
 
99
         * @param index column index
 
100
         * @param value reference to object to set with the value
 
101
         * @see sqlite3_column_*()
 
102
         */
 
103
        template< class T >
 
104
        void column(
 
105
                unsigned int index,
 
106
                T &value )
 
107
        {
 
108
                assert( index < _query.column_count() );
 
109
                const char *text = reinterpret_cast< const char * >(
 
110
                        sqlite3_column_text( _query._handle, index ) );
 
111
                if( text )
 
112
                        value = boost::lexical_cast< T >( text );
 
113
                else
 
114
                        value = boost::get( boost::value_initialized< T >() );
 
115
        }
 
116
 
 
117
        /**
 
118
         * 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-
 
120
         * getting manipulators can be used.
 
121
         * @param value is a variable to store the retrieved data in
 
122
         */
 
123
        template< class T >
 
124
        row &operator >>(
 
125
                T &value )
 
126
        {
 
127
                column( _column_index, value );
 
128
                _column_index++;
 
129
                return *this;
 
130
        }
 
131
 
 
132
        /**
 
133
         * Stream operator for use with set_index().
 
134
         */
 
135
        row &operator >>(
 
136
                _set_index_t t );
 
137
 
 
138
        /**
 
139
         * Check of this row is valid
 
140
         * @return true if it is
 
141
         */
 
142
        operator bool() const
 
143
        {
 
144
                return _valid;
 
145
        }
 
146
 
 
147
//______________________________________________________________________________
 
148
//                                                                implementation
 
149
protected:
 
150
 
 
151
        friend class query;
 
152
 
 
153
        /** the parent query */
 
154
        query &_query;
 
155
 
 
156
private:
 
157
 
 
158
        /** index used when auto-column-getting */
 
159
        unsigned int _column_index;
 
160
 
 
161
        /** is this row valid? */
 
162
        bool _valid;
 
163
 
 
164
};
 
165
 
 
166
 
 
167
// template specialisations
 
168
template< >
 
169
row &row::operator >> < _null_t >(
 
170
        _null_t & );
 
171
 
 
172
 
 
173
} // namespace row
 
174
 
 
175
 
 
176
#endif /* SQLITE3CC_ROW_H_ */