blob: 6a6b0f43c0800acaf01a1e5a216f3356cd79f7f6 [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);
45 if (p != NULL)
46 {
47 STRNCPY(p, string, len);
48 p[len] = NUL;
49 }
50 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);
97 if (escaped_string != NULL)
98 {
99 p2 = escaped_string;
100 for (p = string; *p; p++)
101 {
102 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
103 {
104 mch_memmove(p2, p, (size_t)l);
105 p2 += l;
106 p += l - 1; // skip multibyte char
107 continue;
108 }
109 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
110 *p2++ = cc;
111 *p2++ = *p;
112 }
113 *p2 = NUL;
114 }
115 return escaped_string;
116}
117
118/*
119 * Return TRUE when 'shell' has "csh" in the tail.
120 */
121 int
122csh_like_shell(void)
123{
124 return (strstr((char *)gettail(p_sh), "csh") != NULL);
125}
126
127/*
Jason Cox6e823512021-08-29 12:36:49 +0200128 * Return TRUE when 'shell' has "fish" in the tail.
129 */
Dominique Pellede05ae72021-08-30 19:57:34 +0200130 static int
Jason Cox6e823512021-08-29 12:36:49 +0200131fish_like_shell(void)
132{
133 return (strstr((char *)gettail(p_sh), "fish") != NULL);
134}
135
136/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200137 * Escape "string" for use as a shell argument with system().
138 * This uses single quotes, except when we know we need to use double quotes
139 * (MS-DOS and MS-Windows not using PowerShell and without 'shellslash' set).
140 * PowerShell also uses a novel escaping for enclosed single quotes - double
141 * them up.
142 * Escape a newline, depending on the 'shell' option.
143 * When "do_special" is TRUE also replace "!", "%", "#" and things starting
144 * with "<" like "<cfile>".
145 * When "do_newline" is FALSE do not escape newline unless it is csh shell.
146 * Returns the result in allocated memory, NULL if we have run out.
147 */
148 char_u *
149vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
150{
151 unsigned length;
152 char_u *p;
153 char_u *d;
154 char_u *escaped_string;
155 int l;
156 int csh_like;
Jason Cox6e823512021-08-29 12:36:49 +0200157 int fish_like;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200158 char_u *shname;
159 int powershell;
160# ifdef MSWIN
161 int double_quotes;
162# endif
163
164 // Only csh and similar shells expand '!' within single quotes. For sh and
165 // the like we must not put a backslash before it, it will be taken
166 // literally. If do_special is set the '!' will be escaped twice.
167 // Csh also needs to have "\n" escaped twice when do_special is set.
168 csh_like = csh_like_shell();
169
Jason Cox6e823512021-08-29 12:36:49 +0200170 // Fish shell uses '\' as an escape character within single quotes, so '\'
171 // itself must be escaped to get a literal '\'.
172 fish_like = fish_like_shell();
173
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200174 // PowerShell uses it's own version for quoting single quotes
175 shname = gettail(p_sh);
176 powershell = strstr((char *)shname, "pwsh") != NULL;
177# ifdef MSWIN
178 powershell = powershell || strstr((char *)shname, "powershell") != NULL;
179 // PowerShell only accepts single quotes so override shellslash.
180 double_quotes = !powershell && !p_ssl;
181# endif
182
183 // First count the number of extra bytes required.
184 length = (unsigned)STRLEN(string) + 3; // two quotes and a trailing NUL
185 for (p = string; *p != NUL; MB_PTR_ADV(p))
186 {
187# ifdef MSWIN
188 if (double_quotes)
189 {
190 if (*p == '"')
191 ++length; // " -> ""
192 }
193 else
194# endif
195 if (*p == '\'')
196 {
197 if (powershell)
198 length +=2; // ' => ''
199 else
200 length += 3; // ' => '\''
201 }
202 if ((*p == '\n' && (csh_like || do_newline))
203 || (*p == '!' && (csh_like || do_special)))
204 {
205 ++length; // insert backslash
206 if (csh_like && do_special)
207 ++length; // insert backslash
208 }
209 if (do_special && find_cmdline_var(p, &l) >= 0)
210 {
211 ++length; // insert backslash
212 p += l - 1;
213 }
Jason Cox6e823512021-08-29 12:36:49 +0200214 if (*p == '\\' && fish_like)
215 ++length; // insert backslash
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200216 }
217
218 // Allocate memory for the result and fill it.
219 escaped_string = alloc(length);
220 if (escaped_string != NULL)
221 {
222 d = escaped_string;
223
224 // add opening quote
225# ifdef MSWIN
226 if (double_quotes)
227 *d++ = '"';
228 else
229# endif
230 *d++ = '\'';
231
232 for (p = string; *p != NUL; )
233 {
234# ifdef MSWIN
235 if (double_quotes)
236 {
237 if (*p == '"')
238 {
239 *d++ = '"';
240 *d++ = '"';
241 ++p;
242 continue;
243 }
244 }
245 else
246# endif
247 if (*p == '\'')
248 {
249 if (powershell)
250 {
251 *d++ = '\'';
252 *d++ = '\'';
253 }
254 else
255 {
256 *d++ = '\'';
257 *d++ = '\\';
258 *d++ = '\'';
259 *d++ = '\'';
260 }
261 ++p;
262 continue;
263 }
264 if ((*p == '\n' && (csh_like || do_newline))
265 || (*p == '!' && (csh_like || do_special)))
266 {
267 *d++ = '\\';
268 if (csh_like && do_special)
269 *d++ = '\\';
270 *d++ = *p++;
271 continue;
272 }
273 if (do_special && find_cmdline_var(p, &l) >= 0)
274 {
275 *d++ = '\\'; // insert backslash
276 while (--l >= 0) // copy the var
277 *d++ = *p++;
278 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
341 if (p != NULL)
342 {
343 p2 = p;
344 while ((c = *p2) != NUL)
345#ifdef EBCDIC
346 *p2++ = isalpha(c) ? toupper(c) : c;
347#else
348 *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
349#endif
350 }
351}
352
353#if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
354/*
355 * Make string "s" all upper-case and return it in allocated memory.
356 * Handles multi-byte characters as well as possible.
357 * Returns NULL when out of memory.
358 */
359 static char_u *
360strup_save(char_u *orig)
361{
362 char_u *p;
363 char_u *res;
364
365 res = p = vim_strsave(orig);
366
367 if (res != NULL)
368 while (*p != NUL)
369 {
370 int l;
371
372 if (enc_utf8)
373 {
374 int c, uc;
375 int newl;
376 char_u *s;
377
378 c = utf_ptr2char(p);
379 l = utf_ptr2len(p);
380 if (c == 0)
381 {
382 // overlong sequence, use only the first byte
383 c = *p;
384 l = 1;
385 }
386 uc = utf_toupper(c);
387
388 // Reallocate string when byte count changes. This is rare,
389 // thus it's OK to do another malloc()/free().
390 newl = utf_char2len(uc);
391 if (newl != l)
392 {
393 s = alloc(STRLEN(res) + 1 + newl - l);
394 if (s == NULL)
395 {
396 vim_free(res);
397 return NULL;
398 }
399 mch_memmove(s, res, p - res);
400 STRCPY(s + (p - res) + newl, p + l);
401 p = s + (p - res);
402 vim_free(res);
403 res = s;
404 }
405
406 utf_char2bytes(uc, p);
407 p += newl;
408 }
409 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
410 p += l; // skip multi-byte character
411 else
412 {
413 *p = TOUPPER_LOC(*p); // note that toupper() can be a macro
414 p++;
415 }
416 }
417
418 return res;
419}
420
421/*
422 * Make string "s" all lower-case and return it in allocated memory.
423 * Handles multi-byte characters as well as possible.
424 * Returns NULL when out of memory.
425 */
426 char_u *
427strlow_save(char_u *orig)
428{
429 char_u *p;
430 char_u *res;
431
432 res = p = vim_strsave(orig);
433
434 if (res != NULL)
435 while (*p != NUL)
436 {
437 int l;
438
439 if (enc_utf8)
440 {
441 int c, lc;
442 int newl;
443 char_u *s;
444
445 c = utf_ptr2char(p);
446 l = utf_ptr2len(p);
447 if (c == 0)
448 {
449 // overlong sequence, use only the first byte
450 c = *p;
451 l = 1;
452 }
453 lc = utf_tolower(c);
454
455 // Reallocate string when byte count changes. This is rare,
456 // thus it's OK to do another malloc()/free().
457 newl = utf_char2len(lc);
458 if (newl != l)
459 {
460 s = alloc(STRLEN(res) + 1 + newl - l);
461 if (s == NULL)
462 {
463 vim_free(res);
464 return NULL;
465 }
466 mch_memmove(s, res, p - res);
467 STRCPY(s + (p - res) + newl, p + l);
468 p = s + (p - res);
469 vim_free(res);
470 res = s;
471 }
472
473 utf_char2bytes(lc, p);
474 p += newl;
475 }
476 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
477 p += l; // skip multi-byte character
478 else
479 {
480 *p = TOLOWER_LOC(*p); // note that tolower() can be a macro
481 p++;
482 }
483 }
484
485 return res;
486}
487#endif
488
489/*
490 * delete spaces at the end of a string
491 */
492 void
493del_trailing_spaces(char_u *ptr)
494{
495 char_u *q;
496
497 q = ptr + STRLEN(ptr);
498 while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
499 *q = NUL;
500}
501
502/*
503 * Like strncpy(), but always terminate the result with one NUL.
504 * "to" must be "len + 1" long!
505 */
506 void
507vim_strncpy(char_u *to, char_u *from, size_t len)
508{
509 STRNCPY(to, from, len);
510 to[len] = NUL;
511}
512
513/*
514 * Like strcat(), but make sure the result fits in "tosize" bytes and is
515 * always NUL terminated. "from" and "to" may overlap.
516 */
517 void
518vim_strcat(char_u *to, char_u *from, size_t tosize)
519{
520 size_t tolen = STRLEN(to);
521 size_t fromlen = STRLEN(from);
522
523 if (tolen + fromlen + 1 > tosize)
524 {
525 mch_memmove(to + tolen, from, tosize - tolen - 1);
526 to[tosize - 1] = NUL;
527 }
528 else
529 mch_memmove(to + tolen, from, fromlen + 1);
530}
531
532#if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
533/*
534 * Compare two strings, ignoring case, using current locale.
535 * Doesn't work for multi-byte characters.
536 * return 0 for match, < 0 for smaller, > 0 for bigger
537 */
538 int
539vim_stricmp(char *s1, char *s2)
540{
541 int i;
542
543 for (;;)
544 {
545 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
546 if (i != 0)
547 return i; // this character different
548 if (*s1 == NUL)
549 break; // strings match until NUL
550 ++s1;
551 ++s2;
552 }
553 return 0; // strings match
554}
555#endif
556
557#if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
558/*
559 * Compare two strings, for length "len", ignoring case, using current locale.
560 * Doesn't work for multi-byte characters.
561 * return 0 for match, < 0 for smaller, > 0 for bigger
562 */
563 int
564vim_strnicmp(char *s1, char *s2, size_t len)
565{
566 int i;
567
568 while (len > 0)
569 {
570 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
571 if (i != 0)
572 return i; // this character different
573 if (*s1 == NUL)
574 break; // strings match until NUL
575 ++s1;
576 ++s2;
577 --len;
578 }
579 return 0; // strings match
580}
581#endif
582
583/*
584 * Search for first occurrence of "c" in "string".
585 * Version of strchr() that handles unsigned char strings with characters from
586 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
587 * end of the string.
588 */
589 char_u *
590vim_strchr(char_u *string, int c)
591{
592 char_u *p;
593 int b;
594
595 p = string;
596 if (enc_utf8 && c >= 0x80)
597 {
598 while (*p != NUL)
599 {
600 int l = utfc_ptr2len(p);
601
602 // Avoid matching an illegal byte here.
603 if (utf_ptr2char(p) == c && l > 1)
604 return p;
605 p += l;
606 }
607 return NULL;
608 }
609 if (enc_dbcs != 0 && c > 255)
610 {
611 int n2 = c & 0xff;
612
613 c = ((unsigned)c >> 8) & 0xff;
614 while ((b = *p) != NUL)
615 {
616 if (b == c && p[1] == n2)
617 return p;
618 p += (*mb_ptr2len)(p);
619 }
620 return NULL;
621 }
622 if (has_mbyte)
623 {
624 while ((b = *p) != NUL)
625 {
626 if (b == c)
627 return p;
628 p += (*mb_ptr2len)(p);
629 }
630 return NULL;
631 }
632 while ((b = *p) != NUL)
633 {
634 if (b == c)
635 return p;
636 ++p;
637 }
638 return NULL;
639}
640
641/*
642 * Version of strchr() that only works for bytes and handles unsigned char
643 * strings with characters above 128 correctly. It also doesn't return a
644 * pointer to the NUL at the end of the string.
645 */
646 char_u *
647vim_strbyte(char_u *string, int c)
648{
649 char_u *p = string;
650
651 while (*p != NUL)
652 {
653 if (*p == c)
654 return p;
655 ++p;
656 }
657 return NULL;
658}
659
660/*
661 * Search for last occurrence of "c" in "string".
662 * Version of strrchr() that handles unsigned char strings with characters from
663 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
664 * end of the string.
665 * Return NULL if not found.
666 * Does not handle multi-byte char for "c"!
667 */
668 char_u *
669vim_strrchr(char_u *string, int c)
670{
671 char_u *retval = NULL;
672 char_u *p = string;
673
674 while (*p)
675 {
676 if (*p == c)
677 retval = p;
678 MB_PTR_ADV(p);
679 }
680 return retval;
681}
682
683/*
684 * Vim's version of strpbrk(), in case it's missing.
685 * Don't generate a prototype for this, causes problems when it's not used.
686 */
687#ifndef PROTO
688# ifndef HAVE_STRPBRK
689# ifdef vim_strpbrk
690# undef vim_strpbrk
691# endif
692 char_u *
693vim_strpbrk(char_u *s, char_u *charset)
694{
695 while (*s)
696 {
697 if (vim_strchr(charset, *s) != NULL)
698 return s;
699 MB_PTR_ADV(s);
700 }
701 return NULL;
702}
703# endif
704#endif
705
706/*
707 * Sort an array of strings.
708 */
709static int sort_compare(const void *s1, const void *s2);
710
711 static int
712sort_compare(const void *s1, const void *s2)
713{
714 return STRCMP(*(char **)s1, *(char **)s2);
715}
716
717 void
718sort_strings(
719 char_u **files,
720 int count)
721{
722 qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
723}
724
725#if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
726/*
727 * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
728 * When "s" is NULL FALSE is returned.
729 */
730 int
731has_non_ascii(char_u *s)
732{
733 char_u *p;
734
735 if (s != NULL)
736 for (p = s; *p != NUL; ++p)
737 if (*p >= 128)
738 return TRUE;
739 return FALSE;
740}
741#endif
742
743/*
744 * Concatenate two strings and return the result in allocated memory.
745 * Returns NULL when out of memory.
746 */
747 char_u *
748concat_str(char_u *str1, char_u *str2)
749{
750 char_u *dest;
751 size_t l = str1 == NULL ? 0 : STRLEN(str1);
752
753 dest = alloc(l + (str2 == NULL ? 0 : STRLEN(str2)) + 1L);
754 if (dest != NULL)
755 {
756 if (str1 == NULL)
757 *dest = NUL;
758 else
759 STRCPY(dest, str1);
760 if (str2 != NULL)
761 STRCPY(dest + l, str2);
762 }
763 return dest;
764}
765
766#if defined(FEAT_EVAL) || defined(PROTO)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200767/*
768 * Return string "str" in ' quotes, doubling ' characters.
769 * If "str" is NULL an empty string is assumed.
770 * If "function" is TRUE make it function('string').
771 */
772 char_u *
773string_quote(char_u *str, int function)
774{
775 unsigned len;
776 char_u *p, *r, *s;
777
778 len = (function ? 13 : 3);
779 if (str != NULL)
780 {
781 len += (unsigned)STRLEN(str);
782 for (p = str; *p != NUL; MB_PTR_ADV(p))
783 if (*p == '\'')
784 ++len;
785 }
786 s = r = alloc(len);
787 if (r != NULL)
788 {
789 if (function)
790 {
791 STRCPY(r, "function('");
792 r += 10;
793 }
794 else
795 *r++ = '\'';
796 if (str != NULL)
797 for (p = str; *p != NUL; )
798 {
799 if (*p == '\'')
800 *r++ = '\'';
801 MB_COPY_CHAR(p, r);
802 }
803 *r++ = '\'';
804 if (function)
805 *r++ = ')';
806 *r++ = NUL;
807 }
808 return s;
809}
810
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000811/*
812 * Count the number of times "needle" occurs in string "haystack". Case is
813 * ignored if "ic" is TRUE.
814 */
815 long
816string_count(char_u *haystack, char_u *needle, int ic)
817{
818 long n = 0;
819 char_u *p = haystack;
820 char_u *next;
821
822 if (p == NULL || needle == NULL || *needle == NUL)
823 return 0;
824
825 if (ic)
826 {
827 size_t len = STRLEN(needle);
828
829 while (*p != NUL)
830 {
831 if (MB_STRNICMP(p, needle, len) == 0)
832 {
833 ++n;
834 p += len;
835 }
836 else
837 MB_PTR_ADV(p);
838 }
839 }
840 else
841 while ((next = (char_u *)strstr((char *)p, (char *)needle)) != NULL)
842 {
843 ++n;
844 p = next + STRLEN(needle);
845 }
846
847 return n;
848}
849
850/*
851 * Make a typval_T of the first character of "input" and store it in "output".
852 * Return OK or FAIL.
853 */
854 static int
855copy_first_char_to_tv(char_u *input, typval_T *output)
856{
857 char_u buf[MB_MAXBYTES + 1];
858 int len;
859
860 if (input == NULL || output == NULL)
861 return FAIL;
862
863 len = has_mbyte ? mb_ptr2len(input) : 1;
864 STRNCPY(buf, input, len);
865 buf[len] = NUL;
866 output->v_type = VAR_STRING;
867 output->vval.v_string = vim_strsave(buf);
868
869 return output->vval.v_string == NULL ? FAIL : OK;
870}
871
872/*
873 * Implementation of map() and filter() for a String. Apply "expr" to every
874 * character in string "str" and return the result in "rettv".
875 */
876 void
877string_filter_map(
878 char_u *str,
879 filtermap_T filtermap,
880 typval_T *expr,
881 typval_T *rettv)
882{
883 char_u *p;
884 typval_T tv;
885 garray_T ga;
886 int len = 0;
887 int idx = 0;
888 int rem;
889
890 rettv->v_type = VAR_STRING;
891 rettv->vval.v_string = NULL;
892
893 // set_vim_var_nr() doesn't set the type
894 set_vim_var_type(VV_KEY, VAR_NUMBER);
895
896 ga_init2(&ga, (int)sizeof(char), 80);
897 for (p = str; *p != NUL; p += len)
898 {
899 typval_T newtv;
900
901 if (copy_first_char_to_tv(p, &tv) == FAIL)
902 break;
903 len = (int)STRLEN(tv.vval.v_string);
904
905 set_vim_var_nr(VV_KEY, idx);
906 if (filter_map_one(&tv, expr, filtermap, &newtv, &rem) == FAIL
907 || did_emsg)
908 break;
909 if (did_emsg)
910 {
911 clear_tv(&newtv);
912 clear_tv(&tv);
913 break;
914 }
915 else if (filtermap != FILTERMAP_FILTER)
916 {
917 if (newtv.v_type != VAR_STRING)
918 {
919 clear_tv(&newtv);
920 clear_tv(&tv);
921 emsg(_(e_stringreq));
922 break;
923 }
924 else
925 ga_concat(&ga, newtv.vval.v_string);
926 }
927 else if (!rem)
928 ga_concat(&ga, tv.vval.v_string);
929
930 clear_tv(&newtv);
931 clear_tv(&tv);
932
933 ++idx;
934 }
935 ga_append(&ga, NUL);
936 rettv->vval.v_string = ga.ga_data;
937}
938
939/*
940 * reduce() String argvars[0] using the function 'funcname' with arguments in
941 * 'funcexe' starting with the initial value argvars[2] and return the result
942 * in 'rettv'.
943 */
944 void
945string_reduce(
946 typval_T *argvars,
947 char_u *func_name,
948 funcexe_T *funcexe,
949 typval_T *rettv)
950{
951 char_u *p = tv_get_string(&argvars[0]);
952 int len;
953 typval_T argv[3];
954 int r;
955 int called_emsg_start = called_emsg;
956
957 if (argvars[2].v_type == VAR_UNKNOWN)
958 {
959 if (*p == NUL)
960 {
961 semsg(_(e_reduceempty), "String");
962 return;
963 }
964 if (copy_first_char_to_tv(p, rettv) == FAIL)
965 return;
966 p += STRLEN(rettv->vval.v_string);
967 }
968 else if (argvars[2].v_type != VAR_STRING)
969 {
970 semsg(_(e_string_expected_for_argument_nr), 3);
971 return;
972 }
973 else
974 copy_tv(&argvars[2], rettv);
975
976 for ( ; *p != NUL; p += len)
977 {
978 argv[0] = *rettv;
979 if (copy_first_char_to_tv(p, &argv[1]) == FAIL)
980 break;
981 len = (int)STRLEN(argv[1].vval.v_string);
982 r = call_func(func_name, -1, rettv, 2, argv, funcexe);
983 clear_tv(&argv[0]);
984 clear_tv(&argv[1]);
985 if (r == FAIL || called_emsg != called_emsg_start)
986 return;
987 }
988}
989
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200990 static void
991byteidx(typval_T *argvars, typval_T *rettv, int comp UNUSED)
992{
993 char_u *t;
994 char_u *str;
995 varnumber_T idx;
996
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +0200997 rettv->vval.v_number = -1;
998
999 if (in_vim9script()
1000 && (check_for_string_arg(argvars, 0) == FAIL
1001 || check_for_number_arg(argvars, 1) == FAIL))
1002 return;
1003
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001004 str = tv_get_string_chk(&argvars[0]);
1005 idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001006 if (str == NULL || idx < 0)
1007 return;
1008
1009 t = str;
1010 for ( ; idx > 0; idx--)
1011 {
1012 if (*t == NUL) // EOL reached
1013 return;
1014 if (enc_utf8 && comp)
1015 t += utf_ptr2len(t);
1016 else
1017 t += (*mb_ptr2len)(t);
1018 }
1019 rettv->vval.v_number = (varnumber_T)(t - str);
1020}
1021
1022/*
1023 * "byteidx()" function
1024 */
1025 void
1026f_byteidx(typval_T *argvars, typval_T *rettv)
1027{
1028 byteidx(argvars, rettv, FALSE);
1029}
1030
1031/*
1032 * "byteidxcomp()" function
1033 */
1034 void
1035f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1036{
1037 byteidx(argvars, rettv, TRUE);
1038}
1039
1040/*
1041 * "charidx()" function
1042 */
1043 void
1044f_charidx(typval_T *argvars, typval_T *rettv)
1045{
1046 char_u *str;
1047 varnumber_T idx;
1048 varnumber_T countcc = FALSE;
1049 char_u *p;
1050 int len;
1051 int (*ptr2len)(char_u *);
1052
1053 rettv->vval.v_number = -1;
1054
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001055 if (in_vim9script()
1056 && (check_for_string_arg(argvars, 0) == FAIL
1057 || check_for_number_arg(argvars, 1) == FAIL
1058 || check_for_opt_bool_arg(argvars, 2) == FAIL))
1059 return;
1060
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001061 if (argvars[0].v_type != VAR_STRING || argvars[1].v_type != VAR_NUMBER
1062 || (argvars[2].v_type != VAR_UNKNOWN
1063 && argvars[2].v_type != VAR_NUMBER
1064 && argvars[2].v_type != VAR_BOOL))
1065 {
1066 emsg(_(e_invarg));
1067 return;
1068 }
1069
1070 str = tv_get_string_chk(&argvars[0]);
1071 idx = tv_get_number_chk(&argvars[1], NULL);
1072 if (str == NULL || idx < 0)
1073 return;
1074
1075 if (argvars[2].v_type != VAR_UNKNOWN)
1076 countcc = tv_get_bool(&argvars[2]);
1077 if (countcc < 0 || countcc > 1)
1078 {
1079 semsg(_(e_using_number_as_bool_nr), countcc);
1080 return;
1081 }
1082
1083 if (enc_utf8 && countcc)
1084 ptr2len = utf_ptr2len;
1085 else
1086 ptr2len = mb_ptr2len;
1087
1088 for (p = str, len = 0; p <= str + idx; len++)
1089 {
1090 if (*p == NUL)
1091 return;
1092 p += ptr2len(p);
1093 }
1094
1095 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1096}
1097
1098/*
1099 * "str2list()" function
1100 */
1101 void
1102f_str2list(typval_T *argvars, typval_T *rettv)
1103{
1104 char_u *p;
1105 int utf8 = FALSE;
1106
1107 if (rettv_list_alloc(rettv) == FAIL)
1108 return;
1109
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001110 if (in_vim9script()
1111 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001112 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001113 return;
1114
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001115 if (argvars[1].v_type != VAR_UNKNOWN)
1116 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1117
1118 p = tv_get_string(&argvars[0]);
1119
1120 if (has_mbyte || utf8)
1121 {
1122 int (*ptr2len)(char_u *);
1123 int (*ptr2char)(char_u *);
1124
1125 if (utf8 || enc_utf8)
1126 {
1127 ptr2len = utf_ptr2len;
1128 ptr2char = utf_ptr2char;
1129 }
1130 else
1131 {
1132 ptr2len = mb_ptr2len;
1133 ptr2char = mb_ptr2char;
1134 }
1135
1136 for ( ; *p != NUL; p += (*ptr2len)(p))
1137 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1138 }
1139 else
1140 for ( ; *p != NUL; ++p)
1141 list_append_number(rettv->vval.v_list, *p);
1142}
1143
1144/*
1145 * "str2nr()" function
1146 */
1147 void
1148f_str2nr(typval_T *argvars, typval_T *rettv)
1149{
1150 int base = 10;
1151 char_u *p;
1152 varnumber_T n;
1153 int what = 0;
1154 int isneg;
1155
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001156 if (in_vim9script()
1157 && (check_for_string_arg(argvars, 0) == FAIL
1158 || check_for_opt_number_arg(argvars, 1) == FAIL
1159 || (argvars[1].v_type != VAR_UNKNOWN
1160 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1161 return;
1162
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001163 if (argvars[1].v_type != VAR_UNKNOWN)
1164 {
1165 base = (int)tv_get_number(&argvars[1]);
1166 if (base != 2 && base != 8 && base != 10 && base != 16)
1167 {
1168 emsg(_(e_invarg));
1169 return;
1170 }
1171 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1172 what |= STR2NR_QUOTE;
1173 }
1174
1175 p = skipwhite(tv_get_string_strict(&argvars[0]));
1176 isneg = (*p == '-');
1177 if (*p == '+' || *p == '-')
1178 p = skipwhite(p + 1);
1179 switch (base)
1180 {
1181 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1182 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1183 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1184 }
1185 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE);
1186 // Text after the number is silently ignored.
1187 if (isneg)
1188 rettv->vval.v_number = -n;
1189 else
1190 rettv->vval.v_number = n;
1191
1192}
1193
1194/*
1195 * "strgetchar()" function
1196 */
1197 void
1198f_strgetchar(typval_T *argvars, typval_T *rettv)
1199{
1200 char_u *str;
1201 int len;
1202 int error = FALSE;
1203 int charidx;
1204 int byteidx = 0;
1205
1206 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001207
1208 if (in_vim9script()
1209 && (check_for_string_arg(argvars, 0) == FAIL
1210 || check_for_number_arg(argvars, 1) == FAIL))
1211 return;
1212
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001213 str = tv_get_string_chk(&argvars[0]);
1214 if (str == NULL)
1215 return;
1216 len = (int)STRLEN(str);
1217 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1218 if (error)
1219 return;
1220
1221 while (charidx >= 0 && byteidx < len)
1222 {
1223 if (charidx == 0)
1224 {
1225 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1226 break;
1227 }
1228 --charidx;
1229 byteidx += MB_CPTR2LEN(str + byteidx);
1230 }
1231}
1232
1233/*
1234 * "stridx()" function
1235 */
1236 void
1237f_stridx(typval_T *argvars, typval_T *rettv)
1238{
1239 char_u buf[NUMBUFLEN];
1240 char_u *needle;
1241 char_u *haystack;
1242 char_u *save_haystack;
1243 char_u *pos;
1244 int start_idx;
1245
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001246 if (in_vim9script()
1247 && (check_for_string_arg(argvars, 0) == FAIL
1248 || check_for_string_arg(argvars, 1) == FAIL
1249 || check_for_opt_number_arg(argvars, 2) == FAIL))
1250 return;
1251
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001252 needle = tv_get_string_chk(&argvars[1]);
1253 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1254 rettv->vval.v_number = -1;
1255 if (needle == NULL || haystack == NULL)
1256 return; // type error; errmsg already given
1257
1258 if (argvars[2].v_type != VAR_UNKNOWN)
1259 {
1260 int error = FALSE;
1261
1262 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1263 if (error || start_idx >= (int)STRLEN(haystack))
1264 return;
1265 if (start_idx >= 0)
1266 haystack += start_idx;
1267 }
1268
1269 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1270 if (pos != NULL)
1271 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1272}
1273
1274/*
1275 * "string()" function
1276 */
1277 void
1278f_string(typval_T *argvars, typval_T *rettv)
1279{
1280 char_u *tofree;
1281 char_u numbuf[NUMBUFLEN];
1282
1283 rettv->v_type = VAR_STRING;
1284 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1285 get_copyID());
1286 // Make a copy if we have a value but it's not in allocated memory.
1287 if (rettv->vval.v_string != NULL && tofree == NULL)
1288 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1289}
1290
1291/*
1292 * "strlen()" function
1293 */
1294 void
1295f_strlen(typval_T *argvars, typval_T *rettv)
1296{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001297 if (in_vim9script()
1298 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1299 return;
1300
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001301 rettv->vval.v_number = (varnumber_T)(STRLEN(
1302 tv_get_string(&argvars[0])));
1303}
1304
1305 static void
1306strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1307{
1308 char_u *s = tv_get_string(&argvars[0]);
1309 varnumber_T len = 0;
1310 int (*func_mb_ptr2char_adv)(char_u **pp);
1311
1312 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1313 while (*s != NUL)
1314 {
1315 func_mb_ptr2char_adv(&s);
1316 ++len;
1317 }
1318 rettv->vval.v_number = len;
1319}
1320
1321/*
1322 * "strcharlen()" function
1323 */
1324 void
1325f_strcharlen(typval_T *argvars, typval_T *rettv)
1326{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001327 if (in_vim9script()
1328 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1329 return;
1330
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001331 strchar_common(argvars, rettv, TRUE);
1332}
1333
1334/*
1335 * "strchars()" function
1336 */
1337 void
1338f_strchars(typval_T *argvars, typval_T *rettv)
1339{
1340 varnumber_T skipcc = FALSE;
1341
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001342 if (in_vim9script()
1343 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001344 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001345 return;
1346
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001347 if (argvars[1].v_type != VAR_UNKNOWN)
1348 skipcc = tv_get_bool(&argvars[1]);
1349 if (skipcc < 0 || skipcc > 1)
1350 semsg(_(e_using_number_as_bool_nr), skipcc);
1351 else
1352 strchar_common(argvars, rettv, skipcc);
1353}
1354
1355/*
1356 * "strdisplaywidth()" function
1357 */
1358 void
1359f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1360{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001361 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001362 int col = 0;
1363
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001364 rettv->vval.v_number = -1;
1365
1366 if (in_vim9script()
1367 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001368 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001369 return;
1370
1371 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001372 if (argvars[1].v_type != VAR_UNKNOWN)
1373 col = (int)tv_get_number(&argvars[1]);
1374
1375 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1376}
1377
1378/*
1379 * "strwidth()" function
1380 */
1381 void
1382f_strwidth(typval_T *argvars, typval_T *rettv)
1383{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001384 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001385
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001386 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1387 return;
1388
1389 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001390 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1391}
1392
1393/*
1394 * "strcharpart()" function
1395 */
1396 void
1397f_strcharpart(typval_T *argvars, typval_T *rettv)
1398{
1399 char_u *p;
1400 int nchar;
1401 int nbyte = 0;
1402 int charlen;
1403 int skipcc = FALSE;
1404 int len = 0;
1405 int slen;
1406 int error = FALSE;
1407
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001408 if (in_vim9script()
1409 && (check_for_string_arg(argvars, 0) == FAIL
1410 || check_for_number_arg(argvars, 1) == FAIL
1411 || check_for_opt_number_arg(argvars, 2) == FAIL
1412 || (argvars[2].v_type != VAR_UNKNOWN
1413 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1414 return;
1415
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001416 p = tv_get_string(&argvars[0]);
1417 slen = (int)STRLEN(p);
1418
1419 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1420 if (!error)
1421 {
1422 if (argvars[2].v_type != VAR_UNKNOWN
1423 && argvars[3].v_type != VAR_UNKNOWN)
1424 {
1425 skipcc = tv_get_bool(&argvars[3]);
1426 if (skipcc < 0 || skipcc > 1)
1427 {
1428 semsg(_(e_using_number_as_bool_nr), skipcc);
1429 return;
1430 }
1431 }
1432
1433 if (nchar > 0)
1434 while (nchar > 0 && nbyte < slen)
1435 {
1436 if (skipcc)
1437 nbyte += mb_ptr2len(p + nbyte);
1438 else
1439 nbyte += MB_CPTR2LEN(p + nbyte);
1440 --nchar;
1441 }
1442 else
1443 nbyte = nchar;
1444 if (argvars[2].v_type != VAR_UNKNOWN)
1445 {
1446 charlen = (int)tv_get_number(&argvars[2]);
1447 while (charlen > 0 && nbyte + len < slen)
1448 {
1449 int off = nbyte + len;
1450
1451 if (off < 0)
1452 len += 1;
1453 else
1454 {
1455 if (skipcc)
1456 len += mb_ptr2len(p + off);
1457 else
1458 len += MB_CPTR2LEN(p + off);
1459 }
1460 --charlen;
1461 }
1462 }
1463 else
1464 len = slen - nbyte; // default: all bytes that are available.
1465 }
1466
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001467 // Only return the overlap between the specified part and the actual
1468 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001469 if (nbyte < 0)
1470 {
1471 len += nbyte;
1472 nbyte = 0;
1473 }
1474 else if (nbyte > slen)
1475 nbyte = slen;
1476 if (len < 0)
1477 len = 0;
1478 else if (nbyte + len > slen)
1479 len = slen - nbyte;
1480
1481 rettv->v_type = VAR_STRING;
1482 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1483}
1484
1485/*
1486 * "strpart()" function
1487 */
1488 void
1489f_strpart(typval_T *argvars, typval_T *rettv)
1490{
1491 char_u *p;
1492 int n;
1493 int len;
1494 int slen;
1495 int error = FALSE;
1496
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001497 if (in_vim9script()
1498 && (check_for_string_arg(argvars, 0) == FAIL
1499 || check_for_number_arg(argvars, 1) == FAIL
1500 || check_for_opt_number_arg(argvars, 2) == FAIL
1501 || (argvars[2].v_type != VAR_UNKNOWN
1502 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1503 return;
1504
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001505 p = tv_get_string(&argvars[0]);
1506 slen = (int)STRLEN(p);
1507
1508 n = (int)tv_get_number_chk(&argvars[1], &error);
1509 if (error)
1510 len = 0;
1511 else if (argvars[2].v_type != VAR_UNKNOWN)
1512 len = (int)tv_get_number(&argvars[2]);
1513 else
1514 len = slen - n; // default len: all bytes that are available.
1515
1516 // Only return the overlap between the specified part and the actual
1517 // string.
1518 if (n < 0)
1519 {
1520 len += n;
1521 n = 0;
1522 }
1523 else if (n > slen)
1524 n = slen;
1525 if (len < 0)
1526 len = 0;
1527 else if (n + len > slen)
1528 len = slen - n;
1529
1530 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1531 {
1532 int off;
1533
1534 // length in characters
1535 for (off = n; off < slen && len > 0; --len)
1536 off += mb_ptr2len(p + off);
1537 len = off - n;
1538 }
1539
1540 rettv->v_type = VAR_STRING;
1541 rettv->vval.v_string = vim_strnsave(p + n, len);
1542}
1543
1544/*
1545 * "strridx()" function
1546 */
1547 void
1548f_strridx(typval_T *argvars, typval_T *rettv)
1549{
1550 char_u buf[NUMBUFLEN];
1551 char_u *needle;
1552 char_u *haystack;
1553 char_u *rest;
1554 char_u *lastmatch = NULL;
1555 int haystack_len, end_idx;
1556
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001557 if (in_vim9script()
1558 && (check_for_string_arg(argvars, 0) == FAIL
1559 || check_for_string_arg(argvars, 1) == FAIL
1560 || check_for_opt_number_arg(argvars, 2) == FAIL))
1561 return;
1562
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001563 needle = tv_get_string_chk(&argvars[1]);
1564 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1565
1566 rettv->vval.v_number = -1;
1567 if (needle == NULL || haystack == NULL)
1568 return; // type error; errmsg already given
1569
1570 haystack_len = (int)STRLEN(haystack);
1571 if (argvars[2].v_type != VAR_UNKNOWN)
1572 {
1573 // Third argument: upper limit for index
1574 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1575 if (end_idx < 0)
1576 return; // can never find a match
1577 }
1578 else
1579 end_idx = haystack_len;
1580
1581 if (*needle == NUL)
1582 {
1583 // Empty string matches past the end.
1584 lastmatch = haystack + end_idx;
1585 }
1586 else
1587 {
1588 for (rest = haystack; *rest != '\0'; ++rest)
1589 {
1590 rest = (char_u *)strstr((char *)rest, (char *)needle);
1591 if (rest == NULL || rest > haystack + end_idx)
1592 break;
1593 lastmatch = rest;
1594 }
1595 }
1596
1597 if (lastmatch == NULL)
1598 rettv->vval.v_number = -1;
1599 else
1600 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1601}
1602
1603/*
1604 * "strtrans()" function
1605 */
1606 void
1607f_strtrans(typval_T *argvars, typval_T *rettv)
1608{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001609 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1610 return;
1611
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001612 rettv->v_type = VAR_STRING;
1613 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1614}
1615
1616/*
1617 * "tolower(string)" function
1618 */
1619 void
1620f_tolower(typval_T *argvars, typval_T *rettv)
1621{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001622 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1623 return;
1624
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001625 rettv->v_type = VAR_STRING;
1626 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1627}
1628
1629/*
1630 * "toupper(string)" function
1631 */
1632 void
1633f_toupper(typval_T *argvars, typval_T *rettv)
1634{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001635 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1636 return;
1637
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001638 rettv->v_type = VAR_STRING;
1639 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1640}
1641
1642/*
1643 * "tr(string, fromstr, tostr)" function
1644 */
1645 void
1646f_tr(typval_T *argvars, typval_T *rettv)
1647{
1648 char_u *in_str;
1649 char_u *fromstr;
1650 char_u *tostr;
1651 char_u *p;
1652 int inlen;
1653 int fromlen;
1654 int tolen;
1655 int idx;
1656 char_u *cpstr;
1657 int cplen;
1658 int first = TRUE;
1659 char_u buf[NUMBUFLEN];
1660 char_u buf2[NUMBUFLEN];
1661 garray_T ga;
1662
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001663 if (in_vim9script()
1664 && (check_for_string_arg(argvars, 0) == FAIL
1665 || check_for_string_arg(argvars, 1) == FAIL
1666 || check_for_string_arg(argvars, 2) == FAIL))
1667 return;
1668
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001669 in_str = tv_get_string(&argvars[0]);
1670 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1671 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1672
1673 // Default return value: empty string.
1674 rettv->v_type = VAR_STRING;
1675 rettv->vval.v_string = NULL;
1676 if (fromstr == NULL || tostr == NULL)
1677 return; // type error; errmsg already given
1678 ga_init2(&ga, (int)sizeof(char), 80);
1679
1680 if (!has_mbyte)
1681 // not multi-byte: fromstr and tostr must be the same length
1682 if (STRLEN(fromstr) != STRLEN(tostr))
1683 {
1684error:
1685 semsg(_(e_invarg2), fromstr);
1686 ga_clear(&ga);
1687 return;
1688 }
1689
1690 // fromstr and tostr have to contain the same number of chars
1691 while (*in_str != NUL)
1692 {
1693 if (has_mbyte)
1694 {
1695 inlen = (*mb_ptr2len)(in_str);
1696 cpstr = in_str;
1697 cplen = inlen;
1698 idx = 0;
1699 for (p = fromstr; *p != NUL; p += fromlen)
1700 {
1701 fromlen = (*mb_ptr2len)(p);
1702 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1703 {
1704 for (p = tostr; *p != NUL; p += tolen)
1705 {
1706 tolen = (*mb_ptr2len)(p);
1707 if (idx-- == 0)
1708 {
1709 cplen = tolen;
1710 cpstr = p;
1711 break;
1712 }
1713 }
1714 if (*p == NUL) // tostr is shorter than fromstr
1715 goto error;
1716 break;
1717 }
1718 ++idx;
1719 }
1720
1721 if (first && cpstr == in_str)
1722 {
1723 // Check that fromstr and tostr have the same number of
1724 // (multi-byte) characters. Done only once when a character
1725 // of in_str doesn't appear in fromstr.
1726 first = FALSE;
1727 for (p = tostr; *p != NUL; p += tolen)
1728 {
1729 tolen = (*mb_ptr2len)(p);
1730 --idx;
1731 }
1732 if (idx != 0)
1733 goto error;
1734 }
1735
1736 (void)ga_grow(&ga, cplen);
1737 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1738 ga.ga_len += cplen;
1739
1740 in_str += inlen;
1741 }
1742 else
1743 {
1744 // When not using multi-byte chars we can do it faster.
1745 p = vim_strchr(fromstr, *in_str);
1746 if (p != NULL)
1747 ga_append(&ga, tostr[p - fromstr]);
1748 else
1749 ga_append(&ga, *in_str);
1750 ++in_str;
1751 }
1752 }
1753
1754 // add a terminating NUL
1755 (void)ga_grow(&ga, 1);
1756 ga_append(&ga, NUL);
1757
1758 rettv->vval.v_string = ga.ga_data;
1759}
1760
1761/*
1762 * "trim({expr})" function
1763 */
1764 void
1765f_trim(typval_T *argvars, typval_T *rettv)
1766{
1767 char_u buf1[NUMBUFLEN];
1768 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001769 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001770 char_u *mask = NULL;
1771 char_u *tail;
1772 char_u *prev;
1773 char_u *p;
1774 int c1;
1775 int dir = 0;
1776
1777 rettv->v_type = VAR_STRING;
1778 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001779
1780 if (in_vim9script()
1781 && (check_for_string_arg(argvars, 0) == FAIL
1782 || check_for_opt_string_arg(argvars, 1) == FAIL
1783 || (argvars[1].v_type != VAR_UNKNOWN
1784 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1785 return;
1786
1787 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001788 if (head == NULL)
1789 return;
1790
1791 if (argvars[1].v_type != VAR_UNKNOWN && argvars[1].v_type != VAR_STRING)
1792 {
1793 semsg(_(e_invarg2), tv_get_string(&argvars[1]));
1794 return;
1795 }
1796
1797 if (argvars[1].v_type == VAR_STRING)
1798 {
1799 mask = tv_get_string_buf_chk(&argvars[1], buf2);
1800
1801 if (argvars[2].v_type != VAR_UNKNOWN)
1802 {
1803 int error = 0;
1804
1805 // leading or trailing characters to trim
1806 dir = (int)tv_get_number_chk(&argvars[2], &error);
1807 if (error)
1808 return;
1809 if (dir < 0 || dir > 2)
1810 {
1811 semsg(_(e_invarg2), tv_get_string(&argvars[2]));
1812 return;
1813 }
1814 }
1815 }
1816
1817 if (dir == 0 || dir == 1)
1818 {
1819 // Trim leading characters
1820 while (*head != NUL)
1821 {
1822 c1 = PTR2CHAR(head);
1823 if (mask == NULL)
1824 {
1825 if (c1 > ' ' && c1 != 0xa0)
1826 break;
1827 }
1828 else
1829 {
1830 for (p = mask; *p != NUL; MB_PTR_ADV(p))
1831 if (c1 == PTR2CHAR(p))
1832 break;
1833 if (*p == NUL)
1834 break;
1835 }
1836 MB_PTR_ADV(head);
1837 }
1838 }
1839
1840 tail = head + STRLEN(head);
1841 if (dir == 0 || dir == 2)
1842 {
1843 // Trim trailing characters
1844 for (; tail > head; tail = prev)
1845 {
1846 prev = tail;
1847 MB_PTR_BACK(head, prev);
1848 c1 = PTR2CHAR(prev);
1849 if (mask == NULL)
1850 {
1851 if (c1 > ' ' && c1 != 0xa0)
1852 break;
1853 }
1854 else
1855 {
1856 for (p = mask; *p != NUL; MB_PTR_ADV(p))
1857 if (c1 == PTR2CHAR(p))
1858 break;
1859 if (*p == NUL)
1860 break;
1861 }
1862 }
1863 }
1864 rettv->vval.v_string = vim_strnsave(head, tail - head);
1865}
1866
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001867static char *e_printf = N_("E766: Insufficient arguments for printf()");
1868
1869/*
1870 * Get number argument from "idxp" entry in "tvs". First entry is 1.
1871 */
1872 static varnumber_T
1873tv_nr(typval_T *tvs, int *idxp)
1874{
1875 int idx = *idxp - 1;
1876 varnumber_T n = 0;
1877 int err = FALSE;
1878
1879 if (tvs[idx].v_type == VAR_UNKNOWN)
1880 emsg(_(e_printf));
1881 else
1882 {
1883 ++*idxp;
1884 n = tv_get_number_chk(&tvs[idx], &err);
1885 if (err)
1886 n = 0;
1887 }
1888 return n;
1889}
1890
1891/*
1892 * Get string argument from "idxp" entry in "tvs". First entry is 1.
1893 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
1894 * are not converted to a string.
1895 * If "tofree" is not NULL echo_string() is used. All types are converted to
1896 * a string with the same format as ":echo". The caller must free "*tofree".
1897 * Returns NULL for an error.
1898 */
1899 static char *
1900tv_str(typval_T *tvs, int *idxp, char_u **tofree)
1901{
1902 int idx = *idxp - 1;
1903 char *s = NULL;
1904 static char_u numbuf[NUMBUFLEN];
1905
1906 if (tvs[idx].v_type == VAR_UNKNOWN)
1907 emsg(_(e_printf));
1908 else
1909 {
1910 ++*idxp;
1911 if (tofree != NULL)
1912 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
1913 else
1914 s = (char *)tv_get_string_chk(&tvs[idx]);
1915 }
1916 return s;
1917}
1918
1919# ifdef FEAT_FLOAT
1920/*
1921 * Get float argument from "idxp" entry in "tvs". First entry is 1.
1922 */
1923 static double
1924tv_float(typval_T *tvs, int *idxp)
1925{
1926 int idx = *idxp - 1;
1927 double f = 0;
1928
1929 if (tvs[idx].v_type == VAR_UNKNOWN)
1930 emsg(_(e_printf));
1931 else
1932 {
1933 ++*idxp;
1934 if (tvs[idx].v_type == VAR_FLOAT)
1935 f = tvs[idx].vval.v_float;
1936 else if (tvs[idx].v_type == VAR_NUMBER)
1937 f = (double)tvs[idx].vval.v_number;
1938 else
1939 emsg(_("E807: Expected Float argument for printf()"));
1940 }
1941 return f;
1942}
1943# endif
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001944
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001945#endif
1946
1947#ifdef FEAT_FLOAT
1948/*
1949 * Return the representation of infinity for printf() function:
1950 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
1951 */
1952 static const char *
1953infinity_str(int positive,
1954 char fmt_spec,
1955 int force_sign,
1956 int space_for_positive)
1957{
1958 static const char *table[] =
1959 {
1960 "-inf", "inf", "+inf", " inf",
1961 "-INF", "INF", "+INF", " INF"
1962 };
1963 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
1964
1965 if (ASCII_ISUPPER(fmt_spec))
1966 idx += 4;
1967 return table[idx];
1968}
1969#endif
1970
1971/*
1972 * This code was included to provide a portable vsnprintf() and snprintf().
1973 * Some systems may provide their own, but we always use this one for
1974 * consistency.
1975 *
1976 * This code is based on snprintf.c - a portable implementation of snprintf
1977 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
1978 * Included with permission. It was heavily modified to fit in Vim.
1979 * The original code, including useful comments, can be found here:
1980 * http://www.ijs.si/software/snprintf/
1981 *
1982 * This snprintf() only supports the following conversion specifiers:
1983 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
1984 * with flags: '-', '+', ' ', '0' and '#'.
1985 * An asterisk is supported for field width as well as precision.
1986 *
1987 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
1988 *
1989 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
1990 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
1991 *
1992 * The locale is not used, the string is used as a byte string. This is only
1993 * relevant for double-byte encodings where the second byte may be '%'.
1994 *
1995 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
1996 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
1997 *
1998 * The return value is the number of characters which would be generated
1999 * for the given input, excluding the trailing NUL. If this value
2000 * is greater or equal to "str_m", not all characters from the result
2001 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
2002 * are discarded. If "str_m" is greater than zero it is guaranteed
2003 * the resulting string will be NUL-terminated.
2004 */
2005
2006/*
2007 * When va_list is not supported we only define vim_snprintf().
2008 *
2009 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2010 * "typval_T". When the latter is not used it must be NULL.
2011 */
2012
2013// When generating prototypes all of this is skipped, cproto doesn't
2014// understand this.
2015#ifndef PROTO
2016
2017// Like vim_vsnprintf() but append to the string.
2018 int
2019vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2020{
2021 va_list ap;
2022 int str_l;
2023 size_t len = STRLEN(str);
2024 size_t space;
2025
2026 if (str_m <= len)
2027 space = 0;
2028 else
2029 space = str_m - len;
2030 va_start(ap, fmt);
2031 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2032 va_end(ap);
2033 return str_l;
2034}
2035
2036 int
2037vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2038{
2039 va_list ap;
2040 int str_l;
2041
2042 va_start(ap, fmt);
2043 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2044 va_end(ap);
2045 return str_l;
2046}
2047
2048 int
2049vim_vsnprintf(
2050 char *str,
2051 size_t str_m,
2052 const char *fmt,
2053 va_list ap)
2054{
2055 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2056}
2057
2058 int
2059vim_vsnprintf_typval(
2060 char *str,
2061 size_t str_m,
2062 const char *fmt,
2063 va_list ap,
2064 typval_T *tvs)
2065{
2066 size_t str_l = 0;
2067 const char *p = fmt;
2068 int arg_idx = 1;
2069
2070 if (p == NULL)
2071 p = "";
2072 while (*p != NUL)
2073 {
2074 if (*p != '%')
2075 {
2076 char *q = strchr(p + 1, '%');
2077 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2078
2079 // Copy up to the next '%' or NUL without any changes.
2080 if (str_l < str_m)
2081 {
2082 size_t avail = str_m - str_l;
2083
2084 mch_memmove(str + str_l, p, n > avail ? avail : n);
2085 }
2086 p += n;
2087 str_l += n;
2088 }
2089 else
2090 {
2091 size_t min_field_width = 0, precision = 0;
2092 int zero_padding = 0, precision_specified = 0, justify_left = 0;
2093 int alternate_form = 0, force_sign = 0;
2094
2095 // If both the ' ' and '+' flags appear, the ' ' flag should be
2096 // ignored.
2097 int space_for_positive = 1;
2098
2099 // allowed values: \0, h, l, L
2100 char length_modifier = '\0';
2101
2102 // temporary buffer for simple numeric->string conversion
2103# if defined(FEAT_FLOAT)
2104# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
2105 // That sounds reasonable to use as the maximum
2106 // printable.
2107# else
2108# define TMP_LEN 66
2109# endif
2110 char tmp[TMP_LEN];
2111
2112 // string address in case of string argument
2113 const char *str_arg = NULL;
2114
2115 // natural field width of arg without padding and sign
2116 size_t str_arg_l;
2117
2118 // unsigned char argument value - only defined for c conversion.
2119 // N.B. standard explicitly states the char argument for the c
2120 // conversion is unsigned
2121 unsigned char uchar_arg;
2122
2123 // number of zeros to be inserted for numeric conversions as
2124 // required by the precision or minimal field width
2125 size_t number_of_zeros_to_pad = 0;
2126
2127 // index into tmp where zero padding is to be inserted
2128 size_t zero_padding_insertion_ind = 0;
2129
2130 // current conversion specifier character
2131 char fmt_spec = '\0';
2132
2133 // buffer for 's' and 'S' specs
2134 char_u *tofree = NULL;
2135
2136
2137 p++; // skip '%'
2138
2139 // parse flags
2140 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2141 || *p == '#' || *p == '\'')
2142 {
2143 switch (*p)
2144 {
2145 case '0': zero_padding = 1; break;
2146 case '-': justify_left = 1; break;
2147 case '+': force_sign = 1; space_for_positive = 0; break;
2148 case ' ': force_sign = 1;
2149 // If both the ' ' and '+' flags appear, the ' '
2150 // flag should be ignored
2151 break;
2152 case '#': alternate_form = 1; break;
2153 case '\'': break;
2154 }
2155 p++;
2156 }
2157 // If the '0' and '-' flags both appear, the '0' flag should be
2158 // ignored.
2159
2160 // parse field width
2161 if (*p == '*')
2162 {
2163 int j;
2164
2165 p++;
2166 j =
2167# if defined(FEAT_EVAL)
2168 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2169# endif
2170 va_arg(ap, int);
2171 if (j >= 0)
2172 min_field_width = j;
2173 else
2174 {
2175 min_field_width = -j;
2176 justify_left = 1;
2177 }
2178 }
2179 else if (VIM_ISDIGIT((int)(*p)))
2180 {
2181 // size_t could be wider than unsigned int; make sure we treat
2182 // argument like common implementations do
2183 unsigned int uj = *p++ - '0';
2184
2185 while (VIM_ISDIGIT((int)(*p)))
2186 uj = 10 * uj + (unsigned int)(*p++ - '0');
2187 min_field_width = uj;
2188 }
2189
2190 // parse precision
2191 if (*p == '.')
2192 {
2193 p++;
2194 precision_specified = 1;
2195 if (*p == '*')
2196 {
2197 int j;
2198
2199 j =
2200# if defined(FEAT_EVAL)
2201 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2202# endif
2203 va_arg(ap, int);
2204 p++;
2205 if (j >= 0)
2206 precision = j;
2207 else
2208 {
2209 precision_specified = 0;
2210 precision = 0;
2211 }
2212 }
2213 else if (VIM_ISDIGIT((int)(*p)))
2214 {
2215 // size_t could be wider than unsigned int; make sure we
2216 // treat argument like common implementations do
2217 unsigned int uj = *p++ - '0';
2218
2219 while (VIM_ISDIGIT((int)(*p)))
2220 uj = 10 * uj + (unsigned int)(*p++ - '0');
2221 precision = uj;
2222 }
2223 }
2224
2225 // parse 'h', 'l' and 'll' length modifiers
2226 if (*p == 'h' || *p == 'l')
2227 {
2228 length_modifier = *p;
2229 p++;
2230 if (length_modifier == 'l' && *p == 'l')
2231 {
2232 // double l = __int64 / varnumber_T
2233 length_modifier = 'L';
2234 p++;
2235 }
2236 }
2237 fmt_spec = *p;
2238
2239 // common synonyms:
2240 switch (fmt_spec)
2241 {
2242 case 'i': fmt_spec = 'd'; break;
2243 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2244 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2245 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2246 default: break;
2247 }
2248
2249# if defined(FEAT_EVAL)
2250 switch (fmt_spec)
2251 {
2252 case 'd': case 'u': case 'o': case 'x': case 'X':
2253 if (tvs != NULL && length_modifier == '\0')
2254 length_modifier = 'L';
2255 }
2256# endif
2257
2258 // get parameter value, do initial processing
2259 switch (fmt_spec)
2260 {
2261 // '%' and 'c' behave similar to 's' regarding flags and field
2262 // widths
2263 case '%':
2264 case 'c':
2265 case 's':
2266 case 'S':
2267 str_arg_l = 1;
2268 switch (fmt_spec)
2269 {
2270 case '%':
2271 str_arg = p;
2272 break;
2273
2274 case 'c':
2275 {
2276 int j;
2277
2278 j =
2279# if defined(FEAT_EVAL)
2280 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2281# endif
2282 va_arg(ap, int);
2283 // standard demands unsigned char
2284 uchar_arg = (unsigned char)j;
2285 str_arg = (char *)&uchar_arg;
2286 break;
2287 }
2288
2289 case 's':
2290 case 'S':
2291 str_arg =
2292# if defined(FEAT_EVAL)
2293 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
2294# endif
2295 va_arg(ap, char *);
2296 if (str_arg == NULL)
2297 {
2298 str_arg = "[NULL]";
2299 str_arg_l = 6;
2300 }
2301 // make sure not to address string beyond the specified
2302 // precision !!!
2303 else if (!precision_specified)
2304 str_arg_l = strlen(str_arg);
2305 // truncate string if necessary as requested by precision
2306 else if (precision == 0)
2307 str_arg_l = 0;
2308 else
2309 {
2310 // Don't put the #if inside memchr(), it can be a
2311 // macro.
2312 // memchr on HP does not like n > 2^31 !!!
2313 char *q = memchr(str_arg, '\0',
2314 precision <= (size_t)0x7fffffffL ? precision
2315 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00002316
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002317 str_arg_l = (q == NULL) ? precision
2318 : (size_t)(q - str_arg);
2319 }
2320 if (fmt_spec == 'S')
2321 {
presuku1f2453f2021-11-24 15:32:57 +00002322 char_u *p1;
2323 size_t i;
2324 int cell;
presukud85fccd2021-11-20 19:38:31 +00002325
presuku1f2453f2021-11-24 15:32:57 +00002326 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002327 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00002328 {
2329 cell = mb_ptr2cells(p1);
2330 if (precision_specified && i + cell > precision)
2331 break;
2332 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002333 }
presuku1f2453f2021-11-24 15:32:57 +00002334
2335 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00002336 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00002337 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002338 }
2339 break;
2340
2341 default:
2342 break;
2343 }
2344 break;
2345
2346 case 'd': case 'u':
2347 case 'b': case 'B':
2348 case 'o':
2349 case 'x': case 'X':
2350 case 'p':
2351 {
2352 // NOTE: the u, b, o, x, X and p conversion specifiers
2353 // imply the value is unsigned; d implies a signed
2354 // value
2355
2356 // 0 if numeric argument is zero (or if pointer is
2357 // NULL for 'p'), +1 if greater than zero (or nonzero
2358 // for unsigned arguments), -1 if negative (unsigned
2359 // argument is never negative)
2360 int arg_sign = 0;
2361
2362 // only set for length modifier h, or for no length
2363 // modifiers
2364 int int_arg = 0;
2365 unsigned int uint_arg = 0;
2366
2367 // only set for length modifier l
2368 long int long_arg = 0;
2369 unsigned long int ulong_arg = 0;
2370
2371 // only set for length modifier ll
2372 varnumber_T llong_arg = 0;
2373 uvarnumber_T ullong_arg = 0;
2374
2375 // only set for b conversion
2376 uvarnumber_T bin_arg = 0;
2377
2378 // pointer argument value -only defined for p
2379 // conversion
2380 void *ptr_arg = NULL;
2381
2382 if (fmt_spec == 'p')
2383 {
2384 length_modifier = '\0';
2385 ptr_arg =
2386# if defined(FEAT_EVAL)
2387 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
2388 NULL) :
2389# endif
2390 va_arg(ap, void *);
2391 if (ptr_arg != NULL)
2392 arg_sign = 1;
2393 }
2394 else if (fmt_spec == 'b' || fmt_spec == 'B')
2395 {
2396 bin_arg =
2397# if defined(FEAT_EVAL)
2398 tvs != NULL ?
2399 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
2400# endif
2401 va_arg(ap, uvarnumber_T);
2402 if (bin_arg != 0)
2403 arg_sign = 1;
2404 }
2405 else if (fmt_spec == 'd')
2406 {
2407 // signed
2408 switch (length_modifier)
2409 {
2410 case '\0':
2411 case 'h':
2412 // char and short arguments are passed as int.
2413 int_arg =
2414# if defined(FEAT_EVAL)
2415 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2416# endif
2417 va_arg(ap, int);
2418 if (int_arg > 0)
2419 arg_sign = 1;
2420 else if (int_arg < 0)
2421 arg_sign = -1;
2422 break;
2423 case 'l':
2424 long_arg =
2425# if defined(FEAT_EVAL)
2426 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2427# endif
2428 va_arg(ap, long int);
2429 if (long_arg > 0)
2430 arg_sign = 1;
2431 else if (long_arg < 0)
2432 arg_sign = -1;
2433 break;
2434 case 'L':
2435 llong_arg =
2436# if defined(FEAT_EVAL)
2437 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2438# endif
2439 va_arg(ap, varnumber_T);
2440 if (llong_arg > 0)
2441 arg_sign = 1;
2442 else if (llong_arg < 0)
2443 arg_sign = -1;
2444 break;
2445 }
2446 }
2447 else
2448 {
2449 // unsigned
2450 switch (length_modifier)
2451 {
2452 case '\0':
2453 case 'h':
2454 uint_arg =
2455# if defined(FEAT_EVAL)
2456 tvs != NULL ? (unsigned)
2457 tv_nr(tvs, &arg_idx) :
2458# endif
2459 va_arg(ap, unsigned int);
2460 if (uint_arg != 0)
2461 arg_sign = 1;
2462 break;
2463 case 'l':
2464 ulong_arg =
2465# if defined(FEAT_EVAL)
2466 tvs != NULL ? (unsigned long)
2467 tv_nr(tvs, &arg_idx) :
2468# endif
2469 va_arg(ap, unsigned long int);
2470 if (ulong_arg != 0)
2471 arg_sign = 1;
2472 break;
2473 case 'L':
2474 ullong_arg =
2475# if defined(FEAT_EVAL)
2476 tvs != NULL ? (uvarnumber_T)
2477 tv_nr(tvs, &arg_idx) :
2478# endif
2479 va_arg(ap, uvarnumber_T);
2480 if (ullong_arg != 0)
2481 arg_sign = 1;
2482 break;
2483 }
2484 }
2485
2486 str_arg = tmp;
2487 str_arg_l = 0;
2488
2489 // NOTE:
2490 // For d, i, u, o, x, and X conversions, if precision is
2491 // specified, the '0' flag should be ignored. This is so
2492 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
2493 // FreeBSD, NetBSD; but not with Perl.
2494 if (precision_specified)
2495 zero_padding = 0;
2496 if (fmt_spec == 'd')
2497 {
2498 if (force_sign && arg_sign >= 0)
2499 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
2500 // leave negative numbers for sprintf to handle, to
2501 // avoid handling tricky cases like (short int)-32768
2502 }
2503 else if (alternate_form)
2504 {
2505 if (arg_sign != 0
2506 && (fmt_spec == 'b' || fmt_spec == 'B'
2507 || fmt_spec == 'x' || fmt_spec == 'X') )
2508 {
2509 tmp[str_arg_l++] = '0';
2510 tmp[str_arg_l++] = fmt_spec;
2511 }
2512 // alternate form should have no effect for p
2513 // conversion, but ...
2514 }
2515
2516 zero_padding_insertion_ind = str_arg_l;
2517 if (!precision_specified)
2518 precision = 1; // default precision is 1
2519 if (precision == 0 && arg_sign == 0)
2520 {
2521 // When zero value is formatted with an explicit
2522 // precision 0, the resulting formatted string is
2523 // empty (d, i, u, b, B, o, x, X, p).
2524 }
2525 else
2526 {
2527 char f[6];
2528 int f_l = 0;
2529
2530 // construct a simple format string for sprintf
2531 f[f_l++] = '%';
2532 if (!length_modifier)
2533 ;
2534 else if (length_modifier == 'L')
2535 {
2536# ifdef MSWIN
2537 f[f_l++] = 'I';
2538 f[f_l++] = '6';
2539 f[f_l++] = '4';
2540# else
2541 f[f_l++] = 'l';
2542 f[f_l++] = 'l';
2543# endif
2544 }
2545 else
2546 f[f_l++] = length_modifier;
2547 f[f_l++] = fmt_spec;
2548 f[f_l++] = '\0';
2549
2550 if (fmt_spec == 'p')
2551 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
2552 else if (fmt_spec == 'b' || fmt_spec == 'B')
2553 {
2554 char b[8 * sizeof(uvarnumber_T)];
2555 size_t b_l = 0;
2556 uvarnumber_T bn = bin_arg;
2557
2558 do
2559 {
2560 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
2561 bn >>= 1;
2562 }
2563 while (bn != 0);
2564
2565 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
2566 str_arg_l += b_l;
2567 }
2568 else if (fmt_spec == 'd')
2569 {
2570 // signed
2571 switch (length_modifier)
2572 {
2573 case '\0': str_arg_l += sprintf(
2574 tmp + str_arg_l, f,
2575 int_arg);
2576 break;
2577 case 'h': str_arg_l += sprintf(
2578 tmp + str_arg_l, f,
2579 (short)int_arg);
2580 break;
2581 case 'l': str_arg_l += sprintf(
2582 tmp + str_arg_l, f, long_arg);
2583 break;
2584 case 'L': str_arg_l += sprintf(
2585 tmp + str_arg_l, f, llong_arg);
2586 break;
2587 }
2588 }
2589 else
2590 {
2591 // unsigned
2592 switch (length_modifier)
2593 {
2594 case '\0': str_arg_l += sprintf(
2595 tmp + str_arg_l, f,
2596 uint_arg);
2597 break;
2598 case 'h': str_arg_l += sprintf(
2599 tmp + str_arg_l, f,
2600 (unsigned short)uint_arg);
2601 break;
2602 case 'l': str_arg_l += sprintf(
2603 tmp + str_arg_l, f, ulong_arg);
2604 break;
2605 case 'L': str_arg_l += sprintf(
2606 tmp + str_arg_l, f, ullong_arg);
2607 break;
2608 }
2609 }
2610
2611 // include the optional minus sign and possible
2612 // "0x" in the region before the zero padding
2613 // insertion point
2614 if (zero_padding_insertion_ind < str_arg_l
2615 && tmp[zero_padding_insertion_ind] == '-')
2616 zero_padding_insertion_ind++;
2617 if (zero_padding_insertion_ind + 1 < str_arg_l
2618 && tmp[zero_padding_insertion_ind] == '0'
2619 && (tmp[zero_padding_insertion_ind + 1] == 'x'
2620 || tmp[zero_padding_insertion_ind + 1] == 'X'))
2621 zero_padding_insertion_ind += 2;
2622 }
2623
2624 {
2625 size_t num_of_digits = str_arg_l
2626 - zero_padding_insertion_ind;
2627
2628 if (alternate_form && fmt_spec == 'o'
2629 // unless zero is already the first
2630 // character
2631 && !(zero_padding_insertion_ind < str_arg_l
2632 && tmp[zero_padding_insertion_ind] == '0'))
2633 {
2634 // assure leading zero for alternate-form
2635 // octal numbers
2636 if (!precision_specified
2637 || precision < num_of_digits + 1)
2638 {
2639 // precision is increased to force the
2640 // first character to be zero, except if a
2641 // zero value is formatted with an
2642 // explicit precision of zero
2643 precision = num_of_digits + 1;
2644 }
2645 }
2646 // zero padding to specified precision?
2647 if (num_of_digits < precision)
2648 number_of_zeros_to_pad = precision - num_of_digits;
2649 }
2650 // zero padding to specified minimal field width?
2651 if (!justify_left && zero_padding)
2652 {
2653 int n = (int)(min_field_width - (str_arg_l
2654 + number_of_zeros_to_pad));
2655 if (n > 0)
2656 number_of_zeros_to_pad += n;
2657 }
2658 break;
2659 }
2660
2661# ifdef FEAT_FLOAT
2662 case 'f':
2663 case 'F':
2664 case 'e':
2665 case 'E':
2666 case 'g':
2667 case 'G':
2668 {
2669 // Floating point.
2670 double f;
2671 double abs_f;
2672 char format[40];
2673 int l;
2674 int remove_trailing_zeroes = FALSE;
2675
2676 f =
2677# if defined(FEAT_EVAL)
2678 tvs != NULL ? tv_float(tvs, &arg_idx) :
2679# endif
2680 va_arg(ap, double);
2681 abs_f = f < 0 ? -f : f;
2682
2683 if (fmt_spec == 'g' || fmt_spec == 'G')
2684 {
2685 // Would be nice to use %g directly, but it prints
2686 // "1.0" as "1", we don't want that.
2687 if ((abs_f >= 0.001 && abs_f < 10000000.0)
2688 || abs_f == 0.0)
2689 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
2690 else
2691 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
2692 remove_trailing_zeroes = TRUE;
2693 }
2694
2695 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
2696# ifdef VAX
2697 abs_f > 1.0e38
2698# else
2699 abs_f > 1.0e307
2700# endif
2701 )
2702 {
2703 // Avoid a buffer overflow
2704 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2705 force_sign, space_for_positive));
2706 str_arg_l = STRLEN(tmp);
2707 zero_padding = 0;
2708 }
2709 else
2710 {
2711 if (isnan(f))
2712 {
2713 // Not a number: nan or NAN
2714 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
2715 : "nan");
2716 str_arg_l = 3;
2717 zero_padding = 0;
2718 }
2719 else if (isinf(f))
2720 {
2721 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2722 force_sign, space_for_positive));
2723 str_arg_l = STRLEN(tmp);
2724 zero_padding = 0;
2725 }
2726 else
2727 {
2728 // Regular float number
2729 format[0] = '%';
2730 l = 1;
2731 if (force_sign)
2732 format[l++] = space_for_positive ? ' ' : '+';
2733 if (precision_specified)
2734 {
2735 size_t max_prec = TMP_LEN - 10;
2736
2737 // Make sure we don't get more digits than we
2738 // have room for.
2739 if ((fmt_spec == 'f' || fmt_spec == 'F')
2740 && abs_f > 1.0)
2741 max_prec -= (size_t)log10(abs_f);
2742 if (precision > max_prec)
2743 precision = max_prec;
2744 l += sprintf(format + l, ".%d", (int)precision);
2745 }
2746 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
2747 format[l + 1] = NUL;
2748
2749 str_arg_l = sprintf(tmp, format, f);
2750 }
2751
2752 if (remove_trailing_zeroes)
2753 {
2754 int i;
2755 char *tp;
2756
2757 // Using %g or %G: remove superfluous zeroes.
2758 if (fmt_spec == 'f' || fmt_spec == 'F')
2759 tp = tmp + str_arg_l - 1;
2760 else
2761 {
2762 tp = (char *)vim_strchr((char_u *)tmp,
2763 fmt_spec == 'e' ? 'e' : 'E');
2764 if (tp != NULL)
2765 {
2766 // Remove superfluous '+' and leading
2767 // zeroes from the exponent.
2768 if (tp[1] == '+')
2769 {
2770 // Change "1.0e+07" to "1.0e07"
2771 STRMOVE(tp + 1, tp + 2);
2772 --str_arg_l;
2773 }
2774 i = (tp[1] == '-') ? 2 : 1;
2775 while (tp[i] == '0')
2776 {
2777 // Change "1.0e07" to "1.0e7"
2778 STRMOVE(tp + i, tp + i + 1);
2779 --str_arg_l;
2780 }
2781 --tp;
2782 }
2783 }
2784
2785 if (tp != NULL && !precision_specified)
2786 // Remove trailing zeroes, but keep the one
2787 // just after a dot.
2788 while (tp > tmp + 2 && *tp == '0'
2789 && tp[-1] != '.')
2790 {
2791 STRMOVE(tp, tp + 1);
2792 --tp;
2793 --str_arg_l;
2794 }
2795 }
2796 else
2797 {
2798 char *tp;
2799
2800 // Be consistent: some printf("%e") use 1.0e+12
2801 // and some 1.0e+012. Remove one zero in the last
2802 // case.
2803 tp = (char *)vim_strchr((char_u *)tmp,
2804 fmt_spec == 'e' ? 'e' : 'E');
2805 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
2806 && tp[2] == '0'
2807 && vim_isdigit(tp[3])
2808 && vim_isdigit(tp[4]))
2809 {
2810 STRMOVE(tp + 2, tp + 3);
2811 --str_arg_l;
2812 }
2813 }
2814 }
2815 if (zero_padding && min_field_width > str_arg_l
2816 && (tmp[0] == '-' || force_sign))
2817 {
2818 // padding 0's should be inserted after the sign
2819 number_of_zeros_to_pad = min_field_width - str_arg_l;
2820 zero_padding_insertion_ind = 1;
2821 }
2822 str_arg = tmp;
2823 break;
2824 }
2825# endif
2826
2827 default:
2828 // unrecognized conversion specifier, keep format string
2829 // as-is
2830 zero_padding = 0; // turn zero padding off for non-numeric
2831 // conversion
2832 justify_left = 1;
2833 min_field_width = 0; // reset flags
2834
2835 // discard the unrecognized conversion, just keep *
2836 // the unrecognized conversion character
2837 str_arg = p;
2838 str_arg_l = 0;
2839 if (*p != NUL)
2840 str_arg_l++; // include invalid conversion specifier
2841 // unchanged if not at end-of-string
2842 break;
2843 }
2844
2845 if (*p != NUL)
2846 p++; // step over the just processed conversion specifier
2847
2848 // insert padding to the left as requested by min_field_width;
2849 // this does not include the zero padding in case of numerical
2850 // conversions
2851 if (!justify_left)
2852 {
2853 // left padding with blank or zero
2854 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
2855
2856 if (pn > 0)
2857 {
2858 if (str_l < str_m)
2859 {
2860 size_t avail = str_m - str_l;
2861
2862 vim_memset(str + str_l, zero_padding ? '0' : ' ',
2863 (size_t)pn > avail ? avail
2864 : (size_t)pn);
2865 }
2866 str_l += pn;
2867 }
2868 }
2869
2870 // zero padding as requested by the precision or by the minimal
2871 // field width for numeric conversions required?
2872 if (number_of_zeros_to_pad == 0)
2873 {
2874 // will not copy first part of numeric right now, *
2875 // force it to be copied later in its entirety
2876 zero_padding_insertion_ind = 0;
2877 }
2878 else
2879 {
2880 // insert first part of numerics (sign or '0x') before zero
2881 // padding
2882 int zn = (int)zero_padding_insertion_ind;
2883
2884 if (zn > 0)
2885 {
2886 if (str_l < str_m)
2887 {
2888 size_t avail = str_m - str_l;
2889
2890 mch_memmove(str + str_l, str_arg,
2891 (size_t)zn > avail ? avail
2892 : (size_t)zn);
2893 }
2894 str_l += zn;
2895 }
2896
2897 // insert zero padding as requested by the precision or min
2898 // field width
2899 zn = (int)number_of_zeros_to_pad;
2900 if (zn > 0)
2901 {
2902 if (str_l < str_m)
2903 {
2904 size_t avail = str_m - str_l;
2905
2906 vim_memset(str + str_l, '0',
2907 (size_t)zn > avail ? avail
2908 : (size_t)zn);
2909 }
2910 str_l += zn;
2911 }
2912 }
2913
2914 // insert formatted string
2915 // (or as-is conversion specifier for unknown conversions)
2916 {
2917 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
2918
2919 if (sn > 0)
2920 {
2921 if (str_l < str_m)
2922 {
2923 size_t avail = str_m - str_l;
2924
2925 mch_memmove(str + str_l,
2926 str_arg + zero_padding_insertion_ind,
2927 (size_t)sn > avail ? avail : (size_t)sn);
2928 }
2929 str_l += sn;
2930 }
2931 }
2932
2933 // insert right padding
2934 if (justify_left)
2935 {
2936 // right blank padding to the field width
2937 int pn = (int)(min_field_width
2938 - (str_arg_l + number_of_zeros_to_pad));
2939
2940 if (pn > 0)
2941 {
2942 if (str_l < str_m)
2943 {
2944 size_t avail = str_m - str_l;
2945
2946 vim_memset(str + str_l, ' ',
2947 (size_t)pn > avail ? avail
2948 : (size_t)pn);
2949 }
2950 str_l += pn;
2951 }
2952 }
2953 vim_free(tofree);
2954 }
2955 }
2956
2957 if (str_m > 0)
2958 {
2959 // make sure the string is nul-terminated even at the expense of
2960 // overwriting the last character (shouldn't happen, but just in case)
2961 //
2962 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
2963 }
2964
2965 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
2966 emsg(_("E767: Too many arguments to printf()"));
2967
2968 // Return the number of characters formatted (excluding trailing nul
2969 // character), that is, the number of characters that would have been
2970 // written to the buffer if it were large enough.
2971 return (int)str_l;
2972}
2973
2974#endif // PROTO