PostgreSQL Source Code  git master
plpython.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * plpython.h - Python as a procedural language for PostgreSQL
4  *
5  * Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group
6  * Portions Copyright (c) 1994, Regents of the University of California
7  *
8  * src/pl/plpython/plpython.h
9  *
10  *-------------------------------------------------------------------------
11  */
12 #ifndef PLPYTHON_H
13 #define PLPYTHON_H
14 
15 /*
16  * Include order should be: postgres.h, other postgres headers, plpython.h,
17  * other plpython headers
18  */
19 #ifndef POSTGRES_H
20 #error postgres.h must be included before plpython.h
21 #endif
22 
23 /*
24  * Undefine some things that get (re)defined in the Python headers. They aren't
25  * used by the PL/Python code, and all PostgreSQL headers should be included
26  * earlier, so this should be pretty safe.
27  */
28 #undef _POSIX_C_SOURCE
29 #undef _XOPEN_SOURCE
30 #undef HAVE_STRERROR
31 #undef HAVE_TZNAME
32 
33 /*
34  * Sometimes python carefully scribbles on our *printf macros.
35  * So we undefine them here and redefine them after it's done its dirty deed.
36  */
37 
38 #ifdef USE_REPL_SNPRINTF
39 #undef snprintf
40 #undef vsnprintf
41 #endif
42 
43 #if defined(_MSC_VER) && defined(_DEBUG)
44 /* Python uses #pragma to bring in a non-default libpython on VC++ if
45  * _DEBUG is defined */
46 #undef _DEBUG
47 /* Also hide away errcode, since we load Python.h before postgres.h */
48 #define errcode __msvc_errcode
49 #include <Python.h>
50 #undef errcode
51 #define _DEBUG
52 #elif defined (_MSC_VER)
53 #define errcode __msvc_errcode
54 #include <Python.h>
55 #undef errcode
56 #else
57 #include <Python.h>
58 #endif
59 
60 /*
61  * Py_ssize_t compat for Python <= 2.4
62  */
63 #if PY_VERSION_HEX < 0x02050000 && !defined(PY_SSIZE_T_MIN)
64 typedef int Py_ssize_t;
65 
66 #define PY_SSIZE_T_MAX INT_MAX
67 #define PY_SSIZE_T_MIN INT_MIN
68 #endif
69 
70 /*
71  * Python 2/3 strings/unicode/bytes handling. Python 2 has strings
72  * and unicode, Python 3 has strings, which are unicode on the C
73  * level, and bytes. The porting convention, which is similarly used
74  * in Python 2.6, is that "Unicode" is always unicode, and "Bytes" are
75  * bytes in Python 3 and strings in Python 2. Since we keep
76  * supporting Python 2 and its usual strings, we provide a
77  * compatibility layer for Python 3 that when asked to convert a C
78  * string to a Python string it converts the C string from the
79  * PostgreSQL server encoding to a Python Unicode object.
80  */
81 
82 #if PY_VERSION_HEX < 0x02060000
83 /* This is exactly the compatibility layer that Python 2.6 uses. */
84 #define PyBytes_AsString PyString_AsString
85 #define PyBytes_FromStringAndSize PyString_FromStringAndSize
86 #define PyBytes_Size PyString_Size
87 #define PyObject_Bytes PyObject_Str
88 #endif
89 
90 #if PY_MAJOR_VERSION >= 3
91 #define PyString_Check(x) 0
92 #define PyString_AsString(x) PLyUnicode_AsString(x)
93 #define PyString_FromString(x) PLyUnicode_FromString(x)
94 #define PyString_FromStringAndSize(x, size) PLyUnicode_FromStringAndSize(x, size)
95 #endif
96 
97 /*
98  * Python 3 only has long.
99  */
100 #if PY_MAJOR_VERSION >= 3
101 #define PyInt_FromLong(x) PyLong_FromLong(x)
102 #define PyInt_AsLong(x) PyLong_AsLong(x)
103 #endif
104 
105 /*
106  * PyVarObject_HEAD_INIT was added in Python 2.6. Its use is
107  * necessary to handle both Python 2 and 3. This replacement
108  * definition is for Python <=2.5
109  */
110 #ifndef PyVarObject_HEAD_INIT
111 #define PyVarObject_HEAD_INIT(type, size) \
112  PyObject_HEAD_INIT(type) size,
113 #endif
114 
115 /* Python 3 removed the Py_TPFLAGS_HAVE_ITER flag */
116 #if PY_MAJOR_VERSION >= 3
117 #define Py_TPFLAGS_HAVE_ITER 0
118 #endif
119 
120 /* define our text domain for translations */
121 #undef TEXTDOMAIN
122 #define TEXTDOMAIN PG_TEXTDOMAIN("plpython")
123 
124 #include <compile.h>
125 #include <eval.h>
126 
127 /* put back our snprintf and vsnprintf */
128 #ifdef USE_REPL_SNPRINTF
129 #ifdef snprintf
130 #undef snprintf
131 #endif
132 #ifdef vsnprintf
133 #undef vsnprintf
134 #endif
135 #ifdef __GNUC__
136 #define vsnprintf(...) pg_vsnprintf(__VA_ARGS__)
137 #define snprintf(...) pg_snprintf(__VA_ARGS__)
138 #else
139 #define vsnprintf pg_vsnprintf
140 #define snprintf pg_snprintf
141 #endif /* __GNUC__ */
142 #endif /* USE_REPL_SNPRINTF */
143 
144 /*
145  * Used throughout, and also by the Python 2/3 porting layer, so it's easier to
146  * just include it everywhere.
147  */
148 #include "plpy_util.h"
149 
150 #endif /* PLPYTHON_H */
int Py_ssize_t
Definition: plpython.h:64