/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: 2015-02-26 08:59:36 UTC
  • Revision ID: tim@ed.am-20150226085936-xe43in8bfz6f6nxb
fixed some missing/incorrect includes

Show diffs side-by-side

added added

removed removed

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/>.
24
24
#define SQLITE3CC_MANIPULATOR_H_
25
25
 
26
26
 
 
27
#include <string>
 
28
 
 
29
 
27
30
namespace sqlite
28
31
{
29
32
 
34
37
        struct null_t { };
35
38
        struct exec_t { };
36
39
        struct set_index_t { unsigned int _index; };
 
40
        struct blob_t { const char *value; unsigned int value_length; };
37
41
}
38
42
 
39
43
 
40
44
/**
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
 
45
 * Stream manipulator.  When used with a statment's stream operator, this
 
46
 * specifies a NULL value to bind to a parameter.  When used with a row's stream
43
47
 * operator, no value is fetched for a column.
44
48
 */
45
49
extern detail::null_t null;
46
50
 
47
51
/**
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
 
52
 * Stream manipulator.  When used with a statment's stream operator, this
 
53
 * indicates that the statement should be executed immediately.  Unlike a
 
54
 * statment's exec() method, this will throw on error.  Also, it will throw if
 
55
 * the execution returns any result rows.  When used with a query's stream
52
56
 * operator, behaviour is the same except that it will not throw when the
53
57
 * execution returns results.
54
58
 */
55
59
extern detail::exec_t exec;
56
60
 
57
61
/**
58
 
 * Stream manipulator. When used with a statment's or a row's stream operator,
 
62
 * Stream manipulator.  When used with a statment's or a row's stream operator,
59
63
 * this manipulator sets the index used to automatically bind values or get
60
64
 * column values.
 
65
 *
61
66
 * @param index the new index
62
67
 */
63
68
detail::set_index_t set_index(
64
69
        unsigned int index );
65
70
 
 
71
/**
 
72
 * Stream manipulator.  When used with a statement's or a row's stream operator,
 
73
 * this indicates that the data contained within is to be bound as a blob,
 
74
 * rather than text.
 
75
 *
 
76
 * @param value the blob data value
 
77
 * @param value_length the length of the blob data
 
78
 */
 
79
detail::blob_t blob(
 
80
        const char *value,
 
81
        unsigned int value_length );
 
82
 
 
83
/**
 
84
 * Stream manipulator.  When used with a statement's or a row's stream operator,
 
85
 * this indicates that the data contained within is to be bound as a blob,
 
86
 * rather than text.
 
87
 *
 
88
 * @param value the blob data value
 
89
 */
 
90
detail::blob_t blob(
 
91
        const std::string &value );
 
92
 
66
93
 
67
94
} // namespace sqlite
68
95