blob: af354a5bffbca854274bfcc674e782a0ab25d58f [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010010// for debugging
11// #define CHECK(c, s) do { if (c) emsg((s)); } while (0)
Bram Moolenaar6f470022018-04-10 18:47:20 +020012#define CHECK(c, s) do { /**/ } while (0)
Bram Moolenaar071d4272004-06-13 20:20:40 +000013
14/*
15 * memline.c: Contains the functions for appending, deleting and changing the
Bram Moolenaar4770d092006-01-12 23:22:24 +000016 * text lines. The memfile functions are used to store the information in
17 * blocks of memory, backed up by a file. The structure of the information is
18 * a tree. The root of the tree is a pointer block. The leaves of the tree
19 * are data blocks. In between may be several layers of pointer blocks,
20 * forming branches.
Bram Moolenaar071d4272004-06-13 20:20:40 +000021 *
22 * Three types of blocks are used:
23 * - Block nr 0 contains information for recovery
24 * - Pointer blocks contain list of pointers to other blocks.
25 * - Data blocks contain the actual text.
26 *
27 * Block nr 0 contains the block0 structure (see below).
28 *
29 * Block nr 1 is the first pointer block. It is the root of the tree.
30 * Other pointer blocks are branches.
31 *
32 * If a line is too big to fit in a single page, the block containing that
33 * line is made big enough to hold the line. It may span several pages.
34 * Otherwise all blocks are one page.
35 *
36 * A data block that was filled when starting to edit a file and was not
37 * changed since then, can have a negative block number. This means that it
38 * has not yet been assigned a place in the file. When recovering, the lines
39 * in this data block can be read from the original file. When the block is
40 * changed (lines appended/deleted/changed) or when it is flushed it gets a
41 * positive number. Use mf_trans_del() to get the new number, before calling
42 * mf_get().
43 */
44
Bram Moolenaar071d4272004-06-13 20:20:40 +000045#include "vim.h"
46
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010047#ifndef UNIX // it's in os_unix.h for Unix
Bram Moolenaar071d4272004-06-13 20:20:40 +000048# include <time.h>
49#endif
50
Bram Moolenaar5a6404c2006-11-01 17:12:57 +000051#if defined(SASC) || defined(__amigaos4__)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010052# include <proto/dos.h> // for Open() and Close()
Bram Moolenaar071d4272004-06-13 20:20:40 +000053#endif
54
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010055typedef struct block0 ZERO_BL; // contents of the first block
56typedef struct pointer_block PTR_BL; // contents of a pointer block
57typedef struct data_block DATA_BL; // contents of a data block
58typedef struct pointer_entry PTR_EN; // block/line-count pair
Bram Moolenaar071d4272004-06-13 20:20:40 +000059
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010060#define DATA_ID (('d' << 8) + 'a') // data block id
61#define PTR_ID (('p' << 8) + 't') // pointer block id
62#define BLOCK0_ID0 'b' // block 0 id 0
63#define BLOCK0_ID1 '0' // block 0 id 1
64#define BLOCK0_ID1_C0 'c' // block 0 id 1 'cm' 0
65#define BLOCK0_ID1_C1 'C' // block 0 id 1 'cm' 1
66#define BLOCK0_ID1_C2 'd' // block 0 id 1 'cm' 2
Bram Moolenaare1b48222023-04-24 18:11:35 +010067// BLOCK0_ID1_C3 and BLOCK0_ID1_C4 are for libsodium enctyption. However, for
68// these the swapfile is disabled, thus they will not be used. Added for
69// consistency anyway.
70#define BLOCK0_ID1_C3 'S' // block 0 id 1 'cm' 3
71#define BLOCK0_ID1_C4 's' // block 0 id 1 'cm' 4
Bram Moolenaar8f4ac012014-08-10 13:38:34 +020072
73#if defined(FEAT_CRYPT)
74static int id1_codes[] = {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010075 BLOCK0_ID1_C0, // CRYPT_M_ZIP
76 BLOCK0_ID1_C1, // CRYPT_M_BF
77 BLOCK0_ID1_C2, // CRYPT_M_BF2
Christian Brabandtf573c6e2021-06-20 14:02:16 +020078 BLOCK0_ID1_C3, // CRYPT_M_SOD - Unused!
Bram Moolenaare1b48222023-04-24 18:11:35 +010079 BLOCK0_ID1_C4, // CRYPT_M_SOD2 - Unused!
Bram Moolenaar8f4ac012014-08-10 13:38:34 +020080};
81#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000082
83/*
84 * pointer to a block, used in a pointer block
85 */
86struct pointer_entry
87{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010088 blocknr_T pe_bnum; // block number
89 linenr_T pe_line_count; // number of lines in this branch
90 linenr_T pe_old_lnum; // lnum for this block (for recovery)
91 int pe_page_count; // number of pages in block pe_bnum
Bram Moolenaar071d4272004-06-13 20:20:40 +000092};
93
94/*
95 * A pointer block contains a list of branches in the tree.
96 */
97struct pointer_block
98{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +010099 short_u pb_id; // ID for pointer block: PTR_ID
100 short_u pb_count; // number of pointers in this block
101 short_u pb_count_max; // maximum value for pb_count
102 PTR_EN pb_pointer[1]; // list of pointers to blocks (actually longer)
103 // followed by empty space until end of page
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104};
105
Bram Moolenaarb67ba032023-04-22 21:14:26 +0100106// Value for pb_count_max.
107#define PB_COUNT_MAX(mfp) (short_u)(((mfp)->mf_page_size - offsetof(PTR_BL, pb_pointer)) / sizeof(PTR_EN))
108
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109/*
110 * A data block is a leaf in the tree.
111 *
112 * The text of the lines is at the end of the block. The text of the first line
113 * in the block is put at the end, the text of the second line in front of it,
114 * etc. Thus the order of the lines is the opposite of the line number.
115 */
116struct data_block
117{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100118 short_u db_id; // ID for data block: DATA_ID
119 unsigned db_free; // free space available
120 unsigned db_txt_start; // byte where text starts
121 unsigned db_txt_end; // byte just after data block
122 linenr_T db_line_count; // number of lines in this block
123 unsigned db_index[1]; // index for start of line (actually bigger)
Bram Moolenaar4b96df52020-01-26 22:00:26 +0100124 // followed by empty space up to db_txt_start
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100125 // followed by the text in the lines until
126 // end of page
Bram Moolenaar071d4272004-06-13 20:20:40 +0000127};
128
129/*
130 * The low bits of db_index hold the actual index. The topmost bit is
131 * used for the global command to be able to mark a line.
132 * This method is not clean, but otherwise there would be at least one extra
133 * byte used for each line.
134 * The mark has to be in this place to keep it with the correct line when other
135 * lines are inserted or deleted.
136 */
137#define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
138#define DB_INDEX_MASK (~DB_MARKED)
139
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100140#define INDEX_SIZE (sizeof(unsigned)) // size of one db_index entry
zeertzjq1b438a82023-02-01 13:11:15 +0000141#define HEADER_SIZE (offsetof(DATA_BL, db_index)) // size of data block header
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100143#define B0_FNAME_SIZE_ORG 900 // what it was in older versions
144#define B0_FNAME_SIZE_NOCRYPT 898 // 2 bytes used for other things
145#define B0_FNAME_SIZE_CRYPT 890 // 10 bytes used for other things
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000146#define B0_UNAME_SIZE 40
147#define B0_HNAME_SIZE 40
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148/*
149 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
150 * This won't detect a 64 bit machine that only swaps a byte in the top 32
151 * bits, but that is crazy anyway.
152 */
153#define B0_MAGIC_LONG 0x30313233L
154#define B0_MAGIC_INT 0x20212223L
155#define B0_MAGIC_SHORT 0x10111213L
156#define B0_MAGIC_CHAR 0x55
157
158/*
159 * Block zero holds all info about the swap file.
160 *
161 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
162 * swap files unusable!
163 *
164 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
165 *
Bram Moolenaarbae0c162007-05-10 19:30:25 +0000166 * This block is built up of single bytes, to make it portable across
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 * different machines. b0_magic_* is used to check the byte order and size of
168 * variables, because the rest of the swap file is not portable.
169 */
170struct block0
171{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100172 char_u b0_id[2]; // id for block 0: BLOCK0_ID0 and BLOCK0_ID1,
173 // BLOCK0_ID1_C0, BLOCK0_ID1_C1, etc.
174 char_u b0_version[10]; // Vim version string
175 char_u b0_page_size[4];// number of bytes per page
176 char_u b0_mtime[4]; // last modification time of file
177 char_u b0_ino[4]; // inode of b0_fname
178 char_u b0_pid[4]; // process id of creator (or 0)
179 char_u b0_uname[B0_UNAME_SIZE]; // name of user (uid if no name)
180 char_u b0_hname[B0_HNAME_SIZE]; // host name (if it has a name)
181 char_u b0_fname[B0_FNAME_SIZE_ORG]; // name of file being edited
182 long b0_magic_long; // check for byte order of long
183 int b0_magic_int; // check for byte order of int
184 short b0_magic_short; // check for byte order of short
185 char_u b0_magic_char; // check for last char
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186};
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000187
188/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000189 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000190 * long file names in older versions of Vim they are invalid.
191 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
192 * when there is room, for very long file names it's omitted.
193 */
194#define B0_DIRTY 0x55
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200195#define b0_dirty b0_fname[B0_FNAME_SIZE_ORG - 1]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000196
197/*
198 * The b0_flags field is new in Vim 7.0.
199 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200200#define b0_flags b0_fname[B0_FNAME_SIZE_ORG - 2]
201
202/*
203 * Crypt seed goes here, 8 bytes. New in Vim 7.3.
204 * Without encryption these bytes may be used for 'fenc'.
205 */
206#define b0_seed b0_fname[B0_FNAME_SIZE_ORG - 2 - MF_SEED_LEN]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000207
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100208// The lowest two bits contain the fileformat. Zero means it's not set
209// (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
210// EOL_MAC + 1.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000211#define B0_FF_MASK 3
212
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100213// Swap file is in directory of edited file. Used to find the file from
214// different mount points.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000215#define B0_SAME_DIR 4
216
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100217// The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
218// When empty there is only the NUL.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000219#define B0_HAS_FENC 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100221#define STACK_INCR 5 // nr of entries added to ml_stack at a time
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222
223/*
224 * The line number where the first mark may be is remembered.
225 * If it is 0 there are no marks at all.
226 * (always used for the current buffer only, no buffer change possible while
227 * executing a global command).
228 */
229static linenr_T lowest_marked = 0;
230
231/*
232 * arguments for ml_find_line()
233 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100234#define ML_DELETE 0x11 // delete line
235#define ML_INSERT 0x12 // insert line
236#define ML_FIND 0x13 // just find the line
237#define ML_FLUSH 0x02 // flush locked block
kylo252ae6f1d82022-02-16 19:24:07 +0000238#define ML_SIMPLE(x) ((x) & 0x10) // DEL, INS or FIND
Bram Moolenaar071d4272004-06-13 20:20:40 +0000239
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100240// argument for ml_upd_block0()
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200241typedef enum {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100242 UB_FNAME = 0 // update timestamp and filename
243 , UB_SAME_DIR // update the B0_SAME_DIR flag
244 , UB_CRYPT // update crypt key
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200245} upd_block0_T;
246
247#ifdef FEAT_CRYPT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100248static void ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200249#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100250static void ml_upd_block0(buf_T *buf, upd_block0_T what);
251static void set_b0_fname(ZERO_BL *, buf_T *buf);
252static void set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100253static void add_b0_fenc(ZERO_BL *b0p, buf_T *buf);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100254static time_t swapfile_info(char_u *);
255static int recov_file_names(char_u **, char_u *, int prepend_dot);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100256static char_u *findswapname(buf_T *, char_u **, char_u *);
257static void ml_flush_line(buf_T *);
258static bhdr_T *ml_new_data(memfile_T *, int, int);
259static bhdr_T *ml_new_ptr(memfile_T *);
260static bhdr_T *ml_find_line(buf_T *, linenr_T, int);
261static int ml_add_stack(buf_T *);
262static void ml_lineadd(buf_T *, int);
263static int b0_magic_wrong(ZERO_BL *);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264#ifdef CHECK_INODE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100265static int fnamecmp_ino(char_u *, char_u *, long);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100267static void long_to_char(long, char_u *);
268static long char_to_long(char_u *);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200269#ifdef FEAT_CRYPT
Bram Moolenaar8767f522016-07-01 17:17:39 +0200270static cryptstate_T *ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200271#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272#ifdef FEAT_BYTEOFF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100273static void ml_updatechunk(buf_T *buf, long line, long len, int updtype);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274#endif
275
276/*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000277 * Open a new memline for "buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278 *
Bram Moolenaar4770d092006-01-12 23:22:24 +0000279 * Return FAIL for failure, OK otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 */
281 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100282ml_open(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283{
284 memfile_T *mfp;
285 bhdr_T *hp = NULL;
286 ZERO_BL *b0p;
287 PTR_BL *pp;
288 DATA_BL *dp;
289
Bram Moolenaar4770d092006-01-12 23:22:24 +0000290 /*
291 * init fields in memline struct
292 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100293 buf->b_ml.ml_stack_size = 0; // no stack yet
294 buf->b_ml.ml_stack = NULL; // no stack yet
295 buf->b_ml.ml_stack_top = 0; // nothing in the stack
296 buf->b_ml.ml_locked = NULL; // no cached block
297 buf->b_ml.ml_line_lnum = 0; // no cached line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298#ifdef FEAT_BYTEOFF
Bram Moolenaar4770d092006-01-12 23:22:24 +0000299 buf->b_ml.ml_chunksize = NULL;
Bram Moolenaardf9070e2021-08-25 17:31:37 +0200300 buf->b_ml.ml_usedchunks = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301#endif
302
Bram Moolenaare1004402020-10-24 20:49:43 +0200303 if (cmdmod.cmod_flags & CMOD_NOSWAPFILE)
Bram Moolenaar5803ae62014-03-23 16:04:02 +0100304 buf->b_p_swf = FALSE;
305
Bram Moolenaar4770d092006-01-12 23:22:24 +0000306 /*
307 * When 'updatecount' is non-zero swap file may be opened later.
308 */
309 if (p_uc && buf->b_p_swf)
310 buf->b_may_swap = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 else
Bram Moolenaar4770d092006-01-12 23:22:24 +0000312 buf->b_may_swap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313
Bram Moolenaar4770d092006-01-12 23:22:24 +0000314 /*
315 * Open the memfile. No swap file is created yet.
316 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 mfp = mf_open(NULL, 0);
318 if (mfp == NULL)
319 goto error;
320
Bram Moolenaar4770d092006-01-12 23:22:24 +0000321 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200322#ifdef FEAT_CRYPT
323 mfp->mf_buffer = buf;
324#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000325 buf->b_ml.ml_flags = ML_EMPTY;
326 buf->b_ml.ml_line_count = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328/*
329 * fill block0 struct and write page 0
330 */
331 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
332 goto error;
333 if (hp->bh_bnum != 0)
334 {
Bram Moolenaar9a846fb2022-01-01 21:59:18 +0000335 iemsg(_(e_didnt_get_block_nr_zero));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336 goto error;
337 }
338 b0p = (ZERO_BL *)(hp->bh_data);
339
340 b0p->b0_id[0] = BLOCK0_ID0;
341 b0p->b0_id[1] = BLOCK0_ID1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
343 b0p->b0_magic_int = (int)B0_MAGIC_INT;
344 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
345 b0p->b0_magic_char = B0_MAGIC_CHAR;
Bram Moolenaar22c10562018-05-26 17:35:27 +0200346 mch_memmove(b0p->b0_version, "VIM ", 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347 STRNCPY(b0p->b0_version + 4, Version, 6);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000349
Bram Moolenaar76b92b22006-03-24 22:46:53 +0000350#ifdef FEAT_SPELL
351 if (!buf->b_spell)
352#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000353 {
354 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
355 b0p->b0_flags = get_fileformat(buf) + 1;
356 set_b0_fname(b0p, buf);
357 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
358 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
359 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
360 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
361 long_to_char(mch_get_pid(), b0p->b0_pid);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200362#ifdef FEAT_CRYPT
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200363 ml_set_b0_crypt(buf, b0p);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200364#endif
Bram Moolenaar4770d092006-01-12 23:22:24 +0000365 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366
367 /*
368 * Always sync block number 0 to disk, so we can check the file name in
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200369 * the swap file in findswapname(). Don't do this for a help files or
370 * a spell buffer though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371 * Only works when there's a swapfile, otherwise it's done when the file
372 * is created.
373 */
374 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000375 if (!buf->b_help && !B_SPELL(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 (void)mf_sync(mfp, 0);
377
Bram Moolenaar4770d092006-01-12 23:22:24 +0000378 /*
379 * Fill in root pointer block and write page 1.
380 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381 if ((hp = ml_new_ptr(mfp)) == NULL)
382 goto error;
383 if (hp->bh_bnum != 1)
384 {
Bram Moolenaar9a846fb2022-01-01 21:59:18 +0000385 iemsg(_(e_didnt_get_block_nr_one));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386 goto error;
387 }
388 pp = (PTR_BL *)(hp->bh_data);
389 pp->pb_count = 1;
390 pp->pb_pointer[0].pe_bnum = 2;
391 pp->pb_pointer[0].pe_page_count = 1;
392 pp->pb_pointer[0].pe_old_lnum = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100393 pp->pb_pointer[0].pe_line_count = 1; // line count after insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394 mf_put(mfp, hp, TRUE, FALSE);
395
Bram Moolenaar4770d092006-01-12 23:22:24 +0000396 /*
397 * Allocate first data block and create an empty line 1.
398 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
400 goto error;
401 if (hp->bh_bnum != 2)
402 {
Bram Moolenaar9a846fb2022-01-01 21:59:18 +0000403 iemsg(_(e_didnt_get_block_nr_two));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404 goto error;
405 }
406
407 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100408 dp->db_index[0] = --dp->db_txt_start; // at end of block
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 dp->db_free -= 1 + INDEX_SIZE;
410 dp->db_line_count = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100411 *((char_u *)dp + dp->db_txt_start) = NUL; // empty line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412
413 return OK;
414
415error:
416 if (mfp != NULL)
417 {
418 if (hp)
419 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100420 mf_close(mfp, TRUE); // will also free(mfp->mf_fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 }
Bram Moolenaar4770d092006-01-12 23:22:24 +0000422 buf->b_ml.ml_mfp = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423 return FAIL;
424}
425
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200426#if defined(FEAT_CRYPT) || defined(PROTO)
427/*
Bram Moolenaar2be79502014-08-13 21:58:28 +0200428 * Prepare encryption for "buf" for the current key and method.
429 */
430 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100431ml_set_mfp_crypt(buf_T *buf)
Bram Moolenaar2be79502014-08-13 21:58:28 +0200432{
Yegappan Lakshmanane8575982023-01-14 12:32:28 +0000433 if (*buf->b_p_key == NUL)
434 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200435
Yegappan Lakshmanane8575982023-01-14 12:32:28 +0000436 int method_nr = crypt_get_method_nr(buf);
437
438 if (method_nr > CRYPT_M_ZIP && method_nr < CRYPT_M_SOD)
439 {
440 // Generate a seed and store it in the memfile.
441 sha2_seed(buf->b_ml.ml_mfp->mf_seed, MF_SEED_LEN, NULL, 0);
Bram Moolenaar2be79502014-08-13 21:58:28 +0200442 }
Yegappan Lakshmanane8575982023-01-14 12:32:28 +0000443#ifdef FEAT_SODIUM
Christian Brabandtaae58342023-04-23 17:50:22 +0100444 else if (crypt_method_is_sodium(method_nr))
Yegappan Lakshmanane8575982023-01-14 12:32:28 +0000445 crypt_sodium_randombytes_buf(buf->b_ml.ml_mfp->mf_seed,
446 MF_SEED_LEN);
447#endif
Bram Moolenaar2be79502014-08-13 21:58:28 +0200448}
449
450/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200451 * Prepare encryption for "buf" with block 0 "b0p".
Bram Moolenaare1b48222023-04-24 18:11:35 +0100452 * Note: should not be called with libsodium encryption, since xchacha20 does
453 * not support swapfile encryption.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200454 */
455 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100456ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200457{
458 if (*buf->b_p_key == NUL)
459 b0p->b0_id[1] = BLOCK0_ID1;
460 else
461 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200462 int method_nr = crypt_get_method_nr(buf);
463
464 b0p->b0_id[1] = id1_codes[method_nr];
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200465 if (method_nr > CRYPT_M_ZIP && method_nr < CRYPT_M_SOD)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200466 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100467 // Generate a seed and store it in block 0 and in the memfile.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200468 sha2_seed(&b0p->b0_seed, MF_SEED_LEN, NULL, 0);
469 mch_memmove(buf->b_ml.ml_mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
470 }
471 }
472}
473
474/*
475 * Called after the crypt key or 'cryptmethod' was changed for "buf".
476 * Will apply this to the swapfile.
477 * "old_key" is the previous key. It is equal to buf->b_p_key when
478 * 'cryptmethod' is changed.
Bram Moolenaar49771f42010-07-20 17:32:38 +0200479 * "old_cm" is the previous 'cryptmethod'. It is equal to the current
480 * 'cryptmethod' when 'key' is changed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200481 */
482 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100483ml_set_crypt_key(
484 buf_T *buf,
485 char_u *old_key,
486 char_u *old_cm)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200487{
488 memfile_T *mfp = buf->b_ml.ml_mfp;
489 bhdr_T *hp;
490 int page_count;
491 int idx;
492 long error;
493 infoptr_T *ip;
494 PTR_BL *pp;
495 DATA_BL *dp;
496 blocknr_T bnum;
497 int top;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200498 int old_method;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200499
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200500 if (mfp == NULL || mfp->mf_fd < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100501 return; // no memfile yet, nothing to do
Bram Moolenaarbc563362015-06-09 18:35:25 +0200502 old_method = crypt_method_nr_from_name(old_cm);
503
Bram Moolenaare1b48222023-04-24 18:11:35 +0100504 // Swapfile encryption is not supported by XChaCha20, therefore disable the
505 // swapfile to avoid plain text being written to disk.
506 if (crypt_method_is_sodium(crypt_get_method_nr(buf))
507 && *buf->b_p_key != NUL)
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200508 {
509 // close the swapfile
510 mf_close_file(buf, TRUE);
511 buf->b_p_swf = FALSE;
512 return;
513 }
Bram Moolenaare1b48222023-04-24 18:11:35 +0100514
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100515 // First make sure the swapfile is in a consistent state, using the old
516 // key and method.
Bram Moolenaarbc563362015-06-09 18:35:25 +0200517 {
518 char_u *new_key = buf->b_p_key;
519 char_u *new_buf_cm = buf->b_p_cm;
520
521 buf->b_p_key = old_key;
522 buf->b_p_cm = old_cm;
523 ml_preserve(buf, FALSE);
524 buf->b_p_key = new_key;
525 buf->b_p_cm = new_buf_cm;
526 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200527
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100528 // Set the key, method and seed to be used for reading, these must be the
529 // old values.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200530 mfp->mf_old_key = old_key;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200531 mfp->mf_old_cm = old_method;
532 if (old_method > 0 && *old_key != NUL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200533 mch_memmove(mfp->mf_old_seed, mfp->mf_seed, MF_SEED_LEN);
534
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100535 // Update block 0 with the crypt flag and may set a new seed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200536 ml_upd_block0(buf, UB_CRYPT);
537
538 if (mfp->mf_infile_count > 2)
539 {
540 /*
541 * Need to read back all data blocks from disk, decrypt them with the
542 * old key/method and mark them to be written. The algorithm is
543 * similar to what happens in ml_recover(), but we skip negative block
544 * numbers.
545 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100546 ml_flush_line(buf); // flush buffered line
547 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200548
549 hp = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100550 bnum = 1; // start with block 1
551 page_count = 1; // which is 1 page
552 idx = 0; // start with first index in block 1
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200553 error = 0;
554 buf->b_ml.ml_stack_top = 0;
Bram Moolenaard23a8232018-02-10 18:45:26 +0100555 VIM_CLEAR(buf->b_ml.ml_stack);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100556 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200557
558 for ( ; !got_int; line_breakcheck())
559 {
560 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100561 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200562
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100563 // get the block (pointer or data)
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +0000564 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200565 {
566 if (bnum == 1)
567 break;
568 ++error;
569 }
570 else
571 {
572 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100573 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200574 {
575 if (pp->pb_count == 0)
576 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100577 // empty block?
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200578 ++error;
579 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100580 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200581 {
582 if (pp->pb_pointer[idx].pe_bnum < 0)
583 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100584 // Skip data block with negative block number.
585 // Should not happen, because of the ml_preserve()
586 // above. Get same block again for next index.
Bram Moolenaar4b7214e2019-01-03 21:55:32 +0100587 ++idx;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200588 continue;
589 }
590
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100591 // going one block deeper in the tree, new entry in
592 // stack
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200593 if ((top = ml_add_stack(buf)) < 0)
594 {
595 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100596 break; // out of memory
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200597 }
598 ip = &(buf->b_ml.ml_stack[top]);
599 ip->ip_bnum = bnum;
600 ip->ip_index = idx;
601
602 bnum = pp->pb_pointer[idx].pe_bnum;
603 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200604 idx = 0;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200605 continue;
606 }
607 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100608 else // not a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200609 {
610 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100611 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200612 ++error;
613 else
614 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100615 // It is a data block, need to write it back to disk.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200616 mf_put(mfp, hp, TRUE, FALSE);
617 hp = NULL;
618 }
619 }
620 }
621
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100622 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200623 break;
624
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100625 // go one block up in the tree
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200626 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
627 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100628 idx = ip->ip_index + 1; // go to next index
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200629 page_count = 1;
630 }
Bram Moolenaarbc563362015-06-09 18:35:25 +0200631 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100632 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +0100633
634 if (error > 0)
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000635 emsg(_(e_error_while_updating_swap_file_crypt));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200636 }
637
638 mfp->mf_old_key = NULL;
639}
640#endif
641
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642/*
643 * ml_setname() is called when the file name of "buf" has been changed.
644 * It may rename the swap file.
645 */
646 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100647ml_setname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648{
649 int success = FALSE;
650 memfile_T *mfp;
651 char_u *fname;
652 char_u *dirp;
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100653#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 char_u *p;
655#endif
656
657 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100658 if (mfp->mf_fd < 0) // there is no swap file yet
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 {
660 /*
661 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
662 * For help files we will make a swap file now.
663 */
Bram Moolenaare1004402020-10-24 20:49:43 +0200664 if (p_uc != 0 && (cmdmod.cmod_flags & CMOD_NOSWAPFILE) == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100665 ml_open_file(buf); // create a swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 return;
667 }
668
669 /*
670 * Try all directories in the 'directory' option.
671 */
672 dirp = p_dir;
673 for (;;)
674 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100675 if (*dirp == NUL) // tried all directories, fail
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 break;
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000677 fname = findswapname(buf, &dirp, mfp->mf_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100678 // alloc's fname
679 if (dirp == NULL) // out of memory
Bram Moolenaarf541c362011-10-26 11:44:18 +0200680 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100681 if (fname == NULL) // no file name found for this dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 continue;
683
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100684#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 /*
686 * Set full pathname for swap file now, because a ":!cd dir" may
687 * change directory without us knowing it.
688 */
689 p = FullName_save(fname, FALSE);
690 vim_free(fname);
691 fname = p;
692 if (fname == NULL)
693 continue;
694#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100695 // if the file name is the same we don't have to do anything
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 if (fnamecmp(fname, mfp->mf_fname) == 0)
697 {
698 vim_free(fname);
699 success = TRUE;
700 break;
701 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100702 // need to close the swap file before renaming
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 if (mfp->mf_fd >= 0)
704 {
705 close(mfp->mf_fd);
706 mfp->mf_fd = -1;
707 }
708
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100709 // try to rename the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 if (vim_rename(mfp->mf_fname, fname) == 0)
711 {
712 success = TRUE;
713 vim_free(mfp->mf_fname);
714 mfp->mf_fname = fname;
715 vim_free(mfp->mf_ffname);
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100716#if defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100717 mfp->mf_ffname = NULL; // mf_fname is full pathname already
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718#else
719 mf_set_ffname(mfp);
720#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200721 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722 break;
723 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100724 vim_free(fname); // this fname didn't work, try another
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 }
726
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100727 if (mfp->mf_fd == -1) // need to (re)open the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 {
729 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
730 if (mfp->mf_fd < 0)
731 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100732 // could not (re)open the swap file, what can we do????
Bram Moolenaareaaac012022-01-02 17:00:40 +0000733 emsg(_(e_oops_lost_the_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 return;
735 }
Bram Moolenaarf05da212009-11-17 16:13:15 +0000736#ifdef HAVE_FD_CLOEXEC
737 {
738 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
739 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarfbc4b4d2016-02-07 15:14:01 +0100740 (void)fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaarf05da212009-11-17 16:13:15 +0000741 }
742#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 }
744 if (!success)
Bram Moolenaareaaac012022-01-02 17:00:40 +0000745 emsg(_(e_could_not_rename_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746}
747
748/*
749 * Open a file for the memfile for all buffers that are not readonly or have
750 * been modified.
751 * Used when 'updatecount' changes from zero to non-zero.
752 */
753 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100754ml_open_files(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755{
756 buf_T *buf;
757
Bram Moolenaar29323592016-07-24 22:04:11 +0200758 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 if (!buf->b_p_ro || buf->b_changed)
760 ml_open_file(buf);
761}
762
763/*
764 * Open a swap file for an existing memfile, if there is no swap file yet.
765 * If we are unable to find a file name, mf_fname will be NULL
766 * and the memfile will be in memory only (no recovery possible).
767 */
768 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100769ml_open_file(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770{
771 memfile_T *mfp;
772 char_u *fname;
773 char_u *dirp;
774
775 mfp = buf->b_ml.ml_mfp;
Bram Moolenaare1004402020-10-24 20:49:43 +0200776 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf
777 || (cmdmod.cmod_flags & CMOD_NOSWAPFILE))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100778 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779
Bram Moolenaara1956f62006-03-12 22:18:00 +0000780#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100781 // For a spell buffer use a temp file name.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000782 if (buf->b_spell)
783 {
Bram Moolenaare5c421c2015-03-31 13:33:08 +0200784 fname = vim_tempname('s', FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000785 if (fname != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100786 (void)mf_open_file(mfp, fname); // consumes fname!
Bram Moolenaar4770d092006-01-12 23:22:24 +0000787 buf->b_may_swap = FALSE;
788 return;
789 }
790#endif
791
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 /*
793 * Try all directories in 'directory' option.
794 */
795 dirp = p_dir;
796 for (;;)
797 {
798 if (*dirp == NUL)
799 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100800 // There is a small chance that between choosing the swap file name
801 // and creating it, another Vim creates the file. In that case the
802 // creation will fail and we will use another directory.
803 fname = findswapname(buf, &dirp, NULL); // allocates fname
Bram Moolenaarf541c362011-10-26 11:44:18 +0200804 if (dirp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100805 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 if (fname == NULL)
807 continue;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100808 if (mf_open_file(mfp, fname) == OK) // consumes fname!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100810#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 /*
812 * set full pathname for swap file now, because a ":!cd dir" may
813 * change directory without us knowing it.
814 */
815 mf_fullname(mfp);
816#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200817 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000818
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100819 // Flush block zero, so others can read it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 if (mf_sync(mfp, MFS_ZERO) == OK)
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000821 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100822 // Mark all blocks that should be in the swapfile as dirty.
823 // Needed for when the 'swapfile' option was reset, so that
824 // the swap file was deleted, and then on again.
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000825 mf_set_dirty(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 break;
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000827 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100828 // Writing block 0 failed: close the file and try another dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 mf_close_file(buf, FALSE);
830 }
831 }
832
Bram Moolenaar00e192b2019-10-19 17:01:28 +0200833 if (*p_dir != NUL && mfp->mf_fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 {
Bram Moolenaar13608d82022-08-29 15:06:50 +0100835 need_wait_return = TRUE; // call wait_return() later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 ++no_wait_return;
Bram Moolenaareaaac012022-01-02 17:00:40 +0000837 (void)semsg(_(e_unable_to_open_swap_file_for_str_recovery_impossible),
Bram Moolenaare1704ba2012-10-03 18:25:00 +0200838 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 --no_wait_return;
840 }
841
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100842 // don't try to open a swap file again
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 buf->b_may_swap = FALSE;
844}
845
846/*
847 * If still need to create a swap file, and starting to edit a not-readonly
848 * file, or reading into an existing buffer, create a swap file now.
849 */
850 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100851check_need_swap(
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200852 int newfile) // reading file into new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853{
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200854 int old_msg_silent = msg_silent; // might be reset by an E325 message
855
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
857 ml_open_file(curbuf);
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200858 msg_silent = old_msg_silent;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859}
860
861/*
862 * Close memline for buffer 'buf'.
863 * If 'del_file' is TRUE, delete the swap file
864 */
865 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100866ml_close(buf_T *buf, int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100868 if (buf->b_ml.ml_mfp == NULL) // not open
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 return;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100870 mf_close(buf->b_ml.ml_mfp, del_file); // close the .swp file
Bram Moolenaarfa4873c2022-06-30 22:13:59 +0100871 if (buf->b_ml.ml_line_lnum != 0
872 && (buf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED)))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 vim_free(buf->b_ml.ml_line_ptr);
874 vim_free(buf->b_ml.ml_stack);
875#ifdef FEAT_BYTEOFF
Bram Moolenaard23a8232018-02-10 18:45:26 +0100876 VIM_CLEAR(buf->b_ml.ml_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877#endif
878 buf->b_ml.ml_mfp = NULL;
879
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100880 // Reset the "recovered" flag, give the ATTENTION prompt the next time
881 // this buffer is loaded.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 buf->b_flags &= ~BF_RECOVERED;
883}
884
885/*
886 * Close all existing memlines and memfiles.
887 * Only used when exiting.
888 * When 'del_file' is TRUE, delete the memfiles.
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000889 * But don't delete files that were ":preserve"d when we are POSIX compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 */
891 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100892ml_close_all(int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893{
894 buf_T *buf;
895
Bram Moolenaar29323592016-07-24 22:04:11 +0200896 FOR_ALL_BUFFERS(buf)
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000897 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
898 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100899#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100900 spell_delete_wordlist(); // delete the internal wordlist
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100901#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902#ifdef TEMPDIRNAMES
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100903 vim_deltempdir(); // delete created temp directory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904#endif
905}
906
907/*
908 * Close all memfiles for not modified buffers.
909 * Only use just before exiting!
910 */
911 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100912ml_close_notmod(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913{
914 buf_T *buf;
915
Bram Moolenaar29323592016-07-24 22:04:11 +0200916 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917 if (!bufIsChanged(buf))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100918 ml_close(buf, TRUE); // close all not-modified buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000919}
920
921/*
922 * Update the timestamp in the .swp file.
923 * Used when the file has been written.
924 */
925 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100926ml_timestamp(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927{
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200928 ml_upd_block0(buf, UB_FNAME);
929}
930
931/*
932 * Return FAIL when the ID of "b0p" is wrong.
933 */
934 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100935ml_check_b0_id(ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200936{
937 if (b0p->b0_id[0] != BLOCK0_ID0
938 || (b0p->b0_id[1] != BLOCK0_ID1
939 && b0p->b0_id[1] != BLOCK0_ID1_C0
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200940 && b0p->b0_id[1] != BLOCK0_ID1_C1
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200941 && b0p->b0_id[1] != BLOCK0_ID1_C2
942 && b0p->b0_id[1] != BLOCK0_ID1_C3)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200943 )
944 return FAIL;
945 return OK;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000946}
947
948/*
949 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
950 */
951 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100952ml_upd_block0(buf_T *buf, upd_block0_T what)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000953{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 memfile_T *mfp;
955 bhdr_T *hp;
956 ZERO_BL *b0p;
957
958 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200959 if (mfp == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200961 hp = mf_get(mfp, (blocknr_T)0, 1);
962 if (hp == NULL)
963 {
964#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100965 // Possibly update the seed in the memfile before there is a block0.
Bram Moolenaar2be79502014-08-13 21:58:28 +0200966 if (what == UB_CRYPT)
967 ml_set_mfp_crypt(buf);
968#endif
969 return;
970 }
971
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200973 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaareaaac012022-01-02 17:00:40 +0000974 iemsg(_(e_ml_upd_block0_didnt_get_block_zero));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000976 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200977 if (what == UB_FNAME)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000978 set_b0_fname(b0p, buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200979#ifdef FEAT_CRYPT
980 else if (what == UB_CRYPT)
981 ml_set_b0_crypt(buf, b0p);
982#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100983 else // what == UB_SAME_DIR
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000984 set_b0_dir_flag(b0p, buf);
985 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 mf_put(mfp, hp, TRUE, FALSE);
987}
988
989/*
990 * Write file name and timestamp into block 0 of a swap file.
991 * Also set buf->b_mtime.
992 * Don't use NameBuff[]!!!
993 */
994 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100995set_b0_fname(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996{
Bram Moolenaar8767f522016-07-01 17:17:39 +0200997 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998
999 if (buf->b_ffname == NULL)
1000 b0p->b0_fname[0] = NUL;
1001 else
1002 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001003#if defined(MSWIN) || defined(AMIGA)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001004 // Systems that cannot translate "~user" back into a path: copy the
1005 // file name unmodified. Do use slashes instead of backslashes for
1006 // portability.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001007 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001008# ifdef BACKSLASH_IN_FILENAME
1009 forward_slash(b0p->b0_fname);
1010# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011#else
1012 size_t flen, ulen;
1013 char_u uname[B0_UNAME_SIZE];
1014
1015 /*
1016 * For a file under the home directory of the current user, we try to
1017 * replace the home directory path with "~user". This helps when
1018 * editing the same file on different machines over a network.
1019 * First replace home dir path with "~/" with home_replace().
1020 * Then insert the user name to get "~user/".
1021 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001022 home_replace(NULL, buf->b_ffname, b0p->b0_fname,
1023 B0_FNAME_SIZE_CRYPT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024 if (b0p->b0_fname[0] == '~')
1025 {
1026 flen = STRLEN(b0p->b0_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001027 // If there is no user name or it is too long, don't use "~/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001029 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE_CRYPT - 1)
1030 vim_strncpy(b0p->b0_fname, buf->b_ffname,
1031 B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 else
1033 {
1034 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
1035 mch_memmove(b0p->b0_fname + 1, uname, ulen);
1036 }
1037 }
1038#endif
1039 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
1040 {
1041 long_to_char((long)st.st_mtime, b0p->b0_mtime);
1042#ifdef CHECK_INODE
1043 long_to_char((long)st.st_ino, b0p->b0_ino);
1044#endif
1045 buf_store_time(buf, &st, buf->b_ffname);
1046 buf->b_mtime_read = buf->b_mtime;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001047 buf->b_mtime_read_ns = buf->b_mtime_ns;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 }
1049 else
1050 {
1051 long_to_char(0L, b0p->b0_mtime);
1052#ifdef CHECK_INODE
1053 long_to_char(0L, b0p->b0_ino);
1054#endif
1055 buf->b_mtime = 0;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001056 buf->b_mtime_ns = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 buf->b_mtime_read = 0;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001058 buf->b_mtime_read_ns = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 buf->b_orig_size = 0;
1060 buf->b_orig_mode = 0;
1061 }
1062 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001063
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001064 // Also add the 'fileencoding' if there is room.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001065 add_b0_fenc(b0p, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066}
1067
1068/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001069 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
1070 * swapfile for "buf" are in the same directory.
1071 * This is fail safe: if we are not sure the directories are equal the flag is
1072 * not set.
1073 */
1074 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001075set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001076{
1077 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
1078 b0p->b0_flags |= B0_SAME_DIR;
1079 else
1080 b0p->b0_flags &= ~B0_SAME_DIR;
1081}
1082
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001083/*
1084 * When there is room, add the 'fileencoding' to block zero.
1085 */
1086 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001087add_b0_fenc(
1088 ZERO_BL *b0p,
1089 buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001090{
1091 int n;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001092 int size = B0_FNAME_SIZE_NOCRYPT;
1093
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001094#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001095 // Without encryption use the same offset as in Vim 7.2 to be compatible.
1096 // With encryption it's OK to move elsewhere, the swap file is not
1097 // compatible anyway.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001098 if (*buf->b_p_key != NUL)
1099 size = B0_FNAME_SIZE_CRYPT;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001100#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001101
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001102 n = (int)STRLEN(buf->b_p_fenc);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001103 if ((int)STRLEN(b0p->b0_fname) + n + 1 > size)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001104 b0p->b0_flags &= ~B0_HAS_FENC;
1105 else
1106 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001107 mch_memmove((char *)b0p->b0_fname + size - n,
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001108 (char *)buf->b_p_fenc, (size_t)n);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001109 *(b0p->b0_fname + size - n - 1) = NUL;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001110 b0p->b0_flags |= B0_HAS_FENC;
1111 }
1112}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001113
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001114#if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO_UPTIME)
1115# include <sys/sysinfo.h>
1116#endif
1117
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001118#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001119/*
1120 * Return TRUE if the process with number "b0p->b0_pid" is still running.
1121 * "swap_fname" is the name of the swap file, if it's from before a reboot then
1122 * the result is FALSE;
1123 */
1124 static int
1125swapfile_process_running(ZERO_BL *b0p, char_u *swap_fname UNUSED)
1126{
Bram Moolenaare2982d62021-10-06 11:27:21 +01001127#if defined(HAVE_SYSINFO) && defined(HAVE_SYSINFO_UPTIME)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001128 stat_T st;
1129 struct sysinfo sinfo;
1130
1131 // If the system rebooted after when the swap file was written then the
1132 // process can't be running now.
1133 if (mch_stat((char *)swap_fname, &st) != -1
1134 && sysinfo(&sinfo) == 0
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001135 && st.st_mtime < time(NULL) - (
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001136# ifdef FEAT_EVAL
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001137 override_sysinfo_uptime >= 0 ? override_sysinfo_uptime :
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001138# endif
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001139 sinfo.uptime))
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001140 return FALSE;
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001141# endif
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001142 return mch_process_running(char_to_long(b0p->b0_pid));
1143}
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001144#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001145
1146/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001147 * Try to recover curbuf from the .swp file.
Bram Moolenaar99499b12019-05-23 21:35:48 +02001148 * If "checkext" is TRUE, check the extension and detect whether it is
1149 * a swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 */
1151 void
Bram Moolenaar99499b12019-05-23 21:35:48 +02001152ml_recover(int checkext)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153{
1154 buf_T *buf = NULL;
1155 memfile_T *mfp = NULL;
1156 char_u *fname;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001157 char_u *fname_used = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 bhdr_T *hp = NULL;
1159 ZERO_BL *b0p;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001160 int b0_ff;
1161 char_u *b0_fenc = NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001162#ifdef FEAT_CRYPT
1163 int b0_cm = -1;
1164#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 PTR_BL *pp;
1166 DATA_BL *dp;
1167 infoptr_T *ip;
1168 blocknr_T bnum;
1169 int page_count;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001170 stat_T org_stat, swp_stat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 int len;
1172 int directly;
1173 linenr_T lnum;
1174 char_u *p;
1175 int i;
1176 long error;
1177 int cannot_open;
1178 linenr_T line_count;
1179 int has_error;
1180 int idx;
1181 int top;
1182 int txt_start;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001183 off_T size;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 int called_from_main;
1185 int serious_error = TRUE;
1186 long mtime;
1187 int attr;
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001188 int orig_file_status = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189
1190 recoverymode = TRUE;
1191 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001192 attr = HL_ATTR(HLF_E);
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001193
1194 /*
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001195 * 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 +00001196 * Otherwise a search is done to find the swap file(s).
1197 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 fname = curbuf->b_fname;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001199 if (fname == NULL) // When there is no file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200 fname = (char_u *)"";
1201 len = (int)STRLEN(fname);
Bram Moolenaar99499b12019-05-23 21:35:48 +02001202 if (checkext && len >= 4 &&
Bram Moolenaare60acc12011-05-10 16:41:25 +02001203#if defined(VMS)
Bram Moolenaar79518e22017-02-17 16:31:35 +01001204 STRNICMP(fname + len - 4, "_s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205#else
Bram Moolenaar79518e22017-02-17 16:31:35 +01001206 STRNICMP(fname + len - 4, ".s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207#endif
Bram Moolenaar79518e22017-02-17 16:31:35 +01001208 == 0
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001209 && vim_strchr((char_u *)"abcdefghijklmnopqrstuvw",
1210 TOLOWER_ASC(fname[len - 2])) != NULL
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001211 && ASCII_ISALPHA(fname[len - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 {
1213 directly = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001214 fname_used = vim_strsave(fname); // make a copy for mf_open()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 }
1216 else
1217 {
1218 directly = FALSE;
1219
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001220 // count the number of matching swap files
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001221 len = recover_names(fname, FALSE, NULL, 0, NULL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001222 if (len == 0) // no swap files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001224 semsg(_(e_no_swap_file_found_for_str), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 goto theend;
1226 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001227 if (len == 1) // one swap file found, use it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 i = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001229 else // several swap files found, choose
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001231 // list the names of the swap files
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001232 (void)recover_names(fname, TRUE, NULL, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 msg_putchar('\n');
Bram Moolenaar32526b32019-01-19 17:43:09 +01001234 msg_puts(_("Enter number of swap file to use (0 to quit): "));
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001235 i = get_number(FALSE, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 if (i < 1 || i > len)
1237 goto theend;
1238 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001239 // get the swap file name that will be used
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001240 (void)recover_names(fname, FALSE, NULL, i, &fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001242 if (fname_used == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001243 goto theend; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001245 // When called from main() still need to initialize storage structure
Bram Moolenaar4770d092006-01-12 23:22:24 +00001246 if (called_from_main && ml_open(curbuf) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 getout(1);
1248
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001249 /*
1250 * Allocate a buffer structure for the swap file that is used for recovery.
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001251 * Only the memline and crypt information in it are really used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001252 */
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001253 buf = ALLOC_ONE(buf_T);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 if (buf == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001257 /*
1258 * init fields in memline struct
1259 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001260 buf->b_ml.ml_stack_size = 0; // no stack yet
1261 buf->b_ml.ml_stack = NULL; // no stack yet
1262 buf->b_ml.ml_stack_top = 0; // nothing in the stack
1263 buf->b_ml.ml_line_lnum = 0; // no cached line
1264 buf->b_ml.ml_locked = NULL; // no locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 buf->b_ml.ml_flags = 0;
Bram Moolenaar0fe849a2010-07-25 15:11:11 +02001266#ifdef FEAT_CRYPT
1267 buf->b_p_key = empty_option;
1268 buf->b_p_cm = empty_option;
1269#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001271 /*
1272 * open the memfile from the old swap file
1273 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001274 p = vim_strsave(fname_used); // save "fname_used" for the message:
1275 // mf_open() will consume "fname_used"!
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001276 mfp = mf_open(fname_used, O_RDONLY);
1277 fname_used = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278 if (mfp == NULL || mfp->mf_fd < 0)
1279 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001280 if (fname_used != NULL)
Bram Moolenaareaaac012022-01-02 17:00:40 +00001281 semsg(_(e_cannot_open_str), fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 goto theend;
1283 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001285#ifdef FEAT_CRYPT
1286 mfp->mf_buffer = buf;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001287#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288
1289 /*
1290 * The page size set in mf_open() might be different from the page size
1291 * used in the swap file, we must get it from block 0. But to read block
1292 * 0 we need a page size. Use the minimal size for block 0 here, it will
1293 * be set to the real value below.
1294 */
1295 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
1296
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001297 /*
1298 * try to read block 0
1299 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
1301 {
1302 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +01001303 msg_puts_attr(_("Unable to read block 0 from "), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001305 msg_puts_attr(_("\nMaybe no changes were made or Vim did not update the swap file."),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 attr | MSG_HIST);
1307 msg_end();
1308 goto theend;
1309 }
1310 b0p = (ZERO_BL *)(hp->bh_data);
1311 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
1312 {
1313 msg_start();
1314 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001315 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001317 msg_puts_attr(_("Use Vim version 3.0.\n"), MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 msg_end();
1319 goto theend;
1320 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001321 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001323 semsg(_(e_str_does_not_look_like_vim_swap_file), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 goto theend;
1325 }
1326 if (b0_magic_wrong(b0p))
1327 {
1328 msg_start();
1329 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001330#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001332 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 attr | MSG_HIST);
1334 else
1335#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001336 msg_puts_attr(_(" cannot be used on this computer.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001338 msg_puts_attr(_("The file was created on "), attr | MSG_HIST);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001339 // avoid going past the end of a corrupted hostname
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340 b0p->b0_fname[0] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001341 msg_puts_attr((char *)b0p->b0_hname, attr | MSG_HIST);
1342 msg_puts_attr(_(",\nor the file has been damaged."), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 msg_end();
1344 goto theend;
1345 }
Bram Moolenaar1c536282007-04-26 15:21:56 +00001346
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001347#ifdef FEAT_CRYPT
K.Takataeeec2542021-06-02 13:28:16 +02001348 for (i = 0; i < (int)ARRAY_LENGTH(id1_codes); ++i)
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001349 if (id1_codes[i] == b0p->b0_id[1])
1350 b0_cm = i;
1351 if (b0_cm > 0)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001352 mch_memmove(mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001353 crypt_set_cm_option(buf, b0_cm < 0 ? 0 : b0_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001354#else
1355 if (b0p->b0_id[1] != BLOCK0_ID1)
1356 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00001357 semsg(_(e_str_is_encrypted_and_this_version_of_vim_does_not_support_encryption), mfp->mf_fname);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001358 goto theend;
1359 }
1360#endif
1361
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 /*
1363 * If we guessed the wrong page size, we have to recalculate the
1364 * highest block number in the file.
1365 */
1366 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1367 {
Bram Moolenaar1c536282007-04-26 15:21:56 +00001368 unsigned previous_page_size = mfp->mf_page_size;
1369
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
Bram Moolenaar1c536282007-04-26 15:21:56 +00001371 if (mfp->mf_page_size < previous_page_size)
1372 {
1373 msg_start();
1374 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001375 msg_puts_attr(_(" has been damaged (page size is smaller than minimum value).\n"),
Bram Moolenaar1c536282007-04-26 15:21:56 +00001376 attr | MSG_HIST);
1377 msg_end();
1378 goto theend;
1379 }
Bram Moolenaar8767f522016-07-01 17:17:39 +02001380 if ((size = vim_lseek(mfp->mf_fd, (off_T)0L, SEEK_END)) <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001381 mfp->mf_blocknr_max = 0; // no file or empty file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 else
1383 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1384 mfp->mf_infile_count = mfp->mf_blocknr_max;
Bram Moolenaar1c536282007-04-26 15:21:56 +00001385
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001386 // need to reallocate the memory used to store the data
Bram Moolenaar1c536282007-04-26 15:21:56 +00001387 p = alloc(mfp->mf_page_size);
1388 if (p == NULL)
1389 goto theend;
1390 mch_memmove(p, hp->bh_data, previous_page_size);
1391 vim_free(hp->bh_data);
1392 hp->bh_data = p;
1393 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 }
1395
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001396 /*
1397 * If .swp file name given directly, use name from swap file for buffer.
1398 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 if (directly)
1400 {
1401 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1402 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1403 goto theend;
1404 }
1405
1406 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001407 smsg(_("Using swap file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408
1409 if (buf_spname(curbuf) != NULL)
Bram Moolenaare1704ba2012-10-03 18:25:00 +02001410 vim_strncpy(NameBuff, buf_spname(curbuf), MAXPATHL - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411 else
1412 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001413 smsg(_("Original file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 msg_putchar('\n');
1415
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001416 /*
1417 * check date of swap file and original file
1418 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 mtime = char_to_long(b0p->b0_mtime);
1420 if (curbuf->b_ffname != NULL
1421 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1422 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1423 && org_stat.st_mtime > swp_stat.st_mtime)
1424 || org_stat.st_mtime != mtime))
Bram Moolenaareaaac012022-01-02 17:00:40 +00001425 emsg(_(e_warning_original_file_may_have_been_changed));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426 out_flush();
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001427
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001428 // Get the 'fileformat' and 'fileencoding' from block zero.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001429 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1430 if (b0p->b0_flags & B0_HAS_FENC)
1431 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001432 int fnsize = B0_FNAME_SIZE_NOCRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001433
1434#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001435 // Use the same size as in add_b0_fenc().
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001436 if (b0p->b0_id[1] != BLOCK0_ID1)
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001437 fnsize = B0_FNAME_SIZE_CRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001438#endif
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001439 for (p = b0p->b0_fname + fnsize; p > b0p->b0_fname && p[-1] != NUL; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001440 ;
Bram Moolenaar71ccd032020-06-12 22:59:11 +02001441 b0_fenc = vim_strnsave(p, b0p->b0_fname + fnsize - p);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001442 }
1443
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001444 mf_put(mfp, hp, FALSE, FALSE); // release block 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 hp = NULL;
1446
1447 /*
1448 * Now that we are sure that the file is going to be recovered, clear the
1449 * contents of the current buffer.
1450 */
1451 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001452 ml_delete((linenr_T)1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453
1454 /*
1455 * Try reading the original file to obtain the values of 'fileformat',
1456 * 'fileencoding', etc. Ignore errors. The text itself is not used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001457 * When the file is encrypted the user is asked to enter the key.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 */
1459 if (curbuf->b_ffname != NULL)
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001460 orig_file_status = readfile(curbuf->b_ffname, NULL, (linenr_T)0,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001463#ifdef FEAT_CRYPT
1464 if (b0_cm >= 0)
1465 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001466 // Need to ask the user for the crypt key. If this fails we continue
1467 // without a key, will probably get garbage text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001468 if (*curbuf->b_p_key != NUL)
1469 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001470 smsg(_("Swap file is encrypted: \"%s\""), fname_used);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001471 msg_puts(_("\nIf you entered a new crypt key but did not write the text file,"));
1472 msg_puts(_("\nenter the new crypt key."));
1473 msg_puts(_("\nIf you wrote the text file after changing the crypt key press enter"));
1474 msg_puts(_("\nto use the same key for text file and swap file"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001475 }
1476 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001477 smsg(_(need_key_msg), fname_used);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001478 buf->b_p_key = crypt_get_key(FALSE, FALSE);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001479 if (buf->b_p_key == NULL)
1480 buf->b_p_key = curbuf->b_p_key;
1481 else if (*buf->b_p_key == NUL)
1482 {
1483 vim_free(buf->b_p_key);
1484 buf->b_p_key = curbuf->b_p_key;
1485 }
1486 if (buf->b_p_key == NULL)
1487 buf->b_p_key = empty_option;
1488 }
1489#endif
1490
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001491 // Use the 'fileformat' and 'fileencoding' as stored in the swap file.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001492 if (b0_ff != 0)
1493 set_fileformat(b0_ff - 1, OPT_LOCAL);
1494 if (b0_fenc != NULL)
1495 {
Bram Moolenaar31e5c602022-04-15 13:53:33 +01001496 set_option_value_give_err((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001497 vim_free(b0_fenc);
1498 }
Bram Moolenaarc024b462019-06-08 18:07:21 +02001499 unchanged(curbuf, TRUE, TRUE);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001500
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001501 bnum = 1; // start with block 1
1502 page_count = 1; // which is 1 page
1503 lnum = 0; // append after line 0 in curbuf
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 line_count = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001505 idx = 0; // start with first index in block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 error = 0;
1507 buf->b_ml.ml_stack_top = 0;
1508 buf->b_ml.ml_stack = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001509 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510
1511 if (curbuf->b_ffname == NULL)
1512 cannot_open = TRUE;
1513 else
1514 cannot_open = FALSE;
1515
1516 serious_error = FALSE;
1517 for ( ; !got_int; line_breakcheck())
1518 {
1519 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001520 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521
1522 /*
1523 * get block
1524 */
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00001525 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 {
1527 if (bnum == 1)
1528 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001529 semsg(_(e_unable_to_read_block_one_from_str), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 goto theend;
1531 }
1532 ++error;
1533 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1534 (colnr_T)0, TRUE);
1535 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001536 else // there is a block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 {
1538 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001539 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 {
Bram Moolenaarb67ba032023-04-22 21:14:26 +01001541 int ptr_block_error = FALSE;
1542 if (pp->pb_count_max != PB_COUNT_MAX(mfp))
1543 {
1544 ptr_block_error = TRUE;
1545 pp->pb_count_max = PB_COUNT_MAX(mfp);
1546 }
1547 if (pp->pb_count > pp->pb_count_max)
1548 {
1549 ptr_block_error = TRUE;
1550 pp->pb_count = pp->pb_count_max;
1551 }
1552 if (ptr_block_error)
1553 emsg(_(e_warning_pointer_block_corrupted));
1554
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001555 // check line count when using pointer block first time
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 if (idx == 0 && line_count != 0)
1557 {
1558 for (i = 0; i < (int)pp->pb_count; ++i)
1559 line_count -= pp->pb_pointer[i].pe_line_count;
1560 if (line_count != 0)
1561 {
1562 ++error;
1563 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1564 (colnr_T)0, TRUE);
1565 }
1566 }
1567
1568 if (pp->pb_count == 0)
1569 {
1570 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1571 (colnr_T)0, TRUE);
1572 ++error;
1573 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001574 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575 {
1576 if (pp->pb_pointer[idx].pe_bnum < 0)
1577 {
1578 /*
1579 * Data block with negative block number.
1580 * Try to read lines from the original file.
1581 * This is slow, but it works.
1582 */
1583 if (!cannot_open)
1584 {
1585 line_count = pp->pb_pointer[idx].pe_line_count;
1586 if (readfile(curbuf->b_ffname, NULL, lnum,
1587 pp->pb_pointer[idx].pe_old_lnum - 1,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001588 line_count, NULL, 0) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 cannot_open = TRUE;
1590 else
1591 lnum += line_count;
1592 }
1593 if (cannot_open)
1594 {
1595 ++error;
1596 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1597 (colnr_T)0, TRUE);
1598 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001599 ++idx; // get same block again for next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 continue;
1601 }
1602
1603 /*
1604 * going one block deeper in the tree
1605 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001606 if ((top = ml_add_stack(buf)) < 0) // new entry in stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 {
1608 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001609 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 }
1611 ip = &(buf->b_ml.ml_stack[top]);
1612 ip->ip_bnum = bnum;
1613 ip->ip_index = idx;
1614
1615 bnum = pp->pb_pointer[idx].pe_bnum;
1616 line_count = pp->pb_pointer[idx].pe_line_count;
1617 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaar986a0032011-06-13 01:07:27 +02001618 idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 continue;
1620 }
1621 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001622 else // not a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 {
1624 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001625 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 {
1627 if (bnum == 1)
1628 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001629 semsg(_(e_block_one_id_wrong_str_not_swp_file),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 mfp->mf_fname);
1631 goto theend;
1632 }
1633 ++error;
1634 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1635 (colnr_T)0, TRUE);
1636 }
1637 else
1638 {
1639 /*
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001640 * It is a data block.
1641 * Append all the lines in this block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642 */
1643 has_error = FALSE;
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001644
1645 // Check the length of the block.
1646 // If wrong, use the length given in the pointer block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1648 {
1649 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1650 (colnr_T)0, TRUE);
1651 ++error;
1652 has_error = TRUE;
1653 dp->db_txt_end = page_count * mfp->mf_page_size;
1654 }
1655
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001656 // Make sure there is a NUL at the end of the block so we
1657 // don't go over the end when copying text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1659
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001660 // Check the number of lines in the block.
1661 // If wrong, use the count in the data block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 if (line_count != dp->db_line_count)
1663 {
1664 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1665 (colnr_T)0, TRUE);
1666 ++error;
1667 has_error = TRUE;
1668 }
1669
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001670 int did_questions = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 for (i = 0; i < dp->db_line_count; ++i)
1672 {
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001673 if ((char_u *)&(dp->db_index[i])
1674 >= (char_u *)dp + dp->db_txt_start)
1675 {
1676 // line count must be wrong
1677 ++error;
1678 ml_append(lnum++,
1679 (char_u *)_("??? lines may be missing"),
1680 (colnr_T)0, TRUE);
1681 break;
1682 }
1683
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
Bram Moolenaar740885b2009-11-03 14:33:17 +00001685 if (txt_start <= (int)HEADER_SIZE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 || txt_start >= (int)dp->db_txt_end)
1687 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 ++error;
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001689 // avoid lots of lines with "???"
1690 if (did_questions)
1691 continue;
1692 did_questions = TRUE;
1693 p = (char_u *)"???";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 }
1695 else
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001696 {
1697 did_questions = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 p = (char_u *)dp + txt_start;
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001699 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 ml_append(lnum++, p, (colnr_T)0, TRUE);
1701 }
1702 if (has_error)
Bram Moolenaar740885b2009-11-03 14:33:17 +00001703 ml_append(lnum++, (char_u *)_("???END"),
1704 (colnr_T)0, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 }
1706 }
1707 }
1708
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001709 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 break;
1711
1712 /*
1713 * go one block up in the tree
1714 */
1715 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1716 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001717 idx = ip->ip_index + 1; // go to next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 page_count = 1;
1719 }
1720
1721 /*
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001722 * Compare the buffer contents with the original file. When they differ
1723 * set the 'modified' flag.
1724 * Lines 1 - lnum are the new contents.
1725 * Lines lnum + 1 to ml_line_count are the original contents.
1726 * Line ml_line_count + 1 in the dummy empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 */
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001728 if (orig_file_status != OK || curbuf->b_ml.ml_line_count != lnum * 2 + 1)
1729 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001730 // Recovering an empty file results in two lines and the first line is
1731 // empty. Don't set the modified flag then.
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001732 if (!(curbuf->b_ml.ml_line_count == 2 && *ml_get(1) == NUL))
1733 {
Bram Moolenaarec28d152019-05-11 18:36:34 +02001734 changed_internal();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001735 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001736 }
1737 }
1738 else
1739 {
1740 for (idx = 1; idx <= lnum; ++idx)
1741 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001742 // Need to copy one line, fetching the other one may flush it.
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001743 p = vim_strsave(ml_get(idx));
1744 i = STRCMP(p, ml_get(idx + lnum));
1745 vim_free(p);
1746 if (i != 0)
1747 {
Bram Moolenaarec28d152019-05-11 18:36:34 +02001748 changed_internal();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001749 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001750 break;
1751 }
1752 }
1753 }
1754
1755 /*
1756 * Delete the lines from the original file and the dummy line from the
1757 * empty buffer. These will now be after the last line in the buffer.
1758 */
1759 while (curbuf->b_ml.ml_line_count > lnum
1760 && !(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001761 ml_delete(curbuf->b_ml.ml_line_count);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 curbuf->b_flags |= BF_RECOVERED;
Bram Moolenaare3f50ad2021-06-09 12:33:40 +02001763 check_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764
1765 recoverymode = FALSE;
1766 if (got_int)
Bram Moolenaareaaac012022-01-02 17:00:40 +00001767 emsg(_(e_recovery_interrupted));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 else if (error)
1769 {
1770 ++no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001771 msg(">>>>>>>>>>>>>");
Bram Moolenaareaaac012022-01-02 17:00:40 +00001772 emsg(_(e_errors_detected_while_recovering_look_for_lines_starting_with_questions));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 --no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001774 msg(_("See \":help E312\" for more information."));
1775 msg(">>>>>>>>>>>>>");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 }
1777 else
1778 {
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001779 if (curbuf->b_changed)
1780 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001781 msg(_("Recovery completed. You should check if everything is OK."));
1782 msg_puts(_("\n(You might want to write out this file under another name\n"));
1783 msg_puts(_("and run diff with the original file to check for changes)"));
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001784 }
1785 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001786 msg(_("Recovery completed. Buffer contents equals file contents."));
Bram Moolenaarf8835082020-11-09 21:04:17 +01001787 msg_puts(_("\nYou may want to delete the .swp file now."));
1788#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001789 if (swapfile_process_running(b0p, fname_used))
Bram Moolenaarf8835082020-11-09 21:04:17 +01001790 {
1791 // Warn there could be an active Vim on the same file, the user may
1792 // want to kill it.
1793 msg_puts(_("\nNote: process STILL RUNNING: "));
1794 msg_outnum(char_to_long(b0p->b0_pid));
1795 }
1796#endif
1797 msg_puts("\n\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 cmdline_row = msg_row;
1799 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001800#ifdef FEAT_CRYPT
1801 if (*buf->b_p_key != NUL && STRCMP(curbuf->b_p_key, buf->b_p_key) != 0)
1802 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001803 msg_puts(_("Using crypt key from swap file for the text file.\n"));
Bram Moolenaar31e5c602022-04-15 13:53:33 +01001804 set_option_value_give_err((char_u *)"key", 0L, buf->b_p_key, OPT_LOCAL);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001805 }
1806#endif
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001807 redraw_curbuf_later(UPD_NOT_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
1809theend:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001810 vim_free(fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 recoverymode = FALSE;
1812 if (mfp != NULL)
1813 {
1814 if (hp != NULL)
1815 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001816 mf_close(mfp, FALSE); // will also vim_free(mfp->mf_fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 }
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001818 if (buf != NULL)
1819 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001820#ifdef FEAT_CRYPT
1821 if (buf->b_p_key != curbuf->b_p_key)
1822 free_string_option(buf->b_p_key);
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001823 free_string_option(buf->b_p_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001824#endif
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001825 vim_free(buf->b_ml.ml_stack);
1826 vim_free(buf);
1827 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 if (serious_error && called_from_main)
1829 ml_close(curbuf, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 else
1831 {
1832 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1833 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1834 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835}
1836
1837/*
1838 * Find the names of swap files in current directory and the directory given
1839 * with the 'directory' option.
1840 *
1841 * Used to:
1842 * - list the swap files for "vim -r"
1843 * - count the number of swap files when recovering
1844 * - list the swap files when recovering
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001845 * - list the swap files for swapfilelist()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 * - find the name of the n'th swap file when recovering
1847 */
1848 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001849recover_names(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001850 char_u *fname, // base for swap file name
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001851 int do_list, // when TRUE, list the swap file names
1852 list_T *ret_list UNUSED, // when not NULL add file names to it
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001853 int nr, // when non-zero, return nr'th swap file name
1854 char_u **fname_out) // result when "nr" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855{
1856 int num_names;
1857 char_u *(names[6]);
1858 char_u *tail;
1859 char_u *p;
1860 int num_files;
1861 int file_count = 0;
1862 char_u **files;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 char_u *dirp;
1864 char_u *dir_name;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001865 char_u *fname_res = NULL;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001866#ifdef HAVE_READLINK
1867 char_u fname_buf[MAXPATHL];
Bram Moolenaar64354da2010-05-25 21:37:17 +02001868#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001869
Bram Moolenaar64354da2010-05-25 21:37:17 +02001870 if (fname != NULL)
1871 {
1872#ifdef HAVE_READLINK
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001873 // Expand symlink in the file name, because the swap file is created
1874 // with the actual file instead of with the symlink.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001875 if (resolve_symlink(fname, fname_buf) == OK)
1876 fname_res = fname_buf;
1877 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001878#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001879 fname_res = fname;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001880 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001882 if (do_list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001884 // use msg() to start the scrolling properly
Bram Moolenaar32526b32019-01-19 17:43:09 +01001885 msg(_("Swap files found:"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 msg_putchar('\n');
1887 }
1888
1889 /*
1890 * Do the loop for every directory in 'directory'.
1891 * First allocate some memory to put the directory name in.
1892 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02001893 dir_name = alloc(STRLEN(p_dir) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 dirp = p_dir;
1895 while (dir_name != NULL && *dirp)
1896 {
1897 /*
1898 * Isolate a directory name from *dirp and put it in dir_name (we know
1899 * it is large enough, so use 31000 for length).
1900 * Advance dirp to next directory name.
1901 */
1902 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1903
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001904 if (dir_name[0] == '.' && dir_name[1] == NUL) // check current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001906 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 {
1908#ifdef VMS
1909 names[0] = vim_strsave((char_u *)"*_sw%");
1910#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 names[0] = vim_strsave((char_u *)"*.sw?");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001913#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001914 // For Unix names starting with a dot are special. MS-Windows
1915 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 names[1] = vim_strsave((char_u *)".*.sw?");
1917 names[2] = vim_strsave((char_u *)".sw?");
1918 num_names = 3;
1919#else
1920# ifdef VMS
1921 names[1] = vim_strsave((char_u *)".*_sw%");
1922 num_names = 2;
1923# else
1924 num_names = 1;
1925# endif
1926#endif
1927 }
1928 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001929 num_names = recov_file_names(names, fname_res, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001931 else // check directory dir_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001933 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 {
1935#ifdef VMS
1936 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1937#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001940#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001941 // For Unix names starting with a dot are special. MS-Windows
1942 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1944 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1945 num_names = 3;
1946#else
1947# ifdef VMS
1948 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1949 num_names = 2;
1950# else
1951 num_names = 1;
1952# endif
1953#endif
1954 }
1955 else
1956 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01001957#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01001958 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01001959
1960 p = dir_name + len;
1961 if (after_pathsep(dir_name, p) && len > 1 && p[-1] == p[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001963 // Ends with '//', Use Full path for swap name
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001964 tail = make_percent_swname(dir_name, fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 }
1966 else
1967#endif
1968 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001969 tail = gettail(fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970 tail = concat_fnames(dir_name, tail, TRUE);
1971 }
1972 if (tail == NULL)
1973 num_names = 0;
1974 else
1975 {
1976 num_names = recov_file_names(names, tail, FALSE);
1977 vim_free(tail);
1978 }
1979 }
1980 }
1981
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02001982 // check for out-of-memory
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001983 for (int i = 0; i < num_names; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 {
1985 if (names[i] == NULL)
1986 {
1987 for (i = 0; i < num_names; ++i)
1988 vim_free(names[i]);
1989 num_names = 0;
1990 }
1991 }
1992 if (num_names == 0)
1993 num_files = 0;
1994 else if (expand_wildcards(num_names, names, &num_files, &files,
Bram Moolenaar99499b12019-05-23 21:35:48 +02001995 EW_NOTENV|EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 num_files = 0;
1997
1998 /*
1999 * When no swap file found, wildcard expansion might have failed (e.g.
2000 * not able to execute the shell).
2001 * Try finding a swap file by simply adding ".swp" to the file name.
2002 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002003 if (*dirp == NUL && file_count + num_files == 0 && fname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 {
Bram Moolenaar8767f522016-07-01 17:17:39 +02002005 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 char_u *swapname;
2007
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002008 swapname = modname(fname_res,
Bram Moolenaare60acc12011-05-10 16:41:25 +02002009#if defined(VMS)
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002010 (char_u *)"_swp", FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011#else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002012 (char_u *)".swp", TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002014 );
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 if (swapname != NULL)
2016 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002017 if (mch_stat((char *)swapname, &st) != -1) // It exists!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002019 files = ALLOC_ONE(char_u *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 if (files != NULL)
2021 {
2022 files[0] = swapname;
2023 swapname = NULL;
2024 num_files = 1;
2025 }
2026 }
2027 vim_free(swapname);
2028 }
2029 }
2030
2031 /*
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002032 * Remove swapfile name of the current buffer, it must be ignored.
2033 * But keep it for swapfilelist().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 */
2035 if (curbuf->b_ml.ml_mfp != NULL
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002036 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL
2037 && ret_list == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 {
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002039 for (int i = 0; i < num_files; ++i)
Bram Moolenaar99499b12019-05-23 21:35:48 +02002040 // Do not expand wildcards, on windows would try to expand
2041 // "%tmp%" in "%tmp%file".
2042 if (fullpathcmp(p, files[i], TRUE, FALSE) & FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 {
Bram Moolenaar99499b12019-05-23 21:35:48 +02002044 // Remove the name from files[i]. Move further entries
2045 // down. When the array becomes empty free it here, since
2046 // FreeWild() won't be called below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 vim_free(files[i]);
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00002048 if (--num_files == 0)
2049 vim_free(files);
2050 else
2051 for ( ; i < num_files; ++i)
2052 files[i] = files[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 }
2054 }
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002055 if (nr > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 {
2057 file_count += num_files;
2058 if (nr <= file_count)
2059 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002060 *fname_out = vim_strsave(
2061 files[nr - 1 + num_files - file_count]);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002062 dirp = (char_u *)""; // stop searching
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 }
2064 }
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002065 else if (do_list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 {
2067 if (dir_name[0] == '.' && dir_name[1] == NUL)
2068 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002069 if (fname == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002070 msg_puts(_(" In current directory:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002072 msg_puts(_(" Using specified name:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 }
2074 else
2075 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002076 msg_puts(_(" In directory "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 msg_home_replace(dir_name);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002078 msg_puts(":\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 }
2080
2081 if (num_files)
2082 {
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002083 for (int i = 0; i < num_files; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002085 // print the swap file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 msg_outnum((long)++file_count);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002087 msg_puts(". ");
2088 msg_puts((char *)gettail(files[i]));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 msg_putchar('\n');
2090 (void)swapfile_info(files[i]);
2091 }
2092 }
2093 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002094 msg_puts(_(" -- none --\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 out_flush();
2096 }
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002097#ifdef FEAT_EVAL
2098 else if (ret_list != NULL)
2099 {
2100 for (int i = 0; i < num_files; ++i)
2101 {
2102 char_u *name = concat_fnames(dir_name, files[i], TRUE);
2103 if (name != NULL)
2104 {
2105 list_append_string(ret_list, name, -1);
2106 vim_free(name);
2107 }
2108 }
2109 }
2110#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 else
2112 file_count += num_files;
2113
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002114 for (int i = 0; i < num_names; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 vim_free(names[i]);
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002116 if (num_files > 0)
2117 FreeWild(num_files, files);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118 }
2119 vim_free(dir_name);
2120 return file_count;
2121}
2122
Bram Moolenaar4f974752019-02-17 17:44:42 +01002123#if defined(UNIX) || defined(MSWIN) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124/*
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002125 * Need _very_ long file names.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 * Append the full path to name with path separators made into percent
Bram Moolenaar8b0e62c2021-10-19 22:12:25 +01002127 * signs, to "dir". An unnamed buffer is handled as "" (<currentdir>/"")
2128 * The last character in "dir" must be an extra slash or backslash, it is
2129 * removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 */
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002131 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002132make_percent_swname(char_u *dir, char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133{
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002134 char_u *d = NULL, *s, *f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002136 f = fix_fname(name != NULL ? name : (char_u *)"");
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00002137 if (f == NULL)
2138 return NULL;
Bram Moolenaar8b0e62c2021-10-19 22:12:25 +01002139
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00002140 s = alloc(STRLEN(f) + 1);
2141 if (s != NULL)
2142 {
2143 STRCPY(s, f);
2144 for (d = s; *d != NUL; MB_PTR_ADV(d))
2145 if (vim_ispathsep(*d))
2146 *d = '%';
2147
2148 dir[STRLEN(dir) - 1] = NUL; // remove one trailing slash
2149 d = concat_fnames(dir, s, TRUE);
2150 vim_free(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 }
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00002152 vim_free(f);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 return d;
2154}
2155#endif
2156
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002157#if (defined(UNIX) || defined(VMS) || defined(MSWIN)) \
2158 && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
2159# define HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160static int process_still_running;
2161#endif
2162
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002163#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164/*
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002165 * Return information found in swapfile "fname" in dictionary "d".
2166 * This is used by the swapinfo() function.
2167 */
2168 void
2169get_b0_dict(char_u *fname, dict_T *d)
2170{
2171 int fd;
2172 struct block0 b0;
2173
2174 if ((fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
2175 {
2176 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
2177 {
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002178 if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002179 dict_add_string(d, "error", (char_u *)"Not a swap file");
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002180 else if (b0_magic_wrong(&b0))
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002181 dict_add_string(d, "error", (char_u *)"Magic number mismatch");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002182 else
2183 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002184 // we have swap information
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002185 dict_add_string_len(d, "version", b0.b0_version, 10);
2186 dict_add_string_len(d, "user", b0.b0_uname, B0_UNAME_SIZE);
2187 dict_add_string_len(d, "host", b0.b0_hname, B0_HNAME_SIZE);
2188 dict_add_string_len(d, "fname", b0.b0_fname, B0_FNAME_SIZE_ORG);
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002189
2190 dict_add_number(d, "pid", char_to_long(b0.b0_pid));
2191 dict_add_number(d, "mtime", char_to_long(b0.b0_mtime));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002192 dict_add_number(d, "dirty", b0.b0_dirty ? 1 : 0);
2193# ifdef CHECK_INODE
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002194 dict_add_number(d, "inode", char_to_long(b0.b0_ino));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002195# endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002196 }
2197 }
2198 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002199 dict_add_string(d, "error", (char_u *)"Cannot read file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002200 close(fd);
2201 }
2202 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002203 dict_add_string(d, "error", (char_u *)"Cannot open file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002204}
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002205#endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002206
2207/*
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00002208 * Give information about an existing swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 * Returns timestamp (0 when unknown).
2210 */
2211 static time_t
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002212swapfile_info(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002214 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 int fd;
2216 struct block0 b0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217#ifdef UNIX
2218 char_u uname[B0_UNAME_SIZE];
2219#endif
2220
Bram Moolenaar63d25552019-05-10 21:28:38 +02002221 // print the swap file date
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 if (mch_stat((char *)fname, &st) != -1)
2223 {
2224#ifdef UNIX
Bram Moolenaar63d25552019-05-10 21:28:38 +02002225 // print name of owner of the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
2227 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002228 msg_puts(_(" owned by: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 msg_outtrans(uname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002230 msg_puts(_(" dated: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 }
2232 else
2233#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002234 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02002235 msg_puts(get_ctime(st.st_mtime, TRUE));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 }
Bram Moolenaar63d25552019-05-10 21:28:38 +02002237 else
2238 st.st_mtime = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239
2240 /*
2241 * print the original file name
2242 */
2243 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2244 if (fd >= 0)
2245 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01002246 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 {
2248 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
2249 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002250 msg_puts(_(" [from Vim version 3.0]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002252 else if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002254 msg_puts(_(" [does not look like a Vim swap file]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 }
2256 else
2257 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002258 msg_puts(_(" file name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 if (b0.b0_fname[0] == NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002260 msg_puts(_("[No Name]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 else
2262 msg_outtrans(b0.b0_fname);
2263
Bram Moolenaar32526b32019-01-19 17:43:09 +01002264 msg_puts(_("\n modified: "));
2265 msg_puts(b0.b0_dirty ? _("YES") : _("no"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266
2267 if (*(b0.b0_uname) != NUL)
2268 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002269 msg_puts(_("\n user name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 msg_outtrans(b0.b0_uname);
2271 }
2272
2273 if (*(b0.b0_hname) != NUL)
2274 {
2275 if (*(b0.b0_uname) != NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002276 msg_puts(_(" host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002278 msg_puts(_("\n host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 msg_outtrans(b0.b0_hname);
2280 }
2281
2282 if (char_to_long(b0.b0_pid) != 0L)
2283 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002284 msg_puts(_("\n process ID: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 msg_outnum(char_to_long(b0.b0_pid));
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002286#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01002287 if (swapfile_process_running(&b0, fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002289 msg_puts(_(" (STILL RUNNING)"));
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002290# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 process_still_running = TRUE;
2292# endif
2293 }
2294#endif
2295 }
2296
2297 if (b0_magic_wrong(&b0))
2298 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +01002299#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002301 msg_puts(_("\n [not usable with this version of Vim]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 else
2303#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002304 msg_puts(_("\n [not usable on this computer]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 }
2306 }
2307 }
2308 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002309 msg_puts(_(" [cannot be read]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 close(fd);
2311 }
2312 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002313 msg_puts(_(" [cannot be opened]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 msg_putchar('\n');
2315
Bram Moolenaar63d25552019-05-10 21:28:38 +02002316 return st.st_mtime;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317}
2318
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002319/*
2320 * Return TRUE if the swap file looks OK and there are no changes, thus it can
2321 * be safely deleted.
2322 */
zeertzjq3c5999e2022-03-23 13:54:51 +00002323 static int
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002324swapfile_unchanged(char_u *fname)
2325{
2326 stat_T st;
2327 int fd;
2328 struct block0 b0;
2329 int ret = TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002330
2331 // must be able to stat the swap file
2332 if (mch_stat((char *)fname, &st) == -1)
2333 return FALSE;
2334
2335 // must be able to read the first block
2336 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2337 if (fd < 0)
2338 return FALSE;
2339 if (read_eintr(fd, &b0, sizeof(b0)) != sizeof(b0))
2340 {
2341 close(fd);
2342 return FALSE;
2343 }
2344
2345 // the ID and magic number must be correct
2346 if (ml_check_b0_id(&b0) == FAIL|| b0_magic_wrong(&b0))
2347 ret = FALSE;
2348
2349 // must be unchanged
2350 if (b0.b0_dirty)
2351 ret = FALSE;
2352
2353#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf8835082020-11-09 21:04:17 +01002354 // Host name must be known and must equal the current host name, otherwise
2355 // comparing pid is meaningless.
2356 if (*(b0.b0_hname) == NUL)
2357 {
2358 ret = FALSE;
2359 }
2360 else
2361 {
2362 char_u hostname[B0_HNAME_SIZE];
2363
2364 mch_get_host_name(hostname, B0_HNAME_SIZE);
2365 hostname[B0_HNAME_SIZE - 1] = NUL;
Bram Moolenaare79cdb62020-11-21 13:51:16 +01002366 b0.b0_hname[B0_HNAME_SIZE - 1] = NUL; // in case of corruption
Bram Moolenaarf8835082020-11-09 21:04:17 +01002367 if (STRICMP(b0.b0_hname, hostname) != 0)
2368 ret = FALSE;
2369 }
2370
Bram Moolenaar32aa1022019-11-02 22:54:41 +01002371 // process must be known and not be running
Bram Moolenaarf52f0602021-03-10 21:26:37 +01002372 if (char_to_long(b0.b0_pid) == 0L || swapfile_process_running(&b0, fname))
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002373 ret = FALSE;
2374#endif
2375
Bram Moolenaarf8835082020-11-09 21:04:17 +01002376 // We do not check the user, it should be irrelevant for whether the swap
2377 // file is still useful.
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002378
2379 close(fd);
2380 return ret;
2381}
2382
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002384recov_file_names(char_u **names, char_u *path, int prepend_dot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385{
2386 int num_names;
2387
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 /*
2389 * (Win32 and Win64) never short names, but do prepend a dot.
2390 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
2391 * Only use the short name if it is different.
2392 */
2393 char_u *p;
2394 int i;
Bram Moolenaar4f974752019-02-17 17:44:42 +01002395# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 int shortname = curbuf->b_shortname;
2397
2398 curbuf->b_shortname = FALSE;
2399# endif
2400
2401 num_names = 0;
2402
2403 /*
2404 * May also add the file name with a dot prepended, for swap file in same
2405 * dir as original file.
2406 */
2407 if (prepend_dot)
2408 {
2409 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
2410 if (names[num_names] == NULL)
2411 goto end;
2412 ++num_names;
2413 }
2414
2415 /*
2416 * Form the normal swap file name pattern by appending ".sw?".
2417 */
2418#ifdef VMS
2419 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
2420#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422#endif
2423 if (names[num_names] == NULL)
2424 goto end;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002425 if (num_names >= 1) // check if we have the same name twice
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 {
2427 p = names[num_names - 1];
2428 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
2429 if (i > 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002430 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431
2432 if (STRCMP(p, names[num_names]) != 0)
2433 ++num_names;
2434 else
2435 vim_free(names[num_names]);
2436 }
2437 else
2438 ++num_names;
2439
Bram Moolenaar4f974752019-02-17 17:44:42 +01002440# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 /*
2442 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
2443 */
2444 curbuf->b_shortname = TRUE;
2445#ifdef VMS
2446 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
2447#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449#endif
2450 if (names[num_names] == NULL)
2451 goto end;
2452
2453 /*
2454 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
2455 */
2456 p = names[num_names];
2457 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
2458 if (i > 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002459 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 if (STRCMP(names[num_names - 1], p) == 0)
2461 vim_free(names[num_names]);
2462 else
2463 ++num_names;
2464# endif
2465
2466end:
Bram Moolenaar4f974752019-02-17 17:44:42 +01002467# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 curbuf->b_shortname = shortname;
2469# endif
2470
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 return num_names;
2472}
2473
2474/*
2475 * sync all memlines
2476 *
2477 * If 'check_file' is TRUE, check if original file exists and was not changed.
2478 * If 'check_char' is TRUE, stop syncing when character becomes available, but
2479 * always sync at least one block.
2480 */
2481 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002482ml_sync_all(int check_file, int check_char)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483{
2484 buf_T *buf;
Bram Moolenaar8767f522016-07-01 17:17:39 +02002485 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486
Bram Moolenaar29323592016-07-24 22:04:11 +02002487 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 {
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002489 if (buf->b_ml.ml_mfp == NULL
2490 || buf->b_ml.ml_mfp->mf_fname == NULL
2491 || buf->b_ml.ml_mfp->mf_fd < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002492 continue; // no file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002494 ml_flush_line(buf); // flush buffered line
2495 // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
2497 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
2498 && buf->b_ffname != NULL)
2499 {
2500 /*
2501 * If the original file does not exist anymore or has been changed
2502 * call ml_preserve() to get rid of all negative numbered blocks.
2503 */
2504 if (mch_stat((char *)buf->b_ffname, &st) == -1
2505 || st.st_mtime != buf->b_mtime_read
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01002506#ifdef ST_MTIM_NSEC
2507 || st.ST_MTIM_NSEC != buf->b_mtime_read_ns
2508#endif
Bram Moolenaar914703b2010-05-31 21:59:46 +02002509 || st.st_size != buf->b_orig_size)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 {
2511 ml_preserve(buf, FALSE);
2512 did_check_timestamps = FALSE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002513 need_check_timestamps = TRUE; // give message later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 }
2515 }
2516 if (buf->b_ml.ml_mfp->mf_dirty)
2517 {
2518 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
2519 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002520 if (check_char && ui_char_avail()) // character available now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 break;
2522 }
2523 }
2524}
2525
2526/*
2527 * sync one buffer, including negative blocks
2528 *
2529 * after this all the blocks are in the swap file
2530 *
2531 * Used for the :preserve command and when the original file has been
2532 * changed or deleted.
2533 *
2534 * when message is TRUE the success of preserving is reported
2535 */
2536 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002537ml_preserve(buf_T *buf, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538{
2539 bhdr_T *hp;
2540 linenr_T lnum;
2541 memfile_T *mfp = buf->b_ml.ml_mfp;
2542 int status;
2543 int got_int_save = got_int;
2544
2545 if (mfp == NULL || mfp->mf_fname == NULL)
2546 {
2547 if (message)
Bram Moolenaareaaac012022-01-02 17:00:40 +00002548 emsg(_(e_cannot_preserve_there_is_no_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 return;
2550 }
2551
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002552 // We only want to stop when interrupted here, not when interrupted
2553 // before.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 got_int = FALSE;
2555
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002556 ml_flush_line(buf); // flush buffered line
2557 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2559
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002560 // stack is invalid after mf_sync(.., MFS_ALL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 buf->b_ml.ml_stack_top = 0;
2562
2563 /*
2564 * Some of the data blocks may have been changed from negative to
2565 * positive block number. In that case the pointer blocks need to be
2566 * updated.
2567 *
2568 * We don't know in which pointer block the references are, so we visit
2569 * all data blocks until there are no more translations to be done (or
2570 * we hit the end of the file, which can only happen in case a write fails,
2571 * e.g. when file system if full).
2572 * ml_find_line() does the work by translating the negative block numbers
2573 * when getting the first line of each data block.
2574 */
2575 if (mf_need_trans(mfp) && !got_int)
2576 {
2577 lnum = 1;
2578 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2579 {
2580 hp = ml_find_line(buf, lnum, ML_FIND);
2581 if (hp == NULL)
2582 {
2583 status = FAIL;
2584 goto theend;
2585 }
2586 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2587 lnum = buf->b_ml.ml_locked_high + 1;
2588 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002589 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
2590 // sync the updated pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2592 status = FAIL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002593 buf->b_ml.ml_stack_top = 0; // stack is invalid now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 }
2595theend:
2596 got_int |= got_int_save;
2597
2598 if (message)
2599 {
2600 if (status == OK)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002601 msg(_("File preserved"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 else
Bram Moolenaareaaac012022-01-02 17:00:40 +00002603 emsg(_(e_preserve_failed));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 }
2605}
2606
2607/*
2608 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2609 * until the next call!
2610 * line1 = ml_get(1);
2611 * line2 = ml_get(2); // line1 is now invalid!
2612 * Make a copy of the line if necessary.
2613 */
2614/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002615 * Return a pointer to a (read-only copy of a) line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 *
2617 * On failure an error message is given and IObuff is returned (to avoid
2618 * having to check for error everywhere).
2619 */
2620 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002621ml_get(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622{
2623 return ml_get_buf(curbuf, lnum, FALSE);
2624}
2625
2626/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002627 * Return pointer to position "pos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 */
2629 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002630ml_get_pos(pos_T *pos)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631{
2632 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2633}
2634
2635/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002636 * Return pointer to cursor line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 */
2638 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002639ml_get_curline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640{
2641 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2642}
2643
2644/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002645 * Return pointer to cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 */
2647 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002648ml_get_cursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649{
2650 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2651 curwin->w_cursor.col);
2652}
2653
2654/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002655 * Return a pointer to a line in a specific buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 *
2657 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2658 * changed)
2659 */
2660 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002661ml_get_buf(
2662 buf_T *buf,
2663 linenr_T lnum,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002664 int will_change) // line will be changed
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665{
Bram Moolenaarad40f022007-02-13 03:01:39 +00002666 bhdr_T *hp;
2667 DATA_BL *dp;
Bram Moolenaarad40f022007-02-13 03:01:39 +00002668 static int recursive = 0;
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002669 static char_u questions[4];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002671 if (lnum > buf->b_ml.ml_line_count) // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002673 if (recursive == 0)
2674 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002675 // Avoid giving this message for a recursive call, may happen when
2676 // the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002677 ++recursive;
Bram Moolenaareaaac012022-01-02 17:00:40 +00002678 siemsg(_(e_ml_get_invalid_lnum_nr), lnum);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002679 --recursive;
2680 }
Bram Moolenaarf9435e42022-02-16 16:33:28 +00002681 ml_flush_line(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682errorret:
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002683 STRCPY(questions, "???");
Bram Moolenaaradfde112019-05-25 22:11:45 +02002684 buf->b_ml.ml_line_len = 4;
Bram Moolenaarf9435e42022-02-16 16:33:28 +00002685 buf->b_ml.ml_line_lnum = lnum;
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002686 return questions;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 }
Bram Moolenaaradfde112019-05-25 22:11:45 +02002688 if (lnum <= 0) // pretend line 0 is line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 lnum = 1;
2690
Bram Moolenaaradfde112019-05-25 22:11:45 +02002691 if (buf->b_ml.ml_mfp == NULL) // there are no lines
2692 {
2693 buf->b_ml.ml_line_len = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 return (char_u *)"";
Bram Moolenaaradfde112019-05-25 22:11:45 +02002695 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696
Bram Moolenaar37d619f2010-03-10 14:46:26 +01002697 /*
2698 * See if it is the same line as requested last time.
2699 * Otherwise may need to flush last used line.
2700 * Don't use the last used line when 'swapfile' is reset, need to load all
2701 * blocks.
2702 */
Bram Moolenaar47b8b152007-02-07 02:41:57 +00002703 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002705 unsigned start, end;
2706 colnr_T len;
2707 int idx;
2708
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 ml_flush_line(buf);
2710
2711 /*
2712 * Find the data block containing the line.
2713 * This also fills the stack with the blocks from the root to the data
2714 * block and releases any locked block.
2715 */
2716 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2717 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002718 if (recursive == 0)
2719 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002720 // Avoid giving this message for a recursive call, may happen
2721 // when the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002722 ++recursive;
Bram Moolenaarcb868932019-10-26 20:56:21 +02002723 get_trans_bufname(buf);
2724 shorten_dir(NameBuff);
Bram Moolenaareaaac012022-01-02 17:00:40 +00002725 siemsg(_(e_ml_get_cannot_find_line_nr_in_buffer_nr_str),
Bram Moolenaarcb868932019-10-26 20:56:21 +02002726 lnum, buf->b_fnum, NameBuff);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002727 --recursive;
2728 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729 goto errorret;
2730 }
2731
2732 dp = (DATA_BL *)(hp->bh_data);
2733
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002734 idx = lnum - buf->b_ml.ml_locked_low;
2735 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2736 // The text ends where the previous line starts. The first line ends
2737 // at the end of the block.
2738 if (idx == 0)
2739 end = dp->db_txt_end;
2740 else
2741 end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
2742 len = end - start;
2743
2744 buf->b_ml.ml_line_ptr = (char_u *)dp + start;
2745 buf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 buf->b_ml.ml_line_lnum = lnum;
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002747 buf->b_ml.ml_flags &= ~(ML_LINE_DIRTY | ML_ALLOCATED);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 }
2749 if (will_change)
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002750 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002752#ifdef FEAT_EVAL
2753 if (ml_get_alloc_lines && (buf->b_ml.ml_flags & ML_ALLOCATED))
2754 // can't make the change in the data block
2755 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
2756#endif
2757 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002759#ifdef FEAT_EVAL
2760 if (ml_get_alloc_lines
2761 && (buf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED)) == 0)
2762 {
2763 char_u *p = alloc(buf->b_ml.ml_line_len);
2764
2765 // make sure the text is in allocated memory
2766 if (p != NULL)
2767 {
2768 memmove(p, buf->b_ml.ml_line_ptr, buf->b_ml.ml_line_len);
2769 buf->b_ml.ml_line_ptr = p;
2770 buf->b_ml.ml_flags |= ML_ALLOCATED;
2771 if (will_change)
2772 // can't make the change in the data block
2773 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
2774 }
2775 }
2776#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 return buf->b_ml.ml_line_ptr;
2778}
2779
2780/*
2781 * Check if a line that was just obtained by a call to ml_get
2782 * is in allocated memory.
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002783 * This ignores ML_ALLOCATED to get the same behavior as without the test
2784 * override.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 */
2786 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002787ml_line_alloced(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788{
2789 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2790}
2791
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002792#ifdef FEAT_PROP_POPUP
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002793/*
2794 * Add text properties that continue from the previous line.
2795 */
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002796 static void
2797add_text_props_for_append(
2798 buf_T *buf,
2799 linenr_T lnum,
2800 char_u **line,
2801 int *len,
2802 char_u **tofree)
2803{
2804 int round;
2805 int new_prop_count = 0;
2806 int count;
2807 int n;
2808 char_u *props;
Bram Moolenaarea781452019-09-04 18:53:12 +02002809 int new_len = 0; // init for gcc
Bram Moolenaar8f13d822020-09-12 21:04:23 +02002810 char_u *new_line = NULL;
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002811 textprop_T prop;
2812
2813 // Make two rounds:
2814 // 1. calculate the extra space needed
2815 // 2. allocate the space and fill it
2816 for (round = 1; round <= 2; ++round)
2817 {
2818 if (round == 2)
2819 {
2820 if (new_prop_count == 0)
2821 return; // nothing to do
2822 new_len = *len + new_prop_count * sizeof(textprop_T);
Bram Moolenaar964b3742019-05-24 18:54:09 +02002823 new_line = alloc(new_len);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002824 if (new_line == NULL)
2825 return;
2826 mch_memmove(new_line, *line, *len);
2827 new_prop_count = 0;
2828 }
2829
2830 // Get the line above to find any props that continue in the next
2831 // line.
2832 count = get_text_props(buf, lnum, &props, FALSE);
2833 for (n = 0; n < count; ++n)
2834 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002835 mch_memmove(&prop, props + n * sizeof(textprop_T),
2836 sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002837 if (prop.tp_flags & TP_FLAG_CONT_NEXT)
2838 {
2839 if (round == 2)
2840 {
2841 prop.tp_flags |= TP_FLAG_CONT_PREV;
2842 prop.tp_col = 1;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002843 prop.tp_len = *len; // not exactly the right length
2844 mch_memmove(new_line + *len + new_prop_count
2845 * sizeof(textprop_T), &prop, sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002846 }
2847 ++new_prop_count;
2848 }
2849 }
2850 }
2851 *line = new_line;
2852 *tofree = new_line;
2853 *len = new_len;
2854}
2855#endif
2856
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002858ml_append_int(
2859 buf_T *buf,
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002860 linenr_T lnum, // append after this line (can be 0)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002861 char_u *line_arg, // text of the new line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002862 colnr_T len_arg, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002863 int flags) // ML_APPEND_ flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864{
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002865 char_u *line = line_arg;
2866 colnr_T len = len_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 int i;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002868 int line_count; // number of indexes in current block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 int offset;
2870 int from, to;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002871 int space_needed; // space needed for new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 int page_size;
2873 int page_count;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002874 int db_idx; // index for lnum in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 bhdr_T *hp;
2876 memfile_T *mfp;
2877 DATA_BL *dp;
2878 PTR_BL *pp;
2879 infoptr_T *ip;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002880#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002881 char_u *tofree = NULL;
Bram Moolenaar50652b02022-08-07 21:48:37 +01002882# ifdef FEAT_BYTEOFF
2883 colnr_T text_len = 0; // text len with NUL without text properties
2884# endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002885#endif
2886 int ret = FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002889 return FAIL; // lnum out of range
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890
2891 if (lowest_marked && lowest_marked > lnum)
2892 lowest_marked = lnum + 1;
2893
2894 if (len == 0)
Bram Moolenaar50652b02022-08-07 21:48:37 +01002895 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002896 len = (colnr_T)STRLEN(line) + 1; // space needed for the text
Bram Moolenaar50652b02022-08-07 21:48:37 +01002897#if defined(FEAT_PROP_POPUP) && defined(FEAT_BYTEOFF)
2898 text_len = len;
2899#endif
2900 }
2901#if defined(FEAT_PROP_POPUP) && defined(FEAT_BYTEOFF)
2902 else if (curbuf->b_has_textprop)
2903 // "len" may include text properties, get the length of the text.
2904 text_len = (colnr_T)STRLEN(line) + 1;
2905 else
2906 text_len = len;
2907#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002908
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002909#ifdef FEAT_PROP_POPUP
Bram Moolenaar840f91f2021-05-26 22:32:10 +02002910 if (curbuf->b_has_textprop && lnum > 0
2911 && !(flags & (ML_APPEND_UNDO | ML_APPEND_NOPROP)))
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002912 // Add text properties that continue from the previous line.
2913 add_text_props_for_append(buf, lnum, &line, &len, &tofree);
2914#endif
2915
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002916 space_needed = len + INDEX_SIZE; // space needed for text + index
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917
2918 mfp = buf->b_ml.ml_mfp;
2919 page_size = mfp->mf_page_size;
2920
2921/*
2922 * find the data block containing the previous line
2923 * This also fills the stack with the blocks from the root to the data block
2924 * This also releases any locked block.
2925 */
2926 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2927 ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002928 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929
2930 buf->b_ml.ml_flags &= ~ML_EMPTY;
2931
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002932 if (lnum == 0) // got line one instead, correct db_idx
2933 db_idx = -1; // careful, it is negative!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 else
2935 db_idx = lnum - buf->b_ml.ml_locked_low;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002936 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2938
2939 dp = (DATA_BL *)(hp->bh_data);
2940
2941/*
2942 * If
2943 * - there is not enough room in the current block
2944 * - appending to the last line in the block
2945 * - not appending to the last line in the file
2946 * insert in front of the next block.
2947 */
2948 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2949 && lnum < buf->b_ml.ml_line_count)
2950 {
2951 /*
2952 * Now that the line is not going to be inserted in the block that we
2953 * expected, the line count has to be adjusted in the pointer blocks
2954 * by using ml_locked_lineadd.
2955 */
2956 --(buf->b_ml.ml_locked_lineadd);
2957 --(buf->b_ml.ml_locked_high);
2958 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002959 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002961 db_idx = -1; // careful, it is negative!
2962 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2964 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2965
2966 dp = (DATA_BL *)(hp->bh_data);
2967 }
2968
2969 ++buf->b_ml.ml_line_count;
2970
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002971 if ((int)dp->db_free >= space_needed) // enough room in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 {
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002973 /*
2974 * Insert the new line in an existing data block, or in the data block
2975 * allocated above.
2976 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 dp->db_txt_start -= len;
2978 dp->db_free -= space_needed;
2979 ++(dp->db_line_count);
2980
2981 /*
2982 * move the text of the lines that follow to the front
2983 * adjust the indexes of the lines that follow
2984 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002985 if (line_count > db_idx + 1) // if there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 {
2987 /*
2988 * Offset is the start of the previous line.
2989 * This will become the character just after the new line.
2990 */
2991 if (db_idx < 0)
2992 offset = dp->db_txt_end;
2993 else
2994 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2995 mch_memmove((char *)dp + dp->db_txt_start,
2996 (char *)dp + dp->db_txt_start + len,
2997 (size_t)(offset - (dp->db_txt_start + len)));
2998 for (i = line_count - 1; i > db_idx; --i)
2999 dp->db_index[i + 1] = dp->db_index[i] - len;
3000 dp->db_index[db_idx + 1] = offset - len;
3001 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003002 else
3003 // add line at the end (which is the start of the text)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 dp->db_index[db_idx + 1] = dp->db_txt_start;
3005
3006 /*
3007 * copy the text into the block
3008 */
3009 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003010 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 dp->db_index[db_idx + 1] |= DB_MARKED;
3012
3013 /*
3014 * Mark the block dirty.
3015 */
3016 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003017 if (!(flags & ML_APPEND_NEW))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 buf->b_ml.ml_flags |= ML_LOCKED_POS;
3019 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003020 else // not enough space in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 long line_count_left, line_count_right;
3023 int page_count_left, page_count_right;
3024 bhdr_T *hp_left;
3025 bhdr_T *hp_right;
3026 bhdr_T *hp_new;
3027 int lines_moved;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003028 int data_moved = 0; // init to shut up gcc
3029 int total_moved = 0; // init to shut up gcc
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 DATA_BL *dp_right, *dp_left;
3031 int stack_idx;
3032 int in_left;
3033 int lineadd;
3034 blocknr_T bnum_left, bnum_right;
3035 linenr_T lnum_left, lnum_right;
3036 int pb_idx;
3037 PTR_BL *pp_new;
3038
3039 /*
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003040 * There is not enough room, we have to create a new data block and
3041 * copy some lines into it.
3042 * Then we have to insert an entry in the pointer block.
3043 * If this pointer block also is full, we go up another block, and so
3044 * on, up to the root if necessary.
3045 * The line counts in the pointer blocks have already been adjusted by
3046 * ml_find_line().
3047 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 * We are going to allocate a new data block. Depending on the
3049 * situation it will be put to the left or right of the existing
3050 * block. If possible we put the new line in the left block and move
3051 * the lines after it to the right block. Otherwise the new line is
3052 * also put in the right block. This method is more efficient when
3053 * inserting a lot of lines at one place.
3054 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003055 if (db_idx < 0) // left block is new, right block is existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 {
3057 lines_moved = 0;
3058 in_left = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003059 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003061 else // left block is existing, right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 {
3063 lines_moved = line_count - db_idx - 1;
3064 if (lines_moved == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003065 in_left = FALSE; // put new line in right block
3066 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 else
3068 {
3069 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
3070 dp->db_txt_start;
3071 total_moved = data_moved + lines_moved * INDEX_SIZE;
3072 if ((int)dp->db_free + total_moved >= space_needed)
3073 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003074 in_left = TRUE; // put new line in left block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 space_needed = total_moved;
3076 }
3077 else
3078 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003079 in_left = FALSE; // put new line in right block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 space_needed += total_moved;
3081 }
3082 }
3083 }
3084
3085 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003086 if ((hp_new = ml_new_data(mfp, flags & ML_APPEND_NEW, page_count))
3087 == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003089 // correct line counts in pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 --(buf->b_ml.ml_locked_lineadd);
3091 --(buf->b_ml.ml_locked_high);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003092 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003094 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 {
3096 hp_left = hp_new;
3097 hp_right = hp;
3098 line_count_left = 0;
3099 line_count_right = line_count;
3100 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003101 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 {
3103 hp_left = hp;
3104 hp_right = hp_new;
3105 line_count_left = line_count;
3106 line_count_right = 0;
3107 }
3108 dp_right = (DATA_BL *)(hp_right->bh_data);
3109 dp_left = (DATA_BL *)(hp_left->bh_data);
3110 bnum_left = hp_left->bh_bnum;
3111 bnum_right = hp_right->bh_bnum;
3112 page_count_left = hp_left->bh_page_count;
3113 page_count_right = hp_right->bh_page_count;
3114
3115 /*
3116 * May move the new line into the right/new block.
3117 */
3118 if (!in_left)
3119 {
3120 dp_right->db_txt_start -= len;
3121 dp_right->db_free -= len + INDEX_SIZE;
3122 dp_right->db_index[0] = dp_right->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003123 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 dp_right->db_index[0] |= DB_MARKED;
3125
3126 mch_memmove((char *)dp_right + dp_right->db_txt_start,
3127 line, (size_t)len);
3128 ++line_count_right;
3129 }
3130 /*
3131 * may move lines from the left/old block to the right/new one.
3132 */
3133 if (lines_moved)
3134 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 dp_right->db_txt_start -= data_moved;
3136 dp_right->db_free -= total_moved;
3137 mch_memmove((char *)dp_right + dp_right->db_txt_start,
3138 (char *)dp_left + dp_left->db_txt_start,
3139 (size_t)data_moved);
3140 offset = dp_right->db_txt_start - dp_left->db_txt_start;
3141 dp_left->db_txt_start += data_moved;
3142 dp_left->db_free += total_moved;
3143
3144 /*
3145 * update indexes in the new block
3146 */
3147 for (to = line_count_right, from = db_idx + 1;
3148 from < line_count_left; ++from, ++to)
3149 dp_right->db_index[to] = dp->db_index[from] + offset;
3150 line_count_right += lines_moved;
3151 line_count_left -= lines_moved;
3152 }
3153
3154 /*
3155 * May move the new line into the left (old or new) block.
3156 */
3157 if (in_left)
3158 {
3159 dp_left->db_txt_start -= len;
3160 dp_left->db_free -= len + INDEX_SIZE;
3161 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003162 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 dp_left->db_index[line_count_left] |= DB_MARKED;
3164 mch_memmove((char *)dp_left + dp_left->db_txt_start,
3165 line, (size_t)len);
3166 ++line_count_left;
3167 }
3168
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003169 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 {
3171 lnum_left = lnum + 1;
3172 lnum_right = 0;
3173 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003174 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 {
3176 lnum_left = 0;
3177 if (in_left)
3178 lnum_right = lnum + 2;
3179 else
3180 lnum_right = lnum + 1;
3181 }
3182 dp_left->db_line_count = line_count_left;
3183 dp_right->db_line_count = line_count_right;
3184
3185 /*
3186 * release the two data blocks
3187 * The new one (hp_new) already has a correct blocknumber.
3188 * The old one (hp, in ml_locked) gets a positive blocknumber if
3189 * we changed it and we are not editing a new file.
3190 */
3191 if (lines_moved || in_left)
3192 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003193 if (!(flags & ML_APPEND_NEW) && db_idx >= 0 && in_left)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 buf->b_ml.ml_flags |= ML_LOCKED_POS;
3195 mf_put(mfp, hp_new, TRUE, FALSE);
3196
3197 /*
3198 * flush the old data block
3199 * set ml_locked_lineadd to 0, because the updating of the
3200 * pointer blocks is done below
3201 */
3202 lineadd = buf->b_ml.ml_locked_lineadd;
3203 buf->b_ml.ml_locked_lineadd = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003204 ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205
3206 /*
3207 * update pointer blocks for the new data block
3208 */
3209 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3210 --stack_idx)
3211 {
3212 ip = &(buf->b_ml.ml_stack[stack_idx]);
3213 pb_idx = ip->ip_index;
3214 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003215 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003216 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 if (pp->pb_id != PTR_ID)
3218 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00003219 iemsg(_(e_pointer_block_id_wrong_three));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003221 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 }
3223 /*
3224 * TODO: If the pointer block is full and we are adding at the end
3225 * try to insert in front of the next block
3226 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003227 // block not full, add one entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 if (pp->pb_count < pp->pb_count_max)
3229 {
3230 if (pb_idx + 1 < (int)pp->pb_count)
3231 mch_memmove(&pp->pb_pointer[pb_idx + 2],
3232 &pp->pb_pointer[pb_idx + 1],
3233 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
3234 ++pp->pb_count;
3235 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3236 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3237 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3238 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3239 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3240 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3241
3242 if (lnum_left != 0)
3243 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3244 if (lnum_right != 0)
3245 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3246
3247 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003248 buf->b_ml.ml_stack_top = stack_idx + 1; // truncate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249
3250 if (lineadd)
3251 {
3252 --(buf->b_ml.ml_stack_top);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003253 // fix line count for rest of blocks in the stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 ml_lineadd(buf, lineadd);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003255 // fix stack itself
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
3257 lineadd;
3258 ++(buf->b_ml.ml_stack_top);
3259 }
3260
3261 /*
3262 * We are finished, break the loop here.
3263 */
3264 break;
3265 }
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003266 // pointer block full
3267 /*
3268 * split the pointer block
3269 * allocate a new pointer block
3270 * move some of the pointer into the new block
3271 * prepare for updating the parent block
3272 */
3273 for (;;) // do this twice when splitting block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 {
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003275 hp_new = ml_new_ptr(mfp);
3276 if (hp_new == NULL) // TODO: try to fix tree
3277 goto theend;
3278 pp_new = (PTR_BL *)(hp_new->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003280 if (hp->bh_bnum != 1)
3281 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 /*
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003284 * if block 1 becomes full the tree is given an extra level
3285 * The pointers from block 1 are moved into the new block.
3286 * block 1 is updated to point to the new block
3287 * then continue to split the new block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 */
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003289 mch_memmove(pp_new, pp, (size_t)page_size);
3290 pp->pb_count = 1;
3291 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
3292 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
3293 pp->pb_pointer[0].pe_old_lnum = 1;
3294 pp->pb_pointer[0].pe_page_count = 1;
3295 mf_put(mfp, hp, TRUE, FALSE); // release block 1
3296 hp = hp_new; // new block is to be split
3297 pp = pp_new;
3298 CHECK(stack_idx != 0, _("stack_idx should be 0"));
3299 ip->ip_index = 0;
3300 ++stack_idx; // do block 1 again later
3301 }
3302 /*
3303 * move the pointers after the current one to the new block
3304 * If there are none, the new entry will be in the new block.
3305 */
3306 total_moved = pp->pb_count - pb_idx - 1;
3307 if (total_moved)
3308 {
3309 mch_memmove(&pp_new->pb_pointer[0],
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 &pp->pb_pointer[pb_idx + 1],
3311 (size_t)(total_moved) * sizeof(PTR_EN));
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003312 pp_new->pb_count = total_moved;
3313 pp->pb_count -= total_moved - 1;
3314 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3315 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3316 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3317 if (lnum_right)
3318 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 }
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003320 else
3321 {
3322 pp_new->pb_count = 1;
3323 pp_new->pb_pointer[0].pe_bnum = bnum_right;
3324 pp_new->pb_pointer[0].pe_line_count = line_count_right;
3325 pp_new->pb_pointer[0].pe_page_count = page_count_right;
3326 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
3327 }
3328 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3329 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3330 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3331 if (lnum_left)
3332 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3333 lnum_left = 0;
3334 lnum_right = 0;
3335
3336 /*
3337 * recompute line counts
3338 */
3339 line_count_right = 0;
3340 for (i = 0; i < (int)pp_new->pb_count; ++i)
3341 line_count_right += pp_new->pb_pointer[i].pe_line_count;
3342 line_count_left = 0;
3343 for (i = 0; i < (int)pp->pb_count; ++i)
3344 line_count_left += pp->pb_pointer[i].pe_line_count;
3345
3346 bnum_left = hp->bh_bnum;
3347 bnum_right = hp_new->bh_bnum;
3348 page_count_left = 1;
3349 page_count_right = 1;
3350 mf_put(mfp, hp, TRUE, FALSE);
3351 mf_put(mfp, hp_new, TRUE, FALSE);
3352
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 }
3354
3355 /*
3356 * Safety check: fallen out of for loop?
3357 */
3358 if (stack_idx < 0)
3359 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00003360 iemsg(_(e_updated_too_many_blocks));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003361 buf->b_ml.ml_stack_top = 0; // invalidate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 }
3363 }
3364
3365#ifdef FEAT_BYTEOFF
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003366 // The line was inserted below 'lnum'
Bram Moolenaar50652b02022-08-07 21:48:37 +01003367 ml_updatechunk(buf, lnum + 1,
3368# ifdef FEAT_PROP_POPUP
3369 (long)text_len
3370# else
3371 (long)len
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003372# endif
Bram Moolenaar50652b02022-08-07 21:48:37 +01003373 , ML_CHNK_ADDLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374#endif
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003375
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003377 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 {
3379 if (STRLEN(line) > 0)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003380 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003381 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 (char_u *)"\n", 1);
3383 }
3384#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01003385#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003386 if (buf->b_write_to_channel)
3387 channel_write_new_lines(buf);
3388#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003389 ret = OK;
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003390
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003391theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003392#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003393 vim_free(tofree);
3394#endif
3395 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396}
3397
3398/*
Bram Moolenaar250e3112019-07-15 23:02:14 +02003399 * Flush any pending change and call ml_append_int()
3400 */
3401 static int
3402ml_append_flush(
3403 buf_T *buf,
3404 linenr_T lnum, // append after this line (can be 0)
3405 char_u *line, // text of the new line
3406 colnr_T len, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003407 int flags) // ML_APPEND_ flags
Bram Moolenaar250e3112019-07-15 23:02:14 +02003408{
3409 if (lnum > buf->b_ml.ml_line_count)
3410 return FAIL; // lnum out of range
3411
3412 if (buf->b_ml.ml_line_lnum != 0)
3413 // This may also invoke ml_append_int().
3414 ml_flush_line(buf);
3415
3416#ifdef FEAT_EVAL
3417 // When inserting above recorded changes: flush the changes before changing
3418 // the text. Then flush the cached line, it may become invalid.
3419 may_invoke_listeners(buf, lnum + 1, lnum + 1, 1);
3420 if (buf->b_ml.ml_line_lnum != 0)
3421 ml_flush_line(buf);
3422#endif
3423
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003424 return ml_append_int(buf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003425}
3426
3427/*
3428 * Append a line after lnum (may be 0 to insert a line in front of the file).
3429 * "line" does not need to be allocated, but can't be another line in a
3430 * buffer, unlocking may make it invalid.
3431 *
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003432 * "newfile": TRUE when starting to edit a new file, meaning that pe_old_lnum
Bram Moolenaar250e3112019-07-15 23:02:14 +02003433 * will be set for recovery
3434 * Check: The caller of this function should probably also call
3435 * appended_lines().
3436 *
3437 * return FAIL for failure, OK otherwise
3438 */
3439 int
3440ml_append(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003441 linenr_T lnum, // append after this line (can be 0)
3442 char_u *line, // text of the new line
3443 colnr_T len, // length of new line, including NUL, or 0
3444 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003445{
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003446 return ml_append_flags(lnum, line, len, newfile ? ML_APPEND_NEW : 0);
3447}
3448
3449 int
3450ml_append_flags(
3451 linenr_T lnum, // append after this line (can be 0)
3452 char_u *line, // text of the new line
3453 colnr_T len, // length of new line, including NUL, or 0
3454 int flags) // ML_APPEND_ values
3455{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003456 // When starting up, we might still need to create the memfile
Bram Moolenaar250e3112019-07-15 23:02:14 +02003457 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
3458 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003459 return ml_append_flush(curbuf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003460}
3461
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003462
Bram Moolenaar9f28eeb2022-05-16 10:04:51 +01003463#if defined(FEAT_SPELL) || defined(FEAT_QUICKFIX) || defined(FEAT_PROP_POPUP) \
3464 || defined(PROTO)
Bram Moolenaar250e3112019-07-15 23:02:14 +02003465/*
3466 * Like ml_append() but for an arbitrary buffer. The buffer must already have
3467 * a memline.
3468 */
3469 int
3470ml_append_buf(
3471 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003472 linenr_T lnum, // append after this line (can be 0)
3473 char_u *line, // text of the new line
3474 colnr_T len, // length of new line, including NUL, or 0
3475 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003476{
3477 if (buf->b_ml.ml_mfp == NULL)
3478 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003479 return ml_append_flush(buf, lnum, line, len, newfile ? ML_APPEND_NEW : 0);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003480}
3481#endif
3482
3483/*
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003484 * Replace line "lnum", with buffering, in current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 *
Bram Moolenaar1056d982006-03-09 22:37:52 +00003486 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 * copied to allocated memory already.
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003488 * If "copy" is FALSE the "line" may be freed to add text properties!
3489 * Do not use it after calling ml_replace().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 *
3491 * Check: The caller of this function should probably also call
Bram Moolenaara4d158b2022-08-14 14:17:45 +01003492 * changed_lines(), unless update_screen(UPD_NOT_VALID) is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 *
3494 * return FAIL for failure, OK otherwise
3495 */
3496 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003497ml_replace(linenr_T lnum, char_u *line, int copy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498{
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003499 colnr_T len = -1;
3500
3501 if (line != NULL)
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003502 len = (colnr_T)STRLEN(line);
Bram Moolenaarccae4672019-01-04 15:09:57 +01003503 return ml_replace_len(lnum, line, len, FALSE, copy);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003504}
3505
Bram Moolenaarccae4672019-01-04 15:09:57 +01003506/*
3507 * Replace a line for the current buffer. Like ml_replace() with:
3508 * "len_arg" is the length of the text, excluding NUL.
3509 * If "has_props" is TRUE then "line_arg" includes the text properties and
3510 * "len_arg" includes the NUL of the text.
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01003511 * When "copy" is TRUE copy the text into allocated memory, otherwise
3512 * "line_arg" must be allocated and will be consumed here.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003513 */
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003514 int
Bram Moolenaarccae4672019-01-04 15:09:57 +01003515ml_replace_len(
3516 linenr_T lnum,
3517 char_u *line_arg,
3518 colnr_T len_arg,
3519 int has_props,
3520 int copy)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003521{
3522 char_u *line = line_arg;
3523 colnr_T len = len_arg;
3524
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003525 if (line == NULL) // just checking...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 return FAIL;
3527
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003528 // When starting up, we might still need to create the memfile
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003529 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 return FAIL;
3531
Bram Moolenaarccae4672019-01-04 15:09:57 +01003532 if (!has_props)
3533 ++len; // include the NUL after the text
3534 if (copy)
3535 {
3536 // copy the line to allocated memory
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003537#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003538 if (has_props)
3539 line = vim_memsave(line, len);
3540 else
3541#endif
3542 line = vim_strnsave(line, len - 1);
3543 if (line == NULL)
3544 return FAIL;
3545 }
3546
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003548 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 {
3550 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003551 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 }
3553#endif
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003554 if (curbuf->b_ml.ml_line_lnum != lnum)
3555 {
3556 // another line is buffered, flush it
3557 ml_flush_line(curbuf);
3558
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003559#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003560 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003561 // Need to fetch the old line to copy over any text properties.
3562 ml_get_buf(curbuf, lnum, TRUE);
3563#endif
3564 }
3565
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003566#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003567 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003568 {
3569 size_t oldtextlen = STRLEN(curbuf->b_ml.ml_line_ptr) + 1;
3570
3571 if (oldtextlen < (size_t)curbuf->b_ml.ml_line_len)
3572 {
3573 char_u *newline;
3574 size_t textproplen = curbuf->b_ml.ml_line_len - oldtextlen;
3575
3576 // Need to copy over text properties, stored after the text.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003577 newline = alloc(len + (int)textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003578 if (newline != NULL)
3579 {
Bram Moolenaarccae4672019-01-04 15:09:57 +01003580 mch_memmove(newline, line, len);
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02003581 mch_memmove(newline + len, curbuf->b_ml.ml_line_ptr
3582 + oldtextlen, textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003583 vim_free(line);
3584 line = newline;
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003585 len += (colnr_T)textproplen;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003586 }
3587 }
3588 }
3589#endif
3590
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01003591 if (curbuf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
3592 vim_free(curbuf->b_ml.ml_line_ptr); // free allocated line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003593
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 curbuf->b_ml.ml_line_ptr = line;
Bram Moolenaarccae4672019-01-04 15:09:57 +01003595 curbuf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 curbuf->b_ml.ml_line_lnum = lnum;
3597 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
3598
3599 return OK;
3600}
3601
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003602#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003603/*
3604 * Adjust text properties in line "lnum" for a deleted line.
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003605 * When "above" is true this is the line above the deleted line, otherwise this
3606 * is the line below the deleted line.
3607 * "del_props[del_props_len]" are the properties of the deleted line.
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003608 */
3609 static void
3610adjust_text_props_for_delete(
3611 buf_T *buf,
3612 linenr_T lnum,
3613 char_u *del_props,
3614 int del_props_len,
3615 int above)
3616{
3617 int did_get_line = FALSE;
3618 int done_del;
3619 int done_this;
3620 textprop_T prop_del;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003621 bhdr_T *hp;
3622 DATA_BL *dp;
3623 int idx;
3624 int line_start;
3625 long line_size;
3626 int this_props_len;
3627 char_u *text;
3628 size_t textlen;
3629 int found;
3630
3631 for (done_del = 0; done_del < del_props_len; done_del += sizeof(textprop_T))
3632 {
3633 mch_memmove(&prop_del, del_props + done_del, sizeof(textprop_T));
3634 if ((above && (prop_del.tp_flags & TP_FLAG_CONT_PREV)
3635 && !(prop_del.tp_flags & TP_FLAG_CONT_NEXT))
3636 || (!above && (prop_del.tp_flags & TP_FLAG_CONT_NEXT)
3637 && !(prop_del.tp_flags & TP_FLAG_CONT_PREV)))
3638 {
3639 if (!did_get_line)
3640 {
3641 did_get_line = TRUE;
3642 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
3643 return;
3644
3645 dp = (DATA_BL *)(hp->bh_data);
3646 idx = lnum - buf->b_ml.ml_locked_low;
3647 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3648 if (idx == 0) // first line in block, text at the end
3649 line_size = dp->db_txt_end - line_start;
3650 else
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003651 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK)
3652 - line_start;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003653 text = (char_u *)dp + line_start;
3654 textlen = STRLEN(text) + 1;
3655 if ((long)textlen >= line_size)
3656 {
3657 if (above)
3658 internal_error("no text property above deleted line");
3659 else
3660 internal_error("no text property below deleted line");
3661 return;
3662 }
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01003663 this_props_len = line_size - (int)textlen;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003664 }
3665
3666 found = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003667 for (done_this = 0; done_this < this_props_len;
3668 done_this += sizeof(textprop_T))
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003669 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003670 int flag = above ? TP_FLAG_CONT_NEXT
3671 : TP_FLAG_CONT_PREV;
3672 textprop_T prop_this;
3673
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003674 mch_memmove(&prop_this, text + textlen + done_this,
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003675 sizeof(textprop_T));
3676 if ((prop_this.tp_flags & flag)
3677 && prop_del.tp_id == prop_this.tp_id
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003678 && prop_del.tp_type == prop_this.tp_type)
3679 {
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003680 found = TRUE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003681 prop_this.tp_flags &= ~flag;
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003682 mch_memmove(text + textlen + done_this, &prop_this,
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003683 sizeof(textprop_T));
3684 break;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003685 }
3686 }
3687 if (!found)
3688 {
3689 if (above)
3690 internal_error("text property above deleted line not found");
3691 else
3692 internal_error("text property below deleted line not found");
3693 }
3694
3695 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3696 }
3697 }
3698}
3699#endif
3700
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701/*
Bram Moolenaar4033c552017-09-16 20:54:51 +02003702 * Delete line "lnum" in the current buffer.
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003703 * When "flags" has ML_DEL_MESSAGE may give a "No lines in buffer" message.
3704 * When "flags" has ML_DEL_UNDO this is called from undo.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 *
3706 * return FAIL for failure, OK otherwise
3707 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 static int
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003709ml_delete_int(buf_T *buf, linenr_T lnum, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710{
3711 bhdr_T *hp;
3712 memfile_T *mfp;
3713 DATA_BL *dp;
3714 PTR_BL *pp;
3715 infoptr_T *ip;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003716 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 int idx;
3718 int stack_idx;
3719 int text_start;
3720 int line_start;
3721 long line_size;
3722 int i;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003723 int ret = FAIL;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003724#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003725 char_u *textprop_save = NULL;
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003726 long textprop_len = 0;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003727#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 if (lowest_marked && lowest_marked > lnum)
3730 lowest_marked--;
3731
3732/*
3733 * If the file becomes empty the last line is replaced by an empty line.
3734 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003735 if (buf->b_ml.ml_line_count == 1) // file becomes empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003737 if ((flags & ML_DEL_MESSAGE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738#ifdef FEAT_NETBEANS_INTG
3739 && !netbeansSuppressNoLines
3740#endif
3741 )
Bram Moolenaar238a5642006-02-21 22:12:05 +00003742 set_keep_msg((char_u *)_(no_lines_msg), 0);
3743
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003744 // FEAT_BYTEOFF already handled in there, don't worry 'bout it below
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
3746 buf->b_ml.ml_flags |= ML_EMPTY;
3747
3748 return i;
3749 }
3750
3751/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003752 * Find the data block containing the line.
3753 * This also fills the stack with the blocks from the root to the data block.
3754 * This also releases any locked block..
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 */
3756 mfp = buf->b_ml.ml_mfp;
3757 if (mfp == NULL)
3758 return FAIL;
3759
3760 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
3761 return FAIL;
3762
3763 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003764 // compute line count before the delete
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 count = (long)(buf->b_ml.ml_locked_high)
3766 - (long)(buf->b_ml.ml_locked_low) + 2;
3767 idx = lnum - buf->b_ml.ml_locked_low;
3768
3769 --buf->b_ml.ml_line_count;
3770
3771 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003772 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 line_size = dp->db_txt_end - line_start;
3774 else
3775 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
3776
3777#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003778 if (netbeans_active())
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00003779 netbeans_removed(buf, lnum, 0, line_size);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003781#ifdef FEAT_PROP_POPUP
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003782 // If there are text properties compute their byte length.
3783 // if needed make a copy, so that we can update properties in preceding and
3784 // following lines.
3785 if (buf->b_has_textprop)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003786 {
3787 size_t textlen = STRLEN((char_u *)dp + line_start) + 1;
3788
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003789 textprop_len = line_size - (long)textlen;
3790 if (!(flags & (ML_DEL_UNDO | ML_DEL_NOPROP)) && textprop_len > 0)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003791 textprop_save = vim_memsave((char_u *)dp + line_start + textlen,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003792 textprop_len);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003793 }
3794#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795
3796/*
3797 * special case: If there is only one line in the data block it becomes empty.
3798 * Then we have to remove the entry, pointing to this data block, from the
3799 * pointer block. If this pointer block also becomes empty, we go up another
3800 * block, and so on, up to the root if necessary.
3801 * The line counts in the pointer blocks have already been adjusted by
3802 * ml_find_line().
3803 */
3804 if (count == 1)
3805 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003806 mf_free(mfp, hp); // free the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 buf->b_ml.ml_locked = NULL;
3808
Bram Moolenaare60acc12011-05-10 16:41:25 +02003809 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3810 --stack_idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003812 buf->b_ml.ml_stack_top = 0; // stack is invalid when failing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 ip = &(buf->b_ml.ml_stack[stack_idx]);
3814 idx = ip->ip_index;
3815 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003816 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003817 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 if (pp->pb_id != PTR_ID)
3819 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00003820 iemsg(_(e_pointer_block_id_wrong_four));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003822 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 }
3824 count = --(pp->pb_count);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003825 if (count == 0) // the pointer block becomes empty!
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 mf_free(mfp, hp);
3827 else
3828 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003829 if (count != idx) // move entries after the deleted one
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
3831 (size_t)(count - idx) * sizeof(PTR_EN));
3832 mf_put(mfp, hp, TRUE, FALSE);
3833
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003834 buf->b_ml.ml_stack_top = stack_idx; // truncate stack
3835 // fix line count for rest of blocks in the stack
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003836 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 {
3838 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3839 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003840 buf->b_ml.ml_locked_lineadd;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 }
3842 ++(buf->b_ml.ml_stack_top);
3843
3844 break;
3845 }
3846 }
3847 CHECK(stack_idx < 0, _("deleted block 1?"));
3848 }
3849 else
3850 {
3851 /*
3852 * delete the text by moving the next lines forwards
3853 */
3854 text_start = dp->db_txt_start;
3855 mch_memmove((char *)dp + text_start + line_size,
3856 (char *)dp + text_start, (size_t)(line_start - text_start));
3857
3858 /*
3859 * delete the index by moving the next indexes backwards
3860 * Adjust the indexes for the text movement.
3861 */
3862 for (i = idx; i < count - 1; ++i)
3863 dp->db_index[i] = dp->db_index[i + 1] + line_size;
3864
3865 dp->db_free += line_size + INDEX_SIZE;
3866 dp->db_txt_start += line_size;
3867 --(dp->db_line_count);
3868
3869 /*
3870 * mark the block dirty and make sure it is in the file (for recovery)
3871 */
3872 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3873 }
3874
3875#ifdef FEAT_BYTEOFF
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003876 ml_updatechunk(buf, lnum, line_size
3877# ifdef FEAT_PROP_POPUP
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003878 - textprop_len
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003879# endif
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003880 , ML_CHNK_DELLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881#endif
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003882 ret = OK;
3883
3884theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003885#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003886 if (textprop_save != NULL)
3887 {
3888 // Adjust text properties in the line above and below.
3889 if (lnum > 1)
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02003890 adjust_text_props_for_delete(buf, lnum - 1, textprop_save,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003891 (int)textprop_len, TRUE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003892 if (lnum <= buf->b_ml.ml_line_count)
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02003893 adjust_text_props_for_delete(buf, lnum, textprop_save,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003894 (int)textprop_len, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003895 }
3896 vim_free(textprop_save);
3897#endif
3898 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899}
3900
3901/*
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003902 * Delete line "lnum" in the current buffer.
3903 * When "message" is TRUE may give a "No lines in buffer" message.
3904 *
3905 * Check: The caller of this function should probably also call
3906 * deleted_lines() after this.
3907 *
3908 * return FAIL for failure, OK otherwise
3909 */
3910 int
Bram Moolenaarca70c072020-05-30 20:30:46 +02003911ml_delete(linenr_T lnum)
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003912{
Bram Moolenaarca70c072020-05-30 20:30:46 +02003913 return ml_delete_flags(lnum, 0);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003914}
3915
3916/*
3917 * Like ml_delete() but using flags (see ml_delete_int()).
3918 */
3919 int
3920ml_delete_flags(linenr_T lnum, int flags)
3921{
3922 ml_flush_line(curbuf);
3923 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
3924 return FAIL;
3925
3926#ifdef FEAT_EVAL
3927 // When inserting above recorded changes: flush the changes before changing
3928 // the text.
3929 may_invoke_listeners(curbuf, lnum, lnum + 1, -1);
3930#endif
3931
3932 return ml_delete_int(curbuf, lnum, flags);
3933}
3934
3935/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003936 * set the DB_MARKED flag for line 'lnum'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 */
3938 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003939ml_setmarked(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940{
3941 bhdr_T *hp;
3942 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003943 // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3945 || curbuf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003946 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947
3948 if (lowest_marked == 0 || lowest_marked > lnum)
3949 lowest_marked = lnum;
3950
3951 /*
3952 * find the data block containing the line
3953 * This also fills the stack with the blocks from the root to the data block
3954 * This also releases any locked block.
3955 */
3956 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003957 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958
3959 dp = (DATA_BL *)(hp->bh_data);
3960 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
3961 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3962}
3963
3964/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003965 * find the first line with its DB_MARKED flag set
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 */
3967 linenr_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003968ml_firstmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969{
3970 bhdr_T *hp;
3971 DATA_BL *dp;
3972 linenr_T lnum;
3973 int i;
3974
3975 if (curbuf->b_ml.ml_mfp == NULL)
3976 return (linenr_T) 0;
3977
3978 /*
3979 * The search starts with lowest_marked line. This is the last line where
3980 * a mark was found, adjusted by inserting/deleting lines.
3981 */
3982 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3983 {
3984 /*
3985 * Find the data block containing the line.
3986 * This also fills the stack with the blocks from the root to the data
3987 * block This also releases any locked block.
3988 */
3989 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003990 return (linenr_T)0; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991
3992 dp = (DATA_BL *)(hp->bh_data);
3993
3994 for (i = lnum - curbuf->b_ml.ml_locked_low;
3995 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3996 if ((dp->db_index[i]) & DB_MARKED)
3997 {
3998 (dp->db_index[i]) &= DB_INDEX_MASK;
3999 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
4000 lowest_marked = lnum + 1;
4001 return lnum;
4002 }
4003 }
4004
4005 return (linenr_T) 0;
4006}
4007
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008/*
4009 * clear all DB_MARKED flags
4010 */
4011 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004012ml_clearmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013{
4014 bhdr_T *hp;
4015 DATA_BL *dp;
4016 linenr_T lnum;
4017 int i;
4018
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004019 if (curbuf->b_ml.ml_mfp == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 return;
4021
4022 /*
4023 * The search starts with line lowest_marked.
4024 */
4025 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
4026 {
4027 /*
4028 * Find the data block containing the line.
4029 * This also fills the stack with the blocks from the root to the data
4030 * block and releases any locked block.
4031 */
4032 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004033 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034
4035 dp = (DATA_BL *)(hp->bh_data);
4036
4037 for (i = lnum - curbuf->b_ml.ml_locked_low;
4038 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
4039 if ((dp->db_index[i]) & DB_MARKED)
4040 {
4041 (dp->db_index[i]) &= DB_INDEX_MASK;
4042 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
4043 }
4044 }
4045
4046 lowest_marked = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047}
4048
4049/*
4050 * flush ml_line if necessary
4051 */
4052 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004053ml_flush_line(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054{
4055 bhdr_T *hp;
4056 DATA_BL *dp;
4057 linenr_T lnum;
4058 char_u *new_line;
4059 char_u *old_line;
4060 colnr_T new_len;
4061 int old_len;
4062 int extra;
4063 int idx;
4064 int start;
4065 int count;
4066 int i;
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004067 static int entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068
4069 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004070 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071
4072 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
4073 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004074 // This code doesn't work recursively, but Netbeans may call back here
4075 // when obtaining the cursor position.
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004076 if (entered)
4077 return;
4078 entered = TRUE;
4079
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 lnum = buf->b_ml.ml_line_lnum;
4081 new_line = buf->b_ml.ml_line_ptr;
4082
4083 hp = ml_find_line(buf, lnum, ML_FIND);
4084 if (hp == NULL)
Bram Moolenaareaaac012022-01-02 17:00:40 +00004085 siemsg(_(e_cannot_find_line_nr), lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 else
4087 {
4088 dp = (DATA_BL *)(hp->bh_data);
4089 idx = lnum - buf->b_ml.ml_locked_low;
4090 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
4091 old_line = (char_u *)dp + start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004092 if (idx == 0) // line is last in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 old_len = dp->db_txt_end - start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004094 else // text of previous line follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01004096 new_len = buf->b_ml.ml_line_len;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004097 extra = new_len - old_len; // negative if lines gets smaller
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098
4099 /*
4100 * if new line fits in data block, replace directly
4101 */
4102 if ((int)dp->db_free >= extra)
4103 {
Bram Moolenaar92755bb2021-08-15 22:18:04 +02004104#if defined(FEAT_BYTEOFF) && defined(FEAT_PROP_POPUP)
Bram Moolenaar14c75302021-08-15 14:28:40 +02004105 int old_prop_len = 0;
Paul Ollis4c3d21a2022-05-24 21:26:37 +01004106 if (buf->b_has_textprop)
4107 old_prop_len = old_len - (int)STRLEN(old_line) - 1;
Bram Moolenaar14c75302021-08-15 14:28:40 +02004108#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004109 // if the length changes and there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
4111 if (extra != 0 && idx < count - 1)
4112 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004113 // move text of following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 mch_memmove((char *)dp + dp->db_txt_start - extra,
4115 (char *)dp + dp->db_txt_start,
4116 (size_t)(start - dp->db_txt_start));
4117
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004118 // adjust pointers of this and following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 for (i = idx + 1; i < count; ++i)
4120 dp->db_index[i] -= extra;
4121 }
4122 dp->db_index[idx] -= extra;
4123
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004124 // adjust free space
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 dp->db_free -= extra;
4126 dp->db_txt_start -= extra;
4127
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004128 // copy new line into the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 mch_memmove(old_line - extra, new_line, (size_t)new_len);
4130 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
Bram Moolenaar92755bb2021-08-15 22:18:04 +02004131#if defined(FEAT_BYTEOFF) && defined(FEAT_PROP_POPUP)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004132 // The else case is already covered by the insert and delete
Bram Moolenaar14c75302021-08-15 14:28:40 +02004133 if (buf->b_has_textprop)
4134 {
4135 // Do not count the size of any text properties.
4136 extra += old_prop_len;
Bram Moolenaar434df7a2021-08-16 21:15:32 +02004137 extra -= new_len - (int)STRLEN(new_line) - 1;
Bram Moolenaar14c75302021-08-15 14:28:40 +02004138 }
4139 if (extra != 0)
4140 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141#endif
4142 }
4143 else
4144 {
4145 /*
4146 * Cannot do it in one data block: Delete and append.
4147 * Append first, because ml_delete_int() cannot delete the
4148 * last line in a buffer, which causes trouble for a buffer
4149 * that has only one line.
4150 * Don't forget to copy the mark!
4151 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004152 // How about handling errors???
Bram Moolenaara9d4b842020-05-30 14:46:52 +02004153 (void)ml_append_int(buf, lnum, new_line, new_len,
Bram Moolenaar840f91f2021-05-26 22:32:10 +02004154 ((dp->db_index[idx] & DB_MARKED) ? ML_APPEND_MARK : 0)
4155#ifdef FEAT_PROP_POPUP
4156 | ML_APPEND_NOPROP
4157#endif
4158 );
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02004159 (void)ml_delete_int(buf, lnum, ML_DEL_NOPROP);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 }
4161 }
4162 vim_free(new_line);
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004163
4164 entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 }
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01004166 else if (buf->b_ml.ml_flags & ML_ALLOCATED)
4167 vim_free(buf->b_ml.ml_line_ptr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01004169 buf->b_ml.ml_flags &= ~(ML_LINE_DIRTY | ML_ALLOCATED);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 buf->b_ml.ml_line_lnum = 0;
4171}
4172
4173/*
4174 * create a new, empty, data block
4175 */
4176 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004177ml_new_data(memfile_T *mfp, int negative, int page_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178{
4179 bhdr_T *hp;
4180 DATA_BL *dp;
4181
4182 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
4183 return NULL;
4184
4185 dp = (DATA_BL *)(hp->bh_data);
4186 dp->db_id = DATA_ID;
4187 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
4188 dp->db_free = dp->db_txt_start - HEADER_SIZE;
4189 dp->db_line_count = 0;
4190
4191 return hp;
4192}
4193
4194/*
4195 * create a new, empty, pointer block
4196 */
4197 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004198ml_new_ptr(memfile_T *mfp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199{
4200 bhdr_T *hp;
4201 PTR_BL *pp;
4202
4203 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
4204 return NULL;
4205
4206 pp = (PTR_BL *)(hp->bh_data);
4207 pp->pb_id = PTR_ID;
4208 pp->pb_count = 0;
Bram Moolenaarb67ba032023-04-22 21:14:26 +01004209 pp->pb_count_max = PB_COUNT_MAX(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210
4211 return hp;
4212}
4213
4214/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01004215 * Lookup line 'lnum' in a memline.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 *
4217 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
4218 * if ML_FLUSH only flush a locked block
4219 * if ML_FIND just find the line
4220 *
4221 * If the block was found it is locked and put in ml_locked.
4222 * The stack is updated to lead to the locked block. The ip_high field in
4223 * the stack is updated to reflect the last line in the block AFTER the
4224 * insert or delete, also if the pointer block has not been updated yet. But
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004225 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 *
4227 * return: NULL for failure, pointer to block header otherwise
4228 */
4229 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004230ml_find_line(buf_T *buf, linenr_T lnum, int action)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231{
4232 DATA_BL *dp;
4233 PTR_BL *pp;
4234 infoptr_T *ip;
4235 bhdr_T *hp;
4236 memfile_T *mfp;
4237 linenr_T t;
4238 blocknr_T bnum, bnum2;
4239 int dirty;
4240 linenr_T low, high;
4241 int top;
4242 int page_count;
4243 int idx;
4244
4245 mfp = buf->b_ml.ml_mfp;
4246
4247 /*
4248 * If there is a locked block check if the wanted line is in it.
4249 * If not, flush and release the locked block.
4250 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
4251 * Don't do this for ML_FLUSH, because we want to flush the locked block.
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004252 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 */
4254 if (buf->b_ml.ml_locked)
4255 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004256 if (ML_SIMPLE(action)
4257 && buf->b_ml.ml_locked_low <= lnum
4258 && buf->b_ml.ml_locked_high >= lnum
4259 && !mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004261 // remember to update pointer blocks and stack later
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 if (action == ML_INSERT)
4263 {
4264 ++(buf->b_ml.ml_locked_lineadd);
4265 ++(buf->b_ml.ml_locked_high);
4266 }
4267 else if (action == ML_DELETE)
4268 {
4269 --(buf->b_ml.ml_locked_lineadd);
4270 --(buf->b_ml.ml_locked_high);
4271 }
4272 return (buf->b_ml.ml_locked);
4273 }
4274
4275 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
4276 buf->b_ml.ml_flags & ML_LOCKED_POS);
4277 buf->b_ml.ml_locked = NULL;
4278
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004279 /*
4280 * If lines have been added or deleted in the locked block, need to
4281 * update the line count in pointer blocks.
4282 */
4283 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
4285 }
4286
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004287 if (action == ML_FLUSH) // nothing else to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 return NULL;
4289
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004290 bnum = 1; // start at the root of the tree
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 page_count = 1;
4292 low = 1;
4293 high = buf->b_ml.ml_line_count;
4294
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004295 if (action == ML_FIND) // first try stack entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 {
4297 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
4298 {
4299 ip = &(buf->b_ml.ml_stack[top]);
4300 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
4301 {
4302 bnum = ip->ip_bnum;
4303 low = ip->ip_low;
4304 high = ip->ip_high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004305 buf->b_ml.ml_stack_top = top; // truncate stack at prev entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 break;
4307 }
4308 }
4309 if (top < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004310 buf->b_ml.ml_stack_top = 0; // not found, start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004312 else // ML_DELETE or ML_INSERT
4313 buf->b_ml.ml_stack_top = 0; // start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314
4315/*
4316 * search downwards in the tree until a data block is found
4317 */
4318 for (;;)
4319 {
4320 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
4321 goto error_noblock;
4322
4323 /*
4324 * update high for insert/delete
4325 */
4326 if (action == ML_INSERT)
4327 ++high;
4328 else if (action == ML_DELETE)
4329 --high;
4330
4331 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004332 if (dp->db_id == DATA_ID) // data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 {
4334 buf->b_ml.ml_locked = hp;
4335 buf->b_ml.ml_locked_low = low;
4336 buf->b_ml.ml_locked_high = high;
4337 buf->b_ml.ml_locked_lineadd = 0;
4338 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
4339 return hp;
4340 }
4341
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004342 pp = (PTR_BL *)(dp); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 if (pp->pb_id != PTR_ID)
4344 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00004345 iemsg(_(e_pointer_block_id_wrong));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 goto error_block;
4347 }
4348
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004349 if ((top = ml_add_stack(buf)) < 0) // add new entry to stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 goto error_block;
4351 ip = &(buf->b_ml.ml_stack[top]);
4352 ip->ip_bnum = bnum;
4353 ip->ip_low = low;
4354 ip->ip_high = high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004355 ip->ip_index = -1; // index not known yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356
4357 dirty = FALSE;
4358 for (idx = 0; idx < (int)pp->pb_count; ++idx)
4359 {
4360 t = pp->pb_pointer[idx].pe_line_count;
4361 CHECK(t == 0, _("pe_line_count is zero"));
4362 if ((low += t) > lnum)
4363 {
4364 ip->ip_index = idx;
4365 bnum = pp->pb_pointer[idx].pe_bnum;
4366 page_count = pp->pb_pointer[idx].pe_page_count;
4367 high = low - 1;
4368 low -= t;
4369
4370 /*
4371 * a negative block number may have been changed
4372 */
4373 if (bnum < 0)
4374 {
4375 bnum2 = mf_trans_del(mfp, bnum);
4376 if (bnum != bnum2)
4377 {
4378 bnum = bnum2;
4379 pp->pb_pointer[idx].pe_bnum = bnum;
4380 dirty = TRUE;
4381 }
4382 }
4383
4384 break;
4385 }
4386 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004387 if (idx >= (int)pp->pb_count) // past the end: something wrong!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 {
4389 if (lnum > buf->b_ml.ml_line_count)
Bram Moolenaareaaac012022-01-02 17:00:40 +00004390 siemsg(_(e_line_number_out_of_range_nr_past_the_end),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 lnum - buf->b_ml.ml_line_count);
4392
4393 else
Bram Moolenaareaaac012022-01-02 17:00:40 +00004394 siemsg(_(e_line_count_wrong_in_block_nr), bnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 goto error_block;
4396 }
4397 if (action == ML_DELETE)
4398 {
4399 pp->pb_pointer[idx].pe_line_count--;
4400 dirty = TRUE;
4401 }
4402 else if (action == ML_INSERT)
4403 {
4404 pp->pb_pointer[idx].pe_line_count++;
4405 dirty = TRUE;
4406 }
4407 mf_put(mfp, hp, dirty, FALSE);
4408 }
4409
4410error_block:
4411 mf_put(mfp, hp, FALSE, FALSE);
4412error_noblock:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004413 /*
4414 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
4415 * the incremented/decremented line counts, because there won't be a line
4416 * inserted/deleted after all.
4417 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 if (action == ML_DELETE)
4419 ml_lineadd(buf, 1);
4420 else if (action == ML_INSERT)
4421 ml_lineadd(buf, -1);
4422 buf->b_ml.ml_stack_top = 0;
4423 return NULL;
4424}
4425
4426/*
4427 * add an entry to the info pointer stack
4428 *
4429 * return -1 for failure, number of the new entry otherwise
4430 */
4431 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004432ml_add_stack(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433{
4434 int top;
4435 infoptr_T *newstack;
4436
4437 top = buf->b_ml.ml_stack_top;
4438
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004439 // may have to increase the stack size
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 if (top == buf->b_ml.ml_stack_size)
4441 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004442 CHECK(top > 0, _("Stack size increases")); // more than 5 levels???
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004444 newstack = ALLOC_MULT(infoptr_T, buf->b_ml.ml_stack_size + STACK_INCR);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 if (newstack == NULL)
4446 return -1;
Bram Moolenaarfbd302f2015-08-08 18:23:46 +02004447 if (top > 0)
4448 mch_memmove(newstack, buf->b_ml.ml_stack,
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004449 (size_t)top * sizeof(infoptr_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 vim_free(buf->b_ml.ml_stack);
4451 buf->b_ml.ml_stack = newstack;
4452 buf->b_ml.ml_stack_size += STACK_INCR;
4453 }
4454
4455 buf->b_ml.ml_stack_top++;
4456 return top;
4457}
4458
4459/*
4460 * Update the pointer blocks on the stack for inserted/deleted lines.
4461 * The stack itself is also updated.
4462 *
4463 * When a insert/delete line action fails, the line is not inserted/deleted,
4464 * but the pointer blocks have already been updated. That is fixed here by
4465 * walking through the stack.
4466 *
4467 * Count is the number of lines added, negative if lines have been deleted.
4468 */
4469 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004470ml_lineadd(buf_T *buf, int count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471{
4472 int idx;
4473 infoptr_T *ip;
4474 PTR_BL *pp;
4475 memfile_T *mfp = buf->b_ml.ml_mfp;
4476 bhdr_T *hp;
4477
4478 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
4479 {
4480 ip = &(buf->b_ml.ml_stack[idx]);
4481 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
4482 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004483 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 if (pp->pb_id != PTR_ID)
4485 {
4486 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaareaaac012022-01-02 17:00:40 +00004487 iemsg(_(e_pointer_block_id_wrong_two));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 break;
4489 }
4490 pp->pb_pointer[ip->ip_index].pe_line_count += count;
4491 ip->ip_high += count;
4492 mf_put(mfp, hp, TRUE, FALSE);
4493 }
4494}
4495
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004496#if defined(HAVE_READLINK) || defined(PROTO)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004497/*
4498 * Resolve a symlink in the last component of a file name.
4499 * Note that f_resolve() does it for every part of the path, we don't do that
4500 * here.
4501 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
4502 * Otherwise returns FAIL.
4503 */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004504 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004505resolve_symlink(char_u *fname, char_u *buf)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004506{
4507 char_u tmp[MAXPATHL];
4508 int ret;
4509 int depth = 0;
4510
4511 if (fname == NULL)
4512 return FAIL;
4513
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004514 // Put the result so far in tmp[], starting with the original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004515 vim_strncpy(tmp, fname, MAXPATHL - 1);
4516
4517 for (;;)
4518 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004519 // Limit symlink depth to 100, catch recursive loops.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004520 if (++depth == 100)
4521 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00004522 semsg(_(e_symlink_loop_for_str), fname);
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004523 return FAIL;
4524 }
4525
4526 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
4527 if (ret <= 0)
4528 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00004529 if (errno == EINVAL || errno == ENOENT)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004530 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004531 // Found non-symlink or not existing file, stop here.
4532 // When at the first level use the unmodified name, skip the
4533 // call to vim_FullName().
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004534 if (depth == 1)
4535 return FAIL;
4536
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004537 // Use the resolved name in tmp[].
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004538 break;
4539 }
4540
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004541 // There must be some error reading links, use original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004542 return FAIL;
4543 }
4544 buf[ret] = NUL;
4545
4546 /*
4547 * Check whether the symlink is relative or absolute.
4548 * If it's relative, build a new path based on the directory
4549 * portion of the filename (if any) and the path the symlink
4550 * points to.
4551 */
4552 if (mch_isFullName(buf))
4553 STRCPY(tmp, buf);
4554 else
4555 {
4556 char_u *tail;
4557
4558 tail = gettail(tmp);
4559 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
4560 return FAIL;
4561 STRCPY(tail, buf);
4562 }
4563 }
4564
4565 /*
4566 * Try to resolve the full name of the file so that the swapfile name will
4567 * be consistent even when opening a relative symlink from different
4568 * working directories.
4569 */
4570 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
4571}
4572#endif
4573
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574/*
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004575 * Make swap file name out of the file name and a directory name.
4576 * Returns pointer to allocated memory or NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004578 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004579makeswapname(
4580 char_u *fname,
4581 char_u *ffname UNUSED,
4582 buf_T *buf,
4583 char_u *dir_name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584{
4585 char_u *r, *s;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02004586 char_u *fname_res = fname;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004587#ifdef HAVE_READLINK
4588 char_u fname_buf[MAXPATHL];
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004589
4590 // Expand symlink in the file name, so that we put the swap file with the
4591 // actual file instead of with the symlink.
4592 if (resolve_symlink(fname, fname_buf) == OK)
4593 fname_res = fname_buf;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004594#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595
Bram Moolenaar4f974752019-02-17 17:44:42 +01004596#if defined(UNIX) || defined(MSWIN) // Need _very_ long file names
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01004597 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01004598
4599 s = dir_name + len;
4600 if (after_pathsep(dir_name, s) && len > 1 && s[-1] == s[-2])
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004601 { // Ends with '//', Use Full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 r = NULL;
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004603 if ((s = make_percent_swname(dir_name, fname_res)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 {
4605 r = modname(s, (char_u *)".swp", FALSE);
4606 vim_free(s);
4607 }
4608 return r;
4609 }
4610#endif
4611
4612 r = buf_modname(
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 (buf->b_p_sn || buf->b_shortname),
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004614 fname_res,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 (char_u *)
Bram Moolenaare60acc12011-05-10 16:41:25 +02004616#if defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 "_swp",
4618#else
4619 ".swp",
4620#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004621 // Prepend a '.' to the swap file name for the current directory.
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004622 dir_name[0] == '.' && dir_name[1] == NUL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004623 if (r == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 return NULL;
4625
4626 s = get_file_in_dir(r, dir_name);
4627 vim_free(r);
4628 return s;
4629}
4630
4631/*
4632 * Get file name to use for swap file or backup file.
4633 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
4634 * option "dname".
4635 * - If "dname" is ".", return "fname" (swap file in dir of file).
4636 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
4637 * relative to dir of file).
4638 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
4639 * dir).
4640 *
4641 * The return value is an allocated string and can be NULL.
4642 */
4643 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004644get_file_in_dir(
4645 char_u *fname,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004646 char_u *dname) // don't use "dirname", it is a global for Alpha
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647{
4648 char_u *t;
4649 char_u *tail;
4650 char_u *retval;
4651 int save_char;
4652
4653 tail = gettail(fname);
4654
4655 if (dname[0] == '.' && dname[1] == NUL)
4656 retval = vim_strsave(fname);
4657 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
4658 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004659 if (tail == fname) // no path before file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 retval = concat_fnames(dname + 2, tail, TRUE);
4661 else
4662 {
4663 save_char = *tail;
4664 *tail = NUL;
4665 t = concat_fnames(fname, dname + 2, TRUE);
4666 *tail = save_char;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004667 if (t == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 retval = NULL;
4669 else
4670 {
4671 retval = concat_fnames(t, tail, TRUE);
4672 vim_free(t);
4673 }
4674 }
4675 }
4676 else
4677 retval = concat_fnames(dname, tail, TRUE);
4678
Bram Moolenaar4f974752019-02-17 17:44:42 +01004679#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004680 if (retval != NULL)
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004681 for (t = gettail(retval); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004682 if (*t == ':')
4683 *t = '%';
4684#endif
4685
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 return retval;
4687}
4688
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004689/*
4690 * Print the ATTENTION message: info about an existing swap file.
4691 */
4692 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004693attention_message(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004694 buf_T *buf, // buffer being edited
4695 char_u *fname) // swap file name
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004696{
Bram Moolenaar8767f522016-07-01 17:17:39 +02004697 stat_T st;
Bram Moolenaar63d25552019-05-10 21:28:38 +02004698 time_t swap_mtime;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004699
4700 ++no_wait_return;
Bram Moolenaareaaac012022-01-02 17:00:40 +00004701 (void)emsg(_(e_attention));
Bram Moolenaar32526b32019-01-19 17:43:09 +01004702 msg_puts(_("\nFound a swap file by the name \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004703 msg_home_replace(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004704 msg_puts("\"\n");
Bram Moolenaar63d25552019-05-10 21:28:38 +02004705 swap_mtime = swapfile_info(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004706 msg_puts(_("While opening file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004707 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004708 msg_puts("\"\n");
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004709 if (mch_stat((char *)buf->b_fname, &st) == -1)
4710 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004711 msg_puts(_(" CANNOT BE FOUND"));
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004712 }
4713 else
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004714 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004715 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02004716 msg_puts(get_ctime(st.st_mtime, TRUE));
4717 if (swap_mtime != 0 && st.st_mtime > swap_mtime)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004718 msg_puts(_(" NEWER than swap file!\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004719 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004720 // Some of these messages are long to allow translation to
4721 // other languages.
Bram Moolenaar32526b32019-01-19 17:43:09 +01004722 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"));
4723 msg_puts(_("(2) An edit session for this file crashed.\n"));
4724 msg_puts(_(" If this is the case, use \":recover\" or \"vim -r "));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004725 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004726 msg_puts(_("\"\n to recover the changes (see \":help recovery\").\n"));
4727 msg_puts(_(" If you did this already, delete the swap file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004728 msg_outtrans(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004729 msg_puts(_("\"\n to avoid this message.\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004730 cmdline_row = msg_row;
4731 --no_wait_return;
4732}
4733
Bram Moolenaar188639d2022-04-04 16:57:21 +01004734typedef enum {
4735 SEA_CHOICE_NONE = 0,
4736 SEA_CHOICE_READONLY = 1,
4737 SEA_CHOICE_EDIT = 2,
4738 SEA_CHOICE_RECOVER = 3,
4739 SEA_CHOICE_DELETE = 4,
4740 SEA_CHOICE_QUIT = 5,
4741 SEA_CHOICE_ABORT = 6
4742} sea_choice_T;
4743
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004744#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004745/*
4746 * Trigger the SwapExists autocommands.
Bram Moolenaar188639d2022-04-04 16:57:21 +01004747 * Returns a value for equivalent to do_dialog().
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004748 */
Bram Moolenaar188639d2022-04-04 16:57:21 +01004749 static sea_choice_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004750do_swapexists(buf_T *buf, char_u *fname)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004751{
4752 set_vim_var_string(VV_SWAPNAME, fname, -1);
4753 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
4754
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004755 // Trigger SwapExists autocommands with <afile> set to the file being
4756 // edited. Disallow changing directory here.
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004757 ++allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004758 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004759 --allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004760
4761 set_vim_var_string(VV_SWAPNAME, NULL, -1);
4762
4763 switch (*get_vim_var_str(VV_SWAPCHOICE))
4764 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01004765 case 'o': return SEA_CHOICE_READONLY;
4766 case 'e': return SEA_CHOICE_EDIT;
4767 case 'r': return SEA_CHOICE_RECOVER;
4768 case 'd': return SEA_CHOICE_DELETE;
4769 case 'q': return SEA_CHOICE_QUIT;
4770 case 'a': return SEA_CHOICE_ABORT;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004771 }
4772
Bram Moolenaar188639d2022-04-04 16:57:21 +01004773 return SEA_CHOICE_NONE;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004774}
4775#endif
4776
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777/*
4778 * Find out what name to use for the swap file for buffer 'buf'.
4779 *
4780 * Several names are tried to find one that does not exist
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004781 * Returns the name in allocated memory or NULL.
Bram Moolenaarf541c362011-10-26 11:44:18 +02004782 * When out of memory "dirp" is set to NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 *
4784 * Note: If BASENAMELEN is not correct, you will get error messages for
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004785 * not being able to open the swap or undo file
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004786 * Note: May trigger SwapExists autocmd, pointers may change!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 */
4788 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004789findswapname(
4790 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004791 char_u **dirp, // pointer to list of directories
4792 char_u *old_fname) // don't give warning for this file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793{
4794 char_u *fname;
4795 int n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 char_u *dir_name;
4797#ifdef AMIGA
4798 BPTR fh;
4799#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 int r;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004801 char_u *buf_fname = buf->b_fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004803#if !defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804# define CREATE_DUMMY_FILE
4805 FILE *dummyfd = NULL;
4806
Bram Moolenaar4f974752019-02-17 17:44:42 +01004807# ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004808 if (buf_fname != NULL && !mch_isFullName(buf_fname)
4809 && vim_strchr(gettail(buf_fname), ':'))
4810 {
4811 char_u *t;
4812
4813 buf_fname = vim_strsave(buf_fname);
4814 if (buf_fname == NULL)
4815 buf_fname = buf->b_fname;
4816 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004817 for (t = gettail(buf_fname); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004818 if (*t == ':')
4819 *t = '%';
4820 }
4821# endif
4822
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004823 /*
4824 * If we start editing a new file, e.g. "test.doc", which resides on an
4825 * MSDOS compatible filesystem, it is possible that the file
4826 * "test.doc.swp" which we create will be exactly the same file. To avoid
4827 * this problem we temporarily create "test.doc". Don't do this when the
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00004828 * check below for an 8.3 file name is used.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004829 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004830 if (!(buf->b_p_sn || buf->b_shortname) && buf_fname != NULL
4831 && mch_getperm(buf_fname) < 0)
4832 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833#endif
4834
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004835 /*
4836 * Isolate a directory name from *dirp and put it in dir_name.
4837 * First allocate some memory to put the directory name in.
4838 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02004839 dir_name = alloc(STRLEN(*dirp) + 1);
Bram Moolenaarf541c362011-10-26 11:44:18 +02004840 if (dir_name == NULL)
4841 *dirp = NULL;
4842 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 (void)copy_option_part(dirp, dir_name, 31000, ",");
4844
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004845 /*
4846 * we try different names until we find one that does not exist yet
4847 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004848 if (dir_name == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 fname = NULL;
4850 else
Bram Moolenaar69c35002013-11-04 02:54:12 +01004851 fname = makeswapname(buf_fname, buf->b_ffname, buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852
4853 for (;;)
4854 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004855 if (fname == NULL) // must be out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004857 if ((n = (int)STRLEN(fname)) == 0) // safety check
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01004859 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 break;
4861 }
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004862#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863/*
4864 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
4865 * file names. If this is the first try and the swap file name does not fit in
4866 * 8.3, detect if this is the case, set shortname and try again.
4867 */
4868 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
4869 && !(buf->b_p_sn || buf->b_shortname))
4870 {
4871 char_u *tail;
4872 char_u *fname2;
Bram Moolenaar8767f522016-07-01 17:17:39 +02004873 stat_T s1, s2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 int f1, f2;
4875 int created1 = FALSE, created2 = FALSE;
4876 int same = FALSE;
4877
4878 /*
4879 * Check if swapfile name does not fit in 8.3:
4880 * It either contains two dots, is longer than 8 chars, or starts
4881 * with a dot.
4882 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004883 tail = gettail(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 if ( vim_strchr(tail, '.') != NULL
4885 || STRLEN(tail) > (size_t)8
4886 || *gettail(fname) == '.')
4887 {
4888 fname2 = alloc(n + 2);
4889 if (fname2 != NULL)
4890 {
4891 STRCPY(fname2, fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004892 // if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
4893 // if fname == ".xx.swp", fname2 = ".xx.swpx"
4894 // if fname == "123456789.swp", fname2 = "12345678x.swp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 if (vim_strchr(tail, '.') != NULL)
4896 fname2[n - 1] = 'x';
4897 else if (*gettail(fname) == '.')
4898 {
4899 fname2[n] = 'x';
4900 fname2[n + 1] = NUL;
4901 }
4902 else
4903 fname2[n - 5] += 1;
4904 /*
4905 * may need to create the files to be able to use mch_stat()
4906 */
4907 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4908 if (f1 < 0)
4909 {
4910 f1 = mch_open_rw((char *)fname,
4911 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 created1 = TRUE;
4913 }
4914 if (f1 >= 0)
4915 {
4916 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4917 if (f2 < 0)
4918 {
4919 f2 = mch_open_rw((char *)fname2,
4920 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4921 created2 = TRUE;
4922 }
4923 if (f2 >= 0)
4924 {
4925 /*
4926 * Both files exist now. If mch_stat() returns the
4927 * same device and inode they are the same file.
4928 */
4929 if (mch_fstat(f1, &s1) != -1
4930 && mch_fstat(f2, &s2) != -1
4931 && s1.st_dev == s2.st_dev
4932 && s1.st_ino == s2.st_ino)
4933 same = TRUE;
4934 close(f2);
4935 if (created2)
4936 mch_remove(fname2);
4937 }
4938 close(f1);
4939 if (created1)
4940 mch_remove(fname);
4941 }
4942 vim_free(fname2);
4943 if (same)
4944 {
4945 buf->b_shortname = TRUE;
4946 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01004947 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004948 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004949 continue; // try again with b_shortname set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 }
4951 }
4952 }
4953 }
4954#endif
4955 /*
4956 * check if the swapfile already exists
4957 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004958 if (mch_getperm(fname) < 0) // it does not exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 {
4960#ifdef HAVE_LSTAT
Bram Moolenaar8767f522016-07-01 17:17:39 +02004961 stat_T sb;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962
4963 /*
4964 * Extra security check: When a swap file is a symbolic link, this
4965 * is most likely a symlink attack.
4966 */
4967 if (mch_lstat((char *)fname, &sb) < 0)
4968#else
4969# ifdef AMIGA
4970 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4971 /*
4972 * on the Amiga mch_getperm() will return -1 when the file exists
4973 * but is being used by another program. This happens if you edit
4974 * a file twice.
4975 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004976 if (fh != (BPTR)NULL) // can open file, OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 {
4978 Close(fh);
4979 mch_remove(fname);
4980 break;
4981 }
4982 if (IoErr() != ERROR_OBJECT_IN_USE
4983 && IoErr() != ERROR_OBJECT_EXISTS)
4984# endif
4985#endif
4986 break;
4987 }
4988
4989 /*
4990 * A file name equal to old_fname is OK to use.
4991 */
4992 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4993 break;
4994
4995 /*
4996 * get here when file already exists
4997 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004998 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') // first try
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 /*
5001 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
5002 * and file.doc are the same file. To guess if this problem is
5003 * present try if file.doc.swx exists. If it does, we set
5004 * buf->b_shortname and try file_doc.swp (dots replaced by
5005 * underscores for this file), and try again. If it doesn't we
5006 * assume that "file.doc.swp" already exists.
5007 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005008 if (!(buf->b_p_sn || buf->b_shortname)) // not tried yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 {
5010 fname[n - 1] = 'x';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005011 r = mch_getperm(fname); // try "file.swx"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 fname[n - 1] = 'p';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005013 if (r >= 0) // "file.swx" seems to exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014 {
5015 buf->b_shortname = TRUE;
5016 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01005017 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00005018 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005019 continue; // try again with '.' replaced with '_'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 }
5021 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 /*
5023 * If we get here the ".swp" file really exists.
5024 * Give an error message, unless recovering, no file name, we are
5025 * viewing a help file or when the path of the file is different
5026 * (happens when all .swp files are in one directory).
5027 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01005028 if (!recoverymode && buf_fname != NULL
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02005029 && !buf->b_help
5030 && !(buf->b_flags & (BF_DUMMY | BF_NO_SEA)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 {
5032 int fd;
5033 struct block0 b0;
5034 int differ = FALSE;
5035
5036 /*
5037 * Try to read block 0 from the swap file to get the original
5038 * file name (and inode number).
5039 */
5040 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
5041 if (fd >= 0)
5042 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005043 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 {
5045 /*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005046 * If the swapfile has the same directory as the
5047 * buffer don't compare the directory names, they can
5048 * have a different mountpoint.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005050 if (b0.b0_flags & B0_SAME_DIR)
5051 {
5052 if (fnamecmp(gettail(buf->b_ffname),
5053 gettail(b0.b0_fname)) != 0
5054 || !same_directory(fname, buf->b_ffname))
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005055 {
5056#ifdef CHECK_INODE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005057 // Symlinks may point to the same file even
5058 // when the name differs, need to check the
5059 // inode too.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005060 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
5061 if (fnamecmp_ino(buf->b_ffname, NameBuff,
5062 char_to_long(b0.b0_ino)))
5063#endif
5064 differ = TRUE;
5065 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005066 }
5067 else
5068 {
5069 /*
5070 * The name in the swap file may be
5071 * "~user/path/file". Expand it first.
5072 */
5073 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074#ifdef CHECK_INODE
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005075 if (fnamecmp_ino(buf->b_ffname, NameBuff,
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005076 char_to_long(b0.b0_ino)))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005077 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078#else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005079 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
5080 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005082 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 }
5084 close(fd);
5085 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005087 // give the ATTENTION message when there is an old swap file
5088 // for the current file, and the buffer was not recovered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
5090 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
5091 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005092 sea_choice_T choice = SEA_CHOICE_NONE;
5093 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094#ifdef CREATE_DUMMY_FILE
Bram Moolenaar188639d2022-04-04 16:57:21 +01005095 int did_use_dummy = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005097 // Avoid getting a warning for the file being created
5098 // outside of Vim, it was created at the start of this
5099 // function. Delete the file now, because Vim might exit
5100 // here if the window is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 if (dummyfd != NULL)
5102 {
5103 fclose(dummyfd);
5104 dummyfd = NULL;
Bram Moolenaar69c35002013-11-04 02:54:12 +01005105 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 did_use_dummy = TRUE;
5107 }
5108#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005110#ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 process_still_running = FALSE;
5112#endif
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005113 // It's safe to delete the swap file if all these are true:
5114 // - the edited file exists
5115 // - the swap file has no changes and looks OK
5116 if (mch_stat((char *)buf->b_fname, &st) == 0
5117 && swapfile_unchanged(fname))
5118 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005119 choice = SEA_CHOICE_DELETE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005120 if (p_verbose > 0)
5121 verb_msg(_("Found a swap file that is not useful, deleting it"));
5122 }
5123
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005124#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005125 /*
5126 * If there is an SwapExists autocommand and we can handle
5127 * the response, trigger it. It may return 0 to ask the
5128 * user anyway.
5129 */
Bram Moolenaar188639d2022-04-04 16:57:21 +01005130 if (choice == SEA_CHOICE_NONE
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005131 && swap_exists_action != SEA_NONE
Bram Moolenaar69c35002013-11-04 02:54:12 +01005132 && has_autocmd(EVENT_SWAPEXISTS, buf_fname, buf))
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005133 choice = do_swapexists(buf, fname);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005134#endif
Bram Moolenaar188639d2022-04-04 16:57:21 +01005135
5136 if (choice == SEA_CHOICE_NONE
5137 && swap_exists_action == SEA_READONLY)
5138 {
5139 // always open readonly.
5140 choice = SEA_CHOICE_READONLY;
5141 }
5142
5143 if (choice == SEA_CHOICE_NONE)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005144 {
5145#ifdef FEAT_GUI
Bram Moolenaar798184c2018-10-07 20:48:39 +02005146 // If we are supposed to start the GUI but it wasn't
5147 // completely started yet, start it now. This makes
5148 // the messages displayed in the Vim window when
5149 // loading a session from the .gvimrc file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005150 if (gui.starting && !gui.in_use)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005151 gui_start(NULL);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005152#endif
Bram Moolenaar798184c2018-10-07 20:48:39 +02005153 // Show info about the existing swap file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005154 attention_message(buf, fname);
5155
Bram Moolenaar798184c2018-10-07 20:48:39 +02005156 // We don't want a 'q' typed at the more-prompt
5157 // interrupt loading a file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005158 got_int = FALSE;
Bram Moolenaar798184c2018-10-07 20:48:39 +02005159
5160 // If vimrc has "simalt ~x" we don't want it to
5161 // interfere with the prompt here.
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02005162 flush_buffers(FLUSH_TYPEAHEAD);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005163 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar188639d2022-04-04 16:57:21 +01005166 if (swap_exists_action != SEA_NONE
5167 && choice == SEA_CHOICE_NONE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 {
5169 char_u *name;
Bram Moolenaar188639d2022-04-04 16:57:21 +01005170 int dialog_result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
Bram Moolenaar964b3742019-05-24 18:54:09 +02005172 name = alloc(STRLEN(fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 + STRLEN(_("Swap file \""))
Bram Moolenaar964b3742019-05-24 18:54:09 +02005174 + STRLEN(_("\" already exists!")) + 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 if (name != NULL)
5176 {
5177 STRCPY(name, _("Swap file \""));
5178 home_replace(NULL, fname, name + STRLEN(name),
5179 1000, TRUE);
5180 STRCAT(name, _("\" already exists!"));
5181 }
Bram Moolenaar188639d2022-04-04 16:57:21 +01005182 dialog_result = do_dialog(VIM_WARNING,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 (char_u *)_("VIM - ATTENTION"),
5184 name == NULL
5185 ? (char_u *)_("Swap file already exists!")
5186 : name,
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005187# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 process_still_running
5189 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
5190# endif
Bram Moolenaard2c340a2011-01-17 20:08:11 +01005191 (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 +00005192
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005193# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar188639d2022-04-04 16:57:21 +01005194 if (process_still_running && dialog_result >= 4)
5195 // compensate for missing "Delete it" button
5196 dialog_result++;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005197# endif
Bram Moolenaar188639d2022-04-04 16:57:21 +01005198 choice = dialog_result;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005199 vim_free(name);
5200
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005201 // pretend screen didn't scroll, need redraw anyway
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005202 msg_scrolled = 0;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01005203 redraw_all_later(UPD_NOT_VALID);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005204 }
5205#endif
5206
Bram Moolenaar188639d2022-04-04 16:57:21 +01005207 switch (choice)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005208 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005209 case SEA_CHOICE_READONLY:
5210 buf->b_p_ro = TRUE;
5211 break;
5212 case SEA_CHOICE_EDIT:
5213 break;
5214 case SEA_CHOICE_RECOVER:
5215 swap_exists_action = SEA_RECOVER;
5216 break;
5217 case SEA_CHOICE_DELETE:
5218 mch_remove(fname);
5219 break;
5220 case SEA_CHOICE_QUIT:
5221 swap_exists_action = SEA_QUIT;
5222 break;
5223 case SEA_CHOICE_ABORT:
5224 swap_exists_action = SEA_QUIT;
5225 got_int = TRUE;
5226 break;
5227 case SEA_CHOICE_NONE:
5228 msg_puts("\n");
5229 if (msg_silent == 0)
5230 // call wait_return() later
5231 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 break;
5233 }
Bram Moolenaar188639d2022-04-04 16:57:21 +01005234
5235 // If the file was deleted this fname can be used.
5236 if (choice != SEA_CHOICE_NONE && mch_getperm(fname) < 0)
5237 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238
5239#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005240 // Going to try another name, need the dummy file again.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 if (did_use_dummy)
Bram Moolenaar69c35002013-11-04 02:54:12 +01005242 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243#endif
5244 }
5245 }
5246 }
5247
5248 /*
5249 * Change the ".swp" extension to find another file that can be used.
5250 * First decrement the last char: ".swo", ".swn", etc.
5251 * If that still isn't enough decrement the last but one char: ".svz"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005252 * Can happen when editing many "No Name" buffers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005254 if (fname[n - 1] == 'a') // ".s?a"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005256 if (fname[n - 2] == 'a') // ".saa": tried enough, give up
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00005258 emsg(_(e_too_many_swap_files_found));
Bram Moolenaard23a8232018-02-10 18:45:26 +01005259 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 break;
5261 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005262 --fname[n - 2]; // ".svz", ".suz", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 fname[n - 1] = 'z' + 1;
5264 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005265 --fname[n - 1]; // ".swo", ".swn", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 }
5267
5268 vim_free(dir_name);
5269#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005270 if (dummyfd != NULL) // file has been created temporarily
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 {
5272 fclose(dummyfd);
Bram Moolenaar69c35002013-11-04 02:54:12 +01005273 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 }
5275#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01005276#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01005277 if (buf_fname != buf->b_fname)
5278 vim_free(buf_fname);
5279#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 return fname;
5281}
5282
5283 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005284b0_magic_wrong(ZERO_BL *b0p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285{
5286 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
5287 || b0p->b0_magic_int != (int)B0_MAGIC_INT
5288 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
5289 || b0p->b0_magic_char != B0_MAGIC_CHAR);
5290}
5291
5292#ifdef CHECK_INODE
5293/*
5294 * Compare current file name with file name from swap file.
5295 * Try to use inode numbers when possible.
5296 * Return non-zero when files are different.
5297 *
5298 * When comparing file names a few things have to be taken into consideration:
5299 * - When working over a network the full path of a file depends on the host.
5300 * We check the inode number if possible. It is not 100% reliable though,
5301 * because the device number cannot be used over a network.
5302 * - When a file does not exist yet (editing a new file) there is no inode
5303 * number.
5304 * - The file name in a swap file may not be valid on the current host. The
5305 * "~user" form is used whenever possible to avoid this.
5306 *
5307 * This is getting complicated, let's make a table:
5308 *
5309 * ino_c ino_s fname_c fname_s differ =
5310 *
5311 * both files exist -> compare inode numbers:
5312 * != 0 != 0 X X ino_c != ino_s
5313 *
5314 * inode number(s) unknown, file names available -> compare file names
5315 * == 0 X OK OK fname_c != fname_s
5316 * X == 0 OK OK fname_c != fname_s
5317 *
5318 * current file doesn't exist, file for swap file exist, file name(s) not
5319 * available -> probably different
5320 * == 0 != 0 FAIL X TRUE
5321 * == 0 != 0 X FAIL TRUE
5322 *
5323 * current file exists, inode for swap unknown, file name(s) not
5324 * available -> probably different
5325 * != 0 == 0 FAIL X TRUE
5326 * != 0 == 0 X FAIL TRUE
5327 *
5328 * current file doesn't exist, inode for swap unknown, one file name not
5329 * available -> probably different
5330 * == 0 == 0 FAIL OK TRUE
5331 * == 0 == 0 OK FAIL TRUE
5332 *
5333 * current file doesn't exist, inode for swap unknown, both file names not
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005334 * available -> compare file names
5335 * == 0 == 0 FAIL FAIL fname_c != fname_s
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 *
5337 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
5338 * can't be changed without making the block 0 incompatible with 32 bit
5339 * versions.
5340 */
5341
5342 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005343fnamecmp_ino(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005344 char_u *fname_c, // current file name
5345 char_u *fname_s, // file name from swap file
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005346 long ino_block0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347{
Bram Moolenaar8767f522016-07-01 17:17:39 +02005348 stat_T st;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005349 ino_t ino_c = 0; // ino of current file
5350 ino_t ino_s; // ino of file from swap file
5351 char_u buf_c[MAXPATHL]; // full path of fname_c
5352 char_u buf_s[MAXPATHL]; // full path of fname_s
5353 int retval_c; // flag: buf_c valid
5354 int retval_s; // flag: buf_s valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355
5356 if (mch_stat((char *)fname_c, &st) == 0)
5357 ino_c = (ino_t)st.st_ino;
5358
5359 /*
5360 * First we try to get the inode from the file name, because the inode in
5361 * the swap file may be outdated. If that fails (e.g. this path is not
5362 * valid on this machine), use the inode from block 0.
5363 */
5364 if (mch_stat((char *)fname_s, &st) == 0)
5365 ino_s = (ino_t)st.st_ino;
5366 else
5367 ino_s = (ino_t)ino_block0;
5368
5369 if (ino_c && ino_s)
5370 return (ino_c != ino_s);
5371
5372 /*
5373 * One of the inode numbers is unknown, try a forced vim_FullName() and
5374 * compare the file names.
5375 */
5376 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
5377 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
5378 if (retval_c == OK && retval_s == OK)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005379 return STRCMP(buf_c, buf_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380
5381 /*
5382 * Can't compare inodes or file names, guess that the files are different,
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005383 * unless both appear not to exist at all, then compare with the file name
5384 * in the swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 */
5386 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005387 return STRCMP(fname_c, fname_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 return TRUE;
5389}
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005390#endif // CHECK_INODE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391
5392/*
5393 * Move a long integer into a four byte character array.
5394 * Used for machine independency in block zero.
5395 */
5396 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005397long_to_char(long n, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398{
5399 s[0] = (char_u)(n & 0xff);
5400 n = (unsigned)n >> 8;
5401 s[1] = (char_u)(n & 0xff);
5402 n = (unsigned)n >> 8;
5403 s[2] = (char_u)(n & 0xff);
5404 n = (unsigned)n >> 8;
5405 s[3] = (char_u)(n & 0xff);
5406}
5407
5408 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005409char_to_long(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410{
5411 long retval;
5412
5413 retval = s[3];
5414 retval <<= 8;
5415 retval |= s[2];
5416 retval <<= 8;
5417 retval |= s[1];
5418 retval <<= 8;
5419 retval |= s[0];
5420
5421 return retval;
5422}
5423
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005424/*
5425 * Set the flags in the first block of the swap file:
5426 * - file is modified or not: buf->b_changed
5427 * - 'fileformat'
5428 * - 'fileencoding'
5429 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005431ml_setflags(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432{
5433 bhdr_T *hp;
5434 ZERO_BL *b0p;
5435
5436 if (!buf->b_ml.ml_mfp)
5437 return;
5438 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
5439 {
5440 if (hp->bh_bnum == 0)
5441 {
5442 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005443 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
5444 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
5445 | (get_fileformat(buf) + 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005446 add_b0_fenc(b0p, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 hp->bh_flags |= BH_DIRTY;
5448 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
5449 break;
5450 }
5451 }
5452}
5453
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005454#if defined(FEAT_CRYPT) || defined(PROTO)
5455/*
5456 * If "data" points to a data block encrypt the text in it and return a copy
5457 * in allocated memory. Return NULL when out of memory.
5458 * Otherwise return "data".
5459 */
5460 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005461ml_encrypt_data(
5462 memfile_T *mfp,
5463 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005464 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005465 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005466{
5467 DATA_BL *dp = (DATA_BL *)data;
5468 char_u *head_end;
5469 char_u *text_start;
5470 char_u *new_data;
5471 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005472 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005473
5474 if (dp->db_id != DATA_ID)
5475 return data;
5476
Bram Moolenaarbc563362015-06-09 18:35:25 +02005477 state = ml_crypt_prepare(mfp, offset, FALSE);
5478 if (state == NULL)
5479 return data;
5480
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005481 new_data = alloc(size);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005482 if (new_data == NULL)
5483 return NULL;
5484 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5485 text_start = (char_u *)dp + dp->db_txt_start;
5486 text_len = size - dp->db_txt_start;
5487
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005488 // Copy the header and the text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005489 mch_memmove(new_data, dp, head_end - (char_u *)dp);
5490
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005491 // Encrypt the text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02005492 crypt_encode(state, text_start, text_len, new_data + dp->db_txt_start,
5493 FALSE);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005494 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005495
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005496 // Clear the gap.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005497 if (head_end < text_start)
5498 vim_memset(new_data + (head_end - data), 0, text_start - head_end);
5499
5500 return new_data;
5501}
5502
5503/*
Bram Moolenaarbc563362015-06-09 18:35:25 +02005504 * Decrypt the text in "data" if it points to an encrypted data block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005505 */
5506 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005507ml_decrypt_data(
5508 memfile_T *mfp,
5509 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005510 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005511 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005512{
5513 DATA_BL *dp = (DATA_BL *)data;
5514 char_u *head_end;
5515 char_u *text_start;
5516 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005517 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005518
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00005519 if (dp->db_id != DATA_ID)
5520 return;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005521
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00005522 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5523 text_start = (char_u *)dp + dp->db_txt_start;
5524 text_len = dp->db_txt_end - dp->db_txt_start;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005525
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00005526 if (head_end > text_start || dp->db_txt_start > size
5527 || dp->db_txt_end > size)
5528 return; // data was messed up
5529
5530 state = ml_crypt_prepare(mfp, offset, TRUE);
5531 if (state == NULL)
5532 return;
5533
5534 // Decrypt the text in place.
5535 crypt_decode_inplace(state, text_start, text_len, FALSE);
5536 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005537}
5538
5539/*
5540 * Prepare for encryption/decryption, using the key, seed and offset.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005541 * Return an allocated cryptstate_T *.
Christian Brabandtaae58342023-04-23 17:50:22 +01005542 * Note: Encryption not supported for SODIUM
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005543 */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005544 static cryptstate_T *
Bram Moolenaar8767f522016-07-01 17:17:39 +02005545ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005546{
5547 buf_T *buf = mfp->mf_buffer;
5548 char_u salt[50];
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005549 int method_nr;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005550 char_u *key;
Christian Brabandtaae58342023-04-23 17:50:22 +01005551 crypt_arg_T arg;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005552
Christian Brabandtaae58342023-04-23 17:50:22 +01005553 CLEAR_FIELD(arg);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005554 if (reading && mfp->mf_old_key != NULL)
5555 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005556 // Reading back blocks with the previous key/method/seed.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005557 method_nr = mfp->mf_old_cm;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005558 key = mfp->mf_old_key;
Christian Brabandtaae58342023-04-23 17:50:22 +01005559 arg.cat_seed = mfp->mf_old_seed;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005560 }
5561 else
5562 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005563 method_nr = crypt_get_method_nr(buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005564 key = buf->b_p_key;
Christian Brabandtaae58342023-04-23 17:50:22 +01005565 arg.cat_seed = mfp->mf_seed;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005566 }
Christian Brabandtaae58342023-04-23 17:50:22 +01005567
Bram Moolenaarbc563362015-06-09 18:35:25 +02005568 if (*key == NUL)
5569 return NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005570
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005571 if (method_nr == CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005572 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005573 // For PKzip: Append the offset to the key, so that we use a different
5574 // key for every block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005575 vim_snprintf((char *)salt, sizeof(salt), "%s%ld", key, (long)offset);
Christian Brabandtaae58342023-04-23 17:50:22 +01005576 arg.cat_seed = NULL;
5577 arg.cat_init_from_file = FALSE;
5578
5579 return crypt_create(method_nr, salt, &arg);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005580 }
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005581
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005582 // Using blowfish or better: add salt and seed. We use the byte offset
5583 // of the block for the salt.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005584 vim_snprintf((char *)salt, sizeof(salt), "%ld", (long)offset);
Christian Brabandtaae58342023-04-23 17:50:22 +01005585
5586 arg.cat_salt = salt;
5587 arg.cat_salt_len = (int)STRLEN(salt);
5588 arg.cat_seed_len = MF_SEED_LEN;
5589 arg.cat_add_len = 0;
5590 arg.cat_add = NULL;
5591 arg.cat_init_from_file = FALSE;
5592
5593 return crypt_create(method_nr, key, &arg);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005594}
5595
5596#endif
5597
5598
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599#if defined(FEAT_BYTEOFF) || defined(PROTO)
5600
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005601#define MLCS_MAXL 800 // max no of lines in chunk
5602#define MLCS_MINL 400 // should be half of MLCS_MAXL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603
5604/*
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02005605 * Keep information for finding byte offset of a line, updtype may be one of:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
5607 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
5608 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
5609 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
5610 */
5611 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005612ml_updatechunk(
5613 buf_T *buf,
5614 linenr_T line,
5615 long len,
5616 int updtype)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617{
5618 static buf_T *ml_upd_lastbuf = NULL;
5619 static linenr_T ml_upd_lastline;
5620 static linenr_T ml_upd_lastcurline;
5621 static int ml_upd_lastcurix;
5622
5623 linenr_T curline = ml_upd_lastcurline;
5624 int curix = ml_upd_lastcurix;
5625 long size;
5626 chunksize_T *curchnk;
5627 int rest;
5628 bhdr_T *hp;
5629 DATA_BL *dp;
5630
5631 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
5632 return;
5633 if (buf->b_ml.ml_chunksize == NULL)
5634 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005635 buf->b_ml.ml_chunksize = ALLOC_MULT(chunksize_T, 100);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 if (buf->b_ml.ml_chunksize == NULL)
5637 {
5638 buf->b_ml.ml_usedchunks = -1;
5639 return;
5640 }
5641 buf->b_ml.ml_numchunks = 100;
5642 buf->b_ml.ml_usedchunks = 1;
5643 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
5644 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
5645 }
5646
5647 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
5648 {
5649 /*
5650 * First line in empty buffer from ml_flush_line() -- reset
5651 */
5652 buf->b_ml.ml_usedchunks = 1;
5653 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01005654 buf->b_ml.ml_chunksize[0].mlcs_totalsize = (long)buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 return;
5656 }
5657
5658 /*
5659 * Find chunk that our line belongs to, curline will be at start of the
5660 * chunk.
5661 */
5662 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
5663 || updtype != ML_CHNK_ADDLINE)
5664 {
5665 for (curline = 1, curix = 0;
5666 curix < buf->b_ml.ml_usedchunks - 1
5667 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5668 curix++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 }
Bram Moolenaara9a8e042018-10-30 22:15:55 +01005671 else if (curix < buf->b_ml.ml_usedchunks - 1
5672 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005674 // Adjust cached curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5676 curix++;
5677 }
5678 curchnk = buf->b_ml.ml_chunksize + curix;
5679
5680 if (updtype == ML_CHNK_DELLINE)
Bram Moolenaar5a6404c2006-11-01 17:12:57 +00005681 len = -len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 curchnk->mlcs_totalsize += len;
5683 if (updtype == ML_CHNK_ADDLINE)
5684 {
5685 curchnk->mlcs_numlines++;
5686
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005687 // May resize here so we don't have to do it in both cases below
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
5689 {
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005690 chunksize_T *t_chunksize = buf->b_ml.ml_chunksize;
5691
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
Bram Moolenaar51b6eb42020-08-22 15:19:18 +02005693 buf->b_ml.ml_chunksize = vim_realloc(buf->b_ml.ml_chunksize,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
5695 if (buf->b_ml.ml_chunksize == NULL)
5696 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005697 // Hmmmm, Give up on offset for this buffer
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005698 vim_free(t_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 buf->b_ml.ml_usedchunks = -1;
5700 return;
5701 }
5702 }
5703
5704 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
5705 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005706 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 int idx;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005708 int end_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 int text_end;
5710 int linecnt;
5711
5712 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
5713 buf->b_ml.ml_chunksize + curix,
5714 (buf->b_ml.ml_usedchunks - curix) *
5715 sizeof(chunksize_T));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005716 // Compute length of first half of lines in the split chunk
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 size = 0;
5718 linecnt = 0;
5719 while (curline < buf->b_ml.ml_line_count
5720 && linecnt < MLCS_MINL)
5721 {
5722 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5723 {
5724 buf->b_ml.ml_usedchunks = -1;
5725 return;
5726 }
5727 dp = (DATA_BL *)(hp->bh_data);
5728 count = (long)(buf->b_ml.ml_locked_high) -
5729 (long)(buf->b_ml.ml_locked_low) + 1;
5730 idx = curline - buf->b_ml.ml_locked_low;
5731 curline = buf->b_ml.ml_locked_high + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005732
5733 // compute index of last line to use in this MEMLINE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 rest = count - idx;
5735 if (linecnt + rest > MLCS_MINL)
5736 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005737 end_idx = idx + MLCS_MINL - linecnt - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 linecnt = MLCS_MINL;
5739 }
5740 else
5741 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005742 end_idx = count - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 linecnt += rest;
5744 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005745#ifdef FEAT_PROP_POPUP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005746 if (buf->b_has_textprop)
5747 {
5748 int i;
5749
5750 // We cannot use the text pointers to get the text length,
5751 // the text prop info would also be counted. Go over the
5752 // lines.
5753 for (i = end_idx; i < idx; ++i)
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005754 size += (int)STRLEN((char_u *)dp
5755 + (dp->db_index[i] & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005756 }
5757 else
5758#endif
5759 {
Bram Moolenaar14c75302021-08-15 14:28:40 +02005760 if (idx == 0) // first line in block, text at the end
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005761 text_end = dp->db_txt_end;
5762 else
5763 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005764 size += text_end
5765 - ((dp->db_index[end_idx]) & DB_INDEX_MASK);
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005766 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 }
5768 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
5769 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
5770 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
5771 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
5772 buf->b_ml.ml_usedchunks++;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005773 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 return;
5775 }
5776 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
5777 && curix == buf->b_ml.ml_usedchunks - 1
5778 && buf->b_ml.ml_line_count - line <= 1)
5779 {
5780 /*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01005781 * We are in the last chunk and it is cheap to create a new one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782 * after this. Do it now to avoid the loop above later on
5783 */
5784 curchnk = buf->b_ml.ml_chunksize + curix + 1;
5785 buf->b_ml.ml_usedchunks++;
5786 if (line == buf->b_ml.ml_line_count)
5787 {
5788 curchnk->mlcs_numlines = 0;
5789 curchnk->mlcs_totalsize = 0;
5790 }
5791 else
5792 {
5793 /*
5794 * Line is just prior to last, move count for last
5795 * This is the common case when loading a new file
5796 */
5797 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
5798 if (hp == NULL)
5799 {
5800 buf->b_ml.ml_usedchunks = -1;
5801 return;
5802 }
5803 dp = (DATA_BL *)(hp->bh_data);
5804 if (dp->db_line_count == 1)
5805 rest = dp->db_txt_end - dp->db_txt_start;
5806 else
5807 rest =
5808 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
5809 - dp->db_txt_start;
5810 curchnk->mlcs_totalsize = rest;
5811 curchnk->mlcs_numlines = 1;
5812 curchnk[-1].mlcs_totalsize -= rest;
5813 curchnk[-1].mlcs_numlines -= 1;
5814 }
5815 }
5816 }
5817 else if (updtype == ML_CHNK_DELLINE)
5818 {
5819 curchnk->mlcs_numlines--;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005820 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005821 if (curix < buf->b_ml.ml_usedchunks - 1
5822 && curchnk->mlcs_numlines + curchnk[1].mlcs_numlines
5823 <= MLCS_MINL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 {
5825 curix++;
5826 curchnk = buf->b_ml.ml_chunksize + curix;
5827 }
5828 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
5829 {
5830 buf->b_ml.ml_usedchunks--;
5831 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
5832 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
5833 return;
5834 }
5835 else if (curix == 0 || (curchnk->mlcs_numlines > 10
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005836 && curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines
5837 > MLCS_MINL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 {
5839 return;
5840 }
5841
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005842 // Collapse chunks
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
5844 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
5845 buf->b_ml.ml_usedchunks--;
5846 if (curix < buf->b_ml.ml_usedchunks)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 mch_memmove(buf->b_ml.ml_chunksize + curix,
5848 buf->b_ml.ml_chunksize + curix + 1,
5849 (buf->b_ml.ml_usedchunks - curix) *
5850 sizeof(chunksize_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 return;
5852 }
5853 ml_upd_lastbuf = buf;
5854 ml_upd_lastline = line;
5855 ml_upd_lastcurline = curline;
5856 ml_upd_lastcurix = curix;
5857}
5858
5859/*
5860 * Find offset for line or line with offset.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005861 * Find line with offset if "lnum" is 0; return remaining offset in offp
5862 * Find offset of line if "lnum" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 * return -1 if information is not available
5864 */
5865 long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005866ml_find_line_or_offset(buf_T *buf, linenr_T lnum, long *offp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867{
5868 linenr_T curline;
5869 int curix;
5870 long size;
5871 bhdr_T *hp;
5872 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005873 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 int idx;
5875 int start_idx;
5876 int text_end;
5877 long offset;
5878 int len;
5879 int ffdos = (get_fileformat(buf) == EOL_DOS);
5880 int extra = 0;
5881
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005882 // take care of cached line first
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005883 ml_flush_line(curbuf);
5884
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 if (buf->b_ml.ml_usedchunks == -1
5886 || buf->b_ml.ml_chunksize == NULL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005887 || lnum < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888 return -1;
5889
5890 if (offp == NULL)
5891 offset = 0;
5892 else
5893 offset = *offp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005894 if (lnum == 0 && offset <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005895 return 1; // Not a "find offset" and offset 0 _must_ be in line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 /*
5897 * Find the last chunk before the one containing our line. Last chunk is
Bram Moolenaar14c75302021-08-15 14:28:40 +02005898 * special because it will never qualify.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 */
5900 curline = 1;
5901 curix = size = 0;
5902 while (curix < buf->b_ml.ml_usedchunks - 1
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005903 && ((lnum != 0
5904 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 || (offset != 0
5906 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
=?UTF-8?q?Dundar=20G=C3=B6c?=d5cec1f2022-01-29 15:19:23 +00005907 + (long)ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 {
5909 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5910 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
5911 if (offset && ffdos)
5912 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5913 curix++;
5914 }
5915
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005916 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 {
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005918#ifdef FEAT_PROP_POPUP
5919 size_t textprop_total = 0;
5920#endif
5921
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 if (curline > buf->b_ml.ml_line_count
5923 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5924 return -1;
5925 dp = (DATA_BL *)(hp->bh_data);
5926 count = (long)(buf->b_ml.ml_locked_high) -
5927 (long)(buf->b_ml.ml_locked_low) + 1;
5928 start_idx = idx = curline - buf->b_ml.ml_locked_low;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005929 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 text_end = dp->db_txt_end;
5931 else
5932 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005933 // Compute index of last line to use in this MEMLINE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005934 if (lnum != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005936 if (curline + (count - idx) >= lnum)
5937 idx += lnum - curline - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 else
5939 idx = count - 1;
5940 }
5941 else
5942 {
5943 extra = 0;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005944 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 {
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005946#ifdef FEAT_PROP_POPUP
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005947 size_t textprop_size = 0;
5948
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005949 if (buf->b_has_textprop)
5950 {
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005951 char_u *l1, *l2;
5952
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005953 // compensate for the extra bytes taken by textprops
5954 l1 = (char_u *)dp + ((dp->db_index[idx]) & DB_INDEX_MASK);
5955 l2 = (char_u *)dp + (idx == 0 ? dp->db_txt_end
5956 : ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
5957 textprop_size = (l2 - l1) - (STRLEN(l1) + 1);
5958 }
5959#endif
5960 if (!(offset >= size
5961 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
5962#ifdef FEAT_PROP_POPUP
Bram Moolenaar94b6fb72020-01-17 21:00:59 +01005963 - (long)(textprop_total + textprop_size)
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005964#endif
5965 + ffdos))
5966 break;
5967
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 if (ffdos)
5969 size++;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005970#ifdef FEAT_PROP_POPUP
5971 textprop_total += textprop_size;
5972#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973 if (idx == count - 1)
5974 {
5975 extra = 1;
5976 break;
5977 }
5978 idx++;
5979 }
5980 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005981#ifdef FEAT_PROP_POPUP
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005982 if (buf->b_has_textprop && lnum != 0)
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005983 {
5984 int i;
5985
5986 // cannot use the db_index pointer, need to get the actual text
5987 // lengths.
5988 len = 0;
5989 for (i = start_idx; i <= idx; ++i)
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005990 {
5991 char_u *p = (char_u *)dp + ((dp->db_index[i]) & DB_INDEX_MASK);
5992 len += (int)STRLEN(p) + 1;
5993 }
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005994 }
5995 else
5996#endif
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005997 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK)
5998#ifdef FEAT_PROP_POPUP
5999 - (long)textprop_total
6000#endif
6001 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 size += len;
6003 if (offset != 0 && size >= offset)
6004 {
6005 if (size + ffdos == offset)
6006 *offp = 0;
6007 else if (idx == start_idx)
6008 *offp = offset - size + len;
6009 else
6010 *offp = offset - size + len
Bram Moolenaar59ff6402021-01-30 17:16:28 +01006011 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK))
6012#ifdef FEAT_PROP_POPUP
6013 + (long)textprop_total
6014#endif
6015 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016 curline += idx - start_idx + extra;
6017 if (curline > buf->b_ml.ml_line_count)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006018 return -1; // exactly one byte beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 return curline;
6020 }
6021 curline = buf->b_ml.ml_locked_high + 1;
6022 }
6023
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00006024 if (lnum != 0)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006025 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006026 // Count extra CR characters.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006027 if (ffdos)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00006028 size += lnum - 1;
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006029
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006030 // Don't count the last line break if 'noeol' and ('bin' or
6031 // 'nofixeol').
Bram Moolenaar34d72d42015-07-17 14:18:08 +02006032 if ((!buf->b_p_fixeol || buf->b_p_bin) && !buf->b_p_eol
Bram Moolenaarc26f7c62018-08-20 22:53:04 +02006033 && lnum > buf->b_ml.ml_line_count)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006034 size -= ffdos + 1;
6035 }
6036
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 return size;
6038}
6039
6040/*
6041 * Goto byte in buffer with offset 'cnt'.
6042 */
6043 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01006044goto_byte(long cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045{
6046 long boff = cnt;
6047 linenr_T lnum;
6048
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006049 ml_flush_line(curbuf); // cached line may be dirty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 setpcmark();
6051 if (boff)
6052 --boff;
6053 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006054 if (lnum < 1) // past the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 {
6056 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
6057 curwin->w_curswant = MAXCOL;
6058 coladvance((colnr_T)MAXCOL);
6059 }
6060 else
6061 {
6062 curwin->w_cursor.lnum = lnum;
6063 curwin->w_cursor.col = (colnr_T)boff;
Bram Moolenaar943d2b52005-12-02 00:50:49 +00006064 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 curwin->w_set_curswant = TRUE;
6066 }
6067 check_cursor();
6068
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006069 // Make sure the cursor is on the first byte of a multi-byte char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 if (has_mbyte)
6071 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072}
6073#endif