blob: 391121320b0e89398210cb5657ba3ee6bc9cb7ce [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
Christian Brabandtf573c6e2021-06-20 14:02:16 +020067#define BLOCK0_ID1_C3 'S' // block 0 id 1 'cm' 3 - but not actually used
Bram Moolenaar8f4ac012014-08-10 13:38:34 +020068
69#if defined(FEAT_CRYPT)
70static int id1_codes[] = {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010071 BLOCK0_ID1_C0, // CRYPT_M_ZIP
72 BLOCK0_ID1_C1, // CRYPT_M_BF
73 BLOCK0_ID1_C2, // CRYPT_M_BF2
Christian Brabandtf573c6e2021-06-20 14:02:16 +020074 BLOCK0_ID1_C3, // CRYPT_M_SOD - Unused!
Bram Moolenaar8f4ac012014-08-10 13:38:34 +020075};
76#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000077
78/*
79 * pointer to a block, used in a pointer block
80 */
81struct pointer_entry
82{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010083 blocknr_T pe_bnum; // block number
84 linenr_T pe_line_count; // number of lines in this branch
85 linenr_T pe_old_lnum; // lnum for this block (for recovery)
86 int pe_page_count; // number of pages in block pe_bnum
Bram Moolenaar071d4272004-06-13 20:20:40 +000087};
88
89/*
90 * A pointer block contains a list of branches in the tree.
91 */
92struct pointer_block
93{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010094 short_u pb_id; // ID for pointer block: PTR_ID
95 short_u pb_count; // number of pointers in this block
96 short_u pb_count_max; // maximum value for pb_count
97 PTR_EN pb_pointer[1]; // list of pointers to blocks (actually longer)
98 // followed by empty space until end of page
Bram Moolenaar071d4272004-06-13 20:20:40 +000099};
100
101/*
102 * A data block is a leaf in the tree.
103 *
104 * The text of the lines is at the end of the block. The text of the first line
105 * in the block is put at the end, the text of the second line in front of it,
106 * etc. Thus the order of the lines is the opposite of the line number.
107 */
108struct data_block
109{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100110 short_u db_id; // ID for data block: DATA_ID
111 unsigned db_free; // free space available
112 unsigned db_txt_start; // byte where text starts
113 unsigned db_txt_end; // byte just after data block
114 linenr_T db_line_count; // number of lines in this block
115 unsigned db_index[1]; // index for start of line (actually bigger)
Bram Moolenaar4b96df52020-01-26 22:00:26 +0100116 // followed by empty space up to db_txt_start
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100117 // followed by the text in the lines until
118 // end of page
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119};
120
121/*
122 * The low bits of db_index hold the actual index. The topmost bit is
123 * used for the global command to be able to mark a line.
124 * This method is not clean, but otherwise there would be at least one extra
125 * byte used for each line.
126 * The mark has to be in this place to keep it with the correct line when other
127 * lines are inserted or deleted.
128 */
129#define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
130#define DB_INDEX_MASK (~DB_MARKED)
131
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100132#define INDEX_SIZE (sizeof(unsigned)) // size of one db_index entry
133#define HEADER_SIZE (sizeof(DATA_BL) - INDEX_SIZE) // size of data block header
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100135#define B0_FNAME_SIZE_ORG 900 // what it was in older versions
136#define B0_FNAME_SIZE_NOCRYPT 898 // 2 bytes used for other things
137#define B0_FNAME_SIZE_CRYPT 890 // 10 bytes used for other things
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000138#define B0_UNAME_SIZE 40
139#define B0_HNAME_SIZE 40
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140/*
141 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
142 * This won't detect a 64 bit machine that only swaps a byte in the top 32
143 * bits, but that is crazy anyway.
144 */
145#define B0_MAGIC_LONG 0x30313233L
146#define B0_MAGIC_INT 0x20212223L
147#define B0_MAGIC_SHORT 0x10111213L
148#define B0_MAGIC_CHAR 0x55
149
150/*
151 * Block zero holds all info about the swap file.
152 *
153 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
154 * swap files unusable!
155 *
156 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
157 *
Bram Moolenaarbae0c162007-05-10 19:30:25 +0000158 * This block is built up of single bytes, to make it portable across
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 * different machines. b0_magic_* is used to check the byte order and size of
160 * variables, because the rest of the swap file is not portable.
161 */
162struct block0
163{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100164 char_u b0_id[2]; // id for block 0: BLOCK0_ID0 and BLOCK0_ID1,
165 // BLOCK0_ID1_C0, BLOCK0_ID1_C1, etc.
166 char_u b0_version[10]; // Vim version string
167 char_u b0_page_size[4];// number of bytes per page
168 char_u b0_mtime[4]; // last modification time of file
169 char_u b0_ino[4]; // inode of b0_fname
170 char_u b0_pid[4]; // process id of creator (or 0)
171 char_u b0_uname[B0_UNAME_SIZE]; // name of user (uid if no name)
172 char_u b0_hname[B0_HNAME_SIZE]; // host name (if it has a name)
173 char_u b0_fname[B0_FNAME_SIZE_ORG]; // name of file being edited
174 long b0_magic_long; // check for byte order of long
175 int b0_magic_int; // check for byte order of int
176 short b0_magic_short; // check for byte order of short
177 char_u b0_magic_char; // check for last char
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178};
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000179
180/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000181 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000182 * long file names in older versions of Vim they are invalid.
183 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
184 * when there is room, for very long file names it's omitted.
185 */
186#define B0_DIRTY 0x55
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200187#define b0_dirty b0_fname[B0_FNAME_SIZE_ORG - 1]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000188
189/*
190 * The b0_flags field is new in Vim 7.0.
191 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200192#define b0_flags b0_fname[B0_FNAME_SIZE_ORG - 2]
193
194/*
195 * Crypt seed goes here, 8 bytes. New in Vim 7.3.
196 * Without encryption these bytes may be used for 'fenc'.
197 */
198#define b0_seed b0_fname[B0_FNAME_SIZE_ORG - 2 - MF_SEED_LEN]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000199
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100200// The lowest two bits contain the fileformat. Zero means it's not set
201// (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
202// EOL_MAC + 1.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000203#define B0_FF_MASK 3
204
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100205// Swap file is in directory of edited file. Used to find the file from
206// different mount points.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000207#define B0_SAME_DIR 4
208
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100209// The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
210// When empty there is only the NUL.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000211#define B0_HAS_FENC 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100213#define STACK_INCR 5 // nr of entries added to ml_stack at a time
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214
215/*
216 * The line number where the first mark may be is remembered.
217 * If it is 0 there are no marks at all.
218 * (always used for the current buffer only, no buffer change possible while
219 * executing a global command).
220 */
221static linenr_T lowest_marked = 0;
222
223/*
224 * arguments for ml_find_line()
225 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100226#define ML_DELETE 0x11 // delete line
227#define ML_INSERT 0x12 // insert line
228#define ML_FIND 0x13 // just find the line
229#define ML_FLUSH 0x02 // flush locked block
kylo252ae6f1d82022-02-16 19:24:07 +0000230#define ML_SIMPLE(x) ((x) & 0x10) // DEL, INS or FIND
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100232// argument for ml_upd_block0()
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200233typedef enum {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100234 UB_FNAME = 0 // update timestamp and filename
235 , UB_SAME_DIR // update the B0_SAME_DIR flag
236 , UB_CRYPT // update crypt key
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200237} upd_block0_T;
238
239#ifdef FEAT_CRYPT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100240static void ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200241#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100242static void ml_upd_block0(buf_T *buf, upd_block0_T what);
243static void set_b0_fname(ZERO_BL *, buf_T *buf);
244static void set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100245static void add_b0_fenc(ZERO_BL *b0p, buf_T *buf);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100246static time_t swapfile_info(char_u *);
247static int recov_file_names(char_u **, char_u *, int prepend_dot);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100248static char_u *findswapname(buf_T *, char_u **, char_u *);
249static void ml_flush_line(buf_T *);
250static bhdr_T *ml_new_data(memfile_T *, int, int);
251static bhdr_T *ml_new_ptr(memfile_T *);
252static bhdr_T *ml_find_line(buf_T *, linenr_T, int);
253static int ml_add_stack(buf_T *);
254static void ml_lineadd(buf_T *, int);
255static int b0_magic_wrong(ZERO_BL *);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256#ifdef CHECK_INODE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100257static int fnamecmp_ino(char_u *, char_u *, long);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100259static void long_to_char(long, char_u *);
260static long char_to_long(char_u *);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200261#ifdef FEAT_CRYPT
Bram Moolenaar8767f522016-07-01 17:17:39 +0200262static cryptstate_T *ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200263#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264#ifdef FEAT_BYTEOFF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100265static void ml_updatechunk(buf_T *buf, long line, long len, int updtype);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266#endif
267
268/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000269 * Open a new memline for "buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 *
Bram Moolenaar4770d092006-01-12 23:22:24 +0000271 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 */
273 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100274ml_open(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275{
276 memfile_T *mfp;
277 bhdr_T *hp = NULL;
278 ZERO_BL *b0p;
279 PTR_BL *pp;
280 DATA_BL *dp;
281
Bram Moolenaar4770d092006-01-12 23:22:24 +0000282 /*
283 * init fields in memline struct
284 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100285 buf->b_ml.ml_stack_size = 0; // no stack yet
286 buf->b_ml.ml_stack = NULL; // no stack yet
287 buf->b_ml.ml_stack_top = 0; // nothing in the stack
288 buf->b_ml.ml_locked = NULL; // no cached block
289 buf->b_ml.ml_line_lnum = 0; // no cached line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000290#ifdef FEAT_BYTEOFF
Bram Moolenaar4770d092006-01-12 23:22:24 +0000291 buf->b_ml.ml_chunksize = NULL;
Bram Moolenaardf9070e2021-08-25 17:31:37 +0200292 buf->b_ml.ml_usedchunks = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293#endif
294
Bram Moolenaare1004402020-10-24 20:49:43 +0200295 if (cmdmod.cmod_flags & CMOD_NOSWAPFILE)
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100296 buf->b_p_swf = FALSE;
297
Bram Moolenaar4770d092006-01-12 23:22:24 +0000298 /*
299 * When 'updatecount' is non-zero swap file may be opened later.
300 */
301 if (p_uc && buf->b_p_swf)
302 buf->b_may_swap = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 else
Bram Moolenaar4770d092006-01-12 23:22:24 +0000304 buf->b_may_swap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305
Bram Moolenaar4770d092006-01-12 23:22:24 +0000306 /*
307 * Open the memfile. No swap file is created yet.
308 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 mfp = mf_open(NULL, 0);
310 if (mfp == NULL)
311 goto error;
312
Bram Moolenaar4770d092006-01-12 23:22:24 +0000313 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200314#ifdef FEAT_CRYPT
315 mfp->mf_buffer = buf;
316#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000317 buf->b_ml.ml_flags = ML_EMPTY;
318 buf->b_ml.ml_line_count = 1;
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000319#ifdef FEAT_LINEBREAK
320 curwin->w_nrwidth_line_count = 0;
321#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323/*
324 * fill block0 struct and write page 0
325 */
326 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
327 goto error;
328 if (hp->bh_bnum != 0)
329 {
Bram Moolenaar9a846fb2022-01-01 21:59:18 +0000330 iemsg(_(e_didnt_get_block_nr_zero));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331 goto error;
332 }
333 b0p = (ZERO_BL *)(hp->bh_data);
334
335 b0p->b0_id[0] = BLOCK0_ID0;
336 b0p->b0_id[1] = BLOCK0_ID1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
338 b0p->b0_magic_int = (int)B0_MAGIC_INT;
339 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
340 b0p->b0_magic_char = B0_MAGIC_CHAR;
Bram Moolenaar22c10562018-05-26 17:35:27 +0200341 mch_memmove(b0p->b0_version, "VIM ", 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342 STRNCPY(b0p->b0_version + 4, Version, 6);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000343 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000344
Bram Moolenaar76b92b22006-03-24 22:46:53 +0000345#ifdef FEAT_SPELL
346 if (!buf->b_spell)
347#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000348 {
349 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
350 b0p->b0_flags = get_fileformat(buf) + 1;
351 set_b0_fname(b0p, buf);
352 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
353 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
354 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
355 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
356 long_to_char(mch_get_pid(), b0p->b0_pid);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200357#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200358 ml_set_b0_crypt(buf, b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200359#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000360 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361
362 /*
363 * Always sync block number 0 to disk, so we can check the file name in
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200364 * the swap file in findswapname(). Don't do this for a help files or
365 * a spell buffer though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 * Only works when there's a swapfile, otherwise it's done when the file
367 * is created.
368 */
369 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000370 if (!buf->b_help && !B_SPELL(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371 (void)mf_sync(mfp, 0);
372
Bram Moolenaar4770d092006-01-12 23:22:24 +0000373 /*
374 * Fill in root pointer block and write page 1.
375 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 if ((hp = ml_new_ptr(mfp)) == NULL)
377 goto error;
378 if (hp->bh_bnum != 1)
379 {
Bram Moolenaar9a846fb2022-01-01 21:59:18 +0000380 iemsg(_(e_didnt_get_block_nr_one));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381 goto error;
382 }
383 pp = (PTR_BL *)(hp->bh_data);
384 pp->pb_count = 1;
385 pp->pb_pointer[0].pe_bnum = 2;
386 pp->pb_pointer[0].pe_page_count = 1;
387 pp->pb_pointer[0].pe_old_lnum = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100388 pp->pb_pointer[0].pe_line_count = 1; // line count after insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389 mf_put(mfp, hp, TRUE, FALSE);
390
Bram Moolenaar4770d092006-01-12 23:22:24 +0000391 /*
392 * Allocate first data block and create an empty line 1.
393 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
395 goto error;
396 if (hp->bh_bnum != 2)
397 {
Bram Moolenaar9a846fb2022-01-01 21:59:18 +0000398 iemsg(_(e_didnt_get_block_nr_two));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399 goto error;
400 }
401
402 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100403 dp->db_index[0] = --dp->db_txt_start; // at end of block
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404 dp->db_free -= 1 + INDEX_SIZE;
405 dp->db_line_count = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100406 *((char_u *)dp + dp->db_txt_start) = NUL; // empty line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408 return OK;
409
410error:
411 if (mfp != NULL)
412 {
413 if (hp)
414 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100415 mf_close(mfp, TRUE); // will also free(mfp->mf_fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 }
Bram Moolenaar4770d092006-01-12 23:22:24 +0000417 buf->b_ml.ml_mfp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418 return FAIL;
419}
420
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200421#if defined(FEAT_CRYPT) || defined(PROTO)
422/*
Bram Moolenaar2be79502014-08-13 21:58:28 +0200423 * Prepare encryption for "buf" for the current key and method.
424 */
425 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100426ml_set_mfp_crypt(buf_T *buf)
Bram Moolenaar2be79502014-08-13 21:58:28 +0200427{
428 if (*buf->b_p_key != NUL)
429 {
430 int method_nr = crypt_get_method_nr(buf);
431
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200432 if (method_nr > CRYPT_M_ZIP && method_nr < CRYPT_M_SOD)
Bram Moolenaar2be79502014-08-13 21:58:28 +0200433 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100434 // Generate a seed and store it in the memfile.
Bram Moolenaar2be79502014-08-13 21:58:28 +0200435 sha2_seed(buf->b_ml.ml_mfp->mf_seed, MF_SEED_LEN, NULL, 0);
436 }
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200437#ifdef FEAT_SODIUM
438 else if (method_nr == CRYPT_M_SOD)
K.Takata1a8825d2022-01-19 13:32:57 +0000439 crypt_sodium_randombytes_buf(buf->b_ml.ml_mfp->mf_seed,
440 MF_SEED_LEN);
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200441 #endif
Bram Moolenaar2be79502014-08-13 21:58:28 +0200442 }
443}
444
445/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200446 * Prepare encryption for "buf" with block 0 "b0p".
447 */
448 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100449ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200450{
451 if (*buf->b_p_key == NUL)
452 b0p->b0_id[1] = BLOCK0_ID1;
453 else
454 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200455 int method_nr = crypt_get_method_nr(buf);
456
457 b0p->b0_id[1] = id1_codes[method_nr];
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200458 if (method_nr > CRYPT_M_ZIP && method_nr < CRYPT_M_SOD)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200459 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100460 // Generate a seed and store it in block 0 and in the memfile.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200461 sha2_seed(&b0p->b0_seed, MF_SEED_LEN, NULL, 0);
462 mch_memmove(buf->b_ml.ml_mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
463 }
464 }
465}
466
467/*
468 * Called after the crypt key or 'cryptmethod' was changed for "buf".
469 * Will apply this to the swapfile.
470 * "old_key" is the previous key. It is equal to buf->b_p_key when
471 * 'cryptmethod' is changed.
Bram Moolenaar49771f42010-07-20 17:32:38 +0200472 * "old_cm" is the previous 'cryptmethod'. It is equal to the current
473 * 'cryptmethod' when 'key' is changed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200474 */
475 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100476ml_set_crypt_key(
477 buf_T *buf,
478 char_u *old_key,
479 char_u *old_cm)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200480{
481 memfile_T *mfp = buf->b_ml.ml_mfp;
482 bhdr_T *hp;
483 int page_count;
484 int idx;
485 long error;
486 infoptr_T *ip;
487 PTR_BL *pp;
488 DATA_BL *dp;
489 blocknr_T bnum;
490 int top;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200491 int old_method;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200492
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200493 if (mfp == NULL || mfp->mf_fd < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100494 return; // no memfile yet, nothing to do
Bram Moolenaarbc563362015-06-09 18:35:25 +0200495 old_method = crypt_method_nr_from_name(old_cm);
496
Christian Brabandt226b28b2021-06-21 21:08:08 +0200497 // Swapfile encryption not supported by XChaCha20
498 if (crypt_get_method_nr(buf) == CRYPT_M_SOD && *buf->b_p_key != NUL)
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200499 {
500 // close the swapfile
501 mf_close_file(buf, TRUE);
502 buf->b_p_swf = FALSE;
503 return;
504 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100505 // First make sure the swapfile is in a consistent state, using the old
506 // key and method.
Bram Moolenaarbc563362015-06-09 18:35:25 +0200507 {
508 char_u *new_key = buf->b_p_key;
509 char_u *new_buf_cm = buf->b_p_cm;
510
511 buf->b_p_key = old_key;
512 buf->b_p_cm = old_cm;
513 ml_preserve(buf, FALSE);
514 buf->b_p_key = new_key;
515 buf->b_p_cm = new_buf_cm;
516 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200517
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100518 // Set the key, method and seed to be used for reading, these must be the
519 // old values.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200520 mfp->mf_old_key = old_key;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200521 mfp->mf_old_cm = old_method;
522 if (old_method > 0 && *old_key != NUL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200523 mch_memmove(mfp->mf_old_seed, mfp->mf_seed, MF_SEED_LEN);
524
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100525 // Update block 0 with the crypt flag and may set a new seed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200526 ml_upd_block0(buf, UB_CRYPT);
527
528 if (mfp->mf_infile_count > 2)
529 {
530 /*
531 * Need to read back all data blocks from disk, decrypt them with the
532 * old key/method and mark them to be written. The algorithm is
533 * similar to what happens in ml_recover(), but we skip negative block
534 * numbers.
535 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100536 ml_flush_line(buf); // flush buffered line
537 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200538
539 hp = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100540 bnum = 1; // start with block 1
541 page_count = 1; // which is 1 page
542 idx = 0; // start with first index in block 1
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200543 error = 0;
544 buf->b_ml.ml_stack_top = 0;
Bram Moolenaard23a8232018-02-10 18:45:26 +0100545 VIM_CLEAR(buf->b_ml.ml_stack);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100546 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200547
548 for ( ; !got_int; line_breakcheck())
549 {
550 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100551 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200552
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100553 // get the block (pointer or data)
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +0000554 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200555 {
556 if (bnum == 1)
557 break;
558 ++error;
559 }
560 else
561 {
562 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100563 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200564 {
565 if (pp->pb_count == 0)
566 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100567 // empty block?
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200568 ++error;
569 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100570 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200571 {
572 if (pp->pb_pointer[idx].pe_bnum < 0)
573 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100574 // Skip data block with negative block number.
575 // Should not happen, because of the ml_preserve()
576 // above. Get same block again for next index.
Bram Moolenaar4b7214e2019-01-03 21:55:32 +0100577 ++idx;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200578 continue;
579 }
580
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100581 // going one block deeper in the tree, new entry in
582 // stack
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200583 if ((top = ml_add_stack(buf)) < 0)
584 {
585 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100586 break; // out of memory
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200587 }
588 ip = &(buf->b_ml.ml_stack[top]);
589 ip->ip_bnum = bnum;
590 ip->ip_index = idx;
591
592 bnum = pp->pb_pointer[idx].pe_bnum;
593 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200594 idx = 0;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200595 continue;
596 }
597 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100598 else // not a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200599 {
600 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100601 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200602 ++error;
603 else
604 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100605 // It is a data block, need to write it back to disk.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200606 mf_put(mfp, hp, TRUE, FALSE);
607 hp = NULL;
608 }
609 }
610 }
611
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100612 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200613 break;
614
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100615 // go one block up in the tree
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200616 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
617 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100618 idx = ip->ip_index + 1; // go to next index
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200619 page_count = 1;
620 }
Bram Moolenaarbc563362015-06-09 18:35:25 +0200621 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100622 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +0100623
624 if (error > 0)
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000625 emsg(_(e_error_while_updating_swap_file_crypt));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200626 }
627
628 mfp->mf_old_key = NULL;
629}
630#endif
631
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632/*
633 * ml_setname() is called when the file name of "buf" has been changed.
634 * It may rename the swap file.
635 */
636 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100637ml_setname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638{
639 int success = FALSE;
640 memfile_T *mfp;
641 char_u *fname;
642 char_u *dirp;
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100643#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644 char_u *p;
645#endif
646
647 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100648 if (mfp->mf_fd < 0) // there is no swap file yet
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 {
650 /*
651 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
652 * For help files we will make a swap file now.
653 */
Bram Moolenaare1004402020-10-24 20:49:43 +0200654 if (p_uc != 0 && (cmdmod.cmod_flags & CMOD_NOSWAPFILE) == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100655 ml_open_file(buf); // create a swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 return;
657 }
658
659 /*
660 * Try all directories in the 'directory' option.
661 */
662 dirp = p_dir;
663 for (;;)
664 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100665 if (*dirp == NUL) // tried all directories, fail
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 break;
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000667 fname = findswapname(buf, &dirp, mfp->mf_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100668 // alloc's fname
669 if (dirp == NULL) // out of memory
Bram Moolenaarf541c362011-10-26 11:44:18 +0200670 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100671 if (fname == NULL) // no file name found for this dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 continue;
673
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100674#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 /*
676 * Set full pathname for swap file now, because a ":!cd dir" may
677 * change directory without us knowing it.
678 */
679 p = FullName_save(fname, FALSE);
680 vim_free(fname);
681 fname = p;
682 if (fname == NULL)
683 continue;
684#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100685 // if the file name is the same we don't have to do anything
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 if (fnamecmp(fname, mfp->mf_fname) == 0)
687 {
688 vim_free(fname);
689 success = TRUE;
690 break;
691 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100692 // need to close the swap file before renaming
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 if (mfp->mf_fd >= 0)
694 {
695 close(mfp->mf_fd);
696 mfp->mf_fd = -1;
697 }
698
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100699 // try to rename the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 if (vim_rename(mfp->mf_fname, fname) == 0)
701 {
702 success = TRUE;
703 vim_free(mfp->mf_fname);
704 mfp->mf_fname = fname;
705 vim_free(mfp->mf_ffname);
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100706#if defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100707 mfp->mf_ffname = NULL; // mf_fname is full pathname already
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708#else
709 mf_set_ffname(mfp);
710#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200711 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 break;
713 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100714 vim_free(fname); // this fname didn't work, try another
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 }
716
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100717 if (mfp->mf_fd == -1) // need to (re)open the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 {
719 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
720 if (mfp->mf_fd < 0)
721 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100722 // could not (re)open the swap file, what can we do????
Bram Moolenaareaaac012022-01-02 17:00:40 +0000723 emsg(_(e_oops_lost_the_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724 return;
725 }
Bram Moolenaarf05da212009-11-17 16:13:15 +0000726#ifdef HAVE_FD_CLOEXEC
727 {
728 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
729 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarfbc4b4d2016-02-07 15:14:01 +0100730 (void)fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaarf05da212009-11-17 16:13:15 +0000731 }
732#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 }
734 if (!success)
Bram Moolenaareaaac012022-01-02 17:00:40 +0000735 emsg(_(e_could_not_rename_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736}
737
738/*
739 * Open a file for the memfile for all buffers that are not readonly or have
740 * been modified.
741 * Used when 'updatecount' changes from zero to non-zero.
742 */
743 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100744ml_open_files(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745{
746 buf_T *buf;
747
Bram Moolenaar29323592016-07-24 22:04:11 +0200748 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 if (!buf->b_p_ro || buf->b_changed)
750 ml_open_file(buf);
751}
752
753/*
754 * Open a swap file for an existing memfile, if there is no swap file yet.
755 * If we are unable to find a file name, mf_fname will be NULL
756 * and the memfile will be in memory only (no recovery possible).
757 */
758 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100759ml_open_file(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760{
761 memfile_T *mfp;
762 char_u *fname;
763 char_u *dirp;
764
765 mfp = buf->b_ml.ml_mfp;
Bram Moolenaare1004402020-10-24 20:49:43 +0200766 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf
767 || (cmdmod.cmod_flags & CMOD_NOSWAPFILE))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100768 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769
Bram Moolenaara1956f62006-03-12 22:18:00 +0000770#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100771 // For a spell buffer use a temp file name.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000772 if (buf->b_spell)
773 {
Bram Moolenaare5c421c2015-03-31 13:33:08 +0200774 fname = vim_tempname('s', FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000775 if (fname != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100776 (void)mf_open_file(mfp, fname); // consumes fname!
Bram Moolenaar4770d092006-01-12 23:22:24 +0000777 buf->b_may_swap = FALSE;
778 return;
779 }
780#endif
781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 /*
783 * Try all directories in 'directory' option.
784 */
785 dirp = p_dir;
786 for (;;)
787 {
788 if (*dirp == NUL)
789 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100790 // There is a small chance that between choosing the swap file name
791 // and creating it, another Vim creates the file. In that case the
792 // creation will fail and we will use another directory.
793 fname = findswapname(buf, &dirp, NULL); // allocates fname
Bram Moolenaarf541c362011-10-26 11:44:18 +0200794 if (dirp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100795 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 if (fname == NULL)
797 continue;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100798 if (mf_open_file(mfp, fname) == OK) // consumes fname!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100800#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 /*
802 * set full pathname for swap file now, because a ":!cd dir" may
803 * change directory without us knowing it.
804 */
805 mf_fullname(mfp);
806#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200807 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000808
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100809 // Flush block zero, so others can read it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 if (mf_sync(mfp, MFS_ZERO) == OK)
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000811 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100812 // Mark all blocks that should be in the swapfile as dirty.
813 // Needed for when the 'swapfile' option was reset, so that
814 // the swap file was deleted, and then on again.
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000815 mf_set_dirty(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 break;
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000817 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100818 // Writing block 0 failed: close the file and try another dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 mf_close_file(buf, FALSE);
820 }
821 }
822
Bram Moolenaar00e192b2019-10-19 17:01:28 +0200823 if (*p_dir != NUL && mfp->mf_fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 {
Bram Moolenaar00e192b2019-10-19 17:01:28 +0200825 need_wait_return = TRUE; // call wait_return later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 ++no_wait_return;
Bram Moolenaareaaac012022-01-02 17:00:40 +0000827 (void)semsg(_(e_unable_to_open_swap_file_for_str_recovery_impossible),
Bram Moolenaare1704ba2012-10-03 18:25:00 +0200828 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 --no_wait_return;
830 }
831
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100832 // don't try to open a swap file again
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 buf->b_may_swap = FALSE;
834}
835
836/*
837 * If still need to create a swap file, and starting to edit a not-readonly
838 * file, or reading into an existing buffer, create a swap file now.
839 */
840 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100841check_need_swap(
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200842 int newfile) // reading file into new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843{
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200844 int old_msg_silent = msg_silent; // might be reset by an E325 message
845
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
847 ml_open_file(curbuf);
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200848 msg_silent = old_msg_silent;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849}
850
851/*
852 * Close memline for buffer 'buf'.
853 * If 'del_file' is TRUE, delete the swap file
854 */
855 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100856ml_close(buf_T *buf, int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100858 if (buf->b_ml.ml_mfp == NULL) // not open
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 return;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100860 mf_close(buf->b_ml.ml_mfp, del_file); // close the .swp file
Bram Moolenaarfa4873c2022-06-30 22:13:59 +0100861 if (buf->b_ml.ml_line_lnum != 0
862 && (buf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED)))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 vim_free(buf->b_ml.ml_line_ptr);
864 vim_free(buf->b_ml.ml_stack);
865#ifdef FEAT_BYTEOFF
Bram Moolenaard23a8232018-02-10 18:45:26 +0100866 VIM_CLEAR(buf->b_ml.ml_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867#endif
868 buf->b_ml.ml_mfp = NULL;
869
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100870 // Reset the "recovered" flag, give the ATTENTION prompt the next time
871 // this buffer is loaded.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 buf->b_flags &= ~BF_RECOVERED;
873}
874
875/*
876 * Close all existing memlines and memfiles.
877 * Only used when exiting.
878 * When 'del_file' is TRUE, delete the memfiles.
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000879 * But don't delete files that were ":preserve"d when we are POSIX compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 */
881 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100882ml_close_all(int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883{
884 buf_T *buf;
885
Bram Moolenaar29323592016-07-24 22:04:11 +0200886 FOR_ALL_BUFFERS(buf)
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000887 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
888 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100889#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100890 spell_delete_wordlist(); // delete the internal wordlist
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100891#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892#ifdef TEMPDIRNAMES
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100893 vim_deltempdir(); // delete created temp directory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894#endif
895}
896
897/*
898 * Close all memfiles for not modified buffers.
899 * Only use just before exiting!
900 */
901 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100902ml_close_notmod(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903{
904 buf_T *buf;
905
Bram Moolenaar29323592016-07-24 22:04:11 +0200906 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 if (!bufIsChanged(buf))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100908 ml_close(buf, TRUE); // close all not-modified buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909}
910
911/*
912 * Update the timestamp in the .swp file.
913 * Used when the file has been written.
914 */
915 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100916ml_timestamp(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917{
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200918 ml_upd_block0(buf, UB_FNAME);
919}
920
921/*
922 * Return FAIL when the ID of "b0p" is wrong.
923 */
924 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100925ml_check_b0_id(ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200926{
927 if (b0p->b0_id[0] != BLOCK0_ID0
928 || (b0p->b0_id[1] != BLOCK0_ID1
929 && b0p->b0_id[1] != BLOCK0_ID1_C0
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200930 && b0p->b0_id[1] != BLOCK0_ID1_C1
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200931 && b0p->b0_id[1] != BLOCK0_ID1_C2
932 && b0p->b0_id[1] != BLOCK0_ID1_C3)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200933 )
934 return FAIL;
935 return OK;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000936}
937
938/*
939 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
940 */
941 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100942ml_upd_block0(buf_T *buf, upd_block0_T what)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000943{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 memfile_T *mfp;
945 bhdr_T *hp;
946 ZERO_BL *b0p;
947
948 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200949 if (mfp == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200951 hp = mf_get(mfp, (blocknr_T)0, 1);
952 if (hp == NULL)
953 {
954#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100955 // Possibly update the seed in the memfile before there is a block0.
Bram Moolenaar2be79502014-08-13 21:58:28 +0200956 if (what == UB_CRYPT)
957 ml_set_mfp_crypt(buf);
958#endif
959 return;
960 }
961
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200963 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaareaaac012022-01-02 17:00:40 +0000964 iemsg(_(e_ml_upd_block0_didnt_get_block_zero));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000966 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200967 if (what == UB_FNAME)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000968 set_b0_fname(b0p, buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200969#ifdef FEAT_CRYPT
970 else if (what == UB_CRYPT)
971 ml_set_b0_crypt(buf, b0p);
972#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100973 else // what == UB_SAME_DIR
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000974 set_b0_dir_flag(b0p, buf);
975 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 mf_put(mfp, hp, TRUE, FALSE);
977}
978
979/*
980 * Write file name and timestamp into block 0 of a swap file.
981 * Also set buf->b_mtime.
982 * Don't use NameBuff[]!!!
983 */
984 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100985set_b0_fname(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986{
Bram Moolenaar8767f522016-07-01 17:17:39 +0200987 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988
989 if (buf->b_ffname == NULL)
990 b0p->b0_fname[0] = NUL;
991 else
992 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100993#if defined(MSWIN) || defined(AMIGA)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100994 // Systems that cannot translate "~user" back into a path: copy the
995 // file name unmodified. Do use slashes instead of backslashes for
996 // portability.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200997 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000998# ifdef BACKSLASH_IN_FILENAME
999 forward_slash(b0p->b0_fname);
1000# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001#else
1002 size_t flen, ulen;
1003 char_u uname[B0_UNAME_SIZE];
1004
1005 /*
1006 * For a file under the home directory of the current user, we try to
1007 * replace the home directory path with "~user". This helps when
1008 * editing the same file on different machines over a network.
1009 * First replace home dir path with "~/" with home_replace().
1010 * Then insert the user name to get "~user/".
1011 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001012 home_replace(NULL, buf->b_ffname, b0p->b0_fname,
1013 B0_FNAME_SIZE_CRYPT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014 if (b0p->b0_fname[0] == '~')
1015 {
1016 flen = STRLEN(b0p->b0_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001017 // If there is no user name or it is too long, don't use "~/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001019 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE_CRYPT - 1)
1020 vim_strncpy(b0p->b0_fname, buf->b_ffname,
1021 B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 else
1023 {
1024 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
1025 mch_memmove(b0p->b0_fname + 1, uname, ulen);
1026 }
1027 }
1028#endif
1029 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
1030 {
1031 long_to_char((long)st.st_mtime, b0p->b0_mtime);
1032#ifdef CHECK_INODE
1033 long_to_char((long)st.st_ino, b0p->b0_ino);
1034#endif
1035 buf_store_time(buf, &st, buf->b_ffname);
1036 buf->b_mtime_read = buf->b_mtime;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001037 buf->b_mtime_read_ns = buf->b_mtime_ns;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 }
1039 else
1040 {
1041 long_to_char(0L, b0p->b0_mtime);
1042#ifdef CHECK_INODE
1043 long_to_char(0L, b0p->b0_ino);
1044#endif
1045 buf->b_mtime = 0;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001046 buf->b_mtime_ns = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 buf->b_mtime_read = 0;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001048 buf->b_mtime_read_ns = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 buf->b_orig_size = 0;
1050 buf->b_orig_mode = 0;
1051 }
1052 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001053
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001054 // Also add the 'fileencoding' if there is room.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001055 add_b0_fenc(b0p, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056}
1057
1058/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001059 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
1060 * swapfile for "buf" are in the same directory.
1061 * This is fail safe: if we are not sure the directories are equal the flag is
1062 * not set.
1063 */
1064 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001065set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001066{
1067 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
1068 b0p->b0_flags |= B0_SAME_DIR;
1069 else
1070 b0p->b0_flags &= ~B0_SAME_DIR;
1071}
1072
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001073/*
1074 * When there is room, add the 'fileencoding' to block zero.
1075 */
1076 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001077add_b0_fenc(
1078 ZERO_BL *b0p,
1079 buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001080{
1081 int n;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001082 int size = B0_FNAME_SIZE_NOCRYPT;
1083
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001084#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001085 // Without encryption use the same offset as in Vim 7.2 to be compatible.
1086 // With encryption it's OK to move elsewhere, the swap file is not
1087 // compatible anyway.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001088 if (*buf->b_p_key != NUL)
1089 size = B0_FNAME_SIZE_CRYPT;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001090#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001091
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001092 n = (int)STRLEN(buf->b_p_fenc);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001093 if ((int)STRLEN(b0p->b0_fname) + n + 1 > size)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001094 b0p->b0_flags &= ~B0_HAS_FENC;
1095 else
1096 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001097 mch_memmove((char *)b0p->b0_fname + size - n,
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001098 (char *)buf->b_p_fenc, (size_t)n);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001099 *(b0p->b0_fname + size - n - 1) = NUL;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001100 b0p->b0_flags |= B0_HAS_FENC;
1101 }
1102}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001103
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001104#if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO_UPTIME)
1105# include <sys/sysinfo.h>
1106#endif
1107
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001108#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001109/*
1110 * Return TRUE if the process with number "b0p->b0_pid" is still running.
1111 * "swap_fname" is the name of the swap file, if it's from before a reboot then
1112 * the result is FALSE;
1113 */
1114 static int
1115swapfile_process_running(ZERO_BL *b0p, char_u *swap_fname UNUSED)
1116{
Bram Moolenaare2982d62021-10-06 11:27:21 +01001117#if defined(HAVE_SYSINFO) && defined(HAVE_SYSINFO_UPTIME)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001118 stat_T st;
1119 struct sysinfo sinfo;
1120
1121 // If the system rebooted after when the swap file was written then the
1122 // process can't be running now.
1123 if (mch_stat((char *)swap_fname, &st) != -1
1124 && sysinfo(&sinfo) == 0
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001125 && st.st_mtime < time(NULL) - (
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001126# ifdef FEAT_EVAL
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001127 override_sysinfo_uptime >= 0 ? override_sysinfo_uptime :
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001128# endif
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001129 sinfo.uptime))
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001130 return FALSE;
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001131# endif
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001132 return mch_process_running(char_to_long(b0p->b0_pid));
1133}
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001134#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001135
1136/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001137 * Try to recover curbuf from the .swp file.
Bram Moolenaar99499b12019-05-23 21:35:48 +02001138 * If "checkext" is TRUE, check the extension and detect whether it is
1139 * a swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 */
1141 void
Bram Moolenaar99499b12019-05-23 21:35:48 +02001142ml_recover(int checkext)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143{
1144 buf_T *buf = NULL;
1145 memfile_T *mfp = NULL;
1146 char_u *fname;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001147 char_u *fname_used = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 bhdr_T *hp = NULL;
1149 ZERO_BL *b0p;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001150 int b0_ff;
1151 char_u *b0_fenc = NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001152#ifdef FEAT_CRYPT
1153 int b0_cm = -1;
1154#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 PTR_BL *pp;
1156 DATA_BL *dp;
1157 infoptr_T *ip;
1158 blocknr_T bnum;
1159 int page_count;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001160 stat_T org_stat, swp_stat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 int len;
1162 int directly;
1163 linenr_T lnum;
1164 char_u *p;
1165 int i;
1166 long error;
1167 int cannot_open;
1168 linenr_T line_count;
1169 int has_error;
1170 int idx;
1171 int top;
1172 int txt_start;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001173 off_T size;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 int called_from_main;
1175 int serious_error = TRUE;
1176 long mtime;
1177 int attr;
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001178 int orig_file_status = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179
1180 recoverymode = TRUE;
1181 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001182 attr = HL_ATTR(HLF_E);
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001183
1184 /*
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001185 * 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 +00001186 * Otherwise a search is done to find the swap file(s).
1187 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 fname = curbuf->b_fname;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001189 if (fname == NULL) // When there is no file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 fname = (char_u *)"";
1191 len = (int)STRLEN(fname);
Bram Moolenaar99499b12019-05-23 21:35:48 +02001192 if (checkext && len >= 4 &&
Bram Moolenaare60acc12011-05-10 16:41:25 +02001193#if defined(VMS)
Bram Moolenaar79518e22017-02-17 16:31:35 +01001194 STRNICMP(fname + len - 4, "_s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195#else
Bram Moolenaar79518e22017-02-17 16:31:35 +01001196 STRNICMP(fname + len - 4, ".s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197#endif
Bram Moolenaar79518e22017-02-17 16:31:35 +01001198 == 0
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001199 && vim_strchr((char_u *)"abcdefghijklmnopqrstuvw",
1200 TOLOWER_ASC(fname[len - 2])) != NULL
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001201 && ASCII_ISALPHA(fname[len - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 {
1203 directly = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001204 fname_used = vim_strsave(fname); // make a copy for mf_open()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 }
1206 else
1207 {
1208 directly = FALSE;
1209
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001210 // count the number of matching swap files
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001211 len = recover_names(fname, FALSE, 0, NULL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001212 if (len == 0) // no swap files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001214 semsg(_(e_no_swap_file_found_for_str), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 goto theend;
1216 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001217 if (len == 1) // one swap file found, use it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 i = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001219 else // several swap files found, choose
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001221 // list the names of the swap files
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001222 (void)recover_names(fname, TRUE, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223 msg_putchar('\n');
Bram Moolenaar32526b32019-01-19 17:43:09 +01001224 msg_puts(_("Enter number of swap file to use (0 to quit): "));
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001225 i = get_number(FALSE, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 if (i < 1 || i > len)
1227 goto theend;
1228 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001229 // get the swap file name that will be used
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001230 (void)recover_names(fname, FALSE, i, &fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001232 if (fname_used == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001233 goto theend; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001235 // When called from main() still need to initialize storage structure
Bram Moolenaar4770d092006-01-12 23:22:24 +00001236 if (called_from_main && ml_open(curbuf) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 getout(1);
1238
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001239 /*
1240 * Allocate a buffer structure for the swap file that is used for recovery.
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001241 * Only the memline and crypt information in it are really used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001242 */
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001243 buf = ALLOC_ONE(buf_T);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 if (buf == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001247 /*
1248 * init fields in memline struct
1249 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001250 buf->b_ml.ml_stack_size = 0; // no stack yet
1251 buf->b_ml.ml_stack = NULL; // no stack yet
1252 buf->b_ml.ml_stack_top = 0; // nothing in the stack
1253 buf->b_ml.ml_line_lnum = 0; // no cached line
1254 buf->b_ml.ml_locked = NULL; // no locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 buf->b_ml.ml_flags = 0;
Bram Moolenaar0fe849a2010-07-25 15:11:11 +02001256#ifdef FEAT_CRYPT
1257 buf->b_p_key = empty_option;
1258 buf->b_p_cm = empty_option;
1259#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001261 /*
1262 * open the memfile from the old swap file
1263 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001264 p = vim_strsave(fname_used); // save "fname_used" for the message:
1265 // mf_open() will consume "fname_used"!
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001266 mfp = mf_open(fname_used, O_RDONLY);
1267 fname_used = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 if (mfp == NULL || mfp->mf_fd < 0)
1269 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001270 if (fname_used != NULL)
Bram Moolenaareaaac012022-01-02 17:00:40 +00001271 semsg(_(e_cannot_open_str), fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 goto theend;
1273 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001275#ifdef FEAT_CRYPT
1276 mfp->mf_buffer = buf;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001277#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278
1279 /*
1280 * The page size set in mf_open() might be different from the page size
1281 * used in the swap file, we must get it from block 0. But to read block
1282 * 0 we need a page size. Use the minimal size for block 0 here, it will
1283 * be set to the real value below.
1284 */
1285 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
1286
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001287 /*
1288 * try to read block 0
1289 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
1291 {
1292 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +01001293 msg_puts_attr(_("Unable to read block 0 from "), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001295 msg_puts_attr(_("\nMaybe no changes were made or Vim did not update the swap file."),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 attr | MSG_HIST);
1297 msg_end();
1298 goto theend;
1299 }
1300 b0p = (ZERO_BL *)(hp->bh_data);
1301 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
1302 {
1303 msg_start();
1304 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001305 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001307 msg_puts_attr(_("Use Vim version 3.0.\n"), MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 msg_end();
1309 goto theend;
1310 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001311 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001313 semsg(_(e_str_does_not_look_like_vim_swap_file), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 goto theend;
1315 }
1316 if (b0_magic_wrong(b0p))
1317 {
1318 msg_start();
1319 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001320#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001322 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 attr | MSG_HIST);
1324 else
1325#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001326 msg_puts_attr(_(" cannot be used on this computer.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001328 msg_puts_attr(_("The file was created on "), attr | MSG_HIST);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001329 // avoid going past the end of a corrupted hostname
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 b0p->b0_fname[0] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001331 msg_puts_attr((char *)b0p->b0_hname, attr | MSG_HIST);
1332 msg_puts_attr(_(",\nor the file has been damaged."), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 msg_end();
1334 goto theend;
1335 }
Bram Moolenaar1c536282007-04-26 15:21:56 +00001336
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001337#ifdef FEAT_CRYPT
K.Takataeeec2542021-06-02 13:28:16 +02001338 for (i = 0; i < (int)ARRAY_LENGTH(id1_codes); ++i)
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001339 if (id1_codes[i] == b0p->b0_id[1])
1340 b0_cm = i;
1341 if (b0_cm > 0)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001342 mch_memmove(mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001343 crypt_set_cm_option(buf, b0_cm < 0 ? 0 : b0_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001344#else
1345 if (b0p->b0_id[1] != BLOCK0_ID1)
1346 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00001347 semsg(_(e_str_is_encrypted_and_this_version_of_vim_does_not_support_encryption), mfp->mf_fname);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001348 goto theend;
1349 }
1350#endif
1351
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 /*
1353 * If we guessed the wrong page size, we have to recalculate the
1354 * highest block number in the file.
1355 */
1356 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1357 {
Bram Moolenaar1c536282007-04-26 15:21:56 +00001358 unsigned previous_page_size = mfp->mf_page_size;
1359
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
Bram Moolenaar1c536282007-04-26 15:21:56 +00001361 if (mfp->mf_page_size < previous_page_size)
1362 {
1363 msg_start();
1364 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001365 msg_puts_attr(_(" has been damaged (page size is smaller than minimum value).\n"),
Bram Moolenaar1c536282007-04-26 15:21:56 +00001366 attr | MSG_HIST);
1367 msg_end();
1368 goto theend;
1369 }
Bram Moolenaar8767f522016-07-01 17:17:39 +02001370 if ((size = vim_lseek(mfp->mf_fd, (off_T)0L, SEEK_END)) <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001371 mfp->mf_blocknr_max = 0; // no file or empty file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372 else
1373 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1374 mfp->mf_infile_count = mfp->mf_blocknr_max;
Bram Moolenaar1c536282007-04-26 15:21:56 +00001375
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001376 // need to reallocate the memory used to store the data
Bram Moolenaar1c536282007-04-26 15:21:56 +00001377 p = alloc(mfp->mf_page_size);
1378 if (p == NULL)
1379 goto theend;
1380 mch_memmove(p, hp->bh_data, previous_page_size);
1381 vim_free(hp->bh_data);
1382 hp->bh_data = p;
1383 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 }
1385
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001386 /*
1387 * If .swp file name given directly, use name from swap file for buffer.
1388 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 if (directly)
1390 {
1391 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1392 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1393 goto theend;
1394 }
1395
1396 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001397 smsg(_("Using swap file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398
1399 if (buf_spname(curbuf) != NULL)
Bram Moolenaare1704ba2012-10-03 18:25:00 +02001400 vim_strncpy(NameBuff, buf_spname(curbuf), MAXPATHL - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 else
1402 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001403 smsg(_("Original file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 msg_putchar('\n');
1405
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001406 /*
1407 * check date of swap file and original file
1408 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 mtime = char_to_long(b0p->b0_mtime);
1410 if (curbuf->b_ffname != NULL
1411 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1412 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1413 && org_stat.st_mtime > swp_stat.st_mtime)
1414 || org_stat.st_mtime != mtime))
Bram Moolenaareaaac012022-01-02 17:00:40 +00001415 emsg(_(e_warning_original_file_may_have_been_changed));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 out_flush();
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001417
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001418 // Get the 'fileformat' and 'fileencoding' from block zero.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001419 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1420 if (b0p->b0_flags & B0_HAS_FENC)
1421 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001422 int fnsize = B0_FNAME_SIZE_NOCRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001423
1424#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001425 // Use the same size as in add_b0_fenc().
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001426 if (b0p->b0_id[1] != BLOCK0_ID1)
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001427 fnsize = B0_FNAME_SIZE_CRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001428#endif
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001429 for (p = b0p->b0_fname + fnsize; p > b0p->b0_fname && p[-1] != NUL; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001430 ;
Bram Moolenaar71ccd032020-06-12 22:59:11 +02001431 b0_fenc = vim_strnsave(p, b0p->b0_fname + fnsize - p);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001432 }
1433
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001434 mf_put(mfp, hp, FALSE, FALSE); // release block 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 hp = NULL;
1436
1437 /*
1438 * Now that we are sure that the file is going to be recovered, clear the
1439 * contents of the current buffer.
1440 */
1441 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001442 ml_delete((linenr_T)1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443
1444 /*
1445 * Try reading the original file to obtain the values of 'fileformat',
1446 * 'fileencoding', etc. Ignore errors. The text itself is not used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001447 * When the file is encrypted the user is asked to enter the key.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 */
1449 if (curbuf->b_ffname != NULL)
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001450 orig_file_status = readfile(curbuf->b_ffname, NULL, (linenr_T)0,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001453#ifdef FEAT_CRYPT
1454 if (b0_cm >= 0)
1455 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001456 // Need to ask the user for the crypt key. If this fails we continue
1457 // without a key, will probably get garbage text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001458 if (*curbuf->b_p_key != NUL)
1459 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001460 smsg(_("Swap file is encrypted: \"%s\""), fname_used);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001461 msg_puts(_("\nIf you entered a new crypt key but did not write the text file,"));
1462 msg_puts(_("\nenter the new crypt key."));
1463 msg_puts(_("\nIf you wrote the text file after changing the crypt key press enter"));
1464 msg_puts(_("\nto use the same key for text file and swap file"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001465 }
1466 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001467 smsg(_(need_key_msg), fname_used);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001468 buf->b_p_key = crypt_get_key(FALSE, FALSE);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001469 if (buf->b_p_key == NULL)
1470 buf->b_p_key = curbuf->b_p_key;
1471 else if (*buf->b_p_key == NUL)
1472 {
1473 vim_free(buf->b_p_key);
1474 buf->b_p_key = curbuf->b_p_key;
1475 }
1476 if (buf->b_p_key == NULL)
1477 buf->b_p_key = empty_option;
1478 }
1479#endif
1480
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001481 // Use the 'fileformat' and 'fileencoding' as stored in the swap file.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001482 if (b0_ff != 0)
1483 set_fileformat(b0_ff - 1, OPT_LOCAL);
1484 if (b0_fenc != NULL)
1485 {
Bram Moolenaar31e5c602022-04-15 13:53:33 +01001486 set_option_value_give_err((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001487 vim_free(b0_fenc);
1488 }
Bram Moolenaarc024b462019-06-08 18:07:21 +02001489 unchanged(curbuf, TRUE, TRUE);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001490
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001491 bnum = 1; // start with block 1
1492 page_count = 1; // which is 1 page
1493 lnum = 0; // append after line 0 in curbuf
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 line_count = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001495 idx = 0; // start with first index in block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496 error = 0;
1497 buf->b_ml.ml_stack_top = 0;
1498 buf->b_ml.ml_stack = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001499 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500
1501 if (curbuf->b_ffname == NULL)
1502 cannot_open = TRUE;
1503 else
1504 cannot_open = FALSE;
1505
1506 serious_error = FALSE;
1507 for ( ; !got_int; line_breakcheck())
1508 {
1509 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001510 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511
1512 /*
1513 * get block
1514 */
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00001515 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 {
1517 if (bnum == 1)
1518 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001519 semsg(_(e_unable_to_read_block_one_from_str), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 goto theend;
1521 }
1522 ++error;
1523 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1524 (colnr_T)0, TRUE);
1525 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001526 else // there is a block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 {
1528 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001529 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001531 // check line count when using pointer block first time
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 if (idx == 0 && line_count != 0)
1533 {
1534 for (i = 0; i < (int)pp->pb_count; ++i)
1535 line_count -= pp->pb_pointer[i].pe_line_count;
1536 if (line_count != 0)
1537 {
1538 ++error;
1539 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1540 (colnr_T)0, TRUE);
1541 }
1542 }
1543
1544 if (pp->pb_count == 0)
1545 {
1546 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1547 (colnr_T)0, TRUE);
1548 ++error;
1549 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001550 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 {
1552 if (pp->pb_pointer[idx].pe_bnum < 0)
1553 {
1554 /*
1555 * Data block with negative block number.
1556 * Try to read lines from the original file.
1557 * This is slow, but it works.
1558 */
1559 if (!cannot_open)
1560 {
1561 line_count = pp->pb_pointer[idx].pe_line_count;
1562 if (readfile(curbuf->b_ffname, NULL, lnum,
1563 pp->pb_pointer[idx].pe_old_lnum - 1,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001564 line_count, NULL, 0) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 cannot_open = TRUE;
1566 else
1567 lnum += line_count;
1568 }
1569 if (cannot_open)
1570 {
1571 ++error;
1572 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1573 (colnr_T)0, TRUE);
1574 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001575 ++idx; // get same block again for next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 continue;
1577 }
1578
1579 /*
1580 * going one block deeper in the tree
1581 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001582 if ((top = ml_add_stack(buf)) < 0) // new entry in stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 {
1584 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001585 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 }
1587 ip = &(buf->b_ml.ml_stack[top]);
1588 ip->ip_bnum = bnum;
1589 ip->ip_index = idx;
1590
1591 bnum = pp->pb_pointer[idx].pe_bnum;
1592 line_count = pp->pb_pointer[idx].pe_line_count;
1593 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaar986a0032011-06-13 01:07:27 +02001594 idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 continue;
1596 }
1597 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001598 else // not a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 {
1600 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001601 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 {
1603 if (bnum == 1)
1604 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001605 semsg(_(e_block_one_id_wrong_str_not_swp_file),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 mfp->mf_fname);
1607 goto theend;
1608 }
1609 ++error;
1610 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1611 (colnr_T)0, TRUE);
1612 }
1613 else
1614 {
1615 /*
1616 * it is a data block
1617 * Append all the lines in this block
1618 */
1619 has_error = FALSE;
1620 /*
1621 * check length of block
1622 * if wrong, use length in pointer block
1623 */
1624 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1625 {
1626 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1627 (colnr_T)0, TRUE);
1628 ++error;
1629 has_error = TRUE;
1630 dp->db_txt_end = page_count * mfp->mf_page_size;
1631 }
1632
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001633 // make sure there is a NUL at the end of the block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1635
1636 /*
1637 * check number of lines in block
1638 * if wrong, use count in data block
1639 */
1640 if (line_count != dp->db_line_count)
1641 {
1642 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1643 (colnr_T)0, TRUE);
1644 ++error;
1645 has_error = TRUE;
1646 }
1647
1648 for (i = 0; i < dp->db_line_count; ++i)
1649 {
1650 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
Bram Moolenaar740885b2009-11-03 14:33:17 +00001651 if (txt_start <= (int)HEADER_SIZE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 || txt_start >= (int)dp->db_txt_end)
1653 {
1654 p = (char_u *)"???";
1655 ++error;
1656 }
1657 else
1658 p = (char_u *)dp + txt_start;
1659 ml_append(lnum++, p, (colnr_T)0, TRUE);
1660 }
1661 if (has_error)
Bram Moolenaar740885b2009-11-03 14:33:17 +00001662 ml_append(lnum++, (char_u *)_("???END"),
1663 (colnr_T)0, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 }
1665 }
1666 }
1667
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001668 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 break;
1670
1671 /*
1672 * go one block up in the tree
1673 */
1674 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1675 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001676 idx = ip->ip_index + 1; // go to next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 page_count = 1;
1678 }
1679
1680 /*
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001681 * Compare the buffer contents with the original file. When they differ
1682 * set the 'modified' flag.
1683 * Lines 1 - lnum are the new contents.
1684 * Lines lnum + 1 to ml_line_count are the original contents.
1685 * Line ml_line_count + 1 in the dummy empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 */
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001687 if (orig_file_status != OK || curbuf->b_ml.ml_line_count != lnum * 2 + 1)
1688 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001689 // Recovering an empty file results in two lines and the first line is
1690 // empty. Don't set the modified flag then.
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001691 if (!(curbuf->b_ml.ml_line_count == 2 && *ml_get(1) == NUL))
1692 {
Bram Moolenaarec28d152019-05-11 18:36:34 +02001693 changed_internal();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001694 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001695 }
1696 }
1697 else
1698 {
1699 for (idx = 1; idx <= lnum; ++idx)
1700 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001701 // Need to copy one line, fetching the other one may flush it.
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001702 p = vim_strsave(ml_get(idx));
1703 i = STRCMP(p, ml_get(idx + lnum));
1704 vim_free(p);
1705 if (i != 0)
1706 {
Bram Moolenaarec28d152019-05-11 18:36:34 +02001707 changed_internal();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001708 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001709 break;
1710 }
1711 }
1712 }
1713
1714 /*
1715 * Delete the lines from the original file and the dummy line from the
1716 * empty buffer. These will now be after the last line in the buffer.
1717 */
1718 while (curbuf->b_ml.ml_line_count > lnum
1719 && !(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001720 ml_delete(curbuf->b_ml.ml_line_count);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 curbuf->b_flags |= BF_RECOVERED;
Bram Moolenaare3f50ad2021-06-09 12:33:40 +02001722 check_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723
1724 recoverymode = FALSE;
1725 if (got_int)
Bram Moolenaareaaac012022-01-02 17:00:40 +00001726 emsg(_(e_recovery_interrupted));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 else if (error)
1728 {
1729 ++no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001730 msg(">>>>>>>>>>>>>");
Bram Moolenaareaaac012022-01-02 17:00:40 +00001731 emsg(_(e_errors_detected_while_recovering_look_for_lines_starting_with_questions));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 --no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001733 msg(_("See \":help E312\" for more information."));
1734 msg(">>>>>>>>>>>>>");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 }
1736 else
1737 {
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001738 if (curbuf->b_changed)
1739 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001740 msg(_("Recovery completed. You should check if everything is OK."));
1741 msg_puts(_("\n(You might want to write out this file under another name\n"));
1742 msg_puts(_("and run diff with the original file to check for changes)"));
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001743 }
1744 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001745 msg(_("Recovery completed. Buffer contents equals file contents."));
Bram Moolenaarf8835082020-11-09 21:04:17 +01001746 msg_puts(_("\nYou may want to delete the .swp file now."));
1747#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001748 if (swapfile_process_running(b0p, fname_used))
Bram Moolenaarf8835082020-11-09 21:04:17 +01001749 {
1750 // Warn there could be an active Vim on the same file, the user may
1751 // want to kill it.
1752 msg_puts(_("\nNote: process STILL RUNNING: "));
1753 msg_outnum(char_to_long(b0p->b0_pid));
1754 }
1755#endif
1756 msg_puts("\n\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 cmdline_row = msg_row;
1758 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001759#ifdef FEAT_CRYPT
1760 if (*buf->b_p_key != NUL && STRCMP(curbuf->b_p_key, buf->b_p_key) != 0)
1761 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001762 msg_puts(_("Using crypt key from swap file for the text file.\n"));
Bram Moolenaar31e5c602022-04-15 13:53:33 +01001763 set_option_value_give_err((char_u *)"key", 0L, buf->b_p_key, OPT_LOCAL);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001764 }
1765#endif
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001766 redraw_curbuf_later(UPD_NOT_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767
1768theend:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001769 vim_free(fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 recoverymode = FALSE;
1771 if (mfp != NULL)
1772 {
1773 if (hp != NULL)
1774 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001775 mf_close(mfp, FALSE); // will also vim_free(mfp->mf_fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 }
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001777 if (buf != NULL)
1778 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001779#ifdef FEAT_CRYPT
1780 if (buf->b_p_key != curbuf->b_p_key)
1781 free_string_option(buf->b_p_key);
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001782 free_string_option(buf->b_p_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001783#endif
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001784 vim_free(buf->b_ml.ml_stack);
1785 vim_free(buf);
1786 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 if (serious_error && called_from_main)
1788 ml_close(curbuf, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 else
1790 {
1791 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1792 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1793 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794}
1795
1796/*
1797 * Find the names of swap files in current directory and the directory given
1798 * with the 'directory' option.
1799 *
1800 * Used to:
1801 * - list the swap files for "vim -r"
1802 * - count the number of swap files when recovering
1803 * - list the swap files when recovering
1804 * - find the name of the n'th swap file when recovering
1805 */
1806 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001807recover_names(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001808 char_u *fname, // base for swap file name
1809 int list, // when TRUE, list the swap file names
1810 int nr, // when non-zero, return nr'th swap file name
1811 char_u **fname_out) // result when "nr" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812{
1813 int num_names;
1814 char_u *(names[6]);
1815 char_u *tail;
1816 char_u *p;
1817 int num_files;
1818 int file_count = 0;
1819 char_u **files;
1820 int i;
1821 char_u *dirp;
1822 char_u *dir_name;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001823 char_u *fname_res = NULL;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001824#ifdef HAVE_READLINK
1825 char_u fname_buf[MAXPATHL];
Bram Moolenaar64354da2010-05-25 21:37:17 +02001826#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001827
Bram Moolenaar64354da2010-05-25 21:37:17 +02001828 if (fname != NULL)
1829 {
1830#ifdef HAVE_READLINK
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001831 // Expand symlink in the file name, because the swap file is created
1832 // with the actual file instead of with the symlink.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001833 if (resolve_symlink(fname, fname_buf) == OK)
1834 fname_res = fname_buf;
1835 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001836#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001837 fname_res = fname;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001838 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
1840 if (list)
1841 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001842 // use msg() to start the scrolling properly
Bram Moolenaar32526b32019-01-19 17:43:09 +01001843 msg(_("Swap files found:"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 msg_putchar('\n');
1845 }
1846
1847 /*
1848 * Do the loop for every directory in 'directory'.
1849 * First allocate some memory to put the directory name in.
1850 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02001851 dir_name = alloc(STRLEN(p_dir) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 dirp = p_dir;
1853 while (dir_name != NULL && *dirp)
1854 {
1855 /*
1856 * Isolate a directory name from *dirp and put it in dir_name (we know
1857 * it is large enough, so use 31000 for length).
1858 * Advance dirp to next directory name.
1859 */
1860 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1861
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001862 if (dir_name[0] == '.' && dir_name[1] == NUL) // check current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001864 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 {
1866#ifdef VMS
1867 names[0] = vim_strsave((char_u *)"*_sw%");
1868#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 names[0] = vim_strsave((char_u *)"*.sw?");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001871#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001872 // For Unix names starting with a dot are special. MS-Windows
1873 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 names[1] = vim_strsave((char_u *)".*.sw?");
1875 names[2] = vim_strsave((char_u *)".sw?");
1876 num_names = 3;
1877#else
1878# ifdef VMS
1879 names[1] = vim_strsave((char_u *)".*_sw%");
1880 num_names = 2;
1881# else
1882 num_names = 1;
1883# endif
1884#endif
1885 }
1886 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001887 num_names = recov_file_names(names, fname_res, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001889 else // check directory dir_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001891 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 {
1893#ifdef VMS
1894 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1895#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001898#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001899 // For Unix names starting with a dot are special. MS-Windows
1900 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1902 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1903 num_names = 3;
1904#else
1905# ifdef VMS
1906 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1907 num_names = 2;
1908# else
1909 num_names = 1;
1910# endif
1911#endif
1912 }
1913 else
1914 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01001915#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01001916 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01001917
1918 p = dir_name + len;
1919 if (after_pathsep(dir_name, p) && len > 1 && p[-1] == p[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001921 // Ends with '//', Use Full path for swap name
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001922 tail = make_percent_swname(dir_name, fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 }
1924 else
1925#endif
1926 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001927 tail = gettail(fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 tail = concat_fnames(dir_name, tail, TRUE);
1929 }
1930 if (tail == NULL)
1931 num_names = 0;
1932 else
1933 {
1934 num_names = recov_file_names(names, tail, FALSE);
1935 vim_free(tail);
1936 }
1937 }
1938 }
1939
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02001940 // check for out-of-memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 for (i = 0; i < num_names; ++i)
1942 {
1943 if (names[i] == NULL)
1944 {
1945 for (i = 0; i < num_names; ++i)
1946 vim_free(names[i]);
1947 num_names = 0;
1948 }
1949 }
1950 if (num_names == 0)
1951 num_files = 0;
1952 else if (expand_wildcards(num_names, names, &num_files, &files,
Bram Moolenaar99499b12019-05-23 21:35:48 +02001953 EW_NOTENV|EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 num_files = 0;
1955
1956 /*
1957 * When no swap file found, wildcard expansion might have failed (e.g.
1958 * not able to execute the shell).
1959 * Try finding a swap file by simply adding ".swp" to the file name.
1960 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001961 if (*dirp == NUL && file_count + num_files == 0 && fname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 {
Bram Moolenaar8767f522016-07-01 17:17:39 +02001963 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 char_u *swapname;
1965
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001966 swapname = modname(fname_res,
Bram Moolenaare60acc12011-05-10 16:41:25 +02001967#if defined(VMS)
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001968 (char_u *)"_swp", FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969#else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001970 (char_u *)".swp", TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001972 );
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 if (swapname != NULL)
1974 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001975 if (mch_stat((char *)swapname, &st) != -1) // It exists!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001977 files = ALLOC_ONE(char_u *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 if (files != NULL)
1979 {
1980 files[0] = swapname;
1981 swapname = NULL;
1982 num_files = 1;
1983 }
1984 }
1985 vim_free(swapname);
1986 }
1987 }
1988
1989 /*
1990 * remove swapfile name of the current buffer, it must be ignored
1991 */
1992 if (curbuf->b_ml.ml_mfp != NULL
1993 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1994 {
1995 for (i = 0; i < num_files; ++i)
Bram Moolenaar99499b12019-05-23 21:35:48 +02001996 // Do not expand wildcards, on windows would try to expand
1997 // "%tmp%" in "%tmp%file".
1998 if (fullpathcmp(p, files[i], TRUE, FALSE) & FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 {
Bram Moolenaar99499b12019-05-23 21:35:48 +02002000 // Remove the name from files[i]. Move further entries
2001 // down. When the array becomes empty free it here, since
2002 // FreeWild() won't be called below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 vim_free(files[i]);
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00002004 if (--num_files == 0)
2005 vim_free(files);
2006 else
2007 for ( ; i < num_files; ++i)
2008 files[i] = files[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 }
2010 }
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002011 if (nr > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 {
2013 file_count += num_files;
2014 if (nr <= file_count)
2015 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002016 *fname_out = vim_strsave(
2017 files[nr - 1 + num_files - file_count]);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002018 dirp = (char_u *)""; // stop searching
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019 }
2020 }
2021 else if (list)
2022 {
2023 if (dir_name[0] == '.' && dir_name[1] == NUL)
2024 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002025 if (fname == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002026 msg_puts(_(" In current directory:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002028 msg_puts(_(" Using specified name:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 }
2030 else
2031 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002032 msg_puts(_(" In directory "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 msg_home_replace(dir_name);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002034 msg_puts(":\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 }
2036
2037 if (num_files)
2038 {
2039 for (i = 0; i < num_files; ++i)
2040 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002041 // print the swap file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 msg_outnum((long)++file_count);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002043 msg_puts(". ");
2044 msg_puts((char *)gettail(files[i]));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 msg_putchar('\n');
2046 (void)swapfile_info(files[i]);
2047 }
2048 }
2049 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002050 msg_puts(_(" -- none --\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 out_flush();
2052 }
2053 else
2054 file_count += num_files;
2055
2056 for (i = 0; i < num_names; ++i)
2057 vim_free(names[i]);
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002058 if (num_files > 0)
2059 FreeWild(num_files, files);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 }
2061 vim_free(dir_name);
2062 return file_count;
2063}
2064
Bram Moolenaar4f974752019-02-17 17:44:42 +01002065#if defined(UNIX) || defined(MSWIN) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066/*
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002067 * Need _very_ long file names.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 * Append the full path to name with path separators made into percent
Bram Moolenaar8b0e62c2021-10-19 22:12:25 +01002069 * signs, to "dir". An unnamed buffer is handled as "" (<currentdir>/"")
2070 * The last character in "dir" must be an extra slash or backslash, it is
2071 * removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 */
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002073 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002074make_percent_swname(char_u *dir, char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075{
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002076 char_u *d = NULL, *s, *f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002078 f = fix_fname(name != NULL ? name : (char_u *)"");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 if (f != NULL)
2080 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02002081 s = alloc(STRLEN(f) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 if (s != NULL)
2083 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002084 STRCPY(s, f);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002085 for (d = s; *d != NUL; MB_PTR_ADV(d))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002086 if (vim_ispathsep(*d))
2087 *d = '%';
Bram Moolenaar8b0e62c2021-10-19 22:12:25 +01002088
2089 dir[STRLEN(dir) - 1] = NUL; // remove one trailing slash
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 d = concat_fnames(dir, s, TRUE);
2091 vim_free(s);
2092 }
2093 vim_free(f);
2094 }
2095 return d;
2096}
2097#endif
2098
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002099#if (defined(UNIX) || defined(VMS) || defined(MSWIN)) \
2100 && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
2101# define HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102static int process_still_running;
2103#endif
2104
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002105#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106/*
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002107 * Return information found in swapfile "fname" in dictionary "d".
2108 * This is used by the swapinfo() function.
2109 */
2110 void
2111get_b0_dict(char_u *fname, dict_T *d)
2112{
2113 int fd;
2114 struct block0 b0;
2115
2116 if ((fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
2117 {
2118 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
2119 {
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002120 if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002121 dict_add_string(d, "error", (char_u *)"Not a swap file");
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002122 else if (b0_magic_wrong(&b0))
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002123 dict_add_string(d, "error", (char_u *)"Magic number mismatch");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002124 else
2125 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002126 // we have swap information
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002127 dict_add_string_len(d, "version", b0.b0_version, 10);
2128 dict_add_string_len(d, "user", b0.b0_uname, B0_UNAME_SIZE);
2129 dict_add_string_len(d, "host", b0.b0_hname, B0_HNAME_SIZE);
2130 dict_add_string_len(d, "fname", b0.b0_fname, B0_FNAME_SIZE_ORG);
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002131
2132 dict_add_number(d, "pid", char_to_long(b0.b0_pid));
2133 dict_add_number(d, "mtime", char_to_long(b0.b0_mtime));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002134 dict_add_number(d, "dirty", b0.b0_dirty ? 1 : 0);
2135# ifdef CHECK_INODE
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002136 dict_add_number(d, "inode", char_to_long(b0.b0_ino));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002137# endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002138 }
2139 }
2140 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002141 dict_add_string(d, "error", (char_u *)"Cannot read file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002142 close(fd);
2143 }
2144 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002145 dict_add_string(d, "error", (char_u *)"Cannot open file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002146}
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002147#endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002148
2149/*
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00002150 * Give information about an existing swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 * Returns timestamp (0 when unknown).
2152 */
2153 static time_t
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002154swapfile_info(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002156 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 int fd;
2158 struct block0 b0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159#ifdef UNIX
2160 char_u uname[B0_UNAME_SIZE];
2161#endif
2162
Bram Moolenaar63d25552019-05-10 21:28:38 +02002163 // print the swap file date
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 if (mch_stat((char *)fname, &st) != -1)
2165 {
2166#ifdef UNIX
Bram Moolenaar63d25552019-05-10 21:28:38 +02002167 // print name of owner of the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
2169 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002170 msg_puts(_(" owned by: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 msg_outtrans(uname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002172 msg_puts(_(" dated: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 }
2174 else
2175#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002176 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02002177 msg_puts(get_ctime(st.st_mtime, TRUE));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 }
Bram Moolenaar63d25552019-05-10 21:28:38 +02002179 else
2180 st.st_mtime = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181
2182 /*
2183 * print the original file name
2184 */
2185 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2186 if (fd >= 0)
2187 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01002188 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 {
2190 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
2191 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002192 msg_puts(_(" [from Vim version 3.0]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002194 else if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002196 msg_puts(_(" [does not look like a Vim swap file]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 }
2198 else
2199 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002200 msg_puts(_(" file name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 if (b0.b0_fname[0] == NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002202 msg_puts(_("[No Name]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 else
2204 msg_outtrans(b0.b0_fname);
2205
Bram Moolenaar32526b32019-01-19 17:43:09 +01002206 msg_puts(_("\n modified: "));
2207 msg_puts(b0.b0_dirty ? _("YES") : _("no"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208
2209 if (*(b0.b0_uname) != NUL)
2210 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002211 msg_puts(_("\n user name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 msg_outtrans(b0.b0_uname);
2213 }
2214
2215 if (*(b0.b0_hname) != NUL)
2216 {
2217 if (*(b0.b0_uname) != NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002218 msg_puts(_(" host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002220 msg_puts(_("\n host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 msg_outtrans(b0.b0_hname);
2222 }
2223
2224 if (char_to_long(b0.b0_pid) != 0L)
2225 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002226 msg_puts(_("\n process ID: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 msg_outnum(char_to_long(b0.b0_pid));
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002228#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01002229 if (swapfile_process_running(&b0, fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002231 msg_puts(_(" (STILL RUNNING)"));
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002232# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 process_still_running = TRUE;
2234# endif
2235 }
2236#endif
2237 }
2238
2239 if (b0_magic_wrong(&b0))
2240 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +01002241#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002243 msg_puts(_("\n [not usable with this version of Vim]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 else
2245#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002246 msg_puts(_("\n [not usable on this computer]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 }
2248 }
2249 }
2250 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002251 msg_puts(_(" [cannot be read]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 close(fd);
2253 }
2254 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002255 msg_puts(_(" [cannot be opened]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 msg_putchar('\n');
2257
Bram Moolenaar63d25552019-05-10 21:28:38 +02002258 return st.st_mtime;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259}
2260
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002261/*
2262 * Return TRUE if the swap file looks OK and there are no changes, thus it can
2263 * be safely deleted.
2264 */
zeertzjq3c5999e2022-03-23 13:54:51 +00002265 static int
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002266swapfile_unchanged(char_u *fname)
2267{
2268 stat_T st;
2269 int fd;
2270 struct block0 b0;
2271 int ret = TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002272
2273 // must be able to stat the swap file
2274 if (mch_stat((char *)fname, &st) == -1)
2275 return FALSE;
2276
2277 // must be able to read the first block
2278 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2279 if (fd < 0)
2280 return FALSE;
2281 if (read_eintr(fd, &b0, sizeof(b0)) != sizeof(b0))
2282 {
2283 close(fd);
2284 return FALSE;
2285 }
2286
2287 // the ID and magic number must be correct
2288 if (ml_check_b0_id(&b0) == FAIL|| b0_magic_wrong(&b0))
2289 ret = FALSE;
2290
2291 // must be unchanged
2292 if (b0.b0_dirty)
2293 ret = FALSE;
2294
2295#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf8835082020-11-09 21:04:17 +01002296 // Host name must be known and must equal the current host name, otherwise
2297 // comparing pid is meaningless.
2298 if (*(b0.b0_hname) == NUL)
2299 {
2300 ret = FALSE;
2301 }
2302 else
2303 {
2304 char_u hostname[B0_HNAME_SIZE];
2305
2306 mch_get_host_name(hostname, B0_HNAME_SIZE);
2307 hostname[B0_HNAME_SIZE - 1] = NUL;
Bram Moolenaare79cdb62020-11-21 13:51:16 +01002308 b0.b0_hname[B0_HNAME_SIZE - 1] = NUL; // in case of corruption
Bram Moolenaarf8835082020-11-09 21:04:17 +01002309 if (STRICMP(b0.b0_hname, hostname) != 0)
2310 ret = FALSE;
2311 }
2312
Bram Moolenaar32aa1022019-11-02 22:54:41 +01002313 // process must be known and not be running
Bram Moolenaarf52f0602021-03-10 21:26:37 +01002314 if (char_to_long(b0.b0_pid) == 0L || swapfile_process_running(&b0, fname))
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002315 ret = FALSE;
2316#endif
2317
Bram Moolenaarf8835082020-11-09 21:04:17 +01002318 // We do not check the user, it should be irrelevant for whether the swap
2319 // file is still useful.
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002320
2321 close(fd);
2322 return ret;
2323}
2324
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002326recov_file_names(char_u **names, char_u *path, int prepend_dot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327{
2328 int num_names;
2329
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 /*
2331 * (Win32 and Win64) never short names, but do prepend a dot.
2332 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
2333 * Only use the short name if it is different.
2334 */
2335 char_u *p;
2336 int i;
Bram Moolenaar4f974752019-02-17 17:44:42 +01002337# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 int shortname = curbuf->b_shortname;
2339
2340 curbuf->b_shortname = FALSE;
2341# endif
2342
2343 num_names = 0;
2344
2345 /*
2346 * May also add the file name with a dot prepended, for swap file in same
2347 * dir as original file.
2348 */
2349 if (prepend_dot)
2350 {
2351 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
2352 if (names[num_names] == NULL)
2353 goto end;
2354 ++num_names;
2355 }
2356
2357 /*
2358 * Form the normal swap file name pattern by appending ".sw?".
2359 */
2360#ifdef VMS
2361 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
2362#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364#endif
2365 if (names[num_names] == NULL)
2366 goto end;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002367 if (num_names >= 1) // check if we have the same name twice
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 {
2369 p = names[num_names - 1];
2370 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
2371 if (i > 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002372 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373
2374 if (STRCMP(p, names[num_names]) != 0)
2375 ++num_names;
2376 else
2377 vim_free(names[num_names]);
2378 }
2379 else
2380 ++num_names;
2381
Bram Moolenaar4f974752019-02-17 17:44:42 +01002382# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 /*
2384 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
2385 */
2386 curbuf->b_shortname = TRUE;
2387#ifdef VMS
2388 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
2389#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391#endif
2392 if (names[num_names] == NULL)
2393 goto end;
2394
2395 /*
2396 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
2397 */
2398 p = names[num_names];
2399 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
2400 if (i > 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002401 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 if (STRCMP(names[num_names - 1], p) == 0)
2403 vim_free(names[num_names]);
2404 else
2405 ++num_names;
2406# endif
2407
2408end:
Bram Moolenaar4f974752019-02-17 17:44:42 +01002409# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 curbuf->b_shortname = shortname;
2411# endif
2412
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 return num_names;
2414}
2415
2416/*
2417 * sync all memlines
2418 *
2419 * If 'check_file' is TRUE, check if original file exists and was not changed.
2420 * If 'check_char' is TRUE, stop syncing when character becomes available, but
2421 * always sync at least one block.
2422 */
2423 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002424ml_sync_all(int check_file, int check_char)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425{
2426 buf_T *buf;
Bram Moolenaar8767f522016-07-01 17:17:39 +02002427 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428
Bram Moolenaar29323592016-07-24 22:04:11 +02002429 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 {
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002431 if (buf->b_ml.ml_mfp == NULL
2432 || buf->b_ml.ml_mfp->mf_fname == NULL
2433 || buf->b_ml.ml_mfp->mf_fd < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002434 continue; // no file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002436 ml_flush_line(buf); // flush buffered line
2437 // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
2439 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
2440 && buf->b_ffname != NULL)
2441 {
2442 /*
2443 * If the original file does not exist anymore or has been changed
2444 * call ml_preserve() to get rid of all negative numbered blocks.
2445 */
2446 if (mch_stat((char *)buf->b_ffname, &st) == -1
2447 || st.st_mtime != buf->b_mtime_read
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01002448#ifdef ST_MTIM_NSEC
2449 || st.ST_MTIM_NSEC != buf->b_mtime_read_ns
2450#endif
Bram Moolenaar914703b2010-05-31 21:59:46 +02002451 || st.st_size != buf->b_orig_size)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 {
2453 ml_preserve(buf, FALSE);
2454 did_check_timestamps = FALSE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002455 need_check_timestamps = TRUE; // give message later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 }
2457 }
2458 if (buf->b_ml.ml_mfp->mf_dirty)
2459 {
2460 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
2461 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002462 if (check_char && ui_char_avail()) // character available now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463 break;
2464 }
2465 }
2466}
2467
2468/*
2469 * sync one buffer, including negative blocks
2470 *
2471 * after this all the blocks are in the swap file
2472 *
2473 * Used for the :preserve command and when the original file has been
2474 * changed or deleted.
2475 *
2476 * when message is TRUE the success of preserving is reported
2477 */
2478 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002479ml_preserve(buf_T *buf, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480{
2481 bhdr_T *hp;
2482 linenr_T lnum;
2483 memfile_T *mfp = buf->b_ml.ml_mfp;
2484 int status;
2485 int got_int_save = got_int;
2486
2487 if (mfp == NULL || mfp->mf_fname == NULL)
2488 {
2489 if (message)
Bram Moolenaareaaac012022-01-02 17:00:40 +00002490 emsg(_(e_cannot_preserve_there_is_no_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 return;
2492 }
2493
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002494 // We only want to stop when interrupted here, not when interrupted
2495 // before.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 got_int = FALSE;
2497
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002498 ml_flush_line(buf); // flush buffered line
2499 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2501
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002502 // stack is invalid after mf_sync(.., MFS_ALL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 buf->b_ml.ml_stack_top = 0;
2504
2505 /*
2506 * Some of the data blocks may have been changed from negative to
2507 * positive block number. In that case the pointer blocks need to be
2508 * updated.
2509 *
2510 * We don't know in which pointer block the references are, so we visit
2511 * all data blocks until there are no more translations to be done (or
2512 * we hit the end of the file, which can only happen in case a write fails,
2513 * e.g. when file system if full).
2514 * ml_find_line() does the work by translating the negative block numbers
2515 * when getting the first line of each data block.
2516 */
2517 if (mf_need_trans(mfp) && !got_int)
2518 {
2519 lnum = 1;
2520 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2521 {
2522 hp = ml_find_line(buf, lnum, ML_FIND);
2523 if (hp == NULL)
2524 {
2525 status = FAIL;
2526 goto theend;
2527 }
2528 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2529 lnum = buf->b_ml.ml_locked_high + 1;
2530 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002531 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
2532 // sync the updated pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2534 status = FAIL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002535 buf->b_ml.ml_stack_top = 0; // stack is invalid now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 }
2537theend:
2538 got_int |= got_int_save;
2539
2540 if (message)
2541 {
2542 if (status == OK)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002543 msg(_("File preserved"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 else
Bram Moolenaareaaac012022-01-02 17:00:40 +00002545 emsg(_(e_preserve_failed));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546 }
2547}
2548
2549/*
2550 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2551 * until the next call!
2552 * line1 = ml_get(1);
2553 * line2 = ml_get(2); // line1 is now invalid!
2554 * Make a copy of the line if necessary.
2555 */
2556/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002557 * Return a pointer to a (read-only copy of a) line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 *
2559 * On failure an error message is given and IObuff is returned (to avoid
2560 * having to check for error everywhere).
2561 */
2562 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002563ml_get(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564{
2565 return ml_get_buf(curbuf, lnum, FALSE);
2566}
2567
2568/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002569 * Return pointer to position "pos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 */
2571 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002572ml_get_pos(pos_T *pos)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573{
2574 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2575}
2576
2577/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002578 * Return pointer to cursor line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 */
2580 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002581ml_get_curline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582{
2583 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2584}
2585
2586/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002587 * Return pointer to cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 */
2589 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002590ml_get_cursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591{
2592 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2593 curwin->w_cursor.col);
2594}
2595
2596/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002597 * Return a pointer to a line in a specific buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 *
2599 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2600 * changed)
2601 */
2602 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002603ml_get_buf(
2604 buf_T *buf,
2605 linenr_T lnum,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002606 int will_change) // line will be changed
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607{
Bram Moolenaarad40f022007-02-13 03:01:39 +00002608 bhdr_T *hp;
2609 DATA_BL *dp;
Bram Moolenaarad40f022007-02-13 03:01:39 +00002610 static int recursive = 0;
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002611 static char_u questions[4];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002613 if (lnum > buf->b_ml.ml_line_count) // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002615 if (recursive == 0)
2616 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002617 // Avoid giving this message for a recursive call, may happen when
2618 // the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002619 ++recursive;
Bram Moolenaareaaac012022-01-02 17:00:40 +00002620 siemsg(_(e_ml_get_invalid_lnum_nr), lnum);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002621 --recursive;
2622 }
Bram Moolenaarf9435e42022-02-16 16:33:28 +00002623 ml_flush_line(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624errorret:
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002625 STRCPY(questions, "???");
Bram Moolenaaradfde112019-05-25 22:11:45 +02002626 buf->b_ml.ml_line_len = 4;
Bram Moolenaarf9435e42022-02-16 16:33:28 +00002627 buf->b_ml.ml_line_lnum = lnum;
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002628 return questions;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 }
Bram Moolenaaradfde112019-05-25 22:11:45 +02002630 if (lnum <= 0) // pretend line 0 is line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 lnum = 1;
2632
Bram Moolenaaradfde112019-05-25 22:11:45 +02002633 if (buf->b_ml.ml_mfp == NULL) // there are no lines
2634 {
2635 buf->b_ml.ml_line_len = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 return (char_u *)"";
Bram Moolenaaradfde112019-05-25 22:11:45 +02002637 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638
Bram Moolenaar37d619f2010-03-10 14:46:26 +01002639 /*
2640 * See if it is the same line as requested last time.
2641 * Otherwise may need to flush last used line.
2642 * Don't use the last used line when 'swapfile' is reset, need to load all
2643 * blocks.
2644 */
Bram Moolenaar47b8b152007-02-07 02:41:57 +00002645 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002647 unsigned start, end;
2648 colnr_T len;
2649 int idx;
2650
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 ml_flush_line(buf);
2652
2653 /*
2654 * Find the data block containing the line.
2655 * This also fills the stack with the blocks from the root to the data
2656 * block and releases any locked block.
2657 */
2658 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2659 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002660 if (recursive == 0)
2661 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002662 // Avoid giving this message for a recursive call, may happen
2663 // when the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002664 ++recursive;
Bram Moolenaarcb868932019-10-26 20:56:21 +02002665 get_trans_bufname(buf);
2666 shorten_dir(NameBuff);
Bram Moolenaareaaac012022-01-02 17:00:40 +00002667 siemsg(_(e_ml_get_cannot_find_line_nr_in_buffer_nr_str),
Bram Moolenaarcb868932019-10-26 20:56:21 +02002668 lnum, buf->b_fnum, NameBuff);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002669 --recursive;
2670 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 goto errorret;
2672 }
2673
2674 dp = (DATA_BL *)(hp->bh_data);
2675
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002676 idx = lnum - buf->b_ml.ml_locked_low;
2677 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2678 // The text ends where the previous line starts. The first line ends
2679 // at the end of the block.
2680 if (idx == 0)
2681 end = dp->db_txt_end;
2682 else
2683 end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
2684 len = end - start;
2685
2686 buf->b_ml.ml_line_ptr = (char_u *)dp + start;
2687 buf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 buf->b_ml.ml_line_lnum = lnum;
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002689 buf->b_ml.ml_flags &= ~(ML_LINE_DIRTY | ML_ALLOCATED);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 }
2691 if (will_change)
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002692 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002694#ifdef FEAT_EVAL
2695 if (ml_get_alloc_lines && (buf->b_ml.ml_flags & ML_ALLOCATED))
2696 // can't make the change in the data block
2697 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
2698#endif
2699 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002701#ifdef FEAT_EVAL
2702 if (ml_get_alloc_lines
2703 && (buf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED)) == 0)
2704 {
2705 char_u *p = alloc(buf->b_ml.ml_line_len);
2706
2707 // make sure the text is in allocated memory
2708 if (p != NULL)
2709 {
2710 memmove(p, buf->b_ml.ml_line_ptr, buf->b_ml.ml_line_len);
2711 buf->b_ml.ml_line_ptr = p;
2712 buf->b_ml.ml_flags |= ML_ALLOCATED;
2713 if (will_change)
2714 // can't make the change in the data block
2715 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
2716 }
2717 }
2718#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 return buf->b_ml.ml_line_ptr;
2720}
2721
2722/*
2723 * Check if a line that was just obtained by a call to ml_get
2724 * is in allocated memory.
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002725 * This ignores ML_ALLOCATED to get the same behavior as without the test
2726 * override.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 */
2728 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002729ml_line_alloced(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730{
2731 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2732}
2733
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002734#ifdef FEAT_PROP_POPUP
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002735/*
2736 * Add text properties that continue from the previous line.
2737 */
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002738 static void
2739add_text_props_for_append(
2740 buf_T *buf,
2741 linenr_T lnum,
2742 char_u **line,
2743 int *len,
2744 char_u **tofree)
2745{
2746 int round;
2747 int new_prop_count = 0;
2748 int count;
2749 int n;
2750 char_u *props;
Bram Moolenaarea781452019-09-04 18:53:12 +02002751 int new_len = 0; // init for gcc
Bram Moolenaar8f13d822020-09-12 21:04:23 +02002752 char_u *new_line = NULL;
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002753 textprop_T prop;
2754
2755 // Make two rounds:
2756 // 1. calculate the extra space needed
2757 // 2. allocate the space and fill it
2758 for (round = 1; round <= 2; ++round)
2759 {
2760 if (round == 2)
2761 {
2762 if (new_prop_count == 0)
2763 return; // nothing to do
2764 new_len = *len + new_prop_count * sizeof(textprop_T);
Bram Moolenaar964b3742019-05-24 18:54:09 +02002765 new_line = alloc(new_len);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002766 if (new_line == NULL)
2767 return;
2768 mch_memmove(new_line, *line, *len);
2769 new_prop_count = 0;
2770 }
2771
2772 // Get the line above to find any props that continue in the next
2773 // line.
2774 count = get_text_props(buf, lnum, &props, FALSE);
2775 for (n = 0; n < count; ++n)
2776 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002777 mch_memmove(&prop, props + n * sizeof(textprop_T),
2778 sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002779 if (prop.tp_flags & TP_FLAG_CONT_NEXT)
2780 {
2781 if (round == 2)
2782 {
2783 prop.tp_flags |= TP_FLAG_CONT_PREV;
2784 prop.tp_col = 1;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002785 prop.tp_len = *len; // not exactly the right length
2786 mch_memmove(new_line + *len + new_prop_count
2787 * sizeof(textprop_T), &prop, sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002788 }
2789 ++new_prop_count;
2790 }
2791 }
2792 }
2793 *line = new_line;
2794 *tofree = new_line;
2795 *len = new_len;
2796}
2797#endif
2798
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002800ml_append_int(
2801 buf_T *buf,
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002802 linenr_T lnum, // append after this line (can be 0)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002803 char_u *line_arg, // text of the new line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002804 colnr_T len_arg, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002805 int flags) // ML_APPEND_ flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806{
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002807 char_u *line = line_arg;
2808 colnr_T len = len_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 int i;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002810 int line_count; // number of indexes in current block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 int offset;
2812 int from, to;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002813 int space_needed; // space needed for new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 int page_size;
2815 int page_count;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002816 int db_idx; // index for lnum in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 bhdr_T *hp;
2818 memfile_T *mfp;
2819 DATA_BL *dp;
2820 PTR_BL *pp;
2821 infoptr_T *ip;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002822#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002823 char_u *tofree = NULL;
Bram Moolenaar50652b02022-08-07 21:48:37 +01002824# ifdef FEAT_BYTEOFF
2825 colnr_T text_len = 0; // text len with NUL without text properties
2826# endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002827#endif
2828 int ret = FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002831 return FAIL; // lnum out of range
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832
2833 if (lowest_marked && lowest_marked > lnum)
2834 lowest_marked = lnum + 1;
2835
2836 if (len == 0)
Bram Moolenaar50652b02022-08-07 21:48:37 +01002837 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002838 len = (colnr_T)STRLEN(line) + 1; // space needed for the text
Bram Moolenaar50652b02022-08-07 21:48:37 +01002839#if defined(FEAT_PROP_POPUP) && defined(FEAT_BYTEOFF)
2840 text_len = len;
2841#endif
2842 }
2843#if defined(FEAT_PROP_POPUP) && defined(FEAT_BYTEOFF)
2844 else if (curbuf->b_has_textprop)
2845 // "len" may include text properties, get the length of the text.
2846 text_len = (colnr_T)STRLEN(line) + 1;
2847 else
2848 text_len = len;
2849#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002850
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002851#ifdef FEAT_PROP_POPUP
Bram Moolenaar840f91f2021-05-26 22:32:10 +02002852 if (curbuf->b_has_textprop && lnum > 0
2853 && !(flags & (ML_APPEND_UNDO | ML_APPEND_NOPROP)))
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002854 // Add text properties that continue from the previous line.
2855 add_text_props_for_append(buf, lnum, &line, &len, &tofree);
2856#endif
2857
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002858 space_needed = len + INDEX_SIZE; // space needed for text + index
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859
2860 mfp = buf->b_ml.ml_mfp;
2861 page_size = mfp->mf_page_size;
2862
2863/*
2864 * find the data block containing the previous line
2865 * This also fills the stack with the blocks from the root to the data block
2866 * This also releases any locked block.
2867 */
2868 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2869 ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002870 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871
2872 buf->b_ml.ml_flags &= ~ML_EMPTY;
2873
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002874 if (lnum == 0) // got line one instead, correct db_idx
2875 db_idx = -1; // careful, it is negative!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 else
2877 db_idx = lnum - buf->b_ml.ml_locked_low;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002878 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2880
2881 dp = (DATA_BL *)(hp->bh_data);
2882
2883/*
2884 * If
2885 * - there is not enough room in the current block
2886 * - appending to the last line in the block
2887 * - not appending to the last line in the file
2888 * insert in front of the next block.
2889 */
2890 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2891 && lnum < buf->b_ml.ml_line_count)
2892 {
2893 /*
2894 * Now that the line is not going to be inserted in the block that we
2895 * expected, the line count has to be adjusted in the pointer blocks
2896 * by using ml_locked_lineadd.
2897 */
2898 --(buf->b_ml.ml_locked_lineadd);
2899 --(buf->b_ml.ml_locked_high);
2900 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002901 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002903 db_idx = -1; // careful, it is negative!
2904 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2906 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2907
2908 dp = (DATA_BL *)(hp->bh_data);
2909 }
2910
2911 ++buf->b_ml.ml_line_count;
2912
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002913 if ((int)dp->db_free >= space_needed) // enough room in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 {
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002915 /*
2916 * Insert the new line in an existing data block, or in the data block
2917 * allocated above.
2918 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 dp->db_txt_start -= len;
2920 dp->db_free -= space_needed;
2921 ++(dp->db_line_count);
2922
2923 /*
2924 * move the text of the lines that follow to the front
2925 * adjust the indexes of the lines that follow
2926 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002927 if (line_count > db_idx + 1) // if there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 {
2929 /*
2930 * Offset is the start of the previous line.
2931 * This will become the character just after the new line.
2932 */
2933 if (db_idx < 0)
2934 offset = dp->db_txt_end;
2935 else
2936 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2937 mch_memmove((char *)dp + dp->db_txt_start,
2938 (char *)dp + dp->db_txt_start + len,
2939 (size_t)(offset - (dp->db_txt_start + len)));
2940 for (i = line_count - 1; i > db_idx; --i)
2941 dp->db_index[i + 1] = dp->db_index[i] - len;
2942 dp->db_index[db_idx + 1] = offset - len;
2943 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002944 else
2945 // add line at the end (which is the start of the text)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 dp->db_index[db_idx + 1] = dp->db_txt_start;
2947
2948 /*
2949 * copy the text into the block
2950 */
2951 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002952 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 dp->db_index[db_idx + 1] |= DB_MARKED;
2954
2955 /*
2956 * Mark the block dirty.
2957 */
2958 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002959 if (!(flags & ML_APPEND_NEW))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2961 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002962 else // not enough space in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 long line_count_left, line_count_right;
2965 int page_count_left, page_count_right;
2966 bhdr_T *hp_left;
2967 bhdr_T *hp_right;
2968 bhdr_T *hp_new;
2969 int lines_moved;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002970 int data_moved = 0; // init to shut up gcc
2971 int total_moved = 0; // init to shut up gcc
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 DATA_BL *dp_right, *dp_left;
2973 int stack_idx;
2974 int in_left;
2975 int lineadd;
2976 blocknr_T bnum_left, bnum_right;
2977 linenr_T lnum_left, lnum_right;
2978 int pb_idx;
2979 PTR_BL *pp_new;
2980
2981 /*
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002982 * There is not enough room, we have to create a new data block and
2983 * copy some lines into it.
2984 * Then we have to insert an entry in the pointer block.
2985 * If this pointer block also is full, we go up another block, and so
2986 * on, up to the root if necessary.
2987 * The line counts in the pointer blocks have already been adjusted by
2988 * ml_find_line().
2989 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 * We are going to allocate a new data block. Depending on the
2991 * situation it will be put to the left or right of the existing
2992 * block. If possible we put the new line in the left block and move
2993 * the lines after it to the right block. Otherwise the new line is
2994 * also put in the right block. This method is more efficient when
2995 * inserting a lot of lines at one place.
2996 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002997 if (db_idx < 0) // left block is new, right block is existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 {
2999 lines_moved = 0;
3000 in_left = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003001 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003003 else // left block is existing, right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 {
3005 lines_moved = line_count - db_idx - 1;
3006 if (lines_moved == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003007 in_left = FALSE; // put new line in right block
3008 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 else
3010 {
3011 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
3012 dp->db_txt_start;
3013 total_moved = data_moved + lines_moved * INDEX_SIZE;
3014 if ((int)dp->db_free + total_moved >= space_needed)
3015 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003016 in_left = TRUE; // put new line in left block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 space_needed = total_moved;
3018 }
3019 else
3020 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003021 in_left = FALSE; // put new line in right block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 space_needed += total_moved;
3023 }
3024 }
3025 }
3026
3027 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003028 if ((hp_new = ml_new_data(mfp, flags & ML_APPEND_NEW, page_count))
3029 == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003031 // correct line counts in pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 --(buf->b_ml.ml_locked_lineadd);
3033 --(buf->b_ml.ml_locked_high);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003034 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003036 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 {
3038 hp_left = hp_new;
3039 hp_right = hp;
3040 line_count_left = 0;
3041 line_count_right = line_count;
3042 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003043 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 {
3045 hp_left = hp;
3046 hp_right = hp_new;
3047 line_count_left = line_count;
3048 line_count_right = 0;
3049 }
3050 dp_right = (DATA_BL *)(hp_right->bh_data);
3051 dp_left = (DATA_BL *)(hp_left->bh_data);
3052 bnum_left = hp_left->bh_bnum;
3053 bnum_right = hp_right->bh_bnum;
3054 page_count_left = hp_left->bh_page_count;
3055 page_count_right = hp_right->bh_page_count;
3056
3057 /*
3058 * May move the new line into the right/new block.
3059 */
3060 if (!in_left)
3061 {
3062 dp_right->db_txt_start -= len;
3063 dp_right->db_free -= len + INDEX_SIZE;
3064 dp_right->db_index[0] = dp_right->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003065 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 dp_right->db_index[0] |= DB_MARKED;
3067
3068 mch_memmove((char *)dp_right + dp_right->db_txt_start,
3069 line, (size_t)len);
3070 ++line_count_right;
3071 }
3072 /*
3073 * may move lines from the left/old block to the right/new one.
3074 */
3075 if (lines_moved)
3076 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 dp_right->db_txt_start -= data_moved;
3078 dp_right->db_free -= total_moved;
3079 mch_memmove((char *)dp_right + dp_right->db_txt_start,
3080 (char *)dp_left + dp_left->db_txt_start,
3081 (size_t)data_moved);
3082 offset = dp_right->db_txt_start - dp_left->db_txt_start;
3083 dp_left->db_txt_start += data_moved;
3084 dp_left->db_free += total_moved;
3085
3086 /*
3087 * update indexes in the new block
3088 */
3089 for (to = line_count_right, from = db_idx + 1;
3090 from < line_count_left; ++from, ++to)
3091 dp_right->db_index[to] = dp->db_index[from] + offset;
3092 line_count_right += lines_moved;
3093 line_count_left -= lines_moved;
3094 }
3095
3096 /*
3097 * May move the new line into the left (old or new) block.
3098 */
3099 if (in_left)
3100 {
3101 dp_left->db_txt_start -= len;
3102 dp_left->db_free -= len + INDEX_SIZE;
3103 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003104 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 dp_left->db_index[line_count_left] |= DB_MARKED;
3106 mch_memmove((char *)dp_left + dp_left->db_txt_start,
3107 line, (size_t)len);
3108 ++line_count_left;
3109 }
3110
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003111 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 {
3113 lnum_left = lnum + 1;
3114 lnum_right = 0;
3115 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003116 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 {
3118 lnum_left = 0;
3119 if (in_left)
3120 lnum_right = lnum + 2;
3121 else
3122 lnum_right = lnum + 1;
3123 }
3124 dp_left->db_line_count = line_count_left;
3125 dp_right->db_line_count = line_count_right;
3126
3127 /*
3128 * release the two data blocks
3129 * The new one (hp_new) already has a correct blocknumber.
3130 * The old one (hp, in ml_locked) gets a positive blocknumber if
3131 * we changed it and we are not editing a new file.
3132 */
3133 if (lines_moved || in_left)
3134 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003135 if (!(flags & ML_APPEND_NEW) && db_idx >= 0 && in_left)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 buf->b_ml.ml_flags |= ML_LOCKED_POS;
3137 mf_put(mfp, hp_new, TRUE, FALSE);
3138
3139 /*
3140 * flush the old data block
3141 * set ml_locked_lineadd to 0, because the updating of the
3142 * pointer blocks is done below
3143 */
3144 lineadd = buf->b_ml.ml_locked_lineadd;
3145 buf->b_ml.ml_locked_lineadd = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003146 ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147
3148 /*
3149 * update pointer blocks for the new data block
3150 */
3151 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3152 --stack_idx)
3153 {
3154 ip = &(buf->b_ml.ml_stack[stack_idx]);
3155 pb_idx = ip->ip_index;
3156 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003157 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003158 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 if (pp->pb_id != PTR_ID)
3160 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00003161 iemsg(_(e_pointer_block_id_wrong_three));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003163 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 }
3165 /*
3166 * TODO: If the pointer block is full and we are adding at the end
3167 * try to insert in front of the next block
3168 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003169 // block not full, add one entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 if (pp->pb_count < pp->pb_count_max)
3171 {
3172 if (pb_idx + 1 < (int)pp->pb_count)
3173 mch_memmove(&pp->pb_pointer[pb_idx + 2],
3174 &pp->pb_pointer[pb_idx + 1],
3175 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
3176 ++pp->pb_count;
3177 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3178 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3179 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3180 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3181 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3182 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3183
3184 if (lnum_left != 0)
3185 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3186 if (lnum_right != 0)
3187 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3188
3189 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003190 buf->b_ml.ml_stack_top = stack_idx + 1; // truncate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191
3192 if (lineadd)
3193 {
3194 --(buf->b_ml.ml_stack_top);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003195 // fix line count for rest of blocks in the stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 ml_lineadd(buf, lineadd);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003197 // fix stack itself
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
3199 lineadd;
3200 ++(buf->b_ml.ml_stack_top);
3201 }
3202
3203 /*
3204 * We are finished, break the loop here.
3205 */
3206 break;
3207 }
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003208 // pointer block full
3209 /*
3210 * split the pointer block
3211 * allocate a new pointer block
3212 * move some of the pointer into the new block
3213 * prepare for updating the parent block
3214 */
3215 for (;;) // do this twice when splitting block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 {
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003217 hp_new = ml_new_ptr(mfp);
3218 if (hp_new == NULL) // TODO: try to fix tree
3219 goto theend;
3220 pp_new = (PTR_BL *)(hp_new->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003222 if (hp->bh_bnum != 1)
3223 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 /*
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003226 * if block 1 becomes full the tree is given an extra level
3227 * The pointers from block 1 are moved into the new block.
3228 * block 1 is updated to point to the new block
3229 * then continue to split the new block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 */
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003231 mch_memmove(pp_new, pp, (size_t)page_size);
3232 pp->pb_count = 1;
3233 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
3234 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
3235 pp->pb_pointer[0].pe_old_lnum = 1;
3236 pp->pb_pointer[0].pe_page_count = 1;
3237 mf_put(mfp, hp, TRUE, FALSE); // release block 1
3238 hp = hp_new; // new block is to be split
3239 pp = pp_new;
3240 CHECK(stack_idx != 0, _("stack_idx should be 0"));
3241 ip->ip_index = 0;
3242 ++stack_idx; // do block 1 again later
3243 }
3244 /*
3245 * move the pointers after the current one to the new block
3246 * If there are none, the new entry will be in the new block.
3247 */
3248 total_moved = pp->pb_count - pb_idx - 1;
3249 if (total_moved)
3250 {
3251 mch_memmove(&pp_new->pb_pointer[0],
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 &pp->pb_pointer[pb_idx + 1],
3253 (size_t)(total_moved) * sizeof(PTR_EN));
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003254 pp_new->pb_count = total_moved;
3255 pp->pb_count -= total_moved - 1;
3256 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3257 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3258 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3259 if (lnum_right)
3260 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 }
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003262 else
3263 {
3264 pp_new->pb_count = 1;
3265 pp_new->pb_pointer[0].pe_bnum = bnum_right;
3266 pp_new->pb_pointer[0].pe_line_count = line_count_right;
3267 pp_new->pb_pointer[0].pe_page_count = page_count_right;
3268 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
3269 }
3270 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3271 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3272 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3273 if (lnum_left)
3274 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3275 lnum_left = 0;
3276 lnum_right = 0;
3277
3278 /*
3279 * recompute line counts
3280 */
3281 line_count_right = 0;
3282 for (i = 0; i < (int)pp_new->pb_count; ++i)
3283 line_count_right += pp_new->pb_pointer[i].pe_line_count;
3284 line_count_left = 0;
3285 for (i = 0; i < (int)pp->pb_count; ++i)
3286 line_count_left += pp->pb_pointer[i].pe_line_count;
3287
3288 bnum_left = hp->bh_bnum;
3289 bnum_right = hp_new->bh_bnum;
3290 page_count_left = 1;
3291 page_count_right = 1;
3292 mf_put(mfp, hp, TRUE, FALSE);
3293 mf_put(mfp, hp_new, TRUE, FALSE);
3294
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 }
3296
3297 /*
3298 * Safety check: fallen out of for loop?
3299 */
3300 if (stack_idx < 0)
3301 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00003302 iemsg(_(e_updated_too_many_blocks));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003303 buf->b_ml.ml_stack_top = 0; // invalidate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 }
3305 }
3306
3307#ifdef FEAT_BYTEOFF
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003308 // The line was inserted below 'lnum'
Bram Moolenaar50652b02022-08-07 21:48:37 +01003309 ml_updatechunk(buf, lnum + 1,
3310# ifdef FEAT_PROP_POPUP
3311 (long)text_len
3312# else
3313 (long)len
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003314# endif
Bram Moolenaar50652b02022-08-07 21:48:37 +01003315 , ML_CHNK_ADDLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316#endif
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003317
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003319 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 {
3321 if (STRLEN(line) > 0)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003322 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003323 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 (char_u *)"\n", 1);
3325 }
3326#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01003327#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003328 if (buf->b_write_to_channel)
3329 channel_write_new_lines(buf);
3330#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003331 ret = OK;
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003332
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003333theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003334#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003335 vim_free(tofree);
3336#endif
3337 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338}
3339
3340/*
Bram Moolenaar250e3112019-07-15 23:02:14 +02003341 * Flush any pending change and call ml_append_int()
3342 */
3343 static int
3344ml_append_flush(
3345 buf_T *buf,
3346 linenr_T lnum, // append after this line (can be 0)
3347 char_u *line, // text of the new line
3348 colnr_T len, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003349 int flags) // ML_APPEND_ flags
Bram Moolenaar250e3112019-07-15 23:02:14 +02003350{
3351 if (lnum > buf->b_ml.ml_line_count)
3352 return FAIL; // lnum out of range
3353
3354 if (buf->b_ml.ml_line_lnum != 0)
3355 // This may also invoke ml_append_int().
3356 ml_flush_line(buf);
3357
3358#ifdef FEAT_EVAL
3359 // When inserting above recorded changes: flush the changes before changing
3360 // the text. Then flush the cached line, it may become invalid.
3361 may_invoke_listeners(buf, lnum + 1, lnum + 1, 1);
3362 if (buf->b_ml.ml_line_lnum != 0)
3363 ml_flush_line(buf);
3364#endif
3365
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003366 return ml_append_int(buf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003367}
3368
3369/*
3370 * Append a line after lnum (may be 0 to insert a line in front of the file).
3371 * "line" does not need to be allocated, but can't be another line in a
3372 * buffer, unlocking may make it invalid.
3373 *
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003374 * "newfile": TRUE when starting to edit a new file, meaning that pe_old_lnum
Bram Moolenaar250e3112019-07-15 23:02:14 +02003375 * will be set for recovery
3376 * Check: The caller of this function should probably also call
3377 * appended_lines().
3378 *
3379 * return FAIL for failure, OK otherwise
3380 */
3381 int
3382ml_append(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003383 linenr_T lnum, // append after this line (can be 0)
3384 char_u *line, // text of the new line
3385 colnr_T len, // length of new line, including NUL, or 0
3386 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003387{
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003388 return ml_append_flags(lnum, line, len, newfile ? ML_APPEND_NEW : 0);
3389}
3390
3391 int
3392ml_append_flags(
3393 linenr_T lnum, // append after this line (can be 0)
3394 char_u *line, // text of the new line
3395 colnr_T len, // length of new line, including NUL, or 0
3396 int flags) // ML_APPEND_ values
3397{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003398 // When starting up, we might still need to create the memfile
Bram Moolenaar250e3112019-07-15 23:02:14 +02003399 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
3400 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003401 return ml_append_flush(curbuf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003402}
3403
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003404
Bram Moolenaar9f28eeb2022-05-16 10:04:51 +01003405#if defined(FEAT_SPELL) || defined(FEAT_QUICKFIX) || defined(FEAT_PROP_POPUP) \
3406 || defined(PROTO)
Bram Moolenaar250e3112019-07-15 23:02:14 +02003407/*
3408 * Like ml_append() but for an arbitrary buffer. The buffer must already have
3409 * a memline.
3410 */
3411 int
3412ml_append_buf(
3413 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003414 linenr_T lnum, // append after this line (can be 0)
3415 char_u *line, // text of the new line
3416 colnr_T len, // length of new line, including NUL, or 0
3417 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003418{
3419 if (buf->b_ml.ml_mfp == NULL)
3420 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003421 return ml_append_flush(buf, lnum, line, len, newfile ? ML_APPEND_NEW : 0);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003422}
3423#endif
3424
3425/*
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003426 * Replace line "lnum", with buffering, in current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 *
Bram Moolenaar1056d982006-03-09 22:37:52 +00003428 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 * copied to allocated memory already.
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003430 * If "copy" is FALSE the "line" may be freed to add text properties!
3431 * Do not use it after calling ml_replace().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 *
3433 * Check: The caller of this function should probably also call
Bram Moolenaara4d158b2022-08-14 14:17:45 +01003434 * changed_lines(), unless update_screen(UPD_NOT_VALID) is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 *
3436 * return FAIL for failure, OK otherwise
3437 */
3438 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003439ml_replace(linenr_T lnum, char_u *line, int copy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440{
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003441 colnr_T len = -1;
3442
3443 if (line != NULL)
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003444 len = (colnr_T)STRLEN(line);
Bram Moolenaarccae4672019-01-04 15:09:57 +01003445 return ml_replace_len(lnum, line, len, FALSE, copy);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003446}
3447
Bram Moolenaarccae4672019-01-04 15:09:57 +01003448/*
3449 * Replace a line for the current buffer. Like ml_replace() with:
3450 * "len_arg" is the length of the text, excluding NUL.
3451 * If "has_props" is TRUE then "line_arg" includes the text properties and
3452 * "len_arg" includes the NUL of the text.
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01003453 * When "copy" is TRUE copy the text into allocated memory, otherwise
3454 * "line_arg" must be allocated and will be consumed here.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003455 */
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003456 int
Bram Moolenaarccae4672019-01-04 15:09:57 +01003457ml_replace_len(
3458 linenr_T lnum,
3459 char_u *line_arg,
3460 colnr_T len_arg,
3461 int has_props,
3462 int copy)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003463{
3464 char_u *line = line_arg;
3465 colnr_T len = len_arg;
3466
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003467 if (line == NULL) // just checking...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 return FAIL;
3469
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003470 // When starting up, we might still need to create the memfile
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003471 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 return FAIL;
3473
Bram Moolenaarccae4672019-01-04 15:09:57 +01003474 if (!has_props)
3475 ++len; // include the NUL after the text
3476 if (copy)
3477 {
3478 // copy the line to allocated memory
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003479#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003480 if (has_props)
3481 line = vim_memsave(line, len);
3482 else
3483#endif
3484 line = vim_strnsave(line, len - 1);
3485 if (line == NULL)
3486 return FAIL;
3487 }
3488
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003490 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 {
3492 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003493 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 }
3495#endif
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003496 if (curbuf->b_ml.ml_line_lnum != lnum)
3497 {
3498 // another line is buffered, flush it
3499 ml_flush_line(curbuf);
3500
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003501#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003502 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003503 // Need to fetch the old line to copy over any text properties.
3504 ml_get_buf(curbuf, lnum, TRUE);
3505#endif
3506 }
3507
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003508#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003509 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003510 {
3511 size_t oldtextlen = STRLEN(curbuf->b_ml.ml_line_ptr) + 1;
3512
3513 if (oldtextlen < (size_t)curbuf->b_ml.ml_line_len)
3514 {
3515 char_u *newline;
3516 size_t textproplen = curbuf->b_ml.ml_line_len - oldtextlen;
3517
3518 // Need to copy over text properties, stored after the text.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003519 newline = alloc(len + (int)textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003520 if (newline != NULL)
3521 {
Bram Moolenaarccae4672019-01-04 15:09:57 +01003522 mch_memmove(newline, line, len);
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02003523 mch_memmove(newline + len, curbuf->b_ml.ml_line_ptr
3524 + oldtextlen, textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003525 vim_free(line);
3526 line = newline;
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003527 len += (colnr_T)textproplen;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003528 }
3529 }
3530 }
3531#endif
3532
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01003533 if (curbuf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
3534 vim_free(curbuf->b_ml.ml_line_ptr); // free allocated line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 curbuf->b_ml.ml_line_ptr = line;
Bram Moolenaarccae4672019-01-04 15:09:57 +01003537 curbuf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 curbuf->b_ml.ml_line_lnum = lnum;
3539 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
3540
3541 return OK;
3542}
3543
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003544#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003545/*
3546 * Adjust text properties in line "lnum" for a deleted line.
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003547 * When "above" is true this is the line above the deleted line, otherwise this
3548 * is the line below the deleted line.
3549 * "del_props[del_props_len]" are the properties of the deleted line.
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003550 */
3551 static void
3552adjust_text_props_for_delete(
3553 buf_T *buf,
3554 linenr_T lnum,
3555 char_u *del_props,
3556 int del_props_len,
3557 int above)
3558{
3559 int did_get_line = FALSE;
3560 int done_del;
3561 int done_this;
3562 textprop_T prop_del;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003563 bhdr_T *hp;
3564 DATA_BL *dp;
3565 int idx;
3566 int line_start;
3567 long line_size;
3568 int this_props_len;
3569 char_u *text;
3570 size_t textlen;
3571 int found;
3572
3573 for (done_del = 0; done_del < del_props_len; done_del += sizeof(textprop_T))
3574 {
3575 mch_memmove(&prop_del, del_props + done_del, sizeof(textprop_T));
3576 if ((above && (prop_del.tp_flags & TP_FLAG_CONT_PREV)
3577 && !(prop_del.tp_flags & TP_FLAG_CONT_NEXT))
3578 || (!above && (prop_del.tp_flags & TP_FLAG_CONT_NEXT)
3579 && !(prop_del.tp_flags & TP_FLAG_CONT_PREV)))
3580 {
3581 if (!did_get_line)
3582 {
3583 did_get_line = TRUE;
3584 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
3585 return;
3586
3587 dp = (DATA_BL *)(hp->bh_data);
3588 idx = lnum - buf->b_ml.ml_locked_low;
3589 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3590 if (idx == 0) // first line in block, text at the end
3591 line_size = dp->db_txt_end - line_start;
3592 else
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003593 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK)
3594 - line_start;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003595 text = (char_u *)dp + line_start;
3596 textlen = STRLEN(text) + 1;
3597 if ((long)textlen >= line_size)
3598 {
3599 if (above)
3600 internal_error("no text property above deleted line");
3601 else
3602 internal_error("no text property below deleted line");
3603 return;
3604 }
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01003605 this_props_len = line_size - (int)textlen;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003606 }
3607
3608 found = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003609 for (done_this = 0; done_this < this_props_len;
3610 done_this += sizeof(textprop_T))
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003611 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003612 int flag = above ? TP_FLAG_CONT_NEXT
3613 : TP_FLAG_CONT_PREV;
3614 textprop_T prop_this;
3615
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003616 mch_memmove(&prop_this, text + textlen + done_this,
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003617 sizeof(textprop_T));
3618 if ((prop_this.tp_flags & flag)
3619 && prop_del.tp_id == prop_this.tp_id
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003620 && prop_del.tp_type == prop_this.tp_type)
3621 {
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003622 found = TRUE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003623 prop_this.tp_flags &= ~flag;
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003624 mch_memmove(text + textlen + done_this, &prop_this,
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003625 sizeof(textprop_T));
3626 break;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003627 }
3628 }
3629 if (!found)
3630 {
3631 if (above)
3632 internal_error("text property above deleted line not found");
3633 else
3634 internal_error("text property below deleted line not found");
3635 }
3636
3637 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3638 }
3639 }
3640}
3641#endif
3642
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643/*
Bram Moolenaar4033c552017-09-16 20:54:51 +02003644 * Delete line "lnum" in the current buffer.
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003645 * When "flags" has ML_DEL_MESSAGE may give a "No lines in buffer" message.
3646 * When "flags" has ML_DEL_UNDO this is called from undo.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 *
3648 * return FAIL for failure, OK otherwise
3649 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 static int
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003651ml_delete_int(buf_T *buf, linenr_T lnum, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652{
3653 bhdr_T *hp;
3654 memfile_T *mfp;
3655 DATA_BL *dp;
3656 PTR_BL *pp;
3657 infoptr_T *ip;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003658 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 int idx;
3660 int stack_idx;
3661 int text_start;
3662 int line_start;
3663 long line_size;
3664 int i;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003665 int ret = FAIL;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003666#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003667 char_u *textprop_save = NULL;
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003668 long textprop_len = 0;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003669#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 if (lowest_marked && lowest_marked > lnum)
3672 lowest_marked--;
3673
3674/*
3675 * If the file becomes empty the last line is replaced by an empty line.
3676 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003677 if (buf->b_ml.ml_line_count == 1) // file becomes empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003679 if ((flags & ML_DEL_MESSAGE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680#ifdef FEAT_NETBEANS_INTG
3681 && !netbeansSuppressNoLines
3682#endif
3683 )
Bram Moolenaar238a5642006-02-21 22:12:05 +00003684 set_keep_msg((char_u *)_(no_lines_msg), 0);
3685
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003686 // FEAT_BYTEOFF already handled in there, don't worry 'bout it below
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
3688 buf->b_ml.ml_flags |= ML_EMPTY;
3689
3690 return i;
3691 }
3692
3693/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003694 * Find the data block containing the line.
3695 * This also fills the stack with the blocks from the root to the data block.
3696 * This also releases any locked block..
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 */
3698 mfp = buf->b_ml.ml_mfp;
3699 if (mfp == NULL)
3700 return FAIL;
3701
3702 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
3703 return FAIL;
3704
3705 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003706 // compute line count before the delete
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 count = (long)(buf->b_ml.ml_locked_high)
3708 - (long)(buf->b_ml.ml_locked_low) + 2;
3709 idx = lnum - buf->b_ml.ml_locked_low;
3710
3711 --buf->b_ml.ml_line_count;
3712
3713 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003714 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 line_size = dp->db_txt_end - line_start;
3716 else
3717 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
3718
3719#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003720 if (netbeans_active())
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00003721 netbeans_removed(buf, lnum, 0, line_size);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003723#ifdef FEAT_PROP_POPUP
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003724 // If there are text properties compute their byte length.
3725 // if needed make a copy, so that we can update properties in preceding and
3726 // following lines.
3727 if (buf->b_has_textprop)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003728 {
3729 size_t textlen = STRLEN((char_u *)dp + line_start) + 1;
3730
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003731 textprop_len = line_size - (long)textlen;
3732 if (!(flags & (ML_DEL_UNDO | ML_DEL_NOPROP)) && textprop_len > 0)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003733 textprop_save = vim_memsave((char_u *)dp + line_start + textlen,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003734 textprop_len);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003735 }
3736#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737
3738/*
3739 * special case: If there is only one line in the data block it becomes empty.
3740 * Then we have to remove the entry, pointing to this data block, from the
3741 * pointer block. If this pointer block also becomes empty, we go up another
3742 * block, and so on, up to the root if necessary.
3743 * The line counts in the pointer blocks have already been adjusted by
3744 * ml_find_line().
3745 */
3746 if (count == 1)
3747 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003748 mf_free(mfp, hp); // free the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 buf->b_ml.ml_locked = NULL;
3750
Bram Moolenaare60acc12011-05-10 16:41:25 +02003751 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3752 --stack_idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003754 buf->b_ml.ml_stack_top = 0; // stack is invalid when failing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 ip = &(buf->b_ml.ml_stack[stack_idx]);
3756 idx = ip->ip_index;
3757 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003758 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003759 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 if (pp->pb_id != PTR_ID)
3761 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00003762 iemsg(_(e_pointer_block_id_wrong_four));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003764 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 }
3766 count = --(pp->pb_count);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003767 if (count == 0) // the pointer block becomes empty!
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 mf_free(mfp, hp);
3769 else
3770 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003771 if (count != idx) // move entries after the deleted one
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
3773 (size_t)(count - idx) * sizeof(PTR_EN));
3774 mf_put(mfp, hp, TRUE, FALSE);
3775
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003776 buf->b_ml.ml_stack_top = stack_idx; // truncate stack
3777 // fix line count for rest of blocks in the stack
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003778 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 {
3780 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3781 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003782 buf->b_ml.ml_locked_lineadd;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 }
3784 ++(buf->b_ml.ml_stack_top);
3785
3786 break;
3787 }
3788 }
3789 CHECK(stack_idx < 0, _("deleted block 1?"));
3790 }
3791 else
3792 {
3793 /*
3794 * delete the text by moving the next lines forwards
3795 */
3796 text_start = dp->db_txt_start;
3797 mch_memmove((char *)dp + text_start + line_size,
3798 (char *)dp + text_start, (size_t)(line_start - text_start));
3799
3800 /*
3801 * delete the index by moving the next indexes backwards
3802 * Adjust the indexes for the text movement.
3803 */
3804 for (i = idx; i < count - 1; ++i)
3805 dp->db_index[i] = dp->db_index[i + 1] + line_size;
3806
3807 dp->db_free += line_size + INDEX_SIZE;
3808 dp->db_txt_start += line_size;
3809 --(dp->db_line_count);
3810
3811 /*
3812 * mark the block dirty and make sure it is in the file (for recovery)
3813 */
3814 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3815 }
3816
3817#ifdef FEAT_BYTEOFF
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003818 ml_updatechunk(buf, lnum, line_size
3819# ifdef FEAT_PROP_POPUP
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003820 - textprop_len
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003821# endif
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003822 , ML_CHNK_DELLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823#endif
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003824 ret = OK;
3825
3826theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003827#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003828 if (textprop_save != NULL)
3829 {
3830 // Adjust text properties in the line above and below.
3831 if (lnum > 1)
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02003832 adjust_text_props_for_delete(buf, lnum - 1, textprop_save,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003833 (int)textprop_len, TRUE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003834 if (lnum <= buf->b_ml.ml_line_count)
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02003835 adjust_text_props_for_delete(buf, lnum, textprop_save,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003836 (int)textprop_len, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003837 }
3838 vim_free(textprop_save);
3839#endif
3840 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841}
3842
3843/*
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003844 * Delete line "lnum" in the current buffer.
3845 * When "message" is TRUE may give a "No lines in buffer" message.
3846 *
3847 * Check: The caller of this function should probably also call
3848 * deleted_lines() after this.
3849 *
3850 * return FAIL for failure, OK otherwise
3851 */
3852 int
Bram Moolenaarca70c072020-05-30 20:30:46 +02003853ml_delete(linenr_T lnum)
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003854{
Bram Moolenaarca70c072020-05-30 20:30:46 +02003855 return ml_delete_flags(lnum, 0);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003856}
3857
3858/*
3859 * Like ml_delete() but using flags (see ml_delete_int()).
3860 */
3861 int
3862ml_delete_flags(linenr_T lnum, int flags)
3863{
3864 ml_flush_line(curbuf);
3865 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
3866 return FAIL;
3867
3868#ifdef FEAT_EVAL
3869 // When inserting above recorded changes: flush the changes before changing
3870 // the text.
3871 may_invoke_listeners(curbuf, lnum, lnum + 1, -1);
3872#endif
3873
3874 return ml_delete_int(curbuf, lnum, flags);
3875}
3876
3877/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003878 * set the DB_MARKED flag for line 'lnum'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 */
3880 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003881ml_setmarked(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882{
3883 bhdr_T *hp;
3884 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003885 // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3887 || curbuf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003888 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889
3890 if (lowest_marked == 0 || lowest_marked > lnum)
3891 lowest_marked = lnum;
3892
3893 /*
3894 * find the data block containing the line
3895 * This also fills the stack with the blocks from the root to the data block
3896 * This also releases any locked block.
3897 */
3898 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003899 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900
3901 dp = (DATA_BL *)(hp->bh_data);
3902 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
3903 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3904}
3905
3906/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003907 * find the first line with its DB_MARKED flag set
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 */
3909 linenr_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003910ml_firstmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911{
3912 bhdr_T *hp;
3913 DATA_BL *dp;
3914 linenr_T lnum;
3915 int i;
3916
3917 if (curbuf->b_ml.ml_mfp == NULL)
3918 return (linenr_T) 0;
3919
3920 /*
3921 * The search starts with lowest_marked line. This is the last line where
3922 * a mark was found, adjusted by inserting/deleting lines.
3923 */
3924 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3925 {
3926 /*
3927 * Find the data block containing the line.
3928 * This also fills the stack with the blocks from the root to the data
3929 * block This also releases any locked block.
3930 */
3931 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003932 return (linenr_T)0; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933
3934 dp = (DATA_BL *)(hp->bh_data);
3935
3936 for (i = lnum - curbuf->b_ml.ml_locked_low;
3937 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3938 if ((dp->db_index[i]) & DB_MARKED)
3939 {
3940 (dp->db_index[i]) &= DB_INDEX_MASK;
3941 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3942 lowest_marked = lnum + 1;
3943 return lnum;
3944 }
3945 }
3946
3947 return (linenr_T) 0;
3948}
3949
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950/*
3951 * clear all DB_MARKED flags
3952 */
3953 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003954ml_clearmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955{
3956 bhdr_T *hp;
3957 DATA_BL *dp;
3958 linenr_T lnum;
3959 int i;
3960
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003961 if (curbuf->b_ml.ml_mfp == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 return;
3963
3964 /*
3965 * The search starts with line lowest_marked.
3966 */
3967 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3968 {
3969 /*
3970 * Find the data block containing the line.
3971 * This also fills the stack with the blocks from the root to the data
3972 * block and releases any locked block.
3973 */
3974 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003975 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976
3977 dp = (DATA_BL *)(hp->bh_data);
3978
3979 for (i = lnum - curbuf->b_ml.ml_locked_low;
3980 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3981 if ((dp->db_index[i]) & DB_MARKED)
3982 {
3983 (dp->db_index[i]) &= DB_INDEX_MASK;
3984 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3985 }
3986 }
3987
3988 lowest_marked = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989}
3990
3991/*
3992 * flush ml_line if necessary
3993 */
3994 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003995ml_flush_line(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996{
3997 bhdr_T *hp;
3998 DATA_BL *dp;
3999 linenr_T lnum;
4000 char_u *new_line;
4001 char_u *old_line;
4002 colnr_T new_len;
4003 int old_len;
4004 int extra;
4005 int idx;
4006 int start;
4007 int count;
4008 int i;
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004009 static int entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010
4011 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004012 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013
4014 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
4015 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004016 // This code doesn't work recursively, but Netbeans may call back here
4017 // when obtaining the cursor position.
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004018 if (entered)
4019 return;
4020 entered = TRUE;
4021
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 lnum = buf->b_ml.ml_line_lnum;
4023 new_line = buf->b_ml.ml_line_ptr;
4024
4025 hp = ml_find_line(buf, lnum, ML_FIND);
4026 if (hp == NULL)
Bram Moolenaareaaac012022-01-02 17:00:40 +00004027 siemsg(_(e_cannot_find_line_nr), lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 else
4029 {
4030 dp = (DATA_BL *)(hp->bh_data);
4031 idx = lnum - buf->b_ml.ml_locked_low;
4032 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
4033 old_line = (char_u *)dp + start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004034 if (idx == 0) // line is last in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 old_len = dp->db_txt_end - start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004036 else // text of previous line follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01004038 new_len = buf->b_ml.ml_line_len;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004039 extra = new_len - old_len; // negative if lines gets smaller
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040
4041 /*
4042 * if new line fits in data block, replace directly
4043 */
4044 if ((int)dp->db_free >= extra)
4045 {
Bram Moolenaar92755bb2021-08-15 22:18:04 +02004046#if defined(FEAT_BYTEOFF) && defined(FEAT_PROP_POPUP)
Bram Moolenaar14c75302021-08-15 14:28:40 +02004047 int old_prop_len = 0;
Paul Ollis4c3d21a2022-05-24 21:26:37 +01004048 if (buf->b_has_textprop)
4049 old_prop_len = old_len - (int)STRLEN(old_line) - 1;
Bram Moolenaar14c75302021-08-15 14:28:40 +02004050#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004051 // if the length changes and there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
4053 if (extra != 0 && idx < count - 1)
4054 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004055 // move text of following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 mch_memmove((char *)dp + dp->db_txt_start - extra,
4057 (char *)dp + dp->db_txt_start,
4058 (size_t)(start - dp->db_txt_start));
4059
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004060 // adjust pointers of this and following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 for (i = idx + 1; i < count; ++i)
4062 dp->db_index[i] -= extra;
4063 }
4064 dp->db_index[idx] -= extra;
4065
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004066 // adjust free space
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 dp->db_free -= extra;
4068 dp->db_txt_start -= extra;
4069
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004070 // copy new line into the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 mch_memmove(old_line - extra, new_line, (size_t)new_len);
4072 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
Bram Moolenaar92755bb2021-08-15 22:18:04 +02004073#if defined(FEAT_BYTEOFF) && defined(FEAT_PROP_POPUP)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004074 // The else case is already covered by the insert and delete
Bram Moolenaar14c75302021-08-15 14:28:40 +02004075 if (buf->b_has_textprop)
4076 {
4077 // Do not count the size of any text properties.
4078 extra += old_prop_len;
Bram Moolenaar434df7a2021-08-16 21:15:32 +02004079 extra -= new_len - (int)STRLEN(new_line) - 1;
Bram Moolenaar14c75302021-08-15 14:28:40 +02004080 }
4081 if (extra != 0)
4082 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083#endif
4084 }
4085 else
4086 {
4087 /*
4088 * Cannot do it in one data block: Delete and append.
4089 * Append first, because ml_delete_int() cannot delete the
4090 * last line in a buffer, which causes trouble for a buffer
4091 * that has only one line.
4092 * Don't forget to copy the mark!
4093 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004094 // How about handling errors???
Bram Moolenaara9d4b842020-05-30 14:46:52 +02004095 (void)ml_append_int(buf, lnum, new_line, new_len,
Bram Moolenaar840f91f2021-05-26 22:32:10 +02004096 ((dp->db_index[idx] & DB_MARKED) ? ML_APPEND_MARK : 0)
4097#ifdef FEAT_PROP_POPUP
4098 | ML_APPEND_NOPROP
4099#endif
4100 );
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02004101 (void)ml_delete_int(buf, lnum, ML_DEL_NOPROP);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 }
4103 }
4104 vim_free(new_line);
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004105
4106 entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 }
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01004108 else if (buf->b_ml.ml_flags & ML_ALLOCATED)
4109 vim_free(buf->b_ml.ml_line_ptr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01004111 buf->b_ml.ml_flags &= ~(ML_LINE_DIRTY | ML_ALLOCATED);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 buf->b_ml.ml_line_lnum = 0;
4113}
4114
4115/*
4116 * create a new, empty, data block
4117 */
4118 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004119ml_new_data(memfile_T *mfp, int negative, int page_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120{
4121 bhdr_T *hp;
4122 DATA_BL *dp;
4123
4124 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
4125 return NULL;
4126
4127 dp = (DATA_BL *)(hp->bh_data);
4128 dp->db_id = DATA_ID;
4129 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
4130 dp->db_free = dp->db_txt_start - HEADER_SIZE;
4131 dp->db_line_count = 0;
4132
4133 return hp;
4134}
4135
4136/*
4137 * create a new, empty, pointer block
4138 */
4139 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004140ml_new_ptr(memfile_T *mfp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141{
4142 bhdr_T *hp;
4143 PTR_BL *pp;
4144
4145 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
4146 return NULL;
4147
4148 pp = (PTR_BL *)(hp->bh_data);
4149 pp->pb_id = PTR_ID;
4150 pp->pb_count = 0;
Bram Moolenaar20a825a2010-05-31 21:27:30 +02004151 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL))
4152 / sizeof(PTR_EN) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153
4154 return hp;
4155}
4156
4157/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01004158 * Lookup line 'lnum' in a memline.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 *
4160 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
4161 * if ML_FLUSH only flush a locked block
4162 * if ML_FIND just find the line
4163 *
4164 * If the block was found it is locked and put in ml_locked.
4165 * The stack is updated to lead to the locked block. The ip_high field in
4166 * the stack is updated to reflect the last line in the block AFTER the
4167 * insert or delete, also if the pointer block has not been updated yet. But
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004168 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 *
4170 * return: NULL for failure, pointer to block header otherwise
4171 */
4172 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004173ml_find_line(buf_T *buf, linenr_T lnum, int action)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174{
4175 DATA_BL *dp;
4176 PTR_BL *pp;
4177 infoptr_T *ip;
4178 bhdr_T *hp;
4179 memfile_T *mfp;
4180 linenr_T t;
4181 blocknr_T bnum, bnum2;
4182 int dirty;
4183 linenr_T low, high;
4184 int top;
4185 int page_count;
4186 int idx;
4187
4188 mfp = buf->b_ml.ml_mfp;
4189
4190 /*
4191 * If there is a locked block check if the wanted line is in it.
4192 * If not, flush and release the locked block.
4193 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
4194 * Don't do this for ML_FLUSH, because we want to flush the locked block.
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004195 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 */
4197 if (buf->b_ml.ml_locked)
4198 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004199 if (ML_SIMPLE(action)
4200 && buf->b_ml.ml_locked_low <= lnum
4201 && buf->b_ml.ml_locked_high >= lnum
4202 && !mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004204 // remember to update pointer blocks and stack later
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 if (action == ML_INSERT)
4206 {
4207 ++(buf->b_ml.ml_locked_lineadd);
4208 ++(buf->b_ml.ml_locked_high);
4209 }
4210 else if (action == ML_DELETE)
4211 {
4212 --(buf->b_ml.ml_locked_lineadd);
4213 --(buf->b_ml.ml_locked_high);
4214 }
4215 return (buf->b_ml.ml_locked);
4216 }
4217
4218 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
4219 buf->b_ml.ml_flags & ML_LOCKED_POS);
4220 buf->b_ml.ml_locked = NULL;
4221
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004222 /*
4223 * If lines have been added or deleted in the locked block, need to
4224 * update the line count in pointer blocks.
4225 */
4226 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
4228 }
4229
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004230 if (action == ML_FLUSH) // nothing else to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 return NULL;
4232
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004233 bnum = 1; // start at the root of the tree
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 page_count = 1;
4235 low = 1;
4236 high = buf->b_ml.ml_line_count;
4237
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004238 if (action == ML_FIND) // first try stack entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 {
4240 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
4241 {
4242 ip = &(buf->b_ml.ml_stack[top]);
4243 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
4244 {
4245 bnum = ip->ip_bnum;
4246 low = ip->ip_low;
4247 high = ip->ip_high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004248 buf->b_ml.ml_stack_top = top; // truncate stack at prev entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 break;
4250 }
4251 }
4252 if (top < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004253 buf->b_ml.ml_stack_top = 0; // not found, start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004255 else // ML_DELETE or ML_INSERT
4256 buf->b_ml.ml_stack_top = 0; // start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257
4258/*
4259 * search downwards in the tree until a data block is found
4260 */
4261 for (;;)
4262 {
4263 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
4264 goto error_noblock;
4265
4266 /*
4267 * update high for insert/delete
4268 */
4269 if (action == ML_INSERT)
4270 ++high;
4271 else if (action == ML_DELETE)
4272 --high;
4273
4274 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004275 if (dp->db_id == DATA_ID) // data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 {
4277 buf->b_ml.ml_locked = hp;
4278 buf->b_ml.ml_locked_low = low;
4279 buf->b_ml.ml_locked_high = high;
4280 buf->b_ml.ml_locked_lineadd = 0;
4281 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
4282 return hp;
4283 }
4284
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004285 pp = (PTR_BL *)(dp); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 if (pp->pb_id != PTR_ID)
4287 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00004288 iemsg(_(e_pointer_block_id_wrong));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 goto error_block;
4290 }
4291
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004292 if ((top = ml_add_stack(buf)) < 0) // add new entry to stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 goto error_block;
4294 ip = &(buf->b_ml.ml_stack[top]);
4295 ip->ip_bnum = bnum;
4296 ip->ip_low = low;
4297 ip->ip_high = high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004298 ip->ip_index = -1; // index not known yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299
4300 dirty = FALSE;
4301 for (idx = 0; idx < (int)pp->pb_count; ++idx)
4302 {
4303 t = pp->pb_pointer[idx].pe_line_count;
4304 CHECK(t == 0, _("pe_line_count is zero"));
4305 if ((low += t) > lnum)
4306 {
4307 ip->ip_index = idx;
4308 bnum = pp->pb_pointer[idx].pe_bnum;
4309 page_count = pp->pb_pointer[idx].pe_page_count;
4310 high = low - 1;
4311 low -= t;
4312
4313 /*
4314 * a negative block number may have been changed
4315 */
4316 if (bnum < 0)
4317 {
4318 bnum2 = mf_trans_del(mfp, bnum);
4319 if (bnum != bnum2)
4320 {
4321 bnum = bnum2;
4322 pp->pb_pointer[idx].pe_bnum = bnum;
4323 dirty = TRUE;
4324 }
4325 }
4326
4327 break;
4328 }
4329 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004330 if (idx >= (int)pp->pb_count) // past the end: something wrong!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 {
4332 if (lnum > buf->b_ml.ml_line_count)
Bram Moolenaareaaac012022-01-02 17:00:40 +00004333 siemsg(_(e_line_number_out_of_range_nr_past_the_end),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 lnum - buf->b_ml.ml_line_count);
4335
4336 else
Bram Moolenaareaaac012022-01-02 17:00:40 +00004337 siemsg(_(e_line_count_wrong_in_block_nr), bnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 goto error_block;
4339 }
4340 if (action == ML_DELETE)
4341 {
4342 pp->pb_pointer[idx].pe_line_count--;
4343 dirty = TRUE;
4344 }
4345 else if (action == ML_INSERT)
4346 {
4347 pp->pb_pointer[idx].pe_line_count++;
4348 dirty = TRUE;
4349 }
4350 mf_put(mfp, hp, dirty, FALSE);
4351 }
4352
4353error_block:
4354 mf_put(mfp, hp, FALSE, FALSE);
4355error_noblock:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004356 /*
4357 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
4358 * the incremented/decremented line counts, because there won't be a line
4359 * inserted/deleted after all.
4360 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 if (action == ML_DELETE)
4362 ml_lineadd(buf, 1);
4363 else if (action == ML_INSERT)
4364 ml_lineadd(buf, -1);
4365 buf->b_ml.ml_stack_top = 0;
4366 return NULL;
4367}
4368
4369/*
4370 * add an entry to the info pointer stack
4371 *
4372 * return -1 for failure, number of the new entry otherwise
4373 */
4374 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004375ml_add_stack(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376{
4377 int top;
4378 infoptr_T *newstack;
4379
4380 top = buf->b_ml.ml_stack_top;
4381
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004382 // may have to increase the stack size
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 if (top == buf->b_ml.ml_stack_size)
4384 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004385 CHECK(top > 0, _("Stack size increases")); // more than 5 levels???
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004387 newstack = ALLOC_MULT(infoptr_T, buf->b_ml.ml_stack_size + STACK_INCR);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 if (newstack == NULL)
4389 return -1;
Bram Moolenaarfbd302f2015-08-08 18:23:46 +02004390 if (top > 0)
4391 mch_memmove(newstack, buf->b_ml.ml_stack,
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004392 (size_t)top * sizeof(infoptr_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 vim_free(buf->b_ml.ml_stack);
4394 buf->b_ml.ml_stack = newstack;
4395 buf->b_ml.ml_stack_size += STACK_INCR;
4396 }
4397
4398 buf->b_ml.ml_stack_top++;
4399 return top;
4400}
4401
4402/*
4403 * Update the pointer blocks on the stack for inserted/deleted lines.
4404 * The stack itself is also updated.
4405 *
4406 * When a insert/delete line action fails, the line is not inserted/deleted,
4407 * but the pointer blocks have already been updated. That is fixed here by
4408 * walking through the stack.
4409 *
4410 * Count is the number of lines added, negative if lines have been deleted.
4411 */
4412 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004413ml_lineadd(buf_T *buf, int count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414{
4415 int idx;
4416 infoptr_T *ip;
4417 PTR_BL *pp;
4418 memfile_T *mfp = buf->b_ml.ml_mfp;
4419 bhdr_T *hp;
4420
4421 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
4422 {
4423 ip = &(buf->b_ml.ml_stack[idx]);
4424 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
4425 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004426 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 if (pp->pb_id != PTR_ID)
4428 {
4429 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaareaaac012022-01-02 17:00:40 +00004430 iemsg(_(e_pointer_block_id_wrong_two));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 break;
4432 }
4433 pp->pb_pointer[ip->ip_index].pe_line_count += count;
4434 ip->ip_high += count;
4435 mf_put(mfp, hp, TRUE, FALSE);
4436 }
4437}
4438
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004439#if defined(HAVE_READLINK) || defined(PROTO)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004440/*
4441 * Resolve a symlink in the last component of a file name.
4442 * Note that f_resolve() does it for every part of the path, we don't do that
4443 * here.
4444 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
4445 * Otherwise returns FAIL.
4446 */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004447 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004448resolve_symlink(char_u *fname, char_u *buf)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004449{
4450 char_u tmp[MAXPATHL];
4451 int ret;
4452 int depth = 0;
4453
4454 if (fname == NULL)
4455 return FAIL;
4456
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004457 // Put the result so far in tmp[], starting with the original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004458 vim_strncpy(tmp, fname, MAXPATHL - 1);
4459
4460 for (;;)
4461 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004462 // Limit symlink depth to 100, catch recursive loops.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004463 if (++depth == 100)
4464 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00004465 semsg(_(e_symlink_loop_for_str), fname);
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004466 return FAIL;
4467 }
4468
4469 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
4470 if (ret <= 0)
4471 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00004472 if (errno == EINVAL || errno == ENOENT)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004473 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004474 // Found non-symlink or not existing file, stop here.
4475 // When at the first level use the unmodified name, skip the
4476 // call to vim_FullName().
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004477 if (depth == 1)
4478 return FAIL;
4479
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004480 // Use the resolved name in tmp[].
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004481 break;
4482 }
4483
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004484 // There must be some error reading links, use original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004485 return FAIL;
4486 }
4487 buf[ret] = NUL;
4488
4489 /*
4490 * Check whether the symlink is relative or absolute.
4491 * If it's relative, build a new path based on the directory
4492 * portion of the filename (if any) and the path the symlink
4493 * points to.
4494 */
4495 if (mch_isFullName(buf))
4496 STRCPY(tmp, buf);
4497 else
4498 {
4499 char_u *tail;
4500
4501 tail = gettail(tmp);
4502 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
4503 return FAIL;
4504 STRCPY(tail, buf);
4505 }
4506 }
4507
4508 /*
4509 * Try to resolve the full name of the file so that the swapfile name will
4510 * be consistent even when opening a relative symlink from different
4511 * working directories.
4512 */
4513 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
4514}
4515#endif
4516
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517/*
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004518 * Make swap file name out of the file name and a directory name.
4519 * Returns pointer to allocated memory or NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004521 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004522makeswapname(
4523 char_u *fname,
4524 char_u *ffname UNUSED,
4525 buf_T *buf,
4526 char_u *dir_name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527{
4528 char_u *r, *s;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02004529 char_u *fname_res = fname;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004530#ifdef HAVE_READLINK
4531 char_u fname_buf[MAXPATHL];
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004532
4533 // Expand symlink in the file name, so that we put the swap file with the
4534 // actual file instead of with the symlink.
4535 if (resolve_symlink(fname, fname_buf) == OK)
4536 fname_res = fname_buf;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004537#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538
Bram Moolenaar4f974752019-02-17 17:44:42 +01004539#if defined(UNIX) || defined(MSWIN) // Need _very_ long file names
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01004540 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01004541
4542 s = dir_name + len;
4543 if (after_pathsep(dir_name, s) && len > 1 && s[-1] == s[-2])
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004544 { // Ends with '//', Use Full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 r = NULL;
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004546 if ((s = make_percent_swname(dir_name, fname_res)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 {
4548 r = modname(s, (char_u *)".swp", FALSE);
4549 vim_free(s);
4550 }
4551 return r;
4552 }
4553#endif
4554
4555 r = buf_modname(
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 (buf->b_p_sn || buf->b_shortname),
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004557 fname_res,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 (char_u *)
Bram Moolenaare60acc12011-05-10 16:41:25 +02004559#if defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 "_swp",
4561#else
4562 ".swp",
4563#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004564 // Prepend a '.' to the swap file name for the current directory.
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004565 dir_name[0] == '.' && dir_name[1] == NUL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004566 if (r == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 return NULL;
4568
4569 s = get_file_in_dir(r, dir_name);
4570 vim_free(r);
4571 return s;
4572}
4573
4574/*
4575 * Get file name to use for swap file or backup file.
4576 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
4577 * option "dname".
4578 * - If "dname" is ".", return "fname" (swap file in dir of file).
4579 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
4580 * relative to dir of file).
4581 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
4582 * dir).
4583 *
4584 * The return value is an allocated string and can be NULL.
4585 */
4586 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004587get_file_in_dir(
4588 char_u *fname,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004589 char_u *dname) // don't use "dirname", it is a global for Alpha
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590{
4591 char_u *t;
4592 char_u *tail;
4593 char_u *retval;
4594 int save_char;
4595
4596 tail = gettail(fname);
4597
4598 if (dname[0] == '.' && dname[1] == NUL)
4599 retval = vim_strsave(fname);
4600 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
4601 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004602 if (tail == fname) // no path before file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 retval = concat_fnames(dname + 2, tail, TRUE);
4604 else
4605 {
4606 save_char = *tail;
4607 *tail = NUL;
4608 t = concat_fnames(fname, dname + 2, TRUE);
4609 *tail = save_char;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004610 if (t == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 retval = NULL;
4612 else
4613 {
4614 retval = concat_fnames(t, tail, TRUE);
4615 vim_free(t);
4616 }
4617 }
4618 }
4619 else
4620 retval = concat_fnames(dname, tail, TRUE);
4621
Bram Moolenaar4f974752019-02-17 17:44:42 +01004622#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004623 if (retval != NULL)
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004624 for (t = gettail(retval); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004625 if (*t == ':')
4626 *t = '%';
4627#endif
4628
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 return retval;
4630}
4631
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004632/*
4633 * Print the ATTENTION message: info about an existing swap file.
4634 */
4635 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004636attention_message(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004637 buf_T *buf, // buffer being edited
4638 char_u *fname) // swap file name
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004639{
Bram Moolenaar8767f522016-07-01 17:17:39 +02004640 stat_T st;
Bram Moolenaar63d25552019-05-10 21:28:38 +02004641 time_t swap_mtime;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004642
Bram Moolenaar33a5dd82022-08-28 22:17:50 +01004643 dont_use_message_window();
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004644 ++no_wait_return;
Bram Moolenaareaaac012022-01-02 17:00:40 +00004645 (void)emsg(_(e_attention));
Bram Moolenaar32526b32019-01-19 17:43:09 +01004646 msg_puts(_("\nFound a swap file by the name \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004647 msg_home_replace(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004648 msg_puts("\"\n");
Bram Moolenaar63d25552019-05-10 21:28:38 +02004649 swap_mtime = swapfile_info(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004650 msg_puts(_("While opening file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004651 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004652 msg_puts("\"\n");
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004653 if (mch_stat((char *)buf->b_fname, &st) == -1)
4654 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004655 msg_puts(_(" CANNOT BE FOUND"));
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004656 }
4657 else
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004658 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004659 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02004660 msg_puts(get_ctime(st.st_mtime, TRUE));
4661 if (swap_mtime != 0 && st.st_mtime > swap_mtime)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004662 msg_puts(_(" NEWER than swap file!\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004663 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004664 // Some of these messages are long to allow translation to
4665 // other languages.
Bram Moolenaar32526b32019-01-19 17:43:09 +01004666 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"));
4667 msg_puts(_("(2) An edit session for this file crashed.\n"));
4668 msg_puts(_(" If this is the case, use \":recover\" or \"vim -r "));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004669 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004670 msg_puts(_("\"\n to recover the changes (see \":help recovery\").\n"));
4671 msg_puts(_(" If you did this already, delete the swap file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004672 msg_outtrans(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004673 msg_puts(_("\"\n to avoid this message.\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004674 cmdline_row = msg_row;
4675 --no_wait_return;
4676}
4677
Bram Moolenaar188639d2022-04-04 16:57:21 +01004678typedef enum {
4679 SEA_CHOICE_NONE = 0,
4680 SEA_CHOICE_READONLY = 1,
4681 SEA_CHOICE_EDIT = 2,
4682 SEA_CHOICE_RECOVER = 3,
4683 SEA_CHOICE_DELETE = 4,
4684 SEA_CHOICE_QUIT = 5,
4685 SEA_CHOICE_ABORT = 6
4686} sea_choice_T;
4687
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004688#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004689/*
4690 * Trigger the SwapExists autocommands.
Bram Moolenaar188639d2022-04-04 16:57:21 +01004691 * Returns a value for equivalent to do_dialog().
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004692 */
Bram Moolenaar188639d2022-04-04 16:57:21 +01004693 static sea_choice_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004694do_swapexists(buf_T *buf, char_u *fname)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004695{
4696 set_vim_var_string(VV_SWAPNAME, fname, -1);
4697 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
4698
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004699 // Trigger SwapExists autocommands with <afile> set to the file being
4700 // edited. Disallow changing directory here.
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004701 ++allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004702 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004703 --allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004704
4705 set_vim_var_string(VV_SWAPNAME, NULL, -1);
4706
4707 switch (*get_vim_var_str(VV_SWAPCHOICE))
4708 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01004709 case 'o': return SEA_CHOICE_READONLY;
4710 case 'e': return SEA_CHOICE_EDIT;
4711 case 'r': return SEA_CHOICE_RECOVER;
4712 case 'd': return SEA_CHOICE_DELETE;
4713 case 'q': return SEA_CHOICE_QUIT;
4714 case 'a': return SEA_CHOICE_ABORT;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004715 }
4716
Bram Moolenaar188639d2022-04-04 16:57:21 +01004717 return SEA_CHOICE_NONE;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004718}
4719#endif
4720
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721/*
4722 * Find out what name to use for the swap file for buffer 'buf'.
4723 *
4724 * Several names are tried to find one that does not exist
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004725 * Returns the name in allocated memory or NULL.
Bram Moolenaarf541c362011-10-26 11:44:18 +02004726 * When out of memory "dirp" is set to NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 *
4728 * Note: If BASENAMELEN is not correct, you will get error messages for
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004729 * not being able to open the swap or undo file
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004730 * Note: May trigger SwapExists autocmd, pointers may change!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 */
4732 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004733findswapname(
4734 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004735 char_u **dirp, // pointer to list of directories
4736 char_u *old_fname) // don't give warning for this file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737{
4738 char_u *fname;
4739 int n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 char_u *dir_name;
4741#ifdef AMIGA
4742 BPTR fh;
4743#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 int r;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004745 char_u *buf_fname = buf->b_fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004747#if !defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748# define CREATE_DUMMY_FILE
4749 FILE *dummyfd = NULL;
4750
Bram Moolenaar4f974752019-02-17 17:44:42 +01004751# ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004752 if (buf_fname != NULL && !mch_isFullName(buf_fname)
4753 && vim_strchr(gettail(buf_fname), ':'))
4754 {
4755 char_u *t;
4756
4757 buf_fname = vim_strsave(buf_fname);
4758 if (buf_fname == NULL)
4759 buf_fname = buf->b_fname;
4760 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004761 for (t = gettail(buf_fname); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004762 if (*t == ':')
4763 *t = '%';
4764 }
4765# endif
4766
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004767 /*
4768 * If we start editing a new file, e.g. "test.doc", which resides on an
4769 * MSDOS compatible filesystem, it is possible that the file
4770 * "test.doc.swp" which we create will be exactly the same file. To avoid
4771 * this problem we temporarily create "test.doc". Don't do this when the
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00004772 * check below for an 8.3 file name is used.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004773 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004774 if (!(buf->b_p_sn || buf->b_shortname) && buf_fname != NULL
4775 && mch_getperm(buf_fname) < 0)
4776 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777#endif
4778
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004779 /*
4780 * Isolate a directory name from *dirp and put it in dir_name.
4781 * First allocate some memory to put the directory name in.
4782 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02004783 dir_name = alloc(STRLEN(*dirp) + 1);
Bram Moolenaarf541c362011-10-26 11:44:18 +02004784 if (dir_name == NULL)
4785 *dirp = NULL;
4786 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 (void)copy_option_part(dirp, dir_name, 31000, ",");
4788
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004789 /*
4790 * we try different names until we find one that does not exist yet
4791 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004792 if (dir_name == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 fname = NULL;
4794 else
Bram Moolenaar69c35002013-11-04 02:54:12 +01004795 fname = makeswapname(buf_fname, buf->b_ffname, buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796
4797 for (;;)
4798 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004799 if (fname == NULL) // must be out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004801 if ((n = (int)STRLEN(fname)) == 0) // safety check
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01004803 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 break;
4805 }
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004806#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807/*
4808 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
4809 * file names. If this is the first try and the swap file name does not fit in
4810 * 8.3, detect if this is the case, set shortname and try again.
4811 */
4812 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
4813 && !(buf->b_p_sn || buf->b_shortname))
4814 {
4815 char_u *tail;
4816 char_u *fname2;
Bram Moolenaar8767f522016-07-01 17:17:39 +02004817 stat_T s1, s2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 int f1, f2;
4819 int created1 = FALSE, created2 = FALSE;
4820 int same = FALSE;
4821
4822 /*
4823 * Check if swapfile name does not fit in 8.3:
4824 * It either contains two dots, is longer than 8 chars, or starts
4825 * with a dot.
4826 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004827 tail = gettail(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 if ( vim_strchr(tail, '.') != NULL
4829 || STRLEN(tail) > (size_t)8
4830 || *gettail(fname) == '.')
4831 {
4832 fname2 = alloc(n + 2);
4833 if (fname2 != NULL)
4834 {
4835 STRCPY(fname2, fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004836 // if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
4837 // if fname == ".xx.swp", fname2 = ".xx.swpx"
4838 // if fname == "123456789.swp", fname2 = "12345678x.swp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 if (vim_strchr(tail, '.') != NULL)
4840 fname2[n - 1] = 'x';
4841 else if (*gettail(fname) == '.')
4842 {
4843 fname2[n] = 'x';
4844 fname2[n + 1] = NUL;
4845 }
4846 else
4847 fname2[n - 5] += 1;
4848 /*
4849 * may need to create the files to be able to use mch_stat()
4850 */
4851 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4852 if (f1 < 0)
4853 {
4854 f1 = mch_open_rw((char *)fname,
4855 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 created1 = TRUE;
4857 }
4858 if (f1 >= 0)
4859 {
4860 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4861 if (f2 < 0)
4862 {
4863 f2 = mch_open_rw((char *)fname2,
4864 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4865 created2 = TRUE;
4866 }
4867 if (f2 >= 0)
4868 {
4869 /*
4870 * Both files exist now. If mch_stat() returns the
4871 * same device and inode they are the same file.
4872 */
4873 if (mch_fstat(f1, &s1) != -1
4874 && mch_fstat(f2, &s2) != -1
4875 && s1.st_dev == s2.st_dev
4876 && s1.st_ino == s2.st_ino)
4877 same = TRUE;
4878 close(f2);
4879 if (created2)
4880 mch_remove(fname2);
4881 }
4882 close(f1);
4883 if (created1)
4884 mch_remove(fname);
4885 }
4886 vim_free(fname2);
4887 if (same)
4888 {
4889 buf->b_shortname = TRUE;
4890 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004891 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004892 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004893 continue; // try again with b_shortname set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 }
4895 }
4896 }
4897 }
4898#endif
4899 /*
4900 * check if the swapfile already exists
4901 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004902 if (mch_getperm(fname) < 0) // it does not exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 {
4904#ifdef HAVE_LSTAT
Bram Moolenaar8767f522016-07-01 17:17:39 +02004905 stat_T sb;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906
4907 /*
4908 * Extra security check: When a swap file is a symbolic link, this
4909 * is most likely a symlink attack.
4910 */
4911 if (mch_lstat((char *)fname, &sb) < 0)
4912#else
4913# ifdef AMIGA
4914 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4915 /*
4916 * on the Amiga mch_getperm() will return -1 when the file exists
4917 * but is being used by another program. This happens if you edit
4918 * a file twice.
4919 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004920 if (fh != (BPTR)NULL) // can open file, OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 {
4922 Close(fh);
4923 mch_remove(fname);
4924 break;
4925 }
4926 if (IoErr() != ERROR_OBJECT_IN_USE
4927 && IoErr() != ERROR_OBJECT_EXISTS)
4928# endif
4929#endif
4930 break;
4931 }
4932
4933 /*
4934 * A file name equal to old_fname is OK to use.
4935 */
4936 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4937 break;
4938
4939 /*
4940 * get here when file already exists
4941 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004942 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') // first try
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 /*
4945 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4946 * and file.doc are the same file. To guess if this problem is
4947 * present try if file.doc.swx exists. If it does, we set
4948 * buf->b_shortname and try file_doc.swp (dots replaced by
4949 * underscores for this file), and try again. If it doesn't we
4950 * assume that "file.doc.swp" already exists.
4951 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004952 if (!(buf->b_p_sn || buf->b_shortname)) // not tried yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 {
4954 fname[n - 1] = 'x';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004955 r = mch_getperm(fname); // try "file.swx"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 fname[n - 1] = 'p';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004957 if (r >= 0) // "file.swx" seems to exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 {
4959 buf->b_shortname = TRUE;
4960 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004961 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004962 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004963 continue; // try again with '.' replaced with '_'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 }
4965 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 /*
4967 * If we get here the ".swp" file really exists.
4968 * Give an error message, unless recovering, no file name, we are
4969 * viewing a help file or when the path of the file is different
4970 * (happens when all .swp files are in one directory).
4971 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004972 if (!recoverymode && buf_fname != NULL
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02004973 && !buf->b_help
4974 && !(buf->b_flags & (BF_DUMMY | BF_NO_SEA)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 {
4976 int fd;
4977 struct block0 b0;
4978 int differ = FALSE;
4979
4980 /*
4981 * Try to read block 0 from the swap file to get the original
4982 * file name (and inode number).
4983 */
4984 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4985 if (fd >= 0)
4986 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01004987 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 {
4989 /*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004990 * If the swapfile has the same directory as the
4991 * buffer don't compare the directory names, they can
4992 * have a different mountpoint.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004994 if (b0.b0_flags & B0_SAME_DIR)
4995 {
4996 if (fnamecmp(gettail(buf->b_ffname),
4997 gettail(b0.b0_fname)) != 0
4998 || !same_directory(fname, buf->b_ffname))
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004999 {
5000#ifdef CHECK_INODE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005001 // Symlinks may point to the same file even
5002 // when the name differs, need to check the
5003 // inode too.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005004 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
5005 if (fnamecmp_ino(buf->b_ffname, NameBuff,
5006 char_to_long(b0.b0_ino)))
5007#endif
5008 differ = TRUE;
5009 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005010 }
5011 else
5012 {
5013 /*
5014 * The name in the swap file may be
5015 * "~user/path/file". Expand it first.
5016 */
5017 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018#ifdef CHECK_INODE
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005019 if (fnamecmp_ino(buf->b_ffname, NameBuff,
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005020 char_to_long(b0.b0_ino)))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005021 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022#else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005023 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
5024 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005026 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 }
5028 close(fd);
5029 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005031 // give the ATTENTION message when there is an old swap file
5032 // for the current file, and the buffer was not recovered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
5034 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
5035 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005036 sea_choice_T choice = SEA_CHOICE_NONE;
5037 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038#ifdef CREATE_DUMMY_FILE
Bram Moolenaar188639d2022-04-04 16:57:21 +01005039 int did_use_dummy = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005041 // Avoid getting a warning for the file being created
5042 // outside of Vim, it was created at the start of this
5043 // function. Delete the file now, because Vim might exit
5044 // here if the window is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 if (dummyfd != NULL)
5046 {
5047 fclose(dummyfd);
5048 dummyfd = NULL;
Bram Moolenaar69c35002013-11-04 02:54:12 +01005049 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 did_use_dummy = TRUE;
5051 }
5052#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005054#ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 process_still_running = FALSE;
5056#endif
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005057 // It's safe to delete the swap file if all these are true:
5058 // - the edited file exists
5059 // - the swap file has no changes and looks OK
5060 if (mch_stat((char *)buf->b_fname, &st) == 0
5061 && swapfile_unchanged(fname))
5062 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005063 choice = SEA_CHOICE_DELETE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005064 if (p_verbose > 0)
5065 verb_msg(_("Found a swap file that is not useful, deleting it"));
5066 }
5067
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005068#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005069 /*
5070 * If there is an SwapExists autocommand and we can handle
5071 * the response, trigger it. It may return 0 to ask the
5072 * user anyway.
5073 */
Bram Moolenaar188639d2022-04-04 16:57:21 +01005074 if (choice == SEA_CHOICE_NONE
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005075 && swap_exists_action != SEA_NONE
Bram Moolenaar69c35002013-11-04 02:54:12 +01005076 && has_autocmd(EVENT_SWAPEXISTS, buf_fname, buf))
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005077 choice = do_swapexists(buf, fname);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005078#endif
Bram Moolenaar188639d2022-04-04 16:57:21 +01005079
5080 if (choice == SEA_CHOICE_NONE
5081 && swap_exists_action == SEA_READONLY)
5082 {
5083 // always open readonly.
5084 choice = SEA_CHOICE_READONLY;
5085 }
5086
5087 if (choice == SEA_CHOICE_NONE)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005088 {
5089#ifdef FEAT_GUI
Bram Moolenaar798184c2018-10-07 20:48:39 +02005090 // If we are supposed to start the GUI but it wasn't
5091 // completely started yet, start it now. This makes
5092 // the messages displayed in the Vim window when
5093 // loading a session from the .gvimrc file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005094 if (gui.starting && !gui.in_use)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005095 gui_start(NULL);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005096#endif
Bram Moolenaar798184c2018-10-07 20:48:39 +02005097 // Show info about the existing swap file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005098 attention_message(buf, fname);
5099
Bram Moolenaar798184c2018-10-07 20:48:39 +02005100 // We don't want a 'q' typed at the more-prompt
5101 // interrupt loading a file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005102 got_int = FALSE;
Bram Moolenaar798184c2018-10-07 20:48:39 +02005103
5104 // If vimrc has "simalt ~x" we don't want it to
5105 // interfere with the prompt here.
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02005106 flush_buffers(FLUSH_TYPEAHEAD);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005107 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108
5109#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar188639d2022-04-04 16:57:21 +01005110 if (swap_exists_action != SEA_NONE
5111 && choice == SEA_CHOICE_NONE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 {
5113 char_u *name;
Bram Moolenaar188639d2022-04-04 16:57:21 +01005114 int dialog_result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115
Bram Moolenaar964b3742019-05-24 18:54:09 +02005116 name = alloc(STRLEN(fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 + STRLEN(_("Swap file \""))
Bram Moolenaar964b3742019-05-24 18:54:09 +02005118 + STRLEN(_("\" already exists!")) + 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 if (name != NULL)
5120 {
5121 STRCPY(name, _("Swap file \""));
5122 home_replace(NULL, fname, name + STRLEN(name),
5123 1000, TRUE);
5124 STRCAT(name, _("\" already exists!"));
5125 }
Bram Moolenaar188639d2022-04-04 16:57:21 +01005126 dialog_result = do_dialog(VIM_WARNING,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 (char_u *)_("VIM - ATTENTION"),
5128 name == NULL
5129 ? (char_u *)_("Swap file already exists!")
5130 : name,
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005131# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 process_still_running
5133 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
5134# endif
Bram Moolenaard2c340a2011-01-17 20:08:11 +01005135 (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 +00005136
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005137# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar188639d2022-04-04 16:57:21 +01005138 if (process_still_running && dialog_result >= 4)
5139 // compensate for missing "Delete it" button
5140 dialog_result++;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005141# endif
Bram Moolenaar188639d2022-04-04 16:57:21 +01005142 choice = dialog_result;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005143 vim_free(name);
5144
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005145 // pretend screen didn't scroll, need redraw anyway
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005146 msg_scrolled = 0;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01005147 redraw_all_later(UPD_NOT_VALID);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005148 }
5149#endif
5150
Bram Moolenaar188639d2022-04-04 16:57:21 +01005151 switch (choice)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005152 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005153 case SEA_CHOICE_READONLY:
5154 buf->b_p_ro = TRUE;
5155 break;
5156 case SEA_CHOICE_EDIT:
5157 break;
5158 case SEA_CHOICE_RECOVER:
5159 swap_exists_action = SEA_RECOVER;
5160 break;
5161 case SEA_CHOICE_DELETE:
5162 mch_remove(fname);
5163 break;
5164 case SEA_CHOICE_QUIT:
5165 swap_exists_action = SEA_QUIT;
5166 break;
5167 case SEA_CHOICE_ABORT:
5168 swap_exists_action = SEA_QUIT;
5169 got_int = TRUE;
5170 break;
5171 case SEA_CHOICE_NONE:
5172 msg_puts("\n");
5173 if (msg_silent == 0)
5174 // call wait_return() later
5175 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 break;
5177 }
Bram Moolenaar188639d2022-04-04 16:57:21 +01005178
5179 // If the file was deleted this fname can be used.
5180 if (choice != SEA_CHOICE_NONE && mch_getperm(fname) < 0)
5181 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
5183#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005184 // Going to try another name, need the dummy file again.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 if (did_use_dummy)
Bram Moolenaar69c35002013-11-04 02:54:12 +01005186 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187#endif
5188 }
5189 }
5190 }
5191
5192 /*
5193 * Change the ".swp" extension to find another file that can be used.
5194 * First decrement the last char: ".swo", ".swn", etc.
5195 * If that still isn't enough decrement the last but one char: ".svz"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005196 * Can happen when editing many "No Name" buffers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005198 if (fname[n - 1] == 'a') // ".s?a"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005200 if (fname[n - 2] == 'a') // ".saa": tried enough, give up
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00005202 emsg(_(e_too_many_swap_files_found));
Bram Moolenaard23a8232018-02-10 18:45:26 +01005203 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 break;
5205 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005206 --fname[n - 2]; // ".svz", ".suz", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 fname[n - 1] = 'z' + 1;
5208 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005209 --fname[n - 1]; // ".swo", ".swn", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 }
5211
5212 vim_free(dir_name);
5213#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005214 if (dummyfd != NULL) // file has been created temporarily
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 {
5216 fclose(dummyfd);
Bram Moolenaar69c35002013-11-04 02:54:12 +01005217 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 }
5219#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01005220#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01005221 if (buf_fname != buf->b_fname)
5222 vim_free(buf_fname);
5223#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 return fname;
5225}
5226
5227 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005228b0_magic_wrong(ZERO_BL *b0p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229{
5230 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
5231 || b0p->b0_magic_int != (int)B0_MAGIC_INT
5232 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
5233 || b0p->b0_magic_char != B0_MAGIC_CHAR);
5234}
5235
5236#ifdef CHECK_INODE
5237/*
5238 * Compare current file name with file name from swap file.
5239 * Try to use inode numbers when possible.
5240 * Return non-zero when files are different.
5241 *
5242 * When comparing file names a few things have to be taken into consideration:
5243 * - When working over a network the full path of a file depends on the host.
5244 * We check the inode number if possible. It is not 100% reliable though,
5245 * because the device number cannot be used over a network.
5246 * - When a file does not exist yet (editing a new file) there is no inode
5247 * number.
5248 * - The file name in a swap file may not be valid on the current host. The
5249 * "~user" form is used whenever possible to avoid this.
5250 *
5251 * This is getting complicated, let's make a table:
5252 *
5253 * ino_c ino_s fname_c fname_s differ =
5254 *
5255 * both files exist -> compare inode numbers:
5256 * != 0 != 0 X X ino_c != ino_s
5257 *
5258 * inode number(s) unknown, file names available -> compare file names
5259 * == 0 X OK OK fname_c != fname_s
5260 * X == 0 OK OK fname_c != fname_s
5261 *
5262 * current file doesn't exist, file for swap file exist, file name(s) not
5263 * available -> probably different
5264 * == 0 != 0 FAIL X TRUE
5265 * == 0 != 0 X FAIL TRUE
5266 *
5267 * current file exists, inode for swap unknown, file name(s) not
5268 * available -> probably different
5269 * != 0 == 0 FAIL X TRUE
5270 * != 0 == 0 X FAIL TRUE
5271 *
5272 * current file doesn't exist, inode for swap unknown, one file name not
5273 * available -> probably different
5274 * == 0 == 0 FAIL OK TRUE
5275 * == 0 == 0 OK FAIL TRUE
5276 *
5277 * current file doesn't exist, inode for swap unknown, both file names not
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005278 * available -> compare file names
5279 * == 0 == 0 FAIL FAIL fname_c != fname_s
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 *
5281 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
5282 * can't be changed without making the block 0 incompatible with 32 bit
5283 * versions.
5284 */
5285
5286 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005287fnamecmp_ino(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005288 char_u *fname_c, // current file name
5289 char_u *fname_s, // file name from swap file
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005290 long ino_block0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291{
Bram Moolenaar8767f522016-07-01 17:17:39 +02005292 stat_T st;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005293 ino_t ino_c = 0; // ino of current file
5294 ino_t ino_s; // ino of file from swap file
5295 char_u buf_c[MAXPATHL]; // full path of fname_c
5296 char_u buf_s[MAXPATHL]; // full path of fname_s
5297 int retval_c; // flag: buf_c valid
5298 int retval_s; // flag: buf_s valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299
5300 if (mch_stat((char *)fname_c, &st) == 0)
5301 ino_c = (ino_t)st.st_ino;
5302
5303 /*
5304 * First we try to get the inode from the file name, because the inode in
5305 * the swap file may be outdated. If that fails (e.g. this path is not
5306 * valid on this machine), use the inode from block 0.
5307 */
5308 if (mch_stat((char *)fname_s, &st) == 0)
5309 ino_s = (ino_t)st.st_ino;
5310 else
5311 ino_s = (ino_t)ino_block0;
5312
5313 if (ino_c && ino_s)
5314 return (ino_c != ino_s);
5315
5316 /*
5317 * One of the inode numbers is unknown, try a forced vim_FullName() and
5318 * compare the file names.
5319 */
5320 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
5321 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
5322 if (retval_c == OK && retval_s == OK)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005323 return STRCMP(buf_c, buf_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324
5325 /*
5326 * Can't compare inodes or file names, guess that the files are different,
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005327 * unless both appear not to exist at all, then compare with the file name
5328 * in the swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 */
5330 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005331 return STRCMP(fname_c, fname_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 return TRUE;
5333}
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005334#endif // CHECK_INODE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335
5336/*
5337 * Move a long integer into a four byte character array.
5338 * Used for machine independency in block zero.
5339 */
5340 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005341long_to_char(long n, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342{
5343 s[0] = (char_u)(n & 0xff);
5344 n = (unsigned)n >> 8;
5345 s[1] = (char_u)(n & 0xff);
5346 n = (unsigned)n >> 8;
5347 s[2] = (char_u)(n & 0xff);
5348 n = (unsigned)n >> 8;
5349 s[3] = (char_u)(n & 0xff);
5350}
5351
5352 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005353char_to_long(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354{
5355 long retval;
5356
5357 retval = s[3];
5358 retval <<= 8;
5359 retval |= s[2];
5360 retval <<= 8;
5361 retval |= s[1];
5362 retval <<= 8;
5363 retval |= s[0];
5364
5365 return retval;
5366}
5367
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005368/*
5369 * Set the flags in the first block of the swap file:
5370 * - file is modified or not: buf->b_changed
5371 * - 'fileformat'
5372 * - 'fileencoding'
5373 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005375ml_setflags(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376{
5377 bhdr_T *hp;
5378 ZERO_BL *b0p;
5379
5380 if (!buf->b_ml.ml_mfp)
5381 return;
5382 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
5383 {
5384 if (hp->bh_bnum == 0)
5385 {
5386 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005387 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
5388 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
5389 | (get_fileformat(buf) + 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005390 add_b0_fenc(b0p, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 hp->bh_flags |= BH_DIRTY;
5392 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
5393 break;
5394 }
5395 }
5396}
5397
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005398#if defined(FEAT_CRYPT) || defined(PROTO)
5399/*
5400 * If "data" points to a data block encrypt the text in it and return a copy
5401 * in allocated memory. Return NULL when out of memory.
5402 * Otherwise return "data".
5403 */
5404 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005405ml_encrypt_data(
5406 memfile_T *mfp,
5407 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005408 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005409 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005410{
5411 DATA_BL *dp = (DATA_BL *)data;
5412 char_u *head_end;
5413 char_u *text_start;
5414 char_u *new_data;
5415 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005416 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005417
5418 if (dp->db_id != DATA_ID)
5419 return data;
5420
Bram Moolenaarbc563362015-06-09 18:35:25 +02005421 state = ml_crypt_prepare(mfp, offset, FALSE);
5422 if (state == NULL)
5423 return data;
5424
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005425 new_data = alloc(size);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005426 if (new_data == NULL)
5427 return NULL;
5428 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5429 text_start = (char_u *)dp + dp->db_txt_start;
5430 text_len = size - dp->db_txt_start;
5431
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005432 // Copy the header and the text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005433 mch_memmove(new_data, dp, head_end - (char_u *)dp);
5434
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005435 // Encrypt the text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02005436 crypt_encode(state, text_start, text_len, new_data + dp->db_txt_start,
5437 FALSE);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005438 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005439
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005440 // Clear the gap.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005441 if (head_end < text_start)
5442 vim_memset(new_data + (head_end - data), 0, text_start - head_end);
5443
5444 return new_data;
5445}
5446
5447/*
Bram Moolenaarbc563362015-06-09 18:35:25 +02005448 * Decrypt the text in "data" if it points to an encrypted data block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005449 */
5450 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005451ml_decrypt_data(
5452 memfile_T *mfp,
5453 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005454 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005455 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005456{
5457 DATA_BL *dp = (DATA_BL *)data;
5458 char_u *head_end;
5459 char_u *text_start;
5460 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005461 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005462
5463 if (dp->db_id == DATA_ID)
5464 {
5465 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5466 text_start = (char_u *)dp + dp->db_txt_start;
5467 text_len = dp->db_txt_end - dp->db_txt_start;
5468
5469 if (head_end > text_start || dp->db_txt_start > size
5470 || dp->db_txt_end > size)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005471 return; // data was messed up
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005472
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005473 state = ml_crypt_prepare(mfp, offset, TRUE);
Bram Moolenaarbc563362015-06-09 18:35:25 +02005474 if (state != NULL)
5475 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005476 // Decrypt the text in place.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02005477 crypt_decode_inplace(state, text_start, text_len, FALSE);
Bram Moolenaarbc563362015-06-09 18:35:25 +02005478 crypt_free_state(state);
5479 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005480 }
5481}
5482
5483/*
5484 * Prepare for encryption/decryption, using the key, seed and offset.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005485 * Return an allocated cryptstate_T *.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005486 */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005487 static cryptstate_T *
Bram Moolenaar8767f522016-07-01 17:17:39 +02005488ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005489{
5490 buf_T *buf = mfp->mf_buffer;
5491 char_u salt[50];
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005492 int method_nr;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005493 char_u *key;
5494 char_u *seed;
5495
5496 if (reading && mfp->mf_old_key != NULL)
5497 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005498 // Reading back blocks with the previous key/method/seed.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005499 method_nr = mfp->mf_old_cm;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005500 key = mfp->mf_old_key;
5501 seed = mfp->mf_old_seed;
5502 }
5503 else
5504 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005505 method_nr = crypt_get_method_nr(buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005506 key = buf->b_p_key;
5507 seed = mfp->mf_seed;
5508 }
Bram Moolenaarbc563362015-06-09 18:35:25 +02005509 if (*key == NUL)
5510 return NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005511
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005512 if (method_nr == CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005513 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005514 // For PKzip: Append the offset to the key, so that we use a different
5515 // key for every block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005516 vim_snprintf((char *)salt, sizeof(salt), "%s%ld", key, (long)offset);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005517 return crypt_create(method_nr, salt, NULL, 0, NULL, 0);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005518 }
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005519
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005520 // Using blowfish or better: add salt and seed. We use the byte offset
5521 // of the block for the salt.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005522 vim_snprintf((char *)salt, sizeof(salt), "%ld", (long)offset);
5523 return crypt_create(method_nr, key, salt, (int)STRLEN(salt),
Christian Brabandtf573c6e2021-06-20 14:02:16 +02005524 seed, MF_SEED_LEN);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005525}
5526
5527#endif
5528
5529
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530#if defined(FEAT_BYTEOFF) || defined(PROTO)
5531
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005532#define MLCS_MAXL 800 // max no of lines in chunk
5533#define MLCS_MINL 400 // should be half of MLCS_MAXL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534
5535/*
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02005536 * Keep information for finding byte offset of a line, updtype may be one of:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
5538 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
5539 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
5540 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
5541 */
5542 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005543ml_updatechunk(
5544 buf_T *buf,
5545 linenr_T line,
5546 long len,
5547 int updtype)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548{
5549 static buf_T *ml_upd_lastbuf = NULL;
5550 static linenr_T ml_upd_lastline;
5551 static linenr_T ml_upd_lastcurline;
5552 static int ml_upd_lastcurix;
5553
5554 linenr_T curline = ml_upd_lastcurline;
5555 int curix = ml_upd_lastcurix;
5556 long size;
5557 chunksize_T *curchnk;
5558 int rest;
5559 bhdr_T *hp;
5560 DATA_BL *dp;
5561
5562 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
5563 return;
5564 if (buf->b_ml.ml_chunksize == NULL)
5565 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005566 buf->b_ml.ml_chunksize = ALLOC_MULT(chunksize_T, 100);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 if (buf->b_ml.ml_chunksize == NULL)
5568 {
5569 buf->b_ml.ml_usedchunks = -1;
5570 return;
5571 }
5572 buf->b_ml.ml_numchunks = 100;
5573 buf->b_ml.ml_usedchunks = 1;
5574 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
5575 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
5576 }
5577
5578 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
5579 {
5580 /*
5581 * First line in empty buffer from ml_flush_line() -- reset
5582 */
5583 buf->b_ml.ml_usedchunks = 1;
5584 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01005585 buf->b_ml.ml_chunksize[0].mlcs_totalsize = (long)buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 return;
5587 }
5588
5589 /*
5590 * Find chunk that our line belongs to, curline will be at start of the
5591 * chunk.
5592 */
5593 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
5594 || updtype != ML_CHNK_ADDLINE)
5595 {
5596 for (curline = 1, curix = 0;
5597 curix < buf->b_ml.ml_usedchunks - 1
5598 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5599 curix++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 }
Bram Moolenaara9a8e042018-10-30 22:15:55 +01005602 else if (curix < buf->b_ml.ml_usedchunks - 1
5603 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005605 // Adjust cached curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5607 curix++;
5608 }
5609 curchnk = buf->b_ml.ml_chunksize + curix;
5610
5611 if (updtype == ML_CHNK_DELLINE)
Bram Moolenaar5a6404c2006-11-01 17:12:57 +00005612 len = -len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 curchnk->mlcs_totalsize += len;
5614 if (updtype == ML_CHNK_ADDLINE)
5615 {
5616 curchnk->mlcs_numlines++;
5617
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005618 // May resize here so we don't have to do it in both cases below
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
5620 {
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005621 chunksize_T *t_chunksize = buf->b_ml.ml_chunksize;
5622
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
Bram Moolenaar51b6eb42020-08-22 15:19:18 +02005624 buf->b_ml.ml_chunksize = vim_realloc(buf->b_ml.ml_chunksize,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
5626 if (buf->b_ml.ml_chunksize == NULL)
5627 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005628 // Hmmmm, Give up on offset for this buffer
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005629 vim_free(t_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 buf->b_ml.ml_usedchunks = -1;
5631 return;
5632 }
5633 }
5634
5635 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
5636 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005637 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 int idx;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005639 int end_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 int text_end;
5641 int linecnt;
5642
5643 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
5644 buf->b_ml.ml_chunksize + curix,
5645 (buf->b_ml.ml_usedchunks - curix) *
5646 sizeof(chunksize_T));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005647 // Compute length of first half of lines in the split chunk
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648 size = 0;
5649 linecnt = 0;
5650 while (curline < buf->b_ml.ml_line_count
5651 && linecnt < MLCS_MINL)
5652 {
5653 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5654 {
5655 buf->b_ml.ml_usedchunks = -1;
5656 return;
5657 }
5658 dp = (DATA_BL *)(hp->bh_data);
5659 count = (long)(buf->b_ml.ml_locked_high) -
5660 (long)(buf->b_ml.ml_locked_low) + 1;
5661 idx = curline - buf->b_ml.ml_locked_low;
5662 curline = buf->b_ml.ml_locked_high + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005663
5664 // compute index of last line to use in this MEMLINE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 rest = count - idx;
5666 if (linecnt + rest > MLCS_MINL)
5667 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005668 end_idx = idx + MLCS_MINL - linecnt - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 linecnt = MLCS_MINL;
5670 }
5671 else
5672 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005673 end_idx = count - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 linecnt += rest;
5675 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005676#ifdef FEAT_PROP_POPUP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005677 if (buf->b_has_textprop)
5678 {
5679 int i;
5680
5681 // We cannot use the text pointers to get the text length,
5682 // the text prop info would also be counted. Go over the
5683 // lines.
5684 for (i = end_idx; i < idx; ++i)
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005685 size += (int)STRLEN((char_u *)dp
5686 + (dp->db_index[i] & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005687 }
5688 else
5689#endif
5690 {
Bram Moolenaar14c75302021-08-15 14:28:40 +02005691 if (idx == 0) // first line in block, text at the end
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005692 text_end = dp->db_txt_end;
5693 else
5694 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005695 size += text_end
5696 - ((dp->db_index[end_idx]) & DB_INDEX_MASK);
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005697 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 }
5699 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
5700 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
5701 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
5702 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
5703 buf->b_ml.ml_usedchunks++;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005704 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 return;
5706 }
5707 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
5708 && curix == buf->b_ml.ml_usedchunks - 1
5709 && buf->b_ml.ml_line_count - line <= 1)
5710 {
5711 /*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01005712 * We are in the last chunk and it is cheap to create a new one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 * after this. Do it now to avoid the loop above later on
5714 */
5715 curchnk = buf->b_ml.ml_chunksize + curix + 1;
5716 buf->b_ml.ml_usedchunks++;
5717 if (line == buf->b_ml.ml_line_count)
5718 {
5719 curchnk->mlcs_numlines = 0;
5720 curchnk->mlcs_totalsize = 0;
5721 }
5722 else
5723 {
5724 /*
5725 * Line is just prior to last, move count for last
5726 * This is the common case when loading a new file
5727 */
5728 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
5729 if (hp == NULL)
5730 {
5731 buf->b_ml.ml_usedchunks = -1;
5732 return;
5733 }
5734 dp = (DATA_BL *)(hp->bh_data);
5735 if (dp->db_line_count == 1)
5736 rest = dp->db_txt_end - dp->db_txt_start;
5737 else
5738 rest =
5739 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
5740 - dp->db_txt_start;
5741 curchnk->mlcs_totalsize = rest;
5742 curchnk->mlcs_numlines = 1;
5743 curchnk[-1].mlcs_totalsize -= rest;
5744 curchnk[-1].mlcs_numlines -= 1;
5745 }
5746 }
5747 }
5748 else if (updtype == ML_CHNK_DELLINE)
5749 {
5750 curchnk->mlcs_numlines--;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005751 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005752 if (curix < buf->b_ml.ml_usedchunks - 1
5753 && curchnk->mlcs_numlines + curchnk[1].mlcs_numlines
5754 <= MLCS_MINL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 {
5756 curix++;
5757 curchnk = buf->b_ml.ml_chunksize + curix;
5758 }
5759 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
5760 {
5761 buf->b_ml.ml_usedchunks--;
5762 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
5763 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
5764 return;
5765 }
5766 else if (curix == 0 || (curchnk->mlcs_numlines > 10
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005767 && curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines
5768 > MLCS_MINL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 {
5770 return;
5771 }
5772
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005773 // Collapse chunks
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
5775 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
5776 buf->b_ml.ml_usedchunks--;
5777 if (curix < buf->b_ml.ml_usedchunks)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 mch_memmove(buf->b_ml.ml_chunksize + curix,
5779 buf->b_ml.ml_chunksize + curix + 1,
5780 (buf->b_ml.ml_usedchunks - curix) *
5781 sizeof(chunksize_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782 return;
5783 }
5784 ml_upd_lastbuf = buf;
5785 ml_upd_lastline = line;
5786 ml_upd_lastcurline = curline;
5787 ml_upd_lastcurix = curix;
5788}
5789
5790/*
5791 * Find offset for line or line with offset.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005792 * Find line with offset if "lnum" is 0; return remaining offset in offp
5793 * Find offset of line if "lnum" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 * return -1 if information is not available
5795 */
5796 long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005797ml_find_line_or_offset(buf_T *buf, linenr_T lnum, long *offp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798{
5799 linenr_T curline;
5800 int curix;
5801 long size;
5802 bhdr_T *hp;
5803 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005804 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 int idx;
5806 int start_idx;
5807 int text_end;
5808 long offset;
5809 int len;
5810 int ffdos = (get_fileformat(buf) == EOL_DOS);
5811 int extra = 0;
5812
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005813 // take care of cached line first
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005814 ml_flush_line(curbuf);
5815
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 if (buf->b_ml.ml_usedchunks == -1
5817 || buf->b_ml.ml_chunksize == NULL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005818 || lnum < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 return -1;
5820
5821 if (offp == NULL)
5822 offset = 0;
5823 else
5824 offset = *offp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005825 if (lnum == 0 && offset <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005826 return 1; // Not a "find offset" and offset 0 _must_ be in line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 /*
5828 * Find the last chunk before the one containing our line. Last chunk is
Bram Moolenaar14c75302021-08-15 14:28:40 +02005829 * special because it will never qualify.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 */
5831 curline = 1;
5832 curix = size = 0;
5833 while (curix < buf->b_ml.ml_usedchunks - 1
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005834 && ((lnum != 0
5835 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 || (offset != 0
5837 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
=?UTF-8?q?Dundar=20G=C3=B6c?=d5cec1f2022-01-29 15:19:23 +00005838 + (long)ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 {
5840 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5841 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
5842 if (offset && ffdos)
5843 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5844 curix++;
5845 }
5846
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005847 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 {
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005849#ifdef FEAT_PROP_POPUP
5850 size_t textprop_total = 0;
5851#endif
5852
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 if (curline > buf->b_ml.ml_line_count
5854 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5855 return -1;
5856 dp = (DATA_BL *)(hp->bh_data);
5857 count = (long)(buf->b_ml.ml_locked_high) -
5858 (long)(buf->b_ml.ml_locked_low) + 1;
5859 start_idx = idx = curline - buf->b_ml.ml_locked_low;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005860 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 text_end = dp->db_txt_end;
5862 else
5863 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005864 // Compute index of last line to use in this MEMLINE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005865 if (lnum != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005867 if (curline + (count - idx) >= lnum)
5868 idx += lnum - curline - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 else
5870 idx = count - 1;
5871 }
5872 else
5873 {
5874 extra = 0;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005875 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 {
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005877#ifdef FEAT_PROP_POPUP
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005878 size_t textprop_size = 0;
5879
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005880 if (buf->b_has_textprop)
5881 {
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005882 char_u *l1, *l2;
5883
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005884 // compensate for the extra bytes taken by textprops
5885 l1 = (char_u *)dp + ((dp->db_index[idx]) & DB_INDEX_MASK);
5886 l2 = (char_u *)dp + (idx == 0 ? dp->db_txt_end
5887 : ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
5888 textprop_size = (l2 - l1) - (STRLEN(l1) + 1);
5889 }
5890#endif
5891 if (!(offset >= size
5892 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
5893#ifdef FEAT_PROP_POPUP
Bram Moolenaar94b6fb72020-01-17 21:00:59 +01005894 - (long)(textprop_total + textprop_size)
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005895#endif
5896 + ffdos))
5897 break;
5898
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 if (ffdos)
5900 size++;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005901#ifdef FEAT_PROP_POPUP
5902 textprop_total += textprop_size;
5903#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 if (idx == count - 1)
5905 {
5906 extra = 1;
5907 break;
5908 }
5909 idx++;
5910 }
5911 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005912#ifdef FEAT_PROP_POPUP
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005913 if (buf->b_has_textprop && lnum != 0)
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005914 {
5915 int i;
5916
5917 // cannot use the db_index pointer, need to get the actual text
5918 // lengths.
5919 len = 0;
5920 for (i = start_idx; i <= idx; ++i)
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005921 {
5922 char_u *p = (char_u *)dp + ((dp->db_index[i]) & DB_INDEX_MASK);
5923 len += (int)STRLEN(p) + 1;
5924 }
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005925 }
5926 else
5927#endif
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005928 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK)
5929#ifdef FEAT_PROP_POPUP
5930 - (long)textprop_total
5931#endif
5932 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 size += len;
5934 if (offset != 0 && size >= offset)
5935 {
5936 if (size + ffdos == offset)
5937 *offp = 0;
5938 else if (idx == start_idx)
5939 *offp = offset - size + len;
5940 else
5941 *offp = offset - size + len
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005942 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK))
5943#ifdef FEAT_PROP_POPUP
5944 + (long)textprop_total
5945#endif
5946 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 curline += idx - start_idx + extra;
5948 if (curline > buf->b_ml.ml_line_count)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005949 return -1; // exactly one byte beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 return curline;
5951 }
5952 curline = buf->b_ml.ml_locked_high + 1;
5953 }
5954
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005955 if (lnum != 0)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005956 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005957 // Count extra CR characters.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005958 if (ffdos)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005959 size += lnum - 1;
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005960
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005961 // Don't count the last line break if 'noeol' and ('bin' or
5962 // 'nofixeol').
Bram Moolenaar34d72d42015-07-17 14:18:08 +02005963 if ((!buf->b_p_fixeol || buf->b_p_bin) && !buf->b_p_eol
Bram Moolenaarc26f7c62018-08-20 22:53:04 +02005964 && lnum > buf->b_ml.ml_line_count)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005965 size -= ffdos + 1;
5966 }
5967
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 return size;
5969}
5970
5971/*
5972 * Goto byte in buffer with offset 'cnt'.
5973 */
5974 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005975goto_byte(long cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976{
5977 long boff = cnt;
5978 linenr_T lnum;
5979
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005980 ml_flush_line(curbuf); // cached line may be dirty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 setpcmark();
5982 if (boff)
5983 --boff;
5984 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005985 if (lnum < 1) // past the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 {
5987 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
5988 curwin->w_curswant = MAXCOL;
5989 coladvance((colnr_T)MAXCOL);
5990 }
5991 else
5992 {
5993 curwin->w_cursor.lnum = lnum;
5994 curwin->w_cursor.col = (colnr_T)boff;
Bram Moolenaar943d2b52005-12-02 00:50:49 +00005995 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 curwin->w_set_curswant = TRUE;
5997 }
5998 check_cursor();
5999
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006000 // Make sure the cursor is on the first byte of a multi-byte char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 if (has_mbyte)
6002 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003}
6004#endif