blob: 823666e5adac83f2e1645560b61aa7f2b4468aab [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 Moolenaarf9e3e092019-01-13 23:38:42 +010011/* #define CHECK(c, s) do { if (c) emsg((s)); } while (0) */
Bram Moolenaar6f470022018-04-10 18:47:20 +020012#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 Moolenaar92b8b2d2016-01-29 22:36:45 +0100243static void add_b0_fenc(ZERO_BL *b0p, buf_T *buf);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100244static time_t swapfile_info(char_u *);
245static int recov_file_names(char_u **, char_u *, int prepend_dot);
246static int ml_append_int(buf_T *, linenr_T, char_u *, colnr_T, int, int);
247static int ml_delete_int(buf_T *, linenr_T, int);
248static char_u *findswapname(buf_T *, char_u **, char_u *);
249static void ml_flush_line(buf_T *);
250static bhdr_T *ml_new_data(memfile_T *, int, int);
251static bhdr_T *ml_new_ptr(memfile_T *);
252static bhdr_T *ml_find_line(buf_T *, linenr_T, int);
253static int ml_add_stack(buf_T *);
254static void ml_lineadd(buf_T *, int);
255static int b0_magic_wrong(ZERO_BL *);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256#ifdef CHECK_INODE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100257static int fnamecmp_ino(char_u *, char_u *, long);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100259static void long_to_char(long, char_u *);
260static long char_to_long(char_u *);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200261#ifdef FEAT_CRYPT
Bram Moolenaar8767f522016-07-01 17:17:39 +0200262static cryptstate_T *ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200263#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264#ifdef FEAT_BYTEOFF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100265static void ml_updatechunk(buf_T *buf, long line, long len, int updtype);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266#endif
267
268/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000269 * Open a new memline for "buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 *
Bram Moolenaar4770d092006-01-12 23:22:24 +0000271 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 */
273 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100274ml_open(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275{
276 memfile_T *mfp;
277 bhdr_T *hp = NULL;
278 ZERO_BL *b0p;
279 PTR_BL *pp;
280 DATA_BL *dp;
281
Bram Moolenaar4770d092006-01-12 23:22:24 +0000282 /*
283 * init fields in memline struct
284 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200285 buf->b_ml.ml_stack_size = 0; /* no stack yet */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000286 buf->b_ml.ml_stack = NULL; /* no stack yet */
287 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
288 buf->b_ml.ml_locked = NULL; /* no cached block */
289 buf->b_ml.ml_line_lnum = 0; /* no cached line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000290#ifdef FEAT_BYTEOFF
Bram Moolenaar4770d092006-01-12 23:22:24 +0000291 buf->b_ml.ml_chunksize = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292#endif
293
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100294 if (cmdmod.noswapfile)
295 buf->b_p_swf = FALSE;
296
Bram Moolenaar4770d092006-01-12 23:22:24 +0000297 /*
298 * When 'updatecount' is non-zero swap file may be opened later.
299 */
300 if (p_uc && buf->b_p_swf)
301 buf->b_may_swap = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 else
Bram Moolenaar4770d092006-01-12 23:22:24 +0000303 buf->b_may_swap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar4770d092006-01-12 23:22:24 +0000305 /*
306 * Open the memfile. No swap file is created yet.
307 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 mfp = mf_open(NULL, 0);
309 if (mfp == NULL)
310 goto error;
311
Bram Moolenaar4770d092006-01-12 23:22:24 +0000312 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200313#ifdef FEAT_CRYPT
314 mfp->mf_buffer = buf;
315#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000316 buf->b_ml.ml_flags = ML_EMPTY;
317 buf->b_ml.ml_line_count = 1;
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000318#ifdef FEAT_LINEBREAK
319 curwin->w_nrwidth_line_count = 0;
320#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000321
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322/*
323 * fill block0 struct and write page 0
324 */
325 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
326 goto error;
327 if (hp->bh_bnum != 0)
328 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100329 iemsg(_("E298: Didn't get block nr 0?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330 goto error;
331 }
332 b0p = (ZERO_BL *)(hp->bh_data);
333
334 b0p->b0_id[0] = BLOCK0_ID0;
335 b0p->b0_id[1] = BLOCK0_ID1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
337 b0p->b0_magic_int = (int)B0_MAGIC_INT;
338 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
339 b0p->b0_magic_char = B0_MAGIC_CHAR;
Bram Moolenaar22c10562018-05-26 17:35:27 +0200340 mch_memmove(b0p->b0_version, "VIM ", 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341 STRNCPY(b0p->b0_version + 4, Version, 6);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000343
Bram Moolenaar76b92b22006-03-24 22:46:53 +0000344#ifdef FEAT_SPELL
345 if (!buf->b_spell)
346#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000347 {
348 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
349 b0p->b0_flags = get_fileformat(buf) + 1;
350 set_b0_fname(b0p, buf);
351 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
352 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
353 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
354 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
355 long_to_char(mch_get_pid(), b0p->b0_pid);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200356#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200357 ml_set_b0_crypt(buf, b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200358#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000359 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360
361 /*
362 * Always sync block number 0 to disk, so we can check the file name in
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200363 * the swap file in findswapname(). Don't do this for a help files or
364 * a spell buffer though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365 * Only works when there's a swapfile, otherwise it's done when the file
366 * is created.
367 */
368 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000369 if (!buf->b_help && !B_SPELL(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 (void)mf_sync(mfp, 0);
371
Bram Moolenaar4770d092006-01-12 23:22:24 +0000372 /*
373 * Fill in root pointer block and write page 1.
374 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375 if ((hp = ml_new_ptr(mfp)) == NULL)
376 goto error;
377 if (hp->bh_bnum != 1)
378 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100379 iemsg(_("E298: Didn't get block nr 1?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380 goto error;
381 }
382 pp = (PTR_BL *)(hp->bh_data);
383 pp->pb_count = 1;
384 pp->pb_pointer[0].pe_bnum = 2;
385 pp->pb_pointer[0].pe_page_count = 1;
386 pp->pb_pointer[0].pe_old_lnum = 1;
387 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
388 mf_put(mfp, hp, TRUE, FALSE);
389
Bram Moolenaar4770d092006-01-12 23:22:24 +0000390 /*
391 * Allocate first data block and create an empty line 1.
392 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
394 goto error;
395 if (hp->bh_bnum != 2)
396 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100397 iemsg(_("E298: Didn't get block nr 2?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 goto error;
399 }
400
401 dp = (DATA_BL *)(hp->bh_data);
402 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
403 dp->db_free -= 1 + INDEX_SIZE;
404 dp->db_line_count = 1;
Bram Moolenaarf05da212009-11-17 16:13:15 +0000405 *((char_u *)dp + dp->db_txt_start) = NUL; /* empty line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406
407 return OK;
408
409error:
410 if (mfp != NULL)
411 {
412 if (hp)
413 mf_put(mfp, hp, FALSE, FALSE);
414 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
415 }
Bram Moolenaar4770d092006-01-12 23:22:24 +0000416 buf->b_ml.ml_mfp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417 return FAIL;
418}
419
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200420#if defined(FEAT_CRYPT) || defined(PROTO)
421/*
Bram Moolenaar2be79502014-08-13 21:58:28 +0200422 * Prepare encryption for "buf" for the current key and method.
423 */
424 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100425ml_set_mfp_crypt(buf_T *buf)
Bram Moolenaar2be79502014-08-13 21:58:28 +0200426{
427 if (*buf->b_p_key != NUL)
428 {
429 int method_nr = crypt_get_method_nr(buf);
430
431 if (method_nr > CRYPT_M_ZIP)
432 {
433 /* Generate a seed and store it in the memfile. */
434 sha2_seed(buf->b_ml.ml_mfp->mf_seed, MF_SEED_LEN, NULL, 0);
435 }
436 }
437}
438
439/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200440 * Prepare encryption for "buf" with block 0 "b0p".
441 */
442 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100443ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200444{
445 if (*buf->b_p_key == NUL)
446 b0p->b0_id[1] = BLOCK0_ID1;
447 else
448 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200449 int method_nr = crypt_get_method_nr(buf);
450
451 b0p->b0_id[1] = id1_codes[method_nr];
452 if (method_nr > CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200453 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200454 /* Generate a seed and store it in block 0 and in the memfile. */
455 sha2_seed(&b0p->b0_seed, MF_SEED_LEN, NULL, 0);
456 mch_memmove(buf->b_ml.ml_mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
457 }
458 }
459}
460
461/*
462 * Called after the crypt key or 'cryptmethod' was changed for "buf".
463 * Will apply this to the swapfile.
464 * "old_key" is the previous key. It is equal to buf->b_p_key when
465 * 'cryptmethod' is changed.
Bram Moolenaar49771f42010-07-20 17:32:38 +0200466 * "old_cm" is the previous 'cryptmethod'. It is equal to the current
467 * 'cryptmethod' when 'key' is changed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200468 */
469 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100470ml_set_crypt_key(
471 buf_T *buf,
472 char_u *old_key,
473 char_u *old_cm)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200474{
475 memfile_T *mfp = buf->b_ml.ml_mfp;
476 bhdr_T *hp;
477 int page_count;
478 int idx;
479 long error;
480 infoptr_T *ip;
481 PTR_BL *pp;
482 DATA_BL *dp;
483 blocknr_T bnum;
484 int top;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200485 int old_method;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200486
Bram Moolenaar3832c462010-08-04 15:32:46 +0200487 if (mfp == NULL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200488 return; /* no memfile yet, nothing to do */
Bram Moolenaarbc563362015-06-09 18:35:25 +0200489 old_method = crypt_method_nr_from_name(old_cm);
490
491 /* First make sure the swapfile is in a consistent state, using the old
492 * key and method. */
493 {
494 char_u *new_key = buf->b_p_key;
495 char_u *new_buf_cm = buf->b_p_cm;
496
497 buf->b_p_key = old_key;
498 buf->b_p_cm = old_cm;
499 ml_preserve(buf, FALSE);
500 buf->b_p_key = new_key;
501 buf->b_p_cm = new_buf_cm;
502 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200503
504 /* Set the key, method and seed to be used for reading, these must be the
505 * old values. */
506 mfp->mf_old_key = old_key;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200507 mfp->mf_old_cm = old_method;
508 if (old_method > 0 && *old_key != NUL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200509 mch_memmove(mfp->mf_old_seed, mfp->mf_seed, MF_SEED_LEN);
510
511 /* Update block 0 with the crypt flag and may set a new seed. */
512 ml_upd_block0(buf, UB_CRYPT);
513
514 if (mfp->mf_infile_count > 2)
515 {
516 /*
517 * Need to read back all data blocks from disk, decrypt them with the
518 * old key/method and mark them to be written. The algorithm is
519 * similar to what happens in ml_recover(), but we skip negative block
520 * numbers.
521 */
522 ml_flush_line(buf); /* flush buffered line */
523 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
524
525 hp = NULL;
526 bnum = 1; /* start with block 1 */
527 page_count = 1; /* which is 1 page */
528 idx = 0; /* start with first index in block 1 */
529 error = 0;
530 buf->b_ml.ml_stack_top = 0;
Bram Moolenaard23a8232018-02-10 18:45:26 +0100531 VIM_CLEAR(buf->b_ml.ml_stack);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200532 buf->b_ml.ml_stack_size = 0; /* no stack yet */
533
534 for ( ; !got_int; line_breakcheck())
535 {
536 if (hp != NULL)
537 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
538
539 /* get the block (pointer or data) */
540 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
541 {
542 if (bnum == 1)
543 break;
544 ++error;
545 }
546 else
547 {
548 pp = (PTR_BL *)(hp->bh_data);
549 if (pp->pb_id == PTR_ID) /* it is a pointer block */
550 {
551 if (pp->pb_count == 0)
552 {
553 /* empty block? */
554 ++error;
555 }
556 else if (idx < (int)pp->pb_count) /* go a block deeper */
557 {
558 if (pp->pb_pointer[idx].pe_bnum < 0)
559 {
Bram Moolenaarbc563362015-06-09 18:35:25 +0200560 /* Skip data block with negative block number.
561 * Should not happen, because of the ml_preserve()
562 * above. Get same block again for next index. */
Bram Moolenaar4b7214e2019-01-03 21:55:32 +0100563 ++idx;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200564 continue;
565 }
566
567 /* going one block deeper in the tree, new entry in
568 * stack */
569 if ((top = ml_add_stack(buf)) < 0)
570 {
571 ++error;
572 break; /* out of memory */
573 }
574 ip = &(buf->b_ml.ml_stack[top]);
575 ip->ip_bnum = bnum;
576 ip->ip_index = idx;
577
578 bnum = pp->pb_pointer[idx].pe_bnum;
579 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200580 idx = 0;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200581 continue;
582 }
583 }
584 else /* not a pointer block */
585 {
586 dp = (DATA_BL *)(hp->bh_data);
587 if (dp->db_id != DATA_ID) /* block id wrong */
588 ++error;
589 else
590 {
591 /* It is a data block, need to write it back to disk. */
592 mf_put(mfp, hp, TRUE, FALSE);
593 hp = NULL;
594 }
595 }
596 }
597
598 if (buf->b_ml.ml_stack_top == 0) /* finished */
599 break;
600
601 /* go one block up in the tree */
602 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
603 bnum = ip->ip_bnum;
604 idx = ip->ip_index + 1; /* go to next index */
605 page_count = 1;
606 }
Bram Moolenaarbc563362015-06-09 18:35:25 +0200607 if (hp != NULL)
608 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +0100609
610 if (error > 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100611 emsg(_("E843: Error while updating swap file crypt"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200612 }
613
614 mfp->mf_old_key = NULL;
615}
616#endif
617
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618/*
619 * ml_setname() is called when the file name of "buf" has been changed.
620 * It may rename the swap file.
621 */
622 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100623ml_setname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624{
625 int success = FALSE;
626 memfile_T *mfp;
627 char_u *fname;
628 char_u *dirp;
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100629#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 char_u *p;
631#endif
632
633 mfp = buf->b_ml.ml_mfp;
634 if (mfp->mf_fd < 0) /* there is no swap file yet */
635 {
636 /*
637 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
638 * For help files we will make a swap file now.
639 */
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100640 if (p_uc != 0 && !cmdmod.noswapfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 ml_open_file(buf); /* create a swap file */
642 return;
643 }
644
645 /*
646 * Try all directories in the 'directory' option.
647 */
648 dirp = p_dir;
649 for (;;)
650 {
651 if (*dirp == NUL) /* tried all directories, fail */
652 break;
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000653 fname = findswapname(buf, &dirp, mfp->mf_fname);
654 /* alloc's fname */
Bram Moolenaarf541c362011-10-26 11:44:18 +0200655 if (dirp == NULL) /* out of memory */
656 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 if (fname == NULL) /* no file name found for this dir */
658 continue;
659
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100660#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 /*
662 * Set full pathname for swap file now, because a ":!cd dir" may
663 * change directory without us knowing it.
664 */
665 p = FullName_save(fname, FALSE);
666 vim_free(fname);
667 fname = p;
668 if (fname == NULL)
669 continue;
670#endif
671 /* if the file name is the same we don't have to do anything */
672 if (fnamecmp(fname, mfp->mf_fname) == 0)
673 {
674 vim_free(fname);
675 success = TRUE;
676 break;
677 }
678 /* need to close the swap file before renaming */
679 if (mfp->mf_fd >= 0)
680 {
681 close(mfp->mf_fd);
682 mfp->mf_fd = -1;
683 }
684
685 /* try to rename the swap file */
686 if (vim_rename(mfp->mf_fname, fname) == 0)
687 {
688 success = TRUE;
689 vim_free(mfp->mf_fname);
690 mfp->mf_fname = fname;
691 vim_free(mfp->mf_ffname);
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100692#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
694#else
695 mf_set_ffname(mfp);
696#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200697 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 break;
699 }
700 vim_free(fname); /* this fname didn't work, try another */
701 }
702
703 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
704 {
705 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
706 if (mfp->mf_fd < 0)
707 {
708 /* could not (re)open the swap file, what can we do???? */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100709 emsg(_("E301: Oops, lost the swap file!!!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 return;
711 }
Bram Moolenaarf05da212009-11-17 16:13:15 +0000712#ifdef HAVE_FD_CLOEXEC
713 {
714 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
715 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarfbc4b4d2016-02-07 15:14:01 +0100716 (void)fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaarf05da212009-11-17 16:13:15 +0000717 }
718#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 }
720 if (!success)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100721 emsg(_("E302: Could not rename swap file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722}
723
724/*
725 * Open a file for the memfile for all buffers that are not readonly or have
726 * been modified.
727 * Used when 'updatecount' changes from zero to non-zero.
728 */
729 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100730ml_open_files(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731{
732 buf_T *buf;
733
Bram Moolenaar29323592016-07-24 22:04:11 +0200734 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 if (!buf->b_p_ro || buf->b_changed)
736 ml_open_file(buf);
737}
738
739/*
740 * Open a swap file for an existing memfile, if there is no swap file yet.
741 * If we are unable to find a file name, mf_fname will be NULL
742 * and the memfile will be in memory only (no recovery possible).
743 */
744 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100745ml_open_file(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746{
747 memfile_T *mfp;
748 char_u *fname;
749 char_u *dirp;
750
751 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100752 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf || cmdmod.noswapfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 return; /* nothing to do */
754
Bram Moolenaara1956f62006-03-12 22:18:00 +0000755#ifdef FEAT_SPELL
Bram Moolenaar4770d092006-01-12 23:22:24 +0000756 /* For a spell buffer use a temp file name. */
757 if (buf->b_spell)
758 {
Bram Moolenaare5c421c2015-03-31 13:33:08 +0200759 fname = vim_tempname('s', FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000760 if (fname != NULL)
761 (void)mf_open_file(mfp, fname); /* consumes fname! */
762 buf->b_may_swap = FALSE;
763 return;
764 }
765#endif
766
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 /*
768 * Try all directories in 'directory' option.
769 */
770 dirp = p_dir;
771 for (;;)
772 {
773 if (*dirp == NUL)
774 break;
Bram Moolenaare242b832010-06-24 05:39:03 +0200775 /* There is a small chance that between choosing the swap file name
776 * and creating it, another Vim creates the file. In that case the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 * creation will fail and we will use another directory. */
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000778 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
Bram Moolenaarf541c362011-10-26 11:44:18 +0200779 if (dirp == NULL)
780 break; /* out of memory */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 if (fname == NULL)
782 continue;
783 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
784 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100785#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 /*
787 * set full pathname for swap file now, because a ":!cd dir" may
788 * change directory without us knowing it.
789 */
790 mf_fullname(mfp);
791#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200792 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000793
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 /* Flush block zero, so others can read it */
795 if (mf_sync(mfp, MFS_ZERO) == OK)
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000796 {
797 /* Mark all blocks that should be in the swapfile as dirty.
798 * Needed for when the 'swapfile' option was reset, so that
799 * the swap file was deleted, and then on again. */
800 mf_set_dirty(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 break;
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000802 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 /* Writing block 0 failed: close the file and try another dir */
804 mf_close_file(buf, FALSE);
805 }
806 }
807
808 if (mfp->mf_fname == NULL) /* Failed! */
809 {
810 need_wait_return = TRUE; /* call wait_return later */
811 ++no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100812 (void)semsg(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
Bram Moolenaare1704ba2012-10-03 18:25:00 +0200813 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 --no_wait_return;
815 }
816
817 /* don't try to open a swap file again */
818 buf->b_may_swap = FALSE;
819}
820
821/*
822 * If still need to create a swap file, and starting to edit a not-readonly
823 * file, or reading into an existing buffer, create a swap file now.
824 */
825 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100826check_need_swap(
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200827 int newfile) // reading file into new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828{
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200829 int old_msg_silent = msg_silent; // might be reset by an E325 message
830
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
832 ml_open_file(curbuf);
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200833 msg_silent = old_msg_silent;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834}
835
836/*
837 * Close memline for buffer 'buf'.
838 * If 'del_file' is TRUE, delete the swap file
839 */
840 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100841ml_close(buf_T *buf, int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842{
843 if (buf->b_ml.ml_mfp == NULL) /* not open */
844 return;
845 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
846 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
847 vim_free(buf->b_ml.ml_line_ptr);
848 vim_free(buf->b_ml.ml_stack);
849#ifdef FEAT_BYTEOFF
Bram Moolenaard23a8232018-02-10 18:45:26 +0100850 VIM_CLEAR(buf->b_ml.ml_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851#endif
852 buf->b_ml.ml_mfp = NULL;
853
854 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
855 * this buffer is loaded. */
856 buf->b_flags &= ~BF_RECOVERED;
857}
858
859/*
860 * Close all existing memlines and memfiles.
861 * Only used when exiting.
862 * When 'del_file' is TRUE, delete the memfiles.
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000863 * But don't delete files that were ":preserve"d when we are POSIX compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 */
865 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100866ml_close_all(int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867{
868 buf_T *buf;
869
Bram Moolenaar29323592016-07-24 22:04:11 +0200870 FOR_ALL_BUFFERS(buf)
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000871 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
872 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100873#ifdef FEAT_SPELL
874 spell_delete_wordlist(); /* delete the internal wordlist */
875#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876#ifdef TEMPDIRNAMES
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100877 vim_deltempdir(); /* delete created temp directory */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878#endif
879}
880
881/*
882 * Close all memfiles for not modified buffers.
883 * Only use just before exiting!
884 */
885 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100886ml_close_notmod(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887{
888 buf_T *buf;
889
Bram Moolenaar29323592016-07-24 22:04:11 +0200890 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 if (!bufIsChanged(buf))
892 ml_close(buf, TRUE); /* close all not-modified buffers */
893}
894
895/*
896 * Update the timestamp in the .swp file.
897 * Used when the file has been written.
898 */
899 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100900ml_timestamp(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901{
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200902 ml_upd_block0(buf, UB_FNAME);
903}
904
905/*
906 * Return FAIL when the ID of "b0p" is wrong.
907 */
908 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100909ml_check_b0_id(ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200910{
911 if (b0p->b0_id[0] != BLOCK0_ID0
912 || (b0p->b0_id[1] != BLOCK0_ID1
913 && b0p->b0_id[1] != BLOCK0_ID1_C0
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200914 && b0p->b0_id[1] != BLOCK0_ID1_C1
915 && b0p->b0_id[1] != BLOCK0_ID1_C2)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200916 )
917 return FAIL;
918 return OK;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000919}
920
921/*
922 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
923 */
924 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100925ml_upd_block0(buf_T *buf, upd_block0_T what)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000926{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 memfile_T *mfp;
928 bhdr_T *hp;
929 ZERO_BL *b0p;
930
931 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200932 if (mfp == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200934 hp = mf_get(mfp, (blocknr_T)0, 1);
935 if (hp == NULL)
936 {
937#ifdef FEAT_CRYPT
938 /* Possibly update the seed in the memfile before there is a block0. */
939 if (what == UB_CRYPT)
940 ml_set_mfp_crypt(buf);
941#endif
942 return;
943 }
944
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200946 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100947 iemsg(_("E304: ml_upd_block0(): Didn't get block 0??"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000949 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200950 if (what == UB_FNAME)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000951 set_b0_fname(b0p, buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200952#ifdef FEAT_CRYPT
953 else if (what == UB_CRYPT)
954 ml_set_b0_crypt(buf, b0p);
955#endif
956 else /* what == UB_SAME_DIR */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000957 set_b0_dir_flag(b0p, buf);
958 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959 mf_put(mfp, hp, TRUE, FALSE);
960}
961
962/*
963 * Write file name and timestamp into block 0 of a swap file.
964 * Also set buf->b_mtime.
965 * Don't use NameBuff[]!!!
966 */
967 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100968set_b0_fname(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969{
Bram Moolenaar8767f522016-07-01 17:17:39 +0200970 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
972 if (buf->b_ffname == NULL)
973 b0p->b0_fname[0] = NUL;
974 else
975 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100976#if defined(MSWIN) || defined(AMIGA)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000977 /* Systems that cannot translate "~user" back into a path: copy the
978 * file name unmodified. Do use slashes instead of backslashes for
979 * portability. */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200980 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000981# ifdef BACKSLASH_IN_FILENAME
982 forward_slash(b0p->b0_fname);
983# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984#else
985 size_t flen, ulen;
986 char_u uname[B0_UNAME_SIZE];
987
988 /*
989 * For a file under the home directory of the current user, we try to
990 * replace the home directory path with "~user". This helps when
991 * editing the same file on different machines over a network.
992 * First replace home dir path with "~/" with home_replace().
993 * Then insert the user name to get "~user/".
994 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200995 home_replace(NULL, buf->b_ffname, b0p->b0_fname,
996 B0_FNAME_SIZE_CRYPT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 if (b0p->b0_fname[0] == '~')
998 {
999 flen = STRLEN(b0p->b0_fname);
1000 /* If there is no user name or it is too long, don't use "~/" */
1001 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001002 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE_CRYPT - 1)
1003 vim_strncpy(b0p->b0_fname, buf->b_ffname,
1004 B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 else
1006 {
1007 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
1008 mch_memmove(b0p->b0_fname + 1, uname, ulen);
1009 }
1010 }
1011#endif
1012 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
1013 {
1014 long_to_char((long)st.st_mtime, b0p->b0_mtime);
1015#ifdef CHECK_INODE
1016 long_to_char((long)st.st_ino, b0p->b0_ino);
1017#endif
1018 buf_store_time(buf, &st, buf->b_ffname);
1019 buf->b_mtime_read = buf->b_mtime;
1020 }
1021 else
1022 {
1023 long_to_char(0L, b0p->b0_mtime);
1024#ifdef CHECK_INODE
1025 long_to_char(0L, b0p->b0_ino);
1026#endif
1027 buf->b_mtime = 0;
1028 buf->b_mtime_read = 0;
1029 buf->b_orig_size = 0;
1030 buf->b_orig_mode = 0;
1031 }
1032 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001033
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001034 /* Also add the 'fileencoding' if there is room. */
1035 add_b0_fenc(b0p, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036}
1037
1038/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001039 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
1040 * swapfile for "buf" are in the same directory.
1041 * This is fail safe: if we are not sure the directories are equal the flag is
1042 * not set.
1043 */
1044 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001045set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001046{
1047 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
1048 b0p->b0_flags |= B0_SAME_DIR;
1049 else
1050 b0p->b0_flags &= ~B0_SAME_DIR;
1051}
1052
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001053/*
1054 * When there is room, add the 'fileencoding' to block zero.
1055 */
1056 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001057add_b0_fenc(
1058 ZERO_BL *b0p,
1059 buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001060{
1061 int n;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001062 int size = B0_FNAME_SIZE_NOCRYPT;
1063
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001064#ifdef FEAT_CRYPT
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001065 /* Without encryption use the same offset as in Vim 7.2 to be compatible.
1066 * With encryption it's OK to move elsewhere, the swap file is not
1067 * compatible anyway. */
1068 if (*buf->b_p_key != NUL)
1069 size = B0_FNAME_SIZE_CRYPT;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001070#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001071
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001072 n = (int)STRLEN(buf->b_p_fenc);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001073 if ((int)STRLEN(b0p->b0_fname) + n + 1 > size)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001074 b0p->b0_flags &= ~B0_HAS_FENC;
1075 else
1076 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001077 mch_memmove((char *)b0p->b0_fname + size - n,
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001078 (char *)buf->b_p_fenc, (size_t)n);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001079 *(b0p->b0_fname + size - n - 1) = NUL;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001080 b0p->b0_flags |= B0_HAS_FENC;
1081 }
1082}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001083
1084
1085/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001086 * Try to recover curbuf from the .swp file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 */
1088 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001089ml_recover(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090{
1091 buf_T *buf = NULL;
1092 memfile_T *mfp = NULL;
1093 char_u *fname;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001094 char_u *fname_used = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 bhdr_T *hp = NULL;
1096 ZERO_BL *b0p;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001097 int b0_ff;
1098 char_u *b0_fenc = NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001099#ifdef FEAT_CRYPT
1100 int b0_cm = -1;
1101#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 PTR_BL *pp;
1103 DATA_BL *dp;
1104 infoptr_T *ip;
1105 blocknr_T bnum;
1106 int page_count;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001107 stat_T org_stat, swp_stat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 int len;
1109 int directly;
1110 linenr_T lnum;
1111 char_u *p;
1112 int i;
1113 long error;
1114 int cannot_open;
1115 linenr_T line_count;
1116 int has_error;
1117 int idx;
1118 int top;
1119 int txt_start;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001120 off_T size;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121 int called_from_main;
1122 int serious_error = TRUE;
1123 long mtime;
1124 int attr;
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001125 int orig_file_status = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126
1127 recoverymode = TRUE;
1128 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001129 attr = HL_ATTR(HLF_E);
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001130
1131 /*
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001132 * 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 +00001133 * Otherwise a search is done to find the swap file(s).
1134 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135 fname = curbuf->b_fname;
1136 if (fname == NULL) /* When there is no file name */
1137 fname = (char_u *)"";
1138 len = (int)STRLEN(fname);
1139 if (len >= 4 &&
Bram Moolenaare60acc12011-05-10 16:41:25 +02001140#if defined(VMS)
Bram Moolenaar79518e22017-02-17 16:31:35 +01001141 STRNICMP(fname + len - 4, "_s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142#else
Bram Moolenaar79518e22017-02-17 16:31:35 +01001143 STRNICMP(fname + len - 4, ".s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144#endif
Bram Moolenaar79518e22017-02-17 16:31:35 +01001145 == 0
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001146 && vim_strchr((char_u *)"abcdefghijklmnopqrstuvw",
1147 TOLOWER_ASC(fname[len - 2])) != NULL
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001148 && ASCII_ISALPHA(fname[len - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 {
1150 directly = TRUE;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001151 fname_used = vim_strsave(fname); /* make a copy for mf_open() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 }
1153 else
1154 {
1155 directly = FALSE;
1156
1157 /* count the number of matching swap files */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001158 len = recover_names(fname, FALSE, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 if (len == 0) /* no swap files found */
1160 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001161 semsg(_("E305: No swap file found for %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 goto theend;
1163 }
1164 if (len == 1) /* one swap file found, use it */
1165 i = 1;
1166 else /* several swap files found, choose */
1167 {
1168 /* list the names of the swap files */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001169 (void)recover_names(fname, TRUE, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 msg_putchar('\n');
Bram Moolenaar32526b32019-01-19 17:43:09 +01001171 msg_puts(_("Enter number of swap file to use (0 to quit): "));
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001172 i = get_number(FALSE, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 if (i < 1 || i > len)
1174 goto theend;
1175 }
1176 /* get the swap file name that will be used */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001177 (void)recover_names(fname, FALSE, i, &fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001179 if (fname_used == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 goto theend; /* out of memory */
1181
1182 /* When called from main() still need to initialize storage structure */
Bram Moolenaar4770d092006-01-12 23:22:24 +00001183 if (called_from_main && ml_open(curbuf) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 getout(1);
1185
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001186 /*
1187 * Allocate a buffer structure for the swap file that is used for recovery.
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001188 * Only the memline and crypt information in it are really used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001189 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
1191 if (buf == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001194 /*
1195 * init fields in memline struct
1196 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1198 buf->b_ml.ml_stack = NULL; /* no stack yet */
1199 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
1200 buf->b_ml.ml_line_lnum = 0; /* no cached line */
1201 buf->b_ml.ml_locked = NULL; /* no locked block */
1202 buf->b_ml.ml_flags = 0;
Bram Moolenaar0fe849a2010-07-25 15:11:11 +02001203#ifdef FEAT_CRYPT
1204 buf->b_p_key = empty_option;
1205 buf->b_p_cm = empty_option;
1206#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001208 /*
1209 * open the memfile from the old swap file
1210 */
1211 p = vim_strsave(fname_used); /* save "fname_used" for the message:
1212 mf_open() will consume "fname_used"! */
1213 mfp = mf_open(fname_used, O_RDONLY);
1214 fname_used = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 if (mfp == NULL || mfp->mf_fd < 0)
1216 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001217 if (fname_used != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001218 semsg(_("E306: Cannot open %s"), fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 goto theend;
1220 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001222#ifdef FEAT_CRYPT
1223 mfp->mf_buffer = buf;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001224#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225
1226 /*
1227 * The page size set in mf_open() might be different from the page size
1228 * used in the swap file, we must get it from block 0. But to read block
1229 * 0 we need a page size. Use the minimal size for block 0 here, it will
1230 * be set to the real value below.
1231 */
1232 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
1233
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001234 /*
1235 * try to read block 0
1236 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
1238 {
1239 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +01001240 msg_puts_attr(_("Unable to read block 0 from "), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001242 msg_puts_attr(_("\nMaybe no changes were made or Vim did not update the swap file."),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 attr | MSG_HIST);
1244 msg_end();
1245 goto theend;
1246 }
1247 b0p = (ZERO_BL *)(hp->bh_data);
1248 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
1249 {
1250 msg_start();
1251 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001252 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001254 msg_puts_attr(_("Use Vim version 3.0.\n"), MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 msg_end();
1256 goto theend;
1257 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001258 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001260 semsg(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 goto theend;
1262 }
1263 if (b0_magic_wrong(b0p))
1264 {
1265 msg_start();
1266 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001267#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001269 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 attr | MSG_HIST);
1271 else
1272#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001273 msg_puts_attr(_(" cannot be used on this computer.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001275 msg_puts_attr(_("The file was created on "), attr | MSG_HIST);
Bram Moolenaare242b832010-06-24 05:39:03 +02001276 /* avoid going past the end of a corrupted hostname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 b0p->b0_fname[0] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001278 msg_puts_attr((char *)b0p->b0_hname, attr | MSG_HIST);
1279 msg_puts_attr(_(",\nor the file has been damaged."), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 msg_end();
1281 goto theend;
1282 }
Bram Moolenaar1c536282007-04-26 15:21:56 +00001283
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001284#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001285 for (i = 0; i < (int)(sizeof(id1_codes) / sizeof(int)); ++i)
1286 if (id1_codes[i] == b0p->b0_id[1])
1287 b0_cm = i;
1288 if (b0_cm > 0)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001289 mch_memmove(mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001290 crypt_set_cm_option(buf, b0_cm < 0 ? 0 : b0_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001291#else
1292 if (b0p->b0_id[1] != BLOCK0_ID1)
1293 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001294 semsg(_("E833: %s is encrypted and this version of Vim does not support encryption"), mfp->mf_fname);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001295 goto theend;
1296 }
1297#endif
1298
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 /*
1300 * If we guessed the wrong page size, we have to recalculate the
1301 * highest block number in the file.
1302 */
1303 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1304 {
Bram Moolenaar1c536282007-04-26 15:21:56 +00001305 unsigned previous_page_size = mfp->mf_page_size;
1306
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
Bram Moolenaar1c536282007-04-26 15:21:56 +00001308 if (mfp->mf_page_size < previous_page_size)
1309 {
1310 msg_start();
1311 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001312 msg_puts_attr(_(" has been damaged (page size is smaller than minimum value).\n"),
Bram Moolenaar1c536282007-04-26 15:21:56 +00001313 attr | MSG_HIST);
1314 msg_end();
1315 goto theend;
1316 }
Bram Moolenaar8767f522016-07-01 17:17:39 +02001317 if ((size = vim_lseek(mfp->mf_fd, (off_T)0L, SEEK_END)) <= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 mfp->mf_blocknr_max = 0; /* no file or empty file */
1319 else
1320 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1321 mfp->mf_infile_count = mfp->mf_blocknr_max;
Bram Moolenaar1c536282007-04-26 15:21:56 +00001322
1323 /* need to reallocate the memory used to store the data */
1324 p = alloc(mfp->mf_page_size);
1325 if (p == NULL)
1326 goto theend;
1327 mch_memmove(p, hp->bh_data, previous_page_size);
1328 vim_free(hp->bh_data);
1329 hp->bh_data = p;
1330 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 }
1332
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001333 /*
1334 * If .swp file name given directly, use name from swap file for buffer.
1335 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 if (directly)
1337 {
1338 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1339 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1340 goto theend;
1341 }
1342
1343 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001344 smsg(_("Using swap file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345
1346 if (buf_spname(curbuf) != NULL)
Bram Moolenaare1704ba2012-10-03 18:25:00 +02001347 vim_strncpy(NameBuff, buf_spname(curbuf), MAXPATHL - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 else
1349 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001350 smsg(_("Original file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 msg_putchar('\n');
1352
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001353 /*
1354 * check date of swap file and original file
1355 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 mtime = char_to_long(b0p->b0_mtime);
1357 if (curbuf->b_ffname != NULL
1358 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1359 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1360 && org_stat.st_mtime > swp_stat.st_mtime)
1361 || org_stat.st_mtime != mtime))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001362 emsg(_("E308: Warning: Original file may have been changed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 out_flush();
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001364
1365 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1366 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1367 if (b0p->b0_flags & B0_HAS_FENC)
1368 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001369 int fnsize = B0_FNAME_SIZE_NOCRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001370
1371#ifdef FEAT_CRYPT
1372 /* Use the same size as in add_b0_fenc(). */
1373 if (b0p->b0_id[1] != BLOCK0_ID1)
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001374 fnsize = B0_FNAME_SIZE_CRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001375#endif
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001376 for (p = b0p->b0_fname + fnsize; p > b0p->b0_fname && p[-1] != NUL; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001377 ;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001378 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + fnsize - p));
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001379 }
1380
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1382 hp = NULL;
1383
1384 /*
1385 * Now that we are sure that the file is going to be recovered, clear the
1386 * contents of the current buffer.
1387 */
1388 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1389 ml_delete((linenr_T)1, FALSE);
1390
1391 /*
1392 * Try reading the original file to obtain the values of 'fileformat',
1393 * 'fileencoding', etc. Ignore errors. The text itself is not used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001394 * When the file is encrypted the user is asked to enter the key.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 */
1396 if (curbuf->b_ffname != NULL)
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001397 orig_file_status = readfile(curbuf->b_ffname, NULL, (linenr_T)0,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001400#ifdef FEAT_CRYPT
1401 if (b0_cm >= 0)
1402 {
1403 /* Need to ask the user for the crypt key. If this fails we continue
1404 * without a key, will probably get garbage text. */
1405 if (*curbuf->b_p_key != NUL)
1406 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001407 smsg(_("Swap file is encrypted: \"%s\""), fname_used);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001408 msg_puts(_("\nIf you entered a new crypt key but did not write the text file,"));
1409 msg_puts(_("\nenter the new crypt key."));
1410 msg_puts(_("\nIf you wrote the text file after changing the crypt key press enter"));
1411 msg_puts(_("\nto use the same key for text file and swap file"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001412 }
1413 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001414 smsg(_(need_key_msg), fname_used);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001415 buf->b_p_key = crypt_get_key(FALSE, FALSE);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001416 if (buf->b_p_key == NULL)
1417 buf->b_p_key = curbuf->b_p_key;
1418 else if (*buf->b_p_key == NUL)
1419 {
1420 vim_free(buf->b_p_key);
1421 buf->b_p_key = curbuf->b_p_key;
1422 }
1423 if (buf->b_p_key == NULL)
1424 buf->b_p_key = empty_option;
1425 }
1426#endif
1427
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001428 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1429 if (b0_ff != 0)
1430 set_fileformat(b0_ff - 1, OPT_LOCAL);
1431 if (b0_fenc != NULL)
1432 {
1433 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1434 vim_free(b0_fenc);
1435 }
1436 unchanged(curbuf, TRUE);
1437
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 bnum = 1; /* start with block 1 */
1439 page_count = 1; /* which is 1 page */
1440 lnum = 0; /* append after line 0 in curbuf */
1441 line_count = 0;
1442 idx = 0; /* start with first index in block 1 */
1443 error = 0;
1444 buf->b_ml.ml_stack_top = 0;
1445 buf->b_ml.ml_stack = NULL;
1446 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1447
1448 if (curbuf->b_ffname == NULL)
1449 cannot_open = TRUE;
1450 else
1451 cannot_open = FALSE;
1452
1453 serious_error = FALSE;
1454 for ( ; !got_int; line_breakcheck())
1455 {
1456 if (hp != NULL)
1457 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1458
1459 /*
1460 * get block
1461 */
1462 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1463 {
1464 if (bnum == 1)
1465 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001466 semsg(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 goto theend;
1468 }
1469 ++error;
1470 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1471 (colnr_T)0, TRUE);
1472 }
1473 else /* there is a block */
1474 {
1475 pp = (PTR_BL *)(hp->bh_data);
1476 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1477 {
1478 /* check line count when using pointer block first time */
1479 if (idx == 0 && line_count != 0)
1480 {
1481 for (i = 0; i < (int)pp->pb_count; ++i)
1482 line_count -= pp->pb_pointer[i].pe_line_count;
1483 if (line_count != 0)
1484 {
1485 ++error;
1486 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1487 (colnr_T)0, TRUE);
1488 }
1489 }
1490
1491 if (pp->pb_count == 0)
1492 {
1493 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1494 (colnr_T)0, TRUE);
1495 ++error;
1496 }
1497 else if (idx < (int)pp->pb_count) /* go a block deeper */
1498 {
1499 if (pp->pb_pointer[idx].pe_bnum < 0)
1500 {
1501 /*
1502 * Data block with negative block number.
1503 * Try to read lines from the original file.
1504 * This is slow, but it works.
1505 */
1506 if (!cannot_open)
1507 {
1508 line_count = pp->pb_pointer[idx].pe_line_count;
1509 if (readfile(curbuf->b_ffname, NULL, lnum,
1510 pp->pb_pointer[idx].pe_old_lnum - 1,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001511 line_count, NULL, 0) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 cannot_open = TRUE;
1513 else
1514 lnum += line_count;
1515 }
1516 if (cannot_open)
1517 {
1518 ++error;
1519 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1520 (colnr_T)0, TRUE);
1521 }
1522 ++idx; /* get same block again for next index */
1523 continue;
1524 }
1525
1526 /*
1527 * going one block deeper in the tree
1528 */
1529 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1530 {
1531 ++error;
1532 break; /* out of memory */
1533 }
1534 ip = &(buf->b_ml.ml_stack[top]);
1535 ip->ip_bnum = bnum;
1536 ip->ip_index = idx;
1537
1538 bnum = pp->pb_pointer[idx].pe_bnum;
1539 line_count = pp->pb_pointer[idx].pe_line_count;
1540 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaar986a0032011-06-13 01:07:27 +02001541 idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 continue;
1543 }
1544 }
1545 else /* not a pointer block */
1546 {
1547 dp = (DATA_BL *)(hp->bh_data);
1548 if (dp->db_id != DATA_ID) /* block id wrong */
1549 {
1550 if (bnum == 1)
1551 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001552 semsg(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 mfp->mf_fname);
1554 goto theend;
1555 }
1556 ++error;
1557 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1558 (colnr_T)0, TRUE);
1559 }
1560 else
1561 {
1562 /*
1563 * it is a data block
1564 * Append all the lines in this block
1565 */
1566 has_error = FALSE;
1567 /*
1568 * check length of block
1569 * if wrong, use length in pointer block
1570 */
1571 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1572 {
1573 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1574 (colnr_T)0, TRUE);
1575 ++error;
1576 has_error = TRUE;
1577 dp->db_txt_end = page_count * mfp->mf_page_size;
1578 }
1579
1580 /* make sure there is a NUL at the end of the block */
1581 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1582
1583 /*
1584 * check number of lines in block
1585 * if wrong, use count in data block
1586 */
1587 if (line_count != dp->db_line_count)
1588 {
1589 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1590 (colnr_T)0, TRUE);
1591 ++error;
1592 has_error = TRUE;
1593 }
1594
1595 for (i = 0; i < dp->db_line_count; ++i)
1596 {
1597 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
Bram Moolenaar740885b2009-11-03 14:33:17 +00001598 if (txt_start <= (int)HEADER_SIZE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 || txt_start >= (int)dp->db_txt_end)
1600 {
1601 p = (char_u *)"???";
1602 ++error;
1603 }
1604 else
1605 p = (char_u *)dp + txt_start;
1606 ml_append(lnum++, p, (colnr_T)0, TRUE);
1607 }
1608 if (has_error)
Bram Moolenaar740885b2009-11-03 14:33:17 +00001609 ml_append(lnum++, (char_u *)_("???END"),
1610 (colnr_T)0, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 }
1612 }
1613 }
1614
1615 if (buf->b_ml.ml_stack_top == 0) /* finished */
1616 break;
1617
1618 /*
1619 * go one block up in the tree
1620 */
1621 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1622 bnum = ip->ip_bnum;
1623 idx = ip->ip_index + 1; /* go to next index */
1624 page_count = 1;
1625 }
1626
1627 /*
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001628 * Compare the buffer contents with the original file. When they differ
1629 * set the 'modified' flag.
1630 * Lines 1 - lnum are the new contents.
1631 * Lines lnum + 1 to ml_line_count are the original contents.
1632 * Line ml_line_count + 1 in the dummy empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 */
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001634 if (orig_file_status != OK || curbuf->b_ml.ml_line_count != lnum * 2 + 1)
1635 {
1636 /* Recovering an empty file results in two lines and the first line is
1637 * empty. Don't set the modified flag then. */
1638 if (!(curbuf->b_ml.ml_line_count == 2 && *ml_get(1) == NUL))
1639 {
1640 changed_int();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001641 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001642 }
1643 }
1644 else
1645 {
1646 for (idx = 1; idx <= lnum; ++idx)
1647 {
1648 /* Need to copy one line, fetching the other one may flush it. */
1649 p = vim_strsave(ml_get(idx));
1650 i = STRCMP(p, ml_get(idx + lnum));
1651 vim_free(p);
1652 if (i != 0)
1653 {
1654 changed_int();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001655 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001656 break;
1657 }
1658 }
1659 }
1660
1661 /*
1662 * Delete the lines from the original file and the dummy line from the
1663 * empty buffer. These will now be after the last line in the buffer.
1664 */
1665 while (curbuf->b_ml.ml_line_count > lnum
1666 && !(curbuf->b_ml.ml_flags & ML_EMPTY))
1667 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 curbuf->b_flags |= BF_RECOVERED;
1669
1670 recoverymode = FALSE;
1671 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001672 emsg(_("E311: Recovery Interrupted"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 else if (error)
1674 {
1675 ++no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001676 msg(">>>>>>>>>>>>>");
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001677 emsg(_("E312: Errors detected while recovering; look for lines starting with ???"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 --no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001679 msg(_("See \":help E312\" for more information."));
1680 msg(">>>>>>>>>>>>>");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 }
1682 else
1683 {
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001684 if (curbuf->b_changed)
1685 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001686 msg(_("Recovery completed. You should check if everything is OK."));
1687 msg_puts(_("\n(You might want to write out this file under another name\n"));
1688 msg_puts(_("and run diff with the original file to check for changes)"));
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001689 }
1690 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001691 msg(_("Recovery completed. Buffer contents equals file contents."));
1692 msg_puts(_("\nYou may want to delete the .swp file now.\n\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 cmdline_row = msg_row;
1694 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001695#ifdef FEAT_CRYPT
1696 if (*buf->b_p_key != NUL && STRCMP(curbuf->b_p_key, buf->b_p_key) != 0)
1697 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001698 msg_puts(_("Using crypt key from swap file for the text file.\n"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001699 set_option_value((char_u *)"key", 0L, buf->b_p_key, OPT_LOCAL);
1700 }
1701#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 redraw_curbuf_later(NOT_VALID);
1703
1704theend:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001705 vim_free(fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 recoverymode = FALSE;
1707 if (mfp != NULL)
1708 {
1709 if (hp != NULL)
1710 mf_put(mfp, hp, FALSE, FALSE);
1711 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1712 }
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001713 if (buf != NULL)
1714 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001715#ifdef FEAT_CRYPT
1716 if (buf->b_p_key != curbuf->b_p_key)
1717 free_string_option(buf->b_p_key);
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001718 free_string_option(buf->b_p_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001719#endif
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001720 vim_free(buf->b_ml.ml_stack);
1721 vim_free(buf);
1722 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 if (serious_error && called_from_main)
1724 ml_close(curbuf, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 else
1726 {
1727 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1728 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1729 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 return;
1731}
1732
1733/*
1734 * Find the names of swap files in current directory and the directory given
1735 * with the 'directory' option.
1736 *
1737 * Used to:
1738 * - list the swap files for "vim -r"
1739 * - count the number of swap files when recovering
1740 * - list the swap files when recovering
1741 * - find the name of the n'th swap file when recovering
1742 */
1743 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001744recover_names(
1745 char_u *fname, /* base for swap file name */
1746 int list, /* when TRUE, list the swap file names */
1747 int nr, /* when non-zero, return nr'th swap file name */
1748 char_u **fname_out) /* result when "nr" > 0 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749{
1750 int num_names;
1751 char_u *(names[6]);
1752 char_u *tail;
1753 char_u *p;
1754 int num_files;
1755 int file_count = 0;
1756 char_u **files;
1757 int i;
1758 char_u *dirp;
1759 char_u *dir_name;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001760 char_u *fname_res = NULL;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001761#ifdef HAVE_READLINK
1762 char_u fname_buf[MAXPATHL];
Bram Moolenaar64354da2010-05-25 21:37:17 +02001763#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001764
Bram Moolenaar64354da2010-05-25 21:37:17 +02001765 if (fname != NULL)
1766 {
1767#ifdef HAVE_READLINK
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001768 /* Expand symlink in the file name, because the swap file is created
1769 * with the actual file instead of with the symlink. */
1770 if (resolve_symlink(fname, fname_buf) == OK)
1771 fname_res = fname_buf;
1772 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001773#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001774 fname_res = fname;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001775 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776
1777 if (list)
1778 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001779 /* use msg() to start the scrolling properly */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001780 msg(_("Swap files found:"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 msg_putchar('\n');
1782 }
1783
1784 /*
1785 * Do the loop for every directory in 'directory'.
1786 * First allocate some memory to put the directory name in.
1787 */
1788 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1789 dirp = p_dir;
1790 while (dir_name != NULL && *dirp)
1791 {
1792 /*
1793 * Isolate a directory name from *dirp and put it in dir_name (we know
1794 * it is large enough, so use 31000 for length).
1795 * Advance dirp to next directory name.
1796 */
1797 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1798
1799 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1800 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001801 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 {
1803#ifdef VMS
1804 names[0] = vim_strsave((char_u *)"*_sw%");
1805#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 names[0] = vim_strsave((char_u *)"*.sw?");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001808#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar2cc93182006-10-10 19:56:03 +00001809 /* For Unix names starting with a dot are special. MS-Windows
1810 * supports this too, on some file systems. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 names[1] = vim_strsave((char_u *)".*.sw?");
1812 names[2] = vim_strsave((char_u *)".sw?");
1813 num_names = 3;
1814#else
1815# ifdef VMS
1816 names[1] = vim_strsave((char_u *)".*_sw%");
1817 num_names = 2;
1818# else
1819 num_names = 1;
1820# endif
1821#endif
1822 }
1823 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001824 num_names = recov_file_names(names, fname_res, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 }
1826 else /* check directory dir_name */
1827 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001828 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 {
1830#ifdef VMS
1831 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1832#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001835#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar2cc93182006-10-10 19:56:03 +00001836 /* For Unix names starting with a dot are special. MS-Windows
1837 * supports this too, on some file systems. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1839 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1840 num_names = 3;
1841#else
1842# ifdef VMS
1843 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1844 num_names = 2;
1845# else
1846 num_names = 1;
1847# endif
1848#endif
1849 }
1850 else
1851 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01001852#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01001853 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01001854
1855 p = dir_name + len;
1856 if (after_pathsep(dir_name, p) && len > 1 && p[-1] == p[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 {
1858 /* Ends with '//', Use Full path for swap name */
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001859 tail = make_percent_swname(dir_name, fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 }
1861 else
1862#endif
1863 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001864 tail = gettail(fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 tail = concat_fnames(dir_name, tail, TRUE);
1866 }
1867 if (tail == NULL)
1868 num_names = 0;
1869 else
1870 {
1871 num_names = recov_file_names(names, tail, FALSE);
1872 vim_free(tail);
1873 }
1874 }
1875 }
1876
1877 /* check for out-of-memory */
1878 for (i = 0; i < num_names; ++i)
1879 {
1880 if (names[i] == NULL)
1881 {
1882 for (i = 0; i < num_names; ++i)
1883 vim_free(names[i]);
1884 num_names = 0;
1885 }
1886 }
1887 if (num_names == 0)
1888 num_files = 0;
1889 else if (expand_wildcards(num_names, names, &num_files, &files,
1890 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1891 num_files = 0;
1892
1893 /*
1894 * When no swap file found, wildcard expansion might have failed (e.g.
1895 * not able to execute the shell).
1896 * Try finding a swap file by simply adding ".swp" to the file name.
1897 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001898 if (*dirp == NUL && file_count + num_files == 0 && fname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 {
Bram Moolenaar8767f522016-07-01 17:17:39 +02001900 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 char_u *swapname;
1902
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001903 swapname = modname(fname_res,
Bram Moolenaare60acc12011-05-10 16:41:25 +02001904#if defined(VMS)
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001905 (char_u *)"_swp", FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906#else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001907 (char_u *)".swp", TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001909 );
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 if (swapname != NULL)
1911 {
1912 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1913 {
1914 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1915 if (files != NULL)
1916 {
1917 files[0] = swapname;
1918 swapname = NULL;
1919 num_files = 1;
1920 }
1921 }
1922 vim_free(swapname);
1923 }
1924 }
1925
1926 /*
1927 * remove swapfile name of the current buffer, it must be ignored
1928 */
1929 if (curbuf->b_ml.ml_mfp != NULL
1930 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1931 {
1932 for (i = 0; i < num_files; ++i)
1933 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1934 {
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00001935 /* Remove the name from files[i]. Move further entries
1936 * down. When the array becomes empty free it here, since
1937 * FreeWild() won't be called below. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 vim_free(files[i]);
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00001939 if (--num_files == 0)
1940 vim_free(files);
1941 else
1942 for ( ; i < num_files; ++i)
1943 files[i] = files[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944 }
1945 }
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001946 if (nr > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 {
1948 file_count += num_files;
1949 if (nr <= file_count)
1950 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001951 *fname_out = vim_strsave(
1952 files[nr - 1 + num_files - file_count]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 dirp = (char_u *)""; /* stop searching */
1954 }
1955 }
1956 else if (list)
1957 {
1958 if (dir_name[0] == '.' && dir_name[1] == NUL)
1959 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001960 if (fname == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001961 msg_puts(_(" In current directory:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001963 msg_puts(_(" Using specified name:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 }
1965 else
1966 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001967 msg_puts(_(" In directory "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 msg_home_replace(dir_name);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001969 msg_puts(":\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970 }
1971
1972 if (num_files)
1973 {
1974 for (i = 0; i < num_files; ++i)
1975 {
1976 /* print the swap file name */
1977 msg_outnum((long)++file_count);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001978 msg_puts(". ");
1979 msg_puts((char *)gettail(files[i]));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 msg_putchar('\n');
1981 (void)swapfile_info(files[i]);
1982 }
1983 }
1984 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001985 msg_puts(_(" -- none --\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 out_flush();
1987 }
1988 else
1989 file_count += num_files;
1990
1991 for (i = 0; i < num_names; ++i)
1992 vim_free(names[i]);
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001993 if (num_files > 0)
1994 FreeWild(num_files, files);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995 }
1996 vim_free(dir_name);
1997 return file_count;
1998}
1999
Bram Moolenaar4f974752019-02-17 17:44:42 +01002000#if defined(UNIX) || defined(MSWIN) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001/*
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002002 * Need _very_ long file names.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 * Append the full path to name with path separators made into percent
2004 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
2005 */
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002006 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002007make_percent_swname(char_u *dir, char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008{
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002009 char_u *d = NULL, *s, *f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002011 f = fix_fname(name != NULL ? name : (char_u *)"");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 if (f != NULL)
2013 {
2014 s = alloc((unsigned)(STRLEN(f) + 1));
2015 if (s != NULL)
2016 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002017 STRCPY(s, f);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002018 for (d = s; *d != NUL; MB_PTR_ADV(d))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002019 if (vim_ispathsep(*d))
2020 *d = '%';
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 d = concat_fnames(dir, s, TRUE);
2022 vim_free(s);
2023 }
2024 vim_free(f);
2025 }
2026 return d;
2027}
2028#endif
2029
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002030#if (defined(UNIX) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031static int process_still_running;
2032#endif
2033
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002034#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035/*
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002036 * Return information found in swapfile "fname" in dictionary "d".
2037 * This is used by the swapinfo() function.
2038 */
2039 void
2040get_b0_dict(char_u *fname, dict_T *d)
2041{
2042 int fd;
2043 struct block0 b0;
2044
2045 if ((fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
2046 {
2047 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
2048 {
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002049 if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002050 dict_add_string(d, "error", (char_u *)"Not a swap file");
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002051 else if (b0_magic_wrong(&b0))
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002052 dict_add_string(d, "error", (char_u *)"Magic number mismatch");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002053 else
2054 {
2055 /* we have swap information */
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002056 dict_add_string_len(d, "version", b0.b0_version, 10);
2057 dict_add_string_len(d, "user", b0.b0_uname, B0_UNAME_SIZE);
2058 dict_add_string_len(d, "host", b0.b0_hname, B0_HNAME_SIZE);
2059 dict_add_string_len(d, "fname", b0.b0_fname, B0_FNAME_SIZE_ORG);
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002060
2061 dict_add_number(d, "pid", char_to_long(b0.b0_pid));
2062 dict_add_number(d, "mtime", char_to_long(b0.b0_mtime));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002063 dict_add_number(d, "dirty", b0.b0_dirty ? 1 : 0);
2064# ifdef CHECK_INODE
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002065 dict_add_number(d, "inode", char_to_long(b0.b0_ino));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002066# endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002067 }
2068 }
2069 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002070 dict_add_string(d, "error", (char_u *)"Cannot read file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002071 close(fd);
2072 }
2073 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002074 dict_add_string(d, "error", (char_u *)"Cannot open file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002075}
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002076#endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002077
2078/*
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00002079 * Give information about an existing swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 * Returns timestamp (0 when unknown).
2081 */
2082 static time_t
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002083swapfile_info(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002085 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 int fd;
2087 struct block0 b0;
2088 time_t x = (time_t)0;
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00002089 char *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090#ifdef UNIX
2091 char_u uname[B0_UNAME_SIZE];
2092#endif
2093
2094 /* print the swap file date */
2095 if (mch_stat((char *)fname, &st) != -1)
2096 {
2097#ifdef UNIX
2098 /* print name of owner of the file */
2099 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
2100 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002101 msg_puts(_(" owned by: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 msg_outtrans(uname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002103 msg_puts(_(" dated: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 }
2105 else
2106#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002107 msg_puts(_(" dated: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00002109 p = ctime(&x); /* includes '\n' */
2110 if (p == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002111 msg_puts("(invalid)\n");
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00002112 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002113 msg_puts(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 }
2115
2116 /*
2117 * print the original file name
2118 */
2119 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2120 if (fd >= 0)
2121 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01002122 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 {
2124 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
2125 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002126 msg_puts(_(" [from Vim version 3.0]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002128 else if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002130 msg_puts(_(" [does not look like a Vim swap file]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 }
2132 else
2133 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002134 msg_puts(_(" file name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 if (b0.b0_fname[0] == NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002136 msg_puts(_("[No Name]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 else
2138 msg_outtrans(b0.b0_fname);
2139
Bram Moolenaar32526b32019-01-19 17:43:09 +01002140 msg_puts(_("\n modified: "));
2141 msg_puts(b0.b0_dirty ? _("YES") : _("no"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142
2143 if (*(b0.b0_uname) != NUL)
2144 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002145 msg_puts(_("\n user name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 msg_outtrans(b0.b0_uname);
2147 }
2148
2149 if (*(b0.b0_hname) != NUL)
2150 {
2151 if (*(b0.b0_uname) != NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002152 msg_puts(_(" host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002154 msg_puts(_("\n host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 msg_outtrans(b0.b0_hname);
2156 }
2157
2158 if (char_to_long(b0.b0_pid) != 0L)
2159 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002160 msg_puts(_("\n process ID: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 msg_outnum(char_to_long(b0.b0_pid));
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002162#if defined(UNIX) || defined(MSWIN)
2163 if (mch_process_running((pid_t)char_to_long(b0.b0_pid)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002165 msg_puts(_(" (STILL RUNNING)"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166# if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2167 process_still_running = TRUE;
2168# endif
2169 }
2170#endif
2171 }
2172
2173 if (b0_magic_wrong(&b0))
2174 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +01002175#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002177 msg_puts(_("\n [not usable with this version of Vim]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 else
2179#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002180 msg_puts(_("\n [not usable on this computer]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 }
2182 }
2183 }
2184 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002185 msg_puts(_(" [cannot be read]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 close(fd);
2187 }
2188 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002189 msg_puts(_(" [cannot be opened]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 msg_putchar('\n');
2191
2192 return x;
2193}
2194
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002195/*
2196 * Return TRUE if the swap file looks OK and there are no changes, thus it can
2197 * be safely deleted.
2198 */
2199 static time_t
2200swapfile_unchanged(char_u *fname)
2201{
2202 stat_T st;
2203 int fd;
2204 struct block0 b0;
2205 int ret = TRUE;
2206#ifdef UNIX
2207 long pid;
2208#endif
2209
2210 // must be able to stat the swap file
2211 if (mch_stat((char *)fname, &st) == -1)
2212 return FALSE;
2213
2214 // must be able to read the first block
2215 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2216 if (fd < 0)
2217 return FALSE;
2218 if (read_eintr(fd, &b0, sizeof(b0)) != sizeof(b0))
2219 {
2220 close(fd);
2221 return FALSE;
2222 }
2223
2224 // the ID and magic number must be correct
2225 if (ml_check_b0_id(&b0) == FAIL|| b0_magic_wrong(&b0))
2226 ret = FALSE;
2227
2228 // must be unchanged
2229 if (b0.b0_dirty)
2230 ret = FALSE;
2231
2232#if defined(UNIX) || defined(MSWIN)
2233 // process must known and not be running
2234 pid = char_to_long(b0.b0_pid);
2235 if (pid == 0L || mch_process_running((pid_t)pid))
2236 ret = FALSE;
2237#endif
2238
2239 // TODO: Should we check if the swap file was created on the current
2240 // system? And the current user?
2241
2242 close(fd);
2243 return ret;
2244}
2245
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002247recov_file_names(char_u **names, char_u *path, int prepend_dot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248{
2249 int num_names;
2250
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 /*
2252 * (Win32 and Win64) never short names, but do prepend a dot.
2253 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
2254 * Only use the short name if it is different.
2255 */
2256 char_u *p;
2257 int i;
Bram Moolenaar4f974752019-02-17 17:44:42 +01002258# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 int shortname = curbuf->b_shortname;
2260
2261 curbuf->b_shortname = FALSE;
2262# endif
2263
2264 num_names = 0;
2265
2266 /*
2267 * May also add the file name with a dot prepended, for swap file in same
2268 * dir as original file.
2269 */
2270 if (prepend_dot)
2271 {
2272 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
2273 if (names[num_names] == NULL)
2274 goto end;
2275 ++num_names;
2276 }
2277
2278 /*
2279 * Form the normal swap file name pattern by appending ".sw?".
2280 */
2281#ifdef VMS
2282 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
2283#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285#endif
2286 if (names[num_names] == NULL)
2287 goto end;
2288 if (num_names >= 1) /* check if we have the same name twice */
2289 {
2290 p = names[num_names - 1];
2291 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
2292 if (i > 0)
2293 p += i; /* file name has been expanded to full path */
2294
2295 if (STRCMP(p, names[num_names]) != 0)
2296 ++num_names;
2297 else
2298 vim_free(names[num_names]);
2299 }
2300 else
2301 ++num_names;
2302
Bram Moolenaar4f974752019-02-17 17:44:42 +01002303# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 /*
2305 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
2306 */
2307 curbuf->b_shortname = TRUE;
2308#ifdef VMS
2309 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
2310#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312#endif
2313 if (names[num_names] == NULL)
2314 goto end;
2315
2316 /*
2317 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
2318 */
2319 p = names[num_names];
2320 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
2321 if (i > 0)
2322 p += i; /* file name has been expanded to full path */
2323 if (STRCMP(names[num_names - 1], p) == 0)
2324 vim_free(names[num_names]);
2325 else
2326 ++num_names;
2327# endif
2328
2329end:
Bram Moolenaar4f974752019-02-17 17:44:42 +01002330# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 curbuf->b_shortname = shortname;
2332# endif
2333
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 return num_names;
2335}
2336
2337/*
2338 * sync all memlines
2339 *
2340 * If 'check_file' is TRUE, check if original file exists and was not changed.
2341 * If 'check_char' is TRUE, stop syncing when character becomes available, but
2342 * always sync at least one block.
2343 */
2344 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002345ml_sync_all(int check_file, int check_char)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346{
2347 buf_T *buf;
Bram Moolenaar8767f522016-07-01 17:17:39 +02002348 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349
Bram Moolenaar29323592016-07-24 22:04:11 +02002350 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 {
2352 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
2353 continue; /* no file */
2354
2355 ml_flush_line(buf); /* flush buffered line */
2356 /* flush locked block */
2357 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
2358 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
2359 && buf->b_ffname != NULL)
2360 {
2361 /*
2362 * If the original file does not exist anymore or has been changed
2363 * call ml_preserve() to get rid of all negative numbered blocks.
2364 */
2365 if (mch_stat((char *)buf->b_ffname, &st) == -1
2366 || st.st_mtime != buf->b_mtime_read
Bram Moolenaar914703b2010-05-31 21:59:46 +02002367 || st.st_size != buf->b_orig_size)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 {
2369 ml_preserve(buf, FALSE);
2370 did_check_timestamps = FALSE;
2371 need_check_timestamps = TRUE; /* give message later */
2372 }
2373 }
2374 if (buf->b_ml.ml_mfp->mf_dirty)
2375 {
2376 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
2377 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
2378 if (check_char && ui_char_avail()) /* character available now */
2379 break;
2380 }
2381 }
2382}
2383
2384/*
2385 * sync one buffer, including negative blocks
2386 *
2387 * after this all the blocks are in the swap file
2388 *
2389 * Used for the :preserve command and when the original file has been
2390 * changed or deleted.
2391 *
2392 * when message is TRUE the success of preserving is reported
2393 */
2394 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002395ml_preserve(buf_T *buf, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396{
2397 bhdr_T *hp;
2398 linenr_T lnum;
2399 memfile_T *mfp = buf->b_ml.ml_mfp;
2400 int status;
2401 int got_int_save = got_int;
2402
2403 if (mfp == NULL || mfp->mf_fname == NULL)
2404 {
2405 if (message)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002406 emsg(_("E313: Cannot preserve, there is no swap file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 return;
2408 }
2409
2410 /* We only want to stop when interrupted here, not when interrupted
2411 * before. */
2412 got_int = FALSE;
2413
2414 ml_flush_line(buf); /* flush buffered line */
2415 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2416 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2417
2418 /* stack is invalid after mf_sync(.., MFS_ALL) */
2419 buf->b_ml.ml_stack_top = 0;
2420
2421 /*
2422 * Some of the data blocks may have been changed from negative to
2423 * positive block number. In that case the pointer blocks need to be
2424 * updated.
2425 *
2426 * We don't know in which pointer block the references are, so we visit
2427 * all data blocks until there are no more translations to be done (or
2428 * we hit the end of the file, which can only happen in case a write fails,
2429 * e.g. when file system if full).
2430 * ml_find_line() does the work by translating the negative block numbers
2431 * when getting the first line of each data block.
2432 */
2433 if (mf_need_trans(mfp) && !got_int)
2434 {
2435 lnum = 1;
2436 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2437 {
2438 hp = ml_find_line(buf, lnum, ML_FIND);
2439 if (hp == NULL)
2440 {
2441 status = FAIL;
2442 goto theend;
2443 }
2444 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2445 lnum = buf->b_ml.ml_locked_high + 1;
2446 }
2447 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2448 /* sync the updated pointer blocks */
2449 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2450 status = FAIL;
2451 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2452 }
2453theend:
2454 got_int |= got_int_save;
2455
2456 if (message)
2457 {
2458 if (status == OK)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002459 msg(_("File preserved"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002461 emsg(_("E314: Preserve failed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 }
2463}
2464
2465/*
2466 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2467 * until the next call!
2468 * line1 = ml_get(1);
2469 * line2 = ml_get(2); // line1 is now invalid!
2470 * Make a copy of the line if necessary.
2471 */
2472/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002473 * Return a pointer to a (read-only copy of a) line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 *
2475 * On failure an error message is given and IObuff is returned (to avoid
2476 * having to check for error everywhere).
2477 */
2478 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002479ml_get(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480{
2481 return ml_get_buf(curbuf, lnum, FALSE);
2482}
2483
2484/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002485 * Return pointer to position "pos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 */
2487 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002488ml_get_pos(pos_T *pos)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489{
2490 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2491}
2492
2493/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002494 * Return pointer to cursor line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 */
2496 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002497ml_get_curline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498{
2499 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2500}
2501
2502/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002503 * Return pointer to cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 */
2505 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002506ml_get_cursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507{
2508 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2509 curwin->w_cursor.col);
2510}
2511
2512/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002513 * Return a pointer to a line in a specific buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 *
2515 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2516 * changed)
2517 */
2518 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002519ml_get_buf(
2520 buf_T *buf,
2521 linenr_T lnum,
2522 int will_change) /* line will be changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523{
Bram Moolenaarad40f022007-02-13 03:01:39 +00002524 bhdr_T *hp;
2525 DATA_BL *dp;
Bram Moolenaarad40f022007-02-13 03:01:39 +00002526 static int recursive = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527
2528 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2529 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002530 if (recursive == 0)
2531 {
2532 /* Avoid giving this message for a recursive call, may happen when
2533 * the GUI redraws part of the text. */
2534 ++recursive;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002535 siemsg(_("E315: ml_get: invalid lnum: %ld"), lnum);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002536 --recursive;
2537 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538errorret:
2539 STRCPY(IObuff, "???");
2540 return IObuff;
2541 }
2542 if (lnum <= 0) /* pretend line 0 is line 1 */
2543 lnum = 1;
2544
2545 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2546 return (char_u *)"";
2547
Bram Moolenaar37d619f2010-03-10 14:46:26 +01002548 /*
2549 * See if it is the same line as requested last time.
2550 * Otherwise may need to flush last used line.
2551 * Don't use the last used line when 'swapfile' is reset, need to load all
2552 * blocks.
2553 */
Bram Moolenaar47b8b152007-02-07 02:41:57 +00002554 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002556 unsigned start, end;
2557 colnr_T len;
2558 int idx;
2559
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 ml_flush_line(buf);
2561
2562 /*
2563 * Find the data block containing the line.
2564 * This also fills the stack with the blocks from the root to the data
2565 * block and releases any locked block.
2566 */
2567 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2568 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002569 if (recursive == 0)
2570 {
2571 /* Avoid giving this message for a recursive call, may happen
2572 * when the GUI redraws part of the text. */
2573 ++recursive;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002574 siemsg(_("E316: ml_get: cannot find line %ld"), lnum);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002575 --recursive;
2576 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 goto errorret;
2578 }
2579
2580 dp = (DATA_BL *)(hp->bh_data);
2581
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002582 idx = lnum - buf->b_ml.ml_locked_low;
2583 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2584 // The text ends where the previous line starts. The first line ends
2585 // at the end of the block.
2586 if (idx == 0)
2587 end = dp->db_txt_end;
2588 else
2589 end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
2590 len = end - start;
2591
2592 buf->b_ml.ml_line_ptr = (char_u *)dp + start;
2593 buf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 buf->b_ml.ml_line_lnum = lnum;
2595 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2596 }
2597 if (will_change)
2598 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2599
2600 return buf->b_ml.ml_line_ptr;
2601}
2602
2603/*
2604 * Check if a line that was just obtained by a call to ml_get
2605 * is in allocated memory.
2606 */
2607 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002608ml_line_alloced(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609{
2610 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2611}
2612
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002613#ifdef FEAT_TEXT_PROP
2614 static void
2615add_text_props_for_append(
2616 buf_T *buf,
2617 linenr_T lnum,
2618 char_u **line,
2619 int *len,
2620 char_u **tofree)
2621{
2622 int round;
2623 int new_prop_count = 0;
2624 int count;
2625 int n;
2626 char_u *props;
2627 int new_len;
2628 char_u *new_line;
2629 textprop_T prop;
2630
2631 // Make two rounds:
2632 // 1. calculate the extra space needed
2633 // 2. allocate the space and fill it
2634 for (round = 1; round <= 2; ++round)
2635 {
2636 if (round == 2)
2637 {
2638 if (new_prop_count == 0)
2639 return; // nothing to do
2640 new_len = *len + new_prop_count * sizeof(textprop_T);
2641 new_line = alloc((unsigned)new_len);
2642 if (new_line == NULL)
2643 return;
2644 mch_memmove(new_line, *line, *len);
2645 new_prop_count = 0;
2646 }
2647
2648 // Get the line above to find any props that continue in the next
2649 // line.
2650 count = get_text_props(buf, lnum, &props, FALSE);
2651 for (n = 0; n < count; ++n)
2652 {
2653 mch_memmove(&prop, props + n * sizeof(textprop_T), sizeof(textprop_T));
2654 if (prop.tp_flags & TP_FLAG_CONT_NEXT)
2655 {
2656 if (round == 2)
2657 {
2658 prop.tp_flags |= TP_FLAG_CONT_PREV;
2659 prop.tp_col = 1;
2660 prop.tp_len = *len;
2661 mch_memmove(new_line + *len + new_prop_count * sizeof(textprop_T), &prop, sizeof(textprop_T));
2662 }
2663 ++new_prop_count;
2664 }
2665 }
2666 }
2667 *line = new_line;
2668 *tofree = new_line;
2669 *len = new_len;
2670}
2671#endif
2672
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673/*
2674 * Append a line after lnum (may be 0 to insert a line in front of the file).
2675 * "line" does not need to be allocated, but can't be another line in a
2676 * buffer, unlocking may make it invalid.
2677 *
2678 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2679 * will be set for recovery
2680 * Check: The caller of this function should probably also call
2681 * appended_lines().
2682 *
2683 * return FAIL for failure, OK otherwise
2684 */
2685 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002686ml_append(
2687 linenr_T lnum, /* append after this line (can be 0) */
2688 char_u *line, /* text of the new line */
2689 colnr_T len, /* length of new line, including NUL, or 0 */
2690 int newfile) /* flag, see above */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691{
2692 /* When starting up, we might still need to create the memfile */
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002693 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 return FAIL;
2695
2696 if (curbuf->b_ml.ml_line_lnum != 0)
2697 ml_flush_line(curbuf);
2698 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2699}
2700
Bram Moolenaar4033c552017-09-16 20:54:51 +02002701#if defined(FEAT_SPELL) || defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar4770d092006-01-12 23:22:24 +00002702/*
2703 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2704 * a memline.
2705 */
2706 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002707ml_append_buf(
2708 buf_T *buf,
2709 linenr_T lnum, /* append after this line (can be 0) */
2710 char_u *line, /* text of the new line */
2711 colnr_T len, /* length of new line, including NUL, or 0 */
2712 int newfile) /* flag, see above */
Bram Moolenaar4770d092006-01-12 23:22:24 +00002713{
2714 if (buf->b_ml.ml_mfp == NULL)
2715 return FAIL;
2716
2717 if (buf->b_ml.ml_line_lnum != 0)
2718 ml_flush_line(buf);
2719 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2720}
2721#endif
2722
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002724ml_append_int(
2725 buf_T *buf,
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002726 linenr_T lnum, // append after this line (can be 0)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002727 char_u *line_arg, // text of the new line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002728 colnr_T len_arg, // length of line, including NUL, or 0
2729 int newfile, // flag, see above
2730 int mark) // mark the new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731{
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002732 char_u *line = line_arg;
2733 colnr_T len = len_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 int i;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002735 int line_count; // number of indexes in current block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 int offset;
2737 int from, to;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002738 int space_needed; // space needed for new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 int page_size;
2740 int page_count;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002741 int db_idx; // index for lnum in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 bhdr_T *hp;
2743 memfile_T *mfp;
2744 DATA_BL *dp;
2745 PTR_BL *pp;
2746 infoptr_T *ip;
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002747#ifdef FEAT_TEXT_PROP
2748 char_u *tofree = NULL;
2749#endif
2750 int ret = FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002753 return FAIL; // lnum out of range
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754
2755 if (lowest_marked && lowest_marked > lnum)
2756 lowest_marked = lnum + 1;
2757
2758 if (len == 0)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002759 len = (colnr_T)STRLEN(line) + 1; // space needed for the text
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002760
2761#ifdef FEAT_TEXT_PROP
2762 if (curbuf->b_has_textprop && lnum > 0)
2763 // Add text properties that continue from the previous line.
2764 add_text_props_for_append(buf, lnum, &line, &len, &tofree);
2765#endif
2766
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002767 space_needed = len + INDEX_SIZE; // space needed for text + index
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768
2769 mfp = buf->b_ml.ml_mfp;
2770 page_size = mfp->mf_page_size;
2771
2772/*
2773 * find the data block containing the previous line
2774 * This also fills the stack with the blocks from the root to the data block
2775 * This also releases any locked block.
2776 */
2777 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2778 ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002779 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780
2781 buf->b_ml.ml_flags &= ~ML_EMPTY;
2782
2783 if (lnum == 0) /* got line one instead, correct db_idx */
2784 db_idx = -1; /* careful, it is negative! */
2785 else
2786 db_idx = lnum - buf->b_ml.ml_locked_low;
2787 /* get line count before the insertion */
2788 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2789
2790 dp = (DATA_BL *)(hp->bh_data);
2791
2792/*
2793 * If
2794 * - there is not enough room in the current block
2795 * - appending to the last line in the block
2796 * - not appending to the last line in the file
2797 * insert in front of the next block.
2798 */
2799 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2800 && lnum < buf->b_ml.ml_line_count)
2801 {
2802 /*
2803 * Now that the line is not going to be inserted in the block that we
2804 * expected, the line count has to be adjusted in the pointer blocks
2805 * by using ml_locked_lineadd.
2806 */
2807 --(buf->b_ml.ml_locked_lineadd);
2808 --(buf->b_ml.ml_locked_high);
2809 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002810 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811
2812 db_idx = -1; /* careful, it is negative! */
2813 /* get line count before the insertion */
2814 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2815 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2816
2817 dp = (DATA_BL *)(hp->bh_data);
2818 }
2819
2820 ++buf->b_ml.ml_line_count;
2821
2822 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2823 {
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002824 /*
2825 * Insert the new line in an existing data block, or in the data block
2826 * allocated above.
2827 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 dp->db_txt_start -= len;
2829 dp->db_free -= space_needed;
2830 ++(dp->db_line_count);
2831
2832 /*
2833 * move the text of the lines that follow to the front
2834 * adjust the indexes of the lines that follow
2835 */
2836 if (line_count > db_idx + 1) /* if there are following lines */
2837 {
2838 /*
2839 * Offset is the start of the previous line.
2840 * This will become the character just after the new line.
2841 */
2842 if (db_idx < 0)
2843 offset = dp->db_txt_end;
2844 else
2845 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2846 mch_memmove((char *)dp + dp->db_txt_start,
2847 (char *)dp + dp->db_txt_start + len,
2848 (size_t)(offset - (dp->db_txt_start + len)));
2849 for (i = line_count - 1; i > db_idx; --i)
2850 dp->db_index[i + 1] = dp->db_index[i] - len;
2851 dp->db_index[db_idx + 1] = offset - len;
2852 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002853 else
2854 // add line at the end (which is the start of the text)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 dp->db_index[db_idx + 1] = dp->db_txt_start;
2856
2857 /*
2858 * copy the text into the block
2859 */
2860 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2861 if (mark)
2862 dp->db_index[db_idx + 1] |= DB_MARKED;
2863
2864 /*
2865 * Mark the block dirty.
2866 */
2867 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2868 if (!newfile)
2869 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2870 }
2871 else /* not enough space in data block */
2872 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 long line_count_left, line_count_right;
2874 int page_count_left, page_count_right;
2875 bhdr_T *hp_left;
2876 bhdr_T *hp_right;
2877 bhdr_T *hp_new;
2878 int lines_moved;
2879 int data_moved = 0; /* init to shut up gcc */
2880 int total_moved = 0; /* init to shut up gcc */
2881 DATA_BL *dp_right, *dp_left;
2882 int stack_idx;
2883 int in_left;
2884 int lineadd;
2885 blocknr_T bnum_left, bnum_right;
2886 linenr_T lnum_left, lnum_right;
2887 int pb_idx;
2888 PTR_BL *pp_new;
2889
2890 /*
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002891 * There is not enough room, we have to create a new data block and
2892 * copy some lines into it.
2893 * Then we have to insert an entry in the pointer block.
2894 * If this pointer block also is full, we go up another block, and so
2895 * on, up to the root if necessary.
2896 * The line counts in the pointer blocks have already been adjusted by
2897 * ml_find_line().
2898 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 * We are going to allocate a new data block. Depending on the
2900 * situation it will be put to the left or right of the existing
2901 * block. If possible we put the new line in the left block and move
2902 * the lines after it to the right block. Otherwise the new line is
2903 * also put in the right block. This method is more efficient when
2904 * inserting a lot of lines at one place.
2905 */
2906 if (db_idx < 0) /* left block is new, right block is existing */
2907 {
2908 lines_moved = 0;
2909 in_left = TRUE;
2910 /* space_needed does not change */
2911 }
2912 else /* left block is existing, right block is new */
2913 {
2914 lines_moved = line_count - db_idx - 1;
2915 if (lines_moved == 0)
2916 in_left = FALSE; /* put new line in right block */
2917 /* space_needed does not change */
2918 else
2919 {
2920 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2921 dp->db_txt_start;
2922 total_moved = data_moved + lines_moved * INDEX_SIZE;
2923 if ((int)dp->db_free + total_moved >= space_needed)
2924 {
2925 in_left = TRUE; /* put new line in left block */
2926 space_needed = total_moved;
2927 }
2928 else
2929 {
2930 in_left = FALSE; /* put new line in right block */
2931 space_needed += total_moved;
2932 }
2933 }
2934 }
2935
2936 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2937 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2938 {
2939 /* correct line counts in pointer blocks */
2940 --(buf->b_ml.ml_locked_lineadd);
2941 --(buf->b_ml.ml_locked_high);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002942 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 }
2944 if (db_idx < 0) /* left block is new */
2945 {
2946 hp_left = hp_new;
2947 hp_right = hp;
2948 line_count_left = 0;
2949 line_count_right = line_count;
2950 }
2951 else /* right block is new */
2952 {
2953 hp_left = hp;
2954 hp_right = hp_new;
2955 line_count_left = line_count;
2956 line_count_right = 0;
2957 }
2958 dp_right = (DATA_BL *)(hp_right->bh_data);
2959 dp_left = (DATA_BL *)(hp_left->bh_data);
2960 bnum_left = hp_left->bh_bnum;
2961 bnum_right = hp_right->bh_bnum;
2962 page_count_left = hp_left->bh_page_count;
2963 page_count_right = hp_right->bh_page_count;
2964
2965 /*
2966 * May move the new line into the right/new block.
2967 */
2968 if (!in_left)
2969 {
2970 dp_right->db_txt_start -= len;
2971 dp_right->db_free -= len + INDEX_SIZE;
2972 dp_right->db_index[0] = dp_right->db_txt_start;
2973 if (mark)
2974 dp_right->db_index[0] |= DB_MARKED;
2975
2976 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2977 line, (size_t)len);
2978 ++line_count_right;
2979 }
2980 /*
2981 * may move lines from the left/old block to the right/new one.
2982 */
2983 if (lines_moved)
2984 {
2985 /*
2986 */
2987 dp_right->db_txt_start -= data_moved;
2988 dp_right->db_free -= total_moved;
2989 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2990 (char *)dp_left + dp_left->db_txt_start,
2991 (size_t)data_moved);
2992 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2993 dp_left->db_txt_start += data_moved;
2994 dp_left->db_free += total_moved;
2995
2996 /*
2997 * update indexes in the new block
2998 */
2999 for (to = line_count_right, from = db_idx + 1;
3000 from < line_count_left; ++from, ++to)
3001 dp_right->db_index[to] = dp->db_index[from] + offset;
3002 line_count_right += lines_moved;
3003 line_count_left -= lines_moved;
3004 }
3005
3006 /*
3007 * May move the new line into the left (old or new) block.
3008 */
3009 if (in_left)
3010 {
3011 dp_left->db_txt_start -= len;
3012 dp_left->db_free -= len + INDEX_SIZE;
3013 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
3014 if (mark)
3015 dp_left->db_index[line_count_left] |= DB_MARKED;
3016 mch_memmove((char *)dp_left + dp_left->db_txt_start,
3017 line, (size_t)len);
3018 ++line_count_left;
3019 }
3020
3021 if (db_idx < 0) /* left block is new */
3022 {
3023 lnum_left = lnum + 1;
3024 lnum_right = 0;
3025 }
3026 else /* right block is new */
3027 {
3028 lnum_left = 0;
3029 if (in_left)
3030 lnum_right = lnum + 2;
3031 else
3032 lnum_right = lnum + 1;
3033 }
3034 dp_left->db_line_count = line_count_left;
3035 dp_right->db_line_count = line_count_right;
3036
3037 /*
3038 * release the two data blocks
3039 * The new one (hp_new) already has a correct blocknumber.
3040 * The old one (hp, in ml_locked) gets a positive blocknumber if
3041 * we changed it and we are not editing a new file.
3042 */
3043 if (lines_moved || in_left)
3044 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3045 if (!newfile && db_idx >= 0 && in_left)
3046 buf->b_ml.ml_flags |= ML_LOCKED_POS;
3047 mf_put(mfp, hp_new, TRUE, FALSE);
3048
3049 /*
3050 * flush the old data block
3051 * set ml_locked_lineadd to 0, because the updating of the
3052 * pointer blocks is done below
3053 */
3054 lineadd = buf->b_ml.ml_locked_lineadd;
3055 buf->b_ml.ml_locked_lineadd = 0;
3056 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
3057
3058 /*
3059 * update pointer blocks for the new data block
3060 */
3061 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3062 --stack_idx)
3063 {
3064 ip = &(buf->b_ml.ml_stack[stack_idx]);
3065 pb_idx = ip->ip_index;
3066 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003067 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3069 if (pp->pb_id != PTR_ID)
3070 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003071 iemsg(_("E317: pointer block id wrong 3"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003073 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 }
3075 /*
3076 * TODO: If the pointer block is full and we are adding at the end
3077 * try to insert in front of the next block
3078 */
3079 /* block not full, add one entry */
3080 if (pp->pb_count < pp->pb_count_max)
3081 {
3082 if (pb_idx + 1 < (int)pp->pb_count)
3083 mch_memmove(&pp->pb_pointer[pb_idx + 2],
3084 &pp->pb_pointer[pb_idx + 1],
3085 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
3086 ++pp->pb_count;
3087 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3088 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3089 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3090 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3091 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3092 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3093
3094 if (lnum_left != 0)
3095 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3096 if (lnum_right != 0)
3097 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3098
3099 mf_put(mfp, hp, TRUE, FALSE);
3100 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
3101
3102 if (lineadd)
3103 {
3104 --(buf->b_ml.ml_stack_top);
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003105 /* fix line count for rest of blocks in the stack */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 ml_lineadd(buf, lineadd);
3107 /* fix stack itself */
3108 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
3109 lineadd;
3110 ++(buf->b_ml.ml_stack_top);
3111 }
3112
3113 /*
3114 * We are finished, break the loop here.
3115 */
3116 break;
3117 }
3118 else /* pointer block full */
3119 {
3120 /*
3121 * split the pointer block
3122 * allocate a new pointer block
3123 * move some of the pointer into the new block
3124 * prepare for updating the parent block
3125 */
3126 for (;;) /* do this twice when splitting block 1 */
3127 {
3128 hp_new = ml_new_ptr(mfp);
3129 if (hp_new == NULL) /* TODO: try to fix tree */
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003130 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 pp_new = (PTR_BL *)(hp_new->bh_data);
3132
3133 if (hp->bh_bnum != 1)
3134 break;
3135
3136 /*
3137 * if block 1 becomes full the tree is given an extra level
3138 * The pointers from block 1 are moved into the new block.
3139 * block 1 is updated to point to the new block
3140 * then continue to split the new block
3141 */
3142 mch_memmove(pp_new, pp, (size_t)page_size);
3143 pp->pb_count = 1;
3144 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
3145 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
3146 pp->pb_pointer[0].pe_old_lnum = 1;
3147 pp->pb_pointer[0].pe_page_count = 1;
3148 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
3149 hp = hp_new; /* new block is to be split */
3150 pp = pp_new;
3151 CHECK(stack_idx != 0, _("stack_idx should be 0"));
3152 ip->ip_index = 0;
3153 ++stack_idx; /* do block 1 again later */
3154 }
3155 /*
3156 * move the pointers after the current one to the new block
3157 * If there are none, the new entry will be in the new block.
3158 */
3159 total_moved = pp->pb_count - pb_idx - 1;
3160 if (total_moved)
3161 {
3162 mch_memmove(&pp_new->pb_pointer[0],
3163 &pp->pb_pointer[pb_idx + 1],
3164 (size_t)(total_moved) * sizeof(PTR_EN));
3165 pp_new->pb_count = total_moved;
3166 pp->pb_count -= total_moved - 1;
3167 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3168 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3169 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3170 if (lnum_right)
3171 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3172 }
3173 else
3174 {
3175 pp_new->pb_count = 1;
3176 pp_new->pb_pointer[0].pe_bnum = bnum_right;
3177 pp_new->pb_pointer[0].pe_line_count = line_count_right;
3178 pp_new->pb_pointer[0].pe_page_count = page_count_right;
3179 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
3180 }
3181 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3182 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3183 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3184 if (lnum_left)
3185 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3186 lnum_left = 0;
3187 lnum_right = 0;
3188
3189 /*
3190 * recompute line counts
3191 */
3192 line_count_right = 0;
3193 for (i = 0; i < (int)pp_new->pb_count; ++i)
3194 line_count_right += pp_new->pb_pointer[i].pe_line_count;
3195 line_count_left = 0;
3196 for (i = 0; i < (int)pp->pb_count; ++i)
3197 line_count_left += pp->pb_pointer[i].pe_line_count;
3198
3199 bnum_left = hp->bh_bnum;
3200 bnum_right = hp_new->bh_bnum;
3201 page_count_left = 1;
3202 page_count_right = 1;
3203 mf_put(mfp, hp, TRUE, FALSE);
3204 mf_put(mfp, hp_new, TRUE, FALSE);
3205 }
3206 }
3207
3208 /*
3209 * Safety check: fallen out of for loop?
3210 */
3211 if (stack_idx < 0)
3212 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003213 iemsg(_("E318: Updated too many blocks?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
3215 }
3216 }
3217
3218#ifdef FEAT_BYTEOFF
3219 /* The line was inserted below 'lnum' */
3220 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
3221#endif
3222#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003223 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 {
3225 if (STRLEN(line) > 0)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003226 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003227 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 (char_u *)"\n", 1);
3229 }
3230#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01003231#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003232 if (buf->b_write_to_channel)
3233 channel_write_new_lines(buf);
3234#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003235 ret = OK;
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003236
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003237theend:
3238#ifdef FEAT_TEXT_PROP
3239 vim_free(tofree);
3240#endif
3241 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242}
3243
3244/*
Bram Moolenaar4770d092006-01-12 23:22:24 +00003245 * Replace line lnum, with buffering, in current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 *
Bram Moolenaar1056d982006-03-09 22:37:52 +00003247 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 * copied to allocated memory already.
3249 *
3250 * Check: The caller of this function should probably also call
3251 * changed_lines(), unless update_screen(NOT_VALID) is used.
3252 *
3253 * return FAIL for failure, OK otherwise
3254 */
3255 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003256ml_replace(linenr_T lnum, char_u *line, int copy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257{
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003258 colnr_T len = -1;
3259
3260 if (line != NULL)
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003261 len = (colnr_T)STRLEN(line);
Bram Moolenaarccae4672019-01-04 15:09:57 +01003262 return ml_replace_len(lnum, line, len, FALSE, copy);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003263}
3264
Bram Moolenaarccae4672019-01-04 15:09:57 +01003265/*
3266 * Replace a line for the current buffer. Like ml_replace() with:
3267 * "len_arg" is the length of the text, excluding NUL.
3268 * If "has_props" is TRUE then "line_arg" includes the text properties and
3269 * "len_arg" includes the NUL of the text.
3270 */
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003271 int
Bram Moolenaarccae4672019-01-04 15:09:57 +01003272ml_replace_len(
3273 linenr_T lnum,
3274 char_u *line_arg,
3275 colnr_T len_arg,
3276 int has_props,
3277 int copy)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003278{
3279 char_u *line = line_arg;
3280 colnr_T len = len_arg;
3281
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 if (line == NULL) /* just checking... */
3283 return FAIL;
3284
3285 /* When starting up, we might still need to create the memfile */
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003286 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 return FAIL;
3288
Bram Moolenaarccae4672019-01-04 15:09:57 +01003289 if (!has_props)
3290 ++len; // include the NUL after the text
3291 if (copy)
3292 {
3293 // copy the line to allocated memory
3294#ifdef FEAT_TEXT_PROP
3295 if (has_props)
3296 line = vim_memsave(line, len);
3297 else
3298#endif
3299 line = vim_strnsave(line, len - 1);
3300 if (line == NULL)
3301 return FAIL;
3302 }
3303
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003305 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 {
3307 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003308 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 }
3310#endif
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003311 if (curbuf->b_ml.ml_line_lnum != lnum)
3312 {
3313 // another line is buffered, flush it
3314 ml_flush_line(curbuf);
Bram Moolenaarca79a5f2018-12-13 23:16:36 +01003315 curbuf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003316
3317#ifdef FEAT_TEXT_PROP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003318 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003319 // Need to fetch the old line to copy over any text properties.
3320 ml_get_buf(curbuf, lnum, TRUE);
3321#endif
3322 }
3323
3324#ifdef FEAT_TEXT_PROP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003325 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003326 {
3327 size_t oldtextlen = STRLEN(curbuf->b_ml.ml_line_ptr) + 1;
3328
3329 if (oldtextlen < (size_t)curbuf->b_ml.ml_line_len)
3330 {
3331 char_u *newline;
3332 size_t textproplen = curbuf->b_ml.ml_line_len - oldtextlen;
3333
3334 // Need to copy over text properties, stored after the text.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003335 newline = alloc(len + (int)textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003336 if (newline != NULL)
3337 {
Bram Moolenaarccae4672019-01-04 15:09:57 +01003338 mch_memmove(newline, line, len);
3339 mch_memmove(newline + len, curbuf->b_ml.ml_line_ptr + oldtextlen, textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003340 vim_free(line);
3341 line = newline;
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003342 len += (colnr_T)textproplen;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003343 }
3344 }
3345 }
3346#endif
3347
Bram Moolenaarccae4672019-01-04 15:09:57 +01003348 if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) // same line allocated
3349 vim_free(curbuf->b_ml.ml_line_ptr); // free it
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003350
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 curbuf->b_ml.ml_line_ptr = line;
Bram Moolenaarccae4672019-01-04 15:09:57 +01003352 curbuf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 curbuf->b_ml.ml_line_lnum = lnum;
3354 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
3355
3356 return OK;
3357}
3358
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003359#ifdef FEAT_TEXT_PROP
3360/*
3361 * Adjust text properties in line "lnum" for a deleted line.
3362 * When "above" is true this is the line above the deleted line.
3363 * "del_props" are the properties of the deleted line.
3364 */
3365 static void
3366adjust_text_props_for_delete(
3367 buf_T *buf,
3368 linenr_T lnum,
3369 char_u *del_props,
3370 int del_props_len,
3371 int above)
3372{
3373 int did_get_line = FALSE;
3374 int done_del;
3375 int done_this;
3376 textprop_T prop_del;
3377 textprop_T prop_this;
3378 bhdr_T *hp;
3379 DATA_BL *dp;
3380 int idx;
3381 int line_start;
3382 long line_size;
3383 int this_props_len;
3384 char_u *text;
3385 size_t textlen;
3386 int found;
3387
3388 for (done_del = 0; done_del < del_props_len; done_del += sizeof(textprop_T))
3389 {
3390 mch_memmove(&prop_del, del_props + done_del, sizeof(textprop_T));
3391 if ((above && (prop_del.tp_flags & TP_FLAG_CONT_PREV)
3392 && !(prop_del.tp_flags & TP_FLAG_CONT_NEXT))
3393 || (!above && (prop_del.tp_flags & TP_FLAG_CONT_NEXT)
3394 && !(prop_del.tp_flags & TP_FLAG_CONT_PREV)))
3395 {
3396 if (!did_get_line)
3397 {
3398 did_get_line = TRUE;
3399 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
3400 return;
3401
3402 dp = (DATA_BL *)(hp->bh_data);
3403 idx = lnum - buf->b_ml.ml_locked_low;
3404 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3405 if (idx == 0) // first line in block, text at the end
3406 line_size = dp->db_txt_end - line_start;
3407 else
3408 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
3409 text = (char_u *)dp + line_start;
3410 textlen = STRLEN(text) + 1;
3411 if ((long)textlen >= line_size)
3412 {
3413 if (above)
3414 internal_error("no text property above deleted line");
3415 else
3416 internal_error("no text property below deleted line");
3417 return;
3418 }
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01003419 this_props_len = line_size - (int)textlen;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003420 }
3421
3422 found = FALSE;
3423 for (done_this = 0; done_this < this_props_len; done_this += sizeof(textprop_T))
3424 {
3425 mch_memmove(&prop_this, text + textlen + done_del, sizeof(textprop_T));
3426 if (prop_del.tp_id == prop_this.tp_id
3427 && prop_del.tp_type == prop_this.tp_type)
3428 {
3429 int flag = above ? TP_FLAG_CONT_NEXT : TP_FLAG_CONT_PREV;
3430
3431 found = TRUE;
3432 if (prop_this.tp_flags & flag)
3433 {
3434 prop_this.tp_flags &= ~flag;
3435 mch_memmove(text + textlen + done_del, &prop_this, sizeof(textprop_T));
3436 }
3437 else if (above)
3438 internal_error("text property above deleted line does not continue");
3439 else
3440 internal_error("text property below deleted line does not continue");
3441 }
3442 }
3443 if (!found)
3444 {
3445 if (above)
3446 internal_error("text property above deleted line not found");
3447 else
3448 internal_error("text property below deleted line not found");
3449 }
3450
3451 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3452 }
3453 }
3454}
3455#endif
3456
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457/*
Bram Moolenaar4033c552017-09-16 20:54:51 +02003458 * Delete line "lnum" in the current buffer.
3459 * When "message" is TRUE may give a "No lines in buffer" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 *
3461 * Check: The caller of this function should probably also call
3462 * deleted_lines() after this.
3463 *
3464 * return FAIL for failure, OK otherwise
3465 */
3466 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003467ml_delete(linenr_T lnum, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468{
3469 ml_flush_line(curbuf);
3470 return ml_delete_int(curbuf, lnum, message);
3471}
3472
3473 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003474ml_delete_int(buf_T *buf, linenr_T lnum, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475{
3476 bhdr_T *hp;
3477 memfile_T *mfp;
3478 DATA_BL *dp;
3479 PTR_BL *pp;
3480 infoptr_T *ip;
3481 int count; /* number of entries in block */
3482 int idx;
3483 int stack_idx;
3484 int text_start;
3485 int line_start;
3486 long line_size;
3487 int i;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003488 int ret = FAIL;
3489#ifdef FEAT_TEXT_PROP
3490 char_u *textprop_save = NULL;
3491 int textprop_save_len;
3492#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493
3494 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
3495 return FAIL;
3496
3497 if (lowest_marked && lowest_marked > lnum)
3498 lowest_marked--;
3499
3500/*
3501 * If the file becomes empty the last line is replaced by an empty line.
3502 */
3503 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
3504 {
3505 if (message
3506#ifdef FEAT_NETBEANS_INTG
3507 && !netbeansSuppressNoLines
3508#endif
3509 )
Bram Moolenaar238a5642006-02-21 22:12:05 +00003510 set_keep_msg((char_u *)_(no_lines_msg), 0);
3511
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02003512 /* FEAT_BYTEOFF already handled in there, don't worry 'bout it below */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
3514 buf->b_ml.ml_flags |= ML_EMPTY;
3515
3516 return i;
3517 }
3518
3519/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003520 * Find the data block containing the line.
3521 * This also fills the stack with the blocks from the root to the data block.
3522 * This also releases any locked block..
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 */
3524 mfp = buf->b_ml.ml_mfp;
3525 if (mfp == NULL)
3526 return FAIL;
3527
3528 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
3529 return FAIL;
3530
3531 dp = (DATA_BL *)(hp->bh_data);
3532 /* compute line count before the delete */
3533 count = (long)(buf->b_ml.ml_locked_high)
3534 - (long)(buf->b_ml.ml_locked_low) + 2;
3535 idx = lnum - buf->b_ml.ml_locked_low;
3536
3537 --buf->b_ml.ml_line_count;
3538
3539 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3540 if (idx == 0) /* first line in block, text at the end */
3541 line_size = dp->db_txt_end - line_start;
3542 else
3543 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
3544
3545#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003546 if (netbeans_active())
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003547 netbeans_removed(buf, lnum, 0, (long)line_size);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548#endif
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003549#ifdef FEAT_TEXT_PROP
3550 // If there are text properties, make a copy, so that we can update
3551 // properties in preceding and following lines.
3552 if (buf->b_has_textprop)
3553 {
3554 size_t textlen = STRLEN((char_u *)dp + line_start) + 1;
3555
3556 if ((long)textlen < line_size)
3557 {
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01003558 textprop_save_len = line_size - (int)textlen;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003559 textprop_save = vim_memsave((char_u *)dp + line_start + textlen,
3560 textprop_save_len);
3561 }
3562 }
3563#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564
3565/*
3566 * special case: If there is only one line in the data block it becomes empty.
3567 * Then we have to remove the entry, pointing to this data block, from the
3568 * pointer block. If this pointer block also becomes empty, we go up another
3569 * block, and so on, up to the root if necessary.
3570 * The line counts in the pointer blocks have already been adjusted by
3571 * ml_find_line().
3572 */
3573 if (count == 1)
3574 {
3575 mf_free(mfp, hp); /* free the data block */
3576 buf->b_ml.ml_locked = NULL;
3577
Bram Moolenaare60acc12011-05-10 16:41:25 +02003578 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3579 --stack_idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 {
3581 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
3582 ip = &(buf->b_ml.ml_stack[stack_idx]);
3583 idx = ip->ip_index;
3584 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003585 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3587 if (pp->pb_id != PTR_ID)
3588 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003589 iemsg(_("E317: pointer block id wrong 4"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003591 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 }
3593 count = --(pp->pb_count);
3594 if (count == 0) /* the pointer block becomes empty! */
3595 mf_free(mfp, hp);
3596 else
3597 {
3598 if (count != idx) /* move entries after the deleted one */
3599 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
3600 (size_t)(count - idx) * sizeof(PTR_EN));
3601 mf_put(mfp, hp, TRUE, FALSE);
3602
3603 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003604 /* fix line count for rest of blocks in the stack */
3605 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 {
3607 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3608 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003609 buf->b_ml.ml_locked_lineadd;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 }
3611 ++(buf->b_ml.ml_stack_top);
3612
3613 break;
3614 }
3615 }
3616 CHECK(stack_idx < 0, _("deleted block 1?"));
3617 }
3618 else
3619 {
3620 /*
3621 * delete the text by moving the next lines forwards
3622 */
3623 text_start = dp->db_txt_start;
3624 mch_memmove((char *)dp + text_start + line_size,
3625 (char *)dp + text_start, (size_t)(line_start - text_start));
3626
3627 /*
3628 * delete the index by moving the next indexes backwards
3629 * Adjust the indexes for the text movement.
3630 */
3631 for (i = idx; i < count - 1; ++i)
3632 dp->db_index[i] = dp->db_index[i + 1] + line_size;
3633
3634 dp->db_free += line_size + INDEX_SIZE;
3635 dp->db_txt_start += line_size;
3636 --(dp->db_line_count);
3637
3638 /*
3639 * mark the block dirty and make sure it is in the file (for recovery)
3640 */
3641 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3642 }
3643
3644#ifdef FEAT_BYTEOFF
3645 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
3646#endif
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003647 ret = OK;
3648
3649theend:
3650#ifdef FEAT_TEXT_PROP
3651 if (textprop_save != NULL)
3652 {
3653 // Adjust text properties in the line above and below.
3654 if (lnum > 1)
3655 adjust_text_props_for_delete(buf, lnum - 1, textprop_save, textprop_save_len, TRUE);
3656 if (lnum <= buf->b_ml.ml_line_count)
3657 adjust_text_props_for_delete(buf, lnum, textprop_save, textprop_save_len, FALSE);
3658 }
3659 vim_free(textprop_save);
3660#endif
3661 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662}
3663
3664/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003665 * set the DB_MARKED flag for line 'lnum'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 */
3667 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003668ml_setmarked(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669{
3670 bhdr_T *hp;
3671 DATA_BL *dp;
3672 /* invalid line number */
3673 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3674 || curbuf->b_ml.ml_mfp == NULL)
3675 return; /* give error message? */
3676
3677 if (lowest_marked == 0 || lowest_marked > lnum)
3678 lowest_marked = lnum;
3679
3680 /*
3681 * find the data block containing the line
3682 * This also fills the stack with the blocks from the root to the data block
3683 * This also releases any locked block.
3684 */
3685 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3686 return; /* give error message? */
3687
3688 dp = (DATA_BL *)(hp->bh_data);
3689 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
3690 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3691}
3692
3693/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003694 * find the first line with its DB_MARKED flag set
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 */
3696 linenr_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003697ml_firstmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698{
3699 bhdr_T *hp;
3700 DATA_BL *dp;
3701 linenr_T lnum;
3702 int i;
3703
3704 if (curbuf->b_ml.ml_mfp == NULL)
3705 return (linenr_T) 0;
3706
3707 /*
3708 * The search starts with lowest_marked line. This is the last line where
3709 * a mark was found, adjusted by inserting/deleting lines.
3710 */
3711 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3712 {
3713 /*
3714 * Find the data block containing the line.
3715 * This also fills the stack with the blocks from the root to the data
3716 * block This also releases any locked block.
3717 */
3718 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3719 return (linenr_T)0; /* give error message? */
3720
3721 dp = (DATA_BL *)(hp->bh_data);
3722
3723 for (i = lnum - curbuf->b_ml.ml_locked_low;
3724 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3725 if ((dp->db_index[i]) & DB_MARKED)
3726 {
3727 (dp->db_index[i]) &= DB_INDEX_MASK;
3728 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3729 lowest_marked = lnum + 1;
3730 return lnum;
3731 }
3732 }
3733
3734 return (linenr_T) 0;
3735}
3736
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737/*
3738 * clear all DB_MARKED flags
3739 */
3740 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003741ml_clearmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742{
3743 bhdr_T *hp;
3744 DATA_BL *dp;
3745 linenr_T lnum;
3746 int i;
3747
3748 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3749 return;
3750
3751 /*
3752 * The search starts with line lowest_marked.
3753 */
3754 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3755 {
3756 /*
3757 * Find the data block containing the line.
3758 * This also fills the stack with the blocks from the root to the data
3759 * block and releases any locked block.
3760 */
3761 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3762 return; /* give error message? */
3763
3764 dp = (DATA_BL *)(hp->bh_data);
3765
3766 for (i = lnum - curbuf->b_ml.ml_locked_low;
3767 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3768 if ((dp->db_index[i]) & DB_MARKED)
3769 {
3770 (dp->db_index[i]) &= DB_INDEX_MASK;
3771 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3772 }
3773 }
3774
3775 lowest_marked = 0;
3776 return;
3777}
3778
3779/*
3780 * flush ml_line if necessary
3781 */
3782 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003783ml_flush_line(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784{
3785 bhdr_T *hp;
3786 DATA_BL *dp;
3787 linenr_T lnum;
3788 char_u *new_line;
3789 char_u *old_line;
3790 colnr_T new_len;
3791 int old_len;
3792 int extra;
3793 int idx;
3794 int start;
3795 int count;
3796 int i;
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003797 static int entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798
3799 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3800 return; /* nothing to do */
3801
3802 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3803 {
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003804 /* This code doesn't work recursively, but Netbeans may call back here
3805 * when obtaining the cursor position. */
3806 if (entered)
3807 return;
3808 entered = TRUE;
3809
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 lnum = buf->b_ml.ml_line_lnum;
3811 new_line = buf->b_ml.ml_line_ptr;
3812
3813 hp = ml_find_line(buf, lnum, ML_FIND);
3814 if (hp == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003815 siemsg(_("E320: Cannot find line %ld"), lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 else
3817 {
3818 dp = (DATA_BL *)(hp->bh_data);
3819 idx = lnum - buf->b_ml.ml_locked_low;
3820 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3821 old_line = (char_u *)dp + start;
3822 if (idx == 0) /* line is last in block */
3823 old_len = dp->db_txt_end - start;
3824 else /* text of previous line follows */
3825 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003826 new_len = buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 extra = new_len - old_len; /* negative if lines gets smaller */
3828
3829 /*
3830 * if new line fits in data block, replace directly
3831 */
3832 if ((int)dp->db_free >= extra)
3833 {
3834 /* if the length changes and there are following lines */
3835 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3836 if (extra != 0 && idx < count - 1)
3837 {
3838 /* move text of following lines */
3839 mch_memmove((char *)dp + dp->db_txt_start - extra,
3840 (char *)dp + dp->db_txt_start,
3841 (size_t)(start - dp->db_txt_start));
3842
3843 /* adjust pointers of this and following lines */
3844 for (i = idx + 1; i < count; ++i)
3845 dp->db_index[i] -= extra;
3846 }
3847 dp->db_index[idx] -= extra;
3848
3849 /* adjust free space */
3850 dp->db_free -= extra;
3851 dp->db_txt_start -= extra;
3852
3853 /* copy new line into the data block */
3854 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3855 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3856#ifdef FEAT_BYTEOFF
3857 /* The else case is already covered by the insert and delete */
3858 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3859#endif
3860 }
3861 else
3862 {
3863 /*
3864 * Cannot do it in one data block: Delete and append.
3865 * Append first, because ml_delete_int() cannot delete the
3866 * last line in a buffer, which causes trouble for a buffer
3867 * that has only one line.
3868 * Don't forget to copy the mark!
3869 */
3870 /* How about handling errors??? */
3871 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3872 (dp->db_index[idx] & DB_MARKED));
3873 (void)ml_delete_int(buf, lnum, FALSE);
3874 }
3875 }
3876 vim_free(new_line);
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003877
3878 entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 }
3880
3881 buf->b_ml.ml_line_lnum = 0;
3882}
3883
3884/*
3885 * create a new, empty, data block
3886 */
3887 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003888ml_new_data(memfile_T *mfp, int negative, int page_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889{
3890 bhdr_T *hp;
3891 DATA_BL *dp;
3892
3893 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3894 return NULL;
3895
3896 dp = (DATA_BL *)(hp->bh_data);
3897 dp->db_id = DATA_ID;
3898 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3899 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3900 dp->db_line_count = 0;
3901
3902 return hp;
3903}
3904
3905/*
3906 * create a new, empty, pointer block
3907 */
3908 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003909ml_new_ptr(memfile_T *mfp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910{
3911 bhdr_T *hp;
3912 PTR_BL *pp;
3913
3914 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3915 return NULL;
3916
3917 pp = (PTR_BL *)(hp->bh_data);
3918 pp->pb_id = PTR_ID;
3919 pp->pb_count = 0;
Bram Moolenaar20a825a2010-05-31 21:27:30 +02003920 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL))
3921 / sizeof(PTR_EN) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922
3923 return hp;
3924}
3925
3926/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003927 * Lookup line 'lnum' in a memline.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 *
3929 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3930 * if ML_FLUSH only flush a locked block
3931 * if ML_FIND just find the line
3932 *
3933 * If the block was found it is locked and put in ml_locked.
3934 * The stack is updated to lead to the locked block. The ip_high field in
3935 * the stack is updated to reflect the last line in the block AFTER the
3936 * insert or delete, also if the pointer block has not been updated yet. But
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003937 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 *
3939 * return: NULL for failure, pointer to block header otherwise
3940 */
3941 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003942ml_find_line(buf_T *buf, linenr_T lnum, int action)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943{
3944 DATA_BL *dp;
3945 PTR_BL *pp;
3946 infoptr_T *ip;
3947 bhdr_T *hp;
3948 memfile_T *mfp;
3949 linenr_T t;
3950 blocknr_T bnum, bnum2;
3951 int dirty;
3952 linenr_T low, high;
3953 int top;
3954 int page_count;
3955 int idx;
3956
3957 mfp = buf->b_ml.ml_mfp;
3958
3959 /*
3960 * If there is a locked block check if the wanted line is in it.
3961 * If not, flush and release the locked block.
3962 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3963 * Don't do this for ML_FLUSH, because we want to flush the locked block.
Bram Moolenaar47b8b152007-02-07 02:41:57 +00003964 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 */
3966 if (buf->b_ml.ml_locked)
3967 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00003968 if (ML_SIMPLE(action)
3969 && buf->b_ml.ml_locked_low <= lnum
3970 && buf->b_ml.ml_locked_high >= lnum
3971 && !mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00003973 /* remember to update pointer blocks and stack later */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 if (action == ML_INSERT)
3975 {
3976 ++(buf->b_ml.ml_locked_lineadd);
3977 ++(buf->b_ml.ml_locked_high);
3978 }
3979 else if (action == ML_DELETE)
3980 {
3981 --(buf->b_ml.ml_locked_lineadd);
3982 --(buf->b_ml.ml_locked_high);
3983 }
3984 return (buf->b_ml.ml_locked);
3985 }
3986
3987 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3988 buf->b_ml.ml_flags & ML_LOCKED_POS);
3989 buf->b_ml.ml_locked = NULL;
3990
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003991 /*
3992 * If lines have been added or deleted in the locked block, need to
3993 * update the line count in pointer blocks.
3994 */
3995 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3997 }
3998
3999 if (action == ML_FLUSH) /* nothing else to do */
4000 return NULL;
4001
4002 bnum = 1; /* start at the root of the tree */
4003 page_count = 1;
4004 low = 1;
4005 high = buf->b_ml.ml_line_count;
4006
4007 if (action == ML_FIND) /* first try stack entries */
4008 {
4009 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
4010 {
4011 ip = &(buf->b_ml.ml_stack[top]);
4012 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
4013 {
4014 bnum = ip->ip_bnum;
4015 low = ip->ip_low;
4016 high = ip->ip_high;
4017 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
4018 break;
4019 }
4020 }
4021 if (top < 0)
4022 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
4023 }
4024 else /* ML_DELETE or ML_INSERT */
4025 buf->b_ml.ml_stack_top = 0; /* start at the root */
4026
4027/*
4028 * search downwards in the tree until a data block is found
4029 */
4030 for (;;)
4031 {
4032 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
4033 goto error_noblock;
4034
4035 /*
4036 * update high for insert/delete
4037 */
4038 if (action == ML_INSERT)
4039 ++high;
4040 else if (action == ML_DELETE)
4041 --high;
4042
4043 dp = (DATA_BL *)(hp->bh_data);
4044 if (dp->db_id == DATA_ID) /* data block */
4045 {
4046 buf->b_ml.ml_locked = hp;
4047 buf->b_ml.ml_locked_low = low;
4048 buf->b_ml.ml_locked_high = high;
4049 buf->b_ml.ml_locked_lineadd = 0;
4050 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
4051 return hp;
4052 }
4053
4054 pp = (PTR_BL *)(dp); /* must be pointer block */
4055 if (pp->pb_id != PTR_ID)
4056 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004057 iemsg(_("E317: pointer block id wrong"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 goto error_block;
4059 }
4060
4061 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
4062 goto error_block;
4063 ip = &(buf->b_ml.ml_stack[top]);
4064 ip->ip_bnum = bnum;
4065 ip->ip_low = low;
4066 ip->ip_high = high;
4067 ip->ip_index = -1; /* index not known yet */
4068
4069 dirty = FALSE;
4070 for (idx = 0; idx < (int)pp->pb_count; ++idx)
4071 {
4072 t = pp->pb_pointer[idx].pe_line_count;
4073 CHECK(t == 0, _("pe_line_count is zero"));
4074 if ((low += t) > lnum)
4075 {
4076 ip->ip_index = idx;
4077 bnum = pp->pb_pointer[idx].pe_bnum;
4078 page_count = pp->pb_pointer[idx].pe_page_count;
4079 high = low - 1;
4080 low -= t;
4081
4082 /*
4083 * a negative block number may have been changed
4084 */
4085 if (bnum < 0)
4086 {
4087 bnum2 = mf_trans_del(mfp, bnum);
4088 if (bnum != bnum2)
4089 {
4090 bnum = bnum2;
4091 pp->pb_pointer[idx].pe_bnum = bnum;
4092 dirty = TRUE;
4093 }
4094 }
4095
4096 break;
4097 }
4098 }
4099 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
4100 {
4101 if (lnum > buf->b_ml.ml_line_count)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004102 siemsg(_("E322: line number out of range: %ld past the end"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 lnum - buf->b_ml.ml_line_count);
4104
4105 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004106 siemsg(_("E323: line count wrong in block %ld"), bnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 goto error_block;
4108 }
4109 if (action == ML_DELETE)
4110 {
4111 pp->pb_pointer[idx].pe_line_count--;
4112 dirty = TRUE;
4113 }
4114 else if (action == ML_INSERT)
4115 {
4116 pp->pb_pointer[idx].pe_line_count++;
4117 dirty = TRUE;
4118 }
4119 mf_put(mfp, hp, dirty, FALSE);
4120 }
4121
4122error_block:
4123 mf_put(mfp, hp, FALSE, FALSE);
4124error_noblock:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004125 /*
4126 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
4127 * the incremented/decremented line counts, because there won't be a line
4128 * inserted/deleted after all.
4129 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 if (action == ML_DELETE)
4131 ml_lineadd(buf, 1);
4132 else if (action == ML_INSERT)
4133 ml_lineadd(buf, -1);
4134 buf->b_ml.ml_stack_top = 0;
4135 return NULL;
4136}
4137
4138/*
4139 * add an entry to the info pointer stack
4140 *
4141 * return -1 for failure, number of the new entry otherwise
4142 */
4143 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004144ml_add_stack(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145{
4146 int top;
4147 infoptr_T *newstack;
4148
4149 top = buf->b_ml.ml_stack_top;
4150
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004151 /* may have to increase the stack size */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 if (top == buf->b_ml.ml_stack_size)
4153 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004154 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155
4156 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
4157 (buf->b_ml.ml_stack_size + STACK_INCR));
4158 if (newstack == NULL)
4159 return -1;
Bram Moolenaarfbd302f2015-08-08 18:23:46 +02004160 if (top > 0)
4161 mch_memmove(newstack, buf->b_ml.ml_stack,
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004162 (size_t)top * sizeof(infoptr_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 vim_free(buf->b_ml.ml_stack);
4164 buf->b_ml.ml_stack = newstack;
4165 buf->b_ml.ml_stack_size += STACK_INCR;
4166 }
4167
4168 buf->b_ml.ml_stack_top++;
4169 return top;
4170}
4171
4172/*
4173 * Update the pointer blocks on the stack for inserted/deleted lines.
4174 * The stack itself is also updated.
4175 *
4176 * When a insert/delete line action fails, the line is not inserted/deleted,
4177 * but the pointer blocks have already been updated. That is fixed here by
4178 * walking through the stack.
4179 *
4180 * Count is the number of lines added, negative if lines have been deleted.
4181 */
4182 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004183ml_lineadd(buf_T *buf, int count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184{
4185 int idx;
4186 infoptr_T *ip;
4187 PTR_BL *pp;
4188 memfile_T *mfp = buf->b_ml.ml_mfp;
4189 bhdr_T *hp;
4190
4191 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
4192 {
4193 ip = &(buf->b_ml.ml_stack[idx]);
4194 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
4195 break;
4196 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
4197 if (pp->pb_id != PTR_ID)
4198 {
4199 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004200 iemsg(_("E317: pointer block id wrong 2"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 break;
4202 }
4203 pp->pb_pointer[ip->ip_index].pe_line_count += count;
4204 ip->ip_high += count;
4205 mf_put(mfp, hp, TRUE, FALSE);
4206 }
4207}
4208
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004209#if defined(HAVE_READLINK) || defined(PROTO)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004210/*
4211 * Resolve a symlink in the last component of a file name.
4212 * Note that f_resolve() does it for every part of the path, we don't do that
4213 * here.
4214 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
4215 * Otherwise returns FAIL.
4216 */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004217 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004218resolve_symlink(char_u *fname, char_u *buf)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004219{
4220 char_u tmp[MAXPATHL];
4221 int ret;
4222 int depth = 0;
4223
4224 if (fname == NULL)
4225 return FAIL;
4226
4227 /* Put the result so far in tmp[], starting with the original name. */
4228 vim_strncpy(tmp, fname, MAXPATHL - 1);
4229
4230 for (;;)
4231 {
4232 /* Limit symlink depth to 100, catch recursive loops. */
4233 if (++depth == 100)
4234 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004235 semsg(_("E773: Symlink loop for \"%s\""), fname);
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004236 return FAIL;
4237 }
4238
4239 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
4240 if (ret <= 0)
4241 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00004242 if (errno == EINVAL || errno == ENOENT)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004243 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00004244 /* Found non-symlink or not existing file, stop here.
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00004245 * When at the first level use the unmodified name, skip the
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004246 * call to vim_FullName(). */
4247 if (depth == 1)
4248 return FAIL;
4249
4250 /* Use the resolved name in tmp[]. */
4251 break;
4252 }
4253
4254 /* There must be some error reading links, use original name. */
4255 return FAIL;
4256 }
4257 buf[ret] = NUL;
4258
4259 /*
4260 * Check whether the symlink is relative or absolute.
4261 * If it's relative, build a new path based on the directory
4262 * portion of the filename (if any) and the path the symlink
4263 * points to.
4264 */
4265 if (mch_isFullName(buf))
4266 STRCPY(tmp, buf);
4267 else
4268 {
4269 char_u *tail;
4270
4271 tail = gettail(tmp);
4272 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
4273 return FAIL;
4274 STRCPY(tail, buf);
4275 }
4276 }
4277
4278 /*
4279 * Try to resolve the full name of the file so that the swapfile name will
4280 * be consistent even when opening a relative symlink from different
4281 * working directories.
4282 */
4283 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
4284}
4285#endif
4286
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287/*
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004288 * Make swap file name out of the file name and a directory name.
4289 * Returns pointer to allocated memory or NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004291 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004292makeswapname(
4293 char_u *fname,
4294 char_u *ffname UNUSED,
4295 buf_T *buf,
4296 char_u *dir_name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297{
4298 char_u *r, *s;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02004299 char_u *fname_res = fname;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004300#ifdef HAVE_READLINK
4301 char_u fname_buf[MAXPATHL];
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004302#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303
Bram Moolenaar4f974752019-02-17 17:44:42 +01004304#if defined(UNIX) || defined(MSWIN) // Need _very_ long file names
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01004305 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01004306
4307 s = dir_name + len;
4308 if (after_pathsep(dir_name, s) && len > 1 && s[-1] == s[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 { /* Ends with '//', Use Full path */
4310 r = NULL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004311 if ((s = make_percent_swname(dir_name, fname)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 {
4313 r = modname(s, (char_u *)".swp", FALSE);
4314 vim_free(s);
4315 }
4316 return r;
4317 }
4318#endif
4319
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004320#ifdef HAVE_READLINK
4321 /* Expand symlink in the file name, so that we put the swap file with the
4322 * actual file instead of with the symlink. */
4323 if (resolve_symlink(fname, fname_buf) == OK)
4324 fname_res = fname_buf;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004325#endif
4326
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 r = buf_modname(
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 (buf->b_p_sn || buf->b_shortname),
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004329 fname_res,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 (char_u *)
Bram Moolenaare60acc12011-05-10 16:41:25 +02004331#if defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 "_swp",
4333#else
4334 ".swp",
4335#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 /* Prepend a '.' to the swap file name for the current directory. */
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004337 dir_name[0] == '.' && dir_name[1] == NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 if (r == NULL) /* out of memory */
4339 return NULL;
4340
4341 s = get_file_in_dir(r, dir_name);
4342 vim_free(r);
4343 return s;
4344}
4345
4346/*
4347 * Get file name to use for swap file or backup file.
4348 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
4349 * option "dname".
4350 * - If "dname" is ".", return "fname" (swap file in dir of file).
4351 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
4352 * relative to dir of file).
4353 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
4354 * dir).
4355 *
4356 * The return value is an allocated string and can be NULL.
4357 */
4358 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004359get_file_in_dir(
4360 char_u *fname,
4361 char_u *dname) /* don't use "dirname", it is a global for Alpha */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362{
4363 char_u *t;
4364 char_u *tail;
4365 char_u *retval;
4366 int save_char;
4367
4368 tail = gettail(fname);
4369
4370 if (dname[0] == '.' && dname[1] == NUL)
4371 retval = vim_strsave(fname);
4372 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
4373 {
4374 if (tail == fname) /* no path before file name */
4375 retval = concat_fnames(dname + 2, tail, TRUE);
4376 else
4377 {
4378 save_char = *tail;
4379 *tail = NUL;
4380 t = concat_fnames(fname, dname + 2, TRUE);
4381 *tail = save_char;
4382 if (t == NULL) /* out of memory */
4383 retval = NULL;
4384 else
4385 {
4386 retval = concat_fnames(t, tail, TRUE);
4387 vim_free(t);
4388 }
4389 }
4390 }
4391 else
4392 retval = concat_fnames(dname, tail, TRUE);
4393
Bram Moolenaar4f974752019-02-17 17:44:42 +01004394#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004395 if (retval != NULL)
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004396 for (t = gettail(retval); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004397 if (*t == ':')
4398 *t = '%';
4399#endif
4400
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 return retval;
4402}
4403
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004404/*
4405 * Print the ATTENTION message: info about an existing swap file.
4406 */
4407 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004408attention_message(
4409 buf_T *buf, /* buffer being edited */
4410 char_u *fname) /* swap file name */
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004411{
Bram Moolenaar8767f522016-07-01 17:17:39 +02004412 stat_T st;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004413 time_t x, sx;
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00004414 char *p;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004415
4416 ++no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004417 (void)emsg(_("E325: ATTENTION"));
Bram Moolenaar32526b32019-01-19 17:43:09 +01004418 msg_puts(_("\nFound a swap file by the name \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004419 msg_home_replace(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004420 msg_puts("\"\n");
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004421 sx = swapfile_info(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004422 msg_puts(_("While opening file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004423 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004424 msg_puts("\"\n");
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004425 if (mch_stat((char *)buf->b_fname, &st) == -1)
4426 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004427 msg_puts(_(" CANNOT BE FOUND"));
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004428 }
4429 else
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004430 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004431 msg_puts(_(" dated: "));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004432 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00004433 p = ctime(&x); /* includes '\n' */
4434 if (p == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004435 msg_puts("(invalid)\n");
Bram Moolenaar31e97bf2006-10-10 14:20:13 +00004436 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01004437 msg_puts(p);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004438 if (sx != 0 && x > sx)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004439 msg_puts(_(" NEWER than swap file!\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004440 }
4441 /* Some of these messages are long to allow translation to
4442 * other languages. */
Bram Moolenaar32526b32019-01-19 17:43:09 +01004443 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"));
4444 msg_puts(_("(2) An edit session for this file crashed.\n"));
4445 msg_puts(_(" If this is the case, use \":recover\" or \"vim -r "));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004446 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004447 msg_puts(_("\"\n to recover the changes (see \":help recovery\").\n"));
4448 msg_puts(_(" If you did this already, delete the swap file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004449 msg_outtrans(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004450 msg_puts(_("\"\n to avoid this message.\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004451 cmdline_row = msg_row;
4452 --no_wait_return;
4453}
4454
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004455#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004456/*
4457 * Trigger the SwapExists autocommands.
4458 * Returns a value for equivalent to do_dialog() (see below):
4459 * 0: still need to ask for a choice
4460 * 1: open read-only
4461 * 2: edit anyway
4462 * 3: recover
4463 * 4: delete it
4464 * 5: quit
4465 * 6: abort
4466 */
4467 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004468do_swapexists(buf_T *buf, char_u *fname)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004469{
4470 set_vim_var_string(VV_SWAPNAME, fname, -1);
4471 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
4472
4473 /* Trigger SwapExists autocommands with <afile> set to the file being
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004474 * edited. Disallow changing directory here. */
4475 ++allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004476 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004477 --allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004478
4479 set_vim_var_string(VV_SWAPNAME, NULL, -1);
4480
4481 switch (*get_vim_var_str(VV_SWAPCHOICE))
4482 {
4483 case 'o': return 1;
4484 case 'e': return 2;
4485 case 'r': return 3;
4486 case 'd': return 4;
4487 case 'q': return 5;
4488 case 'a': return 6;
4489 }
4490
4491 return 0;
4492}
4493#endif
4494
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495/*
4496 * Find out what name to use for the swap file for buffer 'buf'.
4497 *
4498 * Several names are tried to find one that does not exist
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004499 * Returns the name in allocated memory or NULL.
Bram Moolenaarf541c362011-10-26 11:44:18 +02004500 * When out of memory "dirp" is set to NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 *
4502 * Note: If BASENAMELEN is not correct, you will get error messages for
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004503 * not being able to open the swap or undo file
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004504 * Note: May trigger SwapExists autocmd, pointers may change!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 */
4506 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004507findswapname(
4508 buf_T *buf,
4509 char_u **dirp, /* pointer to list of directories */
4510 char_u *old_fname) /* don't give warning for this file name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511{
4512 char_u *fname;
4513 int n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 char_u *dir_name;
4515#ifdef AMIGA
4516 BPTR fh;
4517#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 int r;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004519 char_u *buf_fname = buf->b_fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004521#if !defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522# define CREATE_DUMMY_FILE
4523 FILE *dummyfd = NULL;
4524
Bram Moolenaar4f974752019-02-17 17:44:42 +01004525# ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004526 if (buf_fname != NULL && !mch_isFullName(buf_fname)
4527 && vim_strchr(gettail(buf_fname), ':'))
4528 {
4529 char_u *t;
4530
4531 buf_fname = vim_strsave(buf_fname);
4532 if (buf_fname == NULL)
4533 buf_fname = buf->b_fname;
4534 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004535 for (t = gettail(buf_fname); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004536 if (*t == ':')
4537 *t = '%';
4538 }
4539# endif
4540
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004541 /*
4542 * If we start editing a new file, e.g. "test.doc", which resides on an
4543 * MSDOS compatible filesystem, it is possible that the file
4544 * "test.doc.swp" which we create will be exactly the same file. To avoid
4545 * this problem we temporarily create "test.doc". Don't do this when the
4546 * check below for a 8.3 file name is used.
4547 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004548 if (!(buf->b_p_sn || buf->b_shortname) && buf_fname != NULL
4549 && mch_getperm(buf_fname) < 0)
4550 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551#endif
4552
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004553 /*
4554 * Isolate a directory name from *dirp and put it in dir_name.
4555 * First allocate some memory to put the directory name in.
4556 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
Bram Moolenaarf541c362011-10-26 11:44:18 +02004558 if (dir_name == NULL)
4559 *dirp = NULL;
4560 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 (void)copy_option_part(dirp, dir_name, 31000, ",");
4562
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004563 /*
4564 * we try different names until we find one that does not exist yet
4565 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 if (dir_name == NULL) /* out of memory */
4567 fname = NULL;
4568 else
Bram Moolenaar69c35002013-11-04 02:54:12 +01004569 fname = makeswapname(buf_fname, buf->b_ffname, buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570
4571 for (;;)
4572 {
4573 if (fname == NULL) /* must be out of memory */
4574 break;
4575 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
4576 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01004577 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 break;
4579 }
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004580#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581/*
4582 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
4583 * file names. If this is the first try and the swap file name does not fit in
4584 * 8.3, detect if this is the case, set shortname and try again.
4585 */
4586 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
4587 && !(buf->b_p_sn || buf->b_shortname))
4588 {
4589 char_u *tail;
4590 char_u *fname2;
Bram Moolenaar8767f522016-07-01 17:17:39 +02004591 stat_T s1, s2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 int f1, f2;
4593 int created1 = FALSE, created2 = FALSE;
4594 int same = FALSE;
4595
4596 /*
4597 * Check if swapfile name does not fit in 8.3:
4598 * It either contains two dots, is longer than 8 chars, or starts
4599 * with a dot.
4600 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004601 tail = gettail(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 if ( vim_strchr(tail, '.') != NULL
4603 || STRLEN(tail) > (size_t)8
4604 || *gettail(fname) == '.')
4605 {
4606 fname2 = alloc(n + 2);
4607 if (fname2 != NULL)
4608 {
4609 STRCPY(fname2, fname);
4610 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
4611 * if fname == ".xx.swp", fname2 = ".xx.swpx"
4612 * if fname == "123456789.swp", fname2 = "12345678x.swp"
4613 */
4614 if (vim_strchr(tail, '.') != NULL)
4615 fname2[n - 1] = 'x';
4616 else if (*gettail(fname) == '.')
4617 {
4618 fname2[n] = 'x';
4619 fname2[n + 1] = NUL;
4620 }
4621 else
4622 fname2[n - 5] += 1;
4623 /*
4624 * may need to create the files to be able to use mch_stat()
4625 */
4626 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4627 if (f1 < 0)
4628 {
4629 f1 = mch_open_rw((char *)fname,
4630 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 created1 = TRUE;
4632 }
4633 if (f1 >= 0)
4634 {
4635 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4636 if (f2 < 0)
4637 {
4638 f2 = mch_open_rw((char *)fname2,
4639 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4640 created2 = TRUE;
4641 }
4642 if (f2 >= 0)
4643 {
4644 /*
4645 * Both files exist now. If mch_stat() returns the
4646 * same device and inode they are the same file.
4647 */
4648 if (mch_fstat(f1, &s1) != -1
4649 && mch_fstat(f2, &s2) != -1
4650 && s1.st_dev == s2.st_dev
4651 && s1.st_ino == s2.st_ino)
4652 same = TRUE;
4653 close(f2);
4654 if (created2)
4655 mch_remove(fname2);
4656 }
4657 close(f1);
4658 if (created1)
4659 mch_remove(fname);
4660 }
4661 vim_free(fname2);
4662 if (same)
4663 {
4664 buf->b_shortname = TRUE;
4665 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004666 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004667 buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 continue; /* try again with b_shortname set */
4669 }
4670 }
4671 }
4672 }
4673#endif
4674 /*
4675 * check if the swapfile already exists
4676 */
4677 if (mch_getperm(fname) < 0) /* it does not exist */
4678 {
4679#ifdef HAVE_LSTAT
Bram Moolenaar8767f522016-07-01 17:17:39 +02004680 stat_T sb;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681
4682 /*
4683 * Extra security check: When a swap file is a symbolic link, this
4684 * is most likely a symlink attack.
4685 */
4686 if (mch_lstat((char *)fname, &sb) < 0)
4687#else
4688# ifdef AMIGA
4689 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4690 /*
4691 * on the Amiga mch_getperm() will return -1 when the file exists
4692 * but is being used by another program. This happens if you edit
4693 * a file twice.
4694 */
4695 if (fh != (BPTR)NULL) /* can open file, OK */
4696 {
4697 Close(fh);
4698 mch_remove(fname);
4699 break;
4700 }
4701 if (IoErr() != ERROR_OBJECT_IN_USE
4702 && IoErr() != ERROR_OBJECT_EXISTS)
4703# endif
4704#endif
4705 break;
4706 }
4707
4708 /*
4709 * A file name equal to old_fname is OK to use.
4710 */
4711 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4712 break;
4713
4714 /*
4715 * get here when file already exists
4716 */
4717 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4718 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 /*
4720 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4721 * and file.doc are the same file. To guess if this problem is
4722 * present try if file.doc.swx exists. If it does, we set
4723 * buf->b_shortname and try file_doc.swp (dots replaced by
4724 * underscores for this file), and try again. If it doesn't we
4725 * assume that "file.doc.swp" already exists.
4726 */
4727 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4728 {
4729 fname[n - 1] = 'x';
4730 r = mch_getperm(fname); /* try "file.swx" */
4731 fname[n - 1] = 'p';
4732 if (r >= 0) /* "file.swx" seems to exist */
4733 {
4734 buf->b_shortname = TRUE;
4735 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004736 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004737 buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 continue; /* try again with '.' replaced with '_' */
4739 }
4740 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 /*
4742 * If we get here the ".swp" file really exists.
4743 * Give an error message, unless recovering, no file name, we are
4744 * viewing a help file or when the path of the file is different
4745 * (happens when all .swp files are in one directory).
4746 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004747 if (!recoverymode && buf_fname != NULL
Bram Moolenaar8fc061c2004-12-29 21:03:02 +00004748 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 {
4750 int fd;
4751 struct block0 b0;
4752 int differ = FALSE;
4753
4754 /*
4755 * Try to read block 0 from the swap file to get the original
4756 * file name (and inode number).
4757 */
4758 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4759 if (fd >= 0)
4760 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01004761 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 {
4763 /*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004764 * If the swapfile has the same directory as the
4765 * buffer don't compare the directory names, they can
4766 * have a different mountpoint.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004768 if (b0.b0_flags & B0_SAME_DIR)
4769 {
4770 if (fnamecmp(gettail(buf->b_ffname),
4771 gettail(b0.b0_fname)) != 0
4772 || !same_directory(fname, buf->b_ffname))
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004773 {
4774#ifdef CHECK_INODE
4775 /* Symlinks may point to the same file even
4776 * when the name differs, need to check the
4777 * inode too. */
4778 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4779 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4780 char_to_long(b0.b0_ino)))
4781#endif
4782 differ = TRUE;
4783 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004784 }
4785 else
4786 {
4787 /*
4788 * The name in the swap file may be
4789 * "~user/path/file". Expand it first.
4790 */
4791 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792#ifdef CHECK_INODE
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004793 if (fnamecmp_ino(buf->b_ffname, NameBuff,
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004794 char_to_long(b0.b0_ino)))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004795 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796#else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004797 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4798 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004800 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 }
4802 close(fd);
4803 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804
4805 /* give the ATTENTION message when there is an old swap file
4806 * for the current file, and the buffer was not recovered. */
4807 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4808 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4809 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004810 int choice = 0;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02004811 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812#ifdef CREATE_DUMMY_FILE
4813 int did_use_dummy = FALSE;
4814
4815 /* Avoid getting a warning for the file being created
4816 * outside of Vim, it was created at the start of this
4817 * function. Delete the file now, because Vim might exit
4818 * here if the window is closed. */
4819 if (dummyfd != NULL)
4820 {
4821 fclose(dummyfd);
4822 dummyfd = NULL;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004823 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 did_use_dummy = TRUE;
4825 }
4826#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004828#if (defined(UNIX) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 process_still_running = FALSE;
4830#endif
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02004831 // It's safe to delete the swap file if all these are true:
4832 // - the edited file exists
4833 // - the swap file has no changes and looks OK
4834 if (mch_stat((char *)buf->b_fname, &st) == 0
4835 && swapfile_unchanged(fname))
4836 {
4837 choice = 4;
4838 if (p_verbose > 0)
4839 verb_msg(_("Found a swap file that is not useful, deleting it"));
4840 }
4841
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004842#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004843 /*
4844 * If there is an SwapExists autocommand and we can handle
4845 * the response, trigger it. It may return 0 to ask the
4846 * user anyway.
4847 */
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02004848 if (choice == 0
4849 && swap_exists_action != SEA_NONE
Bram Moolenaar69c35002013-11-04 02:54:12 +01004850 && has_autocmd(EVENT_SWAPEXISTS, buf_fname, buf))
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004851 choice = do_swapexists(buf, fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004853 if (choice == 0)
4854#endif
4855 {
4856#ifdef FEAT_GUI
Bram Moolenaar798184c2018-10-07 20:48:39 +02004857 // If we are supposed to start the GUI but it wasn't
4858 // completely started yet, start it now. This makes
4859 // the messages displayed in the Vim window when
4860 // loading a session from the .gvimrc file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004861 if (gui.starting && !gui.in_use)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004862 gui_start(NULL);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004863#endif
Bram Moolenaar798184c2018-10-07 20:48:39 +02004864 // Show info about the existing swap file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004865 attention_message(buf, fname);
4866
Bram Moolenaar798184c2018-10-07 20:48:39 +02004867 // We don't want a 'q' typed at the more-prompt
4868 // interrupt loading a file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004869 got_int = FALSE;
Bram Moolenaar798184c2018-10-07 20:48:39 +02004870
4871 // If vimrc has "simalt ~x" we don't want it to
4872 // interfere with the prompt here.
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02004873 flush_buffers(FLUSH_TYPEAHEAD);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004874 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875
4876#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004877 if (swap_exists_action != SEA_NONE && choice == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 {
4879 char_u *name;
4880
4881 name = alloc((unsigned)(STRLEN(fname)
4882 + STRLEN(_("Swap file \""))
4883 + STRLEN(_("\" already exists!")) + 5));
4884 if (name != NULL)
4885 {
4886 STRCPY(name, _("Swap file \""));
4887 home_replace(NULL, fname, name + STRLEN(name),
4888 1000, TRUE);
4889 STRCAT(name, _("\" already exists!"));
4890 }
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004891 choice = do_dialog(VIM_WARNING,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 (char_u *)_("VIM - ATTENTION"),
4893 name == NULL
4894 ? (char_u *)_("Swap file already exists!")
4895 : name,
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004896# if defined(UNIX) || defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 process_still_running
4898 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4899# endif
Bram Moolenaard2c340a2011-01-17 20:08:11 +01004900 (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 +00004901
Bram Moolenaara06ecab2016-07-16 14:47:36 +02004902# if defined(UNIX) || defined(VMS)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004903 if (process_still_running && choice >= 4)
4904 choice++; /* Skip missing "Delete it" button */
4905# endif
4906 vim_free(name);
4907
4908 /* pretend screen didn't scroll, need redraw anyway */
4909 msg_scrolled = 0;
4910 redraw_all_later(NOT_VALID);
4911 }
4912#endif
4913
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004914 if (choice > 0)
4915 {
4916 switch (choice)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 {
4918 case 1:
4919 buf->b_p_ro = TRUE;
4920 break;
4921 case 2:
4922 break;
4923 case 3:
4924 swap_exists_action = SEA_RECOVER;
4925 break;
4926 case 4:
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004927 mch_remove(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 break;
4929 case 5:
4930 swap_exists_action = SEA_QUIT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 break;
4932 case 6:
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004933 swap_exists_action = SEA_QUIT;
4934 got_int = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 break;
4936 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937
4938 /* If the file was deleted this fname can be used. */
4939 if (mch_getperm(fname) < 0)
4940 break;
4941 }
4942 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004944 msg_puts("\n");
Bram Moolenaar4770d092006-01-12 23:22:24 +00004945 if (msg_silent == 0)
4946 /* call wait_return() later */
4947 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 }
4949
4950#ifdef CREATE_DUMMY_FILE
4951 /* Going to try another name, need the dummy file again. */
4952 if (did_use_dummy)
Bram Moolenaar69c35002013-11-04 02:54:12 +01004953 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954#endif
4955 }
4956 }
4957 }
4958
4959 /*
4960 * Change the ".swp" extension to find another file that can be used.
4961 * First decrement the last char: ".swo", ".swn", etc.
4962 * If that still isn't enough decrement the last but one char: ".svz"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00004963 * Can happen when editing many "No Name" buffers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 */
4965 if (fname[n - 1] == 'a') /* ".s?a" */
4966 {
4967 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4968 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004969 emsg(_("E326: Too many swap files found"));
Bram Moolenaard23a8232018-02-10 18:45:26 +01004970 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 break;
4972 }
4973 --fname[n - 2]; /* ".svz", ".suz", etc. */
4974 fname[n - 1] = 'z' + 1;
4975 }
4976 --fname[n - 1]; /* ".swo", ".swn", etc. */
4977 }
4978
4979 vim_free(dir_name);
4980#ifdef CREATE_DUMMY_FILE
4981 if (dummyfd != NULL) /* file has been created temporarily */
4982 {
4983 fclose(dummyfd);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004984 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 }
4986#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01004987#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004988 if (buf_fname != buf->b_fname)
4989 vim_free(buf_fname);
4990#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 return fname;
4992}
4993
4994 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004995b0_magic_wrong(ZERO_BL *b0p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996{
4997 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4998 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4999 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
5000 || b0p->b0_magic_char != B0_MAGIC_CHAR);
5001}
5002
5003#ifdef CHECK_INODE
5004/*
5005 * Compare current file name with file name from swap file.
5006 * Try to use inode numbers when possible.
5007 * Return non-zero when files are different.
5008 *
5009 * When comparing file names a few things have to be taken into consideration:
5010 * - When working over a network the full path of a file depends on the host.
5011 * We check the inode number if possible. It is not 100% reliable though,
5012 * because the device number cannot be used over a network.
5013 * - When a file does not exist yet (editing a new file) there is no inode
5014 * number.
5015 * - The file name in a swap file may not be valid on the current host. The
5016 * "~user" form is used whenever possible to avoid this.
5017 *
5018 * This is getting complicated, let's make a table:
5019 *
5020 * ino_c ino_s fname_c fname_s differ =
5021 *
5022 * both files exist -> compare inode numbers:
5023 * != 0 != 0 X X ino_c != ino_s
5024 *
5025 * inode number(s) unknown, file names available -> compare file names
5026 * == 0 X OK OK fname_c != fname_s
5027 * X == 0 OK OK fname_c != fname_s
5028 *
5029 * current file doesn't exist, file for swap file exist, file name(s) not
5030 * available -> probably different
5031 * == 0 != 0 FAIL X TRUE
5032 * == 0 != 0 X FAIL TRUE
5033 *
5034 * current file exists, inode for swap unknown, file name(s) not
5035 * available -> probably different
5036 * != 0 == 0 FAIL X TRUE
5037 * != 0 == 0 X FAIL TRUE
5038 *
5039 * current file doesn't exist, inode for swap unknown, one file name not
5040 * available -> probably different
5041 * == 0 == 0 FAIL OK TRUE
5042 * == 0 == 0 OK FAIL TRUE
5043 *
5044 * current file doesn't exist, inode for swap unknown, both file names not
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005045 * available -> compare file names
5046 * == 0 == 0 FAIL FAIL fname_c != fname_s
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 *
5048 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
5049 * can't be changed without making the block 0 incompatible with 32 bit
5050 * versions.
5051 */
5052
5053 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005054fnamecmp_ino(
5055 char_u *fname_c, /* current file name */
5056 char_u *fname_s, /* file name from swap file */
5057 long ino_block0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058{
Bram Moolenaar8767f522016-07-01 17:17:39 +02005059 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 ino_t ino_c = 0; /* ino of current file */
5061 ino_t ino_s; /* ino of file from swap file */
5062 char_u buf_c[MAXPATHL]; /* full path of fname_c */
5063 char_u buf_s[MAXPATHL]; /* full path of fname_s */
5064 int retval_c; /* flag: buf_c valid */
5065 int retval_s; /* flag: buf_s valid */
5066
5067 if (mch_stat((char *)fname_c, &st) == 0)
5068 ino_c = (ino_t)st.st_ino;
5069
5070 /*
5071 * First we try to get the inode from the file name, because the inode in
5072 * the swap file may be outdated. If that fails (e.g. this path is not
5073 * valid on this machine), use the inode from block 0.
5074 */
5075 if (mch_stat((char *)fname_s, &st) == 0)
5076 ino_s = (ino_t)st.st_ino;
5077 else
5078 ino_s = (ino_t)ino_block0;
5079
5080 if (ino_c && ino_s)
5081 return (ino_c != ino_s);
5082
5083 /*
5084 * One of the inode numbers is unknown, try a forced vim_FullName() and
5085 * compare the file names.
5086 */
5087 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
5088 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
5089 if (retval_c == OK && retval_s == OK)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005090 return STRCMP(buf_c, buf_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091
5092 /*
5093 * Can't compare inodes or file names, guess that the files are different,
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005094 * unless both appear not to exist at all, then compare with the file name
5095 * in the swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 */
5097 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005098 return STRCMP(fname_c, fname_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 return TRUE;
5100}
5101#endif /* CHECK_INODE */
5102
5103/*
5104 * Move a long integer into a four byte character array.
5105 * Used for machine independency in block zero.
5106 */
5107 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005108long_to_char(long n, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109{
5110 s[0] = (char_u)(n & 0xff);
5111 n = (unsigned)n >> 8;
5112 s[1] = (char_u)(n & 0xff);
5113 n = (unsigned)n >> 8;
5114 s[2] = (char_u)(n & 0xff);
5115 n = (unsigned)n >> 8;
5116 s[3] = (char_u)(n & 0xff);
5117}
5118
5119 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005120char_to_long(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121{
5122 long retval;
5123
5124 retval = s[3];
5125 retval <<= 8;
5126 retval |= s[2];
5127 retval <<= 8;
5128 retval |= s[1];
5129 retval <<= 8;
5130 retval |= s[0];
5131
5132 return retval;
5133}
5134
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005135/*
5136 * Set the flags in the first block of the swap file:
5137 * - file is modified or not: buf->b_changed
5138 * - 'fileformat'
5139 * - 'fileencoding'
5140 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005142ml_setflags(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143{
5144 bhdr_T *hp;
5145 ZERO_BL *b0p;
5146
5147 if (!buf->b_ml.ml_mfp)
5148 return;
5149 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
5150 {
5151 if (hp->bh_bnum == 0)
5152 {
5153 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005154 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
5155 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
5156 | (get_fileformat(buf) + 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005157 add_b0_fenc(b0p, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 hp->bh_flags |= BH_DIRTY;
5159 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
5160 break;
5161 }
5162 }
5163}
5164
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005165#if defined(FEAT_CRYPT) || defined(PROTO)
5166/*
5167 * If "data" points to a data block encrypt the text in it and return a copy
5168 * in allocated memory. Return NULL when out of memory.
5169 * Otherwise return "data".
5170 */
5171 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005172ml_encrypt_data(
5173 memfile_T *mfp,
5174 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005175 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005176 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005177{
5178 DATA_BL *dp = (DATA_BL *)data;
5179 char_u *head_end;
5180 char_u *text_start;
5181 char_u *new_data;
5182 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005183 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005184
5185 if (dp->db_id != DATA_ID)
5186 return data;
5187
Bram Moolenaarbc563362015-06-09 18:35:25 +02005188 state = ml_crypt_prepare(mfp, offset, FALSE);
5189 if (state == NULL)
5190 return data;
5191
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005192 new_data = (char_u *)alloc(size);
5193 if (new_data == NULL)
5194 return NULL;
5195 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5196 text_start = (char_u *)dp + dp->db_txt_start;
5197 text_len = size - dp->db_txt_start;
5198
5199 /* Copy the header and the text. */
5200 mch_memmove(new_data, dp, head_end - (char_u *)dp);
5201
5202 /* Encrypt the text. */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005203 crypt_encode(state, text_start, text_len, new_data + dp->db_txt_start);
5204 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005205
5206 /* Clear the gap. */
5207 if (head_end < text_start)
5208 vim_memset(new_data + (head_end - data), 0, text_start - head_end);
5209
5210 return new_data;
5211}
5212
5213/*
Bram Moolenaarbc563362015-06-09 18:35:25 +02005214 * Decrypt the text in "data" if it points to an encrypted data block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005215 */
5216 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005217ml_decrypt_data(
5218 memfile_T *mfp,
5219 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005220 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005221 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005222{
5223 DATA_BL *dp = (DATA_BL *)data;
5224 char_u *head_end;
5225 char_u *text_start;
5226 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005227 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005228
5229 if (dp->db_id == DATA_ID)
5230 {
5231 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5232 text_start = (char_u *)dp + dp->db_txt_start;
5233 text_len = dp->db_txt_end - dp->db_txt_start;
5234
5235 if (head_end > text_start || dp->db_txt_start > size
5236 || dp->db_txt_end > size)
5237 return; /* data was messed up */
5238
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005239 state = ml_crypt_prepare(mfp, offset, TRUE);
Bram Moolenaarbc563362015-06-09 18:35:25 +02005240 if (state != NULL)
5241 {
5242 /* Decrypt the text in place. */
5243 crypt_decode_inplace(state, text_start, text_len);
5244 crypt_free_state(state);
5245 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005246 }
5247}
5248
5249/*
5250 * Prepare for encryption/decryption, using the key, seed and offset.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005251 * Return an allocated cryptstate_T *.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005252 */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005253 static cryptstate_T *
Bram Moolenaar8767f522016-07-01 17:17:39 +02005254ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005255{
5256 buf_T *buf = mfp->mf_buffer;
5257 char_u salt[50];
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005258 int method_nr;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005259 char_u *key;
5260 char_u *seed;
5261
5262 if (reading && mfp->mf_old_key != NULL)
5263 {
5264 /* Reading back blocks with the previous key/method/seed. */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005265 method_nr = mfp->mf_old_cm;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005266 key = mfp->mf_old_key;
5267 seed = mfp->mf_old_seed;
5268 }
5269 else
5270 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005271 method_nr = crypt_get_method_nr(buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005272 key = buf->b_p_key;
5273 seed = mfp->mf_seed;
5274 }
Bram Moolenaarbc563362015-06-09 18:35:25 +02005275 if (*key == NUL)
5276 return NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005277
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005278 if (method_nr == CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005279 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005280 /* For PKzip: Append the offset to the key, so that we use a different
5281 * key for every block. */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005282 vim_snprintf((char *)salt, sizeof(salt), "%s%ld", key, (long)offset);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005283 return crypt_create(method_nr, salt, NULL, 0, NULL, 0);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005284 }
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005285
5286 /* Using blowfish or better: add salt and seed. We use the byte offset
5287 * of the block for the salt. */
5288 vim_snprintf((char *)salt, sizeof(salt), "%ld", (long)offset);
5289 return crypt_create(method_nr, key, salt, (int)STRLEN(salt),
5290 seed, MF_SEED_LEN);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005291}
5292
5293#endif
5294
5295
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296#if defined(FEAT_BYTEOFF) || defined(PROTO)
5297
5298#define MLCS_MAXL 800 /* max no of lines in chunk */
5299#define MLCS_MINL 400 /* should be half of MLCS_MAXL */
5300
5301/*
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02005302 * Keep information for finding byte offset of a line, updtype may be one of:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
5304 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
5305 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
5306 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
5307 */
5308 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005309ml_updatechunk(
5310 buf_T *buf,
5311 linenr_T line,
5312 long len,
5313 int updtype)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314{
5315 static buf_T *ml_upd_lastbuf = NULL;
5316 static linenr_T ml_upd_lastline;
5317 static linenr_T ml_upd_lastcurline;
5318 static int ml_upd_lastcurix;
5319
5320 linenr_T curline = ml_upd_lastcurline;
5321 int curix = ml_upd_lastcurix;
5322 long size;
5323 chunksize_T *curchnk;
5324 int rest;
5325 bhdr_T *hp;
5326 DATA_BL *dp;
5327
5328 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
5329 return;
5330 if (buf->b_ml.ml_chunksize == NULL)
5331 {
5332 buf->b_ml.ml_chunksize = (chunksize_T *)
5333 alloc((unsigned)sizeof(chunksize_T) * 100);
5334 if (buf->b_ml.ml_chunksize == NULL)
5335 {
5336 buf->b_ml.ml_usedchunks = -1;
5337 return;
5338 }
5339 buf->b_ml.ml_numchunks = 100;
5340 buf->b_ml.ml_usedchunks = 1;
5341 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
5342 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
5343 }
5344
5345 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
5346 {
5347 /*
5348 * First line in empty buffer from ml_flush_line() -- reset
5349 */
5350 buf->b_ml.ml_usedchunks = 1;
5351 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01005352 buf->b_ml.ml_chunksize[0].mlcs_totalsize = (long)buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 return;
5354 }
5355
5356 /*
5357 * Find chunk that our line belongs to, curline will be at start of the
5358 * chunk.
5359 */
5360 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
5361 || updtype != ML_CHNK_ADDLINE)
5362 {
5363 for (curline = 1, curix = 0;
5364 curix < buf->b_ml.ml_usedchunks - 1
5365 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5366 curix++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 }
Bram Moolenaara9a8e042018-10-30 22:15:55 +01005369 else if (curix < buf->b_ml.ml_usedchunks - 1
5370 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 {
5372 /* Adjust cached curix & curline */
5373 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5374 curix++;
5375 }
5376 curchnk = buf->b_ml.ml_chunksize + curix;
5377
5378 if (updtype == ML_CHNK_DELLINE)
Bram Moolenaar5a6404c2006-11-01 17:12:57 +00005379 len = -len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 curchnk->mlcs_totalsize += len;
5381 if (updtype == ML_CHNK_ADDLINE)
5382 {
5383 curchnk->mlcs_numlines++;
5384
5385 /* May resize here so we don't have to do it in both cases below */
5386 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
5387 {
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005388 chunksize_T *t_chunksize = buf->b_ml.ml_chunksize;
5389
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
5391 buf->b_ml.ml_chunksize = (chunksize_T *)
5392 vim_realloc(buf->b_ml.ml_chunksize,
5393 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
5394 if (buf->b_ml.ml_chunksize == NULL)
5395 {
5396 /* Hmmmm, Give up on offset for this buffer */
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005397 vim_free(t_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 buf->b_ml.ml_usedchunks = -1;
5399 return;
5400 }
5401 }
5402
5403 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
5404 {
5405 int count; /* number of entries in block */
5406 int idx;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005407 int end_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 int text_end;
5409 int linecnt;
5410
5411 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
5412 buf->b_ml.ml_chunksize + curix,
5413 (buf->b_ml.ml_usedchunks - curix) *
5414 sizeof(chunksize_T));
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00005415 /* Compute length of first half of lines in the split chunk */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 size = 0;
5417 linecnt = 0;
5418 while (curline < buf->b_ml.ml_line_count
5419 && linecnt < MLCS_MINL)
5420 {
5421 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5422 {
5423 buf->b_ml.ml_usedchunks = -1;
5424 return;
5425 }
5426 dp = (DATA_BL *)(hp->bh_data);
5427 count = (long)(buf->b_ml.ml_locked_high) -
5428 (long)(buf->b_ml.ml_locked_low) + 1;
5429 idx = curline - buf->b_ml.ml_locked_low;
5430 curline = buf->b_ml.ml_locked_high + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005431
5432 // compute index of last line to use in this MEMLINE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 rest = count - idx;
5434 if (linecnt + rest > MLCS_MINL)
5435 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005436 end_idx = idx + MLCS_MINL - linecnt - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 linecnt = MLCS_MINL;
5438 }
5439 else
5440 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005441 end_idx = count - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 linecnt += rest;
5443 }
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005444#ifdef FEAT_TEXT_PROP
5445 if (buf->b_has_textprop)
5446 {
5447 int i;
5448
5449 // We cannot use the text pointers to get the text length,
5450 // the text prop info would also be counted. Go over the
5451 // lines.
5452 for (i = end_idx; i < idx; ++i)
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01005453 size += (int)STRLEN((char_u *)dp + (dp->db_index[i] & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005454 }
5455 else
5456#endif
5457 {
5458 if (idx == 0)/* first line in block, text at the end */
5459 text_end = dp->db_txt_end;
5460 else
5461 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
5462 size += text_end - ((dp->db_index[end_idx]) & DB_INDEX_MASK);
5463 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 }
5465 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
5466 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
5467 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
5468 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
5469 buf->b_ml.ml_usedchunks++;
5470 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
5471 return;
5472 }
5473 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
5474 && curix == buf->b_ml.ml_usedchunks - 1
5475 && buf->b_ml.ml_line_count - line <= 1)
5476 {
5477 /*
5478 * We are in the last chunk and it is cheap to crate a new one
5479 * after this. Do it now to avoid the loop above later on
5480 */
5481 curchnk = buf->b_ml.ml_chunksize + curix + 1;
5482 buf->b_ml.ml_usedchunks++;
5483 if (line == buf->b_ml.ml_line_count)
5484 {
5485 curchnk->mlcs_numlines = 0;
5486 curchnk->mlcs_totalsize = 0;
5487 }
5488 else
5489 {
5490 /*
5491 * Line is just prior to last, move count for last
5492 * This is the common case when loading a new file
5493 */
5494 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
5495 if (hp == NULL)
5496 {
5497 buf->b_ml.ml_usedchunks = -1;
5498 return;
5499 }
5500 dp = (DATA_BL *)(hp->bh_data);
5501 if (dp->db_line_count == 1)
5502 rest = dp->db_txt_end - dp->db_txt_start;
5503 else
5504 rest =
5505 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
5506 - dp->db_txt_start;
5507 curchnk->mlcs_totalsize = rest;
5508 curchnk->mlcs_numlines = 1;
5509 curchnk[-1].mlcs_totalsize -= rest;
5510 curchnk[-1].mlcs_numlines -= 1;
5511 }
5512 }
5513 }
5514 else if (updtype == ML_CHNK_DELLINE)
5515 {
5516 curchnk->mlcs_numlines--;
5517 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
5518 if (curix < (buf->b_ml.ml_usedchunks - 1)
5519 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
5520 <= MLCS_MINL)
5521 {
5522 curix++;
5523 curchnk = buf->b_ml.ml_chunksize + curix;
5524 }
5525 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
5526 {
5527 buf->b_ml.ml_usedchunks--;
5528 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
5529 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
5530 return;
5531 }
5532 else if (curix == 0 || (curchnk->mlcs_numlines > 10
5533 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
5534 > MLCS_MINL))
5535 {
5536 return;
5537 }
5538
5539 /* Collapse chunks */
5540 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
5541 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
5542 buf->b_ml.ml_usedchunks--;
5543 if (curix < buf->b_ml.ml_usedchunks)
5544 {
5545 mch_memmove(buf->b_ml.ml_chunksize + curix,
5546 buf->b_ml.ml_chunksize + curix + 1,
5547 (buf->b_ml.ml_usedchunks - curix) *
5548 sizeof(chunksize_T));
5549 }
5550 return;
5551 }
5552 ml_upd_lastbuf = buf;
5553 ml_upd_lastline = line;
5554 ml_upd_lastcurline = curline;
5555 ml_upd_lastcurix = curix;
5556}
5557
5558/*
5559 * Find offset for line or line with offset.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005560 * Find line with offset if "lnum" is 0; return remaining offset in offp
5561 * Find offset of line if "lnum" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 * return -1 if information is not available
5563 */
5564 long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005565ml_find_line_or_offset(buf_T *buf, linenr_T lnum, long *offp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566{
5567 linenr_T curline;
5568 int curix;
5569 long size;
5570 bhdr_T *hp;
5571 DATA_BL *dp;
5572 int count; /* number of entries in block */
5573 int idx;
5574 int start_idx;
5575 int text_end;
5576 long offset;
5577 int len;
5578 int ffdos = (get_fileformat(buf) == EOL_DOS);
5579 int extra = 0;
5580
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005581 /* take care of cached line first */
5582 ml_flush_line(curbuf);
5583
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 if (buf->b_ml.ml_usedchunks == -1
5585 || buf->b_ml.ml_chunksize == NULL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005586 || lnum < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 return -1;
5588
5589 if (offp == NULL)
5590 offset = 0;
5591 else
5592 offset = *offp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005593 if (lnum == 0 && offset <= 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
5595 /*
5596 * Find the last chunk before the one containing our line. Last chunk is
5597 * special because it will never qualify
5598 */
5599 curline = 1;
5600 curix = size = 0;
5601 while (curix < buf->b_ml.ml_usedchunks - 1
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005602 && ((lnum != 0
5603 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 || (offset != 0
5605 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
5606 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
5607 {
5608 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5609 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
5610 if (offset && ffdos)
5611 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5612 curix++;
5613 }
5614
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005615 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 {
5617 if (curline > buf->b_ml.ml_line_count
5618 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5619 return -1;
5620 dp = (DATA_BL *)(hp->bh_data);
5621 count = (long)(buf->b_ml.ml_locked_high) -
5622 (long)(buf->b_ml.ml_locked_low) + 1;
5623 start_idx = idx = curline - buf->b_ml.ml_locked_low;
5624 if (idx == 0)/* first line in block, text at the end */
5625 text_end = dp->db_txt_end;
5626 else
5627 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
5628 /* Compute index of last line to use in this MEMLINE */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005629 if (lnum != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005631 if (curline + (count - idx) >= lnum)
5632 idx += lnum - curline - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 else
5634 idx = count - 1;
5635 }
5636 else
5637 {
5638 extra = 0;
5639 while (offset >= size
5640 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
5641 + ffdos)
5642 {
5643 if (ffdos)
5644 size++;
5645 if (idx == count - 1)
5646 {
5647 extra = 1;
5648 break;
5649 }
5650 idx++;
5651 }
5652 }
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005653#ifdef FEAT_TEXT_PROP
5654 if (buf->b_has_textprop)
5655 {
5656 int i;
5657
5658 // cannot use the db_index pointer, need to get the actual text
5659 // lengths.
5660 len = 0;
5661 for (i = start_idx; i <= idx; ++i)
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01005662 len += (int)STRLEN((char_u *)dp + ((dp->db_index[i]) & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005663 }
5664 else
5665#endif
5666 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 size += len;
5668 if (offset != 0 && size >= offset)
5669 {
5670 if (size + ffdos == offset)
5671 *offp = 0;
5672 else if (idx == start_idx)
5673 *offp = offset - size + len;
5674 else
5675 *offp = offset - size + len
5676 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
5677 curline += idx - start_idx + extra;
5678 if (curline > buf->b_ml.ml_line_count)
5679 return -1; /* exactly one byte beyond the end */
5680 return curline;
5681 }
5682 curline = buf->b_ml.ml_locked_high + 1;
5683 }
5684
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005685 if (lnum != 0)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005686 {
5687 /* Count extra CR characters. */
5688 if (ffdos)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005689 size += lnum - 1;
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005690
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005691 /* Don't count the last line break if 'noeol' and ('bin' or
5692 * 'nofixeol'). */
5693 if ((!buf->b_p_fixeol || buf->b_p_bin) && !buf->b_p_eol
Bram Moolenaarc26f7c62018-08-20 22:53:04 +02005694 && lnum > buf->b_ml.ml_line_count)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005695 size -= ffdos + 1;
5696 }
5697
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 return size;
5699}
5700
5701/*
5702 * Goto byte in buffer with offset 'cnt'.
5703 */
5704 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005705goto_byte(long cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706{
5707 long boff = cnt;
5708 linenr_T lnum;
5709
5710 ml_flush_line(curbuf); /* cached line may be dirty */
5711 setpcmark();
5712 if (boff)
5713 --boff;
5714 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
5715 if (lnum < 1) /* past the end */
5716 {
5717 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
5718 curwin->w_curswant = MAXCOL;
5719 coladvance((colnr_T)MAXCOL);
5720 }
5721 else
5722 {
5723 curwin->w_cursor.lnum = lnum;
5724 curwin->w_cursor.col = (colnr_T)boff;
Bram Moolenaar943d2b52005-12-02 00:50:49 +00005725 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 curwin->w_set_curswant = TRUE;
5727 }
5728 check_cursor();
5729
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 /* Make sure the cursor is on the first byte of a multi-byte char. */
5731 if (has_mbyte)
5732 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733}
5734#endif