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