Merge branch 'vim'
[MacVim.git] / src / fileio.c
blob5068c51add6f6bb7bf5cfef473a83b50bffc2dec
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 __TANDEM
25 # include <limits.h> /* for SSIZE_MAX */
26 #endif
28 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
29 # include <utime.h> /* for struct utimbuf */
30 #endif
32 #define BUFSIZE 8192 /* size of normal write buffer */
33 #define SMBUFSIZE 256 /* size of emergency write buffer */
35 #ifdef FEAT_CRYPT
36 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
37 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
38 #endif
40 /* Is there any system that doesn't have access()? */
41 #define USE_MCH_ACCESS
43 #if defined(sun) && defined(S_ISCHR)
44 # define OPEN_CHR_FILES
45 static int is_dev_fd_file(char_u *fname);
46 #endif
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; /* length 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 check_readonly;
221 int filtering = (flags & READ_FILTER);
222 int read_stdin = (flags & READ_STDIN);
223 int read_buffer = (flags & READ_BUFFER);
224 int set_options = newfile || read_buffer
225 || (eap != NULL && eap->read_edit);
226 linenr_T read_buf_lnum = 1; /* next line to read from curbuf */
227 colnr_T read_buf_col = 0; /* next char to read from this line */
228 char_u c;
229 linenr_T lnum = from;
230 char_u *ptr = NULL; /* pointer into read buffer */
231 char_u *buffer = NULL; /* read buffer */
232 char_u *new_buffer = NULL; /* init to shut up gcc */
233 char_u *line_start = NULL; /* init to shut up gcc */
234 int wasempty; /* buffer was empty before reading */
235 colnr_T len;
236 long size = 0;
237 char_u *p;
238 long filesize = 0;
239 int skip_read = FALSE;
240 #ifdef FEAT_CRYPT
241 char_u *cryptkey = NULL;
242 #endif
243 int split = 0; /* number of split lines */
244 #define UNKNOWN 0x0fffffff /* file size is unknown */
245 linenr_T linecnt;
246 int error = FALSE; /* errors encountered */
247 int ff_error = EOL_UNKNOWN; /* file format with errors */
248 long linerest = 0; /* remaining chars in line */
249 #ifdef UNIX
250 int perm = 0;
251 int swap_mode = -1; /* protection bits for swap file */
252 #else
253 int perm;
254 #endif
255 int fileformat = 0; /* end-of-line format */
256 int keep_fileformat = FALSE;
257 struct stat st;
258 int file_readonly;
259 linenr_T skip_count = 0;
260 linenr_T read_count = 0;
261 int msg_save = msg_scroll;
262 linenr_T read_no_eol_lnum = 0; /* non-zero lnum when last line of
263 * last read was missing the eol */
264 int try_mac = (vim_strchr(p_ffs, 'm') != NULL);
265 int try_dos = (vim_strchr(p_ffs, 'd') != NULL);
266 int try_unix = (vim_strchr(p_ffs, 'x') != NULL);
267 int file_rewind = FALSE;
268 #ifdef FEAT_MBYTE
269 int can_retry;
270 linenr_T conv_error = 0; /* line nr with conversion error */
271 linenr_T illegal_byte = 0; /* line nr with illegal byte */
272 int keep_dest_enc = FALSE; /* don't retry when char doesn't fit
273 in destination encoding */
274 int bad_char_behavior = BAD_REPLACE;
275 /* BAD_KEEP, BAD_DROP or character to
276 * replace with */
277 char_u *tmpname = NULL; /* name of 'charconvert' output file */
278 int fio_flags = 0;
279 char_u *fenc; /* fileencoding to use */
280 int fenc_alloced; /* fenc_next is in allocated memory */
281 char_u *fenc_next = NULL; /* next item in 'fencs' or NULL */
282 int advance_fenc = FALSE;
283 long real_size = 0;
284 # ifdef USE_ICONV
285 iconv_t iconv_fd = (iconv_t)-1; /* descriptor for iconv() or -1 */
286 # ifdef FEAT_EVAL
287 int did_iconv = FALSE; /* TRUE when iconv() failed and trying
288 'charconvert' next */
289 # endif
290 # endif
291 int converted = FALSE; /* TRUE if conversion done */
292 int notconverted = FALSE; /* TRUE if conversion wanted but it
293 wasn't possible */
294 char_u conv_rest[CONV_RESTLEN];
295 int conv_restlen = 0; /* nr of bytes in conv_rest[] */
296 #endif
298 write_no_eol_lnum = 0; /* in case it was set by the previous read */
301 * If there is no file name yet, use the one for the read file.
302 * BF_NOTEDITED is set to reflect this.
303 * Don't do this for a read from a filter.
304 * Only do this when 'cpoptions' contains the 'f' flag.
306 if (curbuf->b_ffname == NULL
307 && !filtering
308 && fname != NULL
309 && vim_strchr(p_cpo, CPO_FNAMER) != NULL
310 && !(flags & READ_DUMMY))
312 if (set_rw_fname(fname, sfname) == FAIL)
313 return FAIL;
316 /* After reading a file the cursor line changes but we don't want to
317 * display the line. */
318 ex_no_reprint = TRUE;
320 /* don't display the file info for another buffer now */
321 need_fileinfo = FALSE;
324 * For Unix: Use the short file name whenever possible.
325 * Avoids problems with networks and when directory names are changed.
326 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
327 * another directory, which we don't detect.
329 if (sfname == NULL)
330 sfname = fname;
331 #if defined(UNIX) || defined(__EMX__)
332 fname = sfname;
333 #endif
335 #ifdef FEAT_AUTOCMD
337 * The BufReadCmd and FileReadCmd events intercept the reading process by
338 * executing the associated commands instead.
340 if (!filtering && !read_stdin && !read_buffer)
342 pos_T pos;
344 pos = curbuf->b_op_start;
346 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
347 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
348 curbuf->b_op_start.col = 0;
350 if (newfile)
352 if (apply_autocmds_exarg(EVENT_BUFREADCMD, NULL, sfname,
353 FALSE, curbuf, eap))
354 #ifdef FEAT_EVAL
355 return aborting() ? FAIL : OK;
356 #else
357 return OK;
358 #endif
360 else if (apply_autocmds_exarg(EVENT_FILEREADCMD, sfname, sfname,
361 FALSE, NULL, eap))
362 #ifdef FEAT_EVAL
363 return aborting() ? FAIL : OK;
364 #else
365 return OK;
366 #endif
368 curbuf->b_op_start = pos;
370 #endif
372 if ((shortmess(SHM_OVER) || curbuf->b_help) && p_verbose == 0)
373 msg_scroll = FALSE; /* overwrite previous file message */
374 else
375 msg_scroll = TRUE; /* don't overwrite previous file message */
378 * If the name ends in a path separator, we can't open it. Check here,
379 * because reading the file may actually work, but then creating the swap
380 * file may destroy it! Reported on MS-DOS and Win 95.
381 * If the name is too long we might crash further on, quit here.
383 if (fname != NULL && *fname != NUL)
385 p = fname + STRLEN(fname);
386 if (after_pathsep(fname, p) || STRLEN(fname) >= MAXPATHL)
388 filemess(curbuf, fname, (char_u *)_("Illegal file name"), 0);
389 msg_end();
390 msg_scroll = msg_save;
391 return FAIL;
395 #ifdef UNIX
397 * On Unix it is possible to read a directory, so we have to
398 * check for it before the mch_open().
400 if (!read_stdin && !read_buffer)
402 perm = mch_getperm(fname);
403 if (perm >= 0 && !S_ISREG(perm) /* not a regular file ... */
404 # ifdef S_ISFIFO
405 && !S_ISFIFO(perm) /* ... or fifo */
406 # endif
407 # ifdef S_ISSOCK
408 && !S_ISSOCK(perm) /* ... or socket */
409 # endif
410 # ifdef OPEN_CHR_FILES
411 && !(S_ISCHR(perm) && is_dev_fd_file(fname))
412 /* ... or a character special file named /dev/fd/<n> */
413 # endif
416 if (S_ISDIR(perm))
417 filemess(curbuf, fname, (char_u *)_("is a directory"), 0);
418 else
419 filemess(curbuf, fname, (char_u *)_("is not a file"), 0);
420 msg_end();
421 msg_scroll = msg_save;
422 return FAIL;
425 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
427 * MS-Windows allows opening a device, but we will probably get stuck
428 * trying to read it.
430 if (!p_odev && mch_nodetype(fname) == NODE_WRITABLE)
432 filemess(curbuf, fname, (char_u *)_("is a device (disabled with 'opendevice' option)"), 0);
433 msg_end();
434 msg_scroll = msg_save;
435 return FAIL;
437 # endif
439 #endif
441 /* set default 'fileformat' */
442 if (set_options)
444 if (eap != NULL && eap->force_ff != 0)
445 set_fileformat(get_fileformat_force(curbuf, eap), OPT_LOCAL);
446 else if (*p_ffs != NUL)
447 set_fileformat(default_fileformat(), OPT_LOCAL);
450 /* set or reset 'binary' */
451 if (eap != NULL && eap->force_bin != 0)
453 int oldval = curbuf->b_p_bin;
455 curbuf->b_p_bin = (eap->force_bin == FORCE_BIN);
456 set_options_bin(oldval, curbuf->b_p_bin, OPT_LOCAL);
460 * When opening a new file we take the readonly flag from the file.
461 * Default is r/w, can be set to r/o below.
462 * Don't reset it when in readonly mode
463 * Only set/reset b_p_ro when BF_CHECK_RO is set.
465 check_readonly = (newfile && (curbuf->b_flags & BF_CHECK_RO));
466 if (check_readonly && !readonlymode)
467 curbuf->b_p_ro = FALSE;
469 if (newfile && !read_stdin && !read_buffer)
471 /* Remember time of file.
472 * For RISCOS, also remember the filetype.
474 if (mch_stat((char *)fname, &st) >= 0)
476 buf_store_time(curbuf, &st, fname);
477 curbuf->b_mtime_read = curbuf->b_mtime;
479 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
480 /* Read the filetype into the buffer local filetype option. */
481 mch_read_filetype(fname);
482 #endif
483 #ifdef UNIX
485 * Use the protection bits of the original file for the swap file.
486 * This makes it possible for others to read the name of the
487 * edited file from the swapfile, but only if they can read the
488 * edited file.
489 * Remove the "write" and "execute" bits for group and others
490 * (they must not write the swapfile).
491 * Add the "read" and "write" bits for the user, otherwise we may
492 * not be able to write to the file ourselves.
493 * Setting the bits is done below, after creating the swap file.
495 swap_mode = (st.st_mode & 0644) | 0600;
496 #endif
497 #ifdef FEAT_CW_EDITOR
498 /* Get the FSSpec on MacOS
499 * TODO: Update it properly when the buffer name changes
501 (void)GetFSSpecFromPath(curbuf->b_ffname, &curbuf->b_FSSpec);
502 #endif
503 #ifdef VMS
504 curbuf->b_fab_rfm = st.st_fab_rfm;
505 curbuf->b_fab_rat = st.st_fab_rat;
506 curbuf->b_fab_mrs = st.st_fab_mrs;
507 #endif
509 else
511 curbuf->b_mtime = 0;
512 curbuf->b_mtime_read = 0;
513 curbuf->b_orig_size = 0;
514 curbuf->b_orig_mode = 0;
517 /* Reset the "new file" flag. It will be set again below when the
518 * file doesn't exist. */
519 curbuf->b_flags &= ~(BF_NEW | BF_NEW_W);
523 * for UNIX: check readonly with perm and mch_access()
524 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
525 * for MSDOS and Amiga: check readonly by trying to open the file for writing
527 file_readonly = FALSE;
528 if (read_stdin)
530 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
531 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
532 setmode(0, O_BINARY);
533 #endif
535 else if (!read_buffer)
537 #ifdef USE_MCH_ACCESS
538 if (
539 # ifdef UNIX
540 !(perm & 0222) ||
541 # endif
542 mch_access((char *)fname, W_OK))
543 file_readonly = TRUE;
544 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
545 #else
546 if (!newfile
547 || readonlymode
548 || (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0)
550 file_readonly = TRUE;
551 /* try to open ro */
552 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
554 #endif
557 if (fd < 0) /* cannot open at all */
559 #ifndef UNIX
560 int isdir_f;
561 #endif
562 msg_scroll = msg_save;
563 #ifndef UNIX
565 * On MSDOS and Amiga we can't open a directory, check here.
567 isdir_f = (mch_isdir(fname));
568 perm = mch_getperm(fname); /* check if the file exists */
569 if (isdir_f)
571 filemess(curbuf, sfname, (char_u *)_("is a directory"), 0);
572 curbuf->b_p_ro = TRUE; /* must use "w!" now */
574 else
575 #endif
576 if (newfile)
578 if (perm < 0)
581 * Set the 'new-file' flag, so that when the file has
582 * been created by someone else, a ":w" will complain.
584 curbuf->b_flags |= BF_NEW;
586 /* Create a swap file now, so that other Vims are warned
587 * that we are editing this file. Don't do this for a
588 * "nofile" or "nowrite" buffer type. */
589 #ifdef FEAT_QUICKFIX
590 if (!bt_dontwrite(curbuf))
591 #endif
592 check_need_swap(newfile);
593 if (dir_of_file_exists(fname))
594 filemess(curbuf, sfname, (char_u *)_("[New File]"), 0);
595 else
596 filemess(curbuf, sfname,
597 (char_u *)_("[New DIRECTORY]"), 0);
598 #ifdef FEAT_VIMINFO
599 /* Even though this is a new file, it might have been
600 * edited before and deleted. Get the old marks. */
601 check_marks_read();
602 #endif
603 #ifdef FEAT_MBYTE
604 if (eap != NULL && eap->force_enc != 0)
606 /* set forced 'fileencoding' */
607 fenc = enc_canonize(eap->cmd + eap->force_enc);
608 if (fenc != NULL)
609 set_string_option_direct((char_u *)"fenc", -1,
610 fenc, OPT_FREE|OPT_LOCAL, 0);
611 vim_free(fenc);
613 #endif
614 #ifdef FEAT_AUTOCMD
615 apply_autocmds_exarg(EVENT_BUFNEWFILE, sfname, sfname,
616 FALSE, curbuf, eap);
617 #endif
618 /* remember the current fileformat */
619 save_file_ff(curbuf);
621 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
622 if (aborting()) /* autocmds may abort script processing */
623 return FAIL;
624 #endif
625 return OK; /* a new file is not an error */
627 else
629 filemess(curbuf, sfname, (char_u *)(
630 # ifdef EFBIG
631 (errno == EFBIG) ? _("[File too big]") :
632 # endif
633 _("[Permission Denied]")), 0);
634 curbuf->b_p_ro = TRUE; /* must use "w!" now */
638 return FAIL;
642 * Only set the 'ro' flag for readonly files the first time they are
643 * loaded. Help files always get readonly mode
645 if ((check_readonly && file_readonly) || curbuf->b_help)
646 curbuf->b_p_ro = TRUE;
648 if (set_options)
650 /* Don't change 'eol' if reading from buffer as it will already be
651 * correctly set when reading stdin. */
652 if (!read_buffer)
654 curbuf->b_p_eol = TRUE;
655 curbuf->b_start_eol = TRUE;
657 #ifdef FEAT_MBYTE
658 curbuf->b_p_bomb = FALSE;
659 curbuf->b_start_bomb = FALSE;
660 #endif
663 /* Create a swap file now, so that other Vims are warned that we are
664 * editing this file.
665 * Don't do this for a "nofile" or "nowrite" buffer type. */
666 #ifdef FEAT_QUICKFIX
667 if (!bt_dontwrite(curbuf))
668 #endif
670 check_need_swap(newfile);
671 #ifdef UNIX
672 /* Set swap file protection bits after creating it. */
673 if (swap_mode > 0 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
674 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
675 #endif
678 #if defined(HAS_SWAP_EXISTS_ACTION)
679 /* If "Quit" selected at ATTENTION dialog, don't load the file */
680 if (swap_exists_action == SEA_QUIT)
682 if (!read_buffer && !read_stdin)
683 close(fd);
684 return FAIL;
686 #endif
688 ++no_wait_return; /* don't wait for return yet */
691 * Set '[ mark to the line above where the lines go (line 1 if zero).
693 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
694 curbuf->b_op_start.col = 0;
696 #ifdef FEAT_AUTOCMD
697 if (!read_buffer)
699 int m = msg_scroll;
700 int n = msg_scrolled;
701 buf_T *old_curbuf = curbuf;
704 * The file must be closed again, the autocommands may want to change
705 * the file before reading it.
707 if (!read_stdin)
708 close(fd); /* ignore errors */
711 * The output from the autocommands should not overwrite anything and
712 * should not be overwritten: Set msg_scroll, restore its value if no
713 * output was done.
715 msg_scroll = TRUE;
716 if (filtering)
717 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
718 FALSE, curbuf, eap);
719 else if (read_stdin)
720 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
721 FALSE, curbuf, eap);
722 else if (newfile)
723 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
724 FALSE, curbuf, eap);
725 else
726 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
727 FALSE, NULL, eap);
728 if (msg_scrolled == n)
729 msg_scroll = m;
731 #ifdef FEAT_EVAL
732 if (aborting()) /* autocmds may abort script processing */
734 --no_wait_return;
735 msg_scroll = msg_save;
736 curbuf->b_p_ro = TRUE; /* must use "w!" now */
737 return FAIL;
739 #endif
741 * Don't allow the autocommands to change the current buffer.
742 * Try to re-open the file.
744 if (!read_stdin && (curbuf != old_curbuf
745 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
747 --no_wait_return;
748 msg_scroll = msg_save;
749 if (fd < 0)
750 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
751 else
752 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
753 curbuf->b_p_ro = TRUE; /* must use "w!" now */
754 return FAIL;
757 #endif /* FEAT_AUTOCMD */
759 /* Autocommands may add lines to the file, need to check if it is empty */
760 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
762 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
765 * Show the user that we are busy reading the input. Sometimes this
766 * may take a while. When reading from stdin another program may
767 * still be running, don't move the cursor to the last line, unless
768 * always using the GUI.
770 if (read_stdin)
772 #ifndef ALWAYS_USE_GUI
773 mch_msg(_("Vim: Reading from stdin...\n"));
774 #endif
775 #ifdef FEAT_GUI
776 /* Also write a message in the GUI window, if there is one. */
777 if (gui.in_use && !gui.dying && !gui.starting)
779 p = (char_u *)_("Reading from stdin...");
780 gui_write(p, (int)STRLEN(p));
782 #endif
784 else if (!read_buffer)
785 filemess(curbuf, sfname, (char_u *)"", 0);
788 msg_scroll = FALSE; /* overwrite the file message */
791 * Set linecnt now, before the "retry" caused by a wrong guess for
792 * fileformat, and after the autocommands, which may change them.
794 linecnt = curbuf->b_ml.ml_line_count;
796 #ifdef FEAT_MBYTE
797 /* "++bad=" argument. */
798 if (eap != NULL && eap->bad_char != 0)
800 bad_char_behavior = eap->bad_char;
801 if (set_options)
802 curbuf->b_bad_char = eap->bad_char;
804 else
805 curbuf->b_bad_char = 0;
808 * Decide which 'encoding' to use or use first.
810 if (eap != NULL && eap->force_enc != 0)
812 fenc = enc_canonize(eap->cmd + eap->force_enc);
813 fenc_alloced = TRUE;
814 keep_dest_enc = TRUE;
816 else if (curbuf->b_p_bin)
818 fenc = (char_u *)""; /* binary: don't convert */
819 fenc_alloced = FALSE;
821 else if (curbuf->b_help)
823 char_u firstline[80];
824 int fc;
826 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
827 * fails it must be latin1.
828 * Always do this when 'encoding' is "utf-8". Otherwise only do
829 * this when needed to avoid [converted] remarks all the time.
830 * It is needed when the first line contains non-ASCII characters.
831 * That is only in *.??x files. */
832 fenc = (char_u *)"latin1";
833 c = enc_utf8;
834 if (!c && !read_stdin)
836 fc = fname[STRLEN(fname) - 1];
837 if (TOLOWER_ASC(fc) == 'x')
839 /* Read the first line (and a bit more). Immediately rewind to
840 * the start of the file. If the read() fails "len" is -1. */
841 len = vim_read(fd, firstline, 80);
842 lseek(fd, (off_t)0L, SEEK_SET);
843 for (p = firstline; p < firstline + len; ++p)
844 if (*p >= 0x80)
846 c = TRUE;
847 break;
852 if (c)
854 fenc_next = fenc;
855 fenc = (char_u *)"utf-8";
857 /* When the file is utf-8 but a character doesn't fit in
858 * 'encoding' don't retry. In help text editing utf-8 bytes
859 * doesn't make sense. */
860 if (!enc_utf8)
861 keep_dest_enc = TRUE;
863 fenc_alloced = FALSE;
865 else if (*p_fencs == NUL)
867 fenc = curbuf->b_p_fenc; /* use format from buffer */
868 fenc_alloced = FALSE;
870 else
872 fenc_next = p_fencs; /* try items in 'fileencodings' */
873 fenc = next_fenc(&fenc_next);
874 fenc_alloced = TRUE;
876 #endif
879 * Jump back here to retry reading the file in different ways.
880 * Reasons to retry:
881 * - encoding conversion failed: try another one from "fenc_next"
882 * - BOM detected and fenc was set, need to setup conversion
883 * - "fileformat" check failed: try another
885 * Variables set for special retry actions:
886 * "file_rewind" Rewind the file to start reading it again.
887 * "advance_fenc" Advance "fenc" using "fenc_next".
888 * "skip_read" Re-use already read bytes (BOM detected).
889 * "did_iconv" iconv() conversion failed, try 'charconvert'.
890 * "keep_fileformat" Don't reset "fileformat".
892 * Other status indicators:
893 * "tmpname" When != NULL did conversion with 'charconvert'.
894 * Output file has to be deleted afterwards.
895 * "iconv_fd" When != -1 did conversion with iconv().
897 retry:
899 if (file_rewind)
901 if (read_buffer)
903 read_buf_lnum = 1;
904 read_buf_col = 0;
906 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
908 /* Can't rewind the file, give up. */
909 error = TRUE;
910 goto failed;
912 /* Delete the previously read lines. */
913 while (lnum > from)
914 ml_delete(lnum--, FALSE);
915 file_rewind = FALSE;
916 #ifdef FEAT_MBYTE
917 if (set_options)
919 curbuf->b_p_bomb = FALSE;
920 curbuf->b_start_bomb = FALSE;
922 conv_error = 0;
923 #endif
927 * When retrying with another "fenc" and the first time "fileformat"
928 * will be reset.
930 if (keep_fileformat)
931 keep_fileformat = FALSE;
932 else
934 if (eap != NULL && eap->force_ff != 0)
936 fileformat = get_fileformat_force(curbuf, eap);
937 try_unix = try_dos = try_mac = FALSE;
939 else if (curbuf->b_p_bin)
940 fileformat = EOL_UNIX; /* binary: use Unix format */
941 else if (*p_ffs == NUL)
942 fileformat = get_fileformat(curbuf);/* use format from buffer */
943 else
944 fileformat = EOL_UNKNOWN; /* detect from file */
947 #ifdef FEAT_MBYTE
948 # ifdef USE_ICONV
949 if (iconv_fd != (iconv_t)-1)
951 /* aborted conversion with iconv(), close the descriptor */
952 iconv_close(iconv_fd);
953 iconv_fd = (iconv_t)-1;
955 # endif
957 if (advance_fenc)
960 * Try the next entry in 'fileencodings'.
962 advance_fenc = FALSE;
964 if (eap != NULL && eap->force_enc != 0)
966 /* Conversion given with "++cc=" wasn't possible, read
967 * without conversion. */
968 notconverted = TRUE;
969 conv_error = 0;
970 if (fenc_alloced)
971 vim_free(fenc);
972 fenc = (char_u *)"";
973 fenc_alloced = FALSE;
975 else
977 if (fenc_alloced)
978 vim_free(fenc);
979 if (fenc_next != NULL)
981 fenc = next_fenc(&fenc_next);
982 fenc_alloced = (fenc_next != NULL);
984 else
986 fenc = (char_u *)"";
987 fenc_alloced = FALSE;
990 if (tmpname != NULL)
992 mch_remove(tmpname); /* delete converted file */
993 vim_free(tmpname);
994 tmpname = NULL;
999 * Conversion is required when the encoding of the file is different
1000 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
1001 * conversion to UTF-8).
1003 fio_flags = 0;
1004 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
1005 if (converted || enc_unicode != 0)
1008 /* "ucs-bom" means we need to check the first bytes of the file
1009 * for a BOM. */
1010 if (STRCMP(fenc, ENC_UCSBOM) == 0)
1011 fio_flags = FIO_UCSBOM;
1014 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1015 * done. This is handled below after read(). Prepare the
1016 * fio_flags to avoid having to parse the string each time.
1017 * Also check for Unicode to Latin1 conversion, because iconv()
1018 * appears not to handle this correctly. This works just like
1019 * conversion to UTF-8 except how the resulting character is put in
1020 * the buffer.
1022 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1023 fio_flags = get_fio_flags(fenc);
1025 # ifdef WIN3264
1027 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1028 * is handled with MultiByteToWideChar().
1030 if (fio_flags == 0)
1031 fio_flags = get_win_fio_flags(fenc);
1032 # endif
1034 # ifdef MACOS_X
1035 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1036 if (fio_flags == 0)
1037 fio_flags = get_mac_fio_flags(fenc);
1038 # endif
1040 # ifdef USE_ICONV
1042 * Try using iconv() if we can't convert internally.
1044 if (fio_flags == 0
1045 # ifdef FEAT_EVAL
1046 && !did_iconv
1047 # endif
1049 iconv_fd = (iconv_t)my_iconv_open(
1050 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1051 # endif
1053 # ifdef FEAT_EVAL
1055 * Use the 'charconvert' expression when conversion is required
1056 * and we can't do it internally or with iconv().
1058 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1059 # ifdef USE_ICONV
1060 && iconv_fd == (iconv_t)-1
1061 # endif
1064 # ifdef USE_ICONV
1065 did_iconv = FALSE;
1066 # endif
1067 /* Skip conversion when it's already done (retry for wrong
1068 * "fileformat"). */
1069 if (tmpname == NULL)
1071 tmpname = readfile_charconvert(fname, fenc, &fd);
1072 if (tmpname == NULL)
1074 /* Conversion failed. Try another one. */
1075 advance_fenc = TRUE;
1076 if (fd < 0)
1078 /* Re-opening the original file failed! */
1079 EMSG(_("E202: Conversion made file unreadable!"));
1080 error = TRUE;
1081 goto failed;
1083 goto retry;
1087 else
1088 # endif
1090 if (fio_flags == 0
1091 # ifdef USE_ICONV
1092 && iconv_fd == (iconv_t)-1
1093 # endif
1096 /* Conversion wanted but we can't.
1097 * Try the next conversion in 'fileencodings' */
1098 advance_fenc = TRUE;
1099 goto retry;
1104 /* Set "can_retry" when it's possible to rewind the file and try with
1105 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1106 * stdin or fixed at a specific encoding. */
1107 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1108 #endif
1110 if (!skip_read)
1112 linerest = 0;
1113 filesize = 0;
1114 skip_count = lines_to_skip;
1115 read_count = lines_to_read;
1116 #ifdef FEAT_MBYTE
1117 conv_restlen = 0;
1118 #endif
1121 while (!error && !got_int)
1124 * We allocate as much space for the file as we can get, plus
1125 * space for the old line plus room for one terminating NUL.
1126 * The amount is limited by the fact that read() only can read
1127 * upto max_unsigned characters (and other things).
1129 #if SIZEOF_INT <= 2
1130 if (linerest >= 0x7ff0)
1132 ++split;
1133 *ptr = NL; /* split line by inserting a NL */
1134 size = 1;
1136 else
1137 #endif
1139 if (!skip_read)
1141 #if SIZEOF_INT > 2
1142 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1143 size = SSIZE_MAX; /* use max I/O size, 52K */
1144 # else
1145 size = 0x10000L; /* use buffer >= 64K */
1146 # endif
1147 #else
1148 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1149 #endif
1151 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1153 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1154 FALSE)) != NULL)
1155 break;
1157 if (new_buffer == NULL)
1159 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1160 error = TRUE;
1161 break;
1163 if (linerest) /* copy characters from the previous buffer */
1164 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1165 vim_free(buffer);
1166 buffer = new_buffer;
1167 ptr = buffer + linerest;
1168 line_start = buffer;
1170 #ifdef FEAT_MBYTE
1171 /* May need room to translate into.
1172 * For iconv() we don't really know the required space, use a
1173 * factor ICONV_MULT.
1174 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1175 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1176 * become up to 4 bytes, size must be multiple of 2
1177 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1178 * multiple of 2
1179 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1180 * multiple of 4 */
1181 real_size = (int)size;
1182 # ifdef USE_ICONV
1183 if (iconv_fd != (iconv_t)-1)
1184 size = size / ICONV_MULT;
1185 else
1186 # endif
1187 if (fio_flags & FIO_LATIN1)
1188 size = size / 2;
1189 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1190 size = (size * 2 / 3) & ~1;
1191 else if (fio_flags & FIO_UCS4)
1192 size = (size * 2 / 3) & ~3;
1193 else if (fio_flags == FIO_UCSBOM)
1194 size = size / ICONV_MULT; /* worst case */
1195 # ifdef WIN3264
1196 else if (fio_flags & FIO_CODEPAGE)
1197 size = size / ICONV_MULT; /* also worst case */
1198 # endif
1199 # ifdef MACOS_X
1200 else if (fio_flags & FIO_MACROMAN)
1201 size = size / ICONV_MULT; /* also worst case */
1202 # endif
1203 #endif
1205 #ifdef FEAT_MBYTE
1206 if (conv_restlen > 0)
1208 /* Insert unconverted bytes from previous line. */
1209 mch_memmove(ptr, conv_rest, conv_restlen);
1210 ptr += conv_restlen;
1211 size -= conv_restlen;
1213 #endif
1215 if (read_buffer)
1218 * Read bytes from curbuf. Used for converting text read
1219 * from stdin.
1221 if (read_buf_lnum > from)
1222 size = 0;
1223 else
1225 int n, ni;
1226 long tlen;
1228 tlen = 0;
1229 for (;;)
1231 p = ml_get(read_buf_lnum) + read_buf_col;
1232 n = (int)STRLEN(p);
1233 if ((int)tlen + n + 1 > size)
1235 /* Filled up to "size", append partial line.
1236 * Change NL to NUL to reverse the effect done
1237 * below. */
1238 n = (int)(size - tlen);
1239 for (ni = 0; ni < n; ++ni)
1241 if (p[ni] == NL)
1242 ptr[tlen++] = NUL;
1243 else
1244 ptr[tlen++] = p[ni];
1246 read_buf_col += n;
1247 break;
1249 else
1251 /* Append whole line and new-line. Change NL
1252 * to NUL to reverse the effect done below. */
1253 for (ni = 0; ni < n; ++ni)
1255 if (p[ni] == NL)
1256 ptr[tlen++] = NUL;
1257 else
1258 ptr[tlen++] = p[ni];
1260 ptr[tlen++] = NL;
1261 read_buf_col = 0;
1262 if (++read_buf_lnum > from)
1264 /* When the last line didn't have an
1265 * end-of-line don't add it now either. */
1266 if (!curbuf->b_p_eol)
1267 --tlen;
1268 size = tlen;
1269 break;
1275 else
1278 * Read bytes from the file.
1280 size = vim_read(fd, ptr, size);
1283 if (size <= 0)
1285 if (size < 0) /* read error */
1286 error = TRUE;
1287 #ifdef FEAT_MBYTE
1288 else if (conv_restlen > 0)
1291 * Reached end-of-file but some trailing bytes could
1292 * not be converted. Truncated file?
1295 /* When we did a conversion report an error. */
1296 if (fio_flags != 0
1297 # ifdef USE_ICONV
1298 || iconv_fd != (iconv_t)-1
1299 # endif
1302 if (conv_error == 0)
1303 conv_error = curbuf->b_ml.ml_line_count
1304 - linecnt + 1;
1306 /* Remember the first linenr with an illegal byte */
1307 else if (illegal_byte == 0)
1308 illegal_byte = curbuf->b_ml.ml_line_count
1309 - linecnt + 1;
1310 if (bad_char_behavior == BAD_DROP)
1312 *(ptr - conv_restlen) = NUL;
1313 conv_restlen = 0;
1315 else
1317 /* Replace the trailing bytes with the replacement
1318 * character if we were converting; if we weren't,
1319 * leave the UTF8 checking code to do it, as it
1320 * works slightly differently. */
1321 if (bad_char_behavior != BAD_KEEP && (fio_flags != 0
1322 # ifdef USE_ICONV
1323 || iconv_fd != (iconv_t)-1
1324 # endif
1327 while (conv_restlen > 0)
1329 *(--ptr) = bad_char_behavior;
1330 --conv_restlen;
1333 fio_flags = 0; /* don't convert this */
1334 # ifdef USE_ICONV
1335 if (iconv_fd != (iconv_t)-1)
1337 iconv_close(iconv_fd);
1338 iconv_fd = (iconv_t)-1;
1340 # endif
1343 #endif
1346 #ifdef FEAT_CRYPT
1348 * At start of file: Check for magic number of encryption.
1350 if (filesize == 0)
1351 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1352 &filesize, newfile);
1354 * Decrypt the read bytes.
1356 if (cryptkey != NULL && size > 0)
1357 for (p = ptr; p < ptr + size; ++p)
1358 ZDECODE(*p);
1359 #endif
1361 skip_read = FALSE;
1363 #ifdef FEAT_MBYTE
1365 * At start of file (or after crypt magic number): Check for BOM.
1366 * Also check for a BOM for other Unicode encodings, but not after
1367 * converting with 'charconvert' or when a BOM has already been
1368 * found.
1370 if ((filesize == 0
1371 # ifdef FEAT_CRYPT
1372 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1373 # endif
1375 && (fio_flags == FIO_UCSBOM
1376 || (!curbuf->b_p_bomb
1377 && tmpname == NULL
1378 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1380 char_u *ccname;
1381 int blen;
1383 /* no BOM detection in a short file or in binary mode */
1384 if (size < 2 || curbuf->b_p_bin)
1385 ccname = NULL;
1386 else
1387 ccname = check_for_bom(ptr, size, &blen,
1388 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1389 if (ccname != NULL)
1391 /* Remove BOM from the text */
1392 filesize += blen;
1393 size -= blen;
1394 mch_memmove(ptr, ptr + blen, (size_t)size);
1395 if (set_options)
1397 curbuf->b_p_bomb = TRUE;
1398 curbuf->b_start_bomb = TRUE;
1402 if (fio_flags == FIO_UCSBOM)
1404 if (ccname == NULL)
1406 /* No BOM detected: retry with next encoding. */
1407 advance_fenc = TRUE;
1409 else
1411 /* BOM detected: set "fenc" and jump back */
1412 if (fenc_alloced)
1413 vim_free(fenc);
1414 fenc = ccname;
1415 fenc_alloced = FALSE;
1417 /* retry reading without getting new bytes or rewinding */
1418 skip_read = TRUE;
1419 goto retry;
1423 /* Include not converted bytes. */
1424 ptr -= conv_restlen;
1425 size += conv_restlen;
1426 conv_restlen = 0;
1427 #endif
1429 * Break here for a read error or end-of-file.
1431 if (size <= 0)
1432 break;
1434 #ifdef FEAT_MBYTE
1436 # ifdef USE_ICONV
1437 if (iconv_fd != (iconv_t)-1)
1440 * Attempt conversion of the read bytes to 'encoding' using
1441 * iconv().
1443 const char *fromp;
1444 char *top;
1445 size_t from_size;
1446 size_t to_size;
1448 fromp = (char *)ptr;
1449 from_size = size;
1450 ptr += size;
1451 top = (char *)ptr;
1452 to_size = real_size - size;
1455 * If there is conversion error or not enough room try using
1456 * another conversion. Except for when there is no
1457 * alternative (help files).
1459 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1460 &top, &to_size)
1461 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1462 || from_size > CONV_RESTLEN)
1464 if (can_retry)
1465 goto rewind_retry;
1466 if (conv_error == 0)
1467 conv_error = readfile_linenr(linecnt,
1468 ptr, (char_u *)top);
1470 /* Deal with a bad byte and continue with the next. */
1471 ++fromp;
1472 --from_size;
1473 if (bad_char_behavior == BAD_KEEP)
1475 *top++ = *(fromp - 1);
1476 --to_size;
1478 else if (bad_char_behavior != BAD_DROP)
1480 *top++ = bad_char_behavior;
1481 --to_size;
1485 if (from_size > 0)
1487 /* Some remaining characters, keep them for the next
1488 * round. */
1489 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1490 conv_restlen = (int)from_size;
1493 /* move the linerest to before the converted characters */
1494 line_start = ptr - linerest;
1495 mch_memmove(line_start, buffer, (size_t)linerest);
1496 size = (long)((char_u *)top - ptr);
1498 # endif
1500 # ifdef WIN3264
1501 if (fio_flags & FIO_CODEPAGE)
1503 char_u *src, *dst;
1504 WCHAR ucs2buf[3];
1505 int ucs2len;
1506 int codepage = FIO_GET_CP(fio_flags);
1507 int bytelen;
1508 int found_bad;
1509 char replstr[2];
1512 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1513 * a codepage, using standard MS-Windows functions. This
1514 * requires two steps:
1515 * 1. convert from 'fileencoding' to ucs-2
1516 * 2. convert from ucs-2 to 'encoding'
1518 * Because there may be illegal bytes AND an incomplete byte
1519 * sequence at the end, we may have to do the conversion one
1520 * character at a time to get it right.
1523 /* Replacement string for WideCharToMultiByte(). */
1524 if (bad_char_behavior > 0)
1525 replstr[0] = bad_char_behavior;
1526 else
1527 replstr[0] = '?';
1528 replstr[1] = NUL;
1531 * Move the bytes to the end of the buffer, so that we have
1532 * room to put the result at the start.
1534 src = ptr + real_size - size;
1535 mch_memmove(src, ptr, size);
1538 * Do the conversion.
1540 dst = ptr;
1541 size = size;
1542 while (size > 0)
1544 found_bad = FALSE;
1546 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1547 if (codepage == CP_UTF8)
1549 /* Handle CP_UTF8 input ourselves to be able to handle
1550 * trailing bytes properly.
1551 * Get one UTF-8 character from src. */
1552 bytelen = (int)utf_ptr2len_len(src, size);
1553 if (bytelen > size)
1555 /* Only got some bytes of a character. Normally
1556 * it's put in "conv_rest", but if it's too long
1557 * deal with it as if they were illegal bytes. */
1558 if (bytelen <= CONV_RESTLEN)
1559 break;
1561 /* weird overlong byte sequence */
1562 bytelen = size;
1563 found_bad = TRUE;
1565 else
1567 int u8c = utf_ptr2char(src);
1569 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1570 found_bad = TRUE;
1571 ucs2buf[0] = u8c;
1572 ucs2len = 1;
1575 else
1576 # endif
1578 /* We don't know how long the byte sequence is, try
1579 * from one to three bytes. */
1580 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1581 ++bytelen)
1583 ucs2len = MultiByteToWideChar(codepage,
1584 MB_ERR_INVALID_CHARS,
1585 (LPCSTR)src, bytelen,
1586 ucs2buf, 3);
1587 if (ucs2len > 0)
1588 break;
1590 if (ucs2len == 0)
1592 /* If we have only one byte then it's probably an
1593 * incomplete byte sequence. Otherwise discard
1594 * one byte as a bad character. */
1595 if (size == 1)
1596 break;
1597 found_bad = TRUE;
1598 bytelen = 1;
1602 if (!found_bad)
1604 int i;
1606 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1607 if (enc_utf8)
1609 /* From UCS-2 to UTF-8. Cannot fail. */
1610 for (i = 0; i < ucs2len; ++i)
1611 dst += utf_char2bytes(ucs2buf[i], dst);
1613 else
1615 BOOL bad = FALSE;
1616 int dstlen;
1618 /* From UCS-2 to "enc_codepage". If the
1619 * conversion uses the default character "?",
1620 * the data doesn't fit in this encoding. */
1621 dstlen = WideCharToMultiByte(enc_codepage, 0,
1622 (LPCWSTR)ucs2buf, ucs2len,
1623 (LPSTR)dst, (int)(src - dst),
1624 replstr, &bad);
1625 if (bad)
1626 found_bad = TRUE;
1627 else
1628 dst += dstlen;
1632 if (found_bad)
1634 /* Deal with bytes we can't convert. */
1635 if (can_retry)
1636 goto rewind_retry;
1637 if (conv_error == 0)
1638 conv_error = readfile_linenr(linecnt, ptr, dst);
1639 if (bad_char_behavior != BAD_DROP)
1641 if (bad_char_behavior == BAD_KEEP)
1643 mch_memmove(dst, src, bytelen);
1644 dst += bytelen;
1646 else
1647 *dst++ = bad_char_behavior;
1651 src += bytelen;
1652 size -= bytelen;
1655 if (size > 0)
1657 /* An incomplete byte sequence remaining. */
1658 mch_memmove(conv_rest, src, size);
1659 conv_restlen = size;
1662 /* The new size is equal to how much "dst" was advanced. */
1663 size = (long)(dst - ptr);
1665 else
1666 # endif
1667 # ifdef MACOS_CONVERT
1668 if (fio_flags & FIO_MACROMAN)
1671 * Conversion from Apple MacRoman char encoding to UTF-8 or
1672 * latin1. This is in os_mac_conv.c.
1674 if (macroman2enc(ptr, &size, real_size) == FAIL)
1675 goto rewind_retry;
1677 else
1678 # endif
1679 if (fio_flags != 0)
1681 int u8c;
1682 char_u *dest;
1683 char_u *tail = NULL;
1686 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1687 * "enc_utf8" not set: Convert Unicode to Latin1.
1688 * Go from end to start through the buffer, because the number
1689 * of bytes may increase.
1690 * "dest" points to after where the UTF-8 bytes go, "p" points
1691 * to after the next character to convert.
1693 dest = ptr + real_size;
1694 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1696 p = ptr + size;
1697 if (fio_flags == FIO_UTF8)
1699 /* Check for a trailing incomplete UTF-8 sequence */
1700 tail = ptr + size - 1;
1701 while (tail > ptr && (*tail & 0xc0) == 0x80)
1702 --tail;
1703 if (tail + utf_byte2len(*tail) <= ptr + size)
1704 tail = NULL;
1705 else
1706 p = tail;
1709 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1711 /* Check for a trailing byte */
1712 p = ptr + (size & ~1);
1713 if (size & 1)
1714 tail = p;
1715 if ((fio_flags & FIO_UTF16) && p > ptr)
1717 /* Check for a trailing leading word */
1718 if (fio_flags & FIO_ENDIAN_L)
1720 u8c = (*--p << 8);
1721 u8c += *--p;
1723 else
1725 u8c = *--p;
1726 u8c += (*--p << 8);
1728 if (u8c >= 0xd800 && u8c <= 0xdbff)
1729 tail = p;
1730 else
1731 p += 2;
1734 else /* FIO_UCS4 */
1736 /* Check for trailing 1, 2 or 3 bytes */
1737 p = ptr + (size & ~3);
1738 if (size & 3)
1739 tail = p;
1742 /* If there is a trailing incomplete sequence move it to
1743 * conv_rest[]. */
1744 if (tail != NULL)
1746 conv_restlen = (int)((ptr + size) - tail);
1747 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1748 size -= conv_restlen;
1752 while (p > ptr)
1754 if (fio_flags & FIO_LATIN1)
1755 u8c = *--p;
1756 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1758 if (fio_flags & FIO_ENDIAN_L)
1760 u8c = (*--p << 8);
1761 u8c += *--p;
1763 else
1765 u8c = *--p;
1766 u8c += (*--p << 8);
1768 if ((fio_flags & FIO_UTF16)
1769 && u8c >= 0xdc00 && u8c <= 0xdfff)
1771 int u16c;
1773 if (p == ptr)
1775 /* Missing leading word. */
1776 if (can_retry)
1777 goto rewind_retry;
1778 if (conv_error == 0)
1779 conv_error = readfile_linenr(linecnt,
1780 ptr, p);
1781 if (bad_char_behavior == BAD_DROP)
1782 continue;
1783 if (bad_char_behavior != BAD_KEEP)
1784 u8c = bad_char_behavior;
1787 /* found second word of double-word, get the first
1788 * word and compute the resulting character */
1789 if (fio_flags & FIO_ENDIAN_L)
1791 u16c = (*--p << 8);
1792 u16c += *--p;
1794 else
1796 u16c = *--p;
1797 u16c += (*--p << 8);
1799 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1800 + (u8c & 0x3ff);
1802 /* Check if the word is indeed a leading word. */
1803 if (u16c < 0xd800 || u16c > 0xdbff)
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 else if (fio_flags & FIO_UCS4)
1819 if (fio_flags & FIO_ENDIAN_L)
1821 u8c = (*--p << 24);
1822 u8c += (*--p << 16);
1823 u8c += (*--p << 8);
1824 u8c += *--p;
1826 else /* big endian */
1828 u8c = *--p;
1829 u8c += (*--p << 8);
1830 u8c += (*--p << 16);
1831 u8c += (*--p << 24);
1834 else /* UTF-8 */
1836 if (*--p < 0x80)
1837 u8c = *p;
1838 else
1840 len = utf_head_off(ptr, p);
1841 p -= len;
1842 u8c = utf_ptr2char(p);
1843 if (len == 0)
1845 /* Not a valid UTF-8 character, retry with
1846 * another fenc when possible, otherwise just
1847 * report the error. */
1848 if (can_retry)
1849 goto rewind_retry;
1850 if (conv_error == 0)
1851 conv_error = readfile_linenr(linecnt,
1852 ptr, p);
1853 if (bad_char_behavior == BAD_DROP)
1854 continue;
1855 if (bad_char_behavior != BAD_KEEP)
1856 u8c = bad_char_behavior;
1860 if (enc_utf8) /* produce UTF-8 */
1862 dest -= utf_char2len(u8c);
1863 (void)utf_char2bytes(u8c, dest);
1865 else /* produce Latin1 */
1867 --dest;
1868 if (u8c >= 0x100)
1870 /* character doesn't fit in latin1, retry with
1871 * another fenc when possible, otherwise just
1872 * report the error. */
1873 if (can_retry)
1874 goto rewind_retry;
1875 if (conv_error == 0)
1876 conv_error = readfile_linenr(linecnt, ptr, p);
1877 if (bad_char_behavior == BAD_DROP)
1878 ++dest;
1879 else if (bad_char_behavior == BAD_KEEP)
1880 *dest = u8c;
1881 else if (eap != NULL && eap->bad_char != 0)
1882 *dest = bad_char_behavior;
1883 else
1884 *dest = 0xBF;
1886 else
1887 *dest = u8c;
1891 /* move the linerest to before the converted characters */
1892 line_start = dest - linerest;
1893 mch_memmove(line_start, buffer, (size_t)linerest);
1894 size = (long)((ptr + real_size) - dest);
1895 ptr = dest;
1897 else if (enc_utf8 && !curbuf->b_p_bin)
1899 int incomplete_tail = FALSE;
1901 /* Reading UTF-8: Check if the bytes are valid UTF-8. */
1902 for (p = ptr; ; ++p)
1904 int todo = (int)((ptr + size) - p);
1905 int l;
1907 if (todo <= 0)
1908 break;
1909 if (*p >= 0x80)
1911 /* A length of 1 means it's an illegal byte. Accept
1912 * an incomplete character at the end though, the next
1913 * read() will get the next bytes, we'll check it
1914 * then. */
1915 l = utf_ptr2len_len(p, todo);
1916 if (l > todo && !incomplete_tail)
1918 /* Avoid retrying with a different encoding when
1919 * a truncated file is more likely, or attempting
1920 * to read the rest of an incomplete sequence when
1921 * we have already done so. */
1922 if (p > ptr || filesize > 0)
1923 incomplete_tail = TRUE;
1924 /* Incomplete byte sequence, move it to conv_rest[]
1925 * and try to read the rest of it, unless we've
1926 * already done so. */
1927 if (p > ptr)
1929 conv_restlen = todo;
1930 mch_memmove(conv_rest, p, conv_restlen);
1931 size -= conv_restlen;
1932 break;
1935 if (l == 1 || l > todo)
1937 /* Illegal byte. If we can try another encoding
1938 * do that, unless at EOF where a truncated
1939 * file is more likely than a conversion error. */
1940 if (can_retry && !incomplete_tail)
1941 break;
1942 # ifdef USE_ICONV
1943 /* When we did a conversion report an error. */
1944 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1945 conv_error = readfile_linenr(linecnt, ptr, p);
1946 # endif
1947 /* Remember the first linenr with an illegal byte */
1948 if (conv_error == 0 && illegal_byte == 0)
1949 illegal_byte = readfile_linenr(linecnt, ptr, p);
1951 /* Drop, keep or replace the bad byte. */
1952 if (bad_char_behavior == BAD_DROP)
1954 mch_memmove(p, p + 1, todo - 1);
1955 --p;
1956 --size;
1958 else if (bad_char_behavior != BAD_KEEP)
1959 *p = bad_char_behavior;
1961 else
1962 p += l - 1;
1965 if (p < ptr + size && !incomplete_tail)
1967 /* Detected a UTF-8 error. */
1968 rewind_retry:
1969 /* Retry reading with another conversion. */
1970 # if defined(FEAT_EVAL) && defined(USE_ICONV)
1971 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
1972 /* iconv() failed, try 'charconvert' */
1973 did_iconv = TRUE;
1974 else
1975 # endif
1976 /* use next item from 'fileencodings' */
1977 advance_fenc = TRUE;
1978 file_rewind = TRUE;
1979 goto retry;
1982 #endif
1984 /* count the number of characters (after conversion!) */
1985 filesize += size;
1988 * when reading the first part of a file: guess EOL type
1990 if (fileformat == EOL_UNKNOWN)
1992 /* First try finding a NL, for Dos and Unix */
1993 if (try_dos || try_unix)
1995 for (p = ptr; p < ptr + size; ++p)
1997 if (*p == NL)
1999 if (!try_unix
2000 || (try_dos && p > ptr && p[-1] == CAR))
2001 fileformat = EOL_DOS;
2002 else
2003 fileformat = EOL_UNIX;
2004 break;
2008 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
2009 if (fileformat == EOL_UNIX && try_mac)
2011 /* Need to reset the counters when retrying fenc. */
2012 try_mac = 1;
2013 try_unix = 1;
2014 for (; p >= ptr && *p != CAR; p--)
2016 if (p >= ptr)
2018 for (p = ptr; p < ptr + size; ++p)
2020 if (*p == NL)
2021 try_unix++;
2022 else if (*p == CAR)
2023 try_mac++;
2025 if (try_mac > try_unix)
2026 fileformat = EOL_MAC;
2031 /* No NL found: may use Mac format */
2032 if (fileformat == EOL_UNKNOWN && try_mac)
2033 fileformat = EOL_MAC;
2035 /* Still nothing found? Use first format in 'ffs' */
2036 if (fileformat == EOL_UNKNOWN)
2037 fileformat = default_fileformat();
2039 /* if editing a new file: may set p_tx and p_ff */
2040 if (set_options)
2041 set_fileformat(fileformat, OPT_LOCAL);
2046 * This loop is executed once for every character read.
2047 * Keep it fast!
2049 if (fileformat == EOL_MAC)
2051 --ptr;
2052 while (++ptr, --size >= 0)
2054 /* catch most common case first */
2055 if ((c = *ptr) != NUL && c != CAR && c != NL)
2056 continue;
2057 if (c == NUL)
2058 *ptr = NL; /* NULs are replaced by newlines! */
2059 else if (c == NL)
2060 *ptr = CAR; /* NLs are replaced by CRs! */
2061 else
2063 if (skip_count == 0)
2065 *ptr = NUL; /* end of line */
2066 len = (colnr_T) (ptr - line_start + 1);
2067 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2069 error = TRUE;
2070 break;
2072 ++lnum;
2073 if (--read_count == 0)
2075 error = TRUE; /* break loop */
2076 line_start = ptr; /* nothing left to write */
2077 break;
2080 else
2081 --skip_count;
2082 line_start = ptr + 1;
2086 else
2088 --ptr;
2089 while (++ptr, --size >= 0)
2091 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2092 continue;
2093 if (c == NUL)
2094 *ptr = NL; /* NULs are replaced by newlines! */
2095 else
2097 if (skip_count == 0)
2099 *ptr = NUL; /* end of line */
2100 len = (colnr_T)(ptr - line_start + 1);
2101 if (fileformat == EOL_DOS)
2103 if (ptr[-1] == CAR) /* remove CR */
2105 ptr[-1] = NUL;
2106 --len;
2109 * Reading in Dos format, but no CR-LF found!
2110 * When 'fileformats' includes "unix", delete all
2111 * the lines read so far and start all over again.
2112 * Otherwise give an error message later.
2114 else if (ff_error != EOL_DOS)
2116 if ( try_unix
2117 && !read_stdin
2118 && (read_buffer
2119 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2121 fileformat = EOL_UNIX;
2122 if (set_options)
2123 set_fileformat(EOL_UNIX, OPT_LOCAL);
2124 file_rewind = TRUE;
2125 keep_fileformat = TRUE;
2126 goto retry;
2128 ff_error = EOL_DOS;
2131 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2133 error = TRUE;
2134 break;
2136 ++lnum;
2137 if (--read_count == 0)
2139 error = TRUE; /* break loop */
2140 line_start = ptr; /* nothing left to write */
2141 break;
2144 else
2145 --skip_count;
2146 line_start = ptr + 1;
2150 linerest = (long)(ptr - line_start);
2151 ui_breakcheck();
2154 failed:
2155 /* not an error, max. number of lines reached */
2156 if (error && read_count == 0)
2157 error = FALSE;
2160 * If we get EOF in the middle of a line, note the fact and
2161 * complete the line ourselves.
2162 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2164 if (!error
2165 && !got_int
2166 && linerest != 0
2167 && !(!curbuf->b_p_bin
2168 && fileformat == EOL_DOS
2169 && *line_start == Ctrl_Z
2170 && ptr == line_start + 1))
2172 /* remember for when writing */
2173 if (set_options)
2174 curbuf->b_p_eol = FALSE;
2175 *ptr = NUL;
2176 if (ml_append(lnum, line_start,
2177 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2178 error = TRUE;
2179 else
2180 read_no_eol_lnum = ++lnum;
2183 if (set_options)
2184 save_file_ff(curbuf); /* remember the current file format */
2186 #ifdef FEAT_CRYPT
2187 if (cryptkey != curbuf->b_p_key)
2188 vim_free(cryptkey);
2189 #endif
2191 #ifdef FEAT_MBYTE
2192 /* If editing a new file: set 'fenc' for the current buffer.
2193 * Also for ":read ++edit file". */
2194 if (set_options)
2195 set_string_option_direct((char_u *)"fenc", -1, fenc,
2196 OPT_FREE|OPT_LOCAL, 0);
2197 if (fenc_alloced)
2198 vim_free(fenc);
2199 # ifdef USE_ICONV
2200 if (iconv_fd != (iconv_t)-1)
2202 iconv_close(iconv_fd);
2203 iconv_fd = (iconv_t)-1;
2205 # endif
2206 #endif
2208 if (!read_buffer && !read_stdin)
2209 close(fd); /* errors are ignored */
2210 vim_free(buffer);
2212 #ifdef HAVE_DUP
2213 if (read_stdin)
2215 /* Use stderr for stdin, makes shell commands work. */
2216 close(0);
2217 ignored = dup(2);
2219 #endif
2221 #ifdef FEAT_MBYTE
2222 if (tmpname != NULL)
2224 mch_remove(tmpname); /* delete converted file */
2225 vim_free(tmpname);
2227 #endif
2228 --no_wait_return; /* may wait for return now */
2231 * In recovery mode everything but autocommands is skipped.
2233 if (!recoverymode)
2235 /* need to delete the last line, which comes from the empty buffer */
2236 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2238 #ifdef FEAT_NETBEANS_INTG
2239 netbeansFireChanges = 0;
2240 #endif
2241 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2242 #ifdef FEAT_NETBEANS_INTG
2243 netbeansFireChanges = 1;
2244 #endif
2245 --linecnt;
2247 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2248 if (filesize == 0)
2249 linecnt = 0;
2250 if (newfile || read_buffer)
2252 redraw_curbuf_later(NOT_VALID);
2253 #ifdef FEAT_DIFF
2254 /* After reading the text into the buffer the diff info needs to
2255 * be updated. */
2256 diff_invalidate(curbuf);
2257 #endif
2258 #ifdef FEAT_FOLDING
2259 /* All folds in the window are invalid now. Mark them for update
2260 * before triggering autocommands. */
2261 foldUpdateAll(curwin);
2262 #endif
2264 else if (linecnt) /* appended at least one line */
2265 appended_lines_mark(from, linecnt);
2267 #ifndef ALWAYS_USE_GUI
2269 * If we were reading from the same terminal as where messages go,
2270 * the screen will have been messed up.
2271 * Switch on raw mode now and clear the screen.
2273 if (read_stdin)
2275 settmode(TMODE_RAW); /* set to raw mode */
2276 starttermcap();
2277 screenclear();
2279 #endif
2281 if (got_int)
2283 if (!(flags & READ_DUMMY))
2285 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2286 if (newfile)
2287 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2289 msg_scroll = msg_save;
2290 #ifdef FEAT_VIMINFO
2291 check_marks_read();
2292 #endif
2293 return OK; /* an interrupt isn't really an error */
2296 if (!filtering && !(flags & READ_DUMMY))
2298 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2299 c = FALSE;
2301 #ifdef UNIX
2302 # ifdef S_ISFIFO
2303 if (S_ISFIFO(perm)) /* fifo or socket */
2305 STRCAT(IObuff, _("[fifo/socket]"));
2306 c = TRUE;
2308 # else
2309 # ifdef S_IFIFO
2310 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2312 STRCAT(IObuff, _("[fifo]"));
2313 c = TRUE;
2315 # endif
2316 # ifdef S_IFSOCK
2317 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2319 STRCAT(IObuff, _("[socket]"));
2320 c = TRUE;
2322 # endif
2323 # endif
2324 # ifdef OPEN_CHR_FILES
2325 if (S_ISCHR(perm)) /* or character special */
2327 STRCAT(IObuff, _("[character special]"));
2328 c = TRUE;
2330 # endif
2331 #endif
2332 if (curbuf->b_p_ro)
2334 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2335 c = TRUE;
2337 if (read_no_eol_lnum)
2339 msg_add_eol();
2340 c = TRUE;
2342 if (ff_error == EOL_DOS)
2344 STRCAT(IObuff, _("[CR missing]"));
2345 c = TRUE;
2347 if (split)
2349 STRCAT(IObuff, _("[long lines split]"));
2350 c = TRUE;
2352 #ifdef FEAT_MBYTE
2353 if (notconverted)
2355 STRCAT(IObuff, _("[NOT converted]"));
2356 c = TRUE;
2358 else if (converted)
2360 STRCAT(IObuff, _("[converted]"));
2361 c = TRUE;
2363 #endif
2364 #ifdef FEAT_CRYPT
2365 if (cryptkey != NULL)
2367 STRCAT(IObuff, _("[crypted]"));
2368 c = TRUE;
2370 #endif
2371 #ifdef FEAT_MBYTE
2372 if (conv_error != 0)
2374 sprintf((char *)IObuff + STRLEN(IObuff),
2375 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2376 c = TRUE;
2378 else if (illegal_byte > 0)
2380 sprintf((char *)IObuff + STRLEN(IObuff),
2381 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2382 c = TRUE;
2384 else
2385 #endif
2386 if (error)
2388 STRCAT(IObuff, _("[READ ERRORS]"));
2389 c = TRUE;
2391 if (msg_add_fileformat(fileformat))
2392 c = TRUE;
2393 #ifdef FEAT_CRYPT
2394 if (cryptkey != NULL)
2395 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2396 else
2397 #endif
2398 msg_add_lines(c, (long)linecnt, filesize);
2400 vim_free(keep_msg);
2401 keep_msg = NULL;
2402 msg_scrolled_ign = TRUE;
2403 #ifdef ALWAYS_USE_GUI
2404 /* Don't show the message when reading stdin, it would end up in a
2405 * message box (which might be shown when exiting!) */
2406 if (read_stdin || read_buffer)
2407 p = msg_may_trunc(FALSE, IObuff);
2408 else
2409 #endif
2410 p = msg_trunc_attr(IObuff, FALSE, 0);
2411 if (read_stdin || read_buffer || restart_edit != 0
2412 || (msg_scrolled != 0 && !need_wait_return))
2413 /* Need to repeat the message after redrawing when:
2414 * - When reading from stdin (the screen will be cleared next).
2415 * - When restart_edit is set (otherwise there will be a delay
2416 * before redrawing).
2417 * - When the screen was scrolled but there is no wait-return
2418 * prompt. */
2419 set_keep_msg(p, 0);
2420 msg_scrolled_ign = FALSE;
2423 /* with errors writing the file requires ":w!" */
2424 if (newfile && (error
2425 #ifdef FEAT_MBYTE
2426 || conv_error != 0
2427 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2428 #endif
2430 curbuf->b_p_ro = TRUE;
2432 u_clearline(); /* cannot use "U" command after adding lines */
2435 * In Ex mode: cursor at last new line.
2436 * Otherwise: cursor at first new line.
2438 if (exmode_active)
2439 curwin->w_cursor.lnum = from + linecnt;
2440 else
2441 curwin->w_cursor.lnum = from + 1;
2442 check_cursor_lnum();
2443 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2446 * Set '[ and '] marks to the newly read lines.
2448 curbuf->b_op_start.lnum = from + 1;
2449 curbuf->b_op_start.col = 0;
2450 curbuf->b_op_end.lnum = from + linecnt;
2451 curbuf->b_op_end.col = 0;
2453 #ifdef WIN32
2455 * Work around a weird problem: When a file has two links (only
2456 * possible on NTFS) and we write through one link, then stat() it
2457 * through the other link, the timestamp information may be wrong.
2458 * It's correct again after reading the file, thus reset the timestamp
2459 * here.
2461 if (newfile && !read_stdin && !read_buffer
2462 && mch_stat((char *)fname, &st) >= 0)
2464 buf_store_time(curbuf, &st, fname);
2465 curbuf->b_mtime_read = curbuf->b_mtime;
2467 #endif
2469 msg_scroll = msg_save;
2471 #ifdef FEAT_VIMINFO
2473 * Get the marks before executing autocommands, so they can be used there.
2475 check_marks_read();
2476 #endif
2479 * Trick: We remember if the last line of the read didn't have
2480 * an eol for when writing it again. This is required for
2481 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2483 write_no_eol_lnum = read_no_eol_lnum;
2485 #ifdef FEAT_AUTOCMD
2486 if (!read_stdin && !read_buffer)
2488 int m = msg_scroll;
2489 int n = msg_scrolled;
2491 /* Save the fileformat now, otherwise the buffer will be considered
2492 * modified if the format/encoding was automatically detected. */
2493 if (set_options)
2494 save_file_ff(curbuf);
2497 * The output from the autocommands should not overwrite anything and
2498 * should not be overwritten: Set msg_scroll, restore its value if no
2499 * output was done.
2501 msg_scroll = TRUE;
2502 if (filtering)
2503 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2504 FALSE, curbuf, eap);
2505 else if (newfile)
2506 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2507 FALSE, curbuf, eap);
2508 else
2509 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2510 FALSE, NULL, eap);
2511 if (msg_scrolled == n)
2512 msg_scroll = m;
2513 #ifdef FEAT_EVAL
2514 if (aborting()) /* autocmds may abort script processing */
2515 return FAIL;
2516 #endif
2518 #endif
2520 if (recoverymode && error)
2521 return FAIL;
2522 return OK;
2525 #ifdef OPEN_CHR_FILES
2527 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2528 * which is the name of files used for process substitution output by
2529 * some shells on some operating systems, e.g., bash on SunOS.
2530 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2532 static int
2533 is_dev_fd_file(fname)
2534 char_u *fname;
2536 return (STRNCMP(fname, "/dev/fd/", 8) == 0
2537 && VIM_ISDIGIT(fname[8])
2538 && *skipdigits(fname + 9) == NUL
2539 && (fname[9] != NUL
2540 || (fname[8] != '0' && fname[8] != '1' && fname[8] != '2')));
2542 #endif
2544 #ifdef FEAT_MBYTE
2547 * From the current line count and characters read after that, estimate the
2548 * line number where we are now.
2549 * Used for error messages that include a line number.
2551 static linenr_T
2552 readfile_linenr(linecnt, p, endp)
2553 linenr_T linecnt; /* line count before reading more bytes */
2554 char_u *p; /* start of more bytes read */
2555 char_u *endp; /* end of more bytes read */
2557 char_u *s;
2558 linenr_T lnum;
2560 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2561 for (s = p; s < endp; ++s)
2562 if (*s == '\n')
2563 ++lnum;
2564 return lnum;
2566 #endif
2569 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2570 * equal to the buffer "buf". Used for calling readfile().
2571 * Returns OK or FAIL.
2574 prep_exarg(eap, buf)
2575 exarg_T *eap;
2576 buf_T *buf;
2578 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2579 #ifdef FEAT_MBYTE
2580 + STRLEN(buf->b_p_fenc)
2581 #endif
2582 + 15));
2583 if (eap->cmd == NULL)
2584 return FAIL;
2586 #ifdef FEAT_MBYTE
2587 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2588 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2589 eap->bad_char = buf->b_bad_char;
2590 #else
2591 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2592 #endif
2593 eap->force_ff = 7;
2595 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2596 eap->read_edit = FALSE;
2597 eap->forceit = FALSE;
2598 return OK;
2601 #ifdef FEAT_MBYTE
2603 * Find next fileencoding to use from 'fileencodings'.
2604 * "pp" points to fenc_next. It's advanced to the next item.
2605 * When there are no more items, an empty string is returned and *pp is set to
2606 * NULL.
2607 * When *pp is not set to NULL, the result is in allocated memory.
2609 static char_u *
2610 next_fenc(pp)
2611 char_u **pp;
2613 char_u *p;
2614 char_u *r;
2616 if (**pp == NUL)
2618 *pp = NULL;
2619 return (char_u *)"";
2621 p = vim_strchr(*pp, ',');
2622 if (p == NULL)
2624 r = enc_canonize(*pp);
2625 *pp += STRLEN(*pp);
2627 else
2629 r = vim_strnsave(*pp, (int)(p - *pp));
2630 *pp = p + 1;
2631 if (r != NULL)
2633 p = enc_canonize(r);
2634 vim_free(r);
2635 r = p;
2638 if (r == NULL) /* out of memory */
2640 r = (char_u *)"";
2641 *pp = NULL;
2643 return r;
2646 # ifdef FEAT_EVAL
2648 * Convert a file with the 'charconvert' expression.
2649 * This closes the file which is to be read, converts it and opens the
2650 * resulting file for reading.
2651 * Returns name of the resulting converted file (the caller should delete it
2652 * after reading it).
2653 * Returns NULL if the conversion failed ("*fdp" is not set) .
2655 static char_u *
2656 readfile_charconvert(fname, fenc, fdp)
2657 char_u *fname; /* name of input file */
2658 char_u *fenc; /* converted from */
2659 int *fdp; /* in/out: file descriptor of file */
2661 char_u *tmpname;
2662 char_u *errmsg = NULL;
2664 tmpname = vim_tempname('r');
2665 if (tmpname == NULL)
2666 errmsg = (char_u *)_("Can't find temp file for conversion");
2667 else
2669 close(*fdp); /* close the input file, ignore errors */
2670 *fdp = -1;
2671 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2672 fname, tmpname) == FAIL)
2673 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2674 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2675 O_RDONLY | O_EXTRA, 0)) < 0)
2676 errmsg = (char_u *)_("can't read output of 'charconvert'");
2679 if (errmsg != NULL)
2681 /* Don't use emsg(), it breaks mappings, the retry with
2682 * another type of conversion might still work. */
2683 MSG(errmsg);
2684 if (tmpname != NULL)
2686 mch_remove(tmpname); /* delete converted file */
2687 vim_free(tmpname);
2688 tmpname = NULL;
2692 /* If the input file is closed, open it (caller should check for error). */
2693 if (*fdp < 0)
2694 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2696 return tmpname;
2698 # endif
2700 #endif
2702 #ifdef FEAT_VIMINFO
2704 * Read marks for the current buffer from the viminfo file, when we support
2705 * buffer marks and the buffer has a name.
2707 static void
2708 check_marks_read()
2710 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2711 && curbuf->b_ffname != NULL)
2712 read_viminfo(NULL, VIF_WANT_MARKS);
2714 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2715 * the ' parameter after opening a buffer. */
2716 curbuf->b_marks_read = TRUE;
2718 #endif
2720 #ifdef FEAT_CRYPT
2722 * Check for magic number used for encryption.
2723 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2724 * *filesizep are updated.
2725 * Return the (new) encryption key, NULL for no encryption.
2727 static char_u *
2728 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2729 char_u *cryptkey; /* previous encryption key or NULL */
2730 char_u *ptr; /* pointer to read bytes */
2731 long *sizep; /* length of read bytes */
2732 long *filesizep; /* nr of bytes used from file */
2733 int newfile; /* editing a new buffer */
2735 if (*sizep >= CRYPT_MAGIC_LEN
2736 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2738 if (cryptkey == NULL)
2740 if (*curbuf->b_p_key)
2741 cryptkey = curbuf->b_p_key;
2742 else
2744 /* When newfile is TRUE, store the typed key
2745 * in the 'key' option and don't free it. */
2746 cryptkey = get_crypt_key(newfile, FALSE);
2747 /* check if empty key entered */
2748 if (cryptkey != NULL && *cryptkey == NUL)
2750 if (cryptkey != curbuf->b_p_key)
2751 vim_free(cryptkey);
2752 cryptkey = NULL;
2757 if (cryptkey != NULL)
2759 crypt_init_keys(cryptkey);
2761 /* Remove magic number from the text */
2762 *filesizep += CRYPT_MAGIC_LEN;
2763 *sizep -= CRYPT_MAGIC_LEN;
2764 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2767 /* When starting to edit a new file which does not have
2768 * encryption, clear the 'key' option, except when
2769 * starting up (called with -x argument) */
2770 else if (newfile && *curbuf->b_p_key && !starting)
2771 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2773 return cryptkey;
2775 #endif
2777 #ifdef UNIX
2778 static void
2779 set_file_time(fname, atime, mtime)
2780 char_u *fname;
2781 time_t atime; /* access time */
2782 time_t mtime; /* modification time */
2784 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2785 struct utimbuf buf;
2787 buf.actime = atime;
2788 buf.modtime = mtime;
2789 (void)utime((char *)fname, &buf);
2790 # else
2791 # if defined(HAVE_UTIMES)
2792 struct timeval tvp[2];
2794 tvp[0].tv_sec = atime;
2795 tvp[0].tv_usec = 0;
2796 tvp[1].tv_sec = mtime;
2797 tvp[1].tv_usec = 0;
2798 # ifdef NeXT
2799 (void)utimes((char *)fname, tvp);
2800 # else
2801 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2802 # endif
2803 # endif
2804 # endif
2806 #endif /* UNIX */
2808 #if defined(VMS) && !defined(MIN)
2809 /* Older DECC compiler for VAX doesn't define MIN() */
2810 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2811 #endif
2814 * Return TRUE if a file appears to be read-only from the file permissions.
2817 check_file_readonly(fname, perm)
2818 char_u *fname; /* full path to file */
2819 int perm; /* known permissions on file */
2821 #ifndef USE_MCH_ACCESS
2822 int fd = 0;
2823 #endif
2825 return (
2826 #ifdef USE_MCH_ACCESS
2827 # ifdef UNIX
2828 (perm & 0222) == 0 ||
2829 # endif
2830 mch_access((char *)fname, W_OK)
2831 #else
2832 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
2833 ? TRUE : (close(fd), FALSE)
2834 #endif
2840 * buf_write() - write to file "fname" lines "start" through "end"
2842 * We do our own buffering here because fwrite() is so slow.
2844 * If "forceit" is true, we don't care for errors when attempting backups.
2845 * In case of an error everything possible is done to restore the original
2846 * file. But when "forceit" is TRUE, we risk losing it.
2848 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2849 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2851 * This function must NOT use NameBuff (because it's called by autowrite()).
2853 * return FAIL for failure, OK otherwise
2856 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2857 reset_changed, filtering)
2858 buf_T *buf;
2859 char_u *fname;
2860 char_u *sfname;
2861 linenr_T start, end;
2862 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2863 NULL! */
2864 int append; /* append to the file */
2865 int forceit;
2866 int reset_changed;
2867 int filtering;
2869 int fd;
2870 char_u *backup = NULL;
2871 int backup_copy = FALSE; /* copy the original file? */
2872 int dobackup;
2873 char_u *ffname;
2874 char_u *wfname = NULL; /* name of file to write to */
2875 char_u *s;
2876 char_u *ptr;
2877 char_u c;
2878 int len;
2879 linenr_T lnum;
2880 long nchars;
2881 char_u *errmsg = NULL;
2882 char_u *errnum = NULL;
2883 char_u *buffer;
2884 char_u smallbuf[SMBUFSIZE];
2885 char_u *backup_ext;
2886 int bufsize;
2887 long perm; /* file permissions */
2888 int retval = OK;
2889 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2890 int msg_save = msg_scroll;
2891 int overwriting; /* TRUE if writing over original */
2892 int no_eol = FALSE; /* no end-of-line written */
2893 int device = FALSE; /* writing to a device */
2894 struct stat st_old;
2895 int prev_got_int = got_int;
2896 int file_readonly = FALSE; /* overwritten file is read-only */
2897 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2898 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2899 int made_writable = FALSE; /* 'w' bit has been set */
2900 #endif
2901 /* writing everything */
2902 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2903 #ifdef FEAT_AUTOCMD
2904 linenr_T old_line_count = buf->b_ml.ml_line_count;
2905 #endif
2906 int attr;
2907 int fileformat;
2908 int write_bin;
2909 struct bw_info write_info; /* info for buf_write_bytes() */
2910 #ifdef FEAT_MBYTE
2911 int converted = FALSE;
2912 int notconverted = FALSE;
2913 char_u *fenc; /* effective 'fileencoding' */
2914 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2915 #endif
2916 #ifdef HAS_BW_FLAGS
2917 int wb_flags = 0;
2918 #endif
2919 #ifdef HAVE_ACL
2920 vim_acl_T acl = NULL; /* ACL copied from original file to
2921 backup or new file */
2922 #endif
2924 if (fname == NULL || *fname == NUL) /* safety check */
2925 return FAIL;
2928 * Disallow writing from .exrc and .vimrc in current directory for
2929 * security reasons.
2931 if (check_secure())
2932 return FAIL;
2934 /* Avoid a crash for a long name. */
2935 if (STRLEN(fname) >= MAXPATHL)
2937 EMSG(_(e_longname));
2938 return FAIL;
2941 #ifdef FEAT_MBYTE
2942 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2943 write_info.bw_conv_buf = NULL;
2944 write_info.bw_conv_error = FALSE;
2945 write_info.bw_restlen = 0;
2946 # ifdef USE_ICONV
2947 write_info.bw_iconv_fd = (iconv_t)-1;
2948 # endif
2949 #endif
2951 /* After writing a file changedtick changes but we don't want to display
2952 * the line. */
2953 ex_no_reprint = TRUE;
2956 * If there is no file name yet, use the one for the written file.
2957 * BF_NOTEDITED is set to reflect this (in case the write fails).
2958 * Don't do this when the write is for a filter command.
2959 * Don't do this when appending.
2960 * Only do this when 'cpoptions' contains the 'F' flag.
2962 if (buf->b_ffname == NULL
2963 && reset_changed
2964 && whole
2965 && buf == curbuf
2966 #ifdef FEAT_QUICKFIX
2967 && !bt_nofile(buf)
2968 #endif
2969 && !filtering
2970 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
2971 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
2973 if (set_rw_fname(fname, sfname) == FAIL)
2974 return FAIL;
2975 buf = curbuf; /* just in case autocmds made "buf" invalid */
2978 if (sfname == NULL)
2979 sfname = fname;
2981 * For Unix: Use the short file name whenever possible.
2982 * Avoids problems with networks and when directory names are changed.
2983 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
2984 * another directory, which we don't detect
2986 ffname = fname; /* remember full fname */
2987 #ifdef UNIX
2988 fname = sfname;
2989 #endif
2991 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
2992 overwriting = TRUE;
2993 else
2994 overwriting = FALSE;
2996 if (exiting)
2997 settmode(TMODE_COOK); /* when exiting allow typahead now */
2999 ++no_wait_return; /* don't wait for return yet */
3002 * Set '[ and '] marks to the lines to be written.
3004 buf->b_op_start.lnum = start;
3005 buf->b_op_start.col = 0;
3006 buf->b_op_end.lnum = end;
3007 buf->b_op_end.col = 0;
3009 #ifdef FEAT_AUTOCMD
3011 aco_save_T aco;
3012 int buf_ffname = FALSE;
3013 int buf_sfname = FALSE;
3014 int buf_fname_f = FALSE;
3015 int buf_fname_s = FALSE;
3016 int did_cmd = FALSE;
3017 int nofile_err = FALSE;
3018 int empty_memline = (buf->b_ml.ml_mfp == NULL);
3021 * Apply PRE aucocommands.
3022 * Set curbuf to the buffer to be written.
3023 * Careful: The autocommands may call buf_write() recursively!
3025 if (ffname == buf->b_ffname)
3026 buf_ffname = TRUE;
3027 if (sfname == buf->b_sfname)
3028 buf_sfname = TRUE;
3029 if (fname == buf->b_ffname)
3030 buf_fname_f = TRUE;
3031 if (fname == buf->b_sfname)
3032 buf_fname_s = TRUE;
3034 /* set curwin/curbuf to buf and save a few things */
3035 aucmd_prepbuf(&aco, buf);
3037 if (append)
3039 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
3040 sfname, sfname, FALSE, curbuf, eap)))
3042 #ifdef FEAT_QUICKFIX
3043 if (overwriting && bt_nofile(curbuf))
3044 nofile_err = TRUE;
3045 else
3046 #endif
3047 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
3048 sfname, sfname, FALSE, curbuf, eap);
3051 else if (filtering)
3053 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
3054 NULL, sfname, FALSE, curbuf, eap);
3056 else if (reset_changed && whole)
3058 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
3059 sfname, sfname, FALSE, curbuf, eap)))
3061 #ifdef FEAT_QUICKFIX
3062 if (overwriting && bt_nofile(curbuf))
3063 nofile_err = TRUE;
3064 else
3065 #endif
3066 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
3067 sfname, sfname, FALSE, curbuf, eap);
3070 else
3072 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
3073 sfname, sfname, FALSE, curbuf, eap)))
3075 #ifdef FEAT_QUICKFIX
3076 if (overwriting && bt_nofile(curbuf))
3077 nofile_err = TRUE;
3078 else
3079 #endif
3080 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
3081 sfname, sfname, FALSE, curbuf, eap);
3085 /* restore curwin/curbuf and a few other things */
3086 aucmd_restbuf(&aco);
3089 * In three situations we return here and don't write the file:
3090 * 1. the autocommands deleted or unloaded the buffer.
3091 * 2. The autocommands abort script processing.
3092 * 3. If one of the "Cmd" autocommands was executed.
3094 if (!buf_valid(buf))
3095 buf = NULL;
3096 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
3097 || did_cmd || nofile_err
3098 #ifdef FEAT_EVAL
3099 || aborting()
3100 #endif
3103 --no_wait_return;
3104 msg_scroll = msg_save;
3105 if (nofile_err)
3106 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3108 if (nofile_err
3109 #ifdef FEAT_EVAL
3110 || aborting()
3111 #endif
3113 /* An aborting error, interrupt or exception in the
3114 * autocommands. */
3115 return FAIL;
3116 if (did_cmd)
3118 if (buf == NULL)
3119 /* The buffer was deleted. We assume it was written
3120 * (can't retry anyway). */
3121 return OK;
3122 if (overwriting)
3124 /* Assume the buffer was written, update the timestamp. */
3125 ml_timestamp(buf);
3126 if (append)
3127 buf->b_flags &= ~BF_NEW;
3128 else
3129 buf->b_flags &= ~BF_WRITE_MASK;
3131 if (reset_changed && buf->b_changed && !append
3132 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3133 /* Buffer still changed, the autocommands didn't work
3134 * properly. */
3135 return FAIL;
3136 return OK;
3138 #ifdef FEAT_EVAL
3139 if (!aborting())
3140 #endif
3141 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3142 return FAIL;
3146 * The autocommands may have changed the number of lines in the file.
3147 * When writing the whole file, adjust the end.
3148 * When writing part of the file, assume that the autocommands only
3149 * changed the number of lines that are to be written (tricky!).
3151 if (buf->b_ml.ml_line_count != old_line_count)
3153 if (whole) /* write all */
3154 end = buf->b_ml.ml_line_count;
3155 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3156 end += buf->b_ml.ml_line_count - old_line_count;
3157 else /* less lines */
3159 end -= old_line_count - buf->b_ml.ml_line_count;
3160 if (end < start)
3162 --no_wait_return;
3163 msg_scroll = msg_save;
3164 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3165 return FAIL;
3171 * The autocommands may have changed the name of the buffer, which may
3172 * be kept in fname, ffname and sfname.
3174 if (buf_ffname)
3175 ffname = buf->b_ffname;
3176 if (buf_sfname)
3177 sfname = buf->b_sfname;
3178 if (buf_fname_f)
3179 fname = buf->b_ffname;
3180 if (buf_fname_s)
3181 fname = buf->b_sfname;
3183 #endif
3185 #ifdef FEAT_NETBEANS_INTG
3186 if (usingNetbeans && isNetbeansBuffer(buf))
3188 if (whole)
3191 * b_changed can be 0 after an undo, but we still need to write
3192 * the buffer to NetBeans.
3194 if (buf->b_changed || isNetbeansModified(buf))
3196 --no_wait_return; /* may wait for return now */
3197 msg_scroll = msg_save;
3198 netbeans_save_buffer(buf); /* no error checking... */
3199 return retval;
3201 else
3203 errnum = (char_u *)"E656: ";
3204 errmsg = (char_u *)_("NetBeans disallows writes of unmodified buffers");
3205 buffer = NULL;
3206 goto fail;
3209 else
3211 errnum = (char_u *)"E657: ";
3212 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3213 buffer = NULL;
3214 goto fail;
3217 #endif
3219 if (shortmess(SHM_OVER) && !exiting)
3220 msg_scroll = FALSE; /* overwrite previous file message */
3221 else
3222 msg_scroll = TRUE; /* don't overwrite previous file message */
3223 if (!filtering)
3224 filemess(buf,
3225 #ifndef UNIX
3226 sfname,
3227 #else
3228 fname,
3229 #endif
3230 (char_u *)"", 0); /* show that we are busy */
3231 msg_scroll = FALSE; /* always overwrite the file message now */
3233 buffer = alloc(BUFSIZE);
3234 if (buffer == NULL) /* can't allocate big buffer, use small
3235 * one (to be able to write when out of
3236 * memory) */
3238 buffer = smallbuf;
3239 bufsize = SMBUFSIZE;
3241 else
3242 bufsize = BUFSIZE;
3245 * Get information about original file (if there is one).
3247 #if defined(UNIX) && !defined(ARCHIE)
3248 st_old.st_dev = 0;
3249 st_old.st_ino = 0;
3250 perm = -1;
3251 if (mch_stat((char *)fname, &st_old) < 0)
3252 newfile = TRUE;
3253 else
3255 perm = st_old.st_mode;
3256 if (!S_ISREG(st_old.st_mode)) /* not a file */
3258 if (S_ISDIR(st_old.st_mode))
3260 errnum = (char_u *)"E502: ";
3261 errmsg = (char_u *)_("is a directory");
3262 goto fail;
3264 if (mch_nodetype(fname) != NODE_WRITABLE)
3266 errnum = (char_u *)"E503: ";
3267 errmsg = (char_u *)_("is not a file or writable device");
3268 goto fail;
3270 /* It's a device of some kind (or a fifo) which we can write to
3271 * but for which we can't make a backup. */
3272 device = TRUE;
3273 newfile = TRUE;
3274 perm = -1;
3277 #else /* !UNIX */
3279 * Check for a writable device name.
3281 c = mch_nodetype(fname);
3282 if (c == NODE_OTHER)
3284 errnum = (char_u *)"E503: ";
3285 errmsg = (char_u *)_("is not a file or writable device");
3286 goto fail;
3288 if (c == NODE_WRITABLE)
3290 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3291 /* MS-Windows allows opening a device, but we will probably get stuck
3292 * trying to write to it. */
3293 if (!p_odev)
3295 errnum = (char_u *)"E796: ";
3296 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3297 goto fail;
3299 # endif
3300 device = TRUE;
3301 newfile = TRUE;
3302 perm = -1;
3304 else
3306 perm = mch_getperm(fname);
3307 if (perm < 0)
3308 newfile = TRUE;
3309 else if (mch_isdir(fname))
3311 errnum = (char_u *)"E502: ";
3312 errmsg = (char_u *)_("is a directory");
3313 goto fail;
3315 if (overwriting)
3316 (void)mch_stat((char *)fname, &st_old);
3318 #endif /* !UNIX */
3320 if (!device && !newfile)
3323 * Check if the file is really writable (when renaming the file to
3324 * make a backup we won't discover it later).
3326 file_readonly = check_file_readonly(fname, (int)perm);
3328 if (!forceit && file_readonly)
3330 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3332 errnum = (char_u *)"E504: ";
3333 errmsg = (char_u *)_(err_readonly);
3335 else
3337 errnum = (char_u *)"E505: ";
3338 errmsg = (char_u *)_("is read-only (add ! to override)");
3340 goto fail;
3344 * Check if the timestamp hasn't changed since reading the file.
3346 if (overwriting)
3348 retval = check_mtime(buf, &st_old);
3349 if (retval == FAIL)
3350 goto fail;
3354 #ifdef HAVE_ACL
3356 * For systems that support ACL: get the ACL from the original file.
3358 if (!newfile)
3359 acl = mch_get_acl(fname);
3360 #endif
3363 * If 'backupskip' is not empty, don't make a backup for some files.
3365 dobackup = (p_wb || p_bk || *p_pm != NUL);
3366 #ifdef FEAT_WILDIGN
3367 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3368 dobackup = FALSE;
3369 #endif
3372 * Save the value of got_int and reset it. We don't want a previous
3373 * interruption cancel writing, only hitting CTRL-C while writing should
3374 * abort it.
3376 prev_got_int = got_int;
3377 got_int = FALSE;
3379 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3380 buf->b_saving = TRUE;
3383 * If we are not appending or filtering, the file exists, and the
3384 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3385 * When 'patchmode' is set also make a backup when appending.
3387 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3388 * off. This helps when editing large files on almost-full disks.
3390 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3392 #if defined(UNIX) || defined(WIN32)
3393 struct stat st;
3394 #endif
3396 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3397 backup_copy = TRUE;
3398 #if defined(UNIX) || defined(WIN32)
3399 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3401 int i;
3403 # ifdef UNIX
3405 * Don't rename the file when:
3406 * - it's a hard link
3407 * - it's a symbolic link
3408 * - we don't have write permission in the directory
3409 * - we can't set the owner/group of the new file
3411 if (st_old.st_nlink > 1
3412 || mch_lstat((char *)fname, &st) < 0
3413 || st.st_dev != st_old.st_dev
3414 || st.st_ino != st_old.st_ino
3415 # ifndef HAVE_FCHOWN
3416 || st.st_uid != st_old.st_uid
3417 || st.st_gid != st_old.st_gid
3418 # endif
3420 backup_copy = TRUE;
3421 else
3422 # else
3423 # ifdef WIN32
3424 /* On NTFS file systems hard links are possible. */
3425 if (mch_is_linked(fname))
3426 backup_copy = TRUE;
3427 else
3428 # endif
3429 # endif
3432 * Check if we can create a file and set the owner/group to
3433 * the ones from the original file.
3434 * First find a file name that doesn't exist yet (use some
3435 * arbitrary numbers).
3437 STRCPY(IObuff, fname);
3438 for (i = 4913; ; i += 123)
3440 sprintf((char *)gettail(IObuff), "%d", i);
3441 if (mch_lstat((char *)IObuff, &st) < 0)
3442 break;
3444 fd = mch_open((char *)IObuff,
3445 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3446 if (fd < 0) /* can't write in directory */
3447 backup_copy = TRUE;
3448 else
3450 # ifdef UNIX
3451 # ifdef HAVE_FCHOWN
3452 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
3453 # endif
3454 if (mch_stat((char *)IObuff, &st) < 0
3455 || st.st_uid != st_old.st_uid
3456 || st.st_gid != st_old.st_gid
3457 || st.st_mode != perm)
3458 backup_copy = TRUE;
3459 # endif
3460 /* Close the file before removing it, on MS-Windows we
3461 * can't delete an open file. */
3462 close(fd);
3463 mch_remove(IObuff);
3468 # ifdef UNIX
3470 * Break symlinks and/or hardlinks if we've been asked to.
3472 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3474 int lstat_res;
3476 lstat_res = mch_lstat((char *)fname, &st);
3478 /* Symlinks. */
3479 if ((bkc_flags & BKC_BREAKSYMLINK)
3480 && lstat_res == 0
3481 && st.st_ino != st_old.st_ino)
3482 backup_copy = FALSE;
3484 /* Hardlinks. */
3485 if ((bkc_flags & BKC_BREAKHARDLINK)
3486 && st_old.st_nlink > 1
3487 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3488 backup_copy = FALSE;
3490 #endif
3492 #endif
3494 /* make sure we have a valid backup extension to use */
3495 if (*p_bex == NUL)
3497 #ifdef RISCOS
3498 backup_ext = (char_u *)"/bak";
3499 #else
3500 backup_ext = (char_u *)".bak";
3501 #endif
3503 else
3504 backup_ext = p_bex;
3506 if (backup_copy
3507 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3509 int bfd;
3510 char_u *copybuf, *wp;
3511 int some_error = FALSE;
3512 struct stat st_new;
3513 char_u *dirp;
3514 char_u *rootname;
3515 #if defined(UNIX) && !defined(SHORT_FNAME)
3516 int did_set_shortname;
3517 #endif
3519 copybuf = alloc(BUFSIZE + 1);
3520 if (copybuf == NULL)
3522 some_error = TRUE; /* out of memory */
3523 goto nobackup;
3527 * Try to make the backup in each directory in the 'bdir' option.
3529 * Unix semantics has it, that we may have a writable file,
3530 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3531 * - the directory is not writable,
3532 * - the file may be a symbolic link,
3533 * - the file may belong to another user/group, etc.
3535 * For these reasons, the existing writable file must be truncated
3536 * and reused. Creation of a backup COPY will be attempted.
3538 dirp = p_bdir;
3539 while (*dirp)
3541 #ifdef UNIX
3542 st_new.st_ino = 0;
3543 st_new.st_dev = 0;
3544 st_new.st_gid = 0;
3545 #endif
3548 * Isolate one directory name, using an entry in 'bdir'.
3550 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3551 rootname = get_file_in_dir(fname, copybuf);
3552 if (rootname == NULL)
3554 some_error = TRUE; /* out of memory */
3555 goto nobackup;
3558 #if defined(UNIX) && !defined(SHORT_FNAME)
3559 did_set_shortname = FALSE;
3560 #endif
3563 * May try twice if 'shortname' not set.
3565 for (;;)
3568 * Make backup file name.
3570 backup = buf_modname(
3571 #ifdef SHORT_FNAME
3572 TRUE,
3573 #else
3574 (buf->b_p_sn || buf->b_shortname),
3575 #endif
3576 rootname, backup_ext, FALSE);
3577 if (backup == NULL)
3579 vim_free(rootname);
3580 some_error = TRUE; /* out of memory */
3581 goto nobackup;
3585 * Check if backup file already exists.
3587 if (mch_stat((char *)backup, &st_new) >= 0)
3589 #ifdef UNIX
3591 * Check if backup file is same as original file.
3592 * May happen when modname() gave the same file back.
3593 * E.g. silly link, or file name-length reached.
3594 * If we don't check here, we either ruin the file
3595 * when copying or erase it after writing. jw.
3597 if (st_new.st_dev == st_old.st_dev
3598 && st_new.st_ino == st_old.st_ino)
3600 vim_free(backup);
3601 backup = NULL; /* no backup file to delete */
3602 # ifndef SHORT_FNAME
3604 * may try again with 'shortname' set
3606 if (!(buf->b_shortname || buf->b_p_sn))
3608 buf->b_shortname = TRUE;
3609 did_set_shortname = TRUE;
3610 continue;
3612 /* setting shortname didn't help */
3613 if (did_set_shortname)
3614 buf->b_shortname = FALSE;
3615 # endif
3616 break;
3618 #endif
3621 * If we are not going to keep the backup file, don't
3622 * delete an existing one, try to use another name.
3623 * Change one character, just before the extension.
3625 if (!p_bk)
3627 wp = backup + STRLEN(backup) - 1
3628 - STRLEN(backup_ext);
3629 if (wp < backup) /* empty file name ??? */
3630 wp = backup;
3631 *wp = 'z';
3632 while (*wp > 'a'
3633 && mch_stat((char *)backup, &st_new) >= 0)
3634 --*wp;
3635 /* They all exist??? Must be something wrong. */
3636 if (*wp == 'a')
3638 vim_free(backup);
3639 backup = NULL;
3643 break;
3645 vim_free(rootname);
3648 * Try to create the backup file
3650 if (backup != NULL)
3652 /* remove old backup, if present */
3653 mch_remove(backup);
3654 /* Open with O_EXCL to avoid the file being created while
3655 * we were sleeping (symlink hacker attack?) */
3656 bfd = mch_open((char *)backup,
3657 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3658 perm & 0777);
3659 if (bfd < 0)
3661 vim_free(backup);
3662 backup = NULL;
3664 else
3666 /* set file protection same as original file, but
3667 * strip s-bit */
3668 (void)mch_setperm(backup, perm & 0777);
3670 #ifdef UNIX
3672 * Try to set the group of the backup same as the
3673 * original file. If this fails, set the protection
3674 * bits for the group same as the protection bits for
3675 * others.
3677 if (st_new.st_gid != st_old.st_gid
3678 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3679 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3680 # endif
3682 mch_setperm(backup,
3683 (perm & 0707) | ((perm & 07) << 3));
3684 # ifdef HAVE_SELINUX
3685 mch_copy_sec(fname, backup);
3686 # endif
3687 #endif
3690 * copy the file.
3692 write_info.bw_fd = bfd;
3693 write_info.bw_buf = copybuf;
3694 #ifdef HAS_BW_FLAGS
3695 write_info.bw_flags = FIO_NOCONVERT;
3696 #endif
3697 while ((write_info.bw_len = vim_read(fd, copybuf,
3698 BUFSIZE)) > 0)
3700 if (buf_write_bytes(&write_info) == FAIL)
3702 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3703 break;
3705 ui_breakcheck();
3706 if (got_int)
3708 errmsg = (char_u *)_(e_interr);
3709 break;
3713 if (close(bfd) < 0 && errmsg == NULL)
3714 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3715 if (write_info.bw_len < 0)
3716 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3717 #ifdef UNIX
3718 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3719 #endif
3720 #ifdef HAVE_ACL
3721 mch_set_acl(backup, acl);
3722 #endif
3723 #ifdef HAVE_SELINUX
3724 mch_copy_sec(fname, backup);
3725 #endif
3726 break;
3730 nobackup:
3731 close(fd); /* ignore errors for closing read file */
3732 vim_free(copybuf);
3734 if (backup == NULL && errmsg == NULL)
3735 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3736 /* ignore errors when forceit is TRUE */
3737 if ((some_error || errmsg != NULL) && !forceit)
3739 retval = FAIL;
3740 goto fail;
3742 errmsg = NULL;
3744 else
3746 char_u *dirp;
3747 char_u *p;
3748 char_u *rootname;
3751 * Make a backup by renaming the original file.
3754 * If 'cpoptions' includes the "W" flag, we don't want to
3755 * overwrite a read-only file. But rename may be possible
3756 * anyway, thus we need an extra check here.
3758 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3760 errnum = (char_u *)"E504: ";
3761 errmsg = (char_u *)_(err_readonly);
3762 goto fail;
3767 * Form the backup file name - change path/fo.o.h to
3768 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3769 * that works is used.
3771 dirp = p_bdir;
3772 while (*dirp)
3775 * Isolate one directory name and make the backup file name.
3777 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3778 rootname = get_file_in_dir(fname, IObuff);
3779 if (rootname == NULL)
3780 backup = NULL;
3781 else
3783 backup = buf_modname(
3784 #ifdef SHORT_FNAME
3785 TRUE,
3786 #else
3787 (buf->b_p_sn || buf->b_shortname),
3788 #endif
3789 rootname, backup_ext, FALSE);
3790 vim_free(rootname);
3793 if (backup != NULL)
3796 * If we are not going to keep the backup file, don't
3797 * delete an existing one, try to use another name.
3798 * Change one character, just before the extension.
3800 if (!p_bk && mch_getperm(backup) >= 0)
3802 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3803 if (p < backup) /* empty file name ??? */
3804 p = backup;
3805 *p = 'z';
3806 while (*p > 'a' && mch_getperm(backup) >= 0)
3807 --*p;
3808 /* They all exist??? Must be something wrong! */
3809 if (*p == 'a')
3811 vim_free(backup);
3812 backup = NULL;
3816 if (backup != NULL)
3819 * Delete any existing backup and move the current version
3820 * to the backup. For safety, we don't remove the backup
3821 * until the write has finished successfully. And if the
3822 * 'backup' option is set, leave it around.
3825 * If the renaming of the original file to the backup file
3826 * works, quit here.
3828 if (vim_rename(fname, backup) == 0)
3829 break;
3831 vim_free(backup); /* don't do the rename below */
3832 backup = NULL;
3835 if (backup == NULL && !forceit)
3837 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3838 goto fail;
3843 #if defined(UNIX) && !defined(ARCHIE)
3844 /* When using ":w!" and the file was read-only: make it writable */
3845 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3846 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3848 perm |= 0200;
3849 (void)mch_setperm(fname, perm);
3850 made_writable = TRUE;
3852 #endif
3854 /* When using ":w!" and writing to the current file, 'readonly' makes no
3855 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3856 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3858 buf->b_p_ro = FALSE;
3859 #ifdef FEAT_TITLE
3860 need_maketitle = TRUE; /* set window title later */
3861 #endif
3862 #ifdef FEAT_WINDOWS
3863 status_redraw_all(); /* redraw status lines later */
3864 #endif
3867 if (end > buf->b_ml.ml_line_count)
3868 end = buf->b_ml.ml_line_count;
3869 if (buf->b_ml.ml_flags & ML_EMPTY)
3870 start = end + 1;
3873 * If the original file is being overwritten, there is a small chance that
3874 * we crash in the middle of writing. Therefore the file is preserved now.
3875 * This makes all block numbers positive so that recovery does not need
3876 * the original file.
3877 * Don't do this if there is a backup file and we are exiting.
3879 if (reset_changed && !newfile && overwriting
3880 && !(exiting && backup != NULL))
3882 ml_preserve(buf, FALSE);
3883 if (got_int)
3885 errmsg = (char_u *)_(e_interr);
3886 goto restore_backup;
3890 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3892 * Before risking to lose the original file verify if there's
3893 * a resource fork to preserve, and if cannot be done warn
3894 * the users. This happens when overwriting without backups.
3896 if (backup == NULL && overwriting && !append)
3897 if (mch_has_resource_fork(fname))
3899 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3900 goto restore_backup;
3902 #endif
3904 #ifdef VMS
3905 vms_remove_version(fname); /* remove version */
3906 #endif
3907 /* Default: write the file directly. May write to a temp file for
3908 * multi-byte conversion. */
3909 wfname = fname;
3911 #ifdef FEAT_MBYTE
3912 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3913 if (eap != NULL && eap->force_enc != 0)
3915 fenc = eap->cmd + eap->force_enc;
3916 fenc = enc_canonize(fenc);
3917 fenc_tofree = fenc;
3919 else
3920 fenc = buf->b_p_fenc;
3923 * The file needs to be converted when 'fileencoding' is set and
3924 * 'fileencoding' differs from 'encoding'.
3926 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
3929 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3930 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3931 * Prepare the flags for it and allocate bw_conv_buf when needed.
3933 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3935 wb_flags = get_fio_flags(fenc);
3936 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3938 /* Need to allocate a buffer to translate into. */
3939 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3940 write_info.bw_conv_buflen = bufsize * 2;
3941 else /* FIO_UCS4 */
3942 write_info.bw_conv_buflen = bufsize * 4;
3943 write_info.bw_conv_buf
3944 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3945 if (write_info.bw_conv_buf == NULL)
3946 end = 0;
3950 # ifdef WIN3264
3951 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
3953 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3954 write_info.bw_conv_buflen = bufsize * 4;
3955 write_info.bw_conv_buf
3956 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3957 if (write_info.bw_conv_buf == NULL)
3958 end = 0;
3960 # endif
3962 # ifdef MACOS_X
3963 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
3965 write_info.bw_conv_buflen = bufsize * 3;
3966 write_info.bw_conv_buf
3967 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3968 if (write_info.bw_conv_buf == NULL)
3969 end = 0;
3971 # endif
3973 # if defined(FEAT_EVAL) || defined(USE_ICONV)
3974 if (converted && wb_flags == 0)
3976 # ifdef USE_ICONV
3978 * Use iconv() conversion when conversion is needed and it's not done
3979 * internally.
3981 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
3982 enc_utf8 ? (char_u *)"utf-8" : p_enc);
3983 if (write_info.bw_iconv_fd != (iconv_t)-1)
3985 /* We're going to use iconv(), allocate a buffer to convert in. */
3986 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
3987 write_info.bw_conv_buf
3988 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3989 if (write_info.bw_conv_buf == NULL)
3990 end = 0;
3991 write_info.bw_first = TRUE;
3993 # ifdef FEAT_EVAL
3994 else
3995 # endif
3996 # endif
3998 # ifdef FEAT_EVAL
4000 * When the file needs to be converted with 'charconvert' after
4001 * writing, write to a temp file instead and let the conversion
4002 * overwrite the original file.
4004 if (*p_ccv != NUL)
4006 wfname = vim_tempname('w');
4007 if (wfname == NULL) /* Can't write without a tempfile! */
4009 errmsg = (char_u *)_("E214: Can't find temp file for writing");
4010 goto restore_backup;
4013 # endif
4015 # endif
4016 if (converted && wb_flags == 0
4017 # ifdef USE_ICONV
4018 && write_info.bw_iconv_fd == (iconv_t)-1
4019 # endif
4020 # ifdef FEAT_EVAL
4021 && wfname == fname
4022 # endif
4025 if (!forceit)
4027 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
4028 goto restore_backup;
4030 notconverted = TRUE;
4032 #endif
4035 * Open the file "wfname" for writing.
4036 * We may try to open the file twice: If we can't write to the
4037 * file and forceit is TRUE we delete the existing file and try to create
4038 * a new one. If this still fails we may have lost the original file!
4039 * (this may happen when the user reached his quotum for number of files).
4040 * Appending will fail if the file does not exist and forceit is FALSE.
4042 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
4043 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
4044 : (O_CREAT | O_TRUNC))
4045 , perm < 0 ? 0666 : (perm & 0777))) < 0)
4048 * A forced write will try to create a new file if the old one is
4049 * still readonly. This may also happen when the directory is
4050 * read-only. In that case the mch_remove() will fail.
4052 if (errmsg == NULL)
4054 #ifdef UNIX
4055 struct stat st;
4057 /* Don't delete the file when it's a hard or symbolic link. */
4058 if ((!newfile && st_old.st_nlink > 1)
4059 || (mch_lstat((char *)fname, &st) == 0
4060 && (st.st_dev != st_old.st_dev
4061 || st.st_ino != st_old.st_ino)))
4062 errmsg = (char_u *)_("E166: Can't open linked file for writing");
4063 else
4064 #endif
4066 errmsg = (char_u *)_("E212: Can't open file for writing");
4067 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
4068 && perm >= 0)
4070 #ifdef UNIX
4071 /* we write to the file, thus it should be marked
4072 writable after all */
4073 if (!(perm & 0200))
4074 made_writable = TRUE;
4075 perm |= 0200;
4076 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
4077 perm &= 0777;
4078 #endif
4079 if (!append) /* don't remove when appending */
4080 mch_remove(wfname);
4081 continue;
4086 restore_backup:
4088 struct stat st;
4091 * If we failed to open the file, we don't need a backup. Throw it
4092 * away. If we moved or removed the original file try to put the
4093 * backup in its place.
4095 if (backup != NULL && wfname == fname)
4097 if (backup_copy)
4100 * There is a small chance that we removed the original,
4101 * try to move the copy in its place.
4102 * This may not work if the vim_rename() fails.
4103 * In that case we leave the copy around.
4105 /* If file does not exist, put the copy in its place */
4106 if (mch_stat((char *)fname, &st) < 0)
4107 vim_rename(backup, fname);
4108 /* if original file does exist throw away the copy */
4109 if (mch_stat((char *)fname, &st) >= 0)
4110 mch_remove(backup);
4112 else
4114 /* try to put the original file back */
4115 vim_rename(backup, fname);
4119 /* if original file no longer exists give an extra warning */
4120 if (!newfile && mch_stat((char *)fname, &st) < 0)
4121 end = 0;
4124 #ifdef FEAT_MBYTE
4125 if (wfname != fname)
4126 vim_free(wfname);
4127 #endif
4128 goto fail;
4130 errmsg = NULL;
4132 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4133 /* TODO: Is it need for MACOS_X? (Dany) */
4135 * On macintosh copy the original files attributes (i.e. the backup)
4136 * This is done in order to preserve the resource fork and the
4137 * Finder attribute (label, comments, custom icons, file creator)
4139 if (backup != NULL && overwriting && !append)
4141 if (backup_copy)
4142 (void)mch_copy_file_attribute(wfname, backup);
4143 else
4144 (void)mch_copy_file_attribute(backup, wfname);
4147 if (!overwriting && !append)
4149 if (buf->b_ffname != NULL)
4150 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4151 /* Should copy resource fork */
4153 #endif
4155 write_info.bw_fd = fd;
4157 #ifdef FEAT_CRYPT
4158 if (*buf->b_p_key && !filtering)
4160 crypt_init_keys(buf->b_p_key);
4161 /* Write magic number, so that Vim knows that this file is encrypted
4162 * when reading it again. This also undergoes utf-8 to ucs-2/4
4163 * conversion when needed. */
4164 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4165 write_info.bw_len = CRYPT_MAGIC_LEN;
4166 write_info.bw_flags = FIO_NOCONVERT;
4167 if (buf_write_bytes(&write_info) == FAIL)
4168 end = 0;
4169 wb_flags |= FIO_ENCRYPTED;
4171 #endif
4173 write_info.bw_buf = buffer;
4174 nchars = 0;
4176 /* use "++bin", "++nobin" or 'binary' */
4177 if (eap != NULL && eap->force_bin != 0)
4178 write_bin = (eap->force_bin == FORCE_BIN);
4179 else
4180 write_bin = buf->b_p_bin;
4182 #ifdef FEAT_MBYTE
4184 * The BOM is written just after the encryption magic number.
4185 * Skip it when appending and the file already existed, the BOM only makes
4186 * sense at the start of the file.
4188 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4190 write_info.bw_len = make_bom(buffer, fenc);
4191 if (write_info.bw_len > 0)
4193 /* don't convert, do encryption */
4194 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4195 if (buf_write_bytes(&write_info) == FAIL)
4196 end = 0;
4197 else
4198 nchars += write_info.bw_len;
4201 #endif
4203 write_info.bw_len = bufsize;
4204 #ifdef HAS_BW_FLAGS
4205 write_info.bw_flags = wb_flags;
4206 #endif
4207 fileformat = get_fileformat_force(buf, eap);
4208 s = buffer;
4209 len = 0;
4210 for (lnum = start; lnum <= end; ++lnum)
4213 * The next while loop is done once for each character written.
4214 * Keep it fast!
4216 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4217 while ((c = *++ptr) != NUL)
4219 if (c == NL)
4220 *s = NUL; /* replace newlines with NULs */
4221 else if (c == CAR && fileformat == EOL_MAC)
4222 *s = NL; /* Mac: replace CRs with NLs */
4223 else
4224 *s = c;
4225 ++s;
4226 if (++len != bufsize)
4227 continue;
4228 if (buf_write_bytes(&write_info) == FAIL)
4230 end = 0; /* write error: break loop */
4231 break;
4233 nchars += bufsize;
4234 s = buffer;
4235 len = 0;
4237 /* write failed or last line has no EOL: stop here */
4238 if (end == 0
4239 || (lnum == end
4240 && write_bin
4241 && (lnum == write_no_eol_lnum
4242 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4244 ++lnum; /* written the line, count it */
4245 no_eol = TRUE;
4246 break;
4248 if (fileformat == EOL_UNIX)
4249 *s++ = NL;
4250 else
4252 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4253 if (fileformat == EOL_DOS) /* write CR-NL */
4255 if (++len == bufsize)
4257 if (buf_write_bytes(&write_info) == FAIL)
4259 end = 0; /* write error: break loop */
4260 break;
4262 nchars += bufsize;
4263 s = buffer;
4264 len = 0;
4266 *s++ = NL;
4269 if (++len == bufsize && end)
4271 if (buf_write_bytes(&write_info) == FAIL)
4273 end = 0; /* write error: break loop */
4274 break;
4276 nchars += bufsize;
4277 s = buffer;
4278 len = 0;
4280 ui_breakcheck();
4281 if (got_int)
4283 end = 0; /* Interrupted, break loop */
4284 break;
4287 #ifdef VMS
4289 * On VMS there is a problem: newlines get added when writing blocks
4290 * at a time. Fix it by writing a line at a time.
4291 * This is much slower!
4292 * Explanation: VAX/DECC RTL insists that records in some RMS
4293 * structures end with a newline (carriage return) character, and if
4294 * they don't it adds one.
4295 * With other RMS structures it works perfect without this fix.
4297 if (buf->b_fab_rfm == FAB$C_VFC
4298 || ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0))
4300 int b2write;
4302 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4303 ? MIN(4096, bufsize)
4304 : MIN(buf->b_fab_mrs, bufsize));
4306 b2write = len;
4307 while (b2write > 0)
4309 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4310 if (buf_write_bytes(&write_info) == FAIL)
4312 end = 0;
4313 break;
4315 b2write -= MIN(b2write, buf->b_fab_mrs);
4317 write_info.bw_len = bufsize;
4318 nchars += len;
4319 s = buffer;
4320 len = 0;
4322 #endif
4324 if (len > 0 && end > 0)
4326 write_info.bw_len = len;
4327 if (buf_write_bytes(&write_info) == FAIL)
4328 end = 0; /* write error */
4329 nchars += len;
4332 #if defined(UNIX) && defined(HAVE_FSYNC)
4333 /* On many journalling file systems there is a bug that causes both the
4334 * original and the backup file to be lost when halting the system right
4335 * after writing the file. That's because only the meta-data is
4336 * journalled. Syncing the file slows down the system, but assures it has
4337 * been written to disk and we don't lose it.
4338 * For a device do try the fsync() but don't complain if it does not work
4339 * (could be a pipe).
4340 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4341 if (p_fs && fsync(fd) != 0 && !device)
4343 errmsg = (char_u *)_("E667: Fsync failed");
4344 end = 0;
4346 #endif
4348 #ifdef HAVE_SELINUX
4349 /* Probably need to set the security context. */
4350 if (!backup_copy)
4351 mch_copy_sec(backup, wfname);
4352 #endif
4354 #ifdef UNIX
4355 /* When creating a new file, set its owner/group to that of the original
4356 * file. Get the new device and inode number. */
4357 if (backup != NULL && !backup_copy)
4359 # ifdef HAVE_FCHOWN
4360 struct stat st;
4362 /* don't change the owner when it's already OK, some systems remove
4363 * permission or ACL stuff */
4364 if (mch_stat((char *)wfname, &st) < 0
4365 || st.st_uid != st_old.st_uid
4366 || st.st_gid != st_old.st_gid)
4368 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
4369 if (perm >= 0) /* set permission again, may have changed */
4370 (void)mch_setperm(wfname, perm);
4372 # endif
4373 buf_setino(buf);
4375 else if (buf->b_dev < 0)
4376 /* Set the inode when creating a new file. */
4377 buf_setino(buf);
4378 #endif
4380 if (close(fd) != 0)
4382 errmsg = (char_u *)_("E512: Close failed");
4383 end = 0;
4386 #ifdef UNIX
4387 if (made_writable)
4388 perm &= ~0200; /* reset 'w' bit for security reasons */
4389 #endif
4390 if (perm >= 0) /* set perm. of new file same as old file */
4391 (void)mch_setperm(wfname, perm);
4392 #ifdef RISCOS
4393 if (!append && !filtering)
4394 /* Set the filetype after writing the file. */
4395 mch_set_filetype(wfname, buf->b_p_oft);
4396 #endif
4397 #ifdef HAVE_ACL
4398 /* Probably need to set the ACL before changing the user (can't set the
4399 * ACL on a file the user doesn't own). */
4400 if (!backup_copy)
4401 mch_set_acl(wfname, acl);
4402 #endif
4405 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4406 if (wfname != fname)
4409 * The file was written to a temp file, now it needs to be converted
4410 * with 'charconvert' to (overwrite) the output file.
4412 if (end != 0)
4414 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4415 wfname, fname) == FAIL)
4417 write_info.bw_conv_error = TRUE;
4418 end = 0;
4421 mch_remove(wfname);
4422 vim_free(wfname);
4424 #endif
4426 if (end == 0)
4428 if (errmsg == NULL)
4430 #ifdef FEAT_MBYTE
4431 if (write_info.bw_conv_error)
4432 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4433 else
4434 #endif
4435 if (got_int)
4436 errmsg = (char_u *)_(e_interr);
4437 else
4438 errmsg = (char_u *)_("E514: write error (file system full?)");
4442 * If we have a backup file, try to put it in place of the new file,
4443 * because the new file is probably corrupt. This avoids losing the
4444 * original file when trying to make a backup when writing the file a
4445 * second time.
4446 * When "backup_copy" is set we need to copy the backup over the new
4447 * file. Otherwise rename the backup file.
4448 * If this is OK, don't give the extra warning message.
4450 if (backup != NULL)
4452 if (backup_copy)
4454 /* This may take a while, if we were interrupted let the user
4455 * know we got the message. */
4456 if (got_int)
4458 MSG(_(e_interr));
4459 out_flush();
4461 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4463 if ((write_info.bw_fd = mch_open((char *)fname,
4464 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4465 perm & 0777)) >= 0)
4467 /* copy the file. */
4468 write_info.bw_buf = smallbuf;
4469 #ifdef HAS_BW_FLAGS
4470 write_info.bw_flags = FIO_NOCONVERT;
4471 #endif
4472 while ((write_info.bw_len = vim_read(fd, smallbuf,
4473 SMBUFSIZE)) > 0)
4474 if (buf_write_bytes(&write_info) == FAIL)
4475 break;
4477 if (close(write_info.bw_fd) >= 0
4478 && write_info.bw_len == 0)
4479 end = 1; /* success */
4481 close(fd); /* ignore errors for closing read file */
4484 else
4486 if (vim_rename(backup, fname) == 0)
4487 end = 1;
4490 goto fail;
4493 lnum -= start; /* compute number of written lines */
4494 --no_wait_return; /* may wait for return now */
4496 #if !(defined(UNIX) || defined(VMS))
4497 fname = sfname; /* use shortname now, for the messages */
4498 #endif
4499 if (!filtering)
4501 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4502 c = FALSE;
4503 #ifdef FEAT_MBYTE
4504 if (write_info.bw_conv_error)
4506 STRCAT(IObuff, _(" CONVERSION ERROR"));
4507 c = TRUE;
4509 else if (notconverted)
4511 STRCAT(IObuff, _("[NOT converted]"));
4512 c = TRUE;
4514 else if (converted)
4516 STRCAT(IObuff, _("[converted]"));
4517 c = TRUE;
4519 #endif
4520 if (device)
4522 STRCAT(IObuff, _("[Device]"));
4523 c = TRUE;
4525 else if (newfile)
4527 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4528 c = TRUE;
4530 if (no_eol)
4532 msg_add_eol();
4533 c = TRUE;
4535 /* may add [unix/dos/mac] */
4536 if (msg_add_fileformat(fileformat))
4537 c = TRUE;
4538 #ifdef FEAT_CRYPT
4539 if (wb_flags & FIO_ENCRYPTED)
4541 STRCAT(IObuff, _("[crypted]"));
4542 c = TRUE;
4544 #endif
4545 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4546 if (!shortmess(SHM_WRITE))
4548 if (append)
4549 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4550 else
4551 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4554 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4557 /* When written everything correctly: reset 'modified'. Unless not
4558 * writing to the original file and '+' is not in 'cpoptions'. */
4559 if (reset_changed && whole && !append
4560 #ifdef FEAT_MBYTE
4561 && !write_info.bw_conv_error
4562 #endif
4563 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4566 unchanged(buf, TRUE);
4567 u_unchanged(buf);
4571 * If written to the current file, update the timestamp of the swap file
4572 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4574 if (overwriting)
4576 ml_timestamp(buf);
4577 if (append)
4578 buf->b_flags &= ~BF_NEW;
4579 else
4580 buf->b_flags &= ~BF_WRITE_MASK;
4584 * If we kept a backup until now, and we are in patch mode, then we make
4585 * the backup file our 'original' file.
4587 if (*p_pm && dobackup)
4589 char *org = (char *)buf_modname(
4590 #ifdef SHORT_FNAME
4591 TRUE,
4592 #else
4593 (buf->b_p_sn || buf->b_shortname),
4594 #endif
4595 fname, p_pm, FALSE);
4597 if (backup != NULL)
4599 struct stat st;
4602 * If the original file does not exist yet
4603 * the current backup file becomes the original file
4605 if (org == NULL)
4606 EMSG(_("E205: Patchmode: can't save original file"));
4607 else if (mch_stat(org, &st) < 0)
4609 vim_rename(backup, (char_u *)org);
4610 vim_free(backup); /* don't delete the file */
4611 backup = NULL;
4612 #ifdef UNIX
4613 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4614 #endif
4618 * If there is no backup file, remember that a (new) file was
4619 * created.
4621 else
4623 int empty_fd;
4625 if (org == NULL
4626 || (empty_fd = mch_open(org,
4627 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4628 perm < 0 ? 0666 : (perm & 0777))) < 0)
4629 EMSG(_("E206: patchmode: can't touch empty original file"));
4630 else
4631 close(empty_fd);
4633 if (org != NULL)
4635 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4636 vim_free(org);
4641 * Remove the backup unless 'backup' option is set
4643 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4644 EMSG(_("E207: Can't delete backup file"));
4646 #ifdef FEAT_SUN_WORKSHOP
4647 if (usingSunWorkShop)
4648 workshop_file_saved((char *) ffname);
4649 #endif
4651 goto nofail;
4654 * Finish up. We get here either after failure or success.
4656 fail:
4657 --no_wait_return; /* may wait for return now */
4658 nofail:
4660 /* Done saving, we accept changed buffer warnings again */
4661 buf->b_saving = FALSE;
4663 vim_free(backup);
4664 if (buffer != smallbuf)
4665 vim_free(buffer);
4666 #ifdef FEAT_MBYTE
4667 vim_free(fenc_tofree);
4668 vim_free(write_info.bw_conv_buf);
4669 # ifdef USE_ICONV
4670 if (write_info.bw_iconv_fd != (iconv_t)-1)
4672 iconv_close(write_info.bw_iconv_fd);
4673 write_info.bw_iconv_fd = (iconv_t)-1;
4675 # endif
4676 #endif
4677 #ifdef HAVE_ACL
4678 mch_free_acl(acl);
4679 #endif
4681 if (errmsg != NULL)
4683 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4685 attr = hl_attr(HLF_E); /* set highlight for error messages */
4686 msg_add_fname(buf,
4687 #ifndef UNIX
4688 sfname
4689 #else
4690 fname
4691 #endif
4692 ); /* put file name in IObuff with quotes */
4693 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4694 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4695 /* If the error message has the form "is ...", put the error number in
4696 * front of the file name. */
4697 if (errnum != NULL)
4699 STRMOVE(IObuff + numlen, IObuff);
4700 mch_memmove(IObuff, errnum, (size_t)numlen);
4702 STRCAT(IObuff, errmsg);
4703 emsg(IObuff);
4705 retval = FAIL;
4706 if (end == 0)
4708 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4709 attr | MSG_HIST);
4710 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4711 attr | MSG_HIST);
4713 /* Update the timestamp to avoid an "overwrite changed file"
4714 * prompt when writing again. */
4715 if (mch_stat((char *)fname, &st_old) >= 0)
4717 buf_store_time(buf, &st_old, fname);
4718 buf->b_mtime_read = buf->b_mtime;
4722 msg_scroll = msg_save;
4724 #ifdef FEAT_AUTOCMD
4725 #ifdef FEAT_EVAL
4726 if (!should_abort(retval))
4727 #else
4728 if (!got_int)
4729 #endif
4731 aco_save_T aco;
4733 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4736 * Apply POST autocommands.
4737 * Careful: The autocommands may call buf_write() recursively!
4739 aucmd_prepbuf(&aco, buf);
4741 if (append)
4742 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4743 FALSE, curbuf, eap);
4744 else if (filtering)
4745 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4746 FALSE, curbuf, eap);
4747 else if (reset_changed && whole)
4748 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4749 FALSE, curbuf, eap);
4750 else
4751 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4752 FALSE, curbuf, eap);
4754 /* restore curwin/curbuf and a few other things */
4755 aucmd_restbuf(&aco);
4757 #ifdef FEAT_EVAL
4758 if (aborting()) /* autocmds may abort script processing */
4759 retval = FALSE;
4760 #endif
4762 #endif
4764 got_int |= prev_got_int;
4766 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4767 /* Update machine specific information. */
4768 mch_post_buffer_write(buf);
4769 #endif
4770 #ifdef FEAT_ODB_EDITOR
4771 odb_post_buffer_write(buf);
4772 #endif
4774 return retval;
4778 * Set the name of the current buffer. Use when the buffer doesn't have a
4779 * name and a ":r" or ":w" command with a file name is used.
4781 static int
4782 set_rw_fname(fname, sfname)
4783 char_u *fname;
4784 char_u *sfname;
4786 #ifdef FEAT_AUTOCMD
4787 /* It's like the unnamed buffer is deleted.... */
4788 if (curbuf->b_p_bl)
4789 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4790 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4791 # ifdef FEAT_EVAL
4792 if (aborting()) /* autocmds may abort script processing */
4793 return FAIL;
4794 # endif
4795 #endif
4797 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4798 curbuf->b_flags |= BF_NOTEDITED;
4800 #ifdef FEAT_AUTOCMD
4801 /* ....and a new named one is created */
4802 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4803 if (curbuf->b_p_bl)
4804 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4805 # ifdef FEAT_EVAL
4806 if (aborting()) /* autocmds may abort script processing */
4807 return FAIL;
4808 # endif
4810 /* Do filetype detection now if 'filetype' is empty. */
4811 if (*curbuf->b_p_ft == NUL)
4813 if (au_has_group((char_u *)"filetypedetect"))
4814 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4815 do_modelines(0);
4817 #endif
4819 return OK;
4823 * Put file name into IObuff with quotes.
4825 void
4826 msg_add_fname(buf, fname)
4827 buf_T *buf;
4828 char_u *fname;
4830 if (fname == NULL)
4831 fname = (char_u *)"-stdin-";
4832 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4833 IObuff[0] = '"';
4834 STRCAT(IObuff, "\" ");
4838 * Append message for text mode to IObuff.
4839 * Return TRUE if something appended.
4841 static int
4842 msg_add_fileformat(eol_type)
4843 int eol_type;
4845 #ifndef USE_CRNL
4846 if (eol_type == EOL_DOS)
4848 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4849 return TRUE;
4851 #endif
4852 #ifndef USE_CR
4853 if (eol_type == EOL_MAC)
4855 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4856 return TRUE;
4858 #endif
4859 #if defined(USE_CRNL) || defined(USE_CR)
4860 if (eol_type == EOL_UNIX)
4862 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4863 return TRUE;
4865 #endif
4866 return FALSE;
4870 * Append line and character count to IObuff.
4872 void
4873 msg_add_lines(insert_space, lnum, nchars)
4874 int insert_space;
4875 long lnum;
4876 long nchars;
4878 char_u *p;
4880 p = IObuff + STRLEN(IObuff);
4882 if (insert_space)
4883 *p++ = ' ';
4884 if (shortmess(SHM_LINES))
4885 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4886 else
4888 if (lnum == 1)
4889 STRCPY(p, _("1 line, "));
4890 else
4891 sprintf((char *)p, _("%ld lines, "), lnum);
4892 p += STRLEN(p);
4893 if (nchars == 1)
4894 STRCPY(p, _("1 character"));
4895 else
4896 sprintf((char *)p, _("%ld characters"), nchars);
4901 * Append message for missing line separator to IObuff.
4903 static void
4904 msg_add_eol()
4906 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4910 * Check modification time of file, before writing to it.
4911 * The size isn't checked, because using a tool like "gzip" takes care of
4912 * using the same timestamp but can't set the size.
4914 static int
4915 check_mtime(buf, st)
4916 buf_T *buf;
4917 struct stat *st;
4919 if (buf->b_mtime_read != 0
4920 && time_differs((long)st->st_mtime, buf->b_mtime_read))
4922 msg_scroll = TRUE; /* don't overwrite messages here */
4923 msg_silent = 0; /* must give this prompt */
4924 /* don't use emsg() here, don't want to flush the buffers */
4925 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4926 hl_attr(HLF_E));
4927 if (ask_yesno((char_u *)_("Do you really want to write to it"),
4928 TRUE) == 'n')
4929 return FAIL;
4930 msg_scroll = FALSE; /* always overwrite the file message now */
4932 return OK;
4935 static int
4936 time_differs(t1, t2)
4937 long t1, t2;
4939 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4940 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4941 * the seconds. Since the roundoff is done when flushing the inode, the
4942 * time may change unexpectedly by one second!!! */
4943 return (t1 - t2 > 1 || t2 - t1 > 1);
4944 #else
4945 return (t1 != t2);
4946 #endif
4950 * Call write() to write a number of bytes to the file.
4951 * Also handles encryption and 'encoding' conversion.
4953 * Return FAIL for failure, OK otherwise.
4955 static int
4956 buf_write_bytes(ip)
4957 struct bw_info *ip;
4959 int wlen;
4960 char_u *buf = ip->bw_buf; /* data to write */
4961 int len = ip->bw_len; /* length of data */
4962 #ifdef HAS_BW_FLAGS
4963 int flags = ip->bw_flags; /* extra flags */
4964 #endif
4966 #ifdef FEAT_MBYTE
4968 * Skip conversion when writing the crypt magic number or the BOM.
4970 if (!(flags & FIO_NOCONVERT))
4972 char_u *p;
4973 unsigned c;
4974 int n;
4976 if (flags & FIO_UTF8)
4979 * Convert latin1 in the buffer to UTF-8 in the file.
4981 p = ip->bw_conv_buf; /* translate to buffer */
4982 for (wlen = 0; wlen < len; ++wlen)
4983 p += utf_char2bytes(buf[wlen], p);
4984 buf = ip->bw_conv_buf;
4985 len = (int)(p - ip->bw_conv_buf);
4987 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
4990 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
4991 * Latin1 chars in the file.
4993 if (flags & FIO_LATIN1)
4994 p = buf; /* translate in-place (can only get shorter) */
4995 else
4996 p = ip->bw_conv_buf; /* translate to buffer */
4997 for (wlen = 0; wlen < len; wlen += n)
4999 if (wlen == 0 && ip->bw_restlen != 0)
5001 int l;
5003 /* Use remainder of previous call. Append the start of
5004 * buf[] to get a full sequence. Might still be too
5005 * short! */
5006 l = CONV_RESTLEN - ip->bw_restlen;
5007 if (l > len)
5008 l = len;
5009 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
5010 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
5011 if (n > ip->bw_restlen + len)
5013 /* We have an incomplete byte sequence at the end to
5014 * be written. We can't convert it without the
5015 * remaining bytes. Keep them for the next call. */
5016 if (ip->bw_restlen + len > CONV_RESTLEN)
5017 return FAIL;
5018 ip->bw_restlen += len;
5019 break;
5021 if (n > 1)
5022 c = utf_ptr2char(ip->bw_rest);
5023 else
5024 c = ip->bw_rest[0];
5025 if (n >= ip->bw_restlen)
5027 n -= ip->bw_restlen;
5028 ip->bw_restlen = 0;
5030 else
5032 ip->bw_restlen -= n;
5033 mch_memmove(ip->bw_rest, ip->bw_rest + n,
5034 (size_t)ip->bw_restlen);
5035 n = 0;
5038 else
5040 n = utf_ptr2len_len(buf + wlen, len - wlen);
5041 if (n > len - wlen)
5043 /* We have an incomplete byte sequence at the end to
5044 * be written. We can't convert it without the
5045 * remaining bytes. Keep them for the next call. */
5046 if (len - wlen > CONV_RESTLEN)
5047 return FAIL;
5048 ip->bw_restlen = len - wlen;
5049 mch_memmove(ip->bw_rest, buf + wlen,
5050 (size_t)ip->bw_restlen);
5051 break;
5053 if (n > 1)
5054 c = utf_ptr2char(buf + wlen);
5055 else
5056 c = buf[wlen];
5059 ip->bw_conv_error |= ucs2bytes(c, &p, flags);
5061 if (flags & FIO_LATIN1)
5062 len = (int)(p - buf);
5063 else
5065 buf = ip->bw_conv_buf;
5066 len = (int)(p - ip->bw_conv_buf);
5070 # ifdef WIN3264
5071 else if (flags & FIO_CODEPAGE)
5074 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5075 * codepage.
5077 char_u *from;
5078 size_t fromlen;
5079 char_u *to;
5080 int u8c;
5081 BOOL bad = FALSE;
5082 int needed;
5084 if (ip->bw_restlen > 0)
5086 /* Need to concatenate the remainder of the previous call and
5087 * the bytes of the current call. Use the end of the
5088 * conversion buffer for this. */
5089 fromlen = len + ip->bw_restlen;
5090 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5091 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5092 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5094 else
5096 from = buf;
5097 fromlen = len;
5100 to = ip->bw_conv_buf;
5101 if (enc_utf8)
5103 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5104 * The buffer has been allocated to be big enough. */
5105 while (fromlen > 0)
5107 n = (int)utf_ptr2len_len(from, (int)fromlen);
5108 if (n > (int)fromlen) /* incomplete byte sequence */
5109 break;
5110 u8c = utf_ptr2char(from);
5111 *to++ = (u8c & 0xff);
5112 *to++ = (u8c >> 8);
5113 fromlen -= n;
5114 from += n;
5117 /* Copy remainder to ip->bw_rest[] to be used for the next
5118 * call. */
5119 if (fromlen > CONV_RESTLEN)
5121 /* weird overlong sequence */
5122 ip->bw_conv_error = TRUE;
5123 return FAIL;
5125 mch_memmove(ip->bw_rest, from, fromlen);
5126 ip->bw_restlen = (int)fromlen;
5128 else
5130 /* Convert from enc_codepage to UCS-2, to the start of the
5131 * buffer. The buffer has been allocated to be big enough. */
5132 ip->bw_restlen = 0;
5133 needed = MultiByteToWideChar(enc_codepage,
5134 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5135 NULL, 0);
5136 if (needed == 0)
5138 /* When conversion fails there may be a trailing byte. */
5139 needed = MultiByteToWideChar(enc_codepage,
5140 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5141 NULL, 0);
5142 if (needed == 0)
5144 /* Conversion doesn't work. */
5145 ip->bw_conv_error = TRUE;
5146 return FAIL;
5148 /* Save the trailing byte for the next call. */
5149 ip->bw_rest[0] = from[fromlen - 1];
5150 ip->bw_restlen = 1;
5152 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5153 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5154 (LPWSTR)to, needed);
5155 if (needed == 0)
5157 /* Safety check: Conversion doesn't work. */
5158 ip->bw_conv_error = TRUE;
5159 return FAIL;
5161 to += needed * 2;
5164 fromlen = to - ip->bw_conv_buf;
5165 buf = to;
5166 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5167 if (FIO_GET_CP(flags) == CP_UTF8)
5169 /* Convert from UCS-2 to UTF-8, using the remainder of the
5170 * conversion buffer. Fails when out of space. */
5171 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5173 u8c = *from++;
5174 u8c += (*from++ << 8);
5175 to += utf_char2bytes(u8c, to);
5176 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5178 ip->bw_conv_error = TRUE;
5179 return FAIL;
5182 len = (int)(to - buf);
5184 else
5185 #endif
5187 /* Convert from UCS-2 to the codepage, using the remainder of
5188 * the conversion buffer. If the conversion uses the default
5189 * character "0", the data doesn't fit in this encoding, so
5190 * fail. */
5191 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5192 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5193 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0,
5194 &bad);
5195 if (bad)
5197 ip->bw_conv_error = TRUE;
5198 return FAIL;
5202 # endif
5204 # ifdef MACOS_CONVERT
5205 else if (flags & FIO_MACROMAN)
5208 * Convert UTF-8 or latin1 to Apple MacRoman.
5210 char_u *from;
5211 size_t fromlen;
5213 if (ip->bw_restlen > 0)
5215 /* Need to concatenate the remainder of the previous call and
5216 * the bytes of the current call. Use the end of the
5217 * conversion buffer for this. */
5218 fromlen = len + ip->bw_restlen;
5219 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5220 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5221 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5223 else
5225 from = buf;
5226 fromlen = len;
5229 if (enc2macroman(from, fromlen,
5230 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5231 ip->bw_rest, &ip->bw_restlen) == FAIL)
5233 ip->bw_conv_error = TRUE;
5234 return FAIL;
5236 buf = ip->bw_conv_buf;
5238 # endif
5240 # ifdef USE_ICONV
5241 if (ip->bw_iconv_fd != (iconv_t)-1)
5243 const char *from;
5244 size_t fromlen;
5245 char *to;
5246 size_t tolen;
5248 /* Convert with iconv(). */
5249 if (ip->bw_restlen > 0)
5251 /* Need to concatenate the remainder of the previous call and
5252 * the bytes of the current call. Use the end of the
5253 * conversion buffer for this. */
5254 fromlen = len + ip->bw_restlen;
5255 from = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5256 mch_memmove((void *)from, ip->bw_rest, (size_t)ip->bw_restlen);
5257 mch_memmove((void *)(from + ip->bw_restlen), buf, (size_t)len);
5258 tolen = ip->bw_conv_buflen - fromlen;
5260 else
5262 from = (const char *)buf;
5263 fromlen = len;
5264 tolen = ip->bw_conv_buflen;
5266 to = (char *)ip->bw_conv_buf;
5268 if (ip->bw_first)
5270 size_t save_len = tolen;
5272 /* output the initial shift state sequence */
5273 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5275 /* There is a bug in iconv() on Linux (which appears to be
5276 * wide-spread) which sets "to" to NULL and messes up "tolen".
5278 if (to == NULL)
5280 to = (char *)ip->bw_conv_buf;
5281 tolen = save_len;
5283 ip->bw_first = FALSE;
5287 * If iconv() has an error or there is not enough room, fail.
5289 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5290 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5291 || fromlen > CONV_RESTLEN)
5293 ip->bw_conv_error = TRUE;
5294 return FAIL;
5297 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5298 if (fromlen > 0)
5299 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5300 ip->bw_restlen = (int)fromlen;
5302 buf = ip->bw_conv_buf;
5303 len = (int)((char_u *)to - ip->bw_conv_buf);
5305 # endif
5307 #endif /* FEAT_MBYTE */
5309 #ifdef FEAT_CRYPT
5310 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5312 int ztemp, t, i;
5314 for (i = 0; i < len; i++)
5316 ztemp = buf[i];
5317 buf[i] = ZENCODE(ztemp, t);
5320 #endif
5322 /* Repeat the write(), it may be interrupted by a signal. */
5323 while (len > 0)
5325 wlen = vim_write(ip->bw_fd, buf, len);
5326 if (wlen <= 0) /* error! */
5327 return FAIL;
5328 len -= wlen;
5329 buf += wlen;
5331 return OK;
5334 #ifdef FEAT_MBYTE
5336 * Convert a Unicode character to bytes.
5338 static int
5339 ucs2bytes(c, pp, flags)
5340 unsigned c; /* in: character */
5341 char_u **pp; /* in/out: pointer to result */
5342 int flags; /* FIO_ flags */
5344 char_u *p = *pp;
5345 int error = FALSE;
5346 int cc;
5349 if (flags & FIO_UCS4)
5351 if (flags & FIO_ENDIAN_L)
5353 *p++ = c;
5354 *p++ = (c >> 8);
5355 *p++ = (c >> 16);
5356 *p++ = (c >> 24);
5358 else
5360 *p++ = (c >> 24);
5361 *p++ = (c >> 16);
5362 *p++ = (c >> 8);
5363 *p++ = c;
5366 else if (flags & (FIO_UCS2 | FIO_UTF16))
5368 if (c >= 0x10000)
5370 if (flags & FIO_UTF16)
5372 /* Make two words, ten bits of the character in each. First
5373 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5374 c -= 0x10000;
5375 if (c >= 0x100000)
5376 error = TRUE;
5377 cc = ((c >> 10) & 0x3ff) + 0xd800;
5378 if (flags & FIO_ENDIAN_L)
5380 *p++ = cc;
5381 *p++ = ((unsigned)cc >> 8);
5383 else
5385 *p++ = ((unsigned)cc >> 8);
5386 *p++ = cc;
5388 c = (c & 0x3ff) + 0xdc00;
5390 else
5391 error = TRUE;
5393 if (flags & FIO_ENDIAN_L)
5395 *p++ = c;
5396 *p++ = (c >> 8);
5398 else
5400 *p++ = (c >> 8);
5401 *p++ = c;
5404 else /* Latin1 */
5406 if (c >= 0x100)
5408 error = TRUE;
5409 *p++ = 0xBF;
5411 else
5412 *p++ = c;
5415 *pp = p;
5416 return error;
5420 * Return TRUE if "a" and "b" are the same 'encoding'.
5421 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5423 static int
5424 same_encoding(a, b)
5425 char_u *a;
5426 char_u *b;
5428 int f;
5430 if (STRCMP(a, b) == 0)
5431 return TRUE;
5432 f = get_fio_flags(a);
5433 return (f != 0 && get_fio_flags(b) == f);
5437 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5438 * internal conversion.
5439 * if "ptr" is an empty string, use 'encoding'.
5441 static int
5442 get_fio_flags(ptr)
5443 char_u *ptr;
5445 int prop;
5447 if (*ptr == NUL)
5448 ptr = p_enc;
5450 prop = enc_canon_props(ptr);
5451 if (prop & ENC_UNICODE)
5453 if (prop & ENC_2BYTE)
5455 if (prop & ENC_ENDIAN_L)
5456 return FIO_UCS2 | FIO_ENDIAN_L;
5457 return FIO_UCS2;
5459 if (prop & ENC_4BYTE)
5461 if (prop & ENC_ENDIAN_L)
5462 return FIO_UCS4 | FIO_ENDIAN_L;
5463 return FIO_UCS4;
5465 if (prop & ENC_2WORD)
5467 if (prop & ENC_ENDIAN_L)
5468 return FIO_UTF16 | FIO_ENDIAN_L;
5469 return FIO_UTF16;
5471 return FIO_UTF8;
5473 if (prop & ENC_LATIN1)
5474 return FIO_LATIN1;
5475 /* must be ENC_DBCS, requires iconv() */
5476 return 0;
5479 #ifdef WIN3264
5481 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5482 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5483 * Used for conversion between 'encoding' and 'fileencoding'.
5485 static int
5486 get_win_fio_flags(ptr)
5487 char_u *ptr;
5489 int cp;
5491 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5492 if (!enc_utf8 && enc_codepage <= 0)
5493 return 0;
5495 cp = encname2codepage(ptr);
5496 if (cp == 0)
5498 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5499 if (STRCMP(ptr, "utf-8") == 0)
5500 cp = CP_UTF8;
5501 else
5502 # endif
5503 return 0;
5505 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5507 #endif
5509 #ifdef MACOS_X
5511 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5512 * needed for the internal conversion to/from utf-8 or latin1.
5514 static int
5515 get_mac_fio_flags(ptr)
5516 char_u *ptr;
5518 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5519 && (enc_canon_props(ptr) & ENC_MACROMAN))
5520 return FIO_MACROMAN;
5521 return 0;
5523 #endif
5526 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5527 * "size" must be at least 2.
5528 * Return the name of the encoding and set "*lenp" to the length.
5529 * Returns NULL when no BOM found.
5531 static char_u *
5532 check_for_bom(p, size, lenp, flags)
5533 char_u *p;
5534 long size;
5535 int *lenp;
5536 int flags;
5538 char *name = NULL;
5539 int len = 2;
5541 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5542 && (flags == FIO_ALL || flags == FIO_UTF8 || flags == 0))
5544 name = "utf-8"; /* EF BB BF */
5545 len = 3;
5547 else if (p[0] == 0xff && p[1] == 0xfe)
5549 if (size >= 4 && p[2] == 0 && p[3] == 0
5550 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5552 name = "ucs-4le"; /* FF FE 00 00 */
5553 len = 4;
5555 else if (flags == (FIO_UCS2 | FIO_ENDIAN_L))
5556 name = "ucs-2le"; /* FF FE */
5557 else if (flags == FIO_ALL || flags == (FIO_UTF16 | FIO_ENDIAN_L))
5558 /* utf-16le is preferred, it also works for ucs-2le text */
5559 name = "utf-16le"; /* FF FE */
5561 else if (p[0] == 0xfe && p[1] == 0xff
5562 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5564 /* Default to utf-16, it works also for ucs-2 text. */
5565 if (flags == FIO_UCS2)
5566 name = "ucs-2"; /* FE FF */
5567 else
5568 name = "utf-16"; /* FE FF */
5570 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5571 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5573 name = "ucs-4"; /* 00 00 FE FF */
5574 len = 4;
5577 *lenp = len;
5578 return (char_u *)name;
5582 * Generate a BOM in "buf[4]" for encoding "name".
5583 * Return the length of the BOM (zero when no BOM).
5585 static int
5586 make_bom(buf, name)
5587 char_u *buf;
5588 char_u *name;
5590 int flags;
5591 char_u *p;
5593 flags = get_fio_flags(name);
5595 /* Can't put a BOM in a non-Unicode file. */
5596 if (flags == FIO_LATIN1 || flags == 0)
5597 return 0;
5599 if (flags == FIO_UTF8) /* UTF-8 */
5601 buf[0] = 0xef;
5602 buf[1] = 0xbb;
5603 buf[2] = 0xbf;
5604 return 3;
5606 p = buf;
5607 (void)ucs2bytes(0xfeff, &p, flags);
5608 return (int)(p - buf);
5610 #endif
5612 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5613 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5615 * Try to find a shortname by comparing the fullname with the current
5616 * directory.
5617 * Returns "full_path" or pointer into "full_path" if shortened.
5619 char_u *
5620 shorten_fname1(full_path)
5621 char_u *full_path;
5623 char_u dirname[MAXPATHL];
5624 char_u *p = full_path;
5626 if (mch_dirname(dirname, MAXPATHL) == OK)
5628 p = shorten_fname(full_path, dirname);
5629 if (p == NULL || *p == NUL)
5630 p = full_path;
5632 return p;
5634 #endif
5637 * Try to find a shortname by comparing the fullname with the current
5638 * directory.
5639 * Returns NULL if not shorter name possible, pointer into "full_path"
5640 * otherwise.
5642 char_u *
5643 shorten_fname(full_path, dir_name)
5644 char_u *full_path;
5645 char_u *dir_name;
5647 int len;
5648 char_u *p;
5650 if (full_path == NULL)
5651 return NULL;
5652 len = (int)STRLEN(dir_name);
5653 if (fnamencmp(dir_name, full_path, len) == 0)
5655 p = full_path + len;
5656 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5658 * MSDOS: when a file is in the root directory, dir_name will end in a
5659 * slash, since C: by itself does not define a specific dir. In this
5660 * case p may already be correct. <negri>
5662 if (!((len > 2) && (*(p - 2) == ':')))
5663 #endif
5665 if (vim_ispathsep(*p))
5666 ++p;
5667 #ifndef VMS /* the path separator is always part of the path */
5668 else
5669 p = NULL;
5670 #endif
5673 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5675 * When using a file in the current drive, remove the drive name:
5676 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5677 * a floppy from "A:\dir" to "B:\dir".
5679 else if (len > 3
5680 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5681 && full_path[1] == ':'
5682 && vim_ispathsep(full_path[2]))
5683 p = full_path + 2;
5684 #endif
5685 else
5686 p = NULL;
5687 return p;
5691 * Shorten filenames for all buffers.
5692 * When "force" is TRUE: Use full path from now on for files currently being
5693 * edited, both for file name and swap file name. Try to shorten the file
5694 * names a bit, if safe to do so.
5695 * When "force" is FALSE: Only try to shorten absolute file names.
5696 * For buffers that have buftype "nofile" or "scratch": never change the file
5697 * name.
5699 void
5700 shorten_fnames(force)
5701 int force;
5703 char_u dirname[MAXPATHL];
5704 buf_T *buf;
5705 char_u *p;
5707 mch_dirname(dirname, MAXPATHL);
5708 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5710 if (buf->b_fname != NULL
5711 #ifdef FEAT_QUICKFIX
5712 && !bt_nofile(buf)
5713 #endif
5714 && !path_with_url(buf->b_fname)
5715 && (force
5716 || buf->b_sfname == NULL
5717 || mch_isFullName(buf->b_sfname)))
5719 vim_free(buf->b_sfname);
5720 buf->b_sfname = NULL;
5721 p = shorten_fname(buf->b_ffname, dirname);
5722 if (p != NULL)
5724 buf->b_sfname = vim_strsave(p);
5725 buf->b_fname = buf->b_sfname;
5727 if (p == NULL || buf->b_fname == NULL)
5728 buf->b_fname = buf->b_ffname;
5731 /* Always make the swap file name a full path, a "nofile" buffer may
5732 * also have a swap file. */
5733 mf_fullname(buf->b_ml.ml_mfp);
5735 #ifdef FEAT_WINDOWS
5736 status_redraw_all();
5737 redraw_tabline = TRUE;
5738 #endif
5741 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5742 || defined(FEAT_GUI_MSWIN) \
5743 || defined(FEAT_GUI_MAC) \
5744 || defined(PROTO) \
5745 || defined(FEAT_GUI_MACVIM)
5747 * Shorten all filenames in "fnames[count]" by current directory.
5749 void
5750 shorten_filenames(fnames, count)
5751 char_u **fnames;
5752 int count;
5754 int i;
5755 char_u dirname[MAXPATHL];
5756 char_u *p;
5758 if (fnames == NULL || count < 1)
5759 return;
5760 mch_dirname(dirname, sizeof(dirname));
5761 for (i = 0; i < count; ++i)
5763 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5765 /* shorten_fname() returns pointer in given "fnames[i]". If free
5766 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5767 * "p" first then free fnames[i]. */
5768 p = vim_strsave(p);
5769 vim_free(fnames[i]);
5770 fnames[i] = p;
5774 #endif
5777 * add extension to file name - change path/fo.o.h to path/fo.o.h.ext or
5778 * fo_o_h.ext for MSDOS or when shortname option set.
5780 * Assumed that fname is a valid name found in the filesystem we assure that
5781 * the return value is a different name and ends in 'ext'.
5782 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5783 * characters otherwise.
5784 * Space for the returned name is allocated, must be freed later.
5785 * Returns NULL when out of memory.
5787 char_u *
5788 modname(fname, ext, prepend_dot)
5789 char_u *fname, *ext;
5790 int prepend_dot; /* may prepend a '.' to file name */
5792 return buf_modname(
5793 #ifdef SHORT_FNAME
5794 TRUE,
5795 #else
5796 (curbuf->b_p_sn || curbuf->b_shortname),
5797 #endif
5798 fname, ext, prepend_dot);
5801 char_u *
5802 buf_modname(shortname, fname, ext, prepend_dot)
5803 int shortname; /* use 8.3 file name */
5804 char_u *fname, *ext;
5805 int prepend_dot; /* may prepend a '.' to file name */
5807 char_u *retval;
5808 char_u *s;
5809 char_u *e;
5810 char_u *ptr;
5811 int fnamelen, extlen;
5813 extlen = (int)STRLEN(ext);
5816 * If there is no file name we must get the name of the current directory
5817 * (we need the full path in case :cd is used).
5819 if (fname == NULL || *fname == NUL)
5821 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5822 if (retval == NULL)
5823 return NULL;
5824 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5825 (fnamelen = (int)STRLEN(retval)) == 0)
5827 vim_free(retval);
5828 return NULL;
5830 if (!after_pathsep(retval, retval + fnamelen))
5832 retval[fnamelen++] = PATHSEP;
5833 retval[fnamelen] = NUL;
5835 #ifndef SHORT_FNAME
5836 prepend_dot = FALSE; /* nothing to prepend a dot to */
5837 #endif
5839 else
5841 fnamelen = (int)STRLEN(fname);
5842 retval = alloc((unsigned)(fnamelen + extlen + 3));
5843 if (retval == NULL)
5844 return NULL;
5845 STRCPY(retval, fname);
5846 #ifdef VMS
5847 vms_remove_version(retval); /* we do not need versions here */
5848 #endif
5852 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5853 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5854 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5855 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5857 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5859 #ifndef RISCOS
5860 if (*ext == '.'
5861 # ifdef USE_LONG_FNAME
5862 && (!USE_LONG_FNAME || shortname)
5863 # else
5864 # ifndef SHORT_FNAME
5865 && shortname
5866 # endif
5867 # endif
5869 if (*ptr == '.') /* replace '.' by '_' */
5870 *ptr = '_';
5871 #endif
5872 if (vim_ispathsep(*ptr))
5874 ++ptr;
5875 break;
5879 /* the file name has at most BASENAMELEN characters. */
5880 #ifndef SHORT_FNAME
5881 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5882 ptr[BASENAMELEN] = '\0';
5883 #endif
5885 s = ptr + STRLEN(ptr);
5888 * For 8.3 file names we may have to reduce the length.
5890 #ifdef USE_LONG_FNAME
5891 if (!USE_LONG_FNAME || shortname)
5892 #else
5893 # ifndef SHORT_FNAME
5894 if (shortname)
5895 # endif
5896 #endif
5899 * If there is no file name, or the file name ends in '/', and the
5900 * extension starts with '.', put a '_' before the dot, because just
5901 * ".ext" is invalid.
5903 if (fname == NULL || *fname == NUL
5904 || vim_ispathsep(fname[STRLEN(fname) - 1]))
5906 #ifdef RISCOS
5907 if (*ext == '/')
5908 #else
5909 if (*ext == '.')
5910 #endif
5911 *s++ = '_';
5914 * If the extension starts with '.', truncate the base name at 8
5915 * characters
5917 #ifdef RISCOS
5918 /* We normally use '/', but swap files are '_' */
5919 else if (*ext == '/' || *ext == '_')
5920 #else
5921 else if (*ext == '.')
5922 #endif
5924 if (s - ptr > (size_t)8)
5926 s = ptr + 8;
5927 *s = '\0';
5931 * If the extension doesn't start with '.', and the file name
5932 * doesn't have an extension yet, append a '.'
5934 #ifdef RISCOS
5935 else if ((e = vim_strchr(ptr, '/')) == NULL)
5936 *s++ = '/';
5937 #else
5938 else if ((e = vim_strchr(ptr, '.')) == NULL)
5939 *s++ = '.';
5940 #endif
5942 * If the extension doesn't start with '.', and there already is an
5943 * extension, it may need to be truncated
5945 else if ((int)STRLEN(e) + extlen > 4)
5946 s = e + 4 - extlen;
5948 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5950 * If there is no file name, and the extension starts with '.', put a
5951 * '_' before the dot, because just ".ext" may be invalid if it's on a
5952 * FAT partition, and on HPFS it doesn't matter.
5954 else if ((fname == NULL || *fname == NUL) && *ext == '.')
5955 *s++ = '_';
5956 #endif
5959 * Append the extension.
5960 * ext can start with '.' and cannot exceed 3 more characters.
5962 STRCPY(s, ext);
5964 #ifndef SHORT_FNAME
5966 * Prepend the dot.
5968 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
5969 #ifdef RISCOS
5971 #else
5973 #endif
5974 #ifdef USE_LONG_FNAME
5975 && USE_LONG_FNAME
5976 #endif
5979 STRMOVE(e + 1, e);
5980 #ifdef RISCOS
5981 *e = '/';
5982 #else
5983 *e = '.';
5984 #endif
5986 #endif
5989 * Check that, after appending the extension, the file name is really
5990 * different.
5992 if (fname != NULL && STRCMP(fname, retval) == 0)
5994 /* we search for a character that can be replaced by '_' */
5995 while (--s >= ptr)
5997 if (*s != '_')
5999 *s = '_';
6000 break;
6003 if (s < ptr) /* fname was "________.<ext>", how tricky! */
6004 *ptr = 'v';
6006 return retval;
6010 * Like fgets(), but if the file line is too long, it is truncated and the
6011 * rest of the line is thrown away. Returns TRUE for end-of-file.
6014 vim_fgets(buf, size, fp)
6015 char_u *buf;
6016 int size;
6017 FILE *fp;
6019 char *eof;
6020 #define FGETS_SIZE 200
6021 char tbuf[FGETS_SIZE];
6023 buf[size - 2] = NUL;
6024 #ifdef USE_CR
6025 eof = fgets_cr((char *)buf, size, fp);
6026 #else
6027 eof = fgets((char *)buf, size, fp);
6028 #endif
6029 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
6031 buf[size - 1] = NUL; /* Truncate the line */
6033 /* Now throw away the rest of the line: */
6036 tbuf[FGETS_SIZE - 2] = NUL;
6037 #ifdef USE_CR
6038 ignoredp = fgets_cr((char *)tbuf, FGETS_SIZE, fp);
6039 #else
6040 ignoredp = fgets((char *)tbuf, FGETS_SIZE, fp);
6041 #endif
6042 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
6044 return (eof == NULL);
6047 #if defined(USE_CR) || defined(PROTO)
6049 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6050 * Returns TRUE for end-of-file.
6051 * Only used for the Mac, because it's much slower than vim_fgets().
6054 tag_fgets(buf, size, fp)
6055 char_u *buf;
6056 int size;
6057 FILE *fp;
6059 int i = 0;
6060 int c;
6061 int eof = FALSE;
6063 for (;;)
6065 c = fgetc(fp);
6066 if (c == EOF)
6068 eof = TRUE;
6069 break;
6071 if (c == '\r')
6073 /* Always store a NL for end-of-line. */
6074 if (i < size - 1)
6075 buf[i++] = '\n';
6076 c = fgetc(fp);
6077 if (c != '\n') /* Macintosh format: single CR. */
6078 ungetc(c, fp);
6079 break;
6081 if (i < size - 1)
6082 buf[i++] = c;
6083 if (c == '\n')
6084 break;
6086 buf[i] = NUL;
6087 return eof;
6089 #endif
6092 * rename() only works if both files are on the same file system, this
6093 * function will (attempts to?) copy the file across if rename fails -- webb
6094 * Return -1 for failure, 0 for success.
6097 vim_rename(from, to)
6098 char_u *from;
6099 char_u *to;
6101 int fd_in;
6102 int fd_out;
6103 int n;
6104 char *errmsg = NULL;
6105 char *buffer;
6106 #ifdef AMIGA
6107 BPTR flock;
6108 #endif
6109 struct stat st;
6110 long perm;
6111 #ifdef HAVE_ACL
6112 vim_acl_T acl; /* ACL from original file */
6113 #endif
6114 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6115 int use_tmp_file = FALSE;
6116 #endif
6119 * When the names are identical, there is nothing to do. When they refer
6120 * to the same file (ignoring case and slash/backslash differences) but
6121 * the file name differs we need to go through a temp file.
6123 if (fnamecmp(from, to) == 0)
6125 #ifdef CASE_INSENSITIVE_FILENAME
6126 if (STRCMP(gettail(from), gettail(to)) != 0)
6127 use_tmp_file = TRUE;
6128 else
6129 #endif
6130 return 0;
6134 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6136 if (mch_stat((char *)from, &st) < 0)
6137 return -1;
6139 #ifdef UNIX
6141 struct stat st_to;
6143 /* It's possible for the source and destination to be the same file.
6144 * This happens when "from" and "to" differ in case and are on a FAT32
6145 * filesystem. In that case go through a temp file name. */
6146 if (mch_stat((char *)to, &st_to) >= 0
6147 && st.st_dev == st_to.st_dev
6148 && st.st_ino == st_to.st_ino)
6149 use_tmp_file = TRUE;
6151 #endif
6153 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6154 if (use_tmp_file)
6156 char tempname[MAXPATHL + 1];
6159 * Find a name that doesn't exist and is in the same directory.
6160 * Rename "from" to "tempname" and then rename "tempname" to "to".
6162 if (STRLEN(from) >= MAXPATHL - 5)
6163 return -1;
6164 STRCPY(tempname, from);
6165 for (n = 123; n < 99999; ++n)
6167 sprintf((char *)gettail((char_u *)tempname), "%d", n);
6168 if (mch_stat(tempname, &st) < 0)
6170 if (mch_rename((char *)from, tempname) == 0)
6172 if (mch_rename(tempname, (char *)to) == 0)
6173 return 0;
6174 /* Strange, the second step failed. Try moving the
6175 * file back and return failure. */
6176 mch_rename(tempname, (char *)from);
6177 return -1;
6179 /* If it fails for one temp name it will most likely fail
6180 * for any temp name, give up. */
6181 return -1;
6184 return -1;
6186 #endif
6189 * Delete the "to" file, this is required on some systems to make the
6190 * mch_rename() work, on other systems it makes sure that we don't have
6191 * two files when the mch_rename() fails.
6194 #ifdef AMIGA
6196 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6197 * that the name of the "to" file is the same as the "from" file, even
6198 * though the names are different. To avoid the chance of accidentally
6199 * deleting the "from" file (horror!) we lock it during the remove.
6201 * When used for making a backup before writing the file: This should not
6202 * happen with ":w", because startscript() should detect this problem and
6203 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6204 * name. This problem does exist with ":w filename", but then the
6205 * original file will be somewhere else so the backup isn't really
6206 * important. If autoscripting is off the rename may fail.
6208 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6209 #endif
6210 mch_remove(to);
6211 #ifdef AMIGA
6212 if (flock)
6213 UnLock(flock);
6214 #endif
6217 * First try a normal rename, return if it works.
6219 if (mch_rename((char *)from, (char *)to) == 0)
6220 return 0;
6223 * Rename() failed, try copying the file.
6225 perm = mch_getperm(from);
6226 #ifdef HAVE_ACL
6227 /* For systems that support ACL: get the ACL from the original file. */
6228 acl = mch_get_acl(from);
6229 #endif
6230 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6231 if (fd_in == -1)
6233 #ifdef HAVE_ACL
6234 mch_free_acl(acl);
6235 #endif
6236 return -1;
6239 /* Create the new file with same permissions as the original. */
6240 fd_out = mch_open((char *)to,
6241 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6242 if (fd_out == -1)
6244 close(fd_in);
6245 #ifdef HAVE_ACL
6246 mch_free_acl(acl);
6247 #endif
6248 return -1;
6251 buffer = (char *)alloc(BUFSIZE);
6252 if (buffer == NULL)
6254 close(fd_out);
6255 close(fd_in);
6256 #ifdef HAVE_ACL
6257 mch_free_acl(acl);
6258 #endif
6259 return -1;
6262 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6263 if (vim_write(fd_out, buffer, n) != n)
6265 errmsg = _("E208: Error writing to \"%s\"");
6266 break;
6269 vim_free(buffer);
6270 close(fd_in);
6271 if (close(fd_out) < 0)
6272 errmsg = _("E209: Error closing \"%s\"");
6273 if (n < 0)
6275 errmsg = _("E210: Error reading \"%s\"");
6276 to = from;
6278 #ifndef UNIX /* for Unix mch_open() already set the permission */
6279 mch_setperm(to, perm);
6280 #endif
6281 #ifdef HAVE_ACL
6282 mch_set_acl(to, acl);
6283 mch_free_acl(acl);
6284 #endif
6285 if (errmsg != NULL)
6287 EMSG2(errmsg, to);
6288 return -1;
6290 mch_remove(from);
6291 return 0;
6294 static int already_warned = FALSE;
6295 #ifdef FEAT_GUI_MACVIM
6296 static int default_reload_choice = 0;
6297 #endif
6300 * Check if any not hidden buffer has been changed.
6301 * Postpone the check if there are characters in the stuff buffer, a global
6302 * command is being executed, a mapping is being executed or an autocommand is
6303 * busy.
6304 * Returns TRUE if some message was written (screen should be redrawn and
6305 * cursor positioned).
6308 check_timestamps(focus)
6309 int focus; /* called for GUI focus event */
6311 buf_T *buf;
6312 int didit = 0;
6313 int n;
6315 /* Don't check timestamps while system() or another low-level function may
6316 * cause us to lose and gain focus. */
6317 if (no_check_timestamps > 0)
6318 return FALSE;
6320 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6321 * event and we would keep on checking if the file is steadily growing.
6322 * Do check again after typing something. */
6323 if (focus && did_check_timestamps)
6325 need_check_timestamps = TRUE;
6326 return FALSE;
6329 if (!stuff_empty() || global_busy || !typebuf_typed()
6330 #ifdef FEAT_AUTOCMD
6331 || autocmd_busy || curbuf_lock > 0
6332 #endif
6334 need_check_timestamps = TRUE; /* check later */
6335 else
6337 ++no_wait_return;
6338 did_check_timestamps = TRUE;
6339 already_warned = FALSE;
6340 #ifdef FEAT_GUI_MACVIM
6341 default_reload_choice = 0;
6342 #endif
6343 for (buf = firstbuf; buf != NULL; )
6345 /* Only check buffers in a window. */
6346 if (buf->b_nwindows > 0)
6348 n = buf_check_timestamp(buf, focus);
6349 if (didit < n)
6350 didit = n;
6351 if (n > 0 && !buf_valid(buf))
6353 /* Autocommands have removed the buffer, start at the
6354 * first one again. */
6355 buf = firstbuf;
6356 continue;
6359 buf = buf->b_next;
6361 #ifdef FEAT_GUI_MACVIM
6362 default_reload_choice = 0;
6363 #endif
6364 --no_wait_return;
6365 need_check_timestamps = FALSE;
6366 if (need_wait_return && didit == 2)
6368 /* make sure msg isn't overwritten */
6369 msg_puts((char_u *)"\n");
6370 out_flush();
6373 return didit;
6377 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6378 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6379 * empty.
6381 static int
6382 move_lines(frombuf, tobuf)
6383 buf_T *frombuf;
6384 buf_T *tobuf;
6386 buf_T *tbuf = curbuf;
6387 int retval = OK;
6388 linenr_T lnum;
6389 char_u *p;
6391 /* Copy the lines in "frombuf" to "tobuf". */
6392 curbuf = tobuf;
6393 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6395 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6396 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6398 vim_free(p);
6399 retval = FAIL;
6400 break;
6402 vim_free(p);
6405 /* Delete all the lines in "frombuf". */
6406 if (retval != FAIL)
6408 curbuf = frombuf;
6409 for (lnum = curbuf->b_ml.ml_line_count; lnum > 0; --lnum)
6410 if (ml_delete(lnum, FALSE) == FAIL)
6412 /* Oops! We could try putting back the saved lines, but that
6413 * might fail again... */
6414 retval = FAIL;
6415 break;
6419 curbuf = tbuf;
6420 return retval;
6424 * Check if buffer "buf" has been changed.
6425 * Also check if the file for a new buffer unexpectedly appeared.
6426 * return 1 if a changed buffer was found.
6427 * return 2 if a message has been displayed.
6428 * return 0 otherwise.
6430 /*ARGSUSED*/
6432 buf_check_timestamp(buf, focus)
6433 buf_T *buf;
6434 int focus; /* called for GUI focus event */
6436 struct stat st;
6437 int stat_res;
6438 int retval = 0;
6439 char_u *path;
6440 char_u *tbuf;
6441 char *mesg = NULL;
6442 char *mesg2 = "";
6443 int helpmesg = FALSE;
6444 int reload = FALSE;
6445 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6446 int can_reload = FALSE;
6447 #endif
6448 size_t orig_size = buf->b_orig_size;
6449 int orig_mode = buf->b_orig_mode;
6450 #ifdef FEAT_GUI
6451 int save_mouse_correct = need_mouse_correct;
6452 #endif
6453 #ifdef FEAT_AUTOCMD
6454 static int busy = FALSE;
6455 int n;
6456 char_u *s;
6457 #endif
6458 char *reason;
6460 /* If there is no file name, the buffer is not loaded, 'buftype' is
6461 * set, we are in the middle of a save or being called recursively: ignore
6462 * this buffer. */
6463 if (buf->b_ffname == NULL
6464 || buf->b_ml.ml_mfp == NULL
6465 #if defined(FEAT_QUICKFIX)
6466 || *buf->b_p_bt != NUL
6467 #endif
6468 || buf->b_saving
6469 #ifdef FEAT_AUTOCMD
6470 || busy
6471 #endif
6472 #ifdef FEAT_NETBEANS_INTG
6473 || isNetbeansBuffer(buf)
6474 #endif
6476 return 0;
6478 if ( !(buf->b_flags & BF_NOTEDITED)
6479 && buf->b_mtime != 0
6480 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6481 || time_differs((long)st.st_mtime, buf->b_mtime)
6482 #ifdef HAVE_ST_MODE
6483 || (int)st.st_mode != buf->b_orig_mode
6484 #else
6485 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6486 #endif
6489 retval = 1;
6491 /* set b_mtime to stop further warnings (e.g., when executing
6492 * FileChangedShell autocmd) */
6493 if (stat_res < 0)
6495 buf->b_mtime = 0;
6496 buf->b_orig_size = 0;
6497 buf->b_orig_mode = 0;
6499 else
6500 buf_store_time(buf, &st, buf->b_ffname);
6502 /* Don't do anything for a directory. Might contain the file
6503 * explorer. */
6504 if (mch_isdir(buf->b_fname))
6508 * If 'autoread' is set, the buffer has no changes and the file still
6509 * exists, reload the buffer. Use the buffer-local option value if it
6510 * was set, the global option value otherwise.
6512 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6513 && !bufIsChanged(buf) && stat_res >= 0)
6514 reload = TRUE;
6515 else
6517 if (stat_res < 0)
6518 reason = "deleted";
6519 else if (bufIsChanged(buf))
6520 reason = "conflict";
6521 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6522 reason = "changed";
6523 else if (orig_mode != buf->b_orig_mode)
6524 reason = "mode";
6525 else
6526 reason = "time";
6528 #ifdef FEAT_AUTOCMD
6530 * Only give the warning if there are no FileChangedShell
6531 * autocommands.
6532 * Avoid being called recursively by setting "busy".
6534 busy = TRUE;
6535 # ifdef FEAT_EVAL
6536 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6537 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6538 # endif
6539 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6540 buf->b_fname, buf->b_fname, FALSE, buf);
6541 busy = FALSE;
6542 if (n)
6544 if (!buf_valid(buf))
6545 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6546 # ifdef FEAT_EVAL
6547 s = get_vim_var_str(VV_FCS_CHOICE);
6548 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6549 reload = TRUE;
6550 else if (STRCMP(s, "ask") == 0)
6551 n = FALSE;
6552 else
6553 # endif
6554 return 2;
6556 if (!n)
6557 #endif
6559 if (*reason == 'd')
6560 mesg = _("E211: File \"%s\" no longer available");
6561 else
6563 helpmesg = TRUE;
6564 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6565 can_reload = TRUE;
6566 #endif
6568 * Check if the file contents really changed to avoid
6569 * giving a warning when only the timestamp was set (e.g.,
6570 * checked out of CVS). Always warn when the buffer was
6571 * changed.
6573 if (reason[2] == 'n')
6575 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6576 mesg2 = _("See \":help W12\" for more info.");
6578 else if (reason[1] == 'h')
6580 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6581 mesg2 = _("See \":help W11\" for more info.");
6583 else if (*reason == 'm')
6585 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6586 mesg2 = _("See \":help W16\" for more info.");
6588 /* Else: only timestamp changed, ignored */
6594 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6595 && vim_fexists(buf->b_ffname))
6597 retval = 1;
6598 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6599 buf->b_flags |= BF_NEW_W;
6600 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6601 can_reload = TRUE;
6602 #endif
6605 if (mesg != NULL)
6607 path = home_replace_save(buf, buf->b_fname);
6608 if (path != NULL)
6610 if (!helpmesg)
6611 mesg2 = "";
6612 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6613 + STRLEN(mesg2) + 2));
6614 sprintf((char *)tbuf, mesg, path);
6615 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6616 if (can_reload)
6618 if (*mesg2 != NUL)
6620 STRCAT(tbuf, "\n");
6621 STRCAT(tbuf, mesg2);
6623 # ifdef FEAT_GUI_MACVIM
6624 if (default_reload_choice > 0)
6626 if (default_reload_choice == 2)
6627 reload = TRUE;
6629 else
6631 switch (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6632 (char_u *)_("&OK\n&Load File\nLoad &All\n&Ignore All"),
6633 1, NULL))
6635 case 3:
6636 default_reload_choice = 2;
6637 case 2:
6638 reload = TRUE;
6639 break;
6640 case 4:
6641 default_reload_choice = 1;
6642 break;
6645 # else
6646 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6647 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6648 reload = TRUE;
6649 # endif
6651 else
6652 #endif
6653 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6655 if (*mesg2 != NUL)
6657 STRCAT(tbuf, "; ");
6658 STRCAT(tbuf, mesg2);
6660 EMSG(tbuf);
6661 retval = 2;
6663 else
6665 # ifdef FEAT_AUTOCMD
6666 if (!autocmd_busy)
6667 # endif
6669 msg_start();
6670 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6671 if (*mesg2 != NUL)
6672 msg_puts_attr((char_u *)mesg2,
6673 hl_attr(HLF_W) + MSG_HIST);
6674 msg_clr_eos();
6675 (void)msg_end();
6676 if (emsg_silent == 0)
6678 out_flush();
6679 # ifdef FEAT_GUI
6680 if (!focus)
6681 # endif
6682 /* give the user some time to think about it */
6683 ui_delay(1000L, TRUE);
6685 /* don't redraw and erase the message */
6686 redraw_cmdline = FALSE;
6689 already_warned = TRUE;
6692 vim_free(path);
6693 vim_free(tbuf);
6697 if (reload)
6698 /* Reload the buffer. */
6699 buf_reload(buf, orig_mode);
6701 #ifdef FEAT_AUTOCMD
6702 /* Trigger FileChangedShell when the file was changed in any way. */
6703 if (buf_valid(buf) && retval != 0)
6704 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6705 buf->b_fname, buf->b_fname, FALSE, buf);
6706 #endif
6707 #ifdef FEAT_GUI
6708 /* restore this in case an autocommand has set it; it would break
6709 * 'mousefocus' */
6710 need_mouse_correct = save_mouse_correct;
6711 #endif
6713 return retval;
6717 * Reload a buffer that is already loaded.
6718 * Used when the file was changed outside of Vim.
6719 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6720 * buf->b_orig_mode may have been reset already.
6722 void
6723 buf_reload(buf, orig_mode)
6724 buf_T *buf;
6725 int orig_mode;
6727 exarg_T ea;
6728 pos_T old_cursor;
6729 linenr_T old_topline;
6730 int old_ro = buf->b_p_ro;
6731 buf_T *savebuf;
6732 int saved = OK;
6733 aco_save_T aco;
6735 /* set curwin/curbuf for "buf" and save some things */
6736 aucmd_prepbuf(&aco, buf);
6738 /* We only want to read the text from the file, not reset the syntax
6739 * highlighting, clear marks, diff status, etc. Force the fileformat
6740 * and encoding to be the same. */
6741 if (prep_exarg(&ea, buf) == OK)
6743 old_cursor = curwin->w_cursor;
6744 old_topline = curwin->w_topline;
6747 * To behave like when a new file is edited (matters for
6748 * BufReadPost autocommands) we first need to delete the current
6749 * buffer contents. But if reading the file fails we should keep
6750 * the old contents. Can't use memory only, the file might be
6751 * too big. Use a hidden buffer to move the buffer contents to.
6753 if (bufempty())
6754 savebuf = NULL;
6755 else
6757 /* Allocate a buffer without putting it in the buffer list. */
6758 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6759 if (savebuf != NULL && buf == curbuf)
6761 /* Open the memline. */
6762 curbuf = savebuf;
6763 curwin->w_buffer = savebuf;
6764 saved = ml_open(curbuf);
6765 curbuf = buf;
6766 curwin->w_buffer = buf;
6768 if (savebuf == NULL || saved == FAIL || buf != curbuf
6769 || move_lines(buf, savebuf) == FAIL)
6771 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6772 buf->b_fname);
6773 saved = FAIL;
6777 if (saved == OK)
6779 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6780 #ifdef FEAT_AUTOCMD
6781 keep_filetype = TRUE; /* don't detect 'filetype' */
6782 #endif
6783 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6784 (linenr_T)0,
6785 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6787 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6788 if (!aborting())
6789 #endif
6790 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6791 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6793 /* Put the text back from the save buffer. First
6794 * delete any lines that readfile() added. */
6795 while (!bufempty())
6796 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6797 break;
6798 (void)move_lines(savebuf, buf);
6801 else if (buf == curbuf)
6803 /* Mark the buffer as unmodified and free undo info. */
6804 unchanged(buf, TRUE);
6805 u_blockfree(buf);
6806 u_clearall(buf);
6809 vim_free(ea.cmd);
6811 if (savebuf != NULL && buf_valid(savebuf))
6812 wipe_buffer(savebuf, FALSE);
6814 #ifdef FEAT_DIFF
6815 /* Invalidate diff info if necessary. */
6816 diff_invalidate(curbuf);
6817 #endif
6819 /* Restore the topline and cursor position and check it (lines may
6820 * have been removed). */
6821 if (old_topline > curbuf->b_ml.ml_line_count)
6822 curwin->w_topline = curbuf->b_ml.ml_line_count;
6823 else
6824 curwin->w_topline = old_topline;
6825 curwin->w_cursor = old_cursor;
6826 check_cursor();
6827 update_topline();
6828 #ifdef FEAT_AUTOCMD
6829 keep_filetype = FALSE;
6830 #endif
6831 #ifdef FEAT_FOLDING
6833 win_T *wp;
6835 /* Update folds unless they are defined manually. */
6836 FOR_ALL_WINDOWS(wp)
6837 if (wp->w_buffer == curwin->w_buffer
6838 && !foldmethodIsManual(wp))
6839 foldUpdateAll(wp);
6841 #endif
6842 /* If the mode didn't change and 'readonly' was set, keep the old
6843 * value; the user probably used the ":view" command. But don't
6844 * reset it, might have had a read error. */
6845 if (orig_mode == curbuf->b_orig_mode)
6846 curbuf->b_p_ro |= old_ro;
6849 /* restore curwin/curbuf and a few other things */
6850 aucmd_restbuf(&aco);
6851 /* Careful: autocommands may have made "buf" invalid! */
6854 /*ARGSUSED*/
6855 void
6856 buf_store_time(buf, st, fname)
6857 buf_T *buf;
6858 struct stat *st;
6859 char_u *fname;
6861 buf->b_mtime = (long)st->st_mtime;
6862 buf->b_orig_size = (size_t)st->st_size;
6863 #ifdef HAVE_ST_MODE
6864 buf->b_orig_mode = (int)st->st_mode;
6865 #else
6866 buf->b_orig_mode = mch_getperm(fname);
6867 #endif
6871 * Adjust the line with missing eol, used for the next write.
6872 * Used for do_filter(), when the input lines for the filter are deleted.
6874 void
6875 write_lnum_adjust(offset)
6876 linenr_T offset;
6878 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
6879 write_no_eol_lnum += offset;
6882 #if defined(TEMPDIRNAMES) || defined(PROTO)
6883 static long temp_count = 0; /* Temp filename counter. */
6886 * Delete the temp directory and all files it contains.
6888 void
6889 vim_deltempdir()
6891 char_u **files;
6892 int file_count;
6893 int i;
6895 if (vim_tempdir != NULL)
6897 sprintf((char *)NameBuff, "%s*", vim_tempdir);
6898 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
6899 EW_DIR|EW_FILE|EW_SILENT) == OK)
6901 for (i = 0; i < file_count; ++i)
6902 mch_remove(files[i]);
6903 FreeWild(file_count, files);
6905 gettail(NameBuff)[-1] = NUL;
6906 (void)mch_rmdir(NameBuff);
6908 vim_free(vim_tempdir);
6909 vim_tempdir = NULL;
6912 #endif
6915 * vim_tempname(): Return a unique name that can be used for a temp file.
6917 * The temp file is NOT created.
6919 * The returned pointer is to allocated memory.
6920 * The returned pointer is NULL if no valid name was found.
6922 /*ARGSUSED*/
6923 char_u *
6924 vim_tempname(extra_char)
6925 int extra_char; /* character to use in the name instead of '?' */
6927 #ifdef USE_TMPNAM
6928 char_u itmp[L_tmpnam]; /* use tmpnam() */
6929 #else
6930 char_u itmp[TEMPNAMELEN];
6931 #endif
6933 #ifdef TEMPDIRNAMES
6934 static char *(tempdirs[]) = {TEMPDIRNAMES};
6935 int i;
6936 long nr;
6937 long off;
6938 # ifndef EEXIST
6939 struct stat st;
6940 # endif
6943 * This will create a directory for private use by this instance of Vim.
6944 * This is done once, and the same directory is used for all temp files.
6945 * This method avoids security problems because of symlink attacks et al.
6946 * It's also a bit faster, because we only need to check for an existing
6947 * file when creating the directory and not for each temp file.
6949 if (vim_tempdir == NULL)
6952 * Try the entries in TEMPDIRNAMES to create the temp directory.
6954 for (i = 0; i < sizeof(tempdirs) / sizeof(char *); ++i)
6956 /* expand $TMP, leave room for "/v1100000/999999999" */
6957 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
6958 if (mch_isdir(itmp)) /* directory exists */
6960 # ifdef __EMX__
6961 /* If $TMP contains a forward slash (perhaps using bash or
6962 * tcsh), don't add a backslash, use a forward slash!
6963 * Adding 2 backslashes didn't work. */
6964 if (vim_strchr(itmp, '/') != NULL)
6965 STRCAT(itmp, "/");
6966 else
6967 # endif
6968 add_pathsep(itmp);
6970 /* Get an arbitrary number of up to 6 digits. When it's
6971 * unlikely that it already exists it will be faster,
6972 * otherwise it doesn't matter. The use of mkdir() avoids any
6973 * security problems because of the predictable number. */
6974 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
6976 /* Try up to 10000 different values until we find a name that
6977 * doesn't exist. */
6978 for (off = 0; off < 10000L; ++off)
6980 int r;
6981 #if defined(UNIX) || defined(VMS)
6982 mode_t umask_save;
6983 #endif
6985 sprintf((char *)itmp + STRLEN(itmp), "v%ld", nr + off);
6986 # ifndef EEXIST
6987 /* If mkdir() does not set errno to EEXIST, check for
6988 * existing file here. There is a race condition then,
6989 * although it's fail-safe. */
6990 if (mch_stat((char *)itmp, &st) >= 0)
6991 continue;
6992 # endif
6993 #if defined(UNIX) || defined(VMS)
6994 /* Make sure the umask doesn't remove the executable bit.
6995 * "repl" has been reported to use "177". */
6996 umask_save = umask(077);
6997 #endif
6998 r = vim_mkdir(itmp, 0700);
6999 #if defined(UNIX) || defined(VMS)
7000 (void)umask(umask_save);
7001 #endif
7002 if (r == 0)
7004 char_u *buf;
7006 /* Directory was created, use this name.
7007 * Expand to full path; When using the current
7008 * directory a ":cd" would confuse us. */
7009 buf = alloc((unsigned)MAXPATHL + 1);
7010 if (buf != NULL)
7012 if (vim_FullName(itmp, buf, MAXPATHL, FALSE)
7013 == FAIL)
7014 STRCPY(buf, itmp);
7015 # ifdef __EMX__
7016 if (vim_strchr(buf, '/') != NULL)
7017 STRCAT(buf, "/");
7018 else
7019 # endif
7020 add_pathsep(buf);
7021 vim_tempdir = vim_strsave(buf);
7022 vim_free(buf);
7024 break;
7026 # ifdef EEXIST
7027 /* If the mkdir() didn't fail because the file/dir exists,
7028 * we probably can't create any dir here, try another
7029 * place. */
7030 if (errno != EEXIST)
7031 # endif
7032 break;
7034 if (vim_tempdir != NULL)
7035 break;
7040 if (vim_tempdir != NULL)
7042 /* There is no need to check if the file exists, because we own the
7043 * directory and nobody else creates a file in it. */
7044 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
7045 return vim_strsave(itmp);
7048 return NULL;
7050 #else /* TEMPDIRNAMES */
7052 # ifdef WIN3264
7053 char szTempFile[_MAX_PATH + 1];
7054 char buf4[4];
7055 char_u *retval;
7056 char_u *p;
7058 STRCPY(itmp, "");
7059 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
7060 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
7061 strcpy(buf4, "VIM");
7062 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
7063 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
7064 return NULL;
7065 /* GetTempFileName() will create the file, we don't want that */
7066 (void)DeleteFile(itmp);
7068 /* Backslashes in a temp file name cause problems when filtering with
7069 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
7070 * didn't set 'shellslash'. */
7071 retval = vim_strsave(itmp);
7072 if (*p_shcf == '-' || p_ssl)
7073 for (p = retval; *p; ++p)
7074 if (*p == '\\')
7075 *p = '/';
7076 return retval;
7078 # else /* WIN3264 */
7080 # ifdef USE_TMPNAM
7081 /* tmpnam() will make its own name */
7082 if (*tmpnam((char *)itmp) == NUL)
7083 return NULL;
7084 # else
7085 char_u *p;
7087 # ifdef VMS_TEMPNAM
7088 /* mktemp() is not working on VMS. It seems to be
7089 * a do-nothing function. Therefore we use tempnam().
7091 sprintf((char *)itmp, "VIM%c", extra_char);
7092 p = (char_u *)tempnam("tmp:", (char *)itmp);
7093 if (p != NULL)
7095 /* VMS will use '.LOG' if we don't explicitly specify an extension,
7096 * and VIM will then be unable to find the file later */
7097 STRCPY(itmp, p);
7098 STRCAT(itmp, ".txt");
7099 free(p);
7101 else
7102 return NULL;
7103 # else
7104 STRCPY(itmp, TEMPNAME);
7105 if ((p = vim_strchr(itmp, '?')) != NULL)
7106 *p = extra_char;
7107 if (mktemp((char *)itmp) == NULL)
7108 return NULL;
7109 # endif
7110 # endif
7112 return vim_strsave(itmp);
7113 # endif /* WIN3264 */
7114 #endif /* TEMPDIRNAMES */
7117 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
7119 * Convert all backslashes in fname to forward slashes in-place.
7121 void
7122 forward_slash(fname)
7123 char_u *fname;
7125 char_u *p;
7127 for (p = fname; *p != NUL; ++p)
7128 # ifdef FEAT_MBYTE
7129 /* The Big5 encoding can have '\' in the trail byte. */
7130 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
7131 ++p;
7132 else
7133 # endif
7134 if (*p == '\\')
7135 *p = '/';
7137 #endif
7141 * Code for automatic commands.
7143 * Only included when "FEAT_AUTOCMD" has been defined.
7146 #if defined(FEAT_AUTOCMD) || defined(PROTO)
7149 * The autocommands are stored in a list for each event.
7150 * Autocommands for the same pattern, that are consecutive, are joined
7151 * together, to avoid having to match the pattern too often.
7152 * The result is an array of Autopat lists, which point to AutoCmd lists:
7154 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7155 * Autopat.cmds Autopat.cmds
7156 * | |
7157 * V V
7158 * AutoCmd.next AutoCmd.next
7159 * | |
7160 * V V
7161 * AutoCmd.next NULL
7164 * NULL
7166 * first_autopat[1] --> Autopat.next --> NULL
7167 * Autopat.cmds
7170 * AutoCmd.next
7173 * NULL
7174 * etc.
7176 * The order of AutoCmds is important, this is the order in which they were
7177 * defined and will have to be executed.
7179 typedef struct AutoCmd
7181 char_u *cmd; /* The command to be executed (NULL
7182 when command has been removed) */
7183 char nested; /* If autocommands nest here */
7184 char last; /* last command in list */
7185 #ifdef FEAT_EVAL
7186 scid_T scriptID; /* script ID where defined */
7187 #endif
7188 struct AutoCmd *next; /* Next AutoCmd in list */
7189 } AutoCmd;
7191 typedef struct AutoPat
7193 int group; /* group ID */
7194 char_u *pat; /* pattern as typed (NULL when pattern
7195 has been removed) */
7196 int patlen; /* strlen() of pat */
7197 regprog_T *reg_prog; /* compiled regprog for pattern */
7198 char allow_dirs; /* Pattern may match whole path */
7199 char last; /* last pattern for apply_autocmds() */
7200 AutoCmd *cmds; /* list of commands to do */
7201 struct AutoPat *next; /* next AutoPat in AutoPat list */
7202 int buflocal_nr; /* !=0 for buffer-local AutoPat */
7203 } AutoPat;
7205 static struct event_name
7207 char *name; /* event name */
7208 event_T event; /* event number */
7209 } event_names[] =
7211 {"BufAdd", EVENT_BUFADD},
7212 {"BufCreate", EVENT_BUFADD},
7213 {"BufDelete", EVENT_BUFDELETE},
7214 {"BufEnter", EVENT_BUFENTER},
7215 {"BufFilePost", EVENT_BUFFILEPOST},
7216 {"BufFilePre", EVENT_BUFFILEPRE},
7217 {"BufHidden", EVENT_BUFHIDDEN},
7218 {"BufLeave", EVENT_BUFLEAVE},
7219 {"BufNew", EVENT_BUFNEW},
7220 {"BufNewFile", EVENT_BUFNEWFILE},
7221 {"BufRead", EVENT_BUFREADPOST},
7222 {"BufReadCmd", EVENT_BUFREADCMD},
7223 {"BufReadPost", EVENT_BUFREADPOST},
7224 {"BufReadPre", EVENT_BUFREADPRE},
7225 {"BufUnload", EVENT_BUFUNLOAD},
7226 {"BufWinEnter", EVENT_BUFWINENTER},
7227 {"BufWinLeave", EVENT_BUFWINLEAVE},
7228 {"BufWipeout", EVENT_BUFWIPEOUT},
7229 {"BufWrite", EVENT_BUFWRITEPRE},
7230 {"BufWritePost", EVENT_BUFWRITEPOST},
7231 {"BufWritePre", EVENT_BUFWRITEPRE},
7232 {"BufWriteCmd", EVENT_BUFWRITECMD},
7233 {"CmdwinEnter", EVENT_CMDWINENTER},
7234 {"CmdwinLeave", EVENT_CMDWINLEAVE},
7235 {"ColorScheme", EVENT_COLORSCHEME},
7236 {"CursorHold", EVENT_CURSORHOLD},
7237 {"CursorHoldI", EVENT_CURSORHOLDI},
7238 {"CursorMoved", EVENT_CURSORMOVED},
7239 {"CursorMovedI", EVENT_CURSORMOVEDI},
7240 {"EncodingChanged", EVENT_ENCODINGCHANGED},
7241 {"FileEncoding", EVENT_ENCODINGCHANGED},
7242 {"FileAppendPost", EVENT_FILEAPPENDPOST},
7243 {"FileAppendPre", EVENT_FILEAPPENDPRE},
7244 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
7245 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
7246 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
7247 {"FileChangedRO", EVENT_FILECHANGEDRO},
7248 {"FileReadPost", EVENT_FILEREADPOST},
7249 {"FileReadPre", EVENT_FILEREADPRE},
7250 {"FileReadCmd", EVENT_FILEREADCMD},
7251 {"FileType", EVENT_FILETYPE},
7252 {"FileWritePost", EVENT_FILEWRITEPOST},
7253 {"FileWritePre", EVENT_FILEWRITEPRE},
7254 {"FileWriteCmd", EVENT_FILEWRITECMD},
7255 {"FilterReadPost", EVENT_FILTERREADPOST},
7256 {"FilterReadPre", EVENT_FILTERREADPRE},
7257 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7258 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7259 {"FocusGained", EVENT_FOCUSGAINED},
7260 {"FocusLost", EVENT_FOCUSLOST},
7261 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7262 {"GUIEnter", EVENT_GUIENTER},
7263 {"GUIFailed", EVENT_GUIFAILED},
7264 {"InsertChange", EVENT_INSERTCHANGE},
7265 {"InsertEnter", EVENT_INSERTENTER},
7266 {"InsertLeave", EVENT_INSERTLEAVE},
7267 {"MenuPopup", EVENT_MENUPOPUP},
7268 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7269 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7270 {"RemoteReply", EVENT_REMOTEREPLY},
7271 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7272 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7273 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7274 {"SourcePre", EVENT_SOURCEPRE},
7275 {"SourceCmd", EVENT_SOURCECMD},
7276 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7277 {"StdinReadPost", EVENT_STDINREADPOST},
7278 {"StdinReadPre", EVENT_STDINREADPRE},
7279 {"SwapExists", EVENT_SWAPEXISTS},
7280 {"Syntax", EVENT_SYNTAX},
7281 {"TabEnter", EVENT_TABENTER},
7282 {"TabLeave", EVENT_TABLEAVE},
7283 {"TermChanged", EVENT_TERMCHANGED},
7284 {"TermResponse", EVENT_TERMRESPONSE},
7285 {"User", EVENT_USER},
7286 {"VimEnter", EVENT_VIMENTER},
7287 {"VimLeave", EVENT_VIMLEAVE},
7288 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7289 {"WinEnter", EVENT_WINENTER},
7290 {"WinLeave", EVENT_WINLEAVE},
7291 {"VimResized", EVENT_VIMRESIZED},
7292 {NULL, (event_T)0}
7295 static AutoPat *first_autopat[NUM_EVENTS] =
7297 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7298 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7299 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7300 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7301 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7302 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7306 * struct used to keep status while executing autocommands for an event.
7308 typedef struct AutoPatCmd
7310 AutoPat *curpat; /* next AutoPat to examine */
7311 AutoCmd *nextcmd; /* next AutoCmd to execute */
7312 int group; /* group being used */
7313 char_u *fname; /* fname to match with */
7314 char_u *sfname; /* sfname to match with */
7315 char_u *tail; /* tail of fname */
7316 event_T event; /* current event */
7317 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7318 buf is deleted */
7319 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7320 } AutoPatCmd;
7322 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7325 * augroups stores a list of autocmd group names.
7327 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7328 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7331 * The ID of the current group. Group 0 is the default one.
7333 static int current_augroup = AUGROUP_DEFAULT;
7335 static int au_need_clean = FALSE; /* need to delete marked patterns */
7337 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7338 static void au_remove_pat __ARGS((AutoPat *ap));
7339 static void au_remove_cmds __ARGS((AutoPat *ap));
7340 static void au_cleanup __ARGS((void));
7341 static int au_new_group __ARGS((char_u *name));
7342 static void au_del_group __ARGS((char_u *name));
7343 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7344 static char_u *event_nr2name __ARGS((event_T event));
7345 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7346 static int event_ignored __ARGS((event_T event));
7347 static int au_get_grouparg __ARGS((char_u **argp));
7348 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7349 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7350 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));
7351 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7354 static event_T last_event;
7355 static int last_group;
7356 static int autocmd_blocked = 0; /* block all autocmds */
7359 * Show the autocommands for one AutoPat.
7361 static void
7362 show_autocmd(ap, event)
7363 AutoPat *ap;
7364 event_T event;
7366 AutoCmd *ac;
7368 /* Check for "got_int" (here and at various places below), which is set
7369 * when "q" has been hit for the "--more--" prompt */
7370 if (got_int)
7371 return;
7372 if (ap->pat == NULL) /* pattern has been removed */
7373 return;
7375 msg_putchar('\n');
7376 if (got_int)
7377 return;
7378 if (event != last_event || ap->group != last_group)
7380 if (ap->group != AUGROUP_DEFAULT)
7382 if (AUGROUP_NAME(ap->group) == NULL)
7383 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7384 else
7385 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7386 msg_puts((char_u *)" ");
7388 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7389 last_event = event;
7390 last_group = ap->group;
7391 msg_putchar('\n');
7392 if (got_int)
7393 return;
7395 msg_col = 4;
7396 msg_outtrans(ap->pat);
7398 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7400 if (ac->cmd != NULL) /* skip removed commands */
7402 if (msg_col >= 14)
7403 msg_putchar('\n');
7404 msg_col = 14;
7405 if (got_int)
7406 return;
7407 msg_outtrans(ac->cmd);
7408 #ifdef FEAT_EVAL
7409 if (p_verbose > 0)
7410 last_set_msg(ac->scriptID);
7411 #endif
7412 if (got_int)
7413 return;
7414 if (ac->next != NULL)
7416 msg_putchar('\n');
7417 if (got_int)
7418 return;
7425 * Mark an autocommand pattern for deletion.
7427 static void
7428 au_remove_pat(ap)
7429 AutoPat *ap;
7431 vim_free(ap->pat);
7432 ap->pat = NULL;
7433 ap->buflocal_nr = -1;
7434 au_need_clean = TRUE;
7438 * Mark all commands for a pattern for deletion.
7440 static void
7441 au_remove_cmds(ap)
7442 AutoPat *ap;
7444 AutoCmd *ac;
7446 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7448 vim_free(ac->cmd);
7449 ac->cmd = NULL;
7451 au_need_clean = TRUE;
7455 * Cleanup autocommands and patterns that have been deleted.
7456 * This is only done when not executing autocommands.
7458 static void
7459 au_cleanup()
7461 AutoPat *ap, **prev_ap;
7462 AutoCmd *ac, **prev_ac;
7463 event_T event;
7465 if (autocmd_busy || !au_need_clean)
7466 return;
7468 /* loop over all events */
7469 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7470 event = (event_T)((int)event + 1))
7472 /* loop over all autocommand patterns */
7473 prev_ap = &(first_autopat[(int)event]);
7474 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7476 /* loop over all commands for this pattern */
7477 prev_ac = &(ap->cmds);
7478 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7480 /* remove the command if the pattern is to be deleted or when
7481 * the command has been marked for deletion */
7482 if (ap->pat == NULL || ac->cmd == NULL)
7484 *prev_ac = ac->next;
7485 vim_free(ac->cmd);
7486 vim_free(ac);
7488 else
7489 prev_ac = &(ac->next);
7492 /* remove the pattern if it has been marked for deletion */
7493 if (ap->pat == NULL)
7495 *prev_ap = ap->next;
7496 vim_free(ap->reg_prog);
7497 vim_free(ap);
7499 else
7500 prev_ap = &(ap->next);
7504 au_need_clean = FALSE;
7508 * Called when buffer is freed, to remove/invalidate related buffer-local
7509 * autocmds.
7511 void
7512 aubuflocal_remove(buf)
7513 buf_T *buf;
7515 AutoPat *ap;
7516 event_T event;
7517 AutoPatCmd *apc;
7519 /* invalidate currently executing autocommands */
7520 for (apc = active_apc_list; apc; apc = apc->next)
7521 if (buf->b_fnum == apc->arg_bufnr)
7522 apc->arg_bufnr = 0;
7524 /* invalidate buflocals looping through events */
7525 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7526 event = (event_T)((int)event + 1))
7527 /* loop over all autocommand patterns */
7528 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7529 if (ap->buflocal_nr == buf->b_fnum)
7531 au_remove_pat(ap);
7532 if (p_verbose >= 6)
7534 verbose_enter();
7535 smsg((char_u *)
7536 _("auto-removing autocommand: %s <buffer=%d>"),
7537 event_nr2name(event), buf->b_fnum);
7538 verbose_leave();
7541 au_cleanup();
7545 * Add an autocmd group name.
7546 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7548 static int
7549 au_new_group(name)
7550 char_u *name;
7552 int i;
7554 i = au_find_group(name);
7555 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7557 /* First try using a free entry. */
7558 for (i = 0; i < augroups.ga_len; ++i)
7559 if (AUGROUP_NAME(i) == NULL)
7560 break;
7561 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7562 return AUGROUP_ERROR;
7564 AUGROUP_NAME(i) = vim_strsave(name);
7565 if (AUGROUP_NAME(i) == NULL)
7566 return AUGROUP_ERROR;
7567 if (i == augroups.ga_len)
7568 ++augroups.ga_len;
7571 return i;
7574 static void
7575 au_del_group(name)
7576 char_u *name;
7578 int i;
7580 i = au_find_group(name);
7581 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7582 EMSG2(_("E367: No such group: \"%s\""), name);
7583 else
7585 vim_free(AUGROUP_NAME(i));
7586 AUGROUP_NAME(i) = NULL;
7591 * Find the ID of an autocmd group name.
7592 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7594 static int
7595 au_find_group(name)
7596 char_u *name;
7598 int i;
7600 for (i = 0; i < augroups.ga_len; ++i)
7601 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7602 return i;
7603 return AUGROUP_ERROR;
7607 * Return TRUE if augroup "name" exists.
7610 au_has_group(name)
7611 char_u *name;
7613 return au_find_group(name) != AUGROUP_ERROR;
7617 * ":augroup {name}".
7619 void
7620 do_augroup(arg, del_group)
7621 char_u *arg;
7622 int del_group;
7624 int i;
7626 if (del_group)
7628 if (*arg == NUL)
7629 EMSG(_(e_argreq));
7630 else
7631 au_del_group(arg);
7633 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7634 current_augroup = AUGROUP_DEFAULT;
7635 else if (*arg) /* ":aug xxx": switch to group xxx */
7637 i = au_new_group(arg);
7638 if (i != AUGROUP_ERROR)
7639 current_augroup = i;
7641 else /* ":aug": list the group names */
7643 msg_start();
7644 for (i = 0; i < augroups.ga_len; ++i)
7646 if (AUGROUP_NAME(i) != NULL)
7648 msg_puts(AUGROUP_NAME(i));
7649 msg_puts((char_u *)" ");
7652 msg_clr_eos();
7653 msg_end();
7657 #if defined(EXITFREE) || defined(PROTO)
7658 void
7659 free_all_autocmds()
7661 for (current_augroup = -1; current_augroup < augroups.ga_len;
7662 ++current_augroup)
7663 do_autocmd((char_u *)"", TRUE);
7664 ga_clear_strings(&augroups);
7666 #endif
7669 * Return the event number for event name "start".
7670 * Return NUM_EVENTS if the event name was not found.
7671 * Return a pointer to the next event name in "end".
7673 static event_T
7674 event_name2nr(start, end)
7675 char_u *start;
7676 char_u **end;
7678 char_u *p;
7679 int i;
7680 int len;
7682 /* the event name ends with end of line, a blank or a comma */
7683 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7685 for (i = 0; event_names[i].name != NULL; ++i)
7687 len = (int)STRLEN(event_names[i].name);
7688 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7689 break;
7691 if (*p == ',')
7692 ++p;
7693 *end = p;
7694 if (event_names[i].name == NULL)
7695 return NUM_EVENTS;
7696 return event_names[i].event;
7700 * Return the name for event "event".
7702 static char_u *
7703 event_nr2name(event)
7704 event_T event;
7706 int i;
7708 for (i = 0; event_names[i].name != NULL; ++i)
7709 if (event_names[i].event == event)
7710 return (char_u *)event_names[i].name;
7711 return (char_u *)"Unknown";
7715 * Scan over the events. "*" stands for all events.
7717 static char_u *
7718 find_end_event(arg, have_group)
7719 char_u *arg;
7720 int have_group; /* TRUE when group name was found */
7722 char_u *pat;
7723 char_u *p;
7725 if (*arg == '*')
7727 if (arg[1] && !vim_iswhite(arg[1]))
7729 EMSG2(_("E215: Illegal character after *: %s"), arg);
7730 return NULL;
7732 pat = arg + 1;
7734 else
7736 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7738 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7740 if (have_group)
7741 EMSG2(_("E216: No such event: %s"), pat);
7742 else
7743 EMSG2(_("E216: No such group or event: %s"), pat);
7744 return NULL;
7748 return pat;
7752 * Return TRUE if "event" is included in 'eventignore'.
7754 static int
7755 event_ignored(event)
7756 event_T event;
7758 char_u *p = p_ei;
7760 while (*p != NUL)
7762 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7763 return TRUE;
7764 if (event_name2nr(p, &p) == event)
7765 return TRUE;
7768 return FALSE;
7772 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7775 check_ei()
7777 char_u *p = p_ei;
7779 while (*p)
7781 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7783 p += 3;
7784 if (*p == ',')
7785 ++p;
7787 else if (event_name2nr(p, &p) == NUM_EVENTS)
7788 return FAIL;
7791 return OK;
7794 # if defined(FEAT_SYN_HL) || defined(PROTO)
7797 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7798 * buffer loaded into the window. "what" must start with a comma.
7799 * Returns the old value of 'eventignore' in allocated memory.
7801 char_u *
7802 au_event_disable(what)
7803 char *what;
7805 char_u *new_ei;
7806 char_u *save_ei;
7808 save_ei = vim_strsave(p_ei);
7809 if (save_ei != NULL)
7811 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7812 if (new_ei != NULL)
7814 STRCAT(new_ei, what);
7815 set_string_option_direct((char_u *)"ei", -1, new_ei,
7816 OPT_FREE, SID_NONE);
7817 vim_free(new_ei);
7820 return save_ei;
7823 void
7824 au_event_restore(old_ei)
7825 char_u *old_ei;
7827 if (old_ei != NULL)
7829 set_string_option_direct((char_u *)"ei", -1, old_ei,
7830 OPT_FREE, SID_NONE);
7831 vim_free(old_ei);
7834 # endif /* FEAT_SYN_HL */
7837 * do_autocmd() -- implements the :autocmd command. Can be used in the
7838 * following ways:
7840 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7841 * will be automatically executed for <event>
7842 * when editing a file matching <pat>, in
7843 * the current group.
7844 * :autocmd <event> <pat> Show the auto-commands associated with
7845 * <event> and <pat>.
7846 * :autocmd <event> Show the auto-commands associated with
7847 * <event>.
7848 * :autocmd Show all auto-commands.
7849 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7850 * <event> and <pat>, and add the command
7851 * <cmd>, for the current group.
7852 * :autocmd! <event> <pat> Remove all auto-commands associated with
7853 * <event> and <pat> for the current group.
7854 * :autocmd! <event> Remove all auto-commands associated with
7855 * <event> for the current group.
7856 * :autocmd! Remove ALL auto-commands for the current
7857 * group.
7859 * Multiple events and patterns may be given separated by commas. Here are
7860 * some examples:
7861 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7862 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7864 * :autocmd * *.c show all autocommands for *.c files.
7866 * Mostly a {group} argument can optionally appear before <event>.
7868 void
7869 do_autocmd(arg, forceit)
7870 char_u *arg;
7871 int forceit;
7873 char_u *pat;
7874 char_u *envpat = NULL;
7875 char_u *cmd;
7876 event_T event;
7877 int need_free = FALSE;
7878 int nested = FALSE;
7879 int group;
7882 * Check for a legal group name. If not, use AUGROUP_ALL.
7884 group = au_get_grouparg(&arg);
7885 if (arg == NULL) /* out of memory */
7886 return;
7889 * Scan over the events.
7890 * If we find an illegal name, return here, don't do anything.
7892 pat = find_end_event(arg, group != AUGROUP_ALL);
7893 if (pat == NULL)
7894 return;
7897 * Scan over the pattern. Put a NUL at the end.
7899 pat = skipwhite(pat);
7900 cmd = pat;
7901 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
7902 cmd++;
7903 if (*cmd)
7904 *cmd++ = NUL;
7906 /* Expand environment variables in the pattern. Set 'shellslash', we want
7907 * forward slashes here. */
7908 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
7910 #ifdef BACKSLASH_IN_FILENAME
7911 int p_ssl_save = p_ssl;
7913 p_ssl = TRUE;
7914 #endif
7915 envpat = expand_env_save(pat);
7916 #ifdef BACKSLASH_IN_FILENAME
7917 p_ssl = p_ssl_save;
7918 #endif
7919 if (envpat != NULL)
7920 pat = envpat;
7924 * Check for "nested" flag.
7926 cmd = skipwhite(cmd);
7927 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
7929 nested = TRUE;
7930 cmd = skipwhite(cmd + 6);
7934 * Find the start of the commands.
7935 * Expand <sfile> in it.
7937 if (*cmd != NUL)
7939 cmd = expand_sfile(cmd);
7940 if (cmd == NULL) /* some error */
7941 return;
7942 need_free = TRUE;
7946 * Print header when showing autocommands.
7948 if (!forceit && *cmd == NUL)
7950 /* Highlight title */
7951 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7955 * Loop over the events.
7957 last_event = (event_T)-1; /* for listing the event name */
7958 last_group = AUGROUP_ERROR; /* for listing the group name */
7959 if (*arg == '*' || *arg == NUL)
7961 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7962 event = (event_T)((int)event + 1))
7963 if (do_autocmd_event(event, pat,
7964 nested, cmd, forceit, group) == FAIL)
7965 break;
7967 else
7969 while (*arg && !vim_iswhite(*arg))
7970 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
7971 nested, cmd, forceit, group) == FAIL)
7972 break;
7975 if (need_free)
7976 vim_free(cmd);
7977 vim_free(envpat);
7981 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
7982 * The "argp" argument is advanced to the following argument.
7984 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
7986 static int
7987 au_get_grouparg(argp)
7988 char_u **argp;
7990 char_u *group_name;
7991 char_u *p;
7992 char_u *arg = *argp;
7993 int group = AUGROUP_ALL;
7995 p = skiptowhite(arg);
7996 if (p > arg)
7998 group_name = vim_strnsave(arg, (int)(p - arg));
7999 if (group_name == NULL) /* out of memory */
8000 return AUGROUP_ERROR;
8001 group = au_find_group(group_name);
8002 if (group == AUGROUP_ERROR)
8003 group = AUGROUP_ALL; /* no match, use all groups */
8004 else
8005 *argp = skipwhite(p); /* match, skip over group name */
8006 vim_free(group_name);
8008 return group;
8012 * do_autocmd() for one event.
8013 * If *pat == NUL do for all patterns.
8014 * If *cmd == NUL show entries.
8015 * If forceit == TRUE delete entries.
8016 * If group is not AUGROUP_ALL, only use this group.
8018 static int
8019 do_autocmd_event(event, pat, nested, cmd, forceit, group)
8020 event_T event;
8021 char_u *pat;
8022 int nested;
8023 char_u *cmd;
8024 int forceit;
8025 int group;
8027 AutoPat *ap;
8028 AutoPat **prev_ap;
8029 AutoCmd *ac;
8030 AutoCmd **prev_ac;
8031 int brace_level;
8032 char_u *endpat;
8033 int findgroup;
8034 int allgroups;
8035 int patlen;
8036 int is_buflocal;
8037 int buflocal_nr;
8038 char_u buflocal_pat[25]; /* for "<buffer=X>" */
8040 if (group == AUGROUP_ALL)
8041 findgroup = current_augroup;
8042 else
8043 findgroup = group;
8044 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
8047 * Show or delete all patterns for an event.
8049 if (*pat == NUL)
8051 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
8053 if (forceit) /* delete the AutoPat, if it's in the current group */
8055 if (ap->group == findgroup)
8056 au_remove_pat(ap);
8058 else if (group == AUGROUP_ALL || ap->group == group)
8059 show_autocmd(ap, event);
8064 * Loop through all the specified patterns.
8066 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
8069 * Find end of the pattern.
8070 * Watch out for a comma in braces, like "*.\{obj,o\}".
8072 brace_level = 0;
8073 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
8074 || endpat[-1] == '\\'); ++endpat)
8076 if (*endpat == '{')
8077 brace_level++;
8078 else if (*endpat == '}')
8079 brace_level--;
8081 if (pat == endpat) /* ignore single comma */
8082 continue;
8083 patlen = (int)(endpat - pat);
8086 * detect special <buflocal[=X]> buffer-local patterns
8088 is_buflocal = FALSE;
8089 buflocal_nr = 0;
8091 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
8092 && pat[patlen - 1] == '>')
8094 /* Error will be printed only for addition. printing and removing
8095 * will proceed silently. */
8096 is_buflocal = TRUE;
8097 if (patlen == 8)
8098 buflocal_nr = curbuf->b_fnum;
8099 else if (patlen > 9 && pat[7] == '=')
8101 /* <buffer=abuf> */
8102 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
8103 buflocal_nr = autocmd_bufnr;
8104 /* <buffer=123> */
8105 else if (skipdigits(pat + 8) == pat + patlen - 1)
8106 buflocal_nr = atoi((char *)pat + 8);
8110 if (is_buflocal)
8112 /* normalize pat into standard "<buffer>#N" form */
8113 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
8114 pat = buflocal_pat; /* can modify pat and patlen */
8115 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
8119 * Find AutoPat entries with this pattern.
8121 prev_ap = &first_autopat[(int)event];
8122 while ((ap = *prev_ap) != NULL)
8124 if (ap->pat != NULL)
8126 /* Accept a pattern when:
8127 * - a group was specified and it's that group, or a group was
8128 * not specified and it's the current group, or a group was
8129 * not specified and we are listing
8130 * - the length of the pattern matches
8131 * - the pattern matches.
8132 * For <buffer[=X]>, this condition works because we normalize
8133 * all buffer-local patterns.
8135 if ((allgroups || ap->group == findgroup)
8136 && ap->patlen == patlen
8137 && STRNCMP(pat, ap->pat, patlen) == 0)
8140 * Remove existing autocommands.
8141 * If adding any new autocmd's for this AutoPat, don't
8142 * delete the pattern from the autopat list, append to
8143 * this list.
8145 if (forceit)
8147 if (*cmd != NUL && ap->next == NULL)
8149 au_remove_cmds(ap);
8150 break;
8152 au_remove_pat(ap);
8156 * Show autocmd's for this autopat, or buflocals <buffer=X>
8158 else if (*cmd == NUL)
8159 show_autocmd(ap, event);
8162 * Add autocmd to this autopat, if it's the last one.
8164 else if (ap->next == NULL)
8165 break;
8168 prev_ap = &ap->next;
8172 * Add a new command.
8174 if (*cmd != NUL)
8177 * If the pattern we want to add a command to does appear at the
8178 * end of the list (or not is not in the list at all), add the
8179 * pattern at the end of the list.
8181 if (ap == NULL)
8183 /* refuse to add buffer-local ap if buffer number is invalid */
8184 if (is_buflocal && (buflocal_nr == 0
8185 || buflist_findnr(buflocal_nr) == NULL))
8187 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8188 buflocal_nr);
8189 return FAIL;
8192 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
8193 if (ap == NULL)
8194 return FAIL;
8195 ap->pat = vim_strnsave(pat, patlen);
8196 ap->patlen = patlen;
8197 if (ap->pat == NULL)
8199 vim_free(ap);
8200 return FAIL;
8203 if (is_buflocal)
8205 ap->buflocal_nr = buflocal_nr;
8206 ap->reg_prog = NULL;
8208 else
8210 char_u *reg_pat;
8212 ap->buflocal_nr = 0;
8213 reg_pat = file_pat_to_reg_pat(pat, endpat,
8214 &ap->allow_dirs, TRUE);
8215 if (reg_pat != NULL)
8216 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
8217 vim_free(reg_pat);
8218 if (reg_pat == NULL || ap->reg_prog == NULL)
8220 vim_free(ap->pat);
8221 vim_free(ap);
8222 return FAIL;
8225 ap->cmds = NULL;
8226 *prev_ap = ap;
8227 ap->next = NULL;
8228 if (group == AUGROUP_ALL)
8229 ap->group = current_augroup;
8230 else
8231 ap->group = group;
8235 * Add the autocmd at the end of the AutoCmd list.
8237 prev_ac = &(ap->cmds);
8238 while ((ac = *prev_ac) != NULL)
8239 prev_ac = &ac->next;
8240 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
8241 if (ac == NULL)
8242 return FAIL;
8243 ac->cmd = vim_strsave(cmd);
8244 #ifdef FEAT_EVAL
8245 ac->scriptID = current_SID;
8246 #endif
8247 if (ac->cmd == NULL)
8249 vim_free(ac);
8250 return FAIL;
8252 ac->next = NULL;
8253 *prev_ac = ac;
8254 ac->nested = nested;
8258 au_cleanup(); /* may really delete removed patterns/commands now */
8259 return OK;
8263 * Implementation of ":doautocmd [group] event [fname]".
8264 * Return OK for success, FAIL for failure;
8267 do_doautocmd(arg, do_msg)
8268 char_u *arg;
8269 int do_msg; /* give message for no matching autocmds? */
8271 char_u *fname;
8272 int nothing_done = TRUE;
8273 int group;
8276 * Check for a legal group name. If not, use AUGROUP_ALL.
8278 group = au_get_grouparg(&arg);
8279 if (arg == NULL) /* out of memory */
8280 return FAIL;
8282 if (*arg == '*')
8284 EMSG(_("E217: Can't execute autocommands for ALL events"));
8285 return FAIL;
8289 * Scan over the events.
8290 * If we find an illegal name, return here, don't do anything.
8292 fname = find_end_event(arg, group != AUGROUP_ALL);
8293 if (fname == NULL)
8294 return FAIL;
8296 fname = skipwhite(fname);
8299 * Loop over the events.
8301 while (*arg && !vim_iswhite(*arg))
8302 if (apply_autocmds_group(event_name2nr(arg, &arg),
8303 fname, NULL, TRUE, group, curbuf, NULL))
8304 nothing_done = FALSE;
8306 if (nothing_done && do_msg)
8307 MSG(_("No matching autocommands"));
8309 #ifdef FEAT_EVAL
8310 return aborting() ? FAIL : OK;
8311 #else
8312 return OK;
8313 #endif
8317 * ":doautoall": execute autocommands for each loaded buffer.
8319 void
8320 ex_doautoall(eap)
8321 exarg_T *eap;
8323 int retval;
8324 aco_save_T aco;
8325 buf_T *buf;
8328 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8329 * equal to curbuf, but for some buffers there may not be a window.
8330 * So we change the buffer for the current window for a moment. This
8331 * gives problems when the autocommands make changes to the list of
8332 * buffers or windows...
8334 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8336 if (buf->b_ml.ml_mfp != NULL)
8338 /* find a window for this buffer and save some values */
8339 aucmd_prepbuf(&aco, buf);
8341 /* execute the autocommands for this buffer */
8342 retval = do_doautocmd(eap->arg, FALSE);
8344 /* Execute the modeline settings, but don't set window-local
8345 * options if we are using the current window for another buffer. */
8346 do_modelines(aco.save_curwin == NULL ? OPT_NOWIN : 0);
8348 /* restore the current window */
8349 aucmd_restbuf(&aco);
8351 /* stop if there is some error or buffer was deleted */
8352 if (retval == FAIL || !buf_valid(buf))
8353 break;
8357 check_cursor(); /* just in case lines got deleted */
8361 * Prepare for executing autocommands for (hidden) buffer "buf".
8362 * Search a window for the current buffer. Save the cursor position and
8363 * screen offset.
8364 * Set "curbuf" and "curwin" to match "buf".
8365 * When FEAT_AUTOCMD is not defined another version is used, see below.
8367 void
8368 aucmd_prepbuf(aco, buf)
8369 aco_save_T *aco; /* structure to save values in */
8370 buf_T *buf; /* new curbuf */
8372 win_T *win;
8374 aco->new_curbuf = buf;
8376 /* Find a window that is for the new buffer */
8377 if (buf == curbuf) /* be quick when buf is curbuf */
8378 win = curwin;
8379 else
8380 #ifdef FEAT_WINDOWS
8381 for (win = firstwin; win != NULL; win = win->w_next)
8382 if (win->w_buffer == buf)
8383 break;
8384 #else
8385 win = NULL;
8386 #endif
8389 * Prefer to use an existing window for the buffer, it has the least side
8390 * effects (esp. if "buf" is curbuf).
8391 * Otherwise, use curwin for "buf". It might make some items in the
8392 * window invalid. At least save the cursor and topline.
8394 if (win != NULL)
8396 /* there is a window for "buf", make it the curwin */
8397 aco->save_curwin = curwin;
8398 curwin = win;
8399 aco->save_buf = win->w_buffer;
8400 aco->new_curwin = win;
8402 else
8404 /* there is no window for "buf", use curwin */
8405 aco->save_curwin = NULL;
8406 aco->save_buf = curbuf;
8407 --curbuf->b_nwindows;
8408 curwin->w_buffer = buf;
8409 ++buf->b_nwindows;
8411 /* save cursor and topline, set them to safe values */
8412 aco->save_cursor = curwin->w_cursor;
8413 curwin->w_cursor.lnum = 1;
8414 curwin->w_cursor.col = 0;
8415 aco->save_topline = curwin->w_topline;
8416 curwin->w_topline = 1;
8417 #ifdef FEAT_DIFF
8418 aco->save_topfill = curwin->w_topfill;
8419 curwin->w_topfill = 0;
8420 #endif
8423 curbuf = buf;
8427 * Cleanup after executing autocommands for a (hidden) buffer.
8428 * Restore the window as it was (if possible).
8429 * When FEAT_AUTOCMD is not defined another version is used, see below.
8431 void
8432 aucmd_restbuf(aco)
8433 aco_save_T *aco; /* structure holding saved values */
8435 if (aco->save_curwin != NULL)
8437 /* restore curwin */
8438 #ifdef FEAT_WINDOWS
8439 if (win_valid(aco->save_curwin))
8440 #endif
8442 /* restore the buffer which was previously edited by curwin, if
8443 * it's still the same window and it's valid */
8444 if (curwin == aco->new_curwin
8445 && buf_valid(aco->save_buf)
8446 && aco->save_buf->b_ml.ml_mfp != NULL)
8448 --curbuf->b_nwindows;
8449 curbuf = aco->save_buf;
8450 curwin->w_buffer = curbuf;
8451 ++curbuf->b_nwindows;
8454 curwin = aco->save_curwin;
8455 curbuf = curwin->w_buffer;
8458 else
8460 /* restore buffer for curwin if it still exists and is loaded */
8461 if (buf_valid(aco->save_buf) && aco->save_buf->b_ml.ml_mfp != NULL)
8463 --curbuf->b_nwindows;
8464 curbuf = aco->save_buf;
8465 curwin->w_buffer = curbuf;
8466 ++curbuf->b_nwindows;
8467 curwin->w_cursor = aco->save_cursor;
8468 check_cursor();
8469 /* check topline < line_count, in case lines got deleted */
8470 if (aco->save_topline <= curbuf->b_ml.ml_line_count)
8472 curwin->w_topline = aco->save_topline;
8473 #ifdef FEAT_DIFF
8474 curwin->w_topfill = aco->save_topfill;
8475 #endif
8477 else
8479 curwin->w_topline = curbuf->b_ml.ml_line_count;
8480 #ifdef FEAT_DIFF
8481 curwin->w_topfill = 0;
8482 #endif
8488 static int autocmd_nested = FALSE;
8491 * Execute autocommands for "event" and file name "fname".
8492 * Return TRUE if some commands were executed.
8495 apply_autocmds(event, fname, fname_io, force, buf)
8496 event_T event;
8497 char_u *fname; /* NULL or empty means use actual file name */
8498 char_u *fname_io; /* fname to use for <afile> on cmdline */
8499 int force; /* when TRUE, ignore autocmd_busy */
8500 buf_T *buf; /* buffer for <abuf> */
8502 return apply_autocmds_group(event, fname, fname_io, force,
8503 AUGROUP_ALL, buf, NULL);
8507 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8508 * setting v:filearg.
8510 static int
8511 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8512 event_T event;
8513 char_u *fname;
8514 char_u *fname_io;
8515 int force;
8516 buf_T *buf;
8517 exarg_T *eap;
8519 return apply_autocmds_group(event, fname, fname_io, force,
8520 AUGROUP_ALL, buf, eap);
8524 * Like apply_autocmds(), but handles the caller's retval. If the script
8525 * processing is being aborted or if retval is FAIL when inside a try
8526 * conditional, no autocommands are executed. If otherwise the autocommands
8527 * cause the script to be aborted, retval is set to FAIL.
8530 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8531 event_T event;
8532 char_u *fname; /* NULL or empty means use actual file name */
8533 char_u *fname_io; /* fname to use for <afile> on cmdline */
8534 int force; /* when TRUE, ignore autocmd_busy */
8535 buf_T *buf; /* buffer for <abuf> */
8536 int *retval; /* pointer to caller's retval */
8538 int did_cmd;
8540 #ifdef FEAT_EVAL
8541 if (should_abort(*retval))
8542 return FALSE;
8543 #endif
8545 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8546 AUGROUP_ALL, buf, NULL);
8547 if (did_cmd
8548 #ifdef FEAT_EVAL
8549 && aborting()
8550 #endif
8552 *retval = FAIL;
8553 return did_cmd;
8557 * Return TRUE when there is a CursorHold autocommand defined.
8560 has_cursorhold()
8562 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8563 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8567 * Return TRUE if the CursorHold event can be triggered.
8570 trigger_cursorhold()
8572 int state;
8574 if (!did_cursorhold && has_cursorhold() && !Recording
8575 #ifdef FEAT_INS_EXPAND
8576 && !ins_compl_active()
8577 #endif
8580 state = get_real_state();
8581 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8582 return TRUE;
8584 return FALSE;
8588 * Return TRUE when there is a CursorMoved autocommand defined.
8591 has_cursormoved()
8593 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8597 * Return TRUE when there is a CursorMovedI autocommand defined.
8600 has_cursormovedI()
8602 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8605 static int
8606 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8607 event_T event;
8608 char_u *fname; /* NULL or empty means use actual file name */
8609 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8610 use fname */
8611 int force; /* when TRUE, ignore autocmd_busy */
8612 int group; /* group ID, or AUGROUP_ALL */
8613 buf_T *buf; /* buffer for <abuf> */
8614 exarg_T *eap; /* command arguments */
8616 char_u *sfname = NULL; /* short file name */
8617 char_u *tail;
8618 int save_changed;
8619 buf_T *old_curbuf;
8620 int retval = FALSE;
8621 char_u *save_sourcing_name;
8622 linenr_T save_sourcing_lnum;
8623 char_u *save_autocmd_fname;
8624 int save_autocmd_fname_full;
8625 int save_autocmd_bufnr;
8626 char_u *save_autocmd_match;
8627 int save_autocmd_busy;
8628 int save_autocmd_nested;
8629 static int nesting = 0;
8630 AutoPatCmd patcmd;
8631 AutoPat *ap;
8632 #ifdef FEAT_EVAL
8633 scid_T save_current_SID;
8634 void *save_funccalp;
8635 char_u *save_cmdarg;
8636 long save_cmdbang;
8637 #endif
8638 static int filechangeshell_busy = FALSE;
8639 #ifdef FEAT_PROFILE
8640 proftime_T wait_time;
8641 #endif
8644 * Quickly return if there are no autocommands for this event or
8645 * autocommands are blocked.
8647 if (first_autopat[(int)event] == NULL || autocmd_blocked > 0)
8648 goto BYPASS_AU;
8651 * When autocommands are busy, new autocommands are only executed when
8652 * explicitly enabled with the "nested" flag.
8654 if (autocmd_busy && !(force || autocmd_nested))
8655 goto BYPASS_AU;
8657 #ifdef FEAT_EVAL
8659 * Quickly return when immediately aborting on error, or when an interrupt
8660 * occurred or an exception was thrown but not caught.
8662 if (aborting())
8663 goto BYPASS_AU;
8664 #endif
8667 * FileChangedShell never nests, because it can create an endless loop.
8669 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8670 || event == EVENT_FILECHANGEDSHELLPOST))
8671 goto BYPASS_AU;
8674 * Ignore events in 'eventignore'.
8676 if (event_ignored(event))
8677 goto BYPASS_AU;
8680 * Allow nesting of autocommands, but restrict the depth, because it's
8681 * possible to create an endless loop.
8683 if (nesting == 10)
8685 EMSG(_("E218: autocommand nesting too deep"));
8686 goto BYPASS_AU;
8690 * Check if these autocommands are disabled. Used when doing ":all" or
8691 * ":ball".
8693 if ( (autocmd_no_enter
8694 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8695 || (autocmd_no_leave
8696 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8697 goto BYPASS_AU;
8700 * Save the autocmd_* variables and info about the current buffer.
8702 save_autocmd_fname = autocmd_fname;
8703 save_autocmd_fname_full = autocmd_fname_full;
8704 save_autocmd_bufnr = autocmd_bufnr;
8705 save_autocmd_match = autocmd_match;
8706 save_autocmd_busy = autocmd_busy;
8707 save_autocmd_nested = autocmd_nested;
8708 save_changed = curbuf->b_changed;
8709 old_curbuf = curbuf;
8712 * Set the file name to be used for <afile>.
8713 * Make a copy to avoid that changing a buffer name or directory makes it
8714 * invalid.
8716 if (fname_io == NULL)
8718 if (fname != NULL && *fname != NUL)
8719 autocmd_fname = fname;
8720 else if (buf != NULL)
8721 autocmd_fname = buf->b_ffname;
8722 else
8723 autocmd_fname = NULL;
8725 else
8726 autocmd_fname = fname_io;
8727 if (autocmd_fname != NULL)
8728 autocmd_fname = vim_strsave(autocmd_fname);
8729 autocmd_fname_full = FALSE; /* call FullName_save() later */
8732 * Set the buffer number to be used for <abuf>.
8734 if (buf == NULL)
8735 autocmd_bufnr = 0;
8736 else
8737 autocmd_bufnr = buf->b_fnum;
8740 * When the file name is NULL or empty, use the file name of buffer "buf".
8741 * Always use the full path of the file name to match with, in case
8742 * "allow_dirs" is set.
8744 if (fname == NULL || *fname == NUL)
8746 if (buf == NULL)
8747 fname = NULL;
8748 else
8750 #ifdef FEAT_SYN_HL
8751 if (event == EVENT_SYNTAX)
8752 fname = buf->b_p_syn;
8753 else
8754 #endif
8755 if (event == EVENT_FILETYPE)
8756 fname = buf->b_p_ft;
8757 else
8759 if (buf->b_sfname != NULL)
8760 sfname = vim_strsave(buf->b_sfname);
8761 fname = buf->b_ffname;
8764 if (fname == NULL)
8765 fname = (char_u *)"";
8766 fname = vim_strsave(fname); /* make a copy, so we can change it */
8768 else
8770 sfname = vim_strsave(fname);
8771 /* Don't try expanding FileType, Syntax, WindowID or QuickFixCmd* */
8772 if (event == EVENT_FILETYPE
8773 || event == EVENT_SYNTAX
8774 || event == EVENT_REMOTEREPLY
8775 || event == EVENT_SPELLFILEMISSING
8776 || event == EVENT_QUICKFIXCMDPRE
8777 || event == EVENT_QUICKFIXCMDPOST)
8778 fname = vim_strsave(fname);
8779 else
8780 fname = FullName_save(fname, FALSE);
8782 if (fname == NULL) /* out of memory */
8784 vim_free(sfname);
8785 retval = FALSE;
8786 goto BYPASS_AU;
8789 #ifdef BACKSLASH_IN_FILENAME
8791 * Replace all backslashes with forward slashes. This makes the
8792 * autocommand patterns portable between Unix and MS-DOS.
8794 if (sfname != NULL)
8795 forward_slash(sfname);
8796 forward_slash(fname);
8797 #endif
8799 #ifdef VMS
8800 /* remove version for correct match */
8801 if (sfname != NULL)
8802 vms_remove_version(sfname);
8803 vms_remove_version(fname);
8804 #endif
8807 * Set the name to be used for <amatch>.
8809 autocmd_match = fname;
8812 /* Don't redraw while doing auto commands. */
8813 ++RedrawingDisabled;
8814 save_sourcing_name = sourcing_name;
8815 sourcing_name = NULL; /* don't free this one */
8816 save_sourcing_lnum = sourcing_lnum;
8817 sourcing_lnum = 0; /* no line number here */
8819 #ifdef FEAT_EVAL
8820 save_current_SID = current_SID;
8822 # ifdef FEAT_PROFILE
8823 if (do_profiling == PROF_YES)
8824 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
8825 # endif
8827 /* Don't use local function variables, if called from a function */
8828 save_funccalp = save_funccal();
8829 #endif
8832 * When starting to execute autocommands, save the search patterns.
8834 if (!autocmd_busy)
8836 save_search_patterns();
8837 saveRedobuff();
8838 did_filetype = keep_filetype;
8842 * Note that we are applying autocmds. Some commands need to know.
8844 autocmd_busy = TRUE;
8845 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
8846 ++nesting; /* see matching decrement below */
8848 /* Remember that FileType was triggered. Used for did_filetype(). */
8849 if (event == EVENT_FILETYPE)
8850 did_filetype = TRUE;
8852 tail = gettail(fname);
8854 /* Find first autocommand that matches */
8855 patcmd.curpat = first_autopat[(int)event];
8856 patcmd.nextcmd = NULL;
8857 patcmd.group = group;
8858 patcmd.fname = fname;
8859 patcmd.sfname = sfname;
8860 patcmd.tail = tail;
8861 patcmd.event = event;
8862 patcmd.arg_bufnr = autocmd_bufnr;
8863 patcmd.next = NULL;
8864 auto_next_pat(&patcmd, FALSE);
8866 /* found one, start executing the autocommands */
8867 if (patcmd.curpat != NULL)
8869 /* add to active_apc_list */
8870 patcmd.next = active_apc_list;
8871 active_apc_list = &patcmd;
8873 #ifdef FEAT_EVAL
8874 /* set v:cmdarg (only when there is a matching pattern) */
8875 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
8876 if (eap != NULL)
8878 save_cmdarg = set_cmdarg(eap, NULL);
8879 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
8881 else
8882 save_cmdarg = NULL; /* avoid gcc warning */
8883 #endif
8884 retval = TRUE;
8885 /* mark the last pattern, to avoid an endless loop when more patterns
8886 * are added when executing autocommands */
8887 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
8888 ap->last = FALSE;
8889 ap->last = TRUE;
8890 check_lnums(TRUE); /* make sure cursor and topline are valid */
8891 do_cmdline(NULL, getnextac, (void *)&patcmd,
8892 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
8893 #ifdef FEAT_EVAL
8894 if (eap != NULL)
8896 (void)set_cmdarg(NULL, save_cmdarg);
8897 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
8899 #endif
8900 /* delete from active_apc_list */
8901 if (active_apc_list == &patcmd) /* just in case */
8902 active_apc_list = patcmd.next;
8905 --RedrawingDisabled;
8906 autocmd_busy = save_autocmd_busy;
8907 filechangeshell_busy = FALSE;
8908 autocmd_nested = save_autocmd_nested;
8909 vim_free(sourcing_name);
8910 sourcing_name = save_sourcing_name;
8911 sourcing_lnum = save_sourcing_lnum;
8912 vim_free(autocmd_fname);
8913 autocmd_fname = save_autocmd_fname;
8914 autocmd_fname_full = save_autocmd_fname_full;
8915 autocmd_bufnr = save_autocmd_bufnr;
8916 autocmd_match = save_autocmd_match;
8917 #ifdef FEAT_EVAL
8918 current_SID = save_current_SID;
8919 restore_funccal(save_funccalp);
8920 # ifdef FEAT_PROFILE
8921 if (do_profiling == PROF_YES)
8922 prof_child_exit(&wait_time);
8923 # endif
8924 #endif
8925 vim_free(fname);
8926 vim_free(sfname);
8927 --nesting; /* see matching increment above */
8930 * When stopping to execute autocommands, restore the search patterns and
8931 * the redo buffer.
8933 if (!autocmd_busy)
8935 restore_search_patterns();
8936 restoreRedobuff();
8937 did_filetype = FALSE;
8941 * Some events don't set or reset the Changed flag.
8942 * Check if still in the same buffer!
8944 if (curbuf == old_curbuf
8945 && (event == EVENT_BUFREADPOST
8946 || event == EVENT_BUFWRITEPOST
8947 || event == EVENT_FILEAPPENDPOST
8948 || event == EVENT_VIMLEAVE
8949 || event == EVENT_VIMLEAVEPRE))
8951 #ifdef FEAT_TITLE
8952 if (curbuf->b_changed != save_changed)
8953 need_maketitle = TRUE;
8954 #endif
8955 curbuf->b_changed = save_changed;
8958 au_cleanup(); /* may really delete removed patterns/commands now */
8960 BYPASS_AU:
8961 /* When wiping out a buffer make sure all its buffer-local autocommands
8962 * are deleted. */
8963 if (event == EVENT_BUFWIPEOUT && buf != NULL)
8964 aubuflocal_remove(buf);
8966 return retval;
8969 # ifdef FEAT_EVAL
8970 static char_u *old_termresponse = NULL;
8971 # endif
8974 * Block triggering autocommands until unblock_autocmd() is called.
8975 * Can be used recursively, so long as it's symmetric.
8977 void
8978 block_autocmds()
8980 # ifdef FEAT_EVAL
8981 /* Remember the value of v:termresponse. */
8982 if (autocmd_blocked == 0)
8983 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
8984 # endif
8985 ++autocmd_blocked;
8988 void
8989 unblock_autocmds()
8991 --autocmd_blocked;
8993 # ifdef FEAT_EVAL
8994 /* When v:termresponse was set while autocommands were blocked, trigger
8995 * the autocommands now. Esp. useful when executing a shell command
8996 * during startup (vimdiff). */
8997 if (autocmd_blocked == 0
8998 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
8999 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
9000 # endif
9004 * Find next autocommand pattern that matches.
9006 static void
9007 auto_next_pat(apc, stop_at_last)
9008 AutoPatCmd *apc;
9009 int stop_at_last; /* stop when 'last' flag is set */
9011 AutoPat *ap;
9012 AutoCmd *cp;
9013 char_u *name;
9014 char *s;
9016 vim_free(sourcing_name);
9017 sourcing_name = NULL;
9019 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
9021 apc->curpat = NULL;
9023 /* Only use a pattern when it has not been removed, has commands and
9024 * the group matches. For buffer-local autocommands only check the
9025 * buffer number. */
9026 if (ap->pat != NULL && ap->cmds != NULL
9027 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
9029 /* execution-condition */
9030 if (ap->buflocal_nr == 0
9031 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
9032 apc->sfname, apc->tail, ap->allow_dirs))
9033 : ap->buflocal_nr == apc->arg_bufnr)
9035 name = event_nr2name(apc->event);
9036 s = _("%s Auto commands for \"%s\"");
9037 sourcing_name = alloc((unsigned)(STRLEN(s)
9038 + STRLEN(name) + ap->patlen + 1));
9039 if (sourcing_name != NULL)
9041 sprintf((char *)sourcing_name, s,
9042 (char *)name, (char *)ap->pat);
9043 if (p_verbose >= 8)
9045 verbose_enter();
9046 smsg((char_u *)_("Executing %s"), sourcing_name);
9047 verbose_leave();
9051 apc->curpat = ap;
9052 apc->nextcmd = ap->cmds;
9053 /* mark last command */
9054 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
9055 cp->last = FALSE;
9056 cp->last = TRUE;
9058 line_breakcheck();
9059 if (apc->curpat != NULL) /* found a match */
9060 break;
9062 if (stop_at_last && ap->last)
9063 break;
9068 * Get next autocommand command.
9069 * Called by do_cmdline() to get the next line for ":if".
9070 * Returns allocated string, or NULL for end of autocommands.
9072 /* ARGSUSED */
9073 static char_u *
9074 getnextac(c, cookie, indent)
9075 int c; /* not used */
9076 void *cookie;
9077 int indent; /* not used */
9079 AutoPatCmd *acp = (AutoPatCmd *)cookie;
9080 char_u *retval;
9081 AutoCmd *ac;
9083 /* Can be called again after returning the last line. */
9084 if (acp->curpat == NULL)
9085 return NULL;
9087 /* repeat until we find an autocommand to execute */
9088 for (;;)
9090 /* skip removed commands */
9091 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
9092 if (acp->nextcmd->last)
9093 acp->nextcmd = NULL;
9094 else
9095 acp->nextcmd = acp->nextcmd->next;
9097 if (acp->nextcmd != NULL)
9098 break;
9100 /* at end of commands, find next pattern that matches */
9101 if (acp->curpat->last)
9102 acp->curpat = NULL;
9103 else
9104 acp->curpat = acp->curpat->next;
9105 if (acp->curpat != NULL)
9106 auto_next_pat(acp, TRUE);
9107 if (acp->curpat == NULL)
9108 return NULL;
9111 ac = acp->nextcmd;
9113 if (p_verbose >= 9)
9115 verbose_enter_scroll();
9116 smsg((char_u *)_("autocommand %s"), ac->cmd);
9117 msg_puts((char_u *)"\n"); /* don't overwrite this either */
9118 verbose_leave_scroll();
9120 retval = vim_strsave(ac->cmd);
9121 autocmd_nested = ac->nested;
9122 #ifdef FEAT_EVAL
9123 current_SID = ac->scriptID;
9124 #endif
9125 if (ac->last)
9126 acp->nextcmd = NULL;
9127 else
9128 acp->nextcmd = ac->next;
9129 return retval;
9133 * Return TRUE if there is a matching autocommand for "fname".
9134 * To account for buffer-local autocommands, function needs to know
9135 * in which buffer the file will be opened.
9138 has_autocmd(event, sfname, buf)
9139 event_T event;
9140 char_u *sfname;
9141 buf_T *buf;
9143 AutoPat *ap;
9144 char_u *fname;
9145 char_u *tail = gettail(sfname);
9146 int retval = FALSE;
9148 fname = FullName_save(sfname, FALSE);
9149 if (fname == NULL)
9150 return FALSE;
9152 #ifdef BACKSLASH_IN_FILENAME
9154 * Replace all backslashes with forward slashes. This makes the
9155 * autocommand patterns portable between Unix and MS-DOS.
9157 sfname = vim_strsave(sfname);
9158 if (sfname != NULL)
9159 forward_slash(sfname);
9160 forward_slash(fname);
9161 #endif
9163 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
9164 if (ap->pat != NULL && ap->cmds != NULL
9165 && (ap->buflocal_nr == 0
9166 ? match_file_pat(NULL, ap->reg_prog,
9167 fname, sfname, tail, ap->allow_dirs)
9168 : buf != NULL && ap->buflocal_nr == buf->b_fnum
9171 retval = TRUE;
9172 break;
9175 vim_free(fname);
9176 #ifdef BACKSLASH_IN_FILENAME
9177 vim_free(sfname);
9178 #endif
9180 return retval;
9183 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9185 * Function given to ExpandGeneric() to obtain the list of autocommand group
9186 * names.
9188 /*ARGSUSED*/
9189 char_u *
9190 get_augroup_name(xp, idx)
9191 expand_T *xp;
9192 int idx;
9194 if (idx == augroups.ga_len) /* add "END" add the end */
9195 return (char_u *)"END";
9196 if (idx >= augroups.ga_len) /* end of list */
9197 return NULL;
9198 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
9199 return (char_u *)"";
9200 return AUGROUP_NAME(idx); /* return a name */
9203 static int include_groups = FALSE;
9205 char_u *
9206 set_context_in_autocmd(xp, arg, doautocmd)
9207 expand_T *xp;
9208 char_u *arg;
9209 int doautocmd; /* TRUE for :doauto*, FALSE for :autocmd */
9211 char_u *p;
9212 int group;
9214 /* check for a group name, skip it if present */
9215 include_groups = FALSE;
9216 p = arg;
9217 group = au_get_grouparg(&arg);
9218 if (group == AUGROUP_ERROR)
9219 return NULL;
9220 /* If there only is a group name that's what we expand. */
9221 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
9223 arg = p;
9224 group = AUGROUP_ALL;
9227 /* skip over event name */
9228 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
9229 if (*p == ',')
9230 arg = p + 1;
9231 if (*p == NUL)
9233 if (group == AUGROUP_ALL)
9234 include_groups = TRUE;
9235 xp->xp_context = EXPAND_EVENTS; /* expand event name */
9236 xp->xp_pattern = arg;
9237 return NULL;
9240 /* skip over pattern */
9241 arg = skipwhite(p);
9242 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
9243 arg++;
9244 if (*arg)
9245 return arg; /* expand (next) command */
9247 if (doautocmd)
9248 xp->xp_context = EXPAND_FILES; /* expand file names */
9249 else
9250 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
9251 return NULL;
9255 * Function given to ExpandGeneric() to obtain the list of event names.
9257 /*ARGSUSED*/
9258 char_u *
9259 get_event_name(xp, idx)
9260 expand_T *xp;
9261 int idx;
9263 if (idx < augroups.ga_len) /* First list group names, if wanted */
9265 if (!include_groups || AUGROUP_NAME(idx) == NULL)
9266 return (char_u *)""; /* skip deleted entries */
9267 return AUGROUP_NAME(idx); /* return a name */
9269 return (char_u *)event_names[idx - augroups.ga_len].name;
9272 #endif /* FEAT_CMDL_COMPL */
9275 * Return TRUE if autocmd is supported.
9278 autocmd_supported(name)
9279 char_u *name;
9281 char_u *p;
9283 return (event_name2nr(name, &p) != NUM_EVENTS);
9287 * Return TRUE if an autocommand is defined for a group, event and
9288 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9289 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9290 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9291 * Used for:
9292 * exists("#Group") or
9293 * exists("#Group#Event") or
9294 * exists("#Group#Event#pat") or
9295 * exists("#Event") or
9296 * exists("#Event#pat")
9299 au_exists(arg)
9300 char_u *arg;
9302 char_u *arg_save;
9303 char_u *pattern = NULL;
9304 char_u *event_name;
9305 char_u *p;
9306 event_T event;
9307 AutoPat *ap;
9308 buf_T *buflocal_buf = NULL;
9309 int group;
9310 int retval = FALSE;
9312 /* Make a copy so that we can change the '#' chars to a NUL. */
9313 arg_save = vim_strsave(arg);
9314 if (arg_save == NULL)
9315 return FALSE;
9316 p = vim_strchr(arg_save, '#');
9317 if (p != NULL)
9318 *p++ = NUL;
9320 /* First, look for an autocmd group name */
9321 group = au_find_group(arg_save);
9322 if (group == AUGROUP_ERROR)
9324 /* Didn't match a group name, assume the first argument is an event. */
9325 group = AUGROUP_ALL;
9326 event_name = arg_save;
9328 else
9330 if (p == NULL)
9332 /* "Group": group name is present and it's recognized */
9333 retval = TRUE;
9334 goto theend;
9337 /* Must be "Group#Event" or "Group#Event#pat". */
9338 event_name = p;
9339 p = vim_strchr(event_name, '#');
9340 if (p != NULL)
9341 *p++ = NUL; /* "Group#Event#pat" */
9344 pattern = p; /* "pattern" is NULL when there is no pattern */
9346 /* find the index (enum) for the event name */
9347 event = event_name2nr(event_name, &p);
9349 /* return FALSE if the event name is not recognized */
9350 if (event == NUM_EVENTS)
9351 goto theend;
9353 /* Find the first autocommand for this event.
9354 * If there isn't any, return FALSE;
9355 * If there is one and no pattern given, return TRUE; */
9356 ap = first_autopat[(int)event];
9357 if (ap == NULL)
9358 goto theend;
9359 if (pattern == NULL)
9361 retval = TRUE;
9362 goto theend;
9365 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9366 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9367 if (STRICMP(pattern, "<buffer>") == 0)
9368 buflocal_buf = curbuf;
9370 /* Check if there is an autocommand with the given pattern. */
9371 for ( ; ap != NULL; ap = ap->next)
9372 /* only use a pattern when it has not been removed and has commands. */
9373 /* For buffer-local autocommands, fnamecmp() works fine. */
9374 if (ap->pat != NULL && ap->cmds != NULL
9375 && (group == AUGROUP_ALL || ap->group == group)
9376 && (buflocal_buf == NULL
9377 ? fnamecmp(ap->pat, pattern) == 0
9378 : ap->buflocal_nr == buflocal_buf->b_fnum))
9380 retval = TRUE;
9381 break;
9384 theend:
9385 vim_free(arg_save);
9386 return retval;
9389 #else /* FEAT_AUTOCMD */
9392 * Prepare for executing commands for (hidden) buffer "buf".
9393 * This is the non-autocommand version, it simply saves "curbuf" and sets
9394 * "curbuf" and "curwin" to match "buf".
9396 void
9397 aucmd_prepbuf(aco, buf)
9398 aco_save_T *aco; /* structure to save values in */
9399 buf_T *buf; /* new curbuf */
9401 aco->save_buf = curbuf;
9402 curbuf = buf;
9403 curwin->w_buffer = buf;
9407 * Restore after executing commands for a (hidden) buffer.
9408 * This is the non-autocommand version.
9410 void
9411 aucmd_restbuf(aco)
9412 aco_save_T *aco; /* structure holding saved values */
9414 curbuf = aco->save_buf;
9415 curwin->w_buffer = curbuf;
9418 #endif /* FEAT_AUTOCMD */
9421 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9423 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9424 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9425 * vim_regcomp() often.
9426 * Used for autocommands and 'wildignore'.
9427 * Returns TRUE if there is a match, FALSE otherwise.
9430 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9431 char_u *pattern; /* pattern to match with */
9432 regprog_T *prog; /* pre-compiled regprog or NULL */
9433 char_u *fname; /* full path of file name */
9434 char_u *sfname; /* short file name or NULL */
9435 char_u *tail; /* tail of path */
9436 int allow_dirs; /* allow matching with dir */
9438 regmatch_T regmatch;
9439 int result = FALSE;
9440 #ifdef FEAT_OSFILETYPE
9441 int no_pattern = FALSE; /* TRUE if check is filetype only */
9442 char_u *type_start;
9443 char_u c;
9444 int match = FALSE;
9445 #endif
9447 #ifdef CASE_INSENSITIVE_FILENAME
9448 regmatch.rm_ic = TRUE; /* Always ignore case */
9449 #else
9450 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9451 #endif
9452 #ifdef FEAT_OSFILETYPE
9453 if (*pattern == '<')
9455 /* There is a filetype condition specified with this pattern.
9456 * Check the filetype matches first. If not, don't bother with the
9457 * pattern (set regprog to NULL).
9458 * Always use magic for the regexp.
9461 for (type_start = pattern + 1; (c = *pattern); pattern++)
9463 if ((c == ';' || c == '>') && match == FALSE)
9465 *pattern = NUL; /* Terminate the string */
9466 match = mch_check_filetype(fname, type_start);
9467 *pattern = c; /* Restore the terminator */
9468 type_start = pattern + 1;
9470 if (c == '>')
9471 break;
9474 /* (c should never be NUL, but check anyway) */
9475 if (match == FALSE || c == NUL)
9476 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9477 else if (*pattern == NUL)
9479 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9480 no_pattern = TRUE; /* Always matches - don't check pat. */
9482 else
9483 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9485 else
9486 #endif
9488 if (prog != NULL)
9489 regmatch.regprog = prog;
9490 else
9491 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9495 * Try for a match with the pattern with:
9496 * 1. the full file name, when the pattern has a '/'.
9497 * 2. the short file name, when the pattern has a '/'.
9498 * 3. the tail of the file name, when the pattern has no '/'.
9500 if (
9501 #ifdef FEAT_OSFILETYPE
9502 /* If the check is for a filetype only and we don't care
9503 * about the path then skip all the regexp stuff.
9505 no_pattern ||
9506 #endif
9507 (regmatch.regprog != NULL
9508 && ((allow_dirs
9509 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9510 || (sfname != NULL
9511 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9512 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9513 result = TRUE;
9515 if (prog == NULL)
9516 vim_free(regmatch.regprog);
9517 return result;
9519 #endif
9521 #if defined(FEAT_WILDIGN) || defined(PROTO)
9523 * Return TRUE if a file matches with a pattern in "list".
9524 * "list" is a comma-separated list of patterns, like 'wildignore'.
9525 * "sfname" is the short file name or NULL, "ffname" the long file name.
9528 match_file_list(list, sfname, ffname)
9529 char_u *list;
9530 char_u *sfname;
9531 char_u *ffname;
9533 char_u buf[100];
9534 char_u *tail;
9535 char_u *regpat;
9536 char allow_dirs;
9537 int match;
9538 char_u *p;
9540 tail = gettail(sfname);
9542 /* try all patterns in 'wildignore' */
9543 p = list;
9544 while (*p)
9546 copy_option_part(&p, buf, 100, ",");
9547 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9548 if (regpat == NULL)
9549 break;
9550 match = match_file_pat(regpat, NULL, ffname, sfname,
9551 tail, (int)allow_dirs);
9552 vim_free(regpat);
9553 if (match)
9554 return TRUE;
9556 return FALSE;
9558 #endif
9561 * Convert the given pattern "pat" which has shell style wildcards in it, into
9562 * a regular expression, and return the result in allocated memory. If there
9563 * is a directory path separator to be matched, then TRUE is put in
9564 * allow_dirs, otherwise FALSE is put there -- webb.
9565 * Handle backslashes before special characters, like "\*" and "\ ".
9567 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9568 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9570 * Returns NULL when out of memory.
9572 /*ARGSUSED*/
9573 char_u *
9574 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9575 char_u *pat;
9576 char_u *pat_end; /* first char after pattern or NULL */
9577 char *allow_dirs; /* Result passed back out in here */
9578 int no_bslash; /* Don't use a backward slash as pathsep */
9580 int size;
9581 char_u *endp;
9582 char_u *reg_pat;
9583 char_u *p;
9584 int i;
9585 int nested = 0;
9586 int add_dollar = TRUE;
9587 #ifdef FEAT_OSFILETYPE
9588 int check_length = 0;
9589 #endif
9591 if (allow_dirs != NULL)
9592 *allow_dirs = FALSE;
9593 if (pat_end == NULL)
9594 pat_end = pat + STRLEN(pat);
9596 #ifdef FEAT_OSFILETYPE
9597 /* Find out how much of the string is the filetype check */
9598 if (*pat == '<')
9600 /* Count chars until the next '>' */
9601 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9603 if (p < pat_end)
9605 /* Pattern is of the form <.*>.* */
9606 check_length = p - pat + 1;
9607 if (p + 1 >= pat_end)
9609 /* The 'pattern' is a filetype check ONLY */
9610 reg_pat = (char_u *)alloc(check_length + 1);
9611 if (reg_pat != NULL)
9613 mch_memmove(reg_pat, pat, (size_t)check_length);
9614 reg_pat[check_length] = NUL;
9616 return reg_pat;
9619 /* else: there was no closing '>' - assume it was a normal pattern */
9622 pat += check_length;
9623 size = 2 + check_length;
9624 #else
9625 size = 2; /* '^' at start, '$' at end */
9626 #endif
9628 for (p = pat; p < pat_end; p++)
9630 switch (*p)
9632 case '*':
9633 case '.':
9634 case ',':
9635 case '{':
9636 case '}':
9637 case '~':
9638 size += 2; /* extra backslash */
9639 break;
9640 #ifdef BACKSLASH_IN_FILENAME
9641 case '\\':
9642 case '/':
9643 size += 4; /* could become "[\/]" */
9644 break;
9645 #endif
9646 default:
9647 size++;
9648 # ifdef FEAT_MBYTE
9649 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9651 ++p;
9652 ++size;
9654 # endif
9655 break;
9658 reg_pat = alloc(size + 1);
9659 if (reg_pat == NULL)
9660 return NULL;
9662 #ifdef FEAT_OSFILETYPE
9663 /* Copy the type check in to the start. */
9664 if (check_length)
9665 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9666 i = check_length;
9667 #else
9668 i = 0;
9669 #endif
9671 if (pat[0] == '*')
9672 while (pat[0] == '*' && pat < pat_end - 1)
9673 pat++;
9674 else
9675 reg_pat[i++] = '^';
9676 endp = pat_end - 1;
9677 if (*endp == '*')
9679 while (endp - pat > 0 && *endp == '*')
9680 endp--;
9681 add_dollar = FALSE;
9683 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9685 switch (*p)
9687 case '*':
9688 reg_pat[i++] = '.';
9689 reg_pat[i++] = '*';
9690 while (p[1] == '*') /* "**" matches like "*" */
9691 ++p;
9692 break;
9693 case '.':
9694 #ifdef RISCOS
9695 if (allow_dirs != NULL)
9696 *allow_dirs = TRUE;
9697 /* FALLTHROUGH */
9698 #endif
9699 case '~':
9700 reg_pat[i++] = '\\';
9701 reg_pat[i++] = *p;
9702 break;
9703 case '?':
9704 #ifdef RISCOS
9705 case '#':
9706 #endif
9707 reg_pat[i++] = '.';
9708 break;
9709 case '\\':
9710 if (p[1] == NUL)
9711 break;
9712 #ifdef BACKSLASH_IN_FILENAME
9713 if (!no_bslash)
9715 /* translate:
9716 * "\x" to "\\x" e.g., "dir\file"
9717 * "\*" to "\\.*" e.g., "dir\*.c"
9718 * "\?" to "\\." e.g., "dir\??.c"
9719 * "\+" to "\+" e.g., "fileX\+.c"
9721 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9722 && p[1] != '+')
9724 reg_pat[i++] = '[';
9725 reg_pat[i++] = '\\';
9726 reg_pat[i++] = '/';
9727 reg_pat[i++] = ']';
9728 if (allow_dirs != NULL)
9729 *allow_dirs = TRUE;
9730 break;
9733 #endif
9734 if (*++p == '?'
9735 #ifdef BACKSLASH_IN_FILENAME
9736 && no_bslash
9737 #endif
9739 reg_pat[i++] = '?';
9740 else
9741 if (*p == ',')
9742 reg_pat[i++] = ',';
9743 else
9745 if (allow_dirs != NULL && vim_ispathsep(*p)
9746 #ifdef BACKSLASH_IN_FILENAME
9747 && (!no_bslash || *p != '\\')
9748 #endif
9750 *allow_dirs = TRUE;
9751 reg_pat[i++] = '\\';
9752 reg_pat[i++] = *p;
9754 break;
9755 #ifdef BACKSLASH_IN_FILENAME
9756 case '/':
9757 reg_pat[i++] = '[';
9758 reg_pat[i++] = '\\';
9759 reg_pat[i++] = '/';
9760 reg_pat[i++] = ']';
9761 if (allow_dirs != NULL)
9762 *allow_dirs = TRUE;
9763 break;
9764 #endif
9765 case '{':
9766 reg_pat[i++] = '\\';
9767 reg_pat[i++] = '(';
9768 nested++;
9769 break;
9770 case '}':
9771 reg_pat[i++] = '\\';
9772 reg_pat[i++] = ')';
9773 --nested;
9774 break;
9775 case ',':
9776 if (nested)
9778 reg_pat[i++] = '\\';
9779 reg_pat[i++] = '|';
9781 else
9782 reg_pat[i++] = ',';
9783 break;
9784 default:
9785 # ifdef FEAT_MBYTE
9786 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9787 reg_pat[i++] = *p++;
9788 else
9789 # endif
9790 if (allow_dirs != NULL && vim_ispathsep(*p))
9791 *allow_dirs = TRUE;
9792 reg_pat[i++] = *p;
9793 break;
9796 if (add_dollar)
9797 reg_pat[i++] = '$';
9798 reg_pat[i] = NUL;
9799 if (nested != 0)
9801 if (nested < 0)
9802 EMSG(_("E219: Missing {."));
9803 else
9804 EMSG(_("E220: Missing }."));
9805 vim_free(reg_pat);
9806 reg_pat = NULL;
9808 return reg_pat;