/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/manipulator.h

  • Committer: Tim Marston
  • Date: 2014-01-03 12:17:37 UTC
  • Revision ID: tim@ed.am-20140103121737-yq7j381e00olvw2v
removed stuff from version control that shouldn't be

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/manipulator.h
1
1
/*
2
2
 * manipulator.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/>.
28
28
{
29
29
 
30
30
 
31
 
struct _null_t { };
32
 
struct _exec_t { };
33
 
struct _set_index_t { unsigned int _index; };
 
31
namespace detail
 
32
{
 
33
        // types to represent special manipulators for use with stream operators
 
34
        struct null_t { };
 
35
        struct exec_t { };
 
36
        struct set_index_t { unsigned int _index; };
 
37
}
34
38
 
35
39
 
36
40
/**
37
 
 * Stream manipulator. When used with a statment's stream operator, this
38
 
 * specifies a NULL value to bind to a parameter. When used with a row's stream
 
41
 * Stream manipulator.  When used with a statment's stream operator, this
 
42
 * specifies a NULL value to bind to a parameter.  When used with a row's stream
39
43
 * operator, no value is fetched for a column.
40
44
 */
41
 
extern _null_t null;
 
45
extern detail::null_t null;
42
46
 
43
47
/**
44
 
 * Stream manipulator. When used with a statment's stream operator, this
45
 
 * indicates that the statement should be executed immediately. Unlike a
46
 
 * statment's exec() method, this will throw on error. Also, it will throw if
47
 
 * the execution returns any result rows. When used with a query's stream
 
48
 * Stream manipulator.  When used with a statment's stream operator, this
 
49
 * indicates that the statement should be executed immediately.  Unlike a
 
50
 * statment's exec() method, this will throw on error.  Also, it will throw if
 
51
 * the execution returns any result rows.  When used with a query's stream
48
52
 * operator, behaviour is the same except that it will not throw when the
49
53
 * execution returns results.
50
54
 */
51
 
extern _exec_t exec;
 
55
extern detail::exec_t exec;
52
56
 
53
57
/**
54
 
 * Stream manipulator. When used with a statment's or a row's stream operator,
 
58
 * Stream manipulator.  When used with a statment's or a row's stream operator,
55
59
 * this manipulator sets the index used to automatically bind values or get
56
60
 * column values.
 
61
 *
57
62
 * @param index the new index
58
63
 */
59
 
_set_index_t set_index(
 
64
detail::set_index_t set_index(
60
65
        unsigned int index );
61
66
 
62
67