blob: 6b4a766346e012d7a240849e17e69b202807e149 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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/* for debugging */
Bram Moolenaar6f470022018-04-10 18:47:20 +020011/* #define CHECK(c, s) do { if (c) EMSG(s); } while (0) */
12#define CHECK(c, s) do { /**/ } while (0)
Bram Moolenaar071d4272004-06-13 20:20:40 +000013
14/*
15 * memline.c: Contains the functions for appending, deleting and changing the
Bram Moolenaar4770d092006-01-12 23:22:24 +000016 * text lines. The memfile functions are used to store the information in
17 * blocks of memory, backed up by a file. The structure of the information is
18 * a tree. The root of the tree is a pointer block. The leaves of the tree
19 * are data blocks. In between may be several layers of pointer blocks,
20 * forming branches.
Bram Moolenaar071d4272004-06-13 20:20:40 +000021 *
22 * Three types of blocks are used:
23 * - Block nr 0 contains information for recovery
24 * - Pointer blocks contain list of pointers to other blocks.
25 * - Data blocks contain the actual text.
26 *
27 * Block nr 0 contains the block0 structure (see below).
28 *
29 * Block nr 1 is the first pointer block. It is the root of the tree.
30 * Other pointer blocks are branches.
31 *
32 * If a line is too big to fit in a single page, the block containing that
33 * line is made big enough to hold the line. It may span several pages.
34 * Otherwise all blocks are one page.
35 *
36 * A data block that was filled when starting to edit a file and was not
37 * changed since then, can have a negative block number. This means that it
38 * has not yet been assigned a place in the file. When recovering, the lines
39 * in this data block can be read from the original file. When the block is
40 * changed (lines appended/deleted/changed) or when it is flushed it gets a
41 * positive number. Use mf_trans_del() to get the new number, before calling
42 * mf_get().
43 */
44
Bram Moolenaar071d4272004-06-13 20:20:40 +000045#include "vim.h"
46
Bram Moolenaar071d4272004-06-13 20:20:40 +000047#ifndef UNIX /* it's in os_unix.h for Unix */
48# include <time.h>
49#endif
50
Bram Moolenaar5a6404c2006-11-01 17:12:57 +000051#if defined(SASC) || defined(__amigaos4__)
Bram Moolenaar071d4272004-06-13 20:20:40 +000052# include <proto/dos.h> /* for Open() and Close() */
53#endif
54
55typedef struct block0 ZERO_BL; /* contents of the first block */
56typedef struct pointer_block PTR_BL; /* contents of a pointer block */
57typedef struct data_block DATA_BL; /* contents of a data block */
58typedef struct pointer_entry PTR_EN; /* block/line-count pair */
59
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +020060#define DATA_ID (('d' << 8) + 'a') /* data block id */
61#define PTR_ID (('p' << 8) + 't') /* pointer block id */
62#define BLOCK0_ID0 'b' /* block 0 id 0 */
63#define BLOCK0_ID1 '0' /* block 0 id 1 */
64#define BLOCK0_ID1_C0 'c' /* block 0 id 1 'cm' 0 */
65#define BLOCK0_ID1_C1 'C' /* block 0 id 1 'cm' 1 */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +020066#define BLOCK0_ID1_C2 'd' /* block 0 id 1 'cm' 2 */
67
68#if defined(FEAT_CRYPT)
69static int id1_codes[] = {
70 BLOCK0_ID1_C0, /* CRYPT_M_ZIP */
71 BLOCK0_ID1_C1, /* CRYPT_M_BF */
72 BLOCK0_ID1_C2, /* CRYPT_M_BF2 */
73};
74#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000075
76/*
77 * pointer to a block, used in a pointer block
78 */
79struct pointer_entry
80{
81 blocknr_T pe_bnum; /* block number */
82 linenr_T pe_line_count; /* number of lines in this branch */
83 linenr_T pe_old_lnum; /* lnum for this block (for recovery) */
84 int pe_page_count; /* number of pages in block pe_bnum */
85};
86
87/*
88 * A pointer block contains a list of branches in the tree.
89 */
90struct pointer_block
91{
92 short_u pb_id; /* ID for pointer block: PTR_ID */
Bram Moolenaar20a825a2010-05-31 21:27:30 +020093 short_u pb_count; /* number of pointers in this block */
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 short_u pb_count_max; /* maximum value for pb_count */
95 PTR_EN pb_pointer[1]; /* list of pointers to blocks (actually longer)
96 * followed by empty space until end of page */
97};
98
99/*
100 * A data block is a leaf in the tree.
101 *
102 * The text of the lines is at the end of the block. The text of the first line
103 * in the block is put at the end, the text of the second line in front of it,
104 * etc. Thus the order of the lines is the opposite of the line number.
105 */
106struct data_block
107{
108 short_u db_id; /* ID for data block: DATA_ID */
109 unsigned db_free; /* free space available */
110 unsigned db_txt_start; /* byte where text starts */
111 unsigned db_txt_end; /* byte just after data block */
112 linenr_T db_line_count; /* number of lines in this block */
113 unsigned db_index[1]; /* index for start of line (actually bigger)
114 * followed by empty space upto db_txt_start
115 * followed by the text in the lines until
116 * end of page */
117};
118
119/*
120 * The low bits of db_index hold the actual index. The topmost bit is
121 * used for the global command to be able to mark a line.
122 * This method is not clean, but otherwise there would be at least one extra
123 * byte used for each line.
124 * The mark has to be in this place to keep it with the correct line when other
125 * lines are inserted or deleted.
126 */
127#define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
128#define DB_INDEX_MASK (~DB_MARKED)
129
130#define INDEX_SIZE (sizeof(unsigned)) /* size of one db_index entry */
131#define HEADER_SIZE (sizeof(DATA_BL) - INDEX_SIZE) /* size of data block header */
132
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000133#define B0_FNAME_SIZE_ORG 900 /* what it was in older versions */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200134#define B0_FNAME_SIZE_NOCRYPT 898 /* 2 bytes used for other things */
135#define B0_FNAME_SIZE_CRYPT 890 /* 10 bytes used for other things */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000136#define B0_UNAME_SIZE 40
137#define B0_HNAME_SIZE 40
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138/*
139 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
140 * This won't detect a 64 bit machine that only swaps a byte in the top 32
141 * bits, but that is crazy anyway.
142 */
143#define B0_MAGIC_LONG 0x30313233L
144#define B0_MAGIC_INT 0x20212223L
145#define B0_MAGIC_SHORT 0x10111213L
146#define B0_MAGIC_CHAR 0x55
147
148/*
149 * Block zero holds all info about the swap file.
150 *
151 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
152 * swap files unusable!
153 *
154 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
155 *
Bram Moolenaarbae0c162007-05-10 19:30:25 +0000156 * This block is built up of single bytes, to make it portable across
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 * different machines. b0_magic_* is used to check the byte order and size of
158 * variables, because the rest of the swap file is not portable.
159 */
160struct block0
161{
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200162 char_u b0_id[2]; /* id for block 0: BLOCK0_ID0 and BLOCK0_ID1,
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200163 * BLOCK0_ID1_C0, BLOCK0_ID1_C1, etc. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164 char_u b0_version[10]; /* Vim version string */
165 char_u b0_page_size[4];/* number of bytes per page */
166 char_u b0_mtime[4]; /* last modification time of file */
167 char_u b0_ino[4]; /* inode of b0_fname */
168 char_u b0_pid[4]; /* process id of creator (or 0) */
169 char_u b0_uname[B0_UNAME_SIZE]; /* name of user (uid if no name) */
170 char_u b0_hname[B0_HNAME_SIZE]; /* host name (if it has a name) */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000171 char_u b0_fname[B0_FNAME_SIZE_ORG]; /* name of file being edited */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172 long b0_magic_long; /* check for byte order of long */
173 int b0_magic_int; /* check for byte order of int */
174 short b0_magic_short; /* check for byte order of short */
175 char_u b0_magic_char; /* check for last char */
176};
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000177
178/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000179 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000180 * long file names in older versions of Vim they are invalid.
181 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
182 * when there is room, for very long file names it's omitted.
183 */
184#define B0_DIRTY 0x55
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200185#define b0_dirty b0_fname[B0_FNAME_SIZE_ORG - 1]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000186
187/*
188 * The b0_flags field is new in Vim 7.0.
189 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200190#define b0_flags b0_fname[B0_FNAME_SIZE_ORG - 2]
191
192/*
193 * Crypt seed goes here, 8 bytes. New in Vim 7.3.
194 * Without encryption these bytes may be used for 'fenc'.
195 */
196#define b0_seed b0_fname[B0_FNAME_SIZE_ORG - 2 - MF_SEED_LEN]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000197
198/* The lowest two bits contain the fileformat. Zero means it's not set
199 * (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
200 * EOL_MAC + 1. */
201#define B0_FF_MASK 3
202
203/* Swap file is in directory of edited file. Used to find the file from
204 * different mount points. */
205#define B0_SAME_DIR 4
206
207/* The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
208 * When empty there is only the NUL. */
209#define B0_HAS_FENC 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210
211#define STACK_INCR 5 /* nr of entries added to ml_stack at a time */
212
213/*
214 * The line number where the first mark may be is remembered.
215 * If it is 0 there are no marks at all.
216 * (always used for the current buffer only, no buffer change possible while
217 * executing a global command).
218 */
219static linenr_T lowest_marked = 0;
220
221/*
222 * arguments for ml_find_line()
223 */
224#define ML_DELETE 0x11 /* delete line */
225#define ML_INSERT 0x12 /* insert line */
226#define ML_FIND 0x13 /* just find the line */
227#define ML_FLUSH 0x02 /* flush locked block */
228#define ML_SIMPLE(x) (x & 0x10) /* DEL, INS or FIND */
229
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200230/* argument for ml_upd_block0() */
231typedef enum {
232 UB_FNAME = 0 /* update timestamp and filename */
233 , UB_SAME_DIR /* update the B0_SAME_DIR flag */
234 , UB_CRYPT /* update crypt key */
235} upd_block0_T;
236
237#ifdef FEAT_CRYPT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100238static void ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200239#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100240static void ml_upd_block0(buf_T *buf, upd_block0_T what);
241static void set_b0_fname(ZERO_BL *, buf_T *buf);
242static void set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000243#ifdef FEAT_MBYTE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100244static void add_b0_fenc(ZERO_BL *b0p, buf_T *buf);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000245#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100246static time_t swapfile_info(char_u *);
247static int recov_file_names(char_u **, char_u *, int prepend_dot);
248static int ml_append_int(buf_T *, linenr_T, char_u *, colnr_T, int, int);
249static int ml_delete_int(buf_T *, linenr_T, int);
250static char_u *findswapname(buf_T *, char_u **, char_u *);
251static void ml_flush_line(buf_T *);
252static bhdr_T *ml_new_data(memfile_T *, int, int);
253static bhdr_T *ml_new_ptr(memfile_T *);
254static bhdr_T *ml_find_line(buf_T *, linenr_T, int);
255static int ml_add_stack(buf_T *);
256static void ml_lineadd(buf_T *, int);
257static int b0_magic_wrong(ZERO_BL *);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258#ifdef CHECK_INODE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100259static int fnamecmp_ino(char_u *, char_u *, long);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100261static void long_to_char(long, char_u *);
262static long char_to_long(char_u *);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200263#ifdef FEAT_CRYPT
Bram Moolenaar8767f522016-07-01 17:17:39 +0200264static cryptstate_T *ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200265#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266#ifdef FEAT_BYTEOFF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100267static void ml_updatechunk(buf_T *buf, long line, long len, int updtype);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268#endif
269
270/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000271 * Open a new memline for "buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 *
Bram Moolenaar4770d092006-01-12 23:22:24 +0000273 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 */
275 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100276ml_open(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277{
278 memfile_T *mfp;
279 bhdr_T *hp = NULL;
280 ZERO_BL *b0p;
281 PTR_BL *pp;
282 DATA_BL *dp;
283
Bram Moolenaar4770d092006-01-12 23:22:24 +0000284 /*
285 * init fields in memline struct
286 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200287 buf->b_ml.ml_stack_size = 0; /* no stack yet */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000288 buf->b_ml.ml_stack = NULL; /* no stack yet */
289 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
290 buf->b_ml.ml_locked = NULL; /* no cached block */
291 buf->b_ml.ml_line_lnum = 0; /* no cached line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292#ifdef FEAT_BYTEOFF
Bram Moolenaar4770d092006-01-12 23:22:24 +0000293 buf->b_ml.ml_chunksize = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294#endif
295
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100296 if (cmdmod.noswapfile)
297 buf->b_p_swf = FALSE;
298
Bram Moolenaar4770d092006-01-12 23:22:24 +0000299 /*
300 * When 'updatecount' is non-zero swap file may be opened later.
301 */
302 if (p_uc && buf->b_p_swf)
303 buf->b_may_swap = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 else
Bram Moolenaar4770d092006-01-12 23:22:24 +0000305 buf->b_may_swap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306
Bram Moolenaar4770d092006-01-12 23:22:24 +0000307 /*
308 * Open the memfile. No swap file is created yet.
309 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310 mfp = mf_open(NULL, 0);
311 if (mfp == NULL)
312 goto error;
313
Bram Moolenaar4770d092006-01-12 23:22:24 +0000314 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200315#ifdef FEAT_CRYPT
316 mfp->mf_buffer = buf;
317#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000318 buf->b_ml.ml_flags = ML_EMPTY;
319 buf->b_ml.ml_line_count = 1;
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000320#ifdef FEAT_LINEBREAK
321 curwin->w_nrwidth_line_count = 0;
322#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324/*
325 * fill block0 struct and write page 0
326 */
327 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
328 goto error;
329 if (hp->bh_bnum != 0)
330 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100331 IEMSG(_("E298: Didn't get block nr 0?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 goto error;
333 }
334 b0p = (ZERO_BL *)(hp->bh_data);
335
336 b0p->b0_id[0] = BLOCK0_ID0;
337 b0p->b0_id[1] = BLOCK0_ID1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
339 b0p->b0_magic_int = (int)B0_MAGIC_INT;
340 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
341 b0p->b0_magic_char = B0_MAGIC_CHAR;
Bram Moolenaar22c10562018-05-26 17:35:27 +0200342 mch_memmove(b0p->b0_version, "VIM ", 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000343 STRNCPY(b0p->b0_version + 4, Version, 6);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000345
Bram Moolenaar76b92b22006-03-24 22:46:53 +0000346#ifdef FEAT_SPELL
347 if (!buf->b_spell)
348#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000349 {
350 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
351 b0p->b0_flags = get_fileformat(buf) + 1;
352 set_b0_fname(b0p, buf);
353 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
354 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
355 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
356 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
357 long_to_char(mch_get_pid(), b0p->b0_pid);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200358#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200359 ml_set_b0_crypt(buf, b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200360#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000361 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362
363 /*
364 * Always sync block number 0 to disk, so we can check the file name in
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200365 * the swap file in findswapname(). Don't do this for a help files or
366 * a spell buffer though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367 * Only works when there's a swapfile, otherwise it's done when the file
368 * is created.
369 */
370 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000371 if (!buf->b_help && !B_SPELL(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372 (void)mf_sync(mfp, 0);
373
Bram Moolenaar4770d092006-01-12 23:22:24 +0000374 /*
375 * Fill in root pointer block and write page 1.
376 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377 if ((hp = ml_new_ptr(mfp)) == NULL)
378 goto error;
379 if (hp->bh_bnum != 1)
380 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100381 IEMSG(_("E298: Didn't get block nr 1?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382 goto error;
383 }
384 pp = (PTR_BL *)(hp->bh_data);
385 pp->pb_count = 1;
386 pp->pb_pointer[0].pe_bnum = 2;
387 pp->pb_pointer[0].pe_page_count = 1;
388 pp->pb_pointer[0].pe_old_lnum = 1;
389 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
390 mf_put(mfp, hp, TRUE, FALSE);
391
Bram Moolenaar4770d092006-01-12 23:22:24 +0000392 /*
393 * Allocate first data block and create an empty line 1.
394 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
396 goto error;
397 if (hp->bh_bnum != 2)
398 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100399 IEMSG(_("E298: Didn't get block nr 2?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400 goto error;
401 }
402
403 dp = (DATA_BL *)(hp->bh_data);
404 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
405 dp->db_free -= 1 + INDEX_SIZE;
406 dp->db_line_count = 1;
Bram Moolenaarf05da212009-11-17 16:13:15 +0000407 *((char_u *)dp + dp->db_txt_start) = NUL; /* empty line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408
409 return OK;
410
411error:
412 if (mfp != NULL)
413 {
414 if (hp)
415 mf_put(mfp, hp, FALSE, FALSE);
416 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
417 }
Bram Moolenaar4770d092006-01-12 23:22:24 +0000418 buf->b_ml.ml_mfp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419 return FAIL;
420}
421
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200422#if defined(FEAT_CRYPT) || defined(PROTO)
423/*
Bram Moolenaar2be79502014-08-13 21:58:28 +0200424 * Prepare encryption for "buf" for the current key and method.
425 */
426 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100427ml_set_mfp_crypt(buf_T *buf)
Bram Moolenaar2be79502014-08-13 21:58:28 +0200428{
429 if (*buf->b_p_key != NUL)
430 {
431 int method_nr = crypt_get_method_nr(buf);
432
433 if (method_nr > CRYPT_M_ZIP)
434 {
435 /* Generate a seed and store it in the memfile. */
436 sha2_seed(buf->b_ml.ml_mfp->mf_seed, MF_SEED_LEN, NULL, 0);
437 }
438 }
439}
440
441/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200442 * Prepare encryption for "buf" with block 0 "b0p".
443 */
444 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100445ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200446{
447 if (*buf->b_p_key == NUL)
448 b0p->b0_id[1] = BLOCK0_ID1;
449 else
450 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200451 int method_nr = crypt_get_method_nr(buf);
452
453 b0p->b0_id[1] = id1_codes[method_nr];
454 if (method_nr > CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200455 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200456 /* Generate a seed and store it in block 0 and in the memfile. */
457 sha2_seed(&b0p->b0_seed, MF_SEED_LEN, NULL, 0);
458 mch_memmove(buf->b_ml.ml_mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
459 }
460 }
461}
462
463/*
464 * Called after the crypt key or 'cryptmethod' was changed for "buf".
465 * Will apply this to the swapfile.
466 * "old_key" is the previous key. It is equal to buf->b_p_key when
467 * 'cryptmethod' is changed.
Bram Moolenaar49771f42010-07-20 17:32:38 +0200468 * "old_cm" is the previous 'cryptmethod'. It is equal to the current
469 * 'cryptmethod' when 'key' is changed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200470 */
471 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100472ml_set_crypt_key(
473 buf_T *buf,
474 char_u *old_key,
475 char_u *old_cm)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200476{
477 memfile_T *mfp = buf->b_ml.ml_mfp;
478 bhdr_T *hp;
479 int page_count;
480 int idx;
481 long error;
482 infoptr_T *ip;
483 PTR_BL *pp;
484 DATA_BL *dp;
485 blocknr_T bnum;
486 int top;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200487 int old_method;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200488
Bram Moolenaar3832c462010-08-04 15:32:46 +0200489 if (mfp == NULL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200490 return; /* no memfile yet, nothing to do */
Bram Moolenaarbc563362015-06-09 18:35:25 +0200491 old_method = crypt_method_nr_from_name(old_cm);
492
493 /* First make sure the swapfile is in a consistent state, using the old
494 * key and method. */
495 {
496 char_u *new_key = buf->b_p_key;
497 char_u *new_buf_cm = buf->b_p_cm;
498
499 buf->b_p_key = old_key;
500 buf->b_p_cm = old_cm;
501 ml_preserve(buf, FALSE);
502 buf->b_p_key = new_key;
503 buf->b_p_cm = new_buf_cm;
504 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200505
506 /* Set the key, method and seed to be used for reading, these must be the
507 * old values. */
508 mfp->mf_old_key = old_key;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200509 mfp->mf_old_cm = old_method;
510 if (old_method > 0 && *old_key != NUL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200511 mch_memmove(mfp->mf_old_seed, mfp->mf_seed, MF_SEED_LEN);
512
513 /* Update block 0 with the crypt flag and may set a new seed. */
514 ml_upd_block0(buf, UB_CRYPT);
515
516 if (mfp->mf_infile_count > 2)
517 {
518 /*
519 * Need to read back all data blocks from disk, decrypt them with the
520 * old key/method and mark them to be written. The algorithm is
521 * similar to what happens in ml_recover(), but we skip negative block
522 * numbers.
523 */
524 ml_flush_line(buf); /* flush buffered line */
525 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
526
527 hp = NULL;
528 bnum = 1; /* start with block 1 */
529 page_count = 1; /* which is 1 page */
530 idx = 0; /* start with first index in block 1 */
531 error = 0;
532 buf->b_ml.ml_stack_top = 0;
Bram Moolenaard23a8232018-02-10 18:45:26 +0100533 VIM_CLEAR(buf->b_ml.ml_stack);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200534 buf->b_ml.ml_stack_size = 0; /* no stack yet */
535
536 for ( ; !got_int; line_breakcheck())
537 {
538 if (hp != NULL)
539 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
540
541 /* get the block (pointer or data) */
542 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
543 {
544 if (bnum == 1)
545 break;
546 ++error;
547 }
548 else
549 {
550 pp = (PTR_BL *)(hp->bh_data);
551 if (pp->pb_id == PTR_ID) /* it is a pointer block */
552 {
553 if (pp->pb_count == 0)
554 {
555 /* empty block? */
556 ++error;
557 }
558 else if (idx < (int)pp->pb_count) /* go a block deeper */
559 {
560 if (pp->pb_pointer[idx].pe_bnum < 0)
561 {
Bram Moolenaarbc563362015-06-09 18:35:25 +0200562 /* Skip data block with negative block number.
563 * Should not happen, because of the ml_preserve()
564 * above. Get same block again for next index. */
565 ++idx;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200566 continue;
567 }
568
569 /* going one block deeper in the tree, new entry in
570 * stack */
571 if ((top = ml_add_stack(buf)) < 0)
572 {
573 ++error;
574 break; /* out of memory */
575 }
576 ip = &(buf->b_ml.ml_stack[top]);
577 ip->ip_bnum = bnum;
578 ip->ip_index = idx;
579
580 bnum = pp->pb_pointer[idx].pe_bnum;
581 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200582 idx = 0;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200583 continue;
584 }
585 }
586 else /* not a pointer block */
587 {
588 dp = (DATA_BL *)(hp->bh_data);
589 if (dp->db_id != DATA_ID) /* block id wrong */
590 ++error;
591 else
592 {
593 /* It is a data block, need to write it back to disk. */
594 mf_put(mfp, hp, TRUE, FALSE);
595 hp = NULL;
596 }
597 }
598 }
599
600 if (buf->b_ml.ml_stack_top == 0) /* finished */
601 break;
602
603 /* go one block up in the tree */
604 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
605 bnum = ip->ip_bnum;
606 idx = ip->ip_index + 1; /* go to next index */
607 page_count = 1;
608 }
Bram Moolenaarbc563362015-06-09 18:35:25 +0200609 if (hp != NULL)
610 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +0100611
612 if (error > 0)
613 EMSG(_("E843: Error while updating swap file crypt"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200614 }
615
616 mfp->mf_old_key = NULL;
617}
618#endif
619
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620/*
621 * ml_setname() is called when the file name of "buf" has been changed.
622 * It may rename the swap file.
623 */
624 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100625ml_setname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626{
627 int success = FALSE;
628 memfile_T *mfp;
629 char_u *fname;
630 char_u *dirp;
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100631#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 char_u *p;
633#endif
634
635 mfp = buf->b_ml.ml_mfp;
636 if (mfp->mf_fd < 0) /* there is no swap file yet */
637 {
638 /*
639 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
640 * For help files we will make a swap file now.
641 */
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100642 if (p_uc != 0 && !cmdmod.noswapfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643 ml_open_file(buf); /* create a swap file */
644 return;
645 }
646
647 /*
648 * Try all directories in the 'directory' option.
649 */
650 dirp = p_dir;
651 for (;;)
652 {
653 if (*dirp == NUL) /* tried all directories, fail */
654 break;
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000655 fname = findswapname(buf, &dirp, mfp->mf_fname);
656 /* alloc's fname */
Bram Moolenaarf541c362011-10-26 11:44:18 +0200657 if (dirp == NULL) /* out of memory */
658 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 if (fname == NULL) /* no file name found for this dir */
660 continue;
661
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100662#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 /*
664 * Set full pathname for swap file now, because a ":!cd dir" may
665 * change directory without us knowing it.
666 */
667 p = FullName_save(fname, FALSE);
668 vim_free(fname);
669 fname = p;
670 if (fname == NULL)
671 continue;
672#endif
673 /* if the file name is the same we don't have to do anything */
674 if (fnamecmp(fname, mfp->mf_fname) == 0)
675 {
676 vim_free(fname);
677 success = TRUE;
678 break;
679 }
680 /* need to close the swap file before renaming */
681 if (mfp->mf_fd >= 0)
682 {
683 close(mfp->mf_fd);
684 mfp->mf_fd = -1;
685 }
686
687 /* try to rename the swap file */
688 if (vim_rename(mfp->mf_fname, fname) == 0)
689 {
690 success = TRUE;
691 vim_free(mfp->mf_fname);
692 mfp->mf_fname = fname;
693 vim_free(mfp->mf_ffname);
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100694#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
696#else
697 mf_set_ffname(mfp);
698#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200699 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 break;
701 }
702 vim_free(fname); /* this fname didn't work, try another */
703 }
704
705 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
706 {
707 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
708 if (mfp->mf_fd < 0)
709 {
710 /* could not (re)open the swap file, what can we do???? */
711 EMSG(_("E301: Oops, lost the swap file!!!"));
712 return;
713 }
Bram Moolenaarf05da212009-11-17 16:13:15 +0000714#ifdef HAVE_FD_CLOEXEC
715 {
716 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
717 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarfbc4b4d2016-02-07 15:14:01 +0100718 (void)fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaarf05da212009-11-17 16:13:15 +0000719 }
720#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 }
722 if (!success)
723 EMSG(_("E302: Could not rename swap file"));
724}
725
726/*
727 * Open a file for the memfile for all buffers that are not readonly or have
728 * been modified.
729 * Used when 'updatecount' changes from zero to non-zero.
730 */
731 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100732ml_open_files(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733{
734 buf_T *buf;
735
Bram Moolenaar29323592016-07-24 22:04:11 +0200736 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 if (!buf->b_p_ro || buf->b_changed)
738 ml_open_file(buf);
739}
740
741/*
742 * Open a swap file for an existing memfile, if there is no swap file yet.
743 * If we are unable to find a file name, mf_fname will be NULL
744 * and the memfile will be in memory only (no recovery possible).
745 */
746 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100747ml_open_file(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748{
749 memfile_T *mfp;
750 char_u *fname;
751 char_u *dirp;
752
753 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100754 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf || cmdmod.noswapfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755 return; /* nothing to do */
756
Bram Moolenaara1956f62006-03-12 22:18:00 +0000757#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +0000758 /* For a spell buffer use a temp file name. */
759 if (buf->b_spell)
760 {
Bram Moolenaare5c421c2015-03-31 13:33:08 +0200761 fname = vim_tempname('s', FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000762 if (fname != NULL)
763 (void)mf_open_file(mfp, fname); /* consumes fname! */
764 buf->b_may_swap = FALSE;
765 return;
766 }
767#endif
768
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 /*
770 * Try all directories in 'directory' option.
771 */
772 dirp = p_dir;
773 for (;;)
774 {
775 if (*dirp == NUL)
776 break;
Bram Moolenaare242b832010-06-24 05:39:03 +0200777 /* There is a small chance that between choosing the swap file name
778 * and creating it, another Vim creates the file. In that case the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 * creation will fail and we will use another directory. */
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000780 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
Bram Moolenaarf541c362011-10-26 11:44:18 +0200781 if (dirp == NULL)
782 break; /* out of memory */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 if (fname == NULL)
784 continue;
785 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
786 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100787#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 /*
789 * set full pathname for swap file now, because a ":!cd dir" may
790 * change directory without us knowing it.
791 */
792 mf_fullname(mfp);
793#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200794 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000795
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 /* Flush block zero, so others can read it */
797 if (mf_sync(mfp, MFS_ZERO) == OK)
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000798 {
799 /* Mark all blocks that should be in the swapfile as dirty.
800 * Needed for when the 'swapfile' option was reset, so that
801 * the swap file was deleted, and then on again. */
802 mf_set_dirty(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 break;
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000804 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 /* Writing block 0 failed: close the file and try another dir */
806 mf_close_file(buf, FALSE);
807 }
808 }
809
810 if (mfp->mf_fname == NULL) /* Failed! */
811 {
812 need_wait_return = TRUE; /* call wait_return later */
813 ++no_wait_return;
814 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
Bram Moolenaare1704ba2012-10-03 18:25:00 +0200815 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 --no_wait_return;
817 }
818
819 /* don't try to open a swap file again */
820 buf->b_may_swap = FALSE;
821}
822
823/*
824 * If still need to create a swap file, and starting to edit a not-readonly
825 * file, or reading into an existing buffer, create a swap file now.
826 */
827 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100828check_need_swap(
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200829 int newfile) // reading file into new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830{
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200831 int old_msg_silent = msg_silent; // might be reset by an E325 message
832
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
834 ml_open_file(curbuf);
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200835 msg_silent = old_msg_silent;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836}
837
838/*
839 * Close memline for buffer 'buf'.
840 * If 'del_file' is TRUE, delete the swap file
841 */
842 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100843ml_close(buf_T *buf, int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844{
845 if (buf->b_ml.ml_mfp == NULL) /* not open */
846 return;
847 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
848 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
849 vim_free(buf->b_ml.ml_line_ptr);
850 vim_free(buf->b_ml.ml_stack);
851#ifdef FEAT_BYTEOFF
Bram Moolenaard23a8232018-02-10 18:45:26 +0100852 VIM_CLEAR(buf->b_ml.ml_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853#endif
854 buf->b_ml.ml_mfp = NULL;
855
856 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
857 * this buffer is loaded. */
858 buf->b_flags &= ~BF_RECOVERED;
859}
860
861/*
862 * Close all existing memlines and memfiles.
863 * Only used when exiting.
864 * When 'del_file' is TRUE, delete the memfiles.
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000865 * But don't delete files that were ":preserve"d when we are POSIX compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 */
867 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100868ml_close_all(int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869{
870 buf_T *buf;
871
Bram Moolenaar29323592016-07-24 22:04:11 +0200872 FOR_ALL_BUFFERS(buf)
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000873 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
874 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100875#ifdef FEAT_SPELL
876 spell_delete_wordlist(); /* delete the internal wordlist */
877#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878#ifdef TEMPDIRNAMES
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100879 vim_deltempdir(); /* delete created temp directory */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880#endif
881}
882
883/*
884 * Close all memfiles for not modified buffers.
885 * Only use just before exiting!
886 */
887 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100888ml_close_notmod(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889{
890 buf_T *buf;
891
Bram Moolenaar29323592016-07-24 22:04:11 +0200892 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 if (!bufIsChanged(buf))
894 ml_close(buf, TRUE); /* close all not-modified buffers */
895}
896
897/*
898 * Update the timestamp in the .swp file.
899 * Used when the file has been written.
900 */
901 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100902ml_timestamp(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903{
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200904 ml_upd_block0(buf, UB_FNAME);
905}
906
907/*
908 * Return FAIL when the ID of "b0p" is wrong.
909 */
910 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100911ml_check_b0_id(ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200912{
913 if (b0p->b0_id[0] != BLOCK0_ID0
914 || (b0p->b0_id[1] != BLOCK0_ID1
915 && b0p->b0_id[1] != BLOCK0_ID1_C0
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200916 && b0p->b0_id[1] != BLOCK0_ID1_C1
917 && b0p->b0_id[1] != BLOCK0_ID1_C2)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200918 )
919 return FAIL;
920 return OK;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000921}
922
923/*
924 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
925 */
926 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100927ml_upd_block0(buf_T *buf, upd_block0_T what)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000928{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 memfile_T *mfp;
930 bhdr_T *hp;
931 ZERO_BL *b0p;
932
933 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200934 if (mfp == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200936 hp = mf_get(mfp, (blocknr_T)0, 1);
937 if (hp == NULL)
938 {
939#ifdef FEAT_CRYPT
940 /* Possibly update the seed in the memfile before there is a block0. */
941 if (what == UB_CRYPT)
942 ml_set_mfp_crypt(buf);
943#endif
944 return;
945 }
946
Bram Moolenaar071d4272004-06-13 20:20:40 +0000947 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200948 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100949 IEMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000951 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200952 if (what == UB_FNAME)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000953 set_b0_fname(b0p, buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200954#ifdef FEAT_CRYPT
955 else if (what == UB_CRYPT)
956 ml_set_b0_crypt(buf, b0p);
957#endif
958 else /* what == UB_SAME_DIR */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000959 set_b0_dir_flag(b0p, buf);
960 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961 mf_put(mfp, hp, TRUE, FALSE);
962}
963
964/*
965 * Write file name and timestamp into block 0 of a swap file.
966 * Also set buf->b_mtime.
967 * Don't use NameBuff[]!!!
968 */
969 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100970set_b0_fname(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971{
Bram Moolenaar8767f522016-07-01 17:17:39 +0200972 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973
974 if (buf->b_ffname == NULL)
975 b0p->b0_fname[0] = NUL;
976 else
977 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100978#if defined(MSWIN) || defined(AMIGA)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000979 /* Systems that cannot translate "~user" back into a path: copy the
980 * file name unmodified. Do use slashes instead of backslashes for
981 * portability. */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200982 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000983# ifdef BACKSLASH_IN_FILENAME
984 forward_slash(b0p->b0_fname);
985# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986#else
987 size_t flen, ulen;
988 char_u uname[B0_UNAME_SIZE];
989
990 /*
991 * For a file under the home directory of the current user, we try to
992 * replace the home directory path with "~user". This helps when
993 * editing the same file on different machines over a network.
994 * First replace home dir path with "~/" with home_replace().
995 * Then insert the user name to get "~user/".
996 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200997 home_replace(NULL, buf->b_ffname, b0p->b0_fname,
998 B0_FNAME_SIZE_CRYPT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 if (b0p->b0_fname[0] == '~')
1000 {
1001 flen = STRLEN(b0p->b0_fname);
1002 /* If there is no user name or it is too long, don't use "~/" */
1003 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001004 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE_CRYPT - 1)
1005 vim_strncpy(b0p->b0_fname, buf->b_ffname,
1006 B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 else
1008 {
1009 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
1010 mch_memmove(b0p->b0_fname + 1, uname, ulen);
1011 }
1012 }
1013#endif
1014 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
1015 {
1016 long_to_char((long)st.st_mtime, b0p->b0_mtime);
1017#ifdef CHECK_INODE
1018 long_to_char((long)st.st_ino, b0p->b0_ino);
1019#endif
1020 buf_store_time(buf, &st, buf->b_ffname);
1021 buf->b_mtime_read = buf->b_mtime;
1022 }
1023 else
1024 {
1025 long_to_char(0L, b0p->b0_mtime);
1026#ifdef CHECK_INODE
1027 long_to_char(0L, b0p->b0_ino);
1028#endif
1029 buf->b_mtime = 0;
1030 buf->b_mtime_read = 0;
1031 buf->b_orig_size = 0;
1032 buf->b_orig_mode = 0;
1033 }
1034 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001035
1036#ifdef FEAT_MBYTE
1037 /* Also add the 'fileencoding' if there is room. */
1038 add_b0_fenc(b0p, curbuf);
1039#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040}
1041
1042/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001043 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
1044 * swapfile for "buf" are in the same directory.
1045 * This is fail safe: if we are not sure the directories are equal the flag is
1046 * not set.
1047 */
1048 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001049set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001050{
1051 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
1052 b0p->b0_flags |= B0_SAME_DIR;
1053 else
1054 b0p->b0_flags &= ~B0_SAME_DIR;
1055}
1056
1057#ifdef FEAT_MBYTE
1058/*
1059 * When there is room, add the 'fileencoding' to block zero.
1060 */
1061 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001062add_b0_fenc(
1063 ZERO_BL *b0p,
1064 buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001065{
1066 int n;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001067 int size = B0_FNAME_SIZE_NOCRYPT;
1068
1069# ifdef FEAT_CRYPT
1070 /* Without encryption use the same offset as in Vim 7.2 to be compatible.
1071 * With encryption it's OK to move elsewhere, the swap file is not
1072 * compatible anyway. */
1073 if (*buf->b_p_key != NUL)
1074 size = B0_FNAME_SIZE_CRYPT;
1075# endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001076
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001077 n = (int)STRLEN(buf->b_p_fenc);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001078 if ((int)STRLEN(b0p->b0_fname) + n + 1 > size)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001079 b0p->b0_flags &= ~B0_HAS_FENC;
1080 else
1081 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001082 mch_memmove((char *)b0p->b0_fname + size - n,
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001083 (char *)buf->b_p_fenc, (size_t)n);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001084 *(b0p->b0_fname + size - n - 1) = NUL;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001085 b0p->b0_flags |= B0_HAS_FENC;
1086 }
1087}
1088#endif
1089
1090
1091/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001092 * Try to recover curbuf from the .swp file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 */
1094 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001095ml_recover(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096{
1097 buf_T *buf = NULL;
1098 memfile_T *mfp = NULL;
1099 char_u *fname;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001100 char_u *fname_used = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 bhdr_T *hp = NULL;
1102 ZERO_BL *b0p;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001103 int b0_ff;
1104 char_u *b0_fenc = NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001105#ifdef FEAT_CRYPT
1106 int b0_cm = -1;
1107#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 PTR_BL *pp;
1109 DATA_BL *dp;
1110 infoptr_T *ip;
1111 blocknr_T bnum;
1112 int page_count;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001113 stat_T org_stat, swp_stat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 int len;
1115 int directly;
1116 linenr_T lnum;
1117 char_u *p;
1118 int i;
1119 long error;
1120 int cannot_open;
1121 linenr_T line_count;
1122 int has_error;
1123 int idx;
1124 int top;
1125 int txt_start;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001126 off_T size;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 int called_from_main;
1128 int serious_error = TRUE;
1129 long mtime;
1130 int attr;
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001131 int orig_file_status = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132
1133 recoverymode = TRUE;
1134 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001135 attr = HL_ATTR(HLF_E);
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001136
1137 /*
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001138 * If the file name ends in ".s[a-w][a-z]" we assume this is the swap file.
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001139 * Otherwise a search is done to find the swap file(s).
1140 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 fname = curbuf->b_fname;
1142 if (fname == NULL) /* When there is no file name */
1143 fname = (char_u *)"";
1144 len = (int)STRLEN(fname);
1145 if (len >= 4 &&
Bram Moolenaare60acc12011-05-10 16:41:25 +02001146#if defined(VMS)
Bram Moolenaar79518e22017-02-17 16:31:35 +01001147 STRNICMP(fname + len - 4, "_s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148#else
Bram Moolenaar79518e22017-02-17 16:31:35 +01001149 STRNICMP(fname + len - 4, ".s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150#endif
Bram Moolenaar79518e22017-02-17 16:31:35 +01001151 == 0
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001152 && vim_strchr((char_u *)"abcdefghijklmnopqrstuvw",
1153 TOLOWER_ASC(fname[len - 2])) != NULL
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001154 && ASCII_ISALPHA(fname[len - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 {
1156 directly = TRUE;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001157 fname_used = vim_strsave(fname); /* make a copy for mf_open() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 }
1159 else
1160 {
1161 directly = FALSE;
1162
1163 /* count the number of matching swap files */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001164 len = recover_names(fname, FALSE, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 if (len == 0) /* no swap files found */
1166 {
1167 EMSG2(_("E305: No swap file found for %s"), fname);
1168 goto theend;
1169 }
1170 if (len == 1) /* one swap file found, use it */
1171 i = 1;
1172 else /* several swap files found, choose */
1173 {
1174 /* list the names of the swap files */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001175 (void)recover_names(fname, TRUE, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 msg_putchar('\n');
1177 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001178 i = get_number(FALSE, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 if (i < 1 || i > len)
1180 goto theend;
1181 }
1182 /* get the swap file name that will be used */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001183 (void)recover_names(fname, FALSE, i, &fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001185 if (fname_used == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 goto theend; /* out of memory */
1187
1188 /* When called from main() still need to initialize storage structure */
Bram Moolenaar4770d092006-01-12 23:22:24 +00001189 if (called_from_main && ml_open(curbuf) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 getout(1);
1191
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001192 /*
1193 * Allocate a buffer structure for the swap file that is used for recovery.
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001194 * Only the memline and crypt information in it are really used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001195 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
1197 if (buf == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001200 /*
1201 * init fields in memline struct
1202 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1204 buf->b_ml.ml_stack = NULL; /* no stack yet */
1205 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
1206 buf->b_ml.ml_line_lnum = 0; /* no cached line */
1207 buf->b_ml.ml_locked = NULL; /* no locked block */
1208 buf->b_ml.ml_flags = 0;
Bram Moolenaar0fe849a2010-07-25 15:11:11 +02001209#ifdef FEAT_CRYPT
1210 buf->b_p_key = empty_option;
1211 buf->b_p_cm = empty_option;
1212#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001214 /*
1215 * open the memfile from the old swap file
1216 */
1217 p = vim_strsave(fname_used); /* save "fname_used" for the message:
1218 mf_open() will consume "fname_used"! */
1219 mfp = mf_open(fname_used, O_RDONLY);
1220 fname_used = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 if (mfp == NULL || mfp->mf_fd < 0)
1222 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001223 if (fname_used != NULL)
1224 EMSG2(_("E306: Cannot open %s"), fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 goto theend;
1226 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001228#ifdef FEAT_CRYPT
1229 mfp->mf_buffer = buf;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001230#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231
1232 /*
1233 * The page size set in mf_open() might be different from the page size
1234 * used in the swap file, we must get it from block 0. But to read block
1235 * 0 we need a page size. Use the minimal size for block 0 here, it will
1236 * be set to the real value below.
1237 */
1238 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
1239
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001240 /*
1241 * try to read block 0
1242 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
1244 {
1245 msg_start();
1246 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
1247 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001248 MSG_PUTS_ATTR(_("\nMaybe no changes were made or Vim did not update the swap file."),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 attr | MSG_HIST);
1250 msg_end();
1251 goto theend;
1252 }
1253 b0p = (ZERO_BL *)(hp->bh_data);
1254 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
1255 {
1256 msg_start();
1257 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
1258 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1259 MSG_HIST);
1260 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
1261 msg_end();
1262 goto theend;
1263 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001264 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 {
1266 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
1267 goto theend;
1268 }
1269 if (b0_magic_wrong(b0p))
1270 {
1271 msg_start();
1272 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001273#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1275 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1276 attr | MSG_HIST);
1277 else
1278#endif
1279 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1280 attr | MSG_HIST);
1281 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
Bram Moolenaare242b832010-06-24 05:39:03 +02001282 /* avoid going past the end of a corrupted hostname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 b0p->b0_fname[0] = NUL;
1284 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1285 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1286 msg_end();
1287 goto theend;
1288 }
Bram Moolenaar1c536282007-04-26 15:21:56 +00001289
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001290#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001291 for (i = 0; i < (int)(sizeof(id1_codes) / sizeof(int)); ++i)
1292 if (id1_codes[i] == b0p->b0_id[1])
1293 b0_cm = i;
1294 if (b0_cm > 0)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001295 mch_memmove(mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001296 crypt_set_cm_option(buf, b0_cm < 0 ? 0 : b0_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001297#else
1298 if (b0p->b0_id[1] != BLOCK0_ID1)
1299 {
Bram Moolenaar996343d2010-07-04 22:20:21 +02001300 EMSG2(_("E833: %s is encrypted and this version of Vim does not support encryption"), mfp->mf_fname);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001301 goto theend;
1302 }
1303#endif
1304
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 /*
1306 * If we guessed the wrong page size, we have to recalculate the
1307 * highest block number in the file.
1308 */
1309 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1310 {
Bram Moolenaar1c536282007-04-26 15:21:56 +00001311 unsigned previous_page_size = mfp->mf_page_size;
1312
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
Bram Moolenaar1c536282007-04-26 15:21:56 +00001314 if (mfp->mf_page_size < previous_page_size)
1315 {
1316 msg_start();
1317 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1318 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1319 attr | MSG_HIST);
1320 msg_end();
1321 goto theend;
1322 }
Bram Moolenaar8767f522016-07-01 17:17:39 +02001323 if ((size = vim_lseek(mfp->mf_fd, (off_T)0L, SEEK_END)) <= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 mfp->mf_blocknr_max = 0; /* no file or empty file */
1325 else
1326 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1327 mfp->mf_infile_count = mfp->mf_blocknr_max;
Bram Moolenaar1c536282007-04-26 15:21:56 +00001328
1329 /* need to reallocate the memory used to store the data */
1330 p = alloc(mfp->mf_page_size);
1331 if (p == NULL)
1332 goto theend;
1333 mch_memmove(p, hp->bh_data, previous_page_size);
1334 vim_free(hp->bh_data);
1335 hp->bh_data = p;
1336 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 }
1338
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001339 /*
1340 * If .swp file name given directly, use name from swap file for buffer.
1341 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 if (directly)
1343 {
1344 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1345 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1346 goto theend;
1347 }
1348
1349 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaar555b2802005-05-19 21:08:39 +00001350 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351
1352 if (buf_spname(curbuf) != NULL)
Bram Moolenaare1704ba2012-10-03 18:25:00 +02001353 vim_strncpy(NameBuff, buf_spname(curbuf), MAXPATHL - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 else
1355 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaar555b2802005-05-19 21:08:39 +00001356 smsg((char_u *)_("Original file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 msg_putchar('\n');
1358
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001359 /*
1360 * check date of swap file and original file
1361 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 mtime = char_to_long(b0p->b0_mtime);
1363 if (curbuf->b_ffname != NULL
1364 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1365 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1366 && org_stat.st_mtime > swp_stat.st_mtime)
1367 || org_stat.st_mtime != mtime))
1368 {
1369 EMSG(_("E308: Warning: Original file may have been changed"));
1370 }
1371 out_flush();
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001372
1373 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1374 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1375 if (b0p->b0_flags & B0_HAS_FENC)
1376 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001377 int fnsize = B0_FNAME_SIZE_NOCRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001378
1379#ifdef FEAT_CRYPT
1380 /* Use the same size as in add_b0_fenc(). */
1381 if (b0p->b0_id[1] != BLOCK0_ID1)
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001382 fnsize = B0_FNAME_SIZE_CRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001383#endif
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001384 for (p = b0p->b0_fname + fnsize; p > b0p->b0_fname && p[-1] != NUL; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001385 ;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001386 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + fnsize - p));
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001387 }
1388
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1390 hp = NULL;
1391
1392 /*
1393 * Now that we are sure that the file is going to be recovered, clear the
1394 * contents of the current buffer.
1395 */
1396 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1397 ml_delete((linenr_T)1, FALSE);
1398
1399 /*
1400 * Try reading the original file to obtain the values of 'fileformat',
1401 * 'fileencoding', etc. Ignore errors. The text itself is not used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001402 * When the file is encrypted the user is asked to enter the key.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 */
1404 if (curbuf->b_ffname != NULL)
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001405 orig_file_status = readfile(curbuf->b_ffname, NULL, (linenr_T)0,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001408#ifdef FEAT_CRYPT
1409 if (b0_cm >= 0)
1410 {
1411 /* Need to ask the user for the crypt key. If this fails we continue
1412 * without a key, will probably get garbage text. */
1413 if (*curbuf->b_p_key != NUL)
1414 {
1415 smsg((char_u *)_("Swap file is encrypted: \"%s\""), fname_used);
1416 MSG_PUTS(_("\nIf you entered a new crypt key but did not write the text file,"));
1417 MSG_PUTS(_("\nenter the new crypt key."));
1418 MSG_PUTS(_("\nIf you wrote the text file after changing the crypt key press enter"));
1419 MSG_PUTS(_("\nto use the same key for text file and swap file"));
1420 }
1421 else
1422 smsg((char_u *)_(need_key_msg), fname_used);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001423 buf->b_p_key = crypt_get_key(FALSE, FALSE);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001424 if (buf->b_p_key == NULL)
1425 buf->b_p_key = curbuf->b_p_key;
1426 else if (*buf->b_p_key == NUL)
1427 {
1428 vim_free(buf->b_p_key);
1429 buf->b_p_key = curbuf->b_p_key;
1430 }
1431 if (buf->b_p_key == NULL)
1432 buf->b_p_key = empty_option;
1433 }
1434#endif
1435
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001436 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1437 if (b0_ff != 0)
1438 set_fileformat(b0_ff - 1, OPT_LOCAL);
1439 if (b0_fenc != NULL)
1440 {
1441 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1442 vim_free(b0_fenc);
1443 }
1444 unchanged(curbuf, TRUE);
1445
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 bnum = 1; /* start with block 1 */
1447 page_count = 1; /* which is 1 page */
1448 lnum = 0; /* append after line 0 in curbuf */
1449 line_count = 0;
1450 idx = 0; /* start with first index in block 1 */
1451 error = 0;
1452 buf->b_ml.ml_stack_top = 0;
1453 buf->b_ml.ml_stack = NULL;
1454 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1455
1456 if (curbuf->b_ffname == NULL)
1457 cannot_open = TRUE;
1458 else
1459 cannot_open = FALSE;
1460
1461 serious_error = FALSE;
1462 for ( ; !got_int; line_breakcheck())
1463 {
1464 if (hp != NULL)
1465 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1466
1467 /*
1468 * get block
1469 */
1470 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1471 {
1472 if (bnum == 1)
1473 {
1474 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1475 goto theend;
1476 }
1477 ++error;
1478 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1479 (colnr_T)0, TRUE);
1480 }
1481 else /* there is a block */
1482 {
1483 pp = (PTR_BL *)(hp->bh_data);
1484 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1485 {
1486 /* check line count when using pointer block first time */
1487 if (idx == 0 && line_count != 0)
1488 {
1489 for (i = 0; i < (int)pp->pb_count; ++i)
1490 line_count -= pp->pb_pointer[i].pe_line_count;
1491 if (line_count != 0)
1492 {
1493 ++error;
1494 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1495 (colnr_T)0, TRUE);
1496 }
1497 }
1498
1499 if (pp->pb_count == 0)
1500 {
1501 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1502 (colnr_T)0, TRUE);
1503 ++error;
1504 }
1505 else if (idx < (int)pp->pb_count) /* go a block deeper */
1506 {
1507 if (pp->pb_pointer[idx].pe_bnum < 0)
1508 {
1509 /*
1510 * Data block with negative block number.
1511 * Try to read lines from the original file.
1512 * This is slow, but it works.
1513 */
1514 if (!cannot_open)
1515 {
1516 line_count = pp->pb_pointer[idx].pe_line_count;
1517 if (readfile(curbuf->b_ffname, NULL, lnum,
1518 pp->pb_pointer[idx].pe_old_lnum - 1,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001519 line_count, NULL, 0) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 cannot_open = TRUE;
1521 else
1522 lnum += line_count;
1523 }
1524 if (cannot_open)
1525 {
1526 ++error;
1527 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1528 (colnr_T)0, TRUE);
1529 }
1530 ++idx; /* get same block again for next index */
1531 continue;
1532 }
1533
1534 /*
1535 * going one block deeper in the tree
1536 */
1537 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1538 {
1539 ++error;
1540 break; /* out of memory */
1541 }
1542 ip = &(buf->b_ml.ml_stack[top]);
1543 ip->ip_bnum = bnum;
1544 ip->ip_index = idx;
1545
1546 bnum = pp->pb_pointer[idx].pe_bnum;
1547 line_count = pp->pb_pointer[idx].pe_line_count;
1548 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaar986a0032011-06-13 01:07:27 +02001549 idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 continue;
1551 }
1552 }
1553 else /* not a pointer block */
1554 {
1555 dp = (DATA_BL *)(hp->bh_data);
1556 if (dp->db_id != DATA_ID) /* block id wrong */
1557 {
1558 if (bnum == 1)
1559 {
1560 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1561 mfp->mf_fname);
1562 goto theend;
1563 }
1564 ++error;
1565 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1566 (colnr_T)0, TRUE);
1567 }
1568 else
1569 {
1570 /*
1571 * it is a data block
1572 * Append all the lines in this block
1573 */
1574 has_error = FALSE;
1575 /*
1576 * check length of block
1577 * if wrong, use length in pointer block
1578 */
1579 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1580 {
1581 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1582 (colnr_T)0, TRUE);
1583 ++error;
1584 has_error = TRUE;
1585 dp->db_txt_end = page_count * mfp->mf_page_size;
1586 }
1587
1588 /* make sure there is a NUL at the end of the block */
1589 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1590
1591 /*
1592 * check number of lines in block
1593 * if wrong, use count in data block
1594 */
1595 if (line_count != dp->db_line_count)
1596 {
1597 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1598 (colnr_T)0, TRUE);
1599 ++error;
1600 has_error = TRUE;
1601 }
1602
1603 for (i = 0; i < dp->db_line_count; ++i)
1604 {
1605 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
Bram Moolenaar740885b2009-11-03 14:33:17 +00001606 if (txt_start <= (int)HEADER_SIZE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 || txt_start >= (int)dp->db_txt_end)
1608 {
1609 p = (char_u *)"???";
1610 ++error;
1611 }
1612 else
1613 p = (char_u *)dp + txt_start;
1614 ml_append(lnum++, p, (colnr_T)0, TRUE);
1615 }
1616 if (has_error)
Bram Moolenaar740885b2009-11-03 14:33:17 +00001617 ml_append(lnum++, (char_u *)_("???END"),
1618 (colnr_T)0, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 }
1620 }
1621 }
1622
1623 if (buf->b_ml.ml_stack_top == 0) /* finished */
1624 break;
1625
1626 /*
1627 * go one block up in the tree
1628 */
1629 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1630 bnum = ip->ip_bnum;
1631 idx = ip->ip_index + 1; /* go to next index */
1632 page_count = 1;
1633 }
1634
1635 /*
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001636 * Compare the buffer contents with the original file. When they differ
1637 * set the 'modified' flag.
1638 * Lines 1 - lnum are the new contents.
1639 * Lines lnum + 1 to ml_line_count are the original contents.
1640 * Line ml_line_count + 1 in the dummy empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 */
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001642 if (orig_file_status != OK || curbuf->b_ml.ml_line_count != lnum * 2 + 1)
1643 {
1644 /* Recovering an empty file results in two lines and the first line is
1645 * empty. Don't set the modified flag then. */
1646 if (!(curbuf->b_ml.ml_line_count == 2 && *ml_get(1) == NUL))
1647 {
1648 changed_int();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001649 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001650 }
1651 }
1652 else
1653 {
1654 for (idx = 1; idx <= lnum; ++idx)
1655 {
1656 /* Need to copy one line, fetching the other one may flush it. */
1657 p = vim_strsave(ml_get(idx));
1658 i = STRCMP(p, ml_get(idx + lnum));
1659 vim_free(p);
1660 if (i != 0)
1661 {
1662 changed_int();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001663 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001664 break;
1665 }
1666 }
1667 }
1668
1669 /*
1670 * Delete the lines from the original file and the dummy line from the
1671 * empty buffer. These will now be after the last line in the buffer.
1672 */
1673 while (curbuf->b_ml.ml_line_count > lnum
1674 && !(curbuf->b_ml.ml_flags & ML_EMPTY))
1675 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 curbuf->b_flags |= BF_RECOVERED;
1677
1678 recoverymode = FALSE;
1679 if (got_int)
1680 EMSG(_("E311: Recovery Interrupted"));
1681 else if (error)
1682 {
1683 ++no_wait_return;
1684 MSG(">>>>>>>>>>>>>");
1685 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1686 --no_wait_return;
1687 MSG(_("See \":help E312\" for more information."));
1688 MSG(">>>>>>>>>>>>>");
1689 }
1690 else
1691 {
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001692 if (curbuf->b_changed)
1693 {
1694 MSG(_("Recovery completed. You should check if everything is OK."));
1695 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1696 MSG_PUTS(_("and run diff with the original file to check for changes)"));
1697 }
1698 else
1699 MSG(_("Recovery completed. Buffer contents equals file contents."));
1700 MSG_PUTS(_("\nYou may want to delete the .swp file now.\n\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 cmdline_row = msg_row;
1702 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001703#ifdef FEAT_CRYPT
1704 if (*buf->b_p_key != NUL && STRCMP(curbuf->b_p_key, buf->b_p_key) != 0)
1705 {
1706 MSG_PUTS(_("Using crypt key from swap file for the text file.\n"));
1707 set_option_value((char_u *)"key", 0L, buf->b_p_key, OPT_LOCAL);
1708 }
1709#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 redraw_curbuf_later(NOT_VALID);
1711
1712theend:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001713 vim_free(fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 recoverymode = FALSE;
1715 if (mfp != NULL)
1716 {
1717 if (hp != NULL)
1718 mf_put(mfp, hp, FALSE, FALSE);
1719 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1720 }
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001721 if (buf != NULL)
1722 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001723#ifdef FEAT_CRYPT
1724 if (buf->b_p_key != curbuf->b_p_key)
1725 free_string_option(buf->b_p_key);
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001726 free_string_option(buf->b_p_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001727#endif
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001728 vim_free(buf->b_ml.ml_stack);
1729 vim_free(buf);
1730 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 if (serious_error && called_from_main)
1732 ml_close(curbuf, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 else
1734 {
1735 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1736 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1737 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 return;
1739}
1740
1741/*
1742 * Find the names of swap files in current directory and the directory given
1743 * with the 'directory' option.
1744 *
1745 * Used to:
1746 * - list the swap files for "vim -r"
1747 * - count the number of swap files when recovering
1748 * - list the swap files when recovering
1749 * - find the name of the n'th swap file when recovering
1750 */
1751 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001752recover_names(
1753 char_u *fname, /* base for swap file name */
1754 int list, /* when TRUE, list the swap file names */
1755 int nr, /* when non-zero, return nr'th swap file name */
1756 char_u **fname_out) /* result when "nr" > 0 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757{
1758 int num_names;
1759 char_u *(names[6]);
1760 char_u *tail;
1761 char_u *p;
1762 int num_files;
1763 int file_count = 0;
1764 char_u **files;
1765 int i;
1766 char_u *dirp;
1767 char_u *dir_name;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001768 char_u *fname_res = NULL;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001769#ifdef HAVE_READLINK
1770 char_u fname_buf[MAXPATHL];
Bram Moolenaar64354da2010-05-25 21:37:17 +02001771#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001772
Bram Moolenaar64354da2010-05-25 21:37:17 +02001773 if (fname != NULL)
1774 {
1775#ifdef HAVE_READLINK
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001776 /* Expand symlink in the file name, because the swap file is created
1777 * with the actual file instead of with the symlink. */
1778 if (resolve_symlink(fname, fname_buf) == OK)
1779 fname_res = fname_buf;
1780 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001781#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001782 fname_res = fname;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001783 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784
1785 if (list)
1786 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001787 /* use msg() to start the scrolling properly */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 msg((char_u *)_("Swap files found:"));
1789 msg_putchar('\n');
1790 }
1791
1792 /*
1793 * Do the loop for every directory in 'directory'.
1794 * First allocate some memory to put the directory name in.
1795 */
1796 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1797 dirp = p_dir;
1798 while (dir_name != NULL && *dirp)
1799 {
1800 /*
1801 * Isolate a directory name from *dirp and put it in dir_name (we know
1802 * it is large enough, so use 31000 for length).
1803 * Advance dirp to next directory name.
1804 */
1805 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1806
1807 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1808 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001809 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 {
1811#ifdef VMS
1812 names[0] = vim_strsave((char_u *)"*_sw%");
1813#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 names[0] = vim_strsave((char_u *)"*.sw?");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815#endif
Bram Moolenaar2cc93182006-10-10 19:56:03 +00001816#if defined(UNIX) || defined(WIN3264)
1817 /* For Unix names starting with a dot are special. MS-Windows
1818 * supports this too, on some file systems. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 names[1] = vim_strsave((char_u *)".*.sw?");
1820 names[2] = vim_strsave((char_u *)".sw?");
1821 num_names = 3;
1822#else
1823# ifdef VMS
1824 names[1] = vim_strsave((char_u *)".*_sw%");
1825 num_names = 2;
1826# else
1827 num_names = 1;
1828# endif
1829#endif
1830 }
1831 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001832 num_names = recov_file_names(names, fname_res, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 }
1834 else /* check directory dir_name */
1835 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001836 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 {
1838#ifdef VMS
1839 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1840#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842#endif
Bram Moolenaar2cc93182006-10-10 19:56:03 +00001843#if defined(UNIX) || defined(WIN3264)
1844 /* For Unix names starting with a dot are special. MS-Windows
1845 * supports this too, on some file systems. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1847 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1848 num_names = 3;
1849#else
1850# ifdef VMS
1851 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1852 num_names = 2;
1853# else
1854 num_names = 1;
1855# endif
1856#endif
1857 }
1858 else
1859 {
1860#if defined(UNIX) || defined(WIN3264)
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01001861 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01001862
1863 p = dir_name + len;
1864 if (after_pathsep(dir_name, p) && len > 1 && p[-1] == p[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 {
1866 /* Ends with '//', Use Full path for swap name */
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001867 tail = make_percent_swname(dir_name, fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 }
1869 else
1870#endif
1871 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001872 tail = gettail(fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 tail = concat_fnames(dir_name, tail, TRUE);
1874 }
1875 if (tail == NULL)
1876 num_names = 0;
1877 else
1878 {
1879 num_names = recov_file_names(names, tail, FALSE);
1880 vim_free(tail);
1881 }
1882 }
1883 }
1884
1885 /* check for out-of-memory */
1886 for (i = 0; i < num_names; ++i)
1887 {
1888 if (names[i] == NULL)
1889 {
1890 for (i = 0; i < num_names; ++i)
1891 vim_free(names[i]);
1892 num_names = 0;
1893 }
1894 }
1895 if (num_names == 0)
1896 num_files = 0;
1897 else if (expand_wildcards(num_names, names, &num_files, &files,
1898 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1899 num_files = 0;
1900
1901 /*
1902 * When no swap file found, wildcard expansion might have failed (e.g.
1903 * not able to execute the shell).
1904 * Try finding a swap file by simply adding ".swp" to the file name.
1905 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001906 if (*dirp == NUL && file_count + num_files == 0 && fname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 {
Bram Moolenaar8767f522016-07-01 17:17:39 +02001908 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 char_u *swapname;
1910
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001911 swapname = modname(fname_res,
Bram Moolenaare60acc12011-05-10 16:41:25 +02001912#if defined(VMS)
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001913 (char_u *)"_swp", FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914#else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001915 (char_u *)".swp", TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001917 );
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 if (swapname != NULL)
1919 {
1920 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1921 {
1922 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1923 if (files != NULL)
1924 {
1925 files[0] = swapname;
1926 swapname = NULL;
1927 num_files = 1;
1928 }
1929 }
1930 vim_free(swapname);
1931 }
1932 }
1933
1934 /*
1935 * remove swapfile name of the current buffer, it must be ignored
1936 */
1937 if (curbuf->b_ml.ml_mfp != NULL
1938 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1939 {
1940 for (i = 0; i < num_files; ++i)
1941 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1942 {
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00001943 /* Remove the name from files[i]. Move further entries
1944 * down. When the array becomes empty free it here, since
1945 * FreeWild() won't be called below. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 vim_free(files[i]);
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00001947 if (--num_files == 0)
1948 vim_free(files);
1949 else
1950 for ( ; i < num_files; ++i)
1951 files[i] = files[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 }
1953 }
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001954 if (nr > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 {
1956 file_count += num_files;
1957 if (nr <= file_count)
1958 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001959 *fname_out = vim_strsave(
1960 files[nr - 1 + num_files - file_count]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 dirp = (char_u *)""; /* stop searching */
1962 }
1963 }
1964 else if (list)
1965 {
1966 if (dir_name[0] == '.' && dir_name[1] == NUL)
1967 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001968 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969 MSG_PUTS(_(" In current directory:\n"));
1970 else
1971 MSG_PUTS(_(" Using specified name:\n"));
1972 }
1973 else
1974 {
1975 MSG_PUTS(_(" In directory "));
1976 msg_home_replace(dir_name);
1977 MSG_PUTS(":\n");
1978 }
1979
1980 if (num_files)
1981 {
1982 for (i = 0; i < num_files; ++i)
1983 {
1984 /* print the swap file name */
1985 msg_outnum((long)++file_count);
1986 MSG_PUTS(". ");
1987 msg_puts(gettail(files[i]));
1988 msg_putchar('\n');
1989 (void)swapfile_info(files[i]);
1990 }
1991 }
1992 else
1993 MSG_PUTS(_(" -- none --\n"));
1994 out_flush();
1995 }
1996 else
1997 file_count += num_files;
1998
1999 for (i = 0; i < num_names; ++i)
2000 vim_free(names[i]);
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002001 if (num_files > 0)
2002 FreeWild(num_files, files);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 }
2004 vim_free(dir_name);
2005 return file_count;
2006}
2007
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002008#if defined(UNIX) || defined(WIN3264) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009/*
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002010 * Need _very_ long file names.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 * Append the full path to name with path separators made into percent
2012 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
2013 */
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002014 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002015make_percent_swname(char_u *dir, char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016{
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002017 char_u *d = NULL, *s, *f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002019 f = fix_fname(name != NULL ? name : (char_u *)"");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 if (f != NULL)
2021 {
2022 s = alloc((unsigned)(STRLEN(f) + 1));
2023 if (s != NULL)
2024 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002025 STRCPY(s, f);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002026 for (d = s; *d != NUL; MB_PTR_ADV(d))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002027 if (vim_ispathsep(*d))
2028 *d = '%';
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 d = concat_fnames(dir, s, TRUE);
2030 vim_free(s);
2031 }
2032 vim_free(f);
2033 }
2034 return d;
2035}
2036#endif
2037
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002038#if (defined(UNIX) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039static int process_still_running;
2040#endif
2041
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002042#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043/*
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002044 * Return information found in swapfile "fname" in dictionary "d".
2045 * This is used by the swapinfo() function.
2046 */
2047 void
2048get_b0_dict(char_u *fname, dict_T *d)
2049{
2050 int fd;
2051 struct block0 b0;
2052
2053 if ((fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
2054 {
2055 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
2056 {
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002057 if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002058 dict_add_string(d, "error", (char_u *)"Not a swap file");
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002059 else if (b0_magic_wrong(&b0))
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002060 dict_add_string(d, "error", (char_u *)"Magic number mismatch");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002061 else
2062 {
2063 /* we have swap information */
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002064 dict_add_string_len(d, "version", b0.b0_version, 10);
2065 dict_add_string_len(d, "user", b0.b0_uname, B0_UNAME_SIZE);
2066 dict_add_string_len(d, "host", b0.b0_hname, B0_HNAME_SIZE);
2067 dict_add_string_len(d, "fname", b0.b0_fname, B0_FNAME_SIZE_ORG);
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002068
2069 dict_add_number(d, "pid", char_to_long(b0.b0_pid));
2070 dict_add_number(d, "mtime", char_to_long(b0.b0_mtime));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002071 dict_add_number(d, "dirty", b0.b0_dirty ? 1 : 0);
2072# ifdef CHECK_INODE
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002073 dict_add_number(d, "inode", char_to_long(b0.b0_ino));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002074# endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002075 }
2076 }
2077 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002078 dict_add_string(d, "error", (char_u *)"Cannot read file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002079 close(fd);
2080 }
2081 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002082 dict_add_string(d, "error", (char_u *)"Cannot open file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002083}
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002084#endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002085
2086/*
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00002087 * Give information about an existing swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 * Returns timestamp (0 when unknown).
2089 */
2090 static time_t
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002091swapfile_info(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002093 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 int fd;
2095 struct block0 b0;
2096 time_t x = (time_t)0;
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00002097 char *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098#ifdef UNIX
2099 char_u uname[B0_UNAME_SIZE];
2100#endif
2101
2102 /* print the swap file date */
2103 if (mch_stat((char *)fname, &st) != -1)
2104 {
2105#ifdef UNIX
2106 /* print name of owner of the file */
2107 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
2108 {
2109 MSG_PUTS(_(" owned by: "));
2110 msg_outtrans(uname);
2111 MSG_PUTS(_(" dated: "));
2112 }
2113 else
2114#endif
2115 MSG_PUTS(_(" dated: "));
2116 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00002117 p = ctime(&x); /* includes '\n' */
2118 if (p == NULL)
2119 MSG_PUTS("(invalid)\n");
2120 else
2121 MSG_PUTS(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 }
2123
2124 /*
2125 * print the original file name
2126 */
2127 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2128 if (fd >= 0)
2129 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01002130 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 {
2132 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
2133 {
2134 MSG_PUTS(_(" [from Vim version 3.0]"));
2135 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002136 else if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 {
2138 MSG_PUTS(_(" [does not look like a Vim swap file]"));
2139 }
2140 else
2141 {
2142 MSG_PUTS(_(" file name: "));
2143 if (b0.b0_fname[0] == NUL)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002144 MSG_PUTS(_("[No Name]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 else
2146 msg_outtrans(b0.b0_fname);
2147
2148 MSG_PUTS(_("\n modified: "));
2149 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
2150
2151 if (*(b0.b0_uname) != NUL)
2152 {
2153 MSG_PUTS(_("\n user name: "));
2154 msg_outtrans(b0.b0_uname);
2155 }
2156
2157 if (*(b0.b0_hname) != NUL)
2158 {
2159 if (*(b0.b0_uname) != NUL)
2160 MSG_PUTS(_(" host name: "));
2161 else
2162 MSG_PUTS(_("\n host name: "));
2163 msg_outtrans(b0.b0_hname);
2164 }
2165
2166 if (char_to_long(b0.b0_pid) != 0L)
2167 {
2168 MSG_PUTS(_("\n process ID: "));
2169 msg_outnum(char_to_long(b0.b0_pid));
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002170#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 /* EMX kill() not working correctly, it seems */
2172 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
2173 {
Bram Moolenaard6105cb2018-10-13 19:06:27 +02002174 MSG_PUTS(_(" (STILL RUNNING)"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175# if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2176 process_still_running = TRUE;
2177# endif
2178 }
2179#endif
2180 }
2181
2182 if (b0_magic_wrong(&b0))
2183 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +01002184#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
2186 MSG_PUTS(_("\n [not usable with this version of Vim]"));
2187 else
2188#endif
2189 MSG_PUTS(_("\n [not usable on this computer]"));
2190 }
2191 }
2192 }
2193 else
2194 MSG_PUTS(_(" [cannot be read]"));
2195 close(fd);
2196 }
2197 else
2198 MSG_PUTS(_(" [cannot be opened]"));
2199 msg_putchar('\n');
2200
2201 return x;
2202}
2203
2204 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002205recov_file_names(char_u **names, char_u *path, int prepend_dot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206{
2207 int num_names;
2208
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 /*
2210 * (Win32 and Win64) never short names, but do prepend a dot.
2211 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
2212 * Only use the short name if it is different.
2213 */
2214 char_u *p;
2215 int i;
2216# ifndef WIN3264
2217 int shortname = curbuf->b_shortname;
2218
2219 curbuf->b_shortname = FALSE;
2220# endif
2221
2222 num_names = 0;
2223
2224 /*
2225 * May also add the file name with a dot prepended, for swap file in same
2226 * dir as original file.
2227 */
2228 if (prepend_dot)
2229 {
2230 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
2231 if (names[num_names] == NULL)
2232 goto end;
2233 ++num_names;
2234 }
2235
2236 /*
2237 * Form the normal swap file name pattern by appending ".sw?".
2238 */
2239#ifdef VMS
2240 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
2241#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243#endif
2244 if (names[num_names] == NULL)
2245 goto end;
2246 if (num_names >= 1) /* check if we have the same name twice */
2247 {
2248 p = names[num_names - 1];
2249 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
2250 if (i > 0)
2251 p += i; /* file name has been expanded to full path */
2252
2253 if (STRCMP(p, names[num_names]) != 0)
2254 ++num_names;
2255 else
2256 vim_free(names[num_names]);
2257 }
2258 else
2259 ++num_names;
2260
2261# ifndef WIN3264
2262 /*
2263 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
2264 */
2265 curbuf->b_shortname = TRUE;
2266#ifdef VMS
2267 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
2268#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270#endif
2271 if (names[num_names] == NULL)
2272 goto end;
2273
2274 /*
2275 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
2276 */
2277 p = names[num_names];
2278 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
2279 if (i > 0)
2280 p += i; /* file name has been expanded to full path */
2281 if (STRCMP(names[num_names - 1], p) == 0)
2282 vim_free(names[num_names]);
2283 else
2284 ++num_names;
2285# endif
2286
2287end:
2288# ifndef WIN3264
2289 curbuf->b_shortname = shortname;
2290# endif
2291
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 return num_names;
2293}
2294
2295/*
2296 * sync all memlines
2297 *
2298 * If 'check_file' is TRUE, check if original file exists and was not changed.
2299 * If 'check_char' is TRUE, stop syncing when character becomes available, but
2300 * always sync at least one block.
2301 */
2302 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002303ml_sync_all(int check_file, int check_char)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304{
2305 buf_T *buf;
Bram Moolenaar8767f522016-07-01 17:17:39 +02002306 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307
Bram Moolenaar29323592016-07-24 22:04:11 +02002308 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 {
2310 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
2311 continue; /* no file */
2312
2313 ml_flush_line(buf); /* flush buffered line */
2314 /* flush locked block */
2315 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
2316 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
2317 && buf->b_ffname != NULL)
2318 {
2319 /*
2320 * If the original file does not exist anymore or has been changed
2321 * call ml_preserve() to get rid of all negative numbered blocks.
2322 */
2323 if (mch_stat((char *)buf->b_ffname, &st) == -1
2324 || st.st_mtime != buf->b_mtime_read
Bram Moolenaar914703b2010-05-31 21:59:46 +02002325 || st.st_size != buf->b_orig_size)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 {
2327 ml_preserve(buf, FALSE);
2328 did_check_timestamps = FALSE;
2329 need_check_timestamps = TRUE; /* give message later */
2330 }
2331 }
2332 if (buf->b_ml.ml_mfp->mf_dirty)
2333 {
2334 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
2335 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
2336 if (check_char && ui_char_avail()) /* character available now */
2337 break;
2338 }
2339 }
2340}
2341
2342/*
2343 * sync one buffer, including negative blocks
2344 *
2345 * after this all the blocks are in the swap file
2346 *
2347 * Used for the :preserve command and when the original file has been
2348 * changed or deleted.
2349 *
2350 * when message is TRUE the success of preserving is reported
2351 */
2352 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002353ml_preserve(buf_T *buf, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354{
2355 bhdr_T *hp;
2356 linenr_T lnum;
2357 memfile_T *mfp = buf->b_ml.ml_mfp;
2358 int status;
2359 int got_int_save = got_int;
2360
2361 if (mfp == NULL || mfp->mf_fname == NULL)
2362 {
2363 if (message)
2364 EMSG(_("E313: Cannot preserve, there is no swap file"));
2365 return;
2366 }
2367
2368 /* We only want to stop when interrupted here, not when interrupted
2369 * before. */
2370 got_int = FALSE;
2371
2372 ml_flush_line(buf); /* flush buffered line */
2373 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2374 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2375
2376 /* stack is invalid after mf_sync(.., MFS_ALL) */
2377 buf->b_ml.ml_stack_top = 0;
2378
2379 /*
2380 * Some of the data blocks may have been changed from negative to
2381 * positive block number. In that case the pointer blocks need to be
2382 * updated.
2383 *
2384 * We don't know in which pointer block the references are, so we visit
2385 * all data blocks until there are no more translations to be done (or
2386 * we hit the end of the file, which can only happen in case a write fails,
2387 * e.g. when file system if full).
2388 * ml_find_line() does the work by translating the negative block numbers
2389 * when getting the first line of each data block.
2390 */
2391 if (mf_need_trans(mfp) && !got_int)
2392 {
2393 lnum = 1;
2394 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2395 {
2396 hp = ml_find_line(buf, lnum, ML_FIND);
2397 if (hp == NULL)
2398 {
2399 status = FAIL;
2400 goto theend;
2401 }
2402 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2403 lnum = buf->b_ml.ml_locked_high + 1;
2404 }
2405 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2406 /* sync the updated pointer blocks */
2407 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2408 status = FAIL;
2409 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2410 }
2411theend:
2412 got_int |= got_int_save;
2413
2414 if (message)
2415 {
2416 if (status == OK)
2417 MSG(_("File preserved"));
2418 else
2419 EMSG(_("E314: Preserve failed"));
2420 }
2421}
2422
2423/*
2424 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2425 * until the next call!
2426 * line1 = ml_get(1);
2427 * line2 = ml_get(2); // line1 is now invalid!
2428 * Make a copy of the line if necessary.
2429 */
2430/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002431 * Return a pointer to a (read-only copy of a) line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 *
2433 * On failure an error message is given and IObuff is returned (to avoid
2434 * having to check for error everywhere).
2435 */
2436 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002437ml_get(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438{
2439 return ml_get_buf(curbuf, lnum, FALSE);
2440}
2441
2442/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002443 * Return pointer to position "pos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 */
2445 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002446ml_get_pos(pos_T *pos)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447{
2448 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2449}
2450
2451/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002452 * Return pointer to cursor line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 */
2454 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002455ml_get_curline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456{
2457 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2458}
2459
2460/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002461 * Return pointer to cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 */
2463 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002464ml_get_cursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465{
2466 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2467 curwin->w_cursor.col);
2468}
2469
2470/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002471 * Return a pointer to a line in a specific buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 *
2473 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2474 * changed)
2475 */
2476 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002477ml_get_buf(
2478 buf_T *buf,
2479 linenr_T lnum,
2480 int will_change) /* line will be changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481{
Bram Moolenaarad40f022007-02-13 03:01:39 +00002482 bhdr_T *hp;
2483 DATA_BL *dp;
Bram Moolenaarad40f022007-02-13 03:01:39 +00002484 static int recursive = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485
2486 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2487 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002488 if (recursive == 0)
2489 {
2490 /* Avoid giving this message for a recursive call, may happen when
2491 * the GUI redraws part of the text. */
2492 ++recursive;
Bram Moolenaar95f09602016-11-10 20:01:45 +01002493 IEMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002494 --recursive;
2495 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496errorret:
2497 STRCPY(IObuff, "???");
2498 return IObuff;
2499 }
2500 if (lnum <= 0) /* pretend line 0 is line 1 */
2501 lnum = 1;
2502
2503 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2504 return (char_u *)"";
2505
Bram Moolenaar37d619f2010-03-10 14:46:26 +01002506 /*
2507 * See if it is the same line as requested last time.
2508 * Otherwise may need to flush last used line.
2509 * Don't use the last used line when 'swapfile' is reset, need to load all
2510 * blocks.
2511 */
Bram Moolenaar47b8b152007-02-07 02:41:57 +00002512 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002514 unsigned start, end;
2515 colnr_T len;
2516 int idx;
2517
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 ml_flush_line(buf);
2519
2520 /*
2521 * Find the data block containing the line.
2522 * This also fills the stack with the blocks from the root to the data
2523 * block and releases any locked block.
2524 */
2525 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2526 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002527 if (recursive == 0)
2528 {
2529 /* Avoid giving this message for a recursive call, may happen
2530 * when the GUI redraws part of the text. */
2531 ++recursive;
Bram Moolenaar95f09602016-11-10 20:01:45 +01002532 IEMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002533 --recursive;
2534 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 goto errorret;
2536 }
2537
2538 dp = (DATA_BL *)(hp->bh_data);
2539
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002540 idx = lnum - buf->b_ml.ml_locked_low;
2541 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2542 // The text ends where the previous line starts. The first line ends
2543 // at the end of the block.
2544 if (idx == 0)
2545 end = dp->db_txt_end;
2546 else
2547 end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
2548 len = end - start;
2549
2550 buf->b_ml.ml_line_ptr = (char_u *)dp + start;
2551 buf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 buf->b_ml.ml_line_lnum = lnum;
2553 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2554 }
2555 if (will_change)
2556 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2557
2558 return buf->b_ml.ml_line_ptr;
2559}
2560
2561/*
2562 * Check if a line that was just obtained by a call to ml_get
2563 * is in allocated memory.
2564 */
2565 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002566ml_line_alloced(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567{
2568 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2569}
2570
2571/*
2572 * Append a line after lnum (may be 0 to insert a line in front of the file).
2573 * "line" does not need to be allocated, but can't be another line in a
2574 * buffer, unlocking may make it invalid.
2575 *
2576 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2577 * will be set for recovery
2578 * Check: The caller of this function should probably also call
2579 * appended_lines().
2580 *
2581 * return FAIL for failure, OK otherwise
2582 */
2583 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002584ml_append(
2585 linenr_T lnum, /* append after this line (can be 0) */
2586 char_u *line, /* text of the new line */
2587 colnr_T len, /* length of new line, including NUL, or 0 */
2588 int newfile) /* flag, see above */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589{
2590 /* When starting up, we might still need to create the memfile */
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002591 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 return FAIL;
2593
2594 if (curbuf->b_ml.ml_line_lnum != 0)
2595 ml_flush_line(curbuf);
2596 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2597}
2598
Bram Moolenaar4033c552017-09-16 20:54:51 +02002599#if defined(FEAT_SPELL) || defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar4770d092006-01-12 23:22:24 +00002600/*
2601 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2602 * a memline.
2603 */
2604 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002605ml_append_buf(
2606 buf_T *buf,
2607 linenr_T lnum, /* append after this line (can be 0) */
2608 char_u *line, /* text of the new line */
2609 colnr_T len, /* length of new line, including NUL, or 0 */
2610 int newfile) /* flag, see above */
Bram Moolenaar4770d092006-01-12 23:22:24 +00002611{
2612 if (buf->b_ml.ml_mfp == NULL)
2613 return FAIL;
2614
2615 if (buf->b_ml.ml_line_lnum != 0)
2616 ml_flush_line(buf);
2617 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2618}
2619#endif
2620
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002622ml_append_int(
2623 buf_T *buf,
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002624 linenr_T lnum, // append after this line (can be 0)
2625 char_u *line, // text of the new line
2626 colnr_T len_arg, // length of line, including NUL, or 0
2627 int newfile, // flag, see above
2628 int mark) // mark the new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629{
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002630 colnr_T len = len_arg; // length of line, including NUL, or 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 int i;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002632 int line_count; // number of indexes in current block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 int offset;
2634 int from, to;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002635 int space_needed; // space needed for new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 int page_size;
2637 int page_count;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002638 int db_idx; // index for lnum in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 bhdr_T *hp;
2640 memfile_T *mfp;
2641 DATA_BL *dp;
2642 PTR_BL *pp;
2643 infoptr_T *ip;
2644
2645 /* lnum out of range */
2646 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2647 return FAIL;
2648
2649 if (lowest_marked && lowest_marked > lnum)
2650 lowest_marked = lnum + 1;
2651
2652 if (len == 0)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002653 len = (colnr_T)STRLEN(line) + 1; // space needed for the text
2654 space_needed = len + INDEX_SIZE; // space needed for text + index
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655
2656 mfp = buf->b_ml.ml_mfp;
2657 page_size = mfp->mf_page_size;
2658
2659/*
2660 * find the data block containing the previous line
2661 * This also fills the stack with the blocks from the root to the data block
2662 * This also releases any locked block.
2663 */
2664 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2665 ML_INSERT)) == NULL)
2666 return FAIL;
2667
2668 buf->b_ml.ml_flags &= ~ML_EMPTY;
2669
2670 if (lnum == 0) /* got line one instead, correct db_idx */
2671 db_idx = -1; /* careful, it is negative! */
2672 else
2673 db_idx = lnum - buf->b_ml.ml_locked_low;
2674 /* get line count before the insertion */
2675 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2676
2677 dp = (DATA_BL *)(hp->bh_data);
2678
2679/*
2680 * If
2681 * - there is not enough room in the current block
2682 * - appending to the last line in the block
2683 * - not appending to the last line in the file
2684 * insert in front of the next block.
2685 */
2686 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2687 && lnum < buf->b_ml.ml_line_count)
2688 {
2689 /*
2690 * Now that the line is not going to be inserted in the block that we
2691 * expected, the line count has to be adjusted in the pointer blocks
2692 * by using ml_locked_lineadd.
2693 */
2694 --(buf->b_ml.ml_locked_lineadd);
2695 --(buf->b_ml.ml_locked_high);
2696 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2697 return FAIL;
2698
2699 db_idx = -1; /* careful, it is negative! */
2700 /* get line count before the insertion */
2701 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2702 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2703
2704 dp = (DATA_BL *)(hp->bh_data);
2705 }
2706
2707 ++buf->b_ml.ml_line_count;
2708
2709 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2710 {
2711/*
2712 * Insert new line in existing data block, or in data block allocated above.
2713 */
2714 dp->db_txt_start -= len;
2715 dp->db_free -= space_needed;
2716 ++(dp->db_line_count);
2717
2718 /*
2719 * move the text of the lines that follow to the front
2720 * adjust the indexes of the lines that follow
2721 */
2722 if (line_count > db_idx + 1) /* if there are following lines */
2723 {
2724 /*
2725 * Offset is the start of the previous line.
2726 * This will become the character just after the new line.
2727 */
2728 if (db_idx < 0)
2729 offset = dp->db_txt_end;
2730 else
2731 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2732 mch_memmove((char *)dp + dp->db_txt_start,
2733 (char *)dp + dp->db_txt_start + len,
2734 (size_t)(offset - (dp->db_txt_start + len)));
2735 for (i = line_count - 1; i > db_idx; --i)
2736 dp->db_index[i + 1] = dp->db_index[i] - len;
2737 dp->db_index[db_idx + 1] = offset - len;
2738 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002739 else
2740 // add line at the end (which is the start of the text)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 dp->db_index[db_idx + 1] = dp->db_txt_start;
2742
2743 /*
2744 * copy the text into the block
2745 */
2746 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2747 if (mark)
2748 dp->db_index[db_idx + 1] |= DB_MARKED;
2749
2750 /*
2751 * Mark the block dirty.
2752 */
2753 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2754 if (!newfile)
2755 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2756 }
2757 else /* not enough space in data block */
2758 {
2759/*
2760 * If there is not enough room we have to create a new data block and copy some
2761 * lines into it.
2762 * Then we have to insert an entry in the pointer block.
2763 * If this pointer block also is full, we go up another block, and so on, up
2764 * to the root if necessary.
2765 * The line counts in the pointer blocks have already been adjusted by
2766 * ml_find_line().
2767 */
2768 long line_count_left, line_count_right;
2769 int page_count_left, page_count_right;
2770 bhdr_T *hp_left;
2771 bhdr_T *hp_right;
2772 bhdr_T *hp_new;
2773 int lines_moved;
2774 int data_moved = 0; /* init to shut up gcc */
2775 int total_moved = 0; /* init to shut up gcc */
2776 DATA_BL *dp_right, *dp_left;
2777 int stack_idx;
2778 int in_left;
2779 int lineadd;
2780 blocknr_T bnum_left, bnum_right;
2781 linenr_T lnum_left, lnum_right;
2782 int pb_idx;
2783 PTR_BL *pp_new;
2784
2785 /*
2786 * We are going to allocate a new data block. Depending on the
2787 * situation it will be put to the left or right of the existing
2788 * block. If possible we put the new line in the left block and move
2789 * the lines after it to the right block. Otherwise the new line is
2790 * also put in the right block. This method is more efficient when
2791 * inserting a lot of lines at one place.
2792 */
2793 if (db_idx < 0) /* left block is new, right block is existing */
2794 {
2795 lines_moved = 0;
2796 in_left = TRUE;
2797 /* space_needed does not change */
2798 }
2799 else /* left block is existing, right block is new */
2800 {
2801 lines_moved = line_count - db_idx - 1;
2802 if (lines_moved == 0)
2803 in_left = FALSE; /* put new line in right block */
2804 /* space_needed does not change */
2805 else
2806 {
2807 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2808 dp->db_txt_start;
2809 total_moved = data_moved + lines_moved * INDEX_SIZE;
2810 if ((int)dp->db_free + total_moved >= space_needed)
2811 {
2812 in_left = TRUE; /* put new line in left block */
2813 space_needed = total_moved;
2814 }
2815 else
2816 {
2817 in_left = FALSE; /* put new line in right block */
2818 space_needed += total_moved;
2819 }
2820 }
2821 }
2822
2823 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2824 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2825 {
2826 /* correct line counts in pointer blocks */
2827 --(buf->b_ml.ml_locked_lineadd);
2828 --(buf->b_ml.ml_locked_high);
2829 return FAIL;
2830 }
2831 if (db_idx < 0) /* left block is new */
2832 {
2833 hp_left = hp_new;
2834 hp_right = hp;
2835 line_count_left = 0;
2836 line_count_right = line_count;
2837 }
2838 else /* right block is new */
2839 {
2840 hp_left = hp;
2841 hp_right = hp_new;
2842 line_count_left = line_count;
2843 line_count_right = 0;
2844 }
2845 dp_right = (DATA_BL *)(hp_right->bh_data);
2846 dp_left = (DATA_BL *)(hp_left->bh_data);
2847 bnum_left = hp_left->bh_bnum;
2848 bnum_right = hp_right->bh_bnum;
2849 page_count_left = hp_left->bh_page_count;
2850 page_count_right = hp_right->bh_page_count;
2851
2852 /*
2853 * May move the new line into the right/new block.
2854 */
2855 if (!in_left)
2856 {
2857 dp_right->db_txt_start -= len;
2858 dp_right->db_free -= len + INDEX_SIZE;
2859 dp_right->db_index[0] = dp_right->db_txt_start;
2860 if (mark)
2861 dp_right->db_index[0] |= DB_MARKED;
2862
2863 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2864 line, (size_t)len);
2865 ++line_count_right;
2866 }
2867 /*
2868 * may move lines from the left/old block to the right/new one.
2869 */
2870 if (lines_moved)
2871 {
2872 /*
2873 */
2874 dp_right->db_txt_start -= data_moved;
2875 dp_right->db_free -= total_moved;
2876 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2877 (char *)dp_left + dp_left->db_txt_start,
2878 (size_t)data_moved);
2879 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2880 dp_left->db_txt_start += data_moved;
2881 dp_left->db_free += total_moved;
2882
2883 /*
2884 * update indexes in the new block
2885 */
2886 for (to = line_count_right, from = db_idx + 1;
2887 from < line_count_left; ++from, ++to)
2888 dp_right->db_index[to] = dp->db_index[from] + offset;
2889 line_count_right += lines_moved;
2890 line_count_left -= lines_moved;
2891 }
2892
2893 /*
2894 * May move the new line into the left (old or new) block.
2895 */
2896 if (in_left)
2897 {
2898 dp_left->db_txt_start -= len;
2899 dp_left->db_free -= len + INDEX_SIZE;
2900 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2901 if (mark)
2902 dp_left->db_index[line_count_left] |= DB_MARKED;
2903 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2904 line, (size_t)len);
2905 ++line_count_left;
2906 }
2907
2908 if (db_idx < 0) /* left block is new */
2909 {
2910 lnum_left = lnum + 1;
2911 lnum_right = 0;
2912 }
2913 else /* right block is new */
2914 {
2915 lnum_left = 0;
2916 if (in_left)
2917 lnum_right = lnum + 2;
2918 else
2919 lnum_right = lnum + 1;
2920 }
2921 dp_left->db_line_count = line_count_left;
2922 dp_right->db_line_count = line_count_right;
2923
2924 /*
2925 * release the two data blocks
2926 * The new one (hp_new) already has a correct blocknumber.
2927 * The old one (hp, in ml_locked) gets a positive blocknumber if
2928 * we changed it and we are not editing a new file.
2929 */
2930 if (lines_moved || in_left)
2931 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2932 if (!newfile && db_idx >= 0 && in_left)
2933 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2934 mf_put(mfp, hp_new, TRUE, FALSE);
2935
2936 /*
2937 * flush the old data block
2938 * set ml_locked_lineadd to 0, because the updating of the
2939 * pointer blocks is done below
2940 */
2941 lineadd = buf->b_ml.ml_locked_lineadd;
2942 buf->b_ml.ml_locked_lineadd = 0;
2943 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2944
2945 /*
2946 * update pointer blocks for the new data block
2947 */
2948 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2949 --stack_idx)
2950 {
2951 ip = &(buf->b_ml.ml_stack[stack_idx]);
2952 pb_idx = ip->ip_index;
2953 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2954 return FAIL;
2955 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2956 if (pp->pb_id != PTR_ID)
2957 {
Bram Moolenaar95f09602016-11-10 20:01:45 +01002958 IEMSG(_("E317: pointer block id wrong 3"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 mf_put(mfp, hp, FALSE, FALSE);
2960 return FAIL;
2961 }
2962 /*
2963 * TODO: If the pointer block is full and we are adding at the end
2964 * try to insert in front of the next block
2965 */
2966 /* block not full, add one entry */
2967 if (pp->pb_count < pp->pb_count_max)
2968 {
2969 if (pb_idx + 1 < (int)pp->pb_count)
2970 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2971 &pp->pb_pointer[pb_idx + 1],
2972 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2973 ++pp->pb_count;
2974 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2975 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2976 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2977 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2978 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2979 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2980
2981 if (lnum_left != 0)
2982 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2983 if (lnum_right != 0)
2984 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2985
2986 mf_put(mfp, hp, TRUE, FALSE);
2987 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2988
2989 if (lineadd)
2990 {
2991 --(buf->b_ml.ml_stack_top);
Bram Moolenaar6b803a72007-05-06 14:25:46 +00002992 /* fix line count for rest of blocks in the stack */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 ml_lineadd(buf, lineadd);
2994 /* fix stack itself */
2995 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2996 lineadd;
2997 ++(buf->b_ml.ml_stack_top);
2998 }
2999
3000 /*
3001 * We are finished, break the loop here.
3002 */
3003 break;
3004 }
3005 else /* pointer block full */
3006 {
3007 /*
3008 * split the pointer block
3009 * allocate a new pointer block
3010 * move some of the pointer into the new block
3011 * prepare for updating the parent block
3012 */
3013 for (;;) /* do this twice when splitting block 1 */
3014 {
3015 hp_new = ml_new_ptr(mfp);
3016 if (hp_new == NULL) /* TODO: try to fix tree */
3017 return FAIL;
3018 pp_new = (PTR_BL *)(hp_new->bh_data);
3019
3020 if (hp->bh_bnum != 1)
3021 break;
3022
3023 /*
3024 * if block 1 becomes full the tree is given an extra level
3025 * The pointers from block 1 are moved into the new block.
3026 * block 1 is updated to point to the new block
3027 * then continue to split the new block
3028 */
3029 mch_memmove(pp_new, pp, (size_t)page_size);
3030 pp->pb_count = 1;
3031 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
3032 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
3033 pp->pb_pointer[0].pe_old_lnum = 1;
3034 pp->pb_pointer[0].pe_page_count = 1;
3035 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
3036 hp = hp_new; /* new block is to be split */
3037 pp = pp_new;
3038 CHECK(stack_idx != 0, _("stack_idx should be 0"));
3039 ip->ip_index = 0;
3040 ++stack_idx; /* do block 1 again later */
3041 }
3042 /*
3043 * move the pointers after the current one to the new block
3044 * If there are none, the new entry will be in the new block.
3045 */
3046 total_moved = pp->pb_count - pb_idx - 1;
3047 if (total_moved)
3048 {
3049 mch_memmove(&pp_new->pb_pointer[0],
3050 &pp->pb_pointer[pb_idx + 1],
3051 (size_t)(total_moved) * sizeof(PTR_EN));
3052 pp_new->pb_count = total_moved;
3053 pp->pb_count -= total_moved - 1;
3054 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3055 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3056 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3057 if (lnum_right)
3058 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3059 }
3060 else
3061 {
3062 pp_new->pb_count = 1;
3063 pp_new->pb_pointer[0].pe_bnum = bnum_right;
3064 pp_new->pb_pointer[0].pe_line_count = line_count_right;
3065 pp_new->pb_pointer[0].pe_page_count = page_count_right;
3066 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
3067 }
3068 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3069 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3070 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3071 if (lnum_left)
3072 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3073 lnum_left = 0;
3074 lnum_right = 0;
3075
3076 /*
3077 * recompute line counts
3078 */
3079 line_count_right = 0;
3080 for (i = 0; i < (int)pp_new->pb_count; ++i)
3081 line_count_right += pp_new->pb_pointer[i].pe_line_count;
3082 line_count_left = 0;
3083 for (i = 0; i < (int)pp->pb_count; ++i)
3084 line_count_left += pp->pb_pointer[i].pe_line_count;
3085
3086 bnum_left = hp->bh_bnum;
3087 bnum_right = hp_new->bh_bnum;
3088 page_count_left = 1;
3089 page_count_right = 1;
3090 mf_put(mfp, hp, TRUE, FALSE);
3091 mf_put(mfp, hp_new, TRUE, FALSE);
3092 }
3093 }
3094
3095 /*
3096 * Safety check: fallen out of for loop?
3097 */
3098 if (stack_idx < 0)
3099 {
Bram Moolenaar95f09602016-11-10 20:01:45 +01003100 IEMSG(_("E318: Updated too many blocks?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
3102 }
3103 }
3104
3105#ifdef FEAT_BYTEOFF
3106 /* The line was inserted below 'lnum' */
3107 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
3108#endif
3109#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003110 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 {
3112 if (STRLEN(line) > 0)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003113 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003114 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 (char_u *)"\n", 1);
3116 }
3117#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01003118#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003119 if (buf->b_write_to_channel)
3120 channel_write_new_lines(buf);
3121#endif
3122
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 return OK;
3124}
3125
3126/*
Bram Moolenaar4770d092006-01-12 23:22:24 +00003127 * Replace line lnum, with buffering, in current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 *
Bram Moolenaar1056d982006-03-09 22:37:52 +00003129 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 * copied to allocated memory already.
3131 *
3132 * Check: The caller of this function should probably also call
3133 * changed_lines(), unless update_screen(NOT_VALID) is used.
3134 *
3135 * return FAIL for failure, OK otherwise
3136 */
3137 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003138ml_replace(linenr_T lnum, char_u *line, int copy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139{
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003140 colnr_T len = -1;
3141
3142 if (line != NULL)
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003143 len = (colnr_T)STRLEN(line);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003144 return ml_replace_len(lnum, line, len, copy);
3145}
3146
3147 int
3148ml_replace_len(linenr_T lnum, char_u *line_arg, colnr_T len_arg, int copy)
3149{
3150 char_u *line = line_arg;
3151 colnr_T len = len_arg;
3152
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 if (line == NULL) /* just checking... */
3154 return FAIL;
3155
3156 /* When starting up, we might still need to create the memfile */
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003157 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 return FAIL;
3159
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003160 if (copy && (line = vim_strnsave(line, len)) == NULL) /* allocate memory */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 return FAIL;
3162#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003163 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 {
3165 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003166 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 }
3168#endif
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003169 if (curbuf->b_ml.ml_line_lnum != lnum)
3170 {
3171 // another line is buffered, flush it
3172 ml_flush_line(curbuf);
Bram Moolenaarca79a5f2018-12-13 23:16:36 +01003173 curbuf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003174
3175#ifdef FEAT_TEXT_PROP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01003176 if (curbuf->b_has_textprop)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003177 // Need to fetch the old line to copy over any text properties.
3178 ml_get_buf(curbuf, lnum, TRUE);
3179#endif
3180 }
3181
3182#ifdef FEAT_TEXT_PROP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01003183 if (curbuf->b_has_textprop)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003184 {
3185 size_t oldtextlen = STRLEN(curbuf->b_ml.ml_line_ptr) + 1;
3186
3187 if (oldtextlen < (size_t)curbuf->b_ml.ml_line_len)
3188 {
3189 char_u *newline;
3190 size_t textproplen = curbuf->b_ml.ml_line_len - oldtextlen;
3191
3192 // Need to copy over text properties, stored after the text.
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003193 newline = alloc(len + 1 + (int)textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003194 if (newline != NULL)
3195 {
3196 mch_memmove(newline, line, len + 1);
3197 mch_memmove(newline + len + 1, curbuf->b_ml.ml_line_ptr + oldtextlen, textproplen);
3198 vim_free(line);
3199 line = newline;
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003200 len += (colnr_T)textproplen;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003201 }
3202 }
3203 }
3204#endif
3205
3206 if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003208
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 curbuf->b_ml.ml_line_ptr = line;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003210 curbuf->b_ml.ml_line_len = len + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 curbuf->b_ml.ml_line_lnum = lnum;
3212 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
3213
3214 return OK;
3215}
3216
3217/*
Bram Moolenaar4033c552017-09-16 20:54:51 +02003218 * Delete line "lnum" in the current buffer.
3219 * When "message" is TRUE may give a "No lines in buffer" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 *
3221 * Check: The caller of this function should probably also call
3222 * deleted_lines() after this.
3223 *
3224 * return FAIL for failure, OK otherwise
3225 */
3226 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003227ml_delete(linenr_T lnum, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228{
3229 ml_flush_line(curbuf);
3230 return ml_delete_int(curbuf, lnum, message);
3231}
3232
3233 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003234ml_delete_int(buf_T *buf, linenr_T lnum, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235{
3236 bhdr_T *hp;
3237 memfile_T *mfp;
3238 DATA_BL *dp;
3239 PTR_BL *pp;
3240 infoptr_T *ip;
3241 int count; /* number of entries in block */
3242 int idx;
3243 int stack_idx;
3244 int text_start;
3245 int line_start;
3246 long line_size;
3247 int i;
3248
3249 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
3250 return FAIL;
3251
3252 if (lowest_marked && lowest_marked > lnum)
3253 lowest_marked--;
3254
3255/*
3256 * If the file becomes empty the last line is replaced by an empty line.
3257 */
3258 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
3259 {
3260 if (message
3261#ifdef FEAT_NETBEANS_INTG
3262 && !netbeansSuppressNoLines
3263#endif
3264 )
Bram Moolenaar238a5642006-02-21 22:12:05 +00003265 set_keep_msg((char_u *)_(no_lines_msg), 0);
3266
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02003267 /* FEAT_BYTEOFF already handled in there, don't worry 'bout it below */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
3269 buf->b_ml.ml_flags |= ML_EMPTY;
3270
3271 return i;
3272 }
3273
3274/*
3275 * find the data block containing the line
3276 * This also fills the stack with the blocks from the root to the data block
3277 * This also releases any locked block.
3278 */
3279 mfp = buf->b_ml.ml_mfp;
3280 if (mfp == NULL)
3281 return FAIL;
3282
3283 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
3284 return FAIL;
3285
3286 dp = (DATA_BL *)(hp->bh_data);
3287 /* compute line count before the delete */
3288 count = (long)(buf->b_ml.ml_locked_high)
3289 - (long)(buf->b_ml.ml_locked_low) + 2;
3290 idx = lnum - buf->b_ml.ml_locked_low;
3291
3292 --buf->b_ml.ml_line_count;
3293
3294 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3295 if (idx == 0) /* first line in block, text at the end */
3296 line_size = dp->db_txt_end - line_start;
3297 else
3298 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
3299
3300#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003301 if (netbeans_active())
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003302 netbeans_removed(buf, lnum, 0, (long)line_size);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303#endif
3304
3305/*
3306 * special case: If there is only one line in the data block it becomes empty.
3307 * Then we have to remove the entry, pointing to this data block, from the
3308 * pointer block. If this pointer block also becomes empty, we go up another
3309 * block, and so on, up to the root if necessary.
3310 * The line counts in the pointer blocks have already been adjusted by
3311 * ml_find_line().
3312 */
3313 if (count == 1)
3314 {
3315 mf_free(mfp, hp); /* free the data block */
3316 buf->b_ml.ml_locked = NULL;
3317
Bram Moolenaare60acc12011-05-10 16:41:25 +02003318 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3319 --stack_idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 {
3321 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
3322 ip = &(buf->b_ml.ml_stack[stack_idx]);
3323 idx = ip->ip_index;
3324 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3325 return FAIL;
3326 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3327 if (pp->pb_id != PTR_ID)
3328 {
Bram Moolenaar95f09602016-11-10 20:01:45 +01003329 IEMSG(_("E317: pointer block id wrong 4"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 mf_put(mfp, hp, FALSE, FALSE);
3331 return FAIL;
3332 }
3333 count = --(pp->pb_count);
3334 if (count == 0) /* the pointer block becomes empty! */
3335 mf_free(mfp, hp);
3336 else
3337 {
3338 if (count != idx) /* move entries after the deleted one */
3339 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
3340 (size_t)(count - idx) * sizeof(PTR_EN));
3341 mf_put(mfp, hp, TRUE, FALSE);
3342
3343 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003344 /* fix line count for rest of blocks in the stack */
3345 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 {
3347 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3348 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003349 buf->b_ml.ml_locked_lineadd;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 }
3351 ++(buf->b_ml.ml_stack_top);
3352
3353 break;
3354 }
3355 }
3356 CHECK(stack_idx < 0, _("deleted block 1?"));
3357 }
3358 else
3359 {
3360 /*
3361 * delete the text by moving the next lines forwards
3362 */
3363 text_start = dp->db_txt_start;
3364 mch_memmove((char *)dp + text_start + line_size,
3365 (char *)dp + text_start, (size_t)(line_start - text_start));
3366
3367 /*
3368 * delete the index by moving the next indexes backwards
3369 * Adjust the indexes for the text movement.
3370 */
3371 for (i = idx; i < count - 1; ++i)
3372 dp->db_index[i] = dp->db_index[i + 1] + line_size;
3373
3374 dp->db_free += line_size + INDEX_SIZE;
3375 dp->db_txt_start += line_size;
3376 --(dp->db_line_count);
3377
3378 /*
3379 * mark the block dirty and make sure it is in the file (for recovery)
3380 */
3381 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3382 }
3383
3384#ifdef FEAT_BYTEOFF
3385 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
3386#endif
3387 return OK;
3388}
3389
3390/*
3391 * set the B_MARKED flag for line 'lnum'
3392 */
3393 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003394ml_setmarked(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395{
3396 bhdr_T *hp;
3397 DATA_BL *dp;
3398 /* invalid line number */
3399 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3400 || curbuf->b_ml.ml_mfp == NULL)
3401 return; /* give error message? */
3402
3403 if (lowest_marked == 0 || lowest_marked > lnum)
3404 lowest_marked = lnum;
3405
3406 /*
3407 * find the data block containing the line
3408 * This also fills the stack with the blocks from the root to the data block
3409 * This also releases any locked block.
3410 */
3411 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3412 return; /* give error message? */
3413
3414 dp = (DATA_BL *)(hp->bh_data);
3415 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
3416 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3417}
3418
3419/*
3420 * find the first line with its B_MARKED flag set
3421 */
3422 linenr_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003423ml_firstmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424{
3425 bhdr_T *hp;
3426 DATA_BL *dp;
3427 linenr_T lnum;
3428 int i;
3429
3430 if (curbuf->b_ml.ml_mfp == NULL)
3431 return (linenr_T) 0;
3432
3433 /*
3434 * The search starts with lowest_marked line. This is the last line where
3435 * a mark was found, adjusted by inserting/deleting lines.
3436 */
3437 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3438 {
3439 /*
3440 * Find the data block containing the line.
3441 * This also fills the stack with the blocks from the root to the data
3442 * block This also releases any locked block.
3443 */
3444 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3445 return (linenr_T)0; /* give error message? */
3446
3447 dp = (DATA_BL *)(hp->bh_data);
3448
3449 for (i = lnum - curbuf->b_ml.ml_locked_low;
3450 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3451 if ((dp->db_index[i]) & DB_MARKED)
3452 {
3453 (dp->db_index[i]) &= DB_INDEX_MASK;
3454 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3455 lowest_marked = lnum + 1;
3456 return lnum;
3457 }
3458 }
3459
3460 return (linenr_T) 0;
3461}
3462
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463/*
3464 * clear all DB_MARKED flags
3465 */
3466 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003467ml_clearmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468{
3469 bhdr_T *hp;
3470 DATA_BL *dp;
3471 linenr_T lnum;
3472 int i;
3473
3474 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3475 return;
3476
3477 /*
3478 * The search starts with line lowest_marked.
3479 */
3480 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3481 {
3482 /*
3483 * Find the data block containing the line.
3484 * This also fills the stack with the blocks from the root to the data
3485 * block and releases any locked block.
3486 */
3487 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3488 return; /* give error message? */
3489
3490 dp = (DATA_BL *)(hp->bh_data);
3491
3492 for (i = lnum - curbuf->b_ml.ml_locked_low;
3493 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3494 if ((dp->db_index[i]) & DB_MARKED)
3495 {
3496 (dp->db_index[i]) &= DB_INDEX_MASK;
3497 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3498 }
3499 }
3500
3501 lowest_marked = 0;
3502 return;
3503}
3504
3505/*
3506 * flush ml_line if necessary
3507 */
3508 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003509ml_flush_line(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510{
3511 bhdr_T *hp;
3512 DATA_BL *dp;
3513 linenr_T lnum;
3514 char_u *new_line;
3515 char_u *old_line;
3516 colnr_T new_len;
3517 int old_len;
3518 int extra;
3519 int idx;
3520 int start;
3521 int count;
3522 int i;
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003523 static int entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524
3525 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3526 return; /* nothing to do */
3527
3528 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3529 {
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003530 /* This code doesn't work recursively, but Netbeans may call back here
3531 * when obtaining the cursor position. */
3532 if (entered)
3533 return;
3534 entered = TRUE;
3535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 lnum = buf->b_ml.ml_line_lnum;
3537 new_line = buf->b_ml.ml_line_ptr;
3538
3539 hp = ml_find_line(buf, lnum, ML_FIND);
3540 if (hp == NULL)
Bram Moolenaar95f09602016-11-10 20:01:45 +01003541 IEMSGN(_("E320: Cannot find line %ld"), lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 else
3543 {
3544 dp = (DATA_BL *)(hp->bh_data);
3545 idx = lnum - buf->b_ml.ml_locked_low;
3546 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3547 old_line = (char_u *)dp + start;
3548 if (idx == 0) /* line is last in block */
3549 old_len = dp->db_txt_end - start;
3550 else /* text of previous line follows */
3551 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003552 new_len = buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 extra = new_len - old_len; /* negative if lines gets smaller */
3554
3555 /*
3556 * if new line fits in data block, replace directly
3557 */
3558 if ((int)dp->db_free >= extra)
3559 {
3560 /* if the length changes and there are following lines */
3561 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3562 if (extra != 0 && idx < count - 1)
3563 {
3564 /* move text of following lines */
3565 mch_memmove((char *)dp + dp->db_txt_start - extra,
3566 (char *)dp + dp->db_txt_start,
3567 (size_t)(start - dp->db_txt_start));
3568
3569 /* adjust pointers of this and following lines */
3570 for (i = idx + 1; i < count; ++i)
3571 dp->db_index[i] -= extra;
3572 }
3573 dp->db_index[idx] -= extra;
3574
3575 /* adjust free space */
3576 dp->db_free -= extra;
3577 dp->db_txt_start -= extra;
3578
3579 /* copy new line into the data block */
3580 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3581 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3582#ifdef FEAT_BYTEOFF
3583 /* The else case is already covered by the insert and delete */
3584 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3585#endif
3586 }
3587 else
3588 {
3589 /*
3590 * Cannot do it in one data block: Delete and append.
3591 * Append first, because ml_delete_int() cannot delete the
3592 * last line in a buffer, which causes trouble for a buffer
3593 * that has only one line.
3594 * Don't forget to copy the mark!
3595 */
3596 /* How about handling errors??? */
3597 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3598 (dp->db_index[idx] & DB_MARKED));
3599 (void)ml_delete_int(buf, lnum, FALSE);
3600 }
3601 }
3602 vim_free(new_line);
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003603
3604 entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 }
3606
3607 buf->b_ml.ml_line_lnum = 0;
3608}
3609
3610/*
3611 * create a new, empty, data block
3612 */
3613 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003614ml_new_data(memfile_T *mfp, int negative, int page_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615{
3616 bhdr_T *hp;
3617 DATA_BL *dp;
3618
3619 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3620 return NULL;
3621
3622 dp = (DATA_BL *)(hp->bh_data);
3623 dp->db_id = DATA_ID;
3624 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3625 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3626 dp->db_line_count = 0;
3627
3628 return hp;
3629}
3630
3631/*
3632 * create a new, empty, pointer block
3633 */
3634 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003635ml_new_ptr(memfile_T *mfp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636{
3637 bhdr_T *hp;
3638 PTR_BL *pp;
3639
3640 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3641 return NULL;
3642
3643 pp = (PTR_BL *)(hp->bh_data);
3644 pp->pb_id = PTR_ID;
3645 pp->pb_count = 0;
Bram Moolenaar20a825a2010-05-31 21:27:30 +02003646 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL))
3647 / sizeof(PTR_EN) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648
3649 return hp;
3650}
3651
3652/*
3653 * lookup line 'lnum' in a memline
3654 *
3655 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3656 * if ML_FLUSH only flush a locked block
3657 * if ML_FIND just find the line
3658 *
3659 * If the block was found it is locked and put in ml_locked.
3660 * The stack is updated to lead to the locked block. The ip_high field in
3661 * the stack is updated to reflect the last line in the block AFTER the
3662 * insert or delete, also if the pointer block has not been updated yet. But
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003663 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 *
3665 * return: NULL for failure, pointer to block header otherwise
3666 */
3667 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003668ml_find_line(buf_T *buf, linenr_T lnum, int action)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669{
3670 DATA_BL *dp;
3671 PTR_BL *pp;
3672 infoptr_T *ip;
3673 bhdr_T *hp;
3674 memfile_T *mfp;
3675 linenr_T t;
3676 blocknr_T bnum, bnum2;
3677 int dirty;
3678 linenr_T low, high;
3679 int top;
3680 int page_count;
3681 int idx;
3682
3683 mfp = buf->b_ml.ml_mfp;
3684
3685 /*
3686 * If there is a locked block check if the wanted line is in it.
3687 * If not, flush and release the locked block.
3688 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3689 * Don't do this for ML_FLUSH, because we want to flush the locked block.
Bram Moolenaar47b8b152007-02-07 02:41:57 +00003690 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 */
3692 if (buf->b_ml.ml_locked)
3693 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00003694 if (ML_SIMPLE(action)
3695 && buf->b_ml.ml_locked_low <= lnum
3696 && buf->b_ml.ml_locked_high >= lnum
3697 && !mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00003699 /* remember to update pointer blocks and stack later */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 if (action == ML_INSERT)
3701 {
3702 ++(buf->b_ml.ml_locked_lineadd);
3703 ++(buf->b_ml.ml_locked_high);
3704 }
3705 else if (action == ML_DELETE)
3706 {
3707 --(buf->b_ml.ml_locked_lineadd);
3708 --(buf->b_ml.ml_locked_high);
3709 }
3710 return (buf->b_ml.ml_locked);
3711 }
3712
3713 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3714 buf->b_ml.ml_flags & ML_LOCKED_POS);
3715 buf->b_ml.ml_locked = NULL;
3716
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003717 /*
3718 * If lines have been added or deleted in the locked block, need to
3719 * update the line count in pointer blocks.
3720 */
3721 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3723 }
3724
3725 if (action == ML_FLUSH) /* nothing else to do */
3726 return NULL;
3727
3728 bnum = 1; /* start at the root of the tree */
3729 page_count = 1;
3730 low = 1;
3731 high = buf->b_ml.ml_line_count;
3732
3733 if (action == ML_FIND) /* first try stack entries */
3734 {
3735 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3736 {
3737 ip = &(buf->b_ml.ml_stack[top]);
3738 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3739 {
3740 bnum = ip->ip_bnum;
3741 low = ip->ip_low;
3742 high = ip->ip_high;
3743 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3744 break;
3745 }
3746 }
3747 if (top < 0)
3748 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3749 }
3750 else /* ML_DELETE or ML_INSERT */
3751 buf->b_ml.ml_stack_top = 0; /* start at the root */
3752
3753/*
3754 * search downwards in the tree until a data block is found
3755 */
3756 for (;;)
3757 {
3758 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3759 goto error_noblock;
3760
3761 /*
3762 * update high for insert/delete
3763 */
3764 if (action == ML_INSERT)
3765 ++high;
3766 else if (action == ML_DELETE)
3767 --high;
3768
3769 dp = (DATA_BL *)(hp->bh_data);
3770 if (dp->db_id == DATA_ID) /* data block */
3771 {
3772 buf->b_ml.ml_locked = hp;
3773 buf->b_ml.ml_locked_low = low;
3774 buf->b_ml.ml_locked_high = high;
3775 buf->b_ml.ml_locked_lineadd = 0;
3776 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3777 return hp;
3778 }
3779
3780 pp = (PTR_BL *)(dp); /* must be pointer block */
3781 if (pp->pb_id != PTR_ID)
3782 {
Bram Moolenaar95f09602016-11-10 20:01:45 +01003783 IEMSG(_("E317: pointer block id wrong"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 goto error_block;
3785 }
3786
3787 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3788 goto error_block;
3789 ip = &(buf->b_ml.ml_stack[top]);
3790 ip->ip_bnum = bnum;
3791 ip->ip_low = low;
3792 ip->ip_high = high;
3793 ip->ip_index = -1; /* index not known yet */
3794
3795 dirty = FALSE;
3796 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3797 {
3798 t = pp->pb_pointer[idx].pe_line_count;
3799 CHECK(t == 0, _("pe_line_count is zero"));
3800 if ((low += t) > lnum)
3801 {
3802 ip->ip_index = idx;
3803 bnum = pp->pb_pointer[idx].pe_bnum;
3804 page_count = pp->pb_pointer[idx].pe_page_count;
3805 high = low - 1;
3806 low -= t;
3807
3808 /*
3809 * a negative block number may have been changed
3810 */
3811 if (bnum < 0)
3812 {
3813 bnum2 = mf_trans_del(mfp, bnum);
3814 if (bnum != bnum2)
3815 {
3816 bnum = bnum2;
3817 pp->pb_pointer[idx].pe_bnum = bnum;
3818 dirty = TRUE;
3819 }
3820 }
3821
3822 break;
3823 }
3824 }
3825 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3826 {
3827 if (lnum > buf->b_ml.ml_line_count)
Bram Moolenaar95f09602016-11-10 20:01:45 +01003828 IEMSGN(_("E322: line number out of range: %ld past the end"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 lnum - buf->b_ml.ml_line_count);
3830
3831 else
Bram Moolenaar95f09602016-11-10 20:01:45 +01003832 IEMSGN(_("E323: line count wrong in block %ld"), bnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 goto error_block;
3834 }
3835 if (action == ML_DELETE)
3836 {
3837 pp->pb_pointer[idx].pe_line_count--;
3838 dirty = TRUE;
3839 }
3840 else if (action == ML_INSERT)
3841 {
3842 pp->pb_pointer[idx].pe_line_count++;
3843 dirty = TRUE;
3844 }
3845 mf_put(mfp, hp, dirty, FALSE);
3846 }
3847
3848error_block:
3849 mf_put(mfp, hp, FALSE, FALSE);
3850error_noblock:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02003851 /*
3852 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3853 * the incremented/decremented line counts, because there won't be a line
3854 * inserted/deleted after all.
3855 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 if (action == ML_DELETE)
3857 ml_lineadd(buf, 1);
3858 else if (action == ML_INSERT)
3859 ml_lineadd(buf, -1);
3860 buf->b_ml.ml_stack_top = 0;
3861 return NULL;
3862}
3863
3864/*
3865 * add an entry to the info pointer stack
3866 *
3867 * return -1 for failure, number of the new entry otherwise
3868 */
3869 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003870ml_add_stack(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871{
3872 int top;
3873 infoptr_T *newstack;
3874
3875 top = buf->b_ml.ml_stack_top;
3876
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02003877 /* may have to increase the stack size */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 if (top == buf->b_ml.ml_stack_size)
3879 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02003880 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881
3882 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3883 (buf->b_ml.ml_stack_size + STACK_INCR));
3884 if (newstack == NULL)
3885 return -1;
Bram Moolenaarfbd302f2015-08-08 18:23:46 +02003886 if (top > 0)
3887 mch_memmove(newstack, buf->b_ml.ml_stack,
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003888 (size_t)top * sizeof(infoptr_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 vim_free(buf->b_ml.ml_stack);
3890 buf->b_ml.ml_stack = newstack;
3891 buf->b_ml.ml_stack_size += STACK_INCR;
3892 }
3893
3894 buf->b_ml.ml_stack_top++;
3895 return top;
3896}
3897
3898/*
3899 * Update the pointer blocks on the stack for inserted/deleted lines.
3900 * The stack itself is also updated.
3901 *
3902 * When a insert/delete line action fails, the line is not inserted/deleted,
3903 * but the pointer blocks have already been updated. That is fixed here by
3904 * walking through the stack.
3905 *
3906 * Count is the number of lines added, negative if lines have been deleted.
3907 */
3908 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003909ml_lineadd(buf_T *buf, int count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910{
3911 int idx;
3912 infoptr_T *ip;
3913 PTR_BL *pp;
3914 memfile_T *mfp = buf->b_ml.ml_mfp;
3915 bhdr_T *hp;
3916
3917 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3918 {
3919 ip = &(buf->b_ml.ml_stack[idx]);
3920 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3921 break;
3922 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3923 if (pp->pb_id != PTR_ID)
3924 {
3925 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar95f09602016-11-10 20:01:45 +01003926 IEMSG(_("E317: pointer block id wrong 2"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 break;
3928 }
3929 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3930 ip->ip_high += count;
3931 mf_put(mfp, hp, TRUE, FALSE);
3932 }
3933}
3934
Bram Moolenaar55debbe2010-05-23 23:34:36 +02003935#if defined(HAVE_READLINK) || defined(PROTO)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00003936/*
3937 * Resolve a symlink in the last component of a file name.
3938 * Note that f_resolve() does it for every part of the path, we don't do that
3939 * here.
3940 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3941 * Otherwise returns FAIL.
3942 */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02003943 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003944resolve_symlink(char_u *fname, char_u *buf)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00003945{
3946 char_u tmp[MAXPATHL];
3947 int ret;
3948 int depth = 0;
3949
3950 if (fname == NULL)
3951 return FAIL;
3952
3953 /* Put the result so far in tmp[], starting with the original name. */
3954 vim_strncpy(tmp, fname, MAXPATHL - 1);
3955
3956 for (;;)
3957 {
3958 /* Limit symlink depth to 100, catch recursive loops. */
3959 if (++depth == 100)
3960 {
3961 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3962 return FAIL;
3963 }
3964
3965 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3966 if (ret <= 0)
3967 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00003968 if (errno == EINVAL || errno == ENOENT)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00003969 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00003970 /* Found non-symlink or not existing file, stop here.
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00003971 * When at the first level use the unmodified name, skip the
Bram Moolenaar900b4d72005-12-12 22:05:50 +00003972 * call to vim_FullName(). */
3973 if (depth == 1)
3974 return FAIL;
3975
3976 /* Use the resolved name in tmp[]. */
3977 break;
3978 }
3979
3980 /* There must be some error reading links, use original name. */
3981 return FAIL;
3982 }
3983 buf[ret] = NUL;
3984
3985 /*
3986 * Check whether the symlink is relative or absolute.
3987 * If it's relative, build a new path based on the directory
3988 * portion of the filename (if any) and the path the symlink
3989 * points to.
3990 */
3991 if (mch_isFullName(buf))
3992 STRCPY(tmp, buf);
3993 else
3994 {
3995 char_u *tail;
3996
3997 tail = gettail(tmp);
3998 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3999 return FAIL;
4000 STRCPY(tail, buf);
4001 }
4002 }
4003
4004 /*
4005 * Try to resolve the full name of the file so that the swapfile name will
4006 * be consistent even when opening a relative symlink from different
4007 * working directories.
4008 */
4009 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
4010}
4011#endif
4012
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013/*
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004014 * Make swap file name out of the file name and a directory name.
4015 * Returns pointer to allocated memory or NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004017 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004018makeswapname(
4019 char_u *fname,
4020 char_u *ffname UNUSED,
4021 buf_T *buf,
4022 char_u *dir_name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023{
4024 char_u *r, *s;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02004025 char_u *fname_res = fname;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004026#ifdef HAVE_READLINK
4027 char_u fname_buf[MAXPATHL];
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004028#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029
4030#if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01004031 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01004032
4033 s = dir_name + len;
4034 if (after_pathsep(dir_name, s) && len > 1 && s[-1] == s[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 { /* Ends with '//', Use Full path */
4036 r = NULL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004037 if ((s = make_percent_swname(dir_name, fname)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 {
4039 r = modname(s, (char_u *)".swp", FALSE);
4040 vim_free(s);
4041 }
4042 return r;
4043 }
4044#endif
4045
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004046#ifdef HAVE_READLINK
4047 /* Expand symlink in the file name, so that we put the swap file with the
4048 * actual file instead of with the symlink. */
4049 if (resolve_symlink(fname, fname_buf) == OK)
4050 fname_res = fname_buf;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004051#endif
4052
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 r = buf_modname(
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 (buf->b_p_sn || buf->b_shortname),
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004055 fname_res,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 (char_u *)
Bram Moolenaare60acc12011-05-10 16:41:25 +02004057#if defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 "_swp",
4059#else
4060 ".swp",
4061#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 /* Prepend a '.' to the swap file name for the current directory. */
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004063 dir_name[0] == '.' && dir_name[1] == NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 if (r == NULL) /* out of memory */
4065 return NULL;
4066
4067 s = get_file_in_dir(r, dir_name);
4068 vim_free(r);
4069 return s;
4070}
4071
4072/*
4073 * Get file name to use for swap file or backup file.
4074 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
4075 * option "dname".
4076 * - If "dname" is ".", return "fname" (swap file in dir of file).
4077 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
4078 * relative to dir of file).
4079 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
4080 * dir).
4081 *
4082 * The return value is an allocated string and can be NULL.
4083 */
4084 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004085get_file_in_dir(
4086 char_u *fname,
4087 char_u *dname) /* don't use "dirname", it is a global for Alpha */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088{
4089 char_u *t;
4090 char_u *tail;
4091 char_u *retval;
4092 int save_char;
4093
4094 tail = gettail(fname);
4095
4096 if (dname[0] == '.' && dname[1] == NUL)
4097 retval = vim_strsave(fname);
4098 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
4099 {
4100 if (tail == fname) /* no path before file name */
4101 retval = concat_fnames(dname + 2, tail, TRUE);
4102 else
4103 {
4104 save_char = *tail;
4105 *tail = NUL;
4106 t = concat_fnames(fname, dname + 2, TRUE);
4107 *tail = save_char;
4108 if (t == NULL) /* out of memory */
4109 retval = NULL;
4110 else
4111 {
4112 retval = concat_fnames(t, tail, TRUE);
4113 vim_free(t);
4114 }
4115 }
4116 }
4117 else
4118 retval = concat_fnames(dname, tail, TRUE);
4119
Bram Moolenaar69c35002013-11-04 02:54:12 +01004120#ifdef WIN3264
4121 if (retval != NULL)
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004122 for (t = gettail(retval); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004123 if (*t == ':')
4124 *t = '%';
4125#endif
4126
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 return retval;
4128}
4129
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004130/*
4131 * Print the ATTENTION message: info about an existing swap file.
4132 */
4133 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004134attention_message(
4135 buf_T *buf, /* buffer being edited */
4136 char_u *fname) /* swap file name */
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004137{
Bram Moolenaar8767f522016-07-01 17:17:39 +02004138 stat_T st;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004139 time_t x, sx;
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00004140 char *p;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004141
4142 ++no_wait_return;
4143 (void)EMSG(_("E325: ATTENTION"));
4144 MSG_PUTS(_("\nFound a swap file by the name \""));
4145 msg_home_replace(fname);
4146 MSG_PUTS("\"\n");
4147 sx = swapfile_info(fname);
4148 MSG_PUTS(_("While opening file \""));
4149 msg_outtrans(buf->b_fname);
4150 MSG_PUTS("\"\n");
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004151 if (mch_stat((char *)buf->b_fname, &st) == -1)
4152 {
4153 MSG_PUTS(_(" CANNOT BE FOUND"));
4154 }
4155 else
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004156 {
4157 MSG_PUTS(_(" dated: "));
4158 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00004159 p = ctime(&x); /* includes '\n' */
4160 if (p == NULL)
4161 MSG_PUTS("(invalid)\n");
4162 else
4163 MSG_PUTS(p);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004164 if (sx != 0 && x > sx)
4165 MSG_PUTS(_(" NEWER than swap file!\n"));
4166 }
4167 /* Some of these messages are long to allow translation to
4168 * other languages. */
Bram Moolenaard9ea9062016-02-02 12:38:02 +01004169 MSG_PUTS(_("\n(1) Another program may be editing the same file. If this is the case,\n be careful not to end up with two different instances of the same\n file when making changes. Quit, or continue with caution.\n"));
Bram Moolenaarc41fc712011-02-15 11:57:04 +01004170 MSG_PUTS(_("(2) An edit session for this file crashed.\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004171 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
4172 msg_outtrans(buf->b_fname);
4173 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
4174 MSG_PUTS(_(" If you did this already, delete the swap file \""));
4175 msg_outtrans(fname);
4176 MSG_PUTS(_("\"\n to avoid this message.\n"));
4177 cmdline_row = msg_row;
4178 --no_wait_return;
4179}
4180
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004181#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004182/*
4183 * Trigger the SwapExists autocommands.
4184 * Returns a value for equivalent to do_dialog() (see below):
4185 * 0: still need to ask for a choice
4186 * 1: open read-only
4187 * 2: edit anyway
4188 * 3: recover
4189 * 4: delete it
4190 * 5: quit
4191 * 6: abort
4192 */
4193 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004194do_swapexists(buf_T *buf, char_u *fname)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004195{
4196 set_vim_var_string(VV_SWAPNAME, fname, -1);
4197 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
4198
4199 /* Trigger SwapExists autocommands with <afile> set to the file being
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004200 * edited. Disallow changing directory here. */
4201 ++allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004202 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004203 --allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004204
4205 set_vim_var_string(VV_SWAPNAME, NULL, -1);
4206
4207 switch (*get_vim_var_str(VV_SWAPCHOICE))
4208 {
4209 case 'o': return 1;
4210 case 'e': return 2;
4211 case 'r': return 3;
4212 case 'd': return 4;
4213 case 'q': return 5;
4214 case 'a': return 6;
4215 }
4216
4217 return 0;
4218}
4219#endif
4220
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221/*
4222 * Find out what name to use for the swap file for buffer 'buf'.
4223 *
4224 * Several names are tried to find one that does not exist
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004225 * Returns the name in allocated memory or NULL.
Bram Moolenaarf541c362011-10-26 11:44:18 +02004226 * When out of memory "dirp" is set to NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 *
4228 * Note: If BASENAMELEN is not correct, you will get error messages for
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004229 * not being able to open the swap or undo file
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004230 * Note: May trigger SwapExists autocmd, pointers may change!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 */
4232 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004233findswapname(
4234 buf_T *buf,
4235 char_u **dirp, /* pointer to list of directories */
4236 char_u *old_fname) /* don't give warning for this file name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237{
4238 char_u *fname;
4239 int n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 char_u *dir_name;
4241#ifdef AMIGA
4242 BPTR fh;
4243#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 int r;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004245 char_u *buf_fname = buf->b_fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004247#if !defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248# define CREATE_DUMMY_FILE
4249 FILE *dummyfd = NULL;
4250
Bram Moolenaar69c35002013-11-04 02:54:12 +01004251# ifdef WIN3264
4252 if (buf_fname != NULL && !mch_isFullName(buf_fname)
4253 && vim_strchr(gettail(buf_fname), ':'))
4254 {
4255 char_u *t;
4256
4257 buf_fname = vim_strsave(buf_fname);
4258 if (buf_fname == NULL)
4259 buf_fname = buf->b_fname;
4260 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004261 for (t = gettail(buf_fname); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004262 if (*t == ':')
4263 *t = '%';
4264 }
4265# endif
4266
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004267 /*
4268 * If we start editing a new file, e.g. "test.doc", which resides on an
4269 * MSDOS compatible filesystem, it is possible that the file
4270 * "test.doc.swp" which we create will be exactly the same file. To avoid
4271 * this problem we temporarily create "test.doc". Don't do this when the
4272 * check below for a 8.3 file name is used.
4273 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004274 if (!(buf->b_p_sn || buf->b_shortname) && buf_fname != NULL
4275 && mch_getperm(buf_fname) < 0)
4276 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277#endif
4278
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004279 /*
4280 * Isolate a directory name from *dirp and put it in dir_name.
4281 * First allocate some memory to put the directory name in.
4282 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
Bram Moolenaarf541c362011-10-26 11:44:18 +02004284 if (dir_name == NULL)
4285 *dirp = NULL;
4286 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 (void)copy_option_part(dirp, dir_name, 31000, ",");
4288
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004289 /*
4290 * we try different names until we find one that does not exist yet
4291 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 if (dir_name == NULL) /* out of memory */
4293 fname = NULL;
4294 else
Bram Moolenaar69c35002013-11-04 02:54:12 +01004295 fname = makeswapname(buf_fname, buf->b_ffname, buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296
4297 for (;;)
4298 {
4299 if (fname == NULL) /* must be out of memory */
4300 break;
4301 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
4302 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01004303 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 break;
4305 }
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004306#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307/*
4308 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
4309 * file names. If this is the first try and the swap file name does not fit in
4310 * 8.3, detect if this is the case, set shortname and try again.
4311 */
4312 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
4313 && !(buf->b_p_sn || buf->b_shortname))
4314 {
4315 char_u *tail;
4316 char_u *fname2;
Bram Moolenaar8767f522016-07-01 17:17:39 +02004317 stat_T s1, s2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 int f1, f2;
4319 int created1 = FALSE, created2 = FALSE;
4320 int same = FALSE;
4321
4322 /*
4323 * Check if swapfile name does not fit in 8.3:
4324 * It either contains two dots, is longer than 8 chars, or starts
4325 * with a dot.
4326 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004327 tail = gettail(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 if ( vim_strchr(tail, '.') != NULL
4329 || STRLEN(tail) > (size_t)8
4330 || *gettail(fname) == '.')
4331 {
4332 fname2 = alloc(n + 2);
4333 if (fname2 != NULL)
4334 {
4335 STRCPY(fname2, fname);
4336 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
4337 * if fname == ".xx.swp", fname2 = ".xx.swpx"
4338 * if fname == "123456789.swp", fname2 = "12345678x.swp"
4339 */
4340 if (vim_strchr(tail, '.') != NULL)
4341 fname2[n - 1] = 'x';
4342 else if (*gettail(fname) == '.')
4343 {
4344 fname2[n] = 'x';
4345 fname2[n + 1] = NUL;
4346 }
4347 else
4348 fname2[n - 5] += 1;
4349 /*
4350 * may need to create the files to be able to use mch_stat()
4351 */
4352 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4353 if (f1 < 0)
4354 {
4355 f1 = mch_open_rw((char *)fname,
4356 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 created1 = TRUE;
4358 }
4359 if (f1 >= 0)
4360 {
4361 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4362 if (f2 < 0)
4363 {
4364 f2 = mch_open_rw((char *)fname2,
4365 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4366 created2 = TRUE;
4367 }
4368 if (f2 >= 0)
4369 {
4370 /*
4371 * Both files exist now. If mch_stat() returns the
4372 * same device and inode they are the same file.
4373 */
4374 if (mch_fstat(f1, &s1) != -1
4375 && mch_fstat(f2, &s2) != -1
4376 && s1.st_dev == s2.st_dev
4377 && s1.st_ino == s2.st_ino)
4378 same = TRUE;
4379 close(f2);
4380 if (created2)
4381 mch_remove(fname2);
4382 }
4383 close(f1);
4384 if (created1)
4385 mch_remove(fname);
4386 }
4387 vim_free(fname2);
4388 if (same)
4389 {
4390 buf->b_shortname = TRUE;
4391 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004392 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004393 buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 continue; /* try again with b_shortname set */
4395 }
4396 }
4397 }
4398 }
4399#endif
4400 /*
4401 * check if the swapfile already exists
4402 */
4403 if (mch_getperm(fname) < 0) /* it does not exist */
4404 {
4405#ifdef HAVE_LSTAT
Bram Moolenaar8767f522016-07-01 17:17:39 +02004406 stat_T sb;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407
4408 /*
4409 * Extra security check: When a swap file is a symbolic link, this
4410 * is most likely a symlink attack.
4411 */
4412 if (mch_lstat((char *)fname, &sb) < 0)
4413#else
4414# ifdef AMIGA
4415 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4416 /*
4417 * on the Amiga mch_getperm() will return -1 when the file exists
4418 * but is being used by another program. This happens if you edit
4419 * a file twice.
4420 */
4421 if (fh != (BPTR)NULL) /* can open file, OK */
4422 {
4423 Close(fh);
4424 mch_remove(fname);
4425 break;
4426 }
4427 if (IoErr() != ERROR_OBJECT_IN_USE
4428 && IoErr() != ERROR_OBJECT_EXISTS)
4429# endif
4430#endif
4431 break;
4432 }
4433
4434 /*
4435 * A file name equal to old_fname is OK to use.
4436 */
4437 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4438 break;
4439
4440 /*
4441 * get here when file already exists
4442 */
4443 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4444 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 /*
4446 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4447 * and file.doc are the same file. To guess if this problem is
4448 * present try if file.doc.swx exists. If it does, we set
4449 * buf->b_shortname and try file_doc.swp (dots replaced by
4450 * underscores for this file), and try again. If it doesn't we
4451 * assume that "file.doc.swp" already exists.
4452 */
4453 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4454 {
4455 fname[n - 1] = 'x';
4456 r = mch_getperm(fname); /* try "file.swx" */
4457 fname[n - 1] = 'p';
4458 if (r >= 0) /* "file.swx" seems to exist */
4459 {
4460 buf->b_shortname = TRUE;
4461 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004462 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004463 buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 continue; /* try again with '.' replaced with '_' */
4465 }
4466 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 /*
4468 * If we get here the ".swp" file really exists.
4469 * Give an error message, unless recovering, no file name, we are
4470 * viewing a help file or when the path of the file is different
4471 * (happens when all .swp files are in one directory).
4472 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004473 if (!recoverymode && buf_fname != NULL
Bram Moolenaar8fc061c2004-12-29 21:03:02 +00004474 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 {
4476 int fd;
4477 struct block0 b0;
4478 int differ = FALSE;
4479
4480 /*
4481 * Try to read block 0 from the swap file to get the original
4482 * file name (and inode number).
4483 */
4484 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4485 if (fd >= 0)
4486 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01004487 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 {
4489 /*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004490 * If the swapfile has the same directory as the
4491 * buffer don't compare the directory names, they can
4492 * have a different mountpoint.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004494 if (b0.b0_flags & B0_SAME_DIR)
4495 {
4496 if (fnamecmp(gettail(buf->b_ffname),
4497 gettail(b0.b0_fname)) != 0
4498 || !same_directory(fname, buf->b_ffname))
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004499 {
4500#ifdef CHECK_INODE
4501 /* Symlinks may point to the same file even
4502 * when the name differs, need to check the
4503 * inode too. */
4504 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4505 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4506 char_to_long(b0.b0_ino)))
4507#endif
4508 differ = TRUE;
4509 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004510 }
4511 else
4512 {
4513 /*
4514 * The name in the swap file may be
4515 * "~user/path/file". Expand it first.
4516 */
4517 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518#ifdef CHECK_INODE
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004519 if (fnamecmp_ino(buf->b_ffname, NameBuff,
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004520 char_to_long(b0.b0_ino)))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004521 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522#else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004523 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4524 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004526 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 }
4528 close(fd);
4529 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530
4531 /* give the ATTENTION message when there is an old swap file
4532 * for the current file, and the buffer was not recovered. */
4533 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4534 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4535 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004536#if defined(HAS_SWAP_EXISTS_ACTION)
4537 int choice = 0;
4538#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539#ifdef CREATE_DUMMY_FILE
4540 int did_use_dummy = FALSE;
4541
4542 /* Avoid getting a warning for the file being created
4543 * outside of Vim, it was created at the start of this
4544 * function. Delete the file now, because Vim might exit
4545 * here if the window is closed. */
4546 if (dummyfd != NULL)
4547 {
4548 fclose(dummyfd);
4549 dummyfd = NULL;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004550 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 did_use_dummy = TRUE;
4552 }
4553#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004555#if (defined(UNIX) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 process_still_running = FALSE;
4557#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004558#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004559 /*
4560 * If there is an SwapExists autocommand and we can handle
4561 * the response, trigger it. It may return 0 to ask the
4562 * user anyway.
4563 */
4564 if (swap_exists_action != SEA_NONE
Bram Moolenaar69c35002013-11-04 02:54:12 +01004565 && has_autocmd(EVENT_SWAPEXISTS, buf_fname, buf))
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004566 choice = do_swapexists(buf, fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004568 if (choice == 0)
4569#endif
4570 {
4571#ifdef FEAT_GUI
Bram Moolenaar798184c2018-10-07 20:48:39 +02004572 // If we are supposed to start the GUI but it wasn't
4573 // completely started yet, start it now. This makes
4574 // the messages displayed in the Vim window when
4575 // loading a session from the .gvimrc file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004576 if (gui.starting && !gui.in_use)
4577 gui_start();
4578#endif
Bram Moolenaar798184c2018-10-07 20:48:39 +02004579 // Show info about the existing swap file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004580 attention_message(buf, fname);
4581
Bram Moolenaar798184c2018-10-07 20:48:39 +02004582 // We don't want a 'q' typed at the more-prompt
4583 // interrupt loading a file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004584 got_int = FALSE;
Bram Moolenaar798184c2018-10-07 20:48:39 +02004585
4586 // If vimrc has "simalt ~x" we don't want it to
4587 // interfere with the prompt here.
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02004588 flush_buffers(FLUSH_TYPEAHEAD);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004589 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590
4591#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004592 if (swap_exists_action != SEA_NONE && choice == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 {
4594 char_u *name;
4595
4596 name = alloc((unsigned)(STRLEN(fname)
4597 + STRLEN(_("Swap file \""))
4598 + STRLEN(_("\" already exists!")) + 5));
4599 if (name != NULL)
4600 {
4601 STRCPY(name, _("Swap file \""));
4602 home_replace(NULL, fname, name + STRLEN(name),
4603 1000, TRUE);
4604 STRCAT(name, _("\" already exists!"));
4605 }
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004606 choice = do_dialog(VIM_WARNING,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 (char_u *)_("VIM - ATTENTION"),
4608 name == NULL
4609 ? (char_u *)_("Swap file already exists!")
4610 : name,
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004611# if defined(UNIX) || defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 process_still_running
4613 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4614# endif
Bram Moolenaard2c340a2011-01-17 20:08:11 +01004615 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL, FALSE);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004616
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004617# if defined(UNIX) || defined(VMS)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004618 if (process_still_running && choice >= 4)
4619 choice++; /* Skip missing "Delete it" button */
4620# endif
4621 vim_free(name);
4622
4623 /* pretend screen didn't scroll, need redraw anyway */
4624 msg_scrolled = 0;
4625 redraw_all_later(NOT_VALID);
4626 }
4627#endif
4628
4629#if defined(HAS_SWAP_EXISTS_ACTION)
4630 if (choice > 0)
4631 {
4632 switch (choice)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 {
4634 case 1:
4635 buf->b_p_ro = TRUE;
4636 break;
4637 case 2:
4638 break;
4639 case 3:
4640 swap_exists_action = SEA_RECOVER;
4641 break;
4642 case 4:
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004643 mch_remove(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 break;
4645 case 5:
4646 swap_exists_action = SEA_QUIT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 break;
4648 case 6:
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004649 swap_exists_action = SEA_QUIT;
4650 got_int = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 break;
4652 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653
4654 /* If the file was deleted this fname can be used. */
4655 if (mch_getperm(fname) < 0)
4656 break;
4657 }
4658 else
4659#endif
4660 {
4661 MSG_PUTS("\n");
Bram Moolenaar4770d092006-01-12 23:22:24 +00004662 if (msg_silent == 0)
4663 /* call wait_return() later */
4664 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 }
4666
4667#ifdef CREATE_DUMMY_FILE
4668 /* Going to try another name, need the dummy file again. */
4669 if (did_use_dummy)
Bram Moolenaar69c35002013-11-04 02:54:12 +01004670 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671#endif
4672 }
4673 }
4674 }
4675
4676 /*
4677 * Change the ".swp" extension to find another file that can be used.
4678 * First decrement the last char: ".swo", ".swn", etc.
4679 * If that still isn't enough decrement the last but one char: ".svz"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00004680 * Can happen when editing many "No Name" buffers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 */
4682 if (fname[n - 1] == 'a') /* ".s?a" */
4683 {
4684 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4685 {
4686 EMSG(_("E326: Too many swap files found"));
Bram Moolenaard23a8232018-02-10 18:45:26 +01004687 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 break;
4689 }
4690 --fname[n - 2]; /* ".svz", ".suz", etc. */
4691 fname[n - 1] = 'z' + 1;
4692 }
4693 --fname[n - 1]; /* ".swo", ".swn", etc. */
4694 }
4695
4696 vim_free(dir_name);
4697#ifdef CREATE_DUMMY_FILE
4698 if (dummyfd != NULL) /* file has been created temporarily */
4699 {
4700 fclose(dummyfd);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004701 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 }
4703#endif
Bram Moolenaar69c35002013-11-04 02:54:12 +01004704#ifdef WIN3264
4705 if (buf_fname != buf->b_fname)
4706 vim_free(buf_fname);
4707#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 return fname;
4709}
4710
4711 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004712b0_magic_wrong(ZERO_BL *b0p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713{
4714 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4715 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4716 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4717 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4718}
4719
4720#ifdef CHECK_INODE
4721/*
4722 * Compare current file name with file name from swap file.
4723 * Try to use inode numbers when possible.
4724 * Return non-zero when files are different.
4725 *
4726 * When comparing file names a few things have to be taken into consideration:
4727 * - When working over a network the full path of a file depends on the host.
4728 * We check the inode number if possible. It is not 100% reliable though,
4729 * because the device number cannot be used over a network.
4730 * - When a file does not exist yet (editing a new file) there is no inode
4731 * number.
4732 * - The file name in a swap file may not be valid on the current host. The
4733 * "~user" form is used whenever possible to avoid this.
4734 *
4735 * This is getting complicated, let's make a table:
4736 *
4737 * ino_c ino_s fname_c fname_s differ =
4738 *
4739 * both files exist -> compare inode numbers:
4740 * != 0 != 0 X X ino_c != ino_s
4741 *
4742 * inode number(s) unknown, file names available -> compare file names
4743 * == 0 X OK OK fname_c != fname_s
4744 * X == 0 OK OK fname_c != fname_s
4745 *
4746 * current file doesn't exist, file for swap file exist, file name(s) not
4747 * available -> probably different
4748 * == 0 != 0 FAIL X TRUE
4749 * == 0 != 0 X FAIL TRUE
4750 *
4751 * current file exists, inode for swap unknown, file name(s) not
4752 * available -> probably different
4753 * != 0 == 0 FAIL X TRUE
4754 * != 0 == 0 X FAIL TRUE
4755 *
4756 * current file doesn't exist, inode for swap unknown, one file name not
4757 * available -> probably different
4758 * == 0 == 0 FAIL OK TRUE
4759 * == 0 == 0 OK FAIL TRUE
4760 *
4761 * current file doesn't exist, inode for swap unknown, both file names not
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02004762 * available -> compare file names
4763 * == 0 == 0 FAIL FAIL fname_c != fname_s
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 *
4765 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4766 * can't be changed without making the block 0 incompatible with 32 bit
4767 * versions.
4768 */
4769
4770 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004771fnamecmp_ino(
4772 char_u *fname_c, /* current file name */
4773 char_u *fname_s, /* file name from swap file */
4774 long ino_block0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775{
Bram Moolenaar8767f522016-07-01 17:17:39 +02004776 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 ino_t ino_c = 0; /* ino of current file */
4778 ino_t ino_s; /* ino of file from swap file */
4779 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4780 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4781 int retval_c; /* flag: buf_c valid */
4782 int retval_s; /* flag: buf_s valid */
4783
4784 if (mch_stat((char *)fname_c, &st) == 0)
4785 ino_c = (ino_t)st.st_ino;
4786
4787 /*
4788 * First we try to get the inode from the file name, because the inode in
4789 * the swap file may be outdated. If that fails (e.g. this path is not
4790 * valid on this machine), use the inode from block 0.
4791 */
4792 if (mch_stat((char *)fname_s, &st) == 0)
4793 ino_s = (ino_t)st.st_ino;
4794 else
4795 ino_s = (ino_t)ino_block0;
4796
4797 if (ino_c && ino_s)
4798 return (ino_c != ino_s);
4799
4800 /*
4801 * One of the inode numbers is unknown, try a forced vim_FullName() and
4802 * compare the file names.
4803 */
4804 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4805 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4806 if (retval_c == OK && retval_s == OK)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02004807 return STRCMP(buf_c, buf_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808
4809 /*
4810 * Can't compare inodes or file names, guess that the files are different,
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02004811 * unless both appear not to exist at all, then compare with the file name
4812 * in the swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 */
4814 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02004815 return STRCMP(fname_c, fname_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 return TRUE;
4817}
4818#endif /* CHECK_INODE */
4819
4820/*
4821 * Move a long integer into a four byte character array.
4822 * Used for machine independency in block zero.
4823 */
4824 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004825long_to_char(long n, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826{
4827 s[0] = (char_u)(n & 0xff);
4828 n = (unsigned)n >> 8;
4829 s[1] = (char_u)(n & 0xff);
4830 n = (unsigned)n >> 8;
4831 s[2] = (char_u)(n & 0xff);
4832 n = (unsigned)n >> 8;
4833 s[3] = (char_u)(n & 0xff);
4834}
4835
4836 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004837char_to_long(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838{
4839 long retval;
4840
4841 retval = s[3];
4842 retval <<= 8;
4843 retval |= s[2];
4844 retval <<= 8;
4845 retval |= s[1];
4846 retval <<= 8;
4847 retval |= s[0];
4848
4849 return retval;
4850}
4851
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004852/*
4853 * Set the flags in the first block of the swap file:
4854 * - file is modified or not: buf->b_changed
4855 * - 'fileformat'
4856 * - 'fileencoding'
4857 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004859ml_setflags(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860{
4861 bhdr_T *hp;
4862 ZERO_BL *b0p;
4863
4864 if (!buf->b_ml.ml_mfp)
4865 return;
4866 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4867 {
4868 if (hp->bh_bnum == 0)
4869 {
4870 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004871 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4872 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4873 | (get_fileformat(buf) + 1);
4874#ifdef FEAT_MBYTE
4875 add_b0_fenc(b0p, buf);
4876#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 hp->bh_flags |= BH_DIRTY;
4878 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4879 break;
4880 }
4881 }
4882}
4883
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004884#if defined(FEAT_CRYPT) || defined(PROTO)
4885/*
4886 * If "data" points to a data block encrypt the text in it and return a copy
4887 * in allocated memory. Return NULL when out of memory.
4888 * Otherwise return "data".
4889 */
4890 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004891ml_encrypt_data(
4892 memfile_T *mfp,
4893 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02004894 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004895 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004896{
4897 DATA_BL *dp = (DATA_BL *)data;
4898 char_u *head_end;
4899 char_u *text_start;
4900 char_u *new_data;
4901 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004902 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004903
4904 if (dp->db_id != DATA_ID)
4905 return data;
4906
Bram Moolenaarbc563362015-06-09 18:35:25 +02004907 state = ml_crypt_prepare(mfp, offset, FALSE);
4908 if (state == NULL)
4909 return data;
4910
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004911 new_data = (char_u *)alloc(size);
4912 if (new_data == NULL)
4913 return NULL;
4914 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
4915 text_start = (char_u *)dp + dp->db_txt_start;
4916 text_len = size - dp->db_txt_start;
4917
4918 /* Copy the header and the text. */
4919 mch_memmove(new_data, dp, head_end - (char_u *)dp);
4920
4921 /* Encrypt the text. */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004922 crypt_encode(state, text_start, text_len, new_data + dp->db_txt_start);
4923 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004924
4925 /* Clear the gap. */
4926 if (head_end < text_start)
4927 vim_memset(new_data + (head_end - data), 0, text_start - head_end);
4928
4929 return new_data;
4930}
4931
4932/*
Bram Moolenaarbc563362015-06-09 18:35:25 +02004933 * Decrypt the text in "data" if it points to an encrypted data block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004934 */
4935 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004936ml_decrypt_data(
4937 memfile_T *mfp,
4938 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02004939 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004940 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004941{
4942 DATA_BL *dp = (DATA_BL *)data;
4943 char_u *head_end;
4944 char_u *text_start;
4945 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004946 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004947
4948 if (dp->db_id == DATA_ID)
4949 {
4950 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
4951 text_start = (char_u *)dp + dp->db_txt_start;
4952 text_len = dp->db_txt_end - dp->db_txt_start;
4953
4954 if (head_end > text_start || dp->db_txt_start > size
4955 || dp->db_txt_end > size)
4956 return; /* data was messed up */
4957
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004958 state = ml_crypt_prepare(mfp, offset, TRUE);
Bram Moolenaarbc563362015-06-09 18:35:25 +02004959 if (state != NULL)
4960 {
4961 /* Decrypt the text in place. */
4962 crypt_decode_inplace(state, text_start, text_len);
4963 crypt_free_state(state);
4964 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004965 }
4966}
4967
4968/*
4969 * Prepare for encryption/decryption, using the key, seed and offset.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004970 * Return an allocated cryptstate_T *.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004971 */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004972 static cryptstate_T *
Bram Moolenaar8767f522016-07-01 17:17:39 +02004973ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004974{
4975 buf_T *buf = mfp->mf_buffer;
4976 char_u salt[50];
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004977 int method_nr;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004978 char_u *key;
4979 char_u *seed;
4980
4981 if (reading && mfp->mf_old_key != NULL)
4982 {
4983 /* Reading back blocks with the previous key/method/seed. */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004984 method_nr = mfp->mf_old_cm;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004985 key = mfp->mf_old_key;
4986 seed = mfp->mf_old_seed;
4987 }
4988 else
4989 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004990 method_nr = crypt_get_method_nr(buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004991 key = buf->b_p_key;
4992 seed = mfp->mf_seed;
4993 }
Bram Moolenaarbc563362015-06-09 18:35:25 +02004994 if (*key == NUL)
4995 return NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004996
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004997 if (method_nr == CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004998 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02004999 /* For PKzip: Append the offset to the key, so that we use a different
5000 * key for every block. */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005001 vim_snprintf((char *)salt, sizeof(salt), "%s%ld", key, (long)offset);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005002 return crypt_create(method_nr, salt, NULL, 0, NULL, 0);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005003 }
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005004
5005 /* Using blowfish or better: add salt and seed. We use the byte offset
5006 * of the block for the salt. */
5007 vim_snprintf((char *)salt, sizeof(salt), "%ld", (long)offset);
5008 return crypt_create(method_nr, key, salt, (int)STRLEN(salt),
5009 seed, MF_SEED_LEN);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005010}
5011
5012#endif
5013
5014
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015#if defined(FEAT_BYTEOFF) || defined(PROTO)
5016
5017#define MLCS_MAXL 800 /* max no of lines in chunk */
5018#define MLCS_MINL 400 /* should be half of MLCS_MAXL */
5019
5020/*
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02005021 * Keep information for finding byte offset of a line, updtype may be one of:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
5023 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
5024 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
5025 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
5026 */
5027 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005028ml_updatechunk(
5029 buf_T *buf,
5030 linenr_T line,
5031 long len,
5032 int updtype)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033{
5034 static buf_T *ml_upd_lastbuf = NULL;
5035 static linenr_T ml_upd_lastline;
5036 static linenr_T ml_upd_lastcurline;
5037 static int ml_upd_lastcurix;
5038
5039 linenr_T curline = ml_upd_lastcurline;
5040 int curix = ml_upd_lastcurix;
5041 long size;
5042 chunksize_T *curchnk;
5043 int rest;
5044 bhdr_T *hp;
5045 DATA_BL *dp;
5046
5047 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
5048 return;
5049 if (buf->b_ml.ml_chunksize == NULL)
5050 {
5051 buf->b_ml.ml_chunksize = (chunksize_T *)
5052 alloc((unsigned)sizeof(chunksize_T) * 100);
5053 if (buf->b_ml.ml_chunksize == NULL)
5054 {
5055 buf->b_ml.ml_usedchunks = -1;
5056 return;
5057 }
5058 buf->b_ml.ml_numchunks = 100;
5059 buf->b_ml.ml_usedchunks = 1;
5060 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
5061 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
5062 }
5063
5064 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
5065 {
5066 /*
5067 * First line in empty buffer from ml_flush_line() -- reset
5068 */
5069 buf->b_ml.ml_usedchunks = 1;
5070 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01005071 buf->b_ml.ml_chunksize[0].mlcs_totalsize = (long)buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 return;
5073 }
5074
5075 /*
5076 * Find chunk that our line belongs to, curline will be at start of the
5077 * chunk.
5078 */
5079 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
5080 || updtype != ML_CHNK_ADDLINE)
5081 {
5082 for (curline = 1, curix = 0;
5083 curix < buf->b_ml.ml_usedchunks - 1
5084 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5085 curix++)
5086 {
5087 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5088 }
5089 }
Bram Moolenaara9a8e042018-10-30 22:15:55 +01005090 else if (curix < buf->b_ml.ml_usedchunks - 1
5091 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 {
5093 /* Adjust cached curix & curline */
5094 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5095 curix++;
5096 }
5097 curchnk = buf->b_ml.ml_chunksize + curix;
5098
5099 if (updtype == ML_CHNK_DELLINE)
Bram Moolenaar5a6404c2006-11-01 17:12:57 +00005100 len = -len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 curchnk->mlcs_totalsize += len;
5102 if (updtype == ML_CHNK_ADDLINE)
5103 {
5104 curchnk->mlcs_numlines++;
5105
5106 /* May resize here so we don't have to do it in both cases below */
5107 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
5108 {
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005109 chunksize_T *t_chunksize = buf->b_ml.ml_chunksize;
5110
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
5112 buf->b_ml.ml_chunksize = (chunksize_T *)
5113 vim_realloc(buf->b_ml.ml_chunksize,
5114 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
5115 if (buf->b_ml.ml_chunksize == NULL)
5116 {
5117 /* Hmmmm, Give up on offset for this buffer */
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005118 vim_free(t_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 buf->b_ml.ml_usedchunks = -1;
5120 return;
5121 }
5122 }
5123
5124 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
5125 {
5126 int count; /* number of entries in block */
5127 int idx;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005128 int end_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 int text_end;
5130 int linecnt;
5131
5132 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
5133 buf->b_ml.ml_chunksize + curix,
5134 (buf->b_ml.ml_usedchunks - curix) *
5135 sizeof(chunksize_T));
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00005136 /* Compute length of first half of lines in the split chunk */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 size = 0;
5138 linecnt = 0;
5139 while (curline < buf->b_ml.ml_line_count
5140 && linecnt < MLCS_MINL)
5141 {
5142 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5143 {
5144 buf->b_ml.ml_usedchunks = -1;
5145 return;
5146 }
5147 dp = (DATA_BL *)(hp->bh_data);
5148 count = (long)(buf->b_ml.ml_locked_high) -
5149 (long)(buf->b_ml.ml_locked_low) + 1;
5150 idx = curline - buf->b_ml.ml_locked_low;
5151 curline = buf->b_ml.ml_locked_high + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005152
5153 // compute index of last line to use in this MEMLINE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 rest = count - idx;
5155 if (linecnt + rest > MLCS_MINL)
5156 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005157 end_idx = idx + MLCS_MINL - linecnt - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 linecnt = MLCS_MINL;
5159 }
5160 else
5161 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005162 end_idx = count - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 linecnt += rest;
5164 }
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005165#ifdef FEAT_TEXT_PROP
5166 if (buf->b_has_textprop)
5167 {
5168 int i;
5169
5170 // We cannot use the text pointers to get the text length,
5171 // the text prop info would also be counted. Go over the
5172 // lines.
5173 for (i = end_idx; i < idx; ++i)
5174 size += STRLEN((char_u *)dp + (dp->db_index[i] & DB_INDEX_MASK)) + 1;
5175 }
5176 else
5177#endif
5178 {
5179 if (idx == 0)/* first line in block, text at the end */
5180 text_end = dp->db_txt_end;
5181 else
5182 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
5183 size += text_end - ((dp->db_index[end_idx]) & DB_INDEX_MASK);
5184 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 }
5186 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
5187 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
5188 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
5189 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
5190 buf->b_ml.ml_usedchunks++;
5191 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
5192 return;
5193 }
5194 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
5195 && curix == buf->b_ml.ml_usedchunks - 1
5196 && buf->b_ml.ml_line_count - line <= 1)
5197 {
5198 /*
5199 * We are in the last chunk and it is cheap to crate a new one
5200 * after this. Do it now to avoid the loop above later on
5201 */
5202 curchnk = buf->b_ml.ml_chunksize + curix + 1;
5203 buf->b_ml.ml_usedchunks++;
5204 if (line == buf->b_ml.ml_line_count)
5205 {
5206 curchnk->mlcs_numlines = 0;
5207 curchnk->mlcs_totalsize = 0;
5208 }
5209 else
5210 {
5211 /*
5212 * Line is just prior to last, move count for last
5213 * This is the common case when loading a new file
5214 */
5215 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
5216 if (hp == NULL)
5217 {
5218 buf->b_ml.ml_usedchunks = -1;
5219 return;
5220 }
5221 dp = (DATA_BL *)(hp->bh_data);
5222 if (dp->db_line_count == 1)
5223 rest = dp->db_txt_end - dp->db_txt_start;
5224 else
5225 rest =
5226 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
5227 - dp->db_txt_start;
5228 curchnk->mlcs_totalsize = rest;
5229 curchnk->mlcs_numlines = 1;
5230 curchnk[-1].mlcs_totalsize -= rest;
5231 curchnk[-1].mlcs_numlines -= 1;
5232 }
5233 }
5234 }
5235 else if (updtype == ML_CHNK_DELLINE)
5236 {
5237 curchnk->mlcs_numlines--;
5238 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
5239 if (curix < (buf->b_ml.ml_usedchunks - 1)
5240 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
5241 <= MLCS_MINL)
5242 {
5243 curix++;
5244 curchnk = buf->b_ml.ml_chunksize + curix;
5245 }
5246 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
5247 {
5248 buf->b_ml.ml_usedchunks--;
5249 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
5250 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
5251 return;
5252 }
5253 else if (curix == 0 || (curchnk->mlcs_numlines > 10
5254 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
5255 > MLCS_MINL))
5256 {
5257 return;
5258 }
5259
5260 /* Collapse chunks */
5261 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
5262 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
5263 buf->b_ml.ml_usedchunks--;
5264 if (curix < buf->b_ml.ml_usedchunks)
5265 {
5266 mch_memmove(buf->b_ml.ml_chunksize + curix,
5267 buf->b_ml.ml_chunksize + curix + 1,
5268 (buf->b_ml.ml_usedchunks - curix) *
5269 sizeof(chunksize_T));
5270 }
5271 return;
5272 }
5273 ml_upd_lastbuf = buf;
5274 ml_upd_lastline = line;
5275 ml_upd_lastcurline = curline;
5276 ml_upd_lastcurix = curix;
5277}
5278
5279/*
5280 * Find offset for line or line with offset.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005281 * Find line with offset if "lnum" is 0; return remaining offset in offp
5282 * Find offset of line if "lnum" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 * return -1 if information is not available
5284 */
5285 long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005286ml_find_line_or_offset(buf_T *buf, linenr_T lnum, long *offp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287{
5288 linenr_T curline;
5289 int curix;
5290 long size;
5291 bhdr_T *hp;
5292 DATA_BL *dp;
5293 int count; /* number of entries in block */
5294 int idx;
5295 int start_idx;
5296 int text_end;
5297 long offset;
5298 int len;
5299 int ffdos = (get_fileformat(buf) == EOL_DOS);
5300 int extra = 0;
5301
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005302 /* take care of cached line first */
5303 ml_flush_line(curbuf);
5304
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 if (buf->b_ml.ml_usedchunks == -1
5306 || buf->b_ml.ml_chunksize == NULL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005307 || lnum < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 return -1;
5309
5310 if (offp == NULL)
5311 offset = 0;
5312 else
5313 offset = *offp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005314 if (lnum == 0 && offset <= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
5316 /*
5317 * Find the last chunk before the one containing our line. Last chunk is
5318 * special because it will never qualify
5319 */
5320 curline = 1;
5321 curix = size = 0;
5322 while (curix < buf->b_ml.ml_usedchunks - 1
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005323 && ((lnum != 0
5324 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 || (offset != 0
5326 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
5327 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
5328 {
5329 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5330 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
5331 if (offset && ffdos)
5332 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5333 curix++;
5334 }
5335
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005336 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 {
5338 if (curline > buf->b_ml.ml_line_count
5339 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5340 return -1;
5341 dp = (DATA_BL *)(hp->bh_data);
5342 count = (long)(buf->b_ml.ml_locked_high) -
5343 (long)(buf->b_ml.ml_locked_low) + 1;
5344 start_idx = idx = curline - buf->b_ml.ml_locked_low;
5345 if (idx == 0)/* first line in block, text at the end */
5346 text_end = dp->db_txt_end;
5347 else
5348 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
5349 /* Compute index of last line to use in this MEMLINE */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005350 if (lnum != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005352 if (curline + (count - idx) >= lnum)
5353 idx += lnum - curline - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 else
5355 idx = count - 1;
5356 }
5357 else
5358 {
5359 extra = 0;
5360 while (offset >= size
5361 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
5362 + ffdos)
5363 {
5364 if (ffdos)
5365 size++;
5366 if (idx == count - 1)
5367 {
5368 extra = 1;
5369 break;
5370 }
5371 idx++;
5372 }
5373 }
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005374#ifdef FEAT_TEXT_PROP
5375 if (buf->b_has_textprop)
5376 {
5377 int i;
5378
5379 // cannot use the db_index pointer, need to get the actual text
5380 // lengths.
5381 len = 0;
5382 for (i = start_idx; i <= idx; ++i)
Bram Moolenaar00b1e042018-12-26 23:42:10 +01005383 len += STRLEN((char_u *)dp + ((dp->db_index[i]) & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005384 }
5385 else
5386#endif
5387 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 size += len;
5389 if (offset != 0 && size >= offset)
5390 {
5391 if (size + ffdos == offset)
5392 *offp = 0;
5393 else if (idx == start_idx)
5394 *offp = offset - size + len;
5395 else
5396 *offp = offset - size + len
5397 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
5398 curline += idx - start_idx + extra;
5399 if (curline > buf->b_ml.ml_line_count)
5400 return -1; /* exactly one byte beyond the end */
5401 return curline;
5402 }
5403 curline = buf->b_ml.ml_locked_high + 1;
5404 }
5405
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005406 if (lnum != 0)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005407 {
5408 /* Count extra CR characters. */
5409 if (ffdos)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005410 size += lnum - 1;
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005411
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005412 /* Don't count the last line break if 'noeol' and ('bin' or
5413 * 'nofixeol'). */
5414 if ((!buf->b_p_fixeol || buf->b_p_bin) && !buf->b_p_eol
Bram Moolenaarc26f7c62018-08-20 22:53:04 +02005415 && lnum > buf->b_ml.ml_line_count)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005416 size -= ffdos + 1;
5417 }
5418
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 return size;
5420}
5421
5422/*
5423 * Goto byte in buffer with offset 'cnt'.
5424 */
5425 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005426goto_byte(long cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427{
5428 long boff = cnt;
5429 linenr_T lnum;
5430
5431 ml_flush_line(curbuf); /* cached line may be dirty */
5432 setpcmark();
5433 if (boff)
5434 --boff;
5435 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
5436 if (lnum < 1) /* past the end */
5437 {
5438 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
5439 curwin->w_curswant = MAXCOL;
5440 coladvance((colnr_T)MAXCOL);
5441 }
5442 else
5443 {
5444 curwin->w_cursor.lnum = lnum;
5445 curwin->w_cursor.col = (colnr_T)boff;
Bram Moolenaar943d2b52005-12-02 00:50:49 +00005446# ifdef FEAT_VIRTUALEDIT
5447 curwin->w_cursor.coladd = 0;
5448# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 curwin->w_set_curswant = TRUE;
5450 }
5451 check_cursor();
5452
5453# ifdef FEAT_MBYTE
5454 /* Make sure the cursor is on the first byte of a multi-byte char. */
5455 if (has_mbyte)
5456 mb_adjust_cursor();
5457# endif
5458}
5459#endif