Modules/_sqlite/cursor.h

   1 /* cursor.h - definitions for the cursor type
   2  *
   3  * Copyright (C) 2004-2007 Gerhard Häring <gh@ghaering.de>
   4  *
   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
  32 typedef struct
  33 {
  34     PyObject_HEAD
  35     pysqlite_Connection* connection;
  36     PyObject* description;
  37     PyObject* row_cast_map;
  38     int arraysize;
  39     PyObject* lastrowid;
  40     PyObject* rowcount;
  41     PyObject* row_factory;
  42     pysqlite_Statement* statement;
  43
  44     /* the next row to be returned, NULL if no next row available */
  45     PyObject* next_row;
  46 } pysqlite_Cursor;
  47
  48 typedef enum {
  49     STATEMENT_INVALID, STATEMENT_INSERT, STATEMENT_DELETE,
  50     STATEMENT_UPDATE, STATEMENT_REPLACE, STATEMENT_SELECT,
  51     STATEMENT_OTHER
  52 } pysqlite_StatementKind;
  53
  54 extern PyTypeObject pysqlite_CursorType;
  55
  56 int pysqlite_cursor_init(pysqlite_Cursor* self, PyObject* args, PyObject* kwargs);
  57 void pysqlite_cursor_dealloc(pysqlite_Cursor* self);
  58 PyObject* pysqlite_cursor_execute(pysqlite_Cursor* self, PyObject* args);
  59 PyObject* pysqlite_cursor_executemany(pysqlite_Cursor* self, PyObject* args);
  60 PyObject* pysqlite_cursor_getiter(pysqlite_Cursor *self);
  61 PyObject* pysqlite_cursor_iternext(pysqlite_Cursor *self);
  62 PyObject* pysqlite_cursor_fetchone(pysqlite_Cursor* self, PyObject* args);
  63 PyObject* pysqlite_cursor_fetchmany(pysqlite_Cursor* self, PyObject* args, PyObject* kwargs);
  64 PyObject* pysqlite_cursor_fetchall(pysqlite_Cursor* self, PyObject* args);
  65 PyObject* pysqlite_noop(pysqlite_Connection* self, PyObject* args);
  66 PyObject* pysqlite_cursor_close(pysqlite_Cursor* self, PyObject* args);
  67
  68 int pysqlite_cursor_setup_types(void);
  69
  70 #define UNKNOWN (-1)
  71 #endif