Merge branch 'vim' into feat/quickfix-title
[vim_extended.git] / src / memline.c
blob25300f19e65c7f4ff6ba7de1132919f0e9c16549
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
10 /* for debugging */
11 /* #define CHECK(c, s) if (c) EMSG(s) */
12 #define CHECK(c, s)
15 * memline.c: Contains the functions for appending, deleting and changing the
16 * text lines. The memfile functions are used to store the information in
17 * blocks of memory, backed up by a file. The structure of the information is
18 * a tree. The root of the tree is a pointer block. The leaves of the tree
19 * are data blocks. In between may be several layers of pointer blocks,
20 * forming branches.
22 * Three types of blocks are used:
23 * - Block nr 0 contains information for recovery
24 * - Pointer blocks contain list of pointers to other blocks.
25 * - Data blocks contain the actual text.
27 * Block nr 0 contains the block0 structure (see below).
29 * Block nr 1 is the first pointer block. It is the root of the tree.
30 * Other pointer blocks are branches.
32 * If a line is too big to fit in a single page, the block containing that
33 * line is made big enough to hold the line. It may span several pages.
34 * Otherwise all blocks are one page.
36 * A data block that was filled when starting to edit a file and was not
37 * changed since then, can have a negative block number. This means that it
38 * has not yet been assigned a place in the file. When recovering, the lines
39 * in this data block can be read from the original file. When the block is
40 * changed (lines appended/deleted/changed) or when it is flushed it gets a
41 * positive number. Use mf_trans_del() to get the new number, before calling
42 * mf_get().
45 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
46 # include "vimio.h" /* for mch_open(), must be before vim.h */
47 #endif
49 #include "vim.h"
51 #ifndef UNIX /* it's in os_unix.h for Unix */
52 # include <time.h>
53 #endif
55 #if defined(SASC) || defined(__amigaos4__)
56 # include <proto/dos.h> /* for Open() and Close() */
57 #endif
59 #ifdef HAVE_ERRNO_H
60 # include <errno.h>
61 #endif
63 typedef struct block0 ZERO_BL; /* contents of the first block */
64 typedef struct pointer_block PTR_BL; /* contents of a pointer block */
65 typedef struct data_block DATA_BL; /* contents of a data block */
66 typedef struct pointer_entry PTR_EN; /* block/line-count pair */
68 #define DATA_ID (('d' << 8) + 'a') /* data block id */
69 #define PTR_ID (('p' << 8) + 't') /* pointer block id */
70 #define BLOCK0_ID0 'b' /* block 0 id 0 */
71 #define BLOCK0_ID1 '0' /* block 0 id 1 */
74 * pointer to a block, used in a pointer block
76 struct pointer_entry
78 blocknr_T pe_bnum; /* block number */
79 linenr_T pe_line_count; /* number of lines in this branch */
80 linenr_T pe_old_lnum; /* lnum for this block (for recovery) */
81 int pe_page_count; /* number of pages in block pe_bnum */
85 * A pointer block contains a list of branches in the tree.
87 struct pointer_block
89 short_u pb_id; /* ID for pointer block: PTR_ID */
90 short_u pb_count; /* number of pointer in this block */
91 short_u pb_count_max; /* maximum value for pb_count */
92 PTR_EN pb_pointer[1]; /* list of pointers to blocks (actually longer)
93 * followed by empty space until end of page */
97 * A data block is a leaf in the tree.
99 * The text of the lines is at the end of the block. The text of the first line
100 * in the block is put at the end, the text of the second line in front of it,
101 * etc. Thus the order of the lines is the opposite of the line number.
103 struct data_block
105 short_u db_id; /* ID for data block: DATA_ID */
106 unsigned db_free; /* free space available */
107 unsigned db_txt_start; /* byte where text starts */
108 unsigned db_txt_end; /* byte just after data block */
109 linenr_T db_line_count; /* number of lines in this block */
110 unsigned db_index[1]; /* index for start of line (actually bigger)
111 * followed by empty space upto db_txt_start
112 * followed by the text in the lines until
113 * end of page */
117 * The low bits of db_index hold the actual index. The topmost bit is
118 * used for the global command to be able to mark a line.
119 * This method is not clean, but otherwise there would be at least one extra
120 * byte used for each line.
121 * The mark has to be in this place to keep it with the correct line when other
122 * lines are inserted or deleted.
124 #define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
125 #define DB_INDEX_MASK (~DB_MARKED)
127 #define INDEX_SIZE (sizeof(unsigned)) /* size of one db_index entry */
128 #define HEADER_SIZE (sizeof(DATA_BL) - INDEX_SIZE) /* size of data block header */
130 #define B0_FNAME_SIZE_ORG 900 /* what it was in older versions */
131 #define B0_FNAME_SIZE 898
132 #define B0_UNAME_SIZE 40
133 #define B0_HNAME_SIZE 40
135 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
136 * This won't detect a 64 bit machine that only swaps a byte in the top 32
137 * bits, but that is crazy anyway.
139 #define B0_MAGIC_LONG 0x30313233L
140 #define B0_MAGIC_INT 0x20212223L
141 #define B0_MAGIC_SHORT 0x10111213L
142 #define B0_MAGIC_CHAR 0x55
145 * Block zero holds all info about the swap file.
147 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
148 * swap files unusable!
150 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
152 * This block is built up of single bytes, to make it portable across
153 * different machines. b0_magic_* is used to check the byte order and size of
154 * variables, because the rest of the swap file is not portable.
156 struct block0
158 char_u b0_id[2]; /* id for block 0: BLOCK0_ID0 and BLOCK0_ID1 */
159 char_u b0_version[10]; /* Vim version string */
160 char_u b0_page_size[4];/* number of bytes per page */
161 char_u b0_mtime[4]; /* last modification time of file */
162 char_u b0_ino[4]; /* inode of b0_fname */
163 char_u b0_pid[4]; /* process id of creator (or 0) */
164 char_u b0_uname[B0_UNAME_SIZE]; /* name of user (uid if no name) */
165 char_u b0_hname[B0_HNAME_SIZE]; /* host name (if it has a name) */
166 char_u b0_fname[B0_FNAME_SIZE_ORG]; /* name of file being edited */
167 long b0_magic_long; /* check for byte order of long */
168 int b0_magic_int; /* check for byte order of int */
169 short b0_magic_short; /* check for byte order of short */
170 char_u b0_magic_char; /* check for last char */
174 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
175 * long file names in older versions of Vim they are invalid.
176 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
177 * when there is room, for very long file names it's omitted.
179 #define B0_DIRTY 0x55
180 #define b0_dirty b0_fname[B0_FNAME_SIZE_ORG-1]
183 * The b0_flags field is new in Vim 7.0.
185 #define b0_flags b0_fname[B0_FNAME_SIZE_ORG-2]
187 /* The lowest two bits contain the fileformat. Zero means it's not set
188 * (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
189 * EOL_MAC + 1. */
190 #define B0_FF_MASK 3
192 /* Swap file is in directory of edited file. Used to find the file from
193 * different mount points. */
194 #define B0_SAME_DIR 4
196 /* The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
197 * When empty there is only the NUL. */
198 #define B0_HAS_FENC 8
200 #define STACK_INCR 5 /* nr of entries added to ml_stack at a time */
203 * The line number where the first mark may be is remembered.
204 * If it is 0 there are no marks at all.
205 * (always used for the current buffer only, no buffer change possible while
206 * executing a global command).
208 static linenr_T lowest_marked = 0;
211 * arguments for ml_find_line()
213 #define ML_DELETE 0x11 /* delete line */
214 #define ML_INSERT 0x12 /* insert line */
215 #define ML_FIND 0x13 /* just find the line */
216 #define ML_FLUSH 0x02 /* flush locked block */
217 #define ML_SIMPLE(x) (x & 0x10) /* DEL, INS or FIND */
219 static void ml_upd_block0 __ARGS((buf_T *buf, int set_fname));
220 static void set_b0_fname __ARGS((ZERO_BL *, buf_T *buf));
221 static void set_b0_dir_flag __ARGS((ZERO_BL *b0p, buf_T *buf));
222 #ifdef FEAT_MBYTE
223 static void add_b0_fenc __ARGS((ZERO_BL *b0p, buf_T *buf));
224 #endif
225 static time_t swapfile_info __ARGS((char_u *));
226 static int recov_file_names __ARGS((char_u **, char_u *, int prepend_dot));
227 static int ml_append_int __ARGS((buf_T *, linenr_T, char_u *, colnr_T, int, int));
228 static int ml_delete_int __ARGS((buf_T *, linenr_T, int));
229 static char_u *findswapname __ARGS((buf_T *, char_u **, char_u *));
230 static void ml_flush_line __ARGS((buf_T *));
231 static bhdr_T *ml_new_data __ARGS((memfile_T *, int, int));
232 static bhdr_T *ml_new_ptr __ARGS((memfile_T *));
233 static bhdr_T *ml_find_line __ARGS((buf_T *, linenr_T, int));
234 static int ml_add_stack __ARGS((buf_T *));
235 static void ml_lineadd __ARGS((buf_T *, int));
236 static int b0_magic_wrong __ARGS((ZERO_BL *));
237 #ifdef CHECK_INODE
238 static int fnamecmp_ino __ARGS((char_u *, char_u *, long));
239 #endif
240 static void long_to_char __ARGS((long, char_u *));
241 static long char_to_long __ARGS((char_u *));
242 #if defined(UNIX) || defined(WIN3264)
243 static char_u *make_percent_swname __ARGS((char_u *dir, char_u *name));
244 #endif
245 #ifdef FEAT_BYTEOFF
246 static void ml_updatechunk __ARGS((buf_T *buf, long line, long len, int updtype));
247 #endif
250 * Open a new memline for "buf".
252 * Return FAIL for failure, OK otherwise.
255 ml_open(buf)
256 buf_T *buf;
258 memfile_T *mfp;
259 bhdr_T *hp = NULL;
260 ZERO_BL *b0p;
261 PTR_BL *pp;
262 DATA_BL *dp;
265 * init fields in memline struct
267 buf->b_ml.ml_stack_size = 0; /* no stack yet */
268 buf->b_ml.ml_stack = NULL; /* no stack yet */
269 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
270 buf->b_ml.ml_locked = NULL; /* no cached block */
271 buf->b_ml.ml_line_lnum = 0; /* no cached line */
272 #ifdef FEAT_BYTEOFF
273 buf->b_ml.ml_chunksize = NULL;
274 #endif
277 * When 'updatecount' is non-zero swap file may be opened later.
279 if (p_uc && buf->b_p_swf)
280 buf->b_may_swap = TRUE;
281 else
282 buf->b_may_swap = FALSE;
285 * Open the memfile. No swap file is created yet.
287 mfp = mf_open(NULL, 0);
288 if (mfp == NULL)
289 goto error;
291 buf->b_ml.ml_mfp = mfp;
292 buf->b_ml.ml_flags = ML_EMPTY;
293 buf->b_ml.ml_line_count = 1;
294 #ifdef FEAT_LINEBREAK
295 curwin->w_nrwidth_line_count = 0;
296 #endif
298 #if defined(MSDOS) && !defined(DJGPP)
299 /* for 16 bit MS-DOS create a swapfile now, because we run out of
300 * memory very quickly */
301 if (p_uc != 0)
302 ml_open_file(buf);
303 #endif
306 * fill block0 struct and write page 0
308 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
309 goto error;
310 if (hp->bh_bnum != 0)
312 EMSG(_("E298: Didn't get block nr 0?"));
313 goto error;
315 b0p = (ZERO_BL *)(hp->bh_data);
317 b0p->b0_id[0] = BLOCK0_ID0;
318 b0p->b0_id[1] = BLOCK0_ID1;
319 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
320 b0p->b0_magic_int = (int)B0_MAGIC_INT;
321 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
322 b0p->b0_magic_char = B0_MAGIC_CHAR;
323 STRNCPY(b0p->b0_version, "VIM ", 4);
324 STRNCPY(b0p->b0_version + 4, Version, 6);
325 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
327 #ifdef FEAT_SPELL
328 if (!buf->b_spell)
329 #endif
331 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
332 b0p->b0_flags = get_fileformat(buf) + 1;
333 set_b0_fname(b0p, buf);
334 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
335 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
336 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
337 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
338 long_to_char(mch_get_pid(), b0p->b0_pid);
342 * Always sync block number 0 to disk, so we can check the file name in
343 * the swap file in findswapname(). Don't do this for help files though
344 * and spell buffer though.
345 * Only works when there's a swapfile, otherwise it's done when the file
346 * is created.
348 mf_put(mfp, hp, TRUE, FALSE);
349 if (!buf->b_help && !B_SPELL(buf))
350 (void)mf_sync(mfp, 0);
353 * Fill in root pointer block and write page 1.
355 if ((hp = ml_new_ptr(mfp)) == NULL)
356 goto error;
357 if (hp->bh_bnum != 1)
359 EMSG(_("E298: Didn't get block nr 1?"));
360 goto error;
362 pp = (PTR_BL *)(hp->bh_data);
363 pp->pb_count = 1;
364 pp->pb_pointer[0].pe_bnum = 2;
365 pp->pb_pointer[0].pe_page_count = 1;
366 pp->pb_pointer[0].pe_old_lnum = 1;
367 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
368 mf_put(mfp, hp, TRUE, FALSE);
371 * Allocate first data block and create an empty line 1.
373 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
374 goto error;
375 if (hp->bh_bnum != 2)
377 EMSG(_("E298: Didn't get block nr 2?"));
378 goto error;
381 dp = (DATA_BL *)(hp->bh_data);
382 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
383 dp->db_free -= 1 + INDEX_SIZE;
384 dp->db_line_count = 1;
385 *((char_u *)dp + dp->db_txt_start) = NUL; /* empty line */
387 return OK;
389 error:
390 if (mfp != NULL)
392 if (hp)
393 mf_put(mfp, hp, FALSE, FALSE);
394 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
396 buf->b_ml.ml_mfp = NULL;
397 return FAIL;
401 * ml_setname() is called when the file name of "buf" has been changed.
402 * It may rename the swap file.
404 void
405 ml_setname(buf)
406 buf_T *buf;
408 int success = FALSE;
409 memfile_T *mfp;
410 char_u *fname;
411 char_u *dirp;
412 #if defined(MSDOS) || defined(MSWIN)
413 char_u *p;
414 #endif
416 mfp = buf->b_ml.ml_mfp;
417 if (mfp->mf_fd < 0) /* there is no swap file yet */
420 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
421 * For help files we will make a swap file now.
423 if (p_uc != 0)
424 ml_open_file(buf); /* create a swap file */
425 return;
429 * Try all directories in the 'directory' option.
431 dirp = p_dir;
432 for (;;)
434 if (*dirp == NUL) /* tried all directories, fail */
435 break;
436 fname = findswapname(buf, &dirp, mfp->mf_fname);
437 /* alloc's fname */
438 if (fname == NULL) /* no file name found for this dir */
439 continue;
441 #if defined(MSDOS) || defined(MSWIN)
443 * Set full pathname for swap file now, because a ":!cd dir" may
444 * change directory without us knowing it.
446 p = FullName_save(fname, FALSE);
447 vim_free(fname);
448 fname = p;
449 if (fname == NULL)
450 continue;
451 #endif
452 /* if the file name is the same we don't have to do anything */
453 if (fnamecmp(fname, mfp->mf_fname) == 0)
455 vim_free(fname);
456 success = TRUE;
457 break;
459 /* need to close the swap file before renaming */
460 if (mfp->mf_fd >= 0)
462 close(mfp->mf_fd);
463 mfp->mf_fd = -1;
466 /* try to rename the swap file */
467 if (vim_rename(mfp->mf_fname, fname) == 0)
469 success = TRUE;
470 vim_free(mfp->mf_fname);
471 mfp->mf_fname = fname;
472 vim_free(mfp->mf_ffname);
473 #if defined(MSDOS) || defined(MSWIN)
474 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
475 #else
476 mf_set_ffname(mfp);
477 #endif
478 ml_upd_block0(buf, FALSE);
479 break;
481 vim_free(fname); /* this fname didn't work, try another */
484 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
486 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
487 if (mfp->mf_fd < 0)
489 /* could not (re)open the swap file, what can we do???? */
490 EMSG(_("E301: Oops, lost the swap file!!!"));
491 return;
493 #ifdef HAVE_FD_CLOEXEC
495 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
496 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
497 fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
499 #endif
501 if (!success)
502 EMSG(_("E302: Could not rename swap file"));
506 * Open a file for the memfile for all buffers that are not readonly or have
507 * been modified.
508 * Used when 'updatecount' changes from zero to non-zero.
510 void
511 ml_open_files()
513 buf_T *buf;
515 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
516 if (!buf->b_p_ro || buf->b_changed)
517 ml_open_file(buf);
521 * Open a swap file for an existing memfile, if there is no swap file yet.
522 * If we are unable to find a file name, mf_fname will be NULL
523 * and the memfile will be in memory only (no recovery possible).
525 void
526 ml_open_file(buf)
527 buf_T *buf;
529 memfile_T *mfp;
530 char_u *fname;
531 char_u *dirp;
533 mfp = buf->b_ml.ml_mfp;
534 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
535 return; /* nothing to do */
537 #ifdef FEAT_SPELL
538 /* For a spell buffer use a temp file name. */
539 if (buf->b_spell)
541 fname = vim_tempname('s');
542 if (fname != NULL)
543 (void)mf_open_file(mfp, fname); /* consumes fname! */
544 buf->b_may_swap = FALSE;
545 return;
547 #endif
550 * Try all directories in 'directory' option.
552 dirp = p_dir;
553 for (;;)
555 if (*dirp == NUL)
556 break;
557 /* There is a small chance that between chosing the swap file name and
558 * creating it, another Vim creates the file. In that case the
559 * creation will fail and we will use another directory. */
560 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
561 if (fname == NULL)
562 continue;
563 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
565 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
567 * set full pathname for swap file now, because a ":!cd dir" may
568 * change directory without us knowing it.
570 mf_fullname(mfp);
571 #endif
572 ml_upd_block0(buf, FALSE);
574 /* Flush block zero, so others can read it */
575 if (mf_sync(mfp, MFS_ZERO) == OK)
577 /* Mark all blocks that should be in the swapfile as dirty.
578 * Needed for when the 'swapfile' option was reset, so that
579 * the swap file was deleted, and then on again. */
580 mf_set_dirty(mfp);
581 break;
583 /* Writing block 0 failed: close the file and try another dir */
584 mf_close_file(buf, FALSE);
588 if (mfp->mf_fname == NULL) /* Failed! */
590 char_u *bname = (char_u *)buf_spname(buf);
591 need_wait_return = TRUE; /* call wait_return later */
592 ++no_wait_return;
593 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
594 bname
595 ? bname
596 : buf->b_fname);
597 vim_free(bname);
598 --no_wait_return;
601 /* don't try to open a swap file again */
602 buf->b_may_swap = FALSE;
606 * If still need to create a swap file, and starting to edit a not-readonly
607 * file, or reading into an existing buffer, create a swap file now.
609 void
610 check_need_swap(newfile)
611 int newfile; /* reading file into new buffer */
613 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
614 ml_open_file(curbuf);
618 * Close memline for buffer 'buf'.
619 * If 'del_file' is TRUE, delete the swap file
621 void
622 ml_close(buf, del_file)
623 buf_T *buf;
624 int del_file;
626 if (buf->b_ml.ml_mfp == NULL) /* not open */
627 return;
628 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
629 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
630 vim_free(buf->b_ml.ml_line_ptr);
631 vim_free(buf->b_ml.ml_stack);
632 #ifdef FEAT_BYTEOFF
633 vim_free(buf->b_ml.ml_chunksize);
634 buf->b_ml.ml_chunksize = NULL;
635 #endif
636 buf->b_ml.ml_mfp = NULL;
638 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
639 * this buffer is loaded. */
640 buf->b_flags &= ~BF_RECOVERED;
644 * Close all existing memlines and memfiles.
645 * Only used when exiting.
646 * When 'del_file' is TRUE, delete the memfiles.
647 * But don't delete files that were ":preserve"d when we are POSIX compatible.
649 void
650 ml_close_all(del_file)
651 int del_file;
653 buf_T *buf;
655 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
656 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
657 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
658 #ifdef TEMPDIRNAMES
659 vim_deltempdir(); /* delete created temp directory */
660 #endif
664 * Close all memfiles for not modified buffers.
665 * Only use just before exiting!
667 void
668 ml_close_notmod()
670 buf_T *buf;
672 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
673 if (!bufIsChanged(buf))
674 ml_close(buf, TRUE); /* close all not-modified buffers */
678 * Update the timestamp in the .swp file.
679 * Used when the file has been written.
681 void
682 ml_timestamp(buf)
683 buf_T *buf;
685 ml_upd_block0(buf, TRUE);
689 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
691 static void
692 ml_upd_block0(buf, set_fname)
693 buf_T *buf;
694 int set_fname;
696 memfile_T *mfp;
697 bhdr_T *hp;
698 ZERO_BL *b0p;
700 mfp = buf->b_ml.ml_mfp;
701 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
702 return;
703 b0p = (ZERO_BL *)(hp->bh_data);
704 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
705 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
706 else
708 if (set_fname)
709 set_b0_fname(b0p, buf);
710 else
711 set_b0_dir_flag(b0p, buf);
713 mf_put(mfp, hp, TRUE, FALSE);
717 * Write file name and timestamp into block 0 of a swap file.
718 * Also set buf->b_mtime.
719 * Don't use NameBuff[]!!!
721 static void
722 set_b0_fname(b0p, buf)
723 ZERO_BL *b0p;
724 buf_T *buf;
726 struct stat st;
728 if (buf->b_ffname == NULL)
729 b0p->b0_fname[0] = NUL;
730 else
732 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
733 /* Systems that cannot translate "~user" back into a path: copy the
734 * file name unmodified. Do use slashes instead of backslashes for
735 * portability. */
736 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
737 # ifdef BACKSLASH_IN_FILENAME
738 forward_slash(b0p->b0_fname);
739 # endif
740 #else
741 size_t flen, ulen;
742 char_u uname[B0_UNAME_SIZE];
745 * For a file under the home directory of the current user, we try to
746 * replace the home directory path with "~user". This helps when
747 * editing the same file on different machines over a network.
748 * First replace home dir path with "~/" with home_replace().
749 * Then insert the user name to get "~user/".
751 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
752 if (b0p->b0_fname[0] == '~')
754 flen = STRLEN(b0p->b0_fname);
755 /* If there is no user name or it is too long, don't use "~/" */
756 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
757 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
758 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
759 else
761 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
762 mch_memmove(b0p->b0_fname + 1, uname, ulen);
765 #endif
766 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
768 long_to_char((long)st.st_mtime, b0p->b0_mtime);
769 #ifdef CHECK_INODE
770 long_to_char((long)st.st_ino, b0p->b0_ino);
771 #endif
772 buf_store_time(buf, &st, buf->b_ffname);
773 buf->b_mtime_read = buf->b_mtime;
775 else
777 long_to_char(0L, b0p->b0_mtime);
778 #ifdef CHECK_INODE
779 long_to_char(0L, b0p->b0_ino);
780 #endif
781 buf->b_mtime = 0;
782 buf->b_mtime_read = 0;
783 buf->b_orig_size = 0;
784 buf->b_orig_mode = 0;
788 #ifdef FEAT_MBYTE
789 /* Also add the 'fileencoding' if there is room. */
790 add_b0_fenc(b0p, curbuf);
791 #endif
795 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
796 * swapfile for "buf" are in the same directory.
797 * This is fail safe: if we are not sure the directories are equal the flag is
798 * not set.
800 static void
801 set_b0_dir_flag(b0p, buf)
802 ZERO_BL *b0p;
803 buf_T *buf;
805 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
806 b0p->b0_flags |= B0_SAME_DIR;
807 else
808 b0p->b0_flags &= ~B0_SAME_DIR;
811 #ifdef FEAT_MBYTE
813 * When there is room, add the 'fileencoding' to block zero.
815 static void
816 add_b0_fenc(b0p, buf)
817 ZERO_BL *b0p;
818 buf_T *buf;
820 int n;
822 n = (int)STRLEN(buf->b_p_fenc);
823 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
824 b0p->b0_flags &= ~B0_HAS_FENC;
825 else
827 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
828 (char *)buf->b_p_fenc, (size_t)n);
829 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
830 b0p->b0_flags |= B0_HAS_FENC;
833 #endif
837 * try to recover curbuf from the .swp file
839 void
840 ml_recover()
842 buf_T *buf = NULL;
843 memfile_T *mfp = NULL;
844 char_u *fname;
845 bhdr_T *hp = NULL;
846 ZERO_BL *b0p;
847 int b0_ff;
848 char_u *b0_fenc = NULL;
849 PTR_BL *pp;
850 DATA_BL *dp;
851 infoptr_T *ip;
852 blocknr_T bnum;
853 int page_count;
854 struct stat org_stat, swp_stat;
855 int len;
856 int directly;
857 linenr_T lnum;
858 char_u *p;
859 int i;
860 long error;
861 int cannot_open;
862 linenr_T line_count;
863 int has_error;
864 int idx;
865 int top;
866 int txt_start;
867 off_t size;
868 int called_from_main;
869 int serious_error = TRUE;
870 long mtime;
871 int attr;
872 char_u *bname;
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 ((bname = (char_u *)buf_spname(curbuf)) != NULL)
1078 vim_strncpy(NameBuff, bname, MAXPATHL - 1);
1079 vim_free(bname);
1081 else
1082 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1083 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1084 msg_putchar('\n');
1087 * check date of swap file and original file
1089 mtime = char_to_long(b0p->b0_mtime);
1090 if (curbuf->b_ffname != NULL
1091 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1092 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1093 && org_stat.st_mtime > swp_stat.st_mtime)
1094 || org_stat.st_mtime != mtime))
1096 EMSG(_("E308: Warning: Original file may have been changed"));
1098 out_flush();
1100 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1101 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1102 if (b0p->b0_flags & B0_HAS_FENC)
1104 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1105 p > b0p->b0_fname && p[-1] != NUL; --p)
1107 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1110 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1111 hp = NULL;
1114 * Now that we are sure that the file is going to be recovered, clear the
1115 * contents of the current buffer.
1117 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1118 ml_delete((linenr_T)1, FALSE);
1121 * Try reading the original file to obtain the values of 'fileformat',
1122 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1124 if (curbuf->b_ffname != NULL)
1126 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1127 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1128 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1129 ml_delete((linenr_T)1, FALSE);
1132 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1133 if (b0_ff != 0)
1134 set_fileformat(b0_ff - 1, OPT_LOCAL);
1135 if (b0_fenc != NULL)
1137 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1138 vim_free(b0_fenc);
1140 unchanged(curbuf, TRUE);
1142 bnum = 1; /* start with block 1 */
1143 page_count = 1; /* which is 1 page */
1144 lnum = 0; /* append after line 0 in curbuf */
1145 line_count = 0;
1146 idx = 0; /* start with first index in block 1 */
1147 error = 0;
1148 buf->b_ml.ml_stack_top = 0;
1149 buf->b_ml.ml_stack = NULL;
1150 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1152 if (curbuf->b_ffname == NULL)
1153 cannot_open = TRUE;
1154 else
1155 cannot_open = FALSE;
1157 serious_error = FALSE;
1158 for ( ; !got_int; line_breakcheck())
1160 if (hp != NULL)
1161 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1164 * get block
1166 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1168 if (bnum == 1)
1170 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1171 goto theend;
1173 ++error;
1174 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1175 (colnr_T)0, TRUE);
1177 else /* there is a block */
1179 pp = (PTR_BL *)(hp->bh_data);
1180 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1182 /* check line count when using pointer block first time */
1183 if (idx == 0 && line_count != 0)
1185 for (i = 0; i < (int)pp->pb_count; ++i)
1186 line_count -= pp->pb_pointer[i].pe_line_count;
1187 if (line_count != 0)
1189 ++error;
1190 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1191 (colnr_T)0, TRUE);
1195 if (pp->pb_count == 0)
1197 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1198 (colnr_T)0, TRUE);
1199 ++error;
1201 else if (idx < (int)pp->pb_count) /* go a block deeper */
1203 if (pp->pb_pointer[idx].pe_bnum < 0)
1206 * Data block with negative block number.
1207 * Try to read lines from the original file.
1208 * This is slow, but it works.
1210 if (!cannot_open)
1212 line_count = pp->pb_pointer[idx].pe_line_count;
1213 if (readfile(curbuf->b_ffname, NULL, lnum,
1214 pp->pb_pointer[idx].pe_old_lnum - 1,
1215 line_count, NULL, 0) == FAIL)
1216 cannot_open = TRUE;
1217 else
1218 lnum += line_count;
1220 if (cannot_open)
1222 ++error;
1223 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1224 (colnr_T)0, TRUE);
1226 ++idx; /* get same block again for next index */
1227 continue;
1231 * going one block deeper in the tree
1233 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1235 ++error;
1236 break; /* out of memory */
1238 ip = &(buf->b_ml.ml_stack[top]);
1239 ip->ip_bnum = bnum;
1240 ip->ip_index = idx;
1242 bnum = pp->pb_pointer[idx].pe_bnum;
1243 line_count = pp->pb_pointer[idx].pe_line_count;
1244 page_count = pp->pb_pointer[idx].pe_page_count;
1245 continue;
1248 else /* not a pointer block */
1250 dp = (DATA_BL *)(hp->bh_data);
1251 if (dp->db_id != DATA_ID) /* block id wrong */
1253 if (bnum == 1)
1255 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1256 mfp->mf_fname);
1257 goto theend;
1259 ++error;
1260 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1261 (colnr_T)0, TRUE);
1263 else
1266 * it is a data block
1267 * Append all the lines in this block
1269 has_error = FALSE;
1271 * check length of block
1272 * if wrong, use length in pointer block
1274 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1276 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1277 (colnr_T)0, TRUE);
1278 ++error;
1279 has_error = TRUE;
1280 dp->db_txt_end = page_count * mfp->mf_page_size;
1283 /* make sure there is a NUL at the end of the block */
1284 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1287 * check number of lines in block
1288 * if wrong, use count in data block
1290 if (line_count != dp->db_line_count)
1292 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1293 (colnr_T)0, TRUE);
1294 ++error;
1295 has_error = TRUE;
1298 for (i = 0; i < dp->db_line_count; ++i)
1300 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1301 if (txt_start <= (int)HEADER_SIZE
1302 || txt_start >= (int)dp->db_txt_end)
1304 p = (char_u *)"???";
1305 ++error;
1307 else
1308 p = (char_u *)dp + txt_start;
1309 ml_append(lnum++, p, (colnr_T)0, TRUE);
1311 if (has_error)
1312 ml_append(lnum++, (char_u *)_("???END"),
1313 (colnr_T)0, TRUE);
1318 if (buf->b_ml.ml_stack_top == 0) /* finished */
1319 break;
1322 * go one block up in the tree
1324 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1325 bnum = ip->ip_bnum;
1326 idx = ip->ip_index + 1; /* go to next index */
1327 page_count = 1;
1331 * The dummy line from the empty buffer will now be after the last line in
1332 * the buffer. Delete it.
1334 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1335 curbuf->b_flags |= BF_RECOVERED;
1337 recoverymode = FALSE;
1338 if (got_int)
1339 EMSG(_("E311: Recovery Interrupted"));
1340 else if (error)
1342 ++no_wait_return;
1343 MSG(">>>>>>>>>>>>>");
1344 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1345 --no_wait_return;
1346 MSG(_("See \":help E312\" for more information."));
1347 MSG(">>>>>>>>>>>>>");
1349 else
1351 MSG(_("Recovery completed. You should check if everything is OK."));
1352 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1353 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1354 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1355 cmdline_row = msg_row;
1357 redraw_curbuf_later(NOT_VALID);
1359 theend:
1360 recoverymode = FALSE;
1361 if (mfp != NULL)
1363 if (hp != NULL)
1364 mf_put(mfp, hp, FALSE, FALSE);
1365 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1367 if (buf != NULL)
1369 vim_free(buf->b_ml.ml_stack);
1370 vim_free(buf);
1372 if (serious_error && called_from_main)
1373 ml_close(curbuf, TRUE);
1374 #ifdef FEAT_AUTOCMD
1375 else
1377 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1378 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1380 #endif
1381 return;
1385 * Find the names of swap files in current directory and the directory given
1386 * with the 'directory' option.
1388 * Used to:
1389 * - list the swap files for "vim -r"
1390 * - count the number of swap files when recovering
1391 * - list the swap files when recovering
1392 * - find the name of the n'th swap file when recovering
1395 recover_names(fname, list, nr)
1396 char_u **fname; /* base for swap file name */
1397 int list; /* when TRUE, list the swap file names */
1398 int nr; /* when non-zero, return nr'th swap file name */
1400 int num_names;
1401 char_u *(names[6]);
1402 char_u *tail;
1403 char_u *p;
1404 int num_files;
1405 int file_count = 0;
1406 char_u **files;
1407 int i;
1408 char_u *dirp;
1409 char_u *dir_name;
1411 if (list)
1413 /* use msg() to start the scrolling properly */
1414 msg((char_u *)_("Swap files found:"));
1415 msg_putchar('\n');
1419 * Do the loop for every directory in 'directory'.
1420 * First allocate some memory to put the directory name in.
1422 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1423 dirp = p_dir;
1424 while (dir_name != NULL && *dirp)
1427 * Isolate a directory name from *dirp and put it in dir_name (we know
1428 * it is large enough, so use 31000 for length).
1429 * Advance dirp to next directory name.
1431 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1433 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1435 if (fname == NULL || *fname == NULL)
1437 #ifdef VMS
1438 names[0] = vim_strsave((char_u *)"*_sw%");
1439 #else
1440 # ifdef RISCOS
1441 names[0] = vim_strsave((char_u *)"*_sw#");
1442 # else
1443 names[0] = vim_strsave((char_u *)"*.sw?");
1444 # endif
1445 #endif
1446 #if defined(UNIX) || defined(WIN3264)
1447 /* For Unix names starting with a dot are special. MS-Windows
1448 * supports this too, on some file systems. */
1449 names[1] = vim_strsave((char_u *)".*.sw?");
1450 names[2] = vim_strsave((char_u *)".sw?");
1451 num_names = 3;
1452 #else
1453 # ifdef VMS
1454 names[1] = vim_strsave((char_u *)".*_sw%");
1455 num_names = 2;
1456 # else
1457 num_names = 1;
1458 # endif
1459 #endif
1461 else
1462 num_names = recov_file_names(names, *fname, TRUE);
1464 else /* check directory dir_name */
1466 if (fname == NULL || *fname == NULL)
1468 #ifdef VMS
1469 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1470 #else
1471 # ifdef RISCOS
1472 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1473 # else
1474 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1475 # endif
1476 #endif
1477 #if defined(UNIX) || defined(WIN3264)
1478 /* For Unix names starting with a dot are special. MS-Windows
1479 * supports this too, on some file systems. */
1480 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1481 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1482 num_names = 3;
1483 #else
1484 # ifdef VMS
1485 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1486 num_names = 2;
1487 # else
1488 num_names = 1;
1489 # endif
1490 #endif
1492 else
1494 #if defined(UNIX) || defined(WIN3264)
1495 p = dir_name + STRLEN(dir_name);
1496 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1498 /* Ends with '//', Use Full path for swap name */
1499 tail = make_percent_swname(dir_name, *fname);
1501 else
1502 #endif
1504 tail = gettail(*fname);
1505 tail = concat_fnames(dir_name, tail, TRUE);
1507 if (tail == NULL)
1508 num_names = 0;
1509 else
1511 num_names = recov_file_names(names, tail, FALSE);
1512 vim_free(tail);
1517 /* check for out-of-memory */
1518 for (i = 0; i < num_names; ++i)
1520 if (names[i] == NULL)
1522 for (i = 0; i < num_names; ++i)
1523 vim_free(names[i]);
1524 num_names = 0;
1527 if (num_names == 0)
1528 num_files = 0;
1529 else if (expand_wildcards(num_names, names, &num_files, &files,
1530 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1531 num_files = 0;
1534 * When no swap file found, wildcard expansion might have failed (e.g.
1535 * not able to execute the shell).
1536 * Try finding a swap file by simply adding ".swp" to the file name.
1538 if (*dirp == NUL && file_count + num_files == 0
1539 && fname != NULL && *fname != NULL)
1541 struct stat st;
1542 char_u *swapname;
1544 #if defined(VMS) || defined(RISCOS)
1545 swapname = modname(*fname, (char_u *)"_swp", FALSE);
1546 #else
1547 swapname = modname(*fname, (char_u *)".swp", TRUE);
1548 #endif
1549 if (swapname != NULL)
1551 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1553 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1554 if (files != NULL)
1556 files[0] = swapname;
1557 swapname = NULL;
1558 num_files = 1;
1561 vim_free(swapname);
1566 * remove swapfile name of the current buffer, it must be ignored
1568 if (curbuf->b_ml.ml_mfp != NULL
1569 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1571 for (i = 0; i < num_files; ++i)
1572 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1574 /* Remove the name from files[i]. Move further entries
1575 * down. When the array becomes empty free it here, since
1576 * FreeWild() won't be called below. */
1577 vim_free(files[i]);
1578 if (--num_files == 0)
1579 vim_free(files);
1580 else
1581 for ( ; i < num_files; ++i)
1582 files[i] = files[i + 1];
1585 if (nr > 0)
1587 file_count += num_files;
1588 if (nr <= file_count)
1590 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1591 dirp = (char_u *)""; /* stop searching */
1594 else if (list)
1596 if (dir_name[0] == '.' && dir_name[1] == NUL)
1598 if (fname == NULL || *fname == NULL)
1599 MSG_PUTS(_(" In current directory:\n"));
1600 else
1601 MSG_PUTS(_(" Using specified name:\n"));
1603 else
1605 MSG_PUTS(_(" In directory "));
1606 msg_home_replace(dir_name);
1607 MSG_PUTS(":\n");
1610 if (num_files)
1612 for (i = 0; i < num_files; ++i)
1614 /* print the swap file name */
1615 msg_outnum((long)++file_count);
1616 MSG_PUTS(". ");
1617 msg_puts(gettail(files[i]));
1618 msg_putchar('\n');
1619 (void)swapfile_info(files[i]);
1622 else
1623 MSG_PUTS(_(" -- none --\n"));
1624 out_flush();
1626 else
1627 file_count += num_files;
1629 for (i = 0; i < num_names; ++i)
1630 vim_free(names[i]);
1631 if (num_files > 0)
1632 FreeWild(num_files, files);
1634 vim_free(dir_name);
1635 return file_count;
1638 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1640 * Append the full path to name with path separators made into percent
1641 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1643 static char_u *
1644 make_percent_swname(dir, name)
1645 char_u *dir;
1646 char_u *name;
1648 char_u *d, *s, *f;
1650 f = fix_fname(name != NULL ? name : (char_u *) "");
1651 d = NULL;
1652 if (f != NULL)
1654 s = alloc((unsigned)(STRLEN(f) + 1));
1655 if (s != NULL)
1657 STRCPY(s, f);
1658 for (d = s; *d != NUL; mb_ptr_adv(d))
1659 if (vim_ispathsep(*d))
1660 *d = '%';
1661 d = concat_fnames(dir, s, TRUE);
1662 vim_free(s);
1664 vim_free(f);
1666 return d;
1668 #endif
1670 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1671 static int process_still_running;
1672 #endif
1675 * Give information about an existing swap file.
1676 * Returns timestamp (0 when unknown).
1678 static time_t
1679 swapfile_info(fname)
1680 char_u *fname;
1682 struct stat st;
1683 int fd;
1684 struct block0 b0;
1685 time_t x = (time_t)0;
1686 char *p;
1687 #ifdef UNIX
1688 char_u uname[B0_UNAME_SIZE];
1689 #endif
1691 /* print the swap file date */
1692 if (mch_stat((char *)fname, &st) != -1)
1694 #ifdef UNIX
1695 /* print name of owner of the file */
1696 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1698 MSG_PUTS(_(" owned by: "));
1699 msg_outtrans(uname);
1700 MSG_PUTS(_(" dated: "));
1702 else
1703 #endif
1704 MSG_PUTS(_(" dated: "));
1705 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1706 p = ctime(&x); /* includes '\n' */
1707 if (p == NULL)
1708 MSG_PUTS("(invalid)\n");
1709 else
1710 MSG_PUTS(p);
1714 * print the original file name
1716 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1717 if (fd >= 0)
1719 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1721 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1723 MSG_PUTS(_(" [from Vim version 3.0]"));
1725 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1727 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1729 else
1731 MSG_PUTS(_(" file name: "));
1732 if (b0.b0_fname[0] == NUL)
1733 MSG_PUTS(_("[No Name]"));
1734 else
1735 msg_outtrans(b0.b0_fname);
1737 MSG_PUTS(_("\n modified: "));
1738 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1740 if (*(b0.b0_uname) != NUL)
1742 MSG_PUTS(_("\n user name: "));
1743 msg_outtrans(b0.b0_uname);
1746 if (*(b0.b0_hname) != NUL)
1748 if (*(b0.b0_uname) != NUL)
1749 MSG_PUTS(_(" host name: "));
1750 else
1751 MSG_PUTS(_("\n host name: "));
1752 msg_outtrans(b0.b0_hname);
1755 if (char_to_long(b0.b0_pid) != 0L)
1757 MSG_PUTS(_("\n process ID: "));
1758 msg_outnum(char_to_long(b0.b0_pid));
1759 #if defined(UNIX) || defined(__EMX__)
1760 /* EMX kill() not working correctly, it seems */
1761 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1763 MSG_PUTS(_(" (still running)"));
1764 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1765 process_still_running = TRUE;
1766 # endif
1768 #endif
1771 if (b0_magic_wrong(&b0))
1773 #if defined(MSDOS) || defined(MSWIN)
1774 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1775 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1776 else
1777 #endif
1778 MSG_PUTS(_("\n [not usable on this computer]"));
1782 else
1783 MSG_PUTS(_(" [cannot be read]"));
1784 close(fd);
1786 else
1787 MSG_PUTS(_(" [cannot be opened]"));
1788 msg_putchar('\n');
1790 return x;
1793 static int
1794 recov_file_names(names, path, prepend_dot)
1795 char_u **names;
1796 char_u *path;
1797 int prepend_dot;
1799 int num_names;
1801 #ifdef SHORT_FNAME
1803 * (MS-DOS) always short names
1805 names[0] = modname(path, (char_u *)".sw?", FALSE);
1806 num_names = 1;
1807 #else /* !SHORT_FNAME */
1809 * (Win32 and Win64) never short names, but do prepend a dot.
1810 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1811 * Only use the short name if it is different.
1813 char_u *p;
1814 int i;
1815 # ifndef WIN3264
1816 int shortname = curbuf->b_shortname;
1818 curbuf->b_shortname = FALSE;
1819 # endif
1821 num_names = 0;
1824 * May also add the file name with a dot prepended, for swap file in same
1825 * dir as original file.
1827 if (prepend_dot)
1829 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1830 if (names[num_names] == NULL)
1831 goto end;
1832 ++num_names;
1836 * Form the normal swap file name pattern by appending ".sw?".
1838 #ifdef VMS
1839 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1840 #else
1841 # ifdef RISCOS
1842 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1843 # else
1844 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1845 # endif
1846 #endif
1847 if (names[num_names] == NULL)
1848 goto end;
1849 if (num_names >= 1) /* check if we have the same name twice */
1851 p = names[num_names - 1];
1852 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1853 if (i > 0)
1854 p += i; /* file name has been expanded to full path */
1856 if (STRCMP(p, names[num_names]) != 0)
1857 ++num_names;
1858 else
1859 vim_free(names[num_names]);
1861 else
1862 ++num_names;
1864 # ifndef WIN3264
1866 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1868 curbuf->b_shortname = TRUE;
1869 #ifdef VMS
1870 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1871 #else
1872 # ifdef RISCOS
1873 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1874 # else
1875 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1876 # endif
1877 #endif
1878 if (names[num_names] == NULL)
1879 goto end;
1882 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1884 p = names[num_names];
1885 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1886 if (i > 0)
1887 p += i; /* file name has been expanded to full path */
1888 if (STRCMP(names[num_names - 1], p) == 0)
1889 vim_free(names[num_names]);
1890 else
1891 ++num_names;
1892 # endif
1894 end:
1895 # ifndef WIN3264
1896 curbuf->b_shortname = shortname;
1897 # endif
1899 #endif /* !SHORT_FNAME */
1901 return num_names;
1905 * sync all memlines
1907 * If 'check_file' is TRUE, check if original file exists and was not changed.
1908 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1909 * always sync at least one block.
1911 void
1912 ml_sync_all(check_file, check_char)
1913 int check_file;
1914 int check_char;
1916 buf_T *buf;
1917 struct stat st;
1919 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1921 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1922 continue; /* no file */
1924 ml_flush_line(buf); /* flush buffered line */
1925 /* flush locked block */
1926 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1927 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1928 && buf->b_ffname != NULL)
1931 * If the original file does not exist anymore or has been changed
1932 * call ml_preserve() to get rid of all negative numbered blocks.
1934 if (mch_stat((char *)buf->b_ffname, &st) == -1
1935 || st.st_mtime != buf->b_mtime_read
1936 || (size_t)st.st_size != buf->b_orig_size)
1938 ml_preserve(buf, FALSE);
1939 did_check_timestamps = FALSE;
1940 need_check_timestamps = TRUE; /* give message later */
1943 if (buf->b_ml.ml_mfp->mf_dirty)
1945 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1946 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1947 if (check_char && ui_char_avail()) /* character available now */
1948 break;
1954 * sync one buffer, including negative blocks
1956 * after this all the blocks are in the swap file
1958 * Used for the :preserve command and when the original file has been
1959 * changed or deleted.
1961 * when message is TRUE the success of preserving is reported
1963 void
1964 ml_preserve(buf, message)
1965 buf_T *buf;
1966 int message;
1968 bhdr_T *hp;
1969 linenr_T lnum;
1970 memfile_T *mfp = buf->b_ml.ml_mfp;
1971 int status;
1972 int got_int_save = got_int;
1974 if (mfp == NULL || mfp->mf_fname == NULL)
1976 if (message)
1977 EMSG(_("E313: Cannot preserve, there is no swap file"));
1978 return;
1981 /* We only want to stop when interrupted here, not when interrupted
1982 * before. */
1983 got_int = FALSE;
1985 ml_flush_line(buf); /* flush buffered line */
1986 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
1987 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
1989 /* stack is invalid after mf_sync(.., MFS_ALL) */
1990 buf->b_ml.ml_stack_top = 0;
1993 * Some of the data blocks may have been changed from negative to
1994 * positive block number. In that case the pointer blocks need to be
1995 * updated.
1997 * We don't know in which pointer block the references are, so we visit
1998 * all data blocks until there are no more translations to be done (or
1999 * we hit the end of the file, which can only happen in case a write fails,
2000 * e.g. when file system if full).
2001 * ml_find_line() does the work by translating the negative block numbers
2002 * when getting the first line of each data block.
2004 if (mf_need_trans(mfp) && !got_int)
2006 lnum = 1;
2007 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2009 hp = ml_find_line(buf, lnum, ML_FIND);
2010 if (hp == NULL)
2012 status = FAIL;
2013 goto theend;
2015 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2016 lnum = buf->b_ml.ml_locked_high + 1;
2018 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2019 /* sync the updated pointer blocks */
2020 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2021 status = FAIL;
2022 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2024 theend:
2025 got_int |= got_int_save;
2027 if (message)
2029 if (status == OK)
2030 MSG(_("File preserved"));
2031 else
2032 EMSG(_("E314: Preserve failed"));
2037 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2038 * until the next call!
2039 * line1 = ml_get(1);
2040 * line2 = ml_get(2); // line1 is now invalid!
2041 * Make a copy of the line if necessary.
2044 * get a pointer to a (read-only copy of a) line
2046 * On failure an error message is given and IObuff is returned (to avoid
2047 * having to check for error everywhere).
2049 char_u *
2050 ml_get(lnum)
2051 linenr_T lnum;
2053 return ml_get_buf(curbuf, lnum, FALSE);
2057 * ml_get_pos: get pointer to position 'pos'
2059 char_u *
2060 ml_get_pos(pos)
2061 pos_T *pos;
2063 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2067 * ml_get_curline: get pointer to cursor line.
2069 char_u *
2070 ml_get_curline()
2072 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2076 * ml_get_cursor: get pointer to cursor position
2078 char_u *
2079 ml_get_cursor()
2081 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2082 curwin->w_cursor.col);
2086 * get a pointer to a line in a specific buffer
2088 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2089 * changed)
2091 char_u *
2092 ml_get_buf(buf, lnum, will_change)
2093 buf_T *buf;
2094 linenr_T lnum;
2095 int will_change; /* line will be changed */
2097 bhdr_T *hp;
2098 DATA_BL *dp;
2099 char_u *ptr;
2100 static int recursive = 0;
2102 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2104 if (recursive == 0)
2106 /* Avoid giving this message for a recursive call, may happen when
2107 * the GUI redraws part of the text. */
2108 ++recursive;
2109 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2110 --recursive;
2112 errorret:
2113 STRCPY(IObuff, "???");
2114 return IObuff;
2116 if (lnum <= 0) /* pretend line 0 is line 1 */
2117 lnum = 1;
2119 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2120 return (char_u *)"";
2123 * See if it is the same line as requested last time.
2124 * Otherwise may need to flush last used line.
2125 * Don't use the last used line when 'swapfile' is reset, need to load all
2126 * blocks.
2128 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2130 ml_flush_line(buf);
2133 * Find the data block containing the line.
2134 * This also fills the stack with the blocks from the root to the data
2135 * block and releases any locked block.
2137 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2139 if (recursive == 0)
2141 /* Avoid giving this message for a recursive call, may happen
2142 * when the GUI redraws part of the text. */
2143 ++recursive;
2144 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2145 --recursive;
2147 goto errorret;
2150 dp = (DATA_BL *)(hp->bh_data);
2152 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2153 buf->b_ml.ml_line_ptr = ptr;
2154 buf->b_ml.ml_line_lnum = lnum;
2155 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2157 if (will_change)
2158 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2160 return buf->b_ml.ml_line_ptr;
2164 * Check if a line that was just obtained by a call to ml_get
2165 * is in allocated memory.
2168 ml_line_alloced()
2170 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2174 * Append a line after lnum (may be 0 to insert a line in front of the file).
2175 * "line" does not need to be allocated, but can't be another line in a
2176 * buffer, unlocking may make it invalid.
2178 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2179 * will be set for recovery
2180 * Check: The caller of this function should probably also call
2181 * appended_lines().
2183 * return FAIL for failure, OK otherwise
2186 ml_append(lnum, line, len, newfile)
2187 linenr_T lnum; /* append after this line (can be 0) */
2188 char_u *line; /* text of the new line */
2189 colnr_T len; /* length of new line, including NUL, or 0 */
2190 int newfile; /* flag, see above */
2192 /* When starting up, we might still need to create the memfile */
2193 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2194 return FAIL;
2196 if (curbuf->b_ml.ml_line_lnum != 0)
2197 ml_flush_line(curbuf);
2198 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2201 #if defined(FEAT_SPELL) || defined(PROTO)
2203 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2204 * a memline.
2207 ml_append_buf(buf, lnum, line, len, newfile)
2208 buf_T *buf;
2209 linenr_T lnum; /* append after this line (can be 0) */
2210 char_u *line; /* text of the new line */
2211 colnr_T len; /* length of new line, including NUL, or 0 */
2212 int newfile; /* flag, see above */
2214 if (buf->b_ml.ml_mfp == NULL)
2215 return FAIL;
2217 if (buf->b_ml.ml_line_lnum != 0)
2218 ml_flush_line(buf);
2219 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2221 #endif
2223 static int
2224 ml_append_int(buf, lnum, line, len, newfile, mark)
2225 buf_T *buf;
2226 linenr_T lnum; /* append after this line (can be 0) */
2227 char_u *line; /* text of the new line */
2228 colnr_T len; /* length of line, including NUL, or 0 */
2229 int newfile; /* flag, see above */
2230 int mark; /* mark the new line */
2232 int i;
2233 int line_count; /* number of indexes in current block */
2234 int offset;
2235 int from, to;
2236 int space_needed; /* space needed for new line */
2237 int page_size;
2238 int page_count;
2239 int db_idx; /* index for lnum in data block */
2240 bhdr_T *hp;
2241 memfile_T *mfp;
2242 DATA_BL *dp;
2243 PTR_BL *pp;
2244 infoptr_T *ip;
2246 /* lnum out of range */
2247 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2248 return FAIL;
2250 if (lowest_marked && lowest_marked > lnum)
2251 lowest_marked = lnum + 1;
2253 if (len == 0)
2254 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2255 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2257 mfp = buf->b_ml.ml_mfp;
2258 page_size = mfp->mf_page_size;
2261 * find the data block containing the previous line
2262 * This also fills the stack with the blocks from the root to the data block
2263 * This also releases any locked block.
2265 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2266 ML_INSERT)) == NULL)
2267 return FAIL;
2269 buf->b_ml.ml_flags &= ~ML_EMPTY;
2271 if (lnum == 0) /* got line one instead, correct db_idx */
2272 db_idx = -1; /* careful, it is negative! */
2273 else
2274 db_idx = lnum - buf->b_ml.ml_locked_low;
2275 /* get line count before the insertion */
2276 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2278 dp = (DATA_BL *)(hp->bh_data);
2281 * If
2282 * - there is not enough room in the current block
2283 * - appending to the last line in the block
2284 * - not appending to the last line in the file
2285 * insert in front of the next block.
2287 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2288 && lnum < buf->b_ml.ml_line_count)
2291 * Now that the line is not going to be inserted in the block that we
2292 * expected, the line count has to be adjusted in the pointer blocks
2293 * by using ml_locked_lineadd.
2295 --(buf->b_ml.ml_locked_lineadd);
2296 --(buf->b_ml.ml_locked_high);
2297 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2298 return FAIL;
2300 db_idx = -1; /* careful, it is negative! */
2301 /* get line count before the insertion */
2302 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2303 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2305 dp = (DATA_BL *)(hp->bh_data);
2308 ++buf->b_ml.ml_line_count;
2310 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2313 * Insert new line in existing data block, or in data block allocated above.
2315 dp->db_txt_start -= len;
2316 dp->db_free -= space_needed;
2317 ++(dp->db_line_count);
2320 * move the text of the lines that follow to the front
2321 * adjust the indexes of the lines that follow
2323 if (line_count > db_idx + 1) /* if there are following lines */
2326 * Offset is the start of the previous line.
2327 * This will become the character just after the new line.
2329 if (db_idx < 0)
2330 offset = dp->db_txt_end;
2331 else
2332 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2333 mch_memmove((char *)dp + dp->db_txt_start,
2334 (char *)dp + dp->db_txt_start + len,
2335 (size_t)(offset - (dp->db_txt_start + len)));
2336 for (i = line_count - 1; i > db_idx; --i)
2337 dp->db_index[i + 1] = dp->db_index[i] - len;
2338 dp->db_index[db_idx + 1] = offset - len;
2340 else /* add line at the end */
2341 dp->db_index[db_idx + 1] = dp->db_txt_start;
2344 * copy the text into the block
2346 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2347 if (mark)
2348 dp->db_index[db_idx + 1] |= DB_MARKED;
2351 * Mark the block dirty.
2353 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2354 if (!newfile)
2355 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2357 else /* not enough space in data block */
2360 * If there is not enough room we have to create a new data block and copy some
2361 * lines into it.
2362 * Then we have to insert an entry in the pointer block.
2363 * If this pointer block also is full, we go up another block, and so on, up
2364 * to the root if necessary.
2365 * The line counts in the pointer blocks have already been adjusted by
2366 * ml_find_line().
2368 long line_count_left, line_count_right;
2369 int page_count_left, page_count_right;
2370 bhdr_T *hp_left;
2371 bhdr_T *hp_right;
2372 bhdr_T *hp_new;
2373 int lines_moved;
2374 int data_moved = 0; /* init to shut up gcc */
2375 int total_moved = 0; /* init to shut up gcc */
2376 DATA_BL *dp_right, *dp_left;
2377 int stack_idx;
2378 int in_left;
2379 int lineadd;
2380 blocknr_T bnum_left, bnum_right;
2381 linenr_T lnum_left, lnum_right;
2382 int pb_idx;
2383 PTR_BL *pp_new;
2386 * We are going to allocate a new data block. Depending on the
2387 * situation it will be put to the left or right of the existing
2388 * block. If possible we put the new line in the left block and move
2389 * the lines after it to the right block. Otherwise the new line is
2390 * also put in the right block. This method is more efficient when
2391 * inserting a lot of lines at one place.
2393 if (db_idx < 0) /* left block is new, right block is existing */
2395 lines_moved = 0;
2396 in_left = TRUE;
2397 /* space_needed does not change */
2399 else /* left block is existing, right block is new */
2401 lines_moved = line_count - db_idx - 1;
2402 if (lines_moved == 0)
2403 in_left = FALSE; /* put new line in right block */
2404 /* space_needed does not change */
2405 else
2407 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2408 dp->db_txt_start;
2409 total_moved = data_moved + lines_moved * INDEX_SIZE;
2410 if ((int)dp->db_free + total_moved >= space_needed)
2412 in_left = TRUE; /* put new line in left block */
2413 space_needed = total_moved;
2415 else
2417 in_left = FALSE; /* put new line in right block */
2418 space_needed += total_moved;
2423 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2424 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2426 /* correct line counts in pointer blocks */
2427 --(buf->b_ml.ml_locked_lineadd);
2428 --(buf->b_ml.ml_locked_high);
2429 return FAIL;
2431 if (db_idx < 0) /* left block is new */
2433 hp_left = hp_new;
2434 hp_right = hp;
2435 line_count_left = 0;
2436 line_count_right = line_count;
2438 else /* right block is new */
2440 hp_left = hp;
2441 hp_right = hp_new;
2442 line_count_left = line_count;
2443 line_count_right = 0;
2445 dp_right = (DATA_BL *)(hp_right->bh_data);
2446 dp_left = (DATA_BL *)(hp_left->bh_data);
2447 bnum_left = hp_left->bh_bnum;
2448 bnum_right = hp_right->bh_bnum;
2449 page_count_left = hp_left->bh_page_count;
2450 page_count_right = hp_right->bh_page_count;
2453 * May move the new line into the right/new block.
2455 if (!in_left)
2457 dp_right->db_txt_start -= len;
2458 dp_right->db_free -= len + INDEX_SIZE;
2459 dp_right->db_index[0] = dp_right->db_txt_start;
2460 if (mark)
2461 dp_right->db_index[0] |= DB_MARKED;
2463 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2464 line, (size_t)len);
2465 ++line_count_right;
2468 * may move lines from the left/old block to the right/new one.
2470 if (lines_moved)
2474 dp_right->db_txt_start -= data_moved;
2475 dp_right->db_free -= total_moved;
2476 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2477 (char *)dp_left + dp_left->db_txt_start,
2478 (size_t)data_moved);
2479 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2480 dp_left->db_txt_start += data_moved;
2481 dp_left->db_free += total_moved;
2484 * update indexes in the new block
2486 for (to = line_count_right, from = db_idx + 1;
2487 from < line_count_left; ++from, ++to)
2488 dp_right->db_index[to] = dp->db_index[from] + offset;
2489 line_count_right += lines_moved;
2490 line_count_left -= lines_moved;
2494 * May move the new line into the left (old or new) block.
2496 if (in_left)
2498 dp_left->db_txt_start -= len;
2499 dp_left->db_free -= len + INDEX_SIZE;
2500 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2501 if (mark)
2502 dp_left->db_index[line_count_left] |= DB_MARKED;
2503 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2504 line, (size_t)len);
2505 ++line_count_left;
2508 if (db_idx < 0) /* left block is new */
2510 lnum_left = lnum + 1;
2511 lnum_right = 0;
2513 else /* right block is new */
2515 lnum_left = 0;
2516 if (in_left)
2517 lnum_right = lnum + 2;
2518 else
2519 lnum_right = lnum + 1;
2521 dp_left->db_line_count = line_count_left;
2522 dp_right->db_line_count = line_count_right;
2525 * release the two data blocks
2526 * The new one (hp_new) already has a correct blocknumber.
2527 * The old one (hp, in ml_locked) gets a positive blocknumber if
2528 * we changed it and we are not editing a new file.
2530 if (lines_moved || in_left)
2531 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2532 if (!newfile && db_idx >= 0 && in_left)
2533 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2534 mf_put(mfp, hp_new, TRUE, FALSE);
2537 * flush the old data block
2538 * set ml_locked_lineadd to 0, because the updating of the
2539 * pointer blocks is done below
2541 lineadd = buf->b_ml.ml_locked_lineadd;
2542 buf->b_ml.ml_locked_lineadd = 0;
2543 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2546 * update pointer blocks for the new data block
2548 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2549 --stack_idx)
2551 ip = &(buf->b_ml.ml_stack[stack_idx]);
2552 pb_idx = ip->ip_index;
2553 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2554 return FAIL;
2555 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2556 if (pp->pb_id != PTR_ID)
2558 EMSG(_("E317: pointer block id wrong 3"));
2559 mf_put(mfp, hp, FALSE, FALSE);
2560 return FAIL;
2563 * TODO: If the pointer block is full and we are adding at the end
2564 * try to insert in front of the next block
2566 /* block not full, add one entry */
2567 if (pp->pb_count < pp->pb_count_max)
2569 if (pb_idx + 1 < (int)pp->pb_count)
2570 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2571 &pp->pb_pointer[pb_idx + 1],
2572 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2573 ++pp->pb_count;
2574 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2575 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2576 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2577 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2578 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2579 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2581 if (lnum_left != 0)
2582 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2583 if (lnum_right != 0)
2584 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2586 mf_put(mfp, hp, TRUE, FALSE);
2587 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2589 if (lineadd)
2591 --(buf->b_ml.ml_stack_top);
2592 /* fix line count for rest of blocks in the stack */
2593 ml_lineadd(buf, lineadd);
2594 /* fix stack itself */
2595 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2596 lineadd;
2597 ++(buf->b_ml.ml_stack_top);
2601 * We are finished, break the loop here.
2603 break;
2605 else /* pointer block full */
2608 * split the pointer block
2609 * allocate a new pointer block
2610 * move some of the pointer into the new block
2611 * prepare for updating the parent block
2613 for (;;) /* do this twice when splitting block 1 */
2615 hp_new = ml_new_ptr(mfp);
2616 if (hp_new == NULL) /* TODO: try to fix tree */
2617 return FAIL;
2618 pp_new = (PTR_BL *)(hp_new->bh_data);
2620 if (hp->bh_bnum != 1)
2621 break;
2624 * if block 1 becomes full the tree is given an extra level
2625 * The pointers from block 1 are moved into the new block.
2626 * block 1 is updated to point to the new block
2627 * then continue to split the new block
2629 mch_memmove(pp_new, pp, (size_t)page_size);
2630 pp->pb_count = 1;
2631 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2632 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2633 pp->pb_pointer[0].pe_old_lnum = 1;
2634 pp->pb_pointer[0].pe_page_count = 1;
2635 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2636 hp = hp_new; /* new block is to be split */
2637 pp = pp_new;
2638 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2639 ip->ip_index = 0;
2640 ++stack_idx; /* do block 1 again later */
2643 * move the pointers after the current one to the new block
2644 * If there are none, the new entry will be in the new block.
2646 total_moved = pp->pb_count - pb_idx - 1;
2647 if (total_moved)
2649 mch_memmove(&pp_new->pb_pointer[0],
2650 &pp->pb_pointer[pb_idx + 1],
2651 (size_t)(total_moved) * sizeof(PTR_EN));
2652 pp_new->pb_count = total_moved;
2653 pp->pb_count -= total_moved - 1;
2654 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2655 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2656 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2657 if (lnum_right)
2658 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2660 else
2662 pp_new->pb_count = 1;
2663 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2664 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2665 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2666 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2668 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2669 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2670 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2671 if (lnum_left)
2672 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2673 lnum_left = 0;
2674 lnum_right = 0;
2677 * recompute line counts
2679 line_count_right = 0;
2680 for (i = 0; i < (int)pp_new->pb_count; ++i)
2681 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2682 line_count_left = 0;
2683 for (i = 0; i < (int)pp->pb_count; ++i)
2684 line_count_left += pp->pb_pointer[i].pe_line_count;
2686 bnum_left = hp->bh_bnum;
2687 bnum_right = hp_new->bh_bnum;
2688 page_count_left = 1;
2689 page_count_right = 1;
2690 mf_put(mfp, hp, TRUE, FALSE);
2691 mf_put(mfp, hp_new, TRUE, FALSE);
2696 * Safety check: fallen out of for loop?
2698 if (stack_idx < 0)
2700 EMSG(_("E318: Updated too many blocks?"));
2701 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2705 #ifdef FEAT_BYTEOFF
2706 /* The line was inserted below 'lnum' */
2707 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2708 #endif
2709 #ifdef FEAT_NETBEANS_INTG
2710 if (usingNetbeans)
2712 if (STRLEN(line) > 0)
2713 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2714 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2715 (char_u *)"\n", 1);
2717 #endif
2718 return OK;
2722 * Replace line lnum, with buffering, in current buffer.
2724 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2725 * copied to allocated memory already.
2727 * Check: The caller of this function should probably also call
2728 * changed_lines(), unless update_screen(NOT_VALID) is used.
2730 * return FAIL for failure, OK otherwise
2733 ml_replace(lnum, line, copy)
2734 linenr_T lnum;
2735 char_u *line;
2736 int copy;
2738 if (line == NULL) /* just checking... */
2739 return FAIL;
2741 /* When starting up, we might still need to create the memfile */
2742 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2743 return FAIL;
2745 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2746 return FAIL;
2747 #ifdef FEAT_NETBEANS_INTG
2748 if (usingNetbeans)
2750 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2751 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2753 #endif
2754 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2755 ml_flush_line(curbuf); /* flush it */
2756 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2757 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2758 curbuf->b_ml.ml_line_ptr = line;
2759 curbuf->b_ml.ml_line_lnum = lnum;
2760 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2762 return OK;
2766 * Delete line 'lnum' in the current buffer.
2768 * Check: The caller of this function should probably also call
2769 * deleted_lines() after this.
2771 * return FAIL for failure, OK otherwise
2774 ml_delete(lnum, message)
2775 linenr_T lnum;
2776 int message;
2778 ml_flush_line(curbuf);
2779 return ml_delete_int(curbuf, lnum, message);
2782 static int
2783 ml_delete_int(buf, lnum, message)
2784 buf_T *buf;
2785 linenr_T lnum;
2786 int message;
2788 bhdr_T *hp;
2789 memfile_T *mfp;
2790 DATA_BL *dp;
2791 PTR_BL *pp;
2792 infoptr_T *ip;
2793 int count; /* number of entries in block */
2794 int idx;
2795 int stack_idx;
2796 int text_start;
2797 int line_start;
2798 long line_size;
2799 int i;
2801 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2802 return FAIL;
2804 if (lowest_marked && lowest_marked > lnum)
2805 lowest_marked--;
2808 * If the file becomes empty the last line is replaced by an empty line.
2810 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2812 if (message
2813 #ifdef FEAT_NETBEANS_INTG
2814 && !netbeansSuppressNoLines
2815 #endif
2817 set_keep_msg((char_u *)_(no_lines_msg), 0);
2819 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2820 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2821 buf->b_ml.ml_flags |= ML_EMPTY;
2823 return i;
2827 * find the data block containing the line
2828 * This also fills the stack with the blocks from the root to the data block
2829 * This also releases any locked block.
2831 mfp = buf->b_ml.ml_mfp;
2832 if (mfp == NULL)
2833 return FAIL;
2835 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2836 return FAIL;
2838 dp = (DATA_BL *)(hp->bh_data);
2839 /* compute line count before the delete */
2840 count = (long)(buf->b_ml.ml_locked_high)
2841 - (long)(buf->b_ml.ml_locked_low) + 2;
2842 idx = lnum - buf->b_ml.ml_locked_low;
2844 --buf->b_ml.ml_line_count;
2846 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2847 if (idx == 0) /* first line in block, text at the end */
2848 line_size = dp->db_txt_end - line_start;
2849 else
2850 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2852 #ifdef FEAT_NETBEANS_INTG
2853 if (usingNetbeans)
2854 netbeans_removed(buf, lnum, 0, (long)line_size);
2855 #endif
2858 * special case: If there is only one line in the data block it becomes empty.
2859 * Then we have to remove the entry, pointing to this data block, from the
2860 * pointer block. If this pointer block also becomes empty, we go up another
2861 * block, and so on, up to the root if necessary.
2862 * The line counts in the pointer blocks have already been adjusted by
2863 * ml_find_line().
2865 if (count == 1)
2867 mf_free(mfp, hp); /* free the data block */
2868 buf->b_ml.ml_locked = NULL;
2870 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2872 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2873 ip = &(buf->b_ml.ml_stack[stack_idx]);
2874 idx = ip->ip_index;
2875 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2876 return FAIL;
2877 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2878 if (pp->pb_id != PTR_ID)
2880 EMSG(_("E317: pointer block id wrong 4"));
2881 mf_put(mfp, hp, FALSE, FALSE);
2882 return FAIL;
2884 count = --(pp->pb_count);
2885 if (count == 0) /* the pointer block becomes empty! */
2886 mf_free(mfp, hp);
2887 else
2889 if (count != idx) /* move entries after the deleted one */
2890 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2891 (size_t)(count - idx) * sizeof(PTR_EN));
2892 mf_put(mfp, hp, TRUE, FALSE);
2894 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2895 /* fix line count for rest of blocks in the stack */
2896 if (buf->b_ml.ml_locked_lineadd != 0)
2898 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2899 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2900 buf->b_ml.ml_locked_lineadd;
2902 ++(buf->b_ml.ml_stack_top);
2904 break;
2907 CHECK(stack_idx < 0, _("deleted block 1?"));
2909 else
2912 * delete the text by moving the next lines forwards
2914 text_start = dp->db_txt_start;
2915 mch_memmove((char *)dp + text_start + line_size,
2916 (char *)dp + text_start, (size_t)(line_start - text_start));
2919 * delete the index by moving the next indexes backwards
2920 * Adjust the indexes for the text movement.
2922 for (i = idx; i < count - 1; ++i)
2923 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2925 dp->db_free += line_size + INDEX_SIZE;
2926 dp->db_txt_start += line_size;
2927 --(dp->db_line_count);
2930 * mark the block dirty and make sure it is in the file (for recovery)
2932 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2935 #ifdef FEAT_BYTEOFF
2936 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2937 #endif
2938 return OK;
2942 * set the B_MARKED flag for line 'lnum'
2944 void
2945 ml_setmarked(lnum)
2946 linenr_T lnum;
2948 bhdr_T *hp;
2949 DATA_BL *dp;
2950 /* invalid line number */
2951 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2952 || curbuf->b_ml.ml_mfp == NULL)
2953 return; /* give error message? */
2955 if (lowest_marked == 0 || lowest_marked > lnum)
2956 lowest_marked = lnum;
2959 * find the data block containing the line
2960 * This also fills the stack with the blocks from the root to the data block
2961 * This also releases any locked block.
2963 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2964 return; /* give error message? */
2966 dp = (DATA_BL *)(hp->bh_data);
2967 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2968 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2972 * find the first line with its B_MARKED flag set
2974 linenr_T
2975 ml_firstmarked()
2977 bhdr_T *hp;
2978 DATA_BL *dp;
2979 linenr_T lnum;
2980 int i;
2982 if (curbuf->b_ml.ml_mfp == NULL)
2983 return (linenr_T) 0;
2986 * The search starts with lowest_marked line. This is the last line where
2987 * a mark was found, adjusted by inserting/deleting lines.
2989 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
2992 * Find the data block containing the line.
2993 * This also fills the stack with the blocks from the root to the data
2994 * block This also releases any locked block.
2996 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2997 return (linenr_T)0; /* give error message? */
2999 dp = (DATA_BL *)(hp->bh_data);
3001 for (i = lnum - curbuf->b_ml.ml_locked_low;
3002 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3003 if ((dp->db_index[i]) & DB_MARKED)
3005 (dp->db_index[i]) &= DB_INDEX_MASK;
3006 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3007 lowest_marked = lnum + 1;
3008 return lnum;
3012 return (linenr_T) 0;
3015 #if 0 /* not used */
3017 * return TRUE if line 'lnum' has a mark
3020 ml_has_mark(lnum)
3021 linenr_T lnum;
3023 bhdr_T *hp;
3024 DATA_BL *dp;
3026 if (curbuf->b_ml.ml_mfp == NULL
3027 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3028 return FALSE;
3030 dp = (DATA_BL *)(hp->bh_data);
3031 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3033 #endif
3036 * clear all DB_MARKED flags
3038 void
3039 ml_clearmarked()
3041 bhdr_T *hp;
3042 DATA_BL *dp;
3043 linenr_T lnum;
3044 int i;
3046 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3047 return;
3050 * The search starts with line lowest_marked.
3052 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3055 * Find the data block containing the line.
3056 * This also fills the stack with the blocks from the root to the data
3057 * block and releases any locked block.
3059 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3060 return; /* give error message? */
3062 dp = (DATA_BL *)(hp->bh_data);
3064 for (i = lnum - curbuf->b_ml.ml_locked_low;
3065 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3066 if ((dp->db_index[i]) & DB_MARKED)
3068 (dp->db_index[i]) &= DB_INDEX_MASK;
3069 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3073 lowest_marked = 0;
3074 return;
3078 * flush ml_line if necessary
3080 static void
3081 ml_flush_line(buf)
3082 buf_T *buf;
3084 bhdr_T *hp;
3085 DATA_BL *dp;
3086 linenr_T lnum;
3087 char_u *new_line;
3088 char_u *old_line;
3089 colnr_T new_len;
3090 int old_len;
3091 int extra;
3092 int idx;
3093 int start;
3094 int count;
3095 int i;
3097 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3098 return; /* nothing to do */
3100 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3102 lnum = buf->b_ml.ml_line_lnum;
3103 new_line = buf->b_ml.ml_line_ptr;
3105 hp = ml_find_line(buf, lnum, ML_FIND);
3106 if (hp == NULL)
3107 EMSGN(_("E320: Cannot find line %ld"), lnum);
3108 else
3110 dp = (DATA_BL *)(hp->bh_data);
3111 idx = lnum - buf->b_ml.ml_locked_low;
3112 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3113 old_line = (char_u *)dp + start;
3114 if (idx == 0) /* line is last in block */
3115 old_len = dp->db_txt_end - start;
3116 else /* text of previous line follows */
3117 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3118 new_len = (colnr_T)STRLEN(new_line) + 1;
3119 extra = new_len - old_len; /* negative if lines gets smaller */
3122 * if new line fits in data block, replace directly
3124 if ((int)dp->db_free >= extra)
3126 /* if the length changes and there are following lines */
3127 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3128 if (extra != 0 && idx < count - 1)
3130 /* move text of following lines */
3131 mch_memmove((char *)dp + dp->db_txt_start - extra,
3132 (char *)dp + dp->db_txt_start,
3133 (size_t)(start - dp->db_txt_start));
3135 /* adjust pointers of this and following lines */
3136 for (i = idx + 1; i < count; ++i)
3137 dp->db_index[i] -= extra;
3139 dp->db_index[idx] -= extra;
3141 /* adjust free space */
3142 dp->db_free -= extra;
3143 dp->db_txt_start -= extra;
3145 /* copy new line into the data block */
3146 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3147 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3148 #ifdef FEAT_BYTEOFF
3149 /* The else case is already covered by the insert and delete */
3150 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3151 #endif
3153 else
3156 * Cannot do it in one data block: Delete and append.
3157 * Append first, because ml_delete_int() cannot delete the
3158 * last line in a buffer, which causes trouble for a buffer
3159 * that has only one line.
3160 * Don't forget to copy the mark!
3162 /* How about handling errors??? */
3163 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3164 (dp->db_index[idx] & DB_MARKED));
3165 (void)ml_delete_int(buf, lnum, FALSE);
3168 vim_free(new_line);
3171 buf->b_ml.ml_line_lnum = 0;
3175 * create a new, empty, data block
3177 static bhdr_T *
3178 ml_new_data(mfp, negative, page_count)
3179 memfile_T *mfp;
3180 int negative;
3181 int page_count;
3183 bhdr_T *hp;
3184 DATA_BL *dp;
3186 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3187 return NULL;
3189 dp = (DATA_BL *)(hp->bh_data);
3190 dp->db_id = DATA_ID;
3191 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3192 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3193 dp->db_line_count = 0;
3195 return hp;
3199 * create a new, empty, pointer block
3201 static bhdr_T *
3202 ml_new_ptr(mfp)
3203 memfile_T *mfp;
3205 bhdr_T *hp;
3206 PTR_BL *pp;
3208 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3209 return NULL;
3211 pp = (PTR_BL *)(hp->bh_data);
3212 pp->pb_id = PTR_ID;
3213 pp->pb_count = 0;
3214 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3216 return hp;
3220 * lookup line 'lnum' in a memline
3222 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3223 * if ML_FLUSH only flush a locked block
3224 * if ML_FIND just find the line
3226 * If the block was found it is locked and put in ml_locked.
3227 * The stack is updated to lead to the locked block. The ip_high field in
3228 * the stack is updated to reflect the last line in the block AFTER the
3229 * insert or delete, also if the pointer block has not been updated yet. But
3230 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3232 * return: NULL for failure, pointer to block header otherwise
3234 static bhdr_T *
3235 ml_find_line(buf, lnum, action)
3236 buf_T *buf;
3237 linenr_T lnum;
3238 int action;
3240 DATA_BL *dp;
3241 PTR_BL *pp;
3242 infoptr_T *ip;
3243 bhdr_T *hp;
3244 memfile_T *mfp;
3245 linenr_T t;
3246 blocknr_T bnum, bnum2;
3247 int dirty;
3248 linenr_T low, high;
3249 int top;
3250 int page_count;
3251 int idx;
3253 mfp = buf->b_ml.ml_mfp;
3256 * If there is a locked block check if the wanted line is in it.
3257 * If not, flush and release the locked block.
3258 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3259 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3260 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3262 if (buf->b_ml.ml_locked)
3264 if (ML_SIMPLE(action)
3265 && buf->b_ml.ml_locked_low <= lnum
3266 && buf->b_ml.ml_locked_high >= lnum
3267 && !mf_dont_release)
3269 /* remember to update pointer blocks and stack later */
3270 if (action == ML_INSERT)
3272 ++(buf->b_ml.ml_locked_lineadd);
3273 ++(buf->b_ml.ml_locked_high);
3275 else if (action == ML_DELETE)
3277 --(buf->b_ml.ml_locked_lineadd);
3278 --(buf->b_ml.ml_locked_high);
3280 return (buf->b_ml.ml_locked);
3283 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3284 buf->b_ml.ml_flags & ML_LOCKED_POS);
3285 buf->b_ml.ml_locked = NULL;
3288 * If lines have been added or deleted in the locked block, need to
3289 * update the line count in pointer blocks.
3291 if (buf->b_ml.ml_locked_lineadd != 0)
3292 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3295 if (action == ML_FLUSH) /* nothing else to do */
3296 return NULL;
3298 bnum = 1; /* start at the root of the tree */
3299 page_count = 1;
3300 low = 1;
3301 high = buf->b_ml.ml_line_count;
3303 if (action == ML_FIND) /* first try stack entries */
3305 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3307 ip = &(buf->b_ml.ml_stack[top]);
3308 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3310 bnum = ip->ip_bnum;
3311 low = ip->ip_low;
3312 high = ip->ip_high;
3313 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3314 break;
3317 if (top < 0)
3318 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3320 else /* ML_DELETE or ML_INSERT */
3321 buf->b_ml.ml_stack_top = 0; /* start at the root */
3324 * search downwards in the tree until a data block is found
3326 for (;;)
3328 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3329 goto error_noblock;
3332 * update high for insert/delete
3334 if (action == ML_INSERT)
3335 ++high;
3336 else if (action == ML_DELETE)
3337 --high;
3339 dp = (DATA_BL *)(hp->bh_data);
3340 if (dp->db_id == DATA_ID) /* data block */
3342 buf->b_ml.ml_locked = hp;
3343 buf->b_ml.ml_locked_low = low;
3344 buf->b_ml.ml_locked_high = high;
3345 buf->b_ml.ml_locked_lineadd = 0;
3346 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3347 return hp;
3350 pp = (PTR_BL *)(dp); /* must be pointer block */
3351 if (pp->pb_id != PTR_ID)
3353 EMSG(_("E317: pointer block id wrong"));
3354 goto error_block;
3357 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3358 goto error_block;
3359 ip = &(buf->b_ml.ml_stack[top]);
3360 ip->ip_bnum = bnum;
3361 ip->ip_low = low;
3362 ip->ip_high = high;
3363 ip->ip_index = -1; /* index not known yet */
3365 dirty = FALSE;
3366 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3368 t = pp->pb_pointer[idx].pe_line_count;
3369 CHECK(t == 0, _("pe_line_count is zero"));
3370 if ((low += t) > lnum)
3372 ip->ip_index = idx;
3373 bnum = pp->pb_pointer[idx].pe_bnum;
3374 page_count = pp->pb_pointer[idx].pe_page_count;
3375 high = low - 1;
3376 low -= t;
3379 * a negative block number may have been changed
3381 if (bnum < 0)
3383 bnum2 = mf_trans_del(mfp, bnum);
3384 if (bnum != bnum2)
3386 bnum = bnum2;
3387 pp->pb_pointer[idx].pe_bnum = bnum;
3388 dirty = TRUE;
3392 break;
3395 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3397 if (lnum > buf->b_ml.ml_line_count)
3398 EMSGN(_("E322: line number out of range: %ld past the end"),
3399 lnum - buf->b_ml.ml_line_count);
3401 else
3402 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3403 goto error_block;
3405 if (action == ML_DELETE)
3407 pp->pb_pointer[idx].pe_line_count--;
3408 dirty = TRUE;
3410 else if (action == ML_INSERT)
3412 pp->pb_pointer[idx].pe_line_count++;
3413 dirty = TRUE;
3415 mf_put(mfp, hp, dirty, FALSE);
3418 error_block:
3419 mf_put(mfp, hp, FALSE, FALSE);
3420 error_noblock:
3422 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3423 * the incremented/decremented line counts, because there won't be a line
3424 * inserted/deleted after all.
3426 if (action == ML_DELETE)
3427 ml_lineadd(buf, 1);
3428 else if (action == ML_INSERT)
3429 ml_lineadd(buf, -1);
3430 buf->b_ml.ml_stack_top = 0;
3431 return NULL;
3435 * add an entry to the info pointer stack
3437 * return -1 for failure, number of the new entry otherwise
3439 static int
3440 ml_add_stack(buf)
3441 buf_T *buf;
3443 int top;
3444 infoptr_T *newstack;
3446 top = buf->b_ml.ml_stack_top;
3448 /* may have to increase the stack size */
3449 if (top == buf->b_ml.ml_stack_size)
3451 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3453 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3454 (buf->b_ml.ml_stack_size + STACK_INCR));
3455 if (newstack == NULL)
3456 return -1;
3457 mch_memmove(newstack, buf->b_ml.ml_stack,
3458 (size_t)top * sizeof(infoptr_T));
3459 vim_free(buf->b_ml.ml_stack);
3460 buf->b_ml.ml_stack = newstack;
3461 buf->b_ml.ml_stack_size += STACK_INCR;
3464 buf->b_ml.ml_stack_top++;
3465 return top;
3469 * Update the pointer blocks on the stack for inserted/deleted lines.
3470 * The stack itself is also updated.
3472 * When a insert/delete line action fails, the line is not inserted/deleted,
3473 * but the pointer blocks have already been updated. That is fixed here by
3474 * walking through the stack.
3476 * Count is the number of lines added, negative if lines have been deleted.
3478 static void
3479 ml_lineadd(buf, count)
3480 buf_T *buf;
3481 int count;
3483 int idx;
3484 infoptr_T *ip;
3485 PTR_BL *pp;
3486 memfile_T *mfp = buf->b_ml.ml_mfp;
3487 bhdr_T *hp;
3489 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3491 ip = &(buf->b_ml.ml_stack[idx]);
3492 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3493 break;
3494 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3495 if (pp->pb_id != PTR_ID)
3497 mf_put(mfp, hp, FALSE, FALSE);
3498 EMSG(_("E317: pointer block id wrong 2"));
3499 break;
3501 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3502 ip->ip_high += count;
3503 mf_put(mfp, hp, TRUE, FALSE);
3507 #ifdef HAVE_READLINK
3508 static int resolve_symlink __ARGS((char_u *fname, char_u *buf));
3511 * Resolve a symlink in the last component of a file name.
3512 * Note that f_resolve() does it for every part of the path, we don't do that
3513 * here.
3514 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3515 * Otherwise returns FAIL.
3517 static int
3518 resolve_symlink(fname, buf)
3519 char_u *fname;
3520 char_u *buf;
3522 char_u tmp[MAXPATHL];
3523 int ret;
3524 int depth = 0;
3526 if (fname == NULL)
3527 return FAIL;
3529 /* Put the result so far in tmp[], starting with the original name. */
3530 vim_strncpy(tmp, fname, MAXPATHL - 1);
3532 for (;;)
3534 /* Limit symlink depth to 100, catch recursive loops. */
3535 if (++depth == 100)
3537 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3538 return FAIL;
3541 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3542 if (ret <= 0)
3544 if (errno == EINVAL || errno == ENOENT)
3546 /* Found non-symlink or not existing file, stop here.
3547 * When at the first level use the unmodified name, skip the
3548 * call to vim_FullName(). */
3549 if (depth == 1)
3550 return FAIL;
3552 /* Use the resolved name in tmp[]. */
3553 break;
3556 /* There must be some error reading links, use original name. */
3557 return FAIL;
3559 buf[ret] = NUL;
3562 * Check whether the symlink is relative or absolute.
3563 * If it's relative, build a new path based on the directory
3564 * portion of the filename (if any) and the path the symlink
3565 * points to.
3567 if (mch_isFullName(buf))
3568 STRCPY(tmp, buf);
3569 else
3571 char_u *tail;
3573 tail = gettail(tmp);
3574 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3575 return FAIL;
3576 STRCPY(tail, buf);
3581 * Try to resolve the full name of the file so that the swapfile name will
3582 * be consistent even when opening a relative symlink from different
3583 * working directories.
3585 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3587 #endif
3590 * Make swap file name out of the file name and a directory name.
3591 * Returns pointer to allocated memory or NULL.
3593 char_u *
3594 makeswapname(fname, ffname, buf, dir_name)
3595 char_u *fname;
3596 char_u *ffname UNUSED;
3597 buf_T *buf;
3598 char_u *dir_name;
3600 char_u *r, *s;
3601 #ifdef HAVE_READLINK
3602 char_u fname_buf[MAXPATHL];
3603 char_u *fname_res;
3604 #endif
3606 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3607 s = dir_name + STRLEN(dir_name);
3608 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3609 { /* Ends with '//', Use Full path */
3610 r = NULL;
3611 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3613 r = modname(s, (char_u *)".swp", FALSE);
3614 vim_free(s);
3616 return r;
3618 #endif
3620 #ifdef HAVE_READLINK
3621 /* Expand symlink in the file name, so that we put the swap file with the
3622 * actual file instead of with the symlink. */
3623 if (resolve_symlink(fname, fname_buf) == OK)
3624 fname_res = fname_buf;
3625 else
3626 fname_res = fname;
3627 #endif
3629 r = buf_modname(
3630 #ifdef SHORT_FNAME
3631 TRUE,
3632 #else
3633 (buf->b_p_sn || buf->b_shortname),
3634 #endif
3635 #ifdef RISCOS
3636 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3637 ffname,
3638 #else
3639 # ifdef HAVE_READLINK
3640 fname_res,
3641 # else
3642 fname,
3643 # endif
3644 #endif
3645 (char_u *)
3646 #if defined(VMS) || defined(RISCOS)
3647 "_swp",
3648 #else
3649 ".swp",
3650 #endif
3651 #ifdef SHORT_FNAME /* always 8.3 file name */
3652 FALSE
3653 #else
3654 /* Prepend a '.' to the swap file name for the current directory. */
3655 dir_name[0] == '.' && dir_name[1] == NUL
3656 #endif
3658 if (r == NULL) /* out of memory */
3659 return NULL;
3661 s = get_file_in_dir(r, dir_name);
3662 vim_free(r);
3663 return s;
3667 * Get file name to use for swap file or backup file.
3668 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3669 * option "dname".
3670 * - If "dname" is ".", return "fname" (swap file in dir of file).
3671 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3672 * relative to dir of file).
3673 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3674 * dir).
3676 * The return value is an allocated string and can be NULL.
3678 char_u *
3679 get_file_in_dir(fname, dname)
3680 char_u *fname;
3681 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3683 char_u *t;
3684 char_u *tail;
3685 char_u *retval;
3686 int save_char;
3688 tail = gettail(fname);
3690 if (dname[0] == '.' && dname[1] == NUL)
3691 retval = vim_strsave(fname);
3692 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3694 if (tail == fname) /* no path before file name */
3695 retval = concat_fnames(dname + 2, tail, TRUE);
3696 else
3698 save_char = *tail;
3699 *tail = NUL;
3700 t = concat_fnames(fname, dname + 2, TRUE);
3701 *tail = save_char;
3702 if (t == NULL) /* out of memory */
3703 retval = NULL;
3704 else
3706 retval = concat_fnames(t, tail, TRUE);
3707 vim_free(t);
3711 else
3712 retval = concat_fnames(dname, tail, TRUE);
3714 return retval;
3717 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3720 * Print the ATTENTION message: info about an existing swap file.
3722 static void
3723 attention_message(buf, fname)
3724 buf_T *buf; /* buffer being edited */
3725 char_u *fname; /* swap file name */
3727 struct stat st;
3728 time_t x, sx;
3729 char *p;
3731 ++no_wait_return;
3732 (void)EMSG(_("E325: ATTENTION"));
3733 MSG_PUTS(_("\nFound a swap file by the name \""));
3734 msg_home_replace(fname);
3735 MSG_PUTS("\"\n");
3736 sx = swapfile_info(fname);
3737 MSG_PUTS(_("While opening file \""));
3738 msg_outtrans(buf->b_fname);
3739 MSG_PUTS("\"\n");
3740 if (mch_stat((char *)buf->b_fname, &st) != -1)
3742 MSG_PUTS(_(" dated: "));
3743 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3744 p = ctime(&x); /* includes '\n' */
3745 if (p == NULL)
3746 MSG_PUTS("(invalid)\n");
3747 else
3748 MSG_PUTS(p);
3749 if (sx != 0 && x > sx)
3750 MSG_PUTS(_(" NEWER than swap file!\n"));
3752 /* Some of these messages are long to allow translation to
3753 * other languages. */
3754 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"));
3755 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3756 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3757 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3758 msg_outtrans(buf->b_fname);
3759 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3760 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3761 msg_outtrans(fname);
3762 MSG_PUTS(_("\"\n to avoid this message.\n"));
3763 cmdline_row = msg_row;
3764 --no_wait_return;
3767 #ifdef FEAT_AUTOCMD
3768 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3771 * Trigger the SwapExists autocommands.
3772 * Returns a value for equivalent to do_dialog() (see below):
3773 * 0: still need to ask for a choice
3774 * 1: open read-only
3775 * 2: edit anyway
3776 * 3: recover
3777 * 4: delete it
3778 * 5: quit
3779 * 6: abort
3781 static int
3782 do_swapexists(buf, fname)
3783 buf_T *buf;
3784 char_u *fname;
3786 set_vim_var_string(VV_SWAPNAME, fname, -1);
3787 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3789 /* Trigger SwapExists autocommands with <afile> set to the file being
3790 * edited. Disallow changing directory here. */
3791 ++allbuf_lock;
3792 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3793 --allbuf_lock;
3795 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3797 switch (*get_vim_var_str(VV_SWAPCHOICE))
3799 case 'o': return 1;
3800 case 'e': return 2;
3801 case 'r': return 3;
3802 case 'd': return 4;
3803 case 'q': return 5;
3804 case 'a': return 6;
3807 return 0;
3809 #endif
3812 * Find out what name to use for the swap file for buffer 'buf'.
3814 * Several names are tried to find one that does not exist
3815 * Returns the name in allocated memory or NULL.
3817 * Note: If BASENAMELEN is not correct, you will get error messages for
3818 * not being able to open the swapfile
3819 * Note: May trigger SwapExists autocmd, pointers may change!
3821 static char_u *
3822 findswapname(buf, dirp, old_fname)
3823 buf_T *buf;
3824 char_u **dirp; /* pointer to list of directories */
3825 char_u *old_fname; /* don't give warning for this file name */
3827 char_u *fname;
3828 int n;
3829 char_u *dir_name;
3830 #ifdef AMIGA
3831 BPTR fh;
3832 #endif
3833 #ifndef SHORT_FNAME
3834 int r;
3835 #endif
3837 #if !defined(SHORT_FNAME) \
3838 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3839 # define CREATE_DUMMY_FILE
3840 FILE *dummyfd = NULL;
3843 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3844 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3845 * create will be exactly the same file. To avoid this problem we temporarily
3846 * create "test.doc".
3847 * Don't do this when the check below for a 8.3 file name is used.
3849 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3850 && mch_getperm(buf->b_fname) < 0)
3851 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3852 #endif
3855 * Isolate a directory name from *dirp and put it in dir_name.
3856 * First allocate some memory to put the directory name in.
3858 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3859 if (dir_name != NULL)
3860 (void)copy_option_part(dirp, dir_name, 31000, ",");
3863 * we try different names until we find one that does not exist yet
3865 if (dir_name == NULL) /* out of memory */
3866 fname = NULL;
3867 else
3868 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3870 for (;;)
3872 if (fname == NULL) /* must be out of memory */
3873 break;
3874 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3876 vim_free(fname);
3877 fname = NULL;
3878 break;
3880 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3882 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3883 * file names. If this is the first try and the swap file name does not fit in
3884 * 8.3, detect if this is the case, set shortname and try again.
3886 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3887 && !(buf->b_p_sn || buf->b_shortname))
3889 char_u *tail;
3890 char_u *fname2;
3891 struct stat s1, s2;
3892 int f1, f2;
3893 int created1 = FALSE, created2 = FALSE;
3894 int same = FALSE;
3897 * Check if swapfile name does not fit in 8.3:
3898 * It either contains two dots, is longer than 8 chars, or starts
3899 * with a dot.
3901 tail = gettail(buf->b_fname);
3902 if ( vim_strchr(tail, '.') != NULL
3903 || STRLEN(tail) > (size_t)8
3904 || *gettail(fname) == '.')
3906 fname2 = alloc(n + 2);
3907 if (fname2 != NULL)
3909 STRCPY(fname2, fname);
3910 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3911 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3912 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3914 if (vim_strchr(tail, '.') != NULL)
3915 fname2[n - 1] = 'x';
3916 else if (*gettail(fname) == '.')
3918 fname2[n] = 'x';
3919 fname2[n + 1] = NUL;
3921 else
3922 fname2[n - 5] += 1;
3924 * may need to create the files to be able to use mch_stat()
3926 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3927 if (f1 < 0)
3929 f1 = mch_open_rw((char *)fname,
3930 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3931 #if defined(OS2)
3932 if (f1 < 0 && errno == ENOENT)
3933 same = TRUE;
3934 #endif
3935 created1 = TRUE;
3937 if (f1 >= 0)
3939 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3940 if (f2 < 0)
3942 f2 = mch_open_rw((char *)fname2,
3943 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3944 created2 = TRUE;
3946 if (f2 >= 0)
3949 * Both files exist now. If mch_stat() returns the
3950 * same device and inode they are the same file.
3952 if (mch_fstat(f1, &s1) != -1
3953 && mch_fstat(f2, &s2) != -1
3954 && s1.st_dev == s2.st_dev
3955 && s1.st_ino == s2.st_ino)
3956 same = TRUE;
3957 close(f2);
3958 if (created2)
3959 mch_remove(fname2);
3961 close(f1);
3962 if (created1)
3963 mch_remove(fname);
3965 vim_free(fname2);
3966 if (same)
3968 buf->b_shortname = TRUE;
3969 vim_free(fname);
3970 fname = makeswapname(buf->b_fname, buf->b_ffname,
3971 buf, dir_name);
3972 continue; /* try again with b_shortname set */
3977 #endif
3979 * check if the swapfile already exists
3981 if (mch_getperm(fname) < 0) /* it does not exist */
3983 #ifdef HAVE_LSTAT
3984 struct stat sb;
3987 * Extra security check: When a swap file is a symbolic link, this
3988 * is most likely a symlink attack.
3990 if (mch_lstat((char *)fname, &sb) < 0)
3991 #else
3992 # ifdef AMIGA
3993 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
3995 * on the Amiga mch_getperm() will return -1 when the file exists
3996 * but is being used by another program. This happens if you edit
3997 * a file twice.
3999 if (fh != (BPTR)NULL) /* can open file, OK */
4001 Close(fh);
4002 mch_remove(fname);
4003 break;
4005 if (IoErr() != ERROR_OBJECT_IN_USE
4006 && IoErr() != ERROR_OBJECT_EXISTS)
4007 # endif
4008 #endif
4009 break;
4013 * A file name equal to old_fname is OK to use.
4015 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4016 break;
4019 * get here when file already exists
4021 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4023 #ifndef SHORT_FNAME
4025 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4026 * and file.doc are the same file. To guess if this problem is
4027 * present try if file.doc.swx exists. If it does, we set
4028 * buf->b_shortname and try file_doc.swp (dots replaced by
4029 * underscores for this file), and try again. If it doesn't we
4030 * assume that "file.doc.swp" already exists.
4032 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4034 fname[n - 1] = 'x';
4035 r = mch_getperm(fname); /* try "file.swx" */
4036 fname[n - 1] = 'p';
4037 if (r >= 0) /* "file.swx" seems to exist */
4039 buf->b_shortname = TRUE;
4040 vim_free(fname);
4041 fname = makeswapname(buf->b_fname, buf->b_ffname,
4042 buf, dir_name);
4043 continue; /* try again with '.' replaced with '_' */
4046 #endif
4048 * If we get here the ".swp" file really exists.
4049 * Give an error message, unless recovering, no file name, we are
4050 * viewing a help file or when the path of the file is different
4051 * (happens when all .swp files are in one directory).
4053 if (!recoverymode && buf->b_fname != NULL
4054 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4056 int fd;
4057 struct block0 b0;
4058 int differ = FALSE;
4061 * Try to read block 0 from the swap file to get the original
4062 * file name (and inode number).
4064 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4065 if (fd >= 0)
4067 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4070 * If the swapfile has the same directory as the
4071 * buffer don't compare the directory names, they can
4072 * have a different mountpoint.
4074 if (b0.b0_flags & B0_SAME_DIR)
4076 if (fnamecmp(gettail(buf->b_ffname),
4077 gettail(b0.b0_fname)) != 0
4078 || !same_directory(fname, buf->b_ffname))
4080 #ifdef CHECK_INODE
4081 /* Symlinks may point to the same file even
4082 * when the name differs, need to check the
4083 * inode too. */
4084 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4085 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4086 char_to_long(b0.b0_ino)))
4087 #endif
4088 differ = TRUE;
4091 else
4094 * The name in the swap file may be
4095 * "~user/path/file". Expand it first.
4097 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4098 #ifdef CHECK_INODE
4099 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4100 char_to_long(b0.b0_ino)))
4101 differ = TRUE;
4102 #else
4103 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4104 differ = TRUE;
4105 #endif
4108 close(fd);
4110 #ifdef RISCOS
4111 else
4112 /* Can't open swap file, though it does exist.
4113 * Assume that the user is editing two files with
4114 * the same name in different directories. No error.
4116 differ = TRUE;
4117 #endif
4119 /* give the ATTENTION message when there is an old swap file
4120 * for the current file, and the buffer was not recovered. */
4121 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4122 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4124 #if defined(HAS_SWAP_EXISTS_ACTION)
4125 int choice = 0;
4126 #endif
4127 #ifdef CREATE_DUMMY_FILE
4128 int did_use_dummy = FALSE;
4130 /* Avoid getting a warning for the file being created
4131 * outside of Vim, it was created at the start of this
4132 * function. Delete the file now, because Vim might exit
4133 * here if the window is closed. */
4134 if (dummyfd != NULL)
4136 fclose(dummyfd);
4137 dummyfd = NULL;
4138 mch_remove(buf->b_fname);
4139 did_use_dummy = TRUE;
4141 #endif
4143 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4144 process_still_running = FALSE;
4145 #endif
4146 #ifdef FEAT_AUTOCMD
4148 * If there is an SwapExists autocommand and we can handle
4149 * the response, trigger it. It may return 0 to ask the
4150 * user anyway.
4152 if (swap_exists_action != SEA_NONE
4153 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4154 choice = do_swapexists(buf, fname);
4156 if (choice == 0)
4157 #endif
4159 #ifdef FEAT_GUI
4160 /* If we are supposed to start the GUI but it wasn't
4161 * completely started yet, start it now. This makes
4162 * the messages displayed in the Vim window when
4163 * loading a session from the .gvimrc file. */
4164 if (gui.starting && !gui.in_use)
4165 gui_start();
4166 #endif
4167 /* Show info about the existing swap file. */
4168 attention_message(buf, fname);
4170 /* We don't want a 'q' typed at the more-prompt
4171 * interrupt loading a file. */
4172 got_int = FALSE;
4175 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4176 if (swap_exists_action != SEA_NONE && choice == 0)
4178 char_u *name;
4180 name = alloc((unsigned)(STRLEN(fname)
4181 + STRLEN(_("Swap file \""))
4182 + STRLEN(_("\" already exists!")) + 5));
4183 if (name != NULL)
4185 STRCPY(name, _("Swap file \""));
4186 home_replace(NULL, fname, name + STRLEN(name),
4187 1000, TRUE);
4188 STRCAT(name, _("\" already exists!"));
4190 choice = do_dialog(VIM_WARNING,
4191 (char_u *)_("VIM - ATTENTION"),
4192 name == NULL
4193 ? (char_u *)_("Swap file already exists!")
4194 : name,
4195 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4196 process_still_running
4197 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4198 # endif
4199 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4201 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4202 if (process_still_running && choice >= 4)
4203 choice++; /* Skip missing "Delete it" button */
4204 # endif
4205 vim_free(name);
4207 /* pretend screen didn't scroll, need redraw anyway */
4208 msg_scrolled = 0;
4209 redraw_all_later(NOT_VALID);
4211 #endif
4213 #if defined(HAS_SWAP_EXISTS_ACTION)
4214 if (choice > 0)
4216 switch (choice)
4218 case 1:
4219 buf->b_p_ro = TRUE;
4220 break;
4221 case 2:
4222 break;
4223 case 3:
4224 swap_exists_action = SEA_RECOVER;
4225 break;
4226 case 4:
4227 mch_remove(fname);
4228 break;
4229 case 5:
4230 swap_exists_action = SEA_QUIT;
4231 break;
4232 case 6:
4233 swap_exists_action = SEA_QUIT;
4234 got_int = TRUE;
4235 break;
4238 /* If the file was deleted this fname can be used. */
4239 if (mch_getperm(fname) < 0)
4240 break;
4242 else
4243 #endif
4245 MSG_PUTS("\n");
4246 if (msg_silent == 0)
4247 /* call wait_return() later */
4248 need_wait_return = TRUE;
4251 #ifdef CREATE_DUMMY_FILE
4252 /* Going to try another name, need the dummy file again. */
4253 if (did_use_dummy)
4254 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4255 #endif
4261 * Change the ".swp" extension to find another file that can be used.
4262 * First decrement the last char: ".swo", ".swn", etc.
4263 * If that still isn't enough decrement the last but one char: ".svz"
4264 * Can happen when editing many "No Name" buffers.
4266 if (fname[n - 1] == 'a') /* ".s?a" */
4268 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4270 EMSG(_("E326: Too many swap files found"));
4271 vim_free(fname);
4272 fname = NULL;
4273 break;
4275 --fname[n - 2]; /* ".svz", ".suz", etc. */
4276 fname[n - 1] = 'z' + 1;
4278 --fname[n - 1]; /* ".swo", ".swn", etc. */
4281 vim_free(dir_name);
4282 #ifdef CREATE_DUMMY_FILE
4283 if (dummyfd != NULL) /* file has been created temporarily */
4285 fclose(dummyfd);
4286 mch_remove(buf->b_fname);
4288 #endif
4289 return fname;
4292 static int
4293 b0_magic_wrong(b0p)
4294 ZERO_BL *b0p;
4296 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4297 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4298 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4299 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4302 #ifdef CHECK_INODE
4304 * Compare current file name with file name from swap file.
4305 * Try to use inode numbers when possible.
4306 * Return non-zero when files are different.
4308 * When comparing file names a few things have to be taken into consideration:
4309 * - When working over a network the full path of a file depends on the host.
4310 * We check the inode number if possible. It is not 100% reliable though,
4311 * because the device number cannot be used over a network.
4312 * - When a file does not exist yet (editing a new file) there is no inode
4313 * number.
4314 * - The file name in a swap file may not be valid on the current host. The
4315 * "~user" form is used whenever possible to avoid this.
4317 * This is getting complicated, let's make a table:
4319 * ino_c ino_s fname_c fname_s differ =
4321 * both files exist -> compare inode numbers:
4322 * != 0 != 0 X X ino_c != ino_s
4324 * inode number(s) unknown, file names available -> compare file names
4325 * == 0 X OK OK fname_c != fname_s
4326 * X == 0 OK OK fname_c != fname_s
4328 * current file doesn't exist, file for swap file exist, file name(s) not
4329 * available -> probably different
4330 * == 0 != 0 FAIL X TRUE
4331 * == 0 != 0 X FAIL TRUE
4333 * current file exists, inode for swap unknown, file name(s) not
4334 * available -> probably different
4335 * != 0 == 0 FAIL X TRUE
4336 * != 0 == 0 X FAIL TRUE
4338 * current file doesn't exist, inode for swap unknown, one file name not
4339 * available -> probably different
4340 * == 0 == 0 FAIL OK TRUE
4341 * == 0 == 0 OK FAIL TRUE
4343 * current file doesn't exist, inode for swap unknown, both file names not
4344 * available -> probably same file
4345 * == 0 == 0 FAIL FAIL FALSE
4347 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4348 * can't be changed without making the block 0 incompatible with 32 bit
4349 * versions.
4352 static int
4353 fnamecmp_ino(fname_c, fname_s, ino_block0)
4354 char_u *fname_c; /* current file name */
4355 char_u *fname_s; /* file name from swap file */
4356 long ino_block0;
4358 struct stat st;
4359 ino_t ino_c = 0; /* ino of current file */
4360 ino_t ino_s; /* ino of file from swap file */
4361 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4362 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4363 int retval_c; /* flag: buf_c valid */
4364 int retval_s; /* flag: buf_s valid */
4366 if (mch_stat((char *)fname_c, &st) == 0)
4367 ino_c = (ino_t)st.st_ino;
4370 * First we try to get the inode from the file name, because the inode in
4371 * the swap file may be outdated. If that fails (e.g. this path is not
4372 * valid on this machine), use the inode from block 0.
4374 if (mch_stat((char *)fname_s, &st) == 0)
4375 ino_s = (ino_t)st.st_ino;
4376 else
4377 ino_s = (ino_t)ino_block0;
4379 if (ino_c && ino_s)
4380 return (ino_c != ino_s);
4383 * One of the inode numbers is unknown, try a forced vim_FullName() and
4384 * compare the file names.
4386 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4387 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4388 if (retval_c == OK && retval_s == OK)
4389 return (STRCMP(buf_c, buf_s) != 0);
4392 * Can't compare inodes or file names, guess that the files are different,
4393 * unless both appear not to exist at all.
4395 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4396 return FALSE;
4397 return TRUE;
4399 #endif /* CHECK_INODE */
4402 * Move a long integer into a four byte character array.
4403 * Used for machine independency in block zero.
4405 static void
4406 long_to_char(n, s)
4407 long n;
4408 char_u *s;
4410 s[0] = (char_u)(n & 0xff);
4411 n = (unsigned)n >> 8;
4412 s[1] = (char_u)(n & 0xff);
4413 n = (unsigned)n >> 8;
4414 s[2] = (char_u)(n & 0xff);
4415 n = (unsigned)n >> 8;
4416 s[3] = (char_u)(n & 0xff);
4419 static long
4420 char_to_long(s)
4421 char_u *s;
4423 long retval;
4425 retval = s[3];
4426 retval <<= 8;
4427 retval |= s[2];
4428 retval <<= 8;
4429 retval |= s[1];
4430 retval <<= 8;
4431 retval |= s[0];
4433 return retval;
4437 * Set the flags in the first block of the swap file:
4438 * - file is modified or not: buf->b_changed
4439 * - 'fileformat'
4440 * - 'fileencoding'
4442 void
4443 ml_setflags(buf)
4444 buf_T *buf;
4446 bhdr_T *hp;
4447 ZERO_BL *b0p;
4449 if (!buf->b_ml.ml_mfp)
4450 return;
4451 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4453 if (hp->bh_bnum == 0)
4455 b0p = (ZERO_BL *)(hp->bh_data);
4456 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4457 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4458 | (get_fileformat(buf) + 1);
4459 #ifdef FEAT_MBYTE
4460 add_b0_fenc(b0p, buf);
4461 #endif
4462 hp->bh_flags |= BH_DIRTY;
4463 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4464 break;
4469 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4471 #define MLCS_MAXL 800 /* max no of lines in chunk */
4472 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4475 * Keep information for finding byte offset of a line, updtytpe may be one of:
4476 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4477 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4478 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4479 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4481 static void
4482 ml_updatechunk(buf, line, len, updtype)
4483 buf_T *buf;
4484 linenr_T line;
4485 long len;
4486 int updtype;
4488 static buf_T *ml_upd_lastbuf = NULL;
4489 static linenr_T ml_upd_lastline;
4490 static linenr_T ml_upd_lastcurline;
4491 static int ml_upd_lastcurix;
4493 linenr_T curline = ml_upd_lastcurline;
4494 int curix = ml_upd_lastcurix;
4495 long size;
4496 chunksize_T *curchnk;
4497 int rest;
4498 bhdr_T *hp;
4499 DATA_BL *dp;
4501 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4502 return;
4503 if (buf->b_ml.ml_chunksize == NULL)
4505 buf->b_ml.ml_chunksize = (chunksize_T *)
4506 alloc((unsigned)sizeof(chunksize_T) * 100);
4507 if (buf->b_ml.ml_chunksize == NULL)
4509 buf->b_ml.ml_usedchunks = -1;
4510 return;
4512 buf->b_ml.ml_numchunks = 100;
4513 buf->b_ml.ml_usedchunks = 1;
4514 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4515 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4518 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4521 * First line in empty buffer from ml_flush_line() -- reset
4523 buf->b_ml.ml_usedchunks = 1;
4524 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4525 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4526 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4527 return;
4531 * Find chunk that our line belongs to, curline will be at start of the
4532 * chunk.
4534 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4535 || updtype != ML_CHNK_ADDLINE)
4537 for (curline = 1, curix = 0;
4538 curix < buf->b_ml.ml_usedchunks - 1
4539 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4540 curix++)
4542 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4545 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4546 && curix < buf->b_ml.ml_usedchunks - 1)
4548 /* Adjust cached curix & curline */
4549 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4550 curix++;
4552 curchnk = buf->b_ml.ml_chunksize + curix;
4554 if (updtype == ML_CHNK_DELLINE)
4555 len = -len;
4556 curchnk->mlcs_totalsize += len;
4557 if (updtype == ML_CHNK_ADDLINE)
4559 curchnk->mlcs_numlines++;
4561 /* May resize here so we don't have to do it in both cases below */
4562 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4564 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4565 buf->b_ml.ml_chunksize = (chunksize_T *)
4566 vim_realloc(buf->b_ml.ml_chunksize,
4567 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4568 if (buf->b_ml.ml_chunksize == NULL)
4570 /* Hmmmm, Give up on offset for this buffer */
4571 buf->b_ml.ml_usedchunks = -1;
4572 return;
4576 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4578 int count; /* number of entries in block */
4579 int idx;
4580 int text_end;
4581 int linecnt;
4583 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4584 buf->b_ml.ml_chunksize + curix,
4585 (buf->b_ml.ml_usedchunks - curix) *
4586 sizeof(chunksize_T));
4587 /* Compute length of first half of lines in the split chunk */
4588 size = 0;
4589 linecnt = 0;
4590 while (curline < buf->b_ml.ml_line_count
4591 && linecnt < MLCS_MINL)
4593 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4595 buf->b_ml.ml_usedchunks = -1;
4596 return;
4598 dp = (DATA_BL *)(hp->bh_data);
4599 count = (long)(buf->b_ml.ml_locked_high) -
4600 (long)(buf->b_ml.ml_locked_low) + 1;
4601 idx = curline - buf->b_ml.ml_locked_low;
4602 curline = buf->b_ml.ml_locked_high + 1;
4603 if (idx == 0)/* first line in block, text at the end */
4604 text_end = dp->db_txt_end;
4605 else
4606 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4607 /* Compute index of last line to use in this MEMLINE */
4608 rest = count - idx;
4609 if (linecnt + rest > MLCS_MINL)
4611 idx += MLCS_MINL - linecnt - 1;
4612 linecnt = MLCS_MINL;
4614 else
4616 idx = count - 1;
4617 linecnt += rest;
4619 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4621 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4622 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4623 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4624 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4625 buf->b_ml.ml_usedchunks++;
4626 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4627 return;
4629 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4630 && curix == buf->b_ml.ml_usedchunks - 1
4631 && buf->b_ml.ml_line_count - line <= 1)
4634 * We are in the last chunk and it is cheap to crate a new one
4635 * after this. Do it now to avoid the loop above later on
4637 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4638 buf->b_ml.ml_usedchunks++;
4639 if (line == buf->b_ml.ml_line_count)
4641 curchnk->mlcs_numlines = 0;
4642 curchnk->mlcs_totalsize = 0;
4644 else
4647 * Line is just prior to last, move count for last
4648 * This is the common case when loading a new file
4650 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4651 if (hp == NULL)
4653 buf->b_ml.ml_usedchunks = -1;
4654 return;
4656 dp = (DATA_BL *)(hp->bh_data);
4657 if (dp->db_line_count == 1)
4658 rest = dp->db_txt_end - dp->db_txt_start;
4659 else
4660 rest =
4661 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4662 - dp->db_txt_start;
4663 curchnk->mlcs_totalsize = rest;
4664 curchnk->mlcs_numlines = 1;
4665 curchnk[-1].mlcs_totalsize -= rest;
4666 curchnk[-1].mlcs_numlines -= 1;
4670 else if (updtype == ML_CHNK_DELLINE)
4672 curchnk->mlcs_numlines--;
4673 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4674 if (curix < (buf->b_ml.ml_usedchunks - 1)
4675 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4676 <= MLCS_MINL)
4678 curix++;
4679 curchnk = buf->b_ml.ml_chunksize + curix;
4681 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4683 buf->b_ml.ml_usedchunks--;
4684 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4685 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4686 return;
4688 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4689 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4690 > MLCS_MINL))
4692 return;
4695 /* Collapse chunks */
4696 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4697 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4698 buf->b_ml.ml_usedchunks--;
4699 if (curix < buf->b_ml.ml_usedchunks)
4701 mch_memmove(buf->b_ml.ml_chunksize + curix,
4702 buf->b_ml.ml_chunksize + curix + 1,
4703 (buf->b_ml.ml_usedchunks - curix) *
4704 sizeof(chunksize_T));
4706 return;
4708 ml_upd_lastbuf = buf;
4709 ml_upd_lastline = line;
4710 ml_upd_lastcurline = curline;
4711 ml_upd_lastcurix = curix;
4715 * Find offset for line or line with offset.
4716 * Find line with offset if "lnum" is 0; return remaining offset in offp
4717 * Find offset of line if "lnum" > 0
4718 * return -1 if information is not available
4720 long
4721 ml_find_line_or_offset(buf, lnum, offp)
4722 buf_T *buf;
4723 linenr_T lnum;
4724 long *offp;
4726 linenr_T curline;
4727 int curix;
4728 long size;
4729 bhdr_T *hp;
4730 DATA_BL *dp;
4731 int count; /* number of entries in block */
4732 int idx;
4733 int start_idx;
4734 int text_end;
4735 long offset;
4736 int len;
4737 int ffdos = (get_fileformat(buf) == EOL_DOS);
4738 int extra = 0;
4740 /* take care of cached line first */
4741 ml_flush_line(curbuf);
4743 if (buf->b_ml.ml_usedchunks == -1
4744 || buf->b_ml.ml_chunksize == NULL
4745 || lnum < 0)
4746 return -1;
4748 if (offp == NULL)
4749 offset = 0;
4750 else
4751 offset = *offp;
4752 if (lnum == 0 && offset <= 0)
4753 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4755 * Find the last chunk before the one containing our line. Last chunk is
4756 * special because it will never qualify
4758 curline = 1;
4759 curix = size = 0;
4760 while (curix < buf->b_ml.ml_usedchunks - 1
4761 && ((lnum != 0
4762 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4763 || (offset != 0
4764 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4765 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4767 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4768 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4769 if (offset && ffdos)
4770 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4771 curix++;
4774 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4776 if (curline > buf->b_ml.ml_line_count
4777 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4778 return -1;
4779 dp = (DATA_BL *)(hp->bh_data);
4780 count = (long)(buf->b_ml.ml_locked_high) -
4781 (long)(buf->b_ml.ml_locked_low) + 1;
4782 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4783 if (idx == 0)/* first line in block, text at the end */
4784 text_end = dp->db_txt_end;
4785 else
4786 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4787 /* Compute index of last line to use in this MEMLINE */
4788 if (lnum != 0)
4790 if (curline + (count - idx) >= lnum)
4791 idx += lnum - curline - 1;
4792 else
4793 idx = count - 1;
4795 else
4797 extra = 0;
4798 while (offset >= size
4799 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4800 + ffdos)
4802 if (ffdos)
4803 size++;
4804 if (idx == count - 1)
4806 extra = 1;
4807 break;
4809 idx++;
4812 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4813 size += len;
4814 if (offset != 0 && size >= offset)
4816 if (size + ffdos == offset)
4817 *offp = 0;
4818 else if (idx == start_idx)
4819 *offp = offset - size + len;
4820 else
4821 *offp = offset - size + len
4822 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4823 curline += idx - start_idx + extra;
4824 if (curline > buf->b_ml.ml_line_count)
4825 return -1; /* exactly one byte beyond the end */
4826 return curline;
4828 curline = buf->b_ml.ml_locked_high + 1;
4831 if (lnum != 0)
4833 /* Count extra CR characters. */
4834 if (ffdos)
4835 size += lnum - 1;
4837 /* Don't count the last line break if 'bin' and 'noeol'. */
4838 if (buf->b_p_bin && !buf->b_p_eol)
4839 size -= ffdos + 1;
4842 return size;
4846 * Goto byte in buffer with offset 'cnt'.
4848 void
4849 goto_byte(cnt)
4850 long cnt;
4852 long boff = cnt;
4853 linenr_T lnum;
4855 ml_flush_line(curbuf); /* cached line may be dirty */
4856 setpcmark();
4857 if (boff)
4858 --boff;
4859 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4860 if (lnum < 1) /* past the end */
4862 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4863 curwin->w_curswant = MAXCOL;
4864 coladvance((colnr_T)MAXCOL);
4866 else
4868 curwin->w_cursor.lnum = lnum;
4869 curwin->w_cursor.col = (colnr_T)boff;
4870 # ifdef FEAT_VIRTUALEDIT
4871 curwin->w_cursor.coladd = 0;
4872 # endif
4873 curwin->w_set_curswant = TRUE;
4875 check_cursor();
4877 # ifdef FEAT_MBYTE
4878 /* Make sure the cursor is on the first byte of a multi-byte char. */
4879 if (has_mbyte)
4880 mb_adjust_cursor();
4881 # endif
4883 #endif