xref: /vim-8.2.3635/src/if_python3.c (revision aedfcbe1)
1 /* vi:set ts=8 sts=4 sw=4:
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 /*
21  * Roland Puntaier 2009/sept/16:
22  * Adaptations to support both python3.x and python2.x
23  */
24 
25 /* uncomment this if used with the debug version of python */
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 #include "vim.h"
34 
35 #include <limits.h>
36 
37 /* Python.h defines _POSIX_THREADS itself (if needed) */
38 #ifdef _POSIX_THREADS
39 # undef _POSIX_THREADS
40 #endif
41 
42 #if defined(_WIN32) && defined(HAVE_FCNTL_H)
43 # undef HAVE_FCNTL_H
44 #endif
45 
46 #ifdef _DEBUG
47 # undef _DEBUG
48 #endif
49 
50 #ifdef F_BLANK
51 # undef F_BLANK
52 #endif
53 
54 #ifdef HAVE_STRFTIME
55 # undef HAVE_STRFTIME
56 #endif
57 #ifdef HAVE_STRING_H
58 # undef HAVE_STRING_H
59 #endif
60 #ifdef HAVE_PUTENV
61 # undef HAVE_PUTENV
62 #endif
63 #ifdef HAVE_STDARG_H
64 # undef HAVE_STDARG_H   /* Python's config.h defines it as well. */
65 #endif
66 #ifdef _POSIX_C_SOURCE  /* defined in feature.h */
67 # undef _POSIX_C_SOURCE
68 #endif
69 #ifdef _XOPEN_SOURCE
70 # undef _XOPEN_SOURCE	/* pyconfig.h defines it as well. */
71 #endif
72 
73 #define PY_SSIZE_T_CLEAN
74 
75 #include <Python.h>
76 
77 #if defined(MACOS) && !defined(MACOS_X_UNIX)
78 # include "macglue.h"
79 # include <CodeFragments.h>
80 #endif
81 #undef main /* Defined in python.h - aargh */
82 #undef HAVE_FCNTL_H /* Clash with os_win32.h */
83 
84 /* The "surrogateescape" error handler is new in Python 3.1 */
85 #if PY_VERSION_HEX >= 0x030100f0
86 # define CODEC_ERROR_HANDLER "surrogateescape"
87 #else
88 # define CODEC_ERROR_HANDLER NULL
89 #endif
90 
91 /* Python 3 does not support CObjects, always use Capsules */
92 #define PY_USE_CAPSULE
93 
94 #define PyInt Py_ssize_t
95 #ifndef PyString_Check
96 # define PyString_Check(obj) PyUnicode_Check(obj)
97 #endif
98 #define PyString_FromString(repr) \
99     PyUnicode_Decode(repr, STRLEN(repr), ENC_OPT, NULL)
100 #define PyString_FromFormat PyUnicode_FromFormat
101 #ifndef PyInt_Check
102 # define PyInt_Check(obj) PyLong_Check(obj)
103 #endif
104 #define PyInt_FromLong(i) PyLong_FromLong(i)
105 #define PyInt_AsLong(obj) PyLong_AsLong(obj)
106 #define Py_ssize_t_fmt "n"
107 #define Py_bytes_fmt "y"
108 
109 #define PyIntArgFunc	ssizeargfunc
110 #define PyIntObjArgProc	ssizeobjargproc
111 
112 /*
113  * PySlice_GetIndicesEx(): first argument type changed from PySliceObject
114  * to PyObject in Python 3.2 or later.
115  */
116 #if PY_VERSION_HEX >= 0x030200f0
117 typedef PyObject PySliceObject_T;
118 #else
119 typedef PySliceObject PySliceObject_T;
120 #endif
121 
122 #if defined(DYNAMIC_PYTHON3) || defined(PROTO)
123 
124 # ifndef WIN3264
125 #  include <dlfcn.h>
126 #  define FARPROC void*
127 #  define HINSTANCE void*
128 #  if defined(PY_NO_RTLD_GLOBAL) && defined(PY3_NO_RTLD_GLOBAL)
129 #   define load_dll(n) dlopen((n), RTLD_LAZY)
130 #  else
131 #   define load_dll(n) dlopen((n), RTLD_LAZY|RTLD_GLOBAL)
132 #  endif
133 #  define close_dll dlclose
134 #  define symbol_from_dll dlsym
135 # else
136 #  define load_dll vimLoadLib
137 #  define close_dll FreeLibrary
138 #  define symbol_from_dll GetProcAddress
139 # endif
140 /*
141  * Wrapper defines
142  */
143 # undef PyArg_Parse
144 # define PyArg_Parse py3_PyArg_Parse
145 # undef PyArg_ParseTuple
146 # define PyArg_ParseTuple py3_PyArg_ParseTuple
147 # define PyMem_Free py3_PyMem_Free
148 # define PyMem_Malloc py3_PyMem_Malloc
149 # define PyDict_SetItemString py3_PyDict_SetItemString
150 # define PyErr_BadArgument py3_PyErr_BadArgument
151 # define PyErr_Clear py3_PyErr_Clear
152 # define PyErr_Format py3_PyErr_Format
153 # define PyErr_PrintEx py3_PyErr_PrintEx
154 # define PyErr_NoMemory py3_PyErr_NoMemory
155 # define PyErr_Occurred py3_PyErr_Occurred
156 # define PyErr_SetNone py3_PyErr_SetNone
157 # define PyErr_SetString py3_PyErr_SetString
158 # define PyErr_SetObject py3_PyErr_SetObject
159 # define PyErr_ExceptionMatches py3_PyErr_ExceptionMatches
160 # define PyEval_InitThreads py3_PyEval_InitThreads
161 # define PyEval_RestoreThread py3_PyEval_RestoreThread
162 # define PyEval_SaveThread py3_PyEval_SaveThread
163 # define PyGILState_Ensure py3_PyGILState_Ensure
164 # define PyGILState_Release py3_PyGILState_Release
165 # define PyLong_AsLong py3_PyLong_AsLong
166 # define PyLong_FromLong py3_PyLong_FromLong
167 # define PyList_GetItem py3_PyList_GetItem
168 # define PyList_Append py3_PyList_Append
169 # define PyList_Insert py3_PyList_Insert
170 # define PyList_New py3_PyList_New
171 # define PyList_SetItem py3_PyList_SetItem
172 # define PyList_Size py3_PyList_Size
173 # define PySequence_Check py3_PySequence_Check
174 # define PySequence_Size py3_PySequence_Size
175 # define PySequence_GetItem py3_PySequence_GetItem
176 # define PySequence_Fast py3_PySequence_Fast
177 # define PyTuple_Size py3_PyTuple_Size
178 # define PyTuple_GetItem py3_PyTuple_GetItem
179 # define PySlice_GetIndicesEx py3_PySlice_GetIndicesEx
180 # define PyImport_ImportModule py3_PyImport_ImportModule
181 # define PyObject_Init py3__PyObject_Init
182 # define PyDict_New py3_PyDict_New
183 # define PyDict_GetItemString py3_PyDict_GetItemString
184 # define PyDict_Next py3_PyDict_Next
185 # define PyMapping_Check py3_PyMapping_Check
186 # ifndef PyMapping_Keys
187 #  define PyMapping_Keys py3_PyMapping_Keys
188 # endif
189 # define PyIter_Next py3_PyIter_Next
190 # define PyObject_GetIter py3_PyObject_GetIter
191 # define PyObject_Repr py3_PyObject_Repr
192 # define PyObject_GetItem py3_PyObject_GetItem
193 # define PyObject_IsTrue py3_PyObject_IsTrue
194 # define PyModule_GetDict py3_PyModule_GetDict
195 #undef PyRun_SimpleString
196 # define PyRun_SimpleString py3_PyRun_SimpleString
197 #undef PyRun_String
198 # define PyRun_String py3_PyRun_String
199 # define PyObject_GetAttrString py3_PyObject_GetAttrString
200 # define PyObject_HasAttrString py3_PyObject_HasAttrString
201 # define PyObject_SetAttrString py3_PyObject_SetAttrString
202 # define PyObject_CallFunctionObjArgs py3_PyObject_CallFunctionObjArgs
203 # define _PyObject_CallFunction_SizeT py3__PyObject_CallFunction_SizeT
204 # define PyObject_Call py3_PyObject_Call
205 # define PyEval_GetLocals py3_PyEval_GetLocals
206 # define PyEval_GetGlobals py3_PyEval_GetGlobals
207 # define PySys_SetObject py3_PySys_SetObject
208 # define PySys_GetObject py3_PySys_GetObject
209 # define PySys_SetArgv py3_PySys_SetArgv
210 # define PyType_Ready py3_PyType_Ready
211 #undef Py_BuildValue
212 # define Py_BuildValue py3_Py_BuildValue
213 # define Py_SetPythonHome py3_Py_SetPythonHome
214 # define Py_Initialize py3_Py_Initialize
215 # define Py_Finalize py3_Py_Finalize
216 # define Py_IsInitialized py3_Py_IsInitialized
217 # define _Py_NoneStruct (*py3__Py_NoneStruct)
218 # define _Py_FalseStruct (*py3__Py_FalseStruct)
219 # define _Py_TrueStruct (*py3__Py_TrueStruct)
220 # define _PyObject_NextNotImplemented (*py3__PyObject_NextNotImplemented)
221 # define PyModule_AddObject py3_PyModule_AddObject
222 # define PyImport_AppendInittab py3_PyImport_AppendInittab
223 # define PyImport_AddModule py3_PyImport_AddModule
224 # if PY_VERSION_HEX >= 0x030300f0
225 #  undef _PyUnicode_AsString
226 #  define _PyUnicode_AsString py3_PyUnicode_AsUTF8
227 # else
228 #  define _PyUnicode_AsString py3__PyUnicode_AsString
229 # endif
230 # undef PyUnicode_AsEncodedString
231 # define PyUnicode_AsEncodedString py3_PyUnicode_AsEncodedString
232 # undef PyBytes_AsString
233 # define PyBytes_AsString py3_PyBytes_AsString
234 # ifndef PyBytes_AsStringAndSize
235 #  define PyBytes_AsStringAndSize py3_PyBytes_AsStringAndSize
236 # endif
237 # undef PyBytes_FromString
238 # define PyBytes_FromString py3_PyBytes_FromString
239 # define PyFloat_FromDouble py3_PyFloat_FromDouble
240 # define PyFloat_AsDouble py3_PyFloat_AsDouble
241 # define PyObject_GenericGetAttr py3_PyObject_GenericGetAttr
242 # define PyType_Type (*py3_PyType_Type)
243 # define PySlice_Type (*py3_PySlice_Type)
244 # define PyFloat_Type (*py3_PyFloat_Type)
245 # define PyNumber_Check (*py3_PyNumber_Check)
246 # define PyNumber_Long (*py3_PyNumber_Long)
247 # define PyBool_Type (*py3_PyBool_Type)
248 # define PyErr_NewException py3_PyErr_NewException
249 # ifdef Py_DEBUG
250 #  define _Py_NegativeRefcount py3__Py_NegativeRefcount
251 #  define _Py_RefTotal (*py3__Py_RefTotal)
252 #  define _Py_Dealloc py3__Py_Dealloc
253 #  define PyModule_Create2TraceRefs py3_PyModule_Create2TraceRefs
254 # else
255 #  define PyModule_Create2 py3_PyModule_Create2
256 # endif
257 # if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
258 #  define _PyObject_DebugMalloc py3__PyObject_DebugMalloc
259 #  define _PyObject_DebugFree py3__PyObject_DebugFree
260 # else
261 #  define PyObject_Malloc py3_PyObject_Malloc
262 #  define PyObject_Free py3_PyObject_Free
263 # endif
264 # define _PyObject_GC_New py3__PyObject_GC_New
265 # define PyObject_GC_Del py3_PyObject_GC_Del
266 # define PyObject_GC_UnTrack py3_PyObject_GC_UnTrack
267 # define PyType_GenericAlloc py3_PyType_GenericAlloc
268 # define PyType_GenericNew py3_PyType_GenericNew
269 # undef PyUnicode_FromString
270 # define PyUnicode_FromString py3_PyUnicode_FromString
271 # ifndef PyUnicode_FromFormat
272 #  define PyUnicode_FromFormat py3_PyUnicode_FromFormat
273 # else
274 #  define Py_UNICODE_USE_UCS_FUNCTIONS
275 #  ifdef Py_UNICODE_WIDE
276 #   define PyUnicodeUCS4_FromFormat py3_PyUnicodeUCS4_FromFormat
277 #  else
278 #   define PyUnicodeUCS2_FromFormat py3_PyUnicodeUCS2_FromFormat
279 #  endif
280 # endif
281 # undef PyUnicode_Decode
282 # define PyUnicode_Decode py3_PyUnicode_Decode
283 # define PyType_IsSubtype py3_PyType_IsSubtype
284 # define PyCapsule_New py3_PyCapsule_New
285 # define PyCapsule_GetPointer py3_PyCapsule_GetPointer
286 
287 # if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
288 #  undef PyObject_NEW
289 #  define PyObject_NEW(type, typeobj) \
290 ( (type *) PyObject_Init( \
291 	(PyObject *) _PyObject_DebugMalloc( _PyObject_SIZE(typeobj) ), (typeobj)) )
292 # endif
293 
294 /*
295  * Pointers for dynamic link
296  */
297 static int (*py3_PySys_SetArgv)(int, wchar_t **);
298 static void (*py3_Py_SetPythonHome)(wchar_t *home);
299 static void (*py3_Py_Initialize)(void);
300 static PyObject* (*py3_PyList_New)(Py_ssize_t size);
301 static PyGILState_STATE (*py3_PyGILState_Ensure)(void);
302 static void (*py3_PyGILState_Release)(PyGILState_STATE);
303 static int (*py3_PySys_SetObject)(char *, PyObject *);
304 static PyObject* (*py3_PySys_GetObject)(char *);
305 static int (*py3_PyList_Append)(PyObject *, PyObject *);
306 static int (*py3_PyList_Insert)(PyObject *, int, PyObject *);
307 static Py_ssize_t (*py3_PyList_Size)(PyObject *);
308 static int (*py3_PySequence_Check)(PyObject *);
309 static Py_ssize_t (*py3_PySequence_Size)(PyObject *);
310 static PyObject* (*py3_PySequence_GetItem)(PyObject *, Py_ssize_t);
311 static PyObject* (*py3_PySequence_Fast)(PyObject *, const char *);
312 static Py_ssize_t (*py3_PyTuple_Size)(PyObject *);
313 static PyObject* (*py3_PyTuple_GetItem)(PyObject *, Py_ssize_t);
314 static int (*py3_PyMapping_Check)(PyObject *);
315 static PyObject* (*py3_PyMapping_Keys)(PyObject *);
316 static int (*py3_PySlice_GetIndicesEx)(PySliceObject_T *r, Py_ssize_t length,
317 		     Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step,
318 		     Py_ssize_t *slicelen);
319 static PyObject* (*py3_PyErr_NoMemory)(void);
320 static void (*py3_Py_Finalize)(void);
321 static void (*py3_PyErr_SetString)(PyObject *, const char *);
322 static void (*py3_PyErr_SetObject)(PyObject *, PyObject *);
323 static int (*py3_PyErr_ExceptionMatches)(PyObject *);
324 static int (*py3_PyRun_SimpleString)(char *);
325 static PyObject* (*py3_PyRun_String)(char *, int, PyObject *, PyObject *);
326 static PyObject* (*py3_PyObject_GetAttrString)(PyObject *, const char *);
327 static int (*py3_PyObject_HasAttrString)(PyObject *, const char *);
328 static int (*py3_PyObject_SetAttrString)(PyObject *, const char *, PyObject *);
329 static PyObject* (*py3_PyObject_CallFunctionObjArgs)(PyObject *, ...);
330 static PyObject* (*py3__PyObject_CallFunction_SizeT)(PyObject *, char *, ...);
331 static PyObject* (*py3_PyObject_Call)(PyObject *, PyObject *, PyObject *);
332 static PyObject* (*py3_PyEval_GetGlobals)();
333 static PyObject* (*py3_PyEval_GetLocals)();
334 static PyObject* (*py3_PyList_GetItem)(PyObject *, Py_ssize_t);
335 static PyObject* (*py3_PyImport_ImportModule)(const char *);
336 static PyObject* (*py3_PyImport_AddModule)(const char *);
337 static int (*py3_PyErr_BadArgument)(void);
338 static PyObject* (*py3_PyErr_Occurred)(void);
339 static PyObject* (*py3_PyModule_GetDict)(PyObject *);
340 static int (*py3_PyList_SetItem)(PyObject *, Py_ssize_t, PyObject *);
341 static PyObject* (*py3_PyDict_GetItemString)(PyObject *, const char *);
342 static int (*py3_PyDict_Next)(PyObject *, Py_ssize_t *, PyObject **, PyObject **);
343 static PyObject* (*py3_PyLong_FromLong)(long);
344 static PyObject* (*py3_PyDict_New)(void);
345 static PyObject* (*py3_PyIter_Next)(PyObject *);
346 static PyObject* (*py3_PyObject_GetIter)(PyObject *);
347 static PyObject* (*py3_PyObject_Repr)(PyObject *);
348 static PyObject* (*py3_PyObject_GetItem)(PyObject *, PyObject *);
349 static int (*py3_PyObject_IsTrue)(PyObject *);
350 static PyObject* (*py3_Py_BuildValue)(char *, ...);
351 static int (*py3_PyType_Ready)(PyTypeObject *type);
352 static int (*py3_PyDict_SetItemString)(PyObject *dp, char *key, PyObject *item);
353 static PyObject* (*py3_PyUnicode_FromString)(const char *u);
354 # ifndef Py_UNICODE_USE_UCS_FUNCTIONS
355 static PyObject* (*py3_PyUnicode_FromFormat)(const char *u, ...);
356 # else
357 #  ifdef Py_UNICODE_WIDE
358 static PyObject* (*py3_PyUnicodeUCS4_FromFormat)(const char *u, ...);
359 #  else
360 static PyObject* (*py3_PyUnicodeUCS2_FromFormat)(const char *u, ...);
361 #  endif
362 # endif
363 static PyObject* (*py3_PyUnicode_Decode)(const char *u, Py_ssize_t size,
364 	const char *encoding, const char *errors);
365 static long (*py3_PyLong_AsLong)(PyObject *);
366 static void (*py3_PyErr_SetNone)(PyObject *);
367 static void (*py3_PyEval_InitThreads)(void);
368 static void(*py3_PyEval_RestoreThread)(PyThreadState *);
369 static PyThreadState*(*py3_PyEval_SaveThread)(void);
370 static int (*py3_PyArg_Parse)(PyObject *, char *, ...);
371 static int (*py3_PyArg_ParseTuple)(PyObject *, char *, ...);
372 static int (*py3_PyMem_Free)(void *);
373 static void* (*py3_PyMem_Malloc)(size_t);
374 static int (*py3_Py_IsInitialized)(void);
375 static void (*py3_PyErr_Clear)(void);
376 static PyObject* (*py3_PyErr_Format)(PyObject *, const char *, ...);
377 static void (*py3_PyErr_PrintEx)(int);
378 static PyObject*(*py3__PyObject_Init)(PyObject *, PyTypeObject *);
379 static iternextfunc py3__PyObject_NextNotImplemented;
380 static PyObject* py3__Py_NoneStruct;
381 static PyObject* py3__Py_FalseStruct;
382 static PyObject* py3__Py_TrueStruct;
383 static int (*py3_PyModule_AddObject)(PyObject *m, const char *name, PyObject *o);
384 static int (*py3_PyImport_AppendInittab)(const char *name, PyObject* (*initfunc)(void));
385 # if PY_VERSION_HEX >= 0x030300f0
386 static char* (*py3_PyUnicode_AsUTF8)(PyObject *unicode);
387 # else
388 static char* (*py3__PyUnicode_AsString)(PyObject *unicode);
389 # endif
390 static PyObject* (*py3_PyUnicode_AsEncodedString)(PyObject *unicode, const char* encoding, const char* errors);
391 static char* (*py3_PyBytes_AsString)(PyObject *bytes);
392 static int (*py3_PyBytes_AsStringAndSize)(PyObject *bytes, char **buffer, Py_ssize_t *length);
393 static PyObject* (*py3_PyBytes_FromString)(char *str);
394 static PyObject* (*py3_PyFloat_FromDouble)(double num);
395 static double (*py3_PyFloat_AsDouble)(PyObject *);
396 static PyObject* (*py3_PyObject_GenericGetAttr)(PyObject *obj, PyObject *name);
397 static PyObject* (*py3_PyType_GenericAlloc)(PyTypeObject *type, Py_ssize_t nitems);
398 static PyObject* (*py3_PyType_GenericNew)(PyTypeObject *type, PyObject *args, PyObject *kwds);
399 static PyTypeObject* py3_PyType_Type;
400 static PyTypeObject* py3_PySlice_Type;
401 static PyTypeObject* py3_PyFloat_Type;
402 static PyTypeObject* py3_PyBool_Type;
403 static int (*py3_PyNumber_Check)(PyObject *);
404 static PyObject* (*py3_PyNumber_Long)(PyObject *);
405 static PyObject* (*py3_PyErr_NewException)(char *name, PyObject *base, PyObject *dict);
406 static PyObject* (*py3_PyCapsule_New)(void *, char *, PyCapsule_Destructor);
407 static void* (*py3_PyCapsule_GetPointer)(PyObject *, char *);
408 # ifdef Py_DEBUG
409 static void (*py3__Py_NegativeRefcount)(const char *fname, int lineno, PyObject *op);
410 static Py_ssize_t* py3__Py_RefTotal;
411 static void (*py3__Py_Dealloc)(PyObject *obj);
412 static PyObject* (*py3_PyModule_Create2TraceRefs)(struct PyModuleDef* module, int module_api_version);
413 # else
414 static PyObject* (*py3_PyModule_Create2)(struct PyModuleDef* module, int module_api_version);
415 # endif
416 # if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
417 static void (*py3__PyObject_DebugFree)(void*);
418 static void* (*py3__PyObject_DebugMalloc)(size_t);
419 # else
420 static void (*py3_PyObject_Free)(void*);
421 static void* (*py3_PyObject_Malloc)(size_t);
422 # endif
423 static PyObject*(*py3__PyObject_GC_New)(PyTypeObject *);
424 static void(*py3_PyObject_GC_Del)(void *);
425 static void(*py3_PyObject_GC_UnTrack)(void *);
426 static int (*py3_PyType_IsSubtype)(PyTypeObject *, PyTypeObject *);
427 
428 static HINSTANCE hinstPy3 = 0; /* Instance of python.dll */
429 
430 /* Imported exception objects */
431 static PyObject *p3imp_PyExc_AttributeError;
432 static PyObject *p3imp_PyExc_IndexError;
433 static PyObject *p3imp_PyExc_KeyError;
434 static PyObject *p3imp_PyExc_KeyboardInterrupt;
435 static PyObject *p3imp_PyExc_TypeError;
436 static PyObject *p3imp_PyExc_ValueError;
437 static PyObject *p3imp_PyExc_SystemExit;
438 static PyObject *p3imp_PyExc_RuntimeError;
439 static PyObject *p3imp_PyExc_ImportError;
440 static PyObject *p3imp_PyExc_OverflowError;
441 
442 # define PyExc_AttributeError p3imp_PyExc_AttributeError
443 # define PyExc_IndexError p3imp_PyExc_IndexError
444 # define PyExc_KeyError p3imp_PyExc_KeyError
445 # define PyExc_KeyboardInterrupt p3imp_PyExc_KeyboardInterrupt
446 # define PyExc_TypeError p3imp_PyExc_TypeError
447 # define PyExc_ValueError p3imp_PyExc_ValueError
448 # define PyExc_SystemExit p3imp_PyExc_SystemExit
449 # define PyExc_RuntimeError p3imp_PyExc_RuntimeError
450 # define PyExc_ImportError p3imp_PyExc_ImportError
451 # define PyExc_OverflowError p3imp_PyExc_OverflowError
452 
453 /*
454  * Table of name to function pointer of python.
455  */
456 # define PYTHON_PROC FARPROC
457 static struct
458 {
459     char *name;
460     PYTHON_PROC *ptr;
461 } py3_funcname_table[] =
462 {
463     {"PySys_SetArgv", (PYTHON_PROC*)&py3_PySys_SetArgv},
464     {"Py_SetPythonHome", (PYTHON_PROC*)&py3_Py_SetPythonHome},
465     {"Py_Initialize", (PYTHON_PROC*)&py3_Py_Initialize},
466     {"_PyArg_ParseTuple_SizeT", (PYTHON_PROC*)&py3_PyArg_ParseTuple},
467     {"_Py_BuildValue_SizeT", (PYTHON_PROC*)&py3_Py_BuildValue},
468     {"PyMem_Free", (PYTHON_PROC*)&py3_PyMem_Free},
469     {"PyMem_Malloc", (PYTHON_PROC*)&py3_PyMem_Malloc},
470     {"PyList_New", (PYTHON_PROC*)&py3_PyList_New},
471     {"PyGILState_Ensure", (PYTHON_PROC*)&py3_PyGILState_Ensure},
472     {"PyGILState_Release", (PYTHON_PROC*)&py3_PyGILState_Release},
473     {"PySys_SetObject", (PYTHON_PROC*)&py3_PySys_SetObject},
474     {"PySys_GetObject", (PYTHON_PROC*)&py3_PySys_GetObject},
475     {"PyList_Append", (PYTHON_PROC*)&py3_PyList_Append},
476     {"PyList_Insert", (PYTHON_PROC*)&py3_PyList_Insert},
477     {"PyList_Size", (PYTHON_PROC*)&py3_PyList_Size},
478     {"PySequence_Check", (PYTHON_PROC*)&py3_PySequence_Check},
479     {"PySequence_Size", (PYTHON_PROC*)&py3_PySequence_Size},
480     {"PySequence_GetItem", (PYTHON_PROC*)&py3_PySequence_GetItem},
481     {"PySequence_Fast", (PYTHON_PROC*)&py3_PySequence_Fast},
482     {"PyTuple_Size", (PYTHON_PROC*)&py3_PyTuple_Size},
483     {"PyTuple_GetItem", (PYTHON_PROC*)&py3_PyTuple_GetItem},
484     {"PySlice_GetIndicesEx", (PYTHON_PROC*)&py3_PySlice_GetIndicesEx},
485     {"PyErr_NoMemory", (PYTHON_PROC*)&py3_PyErr_NoMemory},
486     {"Py_Finalize", (PYTHON_PROC*)&py3_Py_Finalize},
487     {"PyErr_SetString", (PYTHON_PROC*)&py3_PyErr_SetString},
488     {"PyErr_SetObject", (PYTHON_PROC*)&py3_PyErr_SetObject},
489     {"PyErr_ExceptionMatches", (PYTHON_PROC*)&py3_PyErr_ExceptionMatches},
490     {"PyRun_SimpleString", (PYTHON_PROC*)&py3_PyRun_SimpleString},
491     {"PyRun_String", (PYTHON_PROC*)&py3_PyRun_String},
492     {"PyObject_GetAttrString", (PYTHON_PROC*)&py3_PyObject_GetAttrString},
493     {"PyObject_HasAttrString", (PYTHON_PROC*)&py3_PyObject_HasAttrString},
494     {"PyObject_SetAttrString", (PYTHON_PROC*)&py3_PyObject_SetAttrString},
495     {"PyObject_CallFunctionObjArgs", (PYTHON_PROC*)&py3_PyObject_CallFunctionObjArgs},
496     {"_PyObject_CallFunction_SizeT", (PYTHON_PROC*)&py3__PyObject_CallFunction_SizeT},
497     {"PyObject_Call", (PYTHON_PROC*)&py3_PyObject_Call},
498     {"PyEval_GetGlobals", (PYTHON_PROC*)&py3_PyEval_GetGlobals},
499     {"PyEval_GetLocals", (PYTHON_PROC*)&py3_PyEval_GetLocals},
500     {"PyList_GetItem", (PYTHON_PROC*)&py3_PyList_GetItem},
501     {"PyImport_ImportModule", (PYTHON_PROC*)&py3_PyImport_ImportModule},
502     {"PyImport_AddModule", (PYTHON_PROC*)&py3_PyImport_AddModule},
503     {"PyErr_BadArgument", (PYTHON_PROC*)&py3_PyErr_BadArgument},
504     {"PyErr_Occurred", (PYTHON_PROC*)&py3_PyErr_Occurred},
505     {"PyModule_GetDict", (PYTHON_PROC*)&py3_PyModule_GetDict},
506     {"PyList_SetItem", (PYTHON_PROC*)&py3_PyList_SetItem},
507     {"PyDict_GetItemString", (PYTHON_PROC*)&py3_PyDict_GetItemString},
508     {"PyDict_Next", (PYTHON_PROC*)&py3_PyDict_Next},
509     {"PyMapping_Check", (PYTHON_PROC*)&py3_PyMapping_Check},
510     {"PyMapping_Keys", (PYTHON_PROC*)&py3_PyMapping_Keys},
511     {"PyIter_Next", (PYTHON_PROC*)&py3_PyIter_Next},
512     {"PyObject_GetIter", (PYTHON_PROC*)&py3_PyObject_GetIter},
513     {"PyObject_Repr", (PYTHON_PROC*)&py3_PyObject_Repr},
514     {"PyObject_GetItem", (PYTHON_PROC*)&py3_PyObject_GetItem},
515     {"PyObject_IsTrue", (PYTHON_PROC*)&py3_PyObject_IsTrue},
516     {"PyLong_FromLong", (PYTHON_PROC*)&py3_PyLong_FromLong},
517     {"PyDict_New", (PYTHON_PROC*)&py3_PyDict_New},
518     {"PyType_Ready", (PYTHON_PROC*)&py3_PyType_Ready},
519     {"PyDict_SetItemString", (PYTHON_PROC*)&py3_PyDict_SetItemString},
520     {"PyLong_AsLong", (PYTHON_PROC*)&py3_PyLong_AsLong},
521     {"PyErr_SetNone", (PYTHON_PROC*)&py3_PyErr_SetNone},
522     {"PyEval_InitThreads", (PYTHON_PROC*)&py3_PyEval_InitThreads},
523     {"PyEval_RestoreThread", (PYTHON_PROC*)&py3_PyEval_RestoreThread},
524     {"PyEval_SaveThread", (PYTHON_PROC*)&py3_PyEval_SaveThread},
525     {"_PyArg_Parse_SizeT", (PYTHON_PROC*)&py3_PyArg_Parse},
526     {"Py_IsInitialized", (PYTHON_PROC*)&py3_Py_IsInitialized},
527     {"_PyObject_NextNotImplemented", (PYTHON_PROC*)&py3__PyObject_NextNotImplemented},
528     {"_Py_NoneStruct", (PYTHON_PROC*)&py3__Py_NoneStruct},
529     {"_Py_FalseStruct", (PYTHON_PROC*)&py3__Py_FalseStruct},
530     {"_Py_TrueStruct", (PYTHON_PROC*)&py3__Py_TrueStruct},
531     {"PyErr_Clear", (PYTHON_PROC*)&py3_PyErr_Clear},
532     {"PyErr_Format", (PYTHON_PROC*)&py3_PyErr_Format},
533     {"PyErr_PrintEx", (PYTHON_PROC*)&py3_PyErr_PrintEx},
534     {"PyObject_Init", (PYTHON_PROC*)&py3__PyObject_Init},
535     {"PyModule_AddObject", (PYTHON_PROC*)&py3_PyModule_AddObject},
536     {"PyImport_AppendInittab", (PYTHON_PROC*)&py3_PyImport_AppendInittab},
537 # if PY_VERSION_HEX >= 0x030300f0
538     {"PyUnicode_AsUTF8", (PYTHON_PROC*)&py3_PyUnicode_AsUTF8},
539 # else
540     {"_PyUnicode_AsString", (PYTHON_PROC*)&py3__PyUnicode_AsString},
541 # endif
542 # ifndef Py_UNICODE_USE_UCS_FUNCTIONS
543     {"PyUnicode_FromFormat", (PYTHON_PROC*)&py3_PyUnicode_FromFormat},
544 # else
545 #  ifdef Py_UNICODE_WIDE
546     {"PyUnicodeUCS4_FromFormat", (PYTHON_PROC*)&py3_PyUnicodeUCS4_FromFormat},
547 #  else
548     {"PyUnicodeUCS2_FromFormat", (PYTHON_PROC*)&py3_PyUnicodeUCS2_FromFormat},
549 #  endif
550 # endif
551     {"PyBytes_AsString", (PYTHON_PROC*)&py3_PyBytes_AsString},
552     {"PyBytes_AsStringAndSize", (PYTHON_PROC*)&py3_PyBytes_AsStringAndSize},
553     {"PyBytes_FromString", (PYTHON_PROC*)&py3_PyBytes_FromString},
554     {"PyFloat_FromDouble", (PYTHON_PROC*)&py3_PyFloat_FromDouble},
555     {"PyFloat_AsDouble", (PYTHON_PROC*)&py3_PyFloat_AsDouble},
556     {"PyObject_GenericGetAttr", (PYTHON_PROC*)&py3_PyObject_GenericGetAttr},
557     {"PyType_GenericAlloc", (PYTHON_PROC*)&py3_PyType_GenericAlloc},
558     {"PyType_GenericNew", (PYTHON_PROC*)&py3_PyType_GenericNew},
559     {"PyType_Type", (PYTHON_PROC*)&py3_PyType_Type},
560     {"PySlice_Type", (PYTHON_PROC*)&py3_PySlice_Type},
561     {"PyFloat_Type", (PYTHON_PROC*)&py3_PyFloat_Type},
562     {"PyBool_Type", (PYTHON_PROC*)&py3_PyBool_Type},
563     {"PyNumber_Check", (PYTHON_PROC*)&py3_PyNumber_Check},
564     {"PyNumber_Long", (PYTHON_PROC*)&py3_PyNumber_Long},
565     {"PyErr_NewException", (PYTHON_PROC*)&py3_PyErr_NewException},
566 # ifdef Py_DEBUG
567     {"_Py_NegativeRefcount", (PYTHON_PROC*)&py3__Py_NegativeRefcount},
568     {"_Py_RefTotal", (PYTHON_PROC*)&py3__Py_RefTotal},
569     {"_Py_Dealloc", (PYTHON_PROC*)&py3__Py_Dealloc},
570     {"PyModule_Create2TraceRefs", (PYTHON_PROC*)&py3_PyModule_Create2TraceRefs},
571 # else
572     {"PyModule_Create2", (PYTHON_PROC*)&py3_PyModule_Create2},
573 # endif
574 # if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
575     {"_PyObject_DebugFree", (PYTHON_PROC*)&py3__PyObject_DebugFree},
576     {"_PyObject_DebugMalloc", (PYTHON_PROC*)&py3__PyObject_DebugMalloc},
577 # else
578     {"PyObject_Malloc", (PYTHON_PROC*)&py3_PyObject_Malloc},
579     {"PyObject_Free", (PYTHON_PROC*)&py3_PyObject_Free},
580 # endif
581     {"_PyObject_GC_New", (PYTHON_PROC*)&py3__PyObject_GC_New},
582     {"PyObject_GC_Del", (PYTHON_PROC*)&py3_PyObject_GC_Del},
583     {"PyObject_GC_UnTrack", (PYTHON_PROC*)&py3_PyObject_GC_UnTrack},
584     {"PyType_IsSubtype", (PYTHON_PROC*)&py3_PyType_IsSubtype},
585     {"PyCapsule_New", (PYTHON_PROC*)&py3_PyCapsule_New},
586     {"PyCapsule_GetPointer", (PYTHON_PROC*)&py3_PyCapsule_GetPointer},
587     {"", NULL},
588 };
589 
590 /*
591  * Free python.dll
592  */
593     static void
594 end_dynamic_python3(void)
595 {
596     if (hinstPy3 != 0)
597     {
598 	close_dll(hinstPy3);
599 	hinstPy3 = 0;
600     }
601 }
602 
603 /*
604  * Load library and get all pointers.
605  * Parameter 'libname' provides name of DLL.
606  * Return OK or FAIL.
607  */
608     static int
609 py3_runtime_link_init(char *libname, int verbose)
610 {
611     int i;
612     void *ucs_from_string, *ucs_decode, *ucs_as_encoded_string;
613 
614 # if !(defined(PY_NO_RTLD_GLOBAL) && defined(PY3_NO_RTLD_GLOBAL)) && defined(UNIX) && defined(FEAT_PYTHON)
615     /* Can't have Python and Python3 loaded at the same time.
616      * It cause a crash, because RTLD_GLOBAL is needed for
617      * standard C extension libraries of one or both python versions. */
618     if (python_loaded())
619     {
620 	if (verbose)
621 	    EMSG(_("E837: This Vim cannot execute :py3 after using :python"));
622 	return FAIL;
623     }
624 # endif
625 
626     if (hinstPy3 != 0)
627 	return OK;
628     hinstPy3 = load_dll(libname);
629 
630     if (!hinstPy3)
631     {
632 	if (verbose)
633 	    EMSG2(_(e_loadlib), libname);
634 	return FAIL;
635     }
636 
637     for (i = 0; py3_funcname_table[i].ptr; ++i)
638     {
639 	if ((*py3_funcname_table[i].ptr = symbol_from_dll(hinstPy3,
640 			py3_funcname_table[i].name)) == NULL)
641 	{
642 	    close_dll(hinstPy3);
643 	    hinstPy3 = 0;
644 	    if (verbose)
645 		EMSG2(_(e_loadfunc), py3_funcname_table[i].name);
646 	    return FAIL;
647 	}
648     }
649 
650     /* Load unicode functions separately as only the ucs2 or the ucs4 functions
651      * will be present in the library. */
652 # if PY_VERSION_HEX >= 0x030300f0
653     ucs_from_string = symbol_from_dll(hinstPy3, "PyUnicode_FromString");
654     ucs_decode = symbol_from_dll(hinstPy3, "PyUnicode_Decode");
655     ucs_as_encoded_string = symbol_from_dll(hinstPy3,
656 	    "PyUnicode_AsEncodedString");
657 # else
658     ucs_from_string = symbol_from_dll(hinstPy3, "PyUnicodeUCS2_FromString");
659     ucs_decode = symbol_from_dll(hinstPy3,
660 	    "PyUnicodeUCS2_Decode");
661     ucs_as_encoded_string = symbol_from_dll(hinstPy3,
662 	    "PyUnicodeUCS2_AsEncodedString");
663     if (!ucs_from_string || !ucs_decode || !ucs_as_encoded_string)
664     {
665 	ucs_from_string = symbol_from_dll(hinstPy3,
666 		"PyUnicodeUCS4_FromString");
667 	ucs_decode = symbol_from_dll(hinstPy3,
668 		"PyUnicodeUCS4_Decode");
669 	ucs_as_encoded_string = symbol_from_dll(hinstPy3,
670 		"PyUnicodeUCS4_AsEncodedString");
671     }
672 # endif
673     if (ucs_from_string && ucs_decode && ucs_as_encoded_string)
674     {
675 	py3_PyUnicode_FromString = ucs_from_string;
676 	py3_PyUnicode_Decode = ucs_decode;
677 	py3_PyUnicode_AsEncodedString = ucs_as_encoded_string;
678     }
679     else
680     {
681 	close_dll(hinstPy3);
682 	hinstPy3 = 0;
683 	if (verbose)
684 	    EMSG2(_(e_loadfunc), "PyUnicode_UCSX_*");
685 	return FAIL;
686     }
687 
688     return OK;
689 }
690 
691 /*
692  * If python is enabled (there is installed python on Windows system) return
693  * TRUE, else FALSE.
694  */
695     int
696 python3_enabled(int verbose)
697 {
698     return py3_runtime_link_init((char *)p_py3dll, verbose) == OK;
699 }
700 
701 /* Load the standard Python exceptions - don't import the symbols from the
702  * DLL, as this can cause errors (importing data symbols is not reliable).
703  */
704 static void get_py3_exceptions(void);
705 
706     static void
707 get_py3_exceptions(void)
708 {
709     PyObject *exmod = PyImport_ImportModule("builtins");
710     PyObject *exdict = PyModule_GetDict(exmod);
711     p3imp_PyExc_AttributeError = PyDict_GetItemString(exdict, "AttributeError");
712     p3imp_PyExc_IndexError = PyDict_GetItemString(exdict, "IndexError");
713     p3imp_PyExc_KeyError = PyDict_GetItemString(exdict, "KeyError");
714     p3imp_PyExc_KeyboardInterrupt = PyDict_GetItemString(exdict, "KeyboardInterrupt");
715     p3imp_PyExc_TypeError = PyDict_GetItemString(exdict, "TypeError");
716     p3imp_PyExc_ValueError = PyDict_GetItemString(exdict, "ValueError");
717     p3imp_PyExc_SystemExit = PyDict_GetItemString(exdict, "SystemExit");
718     p3imp_PyExc_RuntimeError = PyDict_GetItemString(exdict, "RuntimeError");
719     p3imp_PyExc_ImportError = PyDict_GetItemString(exdict, "ImportError");
720     p3imp_PyExc_OverflowError = PyDict_GetItemString(exdict, "OverflowError");
721     Py_XINCREF(p3imp_PyExc_AttributeError);
722     Py_XINCREF(p3imp_PyExc_IndexError);
723     Py_XINCREF(p3imp_PyExc_KeyError);
724     Py_XINCREF(p3imp_PyExc_KeyboardInterrupt);
725     Py_XINCREF(p3imp_PyExc_TypeError);
726     Py_XINCREF(p3imp_PyExc_ValueError);
727     Py_XINCREF(p3imp_PyExc_SystemExit);
728     Py_XINCREF(p3imp_PyExc_RuntimeError);
729     Py_XINCREF(p3imp_PyExc_ImportError);
730     Py_XINCREF(p3imp_PyExc_OverflowError);
731     Py_XDECREF(exmod);
732 }
733 #endif /* DYNAMIC_PYTHON3 */
734 
735 static int py3initialised = 0;
736 
737 #define PYINITIALISED py3initialised
738 
739 #define DESTRUCTOR_FINISH(self) Py_TYPE(self)->tp_free((PyObject*)self)
740 
741 #define WIN_PYTHON_REF(win) win->w_python3_ref
742 #define BUF_PYTHON_REF(buf) buf->b_python3_ref
743 #define TAB_PYTHON_REF(tab) tab->tp_python3_ref
744 
745     static void
746 call_PyObject_Free(void *p)
747 {
748 #if defined(Py_DEBUG) && !defined(Py_DEBUG_NO_PYMALLOC)
749     _PyObject_DebugFree(p);
750 #else
751     PyObject_Free(p);
752 #endif
753 }
754 
755     static PyObject *
756 call_PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
757 {
758     return PyType_GenericNew(type,args,kwds);
759 }
760 
761     static PyObject *
762 call_PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
763 {
764     return PyType_GenericAlloc(type,nitems);
765 }
766 
767 static PyObject *OutputGetattro(PyObject *, PyObject *);
768 static int OutputSetattro(PyObject *, PyObject *, PyObject *);
769 static PyObject *BufferGetattro(PyObject *, PyObject *);
770 static int BufferSetattro(PyObject *, PyObject *, PyObject *);
771 static PyObject *TabPageGetattro(PyObject *, PyObject *);
772 static PyObject *WindowGetattro(PyObject *, PyObject *);
773 static int WindowSetattro(PyObject *, PyObject *, PyObject *);
774 static PyObject *RangeGetattro(PyObject *, PyObject *);
775 static PyObject *CurrentGetattro(PyObject *, PyObject *);
776 static int CurrentSetattro(PyObject *, PyObject *, PyObject *);
777 static PyObject *DictionaryGetattro(PyObject *, PyObject *);
778 static int DictionarySetattro(PyObject *, PyObject *, PyObject *);
779 static PyObject *ListGetattro(PyObject *, PyObject *);
780 static int ListSetattro(PyObject *, PyObject *, PyObject *);
781 static PyObject *FunctionGetattro(PyObject *, PyObject *);
782 
783 static PyObject *VimPathHook(PyObject *, PyObject *);
784 
785 static struct PyModuleDef vimmodule;
786 
787 #define PY_CAN_RECURSE
788 
789 /*
790  * Include the code shared with if_python.c
791  */
792 #include "if_py_both.h"
793 
794 #define GET_ATTR_STRING(name, nameobj) \
795     char	*name = ""; \
796     if (PyUnicode_Check(nameobj)) \
797 	name = _PyUnicode_AsString(nameobj)
798 
799 #define PY3OBJ_DELETED(obj) (obj->ob_base.ob_refcnt<=0)
800 
801 /******************************************************
802  * Internal function prototypes.
803  */
804 
805 static PyObject *Py3Init_vim(void);
806 
807 /******************************************************
808  * 1. Python interpreter main program.
809  */
810 
811     void
812 python3_end(void)
813 {
814     static int recurse = 0;
815 
816     /* If a crash occurs while doing this, don't try again. */
817     if (recurse != 0)
818 	return;
819 
820     ++recurse;
821 
822 #ifdef DYNAMIC_PYTHON3
823     if (hinstPy3)
824 #endif
825     if (Py_IsInitialized())
826     {
827 	// acquire lock before finalizing
828 	PyGILState_Ensure();
829 
830 	Py_Finalize();
831     }
832 
833 #ifdef DYNAMIC_PYTHON3
834     end_dynamic_python3();
835 #endif
836 
837     --recurse;
838 }
839 
840 #if (defined(DYNAMIC_PYTHON3) && defined(DYNAMIC_PYTHON) && defined(FEAT_PYTHON) && defined(UNIX)) || defined(PROTO)
841     int
842 python3_loaded(void)
843 {
844     return (hinstPy3 != 0);
845 }
846 #endif
847 
848     static int
849 Python3_Init(void)
850 {
851     if (!py3initialised)
852     {
853 #ifdef DYNAMIC_PYTHON3
854 	if (!python3_enabled(TRUE))
855 	{
856 	    EMSG(_("E263: Sorry, this command is disabled, the Python library could not be loaded."));
857 	    goto fail;
858 	}
859 #endif
860 
861 	init_structs();
862 
863 
864 #ifdef PYTHON3_HOME
865 # ifdef DYNAMIC_PYTHON3
866 	if (mch_getenv((char_u *)"PYTHONHOME") == NULL)
867 # endif
868 	    Py_SetPythonHome(PYTHON3_HOME);
869 #endif
870 
871 	PyImport_AppendInittab("vim", Py3Init_vim);
872 
873 #if !defined(MACOS) || defined(MACOS_X_UNIX)
874 	Py_Initialize();
875 #else
876 	PyMac_Initialize();
877 #endif
878 	/* Initialise threads, and below save the state using
879 	 * PyEval_SaveThread.  Without the call to PyEval_SaveThread, thread
880 	 * specific state (such as the system trace hook), will be lost
881 	 * between invocations of Python code. */
882 	PyEval_InitThreads();
883 #ifdef DYNAMIC_PYTHON3
884 	get_py3_exceptions();
885 #endif
886 
887 	if (PythonIO_Init_io())
888 	    goto fail;
889 
890 	globals = PyModule_GetDict(PyImport_AddModule("__main__"));
891 
892 	/* Remove the element from sys.path that was added because of our
893 	 * argv[0] value in Py3Init_vim().  Previously we used an empty
894 	 * string, but depending on the OS we then get an empty entry or
895 	 * the current directory in sys.path.
896 	 * Only after vim has been imported, the element does exist in
897 	 * sys.path.
898 	 */
899 	PyRun_SimpleString("import vim; import sys; sys.path = list(filter(lambda x: not x.endswith('must>not&exist'), sys.path))");
900 
901 	/* lock is created and acquired in PyEval_InitThreads() and thread
902 	 * state is created in Py_Initialize()
903 	 * there _PyGILState_NoteThreadState() also sets gilcounter to 1
904 	 * (python must have threads enabled!)
905 	 * so the following does both: unlock GIL and save thread state in TLS
906 	 * without deleting thread state
907 	 */
908 	PyEval_SaveThread();
909 
910 	py3initialised = 1;
911     }
912 
913     return 0;
914 
915 fail:
916     /* We call PythonIO_Flush() here to print any Python errors.
917      * This is OK, as it is possible to call this function even
918      * if PythonIO_Init_io() has not completed successfully (it will
919      * not do anything in this case).
920      */
921     PythonIO_Flush();
922     return -1;
923 }
924 
925 /*
926  * External interface
927  */
928     static void
929 DoPyCommand(const char *cmd, rangeinitializer init_range, runner run, void *arg)
930 {
931 #if defined(MACOS) && !defined(MACOS_X_UNIX)
932     GrafPtr		oldPort;
933 #endif
934 #if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
935     char		*saved_locale;
936 #endif
937     PyObject		*cmdstr;
938     PyObject		*cmdbytes;
939     PyGILState_STATE	pygilstate;
940 
941 #if defined(MACOS) && !defined(MACOS_X_UNIX)
942     GetPort(&oldPort);
943     /* Check if the Python library is available */
944     if ((Ptr)PyMac_Initialize == (Ptr)kUnresolvedCFragSymbolAddress)
945 	goto theend;
946 #endif
947     if (Python3_Init())
948 	goto theend;
949 
950     init_range(arg);
951 
952     Python_Release_Vim();	    /* leave vim */
953 
954 #if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
955     /* Python only works properly when the LC_NUMERIC locale is "C". */
956     saved_locale = setlocale(LC_NUMERIC, NULL);
957     if (saved_locale == NULL || STRCMP(saved_locale, "C") == 0)
958 	saved_locale = NULL;
959     else
960     {
961 	/* Need to make a copy, value may change when setting new locale. */
962 	saved_locale = (char *)vim_strsave((char_u *)saved_locale);
963 	(void)setlocale(LC_NUMERIC, "C");
964     }
965 #endif
966 
967     pygilstate = PyGILState_Ensure();
968 
969     /* PyRun_SimpleString expects a UTF-8 string. Wrong encoding may cause
970      * SyntaxError (unicode error). */
971     cmdstr = PyUnicode_Decode(cmd, strlen(cmd),
972 					(char *)ENC_OPT, CODEC_ERROR_HANDLER);
973     cmdbytes = PyUnicode_AsEncodedString(cmdstr, "utf-8", CODEC_ERROR_HANDLER);
974     Py_XDECREF(cmdstr);
975 
976     run(PyBytes_AsString(cmdbytes), arg, &pygilstate);
977     Py_XDECREF(cmdbytes);
978 
979     PyGILState_Release(pygilstate);
980 
981 #if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
982     if (saved_locale != NULL)
983     {
984 	(void)setlocale(LC_NUMERIC, saved_locale);
985 	vim_free(saved_locale);
986     }
987 #endif
988 
989     Python_Lock_Vim();		    /* enter vim */
990     PythonIO_Flush();
991 #if defined(MACOS) && !defined(MACOS_X_UNIX)
992     SetPort(oldPort);
993 #endif
994 
995 theend:
996     return;	    /* keeps lint happy */
997 }
998 
999 /*
1000  * ":py3"
1001  */
1002     void
1003 ex_py3(exarg_T *eap)
1004 {
1005     char_u *script;
1006 
1007     script = script_get(eap, eap->arg);
1008     if (!eap->skip)
1009     {
1010 	DoPyCommand(script == NULL ? (char *) eap->arg : (char *) script,
1011 		(rangeinitializer) init_range_cmd,
1012 		(runner) run_cmd,
1013 		(void *) eap);
1014     }
1015     vim_free(script);
1016 }
1017 
1018 #define BUFFER_SIZE 2048
1019 
1020 /*
1021  * ":py3file"
1022  */
1023     void
1024 ex_py3file(exarg_T *eap)
1025 {
1026     static char buffer[BUFFER_SIZE];
1027     const char *file;
1028     char *p;
1029     int i;
1030 
1031     /* Have to do it like this. PyRun_SimpleFile requires you to pass a
1032      * stdio file pointer, but Vim and the Python DLL are compiled with
1033      * different options under Windows, meaning that stdio pointers aren't
1034      * compatible between the two. Yuk.
1035      *
1036      * construct: exec(compile(open('a_filename', 'rb').read(), 'a_filename', 'exec'))
1037      *
1038      * Using bytes so that Python can detect the source encoding as it normally
1039      * does. The doc does not say "compile" accept bytes, though.
1040      *
1041      * We need to escape any backslashes or single quotes in the file name, so that
1042      * Python won't mangle the file name.
1043      */
1044 
1045     strcpy(buffer, "exec(compile(open('");
1046     p = buffer + 19; /* size of "exec(compile(open('" */
1047 
1048     for (i=0; i<2; ++i)
1049     {
1050 	file = (char *)eap->arg;
1051 	while (*file && p < buffer + (BUFFER_SIZE - 3))
1052 	{
1053 	    if (*file == '\\' || *file == '\'')
1054 		*p++ = '\\';
1055 	    *p++ = *file++;
1056 	}
1057 	/* If we didn't finish the file name, we hit a buffer overflow */
1058 	if (*file != '\0')
1059 	    return;
1060 	if (i==0)
1061 	{
1062 	    strcpy(p,"','rb').read(),'");
1063 	    p += 16;
1064 	}
1065 	else
1066 	{
1067 	    strcpy(p,"','exec'))");
1068 	    p += 10;
1069 	}
1070     }
1071 
1072 
1073     /* Execute the file */
1074     DoPyCommand(buffer,
1075 	    (rangeinitializer) init_range_cmd,
1076 	    (runner) run_cmd,
1077 	    (void *) eap);
1078 }
1079 
1080     void
1081 ex_py3do(exarg_T *eap)
1082 {
1083     DoPyCommand((char *)eap->arg,
1084 	    (rangeinitializer)init_range_cmd,
1085 	    (runner)run_do,
1086 	    (void *)eap);
1087 }
1088 
1089 /******************************************************
1090  * 2. Python output stream: writes output via [e]msg().
1091  */
1092 
1093 /* Implementation functions
1094  */
1095 
1096     static PyObject *
1097 OutputGetattro(PyObject *self, PyObject *nameobj)
1098 {
1099     GET_ATTR_STRING(name, nameobj);
1100 
1101     if (strcmp(name, "softspace") == 0)
1102 	return PyLong_FromLong(((OutputObject *)(self))->softspace);
1103 
1104     return PyObject_GenericGetAttr(self, nameobj);
1105 }
1106 
1107     static int
1108 OutputSetattro(PyObject *self, PyObject *nameobj, PyObject *val)
1109 {
1110     GET_ATTR_STRING(name, nameobj);
1111 
1112     return OutputSetattr((OutputObject *)(self), name, val);
1113 }
1114 
1115 /******************************************************
1116  * 3. Implementation of the Vim module for Python
1117  */
1118 
1119 /* Window type - Implementation functions
1120  * --------------------------------------
1121  */
1122 
1123 #define WindowType_Check(obj) ((obj)->ob_base.ob_type == &WindowType)
1124 
1125 /* Buffer type - Implementation functions
1126  * --------------------------------------
1127  */
1128 
1129 #define BufferType_Check(obj) ((obj)->ob_base.ob_type == &BufferType)
1130 
1131 static PyObject* BufferSubscript(PyObject *self, PyObject *idx);
1132 static Py_ssize_t BufferAsSubscript(PyObject *self, PyObject *idx, PyObject *val);
1133 
1134 /* Line range type - Implementation functions
1135  * --------------------------------------
1136  */
1137 
1138 #define RangeType_Check(obj) ((obj)->ob_base.ob_type == &RangeType)
1139 
1140 static PyObject* RangeSubscript(PyObject *self, PyObject *idx);
1141 static Py_ssize_t RangeAsItem(PyObject *, Py_ssize_t, PyObject *);
1142 static Py_ssize_t RangeAsSubscript(PyObject *self, PyObject *idx, PyObject *val);
1143 
1144 /* Current objects type - Implementation functions
1145  * -----------------------------------------------
1146  */
1147 
1148 static PySequenceMethods BufferAsSeq = {
1149     (lenfunc)		BufferLength,	    /* sq_length,    len(x)   */
1150     (binaryfunc)	0,		    /* sq_concat,    x+y      */
1151     (ssizeargfunc)	0,		    /* sq_repeat,    x*n      */
1152     (ssizeargfunc)	BufferItem,	    /* sq_item,      x[i]     */
1153     0,					    /* was_sq_slice,	 x[i:j]   */
1154     0,					    /* sq_ass_item,  x[i]=v   */
1155     0,					    /* sq_ass_slice, x[i:j]=v */
1156     0,					    /* sq_contains */
1157     0,					    /* sq_inplace_concat */
1158     0,					    /* sq_inplace_repeat */
1159 };
1160 
1161 static PyMappingMethods BufferAsMapping = {
1162     /* mp_length	*/ (lenfunc)BufferLength,
1163     /* mp_subscript     */ (binaryfunc)BufferSubscript,
1164     /* mp_ass_subscript */ (objobjargproc)BufferAsSubscript,
1165 };
1166 
1167 
1168 /* Buffer object
1169  */
1170 
1171     static PyObject *
1172 BufferGetattro(PyObject *self, PyObject *nameobj)
1173 {
1174     PyObject *r;
1175 
1176     GET_ATTR_STRING(name, nameobj);
1177 
1178     if ((r = BufferAttrValid((BufferObject *)(self), name)))
1179 	return r;
1180 
1181     if (CheckBuffer((BufferObject *)(self)))
1182 	return NULL;
1183 
1184     r = BufferAttr((BufferObject *)(self), name);
1185     if (r || PyErr_Occurred())
1186 	return r;
1187     else
1188 	return PyObject_GenericGetAttr(self, nameobj);
1189 }
1190 
1191     static int
1192 BufferSetattro(PyObject *self, PyObject *nameobj, PyObject *val)
1193 {
1194     GET_ATTR_STRING(name, nameobj);
1195 
1196     return BufferSetattr((BufferObject *)(self), name, val);
1197 }
1198 
1199 /******************/
1200 
1201     static PyObject *
1202 BufferSubscript(PyObject *self, PyObject* idx)
1203 {
1204     if (PyLong_Check(idx))
1205     {
1206 	long _idx = PyLong_AsLong(idx);
1207 	return BufferItem((BufferObject *)(self), _idx);
1208     } else if (PySlice_Check(idx))
1209     {
1210 	Py_ssize_t start, stop, step, slicelen;
1211 
1212 	if (CheckBuffer((BufferObject *) self))
1213 	    return NULL;
1214 
1215 	if (PySlice_GetIndicesEx((PySliceObject_T *)idx,
1216 	      (Py_ssize_t)((BufferObject *)(self))->buf->b_ml.ml_line_count,
1217 	      &start, &stop,
1218 	      &step, &slicelen) < 0)
1219 	{
1220 	    return NULL;
1221 	}
1222 	return BufferSlice((BufferObject *)(self), start, stop);
1223     }
1224     else
1225     {
1226 	RAISE_INVALID_INDEX_TYPE(idx);
1227 	return NULL;
1228     }
1229 }
1230 
1231     static Py_ssize_t
1232 BufferAsSubscript(PyObject *self, PyObject* idx, PyObject* val)
1233 {
1234     if (PyLong_Check(idx))
1235     {
1236 	long n = PyLong_AsLong(idx);
1237 	return RBAsItem((BufferObject *)(self), n, val, 1,
1238 		    (Py_ssize_t)((BufferObject *)(self))->buf->b_ml.ml_line_count,
1239 		    NULL);
1240     } else if (PySlice_Check(idx))
1241     {
1242 	Py_ssize_t start, stop, step, slicelen;
1243 
1244 	if (CheckBuffer((BufferObject *) self))
1245 	    return -1;
1246 
1247 	if (PySlice_GetIndicesEx((PySliceObject_T *)idx,
1248 	      (Py_ssize_t)((BufferObject *)(self))->buf->b_ml.ml_line_count,
1249 	      &start, &stop,
1250 	      &step, &slicelen) < 0)
1251 	{
1252 	    return -1;
1253 	}
1254 	return RBAsSlice((BufferObject *)(self), start, stop, val, 1,
1255 			  (PyInt)((BufferObject *)(self))->buf->b_ml.ml_line_count,
1256 			  NULL);
1257     }
1258     else
1259     {
1260 	RAISE_INVALID_INDEX_TYPE(idx);
1261 	return -1;
1262     }
1263 }
1264 
1265 static PySequenceMethods RangeAsSeq = {
1266     (lenfunc)		RangeLength,	 /* sq_length,	  len(x)   */
1267     (binaryfunc)	0,		 /* RangeConcat, sq_concat,  x+y   */
1268     (ssizeargfunc)	0,		 /* RangeRepeat, sq_repeat,  x*n   */
1269     (ssizeargfunc)	RangeItem,	 /* sq_item,	  x[i]	   */
1270     0,					 /* was_sq_slice,     x[i:j]   */
1271     (ssizeobjargproc)	RangeAsItem,	 /* sq_as_item,  x[i]=v   */
1272     0,					 /* sq_ass_slice, x[i:j]=v */
1273     0,					 /* sq_contains */
1274     0,					 /* sq_inplace_concat */
1275     0,					 /* sq_inplace_repeat */
1276 };
1277 
1278 static PyMappingMethods RangeAsMapping = {
1279     /* mp_length	*/ (lenfunc)RangeLength,
1280     /* mp_subscript     */ (binaryfunc)RangeSubscript,
1281     /* mp_ass_subscript */ (objobjargproc)RangeAsSubscript,
1282 };
1283 
1284 /* Line range object - Implementation
1285  */
1286 
1287     static PyObject *
1288 RangeGetattro(PyObject *self, PyObject *nameobj)
1289 {
1290     GET_ATTR_STRING(name, nameobj);
1291 
1292     if (strcmp(name, "start") == 0)
1293 	return Py_BuildValue("n", ((RangeObject *)(self))->start - 1);
1294     else if (strcmp(name, "end") == 0)
1295 	return Py_BuildValue("n", ((RangeObject *)(self))->end - 1);
1296     else
1297 	return PyObject_GenericGetAttr(self, nameobj);
1298 }
1299 
1300 /****************/
1301 
1302     static Py_ssize_t
1303 RangeAsItem(PyObject *self, Py_ssize_t n, PyObject *val)
1304 {
1305     return RBAsItem(((RangeObject *)(self))->buf, n, val,
1306 		    ((RangeObject *)(self))->start,
1307 		    ((RangeObject *)(self))->end,
1308 		    &((RangeObject *)(self))->end);
1309 }
1310 
1311     static Py_ssize_t
1312 RangeAsSlice(PyObject *self, Py_ssize_t lo, Py_ssize_t hi, PyObject *val)
1313 {
1314     return RBAsSlice(((RangeObject *)(self))->buf, lo, hi, val,
1315 		    ((RangeObject *)(self))->start,
1316 		    ((RangeObject *)(self))->end,
1317 		    &((RangeObject *)(self))->end);
1318 }
1319 
1320     static PyObject *
1321 RangeSubscript(PyObject *self, PyObject* idx)
1322 {
1323     if (PyLong_Check(idx))
1324     {
1325 	long _idx = PyLong_AsLong(idx);
1326 	return RangeItem((RangeObject *)(self), _idx);
1327     } else if (PySlice_Check(idx))
1328     {
1329 	Py_ssize_t start, stop, step, slicelen;
1330 
1331 	if (PySlice_GetIndicesEx((PySliceObject_T *)idx,
1332 		((RangeObject *)(self))->end-((RangeObject *)(self))->start+1,
1333 		&start, &stop,
1334 		&step, &slicelen) < 0)
1335 	{
1336 	    return NULL;
1337 	}
1338 	return RangeSlice((RangeObject *)(self), start, stop);
1339     }
1340     else
1341     {
1342 	RAISE_INVALID_INDEX_TYPE(idx);
1343 	return NULL;
1344     }
1345 }
1346 
1347     static Py_ssize_t
1348 RangeAsSubscript(PyObject *self, PyObject *idx, PyObject *val)
1349 {
1350     if (PyLong_Check(idx))
1351     {
1352 	long n = PyLong_AsLong(idx);
1353 	return RangeAsItem(self, n, val);
1354     } else if (PySlice_Check(idx))
1355     {
1356 	Py_ssize_t start, stop, step, slicelen;
1357 
1358 	if (PySlice_GetIndicesEx((PySliceObject_T *)idx,
1359 		((RangeObject *)(self))->end-((RangeObject *)(self))->start+1,
1360 		&start, &stop,
1361 		&step, &slicelen) < 0)
1362 	{
1363 	    return -1;
1364 	}
1365 	return RangeAsSlice(self, start, stop, val);
1366     }
1367     else
1368     {
1369 	RAISE_INVALID_INDEX_TYPE(idx);
1370 	return -1;
1371     }
1372 }
1373 
1374 /* TabPage object - Implementation
1375  */
1376 
1377     static PyObject *
1378 TabPageGetattro(PyObject *self, PyObject *nameobj)
1379 {
1380     PyObject *r;
1381 
1382     GET_ATTR_STRING(name, nameobj);
1383 
1384     if ((r = TabPageAttrValid((TabPageObject *)(self), name)))
1385 	return r;
1386 
1387     if (CheckTabPage((TabPageObject *)(self)))
1388 	return NULL;
1389 
1390     r = TabPageAttr((TabPageObject *)(self), name);
1391     if (r || PyErr_Occurred())
1392 	return r;
1393     else
1394 	return PyObject_GenericGetAttr(self, nameobj);
1395 }
1396 
1397 /* Window object - Implementation
1398  */
1399 
1400     static PyObject *
1401 WindowGetattro(PyObject *self, PyObject *nameobj)
1402 {
1403     PyObject *r;
1404 
1405     GET_ATTR_STRING(name, nameobj);
1406 
1407     if ((r = WindowAttrValid((WindowObject *)(self), name)))
1408 	return r;
1409 
1410     if (CheckWindow((WindowObject *)(self)))
1411 	return NULL;
1412 
1413     r = WindowAttr((WindowObject *)(self), name);
1414     if (r || PyErr_Occurred())
1415 	return r;
1416     else
1417 	return PyObject_GenericGetAttr(self, nameobj);
1418 }
1419 
1420     static int
1421 WindowSetattro(PyObject *self, PyObject *nameobj, PyObject *val)
1422 {
1423     GET_ATTR_STRING(name, nameobj);
1424 
1425     return WindowSetattr((WindowObject *)(self), name, val);
1426 }
1427 
1428 /* Tab page list object - Definitions
1429  */
1430 
1431 static PySequenceMethods TabListAsSeq = {
1432     (lenfunc)	     TabListLength,	    /* sq_length,    len(x)   */
1433     (binaryfunc)     0,			    /* sq_concat,    x+y      */
1434     (ssizeargfunc)   0,			    /* sq_repeat,    x*n      */
1435     (ssizeargfunc)   TabListItem,	    /* sq_item,      x[i]     */
1436     0,					    /* sq_slice,     x[i:j]   */
1437     (ssizeobjargproc)0,			    /* sq_as_item,  x[i]=v   */
1438     0,					    /* sq_ass_slice, x[i:j]=v */
1439     0,					    /* sq_contains */
1440     0,					    /* sq_inplace_concat */
1441     0,					    /* sq_inplace_repeat */
1442 };
1443 
1444 /* Window list object - Definitions
1445  */
1446 
1447 static PySequenceMethods WinListAsSeq = {
1448     (lenfunc)	     WinListLength,	    /* sq_length,    len(x)   */
1449     (binaryfunc)     0,			    /* sq_concat,    x+y      */
1450     (ssizeargfunc)   0,			    /* sq_repeat,    x*n      */
1451     (ssizeargfunc)   WinListItem,	    /* sq_item,      x[i]     */
1452     0,					    /* sq_slice,     x[i:j]   */
1453     (ssizeobjargproc)0,			    /* sq_as_item,  x[i]=v   */
1454     0,					    /* sq_ass_slice, x[i:j]=v */
1455     0,					    /* sq_contains */
1456     0,					    /* sq_inplace_concat */
1457     0,					    /* sq_inplace_repeat */
1458 };
1459 
1460 /* Current items object - Implementation
1461  */
1462     static PyObject *
1463 CurrentGetattro(PyObject *self, PyObject *nameobj)
1464 {
1465     PyObject	*r;
1466     GET_ATTR_STRING(name, nameobj);
1467     if (!(r = CurrentGetattr(self, name)))
1468 	return PyObject_GenericGetAttr(self, nameobj);
1469     return r;
1470 }
1471 
1472     static int
1473 CurrentSetattro(PyObject *self, PyObject *nameobj, PyObject *value)
1474 {
1475     GET_ATTR_STRING(name, nameobj);
1476     return CurrentSetattr(self, name, value);
1477 }
1478 
1479 /* Dictionary object - Definitions
1480  */
1481 
1482     static PyObject *
1483 DictionaryGetattro(PyObject *self, PyObject *nameobj)
1484 {
1485     DictionaryObject	*this = ((DictionaryObject *) (self));
1486 
1487     GET_ATTR_STRING(name, nameobj);
1488 
1489     if (strcmp(name, "locked") == 0)
1490 	return PyLong_FromLong(this->dict->dv_lock);
1491     else if (strcmp(name, "scope") == 0)
1492 	return PyLong_FromLong(this->dict->dv_scope);
1493 
1494     return PyObject_GenericGetAttr(self, nameobj);
1495 }
1496 
1497     static int
1498 DictionarySetattro(PyObject *self, PyObject *nameobj, PyObject *val)
1499 {
1500     GET_ATTR_STRING(name, nameobj);
1501     return DictionarySetattr((DictionaryObject *)(self), name, val);
1502 }
1503 
1504 /* List object - Definitions
1505  */
1506 
1507     static PyObject *
1508 ListGetattro(PyObject *self, PyObject *nameobj)
1509 {
1510     GET_ATTR_STRING(name, nameobj);
1511 
1512     if (strcmp(name, "locked") == 0)
1513 	return PyLong_FromLong(((ListObject *) (self))->list->lv_lock);
1514 
1515     return PyObject_GenericGetAttr(self, nameobj);
1516 }
1517 
1518     static int
1519 ListSetattro(PyObject *self, PyObject *nameobj, PyObject *val)
1520 {
1521     GET_ATTR_STRING(name, nameobj);
1522     return ListSetattr((ListObject *)(self), name, val);
1523 }
1524 
1525 /* Function object - Definitions
1526  */
1527 
1528     static PyObject *
1529 FunctionGetattro(PyObject *self, PyObject *nameobj)
1530 {
1531     FunctionObject	*this = (FunctionObject *)(self);
1532 
1533     GET_ATTR_STRING(name, nameobj);
1534 
1535     if (strcmp(name, "name") == 0)
1536 	return PyUnicode_FromString((char *)(this->name));
1537 
1538     return PyObject_GenericGetAttr(self, nameobj);
1539 }
1540 
1541 /* External interface
1542  */
1543 
1544     void
1545 python3_buffer_free(buf_T *buf)
1546 {
1547     if (BUF_PYTHON_REF(buf) != NULL)
1548     {
1549 	BufferObject *bp = BUF_PYTHON_REF(buf);
1550 	bp->buf = INVALID_BUFFER_VALUE;
1551 	BUF_PYTHON_REF(buf) = NULL;
1552     }
1553 }
1554 
1555 #if defined(FEAT_WINDOWS) || defined(PROTO)
1556     void
1557 python3_window_free(win_T *win)
1558 {
1559     if (WIN_PYTHON_REF(win) != NULL)
1560     {
1561 	WindowObject *wp = WIN_PYTHON_REF(win);
1562 	wp->win = INVALID_WINDOW_VALUE;
1563 	WIN_PYTHON_REF(win) = NULL;
1564     }
1565 }
1566 
1567     void
1568 python3_tabpage_free(tabpage_T *tab)
1569 {
1570     if (TAB_PYTHON_REF(tab) != NULL)
1571     {
1572 	TabPageObject *tp = TAB_PYTHON_REF(tab);
1573 	tp->tab = INVALID_TABPAGE_VALUE;
1574 	TAB_PYTHON_REF(tab) = NULL;
1575     }
1576 }
1577 #endif
1578 
1579     static PyObject *
1580 Py3Init_vim(void)
1581 {
1582     /* The special value is removed from sys.path in Python3_Init(). */
1583     static wchar_t *(argv[2]) = {L"/must>not&exist/foo", NULL};
1584 
1585     if (init_types())
1586 	return NULL;
1587 
1588     /* Set sys.argv[] to avoid a crash in warn(). */
1589     PySys_SetArgv(1, argv);
1590 
1591     if ((vim_module = PyModule_Create(&vimmodule)) == NULL)
1592 	return NULL;
1593 
1594     if (populate_module(vim_module))
1595 	return NULL;
1596 
1597     if (init_sys_path())
1598 	return NULL;
1599 
1600     return vim_module;
1601 }
1602 
1603 /*************************************************************************
1604  * 4. Utility functions for handling the interface between Vim and Python.
1605  */
1606 
1607 /* Convert a Vim line into a Python string.
1608  * All internal newlines are replaced by null characters.
1609  *
1610  * On errors, the Python exception data is set, and NULL is returned.
1611  */
1612     static PyObject *
1613 LineToString(const char *str)
1614 {
1615     PyObject *result;
1616     Py_ssize_t len = strlen(str);
1617     char *tmp,*p;
1618 
1619     tmp = (char *)alloc((unsigned)(len+1));
1620     p = tmp;
1621     if (p == NULL)
1622     {
1623 	PyErr_NoMemory();
1624 	return NULL;
1625     }
1626 
1627     while (*str)
1628     {
1629 	if (*str == '\n')
1630 	    *p = '\0';
1631 	else
1632 	    *p = *str;
1633 
1634 	++p;
1635 	++str;
1636     }
1637     *p = '\0';
1638 
1639     result = PyUnicode_Decode(tmp, len, (char *)ENC_OPT, CODEC_ERROR_HANDLER);
1640 
1641     vim_free(tmp);
1642     return result;
1643 }
1644 
1645     void
1646 do_py3eval (char_u *str, typval_T *rettv)
1647 {
1648     DoPyCommand((char *) str,
1649 	    (rangeinitializer) init_range_eval,
1650 	    (runner) run_eval,
1651 	    (void *) rettv);
1652     switch(rettv->v_type)
1653     {
1654 	case VAR_DICT: ++rettv->vval.v_dict->dv_refcount; break;
1655 	case VAR_LIST: ++rettv->vval.v_list->lv_refcount; break;
1656 	case VAR_FUNC: func_ref(rettv->vval.v_string);    break;
1657 	case VAR_PARTIAL: ++rettv->vval.v_partial->pt_refcount; break;
1658 	case VAR_UNKNOWN:
1659 	    rettv->v_type = VAR_NUMBER;
1660 	    rettv->vval.v_number = 0;
1661 	    break;
1662 	case VAR_NUMBER:
1663 	case VAR_STRING:
1664 	case VAR_FLOAT:
1665 	case VAR_SPECIAL:
1666 	case VAR_JOB:
1667 	case VAR_CHANNEL:
1668 	    break;
1669     }
1670 }
1671 
1672     int
1673 set_ref_in_python3 (int copyID)
1674 {
1675     return set_ref_in_py(copyID);
1676 }
1677