Merge branch 'vim' into feat/emb-common-lisp
[vim_extended.git] / src / memline.c
blob849011dfb1ef1c47e33271e6aae3c20d13a7adde
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
10 /* for debugging */
11 /* #define CHECK(c, s) if (c) EMSG(s) */
12 #define CHECK(c, s)
15 * memline.c: Contains the functions for appending, deleting and changing the
16 * text lines. The memfile functions are used to store the information in
17 * blocks of memory, backed up by a file. The structure of the information is
18 * a tree. The root of the tree is a pointer block. The leaves of the tree
19 * are data blocks. In between may be several layers of pointer blocks,
20 * forming branches.
22 * Three types of blocks are used:
23 * - Block nr 0 contains information for recovery
24 * - Pointer blocks contain list of pointers to other blocks.
25 * - Data blocks contain the actual text.
27 * Block nr 0 contains the block0 structure (see below).
29 * Block nr 1 is the first pointer block. It is the root of the tree.
30 * Other pointer blocks are branches.
32 * If a line is too big to fit in a single page, the block containing that
33 * line is made big enough to hold the line. It may span several pages.
34 * Otherwise all blocks are one page.
36 * A data block that was filled when starting to edit a file and was not
37 * changed since then, can have a negative block number. This means that it
38 * has not yet been assigned a place in the file. When recovering, the lines
39 * in this data block can be read from the original file. When the block is
40 * changed (lines appended/deleted/changed) or when it is flushed it gets a
41 * positive number. Use mf_trans_del() to get the new number, before calling
42 * mf_get().
45 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
46 # include "vimio.h" /* for mch_open(), must be before vim.h */
47 #endif
49 #include "vim.h"
51 #ifndef UNIX /* it's in os_unix.h for Unix */
52 # include <time.h>
53 #endif
55 #if defined(SASC) || defined(__amigaos4__)
56 # include <proto/dos.h> /* for Open() and Close() */
57 #endif
59 #ifdef HAVE_ERRNO_H
60 # include <errno.h>
61 #endif
63 typedef struct block0 ZERO_BL; /* contents of the first block */
64 typedef struct pointer_block PTR_BL; /* contents of a pointer block */
65 typedef struct data_block DATA_BL; /* contents of a data block */
66 typedef struct pointer_entry PTR_EN; /* block/line-count pair */
68 #define DATA_ID (('d' << 8) + 'a') /* data block id */
69 #define PTR_ID (('p' << 8) + 't') /* pointer block id */
70 #define BLOCK0_ID0 'b' /* block 0 id 0 */
71 #define BLOCK0_ID1 '0' /* block 0 id 1 */
74 * pointer to a block, used in a pointer block
76 struct pointer_entry
78 blocknr_T pe_bnum; /* block number */
79 linenr_T pe_line_count; /* number of lines in this branch */
80 linenr_T pe_old_lnum; /* lnum for this block (for recovery) */
81 int pe_page_count; /* number of pages in block pe_bnum */
85 * A pointer block contains a list of branches in the tree.
87 struct pointer_block
89 short_u pb_id; /* ID for pointer block: PTR_ID */
90 short_u pb_count; /* number of pointer in this block */
91 short_u pb_count_max; /* maximum value for pb_count */
92 PTR_EN pb_pointer[1]; /* list of pointers to blocks (actually longer)
93 * followed by empty space until end of page */
97 * A data block is a leaf in the tree.
99 * The text of the lines is at the end of the block. The text of the first line
100 * in the block is put at the end, the text of the second line in front of it,
101 * etc. Thus the order of the lines is the opposite of the line number.
103 struct data_block
105 short_u db_id; /* ID for data block: DATA_ID */
106 unsigned db_free; /* free space available */
107 unsigned db_txt_start; /* byte where text starts */
108 unsigned db_txt_end; /* byte just after data block */
109 linenr_T db_line_count; /* number of lines in this block */
110 unsigned db_index[1]; /* index for start of line (actually bigger)
111 * followed by empty space upto db_txt_start
112 * followed by the text in the lines until
113 * end of page */
117 * The low bits of db_index hold the actual index. The topmost bit is
118 * used for the global command to be able to mark a line.
119 * This method is not clean, but otherwise there would be at least one extra
120 * byte used for each line.
121 * The mark has to be in this place to keep it with the correct line when other
122 * lines are inserted or deleted.
124 #define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
125 #define DB_INDEX_MASK (~DB_MARKED)
127 #define INDEX_SIZE (sizeof(unsigned)) /* size of one db_index entry */
128 #define HEADER_SIZE (sizeof(DATA_BL) - INDEX_SIZE) /* size of data block header */
130 #define B0_FNAME_SIZE_ORG 900 /* what it was in older versions */
131 #define B0_FNAME_SIZE 898
132 #define B0_UNAME_SIZE 40
133 #define B0_HNAME_SIZE 40
135 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
136 * This won't detect a 64 bit machine that only swaps a byte in the top 32
137 * bits, but that is crazy anyway.
139 #define B0_MAGIC_LONG 0x30313233L
140 #define B0_MAGIC_INT 0x20212223L
141 #define B0_MAGIC_SHORT 0x10111213L
142 #define B0_MAGIC_CHAR 0x55
145 * Block zero holds all info about the swap file.
147 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
148 * swap files unusable!
150 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
152 * This block is built up of single bytes, to make it portable across
153 * different machines. b0_magic_* is used to check the byte order and size of
154 * variables, because the rest of the swap file is not portable.
156 struct block0
158 char_u b0_id[2]; /* id for block 0: BLOCK0_ID0 and BLOCK0_ID1 */
159 char_u b0_version[10]; /* Vim version string */
160 char_u b0_page_size[4];/* number of bytes per page */
161 char_u b0_mtime[4]; /* last modification time of file */
162 char_u b0_ino[4]; /* inode of b0_fname */
163 char_u b0_pid[4]; /* process id of creator (or 0) */
164 char_u b0_uname[B0_UNAME_SIZE]; /* name of user (uid if no name) */
165 char_u b0_hname[B0_HNAME_SIZE]; /* host name (if it has a name) */
166 char_u b0_fname[B0_FNAME_SIZE_ORG]; /* name of file being edited */
167 long b0_magic_long; /* check for byte order of long */
168 int b0_magic_int; /* check for byte order of int */
169 short b0_magic_short; /* check for byte order of short */
170 char_u b0_magic_char; /* check for last char */
174 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
175 * long file names in older versions of Vim they are invalid.
176 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
177 * when there is room, for very long file names it's omitted.
179 #define B0_DIRTY 0x55
180 #define b0_dirty b0_fname[B0_FNAME_SIZE_ORG-1]
183 * The b0_flags field is new in Vim 7.0.
185 #define b0_flags b0_fname[B0_FNAME_SIZE_ORG-2]
187 /* The lowest two bits contain the fileformat. Zero means it's not set
188 * (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
189 * EOL_MAC + 1. */
190 #define B0_FF_MASK 3
192 /* Swap file is in directory of edited file. Used to find the file from
193 * different mount points. */
194 #define B0_SAME_DIR 4
196 /* The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
197 * When empty there is only the NUL. */
198 #define B0_HAS_FENC 8
200 #define STACK_INCR 5 /* nr of entries added to ml_stack at a time */
203 * The line number where the first mark may be is remembered.
204 * If it is 0 there are no marks at all.
205 * (always used for the current buffer only, no buffer change possible while
206 * executing a global command).
208 static linenr_T lowest_marked = 0;
211 * arguments for ml_find_line()
213 #define ML_DELETE 0x11 /* delete line */
214 #define ML_INSERT 0x12 /* insert line */
215 #define ML_FIND 0x13 /* just find the line */
216 #define ML_FLUSH 0x02 /* flush locked block */
217 #define ML_SIMPLE(x) (x & 0x10) /* DEL, INS or FIND */
219 static void ml_upd_block0 __ARGS((buf_T *buf, int set_fname));
220 static void set_b0_fname __ARGS((ZERO_BL *, buf_T *buf));
221 static void set_b0_dir_flag __ARGS((ZERO_BL *b0p, buf_T *buf));
222 #ifdef FEAT_MBYTE
223 static void add_b0_fenc __ARGS((ZERO_BL *b0p, buf_T *buf));
224 #endif
225 static time_t swapfile_info __ARGS((char_u *));
226 static int recov_file_names __ARGS((char_u **, char_u *, int prepend_dot));
227 static int ml_append_int __ARGS((buf_T *, linenr_T, char_u *, colnr_T, int, int));
228 static int ml_delete_int __ARGS((buf_T *, linenr_T, int));
229 static char_u *findswapname __ARGS((buf_T *, char_u **, char_u *));
230 static void ml_flush_line __ARGS((buf_T *));
231 static bhdr_T *ml_new_data __ARGS((memfile_T *, int, int));
232 static bhdr_T *ml_new_ptr __ARGS((memfile_T *));
233 static bhdr_T *ml_find_line __ARGS((buf_T *, linenr_T, int));
234 static int ml_add_stack __ARGS((buf_T *));
235 static void ml_lineadd __ARGS((buf_T *, int));
236 static int b0_magic_wrong __ARGS((ZERO_BL *));
237 #ifdef CHECK_INODE
238 static int fnamecmp_ino __ARGS((char_u *, char_u *, long));
239 #endif
240 static void long_to_char __ARGS((long, char_u *));
241 static long char_to_long __ARGS((char_u *));
242 #if defined(UNIX) || defined(WIN3264)
243 static char_u *make_percent_swname __ARGS((char_u *dir, char_u *name));
244 #endif
245 #ifdef FEAT_BYTEOFF
246 static void ml_updatechunk __ARGS((buf_T *buf, long line, long len, int updtype));
247 #endif
250 * Open a new memline for "buf".
252 * Return FAIL for failure, OK otherwise.
255 ml_open(buf)
256 buf_T *buf;
258 memfile_T *mfp;
259 bhdr_T *hp = NULL;
260 ZERO_BL *b0p;
261 PTR_BL *pp;
262 DATA_BL *dp;
265 * init fields in memline struct
267 buf->b_ml.ml_stack_size = 0; /* no stack yet */
268 buf->b_ml.ml_stack = NULL; /* no stack yet */
269 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
270 buf->b_ml.ml_locked = NULL; /* no cached block */
271 buf->b_ml.ml_line_lnum = 0; /* no cached line */
272 #ifdef FEAT_BYTEOFF
273 buf->b_ml.ml_chunksize = NULL;
274 #endif
277 * When 'updatecount' is non-zero swap file may be opened later.
279 if (p_uc && buf->b_p_swf)
280 buf->b_may_swap = TRUE;
281 else
282 buf->b_may_swap = FALSE;
285 * Open the memfile. No swap file is created yet.
287 mfp = mf_open(NULL, 0);
288 if (mfp == NULL)
289 goto error;
291 buf->b_ml.ml_mfp = mfp;
292 buf->b_ml.ml_flags = ML_EMPTY;
293 buf->b_ml.ml_line_max = 0;
294 buf->b_ml.ml_line_count = 1;
295 #ifdef FEAT_LINEBREAK
296 curwin->w_nrwidth_line_count = 0;
297 #endif
299 #if defined(MSDOS) && !defined(DJGPP)
300 /* for 16 bit MS-DOS create a swapfile now, because we run out of
301 * memory very quickly */
302 if (p_uc != 0)
303 ml_open_file(buf);
304 #endif
307 * fill block0 struct and write page 0
309 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
310 goto error;
311 if (hp->bh_bnum != 0)
313 EMSG(_("E298: Didn't get block nr 0?"));
314 goto error;
316 b0p = (ZERO_BL *)(hp->bh_data);
318 b0p->b0_id[0] = BLOCK0_ID0;
319 b0p->b0_id[1] = BLOCK0_ID1;
320 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
321 b0p->b0_magic_int = (int)B0_MAGIC_INT;
322 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
323 b0p->b0_magic_char = B0_MAGIC_CHAR;
324 STRNCPY(b0p->b0_version, "VIM ", 4);
325 STRNCPY(b0p->b0_version + 4, Version, 6);
326 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
328 #ifdef FEAT_SPELL
329 if (!buf->b_spell)
330 #endif
332 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
333 b0p->b0_flags = get_fileformat(buf) + 1;
334 set_b0_fname(b0p, buf);
335 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
336 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
337 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
338 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
339 long_to_char(mch_get_pid(), b0p->b0_pid);
343 * Always sync block number 0 to disk, so we can check the file name in
344 * the swap file in findswapname(). Don't do this for help files though
345 * and spell buffer though.
346 * Only works when there's a swapfile, otherwise it's done when the file
347 * is created.
349 mf_put(mfp, hp, TRUE, FALSE);
350 if (!buf->b_help && !B_SPELL(buf))
351 (void)mf_sync(mfp, 0);
354 * Fill in root pointer block and write page 1.
356 if ((hp = ml_new_ptr(mfp)) == NULL)
357 goto error;
358 if (hp->bh_bnum != 1)
360 EMSG(_("E298: Didn't get block nr 1?"));
361 goto error;
363 pp = (PTR_BL *)(hp->bh_data);
364 pp->pb_count = 1;
365 pp->pb_pointer[0].pe_bnum = 2;
366 pp->pb_pointer[0].pe_page_count = 1;
367 pp->pb_pointer[0].pe_old_lnum = 1;
368 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
369 mf_put(mfp, hp, TRUE, FALSE);
372 * Allocate first data block and create an empty line 1.
374 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
375 goto error;
376 if (hp->bh_bnum != 2)
378 EMSG(_("E298: Didn't get block nr 2?"));
379 goto error;
382 dp = (DATA_BL *)(hp->bh_data);
383 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
384 dp->db_free -= 1 + INDEX_SIZE;
385 dp->db_line_count = 1;
386 *((char_u *)dp + dp->db_txt_start) = NUL; /* emtpy line */
388 return OK;
390 error:
391 if (mfp != NULL)
393 if (hp)
394 mf_put(mfp, hp, FALSE, FALSE);
395 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
397 buf->b_ml.ml_mfp = NULL;
398 return FAIL;
402 * ml_setname() is called when the file name of "buf" has been changed.
403 * It may rename the swap file.
405 void
406 ml_setname(buf)
407 buf_T *buf;
409 int success = FALSE;
410 memfile_T *mfp;
411 char_u *fname;
412 char_u *dirp;
413 #if defined(MSDOS) || defined(MSWIN)
414 char_u *p;
415 #endif
417 mfp = buf->b_ml.ml_mfp;
418 if (mfp->mf_fd < 0) /* there is no swap file yet */
421 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
422 * For help files we will make a swap file now.
424 if (p_uc != 0)
425 ml_open_file(buf); /* create a swap file */
426 return;
430 * Try all directories in the 'directory' option.
432 dirp = p_dir;
433 for (;;)
435 if (*dirp == NUL) /* tried all directories, fail */
436 break;
437 fname = findswapname(buf, &dirp, mfp->mf_fname);
438 /* alloc's fname */
439 if (fname == NULL) /* no file name found for this dir */
440 continue;
442 #if defined(MSDOS) || defined(MSWIN)
444 * Set full pathname for swap file now, because a ":!cd dir" may
445 * change directory without us knowing it.
447 p = FullName_save(fname, FALSE);
448 vim_free(fname);
449 fname = p;
450 if (fname == NULL)
451 continue;
452 #endif
453 /* if the file name is the same we don't have to do anything */
454 if (fnamecmp(fname, mfp->mf_fname) == 0)
456 vim_free(fname);
457 success = TRUE;
458 break;
460 /* need to close the swap file before renaming */
461 if (mfp->mf_fd >= 0)
463 close(mfp->mf_fd);
464 mfp->mf_fd = -1;
467 /* try to rename the swap file */
468 if (vim_rename(mfp->mf_fname, fname) == 0)
470 success = TRUE;
471 vim_free(mfp->mf_fname);
472 mfp->mf_fname = fname;
473 vim_free(mfp->mf_ffname);
474 #if defined(MSDOS) || defined(MSWIN)
475 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
476 #else
477 mf_set_ffname(mfp);
478 #endif
479 ml_upd_block0(buf, FALSE);
480 break;
482 vim_free(fname); /* this fname didn't work, try another */
485 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
487 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
488 if (mfp->mf_fd < 0)
490 /* could not (re)open the swap file, what can we do???? */
491 EMSG(_("E301: Oops, lost the swap file!!!"));
492 return;
495 if (!success)
496 EMSG(_("E302: Could not rename swap file"));
500 * Open a file for the memfile for all buffers that are not readonly or have
501 * been modified.
502 * Used when 'updatecount' changes from zero to non-zero.
504 void
505 ml_open_files()
507 buf_T *buf;
509 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
510 if (!buf->b_p_ro || buf->b_changed)
511 ml_open_file(buf);
515 * Open a swap file for an existing memfile, if there is no swap file yet.
516 * If we are unable to find a file name, mf_fname will be NULL
517 * and the memfile will be in memory only (no recovery possible).
519 void
520 ml_open_file(buf)
521 buf_T *buf;
523 memfile_T *mfp;
524 char_u *fname;
525 char_u *dirp;
527 mfp = buf->b_ml.ml_mfp;
528 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
529 return; /* nothing to do */
531 #ifdef FEAT_SPELL
532 /* For a spell buffer use a temp file name. */
533 if (buf->b_spell)
535 fname = vim_tempname('s');
536 if (fname != NULL)
537 (void)mf_open_file(mfp, fname); /* consumes fname! */
538 buf->b_may_swap = FALSE;
539 return;
541 #endif
544 * Try all directories in 'directory' option.
546 dirp = p_dir;
547 for (;;)
549 if (*dirp == NUL)
550 break;
551 /* There is a small chance that between chosing the swap file name and
552 * creating it, another Vim creates the file. In that case the
553 * creation will fail and we will use another directory. */
554 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
555 if (fname == NULL)
556 continue;
557 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
559 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
561 * set full pathname for swap file now, because a ":!cd dir" may
562 * change directory without us knowing it.
564 mf_fullname(mfp);
565 #endif
566 ml_upd_block0(buf, FALSE);
568 /* Flush block zero, so others can read it */
569 if (mf_sync(mfp, MFS_ZERO) == OK)
571 /* Mark all blocks that should be in the swapfile as dirty.
572 * Needed for when the 'swapfile' option was reset, so that
573 * the swap file was deleted, and then on again. */
574 mf_set_dirty(mfp);
575 break;
577 /* Writing block 0 failed: close the file and try another dir */
578 mf_close_file(buf, FALSE);
582 if (mfp->mf_fname == NULL) /* Failed! */
584 need_wait_return = TRUE; /* call wait_return later */
585 ++no_wait_return;
586 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
587 buf_spname(buf) != NULL
588 ? (char_u *)buf_spname(buf)
589 : buf->b_fname);
590 --no_wait_return;
593 /* don't try to open a swap file again */
594 buf->b_may_swap = FALSE;
598 * If still need to create a swap file, and starting to edit a not-readonly
599 * file, or reading into an existing buffer, create a swap file now.
601 void
602 check_need_swap(newfile)
603 int newfile; /* reading file into new buffer */
605 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
606 ml_open_file(curbuf);
610 * Close memline for buffer 'buf'.
611 * If 'del_file' is TRUE, delete the swap file
613 void
614 ml_close(buf, del_file)
615 buf_T *buf;
616 int del_file;
618 if (buf->b_ml.ml_mfp == NULL) /* not open */
619 return;
620 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
621 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
622 vim_free(buf->b_ml.ml_line_ptr);
623 vim_free(buf->b_ml.ml_stack);
624 #ifdef FEAT_BYTEOFF
625 vim_free(buf->b_ml.ml_chunksize);
626 buf->b_ml.ml_chunksize = NULL;
627 #endif
628 buf->b_ml.ml_mfp = NULL;
630 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
631 * this buffer is loaded. */
632 buf->b_flags &= ~BF_RECOVERED;
636 * Close all existing memlines and memfiles.
637 * Only used when exiting.
638 * When 'del_file' is TRUE, delete the memfiles.
639 * But don't delete files that were ":preserve"d when we are POSIX compatible.
641 void
642 ml_close_all(del_file)
643 int del_file;
645 buf_T *buf;
647 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
648 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
649 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
650 #ifdef TEMPDIRNAMES
651 vim_deltempdir(); /* delete created temp directory */
652 #endif
656 * Close all memfiles for not modified buffers.
657 * Only use just before exiting!
659 void
660 ml_close_notmod()
662 buf_T *buf;
664 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
665 if (!bufIsChanged(buf))
666 ml_close(buf, TRUE); /* close all not-modified buffers */
670 * Update the timestamp in the .swp file.
671 * Used when the file has been written.
673 void
674 ml_timestamp(buf)
675 buf_T *buf;
677 ml_upd_block0(buf, TRUE);
681 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
683 static void
684 ml_upd_block0(buf, set_fname)
685 buf_T *buf;
686 int set_fname;
688 memfile_T *mfp;
689 bhdr_T *hp;
690 ZERO_BL *b0p;
692 mfp = buf->b_ml.ml_mfp;
693 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
694 return;
695 b0p = (ZERO_BL *)(hp->bh_data);
696 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
697 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
698 else
700 if (set_fname)
701 set_b0_fname(b0p, buf);
702 else
703 set_b0_dir_flag(b0p, buf);
705 mf_put(mfp, hp, TRUE, FALSE);
709 * Write file name and timestamp into block 0 of a swap file.
710 * Also set buf->b_mtime.
711 * Don't use NameBuff[]!!!
713 static void
714 set_b0_fname(b0p, buf)
715 ZERO_BL *b0p;
716 buf_T *buf;
718 struct stat st;
720 if (buf->b_ffname == NULL)
721 b0p->b0_fname[0] = NUL;
722 else
724 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
725 /* Systems that cannot translate "~user" back into a path: copy the
726 * file name unmodified. Do use slashes instead of backslashes for
727 * portability. */
728 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
729 # ifdef BACKSLASH_IN_FILENAME
730 forward_slash(b0p->b0_fname);
731 # endif
732 #else
733 size_t flen, ulen;
734 char_u uname[B0_UNAME_SIZE];
737 * For a file under the home directory of the current user, we try to
738 * replace the home directory path with "~user". This helps when
739 * editing the same file on different machines over a network.
740 * First replace home dir path with "~/" with home_replace().
741 * Then insert the user name to get "~user/".
743 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
744 if (b0p->b0_fname[0] == '~')
746 flen = STRLEN(b0p->b0_fname);
747 /* If there is no user name or it is too long, don't use "~/" */
748 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
749 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
750 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
751 else
753 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
754 mch_memmove(b0p->b0_fname + 1, uname, ulen);
757 #endif
758 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
760 long_to_char((long)st.st_mtime, b0p->b0_mtime);
761 #ifdef CHECK_INODE
762 long_to_char((long)st.st_ino, b0p->b0_ino);
763 #endif
764 buf_store_time(buf, &st, buf->b_ffname);
765 buf->b_mtime_read = buf->b_mtime;
767 else
769 long_to_char(0L, b0p->b0_mtime);
770 #ifdef CHECK_INODE
771 long_to_char(0L, b0p->b0_ino);
772 #endif
773 buf->b_mtime = 0;
774 buf->b_mtime_read = 0;
775 buf->b_orig_size = 0;
776 buf->b_orig_mode = 0;
780 #ifdef FEAT_MBYTE
781 /* Also add the 'fileencoding' if there is room. */
782 add_b0_fenc(b0p, curbuf);
783 #endif
787 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
788 * swapfile for "buf" are in the same directory.
789 * This is fail safe: if we are not sure the directories are equal the flag is
790 * not set.
792 static void
793 set_b0_dir_flag(b0p, buf)
794 ZERO_BL *b0p;
795 buf_T *buf;
797 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
798 b0p->b0_flags |= B0_SAME_DIR;
799 else
800 b0p->b0_flags &= ~B0_SAME_DIR;
803 #ifdef FEAT_MBYTE
805 * When there is room, add the 'fileencoding' to block zero.
807 static void
808 add_b0_fenc(b0p, buf)
809 ZERO_BL *b0p;
810 buf_T *buf;
812 int n;
814 n = (int)STRLEN(buf->b_p_fenc);
815 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
816 b0p->b0_flags &= ~B0_HAS_FENC;
817 else
819 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
820 (char *)buf->b_p_fenc, (size_t)n);
821 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
822 b0p->b0_flags |= B0_HAS_FENC;
825 #endif
829 * try to recover curbuf from the .swp file
831 void
832 ml_recover()
834 buf_T *buf = NULL;
835 memfile_T *mfp = NULL;
836 char_u *fname;
837 bhdr_T *hp = NULL;
838 ZERO_BL *b0p;
839 int b0_ff;
840 char_u *b0_fenc = NULL;
841 PTR_BL *pp;
842 DATA_BL *dp;
843 infoptr_T *ip;
844 blocknr_T bnum;
845 int page_count;
846 struct stat org_stat, swp_stat;
847 int len;
848 int directly;
849 linenr_T lnum;
850 char_u *p;
851 int i;
852 long error;
853 int cannot_open;
854 linenr_T line_count;
855 int has_error;
856 int idx;
857 int top;
858 int txt_start;
859 off_t size;
860 int called_from_main;
861 int serious_error = TRUE;
862 long mtime;
863 int attr;
865 recoverymode = TRUE;
866 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
867 attr = hl_attr(HLF_E);
870 * If the file name ends in ".s[uvw][a-z]" we assume this is the swap file.
871 * Otherwise a search is done to find the swap file(s).
873 fname = curbuf->b_fname;
874 if (fname == NULL) /* When there is no file name */
875 fname = (char_u *)"";
876 len = (int)STRLEN(fname);
877 if (len >= 4 &&
878 #if defined(VMS) || defined(RISCOS)
879 STRNICMP(fname + len - 4, "_s" , 2)
880 #else
881 STRNICMP(fname + len - 4, ".s" , 2)
882 #endif
883 == 0
884 && vim_strchr((char_u *)"UVWuvw", fname[len - 2]) != NULL
885 && ASCII_ISALPHA(fname[len - 1]))
887 directly = TRUE;
888 fname = vim_strsave(fname); /* make a copy for mf_open() */
890 else
892 directly = FALSE;
894 /* count the number of matching swap files */
895 len = recover_names(&fname, FALSE, 0);
896 if (len == 0) /* no swap files found */
898 EMSG2(_("E305: No swap file found for %s"), fname);
899 goto theend;
901 if (len == 1) /* one swap file found, use it */
902 i = 1;
903 else /* several swap files found, choose */
905 /* list the names of the swap files */
906 (void)recover_names(&fname, TRUE, 0);
907 msg_putchar('\n');
908 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
909 i = get_number(FALSE, NULL);
910 if (i < 1 || i > len)
911 goto theend;
913 /* get the swap file name that will be used */
914 (void)recover_names(&fname, FALSE, i);
916 if (fname == NULL)
917 goto theend; /* out of memory */
919 /* When called from main() still need to initialize storage structure */
920 if (called_from_main && ml_open(curbuf) == FAIL)
921 getout(1);
924 * allocate a buffer structure (only the memline in it is really used)
926 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
927 if (buf == NULL)
929 vim_free(fname);
930 goto theend;
934 * init fields in memline struct
936 buf->b_ml.ml_stack_size = 0; /* no stack yet */
937 buf->b_ml.ml_stack = NULL; /* no stack yet */
938 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
939 buf->b_ml.ml_line_lnum = 0; /* no cached line */
940 buf->b_ml.ml_locked = NULL; /* no locked block */
941 buf->b_ml.ml_flags = 0;
944 * open the memfile from the old swap file
946 p = vim_strsave(fname); /* save fname for the message
947 (mf_open() may free fname) */
948 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
949 if (mfp == NULL || mfp->mf_fd < 0)
951 if (p != NULL)
953 EMSG2(_("E306: Cannot open %s"), p);
954 vim_free(p);
956 goto theend;
958 vim_free(p);
959 buf->b_ml.ml_mfp = mfp;
962 * The page size set in mf_open() might be different from the page size
963 * used in the swap file, we must get it from block 0. But to read block
964 * 0 we need a page size. Use the minimal size for block 0 here, it will
965 * be set to the real value below.
967 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
970 * try to read block 0
972 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
974 msg_start();
975 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
976 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
977 MSG_PUTS_ATTR(
978 _("\nMaybe no changes were made or Vim did not update the swap file."),
979 attr | MSG_HIST);
980 msg_end();
981 goto theend;
983 b0p = (ZERO_BL *)(hp->bh_data);
984 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
986 msg_start();
987 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
988 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
989 MSG_HIST);
990 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
991 msg_end();
992 goto theend;
994 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
996 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
997 goto theend;
999 if (b0_magic_wrong(b0p))
1001 msg_start();
1002 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1003 #if defined(MSDOS) || defined(MSWIN)
1004 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1005 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1006 attr | MSG_HIST);
1007 else
1008 #endif
1009 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1010 attr | MSG_HIST);
1011 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1012 /* avoid going past the end of a currupted hostname */
1013 b0p->b0_fname[0] = NUL;
1014 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1015 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1016 msg_end();
1017 goto theend;
1021 * If we guessed the wrong page size, we have to recalculate the
1022 * highest block number in the file.
1024 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1026 unsigned previous_page_size = mfp->mf_page_size;
1028 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1029 if (mfp->mf_page_size < previous_page_size)
1031 msg_start();
1032 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1033 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1034 attr | MSG_HIST);
1035 msg_end();
1036 goto theend;
1038 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1039 mfp->mf_blocknr_max = 0; /* no file or empty file */
1040 else
1041 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1042 mfp->mf_infile_count = mfp->mf_blocknr_max;
1044 /* need to reallocate the memory used to store the data */
1045 p = alloc(mfp->mf_page_size);
1046 if (p == NULL)
1047 goto theend;
1048 mch_memmove(p, hp->bh_data, previous_page_size);
1049 vim_free(hp->bh_data);
1050 hp->bh_data = p;
1051 b0p = (ZERO_BL *)(hp->bh_data);
1055 * If .swp file name given directly, use name from swap file for buffer.
1057 if (directly)
1059 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1060 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1061 goto theend;
1064 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1065 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1067 if (buf_spname(curbuf) != NULL)
1068 STRCPY(NameBuff, buf_spname(curbuf));
1069 else
1070 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1071 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1072 msg_putchar('\n');
1075 * check date of swap file and original file
1077 mtime = char_to_long(b0p->b0_mtime);
1078 if (curbuf->b_ffname != NULL
1079 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1080 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1081 && org_stat.st_mtime > swp_stat.st_mtime)
1082 || org_stat.st_mtime != mtime))
1084 EMSG(_("E308: Warning: Original file may have been changed"));
1086 out_flush();
1088 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1089 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1090 if (b0p->b0_flags & B0_HAS_FENC)
1092 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1093 p > b0p->b0_fname && p[-1] != NUL; --p)
1095 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1098 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1099 hp = NULL;
1102 * Now that we are sure that the file is going to be recovered, clear the
1103 * contents of the current buffer.
1105 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1106 ml_delete((linenr_T)1, FALSE);
1109 * Try reading the original file to obtain the values of 'fileformat',
1110 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1112 if (curbuf->b_ffname != NULL)
1114 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1115 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1116 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1117 ml_delete((linenr_T)1, FALSE);
1120 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1121 if (b0_ff != 0)
1122 set_fileformat(b0_ff - 1, OPT_LOCAL);
1123 if (b0_fenc != NULL)
1125 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1126 vim_free(b0_fenc);
1128 unchanged(curbuf, TRUE);
1130 bnum = 1; /* start with block 1 */
1131 page_count = 1; /* which is 1 page */
1132 lnum = 0; /* append after line 0 in curbuf */
1133 line_count = 0;
1134 idx = 0; /* start with first index in block 1 */
1135 error = 0;
1136 buf->b_ml.ml_stack_top = 0;
1137 buf->b_ml.ml_stack = NULL;
1138 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1140 if (curbuf->b_ffname == NULL)
1141 cannot_open = TRUE;
1142 else
1143 cannot_open = FALSE;
1145 serious_error = FALSE;
1146 for ( ; !got_int; line_breakcheck())
1148 if (hp != NULL)
1149 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1152 * get block
1154 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1156 if (bnum == 1)
1158 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1159 goto theend;
1161 ++error;
1162 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1163 (colnr_T)0, TRUE);
1165 else /* there is a block */
1167 pp = (PTR_BL *)(hp->bh_data);
1168 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1170 /* check line count when using pointer block first time */
1171 if (idx == 0 && line_count != 0)
1173 for (i = 0; i < (int)pp->pb_count; ++i)
1174 line_count -= pp->pb_pointer[i].pe_line_count;
1175 if (line_count != 0)
1177 ++error;
1178 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1179 (colnr_T)0, TRUE);
1183 if (pp->pb_count == 0)
1185 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1186 (colnr_T)0, TRUE);
1187 ++error;
1189 else if (idx < (int)pp->pb_count) /* go a block deeper */
1191 if (pp->pb_pointer[idx].pe_bnum < 0)
1194 * Data block with negative block number.
1195 * Try to read lines from the original file.
1196 * This is slow, but it works.
1198 if (!cannot_open)
1200 line_count = pp->pb_pointer[idx].pe_line_count;
1201 if (readfile(curbuf->b_ffname, NULL, lnum,
1202 pp->pb_pointer[idx].pe_old_lnum - 1,
1203 line_count, NULL, 0) == FAIL)
1204 cannot_open = TRUE;
1205 else
1206 lnum += line_count;
1208 if (cannot_open)
1210 ++error;
1211 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1212 (colnr_T)0, TRUE);
1214 ++idx; /* get same block again for next index */
1215 continue;
1219 * going one block deeper in the tree
1221 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1223 ++error;
1224 break; /* out of memory */
1226 ip = &(buf->b_ml.ml_stack[top]);
1227 ip->ip_bnum = bnum;
1228 ip->ip_index = idx;
1230 bnum = pp->pb_pointer[idx].pe_bnum;
1231 line_count = pp->pb_pointer[idx].pe_line_count;
1232 page_count = pp->pb_pointer[idx].pe_page_count;
1233 continue;
1236 else /* not a pointer block */
1238 dp = (DATA_BL *)(hp->bh_data);
1239 if (dp->db_id != DATA_ID) /* block id wrong */
1241 if (bnum == 1)
1243 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1244 mfp->mf_fname);
1245 goto theend;
1247 ++error;
1248 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1249 (colnr_T)0, TRUE);
1251 else
1254 * it is a data block
1255 * Append all the lines in this block
1257 has_error = FALSE;
1259 * check length of block
1260 * if wrong, use length in pointer block
1262 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1264 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1265 (colnr_T)0, TRUE);
1266 ++error;
1267 has_error = TRUE;
1268 dp->db_txt_end = page_count * mfp->mf_page_size;
1271 /* make sure there is a NUL at the end of the block */
1272 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1275 * check number of lines in block
1276 * if wrong, use count in data block
1278 if (line_count != dp->db_line_count)
1280 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1281 (colnr_T)0, TRUE);
1282 ++error;
1283 has_error = TRUE;
1286 for (i = 0; i < dp->db_line_count; ++i)
1288 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1289 if (txt_start <= (int)HEADER_SIZE
1290 || txt_start >= (int)dp->db_txt_end)
1292 p = (char_u *)"???";
1293 ++error;
1295 else
1296 p = (char_u *)dp + txt_start;
1297 ml_append(lnum++, p, (colnr_T)0, TRUE);
1299 if (has_error)
1300 ml_append(lnum++, (char_u *)_("???END"),
1301 (colnr_T)0, TRUE);
1306 if (buf->b_ml.ml_stack_top == 0) /* finished */
1307 break;
1310 * go one block up in the tree
1312 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1313 bnum = ip->ip_bnum;
1314 idx = ip->ip_index + 1; /* go to next index */
1315 page_count = 1;
1319 * The dummy line from the empty buffer will now be after the last line in
1320 * the buffer. Delete it.
1322 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1323 curbuf->b_flags |= BF_RECOVERED;
1325 recoverymode = FALSE;
1326 if (got_int)
1327 EMSG(_("E311: Recovery Interrupted"));
1328 else if (error)
1330 ++no_wait_return;
1331 MSG(">>>>>>>>>>>>>");
1332 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1333 --no_wait_return;
1334 MSG(_("See \":help E312\" for more information."));
1335 MSG(">>>>>>>>>>>>>");
1337 else
1339 MSG(_("Recovery completed. You should check if everything is OK."));
1340 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1341 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1342 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1343 cmdline_row = msg_row;
1345 redraw_curbuf_later(NOT_VALID);
1347 theend:
1348 recoverymode = FALSE;
1349 if (mfp != NULL)
1351 if (hp != NULL)
1352 mf_put(mfp, hp, FALSE, FALSE);
1353 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1355 if (buf != NULL)
1357 vim_free(buf->b_ml.ml_stack);
1358 vim_free(buf);
1360 if (serious_error && called_from_main)
1361 ml_close(curbuf, TRUE);
1362 #ifdef FEAT_AUTOCMD
1363 else
1365 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1366 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1368 #endif
1369 return;
1373 * Find the names of swap files in current directory and the directory given
1374 * with the 'directory' option.
1376 * Used to:
1377 * - list the swap files for "vim -r"
1378 * - count the number of swap files when recovering
1379 * - list the swap files when recovering
1380 * - find the name of the n'th swap file when recovering
1383 recover_names(fname, list, nr)
1384 char_u **fname; /* base for swap file name */
1385 int list; /* when TRUE, list the swap file names */
1386 int nr; /* when non-zero, return nr'th swap file name */
1388 int num_names;
1389 char_u *(names[6]);
1390 char_u *tail;
1391 char_u *p;
1392 int num_files;
1393 int file_count = 0;
1394 char_u **files;
1395 int i;
1396 char_u *dirp;
1397 char_u *dir_name;
1399 if (list)
1401 /* use msg() to start the scrolling properly */
1402 msg((char_u *)_("Swap files found:"));
1403 msg_putchar('\n');
1407 * Do the loop for every directory in 'directory'.
1408 * First allocate some memory to put the directory name in.
1410 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1411 dirp = p_dir;
1412 while (dir_name != NULL && *dirp)
1415 * Isolate a directory name from *dirp and put it in dir_name (we know
1416 * it is large enough, so use 31000 for length).
1417 * Advance dirp to next directory name.
1419 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1421 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1423 if (fname == NULL || *fname == NULL)
1425 #ifdef VMS
1426 names[0] = vim_strsave((char_u *)"*_sw%");
1427 #else
1428 # ifdef RISCOS
1429 names[0] = vim_strsave((char_u *)"*_sw#");
1430 # else
1431 names[0] = vim_strsave((char_u *)"*.sw?");
1432 # endif
1433 #endif
1434 #if defined(UNIX) || defined(WIN3264)
1435 /* For Unix names starting with a dot are special. MS-Windows
1436 * supports this too, on some file systems. */
1437 names[1] = vim_strsave((char_u *)".*.sw?");
1438 names[2] = vim_strsave((char_u *)".sw?");
1439 num_names = 3;
1440 #else
1441 # ifdef VMS
1442 names[1] = vim_strsave((char_u *)".*_sw%");
1443 num_names = 2;
1444 # else
1445 num_names = 1;
1446 # endif
1447 #endif
1449 else
1450 num_names = recov_file_names(names, *fname, TRUE);
1452 else /* check directory dir_name */
1454 if (fname == NULL || *fname == NULL)
1456 #ifdef VMS
1457 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1458 #else
1459 # ifdef RISCOS
1460 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1461 # else
1462 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1463 # endif
1464 #endif
1465 #if defined(UNIX) || defined(WIN3264)
1466 /* For Unix names starting with a dot are special. MS-Windows
1467 * supports this too, on some file systems. */
1468 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1469 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1470 num_names = 3;
1471 #else
1472 # ifdef VMS
1473 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1474 num_names = 2;
1475 # else
1476 num_names = 1;
1477 # endif
1478 #endif
1480 else
1482 #if defined(UNIX) || defined(WIN3264)
1483 p = dir_name + STRLEN(dir_name);
1484 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1486 /* Ends with '//', Use Full path for swap name */
1487 tail = make_percent_swname(dir_name, *fname);
1489 else
1490 #endif
1492 tail = gettail(*fname);
1493 tail = concat_fnames(dir_name, tail, TRUE);
1495 if (tail == NULL)
1496 num_names = 0;
1497 else
1499 num_names = recov_file_names(names, tail, FALSE);
1500 vim_free(tail);
1505 /* check for out-of-memory */
1506 for (i = 0; i < num_names; ++i)
1508 if (names[i] == NULL)
1510 for (i = 0; i < num_names; ++i)
1511 vim_free(names[i]);
1512 num_names = 0;
1515 if (num_names == 0)
1516 num_files = 0;
1517 else if (expand_wildcards(num_names, names, &num_files, &files,
1518 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1519 num_files = 0;
1522 * When no swap file found, wildcard expansion might have failed (e.g.
1523 * not able to execute the shell).
1524 * Try finding a swap file by simply adding ".swp" to the file name.
1526 if (*dirp == NUL && file_count + num_files == 0
1527 && fname != NULL && *fname != NULL)
1529 struct stat st;
1530 char_u *swapname;
1532 #if defined(VMS) || defined(RISCOS)
1533 swapname = modname(*fname, (char_u *)"_swp", FALSE);
1534 #else
1535 swapname = modname(*fname, (char_u *)".swp", TRUE);
1536 #endif
1537 if (swapname != NULL)
1539 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1541 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1542 if (files != NULL)
1544 files[0] = swapname;
1545 swapname = NULL;
1546 num_files = 1;
1549 vim_free(swapname);
1554 * remove swapfile name of the current buffer, it must be ignored
1556 if (curbuf->b_ml.ml_mfp != NULL
1557 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1559 for (i = 0; i < num_files; ++i)
1560 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1562 /* Remove the name from files[i]. Move further entries
1563 * down. When the array becomes empty free it here, since
1564 * FreeWild() won't be called below. */
1565 vim_free(files[i]);
1566 if (--num_files == 0)
1567 vim_free(files);
1568 else
1569 for ( ; i < num_files; ++i)
1570 files[i] = files[i + 1];
1573 if (nr > 0)
1575 file_count += num_files;
1576 if (nr <= file_count)
1578 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1579 dirp = (char_u *)""; /* stop searching */
1582 else if (list)
1584 if (dir_name[0] == '.' && dir_name[1] == NUL)
1586 if (fname == NULL || *fname == NULL)
1587 MSG_PUTS(_(" In current directory:\n"));
1588 else
1589 MSG_PUTS(_(" Using specified name:\n"));
1591 else
1593 MSG_PUTS(_(" In directory "));
1594 msg_home_replace(dir_name);
1595 MSG_PUTS(":\n");
1598 if (num_files)
1600 for (i = 0; i < num_files; ++i)
1602 /* print the swap file name */
1603 msg_outnum((long)++file_count);
1604 MSG_PUTS(". ");
1605 msg_puts(gettail(files[i]));
1606 msg_putchar('\n');
1607 (void)swapfile_info(files[i]);
1610 else
1611 MSG_PUTS(_(" -- none --\n"));
1612 out_flush();
1614 else
1615 file_count += num_files;
1617 for (i = 0; i < num_names; ++i)
1618 vim_free(names[i]);
1619 if (num_files > 0)
1620 FreeWild(num_files, files);
1622 vim_free(dir_name);
1623 return file_count;
1626 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1628 * Append the full path to name with path separators made into percent
1629 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1631 static char_u *
1632 make_percent_swname(dir, name)
1633 char_u *dir;
1634 char_u *name;
1636 char_u *d, *s, *f;
1638 f = fix_fname(name != NULL ? name : (char_u *) "");
1639 d = NULL;
1640 if (f != NULL)
1642 s = alloc((unsigned)(STRLEN(f) + 1));
1643 if (s != NULL)
1645 STRCPY(s, f);
1646 for (d = s; *d != NUL; mb_ptr_adv(d))
1647 if (vim_ispathsep(*d))
1648 *d = '%';
1649 d = concat_fnames(dir, s, TRUE);
1650 vim_free(s);
1652 vim_free(f);
1654 return d;
1656 #endif
1658 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1659 static int process_still_running;
1660 #endif
1663 * Give information about an existing swap file.
1664 * Returns timestamp (0 when unknown).
1666 static time_t
1667 swapfile_info(fname)
1668 char_u *fname;
1670 struct stat st;
1671 int fd;
1672 struct block0 b0;
1673 time_t x = (time_t)0;
1674 char *p;
1675 #ifdef UNIX
1676 char_u uname[B0_UNAME_SIZE];
1677 #endif
1679 /* print the swap file date */
1680 if (mch_stat((char *)fname, &st) != -1)
1682 #ifdef UNIX
1683 /* print name of owner of the file */
1684 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1686 MSG_PUTS(_(" owned by: "));
1687 msg_outtrans(uname);
1688 MSG_PUTS(_(" dated: "));
1690 else
1691 #endif
1692 MSG_PUTS(_(" dated: "));
1693 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1694 p = ctime(&x); /* includes '\n' */
1695 if (p == NULL)
1696 MSG_PUTS("(invalid)\n");
1697 else
1698 MSG_PUTS(p);
1702 * print the original file name
1704 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1705 if (fd >= 0)
1707 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1709 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1711 MSG_PUTS(_(" [from Vim version 3.0]"));
1713 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1715 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1717 else
1719 MSG_PUTS(_(" file name: "));
1720 if (b0.b0_fname[0] == NUL)
1721 MSG_PUTS(_("[No Name]"));
1722 else
1723 msg_outtrans(b0.b0_fname);
1725 MSG_PUTS(_("\n modified: "));
1726 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1728 if (*(b0.b0_uname) != NUL)
1730 MSG_PUTS(_("\n user name: "));
1731 msg_outtrans(b0.b0_uname);
1734 if (*(b0.b0_hname) != NUL)
1736 if (*(b0.b0_uname) != NUL)
1737 MSG_PUTS(_(" host name: "));
1738 else
1739 MSG_PUTS(_("\n host name: "));
1740 msg_outtrans(b0.b0_hname);
1743 if (char_to_long(b0.b0_pid) != 0L)
1745 MSG_PUTS(_("\n process ID: "));
1746 msg_outnum(char_to_long(b0.b0_pid));
1747 #if defined(UNIX) || defined(__EMX__)
1748 /* EMX kill() not working correctly, it seems */
1749 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1751 MSG_PUTS(_(" (still running)"));
1752 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1753 process_still_running = TRUE;
1754 # endif
1756 #endif
1759 if (b0_magic_wrong(&b0))
1761 #if defined(MSDOS) || defined(MSWIN)
1762 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1763 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1764 else
1765 #endif
1766 MSG_PUTS(_("\n [not usable on this computer]"));
1770 else
1771 MSG_PUTS(_(" [cannot be read]"));
1772 close(fd);
1774 else
1775 MSG_PUTS(_(" [cannot be opened]"));
1776 msg_putchar('\n');
1778 return x;
1781 static int
1782 recov_file_names(names, path, prepend_dot)
1783 char_u **names;
1784 char_u *path;
1785 int prepend_dot;
1787 int num_names;
1789 #ifdef SHORT_FNAME
1791 * (MS-DOS) always short names
1793 names[0] = modname(path, (char_u *)".sw?", FALSE);
1794 num_names = 1;
1795 #else /* !SHORT_FNAME */
1797 * (Win32 and Win64) never short names, but do prepend a dot.
1798 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1799 * Only use the short name if it is different.
1801 char_u *p;
1802 int i;
1803 # ifndef WIN3264
1804 int shortname = curbuf->b_shortname;
1806 curbuf->b_shortname = FALSE;
1807 # endif
1809 num_names = 0;
1812 * May also add the file name with a dot prepended, for swap file in same
1813 * dir as original file.
1815 if (prepend_dot)
1817 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1818 if (names[num_names] == NULL)
1819 goto end;
1820 ++num_names;
1824 * Form the normal swap file name pattern by appending ".sw?".
1826 #ifdef VMS
1827 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1828 #else
1829 # ifdef RISCOS
1830 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1831 # else
1832 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1833 # endif
1834 #endif
1835 if (names[num_names] == NULL)
1836 goto end;
1837 if (num_names >= 1) /* check if we have the same name twice */
1839 p = names[num_names - 1];
1840 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1841 if (i > 0)
1842 p += i; /* file name has been expanded to full path */
1844 if (STRCMP(p, names[num_names]) != 0)
1845 ++num_names;
1846 else
1847 vim_free(names[num_names]);
1849 else
1850 ++num_names;
1852 # ifndef WIN3264
1854 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1856 curbuf->b_shortname = TRUE;
1857 #ifdef VMS
1858 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1859 #else
1860 # ifdef RISCOS
1861 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1862 # else
1863 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1864 # endif
1865 #endif
1866 if (names[num_names] == NULL)
1867 goto end;
1870 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1872 p = names[num_names];
1873 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1874 if (i > 0)
1875 p += i; /* file name has been expanded to full path */
1876 if (STRCMP(names[num_names - 1], p) == 0)
1877 vim_free(names[num_names]);
1878 else
1879 ++num_names;
1880 # endif
1882 end:
1883 # ifndef WIN3264
1884 curbuf->b_shortname = shortname;
1885 # endif
1887 #endif /* !SHORT_FNAME */
1889 return num_names;
1893 * sync all memlines
1895 * If 'check_file' is TRUE, check if original file exists and was not changed.
1896 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1897 * always sync at least one block.
1899 void
1900 ml_sync_all(check_file, check_char)
1901 int check_file;
1902 int check_char;
1904 buf_T *buf;
1905 struct stat st;
1907 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1909 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1910 continue; /* no file */
1912 ml_flush_line(buf); /* flush buffered line */
1913 /* flush locked block */
1914 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1915 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1916 && buf->b_ffname != NULL)
1919 * If the original file does not exist anymore or has been changed
1920 * call ml_preserve() to get rid of all negative numbered blocks.
1922 if (mch_stat((char *)buf->b_ffname, &st) == -1
1923 || st.st_mtime != buf->b_mtime_read
1924 || (size_t)st.st_size != buf->b_orig_size)
1926 ml_preserve(buf, FALSE);
1927 did_check_timestamps = FALSE;
1928 need_check_timestamps = TRUE; /* give message later */
1931 if (buf->b_ml.ml_mfp->mf_dirty)
1933 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1934 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1935 if (check_char && ui_char_avail()) /* character available now */
1936 break;
1942 * sync one buffer, including negative blocks
1944 * after this all the blocks are in the swap file
1946 * Used for the :preserve command and when the original file has been
1947 * changed or deleted.
1949 * when message is TRUE the success of preserving is reported
1951 void
1952 ml_preserve(buf, message)
1953 buf_T *buf;
1954 int message;
1956 bhdr_T *hp;
1957 linenr_T lnum;
1958 memfile_T *mfp = buf->b_ml.ml_mfp;
1959 int status;
1960 int got_int_save = got_int;
1962 if (mfp == NULL || mfp->mf_fname == NULL)
1964 if (message)
1965 EMSG(_("E313: Cannot preserve, there is no swap file"));
1966 return;
1969 /* We only want to stop when interrupted here, not when interrupted
1970 * before. */
1971 got_int = FALSE;
1973 ml_flush_line(buf); /* flush buffered line */
1974 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
1975 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
1977 /* stack is invalid after mf_sync(.., MFS_ALL) */
1978 buf->b_ml.ml_stack_top = 0;
1981 * Some of the data blocks may have been changed from negative to
1982 * positive block number. In that case the pointer blocks need to be
1983 * updated.
1985 * We don't know in which pointer block the references are, so we visit
1986 * all data blocks until there are no more translations to be done (or
1987 * we hit the end of the file, which can only happen in case a write fails,
1988 * e.g. when file system if full).
1989 * ml_find_line() does the work by translating the negative block numbers
1990 * when getting the first line of each data block.
1992 if (mf_need_trans(mfp) && !got_int)
1994 lnum = 1;
1995 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
1997 hp = ml_find_line(buf, lnum, ML_FIND);
1998 if (hp == NULL)
2000 status = FAIL;
2001 goto theend;
2003 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2004 lnum = buf->b_ml.ml_locked_high + 1;
2006 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2007 /* sync the updated pointer blocks */
2008 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2009 status = FAIL;
2010 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2012 theend:
2013 got_int |= got_int_save;
2015 if (message)
2017 if (status == OK)
2018 MSG(_("File preserved"));
2019 else
2020 EMSG(_("E314: Preserve failed"));
2025 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2026 * until the next call!
2027 * line1 = ml_get(1);
2028 * line2 = ml_get(2); // line1 is now invalid!
2029 * Make a copy of the line if necessary.
2032 * get a pointer to a (read-only copy of a) line
2034 * On failure an error message is given and IObuff is returned (to avoid
2035 * having to check for error everywhere).
2037 char_u *
2038 ml_get(lnum)
2039 linenr_T lnum;
2041 return ml_get_buf(curbuf, lnum, FALSE);
2045 * ml_get_pos: get pointer to position 'pos'
2047 char_u *
2048 ml_get_pos(pos)
2049 pos_T *pos;
2051 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2055 * ml_get_curline: get pointer to cursor line.
2057 char_u *
2058 ml_get_curline()
2060 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2064 * ml_get_cursor: get pointer to cursor position
2066 char_u *
2067 ml_get_cursor()
2069 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2070 curwin->w_cursor.col);
2074 * get a pointer to a line in a specific buffer
2076 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2077 * changed)
2079 char_u *
2080 ml_get_buf(buf, lnum, will_change)
2081 buf_T *buf;
2082 linenr_T lnum;
2083 int will_change; /* line will be changed */
2085 bhdr_T *hp;
2086 DATA_BL *dp;
2087 char_u *ptr;
2088 static int recursive = 0;
2090 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2092 if (recursive == 0)
2094 /* Avoid giving this message for a recursive call, may happen when
2095 * the GUI redraws part of the text. */
2096 ++recursive;
2097 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2098 --recursive;
2100 errorret:
2101 STRCPY(IObuff, "???");
2102 return IObuff;
2104 if (lnum <= 0) /* pretend line 0 is line 1 */
2105 lnum = 1;
2107 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2108 return (char_u *)"";
2111 * See if it is the same line as requested last time.
2112 * Otherwise may need to flush last used line.
2113 * Don't use the last used line when 'swapfile' is reset, need to load all
2114 * blocks.
2116 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2118 ml_flush_line(buf);
2121 * Find the data block containing the line.
2122 * This also fills the stack with the blocks from the root to the data
2123 * block and releases any locked block.
2125 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2127 if (recursive == 0)
2129 /* Avoid giving this message for a recursive call, may happen
2130 * when the GUI redraws part of the text. */
2131 ++recursive;
2132 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2133 --recursive;
2135 goto errorret;
2138 dp = (DATA_BL *)(hp->bh_data);
2140 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2141 buf->b_ml.ml_line_ptr = ptr;
2142 buf->b_ml.ml_line_lnum = lnum;
2143 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2145 if (will_change)
2146 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2148 return buf->b_ml.ml_line_ptr;
2152 * Check if a line that was just obtained by a call to ml_get
2153 * is in allocated memory.
2156 ml_line_alloced()
2158 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2162 * Append a line after lnum (may be 0 to insert a line in front of the file).
2163 * "line" does not need to be allocated, but can't be another line in a
2164 * buffer, unlocking may make it invalid.
2166 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2167 * will be set for recovery
2168 * Check: The caller of this function should probably also call
2169 * appended_lines().
2171 * return FAIL for failure, OK otherwise
2174 ml_append(lnum, line, len, newfile)
2175 linenr_T lnum; /* append after this line (can be 0) */
2176 char_u *line; /* text of the new line */
2177 colnr_T len; /* length of new line, including NUL, or 0 */
2178 int newfile; /* flag, see above */
2180 /* When starting up, we might still need to create the memfile */
2181 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2182 return FAIL;
2184 if (curbuf->b_ml.ml_line_lnum != 0)
2185 ml_flush_line(curbuf);
2186 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2190 * Append string to line lnum, with buffering, in current buffer.
2192 * Always makes a copy of the incoming string
2194 * Check: The caller of this function should probably also call
2195 * changed_lines(), unless update_screen(NOT_VALID) is used.
2197 * return FAIL for failure, OK otherwise
2200 ml_append_string(lnum, string, slen)
2201 linenr_T lnum;
2202 char_u *string;
2203 int slen;
2205 int append_len = 0;
2206 int line_len = 0;
2207 if (slen == -1)
2208 append_len = STRLEN(string);
2209 else
2210 append_len = slen;
2211 if (string == NULL) /* just checking... */
2212 return FAIL;
2214 if (lnum == 0)
2215 ml_append (lnum, string, slen, 0);
2217 /* When starting up, we might still need to create the memfile */
2218 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2219 return FAIL;
2221 #ifdef FEAT_NETBEANS_INTG
2223 #error I am 99% sure this is broken
2224 if (usingNetbeans)
2226 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2227 netbeans_inserted(curbuf, lnum, 0, string, (int)STRLEN(string));
2230 #endif
2231 if ((curbuf->b_ml.ml_line_lnum != lnum) || /* other line buffered */
2232 (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) == 0)
2234 ml_flush_line(curbuf); /* flush it, this frees ml_line_ptr */
2236 /* Take a pointer to the existing line, will get re-alloced right
2237 * away below because it is not big enough */
2238 curbuf->b_ml.ml_line_ptr = ml_get(lnum);
2239 curbuf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2240 curbuf->b_ml.ml_line_max = STRLEN(curbuf->b_ml.ml_line_ptr);
2241 curbuf->b_ml.ml_line_lnum = lnum;
2243 /* By here,
2244 * curbuf->b_ml.ml_line_ptr - is filled with the correct existing line
2245 * curbuf->b_ml.ml_line_max - is the alloced size of the line
2247 line_len = STRLEN(curbuf->b_ml.ml_line_ptr);
2248 if (curbuf->b_ml.ml_line_max < line_len + append_len + 1)
2250 int new_len = (curbuf->b_ml.ml_line_max + append_len + 2) * 2;
2251 char_u *new_line;
2252 if (new_len < 80) new_len = 80;
2253 new_line = vim_strnsave(curbuf->b_ml.ml_line_ptr, new_len);
2254 if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY)
2255 vim_free(curbuf->b_ml.ml_line_ptr);
2256 curbuf->b_ml.ml_line_ptr = new_line;
2257 curbuf->b_ml.ml_line_max = new_len;
2258 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2260 /* by here:
2261 * ml_line_ptr is allocated to fit the current line + the append
2262 * ml_line_max is the total alloced size of the line
2264 STRCPY (&curbuf->b_ml.ml_line_ptr[line_len], string); /* Append our string */
2265 curbuf->b_ml.ml_line_ptr[line_len + append_len] = NUL; /* End the line */
2266 return OK;
2271 #if defined(FEAT_SPELL) || defined(PROTO)
2273 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2274 * a memline.
2277 ml_append_buf(buf, lnum, line, len, newfile)
2278 buf_T *buf;
2279 linenr_T lnum; /* append after this line (can be 0) */
2280 char_u *line; /* text of the new line */
2281 colnr_T len; /* length of new line, including NUL, or 0 */
2282 int newfile; /* flag, see above */
2284 if (buf->b_ml.ml_mfp == NULL)
2285 return FAIL;
2287 if (buf->b_ml.ml_line_lnum != 0)
2288 ml_flush_line(buf);
2289 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2291 #endif
2293 static int
2294 ml_append_int(buf, lnum, line, len, newfile, mark)
2295 buf_T *buf;
2296 linenr_T lnum; /* append after this line (can be 0) */
2297 char_u *line; /* text of the new line */
2298 colnr_T len; /* length of line, including NUL, or 0 */
2299 int newfile; /* flag, see above */
2300 int mark; /* mark the new line */
2302 int i;
2303 int line_count; /* number of indexes in current block */
2304 int offset;
2305 int from, to;
2306 int space_needed; /* space needed for new line */
2307 int page_size;
2308 int page_count;
2309 int db_idx; /* index for lnum in data block */
2310 bhdr_T *hp;
2311 memfile_T *mfp;
2312 DATA_BL *dp;
2313 PTR_BL *pp;
2314 infoptr_T *ip;
2316 /* lnum out of range */
2317 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2318 return FAIL;
2320 if (lowest_marked && lowest_marked > lnum)
2321 lowest_marked = lnum + 1;
2323 if (len == 0)
2324 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2325 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2327 mfp = buf->b_ml.ml_mfp;
2328 page_size = mfp->mf_page_size;
2331 * find the data block containing the previous line
2332 * This also fills the stack with the blocks from the root to the data block
2333 * This also releases any locked block.
2335 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2336 ML_INSERT)) == NULL)
2337 return FAIL;
2339 buf->b_ml.ml_flags &= ~ML_EMPTY;
2341 if (lnum == 0) /* got line one instead, correct db_idx */
2342 db_idx = -1; /* careful, it is negative! */
2343 else
2344 db_idx = lnum - buf->b_ml.ml_locked_low;
2345 /* get line count before the insertion */
2346 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2348 dp = (DATA_BL *)(hp->bh_data);
2351 * If
2352 * - there is not enough room in the current block
2353 * - appending to the last line in the block
2354 * - not appending to the last line in the file
2355 * insert in front of the next block.
2357 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2358 && lnum < buf->b_ml.ml_line_count)
2361 * Now that the line is not going to be inserted in the block that we
2362 * expected, the line count has to be adjusted in the pointer blocks
2363 * by using ml_locked_lineadd.
2365 --(buf->b_ml.ml_locked_lineadd);
2366 --(buf->b_ml.ml_locked_high);
2367 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2368 return FAIL;
2370 db_idx = -1; /* careful, it is negative! */
2371 /* get line count before the insertion */
2372 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2373 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2375 dp = (DATA_BL *)(hp->bh_data);
2378 ++buf->b_ml.ml_line_count;
2380 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2383 * Insert new line in existing data block, or in data block allocated above.
2385 dp->db_txt_start -= len;
2386 dp->db_free -= space_needed;
2387 ++(dp->db_line_count);
2390 * move the text of the lines that follow to the front
2391 * adjust the indexes of the lines that follow
2393 if (line_count > db_idx + 1) /* if there are following lines */
2396 * Offset is the start of the previous line.
2397 * This will become the character just after the new line.
2399 if (db_idx < 0)
2400 offset = dp->db_txt_end;
2401 else
2402 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2403 mch_memmove((char *)dp + dp->db_txt_start,
2404 (char *)dp + dp->db_txt_start + len,
2405 (size_t)(offset - (dp->db_txt_start + len)));
2406 for (i = line_count - 1; i > db_idx; --i)
2407 dp->db_index[i + 1] = dp->db_index[i] - len;
2408 dp->db_index[db_idx + 1] = offset - len;
2410 else /* add line at the end */
2411 dp->db_index[db_idx + 1] = dp->db_txt_start;
2414 * copy the text into the block
2416 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2417 if (mark)
2418 dp->db_index[db_idx + 1] |= DB_MARKED;
2421 * Mark the block dirty.
2423 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2424 if (!newfile)
2425 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2427 else /* not enough space in data block */
2430 * If there is not enough room we have to create a new data block and copy some
2431 * lines into it.
2432 * Then we have to insert an entry in the pointer block.
2433 * If this pointer block also is full, we go up another block, and so on, up
2434 * to the root if necessary.
2435 * The line counts in the pointer blocks have already been adjusted by
2436 * ml_find_line().
2438 long line_count_left, line_count_right;
2439 int page_count_left, page_count_right;
2440 bhdr_T *hp_left;
2441 bhdr_T *hp_right;
2442 bhdr_T *hp_new;
2443 int lines_moved;
2444 int data_moved = 0; /* init to shut up gcc */
2445 int total_moved = 0; /* init to shut up gcc */
2446 DATA_BL *dp_right, *dp_left;
2447 int stack_idx;
2448 int in_left;
2449 int lineadd;
2450 blocknr_T bnum_left, bnum_right;
2451 linenr_T lnum_left, lnum_right;
2452 int pb_idx;
2453 PTR_BL *pp_new;
2456 * We are going to allocate a new data block. Depending on the
2457 * situation it will be put to the left or right of the existing
2458 * block. If possible we put the new line in the left block and move
2459 * the lines after it to the right block. Otherwise the new line is
2460 * also put in the right block. This method is more efficient when
2461 * inserting a lot of lines at one place.
2463 if (db_idx < 0) /* left block is new, right block is existing */
2465 lines_moved = 0;
2466 in_left = TRUE;
2467 /* space_needed does not change */
2469 else /* left block is existing, right block is new */
2471 lines_moved = line_count - db_idx - 1;
2472 if (lines_moved == 0)
2473 in_left = FALSE; /* put new line in right block */
2474 /* space_needed does not change */
2475 else
2477 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2478 dp->db_txt_start;
2479 total_moved = data_moved + lines_moved * INDEX_SIZE;
2480 if ((int)dp->db_free + total_moved >= space_needed)
2482 in_left = TRUE; /* put new line in left block */
2483 space_needed = total_moved;
2485 else
2487 in_left = FALSE; /* put new line in right block */
2488 space_needed += total_moved;
2493 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2494 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2496 /* correct line counts in pointer blocks */
2497 --(buf->b_ml.ml_locked_lineadd);
2498 --(buf->b_ml.ml_locked_high);
2499 return FAIL;
2501 if (db_idx < 0) /* left block is new */
2503 hp_left = hp_new;
2504 hp_right = hp;
2505 line_count_left = 0;
2506 line_count_right = line_count;
2508 else /* right block is new */
2510 hp_left = hp;
2511 hp_right = hp_new;
2512 line_count_left = line_count;
2513 line_count_right = 0;
2515 dp_right = (DATA_BL *)(hp_right->bh_data);
2516 dp_left = (DATA_BL *)(hp_left->bh_data);
2517 bnum_left = hp_left->bh_bnum;
2518 bnum_right = hp_right->bh_bnum;
2519 page_count_left = hp_left->bh_page_count;
2520 page_count_right = hp_right->bh_page_count;
2523 * May move the new line into the right/new block.
2525 if (!in_left)
2527 dp_right->db_txt_start -= len;
2528 dp_right->db_free -= len + INDEX_SIZE;
2529 dp_right->db_index[0] = dp_right->db_txt_start;
2530 if (mark)
2531 dp_right->db_index[0] |= DB_MARKED;
2533 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2534 line, (size_t)len);
2535 ++line_count_right;
2538 * may move lines from the left/old block to the right/new one.
2540 if (lines_moved)
2544 dp_right->db_txt_start -= data_moved;
2545 dp_right->db_free -= total_moved;
2546 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2547 (char *)dp_left + dp_left->db_txt_start,
2548 (size_t)data_moved);
2549 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2550 dp_left->db_txt_start += data_moved;
2551 dp_left->db_free += total_moved;
2554 * update indexes in the new block
2556 for (to = line_count_right, from = db_idx + 1;
2557 from < line_count_left; ++from, ++to)
2558 dp_right->db_index[to] = dp->db_index[from] + offset;
2559 line_count_right += lines_moved;
2560 line_count_left -= lines_moved;
2564 * May move the new line into the left (old or new) block.
2566 if (in_left)
2568 dp_left->db_txt_start -= len;
2569 dp_left->db_free -= len + INDEX_SIZE;
2570 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2571 if (mark)
2572 dp_left->db_index[line_count_left] |= DB_MARKED;
2573 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2574 line, (size_t)len);
2575 ++line_count_left;
2578 if (db_idx < 0) /* left block is new */
2580 lnum_left = lnum + 1;
2581 lnum_right = 0;
2583 else /* right block is new */
2585 lnum_left = 0;
2586 if (in_left)
2587 lnum_right = lnum + 2;
2588 else
2589 lnum_right = lnum + 1;
2591 dp_left->db_line_count = line_count_left;
2592 dp_right->db_line_count = line_count_right;
2595 * release the two data blocks
2596 * The new one (hp_new) already has a correct blocknumber.
2597 * The old one (hp, in ml_locked) gets a positive blocknumber if
2598 * we changed it and we are not editing a new file.
2600 if (lines_moved || in_left)
2601 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2602 if (!newfile && db_idx >= 0 && in_left)
2603 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2604 mf_put(mfp, hp_new, TRUE, FALSE);
2607 * flush the old data block
2608 * set ml_locked_lineadd to 0, because the updating of the
2609 * pointer blocks is done below
2611 lineadd = buf->b_ml.ml_locked_lineadd;
2612 buf->b_ml.ml_locked_lineadd = 0;
2613 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2616 * update pointer blocks for the new data block
2618 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2619 --stack_idx)
2621 ip = &(buf->b_ml.ml_stack[stack_idx]);
2622 pb_idx = ip->ip_index;
2623 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2624 return FAIL;
2625 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2626 if (pp->pb_id != PTR_ID)
2628 EMSG(_("E317: pointer block id wrong 3"));
2629 mf_put(mfp, hp, FALSE, FALSE);
2630 return FAIL;
2633 * TODO: If the pointer block is full and we are adding at the end
2634 * try to insert in front of the next block
2636 /* block not full, add one entry */
2637 if (pp->pb_count < pp->pb_count_max)
2639 if (pb_idx + 1 < (int)pp->pb_count)
2640 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2641 &pp->pb_pointer[pb_idx + 1],
2642 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2643 ++pp->pb_count;
2644 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2645 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2646 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2647 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2648 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2649 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2651 if (lnum_left != 0)
2652 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2653 if (lnum_right != 0)
2654 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2656 mf_put(mfp, hp, TRUE, FALSE);
2657 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2659 if (lineadd)
2661 --(buf->b_ml.ml_stack_top);
2662 /* fix line count for rest of blocks in the stack */
2663 ml_lineadd(buf, lineadd);
2664 /* fix stack itself */
2665 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2666 lineadd;
2667 ++(buf->b_ml.ml_stack_top);
2671 * We are finished, break the loop here.
2673 break;
2675 else /* pointer block full */
2678 * split the pointer block
2679 * allocate a new pointer block
2680 * move some of the pointer into the new block
2681 * prepare for updating the parent block
2683 for (;;) /* do this twice when splitting block 1 */
2685 hp_new = ml_new_ptr(mfp);
2686 if (hp_new == NULL) /* TODO: try to fix tree */
2687 return FAIL;
2688 pp_new = (PTR_BL *)(hp_new->bh_data);
2690 if (hp->bh_bnum != 1)
2691 break;
2694 * if block 1 becomes full the tree is given an extra level
2695 * The pointers from block 1 are moved into the new block.
2696 * block 1 is updated to point to the new block
2697 * then continue to split the new block
2699 mch_memmove(pp_new, pp, (size_t)page_size);
2700 pp->pb_count = 1;
2701 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2702 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2703 pp->pb_pointer[0].pe_old_lnum = 1;
2704 pp->pb_pointer[0].pe_page_count = 1;
2705 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2706 hp = hp_new; /* new block is to be split */
2707 pp = pp_new;
2708 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2709 ip->ip_index = 0;
2710 ++stack_idx; /* do block 1 again later */
2713 * move the pointers after the current one to the new block
2714 * If there are none, the new entry will be in the new block.
2716 total_moved = pp->pb_count - pb_idx - 1;
2717 if (total_moved)
2719 mch_memmove(&pp_new->pb_pointer[0],
2720 &pp->pb_pointer[pb_idx + 1],
2721 (size_t)(total_moved) * sizeof(PTR_EN));
2722 pp_new->pb_count = total_moved;
2723 pp->pb_count -= total_moved - 1;
2724 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2725 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2726 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2727 if (lnum_right)
2728 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2730 else
2732 pp_new->pb_count = 1;
2733 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2734 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2735 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2736 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2738 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2739 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2740 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2741 if (lnum_left)
2742 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2743 lnum_left = 0;
2744 lnum_right = 0;
2747 * recompute line counts
2749 line_count_right = 0;
2750 for (i = 0; i < (int)pp_new->pb_count; ++i)
2751 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2752 line_count_left = 0;
2753 for (i = 0; i < (int)pp->pb_count; ++i)
2754 line_count_left += pp->pb_pointer[i].pe_line_count;
2756 bnum_left = hp->bh_bnum;
2757 bnum_right = hp_new->bh_bnum;
2758 page_count_left = 1;
2759 page_count_right = 1;
2760 mf_put(mfp, hp, TRUE, FALSE);
2761 mf_put(mfp, hp_new, TRUE, FALSE);
2766 * Safety check: fallen out of for loop?
2768 if (stack_idx < 0)
2770 EMSG(_("E318: Updated too many blocks?"));
2771 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2775 #ifdef FEAT_BYTEOFF
2776 /* The line was inserted below 'lnum' */
2777 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2778 #endif
2779 #ifdef FEAT_NETBEANS_INTG
2780 if (usingNetbeans)
2782 if (STRLEN(line) > 0)
2783 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2784 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2785 (char_u *)"\n", 1);
2787 #endif
2788 return OK;
2792 * Replace line lnum, with buffering, in current buffer.
2794 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2795 * copied to allocated memory already.
2797 * Check: The caller of this function should probably also call
2798 * changed_lines(), unless update_screen(NOT_VALID) is used.
2800 * return FAIL for failure, OK otherwise
2803 ml_replace(lnum, line, copy)
2804 linenr_T lnum;
2805 char_u *line;
2806 int copy;
2808 if (line == NULL) /* just checking... */
2809 return FAIL;
2811 /* When starting up, we might still need to create the memfile */
2812 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2813 return FAIL;
2815 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2816 return FAIL;
2817 #ifdef FEAT_NETBEANS_INTG
2818 if (usingNetbeans)
2820 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2821 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2823 #endif
2824 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2825 ml_flush_line(curbuf); /* flush it */
2826 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2827 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2828 curbuf->b_ml.ml_line_ptr = line;
2829 curbuf->b_ml.ml_line_lnum = lnum;
2830 curbuf->b_ml.ml_line_max = 0;
2831 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2833 return OK;
2837 * Delete line 'lnum' in the current buffer.
2839 * Check: The caller of this function should probably also call
2840 * deleted_lines() after this.
2842 * return FAIL for failure, OK otherwise
2845 ml_delete(lnum, message)
2846 linenr_T lnum;
2847 int message;
2849 ml_flush_line(curbuf);
2850 return ml_delete_int(curbuf, lnum, message);
2853 static int
2854 ml_delete_int(buf, lnum, message)
2855 buf_T *buf;
2856 linenr_T lnum;
2857 int message;
2859 bhdr_T *hp;
2860 memfile_T *mfp;
2861 DATA_BL *dp;
2862 PTR_BL *pp;
2863 infoptr_T *ip;
2864 int count; /* number of entries in block */
2865 int idx;
2866 int stack_idx;
2867 int text_start;
2868 int line_start;
2869 long line_size;
2870 int i;
2872 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2873 return FAIL;
2875 if (lowest_marked && lowest_marked > lnum)
2876 lowest_marked--;
2879 * If the file becomes empty the last line is replaced by an empty line.
2881 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2883 if (message
2884 #ifdef FEAT_NETBEANS_INTG
2885 && !netbeansSuppressNoLines
2886 #endif
2888 set_keep_msg((char_u *)_(no_lines_msg), 0);
2890 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2891 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2892 buf->b_ml.ml_flags |= ML_EMPTY;
2894 return i;
2898 * find the data block containing the line
2899 * This also fills the stack with the blocks from the root to the data block
2900 * This also releases any locked block.
2902 mfp = buf->b_ml.ml_mfp;
2903 if (mfp == NULL)
2904 return FAIL;
2906 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2907 return FAIL;
2909 dp = (DATA_BL *)(hp->bh_data);
2910 /* compute line count before the delete */
2911 count = (long)(buf->b_ml.ml_locked_high)
2912 - (long)(buf->b_ml.ml_locked_low) + 2;
2913 idx = lnum - buf->b_ml.ml_locked_low;
2915 --buf->b_ml.ml_line_count;
2917 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2918 if (idx == 0) /* first line in block, text at the end */
2919 line_size = dp->db_txt_end - line_start;
2920 else
2921 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2923 #ifdef FEAT_NETBEANS_INTG
2924 if (usingNetbeans)
2925 netbeans_removed(buf, lnum, 0, (long)line_size);
2926 #endif
2929 * special case: If there is only one line in the data block it becomes empty.
2930 * Then we have to remove the entry, pointing to this data block, from the
2931 * pointer block. If this pointer block also becomes empty, we go up another
2932 * block, and so on, up to the root if necessary.
2933 * The line counts in the pointer blocks have already been adjusted by
2934 * ml_find_line().
2936 if (count == 1)
2938 mf_free(mfp, hp); /* free the data block */
2939 buf->b_ml.ml_locked = NULL;
2941 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2943 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2944 ip = &(buf->b_ml.ml_stack[stack_idx]);
2945 idx = ip->ip_index;
2946 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2947 return FAIL;
2948 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2949 if (pp->pb_id != PTR_ID)
2951 EMSG(_("E317: pointer block id wrong 4"));
2952 mf_put(mfp, hp, FALSE, FALSE);
2953 return FAIL;
2955 count = --(pp->pb_count);
2956 if (count == 0) /* the pointer block becomes empty! */
2957 mf_free(mfp, hp);
2958 else
2960 if (count != idx) /* move entries after the deleted one */
2961 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2962 (size_t)(count - idx) * sizeof(PTR_EN));
2963 mf_put(mfp, hp, TRUE, FALSE);
2965 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2966 /* fix line count for rest of blocks in the stack */
2967 if (buf->b_ml.ml_locked_lineadd != 0)
2969 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2970 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2971 buf->b_ml.ml_locked_lineadd;
2973 ++(buf->b_ml.ml_stack_top);
2975 break;
2978 CHECK(stack_idx < 0, _("deleted block 1?"));
2980 else
2983 * delete the text by moving the next lines forwards
2985 text_start = dp->db_txt_start;
2986 mch_memmove((char *)dp + text_start + line_size,
2987 (char *)dp + text_start, (size_t)(line_start - text_start));
2990 * delete the index by moving the next indexes backwards
2991 * Adjust the indexes for the text movement.
2993 for (i = idx; i < count - 1; ++i)
2994 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2996 dp->db_free += line_size + INDEX_SIZE;
2997 dp->db_txt_start += line_size;
2998 --(dp->db_line_count);
3001 * mark the block dirty and make sure it is in the file (for recovery)
3003 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3006 #ifdef FEAT_BYTEOFF
3007 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
3008 #endif
3009 return OK;
3013 * set the B_MARKED flag for line 'lnum'
3015 void
3016 ml_setmarked(lnum)
3017 linenr_T lnum;
3019 bhdr_T *hp;
3020 DATA_BL *dp;
3021 /* invalid line number */
3022 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
3023 || curbuf->b_ml.ml_mfp == NULL)
3024 return; /* give error message? */
3026 if (lowest_marked == 0 || lowest_marked > lnum)
3027 lowest_marked = lnum;
3030 * find the data block containing the line
3031 * This also fills the stack with the blocks from the root to the data block
3032 * This also releases any locked block.
3034 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3035 return; /* give error message? */
3037 dp = (DATA_BL *)(hp->bh_data);
3038 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
3039 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3043 * find the first line with its B_MARKED flag set
3045 linenr_T
3046 ml_firstmarked()
3048 bhdr_T *hp;
3049 DATA_BL *dp;
3050 linenr_T lnum;
3051 int i;
3053 if (curbuf->b_ml.ml_mfp == NULL)
3054 return (linenr_T) 0;
3057 * The search starts with lowest_marked line. This is the last line where
3058 * a mark was found, adjusted by inserting/deleting lines.
3060 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3063 * Find the data block containing the line.
3064 * This also fills the stack with the blocks from the root to the data
3065 * block This also releases any locked block.
3067 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3068 return (linenr_T)0; /* give error message? */
3070 dp = (DATA_BL *)(hp->bh_data);
3072 for (i = lnum - curbuf->b_ml.ml_locked_low;
3073 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3074 if ((dp->db_index[i]) & DB_MARKED)
3076 (dp->db_index[i]) &= DB_INDEX_MASK;
3077 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3078 lowest_marked = lnum + 1;
3079 return lnum;
3083 return (linenr_T) 0;
3086 #if 0 /* not used */
3088 * return TRUE if line 'lnum' has a mark
3091 ml_has_mark(lnum)
3092 linenr_T lnum;
3094 bhdr_T *hp;
3095 DATA_BL *dp;
3097 if (curbuf->b_ml.ml_mfp == NULL
3098 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3099 return FALSE;
3101 dp = (DATA_BL *)(hp->bh_data);
3102 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3104 #endif
3107 * clear all DB_MARKED flags
3109 void
3110 ml_clearmarked()
3112 bhdr_T *hp;
3113 DATA_BL *dp;
3114 linenr_T lnum;
3115 int i;
3117 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3118 return;
3121 * The search starts with line lowest_marked.
3123 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3126 * Find the data block containing the line.
3127 * This also fills the stack with the blocks from the root to the data
3128 * block and releases any locked block.
3130 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3131 return; /* give error message? */
3133 dp = (DATA_BL *)(hp->bh_data);
3135 for (i = lnum - curbuf->b_ml.ml_locked_low;
3136 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3137 if ((dp->db_index[i]) & DB_MARKED)
3139 (dp->db_index[i]) &= DB_INDEX_MASK;
3140 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3144 lowest_marked = 0;
3145 return;
3149 * flush ml_line if necessary
3151 static void
3152 ml_flush_line(buf)
3153 buf_T *buf;
3155 bhdr_T *hp;
3156 DATA_BL *dp;
3157 linenr_T lnum;
3158 char_u *new_line;
3159 char_u *old_line;
3160 colnr_T new_len;
3161 int old_len;
3162 int extra;
3163 int idx;
3164 int start;
3165 int count;
3166 int i;
3168 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3169 return; /* nothing to do */
3171 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3173 lnum = buf->b_ml.ml_line_lnum;
3174 new_line = buf->b_ml.ml_line_ptr;
3176 hp = ml_find_line(buf, lnum, ML_FIND);
3177 if (hp == NULL)
3178 EMSGN(_("E320: Cannot find line %ld"), lnum);
3179 else
3181 dp = (DATA_BL *)(hp->bh_data);
3182 idx = lnum - buf->b_ml.ml_locked_low;
3183 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3184 old_line = (char_u *)dp + start;
3185 if (idx == 0) /* line is last in block */
3186 old_len = dp->db_txt_end - start;
3187 else /* text of previous line follows */
3188 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3189 new_len = (colnr_T)STRLEN(new_line) + 1;
3190 extra = new_len - old_len; /* negative if lines gets smaller */
3193 * if new line fits in data block, replace directly
3195 if ((int)dp->db_free >= extra)
3197 /* if the length changes and there are following lines */
3198 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3199 if (extra != 0 && idx < count - 1)
3201 /* move text of following lines */
3202 mch_memmove((char *)dp + dp->db_txt_start - extra,
3203 (char *)dp + dp->db_txt_start,
3204 (size_t)(start - dp->db_txt_start));
3206 /* adjust pointers of this and following lines */
3207 for (i = idx + 1; i < count; ++i)
3208 dp->db_index[i] -= extra;
3210 dp->db_index[idx] -= extra;
3212 /* adjust free space */
3213 dp->db_free -= extra;
3214 dp->db_txt_start -= extra;
3216 /* copy new line into the data block */
3217 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3218 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3219 #ifdef FEAT_BYTEOFF
3220 /* The else case is already covered by the insert and delete */
3221 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3222 #endif
3224 else
3227 * Cannot do it in one data block: Delete and append.
3228 * Append first, because ml_delete_int() cannot delete the
3229 * last line in a buffer, which causes trouble for a buffer
3230 * that has only one line.
3231 * Don't forget to copy the mark!
3233 /* How about handling errors??? */
3234 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3235 (dp->db_index[idx] & DB_MARKED));
3236 (void)ml_delete_int(buf, lnum, FALSE);
3239 vim_free(new_line);
3242 buf->b_ml.ml_line_lnum = 0;
3246 * create a new, empty, data block
3248 static bhdr_T *
3249 ml_new_data(mfp, negative, page_count)
3250 memfile_T *mfp;
3251 int negative;
3252 int page_count;
3254 bhdr_T *hp;
3255 DATA_BL *dp;
3257 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3258 return NULL;
3260 dp = (DATA_BL *)(hp->bh_data);
3261 dp->db_id = DATA_ID;
3262 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3263 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3264 dp->db_line_count = 0;
3266 return hp;
3270 * create a new, empty, pointer block
3272 static bhdr_T *
3273 ml_new_ptr(mfp)
3274 memfile_T *mfp;
3276 bhdr_T *hp;
3277 PTR_BL *pp;
3279 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3280 return NULL;
3282 pp = (PTR_BL *)(hp->bh_data);
3283 pp->pb_id = PTR_ID;
3284 pp->pb_count = 0;
3285 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3287 return hp;
3291 * lookup line 'lnum' in a memline
3293 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3294 * if ML_FLUSH only flush a locked block
3295 * if ML_FIND just find the line
3297 * If the block was found it is locked and put in ml_locked.
3298 * The stack is updated to lead to the locked block. The ip_high field in
3299 * the stack is updated to reflect the last line in the block AFTER the
3300 * insert or delete, also if the pointer block has not been updated yet. But
3301 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3303 * return: NULL for failure, pointer to block header otherwise
3305 static bhdr_T *
3306 ml_find_line(buf, lnum, action)
3307 buf_T *buf;
3308 linenr_T lnum;
3309 int action;
3311 DATA_BL *dp;
3312 PTR_BL *pp;
3313 infoptr_T *ip;
3314 bhdr_T *hp;
3315 memfile_T *mfp;
3316 linenr_T t;
3317 blocknr_T bnum, bnum2;
3318 int dirty;
3319 linenr_T low, high;
3320 int top;
3321 int page_count;
3322 int idx;
3324 mfp = buf->b_ml.ml_mfp;
3327 * If there is a locked block check if the wanted line is in it.
3328 * If not, flush and release the locked block.
3329 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3330 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3331 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3333 if (buf->b_ml.ml_locked)
3335 if (ML_SIMPLE(action)
3336 && buf->b_ml.ml_locked_low <= lnum
3337 && buf->b_ml.ml_locked_high >= lnum
3338 && !mf_dont_release)
3340 /* remember to update pointer blocks and stack later */
3341 if (action == ML_INSERT)
3343 ++(buf->b_ml.ml_locked_lineadd);
3344 ++(buf->b_ml.ml_locked_high);
3346 else if (action == ML_DELETE)
3348 --(buf->b_ml.ml_locked_lineadd);
3349 --(buf->b_ml.ml_locked_high);
3351 return (buf->b_ml.ml_locked);
3354 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3355 buf->b_ml.ml_flags & ML_LOCKED_POS);
3356 buf->b_ml.ml_locked = NULL;
3359 * If lines have been added or deleted in the locked block, need to
3360 * update the line count in pointer blocks.
3362 if (buf->b_ml.ml_locked_lineadd != 0)
3363 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3366 if (action == ML_FLUSH) /* nothing else to do */
3367 return NULL;
3369 bnum = 1; /* start at the root of the tree */
3370 page_count = 1;
3371 low = 1;
3372 high = buf->b_ml.ml_line_count;
3374 if (action == ML_FIND) /* first try stack entries */
3376 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3378 ip = &(buf->b_ml.ml_stack[top]);
3379 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3381 bnum = ip->ip_bnum;
3382 low = ip->ip_low;
3383 high = ip->ip_high;
3384 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3385 break;
3388 if (top < 0)
3389 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3391 else /* ML_DELETE or ML_INSERT */
3392 buf->b_ml.ml_stack_top = 0; /* start at the root */
3395 * search downwards in the tree until a data block is found
3397 for (;;)
3399 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3400 goto error_noblock;
3403 * update high for insert/delete
3405 if (action == ML_INSERT)
3406 ++high;
3407 else if (action == ML_DELETE)
3408 --high;
3410 dp = (DATA_BL *)(hp->bh_data);
3411 if (dp->db_id == DATA_ID) /* data block */
3413 buf->b_ml.ml_locked = hp;
3414 buf->b_ml.ml_locked_low = low;
3415 buf->b_ml.ml_locked_high = high;
3416 buf->b_ml.ml_locked_lineadd = 0;
3417 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3418 return hp;
3421 pp = (PTR_BL *)(dp); /* must be pointer block */
3422 if (pp->pb_id != PTR_ID)
3424 EMSG(_("E317: pointer block id wrong"));
3425 goto error_block;
3428 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3429 goto error_block;
3430 ip = &(buf->b_ml.ml_stack[top]);
3431 ip->ip_bnum = bnum;
3432 ip->ip_low = low;
3433 ip->ip_high = high;
3434 ip->ip_index = -1; /* index not known yet */
3436 dirty = FALSE;
3437 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3439 t = pp->pb_pointer[idx].pe_line_count;
3440 CHECK(t == 0, _("pe_line_count is zero"));
3441 if ((low += t) > lnum)
3443 ip->ip_index = idx;
3444 bnum = pp->pb_pointer[idx].pe_bnum;
3445 page_count = pp->pb_pointer[idx].pe_page_count;
3446 high = low - 1;
3447 low -= t;
3450 * a negative block number may have been changed
3452 if (bnum < 0)
3454 bnum2 = mf_trans_del(mfp, bnum);
3455 if (bnum != bnum2)
3457 bnum = bnum2;
3458 pp->pb_pointer[idx].pe_bnum = bnum;
3459 dirty = TRUE;
3463 break;
3466 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3468 if (lnum > buf->b_ml.ml_line_count)
3469 EMSGN(_("E322: line number out of range: %ld past the end"),
3470 lnum - buf->b_ml.ml_line_count);
3472 else
3473 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3474 goto error_block;
3476 if (action == ML_DELETE)
3478 pp->pb_pointer[idx].pe_line_count--;
3479 dirty = TRUE;
3481 else if (action == ML_INSERT)
3483 pp->pb_pointer[idx].pe_line_count++;
3484 dirty = TRUE;
3486 mf_put(mfp, hp, dirty, FALSE);
3489 error_block:
3490 mf_put(mfp, hp, FALSE, FALSE);
3491 error_noblock:
3493 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3494 * the incremented/decremented line counts, because there won't be a line
3495 * inserted/deleted after all.
3497 if (action == ML_DELETE)
3498 ml_lineadd(buf, 1);
3499 else if (action == ML_INSERT)
3500 ml_lineadd(buf, -1);
3501 buf->b_ml.ml_stack_top = 0;
3502 return NULL;
3506 * add an entry to the info pointer stack
3508 * return -1 for failure, number of the new entry otherwise
3510 static int
3511 ml_add_stack(buf)
3512 buf_T *buf;
3514 int top;
3515 infoptr_T *newstack;
3517 top = buf->b_ml.ml_stack_top;
3519 /* may have to increase the stack size */
3520 if (top == buf->b_ml.ml_stack_size)
3522 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3524 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3525 (buf->b_ml.ml_stack_size + STACK_INCR));
3526 if (newstack == NULL)
3527 return -1;
3528 mch_memmove(newstack, buf->b_ml.ml_stack,
3529 (size_t)top * sizeof(infoptr_T));
3530 vim_free(buf->b_ml.ml_stack);
3531 buf->b_ml.ml_stack = newstack;
3532 buf->b_ml.ml_stack_size += STACK_INCR;
3535 buf->b_ml.ml_stack_top++;
3536 return top;
3540 * Update the pointer blocks on the stack for inserted/deleted lines.
3541 * The stack itself is also updated.
3543 * When a insert/delete line action fails, the line is not inserted/deleted,
3544 * but the pointer blocks have already been updated. That is fixed here by
3545 * walking through the stack.
3547 * Count is the number of lines added, negative if lines have been deleted.
3549 static void
3550 ml_lineadd(buf, count)
3551 buf_T *buf;
3552 int count;
3554 int idx;
3555 infoptr_T *ip;
3556 PTR_BL *pp;
3557 memfile_T *mfp = buf->b_ml.ml_mfp;
3558 bhdr_T *hp;
3560 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3562 ip = &(buf->b_ml.ml_stack[idx]);
3563 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3564 break;
3565 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3566 if (pp->pb_id != PTR_ID)
3568 mf_put(mfp, hp, FALSE, FALSE);
3569 EMSG(_("E317: pointer block id wrong 2"));
3570 break;
3572 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3573 ip->ip_high += count;
3574 mf_put(mfp, hp, TRUE, FALSE);
3578 #ifdef HAVE_READLINK
3579 static int resolve_symlink __ARGS((char_u *fname, char_u *buf));
3582 * Resolve a symlink in the last component of a file name.
3583 * Note that f_resolve() does it for every part of the path, we don't do that
3584 * here.
3585 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3586 * Otherwise returns FAIL.
3588 static int
3589 resolve_symlink(fname, buf)
3590 char_u *fname;
3591 char_u *buf;
3593 char_u tmp[MAXPATHL];
3594 int ret;
3595 int depth = 0;
3597 if (fname == NULL)
3598 return FAIL;
3600 /* Put the result so far in tmp[], starting with the original name. */
3601 vim_strncpy(tmp, fname, MAXPATHL - 1);
3603 for (;;)
3605 /* Limit symlink depth to 100, catch recursive loops. */
3606 if (++depth == 100)
3608 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3609 return FAIL;
3612 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3613 if (ret <= 0)
3615 if (errno == EINVAL || errno == ENOENT)
3617 /* Found non-symlink or not existing file, stop here.
3618 * When at the first level use the unmodified name, skip the
3619 * call to vim_FullName(). */
3620 if (depth == 1)
3621 return FAIL;
3623 /* Use the resolved name in tmp[]. */
3624 break;
3627 /* There must be some error reading links, use original name. */
3628 return FAIL;
3630 buf[ret] = NUL;
3633 * Check whether the symlink is relative or absolute.
3634 * If it's relative, build a new path based on the directory
3635 * portion of the filename (if any) and the path the symlink
3636 * points to.
3638 if (mch_isFullName(buf))
3639 STRCPY(tmp, buf);
3640 else
3642 char_u *tail;
3644 tail = gettail(tmp);
3645 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3646 return FAIL;
3647 STRCPY(tail, buf);
3652 * Try to resolve the full name of the file so that the swapfile name will
3653 * be consistent even when opening a relative symlink from different
3654 * working directories.
3656 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3658 #endif
3661 * Make swap file name out of the file name and a directory name.
3662 * Returns pointer to allocated memory or NULL.
3664 char_u *
3665 makeswapname(fname, ffname, buf, dir_name)
3666 char_u *fname;
3667 char_u *ffname UNUSED;
3668 buf_T *buf;
3669 char_u *dir_name;
3671 char_u *r, *s;
3672 #ifdef HAVE_READLINK
3673 char_u fname_buf[MAXPATHL];
3674 char_u *fname_res;
3675 #endif
3677 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3678 s = dir_name + STRLEN(dir_name);
3679 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3680 { /* Ends with '//', Use Full path */
3681 r = NULL;
3682 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3684 r = modname(s, (char_u *)".swp", FALSE);
3685 vim_free(s);
3687 return r;
3689 #endif
3691 #ifdef HAVE_READLINK
3692 /* Expand symlink in the file name, so that we put the swap file with the
3693 * actual file instead of with the symlink. */
3694 if (resolve_symlink(fname, fname_buf) == OK)
3695 fname_res = fname_buf;
3696 else
3697 fname_res = fname;
3698 #endif
3700 r = buf_modname(
3701 #ifdef SHORT_FNAME
3702 TRUE,
3703 #else
3704 (buf->b_p_sn || buf->b_shortname),
3705 #endif
3706 #ifdef RISCOS
3707 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3708 ffname,
3709 #else
3710 # ifdef HAVE_READLINK
3711 fname_res,
3712 # else
3713 fname,
3714 # endif
3715 #endif
3716 (char_u *)
3717 #if defined(VMS) || defined(RISCOS)
3718 "_swp",
3719 #else
3720 ".swp",
3721 #endif
3722 #ifdef SHORT_FNAME /* always 8.3 file name */
3723 FALSE
3724 #else
3725 /* Prepend a '.' to the swap file name for the current directory. */
3726 dir_name[0] == '.' && dir_name[1] == NUL
3727 #endif
3729 if (r == NULL) /* out of memory */
3730 return NULL;
3732 s = get_file_in_dir(r, dir_name);
3733 vim_free(r);
3734 return s;
3738 * Get file name to use for swap file or backup file.
3739 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3740 * option "dname".
3741 * - If "dname" is ".", return "fname" (swap file in dir of file).
3742 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3743 * relative to dir of file).
3744 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3745 * dir).
3747 * The return value is an allocated string and can be NULL.
3749 char_u *
3750 get_file_in_dir(fname, dname)
3751 char_u *fname;
3752 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3754 char_u *t;
3755 char_u *tail;
3756 char_u *retval;
3757 int save_char;
3759 tail = gettail(fname);
3761 if (dname[0] == '.' && dname[1] == NUL)
3762 retval = vim_strsave(fname);
3763 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3765 if (tail == fname) /* no path before file name */
3766 retval = concat_fnames(dname + 2, tail, TRUE);
3767 else
3769 save_char = *tail;
3770 *tail = NUL;
3771 t = concat_fnames(fname, dname + 2, TRUE);
3772 *tail = save_char;
3773 if (t == NULL) /* out of memory */
3774 retval = NULL;
3775 else
3777 retval = concat_fnames(t, tail, TRUE);
3778 vim_free(t);
3782 else
3783 retval = concat_fnames(dname, tail, TRUE);
3785 return retval;
3788 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3791 * Print the ATTENTION message: info about an existing swap file.
3793 static void
3794 attention_message(buf, fname)
3795 buf_T *buf; /* buffer being edited */
3796 char_u *fname; /* swap file name */
3798 struct stat st;
3799 time_t x, sx;
3800 char *p;
3802 ++no_wait_return;
3803 (void)EMSG(_("E325: ATTENTION"));
3804 MSG_PUTS(_("\nFound a swap file by the name \""));
3805 msg_home_replace(fname);
3806 MSG_PUTS("\"\n");
3807 sx = swapfile_info(fname);
3808 MSG_PUTS(_("While opening file \""));
3809 msg_outtrans(buf->b_fname);
3810 MSG_PUTS("\"\n");
3811 if (mch_stat((char *)buf->b_fname, &st) != -1)
3813 MSG_PUTS(_(" dated: "));
3814 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3815 p = ctime(&x); /* includes '\n' */
3816 if (p == NULL)
3817 MSG_PUTS("(invalid)\n");
3818 else
3819 MSG_PUTS(p);
3820 if (sx != 0 && x > sx)
3821 MSG_PUTS(_(" NEWER than swap file!\n"));
3823 /* Some of these messages are long to allow translation to
3824 * other languages. */
3825 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"));
3826 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3827 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3828 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3829 msg_outtrans(buf->b_fname);
3830 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3831 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3832 msg_outtrans(fname);
3833 MSG_PUTS(_("\"\n to avoid this message.\n"));
3834 cmdline_row = msg_row;
3835 --no_wait_return;
3838 #ifdef FEAT_AUTOCMD
3839 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3842 * Trigger the SwapExists autocommands.
3843 * Returns a value for equivalent to do_dialog() (see below):
3844 * 0: still need to ask for a choice
3845 * 1: open read-only
3846 * 2: edit anyway
3847 * 3: recover
3848 * 4: delete it
3849 * 5: quit
3850 * 6: abort
3852 static int
3853 do_swapexists(buf, fname)
3854 buf_T *buf;
3855 char_u *fname;
3857 set_vim_var_string(VV_SWAPNAME, fname, -1);
3858 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3860 /* Trigger SwapExists autocommands with <afile> set to the file being
3861 * edited. Disallow changing directory here. */
3862 ++allbuf_lock;
3863 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3864 --allbuf_lock;
3866 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3868 switch (*get_vim_var_str(VV_SWAPCHOICE))
3870 case 'o': return 1;
3871 case 'e': return 2;
3872 case 'r': return 3;
3873 case 'd': return 4;
3874 case 'q': return 5;
3875 case 'a': return 6;
3878 return 0;
3880 #endif
3883 * Find out what name to use for the swap file for buffer 'buf'.
3885 * Several names are tried to find one that does not exist
3886 * Returns the name in allocated memory or NULL.
3888 * Note: If BASENAMELEN is not correct, you will get error messages for
3889 * not being able to open the swapfile
3890 * Note: May trigger SwapExists autocmd, pointers may change!
3892 static char_u *
3893 findswapname(buf, dirp, old_fname)
3894 buf_T *buf;
3895 char_u **dirp; /* pointer to list of directories */
3896 char_u *old_fname; /* don't give warning for this file name */
3898 char_u *fname;
3899 int n;
3900 char_u *dir_name;
3901 #ifdef AMIGA
3902 BPTR fh;
3903 #endif
3904 #ifndef SHORT_FNAME
3905 int r;
3906 #endif
3908 #if !defined(SHORT_FNAME) \
3909 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3910 # define CREATE_DUMMY_FILE
3911 FILE *dummyfd = NULL;
3914 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3915 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3916 * create will be exactly the same file. To avoid this problem we temporarily
3917 * create "test.doc".
3918 * Don't do this when the check below for a 8.3 file name is used.
3920 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3921 && mch_getperm(buf->b_fname) < 0)
3922 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3923 #endif
3926 * Isolate a directory name from *dirp and put it in dir_name.
3927 * First allocate some memory to put the directory name in.
3929 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3930 if (dir_name != NULL)
3931 (void)copy_option_part(dirp, dir_name, 31000, ",");
3934 * we try different names until we find one that does not exist yet
3936 if (dir_name == NULL) /* out of memory */
3937 fname = NULL;
3938 else
3939 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3941 for (;;)
3943 if (fname == NULL) /* must be out of memory */
3944 break;
3945 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3947 vim_free(fname);
3948 fname = NULL;
3949 break;
3951 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3953 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3954 * file names. If this is the first try and the swap file name does not fit in
3955 * 8.3, detect if this is the case, set shortname and try again.
3957 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3958 && !(buf->b_p_sn || buf->b_shortname))
3960 char_u *tail;
3961 char_u *fname2;
3962 struct stat s1, s2;
3963 int f1, f2;
3964 int created1 = FALSE, created2 = FALSE;
3965 int same = FALSE;
3968 * Check if swapfile name does not fit in 8.3:
3969 * It either contains two dots, is longer than 8 chars, or starts
3970 * with a dot.
3972 tail = gettail(buf->b_fname);
3973 if ( vim_strchr(tail, '.') != NULL
3974 || STRLEN(tail) > (size_t)8
3975 || *gettail(fname) == '.')
3977 fname2 = alloc(n + 2);
3978 if (fname2 != NULL)
3980 STRCPY(fname2, fname);
3981 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3982 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3983 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3985 if (vim_strchr(tail, '.') != NULL)
3986 fname2[n - 1] = 'x';
3987 else if (*gettail(fname) == '.')
3989 fname2[n] = 'x';
3990 fname2[n + 1] = NUL;
3992 else
3993 fname2[n - 5] += 1;
3995 * may need to create the files to be able to use mch_stat()
3997 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3998 if (f1 < 0)
4000 f1 = mch_open_rw((char *)fname,
4001 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4002 #if defined(OS2)
4003 if (f1 < 0 && errno == ENOENT)
4004 same = TRUE;
4005 #endif
4006 created1 = TRUE;
4008 if (f1 >= 0)
4010 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
4011 if (f2 < 0)
4013 f2 = mch_open_rw((char *)fname2,
4014 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
4015 created2 = TRUE;
4017 if (f2 >= 0)
4020 * Both files exist now. If mch_stat() returns the
4021 * same device and inode they are the same file.
4023 if (mch_fstat(f1, &s1) != -1
4024 && mch_fstat(f2, &s2) != -1
4025 && s1.st_dev == s2.st_dev
4026 && s1.st_ino == s2.st_ino)
4027 same = TRUE;
4028 close(f2);
4029 if (created2)
4030 mch_remove(fname2);
4032 close(f1);
4033 if (created1)
4034 mch_remove(fname);
4036 vim_free(fname2);
4037 if (same)
4039 buf->b_shortname = TRUE;
4040 vim_free(fname);
4041 fname = makeswapname(buf->b_fname, buf->b_ffname,
4042 buf, dir_name);
4043 continue; /* try again with b_shortname set */
4048 #endif
4050 * check if the swapfile already exists
4052 if (mch_getperm(fname) < 0) /* it does not exist */
4054 #ifdef HAVE_LSTAT
4055 struct stat sb;
4058 * Extra security check: When a swap file is a symbolic link, this
4059 * is most likely a symlink attack.
4061 if (mch_lstat((char *)fname, &sb) < 0)
4062 #else
4063 # ifdef AMIGA
4064 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
4066 * on the Amiga mch_getperm() will return -1 when the file exists
4067 * but is being used by another program. This happens if you edit
4068 * a file twice.
4070 if (fh != (BPTR)NULL) /* can open file, OK */
4072 Close(fh);
4073 mch_remove(fname);
4074 break;
4076 if (IoErr() != ERROR_OBJECT_IN_USE
4077 && IoErr() != ERROR_OBJECT_EXISTS)
4078 # endif
4079 #endif
4080 break;
4084 * A file name equal to old_fname is OK to use.
4086 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4087 break;
4090 * get here when file already exists
4092 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4094 #ifndef SHORT_FNAME
4096 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4097 * and file.doc are the same file. To guess if this problem is
4098 * present try if file.doc.swx exists. If it does, we set
4099 * buf->b_shortname and try file_doc.swp (dots replaced by
4100 * underscores for this file), and try again. If it doesn't we
4101 * assume that "file.doc.swp" already exists.
4103 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4105 fname[n - 1] = 'x';
4106 r = mch_getperm(fname); /* try "file.swx" */
4107 fname[n - 1] = 'p';
4108 if (r >= 0) /* "file.swx" seems to exist */
4110 buf->b_shortname = TRUE;
4111 vim_free(fname);
4112 fname = makeswapname(buf->b_fname, buf->b_ffname,
4113 buf, dir_name);
4114 continue; /* try again with '.' replaced with '_' */
4117 #endif
4119 * If we get here the ".swp" file really exists.
4120 * Give an error message, unless recovering, no file name, we are
4121 * viewing a help file or when the path of the file is different
4122 * (happens when all .swp files are in one directory).
4124 if (!recoverymode && buf->b_fname != NULL
4125 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4127 int fd;
4128 struct block0 b0;
4129 int differ = FALSE;
4132 * Try to read block 0 from the swap file to get the original
4133 * file name (and inode number).
4135 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4136 if (fd >= 0)
4138 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4141 * If the swapfile has the same directory as the
4142 * buffer don't compare the directory names, they can
4143 * have a different mountpoint.
4145 if (b0.b0_flags & B0_SAME_DIR)
4147 if (fnamecmp(gettail(buf->b_ffname),
4148 gettail(b0.b0_fname)) != 0
4149 || !same_directory(fname, buf->b_ffname))
4151 #ifdef CHECK_INODE
4152 /* Symlinks may point to the same file even
4153 * when the name differs, need to check the
4154 * inode too. */
4155 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4156 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4157 char_to_long(b0.b0_ino)))
4158 #endif
4159 differ = TRUE;
4162 else
4165 * The name in the swap file may be
4166 * "~user/path/file". Expand it first.
4168 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4169 #ifdef CHECK_INODE
4170 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4171 char_to_long(b0.b0_ino)))
4172 differ = TRUE;
4173 #else
4174 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4175 differ = TRUE;
4176 #endif
4179 close(fd);
4181 #ifdef RISCOS
4182 else
4183 /* Can't open swap file, though it does exist.
4184 * Assume that the user is editing two files with
4185 * the same name in different directories. No error.
4187 differ = TRUE;
4188 #endif
4190 /* give the ATTENTION message when there is an old swap file
4191 * for the current file, and the buffer was not recovered. */
4192 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4193 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4195 #if defined(HAS_SWAP_EXISTS_ACTION)
4196 int choice = 0;
4197 #endif
4198 #ifdef CREATE_DUMMY_FILE
4199 int did_use_dummy = FALSE;
4201 /* Avoid getting a warning for the file being created
4202 * outside of Vim, it was created at the start of this
4203 * function. Delete the file now, because Vim might exit
4204 * here if the window is closed. */
4205 if (dummyfd != NULL)
4207 fclose(dummyfd);
4208 dummyfd = NULL;
4209 mch_remove(buf->b_fname);
4210 did_use_dummy = TRUE;
4212 #endif
4214 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4215 process_still_running = FALSE;
4216 #endif
4217 #ifdef FEAT_AUTOCMD
4219 * If there is an SwapExists autocommand and we can handle
4220 * the response, trigger it. It may return 0 to ask the
4221 * user anyway.
4223 if (swap_exists_action != SEA_NONE
4224 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4225 choice = do_swapexists(buf, fname);
4227 if (choice == 0)
4228 #endif
4230 #ifdef FEAT_GUI
4231 /* If we are supposed to start the GUI but it wasn't
4232 * completely started yet, start it now. This makes
4233 * the messages displayed in the Vim window when
4234 * loading a session from the .gvimrc file. */
4235 if (gui.starting && !gui.in_use)
4236 gui_start();
4237 #endif
4238 /* Show info about the existing swap file. */
4239 attention_message(buf, fname);
4241 /* We don't want a 'q' typed at the more-prompt
4242 * interrupt loading a file. */
4243 got_int = FALSE;
4246 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4247 if (swap_exists_action != SEA_NONE && choice == 0)
4249 char_u *name;
4251 name = alloc((unsigned)(STRLEN(fname)
4252 + STRLEN(_("Swap file \""))
4253 + STRLEN(_("\" already exists!")) + 5));
4254 if (name != NULL)
4256 STRCPY(name, _("Swap file \""));
4257 home_replace(NULL, fname, name + STRLEN(name),
4258 1000, TRUE);
4259 STRCAT(name, _("\" already exists!"));
4261 choice = do_dialog(VIM_WARNING,
4262 (char_u *)_("VIM - ATTENTION"),
4263 name == NULL
4264 ? (char_u *)_("Swap file already exists!")
4265 : name,
4266 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4267 process_still_running
4268 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4269 # endif
4270 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4272 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4273 if (process_still_running && choice >= 4)
4274 choice++; /* Skip missing "Delete it" button */
4275 # endif
4276 vim_free(name);
4278 /* pretend screen didn't scroll, need redraw anyway */
4279 msg_scrolled = 0;
4280 redraw_all_later(NOT_VALID);
4282 #endif
4284 #if defined(HAS_SWAP_EXISTS_ACTION)
4285 if (choice > 0)
4287 switch (choice)
4289 case 1:
4290 buf->b_p_ro = TRUE;
4291 break;
4292 case 2:
4293 break;
4294 case 3:
4295 swap_exists_action = SEA_RECOVER;
4296 break;
4297 case 4:
4298 mch_remove(fname);
4299 break;
4300 case 5:
4301 swap_exists_action = SEA_QUIT;
4302 break;
4303 case 6:
4304 swap_exists_action = SEA_QUIT;
4305 got_int = TRUE;
4306 break;
4309 /* If the file was deleted this fname can be used. */
4310 if (mch_getperm(fname) < 0)
4311 break;
4313 else
4314 #endif
4316 MSG_PUTS("\n");
4317 if (msg_silent == 0)
4318 /* call wait_return() later */
4319 need_wait_return = TRUE;
4322 #ifdef CREATE_DUMMY_FILE
4323 /* Going to try another name, need the dummy file again. */
4324 if (did_use_dummy)
4325 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4326 #endif
4332 * Change the ".swp" extension to find another file that can be used.
4333 * First decrement the last char: ".swo", ".swn", etc.
4334 * If that still isn't enough decrement the last but one char: ".svz"
4335 * Can happen when editing many "No Name" buffers.
4337 if (fname[n - 1] == 'a') /* ".s?a" */
4339 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4341 EMSG(_("E326: Too many swap files found"));
4342 vim_free(fname);
4343 fname = NULL;
4344 break;
4346 --fname[n - 2]; /* ".svz", ".suz", etc. */
4347 fname[n - 1] = 'z' + 1;
4349 --fname[n - 1]; /* ".swo", ".swn", etc. */
4352 vim_free(dir_name);
4353 #ifdef CREATE_DUMMY_FILE
4354 if (dummyfd != NULL) /* file has been created temporarily */
4356 fclose(dummyfd);
4357 mch_remove(buf->b_fname);
4359 #endif
4360 return fname;
4363 static int
4364 b0_magic_wrong(b0p)
4365 ZERO_BL *b0p;
4367 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4368 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4369 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4370 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4373 #ifdef CHECK_INODE
4375 * Compare current file name with file name from swap file.
4376 * Try to use inode numbers when possible.
4377 * Return non-zero when files are different.
4379 * When comparing file names a few things have to be taken into consideration:
4380 * - When working over a network the full path of a file depends on the host.
4381 * We check the inode number if possible. It is not 100% reliable though,
4382 * because the device number cannot be used over a network.
4383 * - When a file does not exist yet (editing a new file) there is no inode
4384 * number.
4385 * - The file name in a swap file may not be valid on the current host. The
4386 * "~user" form is used whenever possible to avoid this.
4388 * This is getting complicated, let's make a table:
4390 * ino_c ino_s fname_c fname_s differ =
4392 * both files exist -> compare inode numbers:
4393 * != 0 != 0 X X ino_c != ino_s
4395 * inode number(s) unknown, file names available -> compare file names
4396 * == 0 X OK OK fname_c != fname_s
4397 * X == 0 OK OK fname_c != fname_s
4399 * current file doesn't exist, file for swap file exist, file name(s) not
4400 * available -> probably different
4401 * == 0 != 0 FAIL X TRUE
4402 * == 0 != 0 X FAIL TRUE
4404 * current file exists, inode for swap unknown, file name(s) not
4405 * available -> probably different
4406 * != 0 == 0 FAIL X TRUE
4407 * != 0 == 0 X FAIL TRUE
4409 * current file doesn't exist, inode for swap unknown, one file name not
4410 * available -> probably different
4411 * == 0 == 0 FAIL OK TRUE
4412 * == 0 == 0 OK FAIL TRUE
4414 * current file doesn't exist, inode for swap unknown, both file names not
4415 * available -> probably same file
4416 * == 0 == 0 FAIL FAIL FALSE
4418 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4419 * can't be changed without making the block 0 incompatible with 32 bit
4420 * versions.
4423 static int
4424 fnamecmp_ino(fname_c, fname_s, ino_block0)
4425 char_u *fname_c; /* current file name */
4426 char_u *fname_s; /* file name from swap file */
4427 long ino_block0;
4429 struct stat st;
4430 ino_t ino_c = 0; /* ino of current file */
4431 ino_t ino_s; /* ino of file from swap file */
4432 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4433 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4434 int retval_c; /* flag: buf_c valid */
4435 int retval_s; /* flag: buf_s valid */
4437 if (mch_stat((char *)fname_c, &st) == 0)
4438 ino_c = (ino_t)st.st_ino;
4441 * First we try to get the inode from the file name, because the inode in
4442 * the swap file may be outdated. If that fails (e.g. this path is not
4443 * valid on this machine), use the inode from block 0.
4445 if (mch_stat((char *)fname_s, &st) == 0)
4446 ino_s = (ino_t)st.st_ino;
4447 else
4448 ino_s = (ino_t)ino_block0;
4450 if (ino_c && ino_s)
4451 return (ino_c != ino_s);
4454 * One of the inode numbers is unknown, try a forced vim_FullName() and
4455 * compare the file names.
4457 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4458 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4459 if (retval_c == OK && retval_s == OK)
4460 return (STRCMP(buf_c, buf_s) != 0);
4463 * Can't compare inodes or file names, guess that the files are different,
4464 * unless both appear not to exist at all.
4466 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4467 return FALSE;
4468 return TRUE;
4470 #endif /* CHECK_INODE */
4473 * Move a long integer into a four byte character array.
4474 * Used for machine independency in block zero.
4476 static void
4477 long_to_char(n, s)
4478 long n;
4479 char_u *s;
4481 s[0] = (char_u)(n & 0xff);
4482 n = (unsigned)n >> 8;
4483 s[1] = (char_u)(n & 0xff);
4484 n = (unsigned)n >> 8;
4485 s[2] = (char_u)(n & 0xff);
4486 n = (unsigned)n >> 8;
4487 s[3] = (char_u)(n & 0xff);
4490 static long
4491 char_to_long(s)
4492 char_u *s;
4494 long retval;
4496 retval = s[3];
4497 retval <<= 8;
4498 retval |= s[2];
4499 retval <<= 8;
4500 retval |= s[1];
4501 retval <<= 8;
4502 retval |= s[0];
4504 return retval;
4508 * Set the flags in the first block of the swap file:
4509 * - file is modified or not: buf->b_changed
4510 * - 'fileformat'
4511 * - 'fileencoding'
4513 void
4514 ml_setflags(buf)
4515 buf_T *buf;
4517 bhdr_T *hp;
4518 ZERO_BL *b0p;
4520 if (!buf->b_ml.ml_mfp)
4521 return;
4522 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4524 if (hp->bh_bnum == 0)
4526 b0p = (ZERO_BL *)(hp->bh_data);
4527 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4528 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4529 | (get_fileformat(buf) + 1);
4530 #ifdef FEAT_MBYTE
4531 add_b0_fenc(b0p, buf);
4532 #endif
4533 hp->bh_flags |= BH_DIRTY;
4534 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4535 break;
4540 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4542 #define MLCS_MAXL 800 /* max no of lines in chunk */
4543 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4546 * Keep information for finding byte offset of a line, updtytpe may be one of:
4547 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4548 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4549 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4550 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4552 static void
4553 ml_updatechunk(buf, line, len, updtype)
4554 buf_T *buf;
4555 linenr_T line;
4556 long len;
4557 int updtype;
4559 static buf_T *ml_upd_lastbuf = NULL;
4560 static linenr_T ml_upd_lastline;
4561 static linenr_T ml_upd_lastcurline;
4562 static int ml_upd_lastcurix;
4564 linenr_T curline = ml_upd_lastcurline;
4565 int curix = ml_upd_lastcurix;
4566 long size;
4567 chunksize_T *curchnk;
4568 int rest;
4569 bhdr_T *hp;
4570 DATA_BL *dp;
4572 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4573 return;
4574 if (buf->b_ml.ml_chunksize == NULL)
4576 buf->b_ml.ml_chunksize = (chunksize_T *)
4577 alloc((unsigned)sizeof(chunksize_T) * 100);
4578 if (buf->b_ml.ml_chunksize == NULL)
4580 buf->b_ml.ml_usedchunks = -1;
4581 return;
4583 buf->b_ml.ml_numchunks = 100;
4584 buf->b_ml.ml_usedchunks = 1;
4585 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4586 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4589 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4592 * First line in empty buffer from ml_flush_line() -- reset
4594 buf->b_ml.ml_usedchunks = 1;
4595 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4596 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4597 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4598 return;
4602 * Find chunk that our line belongs to, curline will be at start of the
4603 * chunk.
4605 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4606 || updtype != ML_CHNK_ADDLINE)
4608 for (curline = 1, curix = 0;
4609 curix < buf->b_ml.ml_usedchunks - 1
4610 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4611 curix++)
4613 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4616 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4617 && curix < buf->b_ml.ml_usedchunks - 1)
4619 /* Adjust cached curix & curline */
4620 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4621 curix++;
4623 curchnk = buf->b_ml.ml_chunksize + curix;
4625 if (updtype == ML_CHNK_DELLINE)
4626 len = -len;
4627 curchnk->mlcs_totalsize += len;
4628 if (updtype == ML_CHNK_ADDLINE)
4630 curchnk->mlcs_numlines++;
4632 /* May resize here so we don't have to do it in both cases below */
4633 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4635 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4636 buf->b_ml.ml_chunksize = (chunksize_T *)
4637 vim_realloc(buf->b_ml.ml_chunksize,
4638 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4639 if (buf->b_ml.ml_chunksize == NULL)
4641 /* Hmmmm, Give up on offset for this buffer */
4642 buf->b_ml.ml_usedchunks = -1;
4643 return;
4647 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4649 int count; /* number of entries in block */
4650 int idx;
4651 int text_end;
4652 int linecnt;
4654 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4655 buf->b_ml.ml_chunksize + curix,
4656 (buf->b_ml.ml_usedchunks - curix) *
4657 sizeof(chunksize_T));
4658 /* Compute length of first half of lines in the split chunk */
4659 size = 0;
4660 linecnt = 0;
4661 while (curline < buf->b_ml.ml_line_count
4662 && linecnt < MLCS_MINL)
4664 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4666 buf->b_ml.ml_usedchunks = -1;
4667 return;
4669 dp = (DATA_BL *)(hp->bh_data);
4670 count = (long)(buf->b_ml.ml_locked_high) -
4671 (long)(buf->b_ml.ml_locked_low) + 1;
4672 idx = curline - buf->b_ml.ml_locked_low;
4673 curline = buf->b_ml.ml_locked_high + 1;
4674 if (idx == 0)/* first line in block, text at the end */
4675 text_end = dp->db_txt_end;
4676 else
4677 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4678 /* Compute index of last line to use in this MEMLINE */
4679 rest = count - idx;
4680 if (linecnt + rest > MLCS_MINL)
4682 idx += MLCS_MINL - linecnt - 1;
4683 linecnt = MLCS_MINL;
4685 else
4687 idx = count - 1;
4688 linecnt += rest;
4690 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4692 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4693 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4694 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4695 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4696 buf->b_ml.ml_usedchunks++;
4697 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4698 return;
4700 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4701 && curix == buf->b_ml.ml_usedchunks - 1
4702 && buf->b_ml.ml_line_count - line <= 1)
4705 * We are in the last chunk and it is cheap to crate a new one
4706 * after this. Do it now to avoid the loop above later on
4708 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4709 buf->b_ml.ml_usedchunks++;
4710 if (line == buf->b_ml.ml_line_count)
4712 curchnk->mlcs_numlines = 0;
4713 curchnk->mlcs_totalsize = 0;
4715 else
4718 * Line is just prior to last, move count for last
4719 * This is the common case when loading a new file
4721 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4722 if (hp == NULL)
4724 buf->b_ml.ml_usedchunks = -1;
4725 return;
4727 dp = (DATA_BL *)(hp->bh_data);
4728 if (dp->db_line_count == 1)
4729 rest = dp->db_txt_end - dp->db_txt_start;
4730 else
4731 rest =
4732 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4733 - dp->db_txt_start;
4734 curchnk->mlcs_totalsize = rest;
4735 curchnk->mlcs_numlines = 1;
4736 curchnk[-1].mlcs_totalsize -= rest;
4737 curchnk[-1].mlcs_numlines -= 1;
4741 else if (updtype == ML_CHNK_DELLINE)
4743 curchnk->mlcs_numlines--;
4744 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4745 if (curix < (buf->b_ml.ml_usedchunks - 1)
4746 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4747 <= MLCS_MINL)
4749 curix++;
4750 curchnk = buf->b_ml.ml_chunksize + curix;
4752 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4754 buf->b_ml.ml_usedchunks--;
4755 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4756 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4757 return;
4759 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4760 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4761 > MLCS_MINL))
4763 return;
4766 /* Collapse chunks */
4767 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4768 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4769 buf->b_ml.ml_usedchunks--;
4770 if (curix < buf->b_ml.ml_usedchunks)
4772 mch_memmove(buf->b_ml.ml_chunksize + curix,
4773 buf->b_ml.ml_chunksize + curix + 1,
4774 (buf->b_ml.ml_usedchunks - curix) *
4775 sizeof(chunksize_T));
4777 return;
4779 ml_upd_lastbuf = buf;
4780 ml_upd_lastline = line;
4781 ml_upd_lastcurline = curline;
4782 ml_upd_lastcurix = curix;
4786 * Find offset for line or line with offset.
4787 * Find line with offset if "lnum" is 0; return remaining offset in offp
4788 * Find offset of line if "lnum" > 0
4789 * return -1 if information is not available
4791 long
4792 ml_find_line_or_offset(buf, lnum, offp)
4793 buf_T *buf;
4794 linenr_T lnum;
4795 long *offp;
4797 linenr_T curline;
4798 int curix;
4799 long size;
4800 bhdr_T *hp;
4801 DATA_BL *dp;
4802 int count; /* number of entries in block */
4803 int idx;
4804 int start_idx;
4805 int text_end;
4806 long offset;
4807 int len;
4808 int ffdos = (get_fileformat(buf) == EOL_DOS);
4809 int extra = 0;
4811 /* take care of cached line first */
4812 ml_flush_line(curbuf);
4814 if (buf->b_ml.ml_usedchunks == -1
4815 || buf->b_ml.ml_chunksize == NULL
4816 || lnum < 0)
4817 return -1;
4819 if (offp == NULL)
4820 offset = 0;
4821 else
4822 offset = *offp;
4823 if (lnum == 0 && offset <= 0)
4824 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4826 * Find the last chunk before the one containing our line. Last chunk is
4827 * special because it will never qualify
4829 curline = 1;
4830 curix = size = 0;
4831 while (curix < buf->b_ml.ml_usedchunks - 1
4832 && ((lnum != 0
4833 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4834 || (offset != 0
4835 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4836 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4838 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4839 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4840 if (offset && ffdos)
4841 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4842 curix++;
4845 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4847 if (curline > buf->b_ml.ml_line_count
4848 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4849 return -1;
4850 dp = (DATA_BL *)(hp->bh_data);
4851 count = (long)(buf->b_ml.ml_locked_high) -
4852 (long)(buf->b_ml.ml_locked_low) + 1;
4853 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4854 if (idx == 0)/* first line in block, text at the end */
4855 text_end = dp->db_txt_end;
4856 else
4857 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4858 /* Compute index of last line to use in this MEMLINE */
4859 if (lnum != 0)
4861 if (curline + (count - idx) >= lnum)
4862 idx += lnum - curline - 1;
4863 else
4864 idx = count - 1;
4866 else
4868 extra = 0;
4869 while (offset >= size
4870 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4871 + ffdos)
4873 if (ffdos)
4874 size++;
4875 if (idx == count - 1)
4877 extra = 1;
4878 break;
4880 idx++;
4883 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4884 size += len;
4885 if (offset != 0 && size >= offset)
4887 if (size + ffdos == offset)
4888 *offp = 0;
4889 else if (idx == start_idx)
4890 *offp = offset - size + len;
4891 else
4892 *offp = offset - size + len
4893 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4894 curline += idx - start_idx + extra;
4895 if (curline > buf->b_ml.ml_line_count)
4896 return -1; /* exactly one byte beyond the end */
4897 return curline;
4899 curline = buf->b_ml.ml_locked_high + 1;
4902 if (lnum != 0)
4904 /* Count extra CR characters. */
4905 if (ffdos)
4906 size += lnum - 1;
4908 /* Don't count the last line break if 'bin' and 'noeol'. */
4909 if (buf->b_p_bin && !buf->b_p_eol)
4910 size -= ffdos + 1;
4913 return size;
4917 * Goto byte in buffer with offset 'cnt'.
4919 void
4920 goto_byte(cnt)
4921 long cnt;
4923 long boff = cnt;
4924 linenr_T lnum;
4926 ml_flush_line(curbuf); /* cached line may be dirty */
4927 setpcmark();
4928 if (boff)
4929 --boff;
4930 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4931 if (lnum < 1) /* past the end */
4933 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4934 curwin->w_curswant = MAXCOL;
4935 coladvance((colnr_T)MAXCOL);
4937 else
4939 curwin->w_cursor.lnum = lnum;
4940 curwin->w_cursor.col = (colnr_T)boff;
4941 # ifdef FEAT_VIRTUALEDIT
4942 curwin->w_cursor.coladd = 0;
4943 # endif
4944 curwin->w_set_curswant = TRUE;
4946 check_cursor();
4948 # ifdef FEAT_MBYTE
4949 /* Make sure the cursor is on the first byte of a multi-byte char. */
4950 if (has_mbyte)
4951 mb_adjust_cursor();
4952 # endif
4954 #endif