Merge branch 'feat/tagfunc'
[vim_extended.git] / src / memline.c
blob1d3f3e251908ad749c93921897da8586515a2c0d
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
248 #ifdef HAVE_READLINK
249 static int resolve_symlink __ARGS((char_u *fname, char_u *buf));
250 #endif
253 * Open a new memline for "buf".
255 * Return FAIL for failure, OK otherwise.
258 ml_open(buf)
259 buf_T *buf;
261 memfile_T *mfp;
262 bhdr_T *hp = NULL;
263 ZERO_BL *b0p;
264 PTR_BL *pp;
265 DATA_BL *dp;
268 * init fields in memline struct
270 buf->b_ml.ml_stack_size = 0; /* no stack yet */
271 buf->b_ml.ml_stack = NULL; /* no stack yet */
272 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
273 buf->b_ml.ml_locked = NULL; /* no cached block */
274 buf->b_ml.ml_line_lnum = 0; /* no cached line */
275 #ifdef FEAT_BYTEOFF
276 buf->b_ml.ml_chunksize = NULL;
277 #endif
280 * When 'updatecount' is non-zero swap file may be opened later.
282 if (p_uc && buf->b_p_swf)
283 buf->b_may_swap = TRUE;
284 else
285 buf->b_may_swap = FALSE;
288 * Open the memfile. No swap file is created yet.
290 mfp = mf_open(NULL, 0);
291 if (mfp == NULL)
292 goto error;
294 buf->b_ml.ml_mfp = mfp;
295 buf->b_ml.ml_flags = ML_EMPTY;
296 buf->b_ml.ml_line_max = 0;
297 buf->b_ml.ml_line_count = 1;
298 #ifdef FEAT_LINEBREAK
299 curwin->w_nrwidth_line_count = 0;
300 #endif
302 #if defined(MSDOS) && !defined(DJGPP)
303 /* for 16 bit MS-DOS create a swapfile now, because we run out of
304 * memory very quickly */
305 if (p_uc != 0)
306 ml_open_file(buf);
307 #endif
310 * fill block0 struct and write page 0
312 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
313 goto error;
314 if (hp->bh_bnum != 0)
316 EMSG(_("E298: Didn't get block nr 0?"));
317 goto error;
319 b0p = (ZERO_BL *)(hp->bh_data);
321 b0p->b0_id[0] = BLOCK0_ID0;
322 b0p->b0_id[1] = BLOCK0_ID1;
323 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
324 b0p->b0_magic_int = (int)B0_MAGIC_INT;
325 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
326 b0p->b0_magic_char = B0_MAGIC_CHAR;
327 STRNCPY(b0p->b0_version, "VIM ", 4);
328 STRNCPY(b0p->b0_version + 4, Version, 6);
329 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
331 #ifdef FEAT_SPELL
332 if (!buf->b_spell)
333 #endif
335 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
336 b0p->b0_flags = get_fileformat(buf) + 1;
337 set_b0_fname(b0p, buf);
338 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
339 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
340 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
341 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
342 long_to_char(mch_get_pid(), b0p->b0_pid);
346 * Always sync block number 0 to disk, so we can check the file name in
347 * the swap file in findswapname(). Don't do this for help files though
348 * and spell buffer though.
349 * Only works when there's a swapfile, otherwise it's done when the file
350 * is created.
352 mf_put(mfp, hp, TRUE, FALSE);
353 if (!buf->b_help && !B_SPELL(buf))
354 (void)mf_sync(mfp, 0);
357 * Fill in root pointer block and write page 1.
359 if ((hp = ml_new_ptr(mfp)) == NULL)
360 goto error;
361 if (hp->bh_bnum != 1)
363 EMSG(_("E298: Didn't get block nr 1?"));
364 goto error;
366 pp = (PTR_BL *)(hp->bh_data);
367 pp->pb_count = 1;
368 pp->pb_pointer[0].pe_bnum = 2;
369 pp->pb_pointer[0].pe_page_count = 1;
370 pp->pb_pointer[0].pe_old_lnum = 1;
371 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
372 mf_put(mfp, hp, TRUE, FALSE);
375 * Allocate first data block and create an empty line 1.
377 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
378 goto error;
379 if (hp->bh_bnum != 2)
381 EMSG(_("E298: Didn't get block nr 2?"));
382 goto error;
385 dp = (DATA_BL *)(hp->bh_data);
386 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
387 dp->db_free -= 1 + INDEX_SIZE;
388 dp->db_line_count = 1;
389 *((char_u *)dp + dp->db_txt_start) = NUL; /* empty line */
391 return OK;
393 error:
394 if (mfp != NULL)
396 if (hp)
397 mf_put(mfp, hp, FALSE, FALSE);
398 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
400 buf->b_ml.ml_mfp = NULL;
401 return FAIL;
405 * ml_setname() is called when the file name of "buf" has been changed.
406 * It may rename the swap file.
408 void
409 ml_setname(buf)
410 buf_T *buf;
412 int success = FALSE;
413 memfile_T *mfp;
414 char_u *fname;
415 char_u *dirp;
416 #if defined(MSDOS) || defined(MSWIN)
417 char_u *p;
418 #endif
420 mfp = buf->b_ml.ml_mfp;
421 if (mfp->mf_fd < 0) /* there is no swap file yet */
424 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
425 * For help files we will make a swap file now.
427 if (p_uc != 0)
428 ml_open_file(buf); /* create a swap file */
429 return;
433 * Try all directories in the 'directory' option.
435 dirp = p_dir;
436 for (;;)
438 if (*dirp == NUL) /* tried all directories, fail */
439 break;
440 fname = findswapname(buf, &dirp, mfp->mf_fname);
441 /* alloc's fname */
442 if (fname == NULL) /* no file name found for this dir */
443 continue;
445 #if defined(MSDOS) || defined(MSWIN)
447 * Set full pathname for swap file now, because a ":!cd dir" may
448 * change directory without us knowing it.
450 p = FullName_save(fname, FALSE);
451 vim_free(fname);
452 fname = p;
453 if (fname == NULL)
454 continue;
455 #endif
456 /* if the file name is the same we don't have to do anything */
457 if (fnamecmp(fname, mfp->mf_fname) == 0)
459 vim_free(fname);
460 success = TRUE;
461 break;
463 /* need to close the swap file before renaming */
464 if (mfp->mf_fd >= 0)
466 close(mfp->mf_fd);
467 mfp->mf_fd = -1;
470 /* try to rename the swap file */
471 if (vim_rename(mfp->mf_fname, fname) == 0)
473 success = TRUE;
474 vim_free(mfp->mf_fname);
475 mfp->mf_fname = fname;
476 vim_free(mfp->mf_ffname);
477 #if defined(MSDOS) || defined(MSWIN)
478 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
479 #else
480 mf_set_ffname(mfp);
481 #endif
482 ml_upd_block0(buf, FALSE);
483 break;
485 vim_free(fname); /* this fname didn't work, try another */
488 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
490 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
491 if (mfp->mf_fd < 0)
493 /* could not (re)open the swap file, what can we do???? */
494 EMSG(_("E301: Oops, lost the swap file!!!"));
495 return;
497 #ifdef HAVE_FD_CLOEXEC
499 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
500 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
501 fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
503 #endif
505 if (!success)
506 EMSG(_("E302: Could not rename swap file"));
510 * Open a file for the memfile for all buffers that are not readonly or have
511 * been modified.
512 * Used when 'updatecount' changes from zero to non-zero.
514 void
515 ml_open_files()
517 buf_T *buf;
519 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
520 if (!buf->b_p_ro || buf->b_changed)
521 ml_open_file(buf);
525 * Open a swap file for an existing memfile, if there is no swap file yet.
526 * If we are unable to find a file name, mf_fname will be NULL
527 * and the memfile will be in memory only (no recovery possible).
529 void
530 ml_open_file(buf)
531 buf_T *buf;
533 memfile_T *mfp;
534 char_u *fname;
535 char_u *dirp;
537 mfp = buf->b_ml.ml_mfp;
538 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
539 return; /* nothing to do */
541 #ifdef FEAT_SPELL
542 /* For a spell buffer use a temp file name. */
543 if (buf->b_spell)
545 fname = vim_tempname('s');
546 if (fname != NULL)
547 (void)mf_open_file(mfp, fname); /* consumes fname! */
548 buf->b_may_swap = FALSE;
549 return;
551 #endif
554 * Try all directories in 'directory' option.
556 dirp = p_dir;
557 for (;;)
559 if (*dirp == NUL)
560 break;
561 /* There is a small chance that between chosing the swap file name and
562 * creating it, another Vim creates the file. In that case the
563 * creation will fail and we will use another directory. */
564 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
565 if (fname == NULL)
566 continue;
567 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
569 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
571 * set full pathname for swap file now, because a ":!cd dir" may
572 * change directory without us knowing it.
574 mf_fullname(mfp);
575 #endif
576 ml_upd_block0(buf, FALSE);
578 /* Flush block zero, so others can read it */
579 if (mf_sync(mfp, MFS_ZERO) == OK)
581 /* Mark all blocks that should be in the swapfile as dirty.
582 * Needed for when the 'swapfile' option was reset, so that
583 * the swap file was deleted, and then on again. */
584 mf_set_dirty(mfp);
585 break;
587 /* Writing block 0 failed: close the file and try another dir */
588 mf_close_file(buf, FALSE);
592 if (mfp->mf_fname == NULL) /* Failed! */
594 char_u *bname = (char_u *)buf_spname(buf);
595 need_wait_return = TRUE; /* call wait_return later */
596 ++no_wait_return;
597 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
598 bname
599 ? bname
600 : buf->b_fname);
601 vim_free(bname);
602 --no_wait_return;
605 /* don't try to open a swap file again */
606 buf->b_may_swap = FALSE;
610 * If still need to create a swap file, and starting to edit a not-readonly
611 * file, or reading into an existing buffer, create a swap file now.
613 void
614 check_need_swap(newfile)
615 int newfile; /* reading file into new buffer */
617 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
618 ml_open_file(curbuf);
622 * Close memline for buffer 'buf'.
623 * If 'del_file' is TRUE, delete the swap file
625 void
626 ml_close(buf, del_file)
627 buf_T *buf;
628 int del_file;
630 if (buf->b_ml.ml_mfp == NULL) /* not open */
631 return;
632 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
633 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
634 vim_free(buf->b_ml.ml_line_ptr);
635 vim_free(buf->b_ml.ml_stack);
636 #ifdef FEAT_BYTEOFF
637 vim_free(buf->b_ml.ml_chunksize);
638 buf->b_ml.ml_chunksize = NULL;
639 #endif
640 buf->b_ml.ml_mfp = NULL;
642 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
643 * this buffer is loaded. */
644 buf->b_flags &= ~BF_RECOVERED;
648 * Close all existing memlines and memfiles.
649 * Only used when exiting.
650 * When 'del_file' is TRUE, delete the memfiles.
651 * But don't delete files that were ":preserve"d when we are POSIX compatible.
653 void
654 ml_close_all(del_file)
655 int del_file;
657 buf_T *buf;
659 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
660 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
661 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
662 #ifdef TEMPDIRNAMES
663 vim_deltempdir(); /* delete created temp directory */
664 #endif
668 * Close all memfiles for not modified buffers.
669 * Only use just before exiting!
671 void
672 ml_close_notmod()
674 buf_T *buf;
676 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
677 if (!bufIsChanged(buf))
678 ml_close(buf, TRUE); /* close all not-modified buffers */
682 * Update the timestamp in the .swp file.
683 * Used when the file has been written.
685 void
686 ml_timestamp(buf)
687 buf_T *buf;
689 ml_upd_block0(buf, TRUE);
693 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
695 static void
696 ml_upd_block0(buf, set_fname)
697 buf_T *buf;
698 int set_fname;
700 memfile_T *mfp;
701 bhdr_T *hp;
702 ZERO_BL *b0p;
704 mfp = buf->b_ml.ml_mfp;
705 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
706 return;
707 b0p = (ZERO_BL *)(hp->bh_data);
708 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
709 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
710 else
712 if (set_fname)
713 set_b0_fname(b0p, buf);
714 else
715 set_b0_dir_flag(b0p, buf);
717 mf_put(mfp, hp, TRUE, FALSE);
721 * Write file name and timestamp into block 0 of a swap file.
722 * Also set buf->b_mtime.
723 * Don't use NameBuff[]!!!
725 static void
726 set_b0_fname(b0p, buf)
727 ZERO_BL *b0p;
728 buf_T *buf;
730 struct stat st;
732 if (buf->b_ffname == NULL)
733 b0p->b0_fname[0] = NUL;
734 else
736 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
737 /* Systems that cannot translate "~user" back into a path: copy the
738 * file name unmodified. Do use slashes instead of backslashes for
739 * portability. */
740 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
741 # ifdef BACKSLASH_IN_FILENAME
742 forward_slash(b0p->b0_fname);
743 # endif
744 #else
745 size_t flen, ulen;
746 char_u uname[B0_UNAME_SIZE];
749 * For a file under the home directory of the current user, we try to
750 * replace the home directory path with "~user". This helps when
751 * editing the same file on different machines over a network.
752 * First replace home dir path with "~/" with home_replace().
753 * Then insert the user name to get "~user/".
755 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
756 if (b0p->b0_fname[0] == '~')
758 flen = STRLEN(b0p->b0_fname);
759 /* If there is no user name or it is too long, don't use "~/" */
760 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
761 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
762 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
763 else
765 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
766 mch_memmove(b0p->b0_fname + 1, uname, ulen);
769 #endif
770 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
772 long_to_char((long)st.st_mtime, b0p->b0_mtime);
773 #ifdef CHECK_INODE
774 long_to_char((long)st.st_ino, b0p->b0_ino);
775 #endif
776 buf_store_time(buf, &st, buf->b_ffname);
777 buf->b_mtime_read = buf->b_mtime;
779 else
781 long_to_char(0L, b0p->b0_mtime);
782 #ifdef CHECK_INODE
783 long_to_char(0L, b0p->b0_ino);
784 #endif
785 buf->b_mtime = 0;
786 buf->b_mtime_read = 0;
787 buf->b_orig_size = 0;
788 buf->b_orig_mode = 0;
792 #ifdef FEAT_MBYTE
793 /* Also add the 'fileencoding' if there is room. */
794 add_b0_fenc(b0p, curbuf);
795 #endif
799 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
800 * swapfile for "buf" are in the same directory.
801 * This is fail safe: if we are not sure the directories are equal the flag is
802 * not set.
804 static void
805 set_b0_dir_flag(b0p, buf)
806 ZERO_BL *b0p;
807 buf_T *buf;
809 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
810 b0p->b0_flags |= B0_SAME_DIR;
811 else
812 b0p->b0_flags &= ~B0_SAME_DIR;
815 #ifdef FEAT_MBYTE
817 * When there is room, add the 'fileencoding' to block zero.
819 static void
820 add_b0_fenc(b0p, buf)
821 ZERO_BL *b0p;
822 buf_T *buf;
824 int n;
826 n = (int)STRLEN(buf->b_p_fenc);
827 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
828 b0p->b0_flags &= ~B0_HAS_FENC;
829 else
831 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
832 (char *)buf->b_p_fenc, (size_t)n);
833 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
834 b0p->b0_flags |= B0_HAS_FENC;
837 #endif
841 * try to recover curbuf from the .swp file
843 void
844 ml_recover()
846 buf_T *buf = NULL;
847 memfile_T *mfp = NULL;
848 char_u *fname;
849 bhdr_T *hp = NULL;
850 ZERO_BL *b0p;
851 int b0_ff;
852 char_u *b0_fenc = NULL;
853 PTR_BL *pp;
854 DATA_BL *dp;
855 infoptr_T *ip;
856 blocknr_T bnum;
857 int page_count;
858 struct stat org_stat, swp_stat;
859 int len;
860 int directly;
861 linenr_T lnum;
862 char_u *p;
863 int i;
864 long error;
865 int cannot_open;
866 linenr_T line_count;
867 int has_error;
868 int idx;
869 int top;
870 int txt_start;
871 off_t size;
872 int called_from_main;
873 int serious_error = TRUE;
874 long mtime;
875 int attr;
876 char_u *bname;
878 recoverymode = TRUE;
879 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
880 attr = hl_attr(HLF_E);
883 * If the file name ends in ".s[uvw][a-z]" we assume this is the swap file.
884 * Otherwise a search is done to find the swap file(s).
886 fname = curbuf->b_fname;
887 if (fname == NULL) /* When there is no file name */
888 fname = (char_u *)"";
889 len = (int)STRLEN(fname);
890 if (len >= 4 &&
891 #if defined(VMS) || defined(RISCOS)
892 STRNICMP(fname + len - 4, "_s" , 2)
893 #else
894 STRNICMP(fname + len - 4, ".s" , 2)
895 #endif
896 == 0
897 && vim_strchr((char_u *)"UVWuvw", fname[len - 2]) != NULL
898 && ASCII_ISALPHA(fname[len - 1]))
900 directly = TRUE;
901 fname = vim_strsave(fname); /* make a copy for mf_open() */
903 else
905 directly = FALSE;
907 /* count the number of matching swap files */
908 len = recover_names(&fname, FALSE, 0);
909 if (len == 0) /* no swap files found */
911 EMSG2(_("E305: No swap file found for %s"), fname);
912 goto theend;
914 if (len == 1) /* one swap file found, use it */
915 i = 1;
916 else /* several swap files found, choose */
918 /* list the names of the swap files */
919 (void)recover_names(&fname, TRUE, 0);
920 msg_putchar('\n');
921 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
922 i = get_number(FALSE, NULL);
923 if (i < 1 || i > len)
924 goto theend;
926 /* get the swap file name that will be used */
927 (void)recover_names(&fname, FALSE, i);
929 if (fname == NULL)
930 goto theend; /* out of memory */
932 /* When called from main() still need to initialize storage structure */
933 if (called_from_main && ml_open(curbuf) == FAIL)
934 getout(1);
937 * allocate a buffer structure (only the memline in it is really used)
939 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
940 if (buf == NULL)
942 vim_free(fname);
943 goto theend;
947 * init fields in memline struct
949 buf->b_ml.ml_stack_size = 0; /* no stack yet */
950 buf->b_ml.ml_stack = NULL; /* no stack yet */
951 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
952 buf->b_ml.ml_line_lnum = 0; /* no cached line */
953 buf->b_ml.ml_locked = NULL; /* no locked block */
954 buf->b_ml.ml_flags = 0;
957 * open the memfile from the old swap file
959 p = vim_strsave(fname); /* save fname for the message
960 (mf_open() may free fname) */
961 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
962 if (mfp == NULL || mfp->mf_fd < 0)
964 if (p != NULL)
966 EMSG2(_("E306: Cannot open %s"), p);
967 vim_free(p);
969 goto theend;
971 vim_free(p);
972 buf->b_ml.ml_mfp = mfp;
975 * The page size set in mf_open() might be different from the page size
976 * used in the swap file, we must get it from block 0. But to read block
977 * 0 we need a page size. Use the minimal size for block 0 here, it will
978 * be set to the real value below.
980 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
983 * try to read block 0
985 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
987 msg_start();
988 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
989 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
990 MSG_PUTS_ATTR(
991 _("\nMaybe no changes were made or Vim did not update the swap file."),
992 attr | MSG_HIST);
993 msg_end();
994 goto theend;
996 b0p = (ZERO_BL *)(hp->bh_data);
997 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
999 msg_start();
1000 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
1001 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1002 MSG_HIST);
1003 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
1004 msg_end();
1005 goto theend;
1007 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
1009 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
1010 goto theend;
1012 if (b0_magic_wrong(b0p))
1014 msg_start();
1015 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1016 #if defined(MSDOS) || defined(MSWIN)
1017 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1018 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1019 attr | MSG_HIST);
1020 else
1021 #endif
1022 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1023 attr | MSG_HIST);
1024 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1025 /* avoid going past the end of a currupted hostname */
1026 b0p->b0_fname[0] = NUL;
1027 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1028 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1029 msg_end();
1030 goto theend;
1034 * If we guessed the wrong page size, we have to recalculate the
1035 * highest block number in the file.
1037 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1039 unsigned previous_page_size = mfp->mf_page_size;
1041 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1042 if (mfp->mf_page_size < previous_page_size)
1044 msg_start();
1045 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1046 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1047 attr | MSG_HIST);
1048 msg_end();
1049 goto theend;
1051 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1052 mfp->mf_blocknr_max = 0; /* no file or empty file */
1053 else
1054 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1055 mfp->mf_infile_count = mfp->mf_blocknr_max;
1057 /* need to reallocate the memory used to store the data */
1058 p = alloc(mfp->mf_page_size);
1059 if (p == NULL)
1060 goto theend;
1061 mch_memmove(p, hp->bh_data, previous_page_size);
1062 vim_free(hp->bh_data);
1063 hp->bh_data = p;
1064 b0p = (ZERO_BL *)(hp->bh_data);
1068 * If .swp file name given directly, use name from swap file for buffer.
1070 if (directly)
1072 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1073 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1074 goto theend;
1077 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1078 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1080 if ((bname = (char_u *)buf_spname(curbuf)) != NULL)
1082 vim_strncpy(NameBuff, bname, MAXPATHL - 1);
1083 vim_free(bname);
1085 else
1086 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1087 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1088 msg_putchar('\n');
1091 * check date of swap file and original file
1093 mtime = char_to_long(b0p->b0_mtime);
1094 if (curbuf->b_ffname != NULL
1095 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1096 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1097 && org_stat.st_mtime > swp_stat.st_mtime)
1098 || org_stat.st_mtime != mtime))
1100 EMSG(_("E308: Warning: Original file may have been changed"));
1102 out_flush();
1104 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1105 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1106 if (b0p->b0_flags & B0_HAS_FENC)
1108 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1109 p > b0p->b0_fname && p[-1] != NUL; --p)
1111 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1114 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1115 hp = NULL;
1118 * Now that we are sure that the file is going to be recovered, clear the
1119 * contents of the current buffer.
1121 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1122 ml_delete((linenr_T)1, FALSE);
1125 * Try reading the original file to obtain the values of 'fileformat',
1126 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1128 if (curbuf->b_ffname != NULL)
1130 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1131 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1132 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1133 ml_delete((linenr_T)1, FALSE);
1136 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1137 if (b0_ff != 0)
1138 set_fileformat(b0_ff - 1, OPT_LOCAL);
1139 if (b0_fenc != NULL)
1141 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1142 vim_free(b0_fenc);
1144 unchanged(curbuf, TRUE);
1146 bnum = 1; /* start with block 1 */
1147 page_count = 1; /* which is 1 page */
1148 lnum = 0; /* append after line 0 in curbuf */
1149 line_count = 0;
1150 idx = 0; /* start with first index in block 1 */
1151 error = 0;
1152 buf->b_ml.ml_stack_top = 0;
1153 buf->b_ml.ml_stack = NULL;
1154 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1156 if (curbuf->b_ffname == NULL)
1157 cannot_open = TRUE;
1158 else
1159 cannot_open = FALSE;
1161 serious_error = FALSE;
1162 for ( ; !got_int; line_breakcheck())
1164 if (hp != NULL)
1165 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1168 * get block
1170 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1172 if (bnum == 1)
1174 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1175 goto theend;
1177 ++error;
1178 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1179 (colnr_T)0, TRUE);
1181 else /* there is a block */
1183 pp = (PTR_BL *)(hp->bh_data);
1184 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1186 /* check line count when using pointer block first time */
1187 if (idx == 0 && line_count != 0)
1189 for (i = 0; i < (int)pp->pb_count; ++i)
1190 line_count -= pp->pb_pointer[i].pe_line_count;
1191 if (line_count != 0)
1193 ++error;
1194 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1195 (colnr_T)0, TRUE);
1199 if (pp->pb_count == 0)
1201 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1202 (colnr_T)0, TRUE);
1203 ++error;
1205 else if (idx < (int)pp->pb_count) /* go a block deeper */
1207 if (pp->pb_pointer[idx].pe_bnum < 0)
1210 * Data block with negative block number.
1211 * Try to read lines from the original file.
1212 * This is slow, but it works.
1214 if (!cannot_open)
1216 line_count = pp->pb_pointer[idx].pe_line_count;
1217 if (readfile(curbuf->b_ffname, NULL, lnum,
1218 pp->pb_pointer[idx].pe_old_lnum - 1,
1219 line_count, NULL, 0) == FAIL)
1220 cannot_open = TRUE;
1221 else
1222 lnum += line_count;
1224 if (cannot_open)
1226 ++error;
1227 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1228 (colnr_T)0, TRUE);
1230 ++idx; /* get same block again for next index */
1231 continue;
1235 * going one block deeper in the tree
1237 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1239 ++error;
1240 break; /* out of memory */
1242 ip = &(buf->b_ml.ml_stack[top]);
1243 ip->ip_bnum = bnum;
1244 ip->ip_index = idx;
1246 bnum = pp->pb_pointer[idx].pe_bnum;
1247 line_count = pp->pb_pointer[idx].pe_line_count;
1248 page_count = pp->pb_pointer[idx].pe_page_count;
1249 continue;
1252 else /* not a pointer block */
1254 dp = (DATA_BL *)(hp->bh_data);
1255 if (dp->db_id != DATA_ID) /* block id wrong */
1257 if (bnum == 1)
1259 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1260 mfp->mf_fname);
1261 goto theend;
1263 ++error;
1264 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1265 (colnr_T)0, TRUE);
1267 else
1270 * it is a data block
1271 * Append all the lines in this block
1273 has_error = FALSE;
1275 * check length of block
1276 * if wrong, use length in pointer block
1278 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1280 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1281 (colnr_T)0, TRUE);
1282 ++error;
1283 has_error = TRUE;
1284 dp->db_txt_end = page_count * mfp->mf_page_size;
1287 /* make sure there is a NUL at the end of the block */
1288 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1291 * check number of lines in block
1292 * if wrong, use count in data block
1294 if (line_count != dp->db_line_count)
1296 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1297 (colnr_T)0, TRUE);
1298 ++error;
1299 has_error = TRUE;
1302 for (i = 0; i < dp->db_line_count; ++i)
1304 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1305 if (txt_start <= (int)HEADER_SIZE
1306 || txt_start >= (int)dp->db_txt_end)
1308 p = (char_u *)"???";
1309 ++error;
1311 else
1312 p = (char_u *)dp + txt_start;
1313 ml_append(lnum++, p, (colnr_T)0, TRUE);
1315 if (has_error)
1316 ml_append(lnum++, (char_u *)_("???END"),
1317 (colnr_T)0, TRUE);
1322 if (buf->b_ml.ml_stack_top == 0) /* finished */
1323 break;
1326 * go one block up in the tree
1328 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1329 bnum = ip->ip_bnum;
1330 idx = ip->ip_index + 1; /* go to next index */
1331 page_count = 1;
1335 * The dummy line from the empty buffer will now be after the last line in
1336 * the buffer. Delete it.
1338 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1339 curbuf->b_flags |= BF_RECOVERED;
1341 recoverymode = FALSE;
1342 if (got_int)
1343 EMSG(_("E311: Recovery Interrupted"));
1344 else if (error)
1346 ++no_wait_return;
1347 MSG(">>>>>>>>>>>>>");
1348 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1349 --no_wait_return;
1350 MSG(_("See \":help E312\" for more information."));
1351 MSG(">>>>>>>>>>>>>");
1353 else
1355 MSG(_("Recovery completed. You should check if everything is OK."));
1356 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1357 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1358 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1359 cmdline_row = msg_row;
1361 redraw_curbuf_later(NOT_VALID);
1363 theend:
1364 recoverymode = FALSE;
1365 if (mfp != NULL)
1367 if (hp != NULL)
1368 mf_put(mfp, hp, FALSE, FALSE);
1369 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1371 if (buf != NULL)
1373 vim_free(buf->b_ml.ml_stack);
1374 vim_free(buf);
1376 if (serious_error && called_from_main)
1377 ml_close(curbuf, TRUE);
1378 #ifdef FEAT_AUTOCMD
1379 else
1381 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1382 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1384 #endif
1385 return;
1389 * Find the names of swap files in current directory and the directory given
1390 * with the 'directory' option.
1392 * Used to:
1393 * - list the swap files for "vim -r"
1394 * - count the number of swap files when recovering
1395 * - list the swap files when recovering
1396 * - find the name of the n'th swap file when recovering
1399 recover_names(fname, list, nr)
1400 char_u **fname; /* base for swap file name */
1401 int list; /* when TRUE, list the swap file names */
1402 int nr; /* when non-zero, return nr'th swap file name */
1404 int num_names;
1405 char_u *(names[6]);
1406 char_u *tail;
1407 char_u *p;
1408 int num_files;
1409 int file_count = 0;
1410 char_u **files;
1411 int i;
1412 char_u *dirp;
1413 char_u *dir_name;
1414 char_u *fname_res = NULL;
1415 #ifdef HAVE_READLINK
1416 char_u fname_buf[MAXPATHL];
1417 #endif
1419 if (fname != NULL)
1421 #ifdef HAVE_READLINK
1422 /* Expand symlink in the file name, because the swap file is created with
1423 * the actual file instead of with the symlink. */
1424 if (resolve_symlink(*fname, fname_buf) == OK)
1425 fname_res = fname_buf;
1426 else
1427 #endif
1428 fname_res = *fname;
1431 if (list)
1433 /* use msg() to start the scrolling properly */
1434 msg((char_u *)_("Swap files found:"));
1435 msg_putchar('\n');
1439 * Do the loop for every directory in 'directory'.
1440 * First allocate some memory to put the directory name in.
1442 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1443 dirp = p_dir;
1444 while (dir_name != NULL && *dirp)
1447 * Isolate a directory name from *dirp and put it in dir_name (we know
1448 * it is large enough, so use 31000 for length).
1449 * Advance dirp to next directory name.
1451 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1453 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1455 if (fname == NULL || *fname == NULL)
1457 #ifdef VMS
1458 names[0] = vim_strsave((char_u *)"*_sw%");
1459 #else
1460 # ifdef RISCOS
1461 names[0] = vim_strsave((char_u *)"*_sw#");
1462 # else
1463 names[0] = vim_strsave((char_u *)"*.sw?");
1464 # endif
1465 #endif
1466 #if defined(UNIX) || defined(WIN3264)
1467 /* For Unix names starting with a dot are special. MS-Windows
1468 * supports this too, on some file systems. */
1469 names[1] = vim_strsave((char_u *)".*.sw?");
1470 names[2] = vim_strsave((char_u *)".sw?");
1471 num_names = 3;
1472 #else
1473 # ifdef VMS
1474 names[1] = vim_strsave((char_u *)".*_sw%");
1475 num_names = 2;
1476 # else
1477 num_names = 1;
1478 # endif
1479 #endif
1481 else
1482 num_names = recov_file_names(names, fname_res, TRUE);
1484 else /* check directory dir_name */
1486 if (fname == NULL || *fname == NULL)
1488 #ifdef VMS
1489 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1490 #else
1491 # ifdef RISCOS
1492 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1493 # else
1494 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1495 # endif
1496 #endif
1497 #if defined(UNIX) || defined(WIN3264)
1498 /* For Unix names starting with a dot are special. MS-Windows
1499 * supports this too, on some file systems. */
1500 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1501 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1502 num_names = 3;
1503 #else
1504 # ifdef VMS
1505 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1506 num_names = 2;
1507 # else
1508 num_names = 1;
1509 # endif
1510 #endif
1512 else
1514 #if defined(UNIX) || defined(WIN3264)
1515 p = dir_name + STRLEN(dir_name);
1516 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1518 /* Ends with '//', Use Full path for swap name */
1519 tail = make_percent_swname(dir_name, fname_res);
1521 else
1522 #endif
1524 tail = gettail(fname_res);
1525 tail = concat_fnames(dir_name, tail, TRUE);
1527 if (tail == NULL)
1528 num_names = 0;
1529 else
1531 num_names = recov_file_names(names, tail, FALSE);
1532 vim_free(tail);
1537 /* check for out-of-memory */
1538 for (i = 0; i < num_names; ++i)
1540 if (names[i] == NULL)
1542 for (i = 0; i < num_names; ++i)
1543 vim_free(names[i]);
1544 num_names = 0;
1547 if (num_names == 0)
1548 num_files = 0;
1549 else if (expand_wildcards(num_names, names, &num_files, &files,
1550 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1551 num_files = 0;
1554 * When no swap file found, wildcard expansion might have failed (e.g.
1555 * not able to execute the shell).
1556 * Try finding a swap file by simply adding ".swp" to the file name.
1558 if (*dirp == NUL && file_count + num_files == 0
1559 && fname != NULL && *fname != NULL)
1561 struct stat st;
1562 char_u *swapname;
1564 swapname = modname(fname_res,
1565 #if defined(VMS) || defined(RISCOS)
1566 (char_u *)"_swp", FALSE
1567 #else
1568 (char_u *)".swp", TRUE
1569 #endif
1571 if (swapname != NULL)
1573 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1575 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1576 if (files != NULL)
1578 files[0] = swapname;
1579 swapname = NULL;
1580 num_files = 1;
1583 vim_free(swapname);
1588 * remove swapfile name of the current buffer, it must be ignored
1590 if (curbuf->b_ml.ml_mfp != NULL
1591 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1593 for (i = 0; i < num_files; ++i)
1594 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1596 /* Remove the name from files[i]. Move further entries
1597 * down. When the array becomes empty free it here, since
1598 * FreeWild() won't be called below. */
1599 vim_free(files[i]);
1600 if (--num_files == 0)
1601 vim_free(files);
1602 else
1603 for ( ; i < num_files; ++i)
1604 files[i] = files[i + 1];
1607 if (nr > 0)
1609 file_count += num_files;
1610 if (nr <= file_count)
1612 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1613 dirp = (char_u *)""; /* stop searching */
1616 else if (list)
1618 if (dir_name[0] == '.' && dir_name[1] == NUL)
1620 if (fname == NULL || *fname == NULL)
1621 MSG_PUTS(_(" In current directory:\n"));
1622 else
1623 MSG_PUTS(_(" Using specified name:\n"));
1625 else
1627 MSG_PUTS(_(" In directory "));
1628 msg_home_replace(dir_name);
1629 MSG_PUTS(":\n");
1632 if (num_files)
1634 for (i = 0; i < num_files; ++i)
1636 /* print the swap file name */
1637 msg_outnum((long)++file_count);
1638 MSG_PUTS(". ");
1639 msg_puts(gettail(files[i]));
1640 msg_putchar('\n');
1641 (void)swapfile_info(files[i]);
1644 else
1645 MSG_PUTS(_(" -- none --\n"));
1646 out_flush();
1648 else
1649 file_count += num_files;
1651 for (i = 0; i < num_names; ++i)
1652 vim_free(names[i]);
1653 if (num_files > 0)
1654 FreeWild(num_files, files);
1656 vim_free(dir_name);
1657 return file_count;
1660 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1662 * Append the full path to name with path separators made into percent
1663 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1665 static char_u *
1666 make_percent_swname(dir, name)
1667 char_u *dir;
1668 char_u *name;
1670 char_u *d, *s, *f;
1672 f = fix_fname(name != NULL ? name : (char_u *) "");
1673 d = NULL;
1674 if (f != NULL)
1676 s = alloc((unsigned)(STRLEN(f) + 1));
1677 if (s != NULL)
1679 STRCPY(s, f);
1680 for (d = s; *d != NUL; mb_ptr_adv(d))
1681 if (vim_ispathsep(*d))
1682 *d = '%';
1683 d = concat_fnames(dir, s, TRUE);
1684 vim_free(s);
1686 vim_free(f);
1688 return d;
1690 #endif
1692 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1693 static int process_still_running;
1694 #endif
1697 * Give information about an existing swap file.
1698 * Returns timestamp (0 when unknown).
1700 static time_t
1701 swapfile_info(fname)
1702 char_u *fname;
1704 struct stat st;
1705 int fd;
1706 struct block0 b0;
1707 time_t x = (time_t)0;
1708 char *p;
1709 #ifdef UNIX
1710 char_u uname[B0_UNAME_SIZE];
1711 #endif
1713 /* print the swap file date */
1714 if (mch_stat((char *)fname, &st) != -1)
1716 #ifdef UNIX
1717 /* print name of owner of the file */
1718 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1720 MSG_PUTS(_(" owned by: "));
1721 msg_outtrans(uname);
1722 MSG_PUTS(_(" dated: "));
1724 else
1725 #endif
1726 MSG_PUTS(_(" dated: "));
1727 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1728 p = ctime(&x); /* includes '\n' */
1729 if (p == NULL)
1730 MSG_PUTS("(invalid)\n");
1731 else
1732 MSG_PUTS(p);
1736 * print the original file name
1738 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1739 if (fd >= 0)
1741 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1743 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1745 MSG_PUTS(_(" [from Vim version 3.0]"));
1747 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1749 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1751 else
1753 MSG_PUTS(_(" file name: "));
1754 if (b0.b0_fname[0] == NUL)
1755 MSG_PUTS(_("[No Name]"));
1756 else
1757 msg_outtrans(b0.b0_fname);
1759 MSG_PUTS(_("\n modified: "));
1760 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1762 if (*(b0.b0_uname) != NUL)
1764 MSG_PUTS(_("\n user name: "));
1765 msg_outtrans(b0.b0_uname);
1768 if (*(b0.b0_hname) != NUL)
1770 if (*(b0.b0_uname) != NUL)
1771 MSG_PUTS(_(" host name: "));
1772 else
1773 MSG_PUTS(_("\n host name: "));
1774 msg_outtrans(b0.b0_hname);
1777 if (char_to_long(b0.b0_pid) != 0L)
1779 MSG_PUTS(_("\n process ID: "));
1780 msg_outnum(char_to_long(b0.b0_pid));
1781 #if defined(UNIX) || defined(__EMX__)
1782 /* EMX kill() not working correctly, it seems */
1783 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1785 MSG_PUTS(_(" (still running)"));
1786 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1787 process_still_running = TRUE;
1788 # endif
1790 #endif
1793 if (b0_magic_wrong(&b0))
1795 #if defined(MSDOS) || defined(MSWIN)
1796 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1797 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1798 else
1799 #endif
1800 MSG_PUTS(_("\n [not usable on this computer]"));
1804 else
1805 MSG_PUTS(_(" [cannot be read]"));
1806 close(fd);
1808 else
1809 MSG_PUTS(_(" [cannot be opened]"));
1810 msg_putchar('\n');
1812 return x;
1815 static int
1816 recov_file_names(names, path, prepend_dot)
1817 char_u **names;
1818 char_u *path;
1819 int prepend_dot;
1821 int num_names;
1823 #ifdef SHORT_FNAME
1825 * (MS-DOS) always short names
1827 names[0] = modname(path, (char_u *)".sw?", FALSE);
1828 num_names = 1;
1829 #else /* !SHORT_FNAME */
1831 * (Win32 and Win64) never short names, but do prepend a dot.
1832 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1833 * Only use the short name if it is different.
1835 char_u *p;
1836 int i;
1837 # ifndef WIN3264
1838 int shortname = curbuf->b_shortname;
1840 curbuf->b_shortname = FALSE;
1841 # endif
1843 num_names = 0;
1846 * May also add the file name with a dot prepended, for swap file in same
1847 * dir as original file.
1849 if (prepend_dot)
1851 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1852 if (names[num_names] == NULL)
1853 goto end;
1854 ++num_names;
1858 * Form the normal swap file name pattern by appending ".sw?".
1860 #ifdef VMS
1861 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1862 #else
1863 # ifdef RISCOS
1864 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1865 # else
1866 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1867 # endif
1868 #endif
1869 if (names[num_names] == NULL)
1870 goto end;
1871 if (num_names >= 1) /* check if we have the same name twice */
1873 p = names[num_names - 1];
1874 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1875 if (i > 0)
1876 p += i; /* file name has been expanded to full path */
1878 if (STRCMP(p, names[num_names]) != 0)
1879 ++num_names;
1880 else
1881 vim_free(names[num_names]);
1883 else
1884 ++num_names;
1886 # ifndef WIN3264
1888 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1890 curbuf->b_shortname = TRUE;
1891 #ifdef VMS
1892 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1893 #else
1894 # ifdef RISCOS
1895 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1896 # else
1897 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1898 # endif
1899 #endif
1900 if (names[num_names] == NULL)
1901 goto end;
1904 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1906 p = names[num_names];
1907 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1908 if (i > 0)
1909 p += i; /* file name has been expanded to full path */
1910 if (STRCMP(names[num_names - 1], p) == 0)
1911 vim_free(names[num_names]);
1912 else
1913 ++num_names;
1914 # endif
1916 end:
1917 # ifndef WIN3264
1918 curbuf->b_shortname = shortname;
1919 # endif
1921 #endif /* !SHORT_FNAME */
1923 return num_names;
1927 * sync all memlines
1929 * If 'check_file' is TRUE, check if original file exists and was not changed.
1930 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1931 * always sync at least one block.
1933 void
1934 ml_sync_all(check_file, check_char)
1935 int check_file;
1936 int check_char;
1938 buf_T *buf;
1939 struct stat st;
1941 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1943 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1944 continue; /* no file */
1946 ml_flush_line(buf); /* flush buffered line */
1947 /* flush locked block */
1948 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1949 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1950 && buf->b_ffname != NULL)
1953 * If the original file does not exist anymore or has been changed
1954 * call ml_preserve() to get rid of all negative numbered blocks.
1956 if (mch_stat((char *)buf->b_ffname, &st) == -1
1957 || st.st_mtime != buf->b_mtime_read
1958 || (size_t)st.st_size != buf->b_orig_size)
1960 ml_preserve(buf, FALSE);
1961 did_check_timestamps = FALSE;
1962 need_check_timestamps = TRUE; /* give message later */
1965 if (buf->b_ml.ml_mfp->mf_dirty)
1967 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1968 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1969 if (check_char && ui_char_avail()) /* character available now */
1970 break;
1976 * sync one buffer, including negative blocks
1978 * after this all the blocks are in the swap file
1980 * Used for the :preserve command and when the original file has been
1981 * changed or deleted.
1983 * when message is TRUE the success of preserving is reported
1985 void
1986 ml_preserve(buf, message)
1987 buf_T *buf;
1988 int message;
1990 bhdr_T *hp;
1991 linenr_T lnum;
1992 memfile_T *mfp = buf->b_ml.ml_mfp;
1993 int status;
1994 int got_int_save = got_int;
1996 if (mfp == NULL || mfp->mf_fname == NULL)
1998 if (message)
1999 EMSG(_("E313: Cannot preserve, there is no swap file"));
2000 return;
2003 /* We only want to stop when interrupted here, not when interrupted
2004 * before. */
2005 got_int = FALSE;
2007 ml_flush_line(buf); /* flush buffered line */
2008 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2009 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2011 /* stack is invalid after mf_sync(.., MFS_ALL) */
2012 buf->b_ml.ml_stack_top = 0;
2015 * Some of the data blocks may have been changed from negative to
2016 * positive block number. In that case the pointer blocks need to be
2017 * updated.
2019 * We don't know in which pointer block the references are, so we visit
2020 * all data blocks until there are no more translations to be done (or
2021 * we hit the end of the file, which can only happen in case a write fails,
2022 * e.g. when file system if full).
2023 * ml_find_line() does the work by translating the negative block numbers
2024 * when getting the first line of each data block.
2026 if (mf_need_trans(mfp) && !got_int)
2028 lnum = 1;
2029 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2031 hp = ml_find_line(buf, lnum, ML_FIND);
2032 if (hp == NULL)
2034 status = FAIL;
2035 goto theend;
2037 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2038 lnum = buf->b_ml.ml_locked_high + 1;
2040 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2041 /* sync the updated pointer blocks */
2042 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2043 status = FAIL;
2044 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2046 theend:
2047 got_int |= got_int_save;
2049 if (message)
2051 if (status == OK)
2052 MSG(_("File preserved"));
2053 else
2054 EMSG(_("E314: Preserve failed"));
2059 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2060 * until the next call!
2061 * line1 = ml_get(1);
2062 * line2 = ml_get(2); // line1 is now invalid!
2063 * Make a copy of the line if necessary.
2066 * get a pointer to a (read-only copy of a) line
2068 * On failure an error message is given and IObuff is returned (to avoid
2069 * having to check for error everywhere).
2071 char_u *
2072 ml_get(lnum)
2073 linenr_T lnum;
2075 return ml_get_buf(curbuf, lnum, FALSE);
2079 * ml_get_pos: get pointer to position 'pos'
2081 char_u *
2082 ml_get_pos(pos)
2083 pos_T *pos;
2085 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2089 * ml_get_curline: get pointer to cursor line.
2091 char_u *
2092 ml_get_curline()
2094 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2098 * ml_get_cursor: get pointer to cursor position
2100 char_u *
2101 ml_get_cursor()
2103 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2104 curwin->w_cursor.col);
2108 * get a pointer to a line in a specific buffer
2110 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2111 * changed)
2113 char_u *
2114 ml_get_buf(buf, lnum, will_change)
2115 buf_T *buf;
2116 linenr_T lnum;
2117 int will_change; /* line will be changed */
2119 bhdr_T *hp;
2120 DATA_BL *dp;
2121 char_u *ptr;
2122 static int recursive = 0;
2124 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2126 if (recursive == 0)
2128 /* Avoid giving this message for a recursive call, may happen when
2129 * the GUI redraws part of the text. */
2130 ++recursive;
2131 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2132 --recursive;
2134 errorret:
2135 STRCPY(IObuff, "???");
2136 return IObuff;
2138 if (lnum <= 0) /* pretend line 0 is line 1 */
2139 lnum = 1;
2141 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2142 return (char_u *)"";
2145 * See if it is the same line as requested last time.
2146 * Otherwise may need to flush last used line.
2147 * Don't use the last used line when 'swapfile' is reset, need to load all
2148 * blocks.
2150 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2152 ml_flush_line(buf);
2155 * Find the data block containing the line.
2156 * This also fills the stack with the blocks from the root to the data
2157 * block and releases any locked block.
2159 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2161 if (recursive == 0)
2163 /* Avoid giving this message for a recursive call, may happen
2164 * when the GUI redraws part of the text. */
2165 ++recursive;
2166 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2167 --recursive;
2169 goto errorret;
2172 dp = (DATA_BL *)(hp->bh_data);
2174 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2175 buf->b_ml.ml_line_ptr = ptr;
2176 buf->b_ml.ml_line_lnum = lnum;
2177 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2179 if (will_change)
2180 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2182 return buf->b_ml.ml_line_ptr;
2186 * Check if a line that was just obtained by a call to ml_get
2187 * is in allocated memory.
2190 ml_line_alloced()
2192 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2196 * Append a line after lnum (may be 0 to insert a line in front of the file).
2197 * "line" does not need to be allocated, but can't be another line in a
2198 * buffer, unlocking may make it invalid.
2200 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2201 * will be set for recovery
2202 * Check: The caller of this function should probably also call
2203 * appended_lines().
2205 * return FAIL for failure, OK otherwise
2208 ml_append(lnum, line, len, newfile)
2209 linenr_T lnum; /* append after this line (can be 0) */
2210 char_u *line; /* text of the new line */
2211 colnr_T len; /* length of new line, including NUL, or 0 */
2212 int newfile; /* flag, see above */
2214 /* When starting up, we might still need to create the memfile */
2215 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2216 return FAIL;
2218 if (curbuf->b_ml.ml_line_lnum != 0)
2219 ml_flush_line(curbuf);
2220 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2224 * Append string to line lnum, with buffering, in current buffer.
2226 * Always makes a copy of the incoming string
2228 * Check: The caller of this function should probably also call
2229 * changed_lines(), unless update_screen(NOT_VALID) is used.
2231 * return FAIL for failure, OK otherwise
2234 ml_append_string(lnum, string, slen)
2235 linenr_T lnum;
2236 char_u *string;
2237 int slen;
2239 int append_len = 0;
2240 int line_len = 0;
2241 if (slen == -1)
2242 append_len = STRLEN(string);
2243 else
2244 append_len = slen;
2245 if (string == NULL) /* just checking... */
2246 return FAIL;
2248 if (lnum == 0)
2249 ml_append (lnum, string, slen, 0);
2251 /* When starting up, we might still need to create the memfile */
2252 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2253 return FAIL;
2255 #ifdef FEAT_NETBEANS_INTG
2257 #error I am 99% sure this is broken
2258 if (usingNetbeans)
2260 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2261 netbeans_inserted(curbuf, lnum, 0, string, (int)STRLEN(string));
2264 #endif
2265 if ((curbuf->b_ml.ml_line_lnum != lnum) || /* other line buffered */
2266 (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) == 0)
2268 ml_flush_line(curbuf); /* flush it, this frees ml_line_ptr */
2270 /* Take a pointer to the existing line, will get re-alloced right
2271 * away below because it is not big enough */
2272 curbuf->b_ml.ml_line_ptr = ml_get(lnum);
2273 curbuf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2274 curbuf->b_ml.ml_line_max = STRLEN(curbuf->b_ml.ml_line_ptr);
2275 curbuf->b_ml.ml_line_lnum = lnum;
2277 /* By here,
2278 * curbuf->b_ml.ml_line_ptr - is filled with the correct existing line
2279 * curbuf->b_ml.ml_line_max - is the alloced size of the line
2281 line_len = STRLEN(curbuf->b_ml.ml_line_ptr);
2282 if (curbuf->b_ml.ml_line_max < line_len + append_len + 1)
2284 int new_len = (curbuf->b_ml.ml_line_max + append_len + 2) * 2;
2285 char_u *new_line;
2286 if (new_len < 80) new_len = 80;
2287 new_line = vim_strnsave(curbuf->b_ml.ml_line_ptr, new_len);
2288 if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY)
2289 vim_free(curbuf->b_ml.ml_line_ptr);
2290 curbuf->b_ml.ml_line_ptr = new_line;
2291 curbuf->b_ml.ml_line_max = new_len;
2292 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2294 /* by here:
2295 * ml_line_ptr is allocated to fit the current line + the append
2296 * ml_line_max is the total alloced size of the line
2298 STRCPY (&curbuf->b_ml.ml_line_ptr[line_len], string); /* Append our string */
2299 curbuf->b_ml.ml_line_ptr[line_len + append_len] = NUL; /* End the line */
2300 return OK;
2305 #if defined(FEAT_SPELL) || defined(PROTO)
2307 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2308 * a memline.
2311 ml_append_buf(buf, lnum, line, len, newfile)
2312 buf_T *buf;
2313 linenr_T lnum; /* append after this line (can be 0) */
2314 char_u *line; /* text of the new line */
2315 colnr_T len; /* length of new line, including NUL, or 0 */
2316 int newfile; /* flag, see above */
2318 if (buf->b_ml.ml_mfp == NULL)
2319 return FAIL;
2321 if (buf->b_ml.ml_line_lnum != 0)
2322 ml_flush_line(buf);
2323 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2325 #endif
2327 static int
2328 ml_append_int(buf, lnum, line, len, newfile, mark)
2329 buf_T *buf;
2330 linenr_T lnum; /* append after this line (can be 0) */
2331 char_u *line; /* text of the new line */
2332 colnr_T len; /* length of line, including NUL, or 0 */
2333 int newfile; /* flag, see above */
2334 int mark; /* mark the new line */
2336 int i;
2337 int line_count; /* number of indexes in current block */
2338 int offset;
2339 int from, to;
2340 int space_needed; /* space needed for new line */
2341 int page_size;
2342 int page_count;
2343 int db_idx; /* index for lnum in data block */
2344 bhdr_T *hp;
2345 memfile_T *mfp;
2346 DATA_BL *dp;
2347 PTR_BL *pp;
2348 infoptr_T *ip;
2350 /* lnum out of range */
2351 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2352 return FAIL;
2354 if (lowest_marked && lowest_marked > lnum)
2355 lowest_marked = lnum + 1;
2357 if (len == 0)
2358 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2359 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2361 mfp = buf->b_ml.ml_mfp;
2362 page_size = mfp->mf_page_size;
2365 * find the data block containing the previous line
2366 * This also fills the stack with the blocks from the root to the data block
2367 * This also releases any locked block.
2369 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2370 ML_INSERT)) == NULL)
2371 return FAIL;
2373 buf->b_ml.ml_flags &= ~ML_EMPTY;
2375 if (lnum == 0) /* got line one instead, correct db_idx */
2376 db_idx = -1; /* careful, it is negative! */
2377 else
2378 db_idx = lnum - buf->b_ml.ml_locked_low;
2379 /* get line count before the insertion */
2380 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2382 dp = (DATA_BL *)(hp->bh_data);
2385 * If
2386 * - there is not enough room in the current block
2387 * - appending to the last line in the block
2388 * - not appending to the last line in the file
2389 * insert in front of the next block.
2391 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2392 && lnum < buf->b_ml.ml_line_count)
2395 * Now that the line is not going to be inserted in the block that we
2396 * expected, the line count has to be adjusted in the pointer blocks
2397 * by using ml_locked_lineadd.
2399 --(buf->b_ml.ml_locked_lineadd);
2400 --(buf->b_ml.ml_locked_high);
2401 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2402 return FAIL;
2404 db_idx = -1; /* careful, it is negative! */
2405 /* get line count before the insertion */
2406 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2407 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2409 dp = (DATA_BL *)(hp->bh_data);
2412 ++buf->b_ml.ml_line_count;
2414 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2417 * Insert new line in existing data block, or in data block allocated above.
2419 dp->db_txt_start -= len;
2420 dp->db_free -= space_needed;
2421 ++(dp->db_line_count);
2424 * move the text of the lines that follow to the front
2425 * adjust the indexes of the lines that follow
2427 if (line_count > db_idx + 1) /* if there are following lines */
2430 * Offset is the start of the previous line.
2431 * This will become the character just after the new line.
2433 if (db_idx < 0)
2434 offset = dp->db_txt_end;
2435 else
2436 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2437 mch_memmove((char *)dp + dp->db_txt_start,
2438 (char *)dp + dp->db_txt_start + len,
2439 (size_t)(offset - (dp->db_txt_start + len)));
2440 for (i = line_count - 1; i > db_idx; --i)
2441 dp->db_index[i + 1] = dp->db_index[i] - len;
2442 dp->db_index[db_idx + 1] = offset - len;
2444 else /* add line at the end */
2445 dp->db_index[db_idx + 1] = dp->db_txt_start;
2448 * copy the text into the block
2450 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2451 if (mark)
2452 dp->db_index[db_idx + 1] |= DB_MARKED;
2455 * Mark the block dirty.
2457 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2458 if (!newfile)
2459 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2461 else /* not enough space in data block */
2464 * If there is not enough room we have to create a new data block and copy some
2465 * lines into it.
2466 * Then we have to insert an entry in the pointer block.
2467 * If this pointer block also is full, we go up another block, and so on, up
2468 * to the root if necessary.
2469 * The line counts in the pointer blocks have already been adjusted by
2470 * ml_find_line().
2472 long line_count_left, line_count_right;
2473 int page_count_left, page_count_right;
2474 bhdr_T *hp_left;
2475 bhdr_T *hp_right;
2476 bhdr_T *hp_new;
2477 int lines_moved;
2478 int data_moved = 0; /* init to shut up gcc */
2479 int total_moved = 0; /* init to shut up gcc */
2480 DATA_BL *dp_right, *dp_left;
2481 int stack_idx;
2482 int in_left;
2483 int lineadd;
2484 blocknr_T bnum_left, bnum_right;
2485 linenr_T lnum_left, lnum_right;
2486 int pb_idx;
2487 PTR_BL *pp_new;
2490 * We are going to allocate a new data block. Depending on the
2491 * situation it will be put to the left or right of the existing
2492 * block. If possible we put the new line in the left block and move
2493 * the lines after it to the right block. Otherwise the new line is
2494 * also put in the right block. This method is more efficient when
2495 * inserting a lot of lines at one place.
2497 if (db_idx < 0) /* left block is new, right block is existing */
2499 lines_moved = 0;
2500 in_left = TRUE;
2501 /* space_needed does not change */
2503 else /* left block is existing, right block is new */
2505 lines_moved = line_count - db_idx - 1;
2506 if (lines_moved == 0)
2507 in_left = FALSE; /* put new line in right block */
2508 /* space_needed does not change */
2509 else
2511 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2512 dp->db_txt_start;
2513 total_moved = data_moved + lines_moved * INDEX_SIZE;
2514 if ((int)dp->db_free + total_moved >= space_needed)
2516 in_left = TRUE; /* put new line in left block */
2517 space_needed = total_moved;
2519 else
2521 in_left = FALSE; /* put new line in right block */
2522 space_needed += total_moved;
2527 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2528 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2530 /* correct line counts in pointer blocks */
2531 --(buf->b_ml.ml_locked_lineadd);
2532 --(buf->b_ml.ml_locked_high);
2533 return FAIL;
2535 if (db_idx < 0) /* left block is new */
2537 hp_left = hp_new;
2538 hp_right = hp;
2539 line_count_left = 0;
2540 line_count_right = line_count;
2542 else /* right block is new */
2544 hp_left = hp;
2545 hp_right = hp_new;
2546 line_count_left = line_count;
2547 line_count_right = 0;
2549 dp_right = (DATA_BL *)(hp_right->bh_data);
2550 dp_left = (DATA_BL *)(hp_left->bh_data);
2551 bnum_left = hp_left->bh_bnum;
2552 bnum_right = hp_right->bh_bnum;
2553 page_count_left = hp_left->bh_page_count;
2554 page_count_right = hp_right->bh_page_count;
2557 * May move the new line into the right/new block.
2559 if (!in_left)
2561 dp_right->db_txt_start -= len;
2562 dp_right->db_free -= len + INDEX_SIZE;
2563 dp_right->db_index[0] = dp_right->db_txt_start;
2564 if (mark)
2565 dp_right->db_index[0] |= DB_MARKED;
2567 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2568 line, (size_t)len);
2569 ++line_count_right;
2572 * may move lines from the left/old block to the right/new one.
2574 if (lines_moved)
2578 dp_right->db_txt_start -= data_moved;
2579 dp_right->db_free -= total_moved;
2580 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2581 (char *)dp_left + dp_left->db_txt_start,
2582 (size_t)data_moved);
2583 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2584 dp_left->db_txt_start += data_moved;
2585 dp_left->db_free += total_moved;
2588 * update indexes in the new block
2590 for (to = line_count_right, from = db_idx + 1;
2591 from < line_count_left; ++from, ++to)
2592 dp_right->db_index[to] = dp->db_index[from] + offset;
2593 line_count_right += lines_moved;
2594 line_count_left -= lines_moved;
2598 * May move the new line into the left (old or new) block.
2600 if (in_left)
2602 dp_left->db_txt_start -= len;
2603 dp_left->db_free -= len + INDEX_SIZE;
2604 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2605 if (mark)
2606 dp_left->db_index[line_count_left] |= DB_MARKED;
2607 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2608 line, (size_t)len);
2609 ++line_count_left;
2612 if (db_idx < 0) /* left block is new */
2614 lnum_left = lnum + 1;
2615 lnum_right = 0;
2617 else /* right block is new */
2619 lnum_left = 0;
2620 if (in_left)
2621 lnum_right = lnum + 2;
2622 else
2623 lnum_right = lnum + 1;
2625 dp_left->db_line_count = line_count_left;
2626 dp_right->db_line_count = line_count_right;
2629 * release the two data blocks
2630 * The new one (hp_new) already has a correct blocknumber.
2631 * The old one (hp, in ml_locked) gets a positive blocknumber if
2632 * we changed it and we are not editing a new file.
2634 if (lines_moved || in_left)
2635 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2636 if (!newfile && db_idx >= 0 && in_left)
2637 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2638 mf_put(mfp, hp_new, TRUE, FALSE);
2641 * flush the old data block
2642 * set ml_locked_lineadd to 0, because the updating of the
2643 * pointer blocks is done below
2645 lineadd = buf->b_ml.ml_locked_lineadd;
2646 buf->b_ml.ml_locked_lineadd = 0;
2647 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2650 * update pointer blocks for the new data block
2652 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2653 --stack_idx)
2655 ip = &(buf->b_ml.ml_stack[stack_idx]);
2656 pb_idx = ip->ip_index;
2657 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2658 return FAIL;
2659 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2660 if (pp->pb_id != PTR_ID)
2662 EMSG(_("E317: pointer block id wrong 3"));
2663 mf_put(mfp, hp, FALSE, FALSE);
2664 return FAIL;
2667 * TODO: If the pointer block is full and we are adding at the end
2668 * try to insert in front of the next block
2670 /* block not full, add one entry */
2671 if (pp->pb_count < pp->pb_count_max)
2673 if (pb_idx + 1 < (int)pp->pb_count)
2674 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2675 &pp->pb_pointer[pb_idx + 1],
2676 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2677 ++pp->pb_count;
2678 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2679 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2680 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2681 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2682 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2683 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2685 if (lnum_left != 0)
2686 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2687 if (lnum_right != 0)
2688 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2690 mf_put(mfp, hp, TRUE, FALSE);
2691 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2693 if (lineadd)
2695 --(buf->b_ml.ml_stack_top);
2696 /* fix line count for rest of blocks in the stack */
2697 ml_lineadd(buf, lineadd);
2698 /* fix stack itself */
2699 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2700 lineadd;
2701 ++(buf->b_ml.ml_stack_top);
2705 * We are finished, break the loop here.
2707 break;
2709 else /* pointer block full */
2712 * split the pointer block
2713 * allocate a new pointer block
2714 * move some of the pointer into the new block
2715 * prepare for updating the parent block
2717 for (;;) /* do this twice when splitting block 1 */
2719 hp_new = ml_new_ptr(mfp);
2720 if (hp_new == NULL) /* TODO: try to fix tree */
2721 return FAIL;
2722 pp_new = (PTR_BL *)(hp_new->bh_data);
2724 if (hp->bh_bnum != 1)
2725 break;
2728 * if block 1 becomes full the tree is given an extra level
2729 * The pointers from block 1 are moved into the new block.
2730 * block 1 is updated to point to the new block
2731 * then continue to split the new block
2733 mch_memmove(pp_new, pp, (size_t)page_size);
2734 pp->pb_count = 1;
2735 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2736 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2737 pp->pb_pointer[0].pe_old_lnum = 1;
2738 pp->pb_pointer[0].pe_page_count = 1;
2739 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2740 hp = hp_new; /* new block is to be split */
2741 pp = pp_new;
2742 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2743 ip->ip_index = 0;
2744 ++stack_idx; /* do block 1 again later */
2747 * move the pointers after the current one to the new block
2748 * If there are none, the new entry will be in the new block.
2750 total_moved = pp->pb_count - pb_idx - 1;
2751 if (total_moved)
2753 mch_memmove(&pp_new->pb_pointer[0],
2754 &pp->pb_pointer[pb_idx + 1],
2755 (size_t)(total_moved) * sizeof(PTR_EN));
2756 pp_new->pb_count = total_moved;
2757 pp->pb_count -= total_moved - 1;
2758 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2759 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2760 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2761 if (lnum_right)
2762 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2764 else
2766 pp_new->pb_count = 1;
2767 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2768 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2769 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2770 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2772 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2773 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2774 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2775 if (lnum_left)
2776 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2777 lnum_left = 0;
2778 lnum_right = 0;
2781 * recompute line counts
2783 line_count_right = 0;
2784 for (i = 0; i < (int)pp_new->pb_count; ++i)
2785 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2786 line_count_left = 0;
2787 for (i = 0; i < (int)pp->pb_count; ++i)
2788 line_count_left += pp->pb_pointer[i].pe_line_count;
2790 bnum_left = hp->bh_bnum;
2791 bnum_right = hp_new->bh_bnum;
2792 page_count_left = 1;
2793 page_count_right = 1;
2794 mf_put(mfp, hp, TRUE, FALSE);
2795 mf_put(mfp, hp_new, TRUE, FALSE);
2800 * Safety check: fallen out of for loop?
2802 if (stack_idx < 0)
2804 EMSG(_("E318: Updated too many blocks?"));
2805 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2809 #ifdef FEAT_BYTEOFF
2810 /* The line was inserted below 'lnum' */
2811 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2812 #endif
2813 #ifdef FEAT_NETBEANS_INTG
2814 if (usingNetbeans)
2816 if (STRLEN(line) > 0)
2817 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2818 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2819 (char_u *)"\n", 1);
2821 #endif
2822 return OK;
2826 * Replace line lnum, with buffering, in current buffer.
2828 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2829 * copied to allocated memory already.
2831 * Check: The caller of this function should probably also call
2832 * changed_lines(), unless update_screen(NOT_VALID) is used.
2834 * return FAIL for failure, OK otherwise
2837 ml_replace(lnum, line, copy)
2838 linenr_T lnum;
2839 char_u *line;
2840 int copy;
2842 if (line == NULL) /* just checking... */
2843 return FAIL;
2845 /* When starting up, we might still need to create the memfile */
2846 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2847 return FAIL;
2849 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2850 return FAIL;
2851 #ifdef FEAT_NETBEANS_INTG
2852 if (usingNetbeans)
2854 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2855 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2857 #endif
2858 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2859 ml_flush_line(curbuf); /* flush it */
2860 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2861 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2862 curbuf->b_ml.ml_line_ptr = line;
2863 curbuf->b_ml.ml_line_lnum = lnum;
2864 curbuf->b_ml.ml_line_max = 0;
2865 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2867 return OK;
2871 * Delete line 'lnum' in the current buffer.
2873 * Check: The caller of this function should probably also call
2874 * deleted_lines() after this.
2876 * return FAIL for failure, OK otherwise
2879 ml_delete(lnum, message)
2880 linenr_T lnum;
2881 int message;
2883 ml_flush_line(curbuf);
2884 return ml_delete_int(curbuf, lnum, message);
2887 static int
2888 ml_delete_int(buf, lnum, message)
2889 buf_T *buf;
2890 linenr_T lnum;
2891 int message;
2893 bhdr_T *hp;
2894 memfile_T *mfp;
2895 DATA_BL *dp;
2896 PTR_BL *pp;
2897 infoptr_T *ip;
2898 int count; /* number of entries in block */
2899 int idx;
2900 int stack_idx;
2901 int text_start;
2902 int line_start;
2903 long line_size;
2904 int i;
2906 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2907 return FAIL;
2909 if (lowest_marked && lowest_marked > lnum)
2910 lowest_marked--;
2913 * If the file becomes empty the last line is replaced by an empty line.
2915 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2917 if (message
2918 #ifdef FEAT_NETBEANS_INTG
2919 && !netbeansSuppressNoLines
2920 #endif
2922 set_keep_msg((char_u *)_(no_lines_msg), 0);
2924 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2925 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2926 buf->b_ml.ml_flags |= ML_EMPTY;
2928 return i;
2932 * find the data block containing the line
2933 * This also fills the stack with the blocks from the root to the data block
2934 * This also releases any locked block.
2936 mfp = buf->b_ml.ml_mfp;
2937 if (mfp == NULL)
2938 return FAIL;
2940 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2941 return FAIL;
2943 dp = (DATA_BL *)(hp->bh_data);
2944 /* compute line count before the delete */
2945 count = (long)(buf->b_ml.ml_locked_high)
2946 - (long)(buf->b_ml.ml_locked_low) + 2;
2947 idx = lnum - buf->b_ml.ml_locked_low;
2949 --buf->b_ml.ml_line_count;
2951 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2952 if (idx == 0) /* first line in block, text at the end */
2953 line_size = dp->db_txt_end - line_start;
2954 else
2955 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2957 #ifdef FEAT_NETBEANS_INTG
2958 if (usingNetbeans)
2959 netbeans_removed(buf, lnum, 0, (long)line_size);
2960 #endif
2963 * special case: If there is only one line in the data block it becomes empty.
2964 * Then we have to remove the entry, pointing to this data block, from the
2965 * pointer block. If this pointer block also becomes empty, we go up another
2966 * block, and so on, up to the root if necessary.
2967 * The line counts in the pointer blocks have already been adjusted by
2968 * ml_find_line().
2970 if (count == 1)
2972 mf_free(mfp, hp); /* free the data block */
2973 buf->b_ml.ml_locked = NULL;
2975 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2977 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2978 ip = &(buf->b_ml.ml_stack[stack_idx]);
2979 idx = ip->ip_index;
2980 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2981 return FAIL;
2982 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2983 if (pp->pb_id != PTR_ID)
2985 EMSG(_("E317: pointer block id wrong 4"));
2986 mf_put(mfp, hp, FALSE, FALSE);
2987 return FAIL;
2989 count = --(pp->pb_count);
2990 if (count == 0) /* the pointer block becomes empty! */
2991 mf_free(mfp, hp);
2992 else
2994 if (count != idx) /* move entries after the deleted one */
2995 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2996 (size_t)(count - idx) * sizeof(PTR_EN));
2997 mf_put(mfp, hp, TRUE, FALSE);
2999 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
3000 /* fix line count for rest of blocks in the stack */
3001 if (buf->b_ml.ml_locked_lineadd != 0)
3003 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3004 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
3005 buf->b_ml.ml_locked_lineadd;
3007 ++(buf->b_ml.ml_stack_top);
3009 break;
3012 CHECK(stack_idx < 0, _("deleted block 1?"));
3014 else
3017 * delete the text by moving the next lines forwards
3019 text_start = dp->db_txt_start;
3020 mch_memmove((char *)dp + text_start + line_size,
3021 (char *)dp + text_start, (size_t)(line_start - text_start));
3024 * delete the index by moving the next indexes backwards
3025 * Adjust the indexes for the text movement.
3027 for (i = idx; i < count - 1; ++i)
3028 dp->db_index[i] = dp->db_index[i + 1] + line_size;
3030 dp->db_free += line_size + INDEX_SIZE;
3031 dp->db_txt_start += line_size;
3032 --(dp->db_line_count);
3035 * mark the block dirty and make sure it is in the file (for recovery)
3037 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3040 #ifdef FEAT_BYTEOFF
3041 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
3042 #endif
3043 return OK;
3047 * set the B_MARKED flag for line 'lnum'
3049 void
3050 ml_setmarked(lnum)
3051 linenr_T lnum;
3053 bhdr_T *hp;
3054 DATA_BL *dp;
3055 /* invalid line number */
3056 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3057 || curbuf->b_ml.ml_mfp == NULL)
3058 return; /* give error message? */
3060 if (lowest_marked == 0 || lowest_marked > lnum)
3061 lowest_marked = lnum;
3064 * find the data block containing the line
3065 * This also fills the stack with the blocks from the root to the data block
3066 * This also releases any locked block.
3068 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3069 return; /* give error message? */
3071 dp = (DATA_BL *)(hp->bh_data);
3072 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
3073 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3077 * find the first line with its B_MARKED flag set
3079 linenr_T
3080 ml_firstmarked()
3082 bhdr_T *hp;
3083 DATA_BL *dp;
3084 linenr_T lnum;
3085 int i;
3087 if (curbuf->b_ml.ml_mfp == NULL)
3088 return (linenr_T) 0;
3091 * The search starts with lowest_marked line. This is the last line where
3092 * a mark was found, adjusted by inserting/deleting lines.
3094 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3097 * Find the data block containing the line.
3098 * This also fills the stack with the blocks from the root to the data
3099 * block This also releases any locked block.
3101 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3102 return (linenr_T)0; /* give error message? */
3104 dp = (DATA_BL *)(hp->bh_data);
3106 for (i = lnum - curbuf->b_ml.ml_locked_low;
3107 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3108 if ((dp->db_index[i]) & DB_MARKED)
3110 (dp->db_index[i]) &= DB_INDEX_MASK;
3111 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3112 lowest_marked = lnum + 1;
3113 return lnum;
3117 return (linenr_T) 0;
3120 #if 0 /* not used */
3122 * return TRUE if line 'lnum' has a mark
3125 ml_has_mark(lnum)
3126 linenr_T lnum;
3128 bhdr_T *hp;
3129 DATA_BL *dp;
3131 if (curbuf->b_ml.ml_mfp == NULL
3132 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3133 return FALSE;
3135 dp = (DATA_BL *)(hp->bh_data);
3136 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3138 #endif
3141 * clear all DB_MARKED flags
3143 void
3144 ml_clearmarked()
3146 bhdr_T *hp;
3147 DATA_BL *dp;
3148 linenr_T lnum;
3149 int i;
3151 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3152 return;
3155 * The search starts with line lowest_marked.
3157 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3160 * Find the data block containing the line.
3161 * This also fills the stack with the blocks from the root to the data
3162 * block and releases any locked block.
3164 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3165 return; /* give error message? */
3167 dp = (DATA_BL *)(hp->bh_data);
3169 for (i = lnum - curbuf->b_ml.ml_locked_low;
3170 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3171 if ((dp->db_index[i]) & DB_MARKED)
3173 (dp->db_index[i]) &= DB_INDEX_MASK;
3174 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3178 lowest_marked = 0;
3179 return;
3183 * flush ml_line if necessary
3185 static void
3186 ml_flush_line(buf)
3187 buf_T *buf;
3189 bhdr_T *hp;
3190 DATA_BL *dp;
3191 linenr_T lnum;
3192 char_u *new_line;
3193 char_u *old_line;
3194 colnr_T new_len;
3195 int old_len;
3196 int extra;
3197 int idx;
3198 int start;
3199 int count;
3200 int i;
3201 static int entered = FALSE;
3203 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3204 return; /* nothing to do */
3206 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3208 /* This code doesn't work recursively, but Netbeans may call back here
3209 * when obtaining the cursor position. */
3210 if (entered)
3211 return;
3212 entered = TRUE;
3214 lnum = buf->b_ml.ml_line_lnum;
3215 new_line = buf->b_ml.ml_line_ptr;
3217 hp = ml_find_line(buf, lnum, ML_FIND);
3218 if (hp == NULL)
3219 EMSGN(_("E320: Cannot find line %ld"), lnum);
3220 else
3222 dp = (DATA_BL *)(hp->bh_data);
3223 idx = lnum - buf->b_ml.ml_locked_low;
3224 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3225 old_line = (char_u *)dp + start;
3226 if (idx == 0) /* line is last in block */
3227 old_len = dp->db_txt_end - start;
3228 else /* text of previous line follows */
3229 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3230 new_len = (colnr_T)STRLEN(new_line) + 1;
3231 extra = new_len - old_len; /* negative if lines gets smaller */
3234 * if new line fits in data block, replace directly
3236 if ((int)dp->db_free >= extra)
3238 /* if the length changes and there are following lines */
3239 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3240 if (extra != 0 && idx < count - 1)
3242 /* move text of following lines */
3243 mch_memmove((char *)dp + dp->db_txt_start - extra,
3244 (char *)dp + dp->db_txt_start,
3245 (size_t)(start - dp->db_txt_start));
3247 /* adjust pointers of this and following lines */
3248 for (i = idx + 1; i < count; ++i)
3249 dp->db_index[i] -= extra;
3251 dp->db_index[idx] -= extra;
3253 /* adjust free space */
3254 dp->db_free -= extra;
3255 dp->db_txt_start -= extra;
3257 /* copy new line into the data block */
3258 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3259 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3260 #ifdef FEAT_BYTEOFF
3261 /* The else case is already covered by the insert and delete */
3262 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3263 #endif
3265 else
3268 * Cannot do it in one data block: Delete and append.
3269 * Append first, because ml_delete_int() cannot delete the
3270 * last line in a buffer, which causes trouble for a buffer
3271 * that has only one line.
3272 * Don't forget to copy the mark!
3274 /* How about handling errors??? */
3275 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3276 (dp->db_index[idx] & DB_MARKED));
3277 (void)ml_delete_int(buf, lnum, FALSE);
3280 vim_free(new_line);
3282 entered = FALSE;
3285 buf->b_ml.ml_line_lnum = 0;
3289 * create a new, empty, data block
3291 static bhdr_T *
3292 ml_new_data(mfp, negative, page_count)
3293 memfile_T *mfp;
3294 int negative;
3295 int page_count;
3297 bhdr_T *hp;
3298 DATA_BL *dp;
3300 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3301 return NULL;
3303 dp = (DATA_BL *)(hp->bh_data);
3304 dp->db_id = DATA_ID;
3305 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3306 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3307 dp->db_line_count = 0;
3309 return hp;
3313 * create a new, empty, pointer block
3315 static bhdr_T *
3316 ml_new_ptr(mfp)
3317 memfile_T *mfp;
3319 bhdr_T *hp;
3320 PTR_BL *pp;
3322 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3323 return NULL;
3325 pp = (PTR_BL *)(hp->bh_data);
3326 pp->pb_id = PTR_ID;
3327 pp->pb_count = 0;
3328 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3330 return hp;
3334 * lookup line 'lnum' in a memline
3336 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3337 * if ML_FLUSH only flush a locked block
3338 * if ML_FIND just find the line
3340 * If the block was found it is locked and put in ml_locked.
3341 * The stack is updated to lead to the locked block. The ip_high field in
3342 * the stack is updated to reflect the last line in the block AFTER the
3343 * insert or delete, also if the pointer block has not been updated yet. But
3344 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3346 * return: NULL for failure, pointer to block header otherwise
3348 static bhdr_T *
3349 ml_find_line(buf, lnum, action)
3350 buf_T *buf;
3351 linenr_T lnum;
3352 int action;
3354 DATA_BL *dp;
3355 PTR_BL *pp;
3356 infoptr_T *ip;
3357 bhdr_T *hp;
3358 memfile_T *mfp;
3359 linenr_T t;
3360 blocknr_T bnum, bnum2;
3361 int dirty;
3362 linenr_T low, high;
3363 int top;
3364 int page_count;
3365 int idx;
3367 mfp = buf->b_ml.ml_mfp;
3370 * If there is a locked block check if the wanted line is in it.
3371 * If not, flush and release the locked block.
3372 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3373 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3374 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3376 if (buf->b_ml.ml_locked)
3378 if (ML_SIMPLE(action)
3379 && buf->b_ml.ml_locked_low <= lnum
3380 && buf->b_ml.ml_locked_high >= lnum
3381 && !mf_dont_release)
3383 /* remember to update pointer blocks and stack later */
3384 if (action == ML_INSERT)
3386 ++(buf->b_ml.ml_locked_lineadd);
3387 ++(buf->b_ml.ml_locked_high);
3389 else if (action == ML_DELETE)
3391 --(buf->b_ml.ml_locked_lineadd);
3392 --(buf->b_ml.ml_locked_high);
3394 return (buf->b_ml.ml_locked);
3397 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3398 buf->b_ml.ml_flags & ML_LOCKED_POS);
3399 buf->b_ml.ml_locked = NULL;
3402 * If lines have been added or deleted in the locked block, need to
3403 * update the line count in pointer blocks.
3405 if (buf->b_ml.ml_locked_lineadd != 0)
3406 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3409 if (action == ML_FLUSH) /* nothing else to do */
3410 return NULL;
3412 bnum = 1; /* start at the root of the tree */
3413 page_count = 1;
3414 low = 1;
3415 high = buf->b_ml.ml_line_count;
3417 if (action == ML_FIND) /* first try stack entries */
3419 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3421 ip = &(buf->b_ml.ml_stack[top]);
3422 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3424 bnum = ip->ip_bnum;
3425 low = ip->ip_low;
3426 high = ip->ip_high;
3427 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3428 break;
3431 if (top < 0)
3432 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3434 else /* ML_DELETE or ML_INSERT */
3435 buf->b_ml.ml_stack_top = 0; /* start at the root */
3438 * search downwards in the tree until a data block is found
3440 for (;;)
3442 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3443 goto error_noblock;
3446 * update high for insert/delete
3448 if (action == ML_INSERT)
3449 ++high;
3450 else if (action == ML_DELETE)
3451 --high;
3453 dp = (DATA_BL *)(hp->bh_data);
3454 if (dp->db_id == DATA_ID) /* data block */
3456 buf->b_ml.ml_locked = hp;
3457 buf->b_ml.ml_locked_low = low;
3458 buf->b_ml.ml_locked_high = high;
3459 buf->b_ml.ml_locked_lineadd = 0;
3460 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3461 return hp;
3464 pp = (PTR_BL *)(dp); /* must be pointer block */
3465 if (pp->pb_id != PTR_ID)
3467 EMSG(_("E317: pointer block id wrong"));
3468 goto error_block;
3471 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3472 goto error_block;
3473 ip = &(buf->b_ml.ml_stack[top]);
3474 ip->ip_bnum = bnum;
3475 ip->ip_low = low;
3476 ip->ip_high = high;
3477 ip->ip_index = -1; /* index not known yet */
3479 dirty = FALSE;
3480 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3482 t = pp->pb_pointer[idx].pe_line_count;
3483 CHECK(t == 0, _("pe_line_count is zero"));
3484 if ((low += t) > lnum)
3486 ip->ip_index = idx;
3487 bnum = pp->pb_pointer[idx].pe_bnum;
3488 page_count = pp->pb_pointer[idx].pe_page_count;
3489 high = low - 1;
3490 low -= t;
3493 * a negative block number may have been changed
3495 if (bnum < 0)
3497 bnum2 = mf_trans_del(mfp, bnum);
3498 if (bnum != bnum2)
3500 bnum = bnum2;
3501 pp->pb_pointer[idx].pe_bnum = bnum;
3502 dirty = TRUE;
3506 break;
3509 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3511 if (lnum > buf->b_ml.ml_line_count)
3512 EMSGN(_("E322: line number out of range: %ld past the end"),
3513 lnum - buf->b_ml.ml_line_count);
3515 else
3516 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3517 goto error_block;
3519 if (action == ML_DELETE)
3521 pp->pb_pointer[idx].pe_line_count--;
3522 dirty = TRUE;
3524 else if (action == ML_INSERT)
3526 pp->pb_pointer[idx].pe_line_count++;
3527 dirty = TRUE;
3529 mf_put(mfp, hp, dirty, FALSE);
3532 error_block:
3533 mf_put(mfp, hp, FALSE, FALSE);
3534 error_noblock:
3536 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3537 * the incremented/decremented line counts, because there won't be a line
3538 * inserted/deleted after all.
3540 if (action == ML_DELETE)
3541 ml_lineadd(buf, 1);
3542 else if (action == ML_INSERT)
3543 ml_lineadd(buf, -1);
3544 buf->b_ml.ml_stack_top = 0;
3545 return NULL;
3549 * add an entry to the info pointer stack
3551 * return -1 for failure, number of the new entry otherwise
3553 static int
3554 ml_add_stack(buf)
3555 buf_T *buf;
3557 int top;
3558 infoptr_T *newstack;
3560 top = buf->b_ml.ml_stack_top;
3562 /* may have to increase the stack size */
3563 if (top == buf->b_ml.ml_stack_size)
3565 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3567 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3568 (buf->b_ml.ml_stack_size + STACK_INCR));
3569 if (newstack == NULL)
3570 return -1;
3571 mch_memmove(newstack, buf->b_ml.ml_stack,
3572 (size_t)top * sizeof(infoptr_T));
3573 vim_free(buf->b_ml.ml_stack);
3574 buf->b_ml.ml_stack = newstack;
3575 buf->b_ml.ml_stack_size += STACK_INCR;
3578 buf->b_ml.ml_stack_top++;
3579 return top;
3583 * Update the pointer blocks on the stack for inserted/deleted lines.
3584 * The stack itself is also updated.
3586 * When a insert/delete line action fails, the line is not inserted/deleted,
3587 * but the pointer blocks have already been updated. That is fixed here by
3588 * walking through the stack.
3590 * Count is the number of lines added, negative if lines have been deleted.
3592 static void
3593 ml_lineadd(buf, count)
3594 buf_T *buf;
3595 int count;
3597 int idx;
3598 infoptr_T *ip;
3599 PTR_BL *pp;
3600 memfile_T *mfp = buf->b_ml.ml_mfp;
3601 bhdr_T *hp;
3603 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3605 ip = &(buf->b_ml.ml_stack[idx]);
3606 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3607 break;
3608 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3609 if (pp->pb_id != PTR_ID)
3611 mf_put(mfp, hp, FALSE, FALSE);
3612 EMSG(_("E317: pointer block id wrong 2"));
3613 break;
3615 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3616 ip->ip_high += count;
3617 mf_put(mfp, hp, TRUE, FALSE);
3621 #ifdef HAVE_READLINK
3623 * Resolve a symlink in the last component of a file name.
3624 * Note that f_resolve() does it for every part of the path, we don't do that
3625 * here.
3626 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3627 * Otherwise returns FAIL.
3629 static int
3630 resolve_symlink(fname, buf)
3631 char_u *fname;
3632 char_u *buf;
3634 char_u tmp[MAXPATHL];
3635 int ret;
3636 int depth = 0;
3638 if (fname == NULL)
3639 return FAIL;
3641 /* Put the result so far in tmp[], starting with the original name. */
3642 vim_strncpy(tmp, fname, MAXPATHL - 1);
3644 for (;;)
3646 /* Limit symlink depth to 100, catch recursive loops. */
3647 if (++depth == 100)
3649 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3650 return FAIL;
3653 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3654 if (ret <= 0)
3656 if (errno == EINVAL || errno == ENOENT)
3658 /* Found non-symlink or not existing file, stop here.
3659 * When at the first level use the unmodified name, skip the
3660 * call to vim_FullName(). */
3661 if (depth == 1)
3662 return FAIL;
3664 /* Use the resolved name in tmp[]. */
3665 break;
3668 /* There must be some error reading links, use original name. */
3669 return FAIL;
3671 buf[ret] = NUL;
3674 * Check whether the symlink is relative or absolute.
3675 * If it's relative, build a new path based on the directory
3676 * portion of the filename (if any) and the path the symlink
3677 * points to.
3679 if (mch_isFullName(buf))
3680 STRCPY(tmp, buf);
3681 else
3683 char_u *tail;
3685 tail = gettail(tmp);
3686 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3687 return FAIL;
3688 STRCPY(tail, buf);
3693 * Try to resolve the full name of the file so that the swapfile name will
3694 * be consistent even when opening a relative symlink from different
3695 * working directories.
3697 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3699 #endif
3702 * Make swap file name out of the file name and a directory name.
3703 * Returns pointer to allocated memory or NULL.
3705 char_u *
3706 makeswapname(fname, ffname, buf, dir_name)
3707 char_u *fname;
3708 char_u *ffname UNUSED;
3709 buf_T *buf;
3710 char_u *dir_name;
3712 char_u *r, *s;
3713 char_u *fname_res = fname;
3714 #ifdef HAVE_READLINK
3715 char_u fname_buf[MAXPATHL];
3716 #endif
3718 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3719 s = dir_name + STRLEN(dir_name);
3720 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3721 { /* Ends with '//', Use Full path */
3722 r = NULL;
3723 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3725 r = modname(s, (char_u *)".swp", FALSE);
3726 vim_free(s);
3728 return r;
3730 #endif
3732 #ifdef HAVE_READLINK
3733 /* Expand symlink in the file name, so that we put the swap file with the
3734 * actual file instead of with the symlink. */
3735 if (resolve_symlink(fname, fname_buf) == OK)
3736 fname_res = fname_buf;
3737 #endif
3739 r = buf_modname(
3740 #ifdef SHORT_FNAME
3741 TRUE,
3742 #else
3743 (buf->b_p_sn || buf->b_shortname),
3744 #endif
3745 #ifdef RISCOS
3746 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3747 ffname,
3748 #else
3749 fname_res,
3750 #endif
3751 (char_u *)
3752 #if defined(VMS) || defined(RISCOS)
3753 "_swp",
3754 #else
3755 ".swp",
3756 #endif
3757 #ifdef SHORT_FNAME /* always 8.3 file name */
3758 FALSE
3759 #else
3760 /* Prepend a '.' to the swap file name for the current directory. */
3761 dir_name[0] == '.' && dir_name[1] == NUL
3762 #endif
3764 if (r == NULL) /* out of memory */
3765 return NULL;
3767 s = get_file_in_dir(r, dir_name);
3768 vim_free(r);
3769 return s;
3773 * Get file name to use for swap file or backup file.
3774 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3775 * option "dname".
3776 * - If "dname" is ".", return "fname" (swap file in dir of file).
3777 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3778 * relative to dir of file).
3779 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3780 * dir).
3782 * The return value is an allocated string and can be NULL.
3784 char_u *
3785 get_file_in_dir(fname, dname)
3786 char_u *fname;
3787 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3789 char_u *t;
3790 char_u *tail;
3791 char_u *retval;
3792 int save_char;
3794 tail = gettail(fname);
3796 if (dname[0] == '.' && dname[1] == NUL)
3797 retval = vim_strsave(fname);
3798 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3800 if (tail == fname) /* no path before file name */
3801 retval = concat_fnames(dname + 2, tail, TRUE);
3802 else
3804 save_char = *tail;
3805 *tail = NUL;
3806 t = concat_fnames(fname, dname + 2, TRUE);
3807 *tail = save_char;
3808 if (t == NULL) /* out of memory */
3809 retval = NULL;
3810 else
3812 retval = concat_fnames(t, tail, TRUE);
3813 vim_free(t);
3817 else
3818 retval = concat_fnames(dname, tail, TRUE);
3820 return retval;
3823 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3826 * Print the ATTENTION message: info about an existing swap file.
3828 static void
3829 attention_message(buf, fname)
3830 buf_T *buf; /* buffer being edited */
3831 char_u *fname; /* swap file name */
3833 struct stat st;
3834 time_t x, sx;
3835 char *p;
3837 ++no_wait_return;
3838 (void)EMSG(_("E325: ATTENTION"));
3839 MSG_PUTS(_("\nFound a swap file by the name \""));
3840 msg_home_replace(fname);
3841 MSG_PUTS("\"\n");
3842 sx = swapfile_info(fname);
3843 MSG_PUTS(_("While opening file \""));
3844 msg_outtrans(buf->b_fname);
3845 MSG_PUTS("\"\n");
3846 if (mch_stat((char *)buf->b_fname, &st) != -1)
3848 MSG_PUTS(_(" dated: "));
3849 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3850 p = ctime(&x); /* includes '\n' */
3851 if (p == NULL)
3852 MSG_PUTS("(invalid)\n");
3853 else
3854 MSG_PUTS(p);
3855 if (sx != 0 && x > sx)
3856 MSG_PUTS(_(" NEWER than swap file!\n"));
3858 /* Some of these messages are long to allow translation to
3859 * other languages. */
3860 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"));
3861 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3862 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3863 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3864 msg_outtrans(buf->b_fname);
3865 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3866 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3867 msg_outtrans(fname);
3868 MSG_PUTS(_("\"\n to avoid this message.\n"));
3869 cmdline_row = msg_row;
3870 --no_wait_return;
3873 #ifdef FEAT_AUTOCMD
3874 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3877 * Trigger the SwapExists autocommands.
3878 * Returns a value for equivalent to do_dialog() (see below):
3879 * 0: still need to ask for a choice
3880 * 1: open read-only
3881 * 2: edit anyway
3882 * 3: recover
3883 * 4: delete it
3884 * 5: quit
3885 * 6: abort
3887 static int
3888 do_swapexists(buf, fname)
3889 buf_T *buf;
3890 char_u *fname;
3892 set_vim_var_string(VV_SWAPNAME, fname, -1);
3893 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3895 /* Trigger SwapExists autocommands with <afile> set to the file being
3896 * edited. Disallow changing directory here. */
3897 ++allbuf_lock;
3898 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3899 --allbuf_lock;
3901 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3903 switch (*get_vim_var_str(VV_SWAPCHOICE))
3905 case 'o': return 1;
3906 case 'e': return 2;
3907 case 'r': return 3;
3908 case 'd': return 4;
3909 case 'q': return 5;
3910 case 'a': return 6;
3913 return 0;
3915 #endif
3918 * Find out what name to use for the swap file for buffer 'buf'.
3920 * Several names are tried to find one that does not exist
3921 * Returns the name in allocated memory or NULL.
3923 * Note: If BASENAMELEN is not correct, you will get error messages for
3924 * not being able to open the swap or undo file
3925 * Note: May trigger SwapExists autocmd, pointers may change!
3927 static char_u *
3928 findswapname(buf, dirp, old_fname)
3929 buf_T *buf;
3930 char_u **dirp; /* pointer to list of directories */
3931 char_u *old_fname; /* don't give warning for this file name */
3933 char_u *fname;
3934 int n;
3935 char_u *dir_name;
3936 #ifdef AMIGA
3937 BPTR fh;
3938 #endif
3939 #ifndef SHORT_FNAME
3940 int r;
3941 #endif
3943 #if !defined(SHORT_FNAME) \
3944 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3945 # define CREATE_DUMMY_FILE
3946 FILE *dummyfd = NULL;
3949 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3950 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3951 * create will be exactly the same file. To avoid this problem we temporarily
3952 * create "test.doc".
3953 * Don't do this when the check below for a 8.3 file name is used.
3955 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3956 && mch_getperm(buf->b_fname) < 0)
3957 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3958 #endif
3961 * Isolate a directory name from *dirp and put it in dir_name.
3962 * First allocate some memory to put the directory name in.
3964 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3965 if (dir_name != NULL)
3966 (void)copy_option_part(dirp, dir_name, 31000, ",");
3969 * we try different names until we find one that does not exist yet
3971 if (dir_name == NULL) /* out of memory */
3972 fname = NULL;
3973 else
3974 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3976 for (;;)
3978 if (fname == NULL) /* must be out of memory */
3979 break;
3980 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3982 vim_free(fname);
3983 fname = NULL;
3984 break;
3986 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3988 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3989 * file names. If this is the first try and the swap file name does not fit in
3990 * 8.3, detect if this is the case, set shortname and try again.
3992 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3993 && !(buf->b_p_sn || buf->b_shortname))
3995 char_u *tail;
3996 char_u *fname2;
3997 struct stat s1, s2;
3998 int f1, f2;
3999 int created1 = FALSE, created2 = FALSE;
4000 int same = FALSE;
4003 * Check if swapfile name does not fit in 8.3:
4004 * It either contains two dots, is longer than 8 chars, or starts
4005 * with a dot.
4007 tail = gettail(buf->b_fname);
4008 if ( vim_strchr(tail, '.') != NULL
4009 || STRLEN(tail) > (size_t)8
4010 || *gettail(fname) == '.')
4012 fname2 = alloc(n + 2);
4013 if (fname2 != NULL)
4015 STRCPY(fname2, fname);
4016 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
4017 * if fname == ".xx.swp", fname2 = ".xx.swpx"
4018 * if fname == "123456789.swp", fname2 = "12345678x.swp"
4020 if (vim_strchr(tail, '.') != NULL)
4021 fname2[n - 1] = 'x';
4022 else if (*gettail(fname) == '.')
4024 fname2[n] = 'x';
4025 fname2[n + 1] = NUL;
4027 else
4028 fname2[n - 5] += 1;
4030 * may need to create the files to be able to use mch_stat()
4032 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4033 if (f1 < 0)
4035 f1 = mch_open_rw((char *)fname,
4036 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4037 #if defined(OS2)
4038 if (f1 < 0 && errno == ENOENT)
4039 same = TRUE;
4040 #endif
4041 created1 = TRUE;
4043 if (f1 >= 0)
4045 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4046 if (f2 < 0)
4048 f2 = mch_open_rw((char *)fname2,
4049 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4050 created2 = TRUE;
4052 if (f2 >= 0)
4055 * Both files exist now. If mch_stat() returns the
4056 * same device and inode they are the same file.
4058 if (mch_fstat(f1, &s1) != -1
4059 && mch_fstat(f2, &s2) != -1
4060 && s1.st_dev == s2.st_dev
4061 && s1.st_ino == s2.st_ino)
4062 same = TRUE;
4063 close(f2);
4064 if (created2)
4065 mch_remove(fname2);
4067 close(f1);
4068 if (created1)
4069 mch_remove(fname);
4071 vim_free(fname2);
4072 if (same)
4074 buf->b_shortname = TRUE;
4075 vim_free(fname);
4076 fname = makeswapname(buf->b_fname, buf->b_ffname,
4077 buf, dir_name);
4078 continue; /* try again with b_shortname set */
4083 #endif
4085 * check if the swapfile already exists
4087 if (mch_getperm(fname) < 0) /* it does not exist */
4089 #ifdef HAVE_LSTAT
4090 struct stat sb;
4093 * Extra security check: When a swap file is a symbolic link, this
4094 * is most likely a symlink attack.
4096 if (mch_lstat((char *)fname, &sb) < 0)
4097 #else
4098 # ifdef AMIGA
4099 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4101 * on the Amiga mch_getperm() will return -1 when the file exists
4102 * but is being used by another program. This happens if you edit
4103 * a file twice.
4105 if (fh != (BPTR)NULL) /* can open file, OK */
4107 Close(fh);
4108 mch_remove(fname);
4109 break;
4111 if (IoErr() != ERROR_OBJECT_IN_USE
4112 && IoErr() != ERROR_OBJECT_EXISTS)
4113 # endif
4114 #endif
4115 break;
4119 * A file name equal to old_fname is OK to use.
4121 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4122 break;
4125 * get here when file already exists
4127 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4129 #ifndef SHORT_FNAME
4131 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4132 * and file.doc are the same file. To guess if this problem is
4133 * present try if file.doc.swx exists. If it does, we set
4134 * buf->b_shortname and try file_doc.swp (dots replaced by
4135 * underscores for this file), and try again. If it doesn't we
4136 * assume that "file.doc.swp" already exists.
4138 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4140 fname[n - 1] = 'x';
4141 r = mch_getperm(fname); /* try "file.swx" */
4142 fname[n - 1] = 'p';
4143 if (r >= 0) /* "file.swx" seems to exist */
4145 buf->b_shortname = TRUE;
4146 vim_free(fname);
4147 fname = makeswapname(buf->b_fname, buf->b_ffname,
4148 buf, dir_name);
4149 continue; /* try again with '.' replaced with '_' */
4152 #endif
4154 * If we get here the ".swp" file really exists.
4155 * Give an error message, unless recovering, no file name, we are
4156 * viewing a help file or when the path of the file is different
4157 * (happens when all .swp files are in one directory).
4159 if (!recoverymode && buf->b_fname != NULL
4160 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4162 int fd;
4163 struct block0 b0;
4164 int differ = FALSE;
4167 * Try to read block 0 from the swap file to get the original
4168 * file name (and inode number).
4170 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4171 if (fd >= 0)
4173 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4176 * If the swapfile has the same directory as the
4177 * buffer don't compare the directory names, they can
4178 * have a different mountpoint.
4180 if (b0.b0_flags & B0_SAME_DIR)
4182 if (fnamecmp(gettail(buf->b_ffname),
4183 gettail(b0.b0_fname)) != 0
4184 || !same_directory(fname, buf->b_ffname))
4186 #ifdef CHECK_INODE
4187 /* Symlinks may point to the same file even
4188 * when the name differs, need to check the
4189 * inode too. */
4190 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4191 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4192 char_to_long(b0.b0_ino)))
4193 #endif
4194 differ = TRUE;
4197 else
4200 * The name in the swap file may be
4201 * "~user/path/file". Expand it first.
4203 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4204 #ifdef CHECK_INODE
4205 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4206 char_to_long(b0.b0_ino)))
4207 differ = TRUE;
4208 #else
4209 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4210 differ = TRUE;
4211 #endif
4214 close(fd);
4216 #ifdef RISCOS
4217 else
4218 /* Can't open swap file, though it does exist.
4219 * Assume that the user is editing two files with
4220 * the same name in different directories. No error.
4222 differ = TRUE;
4223 #endif
4225 /* give the ATTENTION message when there is an old swap file
4226 * for the current file, and the buffer was not recovered. */
4227 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4228 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4230 #if defined(HAS_SWAP_EXISTS_ACTION)
4231 int choice = 0;
4232 #endif
4233 #ifdef CREATE_DUMMY_FILE
4234 int did_use_dummy = FALSE;
4236 /* Avoid getting a warning for the file being created
4237 * outside of Vim, it was created at the start of this
4238 * function. Delete the file now, because Vim might exit
4239 * here if the window is closed. */
4240 if (dummyfd != NULL)
4242 fclose(dummyfd);
4243 dummyfd = NULL;
4244 mch_remove(buf->b_fname);
4245 did_use_dummy = TRUE;
4247 #endif
4249 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4250 process_still_running = FALSE;
4251 #endif
4252 #ifdef FEAT_AUTOCMD
4254 * If there is an SwapExists autocommand and we can handle
4255 * the response, trigger it. It may return 0 to ask the
4256 * user anyway.
4258 if (swap_exists_action != SEA_NONE
4259 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4260 choice = do_swapexists(buf, fname);
4262 if (choice == 0)
4263 #endif
4265 #ifdef FEAT_GUI
4266 /* If we are supposed to start the GUI but it wasn't
4267 * completely started yet, start it now. This makes
4268 * the messages displayed in the Vim window when
4269 * loading a session from the .gvimrc file. */
4270 if (gui.starting && !gui.in_use)
4271 gui_start();
4272 #endif
4273 /* Show info about the existing swap file. */
4274 attention_message(buf, fname);
4276 /* We don't want a 'q' typed at the more-prompt
4277 * interrupt loading a file. */
4278 got_int = FALSE;
4281 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4282 if (swap_exists_action != SEA_NONE && choice == 0)
4284 char_u *name;
4286 name = alloc((unsigned)(STRLEN(fname)
4287 + STRLEN(_("Swap file \""))
4288 + STRLEN(_("\" already exists!")) + 5));
4289 if (name != NULL)
4291 STRCPY(name, _("Swap file \""));
4292 home_replace(NULL, fname, name + STRLEN(name),
4293 1000, TRUE);
4294 STRCAT(name, _("\" already exists!"));
4296 choice = do_dialog(VIM_WARNING,
4297 (char_u *)_("VIM - ATTENTION"),
4298 name == NULL
4299 ? (char_u *)_("Swap file already exists!")
4300 : name,
4301 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4302 process_still_running
4303 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4304 # endif
4305 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4307 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4308 if (process_still_running && choice >= 4)
4309 choice++; /* Skip missing "Delete it" button */
4310 # endif
4311 vim_free(name);
4313 /* pretend screen didn't scroll, need redraw anyway */
4314 msg_scrolled = 0;
4315 redraw_all_later(NOT_VALID);
4317 #endif
4319 #if defined(HAS_SWAP_EXISTS_ACTION)
4320 if (choice > 0)
4322 switch (choice)
4324 case 1:
4325 buf->b_p_ro = TRUE;
4326 break;
4327 case 2:
4328 break;
4329 case 3:
4330 swap_exists_action = SEA_RECOVER;
4331 break;
4332 case 4:
4333 mch_remove(fname);
4334 break;
4335 case 5:
4336 swap_exists_action = SEA_QUIT;
4337 break;
4338 case 6:
4339 swap_exists_action = SEA_QUIT;
4340 got_int = TRUE;
4341 break;
4344 /* If the file was deleted this fname can be used. */
4345 if (mch_getperm(fname) < 0)
4346 break;
4348 else
4349 #endif
4351 MSG_PUTS("\n");
4352 if (msg_silent == 0)
4353 /* call wait_return() later */
4354 need_wait_return = TRUE;
4357 #ifdef CREATE_DUMMY_FILE
4358 /* Going to try another name, need the dummy file again. */
4359 if (did_use_dummy)
4360 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4361 #endif
4367 * Change the ".swp" extension to find another file that can be used.
4368 * First decrement the last char: ".swo", ".swn", etc.
4369 * If that still isn't enough decrement the last but one char: ".svz"
4370 * Can happen when editing many "No Name" buffers.
4372 if (fname[n - 1] == 'a') /* ".s?a" */
4374 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4376 EMSG(_("E326: Too many swap files found"));
4377 vim_free(fname);
4378 fname = NULL;
4379 break;
4381 --fname[n - 2]; /* ".svz", ".suz", etc. */
4382 fname[n - 1] = 'z' + 1;
4384 --fname[n - 1]; /* ".swo", ".swn", etc. */
4387 vim_free(dir_name);
4388 #ifdef CREATE_DUMMY_FILE
4389 if (dummyfd != NULL) /* file has been created temporarily */
4391 fclose(dummyfd);
4392 mch_remove(buf->b_fname);
4394 #endif
4395 return fname;
4398 static int
4399 b0_magic_wrong(b0p)
4400 ZERO_BL *b0p;
4402 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4403 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4404 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4405 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4408 #ifdef CHECK_INODE
4410 * Compare current file name with file name from swap file.
4411 * Try to use inode numbers when possible.
4412 * Return non-zero when files are different.
4414 * When comparing file names a few things have to be taken into consideration:
4415 * - When working over a network the full path of a file depends on the host.
4416 * We check the inode number if possible. It is not 100% reliable though,
4417 * because the device number cannot be used over a network.
4418 * - When a file does not exist yet (editing a new file) there is no inode
4419 * number.
4420 * - The file name in a swap file may not be valid on the current host. The
4421 * "~user" form is used whenever possible to avoid this.
4423 * This is getting complicated, let's make a table:
4425 * ino_c ino_s fname_c fname_s differ =
4427 * both files exist -> compare inode numbers:
4428 * != 0 != 0 X X ino_c != ino_s
4430 * inode number(s) unknown, file names available -> compare file names
4431 * == 0 X OK OK fname_c != fname_s
4432 * X == 0 OK OK fname_c != fname_s
4434 * current file doesn't exist, file for swap file exist, file name(s) not
4435 * available -> probably different
4436 * == 0 != 0 FAIL X TRUE
4437 * == 0 != 0 X FAIL TRUE
4439 * current file exists, inode for swap unknown, file name(s) not
4440 * available -> probably different
4441 * != 0 == 0 FAIL X TRUE
4442 * != 0 == 0 X FAIL TRUE
4444 * current file doesn't exist, inode for swap unknown, one file name not
4445 * available -> probably different
4446 * == 0 == 0 FAIL OK TRUE
4447 * == 0 == 0 OK FAIL TRUE
4449 * current file doesn't exist, inode for swap unknown, both file names not
4450 * available -> probably same file
4451 * == 0 == 0 FAIL FAIL FALSE
4453 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4454 * can't be changed without making the block 0 incompatible with 32 bit
4455 * versions.
4458 static int
4459 fnamecmp_ino(fname_c, fname_s, ino_block0)
4460 char_u *fname_c; /* current file name */
4461 char_u *fname_s; /* file name from swap file */
4462 long ino_block0;
4464 struct stat st;
4465 ino_t ino_c = 0; /* ino of current file */
4466 ino_t ino_s; /* ino of file from swap file */
4467 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4468 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4469 int retval_c; /* flag: buf_c valid */
4470 int retval_s; /* flag: buf_s valid */
4472 if (mch_stat((char *)fname_c, &st) == 0)
4473 ino_c = (ino_t)st.st_ino;
4476 * First we try to get the inode from the file name, because the inode in
4477 * the swap file may be outdated. If that fails (e.g. this path is not
4478 * valid on this machine), use the inode from block 0.
4480 if (mch_stat((char *)fname_s, &st) == 0)
4481 ino_s = (ino_t)st.st_ino;
4482 else
4483 ino_s = (ino_t)ino_block0;
4485 if (ino_c && ino_s)
4486 return (ino_c != ino_s);
4489 * One of the inode numbers is unknown, try a forced vim_FullName() and
4490 * compare the file names.
4492 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4493 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4494 if (retval_c == OK && retval_s == OK)
4495 return (STRCMP(buf_c, buf_s) != 0);
4498 * Can't compare inodes or file names, guess that the files are different,
4499 * unless both appear not to exist at all.
4501 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4502 return FALSE;
4503 return TRUE;
4505 #endif /* CHECK_INODE */
4508 * Move a long integer into a four byte character array.
4509 * Used for machine independency in block zero.
4511 static void
4512 long_to_char(n, s)
4513 long n;
4514 char_u *s;
4516 s[0] = (char_u)(n & 0xff);
4517 n = (unsigned)n >> 8;
4518 s[1] = (char_u)(n & 0xff);
4519 n = (unsigned)n >> 8;
4520 s[2] = (char_u)(n & 0xff);
4521 n = (unsigned)n >> 8;
4522 s[3] = (char_u)(n & 0xff);
4525 static long
4526 char_to_long(s)
4527 char_u *s;
4529 long retval;
4531 retval = s[3];
4532 retval <<= 8;
4533 retval |= s[2];
4534 retval <<= 8;
4535 retval |= s[1];
4536 retval <<= 8;
4537 retval |= s[0];
4539 return retval;
4543 * Set the flags in the first block of the swap file:
4544 * - file is modified or not: buf->b_changed
4545 * - 'fileformat'
4546 * - 'fileencoding'
4548 void
4549 ml_setflags(buf)
4550 buf_T *buf;
4552 bhdr_T *hp;
4553 ZERO_BL *b0p;
4555 if (!buf->b_ml.ml_mfp)
4556 return;
4557 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4559 if (hp->bh_bnum == 0)
4561 b0p = (ZERO_BL *)(hp->bh_data);
4562 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4563 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4564 | (get_fileformat(buf) + 1);
4565 #ifdef FEAT_MBYTE
4566 add_b0_fenc(b0p, buf);
4567 #endif
4568 hp->bh_flags |= BH_DIRTY;
4569 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4570 break;
4575 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4577 #define MLCS_MAXL 800 /* max no of lines in chunk */
4578 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4581 * Keep information for finding byte offset of a line, updtytpe may be one of:
4582 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4583 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4584 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4585 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4587 static void
4588 ml_updatechunk(buf, line, len, updtype)
4589 buf_T *buf;
4590 linenr_T line;
4591 long len;
4592 int updtype;
4594 static buf_T *ml_upd_lastbuf = NULL;
4595 static linenr_T ml_upd_lastline;
4596 static linenr_T ml_upd_lastcurline;
4597 static int ml_upd_lastcurix;
4599 linenr_T curline = ml_upd_lastcurline;
4600 int curix = ml_upd_lastcurix;
4601 long size;
4602 chunksize_T *curchnk;
4603 int rest;
4604 bhdr_T *hp;
4605 DATA_BL *dp;
4607 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4608 return;
4609 if (buf->b_ml.ml_chunksize == NULL)
4611 buf->b_ml.ml_chunksize = (chunksize_T *)
4612 alloc((unsigned)sizeof(chunksize_T) * 100);
4613 if (buf->b_ml.ml_chunksize == NULL)
4615 buf->b_ml.ml_usedchunks = -1;
4616 return;
4618 buf->b_ml.ml_numchunks = 100;
4619 buf->b_ml.ml_usedchunks = 1;
4620 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4621 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4624 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4627 * First line in empty buffer from ml_flush_line() -- reset
4629 buf->b_ml.ml_usedchunks = 1;
4630 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4631 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4632 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4633 return;
4637 * Find chunk that our line belongs to, curline will be at start of the
4638 * chunk.
4640 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4641 || updtype != ML_CHNK_ADDLINE)
4643 for (curline = 1, curix = 0;
4644 curix < buf->b_ml.ml_usedchunks - 1
4645 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4646 curix++)
4648 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4651 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4652 && curix < buf->b_ml.ml_usedchunks - 1)
4654 /* Adjust cached curix & curline */
4655 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4656 curix++;
4658 curchnk = buf->b_ml.ml_chunksize + curix;
4660 if (updtype == ML_CHNK_DELLINE)
4661 len = -len;
4662 curchnk->mlcs_totalsize += len;
4663 if (updtype == ML_CHNK_ADDLINE)
4665 curchnk->mlcs_numlines++;
4667 /* May resize here so we don't have to do it in both cases below */
4668 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4670 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4671 buf->b_ml.ml_chunksize = (chunksize_T *)
4672 vim_realloc(buf->b_ml.ml_chunksize,
4673 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4674 if (buf->b_ml.ml_chunksize == NULL)
4676 /* Hmmmm, Give up on offset for this buffer */
4677 buf->b_ml.ml_usedchunks = -1;
4678 return;
4682 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4684 int count; /* number of entries in block */
4685 int idx;
4686 int text_end;
4687 int linecnt;
4689 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4690 buf->b_ml.ml_chunksize + curix,
4691 (buf->b_ml.ml_usedchunks - curix) *
4692 sizeof(chunksize_T));
4693 /* Compute length of first half of lines in the split chunk */
4694 size = 0;
4695 linecnt = 0;
4696 while (curline < buf->b_ml.ml_line_count
4697 && linecnt < MLCS_MINL)
4699 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4701 buf->b_ml.ml_usedchunks = -1;
4702 return;
4704 dp = (DATA_BL *)(hp->bh_data);
4705 count = (long)(buf->b_ml.ml_locked_high) -
4706 (long)(buf->b_ml.ml_locked_low) + 1;
4707 idx = curline - buf->b_ml.ml_locked_low;
4708 curline = buf->b_ml.ml_locked_high + 1;
4709 if (idx == 0)/* first line in block, text at the end */
4710 text_end = dp->db_txt_end;
4711 else
4712 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4713 /* Compute index of last line to use in this MEMLINE */
4714 rest = count - idx;
4715 if (linecnt + rest > MLCS_MINL)
4717 idx += MLCS_MINL - linecnt - 1;
4718 linecnt = MLCS_MINL;
4720 else
4722 idx = count - 1;
4723 linecnt += rest;
4725 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4727 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4728 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4729 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4730 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4731 buf->b_ml.ml_usedchunks++;
4732 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4733 return;
4735 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4736 && curix == buf->b_ml.ml_usedchunks - 1
4737 && buf->b_ml.ml_line_count - line <= 1)
4740 * We are in the last chunk and it is cheap to crate a new one
4741 * after this. Do it now to avoid the loop above later on
4743 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4744 buf->b_ml.ml_usedchunks++;
4745 if (line == buf->b_ml.ml_line_count)
4747 curchnk->mlcs_numlines = 0;
4748 curchnk->mlcs_totalsize = 0;
4750 else
4753 * Line is just prior to last, move count for last
4754 * This is the common case when loading a new file
4756 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4757 if (hp == NULL)
4759 buf->b_ml.ml_usedchunks = -1;
4760 return;
4762 dp = (DATA_BL *)(hp->bh_data);
4763 if (dp->db_line_count == 1)
4764 rest = dp->db_txt_end - dp->db_txt_start;
4765 else
4766 rest =
4767 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4768 - dp->db_txt_start;
4769 curchnk->mlcs_totalsize = rest;
4770 curchnk->mlcs_numlines = 1;
4771 curchnk[-1].mlcs_totalsize -= rest;
4772 curchnk[-1].mlcs_numlines -= 1;
4776 else if (updtype == ML_CHNK_DELLINE)
4778 curchnk->mlcs_numlines--;
4779 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4780 if (curix < (buf->b_ml.ml_usedchunks - 1)
4781 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4782 <= MLCS_MINL)
4784 curix++;
4785 curchnk = buf->b_ml.ml_chunksize + curix;
4787 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4789 buf->b_ml.ml_usedchunks--;
4790 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4791 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4792 return;
4794 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4795 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4796 > MLCS_MINL))
4798 return;
4801 /* Collapse chunks */
4802 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4803 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4804 buf->b_ml.ml_usedchunks--;
4805 if (curix < buf->b_ml.ml_usedchunks)
4807 mch_memmove(buf->b_ml.ml_chunksize + curix,
4808 buf->b_ml.ml_chunksize + curix + 1,
4809 (buf->b_ml.ml_usedchunks - curix) *
4810 sizeof(chunksize_T));
4812 return;
4814 ml_upd_lastbuf = buf;
4815 ml_upd_lastline = line;
4816 ml_upd_lastcurline = curline;
4817 ml_upd_lastcurix = curix;
4821 * Find offset for line or line with offset.
4822 * Find line with offset if "lnum" is 0; return remaining offset in offp
4823 * Find offset of line if "lnum" > 0
4824 * return -1 if information is not available
4826 long
4827 ml_find_line_or_offset(buf, lnum, offp)
4828 buf_T *buf;
4829 linenr_T lnum;
4830 long *offp;
4832 linenr_T curline;
4833 int curix;
4834 long size;
4835 bhdr_T *hp;
4836 DATA_BL *dp;
4837 int count; /* number of entries in block */
4838 int idx;
4839 int start_idx;
4840 int text_end;
4841 long offset;
4842 int len;
4843 int ffdos = (get_fileformat(buf) == EOL_DOS);
4844 int extra = 0;
4846 /* take care of cached line first */
4847 ml_flush_line(curbuf);
4849 if (buf->b_ml.ml_usedchunks == -1
4850 || buf->b_ml.ml_chunksize == NULL
4851 || lnum < 0)
4852 return -1;
4854 if (offp == NULL)
4855 offset = 0;
4856 else
4857 offset = *offp;
4858 if (lnum == 0 && offset <= 0)
4859 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4861 * Find the last chunk before the one containing our line. Last chunk is
4862 * special because it will never qualify
4864 curline = 1;
4865 curix = size = 0;
4866 while (curix < buf->b_ml.ml_usedchunks - 1
4867 && ((lnum != 0
4868 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4869 || (offset != 0
4870 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4871 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4873 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4874 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4875 if (offset && ffdos)
4876 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4877 curix++;
4880 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4882 if (curline > buf->b_ml.ml_line_count
4883 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4884 return -1;
4885 dp = (DATA_BL *)(hp->bh_data);
4886 count = (long)(buf->b_ml.ml_locked_high) -
4887 (long)(buf->b_ml.ml_locked_low) + 1;
4888 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4889 if (idx == 0)/* first line in block, text at the end */
4890 text_end = dp->db_txt_end;
4891 else
4892 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4893 /* Compute index of last line to use in this MEMLINE */
4894 if (lnum != 0)
4896 if (curline + (count - idx) >= lnum)
4897 idx += lnum - curline - 1;
4898 else
4899 idx = count - 1;
4901 else
4903 extra = 0;
4904 while (offset >= size
4905 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4906 + ffdos)
4908 if (ffdos)
4909 size++;
4910 if (idx == count - 1)
4912 extra = 1;
4913 break;
4915 idx++;
4918 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4919 size += len;
4920 if (offset != 0 && size >= offset)
4922 if (size + ffdos == offset)
4923 *offp = 0;
4924 else if (idx == start_idx)
4925 *offp = offset - size + len;
4926 else
4927 *offp = offset - size + len
4928 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4929 curline += idx - start_idx + extra;
4930 if (curline > buf->b_ml.ml_line_count)
4931 return -1; /* exactly one byte beyond the end */
4932 return curline;
4934 curline = buf->b_ml.ml_locked_high + 1;
4937 if (lnum != 0)
4939 /* Count extra CR characters. */
4940 if (ffdos)
4941 size += lnum - 1;
4943 /* Don't count the last line break if 'bin' and 'noeol'. */
4944 if (buf->b_p_bin && !buf->b_p_eol)
4945 size -= ffdos + 1;
4948 return size;
4952 * Goto byte in buffer with offset 'cnt'.
4954 void
4955 goto_byte(cnt)
4956 long cnt;
4958 long boff = cnt;
4959 linenr_T lnum;
4961 ml_flush_line(curbuf); /* cached line may be dirty */
4962 setpcmark();
4963 if (boff)
4964 --boff;
4965 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4966 if (lnum < 1) /* past the end */
4968 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4969 curwin->w_curswant = MAXCOL;
4970 coladvance((colnr_T)MAXCOL);
4972 else
4974 curwin->w_cursor.lnum = lnum;
4975 curwin->w_cursor.col = (colnr_T)boff;
4976 # ifdef FEAT_VIRTUALEDIT
4977 curwin->w_cursor.coladd = 0;
4978 # endif
4979 curwin->w_set_curswant = TRUE;
4981 check_cursor();
4983 # ifdef FEAT_MBYTE
4984 /* Make sure the cursor is on the first byte of a multi-byte char. */
4985 if (has_mbyte)
4986 mb_adjust_cursor();
4987 # endif
4989 #endif