blob: c7df93be2a052105ef85648929eb145aa4c07787 [file] [log] [blame]
Bram Moolenaardb913952012-06-29 12:54:53 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar170bf1a2010-07-24 23:51:45 +02002 *
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/*
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +020010 * Python extensions by Paul Moore, David Leonard, Roland Puntaier, Nikolay
11 * Pavlov.
Bram Moolenaar170bf1a2010-07-24 23:51:45 +020012 *
13 * Common code for if_python.c and if_python3.c.
14 */
15
Bram Moolenaar41009372013-07-01 22:03:04 +020016static char_u e_py_systemexit[] = "E880: Can't handle SystemExit of %s exception in vim";
17
Bram Moolenaarc1a995d2012-08-08 16:05:07 +020018#if PY_VERSION_HEX < 0x02050000
Bram Moolenaar9bf703d2019-11-30 19:44:38 +010019typedef int Py_ssize_t; // Python 2.4 and earlier don't have this type.
Bram Moolenaarc1a995d2012-08-08 16:05:07 +020020#endif
21
Bram Moolenaard518f952020-01-01 15:04:17 +010022// Use values that are known to work, others may make Vim crash.
23#define ENC_OPT (enc_utf8 ? "utf-8" : enc_dbcs ? "euc-jp" : (char *)p_enc)
Bram Moolenaard620aa92013-05-17 16:40:06 +020024#define DOPY_FUNC "_vim_pydo"
Bram Moolenaar91805fc2011-06-26 04:01:44 +020025
Bram Moolenaarc09a6d62013-06-10 21:27:29 +020026static const char *vim_special_path = "_vim_path_";
27
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +020028#define PyErr_SET_STRING(exc, str) PyErr_SetString(exc, _(str))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +020029#define PyErr_SetVim(str) PyErr_SetString(VimError, str)
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +020030#define PyErr_SET_VIM(str) PyErr_SET_STRING(VimError, str)
Bram Moolenaar063a46b2014-01-14 16:36:51 +010031#define PyErr_FORMAT(exc, str, arg) PyErr_Format(exc, _(str), arg)
32#define PyErr_FORMAT2(exc, str, arg1, arg2) PyErr_Format(exc, _(str), arg1,arg2)
33#define PyErr_VIM_FORMAT(str, arg) PyErr_FORMAT(VimError, str, arg)
Bram Moolenaarc476e522013-06-23 13:46:40 +020034
35#define Py_TYPE_NAME(obj) (obj->ob_type->tp_name == NULL \
36 ? "(NULL)" \
37 : obj->ob_type->tp_name)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +020038
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +020039#define RAISE_NO_EMPTY_KEYS PyErr_SET_STRING(PyExc_ValueError, \
Bram Moolenaar6f1404f2013-06-23 16:04:08 +020040 N_("empty keys are not allowed"))
41#define RAISE_LOCKED_DICTIONARY PyErr_SET_VIM(N_("dictionary is locked"))
42#define RAISE_LOCKED_LIST PyErr_SET_VIM(N_("list is locked"))
43#define RAISE_UNDO_FAIL PyErr_SET_VIM(N_("cannot save undo information"))
44#define RAISE_DELETE_LINE_FAIL PyErr_SET_VIM(N_("cannot delete line"))
45#define RAISE_INSERT_LINE_FAIL PyErr_SET_VIM(N_("cannot insert line"))
46#define RAISE_REPLACE_LINE_FAIL PyErr_SET_VIM(N_("cannot replace line"))
Bram Moolenaarc476e522013-06-23 13:46:40 +020047#define RAISE_KEY_ADD_FAIL(key) \
Bram Moolenaar6f1404f2013-06-23 16:04:08 +020048 PyErr_VIM_FORMAT(N_("failed to add key '%s' to dictionary"), key)
Bram Moolenaarc476e522013-06-23 13:46:40 +020049#define RAISE_INVALID_INDEX_TYPE(idx) \
Bram Moolenaar6f1404f2013-06-23 16:04:08 +020050 PyErr_FORMAT(PyExc_TypeError, N_("index must be int or slice, not %s"), \
Bram Moolenaarc476e522013-06-23 13:46:40 +020051 Py_TYPE_NAME(idx));
Bram Moolenaar35eacd72013-05-30 22:06:33 +020052
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +020053#define INVALID_BUFFER_VALUE ((buf_T *)(-1))
54#define INVALID_WINDOW_VALUE ((win_T *)(-1))
Bram Moolenaar5e538ec2013-05-15 15:12:29 +020055#define INVALID_TABPAGE_VALUE ((tabpage_T *)(-1))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +020056
Bram Moolenaarb52f4c02013-05-21 18:19:38 +020057typedef void (*rangeinitializer)(void *);
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +020058typedef void (*runner)(const char *, void *
59#ifdef PY_CAN_RECURSE
60 , PyGILState_STATE *
61#endif
62 );
Bram Moolenaarb52f4c02013-05-21 18:19:38 +020063
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +020064static int ConvertFromPyObject(PyObject *, typval_T *);
65static int _ConvertFromPyObject(PyObject *, typval_T *, PyObject *);
Bram Moolenaara9922d62013-05-30 13:01:18 +020066static int ConvertFromPyMapping(PyObject *, typval_T *);
Bram Moolenaar8110a092016-04-14 15:56:09 +020067static int ConvertFromPySequence(PyObject *, typval_T *);
Bram Moolenaarcabf80f2013-05-17 16:18:33 +020068static PyObject *WindowNew(win_T *, tabpage_T *);
69static PyObject *BufferNew (buf_T *);
70static PyObject *LineToString(const char *);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +020071
72static PyInt RangeStart;
73static PyInt RangeEnd;
74
Bram Moolenaarb52f4c02013-05-21 18:19:38 +020075static PyObject *globals;
76
Bram Moolenaarf4258302013-06-02 18:20:17 +020077static PyObject *py_chdir;
78static PyObject *py_fchdir;
79static PyObject *py_getcwd;
Bram Moolenaarc09a6d62013-06-10 21:27:29 +020080static PyObject *vim_module;
81static PyObject *vim_special_path_object;
Bram Moolenaarf4258302013-06-02 18:20:17 +020082
Bram Moolenaar79a494d2018-07-22 04:30:21 +020083#if PY_VERSION_HEX >= 0x030700f0
84static PyObject *py_find_spec;
85#else
Bram Moolenaar81c40c52013-06-12 14:41:04 +020086static PyObject *py_load_module;
Bram Moolenaar79a494d2018-07-22 04:30:21 +020087#endif
Bram Moolenaarb999ba22019-02-14 13:28:45 +010088static PyObject *py_find_module;
Bram Moolenaar81c40c52013-06-12 14:41:04 +020089
90static PyObject *VimError;
91
Bram Moolenaar170bf1a2010-07-24 23:51:45 +020092/*
93 * obtain a lock on the Vim data structures
94 */
95 static void
96Python_Lock_Vim(void)
97{
98}
99
100/*
101 * release a lock on the Vim data structures
102 */
103 static void
104Python_Release_Vim(void)
105{
106}
107
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200108/*
109 * The "todecref" argument holds a pointer to PyObject * that must be
110 * DECREF'ed after returned char_u * is no longer needed or NULL if all what
111 * was needed to generate returned value is object.
112 *
113 * Use Py_XDECREF to decrement reference count.
114 */
115 static char_u *
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200116StringToChars(PyObject *obj, PyObject **todecref)
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200117{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200118 char_u *str;
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200119
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200120 if (PyBytes_Check(obj))
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200121 {
122
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200123 if (PyBytes_AsStringAndSize(obj, (char **) &str, NULL) == -1
124 || str == NULL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200125 return NULL;
126
127 *todecref = NULL;
128 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200129 else if (PyUnicode_Check(obj))
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200130 {
Bram Moolenaar808c2bc2013-06-23 13:11:18 +0200131 PyObject *bytes;
132
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200133 if (!(bytes = PyUnicode_AsEncodedString(obj, ENC_OPT, NULL)))
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200134 return NULL;
135
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200136 if(PyBytes_AsStringAndSize(bytes, (char **) &str, NULL) == -1
137 || str == NULL)
Bram Moolenaar808c2bc2013-06-23 13:11:18 +0200138 {
139 Py_DECREF(bytes);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200140 return NULL;
Bram Moolenaar808c2bc2013-06-23 13:11:18 +0200141 }
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200142
143 *todecref = bytes;
144 }
145 else
146 {
Bram Moolenaarc476e522013-06-23 13:46:40 +0200147#if PY_MAJOR_VERSION < 3
Bram Moolenaarc1c3d682013-06-24 21:21:58 +0200148 PyErr_FORMAT(PyExc_TypeError,
149 N_("expected str() or unicode() instance, but got %s"),
150 Py_TYPE_NAME(obj));
Bram Moolenaarc476e522013-06-23 13:46:40 +0200151#else
Bram Moolenaarc1c3d682013-06-24 21:21:58 +0200152 PyErr_FORMAT(PyExc_TypeError,
153 N_("expected bytes() or str() instance, but got %s"),
154 Py_TYPE_NAME(obj));
Bram Moolenaarc476e522013-06-23 13:46:40 +0200155#endif
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200156 return NULL;
157 }
158
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200159 return (char_u *) str;
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200160}
161
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200162#define NUMBER_LONG 1
163#define NUMBER_INT 2
164#define NUMBER_NATURAL 4
165#define NUMBER_UNSIGNED 8
166
167 static int
168NumberToLong(PyObject *obj, long *result, int flags)
169{
170#if PY_MAJOR_VERSION < 3
171 if (PyInt_Check(obj))
172 {
173 *result = PyInt_AsLong(obj);
174 if (PyErr_Occurred())
175 return -1;
176 }
177 else
178#endif
179 if (PyLong_Check(obj))
180 {
181 *result = PyLong_AsLong(obj);
182 if (PyErr_Occurred())
183 return -1;
184 }
185 else if (PyNumber_Check(obj))
186 {
187 PyObject *num;
188
189 if (!(num = PyNumber_Long(obj)))
190 return -1;
191
192 *result = PyLong_AsLong(num);
193
194 Py_DECREF(num);
195
196 if (PyErr_Occurred())
197 return -1;
198 }
199 else
200 {
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200201#if PY_MAJOR_VERSION < 3
Bram Moolenaarc1c3d682013-06-24 21:21:58 +0200202 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200203 N_("expected int(), long() or something supporting "
Bram Moolenaarc1c3d682013-06-24 21:21:58 +0200204 "coercing to long(), but got %s"),
205 Py_TYPE_NAME(obj));
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200206#else
Bram Moolenaarc1c3d682013-06-24 21:21:58 +0200207 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200208 N_("expected int() or something supporting coercing to int(), "
Bram Moolenaarc1c3d682013-06-24 21:21:58 +0200209 "but got %s"),
210 Py_TYPE_NAME(obj));
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200211#endif
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200212 return -1;
213 }
214
215 if (flags & NUMBER_INT)
216 {
217 if (*result > INT_MAX)
218 {
219 PyErr_SET_STRING(PyExc_OverflowError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200220 N_("value is too large to fit into C int type"));
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200221 return -1;
222 }
223 else if (*result < INT_MIN)
224 {
225 PyErr_SET_STRING(PyExc_OverflowError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200226 N_("value is too small to fit into C int type"));
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200227 return -1;
228 }
229 }
230
231 if (flags & NUMBER_NATURAL)
232 {
233 if (*result <= 0)
234 {
235 PyErr_SET_STRING(PyExc_ValueError,
Bram Moolenaar4de6a212014-03-08 16:13:44 +0100236 N_("number must be greater than zero"));
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200237 return -1;
238 }
239 }
240 else if (flags & NUMBER_UNSIGNED)
241 {
242 if (*result < 0)
243 {
244 PyErr_SET_STRING(PyExc_ValueError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200245 N_("number must be greater or equal to zero"));
Bram Moolenaar141be8a2013-06-23 14:16:57 +0200246 return -1;
247 }
248 }
249
250 return 0;
251}
252
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200253 static int
254add_string(PyObject *list, char *s)
255{
256 PyObject *string;
257
258 if (!(string = PyString_FromString(s)))
259 return -1;
Bram Moolenaar808c2bc2013-06-23 13:11:18 +0200260
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200261 if (PyList_Append(list, string))
262 {
263 Py_DECREF(string);
264 return -1;
265 }
266
267 Py_DECREF(string);
268 return 0;
269}
270
271 static PyObject *
272ObjectDir(PyObject *self, char **attributes)
273{
274 PyMethodDef *method;
275 char **attr;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200276 PyObject *ret;
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200277
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200278 if (!(ret = PyList_New(0)))
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200279 return NULL;
280
281 if (self)
282 for (method = self->ob_type->tp_methods ; method->ml_name != NULL ; ++method)
Bram Moolenaar41009372013-07-01 22:03:04 +0200283 if (add_string(ret, (char *)method->ml_name))
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200284 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200285 Py_DECREF(ret);
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200286 return NULL;
287 }
288
289 for (attr = attributes ; *attr ; ++attr)
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200290 if (add_string(ret, *attr))
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200291 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200292 Py_DECREF(ret);
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200293 return NULL;
294 }
295
296#if PY_MAJOR_VERSION < 3
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200297 if (add_string(ret, "__members__"))
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200298 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200299 Py_DECREF(ret);
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200300 return NULL;
301 }
302#endif
303
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200304 return ret;
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200305}
306
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100307// Output buffer management
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200308
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100309// Function to write a line, points to either msg() or emsg().
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200310typedef void (*writefn)(char_u *);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200311
312static PyTypeObject OutputType;
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200313
314typedef struct
315{
316 PyObject_HEAD
317 long softspace;
318 long error;
319} OutputObject;
320
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200321static char *OutputAttrs[] = {
322 "softspace",
323 NULL
324};
325
326 static PyObject *
327OutputDir(PyObject *self)
328{
329 return ObjectDir(self, OutputAttrs);
330}
331
Bram Moolenaar77045652012-09-21 13:46:06 +0200332 static int
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200333OutputSetattr(OutputObject *self, char *name, PyObject *valObject)
Bram Moolenaar77045652012-09-21 13:46:06 +0200334{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200335 if (valObject == NULL)
Bram Moolenaar77045652012-09-21 13:46:06 +0200336 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +0200337 PyErr_SET_STRING(PyExc_AttributeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200338 N_("can't delete OutputObject attributes"));
Bram Moolenaar77045652012-09-21 13:46:06 +0200339 return -1;
340 }
341
342 if (strcmp(name, "softspace") == 0)
343 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200344 if (NumberToLong(valObject, &(self->softspace), NUMBER_UNSIGNED))
Bram Moolenaar77045652012-09-21 13:46:06 +0200345 return -1;
Bram Moolenaar77045652012-09-21 13:46:06 +0200346 return 0;
347 }
348
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200349 PyErr_FORMAT(PyExc_AttributeError, N_("invalid attribute: %s"), name);
Bram Moolenaar77045652012-09-21 13:46:06 +0200350 return -1;
351}
352
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100353// Buffer IO, we write one whole line at a time.
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200354static garray_T io_ga = {0, 0, 1, 80, NULL};
355static writefn old_fn = NULL;
356
357 static void
358PythonIO_Flush(void)
359{
360 if (old_fn != NULL && io_ga.ga_len > 0)
361 {
362 ((char_u *)io_ga.ga_data)[io_ga.ga_len] = NUL;
363 old_fn((char_u *)io_ga.ga_data);
364 }
365 io_ga.ga_len = 0;
366}
367
368 static void
369writer(writefn fn, char_u *str, PyInt n)
370{
371 char_u *ptr;
372
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100373 // Flush when switching output function.
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200374 if (fn != old_fn)
375 PythonIO_Flush();
376 old_fn = fn;
377
Bram Moolenaarb98678a2019-10-19 15:18:44 +0200378 // Write each NL separated line. Text after the last NL is kept for
379 // writing later.
380 // For normal messages: Do not output when "got_int" was set. This avoids
381 // a loop gone crazy flooding the terminal with messages. Also for when
382 // "q" is pressed at the more-prompt.
383 while (n > 0 && (ptr = memchr(str, '\n', n)) != NULL
384 && (fn == (writefn)emsg || !got_int))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200385 {
386 PyInt len = ptr - str;
387
388 if (ga_grow(&io_ga, (int)(len + 1)) == FAIL)
389 break;
390
391 mch_memmove(((char *)io_ga.ga_data) + io_ga.ga_len, str, (size_t)len);
392 ((char *)io_ga.ga_data)[io_ga.ga_len + len] = NUL;
393 fn((char_u *)io_ga.ga_data);
394 str = ptr + 1;
395 n -= len + 1;
396 io_ga.ga_len = 0;
397 }
398
Bram Moolenaarb98678a2019-10-19 15:18:44 +0200399 // Put the remaining text into io_ga for later printing.
400 if (n > 0 && (fn == (writefn)emsg || !got_int)
401 && ga_grow(&io_ga, (int)(n + 1)) == OK)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200402 {
403 mch_memmove(((char *)io_ga.ga_data) + io_ga.ga_len, str, (size_t)n);
404 io_ga.ga_len += (int)n;
405 }
406}
407
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +0200408 static int
409write_output(OutputObject *self, PyObject *string)
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200410{
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +0200411 Py_ssize_t len = 0;
412 char *str = NULL;
413 int error = self->error;
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200414
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +0200415 if (!PyArg_Parse(string, "et#", ENC_OPT, &str, &len))
416 return -1;
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200417
418 Py_BEGIN_ALLOW_THREADS
419 Python_Lock_Vim();
Bram Moolenaar7f3a2842019-05-18 15:02:25 +0200420 if (error)
421 emsg_severe = TRUE;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100422 writer((writefn)(error ? emsg : msg), (char_u *)str, len);
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200423 Python_Release_Vim();
424 Py_END_ALLOW_THREADS
Bram Moolenaar19e60942011-06-19 00:27:51 +0200425 PyMem_Free(str);
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200426
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +0200427 return 0;
428}
429
430 static PyObject *
431OutputWrite(OutputObject *self, PyObject *string)
432{
433 if (write_output(self, string))
434 return NULL;
435
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200436 Py_INCREF(Py_None);
437 return Py_None;
438}
439
440 static PyObject *
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +0200441OutputWritelines(OutputObject *self, PyObject *seq)
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200442{
Bram Moolenaar01a7a722013-05-30 12:26:58 +0200443 PyObject *iterator;
444 PyObject *item;
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200445
Bram Moolenaar01a7a722013-05-30 12:26:58 +0200446 if (!(iterator = PyObject_GetIter(seq)))
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200447 return NULL;
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200448
Bram Moolenaar01a7a722013-05-30 12:26:58 +0200449 while ((item = PyIter_Next(iterator)))
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200450 {
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +0200451 if (write_output(self, item))
Bram Moolenaardb913952012-06-29 12:54:53 +0200452 {
Bram Moolenaar01a7a722013-05-30 12:26:58 +0200453 Py_DECREF(iterator);
454 Py_DECREF(item);
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200455 return NULL;
456 }
Bram Moolenaar01a7a722013-05-30 12:26:58 +0200457 Py_DECREF(item);
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200458 }
459
Bram Moolenaar01a7a722013-05-30 12:26:58 +0200460 Py_DECREF(iterator);
461
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100462 // Iterator may have finished due to an exception
Bram Moolenaar01a7a722013-05-30 12:26:58 +0200463 if (PyErr_Occurred())
464 return NULL;
465
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200466 Py_INCREF(Py_None);
467 return Py_None;
468}
469
Bram Moolenaara29a37d2011-03-22 15:47:44 +0100470 static PyObject *
Bram Moolenaard4247472015-11-02 13:28:59 +0100471AlwaysNone(PyObject *self UNUSED)
Bram Moolenaara29a37d2011-03-22 15:47:44 +0100472{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100473 // do nothing
Bram Moolenaara29a37d2011-03-22 15:47:44 +0100474 Py_INCREF(Py_None);
475 return Py_None;
476}
477
Bram Moolenaard4247472015-11-02 13:28:59 +0100478 static PyObject *
479AlwaysFalse(PyObject *self UNUSED)
480{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100481 // do nothing
Bram Moolenaare7427f42015-11-10 13:24:20 +0100482 PyObject *ret = Py_False;
483 Py_INCREF(ret);
484 return ret;
Bram Moolenaard4247472015-11-02 13:28:59 +0100485}
486
487 static PyObject *
488AlwaysTrue(PyObject *self UNUSED)
489{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100490 // do nothing
Bram Moolenaare7427f42015-11-10 13:24:20 +0100491 PyObject *ret = Py_True;
492 Py_INCREF(ret);
493 return ret;
Bram Moolenaard4247472015-11-02 13:28:59 +0100494}
495
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200496/***************/
497
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200498static struct PyMethodDef OutputMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100499 // name, function, calling, doc
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +0200500 {"write", (PyCFunction)OutputWrite, METH_O, ""},
501 {"writelines", (PyCFunction)OutputWritelines, METH_O, ""},
Bram Moolenaard4247472015-11-02 13:28:59 +0100502 {"flush", (PyCFunction)AlwaysNone, METH_NOARGS, ""},
503 {"close", (PyCFunction)AlwaysNone, METH_NOARGS, ""},
504 {"isatty", (PyCFunction)AlwaysFalse, METH_NOARGS, ""},
505 {"readable", (PyCFunction)AlwaysFalse, METH_NOARGS, ""},
506 {"seekable", (PyCFunction)AlwaysFalse, METH_NOARGS, ""},
507 {"writable", (PyCFunction)AlwaysTrue, METH_NOARGS, ""},
Bram Moolenaar6d4431e2016-04-21 20:00:56 +0200508 {"closed", (PyCFunction)AlwaysFalse, METH_NOARGS, ""},
Bram Moolenaardd8aca62013-05-29 22:36:10 +0200509 {"__dir__", (PyCFunction)OutputDir, METH_NOARGS, ""},
Bram Moolenaar182dc4f2013-05-21 19:01:55 +0200510 { NULL, NULL, 0, NULL}
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200511};
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200512
513static OutputObject Output =
514{
515 PyObject_HEAD_INIT(&OutputType)
516 0,
517 0
518};
519
520static OutputObject Error =
521{
522 PyObject_HEAD_INIT(&OutputType)
523 0,
524 1
525};
526
527 static int
528PythonIO_Init_io(void)
529{
Bram Moolenaarc1ba10c2013-06-10 20:39:03 +0200530 if (PySys_SetObject("stdout", (PyObject *)(void *)&Output))
531 return -1;
532 if (PySys_SetObject("stderr", (PyObject *)(void *)&Error))
533 return -1;
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200534
535 if (PyErr_Occurred())
536 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100537 emsg(_("E264: Python: Error initialising I/O objects"));
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200538 return -1;
539 }
540
541 return 0;
542}
543
Bram Moolenaar79a494d2018-07-22 04:30:21 +0200544#if PY_VERSION_HEX < 0x030700f0
Bram Moolenaar447bd5a2018-08-07 19:45:27 +0200545static PyObject *call_load_module(char *name, int len, PyObject *find_module_result);
546
Bram Moolenaar81c40c52013-06-12 14:41:04 +0200547typedef struct
548{
549 PyObject_HEAD
Bram Moolenaar447bd5a2018-08-07 19:45:27 +0200550 char *fullname;
551 PyObject *result;
Bram Moolenaar81c40c52013-06-12 14:41:04 +0200552} LoaderObject;
553static PyTypeObject LoaderType;
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200554
Bram Moolenaar81c40c52013-06-12 14:41:04 +0200555 static void
556LoaderDestructor(LoaderObject *self)
557{
Bram Moolenaar447bd5a2018-08-07 19:45:27 +0200558 vim_free(self->fullname);
559 Py_XDECREF(self->result);
Bram Moolenaar81c40c52013-06-12 14:41:04 +0200560 DESTRUCTOR_FINISH(self);
561}
562
563 static PyObject *
564LoaderLoadModule(LoaderObject *self, PyObject *args UNUSED)
565{
Bram Moolenaar447bd5a2018-08-07 19:45:27 +0200566 char *fullname = self->fullname;
567 PyObject *result = self->result;
568 PyObject *module;
Bram Moolenaar81c40c52013-06-12 14:41:04 +0200569
Bram Moolenaar447bd5a2018-08-07 19:45:27 +0200570 if (!fullname)
571 {
572 module = result ? result : Py_None;
573 Py_INCREF(module);
574 return module;
575 }
576
577 module = call_load_module(fullname, (int)STRLEN(fullname), result);
578
579 self->fullname = NULL;
580 self->result = module;
581
582 vim_free(fullname);
583 Py_DECREF(result);
584
585 if (!module)
586 {
587 if (PyErr_Occurred())
588 return NULL;
589
590 Py_INCREF(Py_None);
591 return Py_None;
592 }
593
594 Py_INCREF(module);
595 return module;
Bram Moolenaar81c40c52013-06-12 14:41:04 +0200596}
597
598static struct PyMethodDef LoaderMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100599 // name, function, calling, doc
Bram Moolenaar81c40c52013-06-12 14:41:04 +0200600 {"load_module", (PyCFunction)LoaderLoadModule, METH_VARARGS, ""},
601 { NULL, NULL, 0, NULL}
602};
Bram Moolenaar79a494d2018-07-22 04:30:21 +0200603#endif
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200604
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100605/*
606 * Check to see whether a Vim error has been reported, or a keyboard
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200607 * interrupt has been detected.
608 */
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200609 static void
610VimTryStart(void)
611{
612 ++trylevel;
613}
614
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200615 static int
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200616VimTryEnd(void)
617{
618 --trylevel;
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100619 // Without this it stops processing all subsequent Vim script commands and
620 // generates strange error messages if I e.g. try calling Test() in a cycle
Bram Moolenaar841fbd22013-06-23 14:37:07 +0200621 did_emsg = FALSE;
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100622 // Keyboard interrupt should be preferred over anything else
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200623 if (got_int)
624 {
Bram Moolenaar4315f262014-01-31 14:54:04 +0100625 if (did_throw)
Bram Moolenaard6b8a522013-11-11 01:05:48 +0100626 discard_current_exception();
Bram Moolenaard6b8a522013-11-11 01:05:48 +0100627 got_int = FALSE;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200628 PyErr_SetNone(PyExc_KeyboardInterrupt);
Bram Moolenaar841fbd22013-06-23 14:37:07 +0200629 return -1;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200630 }
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100631 else if (msg_list != NULL && *msg_list != NULL)
632 {
633 int should_free;
Bram Moolenaarb1443b42019-01-13 23:51:14 +0100634 char *msg;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100635
636 msg = get_exception_string(*msg_list, ET_ERROR, NULL, &should_free);
637
638 if (msg == NULL)
639 {
640 PyErr_NoMemory();
641 return -1;
642 }
643
Bram Moolenaarb1443b42019-01-13 23:51:14 +0100644 PyErr_SetVim(msg);
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100645
646 free_global_msglist();
647
648 if (should_free)
649 vim_free(msg);
650
651 return -1;
652 }
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200653 else if (!did_throw)
Bram Moolenaar841fbd22013-06-23 14:37:07 +0200654 return (PyErr_Occurred() ? -1 : 0);
Bram Moolenaar86181df2020-05-11 23:14:04 +0200655 // Python exception is preferred over Vim one; unlikely to occur though
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200656 else if (PyErr_Occurred())
Bram Moolenaar841fbd22013-06-23 14:37:07 +0200657 {
Bram Moolenaar4315f262014-01-31 14:54:04 +0100658 discard_current_exception();
Bram Moolenaar841fbd22013-06-23 14:37:07 +0200659 return -1;
660 }
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100661 // Finally transform Vim script exception to python one
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200662 else
663 {
Bram Moolenaar41009372013-07-01 22:03:04 +0200664 PyErr_SetVim((char *)current_exception->value);
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200665 discard_current_exception();
Bram Moolenaar841fbd22013-06-23 14:37:07 +0200666 return -1;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200667 }
668}
669
670 static int
671VimCheckInterrupt(void)
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200672{
673 if (got_int)
674 {
675 PyErr_SetNone(PyExc_KeyboardInterrupt);
676 return 1;
677 }
Bram Moolenaar170bf1a2010-07-24 23:51:45 +0200678 return 0;
679}
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200680
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100681// Vim module - Implementation
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +0200682
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200683 static PyObject *
Bram Moolenaar389a1792013-06-23 13:00:44 +0200684VimCommand(PyObject *self UNUSED, PyObject *string)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200685{
Bram Moolenaar389a1792013-06-23 13:00:44 +0200686 char_u *cmd;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200687 PyObject *ret;
Bram Moolenaar389a1792013-06-23 13:00:44 +0200688 PyObject *todecref;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200689
Bram Moolenaar389a1792013-06-23 13:00:44 +0200690 if (!(cmd = StringToChars(string, &todecref)))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200691 return NULL;
692
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200693 Py_BEGIN_ALLOW_THREADS
694 Python_Lock_Vim();
695
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200696 VimTryStart();
Bram Moolenaar389a1792013-06-23 13:00:44 +0200697 do_cmdline_cmd(cmd);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200698 update_screen(VALID);
699
700 Python_Release_Vim();
701 Py_END_ALLOW_THREADS
702
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200703 if (VimTryEnd())
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200704 ret = NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200705 else
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200706 ret = Py_None;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200707
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200708 Py_XINCREF(ret);
Bram Moolenaar389a1792013-06-23 13:00:44 +0200709 Py_XDECREF(todecref);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200710 return ret;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200711}
712
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200713/*
714 * Function to translate a typval_T into a PyObject; this will recursively
715 * translate lists/dictionaries into their Python equivalents.
716 *
717 * The depth parameter is to avoid infinite recursion, set it to 1 when
718 * you call VimToPython.
719 */
720 static PyObject *
Bram Moolenaarb38caae2013-05-29 22:39:52 +0200721VimToPython(typval_T *our_tv, int depth, PyObject *lookup_dict)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200722{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200723 PyObject *ret;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200724 PyObject *newObj;
Bram Moolenaardb913952012-06-29 12:54:53 +0200725 char ptrBuf[sizeof(void *) * 2 + 3];
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200726
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100727 // Avoid infinite recursion
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200728 if (depth > 100)
729 {
730 Py_INCREF(Py_None);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200731 ret = Py_None;
732 return ret;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200733 }
734
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100735 // Check if we run into a recursive loop. The item must be in lookup_dict
736 // then and we can use it again.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200737 if ((our_tv->v_type == VAR_LIST && our_tv->vval.v_list != NULL)
738 || (our_tv->v_type == VAR_DICT && our_tv->vval.v_dict != NULL))
739 {
Bram Moolenaardb913952012-06-29 12:54:53 +0200740 sprintf(ptrBuf, "%p",
741 our_tv->v_type == VAR_LIST ? (void *)our_tv->vval.v_list
742 : (void *)our_tv->vval.v_dict);
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200743
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200744 if ((ret = PyDict_GetItemString(lookup_dict, ptrBuf)))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200745 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200746 Py_INCREF(ret);
747 return ret;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200748 }
749 }
750
751 if (our_tv->v_type == VAR_STRING)
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200752 ret = PyString_FromString(our_tv->vval.v_string == NULL
Bram Moolenaard1f13fd2012-10-05 21:30:07 +0200753 ? "" : (char *)our_tv->vval.v_string);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200754 else if (our_tv->v_type == VAR_NUMBER)
755 {
756 char buf[NUMBUFLEN];
757
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100758 // For backwards compatibility numbers are stored as strings.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200759 sprintf(buf, "%ld", (long)our_tv->vval.v_number);
Bram Moolenaar41009372013-07-01 22:03:04 +0200760 ret = PyString_FromString((char *)buf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200761 }
Bram Moolenaarb999ba22019-02-14 13:28:45 +0100762#ifdef FEAT_FLOAT
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200763 else if (our_tv->v_type == VAR_FLOAT)
764 {
765 char buf[NUMBUFLEN];
766
767 sprintf(buf, "%f", our_tv->vval.v_float);
Bram Moolenaar41009372013-07-01 22:03:04 +0200768 ret = PyString_FromString((char *)buf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200769 }
Bram Moolenaarb999ba22019-02-14 13:28:45 +0100770#endif
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200771 else if (our_tv->v_type == VAR_LIST)
772 {
773 list_T *list = our_tv->vval.v_list;
774 listitem_T *curr;
775
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200776 if (list == NULL)
777 return NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200778
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200779 if (!(ret = PyList_New(0)))
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200780 return NULL;
781
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200782 if (PyDict_SetItemString(lookup_dict, ptrBuf, ret))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200783 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200784 Py_DECREF(ret);
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200785 return NULL;
786 }
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200787
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200788 CHECK_LIST_MATERIALIZE(list);
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200789 FOR_ALL_LIST_ITEMS(list, curr)
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200790 {
Bram Moolenaarb38caae2013-05-29 22:39:52 +0200791 if (!(newObj = VimToPython(&curr->li_tv, depth + 1, lookup_dict)))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200792 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200793 Py_DECREF(ret);
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200794 return NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200795 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200796 if (PyList_Append(ret, newObj))
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200797 {
798 Py_DECREF(newObj);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200799 Py_DECREF(ret);
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200800 return NULL;
801 }
802 Py_DECREF(newObj);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200803 }
804 }
805 else if (our_tv->v_type == VAR_DICT)
806 {
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200807
Bram Moolenaar24a6ff82015-02-10 18:41:58 +0100808 hashtab_T *ht;
809 long_u todo;
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200810 hashitem_T *hi;
811 dictitem_T *di;
Bram Moolenaar24a6ff82015-02-10 18:41:58 +0100812
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200813 if (our_tv->vval.v_dict == NULL)
814 return NULL;
Bram Moolenaar24a6ff82015-02-10 18:41:58 +0100815 ht = &our_tv->vval.v_dict->dv_hashtab;
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200816
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200817 if (!(ret = PyDict_New()))
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200818 return NULL;
819
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200820 if (PyDict_SetItemString(lookup_dict, ptrBuf, ret))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200821 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200822 Py_DECREF(ret);
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200823 return NULL;
824 }
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200825
Bram Moolenaar24a6ff82015-02-10 18:41:58 +0100826 todo = ht->ht_used;
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200827 for (hi = ht->ht_array; todo > 0; ++hi)
828 {
829 if (!HASHITEM_EMPTY(hi))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200830 {
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200831 --todo;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200832
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200833 di = dict_lookup(hi);
Bram Moolenaarb38caae2013-05-29 22:39:52 +0200834 if (!(newObj = VimToPython(&di->di_tv, depth + 1, lookup_dict)))
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200835 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200836 Py_DECREF(ret);
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200837 return NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200838 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200839 if (PyDict_SetItemString(ret, (char *)hi->hi_key, newObj))
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200840 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200841 Py_DECREF(ret);
Bram Moolenaar21642ed2013-05-29 22:20:01 +0200842 Py_DECREF(newObj);
843 return NULL;
844 }
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200845 }
846 }
847 }
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +0100848 else if (our_tv->v_type == VAR_BOOL)
Bram Moolenaar520e1e42016-01-23 19:46:28 +0100849 {
850 if (our_tv->vval.v_number == VVAL_FALSE)
851 {
852 ret = Py_False;
853 Py_INCREF(ret);
854 }
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +0100855 else
Bram Moolenaar520e1e42016-01-23 19:46:28 +0100856 {
857 ret = Py_True;
858 Py_INCREF(ret);
859 }
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +0100860 return ret;
861 }
862 else if (our_tv->v_type == VAR_SPECIAL)
863 {
864 Py_INCREF(Py_None);
865 ret = Py_None;
Bram Moolenaar520e1e42016-01-23 19:46:28 +0100866 return ret;
867 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +0100868 else if (our_tv->v_type == VAR_BLOB)
869 ret = PyBytes_FromStringAndSize(
870 (char*) our_tv->vval.v_blob->bv_ga.ga_data,
871 (Py_ssize_t) our_tv->vval.v_blob->bv_ga.ga_len);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200872 else
873 {
874 Py_INCREF(Py_None);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200875 ret = Py_None;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200876 }
877
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200878 return ret;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200879}
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200880
881 static PyObject *
Bram Moolenaar774267b2013-05-21 20:51:59 +0200882VimEval(PyObject *self UNUSED, PyObject *args)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200883{
Bram Moolenaar389a1792013-06-23 13:00:44 +0200884 char_u *expr;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200885 typval_T *our_tv;
Bram Moolenaar389a1792013-06-23 13:00:44 +0200886 PyObject *string;
887 PyObject *todecref;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200888 PyObject *ret;
Bram Moolenaar389a1792013-06-23 13:00:44 +0200889 PyObject *lookup_dict;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200890
Bram Moolenaar389a1792013-06-23 13:00:44 +0200891 if (!PyArg_ParseTuple(args, "O", &string))
892 return NULL;
893
894 if (!(expr = StringToChars(string, &todecref)))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200895 return NULL;
896
897 Py_BEGIN_ALLOW_THREADS
898 Python_Lock_Vim();
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200899 VimTryStart();
Bram Moolenaar389a1792013-06-23 13:00:44 +0200900 our_tv = eval_expr(expr, NULL);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200901 Python_Release_Vim();
902 Py_END_ALLOW_THREADS
903
Bram Moolenaar389a1792013-06-23 13:00:44 +0200904 Py_XDECREF(todecref);
905
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200906 if (VimTryEnd())
907 return NULL;
908
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200909 if (our_tv == NULL)
910 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200911 PyErr_SET_VIM(N_("invalid expression"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200912 return NULL;
913 }
914
Bram Moolenaar9bf703d2019-11-30 19:44:38 +0100915 // Convert the Vim type into a Python type. Create a dictionary that's
916 // used to check for recursive loops.
Bram Moolenaar9bb77d62013-05-30 12:14:49 +0200917 if (!(lookup_dict = PyDict_New()))
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200918 ret = NULL;
Bram Moolenaar9bb77d62013-05-30 12:14:49 +0200919 else
920 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200921 ret = VimToPython(our_tv, 1, lookup_dict);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +0200922 Py_DECREF(lookup_dict);
923 }
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200924
925
926 Py_BEGIN_ALLOW_THREADS
927 Python_Lock_Vim();
928 free_tv(our_tv);
929 Python_Release_Vim();
930 Py_END_ALLOW_THREADS
931
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200932 return ret;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +0200933}
934
Bram Moolenaardb913952012-06-29 12:54:53 +0200935static PyObject *ConvertToPyObject(typval_T *);
936
937 static PyObject *
Bram Moolenaar389a1792013-06-23 13:00:44 +0200938VimEvalPy(PyObject *self UNUSED, PyObject *string)
Bram Moolenaardb913952012-06-29 12:54:53 +0200939{
Bram Moolenaardb913952012-06-29 12:54:53 +0200940 typval_T *our_tv;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200941 PyObject *ret;
Bram Moolenaar389a1792013-06-23 13:00:44 +0200942 char_u *expr;
943 PyObject *todecref;
Bram Moolenaardb913952012-06-29 12:54:53 +0200944
Bram Moolenaar389a1792013-06-23 13:00:44 +0200945 if (!(expr = StringToChars(string, &todecref)))
Bram Moolenaardb913952012-06-29 12:54:53 +0200946 return NULL;
947
948 Py_BEGIN_ALLOW_THREADS
949 Python_Lock_Vim();
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200950 VimTryStart();
Bram Moolenaar389a1792013-06-23 13:00:44 +0200951 our_tv = eval_expr(expr, NULL);
Bram Moolenaardb913952012-06-29 12:54:53 +0200952 Python_Release_Vim();
953 Py_END_ALLOW_THREADS
954
Bram Moolenaar389a1792013-06-23 13:00:44 +0200955 Py_XDECREF(todecref);
956
Bram Moolenaara7b64ce2013-05-21 20:40:40 +0200957 if (VimTryEnd())
958 return NULL;
959
Bram Moolenaardb913952012-06-29 12:54:53 +0200960 if (our_tv == NULL)
961 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +0200962 PyErr_SET_VIM(N_("invalid expression"));
Bram Moolenaardb913952012-06-29 12:54:53 +0200963 return NULL;
964 }
965
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200966 ret = ConvertToPyObject(our_tv);
Bram Moolenaardb913952012-06-29 12:54:53 +0200967 Py_BEGIN_ALLOW_THREADS
968 Python_Lock_Vim();
969 free_tv(our_tv);
970 Python_Release_Vim();
971 Py_END_ALLOW_THREADS
972
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200973 return ret;
Bram Moolenaardb913952012-06-29 12:54:53 +0200974}
975
976 static PyObject *
Bram Moolenaar389a1792013-06-23 13:00:44 +0200977VimStrwidth(PyObject *self UNUSED, PyObject *string)
Bram Moolenaardb913952012-06-29 12:54:53 +0200978{
Bram Moolenaar389a1792013-06-23 13:00:44 +0200979 char_u *str;
980 PyObject *todecref;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200981 int len;
Bram Moolenaardb913952012-06-29 12:54:53 +0200982
Bram Moolenaar389a1792013-06-23 13:00:44 +0200983 if (!(str = StringToChars(string, &todecref)))
Bram Moolenaardb913952012-06-29 12:54:53 +0200984 return NULL;
985
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200986 len = mb_string2cells(str, (int)STRLEN(str));
Bram Moolenaar389a1792013-06-23 13:00:44 +0200987
988 Py_XDECREF(todecref);
989
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200990 return PyLong_FromLong(len);
Bram Moolenaardb913952012-06-29 12:54:53 +0200991}
992
Bram Moolenaarf4258302013-06-02 18:20:17 +0200993 static PyObject *
994_VimChdir(PyObject *_chdir, PyObject *args, PyObject *kwargs)
995{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +0200996 PyObject *ret;
Bram Moolenaarf4258302013-06-02 18:20:17 +0200997 PyObject *newwd;
998 PyObject *todecref;
999 char_u *new_dir;
1000
Bram Moolenaard4209d22013-06-05 20:34:15 +02001001 if (_chdir == NULL)
1002 return NULL;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001003 if (!(ret = PyObject_Call(_chdir, args, kwargs)))
Bram Moolenaarf4258302013-06-02 18:20:17 +02001004 return NULL;
1005
1006 if (!(newwd = PyObject_CallFunctionObjArgs(py_getcwd, NULL)))
1007 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001008 Py_DECREF(ret);
Bram Moolenaarf4258302013-06-02 18:20:17 +02001009 return NULL;
1010 }
1011
1012 if (!(new_dir = StringToChars(newwd, &todecref)))
1013 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001014 Py_DECREF(ret);
Bram Moolenaarf4258302013-06-02 18:20:17 +02001015 Py_DECREF(newwd);
1016 return NULL;
1017 }
1018
1019 VimTryStart();
1020
1021 if (vim_chdir(new_dir))
1022 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001023 Py_DECREF(ret);
Bram Moolenaarf4258302013-06-02 18:20:17 +02001024 Py_DECREF(newwd);
1025 Py_XDECREF(todecref);
1026
1027 if (VimTryEnd())
1028 return NULL;
1029
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001030 PyErr_SET_VIM(N_("failed to change directory"));
Bram Moolenaarf4258302013-06-02 18:20:17 +02001031 return NULL;
1032 }
1033
1034 Py_DECREF(newwd);
1035 Py_XDECREF(todecref);
1036
Bram Moolenaar1063f3d2019-05-07 22:06:52 +02001037 post_chdir(CDSCOPE_GLOBAL);
Bram Moolenaarf4258302013-06-02 18:20:17 +02001038
1039 if (VimTryEnd())
1040 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001041 Py_DECREF(ret);
Bram Moolenaarf4258302013-06-02 18:20:17 +02001042 return NULL;
1043 }
1044
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001045 return ret;
Bram Moolenaarf4258302013-06-02 18:20:17 +02001046}
1047
1048 static PyObject *
1049VimChdir(PyObject *self UNUSED, PyObject *args, PyObject *kwargs)
1050{
1051 return _VimChdir(py_chdir, args, kwargs);
1052}
1053
1054 static PyObject *
1055VimFchdir(PyObject *self UNUSED, PyObject *args, PyObject *kwargs)
1056{
1057 return _VimChdir(py_fchdir, args, kwargs);
1058}
1059
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001060typedef struct {
1061 PyObject *callable;
1062 PyObject *result;
1063} map_rtp_data;
1064
1065 static void
1066map_rtp_callback(char_u *path, void *_data)
1067{
1068 void **data = (void **) _data;
1069 PyObject *pathObject;
1070 map_rtp_data *mr_data = *((map_rtp_data **) data);
1071
Bram Moolenaar41009372013-07-01 22:03:04 +02001072 if (!(pathObject = PyString_FromString((char *)path)))
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001073 {
1074 *data = NULL;
1075 return;
1076 }
1077
1078 mr_data->result = PyObject_CallFunctionObjArgs(mr_data->callable,
1079 pathObject, NULL);
1080
1081 Py_DECREF(pathObject);
1082
1083 if (!mr_data->result || mr_data->result != Py_None)
1084 *data = NULL;
1085 else
1086 {
1087 Py_DECREF(mr_data->result);
1088 mr_data->result = NULL;
1089 }
1090}
1091
1092 static PyObject *
Bram Moolenaar389a1792013-06-23 13:00:44 +02001093VimForeachRTP(PyObject *self UNUSED, PyObject *callable)
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001094{
1095 map_rtp_data data;
1096
Bram Moolenaar389a1792013-06-23 13:00:44 +02001097 data.callable = callable;
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001098 data.result = NULL;
1099
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01001100 do_in_runtimepath(NULL, 0, &map_rtp_callback, &data);
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001101
1102 if (data.result == NULL)
1103 {
1104 if (PyErr_Occurred())
1105 return NULL;
1106 else
1107 {
1108 Py_INCREF(Py_None);
1109 return Py_None;
1110 }
1111 }
1112 return data.result;
1113}
1114
1115/*
1116 * _vim_runtimepath_ special path implementation.
1117 */
1118
1119 static void
1120map_finder_callback(char_u *path, void *_data)
1121{
1122 void **data = (void **) _data;
1123 PyObject *list = *((PyObject **) data);
1124 PyObject *pathObject1, *pathObject2;
1125 char *pathbuf;
1126 size_t pathlen;
1127
1128 pathlen = STRLEN(path);
1129
1130#if PY_MAJOR_VERSION < 3
1131# define PY_MAIN_DIR_STRING "python2"
1132#else
1133# define PY_MAIN_DIR_STRING "python3"
1134#endif
1135#define PY_ALTERNATE_DIR_STRING "pythonx"
1136
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001137#define PYTHONX_STRING_LENGTH 7 // STRLEN("pythonx")
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001138 if (!(pathbuf = PyMem_New(char,
1139 pathlen + STRLEN(PATHSEPSTR) + PYTHONX_STRING_LENGTH + 1)))
1140 {
1141 PyErr_NoMemory();
1142 *data = NULL;
1143 return;
1144 }
1145
1146 mch_memmove(pathbuf, path, pathlen + 1);
1147 add_pathsep((char_u *) pathbuf);
1148
1149 pathlen = STRLEN(pathbuf);
1150 mch_memmove(pathbuf + pathlen, PY_MAIN_DIR_STRING,
1151 PYTHONX_STRING_LENGTH + 1);
1152
1153 if (!(pathObject1 = PyString_FromString(pathbuf)))
1154 {
1155 *data = NULL;
1156 PyMem_Free(pathbuf);
1157 return;
1158 }
1159
1160 mch_memmove(pathbuf + pathlen, PY_ALTERNATE_DIR_STRING,
1161 PYTHONX_STRING_LENGTH + 1);
1162
1163 if (!(pathObject2 = PyString_FromString(pathbuf)))
1164 {
1165 Py_DECREF(pathObject1);
1166 PyMem_Free(pathbuf);
1167 *data = NULL;
1168 return;
1169 }
1170
1171 PyMem_Free(pathbuf);
1172
1173 if (PyList_Append(list, pathObject1)
1174 || PyList_Append(list, pathObject2))
1175 *data = NULL;
1176
1177 Py_DECREF(pathObject1);
1178 Py_DECREF(pathObject2);
1179}
1180
1181 static PyObject *
1182Vim_GetPaths(PyObject *self UNUSED)
1183{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001184 PyObject *ret;
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001185
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001186 if (!(ret = PyList_New(0)))
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001187 return NULL;
1188
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01001189 do_in_runtimepath(NULL, 0, &map_finder_callback, ret);
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001190
1191 if (PyErr_Occurred())
1192 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001193 Py_DECREF(ret);
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001194 return NULL;
1195 }
1196
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001197 return ret;
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001198}
1199
Bram Moolenaar79a494d2018-07-22 04:30:21 +02001200#if PY_VERSION_HEX >= 0x030700f0
1201 static PyObject *
1202FinderFindSpec(PyObject *self, PyObject *args)
1203{
1204 char *fullname;
1205 PyObject *paths;
1206 PyObject *target = Py_None;
1207 PyObject *spec;
1208
1209 if (!PyArg_ParseTuple(args, "s|O", &fullname, &target))
1210 return NULL;
1211
1212 if (!(paths = Vim_GetPaths(self)))
1213 return NULL;
1214
Bram Moolenaarde5b3802019-03-30 12:51:22 +01001215 spec = PyObject_CallFunction(py_find_spec, "sOO", fullname, paths, target);
Bram Moolenaar79a494d2018-07-22 04:30:21 +02001216
1217 Py_DECREF(paths);
1218
1219 if (!spec)
1220 {
1221 if (PyErr_Occurred())
1222 return NULL;
1223
1224 Py_INCREF(Py_None);
1225 return Py_None;
1226 }
1227
1228 return spec;
1229}
Bram Moolenaar0b0ad352019-05-20 21:52:45 +02001230
1231 static PyObject *
1232FinderFindModule(PyObject* self UNUSED, PyObject* args UNUSED)
1233{
1234 // Apparently returning None works.
1235 Py_INCREF(Py_None);
1236 return Py_None;
1237}
Bram Moolenaar79a494d2018-07-22 04:30:21 +02001238#else
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001239 static PyObject *
1240call_load_module(char *name, int len, PyObject *find_module_result)
1241{
1242 PyObject *fd, *pathname, *description;
1243
Bram Moolenaarc476e522013-06-23 13:46:40 +02001244 if (!PyTuple_Check(find_module_result))
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001245 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02001246 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001247 N_("expected 3-tuple as imp.find_module() result, but got %s"),
Bram Moolenaarc476e522013-06-23 13:46:40 +02001248 Py_TYPE_NAME(find_module_result));
1249 return NULL;
1250 }
1251 if (PyTuple_GET_SIZE(find_module_result) != 3)
1252 {
1253 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001254 N_("expected 3-tuple as imp.find_module() result, but got "
1255 "tuple of size %d"),
Bram Moolenaarc476e522013-06-23 13:46:40 +02001256 (int) PyTuple_GET_SIZE(find_module_result));
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001257 return NULL;
1258 }
1259
1260 if (!(fd = PyTuple_GET_ITEM(find_module_result, 0))
1261 || !(pathname = PyTuple_GET_ITEM(find_module_result, 1))
1262 || !(description = PyTuple_GET_ITEM(find_module_result, 2)))
1263 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02001264 PyErr_SET_STRING(PyExc_RuntimeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001265 N_("internal error: imp.find_module returned tuple with NULL"));
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001266 return NULL;
1267 }
1268
1269 return PyObject_CallFunction(py_load_module,
1270 "s#OOO", name, len, fd, pathname, description);
1271}
1272
1273 static PyObject *
1274find_module(char *fullname, char *tail, PyObject *new_path)
1275{
1276 PyObject *find_module_result;
1277 PyObject *module;
1278 char *dot;
1279
Bram Moolenaar41009372013-07-01 22:03:04 +02001280 if ((dot = (char *)vim_strchr((char_u *) tail, '.')))
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001281 {
1282 /*
Bram Moolenaaredb07a22013-06-12 18:13:38 +02001283 * There is a dot in the name: call find_module recursively without the
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001284 * first component
1285 */
1286 PyObject *newest_path;
1287 int partlen = (int) (dot - 1 - tail);
1288
1289 if (!(find_module_result = PyObject_CallFunction(py_find_module,
1290 "s#O", tail, partlen, new_path)))
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001291 {
1292 if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_ImportError))
1293 PyErr_Clear();
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001294 return NULL;
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001295 }
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001296
1297 if (!(module = call_load_module(
1298 fullname,
1299 ((int) (tail - fullname)) + partlen,
1300 find_module_result)))
1301 {
1302 Py_DECREF(find_module_result);
1303 return NULL;
1304 }
1305
1306 Py_DECREF(find_module_result);
1307
1308 if (!(newest_path = PyObject_GetAttrString(module, "__path__")))
1309 {
1310 Py_DECREF(module);
1311 return NULL;
1312 }
1313
1314 Py_DECREF(module);
1315
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001316 find_module_result = find_module(fullname, dot + 1, newest_path);
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001317
1318 Py_DECREF(newest_path);
1319
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001320 return find_module_result;
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001321 }
1322 else
1323 {
1324 if (!(find_module_result = PyObject_CallFunction(py_find_module,
1325 "sO", tail, new_path)))
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001326 {
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001327 if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_ImportError))
1328 PyErr_Clear();
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001329 return NULL;
1330 }
1331
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001332 return find_module_result;
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001333 }
1334}
1335
1336 static PyObject *
1337FinderFindModule(PyObject *self, PyObject *args)
1338{
1339 char *fullname;
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001340 PyObject *result;
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001341 PyObject *new_path;
1342 LoaderObject *loader;
1343
1344 if (!PyArg_ParseTuple(args, "s", &fullname))
1345 return NULL;
1346
1347 if (!(new_path = Vim_GetPaths(self)))
1348 return NULL;
1349
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001350 result = find_module(fullname, fullname, new_path);
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001351
1352 Py_DECREF(new_path);
1353
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001354 if (!result)
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001355 {
Bram Moolenaar7e85d3d2013-06-23 16:40:39 +02001356 if (PyErr_Occurred())
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001357 return NULL;
Bram Moolenaar7e85d3d2013-06-23 16:40:39 +02001358
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001359 Py_INCREF(Py_None);
1360 return Py_None;
1361 }
1362
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001363 if (!(fullname = (char *)vim_strsave((char_u *)fullname)))
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001364 {
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001365 Py_DECREF(result);
1366 PyErr_NoMemory();
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001367 return NULL;
1368 }
1369
Bram Moolenaar447bd5a2018-08-07 19:45:27 +02001370 if (!(loader = PyObject_NEW(LoaderObject, &LoaderType)))
1371 {
1372 vim_free(fullname);
1373 Py_DECREF(result);
1374 return NULL;
1375 }
1376
1377 loader->fullname = fullname;
1378 loader->result = result;
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001379
1380 return (PyObject *) loader;
1381}
Bram Moolenaar79a494d2018-07-22 04:30:21 +02001382#endif
Bram Moolenaar81c40c52013-06-12 14:41:04 +02001383
1384 static PyObject *
1385VimPathHook(PyObject *self UNUSED, PyObject *args)
1386{
1387 char *path;
1388
1389 if (PyArg_ParseTuple(args, "s", &path)
1390 && STRCMP(path, vim_special_path) == 0)
1391 {
1392 Py_INCREF(vim_module);
1393 return vim_module;
1394 }
1395
1396 PyErr_Clear();
1397 PyErr_SetNone(PyExc_ImportError);
1398 return NULL;
1399}
1400
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001401/*
1402 * Vim module - Definitions
1403 */
1404
1405static struct PyMethodDef VimMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001406 // name, function, calling, documentation
Bram Moolenaar389a1792013-06-23 13:00:44 +02001407 {"command", VimCommand, METH_O, "Execute a Vim ex-mode command" },
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001408 {"eval", VimEval, METH_VARARGS, "Evaluate an expression using Vim evaluator" },
Bram Moolenaar86181df2020-05-11 23:14:04 +02001409 {"bindeval", VimEvalPy, METH_O, "Like eval(), but returns objects attached to Vim ones"},
Bram Moolenaar389a1792013-06-23 13:00:44 +02001410 {"strwidth", VimStrwidth, METH_O, "Screen string width, counts <Tab> as having width 1"},
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001411 {"chdir", (PyCFunction)VimChdir, METH_VARARGS|METH_KEYWORDS, "Change directory"},
1412 {"fchdir", (PyCFunction)VimFchdir, METH_VARARGS|METH_KEYWORDS, "Change directory"},
Bram Moolenaar389a1792013-06-23 13:00:44 +02001413 {"foreach_rtp", VimForeachRTP, METH_O, "Call given callable for each path in &rtp"},
Bram Moolenaar79a494d2018-07-22 04:30:21 +02001414#if PY_VERSION_HEX >= 0x030700f0
1415 {"find_spec", FinderFindSpec, METH_VARARGS, "Internal use only, returns spec object for any input it receives"},
Bram Moolenaar79a494d2018-07-22 04:30:21 +02001416#endif
Bram Moolenaar0b0ad352019-05-20 21:52:45 +02001417 {"find_module", FinderFindModule, METH_VARARGS, "Internal use only, returns loader object for any input it receives"},
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02001418 {"path_hook", VimPathHook, METH_VARARGS, "Hook function to install in sys.path_hooks"},
1419 {"_get_paths", (PyCFunction)Vim_GetPaths, METH_NOARGS, "Get &rtp-based additions to sys.path"},
1420 { NULL, NULL, 0, NULL}
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001421};
1422
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001423/*
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001424 * Generic iterator object
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001425 */
1426
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001427static PyTypeObject IterType;
1428
1429typedef PyObject *(*nextfun)(void **);
1430typedef void (*destructorfun)(void *);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001431typedef int (*traversefun)(void *, visitproc, void *);
1432typedef int (*clearfun)(void **);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001433
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001434// Main purpose of this object is removing the need for do python
1435// initialization (i.e. PyType_Ready and setting type attributes) for a big
1436// bunch of objects.
Bram Moolenaar4d1da492013-04-24 13:39:15 +02001437typedef struct
1438{
1439 PyObject_HEAD
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001440 void *cur;
1441 nextfun next;
1442 destructorfun destruct;
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001443 traversefun traverse;
1444 clearfun clear;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001445} IterObject;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02001446
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001447 static PyObject *
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001448IterNew(void *start, destructorfun destruct, nextfun next, traversefun traverse,
1449 clearfun clear)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001450{
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001451 IterObject *self;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001452
Bram Moolenaar774267b2013-05-21 20:51:59 +02001453 self = PyObject_GC_New(IterObject, &IterType);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001454 self->cur = start;
1455 self->next = next;
1456 self->destruct = destruct;
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001457 self->traverse = traverse;
1458 self->clear = clear;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001459
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001460 return (PyObject *)(self);
1461}
1462
1463 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02001464IterDestructor(IterObject *self)
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001465{
Bram Moolenaar774267b2013-05-21 20:51:59 +02001466 PyObject_GC_UnTrack((void *)(self));
Bram Moolenaard6e39182013-05-21 18:30:34 +02001467 self->destruct(self->cur);
Bram Moolenaar774267b2013-05-21 20:51:59 +02001468 PyObject_GC_Del((void *)(self));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001469}
1470
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001471 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02001472IterTraverse(IterObject *self, visitproc visit, void *arg)
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001473{
Bram Moolenaard6e39182013-05-21 18:30:34 +02001474 if (self->traverse != NULL)
1475 return self->traverse(self->cur, visit, arg);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001476 else
1477 return 0;
1478}
1479
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001480// Mac OSX defines clear() somewhere.
Bram Moolenaar9e74e302013-05-17 21:20:17 +02001481#ifdef clear
1482# undef clear
1483#endif
1484
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001485 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02001486IterClear(IterObject *self)
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001487{
Bram Moolenaard6e39182013-05-21 18:30:34 +02001488 if (self->clear != NULL)
1489 return self->clear(&self->cur);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02001490 else
1491 return 0;
1492}
1493
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001494 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02001495IterNext(IterObject *self)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001496{
Bram Moolenaard6e39182013-05-21 18:30:34 +02001497 return self->next(&self->cur);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02001498}
1499
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001500 static PyObject *
1501IterIter(PyObject *self)
1502{
Bram Moolenaar1bcabe12013-05-29 22:52:32 +02001503 Py_INCREF(self);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02001504 return self;
1505}
Bram Moolenaardfa38d42013-05-15 13:38:47 +02001506
Bram Moolenaardb913952012-06-29 12:54:53 +02001507typedef struct pylinkedlist_S {
1508 struct pylinkedlist_S *pll_next;
1509 struct pylinkedlist_S *pll_prev;
1510 PyObject *pll_obj;
1511} pylinkedlist_T;
1512
1513static pylinkedlist_T *lastdict = NULL;
1514static pylinkedlist_T *lastlist = NULL;
Bram Moolenaar8110a092016-04-14 15:56:09 +02001515static pylinkedlist_T *lastfunc = NULL;
Bram Moolenaardb913952012-06-29 12:54:53 +02001516
1517 static void
1518pyll_remove(pylinkedlist_T *ref, pylinkedlist_T **last)
1519{
1520 if (ref->pll_prev == NULL)
1521 {
1522 if (ref->pll_next == NULL)
1523 {
1524 *last = NULL;
1525 return;
1526 }
1527 }
1528 else
1529 ref->pll_prev->pll_next = ref->pll_next;
1530
1531 if (ref->pll_next == NULL)
1532 *last = ref->pll_prev;
1533 else
1534 ref->pll_next->pll_prev = ref->pll_prev;
1535}
1536
1537 static void
1538pyll_add(PyObject *self, pylinkedlist_T *ref, pylinkedlist_T **last)
1539{
1540 if (*last == NULL)
1541 ref->pll_prev = NULL;
1542 else
1543 {
1544 (*last)->pll_next = ref;
1545 ref->pll_prev = *last;
1546 }
1547 ref->pll_next = NULL;
1548 ref->pll_obj = self;
1549 *last = ref;
1550}
1551
1552static PyTypeObject DictionaryType;
1553
1554typedef struct
1555{
1556 PyObject_HEAD
1557 dict_T *dict;
1558 pylinkedlist_T ref;
1559} DictionaryObject;
1560
Bram Moolenaara9922d62013-05-30 13:01:18 +02001561static PyObject *DictionaryUpdate(DictionaryObject *, PyObject *, PyObject *);
1562
1563#define NEW_DICTIONARY(dict) DictionaryNew(&DictionaryType, dict)
1564
Bram Moolenaardb913952012-06-29 12:54:53 +02001565 static PyObject *
Bram Moolenaara9922d62013-05-30 13:01:18 +02001566DictionaryNew(PyTypeObject *subtype, dict_T *dict)
Bram Moolenaardb913952012-06-29 12:54:53 +02001567{
1568 DictionaryObject *self;
1569
Bram Moolenaara9922d62013-05-30 13:01:18 +02001570 self = (DictionaryObject *) subtype->tp_alloc(subtype, 0);
Bram Moolenaardb913952012-06-29 12:54:53 +02001571 if (self == NULL)
1572 return NULL;
1573 self->dict = dict;
1574 ++dict->dv_refcount;
1575
1576 pyll_add((PyObject *)(self), &self->ref, &lastdict);
1577
1578 return (PyObject *)(self);
1579}
1580
Bram Moolenaara9922d62013-05-30 13:01:18 +02001581 static dict_T *
Bram Moolenaar5ab9d982013-06-16 14:25:57 +02001582py_dict_alloc(void)
Bram Moolenaara9922d62013-05-30 13:01:18 +02001583{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001584 dict_T *ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001585
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001586 if (!(ret = dict_alloc()))
Bram Moolenaara9922d62013-05-30 13:01:18 +02001587 {
1588 PyErr_NoMemory();
1589 return NULL;
1590 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001591 ++ret->dv_refcount;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001592
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001593 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001594}
1595
1596 static PyObject *
1597DictionaryConstructor(PyTypeObject *subtype, PyObject *args, PyObject *kwargs)
1598{
1599 DictionaryObject *self;
1600 dict_T *dict;
1601
1602 if (!(dict = py_dict_alloc()))
1603 return NULL;
1604
1605 self = (DictionaryObject *) DictionaryNew(subtype, dict);
1606
1607 --dict->dv_refcount;
1608
1609 if (kwargs || PyTuple_Size(args))
1610 {
1611 PyObject *tmp;
1612 if (!(tmp = DictionaryUpdate(self, args, kwargs)))
1613 {
1614 Py_DECREF(self);
1615 return NULL;
1616 }
1617
1618 Py_DECREF(tmp);
1619 }
1620
1621 return (PyObject *)(self);
1622}
1623
Bram Moolenaar4d1da492013-04-24 13:39:15 +02001624 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02001625DictionaryDestructor(DictionaryObject *self)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02001626{
Bram Moolenaard6e39182013-05-21 18:30:34 +02001627 pyll_remove(&self->ref, &lastdict);
1628 dict_unref(self->dict);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02001629
1630 DESTRUCTOR_FINISH(self);
1631}
1632
Bram Moolenaardd8aca62013-05-29 22:36:10 +02001633static char *DictionaryAttrs[] = {
1634 "locked", "scope",
1635 NULL
1636};
1637
1638 static PyObject *
1639DictionaryDir(PyObject *self)
1640{
1641 return ObjectDir(self, DictionaryAttrs);
1642}
1643
Bram Moolenaardb913952012-06-29 12:54:53 +02001644 static int
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001645DictionarySetattr(DictionaryObject *self, char *name, PyObject *valObject)
Bram Moolenaar66b79852012-09-21 14:00:35 +02001646{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001647 if (valObject == NULL)
Bram Moolenaar66b79852012-09-21 14:00:35 +02001648 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02001649 PyErr_SET_STRING(PyExc_AttributeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001650 N_("cannot delete vim.Dictionary attributes"));
Bram Moolenaar66b79852012-09-21 14:00:35 +02001651 return -1;
1652 }
1653
1654 if (strcmp(name, "locked") == 0)
1655 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02001656 if (self->dict->dv_lock == VAR_FIXED)
Bram Moolenaar66b79852012-09-21 14:00:35 +02001657 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001658 PyErr_SET_STRING(PyExc_TypeError,
1659 N_("cannot modify fixed dictionary"));
Bram Moolenaar66b79852012-09-21 14:00:35 +02001660 return -1;
1661 }
1662 else
1663 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001664 int istrue = PyObject_IsTrue(valObject);
Bram Moolenaarb983f752013-05-15 16:11:50 +02001665 if (istrue == -1)
1666 return -1;
1667 else if (istrue)
Bram Moolenaard6e39182013-05-21 18:30:34 +02001668 self->dict->dv_lock = VAR_LOCKED;
Bram Moolenaar66b79852012-09-21 14:00:35 +02001669 else
Bram Moolenaard6e39182013-05-21 18:30:34 +02001670 self->dict->dv_lock = 0;
Bram Moolenaar66b79852012-09-21 14:00:35 +02001671 }
1672 return 0;
1673 }
1674 else
1675 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001676 PyErr_FORMAT(PyExc_AttributeError, N_("cannot set attribute %s"), name);
Bram Moolenaar66b79852012-09-21 14:00:35 +02001677 return -1;
1678 }
1679}
1680
1681 static PyInt
Bram Moolenaard6e39182013-05-21 18:30:34 +02001682DictionaryLength(DictionaryObject *self)
Bram Moolenaardb913952012-06-29 12:54:53 +02001683{
Bram Moolenaard6e39182013-05-21 18:30:34 +02001684 return ((PyInt) (self->dict->dv_hashtab.ht_used));
Bram Moolenaardb913952012-06-29 12:54:53 +02001685}
1686
Bram Moolenaara9922d62013-05-30 13:01:18 +02001687#define DICT_FLAG_HAS_DEFAULT 0x01
1688#define DICT_FLAG_POP 0x02
1689#define DICT_FLAG_NONE_DEFAULT 0x04
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01001690#define DICT_FLAG_RETURN_BOOL 0x08 // Incompatible with DICT_FLAG_POP
Bram Moolenaara9922d62013-05-30 13:01:18 +02001691#define DICT_FLAG_RETURN_PAIR 0x10
1692
Bram Moolenaardb913952012-06-29 12:54:53 +02001693 static PyObject *
Bram Moolenaara9922d62013-05-30 13:01:18 +02001694_DictionaryItem(DictionaryObject *self, PyObject *args, int flags)
Bram Moolenaardb913952012-06-29 12:54:53 +02001695{
Bram Moolenaara9922d62013-05-30 13:01:18 +02001696 PyObject *keyObject;
1697 PyObject *defObject = ((flags & DICT_FLAG_NONE_DEFAULT)? Py_None : NULL);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001698 PyObject *ret;
Bram Moolenaardb913952012-06-29 12:54:53 +02001699 char_u *key;
Bram Moolenaar231e1a12012-09-05 18:45:28 +02001700 dictitem_T *di;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001701 dict_T *dict = self->dict;
1702 hashitem_T *hi;
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001703 PyObject *todecref;
Bram Moolenaardb913952012-06-29 12:54:53 +02001704
Bram Moolenaara9922d62013-05-30 13:01:18 +02001705 if (flags & DICT_FLAG_HAS_DEFAULT)
1706 {
1707 if (!PyArg_ParseTuple(args, "O|O", &keyObject, &defObject))
1708 return NULL;
1709 }
1710 else
1711 keyObject = args;
1712
1713 if (flags & DICT_FLAG_RETURN_BOOL)
1714 defObject = Py_False;
1715
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001716 if (!(key = StringToChars(keyObject, &todecref)))
1717 return NULL;
1718
1719 if (*key == NUL)
1720 {
1721 RAISE_NO_EMPTY_KEYS;
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02001722 Py_XDECREF(todecref);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001723 return NULL;
1724 }
Bram Moolenaardb913952012-06-29 12:54:53 +02001725
Bram Moolenaara9922d62013-05-30 13:01:18 +02001726 hi = hash_find(&dict->dv_hashtab, key);
Bram Moolenaar231e1a12012-09-05 18:45:28 +02001727
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001728 Py_XDECREF(todecref);
Bram Moolenaar696c2112012-09-21 13:43:14 +02001729
Bram Moolenaara9922d62013-05-30 13:01:18 +02001730 if (HASHITEM_EMPTY(hi))
Bram Moolenaar231e1a12012-09-05 18:45:28 +02001731 {
Bram Moolenaara9922d62013-05-30 13:01:18 +02001732 if (defObject)
1733 {
1734 Py_INCREF(defObject);
1735 return defObject;
1736 }
1737 else
1738 {
1739 PyErr_SetObject(PyExc_KeyError, keyObject);
1740 return NULL;
1741 }
1742 }
1743 else if (flags & DICT_FLAG_RETURN_BOOL)
1744 {
Bram Moolenaar0e4eebd2014-02-12 22:08:49 +01001745 ret = Py_True;
1746 Py_INCREF(ret);
1747 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001748 }
1749
1750 di = dict_lookup(hi);
1751
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001752 if (!(ret = ConvertToPyObject(&di->di_tv)))
Bram Moolenaara9922d62013-05-30 13:01:18 +02001753 return NULL;
1754
1755 if (flags & DICT_FLAG_POP)
1756 {
1757 if (dict->dv_lock)
1758 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02001759 RAISE_LOCKED_DICTIONARY;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001760 Py_DECREF(ret);
Bram Moolenaara9922d62013-05-30 13:01:18 +02001761 return NULL;
1762 }
1763
1764 hash_remove(&dict->dv_hashtab, hi);
1765 dictitem_free(di);
1766 }
1767
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001768 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001769}
1770
1771 static PyObject *
1772DictionaryItem(DictionaryObject *self, PyObject *keyObject)
1773{
1774 return _DictionaryItem(self, keyObject, 0);
1775}
1776
1777 static int
1778DictionaryContains(DictionaryObject *self, PyObject *keyObject)
1779{
1780 PyObject *rObj = _DictionaryItem(self, keyObject, DICT_FLAG_RETURN_BOOL);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001781 int ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001782
Bram Moolenaarba2d7ff2013-11-04 00:34:53 +01001783 if (rObj == NULL)
1784 return -1;
1785
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001786 ret = (rObj == Py_True);
Bram Moolenaara9922d62013-05-30 13:01:18 +02001787
Bram Moolenaardee2e312013-06-23 16:35:47 +02001788 Py_DECREF(rObj);
Bram Moolenaara9922d62013-05-30 13:01:18 +02001789
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001790 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001791}
1792
1793typedef struct
1794{
1795 hashitem_T *ht_array;
1796 long_u ht_used;
1797 hashtab_T *ht;
1798 hashitem_T *hi;
Bram Moolenaar99dc19d2013-05-31 20:49:31 +02001799 long_u todo;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001800} dictiterinfo_T;
1801
1802 static PyObject *
1803DictionaryIterNext(dictiterinfo_T **dii)
1804{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001805 PyObject *ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001806
1807 if (!(*dii)->todo)
1808 return NULL;
1809
1810 if ((*dii)->ht->ht_array != (*dii)->ht_array ||
1811 (*dii)->ht->ht_used != (*dii)->ht_used)
1812 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02001813 PyErr_SET_STRING(PyExc_RuntimeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02001814 N_("hashtab changed during iteration"));
Bram Moolenaar231e1a12012-09-05 18:45:28 +02001815 return NULL;
1816 }
Bram Moolenaardb913952012-06-29 12:54:53 +02001817
Bram Moolenaara9922d62013-05-30 13:01:18 +02001818 while (((*dii)->todo) && HASHITEM_EMPTY((*dii)->hi))
1819 ++((*dii)->hi);
1820
1821 --((*dii)->todo);
1822
Bram Moolenaar41009372013-07-01 22:03:04 +02001823 if (!(ret = PyBytes_FromString((char *)(*dii)->hi->hi_key)))
Bram Moolenaara9922d62013-05-30 13:01:18 +02001824 return NULL;
1825
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001826 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001827}
1828
1829 static PyObject *
1830DictionaryIter(DictionaryObject *self)
1831{
1832 dictiterinfo_T *dii;
1833 hashtab_T *ht;
1834
1835 if (!(dii = PyMem_New(dictiterinfo_T, 1)))
1836 {
1837 PyErr_NoMemory();
1838 return NULL;
1839 }
1840
1841 ht = &self->dict->dv_hashtab;
1842 dii->ht_array = ht->ht_array;
1843 dii->ht_used = ht->ht_used;
1844 dii->ht = ht;
1845 dii->hi = dii->ht_array;
1846 dii->todo = dii->ht_used;
1847
1848 return IterNew(dii,
1849 (destructorfun) PyMem_Free, (nextfun) DictionaryIterNext,
1850 NULL, NULL);
Bram Moolenaardb913952012-06-29 12:54:53 +02001851}
1852
1853 static PyInt
Bram Moolenaar5ab9d982013-06-16 14:25:57 +02001854DictionaryAssItem(
1855 DictionaryObject *self, PyObject *keyObject, PyObject *valObject)
Bram Moolenaardb913952012-06-29 12:54:53 +02001856{
1857 char_u *key;
1858 typval_T tv;
Bram Moolenaarb38caae2013-05-29 22:39:52 +02001859 dict_T *dict = self->dict;
Bram Moolenaardb913952012-06-29 12:54:53 +02001860 dictitem_T *di;
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001861 PyObject *todecref;
Bram Moolenaardb913952012-06-29 12:54:53 +02001862
Bram Moolenaarb38caae2013-05-29 22:39:52 +02001863 if (dict->dv_lock)
Bram Moolenaardb913952012-06-29 12:54:53 +02001864 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02001865 RAISE_LOCKED_DICTIONARY;
Bram Moolenaardb913952012-06-29 12:54:53 +02001866 return -1;
1867 }
1868
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001869 if (!(key = StringToChars(keyObject, &todecref)))
1870 return -1;
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02001871
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001872 if (*key == NUL)
1873 {
1874 RAISE_NO_EMPTY_KEYS;
Bram Moolenaar78b59572013-06-02 18:54:21 +02001875 Py_XDECREF(todecref);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001876 return -1;
1877 }
Bram Moolenaardb913952012-06-29 12:54:53 +02001878
Bram Moolenaarb38caae2013-05-29 22:39:52 +02001879 di = dict_find(dict, key, -1);
Bram Moolenaardb913952012-06-29 12:54:53 +02001880
1881 if (valObject == NULL)
1882 {
Bram Moolenaarf27839c2012-06-29 16:19:50 +02001883 hashitem_T *hi;
1884
Bram Moolenaardb913952012-06-29 12:54:53 +02001885 if (di == NULL)
1886 {
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001887 Py_XDECREF(todecref);
Bram Moolenaar4d188da2013-05-15 15:35:09 +02001888 PyErr_SetObject(PyExc_KeyError, keyObject);
Bram Moolenaardb913952012-06-29 12:54:53 +02001889 return -1;
1890 }
Bram Moolenaarb38caae2013-05-29 22:39:52 +02001891 hi = hash_find(&dict->dv_hashtab, di->di_key);
1892 hash_remove(&dict->dv_hashtab, hi);
Bram Moolenaardb913952012-06-29 12:54:53 +02001893 dictitem_free(di);
Bram Moolenaar78b59572013-06-02 18:54:21 +02001894 Py_XDECREF(todecref);
Bram Moolenaardb913952012-06-29 12:54:53 +02001895 return 0;
1896 }
1897
1898 if (ConvertFromPyObject(valObject, &tv) == -1)
Bram Moolenaar78b59572013-06-02 18:54:21 +02001899 {
1900 Py_XDECREF(todecref);
Bram Moolenaardb913952012-06-29 12:54:53 +02001901 return -1;
Bram Moolenaar78b59572013-06-02 18:54:21 +02001902 }
Bram Moolenaardb913952012-06-29 12:54:53 +02001903
1904 if (di == NULL)
1905 {
Bram Moolenaara9922d62013-05-30 13:01:18 +02001906 if (!(di = dictitem_alloc(key)))
Bram Moolenaardb913952012-06-29 12:54:53 +02001907 {
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001908 Py_XDECREF(todecref);
Bram Moolenaardb913952012-06-29 12:54:53 +02001909 PyErr_NoMemory();
1910 return -1;
1911 }
Bram Moolenaara9922d62013-05-30 13:01:18 +02001912 di->di_tv.v_type = VAR_UNKNOWN;
Bram Moolenaardb913952012-06-29 12:54:53 +02001913
Bram Moolenaarb38caae2013-05-29 22:39:52 +02001914 if (dict_add(dict, di) == FAIL)
Bram Moolenaardb913952012-06-29 12:54:53 +02001915 {
Bram Moolenaara9922d62013-05-30 13:01:18 +02001916 dictitem_free(di);
Bram Moolenaarc476e522013-06-23 13:46:40 +02001917 RAISE_KEY_ADD_FAIL(key);
1918 Py_XDECREF(todecref);
Bram Moolenaardb913952012-06-29 12:54:53 +02001919 return -1;
1920 }
1921 }
1922 else
1923 clear_tv(&di->di_tv);
1924
Bram Moolenaar35eacd72013-05-30 22:06:33 +02001925 Py_XDECREF(todecref);
Bram Moolenaardb913952012-06-29 12:54:53 +02001926
1927 copy_tv(&tv, &di->di_tv);
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02001928 clear_tv(&tv);
Bram Moolenaardb913952012-06-29 12:54:53 +02001929 return 0;
1930}
1931
Bram Moolenaara9922d62013-05-30 13:01:18 +02001932typedef PyObject *(*hi_to_py)(hashitem_T *);
1933
Bram Moolenaardb913952012-06-29 12:54:53 +02001934 static PyObject *
Bram Moolenaara9922d62013-05-30 13:01:18 +02001935DictionaryListObjects(DictionaryObject *self, hi_to_py hiconvert)
Bram Moolenaardb913952012-06-29 12:54:53 +02001936{
Bram Moolenaard6e39182013-05-21 18:30:34 +02001937 dict_T *dict = self->dict;
Bram Moolenaardb913952012-06-29 12:54:53 +02001938 long_u todo = dict->dv_hashtab.ht_used;
1939 Py_ssize_t i = 0;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001940 PyObject *ret;
Bram Moolenaardb913952012-06-29 12:54:53 +02001941 hashitem_T *hi;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001942 PyObject *newObj;
Bram Moolenaardb913952012-06-29 12:54:53 +02001943
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001944 ret = PyList_New(todo);
Bram Moolenaardb913952012-06-29 12:54:53 +02001945 for (hi = dict->dv_hashtab.ht_array; todo > 0; ++hi)
1946 {
1947 if (!HASHITEM_EMPTY(hi))
1948 {
Bram Moolenaara9922d62013-05-30 13:01:18 +02001949 if (!(newObj = hiconvert(hi)))
1950 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001951 Py_DECREF(ret);
Bram Moolenaara9922d62013-05-30 13:01:18 +02001952 return NULL;
1953 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001954 PyList_SET_ITEM(ret, i, newObj);
Bram Moolenaardb913952012-06-29 12:54:53 +02001955 --todo;
1956 ++i;
1957 }
1958 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001959 return ret;
Bram Moolenaardb913952012-06-29 12:54:53 +02001960}
1961
Bram Moolenaara9922d62013-05-30 13:01:18 +02001962 static PyObject *
1963dict_key(hashitem_T *hi)
1964{
1965 return PyBytes_FromString((char *)(hi->hi_key));
1966}
1967
1968 static PyObject *
1969DictionaryListKeys(DictionaryObject *self)
1970{
1971 return DictionaryListObjects(self, dict_key);
1972}
1973
1974 static PyObject *
1975dict_val(hashitem_T *hi)
1976{
1977 dictitem_T *di;
1978
1979 di = dict_lookup(hi);
1980 return ConvertToPyObject(&di->di_tv);
1981}
1982
1983 static PyObject *
1984DictionaryListValues(DictionaryObject *self)
1985{
1986 return DictionaryListObjects(self, dict_val);
1987}
1988
1989 static PyObject *
1990dict_item(hashitem_T *hi)
1991{
1992 PyObject *keyObject;
1993 PyObject *valObject;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02001994 PyObject *ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02001995
1996 if (!(keyObject = dict_key(hi)))
1997 return NULL;
1998
1999 if (!(valObject = dict_val(hi)))
2000 {
2001 Py_DECREF(keyObject);
2002 return NULL;
2003 }
2004
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002005 ret = Py_BuildValue("(OO)", keyObject, valObject);
Bram Moolenaara9922d62013-05-30 13:01:18 +02002006
2007 Py_DECREF(keyObject);
2008 Py_DECREF(valObject);
2009
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002010 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02002011}
2012
2013 static PyObject *
2014DictionaryListItems(DictionaryObject *self)
2015{
2016 return DictionaryListObjects(self, dict_item);
2017}
2018
2019 static PyObject *
2020DictionaryUpdate(DictionaryObject *self, PyObject *args, PyObject *kwargs)
2021{
2022 dict_T *dict = self->dict;
2023
2024 if (dict->dv_lock)
2025 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02002026 RAISE_LOCKED_DICTIONARY;
Bram Moolenaara9922d62013-05-30 13:01:18 +02002027 return NULL;
2028 }
2029
2030 if (kwargs)
2031 {
2032 typval_T tv;
2033
2034 if (ConvertFromPyMapping(kwargs, &tv) == -1)
2035 return NULL;
2036
2037 VimTryStart();
2038 dict_extend(self->dict, tv.vval.v_dict, (char_u *) "force");
2039 clear_tv(&tv);
2040 if (VimTryEnd())
2041 return NULL;
2042 }
2043 else
2044 {
Bram Moolenaar2d5f38f2014-02-11 18:47:27 +01002045 PyObject *obj = NULL;
Bram Moolenaara9922d62013-05-30 13:01:18 +02002046
Bram Moolenaar2d5f38f2014-02-11 18:47:27 +01002047 if (!PyArg_ParseTuple(args, "|O", &obj))
Bram Moolenaara9922d62013-05-30 13:01:18 +02002048 return NULL;
2049
Bram Moolenaar2d5f38f2014-02-11 18:47:27 +01002050 if (obj == NULL)
2051 {
2052 Py_INCREF(Py_None);
2053 return Py_None;
2054 }
2055
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002056 if (PyObject_HasAttrString(obj, "keys"))
2057 return DictionaryUpdate(self, NULL, obj);
Bram Moolenaara9922d62013-05-30 13:01:18 +02002058 else
2059 {
2060 PyObject *iterator;
2061 PyObject *item;
2062
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002063 if (!(iterator = PyObject_GetIter(obj)))
Bram Moolenaara9922d62013-05-30 13:01:18 +02002064 return NULL;
2065
2066 while ((item = PyIter_Next(iterator)))
2067 {
2068 PyObject *fast;
2069 PyObject *keyObject;
2070 PyObject *valObject;
2071 PyObject *todecref;
2072 char_u *key;
2073 dictitem_T *di;
Bram Moolenaar9ed7d342017-11-09 22:10:33 +01002074 hashitem_T *hi;
Bram Moolenaara9922d62013-05-30 13:01:18 +02002075
2076 if (!(fast = PySequence_Fast(item, "")))
2077 {
2078 Py_DECREF(iterator);
2079 Py_DECREF(item);
2080 return NULL;
2081 }
2082
2083 Py_DECREF(item);
2084
2085 if (PySequence_Fast_GET_SIZE(fast) != 2)
2086 {
2087 Py_DECREF(iterator);
2088 Py_DECREF(fast);
Bram Moolenaarc476e522013-06-23 13:46:40 +02002089 PyErr_FORMAT(PyExc_ValueError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002090 N_("expected sequence element of size 2, "
2091 "but got sequence of size %d"),
Bram Moolenaardee2e312013-06-23 16:35:47 +02002092 (int) PySequence_Fast_GET_SIZE(fast));
Bram Moolenaara9922d62013-05-30 13:01:18 +02002093 return NULL;
2094 }
2095
2096 keyObject = PySequence_Fast_GET_ITEM(fast, 0);
2097
2098 if (!(key = StringToChars(keyObject, &todecref)))
2099 {
2100 Py_DECREF(iterator);
2101 Py_DECREF(fast);
2102 return NULL;
2103 }
2104
2105 di = dictitem_alloc(key);
2106
2107 Py_XDECREF(todecref);
2108
2109 if (di == NULL)
2110 {
2111 Py_DECREF(fast);
2112 Py_DECREF(iterator);
2113 PyErr_NoMemory();
2114 return NULL;
2115 }
Bram Moolenaara9922d62013-05-30 13:01:18 +02002116 di->di_tv.v_type = VAR_UNKNOWN;
2117
2118 valObject = PySequence_Fast_GET_ITEM(fast, 1);
2119
2120 if (ConvertFromPyObject(valObject, &di->di_tv) == -1)
2121 {
2122 Py_DECREF(iterator);
2123 Py_DECREF(fast);
2124 dictitem_free(di);
2125 return NULL;
2126 }
2127
2128 Py_DECREF(fast);
2129
Bram Moolenaar9ed7d342017-11-09 22:10:33 +01002130 hi = hash_find(&dict->dv_hashtab, di->di_key);
2131 if (!HASHITEM_EMPTY(hi) || dict_add(dict, di) == FAIL)
Bram Moolenaara9922d62013-05-30 13:01:18 +02002132 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02002133 RAISE_KEY_ADD_FAIL(di->di_key);
Bram Moolenaara9922d62013-05-30 13:01:18 +02002134 Py_DECREF(iterator);
2135 dictitem_free(di);
Bram Moolenaara9922d62013-05-30 13:01:18 +02002136 return NULL;
2137 }
2138 }
2139
2140 Py_DECREF(iterator);
2141
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01002142 // Iterator may have finished due to an exception
Bram Moolenaara9922d62013-05-30 13:01:18 +02002143 if (PyErr_Occurred())
2144 return NULL;
2145 }
2146 }
2147 Py_INCREF(Py_None);
2148 return Py_None;
2149}
2150
2151 static PyObject *
2152DictionaryGet(DictionaryObject *self, PyObject *args)
2153{
2154 return _DictionaryItem(self, args,
2155 DICT_FLAG_HAS_DEFAULT|DICT_FLAG_NONE_DEFAULT);
2156}
2157
2158 static PyObject *
2159DictionaryPop(DictionaryObject *self, PyObject *args)
2160{
2161 return _DictionaryItem(self, args, DICT_FLAG_HAS_DEFAULT|DICT_FLAG_POP);
2162}
2163
2164 static PyObject *
Bram Moolenaarde71b562013-06-02 17:41:54 +02002165DictionaryPopItem(DictionaryObject *self)
Bram Moolenaara9922d62013-05-30 13:01:18 +02002166{
Bram Moolenaarde71b562013-06-02 17:41:54 +02002167 hashitem_T *hi;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002168 PyObject *ret;
Bram Moolenaarde71b562013-06-02 17:41:54 +02002169 PyObject *valObject;
2170 dictitem_T *di;
Bram Moolenaara9922d62013-05-30 13:01:18 +02002171
Bram Moolenaarde71b562013-06-02 17:41:54 +02002172 if (self->dict->dv_hashtab.ht_used == 0)
2173 {
2174 PyErr_SetNone(PyExc_KeyError);
2175 return NULL;
2176 }
2177
2178 hi = self->dict->dv_hashtab.ht_array;
2179 while (HASHITEM_EMPTY(hi))
2180 ++hi;
2181
2182 di = dict_lookup(hi);
2183
2184 if (!(valObject = ConvertToPyObject(&di->di_tv)))
Bram Moolenaara9922d62013-05-30 13:01:18 +02002185 return NULL;
2186
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002187 if (!(ret = Py_BuildValue("(" Py_bytes_fmt "O)", hi->hi_key, valObject)))
Bram Moolenaarde71b562013-06-02 17:41:54 +02002188 {
2189 Py_DECREF(valObject);
2190 return NULL;
2191 }
2192
2193 hash_remove(&self->dict->dv_hashtab, hi);
2194 dictitem_free(di);
2195
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002196 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02002197}
2198
2199 static PyObject *
Bram Moolenaar389a1792013-06-23 13:00:44 +02002200DictionaryHasKey(DictionaryObject *self, PyObject *keyObject)
Bram Moolenaara9922d62013-05-30 13:01:18 +02002201{
Bram Moolenaara9922d62013-05-30 13:01:18 +02002202 return _DictionaryItem(self, keyObject, DICT_FLAG_RETURN_BOOL);
2203}
2204
2205static PySequenceMethods DictionaryAsSeq = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01002206 0, // sq_length
2207 0, // sq_concat
2208 0, // sq_repeat
2209 0, // sq_item
2210 0, // sq_slice
2211 0, // sq_ass_item
2212 0, // sq_ass_slice
2213 (objobjproc) DictionaryContains, // sq_contains
2214 0, // sq_inplace_concat
2215 0, // sq_inplace_repeat
Bram Moolenaara9922d62013-05-30 13:01:18 +02002216};
2217
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02002218static PyMappingMethods DictionaryAsMapping = {
2219 (lenfunc) DictionaryLength,
2220 (binaryfunc) DictionaryItem,
2221 (objobjargproc) DictionaryAssItem,
2222};
2223
Bram Moolenaardb913952012-06-29 12:54:53 +02002224static struct PyMethodDef DictionaryMethods[] = {
Bram Moolenaar182dc4f2013-05-21 19:01:55 +02002225 {"keys", (PyCFunction)DictionaryListKeys, METH_NOARGS, ""},
Bram Moolenaara9922d62013-05-30 13:01:18 +02002226 {"values", (PyCFunction)DictionaryListValues, METH_NOARGS, ""},
2227 {"items", (PyCFunction)DictionaryListItems, METH_NOARGS, ""},
2228 {"update", (PyCFunction)DictionaryUpdate, METH_VARARGS|METH_KEYWORDS, ""},
2229 {"get", (PyCFunction)DictionaryGet, METH_VARARGS, ""},
2230 {"pop", (PyCFunction)DictionaryPop, METH_VARARGS, ""},
Bram Moolenaarde71b562013-06-02 17:41:54 +02002231 {"popitem", (PyCFunction)DictionaryPopItem, METH_NOARGS, ""},
Bram Moolenaar389a1792013-06-23 13:00:44 +02002232 {"has_key", (PyCFunction)DictionaryHasKey, METH_O, ""},
Bram Moolenaardd8aca62013-05-29 22:36:10 +02002233 {"__dir__", (PyCFunction)DictionaryDir, METH_NOARGS, ""},
2234 { NULL, NULL, 0, NULL}
Bram Moolenaardb913952012-06-29 12:54:53 +02002235};
2236
2237static PyTypeObject ListType;
2238
2239typedef struct
2240{
2241 PyObject_HEAD
2242 list_T *list;
2243 pylinkedlist_T ref;
2244} ListObject;
2245
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002246#define NEW_LIST(list) ListNew(&ListType, list)
2247
Bram Moolenaardb913952012-06-29 12:54:53 +02002248 static PyObject *
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002249ListNew(PyTypeObject *subtype, list_T *list)
Bram Moolenaardb913952012-06-29 12:54:53 +02002250{
2251 ListObject *self;
2252
Bram Moolenaarab589462020-07-06 21:03:06 +02002253 if (list == NULL)
2254 return NULL;
2255
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002256 self = (ListObject *) subtype->tp_alloc(subtype, 0);
Bram Moolenaardb913952012-06-29 12:54:53 +02002257 if (self == NULL)
2258 return NULL;
2259 self->list = list;
2260 ++list->lv_refcount;
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002261 CHECK_LIST_MATERIALIZE(list);
Bram Moolenaardb913952012-06-29 12:54:53 +02002262
2263 pyll_add((PyObject *)(self), &self->ref, &lastlist);
2264
2265 return (PyObject *)(self);
2266}
2267
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002268 static list_T *
Bram Moolenaarfb97f282013-07-09 17:42:46 +02002269py_list_alloc(void)
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002270{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002271 list_T *ret;
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002272
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002273 if (!(ret = list_alloc()))
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002274 {
2275 PyErr_NoMemory();
2276 return NULL;
2277 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002278 ++ret->lv_refcount;
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002279
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002280 return ret;
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002281}
2282
2283 static int
2284list_py_concat(list_T *l, PyObject *obj, PyObject *lookup_dict)
2285{
2286 PyObject *iterator;
2287 PyObject *item;
2288 listitem_T *li;
2289
2290 if (!(iterator = PyObject_GetIter(obj)))
2291 return -1;
2292
2293 while ((item = PyIter_Next(iterator)))
2294 {
2295 if (!(li = listitem_alloc()))
2296 {
2297 PyErr_NoMemory();
2298 Py_DECREF(item);
2299 Py_DECREF(iterator);
2300 return -1;
2301 }
2302 li->li_tv.v_lock = 0;
2303 li->li_tv.v_type = VAR_UNKNOWN;
2304
2305 if (_ConvertFromPyObject(item, &li->li_tv, lookup_dict) == -1)
2306 {
2307 Py_DECREF(item);
2308 Py_DECREF(iterator);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002309 listitem_free(l, li);
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002310 return -1;
2311 }
2312
2313 Py_DECREF(item);
2314
2315 list_append(l, li);
2316 }
2317
2318 Py_DECREF(iterator);
2319
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01002320 // Iterator may have finished due to an exception
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002321 if (PyErr_Occurred())
2322 return -1;
2323
2324 return 0;
2325}
2326
2327 static PyObject *
2328ListConstructor(PyTypeObject *subtype, PyObject *args, PyObject *kwargs)
2329{
2330 list_T *list;
2331 PyObject *obj = NULL;
2332
2333 if (kwargs)
2334 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02002335 PyErr_SET_STRING(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002336 N_("list constructor does not accept keyword arguments"));
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02002337 return NULL;
2338 }
2339
2340 if (!PyArg_ParseTuple(args, "|O", &obj))
2341 return NULL;
2342
2343 if (!(list = py_list_alloc()))
2344 return NULL;
2345
2346 if (obj)
2347 {
2348 PyObject *lookup_dict;
2349
2350 if (!(lookup_dict = PyDict_New()))
2351 {
2352 list_unref(list);
2353 return NULL;
2354 }
2355
2356 if (list_py_concat(list, obj, lookup_dict) == -1)
2357 {
2358 Py_DECREF(lookup_dict);
2359 list_unref(list);
2360 return NULL;
2361 }
2362
2363 Py_DECREF(lookup_dict);
2364 }
2365
2366 return ListNew(subtype, list);
2367}
2368
Bram Moolenaar4d1da492013-04-24 13:39:15 +02002369 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02002370ListDestructor(ListObject *self)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02002371{
Bram Moolenaard6e39182013-05-21 18:30:34 +02002372 pyll_remove(&self->ref, &lastlist);
2373 list_unref(self->list);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02002374
2375 DESTRUCTOR_FINISH(self);
2376}
2377
Bram Moolenaardb913952012-06-29 12:54:53 +02002378 static PyInt
Bram Moolenaard6e39182013-05-21 18:30:34 +02002379ListLength(ListObject *self)
Bram Moolenaardb913952012-06-29 12:54:53 +02002380{
Bram Moolenaard6e39182013-05-21 18:30:34 +02002381 return ((PyInt) (self->list->lv_len));
Bram Moolenaardb913952012-06-29 12:54:53 +02002382}
2383
2384 static PyObject *
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002385ListIndex(ListObject *self, Py_ssize_t index)
Bram Moolenaardb913952012-06-29 12:54:53 +02002386{
2387 listitem_T *li;
2388
Bram Moolenaard6e39182013-05-21 18:30:34 +02002389 if (index >= ListLength(self))
Bram Moolenaardb913952012-06-29 12:54:53 +02002390 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002391 PyErr_SET_STRING(PyExc_IndexError, N_("list index out of range"));
Bram Moolenaardb913952012-06-29 12:54:53 +02002392 return NULL;
2393 }
Bram Moolenaard6e39182013-05-21 18:30:34 +02002394 li = list_find(self->list, (long) index);
Bram Moolenaardb913952012-06-29 12:54:53 +02002395 if (li == NULL)
2396 {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01002397 // No more suitable format specifications in python-2.3
Bram Moolenaar86181df2020-05-11 23:14:04 +02002398 PyErr_VIM_FORMAT(N_("internal error: failed to get Vim list item %d"),
Bram Moolenaarc476e522013-06-23 13:46:40 +02002399 (int) index);
Bram Moolenaardb913952012-06-29 12:54:53 +02002400 return NULL;
2401 }
2402 return ConvertToPyObject(&li->li_tv);
2403}
2404
Bram Moolenaardb913952012-06-29 12:54:53 +02002405 static PyObject *
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002406ListSlice(ListObject *self, Py_ssize_t first, Py_ssize_t step,
2407 Py_ssize_t slicelen)
Bram Moolenaardb913952012-06-29 12:54:53 +02002408{
2409 PyInt i;
Bram Moolenaardb913952012-06-29 12:54:53 +02002410 PyObject *list;
Bram Moolenaardb913952012-06-29 12:54:53 +02002411
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002412 if (step == 0)
2413 {
2414 PyErr_SET_STRING(PyExc_ValueError, N_("slice step cannot be zero"));
2415 return NULL;
2416 }
Bram Moolenaardb913952012-06-29 12:54:53 +02002417
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002418 list = PyList_New(slicelen);
Bram Moolenaardb913952012-06-29 12:54:53 +02002419 if (list == NULL)
2420 return NULL;
2421
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002422 for (i = 0; i < slicelen; ++i)
Bram Moolenaardb913952012-06-29 12:54:53 +02002423 {
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002424 PyObject *item;
2425
2426 item = ListIndex(self, first + i*step);
Bram Moolenaardb913952012-06-29 12:54:53 +02002427 if (item == NULL)
2428 {
2429 Py_DECREF(list);
2430 return NULL;
2431 }
2432
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002433 PyList_SET_ITEM(list, i, item);
Bram Moolenaardb913952012-06-29 12:54:53 +02002434 }
2435
2436 return list;
2437}
2438
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002439 static PyObject *
2440ListItem(ListObject *self, PyObject* idx)
2441{
2442#if PY_MAJOR_VERSION < 3
2443 if (PyInt_Check(idx))
2444 {
2445 long _idx = PyInt_AsLong(idx);
2446 return ListIndex(self, _idx);
2447 }
2448 else
2449#endif
2450 if (PyLong_Check(idx))
2451 {
2452 long _idx = PyLong_AsLong(idx);
2453 return ListIndex(self, _idx);
2454 }
2455 else if (PySlice_Check(idx))
2456 {
2457 Py_ssize_t start, stop, step, slicelen;
2458
Bram Moolenaar922a4662014-03-30 16:11:43 +02002459 if (PySlice_GetIndicesEx((PySliceObject_T *)idx, ListLength(self),
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002460 &start, &stop, &step, &slicelen) < 0)
2461 return NULL;
2462 return ListSlice(self, start, step, slicelen);
2463 }
2464 else
2465 {
2466 RAISE_INVALID_INDEX_TYPE(idx);
2467 return NULL;
2468 }
2469}
2470
2471 static void
2472list_restore(Py_ssize_t numadded, Py_ssize_t numreplaced, Py_ssize_t slicelen,
2473 list_T *l, listitem_T **lis, listitem_T *lastaddedli)
2474{
2475 while (numreplaced--)
2476 {
2477 list_insert(l, lis[numreplaced], lis[slicelen + numreplaced]);
2478 listitem_remove(l, lis[slicelen + numreplaced]);
2479 }
2480 while (numadded--)
2481 {
2482 listitem_T *next;
2483
2484 next = lastaddedli->li_prev;
2485 listitem_remove(l, lastaddedli);
2486 lastaddedli = next;
2487 }
2488}
2489
2490 static int
2491ListAssSlice(ListObject *self, Py_ssize_t first,
2492 Py_ssize_t step, Py_ssize_t slicelen, PyObject *obj)
2493{
2494 PyObject *iterator;
2495 PyObject *item;
2496 listitem_T *li;
2497 listitem_T *lastaddedli = NULL;
2498 listitem_T *next;
2499 typval_T v;
2500 list_T *l = self->list;
2501 PyInt i;
2502 PyInt j;
2503 PyInt numreplaced = 0;
2504 PyInt numadded = 0;
2505 PyInt size;
Bram Moolenaar3b522612014-02-11 16:00:35 +01002506 listitem_T **lis = NULL;
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002507
2508 size = ListLength(self);
2509
2510 if (l->lv_lock)
2511 {
2512 RAISE_LOCKED_LIST;
2513 return -1;
2514 }
2515
2516 if (step == 0)
2517 {
2518 PyErr_SET_STRING(PyExc_ValueError, N_("slice step cannot be zero"));
2519 return -1;
2520 }
2521
2522 if (step != 1 && slicelen == 0)
2523 {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01002524 // Nothing to do. Only error out if obj has some items.
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002525 int ret = 0;
2526
2527 if (obj == NULL)
2528 return 0;
2529
2530 if (!(iterator = PyObject_GetIter(obj)))
2531 return -1;
2532
2533 if ((item = PyIter_Next(iterator)))
2534 {
2535 PyErr_FORMAT(PyExc_ValueError,
Bram Moolenaar4de6a212014-03-08 16:13:44 +01002536 N_("attempt to assign sequence of size greater than %d "
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002537 "to extended slice"), 0);
2538 Py_DECREF(item);
2539 ret = -1;
2540 }
2541 Py_DECREF(iterator);
2542 return ret;
2543 }
2544
2545 if (obj != NULL)
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01002546 // XXX May allocate zero bytes.
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002547 if (!(lis = PyMem_New(listitem_T *, slicelen * 2)))
2548 {
2549 PyErr_NoMemory();
2550 return -1;
2551 }
2552
2553 if (first == size)
2554 li = NULL;
2555 else
2556 {
2557 li = list_find(l, (long) first);
2558 if (li == NULL)
2559 {
Bram Moolenaar86181df2020-05-11 23:14:04 +02002560 PyErr_VIM_FORMAT(N_("internal error: no Vim list item %d"),
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002561 (int)first);
2562 if (obj != NULL)
2563 PyMem_Free(lis);
2564 return -1;
2565 }
2566 i = slicelen;
2567 while (i-- && li != NULL)
2568 {
2569 j = step;
2570 next = li;
2571 if (step > 0)
2572 while (next != NULL && ((next = next->li_next) != NULL) && --j);
2573 else
2574 while (next != NULL && ((next = next->li_prev) != NULL) && ++j);
2575
2576 if (obj == NULL)
2577 listitem_remove(l, li);
2578 else
2579 lis[slicelen - i - 1] = li;
2580
2581 li = next;
2582 }
2583 if (li == NULL && i != -1)
2584 {
2585 PyErr_SET_VIM(N_("internal error: not enough list items"));
2586 if (obj != NULL)
2587 PyMem_Free(lis);
2588 return -1;
2589 }
2590 }
2591
2592 if (obj == NULL)
2593 return 0;
2594
2595 if (!(iterator = PyObject_GetIter(obj)))
2596 {
2597 PyMem_Free(lis);
2598 return -1;
2599 }
2600
2601 i = 0;
2602 while ((item = PyIter_Next(iterator)))
2603 {
2604 if (ConvertFromPyObject(item, &v) == -1)
2605 {
2606 Py_DECREF(iterator);
2607 Py_DECREF(item);
2608 PyMem_Free(lis);
2609 return -1;
2610 }
2611 Py_DECREF(item);
2612 if (list_insert_tv(l, &v, numreplaced < slicelen
2613 ? lis[numreplaced]
2614 : li) == FAIL)
2615 {
2616 clear_tv(&v);
2617 PyErr_SET_VIM(N_("internal error: failed to add item to list"));
2618 list_restore(numadded, numreplaced, slicelen, l, lis, lastaddedli);
2619 PyMem_Free(lis);
2620 return -1;
2621 }
2622 if (numreplaced < slicelen)
2623 {
2624 lis[slicelen + numreplaced] = lis[numreplaced]->li_prev;
Bram Moolenaar3ec7f4e2014-05-07 17:31:37 +02002625 vimlist_remove(l, lis[numreplaced], lis[numreplaced]);
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002626 numreplaced++;
2627 }
2628 else
2629 {
2630 if (li)
2631 lastaddedli = li->li_prev;
2632 else
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002633 lastaddedli = l->lv_u.mat.lv_last;
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002634 numadded++;
2635 }
2636 clear_tv(&v);
2637 if (step != 1 && i >= slicelen)
2638 {
2639 Py_DECREF(iterator);
2640 PyErr_FORMAT(PyExc_ValueError,
Bram Moolenaar4de6a212014-03-08 16:13:44 +01002641 N_("attempt to assign sequence of size greater than %d "
Bram Moolenaar403b3cf2014-02-15 15:59:03 +01002642 "to extended slice"), (int) slicelen);
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002643 list_restore(numadded, numreplaced, slicelen, l, lis, lastaddedli);
2644 PyMem_Free(lis);
2645 return -1;
2646 }
2647 ++i;
2648 }
2649 Py_DECREF(iterator);
2650
2651 if (step != 1 && i != slicelen)
2652 {
2653 PyErr_FORMAT2(PyExc_ValueError,
Bram Moolenaar403b3cf2014-02-15 15:59:03 +01002654 N_("attempt to assign sequence of size %d to extended slice "
2655 "of size %d"), (int) i, (int) slicelen);
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002656 list_restore(numadded, numreplaced, slicelen, l, lis, lastaddedli);
2657 PyMem_Free(lis);
2658 return -1;
2659 }
2660
2661 if (PyErr_Occurred())
2662 {
2663 list_restore(numadded, numreplaced, slicelen, l, lis, lastaddedli);
2664 PyMem_Free(lis);
2665 return -1;
2666 }
2667
2668 for (i = 0; i < numreplaced; i++)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002669 listitem_free(l, lis[i]);
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002670 if (step == 1)
2671 for (i = numreplaced; i < slicelen; i++)
2672 listitem_remove(l, lis[i]);
2673
2674 PyMem_Free(lis);
2675
2676 return 0;
2677}
2678
2679 static int
2680ListAssIndex(ListObject *self, Py_ssize_t index, PyObject *obj)
2681{
2682 typval_T tv;
2683 list_T *l = self->list;
2684 listitem_T *li;
2685 Py_ssize_t length = ListLength(self);
2686
2687 if (l->lv_lock)
2688 {
2689 RAISE_LOCKED_LIST;
2690 return -1;
2691 }
2692 if (index > length || (index == length && obj == NULL))
2693 {
2694 PyErr_SET_STRING(PyExc_IndexError, N_("list index out of range"));
2695 return -1;
2696 }
2697
2698 if (obj == NULL)
2699 {
2700 li = list_find(l, (long) index);
Bram Moolenaarab589462020-07-06 21:03:06 +02002701 if (li == NULL)
2702 {
2703 PyErr_VIM_FORMAT(N_("internal error: failed to get Vim "
2704 "list item %d"), (int) index);
2705 return -1;
2706 }
Bram Moolenaar3ec7f4e2014-05-07 17:31:37 +02002707 vimlist_remove(l, li, li);
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002708 clear_tv(&li->li_tv);
2709 vim_free(li);
2710 return 0;
2711 }
2712
2713 if (ConvertFromPyObject(obj, &tv) == -1)
2714 return -1;
2715
2716 if (index == length)
2717 {
2718 if (list_append_tv(l, &tv) == FAIL)
2719 {
2720 clear_tv(&tv);
2721 PyErr_SET_VIM(N_("failed to add item to list"));
2722 return -1;
2723 }
2724 }
2725 else
2726 {
2727 li = list_find(l, (long) index);
Bram Moolenaarab589462020-07-06 21:03:06 +02002728 if (li == NULL)
2729 {
2730 PyErr_VIM_FORMAT(N_("internal error: failed to get Vim "
2731 "list item %d"), (int) index);
2732 return -1;
2733 }
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002734 clear_tv(&li->li_tv);
2735 copy_tv(&tv, &li->li_tv);
2736 clear_tv(&tv);
2737 }
2738 return 0;
2739}
2740
2741 static Py_ssize_t
2742ListAssItem(ListObject *self, PyObject *idx, PyObject *obj)
2743{
2744#if PY_MAJOR_VERSION < 3
2745 if (PyInt_Check(idx))
2746 {
2747 long _idx = PyInt_AsLong(idx);
2748 return ListAssIndex(self, _idx, obj);
2749 }
2750 else
2751#endif
2752 if (PyLong_Check(idx))
2753 {
2754 long _idx = PyLong_AsLong(idx);
2755 return ListAssIndex(self, _idx, obj);
2756 }
2757 else if (PySlice_Check(idx))
2758 {
2759 Py_ssize_t start, stop, step, slicelen;
2760
Bram Moolenaar922a4662014-03-30 16:11:43 +02002761 if (PySlice_GetIndicesEx((PySliceObject_T *)idx, ListLength(self),
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002762 &start, &stop, &step, &slicelen) < 0)
2763 return -1;
2764 return ListAssSlice(self, start, step, slicelen,
2765 obj);
2766 }
2767 else
2768 {
2769 RAISE_INVALID_INDEX_TYPE(idx);
2770 return -1;
2771 }
2772}
2773
2774 static PyObject *
2775ListConcatInPlace(ListObject *self, PyObject *obj)
2776{
2777 list_T *l = self->list;
2778 PyObject *lookup_dict;
2779
2780 if (l->lv_lock)
2781 {
2782 RAISE_LOCKED_LIST;
2783 return NULL;
2784 }
2785
2786 if (!(lookup_dict = PyDict_New()))
2787 return NULL;
2788
2789 if (list_py_concat(l, obj, lookup_dict) == -1)
2790 {
2791 Py_DECREF(lookup_dict);
2792 return NULL;
2793 }
2794 Py_DECREF(lookup_dict);
2795
2796 Py_INCREF(self);
2797 return (PyObject *)(self);
2798}
2799
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002800typedef struct
2801{
2802 listwatch_T lw;
2803 list_T *list;
2804} listiterinfo_T;
2805
2806 static void
2807ListIterDestruct(listiterinfo_T *lii)
2808{
2809 list_rem_watch(lii->list, &lii->lw);
2810 PyMem_Free(lii);
2811}
2812
2813 static PyObject *
2814ListIterNext(listiterinfo_T **lii)
2815{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002816 PyObject *ret;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002817
2818 if (!((*lii)->lw.lw_item))
2819 return NULL;
2820
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002821 if (!(ret = ConvertToPyObject(&((*lii)->lw.lw_item->li_tv))))
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002822 return NULL;
2823
2824 (*lii)->lw.lw_item = (*lii)->lw.lw_item->li_next;
2825
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002826 return ret;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002827}
2828
2829 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02002830ListIter(ListObject *self)
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002831{
2832 listiterinfo_T *lii;
Bram Moolenaard6e39182013-05-21 18:30:34 +02002833 list_T *l = self->list;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002834
2835 if (!(lii = PyMem_New(listiterinfo_T, 1)))
2836 {
2837 PyErr_NoMemory();
2838 return NULL;
2839 }
2840
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002841 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002842 list_add_watch(l, &lii->lw);
2843 lii->lw.lw_item = l->lv_first;
2844 lii->list = l;
2845
2846 return IterNew(lii,
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02002847 (destructorfun) ListIterDestruct, (nextfun) ListIterNext,
2848 NULL, NULL);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02002849}
2850
Bram Moolenaardd8aca62013-05-29 22:36:10 +02002851static char *ListAttrs[] = {
2852 "locked",
2853 NULL
2854};
2855
2856 static PyObject *
2857ListDir(PyObject *self)
2858{
2859 return ObjectDir(self, ListAttrs);
2860}
2861
Bram Moolenaar66b79852012-09-21 14:00:35 +02002862 static int
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002863ListSetattr(ListObject *self, char *name, PyObject *valObject)
Bram Moolenaar66b79852012-09-21 14:00:35 +02002864{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002865 if (valObject == NULL)
Bram Moolenaar66b79852012-09-21 14:00:35 +02002866 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02002867 PyErr_SET_STRING(PyExc_AttributeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002868 N_("cannot delete vim.List attributes"));
Bram Moolenaar66b79852012-09-21 14:00:35 +02002869 return -1;
2870 }
2871
2872 if (strcmp(name, "locked") == 0)
2873 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02002874 if (self->list->lv_lock == VAR_FIXED)
Bram Moolenaar66b79852012-09-21 14:00:35 +02002875 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002876 PyErr_SET_STRING(PyExc_TypeError, N_("cannot modify fixed list"));
Bram Moolenaar66b79852012-09-21 14:00:35 +02002877 return -1;
2878 }
2879 else
2880 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002881 int istrue = PyObject_IsTrue(valObject);
Bram Moolenaarb983f752013-05-15 16:11:50 +02002882 if (istrue == -1)
2883 return -1;
2884 else if (istrue)
Bram Moolenaard6e39182013-05-21 18:30:34 +02002885 self->list->lv_lock = VAR_LOCKED;
Bram Moolenaar66b79852012-09-21 14:00:35 +02002886 else
Bram Moolenaard6e39182013-05-21 18:30:34 +02002887 self->list->lv_lock = 0;
Bram Moolenaar66b79852012-09-21 14:00:35 +02002888 }
2889 return 0;
2890 }
2891 else
2892 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002893 PyErr_FORMAT(PyExc_AttributeError, N_("cannot set attribute %s"), name);
Bram Moolenaar66b79852012-09-21 14:00:35 +02002894 return -1;
2895 }
2896}
2897
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002898static PySequenceMethods ListAsSeq = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01002899 (lenfunc) ListLength, // sq_length, len(x)
2900 (binaryfunc) 0, // RangeConcat, sq_concat, x+y
2901 0, // RangeRepeat, sq_repeat, x*n
2902 (PyIntArgFunc) ListIndex, // sq_item, x[i]
2903 0, // was_sq_slice, x[i:j]
2904 (PyIntObjArgProc) ListAssIndex, // sq_as_item, x[i]=v
2905 0, // was_sq_ass_slice, x[i:j]=v
2906 0, // sq_contains
2907 (binaryfunc) ListConcatInPlace,// sq_inplace_concat
2908 0, // sq_inplace_repeat
Bram Moolenaar063a46b2014-01-14 16:36:51 +01002909};
2910
2911static PyMappingMethods ListAsMapping = {
2912 /* mp_length */ (lenfunc) ListLength,
2913 /* mp_subscript */ (binaryfunc) ListItem,
2914 /* mp_ass_subscript */ (objobjargproc) ListAssItem,
2915};
2916
Bram Moolenaardb913952012-06-29 12:54:53 +02002917static struct PyMethodDef ListMethods[] = {
Bram Moolenaardd8aca62013-05-29 22:36:10 +02002918 {"extend", (PyCFunction)ListConcatInPlace, METH_O, ""},
2919 {"__dir__", (PyCFunction)ListDir, METH_NOARGS, ""},
2920 { NULL, NULL, 0, NULL}
Bram Moolenaardb913952012-06-29 12:54:53 +02002921};
2922
2923typedef struct
2924{
2925 PyObject_HEAD
2926 char_u *name;
Bram Moolenaar8110a092016-04-14 15:56:09 +02002927 int argc;
2928 typval_T *argv;
2929 dict_T *self;
2930 pylinkedlist_T ref;
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02002931 int auto_rebind;
Bram Moolenaardb913952012-06-29 12:54:53 +02002932} FunctionObject;
2933
2934static PyTypeObject FunctionType;
2935
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02002936#define NEW_FUNCTION(name, argc, argv, self, pt_auto) \
2937 FunctionNew(&FunctionType, (name), (argc), (argv), (self), (pt_auto))
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002938
Bram Moolenaardb913952012-06-29 12:54:53 +02002939 static PyObject *
Bram Moolenaar8110a092016-04-14 15:56:09 +02002940FunctionNew(PyTypeObject *subtype, char_u *name, int argc, typval_T *argv,
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02002941 dict_T *selfdict, int auto_rebind)
Bram Moolenaardb913952012-06-29 12:54:53 +02002942{
2943 FunctionObject *self;
2944
Bram Moolenaar9123c0b2018-12-22 18:59:06 +01002945 self = (FunctionObject *)subtype->tp_alloc(subtype, 0);
Bram Moolenaardb913952012-06-29 12:54:53 +02002946 if (self == NULL)
2947 return NULL;
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002948
2949 if (isdigit(*name))
Bram Moolenaardb913952012-06-29 12:54:53 +02002950 {
Bram Moolenaara14bb7e2020-04-28 00:02:41 +02002951 if (!translated_function_exists(name, FALSE))
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002952 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02002953 PyErr_FORMAT(PyExc_ValueError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002954 N_("unnamed function %s does not exist"), name);
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002955 return NULL;
2956 }
2957 self->name = vim_strsave(name);
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002958 }
2959 else
Bram Moolenaar9123c0b2018-12-22 18:59:06 +01002960 {
2961 char_u *p;
2962
2963 if ((p = get_expanded_name(name,
2964 vim_strchr(name, AUTOLOAD_CHAR) == NULL)) == NULL)
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002965 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02002966 PyErr_FORMAT(PyExc_ValueError,
2967 N_("function %s does not exist"), name);
Bram Moolenaar018acca2013-05-30 13:37:28 +02002968 return NULL;
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002969 }
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002970
Bram Moolenaar9123c0b2018-12-22 18:59:06 +01002971 if (p[0] == K_SPECIAL && p[1] == KS_EXTRA && p[2] == (int)KE_SNR)
2972 {
2973 char_u *np;
2974 size_t len = STRLEN(p) + 1;
2975
Bram Moolenaar51e14382019-05-25 20:21:28 +02002976 if ((np = alloc(len + 2)) == NULL)
Bram Moolenaar9123c0b2018-12-22 18:59:06 +01002977 {
2978 vim_free(p);
2979 return NULL;
2980 }
2981 mch_memmove(np, "<SNR>", 5);
2982 mch_memmove(np + 5, p + 3, len - 3);
2983 vim_free(p);
2984 self->name = np;
2985 }
2986 else
2987 self->name = p;
2988 }
2989
Bram Moolenaar2d3d60a2016-08-01 16:27:23 +02002990 func_ref(self->name);
Bram Moolenaar8110a092016-04-14 15:56:09 +02002991 self->argc = argc;
2992 self->argv = argv;
2993 self->self = selfdict;
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02002994 self->auto_rebind = selfdict == NULL ? TRUE : auto_rebind;
Bram Moolenaar8110a092016-04-14 15:56:09 +02002995
2996 if (self->argv || self->self)
2997 pyll_add((PyObject *)(self), &self->ref, &lastfunc);
2998
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02002999 return (PyObject *)(self);
3000}
3001
3002 static PyObject *
3003FunctionConstructor(PyTypeObject *subtype, PyObject *args, PyObject *kwargs)
3004{
3005 PyObject *self;
Bram Moolenaar8110a092016-04-14 15:56:09 +02003006 PyObject *selfdictObject;
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003007 PyObject *autoRebindObject;
Bram Moolenaar8110a092016-04-14 15:56:09 +02003008 PyObject *argsObject = NULL;
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003009 char_u *name;
Bram Moolenaar8110a092016-04-14 15:56:09 +02003010 typval_T selfdicttv;
3011 typval_T argstv;
3012 list_T *argslist = NULL;
3013 dict_T *selfdict = NULL;
3014 int argc = 0;
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003015 int auto_rebind = TRUE;
Bram Moolenaar8110a092016-04-14 15:56:09 +02003016 typval_T *argv = NULL;
3017 typval_T *curtv;
3018 listitem_T *li;
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003019
Bram Moolenaar8110a092016-04-14 15:56:09 +02003020 if (kwargs != NULL)
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003021 {
Bram Moolenaar8110a092016-04-14 15:56:09 +02003022 selfdictObject = PyDict_GetItemString(kwargs, "self");
3023 if (selfdictObject != NULL)
3024 {
3025 if (ConvertFromPyMapping(selfdictObject, &selfdicttv) == -1)
3026 return NULL;
3027 selfdict = selfdicttv.vval.v_dict;
3028 }
3029 argsObject = PyDict_GetItemString(kwargs, "args");
3030 if (argsObject != NULL)
3031 {
3032 if (ConvertFromPySequence(argsObject, &argstv) == -1)
3033 {
3034 dict_unref(selfdict);
3035 return NULL;
3036 }
3037 argslist = argstv.vval.v_list;
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003038 CHECK_LIST_MATERIALIZE(argslist);
Bram Moolenaar8110a092016-04-14 15:56:09 +02003039
3040 argc = argslist->lv_len;
3041 if (argc != 0)
3042 {
3043 argv = PyMem_New(typval_T, (size_t) argc);
Bram Moolenaarfe4b1862016-04-15 21:47:54 +02003044 if (argv == NULL)
3045 {
3046 PyErr_NoMemory();
3047 dict_unref(selfdict);
3048 list_unref(argslist);
3049 return NULL;
3050 }
Bram Moolenaar8110a092016-04-14 15:56:09 +02003051 curtv = argv;
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003052 FOR_ALL_LIST_ITEMS(argslist, li)
Bram Moolenaar8110a092016-04-14 15:56:09 +02003053 copy_tv(&li->li_tv, curtv++);
3054 }
3055 list_unref(argslist);
3056 }
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003057 if (selfdict != NULL)
3058 {
3059 auto_rebind = FALSE;
3060 autoRebindObject = PyDict_GetItemString(kwargs, "auto_rebind");
3061 if (autoRebindObject != NULL)
3062 {
3063 auto_rebind = PyObject_IsTrue(autoRebindObject);
3064 if (auto_rebind == -1)
3065 {
3066 dict_unref(selfdict);
3067 list_unref(argslist);
3068 return NULL;
3069 }
3070 }
3071 }
Bram Moolenaardb913952012-06-29 12:54:53 +02003072 }
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003073
Bram Moolenaar389a1792013-06-23 13:00:44 +02003074 if (!PyArg_ParseTuple(args, "et", "ascii", &name))
Bram Moolenaar8110a092016-04-14 15:56:09 +02003075 {
3076 dict_unref(selfdict);
3077 while (argc--)
3078 clear_tv(&argv[argc]);
3079 PyMem_Free(argv);
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003080 return NULL;
Bram Moolenaar8110a092016-04-14 15:56:09 +02003081 }
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003082
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003083 self = FunctionNew(subtype, name, argc, argv, selfdict, auto_rebind);
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003084
Bram Moolenaar389a1792013-06-23 13:00:44 +02003085 PyMem_Free(name);
3086
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003087 return self;
Bram Moolenaardb913952012-06-29 12:54:53 +02003088}
3089
Bram Moolenaar4d1da492013-04-24 13:39:15 +02003090 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02003091FunctionDestructor(FunctionObject *self)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02003092{
Bram Moolenaar8110a092016-04-14 15:56:09 +02003093 int i;
Bram Moolenaard6e39182013-05-21 18:30:34 +02003094 func_unref(self->name);
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02003095 vim_free(self->name);
Bram Moolenaar8110a092016-04-14 15:56:09 +02003096 for (i = 0; i < self->argc; ++i)
3097 clear_tv(&self->argv[i]);
3098 PyMem_Free(self->argv);
3099 dict_unref(self->self);
3100 if (self->argv || self->self)
3101 pyll_remove(&self->ref, &lastfunc);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02003102
3103 DESTRUCTOR_FINISH(self);
3104}
3105
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003106static char *FunctionAttrs[] = {
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003107 "softspace", "args", "self", "auto_rebind",
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003108 NULL
3109};
3110
3111 static PyObject *
3112FunctionDir(PyObject *self)
3113{
3114 return ObjectDir(self, FunctionAttrs);
3115}
3116
Bram Moolenaardb913952012-06-29 12:54:53 +02003117 static PyObject *
Bram Moolenaar8110a092016-04-14 15:56:09 +02003118FunctionAttr(FunctionObject *self, char *name)
3119{
3120 list_T *list;
3121 int i;
3122 if (strcmp(name, "name") == 0)
3123 return PyString_FromString((char *)(self->name));
3124 else if (strcmp(name, "args") == 0)
3125 {
Bram Moolenaar9f289532016-08-26 16:39:03 +02003126 if (self->argv == NULL || (list = list_alloc()) == NULL)
Bram Moolenaar8110a092016-04-14 15:56:09 +02003127 return AlwaysNone(NULL);
Bram Moolenaar9f289532016-08-26 16:39:03 +02003128
Bram Moolenaar8110a092016-04-14 15:56:09 +02003129 for (i = 0; i < self->argc; ++i)
3130 list_append_tv(list, &self->argv[i]);
3131 return NEW_LIST(list);
3132 }
3133 else if (strcmp(name, "self") == 0)
3134 return self->self == NULL
3135 ? AlwaysNone(NULL)
3136 : NEW_DICTIONARY(self->self);
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003137 else if (strcmp(name, "auto_rebind") == 0)
3138 return self->auto_rebind
3139 ? AlwaysTrue(NULL)
3140 : AlwaysFalse(NULL);
Bram Moolenaar8110a092016-04-14 15:56:09 +02003141 else if (strcmp(name, "__members__") == 0)
3142 return ObjectDir(NULL, FunctionAttrs);
3143 return NULL;
3144}
3145
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003146/*
3147 * Populate partial_T given function object.
Bram Moolenaar8110a092016-04-14 15:56:09 +02003148 *
3149 * "exported" should be set to true when it is needed to construct a partial
3150 * that may be stored in a variable (i.e. may be freed by Vim).
3151 */
3152 static void
3153set_partial(FunctionObject *self, partial_T *pt, int exported)
3154{
Bram Moolenaar8110a092016-04-14 15:56:09 +02003155 int i;
3156
3157 pt->pt_name = self->name;
3158 if (self->argv)
3159 {
3160 pt->pt_argc = self->argc;
3161 if (exported)
3162 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003163 pt->pt_argv = ALLOC_CLEAR_MULT(typval_T, self->argc);
Bram Moolenaar8110a092016-04-14 15:56:09 +02003164 for (i = 0; i < pt->pt_argc; ++i)
3165 copy_tv(&self->argv[i], &pt->pt_argv[i]);
3166 }
3167 else
3168 pt->pt_argv = self->argv;
3169 }
3170 else
3171 {
3172 pt->pt_argc = 0;
3173 pt->pt_argv = NULL;
3174 }
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003175 pt->pt_auto = self->auto_rebind || !exported;
Bram Moolenaar8110a092016-04-14 15:56:09 +02003176 pt->pt_dict = self->self;
3177 if (exported && self->self)
3178 ++pt->pt_dict->dv_refcount;
3179 if (exported)
3180 pt->pt_name = vim_strsave(pt->pt_name);
3181 pt->pt_refcount = 1;
3182}
3183
3184 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02003185FunctionCall(FunctionObject *self, PyObject *argsObject, PyObject *kwargs)
Bram Moolenaardb913952012-06-29 12:54:53 +02003186{
Bram Moolenaard6e39182013-05-21 18:30:34 +02003187 char_u *name = self->name;
Bram Moolenaardb913952012-06-29 12:54:53 +02003188 typval_T args;
3189 typval_T selfdicttv;
3190 typval_T rettv;
3191 dict_T *selfdict = NULL;
3192 PyObject *selfdictObject;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003193 PyObject *ret;
Bram Moolenaardb913952012-06-29 12:54:53 +02003194 int error;
Bram Moolenaar8110a092016-04-14 15:56:09 +02003195 partial_T pt;
3196 partial_T *pt_ptr = NULL;
Bram Moolenaardb913952012-06-29 12:54:53 +02003197
Bram Moolenaar8110a092016-04-14 15:56:09 +02003198 if (ConvertFromPySequence(argsObject, &args) == -1)
Bram Moolenaardb913952012-06-29 12:54:53 +02003199 return NULL;
3200
3201 if (kwargs != NULL)
3202 {
3203 selfdictObject = PyDict_GetItemString(kwargs, "self");
3204 if (selfdictObject != NULL)
3205 {
Bram Moolenaara9922d62013-05-30 13:01:18 +02003206 if (ConvertFromPyMapping(selfdictObject, &selfdicttv) == -1)
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02003207 {
3208 clear_tv(&args);
Bram Moolenaardb913952012-06-29 12:54:53 +02003209 return NULL;
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02003210 }
Bram Moolenaardb913952012-06-29 12:54:53 +02003211 selfdict = selfdicttv.vval.v_dict;
3212 }
3213 }
3214
Bram Moolenaar8110a092016-04-14 15:56:09 +02003215 if (self->argv || self->self)
3216 {
Bram Moolenaara80faa82020-04-12 19:37:17 +02003217 CLEAR_FIELD(pt);
Bram Moolenaar8110a092016-04-14 15:56:09 +02003218 set_partial(self, &pt, FALSE);
3219 pt_ptr = &pt;
3220 }
3221
Bram Moolenaar71700b82013-05-15 17:49:05 +02003222 Py_BEGIN_ALLOW_THREADS
3223 Python_Lock_Vim();
3224
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02003225 VimTryStart();
Bram Moolenaar8110a092016-04-14 15:56:09 +02003226 error = func_call(name, &args, pt_ptr, selfdict, &rettv);
Bram Moolenaar71700b82013-05-15 17:49:05 +02003227
3228 Python_Release_Vim();
3229 Py_END_ALLOW_THREADS
3230
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02003231 if (VimTryEnd())
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003232 ret = NULL;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02003233 else if (error != OK)
Bram Moolenaardb913952012-06-29 12:54:53 +02003234 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003235 ret = NULL;
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003236 PyErr_VIM_FORMAT(N_("failed to run function %s"), (char *)name);
Bram Moolenaardb913952012-06-29 12:54:53 +02003237 }
3238 else
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003239 ret = ConvertToPyObject(&rettv);
Bram Moolenaardb913952012-06-29 12:54:53 +02003240
Bram Moolenaardb913952012-06-29 12:54:53 +02003241 clear_tv(&args);
3242 clear_tv(&rettv);
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02003243 if (selfdict != NULL)
3244 clear_tv(&selfdicttv);
Bram Moolenaardb913952012-06-29 12:54:53 +02003245
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003246 return ret;
Bram Moolenaardb913952012-06-29 12:54:53 +02003247}
3248
Bram Moolenaara5b725c2013-05-30 12:43:54 +02003249 static PyObject *
3250FunctionRepr(FunctionObject *self)
3251{
Bram Moolenaar8110a092016-04-14 15:56:09 +02003252 PyObject *ret;
3253 garray_T repr_ga;
3254 int i;
3255 char_u *tofree = NULL;
3256 typval_T tv;
3257 char_u numbuf[NUMBUFLEN];
3258
3259 ga_init2(&repr_ga, (int)sizeof(char), 70);
3260 ga_concat(&repr_ga, (char_u *)"<vim.Function '");
3261 if (self->name)
3262 ga_concat(&repr_ga, self->name);
3263 else
3264 ga_concat(&repr_ga, (char_u *)"<NULL>");
3265 ga_append(&repr_ga, '\'');
3266 if (self->argv)
3267 {
3268 ga_concat(&repr_ga, (char_u *)", args=[");
3269 ++emsg_silent;
3270 for (i = 0; i < self->argc; i++)
3271 {
3272 if (i != 0)
3273 ga_concat(&repr_ga, (char_u *)", ");
3274 ga_concat(&repr_ga, tv2string(&self->argv[i], &tofree, numbuf,
3275 get_copyID()));
3276 vim_free(tofree);
3277 }
3278 --emsg_silent;
3279 ga_append(&repr_ga, ']');
3280 }
3281 if (self->self)
3282 {
3283 ga_concat(&repr_ga, (char_u *)", self=");
3284 tv.v_type = VAR_DICT;
3285 tv.vval.v_dict = self->self;
3286 ++emsg_silent;
3287 ga_concat(&repr_ga, tv2string(&tv, &tofree, numbuf, get_copyID()));
3288 --emsg_silent;
3289 vim_free(tofree);
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02003290 if (self->auto_rebind)
3291 ga_concat(&repr_ga, (char_u *)", auto_rebind=True");
Bram Moolenaar8110a092016-04-14 15:56:09 +02003292 }
3293 ga_append(&repr_ga, '>');
3294 ret = PyString_FromString((char *)repr_ga.ga_data);
3295 ga_clear(&repr_ga);
3296 return ret;
Bram Moolenaara5b725c2013-05-30 12:43:54 +02003297}
3298
Bram Moolenaardb913952012-06-29 12:54:53 +02003299static struct PyMethodDef FunctionMethods[] = {
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003300 {"__dir__", (PyCFunction)FunctionDir, METH_NOARGS, ""},
3301 { NULL, NULL, 0, NULL}
Bram Moolenaardb913952012-06-29 12:54:53 +02003302};
3303
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003304/*
3305 * Options object
3306 */
3307
3308static PyTypeObject OptionsType;
3309
3310typedef int (*checkfun)(void *);
3311
3312typedef struct
3313{
3314 PyObject_HEAD
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01003315 int opt_type;
3316 void *from;
3317 checkfun Check;
3318 PyObject *fromObj;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003319} OptionsObject;
3320
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003321 static int
3322dummy_check(void *arg UNUSED)
3323{
3324 return 0;
3325}
3326
3327 static PyObject *
3328OptionsNew(int opt_type, void *from, checkfun Check, PyObject *fromObj)
3329{
3330 OptionsObject *self;
3331
Bram Moolenaar774267b2013-05-21 20:51:59 +02003332 self = PyObject_GC_New(OptionsObject, &OptionsType);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003333 if (self == NULL)
3334 return NULL;
3335
3336 self->opt_type = opt_type;
3337 self->from = from;
3338 self->Check = Check;
3339 self->fromObj = fromObj;
3340 if (fromObj)
3341 Py_INCREF(fromObj);
3342
3343 return (PyObject *)(self);
3344}
3345
3346 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02003347OptionsDestructor(OptionsObject *self)
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003348{
Bram Moolenaar774267b2013-05-21 20:51:59 +02003349 PyObject_GC_UnTrack((void *)(self));
3350 Py_XDECREF(self->fromObj);
3351 PyObject_GC_Del((void *)(self));
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003352}
3353
3354 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02003355OptionsTraverse(OptionsObject *self, visitproc visit, void *arg)
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003356{
Bram Moolenaard6e39182013-05-21 18:30:34 +02003357 Py_VISIT(self->fromObj);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003358 return 0;
3359}
3360
3361 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02003362OptionsClear(OptionsObject *self)
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003363{
Bram Moolenaard6e39182013-05-21 18:30:34 +02003364 Py_CLEAR(self->fromObj);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02003365 return 0;
3366}
3367
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003368 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02003369OptionsItem(OptionsObject *self, PyObject *keyObject)
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003370{
3371 char_u *key;
3372 int flags;
3373 long numval;
3374 char_u *stringval;
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003375 PyObject *todecref;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003376
Bram Moolenaard6e39182013-05-21 18:30:34 +02003377 if (self->Check(self->from))
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003378 return NULL;
3379
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003380 if (!(key = StringToChars(keyObject, &todecref)))
3381 return NULL;
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02003382
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003383 if (*key == NUL)
3384 {
3385 RAISE_NO_EMPTY_KEYS;
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02003386 Py_XDECREF(todecref);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003387 return NULL;
3388 }
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003389
3390 flags = get_option_value_strict(key, &numval, &stringval,
Bram Moolenaard6e39182013-05-21 18:30:34 +02003391 self->opt_type, self->from);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003392
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003393 Py_XDECREF(todecref);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003394
3395 if (flags == 0)
3396 {
Bram Moolenaar4d188da2013-05-15 15:35:09 +02003397 PyErr_SetObject(PyExc_KeyError, keyObject);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003398 return NULL;
3399 }
3400
3401 if (flags & SOPT_UNSET)
3402 {
3403 Py_INCREF(Py_None);
3404 return Py_None;
3405 }
3406 else if (flags & SOPT_BOOL)
3407 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003408 PyObject *ret;
3409 ret = numval ? Py_True : Py_False;
3410 Py_INCREF(ret);
3411 return ret;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003412 }
3413 else if (flags & SOPT_NUM)
3414 return PyInt_FromLong(numval);
3415 else if (flags & SOPT_STRING)
3416 {
3417 if (stringval)
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02003418 {
Bram Moolenaar41009372013-07-01 22:03:04 +02003419 PyObject *ret = PyBytes_FromString((char *)stringval);
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02003420 vim_free(stringval);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003421 return ret;
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02003422 }
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003423 else
3424 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02003425 PyErr_SET_STRING(PyExc_RuntimeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003426 N_("unable to get option value"));
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003427 return NULL;
3428 }
3429 }
3430 else
3431 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003432 PyErr_SET_VIM(N_("internal error: unknown option type"));
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003433 return NULL;
3434 }
3435}
3436
3437 static int
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01003438OptionsContains(OptionsObject *self, PyObject *keyObject)
3439{
3440 char_u *key;
3441 PyObject *todecref;
3442
3443 if (!(key = StringToChars(keyObject, &todecref)))
3444 return -1;
3445
3446 if (*key == NUL)
3447 {
3448 Py_XDECREF(todecref);
3449 return 0;
3450 }
3451
3452 if (get_option_value_strict(key, NULL, NULL, self->opt_type, NULL))
3453 {
3454 Py_XDECREF(todecref);
3455 return 1;
3456 }
3457 else
3458 {
3459 Py_XDECREF(todecref);
3460 return 0;
3461 }
3462}
3463
3464typedef struct
3465{
3466 void *lastoption;
3467 int opt_type;
3468} optiterinfo_T;
3469
3470 static PyObject *
3471OptionsIterNext(optiterinfo_T **oii)
3472{
3473 char_u *name;
3474
3475 if ((name = option_iter_next(&((*oii)->lastoption), (*oii)->opt_type)))
3476 return PyString_FromString((char *)name);
3477
3478 return NULL;
3479}
3480
3481 static PyObject *
3482OptionsIter(OptionsObject *self)
3483{
3484 optiterinfo_T *oii;
3485
3486 if (!(oii = PyMem_New(optiterinfo_T, 1)))
3487 {
3488 PyErr_NoMemory();
3489 return NULL;
3490 }
3491
3492 oii->opt_type = self->opt_type;
3493 oii->lastoption = NULL;
3494
3495 return IterNew(oii,
3496 (destructorfun) PyMem_Free, (nextfun) OptionsIterNext,
3497 NULL, NULL);
3498}
3499
3500 static int
Bram Moolenaar5ab9d982013-06-16 14:25:57 +02003501set_option_value_err(char_u *key, int numval, char_u *stringval, int opt_flags)
Bram Moolenaarc96ebe72013-05-21 22:38:18 +02003502{
Bram Moolenaarb1443b42019-01-13 23:51:14 +01003503 char *errmsg;
Bram Moolenaarc96ebe72013-05-21 22:38:18 +02003504
3505 if ((errmsg = set_option_value(key, numval, stringval, opt_flags)))
3506 {
3507 if (VimTryEnd())
3508 return FAIL;
Bram Moolenaarb1443b42019-01-13 23:51:14 +01003509 PyErr_SetVim(errmsg);
Bram Moolenaarc96ebe72013-05-21 22:38:18 +02003510 return FAIL;
3511 }
3512 return OK;
3513}
3514
3515 static int
Bram Moolenaar5ab9d982013-06-16 14:25:57 +02003516set_option_value_for(
3517 char_u *key,
3518 int numval,
3519 char_u *stringval,
3520 int opt_flags,
3521 int opt_type,
3522 void *from)
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003523{
Bram Moolenaar0b9aecc2013-05-21 22:13:41 +02003524 win_T *save_curwin = NULL;
3525 tabpage_T *save_curtab = NULL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003526 bufref_T save_curbuf;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003527 int set_ret = 0;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003528
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02003529 VimTryStart();
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003530 switch (opt_type)
3531 {
3532 case SREQ_WIN:
Bram Moolenaar105bc352013-05-17 16:03:57 +02003533 if (switch_win(&save_curwin, &save_curtab, (win_T *)from,
Bram Moolenaard6949742013-06-16 14:18:28 +02003534 win_find_tabpage((win_T *)from), FALSE) == FAIL)
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003535 {
Bram Moolenaarae38d052014-12-17 14:46:09 +01003536 restore_win(save_curwin, save_curtab, TRUE);
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02003537 if (VimTryEnd())
3538 return -1;
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003539 PyErr_SET_VIM(N_("problem while switching windows"));
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003540 return -1;
3541 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003542 set_ret = set_option_value_err(key, numval, stringval, opt_flags);
3543 restore_win(save_curwin, save_curtab, TRUE);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003544 break;
3545 case SREQ_BUF:
Bram Moolenaar105bc352013-05-17 16:03:57 +02003546 switch_buffer(&save_curbuf, (buf_T *)from);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003547 set_ret = set_option_value_err(key, numval, stringval, opt_flags);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003548 restore_buffer(&save_curbuf);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003549 break;
3550 case SREQ_GLOBAL:
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003551 set_ret = set_option_value_err(key, numval, stringval, opt_flags);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003552 break;
3553 }
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003554 if (set_ret == FAIL)
3555 return -1;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02003556 return VimTryEnd();
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003557}
3558
3559 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02003560OptionsAssItem(OptionsObject *self, PyObject *keyObject, PyObject *valObject)
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003561{
3562 char_u *key;
3563 int flags;
3564 int opt_flags;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003565 int ret = 0;
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003566 PyObject *todecref;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003567
Bram Moolenaard6e39182013-05-21 18:30:34 +02003568 if (self->Check(self->from))
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003569 return -1;
3570
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003571 if (!(key = StringToChars(keyObject, &todecref)))
3572 return -1;
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02003573
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003574 if (*key == NUL)
3575 {
3576 RAISE_NO_EMPTY_KEYS;
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02003577 Py_XDECREF(todecref);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003578 return -1;
3579 }
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003580
3581 flags = get_option_value_strict(key, NULL, NULL,
Bram Moolenaard6e39182013-05-21 18:30:34 +02003582 self->opt_type, self->from);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003583
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003584 if (flags == 0)
3585 {
Bram Moolenaar4d188da2013-05-15 15:35:09 +02003586 PyErr_SetObject(PyExc_KeyError, keyObject);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003587 Py_XDECREF(todecref);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003588 return -1;
3589 }
3590
3591 if (valObject == NULL)
3592 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02003593 if (self->opt_type == SREQ_GLOBAL)
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003594 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02003595 PyErr_FORMAT(PyExc_ValueError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003596 N_("unable to unset global option %s"), key);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003597 Py_XDECREF(todecref);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003598 return -1;
3599 }
3600 else if (!(flags & SOPT_GLOBAL))
3601 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02003602 PyErr_FORMAT(PyExc_ValueError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003603 N_("unable to unset option %s "
3604 "which does not have global value"), key);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003605 Py_XDECREF(todecref);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003606 return -1;
3607 }
3608 else
3609 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02003610 unset_global_local_option(key, self->from);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003611 Py_XDECREF(todecref);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003612 return 0;
3613 }
3614 }
3615
Bram Moolenaard6e39182013-05-21 18:30:34 +02003616 opt_flags = (self->opt_type ? OPT_LOCAL : OPT_GLOBAL);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003617
3618 if (flags & SOPT_BOOL)
3619 {
Bram Moolenaarb983f752013-05-15 16:11:50 +02003620 int istrue = PyObject_IsTrue(valObject);
Bram Moolenaarc96ebe72013-05-21 22:38:18 +02003621
Bram Moolenaarb983f752013-05-15 16:11:50 +02003622 if (istrue == -1)
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003623 ret = -1;
Bram Moolenaar1bc24282013-05-29 21:37:35 +02003624 else
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003625 ret = set_option_value_for(key, istrue, NULL,
Bram Moolenaar1bc24282013-05-29 21:37:35 +02003626 opt_flags, self->opt_type, self->from);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003627 }
3628 else if (flags & SOPT_NUM)
3629 {
Bram Moolenaar141be8a2013-06-23 14:16:57 +02003630 long val;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003631
Bram Moolenaar141be8a2013-06-23 14:16:57 +02003632 if (NumberToLong(valObject, &val, NUMBER_INT))
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003633 {
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003634 Py_XDECREF(todecref);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003635 return -1;
3636 }
3637
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003638 ret = set_option_value_for(key, (int) val, NULL, opt_flags,
Bram Moolenaard6e39182013-05-21 18:30:34 +02003639 self->opt_type, self->from);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003640 }
3641 else
3642 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003643 char_u *val;
Bram Moolenaarc2401d62013-12-07 14:28:43 +01003644 PyObject *todecref2;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003645
Bram Moolenaarc2401d62013-12-07 14:28:43 +01003646 if ((val = StringToChars(valObject, &todecref2)))
3647 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003648 ret = set_option_value_for(key, 0, val, opt_flags,
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003649 self->opt_type, self->from);
Bram Moolenaarc2401d62013-12-07 14:28:43 +01003650 Py_XDECREF(todecref2);
3651 }
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003652 else
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003653 ret = -1;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003654 }
3655
Bram Moolenaar35eacd72013-05-30 22:06:33 +02003656 Py_XDECREF(todecref);
Bram Moolenaar1bc24282013-05-29 21:37:35 +02003657
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003658 return ret;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003659}
3660
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01003661static PySequenceMethods OptionsAsSeq = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003662 0, // sq_length
3663 0, // sq_concat
3664 0, // sq_repeat
3665 0, // sq_item
3666 0, // sq_slice
3667 0, // sq_ass_item
3668 0, // sq_ass_slice
3669 (objobjproc) OptionsContains, // sq_contains
3670 0, // sq_inplace_concat
3671 0, // sq_inplace_repeat
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01003672};
3673
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02003674static PyMappingMethods OptionsAsMapping = {
3675 (lenfunc) NULL,
3676 (binaryfunc) OptionsItem,
3677 (objobjargproc) OptionsAssItem,
3678};
3679
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003680// Tabpage object
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003681
3682typedef struct
3683{
3684 PyObject_HEAD
3685 tabpage_T *tab;
3686} TabPageObject;
3687
3688static PyObject *WinListNew(TabPageObject *tabObject);
3689
3690static PyTypeObject TabPageType;
3691
3692 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02003693CheckTabPage(TabPageObject *self)
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003694{
Bram Moolenaard6e39182013-05-21 18:30:34 +02003695 if (self->tab == INVALID_TABPAGE_VALUE)
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003696 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003697 PyErr_SET_VIM(N_("attempt to refer to deleted tab page"));
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003698 return -1;
3699 }
3700
3701 return 0;
3702}
3703
3704 static PyObject *
3705TabPageNew(tabpage_T *tab)
3706{
3707 TabPageObject *self;
3708
3709 if (TAB_PYTHON_REF(tab))
3710 {
3711 self = TAB_PYTHON_REF(tab);
3712 Py_INCREF(self);
3713 }
3714 else
3715 {
3716 self = PyObject_NEW(TabPageObject, &TabPageType);
3717 if (self == NULL)
3718 return NULL;
3719 self->tab = tab;
3720 TAB_PYTHON_REF(tab) = self;
3721 }
3722
3723 return (PyObject *)(self);
3724}
3725
3726 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02003727TabPageDestructor(TabPageObject *self)
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003728{
Bram Moolenaard6e39182013-05-21 18:30:34 +02003729 if (self->tab && self->tab != INVALID_TABPAGE_VALUE)
3730 TAB_PYTHON_REF(self->tab) = NULL;
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003731
3732 DESTRUCTOR_FINISH(self);
3733}
3734
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003735static char *TabPageAttrs[] = {
3736 "windows", "number", "vars", "window", "valid",
3737 NULL
3738};
3739
3740 static PyObject *
3741TabPageDir(PyObject *self)
3742{
3743 return ObjectDir(self, TabPageAttrs);
3744}
3745
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003746 static PyObject *
Bram Moolenaar9e822c02013-05-29 22:15:30 +02003747TabPageAttrValid(TabPageObject *self, char *name)
3748{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003749 PyObject *ret;
Bram Moolenaar9e822c02013-05-29 22:15:30 +02003750
3751 if (strcmp(name, "valid") != 0)
3752 return NULL;
3753
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003754 ret = ((self->tab == INVALID_TABPAGE_VALUE) ? Py_False : Py_True);
3755 Py_INCREF(ret);
3756 return ret;
Bram Moolenaar9e822c02013-05-29 22:15:30 +02003757}
3758
3759 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02003760TabPageAttr(TabPageObject *self, char *name)
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003761{
3762 if (strcmp(name, "windows") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02003763 return WinListNew(self);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003764 else if (strcmp(name, "number") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02003765 return PyLong_FromLong((long) get_tab_number(self->tab));
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003766 else if (strcmp(name, "vars") == 0)
Bram Moolenaara9922d62013-05-30 13:01:18 +02003767 return NEW_DICTIONARY(self->tab->tp_vars);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003768 else if (strcmp(name, "window") == 0)
3769 {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003770 // For current tab window.c does not bother to set or update tp_curwin
Bram Moolenaard6e39182013-05-21 18:30:34 +02003771 if (self->tab == curtab)
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003772 return WindowNew(curwin, curtab);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003773 else
Bram Moolenaard6e39182013-05-21 18:30:34 +02003774 return WindowNew(self->tab->tp_curwin, self->tab);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003775 }
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003776 else if (strcmp(name, "__members__") == 0)
3777 return ObjectDir(NULL, TabPageAttrs);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003778 return NULL;
3779}
3780
3781 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02003782TabPageRepr(TabPageObject *self)
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003783{
Bram Moolenaard6e39182013-05-21 18:30:34 +02003784 if (self->tab == INVALID_TABPAGE_VALUE)
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02003785 return PyString_FromFormat("<tabpage object (deleted) at %p>", (self));
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003786 else
3787 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02003788 int t = get_tab_number(self->tab);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003789
3790 if (t == 0)
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02003791 return PyString_FromFormat("<tabpage object (unknown) at %p>",
3792 (self));
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003793 else
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02003794 return PyString_FromFormat("<tabpage %d>", t - 1);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003795 }
3796}
3797
3798static struct PyMethodDef TabPageMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003799 // name, function, calling, documentation
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003800 {"__dir__", (PyCFunction)TabPageDir, METH_NOARGS, ""},
3801 { NULL, NULL, 0, NULL}
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003802};
3803
3804/*
3805 * Window list object
3806 */
3807
3808static PyTypeObject TabListType;
3809static PySequenceMethods TabListAsSeq;
3810
3811typedef struct
3812{
3813 PyObject_HEAD
3814} TabListObject;
3815
3816 static PyInt
3817TabListLength(PyObject *self UNUSED)
3818{
3819 tabpage_T *tp = first_tabpage;
3820 PyInt n = 0;
3821
3822 while (tp != NULL)
3823 {
3824 ++n;
3825 tp = tp->tp_next;
3826 }
3827
3828 return n;
3829}
3830
3831 static PyObject *
3832TabListItem(PyObject *self UNUSED, PyInt n)
3833{
3834 tabpage_T *tp;
3835
3836 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next, --n)
3837 if (n == 0)
3838 return TabPageNew(tp);
3839
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003840 PyErr_SET_STRING(PyExc_IndexError, N_("no such tab page"));
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02003841 return NULL;
3842}
3843
Bram Moolenaar6c85e7f2013-06-23 12:51:32 +02003844/*
3845 * Window object
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003846 */
3847
3848typedef struct
3849{
3850 PyObject_HEAD
3851 win_T *win;
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003852 TabPageObject *tabObject;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003853} WindowObject;
3854
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003855static PyTypeObject WindowType;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02003856
3857 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02003858CheckWindow(WindowObject *self)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02003859{
Bram Moolenaard6e39182013-05-21 18:30:34 +02003860 if (self->win == INVALID_WINDOW_VALUE)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02003861 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02003862 PyErr_SET_VIM(N_("attempt to refer to deleted window"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02003863 return -1;
3864 }
3865
3866 return 0;
3867}
3868
Bram Moolenaar4d1da492013-04-24 13:39:15 +02003869 static PyObject *
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003870WindowNew(win_T *win, tabpage_T *tab)
Bram Moolenaar971db462013-05-12 18:44:48 +02003871{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003872 /*
3873 * We need to handle deletion of windows underneath us.
Bram Moolenaar971db462013-05-12 18:44:48 +02003874 * If we add a "w_python*_ref" field to the win_T structure,
3875 * then we can get at it in win_free() in vim. We then
3876 * need to create only ONE Python object per window - if
3877 * we try to create a second, just INCREF the existing one
3878 * and return it. The (single) Python object referring to
3879 * the window is stored in "w_python*_ref".
3880 * On a win_free() we set the Python object's win_T* field
3881 * to an invalid value. We trap all uses of a window
3882 * object, and reject them if the win_T* field is invalid.
3883 *
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003884 * Python2 and Python3 get different fields and different objects:
Bram Moolenaar971db462013-05-12 18:44:48 +02003885 * w_python_ref and w_python3_ref fields respectively.
3886 */
3887
3888 WindowObject *self;
3889
3890 if (WIN_PYTHON_REF(win))
3891 {
3892 self = WIN_PYTHON_REF(win);
3893 Py_INCREF(self);
3894 }
3895 else
3896 {
Bram Moolenaar774267b2013-05-21 20:51:59 +02003897 self = PyObject_GC_New(WindowObject, &WindowType);
Bram Moolenaar971db462013-05-12 18:44:48 +02003898 if (self == NULL)
3899 return NULL;
3900 self->win = win;
3901 WIN_PYTHON_REF(win) = self;
3902 }
3903
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003904 self->tabObject = ((TabPageObject *)(TabPageNew(tab)));
3905
Bram Moolenaar971db462013-05-12 18:44:48 +02003906 return (PyObject *)(self);
3907}
3908
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003909 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02003910WindowDestructor(WindowObject *self)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003911{
Bram Moolenaar774267b2013-05-21 20:51:59 +02003912 PyObject_GC_UnTrack((void *)(self));
Bram Moolenaard6e39182013-05-21 18:30:34 +02003913 if (self->win && self->win != INVALID_WINDOW_VALUE)
3914 WIN_PYTHON_REF(self->win) = NULL;
Bram Moolenaarab589462020-07-06 21:03:06 +02003915 Py_XDECREF(((PyObject *)(self->tabObject)));
Bram Moolenaar774267b2013-05-21 20:51:59 +02003916 PyObject_GC_Del((void *)(self));
3917}
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003918
Bram Moolenaar774267b2013-05-21 20:51:59 +02003919 static int
3920WindowTraverse(WindowObject *self, visitproc visit, void *arg)
3921{
3922 Py_VISIT(((PyObject *)(self->tabObject)));
3923 return 0;
3924}
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003925
Bram Moolenaar774267b2013-05-21 20:51:59 +02003926 static int
3927WindowClear(WindowObject *self)
3928{
3929 Py_CLEAR(self->tabObject);
3930 return 0;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02003931}
3932
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003933 static win_T *
3934get_firstwin(TabPageObject *tabObject)
3935{
3936 if (tabObject)
3937 {
3938 if (CheckTabPage(tabObject))
3939 return NULL;
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01003940 // For current tab window.c does not bother to set or update tp_firstwin
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003941 else if (tabObject->tab == curtab)
3942 return firstwin;
3943 else
3944 return tabObject->tab->tp_firstwin;
3945 }
3946 else
3947 return firstwin;
3948}
Bram Moolenaare950f992018-06-10 13:55:55 +02003949
3950// Use the same order as in the WindowAttr() function.
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003951static char *WindowAttrs[] = {
Bram Moolenaare950f992018-06-10 13:55:55 +02003952 "buffer",
3953 "cursor",
3954 "height",
3955 "row",
3956 "width",
3957 "col",
3958 "vars",
3959 "options",
3960 "number",
3961 "tabpage",
3962 "valid",
Bram Moolenaardd8aca62013-05-29 22:36:10 +02003963 NULL
3964};
3965
3966 static PyObject *
3967WindowDir(PyObject *self)
3968{
3969 return ObjectDir(self, WindowAttrs);
3970}
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02003971
Bram Moolenaar971db462013-05-12 18:44:48 +02003972 static PyObject *
Bram Moolenaar9e822c02013-05-29 22:15:30 +02003973WindowAttrValid(WindowObject *self, char *name)
3974{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003975 PyObject *ret;
Bram Moolenaar9e822c02013-05-29 22:15:30 +02003976
3977 if (strcmp(name, "valid") != 0)
3978 return NULL;
3979
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02003980 ret = ((self->win == INVALID_WINDOW_VALUE) ? Py_False : Py_True);
3981 Py_INCREF(ret);
3982 return ret;
Bram Moolenaar9e822c02013-05-29 22:15:30 +02003983}
3984
3985 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02003986WindowAttr(WindowObject *self, char *name)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02003987{
3988 if (strcmp(name, "buffer") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02003989 return (PyObject *)BufferNew(self->win->w_buffer);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02003990 else if (strcmp(name, "cursor") == 0)
3991 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02003992 pos_T *pos = &self->win->w_cursor;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02003993
3994 return Py_BuildValue("(ll)", (long)(pos->lnum), (long)(pos->col));
3995 }
3996 else if (strcmp(name, "height") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02003997 return PyLong_FromLong((long)(self->win->w_height));
Bram Moolenaar4e5dfb52013-05-12 19:30:31 +02003998 else if (strcmp(name, "row") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02003999 return PyLong_FromLong((long)(self->win->w_winrow));
Bram Moolenaar4d1da492013-04-24 13:39:15 +02004000 else if (strcmp(name, "width") == 0)
Bram Moolenaar02631462017-09-22 15:20:32 +02004001 return PyLong_FromLong((long)(self->win->w_width));
Bram Moolenaar4e5dfb52013-05-12 19:30:31 +02004002 else if (strcmp(name, "col") == 0)
Bram Moolenaar53f81742017-09-22 14:35:51 +02004003 return PyLong_FromLong((long)(self->win->w_wincol));
Bram Moolenaar230bb3f2013-04-24 14:07:45 +02004004 else if (strcmp(name, "vars") == 0)
Bram Moolenaara9922d62013-05-30 13:01:18 +02004005 return NEW_DICTIONARY(self->win->w_vars);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02004006 else if (strcmp(name, "options") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02004007 return OptionsNew(SREQ_WIN, self->win, (checkfun) CheckWindow,
4008 (PyObject *) self);
Bram Moolenaar6d216452013-05-12 19:00:41 +02004009 else if (strcmp(name, "number") == 0)
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02004010 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02004011 if (CheckTabPage(self->tabObject))
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02004012 return NULL;
4013 return PyLong_FromLong((long)
Bram Moolenaard6e39182013-05-21 18:30:34 +02004014 get_win_number(self->win, get_firstwin(self->tabObject)));
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02004015 }
4016 else if (strcmp(name, "tabpage") == 0)
4017 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02004018 Py_INCREF(self->tabObject);
4019 return (PyObject *)(self->tabObject);
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02004020 }
Bram Moolenaardd8aca62013-05-29 22:36:10 +02004021 else if (strcmp(name, "__members__") == 0)
4022 return ObjectDir(NULL, WindowAttrs);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02004023 else
4024 return NULL;
4025}
4026
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004027 static int
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004028WindowSetattr(WindowObject *self, char *name, PyObject *valObject)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004029{
Bram Moolenaard6e39182013-05-21 18:30:34 +02004030 if (CheckWindow(self))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004031 return -1;
4032
4033 if (strcmp(name, "buffer") == 0)
4034 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004035 PyErr_SET_STRING(PyExc_TypeError, N_("readonly attribute: buffer"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004036 return -1;
4037 }
4038 else if (strcmp(name, "cursor") == 0)
4039 {
4040 long lnum;
4041 long col;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004042
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004043 if (!PyArg_Parse(valObject, "(ll)", &lnum, &col))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004044 return -1;
4045
Bram Moolenaard6e39182013-05-21 18:30:34 +02004046 if (lnum <= 0 || lnum > self->win->w_buffer->b_ml.ml_line_count)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004047 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004048 PyErr_SET_VIM(N_("cursor position outside buffer"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004049 return -1;
4050 }
4051
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004052 // Check for keyboard interrupts
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004053 if (VimCheckInterrupt())
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004054 return -1;
4055
Bram Moolenaard6e39182013-05-21 18:30:34 +02004056 self->win->w_cursor.lnum = lnum;
4057 self->win->w_cursor.col = col;
Bram Moolenaar53901442018-07-25 22:02:36 +02004058 self->win->w_set_curswant = TRUE;
Bram Moolenaard6e39182013-05-21 18:30:34 +02004059 self->win->w_cursor.coladd = 0;
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004060 // When column is out of range silently correct it.
Bram Moolenaard6e39182013-05-21 18:30:34 +02004061 check_cursor_col_win(self->win);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004062
Bram Moolenaar03a807a2011-07-07 15:08:58 +02004063 update_screen(VALID);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004064 return 0;
4065 }
4066 else if (strcmp(name, "height") == 0)
4067 {
Bram Moolenaar141be8a2013-06-23 14:16:57 +02004068 long height;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004069 win_T *savewin;
4070
Bram Moolenaardee2e312013-06-23 16:35:47 +02004071 if (NumberToLong(valObject, &height, NUMBER_INT|NUMBER_UNSIGNED))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004072 return -1;
4073
4074#ifdef FEAT_GUI
4075 need_mouse_correct = TRUE;
4076#endif
4077 savewin = curwin;
Bram Moolenaard6e39182013-05-21 18:30:34 +02004078 curwin = self->win;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004079
4080 VimTryStart();
Bram Moolenaar141be8a2013-06-23 14:16:57 +02004081 win_setheight((int) height);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004082 curwin = savewin;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004083 if (VimTryEnd())
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004084 return -1;
4085
4086 return 0;
4087 }
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004088 else if (strcmp(name, "width") == 0)
4089 {
Bram Moolenaar141be8a2013-06-23 14:16:57 +02004090 long width;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004091 win_T *savewin;
4092
Bram Moolenaardee2e312013-06-23 16:35:47 +02004093 if (NumberToLong(valObject, &width, NUMBER_INT|NUMBER_UNSIGNED))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004094 return -1;
4095
4096#ifdef FEAT_GUI
4097 need_mouse_correct = TRUE;
4098#endif
4099 savewin = curwin;
Bram Moolenaard6e39182013-05-21 18:30:34 +02004100 curwin = self->win;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004101
4102 VimTryStart();
Bram Moolenaar141be8a2013-06-23 14:16:57 +02004103 win_setwidth((int) width);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004104 curwin = savewin;
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004105 if (VimTryEnd())
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004106 return -1;
4107
4108 return 0;
4109 }
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004110 else
4111 {
4112 PyErr_SetString(PyExc_AttributeError, name);
4113 return -1;
4114 }
4115}
4116
4117 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02004118WindowRepr(WindowObject *self)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004119{
Bram Moolenaard6e39182013-05-21 18:30:34 +02004120 if (self->win == INVALID_WINDOW_VALUE)
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02004121 return PyString_FromFormat("<window object (deleted) at %p>", (self));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004122 else
4123 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02004124 int w = get_win_number(self->win, firstwin);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004125
Bram Moolenaar6d216452013-05-12 19:00:41 +02004126 if (w == 0)
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02004127 return PyString_FromFormat("<window object (unknown) at %p>",
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004128 (self));
4129 else
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02004130 return PyString_FromFormat("<window %d>", w - 1);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004131 }
4132}
4133
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02004134static struct PyMethodDef WindowMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004135 // name, function, calling, documentation
Bram Moolenaardd8aca62013-05-29 22:36:10 +02004136 {"__dir__", (PyCFunction)WindowDir, METH_NOARGS, ""},
4137 { NULL, NULL, 0, NULL}
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02004138};
4139
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004140/*
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02004141 * Window list object
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004142 */
Bram Moolenaar4d1da492013-04-24 13:39:15 +02004143
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02004144static PyTypeObject WinListType;
4145static PySequenceMethods WinListAsSeq;
4146
Bram Moolenaar4d1da492013-04-24 13:39:15 +02004147typedef struct
4148{
4149 PyObject_HEAD
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004150 TabPageObject *tabObject;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02004151} WinListObject;
4152
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004153 static PyObject *
4154WinListNew(TabPageObject *tabObject)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004155{
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004156 WinListObject *self;
4157
4158 self = PyObject_NEW(WinListObject, &WinListType);
4159 self->tabObject = tabObject;
4160 Py_INCREF(tabObject);
4161
4162 return (PyObject *)(self);
4163}
4164
4165 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02004166WinListDestructor(WinListObject *self)
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004167{
Bram Moolenaard6e39182013-05-21 18:30:34 +02004168 TabPageObject *tabObject = self->tabObject;
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004169
4170 if (tabObject)
Bram Moolenaar425154d2013-05-24 18:58:43 +02004171 {
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004172 Py_DECREF((PyObject *)(tabObject));
Bram Moolenaar425154d2013-05-24 18:58:43 +02004173 }
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004174
4175 DESTRUCTOR_FINISH(self);
4176}
4177
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004178 static PyInt
Bram Moolenaard6e39182013-05-21 18:30:34 +02004179WinListLength(WinListObject *self)
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004180{
4181 win_T *w;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004182 PyInt n = 0;
4183
Bram Moolenaard6e39182013-05-21 18:30:34 +02004184 if (!(w = get_firstwin(self->tabObject)))
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004185 return -1;
4186
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004187 while (w != NULL)
4188 {
4189 ++n;
4190 w = W_NEXT(w);
4191 }
4192
4193 return n;
4194}
4195
4196 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02004197WinListItem(WinListObject *self, PyInt n)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004198{
4199 win_T *w;
4200
Bram Moolenaard6e39182013-05-21 18:30:34 +02004201 if (!(w = get_firstwin(self->tabObject)))
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02004202 return NULL;
4203
4204 for (; w != NULL; w = W_NEXT(w), --n)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004205 if (n == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02004206 return WindowNew(w, self->tabObject? self->tabObject->tab: curtab);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004207
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004208 PyErr_SET_STRING(PyExc_IndexError, N_("no such window"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004209 return NULL;
4210}
4211
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004212/*
4213 * Convert a Python string into a Vim line.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004214 *
4215 * The result is in allocated memory. All internal nulls are replaced by
4216 * newline characters. It is an error for the string to contain newline
4217 * characters.
4218 *
4219 * On errors, the Python exception data is set, and NULL is returned.
4220 */
4221 static char *
4222StringToLine(PyObject *obj)
4223{
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004224 char *str;
4225 char *save;
4226 PyObject *bytes = NULL;
Bram Moolenaardee2e312013-06-23 16:35:47 +02004227 Py_ssize_t len = 0;
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004228 PyInt i;
4229 char *p;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004230
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004231 if (PyBytes_Check(obj))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004232 {
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004233 if (PyBytes_AsStringAndSize(obj, &str, &len) == -1
4234 || str == NULL)
4235 return NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004236 }
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004237 else if (PyUnicode_Check(obj))
4238 {
4239 if (!(bytes = PyUnicode_AsEncodedString(obj, ENC_OPT, NULL)))
4240 return NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004241
Bram Moolenaardaa27022013-06-24 22:33:30 +02004242 if (PyBytes_AsStringAndSize(bytes, &str, &len) == -1
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004243 || str == NULL)
4244 {
4245 Py_DECREF(bytes);
4246 return NULL;
4247 }
4248 }
Bram Moolenaardaa27022013-06-24 22:33:30 +02004249 else
4250 {
4251#if PY_MAJOR_VERSION < 3
4252 PyErr_FORMAT(PyExc_TypeError,
4253 N_("expected str() or unicode() instance, but got %s"),
4254 Py_TYPE_NAME(obj));
4255#else
4256 PyErr_FORMAT(PyExc_TypeError,
4257 N_("expected bytes() or str() instance, but got %s"),
4258 Py_TYPE_NAME(obj));
4259#endif
4260 return NULL;
4261 }
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004262
4263 /*
4264 * Error checking: String must not contain newlines, as we
4265 * are replacing a single line, and we must replace it with
4266 * a single line.
4267 * A trailing newline is removed, so that append(f.readlines()) works.
4268 */
4269 p = memchr(str, '\n', len);
4270 if (p != NULL)
4271 {
4272 if (p == str + len - 1)
4273 --len;
4274 else
4275 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004276 PyErr_SET_VIM(N_("string cannot contain newlines"));
Bram Moolenaar841fbd22013-06-23 14:37:07 +02004277 Py_XDECREF(bytes);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004278 return NULL;
4279 }
4280 }
4281
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004282 /*
4283 * Create a copy of the string, with internal nulls replaced by
Bram Moolenaar86181df2020-05-11 23:14:04 +02004284 * newline characters, as is the Vim convention.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004285 */
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004286 save = alloc(len+1);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004287 if (save == NULL)
4288 {
4289 PyErr_NoMemory();
Bram Moolenaar841fbd22013-06-23 14:37:07 +02004290 Py_XDECREF(bytes);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004291 return NULL;
4292 }
4293
4294 for (i = 0; i < len; ++i)
4295 {
4296 if (str[i] == '\0')
4297 save[i] = '\n';
4298 else
4299 save[i] = str[i];
4300 }
4301
4302 save[i] = '\0';
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004303 Py_XDECREF(bytes); // Python 2 does nothing here
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004304
4305 return save;
4306}
4307
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004308/*
4309 * Get a line from the specified buffer. The line number is
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004310 * in Vim format (1-based). The line is returned as a Python
4311 * string object.
4312 */
4313 static PyObject *
4314GetBufferLine(buf_T *buf, PyInt n)
4315{
4316 return LineToString((char *)ml_get_buf(buf, (linenr_T)n, FALSE));
4317}
4318
4319
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004320/*
4321 * Get a list of lines from the specified buffer. The line numbers
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004322 * are in Vim format (1-based). The range is from lo up to, but not
4323 * including, hi. The list is returned as a Python list of string objects.
4324 */
4325 static PyObject *
4326GetBufferLineList(buf_T *buf, PyInt lo, PyInt hi)
4327{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004328 PyInt i;
4329 PyInt n = hi - lo;
4330 PyObject *list = PyList_New(n);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004331
4332 if (list == NULL)
4333 return NULL;
4334
4335 for (i = 0; i < n; ++i)
4336 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004337 PyObject *string = LineToString(
4338 (char *)ml_get_buf(buf, (linenr_T)(lo+i), FALSE));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004339
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004340 // Error check - was the Python string creation OK?
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004341 if (string == NULL)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004342 {
4343 Py_DECREF(list);
4344 return NULL;
4345 }
4346
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004347 PyList_SET_ITEM(list, i, string);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004348 }
4349
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004350 // The ownership of the Python list is passed to the caller (ie,
4351 // the caller should Py_DECREF() the object when it is finished
4352 // with it).
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004353
4354 return list;
4355}
4356
4357/*
4358 * Check if deleting lines made the cursor position invalid.
4359 * Changed the lines from "lo" to "hi" and added "extra" lines (negative if
4360 * deleted).
4361 */
4362 static void
4363py_fix_cursor(linenr_T lo, linenr_T hi, linenr_T extra)
4364{
4365 if (curwin->w_cursor.lnum >= lo)
4366 {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004367 // Adjust the cursor position if it's in/after the changed
4368 // lines.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004369 if (curwin->w_cursor.lnum >= hi)
4370 {
4371 curwin->w_cursor.lnum += extra;
4372 check_cursor_col();
4373 }
4374 else if (extra < 0)
4375 {
4376 curwin->w_cursor.lnum = lo;
4377 check_cursor();
4378 }
4379 else
4380 check_cursor_col();
4381 changed_cline_bef_curs();
4382 }
4383 invalidate_botline();
4384}
4385
Bram Moolenaar19e60942011-06-19 00:27:51 +02004386/*
4387 * Replace a line in the specified buffer. The line number is
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004388 * in Vim format (1-based). The replacement line is given as
4389 * a Python string object. The object is checked for validity
4390 * and correct format. Errors are returned as a value of FAIL.
4391 * The return value is OK on success.
4392 * If OK is returned and len_change is not NULL, *len_change
4393 * is set to the change in the buffer length.
4394 */
4395 static int
4396SetBufferLine(buf_T *buf, PyInt n, PyObject *line, PyInt *len_change)
4397{
Bram Moolenaar45e5fd12017-06-04 14:58:02 +02004398 bufref_T save_curbuf = {NULL, 0, 0};
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004399 win_T *save_curwin = NULL;
4400 tabpage_T *save_curtab = NULL;
4401
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004402 // First of all, we check the type of the supplied Python object.
4403 // There are three cases:
4404 // 1. NULL, or None - this is a deletion.
4405 // 2. A string - this is a replacement.
4406 // 3. Anything else - this is an error.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004407 if (line == Py_None || line == NULL)
4408 {
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004409 PyErr_Clear();
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004410 switch_to_win_for_buf(buf, &save_curwin, &save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004411
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004412 VimTryStart();
4413
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004414 if (u_savedel((linenr_T)n, 1L) == FAIL)
Bram Moolenaarc476e522013-06-23 13:46:40 +02004415 RAISE_UNDO_FAIL;
Bram Moolenaarca70c072020-05-30 20:30:46 +02004416 else if (ml_delete((linenr_T)n) == FAIL)
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004417 RAISE_DELETE_LINE_FAIL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004418 else
4419 {
Bram Moolenaar63dbfd32019-03-23 17:41:59 +01004420 if (buf == curbuf && (save_curwin != NULL
4421 || save_curbuf.br_buf == NULL))
4422 // Using an existing window for the buffer, adjust the cursor
4423 // position.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004424 py_fix_cursor((linenr_T)n, (linenr_T)n + 1, (linenr_T)-1);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004425 if (save_curbuf.br_buf == NULL)
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004426 // Only adjust marks if we managed to switch to a window that
4427 // holds the buffer, otherwise line numbers will be invalid.
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004428 deleted_lines_mark((linenr_T)n, 1L);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004429 }
4430
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004431 restore_win_for_buf(save_curwin, save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004432
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004433 if (VimTryEnd())
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004434 return FAIL;
4435
4436 if (len_change)
4437 *len_change = -1;
4438
4439 return OK;
4440 }
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004441 else if (PyBytes_Check(line) || PyUnicode_Check(line))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004442 {
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004443 char *save = StringToLine(line);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004444
4445 if (save == NULL)
4446 return FAIL;
4447
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004448 VimTryStart();
4449
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004450 // We do not need to free "save" if ml_replace() consumes it.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004451 PyErr_Clear();
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004452 switch_to_win_for_buf(buf, &save_curwin, &save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004453
4454 if (u_savesub((linenr_T)n) == FAIL)
4455 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02004456 RAISE_UNDO_FAIL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004457 vim_free(save);
4458 }
4459 else if (ml_replace((linenr_T)n, (char_u *)save, FALSE) == FAIL)
4460 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004461 RAISE_REPLACE_LINE_FAIL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004462 vim_free(save);
4463 }
4464 else
4465 changed_bytes((linenr_T)n, 0);
4466
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004467 restore_win_for_buf(save_curwin, save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004468
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004469 // Check that the cursor is not beyond the end of the line now.
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004470 if (buf == curbuf)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004471 check_cursor_col();
4472
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004473 if (VimTryEnd())
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004474 return FAIL;
4475
4476 if (len_change)
4477 *len_change = 0;
4478
4479 return OK;
4480 }
4481 else
4482 {
4483 PyErr_BadArgument();
4484 return FAIL;
4485 }
4486}
4487
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004488/*
4489 * Replace a range of lines in the specified buffer. The line numbers are in
Bram Moolenaar19e60942011-06-19 00:27:51 +02004490 * Vim format (1-based). The range is from lo up to, but not including, hi.
4491 * The replacement lines are given as a Python list of string objects. The
4492 * list is checked for validity and correct format. Errors are returned as a
4493 * value of FAIL. The return value is OK on success.
4494 * If OK is returned and len_change is not NULL, *len_change
4495 * is set to the change in the buffer length.
4496 */
4497 static int
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004498SetBufferLineList(
4499 buf_T *buf,
4500 PyInt lo,
4501 PyInt hi,
4502 PyObject *list,
4503 PyInt *len_change)
Bram Moolenaar19e60942011-06-19 00:27:51 +02004504{
Bram Moolenaar45e5fd12017-06-04 14:58:02 +02004505 bufref_T save_curbuf = {NULL, 0, 0};
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004506 win_T *save_curwin = NULL;
4507 tabpage_T *save_curtab = NULL;
4508
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004509 // First of all, we check the type of the supplied Python object.
4510 // There are three cases:
4511 // 1. NULL, or None - this is a deletion.
4512 // 2. A list - this is a replacement.
4513 // 3. Anything else - this is an error.
Bram Moolenaar19e60942011-06-19 00:27:51 +02004514 if (list == Py_None || list == NULL)
4515 {
4516 PyInt i;
4517 PyInt n = (int)(hi - lo);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004518
4519 PyErr_Clear();
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004520 VimTryStart();
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004521 switch_to_win_for_buf(buf, &save_curwin, &save_curtab, &save_curbuf);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004522
4523 if (u_savedel((linenr_T)lo, (long)n) == FAIL)
Bram Moolenaarc476e522013-06-23 13:46:40 +02004524 RAISE_UNDO_FAIL;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004525 else
4526 {
4527 for (i = 0; i < n; ++i)
4528 {
Bram Moolenaarca70c072020-05-30 20:30:46 +02004529 if (ml_delete((linenr_T)lo) == FAIL)
Bram Moolenaar19e60942011-06-19 00:27:51 +02004530 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004531 RAISE_DELETE_LINE_FAIL;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004532 break;
4533 }
4534 }
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004535 if (buf == curbuf && (save_curwin != NULL
4536 || save_curbuf.br_buf == NULL))
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004537 // Using an existing window for the buffer, adjust the cursor
4538 // position.
Bram Moolenaar19e60942011-06-19 00:27:51 +02004539 py_fix_cursor((linenr_T)lo, (linenr_T)hi, (linenr_T)-n);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004540 if (save_curbuf.br_buf == NULL)
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004541 // Only adjust marks if we managed to switch to a window that
4542 // holds the buffer, otherwise line numbers will be invalid.
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004543 deleted_lines_mark((linenr_T)lo, (long)i);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004544 }
4545
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004546 restore_win_for_buf(save_curwin, save_curtab, &save_curbuf);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004547
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004548 if (VimTryEnd())
Bram Moolenaar19e60942011-06-19 00:27:51 +02004549 return FAIL;
4550
4551 if (len_change)
4552 *len_change = -n;
4553
4554 return OK;
4555 }
4556 else if (PyList_Check(list))
4557 {
4558 PyInt i;
4559 PyInt new_len = PyList_Size(list);
4560 PyInt old_len = hi - lo;
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004561 PyInt extra = 0; // lines added to text, can be negative
Bram Moolenaar19e60942011-06-19 00:27:51 +02004562 char **array;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004563
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004564 if (new_len == 0) // avoid allocating zero bytes
Bram Moolenaar19e60942011-06-19 00:27:51 +02004565 array = NULL;
4566 else
4567 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02004568 array = PyMem_New(char *, new_len);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004569 if (array == NULL)
4570 {
4571 PyErr_NoMemory();
4572 return FAIL;
4573 }
4574 }
4575
4576 for (i = 0; i < new_len; ++i)
4577 {
Bram Moolenaar494ff7e2013-05-30 13:17:17 +02004578 PyObject *line;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004579
Bram Moolenaar494ff7e2013-05-30 13:17:17 +02004580 if (!(line = PyList_GetItem(list, i)) ||
4581 !(array[i] = StringToLine(line)))
Bram Moolenaar19e60942011-06-19 00:27:51 +02004582 {
4583 while (i)
4584 vim_free(array[--i]);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02004585 PyMem_Free(array);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004586 return FAIL;
4587 }
4588 }
4589
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004590 VimTryStart();
Bram Moolenaar19e60942011-06-19 00:27:51 +02004591 PyErr_Clear();
Bram Moolenaar105bc352013-05-17 16:03:57 +02004592
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004593 // START of region without "return". Must call restore_buffer()!
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004594 switch_to_win_for_buf(buf, &save_curwin, &save_curtab, &save_curbuf);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004595
4596 if (u_save((linenr_T)(lo-1), (linenr_T)hi) == FAIL)
Bram Moolenaarc476e522013-06-23 13:46:40 +02004597 RAISE_UNDO_FAIL;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004598
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004599 // If the size of the range is reducing (ie, new_len < old_len) we
4600 // need to delete some old_len. We do this at the start, by
4601 // repeatedly deleting line "lo".
Bram Moolenaar19e60942011-06-19 00:27:51 +02004602 if (!PyErr_Occurred())
4603 {
4604 for (i = 0; i < old_len - new_len; ++i)
Bram Moolenaarca70c072020-05-30 20:30:46 +02004605 if (ml_delete((linenr_T)lo) == FAIL)
Bram Moolenaar19e60942011-06-19 00:27:51 +02004606 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004607 RAISE_DELETE_LINE_FAIL;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004608 break;
4609 }
4610 extra -= i;
4611 }
4612
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004613 // For as long as possible, replace the existing old_len with the
4614 // new old_len. This is a more efficient operation, as it requires
4615 // less memory allocation and freeing.
Bram Moolenaar19e60942011-06-19 00:27:51 +02004616 if (!PyErr_Occurred())
4617 {
4618 for (i = 0; i < old_len && i < new_len; ++i)
4619 if (ml_replace((linenr_T)(lo+i), (char_u *)array[i], FALSE)
4620 == FAIL)
4621 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004622 RAISE_REPLACE_LINE_FAIL;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004623 break;
4624 }
4625 }
4626 else
4627 i = 0;
4628
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004629 // Now we may need to insert the remaining new old_len. If we do, we
4630 // must free the strings as we finish with them (we can't pass the
Bram Moolenaar86181df2020-05-11 23:14:04 +02004631 // responsibility to Vim in this case).
Bram Moolenaar19e60942011-06-19 00:27:51 +02004632 if (!PyErr_Occurred())
4633 {
4634 while (i < new_len)
4635 {
4636 if (ml_append((linenr_T)(lo + i - 1),
4637 (char_u *)array[i], 0, FALSE) == FAIL)
4638 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004639 RAISE_INSERT_LINE_FAIL;
Bram Moolenaar19e60942011-06-19 00:27:51 +02004640 break;
4641 }
4642 vim_free(array[i]);
4643 ++i;
4644 ++extra;
4645 }
4646 }
4647
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004648 // Free any left-over old_len, as a result of an error
Bram Moolenaar19e60942011-06-19 00:27:51 +02004649 while (i < new_len)
4650 {
4651 vim_free(array[i]);
4652 ++i;
4653 }
4654
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004655 // Free the array of old_len. All of its contents have now
4656 // been dealt with (either freed, or the responsibility passed
4657 // to vim.
Bram Moolenaare9ba5162013-05-29 22:02:22 +02004658 PyMem_Free(array);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004659
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004660 // Adjust marks. Invalidate any which lie in the
4661 // changed range, and move any in the remainder of the buffer.
4662 // Only adjust marks if we managed to switch to a window that holds
4663 // the buffer, otherwise line numbers will be invalid.
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004664 if (save_curbuf.br_buf == NULL)
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004665 mark_adjust((linenr_T)lo, (linenr_T)(hi - 1),
Bram Moolenaar19e60942011-06-19 00:27:51 +02004666 (long)MAXLNUM, (long)extra);
4667 changed_lines((linenr_T)lo, 0, (linenr_T)hi, (long)extra);
4668
Bram Moolenaar63dbfd32019-03-23 17:41:59 +01004669 if (buf == curbuf && (save_curwin != NULL
4670 || save_curbuf.br_buf == NULL))
4671 // Using an existing window for the buffer, adjust the cursor
4672 // position.
Bram Moolenaar19e60942011-06-19 00:27:51 +02004673 py_fix_cursor((linenr_T)lo, (linenr_T)hi, (linenr_T)extra);
4674
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004675 // END of region without "return".
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004676 restore_win_for_buf(save_curwin, save_curtab, &save_curbuf);
Bram Moolenaar19e60942011-06-19 00:27:51 +02004677
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004678 if (VimTryEnd())
Bram Moolenaar19e60942011-06-19 00:27:51 +02004679 return FAIL;
4680
4681 if (len_change)
4682 *len_change = new_len - old_len;
4683
4684 return OK;
4685 }
4686 else
4687 {
4688 PyErr_BadArgument();
4689 return FAIL;
4690 }
4691}
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004692
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004693/*
4694 * Insert a number of lines into the specified buffer after the specified line.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004695 * The line number is in Vim format (1-based). The lines to be inserted are
4696 * given as a Python list of string objects or as a single string. The lines
4697 * to be added are checked for validity and correct format. Errors are
4698 * returned as a value of FAIL. The return value is OK on success.
4699 * If OK is returned and len_change is not NULL, *len_change
4700 * is set to the change in the buffer length.
4701 */
4702 static int
4703InsertBufferLines(buf_T *buf, PyInt n, PyObject *lines, PyInt *len_change)
4704{
Bram Moolenaar45e5fd12017-06-04 14:58:02 +02004705 bufref_T save_curbuf = {NULL, 0, 0};
Bram Moolenaar95064ec2013-07-17 17:15:25 +02004706 win_T *save_curwin = NULL;
Bram Moolenaar95064ec2013-07-17 17:15:25 +02004707 tabpage_T *save_curtab = NULL;
4708
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004709 // First of all, we check the type of the supplied Python object.
4710 // It must be a string or a list, or the call is in error.
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02004711 if (PyBytes_Check(lines) || PyUnicode_Check(lines))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004712 {
Bram Moolenaar95064ec2013-07-17 17:15:25 +02004713 char *str = StringToLine(lines);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004714
4715 if (str == NULL)
4716 return FAIL;
4717
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004718 PyErr_Clear();
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004719 VimTryStart();
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004720 switch_to_win_for_buf(buf, &save_curwin, &save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004721
Bram Moolenaar95064ec2013-07-17 17:15:25 +02004722 if (u_save((linenr_T)n, (linenr_T)(n + 1)) == FAIL)
Bram Moolenaarc476e522013-06-23 13:46:40 +02004723 RAISE_UNDO_FAIL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004724 else if (ml_append((linenr_T)n, (char_u *)str, 0, FALSE) == FAIL)
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004725 RAISE_INSERT_LINE_FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004726 else if (save_curbuf.br_buf == NULL)
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004727 // Only adjust marks if we managed to switch to a window that
4728 // holds the buffer, otherwise line numbers will be invalid.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004729 appended_lines_mark((linenr_T)n, 1L);
4730
4731 vim_free(str);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004732 restore_win_for_buf(save_curwin, save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004733 update_screen(VALID);
4734
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004735 if (VimTryEnd())
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004736 return FAIL;
4737
4738 if (len_change)
4739 *len_change = 1;
4740
4741 return OK;
4742 }
4743 else if (PyList_Check(lines))
4744 {
4745 PyInt i;
4746 PyInt size = PyList_Size(lines);
4747 char **array;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004748
Bram Moolenaare9ba5162013-05-29 22:02:22 +02004749 array = PyMem_New(char *, size);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004750 if (array == NULL)
4751 {
4752 PyErr_NoMemory();
4753 return FAIL;
4754 }
4755
4756 for (i = 0; i < size; ++i)
4757 {
Bram Moolenaar494ff7e2013-05-30 13:17:17 +02004758 PyObject *line;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004759
Bram Moolenaar494ff7e2013-05-30 13:17:17 +02004760 if (!(line = PyList_GetItem(lines, i)) ||
4761 !(array[i] = StringToLine(line)))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004762 {
4763 while (i)
4764 vim_free(array[--i]);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02004765 PyMem_Free(array);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004766 return FAIL;
4767 }
4768 }
4769
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004770 PyErr_Clear();
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004771 VimTryStart();
Bram Moolenaaraf003f62013-07-24 17:11:46 +02004772 switch_to_win_for_buf(buf, &save_curwin, &save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004773
4774 if (u_save((linenr_T)n, (linenr_T)(n + 1)) == FAIL)
Bram Moolenaarc476e522013-06-23 13:46:40 +02004775 RAISE_UNDO_FAIL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004776 else
4777 {
4778 for (i = 0; i < size; ++i)
4779 {
4780 if (ml_append((linenr_T)(n + i),
4781 (char_u *)array[i], 0, FALSE) == FAIL)
4782 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004783 RAISE_INSERT_LINE_FAIL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004784
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004785 // Free the rest of the lines
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004786 while (i < size)
4787 vim_free(array[i++]);
4788
4789 break;
4790 }
4791 vim_free(array[i]);
4792 }
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004793 if (i > 0 && save_curbuf.br_buf == NULL)
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004794 // Only adjust marks if we managed to switch to a window that
4795 // holds the buffer, otherwise line numbers will be invalid.
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004796 appended_lines_mark((linenr_T)n, (long)i);
4797 }
4798
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004799 // Free the array of lines. All of its contents have now
4800 // been freed.
Bram Moolenaare9ba5162013-05-29 22:02:22 +02004801 PyMem_Free(array);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004802 restore_win_for_buf(save_curwin, save_curtab, &save_curbuf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004803
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004804 update_screen(VALID);
4805
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02004806 if (VimTryEnd())
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004807 return FAIL;
4808
4809 if (len_change)
4810 *len_change = size;
4811
4812 return OK;
4813 }
4814 else
4815 {
4816 PyErr_BadArgument();
4817 return FAIL;
4818 }
4819}
4820
4821/*
4822 * Common routines for buffers and line ranges
4823 * -------------------------------------------
4824 */
4825
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02004826typedef struct
4827{
4828 PyObject_HEAD
4829 buf_T *buf;
4830} BufferObject;
4831
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004832 static int
Bram Moolenaard6e39182013-05-21 18:30:34 +02004833CheckBuffer(BufferObject *self)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004834{
Bram Moolenaard6e39182013-05-21 18:30:34 +02004835 if (self->buf == INVALID_BUFFER_VALUE)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004836 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004837 PyErr_SET_VIM(N_("attempt to refer to deleted buffer"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004838 return -1;
4839 }
4840
4841 return 0;
4842}
4843
4844 static PyObject *
4845RBItem(BufferObject *self, PyInt n, PyInt start, PyInt end)
4846{
4847 if (CheckBuffer(self))
4848 return NULL;
4849
Bram Moolenaar8f1723d2013-05-12 20:36:14 +02004850 if (end == -1)
4851 end = self->buf->b_ml.ml_line_count;
4852
Bram Moolenaarbd80f352013-05-12 21:16:23 +02004853 if (n < 0)
4854 n += end - start + 1;
4855
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004856 if (n < 0 || n > end - start)
4857 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004858 PyErr_SET_STRING(PyExc_IndexError, N_("line number out of range"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004859 return NULL;
4860 }
4861
4862 return GetBufferLine(self->buf, n+start);
4863}
4864
4865 static PyObject *
4866RBSlice(BufferObject *self, PyInt lo, PyInt hi, PyInt start, PyInt end)
4867{
4868 PyInt size;
4869
4870 if (CheckBuffer(self))
4871 return NULL;
4872
Bram Moolenaar8f1723d2013-05-12 20:36:14 +02004873 if (end == -1)
4874 end = self->buf->b_ml.ml_line_count;
4875
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004876 size = end - start + 1;
4877
4878 if (lo < 0)
4879 lo = 0;
4880 else if (lo > size)
4881 lo = size;
4882 if (hi < 0)
4883 hi = 0;
4884 if (hi < lo)
4885 hi = lo;
4886 else if (hi > size)
4887 hi = size;
4888
4889 return GetBufferLineList(self->buf, lo+start, hi+start);
4890}
4891
4892 static PyInt
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004893RBAsItem(
4894 BufferObject *self,
4895 PyInt n,
4896 PyObject *valObject,
4897 PyInt start,
4898 PyInt end,
4899 PyInt *new_end)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004900{
4901 PyInt len_change;
4902
4903 if (CheckBuffer(self))
4904 return -1;
4905
Bram Moolenaar8f1723d2013-05-12 20:36:14 +02004906 if (end == -1)
4907 end = self->buf->b_ml.ml_line_count;
4908
Bram Moolenaarbd80f352013-05-12 21:16:23 +02004909 if (n < 0)
4910 n += end - start + 1;
4911
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004912 if (n < 0 || n > end - start)
4913 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004914 PyErr_SET_STRING(PyExc_IndexError, N_("line number out of range"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004915 return -1;
4916 }
4917
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004918 if (SetBufferLine(self->buf, n+start, valObject, &len_change) == FAIL)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004919 return -1;
4920
4921 if (new_end)
4922 *new_end = end + len_change;
4923
4924 return 0;
4925}
4926
Bram Moolenaar19e60942011-06-19 00:27:51 +02004927 static PyInt
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004928RBAsSlice(
4929 BufferObject *self,
4930 PyInt lo,
4931 PyInt hi,
4932 PyObject *valObject,
4933 PyInt start,
4934 PyInt end,
4935 PyInt *new_end)
Bram Moolenaar19e60942011-06-19 00:27:51 +02004936{
4937 PyInt size;
4938 PyInt len_change;
4939
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004940 // Self must be a valid buffer
Bram Moolenaar19e60942011-06-19 00:27:51 +02004941 if (CheckBuffer(self))
4942 return -1;
4943
Bram Moolenaar8f1723d2013-05-12 20:36:14 +02004944 if (end == -1)
4945 end = self->buf->b_ml.ml_line_count;
4946
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01004947 // Sort out the slice range
Bram Moolenaar19e60942011-06-19 00:27:51 +02004948 size = end - start + 1;
4949
4950 if (lo < 0)
4951 lo = 0;
4952 else if (lo > size)
4953 lo = size;
4954 if (hi < 0)
4955 hi = 0;
4956 if (hi < lo)
4957 hi = lo;
4958 else if (hi > size)
4959 hi = size;
4960
4961 if (SetBufferLineList(self->buf, lo + start, hi + start,
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004962 valObject, &len_change) == FAIL)
Bram Moolenaar19e60942011-06-19 00:27:51 +02004963 return -1;
4964
4965 if (new_end)
4966 *new_end = end + len_change;
4967
4968 return 0;
4969}
4970
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004971
4972 static PyObject *
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02004973RBAppend(
4974 BufferObject *self,
4975 PyObject *args,
4976 PyInt start,
4977 PyInt end,
4978 PyInt *new_end)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004979{
4980 PyObject *lines;
4981 PyInt len_change;
4982 PyInt max;
4983 PyInt n;
4984
4985 if (CheckBuffer(self))
4986 return NULL;
4987
Bram Moolenaar8f1723d2013-05-12 20:36:14 +02004988 if (end == -1)
4989 end = self->buf->b_ml.ml_line_count;
4990
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004991 max = n = end - start + 1;
4992
4993 if (!PyArg_ParseTuple(args, "O|n", &lines, &n))
4994 return NULL;
4995
4996 if (n < 0 || n > max)
4997 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02004998 PyErr_SET_STRING(PyExc_IndexError, N_("line number out of range"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02004999 return NULL;
5000 }
5001
5002 if (InsertBufferLines(self->buf, n + start - 1, lines, &len_change) == FAIL)
5003 return NULL;
5004
5005 if (new_end)
5006 *new_end = end + len_change;
5007
5008 Py_INCREF(Py_None);
5009 return Py_None;
5010}
5011
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005012// Range object
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005013
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005014static PyTypeObject RangeType;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005015static PySequenceMethods RangeAsSeq;
5016static PyMappingMethods RangeAsMapping;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005017
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005018typedef struct
5019{
5020 PyObject_HEAD
5021 BufferObject *buf;
5022 PyInt start;
5023 PyInt end;
5024} RangeObject;
5025
5026 static PyObject *
5027RangeNew(buf_T *buf, PyInt start, PyInt end)
5028{
5029 BufferObject *bufr;
5030 RangeObject *self;
Bram Moolenaar774267b2013-05-21 20:51:59 +02005031 self = PyObject_GC_New(RangeObject, &RangeType);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005032 if (self == NULL)
5033 return NULL;
5034
5035 bufr = (BufferObject *)BufferNew(buf);
5036 if (bufr == NULL)
5037 {
5038 Py_DECREF(self);
5039 return NULL;
5040 }
5041 Py_INCREF(bufr);
5042
5043 self->buf = bufr;
5044 self->start = start;
5045 self->end = end;
5046
5047 return (PyObject *)(self);
5048}
5049
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005050 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02005051RangeDestructor(RangeObject *self)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005052{
Bram Moolenaar774267b2013-05-21 20:51:59 +02005053 PyObject_GC_UnTrack((void *)(self));
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005054 Py_XDECREF(self->buf);
Bram Moolenaar774267b2013-05-21 20:51:59 +02005055 PyObject_GC_Del((void *)(self));
5056}
5057
5058 static int
5059RangeTraverse(RangeObject *self, visitproc visit, void *arg)
5060{
5061 Py_VISIT(((PyObject *)(self->buf)));
5062 return 0;
5063}
5064
5065 static int
5066RangeClear(RangeObject *self)
5067{
5068 Py_CLEAR(self->buf);
5069 return 0;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005070}
5071
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005072 static PyInt
Bram Moolenaard6e39182013-05-21 18:30:34 +02005073RangeLength(RangeObject *self)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005074{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005075 // HOW DO WE SIGNAL AN ERROR FROM THIS FUNCTION?
Bram Moolenaard6e39182013-05-21 18:30:34 +02005076 if (CheckBuffer(self->buf))
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005077 return -1; // ???
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005078
Bram Moolenaard6e39182013-05-21 18:30:34 +02005079 return (self->end - self->start + 1);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005080}
5081
5082 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005083RangeItem(RangeObject *self, PyInt n)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005084{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005085 return RBItem(self->buf, n, self->start, self->end);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005086}
5087
5088 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005089RangeSlice(RangeObject *self, PyInt lo, PyInt hi)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005090{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005091 return RBSlice(self->buf, lo, hi, self->start, self->end);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005092}
5093
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005094static char *RangeAttrs[] = {
5095 "start", "end",
5096 NULL
5097};
5098
5099 static PyObject *
5100RangeDir(PyObject *self)
5101{
5102 return ObjectDir(self, RangeAttrs);
5103}
5104
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005105 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005106RangeAppend(RangeObject *self, PyObject *args)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005107{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005108 return RBAppend(self->buf, args, self->start, self->end, &self->end);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005109}
5110
5111 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005112RangeRepr(RangeObject *self)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005113{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005114 if (self->buf->buf == INVALID_BUFFER_VALUE)
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02005115 return PyString_FromFormat("<range object (for deleted buffer) at %p>",
5116 (self));
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005117 else
5118 {
Bram Moolenaard6e39182013-05-21 18:30:34 +02005119 char *name = (char *)self->buf->buf->b_fname;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005120
5121 if (name == NULL)
5122 name = "";
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005123
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02005124 return PyString_FromFormat("<range %s (%d:%d)>",
Bram Moolenaarf62d9422013-05-30 19:01:24 +02005125 name, (int)self->start, (int)self->end);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005126 }
5127}
5128
5129static struct PyMethodDef RangeMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005130 // name, function, calling, documentation
Bram Moolenaar182dc4f2013-05-21 19:01:55 +02005131 {"append", (PyCFunction)RangeAppend, METH_VARARGS, "Append data to the Vim range" },
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005132 {"__dir__", (PyCFunction)RangeDir, METH_NOARGS, ""},
5133 { NULL, NULL, 0, NULL}
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005134};
5135
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005136static PyTypeObject BufferType;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005137static PySequenceMethods BufferAsSeq;
5138static PyMappingMethods BufferAsMapping;
5139
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005140 static PyObject *
Bram Moolenaar971db462013-05-12 18:44:48 +02005141BufferNew(buf_T *buf)
5142{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005143 /*
5144 * We need to handle deletion of buffers underneath us.
Bram Moolenaar971db462013-05-12 18:44:48 +02005145 * If we add a "b_python*_ref" field to the buf_T structure,
5146 * then we can get at it in buf_freeall() in vim. We then
5147 * need to create only ONE Python object per buffer - if
5148 * we try to create a second, just INCREF the existing one
5149 * and return it. The (single) Python object referring to
5150 * the buffer is stored in "b_python*_ref".
5151 * Question: what to do on a buf_freeall(). We'll probably
5152 * have to either delete the Python object (DECREF it to
5153 * zero - a bad idea, as it leaves dangling refs!) or
5154 * set the buf_T * value to an invalid value (-1?), which
5155 * means we need checks in all access functions... Bah.
5156 *
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005157 * Python2 and Python3 get different fields and different objects:
Bram Moolenaar971db462013-05-12 18:44:48 +02005158 * b_python_ref and b_python3_ref fields respectively.
5159 */
5160
5161 BufferObject *self;
5162
5163 if (BUF_PYTHON_REF(buf) != NULL)
5164 {
5165 self = BUF_PYTHON_REF(buf);
5166 Py_INCREF(self);
5167 }
5168 else
5169 {
5170 self = PyObject_NEW(BufferObject, &BufferType);
5171 if (self == NULL)
5172 return NULL;
5173 self->buf = buf;
5174 BUF_PYTHON_REF(buf) = self;
5175 }
5176
5177 return (PyObject *)(self);
5178}
5179
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005180 static void
Bram Moolenaard6e39182013-05-21 18:30:34 +02005181BufferDestructor(BufferObject *self)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005182{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005183 if (self->buf && self->buf != INVALID_BUFFER_VALUE)
5184 BUF_PYTHON_REF(self->buf) = NULL;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005185
5186 DESTRUCTOR_FINISH(self);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005187}
5188
Bram Moolenaar971db462013-05-12 18:44:48 +02005189 static PyInt
Bram Moolenaard6e39182013-05-21 18:30:34 +02005190BufferLength(BufferObject *self)
Bram Moolenaar971db462013-05-12 18:44:48 +02005191{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005192 // HOW DO WE SIGNAL AN ERROR FROM THIS FUNCTION?
Bram Moolenaard6e39182013-05-21 18:30:34 +02005193 if (CheckBuffer(self))
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005194 return -1; // ???
Bram Moolenaar971db462013-05-12 18:44:48 +02005195
Bram Moolenaard6e39182013-05-21 18:30:34 +02005196 return (PyInt)(self->buf->b_ml.ml_line_count);
Bram Moolenaar971db462013-05-12 18:44:48 +02005197}
5198
5199 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005200BufferItem(BufferObject *self, PyInt n)
Bram Moolenaar971db462013-05-12 18:44:48 +02005201{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005202 return RBItem(self, n, 1, -1);
Bram Moolenaar971db462013-05-12 18:44:48 +02005203}
5204
5205 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005206BufferSlice(BufferObject *self, PyInt lo, PyInt hi)
Bram Moolenaar971db462013-05-12 18:44:48 +02005207{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005208 return RBSlice(self, lo, hi, 1, -1);
Bram Moolenaar971db462013-05-12 18:44:48 +02005209}
5210
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005211static char *BufferAttrs[] = {
5212 "name", "number", "vars", "options", "valid",
5213 NULL
5214};
5215
5216 static PyObject *
5217BufferDir(PyObject *self)
5218{
5219 return ObjectDir(self, BufferAttrs);
5220}
5221
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005222 static PyObject *
Bram Moolenaar9e822c02013-05-29 22:15:30 +02005223BufferAttrValid(BufferObject *self, char *name)
5224{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005225 PyObject *ret;
Bram Moolenaar9e822c02013-05-29 22:15:30 +02005226
5227 if (strcmp(name, "valid") != 0)
5228 return NULL;
5229
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005230 ret = ((self->buf == INVALID_BUFFER_VALUE) ? Py_False : Py_True);
5231 Py_INCREF(ret);
5232 return ret;
Bram Moolenaar9e822c02013-05-29 22:15:30 +02005233}
5234
5235 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005236BufferAttr(BufferObject *self, char *name)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005237{
5238 if (strcmp(name, "name") == 0)
Bram Moolenaar432b09c2013-05-29 22:26:18 +02005239 return PyString_FromString((self->buf->b_ffname == NULL
Bram Moolenaar41009372013-07-01 22:03:04 +02005240 ? "" : (char *)self->buf->b_ffname));
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005241 else if (strcmp(name, "number") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02005242 return Py_BuildValue(Py_ssize_t_fmt, self->buf->b_fnum);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005243 else if (strcmp(name, "vars") == 0)
Bram Moolenaara9922d62013-05-30 13:01:18 +02005244 return NEW_DICTIONARY(self->buf->b_vars);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005245 else if (strcmp(name, "options") == 0)
Bram Moolenaard6e39182013-05-21 18:30:34 +02005246 return OptionsNew(SREQ_BUF, self->buf, (checkfun) CheckBuffer,
5247 (PyObject *) self);
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005248 else if (strcmp(name, "__members__") == 0)
5249 return ObjectDir(NULL, BufferAttrs);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005250 else
5251 return NULL;
5252}
5253
Bram Moolenaare9ba5162013-05-29 22:02:22 +02005254 static int
5255BufferSetattr(BufferObject *self, char *name, PyObject *valObject)
5256{
5257 if (CheckBuffer(self))
5258 return -1;
5259
5260 if (strcmp(name, "name") == 0)
5261 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005262 char_u *val;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02005263 aco_save_T aco;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005264 int ren_ret;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02005265 PyObject *todecref;
5266
5267 if (!(val = StringToChars(valObject, &todecref)))
5268 return -1;
5269
5270 VimTryStart();
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005271 // Using aucmd_*: autocommands will be executed by rename_buffer
Bram Moolenaare9ba5162013-05-29 22:02:22 +02005272 aucmd_prepbuf(&aco, self->buf);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005273 ren_ret = rename_buffer(val);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02005274 aucmd_restbuf(&aco);
5275 Py_XDECREF(todecref);
5276 if (VimTryEnd())
5277 return -1;
5278
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005279 if (ren_ret == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02005280 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005281 PyErr_SET_VIM(N_("failed to rename buffer"));
Bram Moolenaare9ba5162013-05-29 22:02:22 +02005282 return -1;
5283 }
5284 return 0;
5285 }
5286 else
5287 {
5288 PyErr_SetString(PyExc_AttributeError, name);
5289 return -1;
5290 }
5291}
5292
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005293 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005294BufferAppend(BufferObject *self, PyObject *args)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005295{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005296 return RBAppend(self, args, 1, -1, NULL);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005297}
5298
5299 static PyObject *
Bram Moolenaar389a1792013-06-23 13:00:44 +02005300BufferMark(BufferObject *self, PyObject *pmarkObject)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005301{
5302 pos_T *posp;
Bram Moolenaar389a1792013-06-23 13:00:44 +02005303 char_u *pmark;
5304 char_u mark;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02005305 bufref_T savebuf;
Bram Moolenaar389a1792013-06-23 13:00:44 +02005306 PyObject *todecref;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005307
Bram Moolenaard6e39182013-05-21 18:30:34 +02005308 if (CheckBuffer(self))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005309 return NULL;
5310
Bram Moolenaar389a1792013-06-23 13:00:44 +02005311 if (!(pmark = StringToChars(pmarkObject, &todecref)))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005312 return NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005313
Bram Moolenaar389a1792013-06-23 13:00:44 +02005314 if (pmark[0] == '\0' || pmark[1] != '\0')
Bram Moolenaar494ff7e2013-05-30 13:17:17 +02005315 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02005316 PyErr_SET_STRING(PyExc_ValueError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005317 N_("mark name must be a single character"));
Bram Moolenaar841fbd22013-06-23 14:37:07 +02005318 Py_XDECREF(todecref);
Bram Moolenaar494ff7e2013-05-30 13:17:17 +02005319 return NULL;
5320 }
5321
5322 mark = *pmark;
Bram Moolenaar389a1792013-06-23 13:00:44 +02005323
5324 Py_XDECREF(todecref);
5325
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005326 VimTryStart();
Bram Moolenaard6e39182013-05-21 18:30:34 +02005327 switch_buffer(&savebuf, self->buf);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005328 posp = getmark(mark, FALSE);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02005329 restore_buffer(&savebuf);
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005330 if (VimTryEnd())
5331 return NULL;
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005332
5333 if (posp == NULL)
5334 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005335 PyErr_SET_VIM(N_("invalid mark name"));
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005336 return NULL;
5337 }
5338
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005339 if (posp->lnum <= 0)
5340 {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005341 // Or raise an error?
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005342 Py_INCREF(Py_None);
5343 return Py_None;
5344 }
5345
5346 return Py_BuildValue("(ll)", (long)(posp->lnum), (long)(posp->col));
5347}
5348
5349 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005350BufferRange(BufferObject *self, PyObject *args)
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005351{
5352 PyInt start;
5353 PyInt end;
5354
Bram Moolenaard6e39182013-05-21 18:30:34 +02005355 if (CheckBuffer(self))
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005356 return NULL;
5357
5358 if (!PyArg_ParseTuple(args, "nn", &start, &end))
5359 return NULL;
5360
Bram Moolenaard6e39182013-05-21 18:30:34 +02005361 return RangeNew(self->buf, start, end);
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005362}
5363
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005364 static PyObject *
Bram Moolenaard6e39182013-05-21 18:30:34 +02005365BufferRepr(BufferObject *self)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005366{
Bram Moolenaard6e39182013-05-21 18:30:34 +02005367 if (self->buf == INVALID_BUFFER_VALUE)
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02005368 return PyString_FromFormat("<buffer object (deleted) at %p>", self);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005369 else
5370 {
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02005371 char *name = (char *)self->buf->b_fname;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005372
5373 if (name == NULL)
5374 name = "";
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005375
Bram Moolenaar1a3b5692013-05-30 12:40:39 +02005376 return PyString_FromFormat("<buffer %s>", name);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005377 }
5378}
5379
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005380static struct PyMethodDef BufferMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005381 // name, function, calling, documentation
Bram Moolenaar182dc4f2013-05-21 19:01:55 +02005382 {"append", (PyCFunction)BufferAppend, METH_VARARGS, "Append data to Vim buffer" },
Bram Moolenaar389a1792013-06-23 13:00:44 +02005383 {"mark", (PyCFunction)BufferMark, METH_O, "Return (row,col) representing position of named mark" },
Bram Moolenaar182dc4f2013-05-21 19:01:55 +02005384 {"range", (PyCFunction)BufferRange, METH_VARARGS, "Return a range object which represents the part of the given buffer between line numbers s and e" },
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005385 {"__dir__", (PyCFunction)BufferDir, METH_NOARGS, ""},
5386 { NULL, NULL, 0, NULL}
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005387};
5388
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005389/*
5390 * Buffer list object - Implementation
5391 */
5392
5393static PyTypeObject BufMapType;
5394
5395typedef struct
5396{
5397 PyObject_HEAD
5398} BufMapObject;
5399
5400 static PyInt
5401BufMapLength(PyObject *self UNUSED)
5402{
5403 buf_T *b = firstbuf;
5404 PyInt n = 0;
5405
5406 while (b)
5407 {
5408 ++n;
5409 b = b->b_next;
5410 }
5411
5412 return n;
5413}
5414
5415 static PyObject *
5416BufMapItem(PyObject *self UNUSED, PyObject *keyObject)
5417{
5418 buf_T *b;
Bram Moolenaar141be8a2013-06-23 14:16:57 +02005419 long bnr;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005420
Bram Moolenaar141be8a2013-06-23 14:16:57 +02005421 if (NumberToLong(keyObject, &bnr, NUMBER_INT|NUMBER_NATURAL))
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005422 return NULL;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005423
Bram Moolenaar141be8a2013-06-23 14:16:57 +02005424 b = buflist_findnr((int) bnr);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005425
5426 if (b)
5427 return BufferNew(b);
5428 else
5429 {
Bram Moolenaar4d188da2013-05-15 15:35:09 +02005430 PyErr_SetObject(PyExc_KeyError, keyObject);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005431 return NULL;
5432 }
5433}
5434
5435 static void
5436BufMapIterDestruct(PyObject *buffer)
5437{
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005438 // Iteration was stopped before all buffers were processed
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005439 if (buffer)
5440 {
5441 Py_DECREF(buffer);
5442 }
5443}
5444
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02005445 static int
5446BufMapIterTraverse(PyObject *buffer, visitproc visit, void *arg)
5447{
Bram Moolenaar774267b2013-05-21 20:51:59 +02005448 if (buffer)
5449 Py_VISIT(buffer);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02005450 return 0;
5451}
5452
5453 static int
5454BufMapIterClear(PyObject **buffer)
5455{
Bram Moolenaar774267b2013-05-21 20:51:59 +02005456 if (*buffer)
5457 Py_CLEAR(*buffer);
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02005458 return 0;
5459}
5460
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005461 static PyObject *
5462BufMapIterNext(PyObject **buffer)
5463{
5464 PyObject *next;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005465 PyObject *ret;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005466
5467 if (!*buffer)
5468 return NULL;
5469
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005470 ret = *buffer;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005471
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005472 if (CheckBuffer((BufferObject *)(ret)))
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005473 {
5474 *buffer = NULL;
5475 return NULL;
5476 }
5477
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005478 if (!((BufferObject *)(ret))->buf->b_next)
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005479 next = NULL;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005480 else if (!(next = BufferNew(((BufferObject *)(ret))->buf->b_next)))
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005481 return NULL;
5482 *buffer = next;
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005483 // Do not increment reference: we no longer hold it (decref), but whoever
5484 // on other side will hold (incref). Decref+incref = nothing.
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005485 return ret;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005486}
5487
5488 static PyObject *
5489BufMapIter(PyObject *self UNUSED)
5490{
5491 PyObject *buffer;
5492
5493 buffer = BufferNew(firstbuf);
5494 return IterNew(buffer,
Bram Moolenaarcfef5ff2013-05-17 16:24:32 +02005495 (destructorfun) BufMapIterDestruct, (nextfun) BufMapIterNext,
5496 (traversefun) BufMapIterTraverse, (clearfun) BufMapIterClear);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02005497}
5498
5499static PyMappingMethods BufMapAsMapping = {
5500 (lenfunc) BufMapLength,
5501 (binaryfunc) BufMapItem,
5502 (objobjargproc) 0,
5503};
5504
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005505// Current items object
Bram Moolenaarca8a4df2010-07-31 19:54:14 +02005506
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005507static char *CurrentAttrs[] = {
5508 "buffer", "window", "line", "range", "tabpage",
5509 NULL
5510};
5511
5512 static PyObject *
5513CurrentDir(PyObject *self)
5514{
5515 return ObjectDir(self, CurrentAttrs);
5516}
5517
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005518 static PyObject *
5519CurrentGetattr(PyObject *self UNUSED, char *name)
5520{
5521 if (strcmp(name, "buffer") == 0)
5522 return (PyObject *)BufferNew(curbuf);
5523 else if (strcmp(name, "window") == 0)
Bram Moolenaarcabf80f2013-05-17 16:18:33 +02005524 return (PyObject *)WindowNew(curwin, curtab);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02005525 else if (strcmp(name, "tabpage") == 0)
5526 return (PyObject *)TabPageNew(curtab);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005527 else if (strcmp(name, "line") == 0)
5528 return GetBufferLine(curbuf, (PyInt)curwin->w_cursor.lnum);
5529 else if (strcmp(name, "range") == 0)
5530 return RangeNew(curbuf, RangeStart, RangeEnd);
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005531 else if (strcmp(name, "__members__") == 0)
5532 return ObjectDir(NULL, CurrentAttrs);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005533 else
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005534#if PY_MAJOR_VERSION < 3
5535 return Py_FindMethod(WindowMethods, self, name);
5536#else
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005537 return NULL;
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005538#endif
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005539}
5540
5541 static int
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005542CurrentSetattr(PyObject *self UNUSED, char *name, PyObject *valObject)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005543{
5544 if (strcmp(name, "line") == 0)
5545 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005546 if (SetBufferLine(curbuf, (PyInt)curwin->w_cursor.lnum, valObject,
5547 NULL) == FAIL)
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005548 return -1;
5549
5550 return 0;
5551 }
Bram Moolenaare7614592013-05-15 15:51:08 +02005552 else if (strcmp(name, "buffer") == 0)
5553 {
5554 int count;
5555
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005556 if (valObject->ob_type != &BufferType)
Bram Moolenaare7614592013-05-15 15:51:08 +02005557 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02005558 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005559 N_("expected vim.Buffer object, but got %s"),
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005560 Py_TYPE_NAME(valObject));
Bram Moolenaare7614592013-05-15 15:51:08 +02005561 return -1;
5562 }
5563
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005564 if (CheckBuffer((BufferObject *)(valObject)))
Bram Moolenaare7614592013-05-15 15:51:08 +02005565 return -1;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005566 count = ((BufferObject *)(valObject))->buf->b_fnum;
Bram Moolenaare7614592013-05-15 15:51:08 +02005567
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005568 VimTryStart();
Bram Moolenaare7614592013-05-15 15:51:08 +02005569 if (do_buffer(DOBUF_GOTO, DOBUF_FIRST, FORWARD, count, 0) == FAIL)
5570 {
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005571 if (VimTryEnd())
5572 return -1;
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005573 PyErr_VIM_FORMAT(N_("failed to switch to buffer %d"), count);
Bram Moolenaare7614592013-05-15 15:51:08 +02005574 return -1;
5575 }
5576
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005577 return VimTryEnd();
Bram Moolenaare7614592013-05-15 15:51:08 +02005578 }
5579 else if (strcmp(name, "window") == 0)
5580 {
5581 int count;
5582
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005583 if (valObject->ob_type != &WindowType)
Bram Moolenaare7614592013-05-15 15:51:08 +02005584 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02005585 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005586 N_("expected vim.Window object, but got %s"),
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005587 Py_TYPE_NAME(valObject));
Bram Moolenaare7614592013-05-15 15:51:08 +02005588 return -1;
5589 }
5590
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005591 if (CheckWindow((WindowObject *)(valObject)))
Bram Moolenaare7614592013-05-15 15:51:08 +02005592 return -1;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005593 count = get_win_number(((WindowObject *)(valObject))->win, firstwin);
Bram Moolenaare7614592013-05-15 15:51:08 +02005594
5595 if (!count)
5596 {
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02005597 PyErr_SET_STRING(PyExc_ValueError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005598 N_("failed to find window in the current tab page"));
Bram Moolenaare7614592013-05-15 15:51:08 +02005599 return -1;
5600 }
5601
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005602 VimTryStart();
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005603 win_goto(((WindowObject *)(valObject))->win);
5604 if (((WindowObject *)(valObject))->win != curwin)
Bram Moolenaare7614592013-05-15 15:51:08 +02005605 {
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005606 if (VimTryEnd())
5607 return -1;
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02005608 PyErr_SET_STRING(PyExc_RuntimeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005609 N_("did not switch to the specified window"));
Bram Moolenaare7614592013-05-15 15:51:08 +02005610 return -1;
5611 }
5612
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005613 return VimTryEnd();
Bram Moolenaare7614592013-05-15 15:51:08 +02005614 }
5615 else if (strcmp(name, "tabpage") == 0)
5616 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005617 if (valObject->ob_type != &TabPageType)
Bram Moolenaare7614592013-05-15 15:51:08 +02005618 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02005619 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005620 N_("expected vim.TabPage object, but got %s"),
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005621 Py_TYPE_NAME(valObject));
Bram Moolenaare7614592013-05-15 15:51:08 +02005622 return -1;
5623 }
5624
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005625 if (CheckTabPage((TabPageObject *)(valObject)))
Bram Moolenaare7614592013-05-15 15:51:08 +02005626 return -1;
5627
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005628 VimTryStart();
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005629 goto_tabpage_tp(((TabPageObject *)(valObject))->tab, TRUE, TRUE);
5630 if (((TabPageObject *)(valObject))->tab != curtab)
Bram Moolenaare7614592013-05-15 15:51:08 +02005631 {
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005632 if (VimTryEnd())
5633 return -1;
Bram Moolenaar0bd80cc2013-06-23 13:28:17 +02005634 PyErr_SET_STRING(PyExc_RuntimeError,
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02005635 N_("did not switch to the specified tab page"));
Bram Moolenaare7614592013-05-15 15:51:08 +02005636 return -1;
5637 }
5638
Bram Moolenaara7b64ce2013-05-21 20:40:40 +02005639 return VimTryEnd();
Bram Moolenaare7614592013-05-15 15:51:08 +02005640 }
Bram Moolenaar4d1da492013-04-24 13:39:15 +02005641 else
5642 {
5643 PyErr_SetString(PyExc_AttributeError, name);
5644 return -1;
5645 }
5646}
5647
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005648static struct PyMethodDef CurrentMethods[] = {
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005649 // name, function, calling, documentation
Bram Moolenaardd8aca62013-05-29 22:36:10 +02005650 {"__dir__", (PyCFunction)CurrentDir, METH_NOARGS, ""},
5651 { NULL, NULL, 0, NULL}
5652};
5653
Bram Moolenaardb913952012-06-29 12:54:53 +02005654 static void
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005655init_range_cmd(exarg_T *eap)
5656{
5657 RangeStart = eap->line1;
5658 RangeEnd = eap->line2;
5659}
5660
5661 static void
5662init_range_eval(typval_T *rettv UNUSED)
5663{
5664 RangeStart = (PyInt) curwin->w_cursor.lnum;
5665 RangeEnd = RangeStart;
5666}
5667
5668 static void
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005669run_cmd(const char *cmd, void *arg UNUSED
5670#ifdef PY_CAN_RECURSE
5671 , PyGILState_STATE *pygilstate UNUSED
5672#endif
5673 )
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005674{
Bram Moolenaar41009372013-07-01 22:03:04 +02005675 PyObject *run_ret;
5676 run_ret = PyRun_String((char *)cmd, Py_file_input, globals, globals);
5677 if (run_ret != NULL)
5678 {
5679 Py_DECREF(run_ret);
5680 }
5681 else if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_SystemExit))
5682 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005683 semsg(_(e_py_systemexit), "python");
Bram Moolenaar41009372013-07-01 22:03:04 +02005684 PyErr_Clear();
5685 }
5686 else
5687 PyErr_PrintEx(1);
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005688}
5689
5690static const char *code_hdr = "def " DOPY_FUNC "(line, linenr):\n ";
5691static int code_hdr_len = 30;
5692
5693 static void
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005694run_do(const char *cmd, void *arg UNUSED
5695#ifdef PY_CAN_RECURSE
5696 , PyGILState_STATE *pygilstate
5697#endif
5698 )
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005699{
5700 PyInt lnum;
5701 size_t len;
5702 char *code;
5703 int status;
5704 PyObject *pyfunc, *pymain;
Bram Moolenaar41009372013-07-01 22:03:04 +02005705 PyObject *run_ret;
Bram Moolenaara58883b2017-01-29 21:31:09 +01005706 buf_T *was_curbuf = curbuf;
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005707
Bram Moolenaar4ac66762013-05-28 22:31:46 +02005708 if (u_save((linenr_T)RangeStart - 1, (linenr_T)RangeEnd + 1) != OK)
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005709 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005710 emsg(_("cannot save undo information"));
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005711 return;
5712 }
5713
5714 len = code_hdr_len + STRLEN(cmd);
5715 code = PyMem_New(char, len + 1);
5716 memcpy(code, code_hdr, code_hdr_len);
5717 STRCPY(code + code_hdr_len, cmd);
Bram Moolenaar41009372013-07-01 22:03:04 +02005718 run_ret = PyRun_String(code, Py_file_input, globals, globals);
5719 status = -1;
5720 if (run_ret != NULL)
5721 {
5722 status = 0;
5723 Py_DECREF(run_ret);
5724 }
5725 else if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_SystemExit))
5726 {
5727 PyMem_Free(code);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005728 semsg(_(e_py_systemexit), "python");
Bram Moolenaar41009372013-07-01 22:03:04 +02005729 PyErr_Clear();
5730 return;
5731 }
5732 else
5733 PyErr_PrintEx(1);
5734
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005735 PyMem_Free(code);
5736
5737 if (status)
5738 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005739 emsg(_("failed to run the code"));
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005740 return;
5741 }
5742
5743 status = 0;
5744 pymain = PyImport_AddModule("__main__");
5745 pyfunc = PyObject_GetAttrString(pymain, DOPY_FUNC);
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005746#ifdef PY_CAN_RECURSE
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005747 PyGILState_Release(*pygilstate);
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005748#endif
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005749
5750 for (lnum = RangeStart; lnum <= RangeEnd; ++lnum)
5751 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005752 PyObject *line;
5753 PyObject *linenr;
5754 PyObject *ret;
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005755
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005756#ifdef PY_CAN_RECURSE
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005757 *pygilstate = PyGILState_Ensure();
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005758#endif
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005759 // Check the line number, the command my have deleted lines.
Bram Moolenaara58883b2017-01-29 21:31:09 +01005760 if (lnum > curbuf->b_ml.ml_line_count
5761 || !(line = GetBufferLine(curbuf, lnum)))
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005762 goto err;
5763 if (!(linenr = PyInt_FromLong((long) lnum)))
5764 {
5765 Py_DECREF(line);
5766 goto err;
5767 }
5768 ret = PyObject_CallFunctionObjArgs(pyfunc, line, linenr, NULL);
5769 Py_DECREF(line);
5770 Py_DECREF(linenr);
5771 if (!ret)
5772 goto err;
5773
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01005774 // Check that the command didn't switch to another buffer.
Bram Moolenaara58883b2017-01-29 21:31:09 +01005775 if (curbuf != was_curbuf)
5776 {
5777 Py_XDECREF(ret);
5778 goto err;
5779 }
5780
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005781 if (ret != Py_None)
5782 if (SetBufferLine(curbuf, lnum, ret, NULL) == FAIL)
Bram Moolenaara58883b2017-01-29 21:31:09 +01005783 {
5784 Py_XDECREF(ret);
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005785 goto err;
Bram Moolenaara58883b2017-01-29 21:31:09 +01005786 }
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005787
5788 Py_XDECREF(ret);
5789 PythonIO_Flush();
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005790#ifdef PY_CAN_RECURSE
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005791 PyGILState_Release(*pygilstate);
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005792#endif
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005793 }
5794 goto out;
5795err:
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005796#ifdef PY_CAN_RECURSE
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005797 *pygilstate = PyGILState_Ensure();
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005798#endif
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005799 PyErr_PrintEx(0);
5800 PythonIO_Flush();
5801 status = 1;
5802out:
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005803#ifdef PY_CAN_RECURSE
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005804 if (!status)
5805 *pygilstate = PyGILState_Ensure();
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005806#endif
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005807 Py_DECREF(pyfunc);
5808 PyObject_SetAttrString(pymain, DOPY_FUNC, NULL);
5809 if (status)
5810 return;
5811 check_cursor();
5812 update_curbuf(NOT_VALID);
5813}
5814
5815 static void
Bram Moolenaar2a0f3d32013-05-21 22:23:56 +02005816run_eval(const char *cmd, typval_T *rettv
5817#ifdef PY_CAN_RECURSE
5818 , PyGILState_STATE *pygilstate UNUSED
5819#endif
5820 )
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005821{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005822 PyObject *run_ret;
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005823
Bram Moolenaar41009372013-07-01 22:03:04 +02005824 run_ret = PyRun_String((char *)cmd, Py_eval_input, globals, globals);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005825 if (run_ret == NULL)
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005826 {
Bram Moolenaar91aeaf42013-07-06 13:02:30 +02005827 if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_SystemExit))
Bram Moolenaar41009372013-07-01 22:03:04 +02005828 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005829 semsg(_(e_py_systemexit), "python");
Bram Moolenaar41009372013-07-01 22:03:04 +02005830 PyErr_Clear();
5831 }
Bram Moolenaar91aeaf42013-07-06 13:02:30 +02005832 else
5833 {
5834 if (PyErr_Occurred() && !msg_silent)
5835 PyErr_PrintEx(0);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005836 emsg(_("E858: Eval did not return a valid python object"));
Bram Moolenaar91aeaf42013-07-06 13:02:30 +02005837 }
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005838 }
5839 else
5840 {
Bram Moolenaarde323092017-11-09 19:56:08 +01005841 if (ConvertFromPyObject(run_ret, rettv) == -1)
Bram Moolenaar86181df2020-05-11 23:14:04 +02005842 emsg(_("E859: Failed to convert returned python object to a Vim value"));
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02005843 Py_DECREF(run_ret);
Bram Moolenaarb52f4c02013-05-21 18:19:38 +02005844 }
5845 PyErr_Clear();
5846}
5847
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005848 static int
Bram Moolenaardb913952012-06-29 12:54:53 +02005849set_ref_in_py(const int copyID)
5850{
5851 pylinkedlist_T *cur;
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005852 list_T *ll;
5853 int i;
5854 int abort = FALSE;
Bram Moolenaar8110a092016-04-14 15:56:09 +02005855 FunctionObject *func;
Bram Moolenaardb913952012-06-29 12:54:53 +02005856
5857 if (lastdict != NULL)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005858 {
Bram Moolenaar8110a092016-04-14 15:56:09 +02005859 for (cur = lastdict ; !abort && cur != NULL ; cur = cur->pll_prev)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005860 abort = set_ref_in_dict(((DictionaryObject *)(cur->pll_obj))->dict,
5861 copyID);
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005862 }
Bram Moolenaardb913952012-06-29 12:54:53 +02005863
5864 if (lastlist != NULL)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005865 {
Bram Moolenaar8110a092016-04-14 15:56:09 +02005866 for (cur = lastlist ; !abort && cur != NULL ; cur = cur->pll_prev)
Bram Moolenaardb913952012-06-29 12:54:53 +02005867 {
5868 ll = ((ListObject *) (cur->pll_obj))->list;
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005869 abort = set_ref_in_list(ll, copyID);
Bram Moolenaardb913952012-06-29 12:54:53 +02005870 }
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005871 }
5872
Bram Moolenaar8110a092016-04-14 15:56:09 +02005873 if (lastfunc != NULL)
5874 {
5875 for (cur = lastfunc ; !abort && cur != NULL ; cur = cur->pll_prev)
5876 {
5877 func = (FunctionObject *) cur->pll_obj;
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005878 abort = set_ref_in_dict(func->self, copyID);
Bram Moolenaar8110a092016-04-14 15:56:09 +02005879 if (func->argc)
5880 for (i = 0; !abort && i < func->argc; ++i)
5881 abort = abort
5882 || set_ref_in_item(&func->argv[i], copyID, NULL, NULL);
5883 }
5884 }
5885
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005886 return abort;
Bram Moolenaardb913952012-06-29 12:54:53 +02005887}
5888
5889 static int
5890set_string_copy(char_u *str, typval_T *tv)
5891{
5892 tv->vval.v_string = vim_strsave(str);
5893 if (tv->vval.v_string == NULL)
5894 {
5895 PyErr_NoMemory();
5896 return -1;
5897 }
5898 return 0;
5899}
5900
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005901 static int
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005902pydict_to_tv(PyObject *obj, typval_T *tv, PyObject *lookup_dict)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005903{
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005904 dict_T *dict;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005905 char_u *key;
5906 dictitem_T *di;
5907 PyObject *keyObject;
5908 PyObject *valObject;
5909 Py_ssize_t iter = 0;
5910
Bram Moolenaar35eacd72013-05-30 22:06:33 +02005911 if (!(dict = py_dict_alloc()))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005912 return -1;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005913
5914 tv->v_type = VAR_DICT;
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005915 tv->vval.v_dict = dict;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005916
5917 while (PyDict_Next(obj, &iter, &keyObject, &valObject))
5918 {
Bram Moolenaarfc714b32013-05-30 14:52:37 +02005919 PyObject *todecref = NULL;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005920
Bram Moolenaara03e6312013-05-29 22:49:26 +02005921 if (keyObject == NULL || valObject == NULL)
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005922 {
5923 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005924 return -1;
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005925 }
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005926
Bram Moolenaarfc714b32013-05-30 14:52:37 +02005927 if (!(key = StringToChars(keyObject, &todecref)))
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005928 {
5929 dict_unref(dict);
5930 return -1;
5931 }
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02005932
Bram Moolenaarfc714b32013-05-30 14:52:37 +02005933 if (*key == NUL)
5934 {
5935 dict_unref(dict);
5936 Py_XDECREF(todecref);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02005937 RAISE_NO_EMPTY_KEYS;
Bram Moolenaarfc714b32013-05-30 14:52:37 +02005938 return -1;
5939 }
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005940
5941 di = dictitem_alloc(key);
5942
Bram Moolenaarfc714b32013-05-30 14:52:37 +02005943 Py_XDECREF(todecref);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005944
5945 if (di == NULL)
5946 {
5947 PyErr_NoMemory();
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005948 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005949 return -1;
5950 }
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005951
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005952 if (_ConvertFromPyObject(valObject, &di->di_tv, lookup_dict) == -1)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005953 {
5954 vim_free(di);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005955 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005956 return -1;
5957 }
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005958
5959 if (dict_add(dict, di) == FAIL)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005960 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02005961 RAISE_KEY_ADD_FAIL(di->di_key);
Bram Moolenaara03e6312013-05-29 22:49:26 +02005962 clear_tv(&di->di_tv);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005963 vim_free(di);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005964 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005965 return -1;
5966 }
5967 }
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005968
5969 --dict->dv_refcount;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005970 return 0;
5971}
5972
5973 static int
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005974pymap_to_tv(PyObject *obj, typval_T *tv, PyObject *lookup_dict)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005975{
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005976 dict_T *dict;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005977 char_u *key;
5978 dictitem_T *di;
5979 PyObject *list;
Bram Moolenaarbcb40972013-05-30 13:22:13 +02005980 PyObject *iterator;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005981 PyObject *keyObject;
5982 PyObject *valObject;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005983
Bram Moolenaar35eacd72013-05-30 22:06:33 +02005984 if (!(dict = py_dict_alloc()))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005985 return -1;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005986
5987 tv->v_type = VAR_DICT;
Bram Moolenaarb38caae2013-05-29 22:39:52 +02005988 tv->vval.v_dict = dict;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005989
Bram Moolenaarbcb40972013-05-30 13:22:13 +02005990 if (!(list = PyMapping_Keys(obj)))
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005991 {
5992 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02005993 return -1;
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02005994 }
Bram Moolenaarbcb40972013-05-30 13:22:13 +02005995
5996 if (!(iterator = PyObject_GetIter(list)))
5997 {
5998 dict_unref(dict);
5999 Py_DECREF(list);
6000 return -1;
6001 }
6002 Py_DECREF(list);
6003
6004 while ((keyObject = PyIter_Next(iterator)))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006005 {
Bram Moolenaarfc714b32013-05-30 14:52:37 +02006006 PyObject *todecref;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006007
Bram Moolenaarfc714b32013-05-30 14:52:37 +02006008 if (!(key = StringToChars(keyObject, &todecref)))
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006009 {
Bram Moolenaarfc714b32013-05-30 14:52:37 +02006010 Py_DECREF(keyObject);
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006011 Py_DECREF(iterator);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006012 dict_unref(dict);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006013 return -1;
6014 }
Bram Moolenaar4f2109d2013-06-02 18:07:37 +02006015
Bram Moolenaarfc714b32013-05-30 14:52:37 +02006016 if (*key == NUL)
6017 {
6018 Py_DECREF(keyObject);
6019 Py_DECREF(iterator);
6020 Py_XDECREF(todecref);
6021 dict_unref(dict);
Bram Moolenaar35eacd72013-05-30 22:06:33 +02006022 RAISE_NO_EMPTY_KEYS;
Bram Moolenaarfc714b32013-05-30 14:52:37 +02006023 return -1;
6024 }
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006025
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006026 if (!(valObject = PyObject_GetItem(obj, keyObject)))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006027 {
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006028 Py_DECREF(keyObject);
6029 Py_DECREF(iterator);
Bram Moolenaarfc714b32013-05-30 14:52:37 +02006030 Py_XDECREF(todecref);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006031 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006032 return -1;
6033 }
6034
6035 di = dictitem_alloc(key);
6036
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006037 Py_DECREF(keyObject);
Bram Moolenaarfc714b32013-05-30 14:52:37 +02006038 Py_XDECREF(todecref);
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006039
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006040 if (di == NULL)
6041 {
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006042 Py_DECREF(iterator);
6043 Py_DECREF(valObject);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006044 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006045 PyErr_NoMemory();
6046 return -1;
6047 }
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006048
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006049 if (_ConvertFromPyObject(valObject, &di->di_tv, lookup_dict) == -1)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006050 {
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006051 Py_DECREF(iterator);
6052 Py_DECREF(valObject);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006053 vim_free(di);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006054 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006055 return -1;
6056 }
Bram Moolenaara03e6312013-05-29 22:49:26 +02006057
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006058 Py_DECREF(valObject);
6059
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006060 if (dict_add(dict, di) == FAIL)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006061 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02006062 RAISE_KEY_ADD_FAIL(di->di_key);
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006063 Py_DECREF(iterator);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006064 dictitem_free(di);
6065 dict_unref(dict);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006066 return -1;
6067 }
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006068 }
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006069 Py_DECREF(iterator);
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006070 --dict->dv_refcount;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006071 return 0;
6072}
6073
6074 static int
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006075pyseq_to_tv(PyObject *obj, typval_T *tv, PyObject *lookup_dict)
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006076{
6077 list_T *l;
6078
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006079 if (!(l = py_list_alloc()))
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006080 return -1;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006081
6082 tv->v_type = VAR_LIST;
6083 tv->vval.v_list = l;
6084
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006085 if (list_py_concat(l, obj, lookup_dict) == -1)
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006086 {
6087 list_unref(l);
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006088 return -1;
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006089 }
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006090
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006091 --l->lv_refcount;
Bram Moolenaar3d0c52d2013-05-12 19:45:35 +02006092 return 0;
6093}
6094
Bram Moolenaardb913952012-06-29 12:54:53 +02006095typedef int (*pytotvfunc)(PyObject *, typval_T *, PyObject *);
6096
6097 static int
6098convert_dl(PyObject *obj, typval_T *tv,
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006099 pytotvfunc py_to_tv, PyObject *lookup_dict)
Bram Moolenaardb913952012-06-29 12:54:53 +02006100{
6101 PyObject *capsule;
6102 char hexBuf[sizeof(void *) * 2 + 3];
6103
Bram Moolenaar792f0e32018-02-27 17:27:13 +01006104 sprintf(hexBuf, "%p", (void *)obj);
Bram Moolenaardb913952012-06-29 12:54:53 +02006105
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006106#ifdef PY_USE_CAPSULE
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006107 capsule = PyDict_GetItemString(lookup_dict, hexBuf);
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006108#else
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006109 capsule = (PyObject *)PyDict_GetItemString(lookup_dict, hexBuf);
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006110#endif
Bram Moolenaar221d6872012-06-30 13:34:34 +02006111 if (capsule == NULL)
Bram Moolenaardb913952012-06-29 12:54:53 +02006112 {
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006113#ifdef PY_USE_CAPSULE
Bram Moolenaardb913952012-06-29 12:54:53 +02006114 capsule = PyCapsule_New(tv, NULL, NULL);
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006115#else
Bram Moolenaar221d6872012-06-30 13:34:34 +02006116 capsule = PyCObject_FromVoidPtr(tv, NULL);
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006117#endif
Bram Moolenaara03e6312013-05-29 22:49:26 +02006118 if (PyDict_SetItemString(lookup_dict, hexBuf, capsule))
6119 {
6120 Py_DECREF(capsule);
6121 tv->v_type = VAR_UNKNOWN;
6122 return -1;
6123 }
Bram Moolenaar841fbd22013-06-23 14:37:07 +02006124
6125 Py_DECREF(capsule);
6126
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006127 if (py_to_tv(obj, tv, lookup_dict) == -1)
Bram Moolenaardb913952012-06-29 12:54:53 +02006128 {
6129 tv->v_type = VAR_UNKNOWN;
6130 return -1;
6131 }
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01006132 // As we are not using copy_tv which increments reference count we must
6133 // do it ourself.
Bram Moolenaar81e7a9c2016-02-06 19:57:20 +01006134 if (tv->v_type == VAR_DICT)
6135 ++tv->vval.v_dict->dv_refcount;
6136 else if (tv->v_type == VAR_LIST)
6137 ++tv->vval.v_list->lv_refcount;
Bram Moolenaardb913952012-06-29 12:54:53 +02006138 }
6139 else
6140 {
Bram Moolenaar2afa3232012-06-29 16:28:28 +02006141 typval_T *v;
6142
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006143#ifdef PY_USE_CAPSULE
Bram Moolenaar2afa3232012-06-29 16:28:28 +02006144 v = PyCapsule_GetPointer(capsule, NULL);
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006145#else
Bram Moolenaar221d6872012-06-30 13:34:34 +02006146 v = PyCObject_AsVoidPtr(capsule);
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006147#endif
Bram Moolenaardb913952012-06-29 12:54:53 +02006148 copy_tv(v, tv);
6149 }
6150 return 0;
6151}
6152
6153 static int
Bram Moolenaara9922d62013-05-30 13:01:18 +02006154ConvertFromPyMapping(PyObject *obj, typval_T *tv)
6155{
6156 PyObject *lookup_dict;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006157 int ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02006158
6159 if (!(lookup_dict = PyDict_New()))
6160 return -1;
6161
6162 if (PyType_IsSubtype(obj->ob_type, &DictionaryType))
6163 {
6164 tv->v_type = VAR_DICT;
6165 tv->vval.v_dict = (((DictionaryObject *)(obj))->dict);
6166 ++tv->vval.v_dict->dv_refcount;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006167 ret = 0;
Bram Moolenaara9922d62013-05-30 13:01:18 +02006168 }
6169 else if (PyDict_Check(obj))
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006170 ret = convert_dl(obj, tv, pydict_to_tv, lookup_dict);
Bram Moolenaara9922d62013-05-30 13:01:18 +02006171 else if (PyMapping_Check(obj))
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006172 ret = convert_dl(obj, tv, pymap_to_tv, lookup_dict);
Bram Moolenaara9922d62013-05-30 13:01:18 +02006173 else
6174 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02006175 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar86181df2020-05-11 23:14:04 +02006176 N_("unable to convert %s to a Vim dictionary"),
Bram Moolenaarc476e522013-06-23 13:46:40 +02006177 Py_TYPE_NAME(obj));
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006178 ret = -1;
Bram Moolenaara9922d62013-05-30 13:01:18 +02006179 }
6180 Py_DECREF(lookup_dict);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006181 return ret;
Bram Moolenaara9922d62013-05-30 13:01:18 +02006182}
6183
6184 static int
Bram Moolenaar8110a092016-04-14 15:56:09 +02006185ConvertFromPySequence(PyObject *obj, typval_T *tv)
6186{
6187 PyObject *lookup_dict;
Bram Moolenaar66210042016-04-15 20:40:41 +02006188 int ret;
Bram Moolenaar8110a092016-04-14 15:56:09 +02006189
6190 if (!(lookup_dict = PyDict_New()))
6191 return -1;
6192
6193 if (PyType_IsSubtype(obj->ob_type, &ListType))
6194 {
6195 tv->v_type = VAR_LIST;
6196 tv->vval.v_list = (((ListObject *)(obj))->list);
6197 ++tv->vval.v_list->lv_refcount;
Bram Moolenaar66210042016-04-15 20:40:41 +02006198 ret = 0;
Bram Moolenaar8110a092016-04-14 15:56:09 +02006199 }
6200 else if (PyIter_Check(obj) || PySequence_Check(obj))
Bram Moolenaar66210042016-04-15 20:40:41 +02006201 ret = convert_dl(obj, tv, pyseq_to_tv, lookup_dict);
Bram Moolenaar8110a092016-04-14 15:56:09 +02006202 else
6203 {
6204 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar86181df2020-05-11 23:14:04 +02006205 N_("unable to convert %s to a Vim list"),
Bram Moolenaar8110a092016-04-14 15:56:09 +02006206 Py_TYPE_NAME(obj));
6207 ret = -1;
6208 }
6209 Py_DECREF(lookup_dict);
6210 return ret;
6211}
6212
6213 static int
Bram Moolenaardb913952012-06-29 12:54:53 +02006214ConvertFromPyObject(PyObject *obj, typval_T *tv)
6215{
6216 PyObject *lookup_dict;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006217 int ret;
Bram Moolenaardb913952012-06-29 12:54:53 +02006218
Bram Moolenaar9bb77d62013-05-30 12:14:49 +02006219 if (!(lookup_dict = PyDict_New()))
6220 return -1;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006221 ret = _ConvertFromPyObject(obj, tv, lookup_dict);
Bram Moolenaardb913952012-06-29 12:54:53 +02006222 Py_DECREF(lookup_dict);
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006223 return ret;
Bram Moolenaardb913952012-06-29 12:54:53 +02006224}
6225
6226 static int
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006227_ConvertFromPyObject(PyObject *obj, typval_T *tv, PyObject *lookup_dict)
Bram Moolenaardb913952012-06-29 12:54:53 +02006228{
Bram Moolenaara9922d62013-05-30 13:01:18 +02006229 if (PyType_IsSubtype(obj->ob_type, &DictionaryType))
Bram Moolenaardb913952012-06-29 12:54:53 +02006230 {
6231 tv->v_type = VAR_DICT;
6232 tv->vval.v_dict = (((DictionaryObject *)(obj))->dict);
6233 ++tv->vval.v_dict->dv_refcount;
6234 }
Bram Moolenaar841fbd22013-06-23 14:37:07 +02006235 else if (PyType_IsSubtype(obj->ob_type, &ListType))
Bram Moolenaardb913952012-06-29 12:54:53 +02006236 {
6237 tv->v_type = VAR_LIST;
6238 tv->vval.v_list = (((ListObject *)(obj))->list);
6239 ++tv->vval.v_list->lv_refcount;
6240 }
Bram Moolenaar841fbd22013-06-23 14:37:07 +02006241 else if (PyType_IsSubtype(obj->ob_type, &FunctionType))
Bram Moolenaardb913952012-06-29 12:54:53 +02006242 {
Bram Moolenaar8110a092016-04-14 15:56:09 +02006243 FunctionObject *func = (FunctionObject *) obj;
6244 if (func->self != NULL || func->argv != NULL)
6245 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006246 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
6247
Bram Moolenaar8110a092016-04-14 15:56:09 +02006248 set_partial(func, pt, TRUE);
6249 tv->vval.v_partial = pt;
6250 tv->v_type = VAR_PARTIAL;
6251 }
6252 else
6253 {
6254 if (set_string_copy(func->name, tv) == -1)
6255 return -1;
Bram Moolenaardb913952012-06-29 12:54:53 +02006256
Bram Moolenaar8110a092016-04-14 15:56:09 +02006257 tv->v_type = VAR_FUNC;
6258 }
6259 func_ref(func->name);
Bram Moolenaardb913952012-06-29 12:54:53 +02006260 }
Bram Moolenaardb913952012-06-29 12:54:53 +02006261 else if (PyBytes_Check(obj))
6262 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006263 char_u *str;
Bram Moolenaardb913952012-06-29 12:54:53 +02006264
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006265 if (PyBytes_AsStringAndSize(obj, (char **) &str, NULL) == -1)
Bram Moolenaarafa6b9a2012-09-05 19:09:11 +02006266 return -1;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006267 if (str == NULL)
Bram Moolenaardb913952012-06-29 12:54:53 +02006268 return -1;
6269
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006270 if (set_string_copy(str, tv) == -1)
Bram Moolenaardb913952012-06-29 12:54:53 +02006271 return -1;
6272
6273 tv->v_type = VAR_STRING;
6274 }
6275 else if (PyUnicode_Check(obj))
6276 {
6277 PyObject *bytes;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006278 char_u *str;
Bram Moolenaardb913952012-06-29 12:54:53 +02006279
Bram Moolenaar808c2bc2013-06-23 13:11:18 +02006280 bytes = PyUnicode_AsEncodedString(obj, ENC_OPT, NULL);
Bram Moolenaardb913952012-06-29 12:54:53 +02006281 if (bytes == NULL)
6282 return -1;
6283
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006284 if(PyBytes_AsStringAndSize(bytes, (char **) &str, NULL) == -1)
Bram Moolenaarafa6b9a2012-09-05 19:09:11 +02006285 return -1;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006286 if (str == NULL)
Bram Moolenaardb913952012-06-29 12:54:53 +02006287 return -1;
6288
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006289 if (set_string_copy(str, tv))
Bram Moolenaardb913952012-06-29 12:54:53 +02006290 {
6291 Py_XDECREF(bytes);
6292 return -1;
6293 }
6294 Py_XDECREF(bytes);
6295
6296 tv->v_type = VAR_STRING;
6297 }
Bram Moolenaar335e0b62013-04-24 13:47:45 +02006298#if PY_MAJOR_VERSION < 3
Bram Moolenaardb913952012-06-29 12:54:53 +02006299 else if (PyInt_Check(obj))
6300 {
6301 tv->v_type = VAR_NUMBER;
6302 tv->vval.v_number = (varnumber_T) PyInt_AsLong(obj);
Bram Moolenaar141be8a2013-06-23 14:16:57 +02006303 if (PyErr_Occurred())
6304 return -1;
Bram Moolenaardb913952012-06-29 12:54:53 +02006305 }
6306#endif
6307 else if (PyLong_Check(obj))
6308 {
6309 tv->v_type = VAR_NUMBER;
6310 tv->vval.v_number = (varnumber_T) PyLong_AsLong(obj);
Bram Moolenaar141be8a2013-06-23 14:16:57 +02006311 if (PyErr_Occurred())
6312 return -1;
Bram Moolenaardb913952012-06-29 12:54:53 +02006313 }
6314 else if (PyDict_Check(obj))
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006315 return convert_dl(obj, tv, pydict_to_tv, lookup_dict);
Bram Moolenaardb913952012-06-29 12:54:53 +02006316#ifdef FEAT_FLOAT
6317 else if (PyFloat_Check(obj))
6318 {
6319 tv->v_type = VAR_FLOAT;
6320 tv->vval.v_float = (float_T) PyFloat_AsDouble(obj);
6321 }
6322#endif
Bram Moolenaarbcb40972013-05-30 13:22:13 +02006323 else if (PyObject_HasAttrString(obj, "keys"))
6324 return convert_dl(obj, tv, pymap_to_tv, lookup_dict);
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01006325 // PyObject_GetIter can create built-in iterator for any sequence object
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02006326 else if (PyIter_Check(obj) || PySequence_Check(obj))
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006327 return convert_dl(obj, tv, pyseq_to_tv, lookup_dict);
Bram Moolenaardb913952012-06-29 12:54:53 +02006328 else if (PyMapping_Check(obj))
Bram Moolenaarb38caae2013-05-29 22:39:52 +02006329 return convert_dl(obj, tv, pymap_to_tv, lookup_dict);
Bram Moolenaar141be8a2013-06-23 14:16:57 +02006330 else if (PyNumber_Check(obj))
6331 {
6332 PyObject *num;
6333
6334 if (!(num = PyNumber_Long(obj)))
6335 return -1;
6336
6337 tv->v_type = VAR_NUMBER;
6338 tv->vval.v_number = (varnumber_T) PyLong_AsLong(num);
6339
6340 Py_DECREF(num);
6341 }
Bram Moolenaarde323092017-11-09 19:56:08 +01006342 else if (obj == Py_None)
6343 {
6344 tv->v_type = VAR_SPECIAL;
6345 tv->vval.v_number = VVAL_NONE;
6346 }
Bram Moolenaardb913952012-06-29 12:54:53 +02006347 else
6348 {
Bram Moolenaarc476e522013-06-23 13:46:40 +02006349 PyErr_FORMAT(PyExc_TypeError,
Bram Moolenaar86181df2020-05-11 23:14:04 +02006350 N_("unable to convert %s to a Vim structure"),
Bram Moolenaarc476e522013-06-23 13:46:40 +02006351 Py_TYPE_NAME(obj));
Bram Moolenaardb913952012-06-29 12:54:53 +02006352 return -1;
6353 }
6354 return 0;
6355}
6356
6357 static PyObject *
6358ConvertToPyObject(typval_T *tv)
6359{
Bram Moolenaar8110a092016-04-14 15:56:09 +02006360 typval_T *argv;
6361 int i;
Bram Moolenaardb913952012-06-29 12:54:53 +02006362 if (tv == NULL)
6363 {
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02006364 PyErr_SET_VIM(N_("internal error: NULL reference passed"));
Bram Moolenaardb913952012-06-29 12:54:53 +02006365 return NULL;
6366 }
6367 switch (tv->v_type)
6368 {
6369 case VAR_STRING:
Bram Moolenaard1f13fd2012-10-05 21:30:07 +02006370 return PyBytes_FromString(tv->vval.v_string == NULL
6371 ? "" : (char *)tv->vval.v_string);
Bram Moolenaardb913952012-06-29 12:54:53 +02006372 case VAR_NUMBER:
6373 return PyLong_FromLong((long) tv->vval.v_number);
Bram Moolenaardb913952012-06-29 12:54:53 +02006374 case VAR_FLOAT:
Bram Moolenaara5d59532020-01-26 21:42:03 +01006375#ifdef FEAT_FLOAT
Bram Moolenaardb913952012-06-29 12:54:53 +02006376 return PyFloat_FromDouble((double) tv->vval.v_float);
6377#endif
6378 case VAR_LIST:
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02006379 return NEW_LIST(tv->vval.v_list);
Bram Moolenaardb913952012-06-29 12:54:53 +02006380 case VAR_DICT:
Bram Moolenaara9922d62013-05-30 13:01:18 +02006381 return NEW_DICTIONARY(tv->vval.v_dict);
Bram Moolenaardb913952012-06-29 12:54:53 +02006382 case VAR_FUNC:
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02006383 return NEW_FUNCTION(tv->vval.v_string == NULL
Bram Moolenaar8110a092016-04-14 15:56:09 +02006384 ? (char_u *)"" : tv->vval.v_string,
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02006385 0, NULL, NULL, TRUE);
Bram Moolenaar4c908612016-03-24 21:58:12 +01006386 case VAR_PARTIAL:
Bram Moolenaar8110a092016-04-14 15:56:09 +02006387 if (tv->vval.v_partial->pt_argc)
6388 {
6389 argv = PyMem_New(typval_T, (size_t)tv->vval.v_partial->pt_argc);
6390 for (i = 0; i < tv->vval.v_partial->pt_argc; i++)
6391 copy_tv(&tv->vval.v_partial->pt_argv[i], &argv[i]);
6392 }
6393 else
6394 argv = NULL;
6395 if (tv->vval.v_partial->pt_dict != NULL)
6396 tv->vval.v_partial->pt_dict->dv_refcount++;
Bram Moolenaar4c908612016-03-24 21:58:12 +01006397 return NEW_FUNCTION(tv->vval.v_partial == NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006398 ? (char_u *)"" : partial_name(tv->vval.v_partial),
Bram Moolenaar8110a092016-04-14 15:56:09 +02006399 tv->vval.v_partial->pt_argc, argv,
Bram Moolenaar2177f9f2016-05-25 20:39:09 +02006400 tv->vval.v_partial->pt_dict,
6401 tv->vval.v_partial->pt_auto);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01006402 case VAR_BLOB:
6403 return PyBytes_FromStringAndSize(
6404 (char*) tv->vval.v_blob->bv_ga.ga_data,
6405 (Py_ssize_t) tv->vval.v_blob->bv_ga.ga_len);
Bram Moolenaardb913952012-06-29 12:54:53 +02006406 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02006407 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006408 case VAR_VOID:
Bram Moolenaar4c908612016-03-24 21:58:12 +01006409 case VAR_CHANNEL:
6410 case VAR_JOB:
Bram Moolenaardb913952012-06-29 12:54:53 +02006411 Py_INCREF(Py_None);
6412 return Py_None;
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01006413 case VAR_BOOL:
Bram Moolenaar4c908612016-03-24 21:58:12 +01006414 case VAR_SPECIAL:
6415 switch (tv->vval.v_number)
6416 {
6417 case VVAL_FALSE: return AlwaysFalse(NULL);
6418 case VVAL_TRUE: return AlwaysTrue(NULL);
6419 case VVAL_NONE:
6420 case VVAL_NULL: return AlwaysNone(NULL);
6421 }
Bram Moolenaar6f1404f2013-06-23 16:04:08 +02006422 PyErr_SET_VIM(N_("internal error: invalid value type"));
Bram Moolenaardb913952012-06-29 12:54:53 +02006423 return NULL;
6424 }
Bram Moolenaar4c908612016-03-24 21:58:12 +01006425 return NULL;
Bram Moolenaardb913952012-06-29 12:54:53 +02006426}
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006427
6428typedef struct
6429{
6430 PyObject_HEAD
6431} CurrentObject;
6432static PyTypeObject CurrentType;
6433
6434 static void
6435init_structs(void)
6436{
Bram Moolenaara80faa82020-04-12 19:37:17 +02006437 CLEAR_FIELD(OutputType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006438 OutputType.tp_name = "vim.message";
6439 OutputType.tp_basicsize = sizeof(OutputObject);
6440 OutputType.tp_flags = Py_TPFLAGS_DEFAULT;
6441 OutputType.tp_doc = "vim message object";
6442 OutputType.tp_methods = OutputMethods;
6443#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006444 OutputType.tp_getattro = (getattrofunc)OutputGetattro;
6445 OutputType.tp_setattro = (setattrofunc)OutputSetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006446 OutputType.tp_alloc = call_PyType_GenericAlloc;
6447 OutputType.tp_new = call_PyType_GenericNew;
6448 OutputType.tp_free = call_PyObject_Free;
Bram Moolenaard4a8c982018-05-15 22:31:18 +02006449 OutputType.tp_base = &PyStdPrinter_Type;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006450#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006451 OutputType.tp_getattr = (getattrfunc)OutputGetattr;
6452 OutputType.tp_setattr = (setattrfunc)OutputSetattr;
Bram Moolenaard4a8c982018-05-15 22:31:18 +02006453 // Disabled, because this causes a crash in test86
6454 // OutputType.tp_base = &PyFile_Type;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006455#endif
6456
Bram Moolenaara80faa82020-04-12 19:37:17 +02006457 CLEAR_FIELD(IterType);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02006458 IterType.tp_name = "vim.iter";
6459 IterType.tp_basicsize = sizeof(IterObject);
Bram Moolenaar07b88642013-05-29 22:58:32 +02006460 IterType.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_HAVE_GC;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02006461 IterType.tp_doc = "generic iterator object";
Bram Moolenaard6e39182013-05-21 18:30:34 +02006462 IterType.tp_iter = (getiterfunc)IterIter;
6463 IterType.tp_iternext = (iternextfunc)IterNext;
6464 IterType.tp_dealloc = (destructor)IterDestructor;
6465 IterType.tp_traverse = (traverseproc)IterTraverse;
6466 IterType.tp_clear = (inquiry)IterClear;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02006467
Bram Moolenaara80faa82020-04-12 19:37:17 +02006468 CLEAR_FIELD(BufferType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006469 BufferType.tp_name = "vim.buffer";
6470 BufferType.tp_basicsize = sizeof(BufferType);
Bram Moolenaard6e39182013-05-21 18:30:34 +02006471 BufferType.tp_dealloc = (destructor)BufferDestructor;
6472 BufferType.tp_repr = (reprfunc)BufferRepr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006473 BufferType.tp_as_sequence = &BufferAsSeq;
6474 BufferType.tp_as_mapping = &BufferAsMapping;
6475 BufferType.tp_flags = Py_TPFLAGS_DEFAULT;
6476 BufferType.tp_doc = "vim buffer object";
6477 BufferType.tp_methods = BufferMethods;
6478#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006479 BufferType.tp_getattro = (getattrofunc)BufferGetattro;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02006480 BufferType.tp_setattro = (setattrofunc)BufferSetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006481 BufferType.tp_alloc = call_PyType_GenericAlloc;
6482 BufferType.tp_new = call_PyType_GenericNew;
6483 BufferType.tp_free = call_PyObject_Free;
6484#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006485 BufferType.tp_getattr = (getattrfunc)BufferGetattr;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02006486 BufferType.tp_setattr = (setattrfunc)BufferSetattr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006487#endif
6488
Bram Moolenaara80faa82020-04-12 19:37:17 +02006489 CLEAR_FIELD(WindowType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006490 WindowType.tp_name = "vim.window";
6491 WindowType.tp_basicsize = sizeof(WindowObject);
Bram Moolenaard6e39182013-05-21 18:30:34 +02006492 WindowType.tp_dealloc = (destructor)WindowDestructor;
6493 WindowType.tp_repr = (reprfunc)WindowRepr;
Bram Moolenaar07b88642013-05-29 22:58:32 +02006494 WindowType.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_HAVE_GC;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006495 WindowType.tp_doc = "vim Window object";
6496 WindowType.tp_methods = WindowMethods;
Bram Moolenaard6e39182013-05-21 18:30:34 +02006497 WindowType.tp_traverse = (traverseproc)WindowTraverse;
6498 WindowType.tp_clear = (inquiry)WindowClear;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006499#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006500 WindowType.tp_getattro = (getattrofunc)WindowGetattro;
6501 WindowType.tp_setattro = (setattrofunc)WindowSetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006502 WindowType.tp_alloc = call_PyType_GenericAlloc;
6503 WindowType.tp_new = call_PyType_GenericNew;
6504 WindowType.tp_free = call_PyObject_Free;
6505#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006506 WindowType.tp_getattr = (getattrfunc)WindowGetattr;
6507 WindowType.tp_setattr = (setattrfunc)WindowSetattr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006508#endif
6509
Bram Moolenaara80faa82020-04-12 19:37:17 +02006510 CLEAR_FIELD(TabPageType);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02006511 TabPageType.tp_name = "vim.tabpage";
6512 TabPageType.tp_basicsize = sizeof(TabPageObject);
Bram Moolenaard6e39182013-05-21 18:30:34 +02006513 TabPageType.tp_dealloc = (destructor)TabPageDestructor;
6514 TabPageType.tp_repr = (reprfunc)TabPageRepr;
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02006515 TabPageType.tp_flags = Py_TPFLAGS_DEFAULT;
6516 TabPageType.tp_doc = "vim tab page object";
6517 TabPageType.tp_methods = TabPageMethods;
6518#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006519 TabPageType.tp_getattro = (getattrofunc)TabPageGetattro;
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02006520 TabPageType.tp_alloc = call_PyType_GenericAlloc;
6521 TabPageType.tp_new = call_PyType_GenericNew;
6522 TabPageType.tp_free = call_PyObject_Free;
6523#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006524 TabPageType.tp_getattr = (getattrfunc)TabPageGetattr;
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02006525#endif
6526
Bram Moolenaara80faa82020-04-12 19:37:17 +02006527 CLEAR_FIELD(BufMapType);
Bram Moolenaardfa38d42013-05-15 13:38:47 +02006528 BufMapType.tp_name = "vim.bufferlist";
6529 BufMapType.tp_basicsize = sizeof(BufMapObject);
6530 BufMapType.tp_as_mapping = &BufMapAsMapping;
6531 BufMapType.tp_flags = Py_TPFLAGS_DEFAULT;
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02006532 BufMapType.tp_iter = BufMapIter;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006533 BufferType.tp_doc = "vim buffer list";
6534
Bram Moolenaara80faa82020-04-12 19:37:17 +02006535 CLEAR_FIELD(WinListType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006536 WinListType.tp_name = "vim.windowlist";
6537 WinListType.tp_basicsize = sizeof(WinListType);
6538 WinListType.tp_as_sequence = &WinListAsSeq;
6539 WinListType.tp_flags = Py_TPFLAGS_DEFAULT;
6540 WinListType.tp_doc = "vim window list";
Bram Moolenaard6e39182013-05-21 18:30:34 +02006541 WinListType.tp_dealloc = (destructor)WinListDestructor;
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02006542
Bram Moolenaara80faa82020-04-12 19:37:17 +02006543 CLEAR_FIELD(TabListType);
Bram Moolenaar5e538ec2013-05-15 15:12:29 +02006544 TabListType.tp_name = "vim.tabpagelist";
6545 TabListType.tp_basicsize = sizeof(TabListType);
6546 TabListType.tp_as_sequence = &TabListAsSeq;
6547 TabListType.tp_flags = Py_TPFLAGS_DEFAULT;
6548 TabListType.tp_doc = "vim tab page list";
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006549
Bram Moolenaara80faa82020-04-12 19:37:17 +02006550 CLEAR_FIELD(RangeType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006551 RangeType.tp_name = "vim.range";
6552 RangeType.tp_basicsize = sizeof(RangeObject);
Bram Moolenaard6e39182013-05-21 18:30:34 +02006553 RangeType.tp_dealloc = (destructor)RangeDestructor;
6554 RangeType.tp_repr = (reprfunc)RangeRepr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006555 RangeType.tp_as_sequence = &RangeAsSeq;
6556 RangeType.tp_as_mapping = &RangeAsMapping;
Bram Moolenaar07b88642013-05-29 22:58:32 +02006557 RangeType.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_HAVE_GC;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006558 RangeType.tp_doc = "vim Range object";
6559 RangeType.tp_methods = RangeMethods;
Bram Moolenaar774267b2013-05-21 20:51:59 +02006560 RangeType.tp_traverse = (traverseproc)RangeTraverse;
6561 RangeType.tp_clear = (inquiry)RangeClear;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006562#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006563 RangeType.tp_getattro = (getattrofunc)RangeGetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006564 RangeType.tp_alloc = call_PyType_GenericAlloc;
6565 RangeType.tp_new = call_PyType_GenericNew;
6566 RangeType.tp_free = call_PyObject_Free;
6567#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006568 RangeType.tp_getattr = (getattrfunc)RangeGetattr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006569#endif
6570
Bram Moolenaara80faa82020-04-12 19:37:17 +02006571 CLEAR_FIELD(CurrentType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006572 CurrentType.tp_name = "vim.currentdata";
6573 CurrentType.tp_basicsize = sizeof(CurrentObject);
6574 CurrentType.tp_flags = Py_TPFLAGS_DEFAULT;
6575 CurrentType.tp_doc = "vim current object";
Bram Moolenaardd8aca62013-05-29 22:36:10 +02006576 CurrentType.tp_methods = CurrentMethods;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006577#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006578 CurrentType.tp_getattro = (getattrofunc)CurrentGetattro;
6579 CurrentType.tp_setattro = (setattrofunc)CurrentSetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006580#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006581 CurrentType.tp_getattr = (getattrfunc)CurrentGetattr;
6582 CurrentType.tp_setattr = (setattrfunc)CurrentSetattr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006583#endif
6584
Bram Moolenaara80faa82020-04-12 19:37:17 +02006585 CLEAR_FIELD(DictionaryType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006586 DictionaryType.tp_name = "vim.dictionary";
6587 DictionaryType.tp_basicsize = sizeof(DictionaryObject);
Bram Moolenaard6e39182013-05-21 18:30:34 +02006588 DictionaryType.tp_dealloc = (destructor)DictionaryDestructor;
Bram Moolenaara9922d62013-05-30 13:01:18 +02006589 DictionaryType.tp_as_sequence = &DictionaryAsSeq;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006590 DictionaryType.tp_as_mapping = &DictionaryAsMapping;
Bram Moolenaara9922d62013-05-30 13:01:18 +02006591 DictionaryType.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE;
Bram Moolenaar86181df2020-05-11 23:14:04 +02006592 DictionaryType.tp_doc = "dictionary pushing modifications to Vim structure";
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006593 DictionaryType.tp_methods = DictionaryMethods;
Bram Moolenaara9922d62013-05-30 13:01:18 +02006594 DictionaryType.tp_iter = (getiterfunc)DictionaryIter;
6595 DictionaryType.tp_new = (newfunc)DictionaryConstructor;
6596 DictionaryType.tp_alloc = (allocfunc)PyType_GenericAlloc;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006597#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006598 DictionaryType.tp_getattro = (getattrofunc)DictionaryGetattro;
6599 DictionaryType.tp_setattro = (setattrofunc)DictionarySetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006600#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006601 DictionaryType.tp_getattr = (getattrfunc)DictionaryGetattr;
6602 DictionaryType.tp_setattr = (setattrfunc)DictionarySetattr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006603#endif
6604
Bram Moolenaara80faa82020-04-12 19:37:17 +02006605 CLEAR_FIELD(ListType);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006606 ListType.tp_name = "vim.list";
Bram Moolenaard6e39182013-05-21 18:30:34 +02006607 ListType.tp_dealloc = (destructor)ListDestructor;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006608 ListType.tp_basicsize = sizeof(ListObject);
6609 ListType.tp_as_sequence = &ListAsSeq;
6610 ListType.tp_as_mapping = &ListAsMapping;
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02006611 ListType.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE;
Bram Moolenaar86181df2020-05-11 23:14:04 +02006612 ListType.tp_doc = "list pushing modifications to Vim structure";
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006613 ListType.tp_methods = ListMethods;
Bram Moolenaard6e39182013-05-21 18:30:34 +02006614 ListType.tp_iter = (getiterfunc)ListIter;
Bram Moolenaar78cddbe2013-05-30 13:05:58 +02006615 ListType.tp_new = (newfunc)ListConstructor;
6616 ListType.tp_alloc = (allocfunc)PyType_GenericAlloc;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006617#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006618 ListType.tp_getattro = (getattrofunc)ListGetattro;
6619 ListType.tp_setattro = (setattrofunc)ListSetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006620#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006621 ListType.tp_getattr = (getattrfunc)ListGetattr;
6622 ListType.tp_setattr = (setattrfunc)ListSetattr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006623#endif
6624
Bram Moolenaara80faa82020-04-12 19:37:17 +02006625 CLEAR_FIELD(FunctionType);
Bram Moolenaarb6c589a2013-05-15 14:39:52 +02006626 FunctionType.tp_name = "vim.function";
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006627 FunctionType.tp_basicsize = sizeof(FunctionObject);
Bram Moolenaard6e39182013-05-21 18:30:34 +02006628 FunctionType.tp_dealloc = (destructor)FunctionDestructor;
6629 FunctionType.tp_call = (ternaryfunc)FunctionCall;
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02006630 FunctionType.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE;
Bram Moolenaar86181df2020-05-11 23:14:04 +02006631 FunctionType.tp_doc = "object that calls Vim function";
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006632 FunctionType.tp_methods = FunctionMethods;
Bram Moolenaara5b725c2013-05-30 12:43:54 +02006633 FunctionType.tp_repr = (reprfunc)FunctionRepr;
Bram Moolenaar355fd9b2013-05-30 13:14:13 +02006634 FunctionType.tp_new = (newfunc)FunctionConstructor;
6635 FunctionType.tp_alloc = (allocfunc)PyType_GenericAlloc;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006636#if PY_MAJOR_VERSION >= 3
Bram Moolenaard6e39182013-05-21 18:30:34 +02006637 FunctionType.tp_getattro = (getattrofunc)FunctionGetattro;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006638#else
Bram Moolenaard6e39182013-05-21 18:30:34 +02006639 FunctionType.tp_getattr = (getattrfunc)FunctionGetattr;
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006640#endif
6641
Bram Moolenaara80faa82020-04-12 19:37:17 +02006642 CLEAR_FIELD(OptionsType);
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02006643 OptionsType.tp_name = "vim.options";
6644 OptionsType.tp_basicsize = sizeof(OptionsObject);
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01006645 OptionsType.tp_as_sequence = &OptionsAsSeq;
Bram Moolenaar07b88642013-05-29 22:58:32 +02006646 OptionsType.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_HAVE_GC;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02006647 OptionsType.tp_doc = "object for manipulating options";
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01006648 OptionsType.tp_iter = (getiterfunc)OptionsIter;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02006649 OptionsType.tp_as_mapping = &OptionsAsMapping;
Bram Moolenaard6e39182013-05-21 18:30:34 +02006650 OptionsType.tp_dealloc = (destructor)OptionsDestructor;
6651 OptionsType.tp_traverse = (traverseproc)OptionsTraverse;
6652 OptionsType.tp_clear = (inquiry)OptionsClear;
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02006653
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006654#if PY_VERSION_HEX < 0x030700f0
Bram Moolenaara80faa82020-04-12 19:37:17 +02006655 CLEAR_FIELD(LoaderType);
Bram Moolenaar81c40c52013-06-12 14:41:04 +02006656 LoaderType.tp_name = "vim.Loader";
6657 LoaderType.tp_basicsize = sizeof(LoaderObject);
6658 LoaderType.tp_flags = Py_TPFLAGS_DEFAULT;
6659 LoaderType.tp_doc = "vim message object";
6660 LoaderType.tp_methods = LoaderMethods;
6661 LoaderType.tp_dealloc = (destructor)LoaderDestructor;
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006662#endif
Bram Moolenaar81c40c52013-06-12 14:41:04 +02006663
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006664#if PY_MAJOR_VERSION >= 3
Bram Moolenaara80faa82020-04-12 19:37:17 +02006665 CLEAR_FIELD(vimmodule);
Bram Moolenaar4d1da492013-04-24 13:39:15 +02006666 vimmodule.m_name = "vim";
6667 vimmodule.m_doc = "Vim Python interface\n";
6668 vimmodule.m_size = -1;
6669 vimmodule.m_methods = VimMethods;
6670#endif
6671}
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006672
6673#define PYTYPE_READY(type) \
6674 if (PyType_Ready(&type)) \
6675 return -1;
6676
6677 static int
Bram Moolenaarfb97f282013-07-09 17:42:46 +02006678init_types(void)
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006679{
6680 PYTYPE_READY(IterType);
6681 PYTYPE_READY(BufferType);
6682 PYTYPE_READY(RangeType);
6683 PYTYPE_READY(WindowType);
6684 PYTYPE_READY(TabPageType);
6685 PYTYPE_READY(BufMapType);
6686 PYTYPE_READY(WinListType);
6687 PYTYPE_READY(TabListType);
6688 PYTYPE_READY(CurrentType);
6689 PYTYPE_READY(DictionaryType);
6690 PYTYPE_READY(ListType);
6691 PYTYPE_READY(FunctionType);
6692 PYTYPE_READY(OptionsType);
6693 PYTYPE_READY(OutputType);
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006694#if PY_VERSION_HEX < 0x030700f0
Bram Moolenaar9f3685a2013-06-12 14:20:36 +02006695 PYTYPE_READY(LoaderType);
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006696#endif
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006697 return 0;
6698}
6699
6700 static int
Bram Moolenaar5ab9d982013-06-16 14:25:57 +02006701init_sys_path(void)
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006702{
6703 PyObject *path;
6704 PyObject *path_hook;
6705 PyObject *path_hooks;
6706
6707 if (!(path_hook = PyObject_GetAttrString(vim_module, "path_hook")))
6708 return -1;
6709
6710 if (!(path_hooks = PySys_GetObject("path_hooks")))
6711 {
6712 PyErr_Clear();
6713 path_hooks = PyList_New(1);
6714 PyList_SET_ITEM(path_hooks, 0, path_hook);
6715 if (PySys_SetObject("path_hooks", path_hooks))
6716 {
6717 Py_DECREF(path_hooks);
6718 return -1;
6719 }
6720 Py_DECREF(path_hooks);
6721 }
6722 else if (PyList_Check(path_hooks))
6723 {
6724 if (PyList_Append(path_hooks, path_hook))
6725 {
6726 Py_DECREF(path_hook);
6727 return -1;
6728 }
6729 Py_DECREF(path_hook);
6730 }
6731 else
6732 {
6733 VimTryStart();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006734 emsg(_("Failed to set path hook: sys.path_hooks is not a list\n"
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006735 "You should now do the following:\n"
6736 "- append vim.path_hook to sys.path_hooks\n"
6737 "- append vim.VIM_SPECIAL_PATH to sys.path\n"));
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01006738 VimTryEnd(); // Discard the error
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006739 Py_DECREF(path_hook);
6740 return 0;
6741 }
6742
6743 if (!(path = PySys_GetObject("path")))
6744 {
6745 PyErr_Clear();
6746 path = PyList_New(1);
6747 Py_INCREF(vim_special_path_object);
6748 PyList_SET_ITEM(path, 0, vim_special_path_object);
6749 if (PySys_SetObject("path", path))
6750 {
6751 Py_DECREF(path);
6752 return -1;
6753 }
6754 Py_DECREF(path);
6755 }
6756 else if (PyList_Check(path))
6757 {
6758 if (PyList_Append(path, vim_special_path_object))
6759 return -1;
6760 }
6761 else
6762 {
6763 VimTryStart();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006764 emsg(_("Failed to set path: sys.path is not a list\n"
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006765 "You should now append vim.VIM_SPECIAL_PATH to sys.path"));
Bram Moolenaar9bf703d2019-11-30 19:44:38 +01006766 VimTryEnd(); // Discard the error
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006767 }
6768
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006769 return 0;
6770}
6771
6772static BufMapObject TheBufferMap =
6773{
6774 PyObject_HEAD_INIT(&BufMapType)
6775};
6776
6777static WinListObject TheWindowList =
6778{
6779 PyObject_HEAD_INIT(&WinListType)
6780 NULL
6781};
6782
6783static CurrentObject TheCurrent =
6784{
6785 PyObject_HEAD_INIT(&CurrentType)
6786};
6787
6788static TabListObject TheTabPageList =
6789{
6790 PyObject_HEAD_INIT(&TabListType)
6791};
6792
6793static struct numeric_constant {
6794 char *name;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006795 int val;
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006796} numeric_constants[] = {
6797 {"VAR_LOCKED", VAR_LOCKED},
6798 {"VAR_FIXED", VAR_FIXED},
6799 {"VAR_SCOPE", VAR_SCOPE},
6800 {"VAR_DEF_SCOPE", VAR_DEF_SCOPE},
6801};
6802
6803static struct object_constant {
6804 char *name;
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006805 PyObject *valObject;
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006806} object_constants[] = {
6807 {"buffers", (PyObject *)(void *)&TheBufferMap},
6808 {"windows", (PyObject *)(void *)&TheWindowList},
6809 {"tabpages", (PyObject *)(void *)&TheTabPageList},
6810 {"current", (PyObject *)(void *)&TheCurrent},
Bram Moolenaarcac867a2013-05-21 19:50:34 +02006811
6812 {"Buffer", (PyObject *)&BufferType},
6813 {"Range", (PyObject *)&RangeType},
6814 {"Window", (PyObject *)&WindowType},
6815 {"TabPage", (PyObject *)&TabPageType},
6816 {"Dictionary", (PyObject *)&DictionaryType},
6817 {"List", (PyObject *)&ListType},
6818 {"Function", (PyObject *)&FunctionType},
6819 {"Options", (PyObject *)&OptionsType},
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006820#if PY_VERSION_HEX < 0x030700f0
Bram Moolenaar81c40c52013-06-12 14:41:04 +02006821 {"_Loader", (PyObject *)&LoaderType},
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006822#endif
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006823};
6824
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006825#define ADD_OBJECT(m, name, obj) \
Bram Moolenaardee2e312013-06-23 16:35:47 +02006826 if (PyModule_AddObject(m, name, obj)) \
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006827 return -1;
6828
6829#define ADD_CHECKED_OBJECT(m, name, obj) \
6830 { \
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006831 PyObject *valObject = obj; \
6832 if (!valObject) \
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006833 return -1; \
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006834 ADD_OBJECT(m, name, valObject); \
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006835 }
6836
6837 static int
Bram Moolenaardee2e312013-06-23 16:35:47 +02006838populate_module(PyObject *m)
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006839{
Bram Moolenaarc1ba10c2013-06-10 20:39:03 +02006840 int i;
6841 PyObject *other_module;
Bram Moolenaarf9c9b322013-06-10 20:47:36 +02006842 PyObject *attr;
Bram Moolenaar81c40c52013-06-12 14:41:04 +02006843 PyObject *imp;
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006844#if PY_VERSION_HEX >= 0x030700f0
6845 PyObject *dict;
6846 PyObject *cls;
6847#endif
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006848
6849 for (i = 0; i < (int)(sizeof(numeric_constants)
6850 / sizeof(struct numeric_constant));
6851 ++i)
6852 ADD_CHECKED_OBJECT(m, numeric_constants[i].name,
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006853 PyInt_FromLong(numeric_constants[i].val));
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006854
6855 for (i = 0; i < (int)(sizeof(object_constants)
6856 / sizeof(struct object_constant));
6857 ++i)
6858 {
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006859 PyObject *valObject;
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006860
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02006861 valObject = object_constants[i].valObject;
6862 Py_INCREF(valObject);
6863 ADD_OBJECT(m, object_constants[i].name, valObject);
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006864 }
6865
6866 if (!(VimError = PyErr_NewException("vim.error", NULL, NULL)))
6867 return -1;
6868 ADD_OBJECT(m, "error", VimError);
6869
Bram Moolenaarda6c0332019-09-01 16:01:30 +02006870 ADD_CHECKED_OBJECT(m, "vars", NEW_DICTIONARY(get_globvar_dict()));
6871 ADD_CHECKED_OBJECT(m, "vvars", NEW_DICTIONARY(get_vimvar_dict()));
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006872 ADD_CHECKED_OBJECT(m, "options",
6873 OptionsNew(SREQ_GLOBAL, NULL, dummy_check, NULL));
Bram Moolenaarf4258302013-06-02 18:20:17 +02006874
Bram Moolenaarc1ba10c2013-06-10 20:39:03 +02006875 if (!(other_module = PyImport_ImportModule("os")))
Bram Moolenaarf4258302013-06-02 18:20:17 +02006876 return -1;
Bram Moolenaarc1ba10c2013-06-10 20:39:03 +02006877 ADD_OBJECT(m, "os", other_module);
Bram Moolenaarf4258302013-06-02 18:20:17 +02006878
Bram Moolenaar22081f42016-06-01 20:38:34 +02006879#if PY_MAJOR_VERSION >= 3
Bram Moolenaarc1ba10c2013-06-10 20:39:03 +02006880 if (!(py_getcwd = PyObject_GetAttrString(other_module, "getcwd")))
Bram Moolenaarf4258302013-06-02 18:20:17 +02006881 return -1;
Bram Moolenaar22081f42016-06-01 20:38:34 +02006882#else
6883 if (!(py_getcwd = PyObject_GetAttrString(other_module, "getcwdu")))
6884 return -1;
6885#endif
Bram Moolenaarf4258302013-06-02 18:20:17 +02006886 ADD_OBJECT(m, "_getcwd", py_getcwd)
6887
Bram Moolenaarc1ba10c2013-06-10 20:39:03 +02006888 if (!(py_chdir = PyObject_GetAttrString(other_module, "chdir")))
Bram Moolenaarf4258302013-06-02 18:20:17 +02006889 return -1;
6890 ADD_OBJECT(m, "_chdir", py_chdir);
Bram Moolenaardee2e312013-06-23 16:35:47 +02006891 if (!(attr = PyObject_GetAttrString(m, "chdir")))
Bram Moolenaarf4258302013-06-02 18:20:17 +02006892 return -1;
Bram Moolenaarf9c9b322013-06-10 20:47:36 +02006893 if (PyObject_SetAttrString(other_module, "chdir", attr))
6894 {
6895 Py_DECREF(attr);
6896 return -1;
6897 }
6898 Py_DECREF(attr);
Bram Moolenaarf4258302013-06-02 18:20:17 +02006899
Bram Moolenaarc1ba10c2013-06-10 20:39:03 +02006900 if ((py_fchdir = PyObject_GetAttrString(other_module, "fchdir")))
Bram Moolenaarf4258302013-06-02 18:20:17 +02006901 {
6902 ADD_OBJECT(m, "_fchdir", py_fchdir);
Bram Moolenaardee2e312013-06-23 16:35:47 +02006903 if (!(attr = PyObject_GetAttrString(m, "fchdir")))
Bram Moolenaarf4258302013-06-02 18:20:17 +02006904 return -1;
Bram Moolenaarf9c9b322013-06-10 20:47:36 +02006905 if (PyObject_SetAttrString(other_module, "fchdir", attr))
6906 {
6907 Py_DECREF(attr);
6908 return -1;
6909 }
6910 Py_DECREF(attr);
Bram Moolenaarf4258302013-06-02 18:20:17 +02006911 }
Bram Moolenaare9056b12013-06-03 20:04:48 +02006912 else
6913 PyErr_Clear();
Bram Moolenaarf4258302013-06-02 18:20:17 +02006914
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006915 if (!(vim_special_path_object = PyString_FromString(vim_special_path)))
6916 return -1;
6917
6918 ADD_OBJECT(m, "VIM_SPECIAL_PATH", vim_special_path_object);
6919
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006920#if PY_VERSION_HEX >= 0x030700f0
6921 if (!(imp = PyImport_ImportModule("importlib.machinery")))
6922 return -1;
6923
6924 dict = PyModule_GetDict(imp);
6925
6926 if (!(cls = PyDict_GetItemString(dict, "PathFinder")))
6927 {
6928 Py_DECREF(imp);
6929 return -1;
6930 }
6931
6932 if (!(py_find_spec = PyObject_GetAttrString(cls, "find_spec")))
6933 {
6934 Py_DECREF(imp);
6935 return -1;
6936 }
6937
Bram Moolenaarb999ba22019-02-14 13:28:45 +01006938 if ((py_find_module = PyObject_GetAttrString(cls, "find_module")))
6939 {
6940 // find_module() is deprecated, this may stop working in some later
6941 // version.
6942 ADD_OBJECT(m, "_find_module", py_find_module);
6943 }
6944
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006945 Py_DECREF(imp);
6946
6947 ADD_OBJECT(m, "_find_spec", py_find_spec);
6948#else
Bram Moolenaar81c40c52013-06-12 14:41:04 +02006949 if (!(imp = PyImport_ImportModule("imp")))
6950 return -1;
6951
6952 if (!(py_find_module = PyObject_GetAttrString(imp, "find_module")))
6953 {
6954 Py_DECREF(imp);
6955 return -1;
6956 }
6957
6958 if (!(py_load_module = PyObject_GetAttrString(imp, "load_module")))
6959 {
6960 Py_DECREF(py_find_module);
6961 Py_DECREF(imp);
6962 return -1;
6963 }
6964
6965 Py_DECREF(imp);
6966
Bram Moolenaar9f3685a2013-06-12 14:20:36 +02006967 ADD_OBJECT(m, "_find_module", py_find_module);
6968 ADD_OBJECT(m, "_load_module", py_load_module);
Bram Moolenaar79a494d2018-07-22 04:30:21 +02006969#endif
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02006970
Bram Moolenaar1dc28782013-05-21 19:11:01 +02006971 return 0;
6972}