Merge branch 'vim'
[vim_extended.git] / src / memline.c
blob84ce2d585c1c8b40a61d758db22ef1f32e7b681c
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 need_wait_return = TRUE; /* call wait_return later */
594 ++no_wait_return;
595 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
596 buf_spname(buf) != NULL
597 ? (char_u *)buf_spname(buf)
598 : buf->b_fname);
599 --no_wait_return;
602 /* don't try to open a swap file again */
603 buf->b_may_swap = FALSE;
607 * If still need to create a swap file, and starting to edit a not-readonly
608 * file, or reading into an existing buffer, create a swap file now.
610 void
611 check_need_swap(newfile)
612 int newfile; /* reading file into new buffer */
614 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
615 ml_open_file(curbuf);
619 * Close memline for buffer 'buf'.
620 * If 'del_file' is TRUE, delete the swap file
622 void
623 ml_close(buf, del_file)
624 buf_T *buf;
625 int del_file;
627 if (buf->b_ml.ml_mfp == NULL) /* not open */
628 return;
629 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
630 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
631 vim_free(buf->b_ml.ml_line_ptr);
632 vim_free(buf->b_ml.ml_stack);
633 #ifdef FEAT_BYTEOFF
634 vim_free(buf->b_ml.ml_chunksize);
635 buf->b_ml.ml_chunksize = NULL;
636 #endif
637 buf->b_ml.ml_mfp = NULL;
639 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
640 * this buffer is loaded. */
641 buf->b_flags &= ~BF_RECOVERED;
645 * Close all existing memlines and memfiles.
646 * Only used when exiting.
647 * When 'del_file' is TRUE, delete the memfiles.
648 * But don't delete files that were ":preserve"d when we are POSIX compatible.
650 void
651 ml_close_all(del_file)
652 int del_file;
654 buf_T *buf;
656 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
657 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
658 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
659 #ifdef TEMPDIRNAMES
660 vim_deltempdir(); /* delete created temp directory */
661 #endif
665 * Close all memfiles for not modified buffers.
666 * Only use just before exiting!
668 void
669 ml_close_notmod()
671 buf_T *buf;
673 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
674 if (!bufIsChanged(buf))
675 ml_close(buf, TRUE); /* close all not-modified buffers */
679 * Update the timestamp in the .swp file.
680 * Used when the file has been written.
682 void
683 ml_timestamp(buf)
684 buf_T *buf;
686 ml_upd_block0(buf, TRUE);
690 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
692 static void
693 ml_upd_block0(buf, set_fname)
694 buf_T *buf;
695 int set_fname;
697 memfile_T *mfp;
698 bhdr_T *hp;
699 ZERO_BL *b0p;
701 mfp = buf->b_ml.ml_mfp;
702 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
703 return;
704 b0p = (ZERO_BL *)(hp->bh_data);
705 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
706 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
707 else
709 if (set_fname)
710 set_b0_fname(b0p, buf);
711 else
712 set_b0_dir_flag(b0p, buf);
714 mf_put(mfp, hp, TRUE, FALSE);
718 * Write file name and timestamp into block 0 of a swap file.
719 * Also set buf->b_mtime.
720 * Don't use NameBuff[]!!!
722 static void
723 set_b0_fname(b0p, buf)
724 ZERO_BL *b0p;
725 buf_T *buf;
727 struct stat st;
729 if (buf->b_ffname == NULL)
730 b0p->b0_fname[0] = NUL;
731 else
733 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
734 /* Systems that cannot translate "~user" back into a path: copy the
735 * file name unmodified. Do use slashes instead of backslashes for
736 * portability. */
737 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
738 # ifdef BACKSLASH_IN_FILENAME
739 forward_slash(b0p->b0_fname);
740 # endif
741 #else
742 size_t flen, ulen;
743 char_u uname[B0_UNAME_SIZE];
746 * For a file under the home directory of the current user, we try to
747 * replace the home directory path with "~user". This helps when
748 * editing the same file on different machines over a network.
749 * First replace home dir path with "~/" with home_replace().
750 * Then insert the user name to get "~user/".
752 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
753 if (b0p->b0_fname[0] == '~')
755 flen = STRLEN(b0p->b0_fname);
756 /* If there is no user name or it is too long, don't use "~/" */
757 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
758 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
759 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
760 else
762 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
763 mch_memmove(b0p->b0_fname + 1, uname, ulen);
766 #endif
767 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
769 long_to_char((long)st.st_mtime, b0p->b0_mtime);
770 #ifdef CHECK_INODE
771 long_to_char((long)st.st_ino, b0p->b0_ino);
772 #endif
773 buf_store_time(buf, &st, buf->b_ffname);
774 buf->b_mtime_read = buf->b_mtime;
776 else
778 long_to_char(0L, b0p->b0_mtime);
779 #ifdef CHECK_INODE
780 long_to_char(0L, b0p->b0_ino);
781 #endif
782 buf->b_mtime = 0;
783 buf->b_mtime_read = 0;
784 buf->b_orig_size = 0;
785 buf->b_orig_mode = 0;
789 #ifdef FEAT_MBYTE
790 /* Also add the 'fileencoding' if there is room. */
791 add_b0_fenc(b0p, curbuf);
792 #endif
796 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
797 * swapfile for "buf" are in the same directory.
798 * This is fail safe: if we are not sure the directories are equal the flag is
799 * not set.
801 static void
802 set_b0_dir_flag(b0p, buf)
803 ZERO_BL *b0p;
804 buf_T *buf;
806 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
807 b0p->b0_flags |= B0_SAME_DIR;
808 else
809 b0p->b0_flags &= ~B0_SAME_DIR;
812 #ifdef FEAT_MBYTE
814 * When there is room, add the 'fileencoding' to block zero.
816 static void
817 add_b0_fenc(b0p, buf)
818 ZERO_BL *b0p;
819 buf_T *buf;
821 int n;
823 n = (int)STRLEN(buf->b_p_fenc);
824 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
825 b0p->b0_flags &= ~B0_HAS_FENC;
826 else
828 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
829 (char *)buf->b_p_fenc, (size_t)n);
830 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
831 b0p->b0_flags |= B0_HAS_FENC;
834 #endif
838 * try to recover curbuf from the .swp file
840 void
841 ml_recover()
843 buf_T *buf = NULL;
844 memfile_T *mfp = NULL;
845 char_u *fname;
846 bhdr_T *hp = NULL;
847 ZERO_BL *b0p;
848 int b0_ff;
849 char_u *b0_fenc = NULL;
850 PTR_BL *pp;
851 DATA_BL *dp;
852 infoptr_T *ip;
853 blocknr_T bnum;
854 int page_count;
855 struct stat org_stat, swp_stat;
856 int len;
857 int directly;
858 linenr_T lnum;
859 char_u *p;
860 int i;
861 long error;
862 int cannot_open;
863 linenr_T line_count;
864 int has_error;
865 int idx;
866 int top;
867 int txt_start;
868 off_t size;
869 int called_from_main;
870 int serious_error = TRUE;
871 long mtime;
872 int attr;
874 recoverymode = TRUE;
875 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
876 attr = hl_attr(HLF_E);
879 * If the file name ends in ".s[uvw][a-z]" we assume this is the swap file.
880 * Otherwise a search is done to find the swap file(s).
882 fname = curbuf->b_fname;
883 if (fname == NULL) /* When there is no file name */
884 fname = (char_u *)"";
885 len = (int)STRLEN(fname);
886 if (len >= 4 &&
887 #if defined(VMS) || defined(RISCOS)
888 STRNICMP(fname + len - 4, "_s" , 2)
889 #else
890 STRNICMP(fname + len - 4, ".s" , 2)
891 #endif
892 == 0
893 && vim_strchr((char_u *)"UVWuvw", fname[len - 2]) != NULL
894 && ASCII_ISALPHA(fname[len - 1]))
896 directly = TRUE;
897 fname = vim_strsave(fname); /* make a copy for mf_open() */
899 else
901 directly = FALSE;
903 /* count the number of matching swap files */
904 len = recover_names(&fname, FALSE, 0);
905 if (len == 0) /* no swap files found */
907 EMSG2(_("E305: No swap file found for %s"), fname);
908 goto theend;
910 if (len == 1) /* one swap file found, use it */
911 i = 1;
912 else /* several swap files found, choose */
914 /* list the names of the swap files */
915 (void)recover_names(&fname, TRUE, 0);
916 msg_putchar('\n');
917 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
918 i = get_number(FALSE, NULL);
919 if (i < 1 || i > len)
920 goto theend;
922 /* get the swap file name that will be used */
923 (void)recover_names(&fname, FALSE, i);
925 if (fname == NULL)
926 goto theend; /* out of memory */
928 /* When called from main() still need to initialize storage structure */
929 if (called_from_main && ml_open(curbuf) == FAIL)
930 getout(1);
933 * allocate a buffer structure (only the memline in it is really used)
935 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
936 if (buf == NULL)
938 vim_free(fname);
939 goto theend;
943 * init fields in memline struct
945 buf->b_ml.ml_stack_size = 0; /* no stack yet */
946 buf->b_ml.ml_stack = NULL; /* no stack yet */
947 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
948 buf->b_ml.ml_line_lnum = 0; /* no cached line */
949 buf->b_ml.ml_locked = NULL; /* no locked block */
950 buf->b_ml.ml_flags = 0;
953 * open the memfile from the old swap file
955 p = vim_strsave(fname); /* save fname for the message
956 (mf_open() may free fname) */
957 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
958 if (mfp == NULL || mfp->mf_fd < 0)
960 if (p != NULL)
962 EMSG2(_("E306: Cannot open %s"), p);
963 vim_free(p);
965 goto theend;
967 vim_free(p);
968 buf->b_ml.ml_mfp = mfp;
971 * The page size set in mf_open() might be different from the page size
972 * used in the swap file, we must get it from block 0. But to read block
973 * 0 we need a page size. Use the minimal size for block 0 here, it will
974 * be set to the real value below.
976 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
979 * try to read block 0
981 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
983 msg_start();
984 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
985 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
986 MSG_PUTS_ATTR(
987 _("\nMaybe no changes were made or Vim did not update the swap file."),
988 attr | MSG_HIST);
989 msg_end();
990 goto theend;
992 b0p = (ZERO_BL *)(hp->bh_data);
993 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
995 msg_start();
996 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
997 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
998 MSG_HIST);
999 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
1000 msg_end();
1001 goto theend;
1003 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
1005 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
1006 goto theend;
1008 if (b0_magic_wrong(b0p))
1010 msg_start();
1011 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1012 #if defined(MSDOS) || defined(MSWIN)
1013 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1014 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1015 attr | MSG_HIST);
1016 else
1017 #endif
1018 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1019 attr | MSG_HIST);
1020 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1021 /* avoid going past the end of a currupted hostname */
1022 b0p->b0_fname[0] = NUL;
1023 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1024 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1025 msg_end();
1026 goto theend;
1030 * If we guessed the wrong page size, we have to recalculate the
1031 * highest block number in the file.
1033 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1035 unsigned previous_page_size = mfp->mf_page_size;
1037 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1038 if (mfp->mf_page_size < previous_page_size)
1040 msg_start();
1041 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1042 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1043 attr | MSG_HIST);
1044 msg_end();
1045 goto theend;
1047 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1048 mfp->mf_blocknr_max = 0; /* no file or empty file */
1049 else
1050 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1051 mfp->mf_infile_count = mfp->mf_blocknr_max;
1053 /* need to reallocate the memory used to store the data */
1054 p = alloc(mfp->mf_page_size);
1055 if (p == NULL)
1056 goto theend;
1057 mch_memmove(p, hp->bh_data, previous_page_size);
1058 vim_free(hp->bh_data);
1059 hp->bh_data = p;
1060 b0p = (ZERO_BL *)(hp->bh_data);
1064 * If .swp file name given directly, use name from swap file for buffer.
1066 if (directly)
1068 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1069 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1070 goto theend;
1073 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1074 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1076 if (buf_spname(curbuf) != NULL)
1077 STRCPY(NameBuff, buf_spname(curbuf));
1078 else
1079 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1080 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1081 msg_putchar('\n');
1084 * check date of swap file and original file
1086 mtime = char_to_long(b0p->b0_mtime);
1087 if (curbuf->b_ffname != NULL
1088 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1089 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1090 && org_stat.st_mtime > swp_stat.st_mtime)
1091 || org_stat.st_mtime != mtime))
1093 EMSG(_("E308: Warning: Original file may have been changed"));
1095 out_flush();
1097 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1098 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1099 if (b0p->b0_flags & B0_HAS_FENC)
1101 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1102 p > b0p->b0_fname && p[-1] != NUL; --p)
1104 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1107 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1108 hp = NULL;
1111 * Now that we are sure that the file is going to be recovered, clear the
1112 * contents of the current buffer.
1114 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1115 ml_delete((linenr_T)1, FALSE);
1118 * Try reading the original file to obtain the values of 'fileformat',
1119 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1121 if (curbuf->b_ffname != NULL)
1123 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1124 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1125 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1126 ml_delete((linenr_T)1, FALSE);
1129 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1130 if (b0_ff != 0)
1131 set_fileformat(b0_ff - 1, OPT_LOCAL);
1132 if (b0_fenc != NULL)
1134 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1135 vim_free(b0_fenc);
1137 unchanged(curbuf, TRUE);
1139 bnum = 1; /* start with block 1 */
1140 page_count = 1; /* which is 1 page */
1141 lnum = 0; /* append after line 0 in curbuf */
1142 line_count = 0;
1143 idx = 0; /* start with first index in block 1 */
1144 error = 0;
1145 buf->b_ml.ml_stack_top = 0;
1146 buf->b_ml.ml_stack = NULL;
1147 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1149 if (curbuf->b_ffname == NULL)
1150 cannot_open = TRUE;
1151 else
1152 cannot_open = FALSE;
1154 serious_error = FALSE;
1155 for ( ; !got_int; line_breakcheck())
1157 if (hp != NULL)
1158 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1161 * get block
1163 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1165 if (bnum == 1)
1167 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1168 goto theend;
1170 ++error;
1171 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1172 (colnr_T)0, TRUE);
1174 else /* there is a block */
1176 pp = (PTR_BL *)(hp->bh_data);
1177 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1179 /* check line count when using pointer block first time */
1180 if (idx == 0 && line_count != 0)
1182 for (i = 0; i < (int)pp->pb_count; ++i)
1183 line_count -= pp->pb_pointer[i].pe_line_count;
1184 if (line_count != 0)
1186 ++error;
1187 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1188 (colnr_T)0, TRUE);
1192 if (pp->pb_count == 0)
1194 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1195 (colnr_T)0, TRUE);
1196 ++error;
1198 else if (idx < (int)pp->pb_count) /* go a block deeper */
1200 if (pp->pb_pointer[idx].pe_bnum < 0)
1203 * Data block with negative block number.
1204 * Try to read lines from the original file.
1205 * This is slow, but it works.
1207 if (!cannot_open)
1209 line_count = pp->pb_pointer[idx].pe_line_count;
1210 if (readfile(curbuf->b_ffname, NULL, lnum,
1211 pp->pb_pointer[idx].pe_old_lnum - 1,
1212 line_count, NULL, 0) == FAIL)
1213 cannot_open = TRUE;
1214 else
1215 lnum += line_count;
1217 if (cannot_open)
1219 ++error;
1220 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1221 (colnr_T)0, TRUE);
1223 ++idx; /* get same block again for next index */
1224 continue;
1228 * going one block deeper in the tree
1230 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1232 ++error;
1233 break; /* out of memory */
1235 ip = &(buf->b_ml.ml_stack[top]);
1236 ip->ip_bnum = bnum;
1237 ip->ip_index = idx;
1239 bnum = pp->pb_pointer[idx].pe_bnum;
1240 line_count = pp->pb_pointer[idx].pe_line_count;
1241 page_count = pp->pb_pointer[idx].pe_page_count;
1242 continue;
1245 else /* not a pointer block */
1247 dp = (DATA_BL *)(hp->bh_data);
1248 if (dp->db_id != DATA_ID) /* block id wrong */
1250 if (bnum == 1)
1252 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1253 mfp->mf_fname);
1254 goto theend;
1256 ++error;
1257 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1258 (colnr_T)0, TRUE);
1260 else
1263 * it is a data block
1264 * Append all the lines in this block
1266 has_error = FALSE;
1268 * check length of block
1269 * if wrong, use length in pointer block
1271 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1273 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1274 (colnr_T)0, TRUE);
1275 ++error;
1276 has_error = TRUE;
1277 dp->db_txt_end = page_count * mfp->mf_page_size;
1280 /* make sure there is a NUL at the end of the block */
1281 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1284 * check number of lines in block
1285 * if wrong, use count in data block
1287 if (line_count != dp->db_line_count)
1289 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1290 (colnr_T)0, TRUE);
1291 ++error;
1292 has_error = TRUE;
1295 for (i = 0; i < dp->db_line_count; ++i)
1297 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1298 if (txt_start <= (int)HEADER_SIZE
1299 || txt_start >= (int)dp->db_txt_end)
1301 p = (char_u *)"???";
1302 ++error;
1304 else
1305 p = (char_u *)dp + txt_start;
1306 ml_append(lnum++, p, (colnr_T)0, TRUE);
1308 if (has_error)
1309 ml_append(lnum++, (char_u *)_("???END"),
1310 (colnr_T)0, TRUE);
1315 if (buf->b_ml.ml_stack_top == 0) /* finished */
1316 break;
1319 * go one block up in the tree
1321 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1322 bnum = ip->ip_bnum;
1323 idx = ip->ip_index + 1; /* go to next index */
1324 page_count = 1;
1328 * The dummy line from the empty buffer will now be after the last line in
1329 * the buffer. Delete it.
1331 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1332 curbuf->b_flags |= BF_RECOVERED;
1334 recoverymode = FALSE;
1335 if (got_int)
1336 EMSG(_("E311: Recovery Interrupted"));
1337 else if (error)
1339 ++no_wait_return;
1340 MSG(">>>>>>>>>>>>>");
1341 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1342 --no_wait_return;
1343 MSG(_("See \":help E312\" for more information."));
1344 MSG(">>>>>>>>>>>>>");
1346 else
1348 MSG(_("Recovery completed. You should check if everything is OK."));
1349 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1350 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1351 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1352 cmdline_row = msg_row;
1354 redraw_curbuf_later(NOT_VALID);
1356 theend:
1357 recoverymode = FALSE;
1358 if (mfp != NULL)
1360 if (hp != NULL)
1361 mf_put(mfp, hp, FALSE, FALSE);
1362 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1364 if (buf != NULL)
1366 vim_free(buf->b_ml.ml_stack);
1367 vim_free(buf);
1369 if (serious_error && called_from_main)
1370 ml_close(curbuf, TRUE);
1371 #ifdef FEAT_AUTOCMD
1372 else
1374 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1375 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1377 #endif
1378 return;
1382 * Find the names of swap files in current directory and the directory given
1383 * with the 'directory' option.
1385 * Used to:
1386 * - list the swap files for "vim -r"
1387 * - count the number of swap files when recovering
1388 * - list the swap files when recovering
1389 * - find the name of the n'th swap file when recovering
1392 recover_names(fname, list, nr)
1393 char_u **fname; /* base for swap file name */
1394 int list; /* when TRUE, list the swap file names */
1395 int nr; /* when non-zero, return nr'th swap file name */
1397 int num_names;
1398 char_u *(names[6]);
1399 char_u *tail;
1400 char_u *p;
1401 int num_files;
1402 int file_count = 0;
1403 char_u **files;
1404 int i;
1405 char_u *dirp;
1406 char_u *dir_name;
1407 char_u *fname_res = NULL;
1408 #ifdef HAVE_READLINK
1409 char_u fname_buf[MAXPATHL];
1410 #endif
1412 if (fname != NULL)
1414 #ifdef HAVE_READLINK
1415 /* Expand symlink in the file name, because the swap file is created with
1416 * the actual file instead of with the symlink. */
1417 if (resolve_symlink(*fname, fname_buf) == OK)
1418 fname_res = fname_buf;
1419 else
1420 #endif
1421 fname_res = *fname;
1424 if (list)
1426 /* use msg() to start the scrolling properly */
1427 msg((char_u *)_("Swap files found:"));
1428 msg_putchar('\n');
1432 * Do the loop for every directory in 'directory'.
1433 * First allocate some memory to put the directory name in.
1435 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1436 dirp = p_dir;
1437 while (dir_name != NULL && *dirp)
1440 * Isolate a directory name from *dirp and put it in dir_name (we know
1441 * it is large enough, so use 31000 for length).
1442 * Advance dirp to next directory name.
1444 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1446 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1448 if (fname == NULL || *fname == NULL)
1450 #ifdef VMS
1451 names[0] = vim_strsave((char_u *)"*_sw%");
1452 #else
1453 # ifdef RISCOS
1454 names[0] = vim_strsave((char_u *)"*_sw#");
1455 # else
1456 names[0] = vim_strsave((char_u *)"*.sw?");
1457 # endif
1458 #endif
1459 #if defined(UNIX) || defined(WIN3264)
1460 /* For Unix names starting with a dot are special. MS-Windows
1461 * supports this too, on some file systems. */
1462 names[1] = vim_strsave((char_u *)".*.sw?");
1463 names[2] = vim_strsave((char_u *)".sw?");
1464 num_names = 3;
1465 #else
1466 # ifdef VMS
1467 names[1] = vim_strsave((char_u *)".*_sw%");
1468 num_names = 2;
1469 # else
1470 num_names = 1;
1471 # endif
1472 #endif
1474 else
1475 num_names = recov_file_names(names, fname_res, TRUE);
1477 else /* check directory dir_name */
1479 if (fname == NULL || *fname == NULL)
1481 #ifdef VMS
1482 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1483 #else
1484 # ifdef RISCOS
1485 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1486 # else
1487 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1488 # endif
1489 #endif
1490 #if defined(UNIX) || defined(WIN3264)
1491 /* For Unix names starting with a dot are special. MS-Windows
1492 * supports this too, on some file systems. */
1493 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1494 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1495 num_names = 3;
1496 #else
1497 # ifdef VMS
1498 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1499 num_names = 2;
1500 # else
1501 num_names = 1;
1502 # endif
1503 #endif
1505 else
1507 #if defined(UNIX) || defined(WIN3264)
1508 p = dir_name + STRLEN(dir_name);
1509 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1511 /* Ends with '//', Use Full path for swap name */
1512 tail = make_percent_swname(dir_name, fname_res);
1514 else
1515 #endif
1517 tail = gettail(fname_res);
1518 tail = concat_fnames(dir_name, tail, TRUE);
1520 if (tail == NULL)
1521 num_names = 0;
1522 else
1524 num_names = recov_file_names(names, tail, FALSE);
1525 vim_free(tail);
1530 /* check for out-of-memory */
1531 for (i = 0; i < num_names; ++i)
1533 if (names[i] == NULL)
1535 for (i = 0; i < num_names; ++i)
1536 vim_free(names[i]);
1537 num_names = 0;
1540 if (num_names == 0)
1541 num_files = 0;
1542 else if (expand_wildcards(num_names, names, &num_files, &files,
1543 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1544 num_files = 0;
1547 * When no swap file found, wildcard expansion might have failed (e.g.
1548 * not able to execute the shell).
1549 * Try finding a swap file by simply adding ".swp" to the file name.
1551 if (*dirp == NUL && file_count + num_files == 0
1552 && fname != NULL && *fname != NULL)
1554 struct stat st;
1555 char_u *swapname;
1557 swapname = modname(fname_res,
1558 #if defined(VMS) || defined(RISCOS)
1559 (char_u *)"_swp", FALSE
1560 #else
1561 (char_u *)".swp", TRUE
1562 #endif
1564 if (swapname != NULL)
1566 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1568 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1569 if (files != NULL)
1571 files[0] = swapname;
1572 swapname = NULL;
1573 num_files = 1;
1576 vim_free(swapname);
1581 * remove swapfile name of the current buffer, it must be ignored
1583 if (curbuf->b_ml.ml_mfp != NULL
1584 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1586 for (i = 0; i < num_files; ++i)
1587 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1589 /* Remove the name from files[i]. Move further entries
1590 * down. When the array becomes empty free it here, since
1591 * FreeWild() won't be called below. */
1592 vim_free(files[i]);
1593 if (--num_files == 0)
1594 vim_free(files);
1595 else
1596 for ( ; i < num_files; ++i)
1597 files[i] = files[i + 1];
1600 if (nr > 0)
1602 file_count += num_files;
1603 if (nr <= file_count)
1605 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1606 dirp = (char_u *)""; /* stop searching */
1609 else if (list)
1611 if (dir_name[0] == '.' && dir_name[1] == NUL)
1613 if (fname == NULL || *fname == NULL)
1614 MSG_PUTS(_(" In current directory:\n"));
1615 else
1616 MSG_PUTS(_(" Using specified name:\n"));
1618 else
1620 MSG_PUTS(_(" In directory "));
1621 msg_home_replace(dir_name);
1622 MSG_PUTS(":\n");
1625 if (num_files)
1627 for (i = 0; i < num_files; ++i)
1629 /* print the swap file name */
1630 msg_outnum((long)++file_count);
1631 MSG_PUTS(". ");
1632 msg_puts(gettail(files[i]));
1633 msg_putchar('\n');
1634 (void)swapfile_info(files[i]);
1637 else
1638 MSG_PUTS(_(" -- none --\n"));
1639 out_flush();
1641 else
1642 file_count += num_files;
1644 for (i = 0; i < num_names; ++i)
1645 vim_free(names[i]);
1646 if (num_files > 0)
1647 FreeWild(num_files, files);
1649 vim_free(dir_name);
1650 return file_count;
1653 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1655 * Append the full path to name with path separators made into percent
1656 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1658 static char_u *
1659 make_percent_swname(dir, name)
1660 char_u *dir;
1661 char_u *name;
1663 char_u *d, *s, *f;
1665 f = fix_fname(name != NULL ? name : (char_u *) "");
1666 d = NULL;
1667 if (f != NULL)
1669 s = alloc((unsigned)(STRLEN(f) + 1));
1670 if (s != NULL)
1672 STRCPY(s, f);
1673 for (d = s; *d != NUL; mb_ptr_adv(d))
1674 if (vim_ispathsep(*d))
1675 *d = '%';
1676 d = concat_fnames(dir, s, TRUE);
1677 vim_free(s);
1679 vim_free(f);
1681 return d;
1683 #endif
1685 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1686 static int process_still_running;
1687 #endif
1690 * Give information about an existing swap file.
1691 * Returns timestamp (0 when unknown).
1693 static time_t
1694 swapfile_info(fname)
1695 char_u *fname;
1697 struct stat st;
1698 int fd;
1699 struct block0 b0;
1700 time_t x = (time_t)0;
1701 char *p;
1702 #ifdef UNIX
1703 char_u uname[B0_UNAME_SIZE];
1704 #endif
1706 /* print the swap file date */
1707 if (mch_stat((char *)fname, &st) != -1)
1709 #ifdef UNIX
1710 /* print name of owner of the file */
1711 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1713 MSG_PUTS(_(" owned by: "));
1714 msg_outtrans(uname);
1715 MSG_PUTS(_(" dated: "));
1717 else
1718 #endif
1719 MSG_PUTS(_(" dated: "));
1720 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1721 p = ctime(&x); /* includes '\n' */
1722 if (p == NULL)
1723 MSG_PUTS("(invalid)\n");
1724 else
1725 MSG_PUTS(p);
1729 * print the original file name
1731 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1732 if (fd >= 0)
1734 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1736 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1738 MSG_PUTS(_(" [from Vim version 3.0]"));
1740 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1742 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1744 else
1746 MSG_PUTS(_(" file name: "));
1747 if (b0.b0_fname[0] == NUL)
1748 MSG_PUTS(_("[No Name]"));
1749 else
1750 msg_outtrans(b0.b0_fname);
1752 MSG_PUTS(_("\n modified: "));
1753 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1755 if (*(b0.b0_uname) != NUL)
1757 MSG_PUTS(_("\n user name: "));
1758 msg_outtrans(b0.b0_uname);
1761 if (*(b0.b0_hname) != NUL)
1763 if (*(b0.b0_uname) != NUL)
1764 MSG_PUTS(_(" host name: "));
1765 else
1766 MSG_PUTS(_("\n host name: "));
1767 msg_outtrans(b0.b0_hname);
1770 if (char_to_long(b0.b0_pid) != 0L)
1772 MSG_PUTS(_("\n process ID: "));
1773 msg_outnum(char_to_long(b0.b0_pid));
1774 #if defined(UNIX) || defined(__EMX__)
1775 /* EMX kill() not working correctly, it seems */
1776 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1778 MSG_PUTS(_(" (still running)"));
1779 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1780 process_still_running = TRUE;
1781 # endif
1783 #endif
1786 if (b0_magic_wrong(&b0))
1788 #if defined(MSDOS) || defined(MSWIN)
1789 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1790 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1791 else
1792 #endif
1793 MSG_PUTS(_("\n [not usable on this computer]"));
1797 else
1798 MSG_PUTS(_(" [cannot be read]"));
1799 close(fd);
1801 else
1802 MSG_PUTS(_(" [cannot be opened]"));
1803 msg_putchar('\n');
1805 return x;
1808 static int
1809 recov_file_names(names, path, prepend_dot)
1810 char_u **names;
1811 char_u *path;
1812 int prepend_dot;
1814 int num_names;
1816 #ifdef SHORT_FNAME
1818 * (MS-DOS) always short names
1820 names[0] = modname(path, (char_u *)".sw?", FALSE);
1821 num_names = 1;
1822 #else /* !SHORT_FNAME */
1824 * (Win32 and Win64) never short names, but do prepend a dot.
1825 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1826 * Only use the short name if it is different.
1828 char_u *p;
1829 int i;
1830 # ifndef WIN3264
1831 int shortname = curbuf->b_shortname;
1833 curbuf->b_shortname = FALSE;
1834 # endif
1836 num_names = 0;
1839 * May also add the file name with a dot prepended, for swap file in same
1840 * dir as original file.
1842 if (prepend_dot)
1844 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1845 if (names[num_names] == NULL)
1846 goto end;
1847 ++num_names;
1851 * Form the normal swap file name pattern by appending ".sw?".
1853 #ifdef VMS
1854 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1855 #else
1856 # ifdef RISCOS
1857 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1858 # else
1859 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1860 # endif
1861 #endif
1862 if (names[num_names] == NULL)
1863 goto end;
1864 if (num_names >= 1) /* check if we have the same name twice */
1866 p = names[num_names - 1];
1867 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1868 if (i > 0)
1869 p += i; /* file name has been expanded to full path */
1871 if (STRCMP(p, names[num_names]) != 0)
1872 ++num_names;
1873 else
1874 vim_free(names[num_names]);
1876 else
1877 ++num_names;
1879 # ifndef WIN3264
1881 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1883 curbuf->b_shortname = TRUE;
1884 #ifdef VMS
1885 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1886 #else
1887 # ifdef RISCOS
1888 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1889 # else
1890 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1891 # endif
1892 #endif
1893 if (names[num_names] == NULL)
1894 goto end;
1897 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1899 p = names[num_names];
1900 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1901 if (i > 0)
1902 p += i; /* file name has been expanded to full path */
1903 if (STRCMP(names[num_names - 1], p) == 0)
1904 vim_free(names[num_names]);
1905 else
1906 ++num_names;
1907 # endif
1909 end:
1910 # ifndef WIN3264
1911 curbuf->b_shortname = shortname;
1912 # endif
1914 #endif /* !SHORT_FNAME */
1916 return num_names;
1920 * sync all memlines
1922 * If 'check_file' is TRUE, check if original file exists and was not changed.
1923 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1924 * always sync at least one block.
1926 void
1927 ml_sync_all(check_file, check_char)
1928 int check_file;
1929 int check_char;
1931 buf_T *buf;
1932 struct stat st;
1934 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1936 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1937 continue; /* no file */
1939 ml_flush_line(buf); /* flush buffered line */
1940 /* flush locked block */
1941 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1942 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1943 && buf->b_ffname != NULL)
1946 * If the original file does not exist anymore or has been changed
1947 * call ml_preserve() to get rid of all negative numbered blocks.
1949 if (mch_stat((char *)buf->b_ffname, &st) == -1
1950 || st.st_mtime != buf->b_mtime_read
1951 || (size_t)st.st_size != buf->b_orig_size)
1953 ml_preserve(buf, FALSE);
1954 did_check_timestamps = FALSE;
1955 need_check_timestamps = TRUE; /* give message later */
1958 if (buf->b_ml.ml_mfp->mf_dirty)
1960 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1961 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1962 if (check_char && ui_char_avail()) /* character available now */
1963 break;
1969 * sync one buffer, including negative blocks
1971 * after this all the blocks are in the swap file
1973 * Used for the :preserve command and when the original file has been
1974 * changed or deleted.
1976 * when message is TRUE the success of preserving is reported
1978 void
1979 ml_preserve(buf, message)
1980 buf_T *buf;
1981 int message;
1983 bhdr_T *hp;
1984 linenr_T lnum;
1985 memfile_T *mfp = buf->b_ml.ml_mfp;
1986 int status;
1987 int got_int_save = got_int;
1989 if (mfp == NULL || mfp->mf_fname == NULL)
1991 if (message)
1992 EMSG(_("E313: Cannot preserve, there is no swap file"));
1993 return;
1996 /* We only want to stop when interrupted here, not when interrupted
1997 * before. */
1998 got_int = FALSE;
2000 ml_flush_line(buf); /* flush buffered line */
2001 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2002 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
2004 /* stack is invalid after mf_sync(.., MFS_ALL) */
2005 buf->b_ml.ml_stack_top = 0;
2008 * Some of the data blocks may have been changed from negative to
2009 * positive block number. In that case the pointer blocks need to be
2010 * updated.
2012 * We don't know in which pointer block the references are, so we visit
2013 * all data blocks until there are no more translations to be done (or
2014 * we hit the end of the file, which can only happen in case a write fails,
2015 * e.g. when file system if full).
2016 * ml_find_line() does the work by translating the negative block numbers
2017 * when getting the first line of each data block.
2019 if (mf_need_trans(mfp) && !got_int)
2021 lnum = 1;
2022 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2024 hp = ml_find_line(buf, lnum, ML_FIND);
2025 if (hp == NULL)
2027 status = FAIL;
2028 goto theend;
2030 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2031 lnum = buf->b_ml.ml_locked_high + 1;
2033 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2034 /* sync the updated pointer blocks */
2035 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2036 status = FAIL;
2037 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2039 theend:
2040 got_int |= got_int_save;
2042 if (message)
2044 if (status == OK)
2045 MSG(_("File preserved"));
2046 else
2047 EMSG(_("E314: Preserve failed"));
2052 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2053 * until the next call!
2054 * line1 = ml_get(1);
2055 * line2 = ml_get(2); // line1 is now invalid!
2056 * Make a copy of the line if necessary.
2059 * get a pointer to a (read-only copy of a) line
2061 * On failure an error message is given and IObuff is returned (to avoid
2062 * having to check for error everywhere).
2064 char_u *
2065 ml_get(lnum)
2066 linenr_T lnum;
2068 return ml_get_buf(curbuf, lnum, FALSE);
2072 * ml_get_pos: get pointer to position 'pos'
2074 char_u *
2075 ml_get_pos(pos)
2076 pos_T *pos;
2078 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2082 * ml_get_curline: get pointer to cursor line.
2084 char_u *
2085 ml_get_curline()
2087 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2091 * ml_get_cursor: get pointer to cursor position
2093 char_u *
2094 ml_get_cursor()
2096 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2097 curwin->w_cursor.col);
2101 * get a pointer to a line in a specific buffer
2103 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2104 * changed)
2106 char_u *
2107 ml_get_buf(buf, lnum, will_change)
2108 buf_T *buf;
2109 linenr_T lnum;
2110 int will_change; /* line will be changed */
2112 bhdr_T *hp;
2113 DATA_BL *dp;
2114 char_u *ptr;
2115 static int recursive = 0;
2117 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2119 if (recursive == 0)
2121 /* Avoid giving this message for a recursive call, may happen when
2122 * the GUI redraws part of the text. */
2123 ++recursive;
2124 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2125 --recursive;
2127 errorret:
2128 STRCPY(IObuff, "???");
2129 return IObuff;
2131 if (lnum <= 0) /* pretend line 0 is line 1 */
2132 lnum = 1;
2134 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2135 return (char_u *)"";
2138 * See if it is the same line as requested last time.
2139 * Otherwise may need to flush last used line.
2140 * Don't use the last used line when 'swapfile' is reset, need to load all
2141 * blocks.
2143 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2145 ml_flush_line(buf);
2148 * Find the data block containing the line.
2149 * This also fills the stack with the blocks from the root to the data
2150 * block and releases any locked block.
2152 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2154 if (recursive == 0)
2156 /* Avoid giving this message for a recursive call, may happen
2157 * when the GUI redraws part of the text. */
2158 ++recursive;
2159 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2160 --recursive;
2162 goto errorret;
2165 dp = (DATA_BL *)(hp->bh_data);
2167 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2168 buf->b_ml.ml_line_ptr = ptr;
2169 buf->b_ml.ml_line_lnum = lnum;
2170 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2172 if (will_change)
2173 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2175 return buf->b_ml.ml_line_ptr;
2179 * Check if a line that was just obtained by a call to ml_get
2180 * is in allocated memory.
2183 ml_line_alloced()
2185 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2189 * Append a line after lnum (may be 0 to insert a line in front of the file).
2190 * "line" does not need to be allocated, but can't be another line in a
2191 * buffer, unlocking may make it invalid.
2193 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2194 * will be set for recovery
2195 * Check: The caller of this function should probably also call
2196 * appended_lines().
2198 * return FAIL for failure, OK otherwise
2201 ml_append(lnum, line, len, newfile)
2202 linenr_T lnum; /* append after this line (can be 0) */
2203 char_u *line; /* text of the new line */
2204 colnr_T len; /* length of new line, including NUL, or 0 */
2205 int newfile; /* flag, see above */
2207 /* When starting up, we might still need to create the memfile */
2208 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2209 return FAIL;
2211 if (curbuf->b_ml.ml_line_lnum != 0)
2212 ml_flush_line(curbuf);
2213 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2216 #if defined(FEAT_SPELL) || defined(PROTO)
2218 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2219 * a memline.
2222 ml_append_buf(buf, lnum, line, len, newfile)
2223 buf_T *buf;
2224 linenr_T lnum; /* append after this line (can be 0) */
2225 char_u *line; /* text of the new line */
2226 colnr_T len; /* length of new line, including NUL, or 0 */
2227 int newfile; /* flag, see above */
2229 if (buf->b_ml.ml_mfp == NULL)
2230 return FAIL;
2232 if (buf->b_ml.ml_line_lnum != 0)
2233 ml_flush_line(buf);
2234 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2236 #endif
2238 static int
2239 ml_append_int(buf, lnum, line, len, newfile, mark)
2240 buf_T *buf;
2241 linenr_T lnum; /* append after this line (can be 0) */
2242 char_u *line; /* text of the new line */
2243 colnr_T len; /* length of line, including NUL, or 0 */
2244 int newfile; /* flag, see above */
2245 int mark; /* mark the new line */
2247 int i;
2248 int line_count; /* number of indexes in current block */
2249 int offset;
2250 int from, to;
2251 int space_needed; /* space needed for new line */
2252 int page_size;
2253 int page_count;
2254 int db_idx; /* index for lnum in data block */
2255 bhdr_T *hp;
2256 memfile_T *mfp;
2257 DATA_BL *dp;
2258 PTR_BL *pp;
2259 infoptr_T *ip;
2261 /* lnum out of range */
2262 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2263 return FAIL;
2265 if (lowest_marked && lowest_marked > lnum)
2266 lowest_marked = lnum + 1;
2268 if (len == 0)
2269 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2270 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2272 mfp = buf->b_ml.ml_mfp;
2273 page_size = mfp->mf_page_size;
2276 * find the data block containing the previous line
2277 * This also fills the stack with the blocks from the root to the data block
2278 * This also releases any locked block.
2280 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2281 ML_INSERT)) == NULL)
2282 return FAIL;
2284 buf->b_ml.ml_flags &= ~ML_EMPTY;
2286 if (lnum == 0) /* got line one instead, correct db_idx */
2287 db_idx = -1; /* careful, it is negative! */
2288 else
2289 db_idx = lnum - buf->b_ml.ml_locked_low;
2290 /* get line count before the insertion */
2291 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2293 dp = (DATA_BL *)(hp->bh_data);
2296 * If
2297 * - there is not enough room in the current block
2298 * - appending to the last line in the block
2299 * - not appending to the last line in the file
2300 * insert in front of the next block.
2302 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2303 && lnum < buf->b_ml.ml_line_count)
2306 * Now that the line is not going to be inserted in the block that we
2307 * expected, the line count has to be adjusted in the pointer blocks
2308 * by using ml_locked_lineadd.
2310 --(buf->b_ml.ml_locked_lineadd);
2311 --(buf->b_ml.ml_locked_high);
2312 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2313 return FAIL;
2315 db_idx = -1; /* careful, it is negative! */
2316 /* get line count before the insertion */
2317 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2318 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2320 dp = (DATA_BL *)(hp->bh_data);
2323 ++buf->b_ml.ml_line_count;
2325 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2328 * Insert new line in existing data block, or in data block allocated above.
2330 dp->db_txt_start -= len;
2331 dp->db_free -= space_needed;
2332 ++(dp->db_line_count);
2335 * move the text of the lines that follow to the front
2336 * adjust the indexes of the lines that follow
2338 if (line_count > db_idx + 1) /* if there are following lines */
2341 * Offset is the start of the previous line.
2342 * This will become the character just after the new line.
2344 if (db_idx < 0)
2345 offset = dp->db_txt_end;
2346 else
2347 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2348 mch_memmove((char *)dp + dp->db_txt_start,
2349 (char *)dp + dp->db_txt_start + len,
2350 (size_t)(offset - (dp->db_txt_start + len)));
2351 for (i = line_count - 1; i > db_idx; --i)
2352 dp->db_index[i + 1] = dp->db_index[i] - len;
2353 dp->db_index[db_idx + 1] = offset - len;
2355 else /* add line at the end */
2356 dp->db_index[db_idx + 1] = dp->db_txt_start;
2359 * copy the text into the block
2361 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2362 if (mark)
2363 dp->db_index[db_idx + 1] |= DB_MARKED;
2366 * Mark the block dirty.
2368 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2369 if (!newfile)
2370 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2372 else /* not enough space in data block */
2375 * If there is not enough room we have to create a new data block and copy some
2376 * lines into it.
2377 * Then we have to insert an entry in the pointer block.
2378 * If this pointer block also is full, we go up another block, and so on, up
2379 * to the root if necessary.
2380 * The line counts in the pointer blocks have already been adjusted by
2381 * ml_find_line().
2383 long line_count_left, line_count_right;
2384 int page_count_left, page_count_right;
2385 bhdr_T *hp_left;
2386 bhdr_T *hp_right;
2387 bhdr_T *hp_new;
2388 int lines_moved;
2389 int data_moved = 0; /* init to shut up gcc */
2390 int total_moved = 0; /* init to shut up gcc */
2391 DATA_BL *dp_right, *dp_left;
2392 int stack_idx;
2393 int in_left;
2394 int lineadd;
2395 blocknr_T bnum_left, bnum_right;
2396 linenr_T lnum_left, lnum_right;
2397 int pb_idx;
2398 PTR_BL *pp_new;
2401 * We are going to allocate a new data block. Depending on the
2402 * situation it will be put to the left or right of the existing
2403 * block. If possible we put the new line in the left block and move
2404 * the lines after it to the right block. Otherwise the new line is
2405 * also put in the right block. This method is more efficient when
2406 * inserting a lot of lines at one place.
2408 if (db_idx < 0) /* left block is new, right block is existing */
2410 lines_moved = 0;
2411 in_left = TRUE;
2412 /* space_needed does not change */
2414 else /* left block is existing, right block is new */
2416 lines_moved = line_count - db_idx - 1;
2417 if (lines_moved == 0)
2418 in_left = FALSE; /* put new line in right block */
2419 /* space_needed does not change */
2420 else
2422 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2423 dp->db_txt_start;
2424 total_moved = data_moved + lines_moved * INDEX_SIZE;
2425 if ((int)dp->db_free + total_moved >= space_needed)
2427 in_left = TRUE; /* put new line in left block */
2428 space_needed = total_moved;
2430 else
2432 in_left = FALSE; /* put new line in right block */
2433 space_needed += total_moved;
2438 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2439 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2441 /* correct line counts in pointer blocks */
2442 --(buf->b_ml.ml_locked_lineadd);
2443 --(buf->b_ml.ml_locked_high);
2444 return FAIL;
2446 if (db_idx < 0) /* left block is new */
2448 hp_left = hp_new;
2449 hp_right = hp;
2450 line_count_left = 0;
2451 line_count_right = line_count;
2453 else /* right block is new */
2455 hp_left = hp;
2456 hp_right = hp_new;
2457 line_count_left = line_count;
2458 line_count_right = 0;
2460 dp_right = (DATA_BL *)(hp_right->bh_data);
2461 dp_left = (DATA_BL *)(hp_left->bh_data);
2462 bnum_left = hp_left->bh_bnum;
2463 bnum_right = hp_right->bh_bnum;
2464 page_count_left = hp_left->bh_page_count;
2465 page_count_right = hp_right->bh_page_count;
2468 * May move the new line into the right/new block.
2470 if (!in_left)
2472 dp_right->db_txt_start -= len;
2473 dp_right->db_free -= len + INDEX_SIZE;
2474 dp_right->db_index[0] = dp_right->db_txt_start;
2475 if (mark)
2476 dp_right->db_index[0] |= DB_MARKED;
2478 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2479 line, (size_t)len);
2480 ++line_count_right;
2483 * may move lines from the left/old block to the right/new one.
2485 if (lines_moved)
2489 dp_right->db_txt_start -= data_moved;
2490 dp_right->db_free -= total_moved;
2491 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2492 (char *)dp_left + dp_left->db_txt_start,
2493 (size_t)data_moved);
2494 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2495 dp_left->db_txt_start += data_moved;
2496 dp_left->db_free += total_moved;
2499 * update indexes in the new block
2501 for (to = line_count_right, from = db_idx + 1;
2502 from < line_count_left; ++from, ++to)
2503 dp_right->db_index[to] = dp->db_index[from] + offset;
2504 line_count_right += lines_moved;
2505 line_count_left -= lines_moved;
2509 * May move the new line into the left (old or new) block.
2511 if (in_left)
2513 dp_left->db_txt_start -= len;
2514 dp_left->db_free -= len + INDEX_SIZE;
2515 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2516 if (mark)
2517 dp_left->db_index[line_count_left] |= DB_MARKED;
2518 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2519 line, (size_t)len);
2520 ++line_count_left;
2523 if (db_idx < 0) /* left block is new */
2525 lnum_left = lnum + 1;
2526 lnum_right = 0;
2528 else /* right block is new */
2530 lnum_left = 0;
2531 if (in_left)
2532 lnum_right = lnum + 2;
2533 else
2534 lnum_right = lnum + 1;
2536 dp_left->db_line_count = line_count_left;
2537 dp_right->db_line_count = line_count_right;
2540 * release the two data blocks
2541 * The new one (hp_new) already has a correct blocknumber.
2542 * The old one (hp, in ml_locked) gets a positive blocknumber if
2543 * we changed it and we are not editing a new file.
2545 if (lines_moved || in_left)
2546 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2547 if (!newfile && db_idx >= 0 && in_left)
2548 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2549 mf_put(mfp, hp_new, TRUE, FALSE);
2552 * flush the old data block
2553 * set ml_locked_lineadd to 0, because the updating of the
2554 * pointer blocks is done below
2556 lineadd = buf->b_ml.ml_locked_lineadd;
2557 buf->b_ml.ml_locked_lineadd = 0;
2558 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2561 * update pointer blocks for the new data block
2563 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2564 --stack_idx)
2566 ip = &(buf->b_ml.ml_stack[stack_idx]);
2567 pb_idx = ip->ip_index;
2568 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2569 return FAIL;
2570 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2571 if (pp->pb_id != PTR_ID)
2573 EMSG(_("E317: pointer block id wrong 3"));
2574 mf_put(mfp, hp, FALSE, FALSE);
2575 return FAIL;
2578 * TODO: If the pointer block is full and we are adding at the end
2579 * try to insert in front of the next block
2581 /* block not full, add one entry */
2582 if (pp->pb_count < pp->pb_count_max)
2584 if (pb_idx + 1 < (int)pp->pb_count)
2585 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2586 &pp->pb_pointer[pb_idx + 1],
2587 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2588 ++pp->pb_count;
2589 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2590 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2591 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2592 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2593 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2594 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2596 if (lnum_left != 0)
2597 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2598 if (lnum_right != 0)
2599 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2601 mf_put(mfp, hp, TRUE, FALSE);
2602 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2604 if (lineadd)
2606 --(buf->b_ml.ml_stack_top);
2607 /* fix line count for rest of blocks in the stack */
2608 ml_lineadd(buf, lineadd);
2609 /* fix stack itself */
2610 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2611 lineadd;
2612 ++(buf->b_ml.ml_stack_top);
2616 * We are finished, break the loop here.
2618 break;
2620 else /* pointer block full */
2623 * split the pointer block
2624 * allocate a new pointer block
2625 * move some of the pointer into the new block
2626 * prepare for updating the parent block
2628 for (;;) /* do this twice when splitting block 1 */
2630 hp_new = ml_new_ptr(mfp);
2631 if (hp_new == NULL) /* TODO: try to fix tree */
2632 return FAIL;
2633 pp_new = (PTR_BL *)(hp_new->bh_data);
2635 if (hp->bh_bnum != 1)
2636 break;
2639 * if block 1 becomes full the tree is given an extra level
2640 * The pointers from block 1 are moved into the new block.
2641 * block 1 is updated to point to the new block
2642 * then continue to split the new block
2644 mch_memmove(pp_new, pp, (size_t)page_size);
2645 pp->pb_count = 1;
2646 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2647 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2648 pp->pb_pointer[0].pe_old_lnum = 1;
2649 pp->pb_pointer[0].pe_page_count = 1;
2650 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2651 hp = hp_new; /* new block is to be split */
2652 pp = pp_new;
2653 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2654 ip->ip_index = 0;
2655 ++stack_idx; /* do block 1 again later */
2658 * move the pointers after the current one to the new block
2659 * If there are none, the new entry will be in the new block.
2661 total_moved = pp->pb_count - pb_idx - 1;
2662 if (total_moved)
2664 mch_memmove(&pp_new->pb_pointer[0],
2665 &pp->pb_pointer[pb_idx + 1],
2666 (size_t)(total_moved) * sizeof(PTR_EN));
2667 pp_new->pb_count = total_moved;
2668 pp->pb_count -= total_moved - 1;
2669 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2670 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2671 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2672 if (lnum_right)
2673 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2675 else
2677 pp_new->pb_count = 1;
2678 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2679 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2680 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2681 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2683 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2684 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2685 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2686 if (lnum_left)
2687 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2688 lnum_left = 0;
2689 lnum_right = 0;
2692 * recompute line counts
2694 line_count_right = 0;
2695 for (i = 0; i < (int)pp_new->pb_count; ++i)
2696 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2697 line_count_left = 0;
2698 for (i = 0; i < (int)pp->pb_count; ++i)
2699 line_count_left += pp->pb_pointer[i].pe_line_count;
2701 bnum_left = hp->bh_bnum;
2702 bnum_right = hp_new->bh_bnum;
2703 page_count_left = 1;
2704 page_count_right = 1;
2705 mf_put(mfp, hp, TRUE, FALSE);
2706 mf_put(mfp, hp_new, TRUE, FALSE);
2711 * Safety check: fallen out of for loop?
2713 if (stack_idx < 0)
2715 EMSG(_("E318: Updated too many blocks?"));
2716 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2720 #ifdef FEAT_BYTEOFF
2721 /* The line was inserted below 'lnum' */
2722 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2723 #endif
2724 #ifdef FEAT_NETBEANS_INTG
2725 if (usingNetbeans)
2727 if (STRLEN(line) > 0)
2728 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2729 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2730 (char_u *)"\n", 1);
2732 #endif
2733 return OK;
2737 * Replace line lnum, with buffering, in current buffer.
2739 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2740 * copied to allocated memory already.
2742 * Check: The caller of this function should probably also call
2743 * changed_lines(), unless update_screen(NOT_VALID) is used.
2745 * return FAIL for failure, OK otherwise
2748 ml_replace(lnum, line, copy)
2749 linenr_T lnum;
2750 char_u *line;
2751 int copy;
2753 if (line == NULL) /* just checking... */
2754 return FAIL;
2756 /* When starting up, we might still need to create the memfile */
2757 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2758 return FAIL;
2760 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2761 return FAIL;
2762 #ifdef FEAT_NETBEANS_INTG
2763 if (usingNetbeans)
2765 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2766 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2768 #endif
2769 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2770 ml_flush_line(curbuf); /* flush it */
2771 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2772 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2773 curbuf->b_ml.ml_line_ptr = line;
2774 curbuf->b_ml.ml_line_lnum = lnum;
2775 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2777 return OK;
2781 * Delete line 'lnum' in the current buffer.
2783 * Check: The caller of this function should probably also call
2784 * deleted_lines() after this.
2786 * return FAIL for failure, OK otherwise
2789 ml_delete(lnum, message)
2790 linenr_T lnum;
2791 int message;
2793 ml_flush_line(curbuf);
2794 return ml_delete_int(curbuf, lnum, message);
2797 static int
2798 ml_delete_int(buf, lnum, message)
2799 buf_T *buf;
2800 linenr_T lnum;
2801 int message;
2803 bhdr_T *hp;
2804 memfile_T *mfp;
2805 DATA_BL *dp;
2806 PTR_BL *pp;
2807 infoptr_T *ip;
2808 int count; /* number of entries in block */
2809 int idx;
2810 int stack_idx;
2811 int text_start;
2812 int line_start;
2813 long line_size;
2814 int i;
2816 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2817 return FAIL;
2819 if (lowest_marked && lowest_marked > lnum)
2820 lowest_marked--;
2823 * If the file becomes empty the last line is replaced by an empty line.
2825 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2827 if (message
2828 #ifdef FEAT_NETBEANS_INTG
2829 && !netbeansSuppressNoLines
2830 #endif
2832 set_keep_msg((char_u *)_(no_lines_msg), 0);
2834 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2835 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2836 buf->b_ml.ml_flags |= ML_EMPTY;
2838 return i;
2842 * find the data block containing the line
2843 * This also fills the stack with the blocks from the root to the data block
2844 * This also releases any locked block.
2846 mfp = buf->b_ml.ml_mfp;
2847 if (mfp == NULL)
2848 return FAIL;
2850 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2851 return FAIL;
2853 dp = (DATA_BL *)(hp->bh_data);
2854 /* compute line count before the delete */
2855 count = (long)(buf->b_ml.ml_locked_high)
2856 - (long)(buf->b_ml.ml_locked_low) + 2;
2857 idx = lnum - buf->b_ml.ml_locked_low;
2859 --buf->b_ml.ml_line_count;
2861 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2862 if (idx == 0) /* first line in block, text at the end */
2863 line_size = dp->db_txt_end - line_start;
2864 else
2865 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2867 #ifdef FEAT_NETBEANS_INTG
2868 if (usingNetbeans)
2869 netbeans_removed(buf, lnum, 0, (long)line_size);
2870 #endif
2873 * special case: If there is only one line in the data block it becomes empty.
2874 * Then we have to remove the entry, pointing to this data block, from the
2875 * pointer block. If this pointer block also becomes empty, we go up another
2876 * block, and so on, up to the root if necessary.
2877 * The line counts in the pointer blocks have already been adjusted by
2878 * ml_find_line().
2880 if (count == 1)
2882 mf_free(mfp, hp); /* free the data block */
2883 buf->b_ml.ml_locked = NULL;
2885 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2887 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2888 ip = &(buf->b_ml.ml_stack[stack_idx]);
2889 idx = ip->ip_index;
2890 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2891 return FAIL;
2892 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2893 if (pp->pb_id != PTR_ID)
2895 EMSG(_("E317: pointer block id wrong 4"));
2896 mf_put(mfp, hp, FALSE, FALSE);
2897 return FAIL;
2899 count = --(pp->pb_count);
2900 if (count == 0) /* the pointer block becomes empty! */
2901 mf_free(mfp, hp);
2902 else
2904 if (count != idx) /* move entries after the deleted one */
2905 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2906 (size_t)(count - idx) * sizeof(PTR_EN));
2907 mf_put(mfp, hp, TRUE, FALSE);
2909 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2910 /* fix line count for rest of blocks in the stack */
2911 if (buf->b_ml.ml_locked_lineadd != 0)
2913 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2914 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2915 buf->b_ml.ml_locked_lineadd;
2917 ++(buf->b_ml.ml_stack_top);
2919 break;
2922 CHECK(stack_idx < 0, _("deleted block 1?"));
2924 else
2927 * delete the text by moving the next lines forwards
2929 text_start = dp->db_txt_start;
2930 mch_memmove((char *)dp + text_start + line_size,
2931 (char *)dp + text_start, (size_t)(line_start - text_start));
2934 * delete the index by moving the next indexes backwards
2935 * Adjust the indexes for the text movement.
2937 for (i = idx; i < count - 1; ++i)
2938 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2940 dp->db_free += line_size + INDEX_SIZE;
2941 dp->db_txt_start += line_size;
2942 --(dp->db_line_count);
2945 * mark the block dirty and make sure it is in the file (for recovery)
2947 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2950 #ifdef FEAT_BYTEOFF
2951 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2952 #endif
2953 return OK;
2957 * set the B_MARKED flag for line 'lnum'
2959 void
2960 ml_setmarked(lnum)
2961 linenr_T lnum;
2963 bhdr_T *hp;
2964 DATA_BL *dp;
2965 /* invalid line number */
2966 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2967 || curbuf->b_ml.ml_mfp == NULL)
2968 return; /* give error message? */
2970 if (lowest_marked == 0 || lowest_marked > lnum)
2971 lowest_marked = lnum;
2974 * find the data block containing the line
2975 * This also fills the stack with the blocks from the root to the data block
2976 * This also releases any locked block.
2978 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2979 return; /* give error message? */
2981 dp = (DATA_BL *)(hp->bh_data);
2982 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2983 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2987 * find the first line with its B_MARKED flag set
2989 linenr_T
2990 ml_firstmarked()
2992 bhdr_T *hp;
2993 DATA_BL *dp;
2994 linenr_T lnum;
2995 int i;
2997 if (curbuf->b_ml.ml_mfp == NULL)
2998 return (linenr_T) 0;
3001 * The search starts with lowest_marked line. This is the last line where
3002 * a mark was found, adjusted by inserting/deleting lines.
3004 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3007 * Find the data block containing the line.
3008 * This also fills the stack with the blocks from the root to the data
3009 * block This also releases any locked block.
3011 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3012 return (linenr_T)0; /* give error message? */
3014 dp = (DATA_BL *)(hp->bh_data);
3016 for (i = lnum - curbuf->b_ml.ml_locked_low;
3017 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3018 if ((dp->db_index[i]) & DB_MARKED)
3020 (dp->db_index[i]) &= DB_INDEX_MASK;
3021 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3022 lowest_marked = lnum + 1;
3023 return lnum;
3027 return (linenr_T) 0;
3030 #if 0 /* not used */
3032 * return TRUE if line 'lnum' has a mark
3035 ml_has_mark(lnum)
3036 linenr_T lnum;
3038 bhdr_T *hp;
3039 DATA_BL *dp;
3041 if (curbuf->b_ml.ml_mfp == NULL
3042 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3043 return FALSE;
3045 dp = (DATA_BL *)(hp->bh_data);
3046 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3048 #endif
3051 * clear all DB_MARKED flags
3053 void
3054 ml_clearmarked()
3056 bhdr_T *hp;
3057 DATA_BL *dp;
3058 linenr_T lnum;
3059 int i;
3061 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3062 return;
3065 * The search starts with line lowest_marked.
3067 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3070 * Find the data block containing the line.
3071 * This also fills the stack with the blocks from the root to the data
3072 * block and releases any locked block.
3074 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3075 return; /* give error message? */
3077 dp = (DATA_BL *)(hp->bh_data);
3079 for (i = lnum - curbuf->b_ml.ml_locked_low;
3080 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3081 if ((dp->db_index[i]) & DB_MARKED)
3083 (dp->db_index[i]) &= DB_INDEX_MASK;
3084 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3088 lowest_marked = 0;
3089 return;
3093 * flush ml_line if necessary
3095 static void
3096 ml_flush_line(buf)
3097 buf_T *buf;
3099 bhdr_T *hp;
3100 DATA_BL *dp;
3101 linenr_T lnum;
3102 char_u *new_line;
3103 char_u *old_line;
3104 colnr_T new_len;
3105 int old_len;
3106 int extra;
3107 int idx;
3108 int start;
3109 int count;
3110 int i;
3111 static int entered = FALSE;
3113 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3114 return; /* nothing to do */
3116 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3118 /* This code doesn't work recursively, but Netbeans may call back here
3119 * when obtaining the cursor position. */
3120 if (entered)
3121 return;
3122 entered = TRUE;
3124 lnum = buf->b_ml.ml_line_lnum;
3125 new_line = buf->b_ml.ml_line_ptr;
3127 hp = ml_find_line(buf, lnum, ML_FIND);
3128 if (hp == NULL)
3129 EMSGN(_("E320: Cannot find line %ld"), lnum);
3130 else
3132 dp = (DATA_BL *)(hp->bh_data);
3133 idx = lnum - buf->b_ml.ml_locked_low;
3134 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3135 old_line = (char_u *)dp + start;
3136 if (idx == 0) /* line is last in block */
3137 old_len = dp->db_txt_end - start;
3138 else /* text of previous line follows */
3139 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3140 new_len = (colnr_T)STRLEN(new_line) + 1;
3141 extra = new_len - old_len; /* negative if lines gets smaller */
3144 * if new line fits in data block, replace directly
3146 if ((int)dp->db_free >= extra)
3148 /* if the length changes and there are following lines */
3149 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3150 if (extra != 0 && idx < count - 1)
3152 /* move text of following lines */
3153 mch_memmove((char *)dp + dp->db_txt_start - extra,
3154 (char *)dp + dp->db_txt_start,
3155 (size_t)(start - dp->db_txt_start));
3157 /* adjust pointers of this and following lines */
3158 for (i = idx + 1; i < count; ++i)
3159 dp->db_index[i] -= extra;
3161 dp->db_index[idx] -= extra;
3163 /* adjust free space */
3164 dp->db_free -= extra;
3165 dp->db_txt_start -= extra;
3167 /* copy new line into the data block */
3168 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3169 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3170 #ifdef FEAT_BYTEOFF
3171 /* The else case is already covered by the insert and delete */
3172 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3173 #endif
3175 else
3178 * Cannot do it in one data block: Delete and append.
3179 * Append first, because ml_delete_int() cannot delete the
3180 * last line in a buffer, which causes trouble for a buffer
3181 * that has only one line.
3182 * Don't forget to copy the mark!
3184 /* How about handling errors??? */
3185 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3186 (dp->db_index[idx] & DB_MARKED));
3187 (void)ml_delete_int(buf, lnum, FALSE);
3190 vim_free(new_line);
3192 entered = FALSE;
3195 buf->b_ml.ml_line_lnum = 0;
3199 * create a new, empty, data block
3201 static bhdr_T *
3202 ml_new_data(mfp, negative, page_count)
3203 memfile_T *mfp;
3204 int negative;
3205 int page_count;
3207 bhdr_T *hp;
3208 DATA_BL *dp;
3210 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3211 return NULL;
3213 dp = (DATA_BL *)(hp->bh_data);
3214 dp->db_id = DATA_ID;
3215 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3216 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3217 dp->db_line_count = 0;
3219 return hp;
3223 * create a new, empty, pointer block
3225 static bhdr_T *
3226 ml_new_ptr(mfp)
3227 memfile_T *mfp;
3229 bhdr_T *hp;
3230 PTR_BL *pp;
3232 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3233 return NULL;
3235 pp = (PTR_BL *)(hp->bh_data);
3236 pp->pb_id = PTR_ID;
3237 pp->pb_count = 0;
3238 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3240 return hp;
3244 * lookup line 'lnum' in a memline
3246 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3247 * if ML_FLUSH only flush a locked block
3248 * if ML_FIND just find the line
3250 * If the block was found it is locked and put in ml_locked.
3251 * The stack is updated to lead to the locked block. The ip_high field in
3252 * the stack is updated to reflect the last line in the block AFTER the
3253 * insert or delete, also if the pointer block has not been updated yet. But
3254 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3256 * return: NULL for failure, pointer to block header otherwise
3258 static bhdr_T *
3259 ml_find_line(buf, lnum, action)
3260 buf_T *buf;
3261 linenr_T lnum;
3262 int action;
3264 DATA_BL *dp;
3265 PTR_BL *pp;
3266 infoptr_T *ip;
3267 bhdr_T *hp;
3268 memfile_T *mfp;
3269 linenr_T t;
3270 blocknr_T bnum, bnum2;
3271 int dirty;
3272 linenr_T low, high;
3273 int top;
3274 int page_count;
3275 int idx;
3277 mfp = buf->b_ml.ml_mfp;
3280 * If there is a locked block check if the wanted line is in it.
3281 * If not, flush and release the locked block.
3282 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3283 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3284 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3286 if (buf->b_ml.ml_locked)
3288 if (ML_SIMPLE(action)
3289 && buf->b_ml.ml_locked_low <= lnum
3290 && buf->b_ml.ml_locked_high >= lnum
3291 && !mf_dont_release)
3293 /* remember to update pointer blocks and stack later */
3294 if (action == ML_INSERT)
3296 ++(buf->b_ml.ml_locked_lineadd);
3297 ++(buf->b_ml.ml_locked_high);
3299 else if (action == ML_DELETE)
3301 --(buf->b_ml.ml_locked_lineadd);
3302 --(buf->b_ml.ml_locked_high);
3304 return (buf->b_ml.ml_locked);
3307 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3308 buf->b_ml.ml_flags & ML_LOCKED_POS);
3309 buf->b_ml.ml_locked = NULL;
3312 * If lines have been added or deleted in the locked block, need to
3313 * update the line count in pointer blocks.
3315 if (buf->b_ml.ml_locked_lineadd != 0)
3316 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3319 if (action == ML_FLUSH) /* nothing else to do */
3320 return NULL;
3322 bnum = 1; /* start at the root of the tree */
3323 page_count = 1;
3324 low = 1;
3325 high = buf->b_ml.ml_line_count;
3327 if (action == ML_FIND) /* first try stack entries */
3329 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3331 ip = &(buf->b_ml.ml_stack[top]);
3332 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3334 bnum = ip->ip_bnum;
3335 low = ip->ip_low;
3336 high = ip->ip_high;
3337 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3338 break;
3341 if (top < 0)
3342 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3344 else /* ML_DELETE or ML_INSERT */
3345 buf->b_ml.ml_stack_top = 0; /* start at the root */
3348 * search downwards in the tree until a data block is found
3350 for (;;)
3352 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3353 goto error_noblock;
3356 * update high for insert/delete
3358 if (action == ML_INSERT)
3359 ++high;
3360 else if (action == ML_DELETE)
3361 --high;
3363 dp = (DATA_BL *)(hp->bh_data);
3364 if (dp->db_id == DATA_ID) /* data block */
3366 buf->b_ml.ml_locked = hp;
3367 buf->b_ml.ml_locked_low = low;
3368 buf->b_ml.ml_locked_high = high;
3369 buf->b_ml.ml_locked_lineadd = 0;
3370 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3371 return hp;
3374 pp = (PTR_BL *)(dp); /* must be pointer block */
3375 if (pp->pb_id != PTR_ID)
3377 EMSG(_("E317: pointer block id wrong"));
3378 goto error_block;
3381 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3382 goto error_block;
3383 ip = &(buf->b_ml.ml_stack[top]);
3384 ip->ip_bnum = bnum;
3385 ip->ip_low = low;
3386 ip->ip_high = high;
3387 ip->ip_index = -1; /* index not known yet */
3389 dirty = FALSE;
3390 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3392 t = pp->pb_pointer[idx].pe_line_count;
3393 CHECK(t == 0, _("pe_line_count is zero"));
3394 if ((low += t) > lnum)
3396 ip->ip_index = idx;
3397 bnum = pp->pb_pointer[idx].pe_bnum;
3398 page_count = pp->pb_pointer[idx].pe_page_count;
3399 high = low - 1;
3400 low -= t;
3403 * a negative block number may have been changed
3405 if (bnum < 0)
3407 bnum2 = mf_trans_del(mfp, bnum);
3408 if (bnum != bnum2)
3410 bnum = bnum2;
3411 pp->pb_pointer[idx].pe_bnum = bnum;
3412 dirty = TRUE;
3416 break;
3419 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3421 if (lnum > buf->b_ml.ml_line_count)
3422 EMSGN(_("E322: line number out of range: %ld past the end"),
3423 lnum - buf->b_ml.ml_line_count);
3425 else
3426 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3427 goto error_block;
3429 if (action == ML_DELETE)
3431 pp->pb_pointer[idx].pe_line_count--;
3432 dirty = TRUE;
3434 else if (action == ML_INSERT)
3436 pp->pb_pointer[idx].pe_line_count++;
3437 dirty = TRUE;
3439 mf_put(mfp, hp, dirty, FALSE);
3442 error_block:
3443 mf_put(mfp, hp, FALSE, FALSE);
3444 error_noblock:
3446 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3447 * the incremented/decremented line counts, because there won't be a line
3448 * inserted/deleted after all.
3450 if (action == ML_DELETE)
3451 ml_lineadd(buf, 1);
3452 else if (action == ML_INSERT)
3453 ml_lineadd(buf, -1);
3454 buf->b_ml.ml_stack_top = 0;
3455 return NULL;
3459 * add an entry to the info pointer stack
3461 * return -1 for failure, number of the new entry otherwise
3463 static int
3464 ml_add_stack(buf)
3465 buf_T *buf;
3467 int top;
3468 infoptr_T *newstack;
3470 top = buf->b_ml.ml_stack_top;
3472 /* may have to increase the stack size */
3473 if (top == buf->b_ml.ml_stack_size)
3475 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3477 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3478 (buf->b_ml.ml_stack_size + STACK_INCR));
3479 if (newstack == NULL)
3480 return -1;
3481 mch_memmove(newstack, buf->b_ml.ml_stack,
3482 (size_t)top * sizeof(infoptr_T));
3483 vim_free(buf->b_ml.ml_stack);
3484 buf->b_ml.ml_stack = newstack;
3485 buf->b_ml.ml_stack_size += STACK_INCR;
3488 buf->b_ml.ml_stack_top++;
3489 return top;
3493 * Update the pointer blocks on the stack for inserted/deleted lines.
3494 * The stack itself is also updated.
3496 * When a insert/delete line action fails, the line is not inserted/deleted,
3497 * but the pointer blocks have already been updated. That is fixed here by
3498 * walking through the stack.
3500 * Count is the number of lines added, negative if lines have been deleted.
3502 static void
3503 ml_lineadd(buf, count)
3504 buf_T *buf;
3505 int count;
3507 int idx;
3508 infoptr_T *ip;
3509 PTR_BL *pp;
3510 memfile_T *mfp = buf->b_ml.ml_mfp;
3511 bhdr_T *hp;
3513 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3515 ip = &(buf->b_ml.ml_stack[idx]);
3516 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3517 break;
3518 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3519 if (pp->pb_id != PTR_ID)
3521 mf_put(mfp, hp, FALSE, FALSE);
3522 EMSG(_("E317: pointer block id wrong 2"));
3523 break;
3525 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3526 ip->ip_high += count;
3527 mf_put(mfp, hp, TRUE, FALSE);
3531 #ifdef HAVE_READLINK
3533 * Resolve a symlink in the last component of a file name.
3534 * Note that f_resolve() does it for every part of the path, we don't do that
3535 * here.
3536 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3537 * Otherwise returns FAIL.
3539 static int
3540 resolve_symlink(fname, buf)
3541 char_u *fname;
3542 char_u *buf;
3544 char_u tmp[MAXPATHL];
3545 int ret;
3546 int depth = 0;
3548 if (fname == NULL)
3549 return FAIL;
3551 /* Put the result so far in tmp[], starting with the original name. */
3552 vim_strncpy(tmp, fname, MAXPATHL - 1);
3554 for (;;)
3556 /* Limit symlink depth to 100, catch recursive loops. */
3557 if (++depth == 100)
3559 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3560 return FAIL;
3563 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3564 if (ret <= 0)
3566 if (errno == EINVAL || errno == ENOENT)
3568 /* Found non-symlink or not existing file, stop here.
3569 * When at the first level use the unmodified name, skip the
3570 * call to vim_FullName(). */
3571 if (depth == 1)
3572 return FAIL;
3574 /* Use the resolved name in tmp[]. */
3575 break;
3578 /* There must be some error reading links, use original name. */
3579 return FAIL;
3581 buf[ret] = NUL;
3584 * Check whether the symlink is relative or absolute.
3585 * If it's relative, build a new path based on the directory
3586 * portion of the filename (if any) and the path the symlink
3587 * points to.
3589 if (mch_isFullName(buf))
3590 STRCPY(tmp, buf);
3591 else
3593 char_u *tail;
3595 tail = gettail(tmp);
3596 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3597 return FAIL;
3598 STRCPY(tail, buf);
3603 * Try to resolve the full name of the file so that the swapfile name will
3604 * be consistent even when opening a relative symlink from different
3605 * working directories.
3607 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3609 #endif
3612 * Make swap file name out of the file name and a directory name.
3613 * Returns pointer to allocated memory or NULL.
3615 char_u *
3616 makeswapname(fname, ffname, buf, dir_name)
3617 char_u *fname;
3618 char_u *ffname UNUSED;
3619 buf_T *buf;
3620 char_u *dir_name;
3622 char_u *r, *s;
3623 char_u *fname_res = fname;
3624 #ifdef HAVE_READLINK
3625 char_u fname_buf[MAXPATHL];
3626 #endif
3628 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3629 s = dir_name + STRLEN(dir_name);
3630 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3631 { /* Ends with '//', Use Full path */
3632 r = NULL;
3633 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3635 r = modname(s, (char_u *)".swp", FALSE);
3636 vim_free(s);
3638 return r;
3640 #endif
3642 #ifdef HAVE_READLINK
3643 /* Expand symlink in the file name, so that we put the swap file with the
3644 * actual file instead of with the symlink. */
3645 if (resolve_symlink(fname, fname_buf) == OK)
3646 fname_res = fname_buf;
3647 #endif
3649 r = buf_modname(
3650 #ifdef SHORT_FNAME
3651 TRUE,
3652 #else
3653 (buf->b_p_sn || buf->b_shortname),
3654 #endif
3655 #ifdef RISCOS
3656 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3657 ffname,
3658 #else
3659 fname_res,
3660 #endif
3661 (char_u *)
3662 #if defined(VMS) || defined(RISCOS)
3663 "_swp",
3664 #else
3665 ".swp",
3666 #endif
3667 #ifdef SHORT_FNAME /* always 8.3 file name */
3668 FALSE
3669 #else
3670 /* Prepend a '.' to the swap file name for the current directory. */
3671 dir_name[0] == '.' && dir_name[1] == NUL
3672 #endif
3674 if (r == NULL) /* out of memory */
3675 return NULL;
3677 s = get_file_in_dir(r, dir_name);
3678 vim_free(r);
3679 return s;
3683 * Get file name to use for swap file or backup file.
3684 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3685 * option "dname".
3686 * - If "dname" is ".", return "fname" (swap file in dir of file).
3687 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3688 * relative to dir of file).
3689 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3690 * dir).
3692 * The return value is an allocated string and can be NULL.
3694 char_u *
3695 get_file_in_dir(fname, dname)
3696 char_u *fname;
3697 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3699 char_u *t;
3700 char_u *tail;
3701 char_u *retval;
3702 int save_char;
3704 tail = gettail(fname);
3706 if (dname[0] == '.' && dname[1] == NUL)
3707 retval = vim_strsave(fname);
3708 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3710 if (tail == fname) /* no path before file name */
3711 retval = concat_fnames(dname + 2, tail, TRUE);
3712 else
3714 save_char = *tail;
3715 *tail = NUL;
3716 t = concat_fnames(fname, dname + 2, TRUE);
3717 *tail = save_char;
3718 if (t == NULL) /* out of memory */
3719 retval = NULL;
3720 else
3722 retval = concat_fnames(t, tail, TRUE);
3723 vim_free(t);
3727 else
3728 retval = concat_fnames(dname, tail, TRUE);
3730 return retval;
3733 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3736 * Print the ATTENTION message: info about an existing swap file.
3738 static void
3739 attention_message(buf, fname)
3740 buf_T *buf; /* buffer being edited */
3741 char_u *fname; /* swap file name */
3743 struct stat st;
3744 time_t x, sx;
3745 char *p;
3747 ++no_wait_return;
3748 (void)EMSG(_("E325: ATTENTION"));
3749 MSG_PUTS(_("\nFound a swap file by the name \""));
3750 msg_home_replace(fname);
3751 MSG_PUTS("\"\n");
3752 sx = swapfile_info(fname);
3753 MSG_PUTS(_("While opening file \""));
3754 msg_outtrans(buf->b_fname);
3755 MSG_PUTS("\"\n");
3756 if (mch_stat((char *)buf->b_fname, &st) != -1)
3758 MSG_PUTS(_(" dated: "));
3759 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3760 p = ctime(&x); /* includes '\n' */
3761 if (p == NULL)
3762 MSG_PUTS("(invalid)\n");
3763 else
3764 MSG_PUTS(p);
3765 if (sx != 0 && x > sx)
3766 MSG_PUTS(_(" NEWER than swap file!\n"));
3768 /* Some of these messages are long to allow translation to
3769 * other languages. */
3770 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"));
3771 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3772 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3773 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3774 msg_outtrans(buf->b_fname);
3775 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3776 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3777 msg_outtrans(fname);
3778 MSG_PUTS(_("\"\n to avoid this message.\n"));
3779 cmdline_row = msg_row;
3780 --no_wait_return;
3783 #ifdef FEAT_AUTOCMD
3784 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3787 * Trigger the SwapExists autocommands.
3788 * Returns a value for equivalent to do_dialog() (see below):
3789 * 0: still need to ask for a choice
3790 * 1: open read-only
3791 * 2: edit anyway
3792 * 3: recover
3793 * 4: delete it
3794 * 5: quit
3795 * 6: abort
3797 static int
3798 do_swapexists(buf, fname)
3799 buf_T *buf;
3800 char_u *fname;
3802 set_vim_var_string(VV_SWAPNAME, fname, -1);
3803 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3805 /* Trigger SwapExists autocommands with <afile> set to the file being
3806 * edited. Disallow changing directory here. */
3807 ++allbuf_lock;
3808 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3809 --allbuf_lock;
3811 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3813 switch (*get_vim_var_str(VV_SWAPCHOICE))
3815 case 'o': return 1;
3816 case 'e': return 2;
3817 case 'r': return 3;
3818 case 'd': return 4;
3819 case 'q': return 5;
3820 case 'a': return 6;
3823 return 0;
3825 #endif
3828 * Find out what name to use for the swap file for buffer 'buf'.
3830 * Several names are tried to find one that does not exist
3831 * Returns the name in allocated memory or NULL.
3833 * Note: If BASENAMELEN is not correct, you will get error messages for
3834 * not being able to open the swapfile
3835 * Note: May trigger SwapExists autocmd, pointers may change!
3837 static char_u *
3838 findswapname(buf, dirp, old_fname)
3839 buf_T *buf;
3840 char_u **dirp; /* pointer to list of directories */
3841 char_u *old_fname; /* don't give warning for this file name */
3843 char_u *fname;
3844 int n;
3845 char_u *dir_name;
3846 #ifdef AMIGA
3847 BPTR fh;
3848 #endif
3849 #ifndef SHORT_FNAME
3850 int r;
3851 #endif
3853 #if !defined(SHORT_FNAME) \
3854 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3855 # define CREATE_DUMMY_FILE
3856 FILE *dummyfd = NULL;
3859 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3860 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3861 * create will be exactly the same file. To avoid this problem we temporarily
3862 * create "test.doc".
3863 * Don't do this when the check below for a 8.3 file name is used.
3865 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3866 && mch_getperm(buf->b_fname) < 0)
3867 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3868 #endif
3871 * Isolate a directory name from *dirp and put it in dir_name.
3872 * First allocate some memory to put the directory name in.
3874 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3875 if (dir_name != NULL)
3876 (void)copy_option_part(dirp, dir_name, 31000, ",");
3879 * we try different names until we find one that does not exist yet
3881 if (dir_name == NULL) /* out of memory */
3882 fname = NULL;
3883 else
3884 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3886 for (;;)
3888 if (fname == NULL) /* must be out of memory */
3889 break;
3890 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3892 vim_free(fname);
3893 fname = NULL;
3894 break;
3896 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3898 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3899 * file names. If this is the first try and the swap file name does not fit in
3900 * 8.3, detect if this is the case, set shortname and try again.
3902 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3903 && !(buf->b_p_sn || buf->b_shortname))
3905 char_u *tail;
3906 char_u *fname2;
3907 struct stat s1, s2;
3908 int f1, f2;
3909 int created1 = FALSE, created2 = FALSE;
3910 int same = FALSE;
3913 * Check if swapfile name does not fit in 8.3:
3914 * It either contains two dots, is longer than 8 chars, or starts
3915 * with a dot.
3917 tail = gettail(buf->b_fname);
3918 if ( vim_strchr(tail, '.') != NULL
3919 || STRLEN(tail) > (size_t)8
3920 || *gettail(fname) == '.')
3922 fname2 = alloc(n + 2);
3923 if (fname2 != NULL)
3925 STRCPY(fname2, fname);
3926 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3927 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3928 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3930 if (vim_strchr(tail, '.') != NULL)
3931 fname2[n - 1] = 'x';
3932 else if (*gettail(fname) == '.')
3934 fname2[n] = 'x';
3935 fname2[n + 1] = NUL;
3937 else
3938 fname2[n - 5] += 1;
3940 * may need to create the files to be able to use mch_stat()
3942 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3943 if (f1 < 0)
3945 f1 = mch_open_rw((char *)fname,
3946 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3947 #if defined(OS2)
3948 if (f1 < 0 && errno == ENOENT)
3949 same = TRUE;
3950 #endif
3951 created1 = TRUE;
3953 if (f1 >= 0)
3955 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3956 if (f2 < 0)
3958 f2 = mch_open_rw((char *)fname2,
3959 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3960 created2 = TRUE;
3962 if (f2 >= 0)
3965 * Both files exist now. If mch_stat() returns the
3966 * same device and inode they are the same file.
3968 if (mch_fstat(f1, &s1) != -1
3969 && mch_fstat(f2, &s2) != -1
3970 && s1.st_dev == s2.st_dev
3971 && s1.st_ino == s2.st_ino)
3972 same = TRUE;
3973 close(f2);
3974 if (created2)
3975 mch_remove(fname2);
3977 close(f1);
3978 if (created1)
3979 mch_remove(fname);
3981 vim_free(fname2);
3982 if (same)
3984 buf->b_shortname = TRUE;
3985 vim_free(fname);
3986 fname = makeswapname(buf->b_fname, buf->b_ffname,
3987 buf, dir_name);
3988 continue; /* try again with b_shortname set */
3993 #endif
3995 * check if the swapfile already exists
3997 if (mch_getperm(fname) < 0) /* it does not exist */
3999 #ifdef HAVE_LSTAT
4000 struct stat sb;
4003 * Extra security check: When a swap file is a symbolic link, this
4004 * is most likely a symlink attack.
4006 if (mch_lstat((char *)fname, &sb) < 0)
4007 #else
4008 # ifdef AMIGA
4009 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4011 * on the Amiga mch_getperm() will return -1 when the file exists
4012 * but is being used by another program. This happens if you edit
4013 * a file twice.
4015 if (fh != (BPTR)NULL) /* can open file, OK */
4017 Close(fh);
4018 mch_remove(fname);
4019 break;
4021 if (IoErr() != ERROR_OBJECT_IN_USE
4022 && IoErr() != ERROR_OBJECT_EXISTS)
4023 # endif
4024 #endif
4025 break;
4029 * A file name equal to old_fname is OK to use.
4031 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4032 break;
4035 * get here when file already exists
4037 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4039 #ifndef SHORT_FNAME
4041 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4042 * and file.doc are the same file. To guess if this problem is
4043 * present try if file.doc.swx exists. If it does, we set
4044 * buf->b_shortname and try file_doc.swp (dots replaced by
4045 * underscores for this file), and try again. If it doesn't we
4046 * assume that "file.doc.swp" already exists.
4048 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4050 fname[n - 1] = 'x';
4051 r = mch_getperm(fname); /* try "file.swx" */
4052 fname[n - 1] = 'p';
4053 if (r >= 0) /* "file.swx" seems to exist */
4055 buf->b_shortname = TRUE;
4056 vim_free(fname);
4057 fname = makeswapname(buf->b_fname, buf->b_ffname,
4058 buf, dir_name);
4059 continue; /* try again with '.' replaced with '_' */
4062 #endif
4064 * If we get here the ".swp" file really exists.
4065 * Give an error message, unless recovering, no file name, we are
4066 * viewing a help file or when the path of the file is different
4067 * (happens when all .swp files are in one directory).
4069 if (!recoverymode && buf->b_fname != NULL
4070 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4072 int fd;
4073 struct block0 b0;
4074 int differ = FALSE;
4077 * Try to read block 0 from the swap file to get the original
4078 * file name (and inode number).
4080 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4081 if (fd >= 0)
4083 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4086 * If the swapfile has the same directory as the
4087 * buffer don't compare the directory names, they can
4088 * have a different mountpoint.
4090 if (b0.b0_flags & B0_SAME_DIR)
4092 if (fnamecmp(gettail(buf->b_ffname),
4093 gettail(b0.b0_fname)) != 0
4094 || !same_directory(fname, buf->b_ffname))
4096 #ifdef CHECK_INODE
4097 /* Symlinks may point to the same file even
4098 * when the name differs, need to check the
4099 * inode too. */
4100 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4101 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4102 char_to_long(b0.b0_ino)))
4103 #endif
4104 differ = TRUE;
4107 else
4110 * The name in the swap file may be
4111 * "~user/path/file". Expand it first.
4113 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4114 #ifdef CHECK_INODE
4115 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4116 char_to_long(b0.b0_ino)))
4117 differ = TRUE;
4118 #else
4119 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4120 differ = TRUE;
4121 #endif
4124 close(fd);
4126 #ifdef RISCOS
4127 else
4128 /* Can't open swap file, though it does exist.
4129 * Assume that the user is editing two files with
4130 * the same name in different directories. No error.
4132 differ = TRUE;
4133 #endif
4135 /* give the ATTENTION message when there is an old swap file
4136 * for the current file, and the buffer was not recovered. */
4137 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4138 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4140 #if defined(HAS_SWAP_EXISTS_ACTION)
4141 int choice = 0;
4142 #endif
4143 #ifdef CREATE_DUMMY_FILE
4144 int did_use_dummy = FALSE;
4146 /* Avoid getting a warning for the file being created
4147 * outside of Vim, it was created at the start of this
4148 * function. Delete the file now, because Vim might exit
4149 * here if the window is closed. */
4150 if (dummyfd != NULL)
4152 fclose(dummyfd);
4153 dummyfd = NULL;
4154 mch_remove(buf->b_fname);
4155 did_use_dummy = TRUE;
4157 #endif
4159 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4160 process_still_running = FALSE;
4161 #endif
4162 #ifdef FEAT_AUTOCMD
4164 * If there is an SwapExists autocommand and we can handle
4165 * the response, trigger it. It may return 0 to ask the
4166 * user anyway.
4168 if (swap_exists_action != SEA_NONE
4169 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4170 choice = do_swapexists(buf, fname);
4172 if (choice == 0)
4173 #endif
4175 #ifdef FEAT_GUI
4176 /* If we are supposed to start the GUI but it wasn't
4177 * completely started yet, start it now. This makes
4178 * the messages displayed in the Vim window when
4179 * loading a session from the .gvimrc file. */
4180 if (gui.starting && !gui.in_use)
4181 gui_start();
4182 #endif
4183 /* Show info about the existing swap file. */
4184 attention_message(buf, fname);
4186 /* We don't want a 'q' typed at the more-prompt
4187 * interrupt loading a file. */
4188 got_int = FALSE;
4191 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4192 if (swap_exists_action != SEA_NONE && choice == 0)
4194 char_u *name;
4196 name = alloc((unsigned)(STRLEN(fname)
4197 + STRLEN(_("Swap file \""))
4198 + STRLEN(_("\" already exists!")) + 5));
4199 if (name != NULL)
4201 STRCPY(name, _("Swap file \""));
4202 home_replace(NULL, fname, name + STRLEN(name),
4203 1000, TRUE);
4204 STRCAT(name, _("\" already exists!"));
4206 choice = do_dialog(VIM_WARNING,
4207 (char_u *)_("VIM - ATTENTION"),
4208 name == NULL
4209 ? (char_u *)_("Swap file already exists!")
4210 : name,
4211 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4212 process_still_running
4213 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4214 # endif
4215 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4217 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4218 if (process_still_running && choice >= 4)
4219 choice++; /* Skip missing "Delete it" button */
4220 # endif
4221 vim_free(name);
4223 /* pretend screen didn't scroll, need redraw anyway */
4224 msg_scrolled = 0;
4225 redraw_all_later(NOT_VALID);
4227 #endif
4229 #if defined(HAS_SWAP_EXISTS_ACTION)
4230 if (choice > 0)
4232 switch (choice)
4234 case 1:
4235 buf->b_p_ro = TRUE;
4236 break;
4237 case 2:
4238 break;
4239 case 3:
4240 swap_exists_action = SEA_RECOVER;
4241 break;
4242 case 4:
4243 mch_remove(fname);
4244 break;
4245 case 5:
4246 swap_exists_action = SEA_QUIT;
4247 break;
4248 case 6:
4249 swap_exists_action = SEA_QUIT;
4250 got_int = TRUE;
4251 break;
4254 /* If the file was deleted this fname can be used. */
4255 if (mch_getperm(fname) < 0)
4256 break;
4258 else
4259 #endif
4261 MSG_PUTS("\n");
4262 if (msg_silent == 0)
4263 /* call wait_return() later */
4264 need_wait_return = TRUE;
4267 #ifdef CREATE_DUMMY_FILE
4268 /* Going to try another name, need the dummy file again. */
4269 if (did_use_dummy)
4270 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4271 #endif
4277 * Change the ".swp" extension to find another file that can be used.
4278 * First decrement the last char: ".swo", ".swn", etc.
4279 * If that still isn't enough decrement the last but one char: ".svz"
4280 * Can happen when editing many "No Name" buffers.
4282 if (fname[n - 1] == 'a') /* ".s?a" */
4284 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4286 EMSG(_("E326: Too many swap files found"));
4287 vim_free(fname);
4288 fname = NULL;
4289 break;
4291 --fname[n - 2]; /* ".svz", ".suz", etc. */
4292 fname[n - 1] = 'z' + 1;
4294 --fname[n - 1]; /* ".swo", ".swn", etc. */
4297 vim_free(dir_name);
4298 #ifdef CREATE_DUMMY_FILE
4299 if (dummyfd != NULL) /* file has been created temporarily */
4301 fclose(dummyfd);
4302 mch_remove(buf->b_fname);
4304 #endif
4305 return fname;
4308 static int
4309 b0_magic_wrong(b0p)
4310 ZERO_BL *b0p;
4312 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4313 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4314 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4315 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4318 #ifdef CHECK_INODE
4320 * Compare current file name with file name from swap file.
4321 * Try to use inode numbers when possible.
4322 * Return non-zero when files are different.
4324 * When comparing file names a few things have to be taken into consideration:
4325 * - When working over a network the full path of a file depends on the host.
4326 * We check the inode number if possible. It is not 100% reliable though,
4327 * because the device number cannot be used over a network.
4328 * - When a file does not exist yet (editing a new file) there is no inode
4329 * number.
4330 * - The file name in a swap file may not be valid on the current host. The
4331 * "~user" form is used whenever possible to avoid this.
4333 * This is getting complicated, let's make a table:
4335 * ino_c ino_s fname_c fname_s differ =
4337 * both files exist -> compare inode numbers:
4338 * != 0 != 0 X X ino_c != ino_s
4340 * inode number(s) unknown, file names available -> compare file names
4341 * == 0 X OK OK fname_c != fname_s
4342 * X == 0 OK OK fname_c != fname_s
4344 * current file doesn't exist, file for swap file exist, file name(s) not
4345 * available -> probably different
4346 * == 0 != 0 FAIL X TRUE
4347 * == 0 != 0 X FAIL TRUE
4349 * current file exists, inode for swap unknown, file name(s) not
4350 * available -> probably different
4351 * != 0 == 0 FAIL X TRUE
4352 * != 0 == 0 X FAIL TRUE
4354 * current file doesn't exist, inode for swap unknown, one file name not
4355 * available -> probably different
4356 * == 0 == 0 FAIL OK TRUE
4357 * == 0 == 0 OK FAIL TRUE
4359 * current file doesn't exist, inode for swap unknown, both file names not
4360 * available -> probably same file
4361 * == 0 == 0 FAIL FAIL FALSE
4363 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4364 * can't be changed without making the block 0 incompatible with 32 bit
4365 * versions.
4368 static int
4369 fnamecmp_ino(fname_c, fname_s, ino_block0)
4370 char_u *fname_c; /* current file name */
4371 char_u *fname_s; /* file name from swap file */
4372 long ino_block0;
4374 struct stat st;
4375 ino_t ino_c = 0; /* ino of current file */
4376 ino_t ino_s; /* ino of file from swap file */
4377 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4378 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4379 int retval_c; /* flag: buf_c valid */
4380 int retval_s; /* flag: buf_s valid */
4382 if (mch_stat((char *)fname_c, &st) == 0)
4383 ino_c = (ino_t)st.st_ino;
4386 * First we try to get the inode from the file name, because the inode in
4387 * the swap file may be outdated. If that fails (e.g. this path is not
4388 * valid on this machine), use the inode from block 0.
4390 if (mch_stat((char *)fname_s, &st) == 0)
4391 ino_s = (ino_t)st.st_ino;
4392 else
4393 ino_s = (ino_t)ino_block0;
4395 if (ino_c && ino_s)
4396 return (ino_c != ino_s);
4399 * One of the inode numbers is unknown, try a forced vim_FullName() and
4400 * compare the file names.
4402 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4403 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4404 if (retval_c == OK && retval_s == OK)
4405 return (STRCMP(buf_c, buf_s) != 0);
4408 * Can't compare inodes or file names, guess that the files are different,
4409 * unless both appear not to exist at all.
4411 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4412 return FALSE;
4413 return TRUE;
4415 #endif /* CHECK_INODE */
4418 * Move a long integer into a four byte character array.
4419 * Used for machine independency in block zero.
4421 static void
4422 long_to_char(n, s)
4423 long n;
4424 char_u *s;
4426 s[0] = (char_u)(n & 0xff);
4427 n = (unsigned)n >> 8;
4428 s[1] = (char_u)(n & 0xff);
4429 n = (unsigned)n >> 8;
4430 s[2] = (char_u)(n & 0xff);
4431 n = (unsigned)n >> 8;
4432 s[3] = (char_u)(n & 0xff);
4435 static long
4436 char_to_long(s)
4437 char_u *s;
4439 long retval;
4441 retval = s[3];
4442 retval <<= 8;
4443 retval |= s[2];
4444 retval <<= 8;
4445 retval |= s[1];
4446 retval <<= 8;
4447 retval |= s[0];
4449 return retval;
4453 * Set the flags in the first block of the swap file:
4454 * - file is modified or not: buf->b_changed
4455 * - 'fileformat'
4456 * - 'fileencoding'
4458 void
4459 ml_setflags(buf)
4460 buf_T *buf;
4462 bhdr_T *hp;
4463 ZERO_BL *b0p;
4465 if (!buf->b_ml.ml_mfp)
4466 return;
4467 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4469 if (hp->bh_bnum == 0)
4471 b0p = (ZERO_BL *)(hp->bh_data);
4472 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4473 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4474 | (get_fileformat(buf) + 1);
4475 #ifdef FEAT_MBYTE
4476 add_b0_fenc(b0p, buf);
4477 #endif
4478 hp->bh_flags |= BH_DIRTY;
4479 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4480 break;
4485 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4487 #define MLCS_MAXL 800 /* max no of lines in chunk */
4488 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4491 * Keep information for finding byte offset of a line, updtytpe may be one of:
4492 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4493 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4494 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4495 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4497 static void
4498 ml_updatechunk(buf, line, len, updtype)
4499 buf_T *buf;
4500 linenr_T line;
4501 long len;
4502 int updtype;
4504 static buf_T *ml_upd_lastbuf = NULL;
4505 static linenr_T ml_upd_lastline;
4506 static linenr_T ml_upd_lastcurline;
4507 static int ml_upd_lastcurix;
4509 linenr_T curline = ml_upd_lastcurline;
4510 int curix = ml_upd_lastcurix;
4511 long size;
4512 chunksize_T *curchnk;
4513 int rest;
4514 bhdr_T *hp;
4515 DATA_BL *dp;
4517 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4518 return;
4519 if (buf->b_ml.ml_chunksize == NULL)
4521 buf->b_ml.ml_chunksize = (chunksize_T *)
4522 alloc((unsigned)sizeof(chunksize_T) * 100);
4523 if (buf->b_ml.ml_chunksize == NULL)
4525 buf->b_ml.ml_usedchunks = -1;
4526 return;
4528 buf->b_ml.ml_numchunks = 100;
4529 buf->b_ml.ml_usedchunks = 1;
4530 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4531 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4534 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4537 * First line in empty buffer from ml_flush_line() -- reset
4539 buf->b_ml.ml_usedchunks = 1;
4540 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4541 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4542 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4543 return;
4547 * Find chunk that our line belongs to, curline will be at start of the
4548 * chunk.
4550 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4551 || updtype != ML_CHNK_ADDLINE)
4553 for (curline = 1, curix = 0;
4554 curix < buf->b_ml.ml_usedchunks - 1
4555 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4556 curix++)
4558 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4561 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4562 && curix < buf->b_ml.ml_usedchunks - 1)
4564 /* Adjust cached curix & curline */
4565 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4566 curix++;
4568 curchnk = buf->b_ml.ml_chunksize + curix;
4570 if (updtype == ML_CHNK_DELLINE)
4571 len = -len;
4572 curchnk->mlcs_totalsize += len;
4573 if (updtype == ML_CHNK_ADDLINE)
4575 curchnk->mlcs_numlines++;
4577 /* May resize here so we don't have to do it in both cases below */
4578 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4580 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4581 buf->b_ml.ml_chunksize = (chunksize_T *)
4582 vim_realloc(buf->b_ml.ml_chunksize,
4583 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4584 if (buf->b_ml.ml_chunksize == NULL)
4586 /* Hmmmm, Give up on offset for this buffer */
4587 buf->b_ml.ml_usedchunks = -1;
4588 return;
4592 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4594 int count; /* number of entries in block */
4595 int idx;
4596 int text_end;
4597 int linecnt;
4599 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4600 buf->b_ml.ml_chunksize + curix,
4601 (buf->b_ml.ml_usedchunks - curix) *
4602 sizeof(chunksize_T));
4603 /* Compute length of first half of lines in the split chunk */
4604 size = 0;
4605 linecnt = 0;
4606 while (curline < buf->b_ml.ml_line_count
4607 && linecnt < MLCS_MINL)
4609 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4611 buf->b_ml.ml_usedchunks = -1;
4612 return;
4614 dp = (DATA_BL *)(hp->bh_data);
4615 count = (long)(buf->b_ml.ml_locked_high) -
4616 (long)(buf->b_ml.ml_locked_low) + 1;
4617 idx = curline - buf->b_ml.ml_locked_low;
4618 curline = buf->b_ml.ml_locked_high + 1;
4619 if (idx == 0)/* first line in block, text at the end */
4620 text_end = dp->db_txt_end;
4621 else
4622 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4623 /* Compute index of last line to use in this MEMLINE */
4624 rest = count - idx;
4625 if (linecnt + rest > MLCS_MINL)
4627 idx += MLCS_MINL - linecnt - 1;
4628 linecnt = MLCS_MINL;
4630 else
4632 idx = count - 1;
4633 linecnt += rest;
4635 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4637 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4638 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4639 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4640 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4641 buf->b_ml.ml_usedchunks++;
4642 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4643 return;
4645 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4646 && curix == buf->b_ml.ml_usedchunks - 1
4647 && buf->b_ml.ml_line_count - line <= 1)
4650 * We are in the last chunk and it is cheap to crate a new one
4651 * after this. Do it now to avoid the loop above later on
4653 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4654 buf->b_ml.ml_usedchunks++;
4655 if (line == buf->b_ml.ml_line_count)
4657 curchnk->mlcs_numlines = 0;
4658 curchnk->mlcs_totalsize = 0;
4660 else
4663 * Line is just prior to last, move count for last
4664 * This is the common case when loading a new file
4666 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4667 if (hp == NULL)
4669 buf->b_ml.ml_usedchunks = -1;
4670 return;
4672 dp = (DATA_BL *)(hp->bh_data);
4673 if (dp->db_line_count == 1)
4674 rest = dp->db_txt_end - dp->db_txt_start;
4675 else
4676 rest =
4677 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4678 - dp->db_txt_start;
4679 curchnk->mlcs_totalsize = rest;
4680 curchnk->mlcs_numlines = 1;
4681 curchnk[-1].mlcs_totalsize -= rest;
4682 curchnk[-1].mlcs_numlines -= 1;
4686 else if (updtype == ML_CHNK_DELLINE)
4688 curchnk->mlcs_numlines--;
4689 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4690 if (curix < (buf->b_ml.ml_usedchunks - 1)
4691 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4692 <= MLCS_MINL)
4694 curix++;
4695 curchnk = buf->b_ml.ml_chunksize + curix;
4697 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4699 buf->b_ml.ml_usedchunks--;
4700 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4701 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4702 return;
4704 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4705 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4706 > MLCS_MINL))
4708 return;
4711 /* Collapse chunks */
4712 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4713 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4714 buf->b_ml.ml_usedchunks--;
4715 if (curix < buf->b_ml.ml_usedchunks)
4717 mch_memmove(buf->b_ml.ml_chunksize + curix,
4718 buf->b_ml.ml_chunksize + curix + 1,
4719 (buf->b_ml.ml_usedchunks - curix) *
4720 sizeof(chunksize_T));
4722 return;
4724 ml_upd_lastbuf = buf;
4725 ml_upd_lastline = line;
4726 ml_upd_lastcurline = curline;
4727 ml_upd_lastcurix = curix;
4731 * Find offset for line or line with offset.
4732 * Find line with offset if "lnum" is 0; return remaining offset in offp
4733 * Find offset of line if "lnum" > 0
4734 * return -1 if information is not available
4736 long
4737 ml_find_line_or_offset(buf, lnum, offp)
4738 buf_T *buf;
4739 linenr_T lnum;
4740 long *offp;
4742 linenr_T curline;
4743 int curix;
4744 long size;
4745 bhdr_T *hp;
4746 DATA_BL *dp;
4747 int count; /* number of entries in block */
4748 int idx;
4749 int start_idx;
4750 int text_end;
4751 long offset;
4752 int len;
4753 int ffdos = (get_fileformat(buf) == EOL_DOS);
4754 int extra = 0;
4756 /* take care of cached line first */
4757 ml_flush_line(curbuf);
4759 if (buf->b_ml.ml_usedchunks == -1
4760 || buf->b_ml.ml_chunksize == NULL
4761 || lnum < 0)
4762 return -1;
4764 if (offp == NULL)
4765 offset = 0;
4766 else
4767 offset = *offp;
4768 if (lnum == 0 && offset <= 0)
4769 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4771 * Find the last chunk before the one containing our line. Last chunk is
4772 * special because it will never qualify
4774 curline = 1;
4775 curix = size = 0;
4776 while (curix < buf->b_ml.ml_usedchunks - 1
4777 && ((lnum != 0
4778 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4779 || (offset != 0
4780 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4781 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4783 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4784 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4785 if (offset && ffdos)
4786 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4787 curix++;
4790 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4792 if (curline > buf->b_ml.ml_line_count
4793 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4794 return -1;
4795 dp = (DATA_BL *)(hp->bh_data);
4796 count = (long)(buf->b_ml.ml_locked_high) -
4797 (long)(buf->b_ml.ml_locked_low) + 1;
4798 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4799 if (idx == 0)/* first line in block, text at the end */
4800 text_end = dp->db_txt_end;
4801 else
4802 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4803 /* Compute index of last line to use in this MEMLINE */
4804 if (lnum != 0)
4806 if (curline + (count - idx) >= lnum)
4807 idx += lnum - curline - 1;
4808 else
4809 idx = count - 1;
4811 else
4813 extra = 0;
4814 while (offset >= size
4815 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4816 + ffdos)
4818 if (ffdos)
4819 size++;
4820 if (idx == count - 1)
4822 extra = 1;
4823 break;
4825 idx++;
4828 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4829 size += len;
4830 if (offset != 0 && size >= offset)
4832 if (size + ffdos == offset)
4833 *offp = 0;
4834 else if (idx == start_idx)
4835 *offp = offset - size + len;
4836 else
4837 *offp = offset - size + len
4838 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4839 curline += idx - start_idx + extra;
4840 if (curline > buf->b_ml.ml_line_count)
4841 return -1; /* exactly one byte beyond the end */
4842 return curline;
4844 curline = buf->b_ml.ml_locked_high + 1;
4847 if (lnum != 0)
4849 /* Count extra CR characters. */
4850 if (ffdos)
4851 size += lnum - 1;
4853 /* Don't count the last line break if 'bin' and 'noeol'. */
4854 if (buf->b_p_bin && !buf->b_p_eol)
4855 size -= ffdos + 1;
4858 return size;
4862 * Goto byte in buffer with offset 'cnt'.
4864 void
4865 goto_byte(cnt)
4866 long cnt;
4868 long boff = cnt;
4869 linenr_T lnum;
4871 ml_flush_line(curbuf); /* cached line may be dirty */
4872 setpcmark();
4873 if (boff)
4874 --boff;
4875 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4876 if (lnum < 1) /* past the end */
4878 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4879 curwin->w_curswant = MAXCOL;
4880 coladvance((colnr_T)MAXCOL);
4882 else
4884 curwin->w_cursor.lnum = lnum;
4885 curwin->w_cursor.col = (colnr_T)boff;
4886 # ifdef FEAT_VIRTUALEDIT
4887 curwin->w_cursor.coladd = 0;
4888 # endif
4889 curwin->w_set_curswant = TRUE;
4891 check_cursor();
4893 # ifdef FEAT_MBYTE
4894 /* Make sure the cursor is on the first byte of a multi-byte char. */
4895 if (has_mbyte)
4896 mb_adjust_cursor();
4897 # endif
4899 #endif