/sqlite3cc : contents of include/sqlite3cc/manipulator.h at revision 35

: (revision 35)

To get this branch, use:

bzr branch
http://bzr.ed.am/sqlite3cc

/*
 * manipulator.h
 *
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
 *
 * This file is part of sqlite3cc (hereafter referred to as "this program").
 * See http://ed.am/dev/sqlite3cc for more information.
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SQLITE3CC_MANIPULATOR_H_
#define SQLITE3CC_MANIPULATOR_H_


namespace sqlite
{


namespace detail
{
	// types to represent special manipulators for use with stream operators
	struct null_t { };
	struct exec_t { };
	struct set_index_t { unsigned int _index; };
}


/**
 * Stream manipulator.  When used with a statment's stream operator, this
 * specifies a NULL value to bind to a parameter.  When used with a row's stream
 * operator, no value is fetched for a column.
 */
extern detail::null_t null;

/**
 * Stream manipulator.  When used with a statment's stream operator, this
 * indicates that the statement should be executed immediately.  Unlike a
 * statment's exec() method, this will throw on error.  Also, it will throw if
 * the execution returns any result rows.  When used with a query's stream
 * operator, behaviour is the same except that it will not throw when the
 * execution returns results.
 */
extern detail::exec_t exec;

/**
 * Stream manipulator.  When used with a statment's or a row's stream operator,
 * this manipulator sets the index used to automatically bind values or get
 * column values.
 *
 * @param index the new index
 */
detail::set_index_t set_index(
	unsigned int index );


} // namespace sqlite


#endif /* SQLITE3CC_MANIPULATOR_H_ */

2 by edam - further initial development	1	/*
	2	* manipulator.h
	3	*
22 by edam updated email and web addresses	4	* Copyright (C) 2009 Tim Marston <tim@ed.am>
2 by edam - further initial development	5	*
2 by edam - further initial development	6	* This file is part of sqlite3cc (hereafter referred to as "this program").
22 by edam updated email and web addresses	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.
2 by edam - further initial development	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	namespace sqlite
	28	{
	29
	30
12 by edam - moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace	31	namespace detail
	32	{
13 by edam - made basic_statement::step() protected, for use by query and command only	33	// types to represent special manipulators for use with stream operators
12 by edam - moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace	34	struct null_t { };
	35	struct exec_t { };
	36	struct set_index_t { unsigned int _index; };
	37	}
2 by edam - further initial development	38
	39
	40	/**
22 by edam updated email and web addresses	41	* Stream manipulator. When used with a statment's stream operator, this
22 by edam updated email and web addresses	42	* specifies a NULL value to bind to a parameter. When used with a row's stream
2 by edam - further initial development	43	* operator, no value is fetched for a column.
2 by edam - further initial development	44	*/
12 by edam - moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace	45	extern detail::null_t null;
2 by edam - further initial development	46
2 by edam - further initial development	47	/**
22 by edam updated email and web addresses	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
2 by edam - further initial development	52	* operator, behaviour is the same except that it will not throw when the
	53	* execution returns results.
	54	*/
12 by edam - moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace	55	extern detail::exec_t exec;
2 by edam - further initial development	56
2 by edam - further initial development	57	/**
22 by edam updated email and web addresses	58	* Stream manipulator. When used with a statment's or a row's stream operator,
2 by edam - further initial development	59	* this manipulator sets the index used to automatically bind values or get
2 by edam - further initial development	60	* column values.
22 by edam updated email and web addresses	61	*
2 by edam - further initial development	62	* @param index the new index
2 by edam - further initial development	63	*/
12 by edam - moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace	64	detail::set_index_t set_index(
2 by edam - further initial development	65	unsigned int index );
	66
	67
	68	} // namespace sqlite
	69
	70
	71	#endif /* SQLITE3CC_MANIPULATOR_H_ */