blob: 7d4281dcdc9454144673865822ae941e2942c5eb [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/*
858 * Make a typval_T of the first character of "input" and store it in "output".
859 * Return OK or FAIL.
860 */
861 static int
862copy_first_char_to_tv(char_u *input, typval_T *output)
863{
864 char_u buf[MB_MAXBYTES + 1];
865 int len;
866
867 if (input == NULL || output == NULL)
868 return FAIL;
869
870 len = has_mbyte ? mb_ptr2len(input) : 1;
871 STRNCPY(buf, input, len);
872 buf[len] = NUL;
873 output->v_type = VAR_STRING;
874 output->vval.v_string = vim_strsave(buf);
875
876 return output->vval.v_string == NULL ? FAIL : OK;
877}
878
879/*
880 * Implementation of map() and filter() for a String. Apply "expr" to every
881 * character in string "str" and return the result in "rettv".
882 */
883 void
884string_filter_map(
885 char_u *str,
886 filtermap_T filtermap,
887 typval_T *expr,
888 typval_T *rettv)
889{
890 char_u *p;
891 typval_T tv;
892 garray_T ga;
893 int len = 0;
894 int idx = 0;
895 int rem;
Bram Moolenaar82418262022-09-28 16:16:15 +0100896 typval_T newtv;
897 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000898
899 rettv->v_type = VAR_STRING;
900 rettv->vval.v_string = NULL;
901
902 // set_vim_var_nr() doesn't set the type
903 set_vim_var_type(VV_KEY, VAR_NUMBER);
904
zeertzjqe7d49462023-04-16 20:53:55 +0100905 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +0100906 fc = eval_expr_get_funccal(expr, &newtv);
907
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000908 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000909 for (p = str; *p != NUL; p += len)
910 {
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000911 if (copy_first_char_to_tv(p, &tv) == FAIL)
912 break;
913 len = (int)STRLEN(tv.vval.v_string);
914
Bram Moolenaardd7eff02022-05-06 11:02:05 +0100915 newtv.v_type = VAR_UNKNOWN;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000916 set_vim_var_nr(VV_KEY, idx);
Bram Moolenaar82418262022-09-28 16:16:15 +0100917 if (filter_map_one(&tv, expr, filtermap, fc, &newtv, &rem) == FAIL
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000918 || did_emsg)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000919 {
920 clear_tv(&newtv);
921 clear_tv(&tv);
922 break;
923 }
924 else if (filtermap != FILTERMAP_FILTER)
925 {
926 if (newtv.v_type != VAR_STRING)
927 {
928 clear_tv(&newtv);
929 clear_tv(&tv);
Bram Moolenaare70cec92022-01-01 14:25:55 +0000930 emsg(_(e_string_required));
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000931 break;
932 }
933 else
934 ga_concat(&ga, newtv.vval.v_string);
935 }
936 else if (!rem)
937 ga_concat(&ga, tv.vval.v_string);
938
939 clear_tv(&newtv);
940 clear_tv(&tv);
941
942 ++idx;
943 }
944 ga_append(&ga, NUL);
945 rettv->vval.v_string = ga.ga_data;
Bram Moolenaar82418262022-09-28 16:16:15 +0100946 if (fc != NULL)
947 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000948}
949
950/*
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100951 * Implementation of reduce() for String "argvars[0]" using the function "expr"
952 * starting with the optional initial value "argvars[2]" and return the result
953 * in "rettv".
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000954 */
955 void
956string_reduce(
957 typval_T *argvars,
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100958 typval_T *expr,
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000959 typval_T *rettv)
960{
961 char_u *p = tv_get_string(&argvars[0]);
962 int len;
963 typval_T argv[3];
964 int r;
965 int called_emsg_start = called_emsg;
Bram Moolenaar82418262022-09-28 16:16:15 +0100966 funccall_T *fc;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000967
968 if (argvars[2].v_type == VAR_UNKNOWN)
969 {
970 if (*p == NUL)
971 {
Bram Moolenaare70cec92022-01-01 14:25:55 +0000972 semsg(_(e_reduce_of_an_empty_str_with_no_initial_value), "String");
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000973 return;
974 }
975 if (copy_first_char_to_tv(p, rettv) == FAIL)
976 return;
977 p += STRLEN(rettv->vval.v_string);
978 }
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +0100979 else if (check_for_string_arg(argvars, 2) == FAIL)
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000980 return;
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000981 else
982 copy_tv(&argvars[2], rettv);
983
zeertzjqe7d49462023-04-16 20:53:55 +0100984 // Create one funccall_T for all eval_expr_typval() calls.
Bram Moolenaar82418262022-09-28 16:16:15 +0100985 fc = eval_expr_get_funccal(expr, rettv);
986
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000987 for ( ; *p != NUL; p += len)
988 {
989 argv[0] = *rettv;
990 if (copy_first_char_to_tv(p, &argv[1]) == FAIL)
991 break;
992 len = (int)STRLEN(argv[1].vval.v_string);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100993
Bram Moolenaar82418262022-09-28 16:16:15 +0100994 r = eval_expr_typval(expr, argv, 2, fc, rettv);
Bram Moolenaarf1c60d42022-09-22 17:07:00 +0100995
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +0000996 clear_tv(&argv[0]);
997 clear_tv(&argv[1]);
998 if (r == FAIL || called_emsg != called_emsg_start)
999 return;
1000 }
Bram Moolenaar82418262022-09-28 16:16:15 +01001001
1002 if (fc != NULL)
1003 remove_funccal();
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00001004}
1005
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001006 static void
1007byteidx(typval_T *argvars, typval_T *rettv, int comp UNUSED)
1008{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001009 rettv->vval.v_number = -1;
1010
1011 if (in_vim9script()
1012 && (check_for_string_arg(argvars, 0) == FAIL
1013 || check_for_number_arg(argvars, 1) == FAIL))
1014 return;
1015
Christian Brabandt67672ef2023-04-24 21:09:54 +01001016 char_u *str = tv_get_string_chk(&argvars[0]);
1017 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001018 if (str == NULL || idx < 0)
1019 return;
1020
Christian Brabandt67672ef2023-04-24 21:09:54 +01001021 varnumber_T utf16idx = FALSE;
1022 if (argvars[2].v_type != VAR_UNKNOWN)
1023 {
1024 utf16idx = tv_get_bool(&argvars[2]);
1025 if (utf16idx < 0 || utf16idx > 1)
1026 {
1027 semsg(_(e_using_number_as_bool_nr), utf16idx);
1028 return;
1029 }
1030 }
1031
1032 int (*ptr2len)(char_u *);
1033 if (enc_utf8 && comp)
1034 ptr2len = utf_ptr2len;
1035 else
1036 ptr2len = mb_ptr2len;
1037
1038 char_u *t = str;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001039 for ( ; idx > 0; idx--)
1040 {
1041 if (*t == NUL) // EOL reached
1042 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001043 if (utf16idx)
1044 {
1045 int clen = ptr2len(t);
1046 int c = (clen > 1) ? utf_ptr2char(t) : *t;
1047 if (c > 0xFFFF)
1048 idx--;
1049 }
1050 if (idx > 0)
1051 t += ptr2len(t);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001052 }
1053 rettv->vval.v_number = (varnumber_T)(t - str);
1054}
1055
1056/*
1057 * "byteidx()" function
1058 */
1059 void
1060f_byteidx(typval_T *argvars, typval_T *rettv)
1061{
1062 byteidx(argvars, rettv, FALSE);
1063}
1064
1065/*
1066 * "byteidxcomp()" function
1067 */
1068 void
1069f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1070{
1071 byteidx(argvars, rettv, TRUE);
1072}
1073
1074/*
1075 * "charidx()" function
1076 */
1077 void
1078f_charidx(typval_T *argvars, typval_T *rettv)
1079{
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001080 rettv->vval.v_number = -1;
1081
Christian Brabandt67672ef2023-04-24 21:09:54 +01001082 if (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001083 || check_for_number_arg(argvars, 1) == FAIL
Christian Brabandt67672ef2023-04-24 21:09:54 +01001084 || check_for_opt_bool_arg(argvars, 2) == FAIL
1085 || (argvars[2].v_type != VAR_UNKNOWN
1086 && check_for_opt_bool_arg(argvars, 3) == FAIL))
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001087 return;
1088
Christian Brabandt67672ef2023-04-24 21:09:54 +01001089 char_u *str = tv_get_string_chk(&argvars[0]);
1090 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001091 if (str == NULL || idx < 0)
1092 return;
1093
Christian Brabandt67672ef2023-04-24 21:09:54 +01001094 varnumber_T countcc = FALSE;
1095 varnumber_T utf16idx = FALSE;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001096 if (argvars[2].v_type != VAR_UNKNOWN)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001097 {
Christian Brabandt67672ef2023-04-24 21:09:54 +01001098 countcc = tv_get_bool(&argvars[2]);
1099 if (argvars[3].v_type != VAR_UNKNOWN)
1100 utf16idx = tv_get_bool(&argvars[3]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001101 }
1102
Christian Brabandt67672ef2023-04-24 21:09:54 +01001103 int (*ptr2len)(char_u *);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001104 if (enc_utf8 && countcc)
1105 ptr2len = utf_ptr2len;
1106 else
1107 ptr2len = mb_ptr2len;
1108
Christian Brabandt67672ef2023-04-24 21:09:54 +01001109 char_u *p;
1110 int len;
1111 for (p = str, len = 0; utf16idx ? idx >= 0 : p <= str + idx; len++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001112 {
1113 if (*p == NUL)
1114 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001115 if (utf16idx)
1116 {
1117 idx--;
1118 int clen = ptr2len(p);
1119 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1120 if (c > 0xFFFF)
1121 idx--;
1122 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001123 p += ptr2len(p);
1124 }
1125
1126 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1127}
1128
1129/*
1130 * "str2list()" function
1131 */
1132 void
1133f_str2list(typval_T *argvars, typval_T *rettv)
1134{
1135 char_u *p;
1136 int utf8 = FALSE;
1137
1138 if (rettv_list_alloc(rettv) == FAIL)
1139 return;
1140
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001141 if (in_vim9script()
1142 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001143 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001144 return;
1145
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001146 if (argvars[1].v_type != VAR_UNKNOWN)
1147 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1148
1149 p = tv_get_string(&argvars[0]);
1150
1151 if (has_mbyte || utf8)
1152 {
1153 int (*ptr2len)(char_u *);
1154 int (*ptr2char)(char_u *);
1155
1156 if (utf8 || enc_utf8)
1157 {
1158 ptr2len = utf_ptr2len;
1159 ptr2char = utf_ptr2char;
1160 }
1161 else
1162 {
1163 ptr2len = mb_ptr2len;
1164 ptr2char = mb_ptr2char;
1165 }
1166
1167 for ( ; *p != NUL; p += (*ptr2len)(p))
1168 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1169 }
1170 else
1171 for ( ; *p != NUL; ++p)
1172 list_append_number(rettv->vval.v_list, *p);
1173}
1174
1175/*
1176 * "str2nr()" function
1177 */
1178 void
1179f_str2nr(typval_T *argvars, typval_T *rettv)
1180{
1181 int base = 10;
1182 char_u *p;
1183 varnumber_T n;
1184 int what = 0;
1185 int isneg;
1186
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001187 if (in_vim9script()
1188 && (check_for_string_arg(argvars, 0) == FAIL
1189 || check_for_opt_number_arg(argvars, 1) == FAIL
1190 || (argvars[1].v_type != VAR_UNKNOWN
1191 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1192 return;
1193
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001194 if (argvars[1].v_type != VAR_UNKNOWN)
1195 {
1196 base = (int)tv_get_number(&argvars[1]);
1197 if (base != 2 && base != 8 && base != 10 && base != 16)
1198 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001199 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001200 return;
1201 }
1202 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1203 what |= STR2NR_QUOTE;
1204 }
1205
1206 p = skipwhite(tv_get_string_strict(&argvars[0]));
1207 isneg = (*p == '-');
1208 if (*p == '+' || *p == '-')
1209 p = skipwhite(p + 1);
1210 switch (base)
1211 {
1212 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1213 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1214 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1215 }
Bram Moolenaar5fb78c32023-03-04 20:47:39 +00001216 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE, NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001217 // Text after the number is silently ignored.
1218 if (isneg)
1219 rettv->vval.v_number = -n;
1220 else
1221 rettv->vval.v_number = n;
1222
1223}
1224
1225/*
1226 * "strgetchar()" function
1227 */
1228 void
1229f_strgetchar(typval_T *argvars, typval_T *rettv)
1230{
1231 char_u *str;
1232 int len;
1233 int error = FALSE;
1234 int charidx;
1235 int byteidx = 0;
1236
1237 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001238
1239 if (in_vim9script()
1240 && (check_for_string_arg(argvars, 0) == FAIL
1241 || check_for_number_arg(argvars, 1) == FAIL))
1242 return;
1243
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001244 str = tv_get_string_chk(&argvars[0]);
1245 if (str == NULL)
1246 return;
1247 len = (int)STRLEN(str);
1248 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1249 if (error)
1250 return;
1251
1252 while (charidx >= 0 && byteidx < len)
1253 {
1254 if (charidx == 0)
1255 {
1256 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1257 break;
1258 }
1259 --charidx;
1260 byteidx += MB_CPTR2LEN(str + byteidx);
1261 }
1262}
1263
1264/*
1265 * "stridx()" function
1266 */
1267 void
1268f_stridx(typval_T *argvars, typval_T *rettv)
1269{
1270 char_u buf[NUMBUFLEN];
1271 char_u *needle;
1272 char_u *haystack;
1273 char_u *save_haystack;
1274 char_u *pos;
1275 int start_idx;
1276
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001277 if (in_vim9script()
1278 && (check_for_string_arg(argvars, 0) == FAIL
1279 || check_for_string_arg(argvars, 1) == FAIL
1280 || check_for_opt_number_arg(argvars, 2) == FAIL))
1281 return;
1282
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001283 needle = tv_get_string_chk(&argvars[1]);
1284 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1285 rettv->vval.v_number = -1;
1286 if (needle == NULL || haystack == NULL)
1287 return; // type error; errmsg already given
1288
1289 if (argvars[2].v_type != VAR_UNKNOWN)
1290 {
1291 int error = FALSE;
1292
1293 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1294 if (error || start_idx >= (int)STRLEN(haystack))
1295 return;
1296 if (start_idx >= 0)
1297 haystack += start_idx;
1298 }
1299
1300 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1301 if (pos != NULL)
1302 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1303}
1304
1305/*
1306 * "string()" function
1307 */
1308 void
1309f_string(typval_T *argvars, typval_T *rettv)
1310{
1311 char_u *tofree;
1312 char_u numbuf[NUMBUFLEN];
1313
1314 rettv->v_type = VAR_STRING;
1315 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1316 get_copyID());
1317 // Make a copy if we have a value but it's not in allocated memory.
1318 if (rettv->vval.v_string != NULL && tofree == NULL)
1319 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1320}
1321
1322/*
1323 * "strlen()" function
1324 */
1325 void
1326f_strlen(typval_T *argvars, typval_T *rettv)
1327{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001328 if (in_vim9script()
1329 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1330 return;
1331
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001332 rettv->vval.v_number = (varnumber_T)(STRLEN(
1333 tv_get_string(&argvars[0])));
1334}
1335
1336 static void
1337strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1338{
1339 char_u *s = tv_get_string(&argvars[0]);
1340 varnumber_T len = 0;
1341 int (*func_mb_ptr2char_adv)(char_u **pp);
1342
1343 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1344 while (*s != NUL)
1345 {
1346 func_mb_ptr2char_adv(&s);
1347 ++len;
1348 }
1349 rettv->vval.v_number = len;
1350}
1351
1352/*
1353 * "strcharlen()" function
1354 */
1355 void
1356f_strcharlen(typval_T *argvars, typval_T *rettv)
1357{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001358 if (in_vim9script()
1359 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1360 return;
1361
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001362 strchar_common(argvars, rettv, TRUE);
1363}
1364
1365/*
1366 * "strchars()" function
1367 */
1368 void
1369f_strchars(typval_T *argvars, typval_T *rettv)
1370{
1371 varnumber_T skipcc = FALSE;
1372
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001373 if (in_vim9script()
1374 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001375 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001376 return;
1377
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001378 if (argvars[1].v_type != VAR_UNKNOWN)
1379 skipcc = tv_get_bool(&argvars[1]);
1380 if (skipcc < 0 || skipcc > 1)
1381 semsg(_(e_using_number_as_bool_nr), skipcc);
1382 else
1383 strchar_common(argvars, rettv, skipcc);
1384}
1385
1386/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001387 * "strutf16len()" function
1388 */
1389 void
1390f_strutf16len(typval_T *argvars, typval_T *rettv)
1391{
1392 rettv->vval.v_number = -1;
1393
1394 if (check_for_string_arg(argvars, 0) == FAIL
1395 || check_for_opt_bool_arg(argvars, 1) == FAIL)
1396 return;
1397
1398 varnumber_T countcc = FALSE;
1399 if (argvars[1].v_type != VAR_UNKNOWN)
1400 countcc = tv_get_bool(&argvars[1]);
1401
1402 char_u *s = tv_get_string(&argvars[0]);
1403 varnumber_T len = 0;
1404 int (*func_mb_ptr2char_adv)(char_u **pp);
1405 int ch;
1406
1407 func_mb_ptr2char_adv = countcc ? mb_cptr2char_adv : mb_ptr2char_adv;
1408 while (*s != NUL)
1409 {
1410 ch = func_mb_ptr2char_adv(&s);
1411 if (ch > 0xFFFF)
1412 ++len;
1413 ++len;
1414 }
1415 rettv->vval.v_number = len;
1416}
1417
1418/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001419 * "strdisplaywidth()" function
1420 */
1421 void
1422f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1423{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001424 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001425 int col = 0;
1426
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001427 rettv->vval.v_number = -1;
1428
1429 if (in_vim9script()
1430 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001431 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001432 return;
1433
1434 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001435 if (argvars[1].v_type != VAR_UNKNOWN)
1436 col = (int)tv_get_number(&argvars[1]);
1437
1438 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1439}
1440
1441/*
1442 * "strwidth()" function
1443 */
1444 void
1445f_strwidth(typval_T *argvars, typval_T *rettv)
1446{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001447 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001448
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001449 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1450 return;
1451
1452 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001453 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1454}
1455
1456/*
1457 * "strcharpart()" function
1458 */
1459 void
1460f_strcharpart(typval_T *argvars, typval_T *rettv)
1461{
1462 char_u *p;
1463 int nchar;
1464 int nbyte = 0;
1465 int charlen;
1466 int skipcc = FALSE;
1467 int len = 0;
1468 int slen;
1469 int error = FALSE;
1470
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001471 if (in_vim9script()
1472 && (check_for_string_arg(argvars, 0) == FAIL
1473 || check_for_number_arg(argvars, 1) == FAIL
1474 || check_for_opt_number_arg(argvars, 2) == FAIL
1475 || (argvars[2].v_type != VAR_UNKNOWN
1476 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1477 return;
1478
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001479 p = tv_get_string(&argvars[0]);
1480 slen = (int)STRLEN(p);
1481
1482 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1483 if (!error)
1484 {
1485 if (argvars[2].v_type != VAR_UNKNOWN
1486 && argvars[3].v_type != VAR_UNKNOWN)
1487 {
1488 skipcc = tv_get_bool(&argvars[3]);
1489 if (skipcc < 0 || skipcc > 1)
1490 {
1491 semsg(_(e_using_number_as_bool_nr), skipcc);
1492 return;
1493 }
1494 }
1495
1496 if (nchar > 0)
1497 while (nchar > 0 && nbyte < slen)
1498 {
1499 if (skipcc)
1500 nbyte += mb_ptr2len(p + nbyte);
1501 else
1502 nbyte += MB_CPTR2LEN(p + nbyte);
1503 --nchar;
1504 }
1505 else
1506 nbyte = nchar;
1507 if (argvars[2].v_type != VAR_UNKNOWN)
1508 {
1509 charlen = (int)tv_get_number(&argvars[2]);
1510 while (charlen > 0 && nbyte + len < slen)
1511 {
1512 int off = nbyte + len;
1513
1514 if (off < 0)
1515 len += 1;
1516 else
1517 {
1518 if (skipcc)
1519 len += mb_ptr2len(p + off);
1520 else
1521 len += MB_CPTR2LEN(p + off);
1522 }
1523 --charlen;
1524 }
1525 }
1526 else
1527 len = slen - nbyte; // default: all bytes that are available.
1528 }
1529
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001530 // Only return the overlap between the specified part and the actual
1531 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001532 if (nbyte < 0)
1533 {
1534 len += nbyte;
1535 nbyte = 0;
1536 }
1537 else if (nbyte > slen)
1538 nbyte = slen;
1539 if (len < 0)
1540 len = 0;
1541 else if (nbyte + len > slen)
1542 len = slen - nbyte;
1543
1544 rettv->v_type = VAR_STRING;
1545 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1546}
1547
1548/*
1549 * "strpart()" function
1550 */
1551 void
1552f_strpart(typval_T *argvars, typval_T *rettv)
1553{
1554 char_u *p;
1555 int n;
1556 int len;
1557 int slen;
1558 int error = FALSE;
1559
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001560 if (in_vim9script()
1561 && (check_for_string_arg(argvars, 0) == FAIL
1562 || check_for_number_arg(argvars, 1) == FAIL
1563 || check_for_opt_number_arg(argvars, 2) == FAIL
1564 || (argvars[2].v_type != VAR_UNKNOWN
1565 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1566 return;
1567
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001568 p = tv_get_string(&argvars[0]);
1569 slen = (int)STRLEN(p);
1570
1571 n = (int)tv_get_number_chk(&argvars[1], &error);
1572 if (error)
1573 len = 0;
1574 else if (argvars[2].v_type != VAR_UNKNOWN)
1575 len = (int)tv_get_number(&argvars[2]);
1576 else
1577 len = slen - n; // default len: all bytes that are available.
1578
1579 // Only return the overlap between the specified part and the actual
1580 // string.
1581 if (n < 0)
1582 {
1583 len += n;
1584 n = 0;
1585 }
1586 else if (n > slen)
1587 n = slen;
1588 if (len < 0)
1589 len = 0;
1590 else if (n + len > slen)
1591 len = slen - n;
1592
1593 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1594 {
1595 int off;
1596
1597 // length in characters
1598 for (off = n; off < slen && len > 0; --len)
1599 off += mb_ptr2len(p + off);
1600 len = off - n;
1601 }
1602
1603 rettv->v_type = VAR_STRING;
1604 rettv->vval.v_string = vim_strnsave(p + n, len);
1605}
1606
1607/*
1608 * "strridx()" function
1609 */
1610 void
1611f_strridx(typval_T *argvars, typval_T *rettv)
1612{
1613 char_u buf[NUMBUFLEN];
1614 char_u *needle;
1615 char_u *haystack;
1616 char_u *rest;
1617 char_u *lastmatch = NULL;
1618 int haystack_len, end_idx;
1619
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001620 if (in_vim9script()
1621 && (check_for_string_arg(argvars, 0) == FAIL
1622 || check_for_string_arg(argvars, 1) == FAIL
1623 || check_for_opt_number_arg(argvars, 2) == FAIL))
1624 return;
1625
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001626 needle = tv_get_string_chk(&argvars[1]);
1627 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1628
1629 rettv->vval.v_number = -1;
1630 if (needle == NULL || haystack == NULL)
1631 return; // type error; errmsg already given
1632
1633 haystack_len = (int)STRLEN(haystack);
1634 if (argvars[2].v_type != VAR_UNKNOWN)
1635 {
1636 // Third argument: upper limit for index
1637 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1638 if (end_idx < 0)
1639 return; // can never find a match
1640 }
1641 else
1642 end_idx = haystack_len;
1643
1644 if (*needle == NUL)
1645 {
1646 // Empty string matches past the end.
1647 lastmatch = haystack + end_idx;
1648 }
1649 else
1650 {
1651 for (rest = haystack; *rest != '\0'; ++rest)
1652 {
1653 rest = (char_u *)strstr((char *)rest, (char *)needle);
1654 if (rest == NULL || rest > haystack + end_idx)
1655 break;
1656 lastmatch = rest;
1657 }
1658 }
1659
1660 if (lastmatch == NULL)
1661 rettv->vval.v_number = -1;
1662 else
1663 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1664}
1665
1666/*
1667 * "strtrans()" function
1668 */
1669 void
1670f_strtrans(typval_T *argvars, typval_T *rettv)
1671{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001672 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1673 return;
1674
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001675 rettv->v_type = VAR_STRING;
1676 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1677}
1678
Christian Brabandt67672ef2023-04-24 21:09:54 +01001679
1680/*
1681 *
1682 * "utf16idx()" function
1683 */
1684 void
1685f_utf16idx(typval_T *argvars, typval_T *rettv)
1686{
1687 rettv->vval.v_number = -1;
1688
1689 if (check_for_string_arg(argvars, 0) == FAIL
1690 || check_for_opt_number_arg(argvars, 1) == FAIL
1691 || check_for_opt_bool_arg(argvars, 2) == FAIL
1692 || (argvars[2].v_type != VAR_UNKNOWN
1693 && check_for_opt_bool_arg(argvars, 3) == FAIL))
1694 return;
1695
1696 char_u *str = tv_get_string_chk(&argvars[0]);
1697 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
1698 if (str == NULL || idx < 0)
1699 return;
1700
1701 varnumber_T countcc = FALSE;
1702 varnumber_T charidx = FALSE;
1703 if (argvars[2].v_type != VAR_UNKNOWN)
1704 {
1705 countcc = tv_get_bool(&argvars[2]);
1706 if (argvars[3].v_type != VAR_UNKNOWN)
1707 charidx = tv_get_bool(&argvars[3]);
1708 }
1709
1710 int (*ptr2len)(char_u *);
1711 if (enc_utf8 && countcc)
1712 ptr2len = utf_ptr2len;
1713 else
1714 ptr2len = mb_ptr2len;
1715
1716 char_u *p;
1717 int len;
1718 for (p = str, len = 0; charidx ? idx >= 0 : p <= str + idx; len++)
1719 {
1720 if (*p == NUL)
1721 return;
1722 int clen = ptr2len(p);
1723 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1724 if (c > 0xFFFF)
1725 len++;
1726 p += ptr2len(p);
1727 if (charidx)
1728 idx--;
1729 }
1730
1731 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1732}
1733
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001734/*
1735 * "tolower(string)" function
1736 */
1737 void
1738f_tolower(typval_T *argvars, typval_T *rettv)
1739{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001740 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1741 return;
1742
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001743 rettv->v_type = VAR_STRING;
1744 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1745}
1746
1747/*
1748 * "toupper(string)" function
1749 */
1750 void
1751f_toupper(typval_T *argvars, typval_T *rettv)
1752{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001753 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1754 return;
1755
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001756 rettv->v_type = VAR_STRING;
1757 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1758}
1759
1760/*
1761 * "tr(string, fromstr, tostr)" function
1762 */
1763 void
1764f_tr(typval_T *argvars, typval_T *rettv)
1765{
1766 char_u *in_str;
1767 char_u *fromstr;
1768 char_u *tostr;
1769 char_u *p;
1770 int inlen;
1771 int fromlen;
1772 int tolen;
1773 int idx;
1774 char_u *cpstr;
1775 int cplen;
1776 int first = TRUE;
1777 char_u buf[NUMBUFLEN];
1778 char_u buf2[NUMBUFLEN];
1779 garray_T ga;
1780
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001781 if (in_vim9script()
1782 && (check_for_string_arg(argvars, 0) == FAIL
1783 || check_for_string_arg(argvars, 1) == FAIL
1784 || check_for_string_arg(argvars, 2) == FAIL))
1785 return;
1786
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001787 in_str = tv_get_string(&argvars[0]);
1788 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1789 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1790
1791 // Default return value: empty string.
1792 rettv->v_type = VAR_STRING;
1793 rettv->vval.v_string = NULL;
1794 if (fromstr == NULL || tostr == NULL)
1795 return; // type error; errmsg already given
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001796 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001797
1798 if (!has_mbyte)
1799 // not multi-byte: fromstr and tostr must be the same length
1800 if (STRLEN(fromstr) != STRLEN(tostr))
1801 {
1802error:
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001803 semsg(_(e_invalid_argument_str), fromstr);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001804 ga_clear(&ga);
1805 return;
1806 }
1807
1808 // fromstr and tostr have to contain the same number of chars
1809 while (*in_str != NUL)
1810 {
1811 if (has_mbyte)
1812 {
1813 inlen = (*mb_ptr2len)(in_str);
1814 cpstr = in_str;
1815 cplen = inlen;
1816 idx = 0;
1817 for (p = fromstr; *p != NUL; p += fromlen)
1818 {
1819 fromlen = (*mb_ptr2len)(p);
1820 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1821 {
1822 for (p = tostr; *p != NUL; p += tolen)
1823 {
1824 tolen = (*mb_ptr2len)(p);
1825 if (idx-- == 0)
1826 {
1827 cplen = tolen;
1828 cpstr = p;
1829 break;
1830 }
1831 }
1832 if (*p == NUL) // tostr is shorter than fromstr
1833 goto error;
1834 break;
1835 }
1836 ++idx;
1837 }
1838
1839 if (first && cpstr == in_str)
1840 {
1841 // Check that fromstr and tostr have the same number of
1842 // (multi-byte) characters. Done only once when a character
1843 // of in_str doesn't appear in fromstr.
1844 first = FALSE;
1845 for (p = tostr; *p != NUL; p += tolen)
1846 {
1847 tolen = (*mb_ptr2len)(p);
1848 --idx;
1849 }
1850 if (idx != 0)
1851 goto error;
1852 }
1853
1854 (void)ga_grow(&ga, cplen);
1855 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1856 ga.ga_len += cplen;
1857
1858 in_str += inlen;
1859 }
1860 else
1861 {
1862 // When not using multi-byte chars we can do it faster.
1863 p = vim_strchr(fromstr, *in_str);
1864 if (p != NULL)
1865 ga_append(&ga, tostr[p - fromstr]);
1866 else
1867 ga_append(&ga, *in_str);
1868 ++in_str;
1869 }
1870 }
1871
1872 // add a terminating NUL
1873 (void)ga_grow(&ga, 1);
1874 ga_append(&ga, NUL);
1875
1876 rettv->vval.v_string = ga.ga_data;
1877}
1878
1879/*
1880 * "trim({expr})" function
1881 */
1882 void
1883f_trim(typval_T *argvars, typval_T *rettv)
1884{
1885 char_u buf1[NUMBUFLEN];
1886 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001887 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001888 char_u *mask = NULL;
1889 char_u *tail;
1890 char_u *prev;
1891 char_u *p;
1892 int c1;
1893 int dir = 0;
1894
1895 rettv->v_type = VAR_STRING;
1896 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001897
1898 if (in_vim9script()
1899 && (check_for_string_arg(argvars, 0) == FAIL
1900 || check_for_opt_string_arg(argvars, 1) == FAIL
1901 || (argvars[1].v_type != VAR_UNKNOWN
1902 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1903 return;
1904
1905 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001906 if (head == NULL)
1907 return;
1908
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001909 if (check_for_opt_string_arg(argvars, 1) == FAIL)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001910 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001911
1912 if (argvars[1].v_type == VAR_STRING)
1913 {
1914 mask = tv_get_string_buf_chk(&argvars[1], buf2);
1915
1916 if (argvars[2].v_type != VAR_UNKNOWN)
1917 {
1918 int error = 0;
1919
1920 // leading or trailing characters to trim
1921 dir = (int)tv_get_number_chk(&argvars[2], &error);
1922 if (error)
1923 return;
1924 if (dir < 0 || dir > 2)
1925 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001926 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[2]));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001927 return;
1928 }
1929 }
1930 }
1931
1932 if (dir == 0 || dir == 1)
1933 {
1934 // Trim leading characters
1935 while (*head != NUL)
1936 {
1937 c1 = PTR2CHAR(head);
1938 if (mask == NULL)
1939 {
1940 if (c1 > ' ' && c1 != 0xa0)
1941 break;
1942 }
1943 else
1944 {
1945 for (p = mask; *p != NUL; MB_PTR_ADV(p))
1946 if (c1 == PTR2CHAR(p))
1947 break;
1948 if (*p == NUL)
1949 break;
1950 }
1951 MB_PTR_ADV(head);
1952 }
1953 }
1954
1955 tail = head + STRLEN(head);
1956 if (dir == 0 || dir == 2)
1957 {
1958 // Trim trailing characters
1959 for (; tail > head; tail = prev)
1960 {
1961 prev = tail;
1962 MB_PTR_BACK(head, prev);
1963 c1 = PTR2CHAR(prev);
1964 if (mask == NULL)
1965 {
1966 if (c1 > ' ' && c1 != 0xa0)
1967 break;
1968 }
1969 else
1970 {
1971 for (p = mask; *p != NUL; MB_PTR_ADV(p))
1972 if (c1 == PTR2CHAR(p))
1973 break;
1974 if (*p == NUL)
1975 break;
1976 }
1977 }
1978 }
1979 rettv->vval.v_string = vim_strnsave(head, tail - head);
1980}
1981
Bram Moolenaar677658a2022-01-05 16:09:06 +00001982static char *e_printf = N_(e_insufficient_arguments_for_printf);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001983
1984/*
1985 * Get number argument from "idxp" entry in "tvs". First entry is 1.
1986 */
1987 static varnumber_T
1988tv_nr(typval_T *tvs, int *idxp)
1989{
1990 int idx = *idxp - 1;
1991 varnumber_T n = 0;
1992 int err = FALSE;
1993
1994 if (tvs[idx].v_type == VAR_UNKNOWN)
1995 emsg(_(e_printf));
1996 else
1997 {
1998 ++*idxp;
1999 n = tv_get_number_chk(&tvs[idx], &err);
2000 if (err)
2001 n = 0;
2002 }
2003 return n;
2004}
2005
2006/*
2007 * Get string argument from "idxp" entry in "tvs". First entry is 1.
2008 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
2009 * are not converted to a string.
2010 * If "tofree" is not NULL echo_string() is used. All types are converted to
2011 * a string with the same format as ":echo". The caller must free "*tofree".
2012 * Returns NULL for an error.
2013 */
2014 static char *
2015tv_str(typval_T *tvs, int *idxp, char_u **tofree)
2016{
2017 int idx = *idxp - 1;
2018 char *s = NULL;
2019 static char_u numbuf[NUMBUFLEN];
2020
2021 if (tvs[idx].v_type == VAR_UNKNOWN)
2022 emsg(_(e_printf));
2023 else
2024 {
2025 ++*idxp;
2026 if (tofree != NULL)
2027 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
2028 else
2029 s = (char *)tv_get_string_chk(&tvs[idx]);
2030 }
2031 return s;
2032}
2033
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002034/*
2035 * Get float argument from "idxp" entry in "tvs". First entry is 1.
2036 */
2037 static double
2038tv_float(typval_T *tvs, int *idxp)
2039{
2040 int idx = *idxp - 1;
2041 double f = 0;
2042
2043 if (tvs[idx].v_type == VAR_UNKNOWN)
2044 emsg(_(e_printf));
2045 else
2046 {
2047 ++*idxp;
2048 if (tvs[idx].v_type == VAR_FLOAT)
2049 f = tvs[idx].vval.v_float;
2050 else if (tvs[idx].v_type == VAR_NUMBER)
2051 f = (double)tvs[idx].vval.v_number;
2052 else
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00002053 emsg(_(e_expected_float_argument_for_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002054 }
2055 return f;
2056}
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00002057
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002058#endif
2059
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002060/*
2061 * Return the representation of infinity for printf() function:
2062 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
2063 */
2064 static const char *
2065infinity_str(int positive,
2066 char fmt_spec,
2067 int force_sign,
2068 int space_for_positive)
2069{
2070 static const char *table[] =
2071 {
2072 "-inf", "inf", "+inf", " inf",
2073 "-INF", "INF", "+INF", " INF"
2074 };
2075 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
2076
2077 if (ASCII_ISUPPER(fmt_spec))
2078 idx += 4;
2079 return table[idx];
2080}
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002081
2082/*
2083 * This code was included to provide a portable vsnprintf() and snprintf().
2084 * Some systems may provide their own, but we always use this one for
2085 * consistency.
2086 *
2087 * This code is based on snprintf.c - a portable implementation of snprintf
2088 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
2089 * Included with permission. It was heavily modified to fit in Vim.
2090 * The original code, including useful comments, can be found here:
2091 * http://www.ijs.si/software/snprintf/
2092 *
2093 * This snprintf() only supports the following conversion specifiers:
2094 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
2095 * with flags: '-', '+', ' ', '0' and '#'.
2096 * An asterisk is supported for field width as well as precision.
2097 *
2098 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
2099 *
2100 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
2101 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
2102 *
2103 * The locale is not used, the string is used as a byte string. This is only
2104 * relevant for double-byte encodings where the second byte may be '%'.
2105 *
2106 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
2107 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
2108 *
2109 * The return value is the number of characters which would be generated
2110 * for the given input, excluding the trailing NUL. If this value
2111 * is greater or equal to "str_m", not all characters from the result
2112 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
2113 * are discarded. If "str_m" is greater than zero it is guaranteed
2114 * the resulting string will be NUL-terminated.
2115 */
2116
2117/*
2118 * When va_list is not supported we only define vim_snprintf().
2119 *
2120 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2121 * "typval_T". When the latter is not used it must be NULL.
2122 */
2123
2124// When generating prototypes all of this is skipped, cproto doesn't
2125// understand this.
2126#ifndef PROTO
2127
2128// Like vim_vsnprintf() but append to the string.
2129 int
2130vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2131{
2132 va_list ap;
2133 int str_l;
2134 size_t len = STRLEN(str);
2135 size_t space;
2136
2137 if (str_m <= len)
2138 space = 0;
2139 else
2140 space = str_m - len;
2141 va_start(ap, fmt);
2142 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2143 va_end(ap);
2144 return str_l;
2145}
2146
2147 int
2148vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2149{
2150 va_list ap;
2151 int str_l;
2152
2153 va_start(ap, fmt);
2154 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2155 va_end(ap);
2156 return str_l;
2157}
2158
2159 int
2160vim_vsnprintf(
2161 char *str,
2162 size_t str_m,
2163 const char *fmt,
2164 va_list ap)
2165{
2166 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2167}
2168
2169 int
2170vim_vsnprintf_typval(
2171 char *str,
2172 size_t str_m,
2173 const char *fmt,
2174 va_list ap,
2175 typval_T *tvs)
2176{
2177 size_t str_l = 0;
2178 const char *p = fmt;
2179 int arg_idx = 1;
2180
2181 if (p == NULL)
2182 p = "";
2183 while (*p != NUL)
2184 {
2185 if (*p != '%')
2186 {
2187 char *q = strchr(p + 1, '%');
2188 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2189
2190 // Copy up to the next '%' or NUL without any changes.
2191 if (str_l < str_m)
2192 {
2193 size_t avail = str_m - str_l;
2194
2195 mch_memmove(str + str_l, p, n > avail ? avail : n);
2196 }
2197 p += n;
2198 str_l += n;
2199 }
2200 else
2201 {
2202 size_t min_field_width = 0, precision = 0;
2203 int zero_padding = 0, precision_specified = 0, justify_left = 0;
2204 int alternate_form = 0, force_sign = 0;
2205
2206 // If both the ' ' and '+' flags appear, the ' ' flag should be
2207 // ignored.
2208 int space_for_positive = 1;
2209
2210 // allowed values: \0, h, l, L
2211 char length_modifier = '\0';
2212
2213 // temporary buffer for simple numeric->string conversion
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002214# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002215 // That sounds reasonable to use as the maximum
2216 // printable.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002217 char tmp[TMP_LEN];
2218
2219 // string address in case of string argument
2220 const char *str_arg = NULL;
2221
2222 // natural field width of arg without padding and sign
2223 size_t str_arg_l;
2224
2225 // unsigned char argument value - only defined for c conversion.
2226 // N.B. standard explicitly states the char argument for the c
2227 // conversion is unsigned
2228 unsigned char uchar_arg;
2229
2230 // number of zeros to be inserted for numeric conversions as
2231 // required by the precision or minimal field width
2232 size_t number_of_zeros_to_pad = 0;
2233
2234 // index into tmp where zero padding is to be inserted
2235 size_t zero_padding_insertion_ind = 0;
2236
2237 // current conversion specifier character
2238 char fmt_spec = '\0';
2239
2240 // buffer for 's' and 'S' specs
2241 char_u *tofree = NULL;
2242
2243
2244 p++; // skip '%'
2245
2246 // parse flags
2247 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2248 || *p == '#' || *p == '\'')
2249 {
2250 switch (*p)
2251 {
2252 case '0': zero_padding = 1; break;
2253 case '-': justify_left = 1; break;
2254 case '+': force_sign = 1; space_for_positive = 0; break;
2255 case ' ': force_sign = 1;
2256 // If both the ' ' and '+' flags appear, the ' '
2257 // flag should be ignored
2258 break;
2259 case '#': alternate_form = 1; break;
2260 case '\'': break;
2261 }
2262 p++;
2263 }
2264 // If the '0' and '-' flags both appear, the '0' flag should be
2265 // ignored.
2266
2267 // parse field width
2268 if (*p == '*')
2269 {
2270 int j;
2271
2272 p++;
2273 j =
2274# if defined(FEAT_EVAL)
2275 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2276# endif
2277 va_arg(ap, int);
2278 if (j >= 0)
2279 min_field_width = j;
2280 else
2281 {
2282 min_field_width = -j;
2283 justify_left = 1;
2284 }
2285 }
2286 else if (VIM_ISDIGIT((int)(*p)))
2287 {
2288 // size_t could be wider than unsigned int; make sure we treat
2289 // argument like common implementations do
2290 unsigned int uj = *p++ - '0';
2291
2292 while (VIM_ISDIGIT((int)(*p)))
2293 uj = 10 * uj + (unsigned int)(*p++ - '0');
2294 min_field_width = uj;
2295 }
2296
2297 // parse precision
2298 if (*p == '.')
2299 {
2300 p++;
2301 precision_specified = 1;
2302 if (*p == '*')
2303 {
2304 int j;
2305
2306 j =
2307# if defined(FEAT_EVAL)
2308 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2309# endif
2310 va_arg(ap, int);
2311 p++;
2312 if (j >= 0)
2313 precision = j;
2314 else
2315 {
2316 precision_specified = 0;
2317 precision = 0;
2318 }
2319 }
2320 else if (VIM_ISDIGIT((int)(*p)))
2321 {
2322 // size_t could be wider than unsigned int; make sure we
2323 // treat argument like common implementations do
2324 unsigned int uj = *p++ - '0';
2325
2326 while (VIM_ISDIGIT((int)(*p)))
2327 uj = 10 * uj + (unsigned int)(*p++ - '0');
2328 precision = uj;
2329 }
2330 }
2331
2332 // parse 'h', 'l' and 'll' length modifiers
2333 if (*p == 'h' || *p == 'l')
2334 {
2335 length_modifier = *p;
2336 p++;
2337 if (length_modifier == 'l' && *p == 'l')
2338 {
2339 // double l = __int64 / varnumber_T
2340 length_modifier = 'L';
2341 p++;
2342 }
2343 }
2344 fmt_spec = *p;
2345
2346 // common synonyms:
2347 switch (fmt_spec)
2348 {
2349 case 'i': fmt_spec = 'd'; break;
2350 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2351 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2352 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2353 default: break;
2354 }
2355
2356# if defined(FEAT_EVAL)
2357 switch (fmt_spec)
2358 {
2359 case 'd': case 'u': case 'o': case 'x': case 'X':
2360 if (tvs != NULL && length_modifier == '\0')
2361 length_modifier = 'L';
2362 }
2363# endif
2364
2365 // get parameter value, do initial processing
2366 switch (fmt_spec)
2367 {
2368 // '%' and 'c' behave similar to 's' regarding flags and field
2369 // widths
2370 case '%':
2371 case 'c':
2372 case 's':
2373 case 'S':
2374 str_arg_l = 1;
2375 switch (fmt_spec)
2376 {
2377 case '%':
2378 str_arg = p;
2379 break;
2380
2381 case 'c':
2382 {
2383 int j;
2384
2385 j =
2386# if defined(FEAT_EVAL)
2387 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2388# endif
2389 va_arg(ap, int);
2390 // standard demands unsigned char
2391 uchar_arg = (unsigned char)j;
2392 str_arg = (char *)&uchar_arg;
2393 break;
2394 }
2395
2396 case 's':
2397 case 'S':
2398 str_arg =
2399# if defined(FEAT_EVAL)
2400 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
2401# endif
2402 va_arg(ap, char *);
2403 if (str_arg == NULL)
2404 {
2405 str_arg = "[NULL]";
2406 str_arg_l = 6;
2407 }
2408 // make sure not to address string beyond the specified
2409 // precision !!!
2410 else if (!precision_specified)
2411 str_arg_l = strlen(str_arg);
2412 // truncate string if necessary as requested by precision
2413 else if (precision == 0)
2414 str_arg_l = 0;
2415 else
2416 {
2417 // Don't put the #if inside memchr(), it can be a
2418 // macro.
2419 // memchr on HP does not like n > 2^31 !!!
2420 char *q = memchr(str_arg, '\0',
2421 precision <= (size_t)0x7fffffffL ? precision
2422 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00002423
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002424 str_arg_l = (q == NULL) ? precision
2425 : (size_t)(q - str_arg);
2426 }
2427 if (fmt_spec == 'S')
2428 {
presuku1f2453f2021-11-24 15:32:57 +00002429 char_u *p1;
2430 size_t i;
2431 int cell;
presukud85fccd2021-11-20 19:38:31 +00002432
presuku1f2453f2021-11-24 15:32:57 +00002433 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002434 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00002435 {
2436 cell = mb_ptr2cells(p1);
2437 if (precision_specified && i + cell > precision)
2438 break;
2439 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002440 }
presuku1f2453f2021-11-24 15:32:57 +00002441
2442 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00002443 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00002444 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002445 }
2446 break;
2447
2448 default:
2449 break;
2450 }
2451 break;
2452
2453 case 'd': case 'u':
2454 case 'b': case 'B':
2455 case 'o':
2456 case 'x': case 'X':
2457 case 'p':
2458 {
2459 // NOTE: the u, b, o, x, X and p conversion specifiers
2460 // imply the value is unsigned; d implies a signed
2461 // value
2462
2463 // 0 if numeric argument is zero (or if pointer is
2464 // NULL for 'p'), +1 if greater than zero (or nonzero
2465 // for unsigned arguments), -1 if negative (unsigned
2466 // argument is never negative)
2467 int arg_sign = 0;
2468
2469 // only set for length modifier h, or for no length
2470 // modifiers
2471 int int_arg = 0;
2472 unsigned int uint_arg = 0;
2473
2474 // only set for length modifier l
2475 long int long_arg = 0;
2476 unsigned long int ulong_arg = 0;
2477
2478 // only set for length modifier ll
2479 varnumber_T llong_arg = 0;
2480 uvarnumber_T ullong_arg = 0;
2481
2482 // only set for b conversion
2483 uvarnumber_T bin_arg = 0;
2484
2485 // pointer argument value -only defined for p
2486 // conversion
2487 void *ptr_arg = NULL;
2488
2489 if (fmt_spec == 'p')
2490 {
2491 length_modifier = '\0';
2492 ptr_arg =
2493# if defined(FEAT_EVAL)
2494 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
2495 NULL) :
2496# endif
2497 va_arg(ap, void *);
2498 if (ptr_arg != NULL)
2499 arg_sign = 1;
2500 }
2501 else if (fmt_spec == 'b' || fmt_spec == 'B')
2502 {
2503 bin_arg =
2504# if defined(FEAT_EVAL)
2505 tvs != NULL ?
2506 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
2507# endif
2508 va_arg(ap, uvarnumber_T);
2509 if (bin_arg != 0)
2510 arg_sign = 1;
2511 }
2512 else if (fmt_spec == 'd')
2513 {
2514 // signed
2515 switch (length_modifier)
2516 {
2517 case '\0':
2518 case 'h':
2519 // char and short arguments are passed as int.
2520 int_arg =
2521# if defined(FEAT_EVAL)
2522 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2523# endif
2524 va_arg(ap, int);
2525 if (int_arg > 0)
2526 arg_sign = 1;
2527 else if (int_arg < 0)
2528 arg_sign = -1;
2529 break;
2530 case 'l':
2531 long_arg =
2532# if defined(FEAT_EVAL)
2533 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2534# endif
2535 va_arg(ap, long int);
2536 if (long_arg > 0)
2537 arg_sign = 1;
2538 else if (long_arg < 0)
2539 arg_sign = -1;
2540 break;
2541 case 'L':
2542 llong_arg =
2543# if defined(FEAT_EVAL)
2544 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2545# endif
2546 va_arg(ap, varnumber_T);
2547 if (llong_arg > 0)
2548 arg_sign = 1;
2549 else if (llong_arg < 0)
2550 arg_sign = -1;
2551 break;
2552 }
2553 }
2554 else
2555 {
2556 // unsigned
2557 switch (length_modifier)
2558 {
2559 case '\0':
2560 case 'h':
2561 uint_arg =
2562# if defined(FEAT_EVAL)
2563 tvs != NULL ? (unsigned)
2564 tv_nr(tvs, &arg_idx) :
2565# endif
2566 va_arg(ap, unsigned int);
2567 if (uint_arg != 0)
2568 arg_sign = 1;
2569 break;
2570 case 'l':
2571 ulong_arg =
2572# if defined(FEAT_EVAL)
2573 tvs != NULL ? (unsigned long)
2574 tv_nr(tvs, &arg_idx) :
2575# endif
2576 va_arg(ap, unsigned long int);
2577 if (ulong_arg != 0)
2578 arg_sign = 1;
2579 break;
2580 case 'L':
2581 ullong_arg =
2582# if defined(FEAT_EVAL)
2583 tvs != NULL ? (uvarnumber_T)
2584 tv_nr(tvs, &arg_idx) :
2585# endif
2586 va_arg(ap, uvarnumber_T);
2587 if (ullong_arg != 0)
2588 arg_sign = 1;
2589 break;
2590 }
2591 }
2592
2593 str_arg = tmp;
2594 str_arg_l = 0;
2595
2596 // NOTE:
2597 // For d, i, u, o, x, and X conversions, if precision is
2598 // specified, the '0' flag should be ignored. This is so
2599 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
2600 // FreeBSD, NetBSD; but not with Perl.
2601 if (precision_specified)
2602 zero_padding = 0;
2603 if (fmt_spec == 'd')
2604 {
2605 if (force_sign && arg_sign >= 0)
2606 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
2607 // leave negative numbers for sprintf to handle, to
2608 // avoid handling tricky cases like (short int)-32768
2609 }
2610 else if (alternate_form)
2611 {
2612 if (arg_sign != 0
2613 && (fmt_spec == 'b' || fmt_spec == 'B'
2614 || fmt_spec == 'x' || fmt_spec == 'X') )
2615 {
2616 tmp[str_arg_l++] = '0';
2617 tmp[str_arg_l++] = fmt_spec;
2618 }
2619 // alternate form should have no effect for p
2620 // conversion, but ...
2621 }
2622
2623 zero_padding_insertion_ind = str_arg_l;
2624 if (!precision_specified)
2625 precision = 1; // default precision is 1
2626 if (precision == 0 && arg_sign == 0)
2627 {
2628 // When zero value is formatted with an explicit
2629 // precision 0, the resulting formatted string is
2630 // empty (d, i, u, b, B, o, x, X, p).
2631 }
2632 else
2633 {
2634 char f[6];
2635 int f_l = 0;
2636
2637 // construct a simple format string for sprintf
2638 f[f_l++] = '%';
2639 if (!length_modifier)
2640 ;
2641 else if (length_modifier == 'L')
2642 {
2643# ifdef MSWIN
2644 f[f_l++] = 'I';
2645 f[f_l++] = '6';
2646 f[f_l++] = '4';
2647# else
2648 f[f_l++] = 'l';
2649 f[f_l++] = 'l';
2650# endif
2651 }
2652 else
2653 f[f_l++] = length_modifier;
2654 f[f_l++] = fmt_spec;
2655 f[f_l++] = '\0';
2656
2657 if (fmt_spec == 'p')
2658 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
2659 else if (fmt_spec == 'b' || fmt_spec == 'B')
2660 {
2661 char b[8 * sizeof(uvarnumber_T)];
2662 size_t b_l = 0;
2663 uvarnumber_T bn = bin_arg;
2664
2665 do
2666 {
2667 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
2668 bn >>= 1;
2669 }
2670 while (bn != 0);
2671
2672 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
2673 str_arg_l += b_l;
2674 }
2675 else if (fmt_spec == 'd')
2676 {
2677 // signed
2678 switch (length_modifier)
2679 {
2680 case '\0': str_arg_l += sprintf(
2681 tmp + str_arg_l, f,
2682 int_arg);
2683 break;
2684 case 'h': str_arg_l += sprintf(
2685 tmp + str_arg_l, f,
2686 (short)int_arg);
2687 break;
2688 case 'l': str_arg_l += sprintf(
2689 tmp + str_arg_l, f, long_arg);
2690 break;
2691 case 'L': str_arg_l += sprintf(
2692 tmp + str_arg_l, f, llong_arg);
2693 break;
2694 }
2695 }
2696 else
2697 {
2698 // unsigned
2699 switch (length_modifier)
2700 {
2701 case '\0': str_arg_l += sprintf(
2702 tmp + str_arg_l, f,
2703 uint_arg);
2704 break;
2705 case 'h': str_arg_l += sprintf(
2706 tmp + str_arg_l, f,
2707 (unsigned short)uint_arg);
2708 break;
2709 case 'l': str_arg_l += sprintf(
2710 tmp + str_arg_l, f, ulong_arg);
2711 break;
2712 case 'L': str_arg_l += sprintf(
2713 tmp + str_arg_l, f, ullong_arg);
2714 break;
2715 }
2716 }
2717
2718 // include the optional minus sign and possible
2719 // "0x" in the region before the zero padding
2720 // insertion point
2721 if (zero_padding_insertion_ind < str_arg_l
2722 && tmp[zero_padding_insertion_ind] == '-')
2723 zero_padding_insertion_ind++;
2724 if (zero_padding_insertion_ind + 1 < str_arg_l
2725 && tmp[zero_padding_insertion_ind] == '0'
2726 && (tmp[zero_padding_insertion_ind + 1] == 'x'
2727 || tmp[zero_padding_insertion_ind + 1] == 'X'))
2728 zero_padding_insertion_ind += 2;
2729 }
2730
2731 {
2732 size_t num_of_digits = str_arg_l
2733 - zero_padding_insertion_ind;
2734
2735 if (alternate_form && fmt_spec == 'o'
2736 // unless zero is already the first
2737 // character
2738 && !(zero_padding_insertion_ind < str_arg_l
2739 && tmp[zero_padding_insertion_ind] == '0'))
2740 {
2741 // assure leading zero for alternate-form
2742 // octal numbers
2743 if (!precision_specified
2744 || precision < num_of_digits + 1)
2745 {
2746 // precision is increased to force the
2747 // first character to be zero, except if a
2748 // zero value is formatted with an
2749 // explicit precision of zero
2750 precision = num_of_digits + 1;
2751 }
2752 }
2753 // zero padding to specified precision?
2754 if (num_of_digits < precision)
2755 number_of_zeros_to_pad = precision - num_of_digits;
2756 }
2757 // zero padding to specified minimal field width?
2758 if (!justify_left && zero_padding)
2759 {
2760 int n = (int)(min_field_width - (str_arg_l
2761 + number_of_zeros_to_pad));
2762 if (n > 0)
2763 number_of_zeros_to_pad += n;
2764 }
2765 break;
2766 }
2767
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002768 case 'f':
2769 case 'F':
2770 case 'e':
2771 case 'E':
2772 case 'g':
2773 case 'G':
2774 {
2775 // Floating point.
2776 double f;
2777 double abs_f;
2778 char format[40];
2779 int l;
2780 int remove_trailing_zeroes = FALSE;
2781
2782 f =
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002783# if defined(FEAT_EVAL)
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002784 tvs != NULL ? tv_float(tvs, &arg_idx) :
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002785# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002786 va_arg(ap, double);
2787 abs_f = f < 0 ? -f : f;
2788
2789 if (fmt_spec == 'g' || fmt_spec == 'G')
2790 {
2791 // Would be nice to use %g directly, but it prints
2792 // "1.0" as "1", we don't want that.
2793 if ((abs_f >= 0.001 && abs_f < 10000000.0)
2794 || abs_f == 0.0)
2795 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
2796 else
2797 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
2798 remove_trailing_zeroes = TRUE;
2799 }
2800
2801 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002802# ifdef VAX
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002803 abs_f > 1.0e38
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002804# else
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002805 abs_f > 1.0e307
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002806# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002807 )
2808 {
2809 // Avoid a buffer overflow
2810 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2811 force_sign, space_for_positive));
2812 str_arg_l = STRLEN(tmp);
2813 zero_padding = 0;
2814 }
2815 else
2816 {
2817 if (isnan(f))
2818 {
2819 // Not a number: nan or NAN
2820 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
2821 : "nan");
2822 str_arg_l = 3;
2823 zero_padding = 0;
2824 }
2825 else if (isinf(f))
2826 {
2827 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2828 force_sign, space_for_positive));
2829 str_arg_l = STRLEN(tmp);
2830 zero_padding = 0;
2831 }
2832 else
2833 {
2834 // Regular float number
2835 format[0] = '%';
2836 l = 1;
2837 if (force_sign)
2838 format[l++] = space_for_positive ? ' ' : '+';
2839 if (precision_specified)
2840 {
2841 size_t max_prec = TMP_LEN - 10;
2842
2843 // Make sure we don't get more digits than we
2844 // have room for.
2845 if ((fmt_spec == 'f' || fmt_spec == 'F')
2846 && abs_f > 1.0)
2847 max_prec -= (size_t)log10(abs_f);
2848 if (precision > max_prec)
2849 precision = max_prec;
2850 l += sprintf(format + l, ".%d", (int)precision);
2851 }
2852 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
2853 format[l + 1] = NUL;
2854
2855 str_arg_l = sprintf(tmp, format, f);
2856 }
2857
2858 if (remove_trailing_zeroes)
2859 {
2860 int i;
2861 char *tp;
2862
2863 // Using %g or %G: remove superfluous zeroes.
2864 if (fmt_spec == 'f' || fmt_spec == 'F')
2865 tp = tmp + str_arg_l - 1;
2866 else
2867 {
2868 tp = (char *)vim_strchr((char_u *)tmp,
2869 fmt_spec == 'e' ? 'e' : 'E');
2870 if (tp != NULL)
2871 {
2872 // Remove superfluous '+' and leading
2873 // zeroes from the exponent.
2874 if (tp[1] == '+')
2875 {
2876 // Change "1.0e+07" to "1.0e07"
2877 STRMOVE(tp + 1, tp + 2);
2878 --str_arg_l;
2879 }
2880 i = (tp[1] == '-') ? 2 : 1;
2881 while (tp[i] == '0')
2882 {
2883 // Change "1.0e07" to "1.0e7"
2884 STRMOVE(tp + i, tp + i + 1);
2885 --str_arg_l;
2886 }
2887 --tp;
2888 }
2889 }
2890
2891 if (tp != NULL && !precision_specified)
2892 // Remove trailing zeroes, but keep the one
2893 // just after a dot.
2894 while (tp > tmp + 2 && *tp == '0'
2895 && tp[-1] != '.')
2896 {
2897 STRMOVE(tp, tp + 1);
2898 --tp;
2899 --str_arg_l;
2900 }
2901 }
2902 else
2903 {
2904 char *tp;
2905
2906 // Be consistent: some printf("%e") use 1.0e+12
2907 // and some 1.0e+012. Remove one zero in the last
2908 // case.
2909 tp = (char *)vim_strchr((char_u *)tmp,
2910 fmt_spec == 'e' ? 'e' : 'E');
2911 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
2912 && tp[2] == '0'
2913 && vim_isdigit(tp[3])
2914 && vim_isdigit(tp[4]))
2915 {
2916 STRMOVE(tp + 2, tp + 3);
2917 --str_arg_l;
2918 }
2919 }
2920 }
2921 if (zero_padding && min_field_width > str_arg_l
2922 && (tmp[0] == '-' || force_sign))
2923 {
2924 // padding 0's should be inserted after the sign
2925 number_of_zeros_to_pad = min_field_width - str_arg_l;
2926 zero_padding_insertion_ind = 1;
2927 }
2928 str_arg = tmp;
2929 break;
2930 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002931
2932 default:
2933 // unrecognized conversion specifier, keep format string
2934 // as-is
2935 zero_padding = 0; // turn zero padding off for non-numeric
2936 // conversion
2937 justify_left = 1;
2938 min_field_width = 0; // reset flags
2939
2940 // discard the unrecognized conversion, just keep *
2941 // the unrecognized conversion character
2942 str_arg = p;
2943 str_arg_l = 0;
2944 if (*p != NUL)
2945 str_arg_l++; // include invalid conversion specifier
2946 // unchanged if not at end-of-string
2947 break;
2948 }
2949
2950 if (*p != NUL)
2951 p++; // step over the just processed conversion specifier
2952
2953 // insert padding to the left as requested by min_field_width;
2954 // this does not include the zero padding in case of numerical
2955 // conversions
2956 if (!justify_left)
2957 {
2958 // left padding with blank or zero
2959 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
2960
2961 if (pn > 0)
2962 {
2963 if (str_l < str_m)
2964 {
2965 size_t avail = str_m - str_l;
2966
2967 vim_memset(str + str_l, zero_padding ? '0' : ' ',
2968 (size_t)pn > avail ? avail
2969 : (size_t)pn);
2970 }
2971 str_l += pn;
2972 }
2973 }
2974
2975 // zero padding as requested by the precision or by the minimal
2976 // field width for numeric conversions required?
2977 if (number_of_zeros_to_pad == 0)
2978 {
2979 // will not copy first part of numeric right now, *
2980 // force it to be copied later in its entirety
2981 zero_padding_insertion_ind = 0;
2982 }
2983 else
2984 {
2985 // insert first part of numerics (sign or '0x') before zero
2986 // padding
2987 int zn = (int)zero_padding_insertion_ind;
2988
2989 if (zn > 0)
2990 {
2991 if (str_l < str_m)
2992 {
2993 size_t avail = str_m - str_l;
2994
2995 mch_memmove(str + str_l, str_arg,
2996 (size_t)zn > avail ? avail
2997 : (size_t)zn);
2998 }
2999 str_l += zn;
3000 }
3001
3002 // insert zero padding as requested by the precision or min
3003 // field width
3004 zn = (int)number_of_zeros_to_pad;
3005 if (zn > 0)
3006 {
3007 if (str_l < str_m)
3008 {
3009 size_t avail = str_m - str_l;
3010
3011 vim_memset(str + str_l, '0',
3012 (size_t)zn > avail ? avail
3013 : (size_t)zn);
3014 }
3015 str_l += zn;
3016 }
3017 }
3018
3019 // insert formatted string
3020 // (or as-is conversion specifier for unknown conversions)
3021 {
3022 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
3023
3024 if (sn > 0)
3025 {
3026 if (str_l < str_m)
3027 {
3028 size_t avail = str_m - str_l;
3029
3030 mch_memmove(str + str_l,
3031 str_arg + zero_padding_insertion_ind,
3032 (size_t)sn > avail ? avail : (size_t)sn);
3033 }
3034 str_l += sn;
3035 }
3036 }
3037
3038 // insert right padding
3039 if (justify_left)
3040 {
3041 // right blank padding to the field width
3042 int pn = (int)(min_field_width
3043 - (str_arg_l + number_of_zeros_to_pad));
3044
3045 if (pn > 0)
3046 {
3047 if (str_l < str_m)
3048 {
3049 size_t avail = str_m - str_l;
3050
3051 vim_memset(str + str_l, ' ',
3052 (size_t)pn > avail ? avail
3053 : (size_t)pn);
3054 }
3055 str_l += pn;
3056 }
3057 }
3058 vim_free(tofree);
3059 }
3060 }
3061
3062 if (str_m > 0)
3063 {
3064 // make sure the string is nul-terminated even at the expense of
3065 // overwriting the last character (shouldn't happen, but just in case)
3066 //
3067 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
3068 }
3069
3070 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar677658a2022-01-05 16:09:06 +00003071 emsg(_(e_too_many_arguments_to_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003072
3073 // Return the number of characters formatted (excluding trailing nul
3074 // character), that is, the number of characters that would have been
3075 // written to the buffer if it were large enough.
3076 return (int)str_l;
3077}
3078
3079#endif // PROTO