blob: b5e11ca7fbe50bafdaefd05f9bfcc66a7b31f1ac [file] [log] [blame]
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * vim9class.c: Vim9 script class support
12 */
13
14#define USING_FLOAT_STUFF
15#include "vim.h"
16
17#if defined(FEAT_EVAL) || defined(PROTO)
18
19// When not generating protos this is included in proto.h
20#ifdef PROTO
21# include "vim9.h"
22#endif
23
Yegappan Lakshmanane651e112023-09-04 07:51:01 +020024static class_T *first_class = NULL;
25static class_T *next_nonref_class = NULL;
26
27/*
28 * Call this function when a class has been created. It will be added to the
29 * list headed by "first_class".
30 */
31 static void
32class_created(class_T *cl)
33{
34 if (first_class != NULL)
35 {
36 cl->class_next_used = first_class;
37 first_class->class_prev_used = cl;
38 }
39 first_class = cl;
40}
41
42/*
43 * Call this function when a class has been cleared and is about to be freed.
44 * It is removed from the list headed by "first_class".
45 */
46 static void
47class_cleared(class_T *cl)
48{
49 if (cl->class_next_used != NULL)
50 cl->class_next_used->class_prev_used = cl->class_prev_used;
51 if (cl->class_prev_used != NULL)
52 cl->class_prev_used->class_next_used = cl->class_next_used;
53 else if (first_class == cl)
54 first_class = cl->class_next_used;
55
56 // update the next class to check if needed
57 if (cl == next_nonref_class)
58 next_nonref_class = cl->class_next_used;
59}
60
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000061/*
Bram Moolenaard505d172022-12-18 21:42:55 +000062 * Parse a member declaration, both object and class member.
63 * Returns OK or FAIL. When OK then "varname_end" is set to just after the
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +020064 * variable name and "type_ret" is set to the declared or detected type.
Bram Moolenaard505d172022-12-18 21:42:55 +000065 * "init_expr" is set to the initialisation expression (allocated), if there is
Bram Moolenaar554d0312023-01-05 19:59:18 +000066 * one. For an interface "init_expr" is NULL.
Bram Moolenaard505d172022-12-18 21:42:55 +000067 */
68 static int
69parse_member(
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +020070 exarg_T *eap,
71 char_u *line,
72 char_u *varname,
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +020073 int has_public, // TRUE if "public" seen before "varname"
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +020074 char_u **varname_end,
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +020075 garray_T *type_list,
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +020076 type_T **type_ret,
77 char_u **init_expr)
Bram Moolenaard505d172022-12-18 21:42:55 +000078{
79 *varname_end = to_name_end(varname, FALSE);
80 if (*varname == '_' && has_public)
81 {
RestorerZ7fe8f432023-09-24 23:21:24 +020082 semsg(_(e_public_variable_name_cannot_start_with_underscore_str), line);
Bram Moolenaard505d172022-12-18 21:42:55 +000083 return FAIL;
84 }
85
86 char_u *colon = skipwhite(*varname_end);
87 char_u *type_arg = colon;
88 type_T *type = NULL;
89 if (*colon == ':')
90 {
91 if (VIM_ISWHITE(**varname_end))
92 {
93 semsg(_(e_no_white_space_allowed_before_colon_str), varname);
94 return FAIL;
95 }
96 if (!VIM_ISWHITE(colon[1]))
97 {
98 semsg(_(e_white_space_required_after_str_str), ":", varname);
99 return FAIL;
100 }
101 type_arg = skipwhite(colon + 1);
102 type = parse_type(&type_arg, type_list, TRUE);
103 if (type == NULL)
104 return FAIL;
105 }
106
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200107 char_u *init_arg = skipwhite(type_arg);
108 if (type == NULL && *init_arg != '=')
Bram Moolenaard505d172022-12-18 21:42:55 +0000109 {
110 emsg(_(e_type_or_initialization_required));
111 return FAIL;
112 }
113
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200114 if (init_expr == NULL && *init_arg == '=')
Bram Moolenaard505d172022-12-18 21:42:55 +0000115 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200116 emsg(_(e_cannot_initialize_variable_in_interface));
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200117 return FAIL;
118 }
119
120 if (*init_arg == '=')
121 {
122 evalarg_T evalarg;
123 char_u *expr_start, *expr_end;
124
125 if (!VIM_ISWHITE(init_arg[-1]) || !VIM_ISWHITE(init_arg[1]))
Bram Moolenaard505d172022-12-18 21:42:55 +0000126 {
127 semsg(_(e_white_space_required_before_and_after_str_at_str),
128 "=", type_arg);
129 return FAIL;
130 }
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200131 init_arg = skipwhite(init_arg + 1);
Bram Moolenaard505d172022-12-18 21:42:55 +0000132
Bram Moolenaard505d172022-12-18 21:42:55 +0000133 fill_evalarg_from_eap(&evalarg, eap, FALSE);
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200134 (void)skip_expr_concatenate(&init_arg, &expr_start, &expr_end, &evalarg);
Bram Moolenaard505d172022-12-18 21:42:55 +0000135
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +0200136 // No type specified for the member. Set it to "any" and the correct
137 // type will be set when the object is instantiated.
Bram Moolenaard505d172022-12-18 21:42:55 +0000138 if (type == NULL)
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200139 type = &t_any;
Bram Moolenaard505d172022-12-18 21:42:55 +0000140
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200141 *init_expr = vim_strnsave(expr_start, expr_end - expr_start);
142 // Free the memory pointed by expr_start.
Bram Moolenaard505d172022-12-18 21:42:55 +0000143 clear_evalarg(&evalarg, NULL);
144 }
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200145 else if (!valid_declaration_type(type))
Bram Moolenaard505d172022-12-18 21:42:55 +0000146 return FAIL;
147
148 *type_ret = type;
Bram Moolenaard505d172022-12-18 21:42:55 +0000149 return OK;
150}
151
152/*
153 * Add a member to an object or a class.
154 * Returns OK when successful, "init_expr" will be consumed then.
155 * Returns FAIL otherwise, caller might need to free "init_expr".
156 */
157 static int
158add_member(
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +0200159 garray_T *gap,
160 char_u *varname,
161 char_u *varname_end,
162 int has_public,
163 type_T *type,
164 char_u *init_expr)
Bram Moolenaard505d172022-12-18 21:42:55 +0000165{
166 if (ga_grow(gap, 1) == FAIL)
167 return FAIL;
168 ocmember_T *m = ((ocmember_T *)gap->ga_data) + gap->ga_len;
169 m->ocm_name = vim_strnsave(varname, varname_end - varname);
=?UTF-8?q?Ola=20S=C3=B6der?=d8742472023-03-05 13:12:32 +0000170 m->ocm_access = has_public ? VIM_ACCESS_ALL
171 : *varname == '_' ? VIM_ACCESS_PRIVATE : VIM_ACCESS_READ;
Bram Moolenaard505d172022-12-18 21:42:55 +0000172 m->ocm_type = type;
173 if (init_expr != NULL)
174 m->ocm_init = init_expr;
175 ++gap->ga_len;
176 return OK;
177}
178
179/*
180 * Move the class or object members found while parsing a class into the class.
181 * "gap" contains the found members.
Bram Moolenaar83677162023-01-08 19:54:10 +0000182 * "parent_members" points to the members in the parent class (if any)
183 * "parent_count" is the number of members in the parent class
Bram Moolenaard505d172022-12-18 21:42:55 +0000184 * "members" will be set to the newly allocated array of members and
185 * "member_count" set to the number of members.
186 * Returns OK or FAIL.
187 */
188 static int
189add_members_to_class(
190 garray_T *gap,
Bram Moolenaar83677162023-01-08 19:54:10 +0000191 ocmember_T *parent_members,
192 int parent_count,
Bram Moolenaard505d172022-12-18 21:42:55 +0000193 ocmember_T **members,
194 int *member_count)
195{
Bram Moolenaar83677162023-01-08 19:54:10 +0000196 *member_count = parent_count + gap->ga_len;
197 *members = *member_count == 0 ? NULL
198 : ALLOC_MULT(ocmember_T, *member_count);
199 if (*member_count > 0 && *members == NULL)
Bram Moolenaard505d172022-12-18 21:42:55 +0000200 return FAIL;
Bram Moolenaar83677162023-01-08 19:54:10 +0000201 for (int i = 0; i < parent_count; ++i)
202 {
203 // parent members need to be copied
Bram Moolenaarae3205a2023-01-15 20:49:00 +0000204 ocmember_T *m = *members + i;
205 *m = parent_members[i];
206 m->ocm_name = vim_strsave(m->ocm_name);
207 if (m->ocm_init != NULL)
208 m->ocm_init = vim_strsave(m->ocm_init);
Bram Moolenaar83677162023-01-08 19:54:10 +0000209 }
Bram Moolenaar8efdcee2022-12-19 12:18:09 +0000210 if (gap->ga_len > 0)
Bram Moolenaar83677162023-01-08 19:54:10 +0000211 // new members are moved
212 mch_memmove(*members + parent_count,
213 gap->ga_data, sizeof(ocmember_T) * gap->ga_len);
Bram Moolenaard505d172022-12-18 21:42:55 +0000214 VIM_CLEAR(gap->ga_data);
215 return OK;
216}
217
218/*
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000219 * Convert a member index "idx" of interface "itf" to the member index of class
220 * "cl" implementing that interface.
221 */
222 int
Ernie Rael18143d32023-09-04 22:30:41 +0200223object_index_from_itf_index(class_T *itf, int is_method, int idx, class_T *cl,
224 int is_static)
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000225{
Ernie Rael18143d32023-09-04 22:30:41 +0200226 if (idx >= (is_method ? itf->class_obj_method_count
227 : is_static ? itf->class_class_member_count
Bram Moolenaard0200c82023-01-28 15:19:40 +0000228 : itf->class_obj_member_count))
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000229 {
230 siemsg("index %d out of range for interface %s", idx, itf->class_name);
231 return 0;
232 }
Yegappan Lakshmanan74cc13c2023-08-13 17:41:26 +0200233
234 // If "cl" is the interface or the class that is extended, then the method
235 // index can be used directly and there is no need to search for the method
236 // index in one of the child classes.
237 if (cl == itf)
238 return idx;
239
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200240 itf2class_T *i2c = NULL;
241 int searching = TRUE;
242 int method_offset = 0;
243
Ernie Raelcf138d42023-09-06 20:45:03 +0200244 for (class_T *super = cl; super != NULL && searching;
245 super = super->class_extends)
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200246 {
Ernie Raelcf138d42023-09-06 20:45:03 +0200247 for (i2c = itf->class_itf2class; i2c != NULL; i2c = i2c->i2c_next)
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200248 {
Ernie Raelcf138d42023-09-06 20:45:03 +0200249 if (i2c->i2c_class == super && i2c->i2c_is_method == is_method)
250 {
251 searching = FALSE;
252 break;
253 }
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200254 }
255 if (searching && is_method)
256 // The parent class methods are stored after the current class
257 // methods.
258 method_offset += is_static
259 ? super->class_class_function_count_child
260 : super->class_obj_method_count_child;
261 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000262 if (i2c == NULL)
263 {
264 siemsg("class %s not found on interface %s",
265 cl->class_name, itf->class_name);
266 return 0;
267 }
Ernie Rael18143d32023-09-04 22:30:41 +0200268 if (is_static)
269 {
270 // TODO: Need a table for fast lookup?
271 char_u *name = itf->class_class_members[idx].ocm_name;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200272 int m_idx = class_member_idx(i2c->i2c_class, name, 0);
273 if (m_idx >= 0)
274 return m_idx;
275
Ernie Rael18143d32023-09-04 22:30:41 +0200276 siemsg("class %s, interface %s, static %s not found",
277 cl->class_name, itf->class_name, name);
278 return 0;
279 }
280 else
281 {
282 // A table follows the i2c for the class
283 int *table = (int *)(i2c + 1);
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200284 // "method_offset" is 0, if method is in the current class. If method
285 // is in a parent class, then it is non-zero.
286 return table[idx] + method_offset;
Ernie Rael18143d32023-09-04 22:30:41 +0200287 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000288}
289
290/*
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200291 * Check whether a class named "extends_name" is present. If the class is
292 * valid, then "extends_clp" is set with the class pointer.
293 * Returns TRUE if the class name "extends_names" is a valid class.
294 */
295 static int
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200296validate_extends_class(
297 char_u *extends_name,
298 class_T **extends_clp,
299 int is_class)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200300{
301 typval_T tv;
302 int success = FALSE;
303
304 tv.v_type = VAR_UNKNOWN;
305 if (eval_variable_import(extends_name, &tv) == FAIL)
306 {
307 semsg(_(e_class_name_not_found_str), extends_name);
308 return success;
309 }
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200310
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200311 if (tv.v_type != VAR_CLASS || tv.vval.v_class == NULL
312 || (is_class
313 && (tv.vval.v_class->class_flags & CLASS_INTERFACE) != 0)
314 || (!is_class
315 && (tv.vval.v_class->class_flags & CLASS_INTERFACE) == 0))
316 // a interface cannot extend a class and a class cannot extend an
317 // interface.
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200318 semsg(_(e_cannot_extend_str), extends_name);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200319 else
320 {
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200321 class_T *extends_cl = tv.vval.v_class;
322 ++extends_cl->class_refcount;
323 *extends_clp = extends_cl;
324 success = TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200325 }
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200326 clear_tv(&tv);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200327
328 return success;
329}
330
331/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200332 * Check method names in the parent class lineage to make sure the access is
333 * the same for overridden methods.
334 */
335 static int
336validate_extends_methods(
337 garray_T *objmethods_gap,
338 class_T *extends_cl)
339{
340 class_T *super = extends_cl;
341 int method_count = objmethods_gap->ga_len;
342 ufunc_T **cl_fp = (ufunc_T **)(objmethods_gap->ga_data);
343
344 while (super != NULL)
345 {
346 int extends_method_count = super->class_obj_method_count_child;
347 if (extends_method_count == 0)
348 {
349 super = super->class_extends;
350 continue;
351 }
352
353 ufunc_T **extends_methods = super->class_obj_methods;
354
355 for (int i = 0; i < extends_method_count; i++)
356 {
357 char_u *pstr = extends_methods[i]->uf_name;
358 int extends_private = (*pstr == '_');
359 if (extends_private)
360 pstr++;
361
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200362 // When comparing the method names, ignore the access type (public
363 // and private methods are considered the same).
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200364 for (int j = 0; j < method_count; j++)
365 {
366 char_u *qstr = cl_fp[j]->uf_name;
367 int priv_method = (*qstr == '_');
368 if (priv_method)
369 qstr++;
370 if (STRCMP(pstr, qstr) == 0 && priv_method != extends_private)
371 {
372 // Method access is different between the super class and
373 // the subclass
374 semsg(_(e_method_str_of_class_str_has_different_access),
375 cl_fp[j]->uf_name, super->class_name);
376 return FALSE;
377 }
378 }
379 }
380 super = super->class_extends;
381 }
382
383 return TRUE;
384}
385
386/*
387 * Check whether a object member variable in "objmembers_gap" is a duplicate of
388 * a member in any of the extended parent class lineage. Returns TRUE if there
389 * are no duplicates.
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200390 */
391 static int
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200392extends_check_dup_members(
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200393 garray_T *objmembers_gap,
394 class_T *extends_cl)
395{
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200396 int member_count = objmembers_gap->ga_len;
397 if (member_count == 0)
398 return TRUE;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200399
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200400 ocmember_T *members = (ocmember_T *)(objmembers_gap->ga_data);
401
402 // Validate each member variable
403 for (int c_i = 0; c_i < member_count; c_i++)
404 {
405 class_T *p_cl = extends_cl;
406 ocmember_T *c_m = members + c_i;
407 char_u *pstr = (*c_m->ocm_name == '_')
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200408 ? c_m->ocm_name + 1 : c_m->ocm_name;
409
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200410 // Check in all the parent classes in the lineage
411 while (p_cl != NULL)
412 {
413 int p_member_count = p_cl->class_obj_member_count;
414 if (p_member_count == 0)
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200415 {
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200416 p_cl = p_cl->class_extends;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200417 continue;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200418 }
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200419 ocmember_T *p_members = p_cl->class_obj_members;
420
421 // Compare against all the members in the parent class
422 for (int p_i = 0; p_i < p_member_count; p_i++)
423 {
424 ocmember_T *p_m = p_members + p_i;
425 char_u *qstr = (*p_m->ocm_name == '_')
426 ? p_m->ocm_name + 1 : p_m->ocm_name;
427 if (STRCMP(pstr, qstr) == 0)
428 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200429 semsg(_(e_duplicate_variable_str), c_m->ocm_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200430 return FALSE;
431 }
432 }
433
434 p_cl = p_cl->class_extends;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200435 }
436 }
437
438 return TRUE;
439}
440
441/*
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200442 * Compare the variable type of interface variables in "objmembers_gap" against
443 * the variable in any of the extended super interface lineage. Used to
444 * compare the variable types when extending interfaces. Returns TRUE if the
445 * variable types are the same.
446 */
447 static int
448extends_check_intf_var_type(
449 garray_T *objmembers_gap,
450 class_T *extends_cl)
451{
452 int member_count = objmembers_gap->ga_len;
453 if (member_count == 0)
454 return TRUE;
455
456 ocmember_T *members = (ocmember_T *)(objmembers_gap->ga_data);
457
458 // Validate each member variable
459 for (int c_i = 0; c_i < member_count; c_i++)
460 {
461 class_T *p_cl = extends_cl;
462 ocmember_T *c_m = members + c_i;
463 int var_found = FALSE;
464
465 // Check in all the parent classes in the lineage
466 while (p_cl != NULL && !var_found)
467 {
468 int p_member_count = p_cl->class_obj_member_count;
469 if (p_member_count == 0)
470 {
471 p_cl = p_cl->class_extends;
472 continue;
473 }
474 ocmember_T *p_members = p_cl->class_obj_members;
475
476 // Compare against all the members in the parent class
477 for (int p_i = 0; p_i < p_member_count; p_i++)
478 {
479 where_T where = WHERE_INIT;
480 ocmember_T *p_m = p_members + p_i;
481
482 if (STRCMP(p_m->ocm_name, c_m->ocm_name) != 0)
483 continue;
484
485 // Ensure the type is matching.
486 where.wt_func_name = (char *)c_m->ocm_name;
487 where.wt_kind = WT_MEMBER;
488
489 if (check_type(p_m->ocm_type, c_m->ocm_type, TRUE,
490 where) == FAIL)
491 return FALSE;
492
493 var_found = TRUE;
494 }
495
496 p_cl = p_cl->class_extends;
497 }
498 }
499
500 return TRUE;
501}
502
503/*
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200504 * When extending an abstract class, check whether all the abstract methods in
505 * the parent class are implemented. Returns TRUE if all the methods are
506 * implemented.
507 */
508 static int
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200509validate_abstract_class_methods(
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200510 garray_T *classmethods_gap,
511 garray_T *objmethods_gap,
512 class_T *extends_cl)
513{
514 for (int loop = 1; loop <= 2; ++loop)
515 {
516 // loop == 1: check class methods
517 // loop == 2: check object methods
518 int extends_method_count = loop == 1
519 ? extends_cl->class_class_function_count
520 : extends_cl->class_obj_method_count;
521 if (extends_method_count == 0)
522 continue;
523
524 ufunc_T **extends_methods = loop == 1
525 ? extends_cl->class_class_functions
526 : extends_cl->class_obj_methods;
527
528 int method_count = loop == 1 ? classmethods_gap->ga_len
529 : objmethods_gap->ga_len;
530 ufunc_T **cl_fp = (ufunc_T **)(loop == 1
531 ? classmethods_gap->ga_data
532 : objmethods_gap->ga_data);
533
534 for (int i = 0; i < extends_method_count; i++)
535 {
536 ufunc_T *uf = extends_methods[i];
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +0200537 if (!IS_ABSTRACT_METHOD(uf))
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200538 continue;
539
540 int method_found = FALSE;
541
542 for (int j = 0; j < method_count; j++)
543 {
544 if (STRCMP(uf->uf_name, cl_fp[j]->uf_name) == 0)
545 {
546 method_found = TRUE;
547 break;
548 }
549 }
550
551 if (!method_found)
552 {
553 semsg(_(e_abstract_method_str_not_found), uf->uf_name);
554 return FALSE;
555 }
556 }
557 }
558
559 return TRUE;
560}
561
562/*
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200563 * Returns TRUE if the interface variable "if_var" is present in the list of
564 * variables in "cl_mt" or in the parent lineage of one of the extended classes
565 * in "extends_cl". For a class variable, 'is_class_var' is TRUE.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200566 */
567 static int
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200568intf_variable_present(
569 char_u *intf_class_name,
570 ocmember_T *if_var,
571 int is_class_var,
572 ocmember_T *cl_mt,
573 int cl_member_count,
574 class_T *extends_cl)
575{
576 int variable_present = FALSE;
577
578 for (int cl_i = 0; cl_i < cl_member_count; ++cl_i)
579 {
580 ocmember_T *m = &cl_mt[cl_i];
581 where_T where = WHERE_INIT;
582
583 if (STRCMP(if_var->ocm_name, m->ocm_name) != 0)
584 continue;
585
586 // Ensure the access type is same
587 if (if_var->ocm_access != m->ocm_access)
588 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200589 semsg(_(e_variable_str_of_interface_str_has_different_access),
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200590 if_var->ocm_name, intf_class_name);
591 return FALSE;
592 }
593
594 // Ensure the type is matching.
595 if (m->ocm_type == &t_any)
596 {
597 // variable type is not specified. Use the variable type in the
598 // interface.
599 m->ocm_type = if_var->ocm_type;
600 }
601 else
602 {
603 where.wt_func_name = (char *)m->ocm_name;
604 where.wt_kind = WT_MEMBER;
605 if (check_type(if_var->ocm_type, m->ocm_type, TRUE,
606 where) == FAIL)
607 return FALSE;
608 }
609
610 variable_present = TRUE;
611 break;
612 }
613
614 if (!variable_present && extends_cl != NULL)
615 {
616 int ext_cl_count = is_class_var
617 ? extends_cl->class_class_member_count
618 : extends_cl->class_obj_member_count;
619 ocmember_T *ext_cl_mt = is_class_var
620 ? extends_cl->class_class_members
621 : extends_cl->class_obj_members;
622 return intf_variable_present(intf_class_name, if_var,
623 is_class_var, ext_cl_mt,
624 ext_cl_count,
625 extends_cl->class_extends);
626 }
627
628 return variable_present;
629}
630
631/*
632 * Check the variables of the interface class "ifcl" match the class variables
633 * ("classmembers_gap") and object variables ("objmembers_gap") of a class.
634 * Returns TRUE if the class and object variables names are valid.
635 */
636 static int
637validate_interface_variables(
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200638 char_u *intf_class_name,
639 class_T *ifcl,
640 garray_T *classmembers_gap,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200641 garray_T *objmembers_gap,
642 class_T *extends_cl)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200643{
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200644 for (int loop = 1; loop <= 2; ++loop)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200645 {
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200646 // loop == 1: check class variables
647 // loop == 2: check object variables
648 int is_class_var = (loop == 1);
649 int if_count = is_class_var ? ifcl->class_class_member_count
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200650 : ifcl->class_obj_member_count;
651 if (if_count == 0)
652 continue;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200653 ocmember_T *if_ms = is_class_var ? ifcl->class_class_members
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200654 : ifcl->class_obj_members;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200655 ocmember_T *cl_ms = (ocmember_T *)(is_class_var
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200656 ? classmembers_gap->ga_data
657 : objmembers_gap->ga_data);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200658 int cl_count = is_class_var ? classmembers_gap->ga_len
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200659 : objmembers_gap->ga_len;
660 for (int if_i = 0; if_i < if_count; ++if_i)
661 {
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200662 if (!intf_variable_present(intf_class_name, &if_ms[if_i],
663 is_class_var, cl_ms, cl_count, extends_cl))
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200664 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200665 semsg(_(e_variable_str_of_interface_str_not_implemented),
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200666 if_ms[if_i].ocm_name, intf_class_name);
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200667 return FALSE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200668 }
669 }
670 }
671
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200672 return TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200673}
674
675/*
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200676 * Returns TRUE if the method signature of "if_method" and "cl_method" matches.
677 */
678 static int
679intf_method_type_matches(ufunc_T *if_method, ufunc_T *cl_method)
680{
681 where_T where = WHERE_INIT;
682
683 // Ensure the type is matching.
684 where.wt_func_name = (char *)if_method->uf_name;
685 where.wt_kind = WT_METHOD;
686 if (check_type(if_method->uf_func_type, cl_method->uf_func_type, TRUE,
687 where) == FAIL)
688 return FALSE;
689
690 return TRUE;
691}
692
693/*
694 * Returns TRUE if the interface method "if_ufunc" is present in the list of
695 * methods in "cl_fp" or in the parent lineage of one of the extended classes
696 * in "extends_cl". For a class method, 'is_class_method' is TRUE.
697 */
698 static int
699intf_method_present(
700 ufunc_T *if_ufunc,
701 int is_class_method,
702 ufunc_T **cl_fp,
703 int cl_count,
704 class_T *extends_cl)
705{
706 int method_present = FALSE;
707
708 for (int cl_i = 0; cl_i < cl_count; ++cl_i)
709 {
710 char_u *cl_name = cl_fp[cl_i]->uf_name;
711 if (STRCMP(if_ufunc->uf_name, cl_name) == 0)
712 {
713 // Ensure the type is matching.
714 if (!intf_method_type_matches(if_ufunc, cl_fp[cl_i]))
715 return FALSE;
716 method_present = TRUE;
717 break;
718 }
719 }
720
721 if (!method_present && extends_cl != NULL)
722 {
723 ufunc_T **ext_cl_fp = (ufunc_T **)(is_class_method
724 ? extends_cl->class_class_functions
725 : extends_cl->class_obj_methods);
726 int ext_cl_count = is_class_method
727 ? extends_cl->class_class_function_count
728 : extends_cl->class_obj_method_count;
729 return intf_method_present(if_ufunc, is_class_method, ext_cl_fp,
730 ext_cl_count,
731 extends_cl->class_extends);
732 }
733
734 return method_present;
735}
736
737/*
738 * Validate that a new class implements all the class/instance methods in the
739 * interface "ifcl". The new class methods are in "classfunctions_gap" and the
740 * new object methods are in "objmemthods_gap". Also validates the method
741 * types.
742 * Returns TRUE if all the interface class/object methods are implemented in
743 * the new class.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200744 */
745 static int
746validate_interface_methods(
747 char_u *intf_class_name,
748 class_T *ifcl,
749 garray_T *classfunctions_gap,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200750 garray_T *objmethods_gap,
751 class_T *extends_cl)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200752{
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200753 for (int loop = 1; loop <= 2; ++loop)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200754 {
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200755 // loop == 1: check class methods
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200756 // loop == 2: check object methods
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200757 int is_class_method = (loop == 1);
758 int if_count = is_class_method ? ifcl->class_class_function_count
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200759 : ifcl->class_obj_method_count;
760 if (if_count == 0)
761 continue;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200762 ufunc_T **if_fp = is_class_method ? ifcl->class_class_functions
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200763 : ifcl->class_obj_methods;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200764 ufunc_T **cl_fp = (ufunc_T **)(is_class_method
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200765 ? classfunctions_gap->ga_data
766 : objmethods_gap->ga_data);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200767 int cl_count = is_class_method ? classfunctions_gap->ga_len
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200768 : objmethods_gap->ga_len;
769 for (int if_i = 0; if_i < if_count; ++if_i)
770 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200771 char_u *if_name = if_fp[if_i]->uf_name;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200772
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200773 if (!intf_method_present(if_fp[if_i], is_class_method, cl_fp,
774 cl_count, extends_cl))
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200775 {
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200776 semsg(_(e_method_str_of_interface_str_not_implemented),
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200777 if_name, intf_class_name);
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200778 return FALSE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200779 }
780 }
781 }
782
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200783 return TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200784}
785
786/*
787 * Validate all the "implements" classes when creating a new class. The
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200788 * classes are returned in "intf_classes". The class functions, class members,
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200789 * object methods and object members in the new class are in
790 * "classfunctions_gap", "classmembers_gap", "objmethods_gap", and
791 * "objmembers_gap" respectively.
792 */
793 static int
794validate_implements_classes(
795 garray_T *impl_gap,
796 class_T **intf_classes,
797 garray_T *classfunctions_gap,
798 garray_T *classmembers_gap,
799 garray_T *objmethods_gap,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200800 garray_T *objmembers_gap,
801 class_T *extends_cl)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200802{
803 int success = TRUE;
804
805 for (int i = 0; i < impl_gap->ga_len && success; ++i)
806 {
807 char_u *impl = ((char_u **)impl_gap->ga_data)[i];
808 typval_T tv;
809 tv.v_type = VAR_UNKNOWN;
810 if (eval_variable_import(impl, &tv) == FAIL)
811 {
812 semsg(_(e_interface_name_not_found_str), impl);
813 success = FALSE;
814 break;
815 }
816
817 if (tv.v_type != VAR_CLASS
818 || tv.vval.v_class == NULL
819 || (tv.vval.v_class->class_flags & CLASS_INTERFACE) == 0)
820 {
821 semsg(_(e_not_valid_interface_str), impl);
822 success = FALSE;
823 clear_tv(&tv);
824 break;
825 }
826
827 class_T *ifcl = tv.vval.v_class;
828 intf_classes[i] = ifcl;
829 ++ifcl->class_refcount;
830
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200831 // check the variables of the interface match the members of the class
832 success = validate_interface_variables(impl, ifcl, classmembers_gap,
833 objmembers_gap, extends_cl);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200834
835 // check the functions/methods of the interface match the
836 // functions/methods of the class
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200837 if (success)
838 success = validate_interface_methods(impl, ifcl,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200839 classfunctions_gap, objmethods_gap,
840 extends_cl);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200841 clear_tv(&tv);
842 }
843
844 return success;
845}
846
847/*
848 * Check no function argument name is used as a class member.
849 * (Object members are always accessed with "this." prefix, so no need
850 * to check them.)
851 */
852 static int
853check_func_arg_names(
854 garray_T *classfunctions_gap,
855 garray_T *objmethods_gap,
856 garray_T *classmembers_gap)
857{
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200858 // loop 1: class functions, loop 2: object methods
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200859 for (int loop = 1; loop <= 2; ++loop)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200860 {
861 garray_T *gap = loop == 1 ? classfunctions_gap : objmethods_gap;
862
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200863 for (int fi = 0; fi < gap->ga_len; ++fi)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200864 {
865 ufunc_T *uf = ((ufunc_T **)gap->ga_data)[fi];
866
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200867 for (int i = 0; i < uf->uf_args.ga_len; ++i)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200868 {
869 char_u *aname = ((char_u **)uf->uf_args.ga_data)[i];
870 garray_T *mgap = classmembers_gap;
871
872 // Check all the class member names
873 for (int mi = 0; mi < mgap->ga_len; ++mi)
874 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200875 char_u *mname =
876 ((ocmember_T *)mgap->ga_data + mi)->ocm_name;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200877 if (STRCMP(aname, mname) == 0)
878 {
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200879 if (uf->uf_script_ctx.sc_sid > 0)
880 SOURCING_LNUM = uf->uf_script_ctx.sc_lnum;
881
882 semsg(_(e_argument_already_declared_in_class_str),
883 aname);
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200884
885 return FALSE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200886 }
887 }
888 }
889 }
890 }
891
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200892 return TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200893}
894
895/*
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200896 * Returns TRUE if the member "varname" is already defined.
897 */
898 static int
899is_duplicate_member(garray_T *mgap, char_u *varname, char_u *varname_end)
900{
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200901 char_u *name = vim_strnsave(varname, varname_end - varname);
902 char_u *pstr = (*name == '_') ? name + 1 : name;
903 int dup = FALSE;
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200904
905 for (int i = 0; i < mgap->ga_len; ++i)
906 {
907 ocmember_T *m = ((ocmember_T *)mgap->ga_data) + i;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200908 char_u *qstr = *m->ocm_name == '_' ? m->ocm_name + 1 : m->ocm_name;
909 if (STRCMP(pstr, qstr) == 0)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200910 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200911 semsg(_(e_duplicate_variable_str), name);
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200912 dup = TRUE;
913 break;
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200914 }
915 }
916
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200917 vim_free(name);
918 return dup;
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200919}
920
921/*
922 * Returns TRUE if the method "name" is already defined.
923 */
924 static int
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200925is_duplicate_method(
926 garray_T *classmethods_gap,
927 garray_T *objmethods_gap,
928 char_u *name)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200929{
930 char_u *pstr = (*name == '_') ? name + 1 : name;
931
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200932 // loop 1: class methods, loop 2: object methods
933 for (int loop = 1; loop <= 2; loop++)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200934 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200935 garray_T *fgap = (loop == 1) ? classmethods_gap : objmethods_gap;
936 for (int i = 0; i < fgap->ga_len; ++i)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200937 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200938 char_u *n = ((ufunc_T **)fgap->ga_data)[i]->uf_name;
939 char_u *qstr = *n == '_' ? n + 1 : n;
940 if (STRCMP(pstr, qstr) == 0)
941 {
942 semsg(_(e_duplicate_function_str), name);
943 return TRUE;
944 }
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200945 }
946 }
947
948 return FALSE;
949}
950
951/*
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200952 * Returns TRUE if the constructor is valid.
953 */
954 static int
955is_valid_constructor(ufunc_T *uf, int is_abstract, int has_static)
956{
957 // Constructors are not allowed in abstract classes.
958 if (is_abstract)
959 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200960 emsg(_(e_cannot_define_new_method_in_abstract_class));
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200961 return FALSE;
962 }
963 // A constructor is always static, no need to define it so.
964 if (has_static)
965 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200966 emsg(_(e_cannot_define_new_method_as_static));
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200967 return FALSE;
968 }
969 // A return type should not be specified for the new()
970 // constructor method.
971 if (uf->uf_ret_type->tt_type != VAR_VOID)
972 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200973 emsg(_(e_cannot_use_a_return_type_with_new_method));
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200974 return FALSE;
975 }
976 return TRUE;
977}
978
979/*
Yegappan Lakshmananb1027282023-08-19 11:26:42 +0200980 * Update the interface class lookup table for the member index on the
981 * interface to the member index in the class implementing the interface.
982 * And a lookup table for the object method index on the interface
983 * to the object method index in the class implementing the interface.
984 * This is also used for updating the lookup table for the extended class
985 * hierarchy.
986 */
987 static int
988update_member_method_lookup_table(
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +0200989 class_T *ifcl,
990 class_T *cl,
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +0200991 garray_T *objmethods,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200992 int pobj_method_offset)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +0200993{
994 if (ifcl == NULL)
995 return OK;
996
997 // Table for members.
998 itf2class_T *if2cl = alloc_clear(sizeof(itf2class_T)
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200999 + ifcl->class_obj_member_count * sizeof(int));
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001000 if (if2cl == NULL)
1001 return FAIL;
1002 if2cl->i2c_next = ifcl->class_itf2class;
1003 ifcl->class_itf2class = if2cl;
1004 if2cl->i2c_class = cl;
1005 if2cl->i2c_is_method = FALSE;
1006
1007 for (int if_i = 0; if_i < ifcl->class_obj_member_count; ++if_i)
1008 for (int cl_i = 0; cl_i < cl->class_obj_member_count; ++cl_i)
1009 {
1010 if (STRCMP(ifcl->class_obj_members[if_i].ocm_name,
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001011 cl->class_obj_members[cl_i].ocm_name) == 0)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001012 {
1013 int *table = (int *)(if2cl + 1);
1014 table[if_i] = cl_i;
1015 break;
1016 }
1017 }
1018
1019 // Table for methods.
1020 if2cl = alloc_clear(sizeof(itf2class_T)
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001021 + ifcl->class_obj_method_count * sizeof(int));
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001022 if (if2cl == NULL)
1023 return FAIL;
1024 if2cl->i2c_next = ifcl->class_itf2class;
1025 ifcl->class_itf2class = if2cl;
1026 if2cl->i2c_class = cl;
1027 if2cl->i2c_is_method = TRUE;
1028
1029 for (int if_i = 0; if_i < ifcl->class_obj_method_count; ++if_i)
1030 {
1031 int done = FALSE;
1032 for (int cl_i = 0; cl_i < objmethods->ga_len; ++cl_i)
1033 {
1034 if (STRCMP(ifcl->class_obj_methods[if_i]->uf_name,
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001035 ((ufunc_T **)objmethods->ga_data)[cl_i]->uf_name) == 0)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001036 {
1037 int *table = (int *)(if2cl + 1);
1038 table[if_i] = cl_i;
1039 done = TRUE;
1040 break;
1041 }
1042 }
1043
1044 // extended class object method is not overridden by the child class.
1045 // Keep the method declared in one of the parent classes in the
1046 // lineage.
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001047 if (!done)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001048 {
1049 // If "ifcl" is not the immediate parent of "cl", then search in
1050 // the intermediate parent classes.
1051 if (cl->class_extends != ifcl)
1052 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001053 class_T *parent = cl->class_extends;
1054 int method_offset = objmethods->ga_len;
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001055
1056 while (!done && parent != NULL && parent != ifcl)
1057 {
1058
1059 for (int cl_i = 0;
1060 cl_i < parent->class_obj_method_count_child; ++cl_i)
1061 {
1062 if (STRCMP(ifcl->class_obj_methods[if_i]->uf_name,
1063 parent->class_obj_methods[cl_i]->uf_name)
1064 == 0)
1065 {
1066 int *table = (int *)(if2cl + 1);
1067 table[if_i] = method_offset + cl_i;
1068 done = TRUE;
1069 break;
1070 }
1071 }
1072 method_offset += parent->class_obj_method_count_child;
1073 parent = parent->class_extends;
1074 }
1075 }
1076
1077 if (!done)
1078 {
1079 int *table = (int *)(if2cl + 1);
1080 table[if_i] = pobj_method_offset + if_i;
1081 }
1082 }
1083 }
1084
1085 return OK;
1086}
1087
1088/*
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001089 * Update the member and object method lookup tables for a new class in the
1090 * interface class.
1091 * For each interface add a lookup table for the member index on the interface
1092 * to the member index in the new class. And a lookup table for the object
1093 * method index on the interface to the object method index in the new class.
1094 */
1095 static int
1096add_lookup_tables(class_T *cl, class_T *extends_cl, garray_T *objmethods_gap)
1097{
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001098 // update the lookup table for all the implemented interfaces
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001099 for (int i = 0; i < cl->class_interface_count; ++i)
1100 {
1101 class_T *ifcl = cl->class_interfaces_cl[i];
1102
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001103 // update the lookup table for this interface and all its super
1104 // interfaces.
1105 while (ifcl != NULL)
1106 {
1107 if (update_member_method_lookup_table(ifcl, cl, objmethods_gap,
1108 0) == FAIL)
1109 return FAIL;
1110 ifcl = ifcl->class_extends;
1111 }
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001112 }
1113
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001114 // Update the lookup table for the extended class, if any
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001115 if (extends_cl != NULL)
1116 {
1117 class_T *pclass = extends_cl;
1118 int pobj_method_offset = objmethods_gap->ga_len;
1119
1120 // Update the entire lineage of extended classes.
1121 while (pclass != NULL)
1122 {
1123 if (update_member_method_lookup_table(pclass, cl,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001124 objmethods_gap, pobj_method_offset) == FAIL)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001125 return FAIL;
1126
1127 pobj_method_offset += pclass->class_obj_method_count_child;
1128 pclass = pclass->class_extends;
1129 }
1130 }
1131
1132 return OK;
1133}
1134
1135/*
1136 * Add class members to a new class. Allocate a typval for each class member
1137 * and initialize it.
1138 */
1139 static void
1140add_class_members(class_T *cl, exarg_T *eap)
1141{
1142 // Allocate a typval for each class member and initialize it.
1143 cl->class_members_tv = ALLOC_CLEAR_MULT(typval_T,
1144 cl->class_class_member_count);
1145 if (cl->class_members_tv == NULL)
1146 return;
1147
1148 for (int i = 0; i < cl->class_class_member_count; ++i)
1149 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001150 ocmember_T *m = &cl->class_class_members[i];
1151 typval_T *tv = &cl->class_members_tv[i];
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001152 if (m->ocm_init != NULL)
1153 {
1154 typval_T *etv = eval_expr(m->ocm_init, eap);
1155 if (etv != NULL)
1156 {
1157 *tv = *etv;
1158 vim_free(etv);
1159 }
1160 }
1161 else
1162 {
1163 // TODO: proper default value
1164 tv->v_type = m->ocm_type->tt_type;
1165 tv->vval.v_string = NULL;
1166 }
1167 }
1168}
1169
1170/*
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02001171 * Add a default constructor method (new()) to the class "cl".
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001172 */
1173 static void
1174add_default_constructor(
1175 class_T *cl,
1176 garray_T *classfunctions_gap,
1177 garray_T *type_list_gap)
1178{
1179 garray_T fga;
1180
1181 ga_init2(&fga, 1, 1000);
1182 ga_concat(&fga, (char_u *)"new(");
1183 for (int i = 0; i < cl->class_obj_member_count; ++i)
1184 {
1185 if (i > 0)
1186 ga_concat(&fga, (char_u *)", ");
1187 ga_concat(&fga, (char_u *)"this.");
1188 ocmember_T *m = cl->class_obj_members + i;
1189 ga_concat(&fga, (char_u *)m->ocm_name);
1190 ga_concat(&fga, (char_u *)" = v:none");
1191 }
1192 ga_concat(&fga, (char_u *)")\nenddef\n");
1193 ga_append(&fga, NUL);
1194
1195 exarg_T fea;
1196 CLEAR_FIELD(fea);
1197 fea.cmdidx = CMD_def;
1198 fea.cmd = fea.arg = fga.ga_data;
1199
1200 garray_T lines_to_free;
1201 ga_init2(&lines_to_free, sizeof(char_u *), 50);
1202
h-eastb895b0f2023-09-24 15:46:31 +02001203 ufunc_T *nf = define_function(&fea, NULL, &lines_to_free, CF_CLASS,
1204 cl->class_obj_members, cl->class_obj_member_count);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001205
1206 ga_clear_strings(&lines_to_free);
1207 vim_free(fga.ga_data);
1208
1209 if (nf != NULL && ga_grow(classfunctions_gap, 1) == OK)
1210 {
1211 ((ufunc_T **)classfunctions_gap->ga_data)[classfunctions_gap->ga_len]
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001212 = nf;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001213 ++classfunctions_gap->ga_len;
1214
1215 nf->uf_flags |= FC_NEW;
1216 nf->uf_ret_type = get_type_ptr(type_list_gap);
1217 if (nf->uf_ret_type != NULL)
1218 {
1219 nf->uf_ret_type->tt_type = VAR_OBJECT;
1220 nf->uf_ret_type->tt_class = cl;
1221 nf->uf_ret_type->tt_argcount = 0;
1222 nf->uf_ret_type->tt_args = NULL;
1223 }
1224 }
1225}
1226
1227/*
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001228 * Add the class methods and object methods to the new class "cl".
1229 * When extending a class "extends_cl", add the instance methods from the
1230 * parent class also.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001231 */
1232 static int
1233add_classfuncs_objmethods(
1234 class_T *cl,
1235 class_T *extends_cl,
1236 garray_T *classfunctions_gap,
1237 garray_T *objmethods_gap)
1238{
1239 // loop 1: class functions, loop 2: object methods
1240 for (int loop = 1; loop <= 2; ++loop)
1241 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001242 garray_T *gap = loop == 1 ? classfunctions_gap : objmethods_gap;
1243 int *fcount = loop == 1 ? &cl->class_class_function_count
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001244 : &cl->class_obj_method_count;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001245 ufunc_T ***fup = loop == 1 ? &cl->class_class_functions
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001246 : &cl->class_obj_methods;
1247
1248 int parent_count = 0;
1249 if (extends_cl != NULL)
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001250 // Include object methods from the parent.
1251 // Don't include the parent class methods.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001252 parent_count = loop == 1
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001253 ? 0
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001254 : extends_cl->class_obj_method_count;
1255
1256 *fcount = parent_count + gap->ga_len;
1257 if (*fcount == 0)
1258 {
1259 *fup = NULL;
1260 continue;
1261 }
1262 *fup = ALLOC_MULT(ufunc_T *, *fcount);
1263 if (*fup == NULL)
1264 return FAIL;
1265
1266 if (gap->ga_len != 0)
1267 mch_memmove(*fup, gap->ga_data, sizeof(ufunc_T *) * gap->ga_len);
1268 vim_free(gap->ga_data);
1269 if (loop == 1)
1270 cl->class_class_function_count_child = gap->ga_len;
1271 else
1272 cl->class_obj_method_count_child = gap->ga_len;
1273
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001274 if (loop == 2)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001275 {
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001276 // Copy instance methods from the parent.
1277
1278 for (int i = 0; i < parent_count; ++i)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001279 {
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001280 // Can't use the same parent function, because "uf_class" is
1281 // different and compilation will have a different result.
1282 // Put them after the functions in the current class, object
1283 // methods may be overruled, then "super.Method()" is used to
1284 // find a method from the parent.
1285 ufunc_T *pf = (extends_cl->class_obj_methods)[i];
1286 (*fup)[gap->ga_len + i] = copy_function(pf);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001287
1288 // If the child class overrides a function from the parent
1289 // the signature must be equal.
1290 char_u *pname = pf->uf_name;
1291 for (int ci = 0; ci < gap->ga_len; ++ci)
1292 {
1293 ufunc_T *cf = (*fup)[ci];
1294 char_u *cname = cf->uf_name;
1295 if (STRCMP(pname, cname) == 0)
1296 {
1297 where_T where = WHERE_INIT;
1298 where.wt_func_name = (char *)pname;
1299 where.wt_kind = WT_METHOD;
1300 (void)check_type(pf->uf_func_type, cf->uf_func_type,
1301 TRUE, where);
1302 }
1303 }
1304 }
1305 }
1306
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001307 // Set the class pointer on all the functions and object methods.
1308 for (int i = 0; i < *fcount; ++i)
1309 {
1310 ufunc_T *fp = (*fup)[i];
1311 fp->uf_class = cl;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001312 if (i < gap->ga_len)
1313 fp->uf_defclass = cl;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001314 if (loop == 2)
1315 fp->uf_flags |= FC_OBJECT;
1316 }
1317 }
1318
1319 return OK;
1320}
1321
1322/*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001323 * Handle ":class" and ":abstract class" up to ":endclass".
Bram Moolenaar554d0312023-01-05 19:59:18 +00001324 * Handle ":interface" up to ":endinterface".
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001325 */
1326 void
1327ex_class(exarg_T *eap)
1328{
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001329 int is_class = eap->cmdidx == CMD_class; // FALSE for :interface
1330 long start_lnum = SOURCING_LNUM;
1331 char_u *arg = eap->arg;
1332 int is_abstract = eap->cmdidx == CMD_abstract;
Bram Moolenaar554d0312023-01-05 19:59:18 +00001333
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001334 if (is_abstract)
1335 {
1336 if (STRNCMP(arg, "class", 5) != 0 || !VIM_ISWHITE(arg[5]))
1337 {
1338 semsg(_(e_invalid_argument_str), arg);
1339 return;
1340 }
1341 arg = skipwhite(arg + 5);
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001342 is_class = TRUE;
1343 }
1344
1345 if (!current_script_is_vim9()
1346 || (cmdmod.cmod_flags & CMOD_LEGACY)
1347 || !getline_equal(eap->getline, eap->cookie, getsourceline))
1348 {
1349 if (is_class)
1350 emsg(_(e_class_can_only_be_defined_in_vim9_script));
1351 else
1352 emsg(_(e_interface_can_only_be_defined_in_vim9_script));
1353 return;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001354 }
1355
1356 if (!ASCII_ISUPPER(*arg))
1357 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001358 if (is_class)
1359 semsg(_(e_class_name_must_start_with_uppercase_letter_str), arg);
1360 else
1361 semsg(_(e_interface_name_must_start_with_uppercase_letter_str),
1362 arg);
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001363 return;
1364 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001365 char_u *name_end = find_name_end(arg, NULL, NULL, FNE_CHECK_START);
1366 if (!IS_WHITE_OR_NUL(*name_end))
1367 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001368 semsg(_(e_white_space_required_after_name_str), arg);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001369 return;
1370 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001371 char_u *name_start = arg;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001372
Bram Moolenaara86655a2023-01-12 17:06:27 +00001373 // "export class" gets used when creating the class, don't use "is_export"
1374 // for the items inside the class.
1375 int class_export = is_export;
1376 is_export = FALSE;
1377
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001378 // TODO:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001379 // generics: <Tkey, Tentry>
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001380
Bram Moolenaar83677162023-01-08 19:54:10 +00001381 // Name for "extends BaseClass"
1382 char_u *extends = NULL;
1383
Bram Moolenaar94674f22023-01-06 18:42:20 +00001384 // Names for "implements SomeInterface"
1385 garray_T ga_impl;
1386 ga_init2(&ga_impl, sizeof(char_u *), 5);
1387
1388 arg = skipwhite(name_end);
1389 while (*arg != NUL && *arg != '#' && *arg != '\n')
1390 {
1391 // TODO:
Bram Moolenaar94674f22023-01-06 18:42:20 +00001392 // specifies SomeInterface
Bram Moolenaar83677162023-01-08 19:54:10 +00001393 if (STRNCMP(arg, "extends", 7) == 0 && IS_WHITE_OR_NUL(arg[7]))
1394 {
1395 if (extends != NULL)
1396 {
1397 emsg(_(e_duplicate_extends));
1398 goto early_ret;
1399 }
1400 arg = skipwhite(arg + 7);
1401 char_u *end = find_name_end(arg, NULL, NULL, FNE_CHECK_START);
1402 if (!IS_WHITE_OR_NUL(*end))
1403 {
1404 semsg(_(e_white_space_required_after_name_str), arg);
1405 goto early_ret;
1406 }
1407 extends = vim_strnsave(arg, end - arg);
1408 if (extends == NULL)
1409 goto early_ret;
1410
1411 arg = skipwhite(end + 1);
1412 }
1413 else if (STRNCMP(arg, "implements", 10) == 0
1414 && IS_WHITE_OR_NUL(arg[10]))
Bram Moolenaar94674f22023-01-06 18:42:20 +00001415 {
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001416 if (!is_class)
1417 {
1418 emsg(_(e_interface_cannot_use_implements));
1419 goto early_ret;
1420 }
1421
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001422 if (ga_impl.ga_len > 0)
1423 {
1424 emsg(_(e_duplicate_implements));
1425 goto early_ret;
1426 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001427 arg = skipwhite(arg + 10);
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001428
1429 for (;;)
Bram Moolenaar94674f22023-01-06 18:42:20 +00001430 {
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001431 char_u *impl_end = find_name_end(arg, NULL, NULL,
1432 FNE_CHECK_START);
1433 if (!IS_WHITE_OR_NUL(*impl_end) && *impl_end != ',')
1434 {
1435 semsg(_(e_white_space_required_after_name_str), arg);
1436 goto early_ret;
1437 }
1438 char_u *iname = vim_strnsave(arg, impl_end - arg);
1439 if (iname == NULL)
1440 goto early_ret;
1441 for (int i = 0; i < ga_impl.ga_len; ++i)
1442 if (STRCMP(((char_u **)ga_impl.ga_data)[i], iname) == 0)
1443 {
1444 semsg(_(e_duplicate_interface_after_implements_str),
1445 iname);
1446 vim_free(iname);
1447 goto early_ret;
1448 }
1449 if (ga_add_string(&ga_impl, iname) == FAIL)
1450 {
1451 vim_free(iname);
1452 goto early_ret;
1453 }
1454 if (*impl_end != ',')
1455 {
1456 arg = skipwhite(impl_end);
1457 break;
1458 }
1459 arg = skipwhite(impl_end + 1);
Bram Moolenaar94674f22023-01-06 18:42:20 +00001460 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001461 }
1462 else
1463 {
1464 semsg(_(e_trailing_characters_str), arg);
1465early_ret:
Bram Moolenaar83677162023-01-08 19:54:10 +00001466 vim_free(extends);
Bram Moolenaar94674f22023-01-06 18:42:20 +00001467 ga_clear_strings(&ga_impl);
1468 return;
1469 }
1470 }
1471
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001472 garray_T type_list; // list of pointers to allocated types
1473 ga_init2(&type_list, sizeof(type_T *), 10);
1474
Bram Moolenaard505d172022-12-18 21:42:55 +00001475 // Growarray with class members declared in the class.
1476 garray_T classmembers;
1477 ga_init2(&classmembers, sizeof(ocmember_T), 10);
1478
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001479 // Growarray with functions declared in the class.
1480 garray_T classfunctions;
1481 ga_init2(&classfunctions, sizeof(ufunc_T *), 10);
Bram Moolenaard505d172022-12-18 21:42:55 +00001482
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001483 // Growarray with object members declared in the class.
1484 garray_T objmembers;
Bram Moolenaard505d172022-12-18 21:42:55 +00001485 ga_init2(&objmembers, sizeof(ocmember_T), 10);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001486
1487 // Growarray with object methods declared in the class.
1488 garray_T objmethods;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001489 ga_init2(&objmethods, sizeof(ufunc_T *), 10);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001490
1491 /*
Bram Moolenaar554d0312023-01-05 19:59:18 +00001492 * Go over the body of the class/interface until "endclass" or
1493 * "endinterface" is found.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001494 */
1495 char_u *theline = NULL;
1496 int success = FALSE;
1497 for (;;)
1498 {
1499 vim_free(theline);
1500 theline = eap->getline(':', eap->cookie, 0, GETLINE_CONCAT_ALL);
1501 if (theline == NULL)
1502 break;
1503 char_u *line = skipwhite(theline);
1504
Bram Moolenaar418b5472022-12-20 13:38:22 +00001505 // Skip empty and comment lines.
1506 if (*line == NUL)
1507 continue;
1508 if (*line == '#')
1509 {
1510 if (vim9_bad_comment(line))
1511 break;
1512 continue;
1513 }
1514
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001515 char_u *p = line;
Bram Moolenaar554d0312023-01-05 19:59:18 +00001516 char *end_name = is_class ? "endclass" : "endinterface";
1517 if (checkforcmd(&p, end_name, is_class ? 4 : 5))
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001518 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001519 if (STRNCMP(line, end_name, is_class ? 8 : 12) != 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001520 semsg(_(e_command_cannot_be_shortened_str), line);
1521 else if (*p == '|' || !ends_excmd2(line, p))
1522 semsg(_(e_trailing_characters_str), p);
Bram Moolenaar98aeb212022-12-08 22:09:14 +00001523 else
1524 success = TRUE;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001525 break;
1526 }
Bram Moolenaar554d0312023-01-05 19:59:18 +00001527 char *wrong_name = is_class ? "endinterface" : "endclass";
1528 if (checkforcmd(&p, wrong_name, is_class ? 5 : 4))
1529 {
Bram Moolenaar657aea72023-01-27 13:16:19 +00001530 semsg(_(e_invalid_command_str_expected_str), line, end_name);
Bram Moolenaar554d0312023-01-05 19:59:18 +00001531 break;
1532 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001533
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001534 int has_public = FALSE;
1535 if (checkforcmd(&p, "public", 3))
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001536 {
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001537 if (STRNCMP(line, "public", 6) != 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001538 {
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001539 semsg(_(e_command_cannot_be_shortened_str), line);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001540 break;
1541 }
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001542 has_public = TRUE;
1543 p = skipwhite(line + 6);
1544
Bram Moolenaard505d172022-12-18 21:42:55 +00001545 if (STRNCMP(p, "this", 4) != 0 && STRNCMP(p, "static", 6) != 0)
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001546 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001547 emsg(_(e_public_must_be_followed_by_this_or_static));
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001548 break;
1549 }
1550 }
Bram Moolenaard505d172022-12-18 21:42:55 +00001551
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001552 int abstract_method = FALSE;
1553 char_u *pa = p;
1554 if (checkforcmd(&p, "abstract", 3))
1555 {
1556 if (STRNCMP(pa, "abstract", 8) != 0)
1557 {
1558 semsg(_(e_command_cannot_be_shortened_str), pa);
1559 break;
1560 }
1561
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001562 if (!is_class)
1563 // ignore "abstract" in an interface (as all the methods in an
1564 // interface are abstract.
1565 p = skipwhite(pa + 8);
1566 else
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001567 {
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001568 if (!is_abstract)
1569 {
1570 semsg(_(e_abstract_method_in_concrete_class), pa);
1571 break;
1572 }
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001573
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001574 abstract_method = TRUE;
1575 p = skipwhite(pa + 8);
1576 if (STRNCMP(p, "def", 3) != 0 && STRNCMP(p, "static", 6) != 0)
1577 {
1578 emsg(_(e_abstract_must_be_followed_by_def_or_static));
1579 break;
1580 }
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001581 }
1582 }
1583
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001584 int has_static = FALSE;
1585 char_u *ps = p;
1586 if (checkforcmd(&p, "static", 4))
1587 {
1588 if (STRNCMP(ps, "static", 6) != 0)
1589 {
1590 semsg(_(e_command_cannot_be_shortened_str), ps);
1591 break;
1592 }
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001593
1594 if (!is_class)
1595 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001596 emsg(_(e_static_member_not_supported_in_interface));
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001597 break;
1598 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001599 has_static = TRUE;
1600 p = skipwhite(ps + 6);
1601 }
1602
Bram Moolenaard505d172022-12-18 21:42:55 +00001603 // object members (public, read access, private):
1604 // "this._varname"
1605 // "this.varname"
1606 // "public this.varname"
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001607 if (STRNCMP(p, "this", 4) == 0)
1608 {
1609 if (p[4] != '.' || !eval_isnamec1(p[5]))
1610 {
RestorerZ7fe8f432023-09-24 23:21:24 +02001611 semsg(_(e_invalid_object_variable_declaration_str), p);
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001612 break;
1613 }
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02001614 if (has_static)
1615 {
1616 emsg(_(e_static_cannot_be_followed_by_this));
1617 break;
1618 }
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00001619 char_u *varname = p + 5;
Bram Moolenaard505d172022-12-18 21:42:55 +00001620 char_u *varname_end = NULL;
Bram Moolenaar74e12742022-12-13 21:14:28 +00001621 type_T *type = NULL;
Bram Moolenaard505d172022-12-18 21:42:55 +00001622 char_u *init_expr = NULL;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001623
1624 if (!is_class && *varname == '_')
1625 {
1626 // private variables are not supported in an interface
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001627 semsg(_(e_private_variable_not_supported_in_interface),
1628 varname);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001629 break;
1630 }
1631
Bram Moolenaard505d172022-12-18 21:42:55 +00001632 if (parse_member(eap, line, varname, has_public,
Bram Moolenaar554d0312023-01-05 19:59:18 +00001633 &varname_end, &type_list, &type,
1634 is_class ? &init_expr: NULL) == FAIL)
Bram Moolenaard505d172022-12-18 21:42:55 +00001635 break;
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02001636 if (is_duplicate_member(&objmembers, varname, varname_end))
1637 {
1638 vim_free(init_expr);
1639 break;
1640 }
Bram Moolenaard505d172022-12-18 21:42:55 +00001641 if (add_member(&objmembers, varname, varname_end,
1642 has_public, type, init_expr) == FAIL)
Bram Moolenaar74e12742022-12-13 21:14:28 +00001643 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001644 vim_free(init_expr);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001645 break;
1646 }
Bram Moolenaard505d172022-12-18 21:42:55 +00001647 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001648
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001649 // constructors:
1650 // def new()
1651 // enddef
1652 // def newOther()
1653 // enddef
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001654 // object methods and class functions:
1655 // def SomeMethod()
1656 // enddef
1657 // static def ClassFunction()
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001658 // enddef
1659 // TODO:
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001660 // def <Tval> someMethod()
1661 // enddef
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001662 else if (checkforcmd(&p, "def", 3))
1663 {
1664 exarg_T ea;
1665 garray_T lines_to_free;
1666
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001667 // TODO: error for "public static def Func()"?
1668
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001669 CLEAR_FIELD(ea);
1670 ea.cmd = line;
1671 ea.arg = p;
1672 ea.cmdidx = CMD_def;
1673 ea.getline = eap->getline;
1674 ea.cookie = eap->cookie;
1675
1676 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001677 int class_flags;
1678 if (is_class)
1679 class_flags = abstract_method ? CF_ABSTRACT_METHOD : CF_CLASS;
1680 else
1681 class_flags = CF_INTERFACE;
Bram Moolenaar554d0312023-01-05 19:59:18 +00001682 ufunc_T *uf = define_function(&ea, NULL, &lines_to_free,
h-eastb895b0f2023-09-24 15:46:31 +02001683 class_flags, objmembers.ga_data, objmembers.ga_len);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001684 ga_clear_strings(&lines_to_free);
1685
Bram Moolenaar6acf7572023-01-01 19:53:30 +00001686 if (uf != NULL)
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001687 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001688 char_u *name = uf->uf_name;
1689 int is_new = STRNCMP(name, "new", 3) == 0;
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +02001690
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001691 if (!is_class && *name == '_')
1692 {
1693 // private variables are not supported in an interface
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001694 semsg(_(e_private_method_not_supported_in_interface),
1695 name);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001696 func_clear_free(uf, FALSE);
1697 break;
1698 }
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001699 if (is_new && !is_valid_constructor(uf, is_abstract,
1700 has_static))
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001701 {
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001702 func_clear_free(uf, FALSE);
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001703 break;
1704 }
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +02001705
Bram Moolenaar58b40092023-01-11 15:59:05 +00001706 // Check the name isn't used already.
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001707 if (is_duplicate_method(&classfunctions, &objmethods, name))
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02001708 {
1709 success = FALSE;
1710 func_clear_free(uf, FALSE);
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02001711 break;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02001712 }
Bram Moolenaar58b40092023-01-11 15:59:05 +00001713
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001714 garray_T *fgap = has_static || is_new
1715 ? &classfunctions : &objmethods;
Bram Moolenaar6acf7572023-01-01 19:53:30 +00001716 if (ga_grow(fgap, 1) == OK)
1717 {
1718 if (is_new)
1719 uf->uf_flags |= FC_NEW;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00001720
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001721 if (abstract_method)
1722 uf->uf_flags |= FC_ABSTRACT;
1723
Bram Moolenaar6acf7572023-01-01 19:53:30 +00001724 ((ufunc_T **)fgap->ga_data)[fgap->ga_len] = uf;
1725 ++fgap->ga_len;
1726 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001727 }
1728 }
1729
1730 // class members
1731 else if (has_static)
1732 {
1733 // class members (public, read access, private):
1734 // "static _varname"
1735 // "static varname"
1736 // "public static varname"
1737 char_u *varname = p;
1738 char_u *varname_end = NULL;
1739 type_T *type = NULL;
1740 char_u *init_expr = NULL;
1741 if (parse_member(eap, line, varname, has_public,
Bram Moolenaar554d0312023-01-05 19:59:18 +00001742 &varname_end, &type_list, &type,
1743 is_class ? &init_expr : NULL) == FAIL)
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001744 break;
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02001745 if (is_duplicate_member(&classmembers, varname, varname_end))
1746 {
1747 vim_free(init_expr);
1748 break;
1749 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001750 if (add_member(&classmembers, varname, varname_end,
1751 has_public, type, init_expr) == FAIL)
1752 {
1753 vim_free(init_expr);
1754 break;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001755 }
1756 }
1757
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001758 else
1759 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001760 if (is_class)
1761 semsg(_(e_not_valid_command_in_class_str), line);
1762 else
1763 semsg(_(e_not_valid_command_in_interface_str), line);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001764 break;
1765 }
1766 }
1767 vim_free(theline);
1768
Bram Moolenaar83677162023-01-08 19:54:10 +00001769 class_T *extends_cl = NULL; // class from "extends" argument
1770
1771 /*
1772 * Check a few things before defining the class.
1773 */
1774
1775 // Check the "extends" class is valid.
1776 if (success && extends != NULL)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001777 success = validate_extends_class(extends, &extends_cl, is_class);
Bram Moolenaar83677162023-01-08 19:54:10 +00001778 VIM_CLEAR(extends);
1779
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001780 // Check the new object methods to make sure their access (public or
1781 // private) is the same as that in the extended class lineage.
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02001782 if (success && extends_cl != NULL)
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001783 success = validate_extends_methods(&objmethods, extends_cl);
1784
1785 // Check the new class and object variables are not duplicates of the
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001786 // variables in the extended class lineage. If an interface is extending
1787 // another interface, then it can duplicate the member variables.
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001788 if (success && extends_cl != NULL)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001789 {
1790 if (is_class)
1791 success = extends_check_dup_members(&objmembers, extends_cl);
1792 else
1793 success = extends_check_intf_var_type(&objmembers, extends_cl);
1794 }
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02001795
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001796 // When extending an abstract class, make sure all the abstract methods in
1797 // the parent class are implemented. If the current class is an abstract
1798 // class, then there is no need for this check.
1799 if (success && !is_abstract && extends_cl != NULL
1800 && (extends_cl->class_flags & CLASS_ABSTRACT))
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001801 success = validate_abstract_class_methods(&classfunctions,
1802 &objmethods, extends_cl);
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001803
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00001804 class_T **intf_classes = NULL;
1805
Bram Moolenaar83677162023-01-08 19:54:10 +00001806 // Check all "implements" entries are valid.
Bram Moolenaar94674f22023-01-06 18:42:20 +00001807 if (success && ga_impl.ga_len > 0)
1808 {
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00001809 intf_classes = ALLOC_CLEAR_MULT(class_T *, ga_impl.ga_len);
1810
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001811 success = validate_implements_classes(&ga_impl, intf_classes,
1812 &classfunctions, &classmembers,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001813 &objmethods, &objmembers,
1814 extends_cl);
Bram Moolenaar94674f22023-01-06 18:42:20 +00001815 }
1816
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001817 // Check no function argument name is used as a class member.
Bram Moolenaard40f00c2023-01-13 17:36:49 +00001818 if (success)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001819 success = check_func_arg_names(&classfunctions, &objmethods,
1820 &classmembers);
Bram Moolenaard40f00c2023-01-13 17:36:49 +00001821
Bram Moolenaareb533502022-12-14 15:06:11 +00001822 class_T *cl = NULL;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001823 if (success)
1824 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001825 // "endclass" encountered without failures: Create the class.
1826
Bram Moolenaareb533502022-12-14 15:06:11 +00001827 cl = ALLOC_CLEAR_ONE(class_T);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001828 if (cl == NULL)
1829 goto cleanup;
Bram Moolenaar554d0312023-01-05 19:59:18 +00001830 if (!is_class)
1831 cl->class_flags = CLASS_INTERFACE;
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02001832 else if (is_abstract)
1833 cl->class_flags = CLASS_ABSTRACT;
Bram Moolenaar554d0312023-01-05 19:59:18 +00001834
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001835 cl->class_refcount = 1;
Bram Moolenaar94674f22023-01-06 18:42:20 +00001836 cl->class_name = vim_strnsave(name_start, name_end - name_start);
Bram Moolenaard505d172022-12-18 21:42:55 +00001837 if (cl->class_name == NULL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001838 goto cleanup;
Bram Moolenaard505d172022-12-18 21:42:55 +00001839
Bram Moolenaard0200c82023-01-28 15:19:40 +00001840 if (extends_cl != NULL)
1841 {
1842 cl->class_extends = extends_cl;
1843 extends_cl->class_flags |= CLASS_EXTENDED;
1844 }
Bram Moolenaar83677162023-01-08 19:54:10 +00001845
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001846 // Add class and object variables to "cl".
Bram Moolenaard505d172022-12-18 21:42:55 +00001847 if (add_members_to_class(&classmembers,
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001848 NULL,
1849 0,
Bram Moolenaar83677162023-01-08 19:54:10 +00001850 &cl->class_class_members,
1851 &cl->class_class_member_count) == FAIL
Bram Moolenaard505d172022-12-18 21:42:55 +00001852 || add_members_to_class(&objmembers,
Bram Moolenaar83677162023-01-08 19:54:10 +00001853 extends_cl == NULL ? NULL
1854 : extends_cl->class_obj_members,
1855 extends_cl == NULL ? 0
1856 : extends_cl->class_obj_member_count,
1857 &cl->class_obj_members,
1858 &cl->class_obj_member_count) == FAIL)
Bram Moolenaard505d172022-12-18 21:42:55 +00001859 goto cleanup;
1860
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00001861 if (ga_impl.ga_len > 0)
1862 {
1863 // Move the "implements" names into the class.
1864 cl->class_interface_count = ga_impl.ga_len;
1865 cl->class_interfaces = ALLOC_MULT(char_u *, ga_impl.ga_len);
1866 if (cl->class_interfaces == NULL)
1867 goto cleanup;
1868 for (int i = 0; i < ga_impl.ga_len; ++i)
1869 cl->class_interfaces[i] = ((char_u **)ga_impl.ga_data)[i];
1870 VIM_CLEAR(ga_impl.ga_data);
1871 ga_impl.ga_len = 0;
1872
Bram Moolenaard0200c82023-01-28 15:19:40 +00001873 cl->class_interfaces_cl = intf_classes;
1874 intf_classes = NULL;
1875 }
1876
1877 if (cl->class_interface_count > 0 || extends_cl != NULL)
1878 {
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001879 // Add a method and member lookup table to each of the interface
1880 // classes.
1881 if (add_lookup_tables(cl, extends_cl, &objmethods) == FAIL)
1882 goto cleanup;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00001883 }
1884
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001885 // Allocate a typval for each class member and initialize it.
Bram Moolenaar554d0312023-01-05 19:59:18 +00001886 if (is_class && cl->class_class_member_count > 0)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001887 add_class_members(cl, eap);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001888
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02001889 int have_new = FALSE;
1890 ufunc_T *class_func = NULL;
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001891 for (int i = 0; i < classfunctions.ga_len; ++i)
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02001892 {
1893 class_func = ((ufunc_T **)classfunctions.ga_data)[i];
1894 if (STRCMP(class_func->uf_name, "new") == 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001895 {
1896 have_new = TRUE;
1897 break;
1898 }
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02001899 }
1900
1901 if (have_new)
1902 // The return type of new() is an object of class "cl"
1903 class_func->uf_ret_type->tt_class = cl;
1904 else if (is_class && !is_abstract && !have_new)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001905 // No new() method was defined, add the default constructor.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001906 add_default_constructor(cl, &classfunctions, &type_list);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001907
Bram Moolenaar58b40092023-01-11 15:59:05 +00001908 // Move all the functions into the created class.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001909 if (add_classfuncs_objmethods(cl, extends_cl, &classfunctions,
1910 &objmethods) == FAIL)
1911 goto cleanup;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001912
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001913 cl->class_type.tt_type = VAR_CLASS;
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00001914 cl->class_type.tt_class = cl;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001915 cl->class_object_type.tt_type = VAR_OBJECT;
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00001916 cl->class_object_type.tt_class = cl;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001917 cl->class_type_list = type_list;
1918
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02001919 class_created(cl);
1920
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001921 // TODO:
Bram Moolenaard505d172022-12-18 21:42:55 +00001922 // - Fill hashtab with object members and methods ?
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001923
1924 // Add the class to the script-local variables.
Bram Moolenaar94674f22023-01-06 18:42:20 +00001925 // TODO: handle other context, e.g. in a function
Ernie Rael21d32122023-09-02 15:09:18 +02001926 // TODO: does uf_hash need to be cleared?
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001927 typval_T tv;
1928 tv.v_type = VAR_CLASS;
1929 tv.vval.v_class = cl;
Bram Moolenaara86655a2023-01-12 17:06:27 +00001930 is_export = class_export;
Bram Moolenaar83ae6152023-02-25 19:59:31 +00001931 SOURCING_LNUM = start_lnum;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001932 set_var_const(cl->class_name, current_sctx.sc_sid,
Bram Moolenaar83ae6152023-02-25 19:59:31 +00001933 NULL, &tv, FALSE, 0, 0);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001934 return;
1935 }
1936
1937cleanup:
Bram Moolenaareb533502022-12-14 15:06:11 +00001938 if (cl != NULL)
1939 {
1940 vim_free(cl->class_name);
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001941 vim_free(cl->class_class_functions);
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00001942 if (cl->class_interfaces != NULL)
1943 {
1944 for (int i = 0; i < cl->class_interface_count; ++i)
1945 vim_free(cl->class_interfaces[i]);
1946 vim_free(cl->class_interfaces);
1947 }
1948 if (cl->class_interfaces_cl != NULL)
1949 {
1950 for (int i = 0; i < cl->class_interface_count; ++i)
1951 class_unref(cl->class_interfaces_cl[i]);
1952 vim_free(cl->class_interfaces_cl);
1953 }
Bram Moolenaareb533502022-12-14 15:06:11 +00001954 vim_free(cl->class_obj_members);
1955 vim_free(cl->class_obj_methods);
1956 vim_free(cl);
1957 }
1958
Bram Moolenaar83677162023-01-08 19:54:10 +00001959 vim_free(extends);
1960 class_unref(extends_cl);
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00001961
1962 if (intf_classes != NULL)
1963 {
1964 for (int i = 0; i < ga_impl.ga_len; ++i)
1965 class_unref(intf_classes[i]);
1966 vim_free(intf_classes);
1967 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001968 ga_clear_strings(&ga_impl);
1969
Bram Moolenaard505d172022-12-18 21:42:55 +00001970 for (int round = 1; round <= 2; ++round)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001971 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001972 garray_T *gap = round == 1 ? &classmembers : &objmembers;
1973 if (gap->ga_len == 0 || gap->ga_data == NULL)
1974 continue;
1975
1976 for (int i = 0; i < gap->ga_len; ++i)
1977 {
1978 ocmember_T *m = ((ocmember_T *)gap->ga_data) + i;
1979 vim_free(m->ocm_name);
1980 vim_free(m->ocm_init);
1981 }
1982 ga_clear(gap);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001983 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001984
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001985 for (int i = 0; i < objmethods.ga_len; ++i)
1986 {
1987 ufunc_T *uf = ((ufunc_T **)objmethods.ga_data)[i];
1988 func_clear_free(uf, FALSE);
1989 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001990 ga_clear(&objmethods);
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001991
1992 for (int i = 0; i < classfunctions.ga_len; ++i)
1993 {
1994 ufunc_T *uf = ((ufunc_T **)classfunctions.ga_data)[i];
1995 func_clear_free(uf, FALSE);
1996 }
1997 ga_clear(&classfunctions);
1998
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001999 clear_type_list(&type_list);
2000}
2001
2002/*
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002003 * Find member "name" in class "cl", set "member_idx" to the member index and
2004 * return its type.
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002005 * When "is_object" is TRUE, then look for object members. Otherwise look for
2006 * class members.
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002007 * When not found "member_idx" is set to -1 and t_any is returned.
Ernie Rael456ae552023-09-01 18:54:54 +02002008 * Set *p_m ocmmember_T if not NULL
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002009 */
2010 type_T *
2011class_member_type(
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002012 class_T *cl,
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002013 int is_object,
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002014 char_u *name,
2015 char_u *name_end,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002016 int *member_idx)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002017{
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002018 size_t len = name_end - name;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002019 ocmember_T *m;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002020
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002021 *member_idx = -1; // not found (yet)
2022
2023 m = member_lookup(cl, is_object ? VAR_OBJECT : VAR_CLASS, name, len,
2024 member_idx);
2025 if (m == NULL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002026 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002027 member_not_found_msg(cl, is_object ? VAR_OBJECT : VAR_CLASS, name,
2028 len);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002029 return &t_any;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002030 }
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002031
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002032 return m->ocm_type;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002033}
2034
2035/*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002036 * Handle ":enum" up to ":endenum".
2037 */
2038 void
2039ex_enum(exarg_T *eap UNUSED)
2040{
2041 // TODO
2042}
2043
2044/*
2045 * Handle ":type".
2046 */
2047 void
2048ex_type(exarg_T *eap UNUSED)
2049{
2050 // TODO
2051}
2052
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002053/*
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002054 * Returns OK if a member variable named "name" is present in the class "cl".
2055 * Otherwise returns FAIL. If found, the member variable typval is set in
2056 * "rettv". If "is_object" is TRUE, then the object member variable table is
2057 * searched. Otherwise the class member variable table is searched.
2058 */
2059 static int
2060get_member_tv(
2061 class_T *cl,
2062 int is_object,
2063 char_u *name,
2064 size_t namelen,
2065 typval_T *rettv)
2066{
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002067 ocmember_T *m;
2068 int m_idx;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002069
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002070 m = member_lookup(cl, is_object ? VAR_OBJECT : VAR_CLASS, name, namelen,
2071 &m_idx);
2072 if (m == NULL)
2073 return FAIL;
2074
2075 if (*name == '_')
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002076 {
RestorerZ7fe8f432023-09-24 23:21:24 +02002077 semsg(_(e_cannot_access_private_variable_str), m->ocm_name);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002078 return FAIL;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002079 }
2080
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002081 // The object only contains a pointer to the class, the member
2082 // values array follows right after that.
2083 object_T *obj = rettv->vval.v_object;
2084 if (is_object)
2085 {
2086 typval_T *tv = (typval_T *)(obj + 1) + m_idx;
2087 copy_tv(tv, rettv);
2088 }
2089 else
2090 copy_tv(&cl->class_members_tv[m_idx], rettv);
2091
2092 object_unref(obj);
2093
2094 return OK;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002095}
2096
2097/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002098 * Evaluate what comes after a class:
2099 * - class member: SomeClass.varname
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002100 * - class function: SomeClass.SomeMethod()
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002101 * - class constructor: SomeClass.new()
2102 * - object member: someObject.varname
2103 * - object method: someObject.SomeMethod()
2104 *
2105 * "*arg" points to the '.'.
2106 * "*arg" is advanced to after the member name or method call.
2107 *
2108 * Returns FAIL or OK.
2109 */
2110 int
2111class_object_index(
2112 char_u **arg,
2113 typval_T *rettv,
2114 evalarg_T *evalarg,
2115 int verbose UNUSED) // give error messages
2116{
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002117 if (VIM_ISWHITE((*arg)[1]))
2118 {
2119 semsg(_(e_no_white_space_allowed_after_str_str), ".", *arg);
2120 return FAIL;
2121 }
2122
2123 ++*arg;
2124 char_u *name = *arg;
2125 char_u *name_end = find_name_end(name, NULL, NULL, FNE_CHECK_START);
2126 if (name_end == name)
2127 return FAIL;
2128 size_t len = name_end - name;
2129
Bram Moolenaar552bdca2023-02-17 21:08:50 +00002130 class_T *cl;
2131 if (rettv->v_type == VAR_CLASS)
2132 cl = rettv->vval.v_class;
2133 else // VAR_OBJECT
2134 {
2135 if (rettv->vval.v_object == NULL)
2136 {
2137 emsg(_(e_using_null_object));
2138 return FAIL;
2139 }
2140 cl = rettv->vval.v_object->obj_class;
2141 }
2142
Bram Moolenaard13dd302023-03-11 20:56:35 +00002143 if (cl == NULL)
2144 {
2145 emsg(_(e_incomplete_type));
2146 return FAIL;
2147 }
2148
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002149 if (*name_end == '(')
2150 {
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002151 ufunc_T *fp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002152
Ernie Rael4d00b832023-09-11 19:54:42 +02002153 fp = method_lookup(cl, rettv->v_type, name, len, NULL);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002154 if (fp == NULL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002155 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002156 method_not_found_msg(cl, rettv->v_type, name, len);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002157 return FAIL;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002158 }
2159
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002160 typval_T argvars[MAX_FUNC_ARGS + 1];
2161 int argcount = 0;
2162
2163 if (*fp->uf_name == '_')
2164 {
2165 // Cannot access a private method outside of a class
2166 semsg(_(e_cannot_access_private_method_str), name);
2167 return FAIL;
2168 }
2169
2170 char_u *argp = name_end;
2171 int ret = get_func_arguments(&argp, evalarg, 0,
2172 argvars, &argcount);
2173 if (ret == FAIL)
2174 return FAIL;
2175
2176 funcexe_T funcexe;
2177 CLEAR_FIELD(funcexe);
2178 funcexe.fe_evaluate = TRUE;
2179 if (rettv->v_type == VAR_OBJECT)
2180 {
2181 funcexe.fe_object = rettv->vval.v_object;
2182 ++funcexe.fe_object->obj_refcount;
2183 }
2184
2185 // Clear the class or object after calling the function, in
2186 // case the refcount is one.
2187 typval_T tv_tofree = *rettv;
2188 rettv->v_type = VAR_UNKNOWN;
2189
2190 // Call the user function. Result goes into rettv;
2191 int error = call_user_func_check(fp, argcount, argvars,
2192 rettv, &funcexe, NULL);
2193
2194 // Clear the previous rettv and the arguments.
2195 clear_tv(&tv_tofree);
2196 for (int idx = 0; idx < argcount; ++idx)
2197 clear_tv(&argvars[idx]);
2198
2199 if (error != FCERR_NONE)
2200 {
2201 user_func_error(error, printable_func_name(fp),
2202 funcexe.fe_found_var);
2203 return FAIL;
2204 }
2205 *arg = argp;
2206 return OK;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002207 }
2208
2209 else if (rettv->v_type == VAR_OBJECT)
2210 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002211 // Search in the object member variable table and the class member
2212 // variable table.
Yegappan Lakshmanan23c92d92023-09-09 11:33:29 +02002213 if (get_member_tv(cl, TRUE, name, len, rettv) == OK)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002214 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002215 *arg = name_end;
2216 return OK;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002217 }
2218
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002219 member_not_found_msg(cl, VAR_OBJECT, name, len);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002220 }
2221
Bram Moolenaard505d172022-12-18 21:42:55 +00002222 else if (rettv->v_type == VAR_CLASS)
2223 {
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002224 int m_idx;
2225
Bram Moolenaard505d172022-12-18 21:42:55 +00002226 // class member
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002227 ocmember_T *m = class_member_lookup(cl, name, len, &m_idx);
2228 if (m == NULL)
Bram Moolenaard505d172022-12-18 21:42:55 +00002229 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002230 member_not_found_msg(cl, VAR_CLASS, name, len);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002231 return FAIL;
Bram Moolenaard505d172022-12-18 21:42:55 +00002232 }
2233
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002234 if (*name == '_')
2235 {
RestorerZ7fe8f432023-09-24 23:21:24 +02002236 semsg(_(e_cannot_access_private_variable_str), m->ocm_name);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002237 return FAIL;
2238 }
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002239
2240 typval_T *tv = &cl->class_members_tv[m_idx];
2241 copy_tv(tv, rettv);
2242 class_unref(cl);
2243
2244 *arg = name_end;
2245 return OK;
Bram Moolenaard505d172022-12-18 21:42:55 +00002246 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002247
2248 return FAIL;
2249}
2250
2251/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002252 * If "arg" points to a class or object method, return it.
2253 * Otherwise return NULL.
2254 */
2255 ufunc_T *
2256find_class_func(char_u **arg)
2257{
2258 char_u *name = *arg;
2259 char_u *name_end = find_name_end(name, NULL, NULL, FNE_CHECK_START);
2260 if (name_end == name || *name_end != '.')
2261 return NULL;
2262
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002263 ufunc_T *fp = NULL;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002264 size_t len = name_end - name;
2265 typval_T tv;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002266 tv.v_type = VAR_UNKNOWN;
Bram Moolenaar993dbc32023-01-01 20:31:30 +00002267 if (eval_variable(name, (int)len,
2268 0, &tv, NULL, EVAL_VAR_NOAUTOLOAD) == FAIL)
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002269 return NULL;
2270 if (tv.v_type != VAR_CLASS && tv.v_type != VAR_OBJECT)
Bram Moolenaareb533502022-12-14 15:06:11 +00002271 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002272
2273 class_T *cl = tv.v_type == VAR_CLASS ? tv.vval.v_class
2274 : tv.vval.v_object->obj_class;
2275 if (cl == NULL)
Bram Moolenaareb533502022-12-14 15:06:11 +00002276 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002277 char_u *fname = name_end + 1;
2278 char_u *fname_end = find_name_end(fname, NULL, NULL, FNE_CHECK_START);
2279 if (fname_end == fname)
Bram Moolenaareb533502022-12-14 15:06:11 +00002280 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002281 len = fname_end - fname;
2282
Ernie Rael4d00b832023-09-11 19:54:42 +02002283 fp = method_lookup(cl, tv.v_type, fname, len, NULL);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002284
Bram Moolenaareb533502022-12-14 15:06:11 +00002285fail_after_eval:
2286 clear_tv(&tv);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002287 return fp;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002288}
2289
2290/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002291 * Returns the index of class variable "name" in the class "cl".
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002292 * Returns -1, if the variable is not found.
2293 * If "namelen" is zero, then it is assumed that "name" is NUL terminated.
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002294 */
2295 int
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002296class_member_idx(class_T *cl, char_u *name, size_t namelen)
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002297{
Ernie Rael4d00b832023-09-11 19:54:42 +02002298 int idx;
2299 class_member_lookup(cl, name, namelen, &idx);
2300 return idx;
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002301}
2302
2303/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002304 * Returns a pointer to the class member variable "name" in the class "cl".
2305 * Returns NULL if the variable is not found.
2306 * The member variable index is set in "idx".
2307 */
2308 ocmember_T *
2309class_member_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
2310{
Ernie Rael4d00b832023-09-11 19:54:42 +02002311 ocmember_T *ret_m = NULL;
2312 int ret_idx = -1;
2313 for (int i = 0; i < cl->class_class_member_count; ++i)
2314 {
2315 ocmember_T *m = &cl->class_class_members[i];
2316 if (namelen)
2317 {
2318 if (STRNCMP(name, m->ocm_name, namelen) == 0
2319 && m->ocm_name[namelen] == NUL)
2320 {
2321 ret_m = m;
2322 ret_idx = i;
2323 break;
2324 }
2325 }
2326 else if (STRCMP(name, m->ocm_name) == 0)
2327 {
2328 ret_m = m;
2329 ret_idx = i;
2330 break;
2331 }
2332 }
2333 if (idx != NULL)
2334 *idx = ret_idx;
2335 return ret_m;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002336}
2337
2338/*
2339 * Returns the index of class method "name" in the class "cl".
2340 * Returns -1, if the method is not found.
Yegappan Lakshmanan342f4f62023-09-09 11:37:23 +02002341 */
2342 int
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002343class_method_idx(class_T *cl, char_u *name, size_t namelen)
Yegappan Lakshmanan342f4f62023-09-09 11:37:23 +02002344{
Ernie Rael4d00b832023-09-11 19:54:42 +02002345 int idx;
2346 class_method_lookup(cl, name, namelen, &idx);
2347 return idx;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002348}
2349
2350/*
2351 * Returns a pointer to the class method "name" in class "cl".
2352 * Returns NULL if the method is not found.
2353 * The method index is set in "idx".
2354 */
2355 ufunc_T *
2356class_method_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
2357{
Ernie Rael4d00b832023-09-11 19:54:42 +02002358 ufunc_T *ret_fp = NULL;
2359 int ret_idx = -1;
2360 for (int i = 0; i < cl->class_class_function_count; ++i)
2361 {
2362 ufunc_T *fp = cl->class_class_functions[i];
2363 char_u *ufname = (char_u *)fp->uf_name;
2364 if (STRNCMP(name, ufname, namelen) == 0 && ufname[namelen] == NUL)
2365 {
2366 ret_fp = fp;
2367 ret_idx = i;
2368 break;
2369 }
2370 }
2371 if (idx != NULL)
2372 *idx = ret_idx;
2373 return ret_fp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002374}
2375
2376/*
2377 * Returns the index of object member variable "name" in the class "cl".
2378 * Returns -1, if the variable is not found.
2379 * If "namelen" is zero, then it is assumed that "name" is NUL terminated.
2380 */
2381 int
2382object_member_idx(class_T *cl, char_u *name, size_t namelen)
2383{
Ernie Rael4d00b832023-09-11 19:54:42 +02002384 int idx;
2385 object_member_lookup(cl, name, namelen, &idx);
2386 return idx;
Yegappan Lakshmanan342f4f62023-09-09 11:37:23 +02002387}
2388
2389/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002390 * Returns a pointer to the object member variable "name" in the class "cl".
2391 * Returns NULL if the variable is not found.
2392 * The object member variable index is set in "idx".
2393 */
2394 ocmember_T *
2395object_member_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
2396{
Ernie Rael4d00b832023-09-11 19:54:42 +02002397 ocmember_T *ret_m = NULL;
2398 int ret_idx = -1;
2399 for (int i = 0; i < cl->class_obj_member_count; ++i)
2400 {
2401 ocmember_T *m = &cl->class_obj_members[i];
2402 if (namelen)
2403 {
2404 if (STRNCMP(name, m->ocm_name, namelen) == 0
2405 && m->ocm_name[namelen] == NUL)
2406 {
2407 ret_m = m;
2408 ret_idx = i;
2409 break;
2410 }
2411 }
2412 else if (STRCMP(name, m->ocm_name) == 0)
2413 {
2414 ret_m = m;
2415 ret_idx = i;
2416 break;
2417 }
2418 }
2419 if (idx != NULL)
2420 *idx = ret_idx;
2421 return ret_m;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002422}
2423
2424/*
2425 * Returns the index of object method "name" in the class "cl".
2426 * Returns -1, if the method is not found.
2427 */
2428 int
2429object_method_idx(class_T *cl, char_u *name, size_t namelen)
2430{
Ernie Rael4d00b832023-09-11 19:54:42 +02002431 int idx;
2432 object_method_lookup(cl, name, namelen, &idx);
2433 return idx;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002434}
2435
2436/*
2437 * Returns a pointer to the object method "name" in class "cl".
2438 * Returns NULL if the method is not found.
2439 * The object method index is set in "idx".
2440 */
2441 ufunc_T *
2442object_method_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
2443{
Ernie Rael4d00b832023-09-11 19:54:42 +02002444 ufunc_T *ret_fp = NULL;
2445 int ret_idx = -1;
2446 for (int i = 0; i < cl->class_obj_method_count; ++i)
2447 {
2448 ufunc_T *fp = cl->class_obj_methods[i];
2449 // Use a separate pointer to avoid that ASAN complains about
2450 // uf_name[] only being 4 characters.
2451 char_u *ufname = (char_u *)fp->uf_name;
2452 if (STRNCMP(name, ufname, namelen) == 0 && ufname[namelen] == NUL)
2453 {
2454 ret_fp = fp;
2455 ret_idx = i;
2456 break;
2457 }
2458 }
2459 if (idx != NULL)
2460 *idx = ret_idx;
2461 return ret_fp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002462}
2463
2464/*
2465 * Lookup a class or object member variable by name. If v_type is VAR_CLASS,
2466 * then lookup a class member variable and if it is VAR_OBJECT, then lookup a
2467 * object member variable.
2468 *
2469 * Returns a pointer to the member variable structure if variable is found.
2470 * Otherwise returns NULL. The member variable index is set in "*idx".
2471 */
2472 ocmember_T *
2473member_lookup(
2474 class_T *cl,
2475 vartype_T v_type,
2476 char_u *name,
2477 size_t namelen,
2478 int *idx)
2479{
2480 if (v_type == VAR_CLASS)
2481 return class_member_lookup(cl, name, namelen, idx);
2482 else
2483 return object_member_lookup(cl, name, namelen, idx);
2484}
2485
2486/*
2487 * Lookup a class or object method by name. If v_type is VAR_CLASS, then
2488 * lookup a class method and if it is VAR_OBJECT, then lookup a object method.
2489 *
2490 * Returns a pointer to the method structure if variable is found.
2491 * Otherwise returns NULL. The method variable index is set in "*idx".
2492 */
2493 ufunc_T *
2494method_lookup(
2495 class_T *cl,
2496 vartype_T v_type,
2497 char_u *name,
2498 size_t namelen,
2499 int *idx)
2500{
2501 if (v_type == VAR_CLASS)
2502 return class_method_lookup(cl, name, namelen, idx);
2503 else
2504 return object_method_lookup(cl, name, namelen, idx);
2505}
2506
2507/*
Bram Moolenaar62a69232023-01-24 15:07:04 +00002508 * Return TRUE if current context "cctx_arg" is inside class "cl".
2509 * Return FALSE if not.
2510 */
2511 int
2512inside_class(cctx_T *cctx_arg, class_T *cl)
2513{
2514 for (cctx_T *cctx = cctx_arg; cctx != NULL; cctx = cctx->ctx_outer)
Ernie Raelcf138d42023-09-06 20:45:03 +02002515 if (cctx->ctx_ufunc != NULL
2516 && class_instance_of(cctx->ctx_ufunc->uf_class, cl))
Bram Moolenaar62a69232023-01-24 15:07:04 +00002517 return TRUE;
2518 return FALSE;
2519}
2520
2521/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002522 * Make a copy of an object.
2523 */
2524 void
2525copy_object(typval_T *from, typval_T *to)
2526{
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02002527 if (from->vval.v_object == NULL)
2528 to->vval.v_object = NULL;
2529 else
2530 {
2531 to->vval.v_object = from->vval.v_object;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002532 ++to->vval.v_object->obj_refcount;
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02002533 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002534}
2535
2536/*
2537 * Free an object.
2538 */
2539 static void
2540object_clear(object_T *obj)
2541{
Bram Moolenaarf7ca56f2023-06-05 16:53:25 +01002542 // Avoid a recursive call, it can happen if "obj" has a circular reference.
2543 obj->obj_refcount = INT_MAX;
2544
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002545 class_T *cl = obj->obj_class;
2546
Jia-Ju Bai5b0889b2023-08-13 20:04:04 +02002547 if (!cl)
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +02002548 return;
Jia-Ju Bai5b0889b2023-08-13 20:04:04 +02002549
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002550 // the member values are just after the object structure
2551 typval_T *tv = (typval_T *)(obj + 1);
2552 for (int i = 0; i < cl->class_obj_member_count; ++i)
2553 clear_tv(tv + i);
2554
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002555 // Remove from the list headed by "first_object".
2556 object_cleared(obj);
2557
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002558 vim_free(obj);
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002559 class_unref(cl);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002560}
2561
2562/*
2563 * Unreference an object.
2564 */
2565 void
2566object_unref(object_T *obj)
2567{
2568 if (obj != NULL && --obj->obj_refcount <= 0)
2569 object_clear(obj);
2570}
2571
2572/*
2573 * Make a copy of a class.
2574 */
2575 void
2576copy_class(typval_T *from, typval_T *to)
2577{
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02002578 if (from->vval.v_class == NULL)
2579 to->vval.v_class = NULL;
2580 else
2581 {
2582 to->vval.v_class = from->vval.v_class;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002583 ++to->vval.v_class->class_refcount;
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02002584 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002585}
2586
2587/*
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02002588 * Free the class "cl" and its contents.
2589 */
2590 static void
2591class_free(class_T *cl)
2592{
2593 // Freeing what the class contains may recursively come back here.
2594 // Clear "class_name" first, if it is NULL the class does not need to
2595 // be freed.
2596 VIM_CLEAR(cl->class_name);
2597
2598 class_unref(cl->class_extends);
2599
2600 for (int i = 0; i < cl->class_interface_count; ++i)
2601 {
2602 vim_free(((char_u **)cl->class_interfaces)[i]);
2603 if (cl->class_interfaces_cl[i] != NULL)
2604 class_unref(cl->class_interfaces_cl[i]);
2605 }
2606 vim_free(cl->class_interfaces);
2607 vim_free(cl->class_interfaces_cl);
2608
2609 itf2class_T *next;
2610 for (itf2class_T *i2c = cl->class_itf2class; i2c != NULL; i2c = next)
2611 {
2612 next = i2c->i2c_next;
2613 vim_free(i2c);
2614 }
2615
2616 for (int i = 0; i < cl->class_class_member_count; ++i)
2617 {
2618 ocmember_T *m = &cl->class_class_members[i];
2619 vim_free(m->ocm_name);
2620 vim_free(m->ocm_init);
2621 if (cl->class_members_tv != NULL)
2622 clear_tv(&cl->class_members_tv[i]);
2623 }
2624 vim_free(cl->class_class_members);
2625 vim_free(cl->class_members_tv);
2626
2627 for (int i = 0; i < cl->class_obj_member_count; ++i)
2628 {
2629 ocmember_T *m = &cl->class_obj_members[i];
2630 vim_free(m->ocm_name);
2631 vim_free(m->ocm_init);
2632 }
2633 vim_free(cl->class_obj_members);
2634
2635 for (int i = 0; i < cl->class_class_function_count; ++i)
2636 {
2637 ufunc_T *uf = cl->class_class_functions[i];
2638 func_clear_free(uf, FALSE);
2639 }
2640 vim_free(cl->class_class_functions);
2641
2642 for (int i = 0; i < cl->class_obj_method_count; ++i)
2643 {
2644 ufunc_T *uf = cl->class_obj_methods[i];
2645 func_clear_free(uf, FALSE);
2646 }
2647 vim_free(cl->class_obj_methods);
2648
2649 clear_type_list(&cl->class_type_list);
2650
2651 class_cleared(cl);
2652
2653 vim_free(cl);
2654}
2655
2656/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002657 * Unreference a class. Free it when the reference count goes down to zero.
2658 */
2659 void
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002660class_unref(class_T *cl)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002661{
Bram Moolenaard505d172022-12-18 21:42:55 +00002662 if (cl != NULL && --cl->class_refcount <= 0 && cl->class_name != NULL)
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02002663 class_free(cl);
2664}
2665
2666/*
2667 * Go through the list of all classes and free items without "copyID".
2668 */
2669 int
2670class_free_nonref(int copyID)
2671{
2672 int did_free = FALSE;
2673
2674 for (class_T *cl = first_class; cl != NULL; cl = next_nonref_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002675 {
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02002676 next_nonref_class = cl->class_next_used;
2677 if ((cl->class_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00002678 {
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02002679 // Free the class and items it contains.
2680 class_free(cl);
2681 did_free = TRUE;
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00002682 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002683 }
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02002684
2685 next_nonref_class = NULL;
2686 return did_free;
2687}
2688
2689 int
2690set_ref_in_classes(int copyID)
2691{
2692 for (class_T *cl = first_class; cl != NULL; cl = cl->class_next_used)
2693 set_ref_in_item_class(cl, copyID, NULL, NULL);
2694
2695 return FALSE;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002696}
2697
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002698static object_T *first_object = NULL;
2699
2700/*
2701 * Call this function when an object has been created. It will be added to the
2702 * list headed by "first_object".
2703 */
2704 void
2705object_created(object_T *obj)
2706{
2707 if (first_object != NULL)
2708 {
2709 obj->obj_next_used = first_object;
2710 first_object->obj_prev_used = obj;
2711 }
2712 first_object = obj;
2713}
2714
Bram Moolenaarf7ca56f2023-06-05 16:53:25 +01002715static object_T *next_nonref_obj = NULL;
2716
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002717/*
2718 * Call this function when an object has been cleared and is about to be freed.
2719 * It is removed from the list headed by "first_object".
2720 */
2721 void
2722object_cleared(object_T *obj)
2723{
2724 if (obj->obj_next_used != NULL)
2725 obj->obj_next_used->obj_prev_used = obj->obj_prev_used;
2726 if (obj->obj_prev_used != NULL)
2727 obj->obj_prev_used->obj_next_used = obj->obj_next_used;
2728 else if (first_object == obj)
2729 first_object = obj->obj_next_used;
Bram Moolenaarf7ca56f2023-06-05 16:53:25 +01002730
2731 // update the next object to check if needed
2732 if (obj == next_nonref_obj)
2733 next_nonref_obj = obj->obj_next_used;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002734}
2735
2736/*
2737 * Go through the list of all objects and free items without "copyID".
2738 */
2739 int
2740object_free_nonref(int copyID)
2741{
2742 int did_free = FALSE;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002743
Bram Moolenaarf7ca56f2023-06-05 16:53:25 +01002744 for (object_T *obj = first_object; obj != NULL; obj = next_nonref_obj)
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002745 {
Bram Moolenaarf7ca56f2023-06-05 16:53:25 +01002746 next_nonref_obj = obj->obj_next_used;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002747 if ((obj->obj_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
2748 {
2749 // Free the object and items it contains.
2750 object_clear(obj);
2751 did_free = TRUE;
2752 }
2753 }
2754
Bram Moolenaarf7ca56f2023-06-05 16:53:25 +01002755 next_nonref_obj = NULL;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00002756 return did_free;
2757}
2758
LemonBoyafe04662023-08-23 21:08:11 +02002759/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002760 * Echo a class or object method not found message.
2761 */
2762 void
2763method_not_found_msg(class_T *cl, vartype_T v_type, char_u *name, size_t len)
2764{
2765 char_u *method_name = vim_strnsave(name, len);
2766 if ((v_type == VAR_OBJECT)
2767 && (class_method_idx(cl, name, len) >= 0))
2768 {
2769 // If this is a class method, then give a different error
2770 if (*name == '_')
2771 semsg(_(e_cannot_access_private_method_str), method_name);
2772 else
RestorerZ7fe8f432023-09-24 23:21:24 +02002773 semsg(_(e_class_method_str_accessible_only_using_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002774 method_name, cl->class_name);
2775 }
2776 else if ((v_type == VAR_CLASS)
2777 && (object_method_idx(cl, name, len) >= 0))
2778 {
2779 // If this is an object method, then give a different error
2780 if (*name == '_')
2781 semsg(_(e_cannot_access_private_method_str), method_name);
2782 else
RestorerZ7fe8f432023-09-24 23:21:24 +02002783 semsg(_(e_object_method_str_accessible_only_using_object_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002784 method_name, cl->class_name);
2785 }
2786 else
2787 semsg(_(e_method_not_found_on_class_str_str), cl->class_name,
2788 method_name);
2789 vim_free(method_name);
2790}
2791
2792/*
2793 * Echo a class or object member not found message.
2794 */
2795 void
2796member_not_found_msg(class_T *cl, vartype_T v_type, char_u *name, size_t len)
2797{
2798 char_u *varname = len ? vim_strnsave(name, len) : vim_strsave(name);
2799
2800 if (v_type == VAR_OBJECT)
2801 {
2802 if (class_member_idx(cl, name, len) >= 0)
RestorerZ7fe8f432023-09-24 23:21:24 +02002803 semsg(_(e_class_variable_str_accessible_only_using_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002804 varname, cl->class_name);
2805 else
RestorerZ7fe8f432023-09-24 23:21:24 +02002806 semsg(_(e_variable_not_found_on_object_str_str), cl->class_name,
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002807 varname);
2808 }
2809 else
2810 {
2811 if (object_member_idx(cl, name, len) >= 0)
RestorerZ7fe8f432023-09-24 23:21:24 +02002812 semsg(_(e_object_variable_str_accessible_only_using_object_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002813 varname, cl->class_name);
2814 else
RestorerZ7fe8f432023-09-24 23:21:24 +02002815 semsg(_(e_class_variable_str_not_found_in_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002816 varname, cl->class_name);
2817 }
2818 vim_free(varname);
2819}
2820
2821/*
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +02002822 * Return TRUE when the class "cl", its base class or one of the implemented
2823 * interfaces matches the class "other_cl".
LemonBoyafe04662023-08-23 21:08:11 +02002824 */
2825 int
2826class_instance_of(class_T *cl, class_T *other_cl)
2827{
2828 if (cl == other_cl)
2829 return TRUE;
2830
2831 // Recursively check the base classes.
2832 for (; cl != NULL; cl = cl->class_extends)
2833 {
2834 if (cl == other_cl)
2835 return TRUE;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002836 // Check the implemented interfaces and the super interfaces
LemonBoyafe04662023-08-23 21:08:11 +02002837 for (int i = cl->class_interface_count - 1; i >= 0; --i)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002838 {
2839 class_T *intf = cl->class_interfaces_cl[i];
2840 while (intf != NULL)
2841 {
2842 if (intf == other_cl)
2843 return TRUE;
2844 // check the super interfaces
2845 intf = intf->class_extends;
2846 }
2847 }
LemonBoyafe04662023-08-23 21:08:11 +02002848 }
2849
2850 return FALSE;
2851}
2852
2853/*
2854 * "instanceof(object, classinfo)" function
2855 */
2856 void
2857f_instanceof(typval_T *argvars, typval_T *rettv)
2858{
2859 typval_T *object_tv = &argvars[0];
2860 typval_T *classinfo_tv = &argvars[1];
2861 listitem_T *li;
2862
2863 rettv->vval.v_number = VVAL_FALSE;
2864
2865 if (check_for_object_arg(argvars, 0) == FAIL
2866 || check_for_class_or_list_arg(argvars, 1) == FAIL)
2867 return;
2868
Ernie Rael3da696d2023-09-19 20:14:18 +02002869 if (object_tv->vval.v_object == NULL)
2870 return;
2871
LemonBoyafe04662023-08-23 21:08:11 +02002872 if (classinfo_tv->v_type == VAR_LIST)
2873 {
2874 FOR_ALL_LIST_ITEMS(classinfo_tv->vval.v_list, li)
2875 {
2876 if (li->li_tv.v_type != VAR_CLASS)
2877 {
2878 emsg(_(e_class_required));
2879 return;
2880 }
2881
2882 if (class_instance_of(object_tv->vval.v_object->obj_class,
2883 li->li_tv.vval.v_class) == TRUE)
2884 {
2885 rettv->vval.v_number = VVAL_TRUE;
2886 return;
2887 }
2888 }
2889 }
2890 else if (classinfo_tv->v_type == VAR_CLASS)
2891 {
2892 rettv->vval.v_number = class_instance_of(object_tv->vval.v_object->obj_class,
2893 classinfo_tv->vval.v_class);
2894 }
2895}
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002896
2897#endif // FEAT_EVAL