blob: 0aeea4bce9f14f7172d8ea29092f00d83e494c15 [file] [log] [blame]
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001/* 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 * strings.c: string manipulation functions
12 */
13
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +020014#define USING_FLOAT_STUFF
Yegappan Lakshmanana2438132021-07-10 21:29:18 +020015#include "vim.h"
16
17/*
18 * Copy "string" into newly allocated memory.
19 */
20 char_u *
21vim_strsave(char_u *string)
22{
23 char_u *p;
24 size_t len;
25
26 len = STRLEN(string) + 1;
27 p = alloc(len);
28 if (p != NULL)
29 mch_memmove(p, string, len);
30 return p;
31}
32
33/*
34 * Copy up to "len" bytes of "string" into newly allocated memory and
35 * terminate with a NUL.
36 * The allocated memory always has size "len + 1", also when "string" is
37 * shorter.
38 */
39 char_u *
40vim_strnsave(char_u *string, size_t len)
41{
42 char_u *p;
43
44 p = alloc(len + 1);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +000045 if (p == NULL)
46 return NULL;
47
48 STRNCPY(p, string, len);
49 p[len] = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +020050 return p;
51}
52
53/*
54 * Same as vim_strsave(), but any characters found in esc_chars are preceded
55 * by a backslash.
56 */
57 char_u *
58vim_strsave_escaped(char_u *string, char_u *esc_chars)
59{
60 return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE);
61}
62
63/*
64 * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
65 * characters where rem_backslash() would remove the backslash.
66 * Escape the characters with "cc".
67 */
68 char_u *
69vim_strsave_escaped_ext(
70 char_u *string,
71 char_u *esc_chars,
72 int cc,
73 int bsl)
74{
75 char_u *p;
76 char_u *p2;
77 char_u *escaped_string;
78 unsigned length;
79 int l;
80
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +020081 // First count the number of backslashes required.
82 // Then allocate the memory and insert them.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +020083 length = 1; // count the trailing NUL
84 for (p = string; *p; p++)
85 {
86 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
87 {
88 length += l; // count a multibyte char
89 p += l - 1;
90 continue;
91 }
92 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
93 ++length; // count a backslash
94 ++length; // count an ordinary char
95 }
96 escaped_string = alloc(length);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +000097 if (escaped_string == NULL)
98 return NULL;
99 p2 = escaped_string;
100 for (p = string; *p; p++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200101 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000102 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200103 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000104 mch_memmove(p2, p, (size_t)l);
105 p2 += l;
106 p += l - 1; // skip multibyte char
107 continue;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200108 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000109 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
110 *p2++ = cc;
111 *p2++ = *p;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200112 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000113 *p2 = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200114 return escaped_string;
115}
116
117/*
118 * Return TRUE when 'shell' has "csh" in the tail.
119 */
120 int
121csh_like_shell(void)
122{
123 return (strstr((char *)gettail(p_sh), "csh") != NULL);
124}
125
126/*
Jason Cox6e823512021-08-29 12:36:49 +0200127 * Return TRUE when 'shell' has "fish" in the tail.
128 */
Dominique Pellede05ae72021-08-30 19:57:34 +0200129 static int
Jason Cox6e823512021-08-29 12:36:49 +0200130fish_like_shell(void)
131{
132 return (strstr((char *)gettail(p_sh), "fish") != NULL);
133}
134
135/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200136 * Escape "string" for use as a shell argument with system().
137 * This uses single quotes, except when we know we need to use double quotes
138 * (MS-DOS and MS-Windows not using PowerShell and without 'shellslash' set).
139 * PowerShell also uses a novel escaping for enclosed single quotes - double
140 * them up.
141 * Escape a newline, depending on the 'shell' option.
142 * When "do_special" is TRUE also replace "!", "%", "#" and things starting
143 * with "<" like "<cfile>".
144 * When "do_newline" is FALSE do not escape newline unless it is csh shell.
145 * Returns the result in allocated memory, NULL if we have run out.
146 */
147 char_u *
148vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
149{
150 unsigned length;
151 char_u *p;
152 char_u *d;
153 char_u *escaped_string;
154 int l;
155 int csh_like;
Jason Cox6e823512021-08-29 12:36:49 +0200156 int fish_like;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200157 char_u *shname;
158 int powershell;
159# ifdef MSWIN
160 int double_quotes;
161# endif
162
163 // Only csh and similar shells expand '!' within single quotes. For sh and
164 // the like we must not put a backslash before it, it will be taken
165 // literally. If do_special is set the '!' will be escaped twice.
166 // Csh also needs to have "\n" escaped twice when do_special is set.
167 csh_like = csh_like_shell();
168
Jason Cox6e823512021-08-29 12:36:49 +0200169 // Fish shell uses '\' as an escape character within single quotes, so '\'
170 // itself must be escaped to get a literal '\'.
171 fish_like = fish_like_shell();
172
Dominique Pelleaf4a61a2021-12-27 17:21:41 +0000173 // PowerShell uses its own version for quoting single quotes
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200174 shname = gettail(p_sh);
175 powershell = strstr((char *)shname, "pwsh") != NULL;
176# ifdef MSWIN
177 powershell = powershell || strstr((char *)shname, "powershell") != NULL;
178 // PowerShell only accepts single quotes so override shellslash.
179 double_quotes = !powershell && !p_ssl;
180# endif
181
182 // First count the number of extra bytes required.
183 length = (unsigned)STRLEN(string) + 3; // two quotes and a trailing NUL
184 for (p = string; *p != NUL; MB_PTR_ADV(p))
185 {
186# ifdef MSWIN
187 if (double_quotes)
188 {
189 if (*p == '"')
190 ++length; // " -> ""
191 }
192 else
193# endif
194 if (*p == '\'')
195 {
196 if (powershell)
197 length +=2; // ' => ''
198 else
199 length += 3; // ' => '\''
200 }
201 if ((*p == '\n' && (csh_like || do_newline))
202 || (*p == '!' && (csh_like || do_special)))
203 {
204 ++length; // insert backslash
205 if (csh_like && do_special)
206 ++length; // insert backslash
207 }
208 if (do_special && find_cmdline_var(p, &l) >= 0)
209 {
210 ++length; // insert backslash
211 p += l - 1;
212 }
Jason Cox6e823512021-08-29 12:36:49 +0200213 if (*p == '\\' && fish_like)
214 ++length; // insert backslash
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200215 }
216
217 // Allocate memory for the result and fill it.
218 escaped_string = alloc(length);
219 if (escaped_string != NULL)
220 {
221 d = escaped_string;
222
223 // add opening quote
224# ifdef MSWIN
225 if (double_quotes)
226 *d++ = '"';
227 else
228# endif
229 *d++ = '\'';
230
231 for (p = string; *p != NUL; )
232 {
233# ifdef MSWIN
234 if (double_quotes)
235 {
236 if (*p == '"')
237 {
238 *d++ = '"';
239 *d++ = '"';
240 ++p;
241 continue;
242 }
243 }
244 else
245# endif
246 if (*p == '\'')
247 {
248 if (powershell)
249 {
250 *d++ = '\'';
251 *d++ = '\'';
252 }
253 else
254 {
255 *d++ = '\'';
256 *d++ = '\\';
257 *d++ = '\'';
258 *d++ = '\'';
259 }
260 ++p;
261 continue;
262 }
263 if ((*p == '\n' && (csh_like || do_newline))
264 || (*p == '!' && (csh_like || do_special)))
265 {
266 *d++ = '\\';
267 if (csh_like && do_special)
268 *d++ = '\\';
269 *d++ = *p++;
270 continue;
271 }
272 if (do_special && find_cmdline_var(p, &l) >= 0)
273 {
274 *d++ = '\\'; // insert backslash
275 while (--l >= 0) // copy the var
276 *d++ = *p++;
277 continue;
278 }
Jason Cox6e823512021-08-29 12:36:49 +0200279 if (*p == '\\' && fish_like)
280 {
281 *d++ = '\\';
282 *d++ = *p++;
Bram Moolenaar66315972021-09-01 14:31:51 +0200283 continue;
Jason Cox6e823512021-08-29 12:36:49 +0200284 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200285
286 MB_COPY_CHAR(p, d);
287 }
288
289 // add terminating quote and finish with a NUL
290# ifdef MSWIN
291 if (double_quotes)
292 *d++ = '"';
293 else
294# endif
295 *d++ = '\'';
296 *d = NUL;
297 }
298
299 return escaped_string;
300}
301
302/*
303 * Like vim_strsave(), but make all characters uppercase.
304 * This uses ASCII lower-to-upper case translation, language independent.
305 */
306 char_u *
307vim_strsave_up(char_u *string)
308{
309 char_u *p1;
310
311 p1 = vim_strsave(string);
312 vim_strup(p1);
313 return p1;
314}
315
316/*
317 * Like vim_strnsave(), but make all characters uppercase.
318 * This uses ASCII lower-to-upper case translation, language independent.
319 */
320 char_u *
321vim_strnsave_up(char_u *string, size_t len)
322{
323 char_u *p1;
324
325 p1 = vim_strnsave(string, len);
326 vim_strup(p1);
327 return p1;
328}
329
330/*
331 * ASCII lower-to-upper case translation, language independent.
332 */
333 void
334vim_strup(
335 char_u *p)
336{
337 char_u *p2;
338 int c;
339
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000340 if (p == NULL)
341 return;
342
343 p2 = p;
344 while ((c = *p2) != NUL)
345 *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200346}
347
348#if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
349/*
350 * Make string "s" all upper-case and return it in allocated memory.
351 * Handles multi-byte characters as well as possible.
352 * Returns NULL when out of memory.
353 */
354 static char_u *
355strup_save(char_u *orig)
356{
357 char_u *p;
358 char_u *res;
359
360 res = p = vim_strsave(orig);
361
362 if (res != NULL)
363 while (*p != NUL)
364 {
365 int l;
366
367 if (enc_utf8)
368 {
369 int c, uc;
370 int newl;
371 char_u *s;
372
373 c = utf_ptr2char(p);
374 l = utf_ptr2len(p);
375 if (c == 0)
376 {
377 // overlong sequence, use only the first byte
378 c = *p;
379 l = 1;
380 }
381 uc = utf_toupper(c);
382
383 // Reallocate string when byte count changes. This is rare,
384 // thus it's OK to do another malloc()/free().
385 newl = utf_char2len(uc);
386 if (newl != l)
387 {
388 s = alloc(STRLEN(res) + 1 + newl - l);
389 if (s == NULL)
390 {
391 vim_free(res);
392 return NULL;
393 }
394 mch_memmove(s, res, p - res);
395 STRCPY(s + (p - res) + newl, p + l);
396 p = s + (p - res);
397 vim_free(res);
398 res = s;
399 }
400
401 utf_char2bytes(uc, p);
402 p += newl;
403 }
404 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
405 p += l; // skip multi-byte character
406 else
407 {
408 *p = TOUPPER_LOC(*p); // note that toupper() can be a macro
409 p++;
410 }
411 }
412
413 return res;
414}
415
416/*
417 * Make string "s" all lower-case and return it in allocated memory.
418 * Handles multi-byte characters as well as possible.
419 * Returns NULL when out of memory.
420 */
421 char_u *
422strlow_save(char_u *orig)
423{
424 char_u *p;
425 char_u *res;
426
427 res = p = vim_strsave(orig);
428
429 if (res != NULL)
430 while (*p != NUL)
431 {
432 int l;
433
434 if (enc_utf8)
435 {
436 int c, lc;
437 int newl;
438 char_u *s;
439
440 c = utf_ptr2char(p);
441 l = utf_ptr2len(p);
442 if (c == 0)
443 {
444 // overlong sequence, use only the first byte
445 c = *p;
446 l = 1;
447 }
448 lc = utf_tolower(c);
449
450 // Reallocate string when byte count changes. This is rare,
451 // thus it's OK to do another malloc()/free().
452 newl = utf_char2len(lc);
453 if (newl != l)
454 {
455 s = alloc(STRLEN(res) + 1 + newl - l);
456 if (s == NULL)
457 {
458 vim_free(res);
459 return NULL;
460 }
461 mch_memmove(s, res, p - res);
462 STRCPY(s + (p - res) + newl, p + l);
463 p = s + (p - res);
464 vim_free(res);
465 res = s;
466 }
467
468 utf_char2bytes(lc, p);
469 p += newl;
470 }
471 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
472 p += l; // skip multi-byte character
473 else
474 {
475 *p = TOLOWER_LOC(*p); // note that tolower() can be a macro
476 p++;
477 }
478 }
479
480 return res;
481}
482#endif
483
484/*
485 * delete spaces at the end of a string
486 */
487 void
488del_trailing_spaces(char_u *ptr)
489{
490 char_u *q;
491
492 q = ptr + STRLEN(ptr);
493 while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
494 *q = NUL;
495}
496
497/*
498 * Like strncpy(), but always terminate the result with one NUL.
499 * "to" must be "len + 1" long!
500 */
501 void
502vim_strncpy(char_u *to, char_u *from, size_t len)
503{
504 STRNCPY(to, from, len);
505 to[len] = NUL;
506}
507
508/*
509 * Like strcat(), but make sure the result fits in "tosize" bytes and is
510 * always NUL terminated. "from" and "to" may overlap.
511 */
512 void
513vim_strcat(char_u *to, char_u *from, size_t tosize)
514{
515 size_t tolen = STRLEN(to);
516 size_t fromlen = STRLEN(from);
517
518 if (tolen + fromlen + 1 > tosize)
519 {
520 mch_memmove(to + tolen, from, tosize - tolen - 1);
521 to[tosize - 1] = NUL;
522 }
523 else
524 mch_memmove(to + tolen, from, fromlen + 1);
525}
526
Bram Moolenaarc32949b2023-01-04 15:56:51 +0000527/*
528 * A version of strlen() that has a maximum length.
529 */
530 size_t
531vim_strlen_maxlen(char *s, size_t maxlen)
532{
533 size_t i;
534 for (i = 0; i < maxlen; ++i)
535 if (s[i] == NUL)
536 break;
537 return i;
538}
539
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200540#if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
541/*
542 * Compare two strings, ignoring case, using current locale.
543 * Doesn't work for multi-byte characters.
544 * return 0 for match, < 0 for smaller, > 0 for bigger
545 */
546 int
547vim_stricmp(char *s1, char *s2)
548{
549 int i;
550
551 for (;;)
552 {
553 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
554 if (i != 0)
555 return i; // this character different
556 if (*s1 == NUL)
557 break; // strings match until NUL
558 ++s1;
559 ++s2;
560 }
561 return 0; // strings match
562}
563#endif
564
565#if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
566/*
567 * Compare two strings, for length "len", ignoring case, using current locale.
568 * Doesn't work for multi-byte characters.
569 * return 0 for match, < 0 for smaller, > 0 for bigger
570 */
571 int
572vim_strnicmp(char *s1, char *s2, size_t len)
573{
574 int i;
575
576 while (len > 0)
577 {
578 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
579 if (i != 0)
580 return i; // this character different
581 if (*s1 == NUL)
582 break; // strings match until NUL
583 ++s1;
584 ++s2;
585 --len;
586 }
587 return 0; // strings match
588}
589#endif
590
591/*
592 * Search for first occurrence of "c" in "string".
593 * Version of strchr() that handles unsigned char strings with characters from
594 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
595 * end of the string.
596 */
Bram Moolenaarc32949b2023-01-04 15:56:51 +0000597 char_u *
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200598vim_strchr(char_u *string, int c)
599{
600 char_u *p;
601 int b;
602
603 p = string;
604 if (enc_utf8 && c >= 0x80)
605 {
606 while (*p != NUL)
607 {
608 int l = utfc_ptr2len(p);
609
610 // Avoid matching an illegal byte here.
611 if (utf_ptr2char(p) == c && l > 1)
612 return p;
613 p += l;
614 }
615 return NULL;
616 }
617 if (enc_dbcs != 0 && c > 255)
618 {
619 int n2 = c & 0xff;
620
621 c = ((unsigned)c >> 8) & 0xff;
622 while ((b = *p) != NUL)
623 {
624 if (b == c && p[1] == n2)
625 return p;
626 p += (*mb_ptr2len)(p);
627 }
628 return NULL;
629 }
630 if (has_mbyte)
631 {
632 while ((b = *p) != NUL)
633 {
634 if (b == c)
635 return p;
636 p += (*mb_ptr2len)(p);
637 }
638 return NULL;
639 }
640 while ((b = *p) != NUL)
641 {
642 if (b == c)
643 return p;
644 ++p;
645 }
646 return NULL;
647}
648
649/*
650 * Version of strchr() that only works for bytes and handles unsigned char
651 * strings with characters above 128 correctly. It also doesn't return a
652 * pointer to the NUL at the end of the string.
653 */
654 char_u *
655vim_strbyte(char_u *string, int c)
656{
657 char_u *p = string;
658
659 while (*p != NUL)
660 {
661 if (*p == c)
662 return p;
663 ++p;
664 }
665 return NULL;
666}
667
668/*
669 * Search for last occurrence of "c" in "string".
670 * Version of strrchr() that handles unsigned char strings with characters from
671 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
672 * end of the string.
673 * Return NULL if not found.
674 * Does not handle multi-byte char for "c"!
675 */
676 char_u *
677vim_strrchr(char_u *string, int c)
678{
679 char_u *retval = NULL;
680 char_u *p = string;
681
682 while (*p)
683 {
684 if (*p == c)
685 retval = p;
686 MB_PTR_ADV(p);
687 }
688 return retval;
689}
690
691/*
692 * Vim's version of strpbrk(), in case it's missing.
693 * Don't generate a prototype for this, causes problems when it's not used.
694 */
695#ifndef PROTO
696# ifndef HAVE_STRPBRK
697# ifdef vim_strpbrk
698# undef vim_strpbrk
699# endif
700 char_u *
701vim_strpbrk(char_u *s, char_u *charset)
702{
703 while (*s)
704 {
705 if (vim_strchr(charset, *s) != NULL)
706 return s;
707 MB_PTR_ADV(s);
708 }
709 return NULL;
710}
711# endif
712#endif
713
714/*
715 * Sort an array of strings.
716 */
717static int sort_compare(const void *s1, const void *s2);
718
719 static int
720sort_compare(const void *s1, const void *s2)
721{
722 return STRCMP(*(char **)s1, *(char **)s2);
723}
724
725 void
726sort_strings(
727 char_u **files,
728 int count)
729{
730 qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
731}
732
733#if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
734/*
735 * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
736 * When "s" is NULL FALSE is returned.
737 */
738 int
739has_non_ascii(char_u *s)
740{
741 char_u *p;
742
743 if (s != NULL)
744 for (p = s; *p != NUL; ++p)
745 if (*p >= 128)
746 return TRUE;
747 return FALSE;
748}
749#endif
750
751/*
752 * Concatenate two strings and return the result in allocated memory.
753 * Returns NULL when out of memory.
754 */
755 char_u *
756concat_str(char_u *str1, char_u *str2)
757{
758 char_u *dest;
759 size_t l = str1 == NULL ? 0 : STRLEN(str1);
760
761 dest = alloc(l + (str2 == NULL ? 0 : STRLEN(str2)) + 1L);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000762 if (dest == NULL)
763 return NULL;
764 if (str1 == NULL)
765 *dest = NUL;
766 else
767 STRCPY(dest, str1);
768 if (str2 != NULL)
769 STRCPY(dest + l, str2);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200770 return dest;
771}
772
zeertzjq4dd266c2023-08-19 11:35:03 +0200773#if defined(FEAT_EVAL) || defined(FEAT_RIGHTLEFT) || defined(PROTO)
774/*
775 * Reverse text into allocated memory.
776 * Returns the allocated string, NULL when out of memory.
777 */
778 char_u *
779reverse_text(char_u *s)
780{
781 size_t len = STRLEN(s);
782 char_u *rev = alloc(len + 1);
783 if (rev == NULL)
784 return NULL;
785
786 for (size_t s_i = 0, rev_i = len; s_i < len; ++s_i)
787 {
788 if (has_mbyte)
789 {
790 int mb_len = (*mb_ptr2len)(s + s_i);
791 rev_i -= mb_len;
792 mch_memmove(rev + rev_i, s + s_i, mb_len);
793 s_i += mb_len - 1;
794 }
795 else
796 rev[--rev_i] = s[s_i];
797 }
798 rev[len] = NUL;
799 return rev;
800}
801#endif
802
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200803#if defined(FEAT_EVAL) || defined(PROTO)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200804/*
805 * Return string "str" in ' quotes, doubling ' characters.
806 * If "str" is NULL an empty string is assumed.
807 * If "function" is TRUE make it function('string').
808 */
809 char_u *
810string_quote(char_u *str, int function)
811{
812 unsigned len;
813 char_u *p, *r, *s;
814
815 len = (function ? 13 : 3);
816 if (str != NULL)
817 {
818 len += (unsigned)STRLEN(str);
819 for (p = str; *p != NUL; MB_PTR_ADV(p))
820 if (*p == '\'')
821 ++len;
822 }
823 s = r = alloc(len);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000824 if (r == NULL)
825 return NULL;
826
827 if (function)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200828 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000829 STRCPY(r, "function('");
830 r += 10;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200831 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000832 else
833 *r++ = '\'';
834 if (str != NULL)
835 for (p = str; *p != NUL; )
836 {
837 if (*p == '\'')
838 *r++ = '\'';
839 MB_COPY_CHAR(p, r);
840 }
841 *r++ = '\'';
842 if (function)
843 *r++ = ')';
844 *r++ = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200845 return s;
846}
847
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000848/*
849 * Count the number of times "needle" occurs in string "haystack". Case is
850 * ignored if "ic" is TRUE.
851 */
852 long
853string_count(char_u *haystack, char_u *needle, int ic)
854{
855 long n = 0;
856 char_u *p = haystack;
857 char_u *next;
858
859 if (p == NULL || needle == NULL || *needle == NUL)
860 return 0;
861
862 if (ic)
863 {
864 size_t len = STRLEN(needle);
865
866 while (*p != NUL)
867 {
868 if (MB_STRNICMP(p, needle, len) == 0)
869 {
870 ++n;
871 p += len;
872 }
873 else
874 MB_PTR_ADV(p);
875 }
876 }
877 else
878 while ((next = (char_u *)strstr((char *)p, (char *)needle)) != NULL)
879 {
880 ++n;
881 p = next + STRLEN(needle);
882 }
883
884 return n;
885}
886
887/*
888 * Make a typval_T of the first character of "input" and store it in "output".
889 * Return OK or FAIL.
890 */
891 static int
892copy_first_char_to_tv(char_u *input, typval_T *output)
893{
894 char_u buf[MB_MAXBYTES + 1];
895 int len;
896
897 if (input == NULL || output == NULL)
898 return FAIL;
899
900 len = has_mbyte ? mb_ptr2len(input) : 1;
901 STRNCPY(buf, input, len);
902 buf[len] = NUL;
903 output->v_type = VAR_STRING;
904 output->vval.v_string = vim_strsave(buf);
905
906 return output->vval.v_string == NULL ? FAIL : OK;
907}
908
909/*
910 * Implementation of map() and filter() for a String. Apply "expr" to every
911 * character in string "str" and return the result in "rettv".
912 */
913 void
914string_filter_map(
915 char_u *str,
916 filtermap_T filtermap,
917 typval_T *expr,
918 typval_T *rettv)
919{
920 char_u *p;
921 typval_T tv;
922 garray_T ga;
923 int len = 0;
924 int idx = 0;
925 int rem;
Bram Moolenaar82418262022-09-28 16:16:15 +0100926 typval_T newtv;
927 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000928
929 rettv->v_type = VAR_STRING;
930 rettv->vval.v_string = NULL;
931
932 // set_vim_var_nr() doesn't set the type
933 set_vim_var_type(VV_KEY, VAR_NUMBER);
934
zeertzjqe7d49462023-04-16 20:53:55 +0100935 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +0100936 fc = eval_expr_get_funccal(expr, &newtv);
937
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000938 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000939 for (p = str; *p != NUL; p += len)
940 {
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000941 if (copy_first_char_to_tv(p, &tv) == FAIL)
942 break;
943 len = (int)STRLEN(tv.vval.v_string);
944
Bram Moolenaardd7eff02022-05-06 11:02:05 +0100945 newtv.v_type = VAR_UNKNOWN;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000946 set_vim_var_nr(VV_KEY, idx);
Bram Moolenaar82418262022-09-28 16:16:15 +0100947 if (filter_map_one(&tv, expr, filtermap, fc, &newtv, &rem) == FAIL
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000948 || did_emsg)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000949 {
950 clear_tv(&newtv);
951 clear_tv(&tv);
952 break;
953 }
954 else if (filtermap != FILTERMAP_FILTER)
955 {
956 if (newtv.v_type != VAR_STRING)
957 {
958 clear_tv(&newtv);
959 clear_tv(&tv);
Bram Moolenaare70cec92022-01-01 14:25:55 +0000960 emsg(_(e_string_required));
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000961 break;
962 }
963 else
964 ga_concat(&ga, newtv.vval.v_string);
965 }
966 else if (!rem)
967 ga_concat(&ga, tv.vval.v_string);
968
969 clear_tv(&newtv);
970 clear_tv(&tv);
971
972 ++idx;
973 }
974 ga_append(&ga, NUL);
975 rettv->vval.v_string = ga.ga_data;
Bram Moolenaar82418262022-09-28 16:16:15 +0100976 if (fc != NULL)
977 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000978}
979
980/*
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100981 * Implementation of reduce() for String "argvars[0]" using the function "expr"
982 * starting with the optional initial value "argvars[2]" and return the result
983 * in "rettv".
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000984 */
985 void
986string_reduce(
987 typval_T *argvars,
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100988 typval_T *expr,
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000989 typval_T *rettv)
990{
991 char_u *p = tv_get_string(&argvars[0]);
992 int len;
993 typval_T argv[3];
994 int r;
995 int called_emsg_start = called_emsg;
Bram Moolenaar82418262022-09-28 16:16:15 +0100996 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000997
998 if (argvars[2].v_type == VAR_UNKNOWN)
999 {
1000 if (*p == NUL)
1001 {
Bram Moolenaare70cec92022-01-01 14:25:55 +00001002 semsg(_(e_reduce_of_an_empty_str_with_no_initial_value), "String");
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001003 return;
1004 }
1005 if (copy_first_char_to_tv(p, rettv) == FAIL)
1006 return;
1007 p += STRLEN(rettv->vval.v_string);
1008 }
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001009 else if (check_for_string_arg(argvars, 2) == FAIL)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001010 return;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001011 else
1012 copy_tv(&argvars[2], rettv);
1013
zeertzjqe7d49462023-04-16 20:53:55 +01001014 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +01001015 fc = eval_expr_get_funccal(expr, rettv);
1016
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001017 for ( ; *p != NUL; p += len)
1018 {
1019 argv[0] = *rettv;
1020 if (copy_first_char_to_tv(p, &argv[1]) == FAIL)
1021 break;
1022 len = (int)STRLEN(argv[1].vval.v_string);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001023
zeertzjqad0c4422023-08-17 22:15:47 +02001024 r = eval_expr_typval(expr, TRUE, argv, 2, fc, rettv);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001025
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001026 clear_tv(&argv[0]);
1027 clear_tv(&argv[1]);
1028 if (r == FAIL || called_emsg != called_emsg_start)
1029 return;
1030 }
Bram Moolenaar82418262022-09-28 16:16:15 +01001031
1032 if (fc != NULL)
1033 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001034}
1035
Bram Moolenaare4098452023-05-07 18:53:49 +01001036/*
1037 * Implementation of "byteidx()" and "byteidxcomp()" functions
1038 */
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001039 static void
Bram Moolenaare4098452023-05-07 18:53:49 +01001040byteidx_common(typval_T *argvars, typval_T *rettv, int comp UNUSED)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001041{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001042 rettv->vval.v_number = -1;
1043
1044 if (in_vim9script()
1045 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001046 || check_for_number_arg(argvars, 1) == FAIL
1047 || check_for_opt_bool_arg(argvars, 2) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001048 return;
1049
Christian Brabandt67672ef2023-04-24 21:09:54 +01001050 char_u *str = tv_get_string_chk(&argvars[0]);
1051 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001052 if (str == NULL || idx < 0)
1053 return;
1054
Christian Brabandt67672ef2023-04-24 21:09:54 +01001055 varnumber_T utf16idx = FALSE;
1056 if (argvars[2].v_type != VAR_UNKNOWN)
1057 {
zeertzjq8cf51372023-05-08 15:31:38 +01001058 int error = FALSE;
1059 utf16idx = tv_get_bool_chk(&argvars[2], &error);
1060 if (error)
1061 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001062 if (utf16idx < 0 || utf16idx > 1)
1063 {
zeertzjq8cf51372023-05-08 15:31:38 +01001064 semsg(_(e_using_number_as_bool_nr), utf16idx);
Christian Brabandt67672ef2023-04-24 21:09:54 +01001065 return;
1066 }
1067 }
1068
1069 int (*ptr2len)(char_u *);
1070 if (enc_utf8 && comp)
1071 ptr2len = utf_ptr2len;
1072 else
1073 ptr2len = mb_ptr2len;
1074
1075 char_u *t = str;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001076 for ( ; idx > 0; idx--)
1077 {
1078 if (*t == NUL) // EOL reached
1079 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001080 if (utf16idx)
1081 {
1082 int clen = ptr2len(t);
1083 int c = (clen > 1) ? utf_ptr2char(t) : *t;
1084 if (c > 0xFFFF)
1085 idx--;
1086 }
1087 if (idx > 0)
1088 t += ptr2len(t);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001089 }
1090 rettv->vval.v_number = (varnumber_T)(t - str);
1091}
1092
1093/*
1094 * "byteidx()" function
1095 */
1096 void
1097f_byteidx(typval_T *argvars, typval_T *rettv)
1098{
Bram Moolenaare4098452023-05-07 18:53:49 +01001099 byteidx_common(argvars, rettv, FALSE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001100}
1101
1102/*
1103 * "byteidxcomp()" function
1104 */
1105 void
1106f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1107{
Bram Moolenaare4098452023-05-07 18:53:49 +01001108 byteidx_common(argvars, rettv, TRUE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001109}
1110
1111/*
1112 * "charidx()" function
1113 */
1114 void
1115f_charidx(typval_T *argvars, typval_T *rettv)
1116{
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001117 rettv->vval.v_number = -1;
1118
Christian Brabandt67672ef2023-04-24 21:09:54 +01001119 if (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001120 || check_for_number_arg(argvars, 1) == FAIL
Christian Brabandt67672ef2023-04-24 21:09:54 +01001121 || check_for_opt_bool_arg(argvars, 2) == FAIL
1122 || (argvars[2].v_type != VAR_UNKNOWN
1123 && check_for_opt_bool_arg(argvars, 3) == FAIL))
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001124 return;
1125
Christian Brabandt67672ef2023-04-24 21:09:54 +01001126 char_u *str = tv_get_string_chk(&argvars[0]);
1127 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001128 if (str == NULL || idx < 0)
1129 return;
1130
Christian Brabandt67672ef2023-04-24 21:09:54 +01001131 varnumber_T countcc = FALSE;
1132 varnumber_T utf16idx = FALSE;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001133 if (argvars[2].v_type != VAR_UNKNOWN)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001134 {
Christian Brabandt67672ef2023-04-24 21:09:54 +01001135 countcc = tv_get_bool(&argvars[2]);
1136 if (argvars[3].v_type != VAR_UNKNOWN)
1137 utf16idx = tv_get_bool(&argvars[3]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001138 }
1139
Christian Brabandt67672ef2023-04-24 21:09:54 +01001140 int (*ptr2len)(char_u *);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001141 if (enc_utf8 && countcc)
1142 ptr2len = utf_ptr2len;
1143 else
1144 ptr2len = mb_ptr2len;
1145
Christian Brabandt67672ef2023-04-24 21:09:54 +01001146 char_u *p;
1147 int len;
1148 for (p = str, len = 0; utf16idx ? idx >= 0 : p <= str + idx; len++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001149 {
1150 if (*p == NUL)
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001151 {
1152 // If the index is exactly the number of bytes or utf-16 code units
1153 // in the string then return the length of the string in
1154 // characters.
1155 if (utf16idx ? (idx == 0) : (p == (str + idx)))
1156 rettv->vval.v_number = len;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001157 return;
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001158 }
Christian Brabandt67672ef2023-04-24 21:09:54 +01001159 if (utf16idx)
1160 {
1161 idx--;
1162 int clen = ptr2len(p);
1163 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1164 if (c > 0xFFFF)
1165 idx--;
1166 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001167 p += ptr2len(p);
1168 }
1169
1170 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1171}
1172
1173/*
1174 * "str2list()" function
1175 */
1176 void
1177f_str2list(typval_T *argvars, typval_T *rettv)
1178{
1179 char_u *p;
1180 int utf8 = FALSE;
1181
1182 if (rettv_list_alloc(rettv) == FAIL)
1183 return;
1184
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001185 if (in_vim9script()
1186 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001187 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001188 return;
1189
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001190 if (argvars[1].v_type != VAR_UNKNOWN)
1191 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1192
1193 p = tv_get_string(&argvars[0]);
1194
1195 if (has_mbyte || utf8)
1196 {
1197 int (*ptr2len)(char_u *);
1198 int (*ptr2char)(char_u *);
1199
1200 if (utf8 || enc_utf8)
1201 {
1202 ptr2len = utf_ptr2len;
1203 ptr2char = utf_ptr2char;
1204 }
1205 else
1206 {
1207 ptr2len = mb_ptr2len;
1208 ptr2char = mb_ptr2char;
1209 }
1210
1211 for ( ; *p != NUL; p += (*ptr2len)(p))
1212 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1213 }
1214 else
1215 for ( ; *p != NUL; ++p)
1216 list_append_number(rettv->vval.v_list, *p);
1217}
1218
1219/*
1220 * "str2nr()" function
1221 */
1222 void
1223f_str2nr(typval_T *argvars, typval_T *rettv)
1224{
1225 int base = 10;
1226 char_u *p;
1227 varnumber_T n;
1228 int what = 0;
1229 int isneg;
1230
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001231 if (in_vim9script()
1232 && (check_for_string_arg(argvars, 0) == FAIL
1233 || check_for_opt_number_arg(argvars, 1) == FAIL
1234 || (argvars[1].v_type != VAR_UNKNOWN
1235 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1236 return;
1237
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001238 if (argvars[1].v_type != VAR_UNKNOWN)
1239 {
1240 base = (int)tv_get_number(&argvars[1]);
1241 if (base != 2 && base != 8 && base != 10 && base != 16)
1242 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001243 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001244 return;
1245 }
1246 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1247 what |= STR2NR_QUOTE;
1248 }
1249
1250 p = skipwhite(tv_get_string_strict(&argvars[0]));
1251 isneg = (*p == '-');
1252 if (*p == '+' || *p == '-')
1253 p = skipwhite(p + 1);
1254 switch (base)
1255 {
1256 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1257 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1258 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1259 }
Bram Moolenaar5fb78c32023-03-04 20:47:39 +00001260 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE, NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001261 // Text after the number is silently ignored.
1262 if (isneg)
1263 rettv->vval.v_number = -n;
1264 else
1265 rettv->vval.v_number = n;
1266
1267}
1268
1269/*
1270 * "strgetchar()" function
1271 */
1272 void
1273f_strgetchar(typval_T *argvars, typval_T *rettv)
1274{
1275 char_u *str;
1276 int len;
1277 int error = FALSE;
1278 int charidx;
1279 int byteidx = 0;
1280
1281 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001282
1283 if (in_vim9script()
1284 && (check_for_string_arg(argvars, 0) == FAIL
1285 || check_for_number_arg(argvars, 1) == FAIL))
1286 return;
1287
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001288 str = tv_get_string_chk(&argvars[0]);
1289 if (str == NULL)
1290 return;
1291 len = (int)STRLEN(str);
1292 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1293 if (error)
1294 return;
1295
1296 while (charidx >= 0 && byteidx < len)
1297 {
1298 if (charidx == 0)
1299 {
1300 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1301 break;
1302 }
1303 --charidx;
1304 byteidx += MB_CPTR2LEN(str + byteidx);
1305 }
1306}
1307
1308/*
1309 * "stridx()" function
1310 */
1311 void
1312f_stridx(typval_T *argvars, typval_T *rettv)
1313{
1314 char_u buf[NUMBUFLEN];
1315 char_u *needle;
1316 char_u *haystack;
1317 char_u *save_haystack;
1318 char_u *pos;
1319 int start_idx;
1320
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001321 if (in_vim9script()
1322 && (check_for_string_arg(argvars, 0) == FAIL
1323 || check_for_string_arg(argvars, 1) == FAIL
1324 || check_for_opt_number_arg(argvars, 2) == FAIL))
1325 return;
1326
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001327 needle = tv_get_string_chk(&argvars[1]);
1328 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1329 rettv->vval.v_number = -1;
1330 if (needle == NULL || haystack == NULL)
1331 return; // type error; errmsg already given
1332
1333 if (argvars[2].v_type != VAR_UNKNOWN)
1334 {
1335 int error = FALSE;
1336
1337 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1338 if (error || start_idx >= (int)STRLEN(haystack))
1339 return;
1340 if (start_idx >= 0)
1341 haystack += start_idx;
1342 }
1343
1344 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1345 if (pos != NULL)
1346 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1347}
1348
1349/*
1350 * "string()" function
1351 */
1352 void
1353f_string(typval_T *argvars, typval_T *rettv)
1354{
1355 char_u *tofree;
1356 char_u numbuf[NUMBUFLEN];
1357
1358 rettv->v_type = VAR_STRING;
1359 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1360 get_copyID());
1361 // Make a copy if we have a value but it's not in allocated memory.
1362 if (rettv->vval.v_string != NULL && tofree == NULL)
1363 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1364}
1365
1366/*
1367 * "strlen()" function
1368 */
1369 void
1370f_strlen(typval_T *argvars, typval_T *rettv)
1371{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001372 if (in_vim9script()
1373 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1374 return;
1375
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001376 rettv->vval.v_number = (varnumber_T)(STRLEN(
1377 tv_get_string(&argvars[0])));
1378}
1379
1380 static void
1381strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1382{
1383 char_u *s = tv_get_string(&argvars[0]);
1384 varnumber_T len = 0;
1385 int (*func_mb_ptr2char_adv)(char_u **pp);
1386
1387 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1388 while (*s != NUL)
1389 {
1390 func_mb_ptr2char_adv(&s);
1391 ++len;
1392 }
1393 rettv->vval.v_number = len;
1394}
1395
1396/*
1397 * "strcharlen()" function
1398 */
1399 void
1400f_strcharlen(typval_T *argvars, typval_T *rettv)
1401{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001402 if (in_vim9script()
1403 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1404 return;
1405
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001406 strchar_common(argvars, rettv, TRUE);
1407}
1408
1409/*
1410 * "strchars()" function
1411 */
1412 void
1413f_strchars(typval_T *argvars, typval_T *rettv)
1414{
1415 varnumber_T skipcc = FALSE;
1416
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001417 if (in_vim9script()
1418 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001419 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001420 return;
1421
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001422 if (argvars[1].v_type != VAR_UNKNOWN)
Bram Moolenaare4098452023-05-07 18:53:49 +01001423 {
zeertzjq8cf51372023-05-08 15:31:38 +01001424 int error = FALSE;
1425 skipcc = tv_get_bool_chk(&argvars[1], &error);
1426 if (error)
1427 return;
1428 if (skipcc < 0 || skipcc > 1)
1429 {
Bram Moolenaare4098452023-05-07 18:53:49 +01001430 semsg(_(e_using_number_as_bool_nr), skipcc);
zeertzjq8cf51372023-05-08 15:31:38 +01001431 return;
1432 }
Bram Moolenaare4098452023-05-07 18:53:49 +01001433 }
zeertzjq8cf51372023-05-08 15:31:38 +01001434
1435 strchar_common(argvars, rettv, skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001436}
1437
1438/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001439 * "strutf16len()" function
1440 */
1441 void
1442f_strutf16len(typval_T *argvars, typval_T *rettv)
1443{
1444 rettv->vval.v_number = -1;
1445
1446 if (check_for_string_arg(argvars, 0) == FAIL
1447 || check_for_opt_bool_arg(argvars, 1) == FAIL)
1448 return;
1449
1450 varnumber_T countcc = FALSE;
1451 if (argvars[1].v_type != VAR_UNKNOWN)
1452 countcc = tv_get_bool(&argvars[1]);
1453
1454 char_u *s = tv_get_string(&argvars[0]);
1455 varnumber_T len = 0;
1456 int (*func_mb_ptr2char_adv)(char_u **pp);
1457 int ch;
1458
1459 func_mb_ptr2char_adv = countcc ? mb_cptr2char_adv : mb_ptr2char_adv;
1460 while (*s != NUL)
1461 {
1462 ch = func_mb_ptr2char_adv(&s);
1463 if (ch > 0xFFFF)
1464 ++len;
1465 ++len;
1466 }
1467 rettv->vval.v_number = len;
1468}
1469
1470/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001471 * "strdisplaywidth()" function
1472 */
1473 void
1474f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1475{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001476 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001477 int col = 0;
1478
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001479 rettv->vval.v_number = -1;
1480
1481 if (in_vim9script()
1482 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001483 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001484 return;
1485
1486 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001487 if (argvars[1].v_type != VAR_UNKNOWN)
1488 col = (int)tv_get_number(&argvars[1]);
1489
1490 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1491}
1492
1493/*
1494 * "strwidth()" function
1495 */
1496 void
1497f_strwidth(typval_T *argvars, typval_T *rettv)
1498{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001499 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001500
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001501 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1502 return;
1503
1504 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001505 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1506}
1507
1508/*
1509 * "strcharpart()" function
1510 */
1511 void
1512f_strcharpart(typval_T *argvars, typval_T *rettv)
1513{
1514 char_u *p;
1515 int nchar;
1516 int nbyte = 0;
1517 int charlen;
1518 int skipcc = FALSE;
1519 int len = 0;
1520 int slen;
1521 int error = FALSE;
1522
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001523 if (in_vim9script()
1524 && (check_for_string_arg(argvars, 0) == FAIL
1525 || check_for_number_arg(argvars, 1) == FAIL
1526 || check_for_opt_number_arg(argvars, 2) == FAIL
1527 || (argvars[2].v_type != VAR_UNKNOWN
1528 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1529 return;
1530
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001531 p = tv_get_string(&argvars[0]);
1532 slen = (int)STRLEN(p);
1533
1534 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1535 if (!error)
1536 {
1537 if (argvars[2].v_type != VAR_UNKNOWN
1538 && argvars[3].v_type != VAR_UNKNOWN)
1539 {
zeertzjq8cf51372023-05-08 15:31:38 +01001540 skipcc = tv_get_bool_chk(&argvars[3], &error);
1541 if (error)
1542 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001543 if (skipcc < 0 || skipcc > 1)
1544 {
zeertzjq8cf51372023-05-08 15:31:38 +01001545 semsg(_(e_using_number_as_bool_nr), skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001546 return;
1547 }
1548 }
1549
1550 if (nchar > 0)
1551 while (nchar > 0 && nbyte < slen)
1552 {
1553 if (skipcc)
1554 nbyte += mb_ptr2len(p + nbyte);
1555 else
1556 nbyte += MB_CPTR2LEN(p + nbyte);
1557 --nchar;
1558 }
1559 else
1560 nbyte = nchar;
1561 if (argvars[2].v_type != VAR_UNKNOWN)
1562 {
1563 charlen = (int)tv_get_number(&argvars[2]);
1564 while (charlen > 0 && nbyte + len < slen)
1565 {
1566 int off = nbyte + len;
1567
1568 if (off < 0)
1569 len += 1;
1570 else
1571 {
1572 if (skipcc)
1573 len += mb_ptr2len(p + off);
1574 else
1575 len += MB_CPTR2LEN(p + off);
1576 }
1577 --charlen;
1578 }
1579 }
1580 else
1581 len = slen - nbyte; // default: all bytes that are available.
1582 }
1583
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001584 // Only return the overlap between the specified part and the actual
1585 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001586 if (nbyte < 0)
1587 {
1588 len += nbyte;
1589 nbyte = 0;
1590 }
1591 else if (nbyte > slen)
1592 nbyte = slen;
1593 if (len < 0)
1594 len = 0;
1595 else if (nbyte + len > slen)
1596 len = slen - nbyte;
1597
1598 rettv->v_type = VAR_STRING;
1599 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1600}
1601
1602/*
1603 * "strpart()" function
1604 */
1605 void
1606f_strpart(typval_T *argvars, typval_T *rettv)
1607{
1608 char_u *p;
1609 int n;
1610 int len;
1611 int slen;
1612 int error = FALSE;
1613
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001614 if (in_vim9script()
1615 && (check_for_string_arg(argvars, 0) == FAIL
1616 || check_for_number_arg(argvars, 1) == FAIL
1617 || check_for_opt_number_arg(argvars, 2) == FAIL
1618 || (argvars[2].v_type != VAR_UNKNOWN
1619 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1620 return;
1621
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001622 p = tv_get_string(&argvars[0]);
1623 slen = (int)STRLEN(p);
1624
1625 n = (int)tv_get_number_chk(&argvars[1], &error);
1626 if (error)
1627 len = 0;
1628 else if (argvars[2].v_type != VAR_UNKNOWN)
1629 len = (int)tv_get_number(&argvars[2]);
1630 else
1631 len = slen - n; // default len: all bytes that are available.
1632
1633 // Only return the overlap between the specified part and the actual
1634 // string.
1635 if (n < 0)
1636 {
1637 len += n;
1638 n = 0;
1639 }
1640 else if (n > slen)
1641 n = slen;
1642 if (len < 0)
1643 len = 0;
1644 else if (n + len > slen)
1645 len = slen - n;
1646
1647 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1648 {
1649 int off;
1650
1651 // length in characters
1652 for (off = n; off < slen && len > 0; --len)
1653 off += mb_ptr2len(p + off);
1654 len = off - n;
1655 }
1656
1657 rettv->v_type = VAR_STRING;
1658 rettv->vval.v_string = vim_strnsave(p + n, len);
1659}
1660
1661/*
1662 * "strridx()" function
1663 */
1664 void
1665f_strridx(typval_T *argvars, typval_T *rettv)
1666{
1667 char_u buf[NUMBUFLEN];
1668 char_u *needle;
1669 char_u *haystack;
1670 char_u *rest;
1671 char_u *lastmatch = NULL;
1672 int haystack_len, end_idx;
1673
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001674 if (in_vim9script()
1675 && (check_for_string_arg(argvars, 0) == FAIL
1676 || check_for_string_arg(argvars, 1) == FAIL
1677 || check_for_opt_number_arg(argvars, 2) == FAIL))
1678 return;
1679
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001680 needle = tv_get_string_chk(&argvars[1]);
1681 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1682
1683 rettv->vval.v_number = -1;
1684 if (needle == NULL || haystack == NULL)
1685 return; // type error; errmsg already given
1686
1687 haystack_len = (int)STRLEN(haystack);
1688 if (argvars[2].v_type != VAR_UNKNOWN)
1689 {
1690 // Third argument: upper limit for index
1691 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1692 if (end_idx < 0)
1693 return; // can never find a match
1694 }
1695 else
1696 end_idx = haystack_len;
1697
1698 if (*needle == NUL)
1699 {
1700 // Empty string matches past the end.
1701 lastmatch = haystack + end_idx;
1702 }
1703 else
1704 {
1705 for (rest = haystack; *rest != '\0'; ++rest)
1706 {
1707 rest = (char_u *)strstr((char *)rest, (char *)needle);
1708 if (rest == NULL || rest > haystack + end_idx)
1709 break;
1710 lastmatch = rest;
1711 }
1712 }
1713
1714 if (lastmatch == NULL)
1715 rettv->vval.v_number = -1;
1716 else
1717 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1718}
1719
1720/*
1721 * "strtrans()" function
1722 */
1723 void
1724f_strtrans(typval_T *argvars, typval_T *rettv)
1725{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001726 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1727 return;
1728
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001729 rettv->v_type = VAR_STRING;
1730 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1731}
1732
Christian Brabandt67672ef2023-04-24 21:09:54 +01001733
1734/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001735 * "utf16idx()" function
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001736 *
1737 * Converts a byte or character offset in a string to the corresponding UTF-16
1738 * code unit offset.
Christian Brabandt67672ef2023-04-24 21:09:54 +01001739 */
1740 void
1741f_utf16idx(typval_T *argvars, typval_T *rettv)
1742{
1743 rettv->vval.v_number = -1;
1744
1745 if (check_for_string_arg(argvars, 0) == FAIL
1746 || check_for_opt_number_arg(argvars, 1) == FAIL
1747 || check_for_opt_bool_arg(argvars, 2) == FAIL
1748 || (argvars[2].v_type != VAR_UNKNOWN
1749 && check_for_opt_bool_arg(argvars, 3) == FAIL))
1750 return;
1751
1752 char_u *str = tv_get_string_chk(&argvars[0]);
1753 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
1754 if (str == NULL || idx < 0)
1755 return;
1756
1757 varnumber_T countcc = FALSE;
1758 varnumber_T charidx = FALSE;
1759 if (argvars[2].v_type != VAR_UNKNOWN)
1760 {
1761 countcc = tv_get_bool(&argvars[2]);
1762 if (argvars[3].v_type != VAR_UNKNOWN)
1763 charidx = tv_get_bool(&argvars[3]);
1764 }
1765
1766 int (*ptr2len)(char_u *);
1767 if (enc_utf8 && countcc)
1768 ptr2len = utf_ptr2len;
1769 else
1770 ptr2len = mb_ptr2len;
1771
1772 char_u *p;
1773 int len;
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001774 int utf16idx = 0;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001775 for (p = str, len = 0; charidx ? idx >= 0 : p <= str + idx; len++)
1776 {
1777 if (*p == NUL)
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001778 {
1779 // If the index is exactly the number of bytes or characters in the
1780 // string then return the length of the string in utf-16 code
1781 // units.
1782 if (charidx ? (idx == 0) : (p == (str + idx)))
1783 rettv->vval.v_number = len;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001784 return;
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001785 }
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001786 utf16idx = len;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001787 int clen = ptr2len(p);
1788 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1789 if (c > 0xFFFF)
1790 len++;
1791 p += ptr2len(p);
1792 if (charidx)
1793 idx--;
1794 }
1795
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001796 rettv->vval.v_number = utf16idx;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001797}
1798
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001799/*
1800 * "tolower(string)" function
1801 */
1802 void
1803f_tolower(typval_T *argvars, typval_T *rettv)
1804{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001805 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1806 return;
1807
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001808 rettv->v_type = VAR_STRING;
1809 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1810}
1811
1812/*
1813 * "toupper(string)" function
1814 */
1815 void
1816f_toupper(typval_T *argvars, typval_T *rettv)
1817{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001818 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1819 return;
1820
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001821 rettv->v_type = VAR_STRING;
1822 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1823}
1824
1825/*
1826 * "tr(string, fromstr, tostr)" function
1827 */
1828 void
1829f_tr(typval_T *argvars, typval_T *rettv)
1830{
1831 char_u *in_str;
1832 char_u *fromstr;
1833 char_u *tostr;
1834 char_u *p;
1835 int inlen;
1836 int fromlen;
1837 int tolen;
1838 int idx;
1839 char_u *cpstr;
1840 int cplen;
1841 int first = TRUE;
1842 char_u buf[NUMBUFLEN];
1843 char_u buf2[NUMBUFLEN];
1844 garray_T ga;
1845
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001846 if (in_vim9script()
1847 && (check_for_string_arg(argvars, 0) == FAIL
1848 || check_for_string_arg(argvars, 1) == FAIL
1849 || check_for_string_arg(argvars, 2) == FAIL))
1850 return;
1851
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001852 in_str = tv_get_string(&argvars[0]);
1853 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1854 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1855
1856 // Default return value: empty string.
1857 rettv->v_type = VAR_STRING;
1858 rettv->vval.v_string = NULL;
1859 if (fromstr == NULL || tostr == NULL)
1860 return; // type error; errmsg already given
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001861 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001862
1863 if (!has_mbyte)
1864 // not multi-byte: fromstr and tostr must be the same length
1865 if (STRLEN(fromstr) != STRLEN(tostr))
1866 {
1867error:
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001868 semsg(_(e_invalid_argument_str), fromstr);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001869 ga_clear(&ga);
1870 return;
1871 }
1872
1873 // fromstr and tostr have to contain the same number of chars
1874 while (*in_str != NUL)
1875 {
1876 if (has_mbyte)
1877 {
1878 inlen = (*mb_ptr2len)(in_str);
1879 cpstr = in_str;
1880 cplen = inlen;
1881 idx = 0;
1882 for (p = fromstr; *p != NUL; p += fromlen)
1883 {
1884 fromlen = (*mb_ptr2len)(p);
1885 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1886 {
1887 for (p = tostr; *p != NUL; p += tolen)
1888 {
1889 tolen = (*mb_ptr2len)(p);
1890 if (idx-- == 0)
1891 {
1892 cplen = tolen;
1893 cpstr = p;
1894 break;
1895 }
1896 }
1897 if (*p == NUL) // tostr is shorter than fromstr
1898 goto error;
1899 break;
1900 }
1901 ++idx;
1902 }
1903
1904 if (first && cpstr == in_str)
1905 {
1906 // Check that fromstr and tostr have the same number of
1907 // (multi-byte) characters. Done only once when a character
1908 // of in_str doesn't appear in fromstr.
1909 first = FALSE;
1910 for (p = tostr; *p != NUL; p += tolen)
1911 {
1912 tolen = (*mb_ptr2len)(p);
1913 --idx;
1914 }
1915 if (idx != 0)
1916 goto error;
1917 }
1918
1919 (void)ga_grow(&ga, cplen);
1920 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1921 ga.ga_len += cplen;
1922
1923 in_str += inlen;
1924 }
1925 else
1926 {
1927 // When not using multi-byte chars we can do it faster.
1928 p = vim_strchr(fromstr, *in_str);
1929 if (p != NULL)
1930 ga_append(&ga, tostr[p - fromstr]);
1931 else
1932 ga_append(&ga, *in_str);
1933 ++in_str;
1934 }
1935 }
1936
1937 // add a terminating NUL
1938 (void)ga_grow(&ga, 1);
1939 ga_append(&ga, NUL);
1940
1941 rettv->vval.v_string = ga.ga_data;
1942}
1943
1944/*
1945 * "trim({expr})" function
1946 */
1947 void
1948f_trim(typval_T *argvars, typval_T *rettv)
1949{
1950 char_u buf1[NUMBUFLEN];
1951 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001952 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001953 char_u *mask = NULL;
1954 char_u *tail;
1955 char_u *prev;
1956 char_u *p;
1957 int c1;
1958 int dir = 0;
1959
1960 rettv->v_type = VAR_STRING;
1961 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001962
1963 if (in_vim9script()
1964 && (check_for_string_arg(argvars, 0) == FAIL
Illia Bobyr80799172023-10-17 18:00:50 +02001965 || check_for_opt_string_arg(argvars, 1) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001966 || (argvars[1].v_type != VAR_UNKNOWN
1967 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1968 return;
1969
1970 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001971 if (head == NULL)
1972 return;
1973
Illia Bobyr80799172023-10-17 18:00:50 +02001974 if (check_for_opt_string_arg(argvars, 1) == FAIL)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001975 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001976
1977 if (argvars[1].v_type == VAR_STRING)
Illia Bobyr6e638672023-10-17 11:09:45 +02001978 {
Illia Bobyr80799172023-10-17 18:00:50 +02001979 mask = tv_get_string_buf_chk(&argvars[1], buf2);
1980 if (*mask == NUL)
1981 mask = NULL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001982
Illia Bobyr80799172023-10-17 18:00:50 +02001983 if (argvars[2].v_type != VAR_UNKNOWN)
Illia Bobyr6e638672023-10-17 11:09:45 +02001984 {
Illia Bobyr80799172023-10-17 18:00:50 +02001985 int error = 0;
1986
1987 // leading or trailing characters to trim
1988 dir = (int)tv_get_number_chk(&argvars[2], &error);
1989 if (error)
1990 return;
1991 if (dir < 0 || dir > 2)
1992 {
1993 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[2]));
1994 return;
1995 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001996 }
1997 }
1998
1999 if (dir == 0 || dir == 1)
2000 {
2001 // Trim leading characters
2002 while (*head != NUL)
2003 {
2004 c1 = PTR2CHAR(head);
2005 if (mask == NULL)
2006 {
2007 if (c1 > ' ' && c1 != 0xa0)
2008 break;
2009 }
2010 else
2011 {
2012 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2013 if (c1 == PTR2CHAR(p))
2014 break;
2015 if (*p == NUL)
2016 break;
2017 }
2018 MB_PTR_ADV(head);
2019 }
2020 }
2021
2022 tail = head + STRLEN(head);
2023 if (dir == 0 || dir == 2)
2024 {
2025 // Trim trailing characters
2026 for (; tail > head; tail = prev)
2027 {
2028 prev = tail;
2029 MB_PTR_BACK(head, prev);
2030 c1 = PTR2CHAR(prev);
2031 if (mask == NULL)
2032 {
2033 if (c1 > ' ' && c1 != 0xa0)
2034 break;
2035 }
2036 else
2037 {
2038 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2039 if (c1 == PTR2CHAR(p))
2040 break;
2041 if (*p == NUL)
2042 break;
2043 }
2044 }
2045 }
2046 rettv->vval.v_string = vim_strnsave(head, tail - head);
2047}
2048
Bram Moolenaar677658a2022-01-05 16:09:06 +00002049static char *e_printf = N_(e_insufficient_arguments_for_printf);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002050
2051/*
2052 * Get number argument from "idxp" entry in "tvs". First entry is 1.
2053 */
2054 static varnumber_T
2055tv_nr(typval_T *tvs, int *idxp)
2056{
2057 int idx = *idxp - 1;
2058 varnumber_T n = 0;
2059 int err = FALSE;
2060
2061 if (tvs[idx].v_type == VAR_UNKNOWN)
2062 emsg(_(e_printf));
2063 else
2064 {
2065 ++*idxp;
2066 n = tv_get_number_chk(&tvs[idx], &err);
2067 if (err)
2068 n = 0;
2069 }
2070 return n;
2071}
2072
2073/*
2074 * Get string argument from "idxp" entry in "tvs". First entry is 1.
2075 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
2076 * are not converted to a string.
2077 * If "tofree" is not NULL echo_string() is used. All types are converted to
2078 * a string with the same format as ":echo". The caller must free "*tofree".
2079 * Returns NULL for an error.
2080 */
2081 static char *
2082tv_str(typval_T *tvs, int *idxp, char_u **tofree)
2083{
2084 int idx = *idxp - 1;
2085 char *s = NULL;
2086 static char_u numbuf[NUMBUFLEN];
2087
2088 if (tvs[idx].v_type == VAR_UNKNOWN)
2089 emsg(_(e_printf));
2090 else
2091 {
2092 ++*idxp;
2093 if (tofree != NULL)
2094 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
2095 else
2096 s = (char *)tv_get_string_chk(&tvs[idx]);
2097 }
2098 return s;
2099}
2100
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002101/*
2102 * Get float argument from "idxp" entry in "tvs". First entry is 1.
2103 */
2104 static double
2105tv_float(typval_T *tvs, int *idxp)
2106{
2107 int idx = *idxp - 1;
2108 double f = 0;
2109
2110 if (tvs[idx].v_type == VAR_UNKNOWN)
2111 emsg(_(e_printf));
2112 else
2113 {
2114 ++*idxp;
2115 if (tvs[idx].v_type == VAR_FLOAT)
2116 f = tvs[idx].vval.v_float;
2117 else if (tvs[idx].v_type == VAR_NUMBER)
2118 f = (double)tvs[idx].vval.v_number;
2119 else
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00002120 emsg(_(e_expected_float_argument_for_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002121 }
2122 return f;
2123}
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00002124
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002125#endif
2126
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002127/*
2128 * Return the representation of infinity for printf() function:
2129 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
2130 */
2131 static const char *
2132infinity_str(int positive,
2133 char fmt_spec,
2134 int force_sign,
2135 int space_for_positive)
2136{
2137 static const char *table[] =
2138 {
2139 "-inf", "inf", "+inf", " inf",
2140 "-INF", "INF", "+INF", " INF"
2141 };
2142 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
2143
2144 if (ASCII_ISUPPER(fmt_spec))
2145 idx += 4;
2146 return table[idx];
2147}
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002148
2149/*
2150 * This code was included to provide a portable vsnprintf() and snprintf().
2151 * Some systems may provide their own, but we always use this one for
2152 * consistency.
2153 *
2154 * This code is based on snprintf.c - a portable implementation of snprintf
2155 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
2156 * Included with permission. It was heavily modified to fit in Vim.
2157 * The original code, including useful comments, can be found here:
2158 * http://www.ijs.si/software/snprintf/
2159 *
2160 * This snprintf() only supports the following conversion specifiers:
2161 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
2162 * with flags: '-', '+', ' ', '0' and '#'.
2163 * An asterisk is supported for field width as well as precision.
2164 *
2165 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
2166 *
2167 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
2168 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
2169 *
2170 * The locale is not used, the string is used as a byte string. This is only
2171 * relevant for double-byte encodings where the second byte may be '%'.
2172 *
2173 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
2174 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
2175 *
2176 * The return value is the number of characters which would be generated
2177 * for the given input, excluding the trailing NUL. If this value
2178 * is greater or equal to "str_m", not all characters from the result
2179 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
2180 * are discarded. If "str_m" is greater than zero it is guaranteed
2181 * the resulting string will be NUL-terminated.
2182 */
2183
2184/*
2185 * When va_list is not supported we only define vim_snprintf().
2186 *
2187 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2188 * "typval_T". When the latter is not used it must be NULL.
2189 */
2190
2191// When generating prototypes all of this is skipped, cproto doesn't
2192// understand this.
2193#ifndef PROTO
2194
2195// Like vim_vsnprintf() but append to the string.
2196 int
2197vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2198{
2199 va_list ap;
2200 int str_l;
2201 size_t len = STRLEN(str);
2202 size_t space;
2203
2204 if (str_m <= len)
2205 space = 0;
2206 else
2207 space = str_m - len;
2208 va_start(ap, fmt);
2209 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2210 va_end(ap);
2211 return str_l;
2212}
2213
2214 int
2215vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2216{
2217 va_list ap;
2218 int str_l;
2219
2220 va_start(ap, fmt);
2221 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2222 va_end(ap);
2223 return str_l;
2224}
2225
2226 int
2227vim_vsnprintf(
2228 char *str,
2229 size_t str_m,
2230 const char *fmt,
2231 va_list ap)
2232{
2233 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2234}
2235
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002236enum
2237{
2238 TYPE_UNKNOWN = -1,
2239 TYPE_INT,
2240 TYPE_LONGINT,
2241 TYPE_LONGLONGINT,
2242 TYPE_UNSIGNEDINT,
2243 TYPE_UNSIGNEDLONGINT,
2244 TYPE_UNSIGNEDLONGLONGINT,
2245 TYPE_POINTER,
2246 TYPE_PERCENT,
2247 TYPE_CHAR,
2248 TYPE_STRING,
2249 TYPE_FLOAT
2250};
2251
2252/* Types that can be used in a format string
2253 */
zeertzjq7772c932023-08-15 22:48:40 +02002254 static int
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002255format_typeof(
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002256 const char *type)
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002257{
2258 // allowed values: \0, h, l, L
2259 char length_modifier = '\0';
2260
2261 // current conversion specifier character
2262 char fmt_spec = '\0';
2263
2264 // parse 'h', 'l' and 'll' length modifiers
2265 if (*type == 'h' || *type == 'l')
2266 {
2267 length_modifier = *type;
2268 type++;
2269 if (length_modifier == 'l' && *type == 'l')
2270 {
2271 // double l = __int64 / varnumber_T
2272 length_modifier = 'L';
2273 type++;
2274 }
2275 }
2276 fmt_spec = *type;
2277
2278 // common synonyms:
2279 switch (fmt_spec)
2280 {
2281 case 'i': fmt_spec = 'd'; break;
2282 case '*': fmt_spec = 'd'; length_modifier = 'h'; break;
2283 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2284 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2285 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2286 default: break;
2287 }
2288
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002289 // get parameter value, do initial processing
2290 switch (fmt_spec)
2291 {
2292 // '%' and 'c' behave similar to 's' regarding flags and field
2293 // widths
2294 case '%':
2295 return TYPE_PERCENT;
2296
2297 case 'c':
2298 return TYPE_CHAR;
2299
2300 case 's':
2301 case 'S':
2302 return TYPE_STRING;
2303
2304 case 'd': case 'u':
2305 case 'b': case 'B':
2306 case 'o':
2307 case 'x': case 'X':
2308 case 'p':
2309 {
2310 // NOTE: the u, b, o, x, X and p conversion specifiers
2311 // imply the value is unsigned; d implies a signed
2312 // value
2313
2314 // 0 if numeric argument is zero (or if pointer is
2315 // NULL for 'p'), +1 if greater than zero (or nonzero
2316 // for unsigned arguments), -1 if negative (unsigned
2317 // argument is never negative)
2318
2319 if (fmt_spec == 'p')
2320 return TYPE_POINTER;
2321 else if (fmt_spec == 'b' || fmt_spec == 'B')
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002322 return TYPE_UNSIGNEDLONGLONGINT;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002323 else if (fmt_spec == 'd')
2324 {
2325 // signed
2326 switch (length_modifier)
2327 {
2328 case '\0':
2329 case 'h':
2330 // char and short arguments are passed as int.
2331 return TYPE_INT;
2332 case 'l':
2333 return TYPE_LONGINT;
2334 case 'L':
2335 return TYPE_LONGLONGINT;
2336 }
2337 }
2338 else
2339 {
2340 // unsigned
2341 switch (length_modifier)
2342 {
2343 case '\0':
2344 case 'h':
2345 return TYPE_UNSIGNEDINT;
2346 case 'l':
2347 return TYPE_UNSIGNEDLONGINT;
2348 case 'L':
2349 return TYPE_UNSIGNEDLONGLONGINT;
2350 }
2351 }
2352 }
2353 break;
2354
2355 case 'f':
2356 case 'F':
2357 case 'e':
2358 case 'E':
2359 case 'g':
2360 case 'G':
2361 return TYPE_FLOAT;
2362 }
2363
2364 return TYPE_UNKNOWN;
2365}
2366
zeertzjq7772c932023-08-15 22:48:40 +02002367 static char *
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002368format_typename(
2369 const char *type)
2370{
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002371 switch (format_typeof(type))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002372 {
2373 case TYPE_INT:
2374 return _(typename_int);
2375
2376 case TYPE_LONGINT:
2377 return _(typename_longint);
2378
2379 case TYPE_LONGLONGINT:
2380 return _(typename_longlongint);
2381
2382 case TYPE_UNSIGNEDINT:
2383 return _(typename_unsignedint);
2384
2385 case TYPE_UNSIGNEDLONGINT:
2386 return _(typename_unsignedlongint);
2387
2388 case TYPE_UNSIGNEDLONGLONGINT:
2389 return _(typename_unsignedlonglongint);
2390
2391 case TYPE_POINTER:
2392 return _(typename_pointer);
2393
2394 case TYPE_PERCENT:
2395 return _(typename_percent);
2396
2397 case TYPE_CHAR:
2398 return _(typename_char);
2399
2400 case TYPE_STRING:
2401 return _(typename_string);
2402
2403 case TYPE_FLOAT:
2404 return _(typename_float);
2405 }
2406
2407 return _(typename_unknown);
2408}
2409
zeertzjq7772c932023-08-15 22:48:40 +02002410 static int
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002411adjust_types(
2412 const char ***ap_types,
2413 int arg,
2414 int *num_posarg,
2415 const char *type)
2416{
2417 if (*ap_types == NULL || *num_posarg < arg)
2418 {
2419 int idx;
2420 const char **new_types;
2421
2422 if (*ap_types == NULL)
2423 new_types = ALLOC_CLEAR_MULT(const char *, arg);
2424 else
K.Takata4c215ec2023-08-26 18:05:08 +02002425 new_types = vim_realloc((char **)*ap_types,
2426 arg * sizeof(const char *));
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002427
2428 if (new_types == NULL)
2429 return FAIL;
2430
2431 for (idx = *num_posarg; idx < arg; ++idx)
2432 new_types[idx] = NULL;
2433
2434 *ap_types = new_types;
2435 *num_posarg = arg;
2436 }
2437
2438 if ((*ap_types)[arg - 1] != NULL)
2439 {
2440 if ((*ap_types)[arg - 1][0] == '*' || type[0] == '*')
2441 {
2442 const char *pt = type;
2443 if (pt[0] == '*')
2444 pt = (*ap_types)[arg - 1];
2445
2446 if (pt[0] != '*')
2447 {
2448 switch (pt[0])
2449 {
2450 case 'd': case 'i': break;
2451 default:
2452 semsg(_(e_positional_num_field_spec_reused_str_str), arg, format_typename((*ap_types)[arg - 1]), format_typename(type));
2453 return FAIL;
2454 }
2455 }
2456 }
2457 else
2458 {
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002459 if (format_typeof(type) != format_typeof((*ap_types)[arg - 1]))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002460 {
2461 semsg(_( e_positional_arg_num_type_inconsistent_str_str), arg, format_typename(type), format_typename((*ap_types)[arg - 1]));
2462 return FAIL;
2463 }
2464 }
2465 }
2466
2467 (*ap_types)[arg - 1] = type;
2468
2469 return OK;
2470}
2471
zeertzjq7772c932023-08-15 22:48:40 +02002472 static int
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002473parse_fmt_types(
2474 const char ***ap_types,
2475 int *num_posarg,
2476 const char *fmt,
2477 typval_T *tvs UNUSED
2478 )
2479{
2480 const char *p = fmt;
2481 const char *arg = NULL;
2482
2483 int any_pos = 0;
2484 int any_arg = 0;
2485 int arg_idx;
2486
2487#define CHECK_POS_ARG do { \
2488 if (any_pos && any_arg) \
2489 { \
2490 semsg(_( e_cannot_mix_positional_and_non_positional_str), fmt); \
2491 goto error; \
2492 } \
2493} while (0);
2494
2495 if (p == NULL)
2496 return OK;
2497
2498 while (*p != NUL)
2499 {
2500 if (*p != '%')
2501 {
2502 char *q = strchr(p + 1, '%');
2503 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2504
2505 p += n;
2506 }
2507 else
2508 {
2509 // allowed values: \0, h, l, L
2510 char length_modifier = '\0';
2511
2512 // variable for positional arg
2513 int pos_arg = -1;
2514 const char *ptype = NULL;
2515
2516 p++; // skip '%'
2517
2518 // First check to see if we find a positional
2519 // argument specifier
2520 ptype = p;
2521
2522 while (VIM_ISDIGIT(*ptype))
2523 ++ptype;
2524
2525 if (*ptype == '$')
2526 {
2527 if (*p == '0')
2528 {
2529 // 0 flag at the wrong place
2530 semsg(_( e_invalid_format_specifier_str), fmt);
2531 goto error;
2532 }
2533
2534 // Positional argument
2535 unsigned int uj = *p++ - '0';
2536
2537 while (VIM_ISDIGIT((int)(*p)))
2538 uj = 10 * uj + (unsigned int)(*p++ - '0');
2539 pos_arg = uj;
2540
2541 any_pos = 1;
2542 CHECK_POS_ARG;
2543
2544 ++p;
2545 }
2546
2547 // parse flags
2548 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2549 || *p == '#' || *p == '\'')
2550 {
2551 switch (*p)
2552 {
2553 case '0': break;
2554 case '-': break;
2555 case '+': break;
2556 case ' ': // If both the ' ' and '+' flags appear, the ' '
2557 // flag should be ignored
2558 break;
2559 case '#': break;
2560 case '\'': break;
2561 }
2562 p++;
2563 }
2564 // If the '0' and '-' flags both appear, the '0' flag should be
2565 // ignored.
2566
2567 // parse field width
2568 if (*(arg = p) == '*')
2569 {
2570 p++;
2571
2572 if (VIM_ISDIGIT((int)(*p)))
2573 {
2574 // Positional argument field width
2575 unsigned int uj = *p++ - '0';
2576
2577 while (VIM_ISDIGIT((int)(*p)))
2578 uj = 10 * uj + (unsigned int)(*p++ - '0');
2579
2580 if (*p != '$')
2581 {
2582 semsg(_( e_invalid_format_specifier_str), fmt);
2583 goto error;
2584 }
2585 else
2586 {
2587 ++p;
2588 any_pos = 1;
2589 CHECK_POS_ARG;
2590
2591 if (adjust_types(ap_types, uj, num_posarg, arg) == FAIL)
2592 goto error;
2593 }
2594 }
2595 else
2596 {
2597 any_arg = 1;
2598 CHECK_POS_ARG;
2599 }
2600 }
dundargoc580c1fc2023-10-06 19:41:14 +02002601 else if (VIM_ISDIGIT((int)(*p)))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002602 {
2603 // size_t could be wider than unsigned int; make sure we treat
2604 // argument like common implementations do
2605 unsigned int uj = *p++ - '0';
2606
2607 while (VIM_ISDIGIT((int)(*p)))
2608 uj = 10 * uj + (unsigned int)(*p++ - '0');
2609
2610 if (*p == '$')
2611 {
2612 semsg(_( e_invalid_format_specifier_str), fmt);
2613 goto error;
2614 }
2615 }
2616
2617 // parse precision
2618 if (*p == '.')
2619 {
2620 p++;
2621
2622 if (*(arg = p) == '*')
2623 {
2624 p++;
2625
2626 if (VIM_ISDIGIT((int)(*p)))
2627 {
2628 // Parse precision
2629 unsigned int uj = *p++ - '0';
2630
2631 while (VIM_ISDIGIT((int)(*p)))
2632 uj = 10 * uj + (unsigned int)(*p++ - '0');
2633
2634 if (*p == '$')
2635 {
2636 any_pos = 1;
2637 CHECK_POS_ARG;
2638
2639 ++p;
2640
2641 if (adjust_types(ap_types, uj, num_posarg, arg) == FAIL)
2642 goto error;
2643 }
2644 else
2645 {
2646 semsg(_( e_invalid_format_specifier_str), fmt);
2647 goto error;
2648 }
2649 }
2650 else
2651 {
2652 any_arg = 1;
2653 CHECK_POS_ARG;
2654 }
2655 }
dundargoc580c1fc2023-10-06 19:41:14 +02002656 else if (VIM_ISDIGIT((int)(*p)))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002657 {
2658 // size_t could be wider than unsigned int; make sure we
2659 // treat argument like common implementations do
2660 unsigned int uj = *p++ - '0';
2661
2662 while (VIM_ISDIGIT((int)(*p)))
2663 uj = 10 * uj + (unsigned int)(*p++ - '0');
2664
2665 if (*p == '$')
2666 {
2667 semsg(_( e_invalid_format_specifier_str), fmt);
2668 goto error;
2669 }
2670 }
2671 }
2672
2673 if (pos_arg != -1)
2674 {
2675 any_pos = 1;
2676 CHECK_POS_ARG;
2677
2678 ptype = p;
2679 }
2680
2681 // parse 'h', 'l' and 'll' length modifiers
2682 if (*p == 'h' || *p == 'l')
2683 {
2684 length_modifier = *p;
2685 p++;
2686 if (length_modifier == 'l' && *p == 'l')
2687 {
2688 // double l = __int64 / varnumber_T
dundargoc580c1fc2023-10-06 19:41:14 +02002689 // length_modifier = 'L';
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002690 p++;
2691 }
2692 }
2693
2694 switch (*p)
2695 {
2696 // Check for known format specifiers. % is special!
2697 case 'i':
2698 case '*':
2699 case 'd':
2700 case 'u':
2701 case 'o':
2702 case 'D':
2703 case 'U':
2704 case 'O':
2705 case 'x':
2706 case 'X':
2707 case 'b':
2708 case 'B':
2709 case 'c':
2710 case 's':
2711 case 'S':
2712 case 'p':
2713 case 'f':
2714 case 'F':
2715 case 'e':
2716 case 'E':
2717 case 'g':
2718 case 'G':
2719 if (pos_arg != -1)
2720 {
2721 if (adjust_types(ap_types, pos_arg, num_posarg, ptype) == FAIL)
2722 goto error;
2723 }
2724 else
2725 {
2726 any_arg = 1;
2727 CHECK_POS_ARG;
2728 }
2729 break;
2730
2731 default:
2732 if (pos_arg != -1)
2733 {
2734 semsg(_( e_cannot_mix_positional_and_non_positional_str), fmt);
2735 goto error;
2736 }
2737 }
2738
2739 if (*p != NUL)
2740 p++; // step over the just processed conversion specifier
2741 }
2742 }
2743
2744 for (arg_idx = 0; arg_idx < *num_posarg; ++arg_idx)
2745 {
2746 if ((*ap_types)[arg_idx] == NULL)
2747 {
2748 semsg(_(e_fmt_arg_nr_unused_str), arg_idx + 1, fmt);
2749 goto error;
2750 }
2751
2752# if defined(FEAT_EVAL)
2753 if (tvs != NULL && tvs[arg_idx].v_type == VAR_UNKNOWN)
2754 {
2755 semsg(_(e_positional_nr_out_of_bounds_str), arg_idx + 1, fmt);
2756 goto error;
2757 }
2758# endif
2759 }
2760
2761 return OK;
2762
2763error:
K.Takata4c215ec2023-08-26 18:05:08 +02002764 vim_free((char**)*ap_types);
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002765 *ap_types = NULL;
2766 *num_posarg = 0;
2767 return FAIL;
2768}
2769
zeertzjq7772c932023-08-15 22:48:40 +02002770 static void
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002771skip_to_arg(
2772 const char **ap_types,
2773 va_list ap_start,
2774 va_list *ap,
2775 int *arg_idx,
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002776 int *arg_cur,
2777 const char *fmt)
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002778{
2779 int arg_min = 0;
2780
2781 if (*arg_cur + 1 == *arg_idx)
2782 {
2783 ++*arg_cur;
2784 ++*arg_idx;
2785 return;
2786 }
2787
2788 if (*arg_cur >= *arg_idx)
2789 {
2790 // Reset ap to ap_start and skip arg_idx - 1 types
2791 va_end(*ap);
2792 va_copy(*ap, ap_start);
2793 }
2794 else
2795 {
2796 // Skip over any we should skip
2797 arg_min = *arg_cur;
2798 }
2799
2800 for (*arg_cur = arg_min; *arg_cur < *arg_idx - 1; ++*arg_cur)
2801 {
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002802 const char *p;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002803
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002804 if (ap_types == NULL || ap_types[*arg_cur] == NULL)
2805 {
Christ van Willegen1bd2cb12023-09-08 19:17:09 +02002806 siemsg(e_aptypes_is_null_nr_str, *arg_cur, fmt);
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002807 return;
2808 }
2809
2810 p = ap_types[*arg_cur];
2811
2812 int fmt_type = format_typeof(p);
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002813
2814 // get parameter value, do initial processing
2815 switch (fmt_type)
2816 {
2817 case TYPE_PERCENT:
2818 case TYPE_UNKNOWN:
2819 break;
2820
2821 case TYPE_CHAR:
2822 va_arg(*ap, int);
2823 break;
2824
2825 case TYPE_STRING:
2826 va_arg(*ap, char *);
2827 break;
2828
2829 case TYPE_POINTER:
2830 va_arg(*ap, void *);
2831 break;
2832
2833 case TYPE_INT:
2834 va_arg(*ap, int);
2835 break;
2836
2837 case TYPE_LONGINT:
2838 va_arg(*ap, long int);
2839 break;
2840
2841 case TYPE_LONGLONGINT:
2842 va_arg(*ap, varnumber_T);
2843 break;
2844
2845 case TYPE_UNSIGNEDINT:
2846 va_arg(*ap, unsigned int);
2847 break;
2848
2849 case TYPE_UNSIGNEDLONGINT:
2850 va_arg(*ap, unsigned long int);
2851 break;
2852
2853 case TYPE_UNSIGNEDLONGLONGINT:
2854 va_arg(*ap, uvarnumber_T);
2855 break;
2856
2857 case TYPE_FLOAT:
2858 va_arg(*ap, double);
2859 break;
2860 }
2861 }
2862
2863 // Because we know that after we return from this call,
2864 // a va_arg() call is made, we can pre-emptively
2865 // increment the current argument index.
2866 ++*arg_cur;
2867 ++*arg_idx;
2868
2869 return;
2870}
2871
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002872 int
2873vim_vsnprintf_typval(
2874 char *str,
2875 size_t str_m,
2876 const char *fmt,
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002877 va_list ap_start,
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002878 typval_T *tvs)
2879{
2880 size_t str_l = 0;
2881 const char *p = fmt;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002882 int arg_cur = 0;
2883 int num_posarg = 0;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002884 int arg_idx = 1;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002885 va_list ap;
2886 const char **ap_types = NULL;
2887
2888 if (parse_fmt_types(&ap_types, &num_posarg, fmt, tvs) == FAIL)
2889 return 0;
2890
2891 va_copy(ap, ap_start);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002892
2893 if (p == NULL)
2894 p = "";
2895 while (*p != NUL)
2896 {
2897 if (*p != '%')
2898 {
2899 char *q = strchr(p + 1, '%');
2900 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2901
2902 // Copy up to the next '%' or NUL without any changes.
2903 if (str_l < str_m)
2904 {
2905 size_t avail = str_m - str_l;
2906
2907 mch_memmove(str + str_l, p, n > avail ? avail : n);
2908 }
2909 p += n;
2910 str_l += n;
2911 }
2912 else
2913 {
2914 size_t min_field_width = 0, precision = 0;
2915 int zero_padding = 0, precision_specified = 0, justify_left = 0;
2916 int alternate_form = 0, force_sign = 0;
2917
2918 // If both the ' ' and '+' flags appear, the ' ' flag should be
2919 // ignored.
2920 int space_for_positive = 1;
2921
2922 // allowed values: \0, h, l, L
2923 char length_modifier = '\0';
2924
2925 // temporary buffer for simple numeric->string conversion
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002926# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002927 // That sounds reasonable to use as the maximum
2928 // printable.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002929 char tmp[TMP_LEN];
2930
2931 // string address in case of string argument
2932 const char *str_arg = NULL;
2933
2934 // natural field width of arg without padding and sign
2935 size_t str_arg_l;
2936
2937 // unsigned char argument value - only defined for c conversion.
2938 // N.B. standard explicitly states the char argument for the c
2939 // conversion is unsigned
2940 unsigned char uchar_arg;
2941
2942 // number of zeros to be inserted for numeric conversions as
2943 // required by the precision or minimal field width
2944 size_t number_of_zeros_to_pad = 0;
2945
2946 // index into tmp where zero padding is to be inserted
2947 size_t zero_padding_insertion_ind = 0;
2948
2949 // current conversion specifier character
2950 char fmt_spec = '\0';
2951
2952 // buffer for 's' and 'S' specs
2953 char_u *tofree = NULL;
2954
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002955 // variables for positional arg
2956 int pos_arg = -1;
2957 const char *ptype;
2958
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002959
2960 p++; // skip '%'
2961
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002962 // First check to see if we find a positional
2963 // argument specifier
2964 ptype = p;
2965
2966 while (VIM_ISDIGIT(*ptype))
2967 ++ptype;
2968
2969 if (*ptype == '$')
2970 {
2971 // Positional argument
2972 unsigned int uj = *p++ - '0';
2973
2974 while (VIM_ISDIGIT((int)(*p)))
2975 uj = 10 * uj + (unsigned int)(*p++ - '0');
2976 pos_arg = uj;
2977
2978 ++p;
2979 }
2980
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002981 // parse flags
2982 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2983 || *p == '#' || *p == '\'')
2984 {
2985 switch (*p)
2986 {
2987 case '0': zero_padding = 1; break;
2988 case '-': justify_left = 1; break;
2989 case '+': force_sign = 1; space_for_positive = 0; break;
2990 case ' ': force_sign = 1;
2991 // If both the ' ' and '+' flags appear, the ' '
2992 // flag should be ignored
2993 break;
2994 case '#': alternate_form = 1; break;
2995 case '\'': break;
2996 }
2997 p++;
2998 }
2999 // If the '0' and '-' flags both appear, the '0' flag should be
3000 // ignored.
3001
3002 // parse field width
3003 if (*p == '*')
3004 {
3005 int j;
3006
3007 p++;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003008
3009 if (VIM_ISDIGIT((int)(*p)))
3010 {
3011 // Positional argument field width
3012 unsigned int uj = *p++ - '0';
3013
3014 while (VIM_ISDIGIT((int)(*p)))
3015 uj = 10 * uj + (unsigned int)(*p++ - '0');
3016 arg_idx = uj;
3017
3018 ++p;
3019 }
3020
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003021 j =
3022# if defined(FEAT_EVAL)
3023 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3024# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003025 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3026 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003027 va_arg(ap, int));
3028
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003029 if (j >= 0)
3030 min_field_width = j;
3031 else
3032 {
3033 min_field_width = -j;
3034 justify_left = 1;
3035 }
3036 }
3037 else if (VIM_ISDIGIT((int)(*p)))
3038 {
3039 // size_t could be wider than unsigned int; make sure we treat
3040 // argument like common implementations do
3041 unsigned int uj = *p++ - '0';
3042
3043 while (VIM_ISDIGIT((int)(*p)))
3044 uj = 10 * uj + (unsigned int)(*p++ - '0');
3045 min_field_width = uj;
3046 }
3047
3048 // parse precision
3049 if (*p == '.')
3050 {
3051 p++;
3052 precision_specified = 1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003053
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003054 if (VIM_ISDIGIT((int)(*p)))
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003055 {
3056 // size_t could be wider than unsigned int; make sure we
3057 // treat argument like common implementations do
3058 unsigned int uj = *p++ - '0';
3059
3060 while (VIM_ISDIGIT((int)(*p)))
3061 uj = 10 * uj + (unsigned int)(*p++ - '0');
3062 precision = uj;
3063 }
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003064 else if (*p == '*')
3065 {
3066 int j;
3067
3068 p++;
3069
3070 if (VIM_ISDIGIT((int)(*p)))
3071 {
3072 // positional argument
3073 unsigned int uj = *p++ - '0';
3074
3075 while (VIM_ISDIGIT((int)(*p)))
3076 uj = 10 * uj + (unsigned int)(*p++ - '0');
3077 arg_idx = uj;
3078
3079 ++p;
3080 }
3081
3082 j =
3083# if defined(FEAT_EVAL)
3084 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3085# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003086 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3087 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003088 va_arg(ap, int));
3089
3090 if (j >= 0)
3091 precision = j;
3092 else
3093 {
3094 precision_specified = 0;
3095 precision = 0;
3096 }
3097 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003098 }
3099
3100 // parse 'h', 'l' and 'll' length modifiers
3101 if (*p == 'h' || *p == 'l')
3102 {
3103 length_modifier = *p;
3104 p++;
3105 if (length_modifier == 'l' && *p == 'l')
3106 {
3107 // double l = __int64 / varnumber_T
3108 length_modifier = 'L';
3109 p++;
3110 }
3111 }
3112 fmt_spec = *p;
3113
3114 // common synonyms:
3115 switch (fmt_spec)
3116 {
3117 case 'i': fmt_spec = 'd'; break;
3118 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
3119 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
3120 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
3121 default: break;
3122 }
3123
3124# if defined(FEAT_EVAL)
3125 switch (fmt_spec)
3126 {
3127 case 'd': case 'u': case 'o': case 'x': case 'X':
3128 if (tvs != NULL && length_modifier == '\0')
3129 length_modifier = 'L';
3130 }
3131# endif
3132
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003133 if (pos_arg != -1)
3134 arg_idx = pos_arg;
3135
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003136 // get parameter value, do initial processing
3137 switch (fmt_spec)
3138 {
3139 // '%' and 'c' behave similar to 's' regarding flags and field
3140 // widths
3141 case '%':
3142 case 'c':
3143 case 's':
3144 case 'S':
3145 str_arg_l = 1;
3146 switch (fmt_spec)
3147 {
3148 case '%':
3149 str_arg = p;
3150 break;
3151
3152 case 'c':
3153 {
3154 int j;
3155
3156 j =
3157# if defined(FEAT_EVAL)
3158 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3159# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003160 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3161 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003162 va_arg(ap, int));
3163
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003164 // standard demands unsigned char
3165 uchar_arg = (unsigned char)j;
3166 str_arg = (char *)&uchar_arg;
3167 break;
3168 }
3169
3170 case 's':
3171 case 'S':
3172 str_arg =
3173# if defined(FEAT_EVAL)
3174 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
3175# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003176 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3177 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003178 va_arg(ap, char *));
3179
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003180 if (str_arg == NULL)
3181 {
3182 str_arg = "[NULL]";
3183 str_arg_l = 6;
3184 }
3185 // make sure not to address string beyond the specified
3186 // precision !!!
3187 else if (!precision_specified)
3188 str_arg_l = strlen(str_arg);
3189 // truncate string if necessary as requested by precision
3190 else if (precision == 0)
3191 str_arg_l = 0;
3192 else
3193 {
3194 // Don't put the #if inside memchr(), it can be a
3195 // macro.
3196 // memchr on HP does not like n > 2^31 !!!
3197 char *q = memchr(str_arg, '\0',
3198 precision <= (size_t)0x7fffffffL ? precision
3199 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00003200
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003201 str_arg_l = (q == NULL) ? precision
3202 : (size_t)(q - str_arg);
3203 }
3204 if (fmt_spec == 'S')
3205 {
presuku1f2453f2021-11-24 15:32:57 +00003206 char_u *p1;
3207 size_t i;
3208 int cell;
presukud85fccd2021-11-20 19:38:31 +00003209
presuku1f2453f2021-11-24 15:32:57 +00003210 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003211 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00003212 {
3213 cell = mb_ptr2cells(p1);
3214 if (precision_specified && i + cell > precision)
3215 break;
3216 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003217 }
presuku1f2453f2021-11-24 15:32:57 +00003218
3219 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00003220 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00003221 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003222 }
3223 break;
3224
3225 default:
3226 break;
3227 }
3228 break;
3229
3230 case 'd': case 'u':
3231 case 'b': case 'B':
3232 case 'o':
3233 case 'x': case 'X':
3234 case 'p':
3235 {
3236 // NOTE: the u, b, o, x, X and p conversion specifiers
3237 // imply the value is unsigned; d implies a signed
3238 // value
3239
3240 // 0 if numeric argument is zero (or if pointer is
3241 // NULL for 'p'), +1 if greater than zero (or nonzero
3242 // for unsigned arguments), -1 if negative (unsigned
3243 // argument is never negative)
3244 int arg_sign = 0;
3245
3246 // only set for length modifier h, or for no length
3247 // modifiers
3248 int int_arg = 0;
3249 unsigned int uint_arg = 0;
3250
3251 // only set for length modifier l
3252 long int long_arg = 0;
3253 unsigned long int ulong_arg = 0;
3254
3255 // only set for length modifier ll
3256 varnumber_T llong_arg = 0;
3257 uvarnumber_T ullong_arg = 0;
3258
3259 // only set for b conversion
3260 uvarnumber_T bin_arg = 0;
3261
3262 // pointer argument value -only defined for p
3263 // conversion
3264 void *ptr_arg = NULL;
3265
3266 if (fmt_spec == 'p')
3267 {
3268 length_modifier = '\0';
3269 ptr_arg =
3270# if defined(FEAT_EVAL)
3271 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
3272 NULL) :
3273# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003274 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3275 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003276 va_arg(ap, void *));
3277
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003278 if (ptr_arg != NULL)
3279 arg_sign = 1;
3280 }
3281 else if (fmt_spec == 'b' || fmt_spec == 'B')
3282 {
3283 bin_arg =
3284# if defined(FEAT_EVAL)
3285 tvs != NULL ?
3286 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
3287# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003288 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3289 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003290 va_arg(ap, uvarnumber_T));
3291
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003292 if (bin_arg != 0)
3293 arg_sign = 1;
3294 }
3295 else if (fmt_spec == 'd')
3296 {
3297 // signed
3298 switch (length_modifier)
3299 {
3300 case '\0':
3301 case 'h':
3302 // char and short arguments are passed as int.
3303 int_arg =
3304# if defined(FEAT_EVAL)
3305 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3306# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003307 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3308 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003309 va_arg(ap, int));
3310
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003311 if (int_arg > 0)
3312 arg_sign = 1;
3313 else if (int_arg < 0)
3314 arg_sign = -1;
3315 break;
3316 case 'l':
3317 long_arg =
3318# if defined(FEAT_EVAL)
3319 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3320# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003321 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3322 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003323 va_arg(ap, long int));
3324
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003325 if (long_arg > 0)
3326 arg_sign = 1;
3327 else if (long_arg < 0)
3328 arg_sign = -1;
3329 break;
3330 case 'L':
3331 llong_arg =
3332# if defined(FEAT_EVAL)
3333 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3334# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003335 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3336 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003337 va_arg(ap, varnumber_T));
3338
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003339 if (llong_arg > 0)
3340 arg_sign = 1;
3341 else if (llong_arg < 0)
3342 arg_sign = -1;
3343 break;
3344 }
3345 }
3346 else
3347 {
3348 // unsigned
3349 switch (length_modifier)
3350 {
3351 case '\0':
3352 case 'h':
3353 uint_arg =
3354# if defined(FEAT_EVAL)
3355 tvs != NULL ? (unsigned)
3356 tv_nr(tvs, &arg_idx) :
3357# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003358 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3359 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003360 va_arg(ap, unsigned int));
3361
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003362 if (uint_arg != 0)
3363 arg_sign = 1;
3364 break;
3365 case 'l':
3366 ulong_arg =
3367# if defined(FEAT_EVAL)
3368 tvs != NULL ? (unsigned long)
3369 tv_nr(tvs, &arg_idx) :
3370# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003371 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3372 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003373 va_arg(ap, unsigned long int));
3374
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003375 if (ulong_arg != 0)
3376 arg_sign = 1;
3377 break;
3378 case 'L':
3379 ullong_arg =
3380# if defined(FEAT_EVAL)
3381 tvs != NULL ? (uvarnumber_T)
3382 tv_nr(tvs, &arg_idx) :
3383# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003384 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3385 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003386 va_arg(ap, uvarnumber_T));
3387
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003388 if (ullong_arg != 0)
3389 arg_sign = 1;
3390 break;
3391 }
3392 }
3393
3394 str_arg = tmp;
3395 str_arg_l = 0;
3396
3397 // NOTE:
3398 // For d, i, u, o, x, and X conversions, if precision is
3399 // specified, the '0' flag should be ignored. This is so
3400 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
3401 // FreeBSD, NetBSD; but not with Perl.
3402 if (precision_specified)
3403 zero_padding = 0;
3404 if (fmt_spec == 'd')
3405 {
3406 if (force_sign && arg_sign >= 0)
3407 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
3408 // leave negative numbers for sprintf to handle, to
3409 // avoid handling tricky cases like (short int)-32768
3410 }
3411 else if (alternate_form)
3412 {
3413 if (arg_sign != 0
3414 && (fmt_spec == 'b' || fmt_spec == 'B'
3415 || fmt_spec == 'x' || fmt_spec == 'X') )
3416 {
3417 tmp[str_arg_l++] = '0';
3418 tmp[str_arg_l++] = fmt_spec;
3419 }
3420 // alternate form should have no effect for p
3421 // conversion, but ...
3422 }
3423
3424 zero_padding_insertion_ind = str_arg_l;
3425 if (!precision_specified)
3426 precision = 1; // default precision is 1
3427 if (precision == 0 && arg_sign == 0)
3428 {
3429 // When zero value is formatted with an explicit
3430 // precision 0, the resulting formatted string is
3431 // empty (d, i, u, b, B, o, x, X, p).
3432 }
3433 else
3434 {
3435 char f[6];
3436 int f_l = 0;
3437
3438 // construct a simple format string for sprintf
3439 f[f_l++] = '%';
3440 if (!length_modifier)
3441 ;
3442 else if (length_modifier == 'L')
3443 {
3444# ifdef MSWIN
3445 f[f_l++] = 'I';
3446 f[f_l++] = '6';
3447 f[f_l++] = '4';
3448# else
3449 f[f_l++] = 'l';
3450 f[f_l++] = 'l';
3451# endif
3452 }
3453 else
3454 f[f_l++] = length_modifier;
3455 f[f_l++] = fmt_spec;
3456 f[f_l++] = '\0';
3457
3458 if (fmt_spec == 'p')
3459 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
3460 else if (fmt_spec == 'b' || fmt_spec == 'B')
3461 {
3462 char b[8 * sizeof(uvarnumber_T)];
3463 size_t b_l = 0;
3464 uvarnumber_T bn = bin_arg;
3465
3466 do
3467 {
3468 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
3469 bn >>= 1;
3470 }
3471 while (bn != 0);
3472
3473 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
3474 str_arg_l += b_l;
3475 }
3476 else if (fmt_spec == 'd')
3477 {
3478 // signed
3479 switch (length_modifier)
3480 {
3481 case '\0': str_arg_l += sprintf(
3482 tmp + str_arg_l, f,
3483 int_arg);
3484 break;
3485 case 'h': str_arg_l += sprintf(
3486 tmp + str_arg_l, f,
3487 (short)int_arg);
3488 break;
3489 case 'l': str_arg_l += sprintf(
3490 tmp + str_arg_l, f, long_arg);
3491 break;
3492 case 'L': str_arg_l += sprintf(
3493 tmp + str_arg_l, f, llong_arg);
3494 break;
3495 }
3496 }
3497 else
3498 {
3499 // unsigned
3500 switch (length_modifier)
3501 {
3502 case '\0': str_arg_l += sprintf(
3503 tmp + str_arg_l, f,
3504 uint_arg);
3505 break;
3506 case 'h': str_arg_l += sprintf(
3507 tmp + str_arg_l, f,
3508 (unsigned short)uint_arg);
3509 break;
3510 case 'l': str_arg_l += sprintf(
3511 tmp + str_arg_l, f, ulong_arg);
3512 break;
3513 case 'L': str_arg_l += sprintf(
3514 tmp + str_arg_l, f, ullong_arg);
3515 break;
3516 }
3517 }
3518
3519 // include the optional minus sign and possible
3520 // "0x" in the region before the zero padding
3521 // insertion point
3522 if (zero_padding_insertion_ind < str_arg_l
3523 && tmp[zero_padding_insertion_ind] == '-')
3524 zero_padding_insertion_ind++;
3525 if (zero_padding_insertion_ind + 1 < str_arg_l
3526 && tmp[zero_padding_insertion_ind] == '0'
3527 && (tmp[zero_padding_insertion_ind + 1] == 'x'
3528 || tmp[zero_padding_insertion_ind + 1] == 'X'))
3529 zero_padding_insertion_ind += 2;
3530 }
3531
3532 {
3533 size_t num_of_digits = str_arg_l
3534 - zero_padding_insertion_ind;
3535
3536 if (alternate_form && fmt_spec == 'o'
3537 // unless zero is already the first
3538 // character
3539 && !(zero_padding_insertion_ind < str_arg_l
3540 && tmp[zero_padding_insertion_ind] == '0'))
3541 {
3542 // assure leading zero for alternate-form
3543 // octal numbers
3544 if (!precision_specified
3545 || precision < num_of_digits + 1)
3546 {
3547 // precision is increased to force the
3548 // first character to be zero, except if a
3549 // zero value is formatted with an
3550 // explicit precision of zero
3551 precision = num_of_digits + 1;
3552 }
3553 }
3554 // zero padding to specified precision?
3555 if (num_of_digits < precision)
3556 number_of_zeros_to_pad = precision - num_of_digits;
3557 }
3558 // zero padding to specified minimal field width?
3559 if (!justify_left && zero_padding)
3560 {
3561 int n = (int)(min_field_width - (str_arg_l
3562 + number_of_zeros_to_pad));
3563 if (n > 0)
3564 number_of_zeros_to_pad += n;
3565 }
3566 break;
3567 }
3568
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003569 case 'f':
3570 case 'F':
3571 case 'e':
3572 case 'E':
3573 case 'g':
3574 case 'G':
3575 {
3576 // Floating point.
3577 double f;
3578 double abs_f;
3579 char format[40];
3580 int l;
3581 int remove_trailing_zeroes = FALSE;
3582
3583 f =
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003584# if defined(FEAT_EVAL)
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003585 tvs != NULL ? tv_float(tvs, &arg_idx) :
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003586# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003587 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3588 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003589 va_arg(ap, double));
3590
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003591 abs_f = f < 0 ? -f : f;
3592
3593 if (fmt_spec == 'g' || fmt_spec == 'G')
3594 {
3595 // Would be nice to use %g directly, but it prints
3596 // "1.0" as "1", we don't want that.
3597 if ((abs_f >= 0.001 && abs_f < 10000000.0)
3598 || abs_f == 0.0)
3599 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
3600 else
3601 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
3602 remove_trailing_zeroes = TRUE;
3603 }
3604
3605 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003606# ifdef VAX
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003607 abs_f > 1.0e38
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003608# else
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003609 abs_f > 1.0e307
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003610# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003611 )
3612 {
3613 // Avoid a buffer overflow
3614 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
3615 force_sign, space_for_positive));
3616 str_arg_l = STRLEN(tmp);
3617 zero_padding = 0;
3618 }
3619 else
3620 {
3621 if (isnan(f))
3622 {
3623 // Not a number: nan or NAN
3624 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
3625 : "nan");
3626 str_arg_l = 3;
3627 zero_padding = 0;
3628 }
3629 else if (isinf(f))
3630 {
3631 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
3632 force_sign, space_for_positive));
3633 str_arg_l = STRLEN(tmp);
3634 zero_padding = 0;
3635 }
3636 else
3637 {
3638 // Regular float number
3639 format[0] = '%';
3640 l = 1;
3641 if (force_sign)
3642 format[l++] = space_for_positive ? ' ' : '+';
3643 if (precision_specified)
3644 {
3645 size_t max_prec = TMP_LEN - 10;
3646
3647 // Make sure we don't get more digits than we
3648 // have room for.
3649 if ((fmt_spec == 'f' || fmt_spec == 'F')
3650 && abs_f > 1.0)
3651 max_prec -= (size_t)log10(abs_f);
3652 if (precision > max_prec)
3653 precision = max_prec;
3654 l += sprintf(format + l, ".%d", (int)precision);
3655 }
3656 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
3657 format[l + 1] = NUL;
3658
3659 str_arg_l = sprintf(tmp, format, f);
3660 }
3661
3662 if (remove_trailing_zeroes)
3663 {
3664 int i;
3665 char *tp;
3666
3667 // Using %g or %G: remove superfluous zeroes.
3668 if (fmt_spec == 'f' || fmt_spec == 'F')
3669 tp = tmp + str_arg_l - 1;
3670 else
3671 {
3672 tp = (char *)vim_strchr((char_u *)tmp,
3673 fmt_spec == 'e' ? 'e' : 'E');
3674 if (tp != NULL)
3675 {
3676 // Remove superfluous '+' and leading
3677 // zeroes from the exponent.
3678 if (tp[1] == '+')
3679 {
3680 // Change "1.0e+07" to "1.0e07"
3681 STRMOVE(tp + 1, tp + 2);
3682 --str_arg_l;
3683 }
3684 i = (tp[1] == '-') ? 2 : 1;
3685 while (tp[i] == '0')
3686 {
3687 // Change "1.0e07" to "1.0e7"
3688 STRMOVE(tp + i, tp + i + 1);
3689 --str_arg_l;
3690 }
3691 --tp;
3692 }
3693 }
3694
3695 if (tp != NULL && !precision_specified)
3696 // Remove trailing zeroes, but keep the one
3697 // just after a dot.
3698 while (tp > tmp + 2 && *tp == '0'
3699 && tp[-1] != '.')
3700 {
3701 STRMOVE(tp, tp + 1);
3702 --tp;
3703 --str_arg_l;
3704 }
3705 }
3706 else
3707 {
3708 char *tp;
3709
3710 // Be consistent: some printf("%e") use 1.0e+12
3711 // and some 1.0e+012. Remove one zero in the last
3712 // case.
3713 tp = (char *)vim_strchr((char_u *)tmp,
3714 fmt_spec == 'e' ? 'e' : 'E');
3715 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
3716 && tp[2] == '0'
3717 && vim_isdigit(tp[3])
3718 && vim_isdigit(tp[4]))
3719 {
3720 STRMOVE(tp + 2, tp + 3);
3721 --str_arg_l;
3722 }
3723 }
3724 }
3725 if (zero_padding && min_field_width > str_arg_l
3726 && (tmp[0] == '-' || force_sign))
3727 {
3728 // padding 0's should be inserted after the sign
3729 number_of_zeros_to_pad = min_field_width - str_arg_l;
3730 zero_padding_insertion_ind = 1;
3731 }
3732 str_arg = tmp;
3733 break;
3734 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003735
3736 default:
3737 // unrecognized conversion specifier, keep format string
3738 // as-is
3739 zero_padding = 0; // turn zero padding off for non-numeric
3740 // conversion
3741 justify_left = 1;
3742 min_field_width = 0; // reset flags
3743
3744 // discard the unrecognized conversion, just keep *
3745 // the unrecognized conversion character
3746 str_arg = p;
3747 str_arg_l = 0;
3748 if (*p != NUL)
3749 str_arg_l++; // include invalid conversion specifier
3750 // unchanged if not at end-of-string
3751 break;
3752 }
3753
3754 if (*p != NUL)
3755 p++; // step over the just processed conversion specifier
3756
3757 // insert padding to the left as requested by min_field_width;
3758 // this does not include the zero padding in case of numerical
3759 // conversions
3760 if (!justify_left)
3761 {
3762 // left padding with blank or zero
3763 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
3764
3765 if (pn > 0)
3766 {
3767 if (str_l < str_m)
3768 {
3769 size_t avail = str_m - str_l;
3770
3771 vim_memset(str + str_l, zero_padding ? '0' : ' ',
3772 (size_t)pn > avail ? avail
3773 : (size_t)pn);
3774 }
3775 str_l += pn;
3776 }
3777 }
3778
3779 // zero padding as requested by the precision or by the minimal
3780 // field width for numeric conversions required?
3781 if (number_of_zeros_to_pad == 0)
3782 {
3783 // will not copy first part of numeric right now, *
3784 // force it to be copied later in its entirety
3785 zero_padding_insertion_ind = 0;
3786 }
3787 else
3788 {
3789 // insert first part of numerics (sign or '0x') before zero
3790 // padding
3791 int zn = (int)zero_padding_insertion_ind;
3792
3793 if (zn > 0)
3794 {
3795 if (str_l < str_m)
3796 {
3797 size_t avail = str_m - str_l;
3798
3799 mch_memmove(str + str_l, str_arg,
3800 (size_t)zn > avail ? avail
3801 : (size_t)zn);
3802 }
3803 str_l += zn;
3804 }
3805
3806 // insert zero padding as requested by the precision or min
3807 // field width
3808 zn = (int)number_of_zeros_to_pad;
3809 if (zn > 0)
3810 {
3811 if (str_l < str_m)
3812 {
3813 size_t avail = str_m - str_l;
3814
3815 vim_memset(str + str_l, '0',
3816 (size_t)zn > avail ? avail
3817 : (size_t)zn);
3818 }
3819 str_l += zn;
3820 }
3821 }
3822
3823 // insert formatted string
3824 // (or as-is conversion specifier for unknown conversions)
3825 {
3826 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
3827
3828 if (sn > 0)
3829 {
3830 if (str_l < str_m)
3831 {
3832 size_t avail = str_m - str_l;
3833
3834 mch_memmove(str + str_l,
3835 str_arg + zero_padding_insertion_ind,
3836 (size_t)sn > avail ? avail : (size_t)sn);
3837 }
3838 str_l += sn;
3839 }
3840 }
3841
3842 // insert right padding
3843 if (justify_left)
3844 {
3845 // right blank padding to the field width
3846 int pn = (int)(min_field_width
3847 - (str_arg_l + number_of_zeros_to_pad));
3848
3849 if (pn > 0)
3850 {
3851 if (str_l < str_m)
3852 {
3853 size_t avail = str_m - str_l;
3854
3855 vim_memset(str + str_l, ' ',
3856 (size_t)pn > avail ? avail
3857 : (size_t)pn);
3858 }
3859 str_l += pn;
3860 }
3861 }
3862 vim_free(tofree);
3863 }
3864 }
3865
3866 if (str_m > 0)
3867 {
3868 // make sure the string is nul-terminated even at the expense of
3869 // overwriting the last character (shouldn't happen, but just in case)
3870 //
3871 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
3872 }
3873
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003874 if (tvs != NULL && tvs[num_posarg != 0 ? num_posarg : arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar677658a2022-01-05 16:09:06 +00003875 emsg(_(e_too_many_arguments_to_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003876
K.Takata4c215ec2023-08-26 18:05:08 +02003877 vim_free((char*)ap_types);
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003878 va_end(ap);
3879
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003880 // Return the number of characters formatted (excluding trailing nul
3881 // character), that is, the number of characters that would have been
3882 // written to the buffer if it were large enough.
3883 return (int)str_l;
3884}
3885
3886#endif // PROTO