blob: cd75bc371d768a5de6fb5ce25a84242b27966225 [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;
Mike Williams51024bb2024-05-30 07:46:30 +0200154 size_t l;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200155 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 }
zeertzjq88c8c542024-05-30 19:27:25 +0200272 if (do_special && find_cmdline_var(p, &l) >= 0)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200273 {
274 *d++ = '\\'; // insert backslash
zeertzjq88c8c542024-05-30 19:27:25 +0200275 memcpy(d, p, l); // copy the var
276 d += l;
277 p += l;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200278 continue;
279 }
Jason Cox6e823512021-08-29 12:36:49 +0200280 if (*p == '\\' && fish_like)
281 {
282 *d++ = '\\';
283 *d++ = *p++;
Bram Moolenaar66315972021-09-01 14:31:51 +0200284 continue;
Jason Cox6e823512021-08-29 12:36:49 +0200285 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200286
287 MB_COPY_CHAR(p, d);
288 }
289
290 // add terminating quote and finish with a NUL
291# ifdef MSWIN
292 if (double_quotes)
293 *d++ = '"';
294 else
295# endif
296 *d++ = '\'';
297 *d = NUL;
298 }
299
300 return escaped_string;
301}
302
303/*
304 * Like vim_strsave(), but make all characters uppercase.
305 * This uses ASCII lower-to-upper case translation, language independent.
306 */
307 char_u *
308vim_strsave_up(char_u *string)
309{
310 char_u *p1;
311
312 p1 = vim_strsave(string);
313 vim_strup(p1);
314 return p1;
315}
316
317/*
318 * Like vim_strnsave(), but make all characters uppercase.
319 * This uses ASCII lower-to-upper case translation, language independent.
320 */
321 char_u *
322vim_strnsave_up(char_u *string, size_t len)
323{
324 char_u *p1;
325
326 p1 = vim_strnsave(string, len);
327 vim_strup(p1);
328 return p1;
329}
330
331/*
332 * ASCII lower-to-upper case translation, language independent.
333 */
334 void
335vim_strup(
336 char_u *p)
337{
338 char_u *p2;
339 int c;
340
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000341 if (p == NULL)
342 return;
343
344 p2 = p;
345 while ((c = *p2) != NUL)
346 *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200347}
348
349#if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
350/*
351 * Make string "s" all upper-case and return it in allocated memory.
352 * Handles multi-byte characters as well as possible.
353 * Returns NULL when out of memory.
354 */
355 static char_u *
356strup_save(char_u *orig)
357{
358 char_u *p;
359 char_u *res;
360
361 res = p = vim_strsave(orig);
362
363 if (res != NULL)
364 while (*p != NUL)
365 {
366 int l;
367
368 if (enc_utf8)
369 {
370 int c, uc;
371 int newl;
372 char_u *s;
373
374 c = utf_ptr2char(p);
375 l = utf_ptr2len(p);
376 if (c == 0)
377 {
378 // overlong sequence, use only the first byte
379 c = *p;
380 l = 1;
381 }
382 uc = utf_toupper(c);
383
384 // Reallocate string when byte count changes. This is rare,
385 // thus it's OK to do another malloc()/free().
386 newl = utf_char2len(uc);
387 if (newl != l)
388 {
389 s = alloc(STRLEN(res) + 1 + newl - l);
390 if (s == NULL)
391 {
392 vim_free(res);
393 return NULL;
394 }
395 mch_memmove(s, res, p - res);
396 STRCPY(s + (p - res) + newl, p + l);
397 p = s + (p - res);
398 vim_free(res);
399 res = s;
400 }
401
402 utf_char2bytes(uc, p);
403 p += newl;
404 }
405 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
406 p += l; // skip multi-byte character
407 else
408 {
409 *p = TOUPPER_LOC(*p); // note that toupper() can be a macro
410 p++;
411 }
412 }
413
414 return res;
415}
416
417/*
418 * Make string "s" all lower-case and return it in allocated memory.
419 * Handles multi-byte characters as well as possible.
420 * Returns NULL when out of memory.
421 */
422 char_u *
423strlow_save(char_u *orig)
424{
425 char_u *p;
426 char_u *res;
427
428 res = p = vim_strsave(orig);
429
430 if (res != NULL)
431 while (*p != NUL)
432 {
433 int l;
434
435 if (enc_utf8)
436 {
437 int c, lc;
438 int newl;
439 char_u *s;
440
441 c = utf_ptr2char(p);
442 l = utf_ptr2len(p);
443 if (c == 0)
444 {
445 // overlong sequence, use only the first byte
446 c = *p;
447 l = 1;
448 }
449 lc = utf_tolower(c);
450
451 // Reallocate string when byte count changes. This is rare,
452 // thus it's OK to do another malloc()/free().
453 newl = utf_char2len(lc);
454 if (newl != l)
455 {
456 s = alloc(STRLEN(res) + 1 + newl - l);
457 if (s == NULL)
458 {
459 vim_free(res);
460 return NULL;
461 }
462 mch_memmove(s, res, p - res);
463 STRCPY(s + (p - res) + newl, p + l);
464 p = s + (p - res);
465 vim_free(res);
466 res = s;
467 }
468
469 utf_char2bytes(lc, p);
470 p += newl;
471 }
472 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
473 p += l; // skip multi-byte character
474 else
475 {
476 *p = TOLOWER_LOC(*p); // note that tolower() can be a macro
477 p++;
478 }
479 }
480
481 return res;
482}
483#endif
484
485/*
486 * delete spaces at the end of a string
487 */
488 void
489del_trailing_spaces(char_u *ptr)
490{
491 char_u *q;
492
493 q = ptr + STRLEN(ptr);
494 while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
495 *q = NUL;
496}
497
498/*
499 * Like strncpy(), but always terminate the result with one NUL.
500 * "to" must be "len + 1" long!
501 */
502 void
503vim_strncpy(char_u *to, char_u *from, size_t len)
504{
505 STRNCPY(to, from, len);
506 to[len] = NUL;
507}
508
509/*
510 * Like strcat(), but make sure the result fits in "tosize" bytes and is
511 * always NUL terminated. "from" and "to" may overlap.
512 */
513 void
514vim_strcat(char_u *to, char_u *from, size_t tosize)
515{
516 size_t tolen = STRLEN(to);
517 size_t fromlen = STRLEN(from);
518
519 if (tolen + fromlen + 1 > tosize)
520 {
521 mch_memmove(to + tolen, from, tosize - tolen - 1);
522 to[tosize - 1] = NUL;
523 }
524 else
525 mch_memmove(to + tolen, from, fromlen + 1);
526}
527
Bram Moolenaarc32949b2023-01-04 15:56:51 +0000528/*
529 * A version of strlen() that has a maximum length.
530 */
531 size_t
532vim_strlen_maxlen(char *s, size_t maxlen)
533{
534 size_t i;
535 for (i = 0; i < maxlen; ++i)
536 if (s[i] == NUL)
537 break;
538 return i;
539}
540
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200541#if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
542/*
543 * Compare two strings, ignoring case, using current locale.
544 * Doesn't work for multi-byte characters.
545 * return 0 for match, < 0 for smaller, > 0 for bigger
546 */
547 int
548vim_stricmp(char *s1, char *s2)
549{
550 int i;
551
552 for (;;)
553 {
554 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
555 if (i != 0)
556 return i; // this character different
557 if (*s1 == NUL)
558 break; // strings match until NUL
559 ++s1;
560 ++s2;
561 }
562 return 0; // strings match
563}
564#endif
565
566#if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
567/*
568 * Compare two strings, for length "len", ignoring case, using current locale.
569 * Doesn't work for multi-byte characters.
570 * return 0 for match, < 0 for smaller, > 0 for bigger
571 */
572 int
573vim_strnicmp(char *s1, char *s2, size_t len)
574{
575 int i;
576
577 while (len > 0)
578 {
579 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
580 if (i != 0)
581 return i; // this character different
582 if (*s1 == NUL)
583 break; // strings match until NUL
584 ++s1;
585 ++s2;
586 --len;
587 }
588 return 0; // strings match
589}
590#endif
591
592/*
Christian Brabandt84e31752024-09-02 09:59:18 +0200593 * Compare two ASCII strings, for length "len", ignoring case, ignoring locale
594 * (mostly matters for turkish locale where i I might be different).
595 * return 0 for match, < 0 for smaller, > 0 for bigger
596 */
597 int
598vim_strnicmp_asc(char *s1, char *s2, size_t len)
599{
John Marriottc847c122024-11-24 14:09:40 +0100600 int i = 0;
Christian Brabandt84e31752024-09-02 09:59:18 +0200601 int save_cmp_flags = cmp_flags;
602
603 cmp_flags |= CMP_KEEPASCII; // compare by ASCII value, ignoring locale
604 while (len > 0)
605 {
606 i = vim_tolower(*s1) - vim_tolower(*s2);
607 if (i != 0)
608 break; // this character is different
609 if (*s1 == NUL)
610 break; // strings match until NUL
611 ++s1;
612 ++s2;
613 --len;
614 }
615 cmp_flags = save_cmp_flags;
616 return i;
617}
618
619/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200620 * Search for first occurrence of "c" in "string".
621 * Version of strchr() that handles unsigned char strings with characters from
622 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
623 * end of the string.
624 */
Bram Moolenaarc32949b2023-01-04 15:56:51 +0000625 char_u *
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200626vim_strchr(char_u *string, int c)
627{
628 char_u *p;
629 int b;
630
631 p = string;
632 if (enc_utf8 && c >= 0x80)
633 {
634 while (*p != NUL)
635 {
636 int l = utfc_ptr2len(p);
637
638 // Avoid matching an illegal byte here.
639 if (utf_ptr2char(p) == c && l > 1)
640 return p;
641 p += l;
642 }
643 return NULL;
644 }
645 if (enc_dbcs != 0 && c > 255)
646 {
647 int n2 = c & 0xff;
648
649 c = ((unsigned)c >> 8) & 0xff;
650 while ((b = *p) != NUL)
651 {
652 if (b == c && p[1] == n2)
653 return p;
654 p += (*mb_ptr2len)(p);
655 }
656 return NULL;
657 }
658 if (has_mbyte)
659 {
660 while ((b = *p) != NUL)
661 {
662 if (b == c)
663 return p;
664 p += (*mb_ptr2len)(p);
665 }
666 return NULL;
667 }
668 while ((b = *p) != NUL)
669 {
670 if (b == c)
671 return p;
672 ++p;
673 }
674 return NULL;
675}
676
677/*
678 * Version of strchr() that only works for bytes and handles unsigned char
679 * strings with characters above 128 correctly. It also doesn't return a
680 * pointer to the NUL at the end of the string.
681 */
682 char_u *
683vim_strbyte(char_u *string, int c)
684{
685 char_u *p = string;
686
687 while (*p != NUL)
688 {
689 if (*p == c)
690 return p;
691 ++p;
692 }
693 return NULL;
694}
695
696/*
697 * Search for last occurrence of "c" in "string".
698 * Version of strrchr() that handles unsigned char strings with characters from
699 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
700 * end of the string.
701 * Return NULL if not found.
702 * Does not handle multi-byte char for "c"!
703 */
704 char_u *
705vim_strrchr(char_u *string, int c)
706{
707 char_u *retval = NULL;
708 char_u *p = string;
709
710 while (*p)
711 {
712 if (*p == c)
713 retval = p;
714 MB_PTR_ADV(p);
715 }
716 return retval;
717}
718
719/*
720 * Vim's version of strpbrk(), in case it's missing.
721 * Don't generate a prototype for this, causes problems when it's not used.
722 */
723#ifndef PROTO
724# ifndef HAVE_STRPBRK
725# ifdef vim_strpbrk
726# undef vim_strpbrk
727# endif
728 char_u *
729vim_strpbrk(char_u *s, char_u *charset)
730{
731 while (*s)
732 {
733 if (vim_strchr(charset, *s) != NULL)
734 return s;
735 MB_PTR_ADV(s);
736 }
737 return NULL;
738}
739# endif
740#endif
741
742/*
743 * Sort an array of strings.
744 */
745static int sort_compare(const void *s1, const void *s2);
746
747 static int
748sort_compare(const void *s1, const void *s2)
749{
750 return STRCMP(*(char **)s1, *(char **)s2);
751}
752
753 void
754sort_strings(
755 char_u **files,
756 int count)
757{
758 qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
759}
760
761#if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
762/*
763 * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
764 * When "s" is NULL FALSE is returned.
765 */
766 int
767has_non_ascii(char_u *s)
768{
769 char_u *p;
770
771 if (s != NULL)
772 for (p = s; *p != NUL; ++p)
773 if (*p >= 128)
774 return TRUE;
775 return FALSE;
776}
777#endif
778
779/*
780 * Concatenate two strings and return the result in allocated memory.
781 * Returns NULL when out of memory.
782 */
783 char_u *
784concat_str(char_u *str1, char_u *str2)
785{
786 char_u *dest;
787 size_t l = str1 == NULL ? 0 : STRLEN(str1);
788
789 dest = alloc(l + (str2 == NULL ? 0 : STRLEN(str2)) + 1L);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000790 if (dest == NULL)
791 return NULL;
792 if (str1 == NULL)
793 *dest = NUL;
794 else
795 STRCPY(dest, str1);
796 if (str2 != NULL)
797 STRCPY(dest + l, str2);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200798 return dest;
799}
800
zeertzjq4dd266c2023-08-19 11:35:03 +0200801#if defined(FEAT_EVAL) || defined(FEAT_RIGHTLEFT) || defined(PROTO)
802/*
803 * Reverse text into allocated memory.
804 * Returns the allocated string, NULL when out of memory.
805 */
806 char_u *
807reverse_text(char_u *s)
808{
809 size_t len = STRLEN(s);
810 char_u *rev = alloc(len + 1);
811 if (rev == NULL)
812 return NULL;
813
814 for (size_t s_i = 0, rev_i = len; s_i < len; ++s_i)
815 {
816 if (has_mbyte)
817 {
818 int mb_len = (*mb_ptr2len)(s + s_i);
819 rev_i -= mb_len;
820 mch_memmove(rev + rev_i, s + s_i, mb_len);
821 s_i += mb_len - 1;
822 }
823 else
824 rev[--rev_i] = s[s_i];
825 }
826 rev[len] = NUL;
827 return rev;
828}
829#endif
830
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200831#if defined(FEAT_EVAL) || defined(PROTO)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200832/*
833 * Return string "str" in ' quotes, doubling ' characters.
834 * If "str" is NULL an empty string is assumed.
835 * If "function" is TRUE make it function('string').
836 */
837 char_u *
838string_quote(char_u *str, int function)
839{
840 unsigned len;
841 char_u *p, *r, *s;
842
843 len = (function ? 13 : 3);
844 if (str != NULL)
845 {
846 len += (unsigned)STRLEN(str);
847 for (p = str; *p != NUL; MB_PTR_ADV(p))
848 if (*p == '\'')
849 ++len;
850 }
851 s = r = alloc(len);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000852 if (r == NULL)
853 return NULL;
854
855 if (function)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200856 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000857 STRCPY(r, "function('");
858 r += 10;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200859 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000860 else
861 *r++ = '\'';
862 if (str != NULL)
863 for (p = str; *p != NUL; )
864 {
865 if (*p == '\'')
866 *r++ = '\'';
867 MB_COPY_CHAR(p, r);
868 }
869 *r++ = '\'';
870 if (function)
871 *r++ = ')';
872 *r++ = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200873 return s;
874}
875
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000876/*
877 * Count the number of times "needle" occurs in string "haystack". Case is
878 * ignored if "ic" is TRUE.
879 */
880 long
881string_count(char_u *haystack, char_u *needle, int ic)
882{
883 long n = 0;
884 char_u *p = haystack;
885 char_u *next;
886
887 if (p == NULL || needle == NULL || *needle == NUL)
888 return 0;
889
890 if (ic)
891 {
892 size_t len = STRLEN(needle);
893
894 while (*p != NUL)
895 {
896 if (MB_STRNICMP(p, needle, len) == 0)
897 {
898 ++n;
899 p += len;
900 }
901 else
902 MB_PTR_ADV(p);
903 }
904 }
905 else
906 while ((next = (char_u *)strstr((char *)p, (char *)needle)) != NULL)
907 {
908 ++n;
909 p = next + STRLEN(needle);
910 }
911
912 return n;
913}
914
915/*
916 * Make a typval_T of the first character of "input" and store it in "output".
917 * Return OK or FAIL.
918 */
919 static int
920copy_first_char_to_tv(char_u *input, typval_T *output)
921{
922 char_u buf[MB_MAXBYTES + 1];
923 int len;
924
925 if (input == NULL || output == NULL)
926 return FAIL;
927
928 len = has_mbyte ? mb_ptr2len(input) : 1;
929 STRNCPY(buf, input, len);
930 buf[len] = NUL;
931 output->v_type = VAR_STRING;
932 output->vval.v_string = vim_strsave(buf);
933
934 return output->vval.v_string == NULL ? FAIL : OK;
935}
936
937/*
938 * Implementation of map() and filter() for a String. Apply "expr" to every
939 * character in string "str" and return the result in "rettv".
940 */
941 void
942string_filter_map(
943 char_u *str,
944 filtermap_T filtermap,
945 typval_T *expr,
946 typval_T *rettv)
947{
948 char_u *p;
949 typval_T tv;
950 garray_T ga;
951 int len = 0;
952 int idx = 0;
953 int rem;
Bram Moolenaar82418262022-09-28 16:16:15 +0100954 typval_T newtv;
955 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000956
957 rettv->v_type = VAR_STRING;
958 rettv->vval.v_string = NULL;
959
960 // set_vim_var_nr() doesn't set the type
961 set_vim_var_type(VV_KEY, VAR_NUMBER);
962
zeertzjqe7d49462023-04-16 20:53:55 +0100963 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +0100964 fc = eval_expr_get_funccal(expr, &newtv);
965
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000966 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000967 for (p = str; *p != NUL; p += len)
968 {
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000969 if (copy_first_char_to_tv(p, &tv) == FAIL)
970 break;
971 len = (int)STRLEN(tv.vval.v_string);
972
973 set_vim_var_nr(VV_KEY, idx);
Bram Moolenaar82418262022-09-28 16:16:15 +0100974 if (filter_map_one(&tv, expr, filtermap, fc, &newtv, &rem) == FAIL
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000975 || did_emsg)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000976 {
977 clear_tv(&newtv);
978 clear_tv(&tv);
979 break;
980 }
Ernie Raele79e2072024-01-13 11:47:33 +0100981 if (filtermap == FILTERMAP_MAP || filtermap == FILTERMAP_MAPNEW)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000982 {
983 if (newtv.v_type != VAR_STRING)
984 {
985 clear_tv(&newtv);
986 clear_tv(&tv);
Bram Moolenaare70cec92022-01-01 14:25:55 +0000987 emsg(_(e_string_required));
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000988 break;
989 }
990 else
991 ga_concat(&ga, newtv.vval.v_string);
992 }
Ernie Raele79e2072024-01-13 11:47:33 +0100993 else if (filtermap == FILTERMAP_FOREACH || !rem)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000994 ga_concat(&ga, tv.vval.v_string);
995
996 clear_tv(&newtv);
997 clear_tv(&tv);
998
999 ++idx;
1000 }
1001 ga_append(&ga, NUL);
1002 rettv->vval.v_string = ga.ga_data;
Bram Moolenaar82418262022-09-28 16:16:15 +01001003 if (fc != NULL)
1004 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001005}
1006
1007/*
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001008 * Implementation of reduce() for String "argvars[0]" using the function "expr"
1009 * starting with the optional initial value "argvars[2]" and return the result
1010 * in "rettv".
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001011 */
1012 void
1013string_reduce(
1014 typval_T *argvars,
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001015 typval_T *expr,
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001016 typval_T *rettv)
1017{
1018 char_u *p = tv_get_string(&argvars[0]);
1019 int len;
1020 typval_T argv[3];
1021 int r;
1022 int called_emsg_start = called_emsg;
Bram Moolenaar82418262022-09-28 16:16:15 +01001023 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001024
1025 if (argvars[2].v_type == VAR_UNKNOWN)
1026 {
1027 if (*p == NUL)
1028 {
Bram Moolenaare70cec92022-01-01 14:25:55 +00001029 semsg(_(e_reduce_of_an_empty_str_with_no_initial_value), "String");
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001030 return;
1031 }
1032 if (copy_first_char_to_tv(p, rettv) == FAIL)
1033 return;
1034 p += STRLEN(rettv->vval.v_string);
1035 }
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001036 else if (check_for_string_arg(argvars, 2) == FAIL)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001037 return;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001038 else
1039 copy_tv(&argvars[2], rettv);
1040
zeertzjqe7d49462023-04-16 20:53:55 +01001041 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +01001042 fc = eval_expr_get_funccal(expr, rettv);
1043
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001044 for ( ; *p != NUL; p += len)
1045 {
1046 argv[0] = *rettv;
1047 if (copy_first_char_to_tv(p, &argv[1]) == FAIL)
1048 break;
1049 len = (int)STRLEN(argv[1].vval.v_string);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001050
zeertzjqad0c4422023-08-17 22:15:47 +02001051 r = eval_expr_typval(expr, TRUE, argv, 2, fc, rettv);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001052
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001053 clear_tv(&argv[0]);
1054 clear_tv(&argv[1]);
1055 if (r == FAIL || called_emsg != called_emsg_start)
1056 return;
1057 }
Bram Moolenaar82418262022-09-28 16:16:15 +01001058
1059 if (fc != NULL)
1060 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001061}
1062
Bram Moolenaare4098452023-05-07 18:53:49 +01001063/*
1064 * Implementation of "byteidx()" and "byteidxcomp()" functions
1065 */
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001066 static void
Dominique Pellé0268ff32024-07-28 21:12:20 +02001067byteidx_common(typval_T *argvars, typval_T *rettv, int comp)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001068{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001069 rettv->vval.v_number = -1;
1070
1071 if (in_vim9script()
1072 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001073 || check_for_number_arg(argvars, 1) == FAIL
1074 || check_for_opt_bool_arg(argvars, 2) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001075 return;
1076
Christian Brabandt67672ef2023-04-24 21:09:54 +01001077 char_u *str = tv_get_string_chk(&argvars[0]);
1078 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001079 if (str == NULL || idx < 0)
1080 return;
1081
Christian Brabandt67672ef2023-04-24 21:09:54 +01001082 varnumber_T utf16idx = FALSE;
1083 if (argvars[2].v_type != VAR_UNKNOWN)
1084 {
zeertzjq8cf51372023-05-08 15:31:38 +01001085 int error = FALSE;
1086 utf16idx = tv_get_bool_chk(&argvars[2], &error);
1087 if (error)
1088 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001089 if (utf16idx < 0 || utf16idx > 1)
1090 {
zeertzjq8cf51372023-05-08 15:31:38 +01001091 semsg(_(e_using_number_as_bool_nr), utf16idx);
Christian Brabandt67672ef2023-04-24 21:09:54 +01001092 return;
1093 }
1094 }
1095
1096 int (*ptr2len)(char_u *);
1097 if (enc_utf8 && comp)
1098 ptr2len = utf_ptr2len;
1099 else
1100 ptr2len = mb_ptr2len;
1101
1102 char_u *t = str;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001103 for ( ; idx > 0; idx--)
1104 {
1105 if (*t == NUL) // EOL reached
1106 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001107 if (utf16idx)
1108 {
1109 int clen = ptr2len(t);
1110 int c = (clen > 1) ? utf_ptr2char(t) : *t;
1111 if (c > 0xFFFF)
1112 idx--;
1113 }
1114 if (idx > 0)
1115 t += ptr2len(t);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001116 }
1117 rettv->vval.v_number = (varnumber_T)(t - str);
1118}
1119
1120/*
1121 * "byteidx()" function
1122 */
1123 void
1124f_byteidx(typval_T *argvars, typval_T *rettv)
1125{
Bram Moolenaare4098452023-05-07 18:53:49 +01001126 byteidx_common(argvars, rettv, FALSE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001127}
1128
1129/*
1130 * "byteidxcomp()" function
1131 */
1132 void
1133f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1134{
Bram Moolenaare4098452023-05-07 18:53:49 +01001135 byteidx_common(argvars, rettv, TRUE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001136}
1137
1138/*
1139 * "charidx()" function
1140 */
1141 void
1142f_charidx(typval_T *argvars, typval_T *rettv)
1143{
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001144 rettv->vval.v_number = -1;
1145
Christian Brabandt67672ef2023-04-24 21:09:54 +01001146 if (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001147 || check_for_number_arg(argvars, 1) == FAIL
Christian Brabandt67672ef2023-04-24 21:09:54 +01001148 || check_for_opt_bool_arg(argvars, 2) == FAIL
1149 || (argvars[2].v_type != VAR_UNKNOWN
1150 && check_for_opt_bool_arg(argvars, 3) == FAIL))
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001151 return;
1152
Christian Brabandt67672ef2023-04-24 21:09:54 +01001153 char_u *str = tv_get_string_chk(&argvars[0]);
1154 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001155 if (str == NULL || idx < 0)
1156 return;
1157
Christian Brabandt67672ef2023-04-24 21:09:54 +01001158 varnumber_T countcc = FALSE;
1159 varnumber_T utf16idx = FALSE;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001160 if (argvars[2].v_type != VAR_UNKNOWN)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001161 {
Christian Brabandt67672ef2023-04-24 21:09:54 +01001162 countcc = tv_get_bool(&argvars[2]);
1163 if (argvars[3].v_type != VAR_UNKNOWN)
1164 utf16idx = tv_get_bool(&argvars[3]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001165 }
1166
Christian Brabandt67672ef2023-04-24 21:09:54 +01001167 int (*ptr2len)(char_u *);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001168 if (enc_utf8 && countcc)
1169 ptr2len = utf_ptr2len;
1170 else
1171 ptr2len = mb_ptr2len;
1172
Christian Brabandt67672ef2023-04-24 21:09:54 +01001173 char_u *p;
1174 int len;
1175 for (p = str, len = 0; utf16idx ? idx >= 0 : p <= str + idx; len++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001176 {
1177 if (*p == NUL)
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001178 {
1179 // If the index is exactly the number of bytes or utf-16 code units
1180 // in the string then return the length of the string in
1181 // characters.
1182 if (utf16idx ? (idx == 0) : (p == (str + idx)))
1183 rettv->vval.v_number = len;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001184 return;
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001185 }
Christian Brabandt67672ef2023-04-24 21:09:54 +01001186 if (utf16idx)
1187 {
1188 idx--;
1189 int clen = ptr2len(p);
1190 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1191 if (c > 0xFFFF)
1192 idx--;
1193 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001194 p += ptr2len(p);
1195 }
1196
1197 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1198}
1199
1200/*
1201 * "str2list()" function
1202 */
1203 void
1204f_str2list(typval_T *argvars, typval_T *rettv)
1205{
1206 char_u *p;
1207 int utf8 = FALSE;
1208
1209 if (rettv_list_alloc(rettv) == FAIL)
1210 return;
1211
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001212 if (in_vim9script()
1213 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001214 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001215 return;
1216
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001217 if (argvars[1].v_type != VAR_UNKNOWN)
1218 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1219
1220 p = tv_get_string(&argvars[0]);
1221
1222 if (has_mbyte || utf8)
1223 {
1224 int (*ptr2len)(char_u *);
1225 int (*ptr2char)(char_u *);
1226
1227 if (utf8 || enc_utf8)
1228 {
1229 ptr2len = utf_ptr2len;
1230 ptr2char = utf_ptr2char;
1231 }
1232 else
1233 {
1234 ptr2len = mb_ptr2len;
1235 ptr2char = mb_ptr2char;
1236 }
1237
1238 for ( ; *p != NUL; p += (*ptr2len)(p))
1239 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1240 }
1241 else
1242 for ( ; *p != NUL; ++p)
1243 list_append_number(rettv->vval.v_list, *p);
1244}
1245
1246/*
1247 * "str2nr()" function
1248 */
1249 void
1250f_str2nr(typval_T *argvars, typval_T *rettv)
1251{
1252 int base = 10;
1253 char_u *p;
1254 varnumber_T n;
1255 int what = 0;
1256 int isneg;
1257
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001258 if (in_vim9script()
1259 && (check_for_string_arg(argvars, 0) == FAIL
1260 || check_for_opt_number_arg(argvars, 1) == FAIL
1261 || (argvars[1].v_type != VAR_UNKNOWN
1262 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1263 return;
1264
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001265 if (argvars[1].v_type != VAR_UNKNOWN)
1266 {
1267 base = (int)tv_get_number(&argvars[1]);
1268 if (base != 2 && base != 8 && base != 10 && base != 16)
1269 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001270 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001271 return;
1272 }
1273 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1274 what |= STR2NR_QUOTE;
1275 }
1276
1277 p = skipwhite(tv_get_string_strict(&argvars[0]));
1278 isneg = (*p == '-');
1279 if (*p == '+' || *p == '-')
1280 p = skipwhite(p + 1);
1281 switch (base)
1282 {
1283 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1284 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1285 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1286 }
Bram Moolenaar5fb78c32023-03-04 20:47:39 +00001287 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE, NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001288 // Text after the number is silently ignored.
1289 if (isneg)
1290 rettv->vval.v_number = -n;
1291 else
1292 rettv->vval.v_number = n;
1293
1294}
1295
1296/*
1297 * "strgetchar()" function
1298 */
1299 void
1300f_strgetchar(typval_T *argvars, typval_T *rettv)
1301{
1302 char_u *str;
1303 int len;
1304 int error = FALSE;
1305 int charidx;
1306 int byteidx = 0;
1307
1308 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001309
1310 if (in_vim9script()
1311 && (check_for_string_arg(argvars, 0) == FAIL
1312 || check_for_number_arg(argvars, 1) == FAIL))
1313 return;
1314
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001315 str = tv_get_string_chk(&argvars[0]);
1316 if (str == NULL)
1317 return;
1318 len = (int)STRLEN(str);
1319 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1320 if (error)
1321 return;
1322
1323 while (charidx >= 0 && byteidx < len)
1324 {
1325 if (charidx == 0)
1326 {
1327 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1328 break;
1329 }
1330 --charidx;
1331 byteidx += MB_CPTR2LEN(str + byteidx);
1332 }
1333}
1334
1335/*
1336 * "stridx()" function
1337 */
1338 void
1339f_stridx(typval_T *argvars, typval_T *rettv)
1340{
1341 char_u buf[NUMBUFLEN];
1342 char_u *needle;
1343 char_u *haystack;
1344 char_u *save_haystack;
1345 char_u *pos;
1346 int start_idx;
1347
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001348 if (in_vim9script()
1349 && (check_for_string_arg(argvars, 0) == FAIL
1350 || check_for_string_arg(argvars, 1) == FAIL
1351 || check_for_opt_number_arg(argvars, 2) == FAIL))
1352 return;
1353
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001354 needle = tv_get_string_chk(&argvars[1]);
1355 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1356 rettv->vval.v_number = -1;
1357 if (needle == NULL || haystack == NULL)
1358 return; // type error; errmsg already given
1359
1360 if (argvars[2].v_type != VAR_UNKNOWN)
1361 {
1362 int error = FALSE;
1363
1364 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1365 if (error || start_idx >= (int)STRLEN(haystack))
1366 return;
1367 if (start_idx >= 0)
1368 haystack += start_idx;
1369 }
1370
1371 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1372 if (pos != NULL)
1373 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1374}
1375
1376/*
1377 * "string()" function
1378 */
1379 void
1380f_string(typval_T *argvars, typval_T *rettv)
1381{
1382 char_u *tofree;
1383 char_u numbuf[NUMBUFLEN];
1384
1385 rettv->v_type = VAR_STRING;
1386 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1387 get_copyID());
1388 // Make a copy if we have a value but it's not in allocated memory.
1389 if (rettv->vval.v_string != NULL && tofree == NULL)
1390 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1391}
1392
1393/*
1394 * "strlen()" function
1395 */
1396 void
1397f_strlen(typval_T *argvars, typval_T *rettv)
1398{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001399 if (in_vim9script()
1400 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1401 return;
1402
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001403 rettv->vval.v_number = (varnumber_T)(STRLEN(
1404 tv_get_string(&argvars[0])));
1405}
1406
1407 static void
1408strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1409{
1410 char_u *s = tv_get_string(&argvars[0]);
1411 varnumber_T len = 0;
1412 int (*func_mb_ptr2char_adv)(char_u **pp);
1413
1414 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1415 while (*s != NUL)
1416 {
1417 func_mb_ptr2char_adv(&s);
1418 ++len;
1419 }
1420 rettv->vval.v_number = len;
1421}
1422
1423/*
1424 * "strcharlen()" function
1425 */
1426 void
1427f_strcharlen(typval_T *argvars, typval_T *rettv)
1428{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001429 if (in_vim9script()
1430 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1431 return;
1432
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001433 strchar_common(argvars, rettv, TRUE);
1434}
1435
1436/*
1437 * "strchars()" function
1438 */
1439 void
1440f_strchars(typval_T *argvars, typval_T *rettv)
1441{
1442 varnumber_T skipcc = FALSE;
1443
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001444 if (in_vim9script()
1445 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001446 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001447 return;
1448
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001449 if (argvars[1].v_type != VAR_UNKNOWN)
Bram Moolenaare4098452023-05-07 18:53:49 +01001450 {
zeertzjq8cf51372023-05-08 15:31:38 +01001451 int error = FALSE;
1452 skipcc = tv_get_bool_chk(&argvars[1], &error);
1453 if (error)
1454 return;
1455 if (skipcc < 0 || skipcc > 1)
1456 {
Bram Moolenaare4098452023-05-07 18:53:49 +01001457 semsg(_(e_using_number_as_bool_nr), skipcc);
zeertzjq8cf51372023-05-08 15:31:38 +01001458 return;
1459 }
Bram Moolenaare4098452023-05-07 18:53:49 +01001460 }
zeertzjq8cf51372023-05-08 15:31:38 +01001461
1462 strchar_common(argvars, rettv, skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001463}
1464
1465/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001466 * "strutf16len()" function
1467 */
1468 void
1469f_strutf16len(typval_T *argvars, typval_T *rettv)
1470{
1471 rettv->vval.v_number = -1;
1472
1473 if (check_for_string_arg(argvars, 0) == FAIL
1474 || check_for_opt_bool_arg(argvars, 1) == FAIL)
1475 return;
1476
1477 varnumber_T countcc = FALSE;
1478 if (argvars[1].v_type != VAR_UNKNOWN)
1479 countcc = tv_get_bool(&argvars[1]);
1480
1481 char_u *s = tv_get_string(&argvars[0]);
1482 varnumber_T len = 0;
1483 int (*func_mb_ptr2char_adv)(char_u **pp);
1484 int ch;
1485
1486 func_mb_ptr2char_adv = countcc ? mb_cptr2char_adv : mb_ptr2char_adv;
1487 while (*s != NUL)
1488 {
1489 ch = func_mb_ptr2char_adv(&s);
1490 if (ch > 0xFFFF)
1491 ++len;
1492 ++len;
1493 }
1494 rettv->vval.v_number = len;
1495}
1496
1497/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001498 * "strdisplaywidth()" function
1499 */
1500 void
1501f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1502{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001503 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001504 int col = 0;
1505
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001506 rettv->vval.v_number = -1;
1507
1508 if (in_vim9script()
1509 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001510 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001511 return;
1512
1513 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001514 if (argvars[1].v_type != VAR_UNKNOWN)
1515 col = (int)tv_get_number(&argvars[1]);
1516
1517 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1518}
1519
1520/*
1521 * "strwidth()" function
1522 */
1523 void
1524f_strwidth(typval_T *argvars, typval_T *rettv)
1525{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001526 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001527
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001528 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1529 return;
1530
1531 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001532 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1533}
1534
1535/*
1536 * "strcharpart()" function
1537 */
1538 void
1539f_strcharpart(typval_T *argvars, typval_T *rettv)
1540{
1541 char_u *p;
1542 int nchar;
1543 int nbyte = 0;
1544 int charlen;
1545 int skipcc = FALSE;
1546 int len = 0;
1547 int slen;
1548 int error = FALSE;
1549
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001550 if (in_vim9script()
1551 && (check_for_string_arg(argvars, 0) == FAIL
1552 || check_for_number_arg(argvars, 1) == FAIL
1553 || check_for_opt_number_arg(argvars, 2) == FAIL
1554 || (argvars[2].v_type != VAR_UNKNOWN
1555 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1556 return;
1557
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001558 p = tv_get_string(&argvars[0]);
1559 slen = (int)STRLEN(p);
1560
1561 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1562 if (!error)
1563 {
1564 if (argvars[2].v_type != VAR_UNKNOWN
1565 && argvars[3].v_type != VAR_UNKNOWN)
1566 {
zeertzjq8cf51372023-05-08 15:31:38 +01001567 skipcc = tv_get_bool_chk(&argvars[3], &error);
1568 if (error)
1569 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001570 if (skipcc < 0 || skipcc > 1)
1571 {
zeertzjq8cf51372023-05-08 15:31:38 +01001572 semsg(_(e_using_number_as_bool_nr), skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001573 return;
1574 }
1575 }
1576
1577 if (nchar > 0)
1578 while (nchar > 0 && nbyte < slen)
1579 {
1580 if (skipcc)
1581 nbyte += mb_ptr2len(p + nbyte);
1582 else
1583 nbyte += MB_CPTR2LEN(p + nbyte);
1584 --nchar;
1585 }
1586 else
1587 nbyte = nchar;
1588 if (argvars[2].v_type != VAR_UNKNOWN)
1589 {
1590 charlen = (int)tv_get_number(&argvars[2]);
1591 while (charlen > 0 && nbyte + len < slen)
1592 {
1593 int off = nbyte + len;
1594
1595 if (off < 0)
1596 len += 1;
1597 else
1598 {
1599 if (skipcc)
1600 len += mb_ptr2len(p + off);
1601 else
1602 len += MB_CPTR2LEN(p + off);
1603 }
1604 --charlen;
1605 }
1606 }
1607 else
1608 len = slen - nbyte; // default: all bytes that are available.
1609 }
1610
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001611 // Only return the overlap between the specified part and the actual
1612 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001613 if (nbyte < 0)
1614 {
1615 len += nbyte;
1616 nbyte = 0;
1617 }
1618 else if (nbyte > slen)
1619 nbyte = slen;
1620 if (len < 0)
1621 len = 0;
1622 else if (nbyte + len > slen)
1623 len = slen - nbyte;
1624
1625 rettv->v_type = VAR_STRING;
1626 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1627}
1628
1629/*
1630 * "strpart()" function
1631 */
1632 void
1633f_strpart(typval_T *argvars, typval_T *rettv)
1634{
1635 char_u *p;
1636 int n;
1637 int len;
1638 int slen;
1639 int error = FALSE;
1640
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001641 if (in_vim9script()
1642 && (check_for_string_arg(argvars, 0) == FAIL
1643 || check_for_number_arg(argvars, 1) == FAIL
1644 || check_for_opt_number_arg(argvars, 2) == FAIL
1645 || (argvars[2].v_type != VAR_UNKNOWN
1646 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1647 return;
1648
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001649 p = tv_get_string(&argvars[0]);
1650 slen = (int)STRLEN(p);
1651
1652 n = (int)tv_get_number_chk(&argvars[1], &error);
1653 if (error)
1654 len = 0;
1655 else if (argvars[2].v_type != VAR_UNKNOWN)
1656 len = (int)tv_get_number(&argvars[2]);
1657 else
1658 len = slen - n; // default len: all bytes that are available.
1659
1660 // Only return the overlap between the specified part and the actual
1661 // string.
1662 if (n < 0)
1663 {
1664 len += n;
1665 n = 0;
1666 }
1667 else if (n > slen)
1668 n = slen;
1669 if (len < 0)
1670 len = 0;
1671 else if (n + len > slen)
1672 len = slen - n;
1673
1674 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1675 {
1676 int off;
1677
1678 // length in characters
1679 for (off = n; off < slen && len > 0; --len)
1680 off += mb_ptr2len(p + off);
1681 len = off - n;
1682 }
1683
1684 rettv->v_type = VAR_STRING;
1685 rettv->vval.v_string = vim_strnsave(p + n, len);
1686}
1687
1688/*
1689 * "strridx()" function
1690 */
1691 void
1692f_strridx(typval_T *argvars, typval_T *rettv)
1693{
1694 char_u buf[NUMBUFLEN];
1695 char_u *needle;
1696 char_u *haystack;
1697 char_u *rest;
1698 char_u *lastmatch = NULL;
1699 int haystack_len, end_idx;
1700
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001701 if (in_vim9script()
1702 && (check_for_string_arg(argvars, 0) == FAIL
1703 || check_for_string_arg(argvars, 1) == FAIL
1704 || check_for_opt_number_arg(argvars, 2) == FAIL))
1705 return;
1706
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001707 needle = tv_get_string_chk(&argvars[1]);
1708 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1709
1710 rettv->vval.v_number = -1;
1711 if (needle == NULL || haystack == NULL)
1712 return; // type error; errmsg already given
1713
1714 haystack_len = (int)STRLEN(haystack);
1715 if (argvars[2].v_type != VAR_UNKNOWN)
1716 {
1717 // Third argument: upper limit for index
1718 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1719 if (end_idx < 0)
1720 return; // can never find a match
1721 }
1722 else
1723 end_idx = haystack_len;
1724
1725 if (*needle == NUL)
1726 {
1727 // Empty string matches past the end.
1728 lastmatch = haystack + end_idx;
1729 }
1730 else
1731 {
1732 for (rest = haystack; *rest != '\0'; ++rest)
1733 {
1734 rest = (char_u *)strstr((char *)rest, (char *)needle);
1735 if (rest == NULL || rest > haystack + end_idx)
1736 break;
1737 lastmatch = rest;
1738 }
1739 }
1740
1741 if (lastmatch == NULL)
1742 rettv->vval.v_number = -1;
1743 else
1744 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1745}
1746
1747/*
1748 * "strtrans()" function
1749 */
1750 void
1751f_strtrans(typval_T *argvars, typval_T *rettv)
1752{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001753 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1754 return;
1755
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001756 rettv->v_type = VAR_STRING;
1757 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1758}
1759
Christian Brabandt67672ef2023-04-24 21:09:54 +01001760
1761/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001762 * "utf16idx()" function
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001763 *
1764 * Converts a byte or character offset in a string to the corresponding UTF-16
1765 * code unit offset.
Christian Brabandt67672ef2023-04-24 21:09:54 +01001766 */
1767 void
1768f_utf16idx(typval_T *argvars, typval_T *rettv)
1769{
1770 rettv->vval.v_number = -1;
1771
1772 if (check_for_string_arg(argvars, 0) == FAIL
1773 || check_for_opt_number_arg(argvars, 1) == FAIL
1774 || check_for_opt_bool_arg(argvars, 2) == FAIL
1775 || (argvars[2].v_type != VAR_UNKNOWN
1776 && check_for_opt_bool_arg(argvars, 3) == FAIL))
1777 return;
1778
1779 char_u *str = tv_get_string_chk(&argvars[0]);
1780 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
1781 if (str == NULL || idx < 0)
1782 return;
1783
1784 varnumber_T countcc = FALSE;
1785 varnumber_T charidx = FALSE;
1786 if (argvars[2].v_type != VAR_UNKNOWN)
1787 {
1788 countcc = tv_get_bool(&argvars[2]);
1789 if (argvars[3].v_type != VAR_UNKNOWN)
1790 charidx = tv_get_bool(&argvars[3]);
1791 }
1792
1793 int (*ptr2len)(char_u *);
1794 if (enc_utf8 && countcc)
1795 ptr2len = utf_ptr2len;
1796 else
1797 ptr2len = mb_ptr2len;
1798
1799 char_u *p;
1800 int len;
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001801 int utf16idx = 0;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001802 for (p = str, len = 0; charidx ? idx >= 0 : p <= str + idx; len++)
1803 {
1804 if (*p == NUL)
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001805 {
1806 // If the index is exactly the number of bytes or characters in the
1807 // string then return the length of the string in utf-16 code
1808 // units.
1809 if (charidx ? (idx == 0) : (p == (str + idx)))
1810 rettv->vval.v_number = len;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001811 return;
Yegappan Lakshmanan577922b2023-06-08 17:09:45 +01001812 }
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001813 utf16idx = len;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001814 int clen = ptr2len(p);
1815 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1816 if (c > 0xFFFF)
1817 len++;
1818 p += ptr2len(p);
1819 if (charidx)
1820 idx--;
1821 }
1822
Yegappan Lakshmanan95707032023-06-14 13:10:15 +01001823 rettv->vval.v_number = utf16idx;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001824}
1825
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001826/*
1827 * "tolower(string)" function
1828 */
1829 void
1830f_tolower(typval_T *argvars, typval_T *rettv)
1831{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001832 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1833 return;
1834
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001835 rettv->v_type = VAR_STRING;
1836 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1837}
1838
1839/*
1840 * "toupper(string)" function
1841 */
1842 void
1843f_toupper(typval_T *argvars, typval_T *rettv)
1844{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001845 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1846 return;
1847
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001848 rettv->v_type = VAR_STRING;
1849 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1850}
1851
1852/*
1853 * "tr(string, fromstr, tostr)" function
1854 */
1855 void
1856f_tr(typval_T *argvars, typval_T *rettv)
1857{
1858 char_u *in_str;
1859 char_u *fromstr;
1860 char_u *tostr;
1861 char_u *p;
1862 int inlen;
1863 int fromlen;
1864 int tolen;
1865 int idx;
1866 char_u *cpstr;
1867 int cplen;
1868 int first = TRUE;
1869 char_u buf[NUMBUFLEN];
1870 char_u buf2[NUMBUFLEN];
1871 garray_T ga;
1872
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001873 if (in_vim9script()
1874 && (check_for_string_arg(argvars, 0) == FAIL
1875 || check_for_string_arg(argvars, 1) == FAIL
1876 || check_for_string_arg(argvars, 2) == FAIL))
1877 return;
1878
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001879 in_str = tv_get_string(&argvars[0]);
1880 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1881 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1882
1883 // Default return value: empty string.
1884 rettv->v_type = VAR_STRING;
1885 rettv->vval.v_string = NULL;
1886 if (fromstr == NULL || tostr == NULL)
1887 return; // type error; errmsg already given
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001888 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001889
1890 if (!has_mbyte)
1891 // not multi-byte: fromstr and tostr must be the same length
1892 if (STRLEN(fromstr) != STRLEN(tostr))
1893 {
1894error:
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001895 semsg(_(e_invalid_argument_str), fromstr);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001896 ga_clear(&ga);
1897 return;
1898 }
1899
1900 // fromstr and tostr have to contain the same number of chars
1901 while (*in_str != NUL)
1902 {
1903 if (has_mbyte)
1904 {
1905 inlen = (*mb_ptr2len)(in_str);
1906 cpstr = in_str;
1907 cplen = inlen;
1908 idx = 0;
1909 for (p = fromstr; *p != NUL; p += fromlen)
1910 {
1911 fromlen = (*mb_ptr2len)(p);
1912 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1913 {
1914 for (p = tostr; *p != NUL; p += tolen)
1915 {
1916 tolen = (*mb_ptr2len)(p);
1917 if (idx-- == 0)
1918 {
1919 cplen = tolen;
1920 cpstr = p;
1921 break;
1922 }
1923 }
1924 if (*p == NUL) // tostr is shorter than fromstr
1925 goto error;
1926 break;
1927 }
1928 ++idx;
1929 }
1930
1931 if (first && cpstr == in_str)
1932 {
1933 // Check that fromstr and tostr have the same number of
1934 // (multi-byte) characters. Done only once when a character
1935 // of in_str doesn't appear in fromstr.
1936 first = FALSE;
1937 for (p = tostr; *p != NUL; p += tolen)
1938 {
1939 tolen = (*mb_ptr2len)(p);
1940 --idx;
1941 }
1942 if (idx != 0)
1943 goto error;
1944 }
1945
1946 (void)ga_grow(&ga, cplen);
1947 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1948 ga.ga_len += cplen;
1949
1950 in_str += inlen;
1951 }
1952 else
1953 {
1954 // When not using multi-byte chars we can do it faster.
1955 p = vim_strchr(fromstr, *in_str);
1956 if (p != NULL)
1957 ga_append(&ga, tostr[p - fromstr]);
1958 else
1959 ga_append(&ga, *in_str);
1960 ++in_str;
1961 }
1962 }
1963
1964 // add a terminating NUL
1965 (void)ga_grow(&ga, 1);
1966 ga_append(&ga, NUL);
1967
1968 rettv->vval.v_string = ga.ga_data;
1969}
1970
1971/*
1972 * "trim({expr})" function
1973 */
1974 void
1975f_trim(typval_T *argvars, typval_T *rettv)
1976{
1977 char_u buf1[NUMBUFLEN];
1978 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001979 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001980 char_u *mask = NULL;
1981 char_u *tail;
1982 char_u *prev;
1983 char_u *p;
1984 int c1;
1985 int dir = 0;
1986
1987 rettv->v_type = VAR_STRING;
1988 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001989
1990 if (in_vim9script()
1991 && (check_for_string_arg(argvars, 0) == FAIL
Illia Bobyr80799172023-10-17 18:00:50 +02001992 || check_for_opt_string_arg(argvars, 1) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001993 || (argvars[1].v_type != VAR_UNKNOWN
1994 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1995 return;
1996
1997 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001998 if (head == NULL)
1999 return;
2000
Illia Bobyr80799172023-10-17 18:00:50 +02002001 if (check_for_opt_string_arg(argvars, 1) == FAIL)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02002002 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02002003
2004 if (argvars[1].v_type == VAR_STRING)
Illia Bobyr6e638672023-10-17 11:09:45 +02002005 {
Illia Bobyr80799172023-10-17 18:00:50 +02002006 mask = tv_get_string_buf_chk(&argvars[1], buf2);
2007 if (*mask == NUL)
2008 mask = NULL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02002009
Illia Bobyr80799172023-10-17 18:00:50 +02002010 if (argvars[2].v_type != VAR_UNKNOWN)
Illia Bobyr6e638672023-10-17 11:09:45 +02002011 {
Illia Bobyr80799172023-10-17 18:00:50 +02002012 int error = 0;
2013
2014 // leading or trailing characters to trim
2015 dir = (int)tv_get_number_chk(&argvars[2], &error);
2016 if (error)
2017 return;
2018 if (dir < 0 || dir > 2)
2019 {
2020 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[2]));
2021 return;
2022 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02002023 }
2024 }
2025
2026 if (dir == 0 || dir == 1)
2027 {
2028 // Trim leading characters
2029 while (*head != NUL)
2030 {
2031 c1 = PTR2CHAR(head);
2032 if (mask == NULL)
2033 {
2034 if (c1 > ' ' && c1 != 0xa0)
2035 break;
2036 }
2037 else
2038 {
2039 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2040 if (c1 == PTR2CHAR(p))
2041 break;
2042 if (*p == NUL)
2043 break;
2044 }
2045 MB_PTR_ADV(head);
2046 }
2047 }
2048
2049 tail = head + STRLEN(head);
2050 if (dir == 0 || dir == 2)
2051 {
2052 // Trim trailing characters
2053 for (; tail > head; tail = prev)
2054 {
2055 prev = tail;
2056 MB_PTR_BACK(head, prev);
2057 c1 = PTR2CHAR(prev);
2058 if (mask == NULL)
2059 {
2060 if (c1 > ' ' && c1 != 0xa0)
2061 break;
2062 }
2063 else
2064 {
2065 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2066 if (c1 == PTR2CHAR(p))
2067 break;
2068 if (*p == NUL)
2069 break;
2070 }
2071 }
2072 }
2073 rettv->vval.v_string = vim_strnsave(head, tail - head);
2074}
2075
Bram Moolenaar677658a2022-01-05 16:09:06 +00002076static char *e_printf = N_(e_insufficient_arguments_for_printf);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002077
2078/*
2079 * Get number argument from "idxp" entry in "tvs". First entry is 1.
2080 */
2081 static varnumber_T
2082tv_nr(typval_T *tvs, int *idxp)
2083{
2084 int idx = *idxp - 1;
2085 varnumber_T n = 0;
2086 int err = FALSE;
2087
2088 if (tvs[idx].v_type == VAR_UNKNOWN)
2089 emsg(_(e_printf));
2090 else
2091 {
2092 ++*idxp;
2093 n = tv_get_number_chk(&tvs[idx], &err);
2094 if (err)
2095 n = 0;
2096 }
2097 return n;
2098}
2099
2100/*
2101 * Get string argument from "idxp" entry in "tvs". First entry is 1.
2102 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
2103 * are not converted to a string.
2104 * If "tofree" is not NULL echo_string() is used. All types are converted to
2105 * a string with the same format as ":echo". The caller must free "*tofree".
2106 * Returns NULL for an error.
2107 */
2108 static char *
2109tv_str(typval_T *tvs, int *idxp, char_u **tofree)
2110{
2111 int idx = *idxp - 1;
2112 char *s = NULL;
2113 static char_u numbuf[NUMBUFLEN];
2114
2115 if (tvs[idx].v_type == VAR_UNKNOWN)
2116 emsg(_(e_printf));
2117 else
2118 {
2119 ++*idxp;
2120 if (tofree != NULL)
2121 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
2122 else
2123 s = (char *)tv_get_string_chk(&tvs[idx]);
2124 }
2125 return s;
2126}
2127
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002128/*
2129 * Get float argument from "idxp" entry in "tvs". First entry is 1.
2130 */
2131 static double
2132tv_float(typval_T *tvs, int *idxp)
2133{
2134 int idx = *idxp - 1;
2135 double f = 0;
2136
2137 if (tvs[idx].v_type == VAR_UNKNOWN)
2138 emsg(_(e_printf));
2139 else
2140 {
2141 ++*idxp;
2142 if (tvs[idx].v_type == VAR_FLOAT)
2143 f = tvs[idx].vval.v_float;
2144 else if (tvs[idx].v_type == VAR_NUMBER)
2145 f = (double)tvs[idx].vval.v_number;
2146 else
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00002147 emsg(_(e_expected_float_argument_for_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002148 }
2149 return f;
2150}
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00002151
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002152#endif
2153
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002154/*
2155 * Return the representation of infinity for printf() function:
2156 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
2157 */
2158 static const char *
2159infinity_str(int positive,
2160 char fmt_spec,
2161 int force_sign,
2162 int space_for_positive)
2163{
2164 static const char *table[] =
2165 {
2166 "-inf", "inf", "+inf", " inf",
2167 "-INF", "INF", "+INF", " INF"
2168 };
2169 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
2170
2171 if (ASCII_ISUPPER(fmt_spec))
2172 idx += 4;
2173 return table[idx];
2174}
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002175
2176/*
2177 * This code was included to provide a portable vsnprintf() and snprintf().
2178 * Some systems may provide their own, but we always use this one for
2179 * consistency.
2180 *
2181 * This code is based on snprintf.c - a portable implementation of snprintf
2182 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
2183 * Included with permission. It was heavily modified to fit in Vim.
2184 * The original code, including useful comments, can be found here:
2185 * http://www.ijs.si/software/snprintf/
2186 *
2187 * This snprintf() only supports the following conversion specifiers:
2188 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
2189 * with flags: '-', '+', ' ', '0' and '#'.
2190 * An asterisk is supported for field width as well as precision.
2191 *
2192 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
2193 *
2194 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
2195 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
2196 *
2197 * The locale is not used, the string is used as a byte string. This is only
2198 * relevant for double-byte encodings where the second byte may be '%'.
2199 *
2200 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
2201 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
2202 *
2203 * The return value is the number of characters which would be generated
2204 * for the given input, excluding the trailing NUL. If this value
2205 * is greater or equal to "str_m", not all characters from the result
2206 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
2207 * are discarded. If "str_m" is greater than zero it is guaranteed
2208 * the resulting string will be NUL-terminated.
2209 */
2210
2211/*
2212 * When va_list is not supported we only define vim_snprintf().
2213 *
2214 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2215 * "typval_T". When the latter is not used it must be NULL.
2216 */
2217
2218// When generating prototypes all of this is skipped, cproto doesn't
2219// understand this.
2220#ifndef PROTO
2221
2222// Like vim_vsnprintf() but append to the string.
2223 int
2224vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2225{
2226 va_list ap;
2227 int str_l;
2228 size_t len = STRLEN(str);
2229 size_t space;
2230
2231 if (str_m <= len)
2232 space = 0;
2233 else
2234 space = str_m - len;
2235 va_start(ap, fmt);
2236 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2237 va_end(ap);
2238 return str_l;
2239}
2240
2241 int
2242vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2243{
2244 va_list ap;
2245 int str_l;
2246
2247 va_start(ap, fmt);
2248 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2249 va_end(ap);
2250 return str_l;
2251}
2252
2253 int
2254vim_vsnprintf(
2255 char *str,
2256 size_t str_m,
2257 const char *fmt,
2258 va_list ap)
2259{
2260 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2261}
2262
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002263enum
2264{
2265 TYPE_UNKNOWN = -1,
2266 TYPE_INT,
2267 TYPE_LONGINT,
2268 TYPE_LONGLONGINT,
2269 TYPE_UNSIGNEDINT,
2270 TYPE_UNSIGNEDLONGINT,
2271 TYPE_UNSIGNEDLONGLONGINT,
2272 TYPE_POINTER,
2273 TYPE_PERCENT,
2274 TYPE_CHAR,
2275 TYPE_STRING,
2276 TYPE_FLOAT
2277};
2278
2279/* Types that can be used in a format string
2280 */
zeertzjq7772c932023-08-15 22:48:40 +02002281 static int
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002282format_typeof(
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002283 const char *type)
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002284{
2285 // allowed values: \0, h, l, L
2286 char length_modifier = '\0';
2287
2288 // current conversion specifier character
2289 char fmt_spec = '\0';
2290
2291 // parse 'h', 'l' and 'll' length modifiers
2292 if (*type == 'h' || *type == 'l')
2293 {
2294 length_modifier = *type;
2295 type++;
2296 if (length_modifier == 'l' && *type == 'l')
2297 {
2298 // double l = __int64 / varnumber_T
2299 length_modifier = 'L';
2300 type++;
2301 }
2302 }
2303 fmt_spec = *type;
2304
2305 // common synonyms:
2306 switch (fmt_spec)
2307 {
2308 case 'i': fmt_spec = 'd'; break;
2309 case '*': fmt_spec = 'd'; length_modifier = 'h'; break;
2310 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2311 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2312 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2313 default: break;
2314 }
2315
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002316 // get parameter value, do initial processing
2317 switch (fmt_spec)
2318 {
2319 // '%' and 'c' behave similar to 's' regarding flags and field
2320 // widths
2321 case '%':
2322 return TYPE_PERCENT;
2323
2324 case 'c':
2325 return TYPE_CHAR;
2326
2327 case 's':
2328 case 'S':
2329 return TYPE_STRING;
2330
2331 case 'd': case 'u':
2332 case 'b': case 'B':
2333 case 'o':
2334 case 'x': case 'X':
2335 case 'p':
2336 {
2337 // NOTE: the u, b, o, x, X and p conversion specifiers
2338 // imply the value is unsigned; d implies a signed
2339 // value
2340
2341 // 0 if numeric argument is zero (or if pointer is
2342 // NULL for 'p'), +1 if greater than zero (or nonzero
2343 // for unsigned arguments), -1 if negative (unsigned
2344 // argument is never negative)
2345
2346 if (fmt_spec == 'p')
2347 return TYPE_POINTER;
2348 else if (fmt_spec == 'b' || fmt_spec == 'B')
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002349 return TYPE_UNSIGNEDLONGLONGINT;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002350 else if (fmt_spec == 'd')
2351 {
2352 // signed
2353 switch (length_modifier)
2354 {
2355 case '\0':
2356 case 'h':
2357 // char and short arguments are passed as int.
2358 return TYPE_INT;
2359 case 'l':
2360 return TYPE_LONGINT;
2361 case 'L':
2362 return TYPE_LONGLONGINT;
2363 }
2364 }
2365 else
2366 {
2367 // unsigned
2368 switch (length_modifier)
2369 {
2370 case '\0':
2371 case 'h':
2372 return TYPE_UNSIGNEDINT;
2373 case 'l':
2374 return TYPE_UNSIGNEDLONGINT;
2375 case 'L':
2376 return TYPE_UNSIGNEDLONGLONGINT;
2377 }
2378 }
2379 }
2380 break;
2381
2382 case 'f':
2383 case 'F':
2384 case 'e':
2385 case 'E':
2386 case 'g':
2387 case 'G':
2388 return TYPE_FLOAT;
2389 }
2390
2391 return TYPE_UNKNOWN;
2392}
2393
zeertzjq7772c932023-08-15 22:48:40 +02002394 static char *
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002395format_typename(
2396 const char *type)
2397{
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002398 switch (format_typeof(type))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002399 {
2400 case TYPE_INT:
2401 return _(typename_int);
2402
2403 case TYPE_LONGINT:
2404 return _(typename_longint);
2405
2406 case TYPE_LONGLONGINT:
2407 return _(typename_longlongint);
2408
2409 case TYPE_UNSIGNEDINT:
2410 return _(typename_unsignedint);
2411
2412 case TYPE_UNSIGNEDLONGINT:
2413 return _(typename_unsignedlongint);
2414
2415 case TYPE_UNSIGNEDLONGLONGINT:
2416 return _(typename_unsignedlonglongint);
2417
2418 case TYPE_POINTER:
2419 return _(typename_pointer);
2420
2421 case TYPE_PERCENT:
2422 return _(typename_percent);
2423
2424 case TYPE_CHAR:
2425 return _(typename_char);
2426
2427 case TYPE_STRING:
2428 return _(typename_string);
2429
2430 case TYPE_FLOAT:
2431 return _(typename_float);
2432 }
2433
2434 return _(typename_unknown);
2435}
2436
zeertzjq7772c932023-08-15 22:48:40 +02002437 static int
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002438adjust_types(
2439 const char ***ap_types,
2440 int arg,
2441 int *num_posarg,
2442 const char *type)
2443{
2444 if (*ap_types == NULL || *num_posarg < arg)
2445 {
2446 int idx;
2447 const char **new_types;
2448
2449 if (*ap_types == NULL)
2450 new_types = ALLOC_CLEAR_MULT(const char *, arg);
2451 else
K.Takata4c215ec2023-08-26 18:05:08 +02002452 new_types = vim_realloc((char **)*ap_types,
2453 arg * sizeof(const char *));
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002454
2455 if (new_types == NULL)
2456 return FAIL;
2457
2458 for (idx = *num_posarg; idx < arg; ++idx)
2459 new_types[idx] = NULL;
2460
2461 *ap_types = new_types;
2462 *num_posarg = arg;
2463 }
2464
2465 if ((*ap_types)[arg - 1] != NULL)
2466 {
2467 if ((*ap_types)[arg - 1][0] == '*' || type[0] == '*')
2468 {
2469 const char *pt = type;
2470 if (pt[0] == '*')
2471 pt = (*ap_types)[arg - 1];
2472
2473 if (pt[0] != '*')
2474 {
2475 switch (pt[0])
2476 {
2477 case 'd': case 'i': break;
2478 default:
2479 semsg(_(e_positional_num_field_spec_reused_str_str), arg, format_typename((*ap_types)[arg - 1]), format_typename(type));
2480 return FAIL;
2481 }
2482 }
2483 }
2484 else
2485 {
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002486 if (format_typeof(type) != format_typeof((*ap_types)[arg - 1]))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002487 {
2488 semsg(_( e_positional_arg_num_type_inconsistent_str_str), arg, format_typename(type), format_typename((*ap_types)[arg - 1]));
2489 return FAIL;
2490 }
2491 }
2492 }
2493
2494 (*ap_types)[arg - 1] = type;
2495
2496 return OK;
2497}
2498
Christ van Willegenc35fc032024-03-14 18:30:41 +01002499 static void
2500format_overflow_error(const char *pstart)
2501{
2502 size_t arglen = 0;
2503 char *argcopy = NULL;
2504 const char *p = pstart;
2505
2506 while (VIM_ISDIGIT((int)(*p)))
2507 ++p;
2508
2509 arglen = p - pstart;
2510 argcopy = ALLOC_CLEAR_MULT(char, arglen + 1);
2511 if (argcopy != NULL)
2512 {
2513 strncpy(argcopy, pstart, arglen);
2514 semsg(_( e_val_too_large), argcopy);
2515 free(argcopy);
2516 }
2517 else
2518 semsg(_(e_out_of_memory_allocating_nr_bytes), arglen);
2519}
2520
2521#define MAX_ALLOWED_STRING_WIDTH 6400
2522
2523 static int
2524get_unsigned_int(
2525 const char *pstart,
2526 const char **p,
zeertzjq0dff3152024-07-29 20:28:14 +02002527 unsigned int *uj,
2528 int overflow_err)
Christ van Willegenc35fc032024-03-14 18:30:41 +01002529{
2530 *uj = **p - '0';
2531 ++*p;
2532
2533 while (VIM_ISDIGIT((int)(**p)) && *uj < MAX_ALLOWED_STRING_WIDTH)
2534 {
2535 *uj = 10 * *uj + (unsigned int)(**p - '0');
2536 ++*p;
2537 }
2538
2539 if (*uj > MAX_ALLOWED_STRING_WIDTH)
2540 {
zeertzjq0dff3152024-07-29 20:28:14 +02002541 if (overflow_err)
2542 {
2543 format_overflow_error(pstart);
2544 return FAIL;
2545 }
2546 else
2547 *uj = MAX_ALLOWED_STRING_WIDTH;
Christ van Willegenc35fc032024-03-14 18:30:41 +01002548 }
2549
2550 return OK;
2551}
2552
2553
zeertzjq7772c932023-08-15 22:48:40 +02002554 static int
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002555parse_fmt_types(
2556 const char ***ap_types,
2557 int *num_posarg,
2558 const char *fmt,
2559 typval_T *tvs UNUSED
2560 )
2561{
2562 const char *p = fmt;
2563 const char *arg = NULL;
2564
2565 int any_pos = 0;
2566 int any_arg = 0;
2567 int arg_idx;
2568
2569#define CHECK_POS_ARG do { \
2570 if (any_pos && any_arg) \
2571 { \
2572 semsg(_( e_cannot_mix_positional_and_non_positional_str), fmt); \
2573 goto error; \
2574 } \
2575} while (0);
2576
2577 if (p == NULL)
2578 return OK;
2579
2580 while (*p != NUL)
2581 {
2582 if (*p != '%')
2583 {
2584 char *q = strchr(p + 1, '%');
2585 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2586
2587 p += n;
2588 }
2589 else
2590 {
2591 // allowed values: \0, h, l, L
2592 char length_modifier = '\0';
2593
2594 // variable for positional arg
2595 int pos_arg = -1;
2596 const char *ptype = NULL;
Christ van Willegenc35fc032024-03-14 18:30:41 +01002597 const char *pstart = p+1;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002598
2599 p++; // skip '%'
2600
2601 // First check to see if we find a positional
2602 // argument specifier
2603 ptype = p;
2604
2605 while (VIM_ISDIGIT(*ptype))
2606 ++ptype;
2607
2608 if (*ptype == '$')
2609 {
2610 if (*p == '0')
2611 {
2612 // 0 flag at the wrong place
2613 semsg(_( e_invalid_format_specifier_str), fmt);
2614 goto error;
2615 }
2616
2617 // Positional argument
Christ van Willegenc35fc032024-03-14 18:30:41 +01002618 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002619
zeertzjq0dff3152024-07-29 20:28:14 +02002620 if (get_unsigned_int(pstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01002621 goto error;
2622
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002623 pos_arg = uj;
2624
2625 any_pos = 1;
2626 CHECK_POS_ARG;
2627
2628 ++p;
2629 }
2630
2631 // parse flags
2632 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2633 || *p == '#' || *p == '\'')
2634 {
2635 switch (*p)
2636 {
2637 case '0': break;
2638 case '-': break;
2639 case '+': break;
2640 case ' ': // If both the ' ' and '+' flags appear, the ' '
2641 // flag should be ignored
2642 break;
2643 case '#': break;
2644 case '\'': break;
2645 }
2646 p++;
2647 }
2648 // If the '0' and '-' flags both appear, the '0' flag should be
2649 // ignored.
2650
2651 // parse field width
2652 if (*(arg = p) == '*')
2653 {
2654 p++;
2655
2656 if (VIM_ISDIGIT((int)(*p)))
2657 {
2658 // Positional argument field width
Christ van Willegenc35fc032024-03-14 18:30:41 +01002659 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002660
zeertzjq0dff3152024-07-29 20:28:14 +02002661 if (get_unsigned_int(arg + 1, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01002662 goto error;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002663
2664 if (*p != '$')
2665 {
2666 semsg(_( e_invalid_format_specifier_str), fmt);
2667 goto error;
2668 }
2669 else
2670 {
2671 ++p;
2672 any_pos = 1;
2673 CHECK_POS_ARG;
2674
2675 if (adjust_types(ap_types, uj, num_posarg, arg) == FAIL)
2676 goto error;
2677 }
2678 }
2679 else
2680 {
2681 any_arg = 1;
2682 CHECK_POS_ARG;
2683 }
2684 }
dundargoc580c1fc2023-10-06 19:41:14 +02002685 else if (VIM_ISDIGIT((int)(*p)))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002686 {
2687 // size_t could be wider than unsigned int; make sure we treat
2688 // argument like common implementations do
Christ van Willegenc35fc032024-03-14 18:30:41 +01002689 const char *digstart = p;
2690 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002691
zeertzjq0dff3152024-07-29 20:28:14 +02002692 if (get_unsigned_int(digstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01002693 goto error;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002694
2695 if (*p == '$')
2696 {
2697 semsg(_( e_invalid_format_specifier_str), fmt);
2698 goto error;
2699 }
2700 }
2701
2702 // parse precision
2703 if (*p == '.')
2704 {
2705 p++;
2706
2707 if (*(arg = p) == '*')
2708 {
2709 p++;
2710
2711 if (VIM_ISDIGIT((int)(*p)))
2712 {
2713 // Parse precision
Christ van Willegenc35fc032024-03-14 18:30:41 +01002714 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002715
zeertzjq0dff3152024-07-29 20:28:14 +02002716 if (get_unsigned_int(arg + 1, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01002717 goto error;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002718
2719 if (*p == '$')
2720 {
2721 any_pos = 1;
2722 CHECK_POS_ARG;
2723
2724 ++p;
2725
2726 if (adjust_types(ap_types, uj, num_posarg, arg) == FAIL)
2727 goto error;
2728 }
2729 else
2730 {
2731 semsg(_( e_invalid_format_specifier_str), fmt);
2732 goto error;
2733 }
2734 }
2735 else
2736 {
2737 any_arg = 1;
2738 CHECK_POS_ARG;
2739 }
2740 }
dundargoc580c1fc2023-10-06 19:41:14 +02002741 else if (VIM_ISDIGIT((int)(*p)))
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002742 {
2743 // size_t could be wider than unsigned int; make sure we
2744 // treat argument like common implementations do
Christ van Willegenc35fc032024-03-14 18:30:41 +01002745 const char *digstart = p;
2746 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002747
zeertzjq0dff3152024-07-29 20:28:14 +02002748 if (get_unsigned_int(digstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01002749 goto error;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002750
2751 if (*p == '$')
2752 {
2753 semsg(_( e_invalid_format_specifier_str), fmt);
2754 goto error;
2755 }
2756 }
2757 }
2758
2759 if (pos_arg != -1)
2760 {
2761 any_pos = 1;
2762 CHECK_POS_ARG;
2763
2764 ptype = p;
2765 }
2766
2767 // parse 'h', 'l' and 'll' length modifiers
2768 if (*p == 'h' || *p == 'l')
2769 {
2770 length_modifier = *p;
2771 p++;
2772 if (length_modifier == 'l' && *p == 'l')
2773 {
2774 // double l = __int64 / varnumber_T
dundargoc580c1fc2023-10-06 19:41:14 +02002775 // length_modifier = 'L';
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002776 p++;
2777 }
2778 }
2779
2780 switch (*p)
2781 {
2782 // Check for known format specifiers. % is special!
2783 case 'i':
2784 case '*':
2785 case 'd':
2786 case 'u':
2787 case 'o':
2788 case 'D':
2789 case 'U':
2790 case 'O':
2791 case 'x':
2792 case 'X':
2793 case 'b':
2794 case 'B':
2795 case 'c':
2796 case 's':
2797 case 'S':
2798 case 'p':
2799 case 'f':
2800 case 'F':
2801 case 'e':
2802 case 'E':
2803 case 'g':
2804 case 'G':
2805 if (pos_arg != -1)
2806 {
2807 if (adjust_types(ap_types, pos_arg, num_posarg, ptype) == FAIL)
2808 goto error;
2809 }
2810 else
2811 {
2812 any_arg = 1;
2813 CHECK_POS_ARG;
2814 }
2815 break;
2816
2817 default:
2818 if (pos_arg != -1)
2819 {
2820 semsg(_( e_cannot_mix_positional_and_non_positional_str), fmt);
2821 goto error;
2822 }
2823 }
2824
2825 if (*p != NUL)
2826 p++; // step over the just processed conversion specifier
2827 }
2828 }
2829
2830 for (arg_idx = 0; arg_idx < *num_posarg; ++arg_idx)
2831 {
2832 if ((*ap_types)[arg_idx] == NULL)
2833 {
2834 semsg(_(e_fmt_arg_nr_unused_str), arg_idx + 1, fmt);
2835 goto error;
2836 }
2837
2838# if defined(FEAT_EVAL)
2839 if (tvs != NULL && tvs[arg_idx].v_type == VAR_UNKNOWN)
2840 {
2841 semsg(_(e_positional_nr_out_of_bounds_str), arg_idx + 1, fmt);
2842 goto error;
2843 }
2844# endif
2845 }
2846
2847 return OK;
2848
2849error:
K.Takata4c215ec2023-08-26 18:05:08 +02002850 vim_free((char**)*ap_types);
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002851 *ap_types = NULL;
2852 *num_posarg = 0;
2853 return FAIL;
2854}
2855
zeertzjq7772c932023-08-15 22:48:40 +02002856 static void
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002857skip_to_arg(
2858 const char **ap_types,
2859 va_list ap_start,
2860 va_list *ap,
2861 int *arg_idx,
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002862 int *arg_cur,
2863 const char *fmt)
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002864{
2865 int arg_min = 0;
2866
2867 if (*arg_cur + 1 == *arg_idx)
2868 {
2869 ++*arg_cur;
2870 ++*arg_idx;
2871 return;
2872 }
2873
2874 if (*arg_cur >= *arg_idx)
2875 {
2876 // Reset ap to ap_start and skip arg_idx - 1 types
2877 va_end(*ap);
2878 va_copy(*ap, ap_start);
2879 }
2880 else
2881 {
2882 // Skip over any we should skip
2883 arg_min = *arg_cur;
2884 }
2885
2886 for (*arg_cur = arg_min; *arg_cur < *arg_idx - 1; ++*arg_cur)
2887 {
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002888 const char *p;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002889
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002890 if (ap_types == NULL || ap_types[*arg_cur] == NULL)
2891 {
Christ van Willegen1bd2cb12023-09-08 19:17:09 +02002892 siemsg(e_aptypes_is_null_nr_str, *arg_cur, fmt);
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02002893 return;
2894 }
2895
2896 p = ap_types[*arg_cur];
2897
2898 int fmt_type = format_typeof(p);
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002899
2900 // get parameter value, do initial processing
2901 switch (fmt_type)
2902 {
2903 case TYPE_PERCENT:
2904 case TYPE_UNKNOWN:
2905 break;
2906
2907 case TYPE_CHAR:
2908 va_arg(*ap, int);
2909 break;
2910
2911 case TYPE_STRING:
2912 va_arg(*ap, char *);
2913 break;
2914
2915 case TYPE_POINTER:
2916 va_arg(*ap, void *);
2917 break;
2918
2919 case TYPE_INT:
2920 va_arg(*ap, int);
2921 break;
2922
2923 case TYPE_LONGINT:
2924 va_arg(*ap, long int);
2925 break;
2926
2927 case TYPE_LONGLONGINT:
2928 va_arg(*ap, varnumber_T);
2929 break;
2930
2931 case TYPE_UNSIGNEDINT:
2932 va_arg(*ap, unsigned int);
2933 break;
2934
2935 case TYPE_UNSIGNEDLONGINT:
2936 va_arg(*ap, unsigned long int);
2937 break;
2938
2939 case TYPE_UNSIGNEDLONGLONGINT:
2940 va_arg(*ap, uvarnumber_T);
2941 break;
2942
2943 case TYPE_FLOAT:
2944 va_arg(*ap, double);
2945 break;
2946 }
2947 }
2948
2949 // Because we know that after we return from this call,
2950 // a va_arg() call is made, we can pre-emptively
2951 // increment the current argument index.
2952 ++*arg_cur;
2953 ++*arg_idx;
2954
2955 return;
2956}
2957
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002958 int
2959vim_vsnprintf_typval(
2960 char *str,
2961 size_t str_m,
2962 const char *fmt,
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002963 va_list ap_start,
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002964 typval_T *tvs)
2965{
2966 size_t str_l = 0;
2967 const char *p = fmt;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002968 int arg_cur = 0;
2969 int num_posarg = 0;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002970 int arg_idx = 1;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02002971 va_list ap;
2972 const char **ap_types = NULL;
2973
2974 if (parse_fmt_types(&ap_types, &num_posarg, fmt, tvs) == FAIL)
2975 return 0;
2976
2977 va_copy(ap, ap_start);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002978
2979 if (p == NULL)
2980 p = "";
2981 while (*p != NUL)
2982 {
2983 if (*p != '%')
2984 {
2985 char *q = strchr(p + 1, '%');
2986 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2987
2988 // Copy up to the next '%' or NUL without any changes.
2989 if (str_l < str_m)
2990 {
2991 size_t avail = str_m - str_l;
2992
2993 mch_memmove(str + str_l, p, n > avail ? avail : n);
2994 }
2995 p += n;
2996 str_l += n;
2997 }
2998 else
2999 {
3000 size_t min_field_width = 0, precision = 0;
3001 int zero_padding = 0, precision_specified = 0, justify_left = 0;
3002 int alternate_form = 0, force_sign = 0;
3003
3004 // If both the ' ' and '+' flags appear, the ' ' flag should be
3005 // ignored.
3006 int space_for_positive = 1;
3007
3008 // allowed values: \0, h, l, L
3009 char length_modifier = '\0';
3010
3011 // temporary buffer for simple numeric->string conversion
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003012# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003013 // That sounds reasonable to use as the maximum
3014 // printable.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003015 char tmp[TMP_LEN];
3016
3017 // string address in case of string argument
3018 const char *str_arg = NULL;
3019
3020 // natural field width of arg without padding and sign
3021 size_t str_arg_l;
3022
3023 // unsigned char argument value - only defined for c conversion.
3024 // N.B. standard explicitly states the char argument for the c
3025 // conversion is unsigned
3026 unsigned char uchar_arg;
3027
3028 // number of zeros to be inserted for numeric conversions as
3029 // required by the precision or minimal field width
3030 size_t number_of_zeros_to_pad = 0;
3031
3032 // index into tmp where zero padding is to be inserted
3033 size_t zero_padding_insertion_ind = 0;
3034
3035 // current conversion specifier character
3036 char fmt_spec = '\0';
3037
3038 // buffer for 's' and 'S' specs
3039 char_u *tofree = NULL;
3040
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003041 // variables for positional arg
3042 int pos_arg = -1;
3043 const char *ptype;
3044
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003045
3046 p++; // skip '%'
3047
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003048 // First check to see if we find a positional
3049 // argument specifier
3050 ptype = p;
3051
3052 while (VIM_ISDIGIT(*ptype))
3053 ++ptype;
3054
3055 if (*ptype == '$')
3056 {
3057 // Positional argument
Christ van Willegenc35fc032024-03-14 18:30:41 +01003058 const char *digstart = p;
3059 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003060
zeertzjq0dff3152024-07-29 20:28:14 +02003061 if (get_unsigned_int(digstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01003062 goto error;
3063
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003064 pos_arg = uj;
3065
3066 ++p;
3067 }
3068
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003069 // parse flags
3070 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
3071 || *p == '#' || *p == '\'')
3072 {
3073 switch (*p)
3074 {
3075 case '0': zero_padding = 1; break;
3076 case '-': justify_left = 1; break;
3077 case '+': force_sign = 1; space_for_positive = 0; break;
3078 case ' ': force_sign = 1;
3079 // If both the ' ' and '+' flags appear, the ' '
3080 // flag should be ignored
3081 break;
3082 case '#': alternate_form = 1; break;
3083 case '\'': break;
3084 }
3085 p++;
3086 }
3087 // If the '0' and '-' flags both appear, the '0' flag should be
3088 // ignored.
3089
3090 // parse field width
3091 if (*p == '*')
3092 {
3093 int j;
Christ van Willegenc35fc032024-03-14 18:30:41 +01003094 const char *digstart = p + 1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003095
3096 p++;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003097
3098 if (VIM_ISDIGIT((int)(*p)))
3099 {
3100 // Positional argument field width
Christ van Willegenc35fc032024-03-14 18:30:41 +01003101 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003102
zeertzjq0dff3152024-07-29 20:28:14 +02003103 if (get_unsigned_int(digstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01003104 goto error;
3105
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003106 arg_idx = uj;
3107
3108 ++p;
3109 }
3110
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003111 j =
3112# if defined(FEAT_EVAL)
3113 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3114# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003115 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3116 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003117 va_arg(ap, int));
3118
Christ van Willegenc35fc032024-03-14 18:30:41 +01003119 if (j > MAX_ALLOWED_STRING_WIDTH)
3120 {
zeertzjq0dff3152024-07-29 20:28:14 +02003121 if (tvs != NULL)
3122 {
3123 format_overflow_error(digstart);
3124 goto error;
3125 }
3126 else
3127 j = MAX_ALLOWED_STRING_WIDTH;
Christ van Willegenc35fc032024-03-14 18:30:41 +01003128 }
3129
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003130 if (j >= 0)
3131 min_field_width = j;
3132 else
3133 {
3134 min_field_width = -j;
3135 justify_left = 1;
3136 }
3137 }
3138 else if (VIM_ISDIGIT((int)(*p)))
3139 {
3140 // size_t could be wider than unsigned int; make sure we treat
3141 // argument like common implementations do
Christ van Willegenc35fc032024-03-14 18:30:41 +01003142 const char *digstart = p;
3143 unsigned int uj;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003144
zeertzjq0dff3152024-07-29 20:28:14 +02003145 if (get_unsigned_int(digstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01003146 goto error;
3147
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003148 min_field_width = uj;
3149 }
3150
3151 // parse precision
3152 if (*p == '.')
3153 {
3154 p++;
3155 precision_specified = 1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003156
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003157 if (VIM_ISDIGIT((int)(*p)))
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003158 {
3159 // size_t could be wider than unsigned int; make sure we
3160 // treat argument like common implementations do
Christ van Willegenc35fc032024-03-14 18:30:41 +01003161 const char *digstart = p;
3162 unsigned int uj;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003163
zeertzjq0dff3152024-07-29 20:28:14 +02003164 if (get_unsigned_int(digstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01003165 goto error;
3166
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003167 precision = uj;
3168 }
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003169 else if (*p == '*')
3170 {
3171 int j;
Christ van Willegenc35fc032024-03-14 18:30:41 +01003172 const char *digstart = p;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003173
3174 p++;
3175
3176 if (VIM_ISDIGIT((int)(*p)))
3177 {
3178 // positional argument
Christ van Willegenc35fc032024-03-14 18:30:41 +01003179 unsigned int uj;
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003180
zeertzjq0dff3152024-07-29 20:28:14 +02003181 if (get_unsigned_int(digstart, &p, &uj, tvs != NULL) == FAIL)
Christ van Willegenc35fc032024-03-14 18:30:41 +01003182 goto error;
3183
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003184 arg_idx = uj;
3185
3186 ++p;
3187 }
3188
3189 j =
3190# if defined(FEAT_EVAL)
3191 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3192# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003193 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3194 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003195 va_arg(ap, int));
3196
Christ van Willegenc35fc032024-03-14 18:30:41 +01003197 if (j > MAX_ALLOWED_STRING_WIDTH)
3198 {
zeertzjq0dff3152024-07-29 20:28:14 +02003199 if (tvs != NULL)
3200 {
3201 format_overflow_error(digstart);
3202 goto error;
3203 }
3204 else
3205 j = MAX_ALLOWED_STRING_WIDTH;
Christ van Willegenc35fc032024-03-14 18:30:41 +01003206 }
3207
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003208 if (j >= 0)
3209 precision = j;
3210 else
3211 {
3212 precision_specified = 0;
3213 precision = 0;
3214 }
3215 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003216 }
3217
3218 // parse 'h', 'l' and 'll' length modifiers
3219 if (*p == 'h' || *p == 'l')
3220 {
3221 length_modifier = *p;
3222 p++;
3223 if (length_modifier == 'l' && *p == 'l')
3224 {
3225 // double l = __int64 / varnumber_T
3226 length_modifier = 'L';
3227 p++;
3228 }
3229 }
3230 fmt_spec = *p;
3231
3232 // common synonyms:
3233 switch (fmt_spec)
3234 {
3235 case 'i': fmt_spec = 'd'; break;
3236 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
3237 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
3238 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
3239 default: break;
3240 }
3241
3242# if defined(FEAT_EVAL)
3243 switch (fmt_spec)
3244 {
3245 case 'd': case 'u': case 'o': case 'x': case 'X':
3246 if (tvs != NULL && length_modifier == '\0')
3247 length_modifier = 'L';
3248 }
3249# endif
3250
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003251 if (pos_arg != -1)
3252 arg_idx = pos_arg;
3253
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003254 // get parameter value, do initial processing
3255 switch (fmt_spec)
3256 {
3257 // '%' and 'c' behave similar to 's' regarding flags and field
3258 // widths
3259 case '%':
3260 case 'c':
3261 case 's':
3262 case 'S':
3263 str_arg_l = 1;
3264 switch (fmt_spec)
3265 {
3266 case '%':
3267 str_arg = p;
3268 break;
3269
3270 case 'c':
3271 {
3272 int j;
3273
3274 j =
3275# if defined(FEAT_EVAL)
3276 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3277# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003278 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3279 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003280 va_arg(ap, int));
3281
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003282 // standard demands unsigned char
3283 uchar_arg = (unsigned char)j;
3284 str_arg = (char *)&uchar_arg;
3285 break;
3286 }
3287
3288 case 's':
3289 case 'S':
3290 str_arg =
3291# if defined(FEAT_EVAL)
3292 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
3293# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003294 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3295 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003296 va_arg(ap, char *));
3297
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003298 if (str_arg == NULL)
3299 {
3300 str_arg = "[NULL]";
3301 str_arg_l = 6;
3302 }
3303 // make sure not to address string beyond the specified
3304 // precision !!!
3305 else if (!precision_specified)
3306 str_arg_l = strlen(str_arg);
3307 // truncate string if necessary as requested by precision
3308 else if (precision == 0)
3309 str_arg_l = 0;
3310 else
3311 {
3312 // Don't put the #if inside memchr(), it can be a
3313 // macro.
3314 // memchr on HP does not like n > 2^31 !!!
3315 char *q = memchr(str_arg, '\0',
3316 precision <= (size_t)0x7fffffffL ? precision
3317 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00003318
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003319 str_arg_l = (q == NULL) ? precision
3320 : (size_t)(q - str_arg);
3321 }
3322 if (fmt_spec == 'S')
3323 {
presuku1f2453f2021-11-24 15:32:57 +00003324 char_u *p1;
3325 size_t i;
3326 int cell;
presukud85fccd2021-11-20 19:38:31 +00003327
presuku1f2453f2021-11-24 15:32:57 +00003328 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003329 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00003330 {
3331 cell = mb_ptr2cells(p1);
3332 if (precision_specified && i + cell > precision)
3333 break;
3334 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003335 }
presuku1f2453f2021-11-24 15:32:57 +00003336
3337 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00003338 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00003339 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003340 }
3341 break;
3342
3343 default:
3344 break;
3345 }
3346 break;
3347
3348 case 'd': case 'u':
3349 case 'b': case 'B':
3350 case 'o':
3351 case 'x': case 'X':
3352 case 'p':
3353 {
3354 // NOTE: the u, b, o, x, X and p conversion specifiers
3355 // imply the value is unsigned; d implies a signed
3356 // value
3357
3358 // 0 if numeric argument is zero (or if pointer is
3359 // NULL for 'p'), +1 if greater than zero (or nonzero
3360 // for unsigned arguments), -1 if negative (unsigned
3361 // argument is never negative)
3362 int arg_sign = 0;
3363
3364 // only set for length modifier h, or for no length
3365 // modifiers
3366 int int_arg = 0;
3367 unsigned int uint_arg = 0;
3368
3369 // only set for length modifier l
3370 long int long_arg = 0;
3371 unsigned long int ulong_arg = 0;
3372
3373 // only set for length modifier ll
3374 varnumber_T llong_arg = 0;
3375 uvarnumber_T ullong_arg = 0;
3376
3377 // only set for b conversion
3378 uvarnumber_T bin_arg = 0;
3379
3380 // pointer argument value -only defined for p
3381 // conversion
3382 void *ptr_arg = NULL;
3383
3384 if (fmt_spec == 'p')
3385 {
3386 length_modifier = '\0';
3387 ptr_arg =
3388# if defined(FEAT_EVAL)
3389 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
3390 NULL) :
3391# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003392 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3393 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003394 va_arg(ap, void *));
3395
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003396 if (ptr_arg != NULL)
3397 arg_sign = 1;
3398 }
3399 else if (fmt_spec == 'b' || fmt_spec == 'B')
3400 {
3401 bin_arg =
3402# if defined(FEAT_EVAL)
3403 tvs != NULL ?
3404 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
3405# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003406 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3407 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003408 va_arg(ap, uvarnumber_T));
3409
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003410 if (bin_arg != 0)
3411 arg_sign = 1;
3412 }
3413 else if (fmt_spec == 'd')
3414 {
3415 // signed
3416 switch (length_modifier)
3417 {
3418 case '\0':
3419 case 'h':
3420 // char and short arguments are passed as int.
3421 int_arg =
3422# if defined(FEAT_EVAL)
3423 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3424# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003425 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3426 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003427 va_arg(ap, int));
3428
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003429 if (int_arg > 0)
3430 arg_sign = 1;
3431 else if (int_arg < 0)
3432 arg_sign = -1;
3433 break;
3434 case 'l':
3435 long_arg =
3436# if defined(FEAT_EVAL)
3437 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3438# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003439 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3440 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003441 va_arg(ap, long int));
3442
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003443 if (long_arg > 0)
3444 arg_sign = 1;
3445 else if (long_arg < 0)
3446 arg_sign = -1;
3447 break;
3448 case 'L':
3449 llong_arg =
3450# if defined(FEAT_EVAL)
3451 tvs != NULL ? tv_nr(tvs, &arg_idx) :
3452# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003453 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3454 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003455 va_arg(ap, varnumber_T));
3456
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003457 if (llong_arg > 0)
3458 arg_sign = 1;
3459 else if (llong_arg < 0)
3460 arg_sign = -1;
3461 break;
3462 }
3463 }
3464 else
3465 {
3466 // unsigned
3467 switch (length_modifier)
3468 {
3469 case '\0':
3470 case 'h':
3471 uint_arg =
3472# if defined(FEAT_EVAL)
3473 tvs != NULL ? (unsigned)
3474 tv_nr(tvs, &arg_idx) :
3475# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003476 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3477 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003478 va_arg(ap, unsigned int));
3479
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003480 if (uint_arg != 0)
3481 arg_sign = 1;
3482 break;
3483 case 'l':
3484 ulong_arg =
3485# if defined(FEAT_EVAL)
3486 tvs != NULL ? (unsigned long)
3487 tv_nr(tvs, &arg_idx) :
3488# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003489 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3490 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003491 va_arg(ap, unsigned long int));
3492
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003493 if (ulong_arg != 0)
3494 arg_sign = 1;
3495 break;
3496 case 'L':
3497 ullong_arg =
3498# if defined(FEAT_EVAL)
3499 tvs != NULL ? (uvarnumber_T)
3500 tv_nr(tvs, &arg_idx) :
3501# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003502 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3503 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003504 va_arg(ap, uvarnumber_T));
3505
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003506 if (ullong_arg != 0)
3507 arg_sign = 1;
3508 break;
3509 }
3510 }
3511
3512 str_arg = tmp;
3513 str_arg_l = 0;
3514
3515 // NOTE:
3516 // For d, i, u, o, x, and X conversions, if precision is
3517 // specified, the '0' flag should be ignored. This is so
3518 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
3519 // FreeBSD, NetBSD; but not with Perl.
3520 if (precision_specified)
3521 zero_padding = 0;
3522 if (fmt_spec == 'd')
3523 {
3524 if (force_sign && arg_sign >= 0)
3525 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
3526 // leave negative numbers for sprintf to handle, to
3527 // avoid handling tricky cases like (short int)-32768
3528 }
3529 else if (alternate_form)
3530 {
3531 if (arg_sign != 0
3532 && (fmt_spec == 'b' || fmt_spec == 'B'
3533 || fmt_spec == 'x' || fmt_spec == 'X') )
3534 {
3535 tmp[str_arg_l++] = '0';
3536 tmp[str_arg_l++] = fmt_spec;
3537 }
3538 // alternate form should have no effect for p
3539 // conversion, but ...
3540 }
3541
3542 zero_padding_insertion_ind = str_arg_l;
3543 if (!precision_specified)
3544 precision = 1; // default precision is 1
3545 if (precision == 0 && arg_sign == 0)
3546 {
3547 // When zero value is formatted with an explicit
3548 // precision 0, the resulting formatted string is
3549 // empty (d, i, u, b, B, o, x, X, p).
3550 }
3551 else
3552 {
3553 char f[6];
3554 int f_l = 0;
3555
3556 // construct a simple format string for sprintf
3557 f[f_l++] = '%';
3558 if (!length_modifier)
3559 ;
3560 else if (length_modifier == 'L')
3561 {
3562# ifdef MSWIN
3563 f[f_l++] = 'I';
3564 f[f_l++] = '6';
3565 f[f_l++] = '4';
3566# else
3567 f[f_l++] = 'l';
3568 f[f_l++] = 'l';
3569# endif
3570 }
3571 else
3572 f[f_l++] = length_modifier;
3573 f[f_l++] = fmt_spec;
3574 f[f_l++] = '\0';
3575
3576 if (fmt_spec == 'p')
3577 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
3578 else if (fmt_spec == 'b' || fmt_spec == 'B')
3579 {
3580 char b[8 * sizeof(uvarnumber_T)];
3581 size_t b_l = 0;
3582 uvarnumber_T bn = bin_arg;
3583
3584 do
3585 {
3586 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
3587 bn >>= 1;
3588 }
3589 while (bn != 0);
3590
3591 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
3592 str_arg_l += b_l;
3593 }
3594 else if (fmt_spec == 'd')
3595 {
3596 // signed
3597 switch (length_modifier)
3598 {
3599 case '\0': str_arg_l += sprintf(
3600 tmp + str_arg_l, f,
3601 int_arg);
3602 break;
3603 case 'h': str_arg_l += sprintf(
3604 tmp + str_arg_l, f,
3605 (short)int_arg);
3606 break;
3607 case 'l': str_arg_l += sprintf(
3608 tmp + str_arg_l, f, long_arg);
3609 break;
3610 case 'L': str_arg_l += sprintf(
3611 tmp + str_arg_l, f, llong_arg);
3612 break;
3613 }
3614 }
3615 else
3616 {
3617 // unsigned
3618 switch (length_modifier)
3619 {
3620 case '\0': str_arg_l += sprintf(
3621 tmp + str_arg_l, f,
3622 uint_arg);
3623 break;
3624 case 'h': str_arg_l += sprintf(
3625 tmp + str_arg_l, f,
3626 (unsigned short)uint_arg);
3627 break;
3628 case 'l': str_arg_l += sprintf(
3629 tmp + str_arg_l, f, ulong_arg);
3630 break;
3631 case 'L': str_arg_l += sprintf(
3632 tmp + str_arg_l, f, ullong_arg);
3633 break;
3634 }
3635 }
3636
3637 // include the optional minus sign and possible
3638 // "0x" in the region before the zero padding
3639 // insertion point
3640 if (zero_padding_insertion_ind < str_arg_l
3641 && tmp[zero_padding_insertion_ind] == '-')
3642 zero_padding_insertion_ind++;
3643 if (zero_padding_insertion_ind + 1 < str_arg_l
3644 && tmp[zero_padding_insertion_ind] == '0'
3645 && (tmp[zero_padding_insertion_ind + 1] == 'x'
3646 || tmp[zero_padding_insertion_ind + 1] == 'X'))
3647 zero_padding_insertion_ind += 2;
3648 }
3649
3650 {
3651 size_t num_of_digits = str_arg_l
3652 - zero_padding_insertion_ind;
3653
3654 if (alternate_form && fmt_spec == 'o'
3655 // unless zero is already the first
3656 // character
3657 && !(zero_padding_insertion_ind < str_arg_l
3658 && tmp[zero_padding_insertion_ind] == '0'))
3659 {
3660 // assure leading zero for alternate-form
3661 // octal numbers
3662 if (!precision_specified
3663 || precision < num_of_digits + 1)
3664 {
3665 // precision is increased to force the
3666 // first character to be zero, except if a
3667 // zero value is formatted with an
3668 // explicit precision of zero
3669 precision = num_of_digits + 1;
3670 }
3671 }
3672 // zero padding to specified precision?
3673 if (num_of_digits < precision)
3674 number_of_zeros_to_pad = precision - num_of_digits;
3675 }
3676 // zero padding to specified minimal field width?
3677 if (!justify_left && zero_padding)
3678 {
3679 int n = (int)(min_field_width - (str_arg_l
3680 + number_of_zeros_to_pad));
3681 if (n > 0)
3682 number_of_zeros_to_pad += n;
3683 }
3684 break;
3685 }
3686
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003687 case 'f':
3688 case 'F':
3689 case 'e':
3690 case 'E':
3691 case 'g':
3692 case 'G':
3693 {
3694 // Floating point.
3695 double f;
3696 double abs_f;
3697 char format[40];
3698 int l;
3699 int remove_trailing_zeroes = FALSE;
3700
3701 f =
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003702# if defined(FEAT_EVAL)
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003703 tvs != NULL ? tv_float(tvs, &arg_idx) :
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003704# endif
Christ van Willegenaa90d4f2023-09-03 17:22:37 +02003705 (skip_to_arg(ap_types, ap_start, &ap, &arg_idx,
3706 &arg_cur, fmt),
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003707 va_arg(ap, double));
3708
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003709 abs_f = f < 0 ? -f : f;
3710
3711 if (fmt_spec == 'g' || fmt_spec == 'G')
3712 {
3713 // Would be nice to use %g directly, but it prints
3714 // "1.0" as "1", we don't want that.
3715 if ((abs_f >= 0.001 && abs_f < 10000000.0)
3716 || abs_f == 0.0)
3717 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
3718 else
3719 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
3720 remove_trailing_zeroes = TRUE;
3721 }
3722
3723 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003724# ifdef VAX
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003725 abs_f > 1.0e38
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003726# else
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003727 abs_f > 1.0e307
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01003728# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003729 )
3730 {
3731 // Avoid a buffer overflow
3732 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
3733 force_sign, space_for_positive));
3734 str_arg_l = STRLEN(tmp);
3735 zero_padding = 0;
3736 }
3737 else
3738 {
3739 if (isnan(f))
3740 {
3741 // Not a number: nan or NAN
3742 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
3743 : "nan");
3744 str_arg_l = 3;
3745 zero_padding = 0;
3746 }
3747 else if (isinf(f))
3748 {
3749 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
3750 force_sign, space_for_positive));
3751 str_arg_l = STRLEN(tmp);
3752 zero_padding = 0;
3753 }
3754 else
3755 {
3756 // Regular float number
3757 format[0] = '%';
3758 l = 1;
3759 if (force_sign)
3760 format[l++] = space_for_positive ? ' ' : '+';
3761 if (precision_specified)
3762 {
3763 size_t max_prec = TMP_LEN - 10;
3764
3765 // Make sure we don't get more digits than we
3766 // have room for.
3767 if ((fmt_spec == 'f' || fmt_spec == 'F')
3768 && abs_f > 1.0)
3769 max_prec -= (size_t)log10(abs_f);
3770 if (precision > max_prec)
3771 precision = max_prec;
3772 l += sprintf(format + l, ".%d", (int)precision);
3773 }
3774 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
3775 format[l + 1] = NUL;
3776
3777 str_arg_l = sprintf(tmp, format, f);
3778 }
3779
3780 if (remove_trailing_zeroes)
3781 {
3782 int i;
3783 char *tp;
3784
3785 // Using %g or %G: remove superfluous zeroes.
3786 if (fmt_spec == 'f' || fmt_spec == 'F')
3787 tp = tmp + str_arg_l - 1;
3788 else
3789 {
3790 tp = (char *)vim_strchr((char_u *)tmp,
3791 fmt_spec == 'e' ? 'e' : 'E');
3792 if (tp != NULL)
3793 {
3794 // Remove superfluous '+' and leading
3795 // zeroes from the exponent.
3796 if (tp[1] == '+')
3797 {
3798 // Change "1.0e+07" to "1.0e07"
3799 STRMOVE(tp + 1, tp + 2);
3800 --str_arg_l;
3801 }
3802 i = (tp[1] == '-') ? 2 : 1;
3803 while (tp[i] == '0')
3804 {
3805 // Change "1.0e07" to "1.0e7"
3806 STRMOVE(tp + i, tp + i + 1);
3807 --str_arg_l;
3808 }
3809 --tp;
3810 }
3811 }
3812
3813 if (tp != NULL && !precision_specified)
3814 // Remove trailing zeroes, but keep the one
3815 // just after a dot.
3816 while (tp > tmp + 2 && *tp == '0'
3817 && tp[-1] != '.')
3818 {
3819 STRMOVE(tp, tp + 1);
3820 --tp;
3821 --str_arg_l;
3822 }
3823 }
3824 else
3825 {
3826 char *tp;
3827
3828 // Be consistent: some printf("%e") use 1.0e+12
3829 // and some 1.0e+012. Remove one zero in the last
3830 // case.
3831 tp = (char *)vim_strchr((char_u *)tmp,
3832 fmt_spec == 'e' ? 'e' : 'E');
3833 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
3834 && tp[2] == '0'
3835 && vim_isdigit(tp[3])
3836 && vim_isdigit(tp[4]))
3837 {
3838 STRMOVE(tp + 2, tp + 3);
3839 --str_arg_l;
3840 }
3841 }
3842 }
3843 if (zero_padding && min_field_width > str_arg_l
3844 && (tmp[0] == '-' || force_sign))
3845 {
3846 // padding 0's should be inserted after the sign
3847 number_of_zeros_to_pad = min_field_width - str_arg_l;
3848 zero_padding_insertion_ind = 1;
3849 }
3850 str_arg = tmp;
3851 break;
3852 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003853
3854 default:
3855 // unrecognized conversion specifier, keep format string
3856 // as-is
3857 zero_padding = 0; // turn zero padding off for non-numeric
3858 // conversion
3859 justify_left = 1;
3860 min_field_width = 0; // reset flags
3861
3862 // discard the unrecognized conversion, just keep *
3863 // the unrecognized conversion character
3864 str_arg = p;
3865 str_arg_l = 0;
3866 if (*p != NUL)
3867 str_arg_l++; // include invalid conversion specifier
3868 // unchanged if not at end-of-string
3869 break;
3870 }
3871
3872 if (*p != NUL)
3873 p++; // step over the just processed conversion specifier
3874
3875 // insert padding to the left as requested by min_field_width;
3876 // this does not include the zero padding in case of numerical
3877 // conversions
3878 if (!justify_left)
3879 {
3880 // left padding with blank or zero
3881 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
3882
3883 if (pn > 0)
3884 {
3885 if (str_l < str_m)
3886 {
3887 size_t avail = str_m - str_l;
3888
3889 vim_memset(str + str_l, zero_padding ? '0' : ' ',
3890 (size_t)pn > avail ? avail
3891 : (size_t)pn);
3892 }
3893 str_l += pn;
3894 }
3895 }
3896
3897 // zero padding as requested by the precision or by the minimal
3898 // field width for numeric conversions required?
3899 if (number_of_zeros_to_pad == 0)
3900 {
3901 // will not copy first part of numeric right now, *
3902 // force it to be copied later in its entirety
3903 zero_padding_insertion_ind = 0;
3904 }
3905 else
3906 {
3907 // insert first part of numerics (sign or '0x') before zero
3908 // padding
3909 int zn = (int)zero_padding_insertion_ind;
3910
3911 if (zn > 0)
3912 {
3913 if (str_l < str_m)
3914 {
3915 size_t avail = str_m - str_l;
3916
3917 mch_memmove(str + str_l, str_arg,
3918 (size_t)zn > avail ? avail
3919 : (size_t)zn);
3920 }
3921 str_l += zn;
3922 }
3923
3924 // insert zero padding as requested by the precision or min
3925 // field width
3926 zn = (int)number_of_zeros_to_pad;
3927 if (zn > 0)
3928 {
3929 if (str_l < str_m)
3930 {
3931 size_t avail = str_m - str_l;
3932
3933 vim_memset(str + str_l, '0',
3934 (size_t)zn > avail ? avail
3935 : (size_t)zn);
3936 }
3937 str_l += zn;
3938 }
3939 }
3940
3941 // insert formatted string
3942 // (or as-is conversion specifier for unknown conversions)
3943 {
3944 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
3945
3946 if (sn > 0)
3947 {
3948 if (str_l < str_m)
3949 {
3950 size_t avail = str_m - str_l;
3951
3952 mch_memmove(str + str_l,
3953 str_arg + zero_padding_insertion_ind,
3954 (size_t)sn > avail ? avail : (size_t)sn);
3955 }
3956 str_l += sn;
3957 }
3958 }
3959
3960 // insert right padding
3961 if (justify_left)
3962 {
3963 // right blank padding to the field width
3964 int pn = (int)(min_field_width
3965 - (str_arg_l + number_of_zeros_to_pad));
3966
3967 if (pn > 0)
3968 {
3969 if (str_l < str_m)
3970 {
3971 size_t avail = str_m - str_l;
3972
3973 vim_memset(str + str_l, ' ',
3974 (size_t)pn > avail ? avail
3975 : (size_t)pn);
3976 }
3977 str_l += pn;
3978 }
3979 }
3980 vim_free(tofree);
3981 }
3982 }
3983
3984 if (str_m > 0)
3985 {
3986 // make sure the string is nul-terminated even at the expense of
3987 // overwriting the last character (shouldn't happen, but just in case)
3988 //
3989 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
3990 }
3991
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003992 if (tvs != NULL && tvs[num_posarg != 0 ? num_posarg : arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar677658a2022-01-05 16:09:06 +00003993 emsg(_(e_too_many_arguments_to_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003994
Christ van Willegenc35fc032024-03-14 18:30:41 +01003995error:
K.Takata4c215ec2023-08-26 18:05:08 +02003996 vim_free((char*)ap_types);
Christ van Willegen0c6181f2023-08-13 18:03:14 +02003997 va_end(ap);
3998
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003999 // Return the number of characters formatted (excluding trailing nul
4000 // character), that is, the number of characters that would have been
4001 // written to the buffer if it were large enough.
4002 return (int)str_l;
4003}
4004
4005#endif // PROTO