blob: 3a9944fc794768cafbf2f7e37578896110039cc9 [file] [log] [blame]
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001/* microprotocols.c - definitions for minimalist and non-validating protocols
2 *
3 * Copyright (C) 2003-2004 Federico Di Gregorio <fog@debian.org>
4 *
5 * This file is part of psycopg and was adapted for pysqlite. Federico Di
6 * Gregorio gave the permission to use it within pysqlite under the following
7 * license:
8 *
9 * This software is provided 'as-is', without any express or implied
10 * warranty. In no event will the authors be held liable for any damages
11 * arising from the use of this software.
12 *
13 * Permission is granted to anyone to use this software for any purpose,
14 * including commercial applications, and to alter it and redistribute it
15 * freely, subject to the following restrictions:
16 *
17 * 1. The origin of this software must not be misrepresented; you must not
18 * claim that you wrote the original software. If you use this software
19 * in a product, an acknowledgment in the product documentation would be
20 * appreciated but is not required.
21 * 2. Altered source versions must be plainly marked as such, and must not be
22 * misrepresented as being the original software.
23 * 3. This notice may not be removed or altered from any source distribution.
24 */
25
26#ifndef PSYCOPG_MICROPROTOCOLS_H
27#define PSYCOPG_MICROPROTOCOLS_H 1
28
29#include <Python.h>
30
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000031/** adapters registry **/
32
33extern PyObject *psyco_adapters;
34
35/** the names of the three mandatory methods **/
36
37#define MICROPROTOCOLS_GETQUOTED_NAME "getquoted"
38#define MICROPROTOCOLS_GETSTRING_NAME "getstring"
39#define MICROPROTOCOLS_GETBINARY_NAME "getbinary"
40
41/** exported functions **/
42
43/* used by module.c to init the microprotocols system */
Benjamin Petersond7b03282008-09-13 15:58:53 +000044extern int pysqlite_microprotocols_init(PyObject *dict);
45extern int pysqlite_microprotocols_add(
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000046 PyTypeObject *type, PyObject *proto, PyObject *cast);
Benjamin Petersond7b03282008-09-13 15:58:53 +000047extern PyObject *pysqlite_microprotocols_adapt(
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000048 PyObject *obj, PyObject *proto, PyObject *alt);
49
50extern PyObject *
Benjamin Petersond7b03282008-09-13 15:58:53 +000051 pysqlite_adapt(pysqlite_Cursor* self, PyObject *args);
52#define pysqlite_adapt_doc \
Thomas Wouters477c8d52006-05-27 19:21:47 +000053 "adapt(obj, protocol, alternate) -> adapt obj to given protocol. Non-standard."
54
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000055#endif /* !defined(PSYCOPG_MICROPROTOCOLS_H) */