xref: /vim-8.2.3635/src/if_python.c (revision dee2e315)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  * See README.txt for an overview of the Vim source code.
8  */
9 /*
10  * Python extensions by Paul Moore.
11  * Changes for Unix by David Leonard.
12  *
13  * This consists of four parts:
14  * 1. Python interpreter main program
15  * 2. Python output stream: writes output via [e]msg().
16  * 3. Implementation of the Vim module for Python
17  * 4. Utility functions for handling the interface between Vim and Python.
18  */
19 
20 #include "vim.h"
21 
22 #include <limits.h>
23 
24 /* uncomment this if used with the debug version of python.
25  * Checked on 2.7.4. */
26 /* #define Py_DEBUG */
27 /* Note: most of time you can add -DPy_DEBUG to CFLAGS in place of uncommenting
28  */
29 /* uncomment this if used with the debug version of python, but without its
30  * allocator */
31 /* #define Py_DEBUG_NO_PYMALLOC */
32 
33 /* Python.h defines _POSIX_THREADS itself (if needed) */
34 #ifdef _POSIX_THREADS
35 # undef _POSIX_THREADS
36 #endif
37 
38 #if defined(_WIN32) && defined(HAVE_FCNTL_H)
39 # undef HAVE_FCNTL_H
40 #endif
41 
42 #ifdef _DEBUG
43 # undef _DEBUG
44 #endif
45 
46 #ifdef HAVE_STDARG_H
47 # undef HAVE_STDARG_H	/* Python's config.h defines it as well. */
48 #endif
49 #ifdef _POSIX_C_SOURCE
50 # undef _POSIX_C_SOURCE	/* pyconfig.h defines it as well. */
51 #endif
52 #ifdef _XOPEN_SOURCE
53 # undef _XOPEN_SOURCE	/* pyconfig.h defines it as well. */
54 #endif
55 
56 #define PY_SSIZE_T_CLEAN
57 
58 #include <Python.h>
59 
60 #if !defined(PY_VERSION_HEX) || PY_VERSION_HEX < 0x02050000
61 # undef PY_SSIZE_T_CLEAN
62 #endif
63 
64 #if defined(MACOS) && !defined(MACOS_X_UNIX)
65 # include "macglue.h"
66 # include <CodeFragments.h>
67 #endif
68 #undef main /* Defined in python.h - aargh */
69 #undef HAVE_FCNTL_H /* Clash with os_win32.h */
70 
71 #define PyBytes_FromString      PyString_FromString
72 #define PyBytes_Check           PyString_Check
73 #define PyBytes_AsStringAndSize PyString_AsStringAndSize
74 
75 #if !defined(FEAT_PYTHON) && defined(PROTO)
76 /* Use this to be able to generate prototypes without python being used. */
77 # define PyObject Py_ssize_t
78 # define PyThreadState Py_ssize_t
79 # define PyTypeObject Py_ssize_t
80 struct PyMethodDef { Py_ssize_t a; };
81 # define PySequenceMethods Py_ssize_t
82 #endif
83 
84 #if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02070000
85 # define PY_USE_CAPSULE
86 #endif
87 
88 #if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02050000
89 # define PyInt Py_ssize_t
90 # define PyInquiry lenfunc
91 # define PyIntArgFunc ssizeargfunc
92 # define PyIntIntArgFunc ssizessizeargfunc
93 # define PyIntObjArgProc ssizeobjargproc
94 # define PyIntIntObjArgProc ssizessizeobjargproc
95 # define Py_ssize_t_fmt "n"
96 #else
97 # define PyInt int
98 # define lenfunc inquiry
99 # define PyInquiry inquiry
100 # define PyIntArgFunc intargfunc
101 # define PyIntIntArgFunc intintargfunc
102 # define PyIntObjArgProc intobjargproc
103 # define PyIntIntObjArgProc intintobjargproc
104 # define Py_ssize_t_fmt "i"
105 #endif
106 #define Py_bytes_fmt "s"
107 
108 /* Parser flags */
109 #define single_input	256
110 #define file_input	257
111 #define eval_input	258
112 
113 #if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x020300F0
114   /* Python 2.3: can invoke ":python" recursively. */
115 # define PY_CAN_RECURSE
116 #endif
117 
118 # if defined(DYNAMIC_PYTHON) || defined(PROTO)
119 #  ifndef DYNAMIC_PYTHON
120 #   define HINSTANCE long_u		/* for generating prototypes */
121 #  endif
122 
123 # ifndef WIN3264
124 #  include <dlfcn.h>
125 #  define FARPROC void*
126 #  define HINSTANCE void*
127 #  if defined(PY_NO_RTLD_GLOBAL) && defined(PY3_NO_RTLD_GLOBAL)
128 #   define load_dll(n) dlopen((n), RTLD_LAZY)
129 #  else
130 #   define load_dll(n) dlopen((n), RTLD_LAZY|RTLD_GLOBAL)
131 #  endif
132 #  define close_dll dlclose
133 #  define symbol_from_dll dlsym
134 # else
135 #  define load_dll vimLoadLib
136 #  define close_dll FreeLibrary
137 #  define symbol_from_dll GetProcAddress
138 # endif
139 
140 /* This makes if_python.c compile without warnings against Python 2.5
141  * on Win32 and Win64. */
142 # undef PyRun_SimpleString
143 # undef PyRun_String
144 # undef PyArg_Parse
145 # undef PyArg_ParseTuple
146 # undef Py_BuildValue
147 # undef Py_InitModule4
148 # undef Py_InitModule4_64
149 # undef PyObject_CallMethod
150 # undef PyObject_CallFunction
151 
152 /*
153  * Wrapper defines
154  */
155 # define PyArg_Parse dll_PyArg_Parse
156 # define PyArg_ParseTuple dll_PyArg_ParseTuple
157 # define PyMem_Free dll_PyMem_Free
158 # define PyMem_Malloc dll_PyMem_Malloc
159 # define PyDict_SetItemString dll_PyDict_SetItemString
160 # define PyErr_BadArgument dll_PyErr_BadArgument
161 # define PyErr_NewException dll_PyErr_NewException
162 # define PyErr_Clear dll_PyErr_Clear
163 # define PyErr_Format dll_PyErr_Format
164 # define PyErr_PrintEx dll_PyErr_PrintEx
165 # define PyErr_NoMemory dll_PyErr_NoMemory
166 # define PyErr_Occurred dll_PyErr_Occurred
167 # define PyErr_SetNone dll_PyErr_SetNone
168 # define PyErr_SetString dll_PyErr_SetString
169 # define PyErr_SetObject dll_PyErr_SetObject
170 # define PyErr_ExceptionMatches dll_PyErr_ExceptionMatches
171 # define PyEval_InitThreads dll_PyEval_InitThreads
172 # define PyEval_RestoreThread dll_PyEval_RestoreThread
173 # define PyEval_SaveThread dll_PyEval_SaveThread
174 # ifdef PY_CAN_RECURSE
175 #  define PyGILState_Ensure dll_PyGILState_Ensure
176 #  define PyGILState_Release dll_PyGILState_Release
177 # endif
178 # define PyInt_AsLong dll_PyInt_AsLong
179 # define PyInt_FromLong dll_PyInt_FromLong
180 # define PyLong_AsLong dll_PyLong_AsLong
181 # define PyLong_FromLong dll_PyLong_FromLong
182 # define PyBool_Type (*dll_PyBool_Type)
183 # define PyInt_Type (*dll_PyInt_Type)
184 # define PyLong_Type (*dll_PyLong_Type)
185 # define PyList_GetItem dll_PyList_GetItem
186 # define PyList_Append dll_PyList_Append
187 # define PyList_Insert dll_PyList_Insert
188 # define PyList_New dll_PyList_New
189 # define PyList_SetItem dll_PyList_SetItem
190 # define PyList_Size dll_PyList_Size
191 # define PyList_Type (*dll_PyList_Type)
192 # define PySequence_Check dll_PySequence_Check
193 # define PySequence_Size dll_PySequence_Size
194 # define PySequence_GetItem dll_PySequence_GetItem
195 # define PySequence_Fast dll_PySequence_Fast
196 # define PyTuple_Size dll_PyTuple_Size
197 # define PyTuple_GetItem dll_PyTuple_GetItem
198 # define PyTuple_Type (*dll_PyTuple_Type)
199 # define PyImport_ImportModule dll_PyImport_ImportModule
200 # define PyDict_New dll_PyDict_New
201 # define PyDict_GetItemString dll_PyDict_GetItemString
202 # define PyDict_Next dll_PyDict_Next
203 # define PyDict_Type (*dll_PyDict_Type)
204 # ifdef PyMapping_Keys
205 #  define PY_NO_MAPPING_KEYS
206 # else
207 #  define PyMapping_Keys dll_PyMapping_Keys
208 # endif
209 # define PyObject_GetItem dll_PyObject_GetItem
210 # define PyObject_CallMethod dll_PyObject_CallMethod
211 # define PyMapping_Check dll_PyMapping_Check
212 # define PyIter_Next dll_PyIter_Next
213 # define PyModule_GetDict dll_PyModule_GetDict
214 # define PyModule_AddObject dll_PyModule_AddObject
215 # define PyRun_SimpleString dll_PyRun_SimpleString
216 # define PyRun_String dll_PyRun_String
217 # define PyObject_GetAttrString dll_PyObject_GetAttrString
218 # define PyObject_HasAttrString dll_PyObject_HasAttrString
219 # define PyObject_SetAttrString dll_PyObject_SetAttrString
220 # define PyObject_CallFunctionObjArgs dll_PyObject_CallFunctionObjArgs
221 # define PyObject_CallFunction dll_PyObject_CallFunction
222 # define PyObject_Call dll_PyObject_Call
223 # define PyObject_Repr dll_PyObject_Repr
224 # define PyString_AsString dll_PyString_AsString
225 # define PyString_AsStringAndSize dll_PyString_AsStringAndSize
226 # define PyString_FromString dll_PyString_FromString
227 # define PyString_FromFormat dll_PyString_FromFormat
228 # define PyString_FromStringAndSize dll_PyString_FromStringAndSize
229 # define PyString_Size dll_PyString_Size
230 # define PyString_Type (*dll_PyString_Type)
231 # define PyUnicode_Type (*dll_PyUnicode_Type)
232 # undef PyUnicode_AsEncodedString
233 # define PyUnicode_AsEncodedString py_PyUnicode_AsEncodedString
234 # define PyFloat_AsDouble dll_PyFloat_AsDouble
235 # define PyFloat_FromDouble dll_PyFloat_FromDouble
236 # define PyFloat_Type (*dll_PyFloat_Type)
237 # define PyNumber_Check dll_PyNumber_Check
238 # define PyNumber_Long dll_PyNumber_Long
239 # define PyImport_AddModule (*dll_PyImport_AddModule)
240 # define PySys_SetObject dll_PySys_SetObject
241 # define PySys_GetObject dll_PySys_GetObject
242 # define PySys_SetArgv dll_PySys_SetArgv
243 # define PyType_Type (*dll_PyType_Type)
244 # define PyType_Ready (*dll_PyType_Ready)
245 # define PyType_GenericAlloc dll_PyType_GenericAlloc
246 # define Py_BuildValue dll_Py_BuildValue
247 # define Py_FindMethod dll_Py_FindMethod
248 # define Py_InitModule4 dll_Py_InitModule4
249 # define Py_SetPythonHome dll_Py_SetPythonHome
250 # define Py_Initialize dll_Py_Initialize
251 # define Py_Finalize dll_Py_Finalize
252 # define Py_IsInitialized dll_Py_IsInitialized
253 # define _PyObject_New dll__PyObject_New
254 # define _PyObject_GC_New dll__PyObject_GC_New
255 # ifdef PyObject_GC_Del
256 #  define Py_underscore_GC
257 #  define _PyObject_GC_Del dll__PyObject_GC_Del
258 #  define _PyObject_GC_UnTrack dll__PyObject_GC_UnTrack
259 # else
260 #  define PyObject_GC_Del dll_PyObject_GC_Del
261 #  define PyObject_GC_UnTrack dll_PyObject_GC_UnTrack
262 # endif
263 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02070000
264 #  define _PyObject_NextNotImplemented (*dll__PyObject_NextNotImplemented)
265 # endif
266 # define _Py_NoneStruct (*dll__Py_NoneStruct)
267 # define _Py_ZeroStruct (*dll__Py_ZeroStruct)
268 # define _Py_TrueStruct (*dll__Py_TrueStruct)
269 # define PyObject_Init dll__PyObject_Init
270 # define PyObject_GetIter dll_PyObject_GetIter
271 # define PyObject_IsTrue dll_PyObject_IsTrue
272 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02020000
273 #  define PyType_IsSubtype dll_PyType_IsSubtype
274 #  ifdef Py_DEBUG
275 #   define _Py_NegativeRefcount dll__Py_NegativeRefcount
276 #   define _Py_RefTotal (*dll__Py_RefTotal)
277 #   define _Py_Dealloc dll__Py_Dealloc
278 #  endif
279 # endif
280 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02030000
281 #  if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
282 #   define _PyObject_DebugMalloc dll__PyObject_DebugMalloc
283 #   define _PyObject_DebugFree dll__PyObject_DebugFree
284 #  else
285 #   define PyObject_Malloc dll_PyObject_Malloc
286 #   define PyObject_Free dll_PyObject_Free
287 #  endif
288 # endif
289 # ifdef PY_USE_CAPSULE
290 #  define PyCapsule_New dll_PyCapsule_New
291 #  define PyCapsule_GetPointer dll_PyCapsule_GetPointer
292 # else
293 #  define PyCObject_FromVoidPtr dll_PyCObject_FromVoidPtr
294 #  define PyCObject_AsVoidPtr dll_PyCObject_AsVoidPtr
295 # endif
296 
297 /*
298  * Pointers for dynamic link
299  */
300 static int(*dll_PyArg_Parse)(PyObject *, char *, ...);
301 static int(*dll_PyArg_ParseTuple)(PyObject *, char *, ...);
302 static int(*dll_PyMem_Free)(void *);
303 static void* (*dll_PyMem_Malloc)(size_t);
304 static int(*dll_PyDict_SetItemString)(PyObject *dp, char *key, PyObject *item);
305 static int(*dll_PyErr_BadArgument)(void);
306 static PyObject *(*dll_PyErr_NewException)(char *, PyObject *, PyObject *);
307 static void(*dll_PyErr_Clear)(void);
308 static PyObject*(*dll_PyErr_Format)(PyObject *, const char *, ...);
309 static void(*dll_PyErr_PrintEx)(int);
310 static PyObject*(*dll_PyErr_NoMemory)(void);
311 static PyObject*(*dll_PyErr_Occurred)(void);
312 static void(*dll_PyErr_SetNone)(PyObject *);
313 static void(*dll_PyErr_SetString)(PyObject *, const char *);
314 static void(*dll_PyErr_SetObject)(PyObject *, PyObject *);
315 static int(*dll_PyErr_ExceptionMatches)(PyObject *);
316 static void(*dll_PyEval_InitThreads)(void);
317 static void(*dll_PyEval_RestoreThread)(PyThreadState *);
318 static PyThreadState*(*dll_PyEval_SaveThread)(void);
319 # ifdef PY_CAN_RECURSE
320 static PyGILState_STATE	(*dll_PyGILState_Ensure)(void);
321 static void (*dll_PyGILState_Release)(PyGILState_STATE);
322 # endif
323 static long(*dll_PyInt_AsLong)(PyObject *);
324 static PyObject*(*dll_PyInt_FromLong)(long);
325 static long(*dll_PyLong_AsLong)(PyObject *);
326 static PyObject*(*dll_PyLong_FromLong)(long);
327 static PyTypeObject* dll_PyBool_Type;
328 static PyTypeObject* dll_PyInt_Type;
329 static PyTypeObject* dll_PyLong_Type;
330 static PyObject*(*dll_PyList_GetItem)(PyObject *, PyInt);
331 static int(*dll_PyList_Append)(PyObject *, PyObject *);
332 static int(*dll_PyList_Insert)(PyObject *, int, PyObject *);
333 static PyObject*(*dll_PyList_New)(PyInt size);
334 static int(*dll_PyList_SetItem)(PyObject *, PyInt, PyObject *);
335 static PyInt(*dll_PyList_Size)(PyObject *);
336 static PyTypeObject* dll_PyList_Type;
337 static int (*dll_PySequence_Check)(PyObject *);
338 static PyInt(*dll_PySequence_Size)(PyObject *);
339 static PyObject*(*dll_PySequence_GetItem)(PyObject *, PyInt);
340 static PyObject*(*dll_PySequence_Fast)(PyObject *, const char *);
341 static PyInt(*dll_PyTuple_Size)(PyObject *);
342 static PyObject*(*dll_PyTuple_GetItem)(PyObject *, PyInt);
343 static PyTypeObject* dll_PyTuple_Type;
344 static PyObject*(*dll_PyImport_ImportModule)(const char *);
345 static PyObject*(*dll_PyDict_New)(void);
346 static PyObject*(*dll_PyDict_GetItemString)(PyObject *, const char *);
347 static int (*dll_PyDict_Next)(PyObject *, PyInt *, PyObject **, PyObject **);
348 static PyTypeObject* dll_PyDict_Type;
349 # ifndef PY_NO_MAPPING_KEYS
350 static PyObject* (*dll_PyMapping_Keys)(PyObject *);
351 # endif
352 static PyObject* (*dll_PyObject_GetItem)(PyObject *, PyObject *);
353 static PyObject* (*dll_PyObject_CallMethod)(PyObject *, char *, PyObject *);
354 static int (*dll_PyMapping_Check)(PyObject *);
355 static PyObject* (*dll_PyIter_Next)(PyObject *);
356 static PyObject*(*dll_PyModule_GetDict)(PyObject *);
357 static int(*dll_PyModule_AddObject)(PyObject *, const char *, PyObject *);
358 static int(*dll_PyRun_SimpleString)(char *);
359 static PyObject *(*dll_PyRun_String)(char *, int, PyObject *, PyObject *);
360 static PyObject* (*dll_PyObject_GetAttrString)(PyObject *, const char *);
361 static int (*dll_PyObject_HasAttrString)(PyObject *, const char *);
362 static PyObject* (*dll_PyObject_SetAttrString)(PyObject *, const char *, PyObject *);
363 static PyObject* (*dll_PyObject_CallFunctionObjArgs)(PyObject *, ...);
364 static PyObject* (*dll_PyObject_CallFunction)(PyObject *, char *, ...);
365 static PyObject* (*dll_PyObject_Call)(PyObject *, PyObject *, PyObject *);
366 static PyObject* (*dll_PyObject_Repr)(PyObject *);
367 static char*(*dll_PyString_AsString)(PyObject *);
368 static int(*dll_PyString_AsStringAndSize)(PyObject *, char **, int *);
369 static PyObject*(*dll_PyString_FromString)(const char *);
370 static PyObject*(*dll_PyString_FromFormat)(const char *, ...);
371 static PyObject*(*dll_PyString_FromStringAndSize)(const char *, PyInt);
372 static PyInt(*dll_PyString_Size)(PyObject *);
373 static PyTypeObject* dll_PyString_Type;
374 static PyTypeObject* dll_PyUnicode_Type;
375 static PyObject *(*py_PyUnicode_AsEncodedString)(PyObject *, char *, char *);
376 static double(*dll_PyFloat_AsDouble)(PyObject *);
377 static PyObject*(*dll_PyFloat_FromDouble)(double);
378 static PyTypeObject* dll_PyFloat_Type;
379 static int(*dll_PyNumber_Check)(PyObject *);
380 static PyObject*(*dll_PyNumber_Long)(PyObject *);
381 static int(*dll_PySys_SetObject)(char *, PyObject *);
382 static PyObject *(*dll_PySys_GetObject)(char *);
383 static int(*dll_PySys_SetArgv)(int, char **);
384 static PyTypeObject* dll_PyType_Type;
385 static int (*dll_PyType_Ready)(PyTypeObject *type);
386 static PyObject* (*dll_PyType_GenericAlloc)(PyTypeObject *type, PyInt nitems);
387 static PyObject*(*dll_Py_BuildValue)(char *, ...);
388 static PyObject*(*dll_Py_FindMethod)(struct PyMethodDef[], PyObject *, char *);
389 static PyObject*(*dll_Py_InitModule4)(char *, struct PyMethodDef *, char *, PyObject *, int);
390 static PyObject*(*dll_PyImport_AddModule)(char *);
391 static void(*dll_Py_SetPythonHome)(char *home);
392 static void(*dll_Py_Initialize)(void);
393 static void(*dll_Py_Finalize)(void);
394 static int(*dll_Py_IsInitialized)(void);
395 static PyObject*(*dll__PyObject_New)(PyTypeObject *, PyObject *);
396 static PyObject*(*dll__PyObject_GC_New)(PyTypeObject *);
397 # ifdef Py_underscore_GC
398 static void(*dll__PyObject_GC_Del)(void *);
399 static void(*dll__PyObject_GC_UnTrack)(void *);
400 # else
401 static void(*dll_PyObject_GC_Del)(void *);
402 static void(*dll_PyObject_GC_UnTrack)(void *);
403 # endif
404 static PyObject*(*dll__PyObject_Init)(PyObject *, PyTypeObject *);
405 static PyObject* (*dll_PyObject_GetIter)(PyObject *);
406 static int (*dll_PyObject_IsTrue)(PyObject *);
407 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02070000
408 static iternextfunc dll__PyObject_NextNotImplemented;
409 # endif
410 static PyObject* dll__Py_NoneStruct;
411 static PyObject* _Py_ZeroStruct;
412 static PyObject* dll__Py_TrueStruct;
413 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02020000
414 static int (*dll_PyType_IsSubtype)(PyTypeObject *, PyTypeObject *);
415 #  ifdef Py_DEBUG
416 static void (*dll__Py_NegativeRefcount)(const char *fname, int lineno, PyObject *op);
417 static PyInt* dll__Py_RefTotal;
418 static void (*dll__Py_Dealloc)(PyObject *obj);
419 #  endif
420 # endif
421 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02030000
422 #  if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
423 static void (*dll__PyObject_DebugFree)(void*);
424 static void* (*dll__PyObject_DebugMalloc)(size_t);
425 #  else
426 static void* (*dll_PyObject_Malloc)(size_t);
427 static void (*dll_PyObject_Free)(void*);
428 #  endif
429 # endif
430 # ifdef PY_USE_CAPSULE
431 static PyObject* (*dll_PyCapsule_New)(void *, char *, PyCapsule_Destructor);
432 static void* (*dll_PyCapsule_GetPointer)(PyObject *, char *);
433 # else
434 static PyObject* (*dll_PyCObject_FromVoidPtr)(void *cobj, void (*destr)(void *));
435 static void* (*dll_PyCObject_AsVoidPtr)(PyObject *);
436 # endif
437 
438 static HINSTANCE hinstPython = 0; /* Instance of python.dll */
439 
440 /* Imported exception objects */
441 static PyObject *imp_PyExc_AttributeError;
442 static PyObject *imp_PyExc_IndexError;
443 static PyObject *imp_PyExc_KeyError;
444 static PyObject *imp_PyExc_KeyboardInterrupt;
445 static PyObject *imp_PyExc_TypeError;
446 static PyObject *imp_PyExc_ValueError;
447 static PyObject *imp_PyExc_RuntimeError;
448 static PyObject *imp_PyExc_ImportError;
449 static PyObject *imp_PyExc_OverflowError;
450 
451 # define PyExc_AttributeError imp_PyExc_AttributeError
452 # define PyExc_IndexError imp_PyExc_IndexError
453 # define PyExc_KeyError imp_PyExc_KeyError
454 # define PyExc_KeyboardInterrupt imp_PyExc_KeyboardInterrupt
455 # define PyExc_TypeError imp_PyExc_TypeError
456 # define PyExc_ValueError imp_PyExc_ValueError
457 # define PyExc_RuntimeError imp_PyExc_RuntimeError
458 # define PyExc_ImportError imp_PyExc_ImportError
459 # define PyExc_OverflowError imp_PyExc_OverflowError
460 
461 /*
462  * Table of name to function pointer of python.
463  */
464 # define PYTHON_PROC FARPROC
465 static struct
466 {
467     char *name;
468     PYTHON_PROC *ptr;
469 } python_funcname_table[] =
470 {
471 #ifndef PY_SSIZE_T_CLEAN
472     {"PyArg_Parse", (PYTHON_PROC*)&dll_PyArg_Parse},
473     {"PyArg_ParseTuple", (PYTHON_PROC*)&dll_PyArg_ParseTuple},
474     {"Py_BuildValue", (PYTHON_PROC*)&dll_Py_BuildValue},
475 #else
476     {"_PyArg_Parse_SizeT", (PYTHON_PROC*)&dll_PyArg_Parse},
477     {"_PyArg_ParseTuple_SizeT", (PYTHON_PROC*)&dll_PyArg_ParseTuple},
478     {"_Py_BuildValue_SizeT", (PYTHON_PROC*)&dll_Py_BuildValue},
479 #endif
480     {"PyMem_Free", (PYTHON_PROC*)&dll_PyMem_Free},
481     {"PyMem_Malloc", (PYTHON_PROC*)&dll_PyMem_Malloc},
482     {"PyDict_SetItemString", (PYTHON_PROC*)&dll_PyDict_SetItemString},
483     {"PyErr_BadArgument", (PYTHON_PROC*)&dll_PyErr_BadArgument},
484     {"PyErr_NewException", (PYTHON_PROC*)&dll_PyErr_NewException},
485     {"PyErr_Clear", (PYTHON_PROC*)&dll_PyErr_Clear},
486     {"PyErr_Format", (PYTHON_PROC*)&dll_PyErr_Format},
487     {"PyErr_PrintEx", (PYTHON_PROC*)&dll_PyErr_PrintEx},
488     {"PyErr_NoMemory", (PYTHON_PROC*)&dll_PyErr_NoMemory},
489     {"PyErr_Occurred", (PYTHON_PROC*)&dll_PyErr_Occurred},
490     {"PyErr_SetNone", (PYTHON_PROC*)&dll_PyErr_SetNone},
491     {"PyErr_SetString", (PYTHON_PROC*)&dll_PyErr_SetString},
492     {"PyErr_SetObject", (PYTHON_PROC*)&dll_PyErr_SetObject},
493     {"PyErr_ExceptionMatches", (PYTHON_PROC*)&dll_PyErr_ExceptionMatches},
494     {"PyEval_InitThreads", (PYTHON_PROC*)&dll_PyEval_InitThreads},
495     {"PyEval_RestoreThread", (PYTHON_PROC*)&dll_PyEval_RestoreThread},
496     {"PyEval_SaveThread", (PYTHON_PROC*)&dll_PyEval_SaveThread},
497 # ifdef PY_CAN_RECURSE
498     {"PyGILState_Ensure", (PYTHON_PROC*)&dll_PyGILState_Ensure},
499     {"PyGILState_Release", (PYTHON_PROC*)&dll_PyGILState_Release},
500 # endif
501     {"PyInt_AsLong", (PYTHON_PROC*)&dll_PyInt_AsLong},
502     {"PyInt_FromLong", (PYTHON_PROC*)&dll_PyInt_FromLong},
503     {"PyLong_AsLong", (PYTHON_PROC*)&dll_PyLong_AsLong},
504     {"PyLong_FromLong", (PYTHON_PROC*)&dll_PyLong_FromLong},
505     {"PyBool_Type", (PYTHON_PROC*)&dll_PyBool_Type},
506     {"PyInt_Type", (PYTHON_PROC*)&dll_PyInt_Type},
507     {"PyLong_Type", (PYTHON_PROC*)&dll_PyLong_Type},
508     {"PyList_GetItem", (PYTHON_PROC*)&dll_PyList_GetItem},
509     {"PyList_Append", (PYTHON_PROC*)&dll_PyList_Append},
510     {"PyList_Insert", (PYTHON_PROC*)&dll_PyList_Insert},
511     {"PyList_New", (PYTHON_PROC*)&dll_PyList_New},
512     {"PyList_SetItem", (PYTHON_PROC*)&dll_PyList_SetItem},
513     {"PyList_Size", (PYTHON_PROC*)&dll_PyList_Size},
514     {"PyList_Type", (PYTHON_PROC*)&dll_PyList_Type},
515     {"PySequence_Size", (PYTHON_PROC*)&dll_PySequence_Size},
516     {"PySequence_Check", (PYTHON_PROC*)&dll_PySequence_Check},
517     {"PySequence_GetItem", (PYTHON_PROC*)&dll_PySequence_GetItem},
518     {"PySequence_Fast", (PYTHON_PROC*)&dll_PySequence_Fast},
519     {"PyTuple_GetItem", (PYTHON_PROC*)&dll_PyTuple_GetItem},
520     {"PyTuple_Size", (PYTHON_PROC*)&dll_PyTuple_Size},
521     {"PyTuple_Type", (PYTHON_PROC*)&dll_PyTuple_Type},
522     {"PyImport_ImportModule", (PYTHON_PROC*)&dll_PyImport_ImportModule},
523     {"PyDict_GetItemString", (PYTHON_PROC*)&dll_PyDict_GetItemString},
524     {"PyDict_Next", (PYTHON_PROC*)&dll_PyDict_Next},
525     {"PyDict_New", (PYTHON_PROC*)&dll_PyDict_New},
526     {"PyDict_Type", (PYTHON_PROC*)&dll_PyDict_Type},
527 # ifndef PY_NO_MAPPING_KEYS
528     {"PyMapping_Keys", (PYTHON_PROC*)&dll_PyMapping_Keys},
529 # endif
530     {"PyObject_GetItem", (PYTHON_PROC*)&dll_PyObject_GetItem},
531     {"PyObject_CallMethod", (PYTHON_PROC*)&dll_PyObject_CallMethod},
532     {"PyMapping_Check", (PYTHON_PROC*)&dll_PyMapping_Check},
533     {"PyIter_Next", (PYTHON_PROC*)&dll_PyIter_Next},
534     {"PyModule_GetDict", (PYTHON_PROC*)&dll_PyModule_GetDict},
535     {"PyModule_AddObject", (PYTHON_PROC*)&dll_PyModule_AddObject},
536     {"PyRun_SimpleString", (PYTHON_PROC*)&dll_PyRun_SimpleString},
537     {"PyRun_String", (PYTHON_PROC*)&dll_PyRun_String},
538     {"PyObject_GetAttrString", (PYTHON_PROC*)&dll_PyObject_GetAttrString},
539     {"PyObject_HasAttrString", (PYTHON_PROC*)&dll_PyObject_HasAttrString},
540     {"PyObject_SetAttrString", (PYTHON_PROC*)&dll_PyObject_SetAttrString},
541     {"PyObject_CallFunctionObjArgs", (PYTHON_PROC*)&dll_PyObject_CallFunctionObjArgs},
542     {"PyObject_CallFunction", (PYTHON_PROC*)&dll_PyObject_CallFunction},
543     {"PyObject_Call", (PYTHON_PROC*)&dll_PyObject_Call},
544     {"PyObject_Repr", (PYTHON_PROC*)&dll_PyObject_Repr},
545     {"PyString_AsString", (PYTHON_PROC*)&dll_PyString_AsString},
546     {"PyString_AsStringAndSize", (PYTHON_PROC*)&dll_PyString_AsStringAndSize},
547     {"PyString_FromString", (PYTHON_PROC*)&dll_PyString_FromString},
548     {"PyString_FromFormat", (PYTHON_PROC*)&dll_PyString_FromFormat},
549     {"PyString_FromStringAndSize", (PYTHON_PROC*)&dll_PyString_FromStringAndSize},
550     {"PyString_Size", (PYTHON_PROC*)&dll_PyString_Size},
551     {"PyString_Type", (PYTHON_PROC*)&dll_PyString_Type},
552     {"PyUnicode_Type", (PYTHON_PROC*)&dll_PyUnicode_Type},
553     {"PyFloat_Type", (PYTHON_PROC*)&dll_PyFloat_Type},
554     {"PyFloat_AsDouble", (PYTHON_PROC*)&dll_PyFloat_AsDouble},
555     {"PyFloat_FromDouble", (PYTHON_PROC*)&dll_PyFloat_FromDouble},
556     {"PyImport_AddModule", (PYTHON_PROC*)&dll_PyImport_AddModule},
557     {"PyNumber_Check", (PYTHON_PROC*)&dll_PyNumber_Check},
558     {"PyNumber_Long", (PYTHON_PROC*)&dll_PyNumber_Long},
559     {"PySys_SetObject", (PYTHON_PROC*)&dll_PySys_SetObject},
560     {"PySys_GetObject", (PYTHON_PROC*)&dll_PySys_GetObject},
561     {"PySys_SetArgv", (PYTHON_PROC*)&dll_PySys_SetArgv},
562     {"PyType_Type", (PYTHON_PROC*)&dll_PyType_Type},
563     {"PyType_Ready", (PYTHON_PROC*)&dll_PyType_Ready},
564     {"PyType_GenericAlloc", (PYTHON_PROC*)&dll_PyType_GenericAlloc},
565     {"Py_FindMethod", (PYTHON_PROC*)&dll_Py_FindMethod},
566     {"Py_SetPythonHome", (PYTHON_PROC*)&dll_Py_SetPythonHome},
567     {"Py_Initialize", (PYTHON_PROC*)&dll_Py_Initialize},
568     {"Py_Finalize", (PYTHON_PROC*)&dll_Py_Finalize},
569     {"Py_IsInitialized", (PYTHON_PROC*)&dll_Py_IsInitialized},
570     {"_PyObject_New", (PYTHON_PROC*)&dll__PyObject_New},
571     {"_PyObject_GC_New", (PYTHON_PROC*)&dll__PyObject_GC_New},
572 # ifdef Py_underscore_GC
573     {"_PyObject_GC_Del", (PYTHON_PROC*)&dll__PyObject_GC_Del},
574     {"_PyObject_GC_UnTrack", (PYTHON_PROC*)&dll__PyObject_GC_UnTrack},
575 # else
576     {"PyObject_GC_Del", (PYTHON_PROC*)&dll_PyObject_GC_Del},
577     {"PyObject_GC_UnTrack", (PYTHON_PROC*)&dll_PyObject_GC_UnTrack},
578 # endif
579     {"PyObject_Init", (PYTHON_PROC*)&dll__PyObject_Init},
580     {"PyObject_GetIter", (PYTHON_PROC*)&dll_PyObject_GetIter},
581     {"PyObject_IsTrue", (PYTHON_PROC*)&dll_PyObject_IsTrue},
582 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02070000
583     {"_PyObject_NextNotImplemented", (PYTHON_PROC*)&dll__PyObject_NextNotImplemented},
584 # endif
585     {"_Py_NoneStruct", (PYTHON_PROC*)&dll__Py_NoneStruct},
586     {"_Py_ZeroStruct", (PYTHON_PROC*)&dll__Py_ZeroStruct},
587     {"_Py_TrueStruct", (PYTHON_PROC*)&dll__Py_TrueStruct},
588 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02020000
589 #  ifdef Py_DEBUG
590     {"_Py_NegativeRefcount", (PYTHON_PROC*)&dll__Py_NegativeRefcount},
591     {"_Py_RefTotal", (PYTHON_PROC*)&dll__Py_RefTotal},
592     {"_Py_Dealloc", (PYTHON_PROC*)&dll__Py_Dealloc},
593 #  endif
594     {"PyType_IsSubtype", (PYTHON_PROC*)&dll_PyType_IsSubtype},
595 # endif
596 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02030000
597 #  if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
598     {"_PyObject_DebugFree", (PYTHON_PROC*)&dll__PyObject_DebugFree},
599     {"_PyObject_DebugMalloc", (PYTHON_PROC*)&dll__PyObject_DebugMalloc},
600 #  else
601     {"PyObject_Malloc", (PYTHON_PROC*)&dll_PyObject_Malloc},
602     {"PyObject_Free", (PYTHON_PROC*)&dll_PyObject_Free},
603 #  endif
604 # endif
605 # if defined(PY_VERSION_HEX) && PY_VERSION_HEX >= 0x02050000 \
606 	&& SIZEOF_SIZE_T != SIZEOF_INT
607 #  ifdef Py_DEBUG
608     {"Py_InitModule4TraceRefs_64", (PYTHON_PROC*)&dll_Py_InitModule4},
609 #  else
610     {"Py_InitModule4_64", (PYTHON_PROC*)&dll_Py_InitModule4},
611 #  endif
612 # else
613 #  ifdef Py_DEBUG
614     {"Py_InitModule4TraceRefs", (PYTHON_PROC*)&dll_Py_InitModule4},
615 #  else
616     {"Py_InitModule4", (PYTHON_PROC*)&dll_Py_InitModule4},
617 #  endif
618 # endif
619 # ifdef PY_USE_CAPSULE
620     {"PyCapsule_New", (PYTHON_PROC*)&dll_PyCapsule_New},
621     {"PyCapsule_GetPointer", (PYTHON_PROC*)&dll_PyCapsule_GetPointer},
622 # else
623     {"PyCObject_FromVoidPtr", (PYTHON_PROC*)&dll_PyCObject_FromVoidPtr},
624     {"PyCObject_AsVoidPtr", (PYTHON_PROC*)&dll_PyCObject_AsVoidPtr},
625 # endif
626     {"", NULL},
627 };
628 
629 /*
630  * Free python.dll
631  */
632     static void
633 end_dynamic_python(void)
634 {
635     if (hinstPython)
636     {
637 	close_dll(hinstPython);
638 	hinstPython = 0;
639     }
640 }
641 
642 /*
643  * Load library and get all pointers.
644  * Parameter 'libname' provides name of DLL.
645  * Return OK or FAIL.
646  */
647     static int
648 python_runtime_link_init(char *libname, int verbose)
649 {
650     int i;
651     void *ucs_as_encoded_string;
652 
653 #if !(defined(PY_NO_RTLD_GLOBAL) && defined(PY3_NO_RTLD_GLOBAL)) && defined(UNIX) && defined(FEAT_PYTHON3)
654     /* Can't have Python and Python3 loaded at the same time.
655      * It cause a crash, because RTLD_GLOBAL is needed for
656      * standard C extension libraries of one or both python versions. */
657     if (python3_loaded())
658     {
659 	if (verbose)
660 	    EMSG(_("E836: This Vim cannot execute :python after using :py3"));
661 	return FAIL;
662     }
663 #endif
664 
665     if (hinstPython)
666 	return OK;
667     hinstPython = load_dll(libname);
668     if (!hinstPython)
669     {
670 	if (verbose)
671 	    EMSG2(_(e_loadlib), libname);
672 	return FAIL;
673     }
674 
675     for (i = 0; python_funcname_table[i].ptr; ++i)
676     {
677 	if ((*python_funcname_table[i].ptr = symbol_from_dll(hinstPython,
678 			python_funcname_table[i].name)) == NULL)
679 	{
680 	    close_dll(hinstPython);
681 	    hinstPython = 0;
682 	    if (verbose)
683 		EMSG2(_(e_loadfunc), python_funcname_table[i].name);
684 	    return FAIL;
685 	}
686     }
687 
688     /* Load unicode functions separately as only the ucs2 or the ucs4 functions
689      * will be present in the library. */
690     ucs_as_encoded_string = symbol_from_dll(hinstPython,
691 					     "PyUnicodeUCS2_AsEncodedString");
692     if (ucs_as_encoded_string == NULL)
693 	ucs_as_encoded_string = symbol_from_dll(hinstPython,
694 					     "PyUnicodeUCS4_AsEncodedString");
695     if (ucs_as_encoded_string != NULL)
696 	py_PyUnicode_AsEncodedString = ucs_as_encoded_string;
697     else
698     {
699 	close_dll(hinstPython);
700 	hinstPython = 0;
701 	if (verbose)
702 	    EMSG2(_(e_loadfunc), "PyUnicode_UCSX_*");
703 	return FAIL;
704     }
705 
706     return OK;
707 }
708 
709 /*
710  * If python is enabled (there is installed python on Windows system) return
711  * TRUE, else FALSE.
712  */
713     int
714 python_enabled(int verbose)
715 {
716     return python_runtime_link_init(DYNAMIC_PYTHON_DLL, verbose) == OK;
717 }
718 
719 /*
720  * Load the standard Python exceptions - don't import the symbols from the
721  * DLL, as this can cause errors (importing data symbols is not reliable).
722  */
723     static void
724 get_exceptions(void)
725 {
726     PyObject *exmod = PyImport_ImportModule("exceptions");
727     PyObject *exdict = PyModule_GetDict(exmod);
728     imp_PyExc_AttributeError = PyDict_GetItemString(exdict, "AttributeError");
729     imp_PyExc_IndexError = PyDict_GetItemString(exdict, "IndexError");
730     imp_PyExc_KeyError = PyDict_GetItemString(exdict, "KeyError");
731     imp_PyExc_KeyboardInterrupt = PyDict_GetItemString(exdict, "KeyboardInterrupt");
732     imp_PyExc_TypeError = PyDict_GetItemString(exdict, "TypeError");
733     imp_PyExc_ValueError = PyDict_GetItemString(exdict, "ValueError");
734     imp_PyExc_RuntimeError = PyDict_GetItemString(exdict, "RuntimeError");
735     imp_PyExc_ImportError = PyDict_GetItemString(exdict, "ImportError");
736     imp_PyExc_OverflowError = PyDict_GetItemString(exdict, "OverflowError");
737     Py_XINCREF(imp_PyExc_AttributeError);
738     Py_XINCREF(imp_PyExc_IndexError);
739     Py_XINCREF(imp_PyExc_KeyError);
740     Py_XINCREF(imp_PyExc_KeyboardInterrupt);
741     Py_XINCREF(imp_PyExc_TypeError);
742     Py_XINCREF(imp_PyExc_ValueError);
743     Py_XINCREF(imp_PyExc_RuntimeError);
744     Py_XINCREF(imp_PyExc_ImportError);
745     Py_XINCREF(imp_PyExc_OverflowError);
746     Py_XDECREF(exmod);
747 }
748 #endif /* DYNAMIC_PYTHON */
749 
750 static int initialised = 0;
751 #define PYINITIALISED initialised
752 
753 #define DESTRUCTOR_FINISH(self) self->ob_type->tp_free((PyObject*)self);
754 
755 #define WIN_PYTHON_REF(win) win->w_python_ref
756 #define BUF_PYTHON_REF(buf) buf->b_python_ref
757 #define TAB_PYTHON_REF(tab) tab->tp_python_ref
758 
759 static PyObject *OutputGetattr(PyObject *, char *);
760 static PyObject *BufferGetattr(PyObject *, char *);
761 static PyObject *WindowGetattr(PyObject *, char *);
762 static PyObject *TabPageGetattr(PyObject *, char *);
763 static PyObject *RangeGetattr(PyObject *, char *);
764 static PyObject *DictionaryGetattr(PyObject *, char*);
765 static PyObject *ListGetattr(PyObject *, char *);
766 static PyObject *FunctionGetattr(PyObject *, char *);
767 
768 #ifndef Py_VISIT
769 # define Py_VISIT(obj) visit(obj, arg)
770 #endif
771 #ifndef Py_CLEAR
772 # define Py_CLEAR(obj) \
773     { \
774 	Py_XDECREF(obj); \
775 	obj = NULL; \
776     }
777 #endif
778 
779 #if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
780     static void *
781 py_memsave(void *p, size_t len)
782 {
783     void	*r;
784 
785     if (!(r = PyMem_Malloc(len)))
786 	return NULL;
787     mch_memmove(r, p, len);
788     return r;
789 }
790 
791 # define PY_STRSAVE(s) ((char_u *) py_memsave(s, STRLEN(s) + 1))
792 #endif
793 
794 /*
795  * Include the code shared with if_python3.c
796  */
797 #include "if_py_both.h"
798 
799 
800 /******************************************************
801  * Internal function prototypes.
802  */
803 
804 static int PythonMod_Init(void);
805 
806 
807 /******************************************************
808  * 1. Python interpreter main program.
809  */
810 
811 #if PYTHON_API_VERSION < 1007 /* Python 1.4 */
812 typedef PyObject PyThreadState;
813 #endif
814 
815 #ifndef PY_CAN_RECURSE
816 static PyThreadState *saved_python_thread = NULL;
817 
818 /*
819  * Suspend a thread of the Python interpreter, other threads are allowed to
820  * run.
821  */
822     static void
823 Python_SaveThread(void)
824 {
825     saved_python_thread = PyEval_SaveThread();
826 }
827 
828 /*
829  * Restore a thread of the Python interpreter, waits for other threads to
830  * block.
831  */
832     static void
833 Python_RestoreThread(void)
834 {
835     PyEval_RestoreThread(saved_python_thread);
836     saved_python_thread = NULL;
837 }
838 #endif
839 
840     void
841 python_end()
842 {
843     static int recurse = 0;
844 
845     /* If a crash occurs while doing this, don't try again. */
846     if (recurse != 0)
847 	return;
848 
849     ++recurse;
850 
851 #ifdef DYNAMIC_PYTHON
852     if (hinstPython && Py_IsInitialized())
853     {
854 # ifdef PY_CAN_RECURSE
855 	PyGILState_Ensure();
856 # else
857 	Python_RestoreThread();	    /* enter python */
858 # endif
859 	Py_Finalize();
860     }
861     end_dynamic_python();
862 #else
863     if (Py_IsInitialized())
864     {
865 # ifdef PY_CAN_RECURSE
866 	PyGILState_Ensure();
867 # else
868 	Python_RestoreThread();	    /* enter python */
869 # endif
870 	Py_Finalize();
871     }
872 #endif
873 
874     --recurse;
875 }
876 
877 #if (defined(DYNAMIC_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
878     int
879 python_loaded()
880 {
881     return (hinstPython != 0);
882 }
883 #endif
884 
885     static int
886 Python_Init(void)
887 {
888     if (!initialised)
889     {
890 #ifdef DYNAMIC_PYTHON
891 	if (!python_enabled(TRUE))
892 	{
893 	    EMSG(_("E263: Sorry, this command is disabled, the Python library could not be loaded."));
894 	    goto fail;
895 	}
896 #endif
897 
898 #ifdef PYTHON_HOME
899 	Py_SetPythonHome(PYTHON_HOME);
900 #endif
901 
902 	init_structs();
903 
904 #if !defined(MACOS) || defined(MACOS_X_UNIX)
905 	Py_Initialize();
906 #else
907 	PyMac_Initialize();
908 #endif
909 	/* Initialise threads, and below save the state using
910 	 * PyEval_SaveThread.  Without the call to PyEval_SaveThread, thread
911 	 * specific state (such as the system trace hook), will be lost
912 	 * between invocations of Python code. */
913 	PyEval_InitThreads();
914 #ifdef DYNAMIC_PYTHON
915 	get_exceptions();
916 #endif
917 
918 	if (PythonIO_Init_io())
919 	    goto fail;
920 
921 	if (PythonMod_Init())
922 	    goto fail;
923 
924 	globals = PyModule_GetDict(PyImport_AddModule("__main__"));
925 
926 	/* Remove the element from sys.path that was added because of our
927 	 * argv[0] value in PythonMod_Init().  Previously we used an empty
928 	 * string, but depending on the OS we then get an empty entry or
929 	 * the current directory in sys.path. */
930 	PyRun_SimpleString("import sys; sys.path = filter(lambda x: x != '/must>not&exist', sys.path)");
931 
932 	/* lock is created and acquired in PyEval_InitThreads() and thread
933 	 * state is created in Py_Initialize()
934 	 * there _PyGILState_NoteThreadState() also sets gilcounter to 1
935 	 * (python must have threads enabled!)
936 	 * so the following does both: unlock GIL and save thread state in TLS
937 	 * without deleting thread state
938 	 */
939 #ifndef PY_CAN_RECURSE
940 	saved_python_thread =
941 #endif
942 	    PyEval_SaveThread();
943 
944 	initialised = 1;
945     }
946 
947     return 0;
948 
949 fail:
950     /* We call PythonIO_Flush() here to print any Python errors.
951      * This is OK, as it is possible to call this function even
952      * if PythonIO_Init_io() has not completed successfully (it will
953      * not do anything in this case).
954      */
955     PythonIO_Flush();
956     return -1;
957 }
958 
959 /*
960  * External interface
961  */
962     static void
963 DoPyCommand(const char *cmd, rangeinitializer init_range, runner run, void *arg)
964 {
965 #ifndef PY_CAN_RECURSE
966     static int		recursive = 0;
967 #endif
968 #if defined(MACOS) && !defined(MACOS_X_UNIX)
969     GrafPtr		oldPort;
970 #endif
971 #if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
972     char		*saved_locale;
973 #endif
974 #ifdef PY_CAN_RECURSE
975     PyGILState_STATE	pygilstate;
976 #endif
977 
978 #ifndef PY_CAN_RECURSE
979     if (recursive)
980     {
981 	EMSG(_("E659: Cannot invoke Python recursively"));
982 	return;
983     }
984     ++recursive;
985 #endif
986 
987 #if defined(MACOS) && !defined(MACOS_X_UNIX)
988     GetPort(&oldPort);
989     /* Check if the Python library is available */
990     if ((Ptr)PyMac_Initialize == (Ptr)kUnresolvedCFragSymbolAddress)
991 	goto theend;
992 #endif
993     if (Python_Init())
994 	goto theend;
995 
996     init_range(arg);
997 
998     Python_Release_Vim();	    /* leave vim */
999 
1000 #if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
1001     /* Python only works properly when the LC_NUMERIC locale is "C". */
1002     saved_locale = setlocale(LC_NUMERIC, NULL);
1003     if (saved_locale == NULL || STRCMP(saved_locale, "C") == 0)
1004 	saved_locale = NULL;
1005     else
1006     {
1007 	/* Need to make a copy, value may change when setting new locale. */
1008 	saved_locale = (char *) PY_STRSAVE(saved_locale);
1009 	(void)setlocale(LC_NUMERIC, "C");
1010     }
1011 #endif
1012 
1013 #ifdef PY_CAN_RECURSE
1014     pygilstate = PyGILState_Ensure();
1015 #else
1016     Python_RestoreThread();	    /* enter python */
1017 #endif
1018 
1019     run((char *) cmd, arg
1020 #ifdef PY_CAN_RECURSE
1021 	    , &pygilstate
1022 #endif
1023 	    );
1024 
1025 #ifdef PY_CAN_RECURSE
1026     PyGILState_Release(pygilstate);
1027 #else
1028     Python_SaveThread();	    /* leave python */
1029 #endif
1030 
1031 #if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
1032     if (saved_locale != NULL)
1033     {
1034 	(void)setlocale(LC_NUMERIC, saved_locale);
1035 	PyMem_Free(saved_locale);
1036     }
1037 #endif
1038 
1039     Python_Lock_Vim();		    /* enter vim */
1040     PythonIO_Flush();
1041 #if defined(MACOS) && !defined(MACOS_X_UNIX)
1042     SetPort(oldPort);
1043 #endif
1044 
1045 theend:
1046 #ifndef PY_CAN_RECURSE
1047     --recursive;
1048 #endif
1049     return;
1050 }
1051 
1052 /*
1053  * ":python"
1054  */
1055     void
1056 ex_python(exarg_T *eap)
1057 {
1058     char_u *script;
1059 
1060     script = script_get(eap, eap->arg);
1061     if (!eap->skip)
1062     {
1063 	DoPyCommand(script == NULL ? (char *) eap->arg : (char *) script,
1064 		(rangeinitializer) init_range_cmd,
1065 		(runner) run_cmd,
1066 		(void *) eap);
1067     }
1068     vim_free(script);
1069 }
1070 
1071 #define BUFFER_SIZE 1024
1072 
1073 /*
1074  * ":pyfile"
1075  */
1076     void
1077 ex_pyfile(exarg_T *eap)
1078 {
1079     static char buffer[BUFFER_SIZE];
1080     const char *file = (char *)eap->arg;
1081     char *p;
1082 
1083     /* Have to do it like this. PyRun_SimpleFile requires you to pass a
1084      * stdio file pointer, but Vim and the Python DLL are compiled with
1085      * different options under Windows, meaning that stdio pointers aren't
1086      * compatible between the two. Yuk.
1087      *
1088      * Put the string "execfile('file')" into buffer. But, we need to
1089      * escape any backslashes or single quotes in the file name, so that
1090      * Python won't mangle the file name.
1091      */
1092     strcpy(buffer, "execfile('");
1093     p = buffer + 10; /* size of "execfile('" */
1094 
1095     while (*file && p < buffer + (BUFFER_SIZE - 3))
1096     {
1097 	if (*file == '\\' || *file == '\'')
1098 	    *p++ = '\\';
1099 	*p++ = *file++;
1100     }
1101 
1102     /* If we didn't finish the file name, we hit a buffer overflow */
1103     if (*file != '\0')
1104 	return;
1105 
1106     /* Put in the terminating "')" and a null */
1107     *p++ = '\'';
1108     *p++ = ')';
1109     *p++ = '\0';
1110 
1111     /* Execute the file */
1112     DoPyCommand(buffer,
1113 	    (rangeinitializer) init_range_cmd,
1114 	    (runner) run_cmd,
1115 	    (void *) eap);
1116 }
1117 
1118     void
1119 ex_pydo(exarg_T *eap)
1120 {
1121     DoPyCommand((char *)eap->arg,
1122 	    (rangeinitializer) init_range_cmd,
1123 	    (runner)run_do,
1124 	    (void *)eap);
1125 }
1126 
1127 /******************************************************
1128  * 2. Python output stream: writes output via [e]msg().
1129  */
1130 
1131 /* Implementation functions
1132  */
1133 
1134     static PyObject *
1135 OutputGetattr(PyObject *self, char *name)
1136 {
1137     if (strcmp(name, "softspace") == 0)
1138 	return PyInt_FromLong(((OutputObject *)(self))->softspace);
1139     else if (strcmp(name, "__members__") == 0)
1140 	return ObjectDir(NULL, OutputAttrs);
1141 
1142     return Py_FindMethod(OutputMethods, self, name);
1143 }
1144 
1145 /******************************************************
1146  * 3. Implementation of the Vim module for Python
1147  */
1148 
1149 /* Window type - Implementation functions
1150  * --------------------------------------
1151  */
1152 
1153 #define WindowType_Check(obj) ((obj)->ob_type == &WindowType)
1154 
1155 /* Buffer type - Implementation functions
1156  * --------------------------------------
1157  */
1158 
1159 #define BufferType_Check(obj) ((obj)->ob_type == &BufferType)
1160 
1161 static PyInt BufferAssItem(PyObject *, PyInt, PyObject *);
1162 static PyInt BufferAssSlice(PyObject *, PyInt, PyInt, PyObject *);
1163 
1164 /* Line range type - Implementation functions
1165  * --------------------------------------
1166  */
1167 
1168 #define RangeType_Check(obj) ((obj)->ob_type == &RangeType)
1169 
1170 static PyInt RangeAssItem(PyObject *, PyInt, PyObject *);
1171 static PyInt RangeAssSlice(PyObject *, PyInt, PyInt, PyObject *);
1172 
1173 /* Current objects type - Implementation functions
1174  * -----------------------------------------------
1175  */
1176 
1177 static PySequenceMethods BufferAsSeq = {
1178     (PyInquiry)		BufferLength,	    /* sq_length,    len(x)   */
1179     (binaryfunc)	0,		    /* BufferConcat, sq_concat, x+y */
1180     (PyIntArgFunc)	0,		    /* BufferRepeat, sq_repeat, x*n */
1181     (PyIntArgFunc)	BufferItem,	    /* sq_item,      x[i]     */
1182     (PyIntIntArgFunc)	BufferSlice,	    /* sq_slice,     x[i:j]   */
1183     (PyIntObjArgProc)	BufferAssItem,	    /* sq_ass_item,  x[i]=v   */
1184     (PyIntIntObjArgProc) BufferAssSlice,    /* sq_ass_slice, x[i:j]=v */
1185     (objobjproc)	0,
1186     (binaryfunc)	0,
1187     0,
1188 };
1189 
1190 /* Buffer object - Implementation
1191  */
1192 
1193     static PyObject *
1194 BufferGetattr(PyObject *self, char *name)
1195 {
1196     PyObject *r;
1197 
1198     if ((r = BufferAttrValid((BufferObject *)(self), name)))
1199 	return r;
1200 
1201     if (CheckBuffer((BufferObject *)(self)))
1202 	return NULL;
1203 
1204     r = BufferAttr((BufferObject *)(self), name);
1205     if (r || PyErr_Occurred())
1206 	return r;
1207     else
1208 	return Py_FindMethod(BufferMethods, self, name);
1209 }
1210 
1211 /******************/
1212 
1213     static PyInt
1214 BufferAssItem(PyObject *self, PyInt n, PyObject *val)
1215 {
1216     return RBAsItem((BufferObject *)(self), n, val, 1, -1, NULL);
1217 }
1218 
1219     static PyInt
1220 BufferAssSlice(PyObject *self, PyInt lo, PyInt hi, PyObject *val)
1221 {
1222     return RBAsSlice((BufferObject *)(self), lo, hi, val, 1, -1, NULL);
1223 }
1224 
1225 static PySequenceMethods RangeAsSeq = {
1226     (PyInquiry)		RangeLength,	      /* sq_length,    len(x)   */
1227     (binaryfunc)	0, /* RangeConcat, */ /* sq_concat,    x+y      */
1228     (PyIntArgFunc)	0, /* RangeRepeat, */ /* sq_repeat,    x*n      */
1229     (PyIntArgFunc)	RangeItem,	      /* sq_item,      x[i]     */
1230     (PyIntIntArgFunc)	RangeSlice,	      /* sq_slice,     x[i:j]   */
1231     (PyIntObjArgProc)	RangeAssItem,	      /* sq_ass_item,  x[i]=v   */
1232     (PyIntIntObjArgProc) RangeAssSlice,	      /* sq_ass_slice, x[i:j]=v */
1233     (objobjproc)	0,
1234 #if PY_MAJOR_VERSION >= 2
1235     (binaryfunc)	0,
1236     0,
1237 #endif
1238 };
1239 
1240 /* Line range object - Implementation
1241  */
1242 
1243     static PyObject *
1244 RangeGetattr(PyObject *self, char *name)
1245 {
1246     if (strcmp(name, "start") == 0)
1247 	return Py_BuildValue(Py_ssize_t_fmt, ((RangeObject *)(self))->start - 1);
1248     else if (strcmp(name, "end") == 0)
1249 	return Py_BuildValue(Py_ssize_t_fmt, ((RangeObject *)(self))->end - 1);
1250     else if (strcmp(name, "__members__") == 0)
1251 	return ObjectDir(NULL, RangeAttrs);
1252     else
1253 	return Py_FindMethod(RangeMethods, self, name);
1254 }
1255 
1256 /****************/
1257 
1258     static PyInt
1259 RangeAssItem(PyObject *self, PyInt n, PyObject *val)
1260 {
1261     return RBAsItem(((RangeObject *)(self))->buf, n, val,
1262 		     ((RangeObject *)(self))->start,
1263 		     ((RangeObject *)(self))->end,
1264 		     &((RangeObject *)(self))->end);
1265 }
1266 
1267     static PyInt
1268 RangeAssSlice(PyObject *self, PyInt lo, PyInt hi, PyObject *val)
1269 {
1270     return RBAsSlice(((RangeObject *)(self))->buf, lo, hi, val,
1271 		      ((RangeObject *)(self))->start,
1272 		      ((RangeObject *)(self))->end,
1273 		      &((RangeObject *)(self))->end);
1274 }
1275 
1276 /* TabPage object - Implementation
1277  */
1278 
1279     static PyObject *
1280 TabPageGetattr(PyObject *self, char *name)
1281 {
1282     PyObject *r;
1283 
1284     if ((r = TabPageAttrValid((TabPageObject *)(self), name)))
1285 	return r;
1286 
1287     if (CheckTabPage((TabPageObject *)(self)))
1288 	return NULL;
1289 
1290     r = TabPageAttr((TabPageObject *)(self), name);
1291     if (r || PyErr_Occurred())
1292 	return r;
1293     else
1294 	return Py_FindMethod(TabPageMethods, self, name);
1295 }
1296 
1297 /* Window object - Implementation
1298  */
1299 
1300     static PyObject *
1301 WindowGetattr(PyObject *self, char *name)
1302 {
1303     PyObject *r;
1304 
1305     if ((r = WindowAttrValid((WindowObject *)(self), name)))
1306 	return r;
1307 
1308     if (CheckWindow((WindowObject *)(self)))
1309 	return NULL;
1310 
1311     r = WindowAttr((WindowObject *)(self), name);
1312     if (r || PyErr_Occurred())
1313 	return r;
1314     else
1315 	return Py_FindMethod(WindowMethods, self, name);
1316 }
1317 
1318 /* Tab page list object - Definitions
1319  */
1320 
1321 static PySequenceMethods TabListAsSeq = {
1322     (PyInquiry)		TabListLength,	    /* sq_length,    len(x)   */
1323     (binaryfunc)	0,		    /* sq_concat,    x+y      */
1324     (PyIntArgFunc)	0,		    /* sq_repeat,    x*n      */
1325     (PyIntArgFunc)	TabListItem,	    /* sq_item,      x[i]     */
1326     (PyIntIntArgFunc)	0,		    /* sq_slice,     x[i:j]   */
1327     (PyIntObjArgProc)	0,		    /* sq_ass_item,  x[i]=v   */
1328     (PyIntIntObjArgProc) 0,		    /* sq_ass_slice, x[i:j]=v */
1329     (objobjproc)	0,
1330 #if PY_MAJOR_VERSION >= 2
1331     (binaryfunc)	0,
1332     0,
1333 #endif
1334 };
1335 
1336 /* Window list object - Definitions
1337  */
1338 
1339 static PySequenceMethods WinListAsSeq = {
1340     (PyInquiry)		WinListLength,	    /* sq_length,    len(x)   */
1341     (binaryfunc)	0,		    /* sq_concat,    x+y      */
1342     (PyIntArgFunc)	0,		    /* sq_repeat,    x*n      */
1343     (PyIntArgFunc)	WinListItem,	    /* sq_item,      x[i]     */
1344     (PyIntIntArgFunc)	0,		    /* sq_slice,     x[i:j]   */
1345     (PyIntObjArgProc)	0,		    /* sq_ass_item,  x[i]=v   */
1346     (PyIntIntObjArgProc) 0,		    /* sq_ass_slice, x[i:j]=v */
1347     (objobjproc)	0,
1348 #if PY_MAJOR_VERSION >= 2
1349     (binaryfunc)	0,
1350     0,
1351 #endif
1352 };
1353 
1354 /* External interface
1355  */
1356 
1357     void
1358 python_buffer_free(buf_T *buf)
1359 {
1360     if (BUF_PYTHON_REF(buf) != NULL)
1361     {
1362 	BufferObject *bp = BUF_PYTHON_REF(buf);
1363 	bp->buf = INVALID_BUFFER_VALUE;
1364 	BUF_PYTHON_REF(buf) = NULL;
1365     }
1366 }
1367 
1368 #if defined(FEAT_WINDOWS) || defined(PROTO)
1369     void
1370 python_window_free(win_T *win)
1371 {
1372     if (WIN_PYTHON_REF(win) != NULL)
1373     {
1374 	WindowObject *wp = WIN_PYTHON_REF(win);
1375 	wp->win = INVALID_WINDOW_VALUE;
1376 	WIN_PYTHON_REF(win) = NULL;
1377     }
1378 }
1379 
1380     void
1381 python_tabpage_free(tabpage_T *tab)
1382 {
1383     if (TAB_PYTHON_REF(tab) != NULL)
1384     {
1385 	TabPageObject *tp = TAB_PYTHON_REF(tab);
1386 	tp->tab = INVALID_TABPAGE_VALUE;
1387 	TAB_PYTHON_REF(tab) = NULL;
1388     }
1389 }
1390 #endif
1391 
1392     static int
1393 PythonMod_Init(void)
1394 {
1395     /* The special value is removed from sys.path in Python_Init(). */
1396     static char	*(argv[2]) = {"/must>not&exist/foo", NULL};
1397 
1398     if (init_types())
1399 	return -1;
1400 
1401     /* Set sys.argv[] to avoid a crash in warn(). */
1402     PySys_SetArgv(1, argv);
1403 
1404     vim_module = Py_InitModule4("vim", VimMethods, (char *)NULL,
1405 				(PyObject *)NULL, PYTHON_API_VERSION);
1406 
1407     if (populate_module(vim_module))
1408 	return -1;
1409 
1410     if (init_sys_path())
1411 	return -1;
1412 
1413     return 0;
1414 }
1415 
1416 /*************************************************************************
1417  * 4. Utility functions for handling the interface between Vim and Python.
1418  */
1419 
1420 /* Convert a Vim line into a Python string.
1421  * All internal newlines are replaced by null characters.
1422  *
1423  * On errors, the Python exception data is set, and NULL is returned.
1424  */
1425     static PyObject *
1426 LineToString(const char *str)
1427 {
1428     PyObject *result;
1429     PyInt len = strlen(str);
1430     char *p;
1431 
1432     /* Allocate an Python string object, with uninitialised contents. We
1433      * must do it this way, so that we can modify the string in place
1434      * later. See the Python source, Objects/stringobject.c for details.
1435      */
1436     result = PyString_FromStringAndSize(NULL, len);
1437     if (result == NULL)
1438 	return NULL;
1439 
1440     p = PyString_AsString(result);
1441 
1442     while (*str)
1443     {
1444 	if (*str == '\n')
1445 	    *p = '\0';
1446 	else
1447 	    *p = *str;
1448 
1449 	++p;
1450 	++str;
1451     }
1452 
1453     return result;
1454 }
1455 
1456     static PyObject *
1457 DictionaryGetattr(PyObject *self, char *name)
1458 {
1459     DictionaryObject	*this = ((DictionaryObject *) (self));
1460 
1461     if (strcmp(name, "locked") == 0)
1462 	return PyInt_FromLong(this->dict->dv_lock);
1463     else if (strcmp(name, "scope") == 0)
1464 	return PyInt_FromLong(this->dict->dv_scope);
1465     else if (strcmp(name, "__members__") == 0)
1466 	return ObjectDir(NULL, DictionaryAttrs);
1467 
1468     return Py_FindMethod(DictionaryMethods, self, name);
1469 }
1470 
1471 static PySequenceMethods ListAsSeq = {
1472     (PyInquiry)			ListLength,
1473     (binaryfunc)		0,
1474     (PyIntArgFunc)		0,
1475     (PyIntArgFunc)		ListItem,
1476     (PyIntIntArgFunc)		ListSlice,
1477     (PyIntObjArgProc)		ListAssItem,
1478     (PyIntIntObjArgProc)	ListAssSlice,
1479     (objobjproc)		0,
1480 #if PY_MAJOR_VERSION >= 2
1481     (binaryfunc)		ListConcatInPlace,
1482     0,
1483 #endif
1484 };
1485 
1486     static PyObject *
1487 ListGetattr(PyObject *self, char *name)
1488 {
1489     if (strcmp(name, "locked") == 0)
1490 	return PyInt_FromLong(((ListObject *)(self))->list->lv_lock);
1491     else if (strcmp(name, "__members__") == 0)
1492 	return ObjectDir(NULL, ListAttrs);
1493 
1494     return Py_FindMethod(ListMethods, self, name);
1495 }
1496 
1497     static PyObject *
1498 FunctionGetattr(PyObject *self, char *name)
1499 {
1500     FunctionObject	*this = (FunctionObject *)(self);
1501 
1502     if (strcmp(name, "name") == 0)
1503 	return PyString_FromString((char *)(this->name));
1504     else if (strcmp(name, "__members__") == 0)
1505 	return ObjectDir(NULL, FunctionAttrs);
1506     else
1507 	return Py_FindMethod(FunctionMethods, self, name);
1508 }
1509 
1510     void
1511 do_pyeval (char_u *str, typval_T *rettv)
1512 {
1513     DoPyCommand((char *) str,
1514 	    (rangeinitializer) init_range_eval,
1515 	    (runner) run_eval,
1516 	    (void *) rettv);
1517     switch(rettv->v_type)
1518     {
1519 	case VAR_DICT: ++rettv->vval.v_dict->dv_refcount; break;
1520 	case VAR_LIST: ++rettv->vval.v_list->lv_refcount; break;
1521 	case VAR_FUNC: func_ref(rettv->vval.v_string);    break;
1522 	case VAR_UNKNOWN:
1523 	    rettv->v_type = VAR_NUMBER;
1524 	    rettv->vval.v_number = 0;
1525 	    break;
1526     }
1527 }
1528 
1529 /* Don't generate a prototype for the next function, it generates an error on
1530  * newer Python versions. */
1531 #if PYTHON_API_VERSION < 1007 /* Python 1.4 */ && !defined(PROTO)
1532 
1533     char *
1534 Py_GetProgramName(void)
1535 {
1536     return "vim";
1537 }
1538 #endif /* Python 1.4 */
1539 
1540     void
1541 set_ref_in_python (int copyID)
1542 {
1543     set_ref_in_py(copyID);
1544 }
1545