[7.2.326] Win32: $HOME doesn't work when %HOMEPATH% is not defined.
[vim_extended.git] / src / memline.c
blob480e93cf640a9dc53236bf9b9dda5ba50dae87a3
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
10 /* for debugging */
11 /* #define CHECK(c, s) if (c) EMSG(s) */
12 #define CHECK(c, s)
15 * memline.c: Contains the functions for appending, deleting and changing the
16 * text lines. The memfile functions are used to store the information in
17 * blocks of memory, backed up by a file. The structure of the information is
18 * a tree. The root of the tree is a pointer block. The leaves of the tree
19 * are data blocks. In between may be several layers of pointer blocks,
20 * forming branches.
22 * Three types of blocks are used:
23 * - Block nr 0 contains information for recovery
24 * - Pointer blocks contain list of pointers to other blocks.
25 * - Data blocks contain the actual text.
27 * Block nr 0 contains the block0 structure (see below).
29 * Block nr 1 is the first pointer block. It is the root of the tree.
30 * Other pointer blocks are branches.
32 * If a line is too big to fit in a single page, the block containing that
33 * line is made big enough to hold the line. It may span several pages.
34 * Otherwise all blocks are one page.
36 * A data block that was filled when starting to edit a file and was not
37 * changed since then, can have a negative block number. This means that it
38 * has not yet been assigned a place in the file. When recovering, the lines
39 * in this data block can be read from the original file. When the block is
40 * changed (lines appended/deleted/changed) or when it is flushed it gets a
41 * positive number. Use mf_trans_del() to get the new number, before calling
42 * mf_get().
45 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
46 # include "vimio.h" /* for mch_open(), must be before vim.h */
47 #endif
49 #include "vim.h"
51 #ifndef UNIX /* it's in os_unix.h for Unix */
52 # include <time.h>
53 #endif
55 #if defined(SASC) || defined(__amigaos4__)
56 # include <proto/dos.h> /* for Open() and Close() */
57 #endif
59 #ifdef HAVE_ERRNO_H
60 # include <errno.h>
61 #endif
63 typedef struct block0 ZERO_BL; /* contents of the first block */
64 typedef struct pointer_block PTR_BL; /* contents of a pointer block */
65 typedef struct data_block DATA_BL; /* contents of a data block */
66 typedef struct pointer_entry PTR_EN; /* block/line-count pair */
68 #define DATA_ID (('d' << 8) + 'a') /* data block id */
69 #define PTR_ID (('p' << 8) + 't') /* pointer block id */
70 #define BLOCK0_ID0 'b' /* block 0 id 0 */
71 #define BLOCK0_ID1 '0' /* block 0 id 1 */
74 * pointer to a block, used in a pointer block
76 struct pointer_entry
78 blocknr_T pe_bnum; /* block number */
79 linenr_T pe_line_count; /* number of lines in this branch */
80 linenr_T pe_old_lnum; /* lnum for this block (for recovery) */
81 int pe_page_count; /* number of pages in block pe_bnum */
85 * A pointer block contains a list of branches in the tree.
87 struct pointer_block
89 short_u pb_id; /* ID for pointer block: PTR_ID */
90 short_u pb_count; /* number of pointer in this block */
91 short_u pb_count_max; /* maximum value for pb_count */
92 PTR_EN pb_pointer[1]; /* list of pointers to blocks (actually longer)
93 * followed by empty space until end of page */
97 * A data block is a leaf in the tree.
99 * The text of the lines is at the end of the block. The text of the first line
100 * in the block is put at the end, the text of the second line in front of it,
101 * etc. Thus the order of the lines is the opposite of the line number.
103 struct data_block
105 short_u db_id; /* ID for data block: DATA_ID */
106 unsigned db_free; /* free space available */
107 unsigned db_txt_start; /* byte where text starts */
108 unsigned db_txt_end; /* byte just after data block */
109 linenr_T db_line_count; /* number of lines in this block */
110 unsigned db_index[1]; /* index for start of line (actually bigger)
111 * followed by empty space upto db_txt_start
112 * followed by the text in the lines until
113 * end of page */
117 * The low bits of db_index hold the actual index. The topmost bit is
118 * used for the global command to be able to mark a line.
119 * This method is not clean, but otherwise there would be at least one extra
120 * byte used for each line.
121 * The mark has to be in this place to keep it with the correct line when other
122 * lines are inserted or deleted.
124 #define DB_MARKED ((unsigned)1 << ((sizeof(unsigned) * 8) - 1))
125 #define DB_INDEX_MASK (~DB_MARKED)
127 #define INDEX_SIZE (sizeof(unsigned)) /* size of one db_index entry */
128 #define HEADER_SIZE (sizeof(DATA_BL) - INDEX_SIZE) /* size of data block header */
130 #define B0_FNAME_SIZE_ORG 900 /* what it was in older versions */
131 #define B0_FNAME_SIZE 898
132 #define B0_UNAME_SIZE 40
133 #define B0_HNAME_SIZE 40
135 * Restrict the numbers to 32 bits, otherwise most compilers will complain.
136 * This won't detect a 64 bit machine that only swaps a byte in the top 32
137 * bits, but that is crazy anyway.
139 #define B0_MAGIC_LONG 0x30313233L
140 #define B0_MAGIC_INT 0x20212223L
141 #define B0_MAGIC_SHORT 0x10111213L
142 #define B0_MAGIC_CHAR 0x55
145 * Block zero holds all info about the swap file.
147 * NOTE: DEFINITION OF BLOCK 0 SHOULD NOT CHANGE! It would make all existing
148 * swap files unusable!
150 * If size of block0 changes anyway, adjust MIN_SWAP_PAGE_SIZE in vim.h!!
152 * This block is built up of single bytes, to make it portable across
153 * different machines. b0_magic_* is used to check the byte order and size of
154 * variables, because the rest of the swap file is not portable.
156 struct block0
158 char_u b0_id[2]; /* id for block 0: BLOCK0_ID0 and BLOCK0_ID1 */
159 char_u b0_version[10]; /* Vim version string */
160 char_u b0_page_size[4];/* number of bytes per page */
161 char_u b0_mtime[4]; /* last modification time of file */
162 char_u b0_ino[4]; /* inode of b0_fname */
163 char_u b0_pid[4]; /* process id of creator (or 0) */
164 char_u b0_uname[B0_UNAME_SIZE]; /* name of user (uid if no name) */
165 char_u b0_hname[B0_HNAME_SIZE]; /* host name (if it has a name) */
166 char_u b0_fname[B0_FNAME_SIZE_ORG]; /* name of file being edited */
167 long b0_magic_long; /* check for byte order of long */
168 int b0_magic_int; /* check for byte order of int */
169 short b0_magic_short; /* check for byte order of short */
170 char_u b0_magic_char; /* check for last char */
174 * Note: b0_dirty and b0_flags are put at the end of the file name. For very
175 * long file names in older versions of Vim they are invalid.
176 * The 'fileencoding' comes before b0_flags, with a NUL in front. But only
177 * when there is room, for very long file names it's omitted.
179 #define B0_DIRTY 0x55
180 #define b0_dirty b0_fname[B0_FNAME_SIZE_ORG-1]
183 * The b0_flags field is new in Vim 7.0.
185 #define b0_flags b0_fname[B0_FNAME_SIZE_ORG-2]
187 /* The lowest two bits contain the fileformat. Zero means it's not set
188 * (compatible with Vim 6.x), otherwise it's EOL_UNIX + 1, EOL_DOS + 1 or
189 * EOL_MAC + 1. */
190 #define B0_FF_MASK 3
192 /* Swap file is in directory of edited file. Used to find the file from
193 * different mount points. */
194 #define B0_SAME_DIR 4
196 /* The 'fileencoding' is at the end of b0_fname[], with a NUL in front of it.
197 * When empty there is only the NUL. */
198 #define B0_HAS_FENC 8
200 #define STACK_INCR 5 /* nr of entries added to ml_stack at a time */
203 * The line number where the first mark may be is remembered.
204 * If it is 0 there are no marks at all.
205 * (always used for the current buffer only, no buffer change possible while
206 * executing a global command).
208 static linenr_T lowest_marked = 0;
211 * arguments for ml_find_line()
213 #define ML_DELETE 0x11 /* delete line */
214 #define ML_INSERT 0x12 /* insert line */
215 #define ML_FIND 0x13 /* just find the line */
216 #define ML_FLUSH 0x02 /* flush locked block */
217 #define ML_SIMPLE(x) (x & 0x10) /* DEL, INS or FIND */
219 static void ml_upd_block0 __ARGS((buf_T *buf, int set_fname));
220 static void set_b0_fname __ARGS((ZERO_BL *, buf_T *buf));
221 static void set_b0_dir_flag __ARGS((ZERO_BL *b0p, buf_T *buf));
222 #ifdef FEAT_MBYTE
223 static void add_b0_fenc __ARGS((ZERO_BL *b0p, buf_T *buf));
224 #endif
225 static time_t swapfile_info __ARGS((char_u *));
226 static int recov_file_names __ARGS((char_u **, char_u *, int prepend_dot));
227 static int ml_append_int __ARGS((buf_T *, linenr_T, char_u *, colnr_T, int, int));
228 static int ml_delete_int __ARGS((buf_T *, linenr_T, int));
229 static char_u *findswapname __ARGS((buf_T *, char_u **, char_u *));
230 static void ml_flush_line __ARGS((buf_T *));
231 static bhdr_T *ml_new_data __ARGS((memfile_T *, int, int));
232 static bhdr_T *ml_new_ptr __ARGS((memfile_T *));
233 static bhdr_T *ml_find_line __ARGS((buf_T *, linenr_T, int));
234 static int ml_add_stack __ARGS((buf_T *));
235 static void ml_lineadd __ARGS((buf_T *, int));
236 static int b0_magic_wrong __ARGS((ZERO_BL *));
237 #ifdef CHECK_INODE
238 static int fnamecmp_ino __ARGS((char_u *, char_u *, long));
239 #endif
240 static void long_to_char __ARGS((long, char_u *));
241 static long char_to_long __ARGS((char_u *));
242 #if defined(UNIX) || defined(WIN3264)
243 static char_u *make_percent_swname __ARGS((char_u *dir, char_u *name));
244 #endif
245 #ifdef FEAT_BYTEOFF
246 static void ml_updatechunk __ARGS((buf_T *buf, long line, long len, int updtype));
247 #endif
250 * Open a new memline for "buf".
252 * Return FAIL for failure, OK otherwise.
255 ml_open(buf)
256 buf_T *buf;
258 memfile_T *mfp;
259 bhdr_T *hp = NULL;
260 ZERO_BL *b0p;
261 PTR_BL *pp;
262 DATA_BL *dp;
265 * init fields in memline struct
267 buf->b_ml.ml_stack_size = 0; /* no stack yet */
268 buf->b_ml.ml_stack = NULL; /* no stack yet */
269 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
270 buf->b_ml.ml_locked = NULL; /* no cached block */
271 buf->b_ml.ml_line_lnum = 0; /* no cached line */
272 #ifdef FEAT_BYTEOFF
273 buf->b_ml.ml_chunksize = NULL;
274 #endif
277 * When 'updatecount' is non-zero swap file may be opened later.
279 if (p_uc && buf->b_p_swf)
280 buf->b_may_swap = TRUE;
281 else
282 buf->b_may_swap = FALSE;
285 * Open the memfile. No swap file is created yet.
287 mfp = mf_open(NULL, 0);
288 if (mfp == NULL)
289 goto error;
291 buf->b_ml.ml_mfp = mfp;
292 buf->b_ml.ml_flags = ML_EMPTY;
293 buf->b_ml.ml_line_count = 1;
294 #ifdef FEAT_LINEBREAK
295 curwin->w_nrwidth_line_count = 0;
296 #endif
298 #if defined(MSDOS) && !defined(DJGPP)
299 /* for 16 bit MS-DOS create a swapfile now, because we run out of
300 * memory very quickly */
301 if (p_uc != 0)
302 ml_open_file(buf);
303 #endif
306 * fill block0 struct and write page 0
308 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
309 goto error;
310 if (hp->bh_bnum != 0)
312 EMSG(_("E298: Didn't get block nr 0?"));
313 goto error;
315 b0p = (ZERO_BL *)(hp->bh_data);
317 b0p->b0_id[0] = BLOCK0_ID0;
318 b0p->b0_id[1] = BLOCK0_ID1;
319 b0p->b0_magic_long = (long)B0_MAGIC_LONG;
320 b0p->b0_magic_int = (int)B0_MAGIC_INT;
321 b0p->b0_magic_short = (short)B0_MAGIC_SHORT;
322 b0p->b0_magic_char = B0_MAGIC_CHAR;
323 STRNCPY(b0p->b0_version, "VIM ", 4);
324 STRNCPY(b0p->b0_version + 4, Version, 6);
325 long_to_char((long)mfp->mf_page_size, b0p->b0_page_size);
327 #ifdef FEAT_SPELL
328 if (!buf->b_spell)
329 #endif
331 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
332 b0p->b0_flags = get_fileformat(buf) + 1;
333 set_b0_fname(b0p, buf);
334 (void)get_user_name(b0p->b0_uname, B0_UNAME_SIZE);
335 b0p->b0_uname[B0_UNAME_SIZE - 1] = NUL;
336 mch_get_host_name(b0p->b0_hname, B0_HNAME_SIZE);
337 b0p->b0_hname[B0_HNAME_SIZE - 1] = NUL;
338 long_to_char(mch_get_pid(), b0p->b0_pid);
342 * Always sync block number 0 to disk, so we can check the file name in
343 * the swap file in findswapname(). Don't do this for help files though
344 * and spell buffer though.
345 * Only works when there's a swapfile, otherwise it's done when the file
346 * is created.
348 mf_put(mfp, hp, TRUE, FALSE);
349 if (!buf->b_help && !B_SPELL(buf))
350 (void)mf_sync(mfp, 0);
353 * Fill in root pointer block and write page 1.
355 if ((hp = ml_new_ptr(mfp)) == NULL)
356 goto error;
357 if (hp->bh_bnum != 1)
359 EMSG(_("E298: Didn't get block nr 1?"));
360 goto error;
362 pp = (PTR_BL *)(hp->bh_data);
363 pp->pb_count = 1;
364 pp->pb_pointer[0].pe_bnum = 2;
365 pp->pb_pointer[0].pe_page_count = 1;
366 pp->pb_pointer[0].pe_old_lnum = 1;
367 pp->pb_pointer[0].pe_line_count = 1; /* line count after insertion */
368 mf_put(mfp, hp, TRUE, FALSE);
371 * Allocate first data block and create an empty line 1.
373 if ((hp = ml_new_data(mfp, FALSE, 1)) == NULL)
374 goto error;
375 if (hp->bh_bnum != 2)
377 EMSG(_("E298: Didn't get block nr 2?"));
378 goto error;
381 dp = (DATA_BL *)(hp->bh_data);
382 dp->db_index[0] = --dp->db_txt_start; /* at end of block */
383 dp->db_free -= 1 + INDEX_SIZE;
384 dp->db_line_count = 1;
385 *((char_u *)dp + dp->db_txt_start) = NUL; /* empty line */
387 return OK;
389 error:
390 if (mfp != NULL)
392 if (hp)
393 mf_put(mfp, hp, FALSE, FALSE);
394 mf_close(mfp, TRUE); /* will also free(mfp->mf_fname) */
396 buf->b_ml.ml_mfp = NULL;
397 return FAIL;
401 * ml_setname() is called when the file name of "buf" has been changed.
402 * It may rename the swap file.
404 void
405 ml_setname(buf)
406 buf_T *buf;
408 int success = FALSE;
409 memfile_T *mfp;
410 char_u *fname;
411 char_u *dirp;
412 #if defined(MSDOS) || defined(MSWIN)
413 char_u *p;
414 #endif
416 mfp = buf->b_ml.ml_mfp;
417 if (mfp->mf_fd < 0) /* there is no swap file yet */
420 * When 'updatecount' is 0 and 'noswapfile' there is no swap file.
421 * For help files we will make a swap file now.
423 if (p_uc != 0)
424 ml_open_file(buf); /* create a swap file */
425 return;
429 * Try all directories in the 'directory' option.
431 dirp = p_dir;
432 for (;;)
434 if (*dirp == NUL) /* tried all directories, fail */
435 break;
436 fname = findswapname(buf, &dirp, mfp->mf_fname);
437 /* alloc's fname */
438 if (fname == NULL) /* no file name found for this dir */
439 continue;
441 #if defined(MSDOS) || defined(MSWIN)
443 * Set full pathname for swap file now, because a ":!cd dir" may
444 * change directory without us knowing it.
446 p = FullName_save(fname, FALSE);
447 vim_free(fname);
448 fname = p;
449 if (fname == NULL)
450 continue;
451 #endif
452 /* if the file name is the same we don't have to do anything */
453 if (fnamecmp(fname, mfp->mf_fname) == 0)
455 vim_free(fname);
456 success = TRUE;
457 break;
459 /* need to close the swap file before renaming */
460 if (mfp->mf_fd >= 0)
462 close(mfp->mf_fd);
463 mfp->mf_fd = -1;
466 /* try to rename the swap file */
467 if (vim_rename(mfp->mf_fname, fname) == 0)
469 success = TRUE;
470 vim_free(mfp->mf_fname);
471 mfp->mf_fname = fname;
472 vim_free(mfp->mf_ffname);
473 #if defined(MSDOS) || defined(MSWIN)
474 mfp->mf_ffname = NULL; /* mf_fname is full pathname already */
475 #else
476 mf_set_ffname(mfp);
477 #endif
478 ml_upd_block0(buf, FALSE);
479 break;
481 vim_free(fname); /* this fname didn't work, try another */
484 if (mfp->mf_fd == -1) /* need to (re)open the swap file */
486 mfp->mf_fd = mch_open((char *)mfp->mf_fname, O_RDWR | O_EXTRA, 0);
487 if (mfp->mf_fd < 0)
489 /* could not (re)open the swap file, what can we do???? */
490 EMSG(_("E301: Oops, lost the swap file!!!"));
491 return;
493 #ifdef HAVE_FD_CLOEXEC
495 int fdflags = fcntl(mfp->mf_fd, F_GETFD);
496 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
497 fcntl(mfp->mf_fd, F_SETFD, fdflags | FD_CLOEXEC);
499 #endif
501 if (!success)
502 EMSG(_("E302: Could not rename swap file"));
506 * Open a file for the memfile for all buffers that are not readonly or have
507 * been modified.
508 * Used when 'updatecount' changes from zero to non-zero.
510 void
511 ml_open_files()
513 buf_T *buf;
515 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
516 if (!buf->b_p_ro || buf->b_changed)
517 ml_open_file(buf);
521 * Open a swap file for an existing memfile, if there is no swap file yet.
522 * If we are unable to find a file name, mf_fname will be NULL
523 * and the memfile will be in memory only (no recovery possible).
525 void
526 ml_open_file(buf)
527 buf_T *buf;
529 memfile_T *mfp;
530 char_u *fname;
531 char_u *dirp;
533 mfp = buf->b_ml.ml_mfp;
534 if (mfp == NULL || mfp->mf_fd >= 0 || !buf->b_p_swf)
535 return; /* nothing to do */
537 #ifdef FEAT_SPELL
538 /* For a spell buffer use a temp file name. */
539 if (buf->b_spell)
541 fname = vim_tempname('s');
542 if (fname != NULL)
543 (void)mf_open_file(mfp, fname); /* consumes fname! */
544 buf->b_may_swap = FALSE;
545 return;
547 #endif
550 * Try all directories in 'directory' option.
552 dirp = p_dir;
553 for (;;)
555 if (*dirp == NUL)
556 break;
557 /* There is a small chance that between chosing the swap file name and
558 * creating it, another Vim creates the file. In that case the
559 * creation will fail and we will use another directory. */
560 fname = findswapname(buf, &dirp, NULL); /* allocates fname */
561 if (fname == NULL)
562 continue;
563 if (mf_open_file(mfp, fname) == OK) /* consumes fname! */
565 #if defined(MSDOS) || defined(MSWIN) || defined(RISCOS)
567 * set full pathname for swap file now, because a ":!cd dir" may
568 * change directory without us knowing it.
570 mf_fullname(mfp);
571 #endif
572 ml_upd_block0(buf, FALSE);
574 /* Flush block zero, so others can read it */
575 if (mf_sync(mfp, MFS_ZERO) == OK)
577 /* Mark all blocks that should be in the swapfile as dirty.
578 * Needed for when the 'swapfile' option was reset, so that
579 * the swap file was deleted, and then on again. */
580 mf_set_dirty(mfp);
581 break;
583 /* Writing block 0 failed: close the file and try another dir */
584 mf_close_file(buf, FALSE);
588 if (mfp->mf_fname == NULL) /* Failed! */
590 need_wait_return = TRUE; /* call wait_return later */
591 ++no_wait_return;
592 (void)EMSG2(_("E303: Unable to open swap file for \"%s\", recovery impossible"),
593 buf_spname(buf) != NULL
594 ? (char_u *)buf_spname(buf)
595 : buf->b_fname);
596 --no_wait_return;
599 /* don't try to open a swap file again */
600 buf->b_may_swap = FALSE;
604 * If still need to create a swap file, and starting to edit a not-readonly
605 * file, or reading into an existing buffer, create a swap file now.
607 void
608 check_need_swap(newfile)
609 int newfile; /* reading file into new buffer */
611 if (curbuf->b_may_swap && (!curbuf->b_p_ro || !newfile))
612 ml_open_file(curbuf);
616 * Close memline for buffer 'buf'.
617 * If 'del_file' is TRUE, delete the swap file
619 void
620 ml_close(buf, del_file)
621 buf_T *buf;
622 int del_file;
624 if (buf->b_ml.ml_mfp == NULL) /* not open */
625 return;
626 mf_close(buf->b_ml.ml_mfp, del_file); /* close the .swp file */
627 if (buf->b_ml.ml_line_lnum != 0 && (buf->b_ml.ml_flags & ML_LINE_DIRTY))
628 vim_free(buf->b_ml.ml_line_ptr);
629 vim_free(buf->b_ml.ml_stack);
630 #ifdef FEAT_BYTEOFF
631 vim_free(buf->b_ml.ml_chunksize);
632 buf->b_ml.ml_chunksize = NULL;
633 #endif
634 buf->b_ml.ml_mfp = NULL;
636 /* Reset the "recovered" flag, give the ATTENTION prompt the next time
637 * this buffer is loaded. */
638 buf->b_flags &= ~BF_RECOVERED;
642 * Close all existing memlines and memfiles.
643 * Only used when exiting.
644 * When 'del_file' is TRUE, delete the memfiles.
645 * But don't delete files that were ":preserve"d when we are POSIX compatible.
647 void
648 ml_close_all(del_file)
649 int del_file;
651 buf_T *buf;
653 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
654 ml_close(buf, del_file && ((buf->b_flags & BF_PRESERVED) == 0
655 || vim_strchr(p_cpo, CPO_PRESERVE) == NULL));
656 #ifdef TEMPDIRNAMES
657 vim_deltempdir(); /* delete created temp directory */
658 #endif
662 * Close all memfiles for not modified buffers.
663 * Only use just before exiting!
665 void
666 ml_close_notmod()
668 buf_T *buf;
670 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
671 if (!bufIsChanged(buf))
672 ml_close(buf, TRUE); /* close all not-modified buffers */
676 * Update the timestamp in the .swp file.
677 * Used when the file has been written.
679 void
680 ml_timestamp(buf)
681 buf_T *buf;
683 ml_upd_block0(buf, TRUE);
687 * Update the timestamp or the B0_SAME_DIR flag of the .swp file.
689 static void
690 ml_upd_block0(buf, set_fname)
691 buf_T *buf;
692 int set_fname;
694 memfile_T *mfp;
695 bhdr_T *hp;
696 ZERO_BL *b0p;
698 mfp = buf->b_ml.ml_mfp;
699 if (mfp == NULL || (hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
700 return;
701 b0p = (ZERO_BL *)(hp->bh_data);
702 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
703 EMSG(_("E304: ml_upd_block0(): Didn't get block 0??"));
704 else
706 if (set_fname)
707 set_b0_fname(b0p, buf);
708 else
709 set_b0_dir_flag(b0p, buf);
711 mf_put(mfp, hp, TRUE, FALSE);
715 * Write file name and timestamp into block 0 of a swap file.
716 * Also set buf->b_mtime.
717 * Don't use NameBuff[]!!!
719 static void
720 set_b0_fname(b0p, buf)
721 ZERO_BL *b0p;
722 buf_T *buf;
724 struct stat st;
726 if (buf->b_ffname == NULL)
727 b0p->b0_fname[0] = NUL;
728 else
730 #if defined(MSDOS) || defined(MSWIN) || defined(AMIGA) || defined(RISCOS)
731 /* Systems that cannot translate "~user" back into a path: copy the
732 * file name unmodified. Do use slashes instead of backslashes for
733 * portability. */
734 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
735 # ifdef BACKSLASH_IN_FILENAME
736 forward_slash(b0p->b0_fname);
737 # endif
738 #else
739 size_t flen, ulen;
740 char_u uname[B0_UNAME_SIZE];
743 * For a file under the home directory of the current user, we try to
744 * replace the home directory path with "~user". This helps when
745 * editing the same file on different machines over a network.
746 * First replace home dir path with "~/" with home_replace().
747 * Then insert the user name to get "~user/".
749 home_replace(NULL, buf->b_ffname, b0p->b0_fname, B0_FNAME_SIZE, TRUE);
750 if (b0p->b0_fname[0] == '~')
752 flen = STRLEN(b0p->b0_fname);
753 /* If there is no user name or it is too long, don't use "~/" */
754 if (get_user_name(uname, B0_UNAME_SIZE) == FAIL
755 || (ulen = STRLEN(uname)) + flen > B0_FNAME_SIZE - 1)
756 vim_strncpy(b0p->b0_fname, buf->b_ffname, B0_FNAME_SIZE - 1);
757 else
759 mch_memmove(b0p->b0_fname + ulen + 1, b0p->b0_fname + 1, flen);
760 mch_memmove(b0p->b0_fname + 1, uname, ulen);
763 #endif
764 if (mch_stat((char *)buf->b_ffname, &st) >= 0)
766 long_to_char((long)st.st_mtime, b0p->b0_mtime);
767 #ifdef CHECK_INODE
768 long_to_char((long)st.st_ino, b0p->b0_ino);
769 #endif
770 buf_store_time(buf, &st, buf->b_ffname);
771 buf->b_mtime_read = buf->b_mtime;
773 else
775 long_to_char(0L, b0p->b0_mtime);
776 #ifdef CHECK_INODE
777 long_to_char(0L, b0p->b0_ino);
778 #endif
779 buf->b_mtime = 0;
780 buf->b_mtime_read = 0;
781 buf->b_orig_size = 0;
782 buf->b_orig_mode = 0;
786 #ifdef FEAT_MBYTE
787 /* Also add the 'fileencoding' if there is room. */
788 add_b0_fenc(b0p, curbuf);
789 #endif
793 * Update the B0_SAME_DIR flag of the swap file. It's set if the file and the
794 * swapfile for "buf" are in the same directory.
795 * This is fail safe: if we are not sure the directories are equal the flag is
796 * not set.
798 static void
799 set_b0_dir_flag(b0p, buf)
800 ZERO_BL *b0p;
801 buf_T *buf;
803 if (same_directory(buf->b_ml.ml_mfp->mf_fname, buf->b_ffname))
804 b0p->b0_flags |= B0_SAME_DIR;
805 else
806 b0p->b0_flags &= ~B0_SAME_DIR;
809 #ifdef FEAT_MBYTE
811 * When there is room, add the 'fileencoding' to block zero.
813 static void
814 add_b0_fenc(b0p, buf)
815 ZERO_BL *b0p;
816 buf_T *buf;
818 int n;
820 n = (int)STRLEN(buf->b_p_fenc);
821 if (STRLEN(b0p->b0_fname) + n + 1 > B0_FNAME_SIZE)
822 b0p->b0_flags &= ~B0_HAS_FENC;
823 else
825 mch_memmove((char *)b0p->b0_fname + B0_FNAME_SIZE - n,
826 (char *)buf->b_p_fenc, (size_t)n);
827 *(b0p->b0_fname + B0_FNAME_SIZE - n - 1) = NUL;
828 b0p->b0_flags |= B0_HAS_FENC;
831 #endif
835 * try to recover curbuf from the .swp file
837 void
838 ml_recover()
840 buf_T *buf = NULL;
841 memfile_T *mfp = NULL;
842 char_u *fname;
843 bhdr_T *hp = NULL;
844 ZERO_BL *b0p;
845 int b0_ff;
846 char_u *b0_fenc = NULL;
847 PTR_BL *pp;
848 DATA_BL *dp;
849 infoptr_T *ip;
850 blocknr_T bnum;
851 int page_count;
852 struct stat org_stat, swp_stat;
853 int len;
854 int directly;
855 linenr_T lnum;
856 char_u *p;
857 int i;
858 long error;
859 int cannot_open;
860 linenr_T line_count;
861 int has_error;
862 int idx;
863 int top;
864 int txt_start;
865 off_t size;
866 int called_from_main;
867 int serious_error = TRUE;
868 long mtime;
869 int attr;
871 recoverymode = TRUE;
872 called_from_main = (curbuf->b_ml.ml_mfp == NULL);
873 attr = hl_attr(HLF_E);
876 * If the file name ends in ".s[uvw][a-z]" we assume this is the swap file.
877 * Otherwise a search is done to find the swap file(s).
879 fname = curbuf->b_fname;
880 if (fname == NULL) /* When there is no file name */
881 fname = (char_u *)"";
882 len = (int)STRLEN(fname);
883 if (len >= 4 &&
884 #if defined(VMS) || defined(RISCOS)
885 STRNICMP(fname + len - 4, "_s" , 2)
886 #else
887 STRNICMP(fname + len - 4, ".s" , 2)
888 #endif
889 == 0
890 && vim_strchr((char_u *)"UVWuvw", fname[len - 2]) != NULL
891 && ASCII_ISALPHA(fname[len - 1]))
893 directly = TRUE;
894 fname = vim_strsave(fname); /* make a copy for mf_open() */
896 else
898 directly = FALSE;
900 /* count the number of matching swap files */
901 len = recover_names(&fname, FALSE, 0);
902 if (len == 0) /* no swap files found */
904 EMSG2(_("E305: No swap file found for %s"), fname);
905 goto theend;
907 if (len == 1) /* one swap file found, use it */
908 i = 1;
909 else /* several swap files found, choose */
911 /* list the names of the swap files */
912 (void)recover_names(&fname, TRUE, 0);
913 msg_putchar('\n');
914 MSG_PUTS(_("Enter number of swap file to use (0 to quit): "));
915 i = get_number(FALSE, NULL);
916 if (i < 1 || i > len)
917 goto theend;
919 /* get the swap file name that will be used */
920 (void)recover_names(&fname, FALSE, i);
922 if (fname == NULL)
923 goto theend; /* out of memory */
925 /* When called from main() still need to initialize storage structure */
926 if (called_from_main && ml_open(curbuf) == FAIL)
927 getout(1);
930 * allocate a buffer structure (only the memline in it is really used)
932 buf = (buf_T *)alloc((unsigned)sizeof(buf_T));
933 if (buf == NULL)
935 vim_free(fname);
936 goto theend;
940 * init fields in memline struct
942 buf->b_ml.ml_stack_size = 0; /* no stack yet */
943 buf->b_ml.ml_stack = NULL; /* no stack yet */
944 buf->b_ml.ml_stack_top = 0; /* nothing in the stack */
945 buf->b_ml.ml_line_lnum = 0; /* no cached line */
946 buf->b_ml.ml_locked = NULL; /* no locked block */
947 buf->b_ml.ml_flags = 0;
950 * open the memfile from the old swap file
952 p = vim_strsave(fname); /* save fname for the message
953 (mf_open() may free fname) */
954 mfp = mf_open(fname, O_RDONLY); /* consumes fname! */
955 if (mfp == NULL || mfp->mf_fd < 0)
957 if (p != NULL)
959 EMSG2(_("E306: Cannot open %s"), p);
960 vim_free(p);
962 goto theend;
964 vim_free(p);
965 buf->b_ml.ml_mfp = mfp;
968 * The page size set in mf_open() might be different from the page size
969 * used in the swap file, we must get it from block 0. But to read block
970 * 0 we need a page size. Use the minimal size for block 0 here, it will
971 * be set to the real value below.
973 mfp->mf_page_size = MIN_SWAP_PAGE_SIZE;
976 * try to read block 0
978 if ((hp = mf_get(mfp, (blocknr_T)0, 1)) == NULL)
980 msg_start();
981 MSG_PUTS_ATTR(_("Unable to read block 0 from "), attr | MSG_HIST);
982 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
983 MSG_PUTS_ATTR(
984 _("\nMaybe no changes were made or Vim did not update the swap file."),
985 attr | MSG_HIST);
986 msg_end();
987 goto theend;
989 b0p = (ZERO_BL *)(hp->bh_data);
990 if (STRNCMP(b0p->b0_version, "VIM 3.0", 7) == 0)
992 msg_start();
993 msg_outtrans_attr(mfp->mf_fname, MSG_HIST);
994 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
995 MSG_HIST);
996 MSG_PUTS_ATTR(_("Use Vim version 3.0.\n"), MSG_HIST);
997 msg_end();
998 goto theend;
1000 if (b0p->b0_id[0] != BLOCK0_ID0 || b0p->b0_id[1] != BLOCK0_ID1)
1002 EMSG2(_("E307: %s does not look like a Vim swap file"), mfp->mf_fname);
1003 goto theend;
1005 if (b0_magic_wrong(b0p))
1007 msg_start();
1008 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1009 #if defined(MSDOS) || defined(MSWIN)
1010 if (STRNCMP(b0p->b0_hname, "PC ", 3) == 0)
1011 MSG_PUTS_ATTR(_(" cannot be used with this version of Vim.\n"),
1012 attr | MSG_HIST);
1013 else
1014 #endif
1015 MSG_PUTS_ATTR(_(" cannot be used on this computer.\n"),
1016 attr | MSG_HIST);
1017 MSG_PUTS_ATTR(_("The file was created on "), attr | MSG_HIST);
1018 /* avoid going past the end of a currupted hostname */
1019 b0p->b0_fname[0] = NUL;
1020 MSG_PUTS_ATTR(b0p->b0_hname, attr | MSG_HIST);
1021 MSG_PUTS_ATTR(_(",\nor the file has been damaged."), attr | MSG_HIST);
1022 msg_end();
1023 goto theend;
1027 * If we guessed the wrong page size, we have to recalculate the
1028 * highest block number in the file.
1030 if (mfp->mf_page_size != (unsigned)char_to_long(b0p->b0_page_size))
1032 unsigned previous_page_size = mfp->mf_page_size;
1034 mf_new_page_size(mfp, (unsigned)char_to_long(b0p->b0_page_size));
1035 if (mfp->mf_page_size < previous_page_size)
1037 msg_start();
1038 msg_outtrans_attr(mfp->mf_fname, attr | MSG_HIST);
1039 MSG_PUTS_ATTR(_(" has been damaged (page size is smaller than minimum value).\n"),
1040 attr | MSG_HIST);
1041 msg_end();
1042 goto theend;
1044 if ((size = lseek(mfp->mf_fd, (off_t)0L, SEEK_END)) <= 0)
1045 mfp->mf_blocknr_max = 0; /* no file or empty file */
1046 else
1047 mfp->mf_blocknr_max = (blocknr_T)(size / mfp->mf_page_size);
1048 mfp->mf_infile_count = mfp->mf_blocknr_max;
1050 /* need to reallocate the memory used to store the data */
1051 p = alloc(mfp->mf_page_size);
1052 if (p == NULL)
1053 goto theend;
1054 mch_memmove(p, hp->bh_data, previous_page_size);
1055 vim_free(hp->bh_data);
1056 hp->bh_data = p;
1057 b0p = (ZERO_BL *)(hp->bh_data);
1061 * If .swp file name given directly, use name from swap file for buffer.
1063 if (directly)
1065 expand_env(b0p->b0_fname, NameBuff, MAXPATHL);
1066 if (setfname(curbuf, NameBuff, NULL, TRUE) == FAIL)
1067 goto theend;
1070 home_replace(NULL, mfp->mf_fname, NameBuff, MAXPATHL, TRUE);
1071 smsg((char_u *)_("Using swap file \"%s\""), NameBuff);
1073 if (buf_spname(curbuf) != NULL)
1074 STRCPY(NameBuff, buf_spname(curbuf));
1075 else
1076 home_replace(NULL, curbuf->b_ffname, NameBuff, MAXPATHL, TRUE);
1077 smsg((char_u *)_("Original file \"%s\""), NameBuff);
1078 msg_putchar('\n');
1081 * check date of swap file and original file
1083 mtime = char_to_long(b0p->b0_mtime);
1084 if (curbuf->b_ffname != NULL
1085 && mch_stat((char *)curbuf->b_ffname, &org_stat) != -1
1086 && ((mch_stat((char *)mfp->mf_fname, &swp_stat) != -1
1087 && org_stat.st_mtime > swp_stat.st_mtime)
1088 || org_stat.st_mtime != mtime))
1090 EMSG(_("E308: Warning: Original file may have been changed"));
1092 out_flush();
1094 /* Get the 'fileformat' and 'fileencoding' from block zero. */
1095 b0_ff = (b0p->b0_flags & B0_FF_MASK);
1096 if (b0p->b0_flags & B0_HAS_FENC)
1098 for (p = b0p->b0_fname + B0_FNAME_SIZE;
1099 p > b0p->b0_fname && p[-1] != NUL; --p)
1101 b0_fenc = vim_strnsave(p, (int)(b0p->b0_fname + B0_FNAME_SIZE - p));
1104 mf_put(mfp, hp, FALSE, FALSE); /* release block 0 */
1105 hp = NULL;
1108 * Now that we are sure that the file is going to be recovered, clear the
1109 * contents of the current buffer.
1111 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1112 ml_delete((linenr_T)1, FALSE);
1115 * Try reading the original file to obtain the values of 'fileformat',
1116 * 'fileencoding', etc. Ignore errors. The text itself is not used.
1118 if (curbuf->b_ffname != NULL)
1120 (void)readfile(curbuf->b_ffname, NULL, (linenr_T)0,
1121 (linenr_T)0, (linenr_T)MAXLNUM, NULL, READ_NEW);
1122 while (!(curbuf->b_ml.ml_flags & ML_EMPTY))
1123 ml_delete((linenr_T)1, FALSE);
1126 /* Use the 'fileformat' and 'fileencoding' as stored in the swap file. */
1127 if (b0_ff != 0)
1128 set_fileformat(b0_ff - 1, OPT_LOCAL);
1129 if (b0_fenc != NULL)
1131 set_option_value((char_u *)"fenc", 0L, b0_fenc, OPT_LOCAL);
1132 vim_free(b0_fenc);
1134 unchanged(curbuf, TRUE);
1136 bnum = 1; /* start with block 1 */
1137 page_count = 1; /* which is 1 page */
1138 lnum = 0; /* append after line 0 in curbuf */
1139 line_count = 0;
1140 idx = 0; /* start with first index in block 1 */
1141 error = 0;
1142 buf->b_ml.ml_stack_top = 0;
1143 buf->b_ml.ml_stack = NULL;
1144 buf->b_ml.ml_stack_size = 0; /* no stack yet */
1146 if (curbuf->b_ffname == NULL)
1147 cannot_open = TRUE;
1148 else
1149 cannot_open = FALSE;
1151 serious_error = FALSE;
1152 for ( ; !got_int; line_breakcheck())
1154 if (hp != NULL)
1155 mf_put(mfp, hp, FALSE, FALSE); /* release previous block */
1158 * get block
1160 if ((hp = mf_get(mfp, (blocknr_T)bnum, page_count)) == NULL)
1162 if (bnum == 1)
1164 EMSG2(_("E309: Unable to read block 1 from %s"), mfp->mf_fname);
1165 goto theend;
1167 ++error;
1168 ml_append(lnum++, (char_u *)_("???MANY LINES MISSING"),
1169 (colnr_T)0, TRUE);
1171 else /* there is a block */
1173 pp = (PTR_BL *)(hp->bh_data);
1174 if (pp->pb_id == PTR_ID) /* it is a pointer block */
1176 /* check line count when using pointer block first time */
1177 if (idx == 0 && line_count != 0)
1179 for (i = 0; i < (int)pp->pb_count; ++i)
1180 line_count -= pp->pb_pointer[i].pe_line_count;
1181 if (line_count != 0)
1183 ++error;
1184 ml_append(lnum++, (char_u *)_("???LINE COUNT WRONG"),
1185 (colnr_T)0, TRUE);
1189 if (pp->pb_count == 0)
1191 ml_append(lnum++, (char_u *)_("???EMPTY BLOCK"),
1192 (colnr_T)0, TRUE);
1193 ++error;
1195 else if (idx < (int)pp->pb_count) /* go a block deeper */
1197 if (pp->pb_pointer[idx].pe_bnum < 0)
1200 * Data block with negative block number.
1201 * Try to read lines from the original file.
1202 * This is slow, but it works.
1204 if (!cannot_open)
1206 line_count = pp->pb_pointer[idx].pe_line_count;
1207 if (readfile(curbuf->b_ffname, NULL, lnum,
1208 pp->pb_pointer[idx].pe_old_lnum - 1,
1209 line_count, NULL, 0) == FAIL)
1210 cannot_open = TRUE;
1211 else
1212 lnum += line_count;
1214 if (cannot_open)
1216 ++error;
1217 ml_append(lnum++, (char_u *)_("???LINES MISSING"),
1218 (colnr_T)0, TRUE);
1220 ++idx; /* get same block again for next index */
1221 continue;
1225 * going one block deeper in the tree
1227 if ((top = ml_add_stack(buf)) < 0) /* new entry in stack */
1229 ++error;
1230 break; /* out of memory */
1232 ip = &(buf->b_ml.ml_stack[top]);
1233 ip->ip_bnum = bnum;
1234 ip->ip_index = idx;
1236 bnum = pp->pb_pointer[idx].pe_bnum;
1237 line_count = pp->pb_pointer[idx].pe_line_count;
1238 page_count = pp->pb_pointer[idx].pe_page_count;
1239 continue;
1242 else /* not a pointer block */
1244 dp = (DATA_BL *)(hp->bh_data);
1245 if (dp->db_id != DATA_ID) /* block id wrong */
1247 if (bnum == 1)
1249 EMSG2(_("E310: Block 1 ID wrong (%s not a .swp file?)"),
1250 mfp->mf_fname);
1251 goto theend;
1253 ++error;
1254 ml_append(lnum++, (char_u *)_("???BLOCK MISSING"),
1255 (colnr_T)0, TRUE);
1257 else
1260 * it is a data block
1261 * Append all the lines in this block
1263 has_error = FALSE;
1265 * check length of block
1266 * if wrong, use length in pointer block
1268 if (page_count * mfp->mf_page_size != dp->db_txt_end)
1270 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may be messed up"),
1271 (colnr_T)0, TRUE);
1272 ++error;
1273 has_error = TRUE;
1274 dp->db_txt_end = page_count * mfp->mf_page_size;
1277 /* make sure there is a NUL at the end of the block */
1278 *((char_u *)dp + dp->db_txt_end - 1) = NUL;
1281 * check number of lines in block
1282 * if wrong, use count in data block
1284 if (line_count != dp->db_line_count)
1286 ml_append(lnum++, (char_u *)_("??? from here until ???END lines may have been inserted/deleted"),
1287 (colnr_T)0, TRUE);
1288 ++error;
1289 has_error = TRUE;
1292 for (i = 0; i < dp->db_line_count; ++i)
1294 txt_start = (dp->db_index[i] & DB_INDEX_MASK);
1295 if (txt_start <= (int)HEADER_SIZE
1296 || txt_start >= (int)dp->db_txt_end)
1298 p = (char_u *)"???";
1299 ++error;
1301 else
1302 p = (char_u *)dp + txt_start;
1303 ml_append(lnum++, p, (colnr_T)0, TRUE);
1305 if (has_error)
1306 ml_append(lnum++, (char_u *)_("???END"),
1307 (colnr_T)0, TRUE);
1312 if (buf->b_ml.ml_stack_top == 0) /* finished */
1313 break;
1316 * go one block up in the tree
1318 ip = &(buf->b_ml.ml_stack[--(buf->b_ml.ml_stack_top)]);
1319 bnum = ip->ip_bnum;
1320 idx = ip->ip_index + 1; /* go to next index */
1321 page_count = 1;
1325 * The dummy line from the empty buffer will now be after the last line in
1326 * the buffer. Delete it.
1328 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
1329 curbuf->b_flags |= BF_RECOVERED;
1331 recoverymode = FALSE;
1332 if (got_int)
1333 EMSG(_("E311: Recovery Interrupted"));
1334 else if (error)
1336 ++no_wait_return;
1337 MSG(">>>>>>>>>>>>>");
1338 EMSG(_("E312: Errors detected while recovering; look for lines starting with ???"));
1339 --no_wait_return;
1340 MSG(_("See \":help E312\" for more information."));
1341 MSG(">>>>>>>>>>>>>");
1343 else
1345 MSG(_("Recovery completed. You should check if everything is OK."));
1346 MSG_PUTS(_("\n(You might want to write out this file under another name\n"));
1347 MSG_PUTS(_("and run diff with the original file to check for changes)\n"));
1348 MSG_PUTS(_("Delete the .swp file afterwards.\n\n"));
1349 cmdline_row = msg_row;
1351 redraw_curbuf_later(NOT_VALID);
1353 theend:
1354 recoverymode = FALSE;
1355 if (mfp != NULL)
1357 if (hp != NULL)
1358 mf_put(mfp, hp, FALSE, FALSE);
1359 mf_close(mfp, FALSE); /* will also vim_free(mfp->mf_fname) */
1361 if (buf != NULL)
1363 vim_free(buf->b_ml.ml_stack);
1364 vim_free(buf);
1366 if (serious_error && called_from_main)
1367 ml_close(curbuf, TRUE);
1368 #ifdef FEAT_AUTOCMD
1369 else
1371 apply_autocmds(EVENT_BUFREADPOST, NULL, curbuf->b_fname, FALSE, curbuf);
1372 apply_autocmds(EVENT_BUFWINENTER, NULL, curbuf->b_fname, FALSE, curbuf);
1374 #endif
1375 return;
1379 * Find the names of swap files in current directory and the directory given
1380 * with the 'directory' option.
1382 * Used to:
1383 * - list the swap files for "vim -r"
1384 * - count the number of swap files when recovering
1385 * - list the swap files when recovering
1386 * - find the name of the n'th swap file when recovering
1389 recover_names(fname, list, nr)
1390 char_u **fname; /* base for swap file name */
1391 int list; /* when TRUE, list the swap file names */
1392 int nr; /* when non-zero, return nr'th swap file name */
1394 int num_names;
1395 char_u *(names[6]);
1396 char_u *tail;
1397 char_u *p;
1398 int num_files;
1399 int file_count = 0;
1400 char_u **files;
1401 int i;
1402 char_u *dirp;
1403 char_u *dir_name;
1405 if (list)
1407 /* use msg() to start the scrolling properly */
1408 msg((char_u *)_("Swap files found:"));
1409 msg_putchar('\n');
1413 * Do the loop for every directory in 'directory'.
1414 * First allocate some memory to put the directory name in.
1416 dir_name = alloc((unsigned)STRLEN(p_dir) + 1);
1417 dirp = p_dir;
1418 while (dir_name != NULL && *dirp)
1421 * Isolate a directory name from *dirp and put it in dir_name (we know
1422 * it is large enough, so use 31000 for length).
1423 * Advance dirp to next directory name.
1425 (void)copy_option_part(&dirp, dir_name, 31000, ",");
1427 if (dir_name[0] == '.' && dir_name[1] == NUL) /* check current dir */
1429 if (fname == NULL || *fname == NULL)
1431 #ifdef VMS
1432 names[0] = vim_strsave((char_u *)"*_sw%");
1433 #else
1434 # ifdef RISCOS
1435 names[0] = vim_strsave((char_u *)"*_sw#");
1436 # else
1437 names[0] = vim_strsave((char_u *)"*.sw?");
1438 # endif
1439 #endif
1440 #if defined(UNIX) || defined(WIN3264)
1441 /* For Unix names starting with a dot are special. MS-Windows
1442 * supports this too, on some file systems. */
1443 names[1] = vim_strsave((char_u *)".*.sw?");
1444 names[2] = vim_strsave((char_u *)".sw?");
1445 num_names = 3;
1446 #else
1447 # ifdef VMS
1448 names[1] = vim_strsave((char_u *)".*_sw%");
1449 num_names = 2;
1450 # else
1451 num_names = 1;
1452 # endif
1453 #endif
1455 else
1456 num_names = recov_file_names(names, *fname, TRUE);
1458 else /* check directory dir_name */
1460 if (fname == NULL || *fname == NULL)
1462 #ifdef VMS
1463 names[0] = concat_fnames(dir_name, (char_u *)"*_sw%", TRUE);
1464 #else
1465 # ifdef RISCOS
1466 names[0] = concat_fnames(dir_name, (char_u *)"*_sw#", TRUE);
1467 # else
1468 names[0] = concat_fnames(dir_name, (char_u *)"*.sw?", TRUE);
1469 # endif
1470 #endif
1471 #if defined(UNIX) || defined(WIN3264)
1472 /* For Unix names starting with a dot are special. MS-Windows
1473 * supports this too, on some file systems. */
1474 names[1] = concat_fnames(dir_name, (char_u *)".*.sw?", TRUE);
1475 names[2] = concat_fnames(dir_name, (char_u *)".sw?", TRUE);
1476 num_names = 3;
1477 #else
1478 # ifdef VMS
1479 names[1] = concat_fnames(dir_name, (char_u *)".*_sw%", TRUE);
1480 num_names = 2;
1481 # else
1482 num_names = 1;
1483 # endif
1484 #endif
1486 else
1488 #if defined(UNIX) || defined(WIN3264)
1489 p = dir_name + STRLEN(dir_name);
1490 if (after_pathsep(dir_name, p) && p[-1] == p[-2])
1492 /* Ends with '//', Use Full path for swap name */
1493 tail = make_percent_swname(dir_name, *fname);
1495 else
1496 #endif
1498 tail = gettail(*fname);
1499 tail = concat_fnames(dir_name, tail, TRUE);
1501 if (tail == NULL)
1502 num_names = 0;
1503 else
1505 num_names = recov_file_names(names, tail, FALSE);
1506 vim_free(tail);
1511 /* check for out-of-memory */
1512 for (i = 0; i < num_names; ++i)
1514 if (names[i] == NULL)
1516 for (i = 0; i < num_names; ++i)
1517 vim_free(names[i]);
1518 num_names = 0;
1521 if (num_names == 0)
1522 num_files = 0;
1523 else if (expand_wildcards(num_names, names, &num_files, &files,
1524 EW_KEEPALL|EW_FILE|EW_SILENT) == FAIL)
1525 num_files = 0;
1528 * When no swap file found, wildcard expansion might have failed (e.g.
1529 * not able to execute the shell).
1530 * Try finding a swap file by simply adding ".swp" to the file name.
1532 if (*dirp == NUL && file_count + num_files == 0
1533 && fname != NULL && *fname != NULL)
1535 struct stat st;
1536 char_u *swapname;
1538 #if defined(VMS) || defined(RISCOS)
1539 swapname = modname(*fname, (char_u *)"_swp", FALSE);
1540 #else
1541 swapname = modname(*fname, (char_u *)".swp", TRUE);
1542 #endif
1543 if (swapname != NULL)
1545 if (mch_stat((char *)swapname, &st) != -1) /* It exists! */
1547 files = (char_u **)alloc((unsigned)sizeof(char_u *));
1548 if (files != NULL)
1550 files[0] = swapname;
1551 swapname = NULL;
1552 num_files = 1;
1555 vim_free(swapname);
1560 * remove swapfile name of the current buffer, it must be ignored
1562 if (curbuf->b_ml.ml_mfp != NULL
1563 && (p = curbuf->b_ml.ml_mfp->mf_fname) != NULL)
1565 for (i = 0; i < num_files; ++i)
1566 if (fullpathcmp(p, files[i], TRUE) & FPC_SAME)
1568 /* Remove the name from files[i]. Move further entries
1569 * down. When the array becomes empty free it here, since
1570 * FreeWild() won't be called below. */
1571 vim_free(files[i]);
1572 if (--num_files == 0)
1573 vim_free(files);
1574 else
1575 for ( ; i < num_files; ++i)
1576 files[i] = files[i + 1];
1579 if (nr > 0)
1581 file_count += num_files;
1582 if (nr <= file_count)
1584 *fname = vim_strsave(files[nr - 1 + num_files - file_count]);
1585 dirp = (char_u *)""; /* stop searching */
1588 else if (list)
1590 if (dir_name[0] == '.' && dir_name[1] == NUL)
1592 if (fname == NULL || *fname == NULL)
1593 MSG_PUTS(_(" In current directory:\n"));
1594 else
1595 MSG_PUTS(_(" Using specified name:\n"));
1597 else
1599 MSG_PUTS(_(" In directory "));
1600 msg_home_replace(dir_name);
1601 MSG_PUTS(":\n");
1604 if (num_files)
1606 for (i = 0; i < num_files; ++i)
1608 /* print the swap file name */
1609 msg_outnum((long)++file_count);
1610 MSG_PUTS(". ");
1611 msg_puts(gettail(files[i]));
1612 msg_putchar('\n');
1613 (void)swapfile_info(files[i]);
1616 else
1617 MSG_PUTS(_(" -- none --\n"));
1618 out_flush();
1620 else
1621 file_count += num_files;
1623 for (i = 0; i < num_names; ++i)
1624 vim_free(names[i]);
1625 if (num_files > 0)
1626 FreeWild(num_files, files);
1628 vim_free(dir_name);
1629 return file_count;
1632 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
1634 * Append the full path to name with path separators made into percent
1635 * signs, to dir. An unnamed buffer is handled as "" (<currentdir>/"")
1637 static char_u *
1638 make_percent_swname(dir, name)
1639 char_u *dir;
1640 char_u *name;
1642 char_u *d, *s, *f;
1644 f = fix_fname(name != NULL ? name : (char_u *) "");
1645 d = NULL;
1646 if (f != NULL)
1648 s = alloc((unsigned)(STRLEN(f) + 1));
1649 if (s != NULL)
1651 STRCPY(s, f);
1652 for (d = s; *d != NUL; mb_ptr_adv(d))
1653 if (vim_ispathsep(*d))
1654 *d = '%';
1655 d = concat_fnames(dir, s, TRUE);
1656 vim_free(s);
1658 vim_free(f);
1660 return d;
1662 #endif
1664 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
1665 static int process_still_running;
1666 #endif
1669 * Give information about an existing swap file.
1670 * Returns timestamp (0 when unknown).
1672 static time_t
1673 swapfile_info(fname)
1674 char_u *fname;
1676 struct stat st;
1677 int fd;
1678 struct block0 b0;
1679 time_t x = (time_t)0;
1680 char *p;
1681 #ifdef UNIX
1682 char_u uname[B0_UNAME_SIZE];
1683 #endif
1685 /* print the swap file date */
1686 if (mch_stat((char *)fname, &st) != -1)
1688 #ifdef UNIX
1689 /* print name of owner of the file */
1690 if (mch_get_uname(st.st_uid, uname, B0_UNAME_SIZE) == OK)
1692 MSG_PUTS(_(" owned by: "));
1693 msg_outtrans(uname);
1694 MSG_PUTS(_(" dated: "));
1696 else
1697 #endif
1698 MSG_PUTS(_(" dated: "));
1699 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
1700 p = ctime(&x); /* includes '\n' */
1701 if (p == NULL)
1702 MSG_PUTS("(invalid)\n");
1703 else
1704 MSG_PUTS(p);
1708 * print the original file name
1710 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
1711 if (fd >= 0)
1713 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
1715 if (STRNCMP(b0.b0_version, "VIM 3.0", 7) == 0)
1717 MSG_PUTS(_(" [from Vim version 3.0]"));
1719 else if (b0.b0_id[0] != BLOCK0_ID0 || b0.b0_id[1] != BLOCK0_ID1)
1721 MSG_PUTS(_(" [does not look like a Vim swap file]"));
1723 else
1725 MSG_PUTS(_(" file name: "));
1726 if (b0.b0_fname[0] == NUL)
1727 MSG_PUTS(_("[No Name]"));
1728 else
1729 msg_outtrans(b0.b0_fname);
1731 MSG_PUTS(_("\n modified: "));
1732 MSG_PUTS(b0.b0_dirty ? _("YES") : _("no"));
1734 if (*(b0.b0_uname) != NUL)
1736 MSG_PUTS(_("\n user name: "));
1737 msg_outtrans(b0.b0_uname);
1740 if (*(b0.b0_hname) != NUL)
1742 if (*(b0.b0_uname) != NUL)
1743 MSG_PUTS(_(" host name: "));
1744 else
1745 MSG_PUTS(_("\n host name: "));
1746 msg_outtrans(b0.b0_hname);
1749 if (char_to_long(b0.b0_pid) != 0L)
1751 MSG_PUTS(_("\n process ID: "));
1752 msg_outnum(char_to_long(b0.b0_pid));
1753 #if defined(UNIX) || defined(__EMX__)
1754 /* EMX kill() not working correctly, it seems */
1755 if (kill((pid_t)char_to_long(b0.b0_pid), 0) == 0)
1757 MSG_PUTS(_(" (still running)"));
1758 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1759 process_still_running = TRUE;
1760 # endif
1762 #endif
1765 if (b0_magic_wrong(&b0))
1767 #if defined(MSDOS) || defined(MSWIN)
1768 if (STRNCMP(b0.b0_hname, "PC ", 3) == 0)
1769 MSG_PUTS(_("\n [not usable with this version of Vim]"));
1770 else
1771 #endif
1772 MSG_PUTS(_("\n [not usable on this computer]"));
1776 else
1777 MSG_PUTS(_(" [cannot be read]"));
1778 close(fd);
1780 else
1781 MSG_PUTS(_(" [cannot be opened]"));
1782 msg_putchar('\n');
1784 return x;
1787 static int
1788 recov_file_names(names, path, prepend_dot)
1789 char_u **names;
1790 char_u *path;
1791 int prepend_dot;
1793 int num_names;
1795 #ifdef SHORT_FNAME
1797 * (MS-DOS) always short names
1799 names[0] = modname(path, (char_u *)".sw?", FALSE);
1800 num_names = 1;
1801 #else /* !SHORT_FNAME */
1803 * (Win32 and Win64) never short names, but do prepend a dot.
1804 * (Not MS-DOS or Win32 or Win64) maybe short name, maybe not: Try both.
1805 * Only use the short name if it is different.
1807 char_u *p;
1808 int i;
1809 # ifndef WIN3264
1810 int shortname = curbuf->b_shortname;
1812 curbuf->b_shortname = FALSE;
1813 # endif
1815 num_names = 0;
1818 * May also add the file name with a dot prepended, for swap file in same
1819 * dir as original file.
1821 if (prepend_dot)
1823 names[num_names] = modname(path, (char_u *)".sw?", TRUE);
1824 if (names[num_names] == NULL)
1825 goto end;
1826 ++num_names;
1830 * Form the normal swap file name pattern by appending ".sw?".
1832 #ifdef VMS
1833 names[num_names] = concat_fnames(path, (char_u *)"_sw%", FALSE);
1834 #else
1835 # ifdef RISCOS
1836 names[num_names] = concat_fnames(path, (char_u *)"_sw#", FALSE);
1837 # else
1838 names[num_names] = concat_fnames(path, (char_u *)".sw?", FALSE);
1839 # endif
1840 #endif
1841 if (names[num_names] == NULL)
1842 goto end;
1843 if (num_names >= 1) /* check if we have the same name twice */
1845 p = names[num_names - 1];
1846 i = (int)STRLEN(names[num_names - 1]) - (int)STRLEN(names[num_names]);
1847 if (i > 0)
1848 p += i; /* file name has been expanded to full path */
1850 if (STRCMP(p, names[num_names]) != 0)
1851 ++num_names;
1852 else
1853 vim_free(names[num_names]);
1855 else
1856 ++num_names;
1858 # ifndef WIN3264
1860 * Also try with 'shortname' set, in case the file is on a DOS filesystem.
1862 curbuf->b_shortname = TRUE;
1863 #ifdef VMS
1864 names[num_names] = modname(path, (char_u *)"_sw%", FALSE);
1865 #else
1866 # ifdef RISCOS
1867 names[num_names] = modname(path, (char_u *)"_sw#", FALSE);
1868 # else
1869 names[num_names] = modname(path, (char_u *)".sw?", FALSE);
1870 # endif
1871 #endif
1872 if (names[num_names] == NULL)
1873 goto end;
1876 * Remove the one from 'shortname', if it's the same as with 'noshortname'.
1878 p = names[num_names];
1879 i = STRLEN(names[num_names]) - STRLEN(names[num_names - 1]);
1880 if (i > 0)
1881 p += i; /* file name has been expanded to full path */
1882 if (STRCMP(names[num_names - 1], p) == 0)
1883 vim_free(names[num_names]);
1884 else
1885 ++num_names;
1886 # endif
1888 end:
1889 # ifndef WIN3264
1890 curbuf->b_shortname = shortname;
1891 # endif
1893 #endif /* !SHORT_FNAME */
1895 return num_names;
1899 * sync all memlines
1901 * If 'check_file' is TRUE, check if original file exists and was not changed.
1902 * If 'check_char' is TRUE, stop syncing when character becomes available, but
1903 * always sync at least one block.
1905 void
1906 ml_sync_all(check_file, check_char)
1907 int check_file;
1908 int check_char;
1910 buf_T *buf;
1911 struct stat st;
1913 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1915 if (buf->b_ml.ml_mfp == NULL || buf->b_ml.ml_mfp->mf_fname == NULL)
1916 continue; /* no file */
1918 ml_flush_line(buf); /* flush buffered line */
1919 /* flush locked block */
1920 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH);
1921 if (bufIsChanged(buf) && check_file && mf_need_trans(buf->b_ml.ml_mfp)
1922 && buf->b_ffname != NULL)
1925 * If the original file does not exist anymore or has been changed
1926 * call ml_preserve() to get rid of all negative numbered blocks.
1928 if (mch_stat((char *)buf->b_ffname, &st) == -1
1929 || st.st_mtime != buf->b_mtime_read
1930 || (size_t)st.st_size != buf->b_orig_size)
1932 ml_preserve(buf, FALSE);
1933 did_check_timestamps = FALSE;
1934 need_check_timestamps = TRUE; /* give message later */
1937 if (buf->b_ml.ml_mfp->mf_dirty)
1939 (void)mf_sync(buf->b_ml.ml_mfp, (check_char ? MFS_STOP : 0)
1940 | (bufIsChanged(buf) ? MFS_FLUSH : 0));
1941 if (check_char && ui_char_avail()) /* character available now */
1942 break;
1948 * sync one buffer, including negative blocks
1950 * after this all the blocks are in the swap file
1952 * Used for the :preserve command and when the original file has been
1953 * changed or deleted.
1955 * when message is TRUE the success of preserving is reported
1957 void
1958 ml_preserve(buf, message)
1959 buf_T *buf;
1960 int message;
1962 bhdr_T *hp;
1963 linenr_T lnum;
1964 memfile_T *mfp = buf->b_ml.ml_mfp;
1965 int status;
1966 int got_int_save = got_int;
1968 if (mfp == NULL || mfp->mf_fname == NULL)
1970 if (message)
1971 EMSG(_("E313: Cannot preserve, there is no swap file"));
1972 return;
1975 /* We only want to stop when interrupted here, not when interrupted
1976 * before. */
1977 got_int = FALSE;
1979 ml_flush_line(buf); /* flush buffered line */
1980 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
1981 status = mf_sync(mfp, MFS_ALL | MFS_FLUSH);
1983 /* stack is invalid after mf_sync(.., MFS_ALL) */
1984 buf->b_ml.ml_stack_top = 0;
1987 * Some of the data blocks may have been changed from negative to
1988 * positive block number. In that case the pointer blocks need to be
1989 * updated.
1991 * We don't know in which pointer block the references are, so we visit
1992 * all data blocks until there are no more translations to be done (or
1993 * we hit the end of the file, which can only happen in case a write fails,
1994 * e.g. when file system if full).
1995 * ml_find_line() does the work by translating the negative block numbers
1996 * when getting the first line of each data block.
1998 if (mf_need_trans(mfp) && !got_int)
2000 lnum = 1;
2001 while (mf_need_trans(mfp) && lnum <= buf->b_ml.ml_line_count)
2003 hp = ml_find_line(buf, lnum, ML_FIND);
2004 if (hp == NULL)
2006 status = FAIL;
2007 goto theend;
2009 CHECK(buf->b_ml.ml_locked_low != lnum, "low != lnum");
2010 lnum = buf->b_ml.ml_locked_high + 1;
2012 (void)ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush locked block */
2013 /* sync the updated pointer blocks */
2014 if (mf_sync(mfp, MFS_ALL | MFS_FLUSH) == FAIL)
2015 status = FAIL;
2016 buf->b_ml.ml_stack_top = 0; /* stack is invalid now */
2018 theend:
2019 got_int |= got_int_save;
2021 if (message)
2023 if (status == OK)
2024 MSG(_("File preserved"));
2025 else
2026 EMSG(_("E314: Preserve failed"));
2031 * NOTE: The pointer returned by the ml_get_*() functions only remains valid
2032 * until the next call!
2033 * line1 = ml_get(1);
2034 * line2 = ml_get(2); // line1 is now invalid!
2035 * Make a copy of the line if necessary.
2038 * get a pointer to a (read-only copy of a) line
2040 * On failure an error message is given and IObuff is returned (to avoid
2041 * having to check for error everywhere).
2043 char_u *
2044 ml_get(lnum)
2045 linenr_T lnum;
2047 return ml_get_buf(curbuf, lnum, FALSE);
2051 * ml_get_pos: get pointer to position 'pos'
2053 char_u *
2054 ml_get_pos(pos)
2055 pos_T *pos;
2057 return (ml_get_buf(curbuf, pos->lnum, FALSE) + pos->col);
2061 * ml_get_curline: get pointer to cursor line.
2063 char_u *
2064 ml_get_curline()
2066 return ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE);
2070 * ml_get_cursor: get pointer to cursor position
2072 char_u *
2073 ml_get_cursor()
2075 return (ml_get_buf(curbuf, curwin->w_cursor.lnum, FALSE) +
2076 curwin->w_cursor.col);
2080 * get a pointer to a line in a specific buffer
2082 * "will_change": if TRUE mark the buffer dirty (chars in the line will be
2083 * changed)
2085 char_u *
2086 ml_get_buf(buf, lnum, will_change)
2087 buf_T *buf;
2088 linenr_T lnum;
2089 int will_change; /* line will be changed */
2091 bhdr_T *hp;
2092 DATA_BL *dp;
2093 char_u *ptr;
2094 static int recursive = 0;
2096 if (lnum > buf->b_ml.ml_line_count) /* invalid line number */
2098 if (recursive == 0)
2100 /* Avoid giving this message for a recursive call, may happen when
2101 * the GUI redraws part of the text. */
2102 ++recursive;
2103 EMSGN(_("E315: ml_get: invalid lnum: %ld"), lnum);
2104 --recursive;
2106 errorret:
2107 STRCPY(IObuff, "???");
2108 return IObuff;
2110 if (lnum <= 0) /* pretend line 0 is line 1 */
2111 lnum = 1;
2113 if (buf->b_ml.ml_mfp == NULL) /* there are no lines */
2114 return (char_u *)"";
2117 * See if it is the same line as requested last time.
2118 * Otherwise may need to flush last used line.
2119 * Don't use the last used line when 'swapfile' is reset, need to load all
2120 * blocks.
2122 if (buf->b_ml.ml_line_lnum != lnum || mf_dont_release)
2124 ml_flush_line(buf);
2127 * Find the data block containing the line.
2128 * This also fills the stack with the blocks from the root to the data
2129 * block and releases any locked block.
2131 if ((hp = ml_find_line(buf, lnum, ML_FIND)) == NULL)
2133 if (recursive == 0)
2135 /* Avoid giving this message for a recursive call, may happen
2136 * when the GUI redraws part of the text. */
2137 ++recursive;
2138 EMSGN(_("E316: ml_get: cannot find line %ld"), lnum);
2139 --recursive;
2141 goto errorret;
2144 dp = (DATA_BL *)(hp->bh_data);
2146 ptr = (char_u *)dp + ((dp->db_index[lnum - buf->b_ml.ml_locked_low]) & DB_INDEX_MASK);
2147 buf->b_ml.ml_line_ptr = ptr;
2148 buf->b_ml.ml_line_lnum = lnum;
2149 buf->b_ml.ml_flags &= ~ML_LINE_DIRTY;
2151 if (will_change)
2152 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2154 return buf->b_ml.ml_line_ptr;
2158 * Check if a line that was just obtained by a call to ml_get
2159 * is in allocated memory.
2162 ml_line_alloced()
2164 return (curbuf->b_ml.ml_flags & ML_LINE_DIRTY);
2168 * Append a line after lnum (may be 0 to insert a line in front of the file).
2169 * "line" does not need to be allocated, but can't be another line in a
2170 * buffer, unlocking may make it invalid.
2172 * newfile: TRUE when starting to edit a new file, meaning that pe_old_lnum
2173 * will be set for recovery
2174 * Check: The caller of this function should probably also call
2175 * appended_lines().
2177 * return FAIL for failure, OK otherwise
2180 ml_append(lnum, line, len, newfile)
2181 linenr_T lnum; /* append after this line (can be 0) */
2182 char_u *line; /* text of the new line */
2183 colnr_T len; /* length of new line, including NUL, or 0 */
2184 int newfile; /* flag, see above */
2186 /* When starting up, we might still need to create the memfile */
2187 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2188 return FAIL;
2190 if (curbuf->b_ml.ml_line_lnum != 0)
2191 ml_flush_line(curbuf);
2192 return ml_append_int(curbuf, lnum, line, len, newfile, FALSE);
2195 #if defined(FEAT_SPELL) || defined(PROTO)
2197 * Like ml_append() but for an arbitrary buffer. The buffer must already have
2198 * a memline.
2201 ml_append_buf(buf, lnum, line, len, newfile)
2202 buf_T *buf;
2203 linenr_T lnum; /* append after this line (can be 0) */
2204 char_u *line; /* text of the new line */
2205 colnr_T len; /* length of new line, including NUL, or 0 */
2206 int newfile; /* flag, see above */
2208 if (buf->b_ml.ml_mfp == NULL)
2209 return FAIL;
2211 if (buf->b_ml.ml_line_lnum != 0)
2212 ml_flush_line(buf);
2213 return ml_append_int(buf, lnum, line, len, newfile, FALSE);
2215 #endif
2217 static int
2218 ml_append_int(buf, lnum, line, len, newfile, mark)
2219 buf_T *buf;
2220 linenr_T lnum; /* append after this line (can be 0) */
2221 char_u *line; /* text of the new line */
2222 colnr_T len; /* length of line, including NUL, or 0 */
2223 int newfile; /* flag, see above */
2224 int mark; /* mark the new line */
2226 int i;
2227 int line_count; /* number of indexes in current block */
2228 int offset;
2229 int from, to;
2230 int space_needed; /* space needed for new line */
2231 int page_size;
2232 int page_count;
2233 int db_idx; /* index for lnum in data block */
2234 bhdr_T *hp;
2235 memfile_T *mfp;
2236 DATA_BL *dp;
2237 PTR_BL *pp;
2238 infoptr_T *ip;
2240 /* lnum out of range */
2241 if (lnum > buf->b_ml.ml_line_count || buf->b_ml.ml_mfp == NULL)
2242 return FAIL;
2244 if (lowest_marked && lowest_marked > lnum)
2245 lowest_marked = lnum + 1;
2247 if (len == 0)
2248 len = (colnr_T)STRLEN(line) + 1; /* space needed for the text */
2249 space_needed = len + INDEX_SIZE; /* space needed for text + index */
2251 mfp = buf->b_ml.ml_mfp;
2252 page_size = mfp->mf_page_size;
2255 * find the data block containing the previous line
2256 * This also fills the stack with the blocks from the root to the data block
2257 * This also releases any locked block.
2259 if ((hp = ml_find_line(buf, lnum == 0 ? (linenr_T)1 : lnum,
2260 ML_INSERT)) == NULL)
2261 return FAIL;
2263 buf->b_ml.ml_flags &= ~ML_EMPTY;
2265 if (lnum == 0) /* got line one instead, correct db_idx */
2266 db_idx = -1; /* careful, it is negative! */
2267 else
2268 db_idx = lnum - buf->b_ml.ml_locked_low;
2269 /* get line count before the insertion */
2270 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2272 dp = (DATA_BL *)(hp->bh_data);
2275 * If
2276 * - there is not enough room in the current block
2277 * - appending to the last line in the block
2278 * - not appending to the last line in the file
2279 * insert in front of the next block.
2281 if ((int)dp->db_free < space_needed && db_idx == line_count - 1
2282 && lnum < buf->b_ml.ml_line_count)
2285 * Now that the line is not going to be inserted in the block that we
2286 * expected, the line count has to be adjusted in the pointer blocks
2287 * by using ml_locked_lineadd.
2289 --(buf->b_ml.ml_locked_lineadd);
2290 --(buf->b_ml.ml_locked_high);
2291 if ((hp = ml_find_line(buf, lnum + 1, ML_INSERT)) == NULL)
2292 return FAIL;
2294 db_idx = -1; /* careful, it is negative! */
2295 /* get line count before the insertion */
2296 line_count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low;
2297 CHECK(buf->b_ml.ml_locked_low != lnum + 1, "locked_low != lnum + 1");
2299 dp = (DATA_BL *)(hp->bh_data);
2302 ++buf->b_ml.ml_line_count;
2304 if ((int)dp->db_free >= space_needed) /* enough room in data block */
2307 * Insert new line in existing data block, or in data block allocated above.
2309 dp->db_txt_start -= len;
2310 dp->db_free -= space_needed;
2311 ++(dp->db_line_count);
2314 * move the text of the lines that follow to the front
2315 * adjust the indexes of the lines that follow
2317 if (line_count > db_idx + 1) /* if there are following lines */
2320 * Offset is the start of the previous line.
2321 * This will become the character just after the new line.
2323 if (db_idx < 0)
2324 offset = dp->db_txt_end;
2325 else
2326 offset = ((dp->db_index[db_idx]) & DB_INDEX_MASK);
2327 mch_memmove((char *)dp + dp->db_txt_start,
2328 (char *)dp + dp->db_txt_start + len,
2329 (size_t)(offset - (dp->db_txt_start + len)));
2330 for (i = line_count - 1; i > db_idx; --i)
2331 dp->db_index[i + 1] = dp->db_index[i] - len;
2332 dp->db_index[db_idx + 1] = offset - len;
2334 else /* add line at the end */
2335 dp->db_index[db_idx + 1] = dp->db_txt_start;
2338 * copy the text into the block
2340 mch_memmove((char *)dp + dp->db_index[db_idx + 1], line, (size_t)len);
2341 if (mark)
2342 dp->db_index[db_idx + 1] |= DB_MARKED;
2345 * Mark the block dirty.
2347 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2348 if (!newfile)
2349 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2351 else /* not enough space in data block */
2354 * If there is not enough room we have to create a new data block and copy some
2355 * lines into it.
2356 * Then we have to insert an entry in the pointer block.
2357 * If this pointer block also is full, we go up another block, and so on, up
2358 * to the root if necessary.
2359 * The line counts in the pointer blocks have already been adjusted by
2360 * ml_find_line().
2362 long line_count_left, line_count_right;
2363 int page_count_left, page_count_right;
2364 bhdr_T *hp_left;
2365 bhdr_T *hp_right;
2366 bhdr_T *hp_new;
2367 int lines_moved;
2368 int data_moved = 0; /* init to shut up gcc */
2369 int total_moved = 0; /* init to shut up gcc */
2370 DATA_BL *dp_right, *dp_left;
2371 int stack_idx;
2372 int in_left;
2373 int lineadd;
2374 blocknr_T bnum_left, bnum_right;
2375 linenr_T lnum_left, lnum_right;
2376 int pb_idx;
2377 PTR_BL *pp_new;
2380 * We are going to allocate a new data block. Depending on the
2381 * situation it will be put to the left or right of the existing
2382 * block. If possible we put the new line in the left block and move
2383 * the lines after it to the right block. Otherwise the new line is
2384 * also put in the right block. This method is more efficient when
2385 * inserting a lot of lines at one place.
2387 if (db_idx < 0) /* left block is new, right block is existing */
2389 lines_moved = 0;
2390 in_left = TRUE;
2391 /* space_needed does not change */
2393 else /* left block is existing, right block is new */
2395 lines_moved = line_count - db_idx - 1;
2396 if (lines_moved == 0)
2397 in_left = FALSE; /* put new line in right block */
2398 /* space_needed does not change */
2399 else
2401 data_moved = ((dp->db_index[db_idx]) & DB_INDEX_MASK) -
2402 dp->db_txt_start;
2403 total_moved = data_moved + lines_moved * INDEX_SIZE;
2404 if ((int)dp->db_free + total_moved >= space_needed)
2406 in_left = TRUE; /* put new line in left block */
2407 space_needed = total_moved;
2409 else
2411 in_left = FALSE; /* put new line in right block */
2412 space_needed += total_moved;
2417 page_count = ((space_needed + HEADER_SIZE) + page_size - 1) / page_size;
2418 if ((hp_new = ml_new_data(mfp, newfile, page_count)) == NULL)
2420 /* correct line counts in pointer blocks */
2421 --(buf->b_ml.ml_locked_lineadd);
2422 --(buf->b_ml.ml_locked_high);
2423 return FAIL;
2425 if (db_idx < 0) /* left block is new */
2427 hp_left = hp_new;
2428 hp_right = hp;
2429 line_count_left = 0;
2430 line_count_right = line_count;
2432 else /* right block is new */
2434 hp_left = hp;
2435 hp_right = hp_new;
2436 line_count_left = line_count;
2437 line_count_right = 0;
2439 dp_right = (DATA_BL *)(hp_right->bh_data);
2440 dp_left = (DATA_BL *)(hp_left->bh_data);
2441 bnum_left = hp_left->bh_bnum;
2442 bnum_right = hp_right->bh_bnum;
2443 page_count_left = hp_left->bh_page_count;
2444 page_count_right = hp_right->bh_page_count;
2447 * May move the new line into the right/new block.
2449 if (!in_left)
2451 dp_right->db_txt_start -= len;
2452 dp_right->db_free -= len + INDEX_SIZE;
2453 dp_right->db_index[0] = dp_right->db_txt_start;
2454 if (mark)
2455 dp_right->db_index[0] |= DB_MARKED;
2457 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2458 line, (size_t)len);
2459 ++line_count_right;
2462 * may move lines from the left/old block to the right/new one.
2464 if (lines_moved)
2468 dp_right->db_txt_start -= data_moved;
2469 dp_right->db_free -= total_moved;
2470 mch_memmove((char *)dp_right + dp_right->db_txt_start,
2471 (char *)dp_left + dp_left->db_txt_start,
2472 (size_t)data_moved);
2473 offset = dp_right->db_txt_start - dp_left->db_txt_start;
2474 dp_left->db_txt_start += data_moved;
2475 dp_left->db_free += total_moved;
2478 * update indexes in the new block
2480 for (to = line_count_right, from = db_idx + 1;
2481 from < line_count_left; ++from, ++to)
2482 dp_right->db_index[to] = dp->db_index[from] + offset;
2483 line_count_right += lines_moved;
2484 line_count_left -= lines_moved;
2488 * May move the new line into the left (old or new) block.
2490 if (in_left)
2492 dp_left->db_txt_start -= len;
2493 dp_left->db_free -= len + INDEX_SIZE;
2494 dp_left->db_index[line_count_left] = dp_left->db_txt_start;
2495 if (mark)
2496 dp_left->db_index[line_count_left] |= DB_MARKED;
2497 mch_memmove((char *)dp_left + dp_left->db_txt_start,
2498 line, (size_t)len);
2499 ++line_count_left;
2502 if (db_idx < 0) /* left block is new */
2504 lnum_left = lnum + 1;
2505 lnum_right = 0;
2507 else /* right block is new */
2509 lnum_left = 0;
2510 if (in_left)
2511 lnum_right = lnum + 2;
2512 else
2513 lnum_right = lnum + 1;
2515 dp_left->db_line_count = line_count_left;
2516 dp_right->db_line_count = line_count_right;
2519 * release the two data blocks
2520 * The new one (hp_new) already has a correct blocknumber.
2521 * The old one (hp, in ml_locked) gets a positive blocknumber if
2522 * we changed it and we are not editing a new file.
2524 if (lines_moved || in_left)
2525 buf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2526 if (!newfile && db_idx >= 0 && in_left)
2527 buf->b_ml.ml_flags |= ML_LOCKED_POS;
2528 mf_put(mfp, hp_new, TRUE, FALSE);
2531 * flush the old data block
2532 * set ml_locked_lineadd to 0, because the updating of the
2533 * pointer blocks is done below
2535 lineadd = buf->b_ml.ml_locked_lineadd;
2536 buf->b_ml.ml_locked_lineadd = 0;
2537 ml_find_line(buf, (linenr_T)0, ML_FLUSH); /* flush data block */
2540 * update pointer blocks for the new data block
2542 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0;
2543 --stack_idx)
2545 ip = &(buf->b_ml.ml_stack[stack_idx]);
2546 pb_idx = ip->ip_index;
2547 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2548 return FAIL;
2549 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2550 if (pp->pb_id != PTR_ID)
2552 EMSG(_("E317: pointer block id wrong 3"));
2553 mf_put(mfp, hp, FALSE, FALSE);
2554 return FAIL;
2557 * TODO: If the pointer block is full and we are adding at the end
2558 * try to insert in front of the next block
2560 /* block not full, add one entry */
2561 if (pp->pb_count < pp->pb_count_max)
2563 if (pb_idx + 1 < (int)pp->pb_count)
2564 mch_memmove(&pp->pb_pointer[pb_idx + 2],
2565 &pp->pb_pointer[pb_idx + 1],
2566 (size_t)(pp->pb_count - pb_idx - 1) * sizeof(PTR_EN));
2567 ++pp->pb_count;
2568 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2569 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2570 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2571 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2572 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2573 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2575 if (lnum_left != 0)
2576 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2577 if (lnum_right != 0)
2578 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2580 mf_put(mfp, hp, TRUE, FALSE);
2581 buf->b_ml.ml_stack_top = stack_idx + 1; /* truncate stack */
2583 if (lineadd)
2585 --(buf->b_ml.ml_stack_top);
2586 /* fix line count for rest of blocks in the stack */
2587 ml_lineadd(buf, lineadd);
2588 /* fix stack itself */
2589 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2590 lineadd;
2591 ++(buf->b_ml.ml_stack_top);
2595 * We are finished, break the loop here.
2597 break;
2599 else /* pointer block full */
2602 * split the pointer block
2603 * allocate a new pointer block
2604 * move some of the pointer into the new block
2605 * prepare for updating the parent block
2607 for (;;) /* do this twice when splitting block 1 */
2609 hp_new = ml_new_ptr(mfp);
2610 if (hp_new == NULL) /* TODO: try to fix tree */
2611 return FAIL;
2612 pp_new = (PTR_BL *)(hp_new->bh_data);
2614 if (hp->bh_bnum != 1)
2615 break;
2618 * if block 1 becomes full the tree is given an extra level
2619 * The pointers from block 1 are moved into the new block.
2620 * block 1 is updated to point to the new block
2621 * then continue to split the new block
2623 mch_memmove(pp_new, pp, (size_t)page_size);
2624 pp->pb_count = 1;
2625 pp->pb_pointer[0].pe_bnum = hp_new->bh_bnum;
2626 pp->pb_pointer[0].pe_line_count = buf->b_ml.ml_line_count;
2627 pp->pb_pointer[0].pe_old_lnum = 1;
2628 pp->pb_pointer[0].pe_page_count = 1;
2629 mf_put(mfp, hp, TRUE, FALSE); /* release block 1 */
2630 hp = hp_new; /* new block is to be split */
2631 pp = pp_new;
2632 CHECK(stack_idx != 0, _("stack_idx should be 0"));
2633 ip->ip_index = 0;
2634 ++stack_idx; /* do block 1 again later */
2637 * move the pointers after the current one to the new block
2638 * If there are none, the new entry will be in the new block.
2640 total_moved = pp->pb_count - pb_idx - 1;
2641 if (total_moved)
2643 mch_memmove(&pp_new->pb_pointer[0],
2644 &pp->pb_pointer[pb_idx + 1],
2645 (size_t)(total_moved) * sizeof(PTR_EN));
2646 pp_new->pb_count = total_moved;
2647 pp->pb_count -= total_moved - 1;
2648 pp->pb_pointer[pb_idx + 1].pe_bnum = bnum_right;
2649 pp->pb_pointer[pb_idx + 1].pe_line_count = line_count_right;
2650 pp->pb_pointer[pb_idx + 1].pe_page_count = page_count_right;
2651 if (lnum_right)
2652 pp->pb_pointer[pb_idx + 1].pe_old_lnum = lnum_right;
2654 else
2656 pp_new->pb_count = 1;
2657 pp_new->pb_pointer[0].pe_bnum = bnum_right;
2658 pp_new->pb_pointer[0].pe_line_count = line_count_right;
2659 pp_new->pb_pointer[0].pe_page_count = page_count_right;
2660 pp_new->pb_pointer[0].pe_old_lnum = lnum_right;
2662 pp->pb_pointer[pb_idx].pe_bnum = bnum_left;
2663 pp->pb_pointer[pb_idx].pe_line_count = line_count_left;
2664 pp->pb_pointer[pb_idx].pe_page_count = page_count_left;
2665 if (lnum_left)
2666 pp->pb_pointer[pb_idx].pe_old_lnum = lnum_left;
2667 lnum_left = 0;
2668 lnum_right = 0;
2671 * recompute line counts
2673 line_count_right = 0;
2674 for (i = 0; i < (int)pp_new->pb_count; ++i)
2675 line_count_right += pp_new->pb_pointer[i].pe_line_count;
2676 line_count_left = 0;
2677 for (i = 0; i < (int)pp->pb_count; ++i)
2678 line_count_left += pp->pb_pointer[i].pe_line_count;
2680 bnum_left = hp->bh_bnum;
2681 bnum_right = hp_new->bh_bnum;
2682 page_count_left = 1;
2683 page_count_right = 1;
2684 mf_put(mfp, hp, TRUE, FALSE);
2685 mf_put(mfp, hp_new, TRUE, FALSE);
2690 * Safety check: fallen out of for loop?
2692 if (stack_idx < 0)
2694 EMSG(_("E318: Updated too many blocks?"));
2695 buf->b_ml.ml_stack_top = 0; /* invalidate stack */
2699 #ifdef FEAT_BYTEOFF
2700 /* The line was inserted below 'lnum' */
2701 ml_updatechunk(buf, lnum + 1, (long)len, ML_CHNK_ADDLINE);
2702 #endif
2703 #ifdef FEAT_NETBEANS_INTG
2704 if (usingNetbeans)
2706 if (STRLEN(line) > 0)
2707 netbeans_inserted(buf, lnum+1, (colnr_T)0, line, (int)STRLEN(line));
2708 netbeans_inserted(buf, lnum+1, (colnr_T)STRLEN(line),
2709 (char_u *)"\n", 1);
2711 #endif
2712 return OK;
2716 * Replace line lnum, with buffering, in current buffer.
2718 * If "copy" is TRUE, make a copy of the line, otherwise the line has been
2719 * copied to allocated memory already.
2721 * Check: The caller of this function should probably also call
2722 * changed_lines(), unless update_screen(NOT_VALID) is used.
2724 * return FAIL for failure, OK otherwise
2727 ml_replace(lnum, line, copy)
2728 linenr_T lnum;
2729 char_u *line;
2730 int copy;
2732 if (line == NULL) /* just checking... */
2733 return FAIL;
2735 /* When starting up, we might still need to create the memfile */
2736 if (curbuf->b_ml.ml_mfp == NULL && open_buffer(FALSE, NULL) == FAIL)
2737 return FAIL;
2739 if (copy && (line = vim_strsave(line)) == NULL) /* allocate memory */
2740 return FAIL;
2741 #ifdef FEAT_NETBEANS_INTG
2742 if (usingNetbeans)
2744 netbeans_removed(curbuf, lnum, 0, (long)STRLEN(ml_get(lnum)));
2745 netbeans_inserted(curbuf, lnum, 0, line, (int)STRLEN(line));
2747 #endif
2748 if (curbuf->b_ml.ml_line_lnum != lnum) /* other line buffered */
2749 ml_flush_line(curbuf); /* flush it */
2750 else if (curbuf->b_ml.ml_flags & ML_LINE_DIRTY) /* same line allocated */
2751 vim_free(curbuf->b_ml.ml_line_ptr); /* free it */
2752 curbuf->b_ml.ml_line_ptr = line;
2753 curbuf->b_ml.ml_line_lnum = lnum;
2754 curbuf->b_ml.ml_flags = (curbuf->b_ml.ml_flags | ML_LINE_DIRTY) & ~ML_EMPTY;
2756 return OK;
2760 * Delete line 'lnum' in the current buffer.
2762 * Check: The caller of this function should probably also call
2763 * deleted_lines() after this.
2765 * return FAIL for failure, OK otherwise
2768 ml_delete(lnum, message)
2769 linenr_T lnum;
2770 int message;
2772 ml_flush_line(curbuf);
2773 return ml_delete_int(curbuf, lnum, message);
2776 static int
2777 ml_delete_int(buf, lnum, message)
2778 buf_T *buf;
2779 linenr_T lnum;
2780 int message;
2782 bhdr_T *hp;
2783 memfile_T *mfp;
2784 DATA_BL *dp;
2785 PTR_BL *pp;
2786 infoptr_T *ip;
2787 int count; /* number of entries in block */
2788 int idx;
2789 int stack_idx;
2790 int text_start;
2791 int line_start;
2792 long line_size;
2793 int i;
2795 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
2796 return FAIL;
2798 if (lowest_marked && lowest_marked > lnum)
2799 lowest_marked--;
2802 * If the file becomes empty the last line is replaced by an empty line.
2804 if (buf->b_ml.ml_line_count == 1) /* file becomes empty */
2806 if (message
2807 #ifdef FEAT_NETBEANS_INTG
2808 && !netbeansSuppressNoLines
2809 #endif
2811 set_keep_msg((char_u *)_(no_lines_msg), 0);
2813 /* FEAT_BYTEOFF already handled in there, dont worry 'bout it below */
2814 i = ml_replace((linenr_T)1, (char_u *)"", TRUE);
2815 buf->b_ml.ml_flags |= ML_EMPTY;
2817 return i;
2821 * find the data block containing the line
2822 * This also fills the stack with the blocks from the root to the data block
2823 * This also releases any locked block.
2825 mfp = buf->b_ml.ml_mfp;
2826 if (mfp == NULL)
2827 return FAIL;
2829 if ((hp = ml_find_line(buf, lnum, ML_DELETE)) == NULL)
2830 return FAIL;
2832 dp = (DATA_BL *)(hp->bh_data);
2833 /* compute line count before the delete */
2834 count = (long)(buf->b_ml.ml_locked_high)
2835 - (long)(buf->b_ml.ml_locked_low) + 2;
2836 idx = lnum - buf->b_ml.ml_locked_low;
2838 --buf->b_ml.ml_line_count;
2840 line_start = ((dp->db_index[idx]) & DB_INDEX_MASK);
2841 if (idx == 0) /* first line in block, text at the end */
2842 line_size = dp->db_txt_end - line_start;
2843 else
2844 line_size = ((dp->db_index[idx - 1]) & DB_INDEX_MASK) - line_start;
2846 #ifdef FEAT_NETBEANS_INTG
2847 if (usingNetbeans)
2848 netbeans_removed(buf, lnum, 0, (long)line_size);
2849 #endif
2852 * special case: If there is only one line in the data block it becomes empty.
2853 * Then we have to remove the entry, pointing to this data block, from the
2854 * pointer block. If this pointer block also becomes empty, we go up another
2855 * block, and so on, up to the root if necessary.
2856 * The line counts in the pointer blocks have already been adjusted by
2857 * ml_find_line().
2859 if (count == 1)
2861 mf_free(mfp, hp); /* free the data block */
2862 buf->b_ml.ml_locked = NULL;
2864 for (stack_idx = buf->b_ml.ml_stack_top - 1; stack_idx >= 0; --stack_idx)
2866 buf->b_ml.ml_stack_top = 0; /* stack is invalid when failing */
2867 ip = &(buf->b_ml.ml_stack[stack_idx]);
2868 idx = ip->ip_index;
2869 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
2870 return FAIL;
2871 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
2872 if (pp->pb_id != PTR_ID)
2874 EMSG(_("E317: pointer block id wrong 4"));
2875 mf_put(mfp, hp, FALSE, FALSE);
2876 return FAIL;
2878 count = --(pp->pb_count);
2879 if (count == 0) /* the pointer block becomes empty! */
2880 mf_free(mfp, hp);
2881 else
2883 if (count != idx) /* move entries after the deleted one */
2884 mch_memmove(&pp->pb_pointer[idx], &pp->pb_pointer[idx + 1],
2885 (size_t)(count - idx) * sizeof(PTR_EN));
2886 mf_put(mfp, hp, TRUE, FALSE);
2888 buf->b_ml.ml_stack_top = stack_idx; /* truncate stack */
2889 /* fix line count for rest of blocks in the stack */
2890 if (buf->b_ml.ml_locked_lineadd != 0)
2892 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
2893 buf->b_ml.ml_stack[buf->b_ml.ml_stack_top].ip_high +=
2894 buf->b_ml.ml_locked_lineadd;
2896 ++(buf->b_ml.ml_stack_top);
2898 break;
2901 CHECK(stack_idx < 0, _("deleted block 1?"));
2903 else
2906 * delete the text by moving the next lines forwards
2908 text_start = dp->db_txt_start;
2909 mch_memmove((char *)dp + text_start + line_size,
2910 (char *)dp + text_start, (size_t)(line_start - text_start));
2913 * delete the index by moving the next indexes backwards
2914 * Adjust the indexes for the text movement.
2916 for (i = idx; i < count - 1; ++i)
2917 dp->db_index[i] = dp->db_index[i + 1] + line_size;
2919 dp->db_free += line_size + INDEX_SIZE;
2920 dp->db_txt_start += line_size;
2921 --(dp->db_line_count);
2924 * mark the block dirty and make sure it is in the file (for recovery)
2926 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
2929 #ifdef FEAT_BYTEOFF
2930 ml_updatechunk(buf, lnum, line_size, ML_CHNK_DELLINE);
2931 #endif
2932 return OK;
2936 * set the B_MARKED flag for line 'lnum'
2938 void
2939 ml_setmarked(lnum)
2940 linenr_T lnum;
2942 bhdr_T *hp;
2943 DATA_BL *dp;
2944 /* invalid line number */
2945 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count
2946 || curbuf->b_ml.ml_mfp == NULL)
2947 return; /* give error message? */
2949 if (lowest_marked == 0 || lowest_marked > lnum)
2950 lowest_marked = lnum;
2953 * find the data block containing the line
2954 * This also fills the stack with the blocks from the root to the data block
2955 * This also releases any locked block.
2957 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2958 return; /* give error message? */
2960 dp = (DATA_BL *)(hp->bh_data);
2961 dp->db_index[lnum - curbuf->b_ml.ml_locked_low] |= DB_MARKED;
2962 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
2966 * find the first line with its B_MARKED flag set
2968 linenr_T
2969 ml_firstmarked()
2971 bhdr_T *hp;
2972 DATA_BL *dp;
2973 linenr_T lnum;
2974 int i;
2976 if (curbuf->b_ml.ml_mfp == NULL)
2977 return (linenr_T) 0;
2980 * The search starts with lowest_marked line. This is the last line where
2981 * a mark was found, adjusted by inserting/deleting lines.
2983 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
2986 * Find the data block containing the line.
2987 * This also fills the stack with the blocks from the root to the data
2988 * block This also releases any locked block.
2990 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
2991 return (linenr_T)0; /* give error message? */
2993 dp = (DATA_BL *)(hp->bh_data);
2995 for (i = lnum - curbuf->b_ml.ml_locked_low;
2996 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
2997 if ((dp->db_index[i]) & DB_MARKED)
2999 (dp->db_index[i]) &= DB_INDEX_MASK;
3000 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3001 lowest_marked = lnum + 1;
3002 return lnum;
3006 return (linenr_T) 0;
3009 #if 0 /* not used */
3011 * return TRUE if line 'lnum' has a mark
3014 ml_has_mark(lnum)
3015 linenr_T lnum;
3017 bhdr_T *hp;
3018 DATA_BL *dp;
3020 if (curbuf->b_ml.ml_mfp == NULL
3021 || (hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3022 return FALSE;
3024 dp = (DATA_BL *)(hp->bh_data);
3025 return (int)((dp->db_index[lnum - curbuf->b_ml.ml_locked_low]) & DB_MARKED);
3027 #endif
3030 * clear all DB_MARKED flags
3032 void
3033 ml_clearmarked()
3035 bhdr_T *hp;
3036 DATA_BL *dp;
3037 linenr_T lnum;
3038 int i;
3040 if (curbuf->b_ml.ml_mfp == NULL) /* nothing to do */
3041 return;
3044 * The search starts with line lowest_marked.
3046 for (lnum = lowest_marked; lnum <= curbuf->b_ml.ml_line_count; )
3049 * Find the data block containing the line.
3050 * This also fills the stack with the blocks from the root to the data
3051 * block and releases any locked block.
3053 if ((hp = ml_find_line(curbuf, lnum, ML_FIND)) == NULL)
3054 return; /* give error message? */
3056 dp = (DATA_BL *)(hp->bh_data);
3058 for (i = lnum - curbuf->b_ml.ml_locked_low;
3059 lnum <= curbuf->b_ml.ml_locked_high; ++i, ++lnum)
3060 if ((dp->db_index[i]) & DB_MARKED)
3062 (dp->db_index[i]) &= DB_INDEX_MASK;
3063 curbuf->b_ml.ml_flags |= ML_LOCKED_DIRTY;
3067 lowest_marked = 0;
3068 return;
3072 * flush ml_line if necessary
3074 static void
3075 ml_flush_line(buf)
3076 buf_T *buf;
3078 bhdr_T *hp;
3079 DATA_BL *dp;
3080 linenr_T lnum;
3081 char_u *new_line;
3082 char_u *old_line;
3083 colnr_T new_len;
3084 int old_len;
3085 int extra;
3086 int idx;
3087 int start;
3088 int count;
3089 int i;
3091 if (buf->b_ml.ml_line_lnum == 0 || buf->b_ml.ml_mfp == NULL)
3092 return; /* nothing to do */
3094 if (buf->b_ml.ml_flags & ML_LINE_DIRTY)
3096 lnum = buf->b_ml.ml_line_lnum;
3097 new_line = buf->b_ml.ml_line_ptr;
3099 hp = ml_find_line(buf, lnum, ML_FIND);
3100 if (hp == NULL)
3101 EMSGN(_("E320: Cannot find line %ld"), lnum);
3102 else
3104 dp = (DATA_BL *)(hp->bh_data);
3105 idx = lnum - buf->b_ml.ml_locked_low;
3106 start = ((dp->db_index[idx]) & DB_INDEX_MASK);
3107 old_line = (char_u *)dp + start;
3108 if (idx == 0) /* line is last in block */
3109 old_len = dp->db_txt_end - start;
3110 else /* text of previous line follows */
3111 old_len = (dp->db_index[idx - 1] & DB_INDEX_MASK) - start;
3112 new_len = (colnr_T)STRLEN(new_line) + 1;
3113 extra = new_len - old_len; /* negative if lines gets smaller */
3116 * if new line fits in data block, replace directly
3118 if ((int)dp->db_free >= extra)
3120 /* if the length changes and there are following lines */
3121 count = buf->b_ml.ml_locked_high - buf->b_ml.ml_locked_low + 1;
3122 if (extra != 0 && idx < count - 1)
3124 /* move text of following lines */
3125 mch_memmove((char *)dp + dp->db_txt_start - extra,
3126 (char *)dp + dp->db_txt_start,
3127 (size_t)(start - dp->db_txt_start));
3129 /* adjust pointers of this and following lines */
3130 for (i = idx + 1; i < count; ++i)
3131 dp->db_index[i] -= extra;
3133 dp->db_index[idx] -= extra;
3135 /* adjust free space */
3136 dp->db_free -= extra;
3137 dp->db_txt_start -= extra;
3139 /* copy new line into the data block */
3140 mch_memmove(old_line - extra, new_line, (size_t)new_len);
3141 buf->b_ml.ml_flags |= (ML_LOCKED_DIRTY | ML_LOCKED_POS);
3142 #ifdef FEAT_BYTEOFF
3143 /* The else case is already covered by the insert and delete */
3144 ml_updatechunk(buf, lnum, (long)extra, ML_CHNK_UPDLINE);
3145 #endif
3147 else
3150 * Cannot do it in one data block: Delete and append.
3151 * Append first, because ml_delete_int() cannot delete the
3152 * last line in a buffer, which causes trouble for a buffer
3153 * that has only one line.
3154 * Don't forget to copy the mark!
3156 /* How about handling errors??? */
3157 (void)ml_append_int(buf, lnum, new_line, new_len, FALSE,
3158 (dp->db_index[idx] & DB_MARKED));
3159 (void)ml_delete_int(buf, lnum, FALSE);
3162 vim_free(new_line);
3165 buf->b_ml.ml_line_lnum = 0;
3169 * create a new, empty, data block
3171 static bhdr_T *
3172 ml_new_data(mfp, negative, page_count)
3173 memfile_T *mfp;
3174 int negative;
3175 int page_count;
3177 bhdr_T *hp;
3178 DATA_BL *dp;
3180 if ((hp = mf_new(mfp, negative, page_count)) == NULL)
3181 return NULL;
3183 dp = (DATA_BL *)(hp->bh_data);
3184 dp->db_id = DATA_ID;
3185 dp->db_txt_start = dp->db_txt_end = page_count * mfp->mf_page_size;
3186 dp->db_free = dp->db_txt_start - HEADER_SIZE;
3187 dp->db_line_count = 0;
3189 return hp;
3193 * create a new, empty, pointer block
3195 static bhdr_T *
3196 ml_new_ptr(mfp)
3197 memfile_T *mfp;
3199 bhdr_T *hp;
3200 PTR_BL *pp;
3202 if ((hp = mf_new(mfp, FALSE, 1)) == NULL)
3203 return NULL;
3205 pp = (PTR_BL *)(hp->bh_data);
3206 pp->pb_id = PTR_ID;
3207 pp->pb_count = 0;
3208 pp->pb_count_max = (short_u)((mfp->mf_page_size - sizeof(PTR_BL)) / sizeof(PTR_EN) + 1);
3210 return hp;
3214 * lookup line 'lnum' in a memline
3216 * action: if ML_DELETE or ML_INSERT the line count is updated while searching
3217 * if ML_FLUSH only flush a locked block
3218 * if ML_FIND just find the line
3220 * If the block was found it is locked and put in ml_locked.
3221 * The stack is updated to lead to the locked block. The ip_high field in
3222 * the stack is updated to reflect the last line in the block AFTER the
3223 * insert or delete, also if the pointer block has not been updated yet. But
3224 * if ml_locked != NULL ml_locked_lineadd must be added to ip_high.
3226 * return: NULL for failure, pointer to block header otherwise
3228 static bhdr_T *
3229 ml_find_line(buf, lnum, action)
3230 buf_T *buf;
3231 linenr_T lnum;
3232 int action;
3234 DATA_BL *dp;
3235 PTR_BL *pp;
3236 infoptr_T *ip;
3237 bhdr_T *hp;
3238 memfile_T *mfp;
3239 linenr_T t;
3240 blocknr_T bnum, bnum2;
3241 int dirty;
3242 linenr_T low, high;
3243 int top;
3244 int page_count;
3245 int idx;
3247 mfp = buf->b_ml.ml_mfp;
3250 * If there is a locked block check if the wanted line is in it.
3251 * If not, flush and release the locked block.
3252 * Don't do this for ML_INSERT_SAME, because the stack need to be updated.
3253 * Don't do this for ML_FLUSH, because we want to flush the locked block.
3254 * Don't do this when 'swapfile' is reset, we want to load all the blocks.
3256 if (buf->b_ml.ml_locked)
3258 if (ML_SIMPLE(action)
3259 && buf->b_ml.ml_locked_low <= lnum
3260 && buf->b_ml.ml_locked_high >= lnum
3261 && !mf_dont_release)
3263 /* remember to update pointer blocks and stack later */
3264 if (action == ML_INSERT)
3266 ++(buf->b_ml.ml_locked_lineadd);
3267 ++(buf->b_ml.ml_locked_high);
3269 else if (action == ML_DELETE)
3271 --(buf->b_ml.ml_locked_lineadd);
3272 --(buf->b_ml.ml_locked_high);
3274 return (buf->b_ml.ml_locked);
3277 mf_put(mfp, buf->b_ml.ml_locked, buf->b_ml.ml_flags & ML_LOCKED_DIRTY,
3278 buf->b_ml.ml_flags & ML_LOCKED_POS);
3279 buf->b_ml.ml_locked = NULL;
3282 * If lines have been added or deleted in the locked block, need to
3283 * update the line count in pointer blocks.
3285 if (buf->b_ml.ml_locked_lineadd != 0)
3286 ml_lineadd(buf, buf->b_ml.ml_locked_lineadd);
3289 if (action == ML_FLUSH) /* nothing else to do */
3290 return NULL;
3292 bnum = 1; /* start at the root of the tree */
3293 page_count = 1;
3294 low = 1;
3295 high = buf->b_ml.ml_line_count;
3297 if (action == ML_FIND) /* first try stack entries */
3299 for (top = buf->b_ml.ml_stack_top - 1; top >= 0; --top)
3301 ip = &(buf->b_ml.ml_stack[top]);
3302 if (ip->ip_low <= lnum && ip->ip_high >= lnum)
3304 bnum = ip->ip_bnum;
3305 low = ip->ip_low;
3306 high = ip->ip_high;
3307 buf->b_ml.ml_stack_top = top; /* truncate stack at prev entry */
3308 break;
3311 if (top < 0)
3312 buf->b_ml.ml_stack_top = 0; /* not found, start at the root */
3314 else /* ML_DELETE or ML_INSERT */
3315 buf->b_ml.ml_stack_top = 0; /* start at the root */
3318 * search downwards in the tree until a data block is found
3320 for (;;)
3322 if ((hp = mf_get(mfp, bnum, page_count)) == NULL)
3323 goto error_noblock;
3326 * update high for insert/delete
3328 if (action == ML_INSERT)
3329 ++high;
3330 else if (action == ML_DELETE)
3331 --high;
3333 dp = (DATA_BL *)(hp->bh_data);
3334 if (dp->db_id == DATA_ID) /* data block */
3336 buf->b_ml.ml_locked = hp;
3337 buf->b_ml.ml_locked_low = low;
3338 buf->b_ml.ml_locked_high = high;
3339 buf->b_ml.ml_locked_lineadd = 0;
3340 buf->b_ml.ml_flags &= ~(ML_LOCKED_DIRTY | ML_LOCKED_POS);
3341 return hp;
3344 pp = (PTR_BL *)(dp); /* must be pointer block */
3345 if (pp->pb_id != PTR_ID)
3347 EMSG(_("E317: pointer block id wrong"));
3348 goto error_block;
3351 if ((top = ml_add_stack(buf)) < 0) /* add new entry to stack */
3352 goto error_block;
3353 ip = &(buf->b_ml.ml_stack[top]);
3354 ip->ip_bnum = bnum;
3355 ip->ip_low = low;
3356 ip->ip_high = high;
3357 ip->ip_index = -1; /* index not known yet */
3359 dirty = FALSE;
3360 for (idx = 0; idx < (int)pp->pb_count; ++idx)
3362 t = pp->pb_pointer[idx].pe_line_count;
3363 CHECK(t == 0, _("pe_line_count is zero"));
3364 if ((low += t) > lnum)
3366 ip->ip_index = idx;
3367 bnum = pp->pb_pointer[idx].pe_bnum;
3368 page_count = pp->pb_pointer[idx].pe_page_count;
3369 high = low - 1;
3370 low -= t;
3373 * a negative block number may have been changed
3375 if (bnum < 0)
3377 bnum2 = mf_trans_del(mfp, bnum);
3378 if (bnum != bnum2)
3380 bnum = bnum2;
3381 pp->pb_pointer[idx].pe_bnum = bnum;
3382 dirty = TRUE;
3386 break;
3389 if (idx >= (int)pp->pb_count) /* past the end: something wrong! */
3391 if (lnum > buf->b_ml.ml_line_count)
3392 EMSGN(_("E322: line number out of range: %ld past the end"),
3393 lnum - buf->b_ml.ml_line_count);
3395 else
3396 EMSGN(_("E323: line count wrong in block %ld"), bnum);
3397 goto error_block;
3399 if (action == ML_DELETE)
3401 pp->pb_pointer[idx].pe_line_count--;
3402 dirty = TRUE;
3404 else if (action == ML_INSERT)
3406 pp->pb_pointer[idx].pe_line_count++;
3407 dirty = TRUE;
3409 mf_put(mfp, hp, dirty, FALSE);
3412 error_block:
3413 mf_put(mfp, hp, FALSE, FALSE);
3414 error_noblock:
3416 * If action is ML_DELETE or ML_INSERT we have to correct the tree for
3417 * the incremented/decremented line counts, because there won't be a line
3418 * inserted/deleted after all.
3420 if (action == ML_DELETE)
3421 ml_lineadd(buf, 1);
3422 else if (action == ML_INSERT)
3423 ml_lineadd(buf, -1);
3424 buf->b_ml.ml_stack_top = 0;
3425 return NULL;
3429 * add an entry to the info pointer stack
3431 * return -1 for failure, number of the new entry otherwise
3433 static int
3434 ml_add_stack(buf)
3435 buf_T *buf;
3437 int top;
3438 infoptr_T *newstack;
3440 top = buf->b_ml.ml_stack_top;
3442 /* may have to increase the stack size */
3443 if (top == buf->b_ml.ml_stack_size)
3445 CHECK(top > 0, _("Stack size increases")); /* more than 5 levels??? */
3447 newstack = (infoptr_T *)alloc((unsigned)sizeof(infoptr_T) *
3448 (buf->b_ml.ml_stack_size + STACK_INCR));
3449 if (newstack == NULL)
3450 return -1;
3451 mch_memmove(newstack, buf->b_ml.ml_stack,
3452 (size_t)top * sizeof(infoptr_T));
3453 vim_free(buf->b_ml.ml_stack);
3454 buf->b_ml.ml_stack = newstack;
3455 buf->b_ml.ml_stack_size += STACK_INCR;
3458 buf->b_ml.ml_stack_top++;
3459 return top;
3463 * Update the pointer blocks on the stack for inserted/deleted lines.
3464 * The stack itself is also updated.
3466 * When a insert/delete line action fails, the line is not inserted/deleted,
3467 * but the pointer blocks have already been updated. That is fixed here by
3468 * walking through the stack.
3470 * Count is the number of lines added, negative if lines have been deleted.
3472 static void
3473 ml_lineadd(buf, count)
3474 buf_T *buf;
3475 int count;
3477 int idx;
3478 infoptr_T *ip;
3479 PTR_BL *pp;
3480 memfile_T *mfp = buf->b_ml.ml_mfp;
3481 bhdr_T *hp;
3483 for (idx = buf->b_ml.ml_stack_top - 1; idx >= 0; --idx)
3485 ip = &(buf->b_ml.ml_stack[idx]);
3486 if ((hp = mf_get(mfp, ip->ip_bnum, 1)) == NULL)
3487 break;
3488 pp = (PTR_BL *)(hp->bh_data); /* must be pointer block */
3489 if (pp->pb_id != PTR_ID)
3491 mf_put(mfp, hp, FALSE, FALSE);
3492 EMSG(_("E317: pointer block id wrong 2"));
3493 break;
3495 pp->pb_pointer[ip->ip_index].pe_line_count += count;
3496 ip->ip_high += count;
3497 mf_put(mfp, hp, TRUE, FALSE);
3501 #ifdef HAVE_READLINK
3502 static int resolve_symlink __ARGS((char_u *fname, char_u *buf));
3505 * Resolve a symlink in the last component of a file name.
3506 * Note that f_resolve() does it for every part of the path, we don't do that
3507 * here.
3508 * If it worked returns OK and the resolved link in "buf[MAXPATHL]".
3509 * Otherwise returns FAIL.
3511 static int
3512 resolve_symlink(fname, buf)
3513 char_u *fname;
3514 char_u *buf;
3516 char_u tmp[MAXPATHL];
3517 int ret;
3518 int depth = 0;
3520 if (fname == NULL)
3521 return FAIL;
3523 /* Put the result so far in tmp[], starting with the original name. */
3524 vim_strncpy(tmp, fname, MAXPATHL - 1);
3526 for (;;)
3528 /* Limit symlink depth to 100, catch recursive loops. */
3529 if (++depth == 100)
3531 EMSG2(_("E773: Symlink loop for \"%s\""), fname);
3532 return FAIL;
3535 ret = readlink((char *)tmp, (char *)buf, MAXPATHL - 1);
3536 if (ret <= 0)
3538 if (errno == EINVAL || errno == ENOENT)
3540 /* Found non-symlink or not existing file, stop here.
3541 * When at the first level use the unmodified name, skip the
3542 * call to vim_FullName(). */
3543 if (depth == 1)
3544 return FAIL;
3546 /* Use the resolved name in tmp[]. */
3547 break;
3550 /* There must be some error reading links, use original name. */
3551 return FAIL;
3553 buf[ret] = NUL;
3556 * Check whether the symlink is relative or absolute.
3557 * If it's relative, build a new path based on the directory
3558 * portion of the filename (if any) and the path the symlink
3559 * points to.
3561 if (mch_isFullName(buf))
3562 STRCPY(tmp, buf);
3563 else
3565 char_u *tail;
3567 tail = gettail(tmp);
3568 if (STRLEN(tail) + STRLEN(buf) >= MAXPATHL)
3569 return FAIL;
3570 STRCPY(tail, buf);
3575 * Try to resolve the full name of the file so that the swapfile name will
3576 * be consistent even when opening a relative symlink from different
3577 * working directories.
3579 return vim_FullName(tmp, buf, MAXPATHL, TRUE);
3581 #endif
3584 * Make swap file name out of the file name and a directory name.
3585 * Returns pointer to allocated memory or NULL.
3587 char_u *
3588 makeswapname(fname, ffname, buf, dir_name)
3589 char_u *fname;
3590 char_u *ffname UNUSED;
3591 buf_T *buf;
3592 char_u *dir_name;
3594 char_u *r, *s;
3595 #ifdef HAVE_READLINK
3596 char_u fname_buf[MAXPATHL];
3597 char_u *fname_res;
3598 #endif
3600 #if defined(UNIX) || defined(WIN3264) /* Need _very_ long file names */
3601 s = dir_name + STRLEN(dir_name);
3602 if (after_pathsep(dir_name, s) && s[-1] == s[-2])
3603 { /* Ends with '//', Use Full path */
3604 r = NULL;
3605 if ((s = make_percent_swname(dir_name, fname)) != NULL)
3607 r = modname(s, (char_u *)".swp", FALSE);
3608 vim_free(s);
3610 return r;
3612 #endif
3614 #ifdef HAVE_READLINK
3615 /* Expand symlink in the file name, so that we put the swap file with the
3616 * actual file instead of with the symlink. */
3617 if (resolve_symlink(fname, fname_buf) == OK)
3618 fname_res = fname_buf;
3619 else
3620 fname_res = fname;
3621 #endif
3623 r = buf_modname(
3624 #ifdef SHORT_FNAME
3625 TRUE,
3626 #else
3627 (buf->b_p_sn || buf->b_shortname),
3628 #endif
3629 #ifdef RISCOS
3630 /* Avoid problems if fname has special chars, eg <Wimp$Scrap> */
3631 ffname,
3632 #else
3633 # ifdef HAVE_READLINK
3634 fname_res,
3635 # else
3636 fname,
3637 # endif
3638 #endif
3639 (char_u *)
3640 #if defined(VMS) || defined(RISCOS)
3641 "_swp",
3642 #else
3643 ".swp",
3644 #endif
3645 #ifdef SHORT_FNAME /* always 8.3 file name */
3646 FALSE
3647 #else
3648 /* Prepend a '.' to the swap file name for the current directory. */
3649 dir_name[0] == '.' && dir_name[1] == NUL
3650 #endif
3652 if (r == NULL) /* out of memory */
3653 return NULL;
3655 s = get_file_in_dir(r, dir_name);
3656 vim_free(r);
3657 return s;
3661 * Get file name to use for swap file or backup file.
3662 * Use the name of the edited file "fname" and an entry in the 'dir' or 'bdir'
3663 * option "dname".
3664 * - If "dname" is ".", return "fname" (swap file in dir of file).
3665 * - If "dname" starts with "./", insert "dname" in "fname" (swap file
3666 * relative to dir of file).
3667 * - Otherwise, prepend "dname" to the tail of "fname" (swap file in specific
3668 * dir).
3670 * The return value is an allocated string and can be NULL.
3672 char_u *
3673 get_file_in_dir(fname, dname)
3674 char_u *fname;
3675 char_u *dname; /* don't use "dirname", it is a global for Alpha */
3677 char_u *t;
3678 char_u *tail;
3679 char_u *retval;
3680 int save_char;
3682 tail = gettail(fname);
3684 if (dname[0] == '.' && dname[1] == NUL)
3685 retval = vim_strsave(fname);
3686 else if (dname[0] == '.' && vim_ispathsep(dname[1]))
3688 if (tail == fname) /* no path before file name */
3689 retval = concat_fnames(dname + 2, tail, TRUE);
3690 else
3692 save_char = *tail;
3693 *tail = NUL;
3694 t = concat_fnames(fname, dname + 2, TRUE);
3695 *tail = save_char;
3696 if (t == NULL) /* out of memory */
3697 retval = NULL;
3698 else
3700 retval = concat_fnames(t, tail, TRUE);
3701 vim_free(t);
3705 else
3706 retval = concat_fnames(dname, tail, TRUE);
3708 return retval;
3711 static void attention_message __ARGS((buf_T *buf, char_u *fname));
3714 * Print the ATTENTION message: info about an existing swap file.
3716 static void
3717 attention_message(buf, fname)
3718 buf_T *buf; /* buffer being edited */
3719 char_u *fname; /* swap file name */
3721 struct stat st;
3722 time_t x, sx;
3723 char *p;
3725 ++no_wait_return;
3726 (void)EMSG(_("E325: ATTENTION"));
3727 MSG_PUTS(_("\nFound a swap file by the name \""));
3728 msg_home_replace(fname);
3729 MSG_PUTS("\"\n");
3730 sx = swapfile_info(fname);
3731 MSG_PUTS(_("While opening file \""));
3732 msg_outtrans(buf->b_fname);
3733 MSG_PUTS("\"\n");
3734 if (mch_stat((char *)buf->b_fname, &st) != -1)
3736 MSG_PUTS(_(" dated: "));
3737 x = st.st_mtime; /* Manx C can't do &st.st_mtime */
3738 p = ctime(&x); /* includes '\n' */
3739 if (p == NULL)
3740 MSG_PUTS("(invalid)\n");
3741 else
3742 MSG_PUTS(p);
3743 if (sx != 0 && x > sx)
3744 MSG_PUTS(_(" NEWER than swap file!\n"));
3746 /* Some of these messages are long to allow translation to
3747 * other languages. */
3748 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"));
3749 MSG_PUTS(_(" Quit, or continue with caution.\n"));
3750 MSG_PUTS(_("\n(2) An edit session for this file crashed.\n"));
3751 MSG_PUTS(_(" If this is the case, use \":recover\" or \"vim -r "));
3752 msg_outtrans(buf->b_fname);
3753 MSG_PUTS(_("\"\n to recover the changes (see \":help recovery\").\n"));
3754 MSG_PUTS(_(" If you did this already, delete the swap file \""));
3755 msg_outtrans(fname);
3756 MSG_PUTS(_("\"\n to avoid this message.\n"));
3757 cmdline_row = msg_row;
3758 --no_wait_return;
3761 #ifdef FEAT_AUTOCMD
3762 static int do_swapexists __ARGS((buf_T *buf, char_u *fname));
3765 * Trigger the SwapExists autocommands.
3766 * Returns a value for equivalent to do_dialog() (see below):
3767 * 0: still need to ask for a choice
3768 * 1: open read-only
3769 * 2: edit anyway
3770 * 3: recover
3771 * 4: delete it
3772 * 5: quit
3773 * 6: abort
3775 static int
3776 do_swapexists(buf, fname)
3777 buf_T *buf;
3778 char_u *fname;
3780 set_vim_var_string(VV_SWAPNAME, fname, -1);
3781 set_vim_var_string(VV_SWAPCHOICE, NULL, -1);
3783 /* Trigger SwapExists autocommands with <afile> set to the file being
3784 * edited. Disallow changing directory here. */
3785 ++allbuf_lock;
3786 apply_autocmds(EVENT_SWAPEXISTS, buf->b_fname, NULL, FALSE, NULL);
3787 --allbuf_lock;
3789 set_vim_var_string(VV_SWAPNAME, NULL, -1);
3791 switch (*get_vim_var_str(VV_SWAPCHOICE))
3793 case 'o': return 1;
3794 case 'e': return 2;
3795 case 'r': return 3;
3796 case 'd': return 4;
3797 case 'q': return 5;
3798 case 'a': return 6;
3801 return 0;
3803 #endif
3806 * Find out what name to use for the swap file for buffer 'buf'.
3808 * Several names are tried to find one that does not exist
3809 * Returns the name in allocated memory or NULL.
3811 * Note: If BASENAMELEN is not correct, you will get error messages for
3812 * not being able to open the swapfile
3813 * Note: May trigger SwapExists autocmd, pointers may change!
3815 static char_u *
3816 findswapname(buf, dirp, old_fname)
3817 buf_T *buf;
3818 char_u **dirp; /* pointer to list of directories */
3819 char_u *old_fname; /* don't give warning for this file name */
3821 char_u *fname;
3822 int n;
3823 char_u *dir_name;
3824 #ifdef AMIGA
3825 BPTR fh;
3826 #endif
3827 #ifndef SHORT_FNAME
3828 int r;
3829 #endif
3831 #if !defined(SHORT_FNAME) \
3832 && ((!defined(UNIX) && !defined(OS2)) || defined(ARCHIE))
3833 # define CREATE_DUMMY_FILE
3834 FILE *dummyfd = NULL;
3837 * If we start editing a new file, e.g. "test.doc", which resides on an MSDOS
3838 * compatible filesystem, it is possible that the file "test.doc.swp" which we
3839 * create will be exactly the same file. To avoid this problem we temporarily
3840 * create "test.doc".
3841 * Don't do this when the check below for a 8.3 file name is used.
3843 if (!(buf->b_p_sn || buf->b_shortname) && buf->b_fname != NULL
3844 && mch_getperm(buf->b_fname) < 0)
3845 dummyfd = mch_fopen((char *)buf->b_fname, "w");
3846 #endif
3849 * Isolate a directory name from *dirp and put it in dir_name.
3850 * First allocate some memory to put the directory name in.
3852 dir_name = alloc((unsigned)STRLEN(*dirp) + 1);
3853 if (dir_name != NULL)
3854 (void)copy_option_part(dirp, dir_name, 31000, ",");
3857 * we try different names until we find one that does not exist yet
3859 if (dir_name == NULL) /* out of memory */
3860 fname = NULL;
3861 else
3862 fname = makeswapname(buf->b_fname, buf->b_ffname, buf, dir_name);
3864 for (;;)
3866 if (fname == NULL) /* must be out of memory */
3867 break;
3868 if ((n = (int)STRLEN(fname)) == 0) /* safety check */
3870 vim_free(fname);
3871 fname = NULL;
3872 break;
3874 #if (defined(UNIX) || defined(OS2)) && !defined(ARCHIE) && !defined(SHORT_FNAME)
3876 * Some systems have a MS-DOS compatible filesystem that use 8.3 character
3877 * file names. If this is the first try and the swap file name does not fit in
3878 * 8.3, detect if this is the case, set shortname and try again.
3880 if (fname[n - 2] == 'w' && fname[n - 1] == 'p'
3881 && !(buf->b_p_sn || buf->b_shortname))
3883 char_u *tail;
3884 char_u *fname2;
3885 struct stat s1, s2;
3886 int f1, f2;
3887 int created1 = FALSE, created2 = FALSE;
3888 int same = FALSE;
3891 * Check if swapfile name does not fit in 8.3:
3892 * It either contains two dots, is longer than 8 chars, or starts
3893 * with a dot.
3895 tail = gettail(buf->b_fname);
3896 if ( vim_strchr(tail, '.') != NULL
3897 || STRLEN(tail) > (size_t)8
3898 || *gettail(fname) == '.')
3900 fname2 = alloc(n + 2);
3901 if (fname2 != NULL)
3903 STRCPY(fname2, fname);
3904 /* if fname == "xx.xx.swp", fname2 = "xx.xx.swx"
3905 * if fname == ".xx.swp", fname2 = ".xx.swpx"
3906 * if fname == "123456789.swp", fname2 = "12345678x.swp"
3908 if (vim_strchr(tail, '.') != NULL)
3909 fname2[n - 1] = 'x';
3910 else if (*gettail(fname) == '.')
3912 fname2[n] = 'x';
3913 fname2[n + 1] = NUL;
3915 else
3916 fname2[n - 5] += 1;
3918 * may need to create the files to be able to use mch_stat()
3920 f1 = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
3921 if (f1 < 0)
3923 f1 = mch_open_rw((char *)fname,
3924 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3925 #if defined(OS2)
3926 if (f1 < 0 && errno == ENOENT)
3927 same = TRUE;
3928 #endif
3929 created1 = TRUE;
3931 if (f1 >= 0)
3933 f2 = mch_open((char *)fname2, O_RDONLY | O_EXTRA, 0);
3934 if (f2 < 0)
3936 f2 = mch_open_rw((char *)fname2,
3937 O_RDWR|O_CREAT|O_EXCL|O_EXTRA);
3938 created2 = TRUE;
3940 if (f2 >= 0)
3943 * Both files exist now. If mch_stat() returns the
3944 * same device and inode they are the same file.
3946 if (mch_fstat(f1, &s1) != -1
3947 && mch_fstat(f2, &s2) != -1
3948 && s1.st_dev == s2.st_dev
3949 && s1.st_ino == s2.st_ino)
3950 same = TRUE;
3951 close(f2);
3952 if (created2)
3953 mch_remove(fname2);
3955 close(f1);
3956 if (created1)
3957 mch_remove(fname);
3959 vim_free(fname2);
3960 if (same)
3962 buf->b_shortname = TRUE;
3963 vim_free(fname);
3964 fname = makeswapname(buf->b_fname, buf->b_ffname,
3965 buf, dir_name);
3966 continue; /* try again with b_shortname set */
3971 #endif
3973 * check if the swapfile already exists
3975 if (mch_getperm(fname) < 0) /* it does not exist */
3977 #ifdef HAVE_LSTAT
3978 struct stat sb;
3981 * Extra security check: When a swap file is a symbolic link, this
3982 * is most likely a symlink attack.
3984 if (mch_lstat((char *)fname, &sb) < 0)
3985 #else
3986 # ifdef AMIGA
3987 fh = Open((UBYTE *)fname, (long)MODE_NEWFILE);
3989 * on the Amiga mch_getperm() will return -1 when the file exists
3990 * but is being used by another program. This happens if you edit
3991 * a file twice.
3993 if (fh != (BPTR)NULL) /* can open file, OK */
3995 Close(fh);
3996 mch_remove(fname);
3997 break;
3999 if (IoErr() != ERROR_OBJECT_IN_USE
4000 && IoErr() != ERROR_OBJECT_EXISTS)
4001 # endif
4002 #endif
4003 break;
4007 * A file name equal to old_fname is OK to use.
4009 if (old_fname != NULL && fnamecmp(fname, old_fname) == 0)
4010 break;
4013 * get here when file already exists
4015 if (fname[n - 2] == 'w' && fname[n - 1] == 'p') /* first try */
4017 #ifndef SHORT_FNAME
4019 * on MS-DOS compatible filesystems (e.g. messydos) file.doc.swp
4020 * and file.doc are the same file. To guess if this problem is
4021 * present try if file.doc.swx exists. If it does, we set
4022 * buf->b_shortname and try file_doc.swp (dots replaced by
4023 * underscores for this file), and try again. If it doesn't we
4024 * assume that "file.doc.swp" already exists.
4026 if (!(buf->b_p_sn || buf->b_shortname)) /* not tried yet */
4028 fname[n - 1] = 'x';
4029 r = mch_getperm(fname); /* try "file.swx" */
4030 fname[n - 1] = 'p';
4031 if (r >= 0) /* "file.swx" seems to exist */
4033 buf->b_shortname = TRUE;
4034 vim_free(fname);
4035 fname = makeswapname(buf->b_fname, buf->b_ffname,
4036 buf, dir_name);
4037 continue; /* try again with '.' replaced with '_' */
4040 #endif
4042 * If we get here the ".swp" file really exists.
4043 * Give an error message, unless recovering, no file name, we are
4044 * viewing a help file or when the path of the file is different
4045 * (happens when all .swp files are in one directory).
4047 if (!recoverymode && buf->b_fname != NULL
4048 && !buf->b_help && !(buf->b_flags & BF_DUMMY))
4050 int fd;
4051 struct block0 b0;
4052 int differ = FALSE;
4055 * Try to read block 0 from the swap file to get the original
4056 * file name (and inode number).
4058 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
4059 if (fd >= 0)
4061 if (read(fd, (char *)&b0, sizeof(b0)) == sizeof(b0))
4064 * If the swapfile has the same directory as the
4065 * buffer don't compare the directory names, they can
4066 * have a different mountpoint.
4068 if (b0.b0_flags & B0_SAME_DIR)
4070 if (fnamecmp(gettail(buf->b_ffname),
4071 gettail(b0.b0_fname)) != 0
4072 || !same_directory(fname, buf->b_ffname))
4074 #ifdef CHECK_INODE
4075 /* Symlinks may point to the same file even
4076 * when the name differs, need to check the
4077 * inode too. */
4078 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4079 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4080 char_to_long(b0.b0_ino)))
4081 #endif
4082 differ = TRUE;
4085 else
4088 * The name in the swap file may be
4089 * "~user/path/file". Expand it first.
4091 expand_env(b0.b0_fname, NameBuff, MAXPATHL);
4092 #ifdef CHECK_INODE
4093 if (fnamecmp_ino(buf->b_ffname, NameBuff,
4094 char_to_long(b0.b0_ino)))
4095 differ = TRUE;
4096 #else
4097 if (fnamecmp(NameBuff, buf->b_ffname) != 0)
4098 differ = TRUE;
4099 #endif
4102 close(fd);
4104 #ifdef RISCOS
4105 else
4106 /* Can't open swap file, though it does exist.
4107 * Assume that the user is editing two files with
4108 * the same name in different directories. No error.
4110 differ = TRUE;
4111 #endif
4113 /* give the ATTENTION message when there is an old swap file
4114 * for the current file, and the buffer was not recovered. */
4115 if (differ == FALSE && !(curbuf->b_flags & BF_RECOVERED)
4116 && vim_strchr(p_shm, SHM_ATTENTION) == NULL)
4118 #if defined(HAS_SWAP_EXISTS_ACTION)
4119 int choice = 0;
4120 #endif
4121 #ifdef CREATE_DUMMY_FILE
4122 int did_use_dummy = FALSE;
4124 /* Avoid getting a warning for the file being created
4125 * outside of Vim, it was created at the start of this
4126 * function. Delete the file now, because Vim might exit
4127 * here if the window is closed. */
4128 if (dummyfd != NULL)
4130 fclose(dummyfd);
4131 dummyfd = NULL;
4132 mch_remove(buf->b_fname);
4133 did_use_dummy = TRUE;
4135 #endif
4137 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) && (defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG))
4138 process_still_running = FALSE;
4139 #endif
4140 #ifdef FEAT_AUTOCMD
4142 * If there is an SwapExists autocommand and we can handle
4143 * the response, trigger it. It may return 0 to ask the
4144 * user anyway.
4146 if (swap_exists_action != SEA_NONE
4147 && has_autocmd(EVENT_SWAPEXISTS, buf->b_fname, buf))
4148 choice = do_swapexists(buf, fname);
4150 if (choice == 0)
4151 #endif
4153 #ifdef FEAT_GUI
4154 /* If we are supposed to start the GUI but it wasn't
4155 * completely started yet, start it now. This makes
4156 * the messages displayed in the Vim window when
4157 * loading a session from the .gvimrc file. */
4158 if (gui.starting && !gui.in_use)
4159 gui_start();
4160 #endif
4161 /* Show info about the existing swap file. */
4162 attention_message(buf, fname);
4164 /* We don't want a 'q' typed at the more-prompt
4165 * interrupt loading a file. */
4166 got_int = FALSE;
4169 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
4170 if (swap_exists_action != SEA_NONE && choice == 0)
4172 char_u *name;
4174 name = alloc((unsigned)(STRLEN(fname)
4175 + STRLEN(_("Swap file \""))
4176 + STRLEN(_("\" already exists!")) + 5));
4177 if (name != NULL)
4179 STRCPY(name, _("Swap file \""));
4180 home_replace(NULL, fname, name + STRLEN(name),
4181 1000, TRUE);
4182 STRCAT(name, _("\" already exists!"));
4184 choice = do_dialog(VIM_WARNING,
4185 (char_u *)_("VIM - ATTENTION"),
4186 name == NULL
4187 ? (char_u *)_("Swap file already exists!")
4188 : name,
4189 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4190 process_still_running
4191 ? (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Quit\n&Abort") :
4192 # endif
4193 (char_u *)_("&Open Read-Only\n&Edit anyway\n&Recover\n&Delete it\n&Quit\n&Abort"), 1, NULL);
4195 # if defined(UNIX) || defined(__EMX__) || defined(VMS)
4196 if (process_still_running && choice >= 4)
4197 choice++; /* Skip missing "Delete it" button */
4198 # endif
4199 vim_free(name);
4201 /* pretend screen didn't scroll, need redraw anyway */
4202 msg_scrolled = 0;
4203 redraw_all_later(NOT_VALID);
4205 #endif
4207 #if defined(HAS_SWAP_EXISTS_ACTION)
4208 if (choice > 0)
4210 switch (choice)
4212 case 1:
4213 buf->b_p_ro = TRUE;
4214 break;
4215 case 2:
4216 break;
4217 case 3:
4218 swap_exists_action = SEA_RECOVER;
4219 break;
4220 case 4:
4221 mch_remove(fname);
4222 break;
4223 case 5:
4224 swap_exists_action = SEA_QUIT;
4225 break;
4226 case 6:
4227 swap_exists_action = SEA_QUIT;
4228 got_int = TRUE;
4229 break;
4232 /* If the file was deleted this fname can be used. */
4233 if (mch_getperm(fname) < 0)
4234 break;
4236 else
4237 #endif
4239 MSG_PUTS("\n");
4240 if (msg_silent == 0)
4241 /* call wait_return() later */
4242 need_wait_return = TRUE;
4245 #ifdef CREATE_DUMMY_FILE
4246 /* Going to try another name, need the dummy file again. */
4247 if (did_use_dummy)
4248 dummyfd = mch_fopen((char *)buf->b_fname, "w");
4249 #endif
4255 * Change the ".swp" extension to find another file that can be used.
4256 * First decrement the last char: ".swo", ".swn", etc.
4257 * If that still isn't enough decrement the last but one char: ".svz"
4258 * Can happen when editing many "No Name" buffers.
4260 if (fname[n - 1] == 'a') /* ".s?a" */
4262 if (fname[n - 2] == 'a') /* ".saa": tried enough, give up */
4264 EMSG(_("E326: Too many swap files found"));
4265 vim_free(fname);
4266 fname = NULL;
4267 break;
4269 --fname[n - 2]; /* ".svz", ".suz", etc. */
4270 fname[n - 1] = 'z' + 1;
4272 --fname[n - 1]; /* ".swo", ".swn", etc. */
4275 vim_free(dir_name);
4276 #ifdef CREATE_DUMMY_FILE
4277 if (dummyfd != NULL) /* file has been created temporarily */
4279 fclose(dummyfd);
4280 mch_remove(buf->b_fname);
4282 #endif
4283 return fname;
4286 static int
4287 b0_magic_wrong(b0p)
4288 ZERO_BL *b0p;
4290 return (b0p->b0_magic_long != (long)B0_MAGIC_LONG
4291 || b0p->b0_magic_int != (int)B0_MAGIC_INT
4292 || b0p->b0_magic_short != (short)B0_MAGIC_SHORT
4293 || b0p->b0_magic_char != B0_MAGIC_CHAR);
4296 #ifdef CHECK_INODE
4298 * Compare current file name with file name from swap file.
4299 * Try to use inode numbers when possible.
4300 * Return non-zero when files are different.
4302 * When comparing file names a few things have to be taken into consideration:
4303 * - When working over a network the full path of a file depends on the host.
4304 * We check the inode number if possible. It is not 100% reliable though,
4305 * because the device number cannot be used over a network.
4306 * - When a file does not exist yet (editing a new file) there is no inode
4307 * number.
4308 * - The file name in a swap file may not be valid on the current host. The
4309 * "~user" form is used whenever possible to avoid this.
4311 * This is getting complicated, let's make a table:
4313 * ino_c ino_s fname_c fname_s differ =
4315 * both files exist -> compare inode numbers:
4316 * != 0 != 0 X X ino_c != ino_s
4318 * inode number(s) unknown, file names available -> compare file names
4319 * == 0 X OK OK fname_c != fname_s
4320 * X == 0 OK OK fname_c != fname_s
4322 * current file doesn't exist, file for swap file exist, file name(s) not
4323 * available -> probably different
4324 * == 0 != 0 FAIL X TRUE
4325 * == 0 != 0 X FAIL TRUE
4327 * current file exists, inode for swap unknown, file name(s) not
4328 * available -> probably different
4329 * != 0 == 0 FAIL X TRUE
4330 * != 0 == 0 X FAIL TRUE
4332 * current file doesn't exist, inode for swap unknown, one file name not
4333 * available -> probably different
4334 * == 0 == 0 FAIL OK TRUE
4335 * == 0 == 0 OK FAIL TRUE
4337 * current file doesn't exist, inode for swap unknown, both file names not
4338 * available -> probably same file
4339 * == 0 == 0 FAIL FAIL FALSE
4341 * Note that when the ino_t is 64 bits, only the last 32 will be used. This
4342 * can't be changed without making the block 0 incompatible with 32 bit
4343 * versions.
4346 static int
4347 fnamecmp_ino(fname_c, fname_s, ino_block0)
4348 char_u *fname_c; /* current file name */
4349 char_u *fname_s; /* file name from swap file */
4350 long ino_block0;
4352 struct stat st;
4353 ino_t ino_c = 0; /* ino of current file */
4354 ino_t ino_s; /* ino of file from swap file */
4355 char_u buf_c[MAXPATHL]; /* full path of fname_c */
4356 char_u buf_s[MAXPATHL]; /* full path of fname_s */
4357 int retval_c; /* flag: buf_c valid */
4358 int retval_s; /* flag: buf_s valid */
4360 if (mch_stat((char *)fname_c, &st) == 0)
4361 ino_c = (ino_t)st.st_ino;
4364 * First we try to get the inode from the file name, because the inode in
4365 * the swap file may be outdated. If that fails (e.g. this path is not
4366 * valid on this machine), use the inode from block 0.
4368 if (mch_stat((char *)fname_s, &st) == 0)
4369 ino_s = (ino_t)st.st_ino;
4370 else
4371 ino_s = (ino_t)ino_block0;
4373 if (ino_c && ino_s)
4374 return (ino_c != ino_s);
4377 * One of the inode numbers is unknown, try a forced vim_FullName() and
4378 * compare the file names.
4380 retval_c = vim_FullName(fname_c, buf_c, MAXPATHL, TRUE);
4381 retval_s = vim_FullName(fname_s, buf_s, MAXPATHL, TRUE);
4382 if (retval_c == OK && retval_s == OK)
4383 return (STRCMP(buf_c, buf_s) != 0);
4386 * Can't compare inodes or file names, guess that the files are different,
4387 * unless both appear not to exist at all.
4389 if (ino_s == 0 && ino_c == 0 && retval_c == FAIL && retval_s == FAIL)
4390 return FALSE;
4391 return TRUE;
4393 #endif /* CHECK_INODE */
4396 * Move a long integer into a four byte character array.
4397 * Used for machine independency in block zero.
4399 static void
4400 long_to_char(n, s)
4401 long n;
4402 char_u *s;
4404 s[0] = (char_u)(n & 0xff);
4405 n = (unsigned)n >> 8;
4406 s[1] = (char_u)(n & 0xff);
4407 n = (unsigned)n >> 8;
4408 s[2] = (char_u)(n & 0xff);
4409 n = (unsigned)n >> 8;
4410 s[3] = (char_u)(n & 0xff);
4413 static long
4414 char_to_long(s)
4415 char_u *s;
4417 long retval;
4419 retval = s[3];
4420 retval <<= 8;
4421 retval |= s[2];
4422 retval <<= 8;
4423 retval |= s[1];
4424 retval <<= 8;
4425 retval |= s[0];
4427 return retval;
4431 * Set the flags in the first block of the swap file:
4432 * - file is modified or not: buf->b_changed
4433 * - 'fileformat'
4434 * - 'fileencoding'
4436 void
4437 ml_setflags(buf)
4438 buf_T *buf;
4440 bhdr_T *hp;
4441 ZERO_BL *b0p;
4443 if (!buf->b_ml.ml_mfp)
4444 return;
4445 for (hp = buf->b_ml.ml_mfp->mf_used_last; hp != NULL; hp = hp->bh_prev)
4447 if (hp->bh_bnum == 0)
4449 b0p = (ZERO_BL *)(hp->bh_data);
4450 b0p->b0_dirty = buf->b_changed ? B0_DIRTY : 0;
4451 b0p->b0_flags = (b0p->b0_flags & ~B0_FF_MASK)
4452 | (get_fileformat(buf) + 1);
4453 #ifdef FEAT_MBYTE
4454 add_b0_fenc(b0p, buf);
4455 #endif
4456 hp->bh_flags |= BH_DIRTY;
4457 mf_sync(buf->b_ml.ml_mfp, MFS_ZERO);
4458 break;
4463 #if defined(FEAT_BYTEOFF) || defined(PROTO)
4465 #define MLCS_MAXL 800 /* max no of lines in chunk */
4466 #define MLCS_MINL 400 /* should be half of MLCS_MAXL */
4469 * Keep information for finding byte offset of a line, updtytpe may be one of:
4470 * ML_CHNK_ADDLINE: Add len to parent chunk, possibly splitting it
4471 * Careful: ML_CHNK_ADDLINE may cause ml_find_line() to be called.
4472 * ML_CHNK_DELLINE: Subtract len from parent chunk, possibly deleting it
4473 * ML_CHNK_UPDLINE: Add len to parent chunk, as a signed entity.
4475 static void
4476 ml_updatechunk(buf, line, len, updtype)
4477 buf_T *buf;
4478 linenr_T line;
4479 long len;
4480 int updtype;
4482 static buf_T *ml_upd_lastbuf = NULL;
4483 static linenr_T ml_upd_lastline;
4484 static linenr_T ml_upd_lastcurline;
4485 static int ml_upd_lastcurix;
4487 linenr_T curline = ml_upd_lastcurline;
4488 int curix = ml_upd_lastcurix;
4489 long size;
4490 chunksize_T *curchnk;
4491 int rest;
4492 bhdr_T *hp;
4493 DATA_BL *dp;
4495 if (buf->b_ml.ml_usedchunks == -1 || len == 0)
4496 return;
4497 if (buf->b_ml.ml_chunksize == NULL)
4499 buf->b_ml.ml_chunksize = (chunksize_T *)
4500 alloc((unsigned)sizeof(chunksize_T) * 100);
4501 if (buf->b_ml.ml_chunksize == NULL)
4503 buf->b_ml.ml_usedchunks = -1;
4504 return;
4506 buf->b_ml.ml_numchunks = 100;
4507 buf->b_ml.ml_usedchunks = 1;
4508 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4509 buf->b_ml.ml_chunksize[0].mlcs_totalsize = 1;
4512 if (updtype == ML_CHNK_UPDLINE && buf->b_ml.ml_line_count == 1)
4515 * First line in empty buffer from ml_flush_line() -- reset
4517 buf->b_ml.ml_usedchunks = 1;
4518 buf->b_ml.ml_chunksize[0].mlcs_numlines = 1;
4519 buf->b_ml.ml_chunksize[0].mlcs_totalsize =
4520 (long)STRLEN(buf->b_ml.ml_line_ptr) + 1;
4521 return;
4525 * Find chunk that our line belongs to, curline will be at start of the
4526 * chunk.
4528 if (buf != ml_upd_lastbuf || line != ml_upd_lastline + 1
4529 || updtype != ML_CHNK_ADDLINE)
4531 for (curline = 1, curix = 0;
4532 curix < buf->b_ml.ml_usedchunks - 1
4533 && line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4534 curix++)
4536 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4539 else if (line >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines
4540 && curix < buf->b_ml.ml_usedchunks - 1)
4542 /* Adjust cached curix & curline */
4543 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4544 curix++;
4546 curchnk = buf->b_ml.ml_chunksize + curix;
4548 if (updtype == ML_CHNK_DELLINE)
4549 len = -len;
4550 curchnk->mlcs_totalsize += len;
4551 if (updtype == ML_CHNK_ADDLINE)
4553 curchnk->mlcs_numlines++;
4555 /* May resize here so we don't have to do it in both cases below */
4556 if (buf->b_ml.ml_usedchunks + 1 >= buf->b_ml.ml_numchunks)
4558 buf->b_ml.ml_numchunks = buf->b_ml.ml_numchunks * 3 / 2;
4559 buf->b_ml.ml_chunksize = (chunksize_T *)
4560 vim_realloc(buf->b_ml.ml_chunksize,
4561 sizeof(chunksize_T) * buf->b_ml.ml_numchunks);
4562 if (buf->b_ml.ml_chunksize == NULL)
4564 /* Hmmmm, Give up on offset for this buffer */
4565 buf->b_ml.ml_usedchunks = -1;
4566 return;
4570 if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MAXL)
4572 int count; /* number of entries in block */
4573 int idx;
4574 int text_end;
4575 int linecnt;
4577 mch_memmove(buf->b_ml.ml_chunksize + curix + 1,
4578 buf->b_ml.ml_chunksize + curix,
4579 (buf->b_ml.ml_usedchunks - curix) *
4580 sizeof(chunksize_T));
4581 /* Compute length of first half of lines in the split chunk */
4582 size = 0;
4583 linecnt = 0;
4584 while (curline < buf->b_ml.ml_line_count
4585 && linecnt < MLCS_MINL)
4587 if ((hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4589 buf->b_ml.ml_usedchunks = -1;
4590 return;
4592 dp = (DATA_BL *)(hp->bh_data);
4593 count = (long)(buf->b_ml.ml_locked_high) -
4594 (long)(buf->b_ml.ml_locked_low) + 1;
4595 idx = curline - buf->b_ml.ml_locked_low;
4596 curline = buf->b_ml.ml_locked_high + 1;
4597 if (idx == 0)/* first line in block, text at the end */
4598 text_end = dp->db_txt_end;
4599 else
4600 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4601 /* Compute index of last line to use in this MEMLINE */
4602 rest = count - idx;
4603 if (linecnt + rest > MLCS_MINL)
4605 idx += MLCS_MINL - linecnt - 1;
4606 linecnt = MLCS_MINL;
4608 else
4610 idx = count - 1;
4611 linecnt += rest;
4613 size += text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4615 buf->b_ml.ml_chunksize[curix].mlcs_numlines = linecnt;
4616 buf->b_ml.ml_chunksize[curix + 1].mlcs_numlines -= linecnt;
4617 buf->b_ml.ml_chunksize[curix].mlcs_totalsize = size;
4618 buf->b_ml.ml_chunksize[curix + 1].mlcs_totalsize -= size;
4619 buf->b_ml.ml_usedchunks++;
4620 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4621 return;
4623 else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
4624 && curix == buf->b_ml.ml_usedchunks - 1
4625 && buf->b_ml.ml_line_count - line <= 1)
4628 * We are in the last chunk and it is cheap to crate a new one
4629 * after this. Do it now to avoid the loop above later on
4631 curchnk = buf->b_ml.ml_chunksize + curix + 1;
4632 buf->b_ml.ml_usedchunks++;
4633 if (line == buf->b_ml.ml_line_count)
4635 curchnk->mlcs_numlines = 0;
4636 curchnk->mlcs_totalsize = 0;
4638 else
4641 * Line is just prior to last, move count for last
4642 * This is the common case when loading a new file
4644 hp = ml_find_line(buf, buf->b_ml.ml_line_count, ML_FIND);
4645 if (hp == NULL)
4647 buf->b_ml.ml_usedchunks = -1;
4648 return;
4650 dp = (DATA_BL *)(hp->bh_data);
4651 if (dp->db_line_count == 1)
4652 rest = dp->db_txt_end - dp->db_txt_start;
4653 else
4654 rest =
4655 ((dp->db_index[dp->db_line_count - 2]) & DB_INDEX_MASK)
4656 - dp->db_txt_start;
4657 curchnk->mlcs_totalsize = rest;
4658 curchnk->mlcs_numlines = 1;
4659 curchnk[-1].mlcs_totalsize -= rest;
4660 curchnk[-1].mlcs_numlines -= 1;
4664 else if (updtype == ML_CHNK_DELLINE)
4666 curchnk->mlcs_numlines--;
4667 ml_upd_lastbuf = NULL; /* Force recalc of curix & curline */
4668 if (curix < (buf->b_ml.ml_usedchunks - 1)
4669 && (curchnk->mlcs_numlines + curchnk[1].mlcs_numlines)
4670 <= MLCS_MINL)
4672 curix++;
4673 curchnk = buf->b_ml.ml_chunksize + curix;
4675 else if (curix == 0 && curchnk->mlcs_numlines <= 0)
4677 buf->b_ml.ml_usedchunks--;
4678 mch_memmove(buf->b_ml.ml_chunksize, buf->b_ml.ml_chunksize + 1,
4679 buf->b_ml.ml_usedchunks * sizeof(chunksize_T));
4680 return;
4682 else if (curix == 0 || (curchnk->mlcs_numlines > 10
4683 && (curchnk->mlcs_numlines + curchnk[-1].mlcs_numlines)
4684 > MLCS_MINL))
4686 return;
4689 /* Collapse chunks */
4690 curchnk[-1].mlcs_numlines += curchnk->mlcs_numlines;
4691 curchnk[-1].mlcs_totalsize += curchnk->mlcs_totalsize;
4692 buf->b_ml.ml_usedchunks--;
4693 if (curix < buf->b_ml.ml_usedchunks)
4695 mch_memmove(buf->b_ml.ml_chunksize + curix,
4696 buf->b_ml.ml_chunksize + curix + 1,
4697 (buf->b_ml.ml_usedchunks - curix) *
4698 sizeof(chunksize_T));
4700 return;
4702 ml_upd_lastbuf = buf;
4703 ml_upd_lastline = line;
4704 ml_upd_lastcurline = curline;
4705 ml_upd_lastcurix = curix;
4709 * Find offset for line or line with offset.
4710 * Find line with offset if "lnum" is 0; return remaining offset in offp
4711 * Find offset of line if "lnum" > 0
4712 * return -1 if information is not available
4714 long
4715 ml_find_line_or_offset(buf, lnum, offp)
4716 buf_T *buf;
4717 linenr_T lnum;
4718 long *offp;
4720 linenr_T curline;
4721 int curix;
4722 long size;
4723 bhdr_T *hp;
4724 DATA_BL *dp;
4725 int count; /* number of entries in block */
4726 int idx;
4727 int start_idx;
4728 int text_end;
4729 long offset;
4730 int len;
4731 int ffdos = (get_fileformat(buf) == EOL_DOS);
4732 int extra = 0;
4734 /* take care of cached line first */
4735 ml_flush_line(curbuf);
4737 if (buf->b_ml.ml_usedchunks == -1
4738 || buf->b_ml.ml_chunksize == NULL
4739 || lnum < 0)
4740 return -1;
4742 if (offp == NULL)
4743 offset = 0;
4744 else
4745 offset = *offp;
4746 if (lnum == 0 && offset <= 0)
4747 return 1; /* Not a "find offset" and offset 0 _must_ be in line 1 */
4749 * Find the last chunk before the one containing our line. Last chunk is
4750 * special because it will never qualify
4752 curline = 1;
4753 curix = size = 0;
4754 while (curix < buf->b_ml.ml_usedchunks - 1
4755 && ((lnum != 0
4756 && lnum >= curline + buf->b_ml.ml_chunksize[curix].mlcs_numlines)
4757 || (offset != 0
4758 && offset > size + buf->b_ml.ml_chunksize[curix].mlcs_totalsize
4759 + ffdos * buf->b_ml.ml_chunksize[curix].mlcs_numlines)))
4761 curline += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4762 size += buf->b_ml.ml_chunksize[curix].mlcs_totalsize;
4763 if (offset && ffdos)
4764 size += buf->b_ml.ml_chunksize[curix].mlcs_numlines;
4765 curix++;
4768 while ((lnum != 0 && curline < lnum) || (offset != 0 && size < offset))
4770 if (curline > buf->b_ml.ml_line_count
4771 || (hp = ml_find_line(buf, curline, ML_FIND)) == NULL)
4772 return -1;
4773 dp = (DATA_BL *)(hp->bh_data);
4774 count = (long)(buf->b_ml.ml_locked_high) -
4775 (long)(buf->b_ml.ml_locked_low) + 1;
4776 start_idx = idx = curline - buf->b_ml.ml_locked_low;
4777 if (idx == 0)/* first line in block, text at the end */
4778 text_end = dp->db_txt_end;
4779 else
4780 text_end = ((dp->db_index[idx - 1]) & DB_INDEX_MASK);
4781 /* Compute index of last line to use in this MEMLINE */
4782 if (lnum != 0)
4784 if (curline + (count - idx) >= lnum)
4785 idx += lnum - curline - 1;
4786 else
4787 idx = count - 1;
4789 else
4791 extra = 0;
4792 while (offset >= size
4793 + text_end - (int)((dp->db_index[idx]) & DB_INDEX_MASK)
4794 + ffdos)
4796 if (ffdos)
4797 size++;
4798 if (idx == count - 1)
4800 extra = 1;
4801 break;
4803 idx++;
4806 len = text_end - ((dp->db_index[idx]) & DB_INDEX_MASK);
4807 size += len;
4808 if (offset != 0 && size >= offset)
4810 if (size + ffdos == offset)
4811 *offp = 0;
4812 else if (idx == start_idx)
4813 *offp = offset - size + len;
4814 else
4815 *offp = offset - size + len
4816 - (text_end - ((dp->db_index[idx - 1]) & DB_INDEX_MASK));
4817 curline += idx - start_idx + extra;
4818 if (curline > buf->b_ml.ml_line_count)
4819 return -1; /* exactly one byte beyond the end */
4820 return curline;
4822 curline = buf->b_ml.ml_locked_high + 1;
4825 if (lnum != 0)
4827 /* Count extra CR characters. */
4828 if (ffdos)
4829 size += lnum - 1;
4831 /* Don't count the last line break if 'bin' and 'noeol'. */
4832 if (buf->b_p_bin && !buf->b_p_eol)
4833 size -= ffdos + 1;
4836 return size;
4840 * Goto byte in buffer with offset 'cnt'.
4842 void
4843 goto_byte(cnt)
4844 long cnt;
4846 long boff = cnt;
4847 linenr_T lnum;
4849 ml_flush_line(curbuf); /* cached line may be dirty */
4850 setpcmark();
4851 if (boff)
4852 --boff;
4853 lnum = ml_find_line_or_offset(curbuf, (linenr_T)0, &boff);
4854 if (lnum < 1) /* past the end */
4856 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4857 curwin->w_curswant = MAXCOL;
4858 coladvance((colnr_T)MAXCOL);
4860 else
4862 curwin->w_cursor.lnum = lnum;
4863 curwin->w_cursor.col = (colnr_T)boff;
4864 # ifdef FEAT_VIRTUALEDIT
4865 curwin->w_cursor.coladd = 0;
4866 # endif
4867 curwin->w_set_curswant = TRUE;
4869 check_cursor();
4871 # ifdef FEAT_MBYTE
4872 /* Make sure the cursor is on the first byte of a multi-byte char. */
4873 if (has_mbyte)
4874 mb_adjust_cursor();
4875 # endif
4877 #endif