Add MMRenderer user default
[MacVim.git] / src / memline.c
blobfacdeb62e3d6bbe99182d29a2bb2d2e43656bd1e
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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 */
10 /* for debugging */
11 /* #define CHECK(c, s) if (c) EMSG(s) */
12 #define CHECK(c, s)
15 * memline.c: Contains the functions for appending, deleting and changing the
16 * 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.
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.
27 * Block nr 0 contains the block0 structure (see below).
29 * Block nr 1 is the first pointer block. It is the root of the tree.
30 * Other pointer blocks are branches.
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.
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().
45 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
46 # include "vimio.h" /* for mch_open(), must be before vim.h */
47 #endif
49 #include "vim.h"
51 #ifndef UNIX /* it's in os_unix.h for Unix */
52 # include <time.h>
53 #endif
55 #if defined(SASC) || defined(__amigaos4__)
56 # include <proto/dos.h> /* for Open() and Close() */
57 #endif
59 #ifdef HAVE_ERRNO_H
60 # include <errno.h>
61 #endif
63 typedef struct block0 ZERO_BL; /* contents of the first block */
64 typedef struct pointer_block PTR_BL; /* contents of a pointer block */
65 typedef struct data_block DATA_BL; /* contents of a data block */
66 typedef struct pointer_entry PTR_EN; /* block/line-count pair */
68 #define DATA_ID (('d' << 8) + 'a') /* data block id */
69 #define PTR_ID (('p' << 8) + 't') /* pointer block id */
70 #define BLOCK0_ID0 'b' /* block 0 id 0 */
71 #define BLOCK0_ID1 '0' /* block 0 id 1 */
74 * pointer to a block, used in a pointer block
76 struct pointer_entry
78 blocknr_T pe_bnum; /* block number */
79 linenr_T pe_line_count; /* number of lines in this branch */
80 linenr_T pe_old_lnum; /* lnum for this block (for recovery) */
81 int pe_page_count; /* number of pages in block pe_bnum */
85 * A pointer block contains a list of branches in the tree.
87 struct pointer_block
89 short_u pb_id; /* ID for pointer block: PTR_ID */
90 short_u pb_count; /* number of pointer in this block */
91 short_u pb_count_max; /* maximum value for pb_count */
92 PTR_EN pb_pointer[1]; /* list of pointers to blocks (actually longer)
93 * followed by empty space until end of page */
97 * A data block is a leaf in the tree.
99 * The text of the lines is at the end of the block. The text of the first line
100 * in the block is put at the end, the text of the second line in front of it,
101 * etc. Thus the order of the lines is the opposite of the line number.
103 struct data_block
105 short_u db_id; /* ID for data block: DATA_ID */
106 unsigned db_free; /* free space available */
107 unsigned db_txt_start; /* byte where text starts */
108 unsigned db_txt_end; /* byte just after data block */
109 linenr_T db_line_count; /* number of lines in this block */
110 unsigned db_index[1]; /* index for start of line (actually bigger)
111 * followed by empty space upto db_txt_start
112 * followed by the text in the lines until
113 * end of page */
117 * The low bits of db_index hold the actual index. The topmost bit is
118 * used for the global command to be able to mark a line.
119 * This method is not clean, but otherwise there would be at least one extra
120 * byte used for each line.
121 * The mark has to be in this place to keep it with the correct line when other
122 * lines are inserted or deleted.
124 #define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
125 #define DB_INDEX_MASK (~DB_MARKED)
127 #define INDEX_SIZE (sizeof(unsigned)) /* size of one db_index entry */
128 #define HEADER_SIZE (sizeof(DATA_BL) - INDEX_SIZE) /* size of data block header */
130 #define B0_FNAME_SIZE_ORG 900 /* what it was in older versions */
131 #define B0_FNAME_SIZE 898
132 #define B0_UNAME_SIZE 40
133 #define B0_HNAME_SIZE 40
135 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
136 * This won't detect a 64 bit machine that only swaps a byte in the top 32
137 * bits, but that is crazy anyway.
139 #define B0_MAGIC_LONG 0x30313233L
140 #define B0_MAGIC_INT 0x20212223L
141 #define B0_MAGIC_SHORT 0x10111213L
142 #define B0_MAGIC_CHAR 0x55
145 * Block zero holds all info about the swap file.
147 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
148 * swap files unusable!
150 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
152 * This block is built up of single bytes, to make it portable across
153 * different machines. b0_magic_* is used to check the byte order and size of
154 * variables, because the rest of the swap file is not portable.
156 struct block0
158 char_u b0_id[2]; /* id for block 0: BLOCK0_ID0 and BLOCK0_ID1 */
159 char_u b0_version[10]; /* Vim version string */
160 char_u b0_page_size[4];/* number of bytes per page */
161 char_u b0_mtime[4]; /* last modification time of file */
162 char_u b0_ino[4]; /* inode of b0_fname */
163 char_u b0_pid[4]; /* process id of creator (or 0) */
164 char_u b0_uname[B0_UNAME_SIZE]; /* name of user (uid if no name) */
165 char_u b0_hname[B0_HNAME_SIZE]; /* host name (if it has a name) */
166 char_u b0_fname[B0_FNAME_SIZE_ORG]; /* name of file being edited */
167 long b0_magic_long; /* check for byte order of long */
168 int b0_magic_int; /* check for byte order of int */
169 short b0_magic_short; /* check for byte order of short */
170 char_u b0_magic_char; /* check for last char */
174 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
175 * long file names in older versions of Vim they are invalid.
176 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
177 * when there is room, for very long file names it's omitted.
179 #define B0_DIRTY 0x55
180 #define b0_dirty b0_fname[B0_FNAME_SIZE_ORG-1]
183 * The b0_flags field is new in Vim 7.0.
185 #define b0_flags b0_fname[B0_FNAME_SIZE_ORG-2]
187 /* The lowest two bits contain the fileformat. Zero means it's not set
188 * (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
189 * EOL_MAC + 1. */
190 #define B0_FF_MASK 3
192 /* Swap file is in directory of edited file. Used to find the file from
193 * different mount points. */
194 #define B0_SAME_DIR 4
196 /* The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
197 * When empty there is only the NUL. */
198 #define B0_HAS_FENC 8
200 #define STACK_INCR 5 /* nr of entries added to ml_stack at a time */
203 * The line number where the first mark may be is remembered.
204 * If it is 0 there are no marks at all.
205 * (always used for the current buffer only, no buffer change possible while
206 * executing a global command).
208 static linenr_T lowest_marked = 0;
211 * arguments for ml_find_line()
213 #define ML_DELETE 0x11 /* delete line */
214 #define ML_INSERT 0x12 /* insert line */
215 #define ML_FIND 0x13 /* just find the line */
216 #define ML_FLUSH 0x02 /* flush locked block */
217 #define ML_SIMPLE(x) (x & 0x10) /* DEL, INS or FIND */
219 static void ml_upd_block0 __ARGS((buf_T *buf, int set_fname));
220 static void set_b0_fname __ARGS((ZERO_BL *, buf_T *buf));
221 static void set_b0_dir_flag __ARGS((ZERO_BL *b0p, buf_T *buf));
222 #ifdef FEAT_MBYTE
223 static void add_b0_fenc __ARGS((ZERO_BL *b0p, buf_T *buf));
224 #endif
225 static time_t swapfile_info __ARGS((char_u *));
226 static int recov_file_names __ARGS((char_u **, char_u *, int prepend_dot));
227 static int ml_append_int __ARGS((buf_T *, linenr_T, char_u *, colnr_T, int, int));
228 static int ml_delete_int __ARGS((buf_T *, linenr_T, int));
229 static char_u *findswapname __ARGS((buf_T *, char_u **, char_u *));
230 static void ml_flush_line __ARGS((buf_T *));
231 static bhdr_T *ml_new_data __ARGS((memfile_T *, int, int));
232 static bhdr_T *ml_new_ptr __ARGS((memfile_T *));
233 static bhdr_T *ml_find_line __ARGS((buf_T *, linenr_T, int));
234 static int ml_add_stack __ARGS((buf_T *));
235 static void ml_lineadd __ARGS((buf_T *, int));
236 static int b0_magic_wrong __ARGS((ZERO_BL *));
237 #ifdef CHECK_INODE
238 static int fnamecmp_ino __ARGS((char_u *, char_u *, long));
239 #endif
240 static void long_to_char __ARGS((long, char_u *));
241 static long char_to_long __ARGS((char_u *));
242 #if defined(UNIX) || defined(WIN3264)
243 static char_u *make_percent_swname __ARGS((char_u *dir, char_u *name));
244 #endif
245 #ifdef FEAT_BYTEOFF
246 static void ml_updatechunk __ARGS((buf_T *buf, long line, long len, int updtype));
247 #endif
250 * Open a new memline for "buf".
252 * Return FAIL for failure, OK otherwise.
255 ml_open(buf)
256 buf_T *buf;
258 memfile_T *mfp;
259 bhdr_T *hp = NULL;
260 ZERO_BL *b0p;
261 PTR_BL *pp;
262 DATA_BL *dp;
265 * init fields in memline struct
267 buf->b_ml.ml_stack_size = 0; /* no stack yet */
268 buf->b_ml.ml_stack = NULL; /* no stack yet */
269 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
270 buf->b_ml.ml_locked = NULL; /* no cached block */
271 buf->b_ml.ml_line_lnum = 0; /* no cached line */
272 #ifdef FEAT_BYTEOFF
273 buf->b_ml.ml_chunksize = NULL;
274 #endif
277 * When 'updatecount' is non-zero swap file may be opened later.
279 if (p_uc && buf->b_p_swf)
280 buf->b_may_swap = TRUE;
281 else
282 buf->b_may_swap = FALSE;
285 * Open the memfile. No swap file is created yet.
287 mfp = mf_open(NULL, 0);
288 if (mfp == NULL)
289 goto error;
291 buf->b_ml.ml_mfp = mfp;
292 buf->b_ml.ml_flags = ML_EMPTY;
293 buf->b_ml.ml_line_count = 1;
294 #ifdef FEAT_LINEBREAK
295 curwin->w_nrwidth_line_count = 0;
296 #endif
298 #if defined(MSDOS) && !defined(DJGPP)
299 /* for 16 bit MS-DOS create a swapfile now, because we run out of
300 * memory very quickly */
301 if (p_uc != 0)
302 ml_open_file(buf);
303 #endif
306 * fill block0 struct and write page 0
308 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
309 goto error;
310 if (hp->bh_bnum != 0)
312 EMSG(_("E298: Didn't get block nr 0?"));
313 goto error;
315 b0p = (ZERO_BL *)(hp->bh_data);
317 b0p->b0_id[0] = BLOCK0_ID0;
318 b0p->b0_id[1] = BLOCK0_ID1;
319 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
320 b0p->b0_magic_int = (int)B0_MAGIC_INT;
321 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
322 b0p->b0_magic_char = B0_MAGIC_CHAR;
323 STRNCPY(b0p->b0_version, "VIM ", 4);
324 STRNCPY(b0p->b0_version + 4, Version, 6);
325 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
327 #ifdef FEAT_SPELL
328 if (!buf->b_spell)
329 #endif
331 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
332 b0p->b0_flags = get_fileformat(buf) + 1;
333 set_b0_fname(b0p, buf);
334 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
335 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
336 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
337 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
338 long_to_char(mch_get_pid(), b0p->b0_pid);
342 * Always sync block number 0 to disk, so we can check the file name in
343 * the swap file in findswapname(). Don't do this for help files though
344 * and spell buffer though.
345 * Only works when there's a swapfile, otherwise it's done when the file
346 * is created.
348 mf_put(mfp, hp, TRUE, FALSE);
349 if (!buf->b_help && !B_SPELL(buf))
350 (void)mf_sync(mfp, 0);
353 * Fill in root pointer block and write page 1.
355 if ((hp = ml_new_ptr(mfp)) == NULL)
356 goto error;
357 if (hp->bh_bnum != 1)
359 EMSG(_("E298: Didn't get block nr 1?"));
360 goto error;
362 pp = (PTR_BL *)(hp->bh_data);
363 pp->pb_count = 1;
364 pp->pb_pointer[0].pe_bnum = 2;
365 pp->pb_pointer[0].pe_page_count = 1;
366 pp->pb_pointer[0].pe_old_lnum = 1;
367 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
368 mf_put(mfp, hp, TRUE, FALSE);
371 * Allocate first data block and create an empty line 1.
373 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
374 goto error;
375 if (hp->bh_bnum != 2)
377 EMSG(_("E298: Didn't get block nr 2?"));
378 goto error;
381 dp = (DATA_BL *)(hp->bh_data);
382 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
383 dp->db_free -= 1 + INDEX_SIZE;
384 dp->db_line_count = 1;
385 *((char_u *)dp + dp->db_txt_start) = NUL; /* emtpy line */
387 return OK;
389 error:
390 if (mfp != NULL)
392 if (hp)
393 mf_put(mfp, hp, FALSE, FALSE);
394 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
396 buf->b_ml.ml_mfp = NULL;
397 return FAIL;
401 * ml_setname() is called when the file name of "buf" has been changed.
402 * It may rename the swap file.
404 void
405 ml_setname(buf)
406 buf_T *buf;
408 int success = FALSE;
409 memfile_T *mfp;
410 char_u *fname;
411 char_u *dirp;
412 #if defined(MSDOS) || defined(MSWIN)
413 char_u *p;
414 #endif
416 mfp = buf->b_ml.ml_mfp;
417 if (mfp->mf_fd < 0) /* there is no swap file yet */
420 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
421 * For help files we will make a swap file now.
423 if (p_uc != 0)
424 ml_open_file(buf); /* create a swap file */
425 return;
429 * Try all directories in the 'directory' option.
431 dirp = p_dir;
432 for (;;)
434 if (*dirp == NUL) /* tried all directories, fail */
435 break;
436 fname = findswapname(buf, &dirp, mfp->mf_fname);
437 /* alloc's fname */
438 if (fname == NULL) /* no file name found for this dir */
439 continue;
441 #if defined(MSDOS) || defined(MSWIN)
443 * Set full pathname for swap file now, because a ":!cd dir" may
444 * change directory without us knowing it.
446 p = FullName_save(fname, FALSE);
447 vim_free(fname);
448 fname = p;
449 if (fname == NULL)
450 continue;
451 #endif
452 /* if the file name is the same we don't have to do anything */
453 if (fnamecmp(fname, mfp->mf_fname) == 0)
455 vim_free(fname);
456 success = TRUE;
457 break;
459 /* need to close the swap file before renaming */
460 if (mfp->mf_fd >= 0)
462 close(mfp->mf_fd);
463 mfp->mf_fd = -1;
466 /* try to rename the swap file */
467 if (vim_rename(mfp->mf_fname, fname) == 0)
469 success = TRUE;
470 vim_free(mfp->mf_fname);
471 mfp->mf_fname = fname;
472 vim_free(mfp->mf_ffname);
473 #if defined(MSDOS) || defined(MSWIN)
474 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
475 #else
476 mf_set_ffname(mfp);
477 #endif
478 ml_upd_block0(buf, FALSE);
479 break;
481 vim_free(fname); /* this fname didn't work, try another */
484 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
486 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
487 if (mfp->mf_fd < 0)
489 /* could not (re)open the swap file, what can we do???? */
490 EMSG(_("E301: Oops, lost the swap file!!!"));
491 return;
494 if (!success)
495 EMSG(_("E302: Could not rename swap file"));
499 * Open a file for the memfile for all buffers that are not readonly or have
500 * been modified.
501 * Used when 'updatecount' changes from zero to non-zero.
503 void
504 ml_open_files()
506 buf_T *buf;
508 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
509 if (!buf->b_p_ro || buf->b_changed)
510 ml_open_file(buf);
514 * Open a swap file for an existing memfile, if there is no swap file yet.
515 * If we are unable to find a file name, mf_fname will be NULL
516 * and the memfile will be in memory only (no recovery possible).
518 void
519 ml_open_file(buf)
520 buf_T *buf;
522 memfile_T *mfp;
523 char_u *fname;
524 char_u *dirp;
526 mfp = buf->b_ml.ml_mfp;
527 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
528 return; /* nothing to do */
530 #ifdef FEAT_SPELL
531 /* For a spell buffer use a temp file name. */
532 if (buf->b_spell)
534 fname = vim_tempname('s');
535 if (fname != NULL)
536 (void)mf_open_file(mfp, fname); /* consumes fname! */
537 buf->b_may_swap = FALSE;
538 return;
540 #endif
543 * Try all directories in 'directory' option.
545 dirp = p_dir;
546 for (;;)
548 if (*dirp == NUL)
549 break;
550 /* There is a small chance that between chosing the swap file name and
551 * creating it, another Vim creates the file. In that case the
552 * creation will fail and we will use another directory. */
553 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
554 if (fname == NULL)
555 continue;
556 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
558 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
560 * set full pathname for swap file now, because a ":!cd dir" may
561 * change directory without us knowing it.
563 mf_fullname(mfp);
564 #endif
565 ml_upd_block0(buf, FALSE);
567 /* Flush block zero, so others can read it */
568 if (mf_sync(mfp, MFS_ZERO) == OK)
570 /* Mark all blocks that should be in the swapfile as dirty.
571 * Needed for when the 'swapfile' option was reset, so that
572 * the swap file was deleted, and then on again. */
573 mf_set_dirty(mfp);
574 break;
576 /* Writing block 0 failed: close the file and try another dir */
577 mf_close_file(buf, FALSE);
581 if (mfp->mf_fname == NULL) /* Failed! */
583 need_wait_return = TRUE; /* call wait_return later */
584 ++no_wait_return;
585 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
586 buf_spname(buf) != NULL
587 ? (char_u *)buf_spname(buf)
588 : buf->b_fname);
589 --no_wait_return;
592 /* don't try to open a swap file again */
593 buf->b_may_swap = FALSE;
597 * If still need to create a swap file, and starting to edit a not-readonly
598 * file, or reading into an existing buffer, create a swap file now.
600 void
601 check_need_swap(newfile)
602 int newfile; /* reading file into new buffer */
604 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
605 ml_open_file(curbuf);
609 * Close memline for buffer 'buf'.
610 * If 'del_file' is TRUE, delete the swap file
612 void
613 ml_close(buf, del_file)
614 buf_T *buf;
615 int del_file;
617 if (buf->b_ml.ml_mfp == NULL) /* not open */
618 return;
619 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
620 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
621 vim_free(buf->b_ml.ml_line_ptr);
622 vim_free(buf->b_ml.ml_stack);
623 #ifdef FEAT_BYTEOFF
624 vim_free(buf->b_ml.ml_chunksize);
625 buf->b_ml.ml_chunksize = NULL;
626 #endif
627 buf->b_ml.ml_mfp = NULL;
629 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
630 * this buffer is loaded. */
631 buf->b_flags &= ~BF_RECOVERED;
635 * Close all existing memlines and memfiles.
636 * Only used when exiting.
637 * When 'del_file' is TRUE, delete the memfiles.
638 * But don't delete files that were ":preserve"d when we are POSIX compatible.
640 void
641 ml_close_all(del_file)
642 int del_file;
644 buf_T *buf;
646 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
647 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
648 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
649 #ifdef TEMPDIRNAMES
650 vim_deltempdir(); /* delete created temp directory */
651 #endif
655 * Close all memfiles for not modified buffers.
656 * Only use just before exiting!
658 void
659 ml_close_notmod()
661 buf_T *buf;
663 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
664 if (!bufIsChanged(buf))
665 ml_close(buf, TRUE); /* close all not-modified buffers */
669 * Update the timestamp in the .swp file.
670 * Used when the file has been written.
672 void
673 ml_timestamp(buf)
674 buf_T *buf;
676 ml_upd_block0(buf, TRUE);
680 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
682 static void
683 ml_upd_block0(buf, set_fname)
684 buf_T *buf;
685 int set_fname;
687 memfile_T *mfp;
688 bhdr_T *hp;
689 ZERO_BL *b0p;
691 mfp = buf->b_ml.ml_mfp;
692 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
693 return;
694 b0p = (ZERO_BL *)(hp->bh_data);
695 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
696 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
697 else
699 if (set_fname)
700 set_b0_fname(b0p, buf);
701 else
702 set_b0_dir_flag(b0p, buf);
704 mf_put(mfp, hp, TRUE, FALSE);
708 * Write file name and timestamp into block 0 of a swap file.
709 * Also set buf->b_mtime.
710 * Don't use NameBuff[]!!!
712 static void
713 set_b0_fname(b0p, buf)
714 ZERO_BL *b0p;
715 buf_T *buf;
717 struct stat st;
719 if (buf->b_ffname == NULL)
720 b0p->b0_fname[0] = NUL;
721 else
723 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
724 /* Systems that cannot translate "~user" back into a path: copy the
725 * file name unmodified. Do use slashes instead of backslashes for
726 * portability. */
727 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
728 # ifdef BACKSLASH_IN_FILENAME
729 forward_slash(b0p->b0_fname);
730 # endif
731 #else
732 size_t flen, ulen;
733 char_u uname[B0_UNAME_SIZE];
736 * For a file under the home directory of the current user, we try to
737 * replace the home directory path with "~user". This helps when
738 * editing the same file on different machines over a network.
739 * First replace home dir path with "~/" with home_replace().
740 * Then insert the user name to get "~user/".
742 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
743 if (b0p->b0_fname[0] == '~')
745 flen = STRLEN(b0p->b0_fname);
746 /* If there is no user name or it is too long, don't use "~/" */
747 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
748 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
749 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
750 else
752 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
753 mch_memmove(b0p->b0_fname + 1, uname, ulen);
756 #endif
757 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
759 long_to_char((long)st.st_mtime, b0p->b0_mtime);
760 #ifdef CHECK_INODE
761 long_to_char((long)st.st_ino, b0p->b0_ino);
762 #endif
763 buf_store_time(buf, &st, buf->b_ffname);
764 buf->b_mtime_read = buf->b_mtime;
766 else
768 long_to_char(0L, b0p->b0_mtime);
769 #ifdef CHECK_INODE
770 long_to_char(0L, b0p->b0_ino);
771 #endif
772 buf->b_mtime = 0;
773 buf->b_mtime_read = 0;
774 buf->b_orig_size = 0;
775 buf->b_orig_mode = 0;
779 #ifdef FEAT_MBYTE
780 /* Also add the 'fileencoding' if there is room. */
781 add_b0_fenc(b0p, curbuf);
782 #endif
786 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
787 * swapfile for "buf" are in the same directory.
788 * This is fail safe: if we are not sure the directories are equal the flag is
789 * not set.
791 static void
792 set_b0_dir_flag(b0p, buf)
793 ZERO_BL *b0p;
794 buf_T *buf;
796 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
797 b0p->b0_flags |= B0_SAME_DIR;
798 else
799 b0p->b0_flags &= ~B0_SAME_DIR;
802 #ifdef FEAT_MBYTE
804 * When there is room, add the 'fileencoding' to block zero.
806 static void
807 add_b0_fenc(b0p, buf)
808 ZERO_BL *b0p;
809 buf_T *buf;
811 int n;
813 n = (int)STRLEN(buf->b_p_fenc);
814 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
815 b0p->b0_flags &= ~B0_HAS_FENC;
816 else
818 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
819 (char *)buf->b_p_fenc, (size_t)n);
820 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
821 b0p->b0_flags |= B0_HAS_FENC;
824 #endif
828 * try to recover curbuf from the .swp file
830 void
831 ml_recover()
833 buf_T *buf = NULL;
834 memfile_T *mfp = NULL;
835 char_u *fname;
836 bhdr_T *hp = NULL;
837 ZERO_BL *b0p;
838 int b0_ff;
839 char_u *b0_fenc = NULL;
840 PTR_BL *pp;
841 DATA_BL *dp;
842 infoptr_T *ip;
843 blocknr_T bnum;
844 int page_count;
845 struct stat org_stat, swp_stat;
846 int len;
847 int directly;
848 linenr_T lnum;
849 char_u *p;
850 int i;
851 long error;
852 int cannot_open;
853 linenr_T line_count;
854 int has_error;
855 int idx;
856 int top;
857 int txt_start;
858 off_t size;
859 int called_from_main;
860 int serious_error = TRUE;
861 long mtime;
862 int attr;
864 recoverymode = TRUE;
865 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
866 attr = hl_attr(HLF_E);
869 * If the file name ends in ".s[uvw][a-z]" we assume this is the swap file.
870 * Otherwise a search is done to find the swap file(s).
872 fname = curbuf->b_fname;
873 if (fname == NULL) /* When there is no file name */
874 fname = (char_u *)"";
875 len = (int)STRLEN(fname);
876 if (len >= 4 &&
877 #if defined(VMS) || defined(RISCOS)
878 STRNICMP(fname + len - 4, "_s" , 2)
879 #else
880 STRNICMP(fname + len - 4, ".s" , 2)
881 #endif
882 == 0
883 && vim_strchr((char_u *)"UVWuvw", fname[len - 2]) != NULL
884 && ASCII_ISALPHA(fname[len - 1]))
886 directly = TRUE;
887 fname = vim_strsave(fname); /* make a copy for mf_open() */
889 else
891 directly = FALSE;
893 /* count the number of matching swap files */
894 len = recover_names(&fname, FALSE, 0);
895 if (len == 0) /* no swap files found */
897 EMSG2(_("E305: No swap file found for %s"), fname);
898 goto theend;
900 if (len == 1) /* one swap file found, use it */
901 i = 1;
902 else /* several swap files found, choose */
904 /* list the names of the swap files */
905 (void)recover_names(&fname, TRUE, 0);
906 msg_putchar('\n');
907 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
908 i = get_number(FALSE, NULL);
909 if (i < 1 || i > len)
910 goto theend;
912 /* get the swap file name that will be used */
913 (void)recover_names(&fname, FALSE, i);
915 if (fname == NULL)
916 goto theend; /* out of memory */
918 /* When called from main() still need to initialize storage structure */
919 if (called_from_main && ml_open(curbuf) == FAIL)
920 getout(1);
923 * allocate a buffer structure (only the memline in it is really used)
925 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
926 if (buf == NULL)
928 vim_free(fname);
929 goto theend;
933 * init fields in memline struct
935 buf->b_ml.ml_stack_size = 0; /* no stack yet */
936 buf->b_ml.ml_stack = NULL; /* no stack yet */
937 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
938 buf->b_ml.ml_line_lnum = 0; /* no cached line */
939 buf->b_ml.ml_locked = NULL; /* no locked block */
940 buf->b_ml.ml_flags = 0;
943 * open the memfile from the old swap file
945 p = vim_strsave(fname); /* save fname for the message
946 (mf_open() may free fname) */
947 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
948 if (mfp == NULL || mfp->mf_fd < 0)
950 if (p != NULL)
952 EMSG2(_("E306: Cannot open %s"), p);
953 vim_free(p);
955 goto theend;
957 vim_free(p);
958 buf->b_ml.ml_mfp = mfp;
961 * The page size set in mf_open() might be different from the page size
962 * used in the swap file, we must get it from block 0. But to read block
963 * 0 we need a page size. Use the minimal size for block 0 here, it will
964 * be set to the real value below.
966 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
969 * try to read block 0
971 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
973 msg_start();
974 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
975 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
976 MSG_PUTS_ATTR(
977 _("\nMaybe no changes were made or Vim did not update the swap file."),
978 attr | MSG_HIST);
979 msg_end();
980 goto theend;
982 b0p = (ZERO_BL *)(hp->bh_data);
983 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
985 msg_start();
986 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
987 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
988 MSG_HIST);
989 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
990 msg_end();
991 goto theend;
993 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
995 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
996 goto theend;
998 if (b0_magic_wrong(b0p))
1000 msg_start();
1001 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1002 #if defined(MSDOS) || defined(MSWIN)
1003 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1004 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1005 attr | MSG_HIST);
1006 else
1007 #endif
1008 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1009 attr | MSG_HIST);
1010 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1011 /* avoid going past the end of a currupted hostname */
1012 b0p->b0_fname[0] = NUL;
1013 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1014 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1015 msg_end();
1016 goto theend;
1020 * If we guessed the wrong page size, we have to recalculate the
1021 * highest block number in the file.
1023 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1025 unsigned previous_page_size = mfp->mf_page_size;
1027 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1028 if (mfp->mf_page_size < previous_page_size)
1030 msg_start();
1031 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1032 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1033 attr | MSG_HIST);
1034 msg_end();
1035 goto theend;
1037 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1038 mfp->mf_blocknr_max = 0; /* no file or empty file */
1039 else
1040 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1041 mfp->mf_infile_count = mfp->mf_blocknr_max;
1043 /* need to reallocate the memory used to store the data */
1044 p = alloc(mfp->mf_page_size);
1045 if (p == NULL)
1046 goto theend;
1047 mch_memmove(p, hp->bh_data, previous_page_size);
1048 vim_free(hp->bh_data);
1049 hp->bh_data = p;
1050 b0p = (ZERO_BL *)(hp->bh_data);
1054 * If .swp file name given directly, use name from swap file for buffer.
1056 if (directly)
1058 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1059 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1060 goto theend;
1063 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1064 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1066 if (buf_spname(curbuf) != NULL)
1067 STRCPY(NameBuff, buf_spname(curbuf));
1068 else
1069 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1070 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1071 msg_putchar('\n');
1074 * check date of swap file and original file
1076 mtime = char_to_long(b0p->b0_mtime);
1077 if (curbuf->b_ffname != NULL
1078 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1079 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1080 && org_stat.st_mtime > swp_stat.st_mtime)
1081 || org_stat.st_mtime != mtime))
1083 EMSG(_("E308: Warning: Original file may have been changed"));
1085 out_flush();
1087 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1088 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1089 if (b0p->b0_flags & B0_HAS_FENC)
1091 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1092 p > b0p->b0_fname && p[-1] != NUL; --p)
1094 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1097 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1098 hp = NULL;
1101 * Now that we are sure that the file is going to be recovered, clear the
1102 * contents of the current buffer.
1104 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1105 ml_delete((linenr_T)1, FALSE);
1108 * Try reading the original file to obtain the values of 'fileformat',
1109 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1111 if (curbuf->b_ffname != NULL)
1113 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1114 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1115 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1116 ml_delete((linenr_T)1, FALSE);
1119 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1120 if (b0_ff != 0)
1121 set_fileformat(b0_ff - 1, OPT_LOCAL);
1122 if (b0_fenc != NULL)
1124 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1125 vim_free(b0_fenc);
1127 unchanged(curbuf, TRUE);
1129 bnum = 1; /* start with block 1 */
1130 page_count = 1; /* which is 1 page */
1131 lnum = 0; /* append after line 0 in curbuf */
1132 line_count = 0;
1133 idx = 0; /* start with first index in block 1 */
1134 error = 0;
1135 buf->b_ml.ml_stack_top = 0;
1136 buf->b_ml.ml_stack = NULL;
1137 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1139 if (curbuf->b_ffname == NULL)
1140 cannot_open = TRUE;
1141 else
1142 cannot_open = FALSE;
1144 serious_error = FALSE;
1145 for ( ; !got_int; line_breakcheck())
1147 if (hp != NULL)
1148 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1151 * get block
1153 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1155 if (bnum == 1)
1157 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1158 goto theend;
1160 ++error;
1161 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1162 (colnr_T)0, TRUE);
1164 else /* there is a block */
1166 pp = (PTR_BL *)(hp->bh_data);
1167 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1169 /* check line count when using pointer block first time */
1170 if (idx == 0 && line_count != 0)
1172 for (i = 0; i < (int)pp->pb_count; ++i)
1173 line_count -= pp->pb_pointer[i].pe_line_count;
1174 if (line_count != 0)
1176 ++error;
1177 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1178 (colnr_T)0, TRUE);
1182 if (pp->pb_count == 0)
1184 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1185 (colnr_T)0, TRUE);
1186 ++error;
1188 else if (idx < (int)pp->pb_count) /* go a block deeper */
1190 if (pp->pb_pointer[idx].pe_bnum < 0)
1193 * Data block with negative block number.
1194 * Try to read lines from the original file.
1195 * This is slow, but it works.
1197 if (!cannot_open)
1199 line_count = pp->pb_pointer[idx].pe_line_count;
1200 if (readfile(curbuf->b_ffname, NULL, lnum,
1201 pp->pb_pointer[idx].pe_old_lnum - 1,
1202 line_count, NULL, 0) == FAIL)
1203 cannot_open = TRUE;
1204 else
1205 lnum += line_count;
1207 if (cannot_open)
1209 ++error;
1210 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1211 (colnr_T)0, TRUE);
1213 ++idx; /* get same block again for next index */
1214 continue;
1218 * going one block deeper in the tree
1220 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1222 ++error;
1223 break; /* out of memory */
1225 ip = &(buf->b_ml.ml_stack[top]);
1226 ip->ip_bnum = bnum;
1227 ip->ip_index = idx;
1229 bnum = pp->pb_pointer[idx].pe_bnum;
1230 line_count = pp->pb_pointer[idx].pe_line_count;
1231 page_count = pp->pb_pointer[idx].pe_page_count;
1232 continue;
1235 else /* not a pointer block */
1237 dp = (DATA_BL *)(hp->bh_data);
1238 if (dp->db_id != DATA_ID) /* block id wrong */
1240 if (bnum == 1)
1242 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1243 mfp->mf_fname);
1244 goto theend;
1246 ++error;
1247 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1248 (colnr_T)0, TRUE);
1250 else
1253 * it is a data block
1254 * Append all the lines in this block
1256 has_error = FALSE;
1258 * check length of block
1259 * if wrong, use length in pointer block
1261 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1263 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1264 (colnr_T)0, TRUE);
1265 ++error;
1266 has_error = TRUE;
1267 dp->db_txt_end = page_count * mfp->mf_page_size;
1270 /* make sure there is a NUL at the end of the block */
1271 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1274 * check number of lines in block
1275 * if wrong, use count in data block
1277 if (line_count != dp->db_line_count)
1279 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1280 (colnr_T)0, TRUE);
1281 ++error;
1282 has_error = TRUE;
1285 for (i = 0; i < dp->db_line_count; ++i)
1287 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1288 if (txt_start <= (int)HEADER_SIZE
1289 || txt_start >= (int)dp->db_txt_end)
1291 p = (char_u *)"???";
1292 ++error;
1294 else
1295 p = (char_u *)dp + txt_start;
1296 ml_append(lnum++, p, (colnr_T)0, TRUE);
1298 if (has_error)
1299 ml_append(lnum++, (char_u *)_("???END"),
1300 (colnr_T)0, TRUE);
1305 if (buf->b_ml.ml_stack_top == 0) /* finished */
1306 break;
1309 * go one block up in the tree
1311 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1312 bnum = ip->ip_bnum;
1313 idx = ip->ip_index + 1; /* go to next index */
1314 page_count = 1;
1318 * The dummy line from the empty buffer will now be after the last line in
1319 * the buffer. Delete it.
1321 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1322 curbuf->b_flags |= BF_RECOVERED;
1324 recoverymode = FALSE;
1325 if (got_int)
1326 EMSG(_("E311: Recovery Interrupted"));
1327 else if (error)
1329 ++no_wait_return;
1330 MSG(">>>>>>>>>>>>>");
1331 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1332 --no_wait_return;
1333 MSG(_("See \":help E312\" for more information."));
1334 MSG(">>>>>>>>>>>>>");
1336 else
1338 MSG(_("Recovery completed. You should check if everything is OK."));
1339 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1340 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1341 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1342 cmdline_row = msg_row;
1344 redraw_curbuf_later(NOT_VALID);
1346 theend:
1347 recoverymode = FALSE;
1348 if (mfp != NULL)
1350 if (hp != NULL)
1351 mf_put(mfp, hp, FALSE, FALSE);
1352 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1354 if (buf != NULL)
1356 vim_free(buf->b_ml.ml_stack);
1357 vim_free(buf);
1359 if (serious_error && called_from_main)
1360 ml_close(curbuf, TRUE);
1361 #ifdef FEAT_AUTOCMD
1362 else
1364 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1365 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1367 #endif
1368 return;
1372 * Find the names of swap files in current directory and the directory given
1373 * with the 'directory' option.
1375 * Used to:
1376 * - list the swap files for "vim -r"
1377 * - count the number of swap files when recovering
1378 * - list the swap files when recovering
1379 * - find the name of the n'th swap file when recovering
1382 recover_names(fname, list, nr)
1383 char_u **fname; /* base for swap file name */
1384 int list; /* when TRUE, list the swap file names */
1385 int nr; /* when non-zero, return nr'th swap file name */
1387 int num_names;
1388 char_u *(names[6]);
1389 char_u *tail;
1390 char_u *p;
1391 int num_files;
1392 int file_count = 0;
1393 char_u **files;
1394 int i;
1395 char_u *dirp;
1396 char_u *dir_name;
1398 if (list)
1400 /* use msg() to start the scrolling properly */
1401 msg((char_u *)_("Swap files found:"));
1402 msg_putchar('\n');
1406 * Do the loop for every directory in 'directory'.
1407 * First allocate some memory to put the directory name in.
1409 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1410 dirp = p_dir;
1411 while (dir_name != NULL && *dirp)
1414 * Isolate a directory name from *dirp and put it in dir_name (we know
1415 * it is large enough, so use 31000 for length).
1416 * Advance dirp to next directory name.
1418 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1420 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1422 if (fname == NULL || *fname == NULL)
1424 #ifdef VMS
1425 names[0] = vim_strsave((char_u *)"*_sw%");
1426 #else
1427 # ifdef RISCOS
1428 names[0] = vim_strsave((char_u *)"*_sw#");
1429 # else
1430 names[0] = vim_strsave((char_u *)"*.sw?");
1431 # endif
1432 #endif
1433 #if defined(UNIX) || defined(WIN3264)
1434 /* For Unix names starting with a dot are special. MS-Windows
1435 * supports this too, on some file systems. */
1436 names[1] = vim_strsave((char_u *)".*.sw?");
1437 names[2] = vim_strsave((char_u *)".sw?");
1438 num_names = 3;
1439 #else
1440 # ifdef VMS
1441 names[1] = vim_strsave((char_u *)".*_sw%");
1442 num_names = 2;
1443 # else
1444 num_names = 1;
1445 # endif
1446 #endif
1448 else
1449 num_names = recov_file_names(names, *fname, TRUE);
1451 else /* check directory dir_name */
1453 if (fname == NULL || *fname == NULL)
1455 #ifdef VMS
1456 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1457 #else
1458 # ifdef RISCOS
1459 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1460 # else
1461 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1462 # endif
1463 #endif
1464 #if defined(UNIX) || defined(WIN3264)
1465 /* For Unix names starting with a dot are special. MS-Windows
1466 * supports this too, on some file systems. */
1467 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1468 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1469 num_names = 3;
1470 #else
1471 # ifdef VMS
1472 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1473 num_names = 2;
1474 # else
1475 num_names = 1;
1476 # endif
1477 #endif
1479 else
1481 #if defined(UNIX) || defined(WIN3264)
1482 p = dir_name + STRLEN(dir_name);
1483 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1485 /* Ends with '//', Use Full path for swap name */
1486 tail = make_percent_swname(dir_name, *fname);
1488 else
1489 #endif
1491 tail = gettail(*fname);
1492 tail = concat_fnames(dir_name, tail, TRUE);
1494 if (tail == NULL)
1495 num_names = 0;
1496 else
1498 num_names = recov_file_names(names, tail, FALSE);
1499 vim_free(tail);
1504 /* check for out-of-memory */
1505 for (i = 0; i < num_names; ++i)
1507 if (names[i] == NULL)
1509 for (i = 0; i < num_names; ++i)
1510 vim_free(names[i]);
1511 num_names = 0;
1514 if (num_names == 0)
1515 num_files = 0;
1516 else if (expand_wildcards(num_names, names, &num_files, &files,
1517 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1518 num_files = 0;
1521 * When no swap file found, wildcard expansion might have failed (e.g.
1522 * not able to execute the shell).
1523 * Try finding a swap file by simply adding ".swp" to the file name.
1525 if (*dirp == NUL && file_count + num_files == 0
1526 && fname != NULL && *fname != NULL)
1528 struct stat st;
1529 char_u *swapname;
1531 #if defined(VMS) || defined(RISCOS)
1532 swapname = modname(*fname, (char_u *)"_swp", FALSE);
1533 #else
1534 swapname = modname(*fname, (char_u *)".swp", TRUE);
1535 #endif
1536 if (swapname != NULL)
1538 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1540 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1541 if (files != NULL)
1543 files[0] = swapname;
1544 swapname = NULL;
1545 num_files = 1;
1548 vim_free(swapname);
1553 * remove swapfile name of the current buffer, it must be ignored
1555 if (curbuf->b_ml.ml_mfp != NULL
1556 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1558 for (i = 0; i < num_files; ++i)
1559 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1561 /* Remove the name from files[i]. Move further entries
1562 * down. When the array becomes empty free it here, since
1563 * FreeWild() won't be called below. */
1564 vim_free(files[i]);
1565 if (--num_files == 0)
1566 vim_free(files);
1567 else
1568 for ( ; i < num_files; ++i)
1569 files[i] = files[i + 1];
1572 if (nr > 0)
1574 file_count += num_files;
1575 if (nr <= file_count)
1577 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1578 dirp = (char_u *)""; /* stop searching */
1581 else if (list)
1583 if (dir_name[0] == '.' && dir_name[1] == NUL)
1585 if (fname == NULL || *fname == NULL)
1586 MSG_PUTS(_(" In current directory:\n"));
1587 else
1588 MSG_PUTS(_(" Using specified name:\n"));
1590 else
1592 MSG_PUTS(_(" In directory "));
1593 msg_home_replace(dir_name);
1594 MSG_PUTS(":\n");
1597 if (num_files)
1599 for (i = 0; i < num_files; ++i)
1601 /* print the swap file name */
1602 msg_outnum((long)++file_count);
1603 MSG_PUTS(". ");
1604 msg_puts(gettail(files[i]));
1605 msg_putchar('\n');
1606 (void)swapfile_info(files[i]);
1609 else
1610 MSG_PUTS(_(" -- none --\n"));
1611 out_flush();
1613 else
1614 file_count += num_files;
1616 for (i = 0; i < num_names; ++i)
1617 vim_free(names[i]);
1618 if (num_files > 0)
1619 FreeWild(num_files, files);
1621 vim_free(dir_name);
1622 return file_count;
1625 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1627 * Append the full path to name with path separators made into percent
1628 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1630 static char_u *
1631 make_percent_swname(dir, name)
1632 char_u *dir;
1633 char_u *name;
1635 char_u *d, *s, *f;
1637 f = fix_fname(name != NULL ? name : (char_u *) "");
1638 d = NULL;
1639 if (f != NULL)
1641 s = alloc((unsigned)(STRLEN(f) + 1));
1642 if (s != NULL)
1644 STRCPY(s, f);
1645 for (d = s; *d != NUL; mb_ptr_adv(d))
1646 if (vim_ispathsep(*d))
1647 *d = '%';
1648 d = concat_fnames(dir, s, TRUE);
1649 vim_free(s);
1651 vim_free(f);
1653 return d;
1655 #endif
1657 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1658 static int process_still_running;
1659 #endif
1662 * Give information about an existing swap file.
1663 * Returns timestamp (0 when unknown).
1665 static time_t
1666 swapfile_info(fname)
1667 char_u *fname;
1669 struct stat st;
1670 int fd;
1671 struct block0 b0;
1672 time_t x = (time_t)0;
1673 char *p;
1674 #ifdef UNIX
1675 char_u uname[B0_UNAME_SIZE];
1676 #endif
1678 /* print the swap file date */
1679 if (mch_stat((char *)fname, &st) != -1)
1681 #ifdef UNIX
1682 /* print name of owner of the file */
1683 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1685 MSG_PUTS(_(" owned by: "));
1686 msg_outtrans(uname);
1687 MSG_PUTS(_(" dated: "));
1689 else
1690 #endif
1691 MSG_PUTS(_(" dated: "));
1692 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1693 p = ctime(&x); /* includes '\n' */
1694 if (p == NULL)
1695 MSG_PUTS("(invalid)\n");
1696 else
1697 MSG_PUTS(p);
1701 * print the original file name
1703 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1704 if (fd >= 0)
1706 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1708 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1710 MSG_PUTS(_(" [from Vim version 3.0]"));
1712 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1714 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1716 else
1718 MSG_PUTS(_(" file name: "));
1719 if (b0.b0_fname[0] == NUL)
1720 MSG_PUTS(_("[No Name]"));
1721 else
1722 msg_outtrans(b0.b0_fname);
1724 MSG_PUTS(_("\n modified: "));
1725 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1727 if (*(b0.b0_uname) != NUL)
1729 MSG_PUTS(_("\n user name: "));
1730 msg_outtrans(b0.b0_uname);
1733 if (*(b0.b0_hname) != NUL)
1735 if (*(b0.b0_uname) != NUL)
1736 MSG_PUTS(_(" host name: "));
1737 else
1738 MSG_PUTS(_("\n host name: "));
1739 msg_outtrans(b0.b0_hname);
1742 if (char_to_long(b0.b0_pid) != 0L)
1744 MSG_PUTS(_("\n process ID: "));
1745 msg_outnum(char_to_long(b0.b0_pid));
1746 #if defined(UNIX) || defined(__EMX__)
1747 /* EMX kill() not working correctly, it seems */
1748 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1750 MSG_PUTS(_(" (still running)"));
1751 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1752 process_still_running = TRUE;
1753 # endif
1755 #endif
1758 if (b0_magic_wrong(&b0))
1760 #if defined(MSDOS) || defined(MSWIN)
1761 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1762 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1763 else
1764 #endif
1765 MSG_PUTS(_("\n [not usable on this computer]"));
1769 else
1770 MSG_PUTS(_(" [cannot be read]"));
1771 close(fd);
1773 else
1774 MSG_PUTS(_(" [cannot be opened]"));
1775 msg_putchar('\n');
1777 return x;
1780 static int
1781 recov_file_names(names, path, prepend_dot)
1782 char_u **names;
1783 char_u *path;
1784 int prepend_dot;
1786 int num_names;
1788 #ifdef SHORT_FNAME
1790 * (MS-DOS) always short names
1792 names[0] = modname(path, (char_u *)".sw?", FALSE);
1793 num_names = 1;
1794 #else /* !SHORT_FNAME */
1796 * (Win32 and Win64) never short names, but do prepend a dot.
1797 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1798 * Only use the short name if it is different.
1800 char_u *p;
1801 int i;
1802 # ifndef WIN3264
1803 int shortname = curbuf->b_shortname;
1805 curbuf->b_shortname = FALSE;
1806 # endif
1808 num_names = 0;
1811 * May also add the file name with a dot prepended, for swap file in same
1812 * dir as original file.
1814 if (prepend_dot)
1816 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1817 if (names[num_names] == NULL)
1818 goto end;
1819 ++num_names;
1823 * Form the normal swap file name pattern by appending ".sw?".
1825 #ifdef VMS
1826 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1827 #else
1828 # ifdef RISCOS
1829 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1830 # else
1831 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1832 # endif
1833 #endif
1834 if (names[num_names] == NULL)
1835 goto end;
1836 if (num_names >= 1) /* check if we have the same name twice */
1838 p = names[num_names - 1];
1839 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1840 if (i > 0)
1841 p += i; /* file name has been expanded to full path */
1843 if (STRCMP(p, names[num_names]) != 0)
1844 ++num_names;
1845 else
1846 vim_free(names[num_names]);
1848 else
1849 ++num_names;
1851 # ifndef WIN3264
1853 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1855 curbuf->b_shortname = TRUE;
1856 #ifdef VMS
1857 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1858 #else
1859 # ifdef RISCOS
1860 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1861 # else
1862 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1863 # endif
1864 #endif
1865 if (names[num_names] == NULL)
1866 goto end;
1869 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1871 p = names[num_names];
1872 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1873 if (i > 0)
1874 p += i; /* file name has been expanded to full path */
1875 if (STRCMP(names[num_names - 1], p) == 0)
1876 vim_free(names[num_names]);
1877 else
1878 ++num_names;
1879 # endif
1881 end:
1882 # ifndef WIN3264
1883 curbuf->b_shortname = shortname;
1884 # endif
1886 #endif /* !SHORT_FNAME */
1888 return num_names;
1892 * sync all memlines
1894 * If 'check_file' is TRUE, check if original file exists and was not changed.
1895 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1896 * always sync at least one block.
1898 void
1899 ml_sync_all(check_file, check_char)
1900 int check_file;
1901 int check_char;
1903 buf_T *buf;
1904 struct stat st;
1906 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1908 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1909 continue; /* no file */
1911 ml_flush_line(buf); /* flush buffered line */
1912 /* flush locked block */
1913 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1914 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1915 && buf->b_ffname != NULL)
1918 * If the original file does not exist anymore or has been changed
1919 * call ml_preserve() to get rid of all negative numbered blocks.
1921 if (mch_stat((char *)buf->b_ffname, &st) == -1
1922 || st.st_mtime != buf->b_mtime_read
1923 || (size_t)st.st_size != buf->b_orig_size)
1925 ml_preserve(buf, FALSE);
1926 did_check_timestamps = FALSE;
1927 need_check_timestamps = TRUE; /* give message later */
1930 if (buf->b_ml.ml_mfp->mf_dirty)
1932 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1933 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1934 if (check_char && ui_char_avail()) /* character available now */
1935 break;
1941 * sync one buffer, including negative blocks
1943 * after this all the blocks are in the swap file
1945 * Used for the :preserve command and when the original file has been
1946 * changed or deleted.
1948 * when message is TRUE the success of preserving is reported
1950 void
1951 ml_preserve(buf, message)
1952 buf_T *buf;
1953 int message;
1955 bhdr_T *hp;
1956 linenr_T lnum;
1957 memfile_T *mfp = buf->b_ml.ml_mfp;
1958 int status;
1959 int got_int_save = got_int;
1961 if (mfp == NULL || mfp->mf_fname == NULL)
1963 if (message)
1964 EMSG(_("E313: Cannot preserve, there is no swap file"));
1965 return;
1968 /* We only want to stop when interrupted here, not when interrupted
1969 * before. */
1970 got_int = FALSE;
1972 ml_flush_line(buf); /* flush buffered line */
1973 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
1974 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
1976 /* stack is invalid after mf_sync(.., MFS_ALL) */
1977 buf->b_ml.ml_stack_top = 0;
1980 * Some of the data blocks may have been changed from negative to
1981 * positive block number. In that case the pointer blocks need to be
1982 * updated.
1984 * We don't know in which pointer block the references are, so we visit
1985 * all data blocks until there are no more translations to be done (or
1986 * we hit the end of the file, which can only happen in case a write fails,
1987 * e.g. when file system if full).
1988 * ml_find_line() does the work by translating the negative block numbers
1989 * when getting the first line of each data block.
1991 if (mf_need_trans(mfp) && !got_int)
1993 lnum = 1;
1994 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
1996 hp = ml_find_line(buf, lnum, ML_FIND);
1997 if (hp == NULL)
1999 status = FAIL;
2000 goto theend;
2002 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2003 lnum = buf->b_ml.ml_locked_high + 1;
2005 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2006 /* sync the updated pointer blocks */
2007 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2008 status = FAIL;
2009 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2011 theend:
2012 got_int |= got_int_save;
2014 if (message)
2016 if (status == OK)
2017 MSG(_("File preserved"));
2018 else
2019 EMSG(_("E314: Preserve failed"));
2024 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2025 * until the next call!
2026 * line1 = ml_get(1);
2027 * line2 = ml_get(2); // line1 is now invalid!
2028 * Make a copy of the line if necessary.
2031 * get a pointer to a (read-only copy of a) line
2033 * On failure an error message is given and IObuff is returned (to avoid
2034 * having to check for error everywhere).
2036 char_u *
2037 ml_get(lnum)
2038 linenr_T lnum;
2040 return ml_get_buf(curbuf, lnum, FALSE);
2044 * ml_get_pos: get pointer to position 'pos'
2046 char_u *
2047 ml_get_pos(pos)
2048 pos_T *pos;
2050 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2054 * ml_get_curline: get pointer to cursor line.
2056 char_u *
2057 ml_get_curline()
2059 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2063 * ml_get_cursor: get pointer to cursor position
2065 char_u *
2066 ml_get_cursor()
2068 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2069 curwin->w_cursor.col);
2073 * get a pointer to a line in a specific buffer
2075 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2076 * changed)
2078 char_u *
2079 ml_get_buf(buf, lnum, will_change)
2080 buf_T *buf;
2081 linenr_T lnum;
2082 int will_change; /* line will be changed */
2084 bhdr_T *hp;
2085 DATA_BL *dp;
2086 char_u *ptr;
2087 static int recursive = 0;
2089 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2091 if (recursive == 0)
2093 /* Avoid giving this message for a recursive call, may happen when
2094 * the GUI redraws part of the text. */
2095 ++recursive;
2096 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2097 --recursive;
2099 errorret:
2100 STRCPY(IObuff, "???");
2101 return IObuff;
2103 if (lnum <= 0) /* pretend line 0 is line 1 */
2104 lnum = 1;
2106 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2107 return (char_u *)"";
2110 * See if it is the same line as requested last time.
2111 * Otherwise may need to flush last used line.
2112 * Don't use the last used line when 'swapfile' is reset, need to load all
2113 * blocks.
2115 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2117 ml_flush_line(buf);
2120 * Find the data block containing the line.
2121 * This also fills the stack with the blocks from the root to the data
2122 * block and releases any locked block.
2124 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2126 if (recursive == 0)
2128 /* Avoid giving this message for a recursive call, may happen
2129 * when the GUI redraws part of the text. */
2130 ++recursive;
2131 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2132 --recursive;
2134 goto errorret;
2137 dp = (DATA_BL *)(hp->bh_data);
2139 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2140 buf->b_ml.ml_line_ptr = ptr;
2141 buf->b_ml.ml_line_lnum = lnum;
2142 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2144 if (will_change)
2145 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2147 return buf->b_ml.ml_line_ptr;
2151 * Check if a line that was just obtained by a call to ml_get
2152 * is in allocated memory.
2155 ml_line_alloced()
2157 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2161 * Append a line after lnum (may be 0 to insert a line in front of the file).
2162 * "line" does not need to be allocated, but can't be another line in a
2163 * buffer, unlocking may make it invalid.
2165 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2166 * will be set for recovery
2167 * Check: The caller of this function should probably also call
2168 * appended_lines().
2170 * return FAIL for failure, OK otherwise
2173 ml_append(lnum, line, len, newfile)
2174 linenr_T lnum; /* append after this line (can be 0) */
2175 char_u *line; /* text of the new line */
2176 colnr_T len; /* length of new line, including NUL, or 0 */
2177 int newfile; /* flag, see above */
2179 /* When starting up, we might still need to create the memfile */
2180 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2181 return FAIL;
2183 if (curbuf->b_ml.ml_line_lnum != 0)
2184 ml_flush_line(curbuf);
2185 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2188 #if defined(FEAT_SPELL) || defined(PROTO)
2190 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2191 * a memline.
2194 ml_append_buf(buf, lnum, line, len, newfile)
2195 buf_T *buf;
2196 linenr_T lnum; /* append after this line (can be 0) */
2197 char_u *line; /* text of the new line */
2198 colnr_T len; /* length of new line, including NUL, or 0 */
2199 int newfile; /* flag, see above */
2201 if (buf->b_ml.ml_mfp == NULL)
2202 return FAIL;
2204 if (buf->b_ml.ml_line_lnum != 0)
2205 ml_flush_line(buf);
2206 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2208 #endif
2210 static int
2211 ml_append_int(buf, lnum, line, len, newfile, mark)
2212 buf_T *buf;
2213 linenr_T lnum; /* append after this line (can be 0) */
2214 char_u *line; /* text of the new line */
2215 colnr_T len; /* length of line, including NUL, or 0 */
2216 int newfile; /* flag, see above */
2217 int mark; /* mark the new line */
2219 int i;
2220 int line_count; /* number of indexes in current block */
2221 int offset;
2222 int from, to;
2223 int space_needed; /* space needed for new line */
2224 int page_size;
2225 int page_count;
2226 int db_idx; /* index for lnum in data block */
2227 bhdr_T *hp;
2228 memfile_T *mfp;
2229 DATA_BL *dp;
2230 PTR_BL *pp;
2231 infoptr_T *ip;
2233 /* lnum out of range */
2234 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2235 return FAIL;
2237 if (lowest_marked && lowest_marked > lnum)
2238 lowest_marked = lnum + 1;
2240 if (len == 0)
2241 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2242 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2244 mfp = buf->b_ml.ml_mfp;
2245 page_size = mfp->mf_page_size;
2248 * find the data block containing the previous line
2249 * This also fills the stack with the blocks from the root to the data block
2250 * This also releases any locked block.
2252 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2253 ML_INSERT)) == NULL)
2254 return FAIL;
2256 buf->b_ml.ml_flags &= ~ML_EMPTY;
2258 if (lnum == 0) /* got line one instead, correct db_idx */
2259 db_idx = -1; /* careful, it is negative! */
2260 else
2261 db_idx = lnum - buf->b_ml.ml_locked_low;
2262 /* get line count before the insertion */
2263 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2265 dp = (DATA_BL *)(hp->bh_data);
2268 * If
2269 * - there is not enough room in the current block
2270 * - appending to the last line in the block
2271 * - not appending to the last line in the file
2272 * insert in front of the next block.
2274 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2275 && lnum < buf->b_ml.ml_line_count)
2278 * Now that the line is not going to be inserted in the block that we
2279 * expected, the line count has to be adjusted in the pointer blocks
2280 * by using ml_locked_lineadd.
2282 --(buf->b_ml.ml_locked_lineadd);
2283 --(buf->b_ml.ml_locked_high);
2284 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2285 return FAIL;
2287 db_idx = -1; /* careful, it is negative! */
2288 /* get line count before the insertion */
2289 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2290 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2292 dp = (DATA_BL *)(hp->bh_data);
2295 ++buf->b_ml.ml_line_count;
2297 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2300 * Insert new line in existing data block, or in data block allocated above.
2302 dp->db_txt_start -= len;
2303 dp->db_free -= space_needed;
2304 ++(dp->db_line_count);
2307 * move the text of the lines that follow to the front
2308 * adjust the indexes of the lines that follow
2310 if (line_count > db_idx + 1) /* if there are following lines */
2313 * Offset is the start of the previous line.
2314 * This will become the character just after the new line.
2316 if (db_idx < 0)
2317 offset = dp->db_txt_end;
2318 else
2319 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2320 mch_memmove((char *)dp + dp->db_txt_start,
2321 (char *)dp + dp->db_txt_start + len,
2322 (size_t)(offset - (dp->db_txt_start + len)));
2323 for (i = line_count - 1; i > db_idx; --i)
2324 dp->db_index[i + 1] = dp->db_index[i] - len;
2325 dp->db_index[db_idx + 1] = offset - len;
2327 else /* add line at the end */
2328 dp->db_index[db_idx + 1] = dp->db_txt_start;
2331 * copy the text into the block
2333 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2334 if (mark)
2335 dp->db_index[db_idx + 1] |= DB_MARKED;
2338 * Mark the block dirty.
2340 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2341 if (!newfile)
2342 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2344 else /* not enough space in data block */
2347 * If there is not enough room we have to create a new data block and copy some
2348 * lines into it.
2349 * Then we have to insert an entry in the pointer block.
2350 * If this pointer block also is full, we go up another block, and so on, up
2351 * to the root if necessary.
2352 * The line counts in the pointer blocks have already been adjusted by
2353 * ml_find_line().
2355 long line_count_left, line_count_right;
2356 int page_count_left, page_count_right;
2357 bhdr_T *hp_left;
2358 bhdr_T *hp_right;
2359 bhdr_T *hp_new;
2360 int lines_moved;
2361 int data_moved = 0; /* init to shut up gcc */
2362 int total_moved = 0; /* init to shut up gcc */
2363 DATA_BL *dp_right, *dp_left;
2364 int stack_idx;
2365 int in_left;
2366 int lineadd;
2367 blocknr_T bnum_left, bnum_right;
2368 linenr_T lnum_left, lnum_right;
2369 int pb_idx;
2370 PTR_BL *pp_new;
2373 * We are going to allocate a new data block. Depending on the
2374 * situation it will be put to the left or right of the existing
2375 * block. If possible we put the new line in the left block and move
2376 * the lines after it to the right block. Otherwise the new line is
2377 * also put in the right block. This method is more efficient when
2378 * inserting a lot of lines at one place.
2380 if (db_idx < 0) /* left block is new, right block is existing */
2382 lines_moved = 0;
2383 in_left = TRUE;
2384 /* space_needed does not change */
2386 else /* left block is existing, right block is new */
2388 lines_moved = line_count - db_idx - 1;
2389 if (lines_moved == 0)
2390 in_left = FALSE; /* put new line in right block */
2391 /* space_needed does not change */
2392 else
2394 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2395 dp->db_txt_start;
2396 total_moved = data_moved + lines_moved * INDEX_SIZE;
2397 if ((int)dp->db_free + total_moved >= space_needed)
2399 in_left = TRUE; /* put new line in left block */
2400 space_needed = total_moved;
2402 else
2404 in_left = FALSE; /* put new line in right block */
2405 space_needed += total_moved;
2410 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2411 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2413 /* correct line counts in pointer blocks */
2414 --(buf->b_ml.ml_locked_lineadd);
2415 --(buf->b_ml.ml_locked_high);
2416 return FAIL;
2418 if (db_idx < 0) /* left block is new */
2420 hp_left = hp_new;
2421 hp_right = hp;
2422 line_count_left = 0;
2423 line_count_right = line_count;
2425 else /* right block is new */
2427 hp_left = hp;
2428 hp_right = hp_new;
2429 line_count_left = line_count;
2430 line_count_right = 0;
2432 dp_right = (DATA_BL *)(hp_right->bh_data);
2433 dp_left = (DATA_BL *)(hp_left->bh_data);
2434 bnum_left = hp_left->bh_bnum;
2435 bnum_right = hp_right->bh_bnum;
2436 page_count_left = hp_left->bh_page_count;
2437 page_count_right = hp_right->bh_page_count;
2440 * May move the new line into the right/new block.
2442 if (!in_left)
2444 dp_right->db_txt_start -= len;
2445 dp_right->db_free -= len + INDEX_SIZE;
2446 dp_right->db_index[0] = dp_right->db_txt_start;
2447 if (mark)
2448 dp_right->db_index[0] |= DB_MARKED;
2450 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2451 line, (size_t)len);
2452 ++line_count_right;
2455 * may move lines from the left/old block to the right/new one.
2457 if (lines_moved)
2461 dp_right->db_txt_start -= data_moved;
2462 dp_right->db_free -= total_moved;
2463 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2464 (char *)dp_left + dp_left->db_txt_start,
2465 (size_t)data_moved);
2466 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2467 dp_left->db_txt_start += data_moved;
2468 dp_left->db_free += total_moved;
2471 * update indexes in the new block
2473 for (to = line_count_right, from = db_idx + 1;
2474 from < line_count_left; ++from, ++to)
2475 dp_right->db_index[to] = dp->db_index[from] + offset;
2476 line_count_right += lines_moved;
2477 line_count_left -= lines_moved;
2481 * May move the new line into the left (old or new) block.
2483 if (in_left)
2485 dp_left->db_txt_start -= len;
2486 dp_left->db_free -= len + INDEX_SIZE;
2487 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2488 if (mark)
2489 dp_left->db_index[line_count_left] |= DB_MARKED;
2490 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2491 line, (size_t)len);
2492 ++line_count_left;
2495 if (db_idx < 0) /* left block is new */
2497 lnum_left = lnum + 1;
2498 lnum_right = 0;
2500 else /* right block is new */
2502 lnum_left = 0;
2503 if (in_left)
2504 lnum_right = lnum + 2;
2505 else
2506 lnum_right = lnum + 1;
2508 dp_left->db_line_count = line_count_left;
2509 dp_right->db_line_count = line_count_right;
2512 * release the two data blocks
2513 * The new one (hp_new) already has a correct blocknumber.
2514 * The old one (hp, in ml_locked) gets a positive blocknumber if
2515 * we changed it and we are not editing a new file.
2517 if (lines_moved || in_left)
2518 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2519 if (!newfile && db_idx >= 0 && in_left)
2520 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2521 mf_put(mfp, hp_new, TRUE, FALSE);
2524 * flush the old data block
2525 * set ml_locked_lineadd to 0, because the updating of the
2526 * pointer blocks is done below
2528 lineadd = buf->b_ml.ml_locked_lineadd;
2529 buf->b_ml.ml_locked_lineadd = 0;
2530 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2533 * update pointer blocks for the new data block
2535 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2536 --stack_idx)
2538 ip = &(buf->b_ml.ml_stack[stack_idx]);
2539 pb_idx = ip->ip_index;
2540 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2541 return FAIL;
2542 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2543 if (pp->pb_id != PTR_ID)
2545 EMSG(_("E317: pointer block id wrong 3"));
2546 mf_put(mfp, hp, FALSE, FALSE);
2547 return FAIL;
2550 * TODO: If the pointer block is full and we are adding at the end
2551 * try to insert in front of the next block
2553 /* block not full, add one entry */
2554 if (pp->pb_count < pp->pb_count_max)
2556 if (pb_idx + 1 < (int)pp->pb_count)
2557 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2558 &pp->pb_pointer[pb_idx + 1],
2559 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2560 ++pp->pb_count;
2561 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2562 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2563 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2564 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2565 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2566 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2568 if (lnum_left != 0)
2569 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2570 if (lnum_right != 0)
2571 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2573 mf_put(mfp, hp, TRUE, FALSE);
2574 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2576 if (lineadd)
2578 --(buf->b_ml.ml_stack_top);
2579 /* fix line count for rest of blocks in the stack */
2580 ml_lineadd(buf, lineadd);
2581 /* fix stack itself */
2582 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2583 lineadd;
2584 ++(buf->b_ml.ml_stack_top);
2588 * We are finished, break the loop here.
2590 break;
2592 else /* pointer block full */
2595 * split the pointer block
2596 * allocate a new pointer block
2597 * move some of the pointer into the new block
2598 * prepare for updating the parent block
2600 for (;;) /* do this twice when splitting block 1 */
2602 hp_new = ml_new_ptr(mfp);
2603 if (hp_new == NULL) /* TODO: try to fix tree */
2604 return FAIL;
2605 pp_new = (PTR_BL *)(hp_new->bh_data);
2607 if (hp->bh_bnum != 1)
2608 break;
2611 * if block 1 becomes full the tree is given an extra level
2612 * The pointers from block 1 are moved into the new block.
2613 * block 1 is updated to point to the new block
2614 * then continue to split the new block
2616 mch_memmove(pp_new, pp, (size_t)page_size);
2617 pp->pb_count = 1;
2618 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2619 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2620 pp->pb_pointer[0].pe_old_lnum = 1;
2621 pp->pb_pointer[0].pe_page_count = 1;
2622 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2623 hp = hp_new; /* new block is to be split */
2624 pp = pp_new;
2625 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2626 ip->ip_index = 0;
2627 ++stack_idx; /* do block 1 again later */
2630 * move the pointers after the current one to the new block
2631 * If there are none, the new entry will be in the new block.
2633 total_moved = pp->pb_count - pb_idx - 1;
2634 if (total_moved)
2636 mch_memmove(&pp_new->pb_pointer[0],
2637 &pp->pb_pointer[pb_idx + 1],
2638 (size_t)(total_moved) * sizeof(PTR_EN));
2639 pp_new->pb_count = total_moved;
2640 pp->pb_count -= total_moved - 1;
2641 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2642 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2643 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2644 if (lnum_right)
2645 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2647 else
2649 pp_new->pb_count = 1;
2650 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2651 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2652 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2653 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2655 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2656 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2657 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2658 if (lnum_left)
2659 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2660 lnum_left = 0;
2661 lnum_right = 0;
2664 * recompute line counts
2666 line_count_right = 0;
2667 for (i = 0; i < (int)pp_new->pb_count; ++i)
2668 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2669 line_count_left = 0;
2670 for (i = 0; i < (int)pp->pb_count; ++i)
2671 line_count_left += pp->pb_pointer[i].pe_line_count;
2673 bnum_left = hp->bh_bnum;
2674 bnum_right = hp_new->bh_bnum;
2675 page_count_left = 1;
2676 page_count_right = 1;
2677 mf_put(mfp, hp, TRUE, FALSE);
2678 mf_put(mfp, hp_new, TRUE, FALSE);
2683 * Safety check: fallen out of for loop?
2685 if (stack_idx < 0)
2687 EMSG(_("E318: Updated too many blocks?"));
2688 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2692 #ifdef FEAT_BYTEOFF
2693 /* The line was inserted below 'lnum' */
2694 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2695 #endif
2696 #ifdef FEAT_NETBEANS_INTG
2697 if (usingNetbeans)
2699 if (STRLEN(line) > 0)
2700 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2701 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2702 (char_u *)"\n", 1);
2704 #endif
2705 return OK;
2709 * Replace line lnum, with buffering, in current buffer.
2711 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2712 * copied to allocated memory already.
2714 * Check: The caller of this function should probably also call
2715 * changed_lines(), unless update_screen(NOT_VALID) is used.
2717 * return FAIL for failure, OK otherwise
2720 ml_replace(lnum, line, copy)
2721 linenr_T lnum;
2722 char_u *line;
2723 int copy;
2725 if (line == NULL) /* just checking... */
2726 return FAIL;
2728 /* When starting up, we might still need to create the memfile */
2729 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2730 return FAIL;
2732 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2733 return FAIL;
2734 #ifdef FEAT_NETBEANS_INTG
2735 if (usingNetbeans)
2737 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2738 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2740 #endif
2741 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2742 ml_flush_line(curbuf); /* flush it */
2743 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2744 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2745 curbuf->b_ml.ml_line_ptr = line;
2746 curbuf->b_ml.ml_line_lnum = lnum;
2747 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2749 return OK;
2753 * Delete line 'lnum' in the current buffer.
2755 * Check: The caller of this function should probably also call
2756 * deleted_lines() after this.
2758 * return FAIL for failure, OK otherwise
2761 ml_delete(lnum, message)
2762 linenr_T lnum;
2763 int message;
2765 ml_flush_line(curbuf);
2766 return ml_delete_int(curbuf, lnum, message);
2769 static int
2770 ml_delete_int(buf, lnum, message)
2771 buf_T *buf;
2772 linenr_T lnum;
2773 int message;
2775 bhdr_T *hp;
2776 memfile_T *mfp;
2777 DATA_BL *dp;
2778 PTR_BL *pp;
2779 infoptr_T *ip;
2780 int count; /* number of entries in block */
2781 int idx;
2782 int stack_idx;
2783 int text_start;
2784 int line_start;
2785 long line_size;
2786 int i;
2788 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2789 return FAIL;
2791 if (lowest_marked && lowest_marked > lnum)
2792 lowest_marked--;
2795 * If the file becomes empty the last line is replaced by an empty line.
2797 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2799 if (message
2800 #ifdef FEAT_NETBEANS_INTG
2801 && !netbeansSuppressNoLines
2802 #endif
2804 set_keep_msg((char_u *)_(no_lines_msg), 0);
2806 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2807 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2808 buf->b_ml.ml_flags |= ML_EMPTY;
2810 return i;
2814 * find the data block containing the line
2815 * This also fills the stack with the blocks from the root to the data block
2816 * This also releases any locked block.
2818 mfp = buf->b_ml.ml_mfp;
2819 if (mfp == NULL)
2820 return FAIL;
2822 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2823 return FAIL;
2825 dp = (DATA_BL *)(hp->bh_data);
2826 /* compute line count before the delete */
2827 count = (long)(buf->b_ml.ml_locked_high)
2828 - (long)(buf->b_ml.ml_locked_low) + 2;
2829 idx = lnum - buf->b_ml.ml_locked_low;
2831 --buf->b_ml.ml_line_count;
2833 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2834 if (idx == 0) /* first line in block, text at the end */
2835 line_size = dp->db_txt_end - line_start;
2836 else
2837 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2839 #ifdef FEAT_NETBEANS_INTG
2840 if (usingNetbeans)
2841 netbeans_removed(buf, lnum, 0, (long)line_size);
2842 #endif
2845 * special case: If there is only one line in the data block it becomes empty.
2846 * Then we have to remove the entry, pointing to this data block, from the
2847 * pointer block. If this pointer block also becomes empty, we go up another
2848 * block, and so on, up to the root if necessary.
2849 * The line counts in the pointer blocks have already been adjusted by
2850 * ml_find_line().
2852 if (count == 1)
2854 mf_free(mfp, hp); /* free the data block */
2855 buf->b_ml.ml_locked = NULL;
2857 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2859 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2860 ip = &(buf->b_ml.ml_stack[stack_idx]);
2861 idx = ip->ip_index;
2862 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2863 return FAIL;
2864 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2865 if (pp->pb_id != PTR_ID)
2867 EMSG(_("E317: pointer block id wrong 4"));
2868 mf_put(mfp, hp, FALSE, FALSE);
2869 return FAIL;
2871 count = --(pp->pb_count);
2872 if (count == 0) /* the pointer block becomes empty! */
2873 mf_free(mfp, hp);
2874 else
2876 if (count != idx) /* move entries after the deleted one */
2877 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2878 (size_t)(count - idx) * sizeof(PTR_EN));
2879 mf_put(mfp, hp, TRUE, FALSE);
2881 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2882 /* fix line count for rest of blocks in the stack */
2883 if (buf->b_ml.ml_locked_lineadd != 0)
2885 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2886 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2887 buf->b_ml.ml_locked_lineadd;
2889 ++(buf->b_ml.ml_stack_top);
2891 break;
2894 CHECK(stack_idx < 0, _("deleted block 1?"));
2896 else
2899 * delete the text by moving the next lines forwards
2901 text_start = dp->db_txt_start;
2902 mch_memmove((char *)dp + text_start + line_size,
2903 (char *)dp + text_start, (size_t)(line_start - text_start));
2906 * delete the index by moving the next indexes backwards
2907 * Adjust the indexes for the text movement.
2909 for (i = idx; i < count - 1; ++i)
2910 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2912 dp->db_free += line_size + INDEX_SIZE;
2913 dp->db_txt_start += line_size;
2914 --(dp->db_line_count);
2917 * mark the block dirty and make sure it is in the file (for recovery)
2919 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2922 #ifdef FEAT_BYTEOFF
2923 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2924 #endif
2925 return OK;
2929 * set the B_MARKED flag for line 'lnum'
2931 void
2932 ml_setmarked(lnum)
2933 linenr_T lnum;
2935 bhdr_T *hp;
2936 DATA_BL *dp;
2937 /* invalid line number */
2938 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2939 || curbuf->b_ml.ml_mfp == NULL)
2940 return; /* give error message? */
2942 if (lowest_marked == 0 || lowest_marked > lnum)
2943 lowest_marked = lnum;
2946 * find the data block containing the line
2947 * This also fills the stack with the blocks from the root to the data block
2948 * This also releases any locked block.
2950 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2951 return; /* give error message? */
2953 dp = (DATA_BL *)(hp->bh_data);
2954 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2955 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2959 * find the first line with its B_MARKED flag set
2961 linenr_T
2962 ml_firstmarked()
2964 bhdr_T *hp;
2965 DATA_BL *dp;
2966 linenr_T lnum;
2967 int i;
2969 if (curbuf->b_ml.ml_mfp == NULL)
2970 return (linenr_T) 0;
2973 * The search starts with lowest_marked line. This is the last line where
2974 * a mark was found, adjusted by inserting/deleting lines.
2976 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
2979 * Find the data block containing the line.
2980 * This also fills the stack with the blocks from the root to the data
2981 * block This also releases any locked block.
2983 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2984 return (linenr_T)0; /* give error message? */
2986 dp = (DATA_BL *)(hp->bh_data);
2988 for (i = lnum - curbuf->b_ml.ml_locked_low;
2989 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
2990 if ((dp->db_index[i]) & DB_MARKED)
2992 (dp->db_index[i]) &= DB_INDEX_MASK;
2993 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2994 lowest_marked = lnum + 1;
2995 return lnum;
2999 return (linenr_T) 0;
3002 #if 0 /* not used */
3004 * return TRUE if line 'lnum' has a mark
3007 ml_has_mark(lnum)
3008 linenr_T lnum;
3010 bhdr_T *hp;
3011 DATA_BL *dp;
3013 if (curbuf->b_ml.ml_mfp == NULL
3014 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3015 return FALSE;
3017 dp = (DATA_BL *)(hp->bh_data);
3018 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3020 #endif
3023 * clear all DB_MARKED flags
3025 void
3026 ml_clearmarked()
3028 bhdr_T *hp;
3029 DATA_BL *dp;
3030 linenr_T lnum;
3031 int i;
3033 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3034 return;
3037 * The search starts with line lowest_marked.
3039 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3042 * Find the data block containing the line.
3043 * This also fills the stack with the blocks from the root to the data
3044 * block and releases any locked block.
3046 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3047 return; /* give error message? */
3049 dp = (DATA_BL *)(hp->bh_data);
3051 for (i = lnum - curbuf->b_ml.ml_locked_low;
3052 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3053 if ((dp->db_index[i]) & DB_MARKED)
3055 (dp->db_index[i]) &= DB_INDEX_MASK;
3056 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3060 lowest_marked = 0;
3061 return;
3065 * flush ml_line if necessary
3067 static void
3068 ml_flush_line(buf)
3069 buf_T *buf;
3071 bhdr_T *hp;
3072 DATA_BL *dp;
3073 linenr_T lnum;
3074 char_u *new_line;
3075 char_u *old_line;
3076 colnr_T new_len;
3077 int old_len;
3078 int extra;
3079 int idx;
3080 int start;
3081 int count;
3082 int i;
3084 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3085 return; /* nothing to do */
3087 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3089 lnum = buf->b_ml.ml_line_lnum;
3090 new_line = buf->b_ml.ml_line_ptr;
3092 hp = ml_find_line(buf, lnum, ML_FIND);
3093 if (hp == NULL)
3094 EMSGN(_("E320: Cannot find line %ld"), lnum);
3095 else
3097 dp = (DATA_BL *)(hp->bh_data);
3098 idx = lnum - buf->b_ml.ml_locked_low;
3099 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3100 old_line = (char_u *)dp + start;
3101 if (idx == 0) /* line is last in block */
3102 old_len = dp->db_txt_end - start;
3103 else /* text of previous line follows */
3104 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3105 new_len = (colnr_T)STRLEN(new_line) + 1;
3106 extra = new_len - old_len; /* negative if lines gets smaller */
3109 * if new line fits in data block, replace directly
3111 if ((int)dp->db_free >= extra)
3113 /* if the length changes and there are following lines */
3114 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3115 if (extra != 0 && idx < count - 1)
3117 /* move text of following lines */
3118 mch_memmove((char *)dp + dp->db_txt_start - extra,
3119 (char *)dp + dp->db_txt_start,
3120 (size_t)(start - dp->db_txt_start));
3122 /* adjust pointers of this and following lines */
3123 for (i = idx + 1; i < count; ++i)
3124 dp->db_index[i] -= extra;
3126 dp->db_index[idx] -= extra;
3128 /* adjust free space */
3129 dp->db_free -= extra;
3130 dp->db_txt_start -= extra;
3132 /* copy new line into the data block */
3133 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3134 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3135 #ifdef FEAT_BYTEOFF
3136 /* The else case is already covered by the insert and delete */
3137 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3138 #endif
3140 else
3143 * Cannot do it in one data block: Delete and append.
3144 * Append first, because ml_delete_int() cannot delete the
3145 * last line in a buffer, which causes trouble for a buffer
3146 * that has only one line.
3147 * Don't forget to copy the mark!
3149 /* How about handling errors??? */
3150 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3151 (dp->db_index[idx] & DB_MARKED));
3152 (void)ml_delete_int(buf, lnum, FALSE);
3155 vim_free(new_line);
3158 buf->b_ml.ml_line_lnum = 0;
3162 * create a new, empty, data block
3164 static bhdr_T *
3165 ml_new_data(mfp, negative, page_count)
3166 memfile_T *mfp;
3167 int negative;
3168 int page_count;
3170 bhdr_T *hp;
3171 DATA_BL *dp;
3173 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3174 return NULL;
3176 dp = (DATA_BL *)(hp->bh_data);
3177 dp->db_id = DATA_ID;
3178 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3179 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3180 dp->db_line_count = 0;
3182 return hp;
3186 * create a new, empty, pointer block
3188 static bhdr_T *
3189 ml_new_ptr(mfp)
3190 memfile_T *mfp;
3192 bhdr_T *hp;
3193 PTR_BL *pp;
3195 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3196 return NULL;
3198 pp = (PTR_BL *)(hp->bh_data);
3199 pp->pb_id = PTR_ID;
3200 pp->pb_count = 0;
3201 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3203 return hp;
3207 * lookup line 'lnum' in a memline
3209 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3210 * if ML_FLUSH only flush a locked block
3211 * if ML_FIND just find the line
3213 * If the block was found it is locked and put in ml_locked.
3214 * The stack is updated to lead to the locked block. The ip_high field in
3215 * the stack is updated to reflect the last line in the block AFTER the
3216 * insert or delete, also if the pointer block has not been updated yet. But
3217 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3219 * return: NULL for failure, pointer to block header otherwise
3221 static bhdr_T *
3222 ml_find_line(buf, lnum, action)
3223 buf_T *buf;
3224 linenr_T lnum;
3225 int action;
3227 DATA_BL *dp;
3228 PTR_BL *pp;
3229 infoptr_T *ip;
3230 bhdr_T *hp;
3231 memfile_T *mfp;
3232 linenr_T t;
3233 blocknr_T bnum, bnum2;
3234 int dirty;
3235 linenr_T low, high;
3236 int top;
3237 int page_count;
3238 int idx;
3240 mfp = buf->b_ml.ml_mfp;
3243 * If there is a locked block check if the wanted line is in it.
3244 * If not, flush and release the locked block.
3245 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3246 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3247 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3249 if (buf->b_ml.ml_locked)
3251 if (ML_SIMPLE(action)
3252 && buf->b_ml.ml_locked_low <= lnum
3253 && buf->b_ml.ml_locked_high >= lnum
3254 && !mf_dont_release)
3256 /* remember to update pointer blocks and stack later */
3257 if (action == ML_INSERT)
3259 ++(buf->b_ml.ml_locked_lineadd);
3260 ++(buf->b_ml.ml_locked_high);
3262 else if (action == ML_DELETE)
3264 --(buf->b_ml.ml_locked_lineadd);
3265 --(buf->b_ml.ml_locked_high);
3267 return (buf->b_ml.ml_locked);
3270 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3271 buf->b_ml.ml_flags & ML_LOCKED_POS);
3272 buf->b_ml.ml_locked = NULL;
3275 * If lines have been added or deleted in the locked block, need to
3276 * update the line count in pointer blocks.
3278 if (buf->b_ml.ml_locked_lineadd != 0)
3279 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3282 if (action == ML_FLUSH) /* nothing else to do */
3283 return NULL;
3285 bnum = 1; /* start at the root of the tree */
3286 page_count = 1;
3287 low = 1;
3288 high = buf->b_ml.ml_line_count;
3290 if (action == ML_FIND) /* first try stack entries */
3292 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3294 ip = &(buf->b_ml.ml_stack[top]);
3295 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3297 bnum = ip->ip_bnum;
3298 low = ip->ip_low;
3299 high = ip->ip_high;
3300 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3301 break;
3304 if (top < 0)
3305 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3307 else /* ML_DELETE or ML_INSERT */
3308 buf->b_ml.ml_stack_top = 0; /* start at the root */
3311 * search downwards in the tree until a data block is found
3313 for (;;)
3315 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3316 goto error_noblock;
3319 * update high for insert/delete
3321 if (action == ML_INSERT)
3322 ++high;
3323 else if (action == ML_DELETE)
3324 --high;
3326 dp = (DATA_BL *)(hp->bh_data);
3327 if (dp->db_id == DATA_ID) /* data block */
3329 buf->b_ml.ml_locked = hp;
3330 buf->b_ml.ml_locked_low = low;
3331 buf->b_ml.ml_locked_high = high;
3332 buf->b_ml.ml_locked_lineadd = 0;
3333 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3334 return hp;
3337 pp = (PTR_BL *)(dp); /* must be pointer block */
3338 if (pp->pb_id != PTR_ID)
3340 EMSG(_("E317: pointer block id wrong"));
3341 goto error_block;
3344 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3345 goto error_block;
3346 ip = &(buf->b_ml.ml_stack[top]);
3347 ip->ip_bnum = bnum;
3348 ip->ip_low = low;
3349 ip->ip_high = high;
3350 ip->ip_index = -1; /* index not known yet */
3352 dirty = FALSE;
3353 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3355 t = pp->pb_pointer[idx].pe_line_count;
3356 CHECK(t == 0, _("pe_line_count is zero"));
3357 if ((low += t) > lnum)
3359 ip->ip_index = idx;
3360 bnum = pp->pb_pointer[idx].pe_bnum;
3361 page_count = pp->pb_pointer[idx].pe_page_count;
3362 high = low - 1;
3363 low -= t;
3366 * a negative block number may have been changed
3368 if (bnum < 0)
3370 bnum2 = mf_trans_del(mfp, bnum);
3371 if (bnum != bnum2)
3373 bnum = bnum2;
3374 pp->pb_pointer[idx].pe_bnum = bnum;
3375 dirty = TRUE;
3379 break;
3382 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3384 if (lnum > buf->b_ml.ml_line_count)
3385 EMSGN(_("E322: line number out of range: %ld past the end"),
3386 lnum - buf->b_ml.ml_line_count);
3388 else
3389 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3390 goto error_block;
3392 if (action == ML_DELETE)
3394 pp->pb_pointer[idx].pe_line_count--;
3395 dirty = TRUE;
3397 else if (action == ML_INSERT)
3399 pp->pb_pointer[idx].pe_line_count++;
3400 dirty = TRUE;
3402 mf_put(mfp, hp, dirty, FALSE);
3405 error_block:
3406 mf_put(mfp, hp, FALSE, FALSE);
3407 error_noblock:
3409 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3410 * the incremented/decremented line counts, because there won't be a line
3411 * inserted/deleted after all.
3413 if (action == ML_DELETE)
3414 ml_lineadd(buf, 1);
3415 else if (action == ML_INSERT)
3416 ml_lineadd(buf, -1);
3417 buf->b_ml.ml_stack_top = 0;
3418 return NULL;
3422 * add an entry to the info pointer stack
3424 * return -1 for failure, number of the new entry otherwise
3426 static int
3427 ml_add_stack(buf)
3428 buf_T *buf;
3430 int top;
3431 infoptr_T *newstack;
3433 top = buf->b_ml.ml_stack_top;
3435 /* may have to increase the stack size */
3436 if (top == buf->b_ml.ml_stack_size)
3438 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3440 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3441 (buf->b_ml.ml_stack_size + STACK_INCR));
3442 if (newstack == NULL)
3443 return -1;
3444 mch_memmove(newstack, buf->b_ml.ml_stack,
3445 (size_t)top * sizeof(infoptr_T));
3446 vim_free(buf->b_ml.ml_stack);
3447 buf->b_ml.ml_stack = newstack;
3448 buf->b_ml.ml_stack_size += STACK_INCR;
3451 buf->b_ml.ml_stack_top++;
3452 return top;
3456 * Update the pointer blocks on the stack for inserted/deleted lines.
3457 * The stack itself is also updated.
3459 * When a insert/delete line action fails, the line is not inserted/deleted,
3460 * but the pointer blocks have already been updated. That is fixed here by
3461 * walking through the stack.
3463 * Count is the number of lines added, negative if lines have been deleted.
3465 static void
3466 ml_lineadd(buf, count)
3467 buf_T *buf;
3468 int count;
3470 int idx;
3471 infoptr_T *ip;
3472 PTR_BL *pp;
3473 memfile_T *mfp = buf->b_ml.ml_mfp;
3474 bhdr_T *hp;
3476 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3478 ip = &(buf->b_ml.ml_stack[idx]);
3479 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3480 break;
3481 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3482 if (pp->pb_id != PTR_ID)
3484 mf_put(mfp, hp, FALSE, FALSE);
3485 EMSG(_("E317: pointer block id wrong 2"));
3486 break;
3488 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3489 ip->ip_high += count;
3490 mf_put(mfp, hp, TRUE, FALSE);
3494 #ifdef HAVE_READLINK
3495 static int resolve_symlink __ARGS((char_u *fname, char_u *buf));
3498 * Resolve a symlink in the last component of a file name.
3499 * Note that f_resolve() does it for every part of the path, we don't do that
3500 * here.
3501 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3502 * Otherwise returns FAIL.
3504 static int
3505 resolve_symlink(fname, buf)
3506 char_u *fname;
3507 char_u *buf;
3509 char_u tmp[MAXPATHL];
3510 int ret;
3511 int depth = 0;
3513 if (fname == NULL)
3514 return FAIL;
3516 /* Put the result so far in tmp[], starting with the original name. */
3517 vim_strncpy(tmp, fname, MAXPATHL - 1);
3519 for (;;)
3521 /* Limit symlink depth to 100, catch recursive loops. */
3522 if (++depth == 100)
3524 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3525 return FAIL;
3528 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3529 if (ret <= 0)
3531 if (errno == EINVAL || errno == ENOENT)
3533 /* Found non-symlink or not existing file, stop here.
3534 * When at the first level use the unmodified name, skip the
3535 * call to vim_FullName(). */
3536 if (depth == 1)
3537 return FAIL;
3539 /* Use the resolved name in tmp[]. */
3540 break;
3543 /* There must be some error reading links, use original name. */
3544 return FAIL;
3546 buf[ret] = NUL;
3549 * Check whether the symlink is relative or absolute.
3550 * If it's relative, build a new path based on the directory
3551 * portion of the filename (if any) and the path the symlink
3552 * points to.
3554 if (mch_isFullName(buf))
3555 STRCPY(tmp, buf);
3556 else
3558 char_u *tail;
3560 tail = gettail(tmp);
3561 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3562 return FAIL;
3563 STRCPY(tail, buf);
3568 * Try to resolve the full name of the file so that the swapfile name will
3569 * be consistent even when opening a relative symlink from different
3570 * working directories.
3572 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3574 #endif
3577 * Make swap file name out of the file name and a directory name.
3578 * Returns pointer to allocated memory or NULL.
3580 char_u *
3581 makeswapname(fname, ffname, buf, dir_name)
3582 char_u *fname;
3583 char_u *ffname UNUSED;
3584 buf_T *buf;
3585 char_u *dir_name;
3587 char_u *r, *s;
3588 #ifdef HAVE_READLINK
3589 char_u fname_buf[MAXPATHL];
3590 char_u *fname_res;
3591 #endif
3593 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3594 s = dir_name + STRLEN(dir_name);
3595 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3596 { /* Ends with '//', Use Full path */
3597 r = NULL;
3598 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3600 r = modname(s, (char_u *)".swp", FALSE);
3601 vim_free(s);
3603 return r;
3605 #endif
3607 #ifdef HAVE_READLINK
3608 /* Expand symlink in the file name, so that we put the swap file with the
3609 * actual file instead of with the symlink. */
3610 if (resolve_symlink(fname, fname_buf) == OK)
3611 fname_res = fname_buf;
3612 else
3613 fname_res = fname;
3614 #endif
3616 r = buf_modname(
3617 #ifdef SHORT_FNAME
3618 TRUE,
3619 #else
3620 (buf->b_p_sn || buf->b_shortname),
3621 #endif
3622 #ifdef RISCOS
3623 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3624 ffname,
3625 #else
3626 # ifdef HAVE_READLINK
3627 fname_res,
3628 # else
3629 fname,
3630 # endif
3631 #endif
3632 (char_u *)
3633 #if defined(VMS) || defined(RISCOS)
3634 "_swp",
3635 #else
3636 ".swp",
3637 #endif
3638 #ifdef SHORT_FNAME /* always 8.3 file name */
3639 FALSE
3640 #else
3641 /* Prepend a '.' to the swap file name for the current directory. */
3642 dir_name[0] == '.' && dir_name[1] == NUL
3643 #endif
3645 if (r == NULL) /* out of memory */
3646 return NULL;
3648 s = get_file_in_dir(r, dir_name);
3649 vim_free(r);
3650 return s;
3654 * Get file name to use for swap file or backup file.
3655 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3656 * option "dname".
3657 * - If "dname" is ".", return "fname" (swap file in dir of file).
3658 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3659 * relative to dir of file).
3660 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3661 * dir).
3663 * The return value is an allocated string and can be NULL.
3665 char_u *
3666 get_file_in_dir(fname, dname)
3667 char_u *fname;
3668 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3670 char_u *t;
3671 char_u *tail;
3672 char_u *retval;
3673 int save_char;
3675 tail = gettail(fname);
3677 if (dname[0] == '.' && dname[1] == NUL)
3678 retval = vim_strsave(fname);
3679 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3681 if (tail == fname) /* no path before file name */
3682 retval = concat_fnames(dname + 2, tail, TRUE);
3683 else
3685 save_char = *tail;
3686 *tail = NUL;
3687 t = concat_fnames(fname, dname + 2, TRUE);
3688 *tail = save_char;
3689 if (t == NULL) /* out of memory */
3690 retval = NULL;
3691 else
3693 retval = concat_fnames(t, tail, TRUE);
3694 vim_free(t);
3698 else
3699 retval = concat_fnames(dname, tail, TRUE);
3701 return retval;
3704 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3707 * Print the ATTENTION message: info about an existing swap file.
3709 static void
3710 attention_message(buf, fname)
3711 buf_T *buf; /* buffer being edited */
3712 char_u *fname; /* swap file name */
3714 struct stat st;
3715 time_t x, sx;
3716 char *p;
3718 ++no_wait_return;
3719 (void)EMSG(_("E325: ATTENTION"));
3720 MSG_PUTS(_("\nFound a swap file by the name \""));
3721 msg_home_replace(fname);
3722 MSG_PUTS("\"\n");
3723 sx = swapfile_info(fname);
3724 MSG_PUTS(_("While opening file \""));
3725 msg_outtrans(buf->b_fname);
3726 MSG_PUTS("\"\n");
3727 if (mch_stat((char *)buf->b_fname, &st) != -1)
3729 MSG_PUTS(_(" dated: "));
3730 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3731 p = ctime(&x); /* includes '\n' */
3732 if (p == NULL)
3733 MSG_PUTS("(invalid)\n");
3734 else
3735 MSG_PUTS(p);
3736 if (sx != 0 && x > sx)
3737 MSG_PUTS(_(" NEWER than swap file!\n"));
3739 /* Some of these messages are long to allow translation to
3740 * other languages. */
3741 MSG_PUTS(_("\n(1) Another program may be editing the same file.\n If this is the case, be careful not to end up with two\n different instances of the same file when making changes.\n"));
3742 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3743 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3744 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3745 msg_outtrans(buf->b_fname);
3746 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3747 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3748 msg_outtrans(fname);
3749 MSG_PUTS(_("\"\n to avoid this message.\n"));
3750 cmdline_row = msg_row;
3751 --no_wait_return;
3754 #ifdef FEAT_AUTOCMD
3755 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3758 * Trigger the SwapExists autocommands.
3759 * Returns a value for equivalent to do_dialog() (see below):
3760 * 0: still need to ask for a choice
3761 * 1: open read-only
3762 * 2: edit anyway
3763 * 3: recover
3764 * 4: delete it
3765 * 5: quit
3766 * 6: abort
3768 static int
3769 do_swapexists(buf, fname)
3770 buf_T *buf;
3771 char_u *fname;
3773 set_vim_var_string(VV_SWAPNAME, fname, -1);
3774 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3776 /* Trigger SwapExists autocommands with <afile> set to the file being
3777 * edited. Disallow changing directory here. */
3778 ++allbuf_lock;
3779 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3780 --allbuf_lock;
3782 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3784 switch (*get_vim_var_str(VV_SWAPCHOICE))
3786 case 'o': return 1;
3787 case 'e': return 2;
3788 case 'r': return 3;
3789 case 'd': return 4;
3790 case 'q': return 5;
3791 case 'a': return 6;
3794 return 0;
3796 #endif
3799 * Find out what name to use for the swap file for buffer 'buf'.
3801 * Several names are tried to find one that does not exist
3802 * Returns the name in allocated memory or NULL.
3804 * Note: If BASENAMELEN is not correct, you will get error messages for
3805 * not being able to open the swapfile
3806 * Note: May trigger SwapExists autocmd, pointers may change!
3808 static char_u *
3809 findswapname(buf, dirp, old_fname)
3810 buf_T *buf;
3811 char_u **dirp; /* pointer to list of directories */
3812 char_u *old_fname; /* don't give warning for this file name */
3814 char_u *fname;
3815 int n;
3816 char_u *dir_name;
3817 #ifdef AMIGA
3818 BPTR fh;
3819 #endif
3820 #ifndef SHORT_FNAME
3821 int r;
3822 #endif
3824 #if !defined(SHORT_FNAME) \
3825 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3826 # define CREATE_DUMMY_FILE
3827 FILE *dummyfd = NULL;
3830 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3831 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3832 * create will be exactly the same file. To avoid this problem we temporarily
3833 * create "test.doc".
3834 * Don't do this when the check below for a 8.3 file name is used.
3836 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3837 && mch_getperm(buf->b_fname) < 0)
3838 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3839 #endif
3842 * Isolate a directory name from *dirp and put it in dir_name.
3843 * First allocate some memory to put the directory name in.
3845 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3846 if (dir_name != NULL)
3847 (void)copy_option_part(dirp, dir_name, 31000, ",");
3850 * we try different names until we find one that does not exist yet
3852 if (dir_name == NULL) /* out of memory */
3853 fname = NULL;
3854 else
3855 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3857 for (;;)
3859 if (fname == NULL) /* must be out of memory */
3860 break;
3861 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3863 vim_free(fname);
3864 fname = NULL;
3865 break;
3867 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3869 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3870 * file names. If this is the first try and the swap file name does not fit in
3871 * 8.3, detect if this is the case, set shortname and try again.
3873 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3874 && !(buf->b_p_sn || buf->b_shortname))
3876 char_u *tail;
3877 char_u *fname2;
3878 struct stat s1, s2;
3879 int f1, f2;
3880 int created1 = FALSE, created2 = FALSE;
3881 int same = FALSE;
3884 * Check if swapfile name does not fit in 8.3:
3885 * It either contains two dots, is longer than 8 chars, or starts
3886 * with a dot.
3888 tail = gettail(buf->b_fname);
3889 if ( vim_strchr(tail, '.') != NULL
3890 || STRLEN(tail) > (size_t)8
3891 || *gettail(fname) == '.')
3893 fname2 = alloc(n + 2);
3894 if (fname2 != NULL)
3896 STRCPY(fname2, fname);
3897 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3898 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3899 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3901 if (vim_strchr(tail, '.') != NULL)
3902 fname2[n - 1] = 'x';
3903 else if (*gettail(fname) == '.')
3905 fname2[n] = 'x';
3906 fname2[n + 1] = NUL;
3908 else
3909 fname2[n - 5] += 1;
3911 * may need to create the files to be able to use mch_stat()
3913 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3914 if (f1 < 0)
3916 f1 = mch_open_rw((char *)fname,
3917 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3918 #if defined(OS2)
3919 if (f1 < 0 && errno == ENOENT)
3920 same = TRUE;
3921 #endif
3922 created1 = TRUE;
3924 if (f1 >= 0)
3926 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3927 if (f2 < 0)
3929 f2 = mch_open_rw((char *)fname2,
3930 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3931 created2 = TRUE;
3933 if (f2 >= 0)
3936 * Both files exist now. If mch_stat() returns the
3937 * same device and inode they are the same file.
3939 if (mch_fstat(f1, &s1) != -1
3940 && mch_fstat(f2, &s2) != -1
3941 && s1.st_dev == s2.st_dev
3942 && s1.st_ino == s2.st_ino)
3943 same = TRUE;
3944 close(f2);
3945 if (created2)
3946 mch_remove(fname2);
3948 close(f1);
3949 if (created1)
3950 mch_remove(fname);
3952 vim_free(fname2);
3953 if (same)
3955 buf->b_shortname = TRUE;
3956 vim_free(fname);
3957 fname = makeswapname(buf->b_fname, buf->b_ffname,
3958 buf, dir_name);
3959 continue; /* try again with b_shortname set */
3964 #endif
3966 * check if the swapfile already exists
3968 if (mch_getperm(fname) < 0) /* it does not exist */
3970 #ifdef HAVE_LSTAT
3971 struct stat sb;
3974 * Extra security check: When a swap file is a symbolic link, this
3975 * is most likely a symlink attack.
3977 if (mch_lstat((char *)fname, &sb) < 0)
3978 #else
3979 # ifdef AMIGA
3980 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
3982 * on the Amiga mch_getperm() will return -1 when the file exists
3983 * but is being used by another program. This happens if you edit
3984 * a file twice.
3986 if (fh != (BPTR)NULL) /* can open file, OK */
3988 Close(fh);
3989 mch_remove(fname);
3990 break;
3992 if (IoErr() != ERROR_OBJECT_IN_USE
3993 && IoErr() != ERROR_OBJECT_EXISTS)
3994 # endif
3995 #endif
3996 break;
4000 * A file name equal to old_fname is OK to use.
4002 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4003 break;
4006 * get here when file already exists
4008 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4010 #ifndef SHORT_FNAME
4012 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4013 * and file.doc are the same file. To guess if this problem is
4014 * present try if file.doc.swx exists. If it does, we set
4015 * buf->b_shortname and try file_doc.swp (dots replaced by
4016 * underscores for this file), and try again. If it doesn't we
4017 * assume that "file.doc.swp" already exists.
4019 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4021 fname[n - 1] = 'x';
4022 r = mch_getperm(fname); /* try "file.swx" */
4023 fname[n - 1] = 'p';
4024 if (r >= 0) /* "file.swx" seems to exist */
4026 buf->b_shortname = TRUE;
4027 vim_free(fname);
4028 fname = makeswapname(buf->b_fname, buf->b_ffname,
4029 buf, dir_name);
4030 continue; /* try again with '.' replaced with '_' */
4033 #endif
4035 * If we get here the ".swp" file really exists.
4036 * Give an error message, unless recovering, no file name, we are
4037 * viewing a help file or when the path of the file is different
4038 * (happens when all .swp files are in one directory).
4040 if (!recoverymode && buf->b_fname != NULL
4041 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4043 int fd;
4044 struct block0 b0;
4045 int differ = FALSE;
4048 * Try to read block 0 from the swap file to get the original
4049 * file name (and inode number).
4051 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4052 if (fd >= 0)
4054 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4057 * If the swapfile has the same directory as the
4058 * buffer don't compare the directory names, they can
4059 * have a different mountpoint.
4061 if (b0.b0_flags & B0_SAME_DIR)
4063 if (fnamecmp(gettail(buf->b_ffname),
4064 gettail(b0.b0_fname)) != 0
4065 || !same_directory(fname, buf->b_ffname))
4067 #ifdef CHECK_INODE
4068 /* Symlinks may point to the same file even
4069 * when the name differs, need to check the
4070 * inode too. */
4071 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4072 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4073 char_to_long(b0.b0_ino)))
4074 #endif
4075 differ = TRUE;
4078 else
4081 * The name in the swap file may be
4082 * "~user/path/file". Expand it first.
4084 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4085 #ifdef CHECK_INODE
4086 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4087 char_to_long(b0.b0_ino)))
4088 differ = TRUE;
4089 #else
4090 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4091 differ = TRUE;
4092 #endif
4095 close(fd);
4097 #ifdef RISCOS
4098 else
4099 /* Can't open swap file, though it does exist.
4100 * Assume that the user is editing two files with
4101 * the same name in different directories. No error.
4103 differ = TRUE;
4104 #endif
4106 /* give the ATTENTION message when there is an old swap file
4107 * for the current file, and the buffer was not recovered. */
4108 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4109 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4111 #if defined(HAS_SWAP_EXISTS_ACTION)
4112 int choice = 0;
4113 #endif
4114 #ifdef CREATE_DUMMY_FILE
4115 int did_use_dummy = FALSE;
4117 /* Avoid getting a warning for the file being created
4118 * outside of Vim, it was created at the start of this
4119 * function. Delete the file now, because Vim might exit
4120 * here if the window is closed. */
4121 if (dummyfd != NULL)
4123 fclose(dummyfd);
4124 dummyfd = NULL;
4125 mch_remove(buf->b_fname);
4126 did_use_dummy = TRUE;
4128 #endif
4130 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4131 process_still_running = FALSE;
4132 #endif
4133 #ifdef FEAT_AUTOCMD
4135 * If there is an SwapExists autocommand and we can handle
4136 * the response, trigger it. It may return 0 to ask the
4137 * user anyway.
4139 if (swap_exists_action != SEA_NONE
4140 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4141 choice = do_swapexists(buf, fname);
4143 if (choice == 0)
4144 #endif
4146 #ifdef FEAT_GUI
4147 /* If we are supposed to start the GUI but it wasn't
4148 * completely started yet, start it now. This makes
4149 * the messages displayed in the Vim window when
4150 * loading a session from the .gvimrc file. */
4151 if (gui.starting && !gui.in_use)
4152 gui_start();
4153 #endif
4154 /* Show info about the existing swap file. */
4155 attention_message(buf, fname);
4157 /* We don't want a 'q' typed at the more-prompt
4158 * interrupt loading a file. */
4159 got_int = FALSE;
4162 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4163 if (swap_exists_action != SEA_NONE && choice == 0)
4165 char_u *name;
4167 name = alloc((unsigned)(STRLEN(fname)
4168 + STRLEN(_("Swap file \""))
4169 + STRLEN(_("\" already exists!")) + 5));
4170 if (name != NULL)
4172 STRCPY(name, _("Swap file \""));
4173 home_replace(NULL, fname, name + STRLEN(name),
4174 1000, TRUE);
4175 STRCAT(name, _("\" already exists!"));
4177 choice = do_dialog(VIM_WARNING,
4178 (char_u *)_("VIM - ATTENTION"),
4179 name == NULL
4180 ? (char_u *)_("Swap file already exists!")
4181 : name,
4182 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4183 process_still_running
4184 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4185 # endif
4186 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4188 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4189 if (process_still_running && choice >= 4)
4190 choice++; /* Skip missing "Delete it" button */
4191 # endif
4192 vim_free(name);
4194 /* pretend screen didn't scroll, need redraw anyway */
4195 msg_scrolled = 0;
4196 redraw_all_later(NOT_VALID);
4198 #endif
4200 #if defined(HAS_SWAP_EXISTS_ACTION)
4201 if (choice > 0)
4203 switch (choice)
4205 case 1:
4206 buf->b_p_ro = TRUE;
4207 break;
4208 case 2:
4209 break;
4210 case 3:
4211 swap_exists_action = SEA_RECOVER;
4212 break;
4213 case 4:
4214 mch_remove(fname);
4215 break;
4216 case 5:
4217 swap_exists_action = SEA_QUIT;
4218 break;
4219 case 6:
4220 swap_exists_action = SEA_QUIT;
4221 got_int = TRUE;
4222 break;
4225 /* If the file was deleted this fname can be used. */
4226 if (mch_getperm(fname) < 0)
4227 break;
4229 else
4230 #endif
4232 MSG_PUTS("\n");
4233 if (msg_silent == 0)
4234 /* call wait_return() later */
4235 need_wait_return = TRUE;
4238 #ifdef CREATE_DUMMY_FILE
4239 /* Going to try another name, need the dummy file again. */
4240 if (did_use_dummy)
4241 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4242 #endif
4248 * Change the ".swp" extension to find another file that can be used.
4249 * First decrement the last char: ".swo", ".swn", etc.
4250 * If that still isn't enough decrement the last but one char: ".svz"
4251 * Can happen when editing many "No Name" buffers.
4253 if (fname[n - 1] == 'a') /* ".s?a" */
4255 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4257 EMSG(_("E326: Too many swap files found"));
4258 vim_free(fname);
4259 fname = NULL;
4260 break;
4262 --fname[n - 2]; /* ".svz", ".suz", etc. */
4263 fname[n - 1] = 'z' + 1;
4265 --fname[n - 1]; /* ".swo", ".swn", etc. */
4268 vim_free(dir_name);
4269 #ifdef CREATE_DUMMY_FILE
4270 if (dummyfd != NULL) /* file has been created temporarily */
4272 fclose(dummyfd);
4273 mch_remove(buf->b_fname);
4275 #endif
4276 return fname;
4279 static int
4280 b0_magic_wrong(b0p)
4281 ZERO_BL *b0p;
4283 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4284 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4285 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4286 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4289 #ifdef CHECK_INODE
4291 * Compare current file name with file name from swap file.
4292 * Try to use inode numbers when possible.
4293 * Return non-zero when files are different.
4295 * When comparing file names a few things have to be taken into consideration:
4296 * - When working over a network the full path of a file depends on the host.
4297 * We check the inode number if possible. It is not 100% reliable though,
4298 * because the device number cannot be used over a network.
4299 * - When a file does not exist yet (editing a new file) there is no inode
4300 * number.
4301 * - The file name in a swap file may not be valid on the current host. The
4302 * "~user" form is used whenever possible to avoid this.
4304 * This is getting complicated, let's make a table:
4306 * ino_c ino_s fname_c fname_s differ =
4308 * both files exist -> compare inode numbers:
4309 * != 0 != 0 X X ino_c != ino_s
4311 * inode number(s) unknown, file names available -> compare file names
4312 * == 0 X OK OK fname_c != fname_s
4313 * X == 0 OK OK fname_c != fname_s
4315 * current file doesn't exist, file for swap file exist, file name(s) not
4316 * available -> probably different
4317 * == 0 != 0 FAIL X TRUE
4318 * == 0 != 0 X FAIL TRUE
4320 * current file exists, inode for swap unknown, file name(s) not
4321 * available -> probably different
4322 * != 0 == 0 FAIL X TRUE
4323 * != 0 == 0 X FAIL TRUE
4325 * current file doesn't exist, inode for swap unknown, one file name not
4326 * available -> probably different
4327 * == 0 == 0 FAIL OK TRUE
4328 * == 0 == 0 OK FAIL TRUE
4330 * current file doesn't exist, inode for swap unknown, both file names not
4331 * available -> probably same file
4332 * == 0 == 0 FAIL FAIL FALSE
4334 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4335 * can't be changed without making the block 0 incompatible with 32 bit
4336 * versions.
4339 static int
4340 fnamecmp_ino(fname_c, fname_s, ino_block0)
4341 char_u *fname_c; /* current file name */
4342 char_u *fname_s; /* file name from swap file */
4343 long ino_block0;
4345 struct stat st;
4346 ino_t ino_c = 0; /* ino of current file */
4347 ino_t ino_s; /* ino of file from swap file */
4348 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4349 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4350 int retval_c; /* flag: buf_c valid */
4351 int retval_s; /* flag: buf_s valid */
4353 if (mch_stat((char *)fname_c, &st) == 0)
4354 ino_c = (ino_t)st.st_ino;
4357 * First we try to get the inode from the file name, because the inode in
4358 * the swap file may be outdated. If that fails (e.g. this path is not
4359 * valid on this machine), use the inode from block 0.
4361 if (mch_stat((char *)fname_s, &st) == 0)
4362 ino_s = (ino_t)st.st_ino;
4363 else
4364 ino_s = (ino_t)ino_block0;
4366 if (ino_c && ino_s)
4367 return (ino_c != ino_s);
4370 * One of the inode numbers is unknown, try a forced vim_FullName() and
4371 * compare the file names.
4373 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4374 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4375 if (retval_c == OK && retval_s == OK)
4376 return (STRCMP(buf_c, buf_s) != 0);
4379 * Can't compare inodes or file names, guess that the files are different,
4380 * unless both appear not to exist at all.
4382 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4383 return FALSE;
4384 return TRUE;
4386 #endif /* CHECK_INODE */
4389 * Move a long integer into a four byte character array.
4390 * Used for machine independency in block zero.
4392 static void
4393 long_to_char(n, s)
4394 long n;
4395 char_u *s;
4397 s[0] = (char_u)(n & 0xff);
4398 n = (unsigned)n >> 8;
4399 s[1] = (char_u)(n & 0xff);
4400 n = (unsigned)n >> 8;
4401 s[2] = (char_u)(n & 0xff);
4402 n = (unsigned)n >> 8;
4403 s[3] = (char_u)(n & 0xff);
4406 static long
4407 char_to_long(s)
4408 char_u *s;
4410 long retval;
4412 retval = s[3];
4413 retval <<= 8;
4414 retval |= s[2];
4415 retval <<= 8;
4416 retval |= s[1];
4417 retval <<= 8;
4418 retval |= s[0];
4420 return retval;
4424 * Set the flags in the first block of the swap file:
4425 * - file is modified or not: buf->b_changed
4426 * - 'fileformat'
4427 * - 'fileencoding'
4429 void
4430 ml_setflags(buf)
4431 buf_T *buf;
4433 bhdr_T *hp;
4434 ZERO_BL *b0p;
4436 if (!buf->b_ml.ml_mfp)
4437 return;
4438 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4440 if (hp->bh_bnum == 0)
4442 b0p = (ZERO_BL *)(hp->bh_data);
4443 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4444 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4445 | (get_fileformat(buf) + 1);
4446 #ifdef FEAT_MBYTE
4447 add_b0_fenc(b0p, buf);
4448 #endif
4449 hp->bh_flags |= BH_DIRTY;
4450 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4451 break;
4456 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4458 #define MLCS_MAXL 800 /* max no of lines in chunk */
4459 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4462 * Keep information for finding byte offset of a line, updtytpe may be one of:
4463 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4464 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4465 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4466 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4468 static void
4469 ml_updatechunk(buf, line, len, updtype)
4470 buf_T *buf;
4471 linenr_T line;
4472 long len;
4473 int updtype;
4475 static buf_T *ml_upd_lastbuf = NULL;
4476 static linenr_T ml_upd_lastline;
4477 static linenr_T ml_upd_lastcurline;
4478 static int ml_upd_lastcurix;
4480 linenr_T curline = ml_upd_lastcurline;
4481 int curix = ml_upd_lastcurix;
4482 long size;
4483 chunksize_T *curchnk;
4484 int rest;
4485 bhdr_T *hp;
4486 DATA_BL *dp;
4488 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4489 return;
4490 if (buf->b_ml.ml_chunksize == NULL)
4492 buf->b_ml.ml_chunksize = (chunksize_T *)
4493 alloc((unsigned)sizeof(chunksize_T) * 100);
4494 if (buf->b_ml.ml_chunksize == NULL)
4496 buf->b_ml.ml_usedchunks = -1;
4497 return;
4499 buf->b_ml.ml_numchunks = 100;
4500 buf->b_ml.ml_usedchunks = 1;
4501 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4502 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4505 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4508 * First line in empty buffer from ml_flush_line() -- reset
4510 buf->b_ml.ml_usedchunks = 1;
4511 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4512 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4513 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4514 return;
4518 * Find chunk that our line belongs to, curline will be at start of the
4519 * chunk.
4521 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4522 || updtype != ML_CHNK_ADDLINE)
4524 for (curline = 1, curix = 0;
4525 curix < buf->b_ml.ml_usedchunks - 1
4526 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4527 curix++)
4529 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4532 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4533 && curix < buf->b_ml.ml_usedchunks - 1)
4535 /* Adjust cached curix & curline */
4536 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4537 curix++;
4539 curchnk = buf->b_ml.ml_chunksize + curix;
4541 if (updtype == ML_CHNK_DELLINE)
4542 len = -len;
4543 curchnk->mlcs_totalsize += len;
4544 if (updtype == ML_CHNK_ADDLINE)
4546 curchnk->mlcs_numlines++;
4548 /* May resize here so we don't have to do it in both cases below */
4549 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4551 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4552 buf->b_ml.ml_chunksize = (chunksize_T *)
4553 vim_realloc(buf->b_ml.ml_chunksize,
4554 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4555 if (buf->b_ml.ml_chunksize == NULL)
4557 /* Hmmmm, Give up on offset for this buffer */
4558 buf->b_ml.ml_usedchunks = -1;
4559 return;
4563 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4565 int count; /* number of entries in block */
4566 int idx;
4567 int text_end;
4568 int linecnt;
4570 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4571 buf->b_ml.ml_chunksize + curix,
4572 (buf->b_ml.ml_usedchunks - curix) *
4573 sizeof(chunksize_T));
4574 /* Compute length of first half of lines in the split chunk */
4575 size = 0;
4576 linecnt = 0;
4577 while (curline < buf->b_ml.ml_line_count
4578 && linecnt < MLCS_MINL)
4580 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4582 buf->b_ml.ml_usedchunks = -1;
4583 return;
4585 dp = (DATA_BL *)(hp->bh_data);
4586 count = (long)(buf->b_ml.ml_locked_high) -
4587 (long)(buf->b_ml.ml_locked_low) + 1;
4588 idx = curline - buf->b_ml.ml_locked_low;
4589 curline = buf->b_ml.ml_locked_high + 1;
4590 if (idx == 0)/* first line in block, text at the end */
4591 text_end = dp->db_txt_end;
4592 else
4593 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4594 /* Compute index of last line to use in this MEMLINE */
4595 rest = count - idx;
4596 if (linecnt + rest > MLCS_MINL)
4598 idx += MLCS_MINL - linecnt - 1;
4599 linecnt = MLCS_MINL;
4601 else
4603 idx = count - 1;
4604 linecnt += rest;
4606 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4608 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4609 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4610 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4611 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4612 buf->b_ml.ml_usedchunks++;
4613 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4614 return;
4616 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4617 && curix == buf->b_ml.ml_usedchunks - 1
4618 && buf->b_ml.ml_line_count - line <= 1)
4621 * We are in the last chunk and it is cheap to crate a new one
4622 * after this. Do it now to avoid the loop above later on
4624 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4625 buf->b_ml.ml_usedchunks++;
4626 if (line == buf->b_ml.ml_line_count)
4628 curchnk->mlcs_numlines = 0;
4629 curchnk->mlcs_totalsize = 0;
4631 else
4634 * Line is just prior to last, move count for last
4635 * This is the common case when loading a new file
4637 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4638 if (hp == NULL)
4640 buf->b_ml.ml_usedchunks = -1;
4641 return;
4643 dp = (DATA_BL *)(hp->bh_data);
4644 if (dp->db_line_count == 1)
4645 rest = dp->db_txt_end - dp->db_txt_start;
4646 else
4647 rest =
4648 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4649 - dp->db_txt_start;
4650 curchnk->mlcs_totalsize = rest;
4651 curchnk->mlcs_numlines = 1;
4652 curchnk[-1].mlcs_totalsize -= rest;
4653 curchnk[-1].mlcs_numlines -= 1;
4657 else if (updtype == ML_CHNK_DELLINE)
4659 curchnk->mlcs_numlines--;
4660 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4661 if (curix < (buf->b_ml.ml_usedchunks - 1)
4662 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4663 <= MLCS_MINL)
4665 curix++;
4666 curchnk = buf->b_ml.ml_chunksize + curix;
4668 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4670 buf->b_ml.ml_usedchunks--;
4671 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4672 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4673 return;
4675 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4676 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4677 > MLCS_MINL))
4679 return;
4682 /* Collapse chunks */
4683 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4684 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4685 buf->b_ml.ml_usedchunks--;
4686 if (curix < buf->b_ml.ml_usedchunks)
4688 mch_memmove(buf->b_ml.ml_chunksize + curix,
4689 buf->b_ml.ml_chunksize + curix + 1,
4690 (buf->b_ml.ml_usedchunks - curix) *
4691 sizeof(chunksize_T));
4693 return;
4695 ml_upd_lastbuf = buf;
4696 ml_upd_lastline = line;
4697 ml_upd_lastcurline = curline;
4698 ml_upd_lastcurix = curix;
4702 * Find offset for line or line with offset.
4703 * Find line with offset if "lnum" is 0; return remaining offset in offp
4704 * Find offset of line if "lnum" > 0
4705 * return -1 if information is not available
4707 long
4708 ml_find_line_or_offset(buf, lnum, offp)
4709 buf_T *buf;
4710 linenr_T lnum;
4711 long *offp;
4713 linenr_T curline;
4714 int curix;
4715 long size;
4716 bhdr_T *hp;
4717 DATA_BL *dp;
4718 int count; /* number of entries in block */
4719 int idx;
4720 int start_idx;
4721 int text_end;
4722 long offset;
4723 int len;
4724 int ffdos = (get_fileformat(buf) == EOL_DOS);
4725 int extra = 0;
4727 /* take care of cached line first */
4728 ml_flush_line(curbuf);
4730 if (buf->b_ml.ml_usedchunks == -1
4731 || buf->b_ml.ml_chunksize == NULL
4732 || lnum < 0)
4733 return -1;
4735 if (offp == NULL)
4736 offset = 0;
4737 else
4738 offset = *offp;
4739 if (lnum == 0 && offset <= 0)
4740 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4742 * Find the last chunk before the one containing our line. Last chunk is
4743 * special because it will never qualify
4745 curline = 1;
4746 curix = size = 0;
4747 while (curix < buf->b_ml.ml_usedchunks - 1
4748 && ((lnum != 0
4749 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4750 || (offset != 0
4751 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4752 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4754 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4755 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4756 if (offset && ffdos)
4757 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4758 curix++;
4761 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4763 if (curline > buf->b_ml.ml_line_count
4764 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4765 return -1;
4766 dp = (DATA_BL *)(hp->bh_data);
4767 count = (long)(buf->b_ml.ml_locked_high) -
4768 (long)(buf->b_ml.ml_locked_low) + 1;
4769 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4770 if (idx == 0)/* first line in block, text at the end */
4771 text_end = dp->db_txt_end;
4772 else
4773 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4774 /* Compute index of last line to use in this MEMLINE */
4775 if (lnum != 0)
4777 if (curline + (count - idx) >= lnum)
4778 idx += lnum - curline - 1;
4779 else
4780 idx = count - 1;
4782 else
4784 extra = 0;
4785 while (offset >= size
4786 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4787 + ffdos)
4789 if (ffdos)
4790 size++;
4791 if (idx == count - 1)
4793 extra = 1;
4794 break;
4796 idx++;
4799 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4800 size += len;
4801 if (offset != 0 && size >= offset)
4803 if (size + ffdos == offset)
4804 *offp = 0;
4805 else if (idx == start_idx)
4806 *offp = offset - size + len;
4807 else
4808 *offp = offset - size + len
4809 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4810 curline += idx - start_idx + extra;
4811 if (curline > buf->b_ml.ml_line_count)
4812 return -1; /* exactly one byte beyond the end */
4813 return curline;
4815 curline = buf->b_ml.ml_locked_high + 1;
4818 if (lnum != 0)
4820 /* Count extra CR characters. */
4821 if (ffdos)
4822 size += lnum - 1;
4824 /* Don't count the last line break if 'bin' and 'noeol'. */
4825 if (buf->b_p_bin && !buf->b_p_eol)
4826 size -= ffdos + 1;
4829 return size;
4833 * Goto byte in buffer with offset 'cnt'.
4835 void
4836 goto_byte(cnt)
4837 long cnt;
4839 long boff = cnt;
4840 linenr_T lnum;
4842 ml_flush_line(curbuf); /* cached line may be dirty */
4843 setpcmark();
4844 if (boff)
4845 --boff;
4846 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4847 if (lnum < 1) /* past the end */
4849 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4850 curwin->w_curswant = MAXCOL;
4851 coladvance((colnr_T)MAXCOL);
4853 else
4855 curwin->w_cursor.lnum = lnum;
4856 curwin->w_cursor.col = (colnr_T)boff;
4857 # ifdef FEAT_VIRTUALEDIT
4858 curwin->w_cursor.coladd = 0;
4859 # endif
4860 curwin->w_set_curswant = TRUE;
4862 check_cursor();
4864 # ifdef FEAT_MBYTE
4865 /* Make sure the cursor is on the first byte of a multi-byte char. */
4866 if (has_mbyte)
4867 mb_adjust_cursor();
4868 # endif
4870 #endif