1 /* 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 
31 /** adapters registry **/
32 
33 extern 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 */
44 extern int pysqlite_microprotocols_init(PyObject *dict);
45 extern int pysqlite_microprotocols_add(
46     PyTypeObject *type, PyObject *proto, PyObject *cast);
47 extern PyObject *pysqlite_microprotocols_adapt(
48     PyObject *obj, PyObject *proto, PyObject *alt);
49 
50 extern PyObject *
51     pysqlite_adapt(pysqlite_Cursor* self, PyObject *args);
52 #define pysqlite_adapt_doc \
53     "adapt(obj, protocol, alternate) -> adapt obj to given protocol. Non-standard."
54 
55 #endif /* !defined(PSYCOPG_MICROPROTOCOLS_H) */
56