blob: 0313e7480eaf3d4e07111514041c0895bc0bc0d5 [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
Dominique Pelleaf4a61a2021-12-27 17:21:41 +0000174 // PowerShell uses its own version for quoting single quotes
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200175 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)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200345 *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200346 }
347}
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
528#if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
529/*
530 * Compare two strings, ignoring case, using current locale.
531 * Doesn't work for multi-byte characters.
532 * return 0 for match, < 0 for smaller, > 0 for bigger
533 */
534 int
535vim_stricmp(char *s1, char *s2)
536{
537 int i;
538
539 for (;;)
540 {
541 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
542 if (i != 0)
543 return i; // this character different
544 if (*s1 == NUL)
545 break; // strings match until NUL
546 ++s1;
547 ++s2;
548 }
549 return 0; // strings match
550}
551#endif
552
553#if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
554/*
555 * Compare two strings, for length "len", ignoring case, using current locale.
556 * Doesn't work for multi-byte characters.
557 * return 0 for match, < 0 for smaller, > 0 for bigger
558 */
559 int
560vim_strnicmp(char *s1, char *s2, size_t len)
561{
562 int i;
563
564 while (len > 0)
565 {
566 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
567 if (i != 0)
568 return i; // this character different
569 if (*s1 == NUL)
570 break; // strings match until NUL
571 ++s1;
572 ++s2;
573 --len;
574 }
575 return 0; // strings match
576}
577#endif
578
579/*
580 * Search for first occurrence of "c" in "string".
581 * Version of strchr() that handles unsigned char strings with characters from
582 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
583 * end of the string.
584 */
585 char_u *
586vim_strchr(char_u *string, int c)
587{
588 char_u *p;
589 int b;
590
591 p = string;
592 if (enc_utf8 && c >= 0x80)
593 {
594 while (*p != NUL)
595 {
596 int l = utfc_ptr2len(p);
597
598 // Avoid matching an illegal byte here.
599 if (utf_ptr2char(p) == c && l > 1)
600 return p;
601 p += l;
602 }
603 return NULL;
604 }
605 if (enc_dbcs != 0 && c > 255)
606 {
607 int n2 = c & 0xff;
608
609 c = ((unsigned)c >> 8) & 0xff;
610 while ((b = *p) != NUL)
611 {
612 if (b == c && p[1] == n2)
613 return p;
614 p += (*mb_ptr2len)(p);
615 }
616 return NULL;
617 }
618 if (has_mbyte)
619 {
620 while ((b = *p) != NUL)
621 {
622 if (b == c)
623 return p;
624 p += (*mb_ptr2len)(p);
625 }
626 return NULL;
627 }
628 while ((b = *p) != NUL)
629 {
630 if (b == c)
631 return p;
632 ++p;
633 }
634 return NULL;
635}
636
637/*
638 * Version of strchr() that only works for bytes and handles unsigned char
639 * strings with characters above 128 correctly. It also doesn't return a
640 * pointer to the NUL at the end of the string.
641 */
642 char_u *
643vim_strbyte(char_u *string, int c)
644{
645 char_u *p = string;
646
647 while (*p != NUL)
648 {
649 if (*p == c)
650 return p;
651 ++p;
652 }
653 return NULL;
654}
655
656/*
657 * Search for last occurrence of "c" in "string".
658 * Version of strrchr() that handles unsigned char strings with characters from
659 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
660 * end of the string.
661 * Return NULL if not found.
662 * Does not handle multi-byte char for "c"!
663 */
664 char_u *
665vim_strrchr(char_u *string, int c)
666{
667 char_u *retval = NULL;
668 char_u *p = string;
669
670 while (*p)
671 {
672 if (*p == c)
673 retval = p;
674 MB_PTR_ADV(p);
675 }
676 return retval;
677}
678
679/*
680 * Vim's version of strpbrk(), in case it's missing.
681 * Don't generate a prototype for this, causes problems when it's not used.
682 */
683#ifndef PROTO
684# ifndef HAVE_STRPBRK
685# ifdef vim_strpbrk
686# undef vim_strpbrk
687# endif
688 char_u *
689vim_strpbrk(char_u *s, char_u *charset)
690{
691 while (*s)
692 {
693 if (vim_strchr(charset, *s) != NULL)
694 return s;
695 MB_PTR_ADV(s);
696 }
697 return NULL;
698}
699# endif
700#endif
701
702/*
703 * Sort an array of strings.
704 */
705static int sort_compare(const void *s1, const void *s2);
706
707 static int
708sort_compare(const void *s1, const void *s2)
709{
710 return STRCMP(*(char **)s1, *(char **)s2);
711}
712
713 void
714sort_strings(
715 char_u **files,
716 int count)
717{
718 qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
719}
720
721#if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
722/*
723 * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
724 * When "s" is NULL FALSE is returned.
725 */
726 int
727has_non_ascii(char_u *s)
728{
729 char_u *p;
730
731 if (s != NULL)
732 for (p = s; *p != NUL; ++p)
733 if (*p >= 128)
734 return TRUE;
735 return FALSE;
736}
737#endif
738
739/*
740 * Concatenate two strings and return the result in allocated memory.
741 * Returns NULL when out of memory.
742 */
743 char_u *
744concat_str(char_u *str1, char_u *str2)
745{
746 char_u *dest;
747 size_t l = str1 == NULL ? 0 : STRLEN(str1);
748
749 dest = alloc(l + (str2 == NULL ? 0 : STRLEN(str2)) + 1L);
750 if (dest != NULL)
751 {
752 if (str1 == NULL)
753 *dest = NUL;
754 else
755 STRCPY(dest, str1);
756 if (str2 != NULL)
757 STRCPY(dest + l, str2);
758 }
759 return dest;
760}
761
762#if defined(FEAT_EVAL) || defined(PROTO)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200763/*
764 * Return string "str" in ' quotes, doubling ' characters.
765 * If "str" is NULL an empty string is assumed.
766 * If "function" is TRUE make it function('string').
767 */
768 char_u *
769string_quote(char_u *str, int function)
770{
771 unsigned len;
772 char_u *p, *r, *s;
773
774 len = (function ? 13 : 3);
775 if (str != NULL)
776 {
777 len += (unsigned)STRLEN(str);
778 for (p = str; *p != NUL; MB_PTR_ADV(p))
779 if (*p == '\'')
780 ++len;
781 }
782 s = r = alloc(len);
783 if (r != NULL)
784 {
785 if (function)
786 {
787 STRCPY(r, "function('");
788 r += 10;
789 }
790 else
791 *r++ = '\'';
792 if (str != NULL)
793 for (p = str; *p != NUL; )
794 {
795 if (*p == '\'')
796 *r++ = '\'';
797 MB_COPY_CHAR(p, r);
798 }
799 *r++ = '\'';
800 if (function)
801 *r++ = ')';
802 *r++ = NUL;
803 }
804 return s;
805}
806
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000807/*
808 * Count the number of times "needle" occurs in string "haystack". Case is
809 * ignored if "ic" is TRUE.
810 */
811 long
812string_count(char_u *haystack, char_u *needle, int ic)
813{
814 long n = 0;
815 char_u *p = haystack;
816 char_u *next;
817
818 if (p == NULL || needle == NULL || *needle == NUL)
819 return 0;
820
821 if (ic)
822 {
823 size_t len = STRLEN(needle);
824
825 while (*p != NUL)
826 {
827 if (MB_STRNICMP(p, needle, len) == 0)
828 {
829 ++n;
830 p += len;
831 }
832 else
833 MB_PTR_ADV(p);
834 }
835 }
836 else
837 while ((next = (char_u *)strstr((char *)p, (char *)needle)) != NULL)
838 {
839 ++n;
840 p = next + STRLEN(needle);
841 }
842
843 return n;
844}
845
846/*
847 * Make a typval_T of the first character of "input" and store it in "output".
848 * Return OK or FAIL.
849 */
850 static int
851copy_first_char_to_tv(char_u *input, typval_T *output)
852{
853 char_u buf[MB_MAXBYTES + 1];
854 int len;
855
856 if (input == NULL || output == NULL)
857 return FAIL;
858
859 len = has_mbyte ? mb_ptr2len(input) : 1;
860 STRNCPY(buf, input, len);
861 buf[len] = NUL;
862 output->v_type = VAR_STRING;
863 output->vval.v_string = vim_strsave(buf);
864
865 return output->vval.v_string == NULL ? FAIL : OK;
866}
867
868/*
869 * Implementation of map() and filter() for a String. Apply "expr" to every
870 * character in string "str" and return the result in "rettv".
871 */
872 void
873string_filter_map(
874 char_u *str,
875 filtermap_T filtermap,
876 typval_T *expr,
877 typval_T *rettv)
878{
879 char_u *p;
880 typval_T tv;
881 garray_T ga;
882 int len = 0;
883 int idx = 0;
884 int rem;
885
886 rettv->v_type = VAR_STRING;
887 rettv->vval.v_string = NULL;
888
889 // set_vim_var_nr() doesn't set the type
890 set_vim_var_type(VV_KEY, VAR_NUMBER);
891
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000892 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000893 for (p = str; *p != NUL; p += len)
894 {
895 typval_T newtv;
896
897 if (copy_first_char_to_tv(p, &tv) == FAIL)
898 break;
899 len = (int)STRLEN(tv.vval.v_string);
900
Bram Moolenaardd7eff02022-05-06 11:02:05 +0100901 newtv.v_type = VAR_UNKNOWN;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000902 set_vim_var_nr(VV_KEY, idx);
903 if (filter_map_one(&tv, expr, filtermap, &newtv, &rem) == FAIL
904 || did_emsg)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000905 {
906 clear_tv(&newtv);
907 clear_tv(&tv);
908 break;
909 }
910 else if (filtermap != FILTERMAP_FILTER)
911 {
912 if (newtv.v_type != VAR_STRING)
913 {
914 clear_tv(&newtv);
915 clear_tv(&tv);
Bram Moolenaare70cec92022-01-01 14:25:55 +0000916 emsg(_(e_string_required));
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000917 break;
918 }
919 else
920 ga_concat(&ga, newtv.vval.v_string);
921 }
922 else if (!rem)
923 ga_concat(&ga, tv.vval.v_string);
924
925 clear_tv(&newtv);
926 clear_tv(&tv);
927
928 ++idx;
929 }
930 ga_append(&ga, NUL);
931 rettv->vval.v_string = ga.ga_data;
932}
933
934/*
935 * reduce() String argvars[0] using the function 'funcname' with arguments in
936 * 'funcexe' starting with the initial value argvars[2] and return the result
937 * in 'rettv'.
938 */
939 void
940string_reduce(
941 typval_T *argvars,
942 char_u *func_name,
943 funcexe_T *funcexe,
944 typval_T *rettv)
945{
946 char_u *p = tv_get_string(&argvars[0]);
947 int len;
948 typval_T argv[3];
949 int r;
950 int called_emsg_start = called_emsg;
951
952 if (argvars[2].v_type == VAR_UNKNOWN)
953 {
954 if (*p == NUL)
955 {
Bram Moolenaare70cec92022-01-01 14:25:55 +0000956 semsg(_(e_reduce_of_an_empty_str_with_no_initial_value), "String");
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000957 return;
958 }
959 if (copy_first_char_to_tv(p, rettv) == FAIL)
960 return;
961 p += STRLEN(rettv->vval.v_string);
962 }
963 else if (argvars[2].v_type != VAR_STRING)
964 {
965 semsg(_(e_string_expected_for_argument_nr), 3);
966 return;
967 }
968 else
969 copy_tv(&argvars[2], rettv);
970
971 for ( ; *p != NUL; p += len)
972 {
973 argv[0] = *rettv;
974 if (copy_first_char_to_tv(p, &argv[1]) == FAIL)
975 break;
976 len = (int)STRLEN(argv[1].vval.v_string);
977 r = call_func(func_name, -1, rettv, 2, argv, funcexe);
978 clear_tv(&argv[0]);
979 clear_tv(&argv[1]);
980 if (r == FAIL || called_emsg != called_emsg_start)
981 return;
982 }
983}
984
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200985 static void
986byteidx(typval_T *argvars, typval_T *rettv, int comp UNUSED)
987{
988 char_u *t;
989 char_u *str;
990 varnumber_T idx;
991
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +0200992 rettv->vval.v_number = -1;
993
994 if (in_vim9script()
995 && (check_for_string_arg(argvars, 0) == FAIL
996 || check_for_number_arg(argvars, 1) == FAIL))
997 return;
998
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200999 str = tv_get_string_chk(&argvars[0]);
1000 idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001001 if (str == NULL || idx < 0)
1002 return;
1003
1004 t = str;
1005 for ( ; idx > 0; idx--)
1006 {
1007 if (*t == NUL) // EOL reached
1008 return;
1009 if (enc_utf8 && comp)
1010 t += utf_ptr2len(t);
1011 else
1012 t += (*mb_ptr2len)(t);
1013 }
1014 rettv->vval.v_number = (varnumber_T)(t - str);
1015}
1016
1017/*
1018 * "byteidx()" function
1019 */
1020 void
1021f_byteidx(typval_T *argvars, typval_T *rettv)
1022{
1023 byteidx(argvars, rettv, FALSE);
1024}
1025
1026/*
1027 * "byteidxcomp()" function
1028 */
1029 void
1030f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1031{
1032 byteidx(argvars, rettv, TRUE);
1033}
1034
1035/*
1036 * "charidx()" function
1037 */
1038 void
1039f_charidx(typval_T *argvars, typval_T *rettv)
1040{
1041 char_u *str;
1042 varnumber_T idx;
1043 varnumber_T countcc = FALSE;
1044 char_u *p;
1045 int len;
1046 int (*ptr2len)(char_u *);
1047
1048 rettv->vval.v_number = -1;
1049
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001050 if (in_vim9script()
1051 && (check_for_string_arg(argvars, 0) == FAIL
1052 || check_for_number_arg(argvars, 1) == FAIL
1053 || check_for_opt_bool_arg(argvars, 2) == FAIL))
1054 return;
1055
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001056 if (argvars[0].v_type != VAR_STRING || argvars[1].v_type != VAR_NUMBER
1057 || (argvars[2].v_type != VAR_UNKNOWN
1058 && argvars[2].v_type != VAR_NUMBER
1059 && argvars[2].v_type != VAR_BOOL))
1060 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001061 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001062 return;
1063 }
1064
1065 str = tv_get_string_chk(&argvars[0]);
1066 idx = tv_get_number_chk(&argvars[1], NULL);
1067 if (str == NULL || idx < 0)
1068 return;
1069
1070 if (argvars[2].v_type != VAR_UNKNOWN)
1071 countcc = tv_get_bool(&argvars[2]);
1072 if (countcc < 0 || countcc > 1)
1073 {
1074 semsg(_(e_using_number_as_bool_nr), countcc);
1075 return;
1076 }
1077
1078 if (enc_utf8 && countcc)
1079 ptr2len = utf_ptr2len;
1080 else
1081 ptr2len = mb_ptr2len;
1082
1083 for (p = str, len = 0; p <= str + idx; len++)
1084 {
1085 if (*p == NUL)
1086 return;
1087 p += ptr2len(p);
1088 }
1089
1090 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1091}
1092
1093/*
1094 * "str2list()" function
1095 */
1096 void
1097f_str2list(typval_T *argvars, typval_T *rettv)
1098{
1099 char_u *p;
1100 int utf8 = FALSE;
1101
1102 if (rettv_list_alloc(rettv) == FAIL)
1103 return;
1104
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001105 if (in_vim9script()
1106 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001107 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001108 return;
1109
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001110 if (argvars[1].v_type != VAR_UNKNOWN)
1111 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1112
1113 p = tv_get_string(&argvars[0]);
1114
1115 if (has_mbyte || utf8)
1116 {
1117 int (*ptr2len)(char_u *);
1118 int (*ptr2char)(char_u *);
1119
1120 if (utf8 || enc_utf8)
1121 {
1122 ptr2len = utf_ptr2len;
1123 ptr2char = utf_ptr2char;
1124 }
1125 else
1126 {
1127 ptr2len = mb_ptr2len;
1128 ptr2char = mb_ptr2char;
1129 }
1130
1131 for ( ; *p != NUL; p += (*ptr2len)(p))
1132 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1133 }
1134 else
1135 for ( ; *p != NUL; ++p)
1136 list_append_number(rettv->vval.v_list, *p);
1137}
1138
1139/*
1140 * "str2nr()" function
1141 */
1142 void
1143f_str2nr(typval_T *argvars, typval_T *rettv)
1144{
1145 int base = 10;
1146 char_u *p;
1147 varnumber_T n;
1148 int what = 0;
1149 int isneg;
1150
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001151 if (in_vim9script()
1152 && (check_for_string_arg(argvars, 0) == FAIL
1153 || check_for_opt_number_arg(argvars, 1) == FAIL
1154 || (argvars[1].v_type != VAR_UNKNOWN
1155 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1156 return;
1157
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001158 if (argvars[1].v_type != VAR_UNKNOWN)
1159 {
1160 base = (int)tv_get_number(&argvars[1]);
1161 if (base != 2 && base != 8 && base != 10 && base != 16)
1162 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001163 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001164 return;
1165 }
1166 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1167 what |= STR2NR_QUOTE;
1168 }
1169
1170 p = skipwhite(tv_get_string_strict(&argvars[0]));
1171 isneg = (*p == '-');
1172 if (*p == '+' || *p == '-')
1173 p = skipwhite(p + 1);
1174 switch (base)
1175 {
1176 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1177 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1178 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1179 }
1180 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE);
1181 // Text after the number is silently ignored.
1182 if (isneg)
1183 rettv->vval.v_number = -n;
1184 else
1185 rettv->vval.v_number = n;
1186
1187}
1188
1189/*
1190 * "strgetchar()" function
1191 */
1192 void
1193f_strgetchar(typval_T *argvars, typval_T *rettv)
1194{
1195 char_u *str;
1196 int len;
1197 int error = FALSE;
1198 int charidx;
1199 int byteidx = 0;
1200
1201 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001202
1203 if (in_vim9script()
1204 && (check_for_string_arg(argvars, 0) == FAIL
1205 || check_for_number_arg(argvars, 1) == FAIL))
1206 return;
1207
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001208 str = tv_get_string_chk(&argvars[0]);
1209 if (str == NULL)
1210 return;
1211 len = (int)STRLEN(str);
1212 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1213 if (error)
1214 return;
1215
1216 while (charidx >= 0 && byteidx < len)
1217 {
1218 if (charidx == 0)
1219 {
1220 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1221 break;
1222 }
1223 --charidx;
1224 byteidx += MB_CPTR2LEN(str + byteidx);
1225 }
1226}
1227
1228/*
1229 * "stridx()" function
1230 */
1231 void
1232f_stridx(typval_T *argvars, typval_T *rettv)
1233{
1234 char_u buf[NUMBUFLEN];
1235 char_u *needle;
1236 char_u *haystack;
1237 char_u *save_haystack;
1238 char_u *pos;
1239 int start_idx;
1240
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001241 if (in_vim9script()
1242 && (check_for_string_arg(argvars, 0) == FAIL
1243 || check_for_string_arg(argvars, 1) == FAIL
1244 || check_for_opt_number_arg(argvars, 2) == FAIL))
1245 return;
1246
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001247 needle = tv_get_string_chk(&argvars[1]);
1248 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1249 rettv->vval.v_number = -1;
1250 if (needle == NULL || haystack == NULL)
1251 return; // type error; errmsg already given
1252
1253 if (argvars[2].v_type != VAR_UNKNOWN)
1254 {
1255 int error = FALSE;
1256
1257 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1258 if (error || start_idx >= (int)STRLEN(haystack))
1259 return;
1260 if (start_idx >= 0)
1261 haystack += start_idx;
1262 }
1263
1264 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1265 if (pos != NULL)
1266 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1267}
1268
1269/*
1270 * "string()" function
1271 */
1272 void
1273f_string(typval_T *argvars, typval_T *rettv)
1274{
1275 char_u *tofree;
1276 char_u numbuf[NUMBUFLEN];
1277
1278 rettv->v_type = VAR_STRING;
1279 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1280 get_copyID());
1281 // Make a copy if we have a value but it's not in allocated memory.
1282 if (rettv->vval.v_string != NULL && tofree == NULL)
1283 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1284}
1285
1286/*
1287 * "strlen()" function
1288 */
1289 void
1290f_strlen(typval_T *argvars, typval_T *rettv)
1291{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001292 if (in_vim9script()
1293 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1294 return;
1295
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001296 rettv->vval.v_number = (varnumber_T)(STRLEN(
1297 tv_get_string(&argvars[0])));
1298}
1299
1300 static void
1301strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1302{
1303 char_u *s = tv_get_string(&argvars[0]);
1304 varnumber_T len = 0;
1305 int (*func_mb_ptr2char_adv)(char_u **pp);
1306
1307 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1308 while (*s != NUL)
1309 {
1310 func_mb_ptr2char_adv(&s);
1311 ++len;
1312 }
1313 rettv->vval.v_number = len;
1314}
1315
1316/*
1317 * "strcharlen()" function
1318 */
1319 void
1320f_strcharlen(typval_T *argvars, typval_T *rettv)
1321{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001322 if (in_vim9script()
1323 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1324 return;
1325
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001326 strchar_common(argvars, rettv, TRUE);
1327}
1328
1329/*
1330 * "strchars()" function
1331 */
1332 void
1333f_strchars(typval_T *argvars, typval_T *rettv)
1334{
1335 varnumber_T skipcc = FALSE;
1336
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001337 if (in_vim9script()
1338 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001339 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001340 return;
1341
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001342 if (argvars[1].v_type != VAR_UNKNOWN)
1343 skipcc = tv_get_bool(&argvars[1]);
1344 if (skipcc < 0 || skipcc > 1)
1345 semsg(_(e_using_number_as_bool_nr), skipcc);
1346 else
1347 strchar_common(argvars, rettv, skipcc);
1348}
1349
1350/*
1351 * "strdisplaywidth()" function
1352 */
1353 void
1354f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1355{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001356 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001357 int col = 0;
1358
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001359 rettv->vval.v_number = -1;
1360
1361 if (in_vim9script()
1362 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001363 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001364 return;
1365
1366 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001367 if (argvars[1].v_type != VAR_UNKNOWN)
1368 col = (int)tv_get_number(&argvars[1]);
1369
1370 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1371}
1372
1373/*
1374 * "strwidth()" function
1375 */
1376 void
1377f_strwidth(typval_T *argvars, typval_T *rettv)
1378{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001379 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001380
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001381 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1382 return;
1383
1384 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001385 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1386}
1387
1388/*
1389 * "strcharpart()" function
1390 */
1391 void
1392f_strcharpart(typval_T *argvars, typval_T *rettv)
1393{
1394 char_u *p;
1395 int nchar;
1396 int nbyte = 0;
1397 int charlen;
1398 int skipcc = FALSE;
1399 int len = 0;
1400 int slen;
1401 int error = FALSE;
1402
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001403 if (in_vim9script()
1404 && (check_for_string_arg(argvars, 0) == FAIL
1405 || check_for_number_arg(argvars, 1) == FAIL
1406 || check_for_opt_number_arg(argvars, 2) == FAIL
1407 || (argvars[2].v_type != VAR_UNKNOWN
1408 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1409 return;
1410
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001411 p = tv_get_string(&argvars[0]);
1412 slen = (int)STRLEN(p);
1413
1414 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1415 if (!error)
1416 {
1417 if (argvars[2].v_type != VAR_UNKNOWN
1418 && argvars[3].v_type != VAR_UNKNOWN)
1419 {
1420 skipcc = tv_get_bool(&argvars[3]);
1421 if (skipcc < 0 || skipcc > 1)
1422 {
1423 semsg(_(e_using_number_as_bool_nr), skipcc);
1424 return;
1425 }
1426 }
1427
1428 if (nchar > 0)
1429 while (nchar > 0 && nbyte < slen)
1430 {
1431 if (skipcc)
1432 nbyte += mb_ptr2len(p + nbyte);
1433 else
1434 nbyte += MB_CPTR2LEN(p + nbyte);
1435 --nchar;
1436 }
1437 else
1438 nbyte = nchar;
1439 if (argvars[2].v_type != VAR_UNKNOWN)
1440 {
1441 charlen = (int)tv_get_number(&argvars[2]);
1442 while (charlen > 0 && nbyte + len < slen)
1443 {
1444 int off = nbyte + len;
1445
1446 if (off < 0)
1447 len += 1;
1448 else
1449 {
1450 if (skipcc)
1451 len += mb_ptr2len(p + off);
1452 else
1453 len += MB_CPTR2LEN(p + off);
1454 }
1455 --charlen;
1456 }
1457 }
1458 else
1459 len = slen - nbyte; // default: all bytes that are available.
1460 }
1461
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001462 // Only return the overlap between the specified part and the actual
1463 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001464 if (nbyte < 0)
1465 {
1466 len += nbyte;
1467 nbyte = 0;
1468 }
1469 else if (nbyte > slen)
1470 nbyte = slen;
1471 if (len < 0)
1472 len = 0;
1473 else if (nbyte + len > slen)
1474 len = slen - nbyte;
1475
1476 rettv->v_type = VAR_STRING;
1477 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1478}
1479
1480/*
1481 * "strpart()" function
1482 */
1483 void
1484f_strpart(typval_T *argvars, typval_T *rettv)
1485{
1486 char_u *p;
1487 int n;
1488 int len;
1489 int slen;
1490 int error = FALSE;
1491
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001492 if (in_vim9script()
1493 && (check_for_string_arg(argvars, 0) == FAIL
1494 || check_for_number_arg(argvars, 1) == FAIL
1495 || check_for_opt_number_arg(argvars, 2) == FAIL
1496 || (argvars[2].v_type != VAR_UNKNOWN
1497 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1498 return;
1499
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001500 p = tv_get_string(&argvars[0]);
1501 slen = (int)STRLEN(p);
1502
1503 n = (int)tv_get_number_chk(&argvars[1], &error);
1504 if (error)
1505 len = 0;
1506 else if (argvars[2].v_type != VAR_UNKNOWN)
1507 len = (int)tv_get_number(&argvars[2]);
1508 else
1509 len = slen - n; // default len: all bytes that are available.
1510
1511 // Only return the overlap between the specified part and the actual
1512 // string.
1513 if (n < 0)
1514 {
1515 len += n;
1516 n = 0;
1517 }
1518 else if (n > slen)
1519 n = slen;
1520 if (len < 0)
1521 len = 0;
1522 else if (n + len > slen)
1523 len = slen - n;
1524
1525 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1526 {
1527 int off;
1528
1529 // length in characters
1530 for (off = n; off < slen && len > 0; --len)
1531 off += mb_ptr2len(p + off);
1532 len = off - n;
1533 }
1534
1535 rettv->v_type = VAR_STRING;
1536 rettv->vval.v_string = vim_strnsave(p + n, len);
1537}
1538
1539/*
1540 * "strridx()" function
1541 */
1542 void
1543f_strridx(typval_T *argvars, typval_T *rettv)
1544{
1545 char_u buf[NUMBUFLEN];
1546 char_u *needle;
1547 char_u *haystack;
1548 char_u *rest;
1549 char_u *lastmatch = NULL;
1550 int haystack_len, end_idx;
1551
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001552 if (in_vim9script()
1553 && (check_for_string_arg(argvars, 0) == FAIL
1554 || check_for_string_arg(argvars, 1) == FAIL
1555 || check_for_opt_number_arg(argvars, 2) == FAIL))
1556 return;
1557
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001558 needle = tv_get_string_chk(&argvars[1]);
1559 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1560
1561 rettv->vval.v_number = -1;
1562 if (needle == NULL || haystack == NULL)
1563 return; // type error; errmsg already given
1564
1565 haystack_len = (int)STRLEN(haystack);
1566 if (argvars[2].v_type != VAR_UNKNOWN)
1567 {
1568 // Third argument: upper limit for index
1569 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1570 if (end_idx < 0)
1571 return; // can never find a match
1572 }
1573 else
1574 end_idx = haystack_len;
1575
1576 if (*needle == NUL)
1577 {
1578 // Empty string matches past the end.
1579 lastmatch = haystack + end_idx;
1580 }
1581 else
1582 {
1583 for (rest = haystack; *rest != '\0'; ++rest)
1584 {
1585 rest = (char_u *)strstr((char *)rest, (char *)needle);
1586 if (rest == NULL || rest > haystack + end_idx)
1587 break;
1588 lastmatch = rest;
1589 }
1590 }
1591
1592 if (lastmatch == NULL)
1593 rettv->vval.v_number = -1;
1594 else
1595 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1596}
1597
1598/*
1599 * "strtrans()" function
1600 */
1601 void
1602f_strtrans(typval_T *argvars, typval_T *rettv)
1603{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001604 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1605 return;
1606
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001607 rettv->v_type = VAR_STRING;
1608 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1609}
1610
1611/*
1612 * "tolower(string)" function
1613 */
1614 void
1615f_tolower(typval_T *argvars, typval_T *rettv)
1616{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001617 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1618 return;
1619
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001620 rettv->v_type = VAR_STRING;
1621 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1622}
1623
1624/*
1625 * "toupper(string)" function
1626 */
1627 void
1628f_toupper(typval_T *argvars, typval_T *rettv)
1629{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001630 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1631 return;
1632
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001633 rettv->v_type = VAR_STRING;
1634 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1635}
1636
1637/*
1638 * "tr(string, fromstr, tostr)" function
1639 */
1640 void
1641f_tr(typval_T *argvars, typval_T *rettv)
1642{
1643 char_u *in_str;
1644 char_u *fromstr;
1645 char_u *tostr;
1646 char_u *p;
1647 int inlen;
1648 int fromlen;
1649 int tolen;
1650 int idx;
1651 char_u *cpstr;
1652 int cplen;
1653 int first = TRUE;
1654 char_u buf[NUMBUFLEN];
1655 char_u buf2[NUMBUFLEN];
1656 garray_T ga;
1657
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001658 if (in_vim9script()
1659 && (check_for_string_arg(argvars, 0) == FAIL
1660 || check_for_string_arg(argvars, 1) == FAIL
1661 || check_for_string_arg(argvars, 2) == FAIL))
1662 return;
1663
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001664 in_str = tv_get_string(&argvars[0]);
1665 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1666 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1667
1668 // Default return value: empty string.
1669 rettv->v_type = VAR_STRING;
1670 rettv->vval.v_string = NULL;
1671 if (fromstr == NULL || tostr == NULL)
1672 return; // type error; errmsg already given
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001673 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001674
1675 if (!has_mbyte)
1676 // not multi-byte: fromstr and tostr must be the same length
1677 if (STRLEN(fromstr) != STRLEN(tostr))
1678 {
1679error:
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001680 semsg(_(e_invalid_argument_str), fromstr);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001681 ga_clear(&ga);
1682 return;
1683 }
1684
1685 // fromstr and tostr have to contain the same number of chars
1686 while (*in_str != NUL)
1687 {
1688 if (has_mbyte)
1689 {
1690 inlen = (*mb_ptr2len)(in_str);
1691 cpstr = in_str;
1692 cplen = inlen;
1693 idx = 0;
1694 for (p = fromstr; *p != NUL; p += fromlen)
1695 {
1696 fromlen = (*mb_ptr2len)(p);
1697 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1698 {
1699 for (p = tostr; *p != NUL; p += tolen)
1700 {
1701 tolen = (*mb_ptr2len)(p);
1702 if (idx-- == 0)
1703 {
1704 cplen = tolen;
1705 cpstr = p;
1706 break;
1707 }
1708 }
1709 if (*p == NUL) // tostr is shorter than fromstr
1710 goto error;
1711 break;
1712 }
1713 ++idx;
1714 }
1715
1716 if (first && cpstr == in_str)
1717 {
1718 // Check that fromstr and tostr have the same number of
1719 // (multi-byte) characters. Done only once when a character
1720 // of in_str doesn't appear in fromstr.
1721 first = FALSE;
1722 for (p = tostr; *p != NUL; p += tolen)
1723 {
1724 tolen = (*mb_ptr2len)(p);
1725 --idx;
1726 }
1727 if (idx != 0)
1728 goto error;
1729 }
1730
1731 (void)ga_grow(&ga, cplen);
1732 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1733 ga.ga_len += cplen;
1734
1735 in_str += inlen;
1736 }
1737 else
1738 {
1739 // When not using multi-byte chars we can do it faster.
1740 p = vim_strchr(fromstr, *in_str);
1741 if (p != NULL)
1742 ga_append(&ga, tostr[p - fromstr]);
1743 else
1744 ga_append(&ga, *in_str);
1745 ++in_str;
1746 }
1747 }
1748
1749 // add a terminating NUL
1750 (void)ga_grow(&ga, 1);
1751 ga_append(&ga, NUL);
1752
1753 rettv->vval.v_string = ga.ga_data;
1754}
1755
1756/*
1757 * "trim({expr})" function
1758 */
1759 void
1760f_trim(typval_T *argvars, typval_T *rettv)
1761{
1762 char_u buf1[NUMBUFLEN];
1763 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001764 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001765 char_u *mask = NULL;
1766 char_u *tail;
1767 char_u *prev;
1768 char_u *p;
1769 int c1;
1770 int dir = 0;
1771
1772 rettv->v_type = VAR_STRING;
1773 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001774
1775 if (in_vim9script()
1776 && (check_for_string_arg(argvars, 0) == FAIL
1777 || check_for_opt_string_arg(argvars, 1) == FAIL
1778 || (argvars[1].v_type != VAR_UNKNOWN
1779 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1780 return;
1781
1782 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001783 if (head == NULL)
1784 return;
1785
1786 if (argvars[1].v_type != VAR_UNKNOWN && argvars[1].v_type != VAR_STRING)
1787 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001788 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[1]));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001789 return;
1790 }
1791
1792 if (argvars[1].v_type == VAR_STRING)
1793 {
1794 mask = tv_get_string_buf_chk(&argvars[1], buf2);
1795
1796 if (argvars[2].v_type != VAR_UNKNOWN)
1797 {
1798 int error = 0;
1799
1800 // leading or trailing characters to trim
1801 dir = (int)tv_get_number_chk(&argvars[2], &error);
1802 if (error)
1803 return;
1804 if (dir < 0 || dir > 2)
1805 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001806 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[2]));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001807 return;
1808 }
1809 }
1810 }
1811
1812 if (dir == 0 || dir == 1)
1813 {
1814 // Trim leading characters
1815 while (*head != NUL)
1816 {
1817 c1 = PTR2CHAR(head);
1818 if (mask == NULL)
1819 {
1820 if (c1 > ' ' && c1 != 0xa0)
1821 break;
1822 }
1823 else
1824 {
1825 for (p = mask; *p != NUL; MB_PTR_ADV(p))
1826 if (c1 == PTR2CHAR(p))
1827 break;
1828 if (*p == NUL)
1829 break;
1830 }
1831 MB_PTR_ADV(head);
1832 }
1833 }
1834
1835 tail = head + STRLEN(head);
1836 if (dir == 0 || dir == 2)
1837 {
1838 // Trim trailing characters
1839 for (; tail > head; tail = prev)
1840 {
1841 prev = tail;
1842 MB_PTR_BACK(head, prev);
1843 c1 = PTR2CHAR(prev);
1844 if (mask == NULL)
1845 {
1846 if (c1 > ' ' && c1 != 0xa0)
1847 break;
1848 }
1849 else
1850 {
1851 for (p = mask; *p != NUL; MB_PTR_ADV(p))
1852 if (c1 == PTR2CHAR(p))
1853 break;
1854 if (*p == NUL)
1855 break;
1856 }
1857 }
1858 }
1859 rettv->vval.v_string = vim_strnsave(head, tail - head);
1860}
1861
Bram Moolenaar677658a2022-01-05 16:09:06 +00001862static char *e_printf = N_(e_insufficient_arguments_for_printf);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001863
1864/*
1865 * Get number argument from "idxp" entry in "tvs". First entry is 1.
1866 */
1867 static varnumber_T
1868tv_nr(typval_T *tvs, int *idxp)
1869{
1870 int idx = *idxp - 1;
1871 varnumber_T n = 0;
1872 int err = FALSE;
1873
1874 if (tvs[idx].v_type == VAR_UNKNOWN)
1875 emsg(_(e_printf));
1876 else
1877 {
1878 ++*idxp;
1879 n = tv_get_number_chk(&tvs[idx], &err);
1880 if (err)
1881 n = 0;
1882 }
1883 return n;
1884}
1885
1886/*
1887 * Get string argument from "idxp" entry in "tvs". First entry is 1.
1888 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
1889 * are not converted to a string.
1890 * If "tofree" is not NULL echo_string() is used. All types are converted to
1891 * a string with the same format as ":echo". The caller must free "*tofree".
1892 * Returns NULL for an error.
1893 */
1894 static char *
1895tv_str(typval_T *tvs, int *idxp, char_u **tofree)
1896{
1897 int idx = *idxp - 1;
1898 char *s = NULL;
1899 static char_u numbuf[NUMBUFLEN];
1900
1901 if (tvs[idx].v_type == VAR_UNKNOWN)
1902 emsg(_(e_printf));
1903 else
1904 {
1905 ++*idxp;
1906 if (tofree != NULL)
1907 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
1908 else
1909 s = (char *)tv_get_string_chk(&tvs[idx]);
1910 }
1911 return s;
1912}
1913
1914# ifdef FEAT_FLOAT
1915/*
1916 * Get float argument from "idxp" entry in "tvs". First entry is 1.
1917 */
1918 static double
1919tv_float(typval_T *tvs, int *idxp)
1920{
1921 int idx = *idxp - 1;
1922 double f = 0;
1923
1924 if (tvs[idx].v_type == VAR_UNKNOWN)
1925 emsg(_(e_printf));
1926 else
1927 {
1928 ++*idxp;
1929 if (tvs[idx].v_type == VAR_FLOAT)
1930 f = tvs[idx].vval.v_float;
1931 else if (tvs[idx].v_type == VAR_NUMBER)
1932 f = (double)tvs[idx].vval.v_number;
1933 else
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00001934 emsg(_(e_expected_float_argument_for_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001935 }
1936 return f;
1937}
1938# endif
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001939
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001940#endif
1941
1942#ifdef FEAT_FLOAT
1943/*
1944 * Return the representation of infinity for printf() function:
1945 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
1946 */
1947 static const char *
1948infinity_str(int positive,
1949 char fmt_spec,
1950 int force_sign,
1951 int space_for_positive)
1952{
1953 static const char *table[] =
1954 {
1955 "-inf", "inf", "+inf", " inf",
1956 "-INF", "INF", "+INF", " INF"
1957 };
1958 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
1959
1960 if (ASCII_ISUPPER(fmt_spec))
1961 idx += 4;
1962 return table[idx];
1963}
1964#endif
1965
1966/*
1967 * This code was included to provide a portable vsnprintf() and snprintf().
1968 * Some systems may provide their own, but we always use this one for
1969 * consistency.
1970 *
1971 * This code is based on snprintf.c - a portable implementation of snprintf
1972 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
1973 * Included with permission. It was heavily modified to fit in Vim.
1974 * The original code, including useful comments, can be found here:
1975 * http://www.ijs.si/software/snprintf/
1976 *
1977 * This snprintf() only supports the following conversion specifiers:
1978 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
1979 * with flags: '-', '+', ' ', '0' and '#'.
1980 * An asterisk is supported for field width as well as precision.
1981 *
1982 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
1983 *
1984 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
1985 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
1986 *
1987 * The locale is not used, the string is used as a byte string. This is only
1988 * relevant for double-byte encodings where the second byte may be '%'.
1989 *
1990 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
1991 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
1992 *
1993 * The return value is the number of characters which would be generated
1994 * for the given input, excluding the trailing NUL. If this value
1995 * is greater or equal to "str_m", not all characters from the result
1996 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
1997 * are discarded. If "str_m" is greater than zero it is guaranteed
1998 * the resulting string will be NUL-terminated.
1999 */
2000
2001/*
2002 * When va_list is not supported we only define vim_snprintf().
2003 *
2004 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2005 * "typval_T". When the latter is not used it must be NULL.
2006 */
2007
2008// When generating prototypes all of this is skipped, cproto doesn't
2009// understand this.
2010#ifndef PROTO
2011
2012// Like vim_vsnprintf() but append to the string.
2013 int
2014vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2015{
2016 va_list ap;
2017 int str_l;
2018 size_t len = STRLEN(str);
2019 size_t space;
2020
2021 if (str_m <= len)
2022 space = 0;
2023 else
2024 space = str_m - len;
2025 va_start(ap, fmt);
2026 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2027 va_end(ap);
2028 return str_l;
2029}
2030
2031 int
2032vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2033{
2034 va_list ap;
2035 int str_l;
2036
2037 va_start(ap, fmt);
2038 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2039 va_end(ap);
2040 return str_l;
2041}
2042
2043 int
2044vim_vsnprintf(
2045 char *str,
2046 size_t str_m,
2047 const char *fmt,
2048 va_list ap)
2049{
2050 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2051}
2052
2053 int
2054vim_vsnprintf_typval(
2055 char *str,
2056 size_t str_m,
2057 const char *fmt,
2058 va_list ap,
2059 typval_T *tvs)
2060{
2061 size_t str_l = 0;
2062 const char *p = fmt;
2063 int arg_idx = 1;
2064
2065 if (p == NULL)
2066 p = "";
2067 while (*p != NUL)
2068 {
2069 if (*p != '%')
2070 {
2071 char *q = strchr(p + 1, '%');
2072 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2073
2074 // Copy up to the next '%' or NUL without any changes.
2075 if (str_l < str_m)
2076 {
2077 size_t avail = str_m - str_l;
2078
2079 mch_memmove(str + str_l, p, n > avail ? avail : n);
2080 }
2081 p += n;
2082 str_l += n;
2083 }
2084 else
2085 {
2086 size_t min_field_width = 0, precision = 0;
2087 int zero_padding = 0, precision_specified = 0, justify_left = 0;
2088 int alternate_form = 0, force_sign = 0;
2089
2090 // If both the ' ' and '+' flags appear, the ' ' flag should be
2091 // ignored.
2092 int space_for_positive = 1;
2093
2094 // allowed values: \0, h, l, L
2095 char length_modifier = '\0';
2096
2097 // temporary buffer for simple numeric->string conversion
2098# if defined(FEAT_FLOAT)
2099# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
2100 // That sounds reasonable to use as the maximum
2101 // printable.
2102# else
2103# define TMP_LEN 66
2104# endif
2105 char tmp[TMP_LEN];
2106
2107 // string address in case of string argument
2108 const char *str_arg = NULL;
2109
2110 // natural field width of arg without padding and sign
2111 size_t str_arg_l;
2112
2113 // unsigned char argument value - only defined for c conversion.
2114 // N.B. standard explicitly states the char argument for the c
2115 // conversion is unsigned
2116 unsigned char uchar_arg;
2117
2118 // number of zeros to be inserted for numeric conversions as
2119 // required by the precision or minimal field width
2120 size_t number_of_zeros_to_pad = 0;
2121
2122 // index into tmp where zero padding is to be inserted
2123 size_t zero_padding_insertion_ind = 0;
2124
2125 // current conversion specifier character
2126 char fmt_spec = '\0';
2127
2128 // buffer for 's' and 'S' specs
2129 char_u *tofree = NULL;
2130
2131
2132 p++; // skip '%'
2133
2134 // parse flags
2135 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2136 || *p == '#' || *p == '\'')
2137 {
2138 switch (*p)
2139 {
2140 case '0': zero_padding = 1; break;
2141 case '-': justify_left = 1; break;
2142 case '+': force_sign = 1; space_for_positive = 0; break;
2143 case ' ': force_sign = 1;
2144 // If both the ' ' and '+' flags appear, the ' '
2145 // flag should be ignored
2146 break;
2147 case '#': alternate_form = 1; break;
2148 case '\'': break;
2149 }
2150 p++;
2151 }
2152 // If the '0' and '-' flags both appear, the '0' flag should be
2153 // ignored.
2154
2155 // parse field width
2156 if (*p == '*')
2157 {
2158 int j;
2159
2160 p++;
2161 j =
2162# if defined(FEAT_EVAL)
2163 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2164# endif
2165 va_arg(ap, int);
2166 if (j >= 0)
2167 min_field_width = j;
2168 else
2169 {
2170 min_field_width = -j;
2171 justify_left = 1;
2172 }
2173 }
2174 else if (VIM_ISDIGIT((int)(*p)))
2175 {
2176 // size_t could be wider than unsigned int; make sure we treat
2177 // argument like common implementations do
2178 unsigned int uj = *p++ - '0';
2179
2180 while (VIM_ISDIGIT((int)(*p)))
2181 uj = 10 * uj + (unsigned int)(*p++ - '0');
2182 min_field_width = uj;
2183 }
2184
2185 // parse precision
2186 if (*p == '.')
2187 {
2188 p++;
2189 precision_specified = 1;
2190 if (*p == '*')
2191 {
2192 int j;
2193
2194 j =
2195# if defined(FEAT_EVAL)
2196 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2197# endif
2198 va_arg(ap, int);
2199 p++;
2200 if (j >= 0)
2201 precision = j;
2202 else
2203 {
2204 precision_specified = 0;
2205 precision = 0;
2206 }
2207 }
2208 else if (VIM_ISDIGIT((int)(*p)))
2209 {
2210 // size_t could be wider than unsigned int; make sure we
2211 // treat argument like common implementations do
2212 unsigned int uj = *p++ - '0';
2213
2214 while (VIM_ISDIGIT((int)(*p)))
2215 uj = 10 * uj + (unsigned int)(*p++ - '0');
2216 precision = uj;
2217 }
2218 }
2219
2220 // parse 'h', 'l' and 'll' length modifiers
2221 if (*p == 'h' || *p == 'l')
2222 {
2223 length_modifier = *p;
2224 p++;
2225 if (length_modifier == 'l' && *p == 'l')
2226 {
2227 // double l = __int64 / varnumber_T
2228 length_modifier = 'L';
2229 p++;
2230 }
2231 }
2232 fmt_spec = *p;
2233
2234 // common synonyms:
2235 switch (fmt_spec)
2236 {
2237 case 'i': fmt_spec = 'd'; break;
2238 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2239 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2240 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2241 default: break;
2242 }
2243
2244# if defined(FEAT_EVAL)
2245 switch (fmt_spec)
2246 {
2247 case 'd': case 'u': case 'o': case 'x': case 'X':
2248 if (tvs != NULL && length_modifier == '\0')
2249 length_modifier = 'L';
2250 }
2251# endif
2252
2253 // get parameter value, do initial processing
2254 switch (fmt_spec)
2255 {
2256 // '%' and 'c' behave similar to 's' regarding flags and field
2257 // widths
2258 case '%':
2259 case 'c':
2260 case 's':
2261 case 'S':
2262 str_arg_l = 1;
2263 switch (fmt_spec)
2264 {
2265 case '%':
2266 str_arg = p;
2267 break;
2268
2269 case 'c':
2270 {
2271 int j;
2272
2273 j =
2274# if defined(FEAT_EVAL)
2275 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2276# endif
2277 va_arg(ap, int);
2278 // standard demands unsigned char
2279 uchar_arg = (unsigned char)j;
2280 str_arg = (char *)&uchar_arg;
2281 break;
2282 }
2283
2284 case 's':
2285 case 'S':
2286 str_arg =
2287# if defined(FEAT_EVAL)
2288 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
2289# endif
2290 va_arg(ap, char *);
2291 if (str_arg == NULL)
2292 {
2293 str_arg = "[NULL]";
2294 str_arg_l = 6;
2295 }
2296 // make sure not to address string beyond the specified
2297 // precision !!!
2298 else if (!precision_specified)
2299 str_arg_l = strlen(str_arg);
2300 // truncate string if necessary as requested by precision
2301 else if (precision == 0)
2302 str_arg_l = 0;
2303 else
2304 {
2305 // Don't put the #if inside memchr(), it can be a
2306 // macro.
2307 // memchr on HP does not like n > 2^31 !!!
2308 char *q = memchr(str_arg, '\0',
2309 precision <= (size_t)0x7fffffffL ? precision
2310 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00002311
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002312 str_arg_l = (q == NULL) ? precision
2313 : (size_t)(q - str_arg);
2314 }
2315 if (fmt_spec == 'S')
2316 {
presuku1f2453f2021-11-24 15:32:57 +00002317 char_u *p1;
2318 size_t i;
2319 int cell;
presukud85fccd2021-11-20 19:38:31 +00002320
presuku1f2453f2021-11-24 15:32:57 +00002321 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002322 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00002323 {
2324 cell = mb_ptr2cells(p1);
2325 if (precision_specified && i + cell > precision)
2326 break;
2327 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002328 }
presuku1f2453f2021-11-24 15:32:57 +00002329
2330 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00002331 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00002332 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002333 }
2334 break;
2335
2336 default:
2337 break;
2338 }
2339 break;
2340
2341 case 'd': case 'u':
2342 case 'b': case 'B':
2343 case 'o':
2344 case 'x': case 'X':
2345 case 'p':
2346 {
2347 // NOTE: the u, b, o, x, X and p conversion specifiers
2348 // imply the value is unsigned; d implies a signed
2349 // value
2350
2351 // 0 if numeric argument is zero (or if pointer is
2352 // NULL for 'p'), +1 if greater than zero (or nonzero
2353 // for unsigned arguments), -1 if negative (unsigned
2354 // argument is never negative)
2355 int arg_sign = 0;
2356
2357 // only set for length modifier h, or for no length
2358 // modifiers
2359 int int_arg = 0;
2360 unsigned int uint_arg = 0;
2361
2362 // only set for length modifier l
2363 long int long_arg = 0;
2364 unsigned long int ulong_arg = 0;
2365
2366 // only set for length modifier ll
2367 varnumber_T llong_arg = 0;
2368 uvarnumber_T ullong_arg = 0;
2369
2370 // only set for b conversion
2371 uvarnumber_T bin_arg = 0;
2372
2373 // pointer argument value -only defined for p
2374 // conversion
2375 void *ptr_arg = NULL;
2376
2377 if (fmt_spec == 'p')
2378 {
2379 length_modifier = '\0';
2380 ptr_arg =
2381# if defined(FEAT_EVAL)
2382 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
2383 NULL) :
2384# endif
2385 va_arg(ap, void *);
2386 if (ptr_arg != NULL)
2387 arg_sign = 1;
2388 }
2389 else if (fmt_spec == 'b' || fmt_spec == 'B')
2390 {
2391 bin_arg =
2392# if defined(FEAT_EVAL)
2393 tvs != NULL ?
2394 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
2395# endif
2396 va_arg(ap, uvarnumber_T);
2397 if (bin_arg != 0)
2398 arg_sign = 1;
2399 }
2400 else if (fmt_spec == 'd')
2401 {
2402 // signed
2403 switch (length_modifier)
2404 {
2405 case '\0':
2406 case 'h':
2407 // char and short arguments are passed as int.
2408 int_arg =
2409# if defined(FEAT_EVAL)
2410 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2411# endif
2412 va_arg(ap, int);
2413 if (int_arg > 0)
2414 arg_sign = 1;
2415 else if (int_arg < 0)
2416 arg_sign = -1;
2417 break;
2418 case 'l':
2419 long_arg =
2420# if defined(FEAT_EVAL)
2421 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2422# endif
2423 va_arg(ap, long int);
2424 if (long_arg > 0)
2425 arg_sign = 1;
2426 else if (long_arg < 0)
2427 arg_sign = -1;
2428 break;
2429 case 'L':
2430 llong_arg =
2431# if defined(FEAT_EVAL)
2432 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2433# endif
2434 va_arg(ap, varnumber_T);
2435 if (llong_arg > 0)
2436 arg_sign = 1;
2437 else if (llong_arg < 0)
2438 arg_sign = -1;
2439 break;
2440 }
2441 }
2442 else
2443 {
2444 // unsigned
2445 switch (length_modifier)
2446 {
2447 case '\0':
2448 case 'h':
2449 uint_arg =
2450# if defined(FEAT_EVAL)
2451 tvs != NULL ? (unsigned)
2452 tv_nr(tvs, &arg_idx) :
2453# endif
2454 va_arg(ap, unsigned int);
2455 if (uint_arg != 0)
2456 arg_sign = 1;
2457 break;
2458 case 'l':
2459 ulong_arg =
2460# if defined(FEAT_EVAL)
2461 tvs != NULL ? (unsigned long)
2462 tv_nr(tvs, &arg_idx) :
2463# endif
2464 va_arg(ap, unsigned long int);
2465 if (ulong_arg != 0)
2466 arg_sign = 1;
2467 break;
2468 case 'L':
2469 ullong_arg =
2470# if defined(FEAT_EVAL)
2471 tvs != NULL ? (uvarnumber_T)
2472 tv_nr(tvs, &arg_idx) :
2473# endif
2474 va_arg(ap, uvarnumber_T);
2475 if (ullong_arg != 0)
2476 arg_sign = 1;
2477 break;
2478 }
2479 }
2480
2481 str_arg = tmp;
2482 str_arg_l = 0;
2483
2484 // NOTE:
2485 // For d, i, u, o, x, and X conversions, if precision is
2486 // specified, the '0' flag should be ignored. This is so
2487 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
2488 // FreeBSD, NetBSD; but not with Perl.
2489 if (precision_specified)
2490 zero_padding = 0;
2491 if (fmt_spec == 'd')
2492 {
2493 if (force_sign && arg_sign >= 0)
2494 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
2495 // leave negative numbers for sprintf to handle, to
2496 // avoid handling tricky cases like (short int)-32768
2497 }
2498 else if (alternate_form)
2499 {
2500 if (arg_sign != 0
2501 && (fmt_spec == 'b' || fmt_spec == 'B'
2502 || fmt_spec == 'x' || fmt_spec == 'X') )
2503 {
2504 tmp[str_arg_l++] = '0';
2505 tmp[str_arg_l++] = fmt_spec;
2506 }
2507 // alternate form should have no effect for p
2508 // conversion, but ...
2509 }
2510
2511 zero_padding_insertion_ind = str_arg_l;
2512 if (!precision_specified)
2513 precision = 1; // default precision is 1
2514 if (precision == 0 && arg_sign == 0)
2515 {
2516 // When zero value is formatted with an explicit
2517 // precision 0, the resulting formatted string is
2518 // empty (d, i, u, b, B, o, x, X, p).
2519 }
2520 else
2521 {
2522 char f[6];
2523 int f_l = 0;
2524
2525 // construct a simple format string for sprintf
2526 f[f_l++] = '%';
2527 if (!length_modifier)
2528 ;
2529 else if (length_modifier == 'L')
2530 {
2531# ifdef MSWIN
2532 f[f_l++] = 'I';
2533 f[f_l++] = '6';
2534 f[f_l++] = '4';
2535# else
2536 f[f_l++] = 'l';
2537 f[f_l++] = 'l';
2538# endif
2539 }
2540 else
2541 f[f_l++] = length_modifier;
2542 f[f_l++] = fmt_spec;
2543 f[f_l++] = '\0';
2544
2545 if (fmt_spec == 'p')
2546 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
2547 else if (fmt_spec == 'b' || fmt_spec == 'B')
2548 {
2549 char b[8 * sizeof(uvarnumber_T)];
2550 size_t b_l = 0;
2551 uvarnumber_T bn = bin_arg;
2552
2553 do
2554 {
2555 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
2556 bn >>= 1;
2557 }
2558 while (bn != 0);
2559
2560 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
2561 str_arg_l += b_l;
2562 }
2563 else if (fmt_spec == 'd')
2564 {
2565 // signed
2566 switch (length_modifier)
2567 {
2568 case '\0': str_arg_l += sprintf(
2569 tmp + str_arg_l, f,
2570 int_arg);
2571 break;
2572 case 'h': str_arg_l += sprintf(
2573 tmp + str_arg_l, f,
2574 (short)int_arg);
2575 break;
2576 case 'l': str_arg_l += sprintf(
2577 tmp + str_arg_l, f, long_arg);
2578 break;
2579 case 'L': str_arg_l += sprintf(
2580 tmp + str_arg_l, f, llong_arg);
2581 break;
2582 }
2583 }
2584 else
2585 {
2586 // unsigned
2587 switch (length_modifier)
2588 {
2589 case '\0': str_arg_l += sprintf(
2590 tmp + str_arg_l, f,
2591 uint_arg);
2592 break;
2593 case 'h': str_arg_l += sprintf(
2594 tmp + str_arg_l, f,
2595 (unsigned short)uint_arg);
2596 break;
2597 case 'l': str_arg_l += sprintf(
2598 tmp + str_arg_l, f, ulong_arg);
2599 break;
2600 case 'L': str_arg_l += sprintf(
2601 tmp + str_arg_l, f, ullong_arg);
2602 break;
2603 }
2604 }
2605
2606 // include the optional minus sign and possible
2607 // "0x" in the region before the zero padding
2608 // insertion point
2609 if (zero_padding_insertion_ind < str_arg_l
2610 && tmp[zero_padding_insertion_ind] == '-')
2611 zero_padding_insertion_ind++;
2612 if (zero_padding_insertion_ind + 1 < str_arg_l
2613 && tmp[zero_padding_insertion_ind] == '0'
2614 && (tmp[zero_padding_insertion_ind + 1] == 'x'
2615 || tmp[zero_padding_insertion_ind + 1] == 'X'))
2616 zero_padding_insertion_ind += 2;
2617 }
2618
2619 {
2620 size_t num_of_digits = str_arg_l
2621 - zero_padding_insertion_ind;
2622
2623 if (alternate_form && fmt_spec == 'o'
2624 // unless zero is already the first
2625 // character
2626 && !(zero_padding_insertion_ind < str_arg_l
2627 && tmp[zero_padding_insertion_ind] == '0'))
2628 {
2629 // assure leading zero for alternate-form
2630 // octal numbers
2631 if (!precision_specified
2632 || precision < num_of_digits + 1)
2633 {
2634 // precision is increased to force the
2635 // first character to be zero, except if a
2636 // zero value is formatted with an
2637 // explicit precision of zero
2638 precision = num_of_digits + 1;
2639 }
2640 }
2641 // zero padding to specified precision?
2642 if (num_of_digits < precision)
2643 number_of_zeros_to_pad = precision - num_of_digits;
2644 }
2645 // zero padding to specified minimal field width?
2646 if (!justify_left && zero_padding)
2647 {
2648 int n = (int)(min_field_width - (str_arg_l
2649 + number_of_zeros_to_pad));
2650 if (n > 0)
2651 number_of_zeros_to_pad += n;
2652 }
2653 break;
2654 }
2655
2656# ifdef FEAT_FLOAT
2657 case 'f':
2658 case 'F':
2659 case 'e':
2660 case 'E':
2661 case 'g':
2662 case 'G':
2663 {
2664 // Floating point.
2665 double f;
2666 double abs_f;
2667 char format[40];
2668 int l;
2669 int remove_trailing_zeroes = FALSE;
2670
2671 f =
2672# if defined(FEAT_EVAL)
2673 tvs != NULL ? tv_float(tvs, &arg_idx) :
2674# endif
2675 va_arg(ap, double);
2676 abs_f = f < 0 ? -f : f;
2677
2678 if (fmt_spec == 'g' || fmt_spec == 'G')
2679 {
2680 // Would be nice to use %g directly, but it prints
2681 // "1.0" as "1", we don't want that.
2682 if ((abs_f >= 0.001 && abs_f < 10000000.0)
2683 || abs_f == 0.0)
2684 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
2685 else
2686 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
2687 remove_trailing_zeroes = TRUE;
2688 }
2689
2690 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
2691# ifdef VAX
2692 abs_f > 1.0e38
2693# else
2694 abs_f > 1.0e307
2695# endif
2696 )
2697 {
2698 // Avoid a buffer overflow
2699 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2700 force_sign, space_for_positive));
2701 str_arg_l = STRLEN(tmp);
2702 zero_padding = 0;
2703 }
2704 else
2705 {
2706 if (isnan(f))
2707 {
2708 // Not a number: nan or NAN
2709 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
2710 : "nan");
2711 str_arg_l = 3;
2712 zero_padding = 0;
2713 }
2714 else if (isinf(f))
2715 {
2716 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2717 force_sign, space_for_positive));
2718 str_arg_l = STRLEN(tmp);
2719 zero_padding = 0;
2720 }
2721 else
2722 {
2723 // Regular float number
2724 format[0] = '%';
2725 l = 1;
2726 if (force_sign)
2727 format[l++] = space_for_positive ? ' ' : '+';
2728 if (precision_specified)
2729 {
2730 size_t max_prec = TMP_LEN - 10;
2731
2732 // Make sure we don't get more digits than we
2733 // have room for.
2734 if ((fmt_spec == 'f' || fmt_spec == 'F')
2735 && abs_f > 1.0)
2736 max_prec -= (size_t)log10(abs_f);
2737 if (precision > max_prec)
2738 precision = max_prec;
2739 l += sprintf(format + l, ".%d", (int)precision);
2740 }
2741 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
2742 format[l + 1] = NUL;
2743
2744 str_arg_l = sprintf(tmp, format, f);
2745 }
2746
2747 if (remove_trailing_zeroes)
2748 {
2749 int i;
2750 char *tp;
2751
2752 // Using %g or %G: remove superfluous zeroes.
2753 if (fmt_spec == 'f' || fmt_spec == 'F')
2754 tp = tmp + str_arg_l - 1;
2755 else
2756 {
2757 tp = (char *)vim_strchr((char_u *)tmp,
2758 fmt_spec == 'e' ? 'e' : 'E');
2759 if (tp != NULL)
2760 {
2761 // Remove superfluous '+' and leading
2762 // zeroes from the exponent.
2763 if (tp[1] == '+')
2764 {
2765 // Change "1.0e+07" to "1.0e07"
2766 STRMOVE(tp + 1, tp + 2);
2767 --str_arg_l;
2768 }
2769 i = (tp[1] == '-') ? 2 : 1;
2770 while (tp[i] == '0')
2771 {
2772 // Change "1.0e07" to "1.0e7"
2773 STRMOVE(tp + i, tp + i + 1);
2774 --str_arg_l;
2775 }
2776 --tp;
2777 }
2778 }
2779
2780 if (tp != NULL && !precision_specified)
2781 // Remove trailing zeroes, but keep the one
2782 // just after a dot.
2783 while (tp > tmp + 2 && *tp == '0'
2784 && tp[-1] != '.')
2785 {
2786 STRMOVE(tp, tp + 1);
2787 --tp;
2788 --str_arg_l;
2789 }
2790 }
2791 else
2792 {
2793 char *tp;
2794
2795 // Be consistent: some printf("%e") use 1.0e+12
2796 // and some 1.0e+012. Remove one zero in the last
2797 // case.
2798 tp = (char *)vim_strchr((char_u *)tmp,
2799 fmt_spec == 'e' ? 'e' : 'E');
2800 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
2801 && tp[2] == '0'
2802 && vim_isdigit(tp[3])
2803 && vim_isdigit(tp[4]))
2804 {
2805 STRMOVE(tp + 2, tp + 3);
2806 --str_arg_l;
2807 }
2808 }
2809 }
2810 if (zero_padding && min_field_width > str_arg_l
2811 && (tmp[0] == '-' || force_sign))
2812 {
2813 // padding 0's should be inserted after the sign
2814 number_of_zeros_to_pad = min_field_width - str_arg_l;
2815 zero_padding_insertion_ind = 1;
2816 }
2817 str_arg = tmp;
2818 break;
2819 }
2820# endif
2821
2822 default:
2823 // unrecognized conversion specifier, keep format string
2824 // as-is
2825 zero_padding = 0; // turn zero padding off for non-numeric
2826 // conversion
2827 justify_left = 1;
2828 min_field_width = 0; // reset flags
2829
2830 // discard the unrecognized conversion, just keep *
2831 // the unrecognized conversion character
2832 str_arg = p;
2833 str_arg_l = 0;
2834 if (*p != NUL)
2835 str_arg_l++; // include invalid conversion specifier
2836 // unchanged if not at end-of-string
2837 break;
2838 }
2839
2840 if (*p != NUL)
2841 p++; // step over the just processed conversion specifier
2842
2843 // insert padding to the left as requested by min_field_width;
2844 // this does not include the zero padding in case of numerical
2845 // conversions
2846 if (!justify_left)
2847 {
2848 // left padding with blank or zero
2849 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
2850
2851 if (pn > 0)
2852 {
2853 if (str_l < str_m)
2854 {
2855 size_t avail = str_m - str_l;
2856
2857 vim_memset(str + str_l, zero_padding ? '0' : ' ',
2858 (size_t)pn > avail ? avail
2859 : (size_t)pn);
2860 }
2861 str_l += pn;
2862 }
2863 }
2864
2865 // zero padding as requested by the precision or by the minimal
2866 // field width for numeric conversions required?
2867 if (number_of_zeros_to_pad == 0)
2868 {
2869 // will not copy first part of numeric right now, *
2870 // force it to be copied later in its entirety
2871 zero_padding_insertion_ind = 0;
2872 }
2873 else
2874 {
2875 // insert first part of numerics (sign or '0x') before zero
2876 // padding
2877 int zn = (int)zero_padding_insertion_ind;
2878
2879 if (zn > 0)
2880 {
2881 if (str_l < str_m)
2882 {
2883 size_t avail = str_m - str_l;
2884
2885 mch_memmove(str + str_l, str_arg,
2886 (size_t)zn > avail ? avail
2887 : (size_t)zn);
2888 }
2889 str_l += zn;
2890 }
2891
2892 // insert zero padding as requested by the precision or min
2893 // field width
2894 zn = (int)number_of_zeros_to_pad;
2895 if (zn > 0)
2896 {
2897 if (str_l < str_m)
2898 {
2899 size_t avail = str_m - str_l;
2900
2901 vim_memset(str + str_l, '0',
2902 (size_t)zn > avail ? avail
2903 : (size_t)zn);
2904 }
2905 str_l += zn;
2906 }
2907 }
2908
2909 // insert formatted string
2910 // (or as-is conversion specifier for unknown conversions)
2911 {
2912 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
2913
2914 if (sn > 0)
2915 {
2916 if (str_l < str_m)
2917 {
2918 size_t avail = str_m - str_l;
2919
2920 mch_memmove(str + str_l,
2921 str_arg + zero_padding_insertion_ind,
2922 (size_t)sn > avail ? avail : (size_t)sn);
2923 }
2924 str_l += sn;
2925 }
2926 }
2927
2928 // insert right padding
2929 if (justify_left)
2930 {
2931 // right blank padding to the field width
2932 int pn = (int)(min_field_width
2933 - (str_arg_l + number_of_zeros_to_pad));
2934
2935 if (pn > 0)
2936 {
2937 if (str_l < str_m)
2938 {
2939 size_t avail = str_m - str_l;
2940
2941 vim_memset(str + str_l, ' ',
2942 (size_t)pn > avail ? avail
2943 : (size_t)pn);
2944 }
2945 str_l += pn;
2946 }
2947 }
2948 vim_free(tofree);
2949 }
2950 }
2951
2952 if (str_m > 0)
2953 {
2954 // make sure the string is nul-terminated even at the expense of
2955 // overwriting the last character (shouldn't happen, but just in case)
2956 //
2957 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
2958 }
2959
2960 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar677658a2022-01-05 16:09:06 +00002961 emsg(_(e_too_many_arguments_to_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002962
2963 // Return the number of characters formatted (excluding trailing nul
2964 // character), that is, the number of characters that would have been
2965 // written to the buffer if it were large enough.
2966 return (int)str_l;
2967}
2968
2969#endif // PROTO