blob: 5e4caf81cd4f56f980283bfc1e54d920e243d402 [file] [log] [blame]
Bram Moolenaardefa0672019-07-21 19:25:37 +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 * viminfo.c: viminfo related functions
12 */
13
14#include "vim.h"
15#include "version.h"
16
Bram Moolenaar6bd1d772019-10-09 22:01:25 +020017/*
18 * Structure used for reading from the viminfo file.
19 */
20typedef struct
21{
22 char_u *vir_line; // text of the current line
23 FILE *vir_fd; // file descriptor
24 vimconv_T vir_conv; // encoding conversion
25 int vir_version; // viminfo version detected or -1
26 garray_T vir_barlines; // lines starting with |
27} vir_T;
28
Bram Moolenaar408030e2020-02-10 22:44:32 +010029typedef enum {
30 BVAL_NR,
31 BVAL_STRING,
32 BVAL_EMPTY
33} btype_T;
34
35typedef struct {
36 btype_T bv_type;
37 long bv_nr;
38 char_u *bv_string;
39 char_u *bv_tofree; // free later when not NULL
40 int bv_len; // length of bv_string
41 int bv_allocated; // bv_string was allocated
42} bval_T;
43
Bram Moolenaardefa0672019-07-21 19:25:37 +020044#if defined(FEAT_VIMINFO) || defined(PROTO)
45
46static int viminfo_errcnt;
47
48/*
Bram Moolenaarc3328162019-07-23 22:15:25 +020049 * Find the parameter represented by the given character (eg ''', ':', '"', or
50 * '/') in the 'viminfo' option and return a pointer to the string after it.
51 * Return NULL if the parameter is not specified in the string.
52 */
53 static char_u *
54find_viminfo_parameter(int type)
55{
56 char_u *p;
57
58 for (p = p_viminfo; *p; ++p)
59 {
60 if (*p == type)
61 return p + 1;
62 if (*p == 'n') // 'n' is always the last one
63 break;
64 p = vim_strchr(p, ','); // skip until next ','
65 if (p == NULL) // hit the end without finding parameter
66 break;
67 }
68 return NULL;
69}
70
71/*
72 * Find the parameter represented by the given character (eg ', :, ", or /),
73 * and return its associated value in the 'viminfo' string.
74 * Only works for number parameters, not for 'r' or 'n'.
75 * If the parameter is not specified in the string or there is no following
76 * number, return -1.
77 */
78 int
79get_viminfo_parameter(int type)
80{
81 char_u *p;
82
83 p = find_viminfo_parameter(type);
84 if (p != NULL && VIM_ISDIGIT(*p))
85 return atoi((char *)p);
86 return -1;
87}
88
89/*
Bram Moolenaardefa0672019-07-21 19:25:37 +020090 * Get the viminfo file name to use.
91 * If "file" is given and not empty, use it (has already been expanded by
92 * cmdline functions).
93 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
94 * expand environment variables.
95 * Returns an allocated string. NULL when out of memory.
96 */
97 static char_u *
98viminfo_filename(char_u *file)
99{
100 if (file == NULL || *file == NUL)
101 {
102 if (*p_viminfofile != NUL)
103 file = p_viminfofile;
104 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
105 {
106#ifdef VIMINFO_FILE2
107# ifdef VMS
108 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
109# else
110# ifdef MSWIN
111 // Use $VIM only if $HOME is the default "C:/".
112 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
113 && mch_getenv((char_u *)"HOME") == NULL)
114# else
115 if (mch_getenv((char_u *)"HOME") == NULL)
116# endif
117# endif
118 {
119 // don't use $VIM when not available.
120 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
121 if (STRCMP("$VIM", NameBuff) != 0) // $VIM was expanded
122 file = (char_u *)VIMINFO_FILE2;
123 else
124 file = (char_u *)VIMINFO_FILE;
125 }
126 else
127#endif
128 file = (char_u *)VIMINFO_FILE;
129 }
130 expand_env(file, NameBuff, MAXPATHL);
131 file = NameBuff;
132 }
133 return vim_strsave(file);
134}
135
Bram Moolenaarc3328162019-07-23 22:15:25 +0200136/*
137 * write string to viminfo file
138 * - replace CTRL-V with CTRL-V CTRL-V
139 * - replace '\n' with CTRL-V 'n'
140 * - add a '\n' at the end
141 *
142 * For a long line:
143 * - write " CTRL-V <length> \n " in first line
144 * - write " < <string> \n " in second line
145 */
146 static void
147viminfo_writestring(FILE *fd, char_u *p)
148{
149 int c;
150 char_u *s;
151 int len = 0;
152
153 for (s = p; *s != NUL; ++s)
154 {
155 if (*s == Ctrl_V || *s == '\n')
156 ++len;
157 ++len;
158 }
159
160 // If the string will be too long, write its length and put it in the next
161 // line. Take into account that some room is needed for what comes before
162 // the string (e.g., variable name). Add something to the length for the
163 // '<', NL and trailing NUL.
164 if (len > LSIZE / 2)
Bram Moolenaar424bcae2022-01-31 14:59:41 +0000165 fprintf(fd, "\026%d\n<", len + 3);
Bram Moolenaarc3328162019-07-23 22:15:25 +0200166
167 while ((c = *p++) != NUL)
168 {
169 if (c == Ctrl_V || c == '\n')
170 {
171 putc(Ctrl_V, fd);
172 if (c == '\n')
173 c = 'n';
174 }
175 putc(c, fd);
176 }
177 putc('\n', fd);
178}
179
180/*
181 * Write a string in quotes that barline_parse() can read back.
182 * Breaks the line in less than LSIZE pieces when needed.
183 * Returns remaining characters in the line.
184 */
185 static int
186barline_writestring(FILE *fd, char_u *s, int remaining_start)
187{
188 char_u *p;
189 int remaining = remaining_start;
190 int len = 2;
191
192 // Count the number of characters produced, including quotes.
193 for (p = s; *p != NUL; ++p)
194 {
195 if (*p == NL)
196 len += 2;
197 else if (*p == '"' || *p == '\\')
198 len += 2;
199 else
200 ++len;
201 }
202 if (len > remaining - 2)
203 {
204 fprintf(fd, ">%d\n|<", len);
205 remaining = LSIZE - 20;
206 }
207
208 putc('"', fd);
209 for (p = s; *p != NUL; ++p)
210 {
211 if (*p == NL)
212 {
213 putc('\\', fd);
214 putc('n', fd);
215 --remaining;
216 }
217 else if (*p == '"' || *p == '\\')
218 {
219 putc('\\', fd);
220 putc(*p, fd);
221 --remaining;
222 }
223 else
224 putc(*p, fd);
225 --remaining;
226
227 if (remaining < 3)
228 {
229 putc('\n', fd);
230 putc('|', fd);
231 putc('<', fd);
232 // Leave enough space for another continuation.
233 remaining = LSIZE - 20;
234 }
235 }
236 putc('"', fd);
237 return remaining - 2;
238}
239
240/*
241 * Check string read from viminfo file.
242 * Remove '\n' at the end of the line.
243 * - replace CTRL-V CTRL-V with CTRL-V
244 * - replace CTRL-V 'n' with '\n'
245 *
246 * Check for a long line as written by viminfo_writestring().
247 *
248 * Return the string in allocated memory (NULL when out of memory).
249 */
250 static char_u *
251viminfo_readstring(
252 vir_T *virp,
253 int off, // offset for virp->vir_line
Dominique Pellé0268ff32024-07-28 21:12:20 +0200254 int convert) // convert the string
Bram Moolenaarc3328162019-07-23 22:15:25 +0200255{
Bram Moolenaared7cb2d2021-08-11 17:13:54 +0200256 char_u *retval = NULL;
Bram Moolenaarc3328162019-07-23 22:15:25 +0200257 char_u *s, *d;
258 long len;
259
260 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
261 {
262 len = atol((char *)virp->vir_line + off + 1);
Bram Moolenaared7cb2d2021-08-11 17:13:54 +0200263 if (len > 0 && len < 1000000)
264 retval = lalloc(len, TRUE);
Bram Moolenaarc3328162019-07-23 22:15:25 +0200265 if (retval == NULL)
266 {
Bram Moolenaared7cb2d2021-08-11 17:13:54 +0200267 // Invalid length, line too long, out of memory? Skip next line.
Bram Moolenaarc3328162019-07-23 22:15:25 +0200268 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
269 return NULL;
270 }
271 (void)vim_fgets(retval, (int)len, virp->vir_fd);
272 s = retval + 1; // Skip the leading '<'
273 }
274 else
275 {
276 retval = vim_strsave(virp->vir_line + off);
277 if (retval == NULL)
278 return NULL;
279 s = retval;
280 }
281
282 // Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place.
283 d = retval;
284 while (*s != NUL && *s != '\n')
285 {
286 if (s[0] == Ctrl_V && s[1] != NUL)
287 {
288 if (s[1] == 'n')
289 *d++ = '\n';
290 else
291 *d++ = Ctrl_V;
292 s += 2;
293 }
294 else
295 *d++ = *s++;
296 }
297 *d = NUL;
298
299 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
300 {
301 d = string_convert(&virp->vir_conv, retval, NULL);
302 if (d != NULL)
303 {
304 vim_free(retval);
305 retval = d;
306 }
307 }
308
309 return retval;
310}
311
312/*
313 * Read a line from the viminfo file.
314 * Returns TRUE for end-of-file;
315 */
316 static int
317viminfo_readline(vir_T *virp)
318{
319 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
320}
321
Bram Moolenaardefa0672019-07-21 19:25:37 +0200322 static int
323read_viminfo_bufferlist(
324 vir_T *virp,
325 int writing)
326{
327 char_u *tab;
328 linenr_T lnum;
329 colnr_T col;
330 buf_T *buf;
331 char_u *sfname;
332 char_u *xline;
333
334 // Handle long line and escaped characters.
335 xline = viminfo_readstring(virp, 1, FALSE);
336
337 // don't read in if there are files on the command-line or if writing:
338 if (xline != NULL && !writing && ARGCOUNT == 0
339 && find_viminfo_parameter('%') != NULL)
340 {
341 // Format is: <fname> Tab <lnum> Tab <col>.
342 // Watch out for a Tab in the file name, work from the end.
343 lnum = 0;
344 col = 0;
345 tab = vim_strrchr(xline, '\t');
346 if (tab != NULL)
347 {
348 *tab++ = '\0';
349 col = (colnr_T)atoi((char *)tab);
350 tab = vim_strrchr(xline, '\t');
351 if (tab != NULL)
352 {
353 *tab++ = '\0';
354 lnum = atol((char *)tab);
355 }
356 }
357
358 // Expand "~/" in the file name at "line + 1" to a full path.
359 // Then try shortening it by comparing with the current directory
360 expand_env(xline, NameBuff, MAXPATHL);
361 sfname = shorten_fname1(NameBuff);
362
363 buf = buflist_new(NameBuff, sfname, (linenr_T)0, BLN_LISTED);
364 if (buf != NULL) // just in case...
365 {
366 buf->b_last_cursor.lnum = lnum;
367 buf->b_last_cursor.col = col;
368 buflist_setfpos(buf, curwin, lnum, col, FALSE);
369 }
370 }
371 vim_free(xline);
372
373 return viminfo_readline(virp);
374}
375
Bram Moolenaarc3328162019-07-23 22:15:25 +0200376/*
377 * Return TRUE if "name" is on removable media (depending on 'viminfo').
378 */
379 static int
380removable(char_u *name)
381{
382 char_u *p;
383 char_u part[51];
384 int retval = FALSE;
385 size_t n;
386
387 name = home_replace_save(NULL, name);
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000388 if (name == NULL)
389 return FALSE;
390 for (p = p_viminfo; *p; )
Bram Moolenaarc3328162019-07-23 22:15:25 +0200391 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000392 copy_option_part(&p, part, 51, ", ");
393 if (part[0] == 'r')
Bram Moolenaarc3328162019-07-23 22:15:25 +0200394 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000395 n = STRLEN(part + 1);
396 if (MB_STRNICMP(part + 1, name, n) == 0)
Bram Moolenaarc3328162019-07-23 22:15:25 +0200397 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000398 retval = TRUE;
399 break;
Bram Moolenaarc3328162019-07-23 22:15:25 +0200400 }
401 }
Bram Moolenaarc3328162019-07-23 22:15:25 +0200402 }
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000403 vim_free(name);
Bram Moolenaarc3328162019-07-23 22:15:25 +0200404 return retval;
405}
406
Bram Moolenaardefa0672019-07-21 19:25:37 +0200407 static void
408write_viminfo_bufferlist(FILE *fp)
409{
410 buf_T *buf;
411 win_T *win;
412 tabpage_T *tp;
413 char_u *line;
414 int max_buffers;
415
416 if (find_viminfo_parameter('%') == NULL)
417 return;
418
419 // Without a number -1 is returned: do all buffers.
420 max_buffers = get_viminfo_parameter('%');
421
422 // Allocate room for the file name, lnum and col.
423#define LINE_BUF_LEN (MAXPATHL + 40)
424 line = alloc(LINE_BUF_LEN);
425 if (line == NULL)
426 return;
427
428 FOR_ALL_TAB_WINDOWS(tp, win)
429 set_last_cursor(win);
430
431 fputs(_("\n# Buffer list:\n"), fp);
432 FOR_ALL_BUFFERS(buf)
433 {
434 if (buf->b_fname == NULL
435 || !buf->b_p_bl
Bram Moolenaardefa0672019-07-21 19:25:37 +0200436 || bt_quickfix(buf)
Bram Moolenaardefa0672019-07-21 19:25:37 +0200437 || bt_terminal(buf)
Bram Moolenaardefa0672019-07-21 19:25:37 +0200438 || removable(buf->b_ffname))
439 continue;
440
441 if (max_buffers-- == 0)
442 break;
443 putc('%', fp);
444 home_replace(NULL, buf->b_ffname, line, MAXPATHL, TRUE);
445 vim_snprintf_add((char *)line, LINE_BUF_LEN, "\t%ld\t%d",
446 (long)buf->b_last_cursor.lnum,
447 buf->b_last_cursor.col);
448 viminfo_writestring(fp, line);
449 }
450 vim_free(line);
451}
452
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200453/*
454 * Buffers for history read from a viminfo file. Only valid while reading.
455 */
456static histentry_T *viminfo_history[HIST_COUNT] =
457 {NULL, NULL, NULL, NULL, NULL};
458static int viminfo_hisidx[HIST_COUNT] = {0, 0, 0, 0, 0};
459static int viminfo_hislen[HIST_COUNT] = {0, 0, 0, 0, 0};
460static int viminfo_add_at_front = FALSE;
461
462/*
463 * Translate a history type number to the associated character.
464 */
465 static int
466hist_type2char(
467 int type,
468 int use_question) // use '?' instead of '/'
469{
470 if (type == HIST_CMD)
471 return ':';
472 if (type == HIST_SEARCH)
473 {
474 if (use_question)
475 return '?';
476 else
477 return '/';
478 }
479 if (type == HIST_EXPR)
480 return '=';
481 return '@';
482}
483
484/*
485 * Prepare for reading the history from the viminfo file.
486 * This allocates history arrays to store the read history lines.
487 */
488 static void
489prepare_viminfo_history(int asklen, int writing)
490{
491 int i;
492 int num;
493 int type;
494 int len;
Bram Moolenaar26b654a2019-07-22 20:50:17 +0200495 int hislen;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200496
497 init_history();
Bram Moolenaar26b654a2019-07-22 20:50:17 +0200498 hislen = get_hislen();
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200499 viminfo_add_at_front = (asklen != 0 && !writing);
500 if (asklen > hislen)
501 asklen = hislen;
502
503 for (type = 0; type < HIST_COUNT; ++type)
504 {
505 histentry_T *histentry = get_histentry(type);
506
507 // Count the number of empty spaces in the history list. Entries read
508 // from viminfo previously are also considered empty. If there are
509 // more spaces available than we request, then fill them up.
510 for (i = 0, num = 0; i < hislen; i++)
511 if (histentry[i].hisstr == NULL || histentry[i].viminfo)
512 num++;
513 len = asklen;
514 if (num > len)
515 len = num;
516 if (len <= 0)
517 viminfo_history[type] = NULL;
518 else
519 viminfo_history[type] = LALLOC_MULT(histentry_T, len);
520 if (viminfo_history[type] == NULL)
521 len = 0;
522 viminfo_hislen[type] = len;
523 viminfo_hisidx[type] = 0;
524 }
525}
526
527/*
528 * Accept a line from the viminfo, store it in the history array when it's
529 * new.
530 */
531 static int
532read_viminfo_history(vir_T *virp, int writing)
533{
534 int type;
535 long_u len;
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000536 char_u *val = NULL;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200537 char_u *p;
538
539 type = hist_char2type(virp->vir_line[0]);
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000540 if (viminfo_hisidx[type] >= viminfo_hislen[type])
541 goto done;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200542
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000543 val = viminfo_readstring(virp, 1, TRUE);
544 if (val == NULL || *val == NUL)
545 goto done;
546
547 int sep = (*val == ' ' ? NUL : *val);
548
549 if (in_history(type, val + (type == HIST_SEARCH), viminfo_add_at_front,
550 sep, writing))
551 goto done;
552
553 // Need to re-allocate to append the separator byte.
554 len = STRLEN(val);
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000555 if (type == HIST_SEARCH)
556 {
John Marriott8df07d02024-10-21 22:37:07 +0200557 p = alloc((size_t)len + 1); // +1 for the NUL. val already
558 // includes the separator.
559 if (p == NULL)
560 goto done;
561
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000562 // Search entry: Move the separator from the first
563 // column to after the NUL.
564 mch_memmove(p, val + 1, (size_t)len);
565 p[len] = sep;
John Marriott8df07d02024-10-21 22:37:07 +0200566 --len; // take into account the shortened string
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200567 }
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000568 else
569 {
John Marriott8df07d02024-10-21 22:37:07 +0200570 p = alloc((size_t)len + 2); // +1 for NUL and +1 for separator
571 if (p == NULL)
572 goto done;
573
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000574 // Not a search entry: No separator in the viminfo
575 // file, add a NUL separator.
John Marriott8df07d02024-10-21 22:37:07 +0200576 mch_memmove(p, val, (size_t)len + 1); // +1 to include the NUL
577 p[len + 1] = NUL; // put the separator *after* the string's NUL
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000578 }
579 viminfo_history[type][viminfo_hisidx[type]].hisstr = p;
John Marriott8df07d02024-10-21 22:37:07 +0200580 viminfo_history[type][viminfo_hisidx[type]].hisstrlen = (size_t)len;
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000581 viminfo_history[type][viminfo_hisidx[type]].time_set = 0;
582 viminfo_history[type][viminfo_hisidx[type]].viminfo = TRUE;
583 viminfo_history[type][viminfo_hisidx[type]].hisnum = 0;
584 viminfo_hisidx[type]++;
585
586done:
587 vim_free(val);
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200588 return viminfo_readline(virp);
589}
590
591/*
592 * Accept a new style history line from the viminfo, store it in the history
593 * array when it's new.
594 */
595 static void
596handle_viminfo_history(
597 garray_T *values,
598 int writing)
599{
600 int type;
601 long_u len;
602 char_u *val;
603 char_u *p;
604 bval_T *vp = (bval_T *)values->ga_data;
605
606 // Check the format:
607 // |{bartype},{histtype},{timestamp},{separator},"text"
608 if (values->ga_len < 4
609 || vp[0].bv_type != BVAL_NR
610 || vp[1].bv_type != BVAL_NR
611 || (vp[2].bv_type != BVAL_NR && vp[2].bv_type != BVAL_EMPTY)
612 || vp[3].bv_type != BVAL_STRING)
613 return;
614
615 type = vp[0].bv_nr;
616 if (type >= HIST_COUNT)
617 return;
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000618
619 if (viminfo_hisidx[type] >= viminfo_hislen[type])
620 return;
621
622 val = vp[3].bv_string;
623 if (val == NULL || *val == NUL)
624 return;
625
626 int sep = type == HIST_SEARCH && vp[2].bv_type == BVAL_NR
627 ? vp[2].bv_nr : NUL;
628 int idx;
629 int overwrite = FALSE;
630
631 if (in_history(type, val, viminfo_add_at_front, sep, writing))
632 return;
633
634 // If lines were written by an older Vim we need to avoid
635 // getting duplicates. See if the entry already exists.
636 for (idx = 0; idx < viminfo_hisidx[type]; ++idx)
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200637 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000638 p = viminfo_history[type][idx].hisstr;
John Marriott8df07d02024-10-21 22:37:07 +0200639 len = viminfo_history[type][idx].hisstrlen;
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000640 if (STRCMP(val, p) == 0
John Marriott8df07d02024-10-21 22:37:07 +0200641 && (type != HIST_SEARCH || sep == p[len + 1]))
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200642 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000643 overwrite = TRUE;
644 break;
645 }
646 }
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200647
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000648 if (!overwrite)
649 {
650 // Need to re-allocate to append the separator byte.
651 len = vp[3].bv_len;
652 p = alloc(len + 2);
653 }
654 else
655 len = 0; // for picky compilers
656 if (p != NULL)
657 {
658 viminfo_history[type][idx].time_set = vp[1].bv_nr;
659 if (!overwrite)
660 {
661 mch_memmove(p, val, (size_t)len + 1);
662 // Put the separator after the NUL.
663 p[len + 1] = sep;
664 viminfo_history[type][idx].hisstr = p;
John Marriott8df07d02024-10-21 22:37:07 +0200665 viminfo_history[type][idx].hisstrlen = (size_t)len;
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000666 viminfo_history[type][idx].hisnum = 0;
667 viminfo_history[type][idx].viminfo = TRUE;
668 viminfo_hisidx[type]++;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200669 }
670 }
671}
672
673/*
674 * Concatenate history lines from viminfo after the lines typed in this Vim.
675 */
676 static void
677concat_history(int type)
678{
679 int idx;
680 int i;
681 int hislen = get_hislen();
682 histentry_T *histentry = get_histentry(type);
683 int *hisidx = get_hisidx(type);
684 int *hisnum = get_hisnum(type);
685
686 idx = *hisidx + viminfo_hisidx[type];
687 if (idx >= hislen)
688 idx -= hislen;
689 else if (idx < 0)
690 idx = hislen - 1;
691 if (viminfo_add_at_front)
692 *hisidx = idx;
693 else
694 {
695 if (*hisidx == -1)
696 *hisidx = hislen - 1;
697 do
698 {
699 if (histentry[idx].hisstr != NULL || histentry[idx].viminfo)
700 break;
701 if (++idx == hislen)
702 idx = 0;
703 } while (idx != *hisidx);
704 if (idx != *hisidx && --idx < 0)
705 idx = hislen - 1;
706 }
707 for (i = 0; i < viminfo_hisidx[type]; i++)
708 {
709 vim_free(histentry[idx].hisstr);
710 histentry[idx].hisstr = viminfo_history[type][i].hisstr;
John Marriott8df07d02024-10-21 22:37:07 +0200711 histentry[idx].hisstrlen = viminfo_history[type][i].hisstrlen;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200712 histentry[idx].viminfo = TRUE;
713 histentry[idx].time_set = viminfo_history[type][i].time_set;
714 if (--idx < 0)
715 idx = hislen - 1;
716 }
717 idx += 1;
718 idx %= hislen;
719 for (i = 0; i < viminfo_hisidx[type]; i++)
720 {
721 histentry[idx++].hisnum = ++*hisnum;
722 idx %= hislen;
723 }
724}
725
726 static int
727sort_hist(const void *s1, const void *s2)
728{
729 histentry_T *p1 = *(histentry_T **)s1;
730 histentry_T *p2 = *(histentry_T **)s2;
731
732 if (p1->time_set < p2->time_set) return -1;
733 if (p1->time_set > p2->time_set) return 1;
734 return 0;
735}
736
737/*
738 * Merge history lines from viminfo and lines typed in this Vim based on the
739 * timestamp;
740 */
741 static void
742merge_history(int type)
743{
744 int max_len;
745 histentry_T **tot_hist;
746 histentry_T *new_hist;
747 int i;
748 int len;
749 int hislen = get_hislen();
750 histentry_T *histentry = get_histentry(type);
751 int *hisidx = get_hisidx(type);
752 int *hisnum = get_hisnum(type);
753
754 // Make one long list with all entries.
755 max_len = hislen + viminfo_hisidx[type];
756 tot_hist = ALLOC_MULT(histentry_T *, max_len);
Bram Moolenaar26b654a2019-07-22 20:50:17 +0200757 new_hist = ALLOC_MULT(histentry_T, hislen);
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200758 if (tot_hist == NULL || new_hist == NULL)
759 {
760 vim_free(tot_hist);
761 vim_free(new_hist);
762 return;
763 }
764 for (i = 0; i < viminfo_hisidx[type]; i++)
765 tot_hist[i] = &viminfo_history[type][i];
766 len = i;
767 for (i = 0; i < hislen; i++)
768 if (histentry[i].hisstr != NULL)
769 tot_hist[len++] = &histentry[i];
770
771 // Sort the list on timestamp.
772 qsort((void *)tot_hist, (size_t)len, sizeof(histentry_T *), sort_hist);
773
774 // Keep the newest ones.
775 for (i = 0; i < hislen; i++)
776 {
777 if (i < len)
778 {
779 new_hist[i] = *tot_hist[i];
780 tot_hist[i]->hisstr = NULL;
John Marriott8df07d02024-10-21 22:37:07 +0200781 tot_hist[i]->hisstrlen = 0;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200782 if (new_hist[i].hisnum == 0)
783 new_hist[i].hisnum = ++*hisnum;
784 }
785 else
786 clear_hist_entry(&new_hist[i]);
787 }
788 *hisidx = (i < len ? i : len) - 1;
789
790 // Free what is not kept.
791 for (i = 0; i < viminfo_hisidx[type]; i++)
John Marriott8df07d02024-10-21 22:37:07 +0200792 {
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200793 vim_free(viminfo_history[type][i].hisstr);
John Marriott8df07d02024-10-21 22:37:07 +0200794 viminfo_history[type][i].hisstrlen = 0;
795 }
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200796 for (i = 0; i < hislen; i++)
John Marriott8df07d02024-10-21 22:37:07 +0200797 {
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200798 vim_free(histentry[i].hisstr);
John Marriott8df07d02024-10-21 22:37:07 +0200799 histentry[i].hisstrlen = 0;
800 }
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200801 vim_free(histentry);
802 set_histentry(type, new_hist);
803 vim_free(tot_hist);
804}
805
806/*
807 * Finish reading history lines from viminfo. Not used when writing viminfo.
808 */
809 static void
810finish_viminfo_history(vir_T *virp)
811{
812 int type;
813 int merge = virp->vir_version >= VIMINFO_VERSION_WITH_HISTORY;
814
815 for (type = 0; type < HIST_COUNT; ++type)
816 {
817 if (get_histentry(type) == NULL)
818 continue;
819
820 if (merge)
821 merge_history(type);
822 else
823 concat_history(type);
824
825 VIM_CLEAR(viminfo_history[type]);
826 viminfo_hisidx[type] = 0;
827 }
828}
829
830/*
831 * Write history to viminfo file in "fp".
832 * When "merge" is TRUE merge history lines with a previously read viminfo
833 * file, data is in viminfo_history[].
834 * When "merge" is FALSE just write all history lines. Used for ":wviminfo!".
835 */
836 static void
837write_viminfo_history(FILE *fp, int merge)
838{
839 int i;
840 int type;
841 int num_saved;
842 int round;
843 int hislen;
844
845 init_history();
846 hislen = get_hislen();
847 if (hislen == 0)
848 return;
849 for (type = 0; type < HIST_COUNT; ++type)
850 {
851 histentry_T *histentry = get_histentry(type);
852 int *hisidx = get_hisidx(type);
853
854 num_saved = get_viminfo_parameter(hist_type2char(type, FALSE));
855 if (num_saved == 0)
856 continue;
857 if (num_saved < 0) // Use default
858 num_saved = hislen;
859 fprintf(fp, _("\n# %s History (newest to oldest):\n"),
860 type == HIST_CMD ? _("Command Line") :
861 type == HIST_SEARCH ? _("Search String") :
862 type == HIST_EXPR ? _("Expression") :
863 type == HIST_INPUT ? _("Input Line") :
864 _("Debug Line"));
865 if (num_saved > hislen)
866 num_saved = hislen;
867
Bram Moolenaar6bd1d772019-10-09 22:01:25 +0200868 // Merge typed and viminfo history:
869 // round 1: history of typed commands.
870 // round 2: history from recently read viminfo.
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200871 for (round = 1; round <= 2; ++round)
872 {
873 if (round == 1)
874 // start at newest entry, somewhere in the list
875 i = *hisidx;
876 else if (viminfo_hisidx[type] > 0)
877 // start at newest entry, first in the list
878 i = 0;
879 else
880 // empty list
881 i = -1;
882 if (i >= 0)
883 while (num_saved > 0
884 && !(round == 2 && i >= viminfo_hisidx[type]))
885 {
886 char_u *p;
John Marriott8df07d02024-10-21 22:37:07 +0200887 size_t plen;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200888 time_t timestamp;
889 int c = NUL;
890
891 if (round == 1)
892 {
893 p = histentry[i].hisstr;
John Marriott8df07d02024-10-21 22:37:07 +0200894 plen = histentry[i].hisstrlen;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200895 timestamp = histentry[i].time_set;
896 }
897 else
898 {
John Marriott8df07d02024-10-21 22:37:07 +0200899 if (viminfo_history[type] == NULL)
900 {
901 p = NULL;
902 plen = 0;
903 timestamp = 0;
904 }
905 else
906 {
907 p = viminfo_history[type][i].hisstr;
908 plen = viminfo_history[type][i].hisstrlen;
909 timestamp = viminfo_history[type][i].time_set;
910 }
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200911 }
912
913 if (p != NULL && (round == 2
914 || !merge
915 || !histentry[i].viminfo))
916 {
917 --num_saved;
918 fputc(hist_type2char(type, TRUE), fp);
919 // For the search history: put the separator in the
920 // second column; use a space if there isn't one.
921 if (type == HIST_SEARCH)
922 {
John Marriott8df07d02024-10-21 22:37:07 +0200923 c = p[plen + 1];
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200924 putc(c == NUL ? ' ' : c, fp);
925 }
926 viminfo_writestring(fp, p);
927
928 {
929 char cbuf[NUMBUFLEN];
930
931 // New style history with a bar line. Format:
932 // |{bartype},{histtype},{timestamp},{separator},"text"
933 if (c == NUL)
934 cbuf[0] = NUL;
935 else
936 sprintf(cbuf, "%d", c);
937 fprintf(fp, "|%d,%d,%ld,%s,", BARTYPE_HISTORY,
938 type, (long)timestamp, cbuf);
939 barline_writestring(fp, p, LSIZE - 20);
940 putc('\n', fp);
941 }
942 }
943 if (round == 1)
944 {
945 // Decrement index, loop around and stop when back at
946 // the start.
947 if (--i < 0)
948 i = hislen - 1;
949 if (i == *hisidx)
950 break;
951 }
952 else
953 {
954 // Increment index. Stop at the end in the while.
955 ++i;
956 }
957 }
958 }
959 for (i = 0; i < viminfo_hisidx[type]; ++i)
960 if (viminfo_history[type] != NULL)
John Marriott8df07d02024-10-21 22:37:07 +0200961 {
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200962 vim_free(viminfo_history[type][i].hisstr);
John Marriott8df07d02024-10-21 22:37:07 +0200963 viminfo_history[type][i].hisstrlen = 0;
964 }
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200965 VIM_CLEAR(viminfo_history[type]);
966 viminfo_hisidx[type] = 0;
967 }
968}
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200969
Bram Moolenaardefa0672019-07-21 19:25:37 +0200970 static void
971write_viminfo_barlines(vir_T *virp, FILE *fp_out)
972{
973 int i;
974 garray_T *gap = &virp->vir_barlines;
975 int seen_useful = FALSE;
976 char *line;
977
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000978 if (gap->ga_len <= 0)
979 return;
Bram Moolenaardefa0672019-07-21 19:25:37 +0200980
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000981 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
982
983 // Skip over continuation lines until seeing a useful line.
984 for (i = 0; i < gap->ga_len; ++i)
985 {
986 line = ((char **)(gap->ga_data))[i];
987 if (seen_useful || line[1] != '<')
Bram Moolenaardefa0672019-07-21 19:25:37 +0200988 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000989 fputs(line, fp_out);
990 seen_useful = TRUE;
Bram Moolenaardefa0672019-07-21 19:25:37 +0200991 }
992 }
993}
994
995/*
996 * Parse a viminfo line starting with '|'.
997 * Add each decoded value to "values".
998 * Returns TRUE if the next line is to be read after using the parsed values.
999 */
1000 static int
1001barline_parse(vir_T *virp, char_u *text, garray_T *values)
1002{
1003 char_u *p = text;
1004 char_u *nextp = NULL;
1005 char_u *buf = NULL;
1006 bval_T *value;
1007 int i;
1008 int allocated = FALSE;
1009 int eof;
1010 char_u *sconv;
1011 int converted;
1012
1013 while (*p == ',')
1014 {
1015 ++p;
1016 if (ga_grow(values, 1) == FAIL)
1017 break;
1018 value = (bval_T *)(values->ga_data) + values->ga_len;
1019
1020 if (*p == '>')
1021 {
1022 // Need to read a continuation line. Put strings in allocated
1023 // memory, because virp->vir_line is overwritten.
1024 if (!allocated)
1025 {
1026 for (i = 0; i < values->ga_len; ++i)
1027 {
1028 bval_T *vp = (bval_T *)(values->ga_data) + i;
1029
1030 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
1031 {
1032 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
1033 vp->bv_allocated = TRUE;
1034 }
1035 }
1036 allocated = TRUE;
1037 }
1038
1039 if (vim_isdigit(p[1]))
1040 {
1041 size_t len;
1042 size_t todo;
1043 size_t n;
1044
1045 // String value was split into lines that are each shorter
1046 // than LSIZE:
1047 // |{bartype},>{length of "{text}{text2}"}
1048 // |<"{text1}
1049 // |<{text2}",{value}
1050 // Length includes the quotes.
1051 ++p;
1052 len = getdigits(&p);
1053 buf = alloc((int)(len + 1));
1054 if (buf == NULL)
1055 return TRUE;
1056 p = buf;
1057 for (todo = len; todo > 0; todo -= n)
1058 {
1059 eof = viminfo_readline(virp);
1060 if (eof || virp->vir_line[0] != '|'
1061 || virp->vir_line[1] != '<')
1062 {
1063 // File was truncated or garbled. Read another line if
1064 // this one starts with '|'.
1065 vim_free(buf);
1066 return eof || virp->vir_line[0] == '|';
1067 }
1068 // Get length of text, excluding |< and NL chars.
1069 n = STRLEN(virp->vir_line);
1070 while (n > 0 && (virp->vir_line[n - 1] == NL
1071 || virp->vir_line[n - 1] == CAR))
1072 --n;
1073 n -= 2;
1074 if (n > todo)
1075 {
1076 // more values follow after the string
1077 nextp = virp->vir_line + 2 + todo;
1078 n = todo;
1079 }
1080 mch_memmove(p, virp->vir_line + 2, n);
1081 p += n;
1082 }
1083 *p = NUL;
1084 p = buf;
1085 }
1086 else
1087 {
1088 // Line ending in ">" continues in the next line:
1089 // |{bartype},{lots of values},>
1090 // |<{value},{value}
1091 eof = viminfo_readline(virp);
1092 if (eof || virp->vir_line[0] != '|'
1093 || virp->vir_line[1] != '<')
1094 // File was truncated or garbled. Read another line if
1095 // this one starts with '|'.
1096 return eof || virp->vir_line[0] == '|';
1097 p = virp->vir_line + 2;
1098 }
1099 }
1100
Keith Thompson184f71c2024-01-04 21:19:04 +01001101 if (SAFE_isdigit(*p))
Bram Moolenaardefa0672019-07-21 19:25:37 +02001102 {
1103 value->bv_type = BVAL_NR;
1104 value->bv_nr = getdigits(&p);
1105 ++values->ga_len;
1106 }
1107 else if (*p == '"')
1108 {
1109 int len = 0;
1110 char_u *s = p;
1111
1112 // Unescape special characters in-place.
1113 ++p;
1114 while (*p != '"')
1115 {
1116 if (*p == NL || *p == NUL)
1117 return TRUE; // syntax error, drop the value
1118 if (*p == '\\')
1119 {
1120 ++p;
1121 if (*p == 'n')
1122 s[len++] = '\n';
1123 else
1124 s[len++] = *p;
1125 ++p;
1126 }
1127 else
1128 s[len++] = *p++;
1129 }
1130 ++p;
1131 s[len] = NUL;
1132
1133 converted = FALSE;
Bram Moolenaar408030e2020-02-10 22:44:32 +01001134 value->bv_tofree = NULL;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001135 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
1136 {
1137 sconv = string_convert(&virp->vir_conv, s, NULL);
1138 if (sconv != NULL)
1139 {
1140 if (s == buf)
Bram Moolenaar408030e2020-02-10 22:44:32 +01001141 // the converted string is stored in bv_string and
1142 // freed later, also need to free "buf" later
1143 value->bv_tofree = buf;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001144 s = sconv;
Yegappan Lakshmanan084529c2024-12-24 09:50:01 +01001145 len = (int)STRLEN(s);
Bram Moolenaardefa0672019-07-21 19:25:37 +02001146 converted = TRUE;
1147 }
1148 }
1149
1150 // Need to copy in allocated memory if the string wasn't allocated
1151 // above and we did allocate before, thus vir_line may change.
Bram Moolenaar408030e2020-02-10 22:44:32 +01001152 if (s != buf && allocated && !converted)
John Marriott8df07d02024-10-21 22:37:07 +02001153 s = vim_strnsave(s, len);
Bram Moolenaardefa0672019-07-21 19:25:37 +02001154 value->bv_string = s;
1155 value->bv_type = BVAL_STRING;
1156 value->bv_len = len;
1157 value->bv_allocated = allocated || converted;
1158 ++values->ga_len;
1159 if (nextp != NULL)
1160 {
1161 // values following a long string
1162 p = nextp;
1163 nextp = NULL;
1164 }
1165 }
1166 else if (*p == ',')
1167 {
1168 value->bv_type = BVAL_EMPTY;
1169 ++values->ga_len;
1170 }
1171 else
1172 break;
1173 }
1174 return TRUE;
1175}
1176
Bram Moolenaardefa0672019-07-21 19:25:37 +02001177 static void
1178write_viminfo_version(FILE *fp_out)
1179{
1180 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
1181 BARTYPE_VERSION, VIMINFO_VERSION);
1182}
1183
1184 static int
1185no_viminfo(void)
1186{
1187 // "vim -i NONE" does not read or write a viminfo file
1188 return STRCMP(p_viminfofile, "NONE") == 0;
1189}
1190
1191/*
1192 * Report an error for reading a viminfo file.
1193 * Count the number of errors. When there are more than 10, return TRUE.
1194 */
Bram Moolenaarc3328162019-07-23 22:15:25 +02001195 static int
Bram Moolenaardefa0672019-07-21 19:25:37 +02001196viminfo_error(char *errnum, char *message, char_u *line)
1197{
1198 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1199 errnum, message);
1200 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1201 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1202 IObuff[STRLEN(IObuff) - 1] = NUL;
1203 emsg((char *)IObuff);
1204 if (++viminfo_errcnt >= 10)
1205 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00001206 emsg(_(e_viminfo_too_many_errors_skipping_rest_of_file));
Bram Moolenaardefa0672019-07-21 19:25:37 +02001207 return TRUE;
1208 }
1209 return FALSE;
1210}
1211
1212/*
1213 * Compare the 'encoding' value in the viminfo file with the current value of
1214 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
1215 * conversion of text with iconv() in viminfo_readstring().
1216 */
1217 static int
1218viminfo_encoding(vir_T *virp)
1219{
1220 char_u *p;
1221 int i;
1222
1223 if (get_viminfo_parameter('c') != 0)
1224 {
1225 p = vim_strchr(virp->vir_line, '=');
1226 if (p != NULL)
1227 {
1228 // remove trailing newline
1229 ++p;
1230 for (i = 0; vim_isprintc(p[i]); ++i)
1231 ;
1232 p[i] = NUL;
1233
1234 convert_setup(&virp->vir_conv, p, p_enc);
1235 }
1236 }
1237 return viminfo_readline(virp);
1238}
1239
1240#if defined(FEAT_EVAL) || defined(PROTO)
1241/*
1242 * Restore global vars that start with a capital from the viminfo file
1243 */
1244 static int
1245read_viminfo_varlist(vir_T *virp, int writing)
1246{
1247 char_u *tab;
1248 int type = VAR_NUMBER;
1249 typval_T tv;
1250 funccal_entry_T funccal_entry;
1251
1252 if (!writing && (find_viminfo_parameter('!') != NULL))
1253 {
1254 tab = vim_strchr(virp->vir_line + 1, '\t');
1255 if (tab != NULL)
1256 {
1257 *tab++ = '\0'; // isolate the variable name
1258 switch (*tab)
1259 {
1260 case 'S': type = VAR_STRING; break;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001261 case 'F': type = VAR_FLOAT; break;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001262 case 'D': type = VAR_DICT; break;
1263 case 'L': type = VAR_LIST; break;
1264 case 'B': type = VAR_BLOB; break;
1265 case 'X': type = VAR_SPECIAL; break;
Yegappan Lakshmanan9cb865e2025-03-23 16:42:16 +01001266 case 'T': type = VAR_TUPLE; break;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001267 }
1268
1269 tab = vim_strchr(tab, '\t');
1270 if (tab != NULL)
1271 {
1272 tv.v_type = type;
1273 if (type == VAR_STRING || type == VAR_DICT
Yegappan Lakshmanan9cb865e2025-03-23 16:42:16 +01001274 || type == VAR_LIST || type == VAR_BLOB
1275 || type == VAR_TUPLE)
Bram Moolenaardefa0672019-07-21 19:25:37 +02001276 tv.vval.v_string = viminfo_readstring(virp,
1277 (int)(tab - virp->vir_line + 1), TRUE);
Bram Moolenaardefa0672019-07-21 19:25:37 +02001278 else if (type == VAR_FLOAT)
Bram Moolenaar29500652021-08-08 15:43:34 +02001279 (void)string2float(tab + 1, &tv.vval.v_float, FALSE);
Bram Moolenaardefa0672019-07-21 19:25:37 +02001280 else
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001281 {
Bram Moolenaardefa0672019-07-21 19:25:37 +02001282 tv.vval.v_number = atol((char *)tab + 1);
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001283 if (type == VAR_SPECIAL && (tv.vval.v_number == VVAL_FALSE
1284 || tv.vval.v_number == VVAL_TRUE))
1285 tv.v_type = VAR_BOOL;
1286 }
Yegappan Lakshmanan9cb865e2025-03-23 16:42:16 +01001287 if (type == VAR_DICT || type == VAR_LIST || type == VAR_TUPLE)
Bram Moolenaardefa0672019-07-21 19:25:37 +02001288 {
1289 typval_T *etv = eval_expr(tv.vval.v_string, NULL);
1290
1291 if (etv == NULL)
1292 // Failed to parse back the dict or list, use it as a
1293 // string.
1294 tv.v_type = VAR_STRING;
1295 else
1296 {
1297 vim_free(tv.vval.v_string);
1298 tv = *etv;
1299 vim_free(etv);
1300 }
1301 }
1302 else if (type == VAR_BLOB)
1303 {
1304 blob_T *blob = string2blob(tv.vval.v_string);
1305
1306 if (blob == NULL)
1307 // Failed to parse back the blob, use it as a string.
1308 tv.v_type = VAR_STRING;
1309 else
1310 {
1311 vim_free(tv.vval.v_string);
1312 tv.v_type = VAR_BLOB;
1313 tv.vval.v_blob = blob;
1314 }
1315 }
1316
1317 // when in a function use global variables
1318 save_funccal(&funccal_entry);
1319 set_var(virp->vir_line + 1, &tv, FALSE);
1320 restore_funccal();
1321
1322 if (tv.v_type == VAR_STRING)
1323 vim_free(tv.vval.v_string);
1324 else if (tv.v_type == VAR_DICT || tv.v_type == VAR_LIST ||
1325 tv.v_type == VAR_BLOB)
1326 clear_tv(&tv);
1327 }
1328 }
1329 }
1330
1331 return viminfo_readline(virp);
1332}
1333
1334/*
1335 * Write global vars that start with a capital to the viminfo file
1336 */
1337 static void
1338write_viminfo_varlist(FILE *fp)
1339{
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001340 hashtab_T *gvht = get_globvar_ht();
Bram Moolenaardefa0672019-07-21 19:25:37 +02001341 hashitem_T *hi;
1342 dictitem_T *this_var;
1343 int todo;
1344 char *s = "";
1345 char_u *p;
1346 char_u *tofree;
1347 char_u numbuf[NUMBUFLEN];
1348
1349 if (find_viminfo_parameter('!') == NULL)
1350 return;
1351
1352 fputs(_("\n# global variables:\n"), fp);
1353
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001354 todo = (int)gvht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00001355 FOR_ALL_HASHTAB_ITEMS(gvht, hi, todo)
Bram Moolenaardefa0672019-07-21 19:25:37 +02001356 {
1357 if (!HASHITEM_EMPTY(hi))
1358 {
1359 --todo;
1360 this_var = HI2DI(hi);
1361 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
1362 {
1363 switch (this_var->di_tv.v_type)
1364 {
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001365 case VAR_STRING: s = "STR"; break;
1366 case VAR_NUMBER: s = "NUM"; break;
1367 case VAR_FLOAT: s = "FLO"; break;
Bram Moolenaar5b157fe2020-06-07 16:08:08 +02001368 case VAR_DICT:
1369 {
1370 dict_T *di = this_var->di_tv.vval.v_dict;
1371 int copyID = get_copyID();
1372
1373 s = "DIC";
1374 if (di != NULL && !set_ref_in_ht(
Yegappan Lakshmanan9cb865e2025-03-23 16:42:16 +01001375 &di->dv_hashtab, copyID, NULL, NULL)
Bram Moolenaar5b157fe2020-06-07 16:08:08 +02001376 && di->dv_copyID == copyID)
1377 // has a circular reference, can't turn the
1378 // value into a string
1379 continue;
1380 break;
1381 }
1382 case VAR_LIST:
1383 {
1384 list_T *l = this_var->di_tv.vval.v_list;
1385 int copyID = get_copyID();
1386
1387 s = "LIS";
1388 if (l != NULL && !set_ref_in_list_items(
Yegappan Lakshmanan9cb865e2025-03-23 16:42:16 +01001389 l, copyID, NULL, NULL)
Bram Moolenaar5b157fe2020-06-07 16:08:08 +02001390 && l->lv_copyID == copyID)
1391 // has a circular reference, can't turn the
1392 // value into a string
1393 continue;
1394 break;
1395 }
Yegappan Lakshmanan9cb865e2025-03-23 16:42:16 +01001396 case VAR_TUPLE:
1397 {
1398 tuple_T *tuple = this_var->di_tv.vval.v_tuple;
1399 int copyID = get_copyID();
1400
1401 s = "TUP";
1402 if (tuple != NULL && !set_ref_in_tuple_items(
1403 tuple, copyID, NULL, NULL)
1404 && tuple->tv_copyID == copyID)
1405 // has a circular reference, can't turn the
1406 // value into a string
1407 continue;
1408 break;
1409 }
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001410 case VAR_BLOB: s = "BLO"; break;
1411 case VAR_BOOL: s = "XPL"; break; // backwards compat.
Bram Moolenaardefa0672019-07-21 19:25:37 +02001412 case VAR_SPECIAL: s = "XPL"; break;
1413
1414 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001415 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001416 case VAR_VOID:
Bram Moolenaardefa0672019-07-21 19:25:37 +02001417 case VAR_FUNC:
1418 case VAR_PARTIAL:
1419 case VAR_JOB:
1420 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02001421 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001422 case VAR_CLASS:
1423 case VAR_OBJECT:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001424 case VAR_TYPEALIAS:
1425 continue;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001426 }
1427 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001428 if (this_var->di_tv.v_type == VAR_BOOL
1429 || this_var->di_tv.v_type == VAR_SPECIAL)
Bram Moolenaardefa0672019-07-21 19:25:37 +02001430 {
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001431 // do not use "v:true" but "1"
Bram Moolenaardefa0672019-07-21 19:25:37 +02001432 sprintf((char *)numbuf, "%ld",
1433 (long)this_var->di_tv.vval.v_number);
1434 p = numbuf;
1435 tofree = NULL;
1436 }
1437 else
1438 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
1439 if (p != NULL)
1440 viminfo_writestring(fp, p);
1441 vim_free(tofree);
1442 }
1443 }
1444 }
1445}
1446#endif // FEAT_EVAL
1447
Bram Moolenaarc3328162019-07-23 22:15:25 +02001448 static int
1449read_viminfo_sub_string(vir_T *virp, int force)
1450{
1451 if (force || get_old_sub() == NULL)
1452 set_old_sub(viminfo_readstring(virp, 1, TRUE));
1453 return viminfo_readline(virp);
1454}
1455
1456 static void
1457write_viminfo_sub_string(FILE *fp)
1458{
1459 char_u *old_sub = get_old_sub();
1460
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001461 if (get_viminfo_parameter('/') == 0 || old_sub == NULL)
1462 return;
1463
1464 fputs(_("\n# Last Substitute String:\n$"), fp);
1465 viminfo_writestring(fp, old_sub);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001466}
1467
1468/*
1469 * Functions relating to reading/writing the search pattern from viminfo
1470 */
1471
1472 static int
1473read_viminfo_search_pattern(vir_T *virp, int force)
1474{
1475 char_u *lp;
1476 int idx = -1;
1477 int magic = FALSE;
1478 int no_scs = FALSE;
1479 int off_line = FALSE;
1480 int off_end = 0;
1481 long off = 0;
1482 int setlast = FALSE;
1483#ifdef FEAT_SEARCH_EXTRA
1484 static int hlsearch_on = FALSE;
1485#endif
1486 char_u *val;
1487 spat_T *spat;
1488
1489 // Old line types:
1490 // "/pat", "&pat": search/subst. pat
1491 // "~/pat", "~&pat": last used search/subst. pat
1492 // New line types:
1493 // "~h", "~H": hlsearch highlighting off/on
1494 // "~<magic><smartcase><line><end><off><last><which>pat"
1495 // <magic>: 'm' off, 'M' on
1496 // <smartcase>: 's' off, 'S' on
1497 // <line>: 'L' line offset, 'l' char offset
1498 // <end>: 'E' from end, 'e' from start
1499 // <off>: decimal, offset
1500 // <last>: '~' last used pattern
1501 // <which>: '/' search pat, '&' subst. pat
1502 lp = virp->vir_line;
1503 if (lp[0] == '~' && (lp[1] == 'm' || lp[1] == 'M')) // new line type
1504 {
1505 if (lp[1] == 'M') // magic on
1506 magic = TRUE;
1507 if (lp[2] == 's')
1508 no_scs = TRUE;
1509 if (lp[3] == 'L')
1510 off_line = TRUE;
1511 if (lp[4] == 'E')
1512 off_end = SEARCH_END;
1513 lp += 5;
1514 off = getdigits(&lp);
1515 }
1516 if (lp[0] == '~') // use this pattern for last-used pattern
1517 {
1518 setlast = TRUE;
1519 lp++;
1520 }
1521 if (lp[0] == '/')
1522 idx = RE_SEARCH;
1523 else if (lp[0] == '&')
1524 idx = RE_SUBST;
1525#ifdef FEAT_SEARCH_EXTRA
1526 else if (lp[0] == 'h') // ~h: 'hlsearch' highlighting off
1527 hlsearch_on = FALSE;
1528 else if (lp[0] == 'H') // ~H: 'hlsearch' highlighting on
1529 hlsearch_on = TRUE;
1530#endif
Bram Moolenaarc3328162019-07-23 22:15:25 +02001531 if (idx >= 0)
1532 {
Bram Moolenaar736cd2c2019-07-25 21:58:19 +02001533 spat = get_spat(idx);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001534 if (force || spat->pat == NULL)
1535 {
1536 val = viminfo_readstring(virp, (int)(lp - virp->vir_line + 1),
1537 TRUE);
1538 if (val != NULL)
1539 {
1540 set_last_search_pat(val, idx, magic, setlast);
1541 vim_free(val);
1542 spat->no_scs = no_scs;
1543 spat->off.line = off_line;
1544 spat->off.end = off_end;
1545 spat->off.off = off;
1546#ifdef FEAT_SEARCH_EXTRA
1547 if (setlast)
1548 set_no_hlsearch(!hlsearch_on);
1549#endif
1550 }
1551 }
1552 }
1553 return viminfo_readline(virp);
1554}
1555
1556 static void
1557wvsp_one(
1558 FILE *fp, // file to write to
1559 int idx, // spats[] index
1560 char *s, // search pat
1561 int sc) // dir char
1562{
1563 spat_T *spat = get_spat(idx);
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001564 if (spat->pat == NULL)
1565 return;
1566
1567 fprintf(fp, _("\n# Last %sSearch Pattern:\n~"), s);
1568 // off.dir is not stored, it's reset to forward
1569 fprintf(fp, "%c%c%c%c%ld%s%c",
1570 spat->magic ? 'M' : 'm', // magic
1571 spat->no_scs ? 's' : 'S', // smartcase
1572 spat->off.line ? 'L' : 'l', // line offset
1573 spat->off.end ? 'E' : 'e', // offset from end
1574 spat->off.off, // offset
1575 get_spat_last_idx() == idx ? "~" : "", // last used pat
1576 sc);
1577 viminfo_writestring(fp, spat->pat);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001578}
1579
1580 static void
1581write_viminfo_search_pattern(FILE *fp)
1582{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001583 if (get_viminfo_parameter('/') == 0)
1584 return;
1585
Bram Moolenaarc3328162019-07-23 22:15:25 +02001586#ifdef FEAT_SEARCH_EXTRA
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001587 fprintf(fp, "\n# hlsearch on (H) or off (h):\n~%c",
Bram Moolenaarc3328162019-07-23 22:15:25 +02001588 (no_hlsearch || find_viminfo_parameter('h') != NULL) ? 'h' : 'H');
1589#endif
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001590 wvsp_one(fp, RE_SEARCH, "", '/');
1591 wvsp_one(fp, RE_SUBST, _("Substitute "), '&');
Bram Moolenaarc3328162019-07-23 22:15:25 +02001592}
1593
1594/*
1595 * Functions relating to reading/writing registers from viminfo
1596 */
1597
1598static yankreg_T *y_read_regs = NULL;
1599
1600#define REG_PREVIOUS 1
1601#define REG_EXEC 2
1602
1603/*
1604 * Prepare for reading viminfo registers when writing viminfo later.
1605 */
1606 static void
1607prepare_viminfo_registers(void)
1608{
Yegappan Lakshmanane89aef32025-05-14 20:31:55 +02001609 y_read_regs = ALLOC_CLEAR_MULT(yankreg_T, NUM_REGISTERS);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001610}
1611
1612 static void
1613finish_viminfo_registers(void)
1614{
1615 int i;
1616 int j;
1617
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001618 if (y_read_regs == NULL)
1619 return;
1620
1621 for (i = 0; i < NUM_REGISTERS; ++i)
1622 if (y_read_regs[i].y_array != NULL)
1623 {
1624 for (j = 0; j < y_read_regs[i].y_size; j++)
John Marriott79f6ffd2024-10-31 10:06:54 +01001625 vim_free(y_read_regs[i].y_array[j].string);
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001626 vim_free(y_read_regs[i].y_array);
1627 }
1628 VIM_CLEAR(y_read_regs);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001629}
1630
1631 static int
1632read_viminfo_register(vir_T *virp, int force)
1633{
1634 int eof;
1635 int do_it = TRUE;
1636 int size;
1637 int limit;
1638 int i;
1639 int set_prev = FALSE;
1640 char_u *str;
John Marriott79f6ffd2024-10-31 10:06:54 +01001641 string_T *array = NULL;
Bram Moolenaarc3328162019-07-23 22:15:25 +02001642 int new_type = MCHAR; // init to shut up compiler
1643 colnr_T new_width = 0; // init to shut up compiler
1644 yankreg_T *y_current_p;
1645
1646 // We only get here (hopefully) if line[0] == '"'
1647 str = virp->vir_line + 1;
1648
1649 // If the line starts with "" this is the y_previous register.
1650 if (*str == '"')
1651 {
1652 set_prev = TRUE;
1653 str++;
1654 }
1655
1656 if (!ASCII_ISALNUM(*str) && *str != '-')
1657 {
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001658 if (viminfo_error("E577: ", _(e_illegal_register_name), virp->vir_line))
Bram Moolenaarc3328162019-07-23 22:15:25 +02001659 return TRUE; // too many errors, pretend end-of-file
1660 do_it = FALSE;
1661 }
1662 get_yank_register(*str++, FALSE);
1663 y_current_p = get_y_current();
1664 if (!force && y_current_p->y_array != NULL)
1665 do_it = FALSE;
1666
1667 if (*str == '@')
1668 {
1669 // "x@: register x used for @@
1670 if (force || get_execreg_lastc() == NUL)
1671 set_execreg_lastc(str[-1]);
1672 }
1673
1674 size = 0;
1675 limit = 100; // Optimized for registers containing <= 100 lines
1676 if (do_it)
1677 {
1678 // Build the new register in array[].
1679 // y_array is kept as-is until done.
1680 // The "do_it" flag is reset when something is wrong, in which case
1681 // array[] needs to be freed.
1682 if (set_prev)
1683 set_y_previous(y_current_p);
John Marriott79f6ffd2024-10-31 10:06:54 +01001684 array = ALLOC_MULT(string_T, limit);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001685 str = skipwhite(skiptowhite(str));
1686 if (STRNCMP(str, "CHAR", 4) == 0)
1687 new_type = MCHAR;
1688 else if (STRNCMP(str, "BLOCK", 5) == 0)
1689 new_type = MBLOCK;
1690 else
1691 new_type = MLINE;
1692 // get the block width; if it's missing we get a zero, which is OK
1693 str = skipwhite(skiptowhite(str));
1694 new_width = getdigits(&str);
1695 }
1696
1697 while (!(eof = viminfo_readline(virp))
1698 && (virp->vir_line[0] == TAB || virp->vir_line[0] == '<'))
1699 {
1700 if (do_it)
1701 {
1702 if (size == limit)
1703 {
John Marriott79f6ffd2024-10-31 10:06:54 +01001704 string_T *new_array = (string_T *)
1705 alloc(limit * 2 * sizeof(string_T));
Bram Moolenaarc3328162019-07-23 22:15:25 +02001706
1707 if (new_array == NULL)
1708 {
1709 do_it = FALSE;
1710 break;
1711 }
1712 for (i = 0; i < limit; i++)
1713 new_array[i] = array[i];
1714 vim_free(array);
1715 array = new_array;
1716 limit *= 2;
1717 }
1718 str = viminfo_readstring(virp, 1, TRUE);
1719 if (str != NULL)
John Marriott79f6ffd2024-10-31 10:06:54 +01001720 {
1721 array[size].string = str;
1722 array[size].length = STRLEN(str);
1723 ++size;
1724 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02001725 else
1726 // error, don't store the result
1727 do_it = FALSE;
1728 }
1729 }
1730
1731 if (do_it)
1732 {
1733 // free y_array[]
1734 for (i = 0; i < y_current_p->y_size; i++)
John Marriott79f6ffd2024-10-31 10:06:54 +01001735 vim_free(y_current_p->y_array[i].string);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001736 vim_free(y_current_p->y_array);
1737
1738 y_current_p->y_type = new_type;
1739 y_current_p->y_width = new_width;
1740 y_current_p->y_size = size;
1741 y_current_p->y_time_set = 0;
1742 if (size == 0)
1743 {
1744 y_current_p->y_array = NULL;
1745 }
1746 else
1747 {
1748 // Move the lines from array[] to y_array[].
John Marriott79f6ffd2024-10-31 10:06:54 +01001749 y_current_p->y_array = ALLOC_MULT(string_T, size);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001750 for (i = 0; i < size; i++)
1751 {
1752 if (y_current_p->y_array == NULL)
John Marriott79f6ffd2024-10-31 10:06:54 +01001753 {
1754 VIM_CLEAR_STRING(array[i]);
1755 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02001756 else
John Marriott79f6ffd2024-10-31 10:06:54 +01001757 {
1758 y_current_p->y_array[i].string = array[i].string;
1759 y_current_p->y_array[i].length = array[i].length;
1760 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02001761 }
1762 }
1763 }
1764 else
1765 {
1766 // Free array[] if it was filled.
1767 for (i = 0; i < size; i++)
John Marriott79f6ffd2024-10-31 10:06:54 +01001768 vim_free(array[i].string);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001769 }
1770 vim_free(array);
1771
1772 return eof;
1773}
1774
1775/*
1776 * Accept a new style register line from the viminfo, store it when it's new.
1777 */
1778 static void
1779handle_viminfo_register(garray_T *values, int force)
1780{
1781 bval_T *vp = (bval_T *)values->ga_data;
1782 int flags;
1783 int name;
1784 int type;
1785 int linecount;
1786 int width;
1787 time_t timestamp;
1788 yankreg_T *y_ptr;
1789 yankreg_T *y_regs_p = get_y_regs();
1790 int i;
1791
1792 // Check the format:
1793 // |{bartype},{flags},{name},{type},
1794 // {linecount},{width},{timestamp},"line1","line2"
1795 if (values->ga_len < 6
1796 || vp[0].bv_type != BVAL_NR
1797 || vp[1].bv_type != BVAL_NR
1798 || vp[2].bv_type != BVAL_NR
1799 || vp[3].bv_type != BVAL_NR
1800 || vp[4].bv_type != BVAL_NR
1801 || vp[5].bv_type != BVAL_NR)
1802 return;
1803 flags = vp[0].bv_nr;
1804 name = vp[1].bv_nr;
1805 if (name < 0 || name >= NUM_REGISTERS)
1806 return;
1807 type = vp[2].bv_nr;
1808 if (type != MCHAR && type != MLINE && type != MBLOCK)
1809 return;
1810 linecount = vp[3].bv_nr;
1811 if (values->ga_len < 6 + linecount)
1812 return;
1813 width = vp[4].bv_nr;
1814 if (width < 0)
1815 return;
1816
1817 if (y_read_regs != NULL)
1818 // Reading viminfo for merging and writing. Store the register
1819 // content, don't update the current registers.
1820 y_ptr = &y_read_regs[name];
1821 else
1822 y_ptr = &y_regs_p[name];
1823
1824 // Do not overwrite unless forced or the timestamp is newer.
1825 timestamp = (time_t)vp[5].bv_nr;
1826 if (y_ptr->y_array != NULL && !force
1827 && (timestamp == 0 || y_ptr->y_time_set > timestamp))
1828 return;
1829
1830 if (y_ptr->y_array != NULL)
1831 for (i = 0; i < y_ptr->y_size; i++)
John Marriott79f6ffd2024-10-31 10:06:54 +01001832 vim_free(y_ptr->y_array[i].string);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001833 vim_free(y_ptr->y_array);
1834
1835 if (y_read_regs == NULL)
1836 {
1837 if (flags & REG_PREVIOUS)
1838 set_y_previous(y_ptr);
1839 if ((flags & REG_EXEC) && (force || get_execreg_lastc() == NUL))
1840 set_execreg_lastc(get_register_name(name));
1841 }
1842 y_ptr->y_type = type;
1843 y_ptr->y_width = width;
1844 y_ptr->y_size = linecount;
1845 y_ptr->y_time_set = timestamp;
1846 if (linecount == 0)
1847 {
1848 y_ptr->y_array = NULL;
1849 return;
1850 }
John Marriott79f6ffd2024-10-31 10:06:54 +01001851 y_ptr->y_array = ALLOC_MULT(string_T, linecount);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001852 if (y_ptr->y_array == NULL)
1853 {
1854 y_ptr->y_size = 0; // ensure object state is consistent
1855 return;
1856 }
1857 for (i = 0; i < linecount; i++)
1858 {
1859 if (vp[i + 6].bv_allocated)
1860 {
John Marriott79f6ffd2024-10-31 10:06:54 +01001861 y_ptr->y_array[i].string = vp[i + 6].bv_string;
1862 y_ptr->y_array[i].length = vp[i + 6].bv_len;
Bram Moolenaarc3328162019-07-23 22:15:25 +02001863 vp[i + 6].bv_string = NULL;
1864 }
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +02001865 else if (vp[i + 6].bv_type != BVAL_STRING)
1866 {
1867 free(y_ptr->y_array);
1868 y_ptr->y_array = NULL;
1869 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02001870 else
John Marriott79f6ffd2024-10-31 10:06:54 +01001871 {
1872 y_ptr->y_array[i].string = vim_strnsave(vp[i + 6].bv_string, vp[i + 6].bv_len);
1873 y_ptr->y_array[i].length = vp[i + 6].bv_len;
1874 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02001875 }
1876}
1877
1878 static void
1879write_viminfo_registers(FILE *fp)
1880{
1881 int i, j;
1882 char_u *type;
1883 char_u c;
1884 int num_lines;
1885 int max_num_lines;
1886 int max_kbyte;
1887 long len;
1888 yankreg_T *y_ptr;
1889 yankreg_T *y_regs_p = get_y_regs();;
1890
1891 fputs(_("\n# Registers:\n"), fp);
1892
1893 // Get '<' value, use old '"' value if '<' is not found.
1894 max_num_lines = get_viminfo_parameter('<');
1895 if (max_num_lines < 0)
1896 max_num_lines = get_viminfo_parameter('"');
1897 if (max_num_lines == 0)
1898 return;
1899 max_kbyte = get_viminfo_parameter('s');
1900 if (max_kbyte == 0)
1901 return;
1902
1903 for (i = 0; i < NUM_REGISTERS; i++)
1904 {
1905#ifdef FEAT_CLIPBOARD
1906 // Skip '*'/'+' register, we don't want them back next time
1907 if (i == STAR_REGISTER || i == PLUS_REGISTER)
1908 continue;
1909#endif
1910#ifdef FEAT_DND
1911 // Neither do we want the '~' register
1912 if (i == TILDE_REGISTER)
1913 continue;
1914#endif
1915 // When reading viminfo for merging and writing: Use the register from
1916 // viminfo if it's newer.
1917 if (y_read_regs != NULL
1918 && y_read_regs[i].y_array != NULL
1919 && (y_regs_p[i].y_array == NULL ||
1920 y_read_regs[i].y_time_set > y_regs_p[i].y_time_set))
1921 y_ptr = &y_read_regs[i];
1922 else if (y_regs_p[i].y_array == NULL)
1923 continue;
1924 else
1925 y_ptr = &y_regs_p[i];
1926
1927 // Skip empty registers.
1928 num_lines = y_ptr->y_size;
1929 if (num_lines == 0
1930 || (num_lines == 1 && y_ptr->y_type == MCHAR
John Marriott79f6ffd2024-10-31 10:06:54 +01001931 && *y_ptr->y_array[0].string == NUL))
Bram Moolenaarc3328162019-07-23 22:15:25 +02001932 continue;
1933
1934 if (max_kbyte > 0)
1935 {
1936 // Skip register if there is more text than the maximum size.
1937 len = 0;
1938 for (j = 0; j < num_lines; j++)
John Marriott79f6ffd2024-10-31 10:06:54 +01001939 len += (long)y_ptr->y_array[j].length + 1L;
Bram Moolenaarc3328162019-07-23 22:15:25 +02001940 if (len > (long)max_kbyte * 1024L)
1941 continue;
1942 }
1943
1944 switch (y_ptr->y_type)
1945 {
1946 case MLINE:
1947 type = (char_u *)"LINE";
1948 break;
1949 case MCHAR:
1950 type = (char_u *)"CHAR";
1951 break;
1952 case MBLOCK:
1953 type = (char_u *)"BLOCK";
1954 break;
1955 default:
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001956 semsg(_(e_unknown_register_type_nr), y_ptr->y_type);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001957 type = (char_u *)"LINE";
1958 break;
1959 }
1960 if (get_y_previous() == &y_regs_p[i])
1961 fprintf(fp, "\"");
1962 c = get_register_name(i);
1963 fprintf(fp, "\"%c", c);
1964 if (c == get_execreg_lastc())
1965 fprintf(fp, "@");
1966 fprintf(fp, "\t%s\t%d\n", type, (int)y_ptr->y_width);
1967
1968 // If max_num_lines < 0, then we save ALL the lines in the register
1969 if (max_num_lines > 0 && num_lines > max_num_lines)
1970 num_lines = max_num_lines;
1971 for (j = 0; j < num_lines; j++)
1972 {
1973 putc('\t', fp);
John Marriott79f6ffd2024-10-31 10:06:54 +01001974 viminfo_writestring(fp, y_ptr->y_array[j].string);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001975 }
1976
1977 {
1978 int flags = 0;
1979 int remaining;
1980
1981 // New style with a bar line. Format:
1982 // |{bartype},{flags},{name},{type},
1983 // {linecount},{width},{timestamp},"line1","line2"
1984 // flags: REG_PREVIOUS - register is y_previous
1985 // REG_EXEC - used for @@
1986 if (get_y_previous() == &y_regs_p[i])
1987 flags |= REG_PREVIOUS;
1988 if (c == get_execreg_lastc())
1989 flags |= REG_EXEC;
1990 fprintf(fp, "|%d,%d,%d,%d,%d,%d,%ld", BARTYPE_REGISTER, flags,
1991 i, y_ptr->y_type, num_lines, (int)y_ptr->y_width,
1992 (long)y_ptr->y_time_set);
1993 // 11 chars for type/flags/name/type, 3 * 20 for numbers
1994 remaining = LSIZE - 71;
1995 for (j = 0; j < num_lines; j++)
1996 {
1997 putc(',', fp);
1998 --remaining;
John Marriott79f6ffd2024-10-31 10:06:54 +01001999 remaining = barline_writestring(fp, y_ptr->y_array[j].string,
Bram Moolenaarc3328162019-07-23 22:15:25 +02002000 remaining);
2001 }
2002 putc('\n', fp);
2003 }
2004 }
2005}
2006
2007/*
2008 * Functions relating to reading/writing marks from viminfo
2009 */
2010
2011static xfmark_T *vi_namedfm = NULL;
Bram Moolenaarc3328162019-07-23 22:15:25 +02002012static xfmark_T *vi_jumplist = NULL;
2013static int vi_jumplist_len = 0;
Bram Moolenaarc3328162019-07-23 22:15:25 +02002014
2015 static void
2016write_one_mark(FILE *fp_out, int c, pos_T *pos)
2017{
2018 if (pos->lnum != 0)
2019 fprintf(fp_out, "\t%c\t%ld\t%d\n", c, (long)pos->lnum, (int)pos->col);
2020}
2021
2022 static void
2023write_buffer_marks(buf_T *buf, FILE *fp_out)
2024{
2025 int i;
2026 pos_T pos;
2027
2028 home_replace(NULL, buf->b_ffname, IObuff, IOSIZE, TRUE);
2029 fprintf(fp_out, "\n> ");
2030 viminfo_writestring(fp_out, IObuff);
2031
2032 // Write the last used timestamp as the lnum of the non-existing mark '*'.
2033 // Older Vims will ignore it and/or copy it.
2034 pos.lnum = (linenr_T)buf->b_last_used;
2035 pos.col = 0;
2036 write_one_mark(fp_out, '*', &pos);
2037
2038 write_one_mark(fp_out, '"', &buf->b_last_cursor);
2039 write_one_mark(fp_out, '^', &buf->b_last_insert);
2040 write_one_mark(fp_out, '.', &buf->b_last_change);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002041 // changelist positions are stored oldest first
2042 for (i = 0; i < buf->b_changelistlen; ++i)
2043 {
2044 // skip duplicates
2045 if (i == 0 || !EQUAL_POS(buf->b_changelist[i - 1],
2046 buf->b_changelist[i]))
2047 write_one_mark(fp_out, '+', &buf->b_changelist[i]);
2048 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02002049 for (i = 0; i < NMARKS; i++)
2050 write_one_mark(fp_out, 'a' + i, &buf->b_namedm[i]);
2051}
2052
2053/*
2054 * Return TRUE if marks for "buf" should not be written.
2055 */
2056 static int
2057skip_for_viminfo(buf_T *buf)
2058{
Bram Moolenaar6d4b2f52022-08-25 15:11:15 +01002059 return bt_terminal(buf) || removable(buf->b_ffname);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002060}
2061
2062/*
2063 * Write all the named marks for all buffers.
2064 * When "buflist" is not NULL fill it with the buffers for which marks are to
2065 * be written.
2066 */
2067 static void
2068write_viminfo_marks(FILE *fp_out, garray_T *buflist)
2069{
2070 buf_T *buf;
2071 int is_mark_set;
2072 int i;
2073 win_T *win;
2074 tabpage_T *tp;
2075
2076 // Set b_last_cursor for the all buffers that have a window.
2077 FOR_ALL_TAB_WINDOWS(tp, win)
2078 set_last_cursor(win);
2079
2080 fputs(_("\n# History of marks within files (newest to oldest):\n"), fp_out);
2081 FOR_ALL_BUFFERS(buf)
2082 {
2083 // Only write something if buffer has been loaded and at least one
2084 // mark is set.
2085 if (buf->b_marks_read)
2086 {
2087 if (buf->b_last_cursor.lnum != 0)
2088 is_mark_set = TRUE;
2089 else
2090 {
2091 is_mark_set = FALSE;
2092 for (i = 0; i < NMARKS; i++)
2093 if (buf->b_namedm[i].lnum != 0)
2094 {
2095 is_mark_set = TRUE;
2096 break;
2097 }
2098 }
2099 if (is_mark_set && buf->b_ffname != NULL
2100 && buf->b_ffname[0] != NUL
2101 && !skip_for_viminfo(buf))
2102 {
2103 if (buflist == NULL)
2104 write_buffer_marks(buf, fp_out);
2105 else if (ga_grow(buflist, 1) == OK)
2106 ((buf_T **)buflist->ga_data)[buflist->ga_len++] = buf;
2107 }
2108 }
2109 }
2110}
2111
2112 static void
2113write_one_filemark(
2114 FILE *fp,
2115 xfmark_T *fm,
2116 int c1,
2117 int c2)
2118{
2119 char_u *name;
2120
2121 if (fm->fmark.mark.lnum == 0) // not set
2122 return;
2123
2124 if (fm->fmark.fnum != 0) // there is a buffer
2125 name = buflist_nr2name(fm->fmark.fnum, TRUE, FALSE);
2126 else
2127 name = fm->fname; // use name from .viminfo
2128 if (name != NULL && *name != NUL)
2129 {
2130 fprintf(fp, "%c%c %ld %ld ", c1, c2, (long)fm->fmark.mark.lnum,
2131 (long)fm->fmark.mark.col);
2132 viminfo_writestring(fp, name);
2133
2134 // Barline: |{bartype},{name},{lnum},{col},{timestamp},{filename}
2135 // size up to filename: 8 + 3 * 20
2136 fprintf(fp, "|%d,%d,%ld,%ld,%ld,", BARTYPE_MARK, c2,
2137 (long)fm->fmark.mark.lnum, (long)fm->fmark.mark.col,
2138 (long)fm->time_set);
2139 barline_writestring(fp, name, LSIZE - 70);
2140 putc('\n', fp);
2141 }
2142
2143 if (fm->fmark.fnum != 0)
2144 vim_free(name);
2145}
2146
2147 static void
2148write_viminfo_filemarks(FILE *fp)
2149{
2150 int i;
2151 char_u *name;
2152 buf_T *buf;
2153 xfmark_T *namedfm_p = get_namedfm();
2154 xfmark_T *fm;
2155 int vi_idx;
2156 int idx;
2157
2158 if (get_viminfo_parameter('f') == 0)
2159 return;
2160
2161 fputs(_("\n# File marks:\n"), fp);
2162
2163 // Write the filemarks 'A - 'Z
2164 for (i = 0; i < NMARKS; i++)
2165 {
2166 if (vi_namedfm != NULL
Bram Moolenaar8cd6cd82019-12-27 17:33:26 +01002167 && (vi_namedfm[i].time_set > namedfm_p[i].time_set))
Bram Moolenaarc3328162019-07-23 22:15:25 +02002168 fm = &vi_namedfm[i];
2169 else
2170 fm = &namedfm_p[i];
2171 write_one_filemark(fp, fm, '\'', i + 'A');
2172 }
2173
2174 // Find a mark that is the same file and position as the cursor.
2175 // That one, or else the last one is deleted.
2176 // Move '0 to '1, '1 to '2, etc. until the matching one or '9
2177 // Set the '0 mark to current cursor position.
2178 if (curbuf->b_ffname != NULL && !skip_for_viminfo(curbuf))
2179 {
2180 name = buflist_nr2name(curbuf->b_fnum, TRUE, FALSE);
2181 for (i = NMARKS; i < NMARKS + EXTRA_MARKS - 1; ++i)
2182 if (namedfm_p[i].fmark.mark.lnum == curwin->w_cursor.lnum
2183 && (namedfm_p[i].fname == NULL
2184 ? namedfm_p[i].fmark.fnum == curbuf->b_fnum
2185 : (name != NULL
2186 && STRCMP(name, namedfm_p[i].fname) == 0)))
2187 break;
2188 vim_free(name);
2189
2190 vim_free(namedfm_p[i].fname);
2191 for ( ; i > NMARKS; --i)
2192 namedfm_p[i] = namedfm_p[i - 1];
2193 namedfm_p[NMARKS].fmark.mark = curwin->w_cursor;
2194 namedfm_p[NMARKS].fmark.fnum = curbuf->b_fnum;
2195 namedfm_p[NMARKS].fname = NULL;
2196 namedfm_p[NMARKS].time_set = vim_time();
2197 }
2198
2199 // Write the filemarks '0 - '9. Newest (highest timestamp) first.
2200 vi_idx = NMARKS;
2201 idx = NMARKS;
2202 for (i = NMARKS; i < NMARKS + EXTRA_MARKS; i++)
2203 {
2204 xfmark_T *vi_fm = vi_namedfm != NULL ? &vi_namedfm[vi_idx] : NULL;
2205
2206 if (vi_fm != NULL
2207 && vi_fm->fmark.mark.lnum != 0
2208 && (vi_fm->time_set > namedfm_p[idx].time_set
2209 || namedfm_p[idx].fmark.mark.lnum == 0))
2210 {
2211 fm = vi_fm;
2212 ++vi_idx;
2213 }
2214 else
2215 {
2216 fm = &namedfm_p[idx++];
2217 if (vi_fm != NULL
2218 && vi_fm->fmark.mark.lnum == fm->fmark.mark.lnum
2219 && vi_fm->time_set == fm->time_set
2220 && ((vi_fm->fmark.fnum != 0
2221 && vi_fm->fmark.fnum == fm->fmark.fnum)
2222 || (vi_fm->fname != NULL
2223 && fm->fname != NULL
2224 && STRCMP(vi_fm->fname, fm->fname) == 0)))
2225 ++vi_idx; // skip duplicate
2226 }
2227 write_one_filemark(fp, fm, '\'', i - NMARKS + '0');
2228 }
2229
Bram Moolenaarc3328162019-07-23 22:15:25 +02002230 // Write the jumplist with -'
2231 fputs(_("\n# Jumplist (newest first):\n"), fp);
2232 setpcmark(); // add current cursor position
2233 cleanup_jumplist(curwin, FALSE);
2234 vi_idx = 0;
2235 idx = curwin->w_jumplistlen - 1;
2236 for (i = 0; i < JUMPLISTSIZE; ++i)
2237 {
2238 xfmark_T *vi_fm;
2239
2240 fm = idx >= 0 ? &curwin->w_jumplist[idx] : NULL;
Bram Moolenaar4ad739f2020-09-02 10:25:45 +02002241 vi_fm = (vi_jumplist != NULL && vi_idx < vi_jumplist_len)
2242 ? &vi_jumplist[vi_idx] : NULL;
Bram Moolenaarc3328162019-07-23 22:15:25 +02002243 if (fm == NULL && vi_fm == NULL)
2244 break;
2245 if (fm == NULL || (vi_fm != NULL && fm->time_set < vi_fm->time_set))
2246 {
2247 fm = vi_fm;
2248 ++vi_idx;
2249 }
2250 else
2251 --idx;
2252 if (fm->fmark.fnum == 0
2253 || ((buf = buflist_findnr(fm->fmark.fnum)) != NULL
2254 && !skip_for_viminfo(buf)))
2255 write_one_filemark(fp, fm, '-', '\'');
2256 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02002257}
2258
2259/*
2260 * Compare functions for qsort() below, that compares b_last_used.
2261 */
Bram Moolenaar52410572019-10-27 05:12:45 +01002262 int
Bram Moolenaarc3328162019-07-23 22:15:25 +02002263buf_compare(const void *s1, const void *s2)
2264{
2265 buf_T *buf1 = *(buf_T **)s1;
2266 buf_T *buf2 = *(buf_T **)s2;
2267
2268 if (buf1->b_last_used == buf2->b_last_used)
2269 return 0;
2270 return buf1->b_last_used > buf2->b_last_used ? -1 : 1;
2271}
2272
2273/*
2274 * Handle marks in the viminfo file:
2275 * fp_out != NULL: copy marks, in time order with buffers in "buflist".
Bram Moolenaar3ff656f2021-02-10 19:22:15 +01002276 * fp_out == NULL && (flags & VIF_WANT_MARKS): read marks for curbuf
2277 * fp_out == NULL && (flags & VIF_ONLY_CURBUF): bail out after curbuf marks
Bram Moolenaarc3328162019-07-23 22:15:25 +02002278 * fp_out == NULL && (flags & VIF_GET_OLDFILES | VIF_FORCEIT): fill v:oldfiles
2279 */
2280 static void
2281copy_viminfo_marks(
2282 vir_T *virp,
2283 FILE *fp_out,
2284 garray_T *buflist,
2285 int eof,
2286 int flags)
2287{
2288 char_u *line = virp->vir_line;
2289 buf_T *buf;
2290 int num_marked_files;
2291 int load_marks;
2292 int copy_marks_out;
2293 char_u *str;
2294 int i;
2295 char_u *p;
2296 char_u *name_buf;
2297 pos_T pos;
2298#ifdef FEAT_EVAL
2299 list_T *list = NULL;
2300#endif
2301 int count = 0;
2302 int buflist_used = 0;
2303 buf_T *buflist_buf = NULL;
2304
2305 if ((name_buf = alloc(LSIZE)) == NULL)
2306 return;
2307 *name_buf = NUL;
2308
2309 if (fp_out != NULL && buflist->ga_len > 0)
2310 {
2311 // Sort the list of buffers on b_last_used.
2312 qsort(buflist->ga_data, (size_t)buflist->ga_len,
2313 sizeof(buf_T *), buf_compare);
2314 buflist_buf = ((buf_T **)buflist->ga_data)[0];
2315 }
2316
2317#ifdef FEAT_EVAL
2318 if (fp_out == NULL && (flags & (VIF_GET_OLDFILES | VIF_FORCEIT)))
2319 {
2320 list = list_alloc();
2321 if (list != NULL)
2322 set_vim_var_list(VV_OLDFILES, list);
2323 }
2324#endif
2325
2326 num_marked_files = get_viminfo_parameter('\'');
2327 while (!eof && (count < num_marked_files || fp_out == NULL))
2328 {
2329 if (line[0] != '>')
2330 {
2331 if (line[0] != '\n' && line[0] != '\r' && line[0] != '#')
2332 {
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00002333 if (viminfo_error("E576: ", _(e_nonr_missing_gt), line))
Bram Moolenaarc3328162019-07-23 22:15:25 +02002334 break; // too many errors, return now
2335 }
2336 eof = vim_fgets(line, LSIZE, virp->vir_fd);
2337 continue; // Skip this dud line
2338 }
2339
2340 // Handle long line and translate escaped characters.
2341 // Find file name, set str to start.
2342 // Ignore leading and trailing white space.
2343 str = skipwhite(line + 1);
2344 str = viminfo_readstring(virp, (int)(str - virp->vir_line), FALSE);
2345 if (str == NULL)
2346 continue;
2347 p = str + STRLEN(str);
2348 while (p != str && (*p == NUL || vim_isspace(*p)))
2349 p--;
2350 if (*p)
2351 p++;
2352 *p = NUL;
2353
2354#ifdef FEAT_EVAL
2355 if (list != NULL)
2356 list_append_string(list, str, -1);
2357#endif
2358
2359 // If fp_out == NULL, load marks for current buffer.
2360 // If fp_out != NULL, copy marks for buffers not in buflist.
2361 load_marks = copy_marks_out = FALSE;
2362 if (fp_out == NULL)
2363 {
2364 if ((flags & VIF_WANT_MARKS) && curbuf->b_ffname != NULL)
2365 {
2366 if (*name_buf == NUL) // only need to do this once
2367 home_replace(NULL, curbuf->b_ffname, name_buf, LSIZE, TRUE);
2368 if (fnamecmp(str, name_buf) == 0)
2369 load_marks = TRUE;
2370 }
2371 }
2372 else // fp_out != NULL
2373 {
2374 // This is slow if there are many buffers!!
2375 FOR_ALL_BUFFERS(buf)
2376 if (buf->b_ffname != NULL)
2377 {
2378 home_replace(NULL, buf->b_ffname, name_buf, LSIZE, TRUE);
2379 if (fnamecmp(str, name_buf) == 0)
2380 break;
2381 }
2382
2383 // Copy marks if the buffer has not been loaded.
2384 if (buf == NULL || !buf->b_marks_read)
2385 {
2386 int did_read_line = FALSE;
2387
2388 if (buflist_buf != NULL)
2389 {
2390 // Read the next line. If it has the "*" mark compare the
2391 // time stamps. Write entries from "buflist" that are
2392 // newer.
Yegappan Lakshmanan6b085b92022-09-04 12:47:21 +01002393 if (!viminfo_readline(virp) && line[0] == TAB)
Bram Moolenaarc3328162019-07-23 22:15:25 +02002394 {
2395 did_read_line = TRUE;
2396 if (line[1] == '*')
2397 {
2398 long ltime;
2399
2400 sscanf((char *)line + 2, "%ld ", &ltime);
2401 while ((time_T)ltime < buflist_buf->b_last_used)
2402 {
2403 write_buffer_marks(buflist_buf, fp_out);
2404 if (++count >= num_marked_files)
2405 break;
2406 if (++buflist_used == buflist->ga_len)
2407 {
2408 buflist_buf = NULL;
2409 break;
2410 }
2411 buflist_buf =
2412 ((buf_T **)buflist->ga_data)[buflist_used];
2413 }
2414 }
2415 else
2416 {
2417 // No timestamp, must be written by an older Vim.
Bram Moolenaar32aa1022019-11-02 22:54:41 +01002418 // Assume all remaining buffers are older than
Bram Moolenaarc3328162019-07-23 22:15:25 +02002419 // ours.
2420 while (count < num_marked_files
2421 && buflist_used < buflist->ga_len)
2422 {
2423 buflist_buf = ((buf_T **)buflist->ga_data)
2424 [buflist_used++];
2425 write_buffer_marks(buflist_buf, fp_out);
2426 ++count;
2427 }
2428 buflist_buf = NULL;
2429 }
2430
2431 if (count >= num_marked_files)
2432 {
2433 vim_free(str);
2434 break;
2435 }
2436 }
2437 }
2438
2439 fputs("\n> ", fp_out);
2440 viminfo_writestring(fp_out, str);
2441 if (did_read_line)
2442 fputs((char *)line, fp_out);
2443
2444 count++;
2445 copy_marks_out = TRUE;
2446 }
2447 }
2448 vim_free(str);
2449
2450 pos.coladd = 0;
2451 while (!(eof = viminfo_readline(virp)) && line[0] == TAB)
2452 {
2453 if (load_marks)
2454 {
2455 if (line[1] != NUL)
2456 {
2457 unsigned u;
2458
2459 sscanf((char *)line + 2, "%ld %u", &pos.lnum, &u);
2460 pos.col = u;
2461 switch (line[1])
2462 {
2463 case '"': curbuf->b_last_cursor = pos; break;
2464 case '^': curbuf->b_last_insert = pos; break;
2465 case '.': curbuf->b_last_change = pos; break;
2466 case '+':
Bram Moolenaarc3328162019-07-23 22:15:25 +02002467 // changelist positions are stored oldest
2468 // first
2469 if (curbuf->b_changelistlen == JUMPLISTSIZE)
2470 // list is full, remove oldest entry
2471 mch_memmove(curbuf->b_changelist,
2472 curbuf->b_changelist + 1,
2473 sizeof(pos_T) * (JUMPLISTSIZE - 1));
2474 else
2475 ++curbuf->b_changelistlen;
2476 curbuf->b_changelist[
2477 curbuf->b_changelistlen - 1] = pos;
Bram Moolenaarc3328162019-07-23 22:15:25 +02002478 break;
2479
2480 // Using the line number for the last-used
2481 // timestamp.
2482 case '*': curbuf->b_last_used = pos.lnum; break;
2483
2484 default: if ((i = line[1] - 'a') >= 0 && i < NMARKS)
2485 curbuf->b_namedm[i] = pos;
2486 }
2487 }
2488 }
2489 else if (copy_marks_out)
2490 fputs((char *)line, fp_out);
2491 }
2492
2493 if (load_marks)
2494 {
Bram Moolenaarc3328162019-07-23 22:15:25 +02002495 win_T *wp;
2496
2497 FOR_ALL_WINDOWS(wp)
2498 {
2499 if (wp->w_buffer == curbuf)
2500 wp->w_changelistidx = curbuf->b_changelistlen;
2501 }
Bram Moolenaar3ff656f2021-02-10 19:22:15 +01002502 if (flags & VIF_ONLY_CURBUF)
2503 break;
Bram Moolenaarc3328162019-07-23 22:15:25 +02002504 }
2505 }
2506
2507 if (fp_out != NULL)
2508 // Write any remaining entries from buflist.
2509 while (count < num_marked_files && buflist_used < buflist->ga_len)
2510 {
2511 buflist_buf = ((buf_T **)buflist->ga_data)[buflist_used++];
2512 write_buffer_marks(buflist_buf, fp_out);
2513 ++count;
2514 }
2515
2516 vim_free(name_buf);
2517}
2518
2519/*
2520 * Read marks for the current buffer from the viminfo file, when we support
2521 * buffer marks and the buffer has a name.
2522 */
2523 void
2524check_marks_read(void)
2525{
2526 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2527 && curbuf->b_ffname != NULL)
Bram Moolenaar3ff656f2021-02-10 19:22:15 +01002528 read_viminfo(NULL, VIF_WANT_MARKS | VIF_ONLY_CURBUF);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002529
2530 // Always set b_marks_read; needed when 'viminfo' is changed to include
2531 // the ' parameter after opening a buffer.
2532 curbuf->b_marks_read = TRUE;
2533}
2534
2535 static int
2536read_viminfo_filemark(vir_T *virp, int force)
2537{
2538 char_u *str;
2539 xfmark_T *namedfm_p = get_namedfm();
2540 xfmark_T *fm;
2541 int i;
2542
2543 // We only get here if line[0] == '\'' or '-'.
2544 // Illegal mark names are ignored (for future expansion).
2545 str = virp->vir_line + 1;
Bram Moolenaar424bcae2022-01-31 14:59:41 +00002546 if (*str <= 127
2547 && ((*virp->vir_line == '\''
Keith Thompson184f71c2024-01-04 21:19:04 +01002548 && (VIM_ISDIGIT(*str) || SAFE_isupper(*str)))
Bram Moolenaarc3328162019-07-23 22:15:25 +02002549 || (*virp->vir_line == '-' && *str == '\'')))
2550 {
2551 if (*str == '\'')
2552 {
Bram Moolenaarc3328162019-07-23 22:15:25 +02002553 // If the jumplist isn't full insert fmark as oldest entry
2554 if (curwin->w_jumplistlen == JUMPLISTSIZE)
2555 fm = NULL;
2556 else
2557 {
2558 for (i = curwin->w_jumplistlen; i > 0; --i)
2559 curwin->w_jumplist[i] = curwin->w_jumplist[i - 1];
2560 ++curwin->w_jumplistidx;
2561 ++curwin->w_jumplistlen;
2562 fm = &curwin->w_jumplist[0];
2563 fm->fmark.mark.lnum = 0;
2564 fm->fname = NULL;
2565 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02002566 }
2567 else if (VIM_ISDIGIT(*str))
2568 fm = &namedfm_p[*str - '0' + NMARKS];
2569 else
2570 fm = &namedfm_p[*str - 'A'];
2571 if (fm != NULL && (fm->fmark.mark.lnum == 0 || force))
2572 {
2573 str = skipwhite(str + 1);
2574 fm->fmark.mark.lnum = getdigits(&str);
2575 str = skipwhite(str);
2576 fm->fmark.mark.col = getdigits(&str);
2577 fm->fmark.mark.coladd = 0;
2578 fm->fmark.fnum = 0;
2579 str = skipwhite(str);
2580 vim_free(fm->fname);
2581 fm->fname = viminfo_readstring(virp, (int)(str - virp->vir_line),
2582 FALSE);
2583 fm->time_set = 0;
2584 }
2585 }
2586 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2587}
2588
2589/*
2590 * Prepare for reading viminfo marks when writing viminfo later.
2591 */
2592 static void
2593prepare_viminfo_marks(void)
2594{
2595 vi_namedfm = ALLOC_CLEAR_MULT(xfmark_T, NMARKS + EXTRA_MARKS);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002596 vi_jumplist = ALLOC_CLEAR_MULT(xfmark_T, JUMPLISTSIZE);
2597 vi_jumplist_len = 0;
Bram Moolenaarc3328162019-07-23 22:15:25 +02002598}
2599
2600 static void
2601finish_viminfo_marks(void)
2602{
2603 int i;
2604
2605 if (vi_namedfm != NULL)
2606 {
2607 for (i = 0; i < NMARKS + EXTRA_MARKS; ++i)
2608 vim_free(vi_namedfm[i].fname);
2609 VIM_CLEAR(vi_namedfm);
2610 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02002611 if (vi_jumplist != NULL)
2612 {
2613 for (i = 0; i < vi_jumplist_len; ++i)
2614 vim_free(vi_jumplist[i].fname);
2615 VIM_CLEAR(vi_jumplist);
2616 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02002617}
2618
2619/*
2620 * Accept a new style mark line from the viminfo, store it when it's new.
2621 */
2622 static void
2623handle_viminfo_mark(garray_T *values, int force)
2624{
2625 bval_T *vp = (bval_T *)values->ga_data;
2626 int name;
2627 linenr_T lnum;
2628 colnr_T col;
2629 time_t timestamp;
2630 xfmark_T *fm = NULL;
2631
2632 // Check the format:
2633 // |{bartype},{name},{lnum},{col},{timestamp},{filename}
2634 if (values->ga_len < 5
2635 || vp[0].bv_type != BVAL_NR
2636 || vp[1].bv_type != BVAL_NR
2637 || vp[2].bv_type != BVAL_NR
2638 || vp[3].bv_type != BVAL_NR
2639 || vp[4].bv_type != BVAL_STRING)
2640 return;
2641
2642 name = vp[0].bv_nr;
2643 if (name != '\'' && !VIM_ISDIGIT(name) && !ASCII_ISUPPER(name))
2644 return;
2645 lnum = vp[1].bv_nr;
2646 col = vp[2].bv_nr;
2647 if (lnum <= 0 || col < 0)
2648 return;
2649 timestamp = (time_t)vp[3].bv_nr;
2650
2651 if (name == '\'')
2652 {
Bram Moolenaarc3328162019-07-23 22:15:25 +02002653 if (vi_jumplist != NULL)
2654 {
2655 if (vi_jumplist_len < JUMPLISTSIZE)
2656 fm = &vi_jumplist[vi_jumplist_len++];
2657 }
2658 else
2659 {
2660 int idx;
2661 int i;
2662
2663 // If we have a timestamp insert it in the right place.
2664 if (timestamp != 0)
2665 {
2666 for (idx = curwin->w_jumplistlen - 1; idx >= 0; --idx)
2667 if (curwin->w_jumplist[idx].time_set < timestamp)
2668 {
2669 ++idx;
2670 break;
2671 }
2672 // idx cannot be zero now
2673 if (idx < 0 && curwin->w_jumplistlen < JUMPLISTSIZE)
2674 // insert as the oldest entry
2675 idx = 0;
2676 }
2677 else if (curwin->w_jumplistlen < JUMPLISTSIZE)
2678 // insert as oldest entry
2679 idx = 0;
2680 else
2681 idx = -1;
2682
2683 if (idx >= 0)
2684 {
2685 if (curwin->w_jumplistlen == JUMPLISTSIZE)
2686 {
2687 // Drop the oldest entry.
2688 --idx;
2689 vim_free(curwin->w_jumplist[0].fname);
2690 for (i = 0; i < idx; ++i)
2691 curwin->w_jumplist[i] = curwin->w_jumplist[i + 1];
2692 }
2693 else
2694 {
2695 // Move newer entries forward.
2696 for (i = curwin->w_jumplistlen; i > idx; --i)
2697 curwin->w_jumplist[i] = curwin->w_jumplist[i - 1];
2698 ++curwin->w_jumplistidx;
2699 ++curwin->w_jumplistlen;
2700 }
2701 fm = &curwin->w_jumplist[idx];
2702 fm->fmark.mark.lnum = 0;
2703 fm->fname = NULL;
2704 fm->time_set = 0;
2705 }
2706 }
Bram Moolenaarc3328162019-07-23 22:15:25 +02002707 }
2708 else
2709 {
2710 int idx;
2711 xfmark_T *namedfm_p = get_namedfm();
2712
2713 if (VIM_ISDIGIT(name))
2714 {
2715 if (vi_namedfm != NULL)
2716 idx = name - '0' + NMARKS;
2717 else
2718 {
2719 int i;
2720
2721 // Do not use the name from the viminfo file, insert in time
2722 // order.
2723 for (idx = NMARKS; idx < NMARKS + EXTRA_MARKS; ++idx)
2724 if (namedfm_p[idx].time_set < timestamp)
2725 break;
2726 if (idx == NMARKS + EXTRA_MARKS)
2727 // All existing entries are newer.
2728 return;
2729 i = NMARKS + EXTRA_MARKS - 1;
2730
2731 vim_free(namedfm_p[i].fname);
2732 for ( ; i > idx; --i)
2733 namedfm_p[i] = namedfm_p[i - 1];
2734 namedfm_p[idx].fname = NULL;
2735 }
2736 }
2737 else
2738 idx = name - 'A';
2739 if (vi_namedfm != NULL)
2740 fm = &vi_namedfm[idx];
2741 else
2742 fm = &namedfm_p[idx];
2743 }
2744
2745 if (fm != NULL)
2746 {
2747 if (vi_namedfm != NULL || fm->fmark.mark.lnum == 0
2748 || fm->time_set < timestamp || force)
2749 {
2750 fm->fmark.mark.lnum = lnum;
2751 fm->fmark.mark.col = col;
2752 fm->fmark.mark.coladd = 0;
2753 fm->fmark.fnum = 0;
2754 vim_free(fm->fname);
2755 if (vp[4].bv_allocated)
2756 {
2757 fm->fname = vp[4].bv_string;
2758 vp[4].bv_string = NULL;
2759 }
2760 else
2761 fm->fname = vim_strsave(vp[4].bv_string);
2762 fm->time_set = timestamp;
2763 }
2764 }
2765}
2766
2767 static int
2768read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
2769{
2770 char_u *p = virp->vir_line + 1;
2771 int bartype;
2772 garray_T values;
2773 bval_T *vp;
2774 int i;
2775 int read_next = TRUE;
2776
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02002777 // The format is: |{bartype},{value},...
2778 // For a very long string:
2779 // |{bartype},>{length of "{text}{text2}"}
2780 // |<{text1}
2781 // |<{text2},{value}
2782 // For a long line not using a string
2783 // |{bartype},{lots of values},>
2784 // |<{value},{value}
Bram Moolenaarc3328162019-07-23 22:15:25 +02002785 if (*p == '<')
2786 {
2787 // Continuation line of an unrecognized item.
2788 if (writing)
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00002789 ga_copy_string(&virp->vir_barlines, virp->vir_line);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002790 }
2791 else
2792 {
2793 ga_init2(&values, sizeof(bval_T), 20);
2794 bartype = getdigits(&p);
2795 switch (bartype)
2796 {
2797 case BARTYPE_VERSION:
2798 // Only use the version when it comes before the encoding.
2799 // If it comes later it was copied by a Vim version that
2800 // doesn't understand the version.
2801 if (!got_encoding)
2802 {
2803 read_next = barline_parse(virp, p, &values);
2804 vp = (bval_T *)values.ga_data;
2805 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2806 virp->vir_version = vp->bv_nr;
2807 }
2808 break;
2809
2810 case BARTYPE_HISTORY:
2811 read_next = barline_parse(virp, p, &values);
2812 handle_viminfo_history(&values, writing);
2813 break;
2814
2815 case BARTYPE_REGISTER:
2816 read_next = barline_parse(virp, p, &values);
2817 handle_viminfo_register(&values, force);
2818 break;
2819
2820 case BARTYPE_MARK:
2821 read_next = barline_parse(virp, p, &values);
2822 handle_viminfo_mark(&values, force);
2823 break;
2824
2825 default:
2826 // copy unrecognized line (for future use)
2827 if (writing)
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00002828 ga_copy_string(&virp->vir_barlines, virp->vir_line);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002829 }
2830 for (i = 0; i < values.ga_len; ++i)
2831 {
2832 vp = (bval_T *)values.ga_data + i;
2833 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2834 vim_free(vp->bv_string);
Bram Moolenaar408030e2020-02-10 22:44:32 +01002835 vim_free(vp->bv_tofree);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002836 }
2837 ga_clear(&values);
2838 }
2839
2840 if (read_next)
2841 return viminfo_readline(virp);
2842 return FALSE;
2843}
2844
Bram Moolenaardefa0672019-07-21 19:25:37 +02002845/*
2846 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2847 * first part of the viminfo file which contains everything but the marks that
2848 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2849 */
2850 static int
2851read_viminfo_up_to_marks(
2852 vir_T *virp,
2853 int forceit,
2854 int writing)
2855{
2856 int eof;
2857 buf_T *buf;
2858 int got_encoding = FALSE;
2859
Bram Moolenaardefa0672019-07-21 19:25:37 +02002860 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaardefa0672019-07-21 19:25:37 +02002861
2862 eof = viminfo_readline(virp);
2863 while (!eof && virp->vir_line[0] != '>')
2864 {
2865 switch (virp->vir_line[0])
2866 {
2867 // Characters reserved for future expansion, ignored now
2868 case '+': // "+40 /path/dir file", for running vim without args
2869 case '^': // to be defined
2870 case '<': // long line - ignored
2871 // A comment or empty line.
2872 case NUL:
2873 case '\r':
2874 case '\n':
2875 case '#':
2876 eof = viminfo_readline(virp);
2877 break;
2878 case '|':
2879 eof = read_viminfo_barline(virp, got_encoding,
2880 forceit, writing);
2881 break;
2882 case '*': // "*encoding=value"
2883 got_encoding = TRUE;
2884 eof = viminfo_encoding(virp);
2885 break;
2886 case '!': // global variable
2887#ifdef FEAT_EVAL
2888 eof = read_viminfo_varlist(virp, writing);
2889#else
2890 eof = viminfo_readline(virp);
2891#endif
2892 break;
2893 case '%': // entry for buffer list
2894 eof = read_viminfo_bufferlist(virp, writing);
2895 break;
2896 case '"':
2897 // When registers are in bar lines skip the old style register
2898 // lines.
2899 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2900 eof = read_viminfo_register(virp, forceit);
2901 else
Hirohito Higashia4a00a72025-05-08 22:58:31 +02002902 do
2903 {
Bram Moolenaardefa0672019-07-21 19:25:37 +02002904 eof = viminfo_readline(virp);
2905 } while (!eof && (virp->vir_line[0] == TAB
2906 || virp->vir_line[0] == '<'));
2907 break;
2908 case '/': // Search string
2909 case '&': // Substitute search string
2910 case '~': // Last search string, followed by '/' or '&'
2911 eof = read_viminfo_search_pattern(virp, forceit);
2912 break;
2913 case '$':
2914 eof = read_viminfo_sub_string(virp, forceit);
2915 break;
2916 case ':':
2917 case '?':
2918 case '=':
2919 case '@':
Bram Moolenaardefa0672019-07-21 19:25:37 +02002920 // When history is in bar lines skip the old style history
2921 // lines.
2922 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2923 eof = read_viminfo_history(virp, writing);
2924 else
Bram Moolenaardefa0672019-07-21 19:25:37 +02002925 eof = viminfo_readline(virp);
2926 break;
2927 case '-':
2928 case '\'':
2929 // When file marks are in bar lines skip the old style lines.
2930 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2931 eof = read_viminfo_filemark(virp, forceit);
2932 else
2933 eof = viminfo_readline(virp);
2934 break;
2935 default:
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00002936 if (viminfo_error("E575: ", _(e_illegal_starting_char),
Bram Moolenaardefa0672019-07-21 19:25:37 +02002937 virp->vir_line))
2938 eof = TRUE;
2939 else
2940 eof = viminfo_readline(virp);
2941 break;
2942 }
2943 }
2944
Bram Moolenaardefa0672019-07-21 19:25:37 +02002945 // Finish reading history items.
2946 if (!writing)
2947 finish_viminfo_history(virp);
Bram Moolenaardefa0672019-07-21 19:25:37 +02002948
2949 // Change file names to buffer numbers for fmarks.
2950 FOR_ALL_BUFFERS(buf)
2951 fmarks_check_names(buf);
2952
2953 return eof;
2954}
2955
2956/*
2957 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2958 */
2959 static void
2960do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
2961{
2962 int eof = FALSE;
2963 vir_T vir;
2964 int merge = FALSE;
2965 int do_copy_marks = FALSE;
2966 garray_T buflist;
2967
2968 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2969 return;
2970 vir.vir_fd = fp_in;
2971 vir.vir_conv.vc_type = CONV_NONE;
Bram Moolenaar04935fb2022-01-08 16:19:22 +00002972 ga_init2(&vir.vir_barlines, sizeof(char_u *), 100);
Bram Moolenaardefa0672019-07-21 19:25:37 +02002973 vir.vir_version = -1;
2974
2975 if (fp_in != NULL)
2976 {
2977 if (flags & VIF_WANT_INFO)
2978 {
2979 if (fp_out != NULL)
2980 {
2981 // Registers and marks are read and kept separate from what
2982 // this Vim is using. They are merged when writing.
2983 prepare_viminfo_registers();
2984 prepare_viminfo_marks();
2985 }
2986
2987 eof = read_viminfo_up_to_marks(&vir,
2988 flags & VIF_FORCEIT, fp_out != NULL);
2989 merge = TRUE;
2990 }
2991 else if (flags != 0)
2992 // Skip info, find start of marks
2993 while (!(eof = viminfo_readline(&vir))
2994 && vir.vir_line[0] != '>')
2995 ;
2996
Bram Moolenaar3ff656f2021-02-10 19:22:15 +01002997 do_copy_marks = (flags & (VIF_WANT_MARKS | VIF_ONLY_CURBUF
2998 | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaardefa0672019-07-21 19:25:37 +02002999 }
3000
3001 if (fp_out != NULL)
3002 {
3003 // Write the info:
3004 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
3005 VIM_VERSION_MEDIUM);
3006 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
3007 write_viminfo_version(fp_out);
3008 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
3009 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
3010 write_viminfo_search_pattern(fp_out);
3011 write_viminfo_sub_string(fp_out);
Bram Moolenaardefa0672019-07-21 19:25:37 +02003012 write_viminfo_history(fp_out, merge);
Bram Moolenaardefa0672019-07-21 19:25:37 +02003013 write_viminfo_registers(fp_out);
3014 finish_viminfo_registers();
3015#ifdef FEAT_EVAL
3016 write_viminfo_varlist(fp_out);
3017#endif
3018 write_viminfo_filemarks(fp_out);
3019 finish_viminfo_marks();
3020 write_viminfo_bufferlist(fp_out);
3021 write_viminfo_barlines(&vir, fp_out);
3022
3023 if (do_copy_marks)
3024 ga_init2(&buflist, sizeof(buf_T *), 50);
3025 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
3026 }
3027
3028 if (do_copy_marks)
3029 {
3030 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
3031 if (fp_out != NULL)
3032 ga_clear(&buflist);
3033 }
3034
3035 vim_free(vir.vir_line);
3036 if (vir.vir_conv.vc_type != CONV_NONE)
3037 convert_setup(&vir.vir_conv, NULL, NULL);
3038 ga_clear_strings(&vir.vir_barlines);
3039}
3040
3041/*
3042 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
3043 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
3044 */
3045 int
3046read_viminfo(
3047 char_u *file, // file name or NULL to use default name
3048 int flags) // VIF_WANT_INFO et al.
3049{
3050 FILE *fp;
3051 char_u *fname;
Bram Moolenaarb86abad2020-08-01 16:08:19 +02003052 stat_T st; // mch_stat() of existing viminfo file
Bram Moolenaardefa0672019-07-21 19:25:37 +02003053
3054 if (no_viminfo())
3055 return FAIL;
3056
3057 fname = viminfo_filename(file); // get file name in allocated buffer
3058 if (fname == NULL)
3059 return FAIL;
3060 fp = mch_fopen((char *)fname, READBIN);
3061
3062 if (p_verbose > 0)
3063 {
3064 verbose_enter();
Bram Moolenaardb99f9f2020-03-23 22:12:22 +01003065 smsg(_("Reading viminfo file \"%s\"%s%s%s%s"),
Bram Moolenaardefa0672019-07-21 19:25:37 +02003066 fname,
3067 (flags & VIF_WANT_INFO) ? _(" info") : "",
3068 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
3069 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
3070 fp == NULL ? _(" FAILED") : "");
3071 verbose_leave();
3072 }
3073
3074 vim_free(fname);
3075 if (fp == NULL)
3076 return FAIL;
Bram Moolenaarb86abad2020-08-01 16:08:19 +02003077 if (mch_fstat(fileno(fp), &st) < 0 || S_ISDIR(st.st_mode))
3078 {
3079 fclose(fp);
3080 return FAIL;
3081 }
Bram Moolenaardefa0672019-07-21 19:25:37 +02003082
3083 viminfo_errcnt = 0;
3084 do_viminfo(fp, NULL, flags);
3085
3086 fclose(fp);
3087 return OK;
3088}
3089
3090/*
3091 * Write the viminfo file. The old one is read in first so that effectively a
3092 * merge of current info and old info is done. This allows multiple vims to
3093 * run simultaneously, without losing any marks etc.
3094 * If "forceit" is TRUE, then the old file is not read in, and only internal
3095 * info is written to the file.
3096 */
3097 void
3098write_viminfo(char_u *file, int forceit)
3099{
3100 char_u *fname;
3101 FILE *fp_in = NULL; // input viminfo file, if any
3102 FILE *fp_out = NULL; // output viminfo file
3103 char_u *tempname = NULL; // name of temp viminfo file
3104 stat_T st_new; // mch_stat() of potential new file
Bram Moolenaarb86abad2020-08-01 16:08:19 +02003105 stat_T st_old; // mch_stat() of existing viminfo file
Bram Moolenaardefa0672019-07-21 19:25:37 +02003106#if defined(UNIX) || defined(VMS)
3107 mode_t umask_save;
3108#endif
3109#ifdef UNIX
3110 int shortname = FALSE; // use 8.3 file name
Bram Moolenaardefa0672019-07-21 19:25:37 +02003111#endif
3112#ifdef MSWIN
3113 int hidden = FALSE;
3114#endif
3115
3116 if (no_viminfo())
3117 return;
3118
3119 fname = viminfo_filename(file); // may set to default if NULL
3120 if (fname == NULL)
3121 return;
3122
3123 fp_in = mch_fopen((char *)fname, READBIN);
3124 if (fp_in == NULL)
3125 {
3126 int fd;
3127
3128 // if it does exist, but we can't read it, don't try writing
3129 if (mch_stat((char *)fname, &st_new) == 0)
3130 goto end;
3131
3132 // Create the new .viminfo non-accessible for others, because it may
3133 // contain text from non-accessible documents. It is up to the user to
3134 // widen access (e.g. to a group). This may also fail if there is a
3135 // race condition, then just give up.
3136 fd = mch_open((char *)fname,
3137 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
3138 if (fd < 0)
3139 goto end;
3140 fp_out = fdopen(fd, WRITEBIN);
3141 }
3142 else
3143 {
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003144 // There is an existing viminfo file. Create a temporary file to
3145 // write the new viminfo into, in the same directory as the
3146 // existing viminfo file, which will be renamed once all writing is
3147 // successful.
Bram Moolenaarb86abad2020-08-01 16:08:19 +02003148 if (mch_fstat(fileno(fp_in), &st_old) < 0
3149 || S_ISDIR(st_old.st_mode)
Bram Moolenaardefa0672019-07-21 19:25:37 +02003150#ifdef UNIX
Bram Moolenaarb86abad2020-08-01 16:08:19 +02003151 // For Unix we check the owner of the file. It's not very nice
3152 // to overwrite a user's viminfo file after a "su root", with a
3153 // viminfo file that the user can't read.
3154 || (getuid() != ROOT_UID
3155 && !(st_old.st_uid == getuid()
3156 ? (st_old.st_mode & 0200)
3157 : (st_old.st_gid == getgid()
3158 ? (st_old.st_mode & 0020)
3159 : (st_old.st_mode & 0002))))
3160#endif
3161 )
Bram Moolenaardefa0672019-07-21 19:25:37 +02003162 {
3163 int tt = msg_didany;
3164
Bram Moolenaar13608d82022-08-29 15:06:50 +01003165 // avoid a wait_return() for this message, it's annoying
Bram Moolenaarc553a212021-12-26 20:20:34 +00003166 semsg(_(e_viminfo_file_is_not_writable_str), fname);
Bram Moolenaardefa0672019-07-21 19:25:37 +02003167 msg_didany = tt;
3168 fclose(fp_in);
3169 goto end;
3170 }
Bram Moolenaardefa0672019-07-21 19:25:37 +02003171#ifdef MSWIN
3172 // Get the file attributes of the existing viminfo file.
3173 hidden = mch_ishidden(fname);
3174#endif
3175
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003176 // Make tempname, find one that does not exist yet.
3177 // Beware of a race condition: If someone logs out and all Vim
3178 // instances exit at the same time a temp file might be created between
3179 // stat() and open(). Use mch_open() with O_EXCL to avoid that.
3180 // May try twice: Once normal and once with shortname set, just in
3181 // case somebody puts his viminfo file in an 8.3 filesystem.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003182 for (;;)
3183 {
3184 int next_char = 'z';
3185 char_u *wp;
3186
3187 tempname = buf_modname(
3188#ifdef UNIX
3189 shortname,
3190#else
3191 FALSE,
3192#endif
3193 fname,
3194#ifdef VMS
3195 (char_u *)"-tmp",
3196#else
3197 (char_u *)".tmp",
3198#endif
3199 FALSE);
3200 if (tempname == NULL) // out of memory
3201 break;
3202
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003203 // Try a series of names. Change one character, just before
3204 // the extension. This should also work for an 8.3
3205 // file name, when after adding the extension it still is
3206 // the same file as the original.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003207 wp = tempname + STRLEN(tempname) - 5;
3208 if (wp < gettail(tempname)) // empty file name?
3209 wp = gettail(tempname);
3210 for (;;)
3211 {
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003212 // Check if tempfile already exists. Never overwrite an
3213 // existing file!
Bram Moolenaardefa0672019-07-21 19:25:37 +02003214 if (mch_stat((char *)tempname, &st_new) == 0)
3215 {
3216#ifdef UNIX
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003217 // Check if tempfile is same as original file. May happen
3218 // when modname() gave the same file back. E.g. silly
3219 // link, or file name-length reached. Try again with
3220 // shortname set.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003221 if (!shortname && st_new.st_dev == st_old.st_dev
3222 && st_new.st_ino == st_old.st_ino)
3223 {
3224 VIM_CLEAR(tempname);
3225 shortname = TRUE;
3226 break;
3227 }
3228#endif
3229 }
3230 else
3231 {
3232 // Try creating the file exclusively. This may fail if
3233 // another Vim tries to do it at the same time.
3234#ifdef VMS
3235 // fdopen() fails for some reason
3236 umask_save = umask(077);
3237 fp_out = mch_fopen((char *)tempname, WRITEBIN);
3238 (void)umask(umask_save);
3239#else
3240 int fd;
3241
3242 // Use mch_open() to be able to use O_NOFOLLOW and set file
3243 // protection:
3244 // Unix: same as original file, but strip s-bit. Reset
3245 // umask to avoid it getting in the way.
3246 // Others: r&w for user only.
3247# ifdef UNIX
3248 umask_save = umask(0);
3249 fd = mch_open((char *)tempname,
3250 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
3251 (int)((st_old.st_mode & 0777) | 0600));
3252 (void)umask(umask_save);
3253# else
3254 fd = mch_open((char *)tempname,
3255 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
3256# endif
3257 if (fd < 0)
3258 {
3259 fp_out = NULL;
3260# ifdef EEXIST
3261 // Avoid trying lots of names while the problem is lack
3262 // of permission, only retry if the file already
3263 // exists.
3264 if (errno != EEXIST)
3265 break;
3266# endif
3267 }
3268 else
3269 fp_out = fdopen(fd, WRITEBIN);
3270#endif // VMS
3271 if (fp_out != NULL)
3272 break;
3273 }
3274
3275 // Assume file exists, try again with another name.
3276 if (next_char == 'a' - 1)
3277 {
3278 // They all exist? Must be something wrong! Don't write
3279 // the viminfo file then.
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003280 semsg(_(e_too_many_viminfo_temp_files_like_str), tempname);
Bram Moolenaardefa0672019-07-21 19:25:37 +02003281 break;
3282 }
3283 *wp = next_char;
3284 --next_char;
3285 }
3286
3287 if (tempname != NULL)
3288 break;
3289 // continue if shortname was set
3290 }
3291
3292#if defined(UNIX) && defined(HAVE_FCHOWN)
3293 if (tempname != NULL && fp_out != NULL)
3294 {
3295 stat_T tmp_st;
3296
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003297 // Make sure the original owner can read/write the tempfile and
3298 // otherwise preserve permissions, making sure the group matches.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003299 if (mch_stat((char *)tempname, &tmp_st) >= 0)
3300 {
3301 if (st_old.st_uid != tmp_st.st_uid)
3302 // Changing the owner might fail, in which case the
Bram Moolenaar32aa1022019-11-02 22:54:41 +01003303 // file will now be owned by the current user, oh well.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003304 vim_ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
3305 if (st_old.st_gid != tmp_st.st_gid
3306 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
3307 // can't set the group to what it should be, remove
3308 // group permissions
3309 (void)mch_setperm(tempname, 0600);
3310 }
3311 else
3312 // can't stat the file, set conservative permissions
3313 (void)mch_setperm(tempname, 0600);
3314 }
3315#endif
3316 }
3317
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003318 // Check if the new viminfo file can be written to.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003319 if (fp_out == NULL)
3320 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003321 semsg(_(e_cant_write_viminfo_file_str),
Bram Moolenaardefa0672019-07-21 19:25:37 +02003322 (fp_in == NULL || tempname == NULL) ? fname : tempname);
3323 if (fp_in != NULL)
3324 fclose(fp_in);
3325 goto end;
3326 }
3327
3328 if (p_verbose > 0)
3329 {
3330 verbose_enter();
3331 smsg(_("Writing viminfo file \"%s\""), fname);
3332 verbose_leave();
3333 }
3334
3335 viminfo_errcnt = 0;
3336 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
3337
3338 if (fclose(fp_out) == EOF)
3339 ++viminfo_errcnt;
3340
3341 if (fp_in != NULL)
3342 {
3343 fclose(fp_in);
3344
3345 // In case of an error keep the original viminfo file. Otherwise
3346 // rename the newly written file. Give an error if that fails.
3347 if (viminfo_errcnt == 0)
3348 {
3349 if (vim_rename(tempname, fname) == -1)
3350 {
3351 ++viminfo_errcnt;
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003352 semsg(_(e_cant_rename_viminfo_file_to_str), fname);
Bram Moolenaardefa0672019-07-21 19:25:37 +02003353 }
3354# ifdef MSWIN
3355 // If the viminfo file was hidden then also hide the new file.
3356 else if (hidden)
3357 mch_hide(fname);
3358# endif
3359 }
3360 if (viminfo_errcnt > 0)
3361 mch_remove(tempname);
3362 }
3363
3364end:
3365 vim_free(fname);
3366 vim_free(tempname);
3367}
3368
3369/*
Bram Moolenaardefa0672019-07-21 19:25:37 +02003370 * ":rviminfo" and ":wviminfo".
3371 */
3372 void
3373ex_viminfo(
3374 exarg_T *eap)
3375{
3376 char_u *save_viminfo;
3377
3378 save_viminfo = p_viminfo;
3379 if (*p_viminfo == NUL)
3380 p_viminfo = (char_u *)"'100";
3381 if (eap->cmdidx == CMD_rviminfo)
3382 {
3383 if (read_viminfo(eap->arg, VIF_WANT_INFO | VIF_WANT_MARKS
3384 | (eap->forceit ? VIF_FORCEIT : 0)) == FAIL)
Bram Moolenaarcbadefe2022-01-01 19:33:50 +00003385 emsg(_(e_cannot_open_viminfo_file_for_reading));
Bram Moolenaardefa0672019-07-21 19:25:37 +02003386 }
3387 else
3388 write_viminfo(eap->arg, eap->forceit);
3389 p_viminfo = save_viminfo;
3390}
3391
Bram Moolenaardefa0672019-07-21 19:25:37 +02003392#endif // FEAT_VIMINFO