blob: e0a49cb7ec3bff0c6cf4f7bd733c3c81bd62ec7c [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
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010010// for debugging
11// #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 Moolenaar4ba37b52019-12-04 21:57:43 +010047#ifndef UNIX // it's in os_unix.h for Unix
Bram Moolenaar071d4272004-06-13 20:20:40 +000048# include <time.h>
49#endif
50
Bram Moolenaar5a6404c2006-11-01 17:12:57 +000051#if defined(SASC) || defined(__amigaos4__)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010052# include <proto/dos.h> // for Open() and Close()
Bram Moolenaar071d4272004-06-13 20:20:40 +000053#endif
54
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010055typedef 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
Bram Moolenaar071d4272004-06-13 20:20:40 +000059
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010060#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
66#define BLOCK0_ID1_C2 'd' // block 0 id 1 'cm' 2
Bram Moolenaar8f4ac012014-08-10 13:38:34 +020067
68#if defined(FEAT_CRYPT)
69static int id1_codes[] = {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010070 BLOCK0_ID1_C0, // CRYPT_M_ZIP
71 BLOCK0_ID1_C1, // CRYPT_M_BF
72 BLOCK0_ID1_C2, // CRYPT_M_BF2
Bram Moolenaar8f4ac012014-08-10 13:38:34 +020073};
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{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010081 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
Bram Moolenaar071d4272004-06-13 20:20:40 +000085};
86
87/*
88 * A pointer block contains a list of branches in the tree.
89 */
90struct pointer_block
91{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010092 short_u pb_id; // ID for pointer block: PTR_ID
93 short_u pb_count; // number of pointers in this block
94 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
Bram Moolenaar071d4272004-06-13 20:20:40 +000097};
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{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100108 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)
Bram Moolenaar4b96df52020-01-26 22:00:26 +0100114 // followed by empty space up to db_txt_start
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100115 // followed by the text in the lines until
116 // end of page
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117};
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
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100130#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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100133#define B0_FNAME_SIZE_ORG 900 // what it was in older versions
134#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 Moolenaar4ba37b52019-12-04 21:57:43 +0100162 char_u b0_id[2]; // id for block 0: BLOCK0_ID0 and BLOCK0_ID1,
163 // BLOCK0_ID1_C0, BLOCK0_ID1_C1, etc.
164 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)
171 char_u b0_fname[B0_FNAME_SIZE_ORG]; // name of file being edited
172 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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176};
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
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100198// 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.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000201#define B0_FF_MASK 3
202
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100203// Swap file is in directory of edited file. Used to find the file from
204// different mount points.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000205#define B0_SAME_DIR 4
206
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100207// The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
208// When empty there is only the NUL.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000209#define B0_HAS_FENC 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100211#define STACK_INCR 5 // nr of entries added to ml_stack at a time
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212
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 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100224#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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000229
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100230// argument for ml_upd_block0()
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200231typedef enum {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100232 UB_FNAME = 0 // update timestamp and filename
233 , UB_SAME_DIR // update the B0_SAME_DIR flag
234 , UB_CRYPT // update crypt key
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200235} 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);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100246static char_u *findswapname(buf_T *, char_u **, char_u *);
247static void ml_flush_line(buf_T *);
248static bhdr_T *ml_new_data(memfile_T *, int, int);
249static bhdr_T *ml_new_ptr(memfile_T *);
250static bhdr_T *ml_find_line(buf_T *, linenr_T, int);
251static int ml_add_stack(buf_T *);
252static void ml_lineadd(buf_T *, int);
253static int b0_magic_wrong(ZERO_BL *);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254#ifdef CHECK_INODE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100255static int fnamecmp_ino(char_u *, char_u *, long);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100257static void long_to_char(long, char_u *);
258static long char_to_long(char_u *);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200259#ifdef FEAT_CRYPT
Bram Moolenaar8767f522016-07-01 17:17:39 +0200260static cryptstate_T *ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200261#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262#ifdef FEAT_BYTEOFF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100263static void ml_updatechunk(buf_T *buf, long line, long len, int updtype);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264#endif
265
266/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000267 * Open a new memline for "buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268 *
Bram Moolenaar4770d092006-01-12 23:22:24 +0000269 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 */
271 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100272ml_open(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273{
274 memfile_T *mfp;
275 bhdr_T *hp = NULL;
276 ZERO_BL *b0p;
277 PTR_BL *pp;
278 DATA_BL *dp;
279
Bram Moolenaar4770d092006-01-12 23:22:24 +0000280 /*
281 * init fields in memline struct
282 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100283 buf->b_ml.ml_stack_size = 0; // no stack yet
284 buf->b_ml.ml_stack = NULL; // no stack yet
285 buf->b_ml.ml_stack_top = 0; // nothing in the stack
286 buf->b_ml.ml_locked = NULL; // no cached block
287 buf->b_ml.ml_line_lnum = 0; // no cached line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288#ifdef FEAT_BYTEOFF
Bram Moolenaar4770d092006-01-12 23:22:24 +0000289 buf->b_ml.ml_chunksize = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000290#endif
291
Bram Moolenaare1004402020-10-24 20:49:43 +0200292 if (cmdmod.cmod_flags & CMOD_NOSWAPFILE)
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100293 buf->b_p_swf = FALSE;
294
Bram Moolenaar4770d092006-01-12 23:22:24 +0000295 /*
296 * When 'updatecount' is non-zero swap file may be opened later.
297 */
298 if (p_uc && buf->b_p_swf)
299 buf->b_may_swap = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300 else
Bram Moolenaar4770d092006-01-12 23:22:24 +0000301 buf->b_may_swap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302
Bram Moolenaar4770d092006-01-12 23:22:24 +0000303 /*
304 * Open the memfile. No swap file is created yet.
305 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 mfp = mf_open(NULL, 0);
307 if (mfp == NULL)
308 goto error;
309
Bram Moolenaar4770d092006-01-12 23:22:24 +0000310 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200311#ifdef FEAT_CRYPT
312 mfp->mf_buffer = buf;
313#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000314 buf->b_ml.ml_flags = ML_EMPTY;
315 buf->b_ml.ml_line_count = 1;
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000316#ifdef FEAT_LINEBREAK
317 curwin->w_nrwidth_line_count = 0;
318#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320/*
321 * fill block0 struct and write page 0
322 */
323 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
324 goto error;
325 if (hp->bh_bnum != 0)
326 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100327 iemsg(_("E298: Didn't get block nr 0?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328 goto error;
329 }
330 b0p = (ZERO_BL *)(hp->bh_data);
331
332 b0p->b0_id[0] = BLOCK0_ID0;
333 b0p->b0_id[1] = BLOCK0_ID1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
335 b0p->b0_magic_int = (int)B0_MAGIC_INT;
336 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
337 b0p->b0_magic_char = B0_MAGIC_CHAR;
Bram Moolenaar22c10562018-05-26 17:35:27 +0200338 mch_memmove(b0p->b0_version, "VIM ", 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339 STRNCPY(b0p->b0_version + 4, Version, 6);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000341
Bram Moolenaar76b92b22006-03-24 22:46:53 +0000342#ifdef FEAT_SPELL
343 if (!buf->b_spell)
344#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000345 {
346 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
347 b0p->b0_flags = get_fileformat(buf) + 1;
348 set_b0_fname(b0p, buf);
349 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
350 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
351 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
352 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
353 long_to_char(mch_get_pid(), b0p->b0_pid);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200354#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200355 ml_set_b0_crypt(buf, b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200356#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000357 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358
359 /*
360 * Always sync block number 0 to disk, so we can check the file name in
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200361 * the swap file in findswapname(). Don't do this for a help files or
362 * a spell buffer though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 * Only works when there's a swapfile, otherwise it's done when the file
364 * is created.
365 */
366 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000367 if (!buf->b_help && !B_SPELL(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 (void)mf_sync(mfp, 0);
369
Bram Moolenaar4770d092006-01-12 23:22:24 +0000370 /*
371 * Fill in root pointer block and write page 1.
372 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373 if ((hp = ml_new_ptr(mfp)) == NULL)
374 goto error;
375 if (hp->bh_bnum != 1)
376 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100377 iemsg(_("E298: Didn't get block nr 1?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378 goto error;
379 }
380 pp = (PTR_BL *)(hp->bh_data);
381 pp->pb_count = 1;
382 pp->pb_pointer[0].pe_bnum = 2;
383 pp->pb_pointer[0].pe_page_count = 1;
384 pp->pb_pointer[0].pe_old_lnum = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100385 pp->pb_pointer[0].pe_line_count = 1; // line count after insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386 mf_put(mfp, hp, TRUE, FALSE);
387
Bram Moolenaar4770d092006-01-12 23:22:24 +0000388 /*
389 * Allocate first data block and create an empty line 1.
390 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
392 goto error;
393 if (hp->bh_bnum != 2)
394 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100395 iemsg(_("E298: Didn't get block nr 2?"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396 goto error;
397 }
398
399 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100400 dp->db_index[0] = --dp->db_txt_start; // at end of block
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401 dp->db_free -= 1 + INDEX_SIZE;
402 dp->db_line_count = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100403 *((char_u *)dp + dp->db_txt_start) = NUL; // empty line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404
405 return OK;
406
407error:
408 if (mfp != NULL)
409 {
410 if (hp)
411 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100412 mf_close(mfp, TRUE); // will also free(mfp->mf_fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 }
Bram Moolenaar4770d092006-01-12 23:22:24 +0000414 buf->b_ml.ml_mfp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415 return FAIL;
416}
417
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200418#if defined(FEAT_CRYPT) || defined(PROTO)
419/*
Bram Moolenaar2be79502014-08-13 21:58:28 +0200420 * Prepare encryption for "buf" for the current key and method.
421 */
422 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100423ml_set_mfp_crypt(buf_T *buf)
Bram Moolenaar2be79502014-08-13 21:58:28 +0200424{
425 if (*buf->b_p_key != NUL)
426 {
427 int method_nr = crypt_get_method_nr(buf);
428
429 if (method_nr > CRYPT_M_ZIP)
430 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100431 // Generate a seed and store it in the memfile.
Bram Moolenaar2be79502014-08-13 21:58:28 +0200432 sha2_seed(buf->b_ml.ml_mfp->mf_seed, MF_SEED_LEN, NULL, 0);
433 }
434 }
435}
436
437/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200438 * Prepare encryption for "buf" with block 0 "b0p".
439 */
440 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100441ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200442{
443 if (*buf->b_p_key == NUL)
444 b0p->b0_id[1] = BLOCK0_ID1;
445 else
446 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200447 int method_nr = crypt_get_method_nr(buf);
448
449 b0p->b0_id[1] = id1_codes[method_nr];
450 if (method_nr > CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200451 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100452 // Generate a seed and store it in block 0 and in the memfile.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200453 sha2_seed(&b0p->b0_seed, MF_SEED_LEN, NULL, 0);
454 mch_memmove(buf->b_ml.ml_mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
455 }
456 }
457}
458
459/*
460 * Called after the crypt key or 'cryptmethod' was changed for "buf".
461 * Will apply this to the swapfile.
462 * "old_key" is the previous key. It is equal to buf->b_p_key when
463 * 'cryptmethod' is changed.
Bram Moolenaar49771f42010-07-20 17:32:38 +0200464 * "old_cm" is the previous 'cryptmethod'. It is equal to the current
465 * 'cryptmethod' when 'key' is changed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200466 */
467 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100468ml_set_crypt_key(
469 buf_T *buf,
470 char_u *old_key,
471 char_u *old_cm)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200472{
473 memfile_T *mfp = buf->b_ml.ml_mfp;
474 bhdr_T *hp;
475 int page_count;
476 int idx;
477 long error;
478 infoptr_T *ip;
479 PTR_BL *pp;
480 DATA_BL *dp;
481 blocknr_T bnum;
482 int top;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200483 int old_method;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200484
Bram Moolenaar3832c462010-08-04 15:32:46 +0200485 if (mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100486 return; // no memfile yet, nothing to do
Bram Moolenaarbc563362015-06-09 18:35:25 +0200487 old_method = crypt_method_nr_from_name(old_cm);
488
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100489 // First make sure the swapfile is in a consistent state, using the old
490 // key and method.
Bram Moolenaarbc563362015-06-09 18:35:25 +0200491 {
492 char_u *new_key = buf->b_p_key;
493 char_u *new_buf_cm = buf->b_p_cm;
494
495 buf->b_p_key = old_key;
496 buf->b_p_cm = old_cm;
497 ml_preserve(buf, FALSE);
498 buf->b_p_key = new_key;
499 buf->b_p_cm = new_buf_cm;
500 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200501
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100502 // Set the key, method and seed to be used for reading, these must be the
503 // old values.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200504 mfp->mf_old_key = old_key;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200505 mfp->mf_old_cm = old_method;
506 if (old_method > 0 && *old_key != NUL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200507 mch_memmove(mfp->mf_old_seed, mfp->mf_seed, MF_SEED_LEN);
508
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100509 // Update block 0 with the crypt flag and may set a new seed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200510 ml_upd_block0(buf, UB_CRYPT);
511
512 if (mfp->mf_infile_count > 2)
513 {
514 /*
515 * Need to read back all data blocks from disk, decrypt them with the
516 * old key/method and mark them to be written. The algorithm is
517 * similar to what happens in ml_recover(), but we skip negative block
518 * numbers.
519 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100520 ml_flush_line(buf); // flush buffered line
521 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200522
523 hp = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100524 bnum = 1; // start with block 1
525 page_count = 1; // which is 1 page
526 idx = 0; // start with first index in block 1
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200527 error = 0;
528 buf->b_ml.ml_stack_top = 0;
Bram Moolenaard23a8232018-02-10 18:45:26 +0100529 VIM_CLEAR(buf->b_ml.ml_stack);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100530 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200531
532 for ( ; !got_int; line_breakcheck())
533 {
534 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100535 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200536
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100537 // get the block (pointer or data)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200538 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
539 {
540 if (bnum == 1)
541 break;
542 ++error;
543 }
544 else
545 {
546 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100547 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200548 {
549 if (pp->pb_count == 0)
550 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100551 // empty block?
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200552 ++error;
553 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100554 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200555 {
556 if (pp->pb_pointer[idx].pe_bnum < 0)
557 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100558 // Skip data block with negative block number.
559 // Should not happen, because of the ml_preserve()
560 // above. Get same block again for next index.
Bram Moolenaar4b7214e2019-01-03 21:55:32 +0100561 ++idx;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200562 continue;
563 }
564
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100565 // going one block deeper in the tree, new entry in
566 // stack
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200567 if ((top = ml_add_stack(buf)) < 0)
568 {
569 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100570 break; // out of memory
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200571 }
572 ip = &(buf->b_ml.ml_stack[top]);
573 ip->ip_bnum = bnum;
574 ip->ip_index = idx;
575
576 bnum = pp->pb_pointer[idx].pe_bnum;
577 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200578 idx = 0;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200579 continue;
580 }
581 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100582 else // not a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200583 {
584 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100585 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200586 ++error;
587 else
588 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100589 // It is a data block, need to write it back to disk.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200590 mf_put(mfp, hp, TRUE, FALSE);
591 hp = NULL;
592 }
593 }
594 }
595
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100596 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200597 break;
598
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100599 // go one block up in the tree
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200600 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
601 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100602 idx = ip->ip_index + 1; // go to next index
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200603 page_count = 1;
604 }
Bram Moolenaarbc563362015-06-09 18:35:25 +0200605 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100606 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +0100607
608 if (error > 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100609 emsg(_("E843: Error while updating swap file crypt"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200610 }
611
612 mfp->mf_old_key = NULL;
613}
614#endif
615
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616/*
617 * ml_setname() is called when the file name of "buf" has been changed.
618 * It may rename the swap file.
619 */
620 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100621ml_setname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622{
623 int success = FALSE;
624 memfile_T *mfp;
625 char_u *fname;
626 char_u *dirp;
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100627#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628 char_u *p;
629#endif
630
631 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100632 if (mfp->mf_fd < 0) // there is no swap file yet
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 {
634 /*
635 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
636 * For help files we will make a swap file now.
637 */
Bram Moolenaare1004402020-10-24 20:49:43 +0200638 if (p_uc != 0 && (cmdmod.cmod_flags & CMOD_NOSWAPFILE) == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100639 ml_open_file(buf); // create a swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 return;
641 }
642
643 /*
644 * Try all directories in the 'directory' option.
645 */
646 dirp = p_dir;
647 for (;;)
648 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100649 if (*dirp == NUL) // tried all directories, fail
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 break;
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000651 fname = findswapname(buf, &dirp, mfp->mf_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100652 // alloc's fname
653 if (dirp == NULL) // out of memory
Bram Moolenaarf541c362011-10-26 11:44:18 +0200654 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100655 if (fname == NULL) // no file name found for this dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 continue;
657
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100658#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 /*
660 * Set full pathname for swap file now, because a ":!cd dir" may
661 * change directory without us knowing it.
662 */
663 p = FullName_save(fname, FALSE);
664 vim_free(fname);
665 fname = p;
666 if (fname == NULL)
667 continue;
668#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100669 // if the file name is the same we don't have to do anything
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 if (fnamecmp(fname, mfp->mf_fname) == 0)
671 {
672 vim_free(fname);
673 success = TRUE;
674 break;
675 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100676 // need to close the swap file before renaming
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 if (mfp->mf_fd >= 0)
678 {
679 close(mfp->mf_fd);
680 mfp->mf_fd = -1;
681 }
682
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100683 // try to rename the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 if (vim_rename(mfp->mf_fname, fname) == 0)
685 {
686 success = TRUE;
687 vim_free(mfp->mf_fname);
688 mfp->mf_fname = fname;
689 vim_free(mfp->mf_ffname);
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100690#if defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100691 mfp->mf_ffname = NULL; // mf_fname is full pathname already
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692#else
693 mf_set_ffname(mfp);
694#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200695 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 break;
697 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100698 vim_free(fname); // this fname didn't work, try another
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 }
700
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100701 if (mfp->mf_fd == -1) // need to (re)open the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 {
703 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
704 if (mfp->mf_fd < 0)
705 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100706 // could not (re)open the swap file, what can we do????
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100707 emsg(_("E301: Oops, lost the swap file!!!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 return;
709 }
Bram Moolenaarf05da212009-11-17 16:13:15 +0000710#ifdef HAVE_FD_CLOEXEC
711 {
712 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
713 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarfbc4b4d2016-02-07 15:14:01 +0100714 (void)fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaarf05da212009-11-17 16:13:15 +0000715 }
716#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717 }
718 if (!success)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100719 emsg(_("E302: Could not rename swap file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720}
721
722/*
723 * Open a file for the memfile for all buffers that are not readonly or have
724 * been modified.
725 * Used when 'updatecount' changes from zero to non-zero.
726 */
727 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100728ml_open_files(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729{
730 buf_T *buf;
731
Bram Moolenaar29323592016-07-24 22:04:11 +0200732 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 if (!buf->b_p_ro || buf->b_changed)
734 ml_open_file(buf);
735}
736
737/*
738 * Open a swap file for an existing memfile, if there is no swap file yet.
739 * If we are unable to find a file name, mf_fname will be NULL
740 * and the memfile will be in memory only (no recovery possible).
741 */
742 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100743ml_open_file(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744{
745 memfile_T *mfp;
746 char_u *fname;
747 char_u *dirp;
748
749 mfp = buf->b_ml.ml_mfp;
Bram Moolenaare1004402020-10-24 20:49:43 +0200750 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf
751 || (cmdmod.cmod_flags & CMOD_NOSWAPFILE))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100752 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753
Bram Moolenaara1956f62006-03-12 22:18:00 +0000754#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100755 // For a spell buffer use a temp file name.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000756 if (buf->b_spell)
757 {
Bram Moolenaare5c421c2015-03-31 13:33:08 +0200758 fname = vim_tempname('s', FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000759 if (fname != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100760 (void)mf_open_file(mfp, fname); // consumes fname!
Bram Moolenaar4770d092006-01-12 23:22:24 +0000761 buf->b_may_swap = FALSE;
762 return;
763 }
764#endif
765
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 /*
767 * Try all directories in 'directory' option.
768 */
769 dirp = p_dir;
770 for (;;)
771 {
772 if (*dirp == NUL)
773 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100774 // There is a small chance that between choosing the swap file name
775 // and creating it, another Vim creates the file. In that case the
776 // creation will fail and we will use another directory.
777 fname = findswapname(buf, &dirp, NULL); // allocates fname
Bram Moolenaarf541c362011-10-26 11:44:18 +0200778 if (dirp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100779 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 if (fname == NULL)
781 continue;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100782 if (mf_open_file(mfp, fname) == OK) // consumes fname!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100784#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 /*
786 * set full pathname for swap file now, because a ":!cd dir" may
787 * change directory without us knowing it.
788 */
789 mf_fullname(mfp);
790#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200791 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000792
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100793 // Flush block zero, so others can read it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 if (mf_sync(mfp, MFS_ZERO) == OK)
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000795 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100796 // Mark all blocks that should be in the swapfile as dirty.
797 // Needed for when the 'swapfile' option was reset, so that
798 // the swap file was deleted, and then on again.
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000799 mf_set_dirty(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 break;
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000801 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100802 // Writing block 0 failed: close the file and try another dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 mf_close_file(buf, FALSE);
804 }
805 }
806
Bram Moolenaar00e192b2019-10-19 17:01:28 +0200807 if (*p_dir != NUL && mfp->mf_fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 {
Bram Moolenaar00e192b2019-10-19 17:01:28 +0200809 need_wait_return = TRUE; // call wait_return later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 ++no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100811 (void)semsg(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
Bram Moolenaare1704ba2012-10-03 18:25:00 +0200812 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813 --no_wait_return;
814 }
815
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100816 // don't try to open a swap file again
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 buf->b_may_swap = FALSE;
818}
819
820/*
821 * If still need to create a swap file, and starting to edit a not-readonly
822 * file, or reading into an existing buffer, create a swap file now.
823 */
824 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100825check_need_swap(
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200826 int newfile) // reading file into new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827{
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200828 int old_msg_silent = msg_silent; // might be reset by an E325 message
829
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
831 ml_open_file(curbuf);
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200832 msg_silent = old_msg_silent;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833}
834
835/*
836 * Close memline for buffer 'buf'.
837 * If 'del_file' is TRUE, delete the swap file
838 */
839 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100840ml_close(buf_T *buf, int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100842 if (buf->b_ml.ml_mfp == NULL) // not open
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 return;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100844 mf_close(buf->b_ml.ml_mfp, del_file); // close the .swp file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
846 vim_free(buf->b_ml.ml_line_ptr);
847 vim_free(buf->b_ml.ml_stack);
848#ifdef FEAT_BYTEOFF
Bram Moolenaard23a8232018-02-10 18:45:26 +0100849 VIM_CLEAR(buf->b_ml.ml_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850#endif
851 buf->b_ml.ml_mfp = NULL;
852
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100853 // Reset the "recovered" flag, give the ATTENTION prompt the next time
854 // this buffer is loaded.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 buf->b_flags &= ~BF_RECOVERED;
856}
857
858/*
859 * Close all existing memlines and memfiles.
860 * Only used when exiting.
861 * When 'del_file' is TRUE, delete the memfiles.
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000862 * But don't delete files that were ":preserve"d when we are POSIX compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 */
864 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100865ml_close_all(int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866{
867 buf_T *buf;
868
Bram Moolenaar29323592016-07-24 22:04:11 +0200869 FOR_ALL_BUFFERS(buf)
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000870 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
871 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100872#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100873 spell_delete_wordlist(); // delete the internal wordlist
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100874#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875#ifdef TEMPDIRNAMES
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100876 vim_deltempdir(); // delete created temp directory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877#endif
878}
879
880/*
881 * Close all memfiles for not modified buffers.
882 * Only use just before exiting!
883 */
884 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100885ml_close_notmod(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886{
887 buf_T *buf;
888
Bram Moolenaar29323592016-07-24 22:04:11 +0200889 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 if (!bufIsChanged(buf))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100891 ml_close(buf, TRUE); // close all not-modified buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892}
893
894/*
895 * Update the timestamp in the .swp file.
896 * Used when the file has been written.
897 */
898 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100899ml_timestamp(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900{
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200901 ml_upd_block0(buf, UB_FNAME);
902}
903
904/*
905 * Return FAIL when the ID of "b0p" is wrong.
906 */
907 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100908ml_check_b0_id(ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200909{
910 if (b0p->b0_id[0] != BLOCK0_ID0
911 || (b0p->b0_id[1] != BLOCK0_ID1
912 && b0p->b0_id[1] != BLOCK0_ID1_C0
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200913 && b0p->b0_id[1] != BLOCK0_ID1_C1
914 && b0p->b0_id[1] != BLOCK0_ID1_C2)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200915 )
916 return FAIL;
917 return OK;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000918}
919
920/*
921 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
922 */
923 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100924ml_upd_block0(buf_T *buf, upd_block0_T what)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000925{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 memfile_T *mfp;
927 bhdr_T *hp;
928 ZERO_BL *b0p;
929
930 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200931 if (mfp == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200933 hp = mf_get(mfp, (blocknr_T)0, 1);
934 if (hp == NULL)
935 {
936#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100937 // Possibly update the seed in the memfile before there is a block0.
Bram Moolenaar2be79502014-08-13 21:58:28 +0200938 if (what == UB_CRYPT)
939 ml_set_mfp_crypt(buf);
940#endif
941 return;
942 }
943
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200945 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100946 iemsg(_("E304: ml_upd_block0(): Didn't get block 0??"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000947 else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000948 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200949 if (what == UB_FNAME)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000950 set_b0_fname(b0p, buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200951#ifdef FEAT_CRYPT
952 else if (what == UB_CRYPT)
953 ml_set_b0_crypt(buf, b0p);
954#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100955 else // what == UB_SAME_DIR
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000956 set_b0_dir_flag(b0p, buf);
957 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958 mf_put(mfp, hp, TRUE, FALSE);
959}
960
961/*
962 * Write file name and timestamp into block 0 of a swap file.
963 * Also set buf->b_mtime.
964 * Don't use NameBuff[]!!!
965 */
966 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100967set_b0_fname(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968{
Bram Moolenaar8767f522016-07-01 17:17:39 +0200969 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970
971 if (buf->b_ffname == NULL)
972 b0p->b0_fname[0] = NUL;
973 else
974 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100975#if defined(MSWIN) || defined(AMIGA)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100976 // Systems that cannot translate "~user" back into a path: copy the
977 // file name unmodified. Do use slashes instead of backslashes for
978 // portability.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200979 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000980# ifdef BACKSLASH_IN_FILENAME
981 forward_slash(b0p->b0_fname);
982# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983#else
984 size_t flen, ulen;
985 char_u uname[B0_UNAME_SIZE];
986
987 /*
988 * For a file under the home directory of the current user, we try to
989 * replace the home directory path with "~user". This helps when
990 * editing the same file on different machines over a network.
991 * First replace home dir path with "~/" with home_replace().
992 * Then insert the user name to get "~user/".
993 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200994 home_replace(NULL, buf->b_ffname, b0p->b0_fname,
995 B0_FNAME_SIZE_CRYPT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 if (b0p->b0_fname[0] == '~')
997 {
998 flen = STRLEN(b0p->b0_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100999 // If there is no user name or it is too long, don't use "~/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001001 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE_CRYPT - 1)
1002 vim_strncpy(b0p->b0_fname, buf->b_ffname,
1003 B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 else
1005 {
1006 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
1007 mch_memmove(b0p->b0_fname + 1, uname, ulen);
1008 }
1009 }
1010#endif
1011 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
1012 {
1013 long_to_char((long)st.st_mtime, b0p->b0_mtime);
1014#ifdef CHECK_INODE
1015 long_to_char((long)st.st_ino, b0p->b0_ino);
1016#endif
1017 buf_store_time(buf, &st, buf->b_ffname);
1018 buf->b_mtime_read = buf->b_mtime;
1019 }
1020 else
1021 {
1022 long_to_char(0L, b0p->b0_mtime);
1023#ifdef CHECK_INODE
1024 long_to_char(0L, b0p->b0_ino);
1025#endif
1026 buf->b_mtime = 0;
1027 buf->b_mtime_read = 0;
1028 buf->b_orig_size = 0;
1029 buf->b_orig_mode = 0;
1030 }
1031 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001032
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001033 // Also add the 'fileencoding' if there is room.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001034 add_b0_fenc(b0p, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035}
1036
1037/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001038 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
1039 * swapfile for "buf" are in the same directory.
1040 * This is fail safe: if we are not sure the directories are equal the flag is
1041 * not set.
1042 */
1043 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001044set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001045{
1046 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
1047 b0p->b0_flags |= B0_SAME_DIR;
1048 else
1049 b0p->b0_flags &= ~B0_SAME_DIR;
1050}
1051
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001052/*
1053 * When there is room, add the 'fileencoding' to block zero.
1054 */
1055 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001056add_b0_fenc(
1057 ZERO_BL *b0p,
1058 buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001059{
1060 int n;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001061 int size = B0_FNAME_SIZE_NOCRYPT;
1062
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001063#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001064 // Without encryption use the same offset as in Vim 7.2 to be compatible.
1065 // With encryption it's OK to move elsewhere, the swap file is not
1066 // compatible anyway.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001067 if (*buf->b_p_key != NUL)
1068 size = B0_FNAME_SIZE_CRYPT;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001069#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001070
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001071 n = (int)STRLEN(buf->b_p_fenc);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001072 if ((int)STRLEN(b0p->b0_fname) + n + 1 > size)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001073 b0p->b0_flags &= ~B0_HAS_FENC;
1074 else
1075 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001076 mch_memmove((char *)b0p->b0_fname + size - n,
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001077 (char *)buf->b_p_fenc, (size_t)n);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001078 *(b0p->b0_fname + size - n - 1) = NUL;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001079 b0p->b0_flags |= B0_HAS_FENC;
1080 }
1081}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001082
1083
1084/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001085 * Try to recover curbuf from the .swp file.
Bram Moolenaar99499b12019-05-23 21:35:48 +02001086 * If "checkext" is TRUE, check the extension and detect whether it is
1087 * a swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088 */
1089 void
Bram Moolenaar99499b12019-05-23 21:35:48 +02001090ml_recover(int checkext)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091{
1092 buf_T *buf = NULL;
1093 memfile_T *mfp = NULL;
1094 char_u *fname;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001095 char_u *fname_used = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 bhdr_T *hp = NULL;
1097 ZERO_BL *b0p;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001098 int b0_ff;
1099 char_u *b0_fenc = NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001100#ifdef FEAT_CRYPT
1101 int b0_cm = -1;
1102#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103 PTR_BL *pp;
1104 DATA_BL *dp;
1105 infoptr_T *ip;
1106 blocknr_T bnum;
1107 int page_count;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001108 stat_T org_stat, swp_stat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109 int len;
1110 int directly;
1111 linenr_T lnum;
1112 char_u *p;
1113 int i;
1114 long error;
1115 int cannot_open;
1116 linenr_T line_count;
1117 int has_error;
1118 int idx;
1119 int top;
1120 int txt_start;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001121 off_T size;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 int called_from_main;
1123 int serious_error = TRUE;
1124 long mtime;
1125 int attr;
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001126 int orig_file_status = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127
1128 recoverymode = TRUE;
1129 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001130 attr = HL_ATTR(HLF_E);
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001131
1132 /*
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001133 * 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 +00001134 * Otherwise a search is done to find the swap file(s).
1135 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 fname = curbuf->b_fname;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001137 if (fname == NULL) // When there is no file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 fname = (char_u *)"";
1139 len = (int)STRLEN(fname);
Bram Moolenaar99499b12019-05-23 21:35:48 +02001140 if (checkext && len >= 4 &&
Bram Moolenaare60acc12011-05-10 16:41:25 +02001141#if defined(VMS)
Bram Moolenaar79518e22017-02-17 16:31:35 +01001142 STRNICMP(fname + len - 4, "_s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143#else
Bram Moolenaar79518e22017-02-17 16:31:35 +01001144 STRNICMP(fname + len - 4, ".s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145#endif
Bram Moolenaar79518e22017-02-17 16:31:35 +01001146 == 0
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001147 && vim_strchr((char_u *)"abcdefghijklmnopqrstuvw",
1148 TOLOWER_ASC(fname[len - 2])) != NULL
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001149 && ASCII_ISALPHA(fname[len - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 {
1151 directly = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001152 fname_used = vim_strsave(fname); // make a copy for mf_open()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 }
1154 else
1155 {
1156 directly = FALSE;
1157
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001158 // count the number of matching swap files
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001159 len = recover_names(fname, FALSE, 0, NULL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001160 if (len == 0) // no swap files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001162 semsg(_("E305: No swap file found for %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 goto theend;
1164 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001165 if (len == 1) // one swap file found, use it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166 i = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001167 else // several swap files found, choose
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001169 // list the names of the swap files
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001170 (void)recover_names(fname, TRUE, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 msg_putchar('\n');
Bram Moolenaar32526b32019-01-19 17:43:09 +01001172 msg_puts(_("Enter number of swap file to use (0 to quit): "));
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001173 i = get_number(FALSE, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 if (i < 1 || i > len)
1175 goto theend;
1176 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001177 // get the swap file name that will be used
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001178 (void)recover_names(fname, FALSE, i, &fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001180 if (fname_used == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001181 goto theend; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001183 // When called from main() still need to initialize storage structure
Bram Moolenaar4770d092006-01-12 23:22:24 +00001184 if (called_from_main && ml_open(curbuf) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 getout(1);
1186
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001187 /*
1188 * Allocate a buffer structure for the swap file that is used for recovery.
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001189 * Only the memline and crypt information in it are really used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001190 */
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001191 buf = ALLOC_ONE(buf_T);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 if (buf == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001195 /*
1196 * init fields in memline struct
1197 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001198 buf->b_ml.ml_stack_size = 0; // no stack yet
1199 buf->b_ml.ml_stack = NULL; // no stack yet
1200 buf->b_ml.ml_stack_top = 0; // nothing in the stack
1201 buf->b_ml.ml_line_lnum = 0; // no cached line
1202 buf->b_ml.ml_locked = NULL; // no locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 buf->b_ml.ml_flags = 0;
Bram Moolenaar0fe849a2010-07-25 15:11:11 +02001204#ifdef FEAT_CRYPT
1205 buf->b_p_key = empty_option;
1206 buf->b_p_cm = empty_option;
1207#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001209 /*
1210 * open the memfile from the old swap file
1211 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001212 p = vim_strsave(fname_used); // save "fname_used" for the message:
1213 // mf_open() will consume "fname_used"!
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001214 mfp = mf_open(fname_used, O_RDONLY);
1215 fname_used = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 if (mfp == NULL || mfp->mf_fd < 0)
1217 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001218 if (fname_used != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001219 semsg(_("E306: Cannot open %s"), fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220 goto theend;
1221 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001223#ifdef FEAT_CRYPT
1224 mfp->mf_buffer = buf;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001225#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226
1227 /*
1228 * The page size set in mf_open() might be different from the page size
1229 * used in the swap file, we must get it from block 0. But to read block
1230 * 0 we need a page size. Use the minimal size for block 0 here, it will
1231 * be set to the real value below.
1232 */
1233 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
1234
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001235 /*
1236 * try to read block 0
1237 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
1239 {
1240 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +01001241 msg_puts_attr(_("Unable to read block 0 from "), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001243 msg_puts_attr(_("\nMaybe no changes were made or Vim did not update the swap file."),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 attr | MSG_HIST);
1245 msg_end();
1246 goto theend;
1247 }
1248 b0p = (ZERO_BL *)(hp->bh_data);
1249 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
1250 {
1251 msg_start();
1252 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001253 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001255 msg_puts_attr(_("Use Vim version 3.0.\n"), MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 msg_end();
1257 goto theend;
1258 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001259 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001261 semsg(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 goto theend;
1263 }
1264 if (b0_magic_wrong(b0p))
1265 {
1266 msg_start();
1267 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001268#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001270 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 attr | MSG_HIST);
1272 else
1273#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001274 msg_puts_attr(_(" cannot be used on this computer.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001276 msg_puts_attr(_("The file was created on "), attr | MSG_HIST);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001277 // avoid going past the end of a corrupted hostname
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278 b0p->b0_fname[0] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001279 msg_puts_attr((char *)b0p->b0_hname, attr | MSG_HIST);
1280 msg_puts_attr(_(",\nor the file has been damaged."), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281 msg_end();
1282 goto theend;
1283 }
Bram Moolenaar1c536282007-04-26 15:21:56 +00001284
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001285#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001286 for (i = 0; i < (int)(sizeof(id1_codes) / sizeof(int)); ++i)
1287 if (id1_codes[i] == b0p->b0_id[1])
1288 b0_cm = i;
1289 if (b0_cm > 0)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001290 mch_memmove(mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001291 crypt_set_cm_option(buf, b0_cm < 0 ? 0 : b0_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001292#else
1293 if (b0p->b0_id[1] != BLOCK0_ID1)
1294 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001295 semsg(_("E833: %s is encrypted and this version of Vim does not support encryption"), mfp->mf_fname);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001296 goto theend;
1297 }
1298#endif
1299
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 /*
1301 * If we guessed the wrong page size, we have to recalculate the
1302 * highest block number in the file.
1303 */
1304 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1305 {
Bram Moolenaar1c536282007-04-26 15:21:56 +00001306 unsigned previous_page_size = mfp->mf_page_size;
1307
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
Bram Moolenaar1c536282007-04-26 15:21:56 +00001309 if (mfp->mf_page_size < previous_page_size)
1310 {
1311 msg_start();
1312 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001313 msg_puts_attr(_(" has been damaged (page size is smaller than minimum value).\n"),
Bram Moolenaar1c536282007-04-26 15:21:56 +00001314 attr | MSG_HIST);
1315 msg_end();
1316 goto theend;
1317 }
Bram Moolenaar8767f522016-07-01 17:17:39 +02001318 if ((size = vim_lseek(mfp->mf_fd, (off_T)0L, SEEK_END)) <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001319 mfp->mf_blocknr_max = 0; // no file or empty file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 else
1321 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1322 mfp->mf_infile_count = mfp->mf_blocknr_max;
Bram Moolenaar1c536282007-04-26 15:21:56 +00001323
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001324 // need to reallocate the memory used to store the data
Bram Moolenaar1c536282007-04-26 15:21:56 +00001325 p = alloc(mfp->mf_page_size);
1326 if (p == NULL)
1327 goto theend;
1328 mch_memmove(p, hp->bh_data, previous_page_size);
1329 vim_free(hp->bh_data);
1330 hp->bh_data = p;
1331 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 }
1333
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001334 /*
1335 * If .swp file name given directly, use name from swap file for buffer.
1336 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 if (directly)
1338 {
1339 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1340 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1341 goto theend;
1342 }
1343
1344 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001345 smsg(_("Using swap file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346
1347 if (buf_spname(curbuf) != NULL)
Bram Moolenaare1704ba2012-10-03 18:25:00 +02001348 vim_strncpy(NameBuff, buf_spname(curbuf), MAXPATHL - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349 else
1350 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001351 smsg(_("Original file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 msg_putchar('\n');
1353
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001354 /*
1355 * check date of swap file and original file
1356 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 mtime = char_to_long(b0p->b0_mtime);
1358 if (curbuf->b_ffname != NULL
1359 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1360 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1361 && org_stat.st_mtime > swp_stat.st_mtime)
1362 || org_stat.st_mtime != mtime))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001363 emsg(_("E308: Warning: Original file may have been changed"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364 out_flush();
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001365
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001366 // Get the 'fileformat' and 'fileencoding' from block zero.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001367 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1368 if (b0p->b0_flags & B0_HAS_FENC)
1369 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001370 int fnsize = B0_FNAME_SIZE_NOCRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001371
1372#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001373 // Use the same size as in add_b0_fenc().
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001374 if (b0p->b0_id[1] != BLOCK0_ID1)
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001375 fnsize = B0_FNAME_SIZE_CRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001376#endif
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001377 for (p = b0p->b0_fname + fnsize; p > b0p->b0_fname && p[-1] != NUL; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001378 ;
Bram Moolenaar71ccd032020-06-12 22:59:11 +02001379 b0_fenc = vim_strnsave(p, b0p->b0_fname + fnsize - p);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001380 }
1381
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001382 mf_put(mfp, hp, FALSE, FALSE); // release block 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383 hp = NULL;
1384
1385 /*
1386 * Now that we are sure that the file is going to be recovered, clear the
1387 * contents of the current buffer.
1388 */
1389 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001390 ml_delete((linenr_T)1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391
1392 /*
1393 * Try reading the original file to obtain the values of 'fileformat',
1394 * 'fileencoding', etc. Ignore errors. The text itself is not used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001395 * When the file is encrypted the user is asked to enter the key.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 */
1397 if (curbuf->b_ffname != NULL)
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001398 orig_file_status = readfile(curbuf->b_ffname, NULL, (linenr_T)0,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001401#ifdef FEAT_CRYPT
1402 if (b0_cm >= 0)
1403 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001404 // Need to ask the user for the crypt key. If this fails we continue
1405 // without a key, will probably get garbage text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001406 if (*curbuf->b_p_key != NUL)
1407 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001408 smsg(_("Swap file is encrypted: \"%s\""), fname_used);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001409 msg_puts(_("\nIf you entered a new crypt key but did not write the text file,"));
1410 msg_puts(_("\nenter the new crypt key."));
1411 msg_puts(_("\nIf you wrote the text file after changing the crypt key press enter"));
1412 msg_puts(_("\nto use the same key for text file and swap file"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001413 }
1414 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001415 smsg(_(need_key_msg), fname_used);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001416 buf->b_p_key = crypt_get_key(FALSE, FALSE);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001417 if (buf->b_p_key == NULL)
1418 buf->b_p_key = curbuf->b_p_key;
1419 else if (*buf->b_p_key == NUL)
1420 {
1421 vim_free(buf->b_p_key);
1422 buf->b_p_key = curbuf->b_p_key;
1423 }
1424 if (buf->b_p_key == NULL)
1425 buf->b_p_key = empty_option;
1426 }
1427#endif
1428
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001429 // Use the 'fileformat' and 'fileencoding' as stored in the swap file.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001430 if (b0_ff != 0)
1431 set_fileformat(b0_ff - 1, OPT_LOCAL);
1432 if (b0_fenc != NULL)
1433 {
1434 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1435 vim_free(b0_fenc);
1436 }
Bram Moolenaarc024b462019-06-08 18:07:21 +02001437 unchanged(curbuf, TRUE, TRUE);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001438
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001439 bnum = 1; // start with block 1
1440 page_count = 1; // which is 1 page
1441 lnum = 0; // append after line 0 in curbuf
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 line_count = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001443 idx = 0; // start with first index in block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 error = 0;
1445 buf->b_ml.ml_stack_top = 0;
1446 buf->b_ml.ml_stack = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001447 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 if (curbuf->b_ffname == NULL)
1450 cannot_open = TRUE;
1451 else
1452 cannot_open = FALSE;
1453
1454 serious_error = FALSE;
1455 for ( ; !got_int; line_breakcheck())
1456 {
1457 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001458 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459
1460 /*
1461 * get block
1462 */
1463 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1464 {
1465 if (bnum == 1)
1466 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001467 semsg(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 goto theend;
1469 }
1470 ++error;
1471 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1472 (colnr_T)0, TRUE);
1473 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001474 else // there is a block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475 {
1476 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001477 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001479 // check line count when using pointer block first time
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 if (idx == 0 && line_count != 0)
1481 {
1482 for (i = 0; i < (int)pp->pb_count; ++i)
1483 line_count -= pp->pb_pointer[i].pe_line_count;
1484 if (line_count != 0)
1485 {
1486 ++error;
1487 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1488 (colnr_T)0, TRUE);
1489 }
1490 }
1491
1492 if (pp->pb_count == 0)
1493 {
1494 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1495 (colnr_T)0, TRUE);
1496 ++error;
1497 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001498 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 {
1500 if (pp->pb_pointer[idx].pe_bnum < 0)
1501 {
1502 /*
1503 * Data block with negative block number.
1504 * Try to read lines from the original file.
1505 * This is slow, but it works.
1506 */
1507 if (!cannot_open)
1508 {
1509 line_count = pp->pb_pointer[idx].pe_line_count;
1510 if (readfile(curbuf->b_ffname, NULL, lnum,
1511 pp->pb_pointer[idx].pe_old_lnum - 1,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001512 line_count, NULL, 0) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 cannot_open = TRUE;
1514 else
1515 lnum += line_count;
1516 }
1517 if (cannot_open)
1518 {
1519 ++error;
1520 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1521 (colnr_T)0, TRUE);
1522 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001523 ++idx; // get same block again for next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 continue;
1525 }
1526
1527 /*
1528 * going one block deeper in the tree
1529 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001530 if ((top = ml_add_stack(buf)) < 0) // new entry in stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 {
1532 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001533 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 }
1535 ip = &(buf->b_ml.ml_stack[top]);
1536 ip->ip_bnum = bnum;
1537 ip->ip_index = idx;
1538
1539 bnum = pp->pb_pointer[idx].pe_bnum;
1540 line_count = pp->pb_pointer[idx].pe_line_count;
1541 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaar986a0032011-06-13 01:07:27 +02001542 idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 continue;
1544 }
1545 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001546 else // not a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 {
1548 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001549 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 {
1551 if (bnum == 1)
1552 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001553 semsg(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 mfp->mf_fname);
1555 goto theend;
1556 }
1557 ++error;
1558 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1559 (colnr_T)0, TRUE);
1560 }
1561 else
1562 {
1563 /*
1564 * it is a data block
1565 * Append all the lines in this block
1566 */
1567 has_error = FALSE;
1568 /*
1569 * check length of block
1570 * if wrong, use length in pointer block
1571 */
1572 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1573 {
1574 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1575 (colnr_T)0, TRUE);
1576 ++error;
1577 has_error = TRUE;
1578 dp->db_txt_end = page_count * mfp->mf_page_size;
1579 }
1580
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001581 // make sure there is a NUL at the end of the block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1583
1584 /*
1585 * check number of lines in block
1586 * if wrong, use count in data block
1587 */
1588 if (line_count != dp->db_line_count)
1589 {
1590 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1591 (colnr_T)0, TRUE);
1592 ++error;
1593 has_error = TRUE;
1594 }
1595
1596 for (i = 0; i < dp->db_line_count; ++i)
1597 {
1598 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
Bram Moolenaar740885b2009-11-03 14:33:17 +00001599 if (txt_start <= (int)HEADER_SIZE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 || txt_start >= (int)dp->db_txt_end)
1601 {
1602 p = (char_u *)"???";
1603 ++error;
1604 }
1605 else
1606 p = (char_u *)dp + txt_start;
1607 ml_append(lnum++, p, (colnr_T)0, TRUE);
1608 }
1609 if (has_error)
Bram Moolenaar740885b2009-11-03 14:33:17 +00001610 ml_append(lnum++, (char_u *)_("???END"),
1611 (colnr_T)0, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 }
1613 }
1614 }
1615
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001616 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617 break;
1618
1619 /*
1620 * go one block up in the tree
1621 */
1622 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1623 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001624 idx = ip->ip_index + 1; // go to next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 page_count = 1;
1626 }
1627
1628 /*
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001629 * Compare the buffer contents with the original file. When they differ
1630 * set the 'modified' flag.
1631 * Lines 1 - lnum are the new contents.
1632 * Lines lnum + 1 to ml_line_count are the original contents.
1633 * Line ml_line_count + 1 in the dummy empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 */
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001635 if (orig_file_status != OK || curbuf->b_ml.ml_line_count != lnum * 2 + 1)
1636 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001637 // Recovering an empty file results in two lines and the first line is
1638 // empty. Don't set the modified flag then.
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001639 if (!(curbuf->b_ml.ml_line_count == 2 && *ml_get(1) == NUL))
1640 {
Bram Moolenaarec28d152019-05-11 18:36:34 +02001641 changed_internal();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001642 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001643 }
1644 }
1645 else
1646 {
1647 for (idx = 1; idx <= lnum; ++idx)
1648 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001649 // Need to copy one line, fetching the other one may flush it.
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001650 p = vim_strsave(ml_get(idx));
1651 i = STRCMP(p, ml_get(idx + lnum));
1652 vim_free(p);
1653 if (i != 0)
1654 {
Bram Moolenaarec28d152019-05-11 18:36:34 +02001655 changed_internal();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001656 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001657 break;
1658 }
1659 }
1660 }
1661
1662 /*
1663 * Delete the lines from the original file and the dummy line from the
1664 * empty buffer. These will now be after the last line in the buffer.
1665 */
1666 while (curbuf->b_ml.ml_line_count > lnum
1667 && !(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001668 ml_delete(curbuf->b_ml.ml_line_count);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 curbuf->b_flags |= BF_RECOVERED;
1670
1671 recoverymode = FALSE;
1672 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001673 emsg(_("E311: Recovery Interrupted"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 else if (error)
1675 {
1676 ++no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001677 msg(">>>>>>>>>>>>>");
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001678 emsg(_("E312: Errors detected while recovering; look for lines starting with ???"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 --no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001680 msg(_("See \":help E312\" for more information."));
1681 msg(">>>>>>>>>>>>>");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 }
1683 else
1684 {
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001685 if (curbuf->b_changed)
1686 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001687 msg(_("Recovery completed. You should check if everything is OK."));
1688 msg_puts(_("\n(You might want to write out this file under another name\n"));
1689 msg_puts(_("and run diff with the original file to check for changes)"));
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001690 }
1691 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001692 msg(_("Recovery completed. Buffer contents equals file contents."));
1693 msg_puts(_("\nYou may want to delete the .swp file now.\n\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 cmdline_row = msg_row;
1695 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001696#ifdef FEAT_CRYPT
1697 if (*buf->b_p_key != NUL && STRCMP(curbuf->b_p_key, buf->b_p_key) != 0)
1698 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001699 msg_puts(_("Using crypt key from swap file for the text file.\n"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001700 set_option_value((char_u *)"key", 0L, buf->b_p_key, OPT_LOCAL);
1701 }
1702#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703 redraw_curbuf_later(NOT_VALID);
1704
1705theend:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001706 vim_free(fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 recoverymode = FALSE;
1708 if (mfp != NULL)
1709 {
1710 if (hp != NULL)
1711 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001712 mf_close(mfp, FALSE); // will also vim_free(mfp->mf_fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 }
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001714 if (buf != NULL)
1715 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001716#ifdef FEAT_CRYPT
1717 if (buf->b_p_key != curbuf->b_p_key)
1718 free_string_option(buf->b_p_key);
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001719 free_string_option(buf->b_p_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001720#endif
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001721 vim_free(buf->b_ml.ml_stack);
1722 vim_free(buf);
1723 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 if (serious_error && called_from_main)
1725 ml_close(curbuf, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 else
1727 {
1728 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1729 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1730 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 return;
1732}
1733
1734/*
1735 * Find the names of swap files in current directory and the directory given
1736 * with the 'directory' option.
1737 *
1738 * Used to:
1739 * - list the swap files for "vim -r"
1740 * - count the number of swap files when recovering
1741 * - list the swap files when recovering
1742 * - find the name of the n'th swap file when recovering
1743 */
1744 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001745recover_names(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001746 char_u *fname, // base for swap file name
1747 int list, // when TRUE, list the swap file names
1748 int nr, // when non-zero, return nr'th swap file name
1749 char_u **fname_out) // result when "nr" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750{
1751 int num_names;
1752 char_u *(names[6]);
1753 char_u *tail;
1754 char_u *p;
1755 int num_files;
1756 int file_count = 0;
1757 char_u **files;
1758 int i;
1759 char_u *dirp;
1760 char_u *dir_name;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001761 char_u *fname_res = NULL;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001762#ifdef HAVE_READLINK
1763 char_u fname_buf[MAXPATHL];
Bram Moolenaar64354da2010-05-25 21:37:17 +02001764#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001765
Bram Moolenaar64354da2010-05-25 21:37:17 +02001766 if (fname != NULL)
1767 {
1768#ifdef HAVE_READLINK
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001769 // Expand symlink in the file name, because the swap file is created
1770 // with the actual file instead of with the symlink.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001771 if (resolve_symlink(fname, fname_buf) == OK)
1772 fname_res = fname_buf;
1773 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001774#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001775 fname_res = fname;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001776 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777
1778 if (list)
1779 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001780 // use msg() to start the scrolling properly
Bram Moolenaar32526b32019-01-19 17:43:09 +01001781 msg(_("Swap files found:"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 msg_putchar('\n');
1783 }
1784
1785 /*
1786 * Do the loop for every directory in 'directory'.
1787 * First allocate some memory to put the directory name in.
1788 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02001789 dir_name = alloc(STRLEN(p_dir) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 dirp = p_dir;
1791 while (dir_name != NULL && *dirp)
1792 {
1793 /*
1794 * Isolate a directory name from *dirp and put it in dir_name (we know
1795 * it is large enough, so use 31000 for length).
1796 * Advance dirp to next directory name.
1797 */
1798 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1799
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001800 if (dir_name[0] == '.' && dir_name[1] == NUL) // check current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001802 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 {
1804#ifdef VMS
1805 names[0] = vim_strsave((char_u *)"*_sw%");
1806#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 names[0] = vim_strsave((char_u *)"*.sw?");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001809#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001810 // For Unix names starting with a dot are special. MS-Windows
1811 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 names[1] = vim_strsave((char_u *)".*.sw?");
1813 names[2] = vim_strsave((char_u *)".sw?");
1814 num_names = 3;
1815#else
1816# ifdef VMS
1817 names[1] = vim_strsave((char_u *)".*_sw%");
1818 num_names = 2;
1819# else
1820 num_names = 1;
1821# endif
1822#endif
1823 }
1824 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001825 num_names = recov_file_names(names, fname_res, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001827 else // check directory dir_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001829 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 {
1831#ifdef VMS
1832 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1833#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001836#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001837 // For Unix names starting with a dot are special. MS-Windows
1838 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1840 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1841 num_names = 3;
1842#else
1843# ifdef VMS
1844 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1845 num_names = 2;
1846# else
1847 num_names = 1;
1848# endif
1849#endif
1850 }
1851 else
1852 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01001853#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01001854 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01001855
1856 p = dir_name + len;
1857 if (after_pathsep(dir_name, p) && len > 1 && p[-1] == p[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001859 // Ends with '//', Use Full path for swap name
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001860 tail = make_percent_swname(dir_name, fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 }
1862 else
1863#endif
1864 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001865 tail = gettail(fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 tail = concat_fnames(dir_name, tail, TRUE);
1867 }
1868 if (tail == NULL)
1869 num_names = 0;
1870 else
1871 {
1872 num_names = recov_file_names(names, tail, FALSE);
1873 vim_free(tail);
1874 }
1875 }
1876 }
1877
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02001878 // check for out-of-memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 for (i = 0; i < num_names; ++i)
1880 {
1881 if (names[i] == NULL)
1882 {
1883 for (i = 0; i < num_names; ++i)
1884 vim_free(names[i]);
1885 num_names = 0;
1886 }
1887 }
1888 if (num_names == 0)
1889 num_files = 0;
1890 else if (expand_wildcards(num_names, names, &num_files, &files,
Bram Moolenaar99499b12019-05-23 21:35:48 +02001891 EW_NOTENV|EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 num_files = 0;
1893
1894 /*
1895 * When no swap file found, wildcard expansion might have failed (e.g.
1896 * not able to execute the shell).
1897 * Try finding a swap file by simply adding ".swp" to the file name.
1898 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001899 if (*dirp == NUL && file_count + num_files == 0 && fname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 {
Bram Moolenaar8767f522016-07-01 17:17:39 +02001901 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 char_u *swapname;
1903
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001904 swapname = modname(fname_res,
Bram Moolenaare60acc12011-05-10 16:41:25 +02001905#if defined(VMS)
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001906 (char_u *)"_swp", FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907#else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001908 (char_u *)".swp", TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001910 );
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 if (swapname != NULL)
1912 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001913 if (mch_stat((char *)swapname, &st) != -1) // It exists!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001915 files = ALLOC_ONE(char_u *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 if (files != NULL)
1917 {
1918 files[0] = swapname;
1919 swapname = NULL;
1920 num_files = 1;
1921 }
1922 }
1923 vim_free(swapname);
1924 }
1925 }
1926
1927 /*
1928 * remove swapfile name of the current buffer, it must be ignored
1929 */
1930 if (curbuf->b_ml.ml_mfp != NULL
1931 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1932 {
1933 for (i = 0; i < num_files; ++i)
Bram Moolenaar99499b12019-05-23 21:35:48 +02001934 // Do not expand wildcards, on windows would try to expand
1935 // "%tmp%" in "%tmp%file".
1936 if (fullpathcmp(p, files[i], TRUE, FALSE) & FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 {
Bram Moolenaar99499b12019-05-23 21:35:48 +02001938 // Remove the name from files[i]. Move further entries
1939 // down. When the array becomes empty free it here, since
1940 // FreeWild() won't be called below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 vim_free(files[i]);
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00001942 if (--num_files == 0)
1943 vim_free(files);
1944 else
1945 for ( ; i < num_files; ++i)
1946 files[i] = files[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 }
1948 }
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001949 if (nr > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 {
1951 file_count += num_files;
1952 if (nr <= file_count)
1953 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001954 *fname_out = vim_strsave(
1955 files[nr - 1 + num_files - file_count]);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001956 dirp = (char_u *)""; // stop searching
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 }
1958 }
1959 else if (list)
1960 {
1961 if (dir_name[0] == '.' && dir_name[1] == NUL)
1962 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001963 if (fname == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001964 msg_puts(_(" In current directory:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001966 msg_puts(_(" Using specified name:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 }
1968 else
1969 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001970 msg_puts(_(" In directory "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 msg_home_replace(dir_name);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001972 msg_puts(":\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 }
1974
1975 if (num_files)
1976 {
1977 for (i = 0; i < num_files; ++i)
1978 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001979 // print the swap file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 msg_outnum((long)++file_count);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001981 msg_puts(". ");
1982 msg_puts((char *)gettail(files[i]));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983 msg_putchar('\n');
1984 (void)swapfile_info(files[i]);
1985 }
1986 }
1987 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001988 msg_puts(_(" -- none --\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989 out_flush();
1990 }
1991 else
1992 file_count += num_files;
1993
1994 for (i = 0; i < num_names; ++i)
1995 vim_free(names[i]);
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001996 if (num_files > 0)
1997 FreeWild(num_files, files);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998 }
1999 vim_free(dir_name);
2000 return file_count;
2001}
2002
Bram Moolenaar4f974752019-02-17 17:44:42 +01002003#if defined(UNIX) || defined(MSWIN) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004/*
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002005 * Need _very_ long file names.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 * Append the full path to name with path separators made into percent
2007 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
2008 */
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002009 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002010make_percent_swname(char_u *dir, char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011{
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002012 char_u *d = NULL, *s, *f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002014 f = fix_fname(name != NULL ? name : (char_u *)"");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 if (f != NULL)
2016 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02002017 s = alloc(STRLEN(f) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 if (s != NULL)
2019 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002020 STRCPY(s, f);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002021 for (d = s; *d != NUL; MB_PTR_ADV(d))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002022 if (vim_ispathsep(*d))
2023 *d = '%';
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 d = concat_fnames(dir, s, TRUE);
2025 vim_free(s);
2026 }
2027 vim_free(f);
2028 }
2029 return d;
2030}
2031#endif
2032
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002033#if (defined(UNIX) || defined(VMS) || defined(MSWIN)) \
2034 && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
2035# define HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036static int process_still_running;
2037#endif
2038
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002039#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040/*
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002041 * Return information found in swapfile "fname" in dictionary "d".
2042 * This is used by the swapinfo() function.
2043 */
2044 void
2045get_b0_dict(char_u *fname, dict_T *d)
2046{
2047 int fd;
2048 struct block0 b0;
2049
2050 if ((fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
2051 {
2052 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
2053 {
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002054 if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002055 dict_add_string(d, "error", (char_u *)"Not a swap file");
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002056 else if (b0_magic_wrong(&b0))
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002057 dict_add_string(d, "error", (char_u *)"Magic number mismatch");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002058 else
2059 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002060 // we have swap information
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002061 dict_add_string_len(d, "version", b0.b0_version, 10);
2062 dict_add_string_len(d, "user", b0.b0_uname, B0_UNAME_SIZE);
2063 dict_add_string_len(d, "host", b0.b0_hname, B0_HNAME_SIZE);
2064 dict_add_string_len(d, "fname", b0.b0_fname, B0_FNAME_SIZE_ORG);
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002065
2066 dict_add_number(d, "pid", char_to_long(b0.b0_pid));
2067 dict_add_number(d, "mtime", char_to_long(b0.b0_mtime));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002068 dict_add_number(d, "dirty", b0.b0_dirty ? 1 : 0);
2069# ifdef CHECK_INODE
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002070 dict_add_number(d, "inode", char_to_long(b0.b0_ino));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002071# endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002072 }
2073 }
2074 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002075 dict_add_string(d, "error", (char_u *)"Cannot read file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002076 close(fd);
2077 }
2078 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002079 dict_add_string(d, "error", (char_u *)"Cannot open file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002080}
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002081#endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002082
2083/*
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00002084 * Give information about an existing swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 * Returns timestamp (0 when unknown).
2086 */
2087 static time_t
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002088swapfile_info(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002090 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 int fd;
2092 struct block0 b0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093#ifdef UNIX
2094 char_u uname[B0_UNAME_SIZE];
2095#endif
2096
Bram Moolenaar63d25552019-05-10 21:28:38 +02002097 // print the swap file date
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 if (mch_stat((char *)fname, &st) != -1)
2099 {
2100#ifdef UNIX
Bram Moolenaar63d25552019-05-10 21:28:38 +02002101 // print name of owner of the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
2103 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002104 msg_puts(_(" owned by: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 msg_outtrans(uname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002106 msg_puts(_(" dated: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 }
2108 else
2109#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002110 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02002111 msg_puts(get_ctime(st.st_mtime, TRUE));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 }
Bram Moolenaar63d25552019-05-10 21:28:38 +02002113 else
2114 st.st_mtime = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115
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)
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002163 if (mch_process_running(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 Moolenaar1b243ea2019-04-28 22:50:40 +02002166# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 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
Bram Moolenaar63d25552019-05-10 21:28:38 +02002192 return st.st_mtime;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193}
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;
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002206#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002207 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)
Bram Moolenaar32aa1022019-11-02 22:54:41 +01002233 // process must be known and not be running
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002234 pid = char_to_long(b0.b0_pid);
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002235 if (pid == 0L || mch_process_running(pid))
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002236 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;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002288 if (num_names >= 1) // check if we have the same name twice
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 {
2290 p = names[num_names - 1];
2291 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
2292 if (i > 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002293 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294
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)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002322 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 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)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002353 continue; // no file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002355 ml_flush_line(buf); // flush buffered line
2356 // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 (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;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002371 need_check_timestamps = TRUE; // give message later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 }
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));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002378 if (check_char && ui_char_avail()) // character available now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 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
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002410 // We only want to stop when interrupted here, not when interrupted
2411 // before.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 got_int = FALSE;
2413
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002414 ml_flush_line(buf); // flush buffered line
2415 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2417
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002418 // stack is invalid after mf_sync(.., MFS_ALL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 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 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002447 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
2448 // sync the updated pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2450 status = FAIL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002451 buf->b_ml.ml_stack_top = 0; // stack is invalid now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 }
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,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002522 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
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002528 if (lnum > buf->b_ml.ml_line_count) // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002530 if (recursive == 0)
2531 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002532 // Avoid giving this message for a recursive call, may happen when
2533 // the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002534 ++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, "???");
Bram Moolenaaradfde112019-05-25 22:11:45 +02002540 buf->b_ml.ml_line_len = 4;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 return IObuff;
2542 }
Bram Moolenaaradfde112019-05-25 22:11:45 +02002543 if (lnum <= 0) // pretend line 0 is line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 lnum = 1;
2545
Bram Moolenaaradfde112019-05-25 22:11:45 +02002546 if (buf->b_ml.ml_mfp == NULL) // there are no lines
2547 {
2548 buf->b_ml.ml_line_len = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 return (char_u *)"";
Bram Moolenaaradfde112019-05-25 22:11:45 +02002550 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551
Bram Moolenaar37d619f2010-03-10 14:46:26 +01002552 /*
2553 * See if it is the same line as requested last time.
2554 * Otherwise may need to flush last used line.
2555 * Don't use the last used line when 'swapfile' is reset, need to load all
2556 * blocks.
2557 */
Bram Moolenaar47b8b152007-02-07 02:41:57 +00002558 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002560 unsigned start, end;
2561 colnr_T len;
2562 int idx;
2563
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 ml_flush_line(buf);
2565
2566 /*
2567 * Find the data block containing the line.
2568 * This also fills the stack with the blocks from the root to the data
2569 * block and releases any locked block.
2570 */
2571 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2572 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002573 if (recursive == 0)
2574 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002575 // Avoid giving this message for a recursive call, may happen
2576 // when the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002577 ++recursive;
Bram Moolenaarcb868932019-10-26 20:56:21 +02002578 get_trans_bufname(buf);
2579 shorten_dir(NameBuff);
2580 siemsg(_("E316: ml_get: cannot find line %ld in buffer %d %s"),
2581 lnum, buf->b_fnum, NameBuff);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002582 --recursive;
2583 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 goto errorret;
2585 }
2586
2587 dp = (DATA_BL *)(hp->bh_data);
2588
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002589 idx = lnum - buf->b_ml.ml_locked_low;
2590 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2591 // The text ends where the previous line starts. The first line ends
2592 // at the end of the block.
2593 if (idx == 0)
2594 end = dp->db_txt_end;
2595 else
2596 end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
2597 len = end - start;
2598
2599 buf->b_ml.ml_line_ptr = (char_u *)dp + start;
2600 buf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 buf->b_ml.ml_line_lnum = lnum;
2602 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2603 }
2604 if (will_change)
2605 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2606
2607 return buf->b_ml.ml_line_ptr;
2608}
2609
2610/*
2611 * Check if a line that was just obtained by a call to ml_get
2612 * is in allocated memory.
2613 */
2614 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002615ml_line_alloced(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616{
2617 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2618}
2619
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002620#ifdef FEAT_PROP_POPUP
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002621/*
2622 * Add text properties that continue from the previous line.
2623 */
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002624 static void
2625add_text_props_for_append(
2626 buf_T *buf,
2627 linenr_T lnum,
2628 char_u **line,
2629 int *len,
2630 char_u **tofree)
2631{
2632 int round;
2633 int new_prop_count = 0;
2634 int count;
2635 int n;
2636 char_u *props;
Bram Moolenaarea781452019-09-04 18:53:12 +02002637 int new_len = 0; // init for gcc
Bram Moolenaar8f13d822020-09-12 21:04:23 +02002638 char_u *new_line = NULL;
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002639 textprop_T prop;
2640
2641 // Make two rounds:
2642 // 1. calculate the extra space needed
2643 // 2. allocate the space and fill it
2644 for (round = 1; round <= 2; ++round)
2645 {
2646 if (round == 2)
2647 {
2648 if (new_prop_count == 0)
2649 return; // nothing to do
2650 new_len = *len + new_prop_count * sizeof(textprop_T);
Bram Moolenaar964b3742019-05-24 18:54:09 +02002651 new_line = alloc(new_len);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002652 if (new_line == NULL)
2653 return;
2654 mch_memmove(new_line, *line, *len);
2655 new_prop_count = 0;
2656 }
2657
2658 // Get the line above to find any props that continue in the next
2659 // line.
2660 count = get_text_props(buf, lnum, &props, FALSE);
2661 for (n = 0; n < count; ++n)
2662 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002663 mch_memmove(&prop, props + n * sizeof(textprop_T),
2664 sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002665 if (prop.tp_flags & TP_FLAG_CONT_NEXT)
2666 {
2667 if (round == 2)
2668 {
2669 prop.tp_flags |= TP_FLAG_CONT_PREV;
2670 prop.tp_col = 1;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002671 prop.tp_len = *len; // not exactly the right length
2672 mch_memmove(new_line + *len + new_prop_count
2673 * sizeof(textprop_T), &prop, sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002674 }
2675 ++new_prop_count;
2676 }
2677 }
2678 }
2679 *line = new_line;
2680 *tofree = new_line;
2681 *len = new_len;
2682}
2683#endif
2684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002686ml_append_int(
2687 buf_T *buf,
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002688 linenr_T lnum, // append after this line (can be 0)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002689 char_u *line_arg, // text of the new line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002690 colnr_T len_arg, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002691 int flags) // ML_APPEND_ flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692{
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002693 char_u *line = line_arg;
2694 colnr_T len = len_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 int i;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002696 int line_count; // number of indexes in current block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 int offset;
2698 int from, to;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002699 int space_needed; // space needed for new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 int page_size;
2701 int page_count;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002702 int db_idx; // index for lnum in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 bhdr_T *hp;
2704 memfile_T *mfp;
2705 DATA_BL *dp;
2706 PTR_BL *pp;
2707 infoptr_T *ip;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002708#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002709 char_u *tofree = NULL;
2710#endif
2711 int ret = FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002714 return FAIL; // lnum out of range
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715
2716 if (lowest_marked && lowest_marked > lnum)
2717 lowest_marked = lnum + 1;
2718
2719 if (len == 0)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002720 len = (colnr_T)STRLEN(line) + 1; // space needed for the text
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002721
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002722#ifdef FEAT_PROP_POPUP
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002723 if (curbuf->b_has_textprop && lnum > 0 && !(flags & ML_APPEND_UNDO))
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002724 // Add text properties that continue from the previous line.
2725 add_text_props_for_append(buf, lnum, &line, &len, &tofree);
2726#endif
2727
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002728 space_needed = len + INDEX_SIZE; // space needed for text + index
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729
2730 mfp = buf->b_ml.ml_mfp;
2731 page_size = mfp->mf_page_size;
2732
2733/*
2734 * find the data block containing the previous line
2735 * This also fills the stack with the blocks from the root to the data block
2736 * This also releases any locked block.
2737 */
2738 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2739 ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002740 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741
2742 buf->b_ml.ml_flags &= ~ML_EMPTY;
2743
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002744 if (lnum == 0) // got line one instead, correct db_idx
2745 db_idx = -1; // careful, it is negative!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 else
2747 db_idx = lnum - buf->b_ml.ml_locked_low;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002748 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2750
2751 dp = (DATA_BL *)(hp->bh_data);
2752
2753/*
2754 * If
2755 * - there is not enough room in the current block
2756 * - appending to the last line in the block
2757 * - not appending to the last line in the file
2758 * insert in front of the next block.
2759 */
2760 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2761 && lnum < buf->b_ml.ml_line_count)
2762 {
2763 /*
2764 * Now that the line is not going to be inserted in the block that we
2765 * expected, the line count has to be adjusted in the pointer blocks
2766 * by using ml_locked_lineadd.
2767 */
2768 --(buf->b_ml.ml_locked_lineadd);
2769 --(buf->b_ml.ml_locked_high);
2770 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002771 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002773 db_idx = -1; // careful, it is negative!
2774 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2776 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2777
2778 dp = (DATA_BL *)(hp->bh_data);
2779 }
2780
2781 ++buf->b_ml.ml_line_count;
2782
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002783 if ((int)dp->db_free >= space_needed) // enough room in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 {
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002785 /*
2786 * Insert the new line in an existing data block, or in the data block
2787 * allocated above.
2788 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 dp->db_txt_start -= len;
2790 dp->db_free -= space_needed;
2791 ++(dp->db_line_count);
2792
2793 /*
2794 * move the text of the lines that follow to the front
2795 * adjust the indexes of the lines that follow
2796 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002797 if (line_count > db_idx + 1) // if there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 {
2799 /*
2800 * Offset is the start of the previous line.
2801 * This will become the character just after the new line.
2802 */
2803 if (db_idx < 0)
2804 offset = dp->db_txt_end;
2805 else
2806 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2807 mch_memmove((char *)dp + dp->db_txt_start,
2808 (char *)dp + dp->db_txt_start + len,
2809 (size_t)(offset - (dp->db_txt_start + len)));
2810 for (i = line_count - 1; i > db_idx; --i)
2811 dp->db_index[i + 1] = dp->db_index[i] - len;
2812 dp->db_index[db_idx + 1] = offset - len;
2813 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002814 else
2815 // add line at the end (which is the start of the text)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 dp->db_index[db_idx + 1] = dp->db_txt_start;
2817
2818 /*
2819 * copy the text into the block
2820 */
2821 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002822 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 dp->db_index[db_idx + 1] |= DB_MARKED;
2824
2825 /*
2826 * Mark the block dirty.
2827 */
2828 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002829 if (!(flags & ML_APPEND_NEW))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2831 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002832 else // not enough space in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 long line_count_left, line_count_right;
2835 int page_count_left, page_count_right;
2836 bhdr_T *hp_left;
2837 bhdr_T *hp_right;
2838 bhdr_T *hp_new;
2839 int lines_moved;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002840 int data_moved = 0; // init to shut up gcc
2841 int total_moved = 0; // init to shut up gcc
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 DATA_BL *dp_right, *dp_left;
2843 int stack_idx;
2844 int in_left;
2845 int lineadd;
2846 blocknr_T bnum_left, bnum_right;
2847 linenr_T lnum_left, lnum_right;
2848 int pb_idx;
2849 PTR_BL *pp_new;
2850
2851 /*
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002852 * There is not enough room, we have to create a new data block and
2853 * copy some lines into it.
2854 * Then we have to insert an entry in the pointer block.
2855 * If this pointer block also is full, we go up another block, and so
2856 * on, up to the root if necessary.
2857 * The line counts in the pointer blocks have already been adjusted by
2858 * ml_find_line().
2859 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 * We are going to allocate a new data block. Depending on the
2861 * situation it will be put to the left or right of the existing
2862 * block. If possible we put the new line in the left block and move
2863 * the lines after it to the right block. Otherwise the new line is
2864 * also put in the right block. This method is more efficient when
2865 * inserting a lot of lines at one place.
2866 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002867 if (db_idx < 0) // left block is new, right block is existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 {
2869 lines_moved = 0;
2870 in_left = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002871 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002873 else // left block is existing, right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 {
2875 lines_moved = line_count - db_idx - 1;
2876 if (lines_moved == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002877 in_left = FALSE; // put new line in right block
2878 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 else
2880 {
2881 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2882 dp->db_txt_start;
2883 total_moved = data_moved + lines_moved * INDEX_SIZE;
2884 if ((int)dp->db_free + total_moved >= space_needed)
2885 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002886 in_left = TRUE; // put new line in left block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 space_needed = total_moved;
2888 }
2889 else
2890 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002891 in_left = FALSE; // put new line in right block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 space_needed += total_moved;
2893 }
2894 }
2895 }
2896
2897 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002898 if ((hp_new = ml_new_data(mfp, flags & ML_APPEND_NEW, page_count))
2899 == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002901 // correct line counts in pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 --(buf->b_ml.ml_locked_lineadd);
2903 --(buf->b_ml.ml_locked_high);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002904 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002906 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 {
2908 hp_left = hp_new;
2909 hp_right = hp;
2910 line_count_left = 0;
2911 line_count_right = line_count;
2912 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002913 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 {
2915 hp_left = hp;
2916 hp_right = hp_new;
2917 line_count_left = line_count;
2918 line_count_right = 0;
2919 }
2920 dp_right = (DATA_BL *)(hp_right->bh_data);
2921 dp_left = (DATA_BL *)(hp_left->bh_data);
2922 bnum_left = hp_left->bh_bnum;
2923 bnum_right = hp_right->bh_bnum;
2924 page_count_left = hp_left->bh_page_count;
2925 page_count_right = hp_right->bh_page_count;
2926
2927 /*
2928 * May move the new line into the right/new block.
2929 */
2930 if (!in_left)
2931 {
2932 dp_right->db_txt_start -= len;
2933 dp_right->db_free -= len + INDEX_SIZE;
2934 dp_right->db_index[0] = dp_right->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002935 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 dp_right->db_index[0] |= DB_MARKED;
2937
2938 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2939 line, (size_t)len);
2940 ++line_count_right;
2941 }
2942 /*
2943 * may move lines from the left/old block to the right/new one.
2944 */
2945 if (lines_moved)
2946 {
2947 /*
2948 */
2949 dp_right->db_txt_start -= data_moved;
2950 dp_right->db_free -= total_moved;
2951 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2952 (char *)dp_left + dp_left->db_txt_start,
2953 (size_t)data_moved);
2954 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2955 dp_left->db_txt_start += data_moved;
2956 dp_left->db_free += total_moved;
2957
2958 /*
2959 * update indexes in the new block
2960 */
2961 for (to = line_count_right, from = db_idx + 1;
2962 from < line_count_left; ++from, ++to)
2963 dp_right->db_index[to] = dp->db_index[from] + offset;
2964 line_count_right += lines_moved;
2965 line_count_left -= lines_moved;
2966 }
2967
2968 /*
2969 * May move the new line into the left (old or new) block.
2970 */
2971 if (in_left)
2972 {
2973 dp_left->db_txt_start -= len;
2974 dp_left->db_free -= len + INDEX_SIZE;
2975 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002976 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 dp_left->db_index[line_count_left] |= DB_MARKED;
2978 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2979 line, (size_t)len);
2980 ++line_count_left;
2981 }
2982
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002983 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 {
2985 lnum_left = lnum + 1;
2986 lnum_right = 0;
2987 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002988 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 {
2990 lnum_left = 0;
2991 if (in_left)
2992 lnum_right = lnum + 2;
2993 else
2994 lnum_right = lnum + 1;
2995 }
2996 dp_left->db_line_count = line_count_left;
2997 dp_right->db_line_count = line_count_right;
2998
2999 /*
3000 * release the two data blocks
3001 * The new one (hp_new) already has a correct blocknumber.
3002 * The old one (hp, in ml_locked) gets a positive blocknumber if
3003 * we changed it and we are not editing a new file.
3004 */
3005 if (lines_moved || in_left)
3006 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003007 if (!(flags & ML_APPEND_NEW) && db_idx >= 0 && in_left)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 buf->b_ml.ml_flags |= ML_LOCKED_POS;
3009 mf_put(mfp, hp_new, TRUE, FALSE);
3010
3011 /*
3012 * flush the old data block
3013 * set ml_locked_lineadd to 0, because the updating of the
3014 * pointer blocks is done below
3015 */
3016 lineadd = buf->b_ml.ml_locked_lineadd;
3017 buf->b_ml.ml_locked_lineadd = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003018 ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019
3020 /*
3021 * update pointer blocks for the new data block
3022 */
3023 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3024 --stack_idx)
3025 {
3026 ip = &(buf->b_ml.ml_stack[stack_idx]);
3027 pb_idx = ip->ip_index;
3028 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003029 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003030 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 if (pp->pb_id != PTR_ID)
3032 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003033 iemsg(_("E317: pointer block id wrong 3"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003035 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 }
3037 /*
3038 * TODO: If the pointer block is full and we are adding at the end
3039 * try to insert in front of the next block
3040 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003041 // block not full, add one entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 if (pp->pb_count < pp->pb_count_max)
3043 {
3044 if (pb_idx + 1 < (int)pp->pb_count)
3045 mch_memmove(&pp->pb_pointer[pb_idx + 2],
3046 &pp->pb_pointer[pb_idx + 1],
3047 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
3048 ++pp->pb_count;
3049 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3050 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3051 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3052 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3053 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3054 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3055
3056 if (lnum_left != 0)
3057 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3058 if (lnum_right != 0)
3059 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3060
3061 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003062 buf->b_ml.ml_stack_top = stack_idx + 1; // truncate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063
3064 if (lineadd)
3065 {
3066 --(buf->b_ml.ml_stack_top);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003067 // fix line count for rest of blocks in the stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 ml_lineadd(buf, lineadd);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003069 // fix stack itself
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
3071 lineadd;
3072 ++(buf->b_ml.ml_stack_top);
3073 }
3074
3075 /*
3076 * We are finished, break the loop here.
3077 */
3078 break;
3079 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003080 else // pointer block full
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 {
3082 /*
3083 * split the pointer block
3084 * allocate a new pointer block
3085 * move some of the pointer into the new block
3086 * prepare for updating the parent block
3087 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003088 for (;;) // do this twice when splitting block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 {
3090 hp_new = ml_new_ptr(mfp);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003091 if (hp_new == NULL) // TODO: try to fix tree
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003092 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 pp_new = (PTR_BL *)(hp_new->bh_data);
3094
3095 if (hp->bh_bnum != 1)
3096 break;
3097
3098 /*
3099 * if block 1 becomes full the tree is given an extra level
3100 * The pointers from block 1 are moved into the new block.
3101 * block 1 is updated to point to the new block
3102 * then continue to split the new block
3103 */
3104 mch_memmove(pp_new, pp, (size_t)page_size);
3105 pp->pb_count = 1;
3106 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
3107 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
3108 pp->pb_pointer[0].pe_old_lnum = 1;
3109 pp->pb_pointer[0].pe_page_count = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003110 mf_put(mfp, hp, TRUE, FALSE); // release block 1
3111 hp = hp_new; // new block is to be split
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 pp = pp_new;
3113 CHECK(stack_idx != 0, _("stack_idx should be 0"));
3114 ip->ip_index = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003115 ++stack_idx; // do block 1 again later
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 }
3117 /*
3118 * move the pointers after the current one to the new block
3119 * If there are none, the new entry will be in the new block.
3120 */
3121 total_moved = pp->pb_count - pb_idx - 1;
3122 if (total_moved)
3123 {
3124 mch_memmove(&pp_new->pb_pointer[0],
3125 &pp->pb_pointer[pb_idx + 1],
3126 (size_t)(total_moved) * sizeof(PTR_EN));
3127 pp_new->pb_count = total_moved;
3128 pp->pb_count -= total_moved - 1;
3129 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3130 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3131 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3132 if (lnum_right)
3133 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3134 }
3135 else
3136 {
3137 pp_new->pb_count = 1;
3138 pp_new->pb_pointer[0].pe_bnum = bnum_right;
3139 pp_new->pb_pointer[0].pe_line_count = line_count_right;
3140 pp_new->pb_pointer[0].pe_page_count = page_count_right;
3141 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
3142 }
3143 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3144 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3145 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3146 if (lnum_left)
3147 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3148 lnum_left = 0;
3149 lnum_right = 0;
3150
3151 /*
3152 * recompute line counts
3153 */
3154 line_count_right = 0;
3155 for (i = 0; i < (int)pp_new->pb_count; ++i)
3156 line_count_right += pp_new->pb_pointer[i].pe_line_count;
3157 line_count_left = 0;
3158 for (i = 0; i < (int)pp->pb_count; ++i)
3159 line_count_left += pp->pb_pointer[i].pe_line_count;
3160
3161 bnum_left = hp->bh_bnum;
3162 bnum_right = hp_new->bh_bnum;
3163 page_count_left = 1;
3164 page_count_right = 1;
3165 mf_put(mfp, hp, TRUE, FALSE);
3166 mf_put(mfp, hp_new, TRUE, FALSE);
3167 }
3168 }
3169
3170 /*
3171 * Safety check: fallen out of for loop?
3172 */
3173 if (stack_idx < 0)
3174 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003175 iemsg(_("E318: Updated too many blocks?"));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003176 buf->b_ml.ml_stack_top = 0; // invalidate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 }
3178 }
3179
3180#ifdef FEAT_BYTEOFF
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003181 // The line was inserted below 'lnum'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
3183#endif
3184#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003185 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 {
3187 if (STRLEN(line) > 0)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003188 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003189 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 (char_u *)"\n", 1);
3191 }
3192#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01003193#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003194 if (buf->b_write_to_channel)
3195 channel_write_new_lines(buf);
3196#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003197 ret = OK;
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003198
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003199theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003200#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003201 vim_free(tofree);
3202#endif
3203 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204}
3205
3206/*
Bram Moolenaar250e3112019-07-15 23:02:14 +02003207 * Flush any pending change and call ml_append_int()
3208 */
3209 static int
3210ml_append_flush(
3211 buf_T *buf,
3212 linenr_T lnum, // append after this line (can be 0)
3213 char_u *line, // text of the new line
3214 colnr_T len, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003215 int flags) // ML_APPEND_ flags
Bram Moolenaar250e3112019-07-15 23:02:14 +02003216{
3217 if (lnum > buf->b_ml.ml_line_count)
3218 return FAIL; // lnum out of range
3219
3220 if (buf->b_ml.ml_line_lnum != 0)
3221 // This may also invoke ml_append_int().
3222 ml_flush_line(buf);
3223
3224#ifdef FEAT_EVAL
3225 // When inserting above recorded changes: flush the changes before changing
3226 // the text. Then flush the cached line, it may become invalid.
3227 may_invoke_listeners(buf, lnum + 1, lnum + 1, 1);
3228 if (buf->b_ml.ml_line_lnum != 0)
3229 ml_flush_line(buf);
3230#endif
3231
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003232 return ml_append_int(buf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003233}
3234
3235/*
3236 * Append a line after lnum (may be 0 to insert a line in front of the file).
3237 * "line" does not need to be allocated, but can't be another line in a
3238 * buffer, unlocking may make it invalid.
3239 *
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003240 * "newfile": TRUE when starting to edit a new file, meaning that pe_old_lnum
Bram Moolenaar250e3112019-07-15 23:02:14 +02003241 * will be set for recovery
3242 * Check: The caller of this function should probably also call
3243 * appended_lines().
3244 *
3245 * return FAIL for failure, OK otherwise
3246 */
3247 int
3248ml_append(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003249 linenr_T lnum, // append after this line (can be 0)
3250 char_u *line, // text of the new line
3251 colnr_T len, // length of new line, including NUL, or 0
3252 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003253{
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003254 return ml_append_flags(lnum, line, len, newfile ? ML_APPEND_NEW : 0);
3255}
3256
3257 int
3258ml_append_flags(
3259 linenr_T lnum, // append after this line (can be 0)
3260 char_u *line, // text of the new line
3261 colnr_T len, // length of new line, including NUL, or 0
3262 int flags) // ML_APPEND_ values
3263{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003264 // When starting up, we might still need to create the memfile
Bram Moolenaar250e3112019-07-15 23:02:14 +02003265 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
3266 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003267 return ml_append_flush(curbuf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003268}
3269
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003270
Bram Moolenaar250e3112019-07-15 23:02:14 +02003271#if defined(FEAT_SPELL) || defined(FEAT_QUICKFIX) || defined(PROTO)
3272/*
3273 * Like ml_append() but for an arbitrary buffer. The buffer must already have
3274 * a memline.
3275 */
3276 int
3277ml_append_buf(
3278 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003279 linenr_T lnum, // append after this line (can be 0)
3280 char_u *line, // text of the new line
3281 colnr_T len, // length of new line, including NUL, or 0
3282 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003283{
3284 if (buf->b_ml.ml_mfp == NULL)
3285 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003286 return ml_append_flush(buf, lnum, line, len, newfile ? ML_APPEND_NEW : 0);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003287}
3288#endif
3289
3290/*
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003291 * Replace line "lnum", with buffering, in current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 *
Bram Moolenaar1056d982006-03-09 22:37:52 +00003293 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 * copied to allocated memory already.
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003295 * If "copy" is FALSE the "line" may be freed to add text properties!
3296 * Do not use it after calling ml_replace().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 *
3298 * Check: The caller of this function should probably also call
3299 * changed_lines(), unless update_screen(NOT_VALID) is used.
3300 *
3301 * return FAIL for failure, OK otherwise
3302 */
3303 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003304ml_replace(linenr_T lnum, char_u *line, int copy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305{
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003306 colnr_T len = -1;
3307
3308 if (line != NULL)
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003309 len = (colnr_T)STRLEN(line);
Bram Moolenaarccae4672019-01-04 15:09:57 +01003310 return ml_replace_len(lnum, line, len, FALSE, copy);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003311}
3312
Bram Moolenaarccae4672019-01-04 15:09:57 +01003313/*
3314 * Replace a line for the current buffer. Like ml_replace() with:
3315 * "len_arg" is the length of the text, excluding NUL.
3316 * If "has_props" is TRUE then "line_arg" includes the text properties and
3317 * "len_arg" includes the NUL of the text.
3318 */
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003319 int
Bram Moolenaarccae4672019-01-04 15:09:57 +01003320ml_replace_len(
3321 linenr_T lnum,
3322 char_u *line_arg,
3323 colnr_T len_arg,
3324 int has_props,
3325 int copy)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003326{
3327 char_u *line = line_arg;
3328 colnr_T len = len_arg;
3329
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003330 if (line == NULL) // just checking...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 return FAIL;
3332
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003333 // When starting up, we might still need to create the memfile
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003334 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 return FAIL;
3336
Bram Moolenaarccae4672019-01-04 15:09:57 +01003337 if (!has_props)
3338 ++len; // include the NUL after the text
3339 if (copy)
3340 {
3341 // copy the line to allocated memory
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003342#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003343 if (has_props)
3344 line = vim_memsave(line, len);
3345 else
3346#endif
3347 line = vim_strnsave(line, len - 1);
3348 if (line == NULL)
3349 return FAIL;
3350 }
3351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003353 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 {
3355 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003356 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 }
3358#endif
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003359 if (curbuf->b_ml.ml_line_lnum != lnum)
3360 {
3361 // another line is buffered, flush it
3362 ml_flush_line(curbuf);
Bram Moolenaarca79a5f2018-12-13 23:16:36 +01003363 curbuf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003364
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003365#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003366 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003367 // Need to fetch the old line to copy over any text properties.
3368 ml_get_buf(curbuf, lnum, TRUE);
3369#endif
3370 }
3371
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003372#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003373 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003374 {
3375 size_t oldtextlen = STRLEN(curbuf->b_ml.ml_line_ptr) + 1;
3376
3377 if (oldtextlen < (size_t)curbuf->b_ml.ml_line_len)
3378 {
3379 char_u *newline;
3380 size_t textproplen = curbuf->b_ml.ml_line_len - oldtextlen;
3381
3382 // Need to copy over text properties, stored after the text.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003383 newline = alloc(len + (int)textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003384 if (newline != NULL)
3385 {
Bram Moolenaarccae4672019-01-04 15:09:57 +01003386 mch_memmove(newline, line, len);
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02003387 mch_memmove(newline + len, curbuf->b_ml.ml_line_ptr
3388 + oldtextlen, textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003389 vim_free(line);
3390 line = newline;
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003391 len += (colnr_T)textproplen;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003392 }
3393 }
3394 }
3395#endif
3396
Bram Moolenaarccae4672019-01-04 15:09:57 +01003397 if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) // same line allocated
3398 vim_free(curbuf->b_ml.ml_line_ptr); // free it
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003399
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 curbuf->b_ml.ml_line_ptr = line;
Bram Moolenaarccae4672019-01-04 15:09:57 +01003401 curbuf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 curbuf->b_ml.ml_line_lnum = lnum;
3403 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
3404
3405 return OK;
3406}
3407
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003408#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003409/*
3410 * Adjust text properties in line "lnum" for a deleted line.
3411 * When "above" is true this is the line above the deleted line.
3412 * "del_props" are the properties of the deleted line.
3413 */
3414 static void
3415adjust_text_props_for_delete(
3416 buf_T *buf,
3417 linenr_T lnum,
3418 char_u *del_props,
3419 int del_props_len,
3420 int above)
3421{
3422 int did_get_line = FALSE;
3423 int done_del;
3424 int done_this;
3425 textprop_T prop_del;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003426 bhdr_T *hp;
3427 DATA_BL *dp;
3428 int idx;
3429 int line_start;
3430 long line_size;
3431 int this_props_len;
3432 char_u *text;
3433 size_t textlen;
3434 int found;
3435
3436 for (done_del = 0; done_del < del_props_len; done_del += sizeof(textprop_T))
3437 {
3438 mch_memmove(&prop_del, del_props + done_del, sizeof(textprop_T));
3439 if ((above && (prop_del.tp_flags & TP_FLAG_CONT_PREV)
3440 && !(prop_del.tp_flags & TP_FLAG_CONT_NEXT))
3441 || (!above && (prop_del.tp_flags & TP_FLAG_CONT_NEXT)
3442 && !(prop_del.tp_flags & TP_FLAG_CONT_PREV)))
3443 {
3444 if (!did_get_line)
3445 {
3446 did_get_line = TRUE;
3447 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
3448 return;
3449
3450 dp = (DATA_BL *)(hp->bh_data);
3451 idx = lnum - buf->b_ml.ml_locked_low;
3452 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3453 if (idx == 0) // first line in block, text at the end
3454 line_size = dp->db_txt_end - line_start;
3455 else
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003456 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK)
3457 - line_start;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003458 text = (char_u *)dp + line_start;
3459 textlen = STRLEN(text) + 1;
3460 if ((long)textlen >= line_size)
3461 {
3462 if (above)
3463 internal_error("no text property above deleted line");
3464 else
3465 internal_error("no text property below deleted line");
3466 return;
3467 }
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01003468 this_props_len = line_size - (int)textlen;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003469 }
3470
3471 found = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003472 for (done_this = 0; done_this < this_props_len;
3473 done_this += sizeof(textprop_T))
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003474 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003475 int flag = above ? TP_FLAG_CONT_NEXT
3476 : TP_FLAG_CONT_PREV;
3477 textprop_T prop_this;
3478
3479 mch_memmove(&prop_this, text + textlen + done_del,
3480 sizeof(textprop_T));
3481 if ((prop_this.tp_flags & flag)
3482 && prop_del.tp_id == prop_this.tp_id
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003483 && prop_del.tp_type == prop_this.tp_type)
3484 {
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003485 found = TRUE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003486 prop_this.tp_flags &= ~flag;
3487 mch_memmove(text + textlen + done_del, &prop_this,
3488 sizeof(textprop_T));
3489 break;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003490 }
3491 }
3492 if (!found)
3493 {
3494 if (above)
3495 internal_error("text property above deleted line not found");
3496 else
3497 internal_error("text property below deleted line not found");
3498 }
3499
3500 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3501 }
3502 }
3503}
3504#endif
3505
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506/*
Bram Moolenaar4033c552017-09-16 20:54:51 +02003507 * Delete line "lnum" in the current buffer.
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003508 * When "flags" has ML_DEL_MESSAGE may give a "No lines in buffer" message.
3509 * When "flags" has ML_DEL_UNDO this is called from undo.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 *
3511 * return FAIL for failure, OK otherwise
3512 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 static int
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003514ml_delete_int(buf_T *buf, linenr_T lnum, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515{
3516 bhdr_T *hp;
3517 memfile_T *mfp;
3518 DATA_BL *dp;
3519 PTR_BL *pp;
3520 infoptr_T *ip;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003521 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 int idx;
3523 int stack_idx;
3524 int text_start;
3525 int line_start;
3526 long line_size;
3527 int i;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003528 int ret = FAIL;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003529#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003530 char_u *textprop_save = NULL;
3531 int textprop_save_len;
3532#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 if (lowest_marked && lowest_marked > lnum)
3535 lowest_marked--;
3536
3537/*
3538 * If the file becomes empty the last line is replaced by an empty line.
3539 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003540 if (buf->b_ml.ml_line_count == 1) // file becomes empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003542 if ((flags & ML_DEL_MESSAGE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543#ifdef FEAT_NETBEANS_INTG
3544 && !netbeansSuppressNoLines
3545#endif
3546 )
Bram Moolenaar238a5642006-02-21 22:12:05 +00003547 set_keep_msg((char_u *)_(no_lines_msg), 0);
3548
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003549 // FEAT_BYTEOFF already handled in there, don't worry 'bout it below
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
3551 buf->b_ml.ml_flags |= ML_EMPTY;
3552
3553 return i;
3554 }
3555
3556/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003557 * Find the data block containing the line.
3558 * This also fills the stack with the blocks from the root to the data block.
3559 * This also releases any locked block..
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 */
3561 mfp = buf->b_ml.ml_mfp;
3562 if (mfp == NULL)
3563 return FAIL;
3564
3565 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
3566 return FAIL;
3567
3568 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003569 // compute line count before the delete
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 count = (long)(buf->b_ml.ml_locked_high)
3571 - (long)(buf->b_ml.ml_locked_low) + 2;
3572 idx = lnum - buf->b_ml.ml_locked_low;
3573
3574 --buf->b_ml.ml_line_count;
3575
3576 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003577 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 line_size = dp->db_txt_end - line_start;
3579 else
3580 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
3581
3582#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003583 if (netbeans_active())
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003584 netbeans_removed(buf, lnum, 0, (long)line_size);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003586#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003587 // If there are text properties, make a copy, so that we can update
3588 // properties in preceding and following lines.
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003589 if (buf->b_has_textprop && !(flags & ML_DEL_UNDO))
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003590 {
3591 size_t textlen = STRLEN((char_u *)dp + line_start) + 1;
3592
3593 if ((long)textlen < line_size)
3594 {
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01003595 textprop_save_len = line_size - (int)textlen;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003596 textprop_save = vim_memsave((char_u *)dp + line_start + textlen,
3597 textprop_save_len);
3598 }
3599 }
3600#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601
3602/*
3603 * special case: If there is only one line in the data block it becomes empty.
3604 * Then we have to remove the entry, pointing to this data block, from the
3605 * pointer block. If this pointer block also becomes empty, we go up another
3606 * block, and so on, up to the root if necessary.
3607 * The line counts in the pointer blocks have already been adjusted by
3608 * ml_find_line().
3609 */
3610 if (count == 1)
3611 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003612 mf_free(mfp, hp); // free the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 buf->b_ml.ml_locked = NULL;
3614
Bram Moolenaare60acc12011-05-10 16:41:25 +02003615 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3616 --stack_idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003618 buf->b_ml.ml_stack_top = 0; // stack is invalid when failing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 ip = &(buf->b_ml.ml_stack[stack_idx]);
3620 idx = ip->ip_index;
3621 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003622 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003623 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 if (pp->pb_id != PTR_ID)
3625 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003626 iemsg(_("E317: pointer block id wrong 4"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003628 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 }
3630 count = --(pp->pb_count);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003631 if (count == 0) // the pointer block becomes empty!
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 mf_free(mfp, hp);
3633 else
3634 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003635 if (count != idx) // move entries after the deleted one
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
3637 (size_t)(count - idx) * sizeof(PTR_EN));
3638 mf_put(mfp, hp, TRUE, FALSE);
3639
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003640 buf->b_ml.ml_stack_top = stack_idx; // truncate stack
3641 // fix line count for rest of blocks in the stack
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003642 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 {
3644 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3645 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003646 buf->b_ml.ml_locked_lineadd;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 }
3648 ++(buf->b_ml.ml_stack_top);
3649
3650 break;
3651 }
3652 }
3653 CHECK(stack_idx < 0, _("deleted block 1?"));
3654 }
3655 else
3656 {
3657 /*
3658 * delete the text by moving the next lines forwards
3659 */
3660 text_start = dp->db_txt_start;
3661 mch_memmove((char *)dp + text_start + line_size,
3662 (char *)dp + text_start, (size_t)(line_start - text_start));
3663
3664 /*
3665 * delete the index by moving the next indexes backwards
3666 * Adjust the indexes for the text movement.
3667 */
3668 for (i = idx; i < count - 1; ++i)
3669 dp->db_index[i] = dp->db_index[i + 1] + line_size;
3670
3671 dp->db_free += line_size + INDEX_SIZE;
3672 dp->db_txt_start += line_size;
3673 --(dp->db_line_count);
3674
3675 /*
3676 * mark the block dirty and make sure it is in the file (for recovery)
3677 */
3678 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3679 }
3680
3681#ifdef FEAT_BYTEOFF
3682 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
3683#endif
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003684 ret = OK;
3685
3686theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003687#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003688 if (textprop_save != NULL)
3689 {
3690 // Adjust text properties in the line above and below.
3691 if (lnum > 1)
3692 adjust_text_props_for_delete(buf, lnum - 1, textprop_save, textprop_save_len, TRUE);
3693 if (lnum <= buf->b_ml.ml_line_count)
3694 adjust_text_props_for_delete(buf, lnum, textprop_save, textprop_save_len, FALSE);
3695 }
3696 vim_free(textprop_save);
3697#endif
3698 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699}
3700
3701/*
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003702 * Delete line "lnum" in the current buffer.
3703 * When "message" is TRUE may give a "No lines in buffer" message.
3704 *
3705 * Check: The caller of this function should probably also call
3706 * deleted_lines() after this.
3707 *
3708 * return FAIL for failure, OK otherwise
3709 */
3710 int
Bram Moolenaarca70c072020-05-30 20:30:46 +02003711ml_delete(linenr_T lnum)
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003712{
Bram Moolenaarca70c072020-05-30 20:30:46 +02003713 return ml_delete_flags(lnum, 0);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003714}
3715
3716/*
3717 * Like ml_delete() but using flags (see ml_delete_int()).
3718 */
3719 int
3720ml_delete_flags(linenr_T lnum, int flags)
3721{
3722 ml_flush_line(curbuf);
3723 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
3724 return FAIL;
3725
3726#ifdef FEAT_EVAL
3727 // When inserting above recorded changes: flush the changes before changing
3728 // the text.
3729 may_invoke_listeners(curbuf, lnum, lnum + 1, -1);
3730#endif
3731
3732 return ml_delete_int(curbuf, lnum, flags);
3733}
3734
3735/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003736 * set the DB_MARKED flag for line 'lnum'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 */
3738 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003739ml_setmarked(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740{
3741 bhdr_T *hp;
3742 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003743 // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3745 || curbuf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003746 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747
3748 if (lowest_marked == 0 || lowest_marked > lnum)
3749 lowest_marked = lnum;
3750
3751 /*
3752 * find the data block containing the line
3753 * This also fills the stack with the blocks from the root to the data block
3754 * This also releases any locked block.
3755 */
3756 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003757 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758
3759 dp = (DATA_BL *)(hp->bh_data);
3760 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
3761 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3762}
3763
3764/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003765 * find the first line with its DB_MARKED flag set
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 */
3767 linenr_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003768ml_firstmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769{
3770 bhdr_T *hp;
3771 DATA_BL *dp;
3772 linenr_T lnum;
3773 int i;
3774
3775 if (curbuf->b_ml.ml_mfp == NULL)
3776 return (linenr_T) 0;
3777
3778 /*
3779 * The search starts with lowest_marked line. This is the last line where
3780 * a mark was found, adjusted by inserting/deleting lines.
3781 */
3782 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3783 {
3784 /*
3785 * Find the data block containing the line.
3786 * This also fills the stack with the blocks from the root to the data
3787 * block This also releases any locked block.
3788 */
3789 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003790 return (linenr_T)0; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791
3792 dp = (DATA_BL *)(hp->bh_data);
3793
3794 for (i = lnum - curbuf->b_ml.ml_locked_low;
3795 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3796 if ((dp->db_index[i]) & DB_MARKED)
3797 {
3798 (dp->db_index[i]) &= DB_INDEX_MASK;
3799 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3800 lowest_marked = lnum + 1;
3801 return lnum;
3802 }
3803 }
3804
3805 return (linenr_T) 0;
3806}
3807
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808/*
3809 * clear all DB_MARKED flags
3810 */
3811 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003812ml_clearmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813{
3814 bhdr_T *hp;
3815 DATA_BL *dp;
3816 linenr_T lnum;
3817 int i;
3818
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003819 if (curbuf->b_ml.ml_mfp == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 return;
3821
3822 /*
3823 * The search starts with line lowest_marked.
3824 */
3825 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3826 {
3827 /*
3828 * Find the data block containing the line.
3829 * This also fills the stack with the blocks from the root to the data
3830 * block and releases any locked block.
3831 */
3832 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003833 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834
3835 dp = (DATA_BL *)(hp->bh_data);
3836
3837 for (i = lnum - curbuf->b_ml.ml_locked_low;
3838 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3839 if ((dp->db_index[i]) & DB_MARKED)
3840 {
3841 (dp->db_index[i]) &= DB_INDEX_MASK;
3842 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3843 }
3844 }
3845
3846 lowest_marked = 0;
3847 return;
3848}
3849
3850/*
3851 * flush ml_line if necessary
3852 */
3853 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003854ml_flush_line(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855{
3856 bhdr_T *hp;
3857 DATA_BL *dp;
3858 linenr_T lnum;
3859 char_u *new_line;
3860 char_u *old_line;
3861 colnr_T new_len;
3862 int old_len;
3863 int extra;
3864 int idx;
3865 int start;
3866 int count;
3867 int i;
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003868 static int entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869
3870 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003871 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
3873 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3874 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003875 // This code doesn't work recursively, but Netbeans may call back here
3876 // when obtaining the cursor position.
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003877 if (entered)
3878 return;
3879 entered = TRUE;
3880
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 lnum = buf->b_ml.ml_line_lnum;
3882 new_line = buf->b_ml.ml_line_ptr;
3883
3884 hp = ml_find_line(buf, lnum, ML_FIND);
3885 if (hp == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003886 siemsg(_("E320: Cannot find line %ld"), lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 else
3888 {
3889 dp = (DATA_BL *)(hp->bh_data);
3890 idx = lnum - buf->b_ml.ml_locked_low;
3891 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3892 old_line = (char_u *)dp + start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003893 if (idx == 0) // line is last in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 old_len = dp->db_txt_end - start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003895 else // text of previous line follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003897 new_len = buf->b_ml.ml_line_len;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003898 extra = new_len - old_len; // negative if lines gets smaller
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899
3900 /*
3901 * if new line fits in data block, replace directly
3902 */
3903 if ((int)dp->db_free >= extra)
3904 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003905 // if the length changes and there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3907 if (extra != 0 && idx < count - 1)
3908 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003909 // move text of following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 mch_memmove((char *)dp + dp->db_txt_start - extra,
3911 (char *)dp + dp->db_txt_start,
3912 (size_t)(start - dp->db_txt_start));
3913
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003914 // adjust pointers of this and following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 for (i = idx + 1; i < count; ++i)
3916 dp->db_index[i] -= extra;
3917 }
3918 dp->db_index[idx] -= extra;
3919
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003920 // adjust free space
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 dp->db_free -= extra;
3922 dp->db_txt_start -= extra;
3923
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003924 // copy new line into the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3926 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3927#ifdef FEAT_BYTEOFF
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003928 // The else case is already covered by the insert and delete
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3930#endif
3931 }
3932 else
3933 {
3934 /*
3935 * Cannot do it in one data block: Delete and append.
3936 * Append first, because ml_delete_int() cannot delete the
3937 * last line in a buffer, which causes trouble for a buffer
3938 * that has only one line.
3939 * Don't forget to copy the mark!
3940 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003941 // How about handling errors???
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003942 (void)ml_append_int(buf, lnum, new_line, new_len,
3943 (dp->db_index[idx] & DB_MARKED) ? ML_APPEND_MARK : 0);
3944 (void)ml_delete_int(buf, lnum, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 }
3946 }
3947 vim_free(new_line);
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01003948
3949 entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 }
3951
3952 buf->b_ml.ml_line_lnum = 0;
3953}
3954
3955/*
3956 * create a new, empty, data block
3957 */
3958 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003959ml_new_data(memfile_T *mfp, int negative, int page_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960{
3961 bhdr_T *hp;
3962 DATA_BL *dp;
3963
3964 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3965 return NULL;
3966
3967 dp = (DATA_BL *)(hp->bh_data);
3968 dp->db_id = DATA_ID;
3969 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3970 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3971 dp->db_line_count = 0;
3972
3973 return hp;
3974}
3975
3976/*
3977 * create a new, empty, pointer block
3978 */
3979 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003980ml_new_ptr(memfile_T *mfp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981{
3982 bhdr_T *hp;
3983 PTR_BL *pp;
3984
3985 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3986 return NULL;
3987
3988 pp = (PTR_BL *)(hp->bh_data);
3989 pp->pb_id = PTR_ID;
3990 pp->pb_count = 0;
Bram Moolenaar20a825a2010-05-31 21:27:30 +02003991 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL))
3992 / sizeof(PTR_EN) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993
3994 return hp;
3995}
3996
3997/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003998 * Lookup line 'lnum' in a memline.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 *
4000 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
4001 * if ML_FLUSH only flush a locked block
4002 * if ML_FIND just find the line
4003 *
4004 * If the block was found it is locked and put in ml_locked.
4005 * The stack is updated to lead to the locked block. The ip_high field in
4006 * the stack is updated to reflect the last line in the block AFTER the
4007 * insert or delete, also if the pointer block has not been updated yet. But
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004008 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 *
4010 * return: NULL for failure, pointer to block header otherwise
4011 */
4012 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004013ml_find_line(buf_T *buf, linenr_T lnum, int action)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014{
4015 DATA_BL *dp;
4016 PTR_BL *pp;
4017 infoptr_T *ip;
4018 bhdr_T *hp;
4019 memfile_T *mfp;
4020 linenr_T t;
4021 blocknr_T bnum, bnum2;
4022 int dirty;
4023 linenr_T low, high;
4024 int top;
4025 int page_count;
4026 int idx;
4027
4028 mfp = buf->b_ml.ml_mfp;
4029
4030 /*
4031 * If there is a locked block check if the wanted line is in it.
4032 * If not, flush and release the locked block.
4033 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
4034 * Don't do this for ML_FLUSH, because we want to flush the locked block.
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004035 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 */
4037 if (buf->b_ml.ml_locked)
4038 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004039 if (ML_SIMPLE(action)
4040 && buf->b_ml.ml_locked_low <= lnum
4041 && buf->b_ml.ml_locked_high >= lnum
4042 && !mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004044 // remember to update pointer blocks and stack later
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 if (action == ML_INSERT)
4046 {
4047 ++(buf->b_ml.ml_locked_lineadd);
4048 ++(buf->b_ml.ml_locked_high);
4049 }
4050 else if (action == ML_DELETE)
4051 {
4052 --(buf->b_ml.ml_locked_lineadd);
4053 --(buf->b_ml.ml_locked_high);
4054 }
4055 return (buf->b_ml.ml_locked);
4056 }
4057
4058 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
4059 buf->b_ml.ml_flags & ML_LOCKED_POS);
4060 buf->b_ml.ml_locked = NULL;
4061
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004062 /*
4063 * If lines have been added or deleted in the locked block, need to
4064 * update the line count in pointer blocks.
4065 */
4066 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
4068 }
4069
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004070 if (action == ML_FLUSH) // nothing else to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 return NULL;
4072
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004073 bnum = 1; // start at the root of the tree
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 page_count = 1;
4075 low = 1;
4076 high = buf->b_ml.ml_line_count;
4077
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004078 if (action == ML_FIND) // first try stack entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 {
4080 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
4081 {
4082 ip = &(buf->b_ml.ml_stack[top]);
4083 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
4084 {
4085 bnum = ip->ip_bnum;
4086 low = ip->ip_low;
4087 high = ip->ip_high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004088 buf->b_ml.ml_stack_top = top; // truncate stack at prev entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 break;
4090 }
4091 }
4092 if (top < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004093 buf->b_ml.ml_stack_top = 0; // not found, start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004095 else // ML_DELETE or ML_INSERT
4096 buf->b_ml.ml_stack_top = 0; // start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097
4098/*
4099 * search downwards in the tree until a data block is found
4100 */
4101 for (;;)
4102 {
4103 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
4104 goto error_noblock;
4105
4106 /*
4107 * update high for insert/delete
4108 */
4109 if (action == ML_INSERT)
4110 ++high;
4111 else if (action == ML_DELETE)
4112 --high;
4113
4114 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004115 if (dp->db_id == DATA_ID) // data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 {
4117 buf->b_ml.ml_locked = hp;
4118 buf->b_ml.ml_locked_low = low;
4119 buf->b_ml.ml_locked_high = high;
4120 buf->b_ml.ml_locked_lineadd = 0;
4121 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
4122 return hp;
4123 }
4124
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004125 pp = (PTR_BL *)(dp); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 if (pp->pb_id != PTR_ID)
4127 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004128 iemsg(_("E317: pointer block id wrong"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 goto error_block;
4130 }
4131
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004132 if ((top = ml_add_stack(buf)) < 0) // add new entry to stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 goto error_block;
4134 ip = &(buf->b_ml.ml_stack[top]);
4135 ip->ip_bnum = bnum;
4136 ip->ip_low = low;
4137 ip->ip_high = high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004138 ip->ip_index = -1; // index not known yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139
4140 dirty = FALSE;
4141 for (idx = 0; idx < (int)pp->pb_count; ++idx)
4142 {
4143 t = pp->pb_pointer[idx].pe_line_count;
4144 CHECK(t == 0, _("pe_line_count is zero"));
4145 if ((low += t) > lnum)
4146 {
4147 ip->ip_index = idx;
4148 bnum = pp->pb_pointer[idx].pe_bnum;
4149 page_count = pp->pb_pointer[idx].pe_page_count;
4150 high = low - 1;
4151 low -= t;
4152
4153 /*
4154 * a negative block number may have been changed
4155 */
4156 if (bnum < 0)
4157 {
4158 bnum2 = mf_trans_del(mfp, bnum);
4159 if (bnum != bnum2)
4160 {
4161 bnum = bnum2;
4162 pp->pb_pointer[idx].pe_bnum = bnum;
4163 dirty = TRUE;
4164 }
4165 }
4166
4167 break;
4168 }
4169 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004170 if (idx >= (int)pp->pb_count) // past the end: something wrong!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 {
4172 if (lnum > buf->b_ml.ml_line_count)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004173 siemsg(_("E322: line number out of range: %ld past the end"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 lnum - buf->b_ml.ml_line_count);
4175
4176 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004177 siemsg(_("E323: line count wrong in block %ld"), bnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 goto error_block;
4179 }
4180 if (action == ML_DELETE)
4181 {
4182 pp->pb_pointer[idx].pe_line_count--;
4183 dirty = TRUE;
4184 }
4185 else if (action == ML_INSERT)
4186 {
4187 pp->pb_pointer[idx].pe_line_count++;
4188 dirty = TRUE;
4189 }
4190 mf_put(mfp, hp, dirty, FALSE);
4191 }
4192
4193error_block:
4194 mf_put(mfp, hp, FALSE, FALSE);
4195error_noblock:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004196 /*
4197 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
4198 * the incremented/decremented line counts, because there won't be a line
4199 * inserted/deleted after all.
4200 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 if (action == ML_DELETE)
4202 ml_lineadd(buf, 1);
4203 else if (action == ML_INSERT)
4204 ml_lineadd(buf, -1);
4205 buf->b_ml.ml_stack_top = 0;
4206 return NULL;
4207}
4208
4209/*
4210 * add an entry to the info pointer stack
4211 *
4212 * return -1 for failure, number of the new entry otherwise
4213 */
4214 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004215ml_add_stack(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216{
4217 int top;
4218 infoptr_T *newstack;
4219
4220 top = buf->b_ml.ml_stack_top;
4221
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004222 // may have to increase the stack size
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 if (top == buf->b_ml.ml_stack_size)
4224 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004225 CHECK(top > 0, _("Stack size increases")); // more than 5 levels???
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004227 newstack = ALLOC_MULT(infoptr_T, buf->b_ml.ml_stack_size + STACK_INCR);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 if (newstack == NULL)
4229 return -1;
Bram Moolenaarfbd302f2015-08-08 18:23:46 +02004230 if (top > 0)
4231 mch_memmove(newstack, buf->b_ml.ml_stack,
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004232 (size_t)top * sizeof(infoptr_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 vim_free(buf->b_ml.ml_stack);
4234 buf->b_ml.ml_stack = newstack;
4235 buf->b_ml.ml_stack_size += STACK_INCR;
4236 }
4237
4238 buf->b_ml.ml_stack_top++;
4239 return top;
4240}
4241
4242/*
4243 * Update the pointer blocks on the stack for inserted/deleted lines.
4244 * The stack itself is also updated.
4245 *
4246 * When a insert/delete line action fails, the line is not inserted/deleted,
4247 * but the pointer blocks have already been updated. That is fixed here by
4248 * walking through the stack.
4249 *
4250 * Count is the number of lines added, negative if lines have been deleted.
4251 */
4252 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004253ml_lineadd(buf_T *buf, int count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254{
4255 int idx;
4256 infoptr_T *ip;
4257 PTR_BL *pp;
4258 memfile_T *mfp = buf->b_ml.ml_mfp;
4259 bhdr_T *hp;
4260
4261 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
4262 {
4263 ip = &(buf->b_ml.ml_stack[idx]);
4264 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
4265 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004266 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 if (pp->pb_id != PTR_ID)
4268 {
4269 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004270 iemsg(_("E317: pointer block id wrong 2"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 break;
4272 }
4273 pp->pb_pointer[ip->ip_index].pe_line_count += count;
4274 ip->ip_high += count;
4275 mf_put(mfp, hp, TRUE, FALSE);
4276 }
4277}
4278
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004279#if defined(HAVE_READLINK) || defined(PROTO)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004280/*
4281 * Resolve a symlink in the last component of a file name.
4282 * Note that f_resolve() does it for every part of the path, we don't do that
4283 * here.
4284 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
4285 * Otherwise returns FAIL.
4286 */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004287 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004288resolve_symlink(char_u *fname, char_u *buf)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004289{
4290 char_u tmp[MAXPATHL];
4291 int ret;
4292 int depth = 0;
4293
4294 if (fname == NULL)
4295 return FAIL;
4296
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004297 // Put the result so far in tmp[], starting with the original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004298 vim_strncpy(tmp, fname, MAXPATHL - 1);
4299
4300 for (;;)
4301 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004302 // Limit symlink depth to 100, catch recursive loops.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004303 if (++depth == 100)
4304 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004305 semsg(_("E773: Symlink loop for \"%s\""), fname);
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004306 return FAIL;
4307 }
4308
4309 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
4310 if (ret <= 0)
4311 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00004312 if (errno == EINVAL || errno == ENOENT)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004313 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004314 // Found non-symlink or not existing file, stop here.
4315 // When at the first level use the unmodified name, skip the
4316 // call to vim_FullName().
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004317 if (depth == 1)
4318 return FAIL;
4319
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004320 // Use the resolved name in tmp[].
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004321 break;
4322 }
4323
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004324 // There must be some error reading links, use original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004325 return FAIL;
4326 }
4327 buf[ret] = NUL;
4328
4329 /*
4330 * Check whether the symlink is relative or absolute.
4331 * If it's relative, build a new path based on the directory
4332 * portion of the filename (if any) and the path the symlink
4333 * points to.
4334 */
4335 if (mch_isFullName(buf))
4336 STRCPY(tmp, buf);
4337 else
4338 {
4339 char_u *tail;
4340
4341 tail = gettail(tmp);
4342 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
4343 return FAIL;
4344 STRCPY(tail, buf);
4345 }
4346 }
4347
4348 /*
4349 * Try to resolve the full name of the file so that the swapfile name will
4350 * be consistent even when opening a relative symlink from different
4351 * working directories.
4352 */
4353 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
4354}
4355#endif
4356
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357/*
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004358 * Make swap file name out of the file name and a directory name.
4359 * Returns pointer to allocated memory or NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004361 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004362makeswapname(
4363 char_u *fname,
4364 char_u *ffname UNUSED,
4365 buf_T *buf,
4366 char_u *dir_name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367{
4368 char_u *r, *s;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02004369 char_u *fname_res = fname;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004370#ifdef HAVE_READLINK
4371 char_u fname_buf[MAXPATHL];
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004372
4373 // Expand symlink in the file name, so that we put the swap file with the
4374 // actual file instead of with the symlink.
4375 if (resolve_symlink(fname, fname_buf) == OK)
4376 fname_res = fname_buf;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004377#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378
Bram Moolenaar4f974752019-02-17 17:44:42 +01004379#if defined(UNIX) || defined(MSWIN) // Need _very_ long file names
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01004380 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01004381
4382 s = dir_name + len;
4383 if (after_pathsep(dir_name, s) && len > 1 && s[-1] == s[-2])
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004384 { // Ends with '//', Use Full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 r = NULL;
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004386 if ((s = make_percent_swname(dir_name, fname_res)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 {
4388 r = modname(s, (char_u *)".swp", FALSE);
4389 vim_free(s);
4390 }
4391 return r;
4392 }
4393#endif
4394
4395 r = buf_modname(
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 (buf->b_p_sn || buf->b_shortname),
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004397 fname_res,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 (char_u *)
Bram Moolenaare60acc12011-05-10 16:41:25 +02004399#if defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 "_swp",
4401#else
4402 ".swp",
4403#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004404 // Prepend a '.' to the swap file name for the current directory.
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004405 dir_name[0] == '.' && dir_name[1] == NUL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004406 if (r == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 return NULL;
4408
4409 s = get_file_in_dir(r, dir_name);
4410 vim_free(r);
4411 return s;
4412}
4413
4414/*
4415 * Get file name to use for swap file or backup file.
4416 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
4417 * option "dname".
4418 * - If "dname" is ".", return "fname" (swap file in dir of file).
4419 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
4420 * relative to dir of file).
4421 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
4422 * dir).
4423 *
4424 * The return value is an allocated string and can be NULL.
4425 */
4426 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004427get_file_in_dir(
4428 char_u *fname,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004429 char_u *dname) // don't use "dirname", it is a global for Alpha
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430{
4431 char_u *t;
4432 char_u *tail;
4433 char_u *retval;
4434 int save_char;
4435
4436 tail = gettail(fname);
4437
4438 if (dname[0] == '.' && dname[1] == NUL)
4439 retval = vim_strsave(fname);
4440 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
4441 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004442 if (tail == fname) // no path before file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 retval = concat_fnames(dname + 2, tail, TRUE);
4444 else
4445 {
4446 save_char = *tail;
4447 *tail = NUL;
4448 t = concat_fnames(fname, dname + 2, TRUE);
4449 *tail = save_char;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004450 if (t == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 retval = NULL;
4452 else
4453 {
4454 retval = concat_fnames(t, tail, TRUE);
4455 vim_free(t);
4456 }
4457 }
4458 }
4459 else
4460 retval = concat_fnames(dname, tail, TRUE);
4461
Bram Moolenaar4f974752019-02-17 17:44:42 +01004462#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004463 if (retval != NULL)
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004464 for (t = gettail(retval); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004465 if (*t == ':')
4466 *t = '%';
4467#endif
4468
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 return retval;
4470}
4471
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004472/*
4473 * Print the ATTENTION message: info about an existing swap file.
4474 */
4475 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004476attention_message(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004477 buf_T *buf, // buffer being edited
4478 char_u *fname) // swap file name
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004479{
Bram Moolenaar8767f522016-07-01 17:17:39 +02004480 stat_T st;
Bram Moolenaar63d25552019-05-10 21:28:38 +02004481 time_t swap_mtime;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004482
4483 ++no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004484 (void)emsg(_("E325: ATTENTION"));
Bram Moolenaar32526b32019-01-19 17:43:09 +01004485 msg_puts(_("\nFound a swap file by the name \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004486 msg_home_replace(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004487 msg_puts("\"\n");
Bram Moolenaar63d25552019-05-10 21:28:38 +02004488 swap_mtime = swapfile_info(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004489 msg_puts(_("While opening file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004490 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004491 msg_puts("\"\n");
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004492 if (mch_stat((char *)buf->b_fname, &st) == -1)
4493 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004494 msg_puts(_(" CANNOT BE FOUND"));
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004495 }
4496 else
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004497 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004498 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02004499 msg_puts(get_ctime(st.st_mtime, TRUE));
4500 if (swap_mtime != 0 && st.st_mtime > swap_mtime)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004501 msg_puts(_(" NEWER than swap file!\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004502 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004503 // Some of these messages are long to allow translation to
4504 // other languages.
Bram Moolenaar32526b32019-01-19 17:43:09 +01004505 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"));
4506 msg_puts(_("(2) An edit session for this file crashed.\n"));
4507 msg_puts(_(" If this is the case, use \":recover\" or \"vim -r "));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004508 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004509 msg_puts(_("\"\n to recover the changes (see \":help recovery\").\n"));
4510 msg_puts(_(" If you did this already, delete the swap file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004511 msg_outtrans(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004512 msg_puts(_("\"\n to avoid this message.\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004513 cmdline_row = msg_row;
4514 --no_wait_return;
4515}
4516
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004517#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004518/*
4519 * Trigger the SwapExists autocommands.
4520 * Returns a value for equivalent to do_dialog() (see below):
4521 * 0: still need to ask for a choice
4522 * 1: open read-only
4523 * 2: edit anyway
4524 * 3: recover
4525 * 4: delete it
4526 * 5: quit
4527 * 6: abort
4528 */
4529 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004530do_swapexists(buf_T *buf, char_u *fname)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004531{
4532 set_vim_var_string(VV_SWAPNAME, fname, -1);
4533 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
4534
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004535 // Trigger SwapExists autocommands with <afile> set to the file being
4536 // edited. Disallow changing directory here.
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004537 ++allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004538 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004539 --allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004540
4541 set_vim_var_string(VV_SWAPNAME, NULL, -1);
4542
4543 switch (*get_vim_var_str(VV_SWAPCHOICE))
4544 {
4545 case 'o': return 1;
4546 case 'e': return 2;
4547 case 'r': return 3;
4548 case 'd': return 4;
4549 case 'q': return 5;
4550 case 'a': return 6;
4551 }
4552
4553 return 0;
4554}
4555#endif
4556
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557/*
4558 * Find out what name to use for the swap file for buffer 'buf'.
4559 *
4560 * Several names are tried to find one that does not exist
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004561 * Returns the name in allocated memory or NULL.
Bram Moolenaarf541c362011-10-26 11:44:18 +02004562 * When out of memory "dirp" is set to NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 *
4564 * Note: If BASENAMELEN is not correct, you will get error messages for
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004565 * not being able to open the swap or undo file
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004566 * Note: May trigger SwapExists autocmd, pointers may change!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 */
4568 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004569findswapname(
4570 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004571 char_u **dirp, // pointer to list of directories
4572 char_u *old_fname) // don't give warning for this file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573{
4574 char_u *fname;
4575 int n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 char_u *dir_name;
4577#ifdef AMIGA
4578 BPTR fh;
4579#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 int r;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004581 char_u *buf_fname = buf->b_fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004583#if !defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584# define CREATE_DUMMY_FILE
4585 FILE *dummyfd = NULL;
4586
Bram Moolenaar4f974752019-02-17 17:44:42 +01004587# ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004588 if (buf_fname != NULL && !mch_isFullName(buf_fname)
4589 && vim_strchr(gettail(buf_fname), ':'))
4590 {
4591 char_u *t;
4592
4593 buf_fname = vim_strsave(buf_fname);
4594 if (buf_fname == NULL)
4595 buf_fname = buf->b_fname;
4596 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004597 for (t = gettail(buf_fname); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004598 if (*t == ':')
4599 *t = '%';
4600 }
4601# endif
4602
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004603 /*
4604 * If we start editing a new file, e.g. "test.doc", which resides on an
4605 * MSDOS compatible filesystem, it is possible that the file
4606 * "test.doc.swp" which we create will be exactly the same file. To avoid
4607 * this problem we temporarily create "test.doc". Don't do this when the
4608 * check below for a 8.3 file name is used.
4609 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004610 if (!(buf->b_p_sn || buf->b_shortname) && buf_fname != NULL
4611 && mch_getperm(buf_fname) < 0)
4612 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613#endif
4614
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004615 /*
4616 * Isolate a directory name from *dirp and put it in dir_name.
4617 * First allocate some memory to put the directory name in.
4618 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02004619 dir_name = alloc(STRLEN(*dirp) + 1);
Bram Moolenaarf541c362011-10-26 11:44:18 +02004620 if (dir_name == NULL)
4621 *dirp = NULL;
4622 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 (void)copy_option_part(dirp, dir_name, 31000, ",");
4624
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004625 /*
4626 * we try different names until we find one that does not exist yet
4627 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004628 if (dir_name == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 fname = NULL;
4630 else
Bram Moolenaar69c35002013-11-04 02:54:12 +01004631 fname = makeswapname(buf_fname, buf->b_ffname, buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632
4633 for (;;)
4634 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004635 if (fname == NULL) // must be out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004637 if ((n = (int)STRLEN(fname)) == 0) // safety check
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01004639 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 break;
4641 }
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004642#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643/*
4644 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
4645 * file names. If this is the first try and the swap file name does not fit in
4646 * 8.3, detect if this is the case, set shortname and try again.
4647 */
4648 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
4649 && !(buf->b_p_sn || buf->b_shortname))
4650 {
4651 char_u *tail;
4652 char_u *fname2;
Bram Moolenaar8767f522016-07-01 17:17:39 +02004653 stat_T s1, s2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 int f1, f2;
4655 int created1 = FALSE, created2 = FALSE;
4656 int same = FALSE;
4657
4658 /*
4659 * Check if swapfile name does not fit in 8.3:
4660 * It either contains two dots, is longer than 8 chars, or starts
4661 * with a dot.
4662 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004663 tail = gettail(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 if ( vim_strchr(tail, '.') != NULL
4665 || STRLEN(tail) > (size_t)8
4666 || *gettail(fname) == '.')
4667 {
4668 fname2 = alloc(n + 2);
4669 if (fname2 != NULL)
4670 {
4671 STRCPY(fname2, fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004672 // if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
4673 // if fname == ".xx.swp", fname2 = ".xx.swpx"
4674 // if fname == "123456789.swp", fname2 = "12345678x.swp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 if (vim_strchr(tail, '.') != NULL)
4676 fname2[n - 1] = 'x';
4677 else if (*gettail(fname) == '.')
4678 {
4679 fname2[n] = 'x';
4680 fname2[n + 1] = NUL;
4681 }
4682 else
4683 fname2[n - 5] += 1;
4684 /*
4685 * may need to create the files to be able to use mch_stat()
4686 */
4687 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4688 if (f1 < 0)
4689 {
4690 f1 = mch_open_rw((char *)fname,
4691 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 created1 = TRUE;
4693 }
4694 if (f1 >= 0)
4695 {
4696 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4697 if (f2 < 0)
4698 {
4699 f2 = mch_open_rw((char *)fname2,
4700 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4701 created2 = TRUE;
4702 }
4703 if (f2 >= 0)
4704 {
4705 /*
4706 * Both files exist now. If mch_stat() returns the
4707 * same device and inode they are the same file.
4708 */
4709 if (mch_fstat(f1, &s1) != -1
4710 && mch_fstat(f2, &s2) != -1
4711 && s1.st_dev == s2.st_dev
4712 && s1.st_ino == s2.st_ino)
4713 same = TRUE;
4714 close(f2);
4715 if (created2)
4716 mch_remove(fname2);
4717 }
4718 close(f1);
4719 if (created1)
4720 mch_remove(fname);
4721 }
4722 vim_free(fname2);
4723 if (same)
4724 {
4725 buf->b_shortname = TRUE;
4726 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004727 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004728 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004729 continue; // try again with b_shortname set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 }
4731 }
4732 }
4733 }
4734#endif
4735 /*
4736 * check if the swapfile already exists
4737 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004738 if (mch_getperm(fname) < 0) // it does not exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 {
4740#ifdef HAVE_LSTAT
Bram Moolenaar8767f522016-07-01 17:17:39 +02004741 stat_T sb;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742
4743 /*
4744 * Extra security check: When a swap file is a symbolic link, this
4745 * is most likely a symlink attack.
4746 */
4747 if (mch_lstat((char *)fname, &sb) < 0)
4748#else
4749# ifdef AMIGA
4750 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4751 /*
4752 * on the Amiga mch_getperm() will return -1 when the file exists
4753 * but is being used by another program. This happens if you edit
4754 * a file twice.
4755 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004756 if (fh != (BPTR)NULL) // can open file, OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 {
4758 Close(fh);
4759 mch_remove(fname);
4760 break;
4761 }
4762 if (IoErr() != ERROR_OBJECT_IN_USE
4763 && IoErr() != ERROR_OBJECT_EXISTS)
4764# endif
4765#endif
4766 break;
4767 }
4768
4769 /*
4770 * A file name equal to old_fname is OK to use.
4771 */
4772 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4773 break;
4774
4775 /*
4776 * get here when file already exists
4777 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004778 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') // first try
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780 /*
4781 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4782 * and file.doc are the same file. To guess if this problem is
4783 * present try if file.doc.swx exists. If it does, we set
4784 * buf->b_shortname and try file_doc.swp (dots replaced by
4785 * underscores for this file), and try again. If it doesn't we
4786 * assume that "file.doc.swp" already exists.
4787 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004788 if (!(buf->b_p_sn || buf->b_shortname)) // not tried yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 {
4790 fname[n - 1] = 'x';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004791 r = mch_getperm(fname); // try "file.swx"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 fname[n - 1] = 'p';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004793 if (r >= 0) // "file.swx" seems to exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 {
4795 buf->b_shortname = TRUE;
4796 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004797 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004798 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004799 continue; // try again with '.' replaced with '_'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 }
4801 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 /*
4803 * If we get here the ".swp" file really exists.
4804 * Give an error message, unless recovering, no file name, we are
4805 * viewing a help file or when the path of the file is different
4806 * (happens when all .swp files are in one directory).
4807 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004808 if (!recoverymode && buf_fname != NULL
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02004809 && !buf->b_help
4810 && !(buf->b_flags & (BF_DUMMY | BF_NO_SEA)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 {
4812 int fd;
4813 struct block0 b0;
4814 int differ = FALSE;
4815
4816 /*
4817 * Try to read block 0 from the swap file to get the original
4818 * file name (and inode number).
4819 */
4820 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4821 if (fd >= 0)
4822 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01004823 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 {
4825 /*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004826 * If the swapfile has the same directory as the
4827 * buffer don't compare the directory names, they can
4828 * have a different mountpoint.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004830 if (b0.b0_flags & B0_SAME_DIR)
4831 {
4832 if (fnamecmp(gettail(buf->b_ffname),
4833 gettail(b0.b0_fname)) != 0
4834 || !same_directory(fname, buf->b_ffname))
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004835 {
4836#ifdef CHECK_INODE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004837 // Symlinks may point to the same file even
4838 // when the name differs, need to check the
4839 // inode too.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004840 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4841 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4842 char_to_long(b0.b0_ino)))
4843#endif
4844 differ = TRUE;
4845 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004846 }
4847 else
4848 {
4849 /*
4850 * The name in the swap file may be
4851 * "~user/path/file". Expand it first.
4852 */
4853 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854#ifdef CHECK_INODE
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004855 if (fnamecmp_ino(buf->b_ffname, NameBuff,
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004856 char_to_long(b0.b0_ino)))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004857 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858#else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004859 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4860 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004862 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 }
4864 close(fd);
4865 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004867 // give the ATTENTION message when there is an old swap file
4868 // for the current file, and the buffer was not recovered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4870 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4871 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004872 int choice = 0;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02004873 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874#ifdef CREATE_DUMMY_FILE
4875 int did_use_dummy = FALSE;
4876
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004877 // Avoid getting a warning for the file being created
4878 // outside of Vim, it was created at the start of this
4879 // function. Delete the file now, because Vim might exit
4880 // here if the window is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 if (dummyfd != NULL)
4882 {
4883 fclose(dummyfd);
4884 dummyfd = NULL;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004885 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 did_use_dummy = TRUE;
4887 }
4888#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02004890#ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 process_still_running = FALSE;
4892#endif
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02004893 // It's safe to delete the swap file if all these are true:
4894 // - the edited file exists
4895 // - the swap file has no changes and looks OK
4896 if (mch_stat((char *)buf->b_fname, &st) == 0
4897 && swapfile_unchanged(fname))
4898 {
4899 choice = 4;
4900 if (p_verbose > 0)
4901 verb_msg(_("Found a swap file that is not useful, deleting it"));
4902 }
4903
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004904#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004905 /*
4906 * If there is an SwapExists autocommand and we can handle
4907 * the response, trigger it. It may return 0 to ask the
4908 * user anyway.
4909 */
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02004910 if (choice == 0
4911 && swap_exists_action != SEA_NONE
Bram Moolenaar69c35002013-11-04 02:54:12 +01004912 && has_autocmd(EVENT_SWAPEXISTS, buf_fname, buf))
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004913 choice = do_swapexists(buf, fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004915 if (choice == 0)
4916#endif
4917 {
4918#ifdef FEAT_GUI
Bram Moolenaar798184c2018-10-07 20:48:39 +02004919 // If we are supposed to start the GUI but it wasn't
4920 // completely started yet, start it now. This makes
4921 // the messages displayed in the Vim window when
4922 // loading a session from the .gvimrc file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004923 if (gui.starting && !gui.in_use)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02004924 gui_start(NULL);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004925#endif
Bram Moolenaar798184c2018-10-07 20:48:39 +02004926 // Show info about the existing swap file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004927 attention_message(buf, fname);
4928
Bram Moolenaar798184c2018-10-07 20:48:39 +02004929 // We don't want a 'q' typed at the more-prompt
4930 // interrupt loading a file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004931 got_int = FALSE;
Bram Moolenaar798184c2018-10-07 20:48:39 +02004932
4933 // If vimrc has "simalt ~x" we don't want it to
4934 // interfere with the prompt here.
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02004935 flush_buffers(FLUSH_TYPEAHEAD);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004936 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937
4938#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004939 if (swap_exists_action != SEA_NONE && choice == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 {
4941 char_u *name;
4942
Bram Moolenaar964b3742019-05-24 18:54:09 +02004943 name = alloc(STRLEN(fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 + STRLEN(_("Swap file \""))
Bram Moolenaar964b3742019-05-24 18:54:09 +02004945 + STRLEN(_("\" already exists!")) + 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 if (name != NULL)
4947 {
4948 STRCPY(name, _("Swap file \""));
4949 home_replace(NULL, fname, name + STRLEN(name),
4950 1000, TRUE);
4951 STRCAT(name, _("\" already exists!"));
4952 }
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004953 choice = do_dialog(VIM_WARNING,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 (char_u *)_("VIM - ATTENTION"),
4955 name == NULL
4956 ? (char_u *)_("Swap file already exists!")
4957 : name,
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02004958# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 process_still_running
4960 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4961# endif
Bram Moolenaard2c340a2011-01-17 20:08:11 +01004962 (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 +00004963
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02004964# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004965 if (process_still_running && choice >= 4)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004966 choice++; // Skip missing "Delete it" button
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004967# endif
4968 vim_free(name);
4969
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004970 // pretend screen didn't scroll, need redraw anyway
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004971 msg_scrolled = 0;
4972 redraw_all_later(NOT_VALID);
4973 }
4974#endif
4975
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004976 if (choice > 0)
4977 {
4978 switch (choice)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 {
4980 case 1:
4981 buf->b_p_ro = TRUE;
4982 break;
4983 case 2:
4984 break;
4985 case 3:
4986 swap_exists_action = SEA_RECOVER;
4987 break;
4988 case 4:
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004989 mch_remove(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 break;
4991 case 5:
4992 swap_exists_action = SEA_QUIT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 break;
4994 case 6:
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004995 swap_exists_action = SEA_QUIT;
4996 got_int = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 break;
4998 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005000 // If the file was deleted this fname can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 if (mch_getperm(fname) < 0)
5002 break;
5003 }
5004 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005006 msg_puts("\n");
Bram Moolenaar4770d092006-01-12 23:22:24 +00005007 if (msg_silent == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005008 // call wait_return() later
Bram Moolenaar4770d092006-01-12 23:22:24 +00005009 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 }
5011
5012#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005013 // Going to try another name, need the dummy file again.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014 if (did_use_dummy)
Bram Moolenaar69c35002013-11-04 02:54:12 +01005015 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016#endif
5017 }
5018 }
5019 }
5020
5021 /*
5022 * Change the ".swp" extension to find another file that can be used.
5023 * First decrement the last char: ".swo", ".swn", etc.
5024 * If that still isn't enough decrement the last but one char: ".svz"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005025 * Can happen when editing many "No Name" buffers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005027 if (fname[n - 1] == 'a') // ".s?a"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005029 if (fname[n - 2] == 'a') // ".saa": tried enough, give up
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005031 emsg(_("E326: Too many swap files found"));
Bram Moolenaard23a8232018-02-10 18:45:26 +01005032 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 break;
5034 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005035 --fname[n - 2]; // ".svz", ".suz", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 fname[n - 1] = 'z' + 1;
5037 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005038 --fname[n - 1]; // ".swo", ".swn", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 }
5040
5041 vim_free(dir_name);
5042#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005043 if (dummyfd != NULL) // file has been created temporarily
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 {
5045 fclose(dummyfd);
Bram Moolenaar69c35002013-11-04 02:54:12 +01005046 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 }
5048#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01005049#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01005050 if (buf_fname != buf->b_fname)
5051 vim_free(buf_fname);
5052#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 return fname;
5054}
5055
5056 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005057b0_magic_wrong(ZERO_BL *b0p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058{
5059 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
5060 || b0p->b0_magic_int != (int)B0_MAGIC_INT
5061 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
5062 || b0p->b0_magic_char != B0_MAGIC_CHAR);
5063}
5064
5065#ifdef CHECK_INODE
5066/*
5067 * Compare current file name with file name from swap file.
5068 * Try to use inode numbers when possible.
5069 * Return non-zero when files are different.
5070 *
5071 * When comparing file names a few things have to be taken into consideration:
5072 * - When working over a network the full path of a file depends on the host.
5073 * We check the inode number if possible. It is not 100% reliable though,
5074 * because the device number cannot be used over a network.
5075 * - When a file does not exist yet (editing a new file) there is no inode
5076 * number.
5077 * - The file name in a swap file may not be valid on the current host. The
5078 * "~user" form is used whenever possible to avoid this.
5079 *
5080 * This is getting complicated, let's make a table:
5081 *
5082 * ino_c ino_s fname_c fname_s differ =
5083 *
5084 * both files exist -> compare inode numbers:
5085 * != 0 != 0 X X ino_c != ino_s
5086 *
5087 * inode number(s) unknown, file names available -> compare file names
5088 * == 0 X OK OK fname_c != fname_s
5089 * X == 0 OK OK fname_c != fname_s
5090 *
5091 * current file doesn't exist, file for swap file exist, file name(s) not
5092 * available -> probably different
5093 * == 0 != 0 FAIL X TRUE
5094 * == 0 != 0 X FAIL TRUE
5095 *
5096 * current file exists, inode for swap unknown, file name(s) not
5097 * available -> probably different
5098 * != 0 == 0 FAIL X TRUE
5099 * != 0 == 0 X FAIL TRUE
5100 *
5101 * current file doesn't exist, inode for swap unknown, one file name not
5102 * available -> probably different
5103 * == 0 == 0 FAIL OK TRUE
5104 * == 0 == 0 OK FAIL TRUE
5105 *
5106 * current file doesn't exist, inode for swap unknown, both file names not
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005107 * available -> compare file names
5108 * == 0 == 0 FAIL FAIL fname_c != fname_s
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 *
5110 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
5111 * can't be changed without making the block 0 incompatible with 32 bit
5112 * versions.
5113 */
5114
5115 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005116fnamecmp_ino(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005117 char_u *fname_c, // current file name
5118 char_u *fname_s, // file name from swap file
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005119 long ino_block0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120{
Bram Moolenaar8767f522016-07-01 17:17:39 +02005121 stat_T st;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005122 ino_t ino_c = 0; // ino of current file
5123 ino_t ino_s; // ino of file from swap file
5124 char_u buf_c[MAXPATHL]; // full path of fname_c
5125 char_u buf_s[MAXPATHL]; // full path of fname_s
5126 int retval_c; // flag: buf_c valid
5127 int retval_s; // flag: buf_s valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128
5129 if (mch_stat((char *)fname_c, &st) == 0)
5130 ino_c = (ino_t)st.st_ino;
5131
5132 /*
5133 * First we try to get the inode from the file name, because the inode in
5134 * the swap file may be outdated. If that fails (e.g. this path is not
5135 * valid on this machine), use the inode from block 0.
5136 */
5137 if (mch_stat((char *)fname_s, &st) == 0)
5138 ino_s = (ino_t)st.st_ino;
5139 else
5140 ino_s = (ino_t)ino_block0;
5141
5142 if (ino_c && ino_s)
5143 return (ino_c != ino_s);
5144
5145 /*
5146 * One of the inode numbers is unknown, try a forced vim_FullName() and
5147 * compare the file names.
5148 */
5149 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
5150 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
5151 if (retval_c == OK && retval_s == OK)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005152 return STRCMP(buf_c, buf_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
5154 /*
5155 * Can't compare inodes or file names, guess that the files are different,
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005156 * unless both appear not to exist at all, then compare with the file name
5157 * in the swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 */
5159 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005160 return STRCMP(fname_c, fname_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 return TRUE;
5162}
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005163#endif // CHECK_INODE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165/*
5166 * Move a long integer into a four byte character array.
5167 * Used for machine independency in block zero.
5168 */
5169 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005170long_to_char(long n, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171{
5172 s[0] = (char_u)(n & 0xff);
5173 n = (unsigned)n >> 8;
5174 s[1] = (char_u)(n & 0xff);
5175 n = (unsigned)n >> 8;
5176 s[2] = (char_u)(n & 0xff);
5177 n = (unsigned)n >> 8;
5178 s[3] = (char_u)(n & 0xff);
5179}
5180
5181 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005182char_to_long(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183{
5184 long retval;
5185
5186 retval = s[3];
5187 retval <<= 8;
5188 retval |= s[2];
5189 retval <<= 8;
5190 retval |= s[1];
5191 retval <<= 8;
5192 retval |= s[0];
5193
5194 return retval;
5195}
5196
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005197/*
5198 * Set the flags in the first block of the swap file:
5199 * - file is modified or not: buf->b_changed
5200 * - 'fileformat'
5201 * - 'fileencoding'
5202 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005204ml_setflags(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205{
5206 bhdr_T *hp;
5207 ZERO_BL *b0p;
5208
5209 if (!buf->b_ml.ml_mfp)
5210 return;
5211 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
5212 {
5213 if (hp->bh_bnum == 0)
5214 {
5215 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005216 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
5217 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
5218 | (get_fileformat(buf) + 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005219 add_b0_fenc(b0p, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 hp->bh_flags |= BH_DIRTY;
5221 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
5222 break;
5223 }
5224 }
5225}
5226
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005227#if defined(FEAT_CRYPT) || defined(PROTO)
5228/*
5229 * If "data" points to a data block encrypt the text in it and return a copy
5230 * in allocated memory. Return NULL when out of memory.
5231 * Otherwise return "data".
5232 */
5233 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005234ml_encrypt_data(
5235 memfile_T *mfp,
5236 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005237 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005238 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005239{
5240 DATA_BL *dp = (DATA_BL *)data;
5241 char_u *head_end;
5242 char_u *text_start;
5243 char_u *new_data;
5244 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005245 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005246
5247 if (dp->db_id != DATA_ID)
5248 return data;
5249
Bram Moolenaarbc563362015-06-09 18:35:25 +02005250 state = ml_crypt_prepare(mfp, offset, FALSE);
5251 if (state == NULL)
5252 return data;
5253
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005254 new_data = alloc(size);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005255 if (new_data == NULL)
5256 return NULL;
5257 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5258 text_start = (char_u *)dp + dp->db_txt_start;
5259 text_len = size - dp->db_txt_start;
5260
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005261 // Copy the header and the text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005262 mch_memmove(new_data, dp, head_end - (char_u *)dp);
5263
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005264 // Encrypt the text.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005265 crypt_encode(state, text_start, text_len, new_data + dp->db_txt_start);
5266 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005267
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005268 // Clear the gap.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005269 if (head_end < text_start)
5270 vim_memset(new_data + (head_end - data), 0, text_start - head_end);
5271
5272 return new_data;
5273}
5274
5275/*
Bram Moolenaarbc563362015-06-09 18:35:25 +02005276 * Decrypt the text in "data" if it points to an encrypted data block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005277 */
5278 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005279ml_decrypt_data(
5280 memfile_T *mfp,
5281 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005282 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005283 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005284{
5285 DATA_BL *dp = (DATA_BL *)data;
5286 char_u *head_end;
5287 char_u *text_start;
5288 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005289 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005290
5291 if (dp->db_id == DATA_ID)
5292 {
5293 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5294 text_start = (char_u *)dp + dp->db_txt_start;
5295 text_len = dp->db_txt_end - dp->db_txt_start;
5296
5297 if (head_end > text_start || dp->db_txt_start > size
5298 || dp->db_txt_end > size)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005299 return; // data was messed up
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005300
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005301 state = ml_crypt_prepare(mfp, offset, TRUE);
Bram Moolenaarbc563362015-06-09 18:35:25 +02005302 if (state != NULL)
5303 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005304 // Decrypt the text in place.
Bram Moolenaarbc563362015-06-09 18:35:25 +02005305 crypt_decode_inplace(state, text_start, text_len);
5306 crypt_free_state(state);
5307 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005308 }
5309}
5310
5311/*
5312 * Prepare for encryption/decryption, using the key, seed and offset.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005313 * Return an allocated cryptstate_T *.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005314 */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005315 static cryptstate_T *
Bram Moolenaar8767f522016-07-01 17:17:39 +02005316ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005317{
5318 buf_T *buf = mfp->mf_buffer;
5319 char_u salt[50];
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005320 int method_nr;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005321 char_u *key;
5322 char_u *seed;
5323
5324 if (reading && mfp->mf_old_key != NULL)
5325 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005326 // Reading back blocks with the previous key/method/seed.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005327 method_nr = mfp->mf_old_cm;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005328 key = mfp->mf_old_key;
5329 seed = mfp->mf_old_seed;
5330 }
5331 else
5332 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005333 method_nr = crypt_get_method_nr(buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005334 key = buf->b_p_key;
5335 seed = mfp->mf_seed;
5336 }
Bram Moolenaarbc563362015-06-09 18:35:25 +02005337 if (*key == NUL)
5338 return NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005339
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005340 if (method_nr == CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005341 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005342 // For PKzip: Append the offset to the key, so that we use a different
5343 // key for every block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005344 vim_snprintf((char *)salt, sizeof(salt), "%s%ld", key, (long)offset);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005345 return crypt_create(method_nr, salt, NULL, 0, NULL, 0);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005346 }
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005347
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005348 // Using blowfish or better: add salt and seed. We use the byte offset
5349 // of the block for the salt.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005350 vim_snprintf((char *)salt, sizeof(salt), "%ld", (long)offset);
5351 return crypt_create(method_nr, key, salt, (int)STRLEN(salt),
5352 seed, MF_SEED_LEN);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005353}
5354
5355#endif
5356
5357
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358#if defined(FEAT_BYTEOFF) || defined(PROTO)
5359
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005360#define MLCS_MAXL 800 // max no of lines in chunk
5361#define MLCS_MINL 400 // should be half of MLCS_MAXL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362
5363/*
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02005364 * Keep information for finding byte offset of a line, updtype may be one of:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
5366 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
5367 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
5368 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
5369 */
5370 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005371ml_updatechunk(
5372 buf_T *buf,
5373 linenr_T line,
5374 long len,
5375 int updtype)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376{
5377 static buf_T *ml_upd_lastbuf = NULL;
5378 static linenr_T ml_upd_lastline;
5379 static linenr_T ml_upd_lastcurline;
5380 static int ml_upd_lastcurix;
5381
5382 linenr_T curline = ml_upd_lastcurline;
5383 int curix = ml_upd_lastcurix;
5384 long size;
5385 chunksize_T *curchnk;
5386 int rest;
5387 bhdr_T *hp;
5388 DATA_BL *dp;
5389
5390 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
5391 return;
5392 if (buf->b_ml.ml_chunksize == NULL)
5393 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005394 buf->b_ml.ml_chunksize = ALLOC_MULT(chunksize_T, 100);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 if (buf->b_ml.ml_chunksize == NULL)
5396 {
5397 buf->b_ml.ml_usedchunks = -1;
5398 return;
5399 }
5400 buf->b_ml.ml_numchunks = 100;
5401 buf->b_ml.ml_usedchunks = 1;
5402 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
5403 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
5404 }
5405
5406 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
5407 {
5408 /*
5409 * First line in empty buffer from ml_flush_line() -- reset
5410 */
5411 buf->b_ml.ml_usedchunks = 1;
5412 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01005413 buf->b_ml.ml_chunksize[0].mlcs_totalsize = (long)buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 return;
5415 }
5416
5417 /*
5418 * Find chunk that our line belongs to, curline will be at start of the
5419 * chunk.
5420 */
5421 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
5422 || updtype != ML_CHNK_ADDLINE)
5423 {
5424 for (curline = 1, curix = 0;
5425 curix < buf->b_ml.ml_usedchunks - 1
5426 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5427 curix++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 }
Bram Moolenaara9a8e042018-10-30 22:15:55 +01005430 else if (curix < buf->b_ml.ml_usedchunks - 1
5431 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005433 // Adjust cached curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5435 curix++;
5436 }
5437 curchnk = buf->b_ml.ml_chunksize + curix;
5438
5439 if (updtype == ML_CHNK_DELLINE)
Bram Moolenaar5a6404c2006-11-01 17:12:57 +00005440 len = -len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 curchnk->mlcs_totalsize += len;
5442 if (updtype == ML_CHNK_ADDLINE)
5443 {
5444 curchnk->mlcs_numlines++;
5445
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005446 // May resize here so we don't have to do it in both cases below
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
5448 {
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005449 chunksize_T *t_chunksize = buf->b_ml.ml_chunksize;
5450
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
Bram Moolenaar51b6eb42020-08-22 15:19:18 +02005452 buf->b_ml.ml_chunksize = vim_realloc(buf->b_ml.ml_chunksize,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
5454 if (buf->b_ml.ml_chunksize == NULL)
5455 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005456 // Hmmmm, Give up on offset for this buffer
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005457 vim_free(t_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005458 buf->b_ml.ml_usedchunks = -1;
5459 return;
5460 }
5461 }
5462
5463 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
5464 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005465 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 int idx;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005467 int end_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 int text_end;
5469 int linecnt;
5470
5471 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
5472 buf->b_ml.ml_chunksize + curix,
5473 (buf->b_ml.ml_usedchunks - curix) *
5474 sizeof(chunksize_T));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005475 // Compute length of first half of lines in the split chunk
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 size = 0;
5477 linecnt = 0;
5478 while (curline < buf->b_ml.ml_line_count
5479 && linecnt < MLCS_MINL)
5480 {
5481 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5482 {
5483 buf->b_ml.ml_usedchunks = -1;
5484 return;
5485 }
5486 dp = (DATA_BL *)(hp->bh_data);
5487 count = (long)(buf->b_ml.ml_locked_high) -
5488 (long)(buf->b_ml.ml_locked_low) + 1;
5489 idx = curline - buf->b_ml.ml_locked_low;
5490 curline = buf->b_ml.ml_locked_high + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005491
5492 // compute index of last line to use in this MEMLINE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 rest = count - idx;
5494 if (linecnt + rest > MLCS_MINL)
5495 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005496 end_idx = idx + MLCS_MINL - linecnt - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 linecnt = MLCS_MINL;
5498 }
5499 else
5500 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005501 end_idx = count - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 linecnt += rest;
5503 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005504#ifdef FEAT_PROP_POPUP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005505 if (buf->b_has_textprop)
5506 {
5507 int i;
5508
5509 // We cannot use the text pointers to get the text length,
5510 // the text prop info would also be counted. Go over the
5511 // lines.
5512 for (i = end_idx; i < idx; ++i)
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01005513 size += (int)STRLEN((char_u *)dp + (dp->db_index[i] & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005514 }
5515 else
5516#endif
5517 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005518 if (idx == 0)// first line in block, text at the end
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005519 text_end = dp->db_txt_end;
5520 else
5521 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
5522 size += text_end - ((dp->db_index[end_idx]) & DB_INDEX_MASK);
5523 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 }
5525 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
5526 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
5527 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
5528 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
5529 buf->b_ml.ml_usedchunks++;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005530 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 return;
5532 }
5533 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
5534 && curix == buf->b_ml.ml_usedchunks - 1
5535 && buf->b_ml.ml_line_count - line <= 1)
5536 {
5537 /*
5538 * We are in the last chunk and it is cheap to crate a new one
5539 * after this. Do it now to avoid the loop above later on
5540 */
5541 curchnk = buf->b_ml.ml_chunksize + curix + 1;
5542 buf->b_ml.ml_usedchunks++;
5543 if (line == buf->b_ml.ml_line_count)
5544 {
5545 curchnk->mlcs_numlines = 0;
5546 curchnk->mlcs_totalsize = 0;
5547 }
5548 else
5549 {
5550 /*
5551 * Line is just prior to last, move count for last
5552 * This is the common case when loading a new file
5553 */
5554 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
5555 if (hp == NULL)
5556 {
5557 buf->b_ml.ml_usedchunks = -1;
5558 return;
5559 }
5560 dp = (DATA_BL *)(hp->bh_data);
5561 if (dp->db_line_count == 1)
5562 rest = dp->db_txt_end - dp->db_txt_start;
5563 else
5564 rest =
5565 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
5566 - dp->db_txt_start;
5567 curchnk->mlcs_totalsize = rest;
5568 curchnk->mlcs_numlines = 1;
5569 curchnk[-1].mlcs_totalsize -= rest;
5570 curchnk[-1].mlcs_numlines -= 1;
5571 }
5572 }
5573 }
5574 else if (updtype == ML_CHNK_DELLINE)
5575 {
5576 curchnk->mlcs_numlines--;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005577 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 if (curix < (buf->b_ml.ml_usedchunks - 1)
5579 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
5580 <= MLCS_MINL)
5581 {
5582 curix++;
5583 curchnk = buf->b_ml.ml_chunksize + curix;
5584 }
5585 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
5586 {
5587 buf->b_ml.ml_usedchunks--;
5588 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
5589 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
5590 return;
5591 }
5592 else if (curix == 0 || (curchnk->mlcs_numlines > 10
5593 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
5594 > MLCS_MINL))
5595 {
5596 return;
5597 }
5598
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005599 // Collapse chunks
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
5601 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
5602 buf->b_ml.ml_usedchunks--;
5603 if (curix < buf->b_ml.ml_usedchunks)
5604 {
5605 mch_memmove(buf->b_ml.ml_chunksize + curix,
5606 buf->b_ml.ml_chunksize + curix + 1,
5607 (buf->b_ml.ml_usedchunks - curix) *
5608 sizeof(chunksize_T));
5609 }
5610 return;
5611 }
5612 ml_upd_lastbuf = buf;
5613 ml_upd_lastline = line;
5614 ml_upd_lastcurline = curline;
5615 ml_upd_lastcurix = curix;
5616}
5617
5618/*
5619 * Find offset for line or line with offset.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005620 * Find line with offset if "lnum" is 0; return remaining offset in offp
5621 * Find offset of line if "lnum" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 * return -1 if information is not available
5623 */
5624 long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005625ml_find_line_or_offset(buf_T *buf, linenr_T lnum, long *offp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626{
5627 linenr_T curline;
5628 int curix;
5629 long size;
5630 bhdr_T *hp;
5631 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005632 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 int idx;
5634 int start_idx;
5635 int text_end;
5636 long offset;
5637 int len;
5638 int ffdos = (get_fileformat(buf) == EOL_DOS);
5639 int extra = 0;
5640
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005641 // take care of cached line first
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005642 ml_flush_line(curbuf);
5643
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 if (buf->b_ml.ml_usedchunks == -1
5645 || buf->b_ml.ml_chunksize == NULL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005646 || lnum < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 return -1;
5648
5649 if (offp == NULL)
5650 offset = 0;
5651 else
5652 offset = *offp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005653 if (lnum == 0 && offset <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005654 return 1; // Not a "find offset" and offset 0 _must_ be in line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 /*
5656 * Find the last chunk before the one containing our line. Last chunk is
5657 * special because it will never qualify
5658 */
5659 curline = 1;
5660 curix = size = 0;
5661 while (curix < buf->b_ml.ml_usedchunks - 1
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005662 && ((lnum != 0
5663 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 || (offset != 0
5665 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
5666 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
5667 {
5668 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5669 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
5670 if (offset && ffdos)
5671 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5672 curix++;
5673 }
5674
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005675 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 {
5677 if (curline > buf->b_ml.ml_line_count
5678 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5679 return -1;
5680 dp = (DATA_BL *)(hp->bh_data);
5681 count = (long)(buf->b_ml.ml_locked_high) -
5682 (long)(buf->b_ml.ml_locked_low) + 1;
5683 start_idx = idx = curline - buf->b_ml.ml_locked_low;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005684 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 text_end = dp->db_txt_end;
5686 else
5687 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005688 // Compute index of last line to use in this MEMLINE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005689 if (lnum != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005691 if (curline + (count - idx) >= lnum)
5692 idx += lnum - curline - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 else
5694 idx = count - 1;
5695 }
5696 else
5697 {
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005698#ifdef FEAT_PROP_POPUP
Bram Moolenaar109ef122020-01-17 19:12:03 +01005699 size_t textprop_total = 0;
5700 size_t textprop_size = 0;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005701 char_u *l1, *l2;
5702#endif
5703
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 extra = 0;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005705 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 {
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005707#ifdef FEAT_PROP_POPUP
5708 if (buf->b_has_textprop)
5709 {
5710 // compensate for the extra bytes taken by textprops
5711 l1 = (char_u *)dp + ((dp->db_index[idx]) & DB_INDEX_MASK);
5712 l2 = (char_u *)dp + (idx == 0 ? dp->db_txt_end
5713 : ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
5714 textprop_size = (l2 - l1) - (STRLEN(l1) + 1);
5715 }
5716#endif
5717 if (!(offset >= size
5718 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
5719#ifdef FEAT_PROP_POPUP
Bram Moolenaar94b6fb72020-01-17 21:00:59 +01005720 - (long)(textprop_total + textprop_size)
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005721#endif
5722 + ffdos))
5723 break;
5724
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 if (ffdos)
5726 size++;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005727#ifdef FEAT_PROP_POPUP
5728 textprop_total += textprop_size;
5729#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 if (idx == count - 1)
5731 {
5732 extra = 1;
5733 break;
5734 }
5735 idx++;
5736 }
5737 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005738#ifdef FEAT_PROP_POPUP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005739 if (buf->b_has_textprop)
5740 {
5741 int i;
5742
5743 // cannot use the db_index pointer, need to get the actual text
5744 // lengths.
5745 len = 0;
5746 for (i = start_idx; i <= idx; ++i)
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005747 len += (int)STRLEN((char_u *)dp
5748 + ((dp->db_index[i]) & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005749 }
5750 else
5751#endif
5752 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 size += len;
5754 if (offset != 0 && size >= offset)
5755 {
5756 if (size + ffdos == offset)
5757 *offp = 0;
5758 else if (idx == start_idx)
5759 *offp = offset - size + len;
5760 else
5761 *offp = offset - size + len
5762 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
5763 curline += idx - start_idx + extra;
5764 if (curline > buf->b_ml.ml_line_count)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005765 return -1; // exactly one byte beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 return curline;
5767 }
5768 curline = buf->b_ml.ml_locked_high + 1;
5769 }
5770
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005771 if (lnum != 0)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005772 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005773 // Count extra CR characters.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005774 if (ffdos)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005775 size += lnum - 1;
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005776
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005777 // Don't count the last line break if 'noeol' and ('bin' or
5778 // 'nofixeol').
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005779 if ((!buf->b_p_fixeol || buf->b_p_bin) && !buf->b_p_eol
Bram Moolenaarc26f7c62018-08-20 22:53:04 +02005780 && lnum > buf->b_ml.ml_line_count)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005781 size -= ffdos + 1;
5782 }
5783
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 return size;
5785}
5786
5787/*
5788 * Goto byte in buffer with offset 'cnt'.
5789 */
5790 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005791goto_byte(long cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792{
5793 long boff = cnt;
5794 linenr_T lnum;
5795
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005796 ml_flush_line(curbuf); // cached line may be dirty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797 setpcmark();
5798 if (boff)
5799 --boff;
5800 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005801 if (lnum < 1) // past the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 {
5803 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
5804 curwin->w_curswant = MAXCOL;
5805 coladvance((colnr_T)MAXCOL);
5806 }
5807 else
5808 {
5809 curwin->w_cursor.lnum = lnum;
5810 curwin->w_cursor.col = (colnr_T)boff;
Bram Moolenaar943d2b52005-12-02 00:50:49 +00005811 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 curwin->w_set_curswant = TRUE;
5813 }
5814 check_cursor();
5815
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005816 // Make sure the cursor is on the first byte of a multi-byte char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 if (has_mbyte)
5818 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819}
5820#endif