Patch 7.0.130 (extra)
[MacVim/jjgod.git] / src / fileio.c
blob7bab84e55f2bf5153f4a0f50dad9c40866b03f2d
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 */
11 * fileio.c: read from and write to a file
14 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
15 # include "vimio.h" /* for lseek(), must be before vim.h */
16 #endif
18 #if defined __EMX__
19 # include "vimio.h" /* for mktemp(), CJW 1997-12-03 */
20 #endif
22 #include "vim.h"
24 #ifdef HAVE_FCNTL_H
25 # include <fcntl.h>
26 #endif
28 #ifdef __TANDEM
29 # include <limits.h> /* for SSIZE_MAX */
30 #endif
32 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
33 # include <utime.h> /* for struct utimbuf */
34 #endif
36 #define BUFSIZE 8192 /* size of normal write buffer */
37 #define SMBUFSIZE 256 /* size of emergency write buffer */
39 #ifdef FEAT_CRYPT
40 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
41 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
42 #endif
44 /* Is there any system that doesn't have access()? */
45 #define USE_MCH_ACCESS
47 #ifdef FEAT_MBYTE
48 static char_u *next_fenc __ARGS((char_u **pp));
49 # ifdef FEAT_EVAL
50 static char_u *readfile_charconvert __ARGS((char_u *fname, char_u *fenc, int *fdp));
51 # endif
52 #endif
53 #ifdef FEAT_VIMINFO
54 static void check_marks_read __ARGS((void));
55 #endif
56 #ifdef FEAT_CRYPT
57 static char_u *check_for_cryptkey __ARGS((char_u *cryptkey, char_u *ptr, long *sizep, long *filesizep, int newfile));
58 #endif
59 #ifdef UNIX
60 static void set_file_time __ARGS((char_u *fname, time_t atime, time_t mtime));
61 #endif
62 static int set_rw_fname __ARGS((char_u *fname, char_u *sfname));
63 static int msg_add_fileformat __ARGS((int eol_type));
64 static void msg_add_eol __ARGS((void));
65 static int check_mtime __ARGS((buf_T *buf, struct stat *s));
66 static int time_differs __ARGS((long t1, long t2));
67 #ifdef FEAT_AUTOCMD
68 static int apply_autocmds_exarg __ARGS((event_T event, char_u *fname, char_u *fname_io, int force, buf_T *buf, exarg_T *eap));
69 static int au_find_group __ARGS((char_u *name));
71 # define AUGROUP_DEFAULT -1 /* default autocmd group */
72 # define AUGROUP_ERROR -2 /* errornouse autocmd group */
73 # define AUGROUP_ALL -3 /* all autocmd groups */
74 #endif
76 #if defined(FEAT_CRYPT) || defined(FEAT_MBYTE)
77 # define HAS_BW_FLAGS
78 # define FIO_LATIN1 0x01 /* convert Latin1 */
79 # define FIO_UTF8 0x02 /* convert UTF-8 */
80 # define FIO_UCS2 0x04 /* convert UCS-2 */
81 # define FIO_UCS4 0x08 /* convert UCS-4 */
82 # define FIO_UTF16 0x10 /* convert UTF-16 */
83 # ifdef WIN3264
84 # define FIO_CODEPAGE 0x20 /* convert MS-Windows codepage */
85 # define FIO_PUT_CP(x) (((x) & 0xffff) << 16) /* put codepage in top word */
86 # define FIO_GET_CP(x) (((x)>>16) & 0xffff) /* get codepage from top word */
87 # endif
88 # ifdef MACOS_X
89 # define FIO_MACROMAN 0x20 /* convert MacRoman */
90 # endif
91 # define FIO_ENDIAN_L 0x80 /* little endian */
92 # define FIO_ENCRYPTED 0x1000 /* encrypt written bytes */
93 # define FIO_NOCONVERT 0x2000 /* skip encoding conversion */
94 # define FIO_UCSBOM 0x4000 /* check for BOM at start of file */
95 # define FIO_ALL -1 /* allow all formats */
96 #endif
98 /* When converting, a read() or write() may leave some bytes to be converted
99 * for the next call. The value is guessed... */
100 #define CONV_RESTLEN 30
102 /* We have to guess how much a sequence of bytes may expand when converting
103 * with iconv() to be able to allocate a buffer. */
104 #define ICONV_MULT 8
107 * Structure to pass arguments from buf_write() to buf_write_bytes().
109 struct bw_info
111 int bw_fd; /* file descriptor */
112 char_u *bw_buf; /* buffer with data to be written */
113 int bw_len; /* lenght of data */
114 #ifdef HAS_BW_FLAGS
115 int bw_flags; /* FIO_ flags */
116 #endif
117 #ifdef FEAT_MBYTE
118 char_u bw_rest[CONV_RESTLEN]; /* not converted bytes */
119 int bw_restlen; /* nr of bytes in bw_rest[] */
120 int bw_first; /* first write call */
121 char_u *bw_conv_buf; /* buffer for writing converted chars */
122 int bw_conv_buflen; /* size of bw_conv_buf */
123 int bw_conv_error; /* set for conversion error */
124 # ifdef USE_ICONV
125 iconv_t bw_iconv_fd; /* descriptor for iconv() or -1 */
126 # endif
127 #endif
130 static int buf_write_bytes __ARGS((struct bw_info *ip));
132 #ifdef FEAT_MBYTE
133 static linenr_T readfile_linenr __ARGS((linenr_T linecnt, char_u *p, char_u *endp));
134 static int ucs2bytes __ARGS((unsigned c, char_u **pp, int flags));
135 static int same_encoding __ARGS((char_u *a, char_u *b));
136 static int get_fio_flags __ARGS((char_u *ptr));
137 static char_u *check_for_bom __ARGS((char_u *p, long size, int *lenp, int flags));
138 static int make_bom __ARGS((char_u *buf, char_u *name));
139 # ifdef WIN3264
140 static int get_win_fio_flags __ARGS((char_u *ptr));
141 # endif
142 # ifdef MACOS_X
143 static int get_mac_fio_flags __ARGS((char_u *ptr));
144 # endif
145 #endif
146 static int move_lines __ARGS((buf_T *frombuf, buf_T *tobuf));
149 void
150 filemess(buf, name, s, attr)
151 buf_T *buf;
152 char_u *name;
153 char_u *s;
154 int attr;
156 int msg_scroll_save;
158 if (msg_silent != 0)
159 return;
160 msg_add_fname(buf, name); /* put file name in IObuff with quotes */
161 /* If it's extremely long, truncate it. */
162 if (STRLEN(IObuff) > IOSIZE - 80)
163 IObuff[IOSIZE - 80] = NUL;
164 STRCAT(IObuff, s);
166 * For the first message may have to start a new line.
167 * For further ones overwrite the previous one, reset msg_scroll before
168 * calling filemess().
170 msg_scroll_save = msg_scroll;
171 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
172 msg_scroll = FALSE;
173 if (!msg_scroll) /* wait a bit when overwriting an error msg */
174 check_for_delay(FALSE);
175 msg_start();
176 msg_scroll = msg_scroll_save;
177 msg_scrolled_ign = TRUE;
178 /* may truncate the message to avoid a hit-return prompt */
179 msg_outtrans_attr(msg_may_trunc(FALSE, IObuff), attr);
180 msg_clr_eos();
181 out_flush();
182 msg_scrolled_ign = FALSE;
186 * Read lines from file "fname" into the buffer after line "from".
188 * 1. We allocate blocks with lalloc, as big as possible.
189 * 2. Each block is filled with characters from the file with a single read().
190 * 3. The lines are inserted in the buffer with ml_append().
192 * (caller must check that fname != NULL, unless READ_STDIN is used)
194 * "lines_to_skip" is the number of lines that must be skipped
195 * "lines_to_read" is the number of lines that are appended
196 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
198 * flags:
199 * READ_NEW starting to edit a new buffer
200 * READ_FILTER reading filter output
201 * READ_STDIN read from stdin instead of a file
202 * READ_BUFFER read from curbuf instead of a file (converting after reading
203 * stdin)
204 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
206 * return FAIL for failure, OK otherwise
209 readfile(fname, sfname, from, lines_to_skip, lines_to_read, eap, flags)
210 char_u *fname;
211 char_u *sfname;
212 linenr_T from;
213 linenr_T lines_to_skip;
214 linenr_T lines_to_read;
215 exarg_T *eap; /* can be NULL! */
216 int flags;
218 int fd = 0;
219 int newfile = (flags & READ_NEW);
220 int set_options = newfile || (eap != NULL && eap->read_edit);
221 int check_readonly;
222 int filtering = (flags & READ_FILTER);
223 int read_stdin = (flags & READ_STDIN);
224 int read_buffer = (flags & READ_BUFFER);
225 linenr_T read_buf_lnum = 1; /* next line to read from curbuf */
226 colnr_T read_buf_col = 0; /* next char to read from this line */
227 char_u c;
228 linenr_T lnum = from;
229 char_u *ptr = NULL; /* pointer into read buffer */
230 char_u *buffer = NULL; /* read buffer */
231 char_u *new_buffer = NULL; /* init to shut up gcc */
232 char_u *line_start = NULL; /* init to shut up gcc */
233 int wasempty; /* buffer was empty before reading */
234 colnr_T len;
235 long size = 0;
236 char_u *p;
237 long filesize = 0;
238 int skip_read = FALSE;
239 #ifdef FEAT_CRYPT
240 char_u *cryptkey = NULL;
241 #endif
242 int split = 0; /* number of split lines */
243 #define UNKNOWN 0x0fffffff /* file size is unknown */
244 linenr_T linecnt;
245 int error = FALSE; /* errors encountered */
246 int ff_error = EOL_UNKNOWN; /* file format with errors */
247 long linerest = 0; /* remaining chars in line */
248 #ifdef UNIX
249 int perm = 0;
250 int swap_mode = -1; /* protection bits for swap file */
251 #else
252 int perm;
253 #endif
254 int fileformat = 0; /* end-of-line format */
255 int keep_fileformat = FALSE;
256 struct stat st;
257 int file_readonly;
258 linenr_T skip_count = 0;
259 linenr_T read_count = 0;
260 int msg_save = msg_scroll;
261 linenr_T read_no_eol_lnum = 0; /* non-zero lnum when last line of
262 * last read was missing the eol */
263 int try_mac = (vim_strchr(p_ffs, 'm') != NULL);
264 int try_dos = (vim_strchr(p_ffs, 'd') != NULL);
265 int try_unix = (vim_strchr(p_ffs, 'x') != NULL);
266 int file_rewind = FALSE;
267 #ifdef FEAT_MBYTE
268 int can_retry;
269 linenr_T conv_error = 0; /* line nr with conversion error */
270 linenr_T illegal_byte = 0; /* line nr with illegal byte */
271 int keep_dest_enc = FALSE; /* don't retry when char doesn't fit
272 in destination encoding */
273 int bad_char_behavior = BAD_REPLACE;
274 /* BAD_KEEP, BAD_DROP or character to
275 * replace with */
276 char_u *tmpname = NULL; /* name of 'charconvert' output file */
277 int fio_flags = 0;
278 char_u *fenc; /* fileencoding to use */
279 int fenc_alloced; /* fenc_next is in allocated memory */
280 char_u *fenc_next = NULL; /* next item in 'fencs' or NULL */
281 int advance_fenc = FALSE;
282 long real_size = 0;
283 # ifdef USE_ICONV
284 iconv_t iconv_fd = (iconv_t)-1; /* descriptor for iconv() or -1 */
285 # ifdef FEAT_EVAL
286 int did_iconv = FALSE; /* TRUE when iconv() failed and trying
287 'charconvert' next */
288 # endif
289 # endif
290 int converted = FALSE; /* TRUE if conversion done */
291 int notconverted = FALSE; /* TRUE if conversion wanted but it
292 wasn't possible */
293 char_u conv_rest[CONV_RESTLEN];
294 int conv_restlen = 0; /* nr of bytes in conv_rest[] */
295 #endif
297 write_no_eol_lnum = 0; /* in case it was set by the previous read */
300 * If there is no file name yet, use the one for the read file.
301 * BF_NOTEDITED is set to reflect this.
302 * Don't do this for a read from a filter.
303 * Only do this when 'cpoptions' contains the 'f' flag.
305 if (curbuf->b_ffname == NULL
306 && !filtering
307 && fname != NULL
308 && vim_strchr(p_cpo, CPO_FNAMER) != NULL
309 && !(flags & READ_DUMMY))
311 if (set_rw_fname(fname, sfname) == FAIL)
312 return FAIL;
315 /* After reading a file the cursor line changes but we don't want to
316 * display the line. */
317 ex_no_reprint = TRUE;
319 /* don't display the file info for another buffer now */
320 need_fileinfo = FALSE;
323 * For Unix: Use the short file name whenever possible.
324 * Avoids problems with networks and when directory names are changed.
325 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
326 * another directory, which we don't detect.
328 if (sfname == NULL)
329 sfname = fname;
330 #if defined(UNIX) || defined(__EMX__)
331 fname = sfname;
332 #endif
334 #ifdef FEAT_AUTOCMD
336 * The BufReadCmd and FileReadCmd events intercept the reading process by
337 * executing the associated commands instead.
339 if (!filtering && !read_stdin && !read_buffer)
341 pos_T pos;
343 pos = curbuf->b_op_start;
345 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
346 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
347 curbuf->b_op_start.col = 0;
349 if (newfile)
351 if (apply_autocmds_exarg(EVENT_BUFREADCMD, NULL, sfname,
352 FALSE, curbuf, eap))
353 #ifdef FEAT_EVAL
354 return aborting() ? FAIL : OK;
355 #else
356 return OK;
357 #endif
359 else if (apply_autocmds_exarg(EVENT_FILEREADCMD, sfname, sfname,
360 FALSE, NULL, eap))
361 #ifdef FEAT_EVAL
362 return aborting() ? FAIL : OK;
363 #else
364 return OK;
365 #endif
367 curbuf->b_op_start = pos;
369 #endif
371 if ((shortmess(SHM_OVER) || curbuf->b_help) && p_verbose == 0)
372 msg_scroll = FALSE; /* overwrite previous file message */
373 else
374 msg_scroll = TRUE; /* don't overwrite previous file message */
377 * If the name ends in a path separator, we can't open it. Check here,
378 * because reading the file may actually work, but then creating the swap
379 * file may destroy it! Reported on MS-DOS and Win 95.
380 * If the name is too long we might crash further on, quit here.
382 if (fname != NULL && *fname != NUL)
384 p = fname + STRLEN(fname);
385 if (after_pathsep(fname, p) || STRLEN(fname) >= MAXPATHL)
387 filemess(curbuf, fname, (char_u *)_("Illegal file name"), 0);
388 msg_end();
389 msg_scroll = msg_save;
390 return FAIL;
394 #ifdef UNIX
396 * On Unix it is possible to read a directory, so we have to
397 * check for it before the mch_open().
399 if (!read_stdin && !read_buffer)
401 perm = mch_getperm(fname);
402 if (perm >= 0 && !S_ISREG(perm) /* not a regular file ... */
403 # ifdef S_ISFIFO
404 && !S_ISFIFO(perm) /* ... or fifo */
405 # endif
406 # ifdef S_ISSOCK
407 && !S_ISSOCK(perm) /* ... or socket */
408 # endif
411 if (S_ISDIR(perm))
412 filemess(curbuf, fname, (char_u *)_("is a directory"), 0);
413 else
414 filemess(curbuf, fname, (char_u *)_("is not a file"), 0);
415 msg_end();
416 msg_scroll = msg_save;
417 return FAIL;
420 #endif
422 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
424 * MS-Windows allows opening a device, but we will probably get stuck
425 * trying to read it.
427 if (!p_odev && mch_nodetype(fname) == NODE_WRITABLE)
429 filemess(curbuf, fname, (char_u *)_("is a device (disabled with 'opendevice' option"), 0);
430 msg_end();
431 msg_scroll = msg_save;
432 return FAIL;
434 #endif
436 /* set default 'fileformat' */
437 if (set_options)
439 if (eap != NULL && eap->force_ff != 0)
440 set_fileformat(get_fileformat_force(curbuf, eap), OPT_LOCAL);
441 else if (*p_ffs != NUL)
442 set_fileformat(default_fileformat(), OPT_LOCAL);
445 /* set or reset 'binary' */
446 if (eap != NULL && eap->force_bin != 0)
448 int oldval = curbuf->b_p_bin;
450 curbuf->b_p_bin = (eap->force_bin == FORCE_BIN);
451 set_options_bin(oldval, curbuf->b_p_bin, OPT_LOCAL);
455 * When opening a new file we take the readonly flag from the file.
456 * Default is r/w, can be set to r/o below.
457 * Don't reset it when in readonly mode
458 * Only set/reset b_p_ro when BF_CHECK_RO is set.
460 check_readonly = (newfile && (curbuf->b_flags & BF_CHECK_RO));
461 if (check_readonly && !readonlymode)
462 curbuf->b_p_ro = FALSE;
464 if (newfile && !read_stdin && !read_buffer)
466 /* Remember time of file.
467 * For RISCOS, also remember the filetype.
469 if (mch_stat((char *)fname, &st) >= 0)
471 buf_store_time(curbuf, &st, fname);
472 curbuf->b_mtime_read = curbuf->b_mtime;
474 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
475 /* Read the filetype into the buffer local filetype option. */
476 mch_read_filetype(fname);
477 #endif
478 #ifdef UNIX
480 * Use the protection bits of the original file for the swap file.
481 * This makes it possible for others to read the name of the
482 * edited file from the swapfile, but only if they can read the
483 * edited file.
484 * Remove the "write" and "execute" bits for group and others
485 * (they must not write the swapfile).
486 * Add the "read" and "write" bits for the user, otherwise we may
487 * not be able to write to the file ourselves.
488 * Setting the bits is done below, after creating the swap file.
490 swap_mode = (st.st_mode & 0644) | 0600;
491 #endif
492 #ifdef FEAT_CW_EDITOR
493 /* Get the FSSpec on MacOS
494 * TODO: Update it properly when the buffer name changes
496 (void)GetFSSpecFromPath(curbuf->b_ffname, &curbuf->b_FSSpec);
497 #endif
498 #ifdef VMS
499 curbuf->b_fab_rfm = st.st_fab_rfm;
500 curbuf->b_fab_rat = st.st_fab_rat;
501 curbuf->b_fab_mrs = st.st_fab_mrs;
502 #endif
504 else
506 curbuf->b_mtime = 0;
507 curbuf->b_mtime_read = 0;
508 curbuf->b_orig_size = 0;
509 curbuf->b_orig_mode = 0;
512 /* Reset the "new file" flag. It will be set again below when the
513 * file doesn't exist. */
514 curbuf->b_flags &= ~(BF_NEW | BF_NEW_W);
518 * for UNIX: check readonly with perm and mch_access()
519 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
520 * for MSDOS and Amiga: check readonly by trying to open the file for writing
522 file_readonly = FALSE;
523 if (read_stdin)
525 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
526 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
527 setmode(0, O_BINARY);
528 #endif
530 else if (!read_buffer)
532 #ifdef USE_MCH_ACCESS
533 if (
534 # ifdef UNIX
535 !(perm & 0222) ||
536 # endif
537 mch_access((char *)fname, W_OK))
538 file_readonly = TRUE;
539 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
540 #else
541 if (!newfile
542 || readonlymode
543 || (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0)
545 file_readonly = TRUE;
546 /* try to open ro */
547 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
549 #endif
552 if (fd < 0) /* cannot open at all */
554 #ifndef UNIX
555 int isdir_f;
556 #endif
557 msg_scroll = msg_save;
558 #ifndef UNIX
560 * On MSDOS and Amiga we can't open a directory, check here.
562 isdir_f = (mch_isdir(fname));
563 perm = mch_getperm(fname); /* check if the file exists */
564 if (isdir_f)
566 filemess(curbuf, sfname, (char_u *)_("is a directory"), 0);
567 curbuf->b_p_ro = TRUE; /* must use "w!" now */
569 else
570 #endif
571 if (newfile)
573 if (perm < 0)
576 * Set the 'new-file' flag, so that when the file has
577 * been created by someone else, a ":w" will complain.
579 curbuf->b_flags |= BF_NEW;
581 /* Create a swap file now, so that other Vims are warned
582 * that we are editing this file. Don't do this for a
583 * "nofile" or "nowrite" buffer type. */
584 #ifdef FEAT_QUICKFIX
585 if (!bt_dontwrite(curbuf))
586 #endif
587 check_need_swap(newfile);
588 if (dir_of_file_exists(fname))
589 filemess(curbuf, sfname, (char_u *)_("[New File]"), 0);
590 else
591 filemess(curbuf, sfname,
592 (char_u *)_("[New DIRECTORY]"), 0);
593 #ifdef FEAT_VIMINFO
594 /* Even though this is a new file, it might have been
595 * edited before and deleted. Get the old marks. */
596 check_marks_read();
597 #endif
598 #ifdef FEAT_MBYTE
599 if (eap != NULL && eap->force_enc != 0)
601 /* set forced 'fileencoding' */
602 fenc = enc_canonize(eap->cmd + eap->force_enc);
603 if (fenc != NULL)
604 set_string_option_direct((char_u *)"fenc", -1,
605 fenc, OPT_FREE|OPT_LOCAL, 0);
606 vim_free(fenc);
608 #endif
609 #ifdef FEAT_AUTOCMD
610 apply_autocmds_exarg(EVENT_BUFNEWFILE, sfname, sfname,
611 FALSE, curbuf, eap);
612 #endif
613 /* remember the current fileformat */
614 save_file_ff(curbuf);
616 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
617 if (aborting()) /* autocmds may abort script processing */
618 return FAIL;
619 #endif
620 return OK; /* a new file is not an error */
622 else
624 filemess(curbuf, sfname, (char_u *)(
625 # ifdef EFBIG
626 (errno == EFBIG) ? _("[File too big]") :
627 # endif
628 _("[Permission Denied]")), 0);
629 curbuf->b_p_ro = TRUE; /* must use "w!" now */
633 return FAIL;
637 * Only set the 'ro' flag for readonly files the first time they are
638 * loaded. Help files always get readonly mode
640 if ((check_readonly && file_readonly) || curbuf->b_help)
641 curbuf->b_p_ro = TRUE;
643 if (set_options)
645 curbuf->b_p_eol = TRUE;
646 curbuf->b_start_eol = TRUE;
647 #ifdef FEAT_MBYTE
648 curbuf->b_p_bomb = FALSE;
649 #endif
652 /* Create a swap file now, so that other Vims are warned that we are
653 * editing this file.
654 * Don't do this for a "nofile" or "nowrite" buffer type. */
655 #ifdef FEAT_QUICKFIX
656 if (!bt_dontwrite(curbuf))
657 #endif
659 check_need_swap(newfile);
660 #ifdef UNIX
661 /* Set swap file protection bits after creating it. */
662 if (swap_mode > 0 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
663 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
664 #endif
667 #if defined(HAS_SWAP_EXISTS_ACTION)
668 /* If "Quit" selected at ATTENTION dialog, don't load the file */
669 if (swap_exists_action == SEA_QUIT)
671 if (!read_buffer && !read_stdin)
672 close(fd);
673 return FAIL;
675 #endif
677 ++no_wait_return; /* don't wait for return yet */
680 * Set '[ mark to the line above where the lines go (line 1 if zero).
682 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
683 curbuf->b_op_start.col = 0;
685 #ifdef FEAT_AUTOCMD
686 if (!read_buffer)
688 int m = msg_scroll;
689 int n = msg_scrolled;
690 buf_T *old_curbuf = curbuf;
693 * The file must be closed again, the autocommands may want to change
694 * the file before reading it.
696 if (!read_stdin)
697 close(fd); /* ignore errors */
700 * The output from the autocommands should not overwrite anything and
701 * should not be overwritten: Set msg_scroll, restore its value if no
702 * output was done.
704 msg_scroll = TRUE;
705 if (filtering)
706 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
707 FALSE, curbuf, eap);
708 else if (read_stdin)
709 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
710 FALSE, curbuf, eap);
711 else if (newfile)
712 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
713 FALSE, curbuf, eap);
714 else
715 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
716 FALSE, NULL, eap);
717 if (msg_scrolled == n)
718 msg_scroll = m;
720 #ifdef FEAT_EVAL
721 if (aborting()) /* autocmds may abort script processing */
723 --no_wait_return;
724 msg_scroll = msg_save;
725 curbuf->b_p_ro = TRUE; /* must use "w!" now */
726 return FAIL;
728 #endif
730 * Don't allow the autocommands to change the current buffer.
731 * Try to re-open the file.
733 if (!read_stdin && (curbuf != old_curbuf
734 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
736 --no_wait_return;
737 msg_scroll = msg_save;
738 if (fd < 0)
739 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
740 else
741 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
742 curbuf->b_p_ro = TRUE; /* must use "w!" now */
743 return FAIL;
746 #endif /* FEAT_AUTOCMD */
748 /* Autocommands may add lines to the file, need to check if it is empty */
749 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
751 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
754 * Show the user that we are busy reading the input. Sometimes this
755 * may take a while. When reading from stdin another program may
756 * still be running, don't move the cursor to the last line, unless
757 * always using the GUI.
759 if (read_stdin)
761 #ifndef ALWAYS_USE_GUI
762 mch_msg(_("Vim: Reading from stdin...\n"));
763 #endif
764 #ifdef FEAT_GUI
765 /* Also write a message in the GUI window, if there is one. */
766 if (gui.in_use && !gui.dying && !gui.starting)
768 p = (char_u *)_("Reading from stdin...");
769 gui_write(p, (int)STRLEN(p));
771 #endif
773 else if (!read_buffer)
774 filemess(curbuf, sfname, (char_u *)"", 0);
777 msg_scroll = FALSE; /* overwrite the file message */
780 * Set linecnt now, before the "retry" caused by a wrong guess for
781 * fileformat, and after the autocommands, which may change them.
783 linecnt = curbuf->b_ml.ml_line_count;
785 #ifdef FEAT_MBYTE
786 /* "++bad=" argument. */
787 if (eap != NULL && eap->bad_char != 0)
789 bad_char_behavior = eap->bad_char;
790 if (set_options)
791 curbuf->b_bad_char = eap->bad_char;
793 else
794 curbuf->b_bad_char = 0;
797 * Decide which 'encoding' to use or use first.
799 if (eap != NULL && eap->force_enc != 0)
801 fenc = enc_canonize(eap->cmd + eap->force_enc);
802 fenc_alloced = TRUE;
803 keep_dest_enc = TRUE;
805 else if (curbuf->b_p_bin)
807 fenc = (char_u *)""; /* binary: don't convert */
808 fenc_alloced = FALSE;
810 else if (curbuf->b_help)
812 char_u firstline[80];
813 int fc;
815 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
816 * fails it must be latin1.
817 * Always do this when 'encoding' is "utf-8". Otherwise only do
818 * this when needed to avoid [converted] remarks all the time.
819 * It is needed when the first line contains non-ASCII characters.
820 * That is only in *.??x files. */
821 fenc = (char_u *)"latin1";
822 c = enc_utf8;
823 if (!c && !read_stdin)
825 fc = fname[STRLEN(fname) - 1];
826 if (TOLOWER_ASC(fc) == 'x')
828 /* Read the first line (and a bit more). Immediately rewind to
829 * the start of the file. If the read() fails "len" is -1. */
830 len = vim_read(fd, firstline, 80);
831 lseek(fd, (off_t)0L, SEEK_SET);
832 for (p = firstline; p < firstline + len; ++p)
833 if (*p >= 0x80)
835 c = TRUE;
836 break;
841 if (c)
843 fenc_next = fenc;
844 fenc = (char_u *)"utf-8";
846 /* When the file is utf-8 but a character doesn't fit in
847 * 'encoding' don't retry. In help text editing utf-8 bytes
848 * doesn't make sense. */
849 if (!enc_utf8)
850 keep_dest_enc = TRUE;
852 fenc_alloced = FALSE;
854 else if (*p_fencs == NUL)
856 fenc = curbuf->b_p_fenc; /* use format from buffer */
857 fenc_alloced = FALSE;
859 else
861 fenc_next = p_fencs; /* try items in 'fileencodings' */
862 fenc = next_fenc(&fenc_next);
863 fenc_alloced = TRUE;
865 #endif
868 * Jump back here to retry reading the file in different ways.
869 * Reasons to retry:
870 * - encoding conversion failed: try another one from "fenc_next"
871 * - BOM detected and fenc was set, need to setup conversion
872 * - "fileformat" check failed: try another
874 * Variables set for special retry actions:
875 * "file_rewind" Rewind the file to start reading it again.
876 * "advance_fenc" Advance "fenc" using "fenc_next".
877 * "skip_read" Re-use already read bytes (BOM detected).
878 * "did_iconv" iconv() conversion failed, try 'charconvert'.
879 * "keep_fileformat" Don't reset "fileformat".
881 * Other status indicators:
882 * "tmpname" When != NULL did conversion with 'charconvert'.
883 * Output file has to be deleted afterwards.
884 * "iconv_fd" When != -1 did conversion with iconv().
886 retry:
888 if (file_rewind)
890 if (read_buffer)
892 read_buf_lnum = 1;
893 read_buf_col = 0;
895 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
897 /* Can't rewind the file, give up. */
898 error = TRUE;
899 goto failed;
901 /* Delete the previously read lines. */
902 while (lnum > from)
903 ml_delete(lnum--, FALSE);
904 file_rewind = FALSE;
905 #ifdef FEAT_MBYTE
906 if (set_options)
907 curbuf->b_p_bomb = FALSE;
908 conv_error = 0;
909 #endif
913 * When retrying with another "fenc" and the first time "fileformat"
914 * will be reset.
916 if (keep_fileformat)
917 keep_fileformat = FALSE;
918 else
920 if (eap != NULL && eap->force_ff != 0)
921 fileformat = get_fileformat_force(curbuf, eap);
922 else if (curbuf->b_p_bin)
923 fileformat = EOL_UNIX; /* binary: use Unix format */
924 else if (*p_ffs == NUL)
925 fileformat = get_fileformat(curbuf);/* use format from buffer */
926 else
927 fileformat = EOL_UNKNOWN; /* detect from file */
930 #ifdef FEAT_MBYTE
931 # ifdef USE_ICONV
932 if (iconv_fd != (iconv_t)-1)
934 /* aborted conversion with iconv(), close the descriptor */
935 iconv_close(iconv_fd);
936 iconv_fd = (iconv_t)-1;
938 # endif
940 if (advance_fenc)
943 * Try the next entry in 'fileencodings'.
945 advance_fenc = FALSE;
947 if (eap != NULL && eap->force_enc != 0)
949 /* Conversion given with "++cc=" wasn't possible, read
950 * without conversion. */
951 notconverted = TRUE;
952 conv_error = 0;
953 if (fenc_alloced)
954 vim_free(fenc);
955 fenc = (char_u *)"";
956 fenc_alloced = FALSE;
958 else
960 if (fenc_alloced)
961 vim_free(fenc);
962 if (fenc_next != NULL)
964 fenc = next_fenc(&fenc_next);
965 fenc_alloced = (fenc_next != NULL);
967 else
969 fenc = (char_u *)"";
970 fenc_alloced = FALSE;
973 if (tmpname != NULL)
975 mch_remove(tmpname); /* delete converted file */
976 vim_free(tmpname);
977 tmpname = NULL;
982 * Conversion is required when the encoding of the file is different
983 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
984 * conversion to UTF-8).
986 fio_flags = 0;
987 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
988 if (converted || enc_unicode != 0)
991 /* "ucs-bom" means we need to check the first bytes of the file
992 * for a BOM. */
993 if (STRCMP(fenc, ENC_UCSBOM) == 0)
994 fio_flags = FIO_UCSBOM;
997 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
998 * done. This is handled below after read(). Prepare the
999 * fio_flags to avoid having to parse the string each time.
1000 * Also check for Unicode to Latin1 conversion, because iconv()
1001 * appears not to handle this correctly. This works just like
1002 * conversion to UTF-8 except how the resulting character is put in
1003 * the buffer.
1005 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1006 fio_flags = get_fio_flags(fenc);
1008 # ifdef WIN3264
1010 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1011 * is handled with MultiByteToWideChar().
1013 if (fio_flags == 0)
1014 fio_flags = get_win_fio_flags(fenc);
1015 # endif
1017 # ifdef MACOS_X
1018 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1019 if (fio_flags == 0)
1020 fio_flags = get_mac_fio_flags(fenc);
1021 # endif
1023 # ifdef USE_ICONV
1025 * Try using iconv() if we can't convert internally.
1027 if (fio_flags == 0
1028 # ifdef FEAT_EVAL
1029 && !did_iconv
1030 # endif
1032 iconv_fd = (iconv_t)my_iconv_open(
1033 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1034 # endif
1036 # ifdef FEAT_EVAL
1038 * Use the 'charconvert' expression when conversion is required
1039 * and we can't do it internally or with iconv().
1041 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1042 # ifdef USE_ICONV
1043 && iconv_fd == (iconv_t)-1
1044 # endif
1047 # ifdef USE_ICONV
1048 did_iconv = FALSE;
1049 # endif
1050 /* Skip conversion when it's already done (retry for wrong
1051 * "fileformat"). */
1052 if (tmpname == NULL)
1054 tmpname = readfile_charconvert(fname, fenc, &fd);
1055 if (tmpname == NULL)
1057 /* Conversion failed. Try another one. */
1058 advance_fenc = TRUE;
1059 if (fd < 0)
1061 /* Re-opening the original file failed! */
1062 EMSG(_("E202: Conversion made file unreadable!"));
1063 error = TRUE;
1064 goto failed;
1066 goto retry;
1070 else
1071 # endif
1073 if (fio_flags == 0
1074 # ifdef USE_ICONV
1075 && iconv_fd == (iconv_t)-1
1076 # endif
1079 /* Conversion wanted but we can't.
1080 * Try the next conversion in 'fileencodings' */
1081 advance_fenc = TRUE;
1082 goto retry;
1087 /* Set "can_retry" when it's possible to rewind the file and try with
1088 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1089 * stdin or fixed at a specific encoding. */
1090 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1091 #endif
1093 if (!skip_read)
1095 linerest = 0;
1096 filesize = 0;
1097 skip_count = lines_to_skip;
1098 read_count = lines_to_read;
1099 #ifdef FEAT_MBYTE
1100 conv_restlen = 0;
1101 #endif
1104 while (!error && !got_int)
1107 * We allocate as much space for the file as we can get, plus
1108 * space for the old line plus room for one terminating NUL.
1109 * The amount is limited by the fact that read() only can read
1110 * upto max_unsigned characters (and other things).
1112 #if SIZEOF_INT <= 2
1113 if (linerest >= 0x7ff0)
1115 ++split;
1116 *ptr = NL; /* split line by inserting a NL */
1117 size = 1;
1119 else
1120 #endif
1122 if (!skip_read)
1124 #if SIZEOF_INT > 2
1125 # ifdef __TANDEM
1126 size = SSIZE_MAX; /* use max I/O size, 52K */
1127 # else
1128 size = 0x10000L; /* use buffer >= 64K */
1129 # endif
1130 #else
1131 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1132 #endif
1134 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1136 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1137 FALSE)) != NULL)
1138 break;
1140 if (new_buffer == NULL)
1142 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1143 error = TRUE;
1144 break;
1146 if (linerest) /* copy characters from the previous buffer */
1147 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1148 vim_free(buffer);
1149 buffer = new_buffer;
1150 ptr = buffer + linerest;
1151 line_start = buffer;
1153 #ifdef FEAT_MBYTE
1154 /* May need room to translate into.
1155 * For iconv() we don't really know the required space, use a
1156 * factor ICONV_MULT.
1157 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1158 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1159 * become up to 4 bytes, size must be multiple of 2
1160 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1161 * multiple of 2
1162 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1163 * multiple of 4 */
1164 real_size = (int)size;
1165 # ifdef USE_ICONV
1166 if (iconv_fd != (iconv_t)-1)
1167 size = size / ICONV_MULT;
1168 else
1169 # endif
1170 if (fio_flags & FIO_LATIN1)
1171 size = size / 2;
1172 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1173 size = (size * 2 / 3) & ~1;
1174 else if (fio_flags & FIO_UCS4)
1175 size = (size * 2 / 3) & ~3;
1176 else if (fio_flags == FIO_UCSBOM)
1177 size = size / ICONV_MULT; /* worst case */
1178 # ifdef WIN3264
1179 else if (fio_flags & FIO_CODEPAGE)
1180 size = size / ICONV_MULT; /* also worst case */
1181 # endif
1182 # ifdef MACOS_X
1183 else if (fio_flags & FIO_MACROMAN)
1184 size = size / ICONV_MULT; /* also worst case */
1185 # endif
1186 #endif
1188 #ifdef FEAT_MBYTE
1189 if (conv_restlen > 0)
1191 /* Insert unconverted bytes from previous line. */
1192 mch_memmove(ptr, conv_rest, conv_restlen);
1193 ptr += conv_restlen;
1194 size -= conv_restlen;
1196 #endif
1198 if (read_buffer)
1201 * Read bytes from curbuf. Used for converting text read
1202 * from stdin.
1204 if (read_buf_lnum > from)
1205 size = 0;
1206 else
1208 int n, ni;
1209 long tlen;
1211 tlen = 0;
1212 for (;;)
1214 p = ml_get(read_buf_lnum) + read_buf_col;
1215 n = (int)STRLEN(p);
1216 if ((int)tlen + n + 1 > size)
1218 /* Filled up to "size", append partial line.
1219 * Change NL to NUL to reverse the effect done
1220 * below. */
1221 n = (int)(size - tlen);
1222 for (ni = 0; ni < n; ++ni)
1224 if (p[ni] == NL)
1225 ptr[tlen++] = NUL;
1226 else
1227 ptr[tlen++] = p[ni];
1229 read_buf_col += n;
1230 break;
1232 else
1234 /* Append whole line and new-line. Change NL
1235 * to NUL to reverse the effect done below. */
1236 for (ni = 0; ni < n; ++ni)
1238 if (p[ni] == NL)
1239 ptr[tlen++] = NUL;
1240 else
1241 ptr[tlen++] = p[ni];
1243 ptr[tlen++] = NL;
1244 read_buf_col = 0;
1245 if (++read_buf_lnum > from)
1247 /* When the last line didn't have an
1248 * end-of-line don't add it now either. */
1249 if (!curbuf->b_p_eol)
1250 --tlen;
1251 size = tlen;
1252 break;
1258 else
1261 * Read bytes from the file.
1263 size = vim_read(fd, ptr, size);
1266 if (size <= 0)
1268 if (size < 0) /* read error */
1269 error = TRUE;
1270 #ifdef FEAT_MBYTE
1271 else if (conv_restlen > 0)
1273 /* Reached end-of-file but some trailing bytes could
1274 * not be converted. Trucated file? */
1275 if (conv_error == 0)
1276 conv_error = linecnt;
1277 if (bad_char_behavior != BAD_DROP)
1279 fio_flags = 0; /* don't convert this */
1280 # ifdef USE_ICONV
1281 if (iconv_fd != (iconv_t)-1)
1283 iconv_close(iconv_fd);
1284 iconv_fd = (iconv_t)-1;
1286 # endif
1287 if (bad_char_behavior == BAD_KEEP)
1289 /* Keep the trailing bytes as-is. */
1290 size = conv_restlen;
1291 ptr -= conv_restlen;
1293 else
1295 /* Replace the trailing bytes with the
1296 * replacement character. */
1297 size = 1;
1298 *--ptr = bad_char_behavior;
1300 conv_restlen = 0;
1303 #endif
1306 #ifdef FEAT_CRYPT
1308 * At start of file: Check for magic number of encryption.
1310 if (filesize == 0)
1311 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1312 &filesize, newfile);
1314 * Decrypt the read bytes.
1316 if (cryptkey != NULL && size > 0)
1317 for (p = ptr; p < ptr + size; ++p)
1318 ZDECODE(*p);
1319 #endif
1321 skip_read = FALSE;
1323 #ifdef FEAT_MBYTE
1325 * At start of file (or after crypt magic number): Check for BOM.
1326 * Also check for a BOM for other Unicode encodings, but not after
1327 * converting with 'charconvert' or when a BOM has already been
1328 * found.
1330 if ((filesize == 0
1331 # ifdef FEAT_CRYPT
1332 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1333 # endif
1335 && (fio_flags == FIO_UCSBOM
1336 || (!curbuf->b_p_bomb
1337 && tmpname == NULL
1338 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1340 char_u *ccname;
1341 int blen;
1343 /* no BOM detection in a short file or in binary mode */
1344 if (size < 2 || curbuf->b_p_bin)
1345 ccname = NULL;
1346 else
1347 ccname = check_for_bom(ptr, size, &blen,
1348 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1349 if (ccname != NULL)
1351 /* Remove BOM from the text */
1352 filesize += blen;
1353 size -= blen;
1354 mch_memmove(ptr, ptr + blen, (size_t)size);
1355 if (set_options)
1356 curbuf->b_p_bomb = TRUE;
1359 if (fio_flags == FIO_UCSBOM)
1361 if (ccname == NULL)
1363 /* No BOM detected: retry with next encoding. */
1364 advance_fenc = TRUE;
1366 else
1368 /* BOM detected: set "fenc" and jump back */
1369 if (fenc_alloced)
1370 vim_free(fenc);
1371 fenc = ccname;
1372 fenc_alloced = FALSE;
1374 /* retry reading without getting new bytes or rewinding */
1375 skip_read = TRUE;
1376 goto retry;
1379 #endif
1381 * Break here for a read error or end-of-file.
1383 if (size <= 0)
1384 break;
1386 #ifdef FEAT_MBYTE
1388 /* Include not converted bytes. */
1389 ptr -= conv_restlen;
1390 size += conv_restlen;
1391 conv_restlen = 0;
1393 # ifdef USE_ICONV
1394 if (iconv_fd != (iconv_t)-1)
1397 * Attempt conversion of the read bytes to 'encoding' using
1398 * iconv().
1400 const char *fromp;
1401 char *top;
1402 size_t from_size;
1403 size_t to_size;
1405 fromp = (char *)ptr;
1406 from_size = size;
1407 ptr += size;
1408 top = (char *)ptr;
1409 to_size = real_size - size;
1412 * If there is conversion error or not enough room try using
1413 * another conversion. Except for when there is no
1414 * alternative (help files).
1416 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1417 &top, &to_size)
1418 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1419 || from_size > CONV_RESTLEN)
1421 if (can_retry)
1422 goto rewind_retry;
1423 if (conv_error == 0)
1424 conv_error = readfile_linenr(linecnt,
1425 ptr, (char_u *)top);
1427 /* Deal with a bad byte and continue with the next. */
1428 ++fromp;
1429 --from_size;
1430 if (bad_char_behavior == BAD_KEEP)
1432 *top++ = *(fromp - 1);
1433 --to_size;
1435 else if (bad_char_behavior != BAD_DROP)
1437 *top++ = bad_char_behavior;
1438 --to_size;
1442 if (from_size > 0)
1444 /* Some remaining characters, keep them for the next
1445 * round. */
1446 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1447 conv_restlen = (int)from_size;
1450 /* move the linerest to before the converted characters */
1451 line_start = ptr - linerest;
1452 mch_memmove(line_start, buffer, (size_t)linerest);
1453 size = (long)((char_u *)top - ptr);
1455 # endif
1457 # ifdef WIN3264
1458 if (fio_flags & FIO_CODEPAGE)
1460 char_u *src, *dst;
1461 WCHAR ucs2buf[3];
1462 int ucs2len;
1463 int codepage = FIO_GET_CP(fio_flags);
1464 int bytelen;
1465 int found_bad;
1466 char replstr[2];
1469 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1470 * a codepage, using standard MS-Windows functions. This
1471 * requires two steps:
1472 * 1. convert from 'fileencoding' to ucs-2
1473 * 2. convert from ucs-2 to 'encoding'
1475 * Because there may be illegal bytes AND an incomplete byte
1476 * sequence at the end, we may have to do the conversion one
1477 * character at a time to get it right.
1480 /* Replacement string for WideCharToMultiByte(). */
1481 if (bad_char_behavior > 0)
1482 replstr[0] = bad_char_behavior;
1483 else
1484 replstr[0] = '?';
1485 replstr[1] = NUL;
1488 * Move the bytes to the end of the buffer, so that we have
1489 * room to put the result at the start.
1491 src = ptr + real_size - size;
1492 mch_memmove(src, ptr, size);
1495 * Do the conversion.
1497 dst = ptr;
1498 size = size;
1499 while (size > 0)
1501 found_bad = FALSE;
1503 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1504 if (codepage == CP_UTF8)
1506 /* Handle CP_UTF8 input ourselves to be able to handle
1507 * trailing bytes properly.
1508 * Get one UTF-8 character from src. */
1509 bytelen = (int)utf_ptr2len_len(src, size);
1510 if (bytelen > size)
1512 /* Only got some bytes of a character. Normally
1513 * it's put in "conv_rest", but if it's too long
1514 * deal with it as if they were illegal bytes. */
1515 if (bytelen <= CONV_RESTLEN)
1516 break;
1518 /* weird overlong byte sequence */
1519 bytelen = size;
1520 found_bad = TRUE;
1522 else
1524 int u8c = utf_ptr2char(src);
1526 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1527 found_bad = TRUE;
1528 ucs2buf[0] = u8c;
1529 ucs2len = 1;
1532 else
1533 # endif
1535 /* We don't know how long the byte sequence is, try
1536 * from one to three bytes. */
1537 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1538 ++bytelen)
1540 ucs2len = MultiByteToWideChar(codepage,
1541 MB_ERR_INVALID_CHARS,
1542 (LPCSTR)src, bytelen,
1543 ucs2buf, 3);
1544 if (ucs2len > 0)
1545 break;
1547 if (ucs2len == 0)
1549 /* If we have only one byte then it's probably an
1550 * incomplete byte sequence. Otherwise discard
1551 * one byte as a bad character. */
1552 if (size == 1)
1553 break;
1554 found_bad = TRUE;
1555 bytelen = 1;
1559 if (!found_bad)
1561 int i;
1563 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1564 if (enc_utf8)
1566 /* From UCS-2 to UTF-8. Cannot fail. */
1567 for (i = 0; i < ucs2len; ++i)
1568 dst += utf_char2bytes(ucs2buf[i], dst);
1570 else
1572 BOOL bad = FALSE;
1573 int dstlen;
1575 /* From UCS-2 to "enc_codepage". If the
1576 * conversion uses the default character "?",
1577 * the data doesn't fit in this encoding. */
1578 dstlen = WideCharToMultiByte(enc_codepage, 0,
1579 (LPCWSTR)ucs2buf, ucs2len,
1580 (LPSTR)dst, (int)(src - dst),
1581 replstr, &bad);
1582 if (bad)
1583 found_bad = TRUE;
1584 else
1585 dst += dstlen;
1589 if (found_bad)
1591 /* Deal with bytes we can't convert. */
1592 if (can_retry)
1593 goto rewind_retry;
1594 if (conv_error == 0)
1595 conv_error = readfile_linenr(linecnt, ptr, dst);
1596 if (bad_char_behavior != BAD_DROP)
1598 if (bad_char_behavior == BAD_KEEP)
1600 mch_memmove(dst, src, bytelen);
1601 dst += bytelen;
1603 else
1604 *dst++ = bad_char_behavior;
1608 src += bytelen;
1609 size -= bytelen;
1612 if (size > 0)
1614 /* An incomplete byte sequence remaining. */
1615 mch_memmove(conv_rest, src, size);
1616 conv_restlen = size;
1619 /* The new size is equal to how much "dst" was advanced. */
1620 size = (long)(dst - ptr);
1622 else
1623 # endif
1624 # ifdef MACOS_CONVERT
1625 if (fio_flags & FIO_MACROMAN)
1628 * Conversion from Apple MacRoman char encoding to UTF-8 or
1629 * latin1. This is in os_mac_conv.c.
1631 if (macroman2enc(ptr, &size, real_size) == FAIL)
1632 goto rewind_retry;
1634 else
1635 # endif
1636 if (fio_flags != 0)
1638 int u8c;
1639 char_u *dest;
1640 char_u *tail = NULL;
1643 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1644 * "enc_utf8" not set: Convert Unicode to Latin1.
1645 * Go from end to start through the buffer, because the number
1646 * of bytes may increase.
1647 * "dest" points to after where the UTF-8 bytes go, "p" points
1648 * to after the next character to convert.
1650 dest = ptr + real_size;
1651 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1653 p = ptr + size;
1654 if (fio_flags == FIO_UTF8)
1656 /* Check for a trailing incomplete UTF-8 sequence */
1657 tail = ptr + size - 1;
1658 while (tail > ptr && (*tail & 0xc0) == 0x80)
1659 --tail;
1660 if (tail + utf_byte2len(*tail) <= ptr + size)
1661 tail = NULL;
1662 else
1663 p = tail;
1666 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1668 /* Check for a trailing byte */
1669 p = ptr + (size & ~1);
1670 if (size & 1)
1671 tail = p;
1672 if ((fio_flags & FIO_UTF16) && p > ptr)
1674 /* Check for a trailing leading word */
1675 if (fio_flags & FIO_ENDIAN_L)
1677 u8c = (*--p << 8);
1678 u8c += *--p;
1680 else
1682 u8c = *--p;
1683 u8c += (*--p << 8);
1685 if (u8c >= 0xd800 && u8c <= 0xdbff)
1686 tail = p;
1687 else
1688 p += 2;
1691 else /* FIO_UCS4 */
1693 /* Check for trailing 1, 2 or 3 bytes */
1694 p = ptr + (size & ~3);
1695 if (size & 3)
1696 tail = p;
1699 /* If there is a trailing incomplete sequence move it to
1700 * conv_rest[]. */
1701 if (tail != NULL)
1703 conv_restlen = (int)((ptr + size) - tail);
1704 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1705 size -= conv_restlen;
1709 while (p > ptr)
1711 if (fio_flags & FIO_LATIN1)
1712 u8c = *--p;
1713 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1715 if (fio_flags & FIO_ENDIAN_L)
1717 u8c = (*--p << 8);
1718 u8c += *--p;
1720 else
1722 u8c = *--p;
1723 u8c += (*--p << 8);
1725 if ((fio_flags & FIO_UTF16)
1726 && u8c >= 0xdc00 && u8c <= 0xdfff)
1728 int u16c;
1730 if (p == ptr)
1732 /* Missing leading word. */
1733 if (can_retry)
1734 goto rewind_retry;
1735 if (conv_error == 0)
1736 conv_error = readfile_linenr(linecnt,
1737 ptr, p);
1738 if (bad_char_behavior == BAD_DROP)
1739 continue;
1740 if (bad_char_behavior != BAD_KEEP)
1741 u8c = bad_char_behavior;
1744 /* found second word of double-word, get the first
1745 * word and compute the resulting character */
1746 if (fio_flags & FIO_ENDIAN_L)
1748 u16c = (*--p << 8);
1749 u16c += *--p;
1751 else
1753 u16c = *--p;
1754 u16c += (*--p << 8);
1756 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1757 + (u8c & 0x3ff);
1759 /* Check if the word is indeed a leading word. */
1760 if (u16c < 0xd800 || u16c > 0xdbff)
1762 if (can_retry)
1763 goto rewind_retry;
1764 if (conv_error == 0)
1765 conv_error = readfile_linenr(linecnt,
1766 ptr, p);
1767 if (bad_char_behavior == BAD_DROP)
1768 continue;
1769 if (bad_char_behavior != BAD_KEEP)
1770 u8c = bad_char_behavior;
1774 else if (fio_flags & FIO_UCS4)
1776 if (fio_flags & FIO_ENDIAN_L)
1778 u8c = (*--p << 24);
1779 u8c += (*--p << 16);
1780 u8c += (*--p << 8);
1781 u8c += *--p;
1783 else /* big endian */
1785 u8c = *--p;
1786 u8c += (*--p << 8);
1787 u8c += (*--p << 16);
1788 u8c += (*--p << 24);
1791 else /* UTF-8 */
1793 if (*--p < 0x80)
1794 u8c = *p;
1795 else
1797 len = utf_head_off(ptr, p);
1798 p -= len;
1799 u8c = utf_ptr2char(p);
1800 if (len == 0)
1802 /* Not a valid UTF-8 character, retry with
1803 * another fenc when possible, otherwise just
1804 * report the error. */
1805 if (can_retry)
1806 goto rewind_retry;
1807 if (conv_error == 0)
1808 conv_error = readfile_linenr(linecnt,
1809 ptr, p);
1810 if (bad_char_behavior == BAD_DROP)
1811 continue;
1812 if (bad_char_behavior != BAD_KEEP)
1813 u8c = bad_char_behavior;
1817 if (enc_utf8) /* produce UTF-8 */
1819 dest -= utf_char2len(u8c);
1820 (void)utf_char2bytes(u8c, dest);
1822 else /* produce Latin1 */
1824 --dest;
1825 if (u8c >= 0x100)
1827 /* character doesn't fit in latin1, retry with
1828 * another fenc when possible, otherwise just
1829 * report the error. */
1830 if (can_retry)
1831 goto rewind_retry;
1832 if (conv_error == 0)
1833 conv_error = readfile_linenr(linecnt, ptr, p);
1834 if (bad_char_behavior == BAD_DROP)
1835 ++dest;
1836 else if (bad_char_behavior == BAD_KEEP)
1837 *dest = u8c;
1838 else if (eap != NULL && eap->bad_char != 0)
1839 *dest = bad_char_behavior;
1840 else
1841 *dest = 0xBF;
1843 else
1844 *dest = u8c;
1848 /* move the linerest to before the converted characters */
1849 line_start = dest - linerest;
1850 mch_memmove(line_start, buffer, (size_t)linerest);
1851 size = (long)((ptr + real_size) - dest);
1852 ptr = dest;
1854 else if (enc_utf8 && conv_error == 0 && !curbuf->b_p_bin)
1856 /* Reading UTF-8: Check if the bytes are valid UTF-8.
1857 * Need to start before "ptr" when part of the character was
1858 * read in the previous read() call. */
1859 for (p = ptr - utf_head_off(buffer, ptr); ; ++p)
1861 int todo = (int)((ptr + size) - p);
1862 int l;
1864 if (todo <= 0)
1865 break;
1866 if (*p >= 0x80)
1868 /* A length of 1 means it's an illegal byte. Accept
1869 * an incomplete character at the end though, the next
1870 * read() will get the next bytes, we'll check it
1871 * then. */
1872 l = utf_ptr2len_len(p, todo);
1873 if (l > todo)
1875 /* Incomplete byte sequence, the next read()
1876 * should get them and check the bytes. */
1877 p += todo;
1878 break;
1880 if (l == 1)
1882 /* Illegal byte. If we can try another encoding
1883 * do that. */
1884 if (can_retry)
1885 break;
1887 /* Remember the first linenr with an illegal byte */
1888 if (illegal_byte == 0)
1889 illegal_byte = readfile_linenr(linecnt, ptr, p);
1890 # ifdef USE_ICONV
1891 /* When we did a conversion report an error. */
1892 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1893 conv_error = readfile_linenr(linecnt, ptr, p);
1894 # endif
1896 /* Drop, keep or replace the bad byte. */
1897 if (bad_char_behavior == BAD_DROP)
1899 mch_memmove(p, p+1, todo - 1);
1900 --p;
1901 --size;
1903 else if (bad_char_behavior != BAD_KEEP)
1904 *p = bad_char_behavior;
1906 p += l - 1;
1909 if (p < ptr + size)
1911 /* Detected a UTF-8 error. */
1912 rewind_retry:
1913 /* Retry reading with another conversion. */
1914 # if defined(FEAT_EVAL) && defined(USE_ICONV)
1915 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
1916 /* iconv() failed, try 'charconvert' */
1917 did_iconv = TRUE;
1918 else
1919 # endif
1920 /* use next item from 'fileencodings' */
1921 advance_fenc = TRUE;
1922 file_rewind = TRUE;
1923 goto retry;
1926 #endif
1928 /* count the number of characters (after conversion!) */
1929 filesize += size;
1932 * when reading the first part of a file: guess EOL type
1934 if (fileformat == EOL_UNKNOWN)
1936 /* First try finding a NL, for Dos and Unix */
1937 if (try_dos || try_unix)
1939 for (p = ptr; p < ptr + size; ++p)
1941 if (*p == NL)
1943 if (!try_unix
1944 || (try_dos && p > ptr && p[-1] == CAR))
1945 fileformat = EOL_DOS;
1946 else
1947 fileformat = EOL_UNIX;
1948 break;
1952 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
1953 if (fileformat == EOL_UNIX && try_mac)
1955 /* Need to reset the counters when retrying fenc. */
1956 try_mac = 1;
1957 try_unix = 1;
1958 for (; p >= ptr && *p != CAR; p--)
1960 if (p >= ptr)
1962 for (p = ptr; p < ptr + size; ++p)
1964 if (*p == NL)
1965 try_unix++;
1966 else if (*p == CAR)
1967 try_mac++;
1969 if (try_mac > try_unix)
1970 fileformat = EOL_MAC;
1975 /* No NL found: may use Mac format */
1976 if (fileformat == EOL_UNKNOWN && try_mac)
1977 fileformat = EOL_MAC;
1979 /* Still nothing found? Use first format in 'ffs' */
1980 if (fileformat == EOL_UNKNOWN)
1981 fileformat = default_fileformat();
1983 /* if editing a new file: may set p_tx and p_ff */
1984 if (set_options)
1985 set_fileformat(fileformat, OPT_LOCAL);
1990 * This loop is executed once for every character read.
1991 * Keep it fast!
1993 if (fileformat == EOL_MAC)
1995 --ptr;
1996 while (++ptr, --size >= 0)
1998 /* catch most common case first */
1999 if ((c = *ptr) != NUL && c != CAR && c != NL)
2000 continue;
2001 if (c == NUL)
2002 *ptr = NL; /* NULs are replaced by newlines! */
2003 else if (c == NL)
2004 *ptr = CAR; /* NLs are replaced by CRs! */
2005 else
2007 if (skip_count == 0)
2009 *ptr = NUL; /* end of line */
2010 len = (colnr_T) (ptr - line_start + 1);
2011 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2013 error = TRUE;
2014 break;
2016 ++lnum;
2017 if (--read_count == 0)
2019 error = TRUE; /* break loop */
2020 line_start = ptr; /* nothing left to write */
2021 break;
2024 else
2025 --skip_count;
2026 line_start = ptr + 1;
2030 else
2032 --ptr;
2033 while (++ptr, --size >= 0)
2035 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2036 continue;
2037 if (c == NUL)
2038 *ptr = NL; /* NULs are replaced by newlines! */
2039 else
2041 if (skip_count == 0)
2043 *ptr = NUL; /* end of line */
2044 len = (colnr_T)(ptr - line_start + 1);
2045 if (fileformat == EOL_DOS)
2047 if (ptr[-1] == CAR) /* remove CR */
2049 ptr[-1] = NUL;
2050 --len;
2053 * Reading in Dos format, but no CR-LF found!
2054 * When 'fileformats' includes "unix", delete all
2055 * the lines read so far and start all over again.
2056 * Otherwise give an error message later.
2058 else if (ff_error != EOL_DOS)
2060 if ( try_unix
2061 && !read_stdin
2062 && (read_buffer
2063 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2065 fileformat = EOL_UNIX;
2066 if (set_options)
2067 set_fileformat(EOL_UNIX, OPT_LOCAL);
2068 file_rewind = TRUE;
2069 keep_fileformat = TRUE;
2070 goto retry;
2072 ff_error = EOL_DOS;
2075 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2077 error = TRUE;
2078 break;
2080 ++lnum;
2081 if (--read_count == 0)
2083 error = TRUE; /* break loop */
2084 line_start = ptr; /* nothing left to write */
2085 break;
2088 else
2089 --skip_count;
2090 line_start = ptr + 1;
2094 linerest = (long)(ptr - line_start);
2095 ui_breakcheck();
2098 failed:
2099 /* not an error, max. number of lines reached */
2100 if (error && read_count == 0)
2101 error = FALSE;
2104 * If we get EOF in the middle of a line, note the fact and
2105 * complete the line ourselves.
2106 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2108 if (!error
2109 && !got_int
2110 && linerest != 0
2111 && !(!curbuf->b_p_bin
2112 && fileformat == EOL_DOS
2113 && *line_start == Ctrl_Z
2114 && ptr == line_start + 1))
2116 /* remember for when writing */
2117 if (set_options)
2118 curbuf->b_p_eol = FALSE;
2119 *ptr = NUL;
2120 if (ml_append(lnum, line_start,
2121 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2122 error = TRUE;
2123 else
2124 read_no_eol_lnum = ++lnum;
2127 if (set_options)
2128 save_file_ff(curbuf); /* remember the current file format */
2130 #ifdef FEAT_CRYPT
2131 if (cryptkey != curbuf->b_p_key)
2132 vim_free(cryptkey);
2133 #endif
2135 #ifdef FEAT_MBYTE
2136 /* If editing a new file: set 'fenc' for the current buffer.
2137 * Also for ":read ++edit file". */
2138 if (set_options)
2139 set_string_option_direct((char_u *)"fenc", -1, fenc,
2140 OPT_FREE|OPT_LOCAL, 0);
2141 if (fenc_alloced)
2142 vim_free(fenc);
2143 # ifdef USE_ICONV
2144 if (iconv_fd != (iconv_t)-1)
2146 iconv_close(iconv_fd);
2147 iconv_fd = (iconv_t)-1;
2149 # endif
2150 #endif
2152 if (!read_buffer && !read_stdin)
2153 close(fd); /* errors are ignored */
2154 vim_free(buffer);
2156 #ifdef HAVE_DUP
2157 if (read_stdin)
2159 /* Use stderr for stdin, makes shell commands work. */
2160 close(0);
2161 dup(2);
2163 #endif
2165 #ifdef FEAT_MBYTE
2166 if (tmpname != NULL)
2168 mch_remove(tmpname); /* delete converted file */
2169 vim_free(tmpname);
2171 #endif
2172 --no_wait_return; /* may wait for return now */
2175 * In recovery mode everything but autocommands is skipped.
2177 if (!recoverymode)
2179 /* need to delete the last line, which comes from the empty buffer */
2180 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2182 #ifdef FEAT_NETBEANS_INTG
2183 netbeansFireChanges = 0;
2184 #endif
2185 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2186 #ifdef FEAT_NETBEANS_INTG
2187 netbeansFireChanges = 1;
2188 #endif
2189 --linecnt;
2191 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2192 if (filesize == 0)
2193 linecnt = 0;
2194 if (newfile || read_buffer)
2195 redraw_curbuf_later(NOT_VALID);
2196 else if (linecnt) /* appended at least one line */
2197 appended_lines_mark(from, linecnt);
2199 #ifdef FEAT_DIFF
2200 /* After reading the text into the buffer the diff info needs to be
2201 * updated. */
2202 if (newfile || read_buffer)
2203 diff_invalidate(curbuf);
2204 #endif
2205 #ifndef ALWAYS_USE_GUI
2207 * If we were reading from the same terminal as where messages go,
2208 * the screen will have been messed up.
2209 * Switch on raw mode now and clear the screen.
2211 if (read_stdin)
2213 settmode(TMODE_RAW); /* set to raw mode */
2214 starttermcap();
2215 screenclear();
2217 #endif
2219 if (got_int)
2221 if (!(flags & READ_DUMMY))
2223 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2224 if (newfile)
2225 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2227 msg_scroll = msg_save;
2228 #ifdef FEAT_VIMINFO
2229 check_marks_read();
2230 #endif
2231 return OK; /* an interrupt isn't really an error */
2234 if (!filtering && !(flags & READ_DUMMY))
2236 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2237 c = FALSE;
2239 #ifdef UNIX
2240 # ifdef S_ISFIFO
2241 if (S_ISFIFO(perm)) /* fifo or socket */
2243 STRCAT(IObuff, _("[fifo/socket]"));
2244 c = TRUE;
2246 # else
2247 # ifdef S_IFIFO
2248 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2250 STRCAT(IObuff, _("[fifo]"));
2251 c = TRUE;
2253 # endif
2254 # ifdef S_IFSOCK
2255 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2257 STRCAT(IObuff, _("[socket]"));
2258 c = TRUE;
2260 # endif
2261 # endif
2262 #endif
2263 if (curbuf->b_p_ro)
2265 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2266 c = TRUE;
2268 if (read_no_eol_lnum)
2270 msg_add_eol();
2271 c = TRUE;
2273 if (ff_error == EOL_DOS)
2275 STRCAT(IObuff, _("[CR missing]"));
2276 c = TRUE;
2278 if (ff_error == EOL_MAC)
2280 STRCAT(IObuff, _("[NL found]"));
2281 c = TRUE;
2283 if (split)
2285 STRCAT(IObuff, _("[long lines split]"));
2286 c = TRUE;
2288 #ifdef FEAT_MBYTE
2289 if (notconverted)
2291 STRCAT(IObuff, _("[NOT converted]"));
2292 c = TRUE;
2294 else if (converted)
2296 STRCAT(IObuff, _("[converted]"));
2297 c = TRUE;
2299 #endif
2300 #ifdef FEAT_CRYPT
2301 if (cryptkey != NULL)
2303 STRCAT(IObuff, _("[crypted]"));
2304 c = TRUE;
2306 #endif
2307 #ifdef FEAT_MBYTE
2308 if (conv_error != 0)
2310 sprintf((char *)IObuff + STRLEN(IObuff),
2311 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2312 c = TRUE;
2314 else if (illegal_byte > 0)
2316 sprintf((char *)IObuff + STRLEN(IObuff),
2317 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2318 c = TRUE;
2320 else
2321 #endif
2322 if (error)
2324 STRCAT(IObuff, _("[READ ERRORS]"));
2325 c = TRUE;
2327 if (msg_add_fileformat(fileformat))
2328 c = TRUE;
2329 #ifdef FEAT_CRYPT
2330 if (cryptkey != NULL)
2331 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2332 else
2333 #endif
2334 msg_add_lines(c, (long)linecnt, filesize);
2336 vim_free(keep_msg);
2337 keep_msg = NULL;
2338 msg_scrolled_ign = TRUE;
2339 #ifdef ALWAYS_USE_GUI
2340 /* Don't show the message when reading stdin, it would end up in a
2341 * message box (which might be shown when exiting!) */
2342 if (read_stdin || read_buffer)
2343 p = msg_may_trunc(FALSE, IObuff);
2344 else
2345 #endif
2346 p = msg_trunc_attr(IObuff, FALSE, 0);
2347 if (read_stdin || read_buffer || restart_edit != 0
2348 || (msg_scrolled != 0 && !need_wait_return))
2349 /* Need to repeat the message after redrawing when:
2350 * - When reading from stdin (the screen will be cleared next).
2351 * - When restart_edit is set (otherwise there will be a delay
2352 * before redrawing).
2353 * - When the screen was scrolled but there is no wait-return
2354 * prompt. */
2355 set_keep_msg(p, 0);
2356 msg_scrolled_ign = FALSE;
2359 /* with errors writing the file requires ":w!" */
2360 if (newfile && (error
2361 #ifdef FEAT_MBYTE
2362 || conv_error != 0
2363 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2364 #endif
2366 curbuf->b_p_ro = TRUE;
2368 u_clearline(); /* cannot use "U" command after adding lines */
2371 * In Ex mode: cursor at last new line.
2372 * Otherwise: cursor at first new line.
2374 if (exmode_active)
2375 curwin->w_cursor.lnum = from + linecnt;
2376 else
2377 curwin->w_cursor.lnum = from + 1;
2378 check_cursor_lnum();
2379 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2382 * Set '[ and '] marks to the newly read lines.
2384 curbuf->b_op_start.lnum = from + 1;
2385 curbuf->b_op_start.col = 0;
2386 curbuf->b_op_end.lnum = from + linecnt;
2387 curbuf->b_op_end.col = 0;
2389 #ifdef WIN32
2391 * Work around a weird problem: When a file has two links (only
2392 * possible on NTFS) and we write through one link, then stat() it
2393 * throught the other link, the timestamp information may be wrong.
2394 * It's correct again after reading the file, thus reset the timestamp
2395 * here.
2397 if (newfile && !read_stdin && !read_buffer
2398 && mch_stat((char *)fname, &st) >= 0)
2400 buf_store_time(curbuf, &st, fname);
2401 curbuf->b_mtime_read = curbuf->b_mtime;
2403 #endif
2405 msg_scroll = msg_save;
2407 #ifdef FEAT_VIMINFO
2409 * Get the marks before executing autocommands, so they can be used there.
2411 check_marks_read();
2412 #endif
2415 * Trick: We remember if the last line of the read didn't have
2416 * an eol for when writing it again. This is required for
2417 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2419 write_no_eol_lnum = read_no_eol_lnum;
2421 #ifdef FEAT_AUTOCMD
2422 if (!read_stdin && !read_buffer)
2424 int m = msg_scroll;
2425 int n = msg_scrolled;
2427 /* Save the fileformat now, otherwise the buffer will be considered
2428 * modified if the format/encoding was automatically detected. */
2429 if (set_options)
2430 save_file_ff(curbuf);
2433 * The output from the autocommands should not overwrite anything and
2434 * should not be overwritten: Set msg_scroll, restore its value if no
2435 * output was done.
2437 msg_scroll = TRUE;
2438 if (filtering)
2439 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2440 FALSE, curbuf, eap);
2441 else if (newfile)
2442 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2443 FALSE, curbuf, eap);
2444 else
2445 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2446 FALSE, NULL, eap);
2447 if (msg_scrolled == n)
2448 msg_scroll = m;
2449 #ifdef FEAT_EVAL
2450 if (aborting()) /* autocmds may abort script processing */
2451 return FAIL;
2452 #endif
2454 #endif
2456 if (recoverymode && error)
2457 return FAIL;
2458 return OK;
2461 #ifdef FEAT_MBYTE
2464 * From the current line count and characters read after that, estimate the
2465 * line number where we are now.
2466 * Used for error messages that include a line number.
2468 static linenr_T
2469 readfile_linenr(linecnt, p, endp)
2470 linenr_T linecnt; /* line count before reading more bytes */
2471 char_u *p; /* start of more bytes read */
2472 char_u *endp; /* end of more bytes read */
2474 char_u *s;
2475 linenr_T lnum;
2477 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2478 for (s = p; s < endp; ++s)
2479 if (*s == '\n')
2480 ++lnum;
2481 return lnum;
2483 #endif
2486 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2487 * equal to the buffer "buf". Used for calling readfile().
2488 * Returns OK or FAIL.
2491 prep_exarg(eap, buf)
2492 exarg_T *eap;
2493 buf_T *buf;
2495 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2496 #ifdef FEAT_MBYTE
2497 + STRLEN(buf->b_p_fenc)
2498 #endif
2499 + 15));
2500 if (eap->cmd == NULL)
2501 return FAIL;
2503 #ifdef FEAT_MBYTE
2504 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2505 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2506 eap->bad_char = buf->b_bad_char;
2507 #else
2508 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2509 #endif
2510 eap->force_ff = 7;
2512 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2513 eap->read_edit = FALSE;
2514 eap->forceit = FALSE;
2515 return OK;
2518 #ifdef FEAT_MBYTE
2520 * Find next fileencoding to use from 'fileencodings'.
2521 * "pp" points to fenc_next. It's advanced to the next item.
2522 * When there are no more items, an empty string is returned and *pp is set to
2523 * NULL.
2524 * When *pp is not set to NULL, the result is in allocated memory.
2526 static char_u *
2527 next_fenc(pp)
2528 char_u **pp;
2530 char_u *p;
2531 char_u *r;
2533 if (**pp == NUL)
2535 *pp = NULL;
2536 return (char_u *)"";
2538 p = vim_strchr(*pp, ',');
2539 if (p == NULL)
2541 r = enc_canonize(*pp);
2542 *pp += STRLEN(*pp);
2544 else
2546 r = vim_strnsave(*pp, (int)(p - *pp));
2547 *pp = p + 1;
2548 if (r != NULL)
2550 p = enc_canonize(r);
2551 vim_free(r);
2552 r = p;
2555 if (r == NULL) /* out of memory */
2557 r = (char_u *)"";
2558 *pp = NULL;
2560 return r;
2563 # ifdef FEAT_EVAL
2565 * Convert a file with the 'charconvert' expression.
2566 * This closes the file which is to be read, converts it and opens the
2567 * resulting file for reading.
2568 * Returns name of the resulting converted file (the caller should delete it
2569 * after reading it).
2570 * Returns NULL if the conversion failed ("*fdp" is not set) .
2572 static char_u *
2573 readfile_charconvert(fname, fenc, fdp)
2574 char_u *fname; /* name of input file */
2575 char_u *fenc; /* converted from */
2576 int *fdp; /* in/out: file descriptor of file */
2578 char_u *tmpname;
2579 char_u *errmsg = NULL;
2581 tmpname = vim_tempname('r');
2582 if (tmpname == NULL)
2583 errmsg = (char_u *)_("Can't find temp file for conversion");
2584 else
2586 close(*fdp); /* close the input file, ignore errors */
2587 *fdp = -1;
2588 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2589 fname, tmpname) == FAIL)
2590 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2591 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2592 O_RDONLY | O_EXTRA, 0)) < 0)
2593 errmsg = (char_u *)_("can't read output of 'charconvert'");
2596 if (errmsg != NULL)
2598 /* Don't use emsg(), it breaks mappings, the retry with
2599 * another type of conversion might still work. */
2600 MSG(errmsg);
2601 if (tmpname != NULL)
2603 mch_remove(tmpname); /* delete converted file */
2604 vim_free(tmpname);
2605 tmpname = NULL;
2609 /* If the input file is closed, open it (caller should check for error). */
2610 if (*fdp < 0)
2611 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2613 return tmpname;
2615 # endif
2617 #endif
2619 #ifdef FEAT_VIMINFO
2621 * Read marks for the current buffer from the viminfo file, when we support
2622 * buffer marks and the buffer has a name.
2624 static void
2625 check_marks_read()
2627 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2628 && curbuf->b_ffname != NULL)
2629 read_viminfo(NULL, FALSE, TRUE, FALSE);
2631 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2632 * the ' parameter after opening a buffer. */
2633 curbuf->b_marks_read = TRUE;
2635 #endif
2637 #ifdef FEAT_CRYPT
2639 * Check for magic number used for encryption.
2640 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2641 * *filesizep are updated.
2642 * Return the (new) encryption key, NULL for no encryption.
2644 static char_u *
2645 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2646 char_u *cryptkey; /* previous encryption key or NULL */
2647 char_u *ptr; /* pointer to read bytes */
2648 long *sizep; /* length of read bytes */
2649 long *filesizep; /* nr of bytes used from file */
2650 int newfile; /* editing a new buffer */
2652 if (*sizep >= CRYPT_MAGIC_LEN
2653 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2655 if (cryptkey == NULL)
2657 if (*curbuf->b_p_key)
2658 cryptkey = curbuf->b_p_key;
2659 else
2661 /* When newfile is TRUE, store the typed key
2662 * in the 'key' option and don't free it. */
2663 cryptkey = get_crypt_key(newfile, FALSE);
2664 /* check if empty key entered */
2665 if (cryptkey != NULL && *cryptkey == NUL)
2667 if (cryptkey != curbuf->b_p_key)
2668 vim_free(cryptkey);
2669 cryptkey = NULL;
2674 if (cryptkey != NULL)
2676 crypt_init_keys(cryptkey);
2678 /* Remove magic number from the text */
2679 *filesizep += CRYPT_MAGIC_LEN;
2680 *sizep -= CRYPT_MAGIC_LEN;
2681 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2684 /* When starting to edit a new file which does not have
2685 * encryption, clear the 'key' option, except when
2686 * starting up (called with -x argument) */
2687 else if (newfile && *curbuf->b_p_key && !starting)
2688 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2690 return cryptkey;
2692 #endif
2694 #ifdef UNIX
2695 static void
2696 set_file_time(fname, atime, mtime)
2697 char_u *fname;
2698 time_t atime; /* access time */
2699 time_t mtime; /* modification time */
2701 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2702 struct utimbuf buf;
2704 buf.actime = atime;
2705 buf.modtime = mtime;
2706 (void)utime((char *)fname, &buf);
2707 # else
2708 # if defined(HAVE_UTIMES)
2709 struct timeval tvp[2];
2711 tvp[0].tv_sec = atime;
2712 tvp[0].tv_usec = 0;
2713 tvp[1].tv_sec = mtime;
2714 tvp[1].tv_usec = 0;
2715 # ifdef NeXT
2716 (void)utimes((char *)fname, tvp);
2717 # else
2718 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2719 # endif
2720 # endif
2721 # endif
2723 #endif /* UNIX */
2725 #if defined(VMS) && !defined(MIN)
2726 /* Older DECC compiler for VAX doesn't define MIN() */
2727 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2728 #endif
2731 * buf_write() - write to file "fname" lines "start" through "end"
2733 * We do our own buffering here because fwrite() is so slow.
2735 * If "forceit" is true, we don't care for errors when attempting backups.
2736 * In case of an error everything possible is done to restore the original
2737 * file. But when "forceit" is TRUE, we risk loosing it.
2739 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2740 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2742 * This function must NOT use NameBuff (because it's called by autowrite()).
2744 * return FAIL for failure, OK otherwise
2747 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2748 reset_changed, filtering)
2749 buf_T *buf;
2750 char_u *fname;
2751 char_u *sfname;
2752 linenr_T start, end;
2753 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2754 NULL! */
2755 int append; /* append to the file */
2756 int forceit;
2757 int reset_changed;
2758 int filtering;
2760 int fd;
2761 char_u *backup = NULL;
2762 int backup_copy = FALSE; /* copy the original file? */
2763 int dobackup;
2764 char_u *ffname;
2765 char_u *wfname = NULL; /* name of file to write to */
2766 char_u *s;
2767 char_u *ptr;
2768 char_u c;
2769 int len;
2770 linenr_T lnum;
2771 long nchars;
2772 char_u *errmsg = NULL;
2773 char_u *errnum = NULL;
2774 char_u *buffer;
2775 char_u smallbuf[SMBUFSIZE];
2776 char_u *backup_ext;
2777 int bufsize;
2778 long perm; /* file permissions */
2779 int retval = OK;
2780 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2781 int msg_save = msg_scroll;
2782 int overwriting; /* TRUE if writing over original */
2783 int no_eol = FALSE; /* no end-of-line written */
2784 int device = FALSE; /* writing to a device */
2785 struct stat st_old;
2786 int prev_got_int = got_int;
2787 int file_readonly = FALSE; /* overwritten file is read-only */
2788 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2789 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2790 int made_writable = FALSE; /* 'w' bit has been set */
2791 #endif
2792 /* writing everything */
2793 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2794 #ifdef FEAT_AUTOCMD
2795 linenr_T old_line_count = buf->b_ml.ml_line_count;
2796 #endif
2797 int attr;
2798 int fileformat;
2799 int write_bin;
2800 struct bw_info write_info; /* info for buf_write_bytes() */
2801 #ifdef FEAT_MBYTE
2802 int converted = FALSE;
2803 int notconverted = FALSE;
2804 char_u *fenc; /* effective 'fileencoding' */
2805 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2806 #endif
2807 #ifdef HAS_BW_FLAGS
2808 int wb_flags = 0;
2809 #endif
2810 #ifdef HAVE_ACL
2811 vim_acl_T acl = NULL; /* ACL copied from original file to
2812 backup or new file */
2813 #endif
2815 if (fname == NULL || *fname == NUL) /* safety check */
2816 return FAIL;
2819 * Disallow writing from .exrc and .vimrc in current directory for
2820 * security reasons.
2822 if (check_secure())
2823 return FAIL;
2825 /* Avoid a crash for a long name. */
2826 if (STRLEN(fname) >= MAXPATHL)
2828 EMSG(_(e_longname));
2829 return FAIL;
2832 #ifdef FEAT_MBYTE
2833 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2834 write_info.bw_conv_buf = NULL;
2835 write_info.bw_conv_error = FALSE;
2836 write_info.bw_restlen = 0;
2837 # ifdef USE_ICONV
2838 write_info.bw_iconv_fd = (iconv_t)-1;
2839 # endif
2840 #endif
2842 /* After writing a file changedtick changes but we don't want to display
2843 * the line. */
2844 ex_no_reprint = TRUE;
2847 * If there is no file name yet, use the one for the written file.
2848 * BF_NOTEDITED is set to reflect this (in case the write fails).
2849 * Don't do this when the write is for a filter command.
2850 * Don't do this when appending.
2851 * Only do this when 'cpoptions' contains the 'F' flag.
2853 if (buf->b_ffname == NULL
2854 && reset_changed
2855 && whole
2856 && buf == curbuf
2857 #ifdef FEAT_QUICKFIX
2858 && !bt_nofile(buf)
2859 #endif
2860 && !filtering
2861 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
2862 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
2864 if (set_rw_fname(fname, sfname) == FAIL)
2865 return FAIL;
2866 buf = curbuf; /* just in case autocmds made "buf" invalid */
2869 if (sfname == NULL)
2870 sfname = fname;
2872 * For Unix: Use the short file name whenever possible.
2873 * Avoids problems with networks and when directory names are changed.
2874 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
2875 * another directory, which we don't detect
2877 ffname = fname; /* remember full fname */
2878 #ifdef UNIX
2879 fname = sfname;
2880 #endif
2882 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
2883 overwriting = TRUE;
2884 else
2885 overwriting = FALSE;
2887 if (exiting)
2888 settmode(TMODE_COOK); /* when exiting allow typahead now */
2890 ++no_wait_return; /* don't wait for return yet */
2893 * Set '[ and '] marks to the lines to be written.
2895 buf->b_op_start.lnum = start;
2896 buf->b_op_start.col = 0;
2897 buf->b_op_end.lnum = end;
2898 buf->b_op_end.col = 0;
2900 #ifdef FEAT_AUTOCMD
2902 aco_save_T aco;
2903 int buf_ffname = FALSE;
2904 int buf_sfname = FALSE;
2905 int buf_fname_f = FALSE;
2906 int buf_fname_s = FALSE;
2907 int did_cmd = FALSE;
2908 int nofile_err = FALSE;
2909 int empty_memline = (buf->b_ml.ml_mfp == NULL);
2912 * Apply PRE aucocommands.
2913 * Set curbuf to the buffer to be written.
2914 * Careful: The autocommands may call buf_write() recursively!
2916 if (ffname == buf->b_ffname)
2917 buf_ffname = TRUE;
2918 if (sfname == buf->b_sfname)
2919 buf_sfname = TRUE;
2920 if (fname == buf->b_ffname)
2921 buf_fname_f = TRUE;
2922 if (fname == buf->b_sfname)
2923 buf_fname_s = TRUE;
2925 /* set curwin/curbuf to buf and save a few things */
2926 aucmd_prepbuf(&aco, buf);
2928 if (append)
2930 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
2931 sfname, sfname, FALSE, curbuf, eap)))
2933 #ifdef FEAT_QUICKFIX
2934 if (overwriting && bt_nofile(curbuf))
2935 nofile_err = TRUE;
2936 else
2937 #endif
2938 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
2939 sfname, sfname, FALSE, curbuf, eap);
2942 else if (filtering)
2944 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
2945 NULL, sfname, FALSE, curbuf, eap);
2947 else if (reset_changed && whole)
2949 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
2950 sfname, sfname, FALSE, curbuf, eap)))
2952 #ifdef FEAT_QUICKFIX
2953 if (overwriting && bt_nofile(curbuf))
2954 nofile_err = TRUE;
2955 else
2956 #endif
2957 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
2958 sfname, sfname, FALSE, curbuf, eap);
2961 else
2963 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
2964 sfname, sfname, FALSE, curbuf, eap)))
2966 #ifdef FEAT_QUICKFIX
2967 if (overwriting && bt_nofile(curbuf))
2968 nofile_err = TRUE;
2969 else
2970 #endif
2971 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
2972 sfname, sfname, FALSE, curbuf, eap);
2976 /* restore curwin/curbuf and a few other things */
2977 aucmd_restbuf(&aco);
2980 * In three situations we return here and don't write the file:
2981 * 1. the autocommands deleted or unloaded the buffer.
2982 * 2. The autocommands abort script processing.
2983 * 3. If one of the "Cmd" autocommands was executed.
2985 if (!buf_valid(buf))
2986 buf = NULL;
2987 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
2988 || did_cmd || nofile_err
2989 #ifdef FEAT_EVAL
2990 || aborting()
2991 #endif
2994 --no_wait_return;
2995 msg_scroll = msg_save;
2996 if (nofile_err)
2997 EMSG(_("E676: No matching autocommands for acwrite buffer"));
2999 if (nofile_err
3000 #ifdef FEAT_EVAL
3001 || aborting()
3002 #endif
3004 /* An aborting error, interrupt or exception in the
3005 * autocommands. */
3006 return FAIL;
3007 if (did_cmd)
3009 if (buf == NULL)
3010 /* The buffer was deleted. We assume it was written
3011 * (can't retry anyway). */
3012 return OK;
3013 if (overwriting)
3015 /* Assume the buffer was written, update the timestamp. */
3016 ml_timestamp(buf);
3017 if (append)
3018 buf->b_flags &= ~BF_NEW;
3019 else
3020 buf->b_flags &= ~BF_WRITE_MASK;
3022 if (reset_changed && buf->b_changed && !append
3023 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3024 /* Buffer still changed, the autocommands didn't work
3025 * properly. */
3026 return FAIL;
3027 return OK;
3029 #ifdef FEAT_EVAL
3030 if (!aborting())
3031 #endif
3032 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3033 return FAIL;
3037 * The autocommands may have changed the number of lines in the file.
3038 * When writing the whole file, adjust the end.
3039 * When writing part of the file, assume that the autocommands only
3040 * changed the number of lines that are to be written (tricky!).
3042 if (buf->b_ml.ml_line_count != old_line_count)
3044 if (whole) /* write all */
3045 end = buf->b_ml.ml_line_count;
3046 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3047 end += buf->b_ml.ml_line_count - old_line_count;
3048 else /* less lines */
3050 end -= old_line_count - buf->b_ml.ml_line_count;
3051 if (end < start)
3053 --no_wait_return;
3054 msg_scroll = msg_save;
3055 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3056 return FAIL;
3062 * The autocommands may have changed the name of the buffer, which may
3063 * be kept in fname, ffname and sfname.
3065 if (buf_ffname)
3066 ffname = buf->b_ffname;
3067 if (buf_sfname)
3068 sfname = buf->b_sfname;
3069 if (buf_fname_f)
3070 fname = buf->b_ffname;
3071 if (buf_fname_s)
3072 fname = buf->b_sfname;
3074 #endif
3076 #ifdef FEAT_NETBEANS_INTG
3077 if (usingNetbeans && isNetbeansBuffer(buf))
3079 if (whole)
3082 * b_changed can be 0 after an undo, but we still need to write
3083 * the buffer to NetBeans.
3085 if (buf->b_changed || isNetbeansModified(buf))
3087 --no_wait_return; /* may wait for return now */
3088 msg_scroll = msg_save;
3089 netbeans_save_buffer(buf); /* no error checking... */
3090 return retval;
3092 else
3094 errnum = (char_u *)"E656: ";
3095 errmsg = (char_u *)_("NetBeans dissallows writes of unmodified buffers");
3096 buffer = NULL;
3097 goto fail;
3100 else
3102 errnum = (char_u *)"E657: ";
3103 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3104 buffer = NULL;
3105 goto fail;
3108 #endif
3110 if (shortmess(SHM_OVER) && !exiting)
3111 msg_scroll = FALSE; /* overwrite previous file message */
3112 else
3113 msg_scroll = TRUE; /* don't overwrite previous file message */
3114 if (!filtering)
3115 filemess(buf,
3116 #ifndef UNIX
3117 sfname,
3118 #else
3119 fname,
3120 #endif
3121 (char_u *)"", 0); /* show that we are busy */
3122 msg_scroll = FALSE; /* always overwrite the file message now */
3124 buffer = alloc(BUFSIZE);
3125 if (buffer == NULL) /* can't allocate big buffer, use small
3126 * one (to be able to write when out of
3127 * memory) */
3129 buffer = smallbuf;
3130 bufsize = SMBUFSIZE;
3132 else
3133 bufsize = BUFSIZE;
3136 * Get information about original file (if there is one).
3138 #if defined(UNIX) && !defined(ARCHIE)
3139 st_old.st_dev = st_old.st_ino = 0;
3140 perm = -1;
3141 if (mch_stat((char *)fname, &st_old) < 0)
3142 newfile = TRUE;
3143 else
3145 perm = st_old.st_mode;
3146 if (!S_ISREG(st_old.st_mode)) /* not a file */
3148 if (S_ISDIR(st_old.st_mode))
3150 errnum = (char_u *)"E502: ";
3151 errmsg = (char_u *)_("is a directory");
3152 goto fail;
3154 if (mch_nodetype(fname) != NODE_WRITABLE)
3156 errnum = (char_u *)"E503: ";
3157 errmsg = (char_u *)_("is not a file or writable device");
3158 goto fail;
3160 /* It's a device of some kind (or a fifo) which we can write to
3161 * but for which we can't make a backup. */
3162 device = TRUE;
3163 newfile = TRUE;
3164 perm = -1;
3167 #else /* !UNIX */
3169 * Check for a writable device name.
3171 c = mch_nodetype(fname);
3172 if (c == NODE_OTHER)
3174 errnum = (char_u *)"E503: ";
3175 errmsg = (char_u *)_("is not a file or writable device");
3176 goto fail;
3178 if (c == NODE_WRITABLE)
3180 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3181 /* MS-Windows allows opening a device, but we will probably get stuck
3182 * trying to write to it. */
3183 if (!p_odev)
3185 errnum = (char_u *)"E796: ";
3186 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3187 goto fail;
3189 # endif
3190 device = TRUE;
3191 newfile = TRUE;
3192 perm = -1;
3194 else
3196 perm = mch_getperm(fname);
3197 if (perm < 0)
3198 newfile = TRUE;
3199 else if (mch_isdir(fname))
3201 errnum = (char_u *)"E502: ";
3202 errmsg = (char_u *)_("is a directory");
3203 goto fail;
3205 if (overwriting)
3206 (void)mch_stat((char *)fname, &st_old);
3208 #endif /* !UNIX */
3210 if (!device && !newfile)
3213 * Check if the file is really writable (when renaming the file to
3214 * make a backup we won't discover it later).
3216 file_readonly = (
3217 # ifdef USE_MCH_ACCESS
3218 # ifdef UNIX
3219 (perm & 0222) == 0 ||
3220 # endif
3221 mch_access((char *)fname, W_OK)
3222 # else
3223 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
3224 ? TRUE : (close(fd), FALSE)
3225 # endif
3227 if (!forceit && file_readonly)
3229 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3231 errnum = (char_u *)"E504: ";
3232 errmsg = (char_u *)_(err_readonly);
3234 else
3236 errnum = (char_u *)"E505: ";
3237 errmsg = (char_u *)_("is read-only (add ! to override)");
3239 goto fail;
3243 * Check if the timestamp hasn't changed since reading the file.
3245 if (overwriting)
3247 retval = check_mtime(buf, &st_old);
3248 if (retval == FAIL)
3249 goto fail;
3253 #ifdef HAVE_ACL
3255 * For systems that support ACL: get the ACL from the original file.
3257 if (!newfile)
3258 acl = mch_get_acl(fname);
3259 #endif
3262 * If 'backupskip' is not empty, don't make a backup for some files.
3264 dobackup = (p_wb || p_bk || *p_pm != NUL);
3265 #ifdef FEAT_WILDIGN
3266 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3267 dobackup = FALSE;
3268 #endif
3271 * Save the value of got_int and reset it. We don't want a previous
3272 * interruption cancel writing, only hitting CTRL-C while writing should
3273 * abort it.
3275 prev_got_int = got_int;
3276 got_int = FALSE;
3278 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3279 buf->b_saving = TRUE;
3282 * If we are not appending or filtering, the file exists, and the
3283 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3284 * When 'patchmode' is set also make a backup when appending.
3286 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3287 * off. This helps when editing large files on almost-full disks.
3289 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3291 #if defined(UNIX) || defined(WIN32)
3292 struct stat st;
3293 #endif
3295 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3296 backup_copy = TRUE;
3297 #if defined(UNIX) || defined(WIN32)
3298 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3300 int i;
3302 # ifdef UNIX
3304 * Don't rename the file when:
3305 * - it's a hard link
3306 * - it's a symbolic link
3307 * - we don't have write permission in the directory
3308 * - we can't set the owner/group of the new file
3310 if (st_old.st_nlink > 1
3311 || mch_lstat((char *)fname, &st) < 0
3312 || st.st_dev != st_old.st_dev
3313 || st.st_ino != st_old.st_ino
3314 # ifndef HAVE_FCHOWN
3315 || st.st_uid != st_old.st_uid
3316 || st.st_gid != st_old.st_gid
3317 # endif
3319 backup_copy = TRUE;
3320 else
3321 # else
3322 # ifdef WIN32
3323 /* On NTFS file systems hard links are possible. */
3324 if (mch_is_linked(fname))
3325 backup_copy = TRUE;
3326 else
3327 # endif
3328 # endif
3331 * Check if we can create a file and set the owner/group to
3332 * the ones from the original file.
3333 * First find a file name that doesn't exist yet (use some
3334 * arbitrary numbers).
3336 STRCPY(IObuff, fname);
3337 for (i = 4913; ; i += 123)
3339 sprintf((char *)gettail(IObuff), "%d", i);
3340 if (mch_lstat((char *)IObuff, &st) < 0)
3341 break;
3343 fd = mch_open((char *)IObuff,
3344 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3345 if (fd < 0) /* can't write in directory */
3346 backup_copy = TRUE;
3347 else
3349 # ifdef UNIX
3350 # ifdef HAVE_FCHOWN
3351 fchown(fd, st_old.st_uid, st_old.st_gid);
3352 # endif
3353 if (mch_stat((char *)IObuff, &st) < 0
3354 || st.st_uid != st_old.st_uid
3355 || st.st_gid != st_old.st_gid
3356 || st.st_mode != perm)
3357 backup_copy = TRUE;
3358 # endif
3359 /* Close the file before removing it, on MS-Windows we
3360 * can't delete an open file. */
3361 close(fd);
3362 mch_remove(IObuff);
3367 # ifdef UNIX
3369 * Break symlinks and/or hardlinks if we've been asked to.
3371 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3373 int lstat_res;
3375 lstat_res = mch_lstat((char *)fname, &st);
3377 /* Symlinks. */
3378 if ((bkc_flags & BKC_BREAKSYMLINK)
3379 && lstat_res == 0
3380 && st.st_ino != st_old.st_ino)
3381 backup_copy = FALSE;
3383 /* Hardlinks. */
3384 if ((bkc_flags & BKC_BREAKHARDLINK)
3385 && st_old.st_nlink > 1
3386 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3387 backup_copy = FALSE;
3389 #endif
3391 #endif
3393 /* make sure we have a valid backup extension to use */
3394 if (*p_bex == NUL)
3396 #ifdef RISCOS
3397 backup_ext = (char_u *)"/bak";
3398 #else
3399 backup_ext = (char_u *)".bak";
3400 #endif
3402 else
3403 backup_ext = p_bex;
3405 if (backup_copy
3406 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3408 int bfd;
3409 char_u *copybuf, *wp;
3410 int some_error = FALSE;
3411 struct stat st_new;
3412 char_u *dirp;
3413 char_u *rootname;
3414 #if defined(UNIX) && !defined(SHORT_FNAME)
3415 int did_set_shortname;
3416 #endif
3418 copybuf = alloc(BUFSIZE + 1);
3419 if (copybuf == NULL)
3421 some_error = TRUE; /* out of memory */
3422 goto nobackup;
3426 * Try to make the backup in each directory in the 'bdir' option.
3428 * Unix semantics has it, that we may have a writable file,
3429 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3430 * - the directory is not writable,
3431 * - the file may be a symbolic link,
3432 * - the file may belong to another user/group, etc.
3434 * For these reasons, the existing writable file must be truncated
3435 * and reused. Creation of a backup COPY will be attempted.
3437 dirp = p_bdir;
3438 while (*dirp)
3440 #ifdef UNIX
3441 st_new.st_ino = 0;
3442 st_new.st_dev = 0;
3443 st_new.st_gid = 0;
3444 #endif
3447 * Isolate one directory name, using an entry in 'bdir'.
3449 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3450 rootname = get_file_in_dir(fname, copybuf);
3451 if (rootname == NULL)
3453 some_error = TRUE; /* out of memory */
3454 goto nobackup;
3457 #if defined(UNIX) && !defined(SHORT_FNAME)
3458 did_set_shortname = FALSE;
3459 #endif
3462 * May try twice if 'shortname' not set.
3464 for (;;)
3467 * Make backup file name.
3469 backup = buf_modname(
3470 #ifdef SHORT_FNAME
3471 TRUE,
3472 #else
3473 (buf->b_p_sn || buf->b_shortname),
3474 #endif
3475 rootname, backup_ext, FALSE);
3476 if (backup == NULL)
3478 vim_free(rootname);
3479 some_error = TRUE; /* out of memory */
3480 goto nobackup;
3484 * Check if backup file already exists.
3486 if (mch_stat((char *)backup, &st_new) >= 0)
3488 #ifdef UNIX
3490 * Check if backup file is same as original file.
3491 * May happen when modname() gave the same file back.
3492 * E.g. silly link, or file name-length reached.
3493 * If we don't check here, we either ruin the file
3494 * when copying or erase it after writing. jw.
3496 if (st_new.st_dev == st_old.st_dev
3497 && st_new.st_ino == st_old.st_ino)
3499 vim_free(backup);
3500 backup = NULL; /* no backup file to delete */
3501 # ifndef SHORT_FNAME
3503 * may try again with 'shortname' set
3505 if (!(buf->b_shortname || buf->b_p_sn))
3507 buf->b_shortname = TRUE;
3508 did_set_shortname = TRUE;
3509 continue;
3511 /* setting shortname didn't help */
3512 if (did_set_shortname)
3513 buf->b_shortname = FALSE;
3514 # endif
3515 break;
3517 #endif
3520 * If we are not going to keep the backup file, don't
3521 * delete an existing one, try to use another name.
3522 * Change one character, just before the extension.
3524 if (!p_bk)
3526 wp = backup + STRLEN(backup) - 1
3527 - STRLEN(backup_ext);
3528 if (wp < backup) /* empty file name ??? */
3529 wp = backup;
3530 *wp = 'z';
3531 while (*wp > 'a'
3532 && mch_stat((char *)backup, &st_new) >= 0)
3533 --*wp;
3534 /* They all exist??? Must be something wrong. */
3535 if (*wp == 'a')
3537 vim_free(backup);
3538 backup = NULL;
3542 break;
3544 vim_free(rootname);
3547 * Try to create the backup file
3549 if (backup != NULL)
3551 /* remove old backup, if present */
3552 mch_remove(backup);
3553 /* Open with O_EXCL to avoid the file being created while
3554 * we were sleeping (symlink hacker attack?) */
3555 bfd = mch_open((char *)backup,
3556 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3557 perm & 0777);
3558 if (bfd < 0)
3560 vim_free(backup);
3561 backup = NULL;
3563 else
3565 /* set file protection same as original file, but
3566 * strip s-bit */
3567 (void)mch_setperm(backup, perm & 0777);
3569 #ifdef UNIX
3571 * Try to set the group of the backup same as the
3572 * original file. If this fails, set the protection
3573 * bits for the group same as the protection bits for
3574 * others.
3576 if (st_new.st_gid != st_old.st_gid
3577 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3578 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3579 # endif
3581 mch_setperm(backup,
3582 (perm & 0707) | ((perm & 07) << 3));
3583 #endif
3586 * copy the file.
3588 write_info.bw_fd = bfd;
3589 write_info.bw_buf = copybuf;
3590 #ifdef HAS_BW_FLAGS
3591 write_info.bw_flags = FIO_NOCONVERT;
3592 #endif
3593 while ((write_info.bw_len = vim_read(fd, copybuf,
3594 BUFSIZE)) > 0)
3596 if (buf_write_bytes(&write_info) == FAIL)
3598 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3599 break;
3601 ui_breakcheck();
3602 if (got_int)
3604 errmsg = (char_u *)_(e_interr);
3605 break;
3609 if (close(bfd) < 0 && errmsg == NULL)
3610 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3611 if (write_info.bw_len < 0)
3612 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3613 #ifdef UNIX
3614 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3615 #endif
3616 #ifdef HAVE_ACL
3617 mch_set_acl(backup, acl);
3618 #endif
3619 break;
3623 nobackup:
3624 close(fd); /* ignore errors for closing read file */
3625 vim_free(copybuf);
3627 if (backup == NULL && errmsg == NULL)
3628 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3629 /* ignore errors when forceit is TRUE */
3630 if ((some_error || errmsg != NULL) && !forceit)
3632 retval = FAIL;
3633 goto fail;
3635 errmsg = NULL;
3637 else
3639 char_u *dirp;
3640 char_u *p;
3641 char_u *rootname;
3644 * Make a backup by renaming the original file.
3647 * If 'cpoptions' includes the "W" flag, we don't want to
3648 * overwrite a read-only file. But rename may be possible
3649 * anyway, thus we need an extra check here.
3651 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3653 errnum = (char_u *)"E504: ";
3654 errmsg = (char_u *)_(err_readonly);
3655 goto fail;
3660 * Form the backup file name - change path/fo.o.h to
3661 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3662 * that works is used.
3664 dirp = p_bdir;
3665 while (*dirp)
3668 * Isolate one directory name and make the backup file name.
3670 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3671 rootname = get_file_in_dir(fname, IObuff);
3672 if (rootname == NULL)
3673 backup = NULL;
3674 else
3676 backup = buf_modname(
3677 #ifdef SHORT_FNAME
3678 TRUE,
3679 #else
3680 (buf->b_p_sn || buf->b_shortname),
3681 #endif
3682 rootname, backup_ext, FALSE);
3683 vim_free(rootname);
3686 if (backup != NULL)
3689 * If we are not going to keep the backup file, don't
3690 * delete an existing one, try to use another name.
3691 * Change one character, just before the extension.
3693 if (!p_bk && mch_getperm(backup) >= 0)
3695 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3696 if (p < backup) /* empty file name ??? */
3697 p = backup;
3698 *p = 'z';
3699 while (*p > 'a' && mch_getperm(backup) >= 0)
3700 --*p;
3701 /* They all exist??? Must be something wrong! */
3702 if (*p == 'a')
3704 vim_free(backup);
3705 backup = NULL;
3709 if (backup != NULL)
3712 * Delete any existing backup and move the current version
3713 * to the backup. For safety, we don't remove the backup
3714 * until the write has finished successfully. And if the
3715 * 'backup' option is set, leave it around.
3718 * If the renaming of the original file to the backup file
3719 * works, quit here.
3721 if (vim_rename(fname, backup) == 0)
3722 break;
3724 vim_free(backup); /* don't do the rename below */
3725 backup = NULL;
3728 if (backup == NULL && !forceit)
3730 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3731 goto fail;
3736 #if defined(UNIX) && !defined(ARCHIE)
3737 /* When using ":w!" and the file was read-only: make it writable */
3738 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3739 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3741 perm |= 0200;
3742 (void)mch_setperm(fname, perm);
3743 made_writable = TRUE;
3745 #endif
3747 /* When using ":w!" and writing to the current file, 'readonly' makes no
3748 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3749 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3751 buf->b_p_ro = FALSE;
3752 #ifdef FEAT_TITLE
3753 need_maketitle = TRUE; /* set window title later */
3754 #endif
3755 #ifdef FEAT_WINDOWS
3756 status_redraw_all(); /* redraw status lines later */
3757 #endif
3760 if (end > buf->b_ml.ml_line_count)
3761 end = buf->b_ml.ml_line_count;
3762 if (buf->b_ml.ml_flags & ML_EMPTY)
3763 start = end + 1;
3766 * If the original file is being overwritten, there is a small chance that
3767 * we crash in the middle of writing. Therefore the file is preserved now.
3768 * This makes all block numbers positive so that recovery does not need
3769 * the original file.
3770 * Don't do this if there is a backup file and we are exiting.
3772 if (reset_changed && !newfile && overwriting
3773 && !(exiting && backup != NULL))
3775 ml_preserve(buf, FALSE);
3776 if (got_int)
3778 errmsg = (char_u *)_(e_interr);
3779 goto restore_backup;
3783 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3785 * Before risking to lose the original file verify if there's
3786 * a resource fork to preserve, and if cannot be done warn
3787 * the users. This happens when overwriting without backups.
3789 if (backup == NULL && overwriting && !append)
3790 if (mch_has_resource_fork(fname))
3792 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3793 goto restore_backup;
3795 #endif
3797 #ifdef VMS
3798 vms_remove_version(fname); /* remove version */
3799 #endif
3800 /* Default: write the the file directly. May write to a temp file for
3801 * multi-byte conversion. */
3802 wfname = fname;
3804 #ifdef FEAT_MBYTE
3805 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3806 if (eap != NULL && eap->force_enc != 0)
3808 fenc = eap->cmd + eap->force_enc;
3809 fenc = enc_canonize(fenc);
3810 fenc_tofree = fenc;
3812 else
3813 fenc = buf->b_p_fenc;
3816 * The file needs to be converted when 'fileencoding' is set and
3817 * 'fileencoding' differs from 'encoding'.
3819 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
3822 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3823 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3824 * Prepare the flags for it and allocate bw_conv_buf when needed.
3826 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3828 wb_flags = get_fio_flags(fenc);
3829 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3831 /* Need to allocate a buffer to translate into. */
3832 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3833 write_info.bw_conv_buflen = bufsize * 2;
3834 else /* FIO_UCS4 */
3835 write_info.bw_conv_buflen = bufsize * 4;
3836 write_info.bw_conv_buf
3837 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3838 if (write_info.bw_conv_buf == NULL)
3839 end = 0;
3843 # ifdef WIN3264
3844 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
3846 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3847 write_info.bw_conv_buflen = bufsize * 4;
3848 write_info.bw_conv_buf
3849 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3850 if (write_info.bw_conv_buf == NULL)
3851 end = 0;
3853 # endif
3855 # ifdef MACOS_X
3856 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
3858 write_info.bw_conv_buflen = bufsize * 3;
3859 write_info.bw_conv_buf
3860 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3861 if (write_info.bw_conv_buf == NULL)
3862 end = 0;
3864 # endif
3866 # if defined(FEAT_EVAL) || defined(USE_ICONV)
3867 if (converted && wb_flags == 0)
3869 # ifdef USE_ICONV
3871 * Use iconv() conversion when conversion is needed and it's not done
3872 * internally.
3874 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
3875 enc_utf8 ? (char_u *)"utf-8" : p_enc);
3876 if (write_info.bw_iconv_fd != (iconv_t)-1)
3878 /* We're going to use iconv(), allocate a buffer to convert in. */
3879 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
3880 write_info.bw_conv_buf
3881 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3882 if (write_info.bw_conv_buf == NULL)
3883 end = 0;
3884 write_info.bw_first = TRUE;
3886 # ifdef FEAT_EVAL
3887 else
3888 # endif
3889 # endif
3891 # ifdef FEAT_EVAL
3893 * When the file needs to be converted with 'charconvert' after
3894 * writing, write to a temp file instead and let the conversion
3895 * overwrite the original file.
3897 if (*p_ccv != NUL)
3899 wfname = vim_tempname('w');
3900 if (wfname == NULL) /* Can't write without a tempfile! */
3902 errmsg = (char_u *)_("E214: Can't find temp file for writing");
3903 goto restore_backup;
3906 # endif
3908 # endif
3909 if (converted && wb_flags == 0
3910 # ifdef USE_ICONV
3911 && write_info.bw_iconv_fd == (iconv_t)-1
3912 # endif
3913 # ifdef FEAT_EVAL
3914 && wfname == fname
3915 # endif
3918 if (!forceit)
3920 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
3921 goto restore_backup;
3923 notconverted = TRUE;
3925 #endif
3928 * Open the file "wfname" for writing.
3929 * We may try to open the file twice: If we can't write to the
3930 * file and forceit is TRUE we delete the existing file and try to create
3931 * a new one. If this still fails we may have lost the original file!
3932 * (this may happen when the user reached his quotum for number of files).
3933 * Appending will fail if the file does not exist and forceit is FALSE.
3935 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
3936 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
3937 : (O_CREAT | O_TRUNC))
3938 , perm < 0 ? 0666 : (perm & 0777))) < 0)
3941 * A forced write will try to create a new file if the old one is
3942 * still readonly. This may also happen when the directory is
3943 * read-only. In that case the mch_remove() will fail.
3945 if (errmsg == NULL)
3947 #ifdef UNIX
3948 struct stat st;
3950 /* Don't delete the file when it's a hard or symbolic link. */
3951 if ((!newfile && st_old.st_nlink > 1)
3952 || (mch_lstat((char *)fname, &st) == 0
3953 && (st.st_dev != st_old.st_dev
3954 || st.st_ino != st_old.st_ino)))
3955 errmsg = (char_u *)_("E166: Can't open linked file for writing");
3956 else
3957 #endif
3959 errmsg = (char_u *)_("E212: Can't open file for writing");
3960 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
3961 && perm >= 0)
3963 #ifdef UNIX
3964 /* we write to the file, thus it should be marked
3965 writable after all */
3966 if (!(perm & 0200))
3967 made_writable = TRUE;
3968 perm |= 0200;
3969 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
3970 perm &= 0777;
3971 #endif
3972 if (!append) /* don't remove when appending */
3973 mch_remove(wfname);
3974 continue;
3979 restore_backup:
3981 struct stat st;
3984 * If we failed to open the file, we don't need a backup. Throw it
3985 * away. If we moved or removed the original file try to put the
3986 * backup in its place.
3988 if (backup != NULL && wfname == fname)
3990 if (backup_copy)
3993 * There is a small chance that we removed the original,
3994 * try to move the copy in its place.
3995 * This may not work if the vim_rename() fails.
3996 * In that case we leave the copy around.
3998 /* If file does not exist, put the copy in its place */
3999 if (mch_stat((char *)fname, &st) < 0)
4000 vim_rename(backup, fname);
4001 /* if original file does exist throw away the copy */
4002 if (mch_stat((char *)fname, &st) >= 0)
4003 mch_remove(backup);
4005 else
4007 /* try to put the original file back */
4008 vim_rename(backup, fname);
4012 /* if original file no longer exists give an extra warning */
4013 if (!newfile && mch_stat((char *)fname, &st) < 0)
4014 end = 0;
4017 #ifdef FEAT_MBYTE
4018 if (wfname != fname)
4019 vim_free(wfname);
4020 #endif
4021 goto fail;
4023 errmsg = NULL;
4025 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4026 /* TODO: Is it need for MACOS_X? (Dany) */
4028 * On macintosh copy the original files attributes (i.e. the backup)
4029 * This is done in order to preserve the ressource fork and the
4030 * Finder attribute (label, comments, custom icons, file creatore)
4032 if (backup != NULL && overwriting && !append)
4034 if (backup_copy)
4035 (void)mch_copy_file_attribute(wfname, backup);
4036 else
4037 (void)mch_copy_file_attribute(backup, wfname);
4040 if (!overwriting && !append)
4042 if (buf->b_ffname != NULL)
4043 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4044 /* Should copy ressource fork */
4046 #endif
4048 write_info.bw_fd = fd;
4050 #ifdef FEAT_CRYPT
4051 if (*buf->b_p_key && !filtering)
4053 crypt_init_keys(buf->b_p_key);
4054 /* Write magic number, so that Vim knows that this file is encrypted
4055 * when reading it again. This also undergoes utf-8 to ucs-2/4
4056 * conversion when needed. */
4057 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4058 write_info.bw_len = CRYPT_MAGIC_LEN;
4059 write_info.bw_flags = FIO_NOCONVERT;
4060 if (buf_write_bytes(&write_info) == FAIL)
4061 end = 0;
4062 wb_flags |= FIO_ENCRYPTED;
4064 #endif
4066 write_info.bw_buf = buffer;
4067 nchars = 0;
4069 /* use "++bin", "++nobin" or 'binary' */
4070 if (eap != NULL && eap->force_bin != 0)
4071 write_bin = (eap->force_bin == FORCE_BIN);
4072 else
4073 write_bin = buf->b_p_bin;
4075 #ifdef FEAT_MBYTE
4077 * The BOM is written just after the encryption magic number.
4078 * Skip it when appending and the file already existed, the BOM only makes
4079 * sense at the start of the file.
4081 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4083 write_info.bw_len = make_bom(buffer, fenc);
4084 if (write_info.bw_len > 0)
4086 /* don't convert, do encryption */
4087 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4088 if (buf_write_bytes(&write_info) == FAIL)
4089 end = 0;
4090 else
4091 nchars += write_info.bw_len;
4094 #endif
4096 write_info.bw_len = bufsize;
4097 #ifdef HAS_BW_FLAGS
4098 write_info.bw_flags = wb_flags;
4099 #endif
4100 fileformat = get_fileformat_force(buf, eap);
4101 s = buffer;
4102 len = 0;
4103 for (lnum = start; lnum <= end; ++lnum)
4106 * The next while loop is done once for each character written.
4107 * Keep it fast!
4109 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4110 while ((c = *++ptr) != NUL)
4112 if (c == NL)
4113 *s = NUL; /* replace newlines with NULs */
4114 else if (c == CAR && fileformat == EOL_MAC)
4115 *s = NL; /* Mac: replace CRs with NLs */
4116 else
4117 *s = c;
4118 ++s;
4119 if (++len != bufsize)
4120 continue;
4121 if (buf_write_bytes(&write_info) == FAIL)
4123 end = 0; /* write error: break loop */
4124 break;
4126 nchars += bufsize;
4127 s = buffer;
4128 len = 0;
4130 /* write failed or last line has no EOL: stop here */
4131 if (end == 0
4132 || (lnum == end
4133 && write_bin
4134 && (lnum == write_no_eol_lnum
4135 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4137 ++lnum; /* written the line, count it */
4138 no_eol = TRUE;
4139 break;
4141 if (fileformat == EOL_UNIX)
4142 *s++ = NL;
4143 else
4145 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4146 if (fileformat == EOL_DOS) /* write CR-NL */
4148 if (++len == bufsize)
4150 if (buf_write_bytes(&write_info) == FAIL)
4152 end = 0; /* write error: break loop */
4153 break;
4155 nchars += bufsize;
4156 s = buffer;
4157 len = 0;
4159 *s++ = NL;
4162 if (++len == bufsize && end)
4164 if (buf_write_bytes(&write_info) == FAIL)
4166 end = 0; /* write error: break loop */
4167 break;
4169 nchars += bufsize;
4170 s = buffer;
4171 len = 0;
4173 ui_breakcheck();
4174 if (got_int)
4176 end = 0; /* Interrupted, break loop */
4177 break;
4180 #ifdef VMS
4182 * On VMS there is a problem: newlines get added when writing blocks
4183 * at a time. Fix it by writing a line at a time.
4184 * This is much slower!
4185 * Explanation: VAX/DECC RTL insists that records in some RMS
4186 * structures end with a newline (carriage return) character, and if
4187 * they don't it adds one.
4188 * With other RMS structures it works perfect without this fix.
4190 if ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0)
4192 int b2write;
4194 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4195 ? MIN(4096, bufsize)
4196 : MIN(buf->b_fab_mrs, bufsize));
4198 b2write = len;
4199 while (b2write > 0)
4201 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4202 if (buf_write_bytes(&write_info) == FAIL)
4204 end = 0;
4205 break;
4207 b2write -= MIN(b2write, buf->b_fab_mrs);
4209 write_info.bw_len = bufsize;
4210 nchars += len;
4211 s = buffer;
4212 len = 0;
4214 #endif
4216 if (len > 0 && end > 0)
4218 write_info.bw_len = len;
4219 if (buf_write_bytes(&write_info) == FAIL)
4220 end = 0; /* write error */
4221 nchars += len;
4224 #if defined(UNIX) && defined(HAVE_FSYNC)
4225 /* On many journalling file systems there is a bug that causes both the
4226 * original and the backup file to be lost when halting the system right
4227 * after writing the file. That's because only the meta-data is
4228 * journalled. Syncing the file slows down the system, but assures it has
4229 * been written to disk and we don't lose it.
4230 * For a device do try the fsync() but don't complain if it does not work
4231 * (could be a pipe).
4232 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4233 if (p_fs && fsync(fd) != 0 && !device)
4235 errmsg = (char_u *)_("E667: Fsync failed");
4236 end = 0;
4238 #endif
4240 #ifdef UNIX
4241 /* When creating a new file, set its owner/group to that of the original
4242 * file. Get the new device and inode number. */
4243 if (backup != NULL && !backup_copy)
4245 # ifdef HAVE_FCHOWN
4246 struct stat st;
4248 /* don't change the owner when it's already OK, some systems remove
4249 * permission or ACL stuff */
4250 if (mch_stat((char *)wfname, &st) < 0
4251 || st.st_uid != st_old.st_uid
4252 || st.st_gid != st_old.st_gid)
4254 fchown(fd, st_old.st_uid, st_old.st_gid);
4255 if (perm >= 0) /* set permission again, may have changed */
4256 (void)mch_setperm(wfname, perm);
4258 # endif
4259 buf_setino(buf);
4261 else if (buf->b_dev < 0)
4262 /* Set the inode when creating a new file. */
4263 buf_setino(buf);
4264 #endif
4266 if (close(fd) != 0)
4268 errmsg = (char_u *)_("E512: Close failed");
4269 end = 0;
4272 #ifdef UNIX
4273 if (made_writable)
4274 perm &= ~0200; /* reset 'w' bit for security reasons */
4275 #endif
4276 if (perm >= 0) /* set perm. of new file same as old file */
4277 (void)mch_setperm(wfname, perm);
4278 #ifdef RISCOS
4279 if (!append && !filtering)
4280 /* Set the filetype after writing the file. */
4281 mch_set_filetype(wfname, buf->b_p_oft);
4282 #endif
4283 #ifdef HAVE_ACL
4284 /* Probably need to set the ACL before changing the user (can't set the
4285 * ACL on a file the user doesn't own). */
4286 if (!backup_copy)
4287 mch_set_acl(wfname, acl);
4288 #endif
4291 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4292 if (wfname != fname)
4295 * The file was written to a temp file, now it needs to be converted
4296 * with 'charconvert' to (overwrite) the output file.
4298 if (end != 0)
4300 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4301 wfname, fname) == FAIL)
4303 write_info.bw_conv_error = TRUE;
4304 end = 0;
4307 mch_remove(wfname);
4308 vim_free(wfname);
4310 #endif
4312 if (end == 0)
4314 if (errmsg == NULL)
4316 #ifdef FEAT_MBYTE
4317 if (write_info.bw_conv_error)
4318 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4319 else
4320 #endif
4321 if (got_int)
4322 errmsg = (char_u *)_(e_interr);
4323 else
4324 errmsg = (char_u *)_("E514: write error (file system full?)");
4328 * If we have a backup file, try to put it in place of the new file,
4329 * because the new file is probably corrupt. This avoids loosing the
4330 * original file when trying to make a backup when writing the file a
4331 * second time.
4332 * When "backup_copy" is set we need to copy the backup over the new
4333 * file. Otherwise rename the backup file.
4334 * If this is OK, don't give the extra warning message.
4336 if (backup != NULL)
4338 if (backup_copy)
4340 /* This may take a while, if we were interrupted let the user
4341 * know we got the message. */
4342 if (got_int)
4344 MSG(_(e_interr));
4345 out_flush();
4347 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4349 if ((write_info.bw_fd = mch_open((char *)fname,
4350 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4351 perm & 0777)) >= 0)
4353 /* copy the file. */
4354 write_info.bw_buf = smallbuf;
4355 #ifdef HAS_BW_FLAGS
4356 write_info.bw_flags = FIO_NOCONVERT;
4357 #endif
4358 while ((write_info.bw_len = vim_read(fd, smallbuf,
4359 SMBUFSIZE)) > 0)
4360 if (buf_write_bytes(&write_info) == FAIL)
4361 break;
4363 if (close(write_info.bw_fd) >= 0
4364 && write_info.bw_len == 0)
4365 end = 1; /* success */
4367 close(fd); /* ignore errors for closing read file */
4370 else
4372 if (vim_rename(backup, fname) == 0)
4373 end = 1;
4376 goto fail;
4379 lnum -= start; /* compute number of written lines */
4380 --no_wait_return; /* may wait for return now */
4382 #if !(defined(UNIX) || defined(VMS))
4383 fname = sfname; /* use shortname now, for the messages */
4384 #endif
4385 if (!filtering)
4387 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4388 c = FALSE;
4389 #ifdef FEAT_MBYTE
4390 if (write_info.bw_conv_error)
4392 STRCAT(IObuff, _(" CONVERSION ERROR"));
4393 c = TRUE;
4395 else if (notconverted)
4397 STRCAT(IObuff, _("[NOT converted]"));
4398 c = TRUE;
4400 else if (converted)
4402 STRCAT(IObuff, _("[converted]"));
4403 c = TRUE;
4405 #endif
4406 if (device)
4408 STRCAT(IObuff, _("[Device]"));
4409 c = TRUE;
4411 else if (newfile)
4413 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4414 c = TRUE;
4416 if (no_eol)
4418 msg_add_eol();
4419 c = TRUE;
4421 /* may add [unix/dos/mac] */
4422 if (msg_add_fileformat(fileformat))
4423 c = TRUE;
4424 #ifdef FEAT_CRYPT
4425 if (wb_flags & FIO_ENCRYPTED)
4427 STRCAT(IObuff, _("[crypted]"));
4428 c = TRUE;
4430 #endif
4431 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4432 if (!shortmess(SHM_WRITE))
4434 if (append)
4435 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4436 else
4437 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4440 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4443 /* When written everything correctly: reset 'modified'. Unless not
4444 * writing to the original file and '+' is not in 'cpoptions'. */
4445 if (reset_changed && whole && !append
4446 #ifdef FEAT_MBYTE
4447 && !write_info.bw_conv_error
4448 #endif
4449 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4452 unchanged(buf, TRUE);
4453 u_unchanged(buf);
4457 * If written to the current file, update the timestamp of the swap file
4458 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4460 if (overwriting)
4462 ml_timestamp(buf);
4463 if (append)
4464 buf->b_flags &= ~BF_NEW;
4465 else
4466 buf->b_flags &= ~BF_WRITE_MASK;
4470 * If we kept a backup until now, and we are in patch mode, then we make
4471 * the backup file our 'original' file.
4473 if (*p_pm && dobackup)
4475 char *org = (char *)buf_modname(
4476 #ifdef SHORT_FNAME
4477 TRUE,
4478 #else
4479 (buf->b_p_sn || buf->b_shortname),
4480 #endif
4481 fname, p_pm, FALSE);
4483 if (backup != NULL)
4485 struct stat st;
4488 * If the original file does not exist yet
4489 * the current backup file becomes the original file
4491 if (org == NULL)
4492 EMSG(_("E205: Patchmode: can't save original file"));
4493 else if (mch_stat(org, &st) < 0)
4495 vim_rename(backup, (char_u *)org);
4496 vim_free(backup); /* don't delete the file */
4497 backup = NULL;
4498 #ifdef UNIX
4499 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4500 #endif
4504 * If there is no backup file, remember that a (new) file was
4505 * created.
4507 else
4509 int empty_fd;
4511 if (org == NULL
4512 || (empty_fd = mch_open(org,
4513 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4514 perm < 0 ? 0666 : (perm & 0777))) < 0)
4515 EMSG(_("E206: patchmode: can't touch empty original file"));
4516 else
4517 close(empty_fd);
4519 if (org != NULL)
4521 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4522 vim_free(org);
4527 * Remove the backup unless 'backup' option is set
4529 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4530 EMSG(_("E207: Can't delete backup file"));
4532 #ifdef FEAT_SUN_WORKSHOP
4533 if (usingSunWorkShop)
4534 workshop_file_saved((char *) ffname);
4535 #endif
4537 goto nofail;
4540 * Finish up. We get here either after failure or success.
4542 fail:
4543 --no_wait_return; /* may wait for return now */
4544 nofail:
4546 /* Done saving, we accept changed buffer warnings again */
4547 buf->b_saving = FALSE;
4549 vim_free(backup);
4550 if (buffer != smallbuf)
4551 vim_free(buffer);
4552 #ifdef FEAT_MBYTE
4553 vim_free(fenc_tofree);
4554 vim_free(write_info.bw_conv_buf);
4555 # ifdef USE_ICONV
4556 if (write_info.bw_iconv_fd != (iconv_t)-1)
4558 iconv_close(write_info.bw_iconv_fd);
4559 write_info.bw_iconv_fd = (iconv_t)-1;
4561 # endif
4562 #endif
4563 #ifdef HAVE_ACL
4564 mch_free_acl(acl);
4565 #endif
4567 if (errmsg != NULL)
4569 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4571 attr = hl_attr(HLF_E); /* set highlight for error messages */
4572 msg_add_fname(buf,
4573 #ifndef UNIX
4574 sfname
4575 #else
4576 fname
4577 #endif
4578 ); /* put file name in IObuff with quotes */
4579 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4580 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4581 /* If the error message has the form "is ...", put the error number in
4582 * front of the file name. */
4583 if (errnum != NULL)
4585 mch_memmove(IObuff + numlen, IObuff, STRLEN(IObuff) + 1);
4586 mch_memmove(IObuff, errnum, (size_t)numlen);
4588 STRCAT(IObuff, errmsg);
4589 emsg(IObuff);
4591 retval = FAIL;
4592 if (end == 0)
4594 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4595 attr | MSG_HIST);
4596 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4597 attr | MSG_HIST);
4599 /* Update the timestamp to avoid an "overwrite changed file"
4600 * prompt when writing again. */
4601 if (mch_stat((char *)fname, &st_old) >= 0)
4603 buf_store_time(buf, &st_old, fname);
4604 buf->b_mtime_read = buf->b_mtime;
4608 msg_scroll = msg_save;
4610 #ifdef FEAT_AUTOCMD
4611 #ifdef FEAT_EVAL
4612 if (!should_abort(retval))
4613 #else
4614 if (!got_int)
4615 #endif
4617 aco_save_T aco;
4619 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4622 * Apply POST autocommands.
4623 * Careful: The autocommands may call buf_write() recursively!
4625 aucmd_prepbuf(&aco, buf);
4627 if (append)
4628 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4629 FALSE, curbuf, eap);
4630 else if (filtering)
4631 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4632 FALSE, curbuf, eap);
4633 else if (reset_changed && whole)
4634 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4635 FALSE, curbuf, eap);
4636 else
4637 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4638 FALSE, curbuf, eap);
4640 /* restore curwin/curbuf and a few other things */
4641 aucmd_restbuf(&aco);
4643 #ifdef FEAT_EVAL
4644 if (aborting()) /* autocmds may abort script processing */
4645 retval = FALSE;
4646 #endif
4648 #endif
4650 got_int |= prev_got_int;
4652 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4653 /* Update machine specific information. */
4654 mch_post_buffer_write(buf);
4655 #endif
4656 return retval;
4660 * Set the name of the current buffer. Use when the buffer doesn't have a
4661 * name and a ":r" or ":w" command with a file name is used.
4663 static int
4664 set_rw_fname(fname, sfname)
4665 char_u *fname;
4666 char_u *sfname;
4668 #ifdef FEAT_AUTOCMD
4669 /* It's like the unnamed buffer is deleted.... */
4670 if (curbuf->b_p_bl)
4671 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4672 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4673 # ifdef FEAT_EVAL
4674 if (aborting()) /* autocmds may abort script processing */
4675 return FAIL;
4676 # endif
4677 #endif
4679 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4680 curbuf->b_flags |= BF_NOTEDITED;
4682 #ifdef FEAT_AUTOCMD
4683 /* ....and a new named one is created */
4684 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4685 if (curbuf->b_p_bl)
4686 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4687 # ifdef FEAT_EVAL
4688 if (aborting()) /* autocmds may abort script processing */
4689 return FAIL;
4690 # endif
4692 /* Do filetype detection now if 'filetype' is empty. */
4693 if (*curbuf->b_p_ft == NUL)
4695 if (au_has_group((char_u *)"filetypedetect"))
4696 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4697 do_modelines(0);
4699 #endif
4701 return OK;
4705 * Put file name into IObuff with quotes.
4707 void
4708 msg_add_fname(buf, fname)
4709 buf_T *buf;
4710 char_u *fname;
4712 if (fname == NULL)
4713 fname = (char_u *)"-stdin-";
4714 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4715 IObuff[0] = '"';
4716 STRCAT(IObuff, "\" ");
4720 * Append message for text mode to IObuff.
4721 * Return TRUE if something appended.
4723 static int
4724 msg_add_fileformat(eol_type)
4725 int eol_type;
4727 #ifndef USE_CRNL
4728 if (eol_type == EOL_DOS)
4730 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4731 return TRUE;
4733 #endif
4734 #ifndef USE_CR
4735 if (eol_type == EOL_MAC)
4737 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4738 return TRUE;
4740 #endif
4741 #if defined(USE_CRNL) || defined(USE_CR)
4742 if (eol_type == EOL_UNIX)
4744 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4745 return TRUE;
4747 #endif
4748 return FALSE;
4752 * Append line and character count to IObuff.
4754 void
4755 msg_add_lines(insert_space, lnum, nchars)
4756 int insert_space;
4757 long lnum;
4758 long nchars;
4760 char_u *p;
4762 p = IObuff + STRLEN(IObuff);
4764 if (insert_space)
4765 *p++ = ' ';
4766 if (shortmess(SHM_LINES))
4767 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4768 else
4770 if (lnum == 1)
4771 STRCPY(p, _("1 line, "));
4772 else
4773 sprintf((char *)p, _("%ld lines, "), lnum);
4774 p += STRLEN(p);
4775 if (nchars == 1)
4776 STRCPY(p, _("1 character"));
4777 else
4778 sprintf((char *)p, _("%ld characters"), nchars);
4783 * Append message for missing line separator to IObuff.
4785 static void
4786 msg_add_eol()
4788 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4792 * Check modification time of file, before writing to it.
4793 * The size isn't checked, because using a tool like "gzip" takes care of
4794 * using the same timestamp but can't set the size.
4796 static int
4797 check_mtime(buf, st)
4798 buf_T *buf;
4799 struct stat *st;
4801 if (buf->b_mtime_read != 0
4802 && time_differs((long)st->st_mtime, buf->b_mtime_read))
4804 msg_scroll = TRUE; /* don't overwrite messages here */
4805 msg_silent = 0; /* must give this prompt */
4806 /* don't use emsg() here, don't want to flush the buffers */
4807 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4808 hl_attr(HLF_E));
4809 if (ask_yesno((char_u *)_("Do you really want to write to it"),
4810 TRUE) == 'n')
4811 return FAIL;
4812 msg_scroll = FALSE; /* always overwrite the file message now */
4814 return OK;
4817 static int
4818 time_differs(t1, t2)
4819 long t1, t2;
4821 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4822 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4823 * the seconds. Since the roundoff is done when flushing the inode, the
4824 * time may change unexpectedly by one second!!! */
4825 return (t1 - t2 > 1 || t2 - t1 > 1);
4826 #else
4827 return (t1 != t2);
4828 #endif
4832 * Call write() to write a number of bytes to the file.
4833 * Also handles encryption and 'encoding' conversion.
4835 * Return FAIL for failure, OK otherwise.
4837 static int
4838 buf_write_bytes(ip)
4839 struct bw_info *ip;
4841 int wlen;
4842 char_u *buf = ip->bw_buf; /* data to write */
4843 int len = ip->bw_len; /* length of data */
4844 #ifdef HAS_BW_FLAGS
4845 int flags = ip->bw_flags; /* extra flags */
4846 #endif
4848 #ifdef FEAT_MBYTE
4850 * Skip conversion when writing the crypt magic number or the BOM.
4852 if (!(flags & FIO_NOCONVERT))
4854 char_u *p;
4855 unsigned c;
4856 int n;
4858 if (flags & FIO_UTF8)
4861 * Convert latin1 in the buffer to UTF-8 in the file.
4863 p = ip->bw_conv_buf; /* translate to buffer */
4864 for (wlen = 0; wlen < len; ++wlen)
4865 p += utf_char2bytes(buf[wlen], p);
4866 buf = ip->bw_conv_buf;
4867 len = (int)(p - ip->bw_conv_buf);
4869 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
4872 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
4873 * Latin1 chars in the file.
4875 if (flags & FIO_LATIN1)
4876 p = buf; /* translate in-place (can only get shorter) */
4877 else
4878 p = ip->bw_conv_buf; /* translate to buffer */
4879 for (wlen = 0; wlen < len; wlen += n)
4881 if (wlen == 0 && ip->bw_restlen != 0)
4883 int l;
4885 /* Use remainder of previous call. Append the start of
4886 * buf[] to get a full sequence. Might still be too
4887 * short! */
4888 l = CONV_RESTLEN - ip->bw_restlen;
4889 if (l > len)
4890 l = len;
4891 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
4892 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
4893 if (n > ip->bw_restlen + len)
4895 /* We have an incomplete byte sequence at the end to
4896 * be written. We can't convert it without the
4897 * remaining bytes. Keep them for the next call. */
4898 if (ip->bw_restlen + len > CONV_RESTLEN)
4899 return FAIL;
4900 ip->bw_restlen += len;
4901 break;
4903 if (n > 1)
4904 c = utf_ptr2char(ip->bw_rest);
4905 else
4906 c = ip->bw_rest[0];
4907 if (n >= ip->bw_restlen)
4909 n -= ip->bw_restlen;
4910 ip->bw_restlen = 0;
4912 else
4914 ip->bw_restlen -= n;
4915 mch_memmove(ip->bw_rest, ip->bw_rest + n,
4916 (size_t)ip->bw_restlen);
4917 n = 0;
4920 else
4922 n = utf_ptr2len_len(buf + wlen, len - wlen);
4923 if (n > len - wlen)
4925 /* We have an incomplete byte sequence at the end to
4926 * be written. We can't convert it without the
4927 * remaining bytes. Keep them for the next call. */
4928 if (len - wlen > CONV_RESTLEN)
4929 return FAIL;
4930 ip->bw_restlen = len - wlen;
4931 mch_memmove(ip->bw_rest, buf + wlen,
4932 (size_t)ip->bw_restlen);
4933 break;
4935 if (n > 1)
4936 c = utf_ptr2char(buf + wlen);
4937 else
4938 c = buf[wlen];
4941 ip->bw_conv_error |= ucs2bytes(c, &p, flags);
4943 if (flags & FIO_LATIN1)
4944 len = (int)(p - buf);
4945 else
4947 buf = ip->bw_conv_buf;
4948 len = (int)(p - ip->bw_conv_buf);
4952 # ifdef WIN3264
4953 else if (flags & FIO_CODEPAGE)
4956 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
4957 * codepage.
4959 char_u *from;
4960 size_t fromlen;
4961 char_u *to;
4962 int u8c;
4963 BOOL bad = FALSE;
4964 int needed;
4966 if (ip->bw_restlen > 0)
4968 /* Need to concatenate the remainder of the previous call and
4969 * the bytes of the current call. Use the end of the
4970 * conversion buffer for this. */
4971 fromlen = len + ip->bw_restlen;
4972 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
4973 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
4974 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
4976 else
4978 from = buf;
4979 fromlen = len;
4982 to = ip->bw_conv_buf;
4983 if (enc_utf8)
4985 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
4986 * The buffer has been allocated to be big enough. */
4987 while (fromlen > 0)
4989 n = (int)utf_ptr2len_len(from, (int)fromlen);
4990 if (n > (int)fromlen) /* incomplete byte sequence */
4991 break;
4992 u8c = utf_ptr2char(from);
4993 *to++ = (u8c & 0xff);
4994 *to++ = (u8c >> 8);
4995 fromlen -= n;
4996 from += n;
4999 /* Copy remainder to ip->bw_rest[] to be used for the next
5000 * call. */
5001 if (fromlen > CONV_RESTLEN)
5003 /* weird overlong sequence */
5004 ip->bw_conv_error = TRUE;
5005 return FAIL;
5007 mch_memmove(ip->bw_rest, from, fromlen);
5008 ip->bw_restlen = (int)fromlen;
5010 else
5012 /* Convert from enc_codepage to UCS-2, to the start of the
5013 * buffer. The buffer has been allocated to be big enough. */
5014 ip->bw_restlen = 0;
5015 needed = MultiByteToWideChar(enc_codepage,
5016 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5017 NULL, 0);
5018 if (needed == 0)
5020 /* When conversion fails there may be a trailing byte. */
5021 needed = MultiByteToWideChar(enc_codepage,
5022 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5023 NULL, 0);
5024 if (needed == 0)
5026 /* Conversion doesn't work. */
5027 ip->bw_conv_error = TRUE;
5028 return FAIL;
5030 /* Save the trailing byte for the next call. */
5031 ip->bw_rest[0] = from[fromlen - 1];
5032 ip->bw_restlen = 1;
5034 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5035 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5036 (LPWSTR)to, needed);
5037 if (needed == 0)
5039 /* Safety check: Conversion doesn't work. */
5040 ip->bw_conv_error = TRUE;
5041 return FAIL;
5043 to += needed * 2;
5046 fromlen = to - ip->bw_conv_buf;
5047 buf = to;
5048 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5049 if (FIO_GET_CP(flags) == CP_UTF8)
5051 /* Convert from UCS-2 to UTF-8, using the remainder of the
5052 * conversion buffer. Fails when out of space. */
5053 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5055 u8c = *from++;
5056 u8c += (*from++ << 8);
5057 to += utf_char2bytes(u8c, to);
5058 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5060 ip->bw_conv_error = TRUE;
5061 return FAIL;
5064 len = (int)(to - buf);
5066 else
5067 #endif
5069 /* Convert from UCS-2 to the codepage, using the remainder of
5070 * the conversion buffer. If the conversion uses the default
5071 * character "0", the data doesn't fit in this encoding, so
5072 * fail. */
5073 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5074 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5075 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0, &bad);
5076 if (bad)
5078 ip->bw_conv_error = TRUE;
5079 return FAIL;
5083 # endif
5085 # ifdef MACOS_CONVERT
5086 else if (flags & FIO_MACROMAN)
5089 * Convert UTF-8 or latin1 to Apple MacRoman.
5091 char_u *from;
5092 size_t fromlen;
5094 if (ip->bw_restlen > 0)
5096 /* Need to concatenate the remainder of the previous call and
5097 * the bytes of the current call. Use the end of the
5098 * conversion buffer for this. */
5099 fromlen = len + ip->bw_restlen;
5100 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5101 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5102 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5104 else
5106 from = buf;
5107 fromlen = len;
5110 if (enc2macroman(from, fromlen,
5111 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5112 ip->bw_rest, &ip->bw_restlen) == FAIL)
5114 ip->bw_conv_error = TRUE;
5115 return FAIL;
5117 buf = ip->bw_conv_buf;
5119 # endif
5121 # ifdef USE_ICONV
5122 if (ip->bw_iconv_fd != (iconv_t)-1)
5124 const char *from;
5125 size_t fromlen;
5126 char *to;
5127 size_t tolen;
5129 /* Convert with iconv(). */
5130 if (ip->bw_restlen > 0)
5132 /* Need to concatenate the remainder of the previous call and
5133 * the bytes of the current call. Use the end of the
5134 * conversion buffer for this. */
5135 fromlen = len + ip->bw_restlen;
5136 from = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5137 mch_memmove((void *)from, ip->bw_rest, (size_t)ip->bw_restlen);
5138 mch_memmove((void *)(from + ip->bw_restlen), buf, (size_t)len);
5139 tolen = ip->bw_conv_buflen - fromlen;
5141 else
5143 from = (const char *)buf;
5144 fromlen = len;
5145 tolen = ip->bw_conv_buflen;
5147 to = (char *)ip->bw_conv_buf;
5149 if (ip->bw_first)
5151 size_t save_len = tolen;
5153 /* output the initial shift state sequence */
5154 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5156 /* There is a bug in iconv() on Linux (which appears to be
5157 * wide-spread) which sets "to" to NULL and messes up "tolen".
5159 if (to == NULL)
5161 to = (char *)ip->bw_conv_buf;
5162 tolen = save_len;
5164 ip->bw_first = FALSE;
5168 * If iconv() has an error or there is not enough room, fail.
5170 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5171 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5172 || fromlen > CONV_RESTLEN)
5174 ip->bw_conv_error = TRUE;
5175 return FAIL;
5178 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5179 if (fromlen > 0)
5180 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5181 ip->bw_restlen = (int)fromlen;
5183 buf = ip->bw_conv_buf;
5184 len = (int)((char_u *)to - ip->bw_conv_buf);
5186 # endif
5188 #endif /* FEAT_MBYTE */
5190 #ifdef FEAT_CRYPT
5191 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5193 int ztemp, t, i;
5195 for (i = 0; i < len; i++)
5197 ztemp = buf[i];
5198 buf[i] = ZENCODE(ztemp, t);
5201 #endif
5203 /* Repeat the write(), it may be interrupted by a signal. */
5204 while (len)
5206 wlen = vim_write(ip->bw_fd, buf, len);
5207 if (wlen <= 0) /* error! */
5208 return FAIL;
5209 len -= wlen;
5210 buf += wlen;
5212 return OK;
5215 #ifdef FEAT_MBYTE
5217 * Convert a Unicode character to bytes.
5219 static int
5220 ucs2bytes(c, pp, flags)
5221 unsigned c; /* in: character */
5222 char_u **pp; /* in/out: pointer to result */
5223 int flags; /* FIO_ flags */
5225 char_u *p = *pp;
5226 int error = FALSE;
5227 int cc;
5230 if (flags & FIO_UCS4)
5232 if (flags & FIO_ENDIAN_L)
5234 *p++ = c;
5235 *p++ = (c >> 8);
5236 *p++ = (c >> 16);
5237 *p++ = (c >> 24);
5239 else
5241 *p++ = (c >> 24);
5242 *p++ = (c >> 16);
5243 *p++ = (c >> 8);
5244 *p++ = c;
5247 else if (flags & (FIO_UCS2 | FIO_UTF16))
5249 if (c >= 0x10000)
5251 if (flags & FIO_UTF16)
5253 /* Make two words, ten bits of the character in each. First
5254 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5255 c -= 0x10000;
5256 if (c >= 0x100000)
5257 error = TRUE;
5258 cc = ((c >> 10) & 0x3ff) + 0xd800;
5259 if (flags & FIO_ENDIAN_L)
5261 *p++ = cc;
5262 *p++ = ((unsigned)cc >> 8);
5264 else
5266 *p++ = ((unsigned)cc >> 8);
5267 *p++ = cc;
5269 c = (c & 0x3ff) + 0xdc00;
5271 else
5272 error = TRUE;
5274 if (flags & FIO_ENDIAN_L)
5276 *p++ = c;
5277 *p++ = (c >> 8);
5279 else
5281 *p++ = (c >> 8);
5282 *p++ = c;
5285 else /* Latin1 */
5287 if (c >= 0x100)
5289 error = TRUE;
5290 *p++ = 0xBF;
5292 else
5293 *p++ = c;
5296 *pp = p;
5297 return error;
5301 * Return TRUE if "a" and "b" are the same 'encoding'.
5302 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5304 static int
5305 same_encoding(a, b)
5306 char_u *a;
5307 char_u *b;
5309 int f;
5311 if (STRCMP(a, b) == 0)
5312 return TRUE;
5313 f = get_fio_flags(a);
5314 return (f != 0 && get_fio_flags(b) == f);
5318 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5319 * internal conversion.
5320 * if "ptr" is an empty string, use 'encoding'.
5322 static int
5323 get_fio_flags(ptr)
5324 char_u *ptr;
5326 int prop;
5328 if (*ptr == NUL)
5329 ptr = p_enc;
5331 prop = enc_canon_props(ptr);
5332 if (prop & ENC_UNICODE)
5334 if (prop & ENC_2BYTE)
5336 if (prop & ENC_ENDIAN_L)
5337 return FIO_UCS2 | FIO_ENDIAN_L;
5338 return FIO_UCS2;
5340 if (prop & ENC_4BYTE)
5342 if (prop & ENC_ENDIAN_L)
5343 return FIO_UCS4 | FIO_ENDIAN_L;
5344 return FIO_UCS4;
5346 if (prop & ENC_2WORD)
5348 if (prop & ENC_ENDIAN_L)
5349 return FIO_UTF16 | FIO_ENDIAN_L;
5350 return FIO_UTF16;
5352 return FIO_UTF8;
5354 if (prop & ENC_LATIN1)
5355 return FIO_LATIN1;
5356 /* must be ENC_DBCS, requires iconv() */
5357 return 0;
5360 #ifdef WIN3264
5362 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5363 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5364 * Used for conversion between 'encoding' and 'fileencoding'.
5366 static int
5367 get_win_fio_flags(ptr)
5368 char_u *ptr;
5370 int cp;
5372 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5373 if (!enc_utf8 && enc_codepage <= 0)
5374 return 0;
5376 cp = encname2codepage(ptr);
5377 if (cp == 0)
5379 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5380 if (STRCMP(ptr, "utf-8") == 0)
5381 cp = CP_UTF8;
5382 else
5383 # endif
5384 return 0;
5386 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5388 #endif
5390 #ifdef MACOS_X
5392 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5393 * needed for the internal conversion to/from utf-8 or latin1.
5395 static int
5396 get_mac_fio_flags(ptr)
5397 char_u *ptr;
5399 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5400 && (enc_canon_props(ptr) & ENC_MACROMAN))
5401 return FIO_MACROMAN;
5402 return 0;
5404 #endif
5407 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5408 * "size" must be at least 2.
5409 * Return the name of the encoding and set "*lenp" to the length.
5410 * Returns NULL when no BOM found.
5412 static char_u *
5413 check_for_bom(p, size, lenp, flags)
5414 char_u *p;
5415 long size;
5416 int *lenp;
5417 int flags;
5419 char *name = NULL;
5420 int len = 2;
5422 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5423 && (flags == FIO_ALL || flags == 0))
5425 name = "utf-8"; /* EF BB BF */
5426 len = 3;
5428 else if (p[0] == 0xff && p[1] == 0xfe)
5430 if (size >= 4 && p[2] == 0 && p[3] == 0
5431 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5433 name = "ucs-4le"; /* FF FE 00 00 */
5434 len = 4;
5436 else if (flags == FIO_ALL || flags == (FIO_UCS2 | FIO_ENDIAN_L))
5437 name = "ucs-2le"; /* FF FE */
5438 else if (flags == (FIO_UTF16 | FIO_ENDIAN_L))
5439 name = "utf-16le"; /* FF FE */
5441 else if (p[0] == 0xfe && p[1] == 0xff
5442 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5444 if (flags == FIO_UTF16)
5445 name = "utf-16"; /* FE FF */
5446 else
5447 name = "ucs-2"; /* FE FF */
5449 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5450 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5452 name = "ucs-4"; /* 00 00 FE FF */
5453 len = 4;
5456 *lenp = len;
5457 return (char_u *)name;
5461 * Generate a BOM in "buf[4]" for encoding "name".
5462 * Return the length of the BOM (zero when no BOM).
5464 static int
5465 make_bom(buf, name)
5466 char_u *buf;
5467 char_u *name;
5469 int flags;
5470 char_u *p;
5472 flags = get_fio_flags(name);
5474 /* Can't put a BOM in a non-Unicode file. */
5475 if (flags == FIO_LATIN1 || flags == 0)
5476 return 0;
5478 if (flags == FIO_UTF8) /* UTF-8 */
5480 buf[0] = 0xef;
5481 buf[1] = 0xbb;
5482 buf[2] = 0xbf;
5483 return 3;
5485 p = buf;
5486 (void)ucs2bytes(0xfeff, &p, flags);
5487 return (int)(p - buf);
5489 #endif
5492 * Try to find a shortname by comparing the fullname with the current
5493 * directory.
5494 * Returns NULL if not shorter name possible, pointer into "full_path"
5495 * otherwise.
5497 char_u *
5498 shorten_fname(full_path, dir_name)
5499 char_u *full_path;
5500 char_u *dir_name;
5502 int len;
5503 char_u *p;
5505 if (full_path == NULL)
5506 return NULL;
5507 len = (int)STRLEN(dir_name);
5508 if (fnamencmp(dir_name, full_path, len) == 0)
5510 p = full_path + len;
5511 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5513 * MSDOS: when a file is in the root directory, dir_name will end in a
5514 * slash, since C: by itself does not define a specific dir. In this
5515 * case p may already be correct. <negri>
5517 if (!((len > 2) && (*(p - 2) == ':')))
5518 #endif
5520 if (vim_ispathsep(*p))
5521 ++p;
5522 #ifndef VMS /* the path separator is always part of the path */
5523 else
5524 p = NULL;
5525 #endif
5528 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5530 * When using a file in the current drive, remove the drive name:
5531 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5532 * a floppy from "A:\dir" to "B:\dir".
5534 else if (len > 3
5535 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5536 && full_path[1] == ':'
5537 && vim_ispathsep(full_path[2]))
5538 p = full_path + 2;
5539 #endif
5540 else
5541 p = NULL;
5542 return p;
5546 * Shorten filenames for all buffers.
5547 * When "force" is TRUE: Use full path from now on for files currently being
5548 * edited, both for file name and swap file name. Try to shorten the file
5549 * names a bit, if safe to do so.
5550 * When "force" is FALSE: Only try to shorten absolute file names.
5551 * For buffers that have buftype "nofile" or "scratch": never change the file
5552 * name.
5554 void
5555 shorten_fnames(force)
5556 int force;
5558 char_u dirname[MAXPATHL];
5559 buf_T *buf;
5560 char_u *p;
5562 mch_dirname(dirname, MAXPATHL);
5563 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5565 if (buf->b_fname != NULL
5566 #ifdef FEAT_QUICKFIX
5567 && !bt_nofile(buf)
5568 #endif
5569 && !path_with_url(buf->b_fname)
5570 && (force
5571 || buf->b_sfname == NULL
5572 || mch_isFullName(buf->b_sfname)))
5574 vim_free(buf->b_sfname);
5575 buf->b_sfname = NULL;
5576 p = shorten_fname(buf->b_ffname, dirname);
5577 if (p != NULL)
5579 buf->b_sfname = vim_strsave(p);
5580 buf->b_fname = buf->b_sfname;
5582 if (p == NULL || buf->b_fname == NULL)
5583 buf->b_fname = buf->b_ffname;
5586 /* Always make the swap file name a full path, a "nofile" buffer may
5587 * also have a swap file. */
5588 mf_fullname(buf->b_ml.ml_mfp);
5590 #ifdef FEAT_WINDOWS
5591 status_redraw_all();
5592 redraw_tabline = TRUE;
5593 #endif
5596 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5597 || defined(FEAT_GUI_MSWIN) \
5598 || defined(FEAT_GUI_MAC) \
5599 || defined(PROTO)
5601 * Shorten all filenames in "fnames[count]" by current directory.
5603 void
5604 shorten_filenames(fnames, count)
5605 char_u **fnames;
5606 int count;
5608 int i;
5609 char_u dirname[MAXPATHL];
5610 char_u *p;
5612 if (fnames == NULL || count < 1)
5613 return;
5614 mch_dirname(dirname, sizeof(dirname));
5615 for (i = 0; i < count; ++i)
5617 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5619 /* shorten_fname() returns pointer in given "fnames[i]". If free
5620 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5621 * "p" first then free fnames[i]. */
5622 p = vim_strsave(p);
5623 vim_free(fnames[i]);
5624 fnames[i] = p;
5628 #endif
5631 * add extention to file name - change path/fo.o.h to path/fo.o.h.ext or
5632 * fo_o_h.ext for MSDOS or when shortname option set.
5634 * Assumed that fname is a valid name found in the filesystem we assure that
5635 * the return value is a different name and ends in 'ext'.
5636 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5637 * characters otherwise.
5638 * Space for the returned name is allocated, must be freed later.
5639 * Returns NULL when out of memory.
5641 char_u *
5642 modname(fname, ext, prepend_dot)
5643 char_u *fname, *ext;
5644 int prepend_dot; /* may prepend a '.' to file name */
5646 return buf_modname(
5647 #ifdef SHORT_FNAME
5648 TRUE,
5649 #else
5650 (curbuf->b_p_sn || curbuf->b_shortname),
5651 #endif
5652 fname, ext, prepend_dot);
5655 char_u *
5656 buf_modname(shortname, fname, ext, prepend_dot)
5657 int shortname; /* use 8.3 file name */
5658 char_u *fname, *ext;
5659 int prepend_dot; /* may prepend a '.' to file name */
5661 char_u *retval;
5662 char_u *s;
5663 char_u *e;
5664 char_u *ptr;
5665 int fnamelen, extlen;
5667 extlen = (int)STRLEN(ext);
5670 * If there is no file name we must get the name of the current directory
5671 * (we need the full path in case :cd is used).
5673 if (fname == NULL || *fname == NUL)
5675 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5676 if (retval == NULL)
5677 return NULL;
5678 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5679 (fnamelen = (int)STRLEN(retval)) == 0)
5681 vim_free(retval);
5682 return NULL;
5684 if (!after_pathsep(retval, retval + fnamelen))
5686 retval[fnamelen++] = PATHSEP;
5687 retval[fnamelen] = NUL;
5689 #ifndef SHORT_FNAME
5690 prepend_dot = FALSE; /* nothing to prepend a dot to */
5691 #endif
5693 else
5695 fnamelen = (int)STRLEN(fname);
5696 retval = alloc((unsigned)(fnamelen + extlen + 3));
5697 if (retval == NULL)
5698 return NULL;
5699 STRCPY(retval, fname);
5700 #ifdef VMS
5701 vms_remove_version(retval); /* we do not need versions here */
5702 #endif
5706 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5707 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5708 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5709 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5711 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5713 #ifndef RISCOS
5714 if (*ext == '.'
5715 # ifdef USE_LONG_FNAME
5716 && (!USE_LONG_FNAME || shortname)
5717 # else
5718 # ifndef SHORT_FNAME
5719 && shortname
5720 # endif
5721 # endif
5723 if (*ptr == '.') /* replace '.' by '_' */
5724 *ptr = '_';
5725 #endif
5726 if (vim_ispathsep(*ptr))
5728 ++ptr;
5729 break;
5733 /* the file name has at most BASENAMELEN characters. */
5734 #ifndef SHORT_FNAME
5735 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5736 ptr[BASENAMELEN] = '\0';
5737 #endif
5739 s = ptr + STRLEN(ptr);
5742 * For 8.3 file names we may have to reduce the length.
5744 #ifdef USE_LONG_FNAME
5745 if (!USE_LONG_FNAME || shortname)
5746 #else
5747 # ifndef SHORT_FNAME
5748 if (shortname)
5749 # endif
5750 #endif
5753 * If there is no file name, or the file name ends in '/', and the
5754 * extension starts with '.', put a '_' before the dot, because just
5755 * ".ext" is invalid.
5757 if (fname == NULL || *fname == NUL
5758 || vim_ispathsep(fname[STRLEN(fname) - 1]))
5760 #ifdef RISCOS
5761 if (*ext == '/')
5762 #else
5763 if (*ext == '.')
5764 #endif
5765 *s++ = '_';
5768 * If the extension starts with '.', truncate the base name at 8
5769 * characters
5771 #ifdef RISCOS
5772 /* We normally use '/', but swap files are '_' */
5773 else if (*ext == '/' || *ext == '_')
5774 #else
5775 else if (*ext == '.')
5776 #endif
5778 if (s - ptr > (size_t)8)
5780 s = ptr + 8;
5781 *s = '\0';
5785 * If the extension doesn't start with '.', and the file name
5786 * doesn't have an extension yet, append a '.'
5788 #ifdef RISCOS
5789 else if ((e = vim_strchr(ptr, '/')) == NULL)
5790 *s++ = '/';
5791 #else
5792 else if ((e = vim_strchr(ptr, '.')) == NULL)
5793 *s++ = '.';
5794 #endif
5796 * If the extension doesn't start with '.', and there already is an
5797 * extension, it may need to be tructated
5799 else if ((int)STRLEN(e) + extlen > 4)
5800 s = e + 4 - extlen;
5802 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5804 * If there is no file name, and the extension starts with '.', put a
5805 * '_' before the dot, because just ".ext" may be invalid if it's on a
5806 * FAT partition, and on HPFS it doesn't matter.
5808 else if ((fname == NULL || *fname == NUL) && *ext == '.')
5809 *s++ = '_';
5810 #endif
5813 * Append the extention.
5814 * ext can start with '.' and cannot exceed 3 more characters.
5816 STRCPY(s, ext);
5818 #ifndef SHORT_FNAME
5820 * Prepend the dot.
5822 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
5823 #ifdef RISCOS
5825 #else
5827 #endif
5828 #ifdef USE_LONG_FNAME
5829 && USE_LONG_FNAME
5830 #endif
5833 mch_memmove(e + 1, e, STRLEN(e) + 1);
5834 #ifdef RISCOS
5835 *e = '/';
5836 #else
5837 *e = '.';
5838 #endif
5840 #endif
5843 * Check that, after appending the extension, the file name is really
5844 * different.
5846 if (fname != NULL && STRCMP(fname, retval) == 0)
5848 /* we search for a character that can be replaced by '_' */
5849 while (--s >= ptr)
5851 if (*s != '_')
5853 *s = '_';
5854 break;
5857 if (s < ptr) /* fname was "________.<ext>", how tricky! */
5858 *ptr = 'v';
5860 return retval;
5864 * Like fgets(), but if the file line is too long, it is truncated and the
5865 * rest of the line is thrown away. Returns TRUE for end-of-file.
5868 vim_fgets(buf, size, fp)
5869 char_u *buf;
5870 int size;
5871 FILE *fp;
5873 char *eof;
5874 #define FGETS_SIZE 200
5875 char tbuf[FGETS_SIZE];
5877 buf[size - 2] = NUL;
5878 #ifdef USE_CR
5879 eof = fgets_cr((char *)buf, size, fp);
5880 #else
5881 eof = fgets((char *)buf, size, fp);
5882 #endif
5883 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
5885 buf[size - 1] = NUL; /* Truncate the line */
5887 /* Now throw away the rest of the line: */
5890 tbuf[FGETS_SIZE - 2] = NUL;
5891 #ifdef USE_CR
5892 fgets_cr((char *)tbuf, FGETS_SIZE, fp);
5893 #else
5894 fgets((char *)tbuf, FGETS_SIZE, fp);
5895 #endif
5896 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
5898 return (eof == NULL);
5901 #if defined(USE_CR) || defined(PROTO)
5903 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
5904 * Returns TRUE for end-of-file.
5905 * Only used for the Mac, because it's much slower than vim_fgets().
5908 tag_fgets(buf, size, fp)
5909 char_u *buf;
5910 int size;
5911 FILE *fp;
5913 int i = 0;
5914 int c;
5915 int eof = FALSE;
5917 for (;;)
5919 c = fgetc(fp);
5920 if (c == EOF)
5922 eof = TRUE;
5923 break;
5925 if (c == '\r')
5927 /* Always store a NL for end-of-line. */
5928 if (i < size - 1)
5929 buf[i++] = '\n';
5930 c = fgetc(fp);
5931 if (c != '\n') /* Macintosh format: single CR. */
5932 ungetc(c, fp);
5933 break;
5935 if (i < size - 1)
5936 buf[i++] = c;
5937 if (c == '\n')
5938 break;
5940 buf[i] = NUL;
5941 return eof;
5943 #endif
5946 * rename() only works if both files are on the same file system, this
5947 * function will (attempts to?) copy the file across if rename fails -- webb
5948 * Return -1 for failure, 0 for success.
5951 vim_rename(from, to)
5952 char_u *from;
5953 char_u *to;
5955 int fd_in;
5956 int fd_out;
5957 int n;
5958 char *errmsg = NULL;
5959 char *buffer;
5960 #ifdef AMIGA
5961 BPTR flock;
5962 #endif
5963 struct stat st;
5964 long perm;
5965 #ifdef HAVE_ACL
5966 vim_acl_T acl; /* ACL from original file */
5967 #endif
5970 * When the names are identical, there is nothing to do.
5972 if (fnamecmp(from, to) == 0)
5973 return 0;
5976 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
5978 if (mch_stat((char *)from, &st) < 0)
5979 return -1;
5982 * Delete the "to" file, this is required on some systems to make the
5983 * mch_rename() work, on other systems it makes sure that we don't have
5984 * two files when the mch_rename() fails.
5987 #ifdef AMIGA
5989 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
5990 * that the name of the "to" file is the same as the "from" file, even
5991 * though the names are different. To avoid the chance of accidently
5992 * deleting the "from" file (horror!) we lock it during the remove.
5994 * When used for making a backup before writing the file: This should not
5995 * happen with ":w", because startscript() should detect this problem and
5996 * set buf->b_shortname, causing modname() to return a correct ".bak" file
5997 * name. This problem does exist with ":w filename", but then the
5998 * original file will be somewhere else so the backup isn't really
5999 * important. If autoscripting is off the rename may fail.
6001 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6002 #endif
6003 mch_remove(to);
6004 #ifdef AMIGA
6005 if (flock)
6006 UnLock(flock);
6007 #endif
6010 * First try a normal rename, return if it works.
6012 if (mch_rename((char *)from, (char *)to) == 0)
6013 return 0;
6016 * Rename() failed, try copying the file.
6018 perm = mch_getperm(from);
6019 #ifdef HAVE_ACL
6020 /* For systems that support ACL: get the ACL from the original file. */
6021 acl = mch_get_acl(from);
6022 #endif
6023 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6024 if (fd_in == -1)
6025 return -1;
6027 /* Create the new file with same permissions as the original. */
6028 fd_out = mch_open((char *)to,
6029 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6030 if (fd_out == -1)
6032 close(fd_in);
6033 return -1;
6036 buffer = (char *)alloc(BUFSIZE);
6037 if (buffer == NULL)
6039 close(fd_in);
6040 close(fd_out);
6041 return -1;
6044 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6045 if (vim_write(fd_out, buffer, n) != n)
6047 errmsg = _("E208: Error writing to \"%s\"");
6048 break;
6051 vim_free(buffer);
6052 close(fd_in);
6053 if (close(fd_out) < 0)
6054 errmsg = _("E209: Error closing \"%s\"");
6055 if (n < 0)
6057 errmsg = _("E210: Error reading \"%s\"");
6058 to = from;
6060 #ifndef UNIX /* for Unix mch_open() already set ther permission */
6061 mch_setperm(to, perm);
6062 #endif
6063 #ifdef HAVE_ACL
6064 mch_set_acl(to, acl);
6065 #endif
6066 if (errmsg != NULL)
6068 EMSG2(errmsg, to);
6069 return -1;
6071 mch_remove(from);
6072 return 0;
6075 static int already_warned = FALSE;
6078 * Check if any not hidden buffer has been changed.
6079 * Postpone the check if there are characters in the stuff buffer, a global
6080 * command is being executed, a mapping is being executed or an autocommand is
6081 * busy.
6082 * Returns TRUE if some message was written (screen should be redrawn and
6083 * cursor positioned).
6086 check_timestamps(focus)
6087 int focus; /* called for GUI focus event */
6089 buf_T *buf;
6090 int didit = 0;
6091 int n;
6093 /* Don't check timestamps while system() or another low-level function may
6094 * cause us to lose and gain focus. */
6095 if (no_check_timestamps > 0)
6096 return FALSE;
6098 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6099 * event and we would keep on checking if the file is steadily growing.
6100 * Do check again after typing something. */
6101 if (focus && did_check_timestamps)
6103 need_check_timestamps = TRUE;
6104 return FALSE;
6107 if (!stuff_empty() || global_busy || !typebuf_typed()
6108 #ifdef FEAT_AUTOCMD
6109 || autocmd_busy || curbuf_lock > 0
6110 #endif
6112 need_check_timestamps = TRUE; /* check later */
6113 else
6115 ++no_wait_return;
6116 did_check_timestamps = TRUE;
6117 already_warned = FALSE;
6118 for (buf = firstbuf; buf != NULL; )
6120 /* Only check buffers in a window. */
6121 if (buf->b_nwindows > 0)
6123 n = buf_check_timestamp(buf, focus);
6124 if (didit < n)
6125 didit = n;
6126 if (n > 0 && !buf_valid(buf))
6128 /* Autocommands have removed the buffer, start at the
6129 * first one again. */
6130 buf = firstbuf;
6131 continue;
6134 buf = buf->b_next;
6136 --no_wait_return;
6137 need_check_timestamps = FALSE;
6138 if (need_wait_return && didit == 2)
6140 /* make sure msg isn't overwritten */
6141 msg_puts((char_u *)"\n");
6142 out_flush();
6145 return didit;
6149 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6150 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6151 * empty.
6153 static int
6154 move_lines(frombuf, tobuf)
6155 buf_T *frombuf;
6156 buf_T *tobuf;
6158 buf_T *tbuf = curbuf;
6159 int retval = OK;
6160 linenr_T lnum;
6161 char_u *p;
6163 /* Copy the lines in "frombuf" to "tobuf". */
6164 curbuf = tobuf;
6165 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6167 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6168 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6170 vim_free(p);
6171 retval = FAIL;
6172 break;
6174 vim_free(p);
6177 /* Delete all the lines in "frombuf". */
6178 if (retval != FAIL)
6180 curbuf = frombuf;
6181 while (!bufempty())
6182 if (ml_delete(curbuf->b_ml.ml_line_count, FALSE) == FAIL)
6184 /* Oops! We could try putting back the saved lines, but that
6185 * might fail again... */
6186 retval = FAIL;
6187 break;
6191 curbuf = tbuf;
6192 return retval;
6196 * Check if buffer "buf" has been changed.
6197 * Also check if the file for a new buffer unexpectedly appeared.
6198 * return 1 if a changed buffer was found.
6199 * return 2 if a message has been displayed.
6200 * return 0 otherwise.
6202 /*ARGSUSED*/
6204 buf_check_timestamp(buf, focus)
6205 buf_T *buf;
6206 int focus; /* called for GUI focus event */
6208 struct stat st;
6209 int stat_res;
6210 int retval = 0;
6211 char_u *path;
6212 char_u *tbuf;
6213 char *mesg = NULL;
6214 char *mesg2 = "";
6215 int helpmesg = FALSE;
6216 int reload = FALSE;
6217 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6218 int can_reload = FALSE;
6219 #endif
6220 size_t orig_size = buf->b_orig_size;
6221 int orig_mode = buf->b_orig_mode;
6222 #ifdef FEAT_GUI
6223 int save_mouse_correct = need_mouse_correct;
6224 #endif
6225 #ifdef FEAT_AUTOCMD
6226 static int busy = FALSE;
6227 int n;
6228 char_u *s;
6229 #endif
6230 char *reason;
6232 /* If there is no file name, the buffer is not loaded, 'buftype' is
6233 * set, we are in the middle of a save or being called recursively: ignore
6234 * this buffer. */
6235 if (buf->b_ffname == NULL
6236 || buf->b_ml.ml_mfp == NULL
6237 #if defined(FEAT_QUICKFIX)
6238 || *buf->b_p_bt != NUL
6239 #endif
6240 || buf->b_saving
6241 #ifdef FEAT_AUTOCMD
6242 || busy
6243 #endif
6244 #ifdef FEAT_NETBEANS_INTG
6245 || isNetbeansBuffer(buf)
6246 #endif
6248 return 0;
6250 if ( !(buf->b_flags & BF_NOTEDITED)
6251 && buf->b_mtime != 0
6252 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6253 || time_differs((long)st.st_mtime, buf->b_mtime)
6254 #ifdef HAVE_ST_MODE
6255 || (int)st.st_mode != buf->b_orig_mode
6256 #else
6257 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6258 #endif
6261 retval = 1;
6263 /* set b_mtime to stop further warnings (e.g., when executing
6264 * FileChangedShell autocmd) */
6265 if (stat_res < 0)
6267 buf->b_mtime = 0;
6268 buf->b_orig_size = 0;
6269 buf->b_orig_mode = 0;
6271 else
6272 buf_store_time(buf, &st, buf->b_ffname);
6274 /* Don't do anything for a directory. Might contain the file
6275 * explorer. */
6276 if (mch_isdir(buf->b_fname))
6280 * If 'autoread' is set, the buffer has no changes and the file still
6281 * exists, reload the buffer. Use the buffer-local option value if it
6282 * was set, the global option value otherwise.
6284 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6285 && !bufIsChanged(buf) && stat_res >= 0)
6286 reload = TRUE;
6287 else
6289 if (stat_res < 0)
6290 reason = "deleted";
6291 else if (bufIsChanged(buf))
6292 reason = "conflict";
6293 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6294 reason = "changed";
6295 else if (orig_mode != buf->b_orig_mode)
6296 reason = "mode";
6297 else
6298 reason = "time";
6300 #ifdef FEAT_AUTOCMD
6302 * Only give the warning if there are no FileChangedShell
6303 * autocommands.
6304 * Avoid being called recursively by setting "busy".
6306 busy = TRUE;
6307 # ifdef FEAT_EVAL
6308 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6309 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6310 # endif
6311 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6312 buf->b_fname, buf->b_fname, FALSE, buf);
6313 busy = FALSE;
6314 if (n)
6316 if (!buf_valid(buf))
6317 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6318 # ifdef FEAT_EVAL
6319 s = get_vim_var_str(VV_FCS_CHOICE);
6320 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6321 reload = TRUE;
6322 else if (STRCMP(s, "ask") == 0)
6323 n = FALSE;
6324 else
6325 # endif
6326 return 2;
6328 if (!n)
6329 #endif
6331 if (*reason == 'd')
6332 mesg = _("E211: File \"%s\" no longer available");
6333 else
6335 helpmesg = TRUE;
6336 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6337 can_reload = TRUE;
6338 #endif
6340 * Check if the file contents really changed to avoid
6341 * giving a warning when only the timestamp was set (e.g.,
6342 * checked out of CVS). Always warn when the buffer was
6343 * changed.
6345 if (reason[2] == 'n')
6347 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6348 mesg2 = _("See \":help W12\" for more info.");
6350 else if (reason[1] == 'h')
6352 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6353 mesg2 = _("See \":help W11\" for more info.");
6355 else if (*reason == 'm')
6357 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6358 mesg2 = _("See \":help W16\" for more info.");
6360 /* Else: only timestamp changed, ignored */
6366 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6367 && vim_fexists(buf->b_ffname))
6369 retval = 1;
6370 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6371 buf->b_flags |= BF_NEW_W;
6372 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6373 can_reload = TRUE;
6374 #endif
6377 if (mesg != NULL)
6379 path = home_replace_save(buf, buf->b_fname);
6380 if (path != NULL)
6382 if (!helpmesg)
6383 mesg2 = "";
6384 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6385 + STRLEN(mesg2) + 2));
6386 sprintf((char *)tbuf, mesg, path);
6387 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6388 if (can_reload)
6390 if (*mesg2 != NUL)
6392 STRCAT(tbuf, "\n");
6393 STRCAT(tbuf, mesg2);
6395 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6396 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6397 reload = TRUE;
6399 else
6400 #endif
6401 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6403 if (*mesg2 != NUL)
6405 STRCAT(tbuf, "; ");
6406 STRCAT(tbuf, mesg2);
6408 EMSG(tbuf);
6409 retval = 2;
6411 else
6413 # ifdef FEAT_AUTOCMD
6414 if (!autocmd_busy)
6415 # endif
6417 msg_start();
6418 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6419 if (*mesg2 != NUL)
6420 msg_puts_attr((char_u *)mesg2,
6421 hl_attr(HLF_W) + MSG_HIST);
6422 msg_clr_eos();
6423 (void)msg_end();
6424 if (emsg_silent == 0)
6426 out_flush();
6427 # ifdef FEAT_GUI
6428 if (!focus)
6429 # endif
6430 /* give the user some time to think about it */
6431 ui_delay(1000L, TRUE);
6433 /* don't redraw and erase the message */
6434 redraw_cmdline = FALSE;
6437 already_warned = TRUE;
6440 vim_free(path);
6441 vim_free(tbuf);
6445 if (reload)
6446 /* Reload the buffer. */
6447 buf_reload(buf, orig_mode);
6449 #ifdef FEAT_AUTOCMD
6450 if (buf_valid(buf))
6451 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6452 buf->b_fname, buf->b_fname, FALSE, buf);
6453 #endif
6454 #ifdef FEAT_GUI
6455 /* restore this in case an autocommand has set it; it would break
6456 * 'mousefocus' */
6457 need_mouse_correct = save_mouse_correct;
6458 #endif
6460 return retval;
6464 * Reload a buffer that is already loaded.
6465 * Used when the file was changed outside of Vim.
6466 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6467 * buf->b_orig_mode may have been reset already.
6469 void
6470 buf_reload(buf, orig_mode)
6471 buf_T *buf;
6472 int orig_mode;
6474 exarg_T ea;
6475 pos_T old_cursor;
6476 linenr_T old_topline;
6477 int old_ro = buf->b_p_ro;
6478 buf_T *savebuf;
6479 int saved = OK;
6480 aco_save_T aco;
6482 /* set curwin/curbuf for "buf" and save some things */
6483 aucmd_prepbuf(&aco, buf);
6485 /* We only want to read the text from the file, not reset the syntax
6486 * highlighting, clear marks, diff status, etc. Force the fileformat
6487 * and encoding to be the same. */
6488 if (prep_exarg(&ea, buf) == OK)
6490 old_cursor = curwin->w_cursor;
6491 old_topline = curwin->w_topline;
6494 * To behave like when a new file is edited (matters for
6495 * BufReadPost autocommands) we first need to delete the current
6496 * buffer contents. But if reading the file fails we should keep
6497 * the old contents. Can't use memory only, the file might be
6498 * too big. Use a hidden buffer to move the buffer contents to.
6500 if (bufempty())
6501 savebuf = NULL;
6502 else
6504 /* Allocate a buffer without putting it in the buffer list. */
6505 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6506 if (savebuf != NULL && buf == curbuf)
6508 /* Open the memline. */
6509 curbuf = savebuf;
6510 curwin->w_buffer = savebuf;
6511 saved = ml_open(curbuf);
6512 curbuf = buf;
6513 curwin->w_buffer = buf;
6515 if (savebuf == NULL || saved == FAIL || buf != curbuf
6516 || move_lines(buf, savebuf) == FAIL)
6518 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6519 buf->b_fname);
6520 saved = FAIL;
6524 if (saved == OK)
6526 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6527 #ifdef FEAT_AUTOCMD
6528 keep_filetype = TRUE; /* don't detect 'filetype' */
6529 #endif
6530 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6531 (linenr_T)0,
6532 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6534 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6535 if (!aborting())
6536 #endif
6537 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6538 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6540 /* Put the text back from the save buffer. First
6541 * delete any lines that readfile() added. */
6542 while (!bufempty())
6543 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6544 break;
6545 (void)move_lines(savebuf, buf);
6548 else if (buf == curbuf)
6550 /* Mark the buffer as unmodified and free undo info. */
6551 unchanged(buf, TRUE);
6552 u_blockfree(buf);
6553 u_clearall(buf);
6556 vim_free(ea.cmd);
6558 if (savebuf != NULL && buf_valid(savebuf))
6559 wipe_buffer(savebuf, FALSE);
6561 #ifdef FEAT_DIFF
6562 /* Invalidate diff info if necessary. */
6563 diff_invalidate(curbuf);
6564 #endif
6566 /* Restore the topline and cursor position and check it (lines may
6567 * have been removed). */
6568 if (old_topline > curbuf->b_ml.ml_line_count)
6569 curwin->w_topline = curbuf->b_ml.ml_line_count;
6570 else
6571 curwin->w_topline = old_topline;
6572 curwin->w_cursor = old_cursor;
6573 check_cursor();
6574 update_topline();
6575 #ifdef FEAT_AUTOCMD
6576 keep_filetype = FALSE;
6577 #endif
6578 #ifdef FEAT_FOLDING
6580 win_T *wp;
6582 /* Update folds unless they are defined manually. */
6583 FOR_ALL_WINDOWS(wp)
6584 if (wp->w_buffer == curwin->w_buffer
6585 && !foldmethodIsManual(wp))
6586 foldUpdateAll(wp);
6588 #endif
6589 /* If the mode didn't change and 'readonly' was set, keep the old
6590 * value; the user probably used the ":view" command. But don't
6591 * reset it, might have had a read error. */
6592 if (orig_mode == curbuf->b_orig_mode)
6593 curbuf->b_p_ro |= old_ro;
6596 /* restore curwin/curbuf and a few other things */
6597 aucmd_restbuf(&aco);
6598 /* Careful: autocommands may have made "buf" invalid! */
6601 /*ARGSUSED*/
6602 void
6603 buf_store_time(buf, st, fname)
6604 buf_T *buf;
6605 struct stat *st;
6606 char_u *fname;
6608 buf->b_mtime = (long)st->st_mtime;
6609 buf->b_orig_size = (size_t)st->st_size;
6610 #ifdef HAVE_ST_MODE
6611 buf->b_orig_mode = (int)st->st_mode;
6612 #else
6613 buf->b_orig_mode = mch_getperm(fname);
6614 #endif
6618 * Adjust the line with missing eol, used for the next write.
6619 * Used for do_filter(), when the input lines for the filter are deleted.
6621 void
6622 write_lnum_adjust(offset)
6623 linenr_T offset;
6625 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
6626 write_no_eol_lnum += offset;
6629 #if defined(TEMPDIRNAMES) || defined(PROTO)
6630 static long temp_count = 0; /* Temp filename counter. */
6633 * Delete the temp directory and all files it contains.
6635 void
6636 vim_deltempdir()
6638 char_u **files;
6639 int file_count;
6640 int i;
6642 if (vim_tempdir != NULL)
6644 sprintf((char *)NameBuff, "%s*", vim_tempdir);
6645 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
6646 EW_DIR|EW_FILE|EW_SILENT) == OK)
6648 for (i = 0; i < file_count; ++i)
6649 mch_remove(files[i]);
6650 FreeWild(file_count, files);
6652 gettail(NameBuff)[-1] = NUL;
6653 (void)mch_rmdir(NameBuff);
6655 vim_free(vim_tempdir);
6656 vim_tempdir = NULL;
6659 #endif
6662 * vim_tempname(): Return a unique name that can be used for a temp file.
6664 * The temp file is NOT created.
6666 * The returned pointer is to allocated memory.
6667 * The returned pointer is NULL if no valid name was found.
6669 /*ARGSUSED*/
6670 char_u *
6671 vim_tempname(extra_char)
6672 int extra_char; /* character to use in the name instead of '?' */
6674 #ifdef USE_TMPNAM
6675 char_u itmp[L_tmpnam]; /* use tmpnam() */
6676 #else
6677 char_u itmp[TEMPNAMELEN];
6678 #endif
6680 #ifdef TEMPDIRNAMES
6681 static char *(tempdirs[]) = {TEMPDIRNAMES};
6682 int i;
6683 long nr;
6684 long off;
6685 # ifndef EEXIST
6686 struct stat st;
6687 # endif
6690 * This will create a directory for private use by this instance of Vim.
6691 * This is done once, and the same directory is used for all temp files.
6692 * This method avoids security problems because of symlink attacks et al.
6693 * It's also a bit faster, because we only need to check for an existing
6694 * file when creating the directory and not for each temp file.
6696 if (vim_tempdir == NULL)
6699 * Try the entries in TEMPDIRNAMES to create the temp directory.
6701 for (i = 0; i < sizeof(tempdirs) / sizeof(char *); ++i)
6703 /* expand $TMP, leave room for "/v1100000/999999999" */
6704 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
6705 if (mch_isdir(itmp)) /* directory exists */
6707 # ifdef __EMX__
6708 /* If $TMP contains a forward slash (perhaps using bash or
6709 * tcsh), don't add a backslash, use a forward slash!
6710 * Adding 2 backslashes didn't work. */
6711 if (vim_strchr(itmp, '/') != NULL)
6712 STRCAT(itmp, "/");
6713 else
6714 # endif
6715 add_pathsep(itmp);
6717 /* Get an arbitrary number of up to 6 digits. When it's
6718 * unlikely that it already exists it will be faster,
6719 * otherwise it doesn't matter. The use of mkdir() avoids any
6720 * security problems because of the predictable number. */
6721 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
6723 /* Try up to 10000 different values until we find a name that
6724 * doesn't exist. */
6725 for (off = 0; off < 10000L; ++off)
6727 int r;
6728 #if defined(UNIX) || defined(VMS)
6729 mode_t umask_save;
6730 #endif
6732 sprintf((char *)itmp + STRLEN(itmp), "v%ld", nr + off);
6733 # ifndef EEXIST
6734 /* If mkdir() does not set errno to EEXIST, check for
6735 * existing file here. There is a race condition then,
6736 * although it's fail-safe. */
6737 if (mch_stat((char *)itmp, &st) >= 0)
6738 continue;
6739 # endif
6740 #if defined(UNIX) || defined(VMS)
6741 /* Make sure the umask doesn't remove the executable bit.
6742 * "repl" has been reported to use "177". */
6743 umask_save = umask(077);
6744 #endif
6745 r = vim_mkdir(itmp, 0700);
6746 #if defined(UNIX) || defined(VMS)
6747 (void)umask(umask_save);
6748 #endif
6749 if (r == 0)
6751 char_u *buf;
6753 /* Directory was created, use this name.
6754 * Expand to full path; When using the current
6755 * directory a ":cd" would confuse us. */
6756 buf = alloc((unsigned)MAXPATHL + 1);
6757 if (buf != NULL)
6759 if (vim_FullName(itmp, buf, MAXPATHL, FALSE)
6760 == FAIL)
6761 STRCPY(buf, itmp);
6762 # ifdef __EMX__
6763 if (vim_strchr(buf, '/') != NULL)
6764 STRCAT(buf, "/");
6765 else
6766 # endif
6767 add_pathsep(buf);
6768 vim_tempdir = vim_strsave(buf);
6769 vim_free(buf);
6771 break;
6773 # ifdef EEXIST
6774 /* If the mkdir() didn't fail because the file/dir exists,
6775 * we probably can't create any dir here, try another
6776 * place. */
6777 if (errno != EEXIST)
6778 # endif
6779 break;
6781 if (vim_tempdir != NULL)
6782 break;
6787 if (vim_tempdir != NULL)
6789 /* There is no need to check if the file exists, because we own the
6790 * directory and nobody else creates a file in it. */
6791 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
6792 return vim_strsave(itmp);
6795 return NULL;
6797 #else /* TEMPDIRNAMES */
6799 # ifdef WIN3264
6800 char szTempFile[_MAX_PATH + 1];
6801 char buf4[4];
6802 char_u *retval;
6803 char_u *p;
6805 STRCPY(itmp, "");
6806 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
6807 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
6808 strcpy(buf4, "VIM");
6809 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
6810 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
6811 return NULL;
6812 /* GetTempFileName() will create the file, we don't want that */
6813 (void)DeleteFile(itmp);
6815 /* Backslashes in a temp file name cause problems when filtering with
6816 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
6817 * didn't set 'shellslash'. */
6818 retval = vim_strsave(itmp);
6819 if (*p_shcf == '-' || p_ssl)
6820 for (p = retval; *p; ++p)
6821 if (*p == '\\')
6822 *p = '/';
6823 return retval;
6825 # else /* WIN3264 */
6827 # ifdef USE_TMPNAM
6828 /* tmpnam() will make its own name */
6829 if (*tmpnam((char *)itmp) == NUL)
6830 return NULL;
6831 # else
6832 char_u *p;
6834 # ifdef VMS_TEMPNAM
6835 /* mktemp() is not working on VMS. It seems to be
6836 * a do-nothing function. Therefore we use tempnam().
6838 sprintf((char *)itmp, "VIM%c", extra_char);
6839 p = (char_u *)tempnam("tmp:", (char *)itmp);
6840 if (p != NULL)
6842 /* VMS will use '.LOG' if we don't explicitly specify an extension,
6843 * and VIM will then be unable to find the file later */
6844 STRCPY(itmp, p);
6845 STRCAT(itmp, ".txt");
6846 free(p);
6848 else
6849 return NULL;
6850 # else
6851 STRCPY(itmp, TEMPNAME);
6852 if ((p = vim_strchr(itmp, '?')) != NULL)
6853 *p = extra_char;
6854 if (mktemp((char *)itmp) == NULL)
6855 return NULL;
6856 # endif
6857 # endif
6859 return vim_strsave(itmp);
6860 # endif /* WIN3264 */
6861 #endif /* TEMPDIRNAMES */
6864 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
6866 * Convert all backslashes in fname to forward slashes in-place.
6868 void
6869 forward_slash(fname)
6870 char_u *fname;
6872 char_u *p;
6874 for (p = fname; *p != NUL; ++p)
6875 # ifdef FEAT_MBYTE
6876 /* The Big5 encoding can have '\' in the trail byte. */
6877 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
6878 ++p;
6879 else
6880 # endif
6881 if (*p == '\\')
6882 *p = '/';
6884 #endif
6888 * Code for automatic commands.
6890 * Only included when "FEAT_AUTOCMD" has been defined.
6893 #if defined(FEAT_AUTOCMD) || defined(PROTO)
6896 * The autocommands are stored in a list for each event.
6897 * Autocommands for the same pattern, that are consecutive, are joined
6898 * together, to avoid having to match the pattern too often.
6899 * The result is an array of Autopat lists, which point to AutoCmd lists:
6901 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
6902 * Autopat.cmds Autopat.cmds
6903 * | |
6904 * V V
6905 * AutoCmd.next AutoCmd.next
6906 * | |
6907 * V V
6908 * AutoCmd.next NULL
6911 * NULL
6913 * first_autopat[1] --> Autopat.next --> NULL
6914 * Autopat.cmds
6917 * AutoCmd.next
6920 * NULL
6921 * etc.
6923 * The order of AutoCmds is important, this is the order in which they were
6924 * defined and will have to be executed.
6926 typedef struct AutoCmd
6928 char_u *cmd; /* The command to be executed (NULL
6929 when command has been removed) */
6930 char nested; /* If autocommands nest here */
6931 char last; /* last command in list */
6932 #ifdef FEAT_EVAL
6933 scid_T scriptID; /* script ID where defined */
6934 #endif
6935 struct AutoCmd *next; /* Next AutoCmd in list */
6936 } AutoCmd;
6938 typedef struct AutoPat
6940 int group; /* group ID */
6941 char_u *pat; /* pattern as typed (NULL when pattern
6942 has been removed) */
6943 int patlen; /* strlen() of pat */
6944 regprog_T *reg_prog; /* compiled regprog for pattern */
6945 char allow_dirs; /* Pattern may match whole path */
6946 char last; /* last pattern for apply_autocmds() */
6947 AutoCmd *cmds; /* list of commands to do */
6948 struct AutoPat *next; /* next AutoPat in AutoPat list */
6949 int buflocal_nr; /* !=0 for buffer-local AutoPat */
6950 } AutoPat;
6952 static struct event_name
6954 char *name; /* event name */
6955 event_T event; /* event number */
6956 } event_names[] =
6958 {"BufAdd", EVENT_BUFADD},
6959 {"BufCreate", EVENT_BUFADD},
6960 {"BufDelete", EVENT_BUFDELETE},
6961 {"BufEnter", EVENT_BUFENTER},
6962 {"BufFilePost", EVENT_BUFFILEPOST},
6963 {"BufFilePre", EVENT_BUFFILEPRE},
6964 {"BufHidden", EVENT_BUFHIDDEN},
6965 {"BufLeave", EVENT_BUFLEAVE},
6966 {"BufNew", EVENT_BUFNEW},
6967 {"BufNewFile", EVENT_BUFNEWFILE},
6968 {"BufRead", EVENT_BUFREADPOST},
6969 {"BufReadCmd", EVENT_BUFREADCMD},
6970 {"BufReadPost", EVENT_BUFREADPOST},
6971 {"BufReadPre", EVENT_BUFREADPRE},
6972 {"BufUnload", EVENT_BUFUNLOAD},
6973 {"BufWinEnter", EVENT_BUFWINENTER},
6974 {"BufWinLeave", EVENT_BUFWINLEAVE},
6975 {"BufWipeout", EVENT_BUFWIPEOUT},
6976 {"BufWrite", EVENT_BUFWRITEPRE},
6977 {"BufWritePost", EVENT_BUFWRITEPOST},
6978 {"BufWritePre", EVENT_BUFWRITEPRE},
6979 {"BufWriteCmd", EVENT_BUFWRITECMD},
6980 {"CmdwinEnter", EVENT_CMDWINENTER},
6981 {"CmdwinLeave", EVENT_CMDWINLEAVE},
6982 {"ColorScheme", EVENT_COLORSCHEME},
6983 {"CursorHold", EVENT_CURSORHOLD},
6984 {"CursorHoldI", EVENT_CURSORHOLDI},
6985 {"CursorMoved", EVENT_CURSORMOVED},
6986 {"CursorMovedI", EVENT_CURSORMOVEDI},
6987 {"EncodingChanged", EVENT_ENCODINGCHANGED},
6988 {"FileEncoding", EVENT_ENCODINGCHANGED},
6989 {"FileAppendPost", EVENT_FILEAPPENDPOST},
6990 {"FileAppendPre", EVENT_FILEAPPENDPRE},
6991 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
6992 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
6993 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
6994 {"FileChangedRO", EVENT_FILECHANGEDRO},
6995 {"FileReadPost", EVENT_FILEREADPOST},
6996 {"FileReadPre", EVENT_FILEREADPRE},
6997 {"FileReadCmd", EVENT_FILEREADCMD},
6998 {"FileType", EVENT_FILETYPE},
6999 {"FileWritePost", EVENT_FILEWRITEPOST},
7000 {"FileWritePre", EVENT_FILEWRITEPRE},
7001 {"FileWriteCmd", EVENT_FILEWRITECMD},
7002 {"FilterReadPost", EVENT_FILTERREADPOST},
7003 {"FilterReadPre", EVENT_FILTERREADPRE},
7004 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7005 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7006 {"FocusGained", EVENT_FOCUSGAINED},
7007 {"FocusLost", EVENT_FOCUSLOST},
7008 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7009 {"GUIEnter", EVENT_GUIENTER},
7010 {"GUIFailed", EVENT_GUIFAILED},
7011 {"InsertChange", EVENT_INSERTCHANGE},
7012 {"InsertEnter", EVENT_INSERTENTER},
7013 {"InsertLeave", EVENT_INSERTLEAVE},
7014 {"MenuPopup", EVENT_MENUPOPUP},
7015 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7016 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7017 {"RemoteReply", EVENT_REMOTEREPLY},
7018 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7019 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7020 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7021 {"SourcePre", EVENT_SOURCEPRE},
7022 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7023 {"StdinReadPost", EVENT_STDINREADPOST},
7024 {"StdinReadPre", EVENT_STDINREADPRE},
7025 {"SwapExists", EVENT_SWAPEXISTS},
7026 {"Syntax", EVENT_SYNTAX},
7027 {"TabEnter", EVENT_TABENTER},
7028 {"TabLeave", EVENT_TABLEAVE},
7029 {"TermChanged", EVENT_TERMCHANGED},
7030 {"TermResponse", EVENT_TERMRESPONSE},
7031 {"User", EVENT_USER},
7032 {"VimEnter", EVENT_VIMENTER},
7033 {"VimLeave", EVENT_VIMLEAVE},
7034 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7035 {"WinEnter", EVENT_WINENTER},
7036 {"WinLeave", EVENT_WINLEAVE},
7037 {"VimResized", EVENT_VIMRESIZED},
7038 {NULL, (event_T)0}
7041 static AutoPat *first_autopat[NUM_EVENTS] =
7043 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7044 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7045 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7046 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7047 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7048 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7052 * struct used to keep status while executing autocommands for an event.
7054 typedef struct AutoPatCmd
7056 AutoPat *curpat; /* next AutoPat to examine */
7057 AutoCmd *nextcmd; /* next AutoCmd to execute */
7058 int group; /* group being used */
7059 char_u *fname; /* fname to match with */
7060 char_u *sfname; /* sfname to match with */
7061 char_u *tail; /* tail of fname */
7062 event_T event; /* current event */
7063 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7064 buf is deleted */
7065 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7066 } AutoPatCmd;
7068 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7071 * augroups stores a list of autocmd group names.
7073 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7074 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7077 * The ID of the current group. Group 0 is the default one.
7079 static int current_augroup = AUGROUP_DEFAULT;
7081 static int au_need_clean = FALSE; /* need to delete marked patterns */
7083 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7084 static void au_remove_pat __ARGS((AutoPat *ap));
7085 static void au_remove_cmds __ARGS((AutoPat *ap));
7086 static void au_cleanup __ARGS((void));
7087 static int au_new_group __ARGS((char_u *name));
7088 static void au_del_group __ARGS((char_u *name));
7089 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7090 static char_u *event_nr2name __ARGS((event_T event));
7091 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7092 static int event_ignored __ARGS((event_T event));
7093 static int au_get_grouparg __ARGS((char_u **argp));
7094 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7095 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7096 static int apply_autocmds_group __ARGS((event_T event, char_u *fname, char_u *fname_io, int force, int group, buf_T *buf, exarg_T *eap));
7097 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7100 static event_T last_event;
7101 static int last_group;
7104 * Show the autocommands for one AutoPat.
7106 static void
7107 show_autocmd(ap, event)
7108 AutoPat *ap;
7109 event_T event;
7111 AutoCmd *ac;
7113 /* Check for "got_int" (here and at various places below), which is set
7114 * when "q" has been hit for the "--more--" prompt */
7115 if (got_int)
7116 return;
7117 if (ap->pat == NULL) /* pattern has been removed */
7118 return;
7120 msg_putchar('\n');
7121 if (got_int)
7122 return;
7123 if (event != last_event || ap->group != last_group)
7125 if (ap->group != AUGROUP_DEFAULT)
7127 if (AUGROUP_NAME(ap->group) == NULL)
7128 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7129 else
7130 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7131 msg_puts((char_u *)" ");
7133 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7134 last_event = event;
7135 last_group = ap->group;
7136 msg_putchar('\n');
7137 if (got_int)
7138 return;
7140 msg_col = 4;
7141 msg_outtrans(ap->pat);
7143 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7145 if (ac->cmd != NULL) /* skip removed commands */
7147 if (msg_col >= 14)
7148 msg_putchar('\n');
7149 msg_col = 14;
7150 if (got_int)
7151 return;
7152 msg_outtrans(ac->cmd);
7153 #ifdef FEAT_EVAL
7154 if (p_verbose > 0)
7155 last_set_msg(ac->scriptID);
7156 #endif
7157 if (got_int)
7158 return;
7159 if (ac->next != NULL)
7161 msg_putchar('\n');
7162 if (got_int)
7163 return;
7170 * Mark an autocommand pattern for deletion.
7172 static void
7173 au_remove_pat(ap)
7174 AutoPat *ap;
7176 vim_free(ap->pat);
7177 ap->pat = NULL;
7178 ap->buflocal_nr = -1;
7179 au_need_clean = TRUE;
7183 * Mark all commands for a pattern for deletion.
7185 static void
7186 au_remove_cmds(ap)
7187 AutoPat *ap;
7189 AutoCmd *ac;
7191 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7193 vim_free(ac->cmd);
7194 ac->cmd = NULL;
7196 au_need_clean = TRUE;
7200 * Cleanup autocommands and patterns that have been deleted.
7201 * This is only done when not executing autocommands.
7203 static void
7204 au_cleanup()
7206 AutoPat *ap, **prev_ap;
7207 AutoCmd *ac, **prev_ac;
7208 event_T event;
7210 if (autocmd_busy || !au_need_clean)
7211 return;
7213 /* loop over all events */
7214 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7215 event = (event_T)((int)event + 1))
7217 /* loop over all autocommand patterns */
7218 prev_ap = &(first_autopat[(int)event]);
7219 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7221 /* loop over all commands for this pattern */
7222 prev_ac = &(ap->cmds);
7223 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7225 /* remove the command if the pattern is to be deleted or when
7226 * the command has been marked for deletion */
7227 if (ap->pat == NULL || ac->cmd == NULL)
7229 *prev_ac = ac->next;
7230 vim_free(ac->cmd);
7231 vim_free(ac);
7233 else
7234 prev_ac = &(ac->next);
7237 /* remove the pattern if it has been marked for deletion */
7238 if (ap->pat == NULL)
7240 *prev_ap = ap->next;
7241 vim_free(ap->reg_prog);
7242 vim_free(ap);
7244 else
7245 prev_ap = &(ap->next);
7249 au_need_clean = FALSE;
7253 * Called when buffer is freed, to remove/invalidate related buffer-local
7254 * autocmds.
7256 void
7257 aubuflocal_remove(buf)
7258 buf_T *buf;
7260 AutoPat *ap;
7261 event_T event;
7262 AutoPatCmd *apc;
7264 /* invalidate currently executing autocommands */
7265 for (apc = active_apc_list; apc; apc = apc->next)
7266 if (buf->b_fnum == apc->arg_bufnr)
7267 apc->arg_bufnr = 0;
7269 /* invalidate buflocals looping through events */
7270 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7271 event = (event_T)((int)event + 1))
7272 /* loop over all autocommand patterns */
7273 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7274 if (ap->buflocal_nr == buf->b_fnum)
7276 au_remove_pat(ap);
7277 if (p_verbose >= 6)
7279 verbose_enter();
7280 smsg((char_u *)
7281 _("auto-removing autocommand: %s <buffer=%d>"),
7282 event_nr2name(event), buf->b_fnum);
7283 verbose_leave();
7286 au_cleanup();
7290 * Add an autocmd group name.
7291 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7293 static int
7294 au_new_group(name)
7295 char_u *name;
7297 int i;
7299 i = au_find_group(name);
7300 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7302 /* First try using a free entry. */
7303 for (i = 0; i < augroups.ga_len; ++i)
7304 if (AUGROUP_NAME(i) == NULL)
7305 break;
7306 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7307 return AUGROUP_ERROR;
7309 AUGROUP_NAME(i) = vim_strsave(name);
7310 if (AUGROUP_NAME(i) == NULL)
7311 return AUGROUP_ERROR;
7312 if (i == augroups.ga_len)
7313 ++augroups.ga_len;
7316 return i;
7319 static void
7320 au_del_group(name)
7321 char_u *name;
7323 int i;
7325 i = au_find_group(name);
7326 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7327 EMSG2(_("E367: No such group: \"%s\""), name);
7328 else
7330 vim_free(AUGROUP_NAME(i));
7331 AUGROUP_NAME(i) = NULL;
7336 * Find the ID of an autocmd group name.
7337 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7339 static int
7340 au_find_group(name)
7341 char_u *name;
7343 int i;
7345 for (i = 0; i < augroups.ga_len; ++i)
7346 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7347 return i;
7348 return AUGROUP_ERROR;
7352 * Return TRUE if augroup "name" exists.
7355 au_has_group(name)
7356 char_u *name;
7358 return au_find_group(name) != AUGROUP_ERROR;
7362 * ":augroup {name}".
7364 void
7365 do_augroup(arg, del_group)
7366 char_u *arg;
7367 int del_group;
7369 int i;
7371 if (del_group)
7373 if (*arg == NUL)
7374 EMSG(_(e_argreq));
7375 else
7376 au_del_group(arg);
7378 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7379 current_augroup = AUGROUP_DEFAULT;
7380 else if (*arg) /* ":aug xxx": switch to group xxx */
7382 i = au_new_group(arg);
7383 if (i != AUGROUP_ERROR)
7384 current_augroup = i;
7386 else /* ":aug": list the group names */
7388 msg_start();
7389 for (i = 0; i < augroups.ga_len; ++i)
7391 if (AUGROUP_NAME(i) != NULL)
7393 msg_puts(AUGROUP_NAME(i));
7394 msg_puts((char_u *)" ");
7397 msg_clr_eos();
7398 msg_end();
7402 #if defined(EXITFREE) || defined(PROTO)
7403 void
7404 free_all_autocmds()
7406 for (current_augroup = -1; current_augroup < augroups.ga_len;
7407 ++current_augroup)
7408 do_autocmd((char_u *)"", TRUE);
7409 ga_clear_strings(&augroups);
7411 #endif
7414 * Return the event number for event name "start".
7415 * Return NUM_EVENTS if the event name was not found.
7416 * Return a pointer to the next event name in "end".
7418 static event_T
7419 event_name2nr(start, end)
7420 char_u *start;
7421 char_u **end;
7423 char_u *p;
7424 int i;
7425 int len;
7427 /* the event name ends with end of line, a blank or a comma */
7428 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7430 for (i = 0; event_names[i].name != NULL; ++i)
7432 len = (int)STRLEN(event_names[i].name);
7433 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7434 break;
7436 if (*p == ',')
7437 ++p;
7438 *end = p;
7439 if (event_names[i].name == NULL)
7440 return NUM_EVENTS;
7441 return event_names[i].event;
7445 * Return the name for event "event".
7447 static char_u *
7448 event_nr2name(event)
7449 event_T event;
7451 int i;
7453 for (i = 0; event_names[i].name != NULL; ++i)
7454 if (event_names[i].event == event)
7455 return (char_u *)event_names[i].name;
7456 return (char_u *)"Unknown";
7460 * Scan over the events. "*" stands for all events.
7462 static char_u *
7463 find_end_event(arg, have_group)
7464 char_u *arg;
7465 int have_group; /* TRUE when group name was found */
7467 char_u *pat;
7468 char_u *p;
7470 if (*arg == '*')
7472 if (arg[1] && !vim_iswhite(arg[1]))
7474 EMSG2(_("E215: Illegal character after *: %s"), arg);
7475 return NULL;
7477 pat = arg + 1;
7479 else
7481 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7483 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7485 if (have_group)
7486 EMSG2(_("E216: No such event: %s"), pat);
7487 else
7488 EMSG2(_("E216: No such group or event: %s"), pat);
7489 return NULL;
7493 return pat;
7497 * Return TRUE if "event" is included in 'eventignore'.
7499 static int
7500 event_ignored(event)
7501 event_T event;
7503 char_u *p = p_ei;
7505 while (*p != NUL)
7507 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7508 return TRUE;
7509 if (event_name2nr(p, &p) == event)
7510 return TRUE;
7513 return FALSE;
7517 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7520 check_ei()
7522 char_u *p = p_ei;
7524 while (*p)
7526 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7528 p += 3;
7529 if (*p == ',')
7530 ++p;
7532 else if (event_name2nr(p, &p) == NUM_EVENTS)
7533 return FAIL;
7536 return OK;
7539 # if defined(FEAT_SYN_HL) || defined(PROTO)
7542 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7543 * buffer loaded into the window. "what" must start with a comma.
7544 * Returns the old value of 'eventignore' in allocated memory.
7546 char_u *
7547 au_event_disable(what)
7548 char *what;
7550 char_u *new_ei;
7551 char_u *save_ei;
7553 save_ei = vim_strsave(p_ei);
7554 if (save_ei != NULL)
7556 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7557 if (new_ei != NULL)
7559 STRCAT(new_ei, what);
7560 set_string_option_direct((char_u *)"ei", -1, new_ei,
7561 OPT_FREE, SID_NONE);
7562 vim_free(new_ei);
7565 return save_ei;
7568 void
7569 au_event_restore(old_ei)
7570 char_u *old_ei;
7572 if (old_ei != NULL)
7574 set_string_option_direct((char_u *)"ei", -1, old_ei,
7575 OPT_FREE, SID_NONE);
7576 vim_free(old_ei);
7579 # endif /* FEAT_SYN_HL */
7582 * do_autocmd() -- implements the :autocmd command. Can be used in the
7583 * following ways:
7585 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7586 * will be automatically executed for <event>
7587 * when editing a file matching <pat>, in
7588 * the current group.
7589 * :autocmd <event> <pat> Show the auto-commands associated with
7590 * <event> and <pat>.
7591 * :autocmd <event> Show the auto-commands associated with
7592 * <event>.
7593 * :autocmd Show all auto-commands.
7594 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7595 * <event> and <pat>, and add the command
7596 * <cmd>, for the current group.
7597 * :autocmd! <event> <pat> Remove all auto-commands associated with
7598 * <event> and <pat> for the current group.
7599 * :autocmd! <event> Remove all auto-commands associated with
7600 * <event> for the current group.
7601 * :autocmd! Remove ALL auto-commands for the current
7602 * group.
7604 * Multiple events and patterns may be given separated by commas. Here are
7605 * some examples:
7606 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7607 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7609 * :autocmd * *.c show all autocommands for *.c files.
7611 * Mostly a {group} argument can optionally appear before <event>.
7613 void
7614 do_autocmd(arg, forceit)
7615 char_u *arg;
7616 int forceit;
7618 char_u *pat;
7619 char_u *envpat = NULL;
7620 char_u *cmd;
7621 event_T event;
7622 int need_free = FALSE;
7623 int nested = FALSE;
7624 int group;
7627 * Check for a legal group name. If not, use AUGROUP_ALL.
7629 group = au_get_grouparg(&arg);
7630 if (arg == NULL) /* out of memory */
7631 return;
7634 * Scan over the events.
7635 * If we find an illegal name, return here, don't do anything.
7637 pat = find_end_event(arg, group != AUGROUP_ALL);
7638 if (pat == NULL)
7639 return;
7642 * Scan over the pattern. Put a NUL at the end.
7644 pat = skipwhite(pat);
7645 cmd = pat;
7646 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
7647 cmd++;
7648 if (*cmd)
7649 *cmd++ = NUL;
7651 /* Expand environment variables in the pattern. Set 'shellslash', we want
7652 * forward slashes here. */
7653 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
7655 #ifdef BACKSLASH_IN_FILENAME
7656 int p_ssl_save = p_ssl;
7658 p_ssl = TRUE;
7659 #endif
7660 envpat = expand_env_save(pat);
7661 #ifdef BACKSLASH_IN_FILENAME
7662 p_ssl = p_ssl_save;
7663 #endif
7664 if (envpat != NULL)
7665 pat = envpat;
7669 * Check for "nested" flag.
7671 cmd = skipwhite(cmd);
7672 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
7674 nested = TRUE;
7675 cmd = skipwhite(cmd + 6);
7679 * Find the start of the commands.
7680 * Expand <sfile> in it.
7682 if (*cmd != NUL)
7684 cmd = expand_sfile(cmd);
7685 if (cmd == NULL) /* some error */
7686 return;
7687 need_free = TRUE;
7691 * Print header when showing autocommands.
7693 if (!forceit && *cmd == NUL)
7695 /* Highlight title */
7696 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7700 * Loop over the events.
7702 last_event = (event_T)-1; /* for listing the event name */
7703 last_group = AUGROUP_ERROR; /* for listing the group name */
7704 if (*arg == '*' || *arg == NUL)
7706 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7707 event = (event_T)((int)event + 1))
7708 if (do_autocmd_event(event, pat,
7709 nested, cmd, forceit, group) == FAIL)
7710 break;
7712 else
7714 while (*arg && !vim_iswhite(*arg))
7715 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
7716 nested, cmd, forceit, group) == FAIL)
7717 break;
7720 if (need_free)
7721 vim_free(cmd);
7722 vim_free(envpat);
7726 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
7727 * The "argp" argument is advanced to the following argument.
7729 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
7731 static int
7732 au_get_grouparg(argp)
7733 char_u **argp;
7735 char_u *group_name;
7736 char_u *p;
7737 char_u *arg = *argp;
7738 int group = AUGROUP_ALL;
7740 p = skiptowhite(arg);
7741 if (p > arg)
7743 group_name = vim_strnsave(arg, (int)(p - arg));
7744 if (group_name == NULL) /* out of memory */
7745 return AUGROUP_ERROR;
7746 group = au_find_group(group_name);
7747 if (group == AUGROUP_ERROR)
7748 group = AUGROUP_ALL; /* no match, use all groups */
7749 else
7750 *argp = skipwhite(p); /* match, skip over group name */
7751 vim_free(group_name);
7753 return group;
7757 * do_autocmd() for one event.
7758 * If *pat == NUL do for all patterns.
7759 * If *cmd == NUL show entries.
7760 * If forceit == TRUE delete entries.
7761 * If group is not AUGROUP_ALL, only use this group.
7763 static int
7764 do_autocmd_event(event, pat, nested, cmd, forceit, group)
7765 event_T event;
7766 char_u *pat;
7767 int nested;
7768 char_u *cmd;
7769 int forceit;
7770 int group;
7772 AutoPat *ap;
7773 AutoPat **prev_ap;
7774 AutoCmd *ac;
7775 AutoCmd **prev_ac;
7776 int brace_level;
7777 char_u *endpat;
7778 int findgroup;
7779 int allgroups;
7780 int patlen;
7781 int is_buflocal;
7782 int buflocal_nr;
7783 char_u buflocal_pat[25]; /* for "<buffer=X>" */
7785 if (group == AUGROUP_ALL)
7786 findgroup = current_augroup;
7787 else
7788 findgroup = group;
7789 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
7792 * Show or delete all patterns for an event.
7794 if (*pat == NUL)
7796 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7798 if (forceit) /* delete the AutoPat, if it's in the current group */
7800 if (ap->group == findgroup)
7801 au_remove_pat(ap);
7803 else if (group == AUGROUP_ALL || ap->group == group)
7804 show_autocmd(ap, event);
7809 * Loop through all the specified patterns.
7811 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
7814 * Find end of the pattern.
7815 * Watch out for a comma in braces, like "*.\{obj,o\}".
7817 brace_level = 0;
7818 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
7819 || endpat[-1] == '\\'); ++endpat)
7821 if (*endpat == '{')
7822 brace_level++;
7823 else if (*endpat == '}')
7824 brace_level--;
7826 if (pat == endpat) /* ignore single comma */
7827 continue;
7828 patlen = (int)(endpat - pat);
7831 * detect special <buflocal[=X]> buffer-local patterns
7833 is_buflocal = FALSE;
7834 buflocal_nr = 0;
7836 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
7837 && pat[patlen - 1] == '>')
7839 /* Error will be printed only for addition. printing and removing
7840 * will proceed silently. */
7841 is_buflocal = TRUE;
7842 if (patlen == 8)
7843 buflocal_nr = curbuf->b_fnum;
7844 else if (patlen > 9 && pat[7] == '=')
7846 /* <buffer=abuf> */
7847 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
7848 buflocal_nr = autocmd_bufnr;
7849 /* <buffer=123> */
7850 else if (skipdigits(pat + 8) == pat + patlen - 1)
7851 buflocal_nr = atoi((char *)pat + 8);
7855 if (is_buflocal)
7857 /* normalize pat into standard "<buffer>#N" form */
7858 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
7859 pat = buflocal_pat; /* can modify pat and patlen */
7860 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
7864 * Find AutoPat entries with this pattern.
7866 prev_ap = &first_autopat[(int)event];
7867 while ((ap = *prev_ap) != NULL)
7869 if (ap->pat != NULL)
7871 /* Accept a pattern when:
7872 * - a group was specified and it's that group, or a group was
7873 * not specified and it's the current group, or a group was
7874 * not specified and we are listing
7875 * - the length of the pattern matches
7876 * - the pattern matches.
7877 * For <buffer[=X]>, this condition works because we normalize
7878 * all buffer-local patterns.
7880 if ((allgroups || ap->group == findgroup)
7881 && ap->patlen == patlen
7882 && STRNCMP(pat, ap->pat, patlen) == 0)
7885 * Remove existing autocommands.
7886 * If adding any new autocmd's for this AutoPat, don't
7887 * delete the pattern from the autopat list, append to
7888 * this list.
7890 if (forceit)
7892 if (*cmd != NUL && ap->next == NULL)
7894 au_remove_cmds(ap);
7895 break;
7897 au_remove_pat(ap);
7901 * Show autocmd's for this autopat, or buflocals <buffer=X>
7903 else if (*cmd == NUL)
7904 show_autocmd(ap, event);
7907 * Add autocmd to this autopat, if it's the last one.
7909 else if (ap->next == NULL)
7910 break;
7913 prev_ap = &ap->next;
7917 * Add a new command.
7919 if (*cmd != NUL)
7922 * If the pattern we want to add a command to does appear at the
7923 * end of the list (or not is not in the list at all), add the
7924 * pattern at the end of the list.
7926 if (ap == NULL)
7928 /* refuse to add buffer-local ap if buffer number is invalid */
7929 if (is_buflocal && (buflocal_nr == 0
7930 || buflist_findnr(buflocal_nr) == NULL))
7932 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
7933 buflocal_nr);
7934 return FAIL;
7937 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
7938 if (ap == NULL)
7939 return FAIL;
7940 ap->pat = vim_strnsave(pat, patlen);
7941 ap->patlen = patlen;
7942 if (ap->pat == NULL)
7944 vim_free(ap);
7945 return FAIL;
7948 if (is_buflocal)
7950 ap->buflocal_nr = buflocal_nr;
7951 ap->reg_prog = NULL;
7953 else
7955 char_u *reg_pat;
7957 ap->buflocal_nr = 0;
7958 reg_pat = file_pat_to_reg_pat(pat, endpat,
7959 &ap->allow_dirs, TRUE);
7960 if (reg_pat != NULL)
7961 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
7962 vim_free(reg_pat);
7963 if (reg_pat == NULL || ap->reg_prog == NULL)
7965 vim_free(ap->pat);
7966 vim_free(ap);
7967 return FAIL;
7970 ap->cmds = NULL;
7971 *prev_ap = ap;
7972 ap->next = NULL;
7973 if (group == AUGROUP_ALL)
7974 ap->group = current_augroup;
7975 else
7976 ap->group = group;
7980 * Add the autocmd at the end of the AutoCmd list.
7982 prev_ac = &(ap->cmds);
7983 while ((ac = *prev_ac) != NULL)
7984 prev_ac = &ac->next;
7985 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
7986 if (ac == NULL)
7987 return FAIL;
7988 ac->cmd = vim_strsave(cmd);
7989 #ifdef FEAT_EVAL
7990 ac->scriptID = current_SID;
7991 #endif
7992 if (ac->cmd == NULL)
7994 vim_free(ac);
7995 return FAIL;
7997 ac->next = NULL;
7998 *prev_ac = ac;
7999 ac->nested = nested;
8003 au_cleanup(); /* may really delete removed patterns/commands now */
8004 return OK;
8008 * Implementation of ":doautocmd [group] event [fname]".
8009 * Return OK for success, FAIL for failure;
8012 do_doautocmd(arg, do_msg)
8013 char_u *arg;
8014 int do_msg; /* give message for no matching autocmds? */
8016 char_u *fname;
8017 int nothing_done = TRUE;
8018 int group;
8021 * Check for a legal group name. If not, use AUGROUP_ALL.
8023 group = au_get_grouparg(&arg);
8024 if (arg == NULL) /* out of memory */
8025 return FAIL;
8027 if (*arg == '*')
8029 EMSG(_("E217: Can't execute autocommands for ALL events"));
8030 return FAIL;
8034 * Scan over the events.
8035 * If we find an illegal name, return here, don't do anything.
8037 fname = find_end_event(arg, group != AUGROUP_ALL);
8038 if (fname == NULL)
8039 return FAIL;
8041 fname = skipwhite(fname);
8044 * Loop over the events.
8046 while (*arg && !vim_iswhite(*arg))
8047 if (apply_autocmds_group(event_name2nr(arg, &arg),
8048 fname, NULL, TRUE, group, curbuf, NULL))
8049 nothing_done = FALSE;
8051 if (nothing_done && do_msg)
8052 MSG(_("No matching autocommands"));
8054 #ifdef FEAT_EVAL
8055 return aborting() ? FAIL : OK;
8056 #else
8057 return OK;
8058 #endif
8062 * ":doautoall": execute autocommands for each loaded buffer.
8064 void
8065 ex_doautoall(eap)
8066 exarg_T *eap;
8068 int retval;
8069 aco_save_T aco;
8070 buf_T *buf;
8073 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8074 * equal to curbuf, but for some buffers there may not be a window.
8075 * So we change the buffer for the current window for a moment. This
8076 * gives problems when the autocommands make changes to the list of
8077 * buffers or windows...
8079 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8081 if (curbuf->b_ml.ml_mfp != NULL)
8083 /* find a window for this buffer and save some values */
8084 aucmd_prepbuf(&aco, buf);
8086 /* execute the autocommands for this buffer */
8087 retval = do_doautocmd(eap->arg, FALSE);
8088 do_modelines(0);
8090 /* restore the current window */
8091 aucmd_restbuf(&aco);
8093 /* stop if there is some error or buffer was deleted */
8094 if (retval == FAIL || !buf_valid(buf))
8095 break;
8099 check_cursor(); /* just in case lines got deleted */
8103 * Prepare for executing autocommands for (hidden) buffer "buf".
8104 * Search a window for the current buffer. Save the cursor position and
8105 * screen offset.
8106 * Set "curbuf" and "curwin" to match "buf".
8107 * When FEAT_AUTOCMD is not defined another version is used, see below.
8109 void
8110 aucmd_prepbuf(aco, buf)
8111 aco_save_T *aco; /* structure to save values in */
8112 buf_T *buf; /* new curbuf */
8114 win_T *win;
8116 aco->new_curbuf = buf;
8118 /* Find a window that is for the new buffer */
8119 if (buf == curbuf) /* be quick when buf is curbuf */
8120 win = curwin;
8121 else
8122 #ifdef FEAT_WINDOWS
8123 for (win = firstwin; win != NULL; win = win->w_next)
8124 if (win->w_buffer == buf)
8125 break;
8126 #else
8127 win = NULL;
8128 #endif
8131 * Prefer to use an existing window for the buffer, it has the least side
8132 * effects (esp. if "buf" is curbuf).
8133 * Otherwise, use curwin for "buf". It might make some items in the
8134 * window invalid. At least save the cursor and topline.
8136 if (win != NULL)
8138 /* there is a window for "buf", make it the curwin */
8139 aco->save_curwin = curwin;
8140 curwin = win;
8141 aco->save_buf = win->w_buffer;
8142 aco->new_curwin = win;
8144 else
8146 /* there is no window for "buf", use curwin */
8147 aco->save_curwin = NULL;
8148 aco->save_buf = curbuf;
8149 --curbuf->b_nwindows;
8150 curwin->w_buffer = buf;
8151 ++buf->b_nwindows;
8153 /* save cursor and topline, set them to safe values */
8154 aco->save_cursor = curwin->w_cursor;
8155 curwin->w_cursor.lnum = 1;
8156 curwin->w_cursor.col = 0;
8157 aco->save_topline = curwin->w_topline;
8158 curwin->w_topline = 1;
8159 #ifdef FEAT_DIFF
8160 aco->save_topfill = curwin->w_topfill;
8161 curwin->w_topfill = 0;
8162 #endif
8165 curbuf = buf;
8169 * Cleanup after executing autocommands for a (hidden) buffer.
8170 * Restore the window as it was (if possible).
8171 * When FEAT_AUTOCMD is not defined another version is used, see below.
8173 void
8174 aucmd_restbuf(aco)
8175 aco_save_T *aco; /* structure holding saved values */
8177 if (aco->save_curwin != NULL)
8179 /* restore curwin */
8180 #ifdef FEAT_WINDOWS
8181 if (win_valid(aco->save_curwin))
8182 #endif
8184 /* restore the buffer which was previously edited by curwin, if
8185 * it's still the same window and it's valid */
8186 if (curwin == aco->new_curwin
8187 && buf_valid(aco->save_buf)
8188 && aco->save_buf->b_ml.ml_mfp != NULL)
8190 --curbuf->b_nwindows;
8191 curbuf = aco->save_buf;
8192 curwin->w_buffer = curbuf;
8193 ++curbuf->b_nwindows;
8196 curwin = aco->save_curwin;
8197 curbuf = curwin->w_buffer;
8200 else
8202 /* restore buffer for curwin if it still exists and is loaded */
8203 if (buf_valid(aco->save_buf) && aco->save_buf->b_ml.ml_mfp != NULL)
8205 --curbuf->b_nwindows;
8206 curbuf = aco->save_buf;
8207 curwin->w_buffer = curbuf;
8208 ++curbuf->b_nwindows;
8209 curwin->w_cursor = aco->save_cursor;
8210 check_cursor();
8211 /* check topline < line_count, in case lines got deleted */
8212 if (aco->save_topline <= curbuf->b_ml.ml_line_count)
8214 curwin->w_topline = aco->save_topline;
8215 #ifdef FEAT_DIFF
8216 curwin->w_topfill = aco->save_topfill;
8217 #endif
8219 else
8221 curwin->w_topline = curbuf->b_ml.ml_line_count;
8222 #ifdef FEAT_DIFF
8223 curwin->w_topfill = 0;
8224 #endif
8230 static int autocmd_nested = FALSE;
8233 * Execute autocommands for "event" and file name "fname".
8234 * Return TRUE if some commands were executed.
8237 apply_autocmds(event, fname, fname_io, force, buf)
8238 event_T event;
8239 char_u *fname; /* NULL or empty means use actual file name */
8240 char_u *fname_io; /* fname to use for <afile> on cmdline */
8241 int force; /* when TRUE, ignore autocmd_busy */
8242 buf_T *buf; /* buffer for <abuf> */
8244 return apply_autocmds_group(event, fname, fname_io, force,
8245 AUGROUP_ALL, buf, NULL);
8249 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8250 * setting v:filearg.
8252 static int
8253 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8254 event_T event;
8255 char_u *fname;
8256 char_u *fname_io;
8257 int force;
8258 buf_T *buf;
8259 exarg_T *eap;
8261 return apply_autocmds_group(event, fname, fname_io, force,
8262 AUGROUP_ALL, buf, eap);
8266 * Like apply_autocmds(), but handles the caller's retval. If the script
8267 * processing is being aborted or if retval is FAIL when inside a try
8268 * conditional, no autocommands are executed. If otherwise the autocommands
8269 * cause the script to be aborted, retval is set to FAIL.
8272 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8273 event_T event;
8274 char_u *fname; /* NULL or empty means use actual file name */
8275 char_u *fname_io; /* fname to use for <afile> on cmdline */
8276 int force; /* when TRUE, ignore autocmd_busy */
8277 buf_T *buf; /* buffer for <abuf> */
8278 int *retval; /* pointer to caller's retval */
8280 int did_cmd;
8282 #ifdef FEAT_EVAL
8283 if (should_abort(*retval))
8284 return FALSE;
8285 #endif
8287 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8288 AUGROUP_ALL, buf, NULL);
8289 if (did_cmd
8290 #ifdef FEAT_EVAL
8291 && aborting()
8292 #endif
8294 *retval = FAIL;
8295 return did_cmd;
8299 * Return TRUE when there is a CursorHold autocommand defined.
8302 has_cursorhold()
8304 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8305 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8309 * Return TRUE if the CursorHold event can be triggered.
8312 trigger_cursorhold()
8314 int state;
8316 if (!did_cursorhold && has_cursorhold() && !Recording
8317 #ifdef FEAT_INS_EXPAND
8318 && !ins_compl_active()
8319 #endif
8322 state = get_real_state();
8323 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8324 return TRUE;
8326 return FALSE;
8330 * Return TRUE when there is a CursorMoved autocommand defined.
8333 has_cursormoved()
8335 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8339 * Return TRUE when there is a CursorMovedI autocommand defined.
8342 has_cursormovedI()
8344 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8347 static int
8348 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8349 event_T event;
8350 char_u *fname; /* NULL or empty means use actual file name */
8351 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8352 use fname */
8353 int force; /* when TRUE, ignore autocmd_busy */
8354 int group; /* group ID, or AUGROUP_ALL */
8355 buf_T *buf; /* buffer for <abuf> */
8356 exarg_T *eap; /* command arguments */
8358 char_u *sfname = NULL; /* short file name */
8359 char_u *tail;
8360 int save_changed;
8361 buf_T *old_curbuf;
8362 int retval = FALSE;
8363 char_u *save_sourcing_name;
8364 linenr_T save_sourcing_lnum;
8365 char_u *save_autocmd_fname;
8366 int save_autocmd_bufnr;
8367 char_u *save_autocmd_match;
8368 int save_autocmd_busy;
8369 int save_autocmd_nested;
8370 static int nesting = 0;
8371 AutoPatCmd patcmd;
8372 AutoPat *ap;
8373 #ifdef FEAT_EVAL
8374 scid_T save_current_SID;
8375 void *save_funccalp;
8376 char_u *save_cmdarg;
8377 long save_cmdbang;
8378 #endif
8379 static int filechangeshell_busy = FALSE;
8380 #ifdef FEAT_PROFILE
8381 proftime_T wait_time;
8382 #endif
8385 * Quickly return if there are no autocommands for this event or
8386 * autocommands are blocked.
8388 if (first_autopat[(int)event] == NULL || autocmd_block > 0)
8389 goto BYPASS_AU;
8392 * When autocommands are busy, new autocommands are only executed when
8393 * explicitly enabled with the "nested" flag.
8395 if (autocmd_busy && !(force || autocmd_nested))
8396 goto BYPASS_AU;
8398 #ifdef FEAT_EVAL
8400 * Quickly return when immdediately aborting on error, or when an interrupt
8401 * occurred or an exception was thrown but not caught.
8403 if (aborting())
8404 goto BYPASS_AU;
8405 #endif
8408 * FileChangedShell never nests, because it can create an endless loop.
8410 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8411 || event == EVENT_FILECHANGEDSHELLPOST))
8412 goto BYPASS_AU;
8415 * Ignore events in 'eventignore'.
8417 if (event_ignored(event))
8418 goto BYPASS_AU;
8421 * Allow nesting of autocommands, but restrict the depth, because it's
8422 * possible to create an endless loop.
8424 if (nesting == 10)
8426 EMSG(_("E218: autocommand nesting too deep"));
8427 goto BYPASS_AU;
8431 * Check if these autocommands are disabled. Used when doing ":all" or
8432 * ":ball".
8434 if ( (autocmd_no_enter
8435 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8436 || (autocmd_no_leave
8437 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8438 goto BYPASS_AU;
8441 * Save the autocmd_* variables and info about the current buffer.
8443 save_autocmd_fname = autocmd_fname;
8444 save_autocmd_bufnr = autocmd_bufnr;
8445 save_autocmd_match = autocmd_match;
8446 save_autocmd_busy = autocmd_busy;
8447 save_autocmd_nested = autocmd_nested;
8448 save_changed = curbuf->b_changed;
8449 old_curbuf = curbuf;
8452 * Set the file name to be used for <afile>.
8454 if (fname_io == NULL)
8456 if (fname != NULL && *fname != NUL)
8457 autocmd_fname = fname;
8458 else if (buf != NULL)
8459 autocmd_fname = buf->b_fname;
8460 else
8461 autocmd_fname = NULL;
8463 else
8464 autocmd_fname = fname_io;
8467 * Set the buffer number to be used for <abuf>.
8469 if (buf == NULL)
8470 autocmd_bufnr = 0;
8471 else
8472 autocmd_bufnr = buf->b_fnum;
8475 * When the file name is NULL or empty, use the file name of buffer "buf".
8476 * Always use the full path of the file name to match with, in case
8477 * "allow_dirs" is set.
8479 if (fname == NULL || *fname == NUL)
8481 if (buf == NULL)
8482 fname = NULL;
8483 else
8485 #ifdef FEAT_SYN_HL
8486 if (event == EVENT_SYNTAX)
8487 fname = buf->b_p_syn;
8488 else
8489 #endif
8490 if (event == EVENT_FILETYPE)
8491 fname = buf->b_p_ft;
8492 else
8494 if (buf->b_sfname != NULL)
8495 sfname = vim_strsave(buf->b_sfname);
8496 fname = buf->b_ffname;
8499 if (fname == NULL)
8500 fname = (char_u *)"";
8501 fname = vim_strsave(fname); /* make a copy, so we can change it */
8503 else
8505 sfname = vim_strsave(fname);
8506 /* Don't try expanding FileType, Syntax, WindowID or QuickFixCmd* */
8507 if (event == EVENT_FILETYPE
8508 || event == EVENT_SYNTAX
8509 || event == EVENT_REMOTEREPLY
8510 || event == EVENT_SPELLFILEMISSING
8511 || event == EVENT_QUICKFIXCMDPRE
8512 || event == EVENT_QUICKFIXCMDPOST)
8513 fname = vim_strsave(fname);
8514 else
8515 fname = FullName_save(fname, FALSE);
8517 if (fname == NULL) /* out of memory */
8519 vim_free(sfname);
8520 retval = FALSE;
8521 goto BYPASS_AU;
8524 #ifdef BACKSLASH_IN_FILENAME
8526 * Replace all backslashes with forward slashes. This makes the
8527 * autocommand patterns portable between Unix and MS-DOS.
8529 if (sfname != NULL)
8530 forward_slash(sfname);
8531 forward_slash(fname);
8532 #endif
8534 #ifdef VMS
8535 /* remove version for correct match */
8536 if (sfname != NULL)
8537 vms_remove_version(sfname);
8538 vms_remove_version(fname);
8539 #endif
8542 * Set the name to be used for <amatch>.
8544 autocmd_match = fname;
8547 /* Don't redraw while doing auto commands. */
8548 ++RedrawingDisabled;
8549 save_sourcing_name = sourcing_name;
8550 sourcing_name = NULL; /* don't free this one */
8551 save_sourcing_lnum = sourcing_lnum;
8552 sourcing_lnum = 0; /* no line number here */
8554 #ifdef FEAT_EVAL
8555 save_current_SID = current_SID;
8557 # ifdef FEAT_PROFILE
8558 if (do_profiling == PROF_YES)
8559 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
8560 # endif
8562 /* Don't use local function variables, if called from a function */
8563 save_funccalp = save_funccal();
8564 #endif
8567 * When starting to execute autocommands, save the search patterns.
8569 if (!autocmd_busy)
8571 save_search_patterns();
8572 saveRedobuff();
8573 did_filetype = keep_filetype;
8577 * Note that we are applying autocmds. Some commands need to know.
8579 autocmd_busy = TRUE;
8580 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
8581 ++nesting; /* see matching decrement below */
8583 /* Remember that FileType was triggered. Used for did_filetype(). */
8584 if (event == EVENT_FILETYPE)
8585 did_filetype = TRUE;
8587 tail = gettail(fname);
8589 /* Find first autocommand that matches */
8590 patcmd.curpat = first_autopat[(int)event];
8591 patcmd.nextcmd = NULL;
8592 patcmd.group = group;
8593 patcmd.fname = fname;
8594 patcmd.sfname = sfname;
8595 patcmd.tail = tail;
8596 patcmd.event = event;
8597 patcmd.arg_bufnr = autocmd_bufnr;
8598 patcmd.next = NULL;
8599 auto_next_pat(&patcmd, FALSE);
8601 /* found one, start executing the autocommands */
8602 if (patcmd.curpat != NULL)
8604 /* add to active_apc_list */
8605 patcmd.next = active_apc_list;
8606 active_apc_list = &patcmd;
8608 #ifdef FEAT_EVAL
8609 /* set v:cmdarg (only when there is a matching pattern) */
8610 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
8611 if (eap != NULL)
8613 save_cmdarg = set_cmdarg(eap, NULL);
8614 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
8616 else
8617 save_cmdarg = NULL; /* avoid gcc warning */
8618 #endif
8619 retval = TRUE;
8620 /* mark the last pattern, to avoid an endless loop when more patterns
8621 * are added when executing autocommands */
8622 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
8623 ap->last = FALSE;
8624 ap->last = TRUE;
8625 check_lnums(TRUE); /* make sure cursor and topline are valid */
8626 do_cmdline(NULL, getnextac, (void *)&patcmd,
8627 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
8628 #ifdef FEAT_EVAL
8629 if (eap != NULL)
8631 (void)set_cmdarg(NULL, save_cmdarg);
8632 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
8634 #endif
8635 /* delete from active_apc_list */
8636 if (active_apc_list == &patcmd) /* just in case */
8637 active_apc_list = patcmd.next;
8640 --RedrawingDisabled;
8641 autocmd_busy = save_autocmd_busy;
8642 filechangeshell_busy = FALSE;
8643 autocmd_nested = save_autocmd_nested;
8644 vim_free(sourcing_name);
8645 sourcing_name = save_sourcing_name;
8646 sourcing_lnum = save_sourcing_lnum;
8647 autocmd_fname = save_autocmd_fname;
8648 autocmd_bufnr = save_autocmd_bufnr;
8649 autocmd_match = save_autocmd_match;
8650 #ifdef FEAT_EVAL
8651 current_SID = save_current_SID;
8652 restore_funccal(save_funccalp);
8653 # ifdef FEAT_PROFILE
8654 if (do_profiling == PROF_YES)
8655 prof_child_exit(&wait_time);
8656 # endif
8657 #endif
8658 vim_free(fname);
8659 vim_free(sfname);
8660 --nesting; /* see matching increment above */
8663 * When stopping to execute autocommands, restore the search patterns and
8664 * the redo buffer.
8666 if (!autocmd_busy)
8668 restore_search_patterns();
8669 restoreRedobuff();
8670 did_filetype = FALSE;
8674 * Some events don't set or reset the Changed flag.
8675 * Check if still in the same buffer!
8677 if (curbuf == old_curbuf
8678 && (event == EVENT_BUFREADPOST
8679 || event == EVENT_BUFWRITEPOST
8680 || event == EVENT_FILEAPPENDPOST
8681 || event == EVENT_VIMLEAVE
8682 || event == EVENT_VIMLEAVEPRE))
8684 #ifdef FEAT_TITLE
8685 if (curbuf->b_changed != save_changed)
8686 need_maketitle = TRUE;
8687 #endif
8688 curbuf->b_changed = save_changed;
8691 au_cleanup(); /* may really delete removed patterns/commands now */
8693 BYPASS_AU:
8694 /* When wiping out a buffer make sure all its buffer-local autocommands
8695 * are deleted. */
8696 if (event == EVENT_BUFWIPEOUT && buf != NULL)
8697 aubuflocal_remove(buf);
8699 return retval;
8703 * Find next autocommand pattern that matches.
8705 static void
8706 auto_next_pat(apc, stop_at_last)
8707 AutoPatCmd *apc;
8708 int stop_at_last; /* stop when 'last' flag is set */
8710 AutoPat *ap;
8711 AutoCmd *cp;
8712 char_u *name;
8713 char *s;
8715 vim_free(sourcing_name);
8716 sourcing_name = NULL;
8718 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
8720 apc->curpat = NULL;
8722 /* only use a pattern when it has not been removed, has commands and
8723 * the group matches. For buffer-local autocommands only check the
8724 * buffer number. */
8725 if (ap->pat != NULL && ap->cmds != NULL
8726 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
8728 /* execution-condition */
8729 if (ap->buflocal_nr == 0
8730 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
8731 apc->sfname, apc->tail, ap->allow_dirs))
8732 : ap->buflocal_nr == apc->arg_bufnr)
8734 name = event_nr2name(apc->event);
8735 s = _("%s Auto commands for \"%s\"");
8736 sourcing_name = alloc((unsigned)(STRLEN(s)
8737 + STRLEN(name) + ap->patlen + 1));
8738 if (sourcing_name != NULL)
8740 sprintf((char *)sourcing_name, s,
8741 (char *)name, (char *)ap->pat);
8742 if (p_verbose >= 8)
8744 verbose_enter();
8745 smsg((char_u *)_("Executing %s"), sourcing_name);
8746 verbose_leave();
8750 apc->curpat = ap;
8751 apc->nextcmd = ap->cmds;
8752 /* mark last command */
8753 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
8754 cp->last = FALSE;
8755 cp->last = TRUE;
8757 line_breakcheck();
8758 if (apc->curpat != NULL) /* found a match */
8759 break;
8761 if (stop_at_last && ap->last)
8762 break;
8767 * Get next autocommand command.
8768 * Called by do_cmdline() to get the next line for ":if".
8769 * Returns allocated string, or NULL for end of autocommands.
8771 /* ARGSUSED */
8772 static char_u *
8773 getnextac(c, cookie, indent)
8774 int c; /* not used */
8775 void *cookie;
8776 int indent; /* not used */
8778 AutoPatCmd *acp = (AutoPatCmd *)cookie;
8779 char_u *retval;
8780 AutoCmd *ac;
8782 /* Can be called again after returning the last line. */
8783 if (acp->curpat == NULL)
8784 return NULL;
8786 /* repeat until we find an autocommand to execute */
8787 for (;;)
8789 /* skip removed commands */
8790 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
8791 if (acp->nextcmd->last)
8792 acp->nextcmd = NULL;
8793 else
8794 acp->nextcmd = acp->nextcmd->next;
8796 if (acp->nextcmd != NULL)
8797 break;
8799 /* at end of commands, find next pattern that matches */
8800 if (acp->curpat->last)
8801 acp->curpat = NULL;
8802 else
8803 acp->curpat = acp->curpat->next;
8804 if (acp->curpat != NULL)
8805 auto_next_pat(acp, TRUE);
8806 if (acp->curpat == NULL)
8807 return NULL;
8810 ac = acp->nextcmd;
8812 if (p_verbose >= 9)
8814 verbose_enter_scroll();
8815 smsg((char_u *)_("autocommand %s"), ac->cmd);
8816 msg_puts((char_u *)"\n"); /* don't overwrite this either */
8817 verbose_leave_scroll();
8819 retval = vim_strsave(ac->cmd);
8820 autocmd_nested = ac->nested;
8821 #ifdef FEAT_EVAL
8822 current_SID = ac->scriptID;
8823 #endif
8824 if (ac->last)
8825 acp->nextcmd = NULL;
8826 else
8827 acp->nextcmd = ac->next;
8828 return retval;
8832 * Return TRUE if there is a matching autocommand for "fname".
8833 * To account for buffer-local autocommands, function needs to know
8834 * in which buffer the file will be opened.
8837 has_autocmd(event, sfname, buf)
8838 event_T event;
8839 char_u *sfname;
8840 buf_T *buf;
8842 AutoPat *ap;
8843 char_u *fname;
8844 char_u *tail = gettail(sfname);
8845 int retval = FALSE;
8847 fname = FullName_save(sfname, FALSE);
8848 if (fname == NULL)
8849 return FALSE;
8851 #ifdef BACKSLASH_IN_FILENAME
8853 * Replace all backslashes with forward slashes. This makes the
8854 * autocommand patterns portable between Unix and MS-DOS.
8856 sfname = vim_strsave(sfname);
8857 if (sfname != NULL)
8858 forward_slash(sfname);
8859 forward_slash(fname);
8860 #endif
8862 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
8863 if (ap->pat != NULL && ap->cmds != NULL
8864 && (ap->buflocal_nr == 0
8865 ? match_file_pat(NULL, ap->reg_prog,
8866 fname, sfname, tail, ap->allow_dirs)
8867 : buf != NULL && ap->buflocal_nr == buf->b_fnum
8870 retval = TRUE;
8871 break;
8874 vim_free(fname);
8875 #ifdef BACKSLASH_IN_FILENAME
8876 vim_free(sfname);
8877 #endif
8879 return retval;
8882 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
8884 * Function given to ExpandGeneric() to obtain the list of autocommand group
8885 * names.
8887 /*ARGSUSED*/
8888 char_u *
8889 get_augroup_name(xp, idx)
8890 expand_T *xp;
8891 int idx;
8893 if (idx == augroups.ga_len) /* add "END" add the end */
8894 return (char_u *)"END";
8895 if (idx >= augroups.ga_len) /* end of list */
8896 return NULL;
8897 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
8898 return (char_u *)"";
8899 return AUGROUP_NAME(idx); /* return a name */
8902 static int include_groups = FALSE;
8904 char_u *
8905 set_context_in_autocmd(xp, arg, doautocmd)
8906 expand_T *xp;
8907 char_u *arg;
8908 int doautocmd; /* TRUE for :doautocmd, FALSE for :autocmd */
8910 char_u *p;
8911 int group;
8913 /* check for a group name, skip it if present */
8914 include_groups = FALSE;
8915 p = arg;
8916 group = au_get_grouparg(&arg);
8917 if (group == AUGROUP_ERROR)
8918 return NULL;
8919 /* If there only is a group name that's what we expand. */
8920 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
8922 arg = p;
8923 group = AUGROUP_ALL;
8926 /* skip over event name */
8927 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
8928 if (*p == ',')
8929 arg = p + 1;
8930 if (*p == NUL)
8932 if (group == AUGROUP_ALL)
8933 include_groups = TRUE;
8934 xp->xp_context = EXPAND_EVENTS; /* expand event name */
8935 xp->xp_pattern = arg;
8936 return NULL;
8939 /* skip over pattern */
8940 arg = skipwhite(p);
8941 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
8942 arg++;
8943 if (*arg)
8944 return arg; /* expand (next) command */
8946 if (doautocmd)
8947 xp->xp_context = EXPAND_FILES; /* expand file names */
8948 else
8949 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
8950 return NULL;
8954 * Function given to ExpandGeneric() to obtain the list of event names.
8956 /*ARGSUSED*/
8957 char_u *
8958 get_event_name(xp, idx)
8959 expand_T *xp;
8960 int idx;
8962 if (idx < augroups.ga_len) /* First list group names, if wanted */
8964 if (!include_groups || AUGROUP_NAME(idx) == NULL)
8965 return (char_u *)""; /* skip deleted entries */
8966 return AUGROUP_NAME(idx); /* return a name */
8968 return (char_u *)event_names[idx - augroups.ga_len].name;
8971 #endif /* FEAT_CMDL_COMPL */
8974 * Return TRUE if autocmd is supported.
8977 autocmd_supported(name)
8978 char_u *name;
8980 char_u *p;
8982 return (event_name2nr(name, &p) != NUM_EVENTS);
8986 * Return TRUE if an autocommand is defined for a group, event and
8987 * pattern: The group can be omitted to accept any group. "event" and "pattern"
8988 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
8989 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
8990 * Used for:
8991 * exists("#Group") or
8992 * exists("#Group#Event") or
8993 * exists("#Group#Event#pat") or
8994 * exists("#Event") or
8995 * exists("#Event#pat")
8998 au_exists(arg)
8999 char_u *arg;
9001 char_u *arg_save;
9002 char_u *pattern = NULL;
9003 char_u *event_name;
9004 char_u *p;
9005 event_T event;
9006 AutoPat *ap;
9007 buf_T *buflocal_buf = NULL;
9008 int group;
9009 int retval = FALSE;
9011 /* Make a copy so that we can change the '#' chars to a NUL. */
9012 arg_save = vim_strsave(arg);
9013 if (arg_save == NULL)
9014 return FALSE;
9015 p = vim_strchr(arg_save, '#');
9016 if (p != NULL)
9017 *p++ = NUL;
9019 /* First, look for an autocmd group name */
9020 group = au_find_group(arg_save);
9021 if (group == AUGROUP_ERROR)
9023 /* Didn't match a group name, assume the first argument is an event. */
9024 group = AUGROUP_ALL;
9025 event_name = arg_save;
9027 else
9029 if (p == NULL)
9031 /* "Group": group name is present and it's recognized */
9032 retval = TRUE;
9033 goto theend;
9036 /* Must be "Group#Event" or "Group#Event#pat". */
9037 event_name = p;
9038 p = vim_strchr(event_name, '#');
9039 if (p != NULL)
9040 *p++ = NUL; /* "Group#Event#pat" */
9043 pattern = p; /* "pattern" is NULL when there is no pattern */
9045 /* find the index (enum) for the event name */
9046 event = event_name2nr(event_name, &p);
9048 /* return FALSE if the event name is not recognized */
9049 if (event == NUM_EVENTS)
9050 goto theend;
9052 /* Find the first autocommand for this event.
9053 * If there isn't any, return FALSE;
9054 * If there is one and no pattern given, return TRUE; */
9055 ap = first_autopat[(int)event];
9056 if (ap == NULL)
9057 goto theend;
9058 if (pattern == NULL)
9060 retval = TRUE;
9061 goto theend;
9064 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9065 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9066 if (STRICMP(pattern, "<buffer>") == 0)
9067 buflocal_buf = curbuf;
9069 /* Check if there is an autocommand with the given pattern. */
9070 for ( ; ap != NULL; ap = ap->next)
9071 /* only use a pattern when it has not been removed and has commands. */
9072 /* For buffer-local autocommands, fnamecmp() works fine. */
9073 if (ap->pat != NULL && ap->cmds != NULL
9074 && (group == AUGROUP_ALL || ap->group == group)
9075 && (buflocal_buf == NULL
9076 ? fnamecmp(ap->pat, pattern) == 0
9077 : ap->buflocal_nr == buflocal_buf->b_fnum))
9079 retval = TRUE;
9080 break;
9083 theend:
9084 vim_free(arg_save);
9085 return retval;
9088 #else /* FEAT_AUTOCMD */
9091 * Prepare for executing commands for (hidden) buffer "buf".
9092 * This is the non-autocommand version, it simply saves "curbuf" and sets
9093 * "curbuf" and "curwin" to match "buf".
9095 void
9096 aucmd_prepbuf(aco, buf)
9097 aco_save_T *aco; /* structure to save values in */
9098 buf_T *buf; /* new curbuf */
9100 aco->save_buf = buf;
9101 curbuf = buf;
9102 curwin->w_buffer = buf;
9106 * Restore after executing commands for a (hidden) buffer.
9107 * This is the non-autocommand version.
9109 void
9110 aucmd_restbuf(aco)
9111 aco_save_T *aco; /* structure holding saved values */
9113 curbuf = aco->save_buf;
9114 curwin->w_buffer = curbuf;
9117 #endif /* FEAT_AUTOCMD */
9120 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9122 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9123 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9124 * vim_regcomp() often.
9125 * Used for autocommands and 'wildignore'.
9126 * Returns TRUE if there is a match, FALSE otherwise.
9129 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9130 char_u *pattern; /* pattern to match with */
9131 regprog_T *prog; /* pre-compiled regprog or NULL */
9132 char_u *fname; /* full path of file name */
9133 char_u *sfname; /* short file name or NULL */
9134 char_u *tail; /* tail of path */
9135 int allow_dirs; /* allow matching with dir */
9137 regmatch_T regmatch;
9138 int result = FALSE;
9139 #ifdef FEAT_OSFILETYPE
9140 int no_pattern = FALSE; /* TRUE if check is filetype only */
9141 char_u *type_start;
9142 char_u c;
9143 int match = FALSE;
9144 #endif
9146 #ifdef CASE_INSENSITIVE_FILENAME
9147 regmatch.rm_ic = TRUE; /* Always ignore case */
9148 #else
9149 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9150 #endif
9151 #ifdef FEAT_OSFILETYPE
9152 if (*pattern == '<')
9154 /* There is a filetype condition specified with this pattern.
9155 * Check the filetype matches first. If not, don't bother with the
9156 * pattern (set regprog to NULL).
9157 * Always use magic for the regexp.
9160 for (type_start = pattern + 1; (c = *pattern); pattern++)
9162 if ((c == ';' || c == '>') && match == FALSE)
9164 *pattern = NUL; /* Terminate the string */
9165 match = mch_check_filetype(fname, type_start);
9166 *pattern = c; /* Restore the terminator */
9167 type_start = pattern + 1;
9169 if (c == '>')
9170 break;
9173 /* (c should never be NUL, but check anyway) */
9174 if (match == FALSE || c == NUL)
9175 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9176 else if (*pattern == NUL)
9178 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9179 no_pattern = TRUE; /* Always matches - don't check pat. */
9181 else
9182 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9184 else
9185 #endif
9187 if (prog != NULL)
9188 regmatch.regprog = prog;
9189 else
9190 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9194 * Try for a match with the pattern with:
9195 * 1. the full file name, when the pattern has a '/'.
9196 * 2. the short file name, when the pattern has a '/'.
9197 * 3. the tail of the file name, when the pattern has no '/'.
9199 if (
9200 #ifdef FEAT_OSFILETYPE
9201 /* If the check is for a filetype only and we don't care
9202 * about the path then skip all the regexp stuff.
9204 no_pattern ||
9205 #endif
9206 (regmatch.regprog != NULL
9207 && ((allow_dirs
9208 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9209 || (sfname != NULL
9210 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9211 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9212 result = TRUE;
9214 if (prog == NULL)
9215 vim_free(regmatch.regprog);
9216 return result;
9218 #endif
9220 #if defined(FEAT_WILDIGN) || defined(PROTO)
9222 * Return TRUE if a file matches with a pattern in "list".
9223 * "list" is a comma-separated list of patterns, like 'wildignore'.
9224 * "sfname" is the short file name or NULL, "ffname" the long file name.
9227 match_file_list(list, sfname, ffname)
9228 char_u *list;
9229 char_u *sfname;
9230 char_u *ffname;
9232 char_u buf[100];
9233 char_u *tail;
9234 char_u *regpat;
9235 char allow_dirs;
9236 int match;
9237 char_u *p;
9239 tail = gettail(sfname);
9241 /* try all patterns in 'wildignore' */
9242 p = list;
9243 while (*p)
9245 copy_option_part(&p, buf, 100, ",");
9246 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9247 if (regpat == NULL)
9248 break;
9249 match = match_file_pat(regpat, NULL, ffname, sfname,
9250 tail, (int)allow_dirs);
9251 vim_free(regpat);
9252 if (match)
9253 return TRUE;
9255 return FALSE;
9257 #endif
9260 * Convert the given pattern "pat" which has shell style wildcards in it, into
9261 * a regular expression, and return the result in allocated memory. If there
9262 * is a directory path separator to be matched, then TRUE is put in
9263 * allow_dirs, otherwise FALSE is put there -- webb.
9264 * Handle backslashes before special characters, like "\*" and "\ ".
9266 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9267 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9269 * Returns NULL when out of memory.
9271 /*ARGSUSED*/
9272 char_u *
9273 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9274 char_u *pat;
9275 char_u *pat_end; /* first char after pattern or NULL */
9276 char *allow_dirs; /* Result passed back out in here */
9277 int no_bslash; /* Don't use a backward slash as pathsep */
9279 int size;
9280 char_u *endp;
9281 char_u *reg_pat;
9282 char_u *p;
9283 int i;
9284 int nested = 0;
9285 int add_dollar = TRUE;
9286 #ifdef FEAT_OSFILETYPE
9287 int check_length = 0;
9288 #endif
9290 if (allow_dirs != NULL)
9291 *allow_dirs = FALSE;
9292 if (pat_end == NULL)
9293 pat_end = pat + STRLEN(pat);
9295 #ifdef FEAT_OSFILETYPE
9296 /* Find out how much of the string is the filetype check */
9297 if (*pat == '<')
9299 /* Count chars until the next '>' */
9300 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9302 if (p < pat_end)
9304 /* Pattern is of the form <.*>.* */
9305 check_length = p - pat + 1;
9306 if (p + 1 >= pat_end)
9308 /* The 'pattern' is a filetype check ONLY */
9309 reg_pat = (char_u *)alloc(check_length + 1);
9310 if (reg_pat != NULL)
9312 mch_memmove(reg_pat, pat, (size_t)check_length);
9313 reg_pat[check_length] = NUL;
9315 return reg_pat;
9318 /* else: there was no closing '>' - assume it was a normal pattern */
9321 pat += check_length;
9322 size = 2 + check_length;
9323 #else
9324 size = 2; /* '^' at start, '$' at end */
9325 #endif
9327 for (p = pat; p < pat_end; p++)
9329 switch (*p)
9331 case '*':
9332 case '.':
9333 case ',':
9334 case '{':
9335 case '}':
9336 case '~':
9337 size += 2; /* extra backslash */
9338 break;
9339 #ifdef BACKSLASH_IN_FILENAME
9340 case '\\':
9341 case '/':
9342 size += 4; /* could become "[\/]" */
9343 break;
9344 #endif
9345 default:
9346 size++;
9347 # ifdef FEAT_MBYTE
9348 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9350 ++p;
9351 ++size;
9353 # endif
9354 break;
9357 reg_pat = alloc(size + 1);
9358 if (reg_pat == NULL)
9359 return NULL;
9361 #ifdef FEAT_OSFILETYPE
9362 /* Copy the type check in to the start. */
9363 if (check_length)
9364 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9365 i = check_length;
9366 #else
9367 i = 0;
9368 #endif
9370 if (pat[0] == '*')
9371 while (pat[0] == '*' && pat < pat_end - 1)
9372 pat++;
9373 else
9374 reg_pat[i++] = '^';
9375 endp = pat_end - 1;
9376 if (*endp == '*')
9378 while (endp - pat > 0 && *endp == '*')
9379 endp--;
9380 add_dollar = FALSE;
9382 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9384 switch (*p)
9386 case '*':
9387 reg_pat[i++] = '.';
9388 reg_pat[i++] = '*';
9389 while (p[1] == '*') /* "**" matches like "*" */
9390 ++p;
9391 break;
9392 case '.':
9393 #ifdef RISCOS
9394 if (allow_dirs != NULL)
9395 *allow_dirs = TRUE;
9396 /* FALLTHROUGH */
9397 #endif
9398 case '~':
9399 reg_pat[i++] = '\\';
9400 reg_pat[i++] = *p;
9401 break;
9402 case '?':
9403 #ifdef RISCOS
9404 case '#':
9405 #endif
9406 reg_pat[i++] = '.';
9407 break;
9408 case '\\':
9409 if (p[1] == NUL)
9410 break;
9411 #ifdef BACKSLASH_IN_FILENAME
9412 if (!no_bslash)
9414 /* translate:
9415 * "\x" to "\\x" e.g., "dir\file"
9416 * "\*" to "\\.*" e.g., "dir\*.c"
9417 * "\?" to "\\." e.g., "dir\??.c"
9418 * "\+" to "\+" e.g., "fileX\+.c"
9420 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9421 && p[1] != '+')
9423 reg_pat[i++] = '[';
9424 reg_pat[i++] = '\\';
9425 reg_pat[i++] = '/';
9426 reg_pat[i++] = ']';
9427 if (allow_dirs != NULL)
9428 *allow_dirs = TRUE;
9429 break;
9432 #endif
9433 if (*++p == '?'
9434 #ifdef BACKSLASH_IN_FILENAME
9435 && no_bslash
9436 #endif
9438 reg_pat[i++] = '?';
9439 else
9440 if (*p == ',')
9441 reg_pat[i++] = ',';
9442 else
9444 if (allow_dirs != NULL && vim_ispathsep(*p)
9445 #ifdef BACKSLASH_IN_FILENAME
9446 && (!no_bslash || *p != '\\')
9447 #endif
9449 *allow_dirs = TRUE;
9450 reg_pat[i++] = '\\';
9451 reg_pat[i++] = *p;
9453 break;
9454 #ifdef BACKSLASH_IN_FILENAME
9455 case '/':
9456 reg_pat[i++] = '[';
9457 reg_pat[i++] = '\\';
9458 reg_pat[i++] = '/';
9459 reg_pat[i++] = ']';
9460 if (allow_dirs != NULL)
9461 *allow_dirs = TRUE;
9462 break;
9463 #endif
9464 case '{':
9465 reg_pat[i++] = '\\';
9466 reg_pat[i++] = '(';
9467 nested++;
9468 break;
9469 case '}':
9470 reg_pat[i++] = '\\';
9471 reg_pat[i++] = ')';
9472 --nested;
9473 break;
9474 case ',':
9475 if (nested)
9477 reg_pat[i++] = '\\';
9478 reg_pat[i++] = '|';
9480 else
9481 reg_pat[i++] = ',';
9482 break;
9483 default:
9484 # ifdef FEAT_MBYTE
9485 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9486 reg_pat[i++] = *p++;
9487 else
9488 # endif
9489 if (allow_dirs != NULL && vim_ispathsep(*p))
9490 *allow_dirs = TRUE;
9491 reg_pat[i++] = *p;
9492 break;
9495 if (add_dollar)
9496 reg_pat[i++] = '$';
9497 reg_pat[i] = NUL;
9498 if (nested != 0)
9500 if (nested < 0)
9501 EMSG(_("E219: Missing {."));
9502 else
9503 EMSG(_("E220: Missing }."));
9504 vim_free(reg_pat);
9505 reg_pat = NULL;
9507 return reg_pat;