blob: 5d8b5c160d5fd63ec880f9188b482e2b8da2ca04 [file] [log] [blame]
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001/* cursor.h - definitions for the cursor type
2 *
Florent Xiclunac934f322010-09-03 23:47:32 +00003 * Copyright (C) 2004-2010 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;
Georg Brandlf78e02b2008-06-10 17:40:04 +000040 long rowcount;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000041 PyObject* row_factory;
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000042 pysqlite_Statement* statement;
Gerhard Häringf9cee222010-03-05 15:20:03 +000043 int closed;
44 int reset;
45 int initialized;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000046
47 /* the next row to be returned, NULL if no next row available */
48 PyObject* next_row;
Gerhard Häringf9cee222010-03-05 15:20:03 +000049
50 PyObject* in_weakreflist; /* List of weak references */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000051} pysqlite_Cursor;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000052
53typedef enum {
54 STATEMENT_INVALID, STATEMENT_INSERT, STATEMENT_DELETE,
55 STATEMENT_UPDATE, STATEMENT_REPLACE, STATEMENT_SELECT,
56 STATEMENT_OTHER
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000057} pysqlite_StatementKind;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000058
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000059extern PyTypeObject pysqlite_CursorType;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000060
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000061PyObject* pysqlite_cursor_execute(pysqlite_Cursor* self, PyObject* args);
62PyObject* pysqlite_cursor_executemany(pysqlite_Cursor* self, PyObject* args);
63PyObject* pysqlite_cursor_getiter(pysqlite_Cursor *self);
64PyObject* pysqlite_cursor_iternext(pysqlite_Cursor *self);
65PyObject* pysqlite_cursor_fetchone(pysqlite_Cursor* self, PyObject* args);
Gerhard Häringe7ea7452008-03-29 00:45:29 +000066PyObject* pysqlite_cursor_fetchmany(pysqlite_Cursor* self, PyObject* args, PyObject* kwargs);
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000067PyObject* pysqlite_cursor_fetchall(pysqlite_Cursor* self, PyObject* args);
68PyObject* pysqlite_noop(pysqlite_Connection* self, PyObject* args);
69PyObject* pysqlite_cursor_close(pysqlite_Cursor* self, PyObject* args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000070
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000071int pysqlite_cursor_setup_types(void);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000072
73#define UNKNOWN (-1)
74#endif