Changed DiffText and Constant highlight groups
[MacVim/jjgod.git] / src / memline.c
blob55d0a32736c508c40097307071c7b63cddbc374e
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(WIN32) || defined(_WIN64)
46 # include "vimio.h"
47 #endif
49 #include "vim.h"
51 #ifdef HAVE_FCNTL_H
52 # include <fcntl.h>
53 #endif
54 #ifndef UNIX /* it's in os_unix.h for Unix */
55 # include <time.h>
56 #endif
58 #if defined(SASC) || defined(__amigaos4__)
59 # include <proto/dos.h> /* for Open() and Close() */
60 #endif
62 #ifdef HAVE_ERRNO_H
63 # include <errno.h>
64 #endif
66 typedef struct block0 ZERO_BL; /* contents of the first block */
67 typedef struct pointer_block PTR_BL; /* contents of a pointer block */
68 typedef struct data_block DATA_BL; /* contents of a data block */
69 typedef struct pointer_entry PTR_EN; /* block/line-count pair */
71 #define DATA_ID (('d' << 8) + 'a') /* data block id */
72 #define PTR_ID (('p' << 8) + 't') /* pointer block id */
73 #define BLOCK0_ID0 'b' /* block 0 id 0 */
74 #define BLOCK0_ID1 '0' /* block 0 id 1 */
77 * pointer to a block, used in a pointer block
79 struct pointer_entry
81 blocknr_T pe_bnum; /* block number */
82 linenr_T pe_line_count; /* number of lines in this branch */
83 linenr_T pe_old_lnum; /* lnum for this block (for recovery) */
84 int pe_page_count; /* number of pages in block pe_bnum */
88 * A pointer block contains a list of branches in the tree.
90 struct pointer_block
92 short_u pb_id; /* ID for pointer block: PTR_ID */
93 short_u pb_count; /* number of pointer in this block */
94 short_u pb_count_max; /* maximum value for pb_count */
95 PTR_EN pb_pointer[1]; /* list of pointers to blocks (actually longer)
96 * followed by empty space until end of page */
100 * A data block is a leaf in the tree.
102 * The text of the lines is at the end of the block. The text of the first line
103 * in the block is put at the end, the text of the second line in front of it,
104 * etc. Thus the order of the lines is the opposite of the line number.
106 struct data_block
108 short_u db_id; /* ID for data block: DATA_ID */
109 unsigned db_free; /* free space available */
110 unsigned db_txt_start; /* byte where text starts */
111 unsigned db_txt_end; /* byte just after data block */
112 linenr_T db_line_count; /* number of lines in this block */
113 unsigned db_index[1]; /* index for start of line (actually bigger)
114 * followed by empty space upto db_txt_start
115 * followed by the text in the lines until
116 * end of page */
120 * The low bits of db_index hold the actual index. The topmost bit is
121 * used for the global command to be able to mark a line.
122 * This method is not clean, but otherwise there would be at least one extra
123 * byte used for each line.
124 * The mark has to be in this place to keep it with the correct line when other
125 * lines are inserted or deleted.
127 #define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
128 #define DB_INDEX_MASK (~DB_MARKED)
130 #define INDEX_SIZE (sizeof(unsigned)) /* size of one db_index entry */
131 #define HEADER_SIZE (sizeof(DATA_BL) - INDEX_SIZE) /* size of data block header */
133 #define B0_FNAME_SIZE_ORG 900 /* what it was in older versions */
134 #define B0_FNAME_SIZE 898
135 #define B0_UNAME_SIZE 40
136 #define B0_HNAME_SIZE 40
138 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
139 * This won't detect a 64 bit machine that only swaps a byte in the top 32
140 * bits, but that is crazy anyway.
142 #define B0_MAGIC_LONG 0x30313233L
143 #define B0_MAGIC_INT 0x20212223L
144 #define B0_MAGIC_SHORT 0x10111213L
145 #define B0_MAGIC_CHAR 0x55
148 * Block zero holds all info about the swap file.
150 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
151 * swap files unusable!
153 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
155 * This block is built up of single bytes, to make it portable across
156 * different machines. b0_magic_* is used to check the byte order and size of
157 * variables, because the rest of the swap file is not portable.
159 struct block0
161 char_u b0_id[2]; /* id for block 0: BLOCK0_ID0 and BLOCK0_ID1 */
162 char_u b0_version[10]; /* Vim version string */
163 char_u b0_page_size[4];/* number of bytes per page */
164 char_u b0_mtime[4]; /* last modification time of file */
165 char_u b0_ino[4]; /* inode of b0_fname */
166 char_u b0_pid[4]; /* process id of creator (or 0) */
167 char_u b0_uname[B0_UNAME_SIZE]; /* name of user (uid if no name) */
168 char_u b0_hname[B0_HNAME_SIZE]; /* host name (if it has a name) */
169 char_u b0_fname[B0_FNAME_SIZE_ORG]; /* name of file being edited */
170 long b0_magic_long; /* check for byte order of long */
171 int b0_magic_int; /* check for byte order of int */
172 short b0_magic_short; /* check for byte order of short */
173 char_u b0_magic_char; /* check for last char */
177 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
178 * long file names in older versions of Vim they are invalid.
179 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
180 * when there is room, for very long file names it's omitted.
182 #define B0_DIRTY 0x55
183 #define b0_dirty b0_fname[B0_FNAME_SIZE_ORG-1]
186 * The b0_flags field is new in Vim 7.0.
188 #define b0_flags b0_fname[B0_FNAME_SIZE_ORG-2]
190 /* The lowest two bits contain the fileformat. Zero means it's not set
191 * (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
192 * EOL_MAC + 1. */
193 #define B0_FF_MASK 3
195 /* Swap file is in directory of edited file. Used to find the file from
196 * different mount points. */
197 #define B0_SAME_DIR 4
199 /* The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
200 * When empty there is only the NUL. */
201 #define B0_HAS_FENC 8
203 #define STACK_INCR 5 /* nr of entries added to ml_stack at a time */
206 * The line number where the first mark may be is remembered.
207 * If it is 0 there are no marks at all.
208 * (always used for the current buffer only, no buffer change possible while
209 * executing a global command).
211 static linenr_T lowest_marked = 0;
214 * arguments for ml_find_line()
216 #define ML_DELETE 0x11 /* delete line */
217 #define ML_INSERT 0x12 /* insert line */
218 #define ML_FIND 0x13 /* just find the line */
219 #define ML_FLUSH 0x02 /* flush locked block */
220 #define ML_SIMPLE(x) (x & 0x10) /* DEL, INS or FIND */
222 static void ml_upd_block0 __ARGS((buf_T *buf, int set_fname));
223 static void set_b0_fname __ARGS((ZERO_BL *, buf_T *buf));
224 static void set_b0_dir_flag __ARGS((ZERO_BL *b0p, buf_T *buf));
225 #ifdef FEAT_MBYTE
226 static void add_b0_fenc __ARGS((ZERO_BL *b0p, buf_T *buf));
227 #endif
228 static time_t swapfile_info __ARGS((char_u *));
229 static int recov_file_names __ARGS((char_u **, char_u *, int prepend_dot));
230 static int ml_append_int __ARGS((buf_T *, linenr_T, char_u *, colnr_T, int, int));
231 static int ml_delete_int __ARGS((buf_T *, linenr_T, int));
232 static char_u *findswapname __ARGS((buf_T *, char_u **, char_u *));
233 static void ml_flush_line __ARGS((buf_T *));
234 static bhdr_T *ml_new_data __ARGS((memfile_T *, int, int));
235 static bhdr_T *ml_new_ptr __ARGS((memfile_T *));
236 static bhdr_T *ml_find_line __ARGS((buf_T *, linenr_T, int));
237 static int ml_add_stack __ARGS((buf_T *));
238 static void ml_lineadd __ARGS((buf_T *, int));
239 static int b0_magic_wrong __ARGS((ZERO_BL *));
240 #ifdef CHECK_INODE
241 static int fnamecmp_ino __ARGS((char_u *, char_u *, long));
242 #endif
243 static void long_to_char __ARGS((long, char_u *));
244 static long char_to_long __ARGS((char_u *));
245 #if defined(UNIX) || defined(WIN3264)
246 static char_u *make_percent_swname __ARGS((char_u *dir, char_u *name));
247 #endif
248 #ifdef FEAT_BYTEOFF
249 static void ml_updatechunk __ARGS((buf_T *buf, long line, long len, int updtype));
250 #endif
253 * Open a new memline for "buf".
255 * Return FAIL for failure, OK otherwise.
258 ml_open(buf)
259 buf_T *buf;
261 memfile_T *mfp;
262 bhdr_T *hp = NULL;
263 ZERO_BL *b0p;
264 PTR_BL *pp;
265 DATA_BL *dp;
268 * init fields in memline struct
270 buf->b_ml.ml_stack_size = 0; /* no stack yet */
271 buf->b_ml.ml_stack = NULL; /* no stack yet */
272 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
273 buf->b_ml.ml_locked = NULL; /* no cached block */
274 buf->b_ml.ml_line_lnum = 0; /* no cached line */
275 #ifdef FEAT_BYTEOFF
276 buf->b_ml.ml_chunksize = NULL;
277 #endif
280 * When 'updatecount' is non-zero swap file may be opened later.
282 if (p_uc && buf->b_p_swf)
283 buf->b_may_swap = TRUE;
284 else
285 buf->b_may_swap = FALSE;
288 * Open the memfile. No swap file is created yet.
290 mfp = mf_open(NULL, 0);
291 if (mfp == NULL)
292 goto error;
294 buf->b_ml.ml_mfp = mfp;
295 buf->b_ml.ml_flags = ML_EMPTY;
296 buf->b_ml.ml_line_count = 1;
297 #ifdef FEAT_LINEBREAK
298 curwin->w_nrwidth_line_count = 0;
299 #endif
301 #if defined(MSDOS) && !defined(DJGPP)
302 /* for 16 bit MS-DOS create a swapfile now, because we run out of
303 * memory very quickly */
304 if (p_uc != 0)
305 ml_open_file(buf);
306 #endif
309 * fill block0 struct and write page 0
311 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
312 goto error;
313 if (hp->bh_bnum != 0)
315 EMSG(_("E298: Didn't get block nr 0?"));
316 goto error;
318 b0p = (ZERO_BL *)(hp->bh_data);
320 b0p->b0_id[0] = BLOCK0_ID0;
321 b0p->b0_id[1] = BLOCK0_ID1;
322 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
323 b0p->b0_magic_int = (int)B0_MAGIC_INT;
324 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
325 b0p->b0_magic_char = B0_MAGIC_CHAR;
326 STRNCPY(b0p->b0_version, "VIM ", 4);
327 STRNCPY(b0p->b0_version + 4, Version, 6);
328 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
330 #ifdef FEAT_SPELL
331 if (!buf->b_spell)
332 #endif
334 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
335 b0p->b0_flags = get_fileformat(buf) + 1;
336 set_b0_fname(b0p, buf);
337 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
338 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
339 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
340 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
341 long_to_char(mch_get_pid(), b0p->b0_pid);
345 * Always sync block number 0 to disk, so we can check the file name in
346 * the swap file in findswapname(). Don't do this for help files though
347 * and spell buffer though.
348 * Only works when there's a swapfile, otherwise it's done when the file
349 * is created.
351 mf_put(mfp, hp, TRUE, FALSE);
352 if (!buf->b_help && !B_SPELL(buf))
353 (void)mf_sync(mfp, 0);
356 * Fill in root pointer block and write page 1.
358 if ((hp = ml_new_ptr(mfp)) == NULL)
359 goto error;
360 if (hp->bh_bnum != 1)
362 EMSG(_("E298: Didn't get block nr 1?"));
363 goto error;
365 pp = (PTR_BL *)(hp->bh_data);
366 pp->pb_count = 1;
367 pp->pb_pointer[0].pe_bnum = 2;
368 pp->pb_pointer[0].pe_page_count = 1;
369 pp->pb_pointer[0].pe_old_lnum = 1;
370 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
371 mf_put(mfp, hp, TRUE, FALSE);
374 * Allocate first data block and create an empty line 1.
376 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
377 goto error;
378 if (hp->bh_bnum != 2)
380 EMSG(_("E298: Didn't get block nr 2?"));
381 goto error;
384 dp = (DATA_BL *)(hp->bh_data);
385 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
386 dp->db_free -= 1 + INDEX_SIZE;
387 dp->db_line_count = 1;
388 *((char_u *)dp + dp->db_txt_start) = NUL; /* emtpy line */
390 return OK;
392 error:
393 if (mfp != NULL)
395 if (hp)
396 mf_put(mfp, hp, FALSE, FALSE);
397 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
399 buf->b_ml.ml_mfp = NULL;
400 return FAIL;
404 * ml_setname() is called when the file name of "buf" has been changed.
405 * It may rename the swap file.
407 void
408 ml_setname(buf)
409 buf_T *buf;
411 int success = FALSE;
412 memfile_T *mfp;
413 char_u *fname;
414 char_u *dirp;
415 #if defined(MSDOS) || defined(MSWIN)
416 char_u *p;
417 #endif
419 mfp = buf->b_ml.ml_mfp;
420 if (mfp->mf_fd < 0) /* there is no swap file yet */
423 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
424 * For help files we will make a swap file now.
426 if (p_uc != 0)
427 ml_open_file(buf); /* create a swap file */
428 return;
432 * Try all directories in the 'directory' option.
434 dirp = p_dir;
435 for (;;)
437 if (*dirp == NUL) /* tried all directories, fail */
438 break;
439 fname = findswapname(buf, &dirp, mfp->mf_fname);
440 /* alloc's fname */
441 if (fname == NULL) /* no file name found for this dir */
442 continue;
444 #if defined(MSDOS) || defined(MSWIN)
446 * Set full pathname for swap file now, because a ":!cd dir" may
447 * change directory without us knowing it.
449 p = FullName_save(fname, FALSE);
450 vim_free(fname);
451 fname = p;
452 if (fname == NULL)
453 continue;
454 #endif
455 /* if the file name is the same we don't have to do anything */
456 if (fnamecmp(fname, mfp->mf_fname) == 0)
458 vim_free(fname);
459 success = TRUE;
460 break;
462 /* need to close the swap file before renaming */
463 if (mfp->mf_fd >= 0)
465 close(mfp->mf_fd);
466 mfp->mf_fd = -1;
469 /* try to rename the swap file */
470 if (vim_rename(mfp->mf_fname, fname) == 0)
472 success = TRUE;
473 vim_free(mfp->mf_fname);
474 mfp->mf_fname = fname;
475 vim_free(mfp->mf_ffname);
476 #if defined(MSDOS) || defined(MSWIN)
477 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
478 #else
479 mf_set_ffname(mfp);
480 #endif
481 ml_upd_block0(buf, FALSE);
482 break;
484 vim_free(fname); /* this fname didn't work, try another */
487 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
489 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
490 if (mfp->mf_fd < 0)
492 /* could not (re)open the swap file, what can we do???? */
493 EMSG(_("E301: Oops, lost the swap file!!!"));
494 return;
497 if (!success)
498 EMSG(_("E302: Could not rename swap file"));
502 * Open a file for the memfile for all buffers that are not readonly or have
503 * been modified.
504 * Used when 'updatecount' changes from zero to non-zero.
506 void
507 ml_open_files()
509 buf_T *buf;
511 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
512 if (!buf->b_p_ro || buf->b_changed)
513 ml_open_file(buf);
517 * Open a swap file for an existing memfile, if there is no swap file yet.
518 * If we are unable to find a file name, mf_fname will be NULL
519 * and the memfile will be in memory only (no recovery possible).
521 void
522 ml_open_file(buf)
523 buf_T *buf;
525 memfile_T *mfp;
526 char_u *fname;
527 char_u *dirp;
529 mfp = buf->b_ml.ml_mfp;
530 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
531 return; /* nothing to do */
533 #ifdef FEAT_SPELL
534 /* For a spell buffer use a temp file name. */
535 if (buf->b_spell)
537 fname = vim_tempname('s');
538 if (fname != NULL)
539 (void)mf_open_file(mfp, fname); /* consumes fname! */
540 buf->b_may_swap = FALSE;
541 return;
543 #endif
546 * Try all directories in 'directory' option.
548 dirp = p_dir;
549 for (;;)
551 if (*dirp == NUL)
552 break;
553 /* There is a small chance that between chosing the swap file name and
554 * creating it, another Vim creates the file. In that case the
555 * creation will fail and we will use another directory. */
556 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
557 if (fname == NULL)
558 continue;
559 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
561 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
563 * set full pathname for swap file now, because a ":!cd dir" may
564 * change directory without us knowing it.
566 mf_fullname(mfp);
567 #endif
568 ml_upd_block0(buf, FALSE);
570 /* Flush block zero, so others can read it */
571 if (mf_sync(mfp, MFS_ZERO) == OK)
573 /* Mark all blocks that should be in the swapfile as dirty.
574 * Needed for when the 'swapfile' option was reset, so that
575 * the swap file was deleted, and then on again. */
576 mf_set_dirty(mfp);
577 break;
579 /* Writing block 0 failed: close the file and try another dir */
580 mf_close_file(buf, FALSE);
584 if (mfp->mf_fname == NULL) /* Failed! */
586 need_wait_return = TRUE; /* call wait_return later */
587 ++no_wait_return;
588 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
589 buf_spname(buf) != NULL
590 ? (char_u *)buf_spname(buf)
591 : buf->b_fname);
592 --no_wait_return;
595 /* don't try to open a swap file again */
596 buf->b_may_swap = FALSE;
600 * If still need to create a swap file, and starting to edit a not-readonly
601 * file, or reading into an existing buffer, create a swap file now.
603 void
604 check_need_swap(newfile)
605 int newfile; /* reading file into new buffer */
607 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
608 ml_open_file(curbuf);
612 * Close memline for buffer 'buf'.
613 * If 'del_file' is TRUE, delete the swap file
615 void
616 ml_close(buf, del_file)
617 buf_T *buf;
618 int del_file;
620 if (buf->b_ml.ml_mfp == NULL) /* not open */
621 return;
622 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
623 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
624 vim_free(buf->b_ml.ml_line_ptr);
625 vim_free(buf->b_ml.ml_stack);
626 #ifdef FEAT_BYTEOFF
627 vim_free(buf->b_ml.ml_chunksize);
628 buf->b_ml.ml_chunksize = NULL;
629 #endif
630 buf->b_ml.ml_mfp = NULL;
632 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
633 * this buffer is loaded. */
634 buf->b_flags &= ~BF_RECOVERED;
638 * Close all existing memlines and memfiles.
639 * Only used when exiting.
640 * When 'del_file' is TRUE, delete the memfiles.
641 * But don't delete files that were ":preserve"d when we are POSIX compatible.
643 void
644 ml_close_all(del_file)
645 int del_file;
647 buf_T *buf;
649 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
650 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
651 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
652 #ifdef TEMPDIRNAMES
653 vim_deltempdir(); /* delete created temp directory */
654 #endif
658 * Close all memfiles for not modified buffers.
659 * Only use just before exiting!
661 void
662 ml_close_notmod()
664 buf_T *buf;
666 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
667 if (!bufIsChanged(buf))
668 ml_close(buf, TRUE); /* close all not-modified buffers */
672 * Update the timestamp in the .swp file.
673 * Used when the file has been written.
675 void
676 ml_timestamp(buf)
677 buf_T *buf;
679 ml_upd_block0(buf, TRUE);
683 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
685 static void
686 ml_upd_block0(buf, set_fname)
687 buf_T *buf;
688 int set_fname;
690 memfile_T *mfp;
691 bhdr_T *hp;
692 ZERO_BL *b0p;
694 mfp = buf->b_ml.ml_mfp;
695 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
696 return;
697 b0p = (ZERO_BL *)(hp->bh_data);
698 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
699 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
700 else
702 if (set_fname)
703 set_b0_fname(b0p, buf);
704 else
705 set_b0_dir_flag(b0p, buf);
707 mf_put(mfp, hp, TRUE, FALSE);
711 * Write file name and timestamp into block 0 of a swap file.
712 * Also set buf->b_mtime.
713 * Don't use NameBuff[]!!!
715 static void
716 set_b0_fname(b0p, buf)
717 ZERO_BL *b0p;
718 buf_T *buf;
720 struct stat st;
722 if (buf->b_ffname == NULL)
723 b0p->b0_fname[0] = NUL;
724 else
726 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
727 /* Systems that cannot translate "~user" back into a path: copy the
728 * file name unmodified. Do use slashes instead of backslashes for
729 * portability. */
730 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
731 # ifdef BACKSLASH_IN_FILENAME
732 forward_slash(b0p->b0_fname);
733 # endif
734 #else
735 size_t flen, ulen;
736 char_u uname[B0_UNAME_SIZE];
739 * For a file under the home directory of the current user, we try to
740 * replace the home directory path with "~user". This helps when
741 * editing the same file on different machines over a network.
742 * First replace home dir path with "~/" with home_replace().
743 * Then insert the user name to get "~user/".
745 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
746 if (b0p->b0_fname[0] == '~')
748 flen = STRLEN(b0p->b0_fname);
749 /* If there is no user name or it is too long, don't use "~/" */
750 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
751 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
752 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
753 else
755 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
756 mch_memmove(b0p->b0_fname + 1, uname, ulen);
759 #endif
760 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
762 long_to_char((long)st.st_mtime, b0p->b0_mtime);
763 #ifdef CHECK_INODE
764 long_to_char((long)st.st_ino, b0p->b0_ino);
765 #endif
766 buf_store_time(buf, &st, buf->b_ffname);
767 buf->b_mtime_read = buf->b_mtime;
769 else
771 long_to_char(0L, b0p->b0_mtime);
772 #ifdef CHECK_INODE
773 long_to_char(0L, b0p->b0_ino);
774 #endif
775 buf->b_mtime = 0;
776 buf->b_mtime_read = 0;
777 buf->b_orig_size = 0;
778 buf->b_orig_mode = 0;
782 #ifdef FEAT_MBYTE
783 /* Also add the 'fileencoding' if there is room. */
784 add_b0_fenc(b0p, curbuf);
785 #endif
789 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
790 * swapfile for "buf" are in the same directory.
791 * This is fail safe: if we are not sure the directories are equal the flag is
792 * not set.
794 static void
795 set_b0_dir_flag(b0p, buf)
796 ZERO_BL *b0p;
797 buf_T *buf;
799 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
800 b0p->b0_flags |= B0_SAME_DIR;
801 else
802 b0p->b0_flags &= ~B0_SAME_DIR;
805 #ifdef FEAT_MBYTE
807 * When there is room, add the 'fileencoding' to block zero.
809 static void
810 add_b0_fenc(b0p, buf)
811 ZERO_BL *b0p;
812 buf_T *buf;
814 int n;
816 n = (int)STRLEN(buf->b_p_fenc);
817 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
818 b0p->b0_flags &= ~B0_HAS_FENC;
819 else
821 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
822 (char *)buf->b_p_fenc, (size_t)n);
823 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
824 b0p->b0_flags |= B0_HAS_FENC;
827 #endif
831 * try to recover curbuf from the .swp file
833 void
834 ml_recover()
836 buf_T *buf = NULL;
837 memfile_T *mfp = NULL;
838 char_u *fname;
839 bhdr_T *hp = NULL;
840 ZERO_BL *b0p;
841 int b0_ff;
842 char_u *b0_fenc = NULL;
843 PTR_BL *pp;
844 DATA_BL *dp;
845 infoptr_T *ip;
846 blocknr_T bnum;
847 int page_count;
848 struct stat org_stat, swp_stat;
849 int len;
850 int directly;
851 linenr_T lnum;
852 char_u *p;
853 int i;
854 long error;
855 int cannot_open;
856 linenr_T line_count;
857 int has_error;
858 int idx;
859 int top;
860 int txt_start;
861 off_t size;
862 int called_from_main;
863 int serious_error = TRUE;
864 long mtime;
865 int attr;
867 recoverymode = TRUE;
868 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
869 attr = hl_attr(HLF_E);
871 * If the file name ends in ".sw?" we use it directly.
872 * Otherwise a search is done to find the swap file(s).
874 fname = curbuf->b_fname;
875 if (fname == NULL) /* When there is no file name */
876 fname = (char_u *)"";
877 len = (int)STRLEN(fname);
878 if (len >= 4 &&
879 #if defined(VMS) || defined(RISCOS)
880 STRNICMP(fname + len - 4, "_sw" , 3)
881 #else
882 STRNICMP(fname + len - 4, ".sw" , 3)
883 #endif
884 == 0)
886 directly = TRUE;
887 fname = vim_strsave(fname); /* make a copy for mf_open() */
889 else
891 directly = FALSE;
893 /* count the number of matching swap files */
894 len = recover_names(&fname, FALSE, 0);
895 if (len == 0) /* no swap files found */
897 EMSG2(_("E305: No swap file found for %s"), fname);
898 goto theend;
900 if (len == 1) /* one swap file found, use it */
901 i = 1;
902 else /* several swap files found, choose */
904 /* list the names of the swap files */
905 (void)recover_names(&fname, TRUE, 0);
906 msg_putchar('\n');
907 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
908 i = get_number(FALSE, NULL);
909 if (i < 1 || i > len)
910 goto theend;
912 /* get the swap file name that will be used */
913 (void)recover_names(&fname, FALSE, i);
915 if (fname == NULL)
916 goto theend; /* out of memory */
918 /* When called from main() still need to initialize storage structure */
919 if (called_from_main && ml_open(curbuf) == FAIL)
920 getout(1);
923 * allocate a buffer structure (only the memline in it is really used)
925 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
926 if (buf == NULL)
928 vim_free(fname);
929 goto theend;
933 * init fields in memline struct
935 buf->b_ml.ml_stack_size = 0; /* no stack yet */
936 buf->b_ml.ml_stack = NULL; /* no stack yet */
937 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
938 buf->b_ml.ml_line_lnum = 0; /* no cached line */
939 buf->b_ml.ml_locked = NULL; /* no locked block */
940 buf->b_ml.ml_flags = 0;
943 * open the memfile from the old swap file
945 p = vim_strsave(fname); /* save fname for the message
946 (mf_open() may free fname) */
947 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
948 if (mfp == NULL || mfp->mf_fd < 0)
950 if (p != NULL)
952 EMSG2(_("E306: Cannot open %s"), p);
953 vim_free(p);
955 goto theend;
957 vim_free(p);
958 buf->b_ml.ml_mfp = mfp;
961 * The page size set in mf_open() might be different from the page size
962 * used in the swap file, we must get it from block 0. But to read block
963 * 0 we need a page size. Use the minimal size for block 0 here, it will
964 * be set to the real value below.
966 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
969 * try to read block 0
971 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
973 msg_start();
974 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
975 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
976 MSG_PUTS_ATTR(
977 _("\nMaybe no changes were made or Vim did not update the swap file."),
978 attr | MSG_HIST);
979 msg_end();
980 goto theend;
982 b0p = (ZERO_BL *)(hp->bh_data);
983 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
985 msg_start();
986 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
987 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
988 MSG_HIST);
989 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
990 msg_end();
991 goto theend;
993 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
995 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
996 goto theend;
998 if (b0_magic_wrong(b0p))
1000 msg_start();
1001 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1002 #if defined(MSDOS) || defined(MSWIN)
1003 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1004 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1005 attr | MSG_HIST);
1006 else
1007 #endif
1008 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1009 attr | MSG_HIST);
1010 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1011 /* avoid going past the end of a currupted hostname */
1012 b0p->b0_fname[0] = NUL;
1013 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1014 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1015 msg_end();
1016 goto theend;
1020 * If we guessed the wrong page size, we have to recalculate the
1021 * highest block number in the file.
1023 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1025 unsigned previous_page_size = mfp->mf_page_size;
1027 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1028 if (mfp->mf_page_size < previous_page_size)
1030 msg_start();
1031 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1032 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1033 attr | MSG_HIST);
1034 msg_end();
1035 goto theend;
1037 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1038 mfp->mf_blocknr_max = 0; /* no file or empty file */
1039 else
1040 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1041 mfp->mf_infile_count = mfp->mf_blocknr_max;
1043 /* need to reallocate the memory used to store the data */
1044 p = alloc(mfp->mf_page_size);
1045 if (p == NULL)
1046 goto theend;
1047 mch_memmove(p, hp->bh_data, previous_page_size);
1048 vim_free(hp->bh_data);
1049 hp->bh_data = p;
1050 b0p = (ZERO_BL *)(hp->bh_data);
1054 * If .swp file name given directly, use name from swap file for buffer.
1056 if (directly)
1058 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1059 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1060 goto theend;
1063 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1064 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1066 if (buf_spname(curbuf) != NULL)
1067 STRCPY(NameBuff, buf_spname(curbuf));
1068 else
1069 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1070 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1071 msg_putchar('\n');
1074 * check date of swap file and original file
1076 mtime = char_to_long(b0p->b0_mtime);
1077 if (curbuf->b_ffname != NULL
1078 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1079 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1080 && org_stat.st_mtime > swp_stat.st_mtime)
1081 || org_stat.st_mtime != mtime))
1083 EMSG(_("E308: Warning: Original file may have been changed"));
1085 out_flush();
1087 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1088 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1089 if (b0p->b0_flags & B0_HAS_FENC)
1091 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1092 p > b0p->b0_fname && p[-1] != NUL; --p)
1094 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1097 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1098 hp = NULL;
1101 * Now that we are sure that the file is going to be recovered, clear the
1102 * contents of the current buffer.
1104 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1105 ml_delete((linenr_T)1, FALSE);
1108 * Try reading the original file to obtain the values of 'fileformat',
1109 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1111 if (curbuf->b_ffname != NULL)
1113 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1114 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1115 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1116 ml_delete((linenr_T)1, FALSE);
1119 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1120 if (b0_ff != 0)
1121 set_fileformat(b0_ff - 1, OPT_LOCAL);
1122 if (b0_fenc != NULL)
1124 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1125 vim_free(b0_fenc);
1127 unchanged(curbuf, TRUE);
1129 bnum = 1; /* start with block 1 */
1130 page_count = 1; /* which is 1 page */
1131 lnum = 0; /* append after line 0 in curbuf */
1132 line_count = 0;
1133 idx = 0; /* start with first index in block 1 */
1134 error = 0;
1135 buf->b_ml.ml_stack_top = 0;
1136 buf->b_ml.ml_stack = NULL;
1137 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1139 if (curbuf->b_ffname == NULL)
1140 cannot_open = TRUE;
1141 else
1142 cannot_open = FALSE;
1144 serious_error = FALSE;
1145 for ( ; !got_int; line_breakcheck())
1147 if (hp != NULL)
1148 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1151 * get block
1153 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1155 if (bnum == 1)
1157 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1158 goto theend;
1160 ++error;
1161 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1162 (colnr_T)0, TRUE);
1164 else /* there is a block */
1166 pp = (PTR_BL *)(hp->bh_data);
1167 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1169 /* check line count when using pointer block first time */
1170 if (idx == 0 && line_count != 0)
1172 for (i = 0; i < (int)pp->pb_count; ++i)
1173 line_count -= pp->pb_pointer[i].pe_line_count;
1174 if (line_count != 0)
1176 ++error;
1177 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1178 (colnr_T)0, TRUE);
1182 if (pp->pb_count == 0)
1184 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1185 (colnr_T)0, TRUE);
1186 ++error;
1188 else if (idx < (int)pp->pb_count) /* go a block deeper */
1190 if (pp->pb_pointer[idx].pe_bnum < 0)
1193 * Data block with negative block number.
1194 * Try to read lines from the original file.
1195 * This is slow, but it works.
1197 if (!cannot_open)
1199 line_count = pp->pb_pointer[idx].pe_line_count;
1200 if (readfile(curbuf->b_ffname, NULL, lnum,
1201 pp->pb_pointer[idx].pe_old_lnum - 1,
1202 line_count, NULL, 0) == FAIL)
1203 cannot_open = TRUE;
1204 else
1205 lnum += line_count;
1207 if (cannot_open)
1209 ++error;
1210 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1211 (colnr_T)0, TRUE);
1213 ++idx; /* get same block again for next index */
1214 continue;
1218 * going one block deeper in the tree
1220 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1222 ++error;
1223 break; /* out of memory */
1225 ip = &(buf->b_ml.ml_stack[top]);
1226 ip->ip_bnum = bnum;
1227 ip->ip_index = idx;
1229 bnum = pp->pb_pointer[idx].pe_bnum;
1230 line_count = pp->pb_pointer[idx].pe_line_count;
1231 page_count = pp->pb_pointer[idx].pe_page_count;
1232 continue;
1235 else /* not a pointer block */
1237 dp = (DATA_BL *)(hp->bh_data);
1238 if (dp->db_id != DATA_ID) /* block id wrong */
1240 if (bnum == 1)
1242 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1243 mfp->mf_fname);
1244 goto theend;
1246 ++error;
1247 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1248 (colnr_T)0, TRUE);
1250 else
1253 * it is a data block
1254 * Append all the lines in this block
1256 has_error = FALSE;
1258 * check length of block
1259 * if wrong, use length in pointer block
1261 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1263 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1264 (colnr_T)0, TRUE);
1265 ++error;
1266 has_error = TRUE;
1267 dp->db_txt_end = page_count * mfp->mf_page_size;
1270 /* make sure there is a NUL at the end of the block */
1271 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1274 * check number of lines in block
1275 * if wrong, use count in data block
1277 if (line_count != dp->db_line_count)
1279 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1280 (colnr_T)0, TRUE);
1281 ++error;
1282 has_error = TRUE;
1285 for (i = 0; i < dp->db_line_count; ++i)
1287 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1288 if (txt_start <= HEADER_SIZE
1289 || txt_start >= (int)dp->db_txt_end)
1291 p = (char_u *)"???";
1292 ++error;
1294 else
1295 p = (char_u *)dp + txt_start;
1296 ml_append(lnum++, p, (colnr_T)0, TRUE);
1298 if (has_error)
1299 ml_append(lnum++, (char_u *)_("???END"), (colnr_T)0, TRUE);
1304 if (buf->b_ml.ml_stack_top == 0) /* finished */
1305 break;
1308 * go one block up in the tree
1310 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1311 bnum = ip->ip_bnum;
1312 idx = ip->ip_index + 1; /* go to next index */
1313 page_count = 1;
1317 * The dummy line from the empty buffer will now be after the last line in
1318 * the buffer. Delete it.
1320 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1321 curbuf->b_flags |= BF_RECOVERED;
1323 recoverymode = FALSE;
1324 if (got_int)
1325 EMSG(_("E311: Recovery Interrupted"));
1326 else if (error)
1328 ++no_wait_return;
1329 MSG(">>>>>>>>>>>>>");
1330 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1331 --no_wait_return;
1332 MSG(_("See \":help E312\" for more information."));
1333 MSG(">>>>>>>>>>>>>");
1335 else
1337 MSG(_("Recovery completed. You should check if everything is OK."));
1338 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1339 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1340 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1341 cmdline_row = msg_row;
1343 redraw_curbuf_later(NOT_VALID);
1345 theend:
1346 recoverymode = FALSE;
1347 if (mfp != NULL)
1349 if (hp != NULL)
1350 mf_put(mfp, hp, FALSE, FALSE);
1351 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1353 if (buf != NULL)
1355 vim_free(buf->b_ml.ml_stack);
1356 vim_free(buf);
1358 if (serious_error && called_from_main)
1359 ml_close(curbuf, TRUE);
1360 #ifdef FEAT_AUTOCMD
1361 else
1363 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1364 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1366 #endif
1367 return;
1371 * Find the names of swap files in current directory and the directory given
1372 * with the 'directory' option.
1374 * Used to:
1375 * - list the swap files for "vim -r"
1376 * - count the number of swap files when recovering
1377 * - list the swap files when recovering
1378 * - find the name of the n'th swap file when recovering
1381 recover_names(fname, list, nr)
1382 char_u **fname; /* base for swap file name */
1383 int list; /* when TRUE, list the swap file names */
1384 int nr; /* when non-zero, return nr'th swap file name */
1386 int num_names;
1387 char_u *(names[6]);
1388 char_u *tail;
1389 char_u *p;
1390 int num_files;
1391 int file_count = 0;
1392 char_u **files;
1393 int i;
1394 char_u *dirp;
1395 char_u *dir_name;
1397 if (list)
1399 /* use msg() to start the scrolling properly */
1400 msg((char_u *)_("Swap files found:"));
1401 msg_putchar('\n');
1405 * Do the loop for every directory in 'directory'.
1406 * First allocate some memory to put the directory name in.
1408 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1409 dirp = p_dir;
1410 while (dir_name != NULL && *dirp)
1413 * Isolate a directory name from *dirp and put it in dir_name (we know
1414 * it is large enough, so use 31000 for length).
1415 * Advance dirp to next directory name.
1417 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1419 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1421 if (fname == NULL || *fname == NULL)
1423 #ifdef VMS
1424 names[0] = vim_strsave((char_u *)"*_sw%");
1425 #else
1426 # ifdef RISCOS
1427 names[0] = vim_strsave((char_u *)"*_sw#");
1428 # else
1429 names[0] = vim_strsave((char_u *)"*.sw?");
1430 # endif
1431 #endif
1432 #if defined(UNIX) || defined(WIN3264)
1433 /* For Unix names starting with a dot are special. MS-Windows
1434 * supports this too, on some file systems. */
1435 names[1] = vim_strsave((char_u *)".*.sw?");
1436 names[2] = vim_strsave((char_u *)".sw?");
1437 num_names = 3;
1438 #else
1439 # ifdef VMS
1440 names[1] = vim_strsave((char_u *)".*_sw%");
1441 num_names = 2;
1442 # else
1443 num_names = 1;
1444 # endif
1445 #endif
1447 else
1448 num_names = recov_file_names(names, *fname, TRUE);
1450 else /* check directory dir_name */
1452 if (fname == NULL || *fname == NULL)
1454 #ifdef VMS
1455 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1456 #else
1457 # ifdef RISCOS
1458 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1459 # else
1460 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1461 # endif
1462 #endif
1463 #if defined(UNIX) || defined(WIN3264)
1464 /* For Unix names starting with a dot are special. MS-Windows
1465 * supports this too, on some file systems. */
1466 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1467 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1468 num_names = 3;
1469 #else
1470 # ifdef VMS
1471 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1472 num_names = 2;
1473 # else
1474 num_names = 1;
1475 # endif
1476 #endif
1478 else
1480 #if defined(UNIX) || defined(WIN3264)
1481 p = dir_name + STRLEN(dir_name);
1482 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1484 /* Ends with '//', Use Full path for swap name */
1485 tail = make_percent_swname(dir_name, *fname);
1487 else
1488 #endif
1490 tail = gettail(*fname);
1491 tail = concat_fnames(dir_name, tail, TRUE);
1493 if (tail == NULL)
1494 num_names = 0;
1495 else
1497 num_names = recov_file_names(names, tail, FALSE);
1498 vim_free(tail);
1503 /* check for out-of-memory */
1504 for (i = 0; i < num_names; ++i)
1506 if (names[i] == NULL)
1508 for (i = 0; i < num_names; ++i)
1509 vim_free(names[i]);
1510 num_names = 0;
1513 if (num_names == 0)
1514 num_files = 0;
1515 else if (expand_wildcards(num_names, names, &num_files, &files,
1516 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1517 num_files = 0;
1520 * When no swap file found, wildcard expansion might have failed (e.g.
1521 * not able to execute the shell).
1522 * Try finding a swap file by simply adding ".swp" to the file name.
1524 if (*dirp == NUL && file_count + num_files == 0
1525 && fname != NULL && *fname != NULL)
1527 struct stat st;
1528 char_u *swapname;
1530 #if defined(VMS) || defined(RISCOS)
1531 swapname = modname(*fname, (char_u *)"_swp", FALSE);
1532 #else
1533 swapname = modname(*fname, (char_u *)".swp", TRUE);
1534 #endif
1535 if (swapname != NULL)
1537 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1539 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1540 if (files != NULL)
1542 files[0] = swapname;
1543 swapname = NULL;
1544 num_files = 1;
1547 vim_free(swapname);
1552 * remove swapfile name of the current buffer, it must be ignored
1554 if (curbuf->b_ml.ml_mfp != NULL
1555 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1557 for (i = 0; i < num_files; ++i)
1558 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1560 vim_free(files[i]);
1561 --num_files;
1562 for ( ; i < num_files; ++i)
1563 files[i] = files[i + 1];
1566 if (nr > 0)
1568 file_count += num_files;
1569 if (nr <= file_count)
1571 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1572 dirp = (char_u *)""; /* stop searching */
1575 else if (list)
1577 if (dir_name[0] == '.' && dir_name[1] == NUL)
1579 if (fname == NULL || *fname == NULL)
1580 MSG_PUTS(_(" In current directory:\n"));
1581 else
1582 MSG_PUTS(_(" Using specified name:\n"));
1584 else
1586 MSG_PUTS(_(" In directory "));
1587 msg_home_replace(dir_name);
1588 MSG_PUTS(":\n");
1591 if (num_files)
1593 for (i = 0; i < num_files; ++i)
1595 /* print the swap file name */
1596 msg_outnum((long)++file_count);
1597 MSG_PUTS(". ");
1598 msg_puts(gettail(files[i]));
1599 msg_putchar('\n');
1600 (void)swapfile_info(files[i]);
1603 else
1604 MSG_PUTS(_(" -- none --\n"));
1605 out_flush();
1607 else
1608 file_count += num_files;
1610 for (i = 0; i < num_names; ++i)
1611 vim_free(names[i]);
1612 if (num_files > 0)
1613 FreeWild(num_files, files);
1615 vim_free(dir_name);
1616 return file_count;
1619 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1621 * Append the full path to name with path separators made into percent
1622 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1624 static char_u *
1625 make_percent_swname(dir, name)
1626 char_u *dir;
1627 char_u *name;
1629 char_u *d, *s, *f;
1631 f = fix_fname(name != NULL ? name : (char_u *) "");
1632 d = NULL;
1633 if (f != NULL)
1635 s = alloc((unsigned)(STRLEN(f) + 1));
1636 if (s != NULL)
1638 STRCPY(s, f);
1639 for (d = s; *d != NUL; mb_ptr_adv(d))
1640 if (vim_ispathsep(*d))
1641 *d = '%';
1642 d = concat_fnames(dir, s, TRUE);
1643 vim_free(s);
1645 vim_free(f);
1647 return d;
1649 #endif
1651 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1652 static int process_still_running;
1653 #endif
1656 * Give information about an existing swap file.
1657 * Returns timestamp (0 when unknown).
1659 static time_t
1660 swapfile_info(fname)
1661 char_u *fname;
1663 struct stat st;
1664 int fd;
1665 struct block0 b0;
1666 time_t x = (time_t)0;
1667 char *p;
1668 #ifdef UNIX
1669 char_u uname[B0_UNAME_SIZE];
1670 #endif
1672 /* print the swap file date */
1673 if (mch_stat((char *)fname, &st) != -1)
1675 #ifdef UNIX
1676 /* print name of owner of the file */
1677 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1679 MSG_PUTS(_(" owned by: "));
1680 msg_outtrans(uname);
1681 MSG_PUTS(_(" dated: "));
1683 else
1684 #endif
1685 MSG_PUTS(_(" dated: "));
1686 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1687 p = ctime(&x); /* includes '\n' */
1688 if (p == NULL)
1689 MSG_PUTS("(invalid)\n");
1690 else
1691 MSG_PUTS(p);
1695 * print the original file name
1697 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1698 if (fd >= 0)
1700 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1702 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1704 MSG_PUTS(_(" [from Vim version 3.0]"));
1706 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1708 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1710 else
1712 MSG_PUTS(_(" file name: "));
1713 if (b0.b0_fname[0] == NUL)
1714 MSG_PUTS(_("[No Name]"));
1715 else
1716 msg_outtrans(b0.b0_fname);
1718 MSG_PUTS(_("\n modified: "));
1719 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1721 if (*(b0.b0_uname) != NUL)
1723 MSG_PUTS(_("\n user name: "));
1724 msg_outtrans(b0.b0_uname);
1727 if (*(b0.b0_hname) != NUL)
1729 if (*(b0.b0_uname) != NUL)
1730 MSG_PUTS(_(" host name: "));
1731 else
1732 MSG_PUTS(_("\n host name: "));
1733 msg_outtrans(b0.b0_hname);
1736 if (char_to_long(b0.b0_pid) != 0L)
1738 MSG_PUTS(_("\n process ID: "));
1739 msg_outnum(char_to_long(b0.b0_pid));
1740 #if defined(UNIX) || defined(__EMX__)
1741 /* EMX kill() not working correctly, it seems */
1742 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1744 MSG_PUTS(_(" (still running)"));
1745 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1746 process_still_running = TRUE;
1747 # endif
1749 #endif
1752 if (b0_magic_wrong(&b0))
1754 #if defined(MSDOS) || defined(MSWIN)
1755 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1756 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1757 else
1758 #endif
1759 MSG_PUTS(_("\n [not usable on this computer]"));
1763 else
1764 MSG_PUTS(_(" [cannot be read]"));
1765 close(fd);
1767 else
1768 MSG_PUTS(_(" [cannot be opened]"));
1769 msg_putchar('\n');
1771 return x;
1774 static int
1775 recov_file_names(names, path, prepend_dot)
1776 char_u **names;
1777 char_u *path;
1778 int prepend_dot;
1780 int num_names;
1782 #ifdef SHORT_FNAME
1784 * (MS-DOS) always short names
1786 names[0] = modname(path, (char_u *)".sw?", FALSE);
1787 num_names = 1;
1788 #else /* !SHORT_FNAME */
1790 * (Win32 and Win64) never short names, but do prepend a dot.
1791 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1792 * Only use the short name if it is different.
1794 char_u *p;
1795 int i;
1796 # ifndef WIN3264
1797 int shortname = curbuf->b_shortname;
1799 curbuf->b_shortname = FALSE;
1800 # endif
1802 num_names = 0;
1805 * May also add the file name with a dot prepended, for swap file in same
1806 * dir as original file.
1808 if (prepend_dot)
1810 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1811 if (names[num_names] == NULL)
1812 goto end;
1813 ++num_names;
1817 * Form the normal swap file name pattern by appending ".sw?".
1819 #ifdef VMS
1820 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1821 #else
1822 # ifdef RISCOS
1823 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1824 # else
1825 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1826 # endif
1827 #endif
1828 if (names[num_names] == NULL)
1829 goto end;
1830 if (num_names >= 1) /* check if we have the same name twice */
1832 p = names[num_names - 1];
1833 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1834 if (i > 0)
1835 p += i; /* file name has been expanded to full path */
1837 if (STRCMP(p, names[num_names]) != 0)
1838 ++num_names;
1839 else
1840 vim_free(names[num_names]);
1842 else
1843 ++num_names;
1845 # ifndef WIN3264
1847 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1849 curbuf->b_shortname = TRUE;
1850 #ifdef VMS
1851 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1852 #else
1853 # ifdef RISCOS
1854 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1855 # else
1856 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1857 # endif
1858 #endif
1859 if (names[num_names] == NULL)
1860 goto end;
1863 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1865 p = names[num_names];
1866 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1867 if (i > 0)
1868 p += i; /* file name has been expanded to full path */
1869 if (STRCMP(names[num_names - 1], p) == 0)
1870 vim_free(names[num_names]);
1871 else
1872 ++num_names;
1873 # endif
1875 end:
1876 # ifndef WIN3264
1877 curbuf->b_shortname = shortname;
1878 # endif
1880 #endif /* !SHORT_FNAME */
1882 return num_names;
1886 * sync all memlines
1888 * If 'check_file' is TRUE, check if original file exists and was not changed.
1889 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1890 * always sync at least one block.
1892 void
1893 ml_sync_all(check_file, check_char)
1894 int check_file;
1895 int check_char;
1897 buf_T *buf;
1898 struct stat st;
1900 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1902 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1903 continue; /* no file */
1905 ml_flush_line(buf); /* flush buffered line */
1906 /* flush locked block */
1907 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1908 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1909 && buf->b_ffname != NULL)
1912 * If the original file does not exist anymore or has been changed
1913 * call ml_preserve() to get rid of all negative numbered blocks.
1915 if (mch_stat((char *)buf->b_ffname, &st) == -1
1916 || st.st_mtime != buf->b_mtime_read
1917 || (size_t)st.st_size != buf->b_orig_size)
1919 ml_preserve(buf, FALSE);
1920 did_check_timestamps = FALSE;
1921 need_check_timestamps = TRUE; /* give message later */
1924 if (buf->b_ml.ml_mfp->mf_dirty)
1926 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1927 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1928 if (check_char && ui_char_avail()) /* character available now */
1929 break;
1935 * sync one buffer, including negative blocks
1937 * after this all the blocks are in the swap file
1939 * Used for the :preserve command and when the original file has been
1940 * changed or deleted.
1942 * when message is TRUE the success of preserving is reported
1944 void
1945 ml_preserve(buf, message)
1946 buf_T *buf;
1947 int message;
1949 bhdr_T *hp;
1950 linenr_T lnum;
1951 memfile_T *mfp = buf->b_ml.ml_mfp;
1952 int status;
1953 int got_int_save = got_int;
1955 if (mfp == NULL || mfp->mf_fname == NULL)
1957 if (message)
1958 EMSG(_("E313: Cannot preserve, there is no swap file"));
1959 return;
1962 /* We only want to stop when interrupted here, not when interrupted
1963 * before. */
1964 got_int = FALSE;
1966 ml_flush_line(buf); /* flush buffered line */
1967 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
1968 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
1970 /* stack is invalid after mf_sync(.., MFS_ALL) */
1971 buf->b_ml.ml_stack_top = 0;
1974 * Some of the data blocks may have been changed from negative to
1975 * positive block number. In that case the pointer blocks need to be
1976 * updated.
1978 * We don't know in which pointer block the references are, so we visit
1979 * all data blocks until there are no more translations to be done (or
1980 * we hit the end of the file, which can only happen in case a write fails,
1981 * e.g. when file system if full).
1982 * ml_find_line() does the work by translating the negative block numbers
1983 * when getting the first line of each data block.
1985 if (mf_need_trans(mfp) && !got_int)
1987 lnum = 1;
1988 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
1990 hp = ml_find_line(buf, lnum, ML_FIND);
1991 if (hp == NULL)
1993 status = FAIL;
1994 goto theend;
1996 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
1997 lnum = buf->b_ml.ml_locked_high + 1;
1999 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2000 /* sync the updated pointer blocks */
2001 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2002 status = FAIL;
2003 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2005 theend:
2006 got_int |= got_int_save;
2008 if (message)
2010 if (status == OK)
2011 MSG(_("File preserved"));
2012 else
2013 EMSG(_("E314: Preserve failed"));
2018 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2019 * until the next call!
2020 * line1 = ml_get(1);
2021 * line2 = ml_get(2); // line1 is now invalid!
2022 * Make a copy of the line if necessary.
2025 * get a pointer to a (read-only copy of a) line
2027 * On failure an error message is given and IObuff is returned (to avoid
2028 * having to check for error everywhere).
2030 char_u *
2031 ml_get(lnum)
2032 linenr_T lnum;
2034 return ml_get_buf(curbuf, lnum, FALSE);
2038 * ml_get_pos: get pointer to position 'pos'
2040 char_u *
2041 ml_get_pos(pos)
2042 pos_T *pos;
2044 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2048 * ml_get_curline: get pointer to cursor line.
2050 char_u *
2051 ml_get_curline()
2053 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2057 * ml_get_cursor: get pointer to cursor position
2059 char_u *
2060 ml_get_cursor()
2062 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2063 curwin->w_cursor.col);
2067 * get a pointer to a line in a specific buffer
2069 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2070 * changed)
2072 char_u *
2073 ml_get_buf(buf, lnum, will_change)
2074 buf_T *buf;
2075 linenr_T lnum;
2076 int will_change; /* line will be changed */
2078 bhdr_T *hp;
2079 DATA_BL *dp;
2080 char_u *ptr;
2081 static int recursive = 0;
2083 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2085 if (recursive == 0)
2087 /* Avoid giving this message for a recursive call, may happen when
2088 * the GUI redraws part of the text. */
2089 ++recursive;
2090 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2091 --recursive;
2093 errorret:
2094 STRCPY(IObuff, "???");
2095 return IObuff;
2097 if (lnum <= 0) /* pretend line 0 is line 1 */
2098 lnum = 1;
2100 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2101 return (char_u *)"";
2104 * See if it is the same line as requested last time.
2105 * Otherwise may need to flush last used line.
2106 * Don't use the last used line when 'swapfile' is reset, need to load all
2107 * blocks.
2109 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2111 ml_flush_line(buf);
2114 * Find the data block containing the line.
2115 * This also fills the stack with the blocks from the root to the data
2116 * block and releases any locked block.
2118 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2120 if (recursive == 0)
2122 /* Avoid giving this message for a recursive call, may happen
2123 * when the GUI redraws part of the text. */
2124 ++recursive;
2125 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2126 --recursive;
2128 goto errorret;
2131 dp = (DATA_BL *)(hp->bh_data);
2133 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2134 buf->b_ml.ml_line_ptr = ptr;
2135 buf->b_ml.ml_line_lnum = lnum;
2136 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2138 if (will_change)
2139 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2141 return buf->b_ml.ml_line_ptr;
2145 * Check if a line that was just obtained by a call to ml_get
2146 * is in allocated memory.
2149 ml_line_alloced()
2151 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2155 * Append a line after lnum (may be 0 to insert a line in front of the file).
2156 * "line" does not need to be allocated, but can't be another line in a
2157 * buffer, unlocking may make it invalid.
2159 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2160 * will be set for recovery
2161 * Check: The caller of this function should probably also call
2162 * appended_lines().
2164 * return FAIL for failure, OK otherwise
2167 ml_append(lnum, line, len, newfile)
2168 linenr_T lnum; /* append after this line (can be 0) */
2169 char_u *line; /* text of the new line */
2170 colnr_T len; /* length of new line, including NUL, or 0 */
2171 int newfile; /* flag, see above */
2173 /* When starting up, we might still need to create the memfile */
2174 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2175 return FAIL;
2177 if (curbuf->b_ml.ml_line_lnum != 0)
2178 ml_flush_line(curbuf);
2179 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2182 #if defined(FEAT_SPELL) || defined(PROTO)
2184 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2185 * a memline.
2188 ml_append_buf(buf, lnum, line, len, newfile)
2189 buf_T *buf;
2190 linenr_T lnum; /* append after this line (can be 0) */
2191 char_u *line; /* text of the new line */
2192 colnr_T len; /* length of new line, including NUL, or 0 */
2193 int newfile; /* flag, see above */
2195 if (buf->b_ml.ml_mfp == NULL)
2196 return FAIL;
2198 if (buf->b_ml.ml_line_lnum != 0)
2199 ml_flush_line(buf);
2200 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2202 #endif
2204 static int
2205 ml_append_int(buf, lnum, line, len, newfile, mark)
2206 buf_T *buf;
2207 linenr_T lnum; /* append after this line (can be 0) */
2208 char_u *line; /* text of the new line */
2209 colnr_T len; /* length of line, including NUL, or 0 */
2210 int newfile; /* flag, see above */
2211 int mark; /* mark the new line */
2213 int i;
2214 int line_count; /* number of indexes in current block */
2215 int offset;
2216 int from, to;
2217 int space_needed; /* space needed for new line */
2218 int page_size;
2219 int page_count;
2220 int db_idx; /* index for lnum in data block */
2221 bhdr_T *hp;
2222 memfile_T *mfp;
2223 DATA_BL *dp;
2224 PTR_BL *pp;
2225 infoptr_T *ip;
2227 /* lnum out of range */
2228 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2229 return FAIL;
2231 if (lowest_marked && lowest_marked > lnum)
2232 lowest_marked = lnum + 1;
2234 if (len == 0)
2235 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2236 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2238 mfp = buf->b_ml.ml_mfp;
2239 page_size = mfp->mf_page_size;
2242 * find the data block containing the previous line
2243 * This also fills the stack with the blocks from the root to the data block
2244 * This also releases any locked block.
2246 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2247 ML_INSERT)) == NULL)
2248 return FAIL;
2250 buf->b_ml.ml_flags &= ~ML_EMPTY;
2252 if (lnum == 0) /* got line one instead, correct db_idx */
2253 db_idx = -1; /* careful, it is negative! */
2254 else
2255 db_idx = lnum - buf->b_ml.ml_locked_low;
2256 /* get line count before the insertion */
2257 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2259 dp = (DATA_BL *)(hp->bh_data);
2262 * If
2263 * - there is not enough room in the current block
2264 * - appending to the last line in the block
2265 * - not appending to the last line in the file
2266 * insert in front of the next block.
2268 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2269 && lnum < buf->b_ml.ml_line_count)
2272 * Now that the line is not going to be inserted in the block that we
2273 * expected, the line count has to be adjusted in the pointer blocks
2274 * by using ml_locked_lineadd.
2276 --(buf->b_ml.ml_locked_lineadd);
2277 --(buf->b_ml.ml_locked_high);
2278 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2279 return FAIL;
2281 db_idx = -1; /* careful, it is negative! */
2282 /* get line count before the insertion */
2283 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2284 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2286 dp = (DATA_BL *)(hp->bh_data);
2289 ++buf->b_ml.ml_line_count;
2291 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2294 * Insert new line in existing data block, or in data block allocated above.
2296 dp->db_txt_start -= len;
2297 dp->db_free -= space_needed;
2298 ++(dp->db_line_count);
2301 * move the text of the lines that follow to the front
2302 * adjust the indexes of the lines that follow
2304 if (line_count > db_idx + 1) /* if there are following lines */
2307 * Offset is the start of the previous line.
2308 * This will become the character just after the new line.
2310 if (db_idx < 0)
2311 offset = dp->db_txt_end;
2312 else
2313 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2314 mch_memmove((char *)dp + dp->db_txt_start,
2315 (char *)dp + dp->db_txt_start + len,
2316 (size_t)(offset - (dp->db_txt_start + len)));
2317 for (i = line_count - 1; i > db_idx; --i)
2318 dp->db_index[i + 1] = dp->db_index[i] - len;
2319 dp->db_index[db_idx + 1] = offset - len;
2321 else /* add line at the end */
2322 dp->db_index[db_idx + 1] = dp->db_txt_start;
2325 * copy the text into the block
2327 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2328 if (mark)
2329 dp->db_index[db_idx + 1] |= DB_MARKED;
2332 * Mark the block dirty.
2334 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2335 if (!newfile)
2336 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2338 else /* not enough space in data block */
2341 * If there is not enough room we have to create a new data block and copy some
2342 * lines into it.
2343 * Then we have to insert an entry in the pointer block.
2344 * If this pointer block also is full, we go up another block, and so on, up
2345 * to the root if necessary.
2346 * The line counts in the pointer blocks have already been adjusted by
2347 * ml_find_line().
2349 long line_count_left, line_count_right;
2350 int page_count_left, page_count_right;
2351 bhdr_T *hp_left;
2352 bhdr_T *hp_right;
2353 bhdr_T *hp_new;
2354 int lines_moved;
2355 int data_moved = 0; /* init to shut up gcc */
2356 int total_moved = 0; /* init to shut up gcc */
2357 DATA_BL *dp_right, *dp_left;
2358 int stack_idx;
2359 int in_left;
2360 int lineadd;
2361 blocknr_T bnum_left, bnum_right;
2362 linenr_T lnum_left, lnum_right;
2363 int pb_idx;
2364 PTR_BL *pp_new;
2367 * We are going to allocate a new data block. Depending on the
2368 * situation it will be put to the left or right of the existing
2369 * block. If possible we put the new line in the left block and move
2370 * the lines after it to the right block. Otherwise the new line is
2371 * also put in the right block. This method is more efficient when
2372 * inserting a lot of lines at one place.
2374 if (db_idx < 0) /* left block is new, right block is existing */
2376 lines_moved = 0;
2377 in_left = TRUE;
2378 /* space_needed does not change */
2380 else /* left block is existing, right block is new */
2382 lines_moved = line_count - db_idx - 1;
2383 if (lines_moved == 0)
2384 in_left = FALSE; /* put new line in right block */
2385 /* space_needed does not change */
2386 else
2388 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2389 dp->db_txt_start;
2390 total_moved = data_moved + lines_moved * INDEX_SIZE;
2391 if ((int)dp->db_free + total_moved >= space_needed)
2393 in_left = TRUE; /* put new line in left block */
2394 space_needed = total_moved;
2396 else
2398 in_left = FALSE; /* put new line in right block */
2399 space_needed += total_moved;
2404 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2405 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2407 /* correct line counts in pointer blocks */
2408 --(buf->b_ml.ml_locked_lineadd);
2409 --(buf->b_ml.ml_locked_high);
2410 return FAIL;
2412 if (db_idx < 0) /* left block is new */
2414 hp_left = hp_new;
2415 hp_right = hp;
2416 line_count_left = 0;
2417 line_count_right = line_count;
2419 else /* right block is new */
2421 hp_left = hp;
2422 hp_right = hp_new;
2423 line_count_left = line_count;
2424 line_count_right = 0;
2426 dp_right = (DATA_BL *)(hp_right->bh_data);
2427 dp_left = (DATA_BL *)(hp_left->bh_data);
2428 bnum_left = hp_left->bh_bnum;
2429 bnum_right = hp_right->bh_bnum;
2430 page_count_left = hp_left->bh_page_count;
2431 page_count_right = hp_right->bh_page_count;
2434 * May move the new line into the right/new block.
2436 if (!in_left)
2438 dp_right->db_txt_start -= len;
2439 dp_right->db_free -= len + INDEX_SIZE;
2440 dp_right->db_index[0] = dp_right->db_txt_start;
2441 if (mark)
2442 dp_right->db_index[0] |= DB_MARKED;
2444 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2445 line, (size_t)len);
2446 ++line_count_right;
2449 * may move lines from the left/old block to the right/new one.
2451 if (lines_moved)
2455 dp_right->db_txt_start -= data_moved;
2456 dp_right->db_free -= total_moved;
2457 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2458 (char *)dp_left + dp_left->db_txt_start,
2459 (size_t)data_moved);
2460 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2461 dp_left->db_txt_start += data_moved;
2462 dp_left->db_free += total_moved;
2465 * update indexes in the new block
2467 for (to = line_count_right, from = db_idx + 1;
2468 from < line_count_left; ++from, ++to)
2469 dp_right->db_index[to] = dp->db_index[from] + offset;
2470 line_count_right += lines_moved;
2471 line_count_left -= lines_moved;
2475 * May move the new line into the left (old or new) block.
2477 if (in_left)
2479 dp_left->db_txt_start -= len;
2480 dp_left->db_free -= len + INDEX_SIZE;
2481 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2482 if (mark)
2483 dp_left->db_index[line_count_left] |= DB_MARKED;
2484 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2485 line, (size_t)len);
2486 ++line_count_left;
2489 if (db_idx < 0) /* left block is new */
2491 lnum_left = lnum + 1;
2492 lnum_right = 0;
2494 else /* right block is new */
2496 lnum_left = 0;
2497 if (in_left)
2498 lnum_right = lnum + 2;
2499 else
2500 lnum_right = lnum + 1;
2502 dp_left->db_line_count = line_count_left;
2503 dp_right->db_line_count = line_count_right;
2506 * release the two data blocks
2507 * The new one (hp_new) already has a correct blocknumber.
2508 * The old one (hp, in ml_locked) gets a positive blocknumber if
2509 * we changed it and we are not editing a new file.
2511 if (lines_moved || in_left)
2512 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2513 if (!newfile && db_idx >= 0 && in_left)
2514 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2515 mf_put(mfp, hp_new, TRUE, FALSE);
2518 * flush the old data block
2519 * set ml_locked_lineadd to 0, because the updating of the
2520 * pointer blocks is done below
2522 lineadd = buf->b_ml.ml_locked_lineadd;
2523 buf->b_ml.ml_locked_lineadd = 0;
2524 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2527 * update pointer blocks for the new data block
2529 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2530 --stack_idx)
2532 ip = &(buf->b_ml.ml_stack[stack_idx]);
2533 pb_idx = ip->ip_index;
2534 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2535 return FAIL;
2536 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2537 if (pp->pb_id != PTR_ID)
2539 EMSG(_("E317: pointer block id wrong 3"));
2540 mf_put(mfp, hp, FALSE, FALSE);
2541 return FAIL;
2544 * TODO: If the pointer block is full and we are adding at the end
2545 * try to insert in front of the next block
2547 /* block not full, add one entry */
2548 if (pp->pb_count < pp->pb_count_max)
2550 if (pb_idx + 1 < (int)pp->pb_count)
2551 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2552 &pp->pb_pointer[pb_idx + 1],
2553 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2554 ++pp->pb_count;
2555 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2556 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2557 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2558 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2559 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2560 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2562 if (lnum_left != 0)
2563 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2564 if (lnum_right != 0)
2565 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2567 mf_put(mfp, hp, TRUE, FALSE);
2568 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2570 if (lineadd)
2572 --(buf->b_ml.ml_stack_top);
2573 /* fix line count for rest of blocks in the stack */
2574 ml_lineadd(buf, lineadd);
2575 /* fix stack itself */
2576 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2577 lineadd;
2578 ++(buf->b_ml.ml_stack_top);
2582 * We are finished, break the loop here.
2584 break;
2586 else /* pointer block full */
2589 * split the pointer block
2590 * allocate a new pointer block
2591 * move some of the pointer into the new block
2592 * prepare for updating the parent block
2594 for (;;) /* do this twice when splitting block 1 */
2596 hp_new = ml_new_ptr(mfp);
2597 if (hp_new == NULL) /* TODO: try to fix tree */
2598 return FAIL;
2599 pp_new = (PTR_BL *)(hp_new->bh_data);
2601 if (hp->bh_bnum != 1)
2602 break;
2605 * if block 1 becomes full the tree is given an extra level
2606 * The pointers from block 1 are moved into the new block.
2607 * block 1 is updated to point to the new block
2608 * then continue to split the new block
2610 mch_memmove(pp_new, pp, (size_t)page_size);
2611 pp->pb_count = 1;
2612 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2613 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2614 pp->pb_pointer[0].pe_old_lnum = 1;
2615 pp->pb_pointer[0].pe_page_count = 1;
2616 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2617 hp = hp_new; /* new block is to be split */
2618 pp = pp_new;
2619 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2620 ip->ip_index = 0;
2621 ++stack_idx; /* do block 1 again later */
2624 * move the pointers after the current one to the new block
2625 * If there are none, the new entry will be in the new block.
2627 total_moved = pp->pb_count - pb_idx - 1;
2628 if (total_moved)
2630 mch_memmove(&pp_new->pb_pointer[0],
2631 &pp->pb_pointer[pb_idx + 1],
2632 (size_t)(total_moved) * sizeof(PTR_EN));
2633 pp_new->pb_count = total_moved;
2634 pp->pb_count -= total_moved - 1;
2635 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2636 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2637 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2638 if (lnum_right)
2639 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2641 else
2643 pp_new->pb_count = 1;
2644 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2645 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2646 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2647 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2649 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2650 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2651 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2652 if (lnum_left)
2653 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2654 lnum_left = 0;
2655 lnum_right = 0;
2658 * recompute line counts
2660 line_count_right = 0;
2661 for (i = 0; i < (int)pp_new->pb_count; ++i)
2662 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2663 line_count_left = 0;
2664 for (i = 0; i < (int)pp->pb_count; ++i)
2665 line_count_left += pp->pb_pointer[i].pe_line_count;
2667 bnum_left = hp->bh_bnum;
2668 bnum_right = hp_new->bh_bnum;
2669 page_count_left = 1;
2670 page_count_right = 1;
2671 mf_put(mfp, hp, TRUE, FALSE);
2672 mf_put(mfp, hp_new, TRUE, FALSE);
2677 * Safety check: fallen out of for loop?
2679 if (stack_idx < 0)
2681 EMSG(_("E318: Updated too many blocks?"));
2682 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2686 #ifdef FEAT_BYTEOFF
2687 /* The line was inserted below 'lnum' */
2688 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2689 #endif
2690 #ifdef FEAT_NETBEANS_INTG
2691 if (usingNetbeans)
2693 if (STRLEN(line) > 0)
2694 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2695 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2696 (char_u *)"\n", 1);
2698 #endif
2699 return OK;
2703 * Replace line lnum, with buffering, in current buffer.
2705 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2706 * copied to allocated memory already.
2708 * Check: The caller of this function should probably also call
2709 * changed_lines(), unless update_screen(NOT_VALID) is used.
2711 * return FAIL for failure, OK otherwise
2714 ml_replace(lnum, line, copy)
2715 linenr_T lnum;
2716 char_u *line;
2717 int copy;
2719 if (line == NULL) /* just checking... */
2720 return FAIL;
2722 /* When starting up, we might still need to create the memfile */
2723 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2724 return FAIL;
2726 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2727 return FAIL;
2728 #ifdef FEAT_NETBEANS_INTG
2729 if (usingNetbeans)
2731 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2732 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2734 #endif
2735 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2736 ml_flush_line(curbuf); /* flush it */
2737 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2738 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2739 curbuf->b_ml.ml_line_ptr = line;
2740 curbuf->b_ml.ml_line_lnum = lnum;
2741 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2743 return OK;
2747 * Delete line 'lnum' in the current buffer.
2749 * Check: The caller of this function should probably also call
2750 * deleted_lines() after this.
2752 * return FAIL for failure, OK otherwise
2755 ml_delete(lnum, message)
2756 linenr_T lnum;
2757 int message;
2759 ml_flush_line(curbuf);
2760 return ml_delete_int(curbuf, lnum, message);
2763 static int
2764 ml_delete_int(buf, lnum, message)
2765 buf_T *buf;
2766 linenr_T lnum;
2767 int message;
2769 bhdr_T *hp;
2770 memfile_T *mfp;
2771 DATA_BL *dp;
2772 PTR_BL *pp;
2773 infoptr_T *ip;
2774 int count; /* number of entries in block */
2775 int idx;
2776 int stack_idx;
2777 int text_start;
2778 int line_start;
2779 long line_size;
2780 int i;
2782 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2783 return FAIL;
2785 if (lowest_marked && lowest_marked > lnum)
2786 lowest_marked--;
2789 * If the file becomes empty the last line is replaced by an empty line.
2791 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2793 if (message
2794 #ifdef FEAT_NETBEANS_INTG
2795 && !netbeansSuppressNoLines
2796 #endif
2798 set_keep_msg((char_u *)_(no_lines_msg), 0);
2800 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2801 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2802 buf->b_ml.ml_flags |= ML_EMPTY;
2804 return i;
2808 * find the data block containing the line
2809 * This also fills the stack with the blocks from the root to the data block
2810 * This also releases any locked block.
2812 mfp = buf->b_ml.ml_mfp;
2813 if (mfp == NULL)
2814 return FAIL;
2816 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2817 return FAIL;
2819 dp = (DATA_BL *)(hp->bh_data);
2820 /* compute line count before the delete */
2821 count = (long)(buf->b_ml.ml_locked_high)
2822 - (long)(buf->b_ml.ml_locked_low) + 2;
2823 idx = lnum - buf->b_ml.ml_locked_low;
2825 --buf->b_ml.ml_line_count;
2827 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2828 if (idx == 0) /* first line in block, text at the end */
2829 line_size = dp->db_txt_end - line_start;
2830 else
2831 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2833 #ifdef FEAT_NETBEANS_INTG
2834 if (usingNetbeans)
2835 netbeans_removed(buf, lnum, 0, (long)line_size);
2836 #endif
2839 * special case: If there is only one line in the data block it becomes empty.
2840 * Then we have to remove the entry, pointing to this data block, from the
2841 * pointer block. If this pointer block also becomes empty, we go up another
2842 * block, and so on, up to the root if necessary.
2843 * The line counts in the pointer blocks have already been adjusted by
2844 * ml_find_line().
2846 if (count == 1)
2848 mf_free(mfp, hp); /* free the data block */
2849 buf->b_ml.ml_locked = NULL;
2851 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2853 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2854 ip = &(buf->b_ml.ml_stack[stack_idx]);
2855 idx = ip->ip_index;
2856 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2857 return FAIL;
2858 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2859 if (pp->pb_id != PTR_ID)
2861 EMSG(_("E317: pointer block id wrong 4"));
2862 mf_put(mfp, hp, FALSE, FALSE);
2863 return FAIL;
2865 count = --(pp->pb_count);
2866 if (count == 0) /* the pointer block becomes empty! */
2867 mf_free(mfp, hp);
2868 else
2870 if (count != idx) /* move entries after the deleted one */
2871 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2872 (size_t)(count - idx) * sizeof(PTR_EN));
2873 mf_put(mfp, hp, TRUE, FALSE);
2875 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2876 /* fix line count for rest of blocks in the stack */
2877 if (buf->b_ml.ml_locked_lineadd != 0)
2879 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2880 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2881 buf->b_ml.ml_locked_lineadd;
2883 ++(buf->b_ml.ml_stack_top);
2885 break;
2888 CHECK(stack_idx < 0, _("deleted block 1?"));
2890 else
2893 * delete the text by moving the next lines forwards
2895 text_start = dp->db_txt_start;
2896 mch_memmove((char *)dp + text_start + line_size,
2897 (char *)dp + text_start, (size_t)(line_start - text_start));
2900 * delete the index by moving the next indexes backwards
2901 * Adjust the indexes for the text movement.
2903 for (i = idx; i < count - 1; ++i)
2904 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2906 dp->db_free += line_size + INDEX_SIZE;
2907 dp->db_txt_start += line_size;
2908 --(dp->db_line_count);
2911 * mark the block dirty and make sure it is in the file (for recovery)
2913 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2916 #ifdef FEAT_BYTEOFF
2917 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2918 #endif
2919 return OK;
2923 * set the B_MARKED flag for line 'lnum'
2925 void
2926 ml_setmarked(lnum)
2927 linenr_T lnum;
2929 bhdr_T *hp;
2930 DATA_BL *dp;
2931 /* invalid line number */
2932 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2933 || curbuf->b_ml.ml_mfp == NULL)
2934 return; /* give error message? */
2936 if (lowest_marked == 0 || lowest_marked > lnum)
2937 lowest_marked = lnum;
2940 * find the data block containing the line
2941 * This also fills the stack with the blocks from the root to the data block
2942 * This also releases any locked block.
2944 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2945 return; /* give error message? */
2947 dp = (DATA_BL *)(hp->bh_data);
2948 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2949 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2953 * find the first line with its B_MARKED flag set
2955 linenr_T
2956 ml_firstmarked()
2958 bhdr_T *hp;
2959 DATA_BL *dp;
2960 linenr_T lnum;
2961 int i;
2963 if (curbuf->b_ml.ml_mfp == NULL)
2964 return (linenr_T) 0;
2967 * The search starts with lowest_marked line. This is the last line where
2968 * a mark was found, adjusted by inserting/deleting lines.
2970 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
2973 * Find the data block containing the line.
2974 * This also fills the stack with the blocks from the root to the data
2975 * block This also releases any locked block.
2977 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2978 return (linenr_T)0; /* give error message? */
2980 dp = (DATA_BL *)(hp->bh_data);
2982 for (i = lnum - curbuf->b_ml.ml_locked_low;
2983 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
2984 if ((dp->db_index[i]) & DB_MARKED)
2986 (dp->db_index[i]) &= DB_INDEX_MASK;
2987 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2988 lowest_marked = lnum + 1;
2989 return lnum;
2993 return (linenr_T) 0;
2996 #if 0 /* not used */
2998 * return TRUE if line 'lnum' has a mark
3001 ml_has_mark(lnum)
3002 linenr_T lnum;
3004 bhdr_T *hp;
3005 DATA_BL *dp;
3007 if (curbuf->b_ml.ml_mfp == NULL
3008 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3009 return FALSE;
3011 dp = (DATA_BL *)(hp->bh_data);
3012 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3014 #endif
3017 * clear all DB_MARKED flags
3019 void
3020 ml_clearmarked()
3022 bhdr_T *hp;
3023 DATA_BL *dp;
3024 linenr_T lnum;
3025 int i;
3027 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3028 return;
3031 * The search starts with line lowest_marked.
3033 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3036 * Find the data block containing the line.
3037 * This also fills the stack with the blocks from the root to the data
3038 * block and releases any locked block.
3040 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3041 return; /* give error message? */
3043 dp = (DATA_BL *)(hp->bh_data);
3045 for (i = lnum - curbuf->b_ml.ml_locked_low;
3046 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3047 if ((dp->db_index[i]) & DB_MARKED)
3049 (dp->db_index[i]) &= DB_INDEX_MASK;
3050 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3054 lowest_marked = 0;
3055 return;
3059 * flush ml_line if necessary
3061 static void
3062 ml_flush_line(buf)
3063 buf_T *buf;
3065 bhdr_T *hp;
3066 DATA_BL *dp;
3067 linenr_T lnum;
3068 char_u *new_line;
3069 char_u *old_line;
3070 colnr_T new_len;
3071 int old_len;
3072 int extra;
3073 int idx;
3074 int start;
3075 int count;
3076 int i;
3078 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3079 return; /* nothing to do */
3081 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3083 lnum = buf->b_ml.ml_line_lnum;
3084 new_line = buf->b_ml.ml_line_ptr;
3086 hp = ml_find_line(buf, lnum, ML_FIND);
3087 if (hp == NULL)
3088 EMSGN(_("E320: Cannot find line %ld"), lnum);
3089 else
3091 dp = (DATA_BL *)(hp->bh_data);
3092 idx = lnum - buf->b_ml.ml_locked_low;
3093 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3094 old_line = (char_u *)dp + start;
3095 if (idx == 0) /* line is last in block */
3096 old_len = dp->db_txt_end - start;
3097 else /* text of previous line follows */
3098 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3099 new_len = (colnr_T)STRLEN(new_line) + 1;
3100 extra = new_len - old_len; /* negative if lines gets smaller */
3103 * if new line fits in data block, replace directly
3105 if ((int)dp->db_free >= extra)
3107 /* if the length changes and there are following lines */
3108 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3109 if (extra != 0 && idx < count - 1)
3111 /* move text of following lines */
3112 mch_memmove((char *)dp + dp->db_txt_start - extra,
3113 (char *)dp + dp->db_txt_start,
3114 (size_t)(start - dp->db_txt_start));
3116 /* adjust pointers of this and following lines */
3117 for (i = idx + 1; i < count; ++i)
3118 dp->db_index[i] -= extra;
3120 dp->db_index[idx] -= extra;
3122 /* adjust free space */
3123 dp->db_free -= extra;
3124 dp->db_txt_start -= extra;
3126 /* copy new line into the data block */
3127 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3128 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3129 #ifdef FEAT_BYTEOFF
3130 /* The else case is already covered by the insert and delete */
3131 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3132 #endif
3134 else
3137 * Cannot do it in one data block: Delete and append.
3138 * Append first, because ml_delete_int() cannot delete the
3139 * last line in a buffer, which causes trouble for a buffer
3140 * that has only one line.
3141 * Don't forget to copy the mark!
3143 /* How about handling errors??? */
3144 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3145 (dp->db_index[idx] & DB_MARKED));
3146 (void)ml_delete_int(buf, lnum, FALSE);
3149 vim_free(new_line);
3152 buf->b_ml.ml_line_lnum = 0;
3156 * create a new, empty, data block
3158 static bhdr_T *
3159 ml_new_data(mfp, negative, page_count)
3160 memfile_T *mfp;
3161 int negative;
3162 int page_count;
3164 bhdr_T *hp;
3165 DATA_BL *dp;
3167 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3168 return NULL;
3170 dp = (DATA_BL *)(hp->bh_data);
3171 dp->db_id = DATA_ID;
3172 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3173 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3174 dp->db_line_count = 0;
3176 return hp;
3180 * create a new, empty, pointer block
3182 static bhdr_T *
3183 ml_new_ptr(mfp)
3184 memfile_T *mfp;
3186 bhdr_T *hp;
3187 PTR_BL *pp;
3189 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3190 return NULL;
3192 pp = (PTR_BL *)(hp->bh_data);
3193 pp->pb_id = PTR_ID;
3194 pp->pb_count = 0;
3195 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3197 return hp;
3201 * lookup line 'lnum' in a memline
3203 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3204 * if ML_FLUSH only flush a locked block
3205 * if ML_FIND just find the line
3207 * If the block was found it is locked and put in ml_locked.
3208 * The stack is updated to lead to the locked block. The ip_high field in
3209 * the stack is updated to reflect the last line in the block AFTER the
3210 * insert or delete, also if the pointer block has not been updated yet. But
3211 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3213 * return: NULL for failure, pointer to block header otherwise
3215 static bhdr_T *
3216 ml_find_line(buf, lnum, action)
3217 buf_T *buf;
3218 linenr_T lnum;
3219 int action;
3221 DATA_BL *dp;
3222 PTR_BL *pp;
3223 infoptr_T *ip;
3224 bhdr_T *hp;
3225 memfile_T *mfp;
3226 linenr_T t;
3227 blocknr_T bnum, bnum2;
3228 int dirty;
3229 linenr_T low, high;
3230 int top;
3231 int page_count;
3232 int idx;
3234 mfp = buf->b_ml.ml_mfp;
3237 * If there is a locked block check if the wanted line is in it.
3238 * If not, flush and release the locked block.
3239 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3240 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3241 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3243 if (buf->b_ml.ml_locked)
3245 if (ML_SIMPLE(action)
3246 && buf->b_ml.ml_locked_low <= lnum
3247 && buf->b_ml.ml_locked_high >= lnum
3248 && !mf_dont_release)
3250 /* remember to update pointer blocks and stack later */
3251 if (action == ML_INSERT)
3253 ++(buf->b_ml.ml_locked_lineadd);
3254 ++(buf->b_ml.ml_locked_high);
3256 else if (action == ML_DELETE)
3258 --(buf->b_ml.ml_locked_lineadd);
3259 --(buf->b_ml.ml_locked_high);
3261 return (buf->b_ml.ml_locked);
3264 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3265 buf->b_ml.ml_flags & ML_LOCKED_POS);
3266 buf->b_ml.ml_locked = NULL;
3269 * If lines have been added or deleted in the locked block, need to
3270 * update the line count in pointer blocks.
3272 if (buf->b_ml.ml_locked_lineadd != 0)
3273 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3276 if (action == ML_FLUSH) /* nothing else to do */
3277 return NULL;
3279 bnum = 1; /* start at the root of the tree */
3280 page_count = 1;
3281 low = 1;
3282 high = buf->b_ml.ml_line_count;
3284 if (action == ML_FIND) /* first try stack entries */
3286 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3288 ip = &(buf->b_ml.ml_stack[top]);
3289 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3291 bnum = ip->ip_bnum;
3292 low = ip->ip_low;
3293 high = ip->ip_high;
3294 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3295 break;
3298 if (top < 0)
3299 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3301 else /* ML_DELETE or ML_INSERT */
3302 buf->b_ml.ml_stack_top = 0; /* start at the root */
3305 * search downwards in the tree until a data block is found
3307 for (;;)
3309 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3310 goto error_noblock;
3313 * update high for insert/delete
3315 if (action == ML_INSERT)
3316 ++high;
3317 else if (action == ML_DELETE)
3318 --high;
3320 dp = (DATA_BL *)(hp->bh_data);
3321 if (dp->db_id == DATA_ID) /* data block */
3323 buf->b_ml.ml_locked = hp;
3324 buf->b_ml.ml_locked_low = low;
3325 buf->b_ml.ml_locked_high = high;
3326 buf->b_ml.ml_locked_lineadd = 0;
3327 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3328 return hp;
3331 pp = (PTR_BL *)(dp); /* must be pointer block */
3332 if (pp->pb_id != PTR_ID)
3334 EMSG(_("E317: pointer block id wrong"));
3335 goto error_block;
3338 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3339 goto error_block;
3340 ip = &(buf->b_ml.ml_stack[top]);
3341 ip->ip_bnum = bnum;
3342 ip->ip_low = low;
3343 ip->ip_high = high;
3344 ip->ip_index = -1; /* index not known yet */
3346 dirty = FALSE;
3347 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3349 t = pp->pb_pointer[idx].pe_line_count;
3350 CHECK(t == 0, _("pe_line_count is zero"));
3351 if ((low += t) > lnum)
3353 ip->ip_index = idx;
3354 bnum = pp->pb_pointer[idx].pe_bnum;
3355 page_count = pp->pb_pointer[idx].pe_page_count;
3356 high = low - 1;
3357 low -= t;
3360 * a negative block number may have been changed
3362 if (bnum < 0)
3364 bnum2 = mf_trans_del(mfp, bnum);
3365 if (bnum != bnum2)
3367 bnum = bnum2;
3368 pp->pb_pointer[idx].pe_bnum = bnum;
3369 dirty = TRUE;
3373 break;
3376 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3378 if (lnum > buf->b_ml.ml_line_count)
3379 EMSGN(_("E322: line number out of range: %ld past the end"),
3380 lnum - buf->b_ml.ml_line_count);
3382 else
3383 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3384 goto error_block;
3386 if (action == ML_DELETE)
3388 pp->pb_pointer[idx].pe_line_count--;
3389 dirty = TRUE;
3391 else if (action == ML_INSERT)
3393 pp->pb_pointer[idx].pe_line_count++;
3394 dirty = TRUE;
3396 mf_put(mfp, hp, dirty, FALSE);
3399 error_block:
3400 mf_put(mfp, hp, FALSE, FALSE);
3401 error_noblock:
3403 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3404 * the incremented/decremented line counts, because there won't be a line
3405 * inserted/deleted after all.
3407 if (action == ML_DELETE)
3408 ml_lineadd(buf, 1);
3409 else if (action == ML_INSERT)
3410 ml_lineadd(buf, -1);
3411 buf->b_ml.ml_stack_top = 0;
3412 return NULL;
3416 * add an entry to the info pointer stack
3418 * return -1 for failure, number of the new entry otherwise
3420 static int
3421 ml_add_stack(buf)
3422 buf_T *buf;
3424 int top;
3425 infoptr_T *newstack;
3427 top = buf->b_ml.ml_stack_top;
3429 /* may have to increase the stack size */
3430 if (top == buf->b_ml.ml_stack_size)
3432 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3434 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3435 (buf->b_ml.ml_stack_size + STACK_INCR));
3436 if (newstack == NULL)
3437 return -1;
3438 mch_memmove(newstack, buf->b_ml.ml_stack, (size_t)top * sizeof(infoptr_T));
3439 vim_free(buf->b_ml.ml_stack);
3440 buf->b_ml.ml_stack = newstack;
3441 buf->b_ml.ml_stack_size += STACK_INCR;
3444 buf->b_ml.ml_stack_top++;
3445 return top;
3449 * Update the pointer blocks on the stack for inserted/deleted lines.
3450 * The stack itself is also updated.
3452 * When a insert/delete line action fails, the line is not inserted/deleted,
3453 * but the pointer blocks have already been updated. That is fixed here by
3454 * walking through the stack.
3456 * Count is the number of lines added, negative if lines have been deleted.
3458 static void
3459 ml_lineadd(buf, count)
3460 buf_T *buf;
3461 int count;
3463 int idx;
3464 infoptr_T *ip;
3465 PTR_BL *pp;
3466 memfile_T *mfp = buf->b_ml.ml_mfp;
3467 bhdr_T *hp;
3469 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3471 ip = &(buf->b_ml.ml_stack[idx]);
3472 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3473 break;
3474 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3475 if (pp->pb_id != PTR_ID)
3477 mf_put(mfp, hp, FALSE, FALSE);
3478 EMSG(_("E317: pointer block id wrong 2"));
3479 break;
3481 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3482 ip->ip_high += count;
3483 mf_put(mfp, hp, TRUE, FALSE);
3487 #ifdef HAVE_READLINK
3488 static int resolve_symlink __ARGS((char_u *fname, char_u *buf));
3491 * Resolve a symlink in the last component of a file name.
3492 * Note that f_resolve() does it for every part of the path, we don't do that
3493 * here.
3494 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3495 * Otherwise returns FAIL.
3497 static int
3498 resolve_symlink(fname, buf)
3499 char_u *fname;
3500 char_u *buf;
3502 char_u tmp[MAXPATHL];
3503 int ret;
3504 int depth = 0;
3506 if (fname == NULL)
3507 return FAIL;
3509 /* Put the result so far in tmp[], starting with the original name. */
3510 vim_strncpy(tmp, fname, MAXPATHL - 1);
3512 for (;;)
3514 /* Limit symlink depth to 100, catch recursive loops. */
3515 if (++depth == 100)
3517 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3518 return FAIL;
3521 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3522 if (ret <= 0)
3524 if (errno == EINVAL || errno == ENOENT)
3526 /* Found non-symlink or not existing file, stop here.
3527 * When at the first level use the unmodifed name, skip the
3528 * call to vim_FullName(). */
3529 if (depth == 1)
3530 return FAIL;
3532 /* Use the resolved name in tmp[]. */
3533 break;
3536 /* There must be some error reading links, use original name. */
3537 return FAIL;
3539 buf[ret] = NUL;
3542 * Check whether the symlink is relative or absolute.
3543 * If it's relative, build a new path based on the directory
3544 * portion of the filename (if any) and the path the symlink
3545 * points to.
3547 if (mch_isFullName(buf))
3548 STRCPY(tmp, buf);
3549 else
3551 char_u *tail;
3553 tail = gettail(tmp);
3554 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3555 return FAIL;
3556 STRCPY(tail, buf);
3561 * Try to resolve the full name of the file so that the swapfile name will
3562 * be consistent even when opening a relative symlink from different
3563 * working directories.
3565 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3567 #endif
3570 * Make swap file name out of the file name and a directory name.
3571 * Returns pointer to allocated memory or NULL.
3573 /*ARGSUSED*/
3574 char_u *
3575 makeswapname(fname, ffname, buf, dir_name)
3576 char_u *fname;
3577 char_u *ffname;
3578 buf_T *buf;
3579 char_u *dir_name;
3581 char_u *r, *s;
3582 #ifdef HAVE_READLINK
3583 char_u fname_buf[MAXPATHL];
3584 char_u *fname_res;
3585 #endif
3587 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3588 s = dir_name + STRLEN(dir_name);
3589 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3590 { /* Ends with '//', Use Full path */
3591 r = NULL;
3592 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3594 r = modname(s, (char_u *)".swp", FALSE);
3595 vim_free(s);
3597 return r;
3599 #endif
3601 #ifdef HAVE_READLINK
3602 /* Expand symlink in the file name, so that we put the swap file with the
3603 * actual file instead of with the symlink. */
3604 if (resolve_symlink(fname, fname_buf) == OK)
3605 fname_res = fname_buf;
3606 else
3607 fname_res = fname;
3608 #endif
3610 r = buf_modname(
3611 #ifdef SHORT_FNAME
3612 TRUE,
3613 #else
3614 (buf->b_p_sn || buf->b_shortname),
3615 #endif
3616 #ifdef RISCOS
3617 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3618 ffname,
3619 #else
3620 # ifdef HAVE_READLINK
3621 fname_res,
3622 # else
3623 fname,
3624 # endif
3625 #endif
3626 (char_u *)
3627 #if defined(VMS) || defined(RISCOS)
3628 "_swp",
3629 #else
3630 ".swp",
3631 #endif
3632 #ifdef SHORT_FNAME /* always 8.3 file name */
3633 FALSE
3634 #else
3635 /* Prepend a '.' to the swap file name for the current directory. */
3636 dir_name[0] == '.' && dir_name[1] == NUL
3637 #endif
3639 if (r == NULL) /* out of memory */
3640 return NULL;
3642 s = get_file_in_dir(r, dir_name);
3643 vim_free(r);
3644 return s;
3648 * Get file name to use for swap file or backup file.
3649 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3650 * option "dname".
3651 * - If "dname" is ".", return "fname" (swap file in dir of file).
3652 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3653 * relative to dir of file).
3654 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3655 * dir).
3657 * The return value is an allocated string and can be NULL.
3659 char_u *
3660 get_file_in_dir(fname, dname)
3661 char_u *fname;
3662 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3664 char_u *t;
3665 char_u *tail;
3666 char_u *retval;
3667 int save_char;
3669 tail = gettail(fname);
3671 if (dname[0] == '.' && dname[1] == NUL)
3672 retval = vim_strsave(fname);
3673 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3675 if (tail == fname) /* no path before file name */
3676 retval = concat_fnames(dname + 2, tail, TRUE);
3677 else
3679 save_char = *tail;
3680 *tail = NUL;
3681 t = concat_fnames(fname, dname + 2, TRUE);
3682 *tail = save_char;
3683 if (t == NULL) /* out of memory */
3684 retval = NULL;
3685 else
3687 retval = concat_fnames(t, tail, TRUE);
3688 vim_free(t);
3692 else
3693 retval = concat_fnames(dname, tail, TRUE);
3695 return retval;
3698 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3701 * Print the ATTENTION message: info about an existing swap file.
3703 static void
3704 attention_message(buf, fname)
3705 buf_T *buf; /* buffer being edited */
3706 char_u *fname; /* swap file name */
3708 struct stat st;
3709 time_t x, sx;
3710 char *p;
3712 ++no_wait_return;
3713 (void)EMSG(_("E325: ATTENTION"));
3714 MSG_PUTS(_("\nFound a swap file by the name \""));
3715 msg_home_replace(fname);
3716 MSG_PUTS("\"\n");
3717 sx = swapfile_info(fname);
3718 MSG_PUTS(_("While opening file \""));
3719 msg_outtrans(buf->b_fname);
3720 MSG_PUTS("\"\n");
3721 if (mch_stat((char *)buf->b_fname, &st) != -1)
3723 MSG_PUTS(_(" dated: "));
3724 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3725 p = ctime(&x); /* includes '\n' */
3726 if (p == NULL)
3727 MSG_PUTS("(invalid)\n");
3728 else
3729 MSG_PUTS(p);
3730 if (sx != 0 && x > sx)
3731 MSG_PUTS(_(" NEWER than swap file!\n"));
3733 /* Some of these messages are long to allow translation to
3734 * other languages. */
3735 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"));
3736 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3737 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3738 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3739 msg_outtrans(buf->b_fname);
3740 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3741 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3742 msg_outtrans(fname);
3743 MSG_PUTS(_("\"\n to avoid this message.\n"));
3744 cmdline_row = msg_row;
3745 --no_wait_return;
3748 #ifdef FEAT_AUTOCMD
3749 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3752 * Trigger the SwapExists autocommands.
3753 * Returns a value for equivalent to do_dialog() (see below):
3754 * 0: still need to ask for a choice
3755 * 1: open read-only
3756 * 2: edit anyway
3757 * 3: recover
3758 * 4: delete it
3759 * 5: quit
3760 * 6: abort
3762 static int
3763 do_swapexists(buf, fname)
3764 buf_T *buf;
3765 char_u *fname;
3767 set_vim_var_string(VV_SWAPNAME, fname, -1);
3768 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3770 /* Trigger SwapExists autocommands with <afile> set to the file being
3771 * edited. */
3772 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3774 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3776 switch (*get_vim_var_str(VV_SWAPCHOICE))
3778 case 'o': return 1;
3779 case 'e': return 2;
3780 case 'r': return 3;
3781 case 'd': return 4;
3782 case 'q': return 5;
3783 case 'a': return 6;
3786 return 0;
3788 #endif
3791 * Find out what name to use for the swap file for buffer 'buf'.
3793 * Several names are tried to find one that does not exist
3794 * Returns the name in allocated memory or NULL.
3796 * Note: If BASENAMELEN is not correct, you will get error messages for
3797 * not being able to open the swapfile
3799 static char_u *
3800 findswapname(buf, dirp, old_fname)
3801 buf_T *buf;
3802 char_u **dirp; /* pointer to list of directories */
3803 char_u *old_fname; /* don't give warning for this file name */
3805 char_u *fname;
3806 int n;
3807 char_u *dir_name;
3808 #ifdef AMIGA
3809 BPTR fh;
3810 #endif
3811 #ifndef SHORT_FNAME
3812 int r;
3813 #endif
3815 #if !defined(SHORT_FNAME) \
3816 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3817 # define CREATE_DUMMY_FILE
3818 FILE *dummyfd = NULL;
3821 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3822 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3823 * create will be exactly the same file. To avoid this problem we temporarily
3824 * create "test.doc".
3825 * Don't do this when the check below for a 8.3 file name is used.
3827 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3828 && mch_getperm(buf->b_fname) < 0)
3829 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3830 #endif
3833 * Isolate a directory name from *dirp and put it in dir_name.
3834 * First allocate some memory to put the directory name in.
3836 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3837 if (dir_name != NULL)
3838 (void)copy_option_part(dirp, dir_name, 31000, ",");
3841 * we try different names until we find one that does not exist yet
3843 if (dir_name == NULL) /* out of memory */
3844 fname = NULL;
3845 else
3846 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3848 for (;;)
3850 if (fname == NULL) /* must be out of memory */
3851 break;
3852 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3854 vim_free(fname);
3855 fname = NULL;
3856 break;
3858 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3860 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3861 * file names. If this is the first try and the swap file name does not fit in
3862 * 8.3, detect if this is the case, set shortname and try again.
3864 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3865 && !(buf->b_p_sn || buf->b_shortname))
3867 char_u *tail;
3868 char_u *fname2;
3869 struct stat s1, s2;
3870 int f1, f2;
3871 int created1 = FALSE, created2 = FALSE;
3872 int same = FALSE;
3875 * Check if swapfile name does not fit in 8.3:
3876 * It either contains two dots, is longer than 8 chars, or starts
3877 * with a dot.
3879 tail = gettail(buf->b_fname);
3880 if ( vim_strchr(tail, '.') != NULL
3881 || STRLEN(tail) > (size_t)8
3882 || *gettail(fname) == '.')
3884 fname2 = alloc(n + 2);
3885 if (fname2 != NULL)
3887 STRCPY(fname2, fname);
3888 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3889 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3890 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3892 if (vim_strchr(tail, '.') != NULL)
3893 fname2[n - 1] = 'x';
3894 else if (*gettail(fname) == '.')
3896 fname2[n] = 'x';
3897 fname2[n + 1] = NUL;
3899 else
3900 fname2[n - 5] += 1;
3902 * may need to create the files to be able to use mch_stat()
3904 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3905 if (f1 < 0)
3907 f1 = mch_open_rw((char *)fname,
3908 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3909 #if defined(OS2)
3910 if (f1 < 0 && errno == ENOENT)
3911 same = TRUE;
3912 #endif
3913 created1 = TRUE;
3915 if (f1 >= 0)
3917 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3918 if (f2 < 0)
3920 f2 = mch_open_rw((char *)fname2,
3921 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3922 created2 = TRUE;
3924 if (f2 >= 0)
3927 * Both files exist now. If mch_stat() returns the
3928 * same device and inode they are the same file.
3930 if (mch_fstat(f1, &s1) != -1
3931 && mch_fstat(f2, &s2) != -1
3932 && s1.st_dev == s2.st_dev
3933 && s1.st_ino == s2.st_ino)
3934 same = TRUE;
3935 close(f2);
3936 if (created2)
3937 mch_remove(fname2);
3939 close(f1);
3940 if (created1)
3941 mch_remove(fname);
3943 vim_free(fname2);
3944 if (same)
3946 buf->b_shortname = TRUE;
3947 vim_free(fname);
3948 fname = makeswapname(buf->b_fname, buf->b_ffname,
3949 buf, dir_name);
3950 continue; /* try again with b_shortname set */
3955 #endif
3957 * check if the swapfile already exists
3959 if (mch_getperm(fname) < 0) /* it does not exist */
3961 #ifdef HAVE_LSTAT
3962 struct stat sb;
3965 * Extra security check: When a swap file is a symbolic link, this
3966 * is most likely a symlink attack.
3968 if (mch_lstat((char *)fname, &sb) < 0)
3969 #else
3970 # ifdef AMIGA
3971 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
3973 * on the Amiga mch_getperm() will return -1 when the file exists
3974 * but is being used by another program. This happens if you edit
3975 * a file twice.
3977 if (fh != (BPTR)NULL) /* can open file, OK */
3979 Close(fh);
3980 mch_remove(fname);
3981 break;
3983 if (IoErr() != ERROR_OBJECT_IN_USE
3984 && IoErr() != ERROR_OBJECT_EXISTS)
3985 # endif
3986 #endif
3987 break;
3991 * A file name equal to old_fname is OK to use.
3993 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
3994 break;
3997 * get here when file already exists
3999 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4001 #ifndef SHORT_FNAME
4003 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4004 * and file.doc are the same file. To guess if this problem is
4005 * present try if file.doc.swx exists. If it does, we set
4006 * buf->b_shortname and try file_doc.swp (dots replaced by
4007 * underscores for this file), and try again. If it doesn't we
4008 * assume that "file.doc.swp" already exists.
4010 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4012 fname[n - 1] = 'x';
4013 r = mch_getperm(fname); /* try "file.swx" */
4014 fname[n - 1] = 'p';
4015 if (r >= 0) /* "file.swx" seems to exist */
4017 buf->b_shortname = TRUE;
4018 vim_free(fname);
4019 fname = makeswapname(buf->b_fname, buf->b_ffname,
4020 buf, dir_name);
4021 continue; /* try again with '.' replaced with '_' */
4024 #endif
4026 * If we get here the ".swp" file really exists.
4027 * Give an error message, unless recovering, no file name, we are
4028 * viewing a help file or when the path of the file is different
4029 * (happens when all .swp files are in one directory).
4031 if (!recoverymode && buf->b_fname != NULL
4032 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4034 int fd;
4035 struct block0 b0;
4036 int differ = FALSE;
4039 * Try to read block 0 from the swap file to get the original
4040 * file name (and inode number).
4042 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4043 if (fd >= 0)
4045 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4048 * If the swapfile has the same directory as the
4049 * buffer don't compare the directory names, they can
4050 * have a different mountpoint.
4052 if (b0.b0_flags & B0_SAME_DIR)
4054 if (fnamecmp(gettail(buf->b_ffname),
4055 gettail(b0.b0_fname)) != 0
4056 || !same_directory(fname, buf->b_ffname))
4058 #ifdef CHECK_INODE
4059 /* Symlinks may point to the same file even
4060 * when the name differs, need to check the
4061 * inode too. */
4062 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4063 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4064 char_to_long(b0.b0_ino)))
4065 #endif
4066 differ = TRUE;
4069 else
4072 * The name in the swap file may be
4073 * "~user/path/file". Expand it first.
4075 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4076 #ifdef CHECK_INODE
4077 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4078 char_to_long(b0.b0_ino)))
4079 differ = TRUE;
4080 #else
4081 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4082 differ = TRUE;
4083 #endif
4086 close(fd);
4088 #ifdef RISCOS
4089 else
4090 /* Can't open swap file, though it does exist.
4091 * Assume that the user is editing two files with
4092 * the same name in different directories. No error.
4094 differ = TRUE;
4095 #endif
4097 /* give the ATTENTION message when there is an old swap file
4098 * for the current file, and the buffer was not recovered. */
4099 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4100 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4102 #if defined(HAS_SWAP_EXISTS_ACTION)
4103 int choice = 0;
4104 #endif
4105 #ifdef CREATE_DUMMY_FILE
4106 int did_use_dummy = FALSE;
4108 /* Avoid getting a warning for the file being created
4109 * outside of Vim, it was created at the start of this
4110 * function. Delete the file now, because Vim might exit
4111 * here if the window is closed. */
4112 if (dummyfd != NULL)
4114 fclose(dummyfd);
4115 dummyfd = NULL;
4116 mch_remove(buf->b_fname);
4117 did_use_dummy = TRUE;
4119 #endif
4121 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4122 process_still_running = FALSE;
4123 #endif
4124 #ifdef FEAT_AUTOCMD
4126 * If there is an SwapExists autocommand and we can handle
4127 * the response, trigger it. It may return 0 to ask the
4128 * user anyway.
4130 if (swap_exists_action != SEA_NONE
4131 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4132 choice = do_swapexists(buf, fname);
4134 if (choice == 0)
4135 #endif
4137 #ifdef FEAT_GUI
4138 /* If we are supposed to start the GUI but it wasn't
4139 * completely started yet, start it now. This makes
4140 * the messages displayed in the Vim window when
4141 * loading a session from the .gvimrc file. */
4142 if (gui.starting && !gui.in_use)
4143 gui_start();
4144 #endif
4145 /* Show info about the existing swap file. */
4146 attention_message(buf, fname);
4148 /* We don't want a 'q' typed at the more-prompt
4149 * interrupt loading a file. */
4150 got_int = FALSE;
4153 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4154 if (swap_exists_action != SEA_NONE && choice == 0)
4156 char_u *name;
4158 name = alloc((unsigned)(STRLEN(fname)
4159 + STRLEN(_("Swap file \""))
4160 + STRLEN(_("\" already exists!")) + 5));
4161 if (name != NULL)
4163 STRCPY(name, _("Swap file \""));
4164 home_replace(NULL, fname, name + STRLEN(name),
4165 1000, TRUE);
4166 STRCAT(name, _("\" already exists!"));
4168 choice = do_dialog(VIM_WARNING,
4169 (char_u *)_("VIM - ATTENTION"),
4170 name == NULL
4171 ? (char_u *)_("Swap file already exists!")
4172 : name,
4173 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4174 process_still_running
4175 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4176 # endif
4177 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4179 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4180 if (process_still_running && choice >= 4)
4181 choice++; /* Skip missing "Delete it" button */
4182 # endif
4183 vim_free(name);
4185 /* pretend screen didn't scroll, need redraw anyway */
4186 msg_scrolled = 0;
4187 redraw_all_later(NOT_VALID);
4189 #endif
4191 #if defined(HAS_SWAP_EXISTS_ACTION)
4192 if (choice > 0)
4194 switch (choice)
4196 case 1:
4197 buf->b_p_ro = TRUE;
4198 break;
4199 case 2:
4200 break;
4201 case 3:
4202 swap_exists_action = SEA_RECOVER;
4203 break;
4204 case 4:
4205 mch_remove(fname);
4206 break;
4207 case 5:
4208 swap_exists_action = SEA_QUIT;
4209 break;
4210 case 6:
4211 swap_exists_action = SEA_QUIT;
4212 got_int = TRUE;
4213 break;
4216 /* If the file was deleted this fname can be used. */
4217 if (mch_getperm(fname) < 0)
4218 break;
4220 else
4221 #endif
4223 MSG_PUTS("\n");
4224 if (msg_silent == 0)
4225 /* call wait_return() later */
4226 need_wait_return = TRUE;
4229 #ifdef CREATE_DUMMY_FILE
4230 /* Going to try another name, need the dummy file again. */
4231 if (did_use_dummy)
4232 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4233 #endif
4239 * Change the ".swp" extension to find another file that can be used.
4240 * First decrement the last char: ".swo", ".swn", etc.
4241 * If that still isn't enough decrement the last but one char: ".svz"
4242 * Can happen when editing many "No Name" buffers.
4244 if (fname[n - 1] == 'a') /* ".s?a" */
4246 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4248 EMSG(_("E326: Too many swap files found"));
4249 vim_free(fname);
4250 fname = NULL;
4251 break;
4253 --fname[n - 2]; /* ".svz", ".suz", etc. */
4254 fname[n - 1] = 'z' + 1;
4256 --fname[n - 1]; /* ".swo", ".swn", etc. */
4259 vim_free(dir_name);
4260 #ifdef CREATE_DUMMY_FILE
4261 if (dummyfd != NULL) /* file has been created temporarily */
4263 fclose(dummyfd);
4264 mch_remove(buf->b_fname);
4266 #endif
4267 return fname;
4270 static int
4271 b0_magic_wrong(b0p)
4272 ZERO_BL *b0p;
4274 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4275 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4276 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4277 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4280 #ifdef CHECK_INODE
4282 * Compare current file name with file name from swap file.
4283 * Try to use inode numbers when possible.
4284 * Return non-zero when files are different.
4286 * When comparing file names a few things have to be taken into consideration:
4287 * - When working over a network the full path of a file depends on the host.
4288 * We check the inode number if possible. It is not 100% reliable though,
4289 * because the device number cannot be used over a network.
4290 * - When a file does not exist yet (editing a new file) there is no inode
4291 * number.
4292 * - The file name in a swap file may not be valid on the current host. The
4293 * "~user" form is used whenever possible to avoid this.
4295 * This is getting complicated, let's make a table:
4297 * ino_c ino_s fname_c fname_s differ =
4299 * both files exist -> compare inode numbers:
4300 * != 0 != 0 X X ino_c != ino_s
4302 * inode number(s) unknown, file names available -> compare file names
4303 * == 0 X OK OK fname_c != fname_s
4304 * X == 0 OK OK fname_c != fname_s
4306 * current file doesn't exist, file for swap file exist, file name(s) not
4307 * available -> probably different
4308 * == 0 != 0 FAIL X TRUE
4309 * == 0 != 0 X FAIL TRUE
4311 * current file exists, inode for swap unknown, file name(s) not
4312 * available -> probably different
4313 * != 0 == 0 FAIL X TRUE
4314 * != 0 == 0 X FAIL TRUE
4316 * current file doesn't exist, inode for swap unknown, one file name not
4317 * available -> probably different
4318 * == 0 == 0 FAIL OK TRUE
4319 * == 0 == 0 OK FAIL TRUE
4321 * current file doesn't exist, inode for swap unknown, both file names not
4322 * available -> probably same file
4323 * == 0 == 0 FAIL FAIL FALSE
4325 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4326 * can't be changed without making the block 0 incompatible with 32 bit
4327 * versions.
4330 static int
4331 fnamecmp_ino(fname_c, fname_s, ino_block0)
4332 char_u *fname_c; /* current file name */
4333 char_u *fname_s; /* file name from swap file */
4334 long ino_block0;
4336 struct stat st;
4337 ino_t ino_c = 0; /* ino of current file */
4338 ino_t ino_s; /* ino of file from swap file */
4339 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4340 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4341 int retval_c; /* flag: buf_c valid */
4342 int retval_s; /* flag: buf_s valid */
4344 if (mch_stat((char *)fname_c, &st) == 0)
4345 ino_c = (ino_t)st.st_ino;
4348 * First we try to get the inode from the file name, because the inode in
4349 * the swap file may be outdated. If that fails (e.g. this path is not
4350 * valid on this machine), use the inode from block 0.
4352 if (mch_stat((char *)fname_s, &st) == 0)
4353 ino_s = (ino_t)st.st_ino;
4354 else
4355 ino_s = (ino_t)ino_block0;
4357 if (ino_c && ino_s)
4358 return (ino_c != ino_s);
4361 * One of the inode numbers is unknown, try a forced vim_FullName() and
4362 * compare the file names.
4364 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4365 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4366 if (retval_c == OK && retval_s == OK)
4367 return (STRCMP(buf_c, buf_s) != 0);
4370 * Can't compare inodes or file names, guess that the files are different,
4371 * unless both appear not to exist at all.
4373 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4374 return FALSE;
4375 return TRUE;
4377 #endif /* CHECK_INODE */
4380 * Move a long integer into a four byte character array.
4381 * Used for machine independency in block zero.
4383 static void
4384 long_to_char(n, s)
4385 long n;
4386 char_u *s;
4388 s[0] = (char_u)(n & 0xff);
4389 n = (unsigned)n >> 8;
4390 s[1] = (char_u)(n & 0xff);
4391 n = (unsigned)n >> 8;
4392 s[2] = (char_u)(n & 0xff);
4393 n = (unsigned)n >> 8;
4394 s[3] = (char_u)(n & 0xff);
4397 static long
4398 char_to_long(s)
4399 char_u *s;
4401 long retval;
4403 retval = s[3];
4404 retval <<= 8;
4405 retval |= s[2];
4406 retval <<= 8;
4407 retval |= s[1];
4408 retval <<= 8;
4409 retval |= s[0];
4411 return retval;
4415 * Set the flags in the first block of the swap file:
4416 * - file is modified or not: buf->b_changed
4417 * - 'fileformat'
4418 * - 'fileencoding'
4420 void
4421 ml_setflags(buf)
4422 buf_T *buf;
4424 bhdr_T *hp;
4425 ZERO_BL *b0p;
4427 if (!buf->b_ml.ml_mfp)
4428 return;
4429 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4431 if (hp->bh_bnum == 0)
4433 b0p = (ZERO_BL *)(hp->bh_data);
4434 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4435 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4436 | (get_fileformat(buf) + 1);
4437 #ifdef FEAT_MBYTE
4438 add_b0_fenc(b0p, buf);
4439 #endif
4440 hp->bh_flags |= BH_DIRTY;
4441 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4442 break;
4447 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4449 #define MLCS_MAXL 800 /* max no of lines in chunk */
4450 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4453 * Keep information for finding byte offset of a line, updtytpe may be one of:
4454 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4455 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4456 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4457 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4459 static void
4460 ml_updatechunk(buf, line, len, updtype)
4461 buf_T *buf;
4462 linenr_T line;
4463 long len;
4464 int updtype;
4466 static buf_T *ml_upd_lastbuf = NULL;
4467 static linenr_T ml_upd_lastline;
4468 static linenr_T ml_upd_lastcurline;
4469 static int ml_upd_lastcurix;
4471 linenr_T curline = ml_upd_lastcurline;
4472 int curix = ml_upd_lastcurix;
4473 long size;
4474 chunksize_T *curchnk;
4475 int rest;
4476 bhdr_T *hp;
4477 DATA_BL *dp;
4479 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4480 return;
4481 if (buf->b_ml.ml_chunksize == NULL)
4483 buf->b_ml.ml_chunksize = (chunksize_T *)
4484 alloc((unsigned)sizeof(chunksize_T) * 100);
4485 if (buf->b_ml.ml_chunksize == NULL)
4487 buf->b_ml.ml_usedchunks = -1;
4488 return;
4490 buf->b_ml.ml_numchunks = 100;
4491 buf->b_ml.ml_usedchunks = 1;
4492 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4493 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4496 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4499 * First line in empty buffer from ml_flush_line() -- reset
4501 buf->b_ml.ml_usedchunks = 1;
4502 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4503 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4504 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4505 return;
4509 * Find chunk that our line belongs to, curline will be at start of the
4510 * chunk.
4512 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4513 || updtype != ML_CHNK_ADDLINE)
4515 for (curline = 1, curix = 0;
4516 curix < buf->b_ml.ml_usedchunks - 1
4517 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4518 curix++)
4520 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4523 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4524 && curix < buf->b_ml.ml_usedchunks - 1)
4526 /* Adjust cached curix & curline */
4527 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4528 curix++;
4530 curchnk = buf->b_ml.ml_chunksize + curix;
4532 if (updtype == ML_CHNK_DELLINE)
4533 len = -len;
4534 curchnk->mlcs_totalsize += len;
4535 if (updtype == ML_CHNK_ADDLINE)
4537 curchnk->mlcs_numlines++;
4539 /* May resize here so we don't have to do it in both cases below */
4540 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4542 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4543 buf->b_ml.ml_chunksize = (chunksize_T *)
4544 vim_realloc(buf->b_ml.ml_chunksize,
4545 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4546 if (buf->b_ml.ml_chunksize == NULL)
4548 /* Hmmmm, Give up on offset for this buffer */
4549 buf->b_ml.ml_usedchunks = -1;
4550 return;
4554 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4556 int count; /* number of entries in block */
4557 int idx;
4558 int text_end;
4559 int linecnt;
4561 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4562 buf->b_ml.ml_chunksize + curix,
4563 (buf->b_ml.ml_usedchunks - curix) *
4564 sizeof(chunksize_T));
4565 /* Compute length of first half of lines in the splitted chunk */
4566 size = 0;
4567 linecnt = 0;
4568 while (curline < buf->b_ml.ml_line_count
4569 && linecnt < MLCS_MINL)
4571 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4573 buf->b_ml.ml_usedchunks = -1;
4574 return;
4576 dp = (DATA_BL *)(hp->bh_data);
4577 count = (long)(buf->b_ml.ml_locked_high) -
4578 (long)(buf->b_ml.ml_locked_low) + 1;
4579 idx = curline - buf->b_ml.ml_locked_low;
4580 curline = buf->b_ml.ml_locked_high + 1;
4581 if (idx == 0)/* first line in block, text at the end */
4582 text_end = dp->db_txt_end;
4583 else
4584 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4585 /* Compute index of last line to use in this MEMLINE */
4586 rest = count - idx;
4587 if (linecnt + rest > MLCS_MINL)
4589 idx += MLCS_MINL - linecnt - 1;
4590 linecnt = MLCS_MINL;
4592 else
4594 idx = count - 1;
4595 linecnt += rest;
4597 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4599 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4600 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4601 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4602 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4603 buf->b_ml.ml_usedchunks++;
4604 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4605 return;
4607 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4608 && curix == buf->b_ml.ml_usedchunks - 1
4609 && buf->b_ml.ml_line_count - line <= 1)
4612 * We are in the last chunk and it is cheap to crate a new one
4613 * after this. Do it now to avoid the loop above later on
4615 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4616 buf->b_ml.ml_usedchunks++;
4617 if (line == buf->b_ml.ml_line_count)
4619 curchnk->mlcs_numlines = 0;
4620 curchnk->mlcs_totalsize = 0;
4622 else
4625 * Line is just prior to last, move count for last
4626 * This is the common case when loading a new file
4628 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4629 if (hp == NULL)
4631 buf->b_ml.ml_usedchunks = -1;
4632 return;
4634 dp = (DATA_BL *)(hp->bh_data);
4635 if (dp->db_line_count == 1)
4636 rest = dp->db_txt_end - dp->db_txt_start;
4637 else
4638 rest =
4639 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4640 - dp->db_txt_start;
4641 curchnk->mlcs_totalsize = rest;
4642 curchnk->mlcs_numlines = 1;
4643 curchnk[-1].mlcs_totalsize -= rest;
4644 curchnk[-1].mlcs_numlines -= 1;
4648 else if (updtype == ML_CHNK_DELLINE)
4650 curchnk->mlcs_numlines--;
4651 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4652 if (curix < (buf->b_ml.ml_usedchunks - 1)
4653 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4654 <= MLCS_MINL)
4656 curix++;
4657 curchnk = buf->b_ml.ml_chunksize + curix;
4659 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4661 buf->b_ml.ml_usedchunks--;
4662 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4663 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4664 return;
4666 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4667 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4668 > MLCS_MINL))
4670 return;
4673 /* Collapse chunks */
4674 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4675 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4676 buf->b_ml.ml_usedchunks--;
4677 if (curix < buf->b_ml.ml_usedchunks)
4679 mch_memmove(buf->b_ml.ml_chunksize + curix,
4680 buf->b_ml.ml_chunksize + curix + 1,
4681 (buf->b_ml.ml_usedchunks - curix) *
4682 sizeof(chunksize_T));
4684 return;
4686 ml_upd_lastbuf = buf;
4687 ml_upd_lastline = line;
4688 ml_upd_lastcurline = curline;
4689 ml_upd_lastcurix = curix;
4693 * Find offset for line or line with offset.
4694 * Find line with offset if "lnum" is 0; return remaining offset in offp
4695 * Find offset of line if "lnum" > 0
4696 * return -1 if information is not available
4698 long
4699 ml_find_line_or_offset(buf, lnum, offp)
4700 buf_T *buf;
4701 linenr_T lnum;
4702 long *offp;
4704 linenr_T curline;
4705 int curix;
4706 long size;
4707 bhdr_T *hp;
4708 DATA_BL *dp;
4709 int count; /* number of entries in block */
4710 int idx;
4711 int start_idx;
4712 int text_end;
4713 long offset;
4714 int len;
4715 int ffdos = (get_fileformat(buf) == EOL_DOS);
4716 int extra = 0;
4718 /* take care of cached line first */
4719 ml_flush_line(curbuf);
4721 if (buf->b_ml.ml_usedchunks == -1
4722 || buf->b_ml.ml_chunksize == NULL
4723 || lnum < 0)
4724 return -1;
4726 if (offp == NULL)
4727 offset = 0;
4728 else
4729 offset = *offp;
4730 if (lnum == 0 && offset <= 0)
4731 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4733 * Find the last chunk before the one containing our line. Last chunk is
4734 * special because it will never qualify
4736 curline = 1;
4737 curix = size = 0;
4738 while (curix < buf->b_ml.ml_usedchunks - 1
4739 && ((lnum != 0
4740 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4741 || (offset != 0
4742 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4743 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4745 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4746 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4747 if (offset && ffdos)
4748 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4749 curix++;
4752 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4754 if (curline > buf->b_ml.ml_line_count
4755 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4756 return -1;
4757 dp = (DATA_BL *)(hp->bh_data);
4758 count = (long)(buf->b_ml.ml_locked_high) -
4759 (long)(buf->b_ml.ml_locked_low) + 1;
4760 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4761 if (idx == 0)/* first line in block, text at the end */
4762 text_end = dp->db_txt_end;
4763 else
4764 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4765 /* Compute index of last line to use in this MEMLINE */
4766 if (lnum != 0)
4768 if (curline + (count - idx) >= lnum)
4769 idx += lnum - curline - 1;
4770 else
4771 idx = count - 1;
4773 else
4775 extra = 0;
4776 while (offset >= size
4777 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4778 + ffdos)
4780 if (ffdos)
4781 size++;
4782 if (idx == count - 1)
4784 extra = 1;
4785 break;
4787 idx++;
4790 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4791 size += len;
4792 if (offset != 0 && size >= offset)
4794 if (size + ffdos == offset)
4795 *offp = 0;
4796 else if (idx == start_idx)
4797 *offp = offset - size + len;
4798 else
4799 *offp = offset - size + len
4800 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4801 curline += idx - start_idx + extra;
4802 if (curline > buf->b_ml.ml_line_count)
4803 return -1; /* exactly one byte beyond the end */
4804 return curline;
4806 curline = buf->b_ml.ml_locked_high + 1;
4809 if (lnum != 0)
4811 /* Count extra CR characters. */
4812 if (ffdos)
4813 size += lnum - 1;
4815 /* Don't count the last line break if 'bin' and 'noeol'. */
4816 if (buf->b_p_bin && !buf->b_p_eol)
4817 size -= ffdos + 1;
4820 return size;
4824 * Goto byte in buffer with offset 'cnt'.
4826 void
4827 goto_byte(cnt)
4828 long cnt;
4830 long boff = cnt;
4831 linenr_T lnum;
4833 ml_flush_line(curbuf); /* cached line may be dirty */
4834 setpcmark();
4835 if (boff)
4836 --boff;
4837 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4838 if (lnum < 1) /* past the end */
4840 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4841 curwin->w_curswant = MAXCOL;
4842 coladvance((colnr_T)MAXCOL);
4844 else
4846 curwin->w_cursor.lnum = lnum;
4847 curwin->w_cursor.col = (colnr_T)boff;
4848 # ifdef FEAT_VIRTUALEDIT
4849 curwin->w_cursor.coladd = 0;
4850 # endif
4851 curwin->w_set_curswant = TRUE;
4853 check_cursor();
4855 # ifdef FEAT_MBYTE
4856 /* Make sure the cursor is on the first byte of a multi-byte char. */
4857 if (has_mbyte)
4858 mb_adjust_cursor();
4859 # endif
4861 #endif