Merged from the latest developing branch.
[MacVim/KaoriYa.git] / src / memline.c
blob8c8019ab7be04965e156d3985d4b885bed53b881
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; /* emtpy 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;
494 if (!success)
495 EMSG(_("E302: Could not rename swap file"));
499 * Open a file for the memfile for all buffers that are not readonly or have
500 * been modified.
501 * Used when 'updatecount' changes from zero to non-zero.
503 void
504 ml_open_files()
506 buf_T *buf;
508 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
509 if (!buf->b_p_ro || buf->b_changed)
510 ml_open_file(buf);
514 * Open a swap file for an existing memfile, if there is no swap file yet.
515 * If we are unable to find a file name, mf_fname will be NULL
516 * and the memfile will be in memory only (no recovery possible).
518 void
519 ml_open_file(buf)
520 buf_T *buf;
522 memfile_T *mfp;
523 char_u *fname;
524 char_u *dirp;
526 mfp = buf->b_ml.ml_mfp;
527 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
528 return; /* nothing to do */
530 #ifdef FEAT_SPELL
531 /* For a spell buffer use a temp file name. */
532 if (buf->b_spell)
534 fname = vim_tempname('s');
535 if (fname != NULL)
536 (void)mf_open_file(mfp, fname); /* consumes fname! */
537 buf->b_may_swap = FALSE;
538 return;
540 #endif
543 * Try all directories in 'directory' option.
545 dirp = p_dir;
546 for (;;)
548 if (*dirp == NUL)
549 break;
550 /* There is a small chance that between chosing the swap file name and
551 * creating it, another Vim creates the file. In that case the
552 * creation will fail and we will use another directory. */
553 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
554 if (fname == NULL)
555 continue;
556 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
558 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
560 * set full pathname for swap file now, because a ":!cd dir" may
561 * change directory without us knowing it.
563 mf_fullname(mfp);
564 #endif
565 ml_upd_block0(buf, FALSE);
567 /* Flush block zero, so others can read it */
568 if (mf_sync(mfp, MFS_ZERO) == OK)
570 /* Mark all blocks that should be in the swapfile as dirty.
571 * Needed for when the 'swapfile' option was reset, so that
572 * the swap file was deleted, and then on again. */
573 mf_set_dirty(mfp);
574 break;
576 /* Writing block 0 failed: close the file and try another dir */
577 mf_close_file(buf, FALSE);
581 if (mfp->mf_fname == NULL) /* Failed! */
583 need_wait_return = TRUE; /* call wait_return later */
584 ++no_wait_return;
585 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
586 buf_spname(buf) != NULL
587 ? (char_u *)buf_spname(buf)
588 : buf->b_fname);
589 --no_wait_return;
592 /* don't try to open a swap file again */
593 buf->b_may_swap = FALSE;
597 * If still need to create a swap file, and starting to edit a not-readonly
598 * file, or reading into an existing buffer, create a swap file now.
600 void
601 check_need_swap(newfile)
602 int newfile; /* reading file into new buffer */
604 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
605 ml_open_file(curbuf);
609 * Close memline for buffer 'buf'.
610 * If 'del_file' is TRUE, delete the swap file
612 void
613 ml_close(buf, del_file)
614 buf_T *buf;
615 int del_file;
617 if (buf->b_ml.ml_mfp == NULL) /* not open */
618 return;
619 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
620 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
621 vim_free(buf->b_ml.ml_line_ptr);
622 vim_free(buf->b_ml.ml_stack);
623 #ifdef FEAT_BYTEOFF
624 vim_free(buf->b_ml.ml_chunksize);
625 buf->b_ml.ml_chunksize = NULL;
626 #endif
627 buf->b_ml.ml_mfp = NULL;
629 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
630 * this buffer is loaded. */
631 buf->b_flags &= ~BF_RECOVERED;
635 * Close all existing memlines and memfiles.
636 * Only used when exiting.
637 * When 'del_file' is TRUE, delete the memfiles.
638 * But don't delete files that were ":preserve"d when we are POSIX compatible.
640 void
641 ml_close_all(del_file)
642 int del_file;
644 buf_T *buf;
646 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
647 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
648 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
649 #ifdef TEMPDIRNAMES
650 vim_deltempdir(); /* delete created temp directory */
651 #endif
655 * Close all memfiles for not modified buffers.
656 * Only use just before exiting!
658 void
659 ml_close_notmod()
661 buf_T *buf;
663 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
664 if (!bufIsChanged(buf))
665 ml_close(buf, TRUE); /* close all not-modified buffers */
669 * Update the timestamp in the .swp file.
670 * Used when the file has been written.
672 void
673 ml_timestamp(buf)
674 buf_T *buf;
676 ml_upd_block0(buf, TRUE);
680 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
682 static void
683 ml_upd_block0(buf, set_fname)
684 buf_T *buf;
685 int set_fname;
687 memfile_T *mfp;
688 bhdr_T *hp;
689 ZERO_BL *b0p;
691 mfp = buf->b_ml.ml_mfp;
692 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
693 return;
694 b0p = (ZERO_BL *)(hp->bh_data);
695 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
696 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
697 else
699 if (set_fname)
700 set_b0_fname(b0p, buf);
701 else
702 set_b0_dir_flag(b0p, buf);
704 mf_put(mfp, hp, TRUE, FALSE);
708 * Write file name and timestamp into block 0 of a swap file.
709 * Also set buf->b_mtime.
710 * Don't use NameBuff[]!!!
712 static void
713 set_b0_fname(b0p, buf)
714 ZERO_BL *b0p;
715 buf_T *buf;
717 struct stat st;
719 if (buf->b_ffname == NULL)
720 b0p->b0_fname[0] = NUL;
721 else
723 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
724 /* Systems that cannot translate "~user" back into a path: copy the
725 * file name unmodified. Do use slashes instead of backslashes for
726 * portability. */
727 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
728 # ifdef BACKSLASH_IN_FILENAME
729 forward_slash(b0p->b0_fname);
730 # endif
731 #else
732 size_t flen, ulen;
733 char_u uname[B0_UNAME_SIZE];
736 * For a file under the home directory of the current user, we try to
737 * replace the home directory path with "~user". This helps when
738 * editing the same file on different machines over a network.
739 * First replace home dir path with "~/" with home_replace().
740 * Then insert the user name to get "~user/".
742 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
743 if (b0p->b0_fname[0] == '~')
745 flen = STRLEN(b0p->b0_fname);
746 /* If there is no user name or it is too long, don't use "~/" */
747 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
748 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
749 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
750 else
752 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
753 mch_memmove(b0p->b0_fname + 1, uname, ulen);
756 #endif
757 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
759 long_to_char((long)st.st_mtime, b0p->b0_mtime);
760 #ifdef CHECK_INODE
761 long_to_char((long)st.st_ino, b0p->b0_ino);
762 #endif
763 buf_store_time(buf, &st, buf->b_ffname);
764 buf->b_mtime_read = buf->b_mtime;
766 else
768 long_to_char(0L, b0p->b0_mtime);
769 #ifdef CHECK_INODE
770 long_to_char(0L, b0p->b0_ino);
771 #endif
772 buf->b_mtime = 0;
773 buf->b_mtime_read = 0;
774 buf->b_orig_size = 0;
775 buf->b_orig_mode = 0;
779 #ifdef FEAT_MBYTE
780 /* Also add the 'fileencoding' if there is room. */
781 add_b0_fenc(b0p, curbuf);
782 #endif
786 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
787 * swapfile for "buf" are in the same directory.
788 * This is fail safe: if we are not sure the directories are equal the flag is
789 * not set.
791 static void
792 set_b0_dir_flag(b0p, buf)
793 ZERO_BL *b0p;
794 buf_T *buf;
796 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
797 b0p->b0_flags |= B0_SAME_DIR;
798 else
799 b0p->b0_flags &= ~B0_SAME_DIR;
802 #ifdef FEAT_MBYTE
804 * When there is room, add the 'fileencoding' to block zero.
806 static void
807 add_b0_fenc(b0p, buf)
808 ZERO_BL *b0p;
809 buf_T *buf;
811 int n;
813 n = (int)STRLEN(buf->b_p_fenc);
814 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
815 b0p->b0_flags &= ~B0_HAS_FENC;
816 else
818 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
819 (char *)buf->b_p_fenc, (size_t)n);
820 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
821 b0p->b0_flags |= B0_HAS_FENC;
824 #endif
828 * try to recover curbuf from the .swp file
830 void
831 ml_recover()
833 buf_T *buf = NULL;
834 memfile_T *mfp = NULL;
835 char_u *fname;
836 bhdr_T *hp = NULL;
837 ZERO_BL *b0p;
838 int b0_ff;
839 char_u *b0_fenc = NULL;
840 PTR_BL *pp;
841 DATA_BL *dp;
842 infoptr_T *ip;
843 blocknr_T bnum;
844 int page_count;
845 struct stat org_stat, swp_stat;
846 int len;
847 int directly;
848 linenr_T lnum;
849 char_u *p;
850 int i;
851 long error;
852 int cannot_open;
853 linenr_T line_count;
854 int has_error;
855 int idx;
856 int top;
857 int txt_start;
858 off_t size;
859 int called_from_main;
860 int serious_error = TRUE;
861 long mtime;
862 int attr;
864 recoverymode = TRUE;
865 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
866 attr = hl_attr(HLF_E);
868 * If the file name ends in ".sw?" we use it directly.
869 * Otherwise a search is done to find the swap file(s).
871 fname = curbuf->b_fname;
872 if (fname == NULL) /* When there is no file name */
873 fname = (char_u *)"";
874 len = (int)STRLEN(fname);
875 if (len >= 4 &&
876 #if defined(VMS) || defined(RISCOS)
877 STRNICMP(fname + len - 4, "_sw" , 3)
878 #else
879 STRNICMP(fname + len - 4, ".sw" , 3)
880 #endif
881 == 0)
883 directly = TRUE;
884 fname = vim_strsave(fname); /* make a copy for mf_open() */
886 else
888 directly = FALSE;
890 /* count the number of matching swap files */
891 len = recover_names(&fname, FALSE, 0);
892 if (len == 0) /* no swap files found */
894 EMSG2(_("E305: No swap file found for %s"), fname);
895 goto theend;
897 if (len == 1) /* one swap file found, use it */
898 i = 1;
899 else /* several swap files found, choose */
901 /* list the names of the swap files */
902 (void)recover_names(&fname, TRUE, 0);
903 msg_putchar('\n');
904 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
905 i = get_number(FALSE, NULL);
906 if (i < 1 || i > len)
907 goto theend;
909 /* get the swap file name that will be used */
910 (void)recover_names(&fname, FALSE, i);
912 if (fname == NULL)
913 goto theend; /* out of memory */
915 /* When called from main() still need to initialize storage structure */
916 if (called_from_main && ml_open(curbuf) == FAIL)
917 getout(1);
920 * allocate a buffer structure (only the memline in it is really used)
922 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
923 if (buf == NULL)
925 vim_free(fname);
926 goto theend;
930 * init fields in memline struct
932 buf->b_ml.ml_stack_size = 0; /* no stack yet */
933 buf->b_ml.ml_stack = NULL; /* no stack yet */
934 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
935 buf->b_ml.ml_line_lnum = 0; /* no cached line */
936 buf->b_ml.ml_locked = NULL; /* no locked block */
937 buf->b_ml.ml_flags = 0;
940 * open the memfile from the old swap file
942 p = vim_strsave(fname); /* save fname for the message
943 (mf_open() may free fname) */
944 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
945 if (mfp == NULL || mfp->mf_fd < 0)
947 if (p != NULL)
949 EMSG2(_("E306: Cannot open %s"), p);
950 vim_free(p);
952 goto theend;
954 vim_free(p);
955 buf->b_ml.ml_mfp = mfp;
958 * The page size set in mf_open() might be different from the page size
959 * used in the swap file, we must get it from block 0. But to read block
960 * 0 we need a page size. Use the minimal size for block 0 here, it will
961 * be set to the real value below.
963 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
966 * try to read block 0
968 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
970 msg_start();
971 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
972 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
973 MSG_PUTS_ATTR(
974 _("\nMaybe no changes were made or Vim did not update the swap file."),
975 attr | MSG_HIST);
976 msg_end();
977 goto theend;
979 b0p = (ZERO_BL *)(hp->bh_data);
980 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
982 msg_start();
983 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
984 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
985 MSG_HIST);
986 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
987 msg_end();
988 goto theend;
990 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
992 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
993 goto theend;
995 if (b0_magic_wrong(b0p))
997 msg_start();
998 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
999 #if defined(MSDOS) || defined(MSWIN)
1000 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1001 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1002 attr | MSG_HIST);
1003 else
1004 #endif
1005 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1006 attr | MSG_HIST);
1007 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1008 /* avoid going past the end of a currupted hostname */
1009 b0p->b0_fname[0] = NUL;
1010 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1011 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1012 msg_end();
1013 goto theend;
1017 * If we guessed the wrong page size, we have to recalculate the
1018 * highest block number in the file.
1020 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1022 unsigned previous_page_size = mfp->mf_page_size;
1024 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1025 if (mfp->mf_page_size < previous_page_size)
1027 msg_start();
1028 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1029 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1030 attr | MSG_HIST);
1031 msg_end();
1032 goto theend;
1034 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1035 mfp->mf_blocknr_max = 0; /* no file or empty file */
1036 else
1037 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1038 mfp->mf_infile_count = mfp->mf_blocknr_max;
1040 /* need to reallocate the memory used to store the data */
1041 p = alloc(mfp->mf_page_size);
1042 if (p == NULL)
1043 goto theend;
1044 mch_memmove(p, hp->bh_data, previous_page_size);
1045 vim_free(hp->bh_data);
1046 hp->bh_data = p;
1047 b0p = (ZERO_BL *)(hp->bh_data);
1051 * If .swp file name given directly, use name from swap file for buffer.
1053 if (directly)
1055 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1056 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1057 goto theend;
1060 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1061 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1063 if (buf_spname(curbuf) != NULL)
1064 STRCPY(NameBuff, buf_spname(curbuf));
1065 else
1066 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1067 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1068 msg_putchar('\n');
1071 * check date of swap file and original file
1073 mtime = char_to_long(b0p->b0_mtime);
1074 if (curbuf->b_ffname != NULL
1075 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1076 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1077 && org_stat.st_mtime > swp_stat.st_mtime)
1078 || org_stat.st_mtime != mtime))
1080 EMSG(_("E308: Warning: Original file may have been changed"));
1082 out_flush();
1084 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1085 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1086 if (b0p->b0_flags & B0_HAS_FENC)
1088 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1089 p > b0p->b0_fname && p[-1] != NUL; --p)
1091 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1094 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1095 hp = NULL;
1098 * Now that we are sure that the file is going to be recovered, clear the
1099 * contents of the current buffer.
1101 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1102 ml_delete((linenr_T)1, FALSE);
1105 * Try reading the original file to obtain the values of 'fileformat',
1106 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1108 if (curbuf->b_ffname != NULL)
1110 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1111 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1112 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1113 ml_delete((linenr_T)1, FALSE);
1116 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1117 if (b0_ff != 0)
1118 set_fileformat(b0_ff - 1, OPT_LOCAL);
1119 if (b0_fenc != NULL)
1121 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1122 vim_free(b0_fenc);
1124 unchanged(curbuf, TRUE);
1126 bnum = 1; /* start with block 1 */
1127 page_count = 1; /* which is 1 page */
1128 lnum = 0; /* append after line 0 in curbuf */
1129 line_count = 0;
1130 idx = 0; /* start with first index in block 1 */
1131 error = 0;
1132 buf->b_ml.ml_stack_top = 0;
1133 buf->b_ml.ml_stack = NULL;
1134 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1136 if (curbuf->b_ffname == NULL)
1137 cannot_open = TRUE;
1138 else
1139 cannot_open = FALSE;
1141 serious_error = FALSE;
1142 for ( ; !got_int; line_breakcheck())
1144 if (hp != NULL)
1145 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1148 * get block
1150 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1152 if (bnum == 1)
1154 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1155 goto theend;
1157 ++error;
1158 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1159 (colnr_T)0, TRUE);
1161 else /* there is a block */
1163 pp = (PTR_BL *)(hp->bh_data);
1164 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1166 /* check line count when using pointer block first time */
1167 if (idx == 0 && line_count != 0)
1169 for (i = 0; i < (int)pp->pb_count; ++i)
1170 line_count -= pp->pb_pointer[i].pe_line_count;
1171 if (line_count != 0)
1173 ++error;
1174 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1175 (colnr_T)0, TRUE);
1179 if (pp->pb_count == 0)
1181 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1182 (colnr_T)0, TRUE);
1183 ++error;
1185 else if (idx < (int)pp->pb_count) /* go a block deeper */
1187 if (pp->pb_pointer[idx].pe_bnum < 0)
1190 * Data block with negative block number.
1191 * Try to read lines from the original file.
1192 * This is slow, but it works.
1194 if (!cannot_open)
1196 line_count = pp->pb_pointer[idx].pe_line_count;
1197 if (readfile(curbuf->b_ffname, NULL, lnum,
1198 pp->pb_pointer[idx].pe_old_lnum - 1,
1199 line_count, NULL, 0) == FAIL)
1200 cannot_open = TRUE;
1201 else
1202 lnum += line_count;
1204 if (cannot_open)
1206 ++error;
1207 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1208 (colnr_T)0, TRUE);
1210 ++idx; /* get same block again for next index */
1211 continue;
1215 * going one block deeper in the tree
1217 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1219 ++error;
1220 break; /* out of memory */
1222 ip = &(buf->b_ml.ml_stack[top]);
1223 ip->ip_bnum = bnum;
1224 ip->ip_index = idx;
1226 bnum = pp->pb_pointer[idx].pe_bnum;
1227 line_count = pp->pb_pointer[idx].pe_line_count;
1228 page_count = pp->pb_pointer[idx].pe_page_count;
1229 continue;
1232 else /* not a pointer block */
1234 dp = (DATA_BL *)(hp->bh_data);
1235 if (dp->db_id != DATA_ID) /* block id wrong */
1237 if (bnum == 1)
1239 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1240 mfp->mf_fname);
1241 goto theend;
1243 ++error;
1244 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1245 (colnr_T)0, TRUE);
1247 else
1250 * it is a data block
1251 * Append all the lines in this block
1253 has_error = FALSE;
1255 * check length of block
1256 * if wrong, use length in pointer block
1258 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1260 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1261 (colnr_T)0, TRUE);
1262 ++error;
1263 has_error = TRUE;
1264 dp->db_txt_end = page_count * mfp->mf_page_size;
1267 /* make sure there is a NUL at the end of the block */
1268 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1271 * check number of lines in block
1272 * if wrong, use count in data block
1274 if (line_count != dp->db_line_count)
1276 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1277 (colnr_T)0, TRUE);
1278 ++error;
1279 has_error = TRUE;
1282 for (i = 0; i < dp->db_line_count; ++i)
1284 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1285 if (txt_start <= HEADER_SIZE
1286 || txt_start >= (int)dp->db_txt_end)
1288 p = (char_u *)"???";
1289 ++error;
1291 else
1292 p = (char_u *)dp + txt_start;
1293 ml_append(lnum++, p, (colnr_T)0, TRUE);
1295 if (has_error)
1296 ml_append(lnum++, (char_u *)_("???END"), (colnr_T)0, TRUE);
1301 if (buf->b_ml.ml_stack_top == 0) /* finished */
1302 break;
1305 * go one block up in the tree
1307 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1308 bnum = ip->ip_bnum;
1309 idx = ip->ip_index + 1; /* go to next index */
1310 page_count = 1;
1314 * The dummy line from the empty buffer will now be after the last line in
1315 * the buffer. Delete it.
1317 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1318 curbuf->b_flags |= BF_RECOVERED;
1320 recoverymode = FALSE;
1321 if (got_int)
1322 EMSG(_("E311: Recovery Interrupted"));
1323 else if (error)
1325 ++no_wait_return;
1326 MSG(">>>>>>>>>>>>>");
1327 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1328 --no_wait_return;
1329 MSG(_("See \":help E312\" for more information."));
1330 MSG(">>>>>>>>>>>>>");
1332 else
1334 MSG(_("Recovery completed. You should check if everything is OK."));
1335 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1336 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1337 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1338 cmdline_row = msg_row;
1340 redraw_curbuf_later(NOT_VALID);
1342 theend:
1343 recoverymode = FALSE;
1344 if (mfp != NULL)
1346 if (hp != NULL)
1347 mf_put(mfp, hp, FALSE, FALSE);
1348 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1350 if (buf != NULL)
1352 vim_free(buf->b_ml.ml_stack);
1353 vim_free(buf);
1355 if (serious_error && called_from_main)
1356 ml_close(curbuf, TRUE);
1357 #ifdef FEAT_AUTOCMD
1358 else
1360 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1361 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1363 #endif
1364 return;
1368 * Find the names of swap files in current directory and the directory given
1369 * with the 'directory' option.
1371 * Used to:
1372 * - list the swap files for "vim -r"
1373 * - count the number of swap files when recovering
1374 * - list the swap files when recovering
1375 * - find the name of the n'th swap file when recovering
1378 recover_names(fname, list, nr)
1379 char_u **fname; /* base for swap file name */
1380 int list; /* when TRUE, list the swap file names */
1381 int nr; /* when non-zero, return nr'th swap file name */
1383 int num_names;
1384 char_u *(names[6]);
1385 char_u *tail;
1386 char_u *p;
1387 int num_files;
1388 int file_count = 0;
1389 char_u **files;
1390 int i;
1391 char_u *dirp;
1392 char_u *dir_name;
1394 if (list)
1396 /* use msg() to start the scrolling properly */
1397 msg((char_u *)_("Swap files found:"));
1398 msg_putchar('\n');
1402 * Do the loop for every directory in 'directory'.
1403 * First allocate some memory to put the directory name in.
1405 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1406 dirp = p_dir;
1407 while (dir_name != NULL && *dirp)
1410 * Isolate a directory name from *dirp and put it in dir_name (we know
1411 * it is large enough, so use 31000 for length).
1412 * Advance dirp to next directory name.
1414 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1416 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1418 if (fname == NULL || *fname == NULL)
1420 #ifdef VMS
1421 names[0] = vim_strsave((char_u *)"*_sw%");
1422 #else
1423 # ifdef RISCOS
1424 names[0] = vim_strsave((char_u *)"*_sw#");
1425 # else
1426 names[0] = vim_strsave((char_u *)"*.sw?");
1427 # endif
1428 #endif
1429 #if defined(UNIX) || defined(WIN3264)
1430 /* For Unix names starting with a dot are special. MS-Windows
1431 * supports this too, on some file systems. */
1432 names[1] = vim_strsave((char_u *)".*.sw?");
1433 names[2] = vim_strsave((char_u *)".sw?");
1434 num_names = 3;
1435 #else
1436 # ifdef VMS
1437 names[1] = vim_strsave((char_u *)".*_sw%");
1438 num_names = 2;
1439 # else
1440 num_names = 1;
1441 # endif
1442 #endif
1444 else
1445 num_names = recov_file_names(names, *fname, TRUE);
1447 else /* check directory dir_name */
1449 if (fname == NULL || *fname == NULL)
1451 #ifdef VMS
1452 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1453 #else
1454 # ifdef RISCOS
1455 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1456 # else
1457 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1458 # endif
1459 #endif
1460 #if defined(UNIX) || defined(WIN3264)
1461 /* For Unix names starting with a dot are special. MS-Windows
1462 * supports this too, on some file systems. */
1463 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1464 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1465 num_names = 3;
1466 #else
1467 # ifdef VMS
1468 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1469 num_names = 2;
1470 # else
1471 num_names = 1;
1472 # endif
1473 #endif
1475 else
1477 #if defined(UNIX) || defined(WIN3264)
1478 p = dir_name + STRLEN(dir_name);
1479 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1481 /* Ends with '//', Use Full path for swap name */
1482 tail = make_percent_swname(dir_name, *fname);
1484 else
1485 #endif
1487 tail = gettail(*fname);
1488 tail = concat_fnames(dir_name, tail, TRUE);
1490 if (tail == NULL)
1491 num_names = 0;
1492 else
1494 num_names = recov_file_names(names, tail, FALSE);
1495 vim_free(tail);
1500 /* check for out-of-memory */
1501 for (i = 0; i < num_names; ++i)
1503 if (names[i] == NULL)
1505 for (i = 0; i < num_names; ++i)
1506 vim_free(names[i]);
1507 num_names = 0;
1510 if (num_names == 0)
1511 num_files = 0;
1512 else if (expand_wildcards(num_names, names, &num_files, &files,
1513 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1514 num_files = 0;
1517 * When no swap file found, wildcard expansion might have failed (e.g.
1518 * not able to execute the shell).
1519 * Try finding a swap file by simply adding ".swp" to the file name.
1521 if (*dirp == NUL && file_count + num_files == 0
1522 && fname != NULL && *fname != NULL)
1524 struct stat st;
1525 char_u *swapname;
1527 #if defined(VMS) || defined(RISCOS)
1528 swapname = modname(*fname, (char_u *)"_swp", FALSE);
1529 #else
1530 swapname = modname(*fname, (char_u *)".swp", TRUE);
1531 #endif
1532 if (swapname != NULL)
1534 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1536 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1537 if (files != NULL)
1539 files[0] = swapname;
1540 swapname = NULL;
1541 num_files = 1;
1544 vim_free(swapname);
1549 * remove swapfile name of the current buffer, it must be ignored
1551 if (curbuf->b_ml.ml_mfp != NULL
1552 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1554 for (i = 0; i < num_files; ++i)
1555 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1557 /* Remove the name from files[i]. Move further entries
1558 * down. When the array becomes empty free it here, since
1559 * FreeWild() won't be called below. */
1560 vim_free(files[i]);
1561 if (--num_files == 0)
1562 vim_free(files);
1563 else
1564 for ( ; i < num_files; ++i)
1565 files[i] = files[i + 1];
1568 if (nr > 0)
1570 file_count += num_files;
1571 if (nr <= file_count)
1573 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1574 dirp = (char_u *)""; /* stop searching */
1577 else if (list)
1579 if (dir_name[0] == '.' && dir_name[1] == NUL)
1581 if (fname == NULL || *fname == NULL)
1582 MSG_PUTS(_(" In current directory:\n"));
1583 else
1584 MSG_PUTS(_(" Using specified name:\n"));
1586 else
1588 MSG_PUTS(_(" In directory "));
1589 msg_home_replace(dir_name);
1590 MSG_PUTS(":\n");
1593 if (num_files)
1595 for (i = 0; i < num_files; ++i)
1597 /* print the swap file name */
1598 msg_outnum((long)++file_count);
1599 MSG_PUTS(". ");
1600 msg_puts(gettail(files[i]));
1601 msg_putchar('\n');
1602 (void)swapfile_info(files[i]);
1605 else
1606 MSG_PUTS(_(" -- none --\n"));
1607 out_flush();
1609 else
1610 file_count += num_files;
1612 for (i = 0; i < num_names; ++i)
1613 vim_free(names[i]);
1614 if (num_files > 0)
1615 FreeWild(num_files, files);
1617 vim_free(dir_name);
1618 return file_count;
1621 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1623 * Append the full path to name with path separators made into percent
1624 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1626 static char_u *
1627 make_percent_swname(dir, name)
1628 char_u *dir;
1629 char_u *name;
1631 char_u *d, *s, *f;
1633 f = fix_fname(name != NULL ? name : (char_u *) "");
1634 d = NULL;
1635 if (f != NULL)
1637 s = alloc((unsigned)(STRLEN(f) + 1));
1638 if (s != NULL)
1640 STRCPY(s, f);
1641 for (d = s; *d != NUL; mb_ptr_adv(d))
1642 if (vim_ispathsep(*d))
1643 *d = '%';
1644 d = concat_fnames(dir, s, TRUE);
1645 vim_free(s);
1647 vim_free(f);
1649 return d;
1651 #endif
1653 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1654 static int process_still_running;
1655 #endif
1658 * Give information about an existing swap file.
1659 * Returns timestamp (0 when unknown).
1661 static time_t
1662 swapfile_info(fname)
1663 char_u *fname;
1665 struct stat st;
1666 int fd;
1667 struct block0 b0;
1668 time_t x = (time_t)0;
1669 char *p;
1670 #ifdef UNIX
1671 char_u uname[B0_UNAME_SIZE];
1672 #endif
1674 /* print the swap file date */
1675 if (mch_stat((char *)fname, &st) != -1)
1677 #ifdef UNIX
1678 /* print name of owner of the file */
1679 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1681 MSG_PUTS(_(" owned by: "));
1682 msg_outtrans(uname);
1683 MSG_PUTS(_(" dated: "));
1685 else
1686 #endif
1687 MSG_PUTS(_(" dated: "));
1688 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1689 p = ctime(&x); /* includes '\n' */
1690 if (p == NULL)
1691 MSG_PUTS("(invalid)\n");
1692 else
1693 MSG_PUTS(p);
1697 * print the original file name
1699 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1700 if (fd >= 0)
1702 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1704 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1706 MSG_PUTS(_(" [from Vim version 3.0]"));
1708 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1710 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1712 else
1714 MSG_PUTS(_(" file name: "));
1715 if (b0.b0_fname[0] == NUL)
1716 MSG_PUTS(_("[No Name]"));
1717 else
1718 msg_outtrans(b0.b0_fname);
1720 MSG_PUTS(_("\n modified: "));
1721 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1723 if (*(b0.b0_uname) != NUL)
1725 MSG_PUTS(_("\n user name: "));
1726 msg_outtrans(b0.b0_uname);
1729 if (*(b0.b0_hname) != NUL)
1731 if (*(b0.b0_uname) != NUL)
1732 MSG_PUTS(_(" host name: "));
1733 else
1734 MSG_PUTS(_("\n host name: "));
1735 msg_outtrans(b0.b0_hname);
1738 if (char_to_long(b0.b0_pid) != 0L)
1740 MSG_PUTS(_("\n process ID: "));
1741 msg_outnum(char_to_long(b0.b0_pid));
1742 #if defined(UNIX) || defined(__EMX__)
1743 /* EMX kill() not working correctly, it seems */
1744 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1746 MSG_PUTS(_(" (still running)"));
1747 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1748 process_still_running = TRUE;
1749 # endif
1751 #endif
1754 if (b0_magic_wrong(&b0))
1756 #if defined(MSDOS) || defined(MSWIN)
1757 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1758 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1759 else
1760 #endif
1761 MSG_PUTS(_("\n [not usable on this computer]"));
1765 else
1766 MSG_PUTS(_(" [cannot be read]"));
1767 close(fd);
1769 else
1770 MSG_PUTS(_(" [cannot be opened]"));
1771 msg_putchar('\n');
1773 return x;
1776 static int
1777 recov_file_names(names, path, prepend_dot)
1778 char_u **names;
1779 char_u *path;
1780 int prepend_dot;
1782 int num_names;
1784 #ifdef SHORT_FNAME
1786 * (MS-DOS) always short names
1788 names[0] = modname(path, (char_u *)".sw?", FALSE);
1789 num_names = 1;
1790 #else /* !SHORT_FNAME */
1792 * (Win32 and Win64) never short names, but do prepend a dot.
1793 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1794 * Only use the short name if it is different.
1796 char_u *p;
1797 int i;
1798 # ifndef WIN3264
1799 int shortname = curbuf->b_shortname;
1801 curbuf->b_shortname = FALSE;
1802 # endif
1804 num_names = 0;
1807 * May also add the file name with a dot prepended, for swap file in same
1808 * dir as original file.
1810 if (prepend_dot)
1812 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1813 if (names[num_names] == NULL)
1814 goto end;
1815 ++num_names;
1819 * Form the normal swap file name pattern by appending ".sw?".
1821 #ifdef VMS
1822 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1823 #else
1824 # ifdef RISCOS
1825 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1826 # else
1827 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1828 # endif
1829 #endif
1830 if (names[num_names] == NULL)
1831 goto end;
1832 if (num_names >= 1) /* check if we have the same name twice */
1834 p = names[num_names - 1];
1835 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1836 if (i > 0)
1837 p += i; /* file name has been expanded to full path */
1839 if (STRCMP(p, names[num_names]) != 0)
1840 ++num_names;
1841 else
1842 vim_free(names[num_names]);
1844 else
1845 ++num_names;
1847 # ifndef WIN3264
1849 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1851 curbuf->b_shortname = TRUE;
1852 #ifdef VMS
1853 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1854 #else
1855 # ifdef RISCOS
1856 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1857 # else
1858 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1859 # endif
1860 #endif
1861 if (names[num_names] == NULL)
1862 goto end;
1865 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1867 p = names[num_names];
1868 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1869 if (i > 0)
1870 p += i; /* file name has been expanded to full path */
1871 if (STRCMP(names[num_names - 1], p) == 0)
1872 vim_free(names[num_names]);
1873 else
1874 ++num_names;
1875 # endif
1877 end:
1878 # ifndef WIN3264
1879 curbuf->b_shortname = shortname;
1880 # endif
1882 #endif /* !SHORT_FNAME */
1884 return num_names;
1888 * sync all memlines
1890 * If 'check_file' is TRUE, check if original file exists and was not changed.
1891 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1892 * always sync at least one block.
1894 void
1895 ml_sync_all(check_file, check_char)
1896 int check_file;
1897 int check_char;
1899 buf_T *buf;
1900 struct stat st;
1902 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1904 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1905 continue; /* no file */
1907 ml_flush_line(buf); /* flush buffered line */
1908 /* flush locked block */
1909 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1910 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1911 && buf->b_ffname != NULL)
1914 * If the original file does not exist anymore or has been changed
1915 * call ml_preserve() to get rid of all negative numbered blocks.
1917 if (mch_stat((char *)buf->b_ffname, &st) == -1
1918 || st.st_mtime != buf->b_mtime_read
1919 || (size_t)st.st_size != buf->b_orig_size)
1921 ml_preserve(buf, FALSE);
1922 did_check_timestamps = FALSE;
1923 need_check_timestamps = TRUE; /* give message later */
1926 if (buf->b_ml.ml_mfp->mf_dirty)
1928 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1929 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1930 if (check_char && ui_char_avail()) /* character available now */
1931 break;
1937 * sync one buffer, including negative blocks
1939 * after this all the blocks are in the swap file
1941 * Used for the :preserve command and when the original file has been
1942 * changed or deleted.
1944 * when message is TRUE the success of preserving is reported
1946 void
1947 ml_preserve(buf, message)
1948 buf_T *buf;
1949 int message;
1951 bhdr_T *hp;
1952 linenr_T lnum;
1953 memfile_T *mfp = buf->b_ml.ml_mfp;
1954 int status;
1955 int got_int_save = got_int;
1957 if (mfp == NULL || mfp->mf_fname == NULL)
1959 if (message)
1960 EMSG(_("E313: Cannot preserve, there is no swap file"));
1961 return;
1964 /* We only want to stop when interrupted here, not when interrupted
1965 * before. */
1966 got_int = FALSE;
1968 ml_flush_line(buf); /* flush buffered line */
1969 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
1970 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
1972 /* stack is invalid after mf_sync(.., MFS_ALL) */
1973 buf->b_ml.ml_stack_top = 0;
1976 * Some of the data blocks may have been changed from negative to
1977 * positive block number. In that case the pointer blocks need to be
1978 * updated.
1980 * We don't know in which pointer block the references are, so we visit
1981 * all data blocks until there are no more translations to be done (or
1982 * we hit the end of the file, which can only happen in case a write fails,
1983 * e.g. when file system if full).
1984 * ml_find_line() does the work by translating the negative block numbers
1985 * when getting the first line of each data block.
1987 if (mf_need_trans(mfp) && !got_int)
1989 lnum = 1;
1990 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
1992 hp = ml_find_line(buf, lnum, ML_FIND);
1993 if (hp == NULL)
1995 status = FAIL;
1996 goto theend;
1998 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
1999 lnum = buf->b_ml.ml_locked_high + 1;
2001 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2002 /* sync the updated pointer blocks */
2003 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2004 status = FAIL;
2005 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2007 theend:
2008 got_int |= got_int_save;
2010 if (message)
2012 if (status == OK)
2013 MSG(_("File preserved"));
2014 else
2015 EMSG(_("E314: Preserve failed"));
2020 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2021 * until the next call!
2022 * line1 = ml_get(1);
2023 * line2 = ml_get(2); // line1 is now invalid!
2024 * Make a copy of the line if necessary.
2027 * get a pointer to a (read-only copy of a) line
2029 * On failure an error message is given and IObuff is returned (to avoid
2030 * having to check for error everywhere).
2032 char_u *
2033 ml_get(lnum)
2034 linenr_T lnum;
2036 return ml_get_buf(curbuf, lnum, FALSE);
2040 * ml_get_pos: get pointer to position 'pos'
2042 char_u *
2043 ml_get_pos(pos)
2044 pos_T *pos;
2046 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2050 * ml_get_curline: get pointer to cursor line.
2052 char_u *
2053 ml_get_curline()
2055 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2059 * ml_get_cursor: get pointer to cursor position
2061 char_u *
2062 ml_get_cursor()
2064 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2065 curwin->w_cursor.col);
2069 * get a pointer to a line in a specific buffer
2071 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2072 * changed)
2074 char_u *
2075 ml_get_buf(buf, lnum, will_change)
2076 buf_T *buf;
2077 linenr_T lnum;
2078 int will_change; /* line will be changed */
2080 bhdr_T *hp;
2081 DATA_BL *dp;
2082 char_u *ptr;
2083 static int recursive = 0;
2085 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2087 if (recursive == 0)
2089 /* Avoid giving this message for a recursive call, may happen when
2090 * the GUI redraws part of the text. */
2091 ++recursive;
2092 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2093 --recursive;
2095 errorret:
2096 STRCPY(IObuff, "???");
2097 return IObuff;
2099 if (lnum <= 0) /* pretend line 0 is line 1 */
2100 lnum = 1;
2102 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2103 return (char_u *)"";
2106 * See if it is the same line as requested last time.
2107 * Otherwise may need to flush last used line.
2108 * Don't use the last used line when 'swapfile' is reset, need to load all
2109 * blocks.
2111 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2113 ml_flush_line(buf);
2116 * Find the data block containing the line.
2117 * This also fills the stack with the blocks from the root to the data
2118 * block and releases any locked block.
2120 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2122 if (recursive == 0)
2124 /* Avoid giving this message for a recursive call, may happen
2125 * when the GUI redraws part of the text. */
2126 ++recursive;
2127 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2128 --recursive;
2130 goto errorret;
2133 dp = (DATA_BL *)(hp->bh_data);
2135 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2136 buf->b_ml.ml_line_ptr = ptr;
2137 buf->b_ml.ml_line_lnum = lnum;
2138 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2140 if (will_change)
2141 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2143 return buf->b_ml.ml_line_ptr;
2147 * Check if a line that was just obtained by a call to ml_get
2148 * is in allocated memory.
2151 ml_line_alloced()
2153 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2157 * Append a line after lnum (may be 0 to insert a line in front of the file).
2158 * "line" does not need to be allocated, but can't be another line in a
2159 * buffer, unlocking may make it invalid.
2161 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2162 * will be set for recovery
2163 * Check: The caller of this function should probably also call
2164 * appended_lines().
2166 * return FAIL for failure, OK otherwise
2169 ml_append(lnum, line, len, newfile)
2170 linenr_T lnum; /* append after this line (can be 0) */
2171 char_u *line; /* text of the new line */
2172 colnr_T len; /* length of new line, including NUL, or 0 */
2173 int newfile; /* flag, see above */
2175 /* When starting up, we might still need to create the memfile */
2176 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2177 return FAIL;
2179 if (curbuf->b_ml.ml_line_lnum != 0)
2180 ml_flush_line(curbuf);
2181 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2184 #if defined(FEAT_SPELL) || defined(PROTO)
2186 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2187 * a memline.
2190 ml_append_buf(buf, lnum, line, len, newfile)
2191 buf_T *buf;
2192 linenr_T lnum; /* append after this line (can be 0) */
2193 char_u *line; /* text of the new line */
2194 colnr_T len; /* length of new line, including NUL, or 0 */
2195 int newfile; /* flag, see above */
2197 if (buf->b_ml.ml_mfp == NULL)
2198 return FAIL;
2200 if (buf->b_ml.ml_line_lnum != 0)
2201 ml_flush_line(buf);
2202 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2204 #endif
2206 static int
2207 ml_append_int(buf, lnum, line, len, newfile, mark)
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 line, including NUL, or 0 */
2212 int newfile; /* flag, see above */
2213 int mark; /* mark the new line */
2215 int i;
2216 int line_count; /* number of indexes in current block */
2217 int offset;
2218 int from, to;
2219 int space_needed; /* space needed for new line */
2220 int page_size;
2221 int page_count;
2222 int db_idx; /* index for lnum in data block */
2223 bhdr_T *hp;
2224 memfile_T *mfp;
2225 DATA_BL *dp;
2226 PTR_BL *pp;
2227 infoptr_T *ip;
2229 /* lnum out of range */
2230 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2231 return FAIL;
2233 if (lowest_marked && lowest_marked > lnum)
2234 lowest_marked = lnum + 1;
2236 if (len == 0)
2237 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2238 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2240 mfp = buf->b_ml.ml_mfp;
2241 page_size = mfp->mf_page_size;
2244 * find the data block containing the previous line
2245 * This also fills the stack with the blocks from the root to the data block
2246 * This also releases any locked block.
2248 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2249 ML_INSERT)) == NULL)
2250 return FAIL;
2252 buf->b_ml.ml_flags &= ~ML_EMPTY;
2254 if (lnum == 0) /* got line one instead, correct db_idx */
2255 db_idx = -1; /* careful, it is negative! */
2256 else
2257 db_idx = lnum - buf->b_ml.ml_locked_low;
2258 /* get line count before the insertion */
2259 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2261 dp = (DATA_BL *)(hp->bh_data);
2264 * If
2265 * - there is not enough room in the current block
2266 * - appending to the last line in the block
2267 * - not appending to the last line in the file
2268 * insert in front of the next block.
2270 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2271 && lnum < buf->b_ml.ml_line_count)
2274 * Now that the line is not going to be inserted in the block that we
2275 * expected, the line count has to be adjusted in the pointer blocks
2276 * by using ml_locked_lineadd.
2278 --(buf->b_ml.ml_locked_lineadd);
2279 --(buf->b_ml.ml_locked_high);
2280 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2281 return FAIL;
2283 db_idx = -1; /* careful, it is negative! */
2284 /* get line count before the insertion */
2285 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2286 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2288 dp = (DATA_BL *)(hp->bh_data);
2291 ++buf->b_ml.ml_line_count;
2293 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2296 * Insert new line in existing data block, or in data block allocated above.
2298 dp->db_txt_start -= len;
2299 dp->db_free -= space_needed;
2300 ++(dp->db_line_count);
2303 * move the text of the lines that follow to the front
2304 * adjust the indexes of the lines that follow
2306 if (line_count > db_idx + 1) /* if there are following lines */
2309 * Offset is the start of the previous line.
2310 * This will become the character just after the new line.
2312 if (db_idx < 0)
2313 offset = dp->db_txt_end;
2314 else
2315 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2316 mch_memmove((char *)dp + dp->db_txt_start,
2317 (char *)dp + dp->db_txt_start + len,
2318 (size_t)(offset - (dp->db_txt_start + len)));
2319 for (i = line_count - 1; i > db_idx; --i)
2320 dp->db_index[i + 1] = dp->db_index[i] - len;
2321 dp->db_index[db_idx + 1] = offset - len;
2323 else /* add line at the end */
2324 dp->db_index[db_idx + 1] = dp->db_txt_start;
2327 * copy the text into the block
2329 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2330 if (mark)
2331 dp->db_index[db_idx + 1] |= DB_MARKED;
2334 * Mark the block dirty.
2336 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2337 if (!newfile)
2338 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2340 else /* not enough space in data block */
2343 * If there is not enough room we have to create a new data block and copy some
2344 * lines into it.
2345 * Then we have to insert an entry in the pointer block.
2346 * If this pointer block also is full, we go up another block, and so on, up
2347 * to the root if necessary.
2348 * The line counts in the pointer blocks have already been adjusted by
2349 * ml_find_line().
2351 long line_count_left, line_count_right;
2352 int page_count_left, page_count_right;
2353 bhdr_T *hp_left;
2354 bhdr_T *hp_right;
2355 bhdr_T *hp_new;
2356 int lines_moved;
2357 int data_moved = 0; /* init to shut up gcc */
2358 int total_moved = 0; /* init to shut up gcc */
2359 DATA_BL *dp_right, *dp_left;
2360 int stack_idx;
2361 int in_left;
2362 int lineadd;
2363 blocknr_T bnum_left, bnum_right;
2364 linenr_T lnum_left, lnum_right;
2365 int pb_idx;
2366 PTR_BL *pp_new;
2369 * We are going to allocate a new data block. Depending on the
2370 * situation it will be put to the left or right of the existing
2371 * block. If possible we put the new line in the left block and move
2372 * the lines after it to the right block. Otherwise the new line is
2373 * also put in the right block. This method is more efficient when
2374 * inserting a lot of lines at one place.
2376 if (db_idx < 0) /* left block is new, right block is existing */
2378 lines_moved = 0;
2379 in_left = TRUE;
2380 /* space_needed does not change */
2382 else /* left block is existing, right block is new */
2384 lines_moved = line_count - db_idx - 1;
2385 if (lines_moved == 0)
2386 in_left = FALSE; /* put new line in right block */
2387 /* space_needed does not change */
2388 else
2390 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2391 dp->db_txt_start;
2392 total_moved = data_moved + lines_moved * INDEX_SIZE;
2393 if ((int)dp->db_free + total_moved >= space_needed)
2395 in_left = TRUE; /* put new line in left block */
2396 space_needed = total_moved;
2398 else
2400 in_left = FALSE; /* put new line in right block */
2401 space_needed += total_moved;
2406 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2407 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2409 /* correct line counts in pointer blocks */
2410 --(buf->b_ml.ml_locked_lineadd);
2411 --(buf->b_ml.ml_locked_high);
2412 return FAIL;
2414 if (db_idx < 0) /* left block is new */
2416 hp_left = hp_new;
2417 hp_right = hp;
2418 line_count_left = 0;
2419 line_count_right = line_count;
2421 else /* right block is new */
2423 hp_left = hp;
2424 hp_right = hp_new;
2425 line_count_left = line_count;
2426 line_count_right = 0;
2428 dp_right = (DATA_BL *)(hp_right->bh_data);
2429 dp_left = (DATA_BL *)(hp_left->bh_data);
2430 bnum_left = hp_left->bh_bnum;
2431 bnum_right = hp_right->bh_bnum;
2432 page_count_left = hp_left->bh_page_count;
2433 page_count_right = hp_right->bh_page_count;
2436 * May move the new line into the right/new block.
2438 if (!in_left)
2440 dp_right->db_txt_start -= len;
2441 dp_right->db_free -= len + INDEX_SIZE;
2442 dp_right->db_index[0] = dp_right->db_txt_start;
2443 if (mark)
2444 dp_right->db_index[0] |= DB_MARKED;
2446 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2447 line, (size_t)len);
2448 ++line_count_right;
2451 * may move lines from the left/old block to the right/new one.
2453 if (lines_moved)
2457 dp_right->db_txt_start -= data_moved;
2458 dp_right->db_free -= total_moved;
2459 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2460 (char *)dp_left + dp_left->db_txt_start,
2461 (size_t)data_moved);
2462 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2463 dp_left->db_txt_start += data_moved;
2464 dp_left->db_free += total_moved;
2467 * update indexes in the new block
2469 for (to = line_count_right, from = db_idx + 1;
2470 from < line_count_left; ++from, ++to)
2471 dp_right->db_index[to] = dp->db_index[from] + offset;
2472 line_count_right += lines_moved;
2473 line_count_left -= lines_moved;
2477 * May move the new line into the left (old or new) block.
2479 if (in_left)
2481 dp_left->db_txt_start -= len;
2482 dp_left->db_free -= len + INDEX_SIZE;
2483 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2484 if (mark)
2485 dp_left->db_index[line_count_left] |= DB_MARKED;
2486 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2487 line, (size_t)len);
2488 ++line_count_left;
2491 if (db_idx < 0) /* left block is new */
2493 lnum_left = lnum + 1;
2494 lnum_right = 0;
2496 else /* right block is new */
2498 lnum_left = 0;
2499 if (in_left)
2500 lnum_right = lnum + 2;
2501 else
2502 lnum_right = lnum + 1;
2504 dp_left->db_line_count = line_count_left;
2505 dp_right->db_line_count = line_count_right;
2508 * release the two data blocks
2509 * The new one (hp_new) already has a correct blocknumber.
2510 * The old one (hp, in ml_locked) gets a positive blocknumber if
2511 * we changed it and we are not editing a new file.
2513 if (lines_moved || in_left)
2514 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2515 if (!newfile && db_idx >= 0 && in_left)
2516 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2517 mf_put(mfp, hp_new, TRUE, FALSE);
2520 * flush the old data block
2521 * set ml_locked_lineadd to 0, because the updating of the
2522 * pointer blocks is done below
2524 lineadd = buf->b_ml.ml_locked_lineadd;
2525 buf->b_ml.ml_locked_lineadd = 0;
2526 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2529 * update pointer blocks for the new data block
2531 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2532 --stack_idx)
2534 ip = &(buf->b_ml.ml_stack[stack_idx]);
2535 pb_idx = ip->ip_index;
2536 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2537 return FAIL;
2538 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2539 if (pp->pb_id != PTR_ID)
2541 EMSG(_("E317: pointer block id wrong 3"));
2542 mf_put(mfp, hp, FALSE, FALSE);
2543 return FAIL;
2546 * TODO: If the pointer block is full and we are adding at the end
2547 * try to insert in front of the next block
2549 /* block not full, add one entry */
2550 if (pp->pb_count < pp->pb_count_max)
2552 if (pb_idx + 1 < (int)pp->pb_count)
2553 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2554 &pp->pb_pointer[pb_idx + 1],
2555 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2556 ++pp->pb_count;
2557 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2558 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2559 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2560 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2561 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2562 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2564 if (lnum_left != 0)
2565 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2566 if (lnum_right != 0)
2567 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2569 mf_put(mfp, hp, TRUE, FALSE);
2570 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2572 if (lineadd)
2574 --(buf->b_ml.ml_stack_top);
2575 /* fix line count for rest of blocks in the stack */
2576 ml_lineadd(buf, lineadd);
2577 /* fix stack itself */
2578 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2579 lineadd;
2580 ++(buf->b_ml.ml_stack_top);
2584 * We are finished, break the loop here.
2586 break;
2588 else /* pointer block full */
2591 * split the pointer block
2592 * allocate a new pointer block
2593 * move some of the pointer into the new block
2594 * prepare for updating the parent block
2596 for (;;) /* do this twice when splitting block 1 */
2598 hp_new = ml_new_ptr(mfp);
2599 if (hp_new == NULL) /* TODO: try to fix tree */
2600 return FAIL;
2601 pp_new = (PTR_BL *)(hp_new->bh_data);
2603 if (hp->bh_bnum != 1)
2604 break;
2607 * if block 1 becomes full the tree is given an extra level
2608 * The pointers from block 1 are moved into the new block.
2609 * block 1 is updated to point to the new block
2610 * then continue to split the new block
2612 mch_memmove(pp_new, pp, (size_t)page_size);
2613 pp->pb_count = 1;
2614 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2615 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2616 pp->pb_pointer[0].pe_old_lnum = 1;
2617 pp->pb_pointer[0].pe_page_count = 1;
2618 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2619 hp = hp_new; /* new block is to be split */
2620 pp = pp_new;
2621 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2622 ip->ip_index = 0;
2623 ++stack_idx; /* do block 1 again later */
2626 * move the pointers after the current one to the new block
2627 * If there are none, the new entry will be in the new block.
2629 total_moved = pp->pb_count - pb_idx - 1;
2630 if (total_moved)
2632 mch_memmove(&pp_new->pb_pointer[0],
2633 &pp->pb_pointer[pb_idx + 1],
2634 (size_t)(total_moved) * sizeof(PTR_EN));
2635 pp_new->pb_count = total_moved;
2636 pp->pb_count -= total_moved - 1;
2637 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2638 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2639 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2640 if (lnum_right)
2641 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2643 else
2645 pp_new->pb_count = 1;
2646 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2647 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2648 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2649 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2651 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2652 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2653 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2654 if (lnum_left)
2655 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2656 lnum_left = 0;
2657 lnum_right = 0;
2660 * recompute line counts
2662 line_count_right = 0;
2663 for (i = 0; i < (int)pp_new->pb_count; ++i)
2664 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2665 line_count_left = 0;
2666 for (i = 0; i < (int)pp->pb_count; ++i)
2667 line_count_left += pp->pb_pointer[i].pe_line_count;
2669 bnum_left = hp->bh_bnum;
2670 bnum_right = hp_new->bh_bnum;
2671 page_count_left = 1;
2672 page_count_right = 1;
2673 mf_put(mfp, hp, TRUE, FALSE);
2674 mf_put(mfp, hp_new, TRUE, FALSE);
2679 * Safety check: fallen out of for loop?
2681 if (stack_idx < 0)
2683 EMSG(_("E318: Updated too many blocks?"));
2684 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2688 #ifdef FEAT_BYTEOFF
2689 /* The line was inserted below 'lnum' */
2690 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2691 #endif
2692 #ifdef FEAT_NETBEANS_INTG
2693 if (usingNetbeans)
2695 if (STRLEN(line) > 0)
2696 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2697 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2698 (char_u *)"\n", 1);
2700 #endif
2701 return OK;
2705 * Replace line lnum, with buffering, in current buffer.
2707 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2708 * copied to allocated memory already.
2710 * Check: The caller of this function should probably also call
2711 * changed_lines(), unless update_screen(NOT_VALID) is used.
2713 * return FAIL for failure, OK otherwise
2716 ml_replace(lnum, line, copy)
2717 linenr_T lnum;
2718 char_u *line;
2719 int copy;
2721 if (line == NULL) /* just checking... */
2722 return FAIL;
2724 /* When starting up, we might still need to create the memfile */
2725 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2726 return FAIL;
2728 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2729 return FAIL;
2730 #ifdef FEAT_NETBEANS_INTG
2731 if (usingNetbeans)
2733 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2734 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2736 #endif
2737 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2738 ml_flush_line(curbuf); /* flush it */
2739 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2740 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2741 curbuf->b_ml.ml_line_ptr = line;
2742 curbuf->b_ml.ml_line_lnum = lnum;
2743 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2745 return OK;
2749 * Delete line 'lnum' in the current buffer.
2751 * Check: The caller of this function should probably also call
2752 * deleted_lines() after this.
2754 * return FAIL for failure, OK otherwise
2757 ml_delete(lnum, message)
2758 linenr_T lnum;
2759 int message;
2761 ml_flush_line(curbuf);
2762 return ml_delete_int(curbuf, lnum, message);
2765 static int
2766 ml_delete_int(buf, lnum, message)
2767 buf_T *buf;
2768 linenr_T lnum;
2769 int message;
2771 bhdr_T *hp;
2772 memfile_T *mfp;
2773 DATA_BL *dp;
2774 PTR_BL *pp;
2775 infoptr_T *ip;
2776 int count; /* number of entries in block */
2777 int idx;
2778 int stack_idx;
2779 int text_start;
2780 int line_start;
2781 long line_size;
2782 int i;
2784 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2785 return FAIL;
2787 if (lowest_marked && lowest_marked > lnum)
2788 lowest_marked--;
2791 * If the file becomes empty the last line is replaced by an empty line.
2793 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2795 if (message
2796 #ifdef FEAT_NETBEANS_INTG
2797 && !netbeansSuppressNoLines
2798 #endif
2800 set_keep_msg((char_u *)_(no_lines_msg), 0);
2802 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2803 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2804 buf->b_ml.ml_flags |= ML_EMPTY;
2806 return i;
2810 * find the data block containing the line
2811 * This also fills the stack with the blocks from the root to the data block
2812 * This also releases any locked block.
2814 mfp = buf->b_ml.ml_mfp;
2815 if (mfp == NULL)
2816 return FAIL;
2818 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2819 return FAIL;
2821 dp = (DATA_BL *)(hp->bh_data);
2822 /* compute line count before the delete */
2823 count = (long)(buf->b_ml.ml_locked_high)
2824 - (long)(buf->b_ml.ml_locked_low) + 2;
2825 idx = lnum - buf->b_ml.ml_locked_low;
2827 --buf->b_ml.ml_line_count;
2829 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2830 if (idx == 0) /* first line in block, text at the end */
2831 line_size = dp->db_txt_end - line_start;
2832 else
2833 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2835 #ifdef FEAT_NETBEANS_INTG
2836 if (usingNetbeans)
2837 netbeans_removed(buf, lnum, 0, (long)line_size);
2838 #endif
2841 * special case: If there is only one line in the data block it becomes empty.
2842 * Then we have to remove the entry, pointing to this data block, from the
2843 * pointer block. If this pointer block also becomes empty, we go up another
2844 * block, and so on, up to the root if necessary.
2845 * The line counts in the pointer blocks have already been adjusted by
2846 * ml_find_line().
2848 if (count == 1)
2850 mf_free(mfp, hp); /* free the data block */
2851 buf->b_ml.ml_locked = NULL;
2853 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2855 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2856 ip = &(buf->b_ml.ml_stack[stack_idx]);
2857 idx = ip->ip_index;
2858 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2859 return FAIL;
2860 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2861 if (pp->pb_id != PTR_ID)
2863 EMSG(_("E317: pointer block id wrong 4"));
2864 mf_put(mfp, hp, FALSE, FALSE);
2865 return FAIL;
2867 count = --(pp->pb_count);
2868 if (count == 0) /* the pointer block becomes empty! */
2869 mf_free(mfp, hp);
2870 else
2872 if (count != idx) /* move entries after the deleted one */
2873 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2874 (size_t)(count - idx) * sizeof(PTR_EN));
2875 mf_put(mfp, hp, TRUE, FALSE);
2877 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2878 /* fix line count for rest of blocks in the stack */
2879 if (buf->b_ml.ml_locked_lineadd != 0)
2881 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2882 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2883 buf->b_ml.ml_locked_lineadd;
2885 ++(buf->b_ml.ml_stack_top);
2887 break;
2890 CHECK(stack_idx < 0, _("deleted block 1?"));
2892 else
2895 * delete the text by moving the next lines forwards
2897 text_start = dp->db_txt_start;
2898 mch_memmove((char *)dp + text_start + line_size,
2899 (char *)dp + text_start, (size_t)(line_start - text_start));
2902 * delete the index by moving the next indexes backwards
2903 * Adjust the indexes for the text movement.
2905 for (i = idx; i < count - 1; ++i)
2906 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2908 dp->db_free += line_size + INDEX_SIZE;
2909 dp->db_txt_start += line_size;
2910 --(dp->db_line_count);
2913 * mark the block dirty and make sure it is in the file (for recovery)
2915 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2918 #ifdef FEAT_BYTEOFF
2919 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2920 #endif
2921 return OK;
2925 * set the B_MARKED flag for line 'lnum'
2927 void
2928 ml_setmarked(lnum)
2929 linenr_T lnum;
2931 bhdr_T *hp;
2932 DATA_BL *dp;
2933 /* invalid line number */
2934 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2935 || curbuf->b_ml.ml_mfp == NULL)
2936 return; /* give error message? */
2938 if (lowest_marked == 0 || lowest_marked > lnum)
2939 lowest_marked = lnum;
2942 * find the data block containing the line
2943 * This also fills the stack with the blocks from the root to the data block
2944 * This also releases any locked block.
2946 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2947 return; /* give error message? */
2949 dp = (DATA_BL *)(hp->bh_data);
2950 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2951 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2955 * find the first line with its B_MARKED flag set
2957 linenr_T
2958 ml_firstmarked()
2960 bhdr_T *hp;
2961 DATA_BL *dp;
2962 linenr_T lnum;
2963 int i;
2965 if (curbuf->b_ml.ml_mfp == NULL)
2966 return (linenr_T) 0;
2969 * The search starts with lowest_marked line. This is the last line where
2970 * a mark was found, adjusted by inserting/deleting lines.
2972 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
2975 * Find the data block containing the line.
2976 * This also fills the stack with the blocks from the root to the data
2977 * block This also releases any locked block.
2979 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2980 return (linenr_T)0; /* give error message? */
2982 dp = (DATA_BL *)(hp->bh_data);
2984 for (i = lnum - curbuf->b_ml.ml_locked_low;
2985 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
2986 if ((dp->db_index[i]) & DB_MARKED)
2988 (dp->db_index[i]) &= DB_INDEX_MASK;
2989 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2990 lowest_marked = lnum + 1;
2991 return lnum;
2995 return (linenr_T) 0;
2998 #if 0 /* not used */
3000 * return TRUE if line 'lnum' has a mark
3003 ml_has_mark(lnum)
3004 linenr_T lnum;
3006 bhdr_T *hp;
3007 DATA_BL *dp;
3009 if (curbuf->b_ml.ml_mfp == NULL
3010 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3011 return FALSE;
3013 dp = (DATA_BL *)(hp->bh_data);
3014 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3016 #endif
3019 * clear all DB_MARKED flags
3021 void
3022 ml_clearmarked()
3024 bhdr_T *hp;
3025 DATA_BL *dp;
3026 linenr_T lnum;
3027 int i;
3029 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3030 return;
3033 * The search starts with line lowest_marked.
3035 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3038 * Find the data block containing the line.
3039 * This also fills the stack with the blocks from the root to the data
3040 * block and releases any locked block.
3042 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3043 return; /* give error message? */
3045 dp = (DATA_BL *)(hp->bh_data);
3047 for (i = lnum - curbuf->b_ml.ml_locked_low;
3048 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3049 if ((dp->db_index[i]) & DB_MARKED)
3051 (dp->db_index[i]) &= DB_INDEX_MASK;
3052 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3056 lowest_marked = 0;
3057 return;
3061 * flush ml_line if necessary
3063 static void
3064 ml_flush_line(buf)
3065 buf_T *buf;
3067 bhdr_T *hp;
3068 DATA_BL *dp;
3069 linenr_T lnum;
3070 char_u *new_line;
3071 char_u *old_line;
3072 colnr_T new_len;
3073 int old_len;
3074 int extra;
3075 int idx;
3076 int start;
3077 int count;
3078 int i;
3080 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3081 return; /* nothing to do */
3083 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3085 lnum = buf->b_ml.ml_line_lnum;
3086 new_line = buf->b_ml.ml_line_ptr;
3088 hp = ml_find_line(buf, lnum, ML_FIND);
3089 if (hp == NULL)
3090 EMSGN(_("E320: Cannot find line %ld"), lnum);
3091 else
3093 dp = (DATA_BL *)(hp->bh_data);
3094 idx = lnum - buf->b_ml.ml_locked_low;
3095 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3096 old_line = (char_u *)dp + start;
3097 if (idx == 0) /* line is last in block */
3098 old_len = dp->db_txt_end - start;
3099 else /* text of previous line follows */
3100 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3101 new_len = (colnr_T)STRLEN(new_line) + 1;
3102 extra = new_len - old_len; /* negative if lines gets smaller */
3105 * if new line fits in data block, replace directly
3107 if ((int)dp->db_free >= extra)
3109 /* if the length changes and there are following lines */
3110 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3111 if (extra != 0 && idx < count - 1)
3113 /* move text of following lines */
3114 mch_memmove((char *)dp + dp->db_txt_start - extra,
3115 (char *)dp + dp->db_txt_start,
3116 (size_t)(start - dp->db_txt_start));
3118 /* adjust pointers of this and following lines */
3119 for (i = idx + 1; i < count; ++i)
3120 dp->db_index[i] -= extra;
3122 dp->db_index[idx] -= extra;
3124 /* adjust free space */
3125 dp->db_free -= extra;
3126 dp->db_txt_start -= extra;
3128 /* copy new line into the data block */
3129 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3130 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3131 #ifdef FEAT_BYTEOFF
3132 /* The else case is already covered by the insert and delete */
3133 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3134 #endif
3136 else
3139 * Cannot do it in one data block: Delete and append.
3140 * Append first, because ml_delete_int() cannot delete the
3141 * last line in a buffer, which causes trouble for a buffer
3142 * that has only one line.
3143 * Don't forget to copy the mark!
3145 /* How about handling errors??? */
3146 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3147 (dp->db_index[idx] & DB_MARKED));
3148 (void)ml_delete_int(buf, lnum, FALSE);
3151 vim_free(new_line);
3154 buf->b_ml.ml_line_lnum = 0;
3158 * create a new, empty, data block
3160 static bhdr_T *
3161 ml_new_data(mfp, negative, page_count)
3162 memfile_T *mfp;
3163 int negative;
3164 int page_count;
3166 bhdr_T *hp;
3167 DATA_BL *dp;
3169 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3170 return NULL;
3172 dp = (DATA_BL *)(hp->bh_data);
3173 dp->db_id = DATA_ID;
3174 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3175 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3176 dp->db_line_count = 0;
3178 return hp;
3182 * create a new, empty, pointer block
3184 static bhdr_T *
3185 ml_new_ptr(mfp)
3186 memfile_T *mfp;
3188 bhdr_T *hp;
3189 PTR_BL *pp;
3191 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3192 return NULL;
3194 pp = (PTR_BL *)(hp->bh_data);
3195 pp->pb_id = PTR_ID;
3196 pp->pb_count = 0;
3197 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3199 return hp;
3203 * lookup line 'lnum' in a memline
3205 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3206 * if ML_FLUSH only flush a locked block
3207 * if ML_FIND just find the line
3209 * If the block was found it is locked and put in ml_locked.
3210 * The stack is updated to lead to the locked block. The ip_high field in
3211 * the stack is updated to reflect the last line in the block AFTER the
3212 * insert or delete, also if the pointer block has not been updated yet. But
3213 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3215 * return: NULL for failure, pointer to block header otherwise
3217 static bhdr_T *
3218 ml_find_line(buf, lnum, action)
3219 buf_T *buf;
3220 linenr_T lnum;
3221 int action;
3223 DATA_BL *dp;
3224 PTR_BL *pp;
3225 infoptr_T *ip;
3226 bhdr_T *hp;
3227 memfile_T *mfp;
3228 linenr_T t;
3229 blocknr_T bnum, bnum2;
3230 int dirty;
3231 linenr_T low, high;
3232 int top;
3233 int page_count;
3234 int idx;
3236 mfp = buf->b_ml.ml_mfp;
3239 * If there is a locked block check if the wanted line is in it.
3240 * If not, flush and release the locked block.
3241 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3242 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3243 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3245 if (buf->b_ml.ml_locked)
3247 if (ML_SIMPLE(action)
3248 && buf->b_ml.ml_locked_low <= lnum
3249 && buf->b_ml.ml_locked_high >= lnum
3250 && !mf_dont_release)
3252 /* remember to update pointer blocks and stack later */
3253 if (action == ML_INSERT)
3255 ++(buf->b_ml.ml_locked_lineadd);
3256 ++(buf->b_ml.ml_locked_high);
3258 else if (action == ML_DELETE)
3260 --(buf->b_ml.ml_locked_lineadd);
3261 --(buf->b_ml.ml_locked_high);
3263 return (buf->b_ml.ml_locked);
3266 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3267 buf->b_ml.ml_flags & ML_LOCKED_POS);
3268 buf->b_ml.ml_locked = NULL;
3271 * If lines have been added or deleted in the locked block, need to
3272 * update the line count in pointer blocks.
3274 if (buf->b_ml.ml_locked_lineadd != 0)
3275 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3278 if (action == ML_FLUSH) /* nothing else to do */
3279 return NULL;
3281 bnum = 1; /* start at the root of the tree */
3282 page_count = 1;
3283 low = 1;
3284 high = buf->b_ml.ml_line_count;
3286 if (action == ML_FIND) /* first try stack entries */
3288 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3290 ip = &(buf->b_ml.ml_stack[top]);
3291 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3293 bnum = ip->ip_bnum;
3294 low = ip->ip_low;
3295 high = ip->ip_high;
3296 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3297 break;
3300 if (top < 0)
3301 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3303 else /* ML_DELETE or ML_INSERT */
3304 buf->b_ml.ml_stack_top = 0; /* start at the root */
3307 * search downwards in the tree until a data block is found
3309 for (;;)
3311 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3312 goto error_noblock;
3315 * update high for insert/delete
3317 if (action == ML_INSERT)
3318 ++high;
3319 else if (action == ML_DELETE)
3320 --high;
3322 dp = (DATA_BL *)(hp->bh_data);
3323 if (dp->db_id == DATA_ID) /* data block */
3325 buf->b_ml.ml_locked = hp;
3326 buf->b_ml.ml_locked_low = low;
3327 buf->b_ml.ml_locked_high = high;
3328 buf->b_ml.ml_locked_lineadd = 0;
3329 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3330 return hp;
3333 pp = (PTR_BL *)(dp); /* must be pointer block */
3334 if (pp->pb_id != PTR_ID)
3336 EMSG(_("E317: pointer block id wrong"));
3337 goto error_block;
3340 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3341 goto error_block;
3342 ip = &(buf->b_ml.ml_stack[top]);
3343 ip->ip_bnum = bnum;
3344 ip->ip_low = low;
3345 ip->ip_high = high;
3346 ip->ip_index = -1; /* index not known yet */
3348 dirty = FALSE;
3349 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3351 t = pp->pb_pointer[idx].pe_line_count;
3352 CHECK(t == 0, _("pe_line_count is zero"));
3353 if ((low += t) > lnum)
3355 ip->ip_index = idx;
3356 bnum = pp->pb_pointer[idx].pe_bnum;
3357 page_count = pp->pb_pointer[idx].pe_page_count;
3358 high = low - 1;
3359 low -= t;
3362 * a negative block number may have been changed
3364 if (bnum < 0)
3366 bnum2 = mf_trans_del(mfp, bnum);
3367 if (bnum != bnum2)
3369 bnum = bnum2;
3370 pp->pb_pointer[idx].pe_bnum = bnum;
3371 dirty = TRUE;
3375 break;
3378 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3380 if (lnum > buf->b_ml.ml_line_count)
3381 EMSGN(_("E322: line number out of range: %ld past the end"),
3382 lnum - buf->b_ml.ml_line_count);
3384 else
3385 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3386 goto error_block;
3388 if (action == ML_DELETE)
3390 pp->pb_pointer[idx].pe_line_count--;
3391 dirty = TRUE;
3393 else if (action == ML_INSERT)
3395 pp->pb_pointer[idx].pe_line_count++;
3396 dirty = TRUE;
3398 mf_put(mfp, hp, dirty, FALSE);
3401 error_block:
3402 mf_put(mfp, hp, FALSE, FALSE);
3403 error_noblock:
3405 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3406 * the incremented/decremented line counts, because there won't be a line
3407 * inserted/deleted after all.
3409 if (action == ML_DELETE)
3410 ml_lineadd(buf, 1);
3411 else if (action == ML_INSERT)
3412 ml_lineadd(buf, -1);
3413 buf->b_ml.ml_stack_top = 0;
3414 return NULL;
3418 * add an entry to the info pointer stack
3420 * return -1 for failure, number of the new entry otherwise
3422 static int
3423 ml_add_stack(buf)
3424 buf_T *buf;
3426 int top;
3427 infoptr_T *newstack;
3429 top = buf->b_ml.ml_stack_top;
3431 /* may have to increase the stack size */
3432 if (top == buf->b_ml.ml_stack_size)
3434 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3436 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3437 (buf->b_ml.ml_stack_size + STACK_INCR));
3438 if (newstack == NULL)
3439 return -1;
3440 mch_memmove(newstack, buf->b_ml.ml_stack,
3441 (size_t)top * sizeof(infoptr_T));
3442 vim_free(buf->b_ml.ml_stack);
3443 buf->b_ml.ml_stack = newstack;
3444 buf->b_ml.ml_stack_size += STACK_INCR;
3447 buf->b_ml.ml_stack_top++;
3448 return top;
3452 * Update the pointer blocks on the stack for inserted/deleted lines.
3453 * The stack itself is also updated.
3455 * When a insert/delete line action fails, the line is not inserted/deleted,
3456 * but the pointer blocks have already been updated. That is fixed here by
3457 * walking through the stack.
3459 * Count is the number of lines added, negative if lines have been deleted.
3461 static void
3462 ml_lineadd(buf, count)
3463 buf_T *buf;
3464 int count;
3466 int idx;
3467 infoptr_T *ip;
3468 PTR_BL *pp;
3469 memfile_T *mfp = buf->b_ml.ml_mfp;
3470 bhdr_T *hp;
3472 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3474 ip = &(buf->b_ml.ml_stack[idx]);
3475 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3476 break;
3477 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3478 if (pp->pb_id != PTR_ID)
3480 mf_put(mfp, hp, FALSE, FALSE);
3481 EMSG(_("E317: pointer block id wrong 2"));
3482 break;
3484 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3485 ip->ip_high += count;
3486 mf_put(mfp, hp, TRUE, FALSE);
3490 #ifdef HAVE_READLINK
3491 static int resolve_symlink __ARGS((char_u *fname, char_u *buf));
3494 * Resolve a symlink in the last component of a file name.
3495 * Note that f_resolve() does it for every part of the path, we don't do that
3496 * here.
3497 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3498 * Otherwise returns FAIL.
3500 static int
3501 resolve_symlink(fname, buf)
3502 char_u *fname;
3503 char_u *buf;
3505 char_u tmp[MAXPATHL];
3506 int ret;
3507 int depth = 0;
3509 if (fname == NULL)
3510 return FAIL;
3512 /* Put the result so far in tmp[], starting with the original name. */
3513 vim_strncpy(tmp, fname, MAXPATHL - 1);
3515 for (;;)
3517 /* Limit symlink depth to 100, catch recursive loops. */
3518 if (++depth == 100)
3520 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3521 return FAIL;
3524 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3525 if (ret <= 0)
3527 if (errno == EINVAL || errno == ENOENT)
3529 /* Found non-symlink or not existing file, stop here.
3530 * When at the first level use the unmodified name, skip the
3531 * call to vim_FullName(). */
3532 if (depth == 1)
3533 return FAIL;
3535 /* Use the resolved name in tmp[]. */
3536 break;
3539 /* There must be some error reading links, use original name. */
3540 return FAIL;
3542 buf[ret] = NUL;
3545 * Check whether the symlink is relative or absolute.
3546 * If it's relative, build a new path based on the directory
3547 * portion of the filename (if any) and the path the symlink
3548 * points to.
3550 if (mch_isFullName(buf))
3551 STRCPY(tmp, buf);
3552 else
3554 char_u *tail;
3556 tail = gettail(tmp);
3557 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3558 return FAIL;
3559 STRCPY(tail, buf);
3564 * Try to resolve the full name of the file so that the swapfile name will
3565 * be consistent even when opening a relative symlink from different
3566 * working directories.
3568 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3570 #endif
3573 * Make swap file name out of the file name and a directory name.
3574 * Returns pointer to allocated memory or NULL.
3576 /*ARGSUSED*/
3577 char_u *
3578 makeswapname(fname, ffname, buf, dir_name)
3579 char_u *fname;
3580 char_u *ffname;
3581 buf_T *buf;
3582 char_u *dir_name;
3584 char_u *r, *s;
3585 #ifdef HAVE_READLINK
3586 char_u fname_buf[MAXPATHL];
3587 char_u *fname_res;
3588 #endif
3590 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3591 s = dir_name + STRLEN(dir_name);
3592 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3593 { /* Ends with '//', Use Full path */
3594 r = NULL;
3595 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3597 r = modname(s, (char_u *)".swp", FALSE);
3598 vim_free(s);
3600 return r;
3602 #endif
3604 #ifdef HAVE_READLINK
3605 /* Expand symlink in the file name, so that we put the swap file with the
3606 * actual file instead of with the symlink. */
3607 if (resolve_symlink(fname, fname_buf) == OK)
3608 fname_res = fname_buf;
3609 else
3610 fname_res = fname;
3611 #endif
3613 r = buf_modname(
3614 #ifdef SHORT_FNAME
3615 TRUE,
3616 #else
3617 (buf->b_p_sn || buf->b_shortname),
3618 #endif
3619 #ifdef RISCOS
3620 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3621 ffname,
3622 #else
3623 # ifdef HAVE_READLINK
3624 fname_res,
3625 # else
3626 fname,
3627 # endif
3628 #endif
3629 (char_u *)
3630 #if defined(VMS) || defined(RISCOS)
3631 "_swp",
3632 #else
3633 ".swp",
3634 #endif
3635 #ifdef SHORT_FNAME /* always 8.3 file name */
3636 FALSE
3637 #else
3638 /* Prepend a '.' to the swap file name for the current directory. */
3639 dir_name[0] == '.' && dir_name[1] == NUL
3640 #endif
3642 if (r == NULL) /* out of memory */
3643 return NULL;
3645 s = get_file_in_dir(r, dir_name);
3646 vim_free(r);
3647 return s;
3651 * Get file name to use for swap file or backup file.
3652 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3653 * option "dname".
3654 * - If "dname" is ".", return "fname" (swap file in dir of file).
3655 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3656 * relative to dir of file).
3657 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3658 * dir).
3660 * The return value is an allocated string and can be NULL.
3662 char_u *
3663 get_file_in_dir(fname, dname)
3664 char_u *fname;
3665 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3667 char_u *t;
3668 char_u *tail;
3669 char_u *retval;
3670 int save_char;
3672 tail = gettail(fname);
3674 if (dname[0] == '.' && dname[1] == NUL)
3675 retval = vim_strsave(fname);
3676 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3678 if (tail == fname) /* no path before file name */
3679 retval = concat_fnames(dname + 2, tail, TRUE);
3680 else
3682 save_char = *tail;
3683 *tail = NUL;
3684 t = concat_fnames(fname, dname + 2, TRUE);
3685 *tail = save_char;
3686 if (t == NULL) /* out of memory */
3687 retval = NULL;
3688 else
3690 retval = concat_fnames(t, tail, TRUE);
3691 vim_free(t);
3695 else
3696 retval = concat_fnames(dname, tail, TRUE);
3698 return retval;
3701 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3704 * Print the ATTENTION message: info about an existing swap file.
3706 static void
3707 attention_message(buf, fname)
3708 buf_T *buf; /* buffer being edited */
3709 char_u *fname; /* swap file name */
3711 struct stat st;
3712 time_t x, sx;
3713 char *p;
3715 ++no_wait_return;
3716 (void)EMSG(_("E325: ATTENTION"));
3717 MSG_PUTS(_("\nFound a swap file by the name \""));
3718 msg_home_replace(fname);
3719 MSG_PUTS("\"\n");
3720 sx = swapfile_info(fname);
3721 MSG_PUTS(_("While opening file \""));
3722 msg_outtrans(buf->b_fname);
3723 MSG_PUTS("\"\n");
3724 if (mch_stat((char *)buf->b_fname, &st) != -1)
3726 MSG_PUTS(_(" dated: "));
3727 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3728 p = ctime(&x); /* includes '\n' */
3729 if (p == NULL)
3730 MSG_PUTS("(invalid)\n");
3731 else
3732 MSG_PUTS(p);
3733 if (sx != 0 && x > sx)
3734 MSG_PUTS(_(" NEWER than swap file!\n"));
3736 /* Some of these messages are long to allow translation to
3737 * other languages. */
3738 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"));
3739 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3740 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3741 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3742 msg_outtrans(buf->b_fname);
3743 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3744 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3745 msg_outtrans(fname);
3746 MSG_PUTS(_("\"\n to avoid this message.\n"));
3747 cmdline_row = msg_row;
3748 --no_wait_return;
3751 #ifdef FEAT_AUTOCMD
3752 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3755 * Trigger the SwapExists autocommands.
3756 * Returns a value for equivalent to do_dialog() (see below):
3757 * 0: still need to ask for a choice
3758 * 1: open read-only
3759 * 2: edit anyway
3760 * 3: recover
3761 * 4: delete it
3762 * 5: quit
3763 * 6: abort
3765 static int
3766 do_swapexists(buf, fname)
3767 buf_T *buf;
3768 char_u *fname;
3770 set_vim_var_string(VV_SWAPNAME, fname, -1);
3771 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3773 /* Trigger SwapExists autocommands with <afile> set to the file being
3774 * edited. Disallow changing directory here. */
3775 ++allbuf_lock;
3776 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3777 --allbuf_lock;
3779 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3781 switch (*get_vim_var_str(VV_SWAPCHOICE))
3783 case 'o': return 1;
3784 case 'e': return 2;
3785 case 'r': return 3;
3786 case 'd': return 4;
3787 case 'q': return 5;
3788 case 'a': return 6;
3791 return 0;
3793 #endif
3796 * Find out what name to use for the swap file for buffer 'buf'.
3798 * Several names are tried to find one that does not exist
3799 * Returns the name in allocated memory or NULL.
3801 * Note: If BASENAMELEN is not correct, you will get error messages for
3802 * not being able to open the swapfile
3803 * Note: May trigger SwapExists autocmd, pointers may change!
3805 static char_u *
3806 findswapname(buf, dirp, old_fname)
3807 buf_T *buf;
3808 char_u **dirp; /* pointer to list of directories */
3809 char_u *old_fname; /* don't give warning for this file name */
3811 char_u *fname;
3812 int n;
3813 char_u *dir_name;
3814 #ifdef AMIGA
3815 BPTR fh;
3816 #endif
3817 #ifndef SHORT_FNAME
3818 int r;
3819 #endif
3821 #if !defined(SHORT_FNAME) \
3822 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3823 # define CREATE_DUMMY_FILE
3824 FILE *dummyfd = NULL;
3827 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3828 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3829 * create will be exactly the same file. To avoid this problem we temporarily
3830 * create "test.doc".
3831 * Don't do this when the check below for a 8.3 file name is used.
3833 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3834 && mch_getperm(buf->b_fname) < 0)
3835 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3836 #endif
3839 * Isolate a directory name from *dirp and put it in dir_name.
3840 * First allocate some memory to put the directory name in.
3842 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3843 if (dir_name != NULL)
3844 (void)copy_option_part(dirp, dir_name, 31000, ",");
3847 * we try different names until we find one that does not exist yet
3849 if (dir_name == NULL) /* out of memory */
3850 fname = NULL;
3851 else
3852 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3854 for (;;)
3856 if (fname == NULL) /* must be out of memory */
3857 break;
3858 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3860 vim_free(fname);
3861 fname = NULL;
3862 break;
3864 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3866 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3867 * file names. If this is the first try and the swap file name does not fit in
3868 * 8.3, detect if this is the case, set shortname and try again.
3870 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3871 && !(buf->b_p_sn || buf->b_shortname))
3873 char_u *tail;
3874 char_u *fname2;
3875 struct stat s1, s2;
3876 int f1, f2;
3877 int created1 = FALSE, created2 = FALSE;
3878 int same = FALSE;
3881 * Check if swapfile name does not fit in 8.3:
3882 * It either contains two dots, is longer than 8 chars, or starts
3883 * with a dot.
3885 tail = gettail(buf->b_fname);
3886 if ( vim_strchr(tail, '.') != NULL
3887 || STRLEN(tail) > (size_t)8
3888 || *gettail(fname) == '.')
3890 fname2 = alloc(n + 2);
3891 if (fname2 != NULL)
3893 STRCPY(fname2, fname);
3894 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3895 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3896 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3898 if (vim_strchr(tail, '.') != NULL)
3899 fname2[n - 1] = 'x';
3900 else if (*gettail(fname) == '.')
3902 fname2[n] = 'x';
3903 fname2[n + 1] = NUL;
3905 else
3906 fname2[n - 5] += 1;
3908 * may need to create the files to be able to use mch_stat()
3910 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3911 if (f1 < 0)
3913 f1 = mch_open_rw((char *)fname,
3914 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3915 #if defined(OS2)
3916 if (f1 < 0 && errno == ENOENT)
3917 same = TRUE;
3918 #endif
3919 created1 = TRUE;
3921 if (f1 >= 0)
3923 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3924 if (f2 < 0)
3926 f2 = mch_open_rw((char *)fname2,
3927 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3928 created2 = TRUE;
3930 if (f2 >= 0)
3933 * Both files exist now. If mch_stat() returns the
3934 * same device and inode they are the same file.
3936 if (mch_fstat(f1, &s1) != -1
3937 && mch_fstat(f2, &s2) != -1
3938 && s1.st_dev == s2.st_dev
3939 && s1.st_ino == s2.st_ino)
3940 same = TRUE;
3941 close(f2);
3942 if (created2)
3943 mch_remove(fname2);
3945 close(f1);
3946 if (created1)
3947 mch_remove(fname);
3949 vim_free(fname2);
3950 if (same)
3952 buf->b_shortname = TRUE;
3953 vim_free(fname);
3954 fname = makeswapname(buf->b_fname, buf->b_ffname,
3955 buf, dir_name);
3956 continue; /* try again with b_shortname set */
3961 #endif
3963 * check if the swapfile already exists
3965 if (mch_getperm(fname) < 0) /* it does not exist */
3967 #ifdef HAVE_LSTAT
3968 struct stat sb;
3971 * Extra security check: When a swap file is a symbolic link, this
3972 * is most likely a symlink attack.
3974 if (mch_lstat((char *)fname, &sb) < 0)
3975 #else
3976 # ifdef AMIGA
3977 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
3979 * on the Amiga mch_getperm() will return -1 when the file exists
3980 * but is being used by another program. This happens if you edit
3981 * a file twice.
3983 if (fh != (BPTR)NULL) /* can open file, OK */
3985 Close(fh);
3986 mch_remove(fname);
3987 break;
3989 if (IoErr() != ERROR_OBJECT_IN_USE
3990 && IoErr() != ERROR_OBJECT_EXISTS)
3991 # endif
3992 #endif
3993 break;
3997 * A file name equal to old_fname is OK to use.
3999 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4000 break;
4003 * get here when file already exists
4005 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4007 #ifndef SHORT_FNAME
4009 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4010 * and file.doc are the same file. To guess if this problem is
4011 * present try if file.doc.swx exists. If it does, we set
4012 * buf->b_shortname and try file_doc.swp (dots replaced by
4013 * underscores for this file), and try again. If it doesn't we
4014 * assume that "file.doc.swp" already exists.
4016 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4018 fname[n - 1] = 'x';
4019 r = mch_getperm(fname); /* try "file.swx" */
4020 fname[n - 1] = 'p';
4021 if (r >= 0) /* "file.swx" seems to exist */
4023 buf->b_shortname = TRUE;
4024 vim_free(fname);
4025 fname = makeswapname(buf->b_fname, buf->b_ffname,
4026 buf, dir_name);
4027 continue; /* try again with '.' replaced with '_' */
4030 #endif
4032 * If we get here the ".swp" file really exists.
4033 * Give an error message, unless recovering, no file name, we are
4034 * viewing a help file or when the path of the file is different
4035 * (happens when all .swp files are in one directory).
4037 if (!recoverymode && buf->b_fname != NULL
4038 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4040 int fd;
4041 struct block0 b0;
4042 int differ = FALSE;
4045 * Try to read block 0 from the swap file to get the original
4046 * file name (and inode number).
4048 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4049 if (fd >= 0)
4051 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4054 * If the swapfile has the same directory as the
4055 * buffer don't compare the directory names, they can
4056 * have a different mountpoint.
4058 if (b0.b0_flags & B0_SAME_DIR)
4060 if (fnamecmp(gettail(buf->b_ffname),
4061 gettail(b0.b0_fname)) != 0
4062 || !same_directory(fname, buf->b_ffname))
4064 #ifdef CHECK_INODE
4065 /* Symlinks may point to the same file even
4066 * when the name differs, need to check the
4067 * inode too. */
4068 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4069 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4070 char_to_long(b0.b0_ino)))
4071 #endif
4072 differ = TRUE;
4075 else
4078 * The name in the swap file may be
4079 * "~user/path/file". Expand it first.
4081 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4082 #ifdef CHECK_INODE
4083 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4084 char_to_long(b0.b0_ino)))
4085 differ = TRUE;
4086 #else
4087 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4088 differ = TRUE;
4089 #endif
4092 close(fd);
4094 #ifdef RISCOS
4095 else
4096 /* Can't open swap file, though it does exist.
4097 * Assume that the user is editing two files with
4098 * the same name in different directories. No error.
4100 differ = TRUE;
4101 #endif
4103 /* give the ATTENTION message when there is an old swap file
4104 * for the current file, and the buffer was not recovered. */
4105 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4106 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4108 #if defined(HAS_SWAP_EXISTS_ACTION)
4109 int choice = 0;
4110 #endif
4111 #ifdef CREATE_DUMMY_FILE
4112 int did_use_dummy = FALSE;
4114 /* Avoid getting a warning for the file being created
4115 * outside of Vim, it was created at the start of this
4116 * function. Delete the file now, because Vim might exit
4117 * here if the window is closed. */
4118 if (dummyfd != NULL)
4120 fclose(dummyfd);
4121 dummyfd = NULL;
4122 mch_remove(buf->b_fname);
4123 did_use_dummy = TRUE;
4125 #endif
4127 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4128 process_still_running = FALSE;
4129 #endif
4130 #ifdef FEAT_AUTOCMD
4132 * If there is an SwapExists autocommand and we can handle
4133 * the response, trigger it. It may return 0 to ask the
4134 * user anyway.
4136 if (swap_exists_action != SEA_NONE
4137 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4138 choice = do_swapexists(buf, fname);
4140 if (choice == 0)
4141 #endif
4143 #ifdef FEAT_GUI
4144 /* If we are supposed to start the GUI but it wasn't
4145 * completely started yet, start it now. This makes
4146 * the messages displayed in the Vim window when
4147 * loading a session from the .gvimrc file. */
4148 if (gui.starting && !gui.in_use)
4149 gui_start();
4150 #endif
4151 /* Show info about the existing swap file. */
4152 attention_message(buf, fname);
4154 /* We don't want a 'q' typed at the more-prompt
4155 * interrupt loading a file. */
4156 got_int = FALSE;
4159 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4160 if (swap_exists_action != SEA_NONE && choice == 0)
4162 char_u *name;
4164 name = alloc((unsigned)(STRLEN(fname)
4165 + STRLEN(_("Swap file \""))
4166 + STRLEN(_("\" already exists!")) + 5));
4167 if (name != NULL)
4169 STRCPY(name, _("Swap file \""));
4170 home_replace(NULL, fname, name + STRLEN(name),
4171 1000, TRUE);
4172 STRCAT(name, _("\" already exists!"));
4174 choice = do_dialog(VIM_WARNING,
4175 (char_u *)_("VIM - ATTENTION"),
4176 name == NULL
4177 ? (char_u *)_("Swap file already exists!")
4178 : name,
4179 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4180 process_still_running
4181 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4182 # endif
4183 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4185 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4186 if (process_still_running && choice >= 4)
4187 choice++; /* Skip missing "Delete it" button */
4188 # endif
4189 vim_free(name);
4191 /* pretend screen didn't scroll, need redraw anyway */
4192 msg_scrolled = 0;
4193 redraw_all_later(NOT_VALID);
4195 #endif
4197 #if defined(HAS_SWAP_EXISTS_ACTION)
4198 if (choice > 0)
4200 switch (choice)
4202 case 1:
4203 buf->b_p_ro = TRUE;
4204 break;
4205 case 2:
4206 break;
4207 case 3:
4208 swap_exists_action = SEA_RECOVER;
4209 break;
4210 case 4:
4211 mch_remove(fname);
4212 break;
4213 case 5:
4214 swap_exists_action = SEA_QUIT;
4215 break;
4216 case 6:
4217 swap_exists_action = SEA_QUIT;
4218 got_int = TRUE;
4219 break;
4222 /* If the file was deleted this fname can be used. */
4223 if (mch_getperm(fname) < 0)
4224 break;
4226 else
4227 #endif
4229 MSG_PUTS("\n");
4230 if (msg_silent == 0)
4231 /* call wait_return() later */
4232 need_wait_return = TRUE;
4235 #ifdef CREATE_DUMMY_FILE
4236 /* Going to try another name, need the dummy file again. */
4237 if (did_use_dummy)
4238 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4239 #endif
4245 * Change the ".swp" extension to find another file that can be used.
4246 * First decrement the last char: ".swo", ".swn", etc.
4247 * If that still isn't enough decrement the last but one char: ".svz"
4248 * Can happen when editing many "No Name" buffers.
4250 if (fname[n - 1] == 'a') /* ".s?a" */
4252 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4254 EMSG(_("E326: Too many swap files found"));
4255 vim_free(fname);
4256 fname = NULL;
4257 break;
4259 --fname[n - 2]; /* ".svz", ".suz", etc. */
4260 fname[n - 1] = 'z' + 1;
4262 --fname[n - 1]; /* ".swo", ".swn", etc. */
4265 vim_free(dir_name);
4266 #ifdef CREATE_DUMMY_FILE
4267 if (dummyfd != NULL) /* file has been created temporarily */
4269 fclose(dummyfd);
4270 mch_remove(buf->b_fname);
4272 #endif
4273 return fname;
4276 static int
4277 b0_magic_wrong(b0p)
4278 ZERO_BL *b0p;
4280 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4281 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4282 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4283 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4286 #ifdef CHECK_INODE
4288 * Compare current file name with file name from swap file.
4289 * Try to use inode numbers when possible.
4290 * Return non-zero when files are different.
4292 * When comparing file names a few things have to be taken into consideration:
4293 * - When working over a network the full path of a file depends on the host.
4294 * We check the inode number if possible. It is not 100% reliable though,
4295 * because the device number cannot be used over a network.
4296 * - When a file does not exist yet (editing a new file) there is no inode
4297 * number.
4298 * - The file name in a swap file may not be valid on the current host. The
4299 * "~user" form is used whenever possible to avoid this.
4301 * This is getting complicated, let's make a table:
4303 * ino_c ino_s fname_c fname_s differ =
4305 * both files exist -> compare inode numbers:
4306 * != 0 != 0 X X ino_c != ino_s
4308 * inode number(s) unknown, file names available -> compare file names
4309 * == 0 X OK OK fname_c != fname_s
4310 * X == 0 OK OK fname_c != fname_s
4312 * current file doesn't exist, file for swap file exist, file name(s) not
4313 * available -> probably different
4314 * == 0 != 0 FAIL X TRUE
4315 * == 0 != 0 X FAIL TRUE
4317 * current file exists, inode for swap unknown, file name(s) not
4318 * available -> probably different
4319 * != 0 == 0 FAIL X TRUE
4320 * != 0 == 0 X FAIL TRUE
4322 * current file doesn't exist, inode for swap unknown, one file name not
4323 * available -> probably different
4324 * == 0 == 0 FAIL OK TRUE
4325 * == 0 == 0 OK FAIL TRUE
4327 * current file doesn't exist, inode for swap unknown, both file names not
4328 * available -> probably same file
4329 * == 0 == 0 FAIL FAIL FALSE
4331 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4332 * can't be changed without making the block 0 incompatible with 32 bit
4333 * versions.
4336 static int
4337 fnamecmp_ino(fname_c, fname_s, ino_block0)
4338 char_u *fname_c; /* current file name */
4339 char_u *fname_s; /* file name from swap file */
4340 long ino_block0;
4342 struct stat st;
4343 ino_t ino_c = 0; /* ino of current file */
4344 ino_t ino_s; /* ino of file from swap file */
4345 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4346 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4347 int retval_c; /* flag: buf_c valid */
4348 int retval_s; /* flag: buf_s valid */
4350 if (mch_stat((char *)fname_c, &st) == 0)
4351 ino_c = (ino_t)st.st_ino;
4354 * First we try to get the inode from the file name, because the inode in
4355 * the swap file may be outdated. If that fails (e.g. this path is not
4356 * valid on this machine), use the inode from block 0.
4358 if (mch_stat((char *)fname_s, &st) == 0)
4359 ino_s = (ino_t)st.st_ino;
4360 else
4361 ino_s = (ino_t)ino_block0;
4363 if (ino_c && ino_s)
4364 return (ino_c != ino_s);
4367 * One of the inode numbers is unknown, try a forced vim_FullName() and
4368 * compare the file names.
4370 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4371 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4372 if (retval_c == OK && retval_s == OK)
4373 return (STRCMP(buf_c, buf_s) != 0);
4376 * Can't compare inodes or file names, guess that the files are different,
4377 * unless both appear not to exist at all.
4379 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4380 return FALSE;
4381 return TRUE;
4383 #endif /* CHECK_INODE */
4386 * Move a long integer into a four byte character array.
4387 * Used for machine independency in block zero.
4389 static void
4390 long_to_char(n, s)
4391 long n;
4392 char_u *s;
4394 s[0] = (char_u)(n & 0xff);
4395 n = (unsigned)n >> 8;
4396 s[1] = (char_u)(n & 0xff);
4397 n = (unsigned)n >> 8;
4398 s[2] = (char_u)(n & 0xff);
4399 n = (unsigned)n >> 8;
4400 s[3] = (char_u)(n & 0xff);
4403 static long
4404 char_to_long(s)
4405 char_u *s;
4407 long retval;
4409 retval = s[3];
4410 retval <<= 8;
4411 retval |= s[2];
4412 retval <<= 8;
4413 retval |= s[1];
4414 retval <<= 8;
4415 retval |= s[0];
4417 return retval;
4421 * Set the flags in the first block of the swap file:
4422 * - file is modified or not: buf->b_changed
4423 * - 'fileformat'
4424 * - 'fileencoding'
4426 void
4427 ml_setflags(buf)
4428 buf_T *buf;
4430 bhdr_T *hp;
4431 ZERO_BL *b0p;
4433 if (!buf->b_ml.ml_mfp)
4434 return;
4435 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4437 if (hp->bh_bnum == 0)
4439 b0p = (ZERO_BL *)(hp->bh_data);
4440 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4441 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4442 | (get_fileformat(buf) + 1);
4443 #ifdef FEAT_MBYTE
4444 add_b0_fenc(b0p, buf);
4445 #endif
4446 hp->bh_flags |= BH_DIRTY;
4447 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4448 break;
4453 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4455 #define MLCS_MAXL 800 /* max no of lines in chunk */
4456 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4459 * Keep information for finding byte offset of a line, updtytpe may be one of:
4460 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4461 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4462 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4463 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4465 static void
4466 ml_updatechunk(buf, line, len, updtype)
4467 buf_T *buf;
4468 linenr_T line;
4469 long len;
4470 int updtype;
4472 static buf_T *ml_upd_lastbuf = NULL;
4473 static linenr_T ml_upd_lastline;
4474 static linenr_T ml_upd_lastcurline;
4475 static int ml_upd_lastcurix;
4477 linenr_T curline = ml_upd_lastcurline;
4478 int curix = ml_upd_lastcurix;
4479 long size;
4480 chunksize_T *curchnk;
4481 int rest;
4482 bhdr_T *hp;
4483 DATA_BL *dp;
4485 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4486 return;
4487 if (buf->b_ml.ml_chunksize == NULL)
4489 buf->b_ml.ml_chunksize = (chunksize_T *)
4490 alloc((unsigned)sizeof(chunksize_T) * 100);
4491 if (buf->b_ml.ml_chunksize == NULL)
4493 buf->b_ml.ml_usedchunks = -1;
4494 return;
4496 buf->b_ml.ml_numchunks = 100;
4497 buf->b_ml.ml_usedchunks = 1;
4498 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4499 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4502 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4505 * First line in empty buffer from ml_flush_line() -- reset
4507 buf->b_ml.ml_usedchunks = 1;
4508 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4509 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4510 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4511 return;
4515 * Find chunk that our line belongs to, curline will be at start of the
4516 * chunk.
4518 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4519 || updtype != ML_CHNK_ADDLINE)
4521 for (curline = 1, curix = 0;
4522 curix < buf->b_ml.ml_usedchunks - 1
4523 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4524 curix++)
4526 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4529 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4530 && curix < buf->b_ml.ml_usedchunks - 1)
4532 /* Adjust cached curix & curline */
4533 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4534 curix++;
4536 curchnk = buf->b_ml.ml_chunksize + curix;
4538 if (updtype == ML_CHNK_DELLINE)
4539 len = -len;
4540 curchnk->mlcs_totalsize += len;
4541 if (updtype == ML_CHNK_ADDLINE)
4543 curchnk->mlcs_numlines++;
4545 /* May resize here so we don't have to do it in both cases below */
4546 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4548 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4549 buf->b_ml.ml_chunksize = (chunksize_T *)
4550 vim_realloc(buf->b_ml.ml_chunksize,
4551 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4552 if (buf->b_ml.ml_chunksize == NULL)
4554 /* Hmmmm, Give up on offset for this buffer */
4555 buf->b_ml.ml_usedchunks = -1;
4556 return;
4560 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4562 int count; /* number of entries in block */
4563 int idx;
4564 int text_end;
4565 int linecnt;
4567 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4568 buf->b_ml.ml_chunksize + curix,
4569 (buf->b_ml.ml_usedchunks - curix) *
4570 sizeof(chunksize_T));
4571 /* Compute length of first half of lines in the split chunk */
4572 size = 0;
4573 linecnt = 0;
4574 while (curline < buf->b_ml.ml_line_count
4575 && linecnt < MLCS_MINL)
4577 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4579 buf->b_ml.ml_usedchunks = -1;
4580 return;
4582 dp = (DATA_BL *)(hp->bh_data);
4583 count = (long)(buf->b_ml.ml_locked_high) -
4584 (long)(buf->b_ml.ml_locked_low) + 1;
4585 idx = curline - buf->b_ml.ml_locked_low;
4586 curline = buf->b_ml.ml_locked_high + 1;
4587 if (idx == 0)/* first line in block, text at the end */
4588 text_end = dp->db_txt_end;
4589 else
4590 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4591 /* Compute index of last line to use in this MEMLINE */
4592 rest = count - idx;
4593 if (linecnt + rest > MLCS_MINL)
4595 idx += MLCS_MINL - linecnt - 1;
4596 linecnt = MLCS_MINL;
4598 else
4600 idx = count - 1;
4601 linecnt += rest;
4603 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4605 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4606 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4607 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4608 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4609 buf->b_ml.ml_usedchunks++;
4610 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4611 return;
4613 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4614 && curix == buf->b_ml.ml_usedchunks - 1
4615 && buf->b_ml.ml_line_count - line <= 1)
4618 * We are in the last chunk and it is cheap to crate a new one
4619 * after this. Do it now to avoid the loop above later on
4621 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4622 buf->b_ml.ml_usedchunks++;
4623 if (line == buf->b_ml.ml_line_count)
4625 curchnk->mlcs_numlines = 0;
4626 curchnk->mlcs_totalsize = 0;
4628 else
4631 * Line is just prior to last, move count for last
4632 * This is the common case when loading a new file
4634 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4635 if (hp == NULL)
4637 buf->b_ml.ml_usedchunks = -1;
4638 return;
4640 dp = (DATA_BL *)(hp->bh_data);
4641 if (dp->db_line_count == 1)
4642 rest = dp->db_txt_end - dp->db_txt_start;
4643 else
4644 rest =
4645 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4646 - dp->db_txt_start;
4647 curchnk->mlcs_totalsize = rest;
4648 curchnk->mlcs_numlines = 1;
4649 curchnk[-1].mlcs_totalsize -= rest;
4650 curchnk[-1].mlcs_numlines -= 1;
4654 else if (updtype == ML_CHNK_DELLINE)
4656 curchnk->mlcs_numlines--;
4657 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4658 if (curix < (buf->b_ml.ml_usedchunks - 1)
4659 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4660 <= MLCS_MINL)
4662 curix++;
4663 curchnk = buf->b_ml.ml_chunksize + curix;
4665 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4667 buf->b_ml.ml_usedchunks--;
4668 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4669 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4670 return;
4672 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4673 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4674 > MLCS_MINL))
4676 return;
4679 /* Collapse chunks */
4680 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4681 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4682 buf->b_ml.ml_usedchunks--;
4683 if (curix < buf->b_ml.ml_usedchunks)
4685 mch_memmove(buf->b_ml.ml_chunksize + curix,
4686 buf->b_ml.ml_chunksize + curix + 1,
4687 (buf->b_ml.ml_usedchunks - curix) *
4688 sizeof(chunksize_T));
4690 return;
4692 ml_upd_lastbuf = buf;
4693 ml_upd_lastline = line;
4694 ml_upd_lastcurline = curline;
4695 ml_upd_lastcurix = curix;
4699 * Find offset for line or line with offset.
4700 * Find line with offset if "lnum" is 0; return remaining offset in offp
4701 * Find offset of line if "lnum" > 0
4702 * return -1 if information is not available
4704 long
4705 ml_find_line_or_offset(buf, lnum, offp)
4706 buf_T *buf;
4707 linenr_T lnum;
4708 long *offp;
4710 linenr_T curline;
4711 int curix;
4712 long size;
4713 bhdr_T *hp;
4714 DATA_BL *dp;
4715 int count; /* number of entries in block */
4716 int idx;
4717 int start_idx;
4718 int text_end;
4719 long offset;
4720 int len;
4721 int ffdos = (get_fileformat(buf) == EOL_DOS);
4722 int extra = 0;
4724 /* take care of cached line first */
4725 ml_flush_line(curbuf);
4727 if (buf->b_ml.ml_usedchunks == -1
4728 || buf->b_ml.ml_chunksize == NULL
4729 || lnum < 0)
4730 return -1;
4732 if (offp == NULL)
4733 offset = 0;
4734 else
4735 offset = *offp;
4736 if (lnum == 0 && offset <= 0)
4737 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4739 * Find the last chunk before the one containing our line. Last chunk is
4740 * special because it will never qualify
4742 curline = 1;
4743 curix = size = 0;
4744 while (curix < buf->b_ml.ml_usedchunks - 1
4745 && ((lnum != 0
4746 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4747 || (offset != 0
4748 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4749 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4751 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4752 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4753 if (offset && ffdos)
4754 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4755 curix++;
4758 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4760 if (curline > buf->b_ml.ml_line_count
4761 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4762 return -1;
4763 dp = (DATA_BL *)(hp->bh_data);
4764 count = (long)(buf->b_ml.ml_locked_high) -
4765 (long)(buf->b_ml.ml_locked_low) + 1;
4766 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4767 if (idx == 0)/* first line in block, text at the end */
4768 text_end = dp->db_txt_end;
4769 else
4770 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4771 /* Compute index of last line to use in this MEMLINE */
4772 if (lnum != 0)
4774 if (curline + (count - idx) >= lnum)
4775 idx += lnum - curline - 1;
4776 else
4777 idx = count - 1;
4779 else
4781 extra = 0;
4782 while (offset >= size
4783 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4784 + ffdos)
4786 if (ffdos)
4787 size++;
4788 if (idx == count - 1)
4790 extra = 1;
4791 break;
4793 idx++;
4796 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4797 size += len;
4798 if (offset != 0 && size >= offset)
4800 if (size + ffdos == offset)
4801 *offp = 0;
4802 else if (idx == start_idx)
4803 *offp = offset - size + len;
4804 else
4805 *offp = offset - size + len
4806 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4807 curline += idx - start_idx + extra;
4808 if (curline > buf->b_ml.ml_line_count)
4809 return -1; /* exactly one byte beyond the end */
4810 return curline;
4812 curline = buf->b_ml.ml_locked_high + 1;
4815 if (lnum != 0)
4817 /* Count extra CR characters. */
4818 if (ffdos)
4819 size += lnum - 1;
4821 /* Don't count the last line break if 'bin' and 'noeol'. */
4822 if (buf->b_p_bin && !buf->b_p_eol)
4823 size -= ffdos + 1;
4826 return size;
4830 * Goto byte in buffer with offset 'cnt'.
4832 void
4833 goto_byte(cnt)
4834 long cnt;
4836 long boff = cnt;
4837 linenr_T lnum;
4839 ml_flush_line(curbuf); /* cached line may be dirty */
4840 setpcmark();
4841 if (boff)
4842 --boff;
4843 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4844 if (lnum < 1) /* past the end */
4846 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4847 curwin->w_curswant = MAXCOL;
4848 coladvance((colnr_T)MAXCOL);
4850 else
4852 curwin->w_cursor.lnum = lnum;
4853 curwin->w_cursor.col = (colnr_T)boff;
4854 # ifdef FEAT_VIRTUALEDIT
4855 curwin->w_cursor.coladd = 0;
4856 # endif
4857 curwin->w_set_curswant = TRUE;
4859 check_cursor();
4861 # ifdef FEAT_MBYTE
4862 /* Make sure the cursor is on the first byte of a multi-byte char. */
4863 if (has_mbyte)
4864 mb_adjust_cursor();
4865 # endif
4867 #endif