blob: bbc13d7ed653ed2e196f931b35983c4fd20b74be [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 Moolenaar3a2a60c2023-05-27 18:02:55 +010067// BLOCK0_ID1_C3 and BLOCK0_ID1_C4 are for libsodium encryption. However, for
Bram Moolenaare1b48222023-04-24 18:11:35 +010068// 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 {
RestorerZ68ebcee2023-05-31 17:12:14 +0100335 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 {
RestorerZ68ebcee2023-05-31 17:12:14 +0100385 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 {
RestorerZ68ebcee2023-05-31 17:12:14 +0100403 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/*
Christian Brabandt19e6c4f2023-06-27 18:57:10 +0100428 * Swapfile encryption is not supported by XChaCha20. If this crypt method is
429 * used then disable the swapfile, to avoid plain text being written to disk,
430 * and return TRUE.
431 * Otherwise return FALSE.
432 */
433 static int
434crypt_may_close_swapfile(buf_T *buf, char_u *key, int method)
435{
436 if (crypt_method_is_sodium(method) && *key != NUL)
437 {
438 mf_close_file(buf, TRUE);
439 buf->b_p_swf = FALSE;
440 return TRUE;
441 }
442 return FALSE;
443}
444
445/*
Bram Moolenaar2be79502014-08-13 21:58:28 +0200446 * Prepare encryption for "buf" for the current key and method.
447 */
448 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100449ml_set_mfp_crypt(buf_T *buf)
Bram Moolenaar2be79502014-08-13 21:58:28 +0200450{
Yegappan Lakshmanane8575982023-01-14 12:32:28 +0000451 if (*buf->b_p_key == NUL)
452 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200453
Yegappan Lakshmanane8575982023-01-14 12:32:28 +0000454 int method_nr = crypt_get_method_nr(buf);
455
456 if (method_nr > CRYPT_M_ZIP && method_nr < CRYPT_M_SOD)
457 {
458 // Generate a seed and store it in the memfile.
459 sha2_seed(buf->b_ml.ml_mfp->mf_seed, MF_SEED_LEN, NULL, 0);
Bram Moolenaar2be79502014-08-13 21:58:28 +0200460 }
Christian Brabandt19e6c4f2023-06-27 18:57:10 +0100461# ifdef FEAT_SODIUM
Christian Brabandtaae58342023-04-23 17:50:22 +0100462 else if (crypt_method_is_sodium(method_nr))
Christian Brabandt19e6c4f2023-06-27 18:57:10 +0100463 crypt_sodium_randombytes_buf(buf->b_ml.ml_mfp->mf_seed, MF_SEED_LEN);
464# endif
Bram Moolenaar2be79502014-08-13 21:58:28 +0200465}
466
467/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200468 * Prepare encryption for "buf" with block 0 "b0p".
Bram Moolenaare1b48222023-04-24 18:11:35 +0100469 * Note: should not be called with libsodium encryption, since xchacha20 does
470 * not support swapfile encryption.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200471 */
472 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100473ml_set_b0_crypt(buf_T *buf, ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200474{
475 if (*buf->b_p_key == NUL)
476 b0p->b0_id[1] = BLOCK0_ID1;
477 else
478 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200479 int method_nr = crypt_get_method_nr(buf);
480
481 b0p->b0_id[1] = id1_codes[method_nr];
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200482 if (method_nr > CRYPT_M_ZIP && method_nr < CRYPT_M_SOD)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200483 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100484 // Generate a seed and store it in block 0 and in the memfile.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200485 sha2_seed(&b0p->b0_seed, MF_SEED_LEN, NULL, 0);
486 mch_memmove(buf->b_ml.ml_mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
487 }
488 }
489}
490
491/*
492 * Called after the crypt key or 'cryptmethod' was changed for "buf".
493 * Will apply this to the swapfile.
494 * "old_key" is the previous key. It is equal to buf->b_p_key when
495 * 'cryptmethod' is changed.
Bram Moolenaar49771f42010-07-20 17:32:38 +0200496 * "old_cm" is the previous 'cryptmethod'. It is equal to the current
497 * 'cryptmethod' when 'key' is changed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200498 */
499 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100500ml_set_crypt_key(
501 buf_T *buf,
502 char_u *old_key,
503 char_u *old_cm)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200504{
505 memfile_T *mfp = buf->b_ml.ml_mfp;
506 bhdr_T *hp;
507 int page_count;
508 int idx;
509 long error;
510 infoptr_T *ip;
511 PTR_BL *pp;
512 DATA_BL *dp;
513 blocknr_T bnum;
514 int top;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200515 int old_method;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200516
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200517 if (mfp == NULL || mfp->mf_fd < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100518 return; // no memfile yet, nothing to do
Bram Moolenaarbc563362015-06-09 18:35:25 +0200519 old_method = crypt_method_nr_from_name(old_cm);
520
Christian Brabandt19e6c4f2023-06-27 18:57:10 +0100521#ifdef FEAT_CRYPT
522 if (crypt_may_close_swapfile(buf, buf->b_p_key, crypt_get_method_nr(buf)))
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200523 return;
Christian Brabandt19e6c4f2023-06-27 18:57:10 +0100524#endif
Bram Moolenaare1b48222023-04-24 18:11:35 +0100525
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100526 // First make sure the swapfile is in a consistent state, using the old
527 // key and method.
Bram Moolenaarbc563362015-06-09 18:35:25 +0200528 {
529 char_u *new_key = buf->b_p_key;
530 char_u *new_buf_cm = buf->b_p_cm;
531
532 buf->b_p_key = old_key;
533 buf->b_p_cm = old_cm;
534 ml_preserve(buf, FALSE);
535 buf->b_p_key = new_key;
536 buf->b_p_cm = new_buf_cm;
537 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200538
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100539 // Set the key, method and seed to be used for reading, these must be the
540 // old values.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200541 mfp->mf_old_key = old_key;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200542 mfp->mf_old_cm = old_method;
543 if (old_method > 0 && *old_key != NUL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200544 mch_memmove(mfp->mf_old_seed, mfp->mf_seed, MF_SEED_LEN);
545
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100546 // Update block 0 with the crypt flag and may set a new seed.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200547 ml_upd_block0(buf, UB_CRYPT);
548
549 if (mfp->mf_infile_count > 2)
550 {
551 /*
552 * Need to read back all data blocks from disk, decrypt them with the
553 * old key/method and mark them to be written. The algorithm is
554 * similar to what happens in ml_recover(), but we skip negative block
555 * numbers.
556 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100557 ml_flush_line(buf); // flush buffered line
558 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200559
560 hp = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100561 bnum = 1; // start with block 1
562 page_count = 1; // which is 1 page
563 idx = 0; // start with first index in block 1
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200564 error = 0;
565 buf->b_ml.ml_stack_top = 0;
Bram Moolenaard23a8232018-02-10 18:45:26 +0100566 VIM_CLEAR(buf->b_ml.ml_stack);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100567 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200568
569 for ( ; !got_int; line_breakcheck())
570 {
571 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100572 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200573
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100574 // get the block (pointer or data)
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +0000575 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200576 {
577 if (bnum == 1)
578 break;
579 ++error;
580 }
581 else
582 {
583 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100584 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200585 {
586 if (pp->pb_count == 0)
587 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100588 // empty block?
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200589 ++error;
590 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100591 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200592 {
593 if (pp->pb_pointer[idx].pe_bnum < 0)
594 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100595 // Skip data block with negative block number.
596 // Should not happen, because of the ml_preserve()
597 // above. Get same block again for next index.
Bram Moolenaar4b7214e2019-01-03 21:55:32 +0100598 ++idx;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200599 continue;
600 }
601
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100602 // going one block deeper in the tree, new entry in
603 // stack
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200604 if ((top = ml_add_stack(buf)) < 0)
605 {
606 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100607 break; // out of memory
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200608 }
609 ip = &(buf->b_ml.ml_stack[top]);
610 ip->ip_bnum = bnum;
611 ip->ip_index = idx;
612
613 bnum = pp->pb_pointer[idx].pe_bnum;
614 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaarbc563362015-06-09 18:35:25 +0200615 idx = 0;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200616 continue;
617 }
618 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100619 else // not a pointer block
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200620 {
621 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100622 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200623 ++error;
624 else
625 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100626 // It is a data block, need to write it back to disk.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200627 mf_put(mfp, hp, TRUE, FALSE);
628 hp = NULL;
629 }
630 }
631 }
632
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100633 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200634 break;
635
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100636 // go one block up in the tree
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200637 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
638 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100639 idx = ip->ip_index + 1; // go to next index
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200640 page_count = 1;
641 }
Bram Moolenaarbc563362015-06-09 18:35:25 +0200642 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100643 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +0100644
645 if (error > 0)
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000646 emsg(_(e_error_while_updating_swap_file_crypt));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200647 }
648
649 mfp->mf_old_key = NULL;
650}
651#endif
652
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653/*
654 * ml_setname() is called when the file name of "buf" has been changed.
655 * It may rename the swap file.
656 */
657 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100658ml_setname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659{
660 int success = FALSE;
661 memfile_T *mfp;
662 char_u *fname;
663 char_u *dirp;
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100664#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 char_u *p;
666#endif
667
668 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100669 if (mfp->mf_fd < 0) // there is no swap file yet
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 {
671 /*
672 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
673 * For help files we will make a swap file now.
674 */
Bram Moolenaare1004402020-10-24 20:49:43 +0200675 if (p_uc != 0 && (cmdmod.cmod_flags & CMOD_NOSWAPFILE) == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100676 ml_open_file(buf); // create a swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 return;
678 }
679
680 /*
681 * Try all directories in the 'directory' option.
682 */
683 dirp = p_dir;
684 for (;;)
685 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100686 if (*dirp == NUL) // tried all directories, fail
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 break;
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000688 fname = findswapname(buf, &dirp, mfp->mf_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100689 // alloc's fname
690 if (dirp == NULL) // out of memory
Bram Moolenaarf541c362011-10-26 11:44:18 +0200691 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100692 if (fname == NULL) // no file name found for this dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 continue;
694
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100695#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 /*
697 * Set full pathname for swap file now, because a ":!cd dir" may
698 * change directory without us knowing it.
699 */
700 p = FullName_save(fname, FALSE);
701 vim_free(fname);
702 fname = p;
703 if (fname == NULL)
704 continue;
705#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100706 // if the file name is the same we don't have to do anything
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 if (fnamecmp(fname, mfp->mf_fname) == 0)
708 {
709 vim_free(fname);
710 success = TRUE;
711 break;
712 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100713 // need to close the swap file before renaming
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 if (mfp->mf_fd >= 0)
715 {
716 close(mfp->mf_fd);
717 mfp->mf_fd = -1;
718 }
719
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100720 // try to rename the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 if (vim_rename(mfp->mf_fname, fname) == 0)
722 {
723 success = TRUE;
724 vim_free(mfp->mf_fname);
725 mfp->mf_fname = fname;
726 vim_free(mfp->mf_ffname);
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100727#if defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100728 mfp->mf_ffname = NULL; // mf_fname is full pathname already
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729#else
730 mf_set_ffname(mfp);
731#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200732 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 break;
734 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100735 vim_free(fname); // this fname didn't work, try another
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736 }
737
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100738 if (mfp->mf_fd == -1) // need to (re)open the swap file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 {
740 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
741 if (mfp->mf_fd < 0)
742 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100743 // could not (re)open the swap file, what can we do????
Bram Moolenaareaaac012022-01-02 17:00:40 +0000744 emsg(_(e_oops_lost_the_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 return;
746 }
Bram Moolenaarf05da212009-11-17 16:13:15 +0000747#ifdef HAVE_FD_CLOEXEC
748 {
749 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
750 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarfbc4b4d2016-02-07 15:14:01 +0100751 (void)fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaarf05da212009-11-17 16:13:15 +0000752 }
753#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 }
755 if (!success)
Bram Moolenaareaaac012022-01-02 17:00:40 +0000756 emsg(_(e_could_not_rename_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757}
758
759/*
760 * Open a file for the memfile for all buffers that are not readonly or have
761 * been modified.
762 * Used when 'updatecount' changes from zero to non-zero.
763 */
764 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100765ml_open_files(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766{
767 buf_T *buf;
768
Bram Moolenaar29323592016-07-24 22:04:11 +0200769 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 if (!buf->b_p_ro || buf->b_changed)
771 ml_open_file(buf);
772}
773
774/*
775 * Open a swap file for an existing memfile, if there is no swap file yet.
776 * If we are unable to find a file name, mf_fname will be NULL
777 * and the memfile will be in memory only (no recovery possible).
778 */
779 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100780ml_open_file(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781{
782 memfile_T *mfp;
783 char_u *fname;
784 char_u *dirp;
785
786 mfp = buf->b_ml.ml_mfp;
Bram Moolenaare1004402020-10-24 20:49:43 +0200787 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf
788 || (cmdmod.cmod_flags & CMOD_NOSWAPFILE))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100789 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
Bram Moolenaara1956f62006-03-12 22:18:00 +0000791#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100792 // For a spell buffer use a temp file name.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000793 if (buf->b_spell)
794 {
Bram Moolenaare5c421c2015-03-31 13:33:08 +0200795 fname = vim_tempname('s', FALSE);
Bram Moolenaar4770d092006-01-12 23:22:24 +0000796 if (fname != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100797 (void)mf_open_file(mfp, fname); // consumes fname!
Bram Moolenaar4770d092006-01-12 23:22:24 +0000798 buf->b_may_swap = FALSE;
799 return;
800 }
801#endif
802
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 /*
804 * Try all directories in 'directory' option.
805 */
806 dirp = p_dir;
807 for (;;)
808 {
809 if (*dirp == NUL)
810 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100811 // There is a small chance that between choosing the swap file name
812 // and creating it, another Vim creates the file. In that case the
813 // creation will fail and we will use another directory.
814 fname = findswapname(buf, &dirp, NULL); // allocates fname
Bram Moolenaarf541c362011-10-26 11:44:18 +0200815 if (dirp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100816 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 if (fname == NULL)
818 continue;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100819 if (mf_open_file(mfp, fname) == OK) // consumes fname!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 {
Bram Moolenaar3a2a60c2023-05-27 18:02:55 +0100821 // don't sync yet in ml_sync_all()
822 mfp->mf_dirty = MF_DIRTY_YES_NOSYNC;
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100823#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 /*
825 * set full pathname for swap file now, because a ":!cd dir" may
826 * change directory without us knowing it.
827 */
828 mf_fullname(mfp);
829#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200830 ml_upd_block0(buf, UB_SAME_DIR);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000831
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100832 // Flush block zero, so others can read it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 if (mf_sync(mfp, MFS_ZERO) == OK)
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000834 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100835 // Mark all blocks that should be in the swapfile as dirty.
836 // Needed for when the 'swapfile' option was reset, so that
837 // the swap file was deleted, and then on again.
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000838 mf_set_dirty(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 break;
Bram Moolenaarc32840f2006-01-14 21:23:38 +0000840 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100841 // Writing block 0 failed: close the file and try another dir
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 mf_close_file(buf, FALSE);
843 }
844 }
845
Bram Moolenaar00e192b2019-10-19 17:01:28 +0200846 if (*p_dir != NUL && mfp->mf_fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 {
Bram Moolenaar13608d82022-08-29 15:06:50 +0100848 need_wait_return = TRUE; // call wait_return() later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 ++no_wait_return;
Bram Moolenaareaaac012022-01-02 17:00:40 +0000850 (void)semsg(_(e_unable_to_open_swap_file_for_str_recovery_impossible),
Bram Moolenaare1704ba2012-10-03 18:25:00 +0200851 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 --no_wait_return;
853 }
854
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100855 // don't try to open a swap file again
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 buf->b_may_swap = FALSE;
857}
858
859/*
860 * If still need to create a swap file, and starting to edit a not-readonly
861 * file, or reading into an existing buffer, create a swap file now.
862 */
863 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100864check_need_swap(
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200865 int newfile) // reading file into new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866{
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200867 int old_msg_silent = msg_silent; // might be reset by an E325 message
868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
870 ml_open_file(curbuf);
Bram Moolenaar2f0f8712018-08-21 18:50:18 +0200871 msg_silent = old_msg_silent;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872}
873
874/*
875 * Close memline for buffer 'buf'.
876 * If 'del_file' is TRUE, delete the swap file
877 */
878 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100879ml_close(buf_T *buf, int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100881 if (buf->b_ml.ml_mfp == NULL) // not open
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 return;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100883 mf_close(buf->b_ml.ml_mfp, del_file); // close the .swp file
Bram Moolenaarfa4873c2022-06-30 22:13:59 +0100884 if (buf->b_ml.ml_line_lnum != 0
885 && (buf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED)))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 vim_free(buf->b_ml.ml_line_ptr);
887 vim_free(buf->b_ml.ml_stack);
888#ifdef FEAT_BYTEOFF
Bram Moolenaard23a8232018-02-10 18:45:26 +0100889 VIM_CLEAR(buf->b_ml.ml_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890#endif
891 buf->b_ml.ml_mfp = NULL;
892
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100893 // Reset the "recovered" flag, give the ATTENTION prompt the next time
894 // this buffer is loaded.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 buf->b_flags &= ~BF_RECOVERED;
896}
897
898/*
899 * Close all existing memlines and memfiles.
900 * Only used when exiting.
901 * When 'del_file' is TRUE, delete the memfiles.
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000902 * But don't delete files that were ":preserve"d when we are POSIX compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 */
904 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100905ml_close_all(int del_file)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906{
907 buf_T *buf;
908
Bram Moolenaar29323592016-07-24 22:04:11 +0200909 FOR_ALL_BUFFERS(buf)
Bram Moolenaar81bf7082005-02-12 14:31:42 +0000910 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
911 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100912#ifdef FEAT_SPELL
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100913 spell_delete_wordlist(); // delete the internal wordlist
Bram Moolenaar34b466e2013-11-28 17:41:46 +0100914#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915#ifdef TEMPDIRNAMES
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100916 vim_deltempdir(); // delete created temp directory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917#endif
918}
919
920/*
921 * Close all memfiles for not modified buffers.
922 * Only use just before exiting!
923 */
924 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100925ml_close_notmod(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926{
927 buf_T *buf;
928
Bram Moolenaar29323592016-07-24 22:04:11 +0200929 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 if (!bufIsChanged(buf))
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100931 ml_close(buf, TRUE); // close all not-modified buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932}
933
934/*
935 * Update the timestamp in the .swp file.
936 * Used when the file has been written.
937 */
938 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100939ml_timestamp(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940{
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200941 ml_upd_block0(buf, UB_FNAME);
942}
943
944/*
945 * Return FAIL when the ID of "b0p" is wrong.
946 */
947 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100948ml_check_b0_id(ZERO_BL *b0p)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200949{
950 if (b0p->b0_id[0] != BLOCK0_ID0
951 || (b0p->b0_id[1] != BLOCK0_ID1
952 && b0p->b0_id[1] != BLOCK0_ID1_C0
Bram Moolenaar8f4ac012014-08-10 13:38:34 +0200953 && b0p->b0_id[1] != BLOCK0_ID1_C1
Christian Brabandtf573c6e2021-06-20 14:02:16 +0200954 && b0p->b0_id[1] != BLOCK0_ID1_C2
Bram Moolenaar3a2a60c2023-05-27 18:02:55 +0100955 && b0p->b0_id[1] != BLOCK0_ID1_C3
956 && b0p->b0_id[1] != BLOCK0_ID1_C4)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200957 )
958 return FAIL;
959 return OK;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000960}
961
962/*
963 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
964 */
965 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100966ml_upd_block0(buf_T *buf, upd_block0_T what)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000967{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 memfile_T *mfp;
969 bhdr_T *hp;
970 ZERO_BL *b0p;
971
972 mfp = buf->b_ml.ml_mfp;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200973 if (mfp == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 return;
Bram Moolenaar2be79502014-08-13 21:58:28 +0200975 hp = mf_get(mfp, (blocknr_T)0, 1);
976 if (hp == NULL)
977 {
978#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100979 // Possibly update the seed in the memfile before there is a block0.
Bram Moolenaar2be79502014-08-13 21:58:28 +0200980 if (what == UB_CRYPT)
981 ml_set_mfp_crypt(buf);
982#endif
983 return;
984 }
985
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200987 if (ml_check_b0_id(b0p) == FAIL)
RestorerZ68ebcee2023-05-31 17:12:14 +0100988 iemsg(e_ml_upd_block0_didnt_get_block_zero);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000990 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200991 if (what == UB_FNAME)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000992 set_b0_fname(b0p, buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +0200993#ifdef FEAT_CRYPT
994 else if (what == UB_CRYPT)
995 ml_set_b0_crypt(buf, b0p);
996#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +0100997 else // what == UB_SAME_DIR
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000998 set_b0_dir_flag(b0p, buf);
999 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 mf_put(mfp, hp, TRUE, FALSE);
1001}
1002
1003/*
1004 * Write file name and timestamp into block 0 of a swap file.
1005 * Also set buf->b_mtime.
1006 * Don't use NameBuff[]!!!
1007 */
1008 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001009set_b0_fname(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010{
Bram Moolenaar8767f522016-07-01 17:17:39 +02001011 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012
1013 if (buf->b_ffname == NULL)
1014 b0p->b0_fname[0] = NUL;
1015 else
1016 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001017#if defined(MSWIN) || defined(AMIGA)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001018 // Systems that cannot translate "~user" back into a path: copy the
1019 // file name unmodified. Do use slashes instead of backslashes for
1020 // portability.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001021 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001022# ifdef BACKSLASH_IN_FILENAME
1023 forward_slash(b0p->b0_fname);
1024# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025#else
1026 size_t flen, ulen;
1027 char_u uname[B0_UNAME_SIZE];
1028
1029 /*
1030 * For a file under the home directory of the current user, we try to
1031 * replace the home directory path with "~user". This helps when
1032 * editing the same file on different machines over a network.
1033 * First replace home dir path with "~/" with home_replace().
1034 * Then insert the user name to get "~user/".
1035 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001036 home_replace(NULL, buf->b_ffname, b0p->b0_fname,
1037 B0_FNAME_SIZE_CRYPT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 if (b0p->b0_fname[0] == '~')
1039 {
1040 flen = STRLEN(b0p->b0_fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001041 // If there is no user name or it is too long, don't use "~/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001043 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE_CRYPT - 1)
1044 vim_strncpy(b0p->b0_fname, buf->b_ffname,
1045 B0_FNAME_SIZE_CRYPT - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 else
1047 {
1048 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
1049 mch_memmove(b0p->b0_fname + 1, uname, ulen);
1050 }
1051 }
1052#endif
1053 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
1054 {
1055 long_to_char((long)st.st_mtime, b0p->b0_mtime);
1056#ifdef CHECK_INODE
1057 long_to_char((long)st.st_ino, b0p->b0_ino);
1058#endif
1059 buf_store_time(buf, &st, buf->b_ffname);
1060 buf->b_mtime_read = buf->b_mtime;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001061 buf->b_mtime_read_ns = buf->b_mtime_ns;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062 }
1063 else
1064 {
1065 long_to_char(0L, b0p->b0_mtime);
1066#ifdef CHECK_INODE
1067 long_to_char(0L, b0p->b0_ino);
1068#endif
1069 buf->b_mtime = 0;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001070 buf->b_mtime_ns = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071 buf->b_mtime_read = 0;
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01001072 buf->b_mtime_read_ns = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 buf->b_orig_size = 0;
1074 buf->b_orig_mode = 0;
1075 }
1076 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001077
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001078 // Also add the 'fileencoding' if there is room.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001079 add_b0_fenc(b0p, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080}
1081
1082/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001083 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
1084 * swapfile for "buf" are in the same directory.
1085 * This is fail safe: if we are not sure the directories are equal the flag is
1086 * not set.
1087 */
1088 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001089set_b0_dir_flag(ZERO_BL *b0p, buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001090{
1091 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
1092 b0p->b0_flags |= B0_SAME_DIR;
1093 else
1094 b0p->b0_flags &= ~B0_SAME_DIR;
1095}
1096
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001097/*
1098 * When there is room, add the 'fileencoding' to block zero.
1099 */
1100 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001101add_b0_fenc(
1102 ZERO_BL *b0p,
1103 buf_T *buf)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001104{
1105 int n;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001106 int size = B0_FNAME_SIZE_NOCRYPT;
1107
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001108#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001109 // Without encryption use the same offset as in Vim 7.2 to be compatible.
1110 // With encryption it's OK to move elsewhere, the swap file is not
1111 // compatible anyway.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001112 if (*buf->b_p_key != NUL)
1113 size = B0_FNAME_SIZE_CRYPT;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001114#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001115
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001116 n = (int)STRLEN(buf->b_p_fenc);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001117 if ((int)STRLEN(b0p->b0_fname) + n + 1 > size)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001118 b0p->b0_flags &= ~B0_HAS_FENC;
1119 else
1120 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001121 mch_memmove((char *)b0p->b0_fname + size - n,
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001122 (char *)buf->b_p_fenc, (size_t)n);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001123 *(b0p->b0_fname + size - n - 1) = NUL;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001124 b0p->b0_flags |= B0_HAS_FENC;
1125 }
1126}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001127
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001128#if defined(HAVE_SYS_SYSINFO_H) && defined(HAVE_SYSINFO_UPTIME)
1129# include <sys/sysinfo.h>
1130#endif
1131
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001132#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001133/*
1134 * Return TRUE if the process with number "b0p->b0_pid" is still running.
1135 * "swap_fname" is the name of the swap file, if it's from before a reboot then
1136 * the result is FALSE;
1137 */
1138 static int
1139swapfile_process_running(ZERO_BL *b0p, char_u *swap_fname UNUSED)
1140{
Bram Moolenaare2982d62021-10-06 11:27:21 +01001141#if defined(HAVE_SYSINFO) && defined(HAVE_SYSINFO_UPTIME)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001142 stat_T st;
1143 struct sysinfo sinfo;
1144
1145 // If the system rebooted after when the swap file was written then the
1146 // process can't be running now.
1147 if (mch_stat((char *)swap_fname, &st) != -1
1148 && sysinfo(&sinfo) == 0
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001149 && st.st_mtime < time(NULL) - (
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001150# ifdef FEAT_EVAL
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001151 override_sysinfo_uptime >= 0 ? override_sysinfo_uptime :
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001152# endif
Bram Moolenaar23b32a82021-03-10 21:55:46 +01001153 sinfo.uptime))
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001154 return FALSE;
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001155# endif
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001156 return mch_process_running(char_to_long(b0p->b0_pid));
1157}
=?UTF-8?q?Ola=20S=C3=B6der?=599a6e52021-07-06 20:15:46 +02001158#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001159
1160/*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001161 * Try to recover curbuf from the .swp file.
Bram Moolenaar99499b12019-05-23 21:35:48 +02001162 * If "checkext" is TRUE, check the extension and detect whether it is
1163 * a swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 */
1165 void
Bram Moolenaar99499b12019-05-23 21:35:48 +02001166ml_recover(int checkext)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167{
1168 buf_T *buf = NULL;
1169 memfile_T *mfp = NULL;
1170 char_u *fname;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001171 char_u *fname_used = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 bhdr_T *hp = NULL;
1173 ZERO_BL *b0p;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001174 int b0_ff;
1175 char_u *b0_fenc = NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001176#ifdef FEAT_CRYPT
1177 int b0_cm = -1;
1178#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 PTR_BL *pp;
1180 DATA_BL *dp;
1181 infoptr_T *ip;
1182 blocknr_T bnum;
1183 int page_count;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001184 stat_T org_stat, swp_stat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 int len;
1186 int directly;
1187 linenr_T lnum;
1188 char_u *p;
1189 int i;
1190 long error;
1191 int cannot_open;
1192 linenr_T line_count;
1193 int has_error;
1194 int idx;
1195 int top;
1196 int txt_start;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001197 off_T size;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 int called_from_main;
1199 int serious_error = TRUE;
1200 long mtime;
1201 int attr;
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001202 int orig_file_status = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203
1204 recoverymode = TRUE;
1205 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001206 attr = HL_ATTR(HLF_E);
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001207
1208 /*
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001209 * 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 +00001210 * Otherwise a search is done to find the swap file(s).
1211 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 fname = curbuf->b_fname;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001213 if (fname == NULL) // When there is no file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 fname = (char_u *)"";
1215 len = (int)STRLEN(fname);
Bram Moolenaar99499b12019-05-23 21:35:48 +02001216 if (checkext && len >= 4 &&
Bram Moolenaare60acc12011-05-10 16:41:25 +02001217#if defined(VMS)
Bram Moolenaar79518e22017-02-17 16:31:35 +01001218 STRNICMP(fname + len - 4, "_s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219#else
Bram Moolenaar79518e22017-02-17 16:31:35 +01001220 STRNICMP(fname + len - 4, ".s", 2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221#endif
Bram Moolenaar79518e22017-02-17 16:31:35 +01001222 == 0
Bram Moolenaaraf903e52017-12-02 15:11:22 +01001223 && vim_strchr((char_u *)"abcdefghijklmnopqrstuvw",
1224 TOLOWER_ASC(fname[len - 2])) != NULL
Bram Moolenaard0ba34a2009-11-03 12:06:23 +00001225 && ASCII_ISALPHA(fname[len - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 {
1227 directly = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001228 fname_used = vim_strsave(fname); // make a copy for mf_open()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 }
1230 else
1231 {
1232 directly = FALSE;
1233
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001234 // count the number of matching swap files
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001235 len = recover_names(fname, FALSE, NULL, 0, NULL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001236 if (len == 0) // no swap files found
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001238 semsg(_(e_no_swap_file_found_for_str), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 goto theend;
1240 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001241 if (len == 1) // one swap file found, use it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 i = 1;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001243 else // several swap files found, choose
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001245 // list the names of the swap files
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001246 (void)recover_names(fname, TRUE, NULL, 0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 msg_putchar('\n');
Bram Moolenaar32526b32019-01-19 17:43:09 +01001248 msg_puts(_("Enter number of swap file to use (0 to quit): "));
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001249 i = get_number(FALSE, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 if (i < 1 || i > len)
1251 goto theend;
1252 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001253 // get the swap file name that will be used
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001254 (void)recover_names(fname, FALSE, NULL, i, &fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001256 if (fname_used == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001257 goto theend; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001259 // When called from main() still need to initialize storage structure
Bram Moolenaar4770d092006-01-12 23:22:24 +00001260 if (called_from_main && ml_open(curbuf) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 getout(1);
1262
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001263 /*
1264 * Allocate a buffer structure for the swap file that is used for recovery.
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001265 * Only the memline and crypt information in it are really used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001266 */
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001267 buf = ALLOC_ONE(buf_T);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 if (buf == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001271 /*
1272 * init fields in memline struct
1273 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001274 buf->b_ml.ml_stack_size = 0; // no stack yet
1275 buf->b_ml.ml_stack = NULL; // no stack yet
1276 buf->b_ml.ml_stack_top = 0; // nothing in the stack
1277 buf->b_ml.ml_line_lnum = 0; // no cached line
1278 buf->b_ml.ml_locked = NULL; // no locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 buf->b_ml.ml_flags = 0;
Bram Moolenaar0fe849a2010-07-25 15:11:11 +02001280#ifdef FEAT_CRYPT
1281 buf->b_p_key = empty_option;
1282 buf->b_p_cm = empty_option;
1283#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001285 /*
1286 * open the memfile from the old swap file
1287 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001288 p = vim_strsave(fname_used); // save "fname_used" for the message:
1289 // mf_open() will consume "fname_used"!
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001290 mfp = mf_open(fname_used, O_RDONLY);
1291 fname_used = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 if (mfp == NULL || mfp->mf_fd < 0)
1293 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001294 if (fname_used != NULL)
Bram Moolenaareaaac012022-01-02 17:00:40 +00001295 semsg(_(e_cannot_open_str), fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 goto theend;
1297 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 buf->b_ml.ml_mfp = mfp;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001299#ifdef FEAT_CRYPT
1300 mfp->mf_buffer = buf;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001301#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302
1303 /*
1304 * The page size set in mf_open() might be different from the page size
1305 * used in the swap file, we must get it from block 0. But to read block
1306 * 0 we need a page size. Use the minimal size for block 0 here, it will
1307 * be set to the real value below.
1308 */
1309 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
1310
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001311 /*
1312 * try to read block 0
1313 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
1315 {
1316 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +01001317 msg_puts_attr(_("Unable to read block 0 from "), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001319 msg_puts_attr(_("\nMaybe no changes were made or Vim did not update the swap file."),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 attr | MSG_HIST);
1321 msg_end();
1322 goto theend;
1323 }
1324 b0p = (ZERO_BL *)(hp->bh_data);
1325 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
1326 {
1327 msg_start();
1328 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001329 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001331 msg_puts_attr(_("Use Vim version 3.0.\n"), MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 msg_end();
1333 goto theend;
1334 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001335 if (ml_check_b0_id(b0p) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001337 semsg(_(e_str_does_not_look_like_vim_swap_file), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 goto theend;
1339 }
1340 if (b0_magic_wrong(b0p))
1341 {
1342 msg_start();
1343 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001344#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001346 msg_puts_attr(_(" cannot be used with this version of Vim.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 attr | MSG_HIST);
1348 else
1349#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001350 msg_puts_attr(_(" cannot be used on this computer.\n"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001352 msg_puts_attr(_("The file was created on "), attr | MSG_HIST);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001353 // avoid going past the end of a corrupted hostname
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 b0p->b0_fname[0] = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001355 msg_puts_attr((char *)b0p->b0_hname, attr | MSG_HIST);
1356 msg_puts_attr(_(",\nor the file has been damaged."), attr | MSG_HIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 msg_end();
1358 goto theend;
1359 }
Bram Moolenaar1c536282007-04-26 15:21:56 +00001360
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001361#ifdef FEAT_CRYPT
K.Takataeeec2542021-06-02 13:28:16 +02001362 for (i = 0; i < (int)ARRAY_LENGTH(id1_codes); ++i)
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001363 if (id1_codes[i] == b0p->b0_id[1])
1364 b0_cm = i;
1365 if (b0_cm > 0)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001366 mch_memmove(mfp->mf_seed, &b0p->b0_seed, MF_SEED_LEN);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001367 crypt_set_cm_option(buf, b0_cm < 0 ? 0 : b0_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001368#else
1369 if (b0p->b0_id[1] != BLOCK0_ID1)
1370 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00001371 semsg(_(e_str_is_encrypted_and_this_version_of_vim_does_not_support_encryption), mfp->mf_fname);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001372 goto theend;
1373 }
1374#endif
1375
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 /*
1377 * If we guessed the wrong page size, we have to recalculate the
1378 * highest block number in the file.
1379 */
1380 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1381 {
Bram Moolenaar1c536282007-04-26 15:21:56 +00001382 unsigned previous_page_size = mfp->mf_page_size;
1383
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
Bram Moolenaar1c536282007-04-26 15:21:56 +00001385 if (mfp->mf_page_size < previous_page_size)
1386 {
1387 msg_start();
1388 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001389 msg_puts_attr(_(" has been damaged (page size is smaller than minimum value).\n"),
Bram Moolenaar1c536282007-04-26 15:21:56 +00001390 attr | MSG_HIST);
1391 msg_end();
1392 goto theend;
1393 }
Bram Moolenaar8767f522016-07-01 17:17:39 +02001394 if ((size = vim_lseek(mfp->mf_fd, (off_T)0L, SEEK_END)) <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001395 mfp->mf_blocknr_max = 0; // no file or empty file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 else
1397 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1398 mfp->mf_infile_count = mfp->mf_blocknr_max;
Bram Moolenaar1c536282007-04-26 15:21:56 +00001399
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001400 // need to reallocate the memory used to store the data
Bram Moolenaar1c536282007-04-26 15:21:56 +00001401 p = alloc(mfp->mf_page_size);
1402 if (p == NULL)
1403 goto theend;
1404 mch_memmove(p, hp->bh_data, previous_page_size);
1405 vim_free(hp->bh_data);
1406 hp->bh_data = p;
1407 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 }
1409
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001410 /*
1411 * If .swp file name given directly, use name from swap file for buffer.
1412 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 if (directly)
1414 {
1415 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1416 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1417 goto theend;
1418 }
1419
1420 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001421 smsg(_("Using swap file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422
1423 if (buf_spname(curbuf) != NULL)
Bram Moolenaare1704ba2012-10-03 18:25:00 +02001424 vim_strncpy(NameBuff, buf_spname(curbuf), MAXPATHL - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 else
1426 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001427 smsg(_("Original file \"%s\""), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 msg_putchar('\n');
1429
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001430 /*
1431 * check date of swap file and original file
1432 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 mtime = char_to_long(b0p->b0_mtime);
1434 if (curbuf->b_ffname != NULL
1435 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1436 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1437 && org_stat.st_mtime > swp_stat.st_mtime)
1438 || org_stat.st_mtime != mtime))
Bram Moolenaareaaac012022-01-02 17:00:40 +00001439 emsg(_(e_warning_original_file_may_have_been_changed));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 out_flush();
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001441
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001442 // Get the 'fileformat' and 'fileencoding' from block zero.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001443 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1444 if (b0p->b0_flags & B0_HAS_FENC)
1445 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001446 int fnsize = B0_FNAME_SIZE_NOCRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001447
1448#ifdef FEAT_CRYPT
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001449 // Use the same size as in add_b0_fenc().
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001450 if (b0p->b0_id[1] != BLOCK0_ID1)
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001451 fnsize = B0_FNAME_SIZE_CRYPT;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001452#endif
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02001453 for (p = b0p->b0_fname + fnsize; p > b0p->b0_fname && p[-1] != NUL; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001454 ;
Bram Moolenaar71ccd032020-06-12 22:59:11 +02001455 b0_fenc = vim_strnsave(p, b0p->b0_fname + fnsize - p);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001456 }
1457
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001458 mf_put(mfp, hp, FALSE, FALSE); // release block 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 hp = NULL;
1460
1461 /*
1462 * Now that we are sure that the file is going to be recovered, clear the
1463 * contents of the current buffer.
1464 */
1465 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001466 ml_delete((linenr_T)1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467
1468 /*
1469 * Try reading the original file to obtain the values of 'fileformat',
1470 * 'fileencoding', etc. Ignore errors. The text itself is not used.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001471 * When the file is encrypted the user is asked to enter the key.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 */
1473 if (curbuf->b_ffname != NULL)
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001474 orig_file_status = readfile(curbuf->b_ffname, NULL, (linenr_T)0,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001477#ifdef FEAT_CRYPT
1478 if (b0_cm >= 0)
1479 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001480 // Need to ask the user for the crypt key. If this fails we continue
1481 // without a key, will probably get garbage text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001482 if (*curbuf->b_p_key != NUL)
1483 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001484 smsg(_("Swap file is encrypted: \"%s\""), fname_used);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001485 msg_puts(_("\nIf you entered a new crypt key but did not write the text file,"));
1486 msg_puts(_("\nenter the new crypt key."));
1487 msg_puts(_("\nIf you wrote the text file after changing the crypt key press enter"));
1488 msg_puts(_("\nto use the same key for text file and swap file"));
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001489 }
1490 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001491 smsg(_(need_key_msg), fname_used);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001492 buf->b_p_key = crypt_get_key(FALSE, FALSE);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001493 if (buf->b_p_key == NULL)
1494 buf->b_p_key = curbuf->b_p_key;
1495 else if (*buf->b_p_key == NUL)
1496 {
1497 vim_free(buf->b_p_key);
1498 buf->b_p_key = curbuf->b_p_key;
1499 }
1500 if (buf->b_p_key == NULL)
1501 buf->b_p_key = empty_option;
1502 }
1503#endif
1504
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001505 // Use the 'fileformat' and 'fileencoding' as stored in the swap file.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001506 if (b0_ff != 0)
1507 set_fileformat(b0_ff - 1, OPT_LOCAL);
1508 if (b0_fenc != NULL)
1509 {
Bram Moolenaar31e5c602022-04-15 13:53:33 +01001510 set_option_value_give_err((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001511 vim_free(b0_fenc);
1512 }
Bram Moolenaarc024b462019-06-08 18:07:21 +02001513 unchanged(curbuf, TRUE, TRUE);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001514
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001515 bnum = 1; // start with block 1
1516 page_count = 1; // which is 1 page
1517 lnum = 0; // append after line 0 in curbuf
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 line_count = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001519 idx = 0; // start with first index in block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 error = 0;
1521 buf->b_ml.ml_stack_top = 0;
1522 buf->b_ml.ml_stack = NULL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001523 buf->b_ml.ml_stack_size = 0; // no stack yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524
1525 if (curbuf->b_ffname == NULL)
1526 cannot_open = TRUE;
1527 else
1528 cannot_open = FALSE;
1529
1530 serious_error = FALSE;
1531 for ( ; !got_int; line_breakcheck())
1532 {
1533 if (hp != NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001534 mf_put(mfp, hp, FALSE, FALSE); // release previous block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535
1536 /*
1537 * get block
1538 */
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00001539 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 {
1541 if (bnum == 1)
1542 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001543 semsg(_(e_unable_to_read_block_one_from_str), mfp->mf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 goto theend;
1545 }
1546 ++error;
1547 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1548 (colnr_T)0, TRUE);
1549 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001550 else // there is a block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 {
1552 pp = (PTR_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001553 if (pp->pb_id == PTR_ID) // it is a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 {
Bram Moolenaarb67ba032023-04-22 21:14:26 +01001555 int ptr_block_error = FALSE;
1556 if (pp->pb_count_max != PB_COUNT_MAX(mfp))
1557 {
1558 ptr_block_error = TRUE;
1559 pp->pb_count_max = PB_COUNT_MAX(mfp);
1560 }
1561 if (pp->pb_count > pp->pb_count_max)
1562 {
1563 ptr_block_error = TRUE;
1564 pp->pb_count = pp->pb_count_max;
1565 }
1566 if (ptr_block_error)
1567 emsg(_(e_warning_pointer_block_corrupted));
1568
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001569 // check line count when using pointer block first time
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 if (idx == 0 && line_count != 0)
1571 {
1572 for (i = 0; i < (int)pp->pb_count; ++i)
1573 line_count -= pp->pb_pointer[i].pe_line_count;
1574 if (line_count != 0)
1575 {
1576 ++error;
1577 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1578 (colnr_T)0, TRUE);
1579 }
1580 }
1581
1582 if (pp->pb_count == 0)
1583 {
1584 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1585 (colnr_T)0, TRUE);
1586 ++error;
1587 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001588 else if (idx < (int)pp->pb_count) // go a block deeper
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 {
1590 if (pp->pb_pointer[idx].pe_bnum < 0)
1591 {
1592 /*
1593 * Data block with negative block number.
1594 * Try to read lines from the original file.
1595 * This is slow, but it works.
1596 */
1597 if (!cannot_open)
1598 {
1599 line_count = pp->pb_pointer[idx].pe_line_count;
1600 if (readfile(curbuf->b_ffname, NULL, lnum,
1601 pp->pb_pointer[idx].pe_old_lnum - 1,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001602 line_count, NULL, 0) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 cannot_open = TRUE;
1604 else
1605 lnum += line_count;
1606 }
1607 if (cannot_open)
1608 {
1609 ++error;
1610 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1611 (colnr_T)0, TRUE);
1612 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001613 ++idx; // get same block again for next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 continue;
1615 }
1616
1617 /*
1618 * going one block deeper in the tree
1619 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001620 if ((top = ml_add_stack(buf)) < 0) // new entry in stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 {
1622 ++error;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001623 break; // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 }
1625 ip = &(buf->b_ml.ml_stack[top]);
1626 ip->ip_bnum = bnum;
1627 ip->ip_index = idx;
1628
1629 bnum = pp->pb_pointer[idx].pe_bnum;
1630 line_count = pp->pb_pointer[idx].pe_line_count;
1631 page_count = pp->pb_pointer[idx].pe_page_count;
Bram Moolenaar986a0032011-06-13 01:07:27 +02001632 idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 continue;
1634 }
1635 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001636 else // not a pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 {
1638 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001639 if (dp->db_id != DATA_ID) // block id wrong
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 {
1641 if (bnum == 1)
1642 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00001643 semsg(_(e_block_one_id_wrong_str_not_swp_file),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 mfp->mf_fname);
1645 goto theend;
1646 }
1647 ++error;
1648 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1649 (colnr_T)0, TRUE);
1650 }
1651 else
1652 {
1653 /*
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001654 * It is a data block.
1655 * Append all the lines in this block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 */
1657 has_error = FALSE;
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001658
1659 // Check the length of the block.
1660 // If wrong, use the length given in the pointer block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1662 {
1663 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1664 (colnr_T)0, TRUE);
1665 ++error;
1666 has_error = TRUE;
1667 dp->db_txt_end = page_count * mfp->mf_page_size;
1668 }
1669
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001670 // Make sure there is a NUL at the end of the block so we
1671 // don't go over the end when copying text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1673
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001674 // Check the number of lines in the block.
1675 // If wrong, use the count in the data block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 if (line_count != dp->db_line_count)
1677 {
1678 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1679 (colnr_T)0, TRUE);
1680 ++error;
1681 has_error = TRUE;
1682 }
1683
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001684 int did_questions = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 for (i = 0; i < dp->db_line_count; ++i)
1686 {
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001687 if ((char_u *)&(dp->db_index[i])
1688 >= (char_u *)dp + dp->db_txt_start)
1689 {
1690 // line count must be wrong
1691 ++error;
1692 ml_append(lnum++,
1693 (char_u *)_("??? lines may be missing"),
1694 (colnr_T)0, TRUE);
1695 break;
1696 }
1697
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
Bram Moolenaar740885b2009-11-03 14:33:17 +00001699 if (txt_start <= (int)HEADER_SIZE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 || txt_start >= (int)dp->db_txt_end)
1701 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 ++error;
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001703 // avoid lots of lines with "???"
1704 if (did_questions)
1705 continue;
1706 did_questions = TRUE;
1707 p = (char_u *)"???";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 }
1709 else
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001710 {
1711 did_questions = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 p = (char_u *)dp + txt_start;
Bram Moolenaarbf1b7132023-04-27 21:13:12 +01001713 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 ml_append(lnum++, p, (colnr_T)0, TRUE);
1715 }
1716 if (has_error)
Bram Moolenaar740885b2009-11-03 14:33:17 +00001717 ml_append(lnum++, (char_u *)_("???END"),
1718 (colnr_T)0, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 }
1720 }
1721 }
1722
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001723 if (buf->b_ml.ml_stack_top == 0) // finished
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 break;
1725
1726 /*
1727 * go one block up in the tree
1728 */
1729 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1730 bnum = ip->ip_bnum;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001731 idx = ip->ip_index + 1; // go to next index
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 page_count = 1;
1733 }
1734
1735 /*
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001736 * Compare the buffer contents with the original file. When they differ
1737 * set the 'modified' flag.
1738 * Lines 1 - lnum are the new contents.
1739 * Lines lnum + 1 to ml_line_count are the original contents.
1740 * Line ml_line_count + 1 in the dummy empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 */
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001742 if (orig_file_status != OK || curbuf->b_ml.ml_line_count != lnum * 2 + 1)
1743 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001744 // Recovering an empty file results in two lines and the first line is
1745 // empty. Don't set the modified flag then.
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001746 if (!(curbuf->b_ml.ml_line_count == 2 && *ml_get(1) == NUL))
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 }
1751 }
1752 else
1753 {
1754 for (idx = 1; idx <= lnum; ++idx)
1755 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001756 // Need to copy one line, fetching the other one may flush it.
John Marriott02d7a6c2024-02-26 21:21:17 +01001757 p = vim_strnsave(ml_get(idx), ml_get_len(idx));
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001758 i = STRCMP(p, ml_get(idx + lnum));
1759 vim_free(p);
1760 if (i != 0)
1761 {
Bram Moolenaarec28d152019-05-11 18:36:34 +02001762 changed_internal();
Bram Moolenaar95c526e2017-02-25 14:59:34 +01001763 ++CHANGEDTICK(curbuf);
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001764 break;
1765 }
1766 }
1767 }
1768
1769 /*
1770 * Delete the lines from the original file and the dummy line from the
1771 * empty buffer. These will now be after the last line in the buffer.
1772 */
1773 while (curbuf->b_ml.ml_line_count > lnum
1774 && !(curbuf->b_ml.ml_flags & ML_EMPTY))
Bram Moolenaarca70c072020-05-30 20:30:46 +02001775 ml_delete(curbuf->b_ml.ml_line_count);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 curbuf->b_flags |= BF_RECOVERED;
Bram Moolenaare3f50ad2021-06-09 12:33:40 +02001777 check_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
1779 recoverymode = FALSE;
1780 if (got_int)
Bram Moolenaareaaac012022-01-02 17:00:40 +00001781 emsg(_(e_recovery_interrupted));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 else if (error)
1783 {
1784 ++no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001785 msg(">>>>>>>>>>>>>");
Bram Moolenaareaaac012022-01-02 17:00:40 +00001786 emsg(_(e_errors_detected_while_recovering_look_for_lines_starting_with_questions));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 --no_wait_return;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001788 msg(_("See \":help E312\" for more information."));
1789 msg(">>>>>>>>>>>>>");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 }
1791 else
1792 {
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001793 if (curbuf->b_changed)
1794 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001795 msg(_("Recovery completed. You should check if everything is OK."));
1796 msg_puts(_("\n(You might want to write out this file under another name\n"));
1797 msg_puts(_("and run diff with the original file to check for changes)"));
Bram Moolenaarfc2d5bd2010-05-15 17:06:53 +02001798 }
1799 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001800 msg(_("Recovery completed. Buffer contents equals file contents."));
Bram Moolenaarf8835082020-11-09 21:04:17 +01001801 msg_puts(_("\nYou may want to delete the .swp file now."));
1802#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01001803 if (swapfile_process_running(b0p, fname_used))
Bram Moolenaarf8835082020-11-09 21:04:17 +01001804 {
1805 // Warn there could be an active Vim on the same file, the user may
1806 // want to kill it.
1807 msg_puts(_("\nNote: process STILL RUNNING: "));
1808 msg_outnum(char_to_long(b0p->b0_pid));
1809 }
1810#endif
1811 msg_puts("\n\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 cmdline_row = msg_row;
1813 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001814#ifdef FEAT_CRYPT
1815 if (*buf->b_p_key != NUL && STRCMP(curbuf->b_p_key, buf->b_p_key) != 0)
1816 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001817 msg_puts(_("Using crypt key from swap file for the text file.\n"));
Bram Moolenaar31e5c602022-04-15 13:53:33 +01001818 set_option_value_give_err((char_u *)"key", 0L, buf->b_p_key, OPT_LOCAL);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001819 }
1820#endif
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001821 redraw_curbuf_later(UPD_NOT_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822
1823theend:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001824 vim_free(fname_used);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 recoverymode = FALSE;
1826 if (mfp != NULL)
1827 {
1828 if (hp != NULL)
1829 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001830 mf_close(mfp, FALSE); // will also vim_free(mfp->mf_fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 }
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001832 if (buf != NULL)
1833 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001834#ifdef FEAT_CRYPT
1835 if (buf->b_p_key != curbuf->b_p_key)
1836 free_string_option(buf->b_p_key);
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02001837 free_string_option(buf->b_p_cm);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001838#endif
Bram Moolenaardf88dda2007-01-09 13:34:50 +00001839 vim_free(buf->b_ml.ml_stack);
1840 vim_free(buf);
1841 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 if (serious_error && called_from_main)
1843 ml_close(curbuf, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 else
1845 {
1846 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1847 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1848 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849}
1850
1851/*
1852 * Find the names of swap files in current directory and the directory given
1853 * with the 'directory' option.
1854 *
1855 * Used to:
1856 * - list the swap files for "vim -r"
1857 * - count the number of swap files when recovering
1858 * - list the swap files when recovering
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001859 * - list the swap files for swapfilelist()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 * - find the name of the n'th swap file when recovering
1861 */
1862 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001863recover_names(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001864 char_u *fname, // base for swap file name
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001865 int do_list, // when TRUE, list the swap file names
1866 list_T *ret_list UNUSED, // when not NULL add file names to it
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001867 int nr, // when non-zero, return nr'th swap file name
1868 char_u **fname_out) // result when "nr" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869{
1870 int num_names;
1871 char_u *(names[6]);
1872 char_u *tail;
1873 char_u *p;
1874 int num_files;
1875 int file_count = 0;
1876 char_u **files;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 char_u *dirp;
1878 char_u *dir_name;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001879 char_u *fname_res = NULL;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001880#ifdef HAVE_READLINK
1881 char_u fname_buf[MAXPATHL];
Bram Moolenaar64354da2010-05-25 21:37:17 +02001882#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001883
Bram Moolenaar64354da2010-05-25 21:37:17 +02001884 if (fname != NULL)
1885 {
1886#ifdef HAVE_READLINK
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001887 // Expand symlink in the file name, because the swap file is created
1888 // with the actual file instead of with the symlink.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001889 if (resolve_symlink(fname, fname_buf) == OK)
1890 fname_res = fname_buf;
1891 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001892#endif
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001893 fname_res = fname;
Bram Moolenaar64354da2010-05-25 21:37:17 +02001894 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001896 if (do_list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001898 // use msg() to start the scrolling properly
Bram Moolenaar32526b32019-01-19 17:43:09 +01001899 msg(_("Swap files found:"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 msg_putchar('\n');
1901 }
1902
1903 /*
1904 * Do the loop for every directory in 'directory'.
1905 * First allocate some memory to put the directory name in.
1906 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02001907 dir_name = alloc(STRLEN(p_dir) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 dirp = p_dir;
1909 while (dir_name != NULL && *dirp)
1910 {
1911 /*
1912 * Isolate a directory name from *dirp and put it in dir_name (we know
1913 * it is large enough, so use 31000 for length).
1914 * Advance dirp to next directory name.
1915 */
1916 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1917
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001918 if (dir_name[0] == '.' && dir_name[1] == NUL) // check current dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001920 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 {
1922#ifdef VMS
1923 names[0] = vim_strsave((char_u *)"*_sw%");
1924#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 names[0] = vim_strsave((char_u *)"*.sw?");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001927#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001928 // For Unix names starting with a dot are special. MS-Windows
1929 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 names[1] = vim_strsave((char_u *)".*.sw?");
1931 names[2] = vim_strsave((char_u *)".sw?");
1932 num_names = 3;
1933#else
1934# ifdef VMS
1935 names[1] = vim_strsave((char_u *)".*_sw%");
1936 num_names = 2;
1937# else
1938 num_names = 1;
1939# endif
1940#endif
1941 }
1942 else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001943 num_names = recov_file_names(names, fname_res, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001945 else // check directory dir_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001947 if (fname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 {
1949#ifdef VMS
1950 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1951#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001954#if defined(UNIX) || defined(MSWIN)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001955 // For Unix names starting with a dot are special. MS-Windows
1956 // supports this too, on some file systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1958 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1959 num_names = 3;
1960#else
1961# ifdef VMS
1962 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1963 num_names = 2;
1964# else
1965 num_names = 1;
1966# endif
1967#endif
1968 }
1969 else
1970 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01001971#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01001972 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01001973
1974 p = dir_name + len;
1975 if (after_pathsep(dir_name, p) && len > 1 && p[-1] == p[-2])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01001977 // Ends with '//', Use Full path for swap name
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001978 tail = make_percent_swname(dir_name, fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 }
1980 else
1981#endif
1982 {
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02001983 tail = gettail(fname_res);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 tail = concat_fnames(dir_name, tail, TRUE);
1985 }
1986 if (tail == NULL)
1987 num_names = 0;
1988 else
1989 {
1990 num_names = recov_file_names(names, tail, FALSE);
1991 vim_free(tail);
1992 }
1993 }
1994 }
1995
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02001996 // check for out-of-memory
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00001997 for (int i = 0; i < num_names; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998 {
1999 if (names[i] == NULL)
2000 {
2001 for (i = 0; i < num_names; ++i)
2002 vim_free(names[i]);
2003 num_names = 0;
2004 }
2005 }
2006 if (num_names == 0)
2007 num_files = 0;
2008 else if (expand_wildcards(num_names, names, &num_files, &files,
Bram Moolenaar99499b12019-05-23 21:35:48 +02002009 EW_NOTENV|EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 num_files = 0;
2011
2012 /*
2013 * When no swap file found, wildcard expansion might have failed (e.g.
2014 * not able to execute the shell).
2015 * Try finding a swap file by simply adding ".swp" to the file name.
2016 */
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002017 if (*dirp == NUL && file_count + num_files == 0 && fname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 {
Bram Moolenaar8767f522016-07-01 17:17:39 +02002019 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 char_u *swapname;
2021
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002022 swapname = modname(fname_res,
Bram Moolenaare60acc12011-05-10 16:41:25 +02002023#if defined(VMS)
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002024 (char_u *)"_swp", FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025#else
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002026 (char_u *)".swp", TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027#endif
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02002028 );
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 if (swapname != NULL)
2030 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002031 if (mch_stat((char *)swapname, &st) != -1) // It exists!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002033 files = ALLOC_ONE(char_u *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 if (files != NULL)
2035 {
2036 files[0] = swapname;
2037 swapname = NULL;
2038 num_files = 1;
2039 }
2040 }
2041 vim_free(swapname);
2042 }
2043 }
2044
2045 /*
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002046 * Remove swapfile name of the current buffer, it must be ignored.
2047 * But keep it for swapfilelist().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 */
2049 if (curbuf->b_ml.ml_mfp != NULL
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002050 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL
2051 && ret_list == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 {
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002053 for (int i = 0; i < num_files; ++i)
Bram Moolenaar99499b12019-05-23 21:35:48 +02002054 // Do not expand wildcards, on windows would try to expand
2055 // "%tmp%" in "%tmp%file".
2056 if (fullpathcmp(p, files[i], TRUE, FALSE) & FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 {
Bram Moolenaar99499b12019-05-23 21:35:48 +02002058 // Remove the name from files[i]. Move further entries
2059 // down. When the array becomes empty free it here, since
2060 // FreeWild() won't be called below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 vim_free(files[i]);
Bram Moolenaar9439cdd2009-04-22 13:39:36 +00002062 if (--num_files == 0)
2063 vim_free(files);
2064 else
2065 for ( ; i < num_files; ++i)
2066 files[i] = files[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 }
2068 }
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002069 if (nr > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 {
2071 file_count += num_files;
2072 if (nr <= file_count)
2073 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002074 *fname_out = vim_strsave(
2075 files[nr - 1 + num_files - file_count]);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002076 dirp = (char_u *)""; // stop searching
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 }
2078 }
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002079 else if (do_list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 {
2081 if (dir_name[0] == '.' && dir_name[1] == NUL)
2082 {
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002083 if (fname == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002084 msg_puts(_(" In current directory:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002086 msg_puts(_(" Using specified name:\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 }
2088 else
2089 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002090 msg_puts(_(" In directory "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 msg_home_replace(dir_name);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002092 msg_puts(":\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 }
2094
2095 if (num_files)
2096 {
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002097 for (int i = 0; i < num_files; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002099 // print the swap file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 msg_outnum((long)++file_count);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002101 msg_puts(". ");
2102 msg_puts((char *)gettail(files[i]));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 msg_putchar('\n');
2104 (void)swapfile_info(files[i]);
2105 }
2106 }
2107 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002108 msg_puts(_(" -- none --\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 out_flush();
2110 }
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002111#ifdef FEAT_EVAL
2112 else if (ret_list != NULL)
2113 {
2114 for (int i = 0; i < num_files; ++i)
2115 {
2116 char_u *name = concat_fnames(dir_name, files[i], TRUE);
2117 if (name != NULL)
2118 {
2119 list_append_string(ret_list, name, -1);
2120 vim_free(name);
2121 }
2122 }
2123 }
2124#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 else
2126 file_count += num_files;
2127
Bram Moolenaarc216a7a2022-12-05 13:50:55 +00002128 for (int i = 0; i < num_names; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 vim_free(names[i]);
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002130 if (num_files > 0)
2131 FreeWild(num_files, files);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 }
2133 vim_free(dir_name);
2134 return file_count;
2135}
2136
Bram Moolenaar4f974752019-02-17 17:44:42 +01002137#if defined(UNIX) || defined(MSWIN) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138/*
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002139 * Need _very_ long file names.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 * Append the full path to name with path separators made into percent
Bram Moolenaar8b0e62c2021-10-19 22:12:25 +01002141 * signs, to "dir". An unnamed buffer is handled as "" (<currentdir>/"")
2142 * The last character in "dir" must be an extra slash or backslash, it is
2143 * removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 */
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002145 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002146make_percent_swname(char_u *dir, char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147{
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002148 char_u *d = NULL, *s, *f;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002150 f = fix_fname(name != NULL ? name : (char_u *)"");
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00002151 if (f == NULL)
2152 return NULL;
Bram Moolenaar8b0e62c2021-10-19 22:12:25 +01002153
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00002154 s = alloc(STRLEN(f) + 1);
2155 if (s != NULL)
2156 {
2157 STRCPY(s, f);
2158 for (d = s; *d != NUL; MB_PTR_ADV(d))
2159 if (vim_ispathsep(*d))
2160 *d = '%';
2161
2162 dir[STRLEN(dir) - 1] = NUL; // remove one trailing slash
2163 d = concat_fnames(dir, s, TRUE);
2164 vim_free(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 }
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00002166 vim_free(f);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 return d;
2168}
2169#endif
2170
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002171#if (defined(UNIX) || defined(VMS) || defined(MSWIN)) \
2172 && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
2173# define HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174static int process_still_running;
2175#endif
2176
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002177#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178/*
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002179 * Return information found in swapfile "fname" in dictionary "d".
2180 * This is used by the swapinfo() function.
2181 */
2182 void
2183get_b0_dict(char_u *fname, dict_T *d)
2184{
2185 int fd;
2186 struct block0 b0;
2187
2188 if ((fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
2189 {
2190 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
2191 {
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002192 if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002193 dict_add_string(d, "error", (char_u *)"Not a swap file");
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002194 else if (b0_magic_wrong(&b0))
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002195 dict_add_string(d, "error", (char_u *)"Magic number mismatch");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002196 else
2197 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002198 // we have swap information
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002199 dict_add_string_len(d, "version", b0.b0_version, 10);
2200 dict_add_string_len(d, "user", b0.b0_uname, B0_UNAME_SIZE);
2201 dict_add_string_len(d, "host", b0.b0_hname, B0_HNAME_SIZE);
2202 dict_add_string_len(d, "fname", b0.b0_fname, B0_FNAME_SIZE_ORG);
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002203
2204 dict_add_number(d, "pid", char_to_long(b0.b0_pid));
2205 dict_add_number(d, "mtime", char_to_long(b0.b0_mtime));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002206 dict_add_number(d, "dirty", b0.b0_dirty ? 1 : 0);
2207# ifdef CHECK_INODE
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002208 dict_add_number(d, "inode", char_to_long(b0.b0_ino));
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002209# endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002210 }
2211 }
2212 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002213 dict_add_string(d, "error", (char_u *)"Cannot read file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002214 close(fd);
2215 }
2216 else
Bram Moolenaare6fdf792018-12-26 22:57:42 +01002217 dict_add_string(d, "error", (char_u *)"Cannot open file");
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002218}
Bram Moolenaar47ad5652018-08-21 21:09:07 +02002219#endif
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002220
2221/*
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00002222 * Give information about an existing swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 * Returns timestamp (0 when unknown).
2224 */
2225 static time_t
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002226swapfile_info(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002228 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 int fd;
2230 struct block0 b0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231#ifdef UNIX
2232 char_u uname[B0_UNAME_SIZE];
2233#endif
2234
Bram Moolenaar63d25552019-05-10 21:28:38 +02002235 // print the swap file date
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 if (mch_stat((char *)fname, &st) != -1)
2237 {
2238#ifdef UNIX
Bram Moolenaar63d25552019-05-10 21:28:38 +02002239 // print name of owner of the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
2241 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002242 msg_puts(_(" owned by: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 msg_outtrans(uname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002244 msg_puts(_(" dated: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 }
2246 else
2247#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002248 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02002249 msg_puts(get_ctime(st.st_mtime, TRUE));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 }
Bram Moolenaar63d25552019-05-10 21:28:38 +02002251 else
2252 st.st_mtime = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253
2254 /*
2255 * print the original file name
2256 */
2257 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2258 if (fd >= 0)
2259 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01002260 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 {
2262 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
2263 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002264 msg_puts(_(" [from Vim version 3.0]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 }
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02002266 else if (ml_check_b0_id(&b0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002268 msg_puts(_(" [does not look like a Vim swap file]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 }
2270 else
2271 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002272 msg_puts(_(" file name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 if (b0.b0_fname[0] == NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002274 msg_puts(_("[No Name]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 else
2276 msg_outtrans(b0.b0_fname);
2277
Bram Moolenaar32526b32019-01-19 17:43:09 +01002278 msg_puts(_("\n modified: "));
2279 msg_puts(b0.b0_dirty ? _("YES") : _("no"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280
2281 if (*(b0.b0_uname) != NUL)
2282 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002283 msg_puts(_("\n user name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 msg_outtrans(b0.b0_uname);
2285 }
2286
2287 if (*(b0.b0_hname) != NUL)
2288 {
2289 if (*(b0.b0_uname) != NUL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002290 msg_puts(_(" host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002292 msg_puts(_("\n host name: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 msg_outtrans(b0.b0_hname);
2294 }
2295
2296 if (char_to_long(b0.b0_pid) != 0L)
2297 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002298 msg_puts(_("\n process ID: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 msg_outnum(char_to_long(b0.b0_pid));
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002300#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf52f0602021-03-10 21:26:37 +01002301 if (swapfile_process_running(&b0, fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002303 msg_puts(_(" (STILL RUNNING)"));
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02002304# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 process_still_running = TRUE;
2306# endif
2307 }
2308#endif
2309 }
2310
2311 if (b0_magic_wrong(&b0))
2312 {
Bram Moolenaar48e330a2016-02-23 14:53:34 +01002313#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002315 msg_puts(_("\n [not usable with this version of Vim]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 else
2317#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01002318 msg_puts(_("\n [not usable on this computer]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 }
2320 }
2321 }
2322 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002323 msg_puts(_(" [cannot be read]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 close(fd);
2325 }
2326 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002327 msg_puts(_(" [cannot be opened]"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 msg_putchar('\n');
2329
Bram Moolenaar63d25552019-05-10 21:28:38 +02002330 return st.st_mtime;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331}
2332
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002333/*
2334 * Return TRUE if the swap file looks OK and there are no changes, thus it can
2335 * be safely deleted.
2336 */
zeertzjq3c5999e2022-03-23 13:54:51 +00002337 static int
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002338swapfile_unchanged(char_u *fname)
2339{
2340 stat_T st;
2341 int fd;
2342 struct block0 b0;
2343 int ret = TRUE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002344
2345 // must be able to stat the swap file
2346 if (mch_stat((char *)fname, &st) == -1)
2347 return FALSE;
2348
2349 // must be able to read the first block
2350 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2351 if (fd < 0)
2352 return FALSE;
2353 if (read_eintr(fd, &b0, sizeof(b0)) != sizeof(b0))
2354 {
2355 close(fd);
2356 return FALSE;
2357 }
2358
2359 // the ID and magic number must be correct
2360 if (ml_check_b0_id(&b0) == FAIL|| b0_magic_wrong(&b0))
2361 ret = FALSE;
2362
2363 // must be unchanged
2364 if (b0.b0_dirty)
2365 ret = FALSE;
2366
2367#if defined(UNIX) || defined(MSWIN)
Bram Moolenaarf8835082020-11-09 21:04:17 +01002368 // Host name must be known and must equal the current host name, otherwise
2369 // comparing pid is meaningless.
2370 if (*(b0.b0_hname) == NUL)
2371 {
2372 ret = FALSE;
2373 }
2374 else
2375 {
2376 char_u hostname[B0_HNAME_SIZE];
2377
2378 mch_get_host_name(hostname, B0_HNAME_SIZE);
2379 hostname[B0_HNAME_SIZE - 1] = NUL;
Bram Moolenaare79cdb62020-11-21 13:51:16 +01002380 b0.b0_hname[B0_HNAME_SIZE - 1] = NUL; // in case of corruption
Bram Moolenaarf8835082020-11-09 21:04:17 +01002381 if (STRICMP(b0.b0_hname, hostname) != 0)
2382 ret = FALSE;
2383 }
2384
Bram Moolenaar32aa1022019-11-02 22:54:41 +01002385 // process must be known and not be running
Bram Moolenaarf52f0602021-03-10 21:26:37 +01002386 if (char_to_long(b0.b0_pid) == 0L || swapfile_process_running(&b0, fname))
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002387 ret = FALSE;
2388#endif
2389
Bram Moolenaarf8835082020-11-09 21:04:17 +01002390 // We do not check the user, it should be irrelevant for whether the swap
2391 // file is still useful.
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02002392
2393 close(fd);
2394 return ret;
2395}
2396
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002398recov_file_names(char_u **names, char_u *path, int prepend_dot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399{
2400 int num_names;
2401
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 /*
2403 * (Win32 and Win64) never short names, but do prepend a dot.
2404 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
2405 * Only use the short name if it is different.
2406 */
2407 char_u *p;
2408 int i;
Bram Moolenaar4f974752019-02-17 17:44:42 +01002409# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 int shortname = curbuf->b_shortname;
2411
2412 curbuf->b_shortname = FALSE;
2413# endif
2414
2415 num_names = 0;
2416
2417 /*
2418 * May also add the file name with a dot prepended, for swap file in same
2419 * dir as original file.
2420 */
2421 if (prepend_dot)
2422 {
2423 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
2424 if (names[num_names] == NULL)
2425 goto end;
2426 ++num_names;
2427 }
2428
2429 /*
2430 * Form the normal swap file name pattern by appending ".sw?".
2431 */
2432#ifdef VMS
2433 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
2434#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436#endif
2437 if (names[num_names] == NULL)
2438 goto end;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002439 if (num_names >= 1) // check if we have the same name twice
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 {
2441 p = names[num_names - 1];
2442 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
2443 if (i > 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002444 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445
2446 if (STRCMP(p, names[num_names]) != 0)
2447 ++num_names;
2448 else
2449 vim_free(names[num_names]);
2450 }
2451 else
2452 ++num_names;
2453
Bram Moolenaar4f974752019-02-17 17:44:42 +01002454# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 /*
2456 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
2457 */
2458 curbuf->b_shortname = TRUE;
2459#ifdef VMS
2460 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
2461#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463#endif
2464 if (names[num_names] == NULL)
2465 goto end;
2466
2467 /*
2468 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
2469 */
2470 p = names[num_names];
2471 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
2472 if (i > 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002473 p += i; // file name has been expanded to full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 if (STRCMP(names[num_names - 1], p) == 0)
2475 vim_free(names[num_names]);
2476 else
2477 ++num_names;
2478# endif
2479
2480end:
Bram Moolenaar4f974752019-02-17 17:44:42 +01002481# ifndef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 curbuf->b_shortname = shortname;
2483# endif
2484
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 return num_names;
2486}
2487
2488/*
2489 * sync all memlines
2490 *
2491 * If 'check_file' is TRUE, check if original file exists and was not changed.
2492 * If 'check_char' is TRUE, stop syncing when character becomes available, but
2493 * always sync at least one block.
2494 */
2495 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002496ml_sync_all(int check_file, int check_char)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497{
2498 buf_T *buf;
Bram Moolenaar8767f522016-07-01 17:17:39 +02002499 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500
Bram Moolenaar29323592016-07-24 22:04:11 +02002501 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 {
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002503 if (buf->b_ml.ml_mfp == NULL
2504 || buf->b_ml.ml_mfp->mf_fname == NULL
2505 || buf->b_ml.ml_mfp->mf_fd < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002506 continue; // no file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507
Christian Brabandt19e6c4f2023-06-27 18:57:10 +01002508#ifdef FEAT_CRYPT
2509 if (crypt_may_close_swapfile(buf, buf->b_p_key,
2510 crypt_get_method_nr(buf)))
2511 continue;
2512#endif
2513
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002514 ml_flush_line(buf); // flush buffered line
2515 // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
2517 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
2518 && buf->b_ffname != NULL)
2519 {
2520 /*
2521 * If the original file does not exist anymore or has been changed
2522 * call ml_preserve() to get rid of all negative numbered blocks.
2523 */
2524 if (mch_stat((char *)buf->b_ffname, &st) == -1
2525 || st.st_mtime != buf->b_mtime_read
Leah Neukirchen0a7984a2021-10-14 21:27:55 +01002526#ifdef ST_MTIM_NSEC
2527 || st.ST_MTIM_NSEC != buf->b_mtime_read_ns
2528#endif
Bram Moolenaar914703b2010-05-31 21:59:46 +02002529 || st.st_size != buf->b_orig_size)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 {
2531 ml_preserve(buf, FALSE);
2532 did_check_timestamps = FALSE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002533 need_check_timestamps = TRUE; // give message later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 }
2535 }
Bram Moolenaar3a2a60c2023-05-27 18:02:55 +01002536 if (buf->b_ml.ml_mfp->mf_dirty == MF_DIRTY_YES)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 {
2538 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
2539 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002540 if (check_char && ui_char_avail()) // character available now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 break;
2542 }
2543 }
2544}
2545
2546/*
2547 * sync one buffer, including negative blocks
2548 *
2549 * after this all the blocks are in the swap file
2550 *
2551 * Used for the :preserve command and when the original file has been
2552 * changed or deleted.
2553 *
2554 * when message is TRUE the success of preserving is reported
2555 */
2556 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002557ml_preserve(buf_T *buf, int message)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558{
2559 bhdr_T *hp;
2560 linenr_T lnum;
2561 memfile_T *mfp = buf->b_ml.ml_mfp;
2562 int status;
2563 int got_int_save = got_int;
2564
2565 if (mfp == NULL || mfp->mf_fname == NULL)
2566 {
2567 if (message)
Bram Moolenaareaaac012022-01-02 17:00:40 +00002568 emsg(_(e_cannot_preserve_there_is_no_swap_file));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 return;
2570 }
Christian Brabandt19e6c4f2023-06-27 18:57:10 +01002571#ifdef FEAT_CRYPT
2572 if (crypt_may_close_swapfile(buf, buf->b_p_key, crypt_get_method_nr(buf)))
2573 return;
2574#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002576 // We only want to stop when interrupted here, not when interrupted
2577 // before.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 got_int = FALSE;
2579
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002580 ml_flush_line(buf); // flush buffered line
2581 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2583
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002584 // stack is invalid after mf_sync(.., MFS_ALL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 buf->b_ml.ml_stack_top = 0;
2586
2587 /*
2588 * Some of the data blocks may have been changed from negative to
2589 * positive block number. In that case the pointer blocks need to be
2590 * updated.
2591 *
2592 * We don't know in which pointer block the references are, so we visit
2593 * all data blocks until there are no more translations to be done (or
2594 * we hit the end of the file, which can only happen in case a write fails,
2595 * e.g. when file system if full).
2596 * ml_find_line() does the work by translating the negative block numbers
2597 * when getting the first line of each data block.
2598 */
2599 if (mf_need_trans(mfp) && !got_int)
2600 {
2601 lnum = 1;
2602 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2603 {
2604 hp = ml_find_line(buf, lnum, ML_FIND);
2605 if (hp == NULL)
2606 {
2607 status = FAIL;
2608 goto theend;
2609 }
2610 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2611 lnum = buf->b_ml.ml_locked_high + 1;
2612 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002613 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush locked block
2614 // sync the updated pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2616 status = FAIL;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002617 buf->b_ml.ml_stack_top = 0; // stack is invalid now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 }
2619theend:
2620 got_int |= got_int_save;
2621
2622 if (message)
2623 {
2624 if (status == OK)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002625 msg(_("File preserved"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 else
Bram Moolenaareaaac012022-01-02 17:00:40 +00002627 emsg(_(e_preserve_failed));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 }
2629}
2630
2631/*
2632 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2633 * until the next call!
2634 * line1 = ml_get(1);
2635 * line2 = ml_get(2); // line1 is now invalid!
2636 * Make a copy of the line if necessary.
2637 */
2638/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002639 * Return a pointer to a (read-only copy of a) line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 *
2641 * On failure an error message is given and IObuff is returned (to avoid
2642 * having to check for error everywhere).
2643 */
2644 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002645ml_get(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646{
2647 return ml_get_buf(curbuf, lnum, FALSE);
2648}
2649
2650/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002651 * Return pointer to position "pos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 */
2653 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002654ml_get_pos(pos_T *pos)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655{
2656 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2657}
2658
2659/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002660 * Return pointer to cursor line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 */
2662 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002663ml_get_curline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664{
2665 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2666}
2667
2668/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002669 * Return pointer to cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 */
2671 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002672ml_get_cursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673{
2674 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2675 curwin->w_cursor.col);
2676}
2677
John Marriott02d7a6c2024-02-26 21:21:17 +01002678// return length (excluding the NUL) of the given line
2679 colnr_T
2680ml_get_len(linenr_T lnum)
2681{
2682 return ml_get_buf_len(curbuf, lnum);
2683}
2684
2685// return length (excluding the NUL) of the cursor line
2686 colnr_T
2687ml_get_curline_len(void)
2688{
2689 return ml_get_buf_len(curbuf, curwin->w_cursor.lnum);
2690}
2691
2692// return length (excluding the NUL) of the cursor position
2693 colnr_T
2694ml_get_cursor_len(void)
2695{
2696 return ml_get_buf_len(curbuf, curwin->w_cursor.lnum) - curwin->w_cursor.col;
2697}
2698
2699// return length (excluding the NUL) of the given line in the given buffer
2700 colnr_T
2701ml_get_buf_len(buf_T *buf, linenr_T lnum)
2702{
2703 if (*ml_get_buf(buf, lnum, FALSE) == NUL)
2704 return 0;
2705
2706 return buf->b_ml.ml_line_len - 1;
2707}
2708
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709/*
Bram Moolenaar2e2e13c2010-12-08 13:17:03 +01002710 * Return a pointer to a line in a specific buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 *
2712 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2713 * changed)
2714 */
2715 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002716ml_get_buf(
2717 buf_T *buf,
2718 linenr_T lnum,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002719 int will_change) // line will be changed
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720{
Bram Moolenaarad40f022007-02-13 03:01:39 +00002721 bhdr_T *hp;
2722 DATA_BL *dp;
Bram Moolenaarad40f022007-02-13 03:01:39 +00002723 static int recursive = 0;
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002724 static char_u questions[4];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002726 if (lnum > buf->b_ml.ml_line_count) // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002728 if (recursive == 0)
2729 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002730 // Avoid giving this message for a recursive call, may happen when
2731 // the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002732 ++recursive;
RestorerZ68ebcee2023-05-31 17:12:14 +01002733 siemsg(e_ml_get_invalid_lnum_nr, lnum);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002734 --recursive;
2735 }
Bram Moolenaarf9435e42022-02-16 16:33:28 +00002736 ml_flush_line(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737errorret:
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002738 STRCPY(questions, "???");
Bram Moolenaaradfde112019-05-25 22:11:45 +02002739 buf->b_ml.ml_line_len = 4;
Bram Moolenaarf9435e42022-02-16 16:33:28 +00002740 buf->b_ml.ml_line_lnum = lnum;
Bram Moolenaar96e7a592021-11-25 13:52:37 +00002741 return questions;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 }
Bram Moolenaaradfde112019-05-25 22:11:45 +02002743 if (lnum <= 0) // pretend line 0 is line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 lnum = 1;
2745
Bram Moolenaaradfde112019-05-25 22:11:45 +02002746 if (buf->b_ml.ml_mfp == NULL) // there are no lines
2747 {
2748 buf->b_ml.ml_line_len = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 return (char_u *)"";
Bram Moolenaaradfde112019-05-25 22:11:45 +02002750 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751
Bram Moolenaar37d619f2010-03-10 14:46:26 +01002752 /*
2753 * See if it is the same line as requested last time.
2754 * Otherwise may need to flush last used line.
2755 * Don't use the last used line when 'swapfile' is reset, need to load all
2756 * blocks.
2757 */
Bram Moolenaar47b8b152007-02-07 02:41:57 +00002758 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002760 unsigned start, end;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002761 int idx;
2762
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 ml_flush_line(buf);
2764
2765 /*
2766 * Find the data block containing the line.
2767 * This also fills the stack with the blocks from the root to the data
2768 * block and releases any locked block.
2769 */
2770 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2771 {
Bram Moolenaarad40f022007-02-13 03:01:39 +00002772 if (recursive == 0)
2773 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002774 // Avoid giving this message for a recursive call, may happen
2775 // when the GUI redraws part of the text.
Bram Moolenaarad40f022007-02-13 03:01:39 +00002776 ++recursive;
Bram Moolenaarcb868932019-10-26 20:56:21 +02002777 get_trans_bufname(buf);
2778 shorten_dir(NameBuff);
RestorerZ68ebcee2023-05-31 17:12:14 +01002779 siemsg(e_ml_get_cannot_find_line_nr_in_buffer_nr_str,
Bram Moolenaarcb868932019-10-26 20:56:21 +02002780 lnum, buf->b_fnum, NameBuff);
Bram Moolenaarad40f022007-02-13 03:01:39 +00002781 --recursive;
2782 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 goto errorret;
2784 }
2785
2786 dp = (DATA_BL *)(hp->bh_data);
2787
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002788 idx = lnum - buf->b_ml.ml_locked_low;
2789 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2790 // The text ends where the previous line starts. The first line ends
2791 // at the end of the block.
2792 if (idx == 0)
2793 end = dp->db_txt_end;
2794 else
2795 end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002796
2797 buf->b_ml.ml_line_ptr = (char_u *)dp + start;
John Marriott02d7a6c2024-02-26 21:21:17 +01002798 buf->b_ml.ml_line_len = end - start;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 buf->b_ml.ml_line_lnum = lnum;
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002800 buf->b_ml.ml_flags &= ~(ML_LINE_DIRTY | ML_ALLOCATED);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 }
2802 if (will_change)
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002803 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002805#ifdef FEAT_EVAL
2806 if (ml_get_alloc_lines && (buf->b_ml.ml_flags & ML_ALLOCATED))
2807 // can't make the change in the data block
2808 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
2809#endif
2810 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002812#ifdef FEAT_EVAL
2813 if (ml_get_alloc_lines
2814 && (buf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED)) == 0)
2815 {
2816 char_u *p = alloc(buf->b_ml.ml_line_len);
2817
2818 // make sure the text is in allocated memory
2819 if (p != NULL)
2820 {
2821 memmove(p, buf->b_ml.ml_line_ptr, buf->b_ml.ml_line_len);
2822 buf->b_ml.ml_line_ptr = p;
2823 buf->b_ml.ml_flags |= ML_ALLOCATED;
2824 if (will_change)
2825 // can't make the change in the data block
2826 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
2827 }
2828 }
2829#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 return buf->b_ml.ml_line_ptr;
2831}
2832
2833/*
2834 * Check if a line that was just obtained by a call to ml_get
2835 * is in allocated memory.
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002836 * This ignores ML_ALLOCATED to get the same behavior as without the test
2837 * override.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 */
2839 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002840ml_line_alloced(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841{
2842 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2843}
2844
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002845#ifdef FEAT_PROP_POPUP
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002846/*
2847 * Add text properties that continue from the previous line.
2848 */
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002849 static void
2850add_text_props_for_append(
2851 buf_T *buf,
2852 linenr_T lnum,
2853 char_u **line,
2854 int *len,
2855 char_u **tofree)
2856{
2857 int round;
2858 int new_prop_count = 0;
2859 int count;
2860 int n;
2861 char_u *props;
Bram Moolenaarea781452019-09-04 18:53:12 +02002862 int new_len = 0; // init for gcc
Bram Moolenaar8f13d822020-09-12 21:04:23 +02002863 char_u *new_line = NULL;
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002864 textprop_T prop;
2865
2866 // Make two rounds:
2867 // 1. calculate the extra space needed
2868 // 2. allocate the space and fill it
2869 for (round = 1; round <= 2; ++round)
2870 {
2871 if (round == 2)
2872 {
2873 if (new_prop_count == 0)
2874 return; // nothing to do
2875 new_len = *len + new_prop_count * sizeof(textprop_T);
Bram Moolenaar964b3742019-05-24 18:54:09 +02002876 new_line = alloc(new_len);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002877 if (new_line == NULL)
2878 return;
2879 mch_memmove(new_line, *line, *len);
2880 new_prop_count = 0;
2881 }
2882
2883 // Get the line above to find any props that continue in the next
2884 // line.
2885 count = get_text_props(buf, lnum, &props, FALSE);
2886 for (n = 0; n < count; ++n)
2887 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002888 mch_memmove(&prop, props + n * sizeof(textprop_T),
2889 sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002890 if (prop.tp_flags & TP_FLAG_CONT_NEXT)
2891 {
2892 if (round == 2)
2893 {
2894 prop.tp_flags |= TP_FLAG_CONT_PREV;
2895 prop.tp_col = 1;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002896 prop.tp_len = *len; // not exactly the right length
2897 mch_memmove(new_line + *len + new_prop_count
2898 * sizeof(textprop_T), &prop, sizeof(textprop_T));
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002899 }
2900 ++new_prop_count;
2901 }
2902 }
2903 }
2904 *line = new_line;
2905 *tofree = new_line;
2906 *len = new_len;
2907}
2908#endif
2909
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002911ml_append_int(
2912 buf_T *buf,
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002913 linenr_T lnum, // append after this line (can be 0)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002914 char_u *line_arg, // text of the new line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002915 colnr_T len_arg, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02002916 int flags) // ML_APPEND_ flags
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917{
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002918 char_u *line = line_arg;
2919 colnr_T len = len_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 int i;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002921 int line_count; // number of indexes in current block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002922 int offset;
2923 int from, to;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002924 int space_needed; // space needed for new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 int page_size;
2926 int page_count;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002927 int db_idx; // index for lnum in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 bhdr_T *hp;
2929 memfile_T *mfp;
2930 DATA_BL *dp;
2931 PTR_BL *pp;
2932 infoptr_T *ip;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002933#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002934 char_u *tofree = NULL;
Bram Moolenaar50652b02022-08-07 21:48:37 +01002935# ifdef FEAT_BYTEOFF
2936 colnr_T text_len = 0; // text len with NUL without text properties
2937# endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002938#endif
2939 int ret = FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002942 return FAIL; // lnum out of range
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943
2944 if (lowest_marked && lowest_marked > lnum)
2945 lowest_marked = lnum + 1;
2946
2947 if (len == 0)
Bram Moolenaar50652b02022-08-07 21:48:37 +01002948 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002949 len = (colnr_T)STRLEN(line) + 1; // space needed for the text
Bram Moolenaar50652b02022-08-07 21:48:37 +01002950#if defined(FEAT_PROP_POPUP) && defined(FEAT_BYTEOFF)
2951 text_len = len;
2952#endif
2953 }
2954#if defined(FEAT_PROP_POPUP) && defined(FEAT_BYTEOFF)
2955 else if (curbuf->b_has_textprop)
2956 // "len" may include text properties, get the length of the text.
2957 text_len = (colnr_T)STRLEN(line) + 1;
2958 else
2959 text_len = len;
2960#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002961
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002962#ifdef FEAT_PROP_POPUP
Bram Moolenaar840f91f2021-05-26 22:32:10 +02002963 if (curbuf->b_has_textprop && lnum > 0
2964 && !(flags & (ML_APPEND_UNDO | ML_APPEND_NOPROP)))
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002965 // Add text properties that continue from the previous line.
2966 add_text_props_for_append(buf, lnum, &line, &len, &tofree);
2967#endif
2968
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002969 space_needed = len + INDEX_SIZE; // space needed for text + index
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970
2971 mfp = buf->b_ml.ml_mfp;
2972 page_size = mfp->mf_page_size;
2973
2974/*
2975 * find the data block containing the previous line
2976 * This also fills the stack with the blocks from the root to the data block
2977 * This also releases any locked block.
2978 */
2979 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2980 ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01002981 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982
2983 buf->b_ml.ml_flags &= ~ML_EMPTY;
2984
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002985 if (lnum == 0) // got line one instead, correct db_idx
2986 db_idx = -1; // careful, it is negative!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 else
2988 db_idx = lnum - buf->b_ml.ml_locked_low;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01002989 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2991
2992 dp = (DATA_BL *)(hp->bh_data);
2993
2994/*
2995 * If
2996 * - there is not enough room in the current block
2997 * - appending to the last line in the block
2998 * - not appending to the last line in the file
2999 * insert in front of the next block.
3000 */
3001 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
3002 && lnum < buf->b_ml.ml_line_count)
3003 {
3004 /*
3005 * Now that the line is not going to be inserted in the block that we
3006 * expected, the line count has to be adjusted in the pointer blocks
3007 * by using ml_locked_lineadd.
3008 */
3009 --(buf->b_ml.ml_locked_lineadd);
3010 --(buf->b_ml.ml_locked_high);
3011 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003012 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003014 db_idx = -1; // careful, it is negative!
3015 // get line count before the insertion
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
3017 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
3018
3019 dp = (DATA_BL *)(hp->bh_data);
3020 }
3021
3022 ++buf->b_ml.ml_line_count;
3023
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003024 if ((int)dp->db_free >= space_needed) // enough room in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 {
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003026 /*
3027 * Insert the new line in an existing data block, or in the data block
3028 * allocated above.
3029 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 dp->db_txt_start -= len;
3031 dp->db_free -= space_needed;
3032 ++(dp->db_line_count);
3033
3034 /*
3035 * move the text of the lines that follow to the front
3036 * adjust the indexes of the lines that follow
3037 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003038 if (line_count > db_idx + 1) // if there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 {
3040 /*
3041 * Offset is the start of the previous line.
3042 * This will become the character just after the new line.
3043 */
3044 if (db_idx < 0)
3045 offset = dp->db_txt_end;
3046 else
3047 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
3048 mch_memmove((char *)dp + dp->db_txt_start,
3049 (char *)dp + dp->db_txt_start + len,
3050 (size_t)(offset - (dp->db_txt_start + len)));
3051 for (i = line_count - 1; i > db_idx; --i)
3052 dp->db_index[i + 1] = dp->db_index[i] - len;
3053 dp->db_index[db_idx + 1] = offset - len;
3054 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003055 else
3056 // add line at the end (which is the start of the text)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 dp->db_index[db_idx + 1] = dp->db_txt_start;
3058
3059 /*
3060 * copy the text into the block
3061 */
3062 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003063 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 dp->db_index[db_idx + 1] |= DB_MARKED;
3065
3066 /*
3067 * Mark the block dirty.
3068 */
3069 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003070 if (!(flags & ML_APPEND_NEW))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 buf->b_ml.ml_flags |= ML_LOCKED_POS;
3072 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003073 else // not enough space in data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 long line_count_left, line_count_right;
3076 int page_count_left, page_count_right;
3077 bhdr_T *hp_left;
3078 bhdr_T *hp_right;
3079 bhdr_T *hp_new;
3080 int lines_moved;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003081 int data_moved = 0; // init to shut up gcc
3082 int total_moved = 0; // init to shut up gcc
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 DATA_BL *dp_right, *dp_left;
3084 int stack_idx;
3085 int in_left;
3086 int lineadd;
3087 blocknr_T bnum_left, bnum_right;
3088 linenr_T lnum_left, lnum_right;
3089 int pb_idx;
3090 PTR_BL *pp_new;
3091
3092 /*
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003093 * There is not enough room, we have to create a new data block and
3094 * copy some lines into it.
3095 * Then we have to insert an entry in the pointer block.
3096 * If this pointer block also is full, we go up another block, and so
3097 * on, up to the root if necessary.
3098 * The line counts in the pointer blocks have already been adjusted by
3099 * ml_find_line().
3100 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 * We are going to allocate a new data block. Depending on the
3102 * situation it will be put to the left or right of the existing
3103 * block. If possible we put the new line in the left block and move
3104 * the lines after it to the right block. Otherwise the new line is
3105 * also put in the right block. This method is more efficient when
3106 * inserting a lot of lines at one place.
3107 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003108 if (db_idx < 0) // left block is new, right block is existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 {
3110 lines_moved = 0;
3111 in_left = TRUE;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003112 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003114 else // left block is existing, right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 {
3116 lines_moved = line_count - db_idx - 1;
3117 if (lines_moved == 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003118 in_left = FALSE; // put new line in right block
3119 // space_needed does not change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 else
3121 {
3122 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
3123 dp->db_txt_start;
3124 total_moved = data_moved + lines_moved * INDEX_SIZE;
3125 if ((int)dp->db_free + total_moved >= space_needed)
3126 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003127 in_left = TRUE; // put new line in left block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 space_needed = total_moved;
3129 }
3130 else
3131 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003132 in_left = FALSE; // put new line in right block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 space_needed += total_moved;
3134 }
3135 }
3136 }
3137
3138 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003139 if ((hp_new = ml_new_data(mfp, flags & ML_APPEND_NEW, page_count))
3140 == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003142 // correct line counts in pointer blocks
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 --(buf->b_ml.ml_locked_lineadd);
3144 --(buf->b_ml.ml_locked_high);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003145 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003147 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 {
3149 hp_left = hp_new;
3150 hp_right = hp;
3151 line_count_left = 0;
3152 line_count_right = line_count;
3153 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003154 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 {
3156 hp_left = hp;
3157 hp_right = hp_new;
3158 line_count_left = line_count;
3159 line_count_right = 0;
3160 }
3161 dp_right = (DATA_BL *)(hp_right->bh_data);
3162 dp_left = (DATA_BL *)(hp_left->bh_data);
3163 bnum_left = hp_left->bh_bnum;
3164 bnum_right = hp_right->bh_bnum;
3165 page_count_left = hp_left->bh_page_count;
3166 page_count_right = hp_right->bh_page_count;
3167
3168 /*
3169 * May move the new line into the right/new block.
3170 */
3171 if (!in_left)
3172 {
3173 dp_right->db_txt_start -= len;
3174 dp_right->db_free -= len + INDEX_SIZE;
3175 dp_right->db_index[0] = dp_right->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003176 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 dp_right->db_index[0] |= DB_MARKED;
3178
3179 mch_memmove((char *)dp_right + dp_right->db_txt_start,
3180 line, (size_t)len);
3181 ++line_count_right;
3182 }
3183 /*
3184 * may move lines from the left/old block to the right/new one.
3185 */
3186 if (lines_moved)
3187 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 dp_right->db_txt_start -= data_moved;
3189 dp_right->db_free -= total_moved;
3190 mch_memmove((char *)dp_right + dp_right->db_txt_start,
3191 (char *)dp_left + dp_left->db_txt_start,
3192 (size_t)data_moved);
3193 offset = dp_right->db_txt_start - dp_left->db_txt_start;
3194 dp_left->db_txt_start += data_moved;
3195 dp_left->db_free += total_moved;
3196
3197 /*
3198 * update indexes in the new block
3199 */
3200 for (to = line_count_right, from = db_idx + 1;
3201 from < line_count_left; ++from, ++to)
3202 dp_right->db_index[to] = dp->db_index[from] + offset;
3203 line_count_right += lines_moved;
3204 line_count_left -= lines_moved;
3205 }
3206
3207 /*
3208 * May move the new line into the left (old or new) block.
3209 */
3210 if (in_left)
3211 {
3212 dp_left->db_txt_start -= len;
3213 dp_left->db_free -= len + INDEX_SIZE;
3214 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003215 if (flags & ML_APPEND_MARK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 dp_left->db_index[line_count_left] |= DB_MARKED;
3217 mch_memmove((char *)dp_left + dp_left->db_txt_start,
3218 line, (size_t)len);
3219 ++line_count_left;
3220 }
3221
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003222 if (db_idx < 0) // left block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 {
3224 lnum_left = lnum + 1;
3225 lnum_right = 0;
3226 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003227 else // right block is new
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 {
3229 lnum_left = 0;
3230 if (in_left)
3231 lnum_right = lnum + 2;
3232 else
3233 lnum_right = lnum + 1;
3234 }
3235 dp_left->db_line_count = line_count_left;
3236 dp_right->db_line_count = line_count_right;
3237
3238 /*
3239 * release the two data blocks
3240 * The new one (hp_new) already has a correct blocknumber.
3241 * The old one (hp, in ml_locked) gets a positive blocknumber if
3242 * we changed it and we are not editing a new file.
3243 */
3244 if (lines_moved || in_left)
3245 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003246 if (!(flags & ML_APPEND_NEW) && db_idx >= 0 && in_left)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 buf->b_ml.ml_flags |= ML_LOCKED_POS;
3248 mf_put(mfp, hp_new, TRUE, FALSE);
3249
3250 /*
3251 * flush the old data block
3252 * set ml_locked_lineadd to 0, because the updating of the
3253 * pointer blocks is done below
3254 */
3255 lineadd = buf->b_ml.ml_locked_lineadd;
3256 buf->b_ml.ml_locked_lineadd = 0;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003257 ml_find_line(buf, (linenr_T)0, ML_FLUSH); // flush data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258
3259 /*
3260 * update pointer blocks for the new data block
3261 */
3262 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3263 --stack_idx)
3264 {
3265 ip = &(buf->b_ml.ml_stack[stack_idx]);
3266 pb_idx = ip->ip_index;
3267 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003268 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003269 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 if (pp->pb_id != PTR_ID)
3271 {
RestorerZ68ebcee2023-05-31 17:12:14 +01003272 iemsg(e_pointer_block_id_wrong_three);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003274 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 }
3276 /*
3277 * TODO: If the pointer block is full and we are adding at the end
3278 * try to insert in front of the next block
3279 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003280 // block not full, add one entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 if (pp->pb_count < pp->pb_count_max)
3282 {
3283 if (pb_idx + 1 < (int)pp->pb_count)
3284 mch_memmove(&pp->pb_pointer[pb_idx + 2],
3285 &pp->pb_pointer[pb_idx + 1],
3286 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
3287 ++pp->pb_count;
3288 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3289 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3290 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3291 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3292 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3293 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3294
3295 if (lnum_left != 0)
3296 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3297 if (lnum_right != 0)
3298 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
3299
3300 mf_put(mfp, hp, TRUE, FALSE);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003301 buf->b_ml.ml_stack_top = stack_idx + 1; // truncate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302
3303 if (lineadd)
3304 {
3305 --(buf->b_ml.ml_stack_top);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003306 // fix line count for rest of blocks in the stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 ml_lineadd(buf, lineadd);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003308 // fix stack itself
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
3310 lineadd;
3311 ++(buf->b_ml.ml_stack_top);
3312 }
3313
3314 /*
3315 * We are finished, break the loop here.
3316 */
3317 break;
3318 }
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003319 // pointer block full
3320 /*
3321 * split the pointer block
3322 * allocate a new pointer block
3323 * move some of the pointer into the new block
3324 * prepare for updating the parent block
3325 */
3326 for (;;) // do this twice when splitting block 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 {
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003328 hp_new = ml_new_ptr(mfp);
3329 if (hp_new == NULL) // TODO: try to fix tree
3330 goto theend;
3331 pp_new = (PTR_BL *)(hp_new->bh_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003333 if (hp->bh_bnum != 1)
3334 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 /*
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003337 * if block 1 becomes full the tree is given an extra level
3338 * The pointers from block 1 are moved into the new block.
3339 * block 1 is updated to point to the new block
3340 * then continue to split the new block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 */
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003342 mch_memmove(pp_new, pp, (size_t)page_size);
3343 pp->pb_count = 1;
3344 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
3345 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
3346 pp->pb_pointer[0].pe_old_lnum = 1;
3347 pp->pb_pointer[0].pe_page_count = 1;
3348 mf_put(mfp, hp, TRUE, FALSE); // release block 1
3349 hp = hp_new; // new block is to be split
3350 pp = pp_new;
3351 CHECK(stack_idx != 0, _("stack_idx should be 0"));
3352 ip->ip_index = 0;
3353 ++stack_idx; // do block 1 again later
3354 }
3355 /*
3356 * move the pointers after the current one to the new block
3357 * If there are none, the new entry will be in the new block.
3358 */
3359 total_moved = pp->pb_count - pb_idx - 1;
3360 if (total_moved)
3361 {
3362 mch_memmove(&pp_new->pb_pointer[0],
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 &pp->pb_pointer[pb_idx + 1],
3364 (size_t)(total_moved) * sizeof(PTR_EN));
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003365 pp_new->pb_count = total_moved;
3366 pp->pb_count -= total_moved - 1;
3367 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
3368 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
3369 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
3370 if (lnum_right)
3371 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 }
=?UTF-8?q?Dundar=20G=C3=B6c?=f26c1612022-04-07 13:26:34 +01003373 else
3374 {
3375 pp_new->pb_count = 1;
3376 pp_new->pb_pointer[0].pe_bnum = bnum_right;
3377 pp_new->pb_pointer[0].pe_line_count = line_count_right;
3378 pp_new->pb_pointer[0].pe_page_count = page_count_right;
3379 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
3380 }
3381 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
3382 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
3383 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
3384 if (lnum_left)
3385 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
3386 lnum_left = 0;
3387 lnum_right = 0;
3388
3389 /*
3390 * recompute line counts
3391 */
3392 line_count_right = 0;
3393 for (i = 0; i < (int)pp_new->pb_count; ++i)
3394 line_count_right += pp_new->pb_pointer[i].pe_line_count;
3395 line_count_left = 0;
3396 for (i = 0; i < (int)pp->pb_count; ++i)
3397 line_count_left += pp->pb_pointer[i].pe_line_count;
3398
3399 bnum_left = hp->bh_bnum;
3400 bnum_right = hp_new->bh_bnum;
3401 page_count_left = 1;
3402 page_count_right = 1;
3403 mf_put(mfp, hp, TRUE, FALSE);
3404 mf_put(mfp, hp_new, TRUE, FALSE);
3405
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 }
3407
3408 /*
3409 * Safety check: fallen out of for loop?
3410 */
3411 if (stack_idx < 0)
3412 {
RestorerZ68ebcee2023-05-31 17:12:14 +01003413 iemsg(e_updated_too_many_blocks);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003414 buf->b_ml.ml_stack_top = 0; // invalidate stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 }
3416 }
3417
3418#ifdef FEAT_BYTEOFF
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003419 // The line was inserted below 'lnum'
Bram Moolenaar50652b02022-08-07 21:48:37 +01003420 ml_updatechunk(buf, lnum + 1,
3421# ifdef FEAT_PROP_POPUP
3422 (long)text_len
3423# else
3424 (long)len
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003425# endif
Bram Moolenaar50652b02022-08-07 21:48:37 +01003426 , ML_CHNK_ADDLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427#endif
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003428
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003430 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 {
John Marriott02d7a6c2024-02-26 21:21:17 +01003432 int line_len = (int)STRLEN(line);
3433 if (line_len > 0)
3434 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, line_len);
3435 netbeans_inserted(buf, lnum+1, (colnr_T)line_len, (char_u *)"\n", 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 }
3437#endif
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01003438#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003439 if (buf->b_write_to_channel)
3440 channel_write_new_lines(buf);
3441#endif
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003442 ret = OK;
Bram Moolenaar99ef0622016-03-06 20:22:25 +01003443
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003444theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003445#ifdef FEAT_PROP_POPUP
Bram Moolenaarb56ac042018-12-28 23:22:40 +01003446 vim_free(tofree);
3447#endif
3448 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449}
3450
3451/*
Bram Moolenaar250e3112019-07-15 23:02:14 +02003452 * Flush any pending change and call ml_append_int()
3453 */
3454 static int
3455ml_append_flush(
3456 buf_T *buf,
3457 linenr_T lnum, // append after this line (can be 0)
3458 char_u *line, // text of the new line
3459 colnr_T len, // length of line, including NUL, or 0
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003460 int flags) // ML_APPEND_ flags
Bram Moolenaar250e3112019-07-15 23:02:14 +02003461{
3462 if (lnum > buf->b_ml.ml_line_count)
3463 return FAIL; // lnum out of range
3464
3465 if (buf->b_ml.ml_line_lnum != 0)
3466 // This may also invoke ml_append_int().
3467 ml_flush_line(buf);
3468
3469#ifdef FEAT_EVAL
3470 // When inserting above recorded changes: flush the changes before changing
3471 // the text. Then flush the cached line, it may become invalid.
3472 may_invoke_listeners(buf, lnum + 1, lnum + 1, 1);
3473 if (buf->b_ml.ml_line_lnum != 0)
3474 ml_flush_line(buf);
3475#endif
3476
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003477 return ml_append_int(buf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003478}
3479
3480/*
3481 * Append a line after lnum (may be 0 to insert a line in front of the file).
3482 * "line" does not need to be allocated, but can't be another line in a
3483 * buffer, unlocking may make it invalid.
3484 *
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003485 * "newfile": TRUE when starting to edit a new file, meaning that pe_old_lnum
Bram Moolenaar250e3112019-07-15 23:02:14 +02003486 * will be set for recovery
3487 * Check: The caller of this function should probably also call
3488 * appended_lines().
3489 *
3490 * return FAIL for failure, OK otherwise
3491 */
3492 int
3493ml_append(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003494 linenr_T lnum, // append after this line (can be 0)
3495 char_u *line, // text of the new line
3496 colnr_T len, // length of new line, including NUL, or 0
3497 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003498{
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003499 return ml_append_flags(lnum, line, len, newfile ? ML_APPEND_NEW : 0);
3500}
3501
3502 int
3503ml_append_flags(
3504 linenr_T lnum, // append after this line (can be 0)
3505 char_u *line, // text of the new line
3506 colnr_T len, // length of new line, including NUL, or 0
3507 int flags) // ML_APPEND_ values
3508{
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003509 // When starting up, we might still need to create the memfile
Bram Moolenaar250e3112019-07-15 23:02:14 +02003510 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
3511 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003512 return ml_append_flush(curbuf, lnum, line, len, flags);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003513}
3514
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003515
Bram Moolenaar9f28eeb2022-05-16 10:04:51 +01003516#if defined(FEAT_SPELL) || defined(FEAT_QUICKFIX) || defined(FEAT_PROP_POPUP) \
3517 || defined(PROTO)
Bram Moolenaar250e3112019-07-15 23:02:14 +02003518/*
3519 * Like ml_append() but for an arbitrary buffer. The buffer must already have
3520 * a memline.
3521 */
3522 int
3523ml_append_buf(
3524 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003525 linenr_T lnum, // append after this line (can be 0)
3526 char_u *line, // text of the new line
3527 colnr_T len, // length of new line, including NUL, or 0
3528 int newfile) // flag, see above
Bram Moolenaar250e3112019-07-15 23:02:14 +02003529{
3530 if (buf->b_ml.ml_mfp == NULL)
3531 return FAIL;
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003532 return ml_append_flush(buf, lnum, line, len, newfile ? ML_APPEND_NEW : 0);
Bram Moolenaar250e3112019-07-15 23:02:14 +02003533}
3534#endif
3535
3536/*
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003537 * Replace line "lnum", with buffering, in current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 *
Bram Moolenaar1056d982006-03-09 22:37:52 +00003539 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 * copied to allocated memory already.
Bram Moolenaar5966ea12020-07-15 15:30:05 +02003541 * If "copy" is FALSE the "line" may be freed to add text properties!
3542 * Do not use it after calling ml_replace().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 *
3544 * Check: The caller of this function should probably also call
Bram Moolenaara4d158b2022-08-14 14:17:45 +01003545 * changed_lines(), unless update_screen(UPD_NOT_VALID) is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 *
3547 * return FAIL for failure, OK otherwise
3548 */
3549 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003550ml_replace(linenr_T lnum, char_u *line, int copy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551{
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003552 colnr_T len = -1;
3553
3554 if (line != NULL)
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003555 len = (colnr_T)STRLEN(line);
Bram Moolenaarccae4672019-01-04 15:09:57 +01003556 return ml_replace_len(lnum, line, len, FALSE, copy);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003557}
3558
Bram Moolenaarccae4672019-01-04 15:09:57 +01003559/*
3560 * Replace a line for the current buffer. Like ml_replace() with:
3561 * "len_arg" is the length of the text, excluding NUL.
3562 * If "has_props" is TRUE then "line_arg" includes the text properties and
3563 * "len_arg" includes the NUL of the text.
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01003564 * When "copy" is TRUE copy the text into allocated memory, otherwise
3565 * "line_arg" must be allocated and will be consumed here.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003566 */
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003567 int
Bram Moolenaarccae4672019-01-04 15:09:57 +01003568ml_replace_len(
3569 linenr_T lnum,
3570 char_u *line_arg,
3571 colnr_T len_arg,
3572 int has_props,
3573 int copy)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003574{
3575 char_u *line = line_arg;
3576 colnr_T len = len_arg;
3577
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003578 if (line == NULL) // just checking...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 return FAIL;
3580
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003581 // When starting up, we might still need to create the memfile
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003582 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL, 0) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 return FAIL;
3584
Bram Moolenaarccae4672019-01-04 15:09:57 +01003585 if (!has_props)
3586 ++len; // include the NUL after the text
3587 if (copy)
3588 {
3589 // copy the line to allocated memory
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003590#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003591 if (has_props)
3592 line = vim_memsave(line, len);
3593 else
3594#endif
3595 line = vim_strnsave(line, len - 1);
3596 if (line == NULL)
3597 return FAIL;
3598 }
3599
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003601 if (netbeans_active())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 {
John Marriott02d7a6c2024-02-26 21:21:17 +01003603 netbeans_removed(curbuf, lnum, 0, (long)ml_get_len(lnum));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003604 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 }
3606#endif
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003607 if (curbuf->b_ml.ml_line_lnum != lnum)
3608 {
3609 // another line is buffered, flush it
3610 ml_flush_line(curbuf);
3611
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003612#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003613 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003614 // Need to fetch the old line to copy over any text properties.
3615 ml_get_buf(curbuf, lnum, TRUE);
3616#endif
3617 }
3618
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003619#ifdef FEAT_PROP_POPUP
Bram Moolenaarccae4672019-01-04 15:09:57 +01003620 if (curbuf->b_has_textprop && !has_props)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003621 {
3622 size_t oldtextlen = STRLEN(curbuf->b_ml.ml_line_ptr) + 1;
3623
3624 if (oldtextlen < (size_t)curbuf->b_ml.ml_line_len)
3625 {
3626 char_u *newline;
3627 size_t textproplen = curbuf->b_ml.ml_line_len - oldtextlen;
3628
3629 // Need to copy over text properties, stored after the text.
Bram Moolenaarccae4672019-01-04 15:09:57 +01003630 newline = alloc(len + (int)textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003631 if (newline != NULL)
3632 {
Bram Moolenaarccae4672019-01-04 15:09:57 +01003633 mch_memmove(newline, line, len);
Bram Moolenaar0d3cb732019-05-18 13:05:18 +02003634 mch_memmove(newline + len, curbuf->b_ml.ml_line_ptr
3635 + oldtextlen, textproplen);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003636 vim_free(line);
3637 line = newline;
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01003638 len += (colnr_T)textproplen;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003639 }
3640 }
3641 }
3642#endif
3643
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01003644 if (curbuf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
3645 vim_free(curbuf->b_ml.ml_line_ptr); // free allocated line
Bram Moolenaar98aefe72018-12-13 22:20:09 +01003646
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 curbuf->b_ml.ml_line_ptr = line;
Bram Moolenaarccae4672019-01-04 15:09:57 +01003648 curbuf->b_ml.ml_line_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 curbuf->b_ml.ml_line_lnum = lnum;
3650 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
3651
3652 return OK;
3653}
3654
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003655#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003656/*
3657 * Adjust text properties in line "lnum" for a deleted line.
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003658 * When "above" is true this is the line above the deleted line, otherwise this
3659 * is the line below the deleted line.
3660 * "del_props[del_props_len]" are the properties of the deleted line.
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003661 */
3662 static void
3663adjust_text_props_for_delete(
3664 buf_T *buf,
3665 linenr_T lnum,
3666 char_u *del_props,
3667 int del_props_len,
3668 int above)
3669{
3670 int did_get_line = FALSE;
3671 int done_del;
3672 int done_this;
3673 textprop_T prop_del;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003674 bhdr_T *hp;
3675 DATA_BL *dp;
3676 int idx;
3677 int line_start;
3678 long line_size;
Christian Brabandta2a90d52023-06-26 18:48:09 +01003679 int this_props_len = 0;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003680 char_u *text;
3681 size_t textlen;
3682 int found;
3683
3684 for (done_del = 0; done_del < del_props_len; done_del += sizeof(textprop_T))
3685 {
3686 mch_memmove(&prop_del, del_props + done_del, sizeof(textprop_T));
3687 if ((above && (prop_del.tp_flags & TP_FLAG_CONT_PREV)
3688 && !(prop_del.tp_flags & TP_FLAG_CONT_NEXT))
3689 || (!above && (prop_del.tp_flags & TP_FLAG_CONT_NEXT)
3690 && !(prop_del.tp_flags & TP_FLAG_CONT_PREV)))
3691 {
3692 if (!did_get_line)
3693 {
3694 did_get_line = TRUE;
3695 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
3696 return;
3697
3698 dp = (DATA_BL *)(hp->bh_data);
3699 idx = lnum - buf->b_ml.ml_locked_low;
3700 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3701 if (idx == 0) // first line in block, text at the end
3702 line_size = dp->db_txt_end - line_start;
3703 else
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003704 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK)
3705 - line_start;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003706 text = (char_u *)dp + line_start;
3707 textlen = STRLEN(text) + 1;
3708 if ((long)textlen >= line_size)
3709 {
3710 if (above)
3711 internal_error("no text property above deleted line");
3712 else
3713 internal_error("no text property below deleted line");
3714 return;
3715 }
Bram Moolenaar4b7214e2019-01-03 21:55:32 +01003716 this_props_len = line_size - (int)textlen;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003717 }
3718
3719 found = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003720 for (done_this = 0; done_this < this_props_len;
3721 done_this += sizeof(textprop_T))
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003722 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003723 int flag = above ? TP_FLAG_CONT_NEXT
3724 : TP_FLAG_CONT_PREV;
3725 textprop_T prop_this;
3726
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003727 mch_memmove(&prop_this, text + textlen + done_this,
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003728 sizeof(textprop_T));
3729 if ((prop_this.tp_flags & flag)
3730 && prop_del.tp_id == prop_this.tp_id
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003731 && prop_del.tp_type == prop_this.tp_type)
3732 {
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003733 found = TRUE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003734 prop_this.tp_flags &= ~flag;
Paul Ollis1bdc60e2022-05-15 22:24:55 +01003735 mch_memmove(text + textlen + done_this, &prop_this,
Bram Moolenaar87be9be2020-05-30 15:32:02 +02003736 sizeof(textprop_T));
3737 break;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003738 }
3739 }
3740 if (!found)
3741 {
3742 if (above)
3743 internal_error("text property above deleted line not found");
3744 else
3745 internal_error("text property below deleted line not found");
3746 }
3747
3748 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3749 }
3750 }
3751}
3752#endif
3753
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754/*
Bram Moolenaar4033c552017-09-16 20:54:51 +02003755 * Delete line "lnum" in the current buffer.
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003756 * When "flags" has ML_DEL_MESSAGE may give a "No lines in buffer" message.
3757 * When "flags" has ML_DEL_UNDO this is called from undo.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 *
3759 * return FAIL for failure, OK otherwise
3760 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 static int
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003762ml_delete_int(buf_T *buf, linenr_T lnum, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763{
3764 bhdr_T *hp;
3765 memfile_T *mfp;
3766 DATA_BL *dp;
3767 PTR_BL *pp;
3768 infoptr_T *ip;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003769 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 int idx;
3771 int stack_idx;
3772 int text_start;
3773 int line_start;
3774 long line_size;
3775 int i;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003776 int ret = FAIL;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003777#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003778 char_u *textprop_save = NULL;
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003779 long textprop_len = 0;
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003780#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 if (lowest_marked && lowest_marked > lnum)
3783 lowest_marked--;
3784
3785/*
3786 * If the file becomes empty the last line is replaced by an empty line.
3787 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003788 if (buf->b_ml.ml_line_count == 1) // file becomes empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 {
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003790 if ((flags & ML_DEL_MESSAGE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791#ifdef FEAT_NETBEANS_INTG
3792 && !netbeansSuppressNoLines
3793#endif
3794 )
Bram Moolenaar238a5642006-02-21 22:12:05 +00003795 set_keep_msg((char_u *)_(no_lines_msg), 0);
3796
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003797 // FEAT_BYTEOFF already handled in there, don't worry 'bout it below
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
3799 buf->b_ml.ml_flags |= ML_EMPTY;
3800
3801 return i;
3802 }
3803
3804/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003805 * Find the data block containing the line.
3806 * This also fills the stack with the blocks from the root to the data block.
3807 * This also releases any locked block..
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 */
3809 mfp = buf->b_ml.ml_mfp;
3810 if (mfp == NULL)
3811 return FAIL;
3812
3813 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
3814 return FAIL;
3815
3816 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003817 // compute line count before the delete
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 count = (long)(buf->b_ml.ml_locked_high)
3819 - (long)(buf->b_ml.ml_locked_low) + 2;
3820 idx = lnum - buf->b_ml.ml_locked_low;
3821
3822 --buf->b_ml.ml_line_count;
3823
3824 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003825 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 line_size = dp->db_txt_end - line_start;
3827 else
3828 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
3829
3830#ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003831 if (netbeans_active())
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00003832 netbeans_removed(buf, lnum, 0, line_size);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003834#ifdef FEAT_PROP_POPUP
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003835 // If there are text properties compute their byte length.
3836 // if needed make a copy, so that we can update properties in preceding and
3837 // following lines.
3838 if (buf->b_has_textprop)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003839 {
3840 size_t textlen = STRLEN((char_u *)dp + line_start) + 1;
3841
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003842 textprop_len = line_size - (long)textlen;
3843 if (!(flags & (ML_DEL_UNDO | ML_DEL_NOPROP)) && textprop_len > 0)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003844 textprop_save = vim_memsave((char_u *)dp + line_start + textlen,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003845 textprop_len);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003846 }
3847#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848
3849/*
3850 * special case: If there is only one line in the data block it becomes empty.
3851 * Then we have to remove the entry, pointing to this data block, from the
3852 * pointer block. If this pointer block also becomes empty, we go up another
3853 * block, and so on, up to the root if necessary.
3854 * The line counts in the pointer blocks have already been adjusted by
3855 * ml_find_line().
3856 */
3857 if (count == 1)
3858 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003859 mf_free(mfp, hp); // free the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 buf->b_ml.ml_locked = NULL;
3861
Bram Moolenaare60acc12011-05-10 16:41:25 +02003862 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
3863 --stack_idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003865 buf->b_ml.ml_stack_top = 0; // stack is invalid when failing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 ip = &(buf->b_ml.ml_stack[stack_idx]);
3867 idx = ip->ip_index;
3868 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003869 goto theend;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003870 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 if (pp->pb_id != PTR_ID)
3872 {
RestorerZ68ebcee2023-05-31 17:12:14 +01003873 iemsg(e_pointer_block_id_wrong_four);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 mf_put(mfp, hp, FALSE, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003875 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 }
3877 count = --(pp->pb_count);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003878 if (count == 0) // the pointer block becomes empty!
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 mf_free(mfp, hp);
3880 else
3881 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003882 if (count != idx) // move entries after the deleted one
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
3884 (size_t)(count - idx) * sizeof(PTR_EN));
3885 mf_put(mfp, hp, TRUE, FALSE);
3886
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003887 buf->b_ml.ml_stack_top = stack_idx; // truncate stack
3888 // fix line count for rest of blocks in the stack
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003889 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 {
3891 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3892 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
Bram Moolenaar6b803a72007-05-06 14:25:46 +00003893 buf->b_ml.ml_locked_lineadd;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 }
3895 ++(buf->b_ml.ml_stack_top);
3896
3897 break;
3898 }
3899 }
3900 CHECK(stack_idx < 0, _("deleted block 1?"));
3901 }
3902 else
3903 {
3904 /*
3905 * delete the text by moving the next lines forwards
3906 */
3907 text_start = dp->db_txt_start;
3908 mch_memmove((char *)dp + text_start + line_size,
3909 (char *)dp + text_start, (size_t)(line_start - text_start));
3910
3911 /*
3912 * delete the index by moving the next indexes backwards
3913 * Adjust the indexes for the text movement.
3914 */
3915 for (i = idx; i < count - 1; ++i)
3916 dp->db_index[i] = dp->db_index[i + 1] + line_size;
3917
3918 dp->db_free += line_size + INDEX_SIZE;
3919 dp->db_txt_start += line_size;
3920 --(dp->db_line_count);
3921
3922 /*
3923 * mark the block dirty and make sure it is in the file (for recovery)
3924 */
3925 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3926 }
3927
3928#ifdef FEAT_BYTEOFF
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003929 ml_updatechunk(buf, lnum, line_size
3930# ifdef FEAT_PROP_POPUP
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003931 - textprop_len
Bram Moolenaarcdd8a5e2021-08-25 16:40:03 +02003932# endif
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003933 , ML_CHNK_DELLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934#endif
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003935 ret = OK;
3936
3937theend:
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003938#ifdef FEAT_PROP_POPUP
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003939 if (textprop_save != NULL)
3940 {
3941 // Adjust text properties in the line above and below.
3942 if (lnum > 1)
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02003943 adjust_text_props_for_delete(buf, lnum - 1, textprop_save,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003944 (int)textprop_len, TRUE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003945 if (lnum <= buf->b_ml.ml_line_count)
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02003946 adjust_text_props_for_delete(buf, lnum, textprop_save,
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01003947 (int)textprop_len, FALSE);
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003948 }
3949 vim_free(textprop_save);
3950#endif
3951 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952}
3953
3954/*
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003955 * Delete line "lnum" in the current buffer.
3956 * When "message" is TRUE may give a "No lines in buffer" message.
3957 *
3958 * Check: The caller of this function should probably also call
3959 * deleted_lines() after this.
3960 *
3961 * return FAIL for failure, OK otherwise
3962 */
3963 int
Bram Moolenaarca70c072020-05-30 20:30:46 +02003964ml_delete(linenr_T lnum)
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003965{
Bram Moolenaarca70c072020-05-30 20:30:46 +02003966 return ml_delete_flags(lnum, 0);
Bram Moolenaara9d4b842020-05-30 14:46:52 +02003967}
3968
3969/*
3970 * Like ml_delete() but using flags (see ml_delete_int()).
3971 */
3972 int
3973ml_delete_flags(linenr_T lnum, int flags)
3974{
3975 ml_flush_line(curbuf);
3976 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
3977 return FAIL;
3978
3979#ifdef FEAT_EVAL
3980 // When inserting above recorded changes: flush the changes before changing
3981 // the text.
3982 may_invoke_listeners(curbuf, lnum, lnum + 1, -1);
3983#endif
3984
3985 return ml_delete_int(curbuf, lnum, flags);
3986}
3987
3988/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01003989 * set the DB_MARKED flag for line 'lnum'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 */
3991 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003992ml_setmarked(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993{
3994 bhdr_T *hp;
3995 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003996 // invalid line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3998 || curbuf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01003999 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000
4001 if (lowest_marked == 0 || lowest_marked > lnum)
4002 lowest_marked = lnum;
4003
4004 /*
4005 * find the data block containing the line
4006 * This also fills the stack with the blocks from the root to the data block
4007 * This also releases any locked block.
4008 */
4009 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004010 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011
4012 dp = (DATA_BL *)(hp->bh_data);
4013 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
4014 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
4015}
4016
4017/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01004018 * find the first line with its DB_MARKED flag set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 */
4020 linenr_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004021ml_firstmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022{
4023 bhdr_T *hp;
4024 DATA_BL *dp;
4025 linenr_T lnum;
4026 int i;
4027
4028 if (curbuf->b_ml.ml_mfp == NULL)
4029 return (linenr_T) 0;
4030
4031 /*
4032 * The search starts with lowest_marked line. This is the last line where
4033 * a mark was found, adjusted by inserting/deleting lines.
4034 */
4035 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
4036 {
4037 /*
4038 * Find the data block containing the line.
4039 * This also fills the stack with the blocks from the root to the data
4040 * block This also releases any locked block.
4041 */
4042 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004043 return (linenr_T)0; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044
4045 dp = (DATA_BL *)(hp->bh_data);
4046
4047 for (i = lnum - curbuf->b_ml.ml_locked_low;
4048 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
4049 if ((dp->db_index[i]) & DB_MARKED)
4050 {
4051 (dp->db_index[i]) &= DB_INDEX_MASK;
4052 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
4053 lowest_marked = lnum + 1;
4054 return lnum;
4055 }
4056 }
4057
4058 return (linenr_T) 0;
4059}
4060
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061/*
4062 * clear all DB_MARKED flags
4063 */
4064 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004065ml_clearmarked(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066{
4067 bhdr_T *hp;
4068 DATA_BL *dp;
4069 linenr_T lnum;
4070 int i;
4071
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004072 if (curbuf->b_ml.ml_mfp == NULL) // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 return;
4074
4075 /*
4076 * The search starts with line lowest_marked.
4077 */
4078 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
4079 {
4080 /*
4081 * Find the data block containing the line.
4082 * This also fills the stack with the blocks from the root to the data
4083 * block and releases any locked block.
4084 */
4085 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004086 return; // give error message?
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087
4088 dp = (DATA_BL *)(hp->bh_data);
4089
4090 for (i = lnum - curbuf->b_ml.ml_locked_low;
4091 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
4092 if ((dp->db_index[i]) & DB_MARKED)
4093 {
4094 (dp->db_index[i]) &= DB_INDEX_MASK;
4095 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
4096 }
4097 }
4098
4099 lowest_marked = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100}
4101
4102/*
4103 * flush ml_line if necessary
4104 */
4105 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004106ml_flush_line(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107{
4108 bhdr_T *hp;
4109 DATA_BL *dp;
4110 linenr_T lnum;
4111 char_u *new_line;
4112 char_u *old_line;
4113 colnr_T new_len;
4114 int old_len;
4115 int extra;
4116 int idx;
4117 int start;
4118 int count;
4119 int i;
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004120 static int entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121
4122 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004123 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124
4125 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
4126 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004127 // This code doesn't work recursively, but Netbeans may call back here
4128 // when obtaining the cursor position.
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004129 if (entered)
4130 return;
4131 entered = TRUE;
4132
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 lnum = buf->b_ml.ml_line_lnum;
4134 new_line = buf->b_ml.ml_line_ptr;
4135
4136 hp = ml_find_line(buf, lnum, ML_FIND);
4137 if (hp == NULL)
RestorerZ68ebcee2023-05-31 17:12:14 +01004138 siemsg(e_cannot_find_line_nr, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 else
4140 {
4141 dp = (DATA_BL *)(hp->bh_data);
4142 idx = lnum - buf->b_ml.ml_locked_low;
4143 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
4144 old_line = (char_u *)dp + start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004145 if (idx == 0) // line is last in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 old_len = dp->db_txt_end - start;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004147 else // text of previous line follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01004149 new_len = buf->b_ml.ml_line_len;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004150 extra = new_len - old_len; // negative if lines gets smaller
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151
4152 /*
4153 * if new line fits in data block, replace directly
4154 */
4155 if ((int)dp->db_free >= extra)
4156 {
Bram Moolenaar92755bb2021-08-15 22:18:04 +02004157#if defined(FEAT_BYTEOFF) && defined(FEAT_PROP_POPUP)
Bram Moolenaar14c75302021-08-15 14:28:40 +02004158 int old_prop_len = 0;
Paul Ollis4c3d21a2022-05-24 21:26:37 +01004159 if (buf->b_has_textprop)
4160 old_prop_len = old_len - (int)STRLEN(old_line) - 1;
Bram Moolenaar14c75302021-08-15 14:28:40 +02004161#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004162 // if the length changes and there are following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
4164 if (extra != 0 && idx < count - 1)
4165 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004166 // move text of following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 mch_memmove((char *)dp + dp->db_txt_start - extra,
4168 (char *)dp + dp->db_txt_start,
4169 (size_t)(start - dp->db_txt_start));
4170
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004171 // adjust pointers of this and following lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 for (i = idx + 1; i < count; ++i)
4173 dp->db_index[i] -= extra;
4174 }
4175 dp->db_index[idx] -= extra;
4176
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004177 // adjust free space
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 dp->db_free -= extra;
4179 dp->db_txt_start -= extra;
4180
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004181 // copy new line into the data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 mch_memmove(old_line - extra, new_line, (size_t)new_len);
4183 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
Bram Moolenaar92755bb2021-08-15 22:18:04 +02004184#if defined(FEAT_BYTEOFF) && defined(FEAT_PROP_POPUP)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004185 // The else case is already covered by the insert and delete
Bram Moolenaar14c75302021-08-15 14:28:40 +02004186 if (buf->b_has_textprop)
4187 {
4188 // Do not count the size of any text properties.
4189 extra += old_prop_len;
Bram Moolenaar434df7a2021-08-16 21:15:32 +02004190 extra -= new_len - (int)STRLEN(new_line) - 1;
Bram Moolenaar14c75302021-08-15 14:28:40 +02004191 }
4192 if (extra != 0)
4193 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194#endif
4195 }
4196 else
4197 {
4198 /*
4199 * Cannot do it in one data block: Delete and append.
4200 * Append first, because ml_delete_int() cannot delete the
4201 * last line in a buffer, which causes trouble for a buffer
4202 * that has only one line.
4203 * Don't forget to copy the mark!
4204 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004205 // How about handling errors???
Bram Moolenaara9d4b842020-05-30 14:46:52 +02004206 (void)ml_append_int(buf, lnum, new_line, new_len,
Bram Moolenaar840f91f2021-05-26 22:32:10 +02004207 ((dp->db_index[idx] & DB_MARKED) ? ML_APPEND_MARK : 0)
4208#ifdef FEAT_PROP_POPUP
4209 | ML_APPEND_NOPROP
4210#endif
4211 );
Bram Moolenaar4cd5c522021-06-27 13:04:00 +02004212 (void)ml_delete_int(buf, lnum, ML_DEL_NOPROP);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 }
4214 }
4215 vim_free(new_line);
Bram Moolenaar0ca4b352010-02-11 18:54:43 +01004216
4217 entered = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 }
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01004219 else if (buf->b_ml.ml_flags & ML_ALLOCATED)
4220 vim_free(buf->b_ml.ml_line_ptr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01004222 buf->b_ml.ml_flags &= ~(ML_LINE_DIRTY | ML_ALLOCATED);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 buf->b_ml.ml_line_lnum = 0;
4224}
4225
4226/*
4227 * create a new, empty, data block
4228 */
4229 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004230ml_new_data(memfile_T *mfp, int negative, int page_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231{
4232 bhdr_T *hp;
4233 DATA_BL *dp;
4234
4235 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
4236 return NULL;
4237
4238 dp = (DATA_BL *)(hp->bh_data);
4239 dp->db_id = DATA_ID;
4240 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
4241 dp->db_free = dp->db_txt_start - HEADER_SIZE;
4242 dp->db_line_count = 0;
4243
4244 return hp;
4245}
4246
4247/*
4248 * create a new, empty, pointer block
4249 */
4250 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004251ml_new_ptr(memfile_T *mfp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252{
4253 bhdr_T *hp;
4254 PTR_BL *pp;
4255
4256 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
4257 return NULL;
4258
4259 pp = (PTR_BL *)(hp->bh_data);
4260 pp->pb_id = PTR_ID;
4261 pp->pb_count = 0;
Bram Moolenaarb67ba032023-04-22 21:14:26 +01004262 pp->pb_count_max = PB_COUNT_MAX(mfp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263
4264 return hp;
4265}
4266
4267/*
Bram Moolenaarc1a9bc12018-12-28 21:59:29 +01004268 * Lookup line 'lnum' in a memline.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 *
4270 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
4271 * if ML_FLUSH only flush a locked block
4272 * if ML_FIND just find the line
4273 *
4274 * If the block was found it is locked and put in ml_locked.
4275 * The stack is updated to lead to the locked block. The ip_high field in
4276 * the stack is updated to reflect the last line in the block AFTER the
4277 * insert or delete, also if the pointer block has not been updated yet. But
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004278 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 *
4280 * return: NULL for failure, pointer to block header otherwise
4281 */
4282 static bhdr_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004283ml_find_line(buf_T *buf, linenr_T lnum, int action)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284{
4285 DATA_BL *dp;
4286 PTR_BL *pp;
4287 infoptr_T *ip;
4288 bhdr_T *hp;
4289 memfile_T *mfp;
4290 linenr_T t;
4291 blocknr_T bnum, bnum2;
4292 int dirty;
4293 linenr_T low, high;
4294 int top;
4295 int page_count;
4296 int idx;
4297
4298 mfp = buf->b_ml.ml_mfp;
4299
4300 /*
4301 * If there is a locked block check if the wanted line is in it.
4302 * If not, flush and release the locked block.
4303 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
4304 * Don't do this for ML_FLUSH, because we want to flush the locked block.
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004305 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 */
4307 if (buf->b_ml.ml_locked)
4308 {
Bram Moolenaar47b8b152007-02-07 02:41:57 +00004309 if (ML_SIMPLE(action)
4310 && buf->b_ml.ml_locked_low <= lnum
4311 && buf->b_ml.ml_locked_high >= lnum
4312 && !mf_dont_release)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004314 // remember to update pointer blocks and stack later
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 if (action == ML_INSERT)
4316 {
4317 ++(buf->b_ml.ml_locked_lineadd);
4318 ++(buf->b_ml.ml_locked_high);
4319 }
4320 else if (action == ML_DELETE)
4321 {
4322 --(buf->b_ml.ml_locked_lineadd);
4323 --(buf->b_ml.ml_locked_high);
4324 }
4325 return (buf->b_ml.ml_locked);
4326 }
4327
4328 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
4329 buf->b_ml.ml_flags & ML_LOCKED_POS);
4330 buf->b_ml.ml_locked = NULL;
4331
Bram Moolenaar6b803a72007-05-06 14:25:46 +00004332 /*
4333 * If lines have been added or deleted in the locked block, need to
4334 * update the line count in pointer blocks.
4335 */
4336 if (buf->b_ml.ml_locked_lineadd != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
4338 }
4339
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004340 if (action == ML_FLUSH) // nothing else to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 return NULL;
4342
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004343 bnum = 1; // start at the root of the tree
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 page_count = 1;
4345 low = 1;
4346 high = buf->b_ml.ml_line_count;
4347
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004348 if (action == ML_FIND) // first try stack entries
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 {
4350 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
4351 {
4352 ip = &(buf->b_ml.ml_stack[top]);
4353 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
4354 {
4355 bnum = ip->ip_bnum;
4356 low = ip->ip_low;
4357 high = ip->ip_high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004358 buf->b_ml.ml_stack_top = top; // truncate stack at prev entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 break;
4360 }
4361 }
4362 if (top < 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004363 buf->b_ml.ml_stack_top = 0; // not found, start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004365 else // ML_DELETE or ML_INSERT
4366 buf->b_ml.ml_stack_top = 0; // start at the root
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367
4368/*
4369 * search downwards in the tree until a data block is found
4370 */
4371 for (;;)
4372 {
4373 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
4374 goto error_noblock;
4375
4376 /*
4377 * update high for insert/delete
4378 */
4379 if (action == ML_INSERT)
4380 ++high;
4381 else if (action == ML_DELETE)
4382 --high;
4383
4384 dp = (DATA_BL *)(hp->bh_data);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004385 if (dp->db_id == DATA_ID) // data block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 {
4387 buf->b_ml.ml_locked = hp;
4388 buf->b_ml.ml_locked_low = low;
4389 buf->b_ml.ml_locked_high = high;
4390 buf->b_ml.ml_locked_lineadd = 0;
4391 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
4392 return hp;
4393 }
4394
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004395 pp = (PTR_BL *)(dp); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 if (pp->pb_id != PTR_ID)
4397 {
RestorerZ68ebcee2023-05-31 17:12:14 +01004398 iemsg(e_pointer_block_id_wrong);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 goto error_block;
4400 }
4401
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004402 if ((top = ml_add_stack(buf)) < 0) // add new entry to stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 goto error_block;
4404 ip = &(buf->b_ml.ml_stack[top]);
4405 ip->ip_bnum = bnum;
4406 ip->ip_low = low;
4407 ip->ip_high = high;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004408 ip->ip_index = -1; // index not known yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409
4410 dirty = FALSE;
4411 for (idx = 0; idx < (int)pp->pb_count; ++idx)
4412 {
4413 t = pp->pb_pointer[idx].pe_line_count;
4414 CHECK(t == 0, _("pe_line_count is zero"));
4415 if ((low += t) > lnum)
4416 {
4417 ip->ip_index = idx;
4418 bnum = pp->pb_pointer[idx].pe_bnum;
4419 page_count = pp->pb_pointer[idx].pe_page_count;
4420 high = low - 1;
4421 low -= t;
4422
4423 /*
4424 * a negative block number may have been changed
4425 */
4426 if (bnum < 0)
4427 {
4428 bnum2 = mf_trans_del(mfp, bnum);
4429 if (bnum != bnum2)
4430 {
4431 bnum = bnum2;
4432 pp->pb_pointer[idx].pe_bnum = bnum;
4433 dirty = TRUE;
4434 }
4435 }
4436
4437 break;
4438 }
4439 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004440 if (idx >= (int)pp->pb_count) // past the end: something wrong!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 {
4442 if (lnum > buf->b_ml.ml_line_count)
RestorerZ68ebcee2023-05-31 17:12:14 +01004443 siemsg(e_line_number_out_of_range_nr_past_the_end,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 lnum - buf->b_ml.ml_line_count);
4445
4446 else
RestorerZ68ebcee2023-05-31 17:12:14 +01004447 siemsg(e_line_count_wrong_in_block_nr, bnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 goto error_block;
4449 }
4450 if (action == ML_DELETE)
4451 {
4452 pp->pb_pointer[idx].pe_line_count--;
4453 dirty = TRUE;
4454 }
4455 else if (action == ML_INSERT)
4456 {
4457 pp->pb_pointer[idx].pe_line_count++;
4458 dirty = TRUE;
4459 }
4460 mf_put(mfp, hp, dirty, FALSE);
4461 }
4462
4463error_block:
4464 mf_put(mfp, hp, FALSE, FALSE);
4465error_noblock:
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02004466 /*
4467 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
4468 * the incremented/decremented line counts, because there won't be a line
4469 * inserted/deleted after all.
4470 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 if (action == ML_DELETE)
4472 ml_lineadd(buf, 1);
4473 else if (action == ML_INSERT)
4474 ml_lineadd(buf, -1);
4475 buf->b_ml.ml_stack_top = 0;
4476 return NULL;
4477}
4478
4479/*
4480 * add an entry to the info pointer stack
4481 *
4482 * return -1 for failure, number of the new entry otherwise
4483 */
4484 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004485ml_add_stack(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486{
4487 int top;
4488 infoptr_T *newstack;
4489
4490 top = buf->b_ml.ml_stack_top;
4491
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004492 // may have to increase the stack size
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 if (top == buf->b_ml.ml_stack_size)
4494 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004495 CHECK(top > 0, _("Stack size increases")); // more than 5 levels???
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004497 newstack = ALLOC_MULT(infoptr_T, buf->b_ml.ml_stack_size + STACK_INCR);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 if (newstack == NULL)
4499 return -1;
Bram Moolenaarfbd302f2015-08-08 18:23:46 +02004500 if (top > 0)
4501 mch_memmove(newstack, buf->b_ml.ml_stack,
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004502 (size_t)top * sizeof(infoptr_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 vim_free(buf->b_ml.ml_stack);
4504 buf->b_ml.ml_stack = newstack;
4505 buf->b_ml.ml_stack_size += STACK_INCR;
4506 }
4507
4508 buf->b_ml.ml_stack_top++;
4509 return top;
4510}
4511
4512/*
4513 * Update the pointer blocks on the stack for inserted/deleted lines.
4514 * The stack itself is also updated.
4515 *
4516 * When a insert/delete line action fails, the line is not inserted/deleted,
4517 * but the pointer blocks have already been updated. That is fixed here by
4518 * walking through the stack.
4519 *
4520 * Count is the number of lines added, negative if lines have been deleted.
4521 */
4522 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004523ml_lineadd(buf_T *buf, int count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524{
4525 int idx;
4526 infoptr_T *ip;
4527 PTR_BL *pp;
4528 memfile_T *mfp = buf->b_ml.ml_mfp;
4529 bhdr_T *hp;
4530
4531 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
4532 {
4533 ip = &(buf->b_ml.ml_stack[idx]);
4534 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
4535 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004536 pp = (PTR_BL *)(hp->bh_data); // must be pointer block
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 if (pp->pb_id != PTR_ID)
4538 {
4539 mf_put(mfp, hp, FALSE, FALSE);
RestorerZ68ebcee2023-05-31 17:12:14 +01004540 iemsg(e_pointer_block_id_wrong_two);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 break;
4542 }
4543 pp->pb_pointer[ip->ip_index].pe_line_count += count;
4544 ip->ip_high += count;
4545 mf_put(mfp, hp, TRUE, FALSE);
4546 }
4547}
4548
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004549#if defined(HAVE_READLINK) || defined(PROTO)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004550/*
4551 * Resolve a symlink in the last component of a file name.
4552 * Note that f_resolve() does it for every part of the path, we don't do that
4553 * here.
4554 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
4555 * Otherwise returns FAIL.
4556 */
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004557 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004558resolve_symlink(char_u *fname, char_u *buf)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004559{
4560 char_u tmp[MAXPATHL];
4561 int ret;
4562 int depth = 0;
4563
4564 if (fname == NULL)
4565 return FAIL;
4566
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004567 // Put the result so far in tmp[], starting with the original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004568 vim_strncpy(tmp, fname, MAXPATHL - 1);
4569
4570 for (;;)
4571 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004572 // Limit symlink depth to 100, catch recursive loops.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004573 if (++depth == 100)
4574 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00004575 semsg(_(e_symlink_loop_for_str), fname);
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004576 return FAIL;
4577 }
4578
4579 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
4580 if (ret <= 0)
4581 {
Bram Moolenaarcc984262005-12-23 22:19:46 +00004582 if (errno == EINVAL || errno == ENOENT)
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004583 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004584 // Found non-symlink or not existing file, stop here.
4585 // When at the first level use the unmodified name, skip the
4586 // call to vim_FullName().
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004587 if (depth == 1)
4588 return FAIL;
4589
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004590 // Use the resolved name in tmp[].
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004591 break;
4592 }
4593
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004594 // There must be some error reading links, use original name.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004595 return FAIL;
4596 }
4597 buf[ret] = NUL;
4598
4599 /*
4600 * Check whether the symlink is relative or absolute.
4601 * If it's relative, build a new path based on the directory
4602 * portion of the filename (if any) and the path the symlink
4603 * points to.
4604 */
4605 if (mch_isFullName(buf))
4606 STRCPY(tmp, buf);
4607 else
4608 {
4609 char_u *tail;
4610
4611 tail = gettail(tmp);
4612 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
4613 return FAIL;
4614 STRCPY(tail, buf);
4615 }
4616 }
4617
4618 /*
4619 * Try to resolve the full name of the file so that the swapfile name will
4620 * be consistent even when opening a relative symlink from different
4621 * working directories.
4622 */
4623 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
4624}
4625#endif
4626
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627/*
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004628 * Make swap file name out of the file name and a directory name.
4629 * Returns pointer to allocated memory or NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004631 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004632makeswapname(
4633 char_u *fname,
4634 char_u *ffname UNUSED,
4635 buf_T *buf,
4636 char_u *dir_name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637{
4638 char_u *r, *s;
Bram Moolenaar9dbe4752010-05-14 17:52:42 +02004639 char_u *fname_res = fname;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004640#ifdef HAVE_READLINK
4641 char_u fname_buf[MAXPATHL];
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004642
4643 // Expand symlink in the file name, so that we put the swap file with the
4644 // actual file instead of with the symlink.
4645 if (resolve_symlink(fname, fname_buf) == OK)
4646 fname_res = fname_buf;
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004647#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648
Bram Moolenaar4f974752019-02-17 17:44:42 +01004649#if defined(UNIX) || defined(MSWIN) // Need _very_ long file names
Bram Moolenaarb113c3a2017-02-28 21:26:17 +01004650 int len = (int)STRLEN(dir_name);
Bram Moolenaarc525e3a2017-02-18 16:59:02 +01004651
4652 s = dir_name + len;
4653 if (after_pathsep(dir_name, s) && len > 1 && s[-1] == s[-2])
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004654 { // Ends with '//', Use Full path
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 r = NULL;
Bram Moolenaar5966ea12020-07-15 15:30:05 +02004656 if ((s = make_percent_swname(dir_name, fname_res)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 {
4658 r = modname(s, (char_u *)".swp", FALSE);
4659 vim_free(s);
4660 }
4661 return r;
4662 }
4663#endif
4664
4665 r = buf_modname(
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 (buf->b_p_sn || buf->b_shortname),
Bram Moolenaar900b4d72005-12-12 22:05:50 +00004667 fname_res,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 (char_u *)
Bram Moolenaare60acc12011-05-10 16:41:25 +02004669#if defined(VMS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 "_swp",
4671#else
4672 ".swp",
4673#endif
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004674 // Prepend a '.' to the swap file name for the current directory.
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004675 dir_name[0] == '.' && dir_name[1] == NUL);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004676 if (r == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 return NULL;
4678
4679 s = get_file_in_dir(r, dir_name);
4680 vim_free(r);
4681 return s;
4682}
4683
4684/*
4685 * Get file name to use for swap file or backup file.
4686 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
4687 * option "dname".
4688 * - If "dname" is ".", return "fname" (swap file in dir of file).
4689 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
4690 * relative to dir of file).
4691 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
4692 * dir).
4693 *
4694 * The return value is an allocated string and can be NULL.
4695 */
4696 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004697get_file_in_dir(
4698 char_u *fname,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004699 char_u *dname) // don't use "dirname", it is a global for Alpha
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700{
4701 char_u *t;
4702 char_u *tail;
4703 char_u *retval;
4704 int save_char;
4705
4706 tail = gettail(fname);
4707
4708 if (dname[0] == '.' && dname[1] == NUL)
4709 retval = vim_strsave(fname);
4710 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
4711 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004712 if (tail == fname) // no path before file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 retval = concat_fnames(dname + 2, tail, TRUE);
4714 else
4715 {
4716 save_char = *tail;
4717 *tail = NUL;
4718 t = concat_fnames(fname, dname + 2, TRUE);
4719 *tail = save_char;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004720 if (t == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 retval = NULL;
4722 else
4723 {
4724 retval = concat_fnames(t, tail, TRUE);
4725 vim_free(t);
4726 }
4727 }
4728 }
4729 else
4730 retval = concat_fnames(dname, tail, TRUE);
4731
Bram Moolenaar4f974752019-02-17 17:44:42 +01004732#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004733 if (retval != NULL)
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004734 for (t = gettail(retval); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004735 if (*t == ':')
4736 *t = '%';
4737#endif
4738
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 return retval;
4740}
4741
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004742/*
4743 * Print the ATTENTION message: info about an existing swap file.
4744 */
4745 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004746attention_message(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004747 buf_T *buf, // buffer being edited
4748 char_u *fname) // swap file name
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004749{
Bram Moolenaar8767f522016-07-01 17:17:39 +02004750 stat_T st;
Bram Moolenaar63d25552019-05-10 21:28:38 +02004751 time_t swap_mtime;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004752
4753 ++no_wait_return;
Bram Moolenaareaaac012022-01-02 17:00:40 +00004754 (void)emsg(_(e_attention));
Bram Moolenaar32526b32019-01-19 17:43:09 +01004755 msg_puts(_("\nFound a swap file by the name \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004756 msg_home_replace(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004757 msg_puts("\"\n");
Bram Moolenaar63d25552019-05-10 21:28:38 +02004758 swap_mtime = swapfile_info(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004759 msg_puts(_("While opening file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004760 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004761 msg_puts("\"\n");
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004762 if (mch_stat((char *)buf->b_fname, &st) == -1)
4763 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004764 msg_puts(_(" CANNOT BE FOUND"));
Bram Moolenaard6105cb2018-10-13 19:06:27 +02004765 }
4766 else
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004767 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01004768 msg_puts(_(" dated: "));
Bram Moolenaar63d25552019-05-10 21:28:38 +02004769 msg_puts(get_ctime(st.st_mtime, TRUE));
4770 if (swap_mtime != 0 && st.st_mtime > swap_mtime)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004771 msg_puts(_(" NEWER than swap file!\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004772 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004773 // Some of these messages are long to allow translation to
4774 // other languages.
Bram Moolenaar32526b32019-01-19 17:43:09 +01004775 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"));
4776 msg_puts(_("(2) An edit session for this file crashed.\n"));
4777 msg_puts(_(" If this is the case, use \":recover\" or \"vim -r "));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004778 msg_outtrans(buf->b_fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004779 msg_puts(_("\"\n to recover the changes (see \":help recovery\").\n"));
4780 msg_puts(_(" If you did this already, delete the swap file \""));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004781 msg_outtrans(fname);
Bram Moolenaar32526b32019-01-19 17:43:09 +01004782 msg_puts(_("\"\n to avoid this message.\n"));
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004783 cmdline_row = msg_row;
4784 --no_wait_return;
4785}
4786
Bram Moolenaar188639d2022-04-04 16:57:21 +01004787typedef enum {
4788 SEA_CHOICE_NONE = 0,
4789 SEA_CHOICE_READONLY = 1,
4790 SEA_CHOICE_EDIT = 2,
4791 SEA_CHOICE_RECOVER = 3,
4792 SEA_CHOICE_DELETE = 4,
4793 SEA_CHOICE_QUIT = 5,
4794 SEA_CHOICE_ABORT = 6
4795} sea_choice_T;
4796
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004797#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004798/*
4799 * Trigger the SwapExists autocommands.
Bram Moolenaar188639d2022-04-04 16:57:21 +01004800 * Returns a value for equivalent to do_dialog().
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004801 */
Bram Moolenaar188639d2022-04-04 16:57:21 +01004802 static sea_choice_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004803do_swapexists(buf_T *buf, char_u *fname)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004804{
4805 set_vim_var_string(VV_SWAPNAME, fname, -1);
4806 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
4807
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004808 // Trigger SwapExists autocommands with <afile> set to the file being
4809 // edited. Disallow changing directory here.
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004810 ++allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004811 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004812 --allbuf_lock;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004813
4814 set_vim_var_string(VV_SWAPNAME, NULL, -1);
4815
4816 switch (*get_vim_var_str(VV_SWAPCHOICE))
4817 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01004818 case 'o': return SEA_CHOICE_READONLY;
4819 case 'e': return SEA_CHOICE_EDIT;
4820 case 'r': return SEA_CHOICE_RECOVER;
4821 case 'd': return SEA_CHOICE_DELETE;
4822 case 'q': return SEA_CHOICE_QUIT;
4823 case 'a': return SEA_CHOICE_ABORT;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004824 }
4825
Bram Moolenaar188639d2022-04-04 16:57:21 +01004826 return SEA_CHOICE_NONE;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004827}
4828#endif
4829
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830/*
4831 * Find out what name to use for the swap file for buffer 'buf'.
4832 *
4833 * Several names are tried to find one that does not exist
Bram Moolenaar04a09c12005-08-01 22:02:32 +00004834 * Returns the name in allocated memory or NULL.
Bram Moolenaarf541c362011-10-26 11:44:18 +02004835 * When out of memory "dirp" is set to NULL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 *
4837 * Note: If BASENAMELEN is not correct, you will get error messages for
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004838 * not being able to open the swap or undo file
Bram Moolenaar12c22ce2009-04-22 13:58:46 +00004839 * Note: May trigger SwapExists autocmd, pointers may change!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 */
4841 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004842findswapname(
4843 buf_T *buf,
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004844 char_u **dirp, // pointer to list of directories
4845 char_u *old_fname) // don't give warning for this file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846{
4847 char_u *fname;
4848 int n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 char_u *dir_name;
4850#ifdef AMIGA
4851 BPTR fh;
4852#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 int r;
Bram Moolenaar69c35002013-11-04 02:54:12 +01004854 char_u *buf_fname = buf->b_fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004856#if !defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857# define CREATE_DUMMY_FILE
4858 FILE *dummyfd = NULL;
4859
Bram Moolenaar4f974752019-02-17 17:44:42 +01004860# ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01004861 if (buf_fname != NULL && !mch_isFullName(buf_fname)
4862 && vim_strchr(gettail(buf_fname), ':'))
4863 {
4864 char_u *t;
4865
4866 buf_fname = vim_strsave(buf_fname);
4867 if (buf_fname == NULL)
4868 buf_fname = buf->b_fname;
4869 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004870 for (t = gettail(buf_fname); *t != NUL; MB_PTR_ADV(t))
Bram Moolenaar69c35002013-11-04 02:54:12 +01004871 if (*t == ':')
4872 *t = '%';
4873 }
4874# endif
4875
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004876 /*
4877 * If we start editing a new file, e.g. "test.doc", which resides on an
4878 * MSDOS compatible filesystem, it is possible that the file
4879 * "test.doc.swp" which we create will be exactly the same file. To avoid
4880 * this problem we temporarily create "test.doc". Don't do this when the
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00004881 * check below for an 8.3 file name is used.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004882 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004883 if (!(buf->b_p_sn || buf->b_shortname) && buf_fname != NULL
4884 && mch_getperm(buf_fname) < 0)
4885 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886#endif
4887
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004888 /*
4889 * Isolate a directory name from *dirp and put it in dir_name.
4890 * First allocate some memory to put the directory name in.
4891 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02004892 dir_name = alloc(STRLEN(*dirp) + 1);
Bram Moolenaarf541c362011-10-26 11:44:18 +02004893 if (dir_name == NULL)
4894 *dirp = NULL;
4895 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 (void)copy_option_part(dirp, dir_name, 31000, ",");
4897
Bram Moolenaar55debbe2010-05-23 23:34:36 +02004898 /*
4899 * we try different names until we find one that does not exist yet
4900 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004901 if (dir_name == NULL) // out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 fname = NULL;
4903 else
Bram Moolenaar69c35002013-11-04 02:54:12 +01004904 fname = makeswapname(buf_fname, buf->b_ffname, buf, dir_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905
4906 for (;;)
4907 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004908 if (fname == NULL) // must be out of memory
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 break;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004910 if ((n = (int)STRLEN(fname)) == 0) // safety check
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01004912 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 break;
4914 }
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004915#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916/*
4917 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
4918 * file names. If this is the first try and the swap file name does not fit in
4919 * 8.3, detect if this is the case, set shortname and try again.
4920 */
4921 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
4922 && !(buf->b_p_sn || buf->b_shortname))
4923 {
4924 char_u *tail;
4925 char_u *fname2;
Bram Moolenaar8767f522016-07-01 17:17:39 +02004926 stat_T s1, s2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 int f1, f2;
4928 int created1 = FALSE, created2 = FALSE;
4929 int same = FALSE;
4930
4931 /*
4932 * Check if swapfile name does not fit in 8.3:
4933 * It either contains two dots, is longer than 8 chars, or starts
4934 * with a dot.
4935 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01004936 tail = gettail(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 if ( vim_strchr(tail, '.') != NULL
4938 || STRLEN(tail) > (size_t)8
4939 || *gettail(fname) == '.')
4940 {
4941 fname2 = alloc(n + 2);
4942 if (fname2 != NULL)
4943 {
4944 STRCPY(fname2, fname);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01004945 // if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
4946 // if fname == ".xx.swp", fname2 = ".xx.swpx"
4947 // if fname == "123456789.swp", fname2 = "12345678x.swp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 if (vim_strchr(tail, '.') != NULL)
4949 fname2[n - 1] = 'x';
4950 else if (*gettail(fname) == '.')
4951 {
4952 fname2[n] = 'x';
4953 fname2[n + 1] = NUL;
4954 }
4955 else
4956 fname2[n - 5] += 1;
4957 /*
4958 * may need to create the files to be able to use mch_stat()
4959 */
4960 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4961 if (f1 < 0)
4962 {
4963 f1 = mch_open_rw((char *)fname,
4964 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 created1 = TRUE;
4966 }
4967 if (f1 >= 0)
4968 {
4969 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4970 if (f2 < 0)
4971 {
4972 f2 = mch_open_rw((char *)fname2,
4973 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4974 created2 = TRUE;
4975 }
4976 if (f2 >= 0)
4977 {
4978 /*
4979 * Both files exist now. If mch_stat() returns the
4980 * same device and inode they are the same file.
4981 */
4982 if (mch_fstat(f1, &s1) != -1
4983 && mch_fstat(f2, &s2) != -1
4984 && s1.st_dev == s2.st_dev
4985 && s1.st_ino == s2.st_ino)
4986 same = TRUE;
4987 close(f2);
4988 if (created2)
4989 mch_remove(fname2);
4990 }
4991 close(f1);
4992 if (created1)
4993 mch_remove(fname);
4994 }
4995 vim_free(fname2);
4996 if (same)
4997 {
4998 buf->b_shortname = TRUE;
4999 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01005000 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00005001 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005002 continue; // try again with b_shortname set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 }
5004 }
5005 }
5006 }
5007#endif
5008 /*
5009 * check if the swapfile already exists
5010 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005011 if (mch_getperm(fname) < 0) // it does not exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 {
5013#ifdef HAVE_LSTAT
Bram Moolenaar8767f522016-07-01 17:17:39 +02005014 stat_T sb;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015
5016 /*
5017 * Extra security check: When a swap file is a symbolic link, this
5018 * is most likely a symlink attack.
5019 */
5020 if (mch_lstat((char *)fname, &sb) < 0)
5021#else
5022# ifdef AMIGA
5023 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
5024 /*
5025 * on the Amiga mch_getperm() will return -1 when the file exists
5026 * but is being used by another program. This happens if you edit
5027 * a file twice.
5028 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005029 if (fh != (BPTR)NULL) // can open file, OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 {
5031 Close(fh);
5032 mch_remove(fname);
5033 break;
5034 }
5035 if (IoErr() != ERROR_OBJECT_IN_USE
5036 && IoErr() != ERROR_OBJECT_EXISTS)
5037# endif
5038#endif
5039 break;
5040 }
5041
5042 /*
5043 * A file name equal to old_fname is OK to use.
5044 */
5045 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
5046 break;
5047
5048 /*
5049 * get here when file already exists
5050 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005051 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') // first try
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 /*
5054 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
5055 * and file.doc are the same file. To guess if this problem is
5056 * present try if file.doc.swx exists. If it does, we set
5057 * buf->b_shortname and try file_doc.swp (dots replaced by
5058 * underscores for this file), and try again. If it doesn't we
5059 * assume that "file.doc.swp" already exists.
5060 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005061 if (!(buf->b_p_sn || buf->b_shortname)) // not tried yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 {
5063 fname[n - 1] = 'x';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005064 r = mch_getperm(fname); // try "file.swx"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 fname[n - 1] = 'p';
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005066 if (r >= 0) // "file.swx" seems to exist
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 {
5068 buf->b_shortname = TRUE;
5069 vim_free(fname);
Bram Moolenaar69c35002013-11-04 02:54:12 +01005070 fname = makeswapname(buf_fname, buf->b_ffname,
Bram Moolenaar04a09c12005-08-01 22:02:32 +00005071 buf, dir_name);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005072 continue; // try again with '.' replaced with '_'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 }
5074 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 /*
5076 * If we get here the ".swp" file really exists.
5077 * Give an error message, unless recovering, no file name, we are
5078 * viewing a help file or when the path of the file is different
5079 * (happens when all .swp files are in one directory).
5080 */
Bram Moolenaar69c35002013-11-04 02:54:12 +01005081 if (!recoverymode && buf_fname != NULL
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02005082 && !buf->b_help
5083 && !(buf->b_flags & (BF_DUMMY | BF_NO_SEA)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 {
5085 int fd;
5086 struct block0 b0;
5087 int differ = FALSE;
5088
5089 /*
5090 * Try to read block 0 from the swap file to get the original
5091 * file name (and inode number).
5092 */
5093 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
5094 if (fd >= 0)
5095 {
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01005096 if (read_eintr(fd, &b0, sizeof(b0)) == sizeof(b0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 {
5098 /*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005099 * If the swapfile has the same directory as the
5100 * buffer don't compare the directory names, they can
5101 * have a different mountpoint.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005103 if (b0.b0_flags & B0_SAME_DIR)
5104 {
5105 if (fnamecmp(gettail(buf->b_ffname),
5106 gettail(b0.b0_fname)) != 0
5107 || !same_directory(fname, buf->b_ffname))
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005108 {
5109#ifdef CHECK_INODE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005110 // Symlinks may point to the same file even
5111 // when the name differs, need to check the
5112 // inode too.
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005113 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
5114 if (fnamecmp_ino(buf->b_ffname, NameBuff,
5115 char_to_long(b0.b0_ino)))
5116#endif
5117 differ = TRUE;
5118 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005119 }
5120 else
5121 {
5122 /*
5123 * The name in the swap file may be
5124 * "~user/path/file". Expand it first.
5125 */
5126 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127#ifdef CHECK_INODE
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005128 if (fnamecmp_ino(buf->b_ffname, NameBuff,
Bram Moolenaar900b4d72005-12-12 22:05:50 +00005129 char_to_long(b0.b0_ino)))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005130 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131#else
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005132 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
5133 differ = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 }
5137 close(fd);
5138 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005140 // give the ATTENTION message when there is an old swap file
5141 // for the current file, and the buffer was not recovered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
5143 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
5144 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005145 sea_choice_T choice = SEA_CHOICE_NONE;
5146 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147#ifdef CREATE_DUMMY_FILE
Bram Moolenaar188639d2022-04-04 16:57:21 +01005148 int did_use_dummy = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005150 // Avoid getting a warning for the file being created
5151 // outside of Vim, it was created at the start of this
5152 // function. Delete the file now, because Vim might exit
5153 // here if the window is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 if (dummyfd != NULL)
5155 {
5156 fclose(dummyfd);
5157 dummyfd = NULL;
Bram Moolenaar69c35002013-11-04 02:54:12 +01005158 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 did_use_dummy = TRUE;
5160 }
5161#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005163#ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 process_still_running = FALSE;
5165#endif
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005166 // It's safe to delete the swap file if all these are true:
5167 // - the edited file exists
5168 // - the swap file has no changes and looks OK
5169 if (mch_stat((char *)buf->b_fname, &st) == 0
5170 && swapfile_unchanged(fname))
5171 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005172 choice = SEA_CHOICE_DELETE;
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005173 if (p_verbose > 0)
5174 verb_msg(_("Found a swap file that is not useful, deleting it"));
5175 }
5176
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005177#if defined(FEAT_EVAL)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005178 /*
5179 * If there is an SwapExists autocommand and we can handle
5180 * the response, trigger it. It may return 0 to ask the
5181 * user anyway.
5182 */
Bram Moolenaar188639d2022-04-04 16:57:21 +01005183 if (choice == SEA_CHOICE_NONE
Bram Moolenaar67cf86b2019-04-28 22:25:38 +02005184 && swap_exists_action != SEA_NONE
Bram Moolenaar69c35002013-11-04 02:54:12 +01005185 && has_autocmd(EVENT_SWAPEXISTS, buf_fname, buf))
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005186 choice = do_swapexists(buf, fname);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005187#endif
Bram Moolenaar188639d2022-04-04 16:57:21 +01005188
5189 if (choice == SEA_CHOICE_NONE
5190 && swap_exists_action == SEA_READONLY)
5191 {
5192 // always open readonly.
5193 choice = SEA_CHOICE_READONLY;
5194 }
5195
5196 if (choice == SEA_CHOICE_NONE)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005197 {
5198#ifdef FEAT_GUI
Bram Moolenaar798184c2018-10-07 20:48:39 +02005199 // If we are supposed to start the GUI but it wasn't
5200 // completely started yet, start it now. This makes
5201 // the messages displayed in the Vim window when
5202 // loading a session from the .gvimrc file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005203 if (gui.starting && !gui.in_use)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02005204 gui_start(NULL);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005205#endif
Bram Moolenaar798184c2018-10-07 20:48:39 +02005206 // Show info about the existing swap file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005207 attention_message(buf, fname);
5208
Bram Moolenaar798184c2018-10-07 20:48:39 +02005209 // We don't want a 'q' typed at the more-prompt
5210 // interrupt loading a file.
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005211 got_int = FALSE;
Bram Moolenaar798184c2018-10-07 20:48:39 +02005212
5213 // If vimrc has "simalt ~x" we don't want it to
5214 // interfere with the prompt here.
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02005215 flush_buffers(FLUSH_TYPEAHEAD);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005216 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217
5218#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar188639d2022-04-04 16:57:21 +01005219 if (swap_exists_action != SEA_NONE
5220 && choice == SEA_CHOICE_NONE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 {
5222 char_u *name;
Bram Moolenaar188639d2022-04-04 16:57:21 +01005223 int dialog_result;
John Marriott02d7a6c2024-02-26 21:21:17 +01005224 size_t len = STRLEN(_("Swap file \""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225
Bram Moolenaar964b3742019-05-24 18:54:09 +02005226 name = alloc(STRLEN(fname)
John Marriott02d7a6c2024-02-26 21:21:17 +01005227 + len
Bram Moolenaar964b3742019-05-24 18:54:09 +02005228 + STRLEN(_("\" already exists!")) + 5);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 if (name != NULL)
5230 {
5231 STRCPY(name, _("Swap file \""));
John Marriott02d7a6c2024-02-26 21:21:17 +01005232 home_replace(NULL, fname, name + len, 1000, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 STRCAT(name, _("\" already exists!"));
5234 }
Bram Moolenaar188639d2022-04-04 16:57:21 +01005235 dialog_result = do_dialog(VIM_WARNING,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 (char_u *)_("VIM - ATTENTION"),
5237 name == NULL
5238 ? (char_u *)_("Swap file already exists!")
5239 : name,
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005240# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 process_still_running
5242 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
5243# endif
Bram Moolenaard2c340a2011-01-17 20:08:11 +01005244 (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 +00005245
Bram Moolenaar1b243ea2019-04-28 22:50:40 +02005246# ifdef HAVE_PROCESS_STILL_RUNNING
Bram Moolenaar188639d2022-04-04 16:57:21 +01005247 if (process_still_running && dialog_result >= 4)
5248 // compensate for missing "Delete it" button
5249 dialog_result++;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005250# endif
Bram Moolenaar188639d2022-04-04 16:57:21 +01005251 choice = dialog_result;
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005252 vim_free(name);
5253
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005254 // pretend screen didn't scroll, need redraw anyway
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005255 msg_scrolled = 0;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01005256 redraw_all_later(UPD_NOT_VALID);
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005257 }
5258#endif
5259
Bram Moolenaar188639d2022-04-04 16:57:21 +01005260 switch (choice)
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00005261 {
Bram Moolenaar188639d2022-04-04 16:57:21 +01005262 case SEA_CHOICE_READONLY:
5263 buf->b_p_ro = TRUE;
5264 break;
5265 case SEA_CHOICE_EDIT:
5266 break;
5267 case SEA_CHOICE_RECOVER:
5268 swap_exists_action = SEA_RECOVER;
5269 break;
5270 case SEA_CHOICE_DELETE:
5271 mch_remove(fname);
5272 break;
5273 case SEA_CHOICE_QUIT:
5274 swap_exists_action = SEA_QUIT;
5275 break;
5276 case SEA_CHOICE_ABORT:
5277 swap_exists_action = SEA_QUIT;
5278 got_int = TRUE;
5279 break;
5280 case SEA_CHOICE_NONE:
5281 msg_puts("\n");
5282 if (msg_silent == 0)
5283 // call wait_return() later
5284 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 break;
5286 }
Bram Moolenaar188639d2022-04-04 16:57:21 +01005287
5288 // If the file was deleted this fname can be used.
5289 if (choice != SEA_CHOICE_NONE && mch_getperm(fname) < 0)
5290 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291
5292#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005293 // Going to try another name, need the dummy file again.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 if (did_use_dummy)
Bram Moolenaar69c35002013-11-04 02:54:12 +01005295 dummyfd = mch_fopen((char *)buf_fname, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296#endif
5297 }
5298 }
5299 }
5300
5301 /*
5302 * Change the ".swp" extension to find another file that can be used.
5303 * First decrement the last char: ".swo", ".swn", etc.
5304 * If that still isn't enough decrement the last but one char: ".svz"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005305 * Can happen when editing many "No Name" buffers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 */
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005307 if (fname[n - 1] == 'a') // ".s?a"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005309 if (fname[n - 2] == 'a') // ".saa": tried enough, give up
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 {
Bram Moolenaareaaac012022-01-02 17:00:40 +00005311 emsg(_(e_too_many_swap_files_found));
Bram Moolenaard23a8232018-02-10 18:45:26 +01005312 VIM_CLEAR(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 break;
5314 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005315 --fname[n - 2]; // ".svz", ".suz", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 fname[n - 1] = 'z' + 1;
5317 }
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005318 --fname[n - 1]; // ".swo", ".swn", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 }
5320
5321 vim_free(dir_name);
5322#ifdef CREATE_DUMMY_FILE
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005323 if (dummyfd != NULL) // file has been created temporarily
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 {
5325 fclose(dummyfd);
Bram Moolenaar69c35002013-11-04 02:54:12 +01005326 mch_remove(buf_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 }
5328#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01005329#ifdef MSWIN
Bram Moolenaar69c35002013-11-04 02:54:12 +01005330 if (buf_fname != buf->b_fname)
5331 vim_free(buf_fname);
5332#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 return fname;
5334}
5335
5336 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005337b0_magic_wrong(ZERO_BL *b0p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338{
5339 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
5340 || b0p->b0_magic_int != (int)B0_MAGIC_INT
5341 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
5342 || b0p->b0_magic_char != B0_MAGIC_CHAR);
5343}
5344
5345#ifdef CHECK_INODE
5346/*
5347 * Compare current file name with file name from swap file.
5348 * Try to use inode numbers when possible.
5349 * Return non-zero when files are different.
5350 *
5351 * When comparing file names a few things have to be taken into consideration:
5352 * - When working over a network the full path of a file depends on the host.
5353 * We check the inode number if possible. It is not 100% reliable though,
5354 * because the device number cannot be used over a network.
5355 * - When a file does not exist yet (editing a new file) there is no inode
5356 * number.
5357 * - The file name in a swap file may not be valid on the current host. The
5358 * "~user" form is used whenever possible to avoid this.
5359 *
5360 * This is getting complicated, let's make a table:
5361 *
5362 * ino_c ino_s fname_c fname_s differ =
5363 *
5364 * both files exist -> compare inode numbers:
5365 * != 0 != 0 X X ino_c != ino_s
5366 *
5367 * inode number(s) unknown, file names available -> compare file names
5368 * == 0 X OK OK fname_c != fname_s
5369 * X == 0 OK OK fname_c != fname_s
5370 *
5371 * current file doesn't exist, file for swap file exist, file name(s) not
5372 * available -> probably different
5373 * == 0 != 0 FAIL X TRUE
5374 * == 0 != 0 X FAIL TRUE
5375 *
5376 * current file exists, inode for swap unknown, file name(s) not
5377 * available -> probably different
5378 * != 0 == 0 FAIL X TRUE
5379 * != 0 == 0 X FAIL TRUE
5380 *
5381 * current file doesn't exist, inode for swap unknown, one file name not
5382 * available -> probably different
5383 * == 0 == 0 FAIL OK TRUE
5384 * == 0 == 0 OK FAIL TRUE
5385 *
5386 * current file doesn't exist, inode for swap unknown, both file names not
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005387 * available -> compare file names
5388 * == 0 == 0 FAIL FAIL fname_c != fname_s
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 *
5390 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
5391 * can't be changed without making the block 0 incompatible with 32 bit
5392 * versions.
5393 */
5394
5395 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005396fnamecmp_ino(
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005397 char_u *fname_c, // current file name
5398 char_u *fname_s, // file name from swap file
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005399 long ino_block0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400{
Bram Moolenaar8767f522016-07-01 17:17:39 +02005401 stat_T st;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005402 ino_t ino_c = 0; // ino of current file
5403 ino_t ino_s; // ino of file from swap file
5404 char_u buf_c[MAXPATHL]; // full path of fname_c
5405 char_u buf_s[MAXPATHL]; // full path of fname_s
5406 int retval_c; // flag: buf_c valid
5407 int retval_s; // flag: buf_s valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408
5409 if (mch_stat((char *)fname_c, &st) == 0)
5410 ino_c = (ino_t)st.st_ino;
5411
5412 /*
5413 * First we try to get the inode from the file name, because the inode in
5414 * the swap file may be outdated. If that fails (e.g. this path is not
5415 * valid on this machine), use the inode from block 0.
5416 */
5417 if (mch_stat((char *)fname_s, &st) == 0)
5418 ino_s = (ino_t)st.st_ino;
5419 else
5420 ino_s = (ino_t)ino_block0;
5421
5422 if (ino_c && ino_s)
5423 return (ino_c != ino_s);
5424
5425 /*
5426 * One of the inode numbers is unknown, try a forced vim_FullName() and
5427 * compare the file names.
5428 */
5429 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
5430 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
5431 if (retval_c == OK && retval_s == OK)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005432 return STRCMP(buf_c, buf_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433
5434 /*
5435 * Can't compare inodes or file names, guess that the files are different,
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005436 * unless both appear not to exist at all, then compare with the file name
5437 * in the swap file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 */
5439 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
Bram Moolenaar8c3169c2018-05-12 17:04:12 +02005440 return STRCMP(fname_c, fname_s) != 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 return TRUE;
5442}
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005443#endif // CHECK_INODE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444
5445/*
5446 * Move a long integer into a four byte character array.
5447 * Used for machine independency in block zero.
5448 */
5449 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005450long_to_char(long n, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451{
5452 s[0] = (char_u)(n & 0xff);
5453 n = (unsigned)n >> 8;
5454 s[1] = (char_u)(n & 0xff);
5455 n = (unsigned)n >> 8;
5456 s[2] = (char_u)(n & 0xff);
5457 n = (unsigned)n >> 8;
5458 s[3] = (char_u)(n & 0xff);
5459}
5460
5461 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005462char_to_long(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005463{
5464 long retval;
5465
5466 retval = s[3];
5467 retval <<= 8;
5468 retval |= s[2];
5469 retval <<= 8;
5470 retval |= s[1];
5471 retval <<= 8;
5472 retval |= s[0];
5473
5474 return retval;
5475}
5476
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005477/*
5478 * Set the flags in the first block of the swap file:
5479 * - file is modified or not: buf->b_changed
5480 * - 'fileformat'
5481 * - 'fileencoding'
5482 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005484ml_setflags(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485{
5486 bhdr_T *hp;
5487 ZERO_BL *b0p;
5488
5489 if (!buf->b_ml.ml_mfp)
5490 return;
5491 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
5492 {
5493 if (hp->bh_bnum == 0)
5494 {
5495 b0p = (ZERO_BL *)(hp->bh_data);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005496 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
5497 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
5498 | (get_fileformat(buf) + 1);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005499 add_b0_fenc(b0p, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 hp->bh_flags |= BH_DIRTY;
5501 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
5502 break;
5503 }
5504 }
5505}
5506
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005507#if defined(FEAT_CRYPT) || defined(PROTO)
5508/*
5509 * If "data" points to a data block encrypt the text in it and return a copy
5510 * in allocated memory. Return NULL when out of memory.
5511 * Otherwise return "data".
5512 */
5513 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005514ml_encrypt_data(
5515 memfile_T *mfp,
5516 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005517 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005518 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005519{
5520 DATA_BL *dp = (DATA_BL *)data;
5521 char_u *head_end;
5522 char_u *text_start;
5523 char_u *new_data;
5524 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005525 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005526
5527 if (dp->db_id != DATA_ID)
5528 return data;
5529
Bram Moolenaarbc563362015-06-09 18:35:25 +02005530 state = ml_crypt_prepare(mfp, offset, FALSE);
5531 if (state == NULL)
5532 return data;
5533
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005534 new_data = alloc(size);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005535 if (new_data == NULL)
5536 return NULL;
5537 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5538 text_start = (char_u *)dp + dp->db_txt_start;
5539 text_len = size - dp->db_txt_start;
5540
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005541 // Copy the header and the text.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005542 mch_memmove(new_data, dp, head_end - (char_u *)dp);
5543
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005544 // Encrypt the text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02005545 crypt_encode(state, text_start, text_len, new_data + dp->db_txt_start,
5546 FALSE);
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005547 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005548
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005549 // Clear the gap.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005550 if (head_end < text_start)
5551 vim_memset(new_data + (head_end - data), 0, text_start - head_end);
5552
5553 return new_data;
5554}
5555
5556/*
Bram Moolenaarbc563362015-06-09 18:35:25 +02005557 * Decrypt the text in "data" if it points to an encrypted data block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005558 */
5559 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005560ml_decrypt_data(
5561 memfile_T *mfp,
5562 char_u *data,
Bram Moolenaar8767f522016-07-01 17:17:39 +02005563 off_T offset,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005564 unsigned size)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005565{
5566 DATA_BL *dp = (DATA_BL *)data;
5567 char_u *head_end;
5568 char_u *text_start;
5569 int text_len;
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005570 cryptstate_T *state;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005571
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00005572 if (dp->db_id != DATA_ID)
5573 return;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005574
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00005575 head_end = (char_u *)(&dp->db_index[dp->db_line_count]);
5576 text_start = (char_u *)dp + dp->db_txt_start;
5577 text_len = dp->db_txt_end - dp->db_txt_start;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005578
Yegappan Lakshmanane8575982023-01-14 12:32:28 +00005579 if (head_end > text_start || dp->db_txt_start > size
5580 || dp->db_txt_end > size)
5581 return; // data was messed up
5582
5583 state = ml_crypt_prepare(mfp, offset, TRUE);
5584 if (state == NULL)
5585 return;
5586
5587 // Decrypt the text in place.
5588 crypt_decode_inplace(state, text_start, text_len, FALSE);
5589 crypt_free_state(state);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005590}
5591
5592/*
5593 * Prepare for encryption/decryption, using the key, seed and offset.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005594 * Return an allocated cryptstate_T *.
Christian Brabandtaae58342023-04-23 17:50:22 +01005595 * Note: Encryption not supported for SODIUM
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005596 */
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005597 static cryptstate_T *
Bram Moolenaar8767f522016-07-01 17:17:39 +02005598ml_crypt_prepare(memfile_T *mfp, off_T offset, int reading)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005599{
5600 buf_T *buf = mfp->mf_buffer;
5601 char_u salt[50];
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005602 int method_nr;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005603 char_u *key;
Christian Brabandtaae58342023-04-23 17:50:22 +01005604 crypt_arg_T arg;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005605
Christian Brabandtaae58342023-04-23 17:50:22 +01005606 CLEAR_FIELD(arg);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005607 if (reading && mfp->mf_old_key != NULL)
5608 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005609 // Reading back blocks with the previous key/method/seed.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005610 method_nr = mfp->mf_old_cm;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005611 key = mfp->mf_old_key;
Christian Brabandtaae58342023-04-23 17:50:22 +01005612 arg.cat_seed = mfp->mf_old_seed;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005613 }
5614 else
5615 {
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005616 method_nr = crypt_get_method_nr(buf);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005617 key = buf->b_p_key;
Christian Brabandtaae58342023-04-23 17:50:22 +01005618 arg.cat_seed = mfp->mf_seed;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005619 }
Christian Brabandtaae58342023-04-23 17:50:22 +01005620
Bram Moolenaarbc563362015-06-09 18:35:25 +02005621 if (*key == NUL)
5622 return NULL;
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005623
Christian Brabandt19e6c4f2023-06-27 18:57:10 +01005624 if (crypt_may_close_swapfile(buf, key, method_nr))
5625 return NULL;
5626
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005627 if (method_nr == CRYPT_M_ZIP)
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005628 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005629 // For PKzip: Append the offset to the key, so that we use a different
5630 // key for every block.
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005631 vim_snprintf((char *)salt, sizeof(salt), "%s%ld", key, (long)offset);
Christian Brabandtaae58342023-04-23 17:50:22 +01005632 arg.cat_seed = NULL;
5633 arg.cat_init_from_file = FALSE;
5634
5635 return crypt_create(method_nr, salt, &arg);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005636 }
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005637
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005638 // Using blowfish or better: add salt and seed. We use the byte offset
5639 // of the block for the salt.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02005640 vim_snprintf((char *)salt, sizeof(salt), "%ld", (long)offset);
Christian Brabandtaae58342023-04-23 17:50:22 +01005641
5642 arg.cat_salt = salt;
5643 arg.cat_salt_len = (int)STRLEN(salt);
5644 arg.cat_seed_len = MF_SEED_LEN;
5645 arg.cat_add_len = 0;
5646 arg.cat_add = NULL;
5647 arg.cat_init_from_file = FALSE;
5648
5649 return crypt_create(method_nr, key, &arg);
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02005650}
5651
5652#endif
5653
5654
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655#if defined(FEAT_BYTEOFF) || defined(PROTO)
5656
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005657#define MLCS_MAXL 800 // max no of lines in chunk
5658#define MLCS_MINL 400 // should be half of MLCS_MAXL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659
5660/*
Bram Moolenaar0ad014c2010-07-25 14:00:46 +02005661 * Keep information for finding byte offset of a line, updtype may be one of:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
5663 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
5664 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
5665 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
5666 */
5667 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005668ml_updatechunk(
5669 buf_T *buf,
5670 linenr_T line,
5671 long len,
5672 int updtype)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673{
5674 static buf_T *ml_upd_lastbuf = NULL;
5675 static linenr_T ml_upd_lastline;
5676 static linenr_T ml_upd_lastcurline;
5677 static int ml_upd_lastcurix;
5678
5679 linenr_T curline = ml_upd_lastcurline;
5680 int curix = ml_upd_lastcurix;
5681 long size;
5682 chunksize_T *curchnk;
5683 int rest;
5684 bhdr_T *hp;
5685 DATA_BL *dp;
5686
5687 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
5688 return;
5689 if (buf->b_ml.ml_chunksize == NULL)
5690 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005691 buf->b_ml.ml_chunksize = ALLOC_MULT(chunksize_T, 100);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 if (buf->b_ml.ml_chunksize == NULL)
5693 {
5694 buf->b_ml.ml_usedchunks = -1;
5695 return;
5696 }
5697 buf->b_ml.ml_numchunks = 100;
5698 buf->b_ml.ml_usedchunks = 1;
5699 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
5700 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
5701 }
5702
5703 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
5704 {
5705 /*
5706 * First line in empty buffer from ml_flush_line() -- reset
5707 */
5708 buf->b_ml.ml_usedchunks = 1;
5709 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01005710 buf->b_ml.ml_chunksize[0].mlcs_totalsize = (long)buf->b_ml.ml_line_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 return;
5712 }
5713
5714 /*
5715 * Find chunk that our line belongs to, curline will be at start of the
5716 * chunk.
5717 */
5718 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
5719 || updtype != ML_CHNK_ADDLINE)
5720 {
5721 for (curline = 1, curix = 0;
5722 curix < buf->b_ml.ml_usedchunks - 1
5723 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5724 curix++)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 }
Bram Moolenaara9a8e042018-10-30 22:15:55 +01005727 else if (curix < buf->b_ml.ml_usedchunks - 1
5728 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005730 // Adjust cached curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5732 curix++;
5733 }
5734 curchnk = buf->b_ml.ml_chunksize + curix;
5735
5736 if (updtype == ML_CHNK_DELLINE)
Bram Moolenaar5a6404c2006-11-01 17:12:57 +00005737 len = -len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 curchnk->mlcs_totalsize += len;
5739 if (updtype == ML_CHNK_ADDLINE)
5740 {
5741 curchnk->mlcs_numlines++;
5742
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005743 // May resize here so we don't have to do it in both cases below
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
5745 {
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005746 chunksize_T *t_chunksize = buf->b_ml.ml_chunksize;
5747
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
Bram Moolenaar51b6eb42020-08-22 15:19:18 +02005749 buf->b_ml.ml_chunksize = vim_realloc(buf->b_ml.ml_chunksize,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
5751 if (buf->b_ml.ml_chunksize == NULL)
5752 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005753 // Hmmmm, Give up on offset for this buffer
Bram Moolenaar9abd5c62015-02-10 18:34:01 +01005754 vim_free(t_chunksize);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 buf->b_ml.ml_usedchunks = -1;
5756 return;
5757 }
5758 }
5759
5760 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
5761 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005762 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 int idx;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005764 int end_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 int text_end;
5766 int linecnt;
5767
5768 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
5769 buf->b_ml.ml_chunksize + curix,
5770 (buf->b_ml.ml_usedchunks - curix) *
5771 sizeof(chunksize_T));
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005772 // Compute length of first half of lines in the split chunk
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 size = 0;
5774 linecnt = 0;
5775 while (curline < buf->b_ml.ml_line_count
5776 && linecnt < MLCS_MINL)
5777 {
5778 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5779 {
5780 buf->b_ml.ml_usedchunks = -1;
5781 return;
5782 }
5783 dp = (DATA_BL *)(hp->bh_data);
5784 count = (long)(buf->b_ml.ml_locked_high) -
5785 (long)(buf->b_ml.ml_locked_low) + 1;
5786 idx = curline - buf->b_ml.ml_locked_low;
5787 curline = buf->b_ml.ml_locked_high + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005788
5789 // compute index of last line to use in this MEMLINE
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 rest = count - idx;
5791 if (linecnt + rest > MLCS_MINL)
5792 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005793 end_idx = idx + MLCS_MINL - linecnt - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 linecnt = MLCS_MINL;
5795 }
5796 else
5797 {
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005798 end_idx = count - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 linecnt += rest;
5800 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005801#ifdef FEAT_PROP_POPUP
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005802 if (buf->b_has_textprop)
5803 {
5804 int i;
5805
5806 // We cannot use the text pointers to get the text length,
5807 // the text prop info would also be counted. Go over the
5808 // lines.
5809 for (i = end_idx; i < idx; ++i)
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005810 size += (int)STRLEN((char_u *)dp
5811 + (dp->db_index[i] & DB_INDEX_MASK)) + 1;
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005812 }
5813 else
5814#endif
5815 {
Bram Moolenaar14c75302021-08-15 14:28:40 +02005816 if (idx == 0) // first line in block, text at the end
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005817 text_end = dp->db_txt_end;
5818 else
5819 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005820 size += text_end
5821 - ((dp->db_index[end_idx]) & DB_INDEX_MASK);
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01005822 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 }
5824 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
5825 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
5826 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
5827 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
5828 buf->b_ml.ml_usedchunks++;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005829 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 return;
5831 }
5832 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
5833 && curix == buf->b_ml.ml_usedchunks - 1
5834 && buf->b_ml.ml_line_count - line <= 1)
5835 {
5836 /*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01005837 * We are in the last chunk and it is cheap to create a new one
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 * after this. Do it now to avoid the loop above later on
5839 */
5840 curchnk = buf->b_ml.ml_chunksize + curix + 1;
5841 buf->b_ml.ml_usedchunks++;
5842 if (line == buf->b_ml.ml_line_count)
5843 {
5844 curchnk->mlcs_numlines = 0;
5845 curchnk->mlcs_totalsize = 0;
5846 }
5847 else
5848 {
5849 /*
5850 * Line is just prior to last, move count for last
5851 * This is the common case when loading a new file
5852 */
5853 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
5854 if (hp == NULL)
5855 {
5856 buf->b_ml.ml_usedchunks = -1;
5857 return;
5858 }
5859 dp = (DATA_BL *)(hp->bh_data);
5860 if (dp->db_line_count == 1)
5861 rest = dp->db_txt_end - dp->db_txt_start;
5862 else
5863 rest =
5864 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
5865 - dp->db_txt_start;
5866 curchnk->mlcs_totalsize = rest;
5867 curchnk->mlcs_numlines = 1;
5868 curchnk[-1].mlcs_totalsize -= rest;
5869 curchnk[-1].mlcs_numlines -= 1;
5870 }
5871 }
5872 }
5873 else if (updtype == ML_CHNK_DELLINE)
5874 {
5875 curchnk->mlcs_numlines--;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005876 ml_upd_lastbuf = NULL; // Force recalc of curix & curline
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005877 if (curix < buf->b_ml.ml_usedchunks - 1
5878 && curchnk->mlcs_numlines + curchnk[1].mlcs_numlines
5879 <= MLCS_MINL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 {
5881 curix++;
5882 curchnk = buf->b_ml.ml_chunksize + curix;
5883 }
5884 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
5885 {
5886 buf->b_ml.ml_usedchunks--;
5887 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
5888 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
5889 return;
5890 }
5891 else if (curix == 0 || (curchnk->mlcs_numlines > 10
Bram Moolenaare5a0e8c2022-08-09 21:37:55 +01005892 && curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines
5893 > MLCS_MINL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 {
5895 return;
5896 }
5897
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005898 // Collapse chunks
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
5900 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
5901 buf->b_ml.ml_usedchunks--;
5902 if (curix < buf->b_ml.ml_usedchunks)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 mch_memmove(buf->b_ml.ml_chunksize + curix,
5904 buf->b_ml.ml_chunksize + curix + 1,
5905 (buf->b_ml.ml_usedchunks - curix) *
5906 sizeof(chunksize_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 return;
5908 }
5909 ml_upd_lastbuf = buf;
5910 ml_upd_lastline = line;
5911 ml_upd_lastcurline = curline;
5912 ml_upd_lastcurix = curix;
5913}
5914
5915/*
5916 * Find offset for line or line with offset.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005917 * Find line with offset if "lnum" is 0; return remaining offset in offp
5918 * Find offset of line if "lnum" > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 * return -1 if information is not available
5920 */
5921 long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01005922ml_find_line_or_offset(buf_T *buf, linenr_T lnum, long *offp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923{
5924 linenr_T curline;
5925 int curix;
5926 long size;
5927 bhdr_T *hp;
5928 DATA_BL *dp;
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005929 int count; // number of entries in block
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 int idx;
5931 int start_idx;
5932 int text_end;
5933 long offset;
5934 int len;
5935 int ffdos = (get_fileformat(buf) == EOL_DOS);
5936 int extra = 0;
5937
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005938 // take care of cached line first
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005939 ml_flush_line(curbuf);
5940
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941 if (buf->b_ml.ml_usedchunks == -1
5942 || buf->b_ml.ml_chunksize == NULL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005943 || lnum < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 return -1;
5945
5946 if (offp == NULL)
5947 offset = 0;
5948 else
5949 offset = *offp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005950 if (lnum == 0 && offset <= 0)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005951 return 1; // Not a "find offset" and offset 0 _must_ be in line 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 /*
5953 * Find the last chunk before the one containing our line. Last chunk is
Bram Moolenaar14c75302021-08-15 14:28:40 +02005954 * special because it will never qualify.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 */
5956 curline = 1;
5957 curix = size = 0;
5958 while (curix < buf->b_ml.ml_usedchunks - 1
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005959 && ((lnum != 0
5960 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 || (offset != 0
5962 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
=?UTF-8?q?Dundar=20G=C3=B6c?=d5cec1f2022-01-29 15:19:23 +00005963 + (long)ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 {
5965 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5966 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
5967 if (offset && ffdos)
5968 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
5969 curix++;
5970 }
5971
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005972 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973 {
Bram Moolenaar59ff6402021-01-30 17:16:28 +01005974#ifdef FEAT_PROP_POPUP
5975 size_t textprop_total = 0;
5976#endif
5977
Bram Moolenaar071d4272004-06-13 20:20:40 +00005978 if (curline > buf->b_ml.ml_line_count
5979 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
5980 return -1;
5981 dp = (DATA_BL *)(hp->bh_data);
5982 count = (long)(buf->b_ml.ml_locked_high) -
5983 (long)(buf->b_ml.ml_locked_low) + 1;
5984 start_idx = idx = curline - buf->b_ml.ml_locked_low;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01005985 if (idx == 0) // first line in block, text at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 text_end = dp->db_txt_end;
5987 else
5988 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01005989 // Compute index of last line to use in this MEMLINE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005990 if (lnum != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005992 if (curline + (count - idx) >= lnum)
5993 idx += lnum - curline - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 else
5995 idx = count - 1;
5996 }
5997 else
5998 {
5999 extra = 0;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01006000 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 {
Bram Moolenaar9df53b62020-01-13 20:40:51 +01006002#ifdef FEAT_PROP_POPUP
Bram Moolenaar59ff6402021-01-30 17:16:28 +01006003 size_t textprop_size = 0;
6004
Bram Moolenaar9df53b62020-01-13 20:40:51 +01006005 if (buf->b_has_textprop)
6006 {
Bram Moolenaar59ff6402021-01-30 17:16:28 +01006007 char_u *l1, *l2;
6008
Bram Moolenaar9df53b62020-01-13 20:40:51 +01006009 // compensate for the extra bytes taken by textprops
6010 l1 = (char_u *)dp + ((dp->db_index[idx]) & DB_INDEX_MASK);
6011 l2 = (char_u *)dp + (idx == 0 ? dp->db_txt_end
6012 : ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
6013 textprop_size = (l2 - l1) - (STRLEN(l1) + 1);
6014 }
6015#endif
6016 if (!(offset >= size
6017 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
6018#ifdef FEAT_PROP_POPUP
Bram Moolenaar94b6fb72020-01-17 21:00:59 +01006019 - (long)(textprop_total + textprop_size)
Bram Moolenaar9df53b62020-01-13 20:40:51 +01006020#endif
6021 + ffdos))
6022 break;
6023
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 if (ffdos)
6025 size++;
Bram Moolenaar9df53b62020-01-13 20:40:51 +01006026#ifdef FEAT_PROP_POPUP
6027 textprop_total += textprop_size;
6028#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 if (idx == count - 1)
6030 {
6031 extra = 1;
6032 break;
6033 }
6034 idx++;
6035 }
6036 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01006037#ifdef FEAT_PROP_POPUP
Bram Moolenaar59ff6402021-01-30 17:16:28 +01006038 if (buf->b_has_textprop && lnum != 0)
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01006039 {
6040 int i;
6041
6042 // cannot use the db_index pointer, need to get the actual text
6043 // lengths.
6044 len = 0;
6045 for (i = start_idx; i <= idx; ++i)
Bram Moolenaar59ff6402021-01-30 17:16:28 +01006046 {
6047 char_u *p = (char_u *)dp + ((dp->db_index[i]) & DB_INDEX_MASK);
6048 len += (int)STRLEN(p) + 1;
6049 }
Bram Moolenaarb413d2e2018-12-25 23:15:46 +01006050 }
6051 else
6052#endif
Bram Moolenaar59ff6402021-01-30 17:16:28 +01006053 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK)
6054#ifdef FEAT_PROP_POPUP
6055 - (long)textprop_total
6056#endif
6057 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058 size += len;
6059 if (offset != 0 && size >= offset)
6060 {
6061 if (size + ffdos == offset)
6062 *offp = 0;
6063 else if (idx == start_idx)
6064 *offp = offset - size + len;
6065 else
6066 *offp = offset - size + len
Bram Moolenaar59ff6402021-01-30 17:16:28 +01006067 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK))
6068#ifdef FEAT_PROP_POPUP
6069 + (long)textprop_total
6070#endif
6071 ;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 curline += idx - start_idx + extra;
6073 if (curline > buf->b_ml.ml_line_count)
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006074 return -1; // exactly one byte beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 return curline;
6076 }
6077 curline = buf->b_ml.ml_locked_high + 1;
6078 }
6079
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00006080 if (lnum != 0)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006081 {
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006082 // Count extra CR characters.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006083 if (ffdos)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00006084 size += lnum - 1;
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006085
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006086 // Don't count the last line break if 'noeol' and ('bin' or
6087 // 'nofixeol').
Bram Moolenaar34d72d42015-07-17 14:18:08 +02006088 if ((!buf->b_p_fixeol || buf->b_p_bin) && !buf->b_p_eol
Bram Moolenaarc26f7c62018-08-20 22:53:04 +02006089 && lnum > buf->b_ml.ml_line_count)
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006090 size -= ffdos + 1;
6091 }
6092
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 return size;
6094}
6095
6096/*
6097 * Goto byte in buffer with offset 'cnt'.
6098 */
6099 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01006100goto_byte(long cnt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101{
6102 long boff = cnt;
6103 linenr_T lnum;
6104
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006105 ml_flush_line(curbuf); // cached line may be dirty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 setpcmark();
6107 if (boff)
6108 --boff;
6109 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006110 if (lnum < 1) // past the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 {
6112 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
6113 curwin->w_curswant = MAXCOL;
6114 coladvance((colnr_T)MAXCOL);
6115 }
6116 else
6117 {
6118 curwin->w_cursor.lnum = lnum;
6119 curwin->w_cursor.col = (colnr_T)boff;
Bram Moolenaar943d2b52005-12-02 00:50:49 +00006120 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 curwin->w_set_curswant = TRUE;
6122 }
6123 check_cursor();
6124
Bram Moolenaar4ba37b52019-12-04 21:57:43 +01006125 // Make sure the cursor is on the first byte of a multi-byte char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 if (has_mbyte)
6127 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128}
6129#endif