blob: 5aa7152bbd3883c2e6fdbd90b90b8146c0017696 [file] [log] [blame]
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * strings.c: string manipulation functions
12 */
13
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +020014#define USING_FLOAT_STUFF
Yegappan Lakshmanana2438132021-07-10 21:29:18 +020015#include "vim.h"
16
17/*
18 * Copy "string" into newly allocated memory.
19 */
20 char_u *
21vim_strsave(char_u *string)
22{
23 char_u *p;
24 size_t len;
25
26 len = STRLEN(string) + 1;
27 p = alloc(len);
28 if (p != NULL)
29 mch_memmove(p, string, len);
30 return p;
31}
32
33/*
34 * Copy up to "len" bytes of "string" into newly allocated memory and
35 * terminate with a NUL.
36 * The allocated memory always has size "len + 1", also when "string" is
37 * shorter.
38 */
39 char_u *
40vim_strnsave(char_u *string, size_t len)
41{
42 char_u *p;
43
44 p = alloc(len + 1);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +000045 if (p == NULL)
46 return NULL;
47
48 STRNCPY(p, string, len);
49 p[len] = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +020050 return p;
51}
52
53/*
54 * Same as vim_strsave(), but any characters found in esc_chars are preceded
55 * by a backslash.
56 */
57 char_u *
58vim_strsave_escaped(char_u *string, char_u *esc_chars)
59{
60 return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE);
61}
62
63/*
64 * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
65 * characters where rem_backslash() would remove the backslash.
66 * Escape the characters with "cc".
67 */
68 char_u *
69vim_strsave_escaped_ext(
70 char_u *string,
71 char_u *esc_chars,
72 int cc,
73 int bsl)
74{
75 char_u *p;
76 char_u *p2;
77 char_u *escaped_string;
78 unsigned length;
79 int l;
80
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +020081 // First count the number of backslashes required.
82 // Then allocate the memory and insert them.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +020083 length = 1; // count the trailing NUL
84 for (p = string; *p; p++)
85 {
86 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
87 {
88 length += l; // count a multibyte char
89 p += l - 1;
90 continue;
91 }
92 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
93 ++length; // count a backslash
94 ++length; // count an ordinary char
95 }
96 escaped_string = alloc(length);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +000097 if (escaped_string == NULL)
98 return NULL;
99 p2 = escaped_string;
100 for (p = string; *p; p++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200101 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000102 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200103 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000104 mch_memmove(p2, p, (size_t)l);
105 p2 += l;
106 p += l - 1; // skip multibyte char
107 continue;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200108 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000109 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
110 *p2++ = cc;
111 *p2++ = *p;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200112 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000113 *p2 = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200114 return escaped_string;
115}
116
117/*
118 * Return TRUE when 'shell' has "csh" in the tail.
119 */
120 int
121csh_like_shell(void)
122{
123 return (strstr((char *)gettail(p_sh), "csh") != NULL);
124}
125
126/*
Jason Cox6e823512021-08-29 12:36:49 +0200127 * Return TRUE when 'shell' has "fish" in the tail.
128 */
Dominique Pellede05ae72021-08-30 19:57:34 +0200129 static int
Jason Cox6e823512021-08-29 12:36:49 +0200130fish_like_shell(void)
131{
132 return (strstr((char *)gettail(p_sh), "fish") != NULL);
133}
134
135/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200136 * Escape "string" for use as a shell argument with system().
137 * This uses single quotes, except when we know we need to use double quotes
138 * (MS-DOS and MS-Windows not using PowerShell and without 'shellslash' set).
139 * PowerShell also uses a novel escaping for enclosed single quotes - double
140 * them up.
141 * Escape a newline, depending on the 'shell' option.
142 * When "do_special" is TRUE also replace "!", "%", "#" and things starting
143 * with "<" like "<cfile>".
144 * When "do_newline" is FALSE do not escape newline unless it is csh shell.
145 * Returns the result in allocated memory, NULL if we have run out.
146 */
147 char_u *
148vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
149{
150 unsigned length;
151 char_u *p;
152 char_u *d;
153 char_u *escaped_string;
154 int l;
155 int csh_like;
Jason Cox6e823512021-08-29 12:36:49 +0200156 int fish_like;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200157 char_u *shname;
158 int powershell;
159# ifdef MSWIN
160 int double_quotes;
161# endif
162
163 // Only csh and similar shells expand '!' within single quotes. For sh and
164 // the like we must not put a backslash before it, it will be taken
165 // literally. If do_special is set the '!' will be escaped twice.
166 // Csh also needs to have "\n" escaped twice when do_special is set.
167 csh_like = csh_like_shell();
168
Jason Cox6e823512021-08-29 12:36:49 +0200169 // Fish shell uses '\' as an escape character within single quotes, so '\'
170 // itself must be escaped to get a literal '\'.
171 fish_like = fish_like_shell();
172
Dominique Pelleaf4a61a2021-12-27 17:21:41 +0000173 // PowerShell uses its own version for quoting single quotes
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200174 shname = gettail(p_sh);
175 powershell = strstr((char *)shname, "pwsh") != NULL;
176# ifdef MSWIN
177 powershell = powershell || strstr((char *)shname, "powershell") != NULL;
178 // PowerShell only accepts single quotes so override shellslash.
179 double_quotes = !powershell && !p_ssl;
180# endif
181
182 // First count the number of extra bytes required.
183 length = (unsigned)STRLEN(string) + 3; // two quotes and a trailing NUL
184 for (p = string; *p != NUL; MB_PTR_ADV(p))
185 {
186# ifdef MSWIN
187 if (double_quotes)
188 {
189 if (*p == '"')
190 ++length; // " -> ""
191 }
192 else
193# endif
194 if (*p == '\'')
195 {
196 if (powershell)
197 length +=2; // ' => ''
198 else
199 length += 3; // ' => '\''
200 }
201 if ((*p == '\n' && (csh_like || do_newline))
202 || (*p == '!' && (csh_like || do_special)))
203 {
204 ++length; // insert backslash
205 if (csh_like && do_special)
206 ++length; // insert backslash
207 }
208 if (do_special && find_cmdline_var(p, &l) >= 0)
209 {
210 ++length; // insert backslash
211 p += l - 1;
212 }
Jason Cox6e823512021-08-29 12:36:49 +0200213 if (*p == '\\' && fish_like)
214 ++length; // insert backslash
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200215 }
216
217 // Allocate memory for the result and fill it.
218 escaped_string = alloc(length);
219 if (escaped_string != NULL)
220 {
221 d = escaped_string;
222
223 // add opening quote
224# ifdef MSWIN
225 if (double_quotes)
226 *d++ = '"';
227 else
228# endif
229 *d++ = '\'';
230
231 for (p = string; *p != NUL; )
232 {
233# ifdef MSWIN
234 if (double_quotes)
235 {
236 if (*p == '"')
237 {
238 *d++ = '"';
239 *d++ = '"';
240 ++p;
241 continue;
242 }
243 }
244 else
245# endif
246 if (*p == '\'')
247 {
248 if (powershell)
249 {
250 *d++ = '\'';
251 *d++ = '\'';
252 }
253 else
254 {
255 *d++ = '\'';
256 *d++ = '\\';
257 *d++ = '\'';
258 *d++ = '\'';
259 }
260 ++p;
261 continue;
262 }
263 if ((*p == '\n' && (csh_like || do_newline))
264 || (*p == '!' && (csh_like || do_special)))
265 {
266 *d++ = '\\';
267 if (csh_like && do_special)
268 *d++ = '\\';
269 *d++ = *p++;
270 continue;
271 }
272 if (do_special && find_cmdline_var(p, &l) >= 0)
273 {
274 *d++ = '\\'; // insert backslash
275 while (--l >= 0) // copy the var
276 *d++ = *p++;
277 continue;
278 }
Jason Cox6e823512021-08-29 12:36:49 +0200279 if (*p == '\\' && fish_like)
280 {
281 *d++ = '\\';
282 *d++ = *p++;
Bram Moolenaar66315972021-09-01 14:31:51 +0200283 continue;
Jason Cox6e823512021-08-29 12:36:49 +0200284 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200285
286 MB_COPY_CHAR(p, d);
287 }
288
289 // add terminating quote and finish with a NUL
290# ifdef MSWIN
291 if (double_quotes)
292 *d++ = '"';
293 else
294# endif
295 *d++ = '\'';
296 *d = NUL;
297 }
298
299 return escaped_string;
300}
301
302/*
303 * Like vim_strsave(), but make all characters uppercase.
304 * This uses ASCII lower-to-upper case translation, language independent.
305 */
306 char_u *
307vim_strsave_up(char_u *string)
308{
309 char_u *p1;
310
311 p1 = vim_strsave(string);
312 vim_strup(p1);
313 return p1;
314}
315
316/*
317 * Like vim_strnsave(), but make all characters uppercase.
318 * This uses ASCII lower-to-upper case translation, language independent.
319 */
320 char_u *
321vim_strnsave_up(char_u *string, size_t len)
322{
323 char_u *p1;
324
325 p1 = vim_strnsave(string, len);
326 vim_strup(p1);
327 return p1;
328}
329
330/*
331 * ASCII lower-to-upper case translation, language independent.
332 */
333 void
334vim_strup(
335 char_u *p)
336{
337 char_u *p2;
338 int c;
339
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000340 if (p == NULL)
341 return;
342
343 p2 = p;
344 while ((c = *p2) != NUL)
345 *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200346}
347
348#if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
349/*
350 * Make string "s" all upper-case and return it in allocated memory.
351 * Handles multi-byte characters as well as possible.
352 * Returns NULL when out of memory.
353 */
354 static char_u *
355strup_save(char_u *orig)
356{
357 char_u *p;
358 char_u *res;
359
360 res = p = vim_strsave(orig);
361
362 if (res != NULL)
363 while (*p != NUL)
364 {
365 int l;
366
367 if (enc_utf8)
368 {
369 int c, uc;
370 int newl;
371 char_u *s;
372
373 c = utf_ptr2char(p);
374 l = utf_ptr2len(p);
375 if (c == 0)
376 {
377 // overlong sequence, use only the first byte
378 c = *p;
379 l = 1;
380 }
381 uc = utf_toupper(c);
382
383 // Reallocate string when byte count changes. This is rare,
384 // thus it's OK to do another malloc()/free().
385 newl = utf_char2len(uc);
386 if (newl != l)
387 {
388 s = alloc(STRLEN(res) + 1 + newl - l);
389 if (s == NULL)
390 {
391 vim_free(res);
392 return NULL;
393 }
394 mch_memmove(s, res, p - res);
395 STRCPY(s + (p - res) + newl, p + l);
396 p = s + (p - res);
397 vim_free(res);
398 res = s;
399 }
400
401 utf_char2bytes(uc, p);
402 p += newl;
403 }
404 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
405 p += l; // skip multi-byte character
406 else
407 {
408 *p = TOUPPER_LOC(*p); // note that toupper() can be a macro
409 p++;
410 }
411 }
412
413 return res;
414}
415
416/*
417 * Make string "s" all lower-case and return it in allocated memory.
418 * Handles multi-byte characters as well as possible.
419 * Returns NULL when out of memory.
420 */
421 char_u *
422strlow_save(char_u *orig)
423{
424 char_u *p;
425 char_u *res;
426
427 res = p = vim_strsave(orig);
428
429 if (res != NULL)
430 while (*p != NUL)
431 {
432 int l;
433
434 if (enc_utf8)
435 {
436 int c, lc;
437 int newl;
438 char_u *s;
439
440 c = utf_ptr2char(p);
441 l = utf_ptr2len(p);
442 if (c == 0)
443 {
444 // overlong sequence, use only the first byte
445 c = *p;
446 l = 1;
447 }
448 lc = utf_tolower(c);
449
450 // Reallocate string when byte count changes. This is rare,
451 // thus it's OK to do another malloc()/free().
452 newl = utf_char2len(lc);
453 if (newl != l)
454 {
455 s = alloc(STRLEN(res) + 1 + newl - l);
456 if (s == NULL)
457 {
458 vim_free(res);
459 return NULL;
460 }
461 mch_memmove(s, res, p - res);
462 STRCPY(s + (p - res) + newl, p + l);
463 p = s + (p - res);
464 vim_free(res);
465 res = s;
466 }
467
468 utf_char2bytes(lc, p);
469 p += newl;
470 }
471 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
472 p += l; // skip multi-byte character
473 else
474 {
475 *p = TOLOWER_LOC(*p); // note that tolower() can be a macro
476 p++;
477 }
478 }
479
480 return res;
481}
482#endif
483
484/*
485 * delete spaces at the end of a string
486 */
487 void
488del_trailing_spaces(char_u *ptr)
489{
490 char_u *q;
491
492 q = ptr + STRLEN(ptr);
493 while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
494 *q = NUL;
495}
496
497/*
498 * Like strncpy(), but always terminate the result with one NUL.
499 * "to" must be "len + 1" long!
500 */
501 void
502vim_strncpy(char_u *to, char_u *from, size_t len)
503{
504 STRNCPY(to, from, len);
505 to[len] = NUL;
506}
507
508/*
509 * Like strcat(), but make sure the result fits in "tosize" bytes and is
510 * always NUL terminated. "from" and "to" may overlap.
511 */
512 void
513vim_strcat(char_u *to, char_u *from, size_t tosize)
514{
515 size_t tolen = STRLEN(to);
516 size_t fromlen = STRLEN(from);
517
518 if (tolen + fromlen + 1 > tosize)
519 {
520 mch_memmove(to + tolen, from, tosize - tolen - 1);
521 to[tosize - 1] = NUL;
522 }
523 else
524 mch_memmove(to + tolen, from, fromlen + 1);
525}
526
Bram Moolenaarc32949b2023-01-04 15:56:51 +0000527/*
528 * A version of strlen() that has a maximum length.
529 */
530 size_t
531vim_strlen_maxlen(char *s, size_t maxlen)
532{
533 size_t i;
534 for (i = 0; i < maxlen; ++i)
535 if (s[i] == NUL)
536 break;
537 return i;
538}
539
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200540#if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
541/*
542 * Compare two strings, ignoring case, using current locale.
543 * Doesn't work for multi-byte characters.
544 * return 0 for match, < 0 for smaller, > 0 for bigger
545 */
546 int
547vim_stricmp(char *s1, char *s2)
548{
549 int i;
550
551 for (;;)
552 {
553 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
554 if (i != 0)
555 return i; // this character different
556 if (*s1 == NUL)
557 break; // strings match until NUL
558 ++s1;
559 ++s2;
560 }
561 return 0; // strings match
562}
563#endif
564
565#if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
566/*
567 * Compare two strings, for length "len", ignoring case, using current locale.
568 * Doesn't work for multi-byte characters.
569 * return 0 for match, < 0 for smaller, > 0 for bigger
570 */
571 int
572vim_strnicmp(char *s1, char *s2, size_t len)
573{
574 int i;
575
576 while (len > 0)
577 {
578 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
579 if (i != 0)
580 return i; // this character different
581 if (*s1 == NUL)
582 break; // strings match until NUL
583 ++s1;
584 ++s2;
585 --len;
586 }
587 return 0; // strings match
588}
589#endif
590
591/*
592 * Search for first occurrence of "c" in "string".
593 * Version of strchr() that handles unsigned char strings with characters from
594 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
595 * end of the string.
596 */
Bram Moolenaarc32949b2023-01-04 15:56:51 +0000597 char_u *
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200598vim_strchr(char_u *string, int c)
599{
600 char_u *p;
601 int b;
602
603 p = string;
604 if (enc_utf8 && c >= 0x80)
605 {
606 while (*p != NUL)
607 {
608 int l = utfc_ptr2len(p);
609
610 // Avoid matching an illegal byte here.
611 if (utf_ptr2char(p) == c && l > 1)
612 return p;
613 p += l;
614 }
615 return NULL;
616 }
617 if (enc_dbcs != 0 && c > 255)
618 {
619 int n2 = c & 0xff;
620
621 c = ((unsigned)c >> 8) & 0xff;
622 while ((b = *p) != NUL)
623 {
624 if (b == c && p[1] == n2)
625 return p;
626 p += (*mb_ptr2len)(p);
627 }
628 return NULL;
629 }
630 if (has_mbyte)
631 {
632 while ((b = *p) != NUL)
633 {
634 if (b == c)
635 return p;
636 p += (*mb_ptr2len)(p);
637 }
638 return NULL;
639 }
640 while ((b = *p) != NUL)
641 {
642 if (b == c)
643 return p;
644 ++p;
645 }
646 return NULL;
647}
648
649/*
650 * Version of strchr() that only works for bytes and handles unsigned char
651 * strings with characters above 128 correctly. It also doesn't return a
652 * pointer to the NUL at the end of the string.
653 */
654 char_u *
655vim_strbyte(char_u *string, int c)
656{
657 char_u *p = string;
658
659 while (*p != NUL)
660 {
661 if (*p == c)
662 return p;
663 ++p;
664 }
665 return NULL;
666}
667
668/*
669 * Search for last occurrence of "c" in "string".
670 * Version of strrchr() that handles unsigned char strings with characters from
671 * 128 to 255 correctly. It also doesn't return a pointer to the NUL at the
672 * end of the string.
673 * Return NULL if not found.
674 * Does not handle multi-byte char for "c"!
675 */
676 char_u *
677vim_strrchr(char_u *string, int c)
678{
679 char_u *retval = NULL;
680 char_u *p = string;
681
682 while (*p)
683 {
684 if (*p == c)
685 retval = p;
686 MB_PTR_ADV(p);
687 }
688 return retval;
689}
690
691/*
692 * Vim's version of strpbrk(), in case it's missing.
693 * Don't generate a prototype for this, causes problems when it's not used.
694 */
695#ifndef PROTO
696# ifndef HAVE_STRPBRK
697# ifdef vim_strpbrk
698# undef vim_strpbrk
699# endif
700 char_u *
701vim_strpbrk(char_u *s, char_u *charset)
702{
703 while (*s)
704 {
705 if (vim_strchr(charset, *s) != NULL)
706 return s;
707 MB_PTR_ADV(s);
708 }
709 return NULL;
710}
711# endif
712#endif
713
714/*
715 * Sort an array of strings.
716 */
717static int sort_compare(const void *s1, const void *s2);
718
719 static int
720sort_compare(const void *s1, const void *s2)
721{
722 return STRCMP(*(char **)s1, *(char **)s2);
723}
724
725 void
726sort_strings(
727 char_u **files,
728 int count)
729{
730 qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
731}
732
733#if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
734/*
735 * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
736 * When "s" is NULL FALSE is returned.
737 */
738 int
739has_non_ascii(char_u *s)
740{
741 char_u *p;
742
743 if (s != NULL)
744 for (p = s; *p != NUL; ++p)
745 if (*p >= 128)
746 return TRUE;
747 return FALSE;
748}
749#endif
750
751/*
752 * Concatenate two strings and return the result in allocated memory.
753 * Returns NULL when out of memory.
754 */
755 char_u *
756concat_str(char_u *str1, char_u *str2)
757{
758 char_u *dest;
759 size_t l = str1 == NULL ? 0 : STRLEN(str1);
760
761 dest = alloc(l + (str2 == NULL ? 0 : STRLEN(str2)) + 1L);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000762 if (dest == NULL)
763 return NULL;
764 if (str1 == NULL)
765 *dest = NUL;
766 else
767 STRCPY(dest, str1);
768 if (str2 != NULL)
769 STRCPY(dest + l, str2);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200770 return dest;
771}
772
773#if defined(FEAT_EVAL) || defined(PROTO)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200774/*
775 * Return string "str" in ' quotes, doubling ' characters.
776 * If "str" is NULL an empty string is assumed.
777 * If "function" is TRUE make it function('string').
778 */
779 char_u *
780string_quote(char_u *str, int function)
781{
782 unsigned len;
783 char_u *p, *r, *s;
784
785 len = (function ? 13 : 3);
786 if (str != NULL)
787 {
788 len += (unsigned)STRLEN(str);
789 for (p = str; *p != NUL; MB_PTR_ADV(p))
790 if (*p == '\'')
791 ++len;
792 }
793 s = r = alloc(len);
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000794 if (r == NULL)
795 return NULL;
796
797 if (function)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200798 {
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000799 STRCPY(r, "function('");
800 r += 10;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200801 }
Yegappan Lakshmanan6ec66662023-01-23 20:46:21 +0000802 else
803 *r++ = '\'';
804 if (str != NULL)
805 for (p = str; *p != NUL; )
806 {
807 if (*p == '\'')
808 *r++ = '\'';
809 MB_COPY_CHAR(p, r);
810 }
811 *r++ = '\'';
812 if (function)
813 *r++ = ')';
814 *r++ = NUL;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +0200815 return s;
816}
817
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000818/*
819 * Count the number of times "needle" occurs in string "haystack". Case is
820 * ignored if "ic" is TRUE.
821 */
822 long
823string_count(char_u *haystack, char_u *needle, int ic)
824{
825 long n = 0;
826 char_u *p = haystack;
827 char_u *next;
828
829 if (p == NULL || needle == NULL || *needle == NUL)
830 return 0;
831
832 if (ic)
833 {
834 size_t len = STRLEN(needle);
835
836 while (*p != NUL)
837 {
838 if (MB_STRNICMP(p, needle, len) == 0)
839 {
840 ++n;
841 p += len;
842 }
843 else
844 MB_PTR_ADV(p);
845 }
846 }
847 else
848 while ((next = (char_u *)strstr((char *)p, (char *)needle)) != NULL)
849 {
850 ++n;
851 p = next + STRLEN(needle);
852 }
853
854 return n;
855}
856
857/*
Yegappan Lakshmanan03ff1c22023-05-06 14:08:21 +0100858 * Reverse the string in 'str' and set the result in 'rettv'.
859 */
860 void
861string_reverse(char_u *str, typval_T *rettv)
862{
863 rettv->v_type = VAR_STRING;
864 rettv->vval.v_string = NULL;
865 if (str == NULL)
866 return;
867
868 char_u *rstr = vim_strsave(str);
869 rettv->vval.v_string = rstr;
870 if (rstr == NULL || *str == NUL)
871 return;
872
873 size_t len = STRLEN(rstr);
874 if (has_mbyte)
875 {
876 char_u *src = str;
877 char_u *dest = rstr + len;
878
879 while (src < str + len)
880 {
881 int clen = mb_ptr2len(src);
882 dest -= clen;
883 mch_memmove(dest, src, (size_t)clen);
884 src += clen;
885 }
886 }
887 else
888 {
889 for (size_t i = 0; i < len / 2; i++)
890 {
891 char tmp = rstr[len - i - 1];
892 rstr[len - i - 1] = rstr[i];
893 rstr[i] = tmp;
894 }
895 }
896}
897
898/*
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000899 * Make a typval_T of the first character of "input" and store it in "output".
900 * Return OK or FAIL.
901 */
902 static int
903copy_first_char_to_tv(char_u *input, typval_T *output)
904{
905 char_u buf[MB_MAXBYTES + 1];
906 int len;
907
908 if (input == NULL || output == NULL)
909 return FAIL;
910
911 len = has_mbyte ? mb_ptr2len(input) : 1;
912 STRNCPY(buf, input, len);
913 buf[len] = NUL;
914 output->v_type = VAR_STRING;
915 output->vval.v_string = vim_strsave(buf);
916
917 return output->vval.v_string == NULL ? FAIL : OK;
918}
919
920/*
921 * Implementation of map() and filter() for a String. Apply "expr" to every
922 * character in string "str" and return the result in "rettv".
923 */
924 void
925string_filter_map(
926 char_u *str,
927 filtermap_T filtermap,
928 typval_T *expr,
929 typval_T *rettv)
930{
931 char_u *p;
932 typval_T tv;
933 garray_T ga;
934 int len = 0;
935 int idx = 0;
936 int rem;
Bram Moolenaar82418262022-09-28 16:16:15 +0100937 typval_T newtv;
938 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000939
940 rettv->v_type = VAR_STRING;
941 rettv->vval.v_string = NULL;
942
943 // set_vim_var_nr() doesn't set the type
944 set_vim_var_type(VV_KEY, VAR_NUMBER);
945
zeertzjqe7d49462023-04-16 20:53:55 +0100946 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +0100947 fc = eval_expr_get_funccal(expr, &newtv);
948
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000949 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000950 for (p = str; *p != NUL; p += len)
951 {
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000952 if (copy_first_char_to_tv(p, &tv) == FAIL)
953 break;
954 len = (int)STRLEN(tv.vval.v_string);
955
Bram Moolenaardd7eff02022-05-06 11:02:05 +0100956 newtv.v_type = VAR_UNKNOWN;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000957 set_vim_var_nr(VV_KEY, idx);
Bram Moolenaar82418262022-09-28 16:16:15 +0100958 if (filter_map_one(&tv, expr, filtermap, fc, &newtv, &rem) == FAIL
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000959 || did_emsg)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000960 {
961 clear_tv(&newtv);
962 clear_tv(&tv);
963 break;
964 }
965 else if (filtermap != FILTERMAP_FILTER)
966 {
967 if (newtv.v_type != VAR_STRING)
968 {
969 clear_tv(&newtv);
970 clear_tv(&tv);
Bram Moolenaare70cec92022-01-01 14:25:55 +0000971 emsg(_(e_string_required));
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000972 break;
973 }
974 else
975 ga_concat(&ga, newtv.vval.v_string);
976 }
977 else if (!rem)
978 ga_concat(&ga, tv.vval.v_string);
979
980 clear_tv(&newtv);
981 clear_tv(&tv);
982
983 ++idx;
984 }
985 ga_append(&ga, NUL);
986 rettv->vval.v_string = ga.ga_data;
Bram Moolenaar82418262022-09-28 16:16:15 +0100987 if (fc != NULL)
988 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000989}
990
991/*
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100992 * Implementation of reduce() for String "argvars[0]" using the function "expr"
993 * starting with the optional initial value "argvars[2]" and return the result
994 * in "rettv".
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000995 */
996 void
997string_reduce(
998 typval_T *argvars,
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100999 typval_T *expr,
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001000 typval_T *rettv)
1001{
1002 char_u *p = tv_get_string(&argvars[0]);
1003 int len;
1004 typval_T argv[3];
1005 int r;
1006 int called_emsg_start = called_emsg;
Bram Moolenaar82418262022-09-28 16:16:15 +01001007 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001008
1009 if (argvars[2].v_type == VAR_UNKNOWN)
1010 {
1011 if (*p == NUL)
1012 {
Bram Moolenaare70cec92022-01-01 14:25:55 +00001013 semsg(_(e_reduce_of_an_empty_str_with_no_initial_value), "String");
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001014 return;
1015 }
1016 if (copy_first_char_to_tv(p, rettv) == FAIL)
1017 return;
1018 p += STRLEN(rettv->vval.v_string);
1019 }
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001020 else if (check_for_string_arg(argvars, 2) == FAIL)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001021 return;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001022 else
1023 copy_tv(&argvars[2], rettv);
1024
zeertzjqe7d49462023-04-16 20:53:55 +01001025 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +01001026 fc = eval_expr_get_funccal(expr, rettv);
1027
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001028 for ( ; *p != NUL; p += len)
1029 {
1030 argv[0] = *rettv;
1031 if (copy_first_char_to_tv(p, &argv[1]) == FAIL)
1032 break;
1033 len = (int)STRLEN(argv[1].vval.v_string);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001034
Bram Moolenaar82418262022-09-28 16:16:15 +01001035 r = eval_expr_typval(expr, argv, 2, fc, rettv);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +01001036
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001037 clear_tv(&argv[0]);
1038 clear_tv(&argv[1]);
1039 if (r == FAIL || called_emsg != called_emsg_start)
1040 return;
1041 }
Bram Moolenaar82418262022-09-28 16:16:15 +01001042
1043 if (fc != NULL)
1044 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001045}
1046
Bram Moolenaare4098452023-05-07 18:53:49 +01001047/*
1048 * Implementation of "byteidx()" and "byteidxcomp()" functions
1049 */
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001050 static void
Bram Moolenaare4098452023-05-07 18:53:49 +01001051byteidx_common(typval_T *argvars, typval_T *rettv, int comp UNUSED)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001052{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001053 rettv->vval.v_number = -1;
1054
1055 if (in_vim9script()
1056 && (check_for_string_arg(argvars, 0) == FAIL
1057 || check_for_number_arg(argvars, 1) == FAIL))
1058 return;
1059
Christian Brabandt67672ef2023-04-24 21:09:54 +01001060 char_u *str = tv_get_string_chk(&argvars[0]);
1061 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001062 if (str == NULL || idx < 0)
1063 return;
1064
Christian Brabandt67672ef2023-04-24 21:09:54 +01001065 varnumber_T utf16idx = FALSE;
1066 if (argvars[2].v_type != VAR_UNKNOWN)
1067 {
zeertzjq8cf51372023-05-08 15:31:38 +01001068 int error = FALSE;
1069 utf16idx = tv_get_bool_chk(&argvars[2], &error);
1070 if (error)
1071 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001072 if (utf16idx < 0 || utf16idx > 1)
1073 {
zeertzjq8cf51372023-05-08 15:31:38 +01001074 semsg(_(e_using_number_as_bool_nr), utf16idx);
Christian Brabandt67672ef2023-04-24 21:09:54 +01001075 return;
1076 }
1077 }
1078
1079 int (*ptr2len)(char_u *);
1080 if (enc_utf8 && comp)
1081 ptr2len = utf_ptr2len;
1082 else
1083 ptr2len = mb_ptr2len;
1084
1085 char_u *t = str;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001086 for ( ; idx > 0; idx--)
1087 {
1088 if (*t == NUL) // EOL reached
1089 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001090 if (utf16idx)
1091 {
1092 int clen = ptr2len(t);
1093 int c = (clen > 1) ? utf_ptr2char(t) : *t;
1094 if (c > 0xFFFF)
1095 idx--;
1096 }
1097 if (idx > 0)
1098 t += ptr2len(t);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001099 }
1100 rettv->vval.v_number = (varnumber_T)(t - str);
1101}
1102
1103/*
1104 * "byteidx()" function
1105 */
1106 void
1107f_byteidx(typval_T *argvars, typval_T *rettv)
1108{
Bram Moolenaare4098452023-05-07 18:53:49 +01001109 byteidx_common(argvars, rettv, FALSE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001110}
1111
1112/*
1113 * "byteidxcomp()" function
1114 */
1115 void
1116f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1117{
Bram Moolenaare4098452023-05-07 18:53:49 +01001118 byteidx_common(argvars, rettv, TRUE);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001119}
1120
1121/*
1122 * "charidx()" function
1123 */
1124 void
1125f_charidx(typval_T *argvars, typval_T *rettv)
1126{
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001127 rettv->vval.v_number = -1;
1128
Christian Brabandt67672ef2023-04-24 21:09:54 +01001129 if (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001130 || check_for_number_arg(argvars, 1) == FAIL
Christian Brabandt67672ef2023-04-24 21:09:54 +01001131 || check_for_opt_bool_arg(argvars, 2) == FAIL
1132 || (argvars[2].v_type != VAR_UNKNOWN
1133 && check_for_opt_bool_arg(argvars, 3) == FAIL))
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001134 return;
1135
Christian Brabandt67672ef2023-04-24 21:09:54 +01001136 char_u *str = tv_get_string_chk(&argvars[0]);
1137 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001138 if (str == NULL || idx < 0)
1139 return;
1140
Christian Brabandt67672ef2023-04-24 21:09:54 +01001141 varnumber_T countcc = FALSE;
1142 varnumber_T utf16idx = FALSE;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001143 if (argvars[2].v_type != VAR_UNKNOWN)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001144 {
Christian Brabandt67672ef2023-04-24 21:09:54 +01001145 countcc = tv_get_bool(&argvars[2]);
1146 if (argvars[3].v_type != VAR_UNKNOWN)
1147 utf16idx = tv_get_bool(&argvars[3]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001148 }
1149
Christian Brabandt67672ef2023-04-24 21:09:54 +01001150 int (*ptr2len)(char_u *);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001151 if (enc_utf8 && countcc)
1152 ptr2len = utf_ptr2len;
1153 else
1154 ptr2len = mb_ptr2len;
1155
Christian Brabandt67672ef2023-04-24 21:09:54 +01001156 char_u *p;
1157 int len;
1158 for (p = str, len = 0; utf16idx ? idx >= 0 : p <= str + idx; len++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001159 {
1160 if (*p == NUL)
1161 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001162 if (utf16idx)
1163 {
1164 idx--;
1165 int clen = ptr2len(p);
1166 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1167 if (c > 0xFFFF)
1168 idx--;
1169 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001170 p += ptr2len(p);
1171 }
1172
1173 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1174}
1175
1176/*
1177 * "str2list()" function
1178 */
1179 void
1180f_str2list(typval_T *argvars, typval_T *rettv)
1181{
1182 char_u *p;
1183 int utf8 = FALSE;
1184
1185 if (rettv_list_alloc(rettv) == FAIL)
1186 return;
1187
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001188 if (in_vim9script()
1189 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001190 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001191 return;
1192
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001193 if (argvars[1].v_type != VAR_UNKNOWN)
1194 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1195
1196 p = tv_get_string(&argvars[0]);
1197
1198 if (has_mbyte || utf8)
1199 {
1200 int (*ptr2len)(char_u *);
1201 int (*ptr2char)(char_u *);
1202
1203 if (utf8 || enc_utf8)
1204 {
1205 ptr2len = utf_ptr2len;
1206 ptr2char = utf_ptr2char;
1207 }
1208 else
1209 {
1210 ptr2len = mb_ptr2len;
1211 ptr2char = mb_ptr2char;
1212 }
1213
1214 for ( ; *p != NUL; p += (*ptr2len)(p))
1215 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1216 }
1217 else
1218 for ( ; *p != NUL; ++p)
1219 list_append_number(rettv->vval.v_list, *p);
1220}
1221
1222/*
1223 * "str2nr()" function
1224 */
1225 void
1226f_str2nr(typval_T *argvars, typval_T *rettv)
1227{
1228 int base = 10;
1229 char_u *p;
1230 varnumber_T n;
1231 int what = 0;
1232 int isneg;
1233
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001234 if (in_vim9script()
1235 && (check_for_string_arg(argvars, 0) == FAIL
1236 || check_for_opt_number_arg(argvars, 1) == FAIL
1237 || (argvars[1].v_type != VAR_UNKNOWN
1238 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1239 return;
1240
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001241 if (argvars[1].v_type != VAR_UNKNOWN)
1242 {
1243 base = (int)tv_get_number(&argvars[1]);
1244 if (base != 2 && base != 8 && base != 10 && base != 16)
1245 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001246 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001247 return;
1248 }
1249 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1250 what |= STR2NR_QUOTE;
1251 }
1252
1253 p = skipwhite(tv_get_string_strict(&argvars[0]));
1254 isneg = (*p == '-');
1255 if (*p == '+' || *p == '-')
1256 p = skipwhite(p + 1);
1257 switch (base)
1258 {
1259 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1260 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1261 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1262 }
Bram Moolenaar5fb78c32023-03-04 20:47:39 +00001263 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE, NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001264 // Text after the number is silently ignored.
1265 if (isneg)
1266 rettv->vval.v_number = -n;
1267 else
1268 rettv->vval.v_number = n;
1269
1270}
1271
1272/*
1273 * "strgetchar()" function
1274 */
1275 void
1276f_strgetchar(typval_T *argvars, typval_T *rettv)
1277{
1278 char_u *str;
1279 int len;
1280 int error = FALSE;
1281 int charidx;
1282 int byteidx = 0;
1283
1284 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001285
1286 if (in_vim9script()
1287 && (check_for_string_arg(argvars, 0) == FAIL
1288 || check_for_number_arg(argvars, 1) == FAIL))
1289 return;
1290
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001291 str = tv_get_string_chk(&argvars[0]);
1292 if (str == NULL)
1293 return;
1294 len = (int)STRLEN(str);
1295 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1296 if (error)
1297 return;
1298
1299 while (charidx >= 0 && byteidx < len)
1300 {
1301 if (charidx == 0)
1302 {
1303 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1304 break;
1305 }
1306 --charidx;
1307 byteidx += MB_CPTR2LEN(str + byteidx);
1308 }
1309}
1310
1311/*
1312 * "stridx()" function
1313 */
1314 void
1315f_stridx(typval_T *argvars, typval_T *rettv)
1316{
1317 char_u buf[NUMBUFLEN];
1318 char_u *needle;
1319 char_u *haystack;
1320 char_u *save_haystack;
1321 char_u *pos;
1322 int start_idx;
1323
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001324 if (in_vim9script()
1325 && (check_for_string_arg(argvars, 0) == FAIL
1326 || check_for_string_arg(argvars, 1) == FAIL
1327 || check_for_opt_number_arg(argvars, 2) == FAIL))
1328 return;
1329
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001330 needle = tv_get_string_chk(&argvars[1]);
1331 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1332 rettv->vval.v_number = -1;
1333 if (needle == NULL || haystack == NULL)
1334 return; // type error; errmsg already given
1335
1336 if (argvars[2].v_type != VAR_UNKNOWN)
1337 {
1338 int error = FALSE;
1339
1340 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1341 if (error || start_idx >= (int)STRLEN(haystack))
1342 return;
1343 if (start_idx >= 0)
1344 haystack += start_idx;
1345 }
1346
1347 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1348 if (pos != NULL)
1349 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1350}
1351
1352/*
1353 * "string()" function
1354 */
1355 void
1356f_string(typval_T *argvars, typval_T *rettv)
1357{
1358 char_u *tofree;
1359 char_u numbuf[NUMBUFLEN];
1360
1361 rettv->v_type = VAR_STRING;
1362 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1363 get_copyID());
1364 // Make a copy if we have a value but it's not in allocated memory.
1365 if (rettv->vval.v_string != NULL && tofree == NULL)
1366 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1367}
1368
1369/*
1370 * "strlen()" function
1371 */
1372 void
1373f_strlen(typval_T *argvars, typval_T *rettv)
1374{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001375 if (in_vim9script()
1376 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1377 return;
1378
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001379 rettv->vval.v_number = (varnumber_T)(STRLEN(
1380 tv_get_string(&argvars[0])));
1381}
1382
1383 static void
1384strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1385{
1386 char_u *s = tv_get_string(&argvars[0]);
1387 varnumber_T len = 0;
1388 int (*func_mb_ptr2char_adv)(char_u **pp);
1389
1390 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1391 while (*s != NUL)
1392 {
1393 func_mb_ptr2char_adv(&s);
1394 ++len;
1395 }
1396 rettv->vval.v_number = len;
1397}
1398
1399/*
1400 * "strcharlen()" function
1401 */
1402 void
1403f_strcharlen(typval_T *argvars, typval_T *rettv)
1404{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001405 if (in_vim9script()
1406 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1407 return;
1408
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001409 strchar_common(argvars, rettv, TRUE);
1410}
1411
1412/*
1413 * "strchars()" function
1414 */
1415 void
1416f_strchars(typval_T *argvars, typval_T *rettv)
1417{
1418 varnumber_T skipcc = FALSE;
1419
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001420 if (in_vim9script()
1421 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001422 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001423 return;
1424
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001425 if (argvars[1].v_type != VAR_UNKNOWN)
Bram Moolenaare4098452023-05-07 18:53:49 +01001426 {
zeertzjq8cf51372023-05-08 15:31:38 +01001427 int error = FALSE;
1428 skipcc = tv_get_bool_chk(&argvars[1], &error);
1429 if (error)
1430 return;
1431 if (skipcc < 0 || skipcc > 1)
1432 {
Bram Moolenaare4098452023-05-07 18:53:49 +01001433 semsg(_(e_using_number_as_bool_nr), skipcc);
zeertzjq8cf51372023-05-08 15:31:38 +01001434 return;
1435 }
Bram Moolenaare4098452023-05-07 18:53:49 +01001436 }
zeertzjq8cf51372023-05-08 15:31:38 +01001437
1438 strchar_common(argvars, rettv, skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001439}
1440
1441/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001442 * "strutf16len()" function
1443 */
1444 void
1445f_strutf16len(typval_T *argvars, typval_T *rettv)
1446{
1447 rettv->vval.v_number = -1;
1448
1449 if (check_for_string_arg(argvars, 0) == FAIL
1450 || check_for_opt_bool_arg(argvars, 1) == FAIL)
1451 return;
1452
1453 varnumber_T countcc = FALSE;
1454 if (argvars[1].v_type != VAR_UNKNOWN)
1455 countcc = tv_get_bool(&argvars[1]);
1456
1457 char_u *s = tv_get_string(&argvars[0]);
1458 varnumber_T len = 0;
1459 int (*func_mb_ptr2char_adv)(char_u **pp);
1460 int ch;
1461
1462 func_mb_ptr2char_adv = countcc ? mb_cptr2char_adv : mb_ptr2char_adv;
1463 while (*s != NUL)
1464 {
1465 ch = func_mb_ptr2char_adv(&s);
1466 if (ch > 0xFFFF)
1467 ++len;
1468 ++len;
1469 }
1470 rettv->vval.v_number = len;
1471}
1472
1473/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001474 * "strdisplaywidth()" function
1475 */
1476 void
1477f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1478{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001479 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001480 int col = 0;
1481
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001482 rettv->vval.v_number = -1;
1483
1484 if (in_vim9script()
1485 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001486 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001487 return;
1488
1489 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001490 if (argvars[1].v_type != VAR_UNKNOWN)
1491 col = (int)tv_get_number(&argvars[1]);
1492
1493 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1494}
1495
1496/*
1497 * "strwidth()" function
1498 */
1499 void
1500f_strwidth(typval_T *argvars, typval_T *rettv)
1501{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001502 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001503
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001504 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1505 return;
1506
1507 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001508 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1509}
1510
1511/*
1512 * "strcharpart()" function
1513 */
1514 void
1515f_strcharpart(typval_T *argvars, typval_T *rettv)
1516{
1517 char_u *p;
1518 int nchar;
1519 int nbyte = 0;
1520 int charlen;
1521 int skipcc = FALSE;
1522 int len = 0;
1523 int slen;
1524 int error = FALSE;
1525
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001526 if (in_vim9script()
1527 && (check_for_string_arg(argvars, 0) == FAIL
1528 || check_for_number_arg(argvars, 1) == FAIL
1529 || check_for_opt_number_arg(argvars, 2) == FAIL
1530 || (argvars[2].v_type != VAR_UNKNOWN
1531 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1532 return;
1533
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001534 p = tv_get_string(&argvars[0]);
1535 slen = (int)STRLEN(p);
1536
1537 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1538 if (!error)
1539 {
1540 if (argvars[2].v_type != VAR_UNKNOWN
1541 && argvars[3].v_type != VAR_UNKNOWN)
1542 {
zeertzjq8cf51372023-05-08 15:31:38 +01001543 skipcc = tv_get_bool_chk(&argvars[3], &error);
1544 if (error)
1545 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001546 if (skipcc < 0 || skipcc > 1)
1547 {
zeertzjq8cf51372023-05-08 15:31:38 +01001548 semsg(_(e_using_number_as_bool_nr), skipcc);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001549 return;
1550 }
1551 }
1552
1553 if (nchar > 0)
1554 while (nchar > 0 && nbyte < slen)
1555 {
1556 if (skipcc)
1557 nbyte += mb_ptr2len(p + nbyte);
1558 else
1559 nbyte += MB_CPTR2LEN(p + nbyte);
1560 --nchar;
1561 }
1562 else
1563 nbyte = nchar;
1564 if (argvars[2].v_type != VAR_UNKNOWN)
1565 {
1566 charlen = (int)tv_get_number(&argvars[2]);
1567 while (charlen > 0 && nbyte + len < slen)
1568 {
1569 int off = nbyte + len;
1570
1571 if (off < 0)
1572 len += 1;
1573 else
1574 {
1575 if (skipcc)
1576 len += mb_ptr2len(p + off);
1577 else
1578 len += MB_CPTR2LEN(p + off);
1579 }
1580 --charlen;
1581 }
1582 }
1583 else
1584 len = slen - nbyte; // default: all bytes that are available.
1585 }
1586
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001587 // Only return the overlap between the specified part and the actual
1588 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001589 if (nbyte < 0)
1590 {
1591 len += nbyte;
1592 nbyte = 0;
1593 }
1594 else if (nbyte > slen)
1595 nbyte = slen;
1596 if (len < 0)
1597 len = 0;
1598 else if (nbyte + len > slen)
1599 len = slen - nbyte;
1600
1601 rettv->v_type = VAR_STRING;
1602 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1603}
1604
1605/*
1606 * "strpart()" function
1607 */
1608 void
1609f_strpart(typval_T *argvars, typval_T *rettv)
1610{
1611 char_u *p;
1612 int n;
1613 int len;
1614 int slen;
1615 int error = FALSE;
1616
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001617 if (in_vim9script()
1618 && (check_for_string_arg(argvars, 0) == FAIL
1619 || check_for_number_arg(argvars, 1) == FAIL
1620 || check_for_opt_number_arg(argvars, 2) == FAIL
1621 || (argvars[2].v_type != VAR_UNKNOWN
1622 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1623 return;
1624
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001625 p = tv_get_string(&argvars[0]);
1626 slen = (int)STRLEN(p);
1627
1628 n = (int)tv_get_number_chk(&argvars[1], &error);
1629 if (error)
1630 len = 0;
1631 else if (argvars[2].v_type != VAR_UNKNOWN)
1632 len = (int)tv_get_number(&argvars[2]);
1633 else
1634 len = slen - n; // default len: all bytes that are available.
1635
1636 // Only return the overlap between the specified part and the actual
1637 // string.
1638 if (n < 0)
1639 {
1640 len += n;
1641 n = 0;
1642 }
1643 else if (n > slen)
1644 n = slen;
1645 if (len < 0)
1646 len = 0;
1647 else if (n + len > slen)
1648 len = slen - n;
1649
1650 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1651 {
1652 int off;
1653
1654 // length in characters
1655 for (off = n; off < slen && len > 0; --len)
1656 off += mb_ptr2len(p + off);
1657 len = off - n;
1658 }
1659
1660 rettv->v_type = VAR_STRING;
1661 rettv->vval.v_string = vim_strnsave(p + n, len);
1662}
1663
1664/*
1665 * "strridx()" function
1666 */
1667 void
1668f_strridx(typval_T *argvars, typval_T *rettv)
1669{
1670 char_u buf[NUMBUFLEN];
1671 char_u *needle;
1672 char_u *haystack;
1673 char_u *rest;
1674 char_u *lastmatch = NULL;
1675 int haystack_len, end_idx;
1676
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001677 if (in_vim9script()
1678 && (check_for_string_arg(argvars, 0) == FAIL
1679 || check_for_string_arg(argvars, 1) == FAIL
1680 || check_for_opt_number_arg(argvars, 2) == FAIL))
1681 return;
1682
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001683 needle = tv_get_string_chk(&argvars[1]);
1684 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1685
1686 rettv->vval.v_number = -1;
1687 if (needle == NULL || haystack == NULL)
1688 return; // type error; errmsg already given
1689
1690 haystack_len = (int)STRLEN(haystack);
1691 if (argvars[2].v_type != VAR_UNKNOWN)
1692 {
1693 // Third argument: upper limit for index
1694 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1695 if (end_idx < 0)
1696 return; // can never find a match
1697 }
1698 else
1699 end_idx = haystack_len;
1700
1701 if (*needle == NUL)
1702 {
1703 // Empty string matches past the end.
1704 lastmatch = haystack + end_idx;
1705 }
1706 else
1707 {
1708 for (rest = haystack; *rest != '\0'; ++rest)
1709 {
1710 rest = (char_u *)strstr((char *)rest, (char *)needle);
1711 if (rest == NULL || rest > haystack + end_idx)
1712 break;
1713 lastmatch = rest;
1714 }
1715 }
1716
1717 if (lastmatch == NULL)
1718 rettv->vval.v_number = -1;
1719 else
1720 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1721}
1722
1723/*
1724 * "strtrans()" function
1725 */
1726 void
1727f_strtrans(typval_T *argvars, typval_T *rettv)
1728{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001729 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1730 return;
1731
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001732 rettv->v_type = VAR_STRING;
1733 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1734}
1735
Christian Brabandt67672ef2023-04-24 21:09:54 +01001736
1737/*
1738 *
1739 * "utf16idx()" function
1740 */
1741 void
1742f_utf16idx(typval_T *argvars, typval_T *rettv)
1743{
1744 rettv->vval.v_number = -1;
1745
1746 if (check_for_string_arg(argvars, 0) == FAIL
1747 || check_for_opt_number_arg(argvars, 1) == FAIL
1748 || check_for_opt_bool_arg(argvars, 2) == FAIL
1749 || (argvars[2].v_type != VAR_UNKNOWN
1750 && check_for_opt_bool_arg(argvars, 3) == FAIL))
1751 return;
1752
1753 char_u *str = tv_get_string_chk(&argvars[0]);
1754 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
1755 if (str == NULL || idx < 0)
1756 return;
1757
1758 varnumber_T countcc = FALSE;
1759 varnumber_T charidx = FALSE;
1760 if (argvars[2].v_type != VAR_UNKNOWN)
1761 {
1762 countcc = tv_get_bool(&argvars[2]);
1763 if (argvars[3].v_type != VAR_UNKNOWN)
1764 charidx = tv_get_bool(&argvars[3]);
1765 }
1766
1767 int (*ptr2len)(char_u *);
1768 if (enc_utf8 && countcc)
1769 ptr2len = utf_ptr2len;
1770 else
1771 ptr2len = mb_ptr2len;
1772
1773 char_u *p;
1774 int len;
1775 for (p = str, len = 0; charidx ? idx >= 0 : p <= str + idx; len++)
1776 {
1777 if (*p == NUL)
1778 return;
1779 int clen = ptr2len(p);
1780 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1781 if (c > 0xFFFF)
1782 len++;
1783 p += ptr2len(p);
1784 if (charidx)
1785 idx--;
1786 }
1787
1788 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1789}
1790
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001791/*
1792 * "tolower(string)" function
1793 */
1794 void
1795f_tolower(typval_T *argvars, typval_T *rettv)
1796{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001797 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1798 return;
1799
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001800 rettv->v_type = VAR_STRING;
1801 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1802}
1803
1804/*
1805 * "toupper(string)" function
1806 */
1807 void
1808f_toupper(typval_T *argvars, typval_T *rettv)
1809{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001810 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1811 return;
1812
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001813 rettv->v_type = VAR_STRING;
1814 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1815}
1816
1817/*
1818 * "tr(string, fromstr, tostr)" function
1819 */
1820 void
1821f_tr(typval_T *argvars, typval_T *rettv)
1822{
1823 char_u *in_str;
1824 char_u *fromstr;
1825 char_u *tostr;
1826 char_u *p;
1827 int inlen;
1828 int fromlen;
1829 int tolen;
1830 int idx;
1831 char_u *cpstr;
1832 int cplen;
1833 int first = TRUE;
1834 char_u buf[NUMBUFLEN];
1835 char_u buf2[NUMBUFLEN];
1836 garray_T ga;
1837
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001838 if (in_vim9script()
1839 && (check_for_string_arg(argvars, 0) == FAIL
1840 || check_for_string_arg(argvars, 1) == FAIL
1841 || check_for_string_arg(argvars, 2) == FAIL))
1842 return;
1843
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001844 in_str = tv_get_string(&argvars[0]);
1845 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1846 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1847
1848 // Default return value: empty string.
1849 rettv->v_type = VAR_STRING;
1850 rettv->vval.v_string = NULL;
1851 if (fromstr == NULL || tostr == NULL)
1852 return; // type error; errmsg already given
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001853 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001854
1855 if (!has_mbyte)
1856 // not multi-byte: fromstr and tostr must be the same length
1857 if (STRLEN(fromstr) != STRLEN(tostr))
1858 {
1859error:
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001860 semsg(_(e_invalid_argument_str), fromstr);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001861 ga_clear(&ga);
1862 return;
1863 }
1864
1865 // fromstr and tostr have to contain the same number of chars
1866 while (*in_str != NUL)
1867 {
1868 if (has_mbyte)
1869 {
1870 inlen = (*mb_ptr2len)(in_str);
1871 cpstr = in_str;
1872 cplen = inlen;
1873 idx = 0;
1874 for (p = fromstr; *p != NUL; p += fromlen)
1875 {
1876 fromlen = (*mb_ptr2len)(p);
1877 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1878 {
1879 for (p = tostr; *p != NUL; p += tolen)
1880 {
1881 tolen = (*mb_ptr2len)(p);
1882 if (idx-- == 0)
1883 {
1884 cplen = tolen;
1885 cpstr = p;
1886 break;
1887 }
1888 }
1889 if (*p == NUL) // tostr is shorter than fromstr
1890 goto error;
1891 break;
1892 }
1893 ++idx;
1894 }
1895
1896 if (first && cpstr == in_str)
1897 {
1898 // Check that fromstr and tostr have the same number of
1899 // (multi-byte) characters. Done only once when a character
1900 // of in_str doesn't appear in fromstr.
1901 first = FALSE;
1902 for (p = tostr; *p != NUL; p += tolen)
1903 {
1904 tolen = (*mb_ptr2len)(p);
1905 --idx;
1906 }
1907 if (idx != 0)
1908 goto error;
1909 }
1910
1911 (void)ga_grow(&ga, cplen);
1912 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1913 ga.ga_len += cplen;
1914
1915 in_str += inlen;
1916 }
1917 else
1918 {
1919 // When not using multi-byte chars we can do it faster.
1920 p = vim_strchr(fromstr, *in_str);
1921 if (p != NULL)
1922 ga_append(&ga, tostr[p - fromstr]);
1923 else
1924 ga_append(&ga, *in_str);
1925 ++in_str;
1926 }
1927 }
1928
1929 // add a terminating NUL
1930 (void)ga_grow(&ga, 1);
1931 ga_append(&ga, NUL);
1932
1933 rettv->vval.v_string = ga.ga_data;
1934}
1935
1936/*
1937 * "trim({expr})" function
1938 */
1939 void
1940f_trim(typval_T *argvars, typval_T *rettv)
1941{
1942 char_u buf1[NUMBUFLEN];
1943 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001944 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001945 char_u *mask = NULL;
1946 char_u *tail;
1947 char_u *prev;
1948 char_u *p;
1949 int c1;
1950 int dir = 0;
1951
1952 rettv->v_type = VAR_STRING;
1953 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001954
1955 if (in_vim9script()
1956 && (check_for_string_arg(argvars, 0) == FAIL
1957 || check_for_opt_string_arg(argvars, 1) == FAIL
1958 || (argvars[1].v_type != VAR_UNKNOWN
1959 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1960 return;
1961
1962 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001963 if (head == NULL)
1964 return;
1965
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001966 if (check_for_opt_string_arg(argvars, 1) == FAIL)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001967 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001968
1969 if (argvars[1].v_type == VAR_STRING)
1970 {
1971 mask = tv_get_string_buf_chk(&argvars[1], buf2);
1972
1973 if (argvars[2].v_type != VAR_UNKNOWN)
1974 {
1975 int error = 0;
1976
1977 // leading or trailing characters to trim
1978 dir = (int)tv_get_number_chk(&argvars[2], &error);
1979 if (error)
1980 return;
1981 if (dir < 0 || dir > 2)
1982 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001983 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[2]));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001984 return;
1985 }
1986 }
1987 }
1988
1989 if (dir == 0 || dir == 1)
1990 {
1991 // Trim leading characters
1992 while (*head != NUL)
1993 {
1994 c1 = PTR2CHAR(head);
1995 if (mask == NULL)
1996 {
1997 if (c1 > ' ' && c1 != 0xa0)
1998 break;
1999 }
2000 else
2001 {
2002 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2003 if (c1 == PTR2CHAR(p))
2004 break;
2005 if (*p == NUL)
2006 break;
2007 }
2008 MB_PTR_ADV(head);
2009 }
2010 }
2011
2012 tail = head + STRLEN(head);
2013 if (dir == 0 || dir == 2)
2014 {
2015 // Trim trailing characters
2016 for (; tail > head; tail = prev)
2017 {
2018 prev = tail;
2019 MB_PTR_BACK(head, prev);
2020 c1 = PTR2CHAR(prev);
2021 if (mask == NULL)
2022 {
2023 if (c1 > ' ' && c1 != 0xa0)
2024 break;
2025 }
2026 else
2027 {
2028 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2029 if (c1 == PTR2CHAR(p))
2030 break;
2031 if (*p == NUL)
2032 break;
2033 }
2034 }
2035 }
2036 rettv->vval.v_string = vim_strnsave(head, tail - head);
2037}
2038
Bram Moolenaar677658a2022-01-05 16:09:06 +00002039static char *e_printf = N_(e_insufficient_arguments_for_printf);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002040
2041/*
2042 * Get number argument from "idxp" entry in "tvs". First entry is 1.
2043 */
2044 static varnumber_T
2045tv_nr(typval_T *tvs, int *idxp)
2046{
2047 int idx = *idxp - 1;
2048 varnumber_T n = 0;
2049 int err = FALSE;
2050
2051 if (tvs[idx].v_type == VAR_UNKNOWN)
2052 emsg(_(e_printf));
2053 else
2054 {
2055 ++*idxp;
2056 n = tv_get_number_chk(&tvs[idx], &err);
2057 if (err)
2058 n = 0;
2059 }
2060 return n;
2061}
2062
2063/*
2064 * Get string argument from "idxp" entry in "tvs". First entry is 1.
2065 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
2066 * are not converted to a string.
2067 * If "tofree" is not NULL echo_string() is used. All types are converted to
2068 * a string with the same format as ":echo". The caller must free "*tofree".
2069 * Returns NULL for an error.
2070 */
2071 static char *
2072tv_str(typval_T *tvs, int *idxp, char_u **tofree)
2073{
2074 int idx = *idxp - 1;
2075 char *s = NULL;
2076 static char_u numbuf[NUMBUFLEN];
2077
2078 if (tvs[idx].v_type == VAR_UNKNOWN)
2079 emsg(_(e_printf));
2080 else
2081 {
2082 ++*idxp;
2083 if (tofree != NULL)
2084 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
2085 else
2086 s = (char *)tv_get_string_chk(&tvs[idx]);
2087 }
2088 return s;
2089}
2090
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002091/*
2092 * Get float argument from "idxp" entry in "tvs". First entry is 1.
2093 */
2094 static double
2095tv_float(typval_T *tvs, int *idxp)
2096{
2097 int idx = *idxp - 1;
2098 double f = 0;
2099
2100 if (tvs[idx].v_type == VAR_UNKNOWN)
2101 emsg(_(e_printf));
2102 else
2103 {
2104 ++*idxp;
2105 if (tvs[idx].v_type == VAR_FLOAT)
2106 f = tvs[idx].vval.v_float;
2107 else if (tvs[idx].v_type == VAR_NUMBER)
2108 f = (double)tvs[idx].vval.v_number;
2109 else
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00002110 emsg(_(e_expected_float_argument_for_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002111 }
2112 return f;
2113}
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00002114
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002115#endif
2116
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002117/*
2118 * Return the representation of infinity for printf() function:
2119 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
2120 */
2121 static const char *
2122infinity_str(int positive,
2123 char fmt_spec,
2124 int force_sign,
2125 int space_for_positive)
2126{
2127 static const char *table[] =
2128 {
2129 "-inf", "inf", "+inf", " inf",
2130 "-INF", "INF", "+INF", " INF"
2131 };
2132 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
2133
2134 if (ASCII_ISUPPER(fmt_spec))
2135 idx += 4;
2136 return table[idx];
2137}
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002138
2139/*
2140 * This code was included to provide a portable vsnprintf() and snprintf().
2141 * Some systems may provide their own, but we always use this one for
2142 * consistency.
2143 *
2144 * This code is based on snprintf.c - a portable implementation of snprintf
2145 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
2146 * Included with permission. It was heavily modified to fit in Vim.
2147 * The original code, including useful comments, can be found here:
2148 * http://www.ijs.si/software/snprintf/
2149 *
2150 * This snprintf() only supports the following conversion specifiers:
2151 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
2152 * with flags: '-', '+', ' ', '0' and '#'.
2153 * An asterisk is supported for field width as well as precision.
2154 *
2155 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
2156 *
2157 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
2158 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
2159 *
2160 * The locale is not used, the string is used as a byte string. This is only
2161 * relevant for double-byte encodings where the second byte may be '%'.
2162 *
2163 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
2164 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
2165 *
2166 * The return value is the number of characters which would be generated
2167 * for the given input, excluding the trailing NUL. If this value
2168 * is greater or equal to "str_m", not all characters from the result
2169 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
2170 * are discarded. If "str_m" is greater than zero it is guaranteed
2171 * the resulting string will be NUL-terminated.
2172 */
2173
2174/*
2175 * When va_list is not supported we only define vim_snprintf().
2176 *
2177 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2178 * "typval_T". When the latter is not used it must be NULL.
2179 */
2180
2181// When generating prototypes all of this is skipped, cproto doesn't
2182// understand this.
2183#ifndef PROTO
2184
2185// Like vim_vsnprintf() but append to the string.
2186 int
2187vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2188{
2189 va_list ap;
2190 int str_l;
2191 size_t len = STRLEN(str);
2192 size_t space;
2193
2194 if (str_m <= len)
2195 space = 0;
2196 else
2197 space = str_m - len;
2198 va_start(ap, fmt);
2199 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2200 va_end(ap);
2201 return str_l;
2202}
2203
2204 int
2205vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2206{
2207 va_list ap;
2208 int str_l;
2209
2210 va_start(ap, fmt);
2211 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2212 va_end(ap);
2213 return str_l;
2214}
2215
2216 int
2217vim_vsnprintf(
2218 char *str,
2219 size_t str_m,
2220 const char *fmt,
2221 va_list ap)
2222{
2223 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2224}
2225
2226 int
2227vim_vsnprintf_typval(
2228 char *str,
2229 size_t str_m,
2230 const char *fmt,
2231 va_list ap,
2232 typval_T *tvs)
2233{
2234 size_t str_l = 0;
2235 const char *p = fmt;
2236 int arg_idx = 1;
2237
2238 if (p == NULL)
2239 p = "";
2240 while (*p != NUL)
2241 {
2242 if (*p != '%')
2243 {
2244 char *q = strchr(p + 1, '%');
2245 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2246
2247 // Copy up to the next '%' or NUL without any changes.
2248 if (str_l < str_m)
2249 {
2250 size_t avail = str_m - str_l;
2251
2252 mch_memmove(str + str_l, p, n > avail ? avail : n);
2253 }
2254 p += n;
2255 str_l += n;
2256 }
2257 else
2258 {
2259 size_t min_field_width = 0, precision = 0;
2260 int zero_padding = 0, precision_specified = 0, justify_left = 0;
2261 int alternate_form = 0, force_sign = 0;
2262
2263 // If both the ' ' and '+' flags appear, the ' ' flag should be
2264 // ignored.
2265 int space_for_positive = 1;
2266
2267 // allowed values: \0, h, l, L
2268 char length_modifier = '\0';
2269
2270 // temporary buffer for simple numeric->string conversion
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002271# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002272 // That sounds reasonable to use as the maximum
2273 // printable.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002274 char tmp[TMP_LEN];
2275
2276 // string address in case of string argument
2277 const char *str_arg = NULL;
2278
2279 // natural field width of arg without padding and sign
2280 size_t str_arg_l;
2281
2282 // unsigned char argument value - only defined for c conversion.
2283 // N.B. standard explicitly states the char argument for the c
2284 // conversion is unsigned
2285 unsigned char uchar_arg;
2286
2287 // number of zeros to be inserted for numeric conversions as
2288 // required by the precision or minimal field width
2289 size_t number_of_zeros_to_pad = 0;
2290
2291 // index into tmp where zero padding is to be inserted
2292 size_t zero_padding_insertion_ind = 0;
2293
2294 // current conversion specifier character
2295 char fmt_spec = '\0';
2296
2297 // buffer for 's' and 'S' specs
2298 char_u *tofree = NULL;
2299
2300
2301 p++; // skip '%'
2302
2303 // parse flags
2304 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2305 || *p == '#' || *p == '\'')
2306 {
2307 switch (*p)
2308 {
2309 case '0': zero_padding = 1; break;
2310 case '-': justify_left = 1; break;
2311 case '+': force_sign = 1; space_for_positive = 0; break;
2312 case ' ': force_sign = 1;
2313 // If both the ' ' and '+' flags appear, the ' '
2314 // flag should be ignored
2315 break;
2316 case '#': alternate_form = 1; break;
2317 case '\'': break;
2318 }
2319 p++;
2320 }
2321 // If the '0' and '-' flags both appear, the '0' flag should be
2322 // ignored.
2323
2324 // parse field width
2325 if (*p == '*')
2326 {
2327 int j;
2328
2329 p++;
2330 j =
2331# if defined(FEAT_EVAL)
2332 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2333# endif
2334 va_arg(ap, int);
2335 if (j >= 0)
2336 min_field_width = j;
2337 else
2338 {
2339 min_field_width = -j;
2340 justify_left = 1;
2341 }
2342 }
2343 else if (VIM_ISDIGIT((int)(*p)))
2344 {
2345 // size_t could be wider than unsigned int; make sure we treat
2346 // argument like common implementations do
2347 unsigned int uj = *p++ - '0';
2348
2349 while (VIM_ISDIGIT((int)(*p)))
2350 uj = 10 * uj + (unsigned int)(*p++ - '0');
2351 min_field_width = uj;
2352 }
2353
2354 // parse precision
2355 if (*p == '.')
2356 {
2357 p++;
2358 precision_specified = 1;
2359 if (*p == '*')
2360 {
2361 int j;
2362
2363 j =
2364# if defined(FEAT_EVAL)
2365 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2366# endif
2367 va_arg(ap, int);
2368 p++;
2369 if (j >= 0)
2370 precision = j;
2371 else
2372 {
2373 precision_specified = 0;
2374 precision = 0;
2375 }
2376 }
2377 else if (VIM_ISDIGIT((int)(*p)))
2378 {
2379 // size_t could be wider than unsigned int; make sure we
2380 // treat argument like common implementations do
2381 unsigned int uj = *p++ - '0';
2382
2383 while (VIM_ISDIGIT((int)(*p)))
2384 uj = 10 * uj + (unsigned int)(*p++ - '0');
2385 precision = uj;
2386 }
2387 }
2388
2389 // parse 'h', 'l' and 'll' length modifiers
2390 if (*p == 'h' || *p == 'l')
2391 {
2392 length_modifier = *p;
2393 p++;
2394 if (length_modifier == 'l' && *p == 'l')
2395 {
2396 // double l = __int64 / varnumber_T
2397 length_modifier = 'L';
2398 p++;
2399 }
2400 }
2401 fmt_spec = *p;
2402
2403 // common synonyms:
2404 switch (fmt_spec)
2405 {
2406 case 'i': fmt_spec = 'd'; break;
2407 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2408 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2409 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2410 default: break;
2411 }
2412
2413# if defined(FEAT_EVAL)
2414 switch (fmt_spec)
2415 {
2416 case 'd': case 'u': case 'o': case 'x': case 'X':
2417 if (tvs != NULL && length_modifier == '\0')
2418 length_modifier = 'L';
2419 }
2420# endif
2421
2422 // get parameter value, do initial processing
2423 switch (fmt_spec)
2424 {
2425 // '%' and 'c' behave similar to 's' regarding flags and field
2426 // widths
2427 case '%':
2428 case 'c':
2429 case 's':
2430 case 'S':
2431 str_arg_l = 1;
2432 switch (fmt_spec)
2433 {
2434 case '%':
2435 str_arg = p;
2436 break;
2437
2438 case 'c':
2439 {
2440 int j;
2441
2442 j =
2443# if defined(FEAT_EVAL)
2444 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2445# endif
2446 va_arg(ap, int);
2447 // standard demands unsigned char
2448 uchar_arg = (unsigned char)j;
2449 str_arg = (char *)&uchar_arg;
2450 break;
2451 }
2452
2453 case 's':
2454 case 'S':
2455 str_arg =
2456# if defined(FEAT_EVAL)
2457 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
2458# endif
2459 va_arg(ap, char *);
2460 if (str_arg == NULL)
2461 {
2462 str_arg = "[NULL]";
2463 str_arg_l = 6;
2464 }
2465 // make sure not to address string beyond the specified
2466 // precision !!!
2467 else if (!precision_specified)
2468 str_arg_l = strlen(str_arg);
2469 // truncate string if necessary as requested by precision
2470 else if (precision == 0)
2471 str_arg_l = 0;
2472 else
2473 {
2474 // Don't put the #if inside memchr(), it can be a
2475 // macro.
2476 // memchr on HP does not like n > 2^31 !!!
2477 char *q = memchr(str_arg, '\0',
2478 precision <= (size_t)0x7fffffffL ? precision
2479 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00002480
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002481 str_arg_l = (q == NULL) ? precision
2482 : (size_t)(q - str_arg);
2483 }
2484 if (fmt_spec == 'S')
2485 {
presuku1f2453f2021-11-24 15:32:57 +00002486 char_u *p1;
2487 size_t i;
2488 int cell;
presukud85fccd2021-11-20 19:38:31 +00002489
presuku1f2453f2021-11-24 15:32:57 +00002490 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002491 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00002492 {
2493 cell = mb_ptr2cells(p1);
2494 if (precision_specified && i + cell > precision)
2495 break;
2496 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002497 }
presuku1f2453f2021-11-24 15:32:57 +00002498
2499 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00002500 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00002501 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002502 }
2503 break;
2504
2505 default:
2506 break;
2507 }
2508 break;
2509
2510 case 'd': case 'u':
2511 case 'b': case 'B':
2512 case 'o':
2513 case 'x': case 'X':
2514 case 'p':
2515 {
2516 // NOTE: the u, b, o, x, X and p conversion specifiers
2517 // imply the value is unsigned; d implies a signed
2518 // value
2519
2520 // 0 if numeric argument is zero (or if pointer is
2521 // NULL for 'p'), +1 if greater than zero (or nonzero
2522 // for unsigned arguments), -1 if negative (unsigned
2523 // argument is never negative)
2524 int arg_sign = 0;
2525
2526 // only set for length modifier h, or for no length
2527 // modifiers
2528 int int_arg = 0;
2529 unsigned int uint_arg = 0;
2530
2531 // only set for length modifier l
2532 long int long_arg = 0;
2533 unsigned long int ulong_arg = 0;
2534
2535 // only set for length modifier ll
2536 varnumber_T llong_arg = 0;
2537 uvarnumber_T ullong_arg = 0;
2538
2539 // only set for b conversion
2540 uvarnumber_T bin_arg = 0;
2541
2542 // pointer argument value -only defined for p
2543 // conversion
2544 void *ptr_arg = NULL;
2545
2546 if (fmt_spec == 'p')
2547 {
2548 length_modifier = '\0';
2549 ptr_arg =
2550# if defined(FEAT_EVAL)
2551 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
2552 NULL) :
2553# endif
2554 va_arg(ap, void *);
2555 if (ptr_arg != NULL)
2556 arg_sign = 1;
2557 }
2558 else if (fmt_spec == 'b' || fmt_spec == 'B')
2559 {
2560 bin_arg =
2561# if defined(FEAT_EVAL)
2562 tvs != NULL ?
2563 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
2564# endif
2565 va_arg(ap, uvarnumber_T);
2566 if (bin_arg != 0)
2567 arg_sign = 1;
2568 }
2569 else if (fmt_spec == 'd')
2570 {
2571 // signed
2572 switch (length_modifier)
2573 {
2574 case '\0':
2575 case 'h':
2576 // char and short arguments are passed as int.
2577 int_arg =
2578# if defined(FEAT_EVAL)
2579 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2580# endif
2581 va_arg(ap, int);
2582 if (int_arg > 0)
2583 arg_sign = 1;
2584 else if (int_arg < 0)
2585 arg_sign = -1;
2586 break;
2587 case 'l':
2588 long_arg =
2589# if defined(FEAT_EVAL)
2590 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2591# endif
2592 va_arg(ap, long int);
2593 if (long_arg > 0)
2594 arg_sign = 1;
2595 else if (long_arg < 0)
2596 arg_sign = -1;
2597 break;
2598 case 'L':
2599 llong_arg =
2600# if defined(FEAT_EVAL)
2601 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2602# endif
2603 va_arg(ap, varnumber_T);
2604 if (llong_arg > 0)
2605 arg_sign = 1;
2606 else if (llong_arg < 0)
2607 arg_sign = -1;
2608 break;
2609 }
2610 }
2611 else
2612 {
2613 // unsigned
2614 switch (length_modifier)
2615 {
2616 case '\0':
2617 case 'h':
2618 uint_arg =
2619# if defined(FEAT_EVAL)
2620 tvs != NULL ? (unsigned)
2621 tv_nr(tvs, &arg_idx) :
2622# endif
2623 va_arg(ap, unsigned int);
2624 if (uint_arg != 0)
2625 arg_sign = 1;
2626 break;
2627 case 'l':
2628 ulong_arg =
2629# if defined(FEAT_EVAL)
2630 tvs != NULL ? (unsigned long)
2631 tv_nr(tvs, &arg_idx) :
2632# endif
2633 va_arg(ap, unsigned long int);
2634 if (ulong_arg != 0)
2635 arg_sign = 1;
2636 break;
2637 case 'L':
2638 ullong_arg =
2639# if defined(FEAT_EVAL)
2640 tvs != NULL ? (uvarnumber_T)
2641 tv_nr(tvs, &arg_idx) :
2642# endif
2643 va_arg(ap, uvarnumber_T);
2644 if (ullong_arg != 0)
2645 arg_sign = 1;
2646 break;
2647 }
2648 }
2649
2650 str_arg = tmp;
2651 str_arg_l = 0;
2652
2653 // NOTE:
2654 // For d, i, u, o, x, and X conversions, if precision is
2655 // specified, the '0' flag should be ignored. This is so
2656 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
2657 // FreeBSD, NetBSD; but not with Perl.
2658 if (precision_specified)
2659 zero_padding = 0;
2660 if (fmt_spec == 'd')
2661 {
2662 if (force_sign && arg_sign >= 0)
2663 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
2664 // leave negative numbers for sprintf to handle, to
2665 // avoid handling tricky cases like (short int)-32768
2666 }
2667 else if (alternate_form)
2668 {
2669 if (arg_sign != 0
2670 && (fmt_spec == 'b' || fmt_spec == 'B'
2671 || fmt_spec == 'x' || fmt_spec == 'X') )
2672 {
2673 tmp[str_arg_l++] = '0';
2674 tmp[str_arg_l++] = fmt_spec;
2675 }
2676 // alternate form should have no effect for p
2677 // conversion, but ...
2678 }
2679
2680 zero_padding_insertion_ind = str_arg_l;
2681 if (!precision_specified)
2682 precision = 1; // default precision is 1
2683 if (precision == 0 && arg_sign == 0)
2684 {
2685 // When zero value is formatted with an explicit
2686 // precision 0, the resulting formatted string is
2687 // empty (d, i, u, b, B, o, x, X, p).
2688 }
2689 else
2690 {
2691 char f[6];
2692 int f_l = 0;
2693
2694 // construct a simple format string for sprintf
2695 f[f_l++] = '%';
2696 if (!length_modifier)
2697 ;
2698 else if (length_modifier == 'L')
2699 {
2700# ifdef MSWIN
2701 f[f_l++] = 'I';
2702 f[f_l++] = '6';
2703 f[f_l++] = '4';
2704# else
2705 f[f_l++] = 'l';
2706 f[f_l++] = 'l';
2707# endif
2708 }
2709 else
2710 f[f_l++] = length_modifier;
2711 f[f_l++] = fmt_spec;
2712 f[f_l++] = '\0';
2713
2714 if (fmt_spec == 'p')
2715 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
2716 else if (fmt_spec == 'b' || fmt_spec == 'B')
2717 {
2718 char b[8 * sizeof(uvarnumber_T)];
2719 size_t b_l = 0;
2720 uvarnumber_T bn = bin_arg;
2721
2722 do
2723 {
2724 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
2725 bn >>= 1;
2726 }
2727 while (bn != 0);
2728
2729 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
2730 str_arg_l += b_l;
2731 }
2732 else if (fmt_spec == 'd')
2733 {
2734 // signed
2735 switch (length_modifier)
2736 {
2737 case '\0': str_arg_l += sprintf(
2738 tmp + str_arg_l, f,
2739 int_arg);
2740 break;
2741 case 'h': str_arg_l += sprintf(
2742 tmp + str_arg_l, f,
2743 (short)int_arg);
2744 break;
2745 case 'l': str_arg_l += sprintf(
2746 tmp + str_arg_l, f, long_arg);
2747 break;
2748 case 'L': str_arg_l += sprintf(
2749 tmp + str_arg_l, f, llong_arg);
2750 break;
2751 }
2752 }
2753 else
2754 {
2755 // unsigned
2756 switch (length_modifier)
2757 {
2758 case '\0': str_arg_l += sprintf(
2759 tmp + str_arg_l, f,
2760 uint_arg);
2761 break;
2762 case 'h': str_arg_l += sprintf(
2763 tmp + str_arg_l, f,
2764 (unsigned short)uint_arg);
2765 break;
2766 case 'l': str_arg_l += sprintf(
2767 tmp + str_arg_l, f, ulong_arg);
2768 break;
2769 case 'L': str_arg_l += sprintf(
2770 tmp + str_arg_l, f, ullong_arg);
2771 break;
2772 }
2773 }
2774
2775 // include the optional minus sign and possible
2776 // "0x" in the region before the zero padding
2777 // insertion point
2778 if (zero_padding_insertion_ind < str_arg_l
2779 && tmp[zero_padding_insertion_ind] == '-')
2780 zero_padding_insertion_ind++;
2781 if (zero_padding_insertion_ind + 1 < str_arg_l
2782 && tmp[zero_padding_insertion_ind] == '0'
2783 && (tmp[zero_padding_insertion_ind + 1] == 'x'
2784 || tmp[zero_padding_insertion_ind + 1] == 'X'))
2785 zero_padding_insertion_ind += 2;
2786 }
2787
2788 {
2789 size_t num_of_digits = str_arg_l
2790 - zero_padding_insertion_ind;
2791
2792 if (alternate_form && fmt_spec == 'o'
2793 // unless zero is already the first
2794 // character
2795 && !(zero_padding_insertion_ind < str_arg_l
2796 && tmp[zero_padding_insertion_ind] == '0'))
2797 {
2798 // assure leading zero for alternate-form
2799 // octal numbers
2800 if (!precision_specified
2801 || precision < num_of_digits + 1)
2802 {
2803 // precision is increased to force the
2804 // first character to be zero, except if a
2805 // zero value is formatted with an
2806 // explicit precision of zero
2807 precision = num_of_digits + 1;
2808 }
2809 }
2810 // zero padding to specified precision?
2811 if (num_of_digits < precision)
2812 number_of_zeros_to_pad = precision - num_of_digits;
2813 }
2814 // zero padding to specified minimal field width?
2815 if (!justify_left && zero_padding)
2816 {
2817 int n = (int)(min_field_width - (str_arg_l
2818 + number_of_zeros_to_pad));
2819 if (n > 0)
2820 number_of_zeros_to_pad += n;
2821 }
2822 break;
2823 }
2824
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002825 case 'f':
2826 case 'F':
2827 case 'e':
2828 case 'E':
2829 case 'g':
2830 case 'G':
2831 {
2832 // Floating point.
2833 double f;
2834 double abs_f;
2835 char format[40];
2836 int l;
2837 int remove_trailing_zeroes = FALSE;
2838
2839 f =
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002840# if defined(FEAT_EVAL)
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002841 tvs != NULL ? tv_float(tvs, &arg_idx) :
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002842# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002843 va_arg(ap, double);
2844 abs_f = f < 0 ? -f : f;
2845
2846 if (fmt_spec == 'g' || fmt_spec == 'G')
2847 {
2848 // Would be nice to use %g directly, but it prints
2849 // "1.0" as "1", we don't want that.
2850 if ((abs_f >= 0.001 && abs_f < 10000000.0)
2851 || abs_f == 0.0)
2852 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
2853 else
2854 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
2855 remove_trailing_zeroes = TRUE;
2856 }
2857
2858 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002859# ifdef VAX
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002860 abs_f > 1.0e38
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002861# else
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002862 abs_f > 1.0e307
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002863# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002864 )
2865 {
2866 // Avoid a buffer overflow
2867 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2868 force_sign, space_for_positive));
2869 str_arg_l = STRLEN(tmp);
2870 zero_padding = 0;
2871 }
2872 else
2873 {
2874 if (isnan(f))
2875 {
2876 // Not a number: nan or NAN
2877 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
2878 : "nan");
2879 str_arg_l = 3;
2880 zero_padding = 0;
2881 }
2882 else if (isinf(f))
2883 {
2884 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2885 force_sign, space_for_positive));
2886 str_arg_l = STRLEN(tmp);
2887 zero_padding = 0;
2888 }
2889 else
2890 {
2891 // Regular float number
2892 format[0] = '%';
2893 l = 1;
2894 if (force_sign)
2895 format[l++] = space_for_positive ? ' ' : '+';
2896 if (precision_specified)
2897 {
2898 size_t max_prec = TMP_LEN - 10;
2899
2900 // Make sure we don't get more digits than we
2901 // have room for.
2902 if ((fmt_spec == 'f' || fmt_spec == 'F')
2903 && abs_f > 1.0)
2904 max_prec -= (size_t)log10(abs_f);
2905 if (precision > max_prec)
2906 precision = max_prec;
2907 l += sprintf(format + l, ".%d", (int)precision);
2908 }
2909 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
2910 format[l + 1] = NUL;
2911
2912 str_arg_l = sprintf(tmp, format, f);
2913 }
2914
2915 if (remove_trailing_zeroes)
2916 {
2917 int i;
2918 char *tp;
2919
2920 // Using %g or %G: remove superfluous zeroes.
2921 if (fmt_spec == 'f' || fmt_spec == 'F')
2922 tp = tmp + str_arg_l - 1;
2923 else
2924 {
2925 tp = (char *)vim_strchr((char_u *)tmp,
2926 fmt_spec == 'e' ? 'e' : 'E');
2927 if (tp != NULL)
2928 {
2929 // Remove superfluous '+' and leading
2930 // zeroes from the exponent.
2931 if (tp[1] == '+')
2932 {
2933 // Change "1.0e+07" to "1.0e07"
2934 STRMOVE(tp + 1, tp + 2);
2935 --str_arg_l;
2936 }
2937 i = (tp[1] == '-') ? 2 : 1;
2938 while (tp[i] == '0')
2939 {
2940 // Change "1.0e07" to "1.0e7"
2941 STRMOVE(tp + i, tp + i + 1);
2942 --str_arg_l;
2943 }
2944 --tp;
2945 }
2946 }
2947
2948 if (tp != NULL && !precision_specified)
2949 // Remove trailing zeroes, but keep the one
2950 // just after a dot.
2951 while (tp > tmp + 2 && *tp == '0'
2952 && tp[-1] != '.')
2953 {
2954 STRMOVE(tp, tp + 1);
2955 --tp;
2956 --str_arg_l;
2957 }
2958 }
2959 else
2960 {
2961 char *tp;
2962
2963 // Be consistent: some printf("%e") use 1.0e+12
2964 // and some 1.0e+012. Remove one zero in the last
2965 // case.
2966 tp = (char *)vim_strchr((char_u *)tmp,
2967 fmt_spec == 'e' ? 'e' : 'E');
2968 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
2969 && tp[2] == '0'
2970 && vim_isdigit(tp[3])
2971 && vim_isdigit(tp[4]))
2972 {
2973 STRMOVE(tp + 2, tp + 3);
2974 --str_arg_l;
2975 }
2976 }
2977 }
2978 if (zero_padding && min_field_width > str_arg_l
2979 && (tmp[0] == '-' || force_sign))
2980 {
2981 // padding 0's should be inserted after the sign
2982 number_of_zeros_to_pad = min_field_width - str_arg_l;
2983 zero_padding_insertion_ind = 1;
2984 }
2985 str_arg = tmp;
2986 break;
2987 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002988
2989 default:
2990 // unrecognized conversion specifier, keep format string
2991 // as-is
2992 zero_padding = 0; // turn zero padding off for non-numeric
2993 // conversion
2994 justify_left = 1;
2995 min_field_width = 0; // reset flags
2996
2997 // discard the unrecognized conversion, just keep *
2998 // the unrecognized conversion character
2999 str_arg = p;
3000 str_arg_l = 0;
3001 if (*p != NUL)
3002 str_arg_l++; // include invalid conversion specifier
3003 // unchanged if not at end-of-string
3004 break;
3005 }
3006
3007 if (*p != NUL)
3008 p++; // step over the just processed conversion specifier
3009
3010 // insert padding to the left as requested by min_field_width;
3011 // this does not include the zero padding in case of numerical
3012 // conversions
3013 if (!justify_left)
3014 {
3015 // left padding with blank or zero
3016 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
3017
3018 if (pn > 0)
3019 {
3020 if (str_l < str_m)
3021 {
3022 size_t avail = str_m - str_l;
3023
3024 vim_memset(str + str_l, zero_padding ? '0' : ' ',
3025 (size_t)pn > avail ? avail
3026 : (size_t)pn);
3027 }
3028 str_l += pn;
3029 }
3030 }
3031
3032 // zero padding as requested by the precision or by the minimal
3033 // field width for numeric conversions required?
3034 if (number_of_zeros_to_pad == 0)
3035 {
3036 // will not copy first part of numeric right now, *
3037 // force it to be copied later in its entirety
3038 zero_padding_insertion_ind = 0;
3039 }
3040 else
3041 {
3042 // insert first part of numerics (sign or '0x') before zero
3043 // padding
3044 int zn = (int)zero_padding_insertion_ind;
3045
3046 if (zn > 0)
3047 {
3048 if (str_l < str_m)
3049 {
3050 size_t avail = str_m - str_l;
3051
3052 mch_memmove(str + str_l, str_arg,
3053 (size_t)zn > avail ? avail
3054 : (size_t)zn);
3055 }
3056 str_l += zn;
3057 }
3058
3059 // insert zero padding as requested by the precision or min
3060 // field width
3061 zn = (int)number_of_zeros_to_pad;
3062 if (zn > 0)
3063 {
3064 if (str_l < str_m)
3065 {
3066 size_t avail = str_m - str_l;
3067
3068 vim_memset(str + str_l, '0',
3069 (size_t)zn > avail ? avail
3070 : (size_t)zn);
3071 }
3072 str_l += zn;
3073 }
3074 }
3075
3076 // insert formatted string
3077 // (or as-is conversion specifier for unknown conversions)
3078 {
3079 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
3080
3081 if (sn > 0)
3082 {
3083 if (str_l < str_m)
3084 {
3085 size_t avail = str_m - str_l;
3086
3087 mch_memmove(str + str_l,
3088 str_arg + zero_padding_insertion_ind,
3089 (size_t)sn > avail ? avail : (size_t)sn);
3090 }
3091 str_l += sn;
3092 }
3093 }
3094
3095 // insert right padding
3096 if (justify_left)
3097 {
3098 // right blank padding to the field width
3099 int pn = (int)(min_field_width
3100 - (str_arg_l + number_of_zeros_to_pad));
3101
3102 if (pn > 0)
3103 {
3104 if (str_l < str_m)
3105 {
3106 size_t avail = str_m - str_l;
3107
3108 vim_memset(str + str_l, ' ',
3109 (size_t)pn > avail ? avail
3110 : (size_t)pn);
3111 }
3112 str_l += pn;
3113 }
3114 }
3115 vim_free(tofree);
3116 }
3117 }
3118
3119 if (str_m > 0)
3120 {
3121 // make sure the string is nul-terminated even at the expense of
3122 // overwriting the last character (shouldn't happen, but just in case)
3123 //
3124 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
3125 }
3126
3127 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar677658a2022-01-05 16:09:06 +00003128 emsg(_(e_too_many_arguments_to_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003129
3130 // Return the number of characters formatted (excluding trailing nul
3131 // character), that is, the number of characters that would have been
3132 // written to the buffer if it were large enough.
3133 return (int)str_l;
3134}
3135
3136#endif // PROTO