blob: d916ca5fc6b44ee5b5ae9bff86655689e5aff419 [file] [log] [blame]
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001/* cursor.h - definitions for the cursor type
2 *
Gerhard Häringe7ea7452008-03-29 00:45:29 +00003 * Copyright (C) 2004-2007 Gerhard Häring <gh@ghaering.de>
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004 *
5 * This file is part of pysqlite.
6 *
7 * This software is provided 'as-is', without any express or implied
8 * warranty. In no event will the authors be held liable for any damages
9 * arising from the use of this software.
10 *
11 * Permission is granted to anyone to use this software for any purpose,
12 * including commercial applications, and to alter it and redistribute it
13 * freely, subject to the following restrictions:
14 *
15 * 1. The origin of this software must not be misrepresented; you must not
16 * claim that you wrote the original software. If you use this software
17 * in a product, an acknowledgment in the product documentation would be
18 * appreciated but is not required.
19 * 2. Altered source versions must be plainly marked as such, and must not be
20 * misrepresented as being the original software.
21 * 3. This notice may not be removed or altered from any source distribution.
22 */
23
24#ifndef PYSQLITE_CURSOR_H
25#define PYSQLITE_CURSOR_H
26#include "Python.h"
27
28#include "statement.h"
29#include "connection.h"
30#include "module.h"
31
32typedef struct
33{
34 PyObject_HEAD
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000035 pysqlite_Connection* connection;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000036 PyObject* description;
37 PyObject* row_cast_map;
38 int arraysize;
39 PyObject* lastrowid;
40 PyObject* rowcount;
41 PyObject* row_factory;
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000042 pysqlite_Statement* statement;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000043
44 /* the next row to be returned, NULL if no next row available */
45 PyObject* next_row;
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000046} pysqlite_Cursor;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000047
48typedef enum {
49 STATEMENT_INVALID, STATEMENT_INSERT, STATEMENT_DELETE,
50 STATEMENT_UPDATE, STATEMENT_REPLACE, STATEMENT_SELECT,
51 STATEMENT_OTHER
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000052} pysqlite_StatementKind;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000053
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000054extern PyTypeObject pysqlite_CursorType;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000055
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000056int pysqlite_cursor_init(pysqlite_Cursor* self, PyObject* args, PyObject* kwargs);
57void pysqlite_cursor_dealloc(pysqlite_Cursor* self);
58PyObject* pysqlite_cursor_execute(pysqlite_Cursor* self, PyObject* args);
59PyObject* pysqlite_cursor_executemany(pysqlite_Cursor* self, PyObject* args);
60PyObject* pysqlite_cursor_getiter(pysqlite_Cursor *self);
61PyObject* pysqlite_cursor_iternext(pysqlite_Cursor *self);
62PyObject* pysqlite_cursor_fetchone(pysqlite_Cursor* self, PyObject* args);
Gerhard Häringe7ea7452008-03-29 00:45:29 +000063PyObject* pysqlite_cursor_fetchmany(pysqlite_Cursor* self, PyObject* args, PyObject* kwargs);
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000064PyObject* pysqlite_cursor_fetchall(pysqlite_Cursor* self, PyObject* args);
65PyObject* pysqlite_noop(pysqlite_Connection* self, PyObject* args);
66PyObject* pysqlite_cursor_close(pysqlite_Cursor* self, PyObject* args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000067
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000068int pysqlite_cursor_setup_types(void);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000069
70#define UNKNOWN (-1)
71#endif