blob: b014d7f21562002897d288f650ebdfe731e48f03 [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)
165 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
166
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
254 int convert UNUSED) // convert the string
255{
256 char_u *retval;
257 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);
263 retval = lalloc(len, TRUE);
264 if (retval == NULL)
265 {
266 // Line too long? File messed up? Skip next line.
267 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
268 return NULL;
269 }
270 (void)vim_fgets(retval, (int)len, virp->vir_fd);
271 s = retval + 1; // Skip the leading '<'
272 }
273 else
274 {
275 retval = vim_strsave(virp->vir_line + off);
276 if (retval == NULL)
277 return NULL;
278 s = retval;
279 }
280
281 // Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place.
282 d = retval;
283 while (*s != NUL && *s != '\n')
284 {
285 if (s[0] == Ctrl_V && s[1] != NUL)
286 {
287 if (s[1] == 'n')
288 *d++ = '\n';
289 else
290 *d++ = Ctrl_V;
291 s += 2;
292 }
293 else
294 *d++ = *s++;
295 }
296 *d = NUL;
297
298 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
299 {
300 d = string_convert(&virp->vir_conv, retval, NULL);
301 if (d != NULL)
302 {
303 vim_free(retval);
304 retval = d;
305 }
306 }
307
308 return retval;
309}
310
311/*
312 * Read a line from the viminfo file.
313 * Returns TRUE for end-of-file;
314 */
315 static int
316viminfo_readline(vir_T *virp)
317{
318 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
319}
320
Bram Moolenaardefa0672019-07-21 19:25:37 +0200321 static int
322read_viminfo_bufferlist(
323 vir_T *virp,
324 int writing)
325{
326 char_u *tab;
327 linenr_T lnum;
328 colnr_T col;
329 buf_T *buf;
330 char_u *sfname;
331 char_u *xline;
332
333 // Handle long line and escaped characters.
334 xline = viminfo_readstring(virp, 1, FALSE);
335
336 // don't read in if there are files on the command-line or if writing:
337 if (xline != NULL && !writing && ARGCOUNT == 0
338 && find_viminfo_parameter('%') != NULL)
339 {
340 // Format is: <fname> Tab <lnum> Tab <col>.
341 // Watch out for a Tab in the file name, work from the end.
342 lnum = 0;
343 col = 0;
344 tab = vim_strrchr(xline, '\t');
345 if (tab != NULL)
346 {
347 *tab++ = '\0';
348 col = (colnr_T)atoi((char *)tab);
349 tab = vim_strrchr(xline, '\t');
350 if (tab != NULL)
351 {
352 *tab++ = '\0';
353 lnum = atol((char *)tab);
354 }
355 }
356
357 // Expand "~/" in the file name at "line + 1" to a full path.
358 // Then try shortening it by comparing with the current directory
359 expand_env(xline, NameBuff, MAXPATHL);
360 sfname = shorten_fname1(NameBuff);
361
362 buf = buflist_new(NameBuff, sfname, (linenr_T)0, BLN_LISTED);
363 if (buf != NULL) // just in case...
364 {
365 buf->b_last_cursor.lnum = lnum;
366 buf->b_last_cursor.col = col;
367 buflist_setfpos(buf, curwin, lnum, col, FALSE);
368 }
369 }
370 vim_free(xline);
371
372 return viminfo_readline(virp);
373}
374
Bram Moolenaarc3328162019-07-23 22:15:25 +0200375/*
376 * Return TRUE if "name" is on removable media (depending on 'viminfo').
377 */
378 static int
379removable(char_u *name)
380{
381 char_u *p;
382 char_u part[51];
383 int retval = FALSE;
384 size_t n;
385
386 name = home_replace_save(NULL, name);
387 if (name != NULL)
388 {
389 for (p = p_viminfo; *p; )
390 {
391 copy_option_part(&p, part, 51, ", ");
392 if (part[0] == 'r')
393 {
394 n = STRLEN(part + 1);
395 if (MB_STRNICMP(part + 1, name, n) == 0)
396 {
397 retval = TRUE;
398 break;
399 }
400 }
401 }
402 vim_free(name);
403 }
404 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
436#ifdef FEAT_QUICKFIX
437 || bt_quickfix(buf)
438#endif
439#ifdef FEAT_TERMINAL
440 || bt_terminal(buf)
441#endif
442 || removable(buf->b_ffname))
443 continue;
444
445 if (max_buffers-- == 0)
446 break;
447 putc('%', fp);
448 home_replace(NULL, buf->b_ffname, line, MAXPATHL, TRUE);
449 vim_snprintf_add((char *)line, LINE_BUF_LEN, "\t%ld\t%d",
450 (long)buf->b_last_cursor.lnum,
451 buf->b_last_cursor.col);
452 viminfo_writestring(fp, line);
453 }
454 vim_free(line);
455}
456
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200457/*
458 * Buffers for history read from a viminfo file. Only valid while reading.
459 */
460static histentry_T *viminfo_history[HIST_COUNT] =
461 {NULL, NULL, NULL, NULL, NULL};
462static int viminfo_hisidx[HIST_COUNT] = {0, 0, 0, 0, 0};
463static int viminfo_hislen[HIST_COUNT] = {0, 0, 0, 0, 0};
464static int viminfo_add_at_front = FALSE;
465
466/*
467 * Translate a history type number to the associated character.
468 */
469 static int
470hist_type2char(
471 int type,
472 int use_question) // use '?' instead of '/'
473{
474 if (type == HIST_CMD)
475 return ':';
476 if (type == HIST_SEARCH)
477 {
478 if (use_question)
479 return '?';
480 else
481 return '/';
482 }
483 if (type == HIST_EXPR)
484 return '=';
485 return '@';
486}
487
488/*
489 * Prepare for reading the history from the viminfo file.
490 * This allocates history arrays to store the read history lines.
491 */
492 static void
493prepare_viminfo_history(int asklen, int writing)
494{
495 int i;
496 int num;
497 int type;
498 int len;
Bram Moolenaar26b654a2019-07-22 20:50:17 +0200499 int hislen;
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200500
501 init_history();
Bram Moolenaar26b654a2019-07-22 20:50:17 +0200502 hislen = get_hislen();
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200503 viminfo_add_at_front = (asklen != 0 && !writing);
504 if (asklen > hislen)
505 asklen = hislen;
506
507 for (type = 0; type < HIST_COUNT; ++type)
508 {
509 histentry_T *histentry = get_histentry(type);
510
511 // Count the number of empty spaces in the history list. Entries read
512 // from viminfo previously are also considered empty. If there are
513 // more spaces available than we request, then fill them up.
514 for (i = 0, num = 0; i < hislen; i++)
515 if (histentry[i].hisstr == NULL || histentry[i].viminfo)
516 num++;
517 len = asklen;
518 if (num > len)
519 len = num;
520 if (len <= 0)
521 viminfo_history[type] = NULL;
522 else
523 viminfo_history[type] = LALLOC_MULT(histentry_T, len);
524 if (viminfo_history[type] == NULL)
525 len = 0;
526 viminfo_hislen[type] = len;
527 viminfo_hisidx[type] = 0;
528 }
529}
530
531/*
532 * Accept a line from the viminfo, store it in the history array when it's
533 * new.
534 */
535 static int
536read_viminfo_history(vir_T *virp, int writing)
537{
538 int type;
539 long_u len;
540 char_u *val;
541 char_u *p;
542
543 type = hist_char2type(virp->vir_line[0]);
544 if (viminfo_hisidx[type] < viminfo_hislen[type])
545 {
546 val = viminfo_readstring(virp, 1, TRUE);
547 if (val != NULL && *val != NUL)
548 {
549 int sep = (*val == ' ' ? NUL : *val);
550
551 if (!in_history(type, val + (type == HIST_SEARCH),
552 viminfo_add_at_front, sep, writing))
553 {
554 // Need to re-allocate to append the separator byte.
555 len = STRLEN(val);
556 p = alloc(len + 2);
557 if (p != NULL)
558 {
559 if (type == HIST_SEARCH)
560 {
561 // Search entry: Move the separator from the first
562 // column to after the NUL.
563 mch_memmove(p, val + 1, (size_t)len);
564 p[len] = sep;
565 }
566 else
567 {
568 // Not a search entry: No separator in the viminfo
569 // file, add a NUL separator.
570 mch_memmove(p, val, (size_t)len + 1);
571 p[len + 1] = NUL;
572 }
573 viminfo_history[type][viminfo_hisidx[type]].hisstr = p;
574 viminfo_history[type][viminfo_hisidx[type]].time_set = 0;
575 viminfo_history[type][viminfo_hisidx[type]].viminfo = TRUE;
576 viminfo_history[type][viminfo_hisidx[type]].hisnum = 0;
577 viminfo_hisidx[type]++;
578 }
579 }
580 }
581 vim_free(val);
582 }
583 return viminfo_readline(virp);
584}
585
586/*
587 * Accept a new style history line from the viminfo, store it in the history
588 * array when it's new.
589 */
590 static void
591handle_viminfo_history(
592 garray_T *values,
593 int writing)
594{
595 int type;
596 long_u len;
597 char_u *val;
598 char_u *p;
599 bval_T *vp = (bval_T *)values->ga_data;
600
601 // Check the format:
602 // |{bartype},{histtype},{timestamp},{separator},"text"
603 if (values->ga_len < 4
604 || vp[0].bv_type != BVAL_NR
605 || vp[1].bv_type != BVAL_NR
606 || (vp[2].bv_type != BVAL_NR && vp[2].bv_type != BVAL_EMPTY)
607 || vp[3].bv_type != BVAL_STRING)
608 return;
609
610 type = vp[0].bv_nr;
611 if (type >= HIST_COUNT)
612 return;
613 if (viminfo_hisidx[type] < viminfo_hislen[type])
614 {
615 val = vp[3].bv_string;
616 if (val != NULL && *val != NUL)
617 {
618 int sep = type == HIST_SEARCH && vp[2].bv_type == BVAL_NR
619 ? vp[2].bv_nr : NUL;
620 int idx;
621 int overwrite = FALSE;
622
623 if (!in_history(type, val, viminfo_add_at_front, sep, writing))
624 {
625 // If lines were written by an older Vim we need to avoid
626 // getting duplicates. See if the entry already exists.
627 for (idx = 0; idx < viminfo_hisidx[type]; ++idx)
628 {
629 p = viminfo_history[type][idx].hisstr;
630 if (STRCMP(val, p) == 0
631 && (type != HIST_SEARCH || sep == p[STRLEN(p) + 1]))
632 {
633 overwrite = TRUE;
634 break;
635 }
636 }
637
638 if (!overwrite)
639 {
640 // Need to re-allocate to append the separator byte.
641 len = vp[3].bv_len;
642 p = alloc(len + 2);
643 }
644 else
645 len = 0; // for picky compilers
646 if (p != NULL)
647 {
648 viminfo_history[type][idx].time_set = vp[1].bv_nr;
649 if (!overwrite)
650 {
651 mch_memmove(p, val, (size_t)len + 1);
652 // Put the separator after the NUL.
653 p[len + 1] = sep;
654 viminfo_history[type][idx].hisstr = p;
655 viminfo_history[type][idx].hisnum = 0;
656 viminfo_history[type][idx].viminfo = TRUE;
657 viminfo_hisidx[type]++;
658 }
659 }
660 }
661 }
662 }
663}
664
665/*
666 * Concatenate history lines from viminfo after the lines typed in this Vim.
667 */
668 static void
669concat_history(int type)
670{
671 int idx;
672 int i;
673 int hislen = get_hislen();
674 histentry_T *histentry = get_histentry(type);
675 int *hisidx = get_hisidx(type);
676 int *hisnum = get_hisnum(type);
677
678 idx = *hisidx + viminfo_hisidx[type];
679 if (idx >= hislen)
680 idx -= hislen;
681 else if (idx < 0)
682 idx = hislen - 1;
683 if (viminfo_add_at_front)
684 *hisidx = idx;
685 else
686 {
687 if (*hisidx == -1)
688 *hisidx = hislen - 1;
689 do
690 {
691 if (histentry[idx].hisstr != NULL || histentry[idx].viminfo)
692 break;
693 if (++idx == hislen)
694 idx = 0;
695 } while (idx != *hisidx);
696 if (idx != *hisidx && --idx < 0)
697 idx = hislen - 1;
698 }
699 for (i = 0; i < viminfo_hisidx[type]; i++)
700 {
701 vim_free(histentry[idx].hisstr);
702 histentry[idx].hisstr = viminfo_history[type][i].hisstr;
703 histentry[idx].viminfo = TRUE;
704 histentry[idx].time_set = viminfo_history[type][i].time_set;
705 if (--idx < 0)
706 idx = hislen - 1;
707 }
708 idx += 1;
709 idx %= hislen;
710 for (i = 0; i < viminfo_hisidx[type]; i++)
711 {
712 histentry[idx++].hisnum = ++*hisnum;
713 idx %= hislen;
714 }
715}
716
717 static int
718sort_hist(const void *s1, const void *s2)
719{
720 histentry_T *p1 = *(histentry_T **)s1;
721 histentry_T *p2 = *(histentry_T **)s2;
722
723 if (p1->time_set < p2->time_set) return -1;
724 if (p1->time_set > p2->time_set) return 1;
725 return 0;
726}
727
728/*
729 * Merge history lines from viminfo and lines typed in this Vim based on the
730 * timestamp;
731 */
732 static void
733merge_history(int type)
734{
735 int max_len;
736 histentry_T **tot_hist;
737 histentry_T *new_hist;
738 int i;
739 int len;
740 int hislen = get_hislen();
741 histentry_T *histentry = get_histentry(type);
742 int *hisidx = get_hisidx(type);
743 int *hisnum = get_hisnum(type);
744
745 // Make one long list with all entries.
746 max_len = hislen + viminfo_hisidx[type];
747 tot_hist = ALLOC_MULT(histentry_T *, max_len);
Bram Moolenaar26b654a2019-07-22 20:50:17 +0200748 new_hist = ALLOC_MULT(histentry_T, hislen);
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200749 if (tot_hist == NULL || new_hist == NULL)
750 {
751 vim_free(tot_hist);
752 vim_free(new_hist);
753 return;
754 }
755 for (i = 0; i < viminfo_hisidx[type]; i++)
756 tot_hist[i] = &viminfo_history[type][i];
757 len = i;
758 for (i = 0; i < hislen; i++)
759 if (histentry[i].hisstr != NULL)
760 tot_hist[len++] = &histentry[i];
761
762 // Sort the list on timestamp.
763 qsort((void *)tot_hist, (size_t)len, sizeof(histentry_T *), sort_hist);
764
765 // Keep the newest ones.
766 for (i = 0; i < hislen; i++)
767 {
768 if (i < len)
769 {
770 new_hist[i] = *tot_hist[i];
771 tot_hist[i]->hisstr = NULL;
772 if (new_hist[i].hisnum == 0)
773 new_hist[i].hisnum = ++*hisnum;
774 }
775 else
776 clear_hist_entry(&new_hist[i]);
777 }
778 *hisidx = (i < len ? i : len) - 1;
779
780 // Free what is not kept.
781 for (i = 0; i < viminfo_hisidx[type]; i++)
782 vim_free(viminfo_history[type][i].hisstr);
783 for (i = 0; i < hislen; i++)
784 vim_free(histentry[i].hisstr);
785 vim_free(histentry);
786 set_histentry(type, new_hist);
787 vim_free(tot_hist);
788}
789
790/*
791 * Finish reading history lines from viminfo. Not used when writing viminfo.
792 */
793 static void
794finish_viminfo_history(vir_T *virp)
795{
796 int type;
797 int merge = virp->vir_version >= VIMINFO_VERSION_WITH_HISTORY;
798
799 for (type = 0; type < HIST_COUNT; ++type)
800 {
801 if (get_histentry(type) == NULL)
802 continue;
803
804 if (merge)
805 merge_history(type);
806 else
807 concat_history(type);
808
809 VIM_CLEAR(viminfo_history[type]);
810 viminfo_hisidx[type] = 0;
811 }
812}
813
814/*
815 * Write history to viminfo file in "fp".
816 * When "merge" is TRUE merge history lines with a previously read viminfo
817 * file, data is in viminfo_history[].
818 * When "merge" is FALSE just write all history lines. Used for ":wviminfo!".
819 */
820 static void
821write_viminfo_history(FILE *fp, int merge)
822{
823 int i;
824 int type;
825 int num_saved;
826 int round;
827 int hislen;
828
829 init_history();
830 hislen = get_hislen();
831 if (hislen == 0)
832 return;
833 for (type = 0; type < HIST_COUNT; ++type)
834 {
835 histentry_T *histentry = get_histentry(type);
836 int *hisidx = get_hisidx(type);
837
838 num_saved = get_viminfo_parameter(hist_type2char(type, FALSE));
839 if (num_saved == 0)
840 continue;
841 if (num_saved < 0) // Use default
842 num_saved = hislen;
843 fprintf(fp, _("\n# %s History (newest to oldest):\n"),
844 type == HIST_CMD ? _("Command Line") :
845 type == HIST_SEARCH ? _("Search String") :
846 type == HIST_EXPR ? _("Expression") :
847 type == HIST_INPUT ? _("Input Line") :
848 _("Debug Line"));
849 if (num_saved > hislen)
850 num_saved = hislen;
851
Bram Moolenaar6bd1d772019-10-09 22:01:25 +0200852 // Merge typed and viminfo history:
853 // round 1: history of typed commands.
854 // round 2: history from recently read viminfo.
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200855 for (round = 1; round <= 2; ++round)
856 {
857 if (round == 1)
858 // start at newest entry, somewhere in the list
859 i = *hisidx;
860 else if (viminfo_hisidx[type] > 0)
861 // start at newest entry, first in the list
862 i = 0;
863 else
864 // empty list
865 i = -1;
866 if (i >= 0)
867 while (num_saved > 0
868 && !(round == 2 && i >= viminfo_hisidx[type]))
869 {
870 char_u *p;
871 time_t timestamp;
872 int c = NUL;
873
874 if (round == 1)
875 {
876 p = histentry[i].hisstr;
877 timestamp = histentry[i].time_set;
878 }
879 else
880 {
881 p = viminfo_history[type] == NULL ? NULL
882 : viminfo_history[type][i].hisstr;
883 timestamp = viminfo_history[type] == NULL ? 0
884 : viminfo_history[type][i].time_set;
885 }
886
887 if (p != NULL && (round == 2
888 || !merge
889 || !histentry[i].viminfo))
890 {
891 --num_saved;
892 fputc(hist_type2char(type, TRUE), fp);
893 // For the search history: put the separator in the
894 // second column; use a space if there isn't one.
895 if (type == HIST_SEARCH)
896 {
897 c = p[STRLEN(p) + 1];
898 putc(c == NUL ? ' ' : c, fp);
899 }
900 viminfo_writestring(fp, p);
901
902 {
903 char cbuf[NUMBUFLEN];
904
905 // New style history with a bar line. Format:
906 // |{bartype},{histtype},{timestamp},{separator},"text"
907 if (c == NUL)
908 cbuf[0] = NUL;
909 else
910 sprintf(cbuf, "%d", c);
911 fprintf(fp, "|%d,%d,%ld,%s,", BARTYPE_HISTORY,
912 type, (long)timestamp, cbuf);
913 barline_writestring(fp, p, LSIZE - 20);
914 putc('\n', fp);
915 }
916 }
917 if (round == 1)
918 {
919 // Decrement index, loop around and stop when back at
920 // the start.
921 if (--i < 0)
922 i = hislen - 1;
923 if (i == *hisidx)
924 break;
925 }
926 else
927 {
928 // Increment index. Stop at the end in the while.
929 ++i;
930 }
931 }
932 }
933 for (i = 0; i < viminfo_hisidx[type]; ++i)
934 if (viminfo_history[type] != NULL)
935 vim_free(viminfo_history[type][i].hisstr);
936 VIM_CLEAR(viminfo_history[type]);
937 viminfo_hisidx[type] = 0;
938 }
939}
Bram Moolenaar5f32ece2019-07-21 21:51:59 +0200940
Bram Moolenaardefa0672019-07-21 19:25:37 +0200941 static void
942write_viminfo_barlines(vir_T *virp, FILE *fp_out)
943{
944 int i;
945 garray_T *gap = &virp->vir_barlines;
946 int seen_useful = FALSE;
947 char *line;
948
949 if (gap->ga_len > 0)
950 {
951 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
952
953 // Skip over continuation lines until seeing a useful line.
954 for (i = 0; i < gap->ga_len; ++i)
955 {
956 line = ((char **)(gap->ga_data))[i];
957 if (seen_useful || line[1] != '<')
958 {
959 fputs(line, fp_out);
960 seen_useful = TRUE;
961 }
962 }
963 }
964}
965
966/*
967 * Parse a viminfo line starting with '|'.
968 * Add each decoded value to "values".
969 * Returns TRUE if the next line is to be read after using the parsed values.
970 */
971 static int
972barline_parse(vir_T *virp, char_u *text, garray_T *values)
973{
974 char_u *p = text;
975 char_u *nextp = NULL;
976 char_u *buf = NULL;
977 bval_T *value;
978 int i;
979 int allocated = FALSE;
980 int eof;
981 char_u *sconv;
982 int converted;
983
984 while (*p == ',')
985 {
986 ++p;
987 if (ga_grow(values, 1) == FAIL)
988 break;
989 value = (bval_T *)(values->ga_data) + values->ga_len;
990
991 if (*p == '>')
992 {
993 // Need to read a continuation line. Put strings in allocated
994 // memory, because virp->vir_line is overwritten.
995 if (!allocated)
996 {
997 for (i = 0; i < values->ga_len; ++i)
998 {
999 bval_T *vp = (bval_T *)(values->ga_data) + i;
1000
1001 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
1002 {
1003 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
1004 vp->bv_allocated = TRUE;
1005 }
1006 }
1007 allocated = TRUE;
1008 }
1009
1010 if (vim_isdigit(p[1]))
1011 {
1012 size_t len;
1013 size_t todo;
1014 size_t n;
1015
1016 // String value was split into lines that are each shorter
1017 // than LSIZE:
1018 // |{bartype},>{length of "{text}{text2}"}
1019 // |<"{text1}
1020 // |<{text2}",{value}
1021 // Length includes the quotes.
1022 ++p;
1023 len = getdigits(&p);
1024 buf = alloc((int)(len + 1));
1025 if (buf == NULL)
1026 return TRUE;
1027 p = buf;
1028 for (todo = len; todo > 0; todo -= n)
1029 {
1030 eof = viminfo_readline(virp);
1031 if (eof || virp->vir_line[0] != '|'
1032 || virp->vir_line[1] != '<')
1033 {
1034 // File was truncated or garbled. Read another line if
1035 // this one starts with '|'.
1036 vim_free(buf);
1037 return eof || virp->vir_line[0] == '|';
1038 }
1039 // Get length of text, excluding |< and NL chars.
1040 n = STRLEN(virp->vir_line);
1041 while (n > 0 && (virp->vir_line[n - 1] == NL
1042 || virp->vir_line[n - 1] == CAR))
1043 --n;
1044 n -= 2;
1045 if (n > todo)
1046 {
1047 // more values follow after the string
1048 nextp = virp->vir_line + 2 + todo;
1049 n = todo;
1050 }
1051 mch_memmove(p, virp->vir_line + 2, n);
1052 p += n;
1053 }
1054 *p = NUL;
1055 p = buf;
1056 }
1057 else
1058 {
1059 // Line ending in ">" continues in the next line:
1060 // |{bartype},{lots of values},>
1061 // |<{value},{value}
1062 eof = viminfo_readline(virp);
1063 if (eof || virp->vir_line[0] != '|'
1064 || virp->vir_line[1] != '<')
1065 // File was truncated or garbled. Read another line if
1066 // this one starts with '|'.
1067 return eof || virp->vir_line[0] == '|';
1068 p = virp->vir_line + 2;
1069 }
1070 }
1071
1072 if (isdigit(*p))
1073 {
1074 value->bv_type = BVAL_NR;
1075 value->bv_nr = getdigits(&p);
1076 ++values->ga_len;
1077 }
1078 else if (*p == '"')
1079 {
1080 int len = 0;
1081 char_u *s = p;
1082
1083 // Unescape special characters in-place.
1084 ++p;
1085 while (*p != '"')
1086 {
1087 if (*p == NL || *p == NUL)
1088 return TRUE; // syntax error, drop the value
1089 if (*p == '\\')
1090 {
1091 ++p;
1092 if (*p == 'n')
1093 s[len++] = '\n';
1094 else
1095 s[len++] = *p;
1096 ++p;
1097 }
1098 else
1099 s[len++] = *p++;
1100 }
1101 ++p;
1102 s[len] = NUL;
1103
1104 converted = FALSE;
Bram Moolenaar408030e2020-02-10 22:44:32 +01001105 value->bv_tofree = NULL;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001106 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
1107 {
1108 sconv = string_convert(&virp->vir_conv, s, NULL);
1109 if (sconv != NULL)
1110 {
1111 if (s == buf)
Bram Moolenaar408030e2020-02-10 22:44:32 +01001112 // the converted string is stored in bv_string and
1113 // freed later, also need to free "buf" later
1114 value->bv_tofree = buf;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001115 s = sconv;
Bram Moolenaardefa0672019-07-21 19:25:37 +02001116 converted = TRUE;
1117 }
1118 }
1119
1120 // Need to copy in allocated memory if the string wasn't allocated
1121 // above and we did allocate before, thus vir_line may change.
Bram Moolenaar408030e2020-02-10 22:44:32 +01001122 if (s != buf && allocated && !converted)
Bram Moolenaardefa0672019-07-21 19:25:37 +02001123 s = vim_strsave(s);
1124 value->bv_string = s;
1125 value->bv_type = BVAL_STRING;
1126 value->bv_len = len;
1127 value->bv_allocated = allocated || converted;
1128 ++values->ga_len;
1129 if (nextp != NULL)
1130 {
1131 // values following a long string
1132 p = nextp;
1133 nextp = NULL;
1134 }
1135 }
1136 else if (*p == ',')
1137 {
1138 value->bv_type = BVAL_EMPTY;
1139 ++values->ga_len;
1140 }
1141 else
1142 break;
1143 }
1144 return TRUE;
1145}
1146
Bram Moolenaardefa0672019-07-21 19:25:37 +02001147 static void
1148write_viminfo_version(FILE *fp_out)
1149{
1150 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
1151 BARTYPE_VERSION, VIMINFO_VERSION);
1152}
1153
1154 static int
1155no_viminfo(void)
1156{
1157 // "vim -i NONE" does not read or write a viminfo file
1158 return STRCMP(p_viminfofile, "NONE") == 0;
1159}
1160
1161/*
1162 * Report an error for reading a viminfo file.
1163 * Count the number of errors. When there are more than 10, return TRUE.
1164 */
Bram Moolenaarc3328162019-07-23 22:15:25 +02001165 static int
Bram Moolenaardefa0672019-07-21 19:25:37 +02001166viminfo_error(char *errnum, char *message, char_u *line)
1167{
1168 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1169 errnum, message);
1170 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1171 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1172 IObuff[STRLEN(IObuff) - 1] = NUL;
1173 emsg((char *)IObuff);
1174 if (++viminfo_errcnt >= 10)
1175 {
1176 emsg(_("E136: viminfo: Too many errors, skipping rest of file"));
1177 return TRUE;
1178 }
1179 return FALSE;
1180}
1181
1182/*
1183 * Compare the 'encoding' value in the viminfo file with the current value of
1184 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
1185 * conversion of text with iconv() in viminfo_readstring().
1186 */
1187 static int
1188viminfo_encoding(vir_T *virp)
1189{
1190 char_u *p;
1191 int i;
1192
1193 if (get_viminfo_parameter('c') != 0)
1194 {
1195 p = vim_strchr(virp->vir_line, '=');
1196 if (p != NULL)
1197 {
1198 // remove trailing newline
1199 ++p;
1200 for (i = 0; vim_isprintc(p[i]); ++i)
1201 ;
1202 p[i] = NUL;
1203
1204 convert_setup(&virp->vir_conv, p, p_enc);
1205 }
1206 }
1207 return viminfo_readline(virp);
1208}
1209
1210#if defined(FEAT_EVAL) || defined(PROTO)
1211/*
1212 * Restore global vars that start with a capital from the viminfo file
1213 */
1214 static int
1215read_viminfo_varlist(vir_T *virp, int writing)
1216{
1217 char_u *tab;
1218 int type = VAR_NUMBER;
1219 typval_T tv;
1220 funccal_entry_T funccal_entry;
1221
1222 if (!writing && (find_viminfo_parameter('!') != NULL))
1223 {
1224 tab = vim_strchr(virp->vir_line + 1, '\t');
1225 if (tab != NULL)
1226 {
1227 *tab++ = '\0'; // isolate the variable name
1228 switch (*tab)
1229 {
1230 case 'S': type = VAR_STRING; break;
1231#ifdef FEAT_FLOAT
1232 case 'F': type = VAR_FLOAT; break;
1233#endif
1234 case 'D': type = VAR_DICT; break;
1235 case 'L': type = VAR_LIST; break;
1236 case 'B': type = VAR_BLOB; break;
1237 case 'X': type = VAR_SPECIAL; break;
1238 }
1239
1240 tab = vim_strchr(tab, '\t');
1241 if (tab != NULL)
1242 {
1243 tv.v_type = type;
1244 if (type == VAR_STRING || type == VAR_DICT
1245 || type == VAR_LIST || type == VAR_BLOB)
1246 tv.vval.v_string = viminfo_readstring(virp,
1247 (int)(tab - virp->vir_line + 1), TRUE);
1248#ifdef FEAT_FLOAT
1249 else if (type == VAR_FLOAT)
1250 (void)string2float(tab + 1, &tv.vval.v_float);
1251#endif
1252 else
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001253 {
Bram Moolenaardefa0672019-07-21 19:25:37 +02001254 tv.vval.v_number = atol((char *)tab + 1);
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001255 if (type == VAR_SPECIAL && (tv.vval.v_number == VVAL_FALSE
1256 || tv.vval.v_number == VVAL_TRUE))
1257 tv.v_type = VAR_BOOL;
1258 }
Bram Moolenaardefa0672019-07-21 19:25:37 +02001259 if (type == VAR_DICT || type == VAR_LIST)
1260 {
1261 typval_T *etv = eval_expr(tv.vval.v_string, NULL);
1262
1263 if (etv == NULL)
1264 // Failed to parse back the dict or list, use it as a
1265 // string.
1266 tv.v_type = VAR_STRING;
1267 else
1268 {
1269 vim_free(tv.vval.v_string);
1270 tv = *etv;
1271 vim_free(etv);
1272 }
1273 }
1274 else if (type == VAR_BLOB)
1275 {
1276 blob_T *blob = string2blob(tv.vval.v_string);
1277
1278 if (blob == NULL)
1279 // Failed to parse back the blob, use it as a string.
1280 tv.v_type = VAR_STRING;
1281 else
1282 {
1283 vim_free(tv.vval.v_string);
1284 tv.v_type = VAR_BLOB;
1285 tv.vval.v_blob = blob;
1286 }
1287 }
1288
1289 // when in a function use global variables
1290 save_funccal(&funccal_entry);
1291 set_var(virp->vir_line + 1, &tv, FALSE);
1292 restore_funccal();
1293
1294 if (tv.v_type == VAR_STRING)
1295 vim_free(tv.vval.v_string);
1296 else if (tv.v_type == VAR_DICT || tv.v_type == VAR_LIST ||
1297 tv.v_type == VAR_BLOB)
1298 clear_tv(&tv);
1299 }
1300 }
1301 }
1302
1303 return viminfo_readline(virp);
1304}
1305
1306/*
1307 * Write global vars that start with a capital to the viminfo file
1308 */
1309 static void
1310write_viminfo_varlist(FILE *fp)
1311{
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001312 hashtab_T *gvht = get_globvar_ht();
Bram Moolenaardefa0672019-07-21 19:25:37 +02001313 hashitem_T *hi;
1314 dictitem_T *this_var;
1315 int todo;
1316 char *s = "";
1317 char_u *p;
1318 char_u *tofree;
1319 char_u numbuf[NUMBUFLEN];
1320
1321 if (find_viminfo_parameter('!') == NULL)
1322 return;
1323
1324 fputs(_("\n# global variables:\n"), fp);
1325
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001326 todo = (int)gvht->ht_used;
1327 for (hi = gvht->ht_array; todo > 0; ++hi)
Bram Moolenaardefa0672019-07-21 19:25:37 +02001328 {
1329 if (!HASHITEM_EMPTY(hi))
1330 {
1331 --todo;
1332 this_var = HI2DI(hi);
1333 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
1334 {
1335 switch (this_var->di_tv.v_type)
1336 {
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001337 case VAR_STRING: s = "STR"; break;
1338 case VAR_NUMBER: s = "NUM"; break;
1339 case VAR_FLOAT: s = "FLO"; break;
1340 case VAR_DICT: s = "DIC"; break;
1341 case VAR_LIST: s = "LIS"; break;
1342 case VAR_BLOB: s = "BLO"; break;
1343 case VAR_BOOL: s = "XPL"; break; // backwards compat.
Bram Moolenaardefa0672019-07-21 19:25:37 +02001344 case VAR_SPECIAL: s = "XPL"; break;
1345
1346 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001347 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001348 case VAR_VOID:
Bram Moolenaardefa0672019-07-21 19:25:37 +02001349 case VAR_FUNC:
1350 case VAR_PARTIAL:
1351 case VAR_JOB:
1352 case VAR_CHANNEL:
1353 continue;
1354 }
1355 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001356 if (this_var->di_tv.v_type == VAR_BOOL
1357 || this_var->di_tv.v_type == VAR_SPECIAL)
Bram Moolenaardefa0672019-07-21 19:25:37 +02001358 {
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +01001359 // do not use "v:true" but "1"
Bram Moolenaardefa0672019-07-21 19:25:37 +02001360 sprintf((char *)numbuf, "%ld",
1361 (long)this_var->di_tv.vval.v_number);
1362 p = numbuf;
1363 tofree = NULL;
1364 }
1365 else
1366 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
1367 if (p != NULL)
1368 viminfo_writestring(fp, p);
1369 vim_free(tofree);
1370 }
1371 }
1372 }
1373}
1374#endif // FEAT_EVAL
1375
Bram Moolenaarc3328162019-07-23 22:15:25 +02001376 static int
1377read_viminfo_sub_string(vir_T *virp, int force)
1378{
1379 if (force || get_old_sub() == NULL)
1380 set_old_sub(viminfo_readstring(virp, 1, TRUE));
1381 return viminfo_readline(virp);
1382}
1383
1384 static void
1385write_viminfo_sub_string(FILE *fp)
1386{
1387 char_u *old_sub = get_old_sub();
1388
1389 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
1390 {
1391 fputs(_("\n# Last Substitute String:\n$"), fp);
1392 viminfo_writestring(fp, old_sub);
1393 }
1394}
1395
1396/*
1397 * Functions relating to reading/writing the search pattern from viminfo
1398 */
1399
1400 static int
1401read_viminfo_search_pattern(vir_T *virp, int force)
1402{
1403 char_u *lp;
1404 int idx = -1;
1405 int magic = FALSE;
1406 int no_scs = FALSE;
1407 int off_line = FALSE;
1408 int off_end = 0;
1409 long off = 0;
1410 int setlast = FALSE;
1411#ifdef FEAT_SEARCH_EXTRA
1412 static int hlsearch_on = FALSE;
1413#endif
1414 char_u *val;
1415 spat_T *spat;
1416
1417 // Old line types:
1418 // "/pat", "&pat": search/subst. pat
1419 // "~/pat", "~&pat": last used search/subst. pat
1420 // New line types:
1421 // "~h", "~H": hlsearch highlighting off/on
1422 // "~<magic><smartcase><line><end><off><last><which>pat"
1423 // <magic>: 'm' off, 'M' on
1424 // <smartcase>: 's' off, 'S' on
1425 // <line>: 'L' line offset, 'l' char offset
1426 // <end>: 'E' from end, 'e' from start
1427 // <off>: decimal, offset
1428 // <last>: '~' last used pattern
1429 // <which>: '/' search pat, '&' subst. pat
1430 lp = virp->vir_line;
1431 if (lp[0] == '~' && (lp[1] == 'm' || lp[1] == 'M')) // new line type
1432 {
1433 if (lp[1] == 'M') // magic on
1434 magic = TRUE;
1435 if (lp[2] == 's')
1436 no_scs = TRUE;
1437 if (lp[3] == 'L')
1438 off_line = TRUE;
1439 if (lp[4] == 'E')
1440 off_end = SEARCH_END;
1441 lp += 5;
1442 off = getdigits(&lp);
1443 }
1444 if (lp[0] == '~') // use this pattern for last-used pattern
1445 {
1446 setlast = TRUE;
1447 lp++;
1448 }
1449 if (lp[0] == '/')
1450 idx = RE_SEARCH;
1451 else if (lp[0] == '&')
1452 idx = RE_SUBST;
1453#ifdef FEAT_SEARCH_EXTRA
1454 else if (lp[0] == 'h') // ~h: 'hlsearch' highlighting off
1455 hlsearch_on = FALSE;
1456 else if (lp[0] == 'H') // ~H: 'hlsearch' highlighting on
1457 hlsearch_on = TRUE;
1458#endif
Bram Moolenaarc3328162019-07-23 22:15:25 +02001459 if (idx >= 0)
1460 {
Bram Moolenaar736cd2c2019-07-25 21:58:19 +02001461 spat = get_spat(idx);
Bram Moolenaarc3328162019-07-23 22:15:25 +02001462 if (force || spat->pat == NULL)
1463 {
1464 val = viminfo_readstring(virp, (int)(lp - virp->vir_line + 1),
1465 TRUE);
1466 if (val != NULL)
1467 {
1468 set_last_search_pat(val, idx, magic, setlast);
1469 vim_free(val);
1470 spat->no_scs = no_scs;
1471 spat->off.line = off_line;
1472 spat->off.end = off_end;
1473 spat->off.off = off;
1474#ifdef FEAT_SEARCH_EXTRA
1475 if (setlast)
1476 set_no_hlsearch(!hlsearch_on);
1477#endif
1478 }
1479 }
1480 }
1481 return viminfo_readline(virp);
1482}
1483
1484 static void
1485wvsp_one(
1486 FILE *fp, // file to write to
1487 int idx, // spats[] index
1488 char *s, // search pat
1489 int sc) // dir char
1490{
1491 spat_T *spat = get_spat(idx);
1492 if (spat->pat != NULL)
1493 {
1494 fprintf(fp, _("\n# Last %sSearch Pattern:\n~"), s);
1495 // off.dir is not stored, it's reset to forward
1496 fprintf(fp, "%c%c%c%c%ld%s%c",
1497 spat->magic ? 'M' : 'm', // magic
1498 spat->no_scs ? 's' : 'S', // smartcase
1499 spat->off.line ? 'L' : 'l', // line offset
1500 spat->off.end ? 'E' : 'e', // offset from end
1501 spat->off.off, // offset
1502 get_spat_last_idx() == idx ? "~" : "", // last used pat
1503 sc);
1504 viminfo_writestring(fp, spat->pat);
1505 }
1506}
1507
1508 static void
1509write_viminfo_search_pattern(FILE *fp)
1510{
1511 if (get_viminfo_parameter('/') != 0)
1512 {
1513#ifdef FEAT_SEARCH_EXTRA
1514 fprintf(fp, "\n# hlsearch on (H) or off (h):\n~%c",
1515 (no_hlsearch || find_viminfo_parameter('h') != NULL) ? 'h' : 'H');
1516#endif
1517 wvsp_one(fp, RE_SEARCH, "", '/');
1518 wvsp_one(fp, RE_SUBST, _("Substitute "), '&');
1519 }
1520}
1521
1522/*
1523 * Functions relating to reading/writing registers from viminfo
1524 */
1525
1526static yankreg_T *y_read_regs = NULL;
1527
1528#define REG_PREVIOUS 1
1529#define REG_EXEC 2
1530
1531/*
1532 * Prepare for reading viminfo registers when writing viminfo later.
1533 */
1534 static void
1535prepare_viminfo_registers(void)
1536{
1537 y_read_regs = ALLOC_CLEAR_MULT(yankreg_T, NUM_REGISTERS);
1538}
1539
1540 static void
1541finish_viminfo_registers(void)
1542{
1543 int i;
1544 int j;
1545
1546 if (y_read_regs != NULL)
1547 {
1548 for (i = 0; i < NUM_REGISTERS; ++i)
1549 if (y_read_regs[i].y_array != NULL)
1550 {
1551 for (j = 0; j < y_read_regs[i].y_size; j++)
1552 vim_free(y_read_regs[i].y_array[j]);
1553 vim_free(y_read_regs[i].y_array);
1554 }
1555 VIM_CLEAR(y_read_regs);
1556 }
1557}
1558
1559 static int
1560read_viminfo_register(vir_T *virp, int force)
1561{
1562 int eof;
1563 int do_it = TRUE;
1564 int size;
1565 int limit;
1566 int i;
1567 int set_prev = FALSE;
1568 char_u *str;
1569 char_u **array = NULL;
1570 int new_type = MCHAR; // init to shut up compiler
1571 colnr_T new_width = 0; // init to shut up compiler
1572 yankreg_T *y_current_p;
1573
1574 // We only get here (hopefully) if line[0] == '"'
1575 str = virp->vir_line + 1;
1576
1577 // If the line starts with "" this is the y_previous register.
1578 if (*str == '"')
1579 {
1580 set_prev = TRUE;
1581 str++;
1582 }
1583
1584 if (!ASCII_ISALNUM(*str) && *str != '-')
1585 {
1586 if (viminfo_error("E577: ", _("Illegal register name"), virp->vir_line))
1587 return TRUE; // too many errors, pretend end-of-file
1588 do_it = FALSE;
1589 }
1590 get_yank_register(*str++, FALSE);
1591 y_current_p = get_y_current();
1592 if (!force && y_current_p->y_array != NULL)
1593 do_it = FALSE;
1594
1595 if (*str == '@')
1596 {
1597 // "x@: register x used for @@
1598 if (force || get_execreg_lastc() == NUL)
1599 set_execreg_lastc(str[-1]);
1600 }
1601
1602 size = 0;
1603 limit = 100; // Optimized for registers containing <= 100 lines
1604 if (do_it)
1605 {
1606 // Build the new register in array[].
1607 // y_array is kept as-is until done.
1608 // The "do_it" flag is reset when something is wrong, in which case
1609 // array[] needs to be freed.
1610 if (set_prev)
1611 set_y_previous(y_current_p);
1612 array = ALLOC_MULT(char_u *, limit);
1613 str = skipwhite(skiptowhite(str));
1614 if (STRNCMP(str, "CHAR", 4) == 0)
1615 new_type = MCHAR;
1616 else if (STRNCMP(str, "BLOCK", 5) == 0)
1617 new_type = MBLOCK;
1618 else
1619 new_type = MLINE;
1620 // get the block width; if it's missing we get a zero, which is OK
1621 str = skipwhite(skiptowhite(str));
1622 new_width = getdigits(&str);
1623 }
1624
1625 while (!(eof = viminfo_readline(virp))
1626 && (virp->vir_line[0] == TAB || virp->vir_line[0] == '<'))
1627 {
1628 if (do_it)
1629 {
1630 if (size == limit)
1631 {
1632 char_u **new_array = (char_u **)
1633 alloc(limit * 2 * sizeof(char_u *));
1634
1635 if (new_array == NULL)
1636 {
1637 do_it = FALSE;
1638 break;
1639 }
1640 for (i = 0; i < limit; i++)
1641 new_array[i] = array[i];
1642 vim_free(array);
1643 array = new_array;
1644 limit *= 2;
1645 }
1646 str = viminfo_readstring(virp, 1, TRUE);
1647 if (str != NULL)
1648 array[size++] = str;
1649 else
1650 // error, don't store the result
1651 do_it = FALSE;
1652 }
1653 }
1654
1655 if (do_it)
1656 {
1657 // free y_array[]
1658 for (i = 0; i < y_current_p->y_size; i++)
1659 vim_free(y_current_p->y_array[i]);
1660 vim_free(y_current_p->y_array);
1661
1662 y_current_p->y_type = new_type;
1663 y_current_p->y_width = new_width;
1664 y_current_p->y_size = size;
1665 y_current_p->y_time_set = 0;
1666 if (size == 0)
1667 {
1668 y_current_p->y_array = NULL;
1669 }
1670 else
1671 {
1672 // Move the lines from array[] to y_array[].
1673 y_current_p->y_array = ALLOC_MULT(char_u *, size);
1674 for (i = 0; i < size; i++)
1675 {
1676 if (y_current_p->y_array == NULL)
1677 vim_free(array[i]);
1678 else
1679 y_current_p->y_array[i] = array[i];
1680 }
1681 }
1682 }
1683 else
1684 {
1685 // Free array[] if it was filled.
1686 for (i = 0; i < size; i++)
1687 vim_free(array[i]);
1688 }
1689 vim_free(array);
1690
1691 return eof;
1692}
1693
1694/*
1695 * Accept a new style register line from the viminfo, store it when it's new.
1696 */
1697 static void
1698handle_viminfo_register(garray_T *values, int force)
1699{
1700 bval_T *vp = (bval_T *)values->ga_data;
1701 int flags;
1702 int name;
1703 int type;
1704 int linecount;
1705 int width;
1706 time_t timestamp;
1707 yankreg_T *y_ptr;
1708 yankreg_T *y_regs_p = get_y_regs();
1709 int i;
1710
1711 // Check the format:
1712 // |{bartype},{flags},{name},{type},
1713 // {linecount},{width},{timestamp},"line1","line2"
1714 if (values->ga_len < 6
1715 || vp[0].bv_type != BVAL_NR
1716 || vp[1].bv_type != BVAL_NR
1717 || vp[2].bv_type != BVAL_NR
1718 || vp[3].bv_type != BVAL_NR
1719 || vp[4].bv_type != BVAL_NR
1720 || vp[5].bv_type != BVAL_NR)
1721 return;
1722 flags = vp[0].bv_nr;
1723 name = vp[1].bv_nr;
1724 if (name < 0 || name >= NUM_REGISTERS)
1725 return;
1726 type = vp[2].bv_nr;
1727 if (type != MCHAR && type != MLINE && type != MBLOCK)
1728 return;
1729 linecount = vp[3].bv_nr;
1730 if (values->ga_len < 6 + linecount)
1731 return;
1732 width = vp[4].bv_nr;
1733 if (width < 0)
1734 return;
1735
1736 if (y_read_regs != NULL)
1737 // Reading viminfo for merging and writing. Store the register
1738 // content, don't update the current registers.
1739 y_ptr = &y_read_regs[name];
1740 else
1741 y_ptr = &y_regs_p[name];
1742
1743 // Do not overwrite unless forced or the timestamp is newer.
1744 timestamp = (time_t)vp[5].bv_nr;
1745 if (y_ptr->y_array != NULL && !force
1746 && (timestamp == 0 || y_ptr->y_time_set > timestamp))
1747 return;
1748
1749 if (y_ptr->y_array != NULL)
1750 for (i = 0; i < y_ptr->y_size; i++)
1751 vim_free(y_ptr->y_array[i]);
1752 vim_free(y_ptr->y_array);
1753
1754 if (y_read_regs == NULL)
1755 {
1756 if (flags & REG_PREVIOUS)
1757 set_y_previous(y_ptr);
1758 if ((flags & REG_EXEC) && (force || get_execreg_lastc() == NUL))
1759 set_execreg_lastc(get_register_name(name));
1760 }
1761 y_ptr->y_type = type;
1762 y_ptr->y_width = width;
1763 y_ptr->y_size = linecount;
1764 y_ptr->y_time_set = timestamp;
1765 if (linecount == 0)
1766 {
1767 y_ptr->y_array = NULL;
1768 return;
1769 }
1770 y_ptr->y_array = ALLOC_MULT(char_u *, linecount);
1771 if (y_ptr->y_array == NULL)
1772 {
1773 y_ptr->y_size = 0; // ensure object state is consistent
1774 return;
1775 }
1776 for (i = 0; i < linecount; i++)
1777 {
1778 if (vp[i + 6].bv_allocated)
1779 {
1780 y_ptr->y_array[i] = vp[i + 6].bv_string;
1781 vp[i + 6].bv_string = NULL;
1782 }
1783 else
1784 y_ptr->y_array[i] = vim_strsave(vp[i + 6].bv_string);
1785 }
1786}
1787
1788 static void
1789write_viminfo_registers(FILE *fp)
1790{
1791 int i, j;
1792 char_u *type;
1793 char_u c;
1794 int num_lines;
1795 int max_num_lines;
1796 int max_kbyte;
1797 long len;
1798 yankreg_T *y_ptr;
1799 yankreg_T *y_regs_p = get_y_regs();;
1800
1801 fputs(_("\n# Registers:\n"), fp);
1802
1803 // Get '<' value, use old '"' value if '<' is not found.
1804 max_num_lines = get_viminfo_parameter('<');
1805 if (max_num_lines < 0)
1806 max_num_lines = get_viminfo_parameter('"');
1807 if (max_num_lines == 0)
1808 return;
1809 max_kbyte = get_viminfo_parameter('s');
1810 if (max_kbyte == 0)
1811 return;
1812
1813 for (i = 0; i < NUM_REGISTERS; i++)
1814 {
1815#ifdef FEAT_CLIPBOARD
1816 // Skip '*'/'+' register, we don't want them back next time
1817 if (i == STAR_REGISTER || i == PLUS_REGISTER)
1818 continue;
1819#endif
1820#ifdef FEAT_DND
1821 // Neither do we want the '~' register
1822 if (i == TILDE_REGISTER)
1823 continue;
1824#endif
1825 // When reading viminfo for merging and writing: Use the register from
1826 // viminfo if it's newer.
1827 if (y_read_regs != NULL
1828 && y_read_regs[i].y_array != NULL
1829 && (y_regs_p[i].y_array == NULL ||
1830 y_read_regs[i].y_time_set > y_regs_p[i].y_time_set))
1831 y_ptr = &y_read_regs[i];
1832 else if (y_regs_p[i].y_array == NULL)
1833 continue;
1834 else
1835 y_ptr = &y_regs_p[i];
1836
1837 // Skip empty registers.
1838 num_lines = y_ptr->y_size;
1839 if (num_lines == 0
1840 || (num_lines == 1 && y_ptr->y_type == MCHAR
1841 && *y_ptr->y_array[0] == NUL))
1842 continue;
1843
1844 if (max_kbyte > 0)
1845 {
1846 // Skip register if there is more text than the maximum size.
1847 len = 0;
1848 for (j = 0; j < num_lines; j++)
1849 len += (long)STRLEN(y_ptr->y_array[j]) + 1L;
1850 if (len > (long)max_kbyte * 1024L)
1851 continue;
1852 }
1853
1854 switch (y_ptr->y_type)
1855 {
1856 case MLINE:
1857 type = (char_u *)"LINE";
1858 break;
1859 case MCHAR:
1860 type = (char_u *)"CHAR";
1861 break;
1862 case MBLOCK:
1863 type = (char_u *)"BLOCK";
1864 break;
1865 default:
1866 semsg(_("E574: Unknown register type %d"), y_ptr->y_type);
1867 type = (char_u *)"LINE";
1868 break;
1869 }
1870 if (get_y_previous() == &y_regs_p[i])
1871 fprintf(fp, "\"");
1872 c = get_register_name(i);
1873 fprintf(fp, "\"%c", c);
1874 if (c == get_execreg_lastc())
1875 fprintf(fp, "@");
1876 fprintf(fp, "\t%s\t%d\n", type, (int)y_ptr->y_width);
1877
1878 // If max_num_lines < 0, then we save ALL the lines in the register
1879 if (max_num_lines > 0 && num_lines > max_num_lines)
1880 num_lines = max_num_lines;
1881 for (j = 0; j < num_lines; j++)
1882 {
1883 putc('\t', fp);
1884 viminfo_writestring(fp, y_ptr->y_array[j]);
1885 }
1886
1887 {
1888 int flags = 0;
1889 int remaining;
1890
1891 // New style with a bar line. Format:
1892 // |{bartype},{flags},{name},{type},
1893 // {linecount},{width},{timestamp},"line1","line2"
1894 // flags: REG_PREVIOUS - register is y_previous
1895 // REG_EXEC - used for @@
1896 if (get_y_previous() == &y_regs_p[i])
1897 flags |= REG_PREVIOUS;
1898 if (c == get_execreg_lastc())
1899 flags |= REG_EXEC;
1900 fprintf(fp, "|%d,%d,%d,%d,%d,%d,%ld", BARTYPE_REGISTER, flags,
1901 i, y_ptr->y_type, num_lines, (int)y_ptr->y_width,
1902 (long)y_ptr->y_time_set);
1903 // 11 chars for type/flags/name/type, 3 * 20 for numbers
1904 remaining = LSIZE - 71;
1905 for (j = 0; j < num_lines; j++)
1906 {
1907 putc(',', fp);
1908 --remaining;
1909 remaining = barline_writestring(fp, y_ptr->y_array[j],
1910 remaining);
1911 }
1912 putc('\n', fp);
1913 }
1914 }
1915}
1916
1917/*
1918 * Functions relating to reading/writing marks from viminfo
1919 */
1920
1921static xfmark_T *vi_namedfm = NULL;
1922#ifdef FEAT_JUMPLIST
1923static xfmark_T *vi_jumplist = NULL;
1924static int vi_jumplist_len = 0;
1925#endif
1926
1927 static void
1928write_one_mark(FILE *fp_out, int c, pos_T *pos)
1929{
1930 if (pos->lnum != 0)
1931 fprintf(fp_out, "\t%c\t%ld\t%d\n", c, (long)pos->lnum, (int)pos->col);
1932}
1933
1934 static void
1935write_buffer_marks(buf_T *buf, FILE *fp_out)
1936{
1937 int i;
1938 pos_T pos;
1939
1940 home_replace(NULL, buf->b_ffname, IObuff, IOSIZE, TRUE);
1941 fprintf(fp_out, "\n> ");
1942 viminfo_writestring(fp_out, IObuff);
1943
1944 // Write the last used timestamp as the lnum of the non-existing mark '*'.
1945 // Older Vims will ignore it and/or copy it.
1946 pos.lnum = (linenr_T)buf->b_last_used;
1947 pos.col = 0;
1948 write_one_mark(fp_out, '*', &pos);
1949
1950 write_one_mark(fp_out, '"', &buf->b_last_cursor);
1951 write_one_mark(fp_out, '^', &buf->b_last_insert);
1952 write_one_mark(fp_out, '.', &buf->b_last_change);
1953#ifdef FEAT_JUMPLIST
1954 // changelist positions are stored oldest first
1955 for (i = 0; i < buf->b_changelistlen; ++i)
1956 {
1957 // skip duplicates
1958 if (i == 0 || !EQUAL_POS(buf->b_changelist[i - 1],
1959 buf->b_changelist[i]))
1960 write_one_mark(fp_out, '+', &buf->b_changelist[i]);
1961 }
1962#endif
1963 for (i = 0; i < NMARKS; i++)
1964 write_one_mark(fp_out, 'a' + i, &buf->b_namedm[i]);
1965}
1966
1967/*
1968 * Return TRUE if marks for "buf" should not be written.
1969 */
1970 static int
1971skip_for_viminfo(buf_T *buf)
1972{
1973 return
1974#ifdef FEAT_TERMINAL
1975 bt_terminal(buf) ||
1976#endif
1977 removable(buf->b_ffname);
1978}
1979
1980/*
1981 * Write all the named marks for all buffers.
1982 * When "buflist" is not NULL fill it with the buffers for which marks are to
1983 * be written.
1984 */
1985 static void
1986write_viminfo_marks(FILE *fp_out, garray_T *buflist)
1987{
1988 buf_T *buf;
1989 int is_mark_set;
1990 int i;
1991 win_T *win;
1992 tabpage_T *tp;
1993
1994 // Set b_last_cursor for the all buffers that have a window.
1995 FOR_ALL_TAB_WINDOWS(tp, win)
1996 set_last_cursor(win);
1997
1998 fputs(_("\n# History of marks within files (newest to oldest):\n"), fp_out);
1999 FOR_ALL_BUFFERS(buf)
2000 {
2001 // Only write something if buffer has been loaded and at least one
2002 // mark is set.
2003 if (buf->b_marks_read)
2004 {
2005 if (buf->b_last_cursor.lnum != 0)
2006 is_mark_set = TRUE;
2007 else
2008 {
2009 is_mark_set = FALSE;
2010 for (i = 0; i < NMARKS; i++)
2011 if (buf->b_namedm[i].lnum != 0)
2012 {
2013 is_mark_set = TRUE;
2014 break;
2015 }
2016 }
2017 if (is_mark_set && buf->b_ffname != NULL
2018 && buf->b_ffname[0] != NUL
2019 && !skip_for_viminfo(buf))
2020 {
2021 if (buflist == NULL)
2022 write_buffer_marks(buf, fp_out);
2023 else if (ga_grow(buflist, 1) == OK)
2024 ((buf_T **)buflist->ga_data)[buflist->ga_len++] = buf;
2025 }
2026 }
2027 }
2028}
2029
2030 static void
2031write_one_filemark(
2032 FILE *fp,
2033 xfmark_T *fm,
2034 int c1,
2035 int c2)
2036{
2037 char_u *name;
2038
2039 if (fm->fmark.mark.lnum == 0) // not set
2040 return;
2041
2042 if (fm->fmark.fnum != 0) // there is a buffer
2043 name = buflist_nr2name(fm->fmark.fnum, TRUE, FALSE);
2044 else
2045 name = fm->fname; // use name from .viminfo
2046 if (name != NULL && *name != NUL)
2047 {
2048 fprintf(fp, "%c%c %ld %ld ", c1, c2, (long)fm->fmark.mark.lnum,
2049 (long)fm->fmark.mark.col);
2050 viminfo_writestring(fp, name);
2051
2052 // Barline: |{bartype},{name},{lnum},{col},{timestamp},{filename}
2053 // size up to filename: 8 + 3 * 20
2054 fprintf(fp, "|%d,%d,%ld,%ld,%ld,", BARTYPE_MARK, c2,
2055 (long)fm->fmark.mark.lnum, (long)fm->fmark.mark.col,
2056 (long)fm->time_set);
2057 barline_writestring(fp, name, LSIZE - 70);
2058 putc('\n', fp);
2059 }
2060
2061 if (fm->fmark.fnum != 0)
2062 vim_free(name);
2063}
2064
2065 static void
2066write_viminfo_filemarks(FILE *fp)
2067{
2068 int i;
2069 char_u *name;
2070 buf_T *buf;
2071 xfmark_T *namedfm_p = get_namedfm();
2072 xfmark_T *fm;
2073 int vi_idx;
2074 int idx;
2075
2076 if (get_viminfo_parameter('f') == 0)
2077 return;
2078
2079 fputs(_("\n# File marks:\n"), fp);
2080
2081 // Write the filemarks 'A - 'Z
2082 for (i = 0; i < NMARKS; i++)
2083 {
2084 if (vi_namedfm != NULL
Bram Moolenaar8cd6cd82019-12-27 17:33:26 +01002085 && (vi_namedfm[i].time_set > namedfm_p[i].time_set))
Bram Moolenaarc3328162019-07-23 22:15:25 +02002086 fm = &vi_namedfm[i];
2087 else
2088 fm = &namedfm_p[i];
2089 write_one_filemark(fp, fm, '\'', i + 'A');
2090 }
2091
2092 // Find a mark that is the same file and position as the cursor.
2093 // That one, or else the last one is deleted.
2094 // Move '0 to '1, '1 to '2, etc. until the matching one or '9
2095 // Set the '0 mark to current cursor position.
2096 if (curbuf->b_ffname != NULL && !skip_for_viminfo(curbuf))
2097 {
2098 name = buflist_nr2name(curbuf->b_fnum, TRUE, FALSE);
2099 for (i = NMARKS; i < NMARKS + EXTRA_MARKS - 1; ++i)
2100 if (namedfm_p[i].fmark.mark.lnum == curwin->w_cursor.lnum
2101 && (namedfm_p[i].fname == NULL
2102 ? namedfm_p[i].fmark.fnum == curbuf->b_fnum
2103 : (name != NULL
2104 && STRCMP(name, namedfm_p[i].fname) == 0)))
2105 break;
2106 vim_free(name);
2107
2108 vim_free(namedfm_p[i].fname);
2109 for ( ; i > NMARKS; --i)
2110 namedfm_p[i] = namedfm_p[i - 1];
2111 namedfm_p[NMARKS].fmark.mark = curwin->w_cursor;
2112 namedfm_p[NMARKS].fmark.fnum = curbuf->b_fnum;
2113 namedfm_p[NMARKS].fname = NULL;
2114 namedfm_p[NMARKS].time_set = vim_time();
2115 }
2116
2117 // Write the filemarks '0 - '9. Newest (highest timestamp) first.
2118 vi_idx = NMARKS;
2119 idx = NMARKS;
2120 for (i = NMARKS; i < NMARKS + EXTRA_MARKS; i++)
2121 {
2122 xfmark_T *vi_fm = vi_namedfm != NULL ? &vi_namedfm[vi_idx] : NULL;
2123
2124 if (vi_fm != NULL
2125 && vi_fm->fmark.mark.lnum != 0
2126 && (vi_fm->time_set > namedfm_p[idx].time_set
2127 || namedfm_p[idx].fmark.mark.lnum == 0))
2128 {
2129 fm = vi_fm;
2130 ++vi_idx;
2131 }
2132 else
2133 {
2134 fm = &namedfm_p[idx++];
2135 if (vi_fm != NULL
2136 && vi_fm->fmark.mark.lnum == fm->fmark.mark.lnum
2137 && vi_fm->time_set == fm->time_set
2138 && ((vi_fm->fmark.fnum != 0
2139 && vi_fm->fmark.fnum == fm->fmark.fnum)
2140 || (vi_fm->fname != NULL
2141 && fm->fname != NULL
2142 && STRCMP(vi_fm->fname, fm->fname) == 0)))
2143 ++vi_idx; // skip duplicate
2144 }
2145 write_one_filemark(fp, fm, '\'', i - NMARKS + '0');
2146 }
2147
2148#ifdef FEAT_JUMPLIST
2149 // Write the jumplist with -'
2150 fputs(_("\n# Jumplist (newest first):\n"), fp);
2151 setpcmark(); // add current cursor position
2152 cleanup_jumplist(curwin, FALSE);
2153 vi_idx = 0;
2154 idx = curwin->w_jumplistlen - 1;
2155 for (i = 0; i < JUMPLISTSIZE; ++i)
2156 {
2157 xfmark_T *vi_fm;
2158
2159 fm = idx >= 0 ? &curwin->w_jumplist[idx] : NULL;
2160 vi_fm = vi_idx < vi_jumplist_len ? &vi_jumplist[vi_idx] : NULL;
2161 if (fm == NULL && vi_fm == NULL)
2162 break;
2163 if (fm == NULL || (vi_fm != NULL && fm->time_set < vi_fm->time_set))
2164 {
2165 fm = vi_fm;
2166 ++vi_idx;
2167 }
2168 else
2169 --idx;
2170 if (fm->fmark.fnum == 0
2171 || ((buf = buflist_findnr(fm->fmark.fnum)) != NULL
2172 && !skip_for_viminfo(buf)))
2173 write_one_filemark(fp, fm, '-', '\'');
2174 }
2175#endif
2176}
2177
2178/*
2179 * Compare functions for qsort() below, that compares b_last_used.
2180 */
Bram Moolenaar52410572019-10-27 05:12:45 +01002181 int
Bram Moolenaarc3328162019-07-23 22:15:25 +02002182buf_compare(const void *s1, const void *s2)
2183{
2184 buf_T *buf1 = *(buf_T **)s1;
2185 buf_T *buf2 = *(buf_T **)s2;
2186
2187 if (buf1->b_last_used == buf2->b_last_used)
2188 return 0;
2189 return buf1->b_last_used > buf2->b_last_used ? -1 : 1;
2190}
2191
2192/*
2193 * Handle marks in the viminfo file:
2194 * fp_out != NULL: copy marks, in time order with buffers in "buflist".
2195 * fp_out == NULL && (flags & VIF_WANT_MARKS): read marks for curbuf only
2196 * fp_out == NULL && (flags & VIF_GET_OLDFILES | VIF_FORCEIT): fill v:oldfiles
2197 */
2198 static void
2199copy_viminfo_marks(
2200 vir_T *virp,
2201 FILE *fp_out,
2202 garray_T *buflist,
2203 int eof,
2204 int flags)
2205{
2206 char_u *line = virp->vir_line;
2207 buf_T *buf;
2208 int num_marked_files;
2209 int load_marks;
2210 int copy_marks_out;
2211 char_u *str;
2212 int i;
2213 char_u *p;
2214 char_u *name_buf;
2215 pos_T pos;
2216#ifdef FEAT_EVAL
2217 list_T *list = NULL;
2218#endif
2219 int count = 0;
2220 int buflist_used = 0;
2221 buf_T *buflist_buf = NULL;
2222
2223 if ((name_buf = alloc(LSIZE)) == NULL)
2224 return;
2225 *name_buf = NUL;
2226
2227 if (fp_out != NULL && buflist->ga_len > 0)
2228 {
2229 // Sort the list of buffers on b_last_used.
2230 qsort(buflist->ga_data, (size_t)buflist->ga_len,
2231 sizeof(buf_T *), buf_compare);
2232 buflist_buf = ((buf_T **)buflist->ga_data)[0];
2233 }
2234
2235#ifdef FEAT_EVAL
2236 if (fp_out == NULL && (flags & (VIF_GET_OLDFILES | VIF_FORCEIT)))
2237 {
2238 list = list_alloc();
2239 if (list != NULL)
2240 set_vim_var_list(VV_OLDFILES, list);
2241 }
2242#endif
2243
2244 num_marked_files = get_viminfo_parameter('\'');
2245 while (!eof && (count < num_marked_files || fp_out == NULL))
2246 {
2247 if (line[0] != '>')
2248 {
2249 if (line[0] != '\n' && line[0] != '\r' && line[0] != '#')
2250 {
2251 if (viminfo_error("E576: ", _("Missing '>'"), line))
2252 break; // too many errors, return now
2253 }
2254 eof = vim_fgets(line, LSIZE, virp->vir_fd);
2255 continue; // Skip this dud line
2256 }
2257
2258 // Handle long line and translate escaped characters.
2259 // Find file name, set str to start.
2260 // Ignore leading and trailing white space.
2261 str = skipwhite(line + 1);
2262 str = viminfo_readstring(virp, (int)(str - virp->vir_line), FALSE);
2263 if (str == NULL)
2264 continue;
2265 p = str + STRLEN(str);
2266 while (p != str && (*p == NUL || vim_isspace(*p)))
2267 p--;
2268 if (*p)
2269 p++;
2270 *p = NUL;
2271
2272#ifdef FEAT_EVAL
2273 if (list != NULL)
2274 list_append_string(list, str, -1);
2275#endif
2276
2277 // If fp_out == NULL, load marks for current buffer.
2278 // If fp_out != NULL, copy marks for buffers not in buflist.
2279 load_marks = copy_marks_out = FALSE;
2280 if (fp_out == NULL)
2281 {
2282 if ((flags & VIF_WANT_MARKS) && curbuf->b_ffname != NULL)
2283 {
2284 if (*name_buf == NUL) // only need to do this once
2285 home_replace(NULL, curbuf->b_ffname, name_buf, LSIZE, TRUE);
2286 if (fnamecmp(str, name_buf) == 0)
2287 load_marks = TRUE;
2288 }
2289 }
2290 else // fp_out != NULL
2291 {
2292 // This is slow if there are many buffers!!
2293 FOR_ALL_BUFFERS(buf)
2294 if (buf->b_ffname != NULL)
2295 {
2296 home_replace(NULL, buf->b_ffname, name_buf, LSIZE, TRUE);
2297 if (fnamecmp(str, name_buf) == 0)
2298 break;
2299 }
2300
2301 // Copy marks if the buffer has not been loaded.
2302 if (buf == NULL || !buf->b_marks_read)
2303 {
2304 int did_read_line = FALSE;
2305
2306 if (buflist_buf != NULL)
2307 {
2308 // Read the next line. If it has the "*" mark compare the
2309 // time stamps. Write entries from "buflist" that are
2310 // newer.
2311 if (!(eof = viminfo_readline(virp)) && line[0] == TAB)
2312 {
2313 did_read_line = TRUE;
2314 if (line[1] == '*')
2315 {
2316 long ltime;
2317
2318 sscanf((char *)line + 2, "%ld ", &ltime);
2319 while ((time_T)ltime < buflist_buf->b_last_used)
2320 {
2321 write_buffer_marks(buflist_buf, fp_out);
2322 if (++count >= num_marked_files)
2323 break;
2324 if (++buflist_used == buflist->ga_len)
2325 {
2326 buflist_buf = NULL;
2327 break;
2328 }
2329 buflist_buf =
2330 ((buf_T **)buflist->ga_data)[buflist_used];
2331 }
2332 }
2333 else
2334 {
2335 // No timestamp, must be written by an older Vim.
Bram Moolenaar32aa1022019-11-02 22:54:41 +01002336 // Assume all remaining buffers are older than
Bram Moolenaarc3328162019-07-23 22:15:25 +02002337 // ours.
2338 while (count < num_marked_files
2339 && buflist_used < buflist->ga_len)
2340 {
2341 buflist_buf = ((buf_T **)buflist->ga_data)
2342 [buflist_used++];
2343 write_buffer_marks(buflist_buf, fp_out);
2344 ++count;
2345 }
2346 buflist_buf = NULL;
2347 }
2348
2349 if (count >= num_marked_files)
2350 {
2351 vim_free(str);
2352 break;
2353 }
2354 }
2355 }
2356
2357 fputs("\n> ", fp_out);
2358 viminfo_writestring(fp_out, str);
2359 if (did_read_line)
2360 fputs((char *)line, fp_out);
2361
2362 count++;
2363 copy_marks_out = TRUE;
2364 }
2365 }
2366 vim_free(str);
2367
2368 pos.coladd = 0;
2369 while (!(eof = viminfo_readline(virp)) && line[0] == TAB)
2370 {
2371 if (load_marks)
2372 {
2373 if (line[1] != NUL)
2374 {
2375 unsigned u;
2376
2377 sscanf((char *)line + 2, "%ld %u", &pos.lnum, &u);
2378 pos.col = u;
2379 switch (line[1])
2380 {
2381 case '"': curbuf->b_last_cursor = pos; break;
2382 case '^': curbuf->b_last_insert = pos; break;
2383 case '.': curbuf->b_last_change = pos; break;
2384 case '+':
2385#ifdef FEAT_JUMPLIST
2386 // changelist positions are stored oldest
2387 // first
2388 if (curbuf->b_changelistlen == JUMPLISTSIZE)
2389 // list is full, remove oldest entry
2390 mch_memmove(curbuf->b_changelist,
2391 curbuf->b_changelist + 1,
2392 sizeof(pos_T) * (JUMPLISTSIZE - 1));
2393 else
2394 ++curbuf->b_changelistlen;
2395 curbuf->b_changelist[
2396 curbuf->b_changelistlen - 1] = pos;
2397#endif
2398 break;
2399
2400 // Using the line number for the last-used
2401 // timestamp.
2402 case '*': curbuf->b_last_used = pos.lnum; break;
2403
2404 default: if ((i = line[1] - 'a') >= 0 && i < NMARKS)
2405 curbuf->b_namedm[i] = pos;
2406 }
2407 }
2408 }
2409 else if (copy_marks_out)
2410 fputs((char *)line, fp_out);
2411 }
2412
2413 if (load_marks)
2414 {
2415#ifdef FEAT_JUMPLIST
2416 win_T *wp;
2417
2418 FOR_ALL_WINDOWS(wp)
2419 {
2420 if (wp->w_buffer == curbuf)
2421 wp->w_changelistidx = curbuf->b_changelistlen;
2422 }
2423#endif
2424 break;
2425 }
2426 }
2427
2428 if (fp_out != NULL)
2429 // Write any remaining entries from buflist.
2430 while (count < num_marked_files && buflist_used < buflist->ga_len)
2431 {
2432 buflist_buf = ((buf_T **)buflist->ga_data)[buflist_used++];
2433 write_buffer_marks(buflist_buf, fp_out);
2434 ++count;
2435 }
2436
2437 vim_free(name_buf);
2438}
2439
2440/*
2441 * Read marks for the current buffer from the viminfo file, when we support
2442 * buffer marks and the buffer has a name.
2443 */
2444 void
2445check_marks_read(void)
2446{
2447 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2448 && curbuf->b_ffname != NULL)
2449 read_viminfo(NULL, VIF_WANT_MARKS);
2450
2451 // Always set b_marks_read; needed when 'viminfo' is changed to include
2452 // the ' parameter after opening a buffer.
2453 curbuf->b_marks_read = TRUE;
2454}
2455
2456 static int
2457read_viminfo_filemark(vir_T *virp, int force)
2458{
2459 char_u *str;
2460 xfmark_T *namedfm_p = get_namedfm();
2461 xfmark_T *fm;
2462 int i;
2463
2464 // We only get here if line[0] == '\'' or '-'.
2465 // Illegal mark names are ignored (for future expansion).
2466 str = virp->vir_line + 1;
2467 if (
2468#ifndef EBCDIC
2469 *str <= 127 &&
2470#endif
2471 ((*virp->vir_line == '\'' && (VIM_ISDIGIT(*str) || isupper(*str)))
2472 || (*virp->vir_line == '-' && *str == '\'')))
2473 {
2474 if (*str == '\'')
2475 {
2476#ifdef FEAT_JUMPLIST
2477 // If the jumplist isn't full insert fmark as oldest entry
2478 if (curwin->w_jumplistlen == JUMPLISTSIZE)
2479 fm = NULL;
2480 else
2481 {
2482 for (i = curwin->w_jumplistlen; i > 0; --i)
2483 curwin->w_jumplist[i] = curwin->w_jumplist[i - 1];
2484 ++curwin->w_jumplistidx;
2485 ++curwin->w_jumplistlen;
2486 fm = &curwin->w_jumplist[0];
2487 fm->fmark.mark.lnum = 0;
2488 fm->fname = NULL;
2489 }
2490#else
2491 fm = NULL;
2492#endif
2493 }
2494 else if (VIM_ISDIGIT(*str))
2495 fm = &namedfm_p[*str - '0' + NMARKS];
2496 else
2497 fm = &namedfm_p[*str - 'A'];
2498 if (fm != NULL && (fm->fmark.mark.lnum == 0 || force))
2499 {
2500 str = skipwhite(str + 1);
2501 fm->fmark.mark.lnum = getdigits(&str);
2502 str = skipwhite(str);
2503 fm->fmark.mark.col = getdigits(&str);
2504 fm->fmark.mark.coladd = 0;
2505 fm->fmark.fnum = 0;
2506 str = skipwhite(str);
2507 vim_free(fm->fname);
2508 fm->fname = viminfo_readstring(virp, (int)(str - virp->vir_line),
2509 FALSE);
2510 fm->time_set = 0;
2511 }
2512 }
2513 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2514}
2515
2516/*
2517 * Prepare for reading viminfo marks when writing viminfo later.
2518 */
2519 static void
2520prepare_viminfo_marks(void)
2521{
2522 vi_namedfm = ALLOC_CLEAR_MULT(xfmark_T, NMARKS + EXTRA_MARKS);
2523#ifdef FEAT_JUMPLIST
2524 vi_jumplist = ALLOC_CLEAR_MULT(xfmark_T, JUMPLISTSIZE);
2525 vi_jumplist_len = 0;
2526#endif
2527}
2528
2529 static void
2530finish_viminfo_marks(void)
2531{
2532 int i;
2533
2534 if (vi_namedfm != NULL)
2535 {
2536 for (i = 0; i < NMARKS + EXTRA_MARKS; ++i)
2537 vim_free(vi_namedfm[i].fname);
2538 VIM_CLEAR(vi_namedfm);
2539 }
2540#ifdef FEAT_JUMPLIST
2541 if (vi_jumplist != NULL)
2542 {
2543 for (i = 0; i < vi_jumplist_len; ++i)
2544 vim_free(vi_jumplist[i].fname);
2545 VIM_CLEAR(vi_jumplist);
2546 }
2547#endif
2548}
2549
2550/*
2551 * Accept a new style mark line from the viminfo, store it when it's new.
2552 */
2553 static void
2554handle_viminfo_mark(garray_T *values, int force)
2555{
2556 bval_T *vp = (bval_T *)values->ga_data;
2557 int name;
2558 linenr_T lnum;
2559 colnr_T col;
2560 time_t timestamp;
2561 xfmark_T *fm = NULL;
2562
2563 // Check the format:
2564 // |{bartype},{name},{lnum},{col},{timestamp},{filename}
2565 if (values->ga_len < 5
2566 || vp[0].bv_type != BVAL_NR
2567 || vp[1].bv_type != BVAL_NR
2568 || vp[2].bv_type != BVAL_NR
2569 || vp[3].bv_type != BVAL_NR
2570 || vp[4].bv_type != BVAL_STRING)
2571 return;
2572
2573 name = vp[0].bv_nr;
2574 if (name != '\'' && !VIM_ISDIGIT(name) && !ASCII_ISUPPER(name))
2575 return;
2576 lnum = vp[1].bv_nr;
2577 col = vp[2].bv_nr;
2578 if (lnum <= 0 || col < 0)
2579 return;
2580 timestamp = (time_t)vp[3].bv_nr;
2581
2582 if (name == '\'')
2583 {
2584#ifdef FEAT_JUMPLIST
2585 if (vi_jumplist != NULL)
2586 {
2587 if (vi_jumplist_len < JUMPLISTSIZE)
2588 fm = &vi_jumplist[vi_jumplist_len++];
2589 }
2590 else
2591 {
2592 int idx;
2593 int i;
2594
2595 // If we have a timestamp insert it in the right place.
2596 if (timestamp != 0)
2597 {
2598 for (idx = curwin->w_jumplistlen - 1; idx >= 0; --idx)
2599 if (curwin->w_jumplist[idx].time_set < timestamp)
2600 {
2601 ++idx;
2602 break;
2603 }
2604 // idx cannot be zero now
2605 if (idx < 0 && curwin->w_jumplistlen < JUMPLISTSIZE)
2606 // insert as the oldest entry
2607 idx = 0;
2608 }
2609 else if (curwin->w_jumplistlen < JUMPLISTSIZE)
2610 // insert as oldest entry
2611 idx = 0;
2612 else
2613 idx = -1;
2614
2615 if (idx >= 0)
2616 {
2617 if (curwin->w_jumplistlen == JUMPLISTSIZE)
2618 {
2619 // Drop the oldest entry.
2620 --idx;
2621 vim_free(curwin->w_jumplist[0].fname);
2622 for (i = 0; i < idx; ++i)
2623 curwin->w_jumplist[i] = curwin->w_jumplist[i + 1];
2624 }
2625 else
2626 {
2627 // Move newer entries forward.
2628 for (i = curwin->w_jumplistlen; i > idx; --i)
2629 curwin->w_jumplist[i] = curwin->w_jumplist[i - 1];
2630 ++curwin->w_jumplistidx;
2631 ++curwin->w_jumplistlen;
2632 }
2633 fm = &curwin->w_jumplist[idx];
2634 fm->fmark.mark.lnum = 0;
2635 fm->fname = NULL;
2636 fm->time_set = 0;
2637 }
2638 }
2639#endif
2640 }
2641 else
2642 {
2643 int idx;
2644 xfmark_T *namedfm_p = get_namedfm();
2645
2646 if (VIM_ISDIGIT(name))
2647 {
2648 if (vi_namedfm != NULL)
2649 idx = name - '0' + NMARKS;
2650 else
2651 {
2652 int i;
2653
2654 // Do not use the name from the viminfo file, insert in time
2655 // order.
2656 for (idx = NMARKS; idx < NMARKS + EXTRA_MARKS; ++idx)
2657 if (namedfm_p[idx].time_set < timestamp)
2658 break;
2659 if (idx == NMARKS + EXTRA_MARKS)
2660 // All existing entries are newer.
2661 return;
2662 i = NMARKS + EXTRA_MARKS - 1;
2663
2664 vim_free(namedfm_p[i].fname);
2665 for ( ; i > idx; --i)
2666 namedfm_p[i] = namedfm_p[i - 1];
2667 namedfm_p[idx].fname = NULL;
2668 }
2669 }
2670 else
2671 idx = name - 'A';
2672 if (vi_namedfm != NULL)
2673 fm = &vi_namedfm[idx];
2674 else
2675 fm = &namedfm_p[idx];
2676 }
2677
2678 if (fm != NULL)
2679 {
2680 if (vi_namedfm != NULL || fm->fmark.mark.lnum == 0
2681 || fm->time_set < timestamp || force)
2682 {
2683 fm->fmark.mark.lnum = lnum;
2684 fm->fmark.mark.col = col;
2685 fm->fmark.mark.coladd = 0;
2686 fm->fmark.fnum = 0;
2687 vim_free(fm->fname);
2688 if (vp[4].bv_allocated)
2689 {
2690 fm->fname = vp[4].bv_string;
2691 vp[4].bv_string = NULL;
2692 }
2693 else
2694 fm->fname = vim_strsave(vp[4].bv_string);
2695 fm->time_set = timestamp;
2696 }
2697 }
2698}
2699
2700 static int
2701read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
2702{
2703 char_u *p = virp->vir_line + 1;
2704 int bartype;
2705 garray_T values;
2706 bval_T *vp;
2707 int i;
2708 int read_next = TRUE;
2709
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02002710 // The format is: |{bartype},{value},...
2711 // For a very long string:
2712 // |{bartype},>{length of "{text}{text2}"}
2713 // |<{text1}
2714 // |<{text2},{value}
2715 // For a long line not using a string
2716 // |{bartype},{lots of values},>
2717 // |<{value},{value}
Bram Moolenaarc3328162019-07-23 22:15:25 +02002718 if (*p == '<')
2719 {
2720 // Continuation line of an unrecognized item.
2721 if (writing)
2722 ga_add_string(&virp->vir_barlines, virp->vir_line);
2723 }
2724 else
2725 {
2726 ga_init2(&values, sizeof(bval_T), 20);
2727 bartype = getdigits(&p);
2728 switch (bartype)
2729 {
2730 case BARTYPE_VERSION:
2731 // Only use the version when it comes before the encoding.
2732 // If it comes later it was copied by a Vim version that
2733 // doesn't understand the version.
2734 if (!got_encoding)
2735 {
2736 read_next = barline_parse(virp, p, &values);
2737 vp = (bval_T *)values.ga_data;
2738 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2739 virp->vir_version = vp->bv_nr;
2740 }
2741 break;
2742
2743 case BARTYPE_HISTORY:
2744 read_next = barline_parse(virp, p, &values);
2745 handle_viminfo_history(&values, writing);
2746 break;
2747
2748 case BARTYPE_REGISTER:
2749 read_next = barline_parse(virp, p, &values);
2750 handle_viminfo_register(&values, force);
2751 break;
2752
2753 case BARTYPE_MARK:
2754 read_next = barline_parse(virp, p, &values);
2755 handle_viminfo_mark(&values, force);
2756 break;
2757
2758 default:
2759 // copy unrecognized line (for future use)
2760 if (writing)
2761 ga_add_string(&virp->vir_barlines, virp->vir_line);
2762 }
2763 for (i = 0; i < values.ga_len; ++i)
2764 {
2765 vp = (bval_T *)values.ga_data + i;
2766 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2767 vim_free(vp->bv_string);
Bram Moolenaar408030e2020-02-10 22:44:32 +01002768 vim_free(vp->bv_tofree);
Bram Moolenaarc3328162019-07-23 22:15:25 +02002769 }
2770 ga_clear(&values);
2771 }
2772
2773 if (read_next)
2774 return viminfo_readline(virp);
2775 return FALSE;
2776}
2777
Bram Moolenaardefa0672019-07-21 19:25:37 +02002778/*
2779 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2780 * first part of the viminfo file which contains everything but the marks that
2781 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2782 */
2783 static int
2784read_viminfo_up_to_marks(
2785 vir_T *virp,
2786 int forceit,
2787 int writing)
2788{
2789 int eof;
2790 buf_T *buf;
2791 int got_encoding = FALSE;
2792
Bram Moolenaardefa0672019-07-21 19:25:37 +02002793 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaardefa0672019-07-21 19:25:37 +02002794
2795 eof = viminfo_readline(virp);
2796 while (!eof && virp->vir_line[0] != '>')
2797 {
2798 switch (virp->vir_line[0])
2799 {
2800 // Characters reserved for future expansion, ignored now
2801 case '+': // "+40 /path/dir file", for running vim without args
2802 case '^': // to be defined
2803 case '<': // long line - ignored
2804 // A comment or empty line.
2805 case NUL:
2806 case '\r':
2807 case '\n':
2808 case '#':
2809 eof = viminfo_readline(virp);
2810 break;
2811 case '|':
2812 eof = read_viminfo_barline(virp, got_encoding,
2813 forceit, writing);
2814 break;
2815 case '*': // "*encoding=value"
2816 got_encoding = TRUE;
2817 eof = viminfo_encoding(virp);
2818 break;
2819 case '!': // global variable
2820#ifdef FEAT_EVAL
2821 eof = read_viminfo_varlist(virp, writing);
2822#else
2823 eof = viminfo_readline(virp);
2824#endif
2825 break;
2826 case '%': // entry for buffer list
2827 eof = read_viminfo_bufferlist(virp, writing);
2828 break;
2829 case '"':
2830 // When registers are in bar lines skip the old style register
2831 // lines.
2832 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2833 eof = read_viminfo_register(virp, forceit);
2834 else
2835 do {
2836 eof = viminfo_readline(virp);
2837 } while (!eof && (virp->vir_line[0] == TAB
2838 || virp->vir_line[0] == '<'));
2839 break;
2840 case '/': // Search string
2841 case '&': // Substitute search string
2842 case '~': // Last search string, followed by '/' or '&'
2843 eof = read_viminfo_search_pattern(virp, forceit);
2844 break;
2845 case '$':
2846 eof = read_viminfo_sub_string(virp, forceit);
2847 break;
2848 case ':':
2849 case '?':
2850 case '=':
2851 case '@':
Bram Moolenaardefa0672019-07-21 19:25:37 +02002852 // When history is in bar lines skip the old style history
2853 // lines.
2854 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2855 eof = read_viminfo_history(virp, writing);
2856 else
Bram Moolenaardefa0672019-07-21 19:25:37 +02002857 eof = viminfo_readline(virp);
2858 break;
2859 case '-':
2860 case '\'':
2861 // When file marks are in bar lines skip the old style lines.
2862 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2863 eof = read_viminfo_filemark(virp, forceit);
2864 else
2865 eof = viminfo_readline(virp);
2866 break;
2867 default:
2868 if (viminfo_error("E575: ", _("Illegal starting char"),
2869 virp->vir_line))
2870 eof = TRUE;
2871 else
2872 eof = viminfo_readline(virp);
2873 break;
2874 }
2875 }
2876
Bram Moolenaardefa0672019-07-21 19:25:37 +02002877 // Finish reading history items.
2878 if (!writing)
2879 finish_viminfo_history(virp);
Bram Moolenaardefa0672019-07-21 19:25:37 +02002880
2881 // Change file names to buffer numbers for fmarks.
2882 FOR_ALL_BUFFERS(buf)
2883 fmarks_check_names(buf);
2884
2885 return eof;
2886}
2887
2888/*
2889 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2890 */
2891 static void
2892do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
2893{
2894 int eof = FALSE;
2895 vir_T vir;
2896 int merge = FALSE;
2897 int do_copy_marks = FALSE;
2898 garray_T buflist;
2899
2900 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2901 return;
2902 vir.vir_fd = fp_in;
2903 vir.vir_conv.vc_type = CONV_NONE;
2904 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
2905 vir.vir_version = -1;
2906
2907 if (fp_in != NULL)
2908 {
2909 if (flags & VIF_WANT_INFO)
2910 {
2911 if (fp_out != NULL)
2912 {
2913 // Registers and marks are read and kept separate from what
2914 // this Vim is using. They are merged when writing.
2915 prepare_viminfo_registers();
2916 prepare_viminfo_marks();
2917 }
2918
2919 eof = read_viminfo_up_to_marks(&vir,
2920 flags & VIF_FORCEIT, fp_out != NULL);
2921 merge = TRUE;
2922 }
2923 else if (flags != 0)
2924 // Skip info, find start of marks
2925 while (!(eof = viminfo_readline(&vir))
2926 && vir.vir_line[0] != '>')
2927 ;
2928
2929 do_copy_marks = (flags &
2930 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
2931 }
2932
2933 if (fp_out != NULL)
2934 {
2935 // Write the info:
2936 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2937 VIM_VERSION_MEDIUM);
2938 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
2939 write_viminfo_version(fp_out);
2940 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
2941 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2942 write_viminfo_search_pattern(fp_out);
2943 write_viminfo_sub_string(fp_out);
Bram Moolenaardefa0672019-07-21 19:25:37 +02002944 write_viminfo_history(fp_out, merge);
Bram Moolenaardefa0672019-07-21 19:25:37 +02002945 write_viminfo_registers(fp_out);
2946 finish_viminfo_registers();
2947#ifdef FEAT_EVAL
2948 write_viminfo_varlist(fp_out);
2949#endif
2950 write_viminfo_filemarks(fp_out);
2951 finish_viminfo_marks();
2952 write_viminfo_bufferlist(fp_out);
2953 write_viminfo_barlines(&vir, fp_out);
2954
2955 if (do_copy_marks)
2956 ga_init2(&buflist, sizeof(buf_T *), 50);
2957 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
2958 }
2959
2960 if (do_copy_marks)
2961 {
2962 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2963 if (fp_out != NULL)
2964 ga_clear(&buflist);
2965 }
2966
2967 vim_free(vir.vir_line);
2968 if (vir.vir_conv.vc_type != CONV_NONE)
2969 convert_setup(&vir.vir_conv, NULL, NULL);
2970 ga_clear_strings(&vir.vir_barlines);
2971}
2972
2973/*
2974 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
2975 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
2976 */
2977 int
2978read_viminfo(
2979 char_u *file, // file name or NULL to use default name
2980 int flags) // VIF_WANT_INFO et al.
2981{
2982 FILE *fp;
2983 char_u *fname;
2984
2985 if (no_viminfo())
2986 return FAIL;
2987
2988 fname = viminfo_filename(file); // get file name in allocated buffer
2989 if (fname == NULL)
2990 return FAIL;
2991 fp = mch_fopen((char *)fname, READBIN);
2992
2993 if (p_verbose > 0)
2994 {
2995 verbose_enter();
Bram Moolenaardb99f9f2020-03-23 22:12:22 +01002996 smsg(_("Reading viminfo file \"%s\"%s%s%s%s"),
Bram Moolenaardefa0672019-07-21 19:25:37 +02002997 fname,
2998 (flags & VIF_WANT_INFO) ? _(" info") : "",
2999 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
3000 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
3001 fp == NULL ? _(" FAILED") : "");
3002 verbose_leave();
3003 }
3004
3005 vim_free(fname);
3006 if (fp == NULL)
3007 return FAIL;
3008
3009 viminfo_errcnt = 0;
3010 do_viminfo(fp, NULL, flags);
3011
3012 fclose(fp);
3013 return OK;
3014}
3015
3016/*
3017 * Write the viminfo file. The old one is read in first so that effectively a
3018 * merge of current info and old info is done. This allows multiple vims to
3019 * run simultaneously, without losing any marks etc.
3020 * If "forceit" is TRUE, then the old file is not read in, and only internal
3021 * info is written to the file.
3022 */
3023 void
3024write_viminfo(char_u *file, int forceit)
3025{
3026 char_u *fname;
3027 FILE *fp_in = NULL; // input viminfo file, if any
3028 FILE *fp_out = NULL; // output viminfo file
3029 char_u *tempname = NULL; // name of temp viminfo file
3030 stat_T st_new; // mch_stat() of potential new file
3031#if defined(UNIX) || defined(VMS)
3032 mode_t umask_save;
3033#endif
3034#ifdef UNIX
3035 int shortname = FALSE; // use 8.3 file name
3036 stat_T st_old; // mch_stat() of existing viminfo file
3037#endif
3038#ifdef MSWIN
3039 int hidden = FALSE;
3040#endif
3041
3042 if (no_viminfo())
3043 return;
3044
3045 fname = viminfo_filename(file); // may set to default if NULL
3046 if (fname == NULL)
3047 return;
3048
3049 fp_in = mch_fopen((char *)fname, READBIN);
3050 if (fp_in == NULL)
3051 {
3052 int fd;
3053
3054 // if it does exist, but we can't read it, don't try writing
3055 if (mch_stat((char *)fname, &st_new) == 0)
3056 goto end;
3057
3058 // Create the new .viminfo non-accessible for others, because it may
3059 // contain text from non-accessible documents. It is up to the user to
3060 // widen access (e.g. to a group). This may also fail if there is a
3061 // race condition, then just give up.
3062 fd = mch_open((char *)fname,
3063 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
3064 if (fd < 0)
3065 goto end;
3066 fp_out = fdopen(fd, WRITEBIN);
3067 }
3068 else
3069 {
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003070 // There is an existing viminfo file. Create a temporary file to
3071 // write the new viminfo into, in the same directory as the
3072 // existing viminfo file, which will be renamed once all writing is
3073 // successful.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003074#ifdef UNIX
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003075 // For Unix we check the owner of the file. It's not very nice to
3076 // overwrite a user's viminfo file after a "su root", with a
3077 // viminfo file that the user can't read.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003078 st_old.st_dev = (dev_t)0;
3079 st_old.st_ino = 0;
3080 st_old.st_mode = 0600;
3081 if (mch_stat((char *)fname, &st_old) == 0
3082 && getuid() != ROOT_UID
3083 && !(st_old.st_uid == getuid()
3084 ? (st_old.st_mode & 0200)
3085 : (st_old.st_gid == getgid()
3086 ? (st_old.st_mode & 0020)
3087 : (st_old.st_mode & 0002))))
3088 {
3089 int tt = msg_didany;
3090
3091 // avoid a wait_return for this message, it's annoying
3092 semsg(_("E137: Viminfo file is not writable: %s"), fname);
3093 msg_didany = tt;
3094 fclose(fp_in);
3095 goto end;
3096 }
3097#endif
3098#ifdef MSWIN
3099 // Get the file attributes of the existing viminfo file.
3100 hidden = mch_ishidden(fname);
3101#endif
3102
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003103 // Make tempname, find one that does not exist yet.
3104 // Beware of a race condition: If someone logs out and all Vim
3105 // instances exit at the same time a temp file might be created between
3106 // stat() and open(). Use mch_open() with O_EXCL to avoid that.
3107 // May try twice: Once normal and once with shortname set, just in
3108 // case somebody puts his viminfo file in an 8.3 filesystem.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003109 for (;;)
3110 {
3111 int next_char = 'z';
3112 char_u *wp;
3113
3114 tempname = buf_modname(
3115#ifdef UNIX
3116 shortname,
3117#else
3118 FALSE,
3119#endif
3120 fname,
3121#ifdef VMS
3122 (char_u *)"-tmp",
3123#else
3124 (char_u *)".tmp",
3125#endif
3126 FALSE);
3127 if (tempname == NULL) // out of memory
3128 break;
3129
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003130 // Try a series of names. Change one character, just before
3131 // the extension. This should also work for an 8.3
3132 // file name, when after adding the extension it still is
3133 // the same file as the original.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003134 wp = tempname + STRLEN(tempname) - 5;
3135 if (wp < gettail(tempname)) // empty file name?
3136 wp = gettail(tempname);
3137 for (;;)
3138 {
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003139 // Check if tempfile already exists. Never overwrite an
3140 // existing file!
Bram Moolenaardefa0672019-07-21 19:25:37 +02003141 if (mch_stat((char *)tempname, &st_new) == 0)
3142 {
3143#ifdef UNIX
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003144 // Check if tempfile is same as original file. May happen
3145 // when modname() gave the same file back. E.g. silly
3146 // link, or file name-length reached. Try again with
3147 // shortname set.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003148 if (!shortname && st_new.st_dev == st_old.st_dev
3149 && st_new.st_ino == st_old.st_ino)
3150 {
3151 VIM_CLEAR(tempname);
3152 shortname = TRUE;
3153 break;
3154 }
3155#endif
3156 }
3157 else
3158 {
3159 // Try creating the file exclusively. This may fail if
3160 // another Vim tries to do it at the same time.
3161#ifdef VMS
3162 // fdopen() fails for some reason
3163 umask_save = umask(077);
3164 fp_out = mch_fopen((char *)tempname, WRITEBIN);
3165 (void)umask(umask_save);
3166#else
3167 int fd;
3168
3169 // Use mch_open() to be able to use O_NOFOLLOW and set file
3170 // protection:
3171 // Unix: same as original file, but strip s-bit. Reset
3172 // umask to avoid it getting in the way.
3173 // Others: r&w for user only.
3174# ifdef UNIX
3175 umask_save = umask(0);
3176 fd = mch_open((char *)tempname,
3177 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
3178 (int)((st_old.st_mode & 0777) | 0600));
3179 (void)umask(umask_save);
3180# else
3181 fd = mch_open((char *)tempname,
3182 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
3183# endif
3184 if (fd < 0)
3185 {
3186 fp_out = NULL;
3187# ifdef EEXIST
3188 // Avoid trying lots of names while the problem is lack
3189 // of permission, only retry if the file already
3190 // exists.
3191 if (errno != EEXIST)
3192 break;
3193# endif
3194 }
3195 else
3196 fp_out = fdopen(fd, WRITEBIN);
3197#endif // VMS
3198 if (fp_out != NULL)
3199 break;
3200 }
3201
3202 // Assume file exists, try again with another name.
3203 if (next_char == 'a' - 1)
3204 {
3205 // They all exist? Must be something wrong! Don't write
3206 // the viminfo file then.
3207 semsg(_("E929: Too many viminfo temp files, like %s!"),
3208 tempname);
3209 break;
3210 }
3211 *wp = next_char;
3212 --next_char;
3213 }
3214
3215 if (tempname != NULL)
3216 break;
3217 // continue if shortname was set
3218 }
3219
3220#if defined(UNIX) && defined(HAVE_FCHOWN)
3221 if (tempname != NULL && fp_out != NULL)
3222 {
3223 stat_T tmp_st;
3224
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003225 // Make sure the original owner can read/write the tempfile and
3226 // otherwise preserve permissions, making sure the group matches.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003227 if (mch_stat((char *)tempname, &tmp_st) >= 0)
3228 {
3229 if (st_old.st_uid != tmp_st.st_uid)
3230 // Changing the owner might fail, in which case the
Bram Moolenaar32aa1022019-11-02 22:54:41 +01003231 // file will now be owned by the current user, oh well.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003232 vim_ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
3233 if (st_old.st_gid != tmp_st.st_gid
3234 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
3235 // can't set the group to what it should be, remove
3236 // group permissions
3237 (void)mch_setperm(tempname, 0600);
3238 }
3239 else
3240 // can't stat the file, set conservative permissions
3241 (void)mch_setperm(tempname, 0600);
3242 }
3243#endif
3244 }
3245
Bram Moolenaar6bd1d772019-10-09 22:01:25 +02003246 // Check if the new viminfo file can be written to.
Bram Moolenaardefa0672019-07-21 19:25:37 +02003247 if (fp_out == NULL)
3248 {
3249 semsg(_("E138: Can't write viminfo file %s!"),
3250 (fp_in == NULL || tempname == NULL) ? fname : tempname);
3251 if (fp_in != NULL)
3252 fclose(fp_in);
3253 goto end;
3254 }
3255
3256 if (p_verbose > 0)
3257 {
3258 verbose_enter();
3259 smsg(_("Writing viminfo file \"%s\""), fname);
3260 verbose_leave();
3261 }
3262
3263 viminfo_errcnt = 0;
3264 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
3265
3266 if (fclose(fp_out) == EOF)
3267 ++viminfo_errcnt;
3268
3269 if (fp_in != NULL)
3270 {
3271 fclose(fp_in);
3272
3273 // In case of an error keep the original viminfo file. Otherwise
3274 // rename the newly written file. Give an error if that fails.
3275 if (viminfo_errcnt == 0)
3276 {
3277 if (vim_rename(tempname, fname) == -1)
3278 {
3279 ++viminfo_errcnt;
3280 semsg(_("E886: Can't rename viminfo file to %s!"), fname);
3281 }
3282# ifdef MSWIN
3283 // If the viminfo file was hidden then also hide the new file.
3284 else if (hidden)
3285 mch_hide(fname);
3286# endif
3287 }
3288 if (viminfo_errcnt > 0)
3289 mch_remove(tempname);
3290 }
3291
3292end:
3293 vim_free(fname);
3294 vim_free(tempname);
3295}
3296
3297/*
Bram Moolenaardefa0672019-07-21 19:25:37 +02003298 * ":rviminfo" and ":wviminfo".
3299 */
3300 void
3301ex_viminfo(
3302 exarg_T *eap)
3303{
3304 char_u *save_viminfo;
3305
3306 save_viminfo = p_viminfo;
3307 if (*p_viminfo == NUL)
3308 p_viminfo = (char_u *)"'100";
3309 if (eap->cmdidx == CMD_rviminfo)
3310 {
3311 if (read_viminfo(eap->arg, VIF_WANT_INFO | VIF_WANT_MARKS
3312 | (eap->forceit ? VIF_FORCEIT : 0)) == FAIL)
3313 emsg(_("E195: Cannot open viminfo file for reading"));
3314 }
3315 else
3316 write_viminfo(eap->arg, eap->forceit);
3317 p_viminfo = save_viminfo;
3318}
3319
Bram Moolenaardefa0672019-07-21 19:25:37 +02003320#endif // FEAT_VIMINFO