blob: 4314b52901d6799424eaa0d1000b82fbd19904eb [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 Lakshmananfe7b20a2023-10-04 19:47:52 +020075 int *has_type,
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +020076 garray_T *type_list,
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +020077 type_T **type_ret,
78 char_u **init_expr)
Bram Moolenaard505d172022-12-18 21:42:55 +000079{
80 *varname_end = to_name_end(varname, FALSE);
81 if (*varname == '_' && has_public)
82 {
RestorerZ7fe8f432023-09-24 23:21:24 +020083 semsg(_(e_public_variable_name_cannot_start_with_underscore_str), line);
Bram Moolenaard505d172022-12-18 21:42:55 +000084 return FAIL;
85 }
86
87 char_u *colon = skipwhite(*varname_end);
88 char_u *type_arg = colon;
89 type_T *type = NULL;
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +020090 *has_type = FALSE;
Bram Moolenaard505d172022-12-18 21:42:55 +000091 if (*colon == ':')
92 {
93 if (VIM_ISWHITE(**varname_end))
94 {
95 semsg(_(e_no_white_space_allowed_before_colon_str), varname);
96 return FAIL;
97 }
98 if (!VIM_ISWHITE(colon[1]))
99 {
100 semsg(_(e_white_space_required_after_str_str), ":", varname);
101 return FAIL;
102 }
103 type_arg = skipwhite(colon + 1);
104 type = parse_type(&type_arg, type_list, TRUE);
105 if (type == NULL)
106 return FAIL;
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +0200107 *has_type = TRUE;
Bram Moolenaard505d172022-12-18 21:42:55 +0000108 }
109
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200110 char_u *init_arg = skipwhite(type_arg);
111 if (type == NULL && *init_arg != '=')
Bram Moolenaard505d172022-12-18 21:42:55 +0000112 {
113 emsg(_(e_type_or_initialization_required));
114 return FAIL;
115 }
116
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200117 if (init_expr == NULL && *init_arg == '=')
Bram Moolenaard505d172022-12-18 21:42:55 +0000118 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200119 emsg(_(e_cannot_initialize_variable_in_interface));
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200120 return FAIL;
121 }
122
123 if (*init_arg == '=')
124 {
125 evalarg_T evalarg;
126 char_u *expr_start, *expr_end;
127
128 if (!VIM_ISWHITE(init_arg[-1]) || !VIM_ISWHITE(init_arg[1]))
Bram Moolenaard505d172022-12-18 21:42:55 +0000129 {
130 semsg(_(e_white_space_required_before_and_after_str_at_str),
131 "=", type_arg);
132 return FAIL;
133 }
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200134 init_arg = skipwhite(init_arg + 1);
Bram Moolenaard505d172022-12-18 21:42:55 +0000135
Bram Moolenaard505d172022-12-18 21:42:55 +0000136 fill_evalarg_from_eap(&evalarg, eap, FALSE);
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200137 (void)skip_expr_concatenate(&init_arg, &expr_start, &expr_end, &evalarg);
Bram Moolenaard505d172022-12-18 21:42:55 +0000138
Yegappan Lakshmananac773182024-04-27 11:36:12 +0200139 init_arg = skipwhite(init_arg);
140 if (*init_arg != NUL)
141 {
142 semsg(_(e_trailing_characters_str), init_arg);
143 return FAIL;
144 }
145
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +0200146 // No type specified for the member. Set it to "any" and the correct
147 // type will be set when the object is instantiated.
Bram Moolenaard505d172022-12-18 21:42:55 +0000148 if (type == NULL)
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200149 type = &t_any;
Bram Moolenaard505d172022-12-18 21:42:55 +0000150
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200151 *init_expr = vim_strnsave(expr_start, expr_end - expr_start);
152 // Free the memory pointed by expr_start.
Bram Moolenaard505d172022-12-18 21:42:55 +0000153 clear_evalarg(&evalarg, NULL);
154 }
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200155 else if (!valid_declaration_type(type))
Bram Moolenaard505d172022-12-18 21:42:55 +0000156 return FAIL;
157
158 *type_ret = type;
Bram Moolenaard505d172022-12-18 21:42:55 +0000159 return OK;
160}
161
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +0100162typedef struct oc_newmember_S oc_newmember_T;
163struct oc_newmember_S
164{
165 garray_T *gap;
166 char_u *varname;
167 char_u *varname_end;
168 int has_public;
169 int has_final;
170 int has_type;
171 type_T *type;
172 char_u *init_expr;
173};
174
Bram Moolenaard505d172022-12-18 21:42:55 +0000175/*
176 * Add a member to an object or a class.
177 * Returns OK when successful, "init_expr" will be consumed then.
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +0100178 * Returns OK on success and FAIL on memory allocation failure (caller might
179 * need to free "init_expr").
Bram Moolenaard505d172022-12-18 21:42:55 +0000180 */
181 static int
182add_member(
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +0200183 garray_T *gap,
184 char_u *varname,
185 char_u *varname_end,
186 int has_public,
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +0100187 int has_final,
188 int has_const,
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +0200189 int has_type,
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +0200190 type_T *type,
191 char_u *init_expr)
Bram Moolenaard505d172022-12-18 21:42:55 +0000192{
193 if (ga_grow(gap, 1) == FAIL)
194 return FAIL;
195 ocmember_T *m = ((ocmember_T *)gap->ga_data) + gap->ga_len;
196 m->ocm_name = vim_strnsave(varname, varname_end - varname);
=?UTF-8?q?Ola=20S=C3=B6der?=d8742472023-03-05 13:12:32 +0000197 m->ocm_access = has_public ? VIM_ACCESS_ALL
198 : *varname == '_' ? VIM_ACCESS_PRIVATE : VIM_ACCESS_READ;
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +0100199 if (has_final)
200 m->ocm_flags |= OCMFLAG_FINAL;
201 if (has_const)
202 m->ocm_flags |= OCMFLAG_CONST;
203 if (has_type)
204 m->ocm_flags |= OCMFLAG_HAS_TYPE;
Bram Moolenaard505d172022-12-18 21:42:55 +0000205 m->ocm_type = type;
206 if (init_expr != NULL)
207 m->ocm_init = init_expr;
208 ++gap->ga_len;
209 return OK;
210}
211
212/*
213 * Move the class or object members found while parsing a class into the class.
214 * "gap" contains the found members.
Bram Moolenaar83677162023-01-08 19:54:10 +0000215 * "parent_members" points to the members in the parent class (if any)
216 * "parent_count" is the number of members in the parent class
Bram Moolenaard505d172022-12-18 21:42:55 +0000217 * "members" will be set to the newly allocated array of members and
218 * "member_count" set to the number of members.
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +0100219 * Returns OK on success and FAIL on memory allocation failure.
Bram Moolenaard505d172022-12-18 21:42:55 +0000220 */
221 static int
222add_members_to_class(
223 garray_T *gap,
Bram Moolenaar83677162023-01-08 19:54:10 +0000224 ocmember_T *parent_members,
225 int parent_count,
Bram Moolenaard505d172022-12-18 21:42:55 +0000226 ocmember_T **members,
227 int *member_count)
228{
Bram Moolenaar83677162023-01-08 19:54:10 +0000229 *member_count = parent_count + gap->ga_len;
230 *members = *member_count == 0 ? NULL
231 : ALLOC_MULT(ocmember_T, *member_count);
232 if (*member_count > 0 && *members == NULL)
Bram Moolenaard505d172022-12-18 21:42:55 +0000233 return FAIL;
Bram Moolenaar83677162023-01-08 19:54:10 +0000234 for (int i = 0; i < parent_count; ++i)
235 {
236 // parent members need to be copied
Bram Moolenaarae3205a2023-01-15 20:49:00 +0000237 ocmember_T *m = *members + i;
238 *m = parent_members[i];
239 m->ocm_name = vim_strsave(m->ocm_name);
240 if (m->ocm_init != NULL)
241 m->ocm_init = vim_strsave(m->ocm_init);
Bram Moolenaar83677162023-01-08 19:54:10 +0000242 }
Bram Moolenaar8efdcee2022-12-19 12:18:09 +0000243 if (gap->ga_len > 0)
Bram Moolenaar83677162023-01-08 19:54:10 +0000244 // new members are moved
245 mch_memmove(*members + parent_count,
246 gap->ga_data, sizeof(ocmember_T) * gap->ga_len);
Bram Moolenaard505d172022-12-18 21:42:55 +0000247 VIM_CLEAR(gap->ga_data);
248 return OK;
249}
250
251/*
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000252 * Convert a member index "idx" of interface "itf" to the member index of class
253 * "cl" implementing that interface.
254 */
255 int
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +0200256object_index_from_itf_index(class_T *itf, int is_method, int idx, class_T *cl)
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000257{
Ernie Rael18143d32023-09-04 22:30:41 +0200258 if (idx >= (is_method ? itf->class_obj_method_count
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +0200259 : itf->class_obj_member_count))
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000260 {
261 siemsg("index %d out of range for interface %s", idx, itf->class_name);
262 return 0;
263 }
Yegappan Lakshmanan74cc13c2023-08-13 17:41:26 +0200264
265 // If "cl" is the interface or the class that is extended, then the method
266 // index can be used directly and there is no need to search for the method
267 // index in one of the child classes.
268 if (cl == itf)
269 return idx;
270
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200271 itf2class_T *i2c = NULL;
272 int searching = TRUE;
273 int method_offset = 0;
274
Ernie Raelcf138d42023-09-06 20:45:03 +0200275 for (class_T *super = cl; super != NULL && searching;
276 super = super->class_extends)
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200277 {
Ernie Raelcf138d42023-09-06 20:45:03 +0200278 for (i2c = itf->class_itf2class; i2c != NULL; i2c = i2c->i2c_next)
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200279 {
Ernie Raelcf138d42023-09-06 20:45:03 +0200280 if (i2c->i2c_class == super && i2c->i2c_is_method == is_method)
281 {
282 searching = FALSE;
283 break;
284 }
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200285 }
286 if (searching && is_method)
287 // The parent class methods are stored after the current class
288 // methods.
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +0200289 method_offset += super->class_obj_method_count_child;
Yegappan Lakshmanancc0bcf42023-09-08 19:12:03 +0200290 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000291 if (i2c == NULL)
292 {
293 siemsg("class %s not found on interface %s",
294 cl->class_name, itf->class_name);
295 return 0;
296 }
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200297
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +0200298 // A table follows the i2c for the class
299 int *table = (int *)(i2c + 1);
300 // "method_offset" is 0, if method is in the current class. If method
301 // is in a parent class, then it is non-zero.
302 return table[idx] + method_offset;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +0000303}
304
305/*
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200306 * Check whether a class named "extends_name" is present. If the class is
307 * valid, then "extends_clp" is set with the class pointer.
308 * Returns TRUE if the class name "extends_names" is a valid class.
309 */
310 static int
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200311validate_extends_class(
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +0100312 class_T *cl,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200313 char_u *extends_name,
314 class_T **extends_clp,
315 int is_class)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200316{
317 typval_T tv;
318 int success = FALSE;
319
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +0100320 if (STRCMP(cl->class_name, extends_name) == 0)
321 {
322 semsg(_(e_cannot_extend_str), extends_name);
323 return success;
324 }
325
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200326 tv.v_type = VAR_UNKNOWN;
327 if (eval_variable_import(extends_name, &tv) == FAIL)
328 {
329 semsg(_(e_class_name_not_found_str), extends_name);
330 return success;
331 }
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200332
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200333 if (tv.v_type != VAR_CLASS || tv.vval.v_class == NULL
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +0100334 || (is_class && IS_INTERFACE(tv.vval.v_class))
335 || (!is_class && !IS_INTERFACE(tv.vval.v_class))
336 || (is_class && IS_ENUM(tv.vval.v_class)))
337 {
338 // a class cannot extend an interface
339 // an interface cannot extend a class
340 // a class cannot extend an enum.
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200341 semsg(_(e_cannot_extend_str), extends_name);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +0100342 }
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200343 else
344 {
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200345 class_T *extends_cl = tv.vval.v_class;
346 ++extends_cl->class_refcount;
347 *extends_clp = extends_cl;
348 success = TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200349 }
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200350 clear_tv(&tv);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200351
352 return success;
353}
354
355/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200356 * Check method names in the parent class lineage to make sure the access is
357 * the same for overridden methods.
358 */
359 static int
360validate_extends_methods(
361 garray_T *objmethods_gap,
362 class_T *extends_cl)
363{
364 class_T *super = extends_cl;
365 int method_count = objmethods_gap->ga_len;
366 ufunc_T **cl_fp = (ufunc_T **)(objmethods_gap->ga_data);
367
368 while (super != NULL)
369 {
370 int extends_method_count = super->class_obj_method_count_child;
371 if (extends_method_count == 0)
372 {
373 super = super->class_extends;
374 continue;
375 }
376
377 ufunc_T **extends_methods = super->class_obj_methods;
378
379 for (int i = 0; i < extends_method_count; i++)
380 {
381 char_u *pstr = extends_methods[i]->uf_name;
382 int extends_private = (*pstr == '_');
383 if (extends_private)
384 pstr++;
385
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200386 // When comparing the method names, ignore the access type (public
387 // and private methods are considered the same).
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200388 for (int j = 0; j < method_count; j++)
389 {
390 char_u *qstr = cl_fp[j]->uf_name;
391 int priv_method = (*qstr == '_');
392 if (priv_method)
393 qstr++;
394 if (STRCMP(pstr, qstr) == 0 && priv_method != extends_private)
395 {
396 // Method access is different between the super class and
397 // the subclass
398 semsg(_(e_method_str_of_class_str_has_different_access),
399 cl_fp[j]->uf_name, super->class_name);
400 return FALSE;
401 }
402 }
403 }
404 super = super->class_extends;
405 }
406
407 return TRUE;
408}
409
410/*
411 * Check whether a object member variable in "objmembers_gap" is a duplicate of
412 * a member in any of the extended parent class lineage. Returns TRUE if there
413 * are no duplicates.
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200414 */
415 static int
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200416extends_check_dup_members(
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200417 garray_T *objmembers_gap,
418 class_T *extends_cl)
419{
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200420 int member_count = objmembers_gap->ga_len;
421 if (member_count == 0)
422 return TRUE;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200423
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200424 ocmember_T *members = (ocmember_T *)(objmembers_gap->ga_data);
425
426 // Validate each member variable
427 for (int c_i = 0; c_i < member_count; c_i++)
428 {
429 class_T *p_cl = extends_cl;
430 ocmember_T *c_m = members + c_i;
431 char_u *pstr = (*c_m->ocm_name == '_')
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200432 ? c_m->ocm_name + 1 : c_m->ocm_name;
433
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200434 // Check in all the parent classes in the lineage
435 while (p_cl != NULL)
436 {
437 int p_member_count = p_cl->class_obj_member_count;
438 if (p_member_count == 0)
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200439 {
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200440 p_cl = p_cl->class_extends;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200441 continue;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200442 }
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200443 ocmember_T *p_members = p_cl->class_obj_members;
444
445 // Compare against all the members in the parent class
446 for (int p_i = 0; p_i < p_member_count; p_i++)
447 {
448 ocmember_T *p_m = p_members + p_i;
449 char_u *qstr = (*p_m->ocm_name == '_')
450 ? p_m->ocm_name + 1 : p_m->ocm_name;
451 if (STRCMP(pstr, qstr) == 0)
452 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200453 semsg(_(e_duplicate_variable_str), c_m->ocm_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200454 return FALSE;
455 }
456 }
457
458 p_cl = p_cl->class_extends;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200459 }
460 }
461
462 return TRUE;
463}
464
465/*
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200466 * Compare the variable type of interface variables in "objmembers_gap" against
467 * the variable in any of the extended super interface lineage. Used to
468 * compare the variable types when extending interfaces. Returns TRUE if the
469 * variable types are the same.
470 */
471 static int
472extends_check_intf_var_type(
473 garray_T *objmembers_gap,
474 class_T *extends_cl)
475{
476 int member_count = objmembers_gap->ga_len;
477 if (member_count == 0)
478 return TRUE;
479
480 ocmember_T *members = (ocmember_T *)(objmembers_gap->ga_data);
481
482 // Validate each member variable
483 for (int c_i = 0; c_i < member_count; c_i++)
484 {
485 class_T *p_cl = extends_cl;
486 ocmember_T *c_m = members + c_i;
487 int var_found = FALSE;
488
489 // Check in all the parent classes in the lineage
490 while (p_cl != NULL && !var_found)
491 {
492 int p_member_count = p_cl->class_obj_member_count;
493 if (p_member_count == 0)
494 {
495 p_cl = p_cl->class_extends;
496 continue;
497 }
498 ocmember_T *p_members = p_cl->class_obj_members;
499
500 // Compare against all the members in the parent class
501 for (int p_i = 0; p_i < p_member_count; p_i++)
502 {
503 where_T where = WHERE_INIT;
504 ocmember_T *p_m = p_members + p_i;
505
506 if (STRCMP(p_m->ocm_name, c_m->ocm_name) != 0)
507 continue;
508
509 // Ensure the type is matching.
510 where.wt_func_name = (char *)c_m->ocm_name;
511 where.wt_kind = WT_MEMBER;
512
513 if (check_type(p_m->ocm_type, c_m->ocm_type, TRUE,
514 where) == FAIL)
515 return FALSE;
516
517 var_found = TRUE;
518 }
519
520 p_cl = p_cl->class_extends;
521 }
522 }
523
524 return TRUE;
525}
526
527/*
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200528 * When extending an abstract class, check whether all the abstract methods in
529 * the parent class are implemented. Returns TRUE if all the methods are
530 * implemented.
531 */
532 static int
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200533validate_abstract_class_methods(
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200534 garray_T *classmethods_gap,
535 garray_T *objmethods_gap,
536 class_T *extends_cl)
537{
538 for (int loop = 1; loop <= 2; ++loop)
539 {
540 // loop == 1: check class methods
541 // loop == 2: check object methods
542 int extends_method_count = loop == 1
543 ? extends_cl->class_class_function_count
544 : extends_cl->class_obj_method_count;
545 if (extends_method_count == 0)
546 continue;
547
548 ufunc_T **extends_methods = loop == 1
549 ? extends_cl->class_class_functions
550 : extends_cl->class_obj_methods;
551
552 int method_count = loop == 1 ? classmethods_gap->ga_len
553 : objmethods_gap->ga_len;
554 ufunc_T **cl_fp = (ufunc_T **)(loop == 1
555 ? classmethods_gap->ga_data
556 : objmethods_gap->ga_data);
557
558 for (int i = 0; i < extends_method_count; i++)
559 {
560 ufunc_T *uf = extends_methods[i];
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +0200561 if (!IS_ABSTRACT_METHOD(uf))
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +0200562 continue;
563
564 int method_found = FALSE;
565
566 for (int j = 0; j < method_count; j++)
567 {
568 if (STRCMP(uf->uf_name, cl_fp[j]->uf_name) == 0)
569 {
570 method_found = TRUE;
571 break;
572 }
573 }
574
575 if (!method_found)
576 {
577 semsg(_(e_abstract_method_str_not_found), uf->uf_name);
578 return FALSE;
579 }
580 }
581 }
582
583 return TRUE;
584}
585
586/*
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200587 * Returns TRUE if the interface variable "if_var" is present in the list of
588 * variables in "cl_mt" or in the parent lineage of one of the extended classes
589 * in "extends_cl". For a class variable, 'is_class_var' is TRUE.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200590 */
591 static int
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200592intf_variable_present(
593 char_u *intf_class_name,
594 ocmember_T *if_var,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200595 ocmember_T *cl_mt,
596 int cl_member_count,
597 class_T *extends_cl)
598{
599 int variable_present = FALSE;
600
601 for (int cl_i = 0; cl_i < cl_member_count; ++cl_i)
602 {
603 ocmember_T *m = &cl_mt[cl_i];
604 where_T where = WHERE_INIT;
605
606 if (STRCMP(if_var->ocm_name, m->ocm_name) != 0)
607 continue;
608
609 // Ensure the access type is same
610 if (if_var->ocm_access != m->ocm_access)
611 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200612 semsg(_(e_variable_str_of_interface_str_has_different_access),
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200613 if_var->ocm_name, intf_class_name);
614 return FALSE;
615 }
616
617 // Ensure the type is matching.
618 if (m->ocm_type == &t_any)
619 {
620 // variable type is not specified. Use the variable type in the
621 // interface.
622 m->ocm_type = if_var->ocm_type;
623 }
624 else
625 {
626 where.wt_func_name = (char *)m->ocm_name;
627 where.wt_kind = WT_MEMBER;
628 if (check_type(if_var->ocm_type, m->ocm_type, TRUE,
629 where) == FAIL)
630 return FALSE;
631 }
632
633 variable_present = TRUE;
634 break;
635 }
636
637 if (!variable_present && extends_cl != NULL)
638 {
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200639 int ext_cl_count = extends_cl->class_obj_member_count;
640 ocmember_T *ext_cl_mt = extends_cl->class_obj_members;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200641 return intf_variable_present(intf_class_name, if_var,
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200642 ext_cl_mt, ext_cl_count,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200643 extends_cl->class_extends);
644 }
645
646 return variable_present;
647}
648
649/*
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200650 * Check the variables of the interface class "ifcl" match object variables
651 * ("objmembers_gap") of a class.
652 * Returns TRUE if the object variables names are valid.
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200653 */
654 static int
655validate_interface_variables(
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200656 char_u *intf_class_name,
657 class_T *ifcl,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200658 garray_T *objmembers_gap,
659 class_T *extends_cl)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200660{
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200661 int if_count = ifcl->class_obj_member_count;
662 if (if_count == 0)
663 return TRUE;
664
665 ocmember_T *if_ms = ifcl->class_obj_members;
666 ocmember_T *cl_ms = (ocmember_T *)(objmembers_gap->ga_data);
667 int cl_count = objmembers_gap->ga_len;
668 for (int if_i = 0; if_i < if_count; ++if_i)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200669 {
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200670 if (!intf_variable_present(intf_class_name, &if_ms[if_i], cl_ms,
671 cl_count, extends_cl))
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200672 {
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200673 semsg(_(e_variable_str_of_interface_str_not_implemented),
674 if_ms[if_i].ocm_name, intf_class_name);
675 return FALSE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200676 }
677 }
678
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200679 return TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200680}
681
682/*
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200683 * Returns TRUE if the method signature of "if_method" and "cl_method" matches.
684 */
685 static int
686intf_method_type_matches(ufunc_T *if_method, ufunc_T *cl_method)
687{
688 where_T where = WHERE_INIT;
689
690 // Ensure the type is matching.
691 where.wt_func_name = (char *)if_method->uf_name;
692 where.wt_kind = WT_METHOD;
693 if (check_type(if_method->uf_func_type, cl_method->uf_func_type, TRUE,
694 where) == FAIL)
695 return FALSE;
696
697 return TRUE;
698}
699
700/*
701 * Returns TRUE if the interface method "if_ufunc" is present in the list of
702 * methods in "cl_fp" or in the parent lineage of one of the extended classes
703 * in "extends_cl". For a class method, 'is_class_method' is TRUE.
704 */
705 static int
706intf_method_present(
707 ufunc_T *if_ufunc,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200708 ufunc_T **cl_fp,
709 int cl_count,
710 class_T *extends_cl)
711{
712 int method_present = FALSE;
713
714 for (int cl_i = 0; cl_i < cl_count; ++cl_i)
715 {
716 char_u *cl_name = cl_fp[cl_i]->uf_name;
717 if (STRCMP(if_ufunc->uf_name, cl_name) == 0)
718 {
719 // Ensure the type is matching.
720 if (!intf_method_type_matches(if_ufunc, cl_fp[cl_i]))
721 return FALSE;
722 method_present = TRUE;
723 break;
724 }
725 }
726
727 if (!method_present && extends_cl != NULL)
728 {
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200729 ufunc_T **ext_cl_fp = (ufunc_T **)(extends_cl->class_obj_methods);
730 int ext_cl_count = extends_cl->class_obj_method_count;
731 return intf_method_present(if_ufunc, ext_cl_fp, ext_cl_count,
732 extends_cl->class_extends);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200733 }
734
735 return method_present;
736}
737
738/*
739 * Validate that a new class implements all the class/instance methods in the
740 * interface "ifcl". The new class methods are in "classfunctions_gap" and the
741 * new object methods are in "objmemthods_gap". Also validates the method
742 * types.
743 * Returns TRUE if all the interface class/object methods are implemented in
744 * the new class.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200745 */
746 static int
747validate_interface_methods(
748 char_u *intf_class_name,
749 class_T *ifcl,
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 Lakshmananb8523052023-10-08 19:07:39 +0200753 int if_count = ifcl->class_obj_method_count;
754 if (if_count == 0)
755 return TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200756
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200757 ufunc_T **if_fp = ifcl->class_obj_methods;
758 ufunc_T **cl_fp = (ufunc_T **)(objmethods_gap->ga_data);
759 int cl_count = objmethods_gap->ga_len;
760 for (int if_i = 0; if_i < if_count; ++if_i)
761 {
762 char_u *if_name = if_fp[if_i]->uf_name;
763
764 if (!intf_method_present(if_fp[if_i], cl_fp, cl_count, extends_cl))
765 {
766 semsg(_(e_method_str_of_interface_str_not_implemented),
767 if_name, intf_class_name);
768 return FALSE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200769 }
770 }
771
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200772 return TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200773}
774
775/*
776 * Validate all the "implements" classes when creating a new class. The
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200777 * classes are returned in "intf_classes". The class functions, class members,
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200778 * object methods and object members in the new class are in
779 * "classfunctions_gap", "classmembers_gap", "objmethods_gap", and
780 * "objmembers_gap" respectively.
781 */
782 static int
783validate_implements_classes(
784 garray_T *impl_gap,
785 class_T **intf_classes,
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200786 garray_T *objmethods_gap,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200787 garray_T *objmembers_gap,
788 class_T *extends_cl)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200789{
790 int success = TRUE;
791
792 for (int i = 0; i < impl_gap->ga_len && success; ++i)
793 {
794 char_u *impl = ((char_u **)impl_gap->ga_data)[i];
795 typval_T tv;
796 tv.v_type = VAR_UNKNOWN;
797 if (eval_variable_import(impl, &tv) == FAIL)
798 {
799 semsg(_(e_interface_name_not_found_str), impl);
800 success = FALSE;
801 break;
802 }
803
804 if (tv.v_type != VAR_CLASS
805 || tv.vval.v_class == NULL
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +0100806 || !IS_INTERFACE(tv.vval.v_class))
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200807 {
808 semsg(_(e_not_valid_interface_str), impl);
809 success = FALSE;
810 clear_tv(&tv);
811 break;
812 }
813
814 class_T *ifcl = tv.vval.v_class;
815 intf_classes[i] = ifcl;
816 ++ifcl->class_refcount;
817
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +0200818 // check the variables of the interface match the members of the class
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200819 success = validate_interface_variables(impl, ifcl, objmembers_gap,
820 extends_cl);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200821
822 // check the functions/methods of the interface match the
823 // functions/methods of the class
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200824 if (success)
Yegappan Lakshmananb8523052023-10-08 19:07:39 +0200825 success = validate_interface_methods(impl, ifcl, objmethods_gap,
826 extends_cl);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200827 clear_tv(&tv);
828 }
829
830 return success;
831}
832
833/*
834 * Check no function argument name is used as a class member.
835 * (Object members are always accessed with "this." prefix, so no need
836 * to check them.)
837 */
838 static int
839check_func_arg_names(
840 garray_T *classfunctions_gap,
841 garray_T *objmethods_gap,
842 garray_T *classmembers_gap)
843{
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200844 // loop 1: class functions, loop 2: object methods
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200845 for (int loop = 1; loop <= 2; ++loop)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200846 {
847 garray_T *gap = loop == 1 ? classfunctions_gap : objmethods_gap;
848
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200849 for (int fi = 0; fi < gap->ga_len; ++fi)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200850 {
851 ufunc_T *uf = ((ufunc_T **)gap->ga_data)[fi];
852
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200853 for (int i = 0; i < uf->uf_args.ga_len; ++i)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200854 {
855 char_u *aname = ((char_u **)uf->uf_args.ga_data)[i];
856 garray_T *mgap = classmembers_gap;
857
858 // Check all the class member names
859 for (int mi = 0; mi < mgap->ga_len; ++mi)
860 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200861 char_u *mname =
862 ((ocmember_T *)mgap->ga_data + mi)->ocm_name;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200863 if (STRCMP(aname, mname) == 0)
864 {
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200865 if (uf->uf_script_ctx.sc_sid > 0)
866 SOURCING_LNUM = uf->uf_script_ctx.sc_lnum;
867
868 semsg(_(e_argument_already_declared_in_class_str),
869 aname);
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200870
871 return FALSE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200872 }
873 }
874 }
875 }
876 }
877
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +0200878 return TRUE;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +0200879}
880
881/*
Yegappan Lakshmananf057aca2023-09-28 22:28:15 +0200882 * Returns TRUE if 'varname' is a reserved keyword name
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200883 */
884 static int
Yegappan Lakshmananf057aca2023-09-28 22:28:15 +0200885is_reserved_varname(char_u *varname, char_u *varname_end)
886{
887 int reserved = FALSE;
888 char_u save_varname_end = *varname_end;
889 *varname_end = NUL;
890
891 reserved = check_reserved_name(varname, FALSE) == FAIL;
892
893 *varname_end = save_varname_end;
894
895 return reserved;
896}
897
898/*
899 * Returns TRUE if the variable "varname" is already defined either as a class
900 * variable or as an object variable.
901 */
902 static int
903is_duplicate_variable(
904 garray_T *class_members,
905 garray_T *obj_members,
906 char_u *varname,
907 char_u *varname_end)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200908{
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200909 char_u *name = vim_strnsave(varname, varname_end - varname);
910 char_u *pstr = (*name == '_') ? name + 1 : name;
911 int dup = FALSE;
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200912
Yegappan Lakshmananf057aca2023-09-28 22:28:15 +0200913 for (int loop = 1; loop <= 2; loop++)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200914 {
Yegappan Lakshmananf057aca2023-09-28 22:28:15 +0200915 // loop == 1: class variables, loop == 2: object variables
916 garray_T *vgap = (loop == 1) ? class_members : obj_members;
917 for (int i = 0; i < vgap->ga_len; ++i)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200918 {
Yegappan Lakshmananf057aca2023-09-28 22:28:15 +0200919 ocmember_T *m = ((ocmember_T *)vgap->ga_data) + i;
920 char_u *qstr = *m->ocm_name == '_' ? m->ocm_name + 1
921 : m->ocm_name;
922 if (STRCMP(pstr, qstr) == 0)
923 {
924 semsg(_(e_duplicate_variable_str), name);
925 dup = TRUE;
926 break;
927 }
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200928 }
929 }
930
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +0200931 vim_free(name);
932 return dup;
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200933}
934
935/*
936 * Returns TRUE if the method "name" is already defined.
937 */
938 static int
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200939is_duplicate_method(
940 garray_T *classmethods_gap,
941 garray_T *objmethods_gap,
942 char_u *name)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200943{
944 char_u *pstr = (*name == '_') ? name + 1 : name;
945
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200946 // loop 1: class methods, loop 2: object methods
947 for (int loop = 1; loop <= 2; loop++)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200948 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200949 garray_T *fgap = (loop == 1) ? classmethods_gap : objmethods_gap;
950 for (int i = 0; i < fgap->ga_len; ++i)
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200951 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200952 char_u *n = ((ufunc_T **)fgap->ga_data)[i]->uf_name;
953 char_u *qstr = *n == '_' ? n + 1 : n;
954 if (STRCMP(pstr, qstr) == 0)
955 {
956 semsg(_(e_duplicate_function_str), name);
957 return TRUE;
958 }
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +0200959 }
960 }
961
962 return FALSE;
963}
964
965/*
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200966 * Returns TRUE if the constructor is valid.
967 */
968 static int
969is_valid_constructor(ufunc_T *uf, int is_abstract, int has_static)
970{
971 // Constructors are not allowed in abstract classes.
972 if (is_abstract)
973 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200974 emsg(_(e_cannot_define_new_method_in_abstract_class));
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200975 return FALSE;
976 }
977 // A constructor is always static, no need to define it so.
978 if (has_static)
979 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200980 emsg(_(e_cannot_define_new_method_as_static));
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200981 return FALSE;
982 }
983 // A return type should not be specified for the new()
984 // constructor method.
985 if (uf->uf_ret_type->tt_type != VAR_VOID)
986 {
RestorerZ7fe8f432023-09-24 23:21:24 +0200987 emsg(_(e_cannot_use_a_return_type_with_new_method));
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200988 return FALSE;
989 }
990 return TRUE;
991}
992
993/*
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +0100994 * Returns TRUE if 'uf' is a supported builtin method and has the correct
995 * method signature.
996 */
997 static int
998object_check_builtin_method_sig(ufunc_T *uf)
999{
1000 char_u *name = uf->uf_name;
1001 int valid = FALSE;
1002 type_T method_sig;
1003 type_T method_rt;
1004 where_T where = WHERE_INIT;
1005
1006 // validate the method signature
1007 CLEAR_FIELD(method_sig);
1008 CLEAR_FIELD(method_rt);
1009 method_sig.tt_type = VAR_FUNC;
1010
1011 if (STRCMP(name, "len") == 0)
1012 {
1013 // def __len(): number
1014 method_rt.tt_type = VAR_NUMBER;
1015 method_sig.tt_member = &method_rt;
1016 valid = TRUE;
1017 }
1018 else if (STRCMP(name, "empty") == 0)
1019 {
1020 // def __empty(): bool
1021 method_rt.tt_type = VAR_BOOL;
1022 method_sig.tt_member = &method_rt;
1023 valid = TRUE;
1024 }
1025 else if (STRCMP(name, "string") == 0)
1026 {
1027 // def __string(): string
1028 method_rt.tt_type = VAR_STRING;
1029 method_sig.tt_member = &method_rt;
1030 valid = TRUE;
1031 }
1032 else
1033 semsg(_(e_builtin_object_method_str_not_supported), uf->uf_name);
1034
1035 where.wt_func_name = (char *)uf->uf_name;
1036 where.wt_kind = WT_METHOD;
1037 if (valid && !check_type(&method_sig, uf->uf_func_type, TRUE, where))
1038 valid = FALSE;
1039
1040 return valid;
1041}
1042
1043/*
1044 * Returns TRUE if "funcname" is a supported builtin object method name
1045 */
1046 int
1047is_valid_builtin_obj_methodname(char_u *funcname)
1048{
1049 switch (funcname[0])
1050 {
1051 case 'e':
1052 return STRNCMP(funcname, "empty", 5) == 0;
1053
1054 case 'l':
1055 return STRNCMP(funcname, "len", 3) == 0;
1056
1057 case 'n':
1058 return STRNCMP(funcname, "new", 3) == 0;
1059
1060 case 's':
1061 return STRNCMP(funcname, "string", 6) == 0;
1062 }
1063
1064 return FALSE;
1065}
1066
1067
1068/*
1069 * Returns the builtin method "name" in object "obj". Returns NULL if the
1070 * method is not found.
1071 */
1072 ufunc_T *
1073class_get_builtin_method(
1074 class_T *cl,
1075 class_builtin_T builtin_method,
1076 int *method_idx)
1077{
1078 *method_idx = -1;
1079
1080 if (cl == NULL)
1081 return NULL;
1082
1083 *method_idx = cl->class_builtin_methods[builtin_method];
1084 return *method_idx != -1 ? cl->class_obj_methods[*method_idx] : NULL;
1085}
1086
1087/*
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001088 * Update the interface class lookup table for the member index on the
1089 * interface to the member index in the class implementing the interface.
1090 * And a lookup table for the object method index on the interface
1091 * to the object method index in the class implementing the interface.
1092 * This is also used for updating the lookup table for the extended class
1093 * hierarchy.
1094 */
1095 static int
1096update_member_method_lookup_table(
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02001097 class_T *ifcl,
1098 class_T *cl,
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02001099 garray_T *objmethods,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001100 int pobj_method_offset)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001101{
1102 if (ifcl == NULL)
1103 return OK;
1104
1105 // Table for members.
1106 itf2class_T *if2cl = alloc_clear(sizeof(itf2class_T)
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001107 + ifcl->class_obj_member_count * sizeof(int));
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001108 if (if2cl == NULL)
1109 return FAIL;
1110 if2cl->i2c_next = ifcl->class_itf2class;
1111 ifcl->class_itf2class = if2cl;
1112 if2cl->i2c_class = cl;
1113 if2cl->i2c_is_method = FALSE;
1114
1115 for (int if_i = 0; if_i < ifcl->class_obj_member_count; ++if_i)
1116 for (int cl_i = 0; cl_i < cl->class_obj_member_count; ++cl_i)
1117 {
1118 if (STRCMP(ifcl->class_obj_members[if_i].ocm_name,
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001119 cl->class_obj_members[cl_i].ocm_name) == 0)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001120 {
1121 int *table = (int *)(if2cl + 1);
1122 table[if_i] = cl_i;
1123 break;
1124 }
1125 }
1126
1127 // Table for methods.
1128 if2cl = alloc_clear(sizeof(itf2class_T)
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001129 + ifcl->class_obj_method_count * sizeof(int));
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001130 if (if2cl == NULL)
1131 return FAIL;
1132 if2cl->i2c_next = ifcl->class_itf2class;
1133 ifcl->class_itf2class = if2cl;
1134 if2cl->i2c_class = cl;
1135 if2cl->i2c_is_method = TRUE;
1136
1137 for (int if_i = 0; if_i < ifcl->class_obj_method_count; ++if_i)
1138 {
1139 int done = FALSE;
1140 for (int cl_i = 0; cl_i < objmethods->ga_len; ++cl_i)
1141 {
1142 if (STRCMP(ifcl->class_obj_methods[if_i]->uf_name,
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001143 ((ufunc_T **)objmethods->ga_data)[cl_i]->uf_name) == 0)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001144 {
1145 int *table = (int *)(if2cl + 1);
1146 table[if_i] = cl_i;
1147 done = TRUE;
1148 break;
1149 }
1150 }
1151
1152 // extended class object method is not overridden by the child class.
1153 // Keep the method declared in one of the parent classes in the
1154 // lineage.
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001155 if (!done)
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001156 {
1157 // If "ifcl" is not the immediate parent of "cl", then search in
1158 // the intermediate parent classes.
1159 if (cl->class_extends != ifcl)
1160 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001161 class_T *parent = cl->class_extends;
1162 int method_offset = objmethods->ga_len;
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02001163
1164 while (!done && parent != NULL && parent != ifcl)
1165 {
1166
1167 for (int cl_i = 0;
1168 cl_i < parent->class_obj_method_count_child; ++cl_i)
1169 {
1170 if (STRCMP(ifcl->class_obj_methods[if_i]->uf_name,
1171 parent->class_obj_methods[cl_i]->uf_name)
1172 == 0)
1173 {
1174 int *table = (int *)(if2cl + 1);
1175 table[if_i] = method_offset + cl_i;
1176 done = TRUE;
1177 break;
1178 }
1179 }
1180 method_offset += parent->class_obj_method_count_child;
1181 parent = parent->class_extends;
1182 }
1183 }
1184
1185 if (!done)
1186 {
1187 int *table = (int *)(if2cl + 1);
1188 table[if_i] = pobj_method_offset + if_i;
1189 }
1190 }
1191 }
1192
1193 return OK;
1194}
1195
1196/*
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001197 * Update the member and object method lookup tables for a new class in the
1198 * interface class.
1199 * For each interface add a lookup table for the member index on the interface
1200 * to the member index in the new class. And a lookup table for the object
1201 * method index on the interface to the object method index in the new class.
1202 */
1203 static int
1204add_lookup_tables(class_T *cl, class_T *extends_cl, garray_T *objmethods_gap)
1205{
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001206 // update the lookup table for all the implemented interfaces
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001207 for (int i = 0; i < cl->class_interface_count; ++i)
1208 {
1209 class_T *ifcl = cl->class_interfaces_cl[i];
1210
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001211 // update the lookup table for this interface and all its super
1212 // interfaces.
1213 while (ifcl != NULL)
1214 {
1215 if (update_member_method_lookup_table(ifcl, cl, objmethods_gap,
1216 0) == FAIL)
1217 return FAIL;
1218 ifcl = ifcl->class_extends;
1219 }
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001220 }
1221
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001222 // Update the lookup table for the extended class, if any
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001223 if (extends_cl != NULL)
1224 {
1225 class_T *pclass = extends_cl;
1226 int pobj_method_offset = objmethods_gap->ga_len;
1227
1228 // Update the entire lineage of extended classes.
1229 while (pclass != NULL)
1230 {
1231 if (update_member_method_lookup_table(pclass, cl,
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001232 objmethods_gap, pobj_method_offset) == FAIL)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001233 return FAIL;
1234
1235 pobj_method_offset += pclass->class_obj_method_count_child;
1236 pclass = pclass->class_extends;
1237 }
1238 }
1239
1240 return OK;
1241}
1242
1243/*
1244 * Add class members to a new class. Allocate a typval for each class member
1245 * and initialize it.
1246 */
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001247 static int
Yegappan Lakshmanand2f48002023-10-05 20:24:18 +02001248add_class_members(class_T *cl, exarg_T *eap, garray_T *type_list_gap)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001249{
1250 // Allocate a typval for each class member and initialize it.
1251 cl->class_members_tv = ALLOC_CLEAR_MULT(typval_T,
1252 cl->class_class_member_count);
1253 if (cl->class_members_tv == NULL)
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001254 return FAIL;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001255
1256 for (int i = 0; i < cl->class_class_member_count; ++i)
1257 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001258 ocmember_T *m = &cl->class_class_members[i];
1259 typval_T *tv = &cl->class_members_tv[i];
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001260 if (m->ocm_init != NULL)
1261 {
1262 typval_T *etv = eval_expr(m->ocm_init, eap);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001263 if (etv == NULL)
1264 return FAIL;
1265
1266 if (m->ocm_type->tt_type == VAR_ANY
1267 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
1268 && etv->v_type != VAR_SPECIAL)
1269 // If the member variable type is not yet set, then use
1270 // the initialization expression type.
1271 m->ocm_type = typval2type(etv, get_copyID(),
1272 type_list_gap,
1273 TVTT_DO_MEMBER|TVTT_MORE_SPECIFIC);
1274 *tv = *etv;
1275 vim_free(etv);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001276 }
1277 else
1278 {
1279 // TODO: proper default value
1280 tv->v_type = m->ocm_type->tt_type;
1281 tv->vval.v_string = NULL;
1282 }
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01001283 if (m->ocm_flags & OCMFLAG_CONST)
1284 item_lock(tv, DICT_MAXNEST, TRUE, TRUE);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001285 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001286
1287 return OK;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001288}
1289
1290/*
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02001291 * Add a default constructor method (new()) to the class "cl".
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001292 */
1293 static void
1294add_default_constructor(
1295 class_T *cl,
1296 garray_T *classfunctions_gap,
1297 garray_T *type_list_gap)
1298{
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001299 garray_T fga;
1300 int is_enum = IS_ENUM(cl);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001301
1302 ga_init2(&fga, 1, 1000);
1303 ga_concat(&fga, (char_u *)"new(");
1304 for (int i = 0; i < cl->class_obj_member_count; ++i)
1305 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001306 if (i < 2 && is_enum)
1307 // The first two object variables in an enum are the enum value
1308 // name and ordinal. Don't initialize these object variables in
1309 // the default constructor as they are already initialized right
1310 // after creating the object.
1311 continue;
1312
1313 if (i > (is_enum ? 2 : 0))
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001314 ga_concat(&fga, (char_u *)", ");
1315 ga_concat(&fga, (char_u *)"this.");
1316 ocmember_T *m = cl->class_obj_members + i;
1317 ga_concat(&fga, (char_u *)m->ocm_name);
1318 ga_concat(&fga, (char_u *)" = v:none");
1319 }
1320 ga_concat(&fga, (char_u *)")\nenddef\n");
1321 ga_append(&fga, NUL);
1322
1323 exarg_T fea;
1324 CLEAR_FIELD(fea);
1325 fea.cmdidx = CMD_def;
1326 fea.cmd = fea.arg = fga.ga_data;
1327
1328 garray_T lines_to_free;
1329 ga_init2(&lines_to_free, sizeof(char_u *), 50);
1330
h-eastb895b0f2023-09-24 15:46:31 +02001331 ufunc_T *nf = define_function(&fea, NULL, &lines_to_free, CF_CLASS,
1332 cl->class_obj_members, cl->class_obj_member_count);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001333
1334 ga_clear_strings(&lines_to_free);
1335 vim_free(fga.ga_data);
1336
1337 if (nf != NULL && ga_grow(classfunctions_gap, 1) == OK)
1338 {
1339 ((ufunc_T **)classfunctions_gap->ga_data)[classfunctions_gap->ga_len]
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001340 = nf;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001341 ++classfunctions_gap->ga_len;
1342
1343 nf->uf_flags |= FC_NEW;
1344 nf->uf_ret_type = get_type_ptr(type_list_gap);
1345 if (nf->uf_ret_type != NULL)
1346 {
1347 nf->uf_ret_type->tt_type = VAR_OBJECT;
1348 nf->uf_ret_type->tt_class = cl;
1349 nf->uf_ret_type->tt_argcount = 0;
1350 nf->uf_ret_type->tt_args = NULL;
1351 }
1352 }
1353}
1354
1355/*
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001356 * Add the class methods and object methods to the new class "cl".
1357 * When extending a class "extends_cl", add the instance methods from the
1358 * parent class also.
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001359 * Returns OK on success and FAIL on memory allocation failure.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001360 */
1361 static int
1362add_classfuncs_objmethods(
1363 class_T *cl,
1364 class_T *extends_cl,
1365 garray_T *classfunctions_gap,
1366 garray_T *objmethods_gap)
1367{
1368 // loop 1: class functions, loop 2: object methods
1369 for (int loop = 1; loop <= 2; ++loop)
1370 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001371 garray_T *gap = loop == 1 ? classfunctions_gap : objmethods_gap;
1372 int *fcount = loop == 1 ? &cl->class_class_function_count
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001373 : &cl->class_obj_method_count;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001374 ufunc_T ***fup = loop == 1 ? &cl->class_class_functions
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001375 : &cl->class_obj_methods;
1376
1377 int parent_count = 0;
1378 if (extends_cl != NULL)
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001379 // Include object methods from the parent.
1380 // Don't include the parent class methods.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001381 parent_count = loop == 1
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001382 ? 0
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001383 : extends_cl->class_obj_method_count;
1384
1385 *fcount = parent_count + gap->ga_len;
1386 if (*fcount == 0)
1387 {
1388 *fup = NULL;
1389 continue;
1390 }
1391 *fup = ALLOC_MULT(ufunc_T *, *fcount);
1392 if (*fup == NULL)
1393 return FAIL;
1394
1395 if (gap->ga_len != 0)
1396 mch_memmove(*fup, gap->ga_data, sizeof(ufunc_T *) * gap->ga_len);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001397 VIM_CLEAR(gap->ga_data);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001398 if (loop == 1)
1399 cl->class_class_function_count_child = gap->ga_len;
1400 else
1401 cl->class_obj_method_count_child = gap->ga_len;
1402
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001403 if (loop == 2)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001404 {
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001405 // Copy instance methods from the parent.
1406
1407 for (int i = 0; i < parent_count; ++i)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001408 {
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001409 // Can't use the same parent function, because "uf_class" is
1410 // different and compilation will have a different result.
1411 // Put them after the functions in the current class, object
1412 // methods may be overruled, then "super.Method()" is used to
1413 // find a method from the parent.
1414 ufunc_T *pf = (extends_cl->class_obj_methods)[i];
1415 (*fup)[gap->ga_len + i] = copy_function(pf);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001416
1417 // If the child class overrides a function from the parent
1418 // the signature must be equal.
1419 char_u *pname = pf->uf_name;
1420 for (int ci = 0; ci < gap->ga_len; ++ci)
1421 {
1422 ufunc_T *cf = (*fup)[ci];
1423 char_u *cname = cf->uf_name;
1424 if (STRCMP(pname, cname) == 0)
1425 {
1426 where_T where = WHERE_INIT;
1427 where.wt_func_name = (char *)pname;
1428 where.wt_kind = WT_METHOD;
1429 (void)check_type(pf->uf_func_type, cf->uf_func_type,
1430 TRUE, where);
1431 }
1432 }
1433 }
1434 }
1435
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001436 // Set the class pointer on all the functions and object methods.
1437 for (int i = 0; i < *fcount; ++i)
1438 {
1439 ufunc_T *fp = (*fup)[i];
1440 fp->uf_class = cl;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001441 if (i < gap->ga_len)
1442 fp->uf_defclass = cl;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001443 if (loop == 2)
1444 fp->uf_flags |= FC_OBJECT;
1445 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001446
1447 ga_clear(gap);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001448 }
1449
1450 return OK;
1451}
1452
1453/*
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01001454 * Update the index of object methods called by builtin functions.
1455 */
1456 static void
1457update_builtin_method_index(class_T *cl)
1458{
1459 int i;
1460
1461 for (i = 0; i < CLASS_BUILTIN_MAX; i++)
1462 cl->class_builtin_methods[i] = -1;
1463
1464 for (i = 0; i < cl->class_obj_method_count; i++)
1465 {
1466 ufunc_T *uf = cl->class_obj_methods[i];
1467
1468 if (cl->class_builtin_methods[CLASS_BUILTIN_STRING] == -1
1469 && STRCMP(uf->uf_name, "string") == 0)
1470 cl->class_builtin_methods[CLASS_BUILTIN_STRING] = i;
1471 else if (cl->class_builtin_methods[CLASS_BUILTIN_EMPTY] == -1 &&
1472 STRCMP(uf->uf_name, "empty") == 0)
1473 cl->class_builtin_methods[CLASS_BUILTIN_EMPTY] = i;
1474 else if (cl->class_builtin_methods[CLASS_BUILTIN_LEN] == -1 &&
1475 STRCMP(uf->uf_name, "len") == 0)
1476 cl->class_builtin_methods[CLASS_BUILTIN_LEN] = i;
1477 }
1478}
1479
1480/*
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001481 * Return the end of the class name starting at "arg". Valid characters in a
1482 * class name are alphanumeric characters and "_". Also handles imported class
1483 * names.
1484 */
1485 static char_u *
1486find_class_name_end(char_u *arg)
1487{
1488 char_u *end = arg;
1489
1490 while (ASCII_ISALNUM(*end) || *end == '_'
1491 || (*end == '.' && (ASCII_ISALNUM(end[1]) || end[1] == '_')))
1492 ++end;
1493
1494 return end;
1495}
1496
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001497/*
1498 * Returns TRUE if the enum value "varname" is already defined.
1499 */
1500 static int
1501is_duplicate_enum(
1502 garray_T *enum_gap,
1503 char_u *varname,
1504 char_u *varname_end)
1505{
1506 char_u *name = vim_strnsave(varname, varname_end - varname);
1507 int dup = FALSE;
1508
1509 for (int i = 0; i < enum_gap->ga_len; ++i)
1510 {
1511 ocmember_T *m = ((ocmember_T *)enum_gap->ga_data) + i;
1512 if (STRCMP(name, m->ocm_name) == 0)
1513 {
1514 semsg(_(e_duplicate_enum_str), name);
1515 dup = TRUE;
1516 break;
1517 }
1518 }
1519
1520 vim_free(name);
1521 return dup;
1522}
1523
1524/*
1525 * Parse the enum values in "line" separated by comma and add them to "gap".
1526 * If the last enum value is found, then "enum_end" is set to TRUE.
1527 */
1528 static int
1529enum_parse_values(
1530 exarg_T *eap,
1531 class_T *en,
1532 char_u *line,
1533 garray_T *gap,
1534 int *num_enum_values,
1535 int *enum_end)
1536{
1537 evalarg_T evalarg;
1538 char_u *p = line;
1539 char initexpr_buf[1024];
1540 char_u last_char = NUL;
1541 int rc = OK;
1542
1543 fill_evalarg_from_eap(&evalarg, eap, FALSE);
1544
1545 int did_emsg_before = did_emsg;
1546 while (*p != NUL)
1547 {
1548 // ignore comment
1549 if (*p == '#')
1550 break;
1551
1552 if (!eval_isnamec1(*p))
1553 {
1554 semsg(_(e_invalid_enum_value_declaration_str), p);
1555 break;
1556 }
1557
1558 char_u *eni_name_start = p;
1559 char_u *eni_name_end = to_name_end(p, FALSE);
1560
1561 if (is_duplicate_enum(gap, eni_name_start, eni_name_end))
1562 break;
1563
1564 p = skipwhite(eni_name_end);
1565
1566 char_u *init_expr = NULL;
1567 if (*p == '(')
1568 {
1569 if (VIM_ISWHITE(p[-1]))
1570 {
1571 semsg(_(e_no_white_space_allowed_before_str_str), "(", line);
1572 break;
1573 }
1574
1575 char_u *expr_start, *expr_end;
1576
1577 p = eni_name_start;
1578 (void)skip_expr_concatenate(&p, &expr_start, &expr_end, &evalarg);
1579
1580 while (*expr_start && *expr_start != '(')
1581 expr_start++;
1582
1583 if (expr_end > expr_start)
1584 init_expr = vim_strnsave(expr_start, expr_end - expr_start);
1585 }
1586
1587 if (init_expr == NULL)
1588 vim_snprintf(initexpr_buf, sizeof(initexpr_buf), "%s.new()",
1589 en->class_name);
1590 else
1591 {
1592 vim_snprintf(initexpr_buf, sizeof(initexpr_buf), "%s.new%s",
1593 en->class_name, init_expr);
1594 vim_free(init_expr);
1595 }
1596 if (add_member(gap, eni_name_start, eni_name_end, FALSE,
1597 TRUE, TRUE, TRUE, &en->class_object_type,
1598 vim_strsave((char_u *)initexpr_buf)) == FAIL)
1599 break;
1600
1601 ++*num_enum_values;
1602
1603 if (*p != '#')
1604 last_char = *p;
1605
1606 if (*p != NUL && *p != ',')
1607 break;
1608
1609 if (*p == ',')
1610 {
1611 if (!IS_WHITE_OR_NUL(p[1]))
1612 {
1613 semsg(_(e_white_space_required_after_str_str), ",", line);
1614 break;
1615 }
1616 if (VIM_ISWHITE(p[-1]))
1617 {
1618 semsg(_(e_no_white_space_allowed_before_str_str), ",", line);
1619 break;
1620 }
1621 p = skipwhite(p + 1);
1622 }
1623 }
1624
1625 if (*p != NUL && *p != '#')
1626 {
1627 if (did_emsg == did_emsg_before)
1628 semsg(_(e_missing_comma_before_argument_str), p);
1629 rc = FAIL;
1630 }
1631
1632 if (last_char != ',')
1633 // last enum value should not be terminated by ","
1634 *enum_end = TRUE;
1635
1636 // Free the memory pointed by expr_start.
1637 clear_evalarg(&evalarg, NULL);
1638
1639 return rc;
1640}
1641
1642/*
1643 * Add the "values" class variable (List of enum value objects) to the enum
1644 * class "en"
1645 */
1646 static int
1647enum_add_values_member(
1648 class_T *en,
1649 garray_T *gap,
1650 int num_enum_values,
1651 garray_T *type_list_gap)
1652{
1653 garray_T fga;
1654 int rc = FAIL;
1655
1656 ga_init2(&fga, 1, 1000);
1657 ga_concat(&fga, (char_u *)"[");
1658 for (int i = 0; i < num_enum_values; ++i)
1659 {
1660 ocmember_T *m = ((ocmember_T *)gap->ga_data) + i;
1661
1662 if (i > 0)
1663 ga_concat(&fga, (char_u *)", ");
1664 ga_concat(&fga, en->class_name);
1665 ga_concat(&fga, (char_u *)".");
1666 ga_concat(&fga, (char_u *)m->ocm_name);
1667 }
1668 ga_concat(&fga, (char_u *)"]");
1669 ga_append(&fga, NUL);
1670
1671 char_u *varname = (char_u *)"values";
1672
1673 type_T *type = get_type_ptr(type_list_gap);
1674 if (type == NULL)
1675 goto done;
1676
1677 type->tt_type = VAR_LIST;
1678 type->tt_member = get_type_ptr(type_list_gap);
1679 if (type->tt_member != NULL)
1680 {
1681 type->tt_member->tt_type = VAR_OBJECT;
1682 type->tt_member->tt_class = en;
1683 }
1684
1685 rc = add_member(gap, varname, varname + 6, FALSE, FALSE, TRUE, TRUE, type,
1686 vim_strsave((char_u *)fga.ga_data));
1687
1688done:
1689 vim_free(fga.ga_data);
1690
1691 return rc;
1692}
1693
1694/*
1695 * Clear the constructor method names in a enum class, so that an enum class
1696 * cannot be instantiated.
1697 */
1698 static void
1699enum_clear_constructors(class_T *en)
1700{
1701 for (int i = 0; i < en->class_class_function_count; ++i)
1702 {
1703 ufunc_T *fp = en->class_class_functions[i];
1704
1705 if (fp->uf_flags & FC_NEW)
1706 *fp->uf_name = NUL;
1707 }
1708}
1709
1710/*
1711 * Initialize the name and ordinal object variable in the enum value "enval" in
1712 * the enum "en". These values are set during the enum value object creation.
1713 */
1714 void
1715enum_set_internal_obj_vars(class_T *en, object_T *enval)
1716{
1717 int i;
1718
1719 for (i = 0; i < en->class_class_member_count; ++i)
1720 {
1721 typval_T *en_tv = en->class_members_tv + i;
1722 if (en_tv != NULL && en_tv->v_type == VAR_UNKNOWN)
1723 break;
1724 }
1725
1726 // First object variable is the name
1727 ocmember_T *value_ocm = en->class_class_members + i;
1728 typval_T *name_tv = (typval_T *)(enval + 1);
1729 name_tv->v_type = VAR_STRING;
1730 name_tv->vval.v_string = vim_strsave(value_ocm->ocm_name);
1731
1732 // Second object variable is the ordinal
1733 typval_T *ord_tv = (typval_T *)(name_tv + 1);
1734 ord_tv->v_type = VAR_NUMBER;
1735 ord_tv->vval.v_number = i;
1736}
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001737
1738/*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001739 * Handle ":class" and ":abstract class" up to ":endclass".
Bram Moolenaar554d0312023-01-05 19:59:18 +00001740 * Handle ":interface" up to ":endinterface".
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001741 */
1742 void
1743ex_class(exarg_T *eap)
1744{
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001745 int is_class = eap->cmdidx == CMD_class;
1746 int is_abstract = eap->cmdidx == CMD_abstract;
1747 int is_enum = eap->cmdidx == CMD_enum;
1748 int is_interface;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001749 long start_lnum = SOURCING_LNUM;
1750 char_u *arg = eap->arg;
Bram Moolenaar554d0312023-01-05 19:59:18 +00001751
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001752 if (is_abstract)
1753 {
1754 if (STRNCMP(arg, "class", 5) != 0 || !VIM_ISWHITE(arg[5]))
1755 {
1756 semsg(_(e_invalid_argument_str), arg);
1757 return;
1758 }
1759 arg = skipwhite(arg + 5);
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001760 is_class = TRUE;
1761 }
1762
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001763 is_interface = !is_class && !is_enum;
1764
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001765 if (!current_script_is_vim9()
1766 || (cmdmod.cmod_flags & CMOD_LEGACY)
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01001767 || !getline_equal(eap->ea_getline, eap->cookie, getsourceline))
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001768 {
1769 if (is_class)
1770 emsg(_(e_class_can_only_be_defined_in_vim9_script));
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001771 else if (is_enum)
1772 emsg(_(e_enum_can_only_be_defined_in_vim9_script));
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001773 else
1774 emsg(_(e_interface_can_only_be_defined_in_vim9_script));
1775 return;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001776 }
1777
1778 if (!ASCII_ISUPPER(*arg))
1779 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001780 if (is_class)
1781 semsg(_(e_class_name_must_start_with_uppercase_letter_str), arg);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001782 else if (is_enum)
1783 semsg(_(e_enum_name_must_start_with_uppercase_letter_str), arg);
Bram Moolenaar554d0312023-01-05 19:59:18 +00001784 else
1785 semsg(_(e_interface_name_must_start_with_uppercase_letter_str),
1786 arg);
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001787 return;
1788 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001789 char_u *name_end = find_name_end(arg, NULL, NULL, FNE_CHECK_START);
1790 if (!IS_WHITE_OR_NUL(*name_end))
1791 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001792 semsg(_(e_white_space_required_after_name_str), arg);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001793 return;
1794 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001795 char_u *name_start = arg;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001796
1797 // TODO:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001798 // generics: <Tkey, Tentry>
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001799
Bram Moolenaar83677162023-01-08 19:54:10 +00001800 // Name for "extends BaseClass"
1801 char_u *extends = NULL;
1802
Bram Moolenaar94674f22023-01-06 18:42:20 +00001803 // Names for "implements SomeInterface"
1804 garray_T ga_impl;
1805 ga_init2(&ga_impl, sizeof(char_u *), 5);
1806
1807 arg = skipwhite(name_end);
1808 while (*arg != NUL && *arg != '#' && *arg != '\n')
1809 {
1810 // TODO:
Bram Moolenaar94674f22023-01-06 18:42:20 +00001811 // specifies SomeInterface
Bram Moolenaar83677162023-01-08 19:54:10 +00001812 if (STRNCMP(arg, "extends", 7) == 0 && IS_WHITE_OR_NUL(arg[7]))
1813 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001814 if (is_enum)
1815 {
1816 emsg(_(e_enum_cannot_extend_class));
1817 goto early_ret;
1818 }
Bram Moolenaar83677162023-01-08 19:54:10 +00001819 if (extends != NULL)
1820 {
1821 emsg(_(e_duplicate_extends));
1822 goto early_ret;
1823 }
1824 arg = skipwhite(arg + 7);
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001825
1826 char_u *end = find_class_name_end(arg);
Bram Moolenaar83677162023-01-08 19:54:10 +00001827 if (!IS_WHITE_OR_NUL(*end))
1828 {
1829 semsg(_(e_white_space_required_after_name_str), arg);
1830 goto early_ret;
1831 }
1832 extends = vim_strnsave(arg, end - arg);
1833 if (extends == NULL)
1834 goto early_ret;
1835
1836 arg = skipwhite(end + 1);
1837 }
1838 else if (STRNCMP(arg, "implements", 10) == 0
1839 && IS_WHITE_OR_NUL(arg[10]))
Bram Moolenaar94674f22023-01-06 18:42:20 +00001840 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001841 if (is_interface)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001842 {
1843 emsg(_(e_interface_cannot_use_implements));
1844 goto early_ret;
1845 }
1846
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001847 if (ga_impl.ga_len > 0)
1848 {
1849 emsg(_(e_duplicate_implements));
1850 goto early_ret;
1851 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001852 arg = skipwhite(arg + 10);
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001853
1854 for (;;)
Bram Moolenaar94674f22023-01-06 18:42:20 +00001855 {
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001856 char_u *impl_end = find_class_name_end(arg);
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02001857 if ((!IS_WHITE_OR_NUL(*impl_end) && *impl_end != ',')
1858 || (*impl_end == ','
1859 && !IS_WHITE_OR_NUL(*(impl_end + 1))))
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001860 {
1861 semsg(_(e_white_space_required_after_name_str), arg);
1862 goto early_ret;
1863 }
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02001864 if (impl_end - arg == 0)
1865 {
1866 emsg(_(e_missing_name_after_implements));
1867 goto early_ret;
1868 }
1869
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001870 char_u *iname = vim_strnsave(arg, impl_end - arg);
1871 if (iname == NULL)
1872 goto early_ret;
1873 for (int i = 0; i < ga_impl.ga_len; ++i)
1874 if (STRCMP(((char_u **)ga_impl.ga_data)[i], iname) == 0)
1875 {
1876 semsg(_(e_duplicate_interface_after_implements_str),
1877 iname);
1878 vim_free(iname);
1879 goto early_ret;
1880 }
1881 if (ga_add_string(&ga_impl, iname) == FAIL)
1882 {
1883 vim_free(iname);
1884 goto early_ret;
1885 }
1886 if (*impl_end != ',')
1887 {
1888 arg = skipwhite(impl_end);
1889 break;
1890 }
1891 arg = skipwhite(impl_end + 1);
Bram Moolenaar94674f22023-01-06 18:42:20 +00001892 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001893 }
1894 else
1895 {
1896 semsg(_(e_trailing_characters_str), arg);
1897early_ret:
Bram Moolenaar83677162023-01-08 19:54:10 +00001898 vim_free(extends);
Bram Moolenaar94674f22023-01-06 18:42:20 +00001899 ga_clear_strings(&ga_impl);
1900 return;
1901 }
1902 }
1903
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001904 garray_T type_list; // list of pointers to allocated types
1905 ga_init2(&type_list, sizeof(type_T *), 10);
1906
Bram Moolenaard505d172022-12-18 21:42:55 +00001907 // Growarray with class members declared in the class.
1908 garray_T classmembers;
1909 ga_init2(&classmembers, sizeof(ocmember_T), 10);
1910
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001911 // Growarray with functions declared in the class.
1912 garray_T classfunctions;
1913 ga_init2(&classfunctions, sizeof(ufunc_T *), 10);
Bram Moolenaard505d172022-12-18 21:42:55 +00001914
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001915 // Growarray with object members declared in the class.
1916 garray_T objmembers;
Bram Moolenaard505d172022-12-18 21:42:55 +00001917 ga_init2(&objmembers, sizeof(ocmember_T), 10);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001918
1919 // Growarray with object methods declared in the class.
1920 garray_T objmethods;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001921 ga_init2(&objmethods, sizeof(ufunc_T *), 10);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001922
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001923 class_T *cl = NULL;
1924 class_T *extends_cl = NULL; // class from "extends" argument
1925 class_T **intf_classes = NULL;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001926 int num_enum_values = 0;
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001927
1928 cl = ALLOC_CLEAR_ONE(class_T);
1929 if (cl == NULL)
1930 goto cleanup;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001931
1932 if (is_enum)
1933 cl->class_flags = CLASS_ENUM;
1934 else if (is_interface)
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001935 cl->class_flags = CLASS_INTERFACE;
1936 else if (is_abstract)
1937 cl->class_flags = CLASS_ABSTRACT;
1938
1939 cl->class_refcount = 1;
1940 cl->class_name = vim_strnsave(name_start, name_end - name_start);
1941 if (cl->class_name == NULL)
1942 goto cleanup;
1943
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001944 cl->class_type.tt_type = VAR_CLASS;
1945 cl->class_type.tt_class = cl;
1946 cl->class_object_type.tt_type = VAR_OBJECT;
1947 cl->class_object_type.tt_class = cl;
1948
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001949 // Add the class to the script-local variables.
1950 // TODO: handle other context, e.g. in a function
1951 // TODO: does uf_hash need to be cleared?
1952 typval_T tv;
1953 tv.v_type = VAR_CLASS;
1954 tv.vval.v_class = cl;
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001955 SOURCING_LNUM = start_lnum;
1956 int rc = set_var_const(cl->class_name, current_sctx.sc_sid,
1957 NULL, &tv, FALSE, 0, 0);
1958 if (rc == FAIL)
1959 goto cleanup;
1960
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001961 if (is_enum)
1962 {
1963 // All the enum classes have the name and ordinal object variables.
1964 char_u *varname = (char_u *)"name";
1965 if (add_member(&objmembers, varname, varname + 4, FALSE, FALSE, TRUE,
1966 TRUE, &t_string, NULL) == FAIL)
1967 goto cleanup;
1968
1969 varname = (char_u *)"ordinal";
1970 if (add_member(&objmembers, varname, varname + 7, FALSE, FALSE, TRUE,
1971 TRUE, &t_number, NULL) == FAIL)
1972 goto cleanup;
1973 }
1974
1975 // "export class" gets used when creating the class, don't use "is_export"
1976 // for the items inside the class.
1977 is_export = FALSE;
1978
1979 // When parsing an enum definition, this denotes whether all the enumerated
1980 // values are parsed or not.
1981 int enum_end = FALSE;
1982
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001983 /*
Bram Moolenaar554d0312023-01-05 19:59:18 +00001984 * Go over the body of the class/interface until "endclass" or
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001985 * "endinterface" or "endenum" is found.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001986 */
1987 char_u *theline = NULL;
1988 int success = FALSE;
1989 for (;;)
1990 {
1991 vim_free(theline);
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01001992 theline = eap->ea_getline(':', eap->cookie, 0, GETLINE_CONCAT_ALL);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001993 if (theline == NULL)
1994 break;
1995 char_u *line = skipwhite(theline);
1996
Bram Moolenaar418b5472022-12-20 13:38:22 +00001997 // Skip empty and comment lines.
1998 if (*line == NUL)
1999 continue;
2000 if (*line == '#')
2001 {
2002 if (vim9_bad_comment(line))
2003 break;
2004 continue;
2005 }
2006
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002007 char_u *p = line;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002008
2009 char *end_name;
2010 int shortlen;
2011 int fullen;
2012 if (is_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002013 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002014 end_name = "endclass";
2015 shortlen = 4;
2016 fullen = 8;
2017 }
2018 else if (is_enum)
2019 {
2020 end_name = "endenum";
2021 shortlen = 4;
2022 fullen = 7;
2023 }
2024 else
2025 {
2026 end_name = "endinterface";
2027 shortlen = 5;
2028 fullen = 12;
2029 }
2030
2031 if (checkforcmd(&p, end_name, shortlen))
2032 {
2033 if (STRNCMP(line, end_name, fullen) != 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002034 semsg(_(e_command_cannot_be_shortened_str), line);
2035 else if (*p == '|' || !ends_excmd2(line, p))
2036 semsg(_(e_trailing_characters_str), p);
Bram Moolenaar98aeb212022-12-08 22:09:14 +00002037 else
2038 success = TRUE;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002039 break;
2040 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002041
2042 int wrong_endname = FALSE;
2043 if (is_class)
2044 wrong_endname = checkforcmd(&p, "endinterface", 5)
2045 || checkforcmd(&p, "endenum", 4);
2046 else if (is_enum)
2047 wrong_endname = checkforcmd(&p, "endclass", 4)
2048 || checkforcmd(&p, "endinterface", 5);
2049 else
2050 wrong_endname = checkforcmd(&p, "endclass", 4)
2051 || checkforcmd(&p, "endenum", 4);
2052 if (wrong_endname)
Bram Moolenaar554d0312023-01-05 19:59:18 +00002053 {
Bram Moolenaar657aea72023-01-27 13:16:19 +00002054 semsg(_(e_invalid_command_str_expected_str), line, end_name);
Bram Moolenaar554d0312023-01-05 19:59:18 +00002055 break;
2056 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002057
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002058 if (is_enum && !enum_end)
2059 {
2060 // In an enum, all the enumerated values are at the beginning
2061 // separated by comma. The class and object variables/methods
2062 // follow the values.
2063 if (enum_parse_values(eap, cl, line, &classmembers,
2064 &num_enum_values, &enum_end) == FAIL)
2065 break;
Yegappan Lakshmananabedca92024-03-29 10:08:23 +01002066
2067 if (enum_end)
2068 // Add the enum "values" class variable.
2069 enum_add_values_member(cl, &classmembers, num_enum_values,
2070 &type_list);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002071 continue;
2072 }
2073
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002074 int has_public = FALSE;
2075 if (checkforcmd(&p, "public", 3))
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002076 {
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002077 if (STRNCMP(line, "public", 6) != 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002078 {
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002079 semsg(_(e_command_cannot_be_shortened_str), line);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002080 break;
2081 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002082 if (is_interface)
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02002083 {
Yegappan Lakshmananb90e3bc2023-09-28 23:06:48 +02002084 emsg(_(e_public_variable_not_supported_in_interface));
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02002085 break;
2086 }
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002087 has_public = TRUE;
2088 p = skipwhite(line + 6);
2089
Yegappan Lakshmananc51578f2024-04-13 17:58:09 +02002090 if (STRNCMP(p, "def", 3) == 0)
2091 {
2092 emsg(_(e_public_keyword_not_supported_for_method));
2093 break;
2094 }
2095
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002096 if (STRNCMP(p, "var", 3) != 0 && STRNCMP(p, "static", 6) != 0
2097 && STRNCMP(p, "final", 5) != 0 && STRNCMP(p, "const", 5) != 0)
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002098 {
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002099 emsg(_(e_public_must_be_followed_by_var_static_final_or_const));
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002100 break;
2101 }
2102 }
Bram Moolenaard505d172022-12-18 21:42:55 +00002103
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002104 int abstract_method = FALSE;
2105 char_u *pa = p;
2106 if (checkforcmd(&p, "abstract", 3))
2107 {
2108 if (STRNCMP(pa, "abstract", 8) != 0)
2109 {
2110 semsg(_(e_command_cannot_be_shortened_str), pa);
2111 break;
2112 }
2113
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002114 if (is_enum)
2115 {
2116 // "abstract" not supported in an enum
2117 emsg(_(e_abstract_cannot_be_used_in_enum));
2118 break;
2119 }
2120
2121 if (is_interface)
Yegappan Lakshmanan2b358ad2023-11-02 20:57:32 +01002122 {
2123 // "abstract" not supported in an interface
2124 emsg(_(e_abstract_cannot_be_used_in_interface));
2125 break;
2126 }
2127
2128 if (!is_abstract)
2129 {
2130 semsg(_(e_abstract_method_in_concrete_class), pa);
2131 break;
2132 }
2133
Yegappan Lakshmanan5a539252023-11-04 09:42:46 +01002134 p = skipwhite(pa + 8);
2135 if (STRNCMP(p, "def", 3) != 0)
2136 {
2137 emsg(_(e_abstract_must_be_followed_by_def));
2138 break;
2139 }
2140
Yegappan Lakshmanan2b358ad2023-11-02 20:57:32 +01002141 abstract_method = TRUE;
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002142 }
2143
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002144 int has_static = FALSE;
2145 char_u *ps = p;
2146 if (checkforcmd(&p, "static", 4))
2147 {
2148 if (STRNCMP(ps, "static", 6) != 0)
2149 {
2150 semsg(_(e_command_cannot_be_shortened_str), ps);
2151 break;
2152 }
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002153
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002154 if (is_interface)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002155 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002156 emsg(_(e_static_member_not_supported_in_interface));
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002157 break;
2158 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002159 has_static = TRUE;
2160 p = skipwhite(ps + 6);
Doug Kearns74da0ee2023-12-14 20:26:26 +01002161
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002162 if (STRNCMP(p, "var", 3) != 0 && STRNCMP(p, "def", 3) != 0
2163 && STRNCMP(p, "final", 5) != 0 && STRNCMP(p, "const", 5) != 0)
Doug Kearns74da0ee2023-12-14 20:26:26 +01002164 {
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002165 emsg(_(e_static_must_be_followed_by_var_def_final_or_const));
Doug Kearns74da0ee2023-12-14 20:26:26 +01002166 break;
2167 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002168 }
2169
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002170 int has_final = FALSE;
2171 int has_var = FALSE;
2172 int has_const = FALSE;
2173 if (checkforcmd(&p, "var", 3))
2174 has_var = TRUE;
2175 else if (checkforcmd(&p, "final", 5))
2176 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002177 if (is_interface)
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002178 {
2179 emsg(_(e_final_variable_not_supported_in_interface));
2180 break;
2181 }
2182 has_final = TRUE;
2183 }
2184 else if (checkforcmd(&p, "const", 5))
2185 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002186 if (is_interface)
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002187 {
2188 emsg(_(e_const_variable_not_supported_in_interface));
2189 break;
2190 }
2191 has_const = TRUE;
2192 }
2193 p = skipwhite(p);
2194
Bram Moolenaard505d172022-12-18 21:42:55 +00002195 // object members (public, read access, private):
Doug Kearns74da0ee2023-12-14 20:26:26 +01002196 // "var _varname"
2197 // "var varname"
2198 // "public var varname"
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002199 // "final _varname"
2200 // "final varname"
2201 // "public final varname"
2202 // "const _varname"
2203 // "const varname"
2204 // "public const varname"
Doug Kearns74da0ee2023-12-14 20:26:26 +01002205 // class members (public, read access, private):
2206 // "static var _varname"
2207 // "static var varname"
2208 // "public static var varname"
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002209 // "static final _varname"
2210 // "static final varname"
2211 // "public static final varname"
2212 // "static const _varname"
2213 // "static const varname"
2214 // "public static const varname"
2215 if (has_var || has_final || has_const)
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002216 {
Doug Kearns74da0ee2023-12-14 20:26:26 +01002217 char_u *varname = p;
Bram Moolenaard505d172022-12-18 21:42:55 +00002218 char_u *varname_end = NULL;
Bram Moolenaar74e12742022-12-13 21:14:28 +00002219 type_T *type = NULL;
Bram Moolenaard505d172022-12-18 21:42:55 +00002220 char_u *init_expr = NULL;
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002221 int has_type = FALSE;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002222
Doug Kearns74da0ee2023-12-14 20:26:26 +01002223 if (!eval_isnamec1(*p))
2224 {
2225 if (has_static)
2226 semsg(_(e_invalid_class_variable_declaration_str), line);
2227 else
2228 semsg(_(e_invalid_object_variable_declaration_str), line);
2229 break;
2230 }
2231
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002232 if (is_interface && *varname == '_')
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002233 {
2234 // private variables are not supported in an interface
Ernie Rael03042a22023-11-11 08:53:32 +01002235 semsg(_(e_protected_variable_not_supported_in_interface),
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002236 varname);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002237 break;
2238 }
2239
Bram Moolenaard505d172022-12-18 21:42:55 +00002240 if (parse_member(eap, line, varname, has_public,
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002241 &varname_end, &has_type, &type_list, &type,
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002242 !is_interface ? &init_expr: NULL) == FAIL)
Bram Moolenaard505d172022-12-18 21:42:55 +00002243 break;
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002244
2245 if (is_reserved_varname(varname, varname_end)
2246 || is_duplicate_variable(&classmembers, &objmembers,
2247 varname, varname_end))
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02002248 {
2249 vim_free(init_expr);
2250 break;
2251 }
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002252 if (add_member(has_static ? &classmembers : &objmembers, varname,
2253 varname_end, has_public, has_final, has_const,
2254 has_type, type, init_expr) == FAIL)
Bram Moolenaar74e12742022-12-13 21:14:28 +00002255 {
Bram Moolenaard505d172022-12-18 21:42:55 +00002256 vim_free(init_expr);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002257 break;
2258 }
Bram Moolenaard505d172022-12-18 21:42:55 +00002259 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002260
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002261 // constructors:
2262 // def new()
2263 // enddef
2264 // def newOther()
2265 // enddef
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002266 // object methods and class functions:
2267 // def SomeMethod()
2268 // enddef
2269 // static def ClassFunction()
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002270 // enddef
2271 // TODO:
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002272 // def <Tval> someMethod()
2273 // enddef
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002274 else if (checkforcmd(&p, "def", 3))
2275 {
2276 exarg_T ea;
2277 garray_T lines_to_free;
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002278 int is_new = STRNCMP(p, "new", 3) == 0;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002279
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02002280 if (has_public)
2281 {
2282 // "public" keyword is not supported when defining an object or
2283 // class method
2284 emsg(_(e_public_keyword_not_supported_for_method));
2285 break;
2286 }
2287
2288 if (*p == NUL)
2289 {
2290 // No method name following def
2291 semsg(_(e_not_valid_command_in_class_str), line);
2292 break;
2293 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002294
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002295 if (is_interface && *p == '_')
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002296 {
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002297 // private methods are not supported in an interface
2298 semsg(_(e_protected_method_not_supported_in_interface), p);
2299 break;
2300 }
2301
2302 if (has_static && !is_new && SAFE_islower(*p) &&
2303 is_valid_builtin_obj_methodname(p))
2304 {
2305 semsg(_(e_builtin_class_method_not_supported), p);
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002306 break;
2307 }
2308
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002309 CLEAR_FIELD(ea);
2310 ea.cmd = line;
2311 ea.arg = p;
2312 ea.cmdidx = CMD_def;
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01002313 ea.ea_getline = eap->ea_getline;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002314 ea.cookie = eap->cookie;
2315
2316 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002317 int class_flags;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002318 if (is_interface)
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002319 class_flags = CF_INTERFACE;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002320 else
2321 class_flags = abstract_method ? CF_ABSTRACT_METHOD : CF_CLASS;
Bram Moolenaar554d0312023-01-05 19:59:18 +00002322 ufunc_T *uf = define_function(&ea, NULL, &lines_to_free,
h-eastb895b0f2023-09-24 15:46:31 +02002323 class_flags, objmembers.ga_data, objmembers.ga_len);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002324 ga_clear_strings(&lines_to_free);
2325
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002326 if (uf != NULL)
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002327 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002328 char_u *name = uf->uf_name;
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +02002329
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002330 if (is_new && !is_valid_constructor(uf, is_abstract,
2331 has_static))
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002332 {
2333 // private variables are not supported in an interface
Ernie Rael03042a22023-11-11 08:53:32 +01002334 semsg(_(e_protected_method_not_supported_in_interface),
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002335 name);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002336 func_clear_free(uf, FALSE);
2337 break;
2338 }
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002339
2340 // check for builtin method
2341 if (!is_new && SAFE_islower(*name) &&
2342 !object_check_builtin_method_sig(uf))
Bram Moolenaar24a8d062023-01-14 13:12:06 +00002343 {
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02002344 func_clear_free(uf, FALSE);
Bram Moolenaar24a8d062023-01-14 13:12:06 +00002345 break;
2346 }
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +02002347
Bram Moolenaar58b40092023-01-11 15:59:05 +00002348 // Check the name isn't used already.
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002349 if (is_duplicate_method(&classfunctions, &objmethods, name))
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002350 {
2351 success = FALSE;
2352 func_clear_free(uf, FALSE);
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02002353 break;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002354 }
Bram Moolenaar58b40092023-01-11 15:59:05 +00002355
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002356 garray_T *fgap = has_static || is_new
2357 ? &classfunctions : &objmethods;
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002358 if (ga_grow(fgap, 1) == OK)
2359 {
2360 if (is_new)
2361 uf->uf_flags |= FC_NEW;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002362
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002363 if (abstract_method)
2364 uf->uf_flags |= FC_ABSTRACT;
2365
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002366 ((ufunc_T **)fgap->ga_data)[fgap->ga_len] = uf;
2367 ++fgap->ga_len;
2368 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002369 }
2370 }
2371
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002372 else
2373 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00002374 if (is_class)
2375 semsg(_(e_not_valid_command_in_class_str), line);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002376 else if (is_enum)
2377 semsg(_(e_not_valid_command_in_enum_str), line);
Bram Moolenaar554d0312023-01-05 19:59:18 +00002378 else
2379 semsg(_(e_not_valid_command_in_interface_str), line);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002380 break;
2381 }
2382 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002383
2384 if (theline == NULL && !success && is_enum)
2385 emsg(_(e_missing_endenum));
2386
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002387 vim_free(theline);
2388
Yegappan Lakshmananabedca92024-03-29 10:08:23 +01002389 if (success && is_enum && num_enum_values == 0)
2390 // Empty enum statement. Add an empty "values" class variable
2391 enum_add_values_member(cl, &classmembers, 0, &type_list);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002392
Bram Moolenaar83677162023-01-08 19:54:10 +00002393 /*
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002394 * Check a few things
Bram Moolenaar83677162023-01-08 19:54:10 +00002395 */
2396
2397 // Check the "extends" class is valid.
2398 if (success && extends != NULL)
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01002399 success = validate_extends_class(cl, extends, &extends_cl, is_class);
Bram Moolenaar83677162023-01-08 19:54:10 +00002400 VIM_CLEAR(extends);
2401
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002402 // Check the new object methods to make sure their access (public or
2403 // private) is the same as that in the extended class lineage.
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002404 if (success && extends_cl != NULL)
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002405 success = validate_extends_methods(&objmethods, extends_cl);
2406
2407 // Check the new class and object variables are not duplicates of the
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002408 // variables in the extended class lineage. If an interface is extending
2409 // another interface, then it can duplicate the member variables.
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002410 if (success && extends_cl != NULL)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002411 {
2412 if (is_class)
2413 success = extends_check_dup_members(&objmembers, extends_cl);
2414 else
2415 success = extends_check_intf_var_type(&objmembers, extends_cl);
2416 }
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002417
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002418 // When extending an abstract class, make sure all the abstract methods in
2419 // the parent class are implemented. If the current class is an abstract
2420 // class, then there is no need for this check.
2421 if (success && !is_abstract && extends_cl != NULL
2422 && (extends_cl->class_flags & CLASS_ABSTRACT))
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002423 success = validate_abstract_class_methods(&classfunctions,
2424 &objmethods, extends_cl);
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002425
Bram Moolenaar83677162023-01-08 19:54:10 +00002426 // Check all "implements" entries are valid.
Bram Moolenaar94674f22023-01-06 18:42:20 +00002427 if (success && ga_impl.ga_len > 0)
2428 {
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00002429 intf_classes = ALLOC_CLEAR_MULT(class_T *, ga_impl.ga_len);
2430
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002431 success = validate_implements_classes(&ga_impl, intf_classes,
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002432 &objmethods, &objmembers, extends_cl);
Bram Moolenaar94674f22023-01-06 18:42:20 +00002433 }
2434
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002435 // Check no function argument name is used as a class member.
Bram Moolenaard40f00c2023-01-13 17:36:49 +00002436 if (success)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002437 success = check_func_arg_names(&classfunctions, &objmethods,
2438 &classmembers);
Bram Moolenaard40f00c2023-01-13 17:36:49 +00002439
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002440 if (success)
2441 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002442 // "endclass" or "endinterface" or "endenum" encountered without any
2443 // failures
Bram Moolenaard505d172022-12-18 21:42:55 +00002444
Bram Moolenaard0200c82023-01-28 15:19:40 +00002445 if (extends_cl != NULL)
2446 {
2447 cl->class_extends = extends_cl;
2448 extends_cl->class_flags |= CLASS_EXTENDED;
2449 }
Bram Moolenaar83677162023-01-08 19:54:10 +00002450
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002451 // Add class and object variables to "cl".
Bram Moolenaard505d172022-12-18 21:42:55 +00002452 if (add_members_to_class(&classmembers,
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002453 NULL,
2454 0,
Bram Moolenaar83677162023-01-08 19:54:10 +00002455 &cl->class_class_members,
2456 &cl->class_class_member_count) == FAIL
Bram Moolenaard505d172022-12-18 21:42:55 +00002457 || add_members_to_class(&objmembers,
Bram Moolenaar83677162023-01-08 19:54:10 +00002458 extends_cl == NULL ? NULL
2459 : extends_cl->class_obj_members,
2460 extends_cl == NULL ? 0
2461 : extends_cl->class_obj_member_count,
2462 &cl->class_obj_members,
2463 &cl->class_obj_member_count) == FAIL)
Bram Moolenaard505d172022-12-18 21:42:55 +00002464 goto cleanup;
2465
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00002466 if (ga_impl.ga_len > 0)
2467 {
2468 // Move the "implements" names into the class.
2469 cl->class_interface_count = ga_impl.ga_len;
2470 cl->class_interfaces = ALLOC_MULT(char_u *, ga_impl.ga_len);
2471 if (cl->class_interfaces == NULL)
2472 goto cleanup;
2473 for (int i = 0; i < ga_impl.ga_len; ++i)
2474 cl->class_interfaces[i] = ((char_u **)ga_impl.ga_data)[i];
2475 VIM_CLEAR(ga_impl.ga_data);
2476 ga_impl.ga_len = 0;
2477
Bram Moolenaard0200c82023-01-28 15:19:40 +00002478 cl->class_interfaces_cl = intf_classes;
2479 intf_classes = NULL;
2480 }
2481
2482 if (cl->class_interface_count > 0 || extends_cl != NULL)
2483 {
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002484 // Add a method and member lookup table to each of the interface
2485 // classes.
2486 if (add_lookup_tables(cl, extends_cl, &objmethods) == FAIL)
2487 goto cleanup;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00002488 }
2489
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02002490 int have_new = FALSE;
2491 ufunc_T *class_func = NULL;
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002492 for (int i = 0; i < classfunctions.ga_len; ++i)
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02002493 {
2494 class_func = ((ufunc_T **)classfunctions.ga_data)[i];
2495 if (STRCMP(class_func->uf_name, "new") == 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002496 {
2497 have_new = TRUE;
2498 break;
2499 }
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02002500 }
2501
2502 if (have_new)
2503 // The return type of new() is an object of class "cl"
2504 class_func->uf_ret_type->tt_class = cl;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002505 else if ((is_class || is_enum) && !is_abstract && !have_new)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002506 // No new() method was defined, add the default constructor.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002507 add_default_constructor(cl, &classfunctions, &type_list);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002508
Bram Moolenaar58b40092023-01-11 15:59:05 +00002509 // Move all the functions into the created class.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002510 if (add_classfuncs_objmethods(cl, extends_cl, &classfunctions,
2511 &objmethods) == FAIL)
2512 goto cleanup;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002513
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002514 update_builtin_method_index(cl);
2515
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002516 class_created(cl);
2517
2518 // Allocate a typval for each class member and initialize it.
2519 if ((is_class || is_enum) && cl->class_class_member_count > 0)
2520 if (add_class_members(cl, eap, &type_list) == FAIL)
2521 goto cleanup;
2522
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002523 cl->class_type_list = type_list;
2524
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002525 if (is_enum)
2526 {
2527 // clear the constructor method names, so that an enum class cannot
2528 // be instantiated
2529 enum_clear_constructors(cl);
2530 }
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02002531
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002532 // TODO:
Bram Moolenaard505d172022-12-18 21:42:55 +00002533 // - Fill hashtab with object members and methods ?
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002534
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002535 return;
2536 }
2537
2538cleanup:
Bram Moolenaar83677162023-01-08 19:54:10 +00002539 vim_free(extends);
2540 class_unref(extends_cl);
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00002541
2542 if (intf_classes != NULL)
2543 {
2544 for (int i = 0; i < ga_impl.ga_len; ++i)
2545 class_unref(intf_classes[i]);
2546 vim_free(intf_classes);
2547 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00002548 ga_clear_strings(&ga_impl);
2549
Bram Moolenaard505d172022-12-18 21:42:55 +00002550 for (int round = 1; round <= 2; ++round)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002551 {
Bram Moolenaard505d172022-12-18 21:42:55 +00002552 garray_T *gap = round == 1 ? &classmembers : &objmembers;
2553 if (gap->ga_len == 0 || gap->ga_data == NULL)
2554 continue;
2555
2556 for (int i = 0; i < gap->ga_len; ++i)
2557 {
2558 ocmember_T *m = ((ocmember_T *)gap->ga_data) + i;
2559 vim_free(m->ocm_name);
2560 vim_free(m->ocm_init);
2561 }
2562 ga_clear(gap);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002563 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002564
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002565 for (int i = 0; i < objmethods.ga_len; ++i)
2566 {
2567 ufunc_T *uf = ((ufunc_T **)objmethods.ga_data)[i];
2568 func_clear_free(uf, FALSE);
2569 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002570 ga_clear(&objmethods);
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002571
2572 for (int i = 0; i < classfunctions.ga_len; ++i)
2573 {
2574 ufunc_T *uf = ((ufunc_T **)classfunctions.ga_data)[i];
2575 func_clear_free(uf, FALSE);
2576 }
2577 ga_clear(&classfunctions);
2578
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002579 clear_type_list(&type_list);
2580}
2581
2582/*
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002583 * Find member "name" in class "cl", set "member_idx" to the member index and
2584 * return its type.
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002585 * When "is_object" is TRUE, then look for object members. Otherwise look for
2586 * class members.
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002587 * When not found "member_idx" is set to -1 and t_any is returned.
Ernie Rael456ae552023-09-01 18:54:54 +02002588 * Set *p_m ocmmember_T if not NULL
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002589 */
2590 type_T *
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002591oc_member_type(
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002592 class_T *cl,
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002593 int is_object,
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002594 char_u *name,
2595 char_u *name_end,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002596 int *member_idx)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002597{
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002598 size_t len = name_end - name;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002599 ocmember_T *m;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002600
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002601 *member_idx = -1; // not found (yet)
2602
2603 m = member_lookup(cl, is_object ? VAR_OBJECT : VAR_CLASS, name, len,
2604 member_idx);
2605 if (m == NULL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002606 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002607 member_not_found_msg(cl, is_object ? VAR_OBJECT : VAR_CLASS, name,
2608 len);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002609 return &t_any;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002610 }
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002611
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002612 return m->ocm_type;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002613}
2614
2615/*
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002616 * Given a class or object variable index, return the variable type
2617 */
2618 type_T *
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002619oc_member_type_by_idx(
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002620 class_T *cl,
2621 int is_object,
2622 int member_idx)
2623{
2624 ocmember_T *m;
2625 int member_count;
2626
2627 if (is_object)
2628 {
2629 m = cl->class_obj_members;
2630 member_count = cl->class_obj_member_count;
2631 }
2632 else
2633 {
2634 m = cl->class_class_members;
2635 member_count = cl->class_class_member_count;
2636 }
2637
2638 if (member_idx >= member_count)
2639 return NULL;
2640
2641 return m[member_idx].ocm_type;
2642}
2643
2644/*
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002645 * Type aliases (:type)
2646 */
2647
2648 void
2649typealias_free(typealias_T *ta)
2650{
2651 // ta->ta_type is freed in clear_type_list()
2652 vim_free(ta->ta_name);
2653 vim_free(ta);
2654}
2655
2656 void
2657typealias_unref(typealias_T *ta)
2658{
2659 if (ta != NULL && --ta->ta_refcount <= 0)
2660 typealias_free(ta);
2661}
2662
2663/*
2664 * Handle ":type". Create an alias for a type specification.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002665 */
2666 void
2667ex_type(exarg_T *eap UNUSED)
2668{
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002669 char_u *arg = eap->arg;
2670
2671 if (!current_script_is_vim9()
2672 || (cmdmod.cmod_flags & CMOD_LEGACY)
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01002673 || !getline_equal(eap->ea_getline, eap->cookie, getsourceline))
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002674 {
2675 emsg(_(e_type_can_only_be_defined_in_vim9_script));
2676 return;
2677 }
2678
2679 if (*arg == NUL)
2680 {
2681 emsg(_(e_missing_typealias_name));
2682 return;
2683 }
2684
2685 if (!ASCII_ISUPPER(*arg))
2686 {
2687 semsg(_(e_type_name_must_start_with_uppercase_letter_str), arg);
2688 return;
2689 }
2690
2691 char_u *name_end = find_name_end(arg, NULL, NULL, FNE_CHECK_START);
2692 if (!IS_WHITE_OR_NUL(*name_end))
2693 {
2694 semsg(_(e_white_space_required_after_name_str), arg);
2695 return;
2696 }
2697 char_u *name_start = arg;
2698
2699 arg = skipwhite(name_end);
2700 if (*arg != '=')
2701 {
2702 semsg(_(e_missing_equal_str), arg);
2703 return;
2704 }
2705 if (!IS_WHITE_OR_NUL(*(arg + 1)))
2706 {
2707 semsg(_(e_white_space_required_after_str_str), "=", arg);
2708 return;
2709 }
2710 arg++;
2711 arg = skipwhite(arg);
2712
2713 if (*arg == NUL)
2714 {
2715 emsg(_(e_missing_typealias_type));
2716 return;
2717 }
2718
2719 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
2720 type_T *type = parse_type(&arg, &si->sn_type_list, TRUE);
2721 if (type == NULL)
2722 return;
2723
2724 if (*arg != NUL)
2725 {
2726 // some text after the type
2727 semsg(_(e_trailing_characters_str), arg);
2728 return;
2729 }
2730
2731 int cc = *name_end;
2732 *name_end = NUL;
2733
2734 typval_T tv;
2735 tv.v_type = VAR_UNKNOWN;
2736 if (eval_variable_import(name_start, &tv) == OK)
2737 {
2738 if (tv.v_type == VAR_TYPEALIAS)
2739 semsg(_(e_typealias_already_exists_for_str), name_start);
2740 else
2741 semsg(_(e_redefining_script_item_str), name_start);
2742 clear_tv(&tv);
2743 goto done;
2744 }
2745
Yegappan Lakshmananfeaccd22023-10-28 15:53:55 +02002746 // Create a script-local variable for the type alias.
2747 if (type->tt_type != VAR_OBJECT)
2748 {
2749 tv.v_type = VAR_TYPEALIAS;
2750 tv.v_lock = 0;
2751 tv.vval.v_typealias = ALLOC_CLEAR_ONE(typealias_T);
2752 ++tv.vval.v_typealias->ta_refcount;
2753 tv.vval.v_typealias->ta_name = vim_strsave(name_start);
2754 tv.vval.v_typealias->ta_type = type;
2755 }
2756 else
2757 {
2758 // When creating a type alias for a class, use the class type itself to
2759 // create the type alias variable. This is needed to use the type
2760 // alias to invoke class methods (e.g. new()) and use class variables.
2761 tv.v_type = VAR_CLASS;
2762 tv.v_lock = 0;
2763 tv.vval.v_class = type->tt_class;
2764 ++tv.vval.v_class->class_refcount;
2765 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002766 set_var_const(name_start, current_sctx.sc_sid, NULL, &tv, FALSE,
2767 ASSIGN_CONST | ASSIGN_FINAL, 0);
2768
2769done:
2770 *name_end = cc;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002771}
2772
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002773/*
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002774 * Returns OK if a member variable named "name" is present in the class "cl".
2775 * Otherwise returns FAIL. If found, the member variable typval is set in
2776 * "rettv". If "is_object" is TRUE, then the object member variable table is
2777 * searched. Otherwise the class member variable table is searched.
2778 */
2779 static int
2780get_member_tv(
2781 class_T *cl,
2782 int is_object,
2783 char_u *name,
2784 size_t namelen,
2785 typval_T *rettv)
2786{
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002787 ocmember_T *m;
2788 int m_idx;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002789
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002790 m = member_lookup(cl, is_object ? VAR_OBJECT : VAR_CLASS, name, namelen,
2791 &m_idx);
2792 if (m == NULL)
2793 return FAIL;
2794
2795 if (*name == '_')
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002796 {
Ernie Rael03042a22023-11-11 08:53:32 +01002797 emsg_var_cl_define(e_cannot_access_protected_variable_str,
Ernie Raele6c9aa52023-10-06 19:55:52 +02002798 m->ocm_name, 0, cl);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002799 return FAIL;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002800 }
2801
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002802 if (is_object)
2803 {
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002804 // The object only contains a pointer to the class, the member values
2805 // array follows right after that.
2806 object_T *obj = rettv->vval.v_object;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002807 typval_T *tv = (typval_T *)(obj + 1) + m_idx;
2808 copy_tv(tv, rettv);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002809 object_unref(obj);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002810 }
2811 else
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002812 {
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002813 copy_tv(&cl->class_members_tv[m_idx], rettv);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002814 class_unref(cl);
2815 }
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002816
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002817 return OK;
2818}
2819
2820/*
2821 * Call an object or class method "name" in class "cl". The method return
2822 * value is returned in "rettv".
2823 */
2824 static int
2825call_oc_method(
2826 class_T *cl,
2827 char_u *name,
2828 size_t len,
2829 char_u *name_end,
2830 evalarg_T *evalarg,
2831 char_u **arg,
2832 typval_T *rettv)
2833{
2834 ufunc_T *fp;
2835 typval_T argvars[MAX_FUNC_ARGS + 1];
2836 int argcount = 0;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002837 ocmember_T *ocm = NULL;
2838 int m_idx;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002839
2840 fp = method_lookup(cl, rettv->v_type, name, len, NULL);
2841 if (fp == NULL)
2842 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002843 // could be an object or class funcref variable
2844 ocm = member_lookup(cl, rettv->v_type, name, len, &m_idx);
2845 if (ocm == NULL || ocm->ocm_type->tt_type != VAR_FUNC)
2846 {
2847 method_not_found_msg(cl, rettv->v_type, name, len);
2848 return FAIL;
2849 }
2850
Yegappan Lakshmanan3e336502024-04-04 19:35:59 +02002851 if (*name == '_')
2852 {
2853 // Protected object or class funcref variable
2854 semsg(_(e_cannot_access_protected_variable_str), ocm->ocm_name,
2855 cl->class_name);
2856 return FAIL;
2857 }
2858
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002859 if (rettv->v_type == VAR_OBJECT)
2860 {
2861 // funcref object variable
2862 object_T *obj = rettv->vval.v_object;
2863 typval_T *tv = (typval_T *)(obj + 1) + m_idx;
2864 copy_tv(tv, rettv);
2865 }
2866 else
2867 // funcref class variable
2868 copy_tv(&cl->class_members_tv[m_idx], rettv);
2869 *arg = name_end;
2870 return OK;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002871 }
2872
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002873 if (ocm == NULL && *fp->uf_name == '_')
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002874 {
2875 // Cannot access a private method outside of a class
Ernie Rael03042a22023-11-11 08:53:32 +01002876 semsg(_(e_cannot_access_protected_method_str), fp->uf_name);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002877 return FAIL;
2878 }
2879
2880 char_u *argp = name_end;
Ernie Raelb077b582023-12-14 20:11:44 +01002881 int ret = get_func_arguments(&argp, evalarg, 0, argvars, &argcount, FALSE);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002882 if (ret == FAIL)
2883 return FAIL;
2884
2885 funcexe_T funcexe;
2886 CLEAR_FIELD(funcexe);
2887 funcexe.fe_evaluate = TRUE;
2888 if (rettv->v_type == VAR_OBJECT)
2889 {
2890 funcexe.fe_object = rettv->vval.v_object;
2891 ++funcexe.fe_object->obj_refcount;
2892 }
2893
2894 // Clear the class or object after calling the function, in
2895 // case the refcount is one.
2896 typval_T tv_tofree = *rettv;
2897 rettv->v_type = VAR_UNKNOWN;
2898
2899 // Call the user function. Result goes into rettv;
2900 int error = call_user_func_check(fp, argcount, argvars, rettv, &funcexe,
2901 NULL);
2902
2903 // Clear the previous rettv and the arguments.
2904 clear_tv(&tv_tofree);
2905 for (int idx = 0; idx < argcount; ++idx)
2906 clear_tv(&argvars[idx]);
2907
2908 if (error != FCERR_NONE)
2909 {
2910 user_func_error(error, printable_func_name(fp), funcexe.fe_found_var);
2911 return FAIL;
2912 }
2913 *arg = argp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002914
2915 return OK;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002916}
2917
2918/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002919 * Evaluate what comes after a class:
2920 * - class member: SomeClass.varname
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002921 * - class function: SomeClass.SomeMethod()
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002922 * - class constructor: SomeClass.new()
2923 * - object member: someObject.varname
2924 * - object method: someObject.SomeMethod()
2925 *
2926 * "*arg" points to the '.'.
2927 * "*arg" is advanced to after the member name or method call.
2928 *
2929 * Returns FAIL or OK.
2930 */
2931 int
2932class_object_index(
2933 char_u **arg,
2934 typval_T *rettv,
2935 evalarg_T *evalarg,
2936 int verbose UNUSED) // give error messages
2937{
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002938 if (VIM_ISWHITE((*arg)[1]))
2939 {
2940 semsg(_(e_no_white_space_allowed_after_str_str), ".", *arg);
2941 return FAIL;
2942 }
2943
2944 ++*arg;
2945 char_u *name = *arg;
2946 char_u *name_end = find_name_end(name, NULL, NULL, FNE_CHECK_START);
2947 if (name_end == name)
2948 return FAIL;
2949 size_t len = name_end - name;
2950
Ernie Raeld615a312023-10-05 20:28:16 +02002951 int did_emsg_save = did_emsg;
Bram Moolenaar552bdca2023-02-17 21:08:50 +00002952 class_T *cl;
2953 if (rettv->v_type == VAR_CLASS)
2954 cl = rettv->vval.v_class;
2955 else // VAR_OBJECT
2956 {
2957 if (rettv->vval.v_object == NULL)
2958 {
2959 emsg(_(e_using_null_object));
2960 return FAIL;
2961 }
2962 cl = rettv->vval.v_object->obj_class;
2963 }
2964
Bram Moolenaard13dd302023-03-11 20:56:35 +00002965 if (cl == NULL)
2966 {
2967 emsg(_(e_incomplete_type));
2968 return FAIL;
2969 }
2970
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002971 if (*name_end == '(')
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002972 // Invoke the class or object method
2973 return call_oc_method(cl, name, len, name_end, evalarg, arg, rettv);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002974
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002975 else if (rettv->v_type == VAR_OBJECT || rettv->v_type == VAR_CLASS)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002976 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002977 // Search in the object member variable table and the class member
2978 // variable table.
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002979 int is_object = rettv->v_type == VAR_OBJECT;
2980 if (get_member_tv(cl, is_object, name, len, rettv) == OK)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002981 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002982 *arg = name_end;
2983 return OK;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002984 }
2985
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002986 // could be a class method or an object method
2987 int fidx;
2988 ufunc_T *fp = method_lookup(cl, rettv->v_type, name, len, &fidx);
2989 if (fp != NULL)
2990 {
2991 // Private methods are not accessible outside the class
2992 if (*name == '_')
2993 {
Ernie Rael03042a22023-11-11 08:53:32 +01002994 semsg(_(e_cannot_access_protected_method_str), fp->uf_name);
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002995 return FAIL;
2996 }
2997
2998 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2999 if (pt == NULL)
3000 return FAIL;
3001
3002 pt->pt_refcount = 1;
3003 if (is_object)
3004 {
3005 pt->pt_obj = rettv->vval.v_object;
3006 ++pt->pt_obj->obj_refcount;
3007 }
3008 pt->pt_auto = TRUE;
3009 pt->pt_func = fp;
3010 func_ptr_ref(pt->pt_func);
3011 rettv->v_type = VAR_PARTIAL;
3012 rettv->vval.v_partial = pt;
3013 *arg = name_end;
3014 return OK;
3015 }
3016
Ernie Raeld615a312023-10-05 20:28:16 +02003017 if (did_emsg == did_emsg_save)
Yegappan Lakshmanan0ab500d2023-10-21 11:59:42 +02003018 member_not_found_msg(cl, rettv->v_type, name, len);
Bram Moolenaard505d172022-12-18 21:42:55 +00003019 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003020
3021 return FAIL;
3022}
3023
3024/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003025 * If "arg" points to a class or object method, return it.
3026 * Otherwise return NULL.
3027 */
3028 ufunc_T *
3029find_class_func(char_u **arg)
3030{
3031 char_u *name = *arg;
3032 char_u *name_end = find_name_end(name, NULL, NULL, FNE_CHECK_START);
3033 if (name_end == name || *name_end != '.')
3034 return NULL;
3035
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003036 ufunc_T *fp = NULL;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02003037 size_t len = name_end - name;
3038 typval_T tv;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003039 tv.v_type = VAR_UNKNOWN;
Bram Moolenaar993dbc32023-01-01 20:31:30 +00003040 if (eval_variable(name, (int)len,
3041 0, &tv, NULL, EVAL_VAR_NOAUTOLOAD) == FAIL)
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003042 return NULL;
3043 if (tv.v_type != VAR_CLASS && tv.v_type != VAR_OBJECT)
Bram Moolenaareb533502022-12-14 15:06:11 +00003044 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003045
3046 class_T *cl = tv.v_type == VAR_CLASS ? tv.vval.v_class
3047 : tv.vval.v_object->obj_class;
3048 if (cl == NULL)
Bram Moolenaareb533502022-12-14 15:06:11 +00003049 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003050 char_u *fname = name_end + 1;
3051 char_u *fname_end = find_name_end(fname, NULL, NULL, FNE_CHECK_START);
3052 if (fname_end == fname)
Bram Moolenaareb533502022-12-14 15:06:11 +00003053 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003054 len = fname_end - fname;
3055
Ernie Rael4d00b832023-09-11 19:54:42 +02003056 fp = method_lookup(cl, tv.v_type, fname, len, NULL);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003057
Bram Moolenaareb533502022-12-14 15:06:11 +00003058fail_after_eval:
3059 clear_tv(&tv);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003060 return fp;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003061}
3062
3063/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003064 * Returns the index of class variable "name" in the class "cl".
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003065 * Returns -1, if the variable is not found.
3066 * If "namelen" is zero, then it is assumed that "name" is NUL terminated.
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00003067 */
3068 int
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003069class_member_idx(class_T *cl, char_u *name, size_t namelen)
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00003070{
Ernie Rael4d00b832023-09-11 19:54:42 +02003071 int idx;
3072 class_member_lookup(cl, name, namelen, &idx);
3073 return idx;
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00003074}
3075
3076/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003077 * Returns a pointer to the class member variable "name" in the class "cl".
3078 * Returns NULL if the variable is not found.
3079 * The member variable index is set in "idx".
3080 */
3081 ocmember_T *
3082class_member_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3083{
Ernie Rael4d00b832023-09-11 19:54:42 +02003084 ocmember_T *ret_m = NULL;
3085 int ret_idx = -1;
3086 for (int i = 0; i < cl->class_class_member_count; ++i)
3087 {
3088 ocmember_T *m = &cl->class_class_members[i];
3089 if (namelen)
3090 {
3091 if (STRNCMP(name, m->ocm_name, namelen) == 0
3092 && m->ocm_name[namelen] == NUL)
3093 {
3094 ret_m = m;
3095 ret_idx = i;
3096 break;
3097 }
3098 }
3099 else if (STRCMP(name, m->ocm_name) == 0)
3100 {
3101 ret_m = m;
3102 ret_idx = i;
3103 break;
3104 }
3105 }
3106 if (idx != NULL)
3107 *idx = ret_idx;
3108 return ret_m;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003109}
3110
3111/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003112 * Returns a pointer to the class method "name" in class "cl".
3113 * Returns NULL if the method is not found.
3114 * The method index is set in "idx".
3115 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003116 static ufunc_T *
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003117class_method_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3118{
Ernie Rael4d00b832023-09-11 19:54:42 +02003119 ufunc_T *ret_fp = NULL;
3120 int ret_idx = -1;
3121 for (int i = 0; i < cl->class_class_function_count; ++i)
3122 {
3123 ufunc_T *fp = cl->class_class_functions[i];
3124 char_u *ufname = (char_u *)fp->uf_name;
3125 if (STRNCMP(name, ufname, namelen) == 0 && ufname[namelen] == NUL)
3126 {
3127 ret_fp = fp;
3128 ret_idx = i;
3129 break;
3130 }
3131 }
3132 if (idx != NULL)
3133 *idx = ret_idx;
3134 return ret_fp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003135}
3136
3137/*
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003138 * Returns the index of class method "name" in the class "cl".
3139 * Returns -1, if the method is not found.
3140 */
3141 int
3142class_method_idx(class_T *cl, char_u *name, size_t namelen)
3143{
3144 int idx;
3145 class_method_lookup(cl, name, namelen, &idx);
3146 return idx;
3147}
3148
3149/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003150 * Returns the index of object member variable "name" in the class "cl".
3151 * Returns -1, if the variable is not found.
3152 * If "namelen" is zero, then it is assumed that "name" is NUL terminated.
3153 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003154 static int
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003155object_member_idx(class_T *cl, char_u *name, size_t namelen)
3156{
Ernie Rael4d00b832023-09-11 19:54:42 +02003157 int idx;
3158 object_member_lookup(cl, name, namelen, &idx);
3159 return idx;
Yegappan Lakshmanan342f4f62023-09-09 11:37:23 +02003160}
3161
3162/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003163 * Returns a pointer to the object member variable "name" in the class "cl".
3164 * Returns NULL if the variable is not found.
3165 * The object member variable index is set in "idx".
3166 */
3167 ocmember_T *
3168object_member_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3169{
Ernie Rael4d00b832023-09-11 19:54:42 +02003170 ocmember_T *ret_m = NULL;
3171 int ret_idx = -1;
3172 for (int i = 0; i < cl->class_obj_member_count; ++i)
3173 {
3174 ocmember_T *m = &cl->class_obj_members[i];
3175 if (namelen)
3176 {
3177 if (STRNCMP(name, m->ocm_name, namelen) == 0
3178 && m->ocm_name[namelen] == NUL)
3179 {
3180 ret_m = m;
3181 ret_idx = i;
3182 break;
3183 }
3184 }
3185 else if (STRCMP(name, m->ocm_name) == 0)
3186 {
3187 ret_m = m;
3188 ret_idx = i;
3189 break;
3190 }
3191 }
3192 if (idx != NULL)
3193 *idx = ret_idx;
3194 return ret_m;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003195}
3196
3197/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003198 * Returns a pointer to the object method "name" in class "cl".
3199 * Returns NULL if the method is not found.
3200 * The object method index is set in "idx".
3201 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003202 static ufunc_T *
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003203object_method_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3204{
Ernie Rael4d00b832023-09-11 19:54:42 +02003205 ufunc_T *ret_fp = NULL;
3206 int ret_idx = -1;
3207 for (int i = 0; i < cl->class_obj_method_count; ++i)
3208 {
3209 ufunc_T *fp = cl->class_obj_methods[i];
3210 // Use a separate pointer to avoid that ASAN complains about
3211 // uf_name[] only being 4 characters.
3212 char_u *ufname = (char_u *)fp->uf_name;
3213 if (STRNCMP(name, ufname, namelen) == 0 && ufname[namelen] == NUL)
3214 {
3215 ret_fp = fp;
3216 ret_idx = i;
3217 break;
3218 }
3219 }
3220 if (idx != NULL)
3221 *idx = ret_idx;
3222 return ret_fp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003223}
3224
3225/*
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003226 * Returns the index of object method "name" in the class "cl".
3227 * Returns -1, if the method is not found.
3228 */
3229 int
3230object_method_idx(class_T *cl, char_u *name, size_t namelen)
3231{
3232 int idx;
3233 object_method_lookup(cl, name, namelen, &idx);
3234 return idx;
3235}
3236
3237/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003238 * Lookup a class or object member variable by name. If v_type is VAR_CLASS,
3239 * then lookup a class member variable and if it is VAR_OBJECT, then lookup a
3240 * object member variable.
3241 *
3242 * Returns a pointer to the member variable structure if variable is found.
3243 * Otherwise returns NULL. The member variable index is set in "*idx".
3244 */
3245 ocmember_T *
3246member_lookup(
3247 class_T *cl,
3248 vartype_T v_type,
3249 char_u *name,
3250 size_t namelen,
3251 int *idx)
3252{
3253 if (v_type == VAR_CLASS)
3254 return class_member_lookup(cl, name, namelen, idx);
3255 else
3256 return object_member_lookup(cl, name, namelen, idx);
3257}
3258
3259/*
Ernie Raele6c9aa52023-10-06 19:55:52 +02003260 * Find the class that defines the named member. Look up the hierarchy
3261 * starting at "cl".
3262 *
3263 * Return the class that defines the member "name", else NULL.
3264 * Fill in "p_m", if specified, for ocmember_T in found class.
3265 */
3266// NOTE: if useful for something could also indirectly return vartype and idx.
3267 static class_T *
3268class_defining_member(class_T *cl, char_u *name, size_t len, ocmember_T **p_m)
3269{
3270 class_T *cl_found = NULL;
3271 vartype_T vartype = VAR_UNKNOWN;
3272 ocmember_T *m_found = NULL;
3273
3274 len = len != 0 ? len : STRLEN(name);
3275
3276 // Loop assumes if member is not defined in "cl", then it is not
3277 // defined in any super class; the last class where it's found is the
3278 // class where it is defined. Once the vartype is found, the other
3279 // type is no longer checked.
3280 for (class_T *super = cl; super != NULL; super = super->class_extends)
3281 {
3282 class_T *cl_tmp = NULL;
3283 ocmember_T *m = NULL;
3284 if (vartype == VAR_UNKNOWN || vartype == VAR_OBJECT)
3285 {
3286 if ((m = object_member_lookup(super, name, len, NULL)) != NULL)
3287 {
3288 cl_tmp = super;
3289 vartype = VAR_OBJECT;
3290 }
3291 }
3292 if (vartype == VAR_UNKNOWN || vartype == VAR_CLASS)
3293 {
3294 if (( m = class_member_lookup(super, name, len, NULL)) != NULL)
3295 {
3296 cl_tmp = super;
3297 vartype = VAR_OBJECT;
3298 }
3299 }
3300 if (cl_tmp == NULL)
3301 break; // member is not in this or any super class.
3302 cl_found = cl_tmp;
3303 m_found = m;
3304 }
3305 if (p_m != NULL)
3306 *p_m = m_found;
3307 return cl_found;
3308}
3309
3310/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003311 * Lookup a class or object method by name. If v_type is VAR_CLASS, then
3312 * lookup a class method and if it is VAR_OBJECT, then lookup a object method.
3313 *
3314 * Returns a pointer to the method structure if variable is found.
3315 * Otherwise returns NULL. The method variable index is set in "*idx".
3316 */
3317 ufunc_T *
3318method_lookup(
3319 class_T *cl,
3320 vartype_T v_type,
3321 char_u *name,
3322 size_t namelen,
3323 int *idx)
3324{
3325 if (v_type == VAR_CLASS)
3326 return class_method_lookup(cl, name, namelen, idx);
3327 else
3328 return object_method_lookup(cl, name, namelen, idx);
3329}
3330
3331/*
Bram Moolenaar62a69232023-01-24 15:07:04 +00003332 * Return TRUE if current context "cctx_arg" is inside class "cl".
3333 * Return FALSE if not.
3334 */
3335 int
3336inside_class(cctx_T *cctx_arg, class_T *cl)
3337{
3338 for (cctx_T *cctx = cctx_arg; cctx != NULL; cctx = cctx->ctx_outer)
Ernie Raelcf138d42023-09-06 20:45:03 +02003339 if (cctx->ctx_ufunc != NULL
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003340 && class_instance_of(cctx->ctx_ufunc->uf_class, cl))
Bram Moolenaar62a69232023-01-24 15:07:04 +00003341 return TRUE;
3342 return FALSE;
3343}
3344
3345/*
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01003346 * Return TRUE if object/class variable "m" is read-only.
3347 * Also give an error message.
3348 */
3349 int
3350oc_var_check_ro(class_T *cl, ocmember_T *m)
3351{
3352 if (m->ocm_flags & (OCMFLAG_FINAL | OCMFLAG_CONST))
3353 {
3354 semsg(_(e_cannot_change_readonly_variable_str_in_class_str),
3355 m->ocm_name, cl->class_name);
3356 return TRUE;
3357 }
3358 return FALSE;
3359}
3360
3361/*
3362 * Lock all the constant object variables. Called after creating and
3363 * initializing a new object.
3364 */
3365 void
3366obj_lock_const_vars(object_T *obj)
3367{
3368 for (int i = 0; i < obj->obj_class->class_obj_member_count; i++)
3369 {
3370 ocmember_T *ocm = &obj->obj_class->class_obj_members[i];
3371 if (ocm->ocm_flags & OCMFLAG_CONST)
3372 {
3373 typval_T *mtv = ((typval_T *)(obj + 1)) + i;
3374 item_lock(mtv, DICT_MAXNEST, TRUE, TRUE);
3375 }
3376 }
3377}
3378
3379/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003380 * Make a copy of an object.
3381 */
3382 void
3383copy_object(typval_T *from, typval_T *to)
3384{
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003385 if (from->vval.v_object == NULL)
3386 to->vval.v_object = NULL;
3387 else
3388 {
3389 to->vval.v_object = from->vval.v_object;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003390 ++to->vval.v_object->obj_refcount;
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003391 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003392}
3393
3394/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003395 * Make a copy of a class.
3396 */
3397 void
3398copy_class(typval_T *from, typval_T *to)
3399{
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003400 if (from->vval.v_class == NULL)
3401 to->vval.v_class = NULL;
3402 else
3403 {
3404 to->vval.v_class = from->vval.v_class;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003405 ++to->vval.v_class->class_refcount;
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003406 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003407}
3408
3409/*
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003410 * Free the class "cl" and its contents.
3411 */
3412 static void
3413class_free(class_T *cl)
3414{
3415 // Freeing what the class contains may recursively come back here.
3416 // Clear "class_name" first, if it is NULL the class does not need to
3417 // be freed.
3418 VIM_CLEAR(cl->class_name);
3419
3420 class_unref(cl->class_extends);
3421
3422 for (int i = 0; i < cl->class_interface_count; ++i)
3423 {
3424 vim_free(((char_u **)cl->class_interfaces)[i]);
3425 if (cl->class_interfaces_cl[i] != NULL)
3426 class_unref(cl->class_interfaces_cl[i]);
3427 }
3428 vim_free(cl->class_interfaces);
3429 vim_free(cl->class_interfaces_cl);
3430
3431 itf2class_T *next;
3432 for (itf2class_T *i2c = cl->class_itf2class; i2c != NULL; i2c = next)
3433 {
3434 next = i2c->i2c_next;
3435 vim_free(i2c);
3436 }
3437
3438 for (int i = 0; i < cl->class_class_member_count; ++i)
3439 {
3440 ocmember_T *m = &cl->class_class_members[i];
3441 vim_free(m->ocm_name);
3442 vim_free(m->ocm_init);
3443 if (cl->class_members_tv != NULL)
3444 clear_tv(&cl->class_members_tv[i]);
3445 }
3446 vim_free(cl->class_class_members);
3447 vim_free(cl->class_members_tv);
3448
3449 for (int i = 0; i < cl->class_obj_member_count; ++i)
3450 {
3451 ocmember_T *m = &cl->class_obj_members[i];
3452 vim_free(m->ocm_name);
3453 vim_free(m->ocm_init);
3454 }
3455 vim_free(cl->class_obj_members);
3456
3457 for (int i = 0; i < cl->class_class_function_count; ++i)
3458 {
3459 ufunc_T *uf = cl->class_class_functions[i];
3460 func_clear_free(uf, FALSE);
3461 }
3462 vim_free(cl->class_class_functions);
3463
3464 for (int i = 0; i < cl->class_obj_method_count; ++i)
3465 {
3466 ufunc_T *uf = cl->class_obj_methods[i];
3467 func_clear_free(uf, FALSE);
3468 }
3469 vim_free(cl->class_obj_methods);
3470
3471 clear_type_list(&cl->class_type_list);
3472
3473 class_cleared(cl);
3474
3475 vim_free(cl);
3476}
3477
3478/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003479 * Unreference a class. Free it when the reference count goes down to zero.
3480 */
3481 void
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003482class_unref(class_T *cl)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003483{
Bram Moolenaard505d172022-12-18 21:42:55 +00003484 if (cl != NULL && --cl->class_refcount <= 0 && cl->class_name != NULL)
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003485 class_free(cl);
3486}
3487
3488/*
3489 * Go through the list of all classes and free items without "copyID".
3490 */
3491 int
3492class_free_nonref(int copyID)
3493{
3494 int did_free = FALSE;
3495
3496 for (class_T *cl = first_class; cl != NULL; cl = next_nonref_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003497 {
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003498 next_nonref_class = cl->class_next_used;
3499 if ((cl->class_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00003500 {
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003501 // Free the class and items it contains.
3502 class_free(cl);
3503 did_free = TRUE;
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00003504 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003505 }
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003506
3507 next_nonref_class = NULL;
3508 return did_free;
3509}
3510
3511 int
3512set_ref_in_classes(int copyID)
3513{
3514 for (class_T *cl = first_class; cl != NULL; cl = cl->class_next_used)
3515 set_ref_in_item_class(cl, copyID, NULL, NULL);
3516
3517 return FALSE;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003518}
3519
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003520static object_T *first_object = NULL;
3521
3522/*
3523 * Call this function when an object has been created. It will be added to the
3524 * list headed by "first_object".
3525 */
3526 void
3527object_created(object_T *obj)
3528{
3529 if (first_object != NULL)
3530 {
3531 obj->obj_next_used = first_object;
3532 first_object->obj_prev_used = obj;
3533 }
3534 first_object = obj;
3535}
3536
3537/*
3538 * Call this function when an object has been cleared and is about to be freed.
3539 * It is removed from the list headed by "first_object".
3540 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003541 static void
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003542object_cleared(object_T *obj)
3543{
3544 if (obj->obj_next_used != NULL)
3545 obj->obj_next_used->obj_prev_used = obj->obj_prev_used;
3546 if (obj->obj_prev_used != NULL)
3547 obj->obj_prev_used->obj_next_used = obj->obj_next_used;
3548 else if (first_object == obj)
3549 first_object = obj->obj_next_used;
3550}
3551
3552/*
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003553 * Free the contents of an object ignoring the reference count.
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003554 */
3555 static void
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003556object_free_contents(object_T *obj)
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003557{
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003558 class_T *cl = obj->obj_class;
3559
3560 if (!cl)
3561 return;
3562
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003563 // Avoid a recursive call, it can happen if "obj" has a circular reference.
3564 obj->obj_refcount = INT_MAX;
3565
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003566 // the member values are just after the object structure
3567 typval_T *tv = (typval_T *)(obj + 1);
3568 for (int i = 0; i < cl->class_obj_member_count; ++i)
3569 clear_tv(tv + i);
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003570}
3571
3572 static void
3573object_free_object(object_T *obj)
3574{
3575 class_T *cl = obj->obj_class;
3576
3577 if (!cl)
3578 return;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003579
3580 // Remove from the list headed by "first_object".
3581 object_cleared(obj);
3582
3583 vim_free(obj);
3584 class_unref(cl);
3585}
3586
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003587 static void
3588object_free(object_T *obj)
3589{
3590 if (in_free_unref_items)
3591 return;
3592
3593 object_free_contents(obj);
3594 object_free_object(obj);
3595}
3596
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003597/*
3598 * Unreference an object.
3599 */
3600 void
3601object_unref(object_T *obj)
3602{
3603 if (obj != NULL && --obj->obj_refcount <= 0)
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003604 object_free(obj);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003605}
3606
3607/*
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003608 * Go through the list of all objects and free items without "copyID".
3609 */
3610 int
3611object_free_nonref(int copyID)
3612{
3613 int did_free = FALSE;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003614
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003615 for (object_T *obj = first_object; obj != NULL; obj = obj->obj_next_used)
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003616 {
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003617 if ((obj->obj_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
3618 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003619 // Free the object contents. Object itself will be freed later.
3620 object_free_contents(obj);
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003621 did_free = TRUE;
3622 }
3623 }
3624
3625 return did_free;
3626}
3627
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003628 void
3629object_free_items(int copyID)
3630{
3631 object_T *obj_next;
3632
3633 for (object_T *obj = first_object; obj != NULL; obj = obj_next)
3634 {
3635 obj_next = obj->obj_next_used;
3636 if ((obj->obj_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
3637 object_free_object(obj);
3638 }
3639}
3640
LemonBoyafe04662023-08-23 21:08:11 +02003641/*
Ernie Raele6c9aa52023-10-06 19:55:52 +02003642 * Output message which takes a variable name and the class that defines it.
3643 * "cl" is that class where the name was found. Search "cl"'s hierarchy to
3644 * find the defining class.
3645 */
3646 void
3647emsg_var_cl_define(char *msg, char_u *name, size_t len, class_T *cl)
3648{
3649 ocmember_T *m;
3650 class_T *cl_def = class_defining_member(cl, name, len, &m);
3651 if (cl_def != NULL)
3652 semsg(_(msg), m->ocm_name, cl_def->class_name);
3653 else
3654 emsg(_(e_internal_error_please_report_a_bug));
3655}
3656
3657/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003658 * Echo a class or object method not found message.
3659 */
3660 void
3661method_not_found_msg(class_T *cl, vartype_T v_type, char_u *name, size_t len)
3662{
3663 char_u *method_name = vim_strnsave(name, len);
3664 if ((v_type == VAR_OBJECT)
3665 && (class_method_idx(cl, name, len) >= 0))
3666 {
3667 // If this is a class method, then give a different error
3668 if (*name == '_')
Ernie Rael03042a22023-11-11 08:53:32 +01003669 semsg(_(e_cannot_access_protected_method_str), method_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003670 else
RestorerZ7fe8f432023-09-24 23:21:24 +02003671 semsg(_(e_class_method_str_accessible_only_using_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003672 method_name, cl->class_name);
3673 }
3674 else if ((v_type == VAR_CLASS)
3675 && (object_method_idx(cl, name, len) >= 0))
3676 {
3677 // If this is an object method, then give a different error
3678 if (*name == '_')
Ernie Rael03042a22023-11-11 08:53:32 +01003679 semsg(_(e_cannot_access_protected_method_str), method_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003680 else
RestorerZ7fe8f432023-09-24 23:21:24 +02003681 semsg(_(e_object_method_str_accessible_only_using_object_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003682 method_name, cl->class_name);
3683 }
3684 else
Ernie Raeld4802ec2023-10-20 11:59:00 +02003685 semsg(_(e_method_not_found_on_class_str_str), method_name,
3686 cl->class_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003687 vim_free(method_name);
3688}
3689
3690/*
3691 * Echo a class or object member not found message.
3692 */
3693 void
3694member_not_found_msg(class_T *cl, vartype_T v_type, char_u *name, size_t len)
3695{
3696 char_u *varname = len ? vim_strnsave(name, len) : vim_strsave(name);
3697
3698 if (v_type == VAR_OBJECT)
3699 {
3700 if (class_member_idx(cl, name, len) >= 0)
RestorerZ7fe8f432023-09-24 23:21:24 +02003701 semsg(_(e_class_variable_str_accessible_only_using_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003702 varname, cl->class_name);
3703 else
Ernie Raeld4802ec2023-10-20 11:59:00 +02003704 semsg(_(e_variable_not_found_on_object_str_str), varname,
3705 cl->class_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003706 }
3707 else
3708 {
3709 if (object_member_idx(cl, name, len) >= 0)
RestorerZ7fe8f432023-09-24 23:21:24 +02003710 semsg(_(e_object_variable_str_accessible_only_using_object_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003711 varname, cl->class_name);
3712 else
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003713 {
3714 if (IS_ENUM(cl))
3715 semsg(_(e_enum_value_str_not_found_in_enum_str),
3716 varname, cl->class_name);
3717 else
3718 semsg(_(e_class_variable_str_not_found_in_class_str),
3719 varname, cl->class_name);
3720 }
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003721 }
3722 vim_free(varname);
3723}
3724
3725/*
Yegappan Lakshmanan4f32c832024-01-12 17:36:40 +01003726 * Compile all the class and object methods in "cl".
3727 */
3728 void
3729defcompile_class(class_T *cl)
3730{
3731 for (int loop = 1; loop <= 2; ++loop)
3732 {
3733 int func_count = loop == 1 ? cl->class_class_function_count
3734 : cl->class_obj_method_count;
3735 for (int i = 0; i < func_count; i++)
3736 {
3737 ufunc_T *ufunc = loop == 1 ? cl->class_class_functions[i]
3738 : cl->class_obj_methods[i];
Yegappan Lakshmanan1af0fbf2024-04-09 21:39:27 +02003739 // Don't compile abstract methods
3740 if (!IS_ABSTRACT_METHOD(ufunc))
3741 defcompile_function(ufunc, cl);
Yegappan Lakshmanan4f32c832024-01-12 17:36:40 +01003742 }
3743 }
3744}
3745
3746/*
3747 * Compile all the classes defined in the current script
3748 */
3749 void
3750defcompile_classes_in_script(void)
3751{
3752 for (class_T *cl = first_class; cl != NULL; cl = cl->class_next_used)
3753 {
3754 if (eval_variable(cl->class_name, 0, 0, NULL, NULL,
3755 EVAL_VAR_NOAUTOLOAD | EVAL_VAR_NO_FUNC) != FAIL)
3756 defcompile_class(cl);
3757 }
3758}
3759
3760/*
3761 * Returns TRUE if "name" is the name of a class. The typval for the class is
3762 * returned in "rettv".
3763 */
3764 int
3765is_class_name(char_u *name, typval_T *rettv)
3766{
3767 rettv->v_type = VAR_UNKNOWN;
3768
3769 if (eval_variable(name, 0, 0, rettv, NULL, EVAL_VAR_NOAUTOLOAD |
3770 EVAL_VAR_NO_FUNC) != FAIL)
3771 return rettv->v_type == VAR_CLASS;
3772 return FALSE;
3773}
3774
3775/*
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003776 * Calls the object builtin method "name" with arguments "argv". The value
3777 * returned by the builtin method is in "rettv". Returns OK or FAIL.
3778 */
3779 static int
3780object_call_builtin_method(
3781 object_T *obj,
3782 class_builtin_T builtin_method,
3783 int argc,
3784 typval_T *argv,
3785 typval_T *rettv)
3786{
3787 ufunc_T *uf;
3788 int midx;
3789
3790 if (obj == NULL)
3791 return FAIL;
3792
3793 uf = class_get_builtin_method(obj->obj_class, builtin_method, &midx);
3794 if (uf == NULL)
3795 return FAIL;
3796
3797 funccall_T *fc = create_funccal(uf, rettv);
3798 int r;
3799
3800 if (fc == NULL)
3801 return FAIL;
3802
3803 ++obj->obj_refcount;
3804
3805 r = call_def_function(uf, argc, argv, 0, NULL, obj, fc, rettv);
3806
3807 remove_funccal();
3808
3809 return r;
3810}
3811
3812/*
zeertzjqc029c132024-03-28 11:37:26 +01003813 * Calls the object "empty()" method and returns the method return value. In
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003814 * case of an error, returns TRUE.
3815 */
3816 int
3817object_empty(object_T *obj)
3818{
3819 typval_T rettv;
3820
3821 if (object_call_builtin_method(obj, CLASS_BUILTIN_EMPTY, 0, NULL, &rettv)
3822 == FAIL)
3823 return TRUE;
3824
3825 return tv_get_bool(&rettv);
3826}
3827
3828/*
3829 * Use the object "len()" method to get an object length. Returns 0 if the
3830 * method is not found or there is an error.
3831 */
3832 int
3833object_len(object_T *obj)
3834{
3835 typval_T rettv;
3836
3837 if (object_call_builtin_method(obj, CLASS_BUILTIN_LEN, 0, NULL, &rettv)
3838 == FAIL)
3839 return 0;
3840
3841 return tv_to_number(&rettv);
3842}
3843
3844/*
3845 * Return a textual representation of object "obj"
3846 */
3847 char_u *
3848object_string(
3849 object_T *obj,
3850 char_u *numbuf,
3851 int copyID,
3852 int echo_style,
3853 int restore_copyID,
3854 int composite_val)
3855{
3856 typval_T rettv;
3857
3858 if (object_call_builtin_method(obj, CLASS_BUILTIN_STRING, 0, NULL, &rettv)
3859 == OK
3860 && rettv.vval.v_string != NULL)
3861 return rettv.vval.v_string;
3862 else
3863 {
3864 garray_T ga;
3865 ga_init2(&ga, 1, 50);
3866
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003867 class_T *cl = obj == NULL ? NULL : obj->obj_class;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003868 if (cl != NULL && IS_ENUM(cl))
3869 {
Yegappan Lakshmanan3cf121e2024-03-31 18:45:35 +02003870 ga_concat(&ga, (char_u *)"enum ");
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003871 ga_concat(&ga, cl->class_name);
Yegappan Lakshmanan3cf121e2024-03-31 18:45:35 +02003872 char_u *enum_name = ((typval_T *)(obj + 1))->vval.v_string;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003873 ga_concat(&ga, (char_u *)".");
Yegappan Lakshmanan3cf121e2024-03-31 18:45:35 +02003874 ga_concat(&ga, enum_name);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003875 }
Yegappan Lakshmanan3cf121e2024-03-31 18:45:35 +02003876 else
3877 {
3878 ga_concat(&ga, (char_u *)"object of ");
3879 ga_concat(&ga, cl == NULL ? (char_u *)"[unknown]"
3880 : cl->class_name);
3881 }
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003882 if (cl != NULL)
3883 {
3884 ga_concat(&ga, (char_u *)" {");
3885 for (int i = 0; i < cl->class_obj_member_count; ++i)
3886 {
3887 if (i > 0)
3888 ga_concat(&ga, (char_u *)", ");
3889 ocmember_T *m = &cl->class_obj_members[i];
3890 ga_concat(&ga, m->ocm_name);
3891 ga_concat(&ga, (char_u *)": ");
3892 char_u *tf = NULL;
3893 ga_concat(&ga, echo_string_core(
3894 (typval_T *)(obj + 1) + i,
3895 &tf, numbuf, copyID, echo_style,
3896 restore_copyID, composite_val));
3897 vim_free(tf);
3898 }
3899 ga_concat(&ga, (char_u *)"}");
3900 }
3901 return ga.ga_data;
3902 }
3903}
3904
3905/*
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +02003906 * Return TRUE when the class "cl", its base class or one of the implemented
3907 * interfaces matches the class "other_cl".
LemonBoyafe04662023-08-23 21:08:11 +02003908 */
3909 int
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003910class_instance_of(class_T *cl, class_T *other_cl)
LemonBoyafe04662023-08-23 21:08:11 +02003911{
3912 if (cl == other_cl)
3913 return TRUE;
3914
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003915 // Recursively check the base classes.
3916 for (; cl != NULL; cl = cl->class_extends)
LemonBoyafe04662023-08-23 21:08:11 +02003917 {
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003918 if (cl == other_cl)
3919 return TRUE;
3920 // Check the implemented interfaces and the super interfaces
3921 for (int i = cl->class_interface_count - 1; i >= 0; --i)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02003922 {
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003923 class_T *intf = cl->class_interfaces_cl[i];
3924 while (intf != NULL)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02003925 {
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003926 if (intf == other_cl)
3927 return TRUE;
3928 // check the super interfaces
3929 intf = intf->class_extends;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02003930 }
3931 }
LemonBoyafe04662023-08-23 21:08:11 +02003932 }
3933
3934 return FALSE;
3935}
3936
3937/*
Ernie Rael2025af12023-12-12 16:58:00 +01003938 * "instanceof(object, classinfo, ...)" function
LemonBoyafe04662023-08-23 21:08:11 +02003939 */
3940 void
3941f_instanceof(typval_T *argvars, typval_T *rettv)
3942{
3943 typval_T *object_tv = &argvars[0];
3944 typval_T *classinfo_tv = &argvars[1];
Yegappan Lakshmananfeaccd22023-10-28 15:53:55 +02003945 class_T *c;
LemonBoyafe04662023-08-23 21:08:11 +02003946
3947 rettv->vval.v_number = VVAL_FALSE;
3948
3949 if (check_for_object_arg(argvars, 0) == FAIL
Ernie Rael2025af12023-12-12 16:58:00 +01003950 || check_for_class_or_typealias_args(argvars, 1) == FAIL)
LemonBoyafe04662023-08-23 21:08:11 +02003951 return;
3952
Ernie Rael3da696d2023-09-19 20:14:18 +02003953 if (object_tv->vval.v_object == NULL)
3954 return;
3955
Ernie Rael2025af12023-12-12 16:58:00 +01003956 for (; classinfo_tv->v_type != VAR_UNKNOWN; ++classinfo_tv)
LemonBoyafe04662023-08-23 21:08:11 +02003957 {
Ernie Rael2025af12023-12-12 16:58:00 +01003958 if (classinfo_tv->v_type == VAR_TYPEALIAS)
3959 c = classinfo_tv->vval.v_typealias->ta_type->tt_class;
3960 else
3961 c = classinfo_tv->vval.v_class;
3962
3963 if (class_instance_of(object_tv->vval.v_object->obj_class, c))
LemonBoyafe04662023-08-23 21:08:11 +02003964 {
Ernie Rael2025af12023-12-12 16:58:00 +01003965 rettv->vval.v_number = VVAL_TRUE;
3966 return;
LemonBoyafe04662023-08-23 21:08:11 +02003967 }
3968 }
LemonBoyafe04662023-08-23 21:08:11 +02003969}
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00003970
3971#endif // FEAT_EVAL