Merge branch 'vim-with-runtime' into feat/persistent-undo
[vim_extended.git] / src / memline.c
blob6a07c4a542bc2ea6c1b2646368fca298f16276e6
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 = *fname;
1408 #ifdef HAVE_READLINK
1409 char_u fname_buf[MAXPATHL];
1411 /* Expand symlink in the file name, because the swap file is created with
1412 * the actual file instead of with the symlink. */
1413 if (resolve_symlink(*fname, fname_buf) == OK)
1414 fname_res = fname_buf;
1415 #endif
1417 if (list)
1419 /* use msg() to start the scrolling properly */
1420 msg((char_u *)_("Swap files found:"));
1421 msg_putchar('\n');
1425 * Do the loop for every directory in 'directory'.
1426 * First allocate some memory to put the directory name in.
1428 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1429 dirp = p_dir;
1430 while (dir_name != NULL && *dirp)
1433 * Isolate a directory name from *dirp and put it in dir_name (we know
1434 * it is large enough, so use 31000 for length).
1435 * Advance dirp to next directory name.
1437 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1439 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1441 if (fname == NULL || *fname == NULL)
1443 #ifdef VMS
1444 names[0] = vim_strsave((char_u *)"*_sw%");
1445 #else
1446 # ifdef RISCOS
1447 names[0] = vim_strsave((char_u *)"*_sw#");
1448 # else
1449 names[0] = vim_strsave((char_u *)"*.sw?");
1450 # endif
1451 #endif
1452 #if defined(UNIX) || defined(WIN3264)
1453 /* For Unix names starting with a dot are special. MS-Windows
1454 * supports this too, on some file systems. */
1455 names[1] = vim_strsave((char_u *)".*.sw?");
1456 names[2] = vim_strsave((char_u *)".sw?");
1457 num_names = 3;
1458 #else
1459 # ifdef VMS
1460 names[1] = vim_strsave((char_u *)".*_sw%");
1461 num_names = 2;
1462 # else
1463 num_names = 1;
1464 # endif
1465 #endif
1467 else
1468 num_names = recov_file_names(names, fname_res, TRUE);
1470 else /* check directory dir_name */
1472 if (fname == NULL || *fname == NULL)
1474 #ifdef VMS
1475 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1476 #else
1477 # ifdef RISCOS
1478 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1479 # else
1480 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1481 # endif
1482 #endif
1483 #if defined(UNIX) || defined(WIN3264)
1484 /* For Unix names starting with a dot are special. MS-Windows
1485 * supports this too, on some file systems. */
1486 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1487 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1488 num_names = 3;
1489 #else
1490 # ifdef VMS
1491 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1492 num_names = 2;
1493 # else
1494 num_names = 1;
1495 # endif
1496 #endif
1498 else
1500 #if defined(UNIX) || defined(WIN3264)
1501 p = dir_name + STRLEN(dir_name);
1502 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1504 /* Ends with '//', Use Full path for swap name */
1505 tail = make_percent_swname(dir_name, fname_res);
1507 else
1508 #endif
1510 tail = gettail(fname_res);
1511 tail = concat_fnames(dir_name, tail, TRUE);
1513 if (tail == NULL)
1514 num_names = 0;
1515 else
1517 num_names = recov_file_names(names, tail, FALSE);
1518 vim_free(tail);
1523 /* check for out-of-memory */
1524 for (i = 0; i < num_names; ++i)
1526 if (names[i] == NULL)
1528 for (i = 0; i < num_names; ++i)
1529 vim_free(names[i]);
1530 num_names = 0;
1533 if (num_names == 0)
1534 num_files = 0;
1535 else if (expand_wildcards(num_names, names, &num_files, &files,
1536 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1537 num_files = 0;
1540 * When no swap file found, wildcard expansion might have failed (e.g.
1541 * not able to execute the shell).
1542 * Try finding a swap file by simply adding ".swp" to the file name.
1544 if (*dirp == NUL && file_count + num_files == 0
1545 && fname != NULL && *fname != NULL)
1547 struct stat st;
1548 char_u *swapname;
1550 swapname = modname(fname_res,
1551 #if defined(VMS) || defined(RISCOS)
1552 (char_u *)"_swp", FALSE
1553 #else
1554 (char_u *)".swp", TRUE
1555 #endif
1557 if (swapname != NULL)
1559 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1561 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1562 if (files != NULL)
1564 files[0] = swapname;
1565 swapname = NULL;
1566 num_files = 1;
1569 vim_free(swapname);
1574 * remove swapfile name of the current buffer, it must be ignored
1576 if (curbuf->b_ml.ml_mfp != NULL
1577 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1579 for (i = 0; i < num_files; ++i)
1580 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1582 /* Remove the name from files[i]. Move further entries
1583 * down. When the array becomes empty free it here, since
1584 * FreeWild() won't be called below. */
1585 vim_free(files[i]);
1586 if (--num_files == 0)
1587 vim_free(files);
1588 else
1589 for ( ; i < num_files; ++i)
1590 files[i] = files[i + 1];
1593 if (nr > 0)
1595 file_count += num_files;
1596 if (nr <= file_count)
1598 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1599 dirp = (char_u *)""; /* stop searching */
1602 else if (list)
1604 if (dir_name[0] == '.' && dir_name[1] == NUL)
1606 if (fname == NULL || *fname == NULL)
1607 MSG_PUTS(_(" In current directory:\n"));
1608 else
1609 MSG_PUTS(_(" Using specified name:\n"));
1611 else
1613 MSG_PUTS(_(" In directory "));
1614 msg_home_replace(dir_name);
1615 MSG_PUTS(":\n");
1618 if (num_files)
1620 for (i = 0; i < num_files; ++i)
1622 /* print the swap file name */
1623 msg_outnum((long)++file_count);
1624 MSG_PUTS(". ");
1625 msg_puts(gettail(files[i]));
1626 msg_putchar('\n');
1627 (void)swapfile_info(files[i]);
1630 else
1631 MSG_PUTS(_(" -- none --\n"));
1632 out_flush();
1634 else
1635 file_count += num_files;
1637 for (i = 0; i < num_names; ++i)
1638 vim_free(names[i]);
1639 if (num_files > 0)
1640 FreeWild(num_files, files);
1642 vim_free(dir_name);
1643 return file_count;
1646 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1648 * Append the full path to name with path separators made into percent
1649 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1651 static char_u *
1652 make_percent_swname(dir, name)
1653 char_u *dir;
1654 char_u *name;
1656 char_u *d, *s, *f;
1658 f = fix_fname(name != NULL ? name : (char_u *) "");
1659 d = NULL;
1660 if (f != NULL)
1662 s = alloc((unsigned)(STRLEN(f) + 1));
1663 if (s != NULL)
1665 STRCPY(s, f);
1666 for (d = s; *d != NUL; mb_ptr_adv(d))
1667 if (vim_ispathsep(*d))
1668 *d = '%';
1669 d = concat_fnames(dir, s, TRUE);
1670 vim_free(s);
1672 vim_free(f);
1674 return d;
1676 #endif
1678 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1679 static int process_still_running;
1680 #endif
1683 * Give information about an existing swap file.
1684 * Returns timestamp (0 when unknown).
1686 static time_t
1687 swapfile_info(fname)
1688 char_u *fname;
1690 struct stat st;
1691 int fd;
1692 struct block0 b0;
1693 time_t x = (time_t)0;
1694 char *p;
1695 #ifdef UNIX
1696 char_u uname[B0_UNAME_SIZE];
1697 #endif
1699 /* print the swap file date */
1700 if (mch_stat((char *)fname, &st) != -1)
1702 #ifdef UNIX
1703 /* print name of owner of the file */
1704 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1706 MSG_PUTS(_(" owned by: "));
1707 msg_outtrans(uname);
1708 MSG_PUTS(_(" dated: "));
1710 else
1711 #endif
1712 MSG_PUTS(_(" dated: "));
1713 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1714 p = ctime(&x); /* includes '\n' */
1715 if (p == NULL)
1716 MSG_PUTS("(invalid)\n");
1717 else
1718 MSG_PUTS(p);
1722 * print the original file name
1724 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1725 if (fd >= 0)
1727 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1729 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1731 MSG_PUTS(_(" [from Vim version 3.0]"));
1733 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1735 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1737 else
1739 MSG_PUTS(_(" file name: "));
1740 if (b0.b0_fname[0] == NUL)
1741 MSG_PUTS(_("[No Name]"));
1742 else
1743 msg_outtrans(b0.b0_fname);
1745 MSG_PUTS(_("\n modified: "));
1746 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1748 if (*(b0.b0_uname) != NUL)
1750 MSG_PUTS(_("\n user name: "));
1751 msg_outtrans(b0.b0_uname);
1754 if (*(b0.b0_hname) != NUL)
1756 if (*(b0.b0_uname) != NUL)
1757 MSG_PUTS(_(" host name: "));
1758 else
1759 MSG_PUTS(_("\n host name: "));
1760 msg_outtrans(b0.b0_hname);
1763 if (char_to_long(b0.b0_pid) != 0L)
1765 MSG_PUTS(_("\n process ID: "));
1766 msg_outnum(char_to_long(b0.b0_pid));
1767 #if defined(UNIX) || defined(__EMX__)
1768 /* EMX kill() not working correctly, it seems */
1769 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1771 MSG_PUTS(_(" (still running)"));
1772 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1773 process_still_running = TRUE;
1774 # endif
1776 #endif
1779 if (b0_magic_wrong(&b0))
1781 #if defined(MSDOS) || defined(MSWIN)
1782 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1783 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1784 else
1785 #endif
1786 MSG_PUTS(_("\n [not usable on this computer]"));
1790 else
1791 MSG_PUTS(_(" [cannot be read]"));
1792 close(fd);
1794 else
1795 MSG_PUTS(_(" [cannot be opened]"));
1796 msg_putchar('\n');
1798 return x;
1801 static int
1802 recov_file_names(names, path, prepend_dot)
1803 char_u **names;
1804 char_u *path;
1805 int prepend_dot;
1807 int num_names;
1809 #ifdef SHORT_FNAME
1811 * (MS-DOS) always short names
1813 names[0] = modname(path, (char_u *)".sw?", FALSE);
1814 num_names = 1;
1815 #else /* !SHORT_FNAME */
1817 * (Win32 and Win64) never short names, but do prepend a dot.
1818 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1819 * Only use the short name if it is different.
1821 char_u *p;
1822 int i;
1823 # ifndef WIN3264
1824 int shortname = curbuf->b_shortname;
1826 curbuf->b_shortname = FALSE;
1827 # endif
1829 num_names = 0;
1832 * May also add the file name with a dot prepended, for swap file in same
1833 * dir as original file.
1835 if (prepend_dot)
1837 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1838 if (names[num_names] == NULL)
1839 goto end;
1840 ++num_names;
1844 * Form the normal swap file name pattern by appending ".sw?".
1846 #ifdef VMS
1847 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1848 #else
1849 # ifdef RISCOS
1850 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1851 # else
1852 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1853 # endif
1854 #endif
1855 if (names[num_names] == NULL)
1856 goto end;
1857 if (num_names >= 1) /* check if we have the same name twice */
1859 p = names[num_names - 1];
1860 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1861 if (i > 0)
1862 p += i; /* file name has been expanded to full path */
1864 if (STRCMP(p, names[num_names]) != 0)
1865 ++num_names;
1866 else
1867 vim_free(names[num_names]);
1869 else
1870 ++num_names;
1872 # ifndef WIN3264
1874 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1876 curbuf->b_shortname = TRUE;
1877 #ifdef VMS
1878 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1879 #else
1880 # ifdef RISCOS
1881 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1882 # else
1883 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1884 # endif
1885 #endif
1886 if (names[num_names] == NULL)
1887 goto end;
1890 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1892 p = names[num_names];
1893 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1894 if (i > 0)
1895 p += i; /* file name has been expanded to full path */
1896 if (STRCMP(names[num_names - 1], p) == 0)
1897 vim_free(names[num_names]);
1898 else
1899 ++num_names;
1900 # endif
1902 end:
1903 # ifndef WIN3264
1904 curbuf->b_shortname = shortname;
1905 # endif
1907 #endif /* !SHORT_FNAME */
1909 return num_names;
1913 * sync all memlines
1915 * If 'check_file' is TRUE, check if original file exists and was not changed.
1916 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1917 * always sync at least one block.
1919 void
1920 ml_sync_all(check_file, check_char)
1921 int check_file;
1922 int check_char;
1924 buf_T *buf;
1925 struct stat st;
1927 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1929 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1930 continue; /* no file */
1932 ml_flush_line(buf); /* flush buffered line */
1933 /* flush locked block */
1934 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1935 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1936 && buf->b_ffname != NULL)
1939 * If the original file does not exist anymore or has been changed
1940 * call ml_preserve() to get rid of all negative numbered blocks.
1942 if (mch_stat((char *)buf->b_ffname, &st) == -1
1943 || st.st_mtime != buf->b_mtime_read
1944 || (size_t)st.st_size != buf->b_orig_size)
1946 ml_preserve(buf, FALSE);
1947 did_check_timestamps = FALSE;
1948 need_check_timestamps = TRUE; /* give message later */
1951 if (buf->b_ml.ml_mfp->mf_dirty)
1953 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1954 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1955 if (check_char && ui_char_avail()) /* character available now */
1956 break;
1962 * sync one buffer, including negative blocks
1964 * after this all the blocks are in the swap file
1966 * Used for the :preserve command and when the original file has been
1967 * changed or deleted.
1969 * when message is TRUE the success of preserving is reported
1971 void
1972 ml_preserve(buf, message)
1973 buf_T *buf;
1974 int message;
1976 bhdr_T *hp;
1977 linenr_T lnum;
1978 memfile_T *mfp = buf->b_ml.ml_mfp;
1979 int status;
1980 int got_int_save = got_int;
1982 if (mfp == NULL || mfp->mf_fname == NULL)
1984 if (message)
1985 EMSG(_("E313: Cannot preserve, there is no swap file"));
1986 return;
1989 /* We only want to stop when interrupted here, not when interrupted
1990 * before. */
1991 got_int = FALSE;
1993 ml_flush_line(buf); /* flush buffered line */
1994 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
1995 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
1997 /* stack is invalid after mf_sync(.., MFS_ALL) */
1998 buf->b_ml.ml_stack_top = 0;
2001 * Some of the data blocks may have been changed from negative to
2002 * positive block number. In that case the pointer blocks need to be
2003 * updated.
2005 * We don't know in which pointer block the references are, so we visit
2006 * all data blocks until there are no more translations to be done (or
2007 * we hit the end of the file, which can only happen in case a write fails,
2008 * e.g. when file system if full).
2009 * ml_find_line() does the work by translating the negative block numbers
2010 * when getting the first line of each data block.
2012 if (mf_need_trans(mfp) && !got_int)
2014 lnum = 1;
2015 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2017 hp = ml_find_line(buf, lnum, ML_FIND);
2018 if (hp == NULL)
2020 status = FAIL;
2021 goto theend;
2023 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2024 lnum = buf->b_ml.ml_locked_high + 1;
2026 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2027 /* sync the updated pointer blocks */
2028 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2029 status = FAIL;
2030 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2032 theend:
2033 got_int |= got_int_save;
2035 if (message)
2037 if (status == OK)
2038 MSG(_("File preserved"));
2039 else
2040 EMSG(_("E314: Preserve failed"));
2045 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2046 * until the next call!
2047 * line1 = ml_get(1);
2048 * line2 = ml_get(2); // line1 is now invalid!
2049 * Make a copy of the line if necessary.
2052 * get a pointer to a (read-only copy of a) line
2054 * On failure an error message is given and IObuff is returned (to avoid
2055 * having to check for error everywhere).
2057 char_u *
2058 ml_get(lnum)
2059 linenr_T lnum;
2061 return ml_get_buf(curbuf, lnum, FALSE);
2065 * ml_get_pos: get pointer to position 'pos'
2067 char_u *
2068 ml_get_pos(pos)
2069 pos_T *pos;
2071 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2075 * ml_get_curline: get pointer to cursor line.
2077 char_u *
2078 ml_get_curline()
2080 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2084 * ml_get_cursor: get pointer to cursor position
2086 char_u *
2087 ml_get_cursor()
2089 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2090 curwin->w_cursor.col);
2094 * get a pointer to a line in a specific buffer
2096 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2097 * changed)
2099 char_u *
2100 ml_get_buf(buf, lnum, will_change)
2101 buf_T *buf;
2102 linenr_T lnum;
2103 int will_change; /* line will be changed */
2105 bhdr_T *hp;
2106 DATA_BL *dp;
2107 char_u *ptr;
2108 static int recursive = 0;
2110 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2112 if (recursive == 0)
2114 /* Avoid giving this message for a recursive call, may happen when
2115 * the GUI redraws part of the text. */
2116 ++recursive;
2117 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2118 --recursive;
2120 errorret:
2121 STRCPY(IObuff, "???");
2122 return IObuff;
2124 if (lnum <= 0) /* pretend line 0 is line 1 */
2125 lnum = 1;
2127 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2128 return (char_u *)"";
2131 * See if it is the same line as requested last time.
2132 * Otherwise may need to flush last used line.
2133 * Don't use the last used line when 'swapfile' is reset, need to load all
2134 * blocks.
2136 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2138 ml_flush_line(buf);
2141 * Find the data block containing the line.
2142 * This also fills the stack with the blocks from the root to the data
2143 * block and releases any locked block.
2145 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2147 if (recursive == 0)
2149 /* Avoid giving this message for a recursive call, may happen
2150 * when the GUI redraws part of the text. */
2151 ++recursive;
2152 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2153 --recursive;
2155 goto errorret;
2158 dp = (DATA_BL *)(hp->bh_data);
2160 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2161 buf->b_ml.ml_line_ptr = ptr;
2162 buf->b_ml.ml_line_lnum = lnum;
2163 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2165 if (will_change)
2166 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2168 return buf->b_ml.ml_line_ptr;
2172 * Check if a line that was just obtained by a call to ml_get
2173 * is in allocated memory.
2176 ml_line_alloced()
2178 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2182 * Append a line after lnum (may be 0 to insert a line in front of the file).
2183 * "line" does not need to be allocated, but can't be another line in a
2184 * buffer, unlocking may make it invalid.
2186 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2187 * will be set for recovery
2188 * Check: The caller of this function should probably also call
2189 * appended_lines().
2191 * return FAIL for failure, OK otherwise
2194 ml_append(lnum, line, len, newfile)
2195 linenr_T lnum; /* append after this line (can be 0) */
2196 char_u *line; /* text of the new line */
2197 colnr_T len; /* length of new line, including NUL, or 0 */
2198 int newfile; /* flag, see above */
2200 /* When starting up, we might still need to create the memfile */
2201 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2202 return FAIL;
2204 if (curbuf->b_ml.ml_line_lnum != 0)
2205 ml_flush_line(curbuf);
2206 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2209 #if defined(FEAT_SPELL) || defined(PROTO)
2211 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2212 * a memline.
2215 ml_append_buf(buf, lnum, line, len, newfile)
2216 buf_T *buf;
2217 linenr_T lnum; /* append after this line (can be 0) */
2218 char_u *line; /* text of the new line */
2219 colnr_T len; /* length of new line, including NUL, or 0 */
2220 int newfile; /* flag, see above */
2222 if (buf->b_ml.ml_mfp == NULL)
2223 return FAIL;
2225 if (buf->b_ml.ml_line_lnum != 0)
2226 ml_flush_line(buf);
2227 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2229 #endif
2231 static int
2232 ml_append_int(buf, lnum, line, len, newfile, mark)
2233 buf_T *buf;
2234 linenr_T lnum; /* append after this line (can be 0) */
2235 char_u *line; /* text of the new line */
2236 colnr_T len; /* length of line, including NUL, or 0 */
2237 int newfile; /* flag, see above */
2238 int mark; /* mark the new line */
2240 int i;
2241 int line_count; /* number of indexes in current block */
2242 int offset;
2243 int from, to;
2244 int space_needed; /* space needed for new line */
2245 int page_size;
2246 int page_count;
2247 int db_idx; /* index for lnum in data block */
2248 bhdr_T *hp;
2249 memfile_T *mfp;
2250 DATA_BL *dp;
2251 PTR_BL *pp;
2252 infoptr_T *ip;
2254 /* lnum out of range */
2255 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2256 return FAIL;
2258 if (lowest_marked && lowest_marked > lnum)
2259 lowest_marked = lnum + 1;
2261 if (len == 0)
2262 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2263 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2265 mfp = buf->b_ml.ml_mfp;
2266 page_size = mfp->mf_page_size;
2269 * find the data block containing the previous line
2270 * This also fills the stack with the blocks from the root to the data block
2271 * This also releases any locked block.
2273 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2274 ML_INSERT)) == NULL)
2275 return FAIL;
2277 buf->b_ml.ml_flags &= ~ML_EMPTY;
2279 if (lnum == 0) /* got line one instead, correct db_idx */
2280 db_idx = -1; /* careful, it is negative! */
2281 else
2282 db_idx = lnum - buf->b_ml.ml_locked_low;
2283 /* get line count before the insertion */
2284 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2286 dp = (DATA_BL *)(hp->bh_data);
2289 * If
2290 * - there is not enough room in the current block
2291 * - appending to the last line in the block
2292 * - not appending to the last line in the file
2293 * insert in front of the next block.
2295 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2296 && lnum < buf->b_ml.ml_line_count)
2299 * Now that the line is not going to be inserted in the block that we
2300 * expected, the line count has to be adjusted in the pointer blocks
2301 * by using ml_locked_lineadd.
2303 --(buf->b_ml.ml_locked_lineadd);
2304 --(buf->b_ml.ml_locked_high);
2305 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2306 return FAIL;
2308 db_idx = -1; /* careful, it is negative! */
2309 /* get line count before the insertion */
2310 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2311 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2313 dp = (DATA_BL *)(hp->bh_data);
2316 ++buf->b_ml.ml_line_count;
2318 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2321 * Insert new line in existing data block, or in data block allocated above.
2323 dp->db_txt_start -= len;
2324 dp->db_free -= space_needed;
2325 ++(dp->db_line_count);
2328 * move the text of the lines that follow to the front
2329 * adjust the indexes of the lines that follow
2331 if (line_count > db_idx + 1) /* if there are following lines */
2334 * Offset is the start of the previous line.
2335 * This will become the character just after the new line.
2337 if (db_idx < 0)
2338 offset = dp->db_txt_end;
2339 else
2340 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2341 mch_memmove((char *)dp + dp->db_txt_start,
2342 (char *)dp + dp->db_txt_start + len,
2343 (size_t)(offset - (dp->db_txt_start + len)));
2344 for (i = line_count - 1; i > db_idx; --i)
2345 dp->db_index[i + 1] = dp->db_index[i] - len;
2346 dp->db_index[db_idx + 1] = offset - len;
2348 else /* add line at the end */
2349 dp->db_index[db_idx + 1] = dp->db_txt_start;
2352 * copy the text into the block
2354 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2355 if (mark)
2356 dp->db_index[db_idx + 1] |= DB_MARKED;
2359 * Mark the block dirty.
2361 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2362 if (!newfile)
2363 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2365 else /* not enough space in data block */
2368 * If there is not enough room we have to create a new data block and copy some
2369 * lines into it.
2370 * Then we have to insert an entry in the pointer block.
2371 * If this pointer block also is full, we go up another block, and so on, up
2372 * to the root if necessary.
2373 * The line counts in the pointer blocks have already been adjusted by
2374 * ml_find_line().
2376 long line_count_left, line_count_right;
2377 int page_count_left, page_count_right;
2378 bhdr_T *hp_left;
2379 bhdr_T *hp_right;
2380 bhdr_T *hp_new;
2381 int lines_moved;
2382 int data_moved = 0; /* init to shut up gcc */
2383 int total_moved = 0; /* init to shut up gcc */
2384 DATA_BL *dp_right, *dp_left;
2385 int stack_idx;
2386 int in_left;
2387 int lineadd;
2388 blocknr_T bnum_left, bnum_right;
2389 linenr_T lnum_left, lnum_right;
2390 int pb_idx;
2391 PTR_BL *pp_new;
2394 * We are going to allocate a new data block. Depending on the
2395 * situation it will be put to the left or right of the existing
2396 * block. If possible we put the new line in the left block and move
2397 * the lines after it to the right block. Otherwise the new line is
2398 * also put in the right block. This method is more efficient when
2399 * inserting a lot of lines at one place.
2401 if (db_idx < 0) /* left block is new, right block is existing */
2403 lines_moved = 0;
2404 in_left = TRUE;
2405 /* space_needed does not change */
2407 else /* left block is existing, right block is new */
2409 lines_moved = line_count - db_idx - 1;
2410 if (lines_moved == 0)
2411 in_left = FALSE; /* put new line in right block */
2412 /* space_needed does not change */
2413 else
2415 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2416 dp->db_txt_start;
2417 total_moved = data_moved + lines_moved * INDEX_SIZE;
2418 if ((int)dp->db_free + total_moved >= space_needed)
2420 in_left = TRUE; /* put new line in left block */
2421 space_needed = total_moved;
2423 else
2425 in_left = FALSE; /* put new line in right block */
2426 space_needed += total_moved;
2431 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2432 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2434 /* correct line counts in pointer blocks */
2435 --(buf->b_ml.ml_locked_lineadd);
2436 --(buf->b_ml.ml_locked_high);
2437 return FAIL;
2439 if (db_idx < 0) /* left block is new */
2441 hp_left = hp_new;
2442 hp_right = hp;
2443 line_count_left = 0;
2444 line_count_right = line_count;
2446 else /* right block is new */
2448 hp_left = hp;
2449 hp_right = hp_new;
2450 line_count_left = line_count;
2451 line_count_right = 0;
2453 dp_right = (DATA_BL *)(hp_right->bh_data);
2454 dp_left = (DATA_BL *)(hp_left->bh_data);
2455 bnum_left = hp_left->bh_bnum;
2456 bnum_right = hp_right->bh_bnum;
2457 page_count_left = hp_left->bh_page_count;
2458 page_count_right = hp_right->bh_page_count;
2461 * May move the new line into the right/new block.
2463 if (!in_left)
2465 dp_right->db_txt_start -= len;
2466 dp_right->db_free -= len + INDEX_SIZE;
2467 dp_right->db_index[0] = dp_right->db_txt_start;
2468 if (mark)
2469 dp_right->db_index[0] |= DB_MARKED;
2471 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2472 line, (size_t)len);
2473 ++line_count_right;
2476 * may move lines from the left/old block to the right/new one.
2478 if (lines_moved)
2482 dp_right->db_txt_start -= data_moved;
2483 dp_right->db_free -= total_moved;
2484 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2485 (char *)dp_left + dp_left->db_txt_start,
2486 (size_t)data_moved);
2487 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2488 dp_left->db_txt_start += data_moved;
2489 dp_left->db_free += total_moved;
2492 * update indexes in the new block
2494 for (to = line_count_right, from = db_idx + 1;
2495 from < line_count_left; ++from, ++to)
2496 dp_right->db_index[to] = dp->db_index[from] + offset;
2497 line_count_right += lines_moved;
2498 line_count_left -= lines_moved;
2502 * May move the new line into the left (old or new) block.
2504 if (in_left)
2506 dp_left->db_txt_start -= len;
2507 dp_left->db_free -= len + INDEX_SIZE;
2508 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2509 if (mark)
2510 dp_left->db_index[line_count_left] |= DB_MARKED;
2511 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2512 line, (size_t)len);
2513 ++line_count_left;
2516 if (db_idx < 0) /* left block is new */
2518 lnum_left = lnum + 1;
2519 lnum_right = 0;
2521 else /* right block is new */
2523 lnum_left = 0;
2524 if (in_left)
2525 lnum_right = lnum + 2;
2526 else
2527 lnum_right = lnum + 1;
2529 dp_left->db_line_count = line_count_left;
2530 dp_right->db_line_count = line_count_right;
2533 * release the two data blocks
2534 * The new one (hp_new) already has a correct blocknumber.
2535 * The old one (hp, in ml_locked) gets a positive blocknumber if
2536 * we changed it and we are not editing a new file.
2538 if (lines_moved || in_left)
2539 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2540 if (!newfile && db_idx >= 0 && in_left)
2541 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2542 mf_put(mfp, hp_new, TRUE, FALSE);
2545 * flush the old data block
2546 * set ml_locked_lineadd to 0, because the updating of the
2547 * pointer blocks is done below
2549 lineadd = buf->b_ml.ml_locked_lineadd;
2550 buf->b_ml.ml_locked_lineadd = 0;
2551 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2554 * update pointer blocks for the new data block
2556 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2557 --stack_idx)
2559 ip = &(buf->b_ml.ml_stack[stack_idx]);
2560 pb_idx = ip->ip_index;
2561 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2562 return FAIL;
2563 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2564 if (pp->pb_id != PTR_ID)
2566 EMSG(_("E317: pointer block id wrong 3"));
2567 mf_put(mfp, hp, FALSE, FALSE);
2568 return FAIL;
2571 * TODO: If the pointer block is full and we are adding at the end
2572 * try to insert in front of the next block
2574 /* block not full, add one entry */
2575 if (pp->pb_count < pp->pb_count_max)
2577 if (pb_idx + 1 < (int)pp->pb_count)
2578 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2579 &pp->pb_pointer[pb_idx + 1],
2580 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2581 ++pp->pb_count;
2582 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2583 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2584 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2585 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2586 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2587 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2589 if (lnum_left != 0)
2590 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2591 if (lnum_right != 0)
2592 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2594 mf_put(mfp, hp, TRUE, FALSE);
2595 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2597 if (lineadd)
2599 --(buf->b_ml.ml_stack_top);
2600 /* fix line count for rest of blocks in the stack */
2601 ml_lineadd(buf, lineadd);
2602 /* fix stack itself */
2603 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2604 lineadd;
2605 ++(buf->b_ml.ml_stack_top);
2609 * We are finished, break the loop here.
2611 break;
2613 else /* pointer block full */
2616 * split the pointer block
2617 * allocate a new pointer block
2618 * move some of the pointer into the new block
2619 * prepare for updating the parent block
2621 for (;;) /* do this twice when splitting block 1 */
2623 hp_new = ml_new_ptr(mfp);
2624 if (hp_new == NULL) /* TODO: try to fix tree */
2625 return FAIL;
2626 pp_new = (PTR_BL *)(hp_new->bh_data);
2628 if (hp->bh_bnum != 1)
2629 break;
2632 * if block 1 becomes full the tree is given an extra level
2633 * The pointers from block 1 are moved into the new block.
2634 * block 1 is updated to point to the new block
2635 * then continue to split the new block
2637 mch_memmove(pp_new, pp, (size_t)page_size);
2638 pp->pb_count = 1;
2639 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2640 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2641 pp->pb_pointer[0].pe_old_lnum = 1;
2642 pp->pb_pointer[0].pe_page_count = 1;
2643 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2644 hp = hp_new; /* new block is to be split */
2645 pp = pp_new;
2646 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2647 ip->ip_index = 0;
2648 ++stack_idx; /* do block 1 again later */
2651 * move the pointers after the current one to the new block
2652 * If there are none, the new entry will be in the new block.
2654 total_moved = pp->pb_count - pb_idx - 1;
2655 if (total_moved)
2657 mch_memmove(&pp_new->pb_pointer[0],
2658 &pp->pb_pointer[pb_idx + 1],
2659 (size_t)(total_moved) * sizeof(PTR_EN));
2660 pp_new->pb_count = total_moved;
2661 pp->pb_count -= total_moved - 1;
2662 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2663 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2664 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2665 if (lnum_right)
2666 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2668 else
2670 pp_new->pb_count = 1;
2671 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2672 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2673 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2674 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2676 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2677 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2678 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2679 if (lnum_left)
2680 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2681 lnum_left = 0;
2682 lnum_right = 0;
2685 * recompute line counts
2687 line_count_right = 0;
2688 for (i = 0; i < (int)pp_new->pb_count; ++i)
2689 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2690 line_count_left = 0;
2691 for (i = 0; i < (int)pp->pb_count; ++i)
2692 line_count_left += pp->pb_pointer[i].pe_line_count;
2694 bnum_left = hp->bh_bnum;
2695 bnum_right = hp_new->bh_bnum;
2696 page_count_left = 1;
2697 page_count_right = 1;
2698 mf_put(mfp, hp, TRUE, FALSE);
2699 mf_put(mfp, hp_new, TRUE, FALSE);
2704 * Safety check: fallen out of for loop?
2706 if (stack_idx < 0)
2708 EMSG(_("E318: Updated too many blocks?"));
2709 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2713 #ifdef FEAT_BYTEOFF
2714 /* The line was inserted below 'lnum' */
2715 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2716 #endif
2717 #ifdef FEAT_NETBEANS_INTG
2718 if (usingNetbeans)
2720 if (STRLEN(line) > 0)
2721 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2722 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2723 (char_u *)"\n", 1);
2725 #endif
2726 return OK;
2730 * Replace line lnum, with buffering, in current buffer.
2732 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2733 * copied to allocated memory already.
2735 * Check: The caller of this function should probably also call
2736 * changed_lines(), unless update_screen(NOT_VALID) is used.
2738 * return FAIL for failure, OK otherwise
2741 ml_replace(lnum, line, copy)
2742 linenr_T lnum;
2743 char_u *line;
2744 int copy;
2746 if (line == NULL) /* just checking... */
2747 return FAIL;
2749 /* When starting up, we might still need to create the memfile */
2750 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2751 return FAIL;
2753 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2754 return FAIL;
2755 #ifdef FEAT_NETBEANS_INTG
2756 if (usingNetbeans)
2758 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2759 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2761 #endif
2762 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2763 ml_flush_line(curbuf); /* flush it */
2764 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2765 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2766 curbuf->b_ml.ml_line_ptr = line;
2767 curbuf->b_ml.ml_line_lnum = lnum;
2768 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2770 return OK;
2774 * Delete line 'lnum' in the current buffer.
2776 * Check: The caller of this function should probably also call
2777 * deleted_lines() after this.
2779 * return FAIL for failure, OK otherwise
2782 ml_delete(lnum, message)
2783 linenr_T lnum;
2784 int message;
2786 ml_flush_line(curbuf);
2787 return ml_delete_int(curbuf, lnum, message);
2790 static int
2791 ml_delete_int(buf, lnum, message)
2792 buf_T *buf;
2793 linenr_T lnum;
2794 int message;
2796 bhdr_T *hp;
2797 memfile_T *mfp;
2798 DATA_BL *dp;
2799 PTR_BL *pp;
2800 infoptr_T *ip;
2801 int count; /* number of entries in block */
2802 int idx;
2803 int stack_idx;
2804 int text_start;
2805 int line_start;
2806 long line_size;
2807 int i;
2809 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2810 return FAIL;
2812 if (lowest_marked && lowest_marked > lnum)
2813 lowest_marked--;
2816 * If the file becomes empty the last line is replaced by an empty line.
2818 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2820 if (message
2821 #ifdef FEAT_NETBEANS_INTG
2822 && !netbeansSuppressNoLines
2823 #endif
2825 set_keep_msg((char_u *)_(no_lines_msg), 0);
2827 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2828 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2829 buf->b_ml.ml_flags |= ML_EMPTY;
2831 return i;
2835 * find the data block containing the line
2836 * This also fills the stack with the blocks from the root to the data block
2837 * This also releases any locked block.
2839 mfp = buf->b_ml.ml_mfp;
2840 if (mfp == NULL)
2841 return FAIL;
2843 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2844 return FAIL;
2846 dp = (DATA_BL *)(hp->bh_data);
2847 /* compute line count before the delete */
2848 count = (long)(buf->b_ml.ml_locked_high)
2849 - (long)(buf->b_ml.ml_locked_low) + 2;
2850 idx = lnum - buf->b_ml.ml_locked_low;
2852 --buf->b_ml.ml_line_count;
2854 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2855 if (idx == 0) /* first line in block, text at the end */
2856 line_size = dp->db_txt_end - line_start;
2857 else
2858 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2860 #ifdef FEAT_NETBEANS_INTG
2861 if (usingNetbeans)
2862 netbeans_removed(buf, lnum, 0, (long)line_size);
2863 #endif
2866 * special case: If there is only one line in the data block it becomes empty.
2867 * Then we have to remove the entry, pointing to this data block, from the
2868 * pointer block. If this pointer block also becomes empty, we go up another
2869 * block, and so on, up to the root if necessary.
2870 * The line counts in the pointer blocks have already been adjusted by
2871 * ml_find_line().
2873 if (count == 1)
2875 mf_free(mfp, hp); /* free the data block */
2876 buf->b_ml.ml_locked = NULL;
2878 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2880 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2881 ip = &(buf->b_ml.ml_stack[stack_idx]);
2882 idx = ip->ip_index;
2883 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2884 return FAIL;
2885 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2886 if (pp->pb_id != PTR_ID)
2888 EMSG(_("E317: pointer block id wrong 4"));
2889 mf_put(mfp, hp, FALSE, FALSE);
2890 return FAIL;
2892 count = --(pp->pb_count);
2893 if (count == 0) /* the pointer block becomes empty! */
2894 mf_free(mfp, hp);
2895 else
2897 if (count != idx) /* move entries after the deleted one */
2898 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2899 (size_t)(count - idx) * sizeof(PTR_EN));
2900 mf_put(mfp, hp, TRUE, FALSE);
2902 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2903 /* fix line count for rest of blocks in the stack */
2904 if (buf->b_ml.ml_locked_lineadd != 0)
2906 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2907 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2908 buf->b_ml.ml_locked_lineadd;
2910 ++(buf->b_ml.ml_stack_top);
2912 break;
2915 CHECK(stack_idx < 0, _("deleted block 1?"));
2917 else
2920 * delete the text by moving the next lines forwards
2922 text_start = dp->db_txt_start;
2923 mch_memmove((char *)dp + text_start + line_size,
2924 (char *)dp + text_start, (size_t)(line_start - text_start));
2927 * delete the index by moving the next indexes backwards
2928 * Adjust the indexes for the text movement.
2930 for (i = idx; i < count - 1; ++i)
2931 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2933 dp->db_free += line_size + INDEX_SIZE;
2934 dp->db_txt_start += line_size;
2935 --(dp->db_line_count);
2938 * mark the block dirty and make sure it is in the file (for recovery)
2940 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2943 #ifdef FEAT_BYTEOFF
2944 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2945 #endif
2946 return OK;
2950 * set the B_MARKED flag for line 'lnum'
2952 void
2953 ml_setmarked(lnum)
2954 linenr_T lnum;
2956 bhdr_T *hp;
2957 DATA_BL *dp;
2958 /* invalid line number */
2959 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2960 || curbuf->b_ml.ml_mfp == NULL)
2961 return; /* give error message? */
2963 if (lowest_marked == 0 || lowest_marked > lnum)
2964 lowest_marked = lnum;
2967 * find the data block containing the line
2968 * This also fills the stack with the blocks from the root to the data block
2969 * This also releases any locked block.
2971 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2972 return; /* give error message? */
2974 dp = (DATA_BL *)(hp->bh_data);
2975 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2976 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2980 * find the first line with its B_MARKED flag set
2982 linenr_T
2983 ml_firstmarked()
2985 bhdr_T *hp;
2986 DATA_BL *dp;
2987 linenr_T lnum;
2988 int i;
2990 if (curbuf->b_ml.ml_mfp == NULL)
2991 return (linenr_T) 0;
2994 * The search starts with lowest_marked line. This is the last line where
2995 * a mark was found, adjusted by inserting/deleting lines.
2997 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3000 * Find the data block containing the line.
3001 * This also fills the stack with the blocks from the root to the data
3002 * block This also releases any locked block.
3004 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3005 return (linenr_T)0; /* give error message? */
3007 dp = (DATA_BL *)(hp->bh_data);
3009 for (i = lnum - curbuf->b_ml.ml_locked_low;
3010 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3011 if ((dp->db_index[i]) & DB_MARKED)
3013 (dp->db_index[i]) &= DB_INDEX_MASK;
3014 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3015 lowest_marked = lnum + 1;
3016 return lnum;
3020 return (linenr_T) 0;
3023 #if 0 /* not used */
3025 * return TRUE if line 'lnum' has a mark
3028 ml_has_mark(lnum)
3029 linenr_T lnum;
3031 bhdr_T *hp;
3032 DATA_BL *dp;
3034 if (curbuf->b_ml.ml_mfp == NULL
3035 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3036 return FALSE;
3038 dp = (DATA_BL *)(hp->bh_data);
3039 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3041 #endif
3044 * clear all DB_MARKED flags
3046 void
3047 ml_clearmarked()
3049 bhdr_T *hp;
3050 DATA_BL *dp;
3051 linenr_T lnum;
3052 int i;
3054 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3055 return;
3058 * The search starts with line lowest_marked.
3060 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3063 * Find the data block containing the line.
3064 * This also fills the stack with the blocks from the root to the data
3065 * block and releases any locked block.
3067 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3068 return; /* give error message? */
3070 dp = (DATA_BL *)(hp->bh_data);
3072 for (i = lnum - curbuf->b_ml.ml_locked_low;
3073 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3074 if ((dp->db_index[i]) & DB_MARKED)
3076 (dp->db_index[i]) &= DB_INDEX_MASK;
3077 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3081 lowest_marked = 0;
3082 return;
3086 * flush ml_line if necessary
3088 static void
3089 ml_flush_line(buf)
3090 buf_T *buf;
3092 bhdr_T *hp;
3093 DATA_BL *dp;
3094 linenr_T lnum;
3095 char_u *new_line;
3096 char_u *old_line;
3097 colnr_T new_len;
3098 int old_len;
3099 int extra;
3100 int idx;
3101 int start;
3102 int count;
3103 int i;
3104 static int entered = FALSE;
3106 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3107 return; /* nothing to do */
3109 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3111 /* This code doesn't work recursively, but Netbeans may call back here
3112 * when obtaining the cursor position. */
3113 if (entered)
3114 return;
3115 entered = TRUE;
3117 lnum = buf->b_ml.ml_line_lnum;
3118 new_line = buf->b_ml.ml_line_ptr;
3120 hp = ml_find_line(buf, lnum, ML_FIND);
3121 if (hp == NULL)
3122 EMSGN(_("E320: Cannot find line %ld"), lnum);
3123 else
3125 dp = (DATA_BL *)(hp->bh_data);
3126 idx = lnum - buf->b_ml.ml_locked_low;
3127 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3128 old_line = (char_u *)dp + start;
3129 if (idx == 0) /* line is last in block */
3130 old_len = dp->db_txt_end - start;
3131 else /* text of previous line follows */
3132 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3133 new_len = (colnr_T)STRLEN(new_line) + 1;
3134 extra = new_len - old_len; /* negative if lines gets smaller */
3137 * if new line fits in data block, replace directly
3139 if ((int)dp->db_free >= extra)
3141 /* if the length changes and there are following lines */
3142 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3143 if (extra != 0 && idx < count - 1)
3145 /* move text of following lines */
3146 mch_memmove((char *)dp + dp->db_txt_start - extra,
3147 (char *)dp + dp->db_txt_start,
3148 (size_t)(start - dp->db_txt_start));
3150 /* adjust pointers of this and following lines */
3151 for (i = idx + 1; i < count; ++i)
3152 dp->db_index[i] -= extra;
3154 dp->db_index[idx] -= extra;
3156 /* adjust free space */
3157 dp->db_free -= extra;
3158 dp->db_txt_start -= extra;
3160 /* copy new line into the data block */
3161 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3162 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3163 #ifdef FEAT_BYTEOFF
3164 /* The else case is already covered by the insert and delete */
3165 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3166 #endif
3168 else
3171 * Cannot do it in one data block: Delete and append.
3172 * Append first, because ml_delete_int() cannot delete the
3173 * last line in a buffer, which causes trouble for a buffer
3174 * that has only one line.
3175 * Don't forget to copy the mark!
3177 /* How about handling errors??? */
3178 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3179 (dp->db_index[idx] & DB_MARKED));
3180 (void)ml_delete_int(buf, lnum, FALSE);
3183 vim_free(new_line);
3185 entered = FALSE;
3188 buf->b_ml.ml_line_lnum = 0;
3192 * create a new, empty, data block
3194 static bhdr_T *
3195 ml_new_data(mfp, negative, page_count)
3196 memfile_T *mfp;
3197 int negative;
3198 int page_count;
3200 bhdr_T *hp;
3201 DATA_BL *dp;
3203 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3204 return NULL;
3206 dp = (DATA_BL *)(hp->bh_data);
3207 dp->db_id = DATA_ID;
3208 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3209 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3210 dp->db_line_count = 0;
3212 return hp;
3216 * create a new, empty, pointer block
3218 static bhdr_T *
3219 ml_new_ptr(mfp)
3220 memfile_T *mfp;
3222 bhdr_T *hp;
3223 PTR_BL *pp;
3225 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3226 return NULL;
3228 pp = (PTR_BL *)(hp->bh_data);
3229 pp->pb_id = PTR_ID;
3230 pp->pb_count = 0;
3231 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3233 return hp;
3237 * lookup line 'lnum' in a memline
3239 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3240 * if ML_FLUSH only flush a locked block
3241 * if ML_FIND just find the line
3243 * If the block was found it is locked and put in ml_locked.
3244 * The stack is updated to lead to the locked block. The ip_high field in
3245 * the stack is updated to reflect the last line in the block AFTER the
3246 * insert or delete, also if the pointer block has not been updated yet. But
3247 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3249 * return: NULL for failure, pointer to block header otherwise
3251 static bhdr_T *
3252 ml_find_line(buf, lnum, action)
3253 buf_T *buf;
3254 linenr_T lnum;
3255 int action;
3257 DATA_BL *dp;
3258 PTR_BL *pp;
3259 infoptr_T *ip;
3260 bhdr_T *hp;
3261 memfile_T *mfp;
3262 linenr_T t;
3263 blocknr_T bnum, bnum2;
3264 int dirty;
3265 linenr_T low, high;
3266 int top;
3267 int page_count;
3268 int idx;
3270 mfp = buf->b_ml.ml_mfp;
3273 * If there is a locked block check if the wanted line is in it.
3274 * If not, flush and release the locked block.
3275 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3276 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3277 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3279 if (buf->b_ml.ml_locked)
3281 if (ML_SIMPLE(action)
3282 && buf->b_ml.ml_locked_low <= lnum
3283 && buf->b_ml.ml_locked_high >= lnum
3284 && !mf_dont_release)
3286 /* remember to update pointer blocks and stack later */
3287 if (action == ML_INSERT)
3289 ++(buf->b_ml.ml_locked_lineadd);
3290 ++(buf->b_ml.ml_locked_high);
3292 else if (action == ML_DELETE)
3294 --(buf->b_ml.ml_locked_lineadd);
3295 --(buf->b_ml.ml_locked_high);
3297 return (buf->b_ml.ml_locked);
3300 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3301 buf->b_ml.ml_flags & ML_LOCKED_POS);
3302 buf->b_ml.ml_locked = NULL;
3305 * If lines have been added or deleted in the locked block, need to
3306 * update the line count in pointer blocks.
3308 if (buf->b_ml.ml_locked_lineadd != 0)
3309 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3312 if (action == ML_FLUSH) /* nothing else to do */
3313 return NULL;
3315 bnum = 1; /* start at the root of the tree */
3316 page_count = 1;
3317 low = 1;
3318 high = buf->b_ml.ml_line_count;
3320 if (action == ML_FIND) /* first try stack entries */
3322 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3324 ip = &(buf->b_ml.ml_stack[top]);
3325 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3327 bnum = ip->ip_bnum;
3328 low = ip->ip_low;
3329 high = ip->ip_high;
3330 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3331 break;
3334 if (top < 0)
3335 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3337 else /* ML_DELETE or ML_INSERT */
3338 buf->b_ml.ml_stack_top = 0; /* start at the root */
3341 * search downwards in the tree until a data block is found
3343 for (;;)
3345 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3346 goto error_noblock;
3349 * update high for insert/delete
3351 if (action == ML_INSERT)
3352 ++high;
3353 else if (action == ML_DELETE)
3354 --high;
3356 dp = (DATA_BL *)(hp->bh_data);
3357 if (dp->db_id == DATA_ID) /* data block */
3359 buf->b_ml.ml_locked = hp;
3360 buf->b_ml.ml_locked_low = low;
3361 buf->b_ml.ml_locked_high = high;
3362 buf->b_ml.ml_locked_lineadd = 0;
3363 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3364 return hp;
3367 pp = (PTR_BL *)(dp); /* must be pointer block */
3368 if (pp->pb_id != PTR_ID)
3370 EMSG(_("E317: pointer block id wrong"));
3371 goto error_block;
3374 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3375 goto error_block;
3376 ip = &(buf->b_ml.ml_stack[top]);
3377 ip->ip_bnum = bnum;
3378 ip->ip_low = low;
3379 ip->ip_high = high;
3380 ip->ip_index = -1; /* index not known yet */
3382 dirty = FALSE;
3383 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3385 t = pp->pb_pointer[idx].pe_line_count;
3386 CHECK(t == 0, _("pe_line_count is zero"));
3387 if ((low += t) > lnum)
3389 ip->ip_index = idx;
3390 bnum = pp->pb_pointer[idx].pe_bnum;
3391 page_count = pp->pb_pointer[idx].pe_page_count;
3392 high = low - 1;
3393 low -= t;
3396 * a negative block number may have been changed
3398 if (bnum < 0)
3400 bnum2 = mf_trans_del(mfp, bnum);
3401 if (bnum != bnum2)
3403 bnum = bnum2;
3404 pp->pb_pointer[idx].pe_bnum = bnum;
3405 dirty = TRUE;
3409 break;
3412 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3414 if (lnum > buf->b_ml.ml_line_count)
3415 EMSGN(_("E322: line number out of range: %ld past the end"),
3416 lnum - buf->b_ml.ml_line_count);
3418 else
3419 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3420 goto error_block;
3422 if (action == ML_DELETE)
3424 pp->pb_pointer[idx].pe_line_count--;
3425 dirty = TRUE;
3427 else if (action == ML_INSERT)
3429 pp->pb_pointer[idx].pe_line_count++;
3430 dirty = TRUE;
3432 mf_put(mfp, hp, dirty, FALSE);
3435 error_block:
3436 mf_put(mfp, hp, FALSE, FALSE);
3437 error_noblock:
3439 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3440 * the incremented/decremented line counts, because there won't be a line
3441 * inserted/deleted after all.
3443 if (action == ML_DELETE)
3444 ml_lineadd(buf, 1);
3445 else if (action == ML_INSERT)
3446 ml_lineadd(buf, -1);
3447 buf->b_ml.ml_stack_top = 0;
3448 return NULL;
3452 * add an entry to the info pointer stack
3454 * return -1 for failure, number of the new entry otherwise
3456 static int
3457 ml_add_stack(buf)
3458 buf_T *buf;
3460 int top;
3461 infoptr_T *newstack;
3463 top = buf->b_ml.ml_stack_top;
3465 /* may have to increase the stack size */
3466 if (top == buf->b_ml.ml_stack_size)
3468 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3470 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3471 (buf->b_ml.ml_stack_size + STACK_INCR));
3472 if (newstack == NULL)
3473 return -1;
3474 mch_memmove(newstack, buf->b_ml.ml_stack,
3475 (size_t)top * sizeof(infoptr_T));
3476 vim_free(buf->b_ml.ml_stack);
3477 buf->b_ml.ml_stack = newstack;
3478 buf->b_ml.ml_stack_size += STACK_INCR;
3481 buf->b_ml.ml_stack_top++;
3482 return top;
3486 * Update the pointer blocks on the stack for inserted/deleted lines.
3487 * The stack itself is also updated.
3489 * When a insert/delete line action fails, the line is not inserted/deleted,
3490 * but the pointer blocks have already been updated. That is fixed here by
3491 * walking through the stack.
3493 * Count is the number of lines added, negative if lines have been deleted.
3495 static void
3496 ml_lineadd(buf, count)
3497 buf_T *buf;
3498 int count;
3500 int idx;
3501 infoptr_T *ip;
3502 PTR_BL *pp;
3503 memfile_T *mfp = buf->b_ml.ml_mfp;
3504 bhdr_T *hp;
3506 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3508 ip = &(buf->b_ml.ml_stack[idx]);
3509 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3510 break;
3511 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3512 if (pp->pb_id != PTR_ID)
3514 mf_put(mfp, hp, FALSE, FALSE);
3515 EMSG(_("E317: pointer block id wrong 2"));
3516 break;
3518 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3519 ip->ip_high += count;
3520 mf_put(mfp, hp, TRUE, FALSE);
3524 #ifdef HAVE_READLINK
3526 * Resolve a symlink in the last component of a file name.
3527 * Note that f_resolve() does it for every part of the path, we don't do that
3528 * here.
3529 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3530 * Otherwise returns FAIL.
3532 static int
3533 resolve_symlink(fname, buf)
3534 char_u *fname;
3535 char_u *buf;
3537 char_u tmp[MAXPATHL];
3538 int ret;
3539 int depth = 0;
3541 if (fname == NULL)
3542 return FAIL;
3544 /* Put the result so far in tmp[], starting with the original name. */
3545 vim_strncpy(tmp, fname, MAXPATHL - 1);
3547 for (;;)
3549 /* Limit symlink depth to 100, catch recursive loops. */
3550 if (++depth == 100)
3552 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3553 return FAIL;
3556 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3557 if (ret <= 0)
3559 if (errno == EINVAL || errno == ENOENT)
3561 /* Found non-symlink or not existing file, stop here.
3562 * When at the first level use the unmodified name, skip the
3563 * call to vim_FullName(). */
3564 if (depth == 1)
3565 return FAIL;
3567 /* Use the resolved name in tmp[]. */
3568 break;
3571 /* There must be some error reading links, use original name. */
3572 return FAIL;
3574 buf[ret] = NUL;
3577 * Check whether the symlink is relative or absolute.
3578 * If it's relative, build a new path based on the directory
3579 * portion of the filename (if any) and the path the symlink
3580 * points to.
3582 if (mch_isFullName(buf))
3583 STRCPY(tmp, buf);
3584 else
3586 char_u *tail;
3588 tail = gettail(tmp);
3589 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3590 return FAIL;
3591 STRCPY(tail, buf);
3596 * Try to resolve the full name of the file so that the swapfile name will
3597 * be consistent even when opening a relative symlink from different
3598 * working directories.
3600 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3602 #endif
3605 * Make swap file name out of the file name and a directory name.
3606 * Returns pointer to allocated memory or NULL.
3608 char_u *
3609 makeswapname(fname, ffname, buf, dir_name)
3610 char_u *fname;
3611 char_u *ffname UNUSED;
3612 buf_T *buf;
3613 char_u *dir_name;
3615 char_u *r, *s;
3616 char_u *fname_res = fname;
3617 #ifdef HAVE_READLINK
3618 char_u fname_buf[MAXPATHL];
3619 #endif
3621 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3622 s = dir_name + STRLEN(dir_name);
3623 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3624 { /* Ends with '//', Use Full path */
3625 r = NULL;
3626 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3628 r = modname(s, (char_u *)".swp", FALSE);
3629 vim_free(s);
3631 return r;
3633 #endif
3635 #ifdef HAVE_READLINK
3636 /* Expand symlink in the file name, so that we put the swap file with the
3637 * actual file instead of with the symlink. */
3638 if (resolve_symlink(fname, fname_buf) == OK)
3639 fname_res = fname_buf;
3640 #endif
3642 r = buf_modname(
3643 #ifdef SHORT_FNAME
3644 TRUE,
3645 #else
3646 (buf->b_p_sn || buf->b_shortname),
3647 #endif
3648 #ifdef RISCOS
3649 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3650 ffname,
3651 #else
3652 fname_res,
3653 #endif
3654 (char_u *)
3655 #if defined(VMS) || defined(RISCOS)
3656 "_swp",
3657 #else
3658 ".swp",
3659 #endif
3660 #ifdef SHORT_FNAME /* always 8.3 file name */
3661 FALSE
3662 #else
3663 /* Prepend a '.' to the swap file name for the current directory. */
3664 dir_name[0] == '.' && dir_name[1] == NUL
3665 #endif
3667 if (r == NULL) /* out of memory */
3668 return NULL;
3670 s = get_file_in_dir(r, dir_name);
3671 vim_free(r);
3672 return s;
3676 * Get file name to use for swap file or backup file.
3677 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3678 * option "dname".
3679 * - If "dname" is ".", return "fname" (swap file in dir of file).
3680 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3681 * relative to dir of file).
3682 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3683 * dir).
3685 * The return value is an allocated string and can be NULL.
3687 char_u *
3688 get_file_in_dir(fname, dname)
3689 char_u *fname;
3690 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3692 char_u *t;
3693 char_u *tail;
3694 char_u *retval;
3695 int save_char;
3697 tail = gettail(fname);
3699 if (dname[0] == '.' && dname[1] == NUL)
3700 retval = vim_strsave(fname);
3701 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3703 if (tail == fname) /* no path before file name */
3704 retval = concat_fnames(dname + 2, tail, TRUE);
3705 else
3707 save_char = *tail;
3708 *tail = NUL;
3709 t = concat_fnames(fname, dname + 2, TRUE);
3710 *tail = save_char;
3711 if (t == NULL) /* out of memory */
3712 retval = NULL;
3713 else
3715 retval = concat_fnames(t, tail, TRUE);
3716 vim_free(t);
3720 else
3721 retval = concat_fnames(dname, tail, TRUE);
3723 return retval;
3726 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3729 * Print the ATTENTION message: info about an existing swap file.
3731 static void
3732 attention_message(buf, fname)
3733 buf_T *buf; /* buffer being edited */
3734 char_u *fname; /* swap file name */
3736 struct stat st;
3737 time_t x, sx;
3738 char *p;
3740 ++no_wait_return;
3741 (void)EMSG(_("E325: ATTENTION"));
3742 MSG_PUTS(_("\nFound a swap file by the name \""));
3743 msg_home_replace(fname);
3744 MSG_PUTS("\"\n");
3745 sx = swapfile_info(fname);
3746 MSG_PUTS(_("While opening file \""));
3747 msg_outtrans(buf->b_fname);
3748 MSG_PUTS("\"\n");
3749 if (mch_stat((char *)buf->b_fname, &st) != -1)
3751 MSG_PUTS(_(" dated: "));
3752 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3753 p = ctime(&x); /* includes '\n' */
3754 if (p == NULL)
3755 MSG_PUTS("(invalid)\n");
3756 else
3757 MSG_PUTS(p);
3758 if (sx != 0 && x > sx)
3759 MSG_PUTS(_(" NEWER than swap file!\n"));
3761 /* Some of these messages are long to allow translation to
3762 * other languages. */
3763 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"));
3764 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3765 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3766 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3767 msg_outtrans(buf->b_fname);
3768 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3769 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3770 msg_outtrans(fname);
3771 MSG_PUTS(_("\"\n to avoid this message.\n"));
3772 cmdline_row = msg_row;
3773 --no_wait_return;
3776 #ifdef FEAT_AUTOCMD
3777 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3780 * Trigger the SwapExists autocommands.
3781 * Returns a value for equivalent to do_dialog() (see below):
3782 * 0: still need to ask for a choice
3783 * 1: open read-only
3784 * 2: edit anyway
3785 * 3: recover
3786 * 4: delete it
3787 * 5: quit
3788 * 6: abort
3790 static int
3791 do_swapexists(buf, fname)
3792 buf_T *buf;
3793 char_u *fname;
3795 set_vim_var_string(VV_SWAPNAME, fname, -1);
3796 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3798 /* Trigger SwapExists autocommands with <afile> set to the file being
3799 * edited. Disallow changing directory here. */
3800 ++allbuf_lock;
3801 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3802 --allbuf_lock;
3804 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3806 switch (*get_vim_var_str(VV_SWAPCHOICE))
3808 case 'o': return 1;
3809 case 'e': return 2;
3810 case 'r': return 3;
3811 case 'd': return 4;
3812 case 'q': return 5;
3813 case 'a': return 6;
3816 return 0;
3818 #endif
3821 * Find out what name to use for the swap file for buffer 'buf'.
3823 * Several names are tried to find one that does not exist
3824 * Returns the name in allocated memory or NULL.
3826 * Note: If BASENAMELEN is not correct, you will get error messages for
3827 * not being able to open the swap or undo file
3828 * Note: May trigger SwapExists autocmd, pointers may change!
3830 static char_u *
3831 findswapname(buf, dirp, old_fname)
3832 buf_T *buf;
3833 char_u **dirp; /* pointer to list of directories */
3834 char_u *old_fname; /* don't give warning for this file name */
3836 char_u *fname;
3837 int n;
3838 char_u *dir_name;
3839 #ifdef AMIGA
3840 BPTR fh;
3841 #endif
3842 #ifndef SHORT_FNAME
3843 int r;
3844 #endif
3846 #if !defined(SHORT_FNAME) \
3847 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3848 # define CREATE_DUMMY_FILE
3849 FILE *dummyfd = NULL;
3852 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3853 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3854 * create will be exactly the same file. To avoid this problem we temporarily
3855 * create "test.doc".
3856 * Don't do this when the check below for a 8.3 file name is used.
3858 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3859 && mch_getperm(buf->b_fname) < 0)
3860 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3861 #endif
3864 * Isolate a directory name from *dirp and put it in dir_name.
3865 * First allocate some memory to put the directory name in.
3867 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3868 if (dir_name != NULL)
3869 (void)copy_option_part(dirp, dir_name, 31000, ",");
3872 * we try different names until we find one that does not exist yet
3874 if (dir_name == NULL) /* out of memory */
3875 fname = NULL;
3876 else
3877 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3879 for (;;)
3881 if (fname == NULL) /* must be out of memory */
3882 break;
3883 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3885 vim_free(fname);
3886 fname = NULL;
3887 break;
3889 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3891 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3892 * file names. If this is the first try and the swap file name does not fit in
3893 * 8.3, detect if this is the case, set shortname and try again.
3895 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3896 && !(buf->b_p_sn || buf->b_shortname))
3898 char_u *tail;
3899 char_u *fname2;
3900 struct stat s1, s2;
3901 int f1, f2;
3902 int created1 = FALSE, created2 = FALSE;
3903 int same = FALSE;
3906 * Check if swapfile name does not fit in 8.3:
3907 * It either contains two dots, is longer than 8 chars, or starts
3908 * with a dot.
3910 tail = gettail(buf->b_fname);
3911 if ( vim_strchr(tail, '.') != NULL
3912 || STRLEN(tail) > (size_t)8
3913 || *gettail(fname) == '.')
3915 fname2 = alloc(n + 2);
3916 if (fname2 != NULL)
3918 STRCPY(fname2, fname);
3919 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3920 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3921 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3923 if (vim_strchr(tail, '.') != NULL)
3924 fname2[n - 1] = 'x';
3925 else if (*gettail(fname) == '.')
3927 fname2[n] = 'x';
3928 fname2[n + 1] = NUL;
3930 else
3931 fname2[n - 5] += 1;
3933 * may need to create the files to be able to use mch_stat()
3935 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3936 if (f1 < 0)
3938 f1 = mch_open_rw((char *)fname,
3939 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3940 #if defined(OS2)
3941 if (f1 < 0 && errno == ENOENT)
3942 same = TRUE;
3943 #endif
3944 created1 = TRUE;
3946 if (f1 >= 0)
3948 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3949 if (f2 < 0)
3951 f2 = mch_open_rw((char *)fname2,
3952 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3953 created2 = TRUE;
3955 if (f2 >= 0)
3958 * Both files exist now. If mch_stat() returns the
3959 * same device and inode they are the same file.
3961 if (mch_fstat(f1, &s1) != -1
3962 && mch_fstat(f2, &s2) != -1
3963 && s1.st_dev == s2.st_dev
3964 && s1.st_ino == s2.st_ino)
3965 same = TRUE;
3966 close(f2);
3967 if (created2)
3968 mch_remove(fname2);
3970 close(f1);
3971 if (created1)
3972 mch_remove(fname);
3974 vim_free(fname2);
3975 if (same)
3977 buf->b_shortname = TRUE;
3978 vim_free(fname);
3979 fname = makeswapname(buf->b_fname, buf->b_ffname,
3980 buf, dir_name);
3981 continue; /* try again with b_shortname set */
3986 #endif
3988 * check if the swapfile already exists
3990 if (mch_getperm(fname) < 0) /* it does not exist */
3992 #ifdef HAVE_LSTAT
3993 struct stat sb;
3996 * Extra security check: When a swap file is a symbolic link, this
3997 * is most likely a symlink attack.
3999 if (mch_lstat((char *)fname, &sb) < 0)
4000 #else
4001 # ifdef AMIGA
4002 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4004 * on the Amiga mch_getperm() will return -1 when the file exists
4005 * but is being used by another program. This happens if you edit
4006 * a file twice.
4008 if (fh != (BPTR)NULL) /* can open file, OK */
4010 Close(fh);
4011 mch_remove(fname);
4012 break;
4014 if (IoErr() != ERROR_OBJECT_IN_USE
4015 && IoErr() != ERROR_OBJECT_EXISTS)
4016 # endif
4017 #endif
4018 break;
4022 * A file name equal to old_fname is OK to use.
4024 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4025 break;
4028 * get here when file already exists
4030 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4032 #ifndef SHORT_FNAME
4034 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4035 * and file.doc are the same file. To guess if this problem is
4036 * present try if file.doc.swx exists. If it does, we set
4037 * buf->b_shortname and try file_doc.swp (dots replaced by
4038 * underscores for this file), and try again. If it doesn't we
4039 * assume that "file.doc.swp" already exists.
4041 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4043 fname[n - 1] = 'x';
4044 r = mch_getperm(fname); /* try "file.swx" */
4045 fname[n - 1] = 'p';
4046 if (r >= 0) /* "file.swx" seems to exist */
4048 buf->b_shortname = TRUE;
4049 vim_free(fname);
4050 fname = makeswapname(buf->b_fname, buf->b_ffname,
4051 buf, dir_name);
4052 continue; /* try again with '.' replaced with '_' */
4055 #endif
4057 * If we get here the ".swp" file really exists.
4058 * Give an error message, unless recovering, no file name, we are
4059 * viewing a help file or when the path of the file is different
4060 * (happens when all .swp files are in one directory).
4062 if (!recoverymode && buf->b_fname != NULL
4063 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4065 int fd;
4066 struct block0 b0;
4067 int differ = FALSE;
4070 * Try to read block 0 from the swap file to get the original
4071 * file name (and inode number).
4073 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4074 if (fd >= 0)
4076 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4079 * If the swapfile has the same directory as the
4080 * buffer don't compare the directory names, they can
4081 * have a different mountpoint.
4083 if (b0.b0_flags & B0_SAME_DIR)
4085 if (fnamecmp(gettail(buf->b_ffname),
4086 gettail(b0.b0_fname)) != 0
4087 || !same_directory(fname, buf->b_ffname))
4089 #ifdef CHECK_INODE
4090 /* Symlinks may point to the same file even
4091 * when the name differs, need to check the
4092 * inode too. */
4093 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4094 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4095 char_to_long(b0.b0_ino)))
4096 #endif
4097 differ = TRUE;
4100 else
4103 * The name in the swap file may be
4104 * "~user/path/file". Expand it first.
4106 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4107 #ifdef CHECK_INODE
4108 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4109 char_to_long(b0.b0_ino)))
4110 differ = TRUE;
4111 #else
4112 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4113 differ = TRUE;
4114 #endif
4117 close(fd);
4119 #ifdef RISCOS
4120 else
4121 /* Can't open swap file, though it does exist.
4122 * Assume that the user is editing two files with
4123 * the same name in different directories. No error.
4125 differ = TRUE;
4126 #endif
4128 /* give the ATTENTION message when there is an old swap file
4129 * for the current file, and the buffer was not recovered. */
4130 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4131 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4133 #if defined(HAS_SWAP_EXISTS_ACTION)
4134 int choice = 0;
4135 #endif
4136 #ifdef CREATE_DUMMY_FILE
4137 int did_use_dummy = FALSE;
4139 /* Avoid getting a warning for the file being created
4140 * outside of Vim, it was created at the start of this
4141 * function. Delete the file now, because Vim might exit
4142 * here if the window is closed. */
4143 if (dummyfd != NULL)
4145 fclose(dummyfd);
4146 dummyfd = NULL;
4147 mch_remove(buf->b_fname);
4148 did_use_dummy = TRUE;
4150 #endif
4152 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4153 process_still_running = FALSE;
4154 #endif
4155 #ifdef FEAT_AUTOCMD
4157 * If there is an SwapExists autocommand and we can handle
4158 * the response, trigger it. It may return 0 to ask the
4159 * user anyway.
4161 if (swap_exists_action != SEA_NONE
4162 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4163 choice = do_swapexists(buf, fname);
4165 if (choice == 0)
4166 #endif
4168 #ifdef FEAT_GUI
4169 /* If we are supposed to start the GUI but it wasn't
4170 * completely started yet, start it now. This makes
4171 * the messages displayed in the Vim window when
4172 * loading a session from the .gvimrc file. */
4173 if (gui.starting && !gui.in_use)
4174 gui_start();
4175 #endif
4176 /* Show info about the existing swap file. */
4177 attention_message(buf, fname);
4179 /* We don't want a 'q' typed at the more-prompt
4180 * interrupt loading a file. */
4181 got_int = FALSE;
4184 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4185 if (swap_exists_action != SEA_NONE && choice == 0)
4187 char_u *name;
4189 name = alloc((unsigned)(STRLEN(fname)
4190 + STRLEN(_("Swap file \""))
4191 + STRLEN(_("\" already exists!")) + 5));
4192 if (name != NULL)
4194 STRCPY(name, _("Swap file \""));
4195 home_replace(NULL, fname, name + STRLEN(name),
4196 1000, TRUE);
4197 STRCAT(name, _("\" already exists!"));
4199 choice = do_dialog(VIM_WARNING,
4200 (char_u *)_("VIM - ATTENTION"),
4201 name == NULL
4202 ? (char_u *)_("Swap file already exists!")
4203 : name,
4204 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4205 process_still_running
4206 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4207 # endif
4208 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4210 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4211 if (process_still_running && choice >= 4)
4212 choice++; /* Skip missing "Delete it" button */
4213 # endif
4214 vim_free(name);
4216 /* pretend screen didn't scroll, need redraw anyway */
4217 msg_scrolled = 0;
4218 redraw_all_later(NOT_VALID);
4220 #endif
4222 #if defined(HAS_SWAP_EXISTS_ACTION)
4223 if (choice > 0)
4225 switch (choice)
4227 case 1:
4228 buf->b_p_ro = TRUE;
4229 break;
4230 case 2:
4231 break;
4232 case 3:
4233 swap_exists_action = SEA_RECOVER;
4234 break;
4235 case 4:
4236 mch_remove(fname);
4237 break;
4238 case 5:
4239 swap_exists_action = SEA_QUIT;
4240 break;
4241 case 6:
4242 swap_exists_action = SEA_QUIT;
4243 got_int = TRUE;
4244 break;
4247 /* If the file was deleted this fname can be used. */
4248 if (mch_getperm(fname) < 0)
4249 break;
4251 else
4252 #endif
4254 MSG_PUTS("\n");
4255 if (msg_silent == 0)
4256 /* call wait_return() later */
4257 need_wait_return = TRUE;
4260 #ifdef CREATE_DUMMY_FILE
4261 /* Going to try another name, need the dummy file again. */
4262 if (did_use_dummy)
4263 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4264 #endif
4270 * Change the ".swp" extension to find another file that can be used.
4271 * First decrement the last char: ".swo", ".swn", etc.
4272 * If that still isn't enough decrement the last but one char: ".svz"
4273 * Can happen when editing many "No Name" buffers.
4275 if (fname[n - 1] == 'a') /* ".s?a" */
4277 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4279 EMSG(_("E326: Too many swap files found"));
4280 vim_free(fname);
4281 fname = NULL;
4282 break;
4284 --fname[n - 2]; /* ".svz", ".suz", etc. */
4285 fname[n - 1] = 'z' + 1;
4287 --fname[n - 1]; /* ".swo", ".swn", etc. */
4290 vim_free(dir_name);
4291 #ifdef CREATE_DUMMY_FILE
4292 if (dummyfd != NULL) /* file has been created temporarily */
4294 fclose(dummyfd);
4295 mch_remove(buf->b_fname);
4297 #endif
4298 return fname;
4301 static int
4302 b0_magic_wrong(b0p)
4303 ZERO_BL *b0p;
4305 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4306 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4307 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4308 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4311 #ifdef CHECK_INODE
4313 * Compare current file name with file name from swap file.
4314 * Try to use inode numbers when possible.
4315 * Return non-zero when files are different.
4317 * When comparing file names a few things have to be taken into consideration:
4318 * - When working over a network the full path of a file depends on the host.
4319 * We check the inode number if possible. It is not 100% reliable though,
4320 * because the device number cannot be used over a network.
4321 * - When a file does not exist yet (editing a new file) there is no inode
4322 * number.
4323 * - The file name in a swap file may not be valid on the current host. The
4324 * "~user" form is used whenever possible to avoid this.
4326 * This is getting complicated, let's make a table:
4328 * ino_c ino_s fname_c fname_s differ =
4330 * both files exist -> compare inode numbers:
4331 * != 0 != 0 X X ino_c != ino_s
4333 * inode number(s) unknown, file names available -> compare file names
4334 * == 0 X OK OK fname_c != fname_s
4335 * X == 0 OK OK fname_c != fname_s
4337 * current file doesn't exist, file for swap file exist, file name(s) not
4338 * available -> probably different
4339 * == 0 != 0 FAIL X TRUE
4340 * == 0 != 0 X FAIL TRUE
4342 * current file exists, inode for swap unknown, file name(s) not
4343 * available -> probably different
4344 * != 0 == 0 FAIL X TRUE
4345 * != 0 == 0 X FAIL TRUE
4347 * current file doesn't exist, inode for swap unknown, one file name not
4348 * available -> probably different
4349 * == 0 == 0 FAIL OK TRUE
4350 * == 0 == 0 OK FAIL TRUE
4352 * current file doesn't exist, inode for swap unknown, both file names not
4353 * available -> probably same file
4354 * == 0 == 0 FAIL FAIL FALSE
4356 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4357 * can't be changed without making the block 0 incompatible with 32 bit
4358 * versions.
4361 static int
4362 fnamecmp_ino(fname_c, fname_s, ino_block0)
4363 char_u *fname_c; /* current file name */
4364 char_u *fname_s; /* file name from swap file */
4365 long ino_block0;
4367 struct stat st;
4368 ino_t ino_c = 0; /* ino of current file */
4369 ino_t ino_s; /* ino of file from swap file */
4370 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4371 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4372 int retval_c; /* flag: buf_c valid */
4373 int retval_s; /* flag: buf_s valid */
4375 if (mch_stat((char *)fname_c, &st) == 0)
4376 ino_c = (ino_t)st.st_ino;
4379 * First we try to get the inode from the file name, because the inode in
4380 * the swap file may be outdated. If that fails (e.g. this path is not
4381 * valid on this machine), use the inode from block 0.
4383 if (mch_stat((char *)fname_s, &st) == 0)
4384 ino_s = (ino_t)st.st_ino;
4385 else
4386 ino_s = (ino_t)ino_block0;
4388 if (ino_c && ino_s)
4389 return (ino_c != ino_s);
4392 * One of the inode numbers is unknown, try a forced vim_FullName() and
4393 * compare the file names.
4395 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4396 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4397 if (retval_c == OK && retval_s == OK)
4398 return (STRCMP(buf_c, buf_s) != 0);
4401 * Can't compare inodes or file names, guess that the files are different,
4402 * unless both appear not to exist at all.
4404 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4405 return FALSE;
4406 return TRUE;
4408 #endif /* CHECK_INODE */
4411 * Move a long integer into a four byte character array.
4412 * Used for machine independency in block zero.
4414 static void
4415 long_to_char(n, s)
4416 long n;
4417 char_u *s;
4419 s[0] = (char_u)(n & 0xff);
4420 n = (unsigned)n >> 8;
4421 s[1] = (char_u)(n & 0xff);
4422 n = (unsigned)n >> 8;
4423 s[2] = (char_u)(n & 0xff);
4424 n = (unsigned)n >> 8;
4425 s[3] = (char_u)(n & 0xff);
4428 static long
4429 char_to_long(s)
4430 char_u *s;
4432 long retval;
4434 retval = s[3];
4435 retval <<= 8;
4436 retval |= s[2];
4437 retval <<= 8;
4438 retval |= s[1];
4439 retval <<= 8;
4440 retval |= s[0];
4442 return retval;
4446 * Set the flags in the first block of the swap file:
4447 * - file is modified or not: buf->b_changed
4448 * - 'fileformat'
4449 * - 'fileencoding'
4451 void
4452 ml_setflags(buf)
4453 buf_T *buf;
4455 bhdr_T *hp;
4456 ZERO_BL *b0p;
4458 if (!buf->b_ml.ml_mfp)
4459 return;
4460 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4462 if (hp->bh_bnum == 0)
4464 b0p = (ZERO_BL *)(hp->bh_data);
4465 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4466 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4467 | (get_fileformat(buf) + 1);
4468 #ifdef FEAT_MBYTE
4469 add_b0_fenc(b0p, buf);
4470 #endif
4471 hp->bh_flags |= BH_DIRTY;
4472 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4473 break;
4478 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4480 #define MLCS_MAXL 800 /* max no of lines in chunk */
4481 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4484 * Keep information for finding byte offset of a line, updtytpe may be one of:
4485 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4486 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4487 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4488 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4490 static void
4491 ml_updatechunk(buf, line, len, updtype)
4492 buf_T *buf;
4493 linenr_T line;
4494 long len;
4495 int updtype;
4497 static buf_T *ml_upd_lastbuf = NULL;
4498 static linenr_T ml_upd_lastline;
4499 static linenr_T ml_upd_lastcurline;
4500 static int ml_upd_lastcurix;
4502 linenr_T curline = ml_upd_lastcurline;
4503 int curix = ml_upd_lastcurix;
4504 long size;
4505 chunksize_T *curchnk;
4506 int rest;
4507 bhdr_T *hp;
4508 DATA_BL *dp;
4510 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4511 return;
4512 if (buf->b_ml.ml_chunksize == NULL)
4514 buf->b_ml.ml_chunksize = (chunksize_T *)
4515 alloc((unsigned)sizeof(chunksize_T) * 100);
4516 if (buf->b_ml.ml_chunksize == NULL)
4518 buf->b_ml.ml_usedchunks = -1;
4519 return;
4521 buf->b_ml.ml_numchunks = 100;
4522 buf->b_ml.ml_usedchunks = 1;
4523 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4524 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4527 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4530 * First line in empty buffer from ml_flush_line() -- reset
4532 buf->b_ml.ml_usedchunks = 1;
4533 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4534 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4535 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4536 return;
4540 * Find chunk that our line belongs to, curline will be at start of the
4541 * chunk.
4543 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4544 || updtype != ML_CHNK_ADDLINE)
4546 for (curline = 1, curix = 0;
4547 curix < buf->b_ml.ml_usedchunks - 1
4548 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4549 curix++)
4551 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4554 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4555 && curix < buf->b_ml.ml_usedchunks - 1)
4557 /* Adjust cached curix & curline */
4558 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4559 curix++;
4561 curchnk = buf->b_ml.ml_chunksize + curix;
4563 if (updtype == ML_CHNK_DELLINE)
4564 len = -len;
4565 curchnk->mlcs_totalsize += len;
4566 if (updtype == ML_CHNK_ADDLINE)
4568 curchnk->mlcs_numlines++;
4570 /* May resize here so we don't have to do it in both cases below */
4571 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4573 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4574 buf->b_ml.ml_chunksize = (chunksize_T *)
4575 vim_realloc(buf->b_ml.ml_chunksize,
4576 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4577 if (buf->b_ml.ml_chunksize == NULL)
4579 /* Hmmmm, Give up on offset for this buffer */
4580 buf->b_ml.ml_usedchunks = -1;
4581 return;
4585 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4587 int count; /* number of entries in block */
4588 int idx;
4589 int text_end;
4590 int linecnt;
4592 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4593 buf->b_ml.ml_chunksize + curix,
4594 (buf->b_ml.ml_usedchunks - curix) *
4595 sizeof(chunksize_T));
4596 /* Compute length of first half of lines in the split chunk */
4597 size = 0;
4598 linecnt = 0;
4599 while (curline < buf->b_ml.ml_line_count
4600 && linecnt < MLCS_MINL)
4602 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4604 buf->b_ml.ml_usedchunks = -1;
4605 return;
4607 dp = (DATA_BL *)(hp->bh_data);
4608 count = (long)(buf->b_ml.ml_locked_high) -
4609 (long)(buf->b_ml.ml_locked_low) + 1;
4610 idx = curline - buf->b_ml.ml_locked_low;
4611 curline = buf->b_ml.ml_locked_high + 1;
4612 if (idx == 0)/* first line in block, text at the end */
4613 text_end = dp->db_txt_end;
4614 else
4615 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4616 /* Compute index of last line to use in this MEMLINE */
4617 rest = count - idx;
4618 if (linecnt + rest > MLCS_MINL)
4620 idx += MLCS_MINL - linecnt - 1;
4621 linecnt = MLCS_MINL;
4623 else
4625 idx = count - 1;
4626 linecnt += rest;
4628 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4630 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4631 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4632 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4633 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4634 buf->b_ml.ml_usedchunks++;
4635 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4636 return;
4638 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4639 && curix == buf->b_ml.ml_usedchunks - 1
4640 && buf->b_ml.ml_line_count - line <= 1)
4643 * We are in the last chunk and it is cheap to crate a new one
4644 * after this. Do it now to avoid the loop above later on
4646 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4647 buf->b_ml.ml_usedchunks++;
4648 if (line == buf->b_ml.ml_line_count)
4650 curchnk->mlcs_numlines = 0;
4651 curchnk->mlcs_totalsize = 0;
4653 else
4656 * Line is just prior to last, move count for last
4657 * This is the common case when loading a new file
4659 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4660 if (hp == NULL)
4662 buf->b_ml.ml_usedchunks = -1;
4663 return;
4665 dp = (DATA_BL *)(hp->bh_data);
4666 if (dp->db_line_count == 1)
4667 rest = dp->db_txt_end - dp->db_txt_start;
4668 else
4669 rest =
4670 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4671 - dp->db_txt_start;
4672 curchnk->mlcs_totalsize = rest;
4673 curchnk->mlcs_numlines = 1;
4674 curchnk[-1].mlcs_totalsize -= rest;
4675 curchnk[-1].mlcs_numlines -= 1;
4679 else if (updtype == ML_CHNK_DELLINE)
4681 curchnk->mlcs_numlines--;
4682 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4683 if (curix < (buf->b_ml.ml_usedchunks - 1)
4684 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4685 <= MLCS_MINL)
4687 curix++;
4688 curchnk = buf->b_ml.ml_chunksize + curix;
4690 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4692 buf->b_ml.ml_usedchunks--;
4693 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4694 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4695 return;
4697 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4698 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4699 > MLCS_MINL))
4701 return;
4704 /* Collapse chunks */
4705 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4706 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4707 buf->b_ml.ml_usedchunks--;
4708 if (curix < buf->b_ml.ml_usedchunks)
4710 mch_memmove(buf->b_ml.ml_chunksize + curix,
4711 buf->b_ml.ml_chunksize + curix + 1,
4712 (buf->b_ml.ml_usedchunks - curix) *
4713 sizeof(chunksize_T));
4715 return;
4717 ml_upd_lastbuf = buf;
4718 ml_upd_lastline = line;
4719 ml_upd_lastcurline = curline;
4720 ml_upd_lastcurix = curix;
4724 * Find offset for line or line with offset.
4725 * Find line with offset if "lnum" is 0; return remaining offset in offp
4726 * Find offset of line if "lnum" > 0
4727 * return -1 if information is not available
4729 long
4730 ml_find_line_or_offset(buf, lnum, offp)
4731 buf_T *buf;
4732 linenr_T lnum;
4733 long *offp;
4735 linenr_T curline;
4736 int curix;
4737 long size;
4738 bhdr_T *hp;
4739 DATA_BL *dp;
4740 int count; /* number of entries in block */
4741 int idx;
4742 int start_idx;
4743 int text_end;
4744 long offset;
4745 int len;
4746 int ffdos = (get_fileformat(buf) == EOL_DOS);
4747 int extra = 0;
4749 /* take care of cached line first */
4750 ml_flush_line(curbuf);
4752 if (buf->b_ml.ml_usedchunks == -1
4753 || buf->b_ml.ml_chunksize == NULL
4754 || lnum < 0)
4755 return -1;
4757 if (offp == NULL)
4758 offset = 0;
4759 else
4760 offset = *offp;
4761 if (lnum == 0 && offset <= 0)
4762 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4764 * Find the last chunk before the one containing our line. Last chunk is
4765 * special because it will never qualify
4767 curline = 1;
4768 curix = size = 0;
4769 while (curix < buf->b_ml.ml_usedchunks - 1
4770 && ((lnum != 0
4771 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4772 || (offset != 0
4773 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4774 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4776 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4777 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4778 if (offset && ffdos)
4779 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4780 curix++;
4783 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4785 if (curline > buf->b_ml.ml_line_count
4786 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4787 return -1;
4788 dp = (DATA_BL *)(hp->bh_data);
4789 count = (long)(buf->b_ml.ml_locked_high) -
4790 (long)(buf->b_ml.ml_locked_low) + 1;
4791 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4792 if (idx == 0)/* first line in block, text at the end */
4793 text_end = dp->db_txt_end;
4794 else
4795 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4796 /* Compute index of last line to use in this MEMLINE */
4797 if (lnum != 0)
4799 if (curline + (count - idx) >= lnum)
4800 idx += lnum - curline - 1;
4801 else
4802 idx = count - 1;
4804 else
4806 extra = 0;
4807 while (offset >= size
4808 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4809 + ffdos)
4811 if (ffdos)
4812 size++;
4813 if (idx == count - 1)
4815 extra = 1;
4816 break;
4818 idx++;
4821 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4822 size += len;
4823 if (offset != 0 && size >= offset)
4825 if (size + ffdos == offset)
4826 *offp = 0;
4827 else if (idx == start_idx)
4828 *offp = offset - size + len;
4829 else
4830 *offp = offset - size + len
4831 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4832 curline += idx - start_idx + extra;
4833 if (curline > buf->b_ml.ml_line_count)
4834 return -1; /* exactly one byte beyond the end */
4835 return curline;
4837 curline = buf->b_ml.ml_locked_high + 1;
4840 if (lnum != 0)
4842 /* Count extra CR characters. */
4843 if (ffdos)
4844 size += lnum - 1;
4846 /* Don't count the last line break if 'bin' and 'noeol'. */
4847 if (buf->b_p_bin && !buf->b_p_eol)
4848 size -= ffdos + 1;
4851 return size;
4855 * Goto byte in buffer with offset 'cnt'.
4857 void
4858 goto_byte(cnt)
4859 long cnt;
4861 long boff = cnt;
4862 linenr_T lnum;
4864 ml_flush_line(curbuf); /* cached line may be dirty */
4865 setpcmark();
4866 if (boff)
4867 --boff;
4868 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4869 if (lnum < 1) /* past the end */
4871 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4872 curwin->w_curswant = MAXCOL;
4873 coladvance((colnr_T)MAXCOL);
4875 else
4877 curwin->w_cursor.lnum = lnum;
4878 curwin->w_cursor.col = (colnr_T)boff;
4879 # ifdef FEAT_VIRTUALEDIT
4880 curwin->w_cursor.coladd = 0;
4881 # endif
4882 curwin->w_set_curswant = TRUE;
4884 check_cursor();
4886 # ifdef FEAT_MBYTE
4887 /* Make sure the cursor is on the first byte of a multi-byte char. */
4888 if (has_mbyte)
4889 mb_adjust_cursor();
4890 # endif
4892 #endif