blob: d8813c6f20f78529e202fb7ec25b9d34601ebaa4 [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);
Yegappan Lakshmananfe55c312024-04-28 09:54:09 +0200140 if (*init_arg != NUL && !vim9_comment_start(init_arg))
Yegappan Lakshmananac773182024-04-27 11:36:12 +0200141 {
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 }
LemonBoyf4af3312024-07-04 13:43:12 +02001283 set_tv_type(tv, m->ocm_type);
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01001284 if (m->ocm_flags & OCMFLAG_CONST)
1285 item_lock(tv, DICT_MAXNEST, TRUE, TRUE);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001286 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001287
1288 return OK;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001289}
1290
1291/*
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02001292 * Add a default constructor method (new()) to the class "cl".
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001293 */
1294 static void
1295add_default_constructor(
1296 class_T *cl,
1297 garray_T *classfunctions_gap,
1298 garray_T *type_list_gap)
1299{
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001300 garray_T fga;
1301 int is_enum = IS_ENUM(cl);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001302
1303 ga_init2(&fga, 1, 1000);
1304 ga_concat(&fga, (char_u *)"new(");
1305 for (int i = 0; i < cl->class_obj_member_count; ++i)
1306 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001307 if (i < 2 && is_enum)
1308 // The first two object variables in an enum are the enum value
1309 // name and ordinal. Don't initialize these object variables in
1310 // the default constructor as they are already initialized right
1311 // after creating the object.
1312 continue;
1313
1314 if (i > (is_enum ? 2 : 0))
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001315 ga_concat(&fga, (char_u *)", ");
1316 ga_concat(&fga, (char_u *)"this.");
1317 ocmember_T *m = cl->class_obj_members + i;
1318 ga_concat(&fga, (char_u *)m->ocm_name);
1319 ga_concat(&fga, (char_u *)" = v:none");
1320 }
1321 ga_concat(&fga, (char_u *)")\nenddef\n");
1322 ga_append(&fga, NUL);
1323
1324 exarg_T fea;
1325 CLEAR_FIELD(fea);
1326 fea.cmdidx = CMD_def;
1327 fea.cmd = fea.arg = fga.ga_data;
1328
1329 garray_T lines_to_free;
1330 ga_init2(&lines_to_free, sizeof(char_u *), 50);
1331
h-eastb895b0f2023-09-24 15:46:31 +02001332 ufunc_T *nf = define_function(&fea, NULL, &lines_to_free, CF_CLASS,
1333 cl->class_obj_members, cl->class_obj_member_count);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001334
1335 ga_clear_strings(&lines_to_free);
1336 vim_free(fga.ga_data);
1337
1338 if (nf != NULL && ga_grow(classfunctions_gap, 1) == OK)
1339 {
1340 ((ufunc_T **)classfunctions_gap->ga_data)[classfunctions_gap->ga_len]
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001341 = nf;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001342 ++classfunctions_gap->ga_len;
1343
1344 nf->uf_flags |= FC_NEW;
1345 nf->uf_ret_type = get_type_ptr(type_list_gap);
1346 if (nf->uf_ret_type != NULL)
1347 {
1348 nf->uf_ret_type->tt_type = VAR_OBJECT;
1349 nf->uf_ret_type->tt_class = cl;
1350 nf->uf_ret_type->tt_argcount = 0;
1351 nf->uf_ret_type->tt_args = NULL;
1352 }
1353 }
1354}
1355
1356/*
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001357 * Add the class methods and object methods to the new class "cl".
1358 * When extending a class "extends_cl", add the instance methods from the
1359 * parent class also.
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001360 * Returns OK on success and FAIL on memory allocation failure.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001361 */
1362 static int
1363add_classfuncs_objmethods(
1364 class_T *cl,
1365 class_T *extends_cl,
1366 garray_T *classfunctions_gap,
1367 garray_T *objmethods_gap)
1368{
1369 // loop 1: class functions, loop 2: object methods
1370 for (int loop = 1; loop <= 2; ++loop)
1371 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001372 garray_T *gap = loop == 1 ? classfunctions_gap : objmethods_gap;
1373 int *fcount = loop == 1 ? &cl->class_class_function_count
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001374 : &cl->class_obj_method_count;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001375 ufunc_T ***fup = loop == 1 ? &cl->class_class_functions
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001376 : &cl->class_obj_methods;
1377
1378 int parent_count = 0;
1379 if (extends_cl != NULL)
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001380 // Include object methods from the parent.
1381 // Don't include the parent class methods.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001382 parent_count = loop == 1
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001383 ? 0
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001384 : extends_cl->class_obj_method_count;
1385
1386 *fcount = parent_count + gap->ga_len;
1387 if (*fcount == 0)
1388 {
1389 *fup = NULL;
1390 continue;
1391 }
1392 *fup = ALLOC_MULT(ufunc_T *, *fcount);
1393 if (*fup == NULL)
1394 return FAIL;
1395
1396 if (gap->ga_len != 0)
1397 mch_memmove(*fup, gap->ga_data, sizeof(ufunc_T *) * gap->ga_len);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001398 VIM_CLEAR(gap->ga_data);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001399 if (loop == 1)
1400 cl->class_class_function_count_child = gap->ga_len;
1401 else
1402 cl->class_obj_method_count_child = gap->ga_len;
1403
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001404 if (loop == 2)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001405 {
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001406 // Copy instance methods from the parent.
1407
1408 for (int i = 0; i < parent_count; ++i)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001409 {
Yegappan Lakshmanane2deb7e2023-09-16 18:05:07 +02001410 // Can't use the same parent function, because "uf_class" is
1411 // different and compilation will have a different result.
1412 // Put them after the functions in the current class, object
1413 // methods may be overruled, then "super.Method()" is used to
1414 // find a method from the parent.
1415 ufunc_T *pf = (extends_cl->class_obj_methods)[i];
1416 (*fup)[gap->ga_len + i] = copy_function(pf);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001417
1418 // If the child class overrides a function from the parent
1419 // the signature must be equal.
1420 char_u *pname = pf->uf_name;
1421 for (int ci = 0; ci < gap->ga_len; ++ci)
1422 {
1423 ufunc_T *cf = (*fup)[ci];
1424 char_u *cname = cf->uf_name;
1425 if (STRCMP(pname, cname) == 0)
1426 {
1427 where_T where = WHERE_INIT;
1428 where.wt_func_name = (char *)pname;
1429 where.wt_kind = WT_METHOD;
1430 (void)check_type(pf->uf_func_type, cf->uf_func_type,
1431 TRUE, where);
1432 }
1433 }
1434 }
1435 }
1436
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001437 // Set the class pointer on all the functions and object methods.
1438 for (int i = 0; i < *fcount; ++i)
1439 {
1440 ufunc_T *fp = (*fup)[i];
1441 fp->uf_class = cl;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001442 if (i < gap->ga_len)
1443 fp->uf_defclass = cl;
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001444 if (loop == 2)
1445 fp->uf_flags |= FC_OBJECT;
1446 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001447
1448 ga_clear(gap);
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02001449 }
1450
1451 return OK;
1452}
1453
1454/*
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01001455 * Update the index of object methods called by builtin functions.
1456 */
1457 static void
1458update_builtin_method_index(class_T *cl)
1459{
1460 int i;
1461
1462 for (i = 0; i < CLASS_BUILTIN_MAX; i++)
1463 cl->class_builtin_methods[i] = -1;
1464
1465 for (i = 0; i < cl->class_obj_method_count; i++)
1466 {
1467 ufunc_T *uf = cl->class_obj_methods[i];
1468
1469 if (cl->class_builtin_methods[CLASS_BUILTIN_STRING] == -1
1470 && STRCMP(uf->uf_name, "string") == 0)
1471 cl->class_builtin_methods[CLASS_BUILTIN_STRING] = i;
1472 else if (cl->class_builtin_methods[CLASS_BUILTIN_EMPTY] == -1 &&
1473 STRCMP(uf->uf_name, "empty") == 0)
1474 cl->class_builtin_methods[CLASS_BUILTIN_EMPTY] = i;
1475 else if (cl->class_builtin_methods[CLASS_BUILTIN_LEN] == -1 &&
1476 STRCMP(uf->uf_name, "len") == 0)
1477 cl->class_builtin_methods[CLASS_BUILTIN_LEN] = i;
1478 }
1479}
1480
1481/*
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001482 * Return the end of the class name starting at "arg". Valid characters in a
1483 * class name are alphanumeric characters and "_". Also handles imported class
1484 * names.
1485 */
1486 static char_u *
1487find_class_name_end(char_u *arg)
1488{
1489 char_u *end = arg;
1490
1491 while (ASCII_ISALNUM(*end) || *end == '_'
1492 || (*end == '.' && (ASCII_ISALNUM(end[1]) || end[1] == '_')))
1493 ++end;
1494
1495 return end;
1496}
1497
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001498/*
1499 * Returns TRUE if the enum value "varname" is already defined.
1500 */
1501 static int
1502is_duplicate_enum(
1503 garray_T *enum_gap,
1504 char_u *varname,
1505 char_u *varname_end)
1506{
1507 char_u *name = vim_strnsave(varname, varname_end - varname);
1508 int dup = FALSE;
1509
1510 for (int i = 0; i < enum_gap->ga_len; ++i)
1511 {
1512 ocmember_T *m = ((ocmember_T *)enum_gap->ga_data) + i;
1513 if (STRCMP(name, m->ocm_name) == 0)
1514 {
1515 semsg(_(e_duplicate_enum_str), name);
1516 dup = TRUE;
1517 break;
1518 }
1519 }
1520
1521 vim_free(name);
1522 return dup;
1523}
1524
1525/*
1526 * Parse the enum values in "line" separated by comma and add them to "gap".
1527 * If the last enum value is found, then "enum_end" is set to TRUE.
1528 */
1529 static int
1530enum_parse_values(
1531 exarg_T *eap,
1532 class_T *en,
1533 char_u *line,
1534 garray_T *gap,
1535 int *num_enum_values,
1536 int *enum_end)
1537{
1538 evalarg_T evalarg;
1539 char_u *p = line;
1540 char initexpr_buf[1024];
1541 char_u last_char = NUL;
1542 int rc = OK;
1543
1544 fill_evalarg_from_eap(&evalarg, eap, FALSE);
1545
1546 int did_emsg_before = did_emsg;
1547 while (*p != NUL)
1548 {
1549 // ignore comment
1550 if (*p == '#')
1551 break;
1552
1553 if (!eval_isnamec1(*p))
1554 {
1555 semsg(_(e_invalid_enum_value_declaration_str), p);
1556 break;
1557 }
1558
1559 char_u *eni_name_start = p;
1560 char_u *eni_name_end = to_name_end(p, FALSE);
1561
1562 if (is_duplicate_enum(gap, eni_name_start, eni_name_end))
1563 break;
1564
1565 p = skipwhite(eni_name_end);
1566
1567 char_u *init_expr = NULL;
1568 if (*p == '(')
1569 {
1570 if (VIM_ISWHITE(p[-1]))
1571 {
1572 semsg(_(e_no_white_space_allowed_before_str_str), "(", line);
1573 break;
1574 }
1575
1576 char_u *expr_start, *expr_end;
1577
1578 p = eni_name_start;
1579 (void)skip_expr_concatenate(&p, &expr_start, &expr_end, &evalarg);
1580
1581 while (*expr_start && *expr_start != '(')
1582 expr_start++;
1583
1584 if (expr_end > expr_start)
1585 init_expr = vim_strnsave(expr_start, expr_end - expr_start);
1586 }
1587
1588 if (init_expr == NULL)
1589 vim_snprintf(initexpr_buf, sizeof(initexpr_buf), "%s.new()",
1590 en->class_name);
1591 else
1592 {
1593 vim_snprintf(initexpr_buf, sizeof(initexpr_buf), "%s.new%s",
1594 en->class_name, init_expr);
1595 vim_free(init_expr);
1596 }
1597 if (add_member(gap, eni_name_start, eni_name_end, FALSE,
1598 TRUE, TRUE, TRUE, &en->class_object_type,
1599 vim_strsave((char_u *)initexpr_buf)) == FAIL)
1600 break;
1601
1602 ++*num_enum_values;
1603
1604 if (*p != '#')
1605 last_char = *p;
1606
1607 if (*p != NUL && *p != ',')
1608 break;
1609
1610 if (*p == ',')
1611 {
1612 if (!IS_WHITE_OR_NUL(p[1]))
1613 {
1614 semsg(_(e_white_space_required_after_str_str), ",", line);
1615 break;
1616 }
1617 if (VIM_ISWHITE(p[-1]))
1618 {
1619 semsg(_(e_no_white_space_allowed_before_str_str), ",", line);
1620 break;
1621 }
1622 p = skipwhite(p + 1);
1623 }
1624 }
1625
1626 if (*p != NUL && *p != '#')
1627 {
1628 if (did_emsg == did_emsg_before)
1629 semsg(_(e_missing_comma_before_argument_str), p);
1630 rc = FAIL;
1631 }
1632
1633 if (last_char != ',')
1634 // last enum value should not be terminated by ","
1635 *enum_end = TRUE;
1636
1637 // Free the memory pointed by expr_start.
1638 clear_evalarg(&evalarg, NULL);
1639
1640 return rc;
1641}
1642
1643/*
1644 * Add the "values" class variable (List of enum value objects) to the enum
1645 * class "en"
1646 */
1647 static int
1648enum_add_values_member(
1649 class_T *en,
1650 garray_T *gap,
1651 int num_enum_values,
1652 garray_T *type_list_gap)
1653{
1654 garray_T fga;
1655 int rc = FAIL;
1656
1657 ga_init2(&fga, 1, 1000);
1658 ga_concat(&fga, (char_u *)"[");
1659 for (int i = 0; i < num_enum_values; ++i)
1660 {
1661 ocmember_T *m = ((ocmember_T *)gap->ga_data) + i;
1662
1663 if (i > 0)
1664 ga_concat(&fga, (char_u *)", ");
1665 ga_concat(&fga, en->class_name);
1666 ga_concat(&fga, (char_u *)".");
1667 ga_concat(&fga, (char_u *)m->ocm_name);
1668 }
1669 ga_concat(&fga, (char_u *)"]");
1670 ga_append(&fga, NUL);
1671
1672 char_u *varname = (char_u *)"values";
1673
1674 type_T *type = get_type_ptr(type_list_gap);
1675 if (type == NULL)
1676 goto done;
1677
1678 type->tt_type = VAR_LIST;
1679 type->tt_member = get_type_ptr(type_list_gap);
1680 if (type->tt_member != NULL)
1681 {
1682 type->tt_member->tt_type = VAR_OBJECT;
1683 type->tt_member->tt_class = en;
1684 }
1685
1686 rc = add_member(gap, varname, varname + 6, FALSE, FALSE, TRUE, TRUE, type,
1687 vim_strsave((char_u *)fga.ga_data));
1688
1689done:
1690 vim_free(fga.ga_data);
1691
1692 return rc;
1693}
1694
1695/*
1696 * Clear the constructor method names in a enum class, so that an enum class
1697 * cannot be instantiated.
1698 */
1699 static void
1700enum_clear_constructors(class_T *en)
1701{
1702 for (int i = 0; i < en->class_class_function_count; ++i)
1703 {
1704 ufunc_T *fp = en->class_class_functions[i];
1705
1706 if (fp->uf_flags & FC_NEW)
1707 *fp->uf_name = NUL;
1708 }
1709}
1710
1711/*
1712 * Initialize the name and ordinal object variable in the enum value "enval" in
1713 * the enum "en". These values are set during the enum value object creation.
1714 */
1715 void
1716enum_set_internal_obj_vars(class_T *en, object_T *enval)
1717{
1718 int i;
1719
1720 for (i = 0; i < en->class_class_member_count; ++i)
1721 {
1722 typval_T *en_tv = en->class_members_tv + i;
1723 if (en_tv != NULL && en_tv->v_type == VAR_UNKNOWN)
1724 break;
1725 }
1726
1727 // First object variable is the name
1728 ocmember_T *value_ocm = en->class_class_members + i;
1729 typval_T *name_tv = (typval_T *)(enval + 1);
1730 name_tv->v_type = VAR_STRING;
1731 name_tv->vval.v_string = vim_strsave(value_ocm->ocm_name);
1732
1733 // Second object variable is the ordinal
1734 typval_T *ord_tv = (typval_T *)(name_tv + 1);
1735 ord_tv->v_type = VAR_NUMBER;
1736 ord_tv->vval.v_number = i;
1737}
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001738
1739/*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001740 * Handle ":class" and ":abstract class" up to ":endclass".
Bram Moolenaar554d0312023-01-05 19:59:18 +00001741 * Handle ":interface" up to ":endinterface".
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001742 */
1743 void
1744ex_class(exarg_T *eap)
1745{
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001746 int is_class = eap->cmdidx == CMD_class;
1747 int is_abstract = eap->cmdidx == CMD_abstract;
1748 int is_enum = eap->cmdidx == CMD_enum;
1749 int is_interface;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02001750 long start_lnum = SOURCING_LNUM;
1751 char_u *arg = eap->arg;
Bram Moolenaar554d0312023-01-05 19:59:18 +00001752
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001753 if (is_abstract)
1754 {
1755 if (STRNCMP(arg, "class", 5) != 0 || !VIM_ISWHITE(arg[5]))
1756 {
1757 semsg(_(e_invalid_argument_str), arg);
1758 return;
1759 }
1760 arg = skipwhite(arg + 5);
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001761 is_class = TRUE;
1762 }
1763
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001764 is_interface = !is_class && !is_enum;
1765
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001766 if (!current_script_is_vim9()
1767 || (cmdmod.cmod_flags & CMOD_LEGACY)
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01001768 || !getline_equal(eap->ea_getline, eap->cookie, getsourceline))
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001769 {
1770 if (is_class)
1771 emsg(_(e_class_can_only_be_defined_in_vim9_script));
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001772 else if (is_enum)
1773 emsg(_(e_enum_can_only_be_defined_in_vim9_script));
Bram Moolenaar24a8d062023-01-14 13:12:06 +00001774 else
1775 emsg(_(e_interface_can_only_be_defined_in_vim9_script));
1776 return;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001777 }
1778
1779 if (!ASCII_ISUPPER(*arg))
1780 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001781 if (is_class)
1782 semsg(_(e_class_name_must_start_with_uppercase_letter_str), arg);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001783 else if (is_enum)
1784 semsg(_(e_enum_name_must_start_with_uppercase_letter_str), arg);
Bram Moolenaar554d0312023-01-05 19:59:18 +00001785 else
1786 semsg(_(e_interface_name_must_start_with_uppercase_letter_str),
1787 arg);
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001788 return;
1789 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001790 char_u *name_end = find_name_end(arg, NULL, NULL, FNE_CHECK_START);
1791 if (!IS_WHITE_OR_NUL(*name_end))
1792 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00001793 semsg(_(e_white_space_required_after_name_str), arg);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001794 return;
1795 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001796 char_u *name_start = arg;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001797
1798 // TODO:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001799 // generics: <Tkey, Tentry>
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001800
Bram Moolenaar83677162023-01-08 19:54:10 +00001801 // Name for "extends BaseClass"
1802 char_u *extends = NULL;
1803
Bram Moolenaar94674f22023-01-06 18:42:20 +00001804 // Names for "implements SomeInterface"
1805 garray_T ga_impl;
1806 ga_init2(&ga_impl, sizeof(char_u *), 5);
1807
1808 arg = skipwhite(name_end);
1809 while (*arg != NUL && *arg != '#' && *arg != '\n')
1810 {
1811 // TODO:
Bram Moolenaar94674f22023-01-06 18:42:20 +00001812 // specifies SomeInterface
Bram Moolenaar83677162023-01-08 19:54:10 +00001813 if (STRNCMP(arg, "extends", 7) == 0 && IS_WHITE_OR_NUL(arg[7]))
1814 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001815 if (is_enum)
1816 {
1817 emsg(_(e_enum_cannot_extend_class));
1818 goto early_ret;
1819 }
Bram Moolenaar83677162023-01-08 19:54:10 +00001820 if (extends != NULL)
1821 {
1822 emsg(_(e_duplicate_extends));
1823 goto early_ret;
1824 }
1825 arg = skipwhite(arg + 7);
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001826
1827 char_u *end = find_class_name_end(arg);
Bram Moolenaar83677162023-01-08 19:54:10 +00001828 if (!IS_WHITE_OR_NUL(*end))
1829 {
1830 semsg(_(e_white_space_required_after_name_str), arg);
1831 goto early_ret;
1832 }
1833 extends = vim_strnsave(arg, end - arg);
1834 if (extends == NULL)
1835 goto early_ret;
1836
1837 arg = skipwhite(end + 1);
1838 }
1839 else if (STRNCMP(arg, "implements", 10) == 0
1840 && IS_WHITE_OR_NUL(arg[10]))
Bram Moolenaar94674f22023-01-06 18:42:20 +00001841 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001842 if (is_interface)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02001843 {
1844 emsg(_(e_interface_cannot_use_implements));
1845 goto early_ret;
1846 }
1847
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001848 if (ga_impl.ga_len > 0)
1849 {
1850 emsg(_(e_duplicate_implements));
1851 goto early_ret;
1852 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001853 arg = skipwhite(arg + 10);
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001854
1855 for (;;)
Bram Moolenaar94674f22023-01-06 18:42:20 +00001856 {
Yegappan Lakshmanand2e1c832023-12-14 19:59:45 +01001857 char_u *impl_end = find_class_name_end(arg);
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02001858 if ((!IS_WHITE_OR_NUL(*impl_end) && *impl_end != ',')
1859 || (*impl_end == ','
1860 && !IS_WHITE_OR_NUL(*(impl_end + 1))))
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001861 {
1862 semsg(_(e_white_space_required_after_name_str), arg);
1863 goto early_ret;
1864 }
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02001865 if (impl_end - arg == 0)
1866 {
1867 emsg(_(e_missing_name_after_implements));
1868 goto early_ret;
1869 }
1870
Bram Moolenaardf8f9472023-01-07 14:51:03 +00001871 char_u *iname = vim_strnsave(arg, impl_end - arg);
1872 if (iname == NULL)
1873 goto early_ret;
1874 for (int i = 0; i < ga_impl.ga_len; ++i)
1875 if (STRCMP(((char_u **)ga_impl.ga_data)[i], iname) == 0)
1876 {
1877 semsg(_(e_duplicate_interface_after_implements_str),
1878 iname);
1879 vim_free(iname);
1880 goto early_ret;
1881 }
1882 if (ga_add_string(&ga_impl, iname) == FAIL)
1883 {
1884 vim_free(iname);
1885 goto early_ret;
1886 }
1887 if (*impl_end != ',')
1888 {
1889 arg = skipwhite(impl_end);
1890 break;
1891 }
1892 arg = skipwhite(impl_end + 1);
Bram Moolenaar94674f22023-01-06 18:42:20 +00001893 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00001894 }
1895 else
1896 {
1897 semsg(_(e_trailing_characters_str), arg);
1898early_ret:
Bram Moolenaar83677162023-01-08 19:54:10 +00001899 vim_free(extends);
Bram Moolenaar94674f22023-01-06 18:42:20 +00001900 ga_clear_strings(&ga_impl);
1901 return;
1902 }
1903 }
1904
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001905 garray_T type_list; // list of pointers to allocated types
1906 ga_init2(&type_list, sizeof(type_T *), 10);
1907
Bram Moolenaard505d172022-12-18 21:42:55 +00001908 // Growarray with class members declared in the class.
1909 garray_T classmembers;
1910 ga_init2(&classmembers, sizeof(ocmember_T), 10);
1911
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00001912 // Growarray with functions declared in the class.
1913 garray_T classfunctions;
1914 ga_init2(&classfunctions, sizeof(ufunc_T *), 10);
Bram Moolenaard505d172022-12-18 21:42:55 +00001915
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001916 // Growarray with object members declared in the class.
1917 garray_T objmembers;
Bram Moolenaard505d172022-12-18 21:42:55 +00001918 ga_init2(&objmembers, sizeof(ocmember_T), 10);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001919
1920 // Growarray with object methods declared in the class.
1921 garray_T objmethods;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001922 ga_init2(&objmethods, sizeof(ufunc_T *), 10);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001923
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001924 class_T *cl = NULL;
1925 class_T *extends_cl = NULL; // class from "extends" argument
1926 class_T **intf_classes = NULL;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001927 int num_enum_values = 0;
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001928
1929 cl = ALLOC_CLEAR_ONE(class_T);
1930 if (cl == NULL)
1931 goto cleanup;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001932
1933 if (is_enum)
1934 cl->class_flags = CLASS_ENUM;
1935 else if (is_interface)
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001936 cl->class_flags = CLASS_INTERFACE;
1937 else if (is_abstract)
1938 cl->class_flags = CLASS_ABSTRACT;
1939
1940 cl->class_refcount = 1;
1941 cl->class_name = vim_strnsave(name_start, name_end - name_start);
1942 if (cl->class_name == NULL)
1943 goto cleanup;
1944
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001945 cl->class_type.tt_type = VAR_CLASS;
1946 cl->class_type.tt_class = cl;
1947 cl->class_object_type.tt_type = VAR_OBJECT;
1948 cl->class_object_type.tt_class = cl;
1949
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001950 // Add the class to the script-local variables.
1951 // TODO: handle other context, e.g. in a function
1952 // TODO: does uf_hash need to be cleared?
1953 typval_T tv;
1954 tv.v_type = VAR_CLASS;
1955 tv.vval.v_class = cl;
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01001956 SOURCING_LNUM = start_lnum;
1957 int rc = set_var_const(cl->class_name, current_sctx.sc_sid,
1958 NULL, &tv, FALSE, 0, 0);
1959 if (rc == FAIL)
1960 goto cleanup;
1961
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001962 if (is_enum)
1963 {
1964 // All the enum classes have the name and ordinal object variables.
1965 char_u *varname = (char_u *)"name";
1966 if (add_member(&objmembers, varname, varname + 4, FALSE, FALSE, TRUE,
1967 TRUE, &t_string, NULL) == FAIL)
1968 goto cleanup;
1969
1970 varname = (char_u *)"ordinal";
1971 if (add_member(&objmembers, varname, varname + 7, FALSE, FALSE, TRUE,
1972 TRUE, &t_number, NULL) == FAIL)
1973 goto cleanup;
1974 }
1975
1976 // "export class" gets used when creating the class, don't use "is_export"
1977 // for the items inside the class.
1978 is_export = FALSE;
1979
1980 // When parsing an enum definition, this denotes whether all the enumerated
1981 // values are parsed or not.
1982 int enum_end = FALSE;
1983
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001984 /*
Bram Moolenaar554d0312023-01-05 19:59:18 +00001985 * Go over the body of the class/interface until "endclass" or
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001986 * "endinterface" or "endenum" is found.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001987 */
1988 char_u *theline = NULL;
1989 int success = FALSE;
1990 for (;;)
1991 {
1992 vim_free(theline);
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01001993 theline = eap->ea_getline(':', eap->cookie, 0, GETLINE_CONCAT_ALL);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001994 if (theline == NULL)
1995 break;
1996 char_u *line = skipwhite(theline);
1997
Bram Moolenaar418b5472022-12-20 13:38:22 +00001998 // Skip empty and comment lines.
1999 if (*line == NUL)
2000 continue;
2001 if (*line == '#')
2002 {
2003 if (vim9_bad_comment(line))
2004 break;
2005 continue;
2006 }
2007
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002008 char_u *p = line;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002009
2010 char *end_name;
2011 int shortlen;
2012 int fullen;
2013 if (is_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002014 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002015 end_name = "endclass";
2016 shortlen = 4;
2017 fullen = 8;
2018 }
2019 else if (is_enum)
2020 {
2021 end_name = "endenum";
2022 shortlen = 4;
2023 fullen = 7;
2024 }
2025 else
2026 {
2027 end_name = "endinterface";
2028 shortlen = 5;
2029 fullen = 12;
2030 }
2031
2032 if (checkforcmd(&p, end_name, shortlen))
2033 {
2034 if (STRNCMP(line, end_name, fullen) != 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002035 semsg(_(e_command_cannot_be_shortened_str), line);
2036 else if (*p == '|' || !ends_excmd2(line, p))
2037 semsg(_(e_trailing_characters_str), p);
Bram Moolenaar98aeb212022-12-08 22:09:14 +00002038 else
2039 success = TRUE;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002040 break;
2041 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002042
2043 int wrong_endname = FALSE;
2044 if (is_class)
2045 wrong_endname = checkforcmd(&p, "endinterface", 5)
2046 || checkforcmd(&p, "endenum", 4);
2047 else if (is_enum)
2048 wrong_endname = checkforcmd(&p, "endclass", 4)
2049 || checkforcmd(&p, "endinterface", 5);
2050 else
2051 wrong_endname = checkforcmd(&p, "endclass", 4)
2052 || checkforcmd(&p, "endenum", 4);
2053 if (wrong_endname)
Bram Moolenaar554d0312023-01-05 19:59:18 +00002054 {
Bram Moolenaar657aea72023-01-27 13:16:19 +00002055 semsg(_(e_invalid_command_str_expected_str), line, end_name);
Bram Moolenaar554d0312023-01-05 19:59:18 +00002056 break;
2057 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002058
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002059 if (is_enum && !enum_end)
2060 {
2061 // In an enum, all the enumerated values are at the beginning
2062 // separated by comma. The class and object variables/methods
2063 // follow the values.
2064 if (enum_parse_values(eap, cl, line, &classmembers,
2065 &num_enum_values, &enum_end) == FAIL)
2066 break;
Yegappan Lakshmananabedca92024-03-29 10:08:23 +01002067
2068 if (enum_end)
2069 // Add the enum "values" class variable.
2070 enum_add_values_member(cl, &classmembers, num_enum_values,
2071 &type_list);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002072 continue;
2073 }
2074
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002075 int has_public = FALSE;
2076 if (checkforcmd(&p, "public", 3))
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002077 {
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002078 if (STRNCMP(line, "public", 6) != 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002079 {
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002080 semsg(_(e_command_cannot_be_shortened_str), line);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002081 break;
2082 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002083 if (is_interface)
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02002084 {
Yegappan Lakshmananb90e3bc2023-09-28 23:06:48 +02002085 emsg(_(e_public_variable_not_supported_in_interface));
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02002086 break;
2087 }
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002088 has_public = TRUE;
2089 p = skipwhite(line + 6);
2090
Yegappan Lakshmananc51578f2024-04-13 17:58:09 +02002091 if (STRNCMP(p, "def", 3) == 0)
2092 {
2093 emsg(_(e_public_keyword_not_supported_for_method));
2094 break;
2095 }
2096
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002097 if (STRNCMP(p, "var", 3) != 0 && STRNCMP(p, "static", 6) != 0
2098 && STRNCMP(p, "final", 5) != 0 && STRNCMP(p, "const", 5) != 0)
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002099 {
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002100 emsg(_(e_public_must_be_followed_by_var_static_final_or_const));
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002101 break;
2102 }
2103 }
Bram Moolenaard505d172022-12-18 21:42:55 +00002104
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002105 int abstract_method = FALSE;
2106 char_u *pa = p;
2107 if (checkforcmd(&p, "abstract", 3))
2108 {
2109 if (STRNCMP(pa, "abstract", 8) != 0)
2110 {
2111 semsg(_(e_command_cannot_be_shortened_str), pa);
2112 break;
2113 }
2114
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002115 if (is_enum)
2116 {
2117 // "abstract" not supported in an enum
2118 emsg(_(e_abstract_cannot_be_used_in_enum));
2119 break;
2120 }
2121
2122 if (is_interface)
Yegappan Lakshmanan2b358ad2023-11-02 20:57:32 +01002123 {
2124 // "abstract" not supported in an interface
2125 emsg(_(e_abstract_cannot_be_used_in_interface));
2126 break;
2127 }
2128
2129 if (!is_abstract)
2130 {
2131 semsg(_(e_abstract_method_in_concrete_class), pa);
2132 break;
2133 }
2134
Yegappan Lakshmanan5a539252023-11-04 09:42:46 +01002135 p = skipwhite(pa + 8);
2136 if (STRNCMP(p, "def", 3) != 0)
2137 {
2138 emsg(_(e_abstract_must_be_followed_by_def));
2139 break;
2140 }
2141
Yegappan Lakshmanan2b358ad2023-11-02 20:57:32 +01002142 abstract_method = TRUE;
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002143 }
2144
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002145 int has_static = FALSE;
2146 char_u *ps = p;
2147 if (checkforcmd(&p, "static", 4))
2148 {
2149 if (STRNCMP(ps, "static", 6) != 0)
2150 {
2151 semsg(_(e_command_cannot_be_shortened_str), ps);
2152 break;
2153 }
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002154
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002155 if (is_interface)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002156 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002157 emsg(_(e_static_member_not_supported_in_interface));
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002158 break;
2159 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002160 has_static = TRUE;
2161 p = skipwhite(ps + 6);
Doug Kearns74da0ee2023-12-14 20:26:26 +01002162
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002163 if (STRNCMP(p, "var", 3) != 0 && STRNCMP(p, "def", 3) != 0
2164 && STRNCMP(p, "final", 5) != 0 && STRNCMP(p, "const", 5) != 0)
Doug Kearns74da0ee2023-12-14 20:26:26 +01002165 {
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002166 emsg(_(e_static_must_be_followed_by_var_def_final_or_const));
Doug Kearns74da0ee2023-12-14 20:26:26 +01002167 break;
2168 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002169 }
2170
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002171 int has_final = FALSE;
2172 int has_var = FALSE;
2173 int has_const = FALSE;
2174 if (checkforcmd(&p, "var", 3))
2175 has_var = TRUE;
2176 else if (checkforcmd(&p, "final", 5))
2177 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002178 if (is_interface)
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002179 {
2180 emsg(_(e_final_variable_not_supported_in_interface));
2181 break;
2182 }
2183 has_final = TRUE;
2184 }
2185 else if (checkforcmd(&p, "const", 5))
2186 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002187 if (is_interface)
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002188 {
2189 emsg(_(e_const_variable_not_supported_in_interface));
2190 break;
2191 }
2192 has_const = TRUE;
2193 }
2194 p = skipwhite(p);
2195
Bram Moolenaard505d172022-12-18 21:42:55 +00002196 // object members (public, read access, private):
Doug Kearns74da0ee2023-12-14 20:26:26 +01002197 // "var _varname"
2198 // "var varname"
2199 // "public var varname"
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002200 // "final _varname"
2201 // "final varname"
2202 // "public final varname"
2203 // "const _varname"
2204 // "const varname"
2205 // "public const varname"
Doug Kearns74da0ee2023-12-14 20:26:26 +01002206 // class members (public, read access, private):
2207 // "static var _varname"
2208 // "static var varname"
2209 // "public static var varname"
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002210 // "static final _varname"
2211 // "static final varname"
2212 // "public static final varname"
2213 // "static const _varname"
2214 // "static const varname"
2215 // "public static const varname"
2216 if (has_var || has_final || has_const)
Bram Moolenaar3d473ee2022-12-14 20:59:32 +00002217 {
Doug Kearns74da0ee2023-12-14 20:26:26 +01002218 char_u *varname = p;
Bram Moolenaard505d172022-12-18 21:42:55 +00002219 char_u *varname_end = NULL;
Bram Moolenaar74e12742022-12-13 21:14:28 +00002220 type_T *type = NULL;
Bram Moolenaard505d172022-12-18 21:42:55 +00002221 char_u *init_expr = NULL;
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002222 int has_type = FALSE;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002223
Doug Kearns74da0ee2023-12-14 20:26:26 +01002224 if (!eval_isnamec1(*p))
2225 {
2226 if (has_static)
2227 semsg(_(e_invalid_class_variable_declaration_str), line);
2228 else
2229 semsg(_(e_invalid_object_variable_declaration_str), line);
2230 break;
2231 }
2232
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002233 if (is_interface && *varname == '_')
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002234 {
2235 // private variables are not supported in an interface
Ernie Rael03042a22023-11-11 08:53:32 +01002236 semsg(_(e_protected_variable_not_supported_in_interface),
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002237 varname);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002238 break;
2239 }
2240
Bram Moolenaard505d172022-12-18 21:42:55 +00002241 if (parse_member(eap, line, varname, has_public,
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002242 &varname_end, &has_type, &type_list, &type,
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002243 !is_interface ? &init_expr: NULL) == FAIL)
Bram Moolenaard505d172022-12-18 21:42:55 +00002244 break;
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002245
2246 if (is_reserved_varname(varname, varname_end)
2247 || is_duplicate_variable(&classmembers, &objmembers,
2248 varname, varname_end))
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02002249 {
2250 vim_free(init_expr);
2251 break;
2252 }
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002253 if (add_member(has_static ? &classmembers : &objmembers, varname,
2254 varname_end, has_public, has_final, has_const,
2255 has_type, type, init_expr) == FAIL)
Bram Moolenaar74e12742022-12-13 21:14:28 +00002256 {
Bram Moolenaard505d172022-12-18 21:42:55 +00002257 vim_free(init_expr);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002258 break;
2259 }
Bram Moolenaard505d172022-12-18 21:42:55 +00002260 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002261
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002262 // constructors:
2263 // def new()
2264 // enddef
2265 // def newOther()
2266 // enddef
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002267 // object methods and class functions:
2268 // def SomeMethod()
2269 // enddef
2270 // static def ClassFunction()
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002271 // enddef
2272 // TODO:
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002273 // def <Tval> someMethod()
2274 // enddef
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002275 else if (checkforcmd(&p, "def", 3))
2276 {
2277 exarg_T ea;
2278 garray_T lines_to_free;
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002279 int is_new = STRNCMP(p, "new", 3) == 0;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002280
Yegappan Lakshmanan2dede3d2023-09-27 19:02:01 +02002281 if (has_public)
2282 {
2283 // "public" keyword is not supported when defining an object or
2284 // class method
2285 emsg(_(e_public_keyword_not_supported_for_method));
2286 break;
2287 }
2288
2289 if (*p == NUL)
2290 {
2291 // No method name following def
2292 semsg(_(e_not_valid_command_in_class_str), line);
2293 break;
2294 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002295
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002296 if (is_interface && *p == '_')
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002297 {
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002298 // private methods are not supported in an interface
2299 semsg(_(e_protected_method_not_supported_in_interface), p);
2300 break;
2301 }
2302
2303 if (has_static && !is_new && SAFE_islower(*p) &&
2304 is_valid_builtin_obj_methodname(p))
2305 {
2306 semsg(_(e_builtin_class_method_not_supported), p);
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002307 break;
2308 }
2309
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002310 CLEAR_FIELD(ea);
2311 ea.cmd = line;
2312 ea.arg = p;
2313 ea.cmdidx = CMD_def;
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01002314 ea.ea_getline = eap->ea_getline;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002315 ea.cookie = eap->cookie;
2316
2317 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002318 int class_flags;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002319 if (is_interface)
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002320 class_flags = CF_INTERFACE;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002321 else
2322 class_flags = abstract_method ? CF_ABSTRACT_METHOD : CF_CLASS;
Bram Moolenaar554d0312023-01-05 19:59:18 +00002323 ufunc_T *uf = define_function(&ea, NULL, &lines_to_free,
h-eastb895b0f2023-09-24 15:46:31 +02002324 class_flags, objmembers.ga_data, objmembers.ga_len);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002325 ga_clear_strings(&lines_to_free);
2326
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002327 if (uf != NULL)
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002328 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002329 char_u *name = uf->uf_name;
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +02002330
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002331 if (is_new && !is_valid_constructor(uf, is_abstract,
2332 has_static))
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002333 {
2334 // private variables are not supported in an interface
Ernie Rael03042a22023-11-11 08:53:32 +01002335 semsg(_(e_protected_method_not_supported_in_interface),
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002336 name);
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002337 func_clear_free(uf, FALSE);
2338 break;
2339 }
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002340
2341 // check for builtin method
2342 if (!is_new && SAFE_islower(*name) &&
2343 !object_check_builtin_method_sig(uf))
Bram Moolenaar24a8d062023-01-14 13:12:06 +00002344 {
Yegappan Lakshmananb1027282023-08-19 11:26:42 +02002345 func_clear_free(uf, FALSE);
Bram Moolenaar24a8d062023-01-14 13:12:06 +00002346 break;
2347 }
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +02002348
Bram Moolenaar58b40092023-01-11 15:59:05 +00002349 // Check the name isn't used already.
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002350 if (is_duplicate_method(&classfunctions, &objmethods, name))
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002351 {
2352 success = FALSE;
2353 func_clear_free(uf, FALSE);
Yegappan Lakshmanan2ba9d2e2023-08-28 21:26:23 +02002354 break;
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002355 }
Bram Moolenaar58b40092023-01-11 15:59:05 +00002356
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002357 garray_T *fgap = has_static || is_new
2358 ? &classfunctions : &objmethods;
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002359 if (ga_grow(fgap, 1) == OK)
2360 {
2361 if (is_new)
2362 uf->uf_flags |= FC_NEW;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002363
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002364 if (abstract_method)
2365 uf->uf_flags |= FC_ABSTRACT;
2366
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002367 ((ufunc_T **)fgap->ga_data)[fgap->ga_len] = uf;
2368 ++fgap->ga_len;
2369 }
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002370 }
2371 }
2372
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002373 else
2374 {
Bram Moolenaar554d0312023-01-05 19:59:18 +00002375 if (is_class)
2376 semsg(_(e_not_valid_command_in_class_str), line);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002377 else if (is_enum)
2378 semsg(_(e_not_valid_command_in_enum_str), line);
Bram Moolenaar554d0312023-01-05 19:59:18 +00002379 else
2380 semsg(_(e_not_valid_command_in_interface_str), line);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002381 break;
2382 }
2383 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002384
2385 if (theline == NULL && !success && is_enum)
2386 emsg(_(e_missing_endenum));
2387
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002388 vim_free(theline);
2389
Yegappan Lakshmananabedca92024-03-29 10:08:23 +01002390 if (success && is_enum && num_enum_values == 0)
2391 // Empty enum statement. Add an empty "values" class variable
2392 enum_add_values_member(cl, &classmembers, 0, &type_list);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002393
Bram Moolenaar83677162023-01-08 19:54:10 +00002394 /*
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002395 * Check a few things
Bram Moolenaar83677162023-01-08 19:54:10 +00002396 */
2397
2398 // Check the "extends" class is valid.
2399 if (success && extends != NULL)
Yegappan Lakshmanan35b867b2024-03-09 15:44:19 +01002400 success = validate_extends_class(cl, extends, &extends_cl, is_class);
Bram Moolenaar83677162023-01-08 19:54:10 +00002401 VIM_CLEAR(extends);
2402
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002403 // Check the new object methods to make sure their access (public or
2404 // private) is the same as that in the extended class lineage.
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002405 if (success && extends_cl != NULL)
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002406 success = validate_extends_methods(&objmethods, extends_cl);
2407
2408 // Check the new class and object variables are not duplicates of the
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002409 // variables in the extended class lineage. If an interface is extending
2410 // another interface, then it can duplicate the member variables.
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002411 if (success && extends_cl != NULL)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02002412 {
2413 if (is_class)
2414 success = extends_check_dup_members(&objmembers, extends_cl);
2415 else
2416 success = extends_check_intf_var_type(&objmembers, extends_cl);
2417 }
Yegappan Lakshmanane3b6c782023-08-29 22:32:02 +02002418
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002419 // When extending an abstract class, make sure all the abstract methods in
2420 // the parent class are implemented. If the current class is an abstract
2421 // class, then there is no need for this check.
2422 if (success && !is_abstract && extends_cl != NULL
2423 && (extends_cl->class_flags & CLASS_ABSTRACT))
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002424 success = validate_abstract_class_methods(&classfunctions,
2425 &objmethods, extends_cl);
Yegappan Lakshmanan7bcd25c2023-09-08 19:27:51 +02002426
Bram Moolenaar83677162023-01-08 19:54:10 +00002427 // Check all "implements" entries are valid.
Bram Moolenaar94674f22023-01-06 18:42:20 +00002428 if (success && ga_impl.ga_len > 0)
2429 {
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00002430 intf_classes = ALLOC_CLEAR_MULT(class_T *, ga_impl.ga_len);
2431
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002432 success = validate_implements_classes(&ga_impl, intf_classes,
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002433 &objmethods, &objmembers, extends_cl);
Bram Moolenaar94674f22023-01-06 18:42:20 +00002434 }
2435
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002436 // Check no function argument name is used as a class member.
Bram Moolenaard40f00c2023-01-13 17:36:49 +00002437 if (success)
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002438 success = check_func_arg_names(&classfunctions, &objmethods,
2439 &classmembers);
Bram Moolenaard40f00c2023-01-13 17:36:49 +00002440
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002441 if (success)
2442 {
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002443 // "endclass" or "endinterface" or "endenum" encountered without any
2444 // failures
Bram Moolenaard505d172022-12-18 21:42:55 +00002445
Bram Moolenaard0200c82023-01-28 15:19:40 +00002446 if (extends_cl != NULL)
2447 {
2448 cl->class_extends = extends_cl;
2449 extends_cl->class_flags |= CLASS_EXTENDED;
2450 }
Bram Moolenaar83677162023-01-08 19:54:10 +00002451
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002452 // Add class and object variables to "cl".
Bram Moolenaard505d172022-12-18 21:42:55 +00002453 if (add_members_to_class(&classmembers,
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002454 NULL,
2455 0,
Bram Moolenaar83677162023-01-08 19:54:10 +00002456 &cl->class_class_members,
2457 &cl->class_class_member_count) == FAIL
Bram Moolenaard505d172022-12-18 21:42:55 +00002458 || add_members_to_class(&objmembers,
Bram Moolenaar83677162023-01-08 19:54:10 +00002459 extends_cl == NULL ? NULL
2460 : extends_cl->class_obj_members,
2461 extends_cl == NULL ? 0
2462 : extends_cl->class_obj_member_count,
2463 &cl->class_obj_members,
2464 &cl->class_obj_member_count) == FAIL)
Bram Moolenaard505d172022-12-18 21:42:55 +00002465 goto cleanup;
2466
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00002467 if (ga_impl.ga_len > 0)
2468 {
2469 // Move the "implements" names into the class.
2470 cl->class_interface_count = ga_impl.ga_len;
2471 cl->class_interfaces = ALLOC_MULT(char_u *, ga_impl.ga_len);
2472 if (cl->class_interfaces == NULL)
2473 goto cleanup;
2474 for (int i = 0; i < ga_impl.ga_len; ++i)
2475 cl->class_interfaces[i] = ((char_u **)ga_impl.ga_data)[i];
2476 VIM_CLEAR(ga_impl.ga_data);
2477 ga_impl.ga_len = 0;
2478
Bram Moolenaard0200c82023-01-28 15:19:40 +00002479 cl->class_interfaces_cl = intf_classes;
2480 intf_classes = NULL;
2481 }
2482
2483 if (cl->class_interface_count > 0 || extends_cl != NULL)
2484 {
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002485 // Add a method and member lookup table to each of the interface
2486 // classes.
2487 if (add_lookup_tables(cl, extends_cl, &objmethods) == FAIL)
2488 goto cleanup;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00002489 }
2490
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02002491 int have_new = FALSE;
2492 ufunc_T *class_func = NULL;
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002493 for (int i = 0; i < classfunctions.ga_len; ++i)
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02002494 {
2495 class_func = ((ufunc_T **)classfunctions.ga_data)[i];
2496 if (STRCMP(class_func->uf_name, "new") == 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002497 {
2498 have_new = TRUE;
2499 break;
2500 }
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +02002501 }
2502
2503 if (have_new)
2504 // The return type of new() is an object of class "cl"
2505 class_func->uf_ret_type->tt_class = cl;
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002506 else if ((is_class || is_enum) && !is_abstract && !have_new)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002507 // No new() method was defined, add the default constructor.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002508 add_default_constructor(cl, &classfunctions, &type_list);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002509
Bram Moolenaar58b40092023-01-11 15:59:05 +00002510 // Move all the functions into the created class.
Yegappan Lakshmanan4b1cc792023-08-19 22:39:33 +02002511 if (add_classfuncs_objmethods(cl, extends_cl, &classfunctions,
2512 &objmethods) == FAIL)
2513 goto cleanup;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002514
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01002515 update_builtin_method_index(cl);
2516
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002517 class_created(cl);
2518
2519 // Allocate a typval for each class member and initialize it.
2520 if ((is_class || is_enum) && cl->class_class_member_count > 0)
2521 if (add_class_members(cl, eap, &type_list) == FAIL)
2522 goto cleanup;
2523
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002524 cl->class_type_list = type_list;
2525
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002526 if (is_enum)
2527 {
2528 // clear the constructor method names, so that an enum class cannot
2529 // be instantiated
2530 enum_clear_constructors(cl);
2531 }
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02002532
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002533 // TODO:
Bram Moolenaard505d172022-12-18 21:42:55 +00002534 // - Fill hashtab with object members and methods ?
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002535
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002536 return;
2537 }
2538
2539cleanup:
Bram Moolenaar83677162023-01-08 19:54:10 +00002540 vim_free(extends);
2541 class_unref(extends_cl);
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00002542
2543 if (intf_classes != NULL)
2544 {
2545 for (int i = 0; i < ga_impl.ga_len; ++i)
2546 class_unref(intf_classes[i]);
2547 vim_free(intf_classes);
2548 }
Bram Moolenaar94674f22023-01-06 18:42:20 +00002549 ga_clear_strings(&ga_impl);
2550
Bram Moolenaard505d172022-12-18 21:42:55 +00002551 for (int round = 1; round <= 2; ++round)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002552 {
Bram Moolenaard505d172022-12-18 21:42:55 +00002553 garray_T *gap = round == 1 ? &classmembers : &objmembers;
2554 if (gap->ga_len == 0 || gap->ga_data == NULL)
2555 continue;
2556
2557 for (int i = 0; i < gap->ga_len; ++i)
2558 {
2559 ocmember_T *m = ((ocmember_T *)gap->ga_data) + i;
2560 vim_free(m->ocm_name);
2561 vim_free(m->ocm_init);
2562 }
2563 ga_clear(gap);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002564 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002565
Bram Moolenaarffdaca92022-12-09 21:41:48 +00002566 for (int i = 0; i < objmethods.ga_len; ++i)
2567 {
2568 ufunc_T *uf = ((ufunc_T **)objmethods.ga_data)[i];
2569 func_clear_free(uf, FALSE);
2570 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002571 ga_clear(&objmethods);
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002572
2573 for (int i = 0; i < classfunctions.ga_len; ++i)
2574 {
2575 ufunc_T *uf = ((ufunc_T **)classfunctions.ga_data)[i];
2576 func_clear_free(uf, FALSE);
2577 }
2578 ga_clear(&classfunctions);
2579
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002580 clear_type_list(&type_list);
2581}
2582
2583/*
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002584 * Find member "name" in class "cl", set "member_idx" to the member index and
2585 * return its type.
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002586 * When "is_object" is TRUE, then look for object members. Otherwise look for
2587 * class members.
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002588 * When not found "member_idx" is set to -1 and t_any is returned.
Ernie Rael456ae552023-09-01 18:54:54 +02002589 * Set *p_m ocmmember_T if not NULL
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002590 */
2591 type_T *
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002592oc_member_type(
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002593 class_T *cl,
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002594 int is_object,
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002595 char_u *name,
2596 char_u *name_end,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002597 int *member_idx)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002598{
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002599 size_t len = name_end - name;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002600 ocmember_T *m;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002601
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002602 *member_idx = -1; // not found (yet)
2603
2604 m = member_lookup(cl, is_object ? VAR_OBJECT : VAR_CLASS, name, len,
2605 member_idx);
2606 if (m == NULL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002607 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002608 member_not_found_msg(cl, is_object ? VAR_OBJECT : VAR_CLASS, name,
2609 len);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002610 return &t_any;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002611 }
Bram Moolenaarf54cedd2022-12-23 17:56:27 +00002612
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002613 return m->ocm_type;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002614}
2615
2616/*
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002617 * Given a class or object variable index, return the variable type
2618 */
2619 type_T *
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002620oc_member_type_by_idx(
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02002621 class_T *cl,
2622 int is_object,
2623 int member_idx)
2624{
2625 ocmember_T *m;
2626 int member_count;
2627
2628 if (is_object)
2629 {
2630 m = cl->class_obj_members;
2631 member_count = cl->class_obj_member_count;
2632 }
2633 else
2634 {
2635 m = cl->class_class_members;
2636 member_count = cl->class_class_member_count;
2637 }
2638
2639 if (member_idx >= member_count)
2640 return NULL;
2641
2642 return m[member_idx].ocm_type;
2643}
2644
2645/*
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002646 * Type aliases (:type)
2647 */
2648
2649 void
2650typealias_free(typealias_T *ta)
2651{
2652 // ta->ta_type is freed in clear_type_list()
2653 vim_free(ta->ta_name);
2654 vim_free(ta);
2655}
2656
2657 void
2658typealias_unref(typealias_T *ta)
2659{
2660 if (ta != NULL && --ta->ta_refcount <= 0)
2661 typealias_free(ta);
2662}
2663
2664/*
2665 * Handle ":type". Create an alias for a type specification.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002666 */
2667 void
Dominique Pellé0268ff32024-07-28 21:12:20 +02002668ex_type(exarg_T *eap)
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002669{
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002670 char_u *arg = eap->arg;
2671
2672 if (!current_script_is_vim9()
2673 || (cmdmod.cmod_flags & CMOD_LEGACY)
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01002674 || !getline_equal(eap->ea_getline, eap->cookie, getsourceline))
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002675 {
2676 emsg(_(e_type_can_only_be_defined_in_vim9_script));
2677 return;
2678 }
2679
2680 if (*arg == NUL)
2681 {
2682 emsg(_(e_missing_typealias_name));
2683 return;
2684 }
2685
2686 if (!ASCII_ISUPPER(*arg))
2687 {
2688 semsg(_(e_type_name_must_start_with_uppercase_letter_str), arg);
2689 return;
2690 }
2691
2692 char_u *name_end = find_name_end(arg, NULL, NULL, FNE_CHECK_START);
2693 if (!IS_WHITE_OR_NUL(*name_end))
2694 {
2695 semsg(_(e_white_space_required_after_name_str), arg);
2696 return;
2697 }
2698 char_u *name_start = arg;
2699
2700 arg = skipwhite(name_end);
2701 if (*arg != '=')
2702 {
2703 semsg(_(e_missing_equal_str), arg);
2704 return;
2705 }
2706 if (!IS_WHITE_OR_NUL(*(arg + 1)))
2707 {
2708 semsg(_(e_white_space_required_after_str_str), "=", arg);
2709 return;
2710 }
2711 arg++;
2712 arg = skipwhite(arg);
2713
2714 if (*arg == NUL)
2715 {
2716 emsg(_(e_missing_typealias_type));
2717 return;
2718 }
2719
2720 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
2721 type_T *type = parse_type(&arg, &si->sn_type_list, TRUE);
2722 if (type == NULL)
2723 return;
2724
2725 if (*arg != NUL)
2726 {
2727 // some text after the type
2728 semsg(_(e_trailing_characters_str), arg);
2729 return;
2730 }
2731
2732 int cc = *name_end;
2733 *name_end = NUL;
2734
2735 typval_T tv;
2736 tv.v_type = VAR_UNKNOWN;
2737 if (eval_variable_import(name_start, &tv) == OK)
2738 {
2739 if (tv.v_type == VAR_TYPEALIAS)
2740 semsg(_(e_typealias_already_exists_for_str), name_start);
2741 else
2742 semsg(_(e_redefining_script_item_str), name_start);
2743 clear_tv(&tv);
2744 goto done;
2745 }
2746
Yegappan Lakshmananfeaccd22023-10-28 15:53:55 +02002747 // Create a script-local variable for the type alias.
2748 if (type->tt_type != VAR_OBJECT)
2749 {
2750 tv.v_type = VAR_TYPEALIAS;
2751 tv.v_lock = 0;
2752 tv.vval.v_typealias = ALLOC_CLEAR_ONE(typealias_T);
2753 ++tv.vval.v_typealias->ta_refcount;
2754 tv.vval.v_typealias->ta_name = vim_strsave(name_start);
2755 tv.vval.v_typealias->ta_type = type;
2756 }
2757 else
2758 {
2759 // When creating a type alias for a class, use the class type itself to
2760 // create the type alias variable. This is needed to use the type
2761 // alias to invoke class methods (e.g. new()) and use class variables.
2762 tv.v_type = VAR_CLASS;
2763 tv.v_lock = 0;
2764 tv.vval.v_class = type->tt_class;
2765 ++tv.vval.v_class->class_refcount;
2766 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002767 set_var_const(name_start, current_sctx.sc_sid, NULL, &tv, FALSE,
2768 ASSIGN_CONST | ASSIGN_FINAL, 0);
2769
2770done:
2771 *name_end = cc;
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002772}
2773
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002774/*
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002775 * Returns OK if a member variable named "name" is present in the class "cl".
2776 * Otherwise returns FAIL. If found, the member variable typval is set in
2777 * "rettv". If "is_object" is TRUE, then the object member variable table is
2778 * searched. Otherwise the class member variable table is searched.
2779 */
2780 static int
2781get_member_tv(
2782 class_T *cl,
2783 int is_object,
2784 char_u *name,
2785 size_t namelen,
2786 typval_T *rettv)
2787{
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002788 ocmember_T *m;
2789 int m_idx;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002790
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002791 m = member_lookup(cl, is_object ? VAR_OBJECT : VAR_CLASS, name, namelen,
2792 &m_idx);
2793 if (m == NULL)
2794 return FAIL;
2795
2796 if (*name == '_')
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002797 {
Ernie Rael03042a22023-11-11 08:53:32 +01002798 emsg_var_cl_define(e_cannot_access_protected_variable_str,
Ernie Raele6c9aa52023-10-06 19:55:52 +02002799 m->ocm_name, 0, cl);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002800 return FAIL;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002801 }
2802
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002803 if (is_object)
2804 {
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002805 // The object only contains a pointer to the class, the member values
2806 // array follows right after that.
2807 object_T *obj = rettv->vval.v_object;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002808 typval_T *tv = (typval_T *)(obj + 1) + m_idx;
2809 copy_tv(tv, rettv);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002810 object_unref(obj);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002811 }
2812 else
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002813 {
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002814 copy_tv(&cl->class_members_tv[m_idx], rettv);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002815 class_unref(cl);
2816 }
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002817
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002818 return OK;
2819}
2820
2821/*
2822 * Call an object or class method "name" in class "cl". The method return
2823 * value is returned in "rettv".
2824 */
2825 static int
2826call_oc_method(
2827 class_T *cl,
2828 char_u *name,
2829 size_t len,
2830 char_u *name_end,
2831 evalarg_T *evalarg,
2832 char_u **arg,
2833 typval_T *rettv)
2834{
2835 ufunc_T *fp;
2836 typval_T argvars[MAX_FUNC_ARGS + 1];
2837 int argcount = 0;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002838 ocmember_T *ocm = NULL;
2839 int m_idx;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002840
2841 fp = method_lookup(cl, rettv->v_type, name, len, NULL);
2842 if (fp == NULL)
2843 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002844 // could be an object or class funcref variable
2845 ocm = member_lookup(cl, rettv->v_type, name, len, &m_idx);
2846 if (ocm == NULL || ocm->ocm_type->tt_type != VAR_FUNC)
2847 {
2848 method_not_found_msg(cl, rettv->v_type, name, len);
2849 return FAIL;
2850 }
2851
Yegappan Lakshmanan3e336502024-04-04 19:35:59 +02002852 if (*name == '_')
2853 {
2854 // Protected object or class funcref variable
2855 semsg(_(e_cannot_access_protected_variable_str), ocm->ocm_name,
2856 cl->class_name);
2857 return FAIL;
2858 }
2859
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002860 if (rettv->v_type == VAR_OBJECT)
2861 {
2862 // funcref object variable
2863 object_T *obj = rettv->vval.v_object;
2864 typval_T *tv = (typval_T *)(obj + 1) + m_idx;
2865 copy_tv(tv, rettv);
2866 }
2867 else
2868 // funcref class variable
2869 copy_tv(&cl->class_members_tv[m_idx], rettv);
2870 *arg = name_end;
2871 return OK;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002872 }
2873
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002874 if (ocm == NULL && *fp->uf_name == '_')
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002875 {
2876 // Cannot access a private method outside of a class
Ernie Rael03042a22023-11-11 08:53:32 +01002877 semsg(_(e_cannot_access_protected_method_str), fp->uf_name);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002878 return FAIL;
2879 }
2880
2881 char_u *argp = name_end;
Ernie Raelb077b582023-12-14 20:11:44 +01002882 int ret = get_func_arguments(&argp, evalarg, 0, argvars, &argcount, FALSE);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002883 if (ret == FAIL)
2884 return FAIL;
2885
2886 funcexe_T funcexe;
2887 CLEAR_FIELD(funcexe);
2888 funcexe.fe_evaluate = TRUE;
2889 if (rettv->v_type == VAR_OBJECT)
2890 {
2891 funcexe.fe_object = rettv->vval.v_object;
2892 ++funcexe.fe_object->obj_refcount;
2893 }
2894
2895 // Clear the class or object after calling the function, in
2896 // case the refcount is one.
2897 typval_T tv_tofree = *rettv;
2898 rettv->v_type = VAR_UNKNOWN;
2899
2900 // Call the user function. Result goes into rettv;
2901 int error = call_user_func_check(fp, argcount, argvars, rettv, &funcexe,
2902 NULL);
2903
2904 // Clear the previous rettv and the arguments.
2905 clear_tv(&tv_tofree);
2906 for (int idx = 0; idx < argcount; ++idx)
2907 clear_tv(&argvars[idx]);
2908
2909 if (error != FCERR_NONE)
2910 {
2911 user_func_error(error, printable_func_name(fp), funcexe.fe_found_var);
2912 return FAIL;
2913 }
2914 *arg = argp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002915
2916 return OK;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002917}
2918
2919/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002920 * Evaluate what comes after a class:
2921 * - class member: SomeClass.varname
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00002922 * - class function: SomeClass.SomeMethod()
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002923 * - class constructor: SomeClass.new()
2924 * - object member: someObject.varname
2925 * - object method: someObject.SomeMethod()
2926 *
2927 * "*arg" points to the '.'.
2928 * "*arg" is advanced to after the member name or method call.
2929 *
2930 * Returns FAIL or OK.
2931 */
2932 int
2933class_object_index(
2934 char_u **arg,
2935 typval_T *rettv,
2936 evalarg_T *evalarg,
2937 int verbose UNUSED) // give error messages
2938{
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002939 if (VIM_ISWHITE((*arg)[1]))
2940 {
2941 semsg(_(e_no_white_space_allowed_after_str_str), ".", *arg);
2942 return FAIL;
2943 }
2944
2945 ++*arg;
2946 char_u *name = *arg;
2947 char_u *name_end = find_name_end(name, NULL, NULL, FNE_CHECK_START);
2948 if (name_end == name)
2949 return FAIL;
2950 size_t len = name_end - name;
2951
Ernie Raeld615a312023-10-05 20:28:16 +02002952 int did_emsg_save = did_emsg;
Bram Moolenaar552bdca2023-02-17 21:08:50 +00002953 class_T *cl;
2954 if (rettv->v_type == VAR_CLASS)
2955 cl = rettv->vval.v_class;
2956 else // VAR_OBJECT
2957 {
2958 if (rettv->vval.v_object == NULL)
2959 {
2960 emsg(_(e_using_null_object));
2961 return FAIL;
2962 }
2963 cl = rettv->vval.v_object->obj_class;
2964 }
2965
Bram Moolenaard13dd302023-03-11 20:56:35 +00002966 if (cl == NULL)
2967 {
2968 emsg(_(e_incomplete_type));
2969 return FAIL;
2970 }
2971
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002972 if (*name_end == '(')
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002973 // Invoke the class or object method
2974 return call_oc_method(cl, name, len, name_end, evalarg, arg, rettv);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002975
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002976 else if (rettv->v_type == VAR_OBJECT || rettv->v_type == VAR_CLASS)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002977 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002978 // Search in the object member variable table and the class member
2979 // variable table.
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002980 int is_object = rettv->v_type == VAR_OBJECT;
2981 if (get_member_tv(cl, is_object, name, len, rettv) == OK)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002982 {
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02002983 *arg = name_end;
2984 return OK;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002985 }
2986
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002987 // could be a class method or an object method
2988 int fidx;
2989 ufunc_T *fp = method_lookup(cl, rettv->v_type, name, len, &fidx);
2990 if (fp != NULL)
2991 {
2992 // Private methods are not accessible outside the class
2993 if (*name == '_')
2994 {
Ernie Rael03042a22023-11-11 08:53:32 +01002995 semsg(_(e_cannot_access_protected_method_str), fp->uf_name);
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02002996 return FAIL;
2997 }
2998
2999 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
3000 if (pt == NULL)
3001 return FAIL;
3002
3003 pt->pt_refcount = 1;
3004 if (is_object)
3005 {
3006 pt->pt_obj = rettv->vval.v_object;
3007 ++pt->pt_obj->obj_refcount;
3008 }
3009 pt->pt_auto = TRUE;
3010 pt->pt_func = fp;
3011 func_ptr_ref(pt->pt_func);
3012 rettv->v_type = VAR_PARTIAL;
3013 rettv->vval.v_partial = pt;
3014 *arg = name_end;
3015 return OK;
3016 }
3017
Ernie Raeld615a312023-10-05 20:28:16 +02003018 if (did_emsg == did_emsg_save)
Yegappan Lakshmanan0ab500d2023-10-21 11:59:42 +02003019 member_not_found_msg(cl, rettv->v_type, name, len);
Bram Moolenaard505d172022-12-18 21:42:55 +00003020 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003021
3022 return FAIL;
3023}
3024
3025/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003026 * If "arg" points to a class or object method, return it.
3027 * Otherwise return NULL.
3028 */
3029 ufunc_T *
3030find_class_func(char_u **arg)
3031{
3032 char_u *name = *arg;
3033 char_u *name_end = find_name_end(name, NULL, NULL, FNE_CHECK_START);
3034 if (name_end == name || *name_end != '.')
3035 return NULL;
3036
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003037 ufunc_T *fp = NULL;
Yegappan Lakshmanan1689e842023-09-06 20:23:23 +02003038 size_t len = name_end - name;
3039 typval_T tv;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003040 tv.v_type = VAR_UNKNOWN;
Bram Moolenaar993dbc32023-01-01 20:31:30 +00003041 if (eval_variable(name, (int)len,
3042 0, &tv, NULL, EVAL_VAR_NOAUTOLOAD) == FAIL)
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003043 return NULL;
3044 if (tv.v_type != VAR_CLASS && tv.v_type != VAR_OBJECT)
Bram Moolenaareb533502022-12-14 15:06:11 +00003045 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003046
3047 class_T *cl = tv.v_type == VAR_CLASS ? tv.vval.v_class
3048 : tv.vval.v_object->obj_class;
3049 if (cl == NULL)
Bram Moolenaareb533502022-12-14 15:06:11 +00003050 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003051 char_u *fname = name_end + 1;
3052 char_u *fname_end = find_name_end(fname, NULL, NULL, FNE_CHECK_START);
3053 if (fname_end == fname)
Bram Moolenaareb533502022-12-14 15:06:11 +00003054 goto fail_after_eval;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003055 len = fname_end - fname;
3056
Ernie Rael4d00b832023-09-11 19:54:42 +02003057 fp = method_lookup(cl, tv.v_type, fname, len, NULL);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003058
Bram Moolenaareb533502022-12-14 15:06:11 +00003059fail_after_eval:
3060 clear_tv(&tv);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003061 return fp;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003062}
3063
3064/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003065 * Returns the index of class variable "name" in the class "cl".
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003066 * Returns -1, if the variable is not found.
3067 * If "namelen" is zero, then it is assumed that "name" is NUL terminated.
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00003068 */
3069 int
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003070class_member_idx(class_T *cl, char_u *name, size_t namelen)
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00003071{
Ernie Rael4d00b832023-09-11 19:54:42 +02003072 int idx;
3073 class_member_lookup(cl, name, namelen, &idx);
3074 return idx;
Bram Moolenaar6bafdd42023-01-01 12:58:33 +00003075}
3076
3077/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003078 * Returns a pointer to the class member variable "name" in the class "cl".
3079 * Returns NULL if the variable is not found.
3080 * The member variable index is set in "idx".
3081 */
3082 ocmember_T *
3083class_member_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3084{
Ernie Rael4d00b832023-09-11 19:54:42 +02003085 ocmember_T *ret_m = NULL;
3086 int ret_idx = -1;
3087 for (int i = 0; i < cl->class_class_member_count; ++i)
3088 {
3089 ocmember_T *m = &cl->class_class_members[i];
3090 if (namelen)
3091 {
3092 if (STRNCMP(name, m->ocm_name, namelen) == 0
3093 && m->ocm_name[namelen] == NUL)
3094 {
3095 ret_m = m;
3096 ret_idx = i;
3097 break;
3098 }
3099 }
3100 else if (STRCMP(name, m->ocm_name) == 0)
3101 {
3102 ret_m = m;
3103 ret_idx = i;
zeertzjqd9be94c2024-07-14 10:20:20 +02003104 break;
Ernie Rael4d00b832023-09-11 19:54:42 +02003105 }
3106 }
3107 if (idx != NULL)
3108 *idx = ret_idx;
3109 return ret_m;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003110}
3111
3112/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003113 * Returns a pointer to the class method "name" in class "cl".
3114 * Returns NULL if the method is not found.
3115 * The method index is set in "idx".
3116 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003117 static ufunc_T *
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003118class_method_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3119{
Ernie Rael4d00b832023-09-11 19:54:42 +02003120 ufunc_T *ret_fp = NULL;
3121 int ret_idx = -1;
3122 for (int i = 0; i < cl->class_class_function_count; ++i)
3123 {
3124 ufunc_T *fp = cl->class_class_functions[i];
3125 char_u *ufname = (char_u *)fp->uf_name;
3126 if (STRNCMP(name, ufname, namelen) == 0 && ufname[namelen] == NUL)
3127 {
3128 ret_fp = fp;
3129 ret_idx = i;
3130 break;
3131 }
3132 }
3133 if (idx != NULL)
3134 *idx = ret_idx;
3135 return ret_fp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003136}
3137
3138/*
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003139 * Returns the index of class method "name" in the class "cl".
3140 * Returns -1, if the method is not found.
3141 */
3142 int
3143class_method_idx(class_T *cl, char_u *name, size_t namelen)
3144{
3145 int idx;
3146 class_method_lookup(cl, name, namelen, &idx);
3147 return idx;
3148}
3149
3150/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003151 * Returns the index of object member variable "name" in the class "cl".
3152 * Returns -1, if the variable is not found.
3153 * If "namelen" is zero, then it is assumed that "name" is NUL terminated.
3154 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003155 static int
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003156object_member_idx(class_T *cl, char_u *name, size_t namelen)
3157{
Ernie Rael4d00b832023-09-11 19:54:42 +02003158 int idx;
3159 object_member_lookup(cl, name, namelen, &idx);
3160 return idx;
Yegappan Lakshmanan342f4f62023-09-09 11:37:23 +02003161}
3162
3163/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003164 * Returns a pointer to the object member variable "name" in the class "cl".
3165 * Returns NULL if the variable is not found.
3166 * The object member variable index is set in "idx".
3167 */
3168 ocmember_T *
3169object_member_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3170{
Ernie Rael4d00b832023-09-11 19:54:42 +02003171 ocmember_T *ret_m = NULL;
3172 int ret_idx = -1;
3173 for (int i = 0; i < cl->class_obj_member_count; ++i)
3174 {
3175 ocmember_T *m = &cl->class_obj_members[i];
3176 if (namelen)
3177 {
3178 if (STRNCMP(name, m->ocm_name, namelen) == 0
3179 && m->ocm_name[namelen] == NUL)
3180 {
3181 ret_m = m;
3182 ret_idx = i;
3183 break;
3184 }
3185 }
3186 else if (STRCMP(name, m->ocm_name) == 0)
zeertzjqd9be94c2024-07-14 10:20:20 +02003187 {
Ernie Rael4d00b832023-09-11 19:54:42 +02003188 ret_m = m;
3189 ret_idx = i;
zeertzjqd9be94c2024-07-14 10:20:20 +02003190 break;
3191 }
Ernie Rael4d00b832023-09-11 19:54:42 +02003192 }
3193 if (idx != NULL)
3194 *idx = ret_idx;
3195 return ret_m;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003196}
3197
3198/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003199 * Returns a pointer to the object method "name" in class "cl".
3200 * Returns NULL if the method is not found.
3201 * The object method index is set in "idx".
3202 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003203 static ufunc_T *
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003204object_method_lookup(class_T *cl, char_u *name, size_t namelen, int *idx)
3205{
Ernie Rael4d00b832023-09-11 19:54:42 +02003206 ufunc_T *ret_fp = NULL;
3207 int ret_idx = -1;
3208 for (int i = 0; i < cl->class_obj_method_count; ++i)
3209 {
3210 ufunc_T *fp = cl->class_obj_methods[i];
3211 // Use a separate pointer to avoid that ASAN complains about
3212 // uf_name[] only being 4 characters.
3213 char_u *ufname = (char_u *)fp->uf_name;
3214 if (STRNCMP(name, ufname, namelen) == 0 && ufname[namelen] == NUL)
3215 {
3216 ret_fp = fp;
3217 ret_idx = i;
3218 break;
3219 }
3220 }
3221 if (idx != NULL)
3222 *idx = ret_idx;
3223 return ret_fp;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003224}
3225
3226/*
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003227 * Returns the index of object method "name" in the class "cl".
3228 * Returns -1, if the method is not found.
3229 */
3230 int
3231object_method_idx(class_T *cl, char_u *name, size_t namelen)
3232{
3233 int idx;
3234 object_method_lookup(cl, name, namelen, &idx);
3235 return idx;
3236}
3237
3238/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003239 * Lookup a class or object member variable by name. If v_type is VAR_CLASS,
3240 * then lookup a class member variable and if it is VAR_OBJECT, then lookup a
3241 * object member variable.
3242 *
3243 * Returns a pointer to the member variable structure if variable is found.
3244 * Otherwise returns NULL. The member variable index is set in "*idx".
3245 */
3246 ocmember_T *
3247member_lookup(
3248 class_T *cl,
3249 vartype_T v_type,
3250 char_u *name,
3251 size_t namelen,
3252 int *idx)
3253{
3254 if (v_type == VAR_CLASS)
3255 return class_member_lookup(cl, name, namelen, idx);
3256 else
3257 return object_member_lookup(cl, name, namelen, idx);
3258}
3259
3260/*
Ernie Raele6c9aa52023-10-06 19:55:52 +02003261 * Find the class that defines the named member. Look up the hierarchy
3262 * starting at "cl".
3263 *
3264 * Return the class that defines the member "name", else NULL.
3265 * Fill in "p_m", if specified, for ocmember_T in found class.
3266 */
3267// NOTE: if useful for something could also indirectly return vartype and idx.
3268 static class_T *
3269class_defining_member(class_T *cl, char_u *name, size_t len, ocmember_T **p_m)
3270{
3271 class_T *cl_found = NULL;
3272 vartype_T vartype = VAR_UNKNOWN;
3273 ocmember_T *m_found = NULL;
3274
3275 len = len != 0 ? len : STRLEN(name);
3276
3277 // Loop assumes if member is not defined in "cl", then it is not
3278 // defined in any super class; the last class where it's found is the
3279 // class where it is defined. Once the vartype is found, the other
3280 // type is no longer checked.
3281 for (class_T *super = cl; super != NULL; super = super->class_extends)
3282 {
3283 class_T *cl_tmp = NULL;
3284 ocmember_T *m = NULL;
3285 if (vartype == VAR_UNKNOWN || vartype == VAR_OBJECT)
3286 {
3287 if ((m = object_member_lookup(super, name, len, NULL)) != NULL)
3288 {
3289 cl_tmp = super;
3290 vartype = VAR_OBJECT;
3291 }
3292 }
3293 if (vartype == VAR_UNKNOWN || vartype == VAR_CLASS)
3294 {
3295 if (( m = class_member_lookup(super, name, len, NULL)) != NULL)
3296 {
3297 cl_tmp = super;
3298 vartype = VAR_OBJECT;
3299 }
3300 }
3301 if (cl_tmp == NULL)
3302 break; // member is not in this or any super class.
3303 cl_found = cl_tmp;
3304 m_found = m;
3305 }
3306 if (p_m != NULL)
3307 *p_m = m_found;
3308 return cl_found;
3309}
3310
3311/*
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02003312 * Lookup a class or object method by name. If v_type is VAR_CLASS, then
3313 * lookup a class method and if it is VAR_OBJECT, then lookup a object method.
3314 *
3315 * Returns a pointer to the method structure if variable is found.
3316 * Otherwise returns NULL. The method variable index is set in "*idx".
3317 */
3318 ufunc_T *
3319method_lookup(
3320 class_T *cl,
3321 vartype_T v_type,
3322 char_u *name,
3323 size_t namelen,
3324 int *idx)
3325{
3326 if (v_type == VAR_CLASS)
3327 return class_method_lookup(cl, name, namelen, idx);
3328 else
3329 return object_method_lookup(cl, name, namelen, idx);
3330}
3331
3332/*
Bram Moolenaar62a69232023-01-24 15:07:04 +00003333 * Return TRUE if current context "cctx_arg" is inside class "cl".
3334 * Return FALSE if not.
3335 */
3336 int
3337inside_class(cctx_T *cctx_arg, class_T *cl)
3338{
3339 for (cctx_T *cctx = cctx_arg; cctx != NULL; cctx = cctx->ctx_outer)
Ernie Raelcf138d42023-09-06 20:45:03 +02003340 if (cctx->ctx_ufunc != NULL
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003341 && class_instance_of(cctx->ctx_ufunc->uf_class, cl))
Bram Moolenaar62a69232023-01-24 15:07:04 +00003342 return TRUE;
3343 return FALSE;
3344}
3345
3346/*
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01003347 * Return TRUE if object/class variable "m" is read-only.
3348 * Also give an error message.
3349 */
3350 int
3351oc_var_check_ro(class_T *cl, ocmember_T *m)
3352{
3353 if (m->ocm_flags & (OCMFLAG_FINAL | OCMFLAG_CONST))
3354 {
3355 semsg(_(e_cannot_change_readonly_variable_str_in_class_str),
3356 m->ocm_name, cl->class_name);
3357 return TRUE;
3358 }
3359 return FALSE;
3360}
3361
3362/*
3363 * Lock all the constant object variables. Called after creating and
3364 * initializing a new object.
3365 */
3366 void
3367obj_lock_const_vars(object_T *obj)
3368{
3369 for (int i = 0; i < obj->obj_class->class_obj_member_count; i++)
3370 {
3371 ocmember_T *ocm = &obj->obj_class->class_obj_members[i];
3372 if (ocm->ocm_flags & OCMFLAG_CONST)
3373 {
3374 typval_T *mtv = ((typval_T *)(obj + 1)) + i;
3375 item_lock(mtv, DICT_MAXNEST, TRUE, TRUE);
3376 }
3377 }
3378}
3379
3380/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003381 * Make a copy of an object.
3382 */
3383 void
3384copy_object(typval_T *from, typval_T *to)
3385{
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003386 if (from->vval.v_object == NULL)
3387 to->vval.v_object = NULL;
3388 else
3389 {
3390 to->vval.v_object = from->vval.v_object;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003391 ++to->vval.v_object->obj_refcount;
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003392 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003393}
3394
3395/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003396 * Make a copy of a class.
3397 */
3398 void
3399copy_class(typval_T *from, typval_T *to)
3400{
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003401 if (from->vval.v_class == NULL)
3402 to->vval.v_class = NULL;
3403 else
3404 {
3405 to->vval.v_class = from->vval.v_class;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003406 ++to->vval.v_class->class_refcount;
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003407 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003408}
3409
3410/*
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003411 * Free the class "cl" and its contents.
3412 */
3413 static void
3414class_free(class_T *cl)
3415{
3416 // Freeing what the class contains may recursively come back here.
3417 // Clear "class_name" first, if it is NULL the class does not need to
3418 // be freed.
3419 VIM_CLEAR(cl->class_name);
3420
3421 class_unref(cl->class_extends);
3422
3423 for (int i = 0; i < cl->class_interface_count; ++i)
3424 {
3425 vim_free(((char_u **)cl->class_interfaces)[i]);
3426 if (cl->class_interfaces_cl[i] != NULL)
3427 class_unref(cl->class_interfaces_cl[i]);
3428 }
3429 vim_free(cl->class_interfaces);
3430 vim_free(cl->class_interfaces_cl);
3431
3432 itf2class_T *next;
3433 for (itf2class_T *i2c = cl->class_itf2class; i2c != NULL; i2c = next)
3434 {
3435 next = i2c->i2c_next;
3436 vim_free(i2c);
3437 }
3438
3439 for (int i = 0; i < cl->class_class_member_count; ++i)
3440 {
3441 ocmember_T *m = &cl->class_class_members[i];
3442 vim_free(m->ocm_name);
3443 vim_free(m->ocm_init);
3444 if (cl->class_members_tv != NULL)
3445 clear_tv(&cl->class_members_tv[i]);
3446 }
3447 vim_free(cl->class_class_members);
3448 vim_free(cl->class_members_tv);
3449
3450 for (int i = 0; i < cl->class_obj_member_count; ++i)
3451 {
3452 ocmember_T *m = &cl->class_obj_members[i];
3453 vim_free(m->ocm_name);
3454 vim_free(m->ocm_init);
3455 }
3456 vim_free(cl->class_obj_members);
3457
3458 for (int i = 0; i < cl->class_class_function_count; ++i)
3459 {
3460 ufunc_T *uf = cl->class_class_functions[i];
3461 func_clear_free(uf, FALSE);
3462 }
3463 vim_free(cl->class_class_functions);
3464
3465 for (int i = 0; i < cl->class_obj_method_count; ++i)
3466 {
3467 ufunc_T *uf = cl->class_obj_methods[i];
3468 func_clear_free(uf, FALSE);
3469 }
3470 vim_free(cl->class_obj_methods);
3471
3472 clear_type_list(&cl->class_type_list);
3473
3474 class_cleared(cl);
3475
3476 vim_free(cl);
3477}
3478
3479/*
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003480 * Unreference a class. Free it when the reference count goes down to zero.
3481 */
3482 void
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003483class_unref(class_T *cl)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003484{
Bram Moolenaard505d172022-12-18 21:42:55 +00003485 if (cl != NULL && --cl->class_refcount <= 0 && cl->class_name != NULL)
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003486 class_free(cl);
3487}
3488
3489/*
3490 * Go through the list of all classes and free items without "copyID".
3491 */
3492 int
3493class_free_nonref(int copyID)
3494{
3495 int did_free = FALSE;
3496
3497 for (class_T *cl = first_class; cl != NULL; cl = next_nonref_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003498 {
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003499 next_nonref_class = cl->class_next_used;
3500 if ((cl->class_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00003501 {
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003502 // Free the class and items it contains.
3503 class_free(cl);
3504 did_free = TRUE;
Bram Moolenaara94bd9d2023-01-12 15:01:32 +00003505 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003506 }
Yegappan Lakshmanane651e112023-09-04 07:51:01 +02003507
3508 next_nonref_class = NULL;
3509 return did_free;
3510}
3511
3512 int
3513set_ref_in_classes(int copyID)
3514{
3515 for (class_T *cl = first_class; cl != NULL; cl = cl->class_next_used)
3516 set_ref_in_item_class(cl, copyID, NULL, NULL);
3517
3518 return FALSE;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003519}
3520
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003521static object_T *first_object = NULL;
3522
3523/*
3524 * Call this function when an object has been created. It will be added to the
3525 * list headed by "first_object".
3526 */
3527 void
3528object_created(object_T *obj)
3529{
3530 if (first_object != NULL)
3531 {
3532 obj->obj_next_used = first_object;
3533 first_object->obj_prev_used = obj;
3534 }
3535 first_object = obj;
3536}
3537
3538/*
3539 * Call this function when an object has been cleared and is about to be freed.
3540 * It is removed from the list headed by "first_object".
3541 */
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003542 static void
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003543object_cleared(object_T *obj)
3544{
3545 if (obj->obj_next_used != NULL)
3546 obj->obj_next_used->obj_prev_used = obj->obj_prev_used;
3547 if (obj->obj_prev_used != NULL)
3548 obj->obj_prev_used->obj_next_used = obj->obj_next_used;
3549 else if (first_object == obj)
3550 first_object = obj->obj_next_used;
3551}
3552
3553/*
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003554 * Free the contents of an object ignoring the reference count.
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003555 */
3556 static void
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003557object_free_contents(object_T *obj)
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003558{
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003559 class_T *cl = obj->obj_class;
3560
3561 if (!cl)
3562 return;
3563
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003564 // Avoid a recursive call, it can happen if "obj" has a circular reference.
3565 obj->obj_refcount = INT_MAX;
3566
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003567 // the member values are just after the object structure
3568 typval_T *tv = (typval_T *)(obj + 1);
3569 for (int i = 0; i < cl->class_obj_member_count; ++i)
3570 clear_tv(tv + i);
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003571}
3572
3573 static void
3574object_free_object(object_T *obj)
3575{
3576 class_T *cl = obj->obj_class;
3577
3578 if (!cl)
3579 return;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003580
3581 // Remove from the list headed by "first_object".
3582 object_cleared(obj);
3583
3584 vim_free(obj);
3585 class_unref(cl);
3586}
3587
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003588 static void
3589object_free(object_T *obj)
3590{
3591 if (in_free_unref_items)
3592 return;
3593
3594 object_free_contents(obj);
3595 object_free_object(obj);
3596}
3597
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003598/*
3599 * Unreference an object.
3600 */
3601 void
3602object_unref(object_T *obj)
3603{
3604 if (obj != NULL && --obj->obj_refcount <= 0)
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003605 object_free(obj);
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02003606}
3607
3608/*
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003609 * Go through the list of all objects and free items without "copyID".
3610 */
3611 int
3612object_free_nonref(int copyID)
3613{
3614 int did_free = FALSE;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003615
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003616 for (object_T *obj = first_object; obj != NULL; obj = obj->obj_next_used)
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003617 {
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003618 if ((obj->obj_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
3619 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003620 // Free the object contents. Object itself will be freed later.
3621 object_free_contents(obj);
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003622 did_free = TRUE;
3623 }
3624 }
3625
3626 return did_free;
3627}
3628
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02003629 void
3630object_free_items(int copyID)
3631{
3632 object_T *obj_next;
3633
3634 for (object_T *obj = first_object; obj != NULL; obj = obj_next)
3635 {
3636 obj_next = obj->obj_next_used;
3637 if ((obj->obj_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
3638 object_free_object(obj);
3639 }
3640}
3641
LemonBoyafe04662023-08-23 21:08:11 +02003642/*
Ernie Raele6c9aa52023-10-06 19:55:52 +02003643 * Output message which takes a variable name and the class that defines it.
3644 * "cl" is that class where the name was found. Search "cl"'s hierarchy to
3645 * find the defining class.
3646 */
3647 void
3648emsg_var_cl_define(char *msg, char_u *name, size_t len, class_T *cl)
3649{
3650 ocmember_T *m;
3651 class_T *cl_def = class_defining_member(cl, name, len, &m);
3652 if (cl_def != NULL)
3653 semsg(_(msg), m->ocm_name, cl_def->class_name);
3654 else
3655 emsg(_(e_internal_error_please_report_a_bug));
3656}
3657
3658/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003659 * Echo a class or object method not found message.
3660 */
3661 void
3662method_not_found_msg(class_T *cl, vartype_T v_type, char_u *name, size_t len)
3663{
3664 char_u *method_name = vim_strnsave(name, len);
3665 if ((v_type == VAR_OBJECT)
3666 && (class_method_idx(cl, name, len) >= 0))
3667 {
3668 // If this is a class method, then give a different error
3669 if (*name == '_')
Ernie Rael03042a22023-11-11 08:53:32 +01003670 semsg(_(e_cannot_access_protected_method_str), method_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003671 else
RestorerZ7fe8f432023-09-24 23:21:24 +02003672 semsg(_(e_class_method_str_accessible_only_using_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003673 method_name, cl->class_name);
3674 }
3675 else if ((v_type == VAR_CLASS)
3676 && (object_method_idx(cl, name, len) >= 0))
3677 {
3678 // If this is an object method, then give a different error
3679 if (*name == '_')
Ernie Rael03042a22023-11-11 08:53:32 +01003680 semsg(_(e_cannot_access_protected_method_str), method_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003681 else
RestorerZ7fe8f432023-09-24 23:21:24 +02003682 semsg(_(e_object_method_str_accessible_only_using_object_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003683 method_name, cl->class_name);
3684 }
3685 else
Ernie Raeld4802ec2023-10-20 11:59:00 +02003686 semsg(_(e_method_not_found_on_class_str_str), method_name,
zeertzjqd9be94c2024-07-14 10:20:20 +02003687 cl->class_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003688 vim_free(method_name);
3689}
3690
3691/*
3692 * Echo a class or object member not found message.
3693 */
3694 void
3695member_not_found_msg(class_T *cl, vartype_T v_type, char_u *name, size_t len)
3696{
3697 char_u *varname = len ? vim_strnsave(name, len) : vim_strsave(name);
3698
3699 if (v_type == VAR_OBJECT)
3700 {
3701 if (class_member_idx(cl, name, len) >= 0)
RestorerZ7fe8f432023-09-24 23:21:24 +02003702 semsg(_(e_class_variable_str_accessible_only_using_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003703 varname, cl->class_name);
3704 else
Ernie Raeld4802ec2023-10-20 11:59:00 +02003705 semsg(_(e_variable_not_found_on_object_str_str), varname,
3706 cl->class_name);
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003707 }
3708 else
3709 {
3710 if (object_member_idx(cl, name, len) >= 0)
RestorerZ7fe8f432023-09-24 23:21:24 +02003711 semsg(_(e_object_variable_str_accessible_only_using_object_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003712 varname, cl->class_name);
3713 else
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003714 {
3715 if (IS_ENUM(cl))
3716 semsg(_(e_enum_value_str_not_found_in_enum_str),
3717 varname, cl->class_name);
3718 else
3719 semsg(_(e_class_variable_str_not_found_in_class_str),
3720 varname, cl->class_name);
3721 }
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02003722 }
3723 vim_free(varname);
3724}
3725
3726/*
Yegappan Lakshmanan4f32c832024-01-12 17:36:40 +01003727 * Compile all the class and object methods in "cl".
3728 */
3729 void
3730defcompile_class(class_T *cl)
3731{
3732 for (int loop = 1; loop <= 2; ++loop)
3733 {
3734 int func_count = loop == 1 ? cl->class_class_function_count
3735 : cl->class_obj_method_count;
3736 for (int i = 0; i < func_count; i++)
3737 {
3738 ufunc_T *ufunc = loop == 1 ? cl->class_class_functions[i]
3739 : cl->class_obj_methods[i];
Yegappan Lakshmanan1af0fbf2024-04-09 21:39:27 +02003740 // Don't compile abstract methods
3741 if (!IS_ABSTRACT_METHOD(ufunc))
3742 defcompile_function(ufunc, cl);
Yegappan Lakshmanan4f32c832024-01-12 17:36:40 +01003743 }
3744 }
3745}
3746
3747/*
3748 * Compile all the classes defined in the current script
3749 */
3750 void
3751defcompile_classes_in_script(void)
3752{
3753 for (class_T *cl = first_class; cl != NULL; cl = cl->class_next_used)
3754 {
3755 if (eval_variable(cl->class_name, 0, 0, NULL, NULL,
3756 EVAL_VAR_NOAUTOLOAD | EVAL_VAR_NO_FUNC) != FAIL)
3757 defcompile_class(cl);
3758 }
3759}
3760
3761/*
3762 * Returns TRUE if "name" is the name of a class. The typval for the class is
3763 * returned in "rettv".
3764 */
3765 int
3766is_class_name(char_u *name, typval_T *rettv)
3767{
3768 rettv->v_type = VAR_UNKNOWN;
3769
3770 if (eval_variable(name, 0, 0, rettv, NULL, EVAL_VAR_NOAUTOLOAD |
3771 EVAL_VAR_NO_FUNC) != FAIL)
3772 return rettv->v_type == VAR_CLASS;
3773 return FALSE;
3774}
3775
3776/*
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003777 * Calls the object builtin method "name" with arguments "argv". The value
3778 * returned by the builtin method is in "rettv". Returns OK or FAIL.
3779 */
3780 static int
3781object_call_builtin_method(
3782 object_T *obj,
3783 class_builtin_T builtin_method,
3784 int argc,
3785 typval_T *argv,
3786 typval_T *rettv)
3787{
3788 ufunc_T *uf;
3789 int midx;
3790
3791 if (obj == NULL)
3792 return FAIL;
3793
3794 uf = class_get_builtin_method(obj->obj_class, builtin_method, &midx);
3795 if (uf == NULL)
3796 return FAIL;
3797
3798 funccall_T *fc = create_funccal(uf, rettv);
3799 int r;
3800
3801 if (fc == NULL)
3802 return FAIL;
3803
3804 ++obj->obj_refcount;
3805
3806 r = call_def_function(uf, argc, argv, 0, NULL, obj, fc, rettv);
3807
3808 remove_funccal();
3809
3810 return r;
3811}
3812
3813/*
zeertzjqc029c132024-03-28 11:37:26 +01003814 * Calls the object "empty()" method and returns the method return value. In
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003815 * case of an error, returns TRUE.
3816 */
3817 int
3818object_empty(object_T *obj)
3819{
3820 typval_T rettv;
3821
3822 if (object_call_builtin_method(obj, CLASS_BUILTIN_EMPTY, 0, NULL, &rettv)
3823 == FAIL)
3824 return TRUE;
3825
3826 return tv_get_bool(&rettv);
3827}
3828
3829/*
3830 * Use the object "len()" method to get an object length. Returns 0 if the
3831 * method is not found or there is an error.
3832 */
3833 int
3834object_len(object_T *obj)
3835{
3836 typval_T rettv;
3837
3838 if (object_call_builtin_method(obj, CLASS_BUILTIN_LEN, 0, NULL, &rettv)
3839 == FAIL)
3840 return 0;
3841
3842 return tv_to_number(&rettv);
3843}
3844
3845/*
LemonBoy7b29cc92024-06-22 17:25:07 +02003846 * Return TRUE when two objects have exactly the same values.
3847 */
3848 int
3849object_equal(
3850 object_T *o1,
3851 object_T *o2,
Yinzuo Jiang7ccd1a22024-07-04 17:20:53 +02003852 int ic) // ignore case for strings
LemonBoy7b29cc92024-06-22 17:25:07 +02003853{
3854 class_T *cl1, *cl2;
3855
3856 if (o1 == o2)
3857 return TRUE;
Ernie Rael86257142024-06-23 09:54:45 +02003858 if (o1 == NULL || o2 == NULL)
3859 return FALSE;
LemonBoy7b29cc92024-06-22 17:25:07 +02003860
3861 cl1 = o1->obj_class;
3862 cl2 = o2->obj_class;
3863
3864 if (cl1 != cl2 || cl1 == NULL || cl2 == NULL)
3865 return FALSE;
3866
3867 for (int i = 0; i < cl1->class_obj_member_count; ++i)
Yinzuo Jiang7ccd1a22024-07-04 17:20:53 +02003868 if (!tv_equal((typval_T *)(o1 + 1) + i, (typval_T *)(o2 + 1) + i, ic))
LemonBoy7b29cc92024-06-22 17:25:07 +02003869 return FALSE;
3870
3871 return TRUE;
3872}
3873
3874/*
Ernie Rael05ff4e42024-07-04 16:50:11 +02003875 * Return a textual representation of object "obj".
3876 * "obj" must not be NULL.
3877 * May return NULL.
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003878 */
3879 char_u *
Yegappan Lakshmanan22029ed2024-05-20 13:57:11 +02003880object2string(
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003881 object_T *obj,
3882 char_u *numbuf,
3883 int copyID,
3884 int echo_style,
3885 int restore_copyID,
3886 int composite_val)
3887{
3888 typval_T rettv;
3889
3890 if (object_call_builtin_method(obj, CLASS_BUILTIN_STRING, 0, NULL, &rettv)
3891 == OK
3892 && rettv.vval.v_string != NULL)
3893 return rettv.vval.v_string;
Ernie Rael05ff4e42024-07-04 16:50:11 +02003894
3895 int ok = OK;
3896 class_T *cl = obj->obj_class;
3897 garray_T ga;
3898 ga_init2(&ga, 1, 50);
3899
3900 if (cl != NULL && IS_ENUM(cl))
3901 {
3902 ga_concat(&ga, (char_u *)"enum ");
3903 ga_concat(&ga, cl->class_name);
3904 char_u *enum_name = ((typval_T *)(obj + 1))->vval.v_string;
3905 ga_concat(&ga, (char_u *)".");
3906 ga_concat(&ga, enum_name);
3907 }
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003908 else
3909 {
Ernie Rael05ff4e42024-07-04 16:50:11 +02003910 ga_concat(&ga, (char_u *)"object of ");
3911 ga_concat(&ga, cl == NULL ? (char_u *)"[unknown]"
3912 : cl->class_name);
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003913 }
Ernie Rael05ff4e42024-07-04 16:50:11 +02003914 if (cl != NULL)
3915 {
3916 ga_concat(&ga, (char_u *)" {");
3917 for (int i = 0; i < cl->class_obj_member_count; ++i)
3918 {
3919 if (i > 0)
3920 ga_concat(&ga, (char_u *)", ");
3921 ocmember_T *m = &cl->class_obj_members[i];
3922 ga_concat(&ga, m->ocm_name);
3923 ga_concat(&ga, (char_u *)": ");
3924 char_u *tf = NULL;
3925 char_u *s = echo_string_core((typval_T *)(obj + 1) + i,
3926 &tf, numbuf, copyID, echo_style,
3927 restore_copyID, composite_val);
3928 if (s != NULL)
3929 ga_concat(&ga, s);
3930 vim_free(tf);
3931 if (s == NULL || did_echo_string_emsg)
3932 {
3933 ok = FAIL;
3934 break;
3935 }
3936 line_breakcheck();
3937 }
3938 ga_concat(&ga, (char_u *)"}");
3939 }
3940 if (ok == FAIL)
3941 {
3942 vim_free(ga.ga_data);
3943 return NULL;
3944 }
3945 return (char_u *)ga.ga_data;
Yegappan Lakshmanand3eae7b2024-03-03 16:26:58 +01003946}
3947
3948/*
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +02003949 * Return TRUE when the class "cl", its base class or one of the implemented
3950 * interfaces matches the class "other_cl".
LemonBoyafe04662023-08-23 21:08:11 +02003951 */
3952 int
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003953class_instance_of(class_T *cl, class_T *other_cl)
LemonBoyafe04662023-08-23 21:08:11 +02003954{
3955 if (cl == other_cl)
3956 return TRUE;
3957
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003958 // Recursively check the base classes.
3959 for (; cl != NULL; cl = cl->class_extends)
LemonBoyafe04662023-08-23 21:08:11 +02003960 {
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003961 if (cl == other_cl)
3962 return TRUE;
3963 // Check the implemented interfaces and the super interfaces
3964 for (int i = cl->class_interface_count - 1; i >= 0; --i)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02003965 {
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003966 class_T *intf = cl->class_interfaces_cl[i];
3967 while (intf != NULL)
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02003968 {
Yegappan Lakshmananb32064f2023-10-02 21:43:58 +02003969 if (intf == other_cl)
3970 return TRUE;
3971 // check the super interfaces
3972 intf = intf->class_extends;
Yegappan Lakshmanan92d9ee52023-09-17 17:03:19 +02003973 }
3974 }
LemonBoyafe04662023-08-23 21:08:11 +02003975 }
3976
3977 return FALSE;
3978}
3979
3980/*
Ernie Rael2025af12023-12-12 16:58:00 +01003981 * "instanceof(object, classinfo, ...)" function
LemonBoyafe04662023-08-23 21:08:11 +02003982 */
3983 void
3984f_instanceof(typval_T *argvars, typval_T *rettv)
3985{
3986 typval_T *object_tv = &argvars[0];
3987 typval_T *classinfo_tv = &argvars[1];
Yegappan Lakshmananfeaccd22023-10-28 15:53:55 +02003988 class_T *c;
LemonBoyafe04662023-08-23 21:08:11 +02003989
3990 rettv->vval.v_number = VVAL_FALSE;
3991
3992 if (check_for_object_arg(argvars, 0) == FAIL
Ernie Rael2025af12023-12-12 16:58:00 +01003993 || check_for_class_or_typealias_args(argvars, 1) == FAIL)
LemonBoyafe04662023-08-23 21:08:11 +02003994 return;
3995
Ernie Rael3da696d2023-09-19 20:14:18 +02003996 if (object_tv->vval.v_object == NULL)
3997 return;
3998
Ernie Rael2025af12023-12-12 16:58:00 +01003999 for (; classinfo_tv->v_type != VAR_UNKNOWN; ++classinfo_tv)
LemonBoyafe04662023-08-23 21:08:11 +02004000 {
Ernie Rael2025af12023-12-12 16:58:00 +01004001 if (classinfo_tv->v_type == VAR_TYPEALIAS)
4002 c = classinfo_tv->vval.v_typealias->ta_type->tt_class;
4003 else
4004 c = classinfo_tv->vval.v_class;
4005
4006 if (class_instance_of(object_tv->vval.v_object->obj_class, c))
LemonBoyafe04662023-08-23 21:08:11 +02004007 {
Ernie Rael2025af12023-12-12 16:58:00 +01004008 rettv->vval.v_number = VVAL_TRUE;
4009 return;
LemonBoyafe04662023-08-23 21:08:11 +02004010 }
4011 }
LemonBoyafe04662023-08-23 21:08:11 +02004012}
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00004013
4014#endif // FEAT_EVAL