blob: 90429d3baf6c8b00285c548db9c74a2d2ff86e5b [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
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001047 static void
1048byteidx(typval_T *argvars, typval_T *rettv, int comp UNUSED)
1049{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001050 rettv->vval.v_number = -1;
1051
1052 if (in_vim9script()
1053 && (check_for_string_arg(argvars, 0) == FAIL
1054 || check_for_number_arg(argvars, 1) == FAIL))
1055 return;
1056
Christian Brabandt67672ef2023-04-24 21:09:54 +01001057 char_u *str = tv_get_string_chk(&argvars[0]);
1058 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001059 if (str == NULL || idx < 0)
1060 return;
1061
Christian Brabandt67672ef2023-04-24 21:09:54 +01001062 varnumber_T utf16idx = FALSE;
1063 if (argvars[2].v_type != VAR_UNKNOWN)
1064 {
1065 utf16idx = tv_get_bool(&argvars[2]);
1066 if (utf16idx < 0 || utf16idx > 1)
1067 {
1068 semsg(_(e_using_number_as_bool_nr), utf16idx);
1069 return;
1070 }
1071 }
1072
1073 int (*ptr2len)(char_u *);
1074 if (enc_utf8 && comp)
1075 ptr2len = utf_ptr2len;
1076 else
1077 ptr2len = mb_ptr2len;
1078
1079 char_u *t = str;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001080 for ( ; idx > 0; idx--)
1081 {
1082 if (*t == NUL) // EOL reached
1083 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001084 if (utf16idx)
1085 {
1086 int clen = ptr2len(t);
1087 int c = (clen > 1) ? utf_ptr2char(t) : *t;
1088 if (c > 0xFFFF)
1089 idx--;
1090 }
1091 if (idx > 0)
1092 t += ptr2len(t);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001093 }
1094 rettv->vval.v_number = (varnumber_T)(t - str);
1095}
1096
1097/*
1098 * "byteidx()" function
1099 */
1100 void
1101f_byteidx(typval_T *argvars, typval_T *rettv)
1102{
1103 byteidx(argvars, rettv, FALSE);
1104}
1105
1106/*
1107 * "byteidxcomp()" function
1108 */
1109 void
1110f_byteidxcomp(typval_T *argvars, typval_T *rettv)
1111{
1112 byteidx(argvars, rettv, TRUE);
1113}
1114
1115/*
1116 * "charidx()" function
1117 */
1118 void
1119f_charidx(typval_T *argvars, typval_T *rettv)
1120{
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001121 rettv->vval.v_number = -1;
1122
Christian Brabandt67672ef2023-04-24 21:09:54 +01001123 if (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001124 || check_for_number_arg(argvars, 1) == FAIL
Christian Brabandt67672ef2023-04-24 21:09:54 +01001125 || check_for_opt_bool_arg(argvars, 2) == FAIL
1126 || (argvars[2].v_type != VAR_UNKNOWN
1127 && check_for_opt_bool_arg(argvars, 3) == FAIL))
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001128 return;
1129
Christian Brabandt67672ef2023-04-24 21:09:54 +01001130 char_u *str = tv_get_string_chk(&argvars[0]);
1131 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001132 if (str == NULL || idx < 0)
1133 return;
1134
Christian Brabandt67672ef2023-04-24 21:09:54 +01001135 varnumber_T countcc = FALSE;
1136 varnumber_T utf16idx = FALSE;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001137 if (argvars[2].v_type != VAR_UNKNOWN)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001138 {
Christian Brabandt67672ef2023-04-24 21:09:54 +01001139 countcc = tv_get_bool(&argvars[2]);
1140 if (argvars[3].v_type != VAR_UNKNOWN)
1141 utf16idx = tv_get_bool(&argvars[3]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001142 }
1143
Christian Brabandt67672ef2023-04-24 21:09:54 +01001144 int (*ptr2len)(char_u *);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001145 if (enc_utf8 && countcc)
1146 ptr2len = utf_ptr2len;
1147 else
1148 ptr2len = mb_ptr2len;
1149
Christian Brabandt67672ef2023-04-24 21:09:54 +01001150 char_u *p;
1151 int len;
1152 for (p = str, len = 0; utf16idx ? idx >= 0 : p <= str + idx; len++)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001153 {
1154 if (*p == NUL)
1155 return;
Christian Brabandt67672ef2023-04-24 21:09:54 +01001156 if (utf16idx)
1157 {
1158 idx--;
1159 int clen = ptr2len(p);
1160 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1161 if (c > 0xFFFF)
1162 idx--;
1163 }
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001164 p += ptr2len(p);
1165 }
1166
1167 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1168}
1169
1170/*
1171 * "str2list()" function
1172 */
1173 void
1174f_str2list(typval_T *argvars, typval_T *rettv)
1175{
1176 char_u *p;
1177 int utf8 = FALSE;
1178
1179 if (rettv_list_alloc(rettv) == FAIL)
1180 return;
1181
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001182 if (in_vim9script()
1183 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001184 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001185 return;
1186
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001187 if (argvars[1].v_type != VAR_UNKNOWN)
1188 utf8 = (int)tv_get_bool_chk(&argvars[1], NULL);
1189
1190 p = tv_get_string(&argvars[0]);
1191
1192 if (has_mbyte || utf8)
1193 {
1194 int (*ptr2len)(char_u *);
1195 int (*ptr2char)(char_u *);
1196
1197 if (utf8 || enc_utf8)
1198 {
1199 ptr2len = utf_ptr2len;
1200 ptr2char = utf_ptr2char;
1201 }
1202 else
1203 {
1204 ptr2len = mb_ptr2len;
1205 ptr2char = mb_ptr2char;
1206 }
1207
1208 for ( ; *p != NUL; p += (*ptr2len)(p))
1209 list_append_number(rettv->vval.v_list, (*ptr2char)(p));
1210 }
1211 else
1212 for ( ; *p != NUL; ++p)
1213 list_append_number(rettv->vval.v_list, *p);
1214}
1215
1216/*
1217 * "str2nr()" function
1218 */
1219 void
1220f_str2nr(typval_T *argvars, typval_T *rettv)
1221{
1222 int base = 10;
1223 char_u *p;
1224 varnumber_T n;
1225 int what = 0;
1226 int isneg;
1227
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001228 if (in_vim9script()
1229 && (check_for_string_arg(argvars, 0) == FAIL
1230 || check_for_opt_number_arg(argvars, 1) == FAIL
1231 || (argvars[1].v_type != VAR_UNKNOWN
1232 && check_for_opt_bool_arg(argvars, 2) == FAIL)))
1233 return;
1234
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001235 if (argvars[1].v_type != VAR_UNKNOWN)
1236 {
1237 base = (int)tv_get_number(&argvars[1]);
1238 if (base != 2 && base != 8 && base != 10 && base != 16)
1239 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001240 emsg(_(e_invalid_argument));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001241 return;
1242 }
1243 if (argvars[2].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[2]))
1244 what |= STR2NR_QUOTE;
1245 }
1246
1247 p = skipwhite(tv_get_string_strict(&argvars[0]));
1248 isneg = (*p == '-');
1249 if (*p == '+' || *p == '-')
1250 p = skipwhite(p + 1);
1251 switch (base)
1252 {
1253 case 2: what |= STR2NR_BIN + STR2NR_FORCE; break;
1254 case 8: what |= STR2NR_OCT + STR2NR_OOCT + STR2NR_FORCE; break;
1255 case 16: what |= STR2NR_HEX + STR2NR_FORCE; break;
1256 }
Bram Moolenaar5fb78c32023-03-04 20:47:39 +00001257 vim_str2nr(p, NULL, NULL, what, &n, NULL, 0, FALSE, NULL);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001258 // Text after the number is silently ignored.
1259 if (isneg)
1260 rettv->vval.v_number = -n;
1261 else
1262 rettv->vval.v_number = n;
1263
1264}
1265
1266/*
1267 * "strgetchar()" function
1268 */
1269 void
1270f_strgetchar(typval_T *argvars, typval_T *rettv)
1271{
1272 char_u *str;
1273 int len;
1274 int error = FALSE;
1275 int charidx;
1276 int byteidx = 0;
1277
1278 rettv->vval.v_number = -1;
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001279
1280 if (in_vim9script()
1281 && (check_for_string_arg(argvars, 0) == FAIL
1282 || check_for_number_arg(argvars, 1) == FAIL))
1283 return;
1284
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001285 str = tv_get_string_chk(&argvars[0]);
1286 if (str == NULL)
1287 return;
1288 len = (int)STRLEN(str);
1289 charidx = (int)tv_get_number_chk(&argvars[1], &error);
1290 if (error)
1291 return;
1292
1293 while (charidx >= 0 && byteidx < len)
1294 {
1295 if (charidx == 0)
1296 {
1297 rettv->vval.v_number = mb_ptr2char(str + byteidx);
1298 break;
1299 }
1300 --charidx;
1301 byteidx += MB_CPTR2LEN(str + byteidx);
1302 }
1303}
1304
1305/*
1306 * "stridx()" function
1307 */
1308 void
1309f_stridx(typval_T *argvars, typval_T *rettv)
1310{
1311 char_u buf[NUMBUFLEN];
1312 char_u *needle;
1313 char_u *haystack;
1314 char_u *save_haystack;
1315 char_u *pos;
1316 int start_idx;
1317
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001318 if (in_vim9script()
1319 && (check_for_string_arg(argvars, 0) == FAIL
1320 || check_for_string_arg(argvars, 1) == FAIL
1321 || check_for_opt_number_arg(argvars, 2) == FAIL))
1322 return;
1323
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001324 needle = tv_get_string_chk(&argvars[1]);
1325 save_haystack = haystack = tv_get_string_buf_chk(&argvars[0], buf);
1326 rettv->vval.v_number = -1;
1327 if (needle == NULL || haystack == NULL)
1328 return; // type error; errmsg already given
1329
1330 if (argvars[2].v_type != VAR_UNKNOWN)
1331 {
1332 int error = FALSE;
1333
1334 start_idx = (int)tv_get_number_chk(&argvars[2], &error);
1335 if (error || start_idx >= (int)STRLEN(haystack))
1336 return;
1337 if (start_idx >= 0)
1338 haystack += start_idx;
1339 }
1340
1341 pos = (char_u *)strstr((char *)haystack, (char *)needle);
1342 if (pos != NULL)
1343 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
1344}
1345
1346/*
1347 * "string()" function
1348 */
1349 void
1350f_string(typval_T *argvars, typval_T *rettv)
1351{
1352 char_u *tofree;
1353 char_u numbuf[NUMBUFLEN];
1354
1355 rettv->v_type = VAR_STRING;
1356 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf,
1357 get_copyID());
1358 // Make a copy if we have a value but it's not in allocated memory.
1359 if (rettv->vval.v_string != NULL && tofree == NULL)
1360 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
1361}
1362
1363/*
1364 * "strlen()" function
1365 */
1366 void
1367f_strlen(typval_T *argvars, typval_T *rettv)
1368{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001369 if (in_vim9script()
1370 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1371 return;
1372
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001373 rettv->vval.v_number = (varnumber_T)(STRLEN(
1374 tv_get_string(&argvars[0])));
1375}
1376
1377 static void
1378strchar_common(typval_T *argvars, typval_T *rettv, int skipcc)
1379{
1380 char_u *s = tv_get_string(&argvars[0]);
1381 varnumber_T len = 0;
1382 int (*func_mb_ptr2char_adv)(char_u **pp);
1383
1384 func_mb_ptr2char_adv = skipcc ? mb_ptr2char_adv : mb_cptr2char_adv;
1385 while (*s != NUL)
1386 {
1387 func_mb_ptr2char_adv(&s);
1388 ++len;
1389 }
1390 rettv->vval.v_number = len;
1391}
1392
1393/*
1394 * "strcharlen()" function
1395 */
1396 void
1397f_strcharlen(typval_T *argvars, typval_T *rettv)
1398{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001399 if (in_vim9script()
1400 && check_for_string_or_number_arg(argvars, 0) == FAIL)
1401 return;
1402
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001403 strchar_common(argvars, rettv, TRUE);
1404}
1405
1406/*
1407 * "strchars()" function
1408 */
1409 void
1410f_strchars(typval_T *argvars, typval_T *rettv)
1411{
1412 varnumber_T skipcc = FALSE;
1413
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001414 if (in_vim9script()
1415 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001416 || check_for_opt_bool_arg(argvars, 1) == FAIL))
Yegappan Lakshmanana9a7c0c2021-07-17 19:11:07 +02001417 return;
1418
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001419 if (argvars[1].v_type != VAR_UNKNOWN)
1420 skipcc = tv_get_bool(&argvars[1]);
1421 if (skipcc < 0 || skipcc > 1)
1422 semsg(_(e_using_number_as_bool_nr), skipcc);
1423 else
1424 strchar_common(argvars, rettv, skipcc);
1425}
1426
1427/*
Christian Brabandt67672ef2023-04-24 21:09:54 +01001428 * "strutf16len()" function
1429 */
1430 void
1431f_strutf16len(typval_T *argvars, typval_T *rettv)
1432{
1433 rettv->vval.v_number = -1;
1434
1435 if (check_for_string_arg(argvars, 0) == FAIL
1436 || check_for_opt_bool_arg(argvars, 1) == FAIL)
1437 return;
1438
1439 varnumber_T countcc = FALSE;
1440 if (argvars[1].v_type != VAR_UNKNOWN)
1441 countcc = tv_get_bool(&argvars[1]);
1442
1443 char_u *s = tv_get_string(&argvars[0]);
1444 varnumber_T len = 0;
1445 int (*func_mb_ptr2char_adv)(char_u **pp);
1446 int ch;
1447
1448 func_mb_ptr2char_adv = countcc ? mb_cptr2char_adv : mb_ptr2char_adv;
1449 while (*s != NUL)
1450 {
1451 ch = func_mb_ptr2char_adv(&s);
1452 if (ch > 0xFFFF)
1453 ++len;
1454 ++len;
1455 }
1456 rettv->vval.v_number = len;
1457}
1458
1459/*
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001460 * "strdisplaywidth()" function
1461 */
1462 void
1463f_strdisplaywidth(typval_T *argvars, typval_T *rettv)
1464{
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001465 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001466 int col = 0;
1467
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001468 rettv->vval.v_number = -1;
1469
1470 if (in_vim9script()
1471 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001472 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001473 return;
1474
1475 s = tv_get_string(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001476 if (argvars[1].v_type != VAR_UNKNOWN)
1477 col = (int)tv_get_number(&argvars[1]);
1478
1479 rettv->vval.v_number = (varnumber_T)(linetabsize_col(col, s) - col);
1480}
1481
1482/*
1483 * "strwidth()" function
1484 */
1485 void
1486f_strwidth(typval_T *argvars, typval_T *rettv)
1487{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001488 char_u *s;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001489
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001490 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1491 return;
1492
1493 s = tv_get_string_strict(&argvars[0]);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001494 rettv->vval.v_number = (varnumber_T)(mb_string2cells(s, -1));
1495}
1496
1497/*
1498 * "strcharpart()" function
1499 */
1500 void
1501f_strcharpart(typval_T *argvars, typval_T *rettv)
1502{
1503 char_u *p;
1504 int nchar;
1505 int nbyte = 0;
1506 int charlen;
1507 int skipcc = FALSE;
1508 int len = 0;
1509 int slen;
1510 int error = FALSE;
1511
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001512 if (in_vim9script()
1513 && (check_for_string_arg(argvars, 0) == FAIL
1514 || check_for_number_arg(argvars, 1) == FAIL
1515 || check_for_opt_number_arg(argvars, 2) == FAIL
1516 || (argvars[2].v_type != VAR_UNKNOWN
1517 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1518 return;
1519
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001520 p = tv_get_string(&argvars[0]);
1521 slen = (int)STRLEN(p);
1522
1523 nchar = (int)tv_get_number_chk(&argvars[1], &error);
1524 if (!error)
1525 {
1526 if (argvars[2].v_type != VAR_UNKNOWN
1527 && argvars[3].v_type != VAR_UNKNOWN)
1528 {
1529 skipcc = tv_get_bool(&argvars[3]);
1530 if (skipcc < 0 || skipcc > 1)
1531 {
1532 semsg(_(e_using_number_as_bool_nr), skipcc);
1533 return;
1534 }
1535 }
1536
1537 if (nchar > 0)
1538 while (nchar > 0 && nbyte < slen)
1539 {
1540 if (skipcc)
1541 nbyte += mb_ptr2len(p + nbyte);
1542 else
1543 nbyte += MB_CPTR2LEN(p + nbyte);
1544 --nchar;
1545 }
1546 else
1547 nbyte = nchar;
1548 if (argvars[2].v_type != VAR_UNKNOWN)
1549 {
1550 charlen = (int)tv_get_number(&argvars[2]);
1551 while (charlen > 0 && nbyte + len < slen)
1552 {
1553 int off = nbyte + len;
1554
1555 if (off < 0)
1556 len += 1;
1557 else
1558 {
1559 if (skipcc)
1560 len += mb_ptr2len(p + off);
1561 else
1562 len += MB_CPTR2LEN(p + off);
1563 }
1564 --charlen;
1565 }
1566 }
1567 else
1568 len = slen - nbyte; // default: all bytes that are available.
1569 }
1570
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02001571 // Only return the overlap between the specified part and the actual
1572 // string.
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001573 if (nbyte < 0)
1574 {
1575 len += nbyte;
1576 nbyte = 0;
1577 }
1578 else if (nbyte > slen)
1579 nbyte = slen;
1580 if (len < 0)
1581 len = 0;
1582 else if (nbyte + len > slen)
1583 len = slen - nbyte;
1584
1585 rettv->v_type = VAR_STRING;
1586 rettv->vval.v_string = vim_strnsave(p + nbyte, len);
1587}
1588
1589/*
1590 * "strpart()" function
1591 */
1592 void
1593f_strpart(typval_T *argvars, typval_T *rettv)
1594{
1595 char_u *p;
1596 int n;
1597 int len;
1598 int slen;
1599 int error = FALSE;
1600
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001601 if (in_vim9script()
1602 && (check_for_string_arg(argvars, 0) == FAIL
1603 || check_for_number_arg(argvars, 1) == FAIL
1604 || check_for_opt_number_arg(argvars, 2) == FAIL
1605 || (argvars[2].v_type != VAR_UNKNOWN
1606 && check_for_opt_bool_arg(argvars, 3) == FAIL)))
1607 return;
1608
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001609 p = tv_get_string(&argvars[0]);
1610 slen = (int)STRLEN(p);
1611
1612 n = (int)tv_get_number_chk(&argvars[1], &error);
1613 if (error)
1614 len = 0;
1615 else if (argvars[2].v_type != VAR_UNKNOWN)
1616 len = (int)tv_get_number(&argvars[2]);
1617 else
1618 len = slen - n; // default len: all bytes that are available.
1619
1620 // Only return the overlap between the specified part and the actual
1621 // string.
1622 if (n < 0)
1623 {
1624 len += n;
1625 n = 0;
1626 }
1627 else if (n > slen)
1628 n = slen;
1629 if (len < 0)
1630 len = 0;
1631 else if (n + len > slen)
1632 len = slen - n;
1633
1634 if (argvars[2].v_type != VAR_UNKNOWN && argvars[3].v_type != VAR_UNKNOWN)
1635 {
1636 int off;
1637
1638 // length in characters
1639 for (off = n; off < slen && len > 0; --len)
1640 off += mb_ptr2len(p + off);
1641 len = off - n;
1642 }
1643
1644 rettv->v_type = VAR_STRING;
1645 rettv->vval.v_string = vim_strnsave(p + n, len);
1646}
1647
1648/*
1649 * "strridx()" function
1650 */
1651 void
1652f_strridx(typval_T *argvars, typval_T *rettv)
1653{
1654 char_u buf[NUMBUFLEN];
1655 char_u *needle;
1656 char_u *haystack;
1657 char_u *rest;
1658 char_u *lastmatch = NULL;
1659 int haystack_len, end_idx;
1660
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001661 if (in_vim9script()
1662 && (check_for_string_arg(argvars, 0) == FAIL
1663 || check_for_string_arg(argvars, 1) == FAIL
1664 || check_for_opt_number_arg(argvars, 2) == FAIL))
1665 return;
1666
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001667 needle = tv_get_string_chk(&argvars[1]);
1668 haystack = tv_get_string_buf_chk(&argvars[0], buf);
1669
1670 rettv->vval.v_number = -1;
1671 if (needle == NULL || haystack == NULL)
1672 return; // type error; errmsg already given
1673
1674 haystack_len = (int)STRLEN(haystack);
1675 if (argvars[2].v_type != VAR_UNKNOWN)
1676 {
1677 // Third argument: upper limit for index
1678 end_idx = (int)tv_get_number_chk(&argvars[2], NULL);
1679 if (end_idx < 0)
1680 return; // can never find a match
1681 }
1682 else
1683 end_idx = haystack_len;
1684
1685 if (*needle == NUL)
1686 {
1687 // Empty string matches past the end.
1688 lastmatch = haystack + end_idx;
1689 }
1690 else
1691 {
1692 for (rest = haystack; *rest != '\0'; ++rest)
1693 {
1694 rest = (char_u *)strstr((char *)rest, (char *)needle);
1695 if (rest == NULL || rest > haystack + end_idx)
1696 break;
1697 lastmatch = rest;
1698 }
1699 }
1700
1701 if (lastmatch == NULL)
1702 rettv->vval.v_number = -1;
1703 else
1704 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
1705}
1706
1707/*
1708 * "strtrans()" function
1709 */
1710 void
1711f_strtrans(typval_T *argvars, typval_T *rettv)
1712{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001713 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1714 return;
1715
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001716 rettv->v_type = VAR_STRING;
1717 rettv->vval.v_string = transstr(tv_get_string(&argvars[0]));
1718}
1719
Christian Brabandt67672ef2023-04-24 21:09:54 +01001720
1721/*
1722 *
1723 * "utf16idx()" function
1724 */
1725 void
1726f_utf16idx(typval_T *argvars, typval_T *rettv)
1727{
1728 rettv->vval.v_number = -1;
1729
1730 if (check_for_string_arg(argvars, 0) == FAIL
1731 || check_for_opt_number_arg(argvars, 1) == FAIL
1732 || check_for_opt_bool_arg(argvars, 2) == FAIL
1733 || (argvars[2].v_type != VAR_UNKNOWN
1734 && check_for_opt_bool_arg(argvars, 3) == FAIL))
1735 return;
1736
1737 char_u *str = tv_get_string_chk(&argvars[0]);
1738 varnumber_T idx = tv_get_number_chk(&argvars[1], NULL);
1739 if (str == NULL || idx < 0)
1740 return;
1741
1742 varnumber_T countcc = FALSE;
1743 varnumber_T charidx = FALSE;
1744 if (argvars[2].v_type != VAR_UNKNOWN)
1745 {
1746 countcc = tv_get_bool(&argvars[2]);
1747 if (argvars[3].v_type != VAR_UNKNOWN)
1748 charidx = tv_get_bool(&argvars[3]);
1749 }
1750
1751 int (*ptr2len)(char_u *);
1752 if (enc_utf8 && countcc)
1753 ptr2len = utf_ptr2len;
1754 else
1755 ptr2len = mb_ptr2len;
1756
1757 char_u *p;
1758 int len;
1759 for (p = str, len = 0; charidx ? idx >= 0 : p <= str + idx; len++)
1760 {
1761 if (*p == NUL)
1762 return;
1763 int clen = ptr2len(p);
1764 int c = (clen > 1) ? utf_ptr2char(p) : *p;
1765 if (c > 0xFFFF)
1766 len++;
1767 p += ptr2len(p);
1768 if (charidx)
1769 idx--;
1770 }
1771
1772 rettv->vval.v_number = len > 0 ? len - 1 : 0;
1773}
1774
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001775/*
1776 * "tolower(string)" function
1777 */
1778 void
1779f_tolower(typval_T *argvars, typval_T *rettv)
1780{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001781 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1782 return;
1783
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001784 rettv->v_type = VAR_STRING;
1785 rettv->vval.v_string = strlow_save(tv_get_string(&argvars[0]));
1786}
1787
1788/*
1789 * "toupper(string)" function
1790 */
1791 void
1792f_toupper(typval_T *argvars, typval_T *rettv)
1793{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001794 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1795 return;
1796
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001797 rettv->v_type = VAR_STRING;
1798 rettv->vval.v_string = strup_save(tv_get_string(&argvars[0]));
1799}
1800
1801/*
1802 * "tr(string, fromstr, tostr)" function
1803 */
1804 void
1805f_tr(typval_T *argvars, typval_T *rettv)
1806{
1807 char_u *in_str;
1808 char_u *fromstr;
1809 char_u *tostr;
1810 char_u *p;
1811 int inlen;
1812 int fromlen;
1813 int tolen;
1814 int idx;
1815 char_u *cpstr;
1816 int cplen;
1817 int first = TRUE;
1818 char_u buf[NUMBUFLEN];
1819 char_u buf2[NUMBUFLEN];
1820 garray_T ga;
1821
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001822 if (in_vim9script()
1823 && (check_for_string_arg(argvars, 0) == FAIL
1824 || check_for_string_arg(argvars, 1) == FAIL
1825 || check_for_string_arg(argvars, 2) == FAIL))
1826 return;
1827
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001828 in_str = tv_get_string(&argvars[0]);
1829 fromstr = tv_get_string_buf_chk(&argvars[1], buf);
1830 tostr = tv_get_string_buf_chk(&argvars[2], buf2);
1831
1832 // Default return value: empty string.
1833 rettv->v_type = VAR_STRING;
1834 rettv->vval.v_string = NULL;
1835 if (fromstr == NULL || tostr == NULL)
1836 return; // type error; errmsg already given
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001837 ga_init2(&ga, sizeof(char), 80);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001838
1839 if (!has_mbyte)
1840 // not multi-byte: fromstr and tostr must be the same length
1841 if (STRLEN(fromstr) != STRLEN(tostr))
1842 {
1843error:
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001844 semsg(_(e_invalid_argument_str), fromstr);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001845 ga_clear(&ga);
1846 return;
1847 }
1848
1849 // fromstr and tostr have to contain the same number of chars
1850 while (*in_str != NUL)
1851 {
1852 if (has_mbyte)
1853 {
1854 inlen = (*mb_ptr2len)(in_str);
1855 cpstr = in_str;
1856 cplen = inlen;
1857 idx = 0;
1858 for (p = fromstr; *p != NUL; p += fromlen)
1859 {
1860 fromlen = (*mb_ptr2len)(p);
1861 if (fromlen == inlen && STRNCMP(in_str, p, inlen) == 0)
1862 {
1863 for (p = tostr; *p != NUL; p += tolen)
1864 {
1865 tolen = (*mb_ptr2len)(p);
1866 if (idx-- == 0)
1867 {
1868 cplen = tolen;
1869 cpstr = p;
1870 break;
1871 }
1872 }
1873 if (*p == NUL) // tostr is shorter than fromstr
1874 goto error;
1875 break;
1876 }
1877 ++idx;
1878 }
1879
1880 if (first && cpstr == in_str)
1881 {
1882 // Check that fromstr and tostr have the same number of
1883 // (multi-byte) characters. Done only once when a character
1884 // of in_str doesn't appear in fromstr.
1885 first = FALSE;
1886 for (p = tostr; *p != NUL; p += tolen)
1887 {
1888 tolen = (*mb_ptr2len)(p);
1889 --idx;
1890 }
1891 if (idx != 0)
1892 goto error;
1893 }
1894
1895 (void)ga_grow(&ga, cplen);
1896 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
1897 ga.ga_len += cplen;
1898
1899 in_str += inlen;
1900 }
1901 else
1902 {
1903 // When not using multi-byte chars we can do it faster.
1904 p = vim_strchr(fromstr, *in_str);
1905 if (p != NULL)
1906 ga_append(&ga, tostr[p - fromstr]);
1907 else
1908 ga_append(&ga, *in_str);
1909 ++in_str;
1910 }
1911 }
1912
1913 // add a terminating NUL
1914 (void)ga_grow(&ga, 1);
1915 ga_append(&ga, NUL);
1916
1917 rettv->vval.v_string = ga.ga_data;
1918}
1919
1920/*
1921 * "trim({expr})" function
1922 */
1923 void
1924f_trim(typval_T *argvars, typval_T *rettv)
1925{
1926 char_u buf1[NUMBUFLEN];
1927 char_u buf2[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001928 char_u *head;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001929 char_u *mask = NULL;
1930 char_u *tail;
1931 char_u *prev;
1932 char_u *p;
1933 int c1;
1934 int dir = 0;
1935
1936 rettv->v_type = VAR_STRING;
1937 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001938
1939 if (in_vim9script()
1940 && (check_for_string_arg(argvars, 0) == FAIL
1941 || check_for_opt_string_arg(argvars, 1) == FAIL
1942 || (argvars[1].v_type != VAR_UNKNOWN
1943 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1944 return;
1945
1946 head = tv_get_string_buf_chk(&argvars[0], buf1);
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001947 if (head == NULL)
1948 return;
1949
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +01001950 if (check_for_opt_string_arg(argvars, 1) == FAIL)
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001951 return;
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001952
1953 if (argvars[1].v_type == VAR_STRING)
1954 {
1955 mask = tv_get_string_buf_chk(&argvars[1], buf2);
1956
1957 if (argvars[2].v_type != VAR_UNKNOWN)
1958 {
1959 int error = 0;
1960
1961 // leading or trailing characters to trim
1962 dir = (int)tv_get_number_chk(&argvars[2], &error);
1963 if (error)
1964 return;
1965 if (dir < 0 || dir > 2)
1966 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001967 semsg(_(e_invalid_argument_str), tv_get_string(&argvars[2]));
Yegappan Lakshmanana2438132021-07-10 21:29:18 +02001968 return;
1969 }
1970 }
1971 }
1972
1973 if (dir == 0 || dir == 1)
1974 {
1975 // Trim leading characters
1976 while (*head != NUL)
1977 {
1978 c1 = PTR2CHAR(head);
1979 if (mask == NULL)
1980 {
1981 if (c1 > ' ' && c1 != 0xa0)
1982 break;
1983 }
1984 else
1985 {
1986 for (p = mask; *p != NUL; MB_PTR_ADV(p))
1987 if (c1 == PTR2CHAR(p))
1988 break;
1989 if (*p == NUL)
1990 break;
1991 }
1992 MB_PTR_ADV(head);
1993 }
1994 }
1995
1996 tail = head + STRLEN(head);
1997 if (dir == 0 || dir == 2)
1998 {
1999 // Trim trailing characters
2000 for (; tail > head; tail = prev)
2001 {
2002 prev = tail;
2003 MB_PTR_BACK(head, prev);
2004 c1 = PTR2CHAR(prev);
2005 if (mask == NULL)
2006 {
2007 if (c1 > ' ' && c1 != 0xa0)
2008 break;
2009 }
2010 else
2011 {
2012 for (p = mask; *p != NUL; MB_PTR_ADV(p))
2013 if (c1 == PTR2CHAR(p))
2014 break;
2015 if (*p == NUL)
2016 break;
2017 }
2018 }
2019 }
2020 rettv->vval.v_string = vim_strnsave(head, tail - head);
2021}
2022
Bram Moolenaar677658a2022-01-05 16:09:06 +00002023static char *e_printf = N_(e_insufficient_arguments_for_printf);
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002024
2025/*
2026 * Get number argument from "idxp" entry in "tvs". First entry is 1.
2027 */
2028 static varnumber_T
2029tv_nr(typval_T *tvs, int *idxp)
2030{
2031 int idx = *idxp - 1;
2032 varnumber_T n = 0;
2033 int err = FALSE;
2034
2035 if (tvs[idx].v_type == VAR_UNKNOWN)
2036 emsg(_(e_printf));
2037 else
2038 {
2039 ++*idxp;
2040 n = tv_get_number_chk(&tvs[idx], &err);
2041 if (err)
2042 n = 0;
2043 }
2044 return n;
2045}
2046
2047/*
2048 * Get string argument from "idxp" entry in "tvs". First entry is 1.
2049 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
2050 * are not converted to a string.
2051 * If "tofree" is not NULL echo_string() is used. All types are converted to
2052 * a string with the same format as ":echo". The caller must free "*tofree".
2053 * Returns NULL for an error.
2054 */
2055 static char *
2056tv_str(typval_T *tvs, int *idxp, char_u **tofree)
2057{
2058 int idx = *idxp - 1;
2059 char *s = NULL;
2060 static char_u numbuf[NUMBUFLEN];
2061
2062 if (tvs[idx].v_type == VAR_UNKNOWN)
2063 emsg(_(e_printf));
2064 else
2065 {
2066 ++*idxp;
2067 if (tofree != NULL)
2068 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
2069 else
2070 s = (char *)tv_get_string_chk(&tvs[idx]);
2071 }
2072 return s;
2073}
2074
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002075/*
2076 * Get float argument from "idxp" entry in "tvs". First entry is 1.
2077 */
2078 static double
2079tv_float(typval_T *tvs, int *idxp)
2080{
2081 int idx = *idxp - 1;
2082 double f = 0;
2083
2084 if (tvs[idx].v_type == VAR_UNKNOWN)
2085 emsg(_(e_printf));
2086 else
2087 {
2088 ++*idxp;
2089 if (tvs[idx].v_type == VAR_FLOAT)
2090 f = tvs[idx].vval.v_float;
2091 else if (tvs[idx].v_type == VAR_NUMBER)
2092 f = (double)tvs[idx].vval.v_number;
2093 else
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00002094 emsg(_(e_expected_float_argument_for_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002095 }
2096 return f;
2097}
Yegappan Lakshmananf973eeb2021-12-22 18:19:26 +00002098
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002099#endif
2100
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002101/*
2102 * Return the representation of infinity for printf() function:
2103 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
2104 */
2105 static const char *
2106infinity_str(int positive,
2107 char fmt_spec,
2108 int force_sign,
2109 int space_for_positive)
2110{
2111 static const char *table[] =
2112 {
2113 "-inf", "inf", "+inf", " inf",
2114 "-INF", "INF", "+INF", " INF"
2115 };
2116 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
2117
2118 if (ASCII_ISUPPER(fmt_spec))
2119 idx += 4;
2120 return table[idx];
2121}
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002122
2123/*
2124 * This code was included to provide a portable vsnprintf() and snprintf().
2125 * Some systems may provide their own, but we always use this one for
2126 * consistency.
2127 *
2128 * This code is based on snprintf.c - a portable implementation of snprintf
2129 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
2130 * Included with permission. It was heavily modified to fit in Vim.
2131 * The original code, including useful comments, can be found here:
2132 * http://www.ijs.si/software/snprintf/
2133 *
2134 * This snprintf() only supports the following conversion specifiers:
2135 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
2136 * with flags: '-', '+', ' ', '0' and '#'.
2137 * An asterisk is supported for field width as well as precision.
2138 *
2139 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
2140 *
2141 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
2142 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
2143 *
2144 * The locale is not used, the string is used as a byte string. This is only
2145 * relevant for double-byte encodings where the second byte may be '%'.
2146 *
2147 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
2148 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
2149 *
2150 * The return value is the number of characters which would be generated
2151 * for the given input, excluding the trailing NUL. If this value
2152 * is greater or equal to "str_m", not all characters from the result
2153 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
2154 * are discarded. If "str_m" is greater than zero it is guaranteed
2155 * the resulting string will be NUL-terminated.
2156 */
2157
2158/*
2159 * When va_list is not supported we only define vim_snprintf().
2160 *
2161 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
2162 * "typval_T". When the latter is not used it must be NULL.
2163 */
2164
2165// When generating prototypes all of this is skipped, cproto doesn't
2166// understand this.
2167#ifndef PROTO
2168
2169// Like vim_vsnprintf() but append to the string.
2170 int
2171vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
2172{
2173 va_list ap;
2174 int str_l;
2175 size_t len = STRLEN(str);
2176 size_t space;
2177
2178 if (str_m <= len)
2179 space = 0;
2180 else
2181 space = str_m - len;
2182 va_start(ap, fmt);
2183 str_l = vim_vsnprintf(str + len, space, fmt, ap);
2184 va_end(ap);
2185 return str_l;
2186}
2187
2188 int
2189vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
2190{
2191 va_list ap;
2192 int str_l;
2193
2194 va_start(ap, fmt);
2195 str_l = vim_vsnprintf(str, str_m, fmt, ap);
2196 va_end(ap);
2197 return str_l;
2198}
2199
2200 int
2201vim_vsnprintf(
2202 char *str,
2203 size_t str_m,
2204 const char *fmt,
2205 va_list ap)
2206{
2207 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
2208}
2209
2210 int
2211vim_vsnprintf_typval(
2212 char *str,
2213 size_t str_m,
2214 const char *fmt,
2215 va_list ap,
2216 typval_T *tvs)
2217{
2218 size_t str_l = 0;
2219 const char *p = fmt;
2220 int arg_idx = 1;
2221
2222 if (p == NULL)
2223 p = "";
2224 while (*p != NUL)
2225 {
2226 if (*p != '%')
2227 {
2228 char *q = strchr(p + 1, '%');
2229 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
2230
2231 // Copy up to the next '%' or NUL without any changes.
2232 if (str_l < str_m)
2233 {
2234 size_t avail = str_m - str_l;
2235
2236 mch_memmove(str + str_l, p, n > avail ? avail : n);
2237 }
2238 p += n;
2239 str_l += n;
2240 }
2241 else
2242 {
2243 size_t min_field_width = 0, precision = 0;
2244 int zero_padding = 0, precision_specified = 0, justify_left = 0;
2245 int alternate_form = 0, force_sign = 0;
2246
2247 // If both the ' ' and '+' flags appear, the ' ' flag should be
2248 // ignored.
2249 int space_for_positive = 1;
2250
2251 // allowed values: \0, h, l, L
2252 char length_modifier = '\0';
2253
2254 // temporary buffer for simple numeric->string conversion
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002255# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002256 // That sounds reasonable to use as the maximum
2257 // printable.
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002258 char tmp[TMP_LEN];
2259
2260 // string address in case of string argument
2261 const char *str_arg = NULL;
2262
2263 // natural field width of arg without padding and sign
2264 size_t str_arg_l;
2265
2266 // unsigned char argument value - only defined for c conversion.
2267 // N.B. standard explicitly states the char argument for the c
2268 // conversion is unsigned
2269 unsigned char uchar_arg;
2270
2271 // number of zeros to be inserted for numeric conversions as
2272 // required by the precision or minimal field width
2273 size_t number_of_zeros_to_pad = 0;
2274
2275 // index into tmp where zero padding is to be inserted
2276 size_t zero_padding_insertion_ind = 0;
2277
2278 // current conversion specifier character
2279 char fmt_spec = '\0';
2280
2281 // buffer for 's' and 'S' specs
2282 char_u *tofree = NULL;
2283
2284
2285 p++; // skip '%'
2286
2287 // parse flags
2288 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
2289 || *p == '#' || *p == '\'')
2290 {
2291 switch (*p)
2292 {
2293 case '0': zero_padding = 1; break;
2294 case '-': justify_left = 1; break;
2295 case '+': force_sign = 1; space_for_positive = 0; break;
2296 case ' ': force_sign = 1;
2297 // If both the ' ' and '+' flags appear, the ' '
2298 // flag should be ignored
2299 break;
2300 case '#': alternate_form = 1; break;
2301 case '\'': break;
2302 }
2303 p++;
2304 }
2305 // If the '0' and '-' flags both appear, the '0' flag should be
2306 // ignored.
2307
2308 // parse field width
2309 if (*p == '*')
2310 {
2311 int j;
2312
2313 p++;
2314 j =
2315# if defined(FEAT_EVAL)
2316 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2317# endif
2318 va_arg(ap, int);
2319 if (j >= 0)
2320 min_field_width = j;
2321 else
2322 {
2323 min_field_width = -j;
2324 justify_left = 1;
2325 }
2326 }
2327 else if (VIM_ISDIGIT((int)(*p)))
2328 {
2329 // size_t could be wider than unsigned int; make sure we treat
2330 // argument like common implementations do
2331 unsigned int uj = *p++ - '0';
2332
2333 while (VIM_ISDIGIT((int)(*p)))
2334 uj = 10 * uj + (unsigned int)(*p++ - '0');
2335 min_field_width = uj;
2336 }
2337
2338 // parse precision
2339 if (*p == '.')
2340 {
2341 p++;
2342 precision_specified = 1;
2343 if (*p == '*')
2344 {
2345 int j;
2346
2347 j =
2348# if defined(FEAT_EVAL)
2349 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2350# endif
2351 va_arg(ap, int);
2352 p++;
2353 if (j >= 0)
2354 precision = j;
2355 else
2356 {
2357 precision_specified = 0;
2358 precision = 0;
2359 }
2360 }
2361 else if (VIM_ISDIGIT((int)(*p)))
2362 {
2363 // size_t could be wider than unsigned int; make sure we
2364 // treat argument like common implementations do
2365 unsigned int uj = *p++ - '0';
2366
2367 while (VIM_ISDIGIT((int)(*p)))
2368 uj = 10 * uj + (unsigned int)(*p++ - '0');
2369 precision = uj;
2370 }
2371 }
2372
2373 // parse 'h', 'l' and 'll' length modifiers
2374 if (*p == 'h' || *p == 'l')
2375 {
2376 length_modifier = *p;
2377 p++;
2378 if (length_modifier == 'l' && *p == 'l')
2379 {
2380 // double l = __int64 / varnumber_T
2381 length_modifier = 'L';
2382 p++;
2383 }
2384 }
2385 fmt_spec = *p;
2386
2387 // common synonyms:
2388 switch (fmt_spec)
2389 {
2390 case 'i': fmt_spec = 'd'; break;
2391 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
2392 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
2393 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
2394 default: break;
2395 }
2396
2397# if defined(FEAT_EVAL)
2398 switch (fmt_spec)
2399 {
2400 case 'd': case 'u': case 'o': case 'x': case 'X':
2401 if (tvs != NULL && length_modifier == '\0')
2402 length_modifier = 'L';
2403 }
2404# endif
2405
2406 // get parameter value, do initial processing
2407 switch (fmt_spec)
2408 {
2409 // '%' and 'c' behave similar to 's' regarding flags and field
2410 // widths
2411 case '%':
2412 case 'c':
2413 case 's':
2414 case 'S':
2415 str_arg_l = 1;
2416 switch (fmt_spec)
2417 {
2418 case '%':
2419 str_arg = p;
2420 break;
2421
2422 case 'c':
2423 {
2424 int j;
2425
2426 j =
2427# if defined(FEAT_EVAL)
2428 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2429# endif
2430 va_arg(ap, int);
2431 // standard demands unsigned char
2432 uchar_arg = (unsigned char)j;
2433 str_arg = (char *)&uchar_arg;
2434 break;
2435 }
2436
2437 case 's':
2438 case 'S':
2439 str_arg =
2440# if defined(FEAT_EVAL)
2441 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
2442# endif
2443 va_arg(ap, char *);
2444 if (str_arg == NULL)
2445 {
2446 str_arg = "[NULL]";
2447 str_arg_l = 6;
2448 }
2449 // make sure not to address string beyond the specified
2450 // precision !!!
2451 else if (!precision_specified)
2452 str_arg_l = strlen(str_arg);
2453 // truncate string if necessary as requested by precision
2454 else if (precision == 0)
2455 str_arg_l = 0;
2456 else
2457 {
2458 // Don't put the #if inside memchr(), it can be a
2459 // macro.
2460 // memchr on HP does not like n > 2^31 !!!
2461 char *q = memchr(str_arg, '\0',
2462 precision <= (size_t)0x7fffffffL ? precision
2463 : (size_t)0x7fffffffL);
presukud85fccd2021-11-20 19:38:31 +00002464
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002465 str_arg_l = (q == NULL) ? precision
2466 : (size_t)(q - str_arg);
2467 }
2468 if (fmt_spec == 'S')
2469 {
presuku1f2453f2021-11-24 15:32:57 +00002470 char_u *p1;
2471 size_t i;
2472 int cell;
presukud85fccd2021-11-20 19:38:31 +00002473
presuku1f2453f2021-11-24 15:32:57 +00002474 for (i = 0, p1 = (char_u *)str_arg; *p1;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002475 p1 += mb_ptr2len(p1))
presuku1f2453f2021-11-24 15:32:57 +00002476 {
2477 cell = mb_ptr2cells(p1);
2478 if (precision_specified && i + cell > precision)
2479 break;
2480 i += cell;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002481 }
presuku1f2453f2021-11-24 15:32:57 +00002482
2483 str_arg_l = p1 - (char_u *)str_arg;
presukud85fccd2021-11-20 19:38:31 +00002484 if (min_field_width != 0)
presuku1f2453f2021-11-24 15:32:57 +00002485 min_field_width += str_arg_l - i;
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002486 }
2487 break;
2488
2489 default:
2490 break;
2491 }
2492 break;
2493
2494 case 'd': case 'u':
2495 case 'b': case 'B':
2496 case 'o':
2497 case 'x': case 'X':
2498 case 'p':
2499 {
2500 // NOTE: the u, b, o, x, X and p conversion specifiers
2501 // imply the value is unsigned; d implies a signed
2502 // value
2503
2504 // 0 if numeric argument is zero (or if pointer is
2505 // NULL for 'p'), +1 if greater than zero (or nonzero
2506 // for unsigned arguments), -1 if negative (unsigned
2507 // argument is never negative)
2508 int arg_sign = 0;
2509
2510 // only set for length modifier h, or for no length
2511 // modifiers
2512 int int_arg = 0;
2513 unsigned int uint_arg = 0;
2514
2515 // only set for length modifier l
2516 long int long_arg = 0;
2517 unsigned long int ulong_arg = 0;
2518
2519 // only set for length modifier ll
2520 varnumber_T llong_arg = 0;
2521 uvarnumber_T ullong_arg = 0;
2522
2523 // only set for b conversion
2524 uvarnumber_T bin_arg = 0;
2525
2526 // pointer argument value -only defined for p
2527 // conversion
2528 void *ptr_arg = NULL;
2529
2530 if (fmt_spec == 'p')
2531 {
2532 length_modifier = '\0';
2533 ptr_arg =
2534# if defined(FEAT_EVAL)
2535 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
2536 NULL) :
2537# endif
2538 va_arg(ap, void *);
2539 if (ptr_arg != NULL)
2540 arg_sign = 1;
2541 }
2542 else if (fmt_spec == 'b' || fmt_spec == 'B')
2543 {
2544 bin_arg =
2545# if defined(FEAT_EVAL)
2546 tvs != NULL ?
2547 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
2548# endif
2549 va_arg(ap, uvarnumber_T);
2550 if (bin_arg != 0)
2551 arg_sign = 1;
2552 }
2553 else if (fmt_spec == 'd')
2554 {
2555 // signed
2556 switch (length_modifier)
2557 {
2558 case '\0':
2559 case 'h':
2560 // char and short arguments are passed as int.
2561 int_arg =
2562# if defined(FEAT_EVAL)
2563 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2564# endif
2565 va_arg(ap, int);
2566 if (int_arg > 0)
2567 arg_sign = 1;
2568 else if (int_arg < 0)
2569 arg_sign = -1;
2570 break;
2571 case 'l':
2572 long_arg =
2573# if defined(FEAT_EVAL)
2574 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2575# endif
2576 va_arg(ap, long int);
2577 if (long_arg > 0)
2578 arg_sign = 1;
2579 else if (long_arg < 0)
2580 arg_sign = -1;
2581 break;
2582 case 'L':
2583 llong_arg =
2584# if defined(FEAT_EVAL)
2585 tvs != NULL ? tv_nr(tvs, &arg_idx) :
2586# endif
2587 va_arg(ap, varnumber_T);
2588 if (llong_arg > 0)
2589 arg_sign = 1;
2590 else if (llong_arg < 0)
2591 arg_sign = -1;
2592 break;
2593 }
2594 }
2595 else
2596 {
2597 // unsigned
2598 switch (length_modifier)
2599 {
2600 case '\0':
2601 case 'h':
2602 uint_arg =
2603# if defined(FEAT_EVAL)
2604 tvs != NULL ? (unsigned)
2605 tv_nr(tvs, &arg_idx) :
2606# endif
2607 va_arg(ap, unsigned int);
2608 if (uint_arg != 0)
2609 arg_sign = 1;
2610 break;
2611 case 'l':
2612 ulong_arg =
2613# if defined(FEAT_EVAL)
2614 tvs != NULL ? (unsigned long)
2615 tv_nr(tvs, &arg_idx) :
2616# endif
2617 va_arg(ap, unsigned long int);
2618 if (ulong_arg != 0)
2619 arg_sign = 1;
2620 break;
2621 case 'L':
2622 ullong_arg =
2623# if defined(FEAT_EVAL)
2624 tvs != NULL ? (uvarnumber_T)
2625 tv_nr(tvs, &arg_idx) :
2626# endif
2627 va_arg(ap, uvarnumber_T);
2628 if (ullong_arg != 0)
2629 arg_sign = 1;
2630 break;
2631 }
2632 }
2633
2634 str_arg = tmp;
2635 str_arg_l = 0;
2636
2637 // NOTE:
2638 // For d, i, u, o, x, and X conversions, if precision is
2639 // specified, the '0' flag should be ignored. This is so
2640 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
2641 // FreeBSD, NetBSD; but not with Perl.
2642 if (precision_specified)
2643 zero_padding = 0;
2644 if (fmt_spec == 'd')
2645 {
2646 if (force_sign && arg_sign >= 0)
2647 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
2648 // leave negative numbers for sprintf to handle, to
2649 // avoid handling tricky cases like (short int)-32768
2650 }
2651 else if (alternate_form)
2652 {
2653 if (arg_sign != 0
2654 && (fmt_spec == 'b' || fmt_spec == 'B'
2655 || fmt_spec == 'x' || fmt_spec == 'X') )
2656 {
2657 tmp[str_arg_l++] = '0';
2658 tmp[str_arg_l++] = fmt_spec;
2659 }
2660 // alternate form should have no effect for p
2661 // conversion, but ...
2662 }
2663
2664 zero_padding_insertion_ind = str_arg_l;
2665 if (!precision_specified)
2666 precision = 1; // default precision is 1
2667 if (precision == 0 && arg_sign == 0)
2668 {
2669 // When zero value is formatted with an explicit
2670 // precision 0, the resulting formatted string is
2671 // empty (d, i, u, b, B, o, x, X, p).
2672 }
2673 else
2674 {
2675 char f[6];
2676 int f_l = 0;
2677
2678 // construct a simple format string for sprintf
2679 f[f_l++] = '%';
2680 if (!length_modifier)
2681 ;
2682 else if (length_modifier == 'L')
2683 {
2684# ifdef MSWIN
2685 f[f_l++] = 'I';
2686 f[f_l++] = '6';
2687 f[f_l++] = '4';
2688# else
2689 f[f_l++] = 'l';
2690 f[f_l++] = 'l';
2691# endif
2692 }
2693 else
2694 f[f_l++] = length_modifier;
2695 f[f_l++] = fmt_spec;
2696 f[f_l++] = '\0';
2697
2698 if (fmt_spec == 'p')
2699 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
2700 else if (fmt_spec == 'b' || fmt_spec == 'B')
2701 {
2702 char b[8 * sizeof(uvarnumber_T)];
2703 size_t b_l = 0;
2704 uvarnumber_T bn = bin_arg;
2705
2706 do
2707 {
2708 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
2709 bn >>= 1;
2710 }
2711 while (bn != 0);
2712
2713 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
2714 str_arg_l += b_l;
2715 }
2716 else if (fmt_spec == 'd')
2717 {
2718 // signed
2719 switch (length_modifier)
2720 {
2721 case '\0': str_arg_l += sprintf(
2722 tmp + str_arg_l, f,
2723 int_arg);
2724 break;
2725 case 'h': str_arg_l += sprintf(
2726 tmp + str_arg_l, f,
2727 (short)int_arg);
2728 break;
2729 case 'l': str_arg_l += sprintf(
2730 tmp + str_arg_l, f, long_arg);
2731 break;
2732 case 'L': str_arg_l += sprintf(
2733 tmp + str_arg_l, f, llong_arg);
2734 break;
2735 }
2736 }
2737 else
2738 {
2739 // unsigned
2740 switch (length_modifier)
2741 {
2742 case '\0': str_arg_l += sprintf(
2743 tmp + str_arg_l, f,
2744 uint_arg);
2745 break;
2746 case 'h': str_arg_l += sprintf(
2747 tmp + str_arg_l, f,
2748 (unsigned short)uint_arg);
2749 break;
2750 case 'l': str_arg_l += sprintf(
2751 tmp + str_arg_l, f, ulong_arg);
2752 break;
2753 case 'L': str_arg_l += sprintf(
2754 tmp + str_arg_l, f, ullong_arg);
2755 break;
2756 }
2757 }
2758
2759 // include the optional minus sign and possible
2760 // "0x" in the region before the zero padding
2761 // insertion point
2762 if (zero_padding_insertion_ind < str_arg_l
2763 && tmp[zero_padding_insertion_ind] == '-')
2764 zero_padding_insertion_ind++;
2765 if (zero_padding_insertion_ind + 1 < str_arg_l
2766 && tmp[zero_padding_insertion_ind] == '0'
2767 && (tmp[zero_padding_insertion_ind + 1] == 'x'
2768 || tmp[zero_padding_insertion_ind + 1] == 'X'))
2769 zero_padding_insertion_ind += 2;
2770 }
2771
2772 {
2773 size_t num_of_digits = str_arg_l
2774 - zero_padding_insertion_ind;
2775
2776 if (alternate_form && fmt_spec == 'o'
2777 // unless zero is already the first
2778 // character
2779 && !(zero_padding_insertion_ind < str_arg_l
2780 && tmp[zero_padding_insertion_ind] == '0'))
2781 {
2782 // assure leading zero for alternate-form
2783 // octal numbers
2784 if (!precision_specified
2785 || precision < num_of_digits + 1)
2786 {
2787 // precision is increased to force the
2788 // first character to be zero, except if a
2789 // zero value is formatted with an
2790 // explicit precision of zero
2791 precision = num_of_digits + 1;
2792 }
2793 }
2794 // zero padding to specified precision?
2795 if (num_of_digits < precision)
2796 number_of_zeros_to_pad = precision - num_of_digits;
2797 }
2798 // zero padding to specified minimal field width?
2799 if (!justify_left && zero_padding)
2800 {
2801 int n = (int)(min_field_width - (str_arg_l
2802 + number_of_zeros_to_pad));
2803 if (n > 0)
2804 number_of_zeros_to_pad += n;
2805 }
2806 break;
2807 }
2808
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002809 case 'f':
2810 case 'F':
2811 case 'e':
2812 case 'E':
2813 case 'g':
2814 case 'G':
2815 {
2816 // Floating point.
2817 double f;
2818 double abs_f;
2819 char format[40];
2820 int l;
2821 int remove_trailing_zeroes = FALSE;
2822
2823 f =
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002824# if defined(FEAT_EVAL)
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002825 tvs != NULL ? tv_float(tvs, &arg_idx) :
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002826# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002827 va_arg(ap, double);
2828 abs_f = f < 0 ? -f : f;
2829
2830 if (fmt_spec == 'g' || fmt_spec == 'G')
2831 {
2832 // Would be nice to use %g directly, but it prints
2833 // "1.0" as "1", we don't want that.
2834 if ((abs_f >= 0.001 && abs_f < 10000000.0)
2835 || abs_f == 0.0)
2836 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
2837 else
2838 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
2839 remove_trailing_zeroes = TRUE;
2840 }
2841
2842 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002843# ifdef VAX
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002844 abs_f > 1.0e38
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002845# else
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002846 abs_f > 1.0e307
Bram Moolenaar73e28dc2022-09-17 21:08:33 +01002847# endif
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002848 )
2849 {
2850 // Avoid a buffer overflow
2851 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2852 force_sign, space_for_positive));
2853 str_arg_l = STRLEN(tmp);
2854 zero_padding = 0;
2855 }
2856 else
2857 {
2858 if (isnan(f))
2859 {
2860 // Not a number: nan or NAN
2861 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
2862 : "nan");
2863 str_arg_l = 3;
2864 zero_padding = 0;
2865 }
2866 else if (isinf(f))
2867 {
2868 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
2869 force_sign, space_for_positive));
2870 str_arg_l = STRLEN(tmp);
2871 zero_padding = 0;
2872 }
2873 else
2874 {
2875 // Regular float number
2876 format[0] = '%';
2877 l = 1;
2878 if (force_sign)
2879 format[l++] = space_for_positive ? ' ' : '+';
2880 if (precision_specified)
2881 {
2882 size_t max_prec = TMP_LEN - 10;
2883
2884 // Make sure we don't get more digits than we
2885 // have room for.
2886 if ((fmt_spec == 'f' || fmt_spec == 'F')
2887 && abs_f > 1.0)
2888 max_prec -= (size_t)log10(abs_f);
2889 if (precision > max_prec)
2890 precision = max_prec;
2891 l += sprintf(format + l, ".%d", (int)precision);
2892 }
2893 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
2894 format[l + 1] = NUL;
2895
2896 str_arg_l = sprintf(tmp, format, f);
2897 }
2898
2899 if (remove_trailing_zeroes)
2900 {
2901 int i;
2902 char *tp;
2903
2904 // Using %g or %G: remove superfluous zeroes.
2905 if (fmt_spec == 'f' || fmt_spec == 'F')
2906 tp = tmp + str_arg_l - 1;
2907 else
2908 {
2909 tp = (char *)vim_strchr((char_u *)tmp,
2910 fmt_spec == 'e' ? 'e' : 'E');
2911 if (tp != NULL)
2912 {
2913 // Remove superfluous '+' and leading
2914 // zeroes from the exponent.
2915 if (tp[1] == '+')
2916 {
2917 // Change "1.0e+07" to "1.0e07"
2918 STRMOVE(tp + 1, tp + 2);
2919 --str_arg_l;
2920 }
2921 i = (tp[1] == '-') ? 2 : 1;
2922 while (tp[i] == '0')
2923 {
2924 // Change "1.0e07" to "1.0e7"
2925 STRMOVE(tp + i, tp + i + 1);
2926 --str_arg_l;
2927 }
2928 --tp;
2929 }
2930 }
2931
2932 if (tp != NULL && !precision_specified)
2933 // Remove trailing zeroes, but keep the one
2934 // just after a dot.
2935 while (tp > tmp + 2 && *tp == '0'
2936 && tp[-1] != '.')
2937 {
2938 STRMOVE(tp, tp + 1);
2939 --tp;
2940 --str_arg_l;
2941 }
2942 }
2943 else
2944 {
2945 char *tp;
2946
2947 // Be consistent: some printf("%e") use 1.0e+12
2948 // and some 1.0e+012. Remove one zero in the last
2949 // case.
2950 tp = (char *)vim_strchr((char_u *)tmp,
2951 fmt_spec == 'e' ? 'e' : 'E');
2952 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
2953 && tp[2] == '0'
2954 && vim_isdigit(tp[3])
2955 && vim_isdigit(tp[4]))
2956 {
2957 STRMOVE(tp + 2, tp + 3);
2958 --str_arg_l;
2959 }
2960 }
2961 }
2962 if (zero_padding && min_field_width > str_arg_l
2963 && (tmp[0] == '-' || force_sign))
2964 {
2965 // padding 0's should be inserted after the sign
2966 number_of_zeros_to_pad = min_field_width - str_arg_l;
2967 zero_padding_insertion_ind = 1;
2968 }
2969 str_arg = tmp;
2970 break;
2971 }
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02002972
2973 default:
2974 // unrecognized conversion specifier, keep format string
2975 // as-is
2976 zero_padding = 0; // turn zero padding off for non-numeric
2977 // conversion
2978 justify_left = 1;
2979 min_field_width = 0; // reset flags
2980
2981 // discard the unrecognized conversion, just keep *
2982 // the unrecognized conversion character
2983 str_arg = p;
2984 str_arg_l = 0;
2985 if (*p != NUL)
2986 str_arg_l++; // include invalid conversion specifier
2987 // unchanged if not at end-of-string
2988 break;
2989 }
2990
2991 if (*p != NUL)
2992 p++; // step over the just processed conversion specifier
2993
2994 // insert padding to the left as requested by min_field_width;
2995 // this does not include the zero padding in case of numerical
2996 // conversions
2997 if (!justify_left)
2998 {
2999 // left padding with blank or zero
3000 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
3001
3002 if (pn > 0)
3003 {
3004 if (str_l < str_m)
3005 {
3006 size_t avail = str_m - str_l;
3007
3008 vim_memset(str + str_l, zero_padding ? '0' : ' ',
3009 (size_t)pn > avail ? avail
3010 : (size_t)pn);
3011 }
3012 str_l += pn;
3013 }
3014 }
3015
3016 // zero padding as requested by the precision or by the minimal
3017 // field width for numeric conversions required?
3018 if (number_of_zeros_to_pad == 0)
3019 {
3020 // will not copy first part of numeric right now, *
3021 // force it to be copied later in its entirety
3022 zero_padding_insertion_ind = 0;
3023 }
3024 else
3025 {
3026 // insert first part of numerics (sign or '0x') before zero
3027 // padding
3028 int zn = (int)zero_padding_insertion_ind;
3029
3030 if (zn > 0)
3031 {
3032 if (str_l < str_m)
3033 {
3034 size_t avail = str_m - str_l;
3035
3036 mch_memmove(str + str_l, str_arg,
3037 (size_t)zn > avail ? avail
3038 : (size_t)zn);
3039 }
3040 str_l += zn;
3041 }
3042
3043 // insert zero padding as requested by the precision or min
3044 // field width
3045 zn = (int)number_of_zeros_to_pad;
3046 if (zn > 0)
3047 {
3048 if (str_l < str_m)
3049 {
3050 size_t avail = str_m - str_l;
3051
3052 vim_memset(str + str_l, '0',
3053 (size_t)zn > avail ? avail
3054 : (size_t)zn);
3055 }
3056 str_l += zn;
3057 }
3058 }
3059
3060 // insert formatted string
3061 // (or as-is conversion specifier for unknown conversions)
3062 {
3063 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
3064
3065 if (sn > 0)
3066 {
3067 if (str_l < str_m)
3068 {
3069 size_t avail = str_m - str_l;
3070
3071 mch_memmove(str + str_l,
3072 str_arg + zero_padding_insertion_ind,
3073 (size_t)sn > avail ? avail : (size_t)sn);
3074 }
3075 str_l += sn;
3076 }
3077 }
3078
3079 // insert right padding
3080 if (justify_left)
3081 {
3082 // right blank padding to the field width
3083 int pn = (int)(min_field_width
3084 - (str_arg_l + number_of_zeros_to_pad));
3085
3086 if (pn > 0)
3087 {
3088 if (str_l < str_m)
3089 {
3090 size_t avail = str_m - str_l;
3091
3092 vim_memset(str + str_l, ' ',
3093 (size_t)pn > avail ? avail
3094 : (size_t)pn);
3095 }
3096 str_l += pn;
3097 }
3098 }
3099 vim_free(tofree);
3100 }
3101 }
3102
3103 if (str_m > 0)
3104 {
3105 // make sure the string is nul-terminated even at the expense of
3106 // overwriting the last character (shouldn't happen, but just in case)
3107 //
3108 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
3109 }
3110
3111 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar677658a2022-01-05 16:09:06 +00003112 emsg(_(e_too_many_arguments_to_printf));
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +02003113
3114 // Return the number of characters formatted (excluding trailing nul
3115 // character), that is, the number of characters that would have been
3116 // written to the buffer if it were large enough.
3117 return (int)str_l;
3118}
3119
3120#endif // PROTO