/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: edam
  • Date: 2009-11-25 20:32:34 UTC
  • Revision ID: edam@waxworlds.org-20091125203234-24i7mzd60c7o46py
- initial commit
- basic support for: database, statements, commands, transactions, exceptions
- initial test app
- initial liscence and readme

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/manipulator.h
1
 
/*
2
 
 * manipulator.h
3
 
 *
4
 
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
5
 
 *
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.
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_MANIPULATOR_H_
24
 
#define SQLITE3CC_MANIPULATOR_H_
25
 
 
26
 
 
27
 
#include <string>
28
 
 
29
 
 
30
 
namespace sqlite
31
 
{
32
 
 
33
 
 
34
 
namespace detail
35
 
{
36
 
        // types to represent special manipulators for use with stream operators
37
 
        struct null_t { };
38
 
        struct exec_t { };
39
 
        struct set_index_t { unsigned int _index; };
40
 
        struct blob_t { const char *value; unsigned int value_length; };
41
 
}
42
 
 
43
 
 
44
 
/**
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
47
 
 * operator, no value is fetched for a column.
48
 
 */
49
 
extern detail::null_t null;
50
 
 
51
 
/**
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
56
 
 * operator, behaviour is the same except that it will not throw when the
57
 
 * execution returns results.
58
 
 */
59
 
extern detail::exec_t exec;
60
 
 
61
 
/**
62
 
 * Stream manipulator.  When used with a statment's or a row's stream operator,
63
 
 * this manipulator sets the index used to automatically bind values or get
64
 
 * column values.
65
 
 *
66
 
 * @param index the new index
67
 
 */
68
 
detail::set_index_t set_index(
69
 
        unsigned int index );
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
 
 
93
 
 
94
 
} // namespace sqlite
95
 
 
96
 
 
97
 
#endif /* SQLITE3CC_MANIPULATOR_H_ */