blob: 9e2c331bf4ed749788e36cc274a223285a89545a [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
773#if defined(FEAT_EVAL) || defined(PROTO)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200774/*
775 * Return string "str" in ' quotes, doubling ' characters.
776 * If "str" is NULL an empty string is assumed.
777 * If "function" is TRUE make it function('string').
778 */
779 char_u *
780string_quote(char_u *str, int function)
781{
782 unsigned len;
783 char_u *p, *r, *s;
784
785 len = (function ? 13 : 3);
786 if (str != NULL)
787 {
788 len += (unsigned)STRLEN(str);
789 for (p = str; *p != NUL; MB_PTR_ADV(p))
790 if (*p == '\'')
791 ++len;
792 }
793 s = r = alloc(len);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000794 if (r == NULL)
795 return NULL;
796
797 if (function)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200798 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000799 STRCPY(r, "function('");
800 r += 10;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200801 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000802 else
803 *r++ = '\'';
804 if (str != NULL)
805 for (p = str; *p != NUL; )
806 {
807 if (*p == '\'')
808 *r++ = '\'';
809 MB_COPY_CHAR(p, r);
810 }
811 *r++ = '\'';
812 if (function)
813 *r++ = ')';
814 *r++ = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200815 return s;
816}
817
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000818/*
819 * Count the number of times "needle" occurs in string "haystack". Case is
820 * ignored if "ic" is TRUE.
821 */
822 long
823string_count(char_u *haystack, char_u *needle, int ic)
824{
825 long n = 0;
826 char_u *p = haystack;
827 char_u *next;
828
829 if (p == NULL || needle == NULL || *needle == NUL)
830 return 0;
831
832 if (ic)
833 {
834 size_t len = STRLEN(needle);
835
836 while (*p != NUL)
837 {
838 if (MB_STRNICMP(p, needle, len) == 0)
839 {
840 ++n;
841 p += len;
842 }
843 else
844 MB_PTR_ADV(p);
845 }
846 }
847 else
848 while ((next = (char_u *)strstr((char *)p, (char *)needle)) != NULL)
849 {
850 ++n;
851 p = next + STRLEN(needle);
852 }
853
854 return n;
855}
856
857/*
Yegappan Lakshmanan03ff1c22023-05-06 14:08:21 +0100858 * Reverse the string in 'str' and set the result in 'rettv'.
859 */
860 void
861string_reverse(char_u *str, typval_T *rettv)
862{
863 rettv->v_type = VAR_STRING;
864 rettv->vval.v_string = NULL;
865 if (str == NULL)
866 return;
867
868 char_u *rstr = vim_strsave(str);
869 rettv->vval.v_string = rstr;
870 if (rstr == NULL || *str == NUL)
871 return;
872
873 size_t len = STRLEN(rstr);
874 if (has_mbyte)
875 {
876 char_u *src = str;
877 char_u *dest = rstr + len;
878
879 while (src < str + len)
880 {
881 int clen = mb_ptr2len(src);
882 dest -= clen;
883 mch_memmove(dest, src, (size_t)clen);
884 src += clen;
885 }
886 }
887 else
888 {
889 for (size_t i = 0; i < len / 2; i++)
890 {
891 char tmp = rstr[len - i - 1];
892 rstr[len - i - 1] = rstr[i];
893 rstr[i] = tmp;
894 }
895 }
896}
897
898/*
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000899 * Make a typval_T of the first character of "input" and store it in "output".
900 * Return OK or FAIL.
901 */
902 static int
903copy_first_char_to_tv(char_u *input, typval_T *output)
904{
905 char_u buf[MB_MAXBYTES + 1];
906 int len;
907
908 if (input == NULL || output == NULL)
909 return FAIL;
910
911 len = has_mbyte ? mb_ptr2len(input) : 1;
912 STRNCPY(buf, input, len);
913 buf[len] = NUL;
914 output->v_type = VAR_STRING;
915 output->vval.v_string = vim_strsave(buf);
916
917 return output->vval.v_string == NULL ? FAIL : OK;
918}
919
920/*
921 * Implementation of map() and filter() for a String. Apply "expr" to every
922 * character in string "str" and return the result in "rettv".
923 */
924 void
925string_filter_map(
926 char_u *str,
927 filtermap_T filtermap,
928 typval_T *expr,
929 typval_T *rettv)
930{
931 char_u *p;
932 typval_T tv;
933 garray_T ga;
934 int len = 0;
935 int idx = 0;
936 int rem;
Bram Moolenaar82418262022-09-28 16:16:15 +0100937 typval_T newtv;
938 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000939
940 rettv->v_type = VAR_STRING;
941 rettv->vval.v_string = NULL;
942
943 // set_vim_var_nr() doesn't set the type
944 set_vim_var_type(VV_KEY, VAR_NUMBER);
945
zeertzjqe7d49462023-04-16 20:53:55 +0100946 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +0100947 fc = eval_expr_get_funccal(expr, &newtv);
948
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000949 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000950 for (p = str; *p != NUL; p += len)
951 {
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000952 if (copy_first_char_to_tv(p, &tv) == FAIL)
953 break;
954 len = (int)STRLEN(tv.vval.v_string);
955
Bram Moolenaardd7eff02022-05-06 11:02:05 +0100956 newtv.v_type = VAR_UNKNOWN;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000957 set_vim_var_nr(VV_KEY, idx);
Bram Moolenaar82418262022-09-28 16:16:15 +0100958 if (filter_map_one(&tv, expr, filtermap, fc, &newtv, &rem) == FAIL
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000959 || did_emsg)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000960 {
961 clear_tv(&newtv);
962 clear_tv(&tv);
963 break;
964 }
965 else if (filtermap != FILTERMAP_FILTER)
966 {
967 if (newtv.v_type != VAR_STRING)
968 {
969 clear_tv(&newtv);
970 clear_tv(&tv);
Bram Moolenaare70cec92022-01-01 14:25:55 +0000971 emsg(_(e_string_required));
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000972 break;
973 }
974 else
975 ga_concat(&ga, newtv.vval.v_string);
976 }
977 else if (!rem)
978 ga_concat(&ga, tv.vval.v_string);
979
980 clear_tv(&newtv);
981 clear_tv(&tv);
982
983 ++idx;
984 }
985 ga_append(&ga, NUL);
986 rettv->vval.v_string = ga.ga_data;
Bram Moolenaar82418262022-09-28 16:16:15 +0100987 if (fc != NULL)
988 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000989}
990
991/*
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100992 * Implementation of reduce() for String "argvars[0]" using the function "expr"
993 * starting with the optional initial value "argvars[2]" and return the result
994 * in "rettv".
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000995 */
996 void
997string_reduce(
998 typval_T *argvars,
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100999 typval_T *expr,
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001000 typval_T *rettv)
1001{
1002 char_u *p = tv_get_string(&argvars[0]);
1003 int len;
1004 typval_T argv[3];
1005 int r;
1006 int called_emsg_start = called_emsg;
Bram Moolenaar82418262022-09-28 16:16:15 +01001007 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001008
1009 if (argvars[2].v_type == VAR_UNKNOWN)
1010 {
1011 if (*p == NUL)
1012 {
Bram Moolenaare70cec92022-01-01 14:25:55 +00001013 semsg(_(e_reduce_of_an_empty_str_with_no_initial_value), "String");
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001014 return;
1015 }
1016 if (copy_first_char_to_tv(p, rettv) == FAIL)
1017 return;
1018 p += STRLEN(rettv->vval.v_string);
1019 }
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001020 else if (check_for_string_arg(argvars, 2) == FAIL)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001021 return;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001022 else
1023 copy_tv(&argvars[2], rettv);
1024
zeertzjqe7d49462023-04-16 20:53:55 +01001025 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +01001026 fc = eval_expr_get_funccal(expr, rettv);
1027
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001028 for ( ; *p != NUL; p += len)
1029 {
1030 argv[0] = *rettv;
1031 if (copy_first_char_to_tv(p, &argv[1]) == FAIL)
1032 break;
1033 len = (int)STRLEN(argv[1].vval.v_string);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001034
Bram Moolenaar82418262022-09-28 16:16:15 +01001035 r = eval_expr_typval(expr, argv, 2, fc, rettv);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001036
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001037 clear_tv(&argv[0]);
1038 clear_tv(&argv[1]);
1039 if (r == FAIL || called_emsg != called_emsg_start)
1040 return;
1041 }
Bram Moolenaar82418262022-09-28 16:16:15 +01001042
1043 if (fc != NULL)
1044 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001045}
1046
Bram Moolenaare4098452023-05-07 18:53:49 +01001047/*
1048 * Implementation of "byteidx()" and "byteidxcomp()" functions
1049 */
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001050 static void
Bram Moolenaare4098452023-05-07 18:53:49 +01001051byteidx_common(typval_T *argvars, typval_T *rettv, int comp UNUSED)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001052{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001053 rettv->vval.v_number = -1;
1054
1055 if (in_vim9script()
1056 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001057 || check_for_number_arg(argvars, 1) == FAIL
1058 || check_for_opt_bool_arg(argvars, 2) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001059 return;
1060
Christian Brabandt67672ef2023-04-24 21:09:54 +01001061 char_u *str = tv_get_string_chk(&argvars[0]);
1062 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001063 if (str == NULL || idx < 0)
1064 return;
1065
Christian Brabandt67672ef2023-04-24 21:09:54 +01001066 varnumber_T utf16idx = FALSE;
1067 if (argvars[2].v_type != VAR_UNKNOWN)
1068 {
zeertzjq8cf51372023-05-08 15:31:38 +01001069 int error = FALSE;
1070 utf16idx = tv_get_bool_chk(&argvars[2], &error);
1071 if (error)
1072 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001073 if (utf16idx < 0 || utf16idx > 1)
1074 {
zeertzjq8cf51372023-05-08 15:31:38 +01001075 semsg(_(e_using_number_as_bool_nr), utf16idx);
Christian Brabandt67672ef2023-04-24 21:09:54 +01001076 return;
1077 }
1078 }
1079
1080 int (*ptr2len)(char_u *);
1081 if (enc_utf8 && comp)
1082 ptr2len = utf_ptr2len;
1083 else
1084 ptr2len = mb_ptr2len;
1085
1086 char_u *t = str;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001087 for ( ; idx > 0; idx--)
1088 {
1089 if (*t == NUL) // EOL reached
1090 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001091 if (utf16idx)
1092 {
1093 int clen = ptr2len(t);
1094 int c = (clen > 1) ? utf_ptr2char(t) : *t;
1095 if (c > 0xFFFF)
1096 idx--;
1097 }
1098 if (idx > 0)
1099 t += ptr2len(t);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001100 }
1101 rettv->vval.v_number = (varnumber_T)(t - str);
1102}
1103
1104/*
1105 * "byteidx()" function
1106 */
1107 void
1108f_byteidx(typval_T *argvars, typval_T *rettv)
1109{
Bram Moolenaare4098452023-05-07 18:53:49 +01001110 byteidx_common(argvars, rettv, FALSE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001111}
1112
1113/*
1114 * "byteidxcomp()" function
1115 */
1116 void
1117f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1118{
Bram Moolenaare4098452023-05-07 18:53:49 +01001119 byteidx_common(argvars, rettv, TRUE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001120}
1121
1122/*
1123 * "charidx()" function
1124 */
1125 void
1126f_charidx(typval_T *argvars, typval_T *rettv)
1127{
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001128 rettv->vval.v_number = -1;
1129
Christian Brabandt67672ef2023-04-24 21:09:54 +01001130 if (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001131 || check_for_number_arg(argvars, 1) == FAIL
Christian Brabandt67672ef2023-04-24 21:09:54 +01001132 || check_for_opt_bool_arg(argvars, 2) == FAIL
1133 || (argvars[2].v_type != VAR_UNKNOWN
1134 && check_for_opt_bool_arg(argvars, 3) == FAIL))
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001135 return;
1136
Christian Brabandt67672ef2023-04-24 21:09:54 +01001137 char_u *str = tv_get_string_chk(&argvars[0]);
1138 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001139 if (str == NULL || idx < 0)
1140 return;
1141
Christian Brabandt67672ef2023-04-24 21:09:54 +01001142 varnumber_T countcc = FALSE;
1143 varnumber_T utf16idx = FALSE;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001144 if (argvars[2].v_type != VAR_UNKNOWN)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001145 {
Christian Brabandt67672ef2023-04-24 21:09:54 +01001146 countcc = tv_get_bool(&argvars[2]);
1147 if (argvars[3].v_type != VAR_UNKNOWN)
1148 utf16idx = tv_get_bool(&argvars[3]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001149 }
1150
Christian Brabandt67672ef2023-04-24 21:09:54 +01001151 int (*ptr2len)(char_u *);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001152 if (enc_utf8 && countcc)
1153 ptr2len = utf_ptr2len;
1154 else
1155 ptr2len = mb_ptr2len;
1156
Christian Brabandt67672ef2023-04-24 21:09:54 +01001157 char_u *p;
1158 int len;
1159 for (p = str, len = 0; utf16idx ? idx >= 0 : p <= str + idx; len++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001160 {
1161 if (*p == NUL)
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001162 {
1163 // If the index is exactly the number of bytes or utf-16 code units
1164 // in the string then return the length of the string in
1165 // characters.
1166 if (utf16idx ? (idx == 0) : (p == (str + idx)))
1167 rettv->vval.v_number = len;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001168 return;
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001169 }
Christian Brabandt67672ef2023-04-24 21:09:54 +01001170 if (utf16idx)
1171 {
1172 idx--;
1173 int clen = ptr2len(p);
1174 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1175 if (c > 0xFFFF)
1176 idx--;
1177 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001178 p += ptr2len(p);
1179 }
1180
1181 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1182}
1183
1184/*
1185 * "str2list()" function
1186 */
1187 void
1188f_str2list(typval_T *argvars, typval_T *rettv)
1189{
1190 char_u *p;
1191 int utf8 = FALSE;
1192
1193 if (rettv_list_alloc(rettv) == FAIL)
1194 return;
1195
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001196 if (in_vim9script()
1197 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001198 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001199 return;
1200
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001201 if (argvars[1].v_type != VAR_UNKNOWN)
1202 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1203
1204 p = tv_get_string(&argvars[0]);
1205
1206 if (has_mbyte || utf8)
1207 {
1208 int (*ptr2len)(char_u *);
1209 int (*ptr2char)(char_u *);
1210
1211 if (utf8 || enc_utf8)
1212 {
1213 ptr2len = utf_ptr2len;
1214 ptr2char = utf_ptr2char;
1215 }
1216 else
1217 {
1218 ptr2len = mb_ptr2len;
1219 ptr2char = mb_ptr2char;
1220 }
1221
1222 for ( ; *p != NUL; p += (*ptr2len)(p))
1223 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1224 }
1225 else
1226 for ( ; *p != NUL; ++p)
1227 list_append_number(rettv->vval.v_list, *p);
1228}
1229
1230/*
1231 * "str2nr()" function
1232 */
1233 void
1234f_str2nr(typval_T *argvars, typval_T *rettv)
1235{
1236 int base = 10;
1237 char_u *p;
1238 varnumber_T n;
1239 int what = 0;
1240 int isneg;
1241
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001242 if (in_vim9script()
1243 && (check_for_string_arg(argvars, 0) == FAIL
1244 || check_for_opt_number_arg(argvars, 1) == FAIL
1245 || (argvars[1].v_type != VAR_UNKNOWN
1246 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1247 return;
1248
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001249 if (argvars[1].v_type != VAR_UNKNOWN)
1250 {
1251 base = (int)tv_get_number(&argvars[1]);
1252 if (base != 2 && base != 8 && base != 10 && base != 16)
1253 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001254 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001255 return;
1256 }
1257 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1258 what |= STR2NR_QUOTE;
1259 }
1260
1261 p = skipwhite(tv_get_string_strict(&argvars[0]));
1262 isneg = (*p == '-');
1263 if (*p == '+' || *p == '-')
1264 p = skipwhite(p + 1);
1265 switch (base)
1266 {
1267 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1268 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1269 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1270 }
Bram Moolenaar5fb78c32023-03-04 20:47:39 +00001271 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE, NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001272 // Text after the number is silently ignored.
1273 if (isneg)
1274 rettv->vval.v_number = -n;
1275 else
1276 rettv->vval.v_number = n;
1277
1278}
1279
1280/*
1281 * "strgetchar()" function
1282 */
1283 void
1284f_strgetchar(typval_T *argvars, typval_T *rettv)
1285{
1286 char_u *str;
1287 int len;
1288 int error = FALSE;
1289 int charidx;
1290 int byteidx = 0;
1291
1292 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001293
1294 if (in_vim9script()
1295 && (check_for_string_arg(argvars, 0) == FAIL
1296 || check_for_number_arg(argvars, 1) == FAIL))
1297 return;
1298
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001299 str = tv_get_string_chk(&argvars[0]);
1300 if (str == NULL)
1301 return;
1302 len = (int)STRLEN(str);
1303 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1304 if (error)
1305 return;
1306
1307 while (charidx >= 0 && byteidx < len)
1308 {
1309 if (charidx == 0)
1310 {
1311 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1312 break;
1313 }
1314 --charidx;
1315 byteidx += MB_CPTR2LEN(str + byteidx);
1316 }
1317}
1318
1319/*
1320 * "stridx()" function
1321 */
1322 void
1323f_stridx(typval_T *argvars, typval_T *rettv)
1324{
1325 char_u buf[NUMBUFLEN];
1326 char_u *needle;
1327 char_u *haystack;
1328 char_u *save_haystack;
1329 char_u *pos;
1330 int start_idx;
1331
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001332 if (in_vim9script()
1333 && (check_for_string_arg(argvars, 0) == FAIL
1334 || check_for_string_arg(argvars, 1) == FAIL
1335 || check_for_opt_number_arg(argvars, 2) == FAIL))
1336 return;
1337
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001338 needle = tv_get_string_chk(&argvars[1]);
1339 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1340 rettv->vval.v_number = -1;
1341 if (needle == NULL || haystack == NULL)
1342 return; // type error; errmsg already given
1343
1344 if (argvars[2].v_type != VAR_UNKNOWN)
1345 {
1346 int error = FALSE;
1347
1348 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1349 if (error || start_idx >= (int)STRLEN(haystack))
1350 return;
1351 if (start_idx >= 0)
1352 haystack += start_idx;
1353 }
1354
1355 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1356 if (pos != NULL)
1357 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1358}
1359
1360/*
1361 * "string()" function
1362 */
1363 void
1364f_string(typval_T *argvars, typval_T *rettv)
1365{
1366 char_u *tofree;
1367 char_u numbuf[NUMBUFLEN];
1368
1369 rettv->v_type = VAR_STRING;
1370 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1371 get_copyID());
1372 // Make a copy if we have a value but it's not in allocated memory.
1373 if (rettv->vval.v_string != NULL && tofree == NULL)
1374 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1375}
1376
1377/*
1378 * "strlen()" function
1379 */
1380 void
1381f_strlen(typval_T *argvars, typval_T *rettv)
1382{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001383 if (in_vim9script()
1384 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1385 return;
1386
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001387 rettv->vval.v_number = (varnumber_T)(STRLEN(
1388 tv_get_string(&argvars[0])));
1389}
1390
1391 static void
1392strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1393{
1394 char_u *s = tv_get_string(&argvars[0]);
1395 varnumber_T len = 0;
1396 int (*func_mb_ptr2char_adv)(char_u **pp);
1397
1398 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1399 while (*s != NUL)
1400 {
1401 func_mb_ptr2char_adv(&s);
1402 ++len;
1403 }
1404 rettv->vval.v_number = len;
1405}
1406
1407/*
1408 * "strcharlen()" function
1409 */
1410 void
1411f_strcharlen(typval_T *argvars, typval_T *rettv)
1412{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001413 if (in_vim9script()
1414 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1415 return;
1416
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001417 strchar_common(argvars, rettv, TRUE);
1418}
1419
1420/*
1421 * "strchars()" function
1422 */
1423 void
1424f_strchars(typval_T *argvars, typval_T *rettv)
1425{
1426 varnumber_T skipcc = FALSE;
1427
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001428 if (in_vim9script()
1429 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001430 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001431 return;
1432
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001433 if (argvars[1].v_type != VAR_UNKNOWN)
Bram Moolenaare4098452023-05-07 18:53:49 +01001434 {
zeertzjq8cf51372023-05-08 15:31:38 +01001435 int error = FALSE;
1436 skipcc = tv_get_bool_chk(&argvars[1], &error);
1437 if (error)
1438 return;
1439 if (skipcc < 0 || skipcc > 1)
1440 {
Bram Moolenaare4098452023-05-07 18:53:49 +01001441 semsg(_(e_using_number_as_bool_nr), skipcc);
zeertzjq8cf51372023-05-08 15:31:38 +01001442 return;
1443 }
Bram Moolenaare4098452023-05-07 18:53:49 +01001444 }
zeertzjq8cf51372023-05-08 15:31:38 +01001445
1446 strchar_common(argvars, rettv, skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001447}
1448
1449/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001450 * "strutf16len()" function
1451 */
1452 void
1453f_strutf16len(typval_T *argvars, typval_T *rettv)
1454{
1455 rettv->vval.v_number = -1;
1456
1457 if (check_for_string_arg(argvars, 0) == FAIL
1458 || check_for_opt_bool_arg(argvars, 1) == FAIL)
1459 return;
1460
1461 varnumber_T countcc = FALSE;
1462 if (argvars[1].v_type != VAR_UNKNOWN)
1463 countcc = tv_get_bool(&argvars[1]);
1464
1465 char_u *s = tv_get_string(&argvars[0]);
1466 varnumber_T len = 0;
1467 int (*func_mb_ptr2char_adv)(char_u **pp);
1468 int ch;
1469
1470 func_mb_ptr2char_adv = countcc ? mb_cptr2char_adv : mb_ptr2char_adv;
1471 while (*s != NUL)
1472 {
1473 ch = func_mb_ptr2char_adv(&s);
1474 if (ch > 0xFFFF)
1475 ++len;
1476 ++len;
1477 }
1478 rettv->vval.v_number = len;
1479}
1480
1481/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001482 * "strdisplaywidth()" function
1483 */
1484 void
1485f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1486{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001487 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001488 int col = 0;
1489
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001490 rettv->vval.v_number = -1;
1491
1492 if (in_vim9script()
1493 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001494 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001495 return;
1496
1497 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001498 if (argvars[1].v_type != VAR_UNKNOWN)
1499 col = (int)tv_get_number(&argvars[1]);
1500
1501 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1502}
1503
1504/*
1505 * "strwidth()" function
1506 */
1507 void
1508f_strwidth(typval_T *argvars, typval_T *rettv)
1509{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001510 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001511
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001512 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1513 return;
1514
1515 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001516 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1517}
1518
1519/*
1520 * "strcharpart()" function
1521 */
1522 void
1523f_strcharpart(typval_T *argvars, typval_T *rettv)
1524{
1525 char_u *p;
1526 int nchar;
1527 int nbyte = 0;
1528 int charlen;
1529 int skipcc = FALSE;
1530 int len = 0;
1531 int slen;
1532 int error = FALSE;
1533
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001534 if (in_vim9script()
1535 && (check_for_string_arg(argvars, 0) == FAIL
1536 || check_for_number_arg(argvars, 1) == FAIL
1537 || check_for_opt_number_arg(argvars, 2) == FAIL
1538 || (argvars[2].v_type != VAR_UNKNOWN
1539 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1540 return;
1541
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001542 p = tv_get_string(&argvars[0]);
1543 slen = (int)STRLEN(p);
1544
1545 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1546 if (!error)
1547 {
1548 if (argvars[2].v_type != VAR_UNKNOWN
1549 && argvars[3].v_type != VAR_UNKNOWN)
1550 {
zeertzjq8cf51372023-05-08 15:31:38 +01001551 skipcc = tv_get_bool_chk(&argvars[3], &error);
1552 if (error)
1553 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001554 if (skipcc < 0 || skipcc > 1)
1555 {
zeertzjq8cf51372023-05-08 15:31:38 +01001556 semsg(_(e_using_number_as_bool_nr), skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001557 return;
1558 }
1559 }
1560
1561 if (nchar > 0)
1562 while (nchar > 0 && nbyte < slen)
1563 {
1564 if (skipcc)
1565 nbyte += mb_ptr2len(p + nbyte);
1566 else
1567 nbyte += MB_CPTR2LEN(p + nbyte);
1568 --nchar;
1569 }
1570 else
1571 nbyte = nchar;
1572 if (argvars[2].v_type != VAR_UNKNOWN)
1573 {
1574 charlen = (int)tv_get_number(&argvars[2]);
1575 while (charlen > 0 && nbyte + len < slen)
1576 {
1577 int off = nbyte + len;
1578
1579 if (off < 0)
1580 len += 1;
1581 else
1582 {
1583 if (skipcc)
1584 len += mb_ptr2len(p + off);
1585 else
1586 len += MB_CPTR2LEN(p + off);
1587 }
1588 --charlen;
1589 }
1590 }
1591 else
1592 len = slen - nbyte; // default: all bytes that are available.
1593 }
1594
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001595 // Only return the overlap between the specified part and the actual
1596 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001597 if (nbyte < 0)
1598 {
1599 len += nbyte;
1600 nbyte = 0;
1601 }
1602 else if (nbyte > slen)
1603 nbyte = slen;
1604 if (len < 0)
1605 len = 0;
1606 else if (nbyte + len > slen)
1607 len = slen - nbyte;
1608
1609 rettv->v_type = VAR_STRING;
1610 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1611}
1612
1613/*
1614 * "strpart()" function
1615 */
1616 void
1617f_strpart(typval_T *argvars, typval_T *rettv)
1618{
1619 char_u *p;
1620 int n;
1621 int len;
1622 int slen;
1623 int error = FALSE;
1624
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001625 if (in_vim9script()
1626 && (check_for_string_arg(argvars, 0) == FAIL
1627 || check_for_number_arg(argvars, 1) == FAIL
1628 || check_for_opt_number_arg(argvars, 2) == FAIL
1629 || (argvars[2].v_type != VAR_UNKNOWN
1630 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1631 return;
1632
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001633 p = tv_get_string(&argvars[0]);
1634 slen = (int)STRLEN(p);
1635
1636 n = (int)tv_get_number_chk(&argvars[1], &error);
1637 if (error)
1638 len = 0;
1639 else if (argvars[2].v_type != VAR_UNKNOWN)
1640 len = (int)tv_get_number(&argvars[2]);
1641 else
1642 len = slen - n; // default len: all bytes that are available.
1643
1644 // Only return the overlap between the specified part and the actual
1645 // string.
1646 if (n < 0)
1647 {
1648 len += n;
1649 n = 0;
1650 }
1651 else if (n > slen)
1652 n = slen;
1653 if (len < 0)
1654 len = 0;
1655 else if (n + len > slen)
1656 len = slen - n;
1657
1658 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1659 {
1660 int off;
1661
1662 // length in characters
1663 for (off = n; off < slen && len > 0; --len)
1664 off += mb_ptr2len(p + off);
1665 len = off - n;
1666 }
1667
1668 rettv->v_type = VAR_STRING;
1669 rettv->vval.v_string = vim_strnsave(p + n, len);
1670}
1671
1672/*
1673 * "strridx()" function
1674 */
1675 void
1676f_strridx(typval_T *argvars, typval_T *rettv)
1677{
1678 char_u buf[NUMBUFLEN];
1679 char_u *needle;
1680 char_u *haystack;
1681 char_u *rest;
1682 char_u *lastmatch = NULL;
1683 int haystack_len, end_idx;
1684
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001685 if (in_vim9script()
1686 && (check_for_string_arg(argvars, 0) == FAIL
1687 || check_for_string_arg(argvars, 1) == FAIL
1688 || check_for_opt_number_arg(argvars, 2) == FAIL))
1689 return;
1690
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001691 needle = tv_get_string_chk(&argvars[1]);
1692 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1693
1694 rettv->vval.v_number = -1;
1695 if (needle == NULL || haystack == NULL)
1696 return; // type error; errmsg already given
1697
1698 haystack_len = (int)STRLEN(haystack);
1699 if (argvars[2].v_type != VAR_UNKNOWN)
1700 {
1701 // Third argument: upper limit for index
1702 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1703 if (end_idx < 0)
1704 return; // can never find a match
1705 }
1706 else
1707 end_idx = haystack_len;
1708
1709 if (*needle == NUL)
1710 {
1711 // Empty string matches past the end.
1712 lastmatch = haystack + end_idx;
1713 }
1714 else
1715 {
1716 for (rest = haystack; *rest != '\0'; ++rest)
1717 {
1718 rest = (char_u *)strstr((char *)rest, (char *)needle);
1719 if (rest == NULL || rest > haystack + end_idx)
1720 break;
1721 lastmatch = rest;
1722 }
1723 }
1724
1725 if (lastmatch == NULL)
1726 rettv->vval.v_number = -1;
1727 else
1728 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1729}
1730
1731/*
1732 * "strtrans()" function
1733 */
1734 void
1735f_strtrans(typval_T *argvars, typval_T *rettv)
1736{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001737 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1738 return;
1739
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001740 rettv->v_type = VAR_STRING;
1741 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1742}
1743
Christian Brabandt67672ef2023-04-24 21:09:54 +01001744
1745/*
1746 *
1747 * "utf16idx()" function
1748 */
1749 void
1750f_utf16idx(typval_T *argvars, typval_T *rettv)
1751{
1752 rettv->vval.v_number = -1;
1753
1754 if (check_for_string_arg(argvars, 0) == FAIL
1755 || check_for_opt_number_arg(argvars, 1) == FAIL
1756 || check_for_opt_bool_arg(argvars, 2) == FAIL
1757 || (argvars[2].v_type != VAR_UNKNOWN
1758 && check_for_opt_bool_arg(argvars, 3) == FAIL))
1759 return;
1760
1761 char_u *str = tv_get_string_chk(&argvars[0]);
1762 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
1763 if (str == NULL || idx < 0)
1764 return;
1765
1766 varnumber_T countcc = FALSE;
1767 varnumber_T charidx = FALSE;
1768 if (argvars[2].v_type != VAR_UNKNOWN)
1769 {
1770 countcc = tv_get_bool(&argvars[2]);
1771 if (argvars[3].v_type != VAR_UNKNOWN)
1772 charidx = tv_get_bool(&argvars[3]);
1773 }
1774
1775 int (*ptr2len)(char_u *);
1776 if (enc_utf8 && countcc)
1777 ptr2len = utf_ptr2len;
1778 else
1779 ptr2len = mb_ptr2len;
1780
1781 char_u *p;
1782 int len;
1783 for (p = str, len = 0; charidx ? idx >= 0 : p <= str + idx; len++)
1784 {
1785 if (*p == NUL)
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001786 {
1787 // If the index is exactly the number of bytes or characters in the
1788 // string then return the length of the string in utf-16 code
1789 // units.
1790 if (charidx ? (idx == 0) : (p == (str + idx)))
1791 rettv->vval.v_number = len;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001792 return;
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001793 }
Christian Brabandt67672ef2023-04-24 21:09:54 +01001794 int clen = ptr2len(p);
1795 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1796 if (c > 0xFFFF)
1797 len++;
1798 p += ptr2len(p);
1799 if (charidx)
1800 idx--;
1801 }
1802
1803 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1804}
1805
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001806/*
1807 * "tolower(string)" function
1808 */
1809 void
1810f_tolower(typval_T *argvars, typval_T *rettv)
1811{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001812 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1813 return;
1814
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001815 rettv->v_type = VAR_STRING;
1816 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1817}
1818
1819/*
1820 * "toupper(string)" function
1821 */
1822 void
1823f_toupper(typval_T *argvars, typval_T *rettv)
1824{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001825 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1826 return;
1827
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001828 rettv->v_type = VAR_STRING;
1829 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1830}
1831
1832/*
1833 * "tr(string, fromstr, tostr)" function
1834 */
1835 void
1836f_tr(typval_T *argvars, typval_T *rettv)
1837{
1838 char_u *in_str;
1839 char_u *fromstr;
1840 char_u *tostr;
1841 char_u *p;
1842 int inlen;
1843 int fromlen;
1844 int tolen;
1845 int idx;
1846 char_u *cpstr;
1847 int cplen;
1848 int first = TRUE;
1849 char_u buf[NUMBUFLEN];
1850 char_u buf2[NUMBUFLEN];
1851 garray_T ga;
1852
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001853 if (in_vim9script()
1854 && (check_for_string_arg(argvars, 0) == FAIL
1855 || check_for_string_arg(argvars, 1) == FAIL
1856 || check_for_string_arg(argvars, 2) == FAIL))
1857 return;
1858
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001859 in_str = tv_get_string(&argvars[0]);
1860 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1861 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1862
1863 // Default return value: empty string.
1864 rettv->v_type = VAR_STRING;
1865 rettv->vval.v_string = NULL;
1866 if (fromstr == NULL || tostr == NULL)
1867 return; // type error; errmsg already given
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001868 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001869
1870 if (!has_mbyte)
1871 // not multi-byte: fromstr and tostr must be the same length
1872 if (STRLEN(fromstr) != STRLEN(tostr))
1873 {
1874error:
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001875 semsg(_(e_invalid_argument_str), fromstr);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001876 ga_clear(&ga);
1877 return;
1878 }
1879
1880 // fromstr and tostr have to contain the same number of chars
1881 while (*in_str != NUL)
1882 {
1883 if (has_mbyte)
1884 {
1885 inlen = (*mb_ptr2len)(in_str);
1886 cpstr = in_str;
1887 cplen = inlen;
1888 idx = 0;
1889 for (p = fromstr; *p != NUL; p += fromlen)
1890 {
1891 fromlen = (*mb_ptr2len)(p);
1892 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1893 {
1894 for (p = tostr; *p != NUL; p += tolen)
1895 {
1896 tolen = (*mb_ptr2len)(p);
1897 if (idx-- == 0)
1898 {
1899 cplen = tolen;
1900 cpstr = p;
1901 break;
1902 }
1903 }
1904 if (*p == NUL) // tostr is shorter than fromstr
1905 goto error;
1906 break;
1907 }
1908 ++idx;
1909 }
1910
1911 if (first && cpstr == in_str)
1912 {
1913 // Check that fromstr and tostr have the same number of
1914 // (multi-byte) characters. Done only once when a character
1915 // of in_str doesn't appear in fromstr.
1916 first = FALSE;
1917 for (p = tostr; *p != NUL; p += tolen)
1918 {
1919 tolen = (*mb_ptr2len)(p);
1920 --idx;
1921 }
1922 if (idx != 0)
1923 goto error;
1924 }
1925
1926 (void)ga_grow(&ga, cplen);
1927 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1928 ga.ga_len += cplen;
1929
1930 in_str += inlen;
1931 }
1932 else
1933 {
1934 // When not using multi-byte chars we can do it faster.
1935 p = vim_strchr(fromstr, *in_str);
1936 if (p != NULL)
1937 ga_append(&ga, tostr[p - fromstr]);
1938 else
1939 ga_append(&ga, *in_str);
1940 ++in_str;
1941 }
1942 }
1943
1944 // add a terminating NUL
1945 (void)ga_grow(&ga, 1);
1946 ga_append(&ga, NUL);
1947
1948 rettv->vval.v_string = ga.ga_data;
1949}
1950
1951/*
1952 * "trim({expr})" function
1953 */
1954 void
1955f_trim(typval_T *argvars, typval_T *rettv)
1956{
1957 char_u buf1[NUMBUFLEN];
1958 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001959 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001960 char_u *mask = NULL;
1961 char_u *tail;
1962 char_u *prev;
1963 char_u *p;
1964 int c1;
1965 int dir = 0;
1966
1967 rettv->v_type = VAR_STRING;
1968 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001969
1970 if (in_vim9script()
1971 && (check_for_string_arg(argvars, 0) == FAIL
1972 || check_for_opt_string_arg(argvars, 1) == FAIL
1973 || (argvars[1].v_type != VAR_UNKNOWN
1974 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1975 return;
1976
1977 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001978 if (head == NULL)
1979 return;
1980
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001981 if (check_for_opt_string_arg(argvars, 1) == FAIL)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001982 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001983
1984 if (argvars[1].v_type == VAR_STRING)
1985 {
1986 mask = tv_get_string_buf_chk(&argvars[1], buf2);
1987
1988 if (argvars[2].v_type != VAR_UNKNOWN)
1989 {
1990 int error = 0;
1991
1992 // leading or trailing characters to trim
1993 dir = (int)tv_get_number_chk(&argvars[2], &error);
1994 if (error)
1995 return;
1996 if (dir < 0 || dir > 2)
1997 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001998 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[2]));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001999 return;
2000 }
2001 }
2002 }
2003
2004 if (dir == 0 || dir == 1)
2005 {
2006 // Trim leading characters
2007 while (*head != NUL)
2008 {
2009 c1 = PTR2CHAR(head);
2010 if (mask == NULL)
2011 {
2012 if (c1 > ' ' && c1 != 0xa0)
2013 break;
2014 }
2015 else
2016 {
2017 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2018 if (c1 == PTR2CHAR(p))
2019 break;
2020 if (*p == NUL)
2021 break;
2022 }
2023 MB_PTR_ADV(head);
2024 }
2025 }
2026
2027 tail = head + STRLEN(head);
2028 if (dir == 0 || dir == 2)
2029 {
2030 // Trim trailing characters
2031 for (; tail > head; tail = prev)
2032 {
2033 prev = tail;
2034 MB_PTR_BACK(head, prev);
2035 c1 = PTR2CHAR(prev);
2036 if (mask == NULL)
2037 {
2038 if (c1 > ' ' && c1 != 0xa0)
2039 break;
2040 }
2041 else
2042 {
2043 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2044 if (c1 == PTR2CHAR(p))
2045 break;
2046 if (*p == NUL)
2047 break;
2048 }
2049 }
2050 }
2051 rettv->vval.v_string = vim_strnsave(head, tail - head);
2052}
2053
Bram Moolenaar677658a2022-01-05 16:09:06 +00002054static char *e_printf = N_(e_insufficient_arguments_for_printf);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002055
2056/*
2057 * Get number argument from "idxp" entry in "tvs". First entry is 1.
2058 */
2059 static varnumber_T
2060tv_nr(typval_T *tvs, int *idxp)
2061{
2062 int idx = *idxp - 1;
2063 varnumber_T n = 0;
2064 int err = FALSE;
2065
2066 if (tvs[idx].v_type == VAR_UNKNOWN)
2067 emsg(_(e_printf));
2068 else
2069 {
2070 ++*idxp;
2071 n = tv_get_number_chk(&tvs[idx], &err);
2072 if (err)
2073 n = 0;
2074 }
2075 return n;
2076}
2077
2078/*
2079 * Get string argument from "idxp" entry in "tvs". First entry is 1.
2080 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
2081 * are not converted to a string.
2082 * If "tofree" is not NULL echo_string() is used. All types are converted to
2083 * a string with the same format as ":echo". The caller must free "*tofree".
2084 * Returns NULL for an error.
2085 */
2086 static char *
2087tv_str(typval_T *tvs, int *idxp, char_u **tofree)
2088{
2089 int idx = *idxp - 1;
2090 char *s = NULL;
2091 static char_u numbuf[NUMBUFLEN];
2092
2093 if (tvs[idx].v_type == VAR_UNKNOWN)
2094 emsg(_(e_printf));
2095 else
2096 {
2097 ++*idxp;
2098 if (tofree != NULL)
2099 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
2100 else
2101 s = (char *)tv_get_string_chk(&tvs[idx]);
2102 }
2103 return s;
2104}
2105
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002106/*
2107 * Get float argument from "idxp" entry in "tvs". First entry is 1.
2108 */
2109 static double
2110tv_float(typval_T *tvs, int *idxp)
2111{
2112 int idx = *idxp - 1;
2113 double f = 0;
2114
2115 if (tvs[idx].v_type == VAR_UNKNOWN)
2116 emsg(_(e_printf));
2117 else
2118 {
2119 ++*idxp;
2120 if (tvs[idx].v_type == VAR_FLOAT)
2121 f = tvs[idx].vval.v_float;
2122 else if (tvs[idx].v_type == VAR_NUMBER)
2123 f = (double)tvs[idx].vval.v_number;
2124 else
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00002125 emsg(_(e_expected_float_argument_for_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002126 }
2127 return f;
2128}
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00002129
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002130#endif
2131
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002132/*
2133 * Return the representation of infinity for printf() function:
2134 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
2135 */
2136 static const char *
2137infinity_str(int positive,
2138 char fmt_spec,
2139 int force_sign,
2140 int space_for_positive)
2141{
2142 static const char *table[] =
2143 {
2144 "-inf", "inf", "+inf", " inf",
2145 "-INF", "INF", "+INF", " INF"
2146 };
2147 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
2148
2149 if (ASCII_ISUPPER(fmt_spec))
2150 idx += 4;
2151 return table[idx];
2152}
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002153
2154/*
2155 * This code was included to provide a portable vsnprintf() and snprintf().
2156 * Some systems may provide their own, but we always use this one for
2157 * consistency.
2158 *
2159 * This code is based on snprintf.c - a portable implementation of snprintf
2160 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
2161 * Included with permission. It was heavily modified to fit in Vim.
2162 * The original code, including useful comments, can be found here:
2163 * http://www.ijs.si/software/snprintf/
2164 *
2165 * This snprintf() only supports the following conversion specifiers:
2166 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
2167 * with flags: '-', '+', ' ', '0' and '#'.
2168 * An asterisk is supported for field width as well as precision.
2169 *
2170 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
2171 *
2172 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
2173 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
2174 *
2175 * The locale is not used, the string is used as a byte string. This is only
2176 * relevant for double-byte encodings where the second byte may be '%'.
2177 *
2178 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
2179 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
2180 *
2181 * The return value is the number of characters which would be generated
2182 * for the given input, excluding the trailing NUL. If this value
2183 * is greater or equal to "str_m", not all characters from the result
2184 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
2185 * are discarded. If "str_m" is greater than zero it is guaranteed
2186 * the resulting string will be NUL-terminated.
2187 */
2188
2189/*
2190 * When va_list is not supported we only define vim_snprintf().
2191 *
2192 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2193 * "typval_T". When the latter is not used it must be NULL.
2194 */
2195
2196// When generating prototypes all of this is skipped, cproto doesn't
2197// understand this.
2198#ifndef PROTO
2199
2200// Like vim_vsnprintf() but append to the string.
2201 int
2202vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2203{
2204 va_list ap;
2205 int str_l;
2206 size_t len = STRLEN(str);
2207 size_t space;
2208
2209 if (str_m <= len)
2210 space = 0;
2211 else
2212 space = str_m - len;
2213 va_start(ap, fmt);
2214 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2215 va_end(ap);
2216 return str_l;
2217}
2218
2219 int
2220vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2221{
2222 va_list ap;
2223 int str_l;
2224
2225 va_start(ap, fmt);
2226 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2227 va_end(ap);
2228 return str_l;
2229}
2230
2231 int
2232vim_vsnprintf(
2233 char *str,
2234 size_t str_m,
2235 const char *fmt,
2236 va_list ap)
2237{
2238 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2239}
2240
2241 int
2242vim_vsnprintf_typval(
2243 char *str,
2244 size_t str_m,
2245 const char *fmt,
2246 va_list ap,
2247 typval_T *tvs)
2248{
2249 size_t str_l = 0;
2250 const char *p = fmt;
2251 int arg_idx = 1;
2252
2253 if (p == NULL)
2254 p = "";
2255 while (*p != NUL)
2256 {
2257 if (*p != '%')
2258 {
2259 char *q = strchr(p + 1, '%');
2260 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2261
2262 // Copy up to the next '%' or NUL without any changes.
2263 if (str_l < str_m)
2264 {
2265 size_t avail = str_m - str_l;
2266
2267 mch_memmove(str + str_l, p, n > avail ? avail : n);
2268 }
2269 p += n;
2270 str_l += n;
2271 }
2272 else
2273 {
2274 size_t min_field_width = 0, precision = 0;
2275 int zero_padding = 0, precision_specified = 0, justify_left = 0;
2276 int alternate_form = 0, force_sign = 0;
2277
2278 // If both the ' ' and '+' flags appear, the ' ' flag should be
2279 // ignored.
2280 int space_for_positive = 1;
2281
2282 // allowed values: \0, h, l, L
2283 char length_modifier = '\0';
2284
2285 // temporary buffer for simple numeric->string conversion
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002286# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002287 // That sounds reasonable to use as the maximum
2288 // printable.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002289 char tmp[TMP_LEN];
2290
2291 // string address in case of string argument
2292 const char *str_arg = NULL;
2293
2294 // natural field width of arg without padding and sign
2295 size_t str_arg_l;
2296
2297 // unsigned char argument value - only defined for c conversion.
2298 // N.B. standard explicitly states the char argument for the c
2299 // conversion is unsigned
2300 unsigned char uchar_arg;
2301
2302 // number of zeros to be inserted for numeric conversions as
2303 // required by the precision or minimal field width
2304 size_t number_of_zeros_to_pad = 0;
2305
2306 // index into tmp where zero padding is to be inserted
2307 size_t zero_padding_insertion_ind = 0;
2308
2309 // current conversion specifier character
2310 char fmt_spec = '\0';
2311
2312 // buffer for 's' and 'S' specs
2313 char_u *tofree = NULL;
2314
2315
2316 p++; // skip '%'
2317
2318 // parse flags
2319 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2320 || *p == '#' || *p == '\'')
2321 {
2322 switch (*p)
2323 {
2324 case '0': zero_padding = 1; break;
2325 case '-': justify_left = 1; break;
2326 case '+': force_sign = 1; space_for_positive = 0; break;
2327 case ' ': force_sign = 1;
2328 // If both the ' ' and '+' flags appear, the ' '
2329 // flag should be ignored
2330 break;
2331 case '#': alternate_form = 1; break;
2332 case '\'': break;
2333 }
2334 p++;
2335 }
2336 // If the '0' and '-' flags both appear, the '0' flag should be
2337 // ignored.
2338
2339 // parse field width
2340 if (*p == '*')
2341 {
2342 int j;
2343
2344 p++;
2345 j =
2346# if defined(FEAT_EVAL)
2347 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2348# endif
2349 va_arg(ap, int);
2350 if (j >= 0)
2351 min_field_width = j;
2352 else
2353 {
2354 min_field_width = -j;
2355 justify_left = 1;
2356 }
2357 }
2358 else if (VIM_ISDIGIT((int)(*p)))
2359 {
2360 // size_t could be wider than unsigned int; make sure we treat
2361 // argument like common implementations do
2362 unsigned int uj = *p++ - '0';
2363
2364 while (VIM_ISDIGIT((int)(*p)))
2365 uj = 10 * uj + (unsigned int)(*p++ - '0');
2366 min_field_width = uj;
2367 }
2368
2369 // parse precision
2370 if (*p == '.')
2371 {
2372 p++;
2373 precision_specified = 1;
2374 if (*p == '*')
2375 {
2376 int j;
2377
2378 j =
2379# if defined(FEAT_EVAL)
2380 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2381# endif
2382 va_arg(ap, int);
2383 p++;
2384 if (j >= 0)
2385 precision = j;
2386 else
2387 {
2388 precision_specified = 0;
2389 precision = 0;
2390 }
2391 }
2392 else if (VIM_ISDIGIT((int)(*p)))
2393 {
2394 // size_t could be wider than unsigned int; make sure we
2395 // treat argument like common implementations do
2396 unsigned int uj = *p++ - '0';
2397
2398 while (VIM_ISDIGIT((int)(*p)))
2399 uj = 10 * uj + (unsigned int)(*p++ - '0');
2400 precision = uj;
2401 }
2402 }
2403
2404 // parse 'h', 'l' and 'll' length modifiers
2405 if (*p == 'h' || *p == 'l')
2406 {
2407 length_modifier = *p;
2408 p++;
2409 if (length_modifier == 'l' && *p == 'l')
2410 {
2411 // double l = __int64 / varnumber_T
2412 length_modifier = 'L';
2413 p++;
2414 }
2415 }
2416 fmt_spec = *p;
2417
2418 // common synonyms:
2419 switch (fmt_spec)
2420 {
2421 case 'i': fmt_spec = 'd'; break;
2422 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2423 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2424 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2425 default: break;
2426 }
2427
2428# if defined(FEAT_EVAL)
2429 switch (fmt_spec)
2430 {
2431 case 'd': case 'u': case 'o': case 'x': case 'X':
2432 if (tvs != NULL && length_modifier == '\0')
2433 length_modifier = 'L';
2434 }
2435# endif
2436
2437 // get parameter value, do initial processing
2438 switch (fmt_spec)
2439 {
2440 // '%' and 'c' behave similar to 's' regarding flags and field
2441 // widths
2442 case '%':
2443 case 'c':
2444 case 's':
2445 case 'S':
2446 str_arg_l = 1;
2447 switch (fmt_spec)
2448 {
2449 case '%':
2450 str_arg = p;
2451 break;
2452
2453 case 'c':
2454 {
2455 int j;
2456
2457 j =
2458# if defined(FEAT_EVAL)
2459 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2460# endif
2461 va_arg(ap, int);
2462 // standard demands unsigned char
2463 uchar_arg = (unsigned char)j;
2464 str_arg = (char *)&uchar_arg;
2465 break;
2466 }
2467
2468 case 's':
2469 case 'S':
2470 str_arg =
2471# if defined(FEAT_EVAL)
2472 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
2473# endif
2474 va_arg(ap, char *);
2475 if (str_arg == NULL)
2476 {
2477 str_arg = "[NULL]";
2478 str_arg_l = 6;
2479 }
2480 // make sure not to address string beyond the specified
2481 // precision !!!
2482 else if (!precision_specified)
2483 str_arg_l = strlen(str_arg);
2484 // truncate string if necessary as requested by precision
2485 else if (precision == 0)
2486 str_arg_l = 0;
2487 else
2488 {
2489 // Don't put the #if inside memchr(), it can be a
2490 // macro.
2491 // memchr on HP does not like n > 2^31 !!!
2492 char *q = memchr(str_arg, '\0',
2493 precision <= (size_t)0x7fffffffL ? precision
2494 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00002495
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002496 str_arg_l = (q == NULL) ? precision
2497 : (size_t)(q - str_arg);
2498 }
2499 if (fmt_spec == 'S')
2500 {
presuku1f2453f2021-11-24 15:32:57 +00002501 char_u *p1;
2502 size_t i;
2503 int cell;
presukud85fccd2021-11-20 19:38:31 +00002504
presuku1f2453f2021-11-24 15:32:57 +00002505 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002506 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00002507 {
2508 cell = mb_ptr2cells(p1);
2509 if (precision_specified && i + cell > precision)
2510 break;
2511 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002512 }
presuku1f2453f2021-11-24 15:32:57 +00002513
2514 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00002515 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00002516 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002517 }
2518 break;
2519
2520 default:
2521 break;
2522 }
2523 break;
2524
2525 case 'd': case 'u':
2526 case 'b': case 'B':
2527 case 'o':
2528 case 'x': case 'X':
2529 case 'p':
2530 {
2531 // NOTE: the u, b, o, x, X and p conversion specifiers
2532 // imply the value is unsigned; d implies a signed
2533 // value
2534
2535 // 0 if numeric argument is zero (or if pointer is
2536 // NULL for 'p'), +1 if greater than zero (or nonzero
2537 // for unsigned arguments), -1 if negative (unsigned
2538 // argument is never negative)
2539 int arg_sign = 0;
2540
2541 // only set for length modifier h, or for no length
2542 // modifiers
2543 int int_arg = 0;
2544 unsigned int uint_arg = 0;
2545
2546 // only set for length modifier l
2547 long int long_arg = 0;
2548 unsigned long int ulong_arg = 0;
2549
2550 // only set for length modifier ll
2551 varnumber_T llong_arg = 0;
2552 uvarnumber_T ullong_arg = 0;
2553
2554 // only set for b conversion
2555 uvarnumber_T bin_arg = 0;
2556
2557 // pointer argument value -only defined for p
2558 // conversion
2559 void *ptr_arg = NULL;
2560
2561 if (fmt_spec == 'p')
2562 {
2563 length_modifier = '\0';
2564 ptr_arg =
2565# if defined(FEAT_EVAL)
2566 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
2567 NULL) :
2568# endif
2569 va_arg(ap, void *);
2570 if (ptr_arg != NULL)
2571 arg_sign = 1;
2572 }
2573 else if (fmt_spec == 'b' || fmt_spec == 'B')
2574 {
2575 bin_arg =
2576# if defined(FEAT_EVAL)
2577 tvs != NULL ?
2578 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
2579# endif
2580 va_arg(ap, uvarnumber_T);
2581 if (bin_arg != 0)
2582 arg_sign = 1;
2583 }
2584 else if (fmt_spec == 'd')
2585 {
2586 // signed
2587 switch (length_modifier)
2588 {
2589 case '\0':
2590 case 'h':
2591 // char and short arguments are passed as int.
2592 int_arg =
2593# if defined(FEAT_EVAL)
2594 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2595# endif
2596 va_arg(ap, int);
2597 if (int_arg > 0)
2598 arg_sign = 1;
2599 else if (int_arg < 0)
2600 arg_sign = -1;
2601 break;
2602 case 'l':
2603 long_arg =
2604# if defined(FEAT_EVAL)
2605 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2606# endif
2607 va_arg(ap, long int);
2608 if (long_arg > 0)
2609 arg_sign = 1;
2610 else if (long_arg < 0)
2611 arg_sign = -1;
2612 break;
2613 case 'L':
2614 llong_arg =
2615# if defined(FEAT_EVAL)
2616 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2617# endif
2618 va_arg(ap, varnumber_T);
2619 if (llong_arg > 0)
2620 arg_sign = 1;
2621 else if (llong_arg < 0)
2622 arg_sign = -1;
2623 break;
2624 }
2625 }
2626 else
2627 {
2628 // unsigned
2629 switch (length_modifier)
2630 {
2631 case '\0':
2632 case 'h':
2633 uint_arg =
2634# if defined(FEAT_EVAL)
2635 tvs != NULL ? (unsigned)
2636 tv_nr(tvs, &arg_idx) :
2637# endif
2638 va_arg(ap, unsigned int);
2639 if (uint_arg != 0)
2640 arg_sign = 1;
2641 break;
2642 case 'l':
2643 ulong_arg =
2644# if defined(FEAT_EVAL)
2645 tvs != NULL ? (unsigned long)
2646 tv_nr(tvs, &arg_idx) :
2647# endif
2648 va_arg(ap, unsigned long int);
2649 if (ulong_arg != 0)
2650 arg_sign = 1;
2651 break;
2652 case 'L':
2653 ullong_arg =
2654# if defined(FEAT_EVAL)
2655 tvs != NULL ? (uvarnumber_T)
2656 tv_nr(tvs, &arg_idx) :
2657# endif
2658 va_arg(ap, uvarnumber_T);
2659 if (ullong_arg != 0)
2660 arg_sign = 1;
2661 break;
2662 }
2663 }
2664
2665 str_arg = tmp;
2666 str_arg_l = 0;
2667
2668 // NOTE:
2669 // For d, i, u, o, x, and X conversions, if precision is
2670 // specified, the '0' flag should be ignored. This is so
2671 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
2672 // FreeBSD, NetBSD; but not with Perl.
2673 if (precision_specified)
2674 zero_padding = 0;
2675 if (fmt_spec == 'd')
2676 {
2677 if (force_sign && arg_sign >= 0)
2678 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
2679 // leave negative numbers for sprintf to handle, to
2680 // avoid handling tricky cases like (short int)-32768
2681 }
2682 else if (alternate_form)
2683 {
2684 if (arg_sign != 0
2685 && (fmt_spec == 'b' || fmt_spec == 'B'
2686 || fmt_spec == 'x' || fmt_spec == 'X') )
2687 {
2688 tmp[str_arg_l++] = '0';
2689 tmp[str_arg_l++] = fmt_spec;
2690 }
2691 // alternate form should have no effect for p
2692 // conversion, but ...
2693 }
2694
2695 zero_padding_insertion_ind = str_arg_l;
2696 if (!precision_specified)
2697 precision = 1; // default precision is 1
2698 if (precision == 0 && arg_sign == 0)
2699 {
2700 // When zero value is formatted with an explicit
2701 // precision 0, the resulting formatted string is
2702 // empty (d, i, u, b, B, o, x, X, p).
2703 }
2704 else
2705 {
2706 char f[6];
2707 int f_l = 0;
2708
2709 // construct a simple format string for sprintf
2710 f[f_l++] = '%';
2711 if (!length_modifier)
2712 ;
2713 else if (length_modifier == 'L')
2714 {
2715# ifdef MSWIN
2716 f[f_l++] = 'I';
2717 f[f_l++] = '6';
2718 f[f_l++] = '4';
2719# else
2720 f[f_l++] = 'l';
2721 f[f_l++] = 'l';
2722# endif
2723 }
2724 else
2725 f[f_l++] = length_modifier;
2726 f[f_l++] = fmt_spec;
2727 f[f_l++] = '\0';
2728
2729 if (fmt_spec == 'p')
2730 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
2731 else if (fmt_spec == 'b' || fmt_spec == 'B')
2732 {
2733 char b[8 * sizeof(uvarnumber_T)];
2734 size_t b_l = 0;
2735 uvarnumber_T bn = bin_arg;
2736
2737 do
2738 {
2739 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
2740 bn >>= 1;
2741 }
2742 while (bn != 0);
2743
2744 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
2745 str_arg_l += b_l;
2746 }
2747 else if (fmt_spec == 'd')
2748 {
2749 // signed
2750 switch (length_modifier)
2751 {
2752 case '\0': str_arg_l += sprintf(
2753 tmp + str_arg_l, f,
2754 int_arg);
2755 break;
2756 case 'h': str_arg_l += sprintf(
2757 tmp + str_arg_l, f,
2758 (short)int_arg);
2759 break;
2760 case 'l': str_arg_l += sprintf(
2761 tmp + str_arg_l, f, long_arg);
2762 break;
2763 case 'L': str_arg_l += sprintf(
2764 tmp + str_arg_l, f, llong_arg);
2765 break;
2766 }
2767 }
2768 else
2769 {
2770 // unsigned
2771 switch (length_modifier)
2772 {
2773 case '\0': str_arg_l += sprintf(
2774 tmp + str_arg_l, f,
2775 uint_arg);
2776 break;
2777 case 'h': str_arg_l += sprintf(
2778 tmp + str_arg_l, f,
2779 (unsigned short)uint_arg);
2780 break;
2781 case 'l': str_arg_l += sprintf(
2782 tmp + str_arg_l, f, ulong_arg);
2783 break;
2784 case 'L': str_arg_l += sprintf(
2785 tmp + str_arg_l, f, ullong_arg);
2786 break;
2787 }
2788 }
2789
2790 // include the optional minus sign and possible
2791 // "0x" in the region before the zero padding
2792 // insertion point
2793 if (zero_padding_insertion_ind < str_arg_l
2794 && tmp[zero_padding_insertion_ind] == '-')
2795 zero_padding_insertion_ind++;
2796 if (zero_padding_insertion_ind + 1 < str_arg_l
2797 && tmp[zero_padding_insertion_ind] == '0'
2798 && (tmp[zero_padding_insertion_ind + 1] == 'x'
2799 || tmp[zero_padding_insertion_ind + 1] == 'X'))
2800 zero_padding_insertion_ind += 2;
2801 }
2802
2803 {
2804 size_t num_of_digits = str_arg_l
2805 - zero_padding_insertion_ind;
2806
2807 if (alternate_form && fmt_spec == 'o'
2808 // unless zero is already the first
2809 // character
2810 && !(zero_padding_insertion_ind < str_arg_l
2811 && tmp[zero_padding_insertion_ind] == '0'))
2812 {
2813 // assure leading zero for alternate-form
2814 // octal numbers
2815 if (!precision_specified
2816 || precision < num_of_digits + 1)
2817 {
2818 // precision is increased to force the
2819 // first character to be zero, except if a
2820 // zero value is formatted with an
2821 // explicit precision of zero
2822 precision = num_of_digits + 1;
2823 }
2824 }
2825 // zero padding to specified precision?
2826 if (num_of_digits < precision)
2827 number_of_zeros_to_pad = precision - num_of_digits;
2828 }
2829 // zero padding to specified minimal field width?
2830 if (!justify_left && zero_padding)
2831 {
2832 int n = (int)(min_field_width - (str_arg_l
2833 + number_of_zeros_to_pad));
2834 if (n > 0)
2835 number_of_zeros_to_pad += n;
2836 }
2837 break;
2838 }
2839
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002840 case 'f':
2841 case 'F':
2842 case 'e':
2843 case 'E':
2844 case 'g':
2845 case 'G':
2846 {
2847 // Floating point.
2848 double f;
2849 double abs_f;
2850 char format[40];
2851 int l;
2852 int remove_trailing_zeroes = FALSE;
2853
2854 f =
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002855# if defined(FEAT_EVAL)
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002856 tvs != NULL ? tv_float(tvs, &arg_idx) :
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002857# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002858 va_arg(ap, double);
2859 abs_f = f < 0 ? -f : f;
2860
2861 if (fmt_spec == 'g' || fmt_spec == 'G')
2862 {
2863 // Would be nice to use %g directly, but it prints
2864 // "1.0" as "1", we don't want that.
2865 if ((abs_f >= 0.001 && abs_f < 10000000.0)
2866 || abs_f == 0.0)
2867 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
2868 else
2869 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
2870 remove_trailing_zeroes = TRUE;
2871 }
2872
2873 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002874# ifdef VAX
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002875 abs_f > 1.0e38
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002876# else
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002877 abs_f > 1.0e307
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002878# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002879 )
2880 {
2881 // Avoid a buffer overflow
2882 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2883 force_sign, space_for_positive));
2884 str_arg_l = STRLEN(tmp);
2885 zero_padding = 0;
2886 }
2887 else
2888 {
2889 if (isnan(f))
2890 {
2891 // Not a number: nan or NAN
2892 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
2893 : "nan");
2894 str_arg_l = 3;
2895 zero_padding = 0;
2896 }
2897 else if (isinf(f))
2898 {
2899 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2900 force_sign, space_for_positive));
2901 str_arg_l = STRLEN(tmp);
2902 zero_padding = 0;
2903 }
2904 else
2905 {
2906 // Regular float number
2907 format[0] = '%';
2908 l = 1;
2909 if (force_sign)
2910 format[l++] = space_for_positive ? ' ' : '+';
2911 if (precision_specified)
2912 {
2913 size_t max_prec = TMP_LEN - 10;
2914
2915 // Make sure we don't get more digits than we
2916 // have room for.
2917 if ((fmt_spec == 'f' || fmt_spec == 'F')
2918 && abs_f > 1.0)
2919 max_prec -= (size_t)log10(abs_f);
2920 if (precision > max_prec)
2921 precision = max_prec;
2922 l += sprintf(format + l, ".%d", (int)precision);
2923 }
2924 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
2925 format[l + 1] = NUL;
2926
2927 str_arg_l = sprintf(tmp, format, f);
2928 }
2929
2930 if (remove_trailing_zeroes)
2931 {
2932 int i;
2933 char *tp;
2934
2935 // Using %g or %G: remove superfluous zeroes.
2936 if (fmt_spec == 'f' || fmt_spec == 'F')
2937 tp = tmp + str_arg_l - 1;
2938 else
2939 {
2940 tp = (char *)vim_strchr((char_u *)tmp,
2941 fmt_spec == 'e' ? 'e' : 'E');
2942 if (tp != NULL)
2943 {
2944 // Remove superfluous '+' and leading
2945 // zeroes from the exponent.
2946 if (tp[1] == '+')
2947 {
2948 // Change "1.0e+07" to "1.0e07"
2949 STRMOVE(tp + 1, tp + 2);
2950 --str_arg_l;
2951 }
2952 i = (tp[1] == '-') ? 2 : 1;
2953 while (tp[i] == '0')
2954 {
2955 // Change "1.0e07" to "1.0e7"
2956 STRMOVE(tp + i, tp + i + 1);
2957 --str_arg_l;
2958 }
2959 --tp;
2960 }
2961 }
2962
2963 if (tp != NULL && !precision_specified)
2964 // Remove trailing zeroes, but keep the one
2965 // just after a dot.
2966 while (tp > tmp + 2 && *tp == '0'
2967 && tp[-1] != '.')
2968 {
2969 STRMOVE(tp, tp + 1);
2970 --tp;
2971 --str_arg_l;
2972 }
2973 }
2974 else
2975 {
2976 char *tp;
2977
2978 // Be consistent: some printf("%e") use 1.0e+12
2979 // and some 1.0e+012. Remove one zero in the last
2980 // case.
2981 tp = (char *)vim_strchr((char_u *)tmp,
2982 fmt_spec == 'e' ? 'e' : 'E');
2983 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
2984 && tp[2] == '0'
2985 && vim_isdigit(tp[3])
2986 && vim_isdigit(tp[4]))
2987 {
2988 STRMOVE(tp + 2, tp + 3);
2989 --str_arg_l;
2990 }
2991 }
2992 }
2993 if (zero_padding && min_field_width > str_arg_l
2994 && (tmp[0] == '-' || force_sign))
2995 {
2996 // padding 0's should be inserted after the sign
2997 number_of_zeros_to_pad = min_field_width - str_arg_l;
2998 zero_padding_insertion_ind = 1;
2999 }
3000 str_arg = tmp;
3001 break;
3002 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003003
3004 default:
3005 // unrecognized conversion specifier, keep format string
3006 // as-is
3007 zero_padding = 0; // turn zero padding off for non-numeric
3008 // conversion
3009 justify_left = 1;
3010 min_field_width = 0; // reset flags
3011
3012 // discard the unrecognized conversion, just keep *
3013 // the unrecognized conversion character
3014 str_arg = p;
3015 str_arg_l = 0;
3016 if (*p != NUL)
3017 str_arg_l++; // include invalid conversion specifier
3018 // unchanged if not at end-of-string
3019 break;
3020 }
3021
3022 if (*p != NUL)
3023 p++; // step over the just processed conversion specifier
3024
3025 // insert padding to the left as requested by min_field_width;
3026 // this does not include the zero padding in case of numerical
3027 // conversions
3028 if (!justify_left)
3029 {
3030 // left padding with blank or zero
3031 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
3032
3033 if (pn > 0)
3034 {
3035 if (str_l < str_m)
3036 {
3037 size_t avail = str_m - str_l;
3038
3039 vim_memset(str + str_l, zero_padding ? '0' : ' ',
3040 (size_t)pn > avail ? avail
3041 : (size_t)pn);
3042 }
3043 str_l += pn;
3044 }
3045 }
3046
3047 // zero padding as requested by the precision or by the minimal
3048 // field width for numeric conversions required?
3049 if (number_of_zeros_to_pad == 0)
3050 {
3051 // will not copy first part of numeric right now, *
3052 // force it to be copied later in its entirety
3053 zero_padding_insertion_ind = 0;
3054 }
3055 else
3056 {
3057 // insert first part of numerics (sign or '0x') before zero
3058 // padding
3059 int zn = (int)zero_padding_insertion_ind;
3060
3061 if (zn > 0)
3062 {
3063 if (str_l < str_m)
3064 {
3065 size_t avail = str_m - str_l;
3066
3067 mch_memmove(str + str_l, str_arg,
3068 (size_t)zn > avail ? avail
3069 : (size_t)zn);
3070 }
3071 str_l += zn;
3072 }
3073
3074 // insert zero padding as requested by the precision or min
3075 // field width
3076 zn = (int)number_of_zeros_to_pad;
3077 if (zn > 0)
3078 {
3079 if (str_l < str_m)
3080 {
3081 size_t avail = str_m - str_l;
3082
3083 vim_memset(str + str_l, '0',
3084 (size_t)zn > avail ? avail
3085 : (size_t)zn);
3086 }
3087 str_l += zn;
3088 }
3089 }
3090
3091 // insert formatted string
3092 // (or as-is conversion specifier for unknown conversions)
3093 {
3094 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
3095
3096 if (sn > 0)
3097 {
3098 if (str_l < str_m)
3099 {
3100 size_t avail = str_m - str_l;
3101
3102 mch_memmove(str + str_l,
3103 str_arg + zero_padding_insertion_ind,
3104 (size_t)sn > avail ? avail : (size_t)sn);
3105 }
3106 str_l += sn;
3107 }
3108 }
3109
3110 // insert right padding
3111 if (justify_left)
3112 {
3113 // right blank padding to the field width
3114 int pn = (int)(min_field_width
3115 - (str_arg_l + number_of_zeros_to_pad));
3116
3117 if (pn > 0)
3118 {
3119 if (str_l < str_m)
3120 {
3121 size_t avail = str_m - str_l;
3122
3123 vim_memset(str + str_l, ' ',
3124 (size_t)pn > avail ? avail
3125 : (size_t)pn);
3126 }
3127 str_l += pn;
3128 }
3129 }
3130 vim_free(tofree);
3131 }
3132 }
3133
3134 if (str_m > 0)
3135 {
3136 // make sure the string is nul-terminated even at the expense of
3137 // overwriting the last character (shouldn't happen, but just in case)
3138 //
3139 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
3140 }
3141
3142 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar677658a2022-01-05 16:09:06 +00003143 emsg(_(e_too_many_arguments_to_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003144
3145 // Return the number of characters formatted (excluding trailing nul
3146 // character), that is, the number of characters that would have been
3147 // written to the buffer if it were large enough.
3148 return (int)str_l;
3149}
3150
3151#endif // PROTO