Merge branch 'vim-with-runtime' into feat/quickfix-title
[vim_extended.git] / src / memline.c
blobaff787b0479f88864b46798119ba59403e11838f
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_count = 1;
297 #ifdef FEAT_LINEBREAK
298 curwin->w_nrwidth_line_count = 0;
299 #endif
301 #if defined(MSDOS) && !defined(DJGPP)
302 /* for 16 bit MS-DOS create a swapfile now, because we run out of
303 * memory very quickly */
304 if (p_uc != 0)
305 ml_open_file(buf);
306 #endif
309 * fill block0 struct and write page 0
311 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
312 goto error;
313 if (hp->bh_bnum != 0)
315 EMSG(_("E298: Didn't get block nr 0?"));
316 goto error;
318 b0p = (ZERO_BL *)(hp->bh_data);
320 b0p->b0_id[0] = BLOCK0_ID0;
321 b0p->b0_id[1] = BLOCK0_ID1;
322 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
323 b0p->b0_magic_int = (int)B0_MAGIC_INT;
324 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
325 b0p->b0_magic_char = B0_MAGIC_CHAR;
326 STRNCPY(b0p->b0_version, "VIM ", 4);
327 STRNCPY(b0p->b0_version + 4, Version, 6);
328 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
330 #ifdef FEAT_SPELL
331 if (!buf->b_spell)
332 #endif
334 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
335 b0p->b0_flags = get_fileformat(buf) + 1;
336 set_b0_fname(b0p, buf);
337 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
338 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
339 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
340 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
341 long_to_char(mch_get_pid(), b0p->b0_pid);
345 * Always sync block number 0 to disk, so we can check the file name in
346 * the swap file in findswapname(). Don't do this for help files though
347 * and spell buffer though.
348 * Only works when there's a swapfile, otherwise it's done when the file
349 * is created.
351 mf_put(mfp, hp, TRUE, FALSE);
352 if (!buf->b_help && !B_SPELL(buf))
353 (void)mf_sync(mfp, 0);
356 * Fill in root pointer block and write page 1.
358 if ((hp = ml_new_ptr(mfp)) == NULL)
359 goto error;
360 if (hp->bh_bnum != 1)
362 EMSG(_("E298: Didn't get block nr 1?"));
363 goto error;
365 pp = (PTR_BL *)(hp->bh_data);
366 pp->pb_count = 1;
367 pp->pb_pointer[0].pe_bnum = 2;
368 pp->pb_pointer[0].pe_page_count = 1;
369 pp->pb_pointer[0].pe_old_lnum = 1;
370 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
371 mf_put(mfp, hp, TRUE, FALSE);
374 * Allocate first data block and create an empty line 1.
376 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
377 goto error;
378 if (hp->bh_bnum != 2)
380 EMSG(_("E298: Didn't get block nr 2?"));
381 goto error;
384 dp = (DATA_BL *)(hp->bh_data);
385 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
386 dp->db_free -= 1 + INDEX_SIZE;
387 dp->db_line_count = 1;
388 *((char_u *)dp + dp->db_txt_start) = NUL; /* empty line */
390 return OK;
392 error:
393 if (mfp != NULL)
395 if (hp)
396 mf_put(mfp, hp, FALSE, FALSE);
397 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
399 buf->b_ml.ml_mfp = NULL;
400 return FAIL;
404 * ml_setname() is called when the file name of "buf" has been changed.
405 * It may rename the swap file.
407 void
408 ml_setname(buf)
409 buf_T *buf;
411 int success = FALSE;
412 memfile_T *mfp;
413 char_u *fname;
414 char_u *dirp;
415 #if defined(MSDOS) || defined(MSWIN)
416 char_u *p;
417 #endif
419 mfp = buf->b_ml.ml_mfp;
420 if (mfp->mf_fd < 0) /* there is no swap file yet */
423 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
424 * For help files we will make a swap file now.
426 if (p_uc != 0)
427 ml_open_file(buf); /* create a swap file */
428 return;
432 * Try all directories in the 'directory' option.
434 dirp = p_dir;
435 for (;;)
437 if (*dirp == NUL) /* tried all directories, fail */
438 break;
439 fname = findswapname(buf, &dirp, mfp->mf_fname);
440 /* alloc's fname */
441 if (fname == NULL) /* no file name found for this dir */
442 continue;
444 #if defined(MSDOS) || defined(MSWIN)
446 * Set full pathname for swap file now, because a ":!cd dir" may
447 * change directory without us knowing it.
449 p = FullName_save(fname, FALSE);
450 vim_free(fname);
451 fname = p;
452 if (fname == NULL)
453 continue;
454 #endif
455 /* if the file name is the same we don't have to do anything */
456 if (fnamecmp(fname, mfp->mf_fname) == 0)
458 vim_free(fname);
459 success = TRUE;
460 break;
462 /* need to close the swap file before renaming */
463 if (mfp->mf_fd >= 0)
465 close(mfp->mf_fd);
466 mfp->mf_fd = -1;
469 /* try to rename the swap file */
470 if (vim_rename(mfp->mf_fname, fname) == 0)
472 success = TRUE;
473 vim_free(mfp->mf_fname);
474 mfp->mf_fname = fname;
475 vim_free(mfp->mf_ffname);
476 #if defined(MSDOS) || defined(MSWIN)
477 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
478 #else
479 mf_set_ffname(mfp);
480 #endif
481 ml_upd_block0(buf, FALSE);
482 break;
484 vim_free(fname); /* this fname didn't work, try another */
487 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
489 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
490 if (mfp->mf_fd < 0)
492 /* could not (re)open the swap file, what can we do???? */
493 EMSG(_("E301: Oops, lost the swap file!!!"));
494 return;
496 #ifdef HAVE_FD_CLOEXEC
498 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
499 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
500 fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
502 #endif
504 if (!success)
505 EMSG(_("E302: Could not rename swap file"));
509 * Open a file for the memfile for all buffers that are not readonly or have
510 * been modified.
511 * Used when 'updatecount' changes from zero to non-zero.
513 void
514 ml_open_files()
516 buf_T *buf;
518 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
519 if (!buf->b_p_ro || buf->b_changed)
520 ml_open_file(buf);
524 * Open a swap file for an existing memfile, if there is no swap file yet.
525 * If we are unable to find a file name, mf_fname will be NULL
526 * and the memfile will be in memory only (no recovery possible).
528 void
529 ml_open_file(buf)
530 buf_T *buf;
532 memfile_T *mfp;
533 char_u *fname;
534 char_u *dirp;
536 mfp = buf->b_ml.ml_mfp;
537 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
538 return; /* nothing to do */
540 #ifdef FEAT_SPELL
541 /* For a spell buffer use a temp file name. */
542 if (buf->b_spell)
544 fname = vim_tempname('s');
545 if (fname != NULL)
546 (void)mf_open_file(mfp, fname); /* consumes fname! */
547 buf->b_may_swap = FALSE;
548 return;
550 #endif
553 * Try all directories in 'directory' option.
555 dirp = p_dir;
556 for (;;)
558 if (*dirp == NUL)
559 break;
560 /* There is a small chance that between chosing the swap file name and
561 * creating it, another Vim creates the file. In that case the
562 * creation will fail and we will use another directory. */
563 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
564 if (fname == NULL)
565 continue;
566 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
568 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
570 * set full pathname for swap file now, because a ":!cd dir" may
571 * change directory without us knowing it.
573 mf_fullname(mfp);
574 #endif
575 ml_upd_block0(buf, FALSE);
577 /* Flush block zero, so others can read it */
578 if (mf_sync(mfp, MFS_ZERO) == OK)
580 /* Mark all blocks that should be in the swapfile as dirty.
581 * Needed for when the 'swapfile' option was reset, so that
582 * the swap file was deleted, and then on again. */
583 mf_set_dirty(mfp);
584 break;
586 /* Writing block 0 failed: close the file and try another dir */
587 mf_close_file(buf, FALSE);
591 if (mfp->mf_fname == NULL) /* Failed! */
593 char_u *bname = (char_u *)buf_spname(buf);
594 need_wait_return = TRUE; /* call wait_return later */
595 ++no_wait_return;
596 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
597 bname
598 ? bname
599 : buf->b_fname);
600 vim_free(bname);
601 --no_wait_return;
604 /* don't try to open a swap file again */
605 buf->b_may_swap = FALSE;
609 * If still need to create a swap file, and starting to edit a not-readonly
610 * file, or reading into an existing buffer, create a swap file now.
612 void
613 check_need_swap(newfile)
614 int newfile; /* reading file into new buffer */
616 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
617 ml_open_file(curbuf);
621 * Close memline for buffer 'buf'.
622 * If 'del_file' is TRUE, delete the swap file
624 void
625 ml_close(buf, del_file)
626 buf_T *buf;
627 int del_file;
629 if (buf->b_ml.ml_mfp == NULL) /* not open */
630 return;
631 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
632 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
633 vim_free(buf->b_ml.ml_line_ptr);
634 vim_free(buf->b_ml.ml_stack);
635 #ifdef FEAT_BYTEOFF
636 vim_free(buf->b_ml.ml_chunksize);
637 buf->b_ml.ml_chunksize = NULL;
638 #endif
639 buf->b_ml.ml_mfp = NULL;
641 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
642 * this buffer is loaded. */
643 buf->b_flags &= ~BF_RECOVERED;
647 * Close all existing memlines and memfiles.
648 * Only used when exiting.
649 * When 'del_file' is TRUE, delete the memfiles.
650 * But don't delete files that were ":preserve"d when we are POSIX compatible.
652 void
653 ml_close_all(del_file)
654 int del_file;
656 buf_T *buf;
658 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
659 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
660 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
661 #ifdef TEMPDIRNAMES
662 vim_deltempdir(); /* delete created temp directory */
663 #endif
667 * Close all memfiles for not modified buffers.
668 * Only use just before exiting!
670 void
671 ml_close_notmod()
673 buf_T *buf;
675 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
676 if (!bufIsChanged(buf))
677 ml_close(buf, TRUE); /* close all not-modified buffers */
681 * Update the timestamp in the .swp file.
682 * Used when the file has been written.
684 void
685 ml_timestamp(buf)
686 buf_T *buf;
688 ml_upd_block0(buf, TRUE);
692 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
694 static void
695 ml_upd_block0(buf, set_fname)
696 buf_T *buf;
697 int set_fname;
699 memfile_T *mfp;
700 bhdr_T *hp;
701 ZERO_BL *b0p;
703 mfp = buf->b_ml.ml_mfp;
704 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
705 return;
706 b0p = (ZERO_BL *)(hp->bh_data);
707 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
708 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
709 else
711 if (set_fname)
712 set_b0_fname(b0p, buf);
713 else
714 set_b0_dir_flag(b0p, buf);
716 mf_put(mfp, hp, TRUE, FALSE);
720 * Write file name and timestamp into block 0 of a swap file.
721 * Also set buf->b_mtime.
722 * Don't use NameBuff[]!!!
724 static void
725 set_b0_fname(b0p, buf)
726 ZERO_BL *b0p;
727 buf_T *buf;
729 struct stat st;
731 if (buf->b_ffname == NULL)
732 b0p->b0_fname[0] = NUL;
733 else
735 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
736 /* Systems that cannot translate "~user" back into a path: copy the
737 * file name unmodified. Do use slashes instead of backslashes for
738 * portability. */
739 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
740 # ifdef BACKSLASH_IN_FILENAME
741 forward_slash(b0p->b0_fname);
742 # endif
743 #else
744 size_t flen, ulen;
745 char_u uname[B0_UNAME_SIZE];
748 * For a file under the home directory of the current user, we try to
749 * replace the home directory path with "~user". This helps when
750 * editing the same file on different machines over a network.
751 * First replace home dir path with "~/" with home_replace().
752 * Then insert the user name to get "~user/".
754 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
755 if (b0p->b0_fname[0] == '~')
757 flen = STRLEN(b0p->b0_fname);
758 /* If there is no user name or it is too long, don't use "~/" */
759 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
760 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
761 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
762 else
764 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
765 mch_memmove(b0p->b0_fname + 1, uname, ulen);
768 #endif
769 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
771 long_to_char((long)st.st_mtime, b0p->b0_mtime);
772 #ifdef CHECK_INODE
773 long_to_char((long)st.st_ino, b0p->b0_ino);
774 #endif
775 buf_store_time(buf, &st, buf->b_ffname);
776 buf->b_mtime_read = buf->b_mtime;
778 else
780 long_to_char(0L, b0p->b0_mtime);
781 #ifdef CHECK_INODE
782 long_to_char(0L, b0p->b0_ino);
783 #endif
784 buf->b_mtime = 0;
785 buf->b_mtime_read = 0;
786 buf->b_orig_size = 0;
787 buf->b_orig_mode = 0;
791 #ifdef FEAT_MBYTE
792 /* Also add the 'fileencoding' if there is room. */
793 add_b0_fenc(b0p, curbuf);
794 #endif
798 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
799 * swapfile for "buf" are in the same directory.
800 * This is fail safe: if we are not sure the directories are equal the flag is
801 * not set.
803 static void
804 set_b0_dir_flag(b0p, buf)
805 ZERO_BL *b0p;
806 buf_T *buf;
808 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
809 b0p->b0_flags |= B0_SAME_DIR;
810 else
811 b0p->b0_flags &= ~B0_SAME_DIR;
814 #ifdef FEAT_MBYTE
816 * When there is room, add the 'fileencoding' to block zero.
818 static void
819 add_b0_fenc(b0p, buf)
820 ZERO_BL *b0p;
821 buf_T *buf;
823 int n;
825 n = (int)STRLEN(buf->b_p_fenc);
826 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
827 b0p->b0_flags &= ~B0_HAS_FENC;
828 else
830 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
831 (char *)buf->b_p_fenc, (size_t)n);
832 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
833 b0p->b0_flags |= B0_HAS_FENC;
836 #endif
840 * try to recover curbuf from the .swp file
842 void
843 ml_recover()
845 buf_T *buf = NULL;
846 memfile_T *mfp = NULL;
847 char_u *fname;
848 bhdr_T *hp = NULL;
849 ZERO_BL *b0p;
850 int b0_ff;
851 char_u *b0_fenc = NULL;
852 PTR_BL *pp;
853 DATA_BL *dp;
854 infoptr_T *ip;
855 blocknr_T bnum;
856 int page_count;
857 struct stat org_stat, swp_stat;
858 int len;
859 int directly;
860 linenr_T lnum;
861 char_u *p;
862 int i;
863 long error;
864 int cannot_open;
865 linenr_T line_count;
866 int has_error;
867 int idx;
868 int top;
869 int txt_start;
870 off_t size;
871 int called_from_main;
872 int serious_error = TRUE;
873 long mtime;
874 int attr;
875 char_u *bname;
877 recoverymode = TRUE;
878 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
879 attr = hl_attr(HLF_E);
882 * If the file name ends in ".s[uvw][a-z]" we assume this is the swap file.
883 * Otherwise a search is done to find the swap file(s).
885 fname = curbuf->b_fname;
886 if (fname == NULL) /* When there is no file name */
887 fname = (char_u *)"";
888 len = (int)STRLEN(fname);
889 if (len >= 4 &&
890 #if defined(VMS) || defined(RISCOS)
891 STRNICMP(fname + len - 4, "_s" , 2)
892 #else
893 STRNICMP(fname + len - 4, ".s" , 2)
894 #endif
895 == 0
896 && vim_strchr((char_u *)"UVWuvw", fname[len - 2]) != NULL
897 && ASCII_ISALPHA(fname[len - 1]))
899 directly = TRUE;
900 fname = vim_strsave(fname); /* make a copy for mf_open() */
902 else
904 directly = FALSE;
906 /* count the number of matching swap files */
907 len = recover_names(&fname, FALSE, 0);
908 if (len == 0) /* no swap files found */
910 EMSG2(_("E305: No swap file found for %s"), fname);
911 goto theend;
913 if (len == 1) /* one swap file found, use it */
914 i = 1;
915 else /* several swap files found, choose */
917 /* list the names of the swap files */
918 (void)recover_names(&fname, TRUE, 0);
919 msg_putchar('\n');
920 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
921 i = get_number(FALSE, NULL);
922 if (i < 1 || i > len)
923 goto theend;
925 /* get the swap file name that will be used */
926 (void)recover_names(&fname, FALSE, i);
928 if (fname == NULL)
929 goto theend; /* out of memory */
931 /* When called from main() still need to initialize storage structure */
932 if (called_from_main && ml_open(curbuf) == FAIL)
933 getout(1);
936 * allocate a buffer structure (only the memline in it is really used)
938 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
939 if (buf == NULL)
941 vim_free(fname);
942 goto theend;
946 * init fields in memline struct
948 buf->b_ml.ml_stack_size = 0; /* no stack yet */
949 buf->b_ml.ml_stack = NULL; /* no stack yet */
950 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
951 buf->b_ml.ml_line_lnum = 0; /* no cached line */
952 buf->b_ml.ml_locked = NULL; /* no locked block */
953 buf->b_ml.ml_flags = 0;
956 * open the memfile from the old swap file
958 p = vim_strsave(fname); /* save fname for the message
959 (mf_open() may free fname) */
960 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
961 if (mfp == NULL || mfp->mf_fd < 0)
963 if (p != NULL)
965 EMSG2(_("E306: Cannot open %s"), p);
966 vim_free(p);
968 goto theend;
970 vim_free(p);
971 buf->b_ml.ml_mfp = mfp;
974 * The page size set in mf_open() might be different from the page size
975 * used in the swap file, we must get it from block 0. But to read block
976 * 0 we need a page size. Use the minimal size for block 0 here, it will
977 * be set to the real value below.
979 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
982 * try to read block 0
984 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
986 msg_start();
987 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
988 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
989 MSG_PUTS_ATTR(
990 _("\nMaybe no changes were made or Vim did not update the swap file."),
991 attr | MSG_HIST);
992 msg_end();
993 goto theend;
995 b0p = (ZERO_BL *)(hp->bh_data);
996 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
998 msg_start();
999 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
1000 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1001 MSG_HIST);
1002 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
1003 msg_end();
1004 goto theend;
1006 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
1008 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
1009 goto theend;
1011 if (b0_magic_wrong(b0p))
1013 msg_start();
1014 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1015 #if defined(MSDOS) || defined(MSWIN)
1016 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1017 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1018 attr | MSG_HIST);
1019 else
1020 #endif
1021 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1022 attr | MSG_HIST);
1023 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1024 /* avoid going past the end of a currupted hostname */
1025 b0p->b0_fname[0] = NUL;
1026 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1027 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1028 msg_end();
1029 goto theend;
1033 * If we guessed the wrong page size, we have to recalculate the
1034 * highest block number in the file.
1036 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1038 unsigned previous_page_size = mfp->mf_page_size;
1040 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1041 if (mfp->mf_page_size < previous_page_size)
1043 msg_start();
1044 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1045 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1046 attr | MSG_HIST);
1047 msg_end();
1048 goto theend;
1050 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1051 mfp->mf_blocknr_max = 0; /* no file or empty file */
1052 else
1053 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1054 mfp->mf_infile_count = mfp->mf_blocknr_max;
1056 /* need to reallocate the memory used to store the data */
1057 p = alloc(mfp->mf_page_size);
1058 if (p == NULL)
1059 goto theend;
1060 mch_memmove(p, hp->bh_data, previous_page_size);
1061 vim_free(hp->bh_data);
1062 hp->bh_data = p;
1063 b0p = (ZERO_BL *)(hp->bh_data);
1067 * If .swp file name given directly, use name from swap file for buffer.
1069 if (directly)
1071 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1072 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1073 goto theend;
1076 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1077 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1079 if ((bname = (char_u *)buf_spname(curbuf)) != NULL)
1081 vim_strncpy(NameBuff, bname, MAXPATHL - 1);
1082 vim_free(bname);
1084 else
1085 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1086 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1087 msg_putchar('\n');
1090 * check date of swap file and original file
1092 mtime = char_to_long(b0p->b0_mtime);
1093 if (curbuf->b_ffname != NULL
1094 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1095 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1096 && org_stat.st_mtime > swp_stat.st_mtime)
1097 || org_stat.st_mtime != mtime))
1099 EMSG(_("E308: Warning: Original file may have been changed"));
1101 out_flush();
1103 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1104 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1105 if (b0p->b0_flags & B0_HAS_FENC)
1107 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1108 p > b0p->b0_fname && p[-1] != NUL; --p)
1110 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1113 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1114 hp = NULL;
1117 * Now that we are sure that the file is going to be recovered, clear the
1118 * contents of the current buffer.
1120 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1121 ml_delete((linenr_T)1, FALSE);
1124 * Try reading the original file to obtain the values of 'fileformat',
1125 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1127 if (curbuf->b_ffname != NULL)
1129 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1130 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1131 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1132 ml_delete((linenr_T)1, FALSE);
1135 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1136 if (b0_ff != 0)
1137 set_fileformat(b0_ff - 1, OPT_LOCAL);
1138 if (b0_fenc != NULL)
1140 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1141 vim_free(b0_fenc);
1143 unchanged(curbuf, TRUE);
1145 bnum = 1; /* start with block 1 */
1146 page_count = 1; /* which is 1 page */
1147 lnum = 0; /* append after line 0 in curbuf */
1148 line_count = 0;
1149 idx = 0; /* start with first index in block 1 */
1150 error = 0;
1151 buf->b_ml.ml_stack_top = 0;
1152 buf->b_ml.ml_stack = NULL;
1153 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1155 if (curbuf->b_ffname == NULL)
1156 cannot_open = TRUE;
1157 else
1158 cannot_open = FALSE;
1160 serious_error = FALSE;
1161 for ( ; !got_int; line_breakcheck())
1163 if (hp != NULL)
1164 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1167 * get block
1169 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1171 if (bnum == 1)
1173 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1174 goto theend;
1176 ++error;
1177 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1178 (colnr_T)0, TRUE);
1180 else /* there is a block */
1182 pp = (PTR_BL *)(hp->bh_data);
1183 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1185 /* check line count when using pointer block first time */
1186 if (idx == 0 && line_count != 0)
1188 for (i = 0; i < (int)pp->pb_count; ++i)
1189 line_count -= pp->pb_pointer[i].pe_line_count;
1190 if (line_count != 0)
1192 ++error;
1193 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1194 (colnr_T)0, TRUE);
1198 if (pp->pb_count == 0)
1200 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1201 (colnr_T)0, TRUE);
1202 ++error;
1204 else if (idx < (int)pp->pb_count) /* go a block deeper */
1206 if (pp->pb_pointer[idx].pe_bnum < 0)
1209 * Data block with negative block number.
1210 * Try to read lines from the original file.
1211 * This is slow, but it works.
1213 if (!cannot_open)
1215 line_count = pp->pb_pointer[idx].pe_line_count;
1216 if (readfile(curbuf->b_ffname, NULL, lnum,
1217 pp->pb_pointer[idx].pe_old_lnum - 1,
1218 line_count, NULL, 0) == FAIL)
1219 cannot_open = TRUE;
1220 else
1221 lnum += line_count;
1223 if (cannot_open)
1225 ++error;
1226 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1227 (colnr_T)0, TRUE);
1229 ++idx; /* get same block again for next index */
1230 continue;
1234 * going one block deeper in the tree
1236 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1238 ++error;
1239 break; /* out of memory */
1241 ip = &(buf->b_ml.ml_stack[top]);
1242 ip->ip_bnum = bnum;
1243 ip->ip_index = idx;
1245 bnum = pp->pb_pointer[idx].pe_bnum;
1246 line_count = pp->pb_pointer[idx].pe_line_count;
1247 page_count = pp->pb_pointer[idx].pe_page_count;
1248 continue;
1251 else /* not a pointer block */
1253 dp = (DATA_BL *)(hp->bh_data);
1254 if (dp->db_id != DATA_ID) /* block id wrong */
1256 if (bnum == 1)
1258 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1259 mfp->mf_fname);
1260 goto theend;
1262 ++error;
1263 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1264 (colnr_T)0, TRUE);
1266 else
1269 * it is a data block
1270 * Append all the lines in this block
1272 has_error = FALSE;
1274 * check length of block
1275 * if wrong, use length in pointer block
1277 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1279 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1280 (colnr_T)0, TRUE);
1281 ++error;
1282 has_error = TRUE;
1283 dp->db_txt_end = page_count * mfp->mf_page_size;
1286 /* make sure there is a NUL at the end of the block */
1287 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1290 * check number of lines in block
1291 * if wrong, use count in data block
1293 if (line_count != dp->db_line_count)
1295 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1296 (colnr_T)0, TRUE);
1297 ++error;
1298 has_error = TRUE;
1301 for (i = 0; i < dp->db_line_count; ++i)
1303 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1304 if (txt_start <= (int)HEADER_SIZE
1305 || txt_start >= (int)dp->db_txt_end)
1307 p = (char_u *)"???";
1308 ++error;
1310 else
1311 p = (char_u *)dp + txt_start;
1312 ml_append(lnum++, p, (colnr_T)0, TRUE);
1314 if (has_error)
1315 ml_append(lnum++, (char_u *)_("???END"),
1316 (colnr_T)0, TRUE);
1321 if (buf->b_ml.ml_stack_top == 0) /* finished */
1322 break;
1325 * go one block up in the tree
1327 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1328 bnum = ip->ip_bnum;
1329 idx = ip->ip_index + 1; /* go to next index */
1330 page_count = 1;
1334 * The dummy line from the empty buffer will now be after the last line in
1335 * the buffer. Delete it.
1337 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1338 curbuf->b_flags |= BF_RECOVERED;
1340 recoverymode = FALSE;
1341 if (got_int)
1342 EMSG(_("E311: Recovery Interrupted"));
1343 else if (error)
1345 ++no_wait_return;
1346 MSG(">>>>>>>>>>>>>");
1347 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1348 --no_wait_return;
1349 MSG(_("See \":help E312\" for more information."));
1350 MSG(">>>>>>>>>>>>>");
1352 else
1354 MSG(_("Recovery completed. You should check if everything is OK."));
1355 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1356 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1357 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1358 cmdline_row = msg_row;
1360 redraw_curbuf_later(NOT_VALID);
1362 theend:
1363 recoverymode = FALSE;
1364 if (mfp != NULL)
1366 if (hp != NULL)
1367 mf_put(mfp, hp, FALSE, FALSE);
1368 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1370 if (buf != NULL)
1372 vim_free(buf->b_ml.ml_stack);
1373 vim_free(buf);
1375 if (serious_error && called_from_main)
1376 ml_close(curbuf, TRUE);
1377 #ifdef FEAT_AUTOCMD
1378 else
1380 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1381 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1383 #endif
1384 return;
1388 * Find the names of swap files in current directory and the directory given
1389 * with the 'directory' option.
1391 * Used to:
1392 * - list the swap files for "vim -r"
1393 * - count the number of swap files when recovering
1394 * - list the swap files when recovering
1395 * - find the name of the n'th swap file when recovering
1398 recover_names(fname, list, nr)
1399 char_u **fname; /* base for swap file name */
1400 int list; /* when TRUE, list the swap file names */
1401 int nr; /* when non-zero, return nr'th swap file name */
1403 int num_names;
1404 char_u *(names[6]);
1405 char_u *tail;
1406 char_u *p;
1407 int num_files;
1408 int file_count = 0;
1409 char_u **files;
1410 int i;
1411 char_u *dirp;
1412 char_u *dir_name;
1413 char_u *fname_res = *fname;
1414 #ifdef HAVE_READLINK
1415 char_u fname_buf[MAXPATHL];
1417 /* Expand symlink in the file name, because the swap file is created with
1418 * the actual file instead of with the symlink. */
1419 if (resolve_symlink(*fname, fname_buf) == OK)
1420 fname_res = fname_buf;
1421 #endif
1423 if (list)
1425 /* use msg() to start the scrolling properly */
1426 msg((char_u *)_("Swap files found:"));
1427 msg_putchar('\n');
1431 * Do the loop for every directory in 'directory'.
1432 * First allocate some memory to put the directory name in.
1434 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1435 dirp = p_dir;
1436 while (dir_name != NULL && *dirp)
1439 * Isolate a directory name from *dirp and put it in dir_name (we know
1440 * it is large enough, so use 31000 for length).
1441 * Advance dirp to next directory name.
1443 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1445 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1447 if (fname == NULL || *fname == NULL)
1449 #ifdef VMS
1450 names[0] = vim_strsave((char_u *)"*_sw%");
1451 #else
1452 # ifdef RISCOS
1453 names[0] = vim_strsave((char_u *)"*_sw#");
1454 # else
1455 names[0] = vim_strsave((char_u *)"*.sw?");
1456 # endif
1457 #endif
1458 #if defined(UNIX) || defined(WIN3264)
1459 /* For Unix names starting with a dot are special. MS-Windows
1460 * supports this too, on some file systems. */
1461 names[1] = vim_strsave((char_u *)".*.sw?");
1462 names[2] = vim_strsave((char_u *)".sw?");
1463 num_names = 3;
1464 #else
1465 # ifdef VMS
1466 names[1] = vim_strsave((char_u *)".*_sw%");
1467 num_names = 2;
1468 # else
1469 num_names = 1;
1470 # endif
1471 #endif
1473 else
1474 num_names = recov_file_names(names, fname_res, TRUE);
1476 else /* check directory dir_name */
1478 if (fname == NULL || *fname == NULL)
1480 #ifdef VMS
1481 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1482 #else
1483 # ifdef RISCOS
1484 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1485 # else
1486 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1487 # endif
1488 #endif
1489 #if defined(UNIX) || defined(WIN3264)
1490 /* For Unix names starting with a dot are special. MS-Windows
1491 * supports this too, on some file systems. */
1492 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1493 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1494 num_names = 3;
1495 #else
1496 # ifdef VMS
1497 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1498 num_names = 2;
1499 # else
1500 num_names = 1;
1501 # endif
1502 #endif
1504 else
1506 #if defined(UNIX) || defined(WIN3264)
1507 p = dir_name + STRLEN(dir_name);
1508 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1510 /* Ends with '//', Use Full path for swap name */
1511 tail = make_percent_swname(dir_name, fname_res);
1513 else
1514 #endif
1516 tail = gettail(fname_res);
1517 tail = concat_fnames(dir_name, tail, TRUE);
1519 if (tail == NULL)
1520 num_names = 0;
1521 else
1523 num_names = recov_file_names(names, tail, FALSE);
1524 vim_free(tail);
1529 /* check for out-of-memory */
1530 for (i = 0; i < num_names; ++i)
1532 if (names[i] == NULL)
1534 for (i = 0; i < num_names; ++i)
1535 vim_free(names[i]);
1536 num_names = 0;
1539 if (num_names == 0)
1540 num_files = 0;
1541 else if (expand_wildcards(num_names, names, &num_files, &files,
1542 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1543 num_files = 0;
1546 * When no swap file found, wildcard expansion might have failed (e.g.
1547 * not able to execute the shell).
1548 * Try finding a swap file by simply adding ".swp" to the file name.
1550 if (*dirp == NUL && file_count + num_files == 0
1551 && fname != NULL && *fname != NULL)
1553 struct stat st;
1554 char_u *swapname;
1556 swapname = modname(fname_res,
1557 #if defined(VMS) || defined(RISCOS)
1558 (char_u *)"_swp", FALSE
1559 #else
1560 (char_u *)".swp", TRUE
1561 #endif
1563 if (swapname != NULL)
1565 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1567 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1568 if (files != NULL)
1570 files[0] = swapname;
1571 swapname = NULL;
1572 num_files = 1;
1575 vim_free(swapname);
1580 * remove swapfile name of the current buffer, it must be ignored
1582 if (curbuf->b_ml.ml_mfp != NULL
1583 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1585 for (i = 0; i < num_files; ++i)
1586 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1588 /* Remove the name from files[i]. Move further entries
1589 * down. When the array becomes empty free it here, since
1590 * FreeWild() won't be called below. */
1591 vim_free(files[i]);
1592 if (--num_files == 0)
1593 vim_free(files);
1594 else
1595 for ( ; i < num_files; ++i)
1596 files[i] = files[i + 1];
1599 if (nr > 0)
1601 file_count += num_files;
1602 if (nr <= file_count)
1604 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1605 dirp = (char_u *)""; /* stop searching */
1608 else if (list)
1610 if (dir_name[0] == '.' && dir_name[1] == NUL)
1612 if (fname == NULL || *fname == NULL)
1613 MSG_PUTS(_(" In current directory:\n"));
1614 else
1615 MSG_PUTS(_(" Using specified name:\n"));
1617 else
1619 MSG_PUTS(_(" In directory "));
1620 msg_home_replace(dir_name);
1621 MSG_PUTS(":\n");
1624 if (num_files)
1626 for (i = 0; i < num_files; ++i)
1628 /* print the swap file name */
1629 msg_outnum((long)++file_count);
1630 MSG_PUTS(". ");
1631 msg_puts(gettail(files[i]));
1632 msg_putchar('\n');
1633 (void)swapfile_info(files[i]);
1636 else
1637 MSG_PUTS(_(" -- none --\n"));
1638 out_flush();
1640 else
1641 file_count += num_files;
1643 for (i = 0; i < num_names; ++i)
1644 vim_free(names[i]);
1645 if (num_files > 0)
1646 FreeWild(num_files, files);
1648 vim_free(dir_name);
1649 return file_count;
1652 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1654 * Append the full path to name with path separators made into percent
1655 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1657 static char_u *
1658 make_percent_swname(dir, name)
1659 char_u *dir;
1660 char_u *name;
1662 char_u *d, *s, *f;
1664 f = fix_fname(name != NULL ? name : (char_u *) "");
1665 d = NULL;
1666 if (f != NULL)
1668 s = alloc((unsigned)(STRLEN(f) + 1));
1669 if (s != NULL)
1671 STRCPY(s, f);
1672 for (d = s; *d != NUL; mb_ptr_adv(d))
1673 if (vim_ispathsep(*d))
1674 *d = '%';
1675 d = concat_fnames(dir, s, TRUE);
1676 vim_free(s);
1678 vim_free(f);
1680 return d;
1682 #endif
1684 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1685 static int process_still_running;
1686 #endif
1689 * Give information about an existing swap file.
1690 * Returns timestamp (0 when unknown).
1692 static time_t
1693 swapfile_info(fname)
1694 char_u *fname;
1696 struct stat st;
1697 int fd;
1698 struct block0 b0;
1699 time_t x = (time_t)0;
1700 char *p;
1701 #ifdef UNIX
1702 char_u uname[B0_UNAME_SIZE];
1703 #endif
1705 /* print the swap file date */
1706 if (mch_stat((char *)fname, &st) != -1)
1708 #ifdef UNIX
1709 /* print name of owner of the file */
1710 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1712 MSG_PUTS(_(" owned by: "));
1713 msg_outtrans(uname);
1714 MSG_PUTS(_(" dated: "));
1716 else
1717 #endif
1718 MSG_PUTS(_(" dated: "));
1719 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1720 p = ctime(&x); /* includes '\n' */
1721 if (p == NULL)
1722 MSG_PUTS("(invalid)\n");
1723 else
1724 MSG_PUTS(p);
1728 * print the original file name
1730 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1731 if (fd >= 0)
1733 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1735 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1737 MSG_PUTS(_(" [from Vim version 3.0]"));
1739 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1741 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1743 else
1745 MSG_PUTS(_(" file name: "));
1746 if (b0.b0_fname[0] == NUL)
1747 MSG_PUTS(_("[No Name]"));
1748 else
1749 msg_outtrans(b0.b0_fname);
1751 MSG_PUTS(_("\n modified: "));
1752 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1754 if (*(b0.b0_uname) != NUL)
1756 MSG_PUTS(_("\n user name: "));
1757 msg_outtrans(b0.b0_uname);
1760 if (*(b0.b0_hname) != NUL)
1762 if (*(b0.b0_uname) != NUL)
1763 MSG_PUTS(_(" host name: "));
1764 else
1765 MSG_PUTS(_("\n host name: "));
1766 msg_outtrans(b0.b0_hname);
1769 if (char_to_long(b0.b0_pid) != 0L)
1771 MSG_PUTS(_("\n process ID: "));
1772 msg_outnum(char_to_long(b0.b0_pid));
1773 #if defined(UNIX) || defined(__EMX__)
1774 /* EMX kill() not working correctly, it seems */
1775 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1777 MSG_PUTS(_(" (still running)"));
1778 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1779 process_still_running = TRUE;
1780 # endif
1782 #endif
1785 if (b0_magic_wrong(&b0))
1787 #if defined(MSDOS) || defined(MSWIN)
1788 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1789 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1790 else
1791 #endif
1792 MSG_PUTS(_("\n [not usable on this computer]"));
1796 else
1797 MSG_PUTS(_(" [cannot be read]"));
1798 close(fd);
1800 else
1801 MSG_PUTS(_(" [cannot be opened]"));
1802 msg_putchar('\n');
1804 return x;
1807 static int
1808 recov_file_names(names, path, prepend_dot)
1809 char_u **names;
1810 char_u *path;
1811 int prepend_dot;
1813 int num_names;
1815 #ifdef SHORT_FNAME
1817 * (MS-DOS) always short names
1819 names[0] = modname(path, (char_u *)".sw?", FALSE);
1820 num_names = 1;
1821 #else /* !SHORT_FNAME */
1823 * (Win32 and Win64) never short names, but do prepend a dot.
1824 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1825 * Only use the short name if it is different.
1827 char_u *p;
1828 int i;
1829 # ifndef WIN3264
1830 int shortname = curbuf->b_shortname;
1832 curbuf->b_shortname = FALSE;
1833 # endif
1835 num_names = 0;
1838 * May also add the file name with a dot prepended, for swap file in same
1839 * dir as original file.
1841 if (prepend_dot)
1843 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1844 if (names[num_names] == NULL)
1845 goto end;
1846 ++num_names;
1850 * Form the normal swap file name pattern by appending ".sw?".
1852 #ifdef VMS
1853 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1854 #else
1855 # ifdef RISCOS
1856 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1857 # else
1858 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1859 # endif
1860 #endif
1861 if (names[num_names] == NULL)
1862 goto end;
1863 if (num_names >= 1) /* check if we have the same name twice */
1865 p = names[num_names - 1];
1866 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1867 if (i > 0)
1868 p += i; /* file name has been expanded to full path */
1870 if (STRCMP(p, names[num_names]) != 0)
1871 ++num_names;
1872 else
1873 vim_free(names[num_names]);
1875 else
1876 ++num_names;
1878 # ifndef WIN3264
1880 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1882 curbuf->b_shortname = TRUE;
1883 #ifdef VMS
1884 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1885 #else
1886 # ifdef RISCOS
1887 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1888 # else
1889 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1890 # endif
1891 #endif
1892 if (names[num_names] == NULL)
1893 goto end;
1896 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1898 p = names[num_names];
1899 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1900 if (i > 0)
1901 p += i; /* file name has been expanded to full path */
1902 if (STRCMP(names[num_names - 1], p) == 0)
1903 vim_free(names[num_names]);
1904 else
1905 ++num_names;
1906 # endif
1908 end:
1909 # ifndef WIN3264
1910 curbuf->b_shortname = shortname;
1911 # endif
1913 #endif /* !SHORT_FNAME */
1915 return num_names;
1919 * sync all memlines
1921 * If 'check_file' is TRUE, check if original file exists and was not changed.
1922 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1923 * always sync at least one block.
1925 void
1926 ml_sync_all(check_file, check_char)
1927 int check_file;
1928 int check_char;
1930 buf_T *buf;
1931 struct stat st;
1933 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1935 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1936 continue; /* no file */
1938 ml_flush_line(buf); /* flush buffered line */
1939 /* flush locked block */
1940 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1941 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1942 && buf->b_ffname != NULL)
1945 * If the original file does not exist anymore or has been changed
1946 * call ml_preserve() to get rid of all negative numbered blocks.
1948 if (mch_stat((char *)buf->b_ffname, &st) == -1
1949 || st.st_mtime != buf->b_mtime_read
1950 || (size_t)st.st_size != buf->b_orig_size)
1952 ml_preserve(buf, FALSE);
1953 did_check_timestamps = FALSE;
1954 need_check_timestamps = TRUE; /* give message later */
1957 if (buf->b_ml.ml_mfp->mf_dirty)
1959 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1960 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1961 if (check_char && ui_char_avail()) /* character available now */
1962 break;
1968 * sync one buffer, including negative blocks
1970 * after this all the blocks are in the swap file
1972 * Used for the :preserve command and when the original file has been
1973 * changed or deleted.
1975 * when message is TRUE the success of preserving is reported
1977 void
1978 ml_preserve(buf, message)
1979 buf_T *buf;
1980 int message;
1982 bhdr_T *hp;
1983 linenr_T lnum;
1984 memfile_T *mfp = buf->b_ml.ml_mfp;
1985 int status;
1986 int got_int_save = got_int;
1988 if (mfp == NULL || mfp->mf_fname == NULL)
1990 if (message)
1991 EMSG(_("E313: Cannot preserve, there is no swap file"));
1992 return;
1995 /* We only want to stop when interrupted here, not when interrupted
1996 * before. */
1997 got_int = FALSE;
1999 ml_flush_line(buf); /* flush buffered line */
2000 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2001 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2003 /* stack is invalid after mf_sync(.., MFS_ALL) */
2004 buf->b_ml.ml_stack_top = 0;
2007 * Some of the data blocks may have been changed from negative to
2008 * positive block number. In that case the pointer blocks need to be
2009 * updated.
2011 * We don't know in which pointer block the references are, so we visit
2012 * all data blocks until there are no more translations to be done (or
2013 * we hit the end of the file, which can only happen in case a write fails,
2014 * e.g. when file system if full).
2015 * ml_find_line() does the work by translating the negative block numbers
2016 * when getting the first line of each data block.
2018 if (mf_need_trans(mfp) && !got_int)
2020 lnum = 1;
2021 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2023 hp = ml_find_line(buf, lnum, ML_FIND);
2024 if (hp == NULL)
2026 status = FAIL;
2027 goto theend;
2029 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2030 lnum = buf->b_ml.ml_locked_high + 1;
2032 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2033 /* sync the updated pointer blocks */
2034 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2035 status = FAIL;
2036 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2038 theend:
2039 got_int |= got_int_save;
2041 if (message)
2043 if (status == OK)
2044 MSG(_("File preserved"));
2045 else
2046 EMSG(_("E314: Preserve failed"));
2051 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2052 * until the next call!
2053 * line1 = ml_get(1);
2054 * line2 = ml_get(2); // line1 is now invalid!
2055 * Make a copy of the line if necessary.
2058 * get a pointer to a (read-only copy of a) line
2060 * On failure an error message is given and IObuff is returned (to avoid
2061 * having to check for error everywhere).
2063 char_u *
2064 ml_get(lnum)
2065 linenr_T lnum;
2067 return ml_get_buf(curbuf, lnum, FALSE);
2071 * ml_get_pos: get pointer to position 'pos'
2073 char_u *
2074 ml_get_pos(pos)
2075 pos_T *pos;
2077 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2081 * ml_get_curline: get pointer to cursor line.
2083 char_u *
2084 ml_get_curline()
2086 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2090 * ml_get_cursor: get pointer to cursor position
2092 char_u *
2093 ml_get_cursor()
2095 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2096 curwin->w_cursor.col);
2100 * get a pointer to a line in a specific buffer
2102 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2103 * changed)
2105 char_u *
2106 ml_get_buf(buf, lnum, will_change)
2107 buf_T *buf;
2108 linenr_T lnum;
2109 int will_change; /* line will be changed */
2111 bhdr_T *hp;
2112 DATA_BL *dp;
2113 char_u *ptr;
2114 static int recursive = 0;
2116 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2118 if (recursive == 0)
2120 /* Avoid giving this message for a recursive call, may happen when
2121 * the GUI redraws part of the text. */
2122 ++recursive;
2123 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2124 --recursive;
2126 errorret:
2127 STRCPY(IObuff, "???");
2128 return IObuff;
2130 if (lnum <= 0) /* pretend line 0 is line 1 */
2131 lnum = 1;
2133 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2134 return (char_u *)"";
2137 * See if it is the same line as requested last time.
2138 * Otherwise may need to flush last used line.
2139 * Don't use the last used line when 'swapfile' is reset, need to load all
2140 * blocks.
2142 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2144 ml_flush_line(buf);
2147 * Find the data block containing the line.
2148 * This also fills the stack with the blocks from the root to the data
2149 * block and releases any locked block.
2151 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2153 if (recursive == 0)
2155 /* Avoid giving this message for a recursive call, may happen
2156 * when the GUI redraws part of the text. */
2157 ++recursive;
2158 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2159 --recursive;
2161 goto errorret;
2164 dp = (DATA_BL *)(hp->bh_data);
2166 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2167 buf->b_ml.ml_line_ptr = ptr;
2168 buf->b_ml.ml_line_lnum = lnum;
2169 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2171 if (will_change)
2172 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2174 return buf->b_ml.ml_line_ptr;
2178 * Check if a line that was just obtained by a call to ml_get
2179 * is in allocated memory.
2182 ml_line_alloced()
2184 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2188 * Append a line after lnum (may be 0 to insert a line in front of the file).
2189 * "line" does not need to be allocated, but can't be another line in a
2190 * buffer, unlocking may make it invalid.
2192 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2193 * will be set for recovery
2194 * Check: The caller of this function should probably also call
2195 * appended_lines().
2197 * return FAIL for failure, OK otherwise
2200 ml_append(lnum, line, len, newfile)
2201 linenr_T lnum; /* append after this line (can be 0) */
2202 char_u *line; /* text of the new line */
2203 colnr_T len; /* length of new line, including NUL, or 0 */
2204 int newfile; /* flag, see above */
2206 /* When starting up, we might still need to create the memfile */
2207 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2208 return FAIL;
2210 if (curbuf->b_ml.ml_line_lnum != 0)
2211 ml_flush_line(curbuf);
2212 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2215 #if defined(FEAT_SPELL) || defined(PROTO)
2217 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2218 * a memline.
2221 ml_append_buf(buf, lnum, line, len, newfile)
2222 buf_T *buf;
2223 linenr_T lnum; /* append after this line (can be 0) */
2224 char_u *line; /* text of the new line */
2225 colnr_T len; /* length of new line, including NUL, or 0 */
2226 int newfile; /* flag, see above */
2228 if (buf->b_ml.ml_mfp == NULL)
2229 return FAIL;
2231 if (buf->b_ml.ml_line_lnum != 0)
2232 ml_flush_line(buf);
2233 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2235 #endif
2237 static int
2238 ml_append_int(buf, lnum, line, len, newfile, mark)
2239 buf_T *buf;
2240 linenr_T lnum; /* append after this line (can be 0) */
2241 char_u *line; /* text of the new line */
2242 colnr_T len; /* length of line, including NUL, or 0 */
2243 int newfile; /* flag, see above */
2244 int mark; /* mark the new line */
2246 int i;
2247 int line_count; /* number of indexes in current block */
2248 int offset;
2249 int from, to;
2250 int space_needed; /* space needed for new line */
2251 int page_size;
2252 int page_count;
2253 int db_idx; /* index for lnum in data block */
2254 bhdr_T *hp;
2255 memfile_T *mfp;
2256 DATA_BL *dp;
2257 PTR_BL *pp;
2258 infoptr_T *ip;
2260 /* lnum out of range */
2261 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2262 return FAIL;
2264 if (lowest_marked && lowest_marked > lnum)
2265 lowest_marked = lnum + 1;
2267 if (len == 0)
2268 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2269 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2271 mfp = buf->b_ml.ml_mfp;
2272 page_size = mfp->mf_page_size;
2275 * find the data block containing the previous line
2276 * This also fills the stack with the blocks from the root to the data block
2277 * This also releases any locked block.
2279 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2280 ML_INSERT)) == NULL)
2281 return FAIL;
2283 buf->b_ml.ml_flags &= ~ML_EMPTY;
2285 if (lnum == 0) /* got line one instead, correct db_idx */
2286 db_idx = -1; /* careful, it is negative! */
2287 else
2288 db_idx = lnum - buf->b_ml.ml_locked_low;
2289 /* get line count before the insertion */
2290 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2292 dp = (DATA_BL *)(hp->bh_data);
2295 * If
2296 * - there is not enough room in the current block
2297 * - appending to the last line in the block
2298 * - not appending to the last line in the file
2299 * insert in front of the next block.
2301 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2302 && lnum < buf->b_ml.ml_line_count)
2305 * Now that the line is not going to be inserted in the block that we
2306 * expected, the line count has to be adjusted in the pointer blocks
2307 * by using ml_locked_lineadd.
2309 --(buf->b_ml.ml_locked_lineadd);
2310 --(buf->b_ml.ml_locked_high);
2311 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2312 return FAIL;
2314 db_idx = -1; /* careful, it is negative! */
2315 /* get line count before the insertion */
2316 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2317 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2319 dp = (DATA_BL *)(hp->bh_data);
2322 ++buf->b_ml.ml_line_count;
2324 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2327 * Insert new line in existing data block, or in data block allocated above.
2329 dp->db_txt_start -= len;
2330 dp->db_free -= space_needed;
2331 ++(dp->db_line_count);
2334 * move the text of the lines that follow to the front
2335 * adjust the indexes of the lines that follow
2337 if (line_count > db_idx + 1) /* if there are following lines */
2340 * Offset is the start of the previous line.
2341 * This will become the character just after the new line.
2343 if (db_idx < 0)
2344 offset = dp->db_txt_end;
2345 else
2346 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2347 mch_memmove((char *)dp + dp->db_txt_start,
2348 (char *)dp + dp->db_txt_start + len,
2349 (size_t)(offset - (dp->db_txt_start + len)));
2350 for (i = line_count - 1; i > db_idx; --i)
2351 dp->db_index[i + 1] = dp->db_index[i] - len;
2352 dp->db_index[db_idx + 1] = offset - len;
2354 else /* add line at the end */
2355 dp->db_index[db_idx + 1] = dp->db_txt_start;
2358 * copy the text into the block
2360 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2361 if (mark)
2362 dp->db_index[db_idx + 1] |= DB_MARKED;
2365 * Mark the block dirty.
2367 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2368 if (!newfile)
2369 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2371 else /* not enough space in data block */
2374 * If there is not enough room we have to create a new data block and copy some
2375 * lines into it.
2376 * Then we have to insert an entry in the pointer block.
2377 * If this pointer block also is full, we go up another block, and so on, up
2378 * to the root if necessary.
2379 * The line counts in the pointer blocks have already been adjusted by
2380 * ml_find_line().
2382 long line_count_left, line_count_right;
2383 int page_count_left, page_count_right;
2384 bhdr_T *hp_left;
2385 bhdr_T *hp_right;
2386 bhdr_T *hp_new;
2387 int lines_moved;
2388 int data_moved = 0; /* init to shut up gcc */
2389 int total_moved = 0; /* init to shut up gcc */
2390 DATA_BL *dp_right, *dp_left;
2391 int stack_idx;
2392 int in_left;
2393 int lineadd;
2394 blocknr_T bnum_left, bnum_right;
2395 linenr_T lnum_left, lnum_right;
2396 int pb_idx;
2397 PTR_BL *pp_new;
2400 * We are going to allocate a new data block. Depending on the
2401 * situation it will be put to the left or right of the existing
2402 * block. If possible we put the new line in the left block and move
2403 * the lines after it to the right block. Otherwise the new line is
2404 * also put in the right block. This method is more efficient when
2405 * inserting a lot of lines at one place.
2407 if (db_idx < 0) /* left block is new, right block is existing */
2409 lines_moved = 0;
2410 in_left = TRUE;
2411 /* space_needed does not change */
2413 else /* left block is existing, right block is new */
2415 lines_moved = line_count - db_idx - 1;
2416 if (lines_moved == 0)
2417 in_left = FALSE; /* put new line in right block */
2418 /* space_needed does not change */
2419 else
2421 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2422 dp->db_txt_start;
2423 total_moved = data_moved + lines_moved * INDEX_SIZE;
2424 if ((int)dp->db_free + total_moved >= space_needed)
2426 in_left = TRUE; /* put new line in left block */
2427 space_needed = total_moved;
2429 else
2431 in_left = FALSE; /* put new line in right block */
2432 space_needed += total_moved;
2437 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2438 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2440 /* correct line counts in pointer blocks */
2441 --(buf->b_ml.ml_locked_lineadd);
2442 --(buf->b_ml.ml_locked_high);
2443 return FAIL;
2445 if (db_idx < 0) /* left block is new */
2447 hp_left = hp_new;
2448 hp_right = hp;
2449 line_count_left = 0;
2450 line_count_right = line_count;
2452 else /* right block is new */
2454 hp_left = hp;
2455 hp_right = hp_new;
2456 line_count_left = line_count;
2457 line_count_right = 0;
2459 dp_right = (DATA_BL *)(hp_right->bh_data);
2460 dp_left = (DATA_BL *)(hp_left->bh_data);
2461 bnum_left = hp_left->bh_bnum;
2462 bnum_right = hp_right->bh_bnum;
2463 page_count_left = hp_left->bh_page_count;
2464 page_count_right = hp_right->bh_page_count;
2467 * May move the new line into the right/new block.
2469 if (!in_left)
2471 dp_right->db_txt_start -= len;
2472 dp_right->db_free -= len + INDEX_SIZE;
2473 dp_right->db_index[0] = dp_right->db_txt_start;
2474 if (mark)
2475 dp_right->db_index[0] |= DB_MARKED;
2477 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2478 line, (size_t)len);
2479 ++line_count_right;
2482 * may move lines from the left/old block to the right/new one.
2484 if (lines_moved)
2488 dp_right->db_txt_start -= data_moved;
2489 dp_right->db_free -= total_moved;
2490 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2491 (char *)dp_left + dp_left->db_txt_start,
2492 (size_t)data_moved);
2493 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2494 dp_left->db_txt_start += data_moved;
2495 dp_left->db_free += total_moved;
2498 * update indexes in the new block
2500 for (to = line_count_right, from = db_idx + 1;
2501 from < line_count_left; ++from, ++to)
2502 dp_right->db_index[to] = dp->db_index[from] + offset;
2503 line_count_right += lines_moved;
2504 line_count_left -= lines_moved;
2508 * May move the new line into the left (old or new) block.
2510 if (in_left)
2512 dp_left->db_txt_start -= len;
2513 dp_left->db_free -= len + INDEX_SIZE;
2514 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2515 if (mark)
2516 dp_left->db_index[line_count_left] |= DB_MARKED;
2517 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2518 line, (size_t)len);
2519 ++line_count_left;
2522 if (db_idx < 0) /* left block is new */
2524 lnum_left = lnum + 1;
2525 lnum_right = 0;
2527 else /* right block is new */
2529 lnum_left = 0;
2530 if (in_left)
2531 lnum_right = lnum + 2;
2532 else
2533 lnum_right = lnum + 1;
2535 dp_left->db_line_count = line_count_left;
2536 dp_right->db_line_count = line_count_right;
2539 * release the two data blocks
2540 * The new one (hp_new) already has a correct blocknumber.
2541 * The old one (hp, in ml_locked) gets a positive blocknumber if
2542 * we changed it and we are not editing a new file.
2544 if (lines_moved || in_left)
2545 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2546 if (!newfile && db_idx >= 0 && in_left)
2547 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2548 mf_put(mfp, hp_new, TRUE, FALSE);
2551 * flush the old data block
2552 * set ml_locked_lineadd to 0, because the updating of the
2553 * pointer blocks is done below
2555 lineadd = buf->b_ml.ml_locked_lineadd;
2556 buf->b_ml.ml_locked_lineadd = 0;
2557 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2560 * update pointer blocks for the new data block
2562 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2563 --stack_idx)
2565 ip = &(buf->b_ml.ml_stack[stack_idx]);
2566 pb_idx = ip->ip_index;
2567 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2568 return FAIL;
2569 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2570 if (pp->pb_id != PTR_ID)
2572 EMSG(_("E317: pointer block id wrong 3"));
2573 mf_put(mfp, hp, FALSE, FALSE);
2574 return FAIL;
2577 * TODO: If the pointer block is full and we are adding at the end
2578 * try to insert in front of the next block
2580 /* block not full, add one entry */
2581 if (pp->pb_count < pp->pb_count_max)
2583 if (pb_idx + 1 < (int)pp->pb_count)
2584 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2585 &pp->pb_pointer[pb_idx + 1],
2586 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2587 ++pp->pb_count;
2588 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2589 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2590 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2591 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2592 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2593 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2595 if (lnum_left != 0)
2596 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2597 if (lnum_right != 0)
2598 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2600 mf_put(mfp, hp, TRUE, FALSE);
2601 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2603 if (lineadd)
2605 --(buf->b_ml.ml_stack_top);
2606 /* fix line count for rest of blocks in the stack */
2607 ml_lineadd(buf, lineadd);
2608 /* fix stack itself */
2609 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2610 lineadd;
2611 ++(buf->b_ml.ml_stack_top);
2615 * We are finished, break the loop here.
2617 break;
2619 else /* pointer block full */
2622 * split the pointer block
2623 * allocate a new pointer block
2624 * move some of the pointer into the new block
2625 * prepare for updating the parent block
2627 for (;;) /* do this twice when splitting block 1 */
2629 hp_new = ml_new_ptr(mfp);
2630 if (hp_new == NULL) /* TODO: try to fix tree */
2631 return FAIL;
2632 pp_new = (PTR_BL *)(hp_new->bh_data);
2634 if (hp->bh_bnum != 1)
2635 break;
2638 * if block 1 becomes full the tree is given an extra level
2639 * The pointers from block 1 are moved into the new block.
2640 * block 1 is updated to point to the new block
2641 * then continue to split the new block
2643 mch_memmove(pp_new, pp, (size_t)page_size);
2644 pp->pb_count = 1;
2645 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2646 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2647 pp->pb_pointer[0].pe_old_lnum = 1;
2648 pp->pb_pointer[0].pe_page_count = 1;
2649 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2650 hp = hp_new; /* new block is to be split */
2651 pp = pp_new;
2652 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2653 ip->ip_index = 0;
2654 ++stack_idx; /* do block 1 again later */
2657 * move the pointers after the current one to the new block
2658 * If there are none, the new entry will be in the new block.
2660 total_moved = pp->pb_count - pb_idx - 1;
2661 if (total_moved)
2663 mch_memmove(&pp_new->pb_pointer[0],
2664 &pp->pb_pointer[pb_idx + 1],
2665 (size_t)(total_moved) * sizeof(PTR_EN));
2666 pp_new->pb_count = total_moved;
2667 pp->pb_count -= total_moved - 1;
2668 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2669 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2670 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2671 if (lnum_right)
2672 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2674 else
2676 pp_new->pb_count = 1;
2677 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2678 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2679 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2680 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2682 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2683 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2684 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2685 if (lnum_left)
2686 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2687 lnum_left = 0;
2688 lnum_right = 0;
2691 * recompute line counts
2693 line_count_right = 0;
2694 for (i = 0; i < (int)pp_new->pb_count; ++i)
2695 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2696 line_count_left = 0;
2697 for (i = 0; i < (int)pp->pb_count; ++i)
2698 line_count_left += pp->pb_pointer[i].pe_line_count;
2700 bnum_left = hp->bh_bnum;
2701 bnum_right = hp_new->bh_bnum;
2702 page_count_left = 1;
2703 page_count_right = 1;
2704 mf_put(mfp, hp, TRUE, FALSE);
2705 mf_put(mfp, hp_new, TRUE, FALSE);
2710 * Safety check: fallen out of for loop?
2712 if (stack_idx < 0)
2714 EMSG(_("E318: Updated too many blocks?"));
2715 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2719 #ifdef FEAT_BYTEOFF
2720 /* The line was inserted below 'lnum' */
2721 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2722 #endif
2723 #ifdef FEAT_NETBEANS_INTG
2724 if (usingNetbeans)
2726 if (STRLEN(line) > 0)
2727 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2728 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2729 (char_u *)"\n", 1);
2731 #endif
2732 return OK;
2736 * Replace line lnum, with buffering, in current buffer.
2738 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2739 * copied to allocated memory already.
2741 * Check: The caller of this function should probably also call
2742 * changed_lines(), unless update_screen(NOT_VALID) is used.
2744 * return FAIL for failure, OK otherwise
2747 ml_replace(lnum, line, copy)
2748 linenr_T lnum;
2749 char_u *line;
2750 int copy;
2752 if (line == NULL) /* just checking... */
2753 return FAIL;
2755 /* When starting up, we might still need to create the memfile */
2756 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2757 return FAIL;
2759 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2760 return FAIL;
2761 #ifdef FEAT_NETBEANS_INTG
2762 if (usingNetbeans)
2764 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2765 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2767 #endif
2768 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2769 ml_flush_line(curbuf); /* flush it */
2770 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2771 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2772 curbuf->b_ml.ml_line_ptr = line;
2773 curbuf->b_ml.ml_line_lnum = lnum;
2774 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2776 return OK;
2780 * Delete line 'lnum' in the current buffer.
2782 * Check: The caller of this function should probably also call
2783 * deleted_lines() after this.
2785 * return FAIL for failure, OK otherwise
2788 ml_delete(lnum, message)
2789 linenr_T lnum;
2790 int message;
2792 ml_flush_line(curbuf);
2793 return ml_delete_int(curbuf, lnum, message);
2796 static int
2797 ml_delete_int(buf, lnum, message)
2798 buf_T *buf;
2799 linenr_T lnum;
2800 int message;
2802 bhdr_T *hp;
2803 memfile_T *mfp;
2804 DATA_BL *dp;
2805 PTR_BL *pp;
2806 infoptr_T *ip;
2807 int count; /* number of entries in block */
2808 int idx;
2809 int stack_idx;
2810 int text_start;
2811 int line_start;
2812 long line_size;
2813 int i;
2815 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2816 return FAIL;
2818 if (lowest_marked && lowest_marked > lnum)
2819 lowest_marked--;
2822 * If the file becomes empty the last line is replaced by an empty line.
2824 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2826 if (message
2827 #ifdef FEAT_NETBEANS_INTG
2828 && !netbeansSuppressNoLines
2829 #endif
2831 set_keep_msg((char_u *)_(no_lines_msg), 0);
2833 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2834 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2835 buf->b_ml.ml_flags |= ML_EMPTY;
2837 return i;
2841 * find the data block containing the line
2842 * This also fills the stack with the blocks from the root to the data block
2843 * This also releases any locked block.
2845 mfp = buf->b_ml.ml_mfp;
2846 if (mfp == NULL)
2847 return FAIL;
2849 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2850 return FAIL;
2852 dp = (DATA_BL *)(hp->bh_data);
2853 /* compute line count before the delete */
2854 count = (long)(buf->b_ml.ml_locked_high)
2855 - (long)(buf->b_ml.ml_locked_low) + 2;
2856 idx = lnum - buf->b_ml.ml_locked_low;
2858 --buf->b_ml.ml_line_count;
2860 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2861 if (idx == 0) /* first line in block, text at the end */
2862 line_size = dp->db_txt_end - line_start;
2863 else
2864 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2866 #ifdef FEAT_NETBEANS_INTG
2867 if (usingNetbeans)
2868 netbeans_removed(buf, lnum, 0, (long)line_size);
2869 #endif
2872 * special case: If there is only one line in the data block it becomes empty.
2873 * Then we have to remove the entry, pointing to this data block, from the
2874 * pointer block. If this pointer block also becomes empty, we go up another
2875 * block, and so on, up to the root if necessary.
2876 * The line counts in the pointer blocks have already been adjusted by
2877 * ml_find_line().
2879 if (count == 1)
2881 mf_free(mfp, hp); /* free the data block */
2882 buf->b_ml.ml_locked = NULL;
2884 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2886 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2887 ip = &(buf->b_ml.ml_stack[stack_idx]);
2888 idx = ip->ip_index;
2889 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2890 return FAIL;
2891 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2892 if (pp->pb_id != PTR_ID)
2894 EMSG(_("E317: pointer block id wrong 4"));
2895 mf_put(mfp, hp, FALSE, FALSE);
2896 return FAIL;
2898 count = --(pp->pb_count);
2899 if (count == 0) /* the pointer block becomes empty! */
2900 mf_free(mfp, hp);
2901 else
2903 if (count != idx) /* move entries after the deleted one */
2904 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2905 (size_t)(count - idx) * sizeof(PTR_EN));
2906 mf_put(mfp, hp, TRUE, FALSE);
2908 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2909 /* fix line count for rest of blocks in the stack */
2910 if (buf->b_ml.ml_locked_lineadd != 0)
2912 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2913 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2914 buf->b_ml.ml_locked_lineadd;
2916 ++(buf->b_ml.ml_stack_top);
2918 break;
2921 CHECK(stack_idx < 0, _("deleted block 1?"));
2923 else
2926 * delete the text by moving the next lines forwards
2928 text_start = dp->db_txt_start;
2929 mch_memmove((char *)dp + text_start + line_size,
2930 (char *)dp + text_start, (size_t)(line_start - text_start));
2933 * delete the index by moving the next indexes backwards
2934 * Adjust the indexes for the text movement.
2936 for (i = idx; i < count - 1; ++i)
2937 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2939 dp->db_free += line_size + INDEX_SIZE;
2940 dp->db_txt_start += line_size;
2941 --(dp->db_line_count);
2944 * mark the block dirty and make sure it is in the file (for recovery)
2946 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2949 #ifdef FEAT_BYTEOFF
2950 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2951 #endif
2952 return OK;
2956 * set the B_MARKED flag for line 'lnum'
2958 void
2959 ml_setmarked(lnum)
2960 linenr_T lnum;
2962 bhdr_T *hp;
2963 DATA_BL *dp;
2964 /* invalid line number */
2965 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2966 || curbuf->b_ml.ml_mfp == NULL)
2967 return; /* give error message? */
2969 if (lowest_marked == 0 || lowest_marked > lnum)
2970 lowest_marked = lnum;
2973 * find the data block containing the line
2974 * This also fills the stack with the blocks from the root to the data block
2975 * This also releases any locked block.
2977 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2978 return; /* give error message? */
2980 dp = (DATA_BL *)(hp->bh_data);
2981 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2982 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2986 * find the first line with its B_MARKED flag set
2988 linenr_T
2989 ml_firstmarked()
2991 bhdr_T *hp;
2992 DATA_BL *dp;
2993 linenr_T lnum;
2994 int i;
2996 if (curbuf->b_ml.ml_mfp == NULL)
2997 return (linenr_T) 0;
3000 * The search starts with lowest_marked line. This is the last line where
3001 * a mark was found, adjusted by inserting/deleting lines.
3003 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3006 * Find the data block containing the line.
3007 * This also fills the stack with the blocks from the root to the data
3008 * block This also releases any locked block.
3010 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3011 return (linenr_T)0; /* give error message? */
3013 dp = (DATA_BL *)(hp->bh_data);
3015 for (i = lnum - curbuf->b_ml.ml_locked_low;
3016 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3017 if ((dp->db_index[i]) & DB_MARKED)
3019 (dp->db_index[i]) &= DB_INDEX_MASK;
3020 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3021 lowest_marked = lnum + 1;
3022 return lnum;
3026 return (linenr_T) 0;
3029 #if 0 /* not used */
3031 * return TRUE if line 'lnum' has a mark
3034 ml_has_mark(lnum)
3035 linenr_T lnum;
3037 bhdr_T *hp;
3038 DATA_BL *dp;
3040 if (curbuf->b_ml.ml_mfp == NULL
3041 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3042 return FALSE;
3044 dp = (DATA_BL *)(hp->bh_data);
3045 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3047 #endif
3050 * clear all DB_MARKED flags
3052 void
3053 ml_clearmarked()
3055 bhdr_T *hp;
3056 DATA_BL *dp;
3057 linenr_T lnum;
3058 int i;
3060 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3061 return;
3064 * The search starts with line lowest_marked.
3066 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3069 * Find the data block containing the line.
3070 * This also fills the stack with the blocks from the root to the data
3071 * block and releases any locked block.
3073 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3074 return; /* give error message? */
3076 dp = (DATA_BL *)(hp->bh_data);
3078 for (i = lnum - curbuf->b_ml.ml_locked_low;
3079 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3080 if ((dp->db_index[i]) & DB_MARKED)
3082 (dp->db_index[i]) &= DB_INDEX_MASK;
3083 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3087 lowest_marked = 0;
3088 return;
3092 * flush ml_line if necessary
3094 static void
3095 ml_flush_line(buf)
3096 buf_T *buf;
3098 bhdr_T *hp;
3099 DATA_BL *dp;
3100 linenr_T lnum;
3101 char_u *new_line;
3102 char_u *old_line;
3103 colnr_T new_len;
3104 int old_len;
3105 int extra;
3106 int idx;
3107 int start;
3108 int count;
3109 int i;
3110 static int entered = FALSE;
3112 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3113 return; /* nothing to do */
3115 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3117 /* This code doesn't work recursively, but Netbeans may call back here
3118 * when obtaining the cursor position. */
3119 if (entered)
3120 return;
3121 entered = TRUE;
3123 lnum = buf->b_ml.ml_line_lnum;
3124 new_line = buf->b_ml.ml_line_ptr;
3126 hp = ml_find_line(buf, lnum, ML_FIND);
3127 if (hp == NULL)
3128 EMSGN(_("E320: Cannot find line %ld"), lnum);
3129 else
3131 dp = (DATA_BL *)(hp->bh_data);
3132 idx = lnum - buf->b_ml.ml_locked_low;
3133 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3134 old_line = (char_u *)dp + start;
3135 if (idx == 0) /* line is last in block */
3136 old_len = dp->db_txt_end - start;
3137 else /* text of previous line follows */
3138 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3139 new_len = (colnr_T)STRLEN(new_line) + 1;
3140 extra = new_len - old_len; /* negative if lines gets smaller */
3143 * if new line fits in data block, replace directly
3145 if ((int)dp->db_free >= extra)
3147 /* if the length changes and there are following lines */
3148 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3149 if (extra != 0 && idx < count - 1)
3151 /* move text of following lines */
3152 mch_memmove((char *)dp + dp->db_txt_start - extra,
3153 (char *)dp + dp->db_txt_start,
3154 (size_t)(start - dp->db_txt_start));
3156 /* adjust pointers of this and following lines */
3157 for (i = idx + 1; i < count; ++i)
3158 dp->db_index[i] -= extra;
3160 dp->db_index[idx] -= extra;
3162 /* adjust free space */
3163 dp->db_free -= extra;
3164 dp->db_txt_start -= extra;
3166 /* copy new line into the data block */
3167 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3168 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3169 #ifdef FEAT_BYTEOFF
3170 /* The else case is already covered by the insert and delete */
3171 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3172 #endif
3174 else
3177 * Cannot do it in one data block: Delete and append.
3178 * Append first, because ml_delete_int() cannot delete the
3179 * last line in a buffer, which causes trouble for a buffer
3180 * that has only one line.
3181 * Don't forget to copy the mark!
3183 /* How about handling errors??? */
3184 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3185 (dp->db_index[idx] & DB_MARKED));
3186 (void)ml_delete_int(buf, lnum, FALSE);
3189 vim_free(new_line);
3191 entered = FALSE;
3194 buf->b_ml.ml_line_lnum = 0;
3198 * create a new, empty, data block
3200 static bhdr_T *
3201 ml_new_data(mfp, negative, page_count)
3202 memfile_T *mfp;
3203 int negative;
3204 int page_count;
3206 bhdr_T *hp;
3207 DATA_BL *dp;
3209 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3210 return NULL;
3212 dp = (DATA_BL *)(hp->bh_data);
3213 dp->db_id = DATA_ID;
3214 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3215 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3216 dp->db_line_count = 0;
3218 return hp;
3222 * create a new, empty, pointer block
3224 static bhdr_T *
3225 ml_new_ptr(mfp)
3226 memfile_T *mfp;
3228 bhdr_T *hp;
3229 PTR_BL *pp;
3231 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3232 return NULL;
3234 pp = (PTR_BL *)(hp->bh_data);
3235 pp->pb_id = PTR_ID;
3236 pp->pb_count = 0;
3237 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3239 return hp;
3243 * lookup line 'lnum' in a memline
3245 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3246 * if ML_FLUSH only flush a locked block
3247 * if ML_FIND just find the line
3249 * If the block was found it is locked and put in ml_locked.
3250 * The stack is updated to lead to the locked block. The ip_high field in
3251 * the stack is updated to reflect the last line in the block AFTER the
3252 * insert or delete, also if the pointer block has not been updated yet. But
3253 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3255 * return: NULL for failure, pointer to block header otherwise
3257 static bhdr_T *
3258 ml_find_line(buf, lnum, action)
3259 buf_T *buf;
3260 linenr_T lnum;
3261 int action;
3263 DATA_BL *dp;
3264 PTR_BL *pp;
3265 infoptr_T *ip;
3266 bhdr_T *hp;
3267 memfile_T *mfp;
3268 linenr_T t;
3269 blocknr_T bnum, bnum2;
3270 int dirty;
3271 linenr_T low, high;
3272 int top;
3273 int page_count;
3274 int idx;
3276 mfp = buf->b_ml.ml_mfp;
3279 * If there is a locked block check if the wanted line is in it.
3280 * If not, flush and release the locked block.
3281 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3282 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3283 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3285 if (buf->b_ml.ml_locked)
3287 if (ML_SIMPLE(action)
3288 && buf->b_ml.ml_locked_low <= lnum
3289 && buf->b_ml.ml_locked_high >= lnum
3290 && !mf_dont_release)
3292 /* remember to update pointer blocks and stack later */
3293 if (action == ML_INSERT)
3295 ++(buf->b_ml.ml_locked_lineadd);
3296 ++(buf->b_ml.ml_locked_high);
3298 else if (action == ML_DELETE)
3300 --(buf->b_ml.ml_locked_lineadd);
3301 --(buf->b_ml.ml_locked_high);
3303 return (buf->b_ml.ml_locked);
3306 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3307 buf->b_ml.ml_flags & ML_LOCKED_POS);
3308 buf->b_ml.ml_locked = NULL;
3311 * If lines have been added or deleted in the locked block, need to
3312 * update the line count in pointer blocks.
3314 if (buf->b_ml.ml_locked_lineadd != 0)
3315 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3318 if (action == ML_FLUSH) /* nothing else to do */
3319 return NULL;
3321 bnum = 1; /* start at the root of the tree */
3322 page_count = 1;
3323 low = 1;
3324 high = buf->b_ml.ml_line_count;
3326 if (action == ML_FIND) /* first try stack entries */
3328 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3330 ip = &(buf->b_ml.ml_stack[top]);
3331 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3333 bnum = ip->ip_bnum;
3334 low = ip->ip_low;
3335 high = ip->ip_high;
3336 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3337 break;
3340 if (top < 0)
3341 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3343 else /* ML_DELETE or ML_INSERT */
3344 buf->b_ml.ml_stack_top = 0; /* start at the root */
3347 * search downwards in the tree until a data block is found
3349 for (;;)
3351 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3352 goto error_noblock;
3355 * update high for insert/delete
3357 if (action == ML_INSERT)
3358 ++high;
3359 else if (action == ML_DELETE)
3360 --high;
3362 dp = (DATA_BL *)(hp->bh_data);
3363 if (dp->db_id == DATA_ID) /* data block */
3365 buf->b_ml.ml_locked = hp;
3366 buf->b_ml.ml_locked_low = low;
3367 buf->b_ml.ml_locked_high = high;
3368 buf->b_ml.ml_locked_lineadd = 0;
3369 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3370 return hp;
3373 pp = (PTR_BL *)(dp); /* must be pointer block */
3374 if (pp->pb_id != PTR_ID)
3376 EMSG(_("E317: pointer block id wrong"));
3377 goto error_block;
3380 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3381 goto error_block;
3382 ip = &(buf->b_ml.ml_stack[top]);
3383 ip->ip_bnum = bnum;
3384 ip->ip_low = low;
3385 ip->ip_high = high;
3386 ip->ip_index = -1; /* index not known yet */
3388 dirty = FALSE;
3389 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3391 t = pp->pb_pointer[idx].pe_line_count;
3392 CHECK(t == 0, _("pe_line_count is zero"));
3393 if ((low += t) > lnum)
3395 ip->ip_index = idx;
3396 bnum = pp->pb_pointer[idx].pe_bnum;
3397 page_count = pp->pb_pointer[idx].pe_page_count;
3398 high = low - 1;
3399 low -= t;
3402 * a negative block number may have been changed
3404 if (bnum < 0)
3406 bnum2 = mf_trans_del(mfp, bnum);
3407 if (bnum != bnum2)
3409 bnum = bnum2;
3410 pp->pb_pointer[idx].pe_bnum = bnum;
3411 dirty = TRUE;
3415 break;
3418 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3420 if (lnum > buf->b_ml.ml_line_count)
3421 EMSGN(_("E322: line number out of range: %ld past the end"),
3422 lnum - buf->b_ml.ml_line_count);
3424 else
3425 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3426 goto error_block;
3428 if (action == ML_DELETE)
3430 pp->pb_pointer[idx].pe_line_count--;
3431 dirty = TRUE;
3433 else if (action == ML_INSERT)
3435 pp->pb_pointer[idx].pe_line_count++;
3436 dirty = TRUE;
3438 mf_put(mfp, hp, dirty, FALSE);
3441 error_block:
3442 mf_put(mfp, hp, FALSE, FALSE);
3443 error_noblock:
3445 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3446 * the incremented/decremented line counts, because there won't be a line
3447 * inserted/deleted after all.
3449 if (action == ML_DELETE)
3450 ml_lineadd(buf, 1);
3451 else if (action == ML_INSERT)
3452 ml_lineadd(buf, -1);
3453 buf->b_ml.ml_stack_top = 0;
3454 return NULL;
3458 * add an entry to the info pointer stack
3460 * return -1 for failure, number of the new entry otherwise
3462 static int
3463 ml_add_stack(buf)
3464 buf_T *buf;
3466 int top;
3467 infoptr_T *newstack;
3469 top = buf->b_ml.ml_stack_top;
3471 /* may have to increase the stack size */
3472 if (top == buf->b_ml.ml_stack_size)
3474 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3476 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3477 (buf->b_ml.ml_stack_size + STACK_INCR));
3478 if (newstack == NULL)
3479 return -1;
3480 mch_memmove(newstack, buf->b_ml.ml_stack,
3481 (size_t)top * sizeof(infoptr_T));
3482 vim_free(buf->b_ml.ml_stack);
3483 buf->b_ml.ml_stack = newstack;
3484 buf->b_ml.ml_stack_size += STACK_INCR;
3487 buf->b_ml.ml_stack_top++;
3488 return top;
3492 * Update the pointer blocks on the stack for inserted/deleted lines.
3493 * The stack itself is also updated.
3495 * When a insert/delete line action fails, the line is not inserted/deleted,
3496 * but the pointer blocks have already been updated. That is fixed here by
3497 * walking through the stack.
3499 * Count is the number of lines added, negative if lines have been deleted.
3501 static void
3502 ml_lineadd(buf, count)
3503 buf_T *buf;
3504 int count;
3506 int idx;
3507 infoptr_T *ip;
3508 PTR_BL *pp;
3509 memfile_T *mfp = buf->b_ml.ml_mfp;
3510 bhdr_T *hp;
3512 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3514 ip = &(buf->b_ml.ml_stack[idx]);
3515 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3516 break;
3517 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3518 if (pp->pb_id != PTR_ID)
3520 mf_put(mfp, hp, FALSE, FALSE);
3521 EMSG(_("E317: pointer block id wrong 2"));
3522 break;
3524 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3525 ip->ip_high += count;
3526 mf_put(mfp, hp, TRUE, FALSE);
3530 #ifdef HAVE_READLINK
3532 * Resolve a symlink in the last component of a file name.
3533 * Note that f_resolve() does it for every part of the path, we don't do that
3534 * here.
3535 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3536 * Otherwise returns FAIL.
3538 static int
3539 resolve_symlink(fname, buf)
3540 char_u *fname;
3541 char_u *buf;
3543 char_u tmp[MAXPATHL];
3544 int ret;
3545 int depth = 0;
3547 if (fname == NULL)
3548 return FAIL;
3550 /* Put the result so far in tmp[], starting with the original name. */
3551 vim_strncpy(tmp, fname, MAXPATHL - 1);
3553 for (;;)
3555 /* Limit symlink depth to 100, catch recursive loops. */
3556 if (++depth == 100)
3558 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3559 return FAIL;
3562 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3563 if (ret <= 0)
3565 if (errno == EINVAL || errno == ENOENT)
3567 /* Found non-symlink or not existing file, stop here.
3568 * When at the first level use the unmodified name, skip the
3569 * call to vim_FullName(). */
3570 if (depth == 1)
3571 return FAIL;
3573 /* Use the resolved name in tmp[]. */
3574 break;
3577 /* There must be some error reading links, use original name. */
3578 return FAIL;
3580 buf[ret] = NUL;
3583 * Check whether the symlink is relative or absolute.
3584 * If it's relative, build a new path based on the directory
3585 * portion of the filename (if any) and the path the symlink
3586 * points to.
3588 if (mch_isFullName(buf))
3589 STRCPY(tmp, buf);
3590 else
3592 char_u *tail;
3594 tail = gettail(tmp);
3595 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3596 return FAIL;
3597 STRCPY(tail, buf);
3602 * Try to resolve the full name of the file so that the swapfile name will
3603 * be consistent even when opening a relative symlink from different
3604 * working directories.
3606 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3608 #endif
3611 * Make swap file name out of the file name and a directory name.
3612 * Returns pointer to allocated memory or NULL.
3614 char_u *
3615 makeswapname(fname, ffname, buf, dir_name)
3616 char_u *fname;
3617 char_u *ffname UNUSED;
3618 buf_T *buf;
3619 char_u *dir_name;
3621 char_u *r, *s;
3622 char_u *fname_res = fname;
3623 #ifdef HAVE_READLINK
3624 char_u fname_buf[MAXPATHL];
3625 #endif
3627 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3628 s = dir_name + STRLEN(dir_name);
3629 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3630 { /* Ends with '//', Use Full path */
3631 r = NULL;
3632 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3634 r = modname(s, (char_u *)".swp", FALSE);
3635 vim_free(s);
3637 return r;
3639 #endif
3641 #ifdef HAVE_READLINK
3642 /* Expand symlink in the file name, so that we put the swap file with the
3643 * actual file instead of with the symlink. */
3644 if (resolve_symlink(fname, fname_buf) == OK)
3645 fname_res = fname_buf;
3646 #endif
3648 r = buf_modname(
3649 #ifdef SHORT_FNAME
3650 TRUE,
3651 #else
3652 (buf->b_p_sn || buf->b_shortname),
3653 #endif
3654 #ifdef RISCOS
3655 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3656 ffname,
3657 #else
3658 fname_res,
3659 #endif
3660 (char_u *)
3661 #if defined(VMS) || defined(RISCOS)
3662 "_swp",
3663 #else
3664 ".swp",
3665 #endif
3666 #ifdef SHORT_FNAME /* always 8.3 file name */
3667 FALSE
3668 #else
3669 /* Prepend a '.' to the swap file name for the current directory. */
3670 dir_name[0] == '.' && dir_name[1] == NUL
3671 #endif
3673 if (r == NULL) /* out of memory */
3674 return NULL;
3676 s = get_file_in_dir(r, dir_name);
3677 vim_free(r);
3678 return s;
3682 * Get file name to use for swap file or backup file.
3683 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3684 * option "dname".
3685 * - If "dname" is ".", return "fname" (swap file in dir of file).
3686 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3687 * relative to dir of file).
3688 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3689 * dir).
3691 * The return value is an allocated string and can be NULL.
3693 char_u *
3694 get_file_in_dir(fname, dname)
3695 char_u *fname;
3696 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3698 char_u *t;
3699 char_u *tail;
3700 char_u *retval;
3701 int save_char;
3703 tail = gettail(fname);
3705 if (dname[0] == '.' && dname[1] == NUL)
3706 retval = vim_strsave(fname);
3707 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3709 if (tail == fname) /* no path before file name */
3710 retval = concat_fnames(dname + 2, tail, TRUE);
3711 else
3713 save_char = *tail;
3714 *tail = NUL;
3715 t = concat_fnames(fname, dname + 2, TRUE);
3716 *tail = save_char;
3717 if (t == NULL) /* out of memory */
3718 retval = NULL;
3719 else
3721 retval = concat_fnames(t, tail, TRUE);
3722 vim_free(t);
3726 else
3727 retval = concat_fnames(dname, tail, TRUE);
3729 return retval;
3732 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3735 * Print the ATTENTION message: info about an existing swap file.
3737 static void
3738 attention_message(buf, fname)
3739 buf_T *buf; /* buffer being edited */
3740 char_u *fname; /* swap file name */
3742 struct stat st;
3743 time_t x, sx;
3744 char *p;
3746 ++no_wait_return;
3747 (void)EMSG(_("E325: ATTENTION"));
3748 MSG_PUTS(_("\nFound a swap file by the name \""));
3749 msg_home_replace(fname);
3750 MSG_PUTS("\"\n");
3751 sx = swapfile_info(fname);
3752 MSG_PUTS(_("While opening file \""));
3753 msg_outtrans(buf->b_fname);
3754 MSG_PUTS("\"\n");
3755 if (mch_stat((char *)buf->b_fname, &st) != -1)
3757 MSG_PUTS(_(" dated: "));
3758 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3759 p = ctime(&x); /* includes '\n' */
3760 if (p == NULL)
3761 MSG_PUTS("(invalid)\n");
3762 else
3763 MSG_PUTS(p);
3764 if (sx != 0 && x > sx)
3765 MSG_PUTS(_(" NEWER than swap file!\n"));
3767 /* Some of these messages are long to allow translation to
3768 * other languages. */
3769 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"));
3770 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3771 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3772 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3773 msg_outtrans(buf->b_fname);
3774 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3775 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3776 msg_outtrans(fname);
3777 MSG_PUTS(_("\"\n to avoid this message.\n"));
3778 cmdline_row = msg_row;
3779 --no_wait_return;
3782 #ifdef FEAT_AUTOCMD
3783 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3786 * Trigger the SwapExists autocommands.
3787 * Returns a value for equivalent to do_dialog() (see below):
3788 * 0: still need to ask for a choice
3789 * 1: open read-only
3790 * 2: edit anyway
3791 * 3: recover
3792 * 4: delete it
3793 * 5: quit
3794 * 6: abort
3796 static int
3797 do_swapexists(buf, fname)
3798 buf_T *buf;
3799 char_u *fname;
3801 set_vim_var_string(VV_SWAPNAME, fname, -1);
3802 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3804 /* Trigger SwapExists autocommands with <afile> set to the file being
3805 * edited. Disallow changing directory here. */
3806 ++allbuf_lock;
3807 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3808 --allbuf_lock;
3810 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3812 switch (*get_vim_var_str(VV_SWAPCHOICE))
3814 case 'o': return 1;
3815 case 'e': return 2;
3816 case 'r': return 3;
3817 case 'd': return 4;
3818 case 'q': return 5;
3819 case 'a': return 6;
3822 return 0;
3824 #endif
3827 * Find out what name to use for the swap file for buffer 'buf'.
3829 * Several names are tried to find one that does not exist
3830 * Returns the name in allocated memory or NULL.
3832 * Note: If BASENAMELEN is not correct, you will get error messages for
3833 * not being able to open the swapfile
3834 * Note: May trigger SwapExists autocmd, pointers may change!
3836 static char_u *
3837 findswapname(buf, dirp, old_fname)
3838 buf_T *buf;
3839 char_u **dirp; /* pointer to list of directories */
3840 char_u *old_fname; /* don't give warning for this file name */
3842 char_u *fname;
3843 int n;
3844 char_u *dir_name;
3845 #ifdef AMIGA
3846 BPTR fh;
3847 #endif
3848 #ifndef SHORT_FNAME
3849 int r;
3850 #endif
3852 #if !defined(SHORT_FNAME) \
3853 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3854 # define CREATE_DUMMY_FILE
3855 FILE *dummyfd = NULL;
3858 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3859 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3860 * create will be exactly the same file. To avoid this problem we temporarily
3861 * create "test.doc".
3862 * Don't do this when the check below for a 8.3 file name is used.
3864 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3865 && mch_getperm(buf->b_fname) < 0)
3866 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3867 #endif
3870 * Isolate a directory name from *dirp and put it in dir_name.
3871 * First allocate some memory to put the directory name in.
3873 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3874 if (dir_name != NULL)
3875 (void)copy_option_part(dirp, dir_name, 31000, ",");
3878 * we try different names until we find one that does not exist yet
3880 if (dir_name == NULL) /* out of memory */
3881 fname = NULL;
3882 else
3883 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3885 for (;;)
3887 if (fname == NULL) /* must be out of memory */
3888 break;
3889 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3891 vim_free(fname);
3892 fname = NULL;
3893 break;
3895 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3897 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3898 * file names. If this is the first try and the swap file name does not fit in
3899 * 8.3, detect if this is the case, set shortname and try again.
3901 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3902 && !(buf->b_p_sn || buf->b_shortname))
3904 char_u *tail;
3905 char_u *fname2;
3906 struct stat s1, s2;
3907 int f1, f2;
3908 int created1 = FALSE, created2 = FALSE;
3909 int same = FALSE;
3912 * Check if swapfile name does not fit in 8.3:
3913 * It either contains two dots, is longer than 8 chars, or starts
3914 * with a dot.
3916 tail = gettail(buf->b_fname);
3917 if ( vim_strchr(tail, '.') != NULL
3918 || STRLEN(tail) > (size_t)8
3919 || *gettail(fname) == '.')
3921 fname2 = alloc(n + 2);
3922 if (fname2 != NULL)
3924 STRCPY(fname2, fname);
3925 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3926 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3927 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3929 if (vim_strchr(tail, '.') != NULL)
3930 fname2[n - 1] = 'x';
3931 else if (*gettail(fname) == '.')
3933 fname2[n] = 'x';
3934 fname2[n + 1] = NUL;
3936 else
3937 fname2[n - 5] += 1;
3939 * may need to create the files to be able to use mch_stat()
3941 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3942 if (f1 < 0)
3944 f1 = mch_open_rw((char *)fname,
3945 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3946 #if defined(OS2)
3947 if (f1 < 0 && errno == ENOENT)
3948 same = TRUE;
3949 #endif
3950 created1 = TRUE;
3952 if (f1 >= 0)
3954 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3955 if (f2 < 0)
3957 f2 = mch_open_rw((char *)fname2,
3958 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3959 created2 = TRUE;
3961 if (f2 >= 0)
3964 * Both files exist now. If mch_stat() returns the
3965 * same device and inode they are the same file.
3967 if (mch_fstat(f1, &s1) != -1
3968 && mch_fstat(f2, &s2) != -1
3969 && s1.st_dev == s2.st_dev
3970 && s1.st_ino == s2.st_ino)
3971 same = TRUE;
3972 close(f2);
3973 if (created2)
3974 mch_remove(fname2);
3976 close(f1);
3977 if (created1)
3978 mch_remove(fname);
3980 vim_free(fname2);
3981 if (same)
3983 buf->b_shortname = TRUE;
3984 vim_free(fname);
3985 fname = makeswapname(buf->b_fname, buf->b_ffname,
3986 buf, dir_name);
3987 continue; /* try again with b_shortname set */
3992 #endif
3994 * check if the swapfile already exists
3996 if (mch_getperm(fname) < 0) /* it does not exist */
3998 #ifdef HAVE_LSTAT
3999 struct stat sb;
4002 * Extra security check: When a swap file is a symbolic link, this
4003 * is most likely a symlink attack.
4005 if (mch_lstat((char *)fname, &sb) < 0)
4006 #else
4007 # ifdef AMIGA
4008 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4010 * on the Amiga mch_getperm() will return -1 when the file exists
4011 * but is being used by another program. This happens if you edit
4012 * a file twice.
4014 if (fh != (BPTR)NULL) /* can open file, OK */
4016 Close(fh);
4017 mch_remove(fname);
4018 break;
4020 if (IoErr() != ERROR_OBJECT_IN_USE
4021 && IoErr() != ERROR_OBJECT_EXISTS)
4022 # endif
4023 #endif
4024 break;
4028 * A file name equal to old_fname is OK to use.
4030 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4031 break;
4034 * get here when file already exists
4036 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4038 #ifndef SHORT_FNAME
4040 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4041 * and file.doc are the same file. To guess if this problem is
4042 * present try if file.doc.swx exists. If it does, we set
4043 * buf->b_shortname and try file_doc.swp (dots replaced by
4044 * underscores for this file), and try again. If it doesn't we
4045 * assume that "file.doc.swp" already exists.
4047 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4049 fname[n - 1] = 'x';
4050 r = mch_getperm(fname); /* try "file.swx" */
4051 fname[n - 1] = 'p';
4052 if (r >= 0) /* "file.swx" seems to exist */
4054 buf->b_shortname = TRUE;
4055 vim_free(fname);
4056 fname = makeswapname(buf->b_fname, buf->b_ffname,
4057 buf, dir_name);
4058 continue; /* try again with '.' replaced with '_' */
4061 #endif
4063 * If we get here the ".swp" file really exists.
4064 * Give an error message, unless recovering, no file name, we are
4065 * viewing a help file or when the path of the file is different
4066 * (happens when all .swp files are in one directory).
4068 if (!recoverymode && buf->b_fname != NULL
4069 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4071 int fd;
4072 struct block0 b0;
4073 int differ = FALSE;
4076 * Try to read block 0 from the swap file to get the original
4077 * file name (and inode number).
4079 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4080 if (fd >= 0)
4082 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4085 * If the swapfile has the same directory as the
4086 * buffer don't compare the directory names, they can
4087 * have a different mountpoint.
4089 if (b0.b0_flags & B0_SAME_DIR)
4091 if (fnamecmp(gettail(buf->b_ffname),
4092 gettail(b0.b0_fname)) != 0
4093 || !same_directory(fname, buf->b_ffname))
4095 #ifdef CHECK_INODE
4096 /* Symlinks may point to the same file even
4097 * when the name differs, need to check the
4098 * inode too. */
4099 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4100 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4101 char_to_long(b0.b0_ino)))
4102 #endif
4103 differ = TRUE;
4106 else
4109 * The name in the swap file may be
4110 * "~user/path/file". Expand it first.
4112 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4113 #ifdef CHECK_INODE
4114 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4115 char_to_long(b0.b0_ino)))
4116 differ = TRUE;
4117 #else
4118 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4119 differ = TRUE;
4120 #endif
4123 close(fd);
4125 #ifdef RISCOS
4126 else
4127 /* Can't open swap file, though it does exist.
4128 * Assume that the user is editing two files with
4129 * the same name in different directories. No error.
4131 differ = TRUE;
4132 #endif
4134 /* give the ATTENTION message when there is an old swap file
4135 * for the current file, and the buffer was not recovered. */
4136 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4137 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4139 #if defined(HAS_SWAP_EXISTS_ACTION)
4140 int choice = 0;
4141 #endif
4142 #ifdef CREATE_DUMMY_FILE
4143 int did_use_dummy = FALSE;
4145 /* Avoid getting a warning for the file being created
4146 * outside of Vim, it was created at the start of this
4147 * function. Delete the file now, because Vim might exit
4148 * here if the window is closed. */
4149 if (dummyfd != NULL)
4151 fclose(dummyfd);
4152 dummyfd = NULL;
4153 mch_remove(buf->b_fname);
4154 did_use_dummy = TRUE;
4156 #endif
4158 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4159 process_still_running = FALSE;
4160 #endif
4161 #ifdef FEAT_AUTOCMD
4163 * If there is an SwapExists autocommand and we can handle
4164 * the response, trigger it. It may return 0 to ask the
4165 * user anyway.
4167 if (swap_exists_action != SEA_NONE
4168 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4169 choice = do_swapexists(buf, fname);
4171 if (choice == 0)
4172 #endif
4174 #ifdef FEAT_GUI
4175 /* If we are supposed to start the GUI but it wasn't
4176 * completely started yet, start it now. This makes
4177 * the messages displayed in the Vim window when
4178 * loading a session from the .gvimrc file. */
4179 if (gui.starting && !gui.in_use)
4180 gui_start();
4181 #endif
4182 /* Show info about the existing swap file. */
4183 attention_message(buf, fname);
4185 /* We don't want a 'q' typed at the more-prompt
4186 * interrupt loading a file. */
4187 got_int = FALSE;
4190 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4191 if (swap_exists_action != SEA_NONE && choice == 0)
4193 char_u *name;
4195 name = alloc((unsigned)(STRLEN(fname)
4196 + STRLEN(_("Swap file \""))
4197 + STRLEN(_("\" already exists!")) + 5));
4198 if (name != NULL)
4200 STRCPY(name, _("Swap file \""));
4201 home_replace(NULL, fname, name + STRLEN(name),
4202 1000, TRUE);
4203 STRCAT(name, _("\" already exists!"));
4205 choice = do_dialog(VIM_WARNING,
4206 (char_u *)_("VIM - ATTENTION"),
4207 name == NULL
4208 ? (char_u *)_("Swap file already exists!")
4209 : name,
4210 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4211 process_still_running
4212 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4213 # endif
4214 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4216 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4217 if (process_still_running && choice >= 4)
4218 choice++; /* Skip missing "Delete it" button */
4219 # endif
4220 vim_free(name);
4222 /* pretend screen didn't scroll, need redraw anyway */
4223 msg_scrolled = 0;
4224 redraw_all_later(NOT_VALID);
4226 #endif
4228 #if defined(HAS_SWAP_EXISTS_ACTION)
4229 if (choice > 0)
4231 switch (choice)
4233 case 1:
4234 buf->b_p_ro = TRUE;
4235 break;
4236 case 2:
4237 break;
4238 case 3:
4239 swap_exists_action = SEA_RECOVER;
4240 break;
4241 case 4:
4242 mch_remove(fname);
4243 break;
4244 case 5:
4245 swap_exists_action = SEA_QUIT;
4246 break;
4247 case 6:
4248 swap_exists_action = SEA_QUIT;
4249 got_int = TRUE;
4250 break;
4253 /* If the file was deleted this fname can be used. */
4254 if (mch_getperm(fname) < 0)
4255 break;
4257 else
4258 #endif
4260 MSG_PUTS("\n");
4261 if (msg_silent == 0)
4262 /* call wait_return() later */
4263 need_wait_return = TRUE;
4266 #ifdef CREATE_DUMMY_FILE
4267 /* Going to try another name, need the dummy file again. */
4268 if (did_use_dummy)
4269 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4270 #endif
4276 * Change the ".swp" extension to find another file that can be used.
4277 * First decrement the last char: ".swo", ".swn", etc.
4278 * If that still isn't enough decrement the last but one char: ".svz"
4279 * Can happen when editing many "No Name" buffers.
4281 if (fname[n - 1] == 'a') /* ".s?a" */
4283 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4285 EMSG(_("E326: Too many swap files found"));
4286 vim_free(fname);
4287 fname = NULL;
4288 break;
4290 --fname[n - 2]; /* ".svz", ".suz", etc. */
4291 fname[n - 1] = 'z' + 1;
4293 --fname[n - 1]; /* ".swo", ".swn", etc. */
4296 vim_free(dir_name);
4297 #ifdef CREATE_DUMMY_FILE
4298 if (dummyfd != NULL) /* file has been created temporarily */
4300 fclose(dummyfd);
4301 mch_remove(buf->b_fname);
4303 #endif
4304 return fname;
4307 static int
4308 b0_magic_wrong(b0p)
4309 ZERO_BL *b0p;
4311 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4312 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4313 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4314 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4317 #ifdef CHECK_INODE
4319 * Compare current file name with file name from swap file.
4320 * Try to use inode numbers when possible.
4321 * Return non-zero when files are different.
4323 * When comparing file names a few things have to be taken into consideration:
4324 * - When working over a network the full path of a file depends on the host.
4325 * We check the inode number if possible. It is not 100% reliable though,
4326 * because the device number cannot be used over a network.
4327 * - When a file does not exist yet (editing a new file) there is no inode
4328 * number.
4329 * - The file name in a swap file may not be valid on the current host. The
4330 * "~user" form is used whenever possible to avoid this.
4332 * This is getting complicated, let's make a table:
4334 * ino_c ino_s fname_c fname_s differ =
4336 * both files exist -> compare inode numbers:
4337 * != 0 != 0 X X ino_c != ino_s
4339 * inode number(s) unknown, file names available -> compare file names
4340 * == 0 X OK OK fname_c != fname_s
4341 * X == 0 OK OK fname_c != fname_s
4343 * current file doesn't exist, file for swap file exist, file name(s) not
4344 * available -> probably different
4345 * == 0 != 0 FAIL X TRUE
4346 * == 0 != 0 X FAIL TRUE
4348 * current file exists, inode for swap unknown, file name(s) not
4349 * available -> probably different
4350 * != 0 == 0 FAIL X TRUE
4351 * != 0 == 0 X FAIL TRUE
4353 * current file doesn't exist, inode for swap unknown, one file name not
4354 * available -> probably different
4355 * == 0 == 0 FAIL OK TRUE
4356 * == 0 == 0 OK FAIL TRUE
4358 * current file doesn't exist, inode for swap unknown, both file names not
4359 * available -> probably same file
4360 * == 0 == 0 FAIL FAIL FALSE
4362 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4363 * can't be changed without making the block 0 incompatible with 32 bit
4364 * versions.
4367 static int
4368 fnamecmp_ino(fname_c, fname_s, ino_block0)
4369 char_u *fname_c; /* current file name */
4370 char_u *fname_s; /* file name from swap file */
4371 long ino_block0;
4373 struct stat st;
4374 ino_t ino_c = 0; /* ino of current file */
4375 ino_t ino_s; /* ino of file from swap file */
4376 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4377 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4378 int retval_c; /* flag: buf_c valid */
4379 int retval_s; /* flag: buf_s valid */
4381 if (mch_stat((char *)fname_c, &st) == 0)
4382 ino_c = (ino_t)st.st_ino;
4385 * First we try to get the inode from the file name, because the inode in
4386 * the swap file may be outdated. If that fails (e.g. this path is not
4387 * valid on this machine), use the inode from block 0.
4389 if (mch_stat((char *)fname_s, &st) == 0)
4390 ino_s = (ino_t)st.st_ino;
4391 else
4392 ino_s = (ino_t)ino_block0;
4394 if (ino_c && ino_s)
4395 return (ino_c != ino_s);
4398 * One of the inode numbers is unknown, try a forced vim_FullName() and
4399 * compare the file names.
4401 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4402 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4403 if (retval_c == OK && retval_s == OK)
4404 return (STRCMP(buf_c, buf_s) != 0);
4407 * Can't compare inodes or file names, guess that the files are different,
4408 * unless both appear not to exist at all.
4410 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4411 return FALSE;
4412 return TRUE;
4414 #endif /* CHECK_INODE */
4417 * Move a long integer into a four byte character array.
4418 * Used for machine independency in block zero.
4420 static void
4421 long_to_char(n, s)
4422 long n;
4423 char_u *s;
4425 s[0] = (char_u)(n & 0xff);
4426 n = (unsigned)n >> 8;
4427 s[1] = (char_u)(n & 0xff);
4428 n = (unsigned)n >> 8;
4429 s[2] = (char_u)(n & 0xff);
4430 n = (unsigned)n >> 8;
4431 s[3] = (char_u)(n & 0xff);
4434 static long
4435 char_to_long(s)
4436 char_u *s;
4438 long retval;
4440 retval = s[3];
4441 retval <<= 8;
4442 retval |= s[2];
4443 retval <<= 8;
4444 retval |= s[1];
4445 retval <<= 8;
4446 retval |= s[0];
4448 return retval;
4452 * Set the flags in the first block of the swap file:
4453 * - file is modified or not: buf->b_changed
4454 * - 'fileformat'
4455 * - 'fileencoding'
4457 void
4458 ml_setflags(buf)
4459 buf_T *buf;
4461 bhdr_T *hp;
4462 ZERO_BL *b0p;
4464 if (!buf->b_ml.ml_mfp)
4465 return;
4466 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4468 if (hp->bh_bnum == 0)
4470 b0p = (ZERO_BL *)(hp->bh_data);
4471 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4472 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4473 | (get_fileformat(buf) + 1);
4474 #ifdef FEAT_MBYTE
4475 add_b0_fenc(b0p, buf);
4476 #endif
4477 hp->bh_flags |= BH_DIRTY;
4478 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4479 break;
4484 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4486 #define MLCS_MAXL 800 /* max no of lines in chunk */
4487 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4490 * Keep information for finding byte offset of a line, updtytpe may be one of:
4491 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4492 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4493 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4494 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4496 static void
4497 ml_updatechunk(buf, line, len, updtype)
4498 buf_T *buf;
4499 linenr_T line;
4500 long len;
4501 int updtype;
4503 static buf_T *ml_upd_lastbuf = NULL;
4504 static linenr_T ml_upd_lastline;
4505 static linenr_T ml_upd_lastcurline;
4506 static int ml_upd_lastcurix;
4508 linenr_T curline = ml_upd_lastcurline;
4509 int curix = ml_upd_lastcurix;
4510 long size;
4511 chunksize_T *curchnk;
4512 int rest;
4513 bhdr_T *hp;
4514 DATA_BL *dp;
4516 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4517 return;
4518 if (buf->b_ml.ml_chunksize == NULL)
4520 buf->b_ml.ml_chunksize = (chunksize_T *)
4521 alloc((unsigned)sizeof(chunksize_T) * 100);
4522 if (buf->b_ml.ml_chunksize == NULL)
4524 buf->b_ml.ml_usedchunks = -1;
4525 return;
4527 buf->b_ml.ml_numchunks = 100;
4528 buf->b_ml.ml_usedchunks = 1;
4529 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4530 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4533 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4536 * First line in empty buffer from ml_flush_line() -- reset
4538 buf->b_ml.ml_usedchunks = 1;
4539 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4540 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4541 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4542 return;
4546 * Find chunk that our line belongs to, curline will be at start of the
4547 * chunk.
4549 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4550 || updtype != ML_CHNK_ADDLINE)
4552 for (curline = 1, curix = 0;
4553 curix < buf->b_ml.ml_usedchunks - 1
4554 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4555 curix++)
4557 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4560 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4561 && curix < buf->b_ml.ml_usedchunks - 1)
4563 /* Adjust cached curix & curline */
4564 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4565 curix++;
4567 curchnk = buf->b_ml.ml_chunksize + curix;
4569 if (updtype == ML_CHNK_DELLINE)
4570 len = -len;
4571 curchnk->mlcs_totalsize += len;
4572 if (updtype == ML_CHNK_ADDLINE)
4574 curchnk->mlcs_numlines++;
4576 /* May resize here so we don't have to do it in both cases below */
4577 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4579 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4580 buf->b_ml.ml_chunksize = (chunksize_T *)
4581 vim_realloc(buf->b_ml.ml_chunksize,
4582 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4583 if (buf->b_ml.ml_chunksize == NULL)
4585 /* Hmmmm, Give up on offset for this buffer */
4586 buf->b_ml.ml_usedchunks = -1;
4587 return;
4591 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4593 int count; /* number of entries in block */
4594 int idx;
4595 int text_end;
4596 int linecnt;
4598 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4599 buf->b_ml.ml_chunksize + curix,
4600 (buf->b_ml.ml_usedchunks - curix) *
4601 sizeof(chunksize_T));
4602 /* Compute length of first half of lines in the split chunk */
4603 size = 0;
4604 linecnt = 0;
4605 while (curline < buf->b_ml.ml_line_count
4606 && linecnt < MLCS_MINL)
4608 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4610 buf->b_ml.ml_usedchunks = -1;
4611 return;
4613 dp = (DATA_BL *)(hp->bh_data);
4614 count = (long)(buf->b_ml.ml_locked_high) -
4615 (long)(buf->b_ml.ml_locked_low) + 1;
4616 idx = curline - buf->b_ml.ml_locked_low;
4617 curline = buf->b_ml.ml_locked_high + 1;
4618 if (idx == 0)/* first line in block, text at the end */
4619 text_end = dp->db_txt_end;
4620 else
4621 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4622 /* Compute index of last line to use in this MEMLINE */
4623 rest = count - idx;
4624 if (linecnt + rest > MLCS_MINL)
4626 idx += MLCS_MINL - linecnt - 1;
4627 linecnt = MLCS_MINL;
4629 else
4631 idx = count - 1;
4632 linecnt += rest;
4634 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4636 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4637 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4638 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4639 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4640 buf->b_ml.ml_usedchunks++;
4641 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4642 return;
4644 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4645 && curix == buf->b_ml.ml_usedchunks - 1
4646 && buf->b_ml.ml_line_count - line <= 1)
4649 * We are in the last chunk and it is cheap to crate a new one
4650 * after this. Do it now to avoid the loop above later on
4652 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4653 buf->b_ml.ml_usedchunks++;
4654 if (line == buf->b_ml.ml_line_count)
4656 curchnk->mlcs_numlines = 0;
4657 curchnk->mlcs_totalsize = 0;
4659 else
4662 * Line is just prior to last, move count for last
4663 * This is the common case when loading a new file
4665 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4666 if (hp == NULL)
4668 buf->b_ml.ml_usedchunks = -1;
4669 return;
4671 dp = (DATA_BL *)(hp->bh_data);
4672 if (dp->db_line_count == 1)
4673 rest = dp->db_txt_end - dp->db_txt_start;
4674 else
4675 rest =
4676 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4677 - dp->db_txt_start;
4678 curchnk->mlcs_totalsize = rest;
4679 curchnk->mlcs_numlines = 1;
4680 curchnk[-1].mlcs_totalsize -= rest;
4681 curchnk[-1].mlcs_numlines -= 1;
4685 else if (updtype == ML_CHNK_DELLINE)
4687 curchnk->mlcs_numlines--;
4688 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4689 if (curix < (buf->b_ml.ml_usedchunks - 1)
4690 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4691 <= MLCS_MINL)
4693 curix++;
4694 curchnk = buf->b_ml.ml_chunksize + curix;
4696 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4698 buf->b_ml.ml_usedchunks--;
4699 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4700 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4701 return;
4703 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4704 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4705 > MLCS_MINL))
4707 return;
4710 /* Collapse chunks */
4711 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4712 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4713 buf->b_ml.ml_usedchunks--;
4714 if (curix < buf->b_ml.ml_usedchunks)
4716 mch_memmove(buf->b_ml.ml_chunksize + curix,
4717 buf->b_ml.ml_chunksize + curix + 1,
4718 (buf->b_ml.ml_usedchunks - curix) *
4719 sizeof(chunksize_T));
4721 return;
4723 ml_upd_lastbuf = buf;
4724 ml_upd_lastline = line;
4725 ml_upd_lastcurline = curline;
4726 ml_upd_lastcurix = curix;
4730 * Find offset for line or line with offset.
4731 * Find line with offset if "lnum" is 0; return remaining offset in offp
4732 * Find offset of line if "lnum" > 0
4733 * return -1 if information is not available
4735 long
4736 ml_find_line_or_offset(buf, lnum, offp)
4737 buf_T *buf;
4738 linenr_T lnum;
4739 long *offp;
4741 linenr_T curline;
4742 int curix;
4743 long size;
4744 bhdr_T *hp;
4745 DATA_BL *dp;
4746 int count; /* number of entries in block */
4747 int idx;
4748 int start_idx;
4749 int text_end;
4750 long offset;
4751 int len;
4752 int ffdos = (get_fileformat(buf) == EOL_DOS);
4753 int extra = 0;
4755 /* take care of cached line first */
4756 ml_flush_line(curbuf);
4758 if (buf->b_ml.ml_usedchunks == -1
4759 || buf->b_ml.ml_chunksize == NULL
4760 || lnum < 0)
4761 return -1;
4763 if (offp == NULL)
4764 offset = 0;
4765 else
4766 offset = *offp;
4767 if (lnum == 0 && offset <= 0)
4768 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4770 * Find the last chunk before the one containing our line. Last chunk is
4771 * special because it will never qualify
4773 curline = 1;
4774 curix = size = 0;
4775 while (curix < buf->b_ml.ml_usedchunks - 1
4776 && ((lnum != 0
4777 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4778 || (offset != 0
4779 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4780 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4782 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4783 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4784 if (offset && ffdos)
4785 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4786 curix++;
4789 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4791 if (curline > buf->b_ml.ml_line_count
4792 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4793 return -1;
4794 dp = (DATA_BL *)(hp->bh_data);
4795 count = (long)(buf->b_ml.ml_locked_high) -
4796 (long)(buf->b_ml.ml_locked_low) + 1;
4797 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4798 if (idx == 0)/* first line in block, text at the end */
4799 text_end = dp->db_txt_end;
4800 else
4801 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4802 /* Compute index of last line to use in this MEMLINE */
4803 if (lnum != 0)
4805 if (curline + (count - idx) >= lnum)
4806 idx += lnum - curline - 1;
4807 else
4808 idx = count - 1;
4810 else
4812 extra = 0;
4813 while (offset >= size
4814 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4815 + ffdos)
4817 if (ffdos)
4818 size++;
4819 if (idx == count - 1)
4821 extra = 1;
4822 break;
4824 idx++;
4827 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4828 size += len;
4829 if (offset != 0 && size >= offset)
4831 if (size + ffdos == offset)
4832 *offp = 0;
4833 else if (idx == start_idx)
4834 *offp = offset - size + len;
4835 else
4836 *offp = offset - size + len
4837 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4838 curline += idx - start_idx + extra;
4839 if (curline > buf->b_ml.ml_line_count)
4840 return -1; /* exactly one byte beyond the end */
4841 return curline;
4843 curline = buf->b_ml.ml_locked_high + 1;
4846 if (lnum != 0)
4848 /* Count extra CR characters. */
4849 if (ffdos)
4850 size += lnum - 1;
4852 /* Don't count the last line break if 'bin' and 'noeol'. */
4853 if (buf->b_p_bin && !buf->b_p_eol)
4854 size -= ffdos + 1;
4857 return size;
4861 * Goto byte in buffer with offset 'cnt'.
4863 void
4864 goto_byte(cnt)
4865 long cnt;
4867 long boff = cnt;
4868 linenr_T lnum;
4870 ml_flush_line(curbuf); /* cached line may be dirty */
4871 setpcmark();
4872 if (boff)
4873 --boff;
4874 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4875 if (lnum < 1) /* past the end */
4877 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4878 curwin->w_curswant = MAXCOL;
4879 coladvance((colnr_T)MAXCOL);
4881 else
4883 curwin->w_cursor.lnum = lnum;
4884 curwin->w_cursor.col = (colnr_T)boff;
4885 # ifdef FEAT_VIRTUALEDIT
4886 curwin->w_cursor.coladd = 0;
4887 # endif
4888 curwin->w_set_curswant = TRUE;
4890 check_cursor();
4892 # ifdef FEAT_MBYTE
4893 /* Make sure the cursor is on the first byte of a multi-byte char. */
4894 if (has_mbyte)
4895 mb_adjust_cursor();
4896 # endif
4898 #endif