Merged from the latest developing branch.
[MacVim.git] / src / fileio.c
blob3af64c4b0fba997984c0235ef8fa9f9d2888a316
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 /* erroneous 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));
147 #ifdef FEAT_AUTOCMD
148 static char *e_auchangedbuf = N_("E812: Autocommands changed buffer or buffer name");
149 #endif
151 void
152 filemess(buf, name, s, attr)
153 buf_T *buf;
154 char_u *name;
155 char_u *s;
156 int attr;
158 int msg_scroll_save;
160 if (msg_silent != 0)
161 return;
162 msg_add_fname(buf, name); /* put file name in IObuff with quotes */
163 /* If it's extremely long, truncate it. */
164 if (STRLEN(IObuff) > IOSIZE - 80)
165 IObuff[IOSIZE - 80] = NUL;
166 STRCAT(IObuff, s);
168 * For the first message may have to start a new line.
169 * For further ones overwrite the previous one, reset msg_scroll before
170 * calling filemess().
172 msg_scroll_save = msg_scroll;
173 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
174 msg_scroll = FALSE;
175 if (!msg_scroll) /* wait a bit when overwriting an error msg */
176 check_for_delay(FALSE);
177 msg_start();
178 msg_scroll = msg_scroll_save;
179 msg_scrolled_ign = TRUE;
180 /* may truncate the message to avoid a hit-return prompt */
181 msg_outtrans_attr(msg_may_trunc(FALSE, IObuff), attr);
182 msg_clr_eos();
183 out_flush();
184 msg_scrolled_ign = FALSE;
188 * Read lines from file "fname" into the buffer after line "from".
190 * 1. We allocate blocks with lalloc, as big as possible.
191 * 2. Each block is filled with characters from the file with a single read().
192 * 3. The lines are inserted in the buffer with ml_append().
194 * (caller must check that fname != NULL, unless READ_STDIN is used)
196 * "lines_to_skip" is the number of lines that must be skipped
197 * "lines_to_read" is the number of lines that are appended
198 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
200 * flags:
201 * READ_NEW starting to edit a new buffer
202 * READ_FILTER reading filter output
203 * READ_STDIN read from stdin instead of a file
204 * READ_BUFFER read from curbuf instead of a file (converting after reading
205 * stdin)
206 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
208 * return FAIL for failure, OK otherwise
211 readfile(fname, sfname, from, lines_to_skip, lines_to_read, eap, flags)
212 char_u *fname;
213 char_u *sfname;
214 linenr_T from;
215 linenr_T lines_to_skip;
216 linenr_T lines_to_read;
217 exarg_T *eap; /* can be NULL! */
218 int flags;
220 int fd = 0;
221 int newfile = (flags & READ_NEW);
222 int check_readonly;
223 int filtering = (flags & READ_FILTER);
224 int read_stdin = (flags & READ_STDIN);
225 int read_buffer = (flags & READ_BUFFER);
226 int set_options = newfile || read_buffer
227 || (eap != NULL && eap->read_edit);
228 linenr_T read_buf_lnum = 1; /* next line to read from curbuf */
229 colnr_T read_buf_col = 0; /* next char to read from this line */
230 char_u c;
231 linenr_T lnum = from;
232 char_u *ptr = NULL; /* pointer into read buffer */
233 char_u *buffer = NULL; /* read buffer */
234 char_u *new_buffer = NULL; /* init to shut up gcc */
235 char_u *line_start = NULL; /* init to shut up gcc */
236 int wasempty; /* buffer was empty before reading */
237 colnr_T len;
238 long size = 0;
239 char_u *p;
240 long filesize = 0;
241 int skip_read = FALSE;
242 #ifdef FEAT_CRYPT
243 char_u *cryptkey = NULL;
244 #endif
245 int split = 0; /* number of split lines */
246 #define UNKNOWN 0x0fffffff /* file size is unknown */
247 linenr_T linecnt;
248 int error = FALSE; /* errors encountered */
249 int ff_error = EOL_UNKNOWN; /* file format with errors */
250 long linerest = 0; /* remaining chars in line */
251 #ifdef UNIX
252 int perm = 0;
253 int swap_mode = -1; /* protection bits for swap file */
254 #else
255 int perm;
256 #endif
257 int fileformat = 0; /* end-of-line format */
258 int keep_fileformat = FALSE;
259 struct stat st;
260 int file_readonly;
261 linenr_T skip_count = 0;
262 linenr_T read_count = 0;
263 int msg_save = msg_scroll;
264 linenr_T read_no_eol_lnum = 0; /* non-zero lnum when last line of
265 * last read was missing the eol */
266 int try_mac = (vim_strchr(p_ffs, 'm') != NULL);
267 int try_dos = (vim_strchr(p_ffs, 'd') != NULL);
268 int try_unix = (vim_strchr(p_ffs, 'x') != NULL);
269 int file_rewind = FALSE;
270 #ifdef FEAT_MBYTE
271 int can_retry;
272 linenr_T conv_error = 0; /* line nr with conversion error */
273 linenr_T illegal_byte = 0; /* line nr with illegal byte */
274 int keep_dest_enc = FALSE; /* don't retry when char doesn't fit
275 in destination encoding */
276 int bad_char_behavior = BAD_REPLACE;
277 /* BAD_KEEP, BAD_DROP or character to
278 * replace with */
279 char_u *tmpname = NULL; /* name of 'charconvert' output file */
280 int fio_flags = 0;
281 char_u *fenc; /* fileencoding to use */
282 int fenc_alloced; /* fenc_next is in allocated memory */
283 char_u *fenc_next = NULL; /* next item in 'fencs' or NULL */
284 int advance_fenc = FALSE;
285 long real_size = 0;
286 # ifdef USE_ICONV
287 iconv_t iconv_fd = (iconv_t)-1; /* descriptor for iconv() or -1 */
288 # ifdef FEAT_EVAL
289 int did_iconv = FALSE; /* TRUE when iconv() failed and trying
290 'charconvert' next */
291 # endif
292 # endif
293 int converted = FALSE; /* TRUE if conversion done */
294 int notconverted = FALSE; /* TRUE if conversion wanted but it
295 wasn't possible */
296 char_u conv_rest[CONV_RESTLEN];
297 int conv_restlen = 0; /* nr of bytes in conv_rest[] */
298 #endif
300 #ifdef FEAT_AUTOCMD
301 /* Remember the initial values of curbuf, curbuf->b_ffname and
302 * curbuf->b_fname to detect whether they are altered as a result of
303 * executing nasty autocommands. Also check if "fname" and "sfname"
304 * point to one of these values. */
305 buf_T *old_curbuf = curbuf;
306 char_u *old_b_ffname = curbuf->b_ffname;
307 char_u *old_b_fname = curbuf->b_fname;
308 int using_b_ffname = (fname == curbuf->b_ffname)
309 || (sfname == curbuf->b_ffname);
310 int using_b_fname = (fname == curbuf->b_fname)
311 || (sfname == curbuf->b_fname);
312 #endif
313 write_no_eol_lnum = 0; /* in case it was set by the previous read */
316 * If there is no file name yet, use the one for the read file.
317 * BF_NOTEDITED is set to reflect this.
318 * Don't do this for a read from a filter.
319 * Only do this when 'cpoptions' contains the 'f' flag.
321 if (curbuf->b_ffname == NULL
322 && !filtering
323 && fname != NULL
324 && vim_strchr(p_cpo, CPO_FNAMER) != NULL
325 && !(flags & READ_DUMMY))
327 if (set_rw_fname(fname, sfname) == FAIL)
328 return FAIL;
331 /* After reading a file the cursor line changes but we don't want to
332 * display the line. */
333 ex_no_reprint = TRUE;
335 /* don't display the file info for another buffer now */
336 need_fileinfo = FALSE;
339 * For Unix: Use the short file name whenever possible.
340 * Avoids problems with networks and when directory names are changed.
341 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
342 * another directory, which we don't detect.
344 if (sfname == NULL)
345 sfname = fname;
346 #if defined(UNIX) || defined(__EMX__)
347 fname = sfname;
348 #endif
350 #ifdef FEAT_AUTOCMD
352 * The BufReadCmd and FileReadCmd events intercept the reading process by
353 * executing the associated commands instead.
355 if (!filtering && !read_stdin && !read_buffer)
357 pos_T pos;
359 pos = curbuf->b_op_start;
361 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
362 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
363 curbuf->b_op_start.col = 0;
365 if (newfile)
367 if (apply_autocmds_exarg(EVENT_BUFREADCMD, NULL, sfname,
368 FALSE, curbuf, eap))
369 #ifdef FEAT_EVAL
370 return aborting() ? FAIL : OK;
371 #else
372 return OK;
373 #endif
375 else if (apply_autocmds_exarg(EVENT_FILEREADCMD, sfname, sfname,
376 FALSE, NULL, eap))
377 #ifdef FEAT_EVAL
378 return aborting() ? FAIL : OK;
379 #else
380 return OK;
381 #endif
383 curbuf->b_op_start = pos;
385 #endif
387 if ((shortmess(SHM_OVER) || curbuf->b_help) && p_verbose == 0)
388 msg_scroll = FALSE; /* overwrite previous file message */
389 else
390 msg_scroll = TRUE; /* don't overwrite previous file message */
393 * If the name ends in a path separator, we can't open it. Check here,
394 * because reading the file may actually work, but then creating the swap
395 * file may destroy it! Reported on MS-DOS and Win 95.
396 * If the name is too long we might crash further on, quit here.
398 if (fname != NULL && *fname != NUL)
400 p = fname + STRLEN(fname);
401 if (after_pathsep(fname, p) || STRLEN(fname) >= MAXPATHL)
403 filemess(curbuf, fname, (char_u *)_("Illegal file name"), 0);
404 msg_end();
405 msg_scroll = msg_save;
406 return FAIL;
410 #ifdef UNIX
412 * On Unix it is possible to read a directory, so we have to
413 * check for it before the mch_open().
415 if (!read_stdin && !read_buffer)
417 perm = mch_getperm(fname);
418 if (perm >= 0 && !S_ISREG(perm) /* not a regular file ... */
419 # ifdef S_ISFIFO
420 && !S_ISFIFO(perm) /* ... or fifo */
421 # endif
422 # ifdef S_ISSOCK
423 && !S_ISSOCK(perm) /* ... or socket */
424 # endif
425 # ifdef OPEN_CHR_FILES
426 && !(S_ISCHR(perm) && is_dev_fd_file(fname))
427 /* ... or a character special file named /dev/fd/<n> */
428 # endif
431 if (S_ISDIR(perm))
432 filemess(curbuf, fname, (char_u *)_("is a directory"), 0);
433 else
434 filemess(curbuf, fname, (char_u *)_("is not a file"), 0);
435 msg_end();
436 msg_scroll = msg_save;
437 return FAIL;
440 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
442 * MS-Windows allows opening a device, but we will probably get stuck
443 * trying to read it.
445 if (!p_odev && mch_nodetype(fname) == NODE_WRITABLE)
447 filemess(curbuf, fname, (char_u *)_("is a device (disabled with 'opendevice' option)"), 0);
448 msg_end();
449 msg_scroll = msg_save;
450 return FAIL;
452 # endif
454 #endif
456 /* set default 'fileformat' */
457 if (set_options)
459 if (eap != NULL && eap->force_ff != 0)
460 set_fileformat(get_fileformat_force(curbuf, eap), OPT_LOCAL);
461 else if (*p_ffs != NUL)
462 set_fileformat(default_fileformat(), OPT_LOCAL);
465 /* set or reset 'binary' */
466 if (eap != NULL && eap->force_bin != 0)
468 int oldval = curbuf->b_p_bin;
470 curbuf->b_p_bin = (eap->force_bin == FORCE_BIN);
471 set_options_bin(oldval, curbuf->b_p_bin, OPT_LOCAL);
475 * When opening a new file we take the readonly flag from the file.
476 * Default is r/w, can be set to r/o below.
477 * Don't reset it when in readonly mode
478 * Only set/reset b_p_ro when BF_CHECK_RO is set.
480 check_readonly = (newfile && (curbuf->b_flags & BF_CHECK_RO));
481 if (check_readonly && !readonlymode)
482 curbuf->b_p_ro = FALSE;
484 if (newfile && !read_stdin && !read_buffer)
486 /* Remember time of file.
487 * For RISCOS, also remember the filetype.
489 if (mch_stat((char *)fname, &st) >= 0)
491 buf_store_time(curbuf, &st, fname);
492 curbuf->b_mtime_read = curbuf->b_mtime;
494 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
495 /* Read the filetype into the buffer local filetype option. */
496 mch_read_filetype(fname);
497 #endif
498 #ifdef UNIX
500 * Use the protection bits of the original file for the swap file.
501 * This makes it possible for others to read the name of the
502 * edited file from the swapfile, but only if they can read the
503 * edited file.
504 * Remove the "write" and "execute" bits for group and others
505 * (they must not write the swapfile).
506 * Add the "read" and "write" bits for the user, otherwise we may
507 * not be able to write to the file ourselves.
508 * Setting the bits is done below, after creating the swap file.
510 swap_mode = (st.st_mode & 0644) | 0600;
511 #endif
512 #ifdef FEAT_CW_EDITOR
513 /* Get the FSSpec on MacOS
514 * TODO: Update it properly when the buffer name changes
516 (void)GetFSSpecFromPath(curbuf->b_ffname, &curbuf->b_FSSpec);
517 #endif
518 #ifdef VMS
519 curbuf->b_fab_rfm = st.st_fab_rfm;
520 curbuf->b_fab_rat = st.st_fab_rat;
521 curbuf->b_fab_mrs = st.st_fab_mrs;
522 #endif
524 else
526 curbuf->b_mtime = 0;
527 curbuf->b_mtime_read = 0;
528 curbuf->b_orig_size = 0;
529 curbuf->b_orig_mode = 0;
532 /* Reset the "new file" flag. It will be set again below when the
533 * file doesn't exist. */
534 curbuf->b_flags &= ~(BF_NEW | BF_NEW_W);
538 * for UNIX: check readonly with perm and mch_access()
539 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
540 * for MSDOS and Amiga: check readonly by trying to open the file for writing
542 file_readonly = FALSE;
543 if (read_stdin)
545 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
546 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
547 setmode(0, O_BINARY);
548 #endif
550 else if (!read_buffer)
552 #ifdef USE_MCH_ACCESS
553 if (
554 # ifdef UNIX
555 !(perm & 0222) ||
556 # endif
557 mch_access((char *)fname, W_OK))
558 file_readonly = TRUE;
559 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
560 #else
561 if (!newfile
562 || readonlymode
563 || (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0)
565 file_readonly = TRUE;
566 /* try to open ro */
567 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
569 #endif
572 if (fd < 0) /* cannot open at all */
574 #ifndef UNIX
575 int isdir_f;
576 #endif
577 msg_scroll = msg_save;
578 #ifndef UNIX
580 * On MSDOS and Amiga we can't open a directory, check here.
582 isdir_f = (mch_isdir(fname));
583 perm = mch_getperm(fname); /* check if the file exists */
584 if (isdir_f)
586 filemess(curbuf, sfname, (char_u *)_("is a directory"), 0);
587 curbuf->b_p_ro = TRUE; /* must use "w!" now */
589 else
590 #endif
591 if (newfile)
593 if (perm < 0)
596 * Set the 'new-file' flag, so that when the file has
597 * been created by someone else, a ":w" will complain.
599 curbuf->b_flags |= BF_NEW;
601 /* Create a swap file now, so that other Vims are warned
602 * that we are editing this file. Don't do this for a
603 * "nofile" or "nowrite" buffer type. */
604 #ifdef FEAT_QUICKFIX
605 if (!bt_dontwrite(curbuf))
606 #endif
608 check_need_swap(newfile);
609 #ifdef FEAT_AUTOCMD
610 /* SwapExists autocommand may mess things up */
611 if (curbuf != old_curbuf
612 || (using_b_ffname
613 && (old_b_ffname != curbuf->b_ffname))
614 || (using_b_fname
615 && (old_b_fname != curbuf->b_fname)))
617 EMSG(_(e_auchangedbuf));
618 return FAIL;
620 #endif
622 if (dir_of_file_exists(fname))
623 filemess(curbuf, sfname, (char_u *)_("[New File]"), 0);
624 else
625 filemess(curbuf, sfname,
626 (char_u *)_("[New DIRECTORY]"), 0);
627 #ifdef FEAT_VIMINFO
628 /* Even though this is a new file, it might have been
629 * edited before and deleted. Get the old marks. */
630 check_marks_read();
631 #endif
632 #ifdef FEAT_MBYTE
633 if (eap != NULL && eap->force_enc != 0)
635 /* set forced 'fileencoding' */
636 fenc = enc_canonize(eap->cmd + eap->force_enc);
637 if (fenc != NULL)
638 set_string_option_direct((char_u *)"fenc", -1,
639 fenc, OPT_FREE|OPT_LOCAL, 0);
640 vim_free(fenc);
642 #endif
643 #ifdef FEAT_AUTOCMD
644 apply_autocmds_exarg(EVENT_BUFNEWFILE, sfname, sfname,
645 FALSE, curbuf, eap);
646 #endif
647 /* remember the current fileformat */
648 save_file_ff(curbuf);
650 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
651 if (aborting()) /* autocmds may abort script processing */
652 return FAIL;
653 #endif
654 return OK; /* a new file is not an error */
656 else
658 filemess(curbuf, sfname, (char_u *)(
659 # ifdef EFBIG
660 (errno == EFBIG) ? _("[File too big]") :
661 # endif
662 _("[Permission Denied]")), 0);
663 curbuf->b_p_ro = TRUE; /* must use "w!" now */
667 return FAIL;
671 * Only set the 'ro' flag for readonly files the first time they are
672 * loaded. Help files always get readonly mode
674 if ((check_readonly && file_readonly) || curbuf->b_help)
675 curbuf->b_p_ro = TRUE;
677 if (set_options)
679 /* Don't change 'eol' if reading from buffer as it will already be
680 * correctly set when reading stdin. */
681 if (!read_buffer)
683 curbuf->b_p_eol = TRUE;
684 curbuf->b_start_eol = TRUE;
686 #ifdef FEAT_MBYTE
687 curbuf->b_p_bomb = FALSE;
688 curbuf->b_start_bomb = FALSE;
689 #endif
692 /* Create a swap file now, so that other Vims are warned that we are
693 * editing this file.
694 * Don't do this for a "nofile" or "nowrite" buffer type. */
695 #ifdef FEAT_QUICKFIX
696 if (!bt_dontwrite(curbuf))
697 #endif
699 check_need_swap(newfile);
700 #ifdef FEAT_AUTOCMD
701 if (!read_stdin && (curbuf != old_curbuf
702 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
703 || (using_b_fname && (old_b_fname != curbuf->b_fname))))
705 EMSG(_(e_auchangedbuf));
706 if (!read_buffer)
707 close(fd);
708 return FAIL;
710 #endif
711 #ifdef UNIX
712 /* Set swap file protection bits after creating it. */
713 if (swap_mode > 0 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
714 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
715 #endif
718 #if defined(HAS_SWAP_EXISTS_ACTION)
719 /* If "Quit" selected at ATTENTION dialog, don't load the file */
720 if (swap_exists_action == SEA_QUIT)
722 if (!read_buffer && !read_stdin)
723 close(fd);
724 return FAIL;
726 #endif
728 ++no_wait_return; /* don't wait for return yet */
731 * Set '[ mark to the line above where the lines go (line 1 if zero).
733 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
734 curbuf->b_op_start.col = 0;
736 #ifdef FEAT_AUTOCMD
737 if (!read_buffer)
739 int m = msg_scroll;
740 int n = msg_scrolled;
743 * The file must be closed again, the autocommands may want to change
744 * the file before reading it.
746 if (!read_stdin)
747 close(fd); /* ignore errors */
750 * The output from the autocommands should not overwrite anything and
751 * should not be overwritten: Set msg_scroll, restore its value if no
752 * output was done.
754 msg_scroll = TRUE;
755 if (filtering)
756 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
757 FALSE, curbuf, eap);
758 else if (read_stdin)
759 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
760 FALSE, curbuf, eap);
761 else if (newfile)
762 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
763 FALSE, curbuf, eap);
764 else
765 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
766 FALSE, NULL, eap);
767 if (msg_scrolled == n)
768 msg_scroll = m;
770 #ifdef FEAT_EVAL
771 if (aborting()) /* autocmds may abort script processing */
773 --no_wait_return;
774 msg_scroll = msg_save;
775 curbuf->b_p_ro = TRUE; /* must use "w!" now */
776 return FAIL;
778 #endif
780 * Don't allow the autocommands to change the current buffer.
781 * Try to re-open the file.
783 * Don't allow the autocommands to change the buffer name either
784 * (cd for example) if it invalidates fname or sfname.
786 if (!read_stdin && (curbuf != old_curbuf
787 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
788 || (using_b_fname && (old_b_fname != curbuf->b_fname))
789 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
791 --no_wait_return;
792 msg_scroll = msg_save;
793 if (fd < 0)
794 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
795 else
796 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
797 curbuf->b_p_ro = TRUE; /* must use "w!" now */
798 return FAIL;
801 #endif /* FEAT_AUTOCMD */
803 /* Autocommands may add lines to the file, need to check if it is empty */
804 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
806 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
809 * Show the user that we are busy reading the input. Sometimes this
810 * may take a while. When reading from stdin another program may
811 * still be running, don't move the cursor to the last line, unless
812 * always using the GUI.
814 if (read_stdin)
816 #ifndef ALWAYS_USE_GUI
817 mch_msg(_("Vim: Reading from stdin...\n"));
818 #endif
819 #ifdef FEAT_GUI
820 /* Also write a message in the GUI window, if there is one. */
821 if (gui.in_use && !gui.dying && !gui.starting)
823 p = (char_u *)_("Reading from stdin...");
824 gui_write(p, (int)STRLEN(p));
826 #endif
828 else if (!read_buffer)
829 filemess(curbuf, sfname, (char_u *)"", 0);
832 msg_scroll = FALSE; /* overwrite the file message */
835 * Set linecnt now, before the "retry" caused by a wrong guess for
836 * fileformat, and after the autocommands, which may change them.
838 linecnt = curbuf->b_ml.ml_line_count;
840 #ifdef FEAT_MBYTE
841 /* "++bad=" argument. */
842 if (eap != NULL && eap->bad_char != 0)
844 bad_char_behavior = eap->bad_char;
845 if (set_options)
846 curbuf->b_bad_char = eap->bad_char;
848 else
849 curbuf->b_bad_char = 0;
852 * Decide which 'encoding' to use or use first.
854 if (eap != NULL && eap->force_enc != 0)
856 fenc = enc_canonize(eap->cmd + eap->force_enc);
857 fenc_alloced = TRUE;
858 keep_dest_enc = TRUE;
860 else if (curbuf->b_p_bin)
862 fenc = (char_u *)""; /* binary: don't convert */
863 fenc_alloced = FALSE;
865 else if (curbuf->b_help)
867 char_u firstline[80];
868 int fc;
870 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
871 * fails it must be latin1.
872 * Always do this when 'encoding' is "utf-8". Otherwise only do
873 * this when needed to avoid [converted] remarks all the time.
874 * It is needed when the first line contains non-ASCII characters.
875 * That is only in *.??x files. */
876 fenc = (char_u *)"latin1";
877 c = enc_utf8;
878 if (!c && !read_stdin)
880 fc = fname[STRLEN(fname) - 1];
881 if (TOLOWER_ASC(fc) == 'x')
883 /* Read the first line (and a bit more). Immediately rewind to
884 * the start of the file. If the read() fails "len" is -1. */
885 len = vim_read(fd, firstline, 80);
886 lseek(fd, (off_t)0L, SEEK_SET);
887 for (p = firstline; p < firstline + len; ++p)
888 if (*p >= 0x80)
890 c = TRUE;
891 break;
896 if (c)
898 fenc_next = fenc;
899 fenc = (char_u *)"utf-8";
901 /* When the file is utf-8 but a character doesn't fit in
902 * 'encoding' don't retry. In help text editing utf-8 bytes
903 * doesn't make sense. */
904 if (!enc_utf8)
905 keep_dest_enc = TRUE;
907 fenc_alloced = FALSE;
909 else if (*p_fencs == NUL)
911 fenc = curbuf->b_p_fenc; /* use format from buffer */
912 fenc_alloced = FALSE;
914 else
916 fenc_next = p_fencs; /* try items in 'fileencodings' */
917 fenc = next_fenc(&fenc_next);
918 fenc_alloced = TRUE;
920 #endif
923 * Jump back here to retry reading the file in different ways.
924 * Reasons to retry:
925 * - encoding conversion failed: try another one from "fenc_next"
926 * - BOM detected and fenc was set, need to setup conversion
927 * - "fileformat" check failed: try another
929 * Variables set for special retry actions:
930 * "file_rewind" Rewind the file to start reading it again.
931 * "advance_fenc" Advance "fenc" using "fenc_next".
932 * "skip_read" Re-use already read bytes (BOM detected).
933 * "did_iconv" iconv() conversion failed, try 'charconvert'.
934 * "keep_fileformat" Don't reset "fileformat".
936 * Other status indicators:
937 * "tmpname" When != NULL did conversion with 'charconvert'.
938 * Output file has to be deleted afterwards.
939 * "iconv_fd" When != -1 did conversion with iconv().
941 retry:
943 if (file_rewind)
945 if (read_buffer)
947 read_buf_lnum = 1;
948 read_buf_col = 0;
950 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
952 /* Can't rewind the file, give up. */
953 error = TRUE;
954 goto failed;
956 /* Delete the previously read lines. */
957 while (lnum > from)
958 ml_delete(lnum--, FALSE);
959 file_rewind = FALSE;
960 #ifdef FEAT_MBYTE
961 if (set_options)
963 curbuf->b_p_bomb = FALSE;
964 curbuf->b_start_bomb = FALSE;
966 conv_error = 0;
967 #endif
971 * When retrying with another "fenc" and the first time "fileformat"
972 * will be reset.
974 if (keep_fileformat)
975 keep_fileformat = FALSE;
976 else
978 if (eap != NULL && eap->force_ff != 0)
980 fileformat = get_fileformat_force(curbuf, eap);
981 try_unix = try_dos = try_mac = FALSE;
983 else if (curbuf->b_p_bin)
984 fileformat = EOL_UNIX; /* binary: use Unix format */
985 else if (*p_ffs == NUL)
986 fileformat = get_fileformat(curbuf);/* use format from buffer */
987 else
988 fileformat = EOL_UNKNOWN; /* detect from file */
991 #ifdef FEAT_MBYTE
992 # ifdef USE_ICONV
993 if (iconv_fd != (iconv_t)-1)
995 /* aborted conversion with iconv(), close the descriptor */
996 iconv_close(iconv_fd);
997 iconv_fd = (iconv_t)-1;
999 # endif
1001 if (advance_fenc)
1004 * Try the next entry in 'fileencodings'.
1006 advance_fenc = FALSE;
1008 if (eap != NULL && eap->force_enc != 0)
1010 /* Conversion given with "++cc=" wasn't possible, read
1011 * without conversion. */
1012 notconverted = TRUE;
1013 conv_error = 0;
1014 if (fenc_alloced)
1015 vim_free(fenc);
1016 fenc = (char_u *)"";
1017 fenc_alloced = FALSE;
1019 else
1021 if (fenc_alloced)
1022 vim_free(fenc);
1023 if (fenc_next != NULL)
1025 fenc = next_fenc(&fenc_next);
1026 fenc_alloced = (fenc_next != NULL);
1028 else
1030 fenc = (char_u *)"";
1031 fenc_alloced = FALSE;
1034 if (tmpname != NULL)
1036 mch_remove(tmpname); /* delete converted file */
1037 vim_free(tmpname);
1038 tmpname = NULL;
1043 * Conversion is required when the encoding of the file is different
1044 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
1045 * conversion to UTF-8).
1047 fio_flags = 0;
1048 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
1049 if (converted || enc_unicode != 0)
1052 /* "ucs-bom" means we need to check the first bytes of the file
1053 * for a BOM. */
1054 if (STRCMP(fenc, ENC_UCSBOM) == 0)
1055 fio_flags = FIO_UCSBOM;
1058 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1059 * done. This is handled below after read(). Prepare the
1060 * fio_flags to avoid having to parse the string each time.
1061 * Also check for Unicode to Latin1 conversion, because iconv()
1062 * appears not to handle this correctly. This works just like
1063 * conversion to UTF-8 except how the resulting character is put in
1064 * the buffer.
1066 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1067 fio_flags = get_fio_flags(fenc);
1069 # ifdef WIN3264
1071 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1072 * is handled with MultiByteToWideChar().
1074 if (fio_flags == 0)
1075 fio_flags = get_win_fio_flags(fenc);
1076 # endif
1078 # ifdef MACOS_X
1079 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1080 if (fio_flags == 0)
1081 fio_flags = get_mac_fio_flags(fenc);
1082 # endif
1084 # ifdef USE_ICONV
1086 * Try using iconv() if we can't convert internally.
1088 if (fio_flags == 0
1089 # ifdef FEAT_EVAL
1090 && !did_iconv
1091 # endif
1093 iconv_fd = (iconv_t)my_iconv_open(
1094 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1095 # endif
1097 # ifdef FEAT_EVAL
1099 * Use the 'charconvert' expression when conversion is required
1100 * and we can't do it internally or with iconv().
1102 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1103 # ifdef USE_ICONV
1104 && iconv_fd == (iconv_t)-1
1105 # endif
1108 # ifdef USE_ICONV
1109 did_iconv = FALSE;
1110 # endif
1111 /* Skip conversion when it's already done (retry for wrong
1112 * "fileformat"). */
1113 if (tmpname == NULL)
1115 tmpname = readfile_charconvert(fname, fenc, &fd);
1116 if (tmpname == NULL)
1118 /* Conversion failed. Try another one. */
1119 advance_fenc = TRUE;
1120 if (fd < 0)
1122 /* Re-opening the original file failed! */
1123 EMSG(_("E202: Conversion made file unreadable!"));
1124 error = TRUE;
1125 goto failed;
1127 goto retry;
1131 else
1132 # endif
1134 if (fio_flags == 0
1135 # ifdef USE_ICONV
1136 && iconv_fd == (iconv_t)-1
1137 # endif
1140 /* Conversion wanted but we can't.
1141 * Try the next conversion in 'fileencodings' */
1142 advance_fenc = TRUE;
1143 goto retry;
1148 /* Set "can_retry" when it's possible to rewind the file and try with
1149 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1150 * stdin or fixed at a specific encoding. */
1151 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1152 #endif
1154 if (!skip_read)
1156 linerest = 0;
1157 filesize = 0;
1158 skip_count = lines_to_skip;
1159 read_count = lines_to_read;
1160 #ifdef FEAT_MBYTE
1161 conv_restlen = 0;
1162 #endif
1165 while (!error && !got_int)
1168 * We allocate as much space for the file as we can get, plus
1169 * space for the old line plus room for one terminating NUL.
1170 * The amount is limited by the fact that read() only can read
1171 * upto max_unsigned characters (and other things).
1173 #if SIZEOF_INT <= 2
1174 if (linerest >= 0x7ff0)
1176 ++split;
1177 *ptr = NL; /* split line by inserting a NL */
1178 size = 1;
1180 else
1181 #endif
1183 if (!skip_read)
1185 #if SIZEOF_INT > 2
1186 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1187 size = SSIZE_MAX; /* use max I/O size, 52K */
1188 # else
1189 size = 0x10000L; /* use buffer >= 64K */
1190 # endif
1191 #else
1192 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1193 #endif
1195 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1197 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1198 FALSE)) != NULL)
1199 break;
1201 if (new_buffer == NULL)
1203 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1204 error = TRUE;
1205 break;
1207 if (linerest) /* copy characters from the previous buffer */
1208 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1209 vim_free(buffer);
1210 buffer = new_buffer;
1211 ptr = buffer + linerest;
1212 line_start = buffer;
1214 #ifdef FEAT_MBYTE
1215 /* May need room to translate into.
1216 * For iconv() we don't really know the required space, use a
1217 * factor ICONV_MULT.
1218 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1219 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1220 * become up to 4 bytes, size must be multiple of 2
1221 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1222 * multiple of 2
1223 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1224 * multiple of 4 */
1225 real_size = (int)size;
1226 # ifdef USE_ICONV
1227 if (iconv_fd != (iconv_t)-1)
1228 size = size / ICONV_MULT;
1229 else
1230 # endif
1231 if (fio_flags & FIO_LATIN1)
1232 size = size / 2;
1233 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1234 size = (size * 2 / 3) & ~1;
1235 else if (fio_flags & FIO_UCS4)
1236 size = (size * 2 / 3) & ~3;
1237 else if (fio_flags == FIO_UCSBOM)
1238 size = size / ICONV_MULT; /* worst case */
1239 # ifdef WIN3264
1240 else if (fio_flags & FIO_CODEPAGE)
1241 size = size / ICONV_MULT; /* also worst case */
1242 # endif
1243 # ifdef MACOS_X
1244 else if (fio_flags & FIO_MACROMAN)
1245 size = size / ICONV_MULT; /* also worst case */
1246 # endif
1247 #endif
1249 #ifdef FEAT_MBYTE
1250 if (conv_restlen > 0)
1252 /* Insert unconverted bytes from previous line. */
1253 mch_memmove(ptr, conv_rest, conv_restlen);
1254 ptr += conv_restlen;
1255 size -= conv_restlen;
1257 #endif
1259 if (read_buffer)
1262 * Read bytes from curbuf. Used for converting text read
1263 * from stdin.
1265 if (read_buf_lnum > from)
1266 size = 0;
1267 else
1269 int n, ni;
1270 long tlen;
1272 tlen = 0;
1273 for (;;)
1275 p = ml_get(read_buf_lnum) + read_buf_col;
1276 n = (int)STRLEN(p);
1277 if ((int)tlen + n + 1 > size)
1279 /* Filled up to "size", append partial line.
1280 * Change NL to NUL to reverse the effect done
1281 * below. */
1282 n = (int)(size - tlen);
1283 for (ni = 0; ni < n; ++ni)
1285 if (p[ni] == NL)
1286 ptr[tlen++] = NUL;
1287 else
1288 ptr[tlen++] = p[ni];
1290 read_buf_col += n;
1291 break;
1293 else
1295 /* Append whole line and new-line. Change NL
1296 * to NUL to reverse the effect done below. */
1297 for (ni = 0; ni < n; ++ni)
1299 if (p[ni] == NL)
1300 ptr[tlen++] = NUL;
1301 else
1302 ptr[tlen++] = p[ni];
1304 ptr[tlen++] = NL;
1305 read_buf_col = 0;
1306 if (++read_buf_lnum > from)
1308 /* When the last line didn't have an
1309 * end-of-line don't add it now either. */
1310 if (!curbuf->b_p_eol)
1311 --tlen;
1312 size = tlen;
1313 break;
1319 else
1322 * Read bytes from the file.
1324 size = vim_read(fd, ptr, size);
1327 if (size <= 0)
1329 if (size < 0) /* read error */
1330 error = TRUE;
1331 #ifdef FEAT_MBYTE
1332 else if (conv_restlen > 0)
1335 * Reached end-of-file but some trailing bytes could
1336 * not be converted. Truncated file?
1339 /* When we did a conversion report an error. */
1340 if (fio_flags != 0
1341 # ifdef USE_ICONV
1342 || iconv_fd != (iconv_t)-1
1343 # endif
1346 if (conv_error == 0)
1347 conv_error = curbuf->b_ml.ml_line_count
1348 - linecnt + 1;
1350 /* Remember the first linenr with an illegal byte */
1351 else if (illegal_byte == 0)
1352 illegal_byte = curbuf->b_ml.ml_line_count
1353 - linecnt + 1;
1354 if (bad_char_behavior == BAD_DROP)
1356 *(ptr - conv_restlen) = NUL;
1357 conv_restlen = 0;
1359 else
1361 /* Replace the trailing bytes with the replacement
1362 * character if we were converting; if we weren't,
1363 * leave the UTF8 checking code to do it, as it
1364 * works slightly differently. */
1365 if (bad_char_behavior != BAD_KEEP && (fio_flags != 0
1366 # ifdef USE_ICONV
1367 || iconv_fd != (iconv_t)-1
1368 # endif
1371 while (conv_restlen > 0)
1373 *(--ptr) = bad_char_behavior;
1374 --conv_restlen;
1377 fio_flags = 0; /* don't convert this */
1378 # ifdef USE_ICONV
1379 if (iconv_fd != (iconv_t)-1)
1381 iconv_close(iconv_fd);
1382 iconv_fd = (iconv_t)-1;
1384 # endif
1387 #endif
1390 #ifdef FEAT_CRYPT
1392 * At start of file: Check for magic number of encryption.
1394 if (filesize == 0)
1395 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1396 &filesize, newfile);
1398 * Decrypt the read bytes.
1400 if (cryptkey != NULL && size > 0)
1401 for (p = ptr; p < ptr + size; ++p)
1402 ZDECODE(*p);
1403 #endif
1405 skip_read = FALSE;
1407 #ifdef FEAT_MBYTE
1409 * At start of file (or after crypt magic number): Check for BOM.
1410 * Also check for a BOM for other Unicode encodings, but not after
1411 * converting with 'charconvert' or when a BOM has already been
1412 * found.
1414 if ((filesize == 0
1415 # ifdef FEAT_CRYPT
1416 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1417 # endif
1419 && (fio_flags == FIO_UCSBOM
1420 || (!curbuf->b_p_bomb
1421 && tmpname == NULL
1422 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1424 char_u *ccname;
1425 int blen;
1427 /* no BOM detection in a short file or in binary mode */
1428 if (size < 2 || curbuf->b_p_bin)
1429 ccname = NULL;
1430 else
1431 ccname = check_for_bom(ptr, size, &blen,
1432 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1433 if (ccname != NULL)
1435 /* Remove BOM from the text */
1436 filesize += blen;
1437 size -= blen;
1438 mch_memmove(ptr, ptr + blen, (size_t)size);
1439 if (set_options)
1441 curbuf->b_p_bomb = TRUE;
1442 curbuf->b_start_bomb = TRUE;
1446 if (fio_flags == FIO_UCSBOM)
1448 if (ccname == NULL)
1450 /* No BOM detected: retry with next encoding. */
1451 advance_fenc = TRUE;
1453 else
1455 /* BOM detected: set "fenc" and jump back */
1456 if (fenc_alloced)
1457 vim_free(fenc);
1458 fenc = ccname;
1459 fenc_alloced = FALSE;
1461 /* retry reading without getting new bytes or rewinding */
1462 skip_read = TRUE;
1463 goto retry;
1467 /* Include not converted bytes. */
1468 ptr -= conv_restlen;
1469 size += conv_restlen;
1470 conv_restlen = 0;
1471 #endif
1473 * Break here for a read error or end-of-file.
1475 if (size <= 0)
1476 break;
1478 #ifdef FEAT_MBYTE
1480 # ifdef USE_ICONV
1481 if (iconv_fd != (iconv_t)-1)
1484 * Attempt conversion of the read bytes to 'encoding' using
1485 * iconv().
1487 const char *fromp;
1488 char *top;
1489 size_t from_size;
1490 size_t to_size;
1492 fromp = (char *)ptr;
1493 from_size = size;
1494 ptr += size;
1495 top = (char *)ptr;
1496 to_size = real_size - size;
1499 * If there is conversion error or not enough room try using
1500 * another conversion. Except for when there is no
1501 * alternative (help files).
1503 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1504 &top, &to_size)
1505 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1506 || from_size > CONV_RESTLEN)
1508 if (can_retry)
1509 goto rewind_retry;
1510 if (conv_error == 0)
1511 conv_error = readfile_linenr(linecnt,
1512 ptr, (char_u *)top);
1514 /* Deal with a bad byte and continue with the next. */
1515 ++fromp;
1516 --from_size;
1517 if (bad_char_behavior == BAD_KEEP)
1519 *top++ = *(fromp - 1);
1520 --to_size;
1522 else if (bad_char_behavior != BAD_DROP)
1524 *top++ = bad_char_behavior;
1525 --to_size;
1529 if (from_size > 0)
1531 /* Some remaining characters, keep them for the next
1532 * round. */
1533 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1534 conv_restlen = (int)from_size;
1537 /* move the linerest to before the converted characters */
1538 line_start = ptr - linerest;
1539 mch_memmove(line_start, buffer, (size_t)linerest);
1540 size = (long)((char_u *)top - ptr);
1542 # endif
1544 # ifdef WIN3264
1545 if (fio_flags & FIO_CODEPAGE)
1547 char_u *src, *dst;
1548 WCHAR ucs2buf[3];
1549 int ucs2len;
1550 int codepage = FIO_GET_CP(fio_flags);
1551 int bytelen;
1552 int found_bad;
1553 char replstr[2];
1556 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1557 * a codepage, using standard MS-Windows functions. This
1558 * requires two steps:
1559 * 1. convert from 'fileencoding' to ucs-2
1560 * 2. convert from ucs-2 to 'encoding'
1562 * Because there may be illegal bytes AND an incomplete byte
1563 * sequence at the end, we may have to do the conversion one
1564 * character at a time to get it right.
1567 /* Replacement string for WideCharToMultiByte(). */
1568 if (bad_char_behavior > 0)
1569 replstr[0] = bad_char_behavior;
1570 else
1571 replstr[0] = '?';
1572 replstr[1] = NUL;
1575 * Move the bytes to the end of the buffer, so that we have
1576 * room to put the result at the start.
1578 src = ptr + real_size - size;
1579 mch_memmove(src, ptr, size);
1582 * Do the conversion.
1584 dst = ptr;
1585 size = size;
1586 while (size > 0)
1588 found_bad = FALSE;
1590 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1591 if (codepage == CP_UTF8)
1593 /* Handle CP_UTF8 input ourselves to be able to handle
1594 * trailing bytes properly.
1595 * Get one UTF-8 character from src. */
1596 bytelen = (int)utf_ptr2len_len(src, size);
1597 if (bytelen > size)
1599 /* Only got some bytes of a character. Normally
1600 * it's put in "conv_rest", but if it's too long
1601 * deal with it as if they were illegal bytes. */
1602 if (bytelen <= CONV_RESTLEN)
1603 break;
1605 /* weird overlong byte sequence */
1606 bytelen = size;
1607 found_bad = TRUE;
1609 else
1611 int u8c = utf_ptr2char(src);
1613 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1614 found_bad = TRUE;
1615 ucs2buf[0] = u8c;
1616 ucs2len = 1;
1619 else
1620 # endif
1622 /* We don't know how long the byte sequence is, try
1623 * from one to three bytes. */
1624 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1625 ++bytelen)
1627 ucs2len = MultiByteToWideChar(codepage,
1628 MB_ERR_INVALID_CHARS,
1629 (LPCSTR)src, bytelen,
1630 ucs2buf, 3);
1631 if (ucs2len > 0)
1632 break;
1634 if (ucs2len == 0)
1636 /* If we have only one byte then it's probably an
1637 * incomplete byte sequence. Otherwise discard
1638 * one byte as a bad character. */
1639 if (size == 1)
1640 break;
1641 found_bad = TRUE;
1642 bytelen = 1;
1646 if (!found_bad)
1648 int i;
1650 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1651 if (enc_utf8)
1653 /* From UCS-2 to UTF-8. Cannot fail. */
1654 for (i = 0; i < ucs2len; ++i)
1655 dst += utf_char2bytes(ucs2buf[i], dst);
1657 else
1659 BOOL bad = FALSE;
1660 int dstlen;
1662 /* From UCS-2 to "enc_codepage". If the
1663 * conversion uses the default character "?",
1664 * the data doesn't fit in this encoding. */
1665 dstlen = WideCharToMultiByte(enc_codepage, 0,
1666 (LPCWSTR)ucs2buf, ucs2len,
1667 (LPSTR)dst, (int)(src - dst),
1668 replstr, &bad);
1669 if (bad)
1670 found_bad = TRUE;
1671 else
1672 dst += dstlen;
1676 if (found_bad)
1678 /* Deal with bytes we can't convert. */
1679 if (can_retry)
1680 goto rewind_retry;
1681 if (conv_error == 0)
1682 conv_error = readfile_linenr(linecnt, ptr, dst);
1683 if (bad_char_behavior != BAD_DROP)
1685 if (bad_char_behavior == BAD_KEEP)
1687 mch_memmove(dst, src, bytelen);
1688 dst += bytelen;
1690 else
1691 *dst++ = bad_char_behavior;
1695 src += bytelen;
1696 size -= bytelen;
1699 if (size > 0)
1701 /* An incomplete byte sequence remaining. */
1702 mch_memmove(conv_rest, src, size);
1703 conv_restlen = size;
1706 /* The new size is equal to how much "dst" was advanced. */
1707 size = (long)(dst - ptr);
1709 else
1710 # endif
1711 # ifdef MACOS_CONVERT
1712 if (fio_flags & FIO_MACROMAN)
1715 * Conversion from Apple MacRoman char encoding to UTF-8 or
1716 * latin1. This is in os_mac_conv.c.
1718 if (macroman2enc(ptr, &size, real_size) == FAIL)
1719 goto rewind_retry;
1721 else
1722 # endif
1723 if (fio_flags != 0)
1725 int u8c;
1726 char_u *dest;
1727 char_u *tail = NULL;
1730 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1731 * "enc_utf8" not set: Convert Unicode to Latin1.
1732 * Go from end to start through the buffer, because the number
1733 * of bytes may increase.
1734 * "dest" points to after where the UTF-8 bytes go, "p" points
1735 * to after the next character to convert.
1737 dest = ptr + real_size;
1738 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1740 p = ptr + size;
1741 if (fio_flags == FIO_UTF8)
1743 /* Check for a trailing incomplete UTF-8 sequence */
1744 tail = ptr + size - 1;
1745 while (tail > ptr && (*tail & 0xc0) == 0x80)
1746 --tail;
1747 if (tail + utf_byte2len(*tail) <= ptr + size)
1748 tail = NULL;
1749 else
1750 p = tail;
1753 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1755 /* Check for a trailing byte */
1756 p = ptr + (size & ~1);
1757 if (size & 1)
1758 tail = p;
1759 if ((fio_flags & FIO_UTF16) && p > ptr)
1761 /* Check for a trailing leading word */
1762 if (fio_flags & FIO_ENDIAN_L)
1764 u8c = (*--p << 8);
1765 u8c += *--p;
1767 else
1769 u8c = *--p;
1770 u8c += (*--p << 8);
1772 if (u8c >= 0xd800 && u8c <= 0xdbff)
1773 tail = p;
1774 else
1775 p += 2;
1778 else /* FIO_UCS4 */
1780 /* Check for trailing 1, 2 or 3 bytes */
1781 p = ptr + (size & ~3);
1782 if (size & 3)
1783 tail = p;
1786 /* If there is a trailing incomplete sequence move it to
1787 * conv_rest[]. */
1788 if (tail != NULL)
1790 conv_restlen = (int)((ptr + size) - tail);
1791 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1792 size -= conv_restlen;
1796 while (p > ptr)
1798 if (fio_flags & FIO_LATIN1)
1799 u8c = *--p;
1800 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1802 if (fio_flags & FIO_ENDIAN_L)
1804 u8c = (*--p << 8);
1805 u8c += *--p;
1807 else
1809 u8c = *--p;
1810 u8c += (*--p << 8);
1812 if ((fio_flags & FIO_UTF16)
1813 && u8c >= 0xdc00 && u8c <= 0xdfff)
1815 int u16c;
1817 if (p == ptr)
1819 /* Missing leading word. */
1820 if (can_retry)
1821 goto rewind_retry;
1822 if (conv_error == 0)
1823 conv_error = readfile_linenr(linecnt,
1824 ptr, p);
1825 if (bad_char_behavior == BAD_DROP)
1826 continue;
1827 if (bad_char_behavior != BAD_KEEP)
1828 u8c = bad_char_behavior;
1831 /* found second word of double-word, get the first
1832 * word and compute the resulting character */
1833 if (fio_flags & FIO_ENDIAN_L)
1835 u16c = (*--p << 8);
1836 u16c += *--p;
1838 else
1840 u16c = *--p;
1841 u16c += (*--p << 8);
1843 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1844 + (u8c & 0x3ff);
1846 /* Check if the word is indeed a leading word. */
1847 if (u16c < 0xd800 || u16c > 0xdbff)
1849 if (can_retry)
1850 goto rewind_retry;
1851 if (conv_error == 0)
1852 conv_error = readfile_linenr(linecnt,
1853 ptr, p);
1854 if (bad_char_behavior == BAD_DROP)
1855 continue;
1856 if (bad_char_behavior != BAD_KEEP)
1857 u8c = bad_char_behavior;
1861 else if (fio_flags & FIO_UCS4)
1863 if (fio_flags & FIO_ENDIAN_L)
1865 u8c = (*--p << 24);
1866 u8c += (*--p << 16);
1867 u8c += (*--p << 8);
1868 u8c += *--p;
1870 else /* big endian */
1872 u8c = *--p;
1873 u8c += (*--p << 8);
1874 u8c += (*--p << 16);
1875 u8c += (*--p << 24);
1878 else /* UTF-8 */
1880 if (*--p < 0x80)
1881 u8c = *p;
1882 else
1884 len = utf_head_off(ptr, p);
1885 p -= len;
1886 u8c = utf_ptr2char(p);
1887 if (len == 0)
1889 /* Not a valid UTF-8 character, retry with
1890 * another fenc when possible, otherwise just
1891 * report the error. */
1892 if (can_retry)
1893 goto rewind_retry;
1894 if (conv_error == 0)
1895 conv_error = readfile_linenr(linecnt,
1896 ptr, p);
1897 if (bad_char_behavior == BAD_DROP)
1898 continue;
1899 if (bad_char_behavior != BAD_KEEP)
1900 u8c = bad_char_behavior;
1904 if (enc_utf8) /* produce UTF-8 */
1906 dest -= utf_char2len(u8c);
1907 (void)utf_char2bytes(u8c, dest);
1909 else /* produce Latin1 */
1911 --dest;
1912 if (u8c >= 0x100)
1914 /* character doesn't fit in latin1, retry with
1915 * another fenc when possible, otherwise just
1916 * report the error. */
1917 if (can_retry)
1918 goto rewind_retry;
1919 if (conv_error == 0)
1920 conv_error = readfile_linenr(linecnt, ptr, p);
1921 if (bad_char_behavior == BAD_DROP)
1922 ++dest;
1923 else if (bad_char_behavior == BAD_KEEP)
1924 *dest = u8c;
1925 else if (eap != NULL && eap->bad_char != 0)
1926 *dest = bad_char_behavior;
1927 else
1928 *dest = 0xBF;
1930 else
1931 *dest = u8c;
1935 /* move the linerest to before the converted characters */
1936 line_start = dest - linerest;
1937 mch_memmove(line_start, buffer, (size_t)linerest);
1938 size = (long)((ptr + real_size) - dest);
1939 ptr = dest;
1941 else if (enc_utf8 && !curbuf->b_p_bin)
1943 int incomplete_tail = FALSE;
1945 /* Reading UTF-8: Check if the bytes are valid UTF-8. */
1946 for (p = ptr; ; ++p)
1948 int todo = (int)((ptr + size) - p);
1949 int l;
1951 if (todo <= 0)
1952 break;
1953 if (*p >= 0x80)
1955 /* A length of 1 means it's an illegal byte. Accept
1956 * an incomplete character at the end though, the next
1957 * read() will get the next bytes, we'll check it
1958 * then. */
1959 l = utf_ptr2len_len(p, todo);
1960 if (l > todo && !incomplete_tail)
1962 /* Avoid retrying with a different encoding when
1963 * a truncated file is more likely, or attempting
1964 * to read the rest of an incomplete sequence when
1965 * we have already done so. */
1966 if (p > ptr || filesize > 0)
1967 incomplete_tail = TRUE;
1968 /* Incomplete byte sequence, move it to conv_rest[]
1969 * and try to read the rest of it, unless we've
1970 * already done so. */
1971 if (p > ptr)
1973 conv_restlen = todo;
1974 mch_memmove(conv_rest, p, conv_restlen);
1975 size -= conv_restlen;
1976 break;
1979 if (l == 1 || l > todo)
1981 /* Illegal byte. If we can try another encoding
1982 * do that, unless at EOF where a truncated
1983 * file is more likely than a conversion error. */
1984 if (can_retry && !incomplete_tail)
1985 break;
1986 # ifdef USE_ICONV
1987 /* When we did a conversion report an error. */
1988 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1989 conv_error = readfile_linenr(linecnt, ptr, p);
1990 # endif
1991 /* Remember the first linenr with an illegal byte */
1992 if (conv_error == 0 && illegal_byte == 0)
1993 illegal_byte = readfile_linenr(linecnt, ptr, p);
1995 /* Drop, keep or replace the bad byte. */
1996 if (bad_char_behavior == BAD_DROP)
1998 mch_memmove(p, p + 1, todo - 1);
1999 --p;
2000 --size;
2002 else if (bad_char_behavior != BAD_KEEP)
2003 *p = bad_char_behavior;
2005 else
2006 p += l - 1;
2009 if (p < ptr + size && !incomplete_tail)
2011 /* Detected a UTF-8 error. */
2012 rewind_retry:
2013 /* Retry reading with another conversion. */
2014 # if defined(FEAT_EVAL) && defined(USE_ICONV)
2015 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
2016 /* iconv() failed, try 'charconvert' */
2017 did_iconv = TRUE;
2018 else
2019 # endif
2020 /* use next item from 'fileencodings' */
2021 advance_fenc = TRUE;
2022 file_rewind = TRUE;
2023 goto retry;
2026 #endif
2028 /* count the number of characters (after conversion!) */
2029 filesize += size;
2032 * when reading the first part of a file: guess EOL type
2034 if (fileformat == EOL_UNKNOWN)
2036 /* First try finding a NL, for Dos and Unix */
2037 if (try_dos || try_unix)
2039 for (p = ptr; p < ptr + size; ++p)
2041 if (*p == NL)
2043 if (!try_unix
2044 || (try_dos && p > ptr && p[-1] == CAR))
2045 fileformat = EOL_DOS;
2046 else
2047 fileformat = EOL_UNIX;
2048 break;
2052 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
2053 if (fileformat == EOL_UNIX && try_mac)
2055 /* Need to reset the counters when retrying fenc. */
2056 try_mac = 1;
2057 try_unix = 1;
2058 for (; p >= ptr && *p != CAR; p--)
2060 if (p >= ptr)
2062 for (p = ptr; p < ptr + size; ++p)
2064 if (*p == NL)
2065 try_unix++;
2066 else if (*p == CAR)
2067 try_mac++;
2069 if (try_mac > try_unix)
2070 fileformat = EOL_MAC;
2075 /* No NL found: may use Mac format */
2076 if (fileformat == EOL_UNKNOWN && try_mac)
2077 fileformat = EOL_MAC;
2079 /* Still nothing found? Use first format in 'ffs' */
2080 if (fileformat == EOL_UNKNOWN)
2081 fileformat = default_fileformat();
2083 /* if editing a new file: may set p_tx and p_ff */
2084 if (set_options)
2085 set_fileformat(fileformat, OPT_LOCAL);
2090 * This loop is executed once for every character read.
2091 * Keep it fast!
2093 if (fileformat == EOL_MAC)
2095 --ptr;
2096 while (++ptr, --size >= 0)
2098 /* catch most common case first */
2099 if ((c = *ptr) != NUL && c != CAR && c != NL)
2100 continue;
2101 if (c == NUL)
2102 *ptr = NL; /* NULs are replaced by newlines! */
2103 else if (c == NL)
2104 *ptr = CAR; /* NLs are replaced by CRs! */
2105 else
2107 if (skip_count == 0)
2109 *ptr = NUL; /* end of line */
2110 len = (colnr_T) (ptr - line_start + 1);
2111 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2113 error = TRUE;
2114 break;
2116 ++lnum;
2117 if (--read_count == 0)
2119 error = TRUE; /* break loop */
2120 line_start = ptr; /* nothing left to write */
2121 break;
2124 else
2125 --skip_count;
2126 line_start = ptr + 1;
2130 else
2132 --ptr;
2133 while (++ptr, --size >= 0)
2135 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2136 continue;
2137 if (c == NUL)
2138 *ptr = NL; /* NULs are replaced by newlines! */
2139 else
2141 if (skip_count == 0)
2143 *ptr = NUL; /* end of line */
2144 len = (colnr_T)(ptr - line_start + 1);
2145 if (fileformat == EOL_DOS)
2147 if (ptr[-1] == CAR) /* remove CR */
2149 ptr[-1] = NUL;
2150 --len;
2153 * Reading in Dos format, but no CR-LF found!
2154 * When 'fileformats' includes "unix", delete all
2155 * the lines read so far and start all over again.
2156 * Otherwise give an error message later.
2158 else if (ff_error != EOL_DOS)
2160 if ( try_unix
2161 && !read_stdin
2162 && (read_buffer
2163 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2165 fileformat = EOL_UNIX;
2166 if (set_options)
2167 set_fileformat(EOL_UNIX, OPT_LOCAL);
2168 file_rewind = TRUE;
2169 keep_fileformat = TRUE;
2170 goto retry;
2172 ff_error = EOL_DOS;
2175 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2177 error = TRUE;
2178 break;
2180 ++lnum;
2181 if (--read_count == 0)
2183 error = TRUE; /* break loop */
2184 line_start = ptr; /* nothing left to write */
2185 break;
2188 else
2189 --skip_count;
2190 line_start = ptr + 1;
2194 linerest = (long)(ptr - line_start);
2195 ui_breakcheck();
2198 failed:
2199 /* not an error, max. number of lines reached */
2200 if (error && read_count == 0)
2201 error = FALSE;
2204 * If we get EOF in the middle of a line, note the fact and
2205 * complete the line ourselves.
2206 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2208 if (!error
2209 && !got_int
2210 && linerest != 0
2211 && !(!curbuf->b_p_bin
2212 && fileformat == EOL_DOS
2213 && *line_start == Ctrl_Z
2214 && ptr == line_start + 1))
2216 /* remember for when writing */
2217 if (set_options)
2218 curbuf->b_p_eol = FALSE;
2219 *ptr = NUL;
2220 if (ml_append(lnum, line_start,
2221 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2222 error = TRUE;
2223 else
2224 read_no_eol_lnum = ++lnum;
2227 if (set_options)
2228 save_file_ff(curbuf); /* remember the current file format */
2230 #ifdef FEAT_CRYPT
2231 if (cryptkey != curbuf->b_p_key)
2232 vim_free(cryptkey);
2233 #endif
2235 #ifdef FEAT_MBYTE
2236 /* If editing a new file: set 'fenc' for the current buffer.
2237 * Also for ":read ++edit file". */
2238 if (set_options)
2239 set_string_option_direct((char_u *)"fenc", -1, fenc,
2240 OPT_FREE|OPT_LOCAL, 0);
2241 if (fenc_alloced)
2242 vim_free(fenc);
2243 # ifdef USE_ICONV
2244 if (iconv_fd != (iconv_t)-1)
2246 iconv_close(iconv_fd);
2247 iconv_fd = (iconv_t)-1;
2249 # endif
2250 #endif
2252 if (!read_buffer && !read_stdin)
2253 close(fd); /* errors are ignored */
2254 vim_free(buffer);
2256 #ifdef HAVE_DUP
2257 if (read_stdin)
2259 /* Use stderr for stdin, makes shell commands work. */
2260 close(0);
2261 ignored = dup(2);
2263 #endif
2265 #ifdef FEAT_MBYTE
2266 if (tmpname != NULL)
2268 mch_remove(tmpname); /* delete converted file */
2269 vim_free(tmpname);
2271 #endif
2272 --no_wait_return; /* may wait for return now */
2275 * In recovery mode everything but autocommands is skipped.
2277 if (!recoverymode)
2279 /* need to delete the last line, which comes from the empty buffer */
2280 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2282 #ifdef FEAT_NETBEANS_INTG
2283 netbeansFireChanges = 0;
2284 #endif
2285 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2286 #ifdef FEAT_NETBEANS_INTG
2287 netbeansFireChanges = 1;
2288 #endif
2289 --linecnt;
2291 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2292 if (filesize == 0)
2293 linecnt = 0;
2294 if (newfile || read_buffer)
2296 redraw_curbuf_later(NOT_VALID);
2297 #ifdef FEAT_DIFF
2298 /* After reading the text into the buffer the diff info needs to
2299 * be updated. */
2300 diff_invalidate(curbuf);
2301 #endif
2302 #ifdef FEAT_FOLDING
2303 /* All folds in the window are invalid now. Mark them for update
2304 * before triggering autocommands. */
2305 foldUpdateAll(curwin);
2306 #endif
2308 else if (linecnt) /* appended at least one line */
2309 appended_lines_mark(from, linecnt);
2311 #ifndef ALWAYS_USE_GUI
2313 * If we were reading from the same terminal as where messages go,
2314 * the screen will have been messed up.
2315 * Switch on raw mode now and clear the screen.
2317 if (read_stdin)
2319 settmode(TMODE_RAW); /* set to raw mode */
2320 starttermcap();
2321 screenclear();
2323 #endif
2325 if (got_int)
2327 if (!(flags & READ_DUMMY))
2329 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2330 if (newfile)
2331 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2333 msg_scroll = msg_save;
2334 #ifdef FEAT_VIMINFO
2335 check_marks_read();
2336 #endif
2337 return OK; /* an interrupt isn't really an error */
2340 if (!filtering && !(flags & READ_DUMMY))
2342 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2343 c = FALSE;
2345 #ifdef UNIX
2346 # ifdef S_ISFIFO
2347 if (S_ISFIFO(perm)) /* fifo or socket */
2349 STRCAT(IObuff, _("[fifo/socket]"));
2350 c = TRUE;
2352 # else
2353 # ifdef S_IFIFO
2354 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2356 STRCAT(IObuff, _("[fifo]"));
2357 c = TRUE;
2359 # endif
2360 # ifdef S_IFSOCK
2361 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2363 STRCAT(IObuff, _("[socket]"));
2364 c = TRUE;
2366 # endif
2367 # endif
2368 # ifdef OPEN_CHR_FILES
2369 if (S_ISCHR(perm)) /* or character special */
2371 STRCAT(IObuff, _("[character special]"));
2372 c = TRUE;
2374 # endif
2375 #endif
2376 if (curbuf->b_p_ro)
2378 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2379 c = TRUE;
2381 if (read_no_eol_lnum)
2383 msg_add_eol();
2384 c = TRUE;
2386 if (ff_error == EOL_DOS)
2388 STRCAT(IObuff, _("[CR missing]"));
2389 c = TRUE;
2391 if (split)
2393 STRCAT(IObuff, _("[long lines split]"));
2394 c = TRUE;
2396 #ifdef FEAT_MBYTE
2397 if (notconverted)
2399 STRCAT(IObuff, _("[NOT converted]"));
2400 c = TRUE;
2402 else if (converted)
2404 STRCAT(IObuff, _("[converted]"));
2405 c = TRUE;
2407 #endif
2408 #ifdef FEAT_CRYPT
2409 if (cryptkey != NULL)
2411 STRCAT(IObuff, _("[crypted]"));
2412 c = TRUE;
2414 #endif
2415 #ifdef FEAT_MBYTE
2416 if (conv_error != 0)
2418 sprintf((char *)IObuff + STRLEN(IObuff),
2419 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2420 c = TRUE;
2422 else if (illegal_byte > 0)
2424 sprintf((char *)IObuff + STRLEN(IObuff),
2425 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2426 c = TRUE;
2428 else
2429 #endif
2430 if (error)
2432 STRCAT(IObuff, _("[READ ERRORS]"));
2433 c = TRUE;
2435 if (msg_add_fileformat(fileformat))
2436 c = TRUE;
2437 #ifdef FEAT_CRYPT
2438 if (cryptkey != NULL)
2439 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2440 else
2441 #endif
2442 msg_add_lines(c, (long)linecnt, filesize);
2444 vim_free(keep_msg);
2445 keep_msg = NULL;
2446 msg_scrolled_ign = TRUE;
2447 #ifdef ALWAYS_USE_GUI
2448 /* Don't show the message when reading stdin, it would end up in a
2449 * message box (which might be shown when exiting!) */
2450 if (read_stdin || read_buffer)
2451 p = msg_may_trunc(FALSE, IObuff);
2452 else
2453 #endif
2454 p = msg_trunc_attr(IObuff, FALSE, 0);
2455 if (read_stdin || read_buffer || restart_edit != 0
2456 || (msg_scrolled != 0 && !need_wait_return))
2457 /* Need to repeat the message after redrawing when:
2458 * - When reading from stdin (the screen will be cleared next).
2459 * - When restart_edit is set (otherwise there will be a delay
2460 * before redrawing).
2461 * - When the screen was scrolled but there is no wait-return
2462 * prompt. */
2463 set_keep_msg(p, 0);
2464 msg_scrolled_ign = FALSE;
2467 /* with errors writing the file requires ":w!" */
2468 if (newfile && (error
2469 #ifdef FEAT_MBYTE
2470 || conv_error != 0
2471 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2472 #endif
2474 curbuf->b_p_ro = TRUE;
2476 u_clearline(); /* cannot use "U" command after adding lines */
2479 * In Ex mode: cursor at last new line.
2480 * Otherwise: cursor at first new line.
2482 if (exmode_active)
2483 curwin->w_cursor.lnum = from + linecnt;
2484 else
2485 curwin->w_cursor.lnum = from + 1;
2486 check_cursor_lnum();
2487 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2490 * Set '[ and '] marks to the newly read lines.
2492 curbuf->b_op_start.lnum = from + 1;
2493 curbuf->b_op_start.col = 0;
2494 curbuf->b_op_end.lnum = from + linecnt;
2495 curbuf->b_op_end.col = 0;
2497 #ifdef WIN32
2499 * Work around a weird problem: When a file has two links (only
2500 * possible on NTFS) and we write through one link, then stat() it
2501 * through the other link, the timestamp information may be wrong.
2502 * It's correct again after reading the file, thus reset the timestamp
2503 * here.
2505 if (newfile && !read_stdin && !read_buffer
2506 && mch_stat((char *)fname, &st) >= 0)
2508 buf_store_time(curbuf, &st, fname);
2509 curbuf->b_mtime_read = curbuf->b_mtime;
2511 #endif
2513 msg_scroll = msg_save;
2515 #ifdef FEAT_VIMINFO
2517 * Get the marks before executing autocommands, so they can be used there.
2519 check_marks_read();
2520 #endif
2523 * Trick: We remember if the last line of the read didn't have
2524 * an eol for when writing it again. This is required for
2525 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2527 write_no_eol_lnum = read_no_eol_lnum;
2529 #ifdef FEAT_AUTOCMD
2530 if (!read_stdin && !read_buffer)
2532 int m = msg_scroll;
2533 int n = msg_scrolled;
2535 /* Save the fileformat now, otherwise the buffer will be considered
2536 * modified if the format/encoding was automatically detected. */
2537 if (set_options)
2538 save_file_ff(curbuf);
2541 * The output from the autocommands should not overwrite anything and
2542 * should not be overwritten: Set msg_scroll, restore its value if no
2543 * output was done.
2545 msg_scroll = TRUE;
2546 if (filtering)
2547 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2548 FALSE, curbuf, eap);
2549 else if (newfile)
2550 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2551 FALSE, curbuf, eap);
2552 else
2553 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2554 FALSE, NULL, eap);
2555 if (msg_scrolled == n)
2556 msg_scroll = m;
2557 #ifdef FEAT_EVAL
2558 if (aborting()) /* autocmds may abort script processing */
2559 return FAIL;
2560 #endif
2562 #endif
2564 if (recoverymode && error)
2565 return FAIL;
2566 return OK;
2569 #ifdef OPEN_CHR_FILES
2571 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2572 * which is the name of files used for process substitution output by
2573 * some shells on some operating systems, e.g., bash on SunOS.
2574 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2576 static int
2577 is_dev_fd_file(fname)
2578 char_u *fname;
2580 return (STRNCMP(fname, "/dev/fd/", 8) == 0
2581 && VIM_ISDIGIT(fname[8])
2582 && *skipdigits(fname + 9) == NUL
2583 && (fname[9] != NUL
2584 || (fname[8] != '0' && fname[8] != '1' && fname[8] != '2')));
2586 #endif
2588 #ifdef FEAT_MBYTE
2591 * From the current line count and characters read after that, estimate the
2592 * line number where we are now.
2593 * Used for error messages that include a line number.
2595 static linenr_T
2596 readfile_linenr(linecnt, p, endp)
2597 linenr_T linecnt; /* line count before reading more bytes */
2598 char_u *p; /* start of more bytes read */
2599 char_u *endp; /* end of more bytes read */
2601 char_u *s;
2602 linenr_T lnum;
2604 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2605 for (s = p; s < endp; ++s)
2606 if (*s == '\n')
2607 ++lnum;
2608 return lnum;
2610 #endif
2613 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2614 * equal to the buffer "buf". Used for calling readfile().
2615 * Returns OK or FAIL.
2618 prep_exarg(eap, buf)
2619 exarg_T *eap;
2620 buf_T *buf;
2622 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2623 #ifdef FEAT_MBYTE
2624 + STRLEN(buf->b_p_fenc)
2625 #endif
2626 + 15));
2627 if (eap->cmd == NULL)
2628 return FAIL;
2630 #ifdef FEAT_MBYTE
2631 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2632 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2633 eap->bad_char = buf->b_bad_char;
2634 #else
2635 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2636 #endif
2637 eap->force_ff = 7;
2639 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2640 eap->read_edit = FALSE;
2641 eap->forceit = FALSE;
2642 return OK;
2645 #ifdef FEAT_MBYTE
2647 * Find next fileencoding to use from 'fileencodings'.
2648 * "pp" points to fenc_next. It's advanced to the next item.
2649 * When there are no more items, an empty string is returned and *pp is set to
2650 * NULL.
2651 * When *pp is not set to NULL, the result is in allocated memory.
2653 static char_u *
2654 next_fenc(pp)
2655 char_u **pp;
2657 char_u *p;
2658 char_u *r;
2660 if (**pp == NUL)
2662 *pp = NULL;
2663 return (char_u *)"";
2665 p = vim_strchr(*pp, ',');
2666 if (p == NULL)
2668 r = enc_canonize(*pp);
2669 *pp += STRLEN(*pp);
2671 else
2673 r = vim_strnsave(*pp, (int)(p - *pp));
2674 *pp = p + 1;
2675 if (r != NULL)
2677 p = enc_canonize(r);
2678 vim_free(r);
2679 r = p;
2682 if (r == NULL) /* out of memory */
2684 r = (char_u *)"";
2685 *pp = NULL;
2687 return r;
2690 # ifdef FEAT_EVAL
2692 * Convert a file with the 'charconvert' expression.
2693 * This closes the file which is to be read, converts it and opens the
2694 * resulting file for reading.
2695 * Returns name of the resulting converted file (the caller should delete it
2696 * after reading it).
2697 * Returns NULL if the conversion failed ("*fdp" is not set) .
2699 static char_u *
2700 readfile_charconvert(fname, fenc, fdp)
2701 char_u *fname; /* name of input file */
2702 char_u *fenc; /* converted from */
2703 int *fdp; /* in/out: file descriptor of file */
2705 char_u *tmpname;
2706 char_u *errmsg = NULL;
2708 tmpname = vim_tempname('r');
2709 if (tmpname == NULL)
2710 errmsg = (char_u *)_("Can't find temp file for conversion");
2711 else
2713 close(*fdp); /* close the input file, ignore errors */
2714 *fdp = -1;
2715 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2716 fname, tmpname) == FAIL)
2717 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2718 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2719 O_RDONLY | O_EXTRA, 0)) < 0)
2720 errmsg = (char_u *)_("can't read output of 'charconvert'");
2723 if (errmsg != NULL)
2725 /* Don't use emsg(), it breaks mappings, the retry with
2726 * another type of conversion might still work. */
2727 MSG(errmsg);
2728 if (tmpname != NULL)
2730 mch_remove(tmpname); /* delete converted file */
2731 vim_free(tmpname);
2732 tmpname = NULL;
2736 /* If the input file is closed, open it (caller should check for error). */
2737 if (*fdp < 0)
2738 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2740 return tmpname;
2742 # endif
2744 #endif
2746 #ifdef FEAT_VIMINFO
2748 * Read marks for the current buffer from the viminfo file, when we support
2749 * buffer marks and the buffer has a name.
2751 static void
2752 check_marks_read()
2754 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2755 && curbuf->b_ffname != NULL)
2756 read_viminfo(NULL, VIF_WANT_MARKS);
2758 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2759 * the ' parameter after opening a buffer. */
2760 curbuf->b_marks_read = TRUE;
2762 #endif
2764 #ifdef FEAT_CRYPT
2766 * Check for magic number used for encryption.
2767 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2768 * *filesizep are updated.
2769 * Return the (new) encryption key, NULL for no encryption.
2771 static char_u *
2772 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2773 char_u *cryptkey; /* previous encryption key or NULL */
2774 char_u *ptr; /* pointer to read bytes */
2775 long *sizep; /* length of read bytes */
2776 long *filesizep; /* nr of bytes used from file */
2777 int newfile; /* editing a new buffer */
2779 if (*sizep >= CRYPT_MAGIC_LEN
2780 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2782 if (cryptkey == NULL)
2784 if (*curbuf->b_p_key)
2785 cryptkey = curbuf->b_p_key;
2786 else
2788 /* When newfile is TRUE, store the typed key
2789 * in the 'key' option and don't free it. */
2790 cryptkey = get_crypt_key(newfile, FALSE);
2791 /* check if empty key entered */
2792 if (cryptkey != NULL && *cryptkey == NUL)
2794 if (cryptkey != curbuf->b_p_key)
2795 vim_free(cryptkey);
2796 cryptkey = NULL;
2801 if (cryptkey != NULL)
2803 crypt_init_keys(cryptkey);
2805 /* Remove magic number from the text */
2806 *filesizep += CRYPT_MAGIC_LEN;
2807 *sizep -= CRYPT_MAGIC_LEN;
2808 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2811 /* When starting to edit a new file which does not have
2812 * encryption, clear the 'key' option, except when
2813 * starting up (called with -x argument) */
2814 else if (newfile && *curbuf->b_p_key && !starting)
2815 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2817 return cryptkey;
2819 #endif
2821 #ifdef UNIX
2822 static void
2823 set_file_time(fname, atime, mtime)
2824 char_u *fname;
2825 time_t atime; /* access time */
2826 time_t mtime; /* modification time */
2828 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2829 struct utimbuf buf;
2831 buf.actime = atime;
2832 buf.modtime = mtime;
2833 (void)utime((char *)fname, &buf);
2834 # else
2835 # if defined(HAVE_UTIMES)
2836 struct timeval tvp[2];
2838 tvp[0].tv_sec = atime;
2839 tvp[0].tv_usec = 0;
2840 tvp[1].tv_sec = mtime;
2841 tvp[1].tv_usec = 0;
2842 # ifdef NeXT
2843 (void)utimes((char *)fname, tvp);
2844 # else
2845 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2846 # endif
2847 # endif
2848 # endif
2850 #endif /* UNIX */
2852 #if defined(VMS) && !defined(MIN)
2853 /* Older DECC compiler for VAX doesn't define MIN() */
2854 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2855 #endif
2858 * Return TRUE if a file appears to be read-only from the file permissions.
2861 check_file_readonly(fname, perm)
2862 char_u *fname; /* full path to file */
2863 int perm; /* known permissions on file */
2865 #ifndef USE_MCH_ACCESS
2866 int fd = 0;
2867 #endif
2869 return (
2870 #ifdef USE_MCH_ACCESS
2871 # ifdef UNIX
2872 (perm & 0222) == 0 ||
2873 # endif
2874 mch_access((char *)fname, W_OK)
2875 #else
2876 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
2877 ? TRUE : (close(fd), FALSE)
2878 #endif
2884 * buf_write() - write to file "fname" lines "start" through "end"
2886 * We do our own buffering here because fwrite() is so slow.
2888 * If "forceit" is true, we don't care for errors when attempting backups.
2889 * In case of an error everything possible is done to restore the original
2890 * file. But when "forceit" is TRUE, we risk losing it.
2892 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2893 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2895 * This function must NOT use NameBuff (because it's called by autowrite()).
2897 * return FAIL for failure, OK otherwise
2900 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2901 reset_changed, filtering)
2902 buf_T *buf;
2903 char_u *fname;
2904 char_u *sfname;
2905 linenr_T start, end;
2906 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2907 NULL! */
2908 int append; /* append to the file */
2909 int forceit;
2910 int reset_changed;
2911 int filtering;
2913 int fd;
2914 char_u *backup = NULL;
2915 int backup_copy = FALSE; /* copy the original file? */
2916 int dobackup;
2917 char_u *ffname;
2918 char_u *wfname = NULL; /* name of file to write to */
2919 char_u *s;
2920 char_u *ptr;
2921 char_u c;
2922 int len;
2923 linenr_T lnum;
2924 long nchars;
2925 char_u *errmsg = NULL;
2926 char_u *errnum = NULL;
2927 char_u *buffer;
2928 char_u smallbuf[SMBUFSIZE];
2929 char_u *backup_ext;
2930 int bufsize;
2931 long perm; /* file permissions */
2932 int retval = OK;
2933 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2934 int msg_save = msg_scroll;
2935 int overwriting; /* TRUE if writing over original */
2936 int no_eol = FALSE; /* no end-of-line written */
2937 int device = FALSE; /* writing to a device */
2938 struct stat st_old;
2939 int prev_got_int = got_int;
2940 int file_readonly = FALSE; /* overwritten file is read-only */
2941 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2942 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2943 int made_writable = FALSE; /* 'w' bit has been set */
2944 #endif
2945 /* writing everything */
2946 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2947 #ifdef FEAT_AUTOCMD
2948 linenr_T old_line_count = buf->b_ml.ml_line_count;
2949 #endif
2950 int attr;
2951 int fileformat;
2952 int write_bin;
2953 struct bw_info write_info; /* info for buf_write_bytes() */
2954 #ifdef FEAT_MBYTE
2955 int converted = FALSE;
2956 int notconverted = FALSE;
2957 char_u *fenc; /* effective 'fileencoding' */
2958 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2959 #endif
2960 #ifdef HAS_BW_FLAGS
2961 int wb_flags = 0;
2962 #endif
2963 #ifdef HAVE_ACL
2964 vim_acl_T acl = NULL; /* ACL copied from original file to
2965 backup or new file */
2966 #endif
2968 if (fname == NULL || *fname == NUL) /* safety check */
2969 return FAIL;
2972 * Disallow writing from .exrc and .vimrc in current directory for
2973 * security reasons.
2975 if (check_secure())
2976 return FAIL;
2978 /* Avoid a crash for a long name. */
2979 if (STRLEN(fname) >= MAXPATHL)
2981 EMSG(_(e_longname));
2982 return FAIL;
2985 #ifdef FEAT_MBYTE
2986 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2987 write_info.bw_conv_buf = NULL;
2988 write_info.bw_conv_error = FALSE;
2989 write_info.bw_restlen = 0;
2990 # ifdef USE_ICONV
2991 write_info.bw_iconv_fd = (iconv_t)-1;
2992 # endif
2993 #endif
2995 /* After writing a file changedtick changes but we don't want to display
2996 * the line. */
2997 ex_no_reprint = TRUE;
3000 * If there is no file name yet, use the one for the written file.
3001 * BF_NOTEDITED is set to reflect this (in case the write fails).
3002 * Don't do this when the write is for a filter command.
3003 * Don't do this when appending.
3004 * Only do this when 'cpoptions' contains the 'F' flag.
3006 if (buf->b_ffname == NULL
3007 && reset_changed
3008 && whole
3009 && buf == curbuf
3010 #ifdef FEAT_QUICKFIX
3011 && !bt_nofile(buf)
3012 #endif
3013 && !filtering
3014 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
3015 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
3017 if (set_rw_fname(fname, sfname) == FAIL)
3018 return FAIL;
3019 buf = curbuf; /* just in case autocmds made "buf" invalid */
3022 if (sfname == NULL)
3023 sfname = fname;
3025 * For Unix: Use the short file name whenever possible.
3026 * Avoids problems with networks and when directory names are changed.
3027 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
3028 * another directory, which we don't detect
3030 ffname = fname; /* remember full fname */
3031 #ifdef UNIX
3032 fname = sfname;
3033 #endif
3035 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
3036 overwriting = TRUE;
3037 else
3038 overwriting = FALSE;
3040 if (exiting)
3041 settmode(TMODE_COOK); /* when exiting allow typahead now */
3043 ++no_wait_return; /* don't wait for return yet */
3046 * Set '[ and '] marks to the lines to be written.
3048 buf->b_op_start.lnum = start;
3049 buf->b_op_start.col = 0;
3050 buf->b_op_end.lnum = end;
3051 buf->b_op_end.col = 0;
3053 #ifdef FEAT_AUTOCMD
3055 aco_save_T aco;
3056 int buf_ffname = FALSE;
3057 int buf_sfname = FALSE;
3058 int buf_fname_f = FALSE;
3059 int buf_fname_s = FALSE;
3060 int did_cmd = FALSE;
3061 int nofile_err = FALSE;
3062 int empty_memline = (buf->b_ml.ml_mfp == NULL);
3065 * Apply PRE aucocommands.
3066 * Set curbuf to the buffer to be written.
3067 * Careful: The autocommands may call buf_write() recursively!
3069 if (ffname == buf->b_ffname)
3070 buf_ffname = TRUE;
3071 if (sfname == buf->b_sfname)
3072 buf_sfname = TRUE;
3073 if (fname == buf->b_ffname)
3074 buf_fname_f = TRUE;
3075 if (fname == buf->b_sfname)
3076 buf_fname_s = TRUE;
3078 /* set curwin/curbuf to buf and save a few things */
3079 aucmd_prepbuf(&aco, buf);
3081 if (append)
3083 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
3084 sfname, sfname, FALSE, curbuf, eap)))
3086 #ifdef FEAT_QUICKFIX
3087 if (overwriting && bt_nofile(curbuf))
3088 nofile_err = TRUE;
3089 else
3090 #endif
3091 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
3092 sfname, sfname, FALSE, curbuf, eap);
3095 else if (filtering)
3097 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
3098 NULL, sfname, FALSE, curbuf, eap);
3100 else if (reset_changed && whole)
3102 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
3103 sfname, sfname, FALSE, curbuf, eap)))
3105 #ifdef FEAT_QUICKFIX
3106 if (overwriting && bt_nofile(curbuf))
3107 nofile_err = TRUE;
3108 else
3109 #endif
3110 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
3111 sfname, sfname, FALSE, curbuf, eap);
3114 else
3116 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
3117 sfname, sfname, FALSE, curbuf, eap)))
3119 #ifdef FEAT_QUICKFIX
3120 if (overwriting && bt_nofile(curbuf))
3121 nofile_err = TRUE;
3122 else
3123 #endif
3124 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
3125 sfname, sfname, FALSE, curbuf, eap);
3129 /* restore curwin/curbuf and a few other things */
3130 aucmd_restbuf(&aco);
3133 * In three situations we return here and don't write the file:
3134 * 1. the autocommands deleted or unloaded the buffer.
3135 * 2. The autocommands abort script processing.
3136 * 3. If one of the "Cmd" autocommands was executed.
3138 if (!buf_valid(buf))
3139 buf = NULL;
3140 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
3141 || did_cmd || nofile_err
3142 #ifdef FEAT_EVAL
3143 || aborting()
3144 #endif
3147 --no_wait_return;
3148 msg_scroll = msg_save;
3149 if (nofile_err)
3150 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3152 if (nofile_err
3153 #ifdef FEAT_EVAL
3154 || aborting()
3155 #endif
3157 /* An aborting error, interrupt or exception in the
3158 * autocommands. */
3159 return FAIL;
3160 if (did_cmd)
3162 if (buf == NULL)
3163 /* The buffer was deleted. We assume it was written
3164 * (can't retry anyway). */
3165 return OK;
3166 if (overwriting)
3168 /* Assume the buffer was written, update the timestamp. */
3169 ml_timestamp(buf);
3170 if (append)
3171 buf->b_flags &= ~BF_NEW;
3172 else
3173 buf->b_flags &= ~BF_WRITE_MASK;
3175 if (reset_changed && buf->b_changed && !append
3176 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3177 /* Buffer still changed, the autocommands didn't work
3178 * properly. */
3179 return FAIL;
3180 return OK;
3182 #ifdef FEAT_EVAL
3183 if (!aborting())
3184 #endif
3185 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3186 return FAIL;
3190 * The autocommands may have changed the number of lines in the file.
3191 * When writing the whole file, adjust the end.
3192 * When writing part of the file, assume that the autocommands only
3193 * changed the number of lines that are to be written (tricky!).
3195 if (buf->b_ml.ml_line_count != old_line_count)
3197 if (whole) /* write all */
3198 end = buf->b_ml.ml_line_count;
3199 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3200 end += buf->b_ml.ml_line_count - old_line_count;
3201 else /* less lines */
3203 end -= old_line_count - buf->b_ml.ml_line_count;
3204 if (end < start)
3206 --no_wait_return;
3207 msg_scroll = msg_save;
3208 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3209 return FAIL;
3215 * The autocommands may have changed the name of the buffer, which may
3216 * be kept in fname, ffname and sfname.
3218 if (buf_ffname)
3219 ffname = buf->b_ffname;
3220 if (buf_sfname)
3221 sfname = buf->b_sfname;
3222 if (buf_fname_f)
3223 fname = buf->b_ffname;
3224 if (buf_fname_s)
3225 fname = buf->b_sfname;
3227 #endif
3229 #ifdef FEAT_NETBEANS_INTG
3230 if (usingNetbeans && isNetbeansBuffer(buf))
3232 if (whole)
3235 * b_changed can be 0 after an undo, but we still need to write
3236 * the buffer to NetBeans.
3238 if (buf->b_changed || isNetbeansModified(buf))
3240 --no_wait_return; /* may wait for return now */
3241 msg_scroll = msg_save;
3242 netbeans_save_buffer(buf); /* no error checking... */
3243 return retval;
3245 else
3247 errnum = (char_u *)"E656: ";
3248 errmsg = (char_u *)_("NetBeans disallows writes of unmodified buffers");
3249 buffer = NULL;
3250 goto fail;
3253 else
3255 errnum = (char_u *)"E657: ";
3256 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3257 buffer = NULL;
3258 goto fail;
3261 #endif
3263 if (shortmess(SHM_OVER) && !exiting)
3264 msg_scroll = FALSE; /* overwrite previous file message */
3265 else
3266 msg_scroll = TRUE; /* don't overwrite previous file message */
3267 if (!filtering)
3268 filemess(buf,
3269 #ifndef UNIX
3270 sfname,
3271 #else
3272 fname,
3273 #endif
3274 (char_u *)"", 0); /* show that we are busy */
3275 msg_scroll = FALSE; /* always overwrite the file message now */
3277 buffer = alloc(BUFSIZE);
3278 if (buffer == NULL) /* can't allocate big buffer, use small
3279 * one (to be able to write when out of
3280 * memory) */
3282 buffer = smallbuf;
3283 bufsize = SMBUFSIZE;
3285 else
3286 bufsize = BUFSIZE;
3289 * Get information about original file (if there is one).
3291 #if defined(UNIX) && !defined(ARCHIE)
3292 st_old.st_dev = 0;
3293 st_old.st_ino = 0;
3294 perm = -1;
3295 if (mch_stat((char *)fname, &st_old) < 0)
3296 newfile = TRUE;
3297 else
3299 perm = st_old.st_mode;
3300 if (!S_ISREG(st_old.st_mode)) /* not a file */
3302 if (S_ISDIR(st_old.st_mode))
3304 errnum = (char_u *)"E502: ";
3305 errmsg = (char_u *)_("is a directory");
3306 goto fail;
3308 if (mch_nodetype(fname) != NODE_WRITABLE)
3310 errnum = (char_u *)"E503: ";
3311 errmsg = (char_u *)_("is not a file or writable device");
3312 goto fail;
3314 /* It's a device of some kind (or a fifo) which we can write to
3315 * but for which we can't make a backup. */
3316 device = TRUE;
3317 newfile = TRUE;
3318 perm = -1;
3321 #else /* !UNIX */
3323 * Check for a writable device name.
3325 c = mch_nodetype(fname);
3326 if (c == NODE_OTHER)
3328 errnum = (char_u *)"E503: ";
3329 errmsg = (char_u *)_("is not a file or writable device");
3330 goto fail;
3332 if (c == NODE_WRITABLE)
3334 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3335 /* MS-Windows allows opening a device, but we will probably get stuck
3336 * trying to write to it. */
3337 if (!p_odev)
3339 errnum = (char_u *)"E796: ";
3340 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3341 goto fail;
3343 # endif
3344 device = TRUE;
3345 newfile = TRUE;
3346 perm = -1;
3348 else
3350 perm = mch_getperm(fname);
3351 if (perm < 0)
3352 newfile = TRUE;
3353 else if (mch_isdir(fname))
3355 errnum = (char_u *)"E502: ";
3356 errmsg = (char_u *)_("is a directory");
3357 goto fail;
3359 if (overwriting)
3360 (void)mch_stat((char *)fname, &st_old);
3362 #endif /* !UNIX */
3364 if (!device && !newfile)
3367 * Check if the file is really writable (when renaming the file to
3368 * make a backup we won't discover it later).
3370 file_readonly = check_file_readonly(fname, (int)perm);
3372 if (!forceit && file_readonly)
3374 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3376 errnum = (char_u *)"E504: ";
3377 errmsg = (char_u *)_(err_readonly);
3379 else
3381 errnum = (char_u *)"E505: ";
3382 errmsg = (char_u *)_("is read-only (add ! to override)");
3384 goto fail;
3388 * Check if the timestamp hasn't changed since reading the file.
3390 if (overwriting)
3392 retval = check_mtime(buf, &st_old);
3393 if (retval == FAIL)
3394 goto fail;
3398 #ifdef HAVE_ACL
3400 * For systems that support ACL: get the ACL from the original file.
3402 if (!newfile)
3403 acl = mch_get_acl(fname);
3404 #endif
3407 * If 'backupskip' is not empty, don't make a backup for some files.
3409 dobackup = (p_wb || p_bk || *p_pm != NUL);
3410 #ifdef FEAT_WILDIGN
3411 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3412 dobackup = FALSE;
3413 #endif
3416 * Save the value of got_int and reset it. We don't want a previous
3417 * interruption cancel writing, only hitting CTRL-C while writing should
3418 * abort it.
3420 prev_got_int = got_int;
3421 got_int = FALSE;
3423 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3424 buf->b_saving = TRUE;
3427 * If we are not appending or filtering, the file exists, and the
3428 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3429 * When 'patchmode' is set also make a backup when appending.
3431 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3432 * off. This helps when editing large files on almost-full disks.
3434 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3436 #if defined(UNIX) || defined(WIN32)
3437 struct stat st;
3438 #endif
3440 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3441 backup_copy = TRUE;
3442 #if defined(UNIX) || defined(WIN32)
3443 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3445 int i;
3447 # ifdef UNIX
3449 * Don't rename the file when:
3450 * - it's a hard link
3451 * - it's a symbolic link
3452 * - we don't have write permission in the directory
3453 * - we can't set the owner/group of the new file
3455 if (st_old.st_nlink > 1
3456 || mch_lstat((char *)fname, &st) < 0
3457 || st.st_dev != st_old.st_dev
3458 || st.st_ino != st_old.st_ino
3459 # ifndef HAVE_FCHOWN
3460 || st.st_uid != st_old.st_uid
3461 || st.st_gid != st_old.st_gid
3462 # endif
3464 backup_copy = TRUE;
3465 else
3466 # else
3467 # ifdef WIN32
3468 /* On NTFS file systems hard links are possible. */
3469 if (mch_is_linked(fname))
3470 backup_copy = TRUE;
3471 else
3472 # endif
3473 # endif
3476 * Check if we can create a file and set the owner/group to
3477 * the ones from the original file.
3478 * First find a file name that doesn't exist yet (use some
3479 * arbitrary numbers).
3481 STRCPY(IObuff, fname);
3482 for (i = 4913; ; i += 123)
3484 sprintf((char *)gettail(IObuff), "%d", i);
3485 if (mch_lstat((char *)IObuff, &st) < 0)
3486 break;
3488 fd = mch_open((char *)IObuff,
3489 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3490 if (fd < 0) /* can't write in directory */
3491 backup_copy = TRUE;
3492 else
3494 # ifdef UNIX
3495 # ifdef HAVE_FCHOWN
3496 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
3497 # endif
3498 if (mch_stat((char *)IObuff, &st) < 0
3499 || st.st_uid != st_old.st_uid
3500 || st.st_gid != st_old.st_gid
3501 || st.st_mode != perm)
3502 backup_copy = TRUE;
3503 # endif
3504 /* Close the file before removing it, on MS-Windows we
3505 * can't delete an open file. */
3506 close(fd);
3507 mch_remove(IObuff);
3512 # ifdef UNIX
3514 * Break symlinks and/or hardlinks if we've been asked to.
3516 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3518 int lstat_res;
3520 lstat_res = mch_lstat((char *)fname, &st);
3522 /* Symlinks. */
3523 if ((bkc_flags & BKC_BREAKSYMLINK)
3524 && lstat_res == 0
3525 && st.st_ino != st_old.st_ino)
3526 backup_copy = FALSE;
3528 /* Hardlinks. */
3529 if ((bkc_flags & BKC_BREAKHARDLINK)
3530 && st_old.st_nlink > 1
3531 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3532 backup_copy = FALSE;
3534 #endif
3536 #endif
3538 /* make sure we have a valid backup extension to use */
3539 if (*p_bex == NUL)
3541 #ifdef RISCOS
3542 backup_ext = (char_u *)"/bak";
3543 #else
3544 backup_ext = (char_u *)".bak";
3545 #endif
3547 else
3548 backup_ext = p_bex;
3550 if (backup_copy
3551 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3553 int bfd;
3554 char_u *copybuf, *wp;
3555 int some_error = FALSE;
3556 struct stat st_new;
3557 char_u *dirp;
3558 char_u *rootname;
3559 #if defined(UNIX) && !defined(SHORT_FNAME)
3560 int did_set_shortname;
3561 #endif
3563 copybuf = alloc(BUFSIZE + 1);
3564 if (copybuf == NULL)
3566 some_error = TRUE; /* out of memory */
3567 goto nobackup;
3571 * Try to make the backup in each directory in the 'bdir' option.
3573 * Unix semantics has it, that we may have a writable file,
3574 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3575 * - the directory is not writable,
3576 * - the file may be a symbolic link,
3577 * - the file may belong to another user/group, etc.
3579 * For these reasons, the existing writable file must be truncated
3580 * and reused. Creation of a backup COPY will be attempted.
3582 dirp = p_bdir;
3583 while (*dirp)
3585 #ifdef UNIX
3586 st_new.st_ino = 0;
3587 st_new.st_dev = 0;
3588 st_new.st_gid = 0;
3589 #endif
3592 * Isolate one directory name, using an entry in 'bdir'.
3594 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3595 rootname = get_file_in_dir(fname, copybuf);
3596 if (rootname == NULL)
3598 some_error = TRUE; /* out of memory */
3599 goto nobackup;
3602 #if defined(UNIX) && !defined(SHORT_FNAME)
3603 did_set_shortname = FALSE;
3604 #endif
3607 * May try twice if 'shortname' not set.
3609 for (;;)
3612 * Make backup file name.
3614 backup = buf_modname(
3615 #ifdef SHORT_FNAME
3616 TRUE,
3617 #else
3618 (buf->b_p_sn || buf->b_shortname),
3619 #endif
3620 rootname, backup_ext, FALSE);
3621 if (backup == NULL)
3623 vim_free(rootname);
3624 some_error = TRUE; /* out of memory */
3625 goto nobackup;
3629 * Check if backup file already exists.
3631 if (mch_stat((char *)backup, &st_new) >= 0)
3633 #ifdef UNIX
3635 * Check if backup file is same as original file.
3636 * May happen when modname() gave the same file back.
3637 * E.g. silly link, or file name-length reached.
3638 * If we don't check here, we either ruin the file
3639 * when copying or erase it after writing. jw.
3641 if (st_new.st_dev == st_old.st_dev
3642 && st_new.st_ino == st_old.st_ino)
3644 vim_free(backup);
3645 backup = NULL; /* no backup file to delete */
3646 # ifndef SHORT_FNAME
3648 * may try again with 'shortname' set
3650 if (!(buf->b_shortname || buf->b_p_sn))
3652 buf->b_shortname = TRUE;
3653 did_set_shortname = TRUE;
3654 continue;
3656 /* setting shortname didn't help */
3657 if (did_set_shortname)
3658 buf->b_shortname = FALSE;
3659 # endif
3660 break;
3662 #endif
3665 * If we are not going to keep the backup file, don't
3666 * delete an existing one, try to use another name.
3667 * Change one character, just before the extension.
3669 if (!p_bk)
3671 wp = backup + STRLEN(backup) - 1
3672 - STRLEN(backup_ext);
3673 if (wp < backup) /* empty file name ??? */
3674 wp = backup;
3675 *wp = 'z';
3676 while (*wp > 'a'
3677 && mch_stat((char *)backup, &st_new) >= 0)
3678 --*wp;
3679 /* They all exist??? Must be something wrong. */
3680 if (*wp == 'a')
3682 vim_free(backup);
3683 backup = NULL;
3687 break;
3689 vim_free(rootname);
3692 * Try to create the backup file
3694 if (backup != NULL)
3696 /* remove old backup, if present */
3697 mch_remove(backup);
3698 /* Open with O_EXCL to avoid the file being created while
3699 * we were sleeping (symlink hacker attack?) */
3700 bfd = mch_open((char *)backup,
3701 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3702 perm & 0777);
3703 if (bfd < 0)
3705 vim_free(backup);
3706 backup = NULL;
3708 else
3710 /* set file protection same as original file, but
3711 * strip s-bit */
3712 (void)mch_setperm(backup, perm & 0777);
3714 #ifdef UNIX
3716 * Try to set the group of the backup same as the
3717 * original file. If this fails, set the protection
3718 * bits for the group same as the protection bits for
3719 * others.
3721 if (st_new.st_gid != st_old.st_gid
3722 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3723 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3724 # endif
3726 mch_setperm(backup,
3727 (perm & 0707) | ((perm & 07) << 3));
3728 # ifdef HAVE_SELINUX
3729 mch_copy_sec(fname, backup);
3730 # endif
3731 #endif
3734 * copy the file.
3736 write_info.bw_fd = bfd;
3737 write_info.bw_buf = copybuf;
3738 #ifdef HAS_BW_FLAGS
3739 write_info.bw_flags = FIO_NOCONVERT;
3740 #endif
3741 while ((write_info.bw_len = vim_read(fd, copybuf,
3742 BUFSIZE)) > 0)
3744 if (buf_write_bytes(&write_info) == FAIL)
3746 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3747 break;
3749 ui_breakcheck();
3750 if (got_int)
3752 errmsg = (char_u *)_(e_interr);
3753 break;
3757 if (close(bfd) < 0 && errmsg == NULL)
3758 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3759 if (write_info.bw_len < 0)
3760 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3761 #ifdef UNIX
3762 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3763 #endif
3764 #ifdef HAVE_ACL
3765 mch_set_acl(backup, acl);
3766 #endif
3767 #ifdef HAVE_SELINUX
3768 mch_copy_sec(fname, backup);
3769 #endif
3770 break;
3774 nobackup:
3775 close(fd); /* ignore errors for closing read file */
3776 vim_free(copybuf);
3778 if (backup == NULL && errmsg == NULL)
3779 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3780 /* ignore errors when forceit is TRUE */
3781 if ((some_error || errmsg != NULL) && !forceit)
3783 retval = FAIL;
3784 goto fail;
3786 errmsg = NULL;
3788 else
3790 char_u *dirp;
3791 char_u *p;
3792 char_u *rootname;
3795 * Make a backup by renaming the original file.
3798 * If 'cpoptions' includes the "W" flag, we don't want to
3799 * overwrite a read-only file. But rename may be possible
3800 * anyway, thus we need an extra check here.
3802 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3804 errnum = (char_u *)"E504: ";
3805 errmsg = (char_u *)_(err_readonly);
3806 goto fail;
3811 * Form the backup file name - change path/fo.o.h to
3812 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3813 * that works is used.
3815 dirp = p_bdir;
3816 while (*dirp)
3819 * Isolate one directory name and make the backup file name.
3821 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3822 rootname = get_file_in_dir(fname, IObuff);
3823 if (rootname == NULL)
3824 backup = NULL;
3825 else
3827 backup = buf_modname(
3828 #ifdef SHORT_FNAME
3829 TRUE,
3830 #else
3831 (buf->b_p_sn || buf->b_shortname),
3832 #endif
3833 rootname, backup_ext, FALSE);
3834 vim_free(rootname);
3837 if (backup != NULL)
3840 * If we are not going to keep the backup file, don't
3841 * delete an existing one, try to use another name.
3842 * Change one character, just before the extension.
3844 if (!p_bk && mch_getperm(backup) >= 0)
3846 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3847 if (p < backup) /* empty file name ??? */
3848 p = backup;
3849 *p = 'z';
3850 while (*p > 'a' && mch_getperm(backup) >= 0)
3851 --*p;
3852 /* They all exist??? Must be something wrong! */
3853 if (*p == 'a')
3855 vim_free(backup);
3856 backup = NULL;
3860 if (backup != NULL)
3863 * Delete any existing backup and move the current version
3864 * to the backup. For safety, we don't remove the backup
3865 * until the write has finished successfully. And if the
3866 * 'backup' option is set, leave it around.
3869 * If the renaming of the original file to the backup file
3870 * works, quit here.
3872 if (vim_rename(fname, backup) == 0)
3873 break;
3875 vim_free(backup); /* don't do the rename below */
3876 backup = NULL;
3879 if (backup == NULL && !forceit)
3881 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3882 goto fail;
3887 #if defined(UNIX) && !defined(ARCHIE)
3888 /* When using ":w!" and the file was read-only: make it writable */
3889 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3890 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3892 perm |= 0200;
3893 (void)mch_setperm(fname, perm);
3894 made_writable = TRUE;
3896 #endif
3898 /* When using ":w!" and writing to the current file, 'readonly' makes no
3899 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3900 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3902 buf->b_p_ro = FALSE;
3903 #ifdef FEAT_TITLE
3904 need_maketitle = TRUE; /* set window title later */
3905 #endif
3906 #ifdef FEAT_WINDOWS
3907 status_redraw_all(); /* redraw status lines later */
3908 #endif
3911 if (end > buf->b_ml.ml_line_count)
3912 end = buf->b_ml.ml_line_count;
3913 if (buf->b_ml.ml_flags & ML_EMPTY)
3914 start = end + 1;
3917 * If the original file is being overwritten, there is a small chance that
3918 * we crash in the middle of writing. Therefore the file is preserved now.
3919 * This makes all block numbers positive so that recovery does not need
3920 * the original file.
3921 * Don't do this if there is a backup file and we are exiting.
3923 if (reset_changed && !newfile && overwriting
3924 && !(exiting && backup != NULL))
3926 ml_preserve(buf, FALSE);
3927 if (got_int)
3929 errmsg = (char_u *)_(e_interr);
3930 goto restore_backup;
3934 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3936 * Before risking to lose the original file verify if there's
3937 * a resource fork to preserve, and if cannot be done warn
3938 * the users. This happens when overwriting without backups.
3940 if (backup == NULL && overwriting && !append)
3941 if (mch_has_resource_fork(fname))
3943 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3944 goto restore_backup;
3946 #endif
3948 #ifdef VMS
3949 vms_remove_version(fname); /* remove version */
3950 #endif
3951 /* Default: write the file directly. May write to a temp file for
3952 * multi-byte conversion. */
3953 wfname = fname;
3955 #ifdef FEAT_MBYTE
3956 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3957 if (eap != NULL && eap->force_enc != 0)
3959 fenc = eap->cmd + eap->force_enc;
3960 fenc = enc_canonize(fenc);
3961 fenc_tofree = fenc;
3963 else
3964 fenc = buf->b_p_fenc;
3967 * The file needs to be converted when 'fileencoding' is set and
3968 * 'fileencoding' differs from 'encoding'.
3970 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
3973 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3974 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3975 * Prepare the flags for it and allocate bw_conv_buf when needed.
3977 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3979 wb_flags = get_fio_flags(fenc);
3980 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3982 /* Need to allocate a buffer to translate into. */
3983 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3984 write_info.bw_conv_buflen = bufsize * 2;
3985 else /* FIO_UCS4 */
3986 write_info.bw_conv_buflen = bufsize * 4;
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;
3994 # ifdef WIN3264
3995 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
3997 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3998 write_info.bw_conv_buflen = bufsize * 4;
3999 write_info.bw_conv_buf
4000 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4001 if (write_info.bw_conv_buf == NULL)
4002 end = 0;
4004 # endif
4006 # ifdef MACOS_X
4007 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
4009 write_info.bw_conv_buflen = bufsize * 3;
4010 write_info.bw_conv_buf
4011 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4012 if (write_info.bw_conv_buf == NULL)
4013 end = 0;
4015 # endif
4017 # if defined(FEAT_EVAL) || defined(USE_ICONV)
4018 if (converted && wb_flags == 0)
4020 # ifdef USE_ICONV
4022 * Use iconv() conversion when conversion is needed and it's not done
4023 * internally.
4025 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
4026 enc_utf8 ? (char_u *)"utf-8" : p_enc);
4027 if (write_info.bw_iconv_fd != (iconv_t)-1)
4029 /* We're going to use iconv(), allocate a buffer to convert in. */
4030 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
4031 write_info.bw_conv_buf
4032 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4033 if (write_info.bw_conv_buf == NULL)
4034 end = 0;
4035 write_info.bw_first = TRUE;
4037 # ifdef FEAT_EVAL
4038 else
4039 # endif
4040 # endif
4042 # ifdef FEAT_EVAL
4044 * When the file needs to be converted with 'charconvert' after
4045 * writing, write to a temp file instead and let the conversion
4046 * overwrite the original file.
4048 if (*p_ccv != NUL)
4050 wfname = vim_tempname('w');
4051 if (wfname == NULL) /* Can't write without a tempfile! */
4053 errmsg = (char_u *)_("E214: Can't find temp file for writing");
4054 goto restore_backup;
4057 # endif
4059 # endif
4060 if (converted && wb_flags == 0
4061 # ifdef USE_ICONV
4062 && write_info.bw_iconv_fd == (iconv_t)-1
4063 # endif
4064 # ifdef FEAT_EVAL
4065 && wfname == fname
4066 # endif
4069 if (!forceit)
4071 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
4072 goto restore_backup;
4074 notconverted = TRUE;
4076 #endif
4079 * Open the file "wfname" for writing.
4080 * We may try to open the file twice: If we can't write to the
4081 * file and forceit is TRUE we delete the existing file and try to create
4082 * a new one. If this still fails we may have lost the original file!
4083 * (this may happen when the user reached his quotum for number of files).
4084 * Appending will fail if the file does not exist and forceit is FALSE.
4086 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
4087 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
4088 : (O_CREAT | O_TRUNC))
4089 , perm < 0 ? 0666 : (perm & 0777))) < 0)
4092 * A forced write will try to create a new file if the old one is
4093 * still readonly. This may also happen when the directory is
4094 * read-only. In that case the mch_remove() will fail.
4096 if (errmsg == NULL)
4098 #ifdef UNIX
4099 struct stat st;
4101 /* Don't delete the file when it's a hard or symbolic link. */
4102 if ((!newfile && st_old.st_nlink > 1)
4103 || (mch_lstat((char *)fname, &st) == 0
4104 && (st.st_dev != st_old.st_dev
4105 || st.st_ino != st_old.st_ino)))
4106 errmsg = (char_u *)_("E166: Can't open linked file for writing");
4107 else
4108 #endif
4110 errmsg = (char_u *)_("E212: Can't open file for writing");
4111 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
4112 && perm >= 0)
4114 #ifdef UNIX
4115 /* we write to the file, thus it should be marked
4116 writable after all */
4117 if (!(perm & 0200))
4118 made_writable = TRUE;
4119 perm |= 0200;
4120 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
4121 perm &= 0777;
4122 #endif
4123 if (!append) /* don't remove when appending */
4124 mch_remove(wfname);
4125 continue;
4130 restore_backup:
4132 struct stat st;
4135 * If we failed to open the file, we don't need a backup. Throw it
4136 * away. If we moved or removed the original file try to put the
4137 * backup in its place.
4139 if (backup != NULL && wfname == fname)
4141 if (backup_copy)
4144 * There is a small chance that we removed the original,
4145 * try to move the copy in its place.
4146 * This may not work if the vim_rename() fails.
4147 * In that case we leave the copy around.
4149 /* If file does not exist, put the copy in its place */
4150 if (mch_stat((char *)fname, &st) < 0)
4151 vim_rename(backup, fname);
4152 /* if original file does exist throw away the copy */
4153 if (mch_stat((char *)fname, &st) >= 0)
4154 mch_remove(backup);
4156 else
4158 /* try to put the original file back */
4159 vim_rename(backup, fname);
4163 /* if original file no longer exists give an extra warning */
4164 if (!newfile && mch_stat((char *)fname, &st) < 0)
4165 end = 0;
4168 #ifdef FEAT_MBYTE
4169 if (wfname != fname)
4170 vim_free(wfname);
4171 #endif
4172 goto fail;
4174 errmsg = NULL;
4176 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4177 /* TODO: Is it need for MACOS_X? (Dany) */
4179 * On macintosh copy the original files attributes (i.e. the backup)
4180 * This is done in order to preserve the resource fork and the
4181 * Finder attribute (label, comments, custom icons, file creator)
4183 if (backup != NULL && overwriting && !append)
4185 if (backup_copy)
4186 (void)mch_copy_file_attribute(wfname, backup);
4187 else
4188 (void)mch_copy_file_attribute(backup, wfname);
4191 if (!overwriting && !append)
4193 if (buf->b_ffname != NULL)
4194 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4195 /* Should copy resource fork */
4197 #endif
4199 write_info.bw_fd = fd;
4201 #ifdef FEAT_CRYPT
4202 if (*buf->b_p_key && !filtering)
4204 crypt_init_keys(buf->b_p_key);
4205 /* Write magic number, so that Vim knows that this file is encrypted
4206 * when reading it again. This also undergoes utf-8 to ucs-2/4
4207 * conversion when needed. */
4208 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4209 write_info.bw_len = CRYPT_MAGIC_LEN;
4210 write_info.bw_flags = FIO_NOCONVERT;
4211 if (buf_write_bytes(&write_info) == FAIL)
4212 end = 0;
4213 wb_flags |= FIO_ENCRYPTED;
4215 #endif
4217 write_info.bw_buf = buffer;
4218 nchars = 0;
4220 /* use "++bin", "++nobin" or 'binary' */
4221 if (eap != NULL && eap->force_bin != 0)
4222 write_bin = (eap->force_bin == FORCE_BIN);
4223 else
4224 write_bin = buf->b_p_bin;
4226 #ifdef FEAT_MBYTE
4228 * The BOM is written just after the encryption magic number.
4229 * Skip it when appending and the file already existed, the BOM only makes
4230 * sense at the start of the file.
4232 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4234 write_info.bw_len = make_bom(buffer, fenc);
4235 if (write_info.bw_len > 0)
4237 /* don't convert, do encryption */
4238 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4239 if (buf_write_bytes(&write_info) == FAIL)
4240 end = 0;
4241 else
4242 nchars += write_info.bw_len;
4245 #endif
4247 write_info.bw_len = bufsize;
4248 #ifdef HAS_BW_FLAGS
4249 write_info.bw_flags = wb_flags;
4250 #endif
4251 fileformat = get_fileformat_force(buf, eap);
4252 s = buffer;
4253 len = 0;
4254 for (lnum = start; lnum <= end; ++lnum)
4257 * The next while loop is done once for each character written.
4258 * Keep it fast!
4260 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4261 while ((c = *++ptr) != NUL)
4263 if (c == NL)
4264 *s = NUL; /* replace newlines with NULs */
4265 else if (c == CAR && fileformat == EOL_MAC)
4266 *s = NL; /* Mac: replace CRs with NLs */
4267 else
4268 *s = c;
4269 ++s;
4270 if (++len != bufsize)
4271 continue;
4272 if (buf_write_bytes(&write_info) == FAIL)
4274 end = 0; /* write error: break loop */
4275 break;
4277 nchars += bufsize;
4278 s = buffer;
4279 len = 0;
4281 /* write failed or last line has no EOL: stop here */
4282 if (end == 0
4283 || (lnum == end
4284 && write_bin
4285 && (lnum == write_no_eol_lnum
4286 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4288 ++lnum; /* written the line, count it */
4289 no_eol = TRUE;
4290 break;
4292 if (fileformat == EOL_UNIX)
4293 *s++ = NL;
4294 else
4296 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4297 if (fileformat == EOL_DOS) /* write CR-NL */
4299 if (++len == bufsize)
4301 if (buf_write_bytes(&write_info) == FAIL)
4303 end = 0; /* write error: break loop */
4304 break;
4306 nchars += bufsize;
4307 s = buffer;
4308 len = 0;
4310 *s++ = NL;
4313 if (++len == bufsize && end)
4315 if (buf_write_bytes(&write_info) == FAIL)
4317 end = 0; /* write error: break loop */
4318 break;
4320 nchars += bufsize;
4321 s = buffer;
4322 len = 0;
4324 ui_breakcheck();
4325 if (got_int)
4327 end = 0; /* Interrupted, break loop */
4328 break;
4331 #ifdef VMS
4333 * On VMS there is a problem: newlines get added when writing blocks
4334 * at a time. Fix it by writing a line at a time.
4335 * This is much slower!
4336 * Explanation: VAX/DECC RTL insists that records in some RMS
4337 * structures end with a newline (carriage return) character, and if
4338 * they don't it adds one.
4339 * With other RMS structures it works perfect without this fix.
4341 if (buf->b_fab_rfm == FAB$C_VFC
4342 || ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0))
4344 int b2write;
4346 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4347 ? MIN(4096, bufsize)
4348 : MIN(buf->b_fab_mrs, bufsize));
4350 b2write = len;
4351 while (b2write > 0)
4353 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4354 if (buf_write_bytes(&write_info) == FAIL)
4356 end = 0;
4357 break;
4359 b2write -= MIN(b2write, buf->b_fab_mrs);
4361 write_info.bw_len = bufsize;
4362 nchars += len;
4363 s = buffer;
4364 len = 0;
4366 #endif
4368 if (len > 0 && end > 0)
4370 write_info.bw_len = len;
4371 if (buf_write_bytes(&write_info) == FAIL)
4372 end = 0; /* write error */
4373 nchars += len;
4376 #if defined(UNIX) && defined(HAVE_FSYNC)
4377 /* On many journalling file systems there is a bug that causes both the
4378 * original and the backup file to be lost when halting the system right
4379 * after writing the file. That's because only the meta-data is
4380 * journalled. Syncing the file slows down the system, but assures it has
4381 * been written to disk and we don't lose it.
4382 * For a device do try the fsync() but don't complain if it does not work
4383 * (could be a pipe).
4384 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4385 if (p_fs && fsync(fd) != 0 && !device)
4387 errmsg = (char_u *)_("E667: Fsync failed");
4388 end = 0;
4390 #endif
4392 #ifdef HAVE_SELINUX
4393 /* Probably need to set the security context. */
4394 if (!backup_copy)
4395 mch_copy_sec(backup, wfname);
4396 #endif
4398 #ifdef UNIX
4399 /* When creating a new file, set its owner/group to that of the original
4400 * file. Get the new device and inode number. */
4401 if (backup != NULL && !backup_copy)
4403 # ifdef HAVE_FCHOWN
4404 struct stat st;
4406 /* don't change the owner when it's already OK, some systems remove
4407 * permission or ACL stuff */
4408 if (mch_stat((char *)wfname, &st) < 0
4409 || st.st_uid != st_old.st_uid
4410 || st.st_gid != st_old.st_gid)
4412 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
4413 if (perm >= 0) /* set permission again, may have changed */
4414 (void)mch_setperm(wfname, perm);
4416 # endif
4417 buf_setino(buf);
4419 else if (buf->b_dev < 0)
4420 /* Set the inode when creating a new file. */
4421 buf_setino(buf);
4422 #endif
4424 if (close(fd) != 0)
4426 errmsg = (char_u *)_("E512: Close failed");
4427 end = 0;
4430 #ifdef UNIX
4431 if (made_writable)
4432 perm &= ~0200; /* reset 'w' bit for security reasons */
4433 #endif
4434 if (perm >= 0) /* set perm. of new file same as old file */
4435 (void)mch_setperm(wfname, perm);
4436 #ifdef RISCOS
4437 if (!append && !filtering)
4438 /* Set the filetype after writing the file. */
4439 mch_set_filetype(wfname, buf->b_p_oft);
4440 #endif
4441 #ifdef HAVE_ACL
4442 /* Probably need to set the ACL before changing the user (can't set the
4443 * ACL on a file the user doesn't own). */
4444 if (!backup_copy)
4445 mch_set_acl(wfname, acl);
4446 #endif
4449 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4450 if (wfname != fname)
4453 * The file was written to a temp file, now it needs to be converted
4454 * with 'charconvert' to (overwrite) the output file.
4456 if (end != 0)
4458 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4459 wfname, fname) == FAIL)
4461 write_info.bw_conv_error = TRUE;
4462 end = 0;
4465 mch_remove(wfname);
4466 vim_free(wfname);
4468 #endif
4470 if (end == 0)
4472 if (errmsg == NULL)
4474 #ifdef FEAT_MBYTE
4475 if (write_info.bw_conv_error)
4476 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4477 else
4478 #endif
4479 if (got_int)
4480 errmsg = (char_u *)_(e_interr);
4481 else
4482 errmsg = (char_u *)_("E514: write error (file system full?)");
4486 * If we have a backup file, try to put it in place of the new file,
4487 * because the new file is probably corrupt. This avoids losing the
4488 * original file when trying to make a backup when writing the file a
4489 * second time.
4490 * When "backup_copy" is set we need to copy the backup over the new
4491 * file. Otherwise rename the backup file.
4492 * If this is OK, don't give the extra warning message.
4494 if (backup != NULL)
4496 if (backup_copy)
4498 /* This may take a while, if we were interrupted let the user
4499 * know we got the message. */
4500 if (got_int)
4502 MSG(_(e_interr));
4503 out_flush();
4505 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4507 if ((write_info.bw_fd = mch_open((char *)fname,
4508 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4509 perm & 0777)) >= 0)
4511 /* copy the file. */
4512 write_info.bw_buf = smallbuf;
4513 #ifdef HAS_BW_FLAGS
4514 write_info.bw_flags = FIO_NOCONVERT;
4515 #endif
4516 while ((write_info.bw_len = vim_read(fd, smallbuf,
4517 SMBUFSIZE)) > 0)
4518 if (buf_write_bytes(&write_info) == FAIL)
4519 break;
4521 if (close(write_info.bw_fd) >= 0
4522 && write_info.bw_len == 0)
4523 end = 1; /* success */
4525 close(fd); /* ignore errors for closing read file */
4528 else
4530 if (vim_rename(backup, fname) == 0)
4531 end = 1;
4534 goto fail;
4537 lnum -= start; /* compute number of written lines */
4538 --no_wait_return; /* may wait for return now */
4540 #if !(defined(UNIX) || defined(VMS))
4541 fname = sfname; /* use shortname now, for the messages */
4542 #endif
4543 if (!filtering)
4545 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4546 c = FALSE;
4547 #ifdef FEAT_MBYTE
4548 if (write_info.bw_conv_error)
4550 STRCAT(IObuff, _(" CONVERSION ERROR"));
4551 c = TRUE;
4553 else if (notconverted)
4555 STRCAT(IObuff, _("[NOT converted]"));
4556 c = TRUE;
4558 else if (converted)
4560 STRCAT(IObuff, _("[converted]"));
4561 c = TRUE;
4563 #endif
4564 if (device)
4566 STRCAT(IObuff, _("[Device]"));
4567 c = TRUE;
4569 else if (newfile)
4571 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4572 c = TRUE;
4574 if (no_eol)
4576 msg_add_eol();
4577 c = TRUE;
4579 /* may add [unix/dos/mac] */
4580 if (msg_add_fileformat(fileformat))
4581 c = TRUE;
4582 #ifdef FEAT_CRYPT
4583 if (wb_flags & FIO_ENCRYPTED)
4585 STRCAT(IObuff, _("[crypted]"));
4586 c = TRUE;
4588 #endif
4589 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4590 if (!shortmess(SHM_WRITE))
4592 if (append)
4593 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4594 else
4595 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4598 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4601 /* When written everything correctly: reset 'modified'. Unless not
4602 * writing to the original file and '+' is not in 'cpoptions'. */
4603 if (reset_changed && whole && !append
4604 #ifdef FEAT_MBYTE
4605 && !write_info.bw_conv_error
4606 #endif
4607 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4610 unchanged(buf, TRUE);
4611 u_unchanged(buf);
4615 * If written to the current file, update the timestamp of the swap file
4616 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4618 if (overwriting)
4620 ml_timestamp(buf);
4621 if (append)
4622 buf->b_flags &= ~BF_NEW;
4623 else
4624 buf->b_flags &= ~BF_WRITE_MASK;
4628 * If we kept a backup until now, and we are in patch mode, then we make
4629 * the backup file our 'original' file.
4631 if (*p_pm && dobackup)
4633 char *org = (char *)buf_modname(
4634 #ifdef SHORT_FNAME
4635 TRUE,
4636 #else
4637 (buf->b_p_sn || buf->b_shortname),
4638 #endif
4639 fname, p_pm, FALSE);
4641 if (backup != NULL)
4643 struct stat st;
4646 * If the original file does not exist yet
4647 * the current backup file becomes the original file
4649 if (org == NULL)
4650 EMSG(_("E205: Patchmode: can't save original file"));
4651 else if (mch_stat(org, &st) < 0)
4653 vim_rename(backup, (char_u *)org);
4654 vim_free(backup); /* don't delete the file */
4655 backup = NULL;
4656 #ifdef UNIX
4657 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4658 #endif
4662 * If there is no backup file, remember that a (new) file was
4663 * created.
4665 else
4667 int empty_fd;
4669 if (org == NULL
4670 || (empty_fd = mch_open(org,
4671 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4672 perm < 0 ? 0666 : (perm & 0777))) < 0)
4673 EMSG(_("E206: patchmode: can't touch empty original file"));
4674 else
4675 close(empty_fd);
4677 if (org != NULL)
4679 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4680 vim_free(org);
4685 * Remove the backup unless 'backup' option is set
4687 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4688 EMSG(_("E207: Can't delete backup file"));
4690 #ifdef FEAT_SUN_WORKSHOP
4691 if (usingSunWorkShop)
4692 workshop_file_saved((char *) ffname);
4693 #endif
4695 goto nofail;
4698 * Finish up. We get here either after failure or success.
4700 fail:
4701 --no_wait_return; /* may wait for return now */
4702 nofail:
4704 /* Done saving, we accept changed buffer warnings again */
4705 buf->b_saving = FALSE;
4707 vim_free(backup);
4708 if (buffer != smallbuf)
4709 vim_free(buffer);
4710 #ifdef FEAT_MBYTE
4711 vim_free(fenc_tofree);
4712 vim_free(write_info.bw_conv_buf);
4713 # ifdef USE_ICONV
4714 if (write_info.bw_iconv_fd != (iconv_t)-1)
4716 iconv_close(write_info.bw_iconv_fd);
4717 write_info.bw_iconv_fd = (iconv_t)-1;
4719 # endif
4720 #endif
4721 #ifdef HAVE_ACL
4722 mch_free_acl(acl);
4723 #endif
4725 if (errmsg != NULL)
4727 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4729 attr = hl_attr(HLF_E); /* set highlight for error messages */
4730 msg_add_fname(buf,
4731 #ifndef UNIX
4732 sfname
4733 #else
4734 fname
4735 #endif
4736 ); /* put file name in IObuff with quotes */
4737 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4738 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4739 /* If the error message has the form "is ...", put the error number in
4740 * front of the file name. */
4741 if (errnum != NULL)
4743 STRMOVE(IObuff + numlen, IObuff);
4744 mch_memmove(IObuff, errnum, (size_t)numlen);
4746 STRCAT(IObuff, errmsg);
4747 emsg(IObuff);
4749 retval = FAIL;
4750 if (end == 0)
4752 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4753 attr | MSG_HIST);
4754 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4755 attr | MSG_HIST);
4757 /* Update the timestamp to avoid an "overwrite changed file"
4758 * prompt when writing again. */
4759 if (mch_stat((char *)fname, &st_old) >= 0)
4761 buf_store_time(buf, &st_old, fname);
4762 buf->b_mtime_read = buf->b_mtime;
4766 msg_scroll = msg_save;
4768 #ifdef FEAT_AUTOCMD
4769 #ifdef FEAT_EVAL
4770 if (!should_abort(retval))
4771 #else
4772 if (!got_int)
4773 #endif
4775 aco_save_T aco;
4777 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4780 * Apply POST autocommands.
4781 * Careful: The autocommands may call buf_write() recursively!
4783 aucmd_prepbuf(&aco, buf);
4785 if (append)
4786 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4787 FALSE, curbuf, eap);
4788 else if (filtering)
4789 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4790 FALSE, curbuf, eap);
4791 else if (reset_changed && whole)
4792 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4793 FALSE, curbuf, eap);
4794 else
4795 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4796 FALSE, curbuf, eap);
4798 /* restore curwin/curbuf and a few other things */
4799 aucmd_restbuf(&aco);
4801 #ifdef FEAT_EVAL
4802 if (aborting()) /* autocmds may abort script processing */
4803 retval = FALSE;
4804 #endif
4806 #endif
4808 got_int |= prev_got_int;
4810 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4811 /* Update machine specific information. */
4812 mch_post_buffer_write(buf);
4813 #endif
4814 return retval;
4818 * Set the name of the current buffer. Use when the buffer doesn't have a
4819 * name and a ":r" or ":w" command with a file name is used.
4821 static int
4822 set_rw_fname(fname, sfname)
4823 char_u *fname;
4824 char_u *sfname;
4826 #ifdef FEAT_AUTOCMD
4827 /* It's like the unnamed buffer is deleted.... */
4828 if (curbuf->b_p_bl)
4829 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4830 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4831 # ifdef FEAT_EVAL
4832 if (aborting()) /* autocmds may abort script processing */
4833 return FAIL;
4834 # endif
4835 #endif
4837 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4838 curbuf->b_flags |= BF_NOTEDITED;
4840 #ifdef FEAT_AUTOCMD
4841 /* ....and a new named one is created */
4842 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4843 if (curbuf->b_p_bl)
4844 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4845 # ifdef FEAT_EVAL
4846 if (aborting()) /* autocmds may abort script processing */
4847 return FAIL;
4848 # endif
4850 /* Do filetype detection now if 'filetype' is empty. */
4851 if (*curbuf->b_p_ft == NUL)
4853 if (au_has_group((char_u *)"filetypedetect"))
4854 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4855 do_modelines(0);
4857 #endif
4859 return OK;
4863 * Put file name into IObuff with quotes.
4865 void
4866 msg_add_fname(buf, fname)
4867 buf_T *buf;
4868 char_u *fname;
4870 if (fname == NULL)
4871 fname = (char_u *)"-stdin-";
4872 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4873 IObuff[0] = '"';
4874 STRCAT(IObuff, "\" ");
4878 * Append message for text mode to IObuff.
4879 * Return TRUE if something appended.
4881 static int
4882 msg_add_fileformat(eol_type)
4883 int eol_type;
4885 #ifndef USE_CRNL
4886 if (eol_type == EOL_DOS)
4888 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4889 return TRUE;
4891 #endif
4892 #ifndef USE_CR
4893 if (eol_type == EOL_MAC)
4895 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4896 return TRUE;
4898 #endif
4899 #if defined(USE_CRNL) || defined(USE_CR)
4900 if (eol_type == EOL_UNIX)
4902 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4903 return TRUE;
4905 #endif
4906 return FALSE;
4910 * Append line and character count to IObuff.
4912 void
4913 msg_add_lines(insert_space, lnum, nchars)
4914 int insert_space;
4915 long lnum;
4916 long nchars;
4918 char_u *p;
4920 p = IObuff + STRLEN(IObuff);
4922 if (insert_space)
4923 *p++ = ' ';
4924 if (shortmess(SHM_LINES))
4925 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4926 else
4928 if (lnum == 1)
4929 STRCPY(p, _("1 line, "));
4930 else
4931 sprintf((char *)p, _("%ld lines, "), lnum);
4932 p += STRLEN(p);
4933 if (nchars == 1)
4934 STRCPY(p, _("1 character"));
4935 else
4936 sprintf((char *)p, _("%ld characters"), nchars);
4941 * Append message for missing line separator to IObuff.
4943 static void
4944 msg_add_eol()
4946 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4950 * Check modification time of file, before writing to it.
4951 * The size isn't checked, because using a tool like "gzip" takes care of
4952 * using the same timestamp but can't set the size.
4954 static int
4955 check_mtime(buf, st)
4956 buf_T *buf;
4957 struct stat *st;
4959 if (buf->b_mtime_read != 0
4960 && time_differs((long)st->st_mtime, buf->b_mtime_read))
4962 msg_scroll = TRUE; /* don't overwrite messages here */
4963 msg_silent = 0; /* must give this prompt */
4964 /* don't use emsg() here, don't want to flush the buffers */
4965 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4966 hl_attr(HLF_E));
4967 if (ask_yesno((char_u *)_("Do you really want to write to it"),
4968 TRUE) == 'n')
4969 return FAIL;
4970 msg_scroll = FALSE; /* always overwrite the file message now */
4972 return OK;
4975 static int
4976 time_differs(t1, t2)
4977 long t1, t2;
4979 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4980 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4981 * the seconds. Since the roundoff is done when flushing the inode, the
4982 * time may change unexpectedly by one second!!! */
4983 return (t1 - t2 > 1 || t2 - t1 > 1);
4984 #else
4985 return (t1 != t2);
4986 #endif
4990 * Call write() to write a number of bytes to the file.
4991 * Also handles encryption and 'encoding' conversion.
4993 * Return FAIL for failure, OK otherwise.
4995 static int
4996 buf_write_bytes(ip)
4997 struct bw_info *ip;
4999 int wlen;
5000 char_u *buf = ip->bw_buf; /* data to write */
5001 int len = ip->bw_len; /* length of data */
5002 #ifdef HAS_BW_FLAGS
5003 int flags = ip->bw_flags; /* extra flags */
5004 #endif
5006 #ifdef FEAT_MBYTE
5008 * Skip conversion when writing the crypt magic number or the BOM.
5010 if (!(flags & FIO_NOCONVERT))
5012 char_u *p;
5013 unsigned c;
5014 int n;
5016 if (flags & FIO_UTF8)
5019 * Convert latin1 in the buffer to UTF-8 in the file.
5021 p = ip->bw_conv_buf; /* translate to buffer */
5022 for (wlen = 0; wlen < len; ++wlen)
5023 p += utf_char2bytes(buf[wlen], p);
5024 buf = ip->bw_conv_buf;
5025 len = (int)(p - ip->bw_conv_buf);
5027 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
5030 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
5031 * Latin1 chars in the file.
5033 if (flags & FIO_LATIN1)
5034 p = buf; /* translate in-place (can only get shorter) */
5035 else
5036 p = ip->bw_conv_buf; /* translate to buffer */
5037 for (wlen = 0; wlen < len; wlen += n)
5039 if (wlen == 0 && ip->bw_restlen != 0)
5041 int l;
5043 /* Use remainder of previous call. Append the start of
5044 * buf[] to get a full sequence. Might still be too
5045 * short! */
5046 l = CONV_RESTLEN - ip->bw_restlen;
5047 if (l > len)
5048 l = len;
5049 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
5050 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
5051 if (n > ip->bw_restlen + len)
5053 /* We have an incomplete byte sequence at the end to
5054 * be written. We can't convert it without the
5055 * remaining bytes. Keep them for the next call. */
5056 if (ip->bw_restlen + len > CONV_RESTLEN)
5057 return FAIL;
5058 ip->bw_restlen += len;
5059 break;
5061 if (n > 1)
5062 c = utf_ptr2char(ip->bw_rest);
5063 else
5064 c = ip->bw_rest[0];
5065 if (n >= ip->bw_restlen)
5067 n -= ip->bw_restlen;
5068 ip->bw_restlen = 0;
5070 else
5072 ip->bw_restlen -= n;
5073 mch_memmove(ip->bw_rest, ip->bw_rest + n,
5074 (size_t)ip->bw_restlen);
5075 n = 0;
5078 else
5080 n = utf_ptr2len_len(buf + wlen, len - wlen);
5081 if (n > len - wlen)
5083 /* We have an incomplete byte sequence at the end to
5084 * be written. We can't convert it without the
5085 * remaining bytes. Keep them for the next call. */
5086 if (len - wlen > CONV_RESTLEN)
5087 return FAIL;
5088 ip->bw_restlen = len - wlen;
5089 mch_memmove(ip->bw_rest, buf + wlen,
5090 (size_t)ip->bw_restlen);
5091 break;
5093 if (n > 1)
5094 c = utf_ptr2char(buf + wlen);
5095 else
5096 c = buf[wlen];
5099 ip->bw_conv_error |= ucs2bytes(c, &p, flags);
5101 if (flags & FIO_LATIN1)
5102 len = (int)(p - buf);
5103 else
5105 buf = ip->bw_conv_buf;
5106 len = (int)(p - ip->bw_conv_buf);
5110 # ifdef WIN3264
5111 else if (flags & FIO_CODEPAGE)
5114 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5115 * codepage.
5117 char_u *from;
5118 size_t fromlen;
5119 char_u *to;
5120 int u8c;
5121 BOOL bad = FALSE;
5122 int needed;
5124 if (ip->bw_restlen > 0)
5126 /* Need to concatenate the remainder of the previous call and
5127 * the bytes of the current call. Use the end of the
5128 * conversion buffer for this. */
5129 fromlen = len + ip->bw_restlen;
5130 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5131 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5132 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5134 else
5136 from = buf;
5137 fromlen = len;
5140 to = ip->bw_conv_buf;
5141 if (enc_utf8)
5143 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5144 * The buffer has been allocated to be big enough. */
5145 while (fromlen > 0)
5147 n = (int)utf_ptr2len_len(from, (int)fromlen);
5148 if (n > (int)fromlen) /* incomplete byte sequence */
5149 break;
5150 u8c = utf_ptr2char(from);
5151 *to++ = (u8c & 0xff);
5152 *to++ = (u8c >> 8);
5153 fromlen -= n;
5154 from += n;
5157 /* Copy remainder to ip->bw_rest[] to be used for the next
5158 * call. */
5159 if (fromlen > CONV_RESTLEN)
5161 /* weird overlong sequence */
5162 ip->bw_conv_error = TRUE;
5163 return FAIL;
5165 mch_memmove(ip->bw_rest, from, fromlen);
5166 ip->bw_restlen = (int)fromlen;
5168 else
5170 /* Convert from enc_codepage to UCS-2, to the start of the
5171 * buffer. The buffer has been allocated to be big enough. */
5172 ip->bw_restlen = 0;
5173 needed = MultiByteToWideChar(enc_codepage,
5174 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5175 NULL, 0);
5176 if (needed == 0)
5178 /* When conversion fails there may be a trailing byte. */
5179 needed = MultiByteToWideChar(enc_codepage,
5180 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5181 NULL, 0);
5182 if (needed == 0)
5184 /* Conversion doesn't work. */
5185 ip->bw_conv_error = TRUE;
5186 return FAIL;
5188 /* Save the trailing byte for the next call. */
5189 ip->bw_rest[0] = from[fromlen - 1];
5190 ip->bw_restlen = 1;
5192 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5193 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5194 (LPWSTR)to, needed);
5195 if (needed == 0)
5197 /* Safety check: Conversion doesn't work. */
5198 ip->bw_conv_error = TRUE;
5199 return FAIL;
5201 to += needed * 2;
5204 fromlen = to - ip->bw_conv_buf;
5205 buf = to;
5206 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5207 if (FIO_GET_CP(flags) == CP_UTF8)
5209 /* Convert from UCS-2 to UTF-8, using the remainder of the
5210 * conversion buffer. Fails when out of space. */
5211 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5213 u8c = *from++;
5214 u8c += (*from++ << 8);
5215 to += utf_char2bytes(u8c, to);
5216 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5218 ip->bw_conv_error = TRUE;
5219 return FAIL;
5222 len = (int)(to - buf);
5224 else
5225 #endif
5227 /* Convert from UCS-2 to the codepage, using the remainder of
5228 * the conversion buffer. If the conversion uses the default
5229 * character "0", the data doesn't fit in this encoding, so
5230 * fail. */
5231 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5232 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5233 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0,
5234 &bad);
5235 if (bad)
5237 ip->bw_conv_error = TRUE;
5238 return FAIL;
5242 # endif
5244 # ifdef MACOS_CONVERT
5245 else if (flags & FIO_MACROMAN)
5248 * Convert UTF-8 or latin1 to Apple MacRoman.
5250 char_u *from;
5251 size_t fromlen;
5253 if (ip->bw_restlen > 0)
5255 /* Need to concatenate the remainder of the previous call and
5256 * the bytes of the current call. Use the end of the
5257 * conversion buffer for this. */
5258 fromlen = len + ip->bw_restlen;
5259 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5260 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5261 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5263 else
5265 from = buf;
5266 fromlen = len;
5269 if (enc2macroman(from, fromlen,
5270 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5271 ip->bw_rest, &ip->bw_restlen) == FAIL)
5273 ip->bw_conv_error = TRUE;
5274 return FAIL;
5276 buf = ip->bw_conv_buf;
5278 # endif
5280 # ifdef USE_ICONV
5281 if (ip->bw_iconv_fd != (iconv_t)-1)
5283 const char *from;
5284 size_t fromlen;
5285 char *to;
5286 size_t tolen;
5288 /* Convert with iconv(). */
5289 if (ip->bw_restlen > 0)
5291 char *fp;
5293 /* Need to concatenate the remainder of the previous call and
5294 * the bytes of the current call. Use the end of the
5295 * conversion buffer for this. */
5296 fromlen = len + ip->bw_restlen;
5297 fp = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5298 mch_memmove(fp, ip->bw_rest, (size_t)ip->bw_restlen);
5299 mch_memmove(fp + ip->bw_restlen, buf, (size_t)len);
5300 from = fp;
5301 tolen = ip->bw_conv_buflen - fromlen;
5303 else
5305 from = (const char *)buf;
5306 fromlen = len;
5307 tolen = ip->bw_conv_buflen;
5309 to = (char *)ip->bw_conv_buf;
5311 if (ip->bw_first)
5313 size_t save_len = tolen;
5315 /* output the initial shift state sequence */
5316 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5318 /* There is a bug in iconv() on Linux (which appears to be
5319 * wide-spread) which sets "to" to NULL and messes up "tolen".
5321 if (to == NULL)
5323 to = (char *)ip->bw_conv_buf;
5324 tolen = save_len;
5326 ip->bw_first = FALSE;
5330 * If iconv() has an error or there is not enough room, fail.
5332 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5333 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5334 || fromlen > CONV_RESTLEN)
5336 ip->bw_conv_error = TRUE;
5337 return FAIL;
5340 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5341 if (fromlen > 0)
5342 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5343 ip->bw_restlen = (int)fromlen;
5345 buf = ip->bw_conv_buf;
5346 len = (int)((char_u *)to - ip->bw_conv_buf);
5348 # endif
5350 #endif /* FEAT_MBYTE */
5352 #ifdef FEAT_CRYPT
5353 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5355 int ztemp, t, i;
5357 for (i = 0; i < len; i++)
5359 ztemp = buf[i];
5360 buf[i] = ZENCODE(ztemp, t);
5363 #endif
5365 /* Repeat the write(), it may be interrupted by a signal. */
5366 while (len > 0)
5368 wlen = vim_write(ip->bw_fd, buf, len);
5369 if (wlen <= 0) /* error! */
5370 return FAIL;
5371 len -= wlen;
5372 buf += wlen;
5374 return OK;
5377 #ifdef FEAT_MBYTE
5379 * Convert a Unicode character to bytes.
5381 static int
5382 ucs2bytes(c, pp, flags)
5383 unsigned c; /* in: character */
5384 char_u **pp; /* in/out: pointer to result */
5385 int flags; /* FIO_ flags */
5387 char_u *p = *pp;
5388 int error = FALSE;
5389 int cc;
5392 if (flags & FIO_UCS4)
5394 if (flags & FIO_ENDIAN_L)
5396 *p++ = c;
5397 *p++ = (c >> 8);
5398 *p++ = (c >> 16);
5399 *p++ = (c >> 24);
5401 else
5403 *p++ = (c >> 24);
5404 *p++ = (c >> 16);
5405 *p++ = (c >> 8);
5406 *p++ = c;
5409 else if (flags & (FIO_UCS2 | FIO_UTF16))
5411 if (c >= 0x10000)
5413 if (flags & FIO_UTF16)
5415 /* Make two words, ten bits of the character in each. First
5416 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5417 c -= 0x10000;
5418 if (c >= 0x100000)
5419 error = TRUE;
5420 cc = ((c >> 10) & 0x3ff) + 0xd800;
5421 if (flags & FIO_ENDIAN_L)
5423 *p++ = cc;
5424 *p++ = ((unsigned)cc >> 8);
5426 else
5428 *p++ = ((unsigned)cc >> 8);
5429 *p++ = cc;
5431 c = (c & 0x3ff) + 0xdc00;
5433 else
5434 error = TRUE;
5436 if (flags & FIO_ENDIAN_L)
5438 *p++ = c;
5439 *p++ = (c >> 8);
5441 else
5443 *p++ = (c >> 8);
5444 *p++ = c;
5447 else /* Latin1 */
5449 if (c >= 0x100)
5451 error = TRUE;
5452 *p++ = 0xBF;
5454 else
5455 *p++ = c;
5458 *pp = p;
5459 return error;
5463 * Return TRUE if "a" and "b" are the same 'encoding'.
5464 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5466 static int
5467 same_encoding(a, b)
5468 char_u *a;
5469 char_u *b;
5471 int f;
5473 if (STRCMP(a, b) == 0)
5474 return TRUE;
5475 f = get_fio_flags(a);
5476 return (f != 0 && get_fio_flags(b) == f);
5480 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5481 * internal conversion.
5482 * if "ptr" is an empty string, use 'encoding'.
5484 static int
5485 get_fio_flags(ptr)
5486 char_u *ptr;
5488 int prop;
5490 if (*ptr == NUL)
5491 ptr = p_enc;
5493 prop = enc_canon_props(ptr);
5494 if (prop & ENC_UNICODE)
5496 if (prop & ENC_2BYTE)
5498 if (prop & ENC_ENDIAN_L)
5499 return FIO_UCS2 | FIO_ENDIAN_L;
5500 return FIO_UCS2;
5502 if (prop & ENC_4BYTE)
5504 if (prop & ENC_ENDIAN_L)
5505 return FIO_UCS4 | FIO_ENDIAN_L;
5506 return FIO_UCS4;
5508 if (prop & ENC_2WORD)
5510 if (prop & ENC_ENDIAN_L)
5511 return FIO_UTF16 | FIO_ENDIAN_L;
5512 return FIO_UTF16;
5514 return FIO_UTF8;
5516 if (prop & ENC_LATIN1)
5517 return FIO_LATIN1;
5518 /* must be ENC_DBCS, requires iconv() */
5519 return 0;
5522 #ifdef WIN3264
5524 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5525 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5526 * Used for conversion between 'encoding' and 'fileencoding'.
5528 static int
5529 get_win_fio_flags(ptr)
5530 char_u *ptr;
5532 int cp;
5534 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5535 if (!enc_utf8 && enc_codepage <= 0)
5536 return 0;
5538 cp = encname2codepage(ptr);
5539 if (cp == 0)
5541 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5542 if (STRCMP(ptr, "utf-8") == 0)
5543 cp = CP_UTF8;
5544 else
5545 # endif
5546 return 0;
5548 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5550 #endif
5552 #ifdef MACOS_X
5554 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5555 * needed for the internal conversion to/from utf-8 or latin1.
5557 static int
5558 get_mac_fio_flags(ptr)
5559 char_u *ptr;
5561 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5562 && (enc_canon_props(ptr) & ENC_MACROMAN))
5563 return FIO_MACROMAN;
5564 return 0;
5566 #endif
5569 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5570 * "size" must be at least 2.
5571 * Return the name of the encoding and set "*lenp" to the length.
5572 * Returns NULL when no BOM found.
5574 static char_u *
5575 check_for_bom(p, size, lenp, flags)
5576 char_u *p;
5577 long size;
5578 int *lenp;
5579 int flags;
5581 char *name = NULL;
5582 int len = 2;
5584 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5585 && (flags == FIO_ALL || flags == FIO_UTF8 || flags == 0))
5587 name = "utf-8"; /* EF BB BF */
5588 len = 3;
5590 else if (p[0] == 0xff && p[1] == 0xfe)
5592 if (size >= 4 && p[2] == 0 && p[3] == 0
5593 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5595 name = "ucs-4le"; /* FF FE 00 00 */
5596 len = 4;
5598 else if (flags == (FIO_UCS2 | FIO_ENDIAN_L))
5599 name = "ucs-2le"; /* FF FE */
5600 else if (flags == FIO_ALL || flags == (FIO_UTF16 | FIO_ENDIAN_L))
5601 /* utf-16le is preferred, it also works for ucs-2le text */
5602 name = "utf-16le"; /* FF FE */
5604 else if (p[0] == 0xfe && p[1] == 0xff
5605 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5607 /* Default to utf-16, it works also for ucs-2 text. */
5608 if (flags == FIO_UCS2)
5609 name = "ucs-2"; /* FE FF */
5610 else
5611 name = "utf-16"; /* FE FF */
5613 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5614 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5616 name = "ucs-4"; /* 00 00 FE FF */
5617 len = 4;
5620 *lenp = len;
5621 return (char_u *)name;
5625 * Generate a BOM in "buf[4]" for encoding "name".
5626 * Return the length of the BOM (zero when no BOM).
5628 static int
5629 make_bom(buf, name)
5630 char_u *buf;
5631 char_u *name;
5633 int flags;
5634 char_u *p;
5636 flags = get_fio_flags(name);
5638 /* Can't put a BOM in a non-Unicode file. */
5639 if (flags == FIO_LATIN1 || flags == 0)
5640 return 0;
5642 if (flags == FIO_UTF8) /* UTF-8 */
5644 buf[0] = 0xef;
5645 buf[1] = 0xbb;
5646 buf[2] = 0xbf;
5647 return 3;
5649 p = buf;
5650 (void)ucs2bytes(0xfeff, &p, flags);
5651 return (int)(p - buf);
5653 #endif
5655 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5656 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5658 * Try to find a shortname by comparing the fullname with the current
5659 * directory.
5660 * Returns "full_path" or pointer into "full_path" if shortened.
5662 char_u *
5663 shorten_fname1(full_path)
5664 char_u *full_path;
5666 char_u dirname[MAXPATHL];
5667 char_u *p = full_path;
5669 if (mch_dirname(dirname, MAXPATHL) == OK)
5671 p = shorten_fname(full_path, dirname);
5672 if (p == NULL || *p == NUL)
5673 p = full_path;
5675 return p;
5677 #endif
5680 * Try to find a shortname by comparing the fullname with the current
5681 * directory.
5682 * Returns NULL if not shorter name possible, pointer into "full_path"
5683 * otherwise.
5685 char_u *
5686 shorten_fname(full_path, dir_name)
5687 char_u *full_path;
5688 char_u *dir_name;
5690 int len;
5691 char_u *p;
5693 if (full_path == NULL)
5694 return NULL;
5695 len = (int)STRLEN(dir_name);
5696 if (fnamencmp(dir_name, full_path, len) == 0)
5698 p = full_path + len;
5699 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5701 * MSDOS: when a file is in the root directory, dir_name will end in a
5702 * slash, since C: by itself does not define a specific dir. In this
5703 * case p may already be correct. <negri>
5705 if (!((len > 2) && (*(p - 2) == ':')))
5706 #endif
5708 if (vim_ispathsep(*p))
5709 ++p;
5710 #ifndef VMS /* the path separator is always part of the path */
5711 else
5712 p = NULL;
5713 #endif
5716 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5718 * When using a file in the current drive, remove the drive name:
5719 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5720 * a floppy from "A:\dir" to "B:\dir".
5722 else if (len > 3
5723 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5724 && full_path[1] == ':'
5725 && vim_ispathsep(full_path[2]))
5726 p = full_path + 2;
5727 #endif
5728 else
5729 p = NULL;
5730 return p;
5734 * Shorten filenames for all buffers.
5735 * When "force" is TRUE: Use full path from now on for files currently being
5736 * edited, both for file name and swap file name. Try to shorten the file
5737 * names a bit, if safe to do so.
5738 * When "force" is FALSE: Only try to shorten absolute file names.
5739 * For buffers that have buftype "nofile" or "scratch": never change the file
5740 * name.
5742 void
5743 shorten_fnames(force)
5744 int force;
5746 char_u dirname[MAXPATHL];
5747 buf_T *buf;
5748 char_u *p;
5750 mch_dirname(dirname, MAXPATHL);
5751 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5753 if (buf->b_fname != NULL
5754 #ifdef FEAT_QUICKFIX
5755 && !bt_nofile(buf)
5756 #endif
5757 && !path_with_url(buf->b_fname)
5758 && (force
5759 || buf->b_sfname == NULL
5760 || mch_isFullName(buf->b_sfname)))
5762 vim_free(buf->b_sfname);
5763 buf->b_sfname = NULL;
5764 p = shorten_fname(buf->b_ffname, dirname);
5765 if (p != NULL)
5767 buf->b_sfname = vim_strsave(p);
5768 buf->b_fname = buf->b_sfname;
5770 if (p == NULL || buf->b_fname == NULL)
5771 buf->b_fname = buf->b_ffname;
5774 /* Always make the swap file name a full path, a "nofile" buffer may
5775 * also have a swap file. */
5776 mf_fullname(buf->b_ml.ml_mfp);
5778 #ifdef FEAT_WINDOWS
5779 status_redraw_all();
5780 redraw_tabline = TRUE;
5781 #endif
5784 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5785 || defined(FEAT_GUI_MSWIN) \
5786 || defined(FEAT_GUI_MAC) \
5787 || defined(PROTO)
5789 * Shorten all filenames in "fnames[count]" by current directory.
5791 void
5792 shorten_filenames(fnames, count)
5793 char_u **fnames;
5794 int count;
5796 int i;
5797 char_u dirname[MAXPATHL];
5798 char_u *p;
5800 if (fnames == NULL || count < 1)
5801 return;
5802 mch_dirname(dirname, sizeof(dirname));
5803 for (i = 0; i < count; ++i)
5805 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5807 /* shorten_fname() returns pointer in given "fnames[i]". If free
5808 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5809 * "p" first then free fnames[i]. */
5810 p = vim_strsave(p);
5811 vim_free(fnames[i]);
5812 fnames[i] = p;
5816 #endif
5819 * add extension to file name - change path/fo.o.h to path/fo.o.h.ext or
5820 * fo_o_h.ext for MSDOS or when shortname option set.
5822 * Assumed that fname is a valid name found in the filesystem we assure that
5823 * the return value is a different name and ends in 'ext'.
5824 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5825 * characters otherwise.
5826 * Space for the returned name is allocated, must be freed later.
5827 * Returns NULL when out of memory.
5829 char_u *
5830 modname(fname, ext, prepend_dot)
5831 char_u *fname, *ext;
5832 int prepend_dot; /* may prepend a '.' to file name */
5834 return buf_modname(
5835 #ifdef SHORT_FNAME
5836 TRUE,
5837 #else
5838 (curbuf->b_p_sn || curbuf->b_shortname),
5839 #endif
5840 fname, ext, prepend_dot);
5843 char_u *
5844 buf_modname(shortname, fname, ext, prepend_dot)
5845 int shortname; /* use 8.3 file name */
5846 char_u *fname, *ext;
5847 int prepend_dot; /* may prepend a '.' to file name */
5849 char_u *retval;
5850 char_u *s;
5851 char_u *e;
5852 char_u *ptr;
5853 int fnamelen, extlen;
5855 extlen = (int)STRLEN(ext);
5858 * If there is no file name we must get the name of the current directory
5859 * (we need the full path in case :cd is used).
5861 if (fname == NULL || *fname == NUL)
5863 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5864 if (retval == NULL)
5865 return NULL;
5866 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5867 (fnamelen = (int)STRLEN(retval)) == 0)
5869 vim_free(retval);
5870 return NULL;
5872 if (!after_pathsep(retval, retval + fnamelen))
5874 retval[fnamelen++] = PATHSEP;
5875 retval[fnamelen] = NUL;
5877 #ifndef SHORT_FNAME
5878 prepend_dot = FALSE; /* nothing to prepend a dot to */
5879 #endif
5881 else
5883 fnamelen = (int)STRLEN(fname);
5884 retval = alloc((unsigned)(fnamelen + extlen + 3));
5885 if (retval == NULL)
5886 return NULL;
5887 STRCPY(retval, fname);
5888 #ifdef VMS
5889 vms_remove_version(retval); /* we do not need versions here */
5890 #endif
5894 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5895 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5896 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5897 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5899 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5901 #ifndef RISCOS
5902 if (*ext == '.'
5903 # ifdef USE_LONG_FNAME
5904 && (!USE_LONG_FNAME || shortname)
5905 # else
5906 # ifndef SHORT_FNAME
5907 && shortname
5908 # endif
5909 # endif
5911 if (*ptr == '.') /* replace '.' by '_' */
5912 *ptr = '_';
5913 #endif
5914 if (vim_ispathsep(*ptr))
5916 ++ptr;
5917 break;
5921 /* the file name has at most BASENAMELEN characters. */
5922 #ifndef SHORT_FNAME
5923 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5924 ptr[BASENAMELEN] = '\0';
5925 #endif
5927 s = ptr + STRLEN(ptr);
5930 * For 8.3 file names we may have to reduce the length.
5932 #ifdef USE_LONG_FNAME
5933 if (!USE_LONG_FNAME || shortname)
5934 #else
5935 # ifndef SHORT_FNAME
5936 if (shortname)
5937 # endif
5938 #endif
5941 * If there is no file name, or the file name ends in '/', and the
5942 * extension starts with '.', put a '_' before the dot, because just
5943 * ".ext" is invalid.
5945 if (fname == NULL || *fname == NUL
5946 || vim_ispathsep(fname[STRLEN(fname) - 1]))
5948 #ifdef RISCOS
5949 if (*ext == '/')
5950 #else
5951 if (*ext == '.')
5952 #endif
5953 *s++ = '_';
5956 * If the extension starts with '.', truncate the base name at 8
5957 * characters
5959 #ifdef RISCOS
5960 /* We normally use '/', but swap files are '_' */
5961 else if (*ext == '/' || *ext == '_')
5962 #else
5963 else if (*ext == '.')
5964 #endif
5966 if (s - ptr > (size_t)8)
5968 s = ptr + 8;
5969 *s = '\0';
5973 * If the extension doesn't start with '.', and the file name
5974 * doesn't have an extension yet, append a '.'
5976 #ifdef RISCOS
5977 else if ((e = vim_strchr(ptr, '/')) == NULL)
5978 *s++ = '/';
5979 #else
5980 else if ((e = vim_strchr(ptr, '.')) == NULL)
5981 *s++ = '.';
5982 #endif
5984 * If the extension doesn't start with '.', and there already is an
5985 * extension, it may need to be truncated
5987 else if ((int)STRLEN(e) + extlen > 4)
5988 s = e + 4 - extlen;
5990 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5992 * If there is no file name, and the extension starts with '.', put a
5993 * '_' before the dot, because just ".ext" may be invalid if it's on a
5994 * FAT partition, and on HPFS it doesn't matter.
5996 else if ((fname == NULL || *fname == NUL) && *ext == '.')
5997 *s++ = '_';
5998 #endif
6001 * Append the extension.
6002 * ext can start with '.' and cannot exceed 3 more characters.
6004 STRCPY(s, ext);
6006 #ifndef SHORT_FNAME
6008 * Prepend the dot.
6010 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
6011 #ifdef RISCOS
6013 #else
6015 #endif
6016 #ifdef USE_LONG_FNAME
6017 && USE_LONG_FNAME
6018 #endif
6021 STRMOVE(e + 1, e);
6022 #ifdef RISCOS
6023 *e = '/';
6024 #else
6025 *e = '.';
6026 #endif
6028 #endif
6031 * Check that, after appending the extension, the file name is really
6032 * different.
6034 if (fname != NULL && STRCMP(fname, retval) == 0)
6036 /* we search for a character that can be replaced by '_' */
6037 while (--s >= ptr)
6039 if (*s != '_')
6041 *s = '_';
6042 break;
6045 if (s < ptr) /* fname was "________.<ext>", how tricky! */
6046 *ptr = 'v';
6048 return retval;
6052 * Like fgets(), but if the file line is too long, it is truncated and the
6053 * rest of the line is thrown away. Returns TRUE for end-of-file.
6056 vim_fgets(buf, size, fp)
6057 char_u *buf;
6058 int size;
6059 FILE *fp;
6061 char *eof;
6062 #define FGETS_SIZE 200
6063 char tbuf[FGETS_SIZE];
6065 buf[size - 2] = NUL;
6066 #ifdef USE_CR
6067 eof = fgets_cr((char *)buf, size, fp);
6068 #else
6069 eof = fgets((char *)buf, size, fp);
6070 #endif
6071 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
6073 buf[size - 1] = NUL; /* Truncate the line */
6075 /* Now throw away the rest of the line: */
6078 tbuf[FGETS_SIZE - 2] = NUL;
6079 #ifdef USE_CR
6080 ignoredp = fgets_cr((char *)tbuf, FGETS_SIZE, fp);
6081 #else
6082 ignoredp = fgets((char *)tbuf, FGETS_SIZE, fp);
6083 #endif
6084 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
6086 return (eof == NULL);
6089 #if defined(USE_CR) || defined(PROTO)
6091 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6092 * Returns TRUE for end-of-file.
6093 * Only used for the Mac, because it's much slower than vim_fgets().
6096 tag_fgets(buf, size, fp)
6097 char_u *buf;
6098 int size;
6099 FILE *fp;
6101 int i = 0;
6102 int c;
6103 int eof = FALSE;
6105 for (;;)
6107 c = fgetc(fp);
6108 if (c == EOF)
6110 eof = TRUE;
6111 break;
6113 if (c == '\r')
6115 /* Always store a NL for end-of-line. */
6116 if (i < size - 1)
6117 buf[i++] = '\n';
6118 c = fgetc(fp);
6119 if (c != '\n') /* Macintosh format: single CR. */
6120 ungetc(c, fp);
6121 break;
6123 if (i < size - 1)
6124 buf[i++] = c;
6125 if (c == '\n')
6126 break;
6128 buf[i] = NUL;
6129 return eof;
6131 #endif
6134 * rename() only works if both files are on the same file system, this
6135 * function will (attempts to?) copy the file across if rename fails -- webb
6136 * Return -1 for failure, 0 for success.
6139 vim_rename(from, to)
6140 char_u *from;
6141 char_u *to;
6143 int fd_in;
6144 int fd_out;
6145 int n;
6146 char *errmsg = NULL;
6147 char *buffer;
6148 #ifdef AMIGA
6149 BPTR flock;
6150 #endif
6151 struct stat st;
6152 long perm;
6153 #ifdef HAVE_ACL
6154 vim_acl_T acl; /* ACL from original file */
6155 #endif
6156 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6157 int use_tmp_file = FALSE;
6158 #endif
6161 * When the names are identical, there is nothing to do. When they refer
6162 * to the same file (ignoring case and slash/backslash differences) but
6163 * the file name differs we need to go through a temp file.
6165 if (fnamecmp(from, to) == 0)
6167 #ifdef CASE_INSENSITIVE_FILENAME
6168 if (STRCMP(gettail(from), gettail(to)) != 0)
6169 use_tmp_file = TRUE;
6170 else
6171 #endif
6172 return 0;
6176 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6178 if (mch_stat((char *)from, &st) < 0)
6179 return -1;
6181 #ifdef UNIX
6183 struct stat st_to;
6185 /* It's possible for the source and destination to be the same file.
6186 * This happens when "from" and "to" differ in case and are on a FAT32
6187 * filesystem. In that case go through a temp file name. */
6188 if (mch_stat((char *)to, &st_to) >= 0
6189 && st.st_dev == st_to.st_dev
6190 && st.st_ino == st_to.st_ino)
6191 use_tmp_file = TRUE;
6193 #endif
6195 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6196 if (use_tmp_file)
6198 char tempname[MAXPATHL + 1];
6201 * Find a name that doesn't exist and is in the same directory.
6202 * Rename "from" to "tempname" and then rename "tempname" to "to".
6204 if (STRLEN(from) >= MAXPATHL - 5)
6205 return -1;
6206 STRCPY(tempname, from);
6207 for (n = 123; n < 99999; ++n)
6209 sprintf((char *)gettail((char_u *)tempname), "%d", n);
6210 if (mch_stat(tempname, &st) < 0)
6212 if (mch_rename((char *)from, tempname) == 0)
6214 if (mch_rename(tempname, (char *)to) == 0)
6215 return 0;
6216 /* Strange, the second step failed. Try moving the
6217 * file back and return failure. */
6218 mch_rename(tempname, (char *)from);
6219 return -1;
6221 /* If it fails for one temp name it will most likely fail
6222 * for any temp name, give up. */
6223 return -1;
6226 return -1;
6228 #endif
6231 * Delete the "to" file, this is required on some systems to make the
6232 * mch_rename() work, on other systems it makes sure that we don't have
6233 * two files when the mch_rename() fails.
6236 #ifdef AMIGA
6238 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6239 * that the name of the "to" file is the same as the "from" file, even
6240 * though the names are different. To avoid the chance of accidentally
6241 * deleting the "from" file (horror!) we lock it during the remove.
6243 * When used for making a backup before writing the file: This should not
6244 * happen with ":w", because startscript() should detect this problem and
6245 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6246 * name. This problem does exist with ":w filename", but then the
6247 * original file will be somewhere else so the backup isn't really
6248 * important. If autoscripting is off the rename may fail.
6250 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6251 #endif
6252 mch_remove(to);
6253 #ifdef AMIGA
6254 if (flock)
6255 UnLock(flock);
6256 #endif
6259 * First try a normal rename, return if it works.
6261 if (mch_rename((char *)from, (char *)to) == 0)
6262 return 0;
6265 * Rename() failed, try copying the file.
6267 perm = mch_getperm(from);
6268 #ifdef HAVE_ACL
6269 /* For systems that support ACL: get the ACL from the original file. */
6270 acl = mch_get_acl(from);
6271 #endif
6272 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6273 if (fd_in == -1)
6275 #ifdef HAVE_ACL
6276 mch_free_acl(acl);
6277 #endif
6278 return -1;
6281 /* Create the new file with same permissions as the original. */
6282 fd_out = mch_open((char *)to,
6283 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6284 if (fd_out == -1)
6286 close(fd_in);
6287 #ifdef HAVE_ACL
6288 mch_free_acl(acl);
6289 #endif
6290 return -1;
6293 buffer = (char *)alloc(BUFSIZE);
6294 if (buffer == NULL)
6296 close(fd_out);
6297 close(fd_in);
6298 #ifdef HAVE_ACL
6299 mch_free_acl(acl);
6300 #endif
6301 return -1;
6304 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6305 if (vim_write(fd_out, buffer, n) != n)
6307 errmsg = _("E208: Error writing to \"%s\"");
6308 break;
6311 vim_free(buffer);
6312 close(fd_in);
6313 if (close(fd_out) < 0)
6314 errmsg = _("E209: Error closing \"%s\"");
6315 if (n < 0)
6317 errmsg = _("E210: Error reading \"%s\"");
6318 to = from;
6320 #ifndef UNIX /* for Unix mch_open() already set the permission */
6321 mch_setperm(to, perm);
6322 #endif
6323 #ifdef HAVE_ACL
6324 mch_set_acl(to, acl);
6325 mch_free_acl(acl);
6326 #endif
6327 if (errmsg != NULL)
6329 EMSG2(errmsg, to);
6330 return -1;
6332 mch_remove(from);
6333 return 0;
6336 static int already_warned = FALSE;
6339 * Check if any not hidden buffer has been changed.
6340 * Postpone the check if there are characters in the stuff buffer, a global
6341 * command is being executed, a mapping is being executed or an autocommand is
6342 * busy.
6343 * Returns TRUE if some message was written (screen should be redrawn and
6344 * cursor positioned).
6347 check_timestamps(focus)
6348 int focus; /* called for GUI focus event */
6350 buf_T *buf;
6351 int didit = 0;
6352 int n;
6354 /* Don't check timestamps while system() or another low-level function may
6355 * cause us to lose and gain focus. */
6356 if (no_check_timestamps > 0)
6357 return FALSE;
6359 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6360 * event and we would keep on checking if the file is steadily growing.
6361 * Do check again after typing something. */
6362 if (focus && did_check_timestamps)
6364 need_check_timestamps = TRUE;
6365 return FALSE;
6368 if (!stuff_empty() || global_busy || !typebuf_typed()
6369 #ifdef FEAT_AUTOCMD
6370 || autocmd_busy || curbuf_lock > 0 || allbuf_lock > 0
6371 #endif
6373 need_check_timestamps = TRUE; /* check later */
6374 else
6376 ++no_wait_return;
6377 did_check_timestamps = TRUE;
6378 already_warned = FALSE;
6379 for (buf = firstbuf; buf != NULL; )
6381 /* Only check buffers in a window. */
6382 if (buf->b_nwindows > 0)
6384 n = buf_check_timestamp(buf, focus);
6385 if (didit < n)
6386 didit = n;
6387 if (n > 0 && !buf_valid(buf))
6389 /* Autocommands have removed the buffer, start at the
6390 * first one again. */
6391 buf = firstbuf;
6392 continue;
6395 buf = buf->b_next;
6397 --no_wait_return;
6398 need_check_timestamps = FALSE;
6399 if (need_wait_return && didit == 2)
6401 /* make sure msg isn't overwritten */
6402 msg_puts((char_u *)"\n");
6403 out_flush();
6406 return didit;
6410 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6411 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6412 * empty.
6414 static int
6415 move_lines(frombuf, tobuf)
6416 buf_T *frombuf;
6417 buf_T *tobuf;
6419 buf_T *tbuf = curbuf;
6420 int retval = OK;
6421 linenr_T lnum;
6422 char_u *p;
6424 /* Copy the lines in "frombuf" to "tobuf". */
6425 curbuf = tobuf;
6426 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6428 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6429 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6431 vim_free(p);
6432 retval = FAIL;
6433 break;
6435 vim_free(p);
6438 /* Delete all the lines in "frombuf". */
6439 if (retval != FAIL)
6441 curbuf = frombuf;
6442 for (lnum = curbuf->b_ml.ml_line_count; lnum > 0; --lnum)
6443 if (ml_delete(lnum, FALSE) == FAIL)
6445 /* Oops! We could try putting back the saved lines, but that
6446 * might fail again... */
6447 retval = FAIL;
6448 break;
6452 curbuf = tbuf;
6453 return retval;
6457 * Check if buffer "buf" has been changed.
6458 * Also check if the file for a new buffer unexpectedly appeared.
6459 * return 1 if a changed buffer was found.
6460 * return 2 if a message has been displayed.
6461 * return 0 otherwise.
6463 /*ARGSUSED*/
6465 buf_check_timestamp(buf, focus)
6466 buf_T *buf;
6467 int focus; /* called for GUI focus event */
6469 struct stat st;
6470 int stat_res;
6471 int retval = 0;
6472 char_u *path;
6473 char_u *tbuf;
6474 char *mesg = NULL;
6475 char *mesg2 = "";
6476 int helpmesg = FALSE;
6477 int reload = FALSE;
6478 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6479 int can_reload = FALSE;
6480 #endif
6481 size_t orig_size = buf->b_orig_size;
6482 int orig_mode = buf->b_orig_mode;
6483 #ifdef FEAT_GUI
6484 int save_mouse_correct = need_mouse_correct;
6485 #endif
6486 #ifdef FEAT_AUTOCMD
6487 static int busy = FALSE;
6488 int n;
6489 char_u *s;
6490 #endif
6491 char *reason;
6493 /* If there is no file name, the buffer is not loaded, 'buftype' is
6494 * set, we are in the middle of a save or being called recursively: ignore
6495 * this buffer. */
6496 if (buf->b_ffname == NULL
6497 || buf->b_ml.ml_mfp == NULL
6498 #if defined(FEAT_QUICKFIX)
6499 || *buf->b_p_bt != NUL
6500 #endif
6501 || buf->b_saving
6502 #ifdef FEAT_AUTOCMD
6503 || busy
6504 #endif
6505 #ifdef FEAT_NETBEANS_INTG
6506 || isNetbeansBuffer(buf)
6507 #endif
6509 return 0;
6511 if ( !(buf->b_flags & BF_NOTEDITED)
6512 && buf->b_mtime != 0
6513 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6514 || time_differs((long)st.st_mtime, buf->b_mtime)
6515 #ifdef HAVE_ST_MODE
6516 || (int)st.st_mode != buf->b_orig_mode
6517 #else
6518 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6519 #endif
6522 retval = 1;
6524 /* set b_mtime to stop further warnings (e.g., when executing
6525 * FileChangedShell autocmd) */
6526 if (stat_res < 0)
6528 buf->b_mtime = 0;
6529 buf->b_orig_size = 0;
6530 buf->b_orig_mode = 0;
6532 else
6533 buf_store_time(buf, &st, buf->b_ffname);
6535 /* Don't do anything for a directory. Might contain the file
6536 * explorer. */
6537 if (mch_isdir(buf->b_fname))
6541 * If 'autoread' is set, the buffer has no changes and the file still
6542 * exists, reload the buffer. Use the buffer-local option value if it
6543 * was set, the global option value otherwise.
6545 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6546 && !bufIsChanged(buf) && stat_res >= 0)
6547 reload = TRUE;
6548 else
6550 if (stat_res < 0)
6551 reason = "deleted";
6552 else if (bufIsChanged(buf))
6553 reason = "conflict";
6554 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6555 reason = "changed";
6556 else if (orig_mode != buf->b_orig_mode)
6557 reason = "mode";
6558 else
6559 reason = "time";
6561 #ifdef FEAT_AUTOCMD
6563 * Only give the warning if there are no FileChangedShell
6564 * autocommands.
6565 * Avoid being called recursively by setting "busy".
6567 busy = TRUE;
6568 # ifdef FEAT_EVAL
6569 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6570 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6571 # endif
6572 ++allbuf_lock;
6573 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6574 buf->b_fname, buf->b_fname, FALSE, buf);
6575 --allbuf_lock;
6576 busy = FALSE;
6577 if (n)
6579 if (!buf_valid(buf))
6580 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6581 # ifdef FEAT_EVAL
6582 s = get_vim_var_str(VV_FCS_CHOICE);
6583 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6584 reload = TRUE;
6585 else if (STRCMP(s, "ask") == 0)
6586 n = FALSE;
6587 else
6588 # endif
6589 return 2;
6591 if (!n)
6592 #endif
6594 if (*reason == 'd')
6595 mesg = _("E211: File \"%s\" no longer available");
6596 else
6598 helpmesg = TRUE;
6599 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6600 can_reload = TRUE;
6601 #endif
6603 * Check if the file contents really changed to avoid
6604 * giving a warning when only the timestamp was set (e.g.,
6605 * checked out of CVS). Always warn when the buffer was
6606 * changed.
6608 if (reason[2] == 'n')
6610 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6611 mesg2 = _("See \":help W12\" for more info.");
6613 else if (reason[1] == 'h')
6615 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6616 mesg2 = _("See \":help W11\" for more info.");
6618 else if (*reason == 'm')
6620 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6621 mesg2 = _("See \":help W16\" for more info.");
6623 /* Else: only timestamp changed, ignored */
6629 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6630 && vim_fexists(buf->b_ffname))
6632 retval = 1;
6633 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6634 buf->b_flags |= BF_NEW_W;
6635 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6636 can_reload = TRUE;
6637 #endif
6640 if (mesg != NULL)
6642 path = home_replace_save(buf, buf->b_fname);
6643 if (path != NULL)
6645 if (!helpmesg)
6646 mesg2 = "";
6647 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6648 + STRLEN(mesg2) + 2));
6649 sprintf((char *)tbuf, mesg, path);
6650 #ifdef FEAT_EVAL
6651 /* Set warningmsg here, before the unimportant and output-specific
6652 * mesg2 has been appended. */
6653 set_vim_var_string(VV_WARNINGMSG, tbuf, -1);
6654 #endif
6655 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6656 if (can_reload)
6658 if (*mesg2 != NUL)
6660 STRCAT(tbuf, "\n");
6661 STRCAT(tbuf, mesg2);
6663 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6664 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6665 reload = TRUE;
6667 else
6668 #endif
6669 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6671 if (*mesg2 != NUL)
6673 STRCAT(tbuf, "; ");
6674 STRCAT(tbuf, mesg2);
6676 EMSG(tbuf);
6677 retval = 2;
6679 else
6681 # ifdef FEAT_AUTOCMD
6682 if (!autocmd_busy)
6683 # endif
6685 msg_start();
6686 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6687 if (*mesg2 != NUL)
6688 msg_puts_attr((char_u *)mesg2,
6689 hl_attr(HLF_W) + MSG_HIST);
6690 msg_clr_eos();
6691 (void)msg_end();
6692 if (emsg_silent == 0)
6694 out_flush();
6695 # ifdef FEAT_GUI
6696 if (!focus)
6697 # endif
6698 /* give the user some time to think about it */
6699 ui_delay(1000L, TRUE);
6701 /* don't redraw and erase the message */
6702 redraw_cmdline = FALSE;
6705 already_warned = TRUE;
6708 vim_free(path);
6709 vim_free(tbuf);
6713 if (reload)
6714 /* Reload the buffer. */
6715 buf_reload(buf, orig_mode);
6717 #ifdef FEAT_AUTOCMD
6718 /* Trigger FileChangedShell when the file was changed in any way. */
6719 if (buf_valid(buf) && retval != 0)
6720 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6721 buf->b_fname, buf->b_fname, FALSE, buf);
6722 #endif
6723 #ifdef FEAT_GUI
6724 /* restore this in case an autocommand has set it; it would break
6725 * 'mousefocus' */
6726 need_mouse_correct = save_mouse_correct;
6727 #endif
6729 return retval;
6733 * Reload a buffer that is already loaded.
6734 * Used when the file was changed outside of Vim.
6735 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6736 * buf->b_orig_mode may have been reset already.
6738 void
6739 buf_reload(buf, orig_mode)
6740 buf_T *buf;
6741 int orig_mode;
6743 exarg_T ea;
6744 pos_T old_cursor;
6745 linenr_T old_topline;
6746 int old_ro = buf->b_p_ro;
6747 buf_T *savebuf;
6748 int saved = OK;
6749 aco_save_T aco;
6751 /* set curwin/curbuf for "buf" and save some things */
6752 aucmd_prepbuf(&aco, buf);
6754 /* We only want to read the text from the file, not reset the syntax
6755 * highlighting, clear marks, diff status, etc. Force the fileformat
6756 * and encoding to be the same. */
6757 if (prep_exarg(&ea, buf) == OK)
6759 old_cursor = curwin->w_cursor;
6760 old_topline = curwin->w_topline;
6763 * To behave like when a new file is edited (matters for
6764 * BufReadPost autocommands) we first need to delete the current
6765 * buffer contents. But if reading the file fails we should keep
6766 * the old contents. Can't use memory only, the file might be
6767 * too big. Use a hidden buffer to move the buffer contents to.
6769 if (bufempty())
6770 savebuf = NULL;
6771 else
6773 /* Allocate a buffer without putting it in the buffer list. */
6774 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6775 if (savebuf != NULL && buf == curbuf)
6777 /* Open the memline. */
6778 curbuf = savebuf;
6779 curwin->w_buffer = savebuf;
6780 saved = ml_open(curbuf);
6781 curbuf = buf;
6782 curwin->w_buffer = buf;
6784 if (savebuf == NULL || saved == FAIL || buf != curbuf
6785 || move_lines(buf, savebuf) == FAIL)
6787 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6788 buf->b_fname);
6789 saved = FAIL;
6793 if (saved == OK)
6795 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6796 #ifdef FEAT_AUTOCMD
6797 keep_filetype = TRUE; /* don't detect 'filetype' */
6798 #endif
6799 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6800 (linenr_T)0,
6801 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6803 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6804 if (!aborting())
6805 #endif
6806 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6807 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6809 /* Put the text back from the save buffer. First
6810 * delete any lines that readfile() added. */
6811 while (!bufempty())
6812 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6813 break;
6814 (void)move_lines(savebuf, buf);
6817 else if (buf == curbuf)
6819 /* Mark the buffer as unmodified and free undo info. */
6820 unchanged(buf, TRUE);
6821 u_blockfree(buf);
6822 u_clearall(buf);
6825 vim_free(ea.cmd);
6827 if (savebuf != NULL && buf_valid(savebuf))
6828 wipe_buffer(savebuf, FALSE);
6830 #ifdef FEAT_DIFF
6831 /* Invalidate diff info if necessary. */
6832 diff_invalidate(curbuf);
6833 #endif
6835 /* Restore the topline and cursor position and check it (lines may
6836 * have been removed). */
6837 if (old_topline > curbuf->b_ml.ml_line_count)
6838 curwin->w_topline = curbuf->b_ml.ml_line_count;
6839 else
6840 curwin->w_topline = old_topline;
6841 curwin->w_cursor = old_cursor;
6842 check_cursor();
6843 update_topline();
6844 #ifdef FEAT_AUTOCMD
6845 keep_filetype = FALSE;
6846 #endif
6847 #ifdef FEAT_FOLDING
6849 win_T *wp;
6850 tabpage_T *tp;
6852 /* Update folds unless they are defined manually. */
6853 FOR_ALL_TAB_WINDOWS(tp, wp)
6854 if (wp->w_buffer == curwin->w_buffer
6855 && !foldmethodIsManual(wp))
6856 foldUpdateAll(wp);
6858 #endif
6859 /* If the mode didn't change and 'readonly' was set, keep the old
6860 * value; the user probably used the ":view" command. But don't
6861 * reset it, might have had a read error. */
6862 if (orig_mode == curbuf->b_orig_mode)
6863 curbuf->b_p_ro |= old_ro;
6866 /* restore curwin/curbuf and a few other things */
6867 aucmd_restbuf(&aco);
6868 /* Careful: autocommands may have made "buf" invalid! */
6871 /*ARGSUSED*/
6872 void
6873 buf_store_time(buf, st, fname)
6874 buf_T *buf;
6875 struct stat *st;
6876 char_u *fname;
6878 buf->b_mtime = (long)st->st_mtime;
6879 buf->b_orig_size = (size_t)st->st_size;
6880 #ifdef HAVE_ST_MODE
6881 buf->b_orig_mode = (int)st->st_mode;
6882 #else
6883 buf->b_orig_mode = mch_getperm(fname);
6884 #endif
6888 * Adjust the line with missing eol, used for the next write.
6889 * Used for do_filter(), when the input lines for the filter are deleted.
6891 void
6892 write_lnum_adjust(offset)
6893 linenr_T offset;
6895 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
6896 write_no_eol_lnum += offset;
6899 #if defined(TEMPDIRNAMES) || defined(PROTO)
6900 static long temp_count = 0; /* Temp filename counter. */
6903 * Delete the temp directory and all files it contains.
6905 void
6906 vim_deltempdir()
6908 char_u **files;
6909 int file_count;
6910 int i;
6912 if (vim_tempdir != NULL)
6914 sprintf((char *)NameBuff, "%s*", vim_tempdir);
6915 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
6916 EW_DIR|EW_FILE|EW_SILENT) == OK)
6918 for (i = 0; i < file_count; ++i)
6919 mch_remove(files[i]);
6920 FreeWild(file_count, files);
6922 gettail(NameBuff)[-1] = NUL;
6923 (void)mch_rmdir(NameBuff);
6925 vim_free(vim_tempdir);
6926 vim_tempdir = NULL;
6929 #endif
6932 * vim_tempname(): Return a unique name that can be used for a temp file.
6934 * The temp file is NOT created.
6936 * The returned pointer is to allocated memory.
6937 * The returned pointer is NULL if no valid name was found.
6939 /*ARGSUSED*/
6940 char_u *
6941 vim_tempname(extra_char)
6942 int extra_char; /* character to use in the name instead of '?' */
6944 #ifdef USE_TMPNAM
6945 char_u itmp[L_tmpnam]; /* use tmpnam() */
6946 #else
6947 char_u itmp[TEMPNAMELEN];
6948 #endif
6950 #ifdef TEMPDIRNAMES
6951 static char *(tempdirs[]) = {TEMPDIRNAMES};
6952 int i;
6953 long nr;
6954 long off;
6955 # ifndef EEXIST
6956 struct stat st;
6957 # endif
6960 * This will create a directory for private use by this instance of Vim.
6961 * This is done once, and the same directory is used for all temp files.
6962 * This method avoids security problems because of symlink attacks et al.
6963 * It's also a bit faster, because we only need to check for an existing
6964 * file when creating the directory and not for each temp file.
6966 if (vim_tempdir == NULL)
6969 * Try the entries in TEMPDIRNAMES to create the temp directory.
6971 for (i = 0; i < sizeof(tempdirs) / sizeof(char *); ++i)
6973 /* expand $TMP, leave room for "/v1100000/999999999" */
6974 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
6975 if (mch_isdir(itmp)) /* directory exists */
6977 # ifdef __EMX__
6978 /* If $TMP contains a forward slash (perhaps using bash or
6979 * tcsh), don't add a backslash, use a forward slash!
6980 * Adding 2 backslashes didn't work. */
6981 if (vim_strchr(itmp, '/') != NULL)
6982 STRCAT(itmp, "/");
6983 else
6984 # endif
6985 add_pathsep(itmp);
6987 /* Get an arbitrary number of up to 6 digits. When it's
6988 * unlikely that it already exists it will be faster,
6989 * otherwise it doesn't matter. The use of mkdir() avoids any
6990 * security problems because of the predictable number. */
6991 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
6993 /* Try up to 10000 different values until we find a name that
6994 * doesn't exist. */
6995 for (off = 0; off < 10000L; ++off)
6997 int r;
6998 #if defined(UNIX) || defined(VMS)
6999 mode_t umask_save;
7000 #endif
7002 sprintf((char *)itmp + STRLEN(itmp), "v%ld", nr + off);
7003 # ifndef EEXIST
7004 /* If mkdir() does not set errno to EEXIST, check for
7005 * existing file here. There is a race condition then,
7006 * although it's fail-safe. */
7007 if (mch_stat((char *)itmp, &st) >= 0)
7008 continue;
7009 # endif
7010 #if defined(UNIX) || defined(VMS)
7011 /* Make sure the umask doesn't remove the executable bit.
7012 * "repl" has been reported to use "177". */
7013 umask_save = umask(077);
7014 #endif
7015 r = vim_mkdir(itmp, 0700);
7016 #if defined(UNIX) || defined(VMS)
7017 (void)umask(umask_save);
7018 #endif
7019 if (r == 0)
7021 char_u *buf;
7023 /* Directory was created, use this name.
7024 * Expand to full path; When using the current
7025 * directory a ":cd" would confuse us. */
7026 buf = alloc((unsigned)MAXPATHL + 1);
7027 if (buf != NULL)
7029 if (vim_FullName(itmp, buf, MAXPATHL, FALSE)
7030 == FAIL)
7031 STRCPY(buf, itmp);
7032 # ifdef __EMX__
7033 if (vim_strchr(buf, '/') != NULL)
7034 STRCAT(buf, "/");
7035 else
7036 # endif
7037 add_pathsep(buf);
7038 vim_tempdir = vim_strsave(buf);
7039 vim_free(buf);
7041 break;
7043 # ifdef EEXIST
7044 /* If the mkdir() didn't fail because the file/dir exists,
7045 * we probably can't create any dir here, try another
7046 * place. */
7047 if (errno != EEXIST)
7048 # endif
7049 break;
7051 if (vim_tempdir != NULL)
7052 break;
7057 if (vim_tempdir != NULL)
7059 /* There is no need to check if the file exists, because we own the
7060 * directory and nobody else creates a file in it. */
7061 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
7062 return vim_strsave(itmp);
7065 return NULL;
7067 #else /* TEMPDIRNAMES */
7069 # ifdef WIN3264
7070 char szTempFile[_MAX_PATH + 1];
7071 char buf4[4];
7072 char_u *retval;
7073 char_u *p;
7075 STRCPY(itmp, "");
7076 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
7077 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
7078 strcpy(buf4, "VIM");
7079 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
7080 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
7081 return NULL;
7082 /* GetTempFileName() will create the file, we don't want that */
7083 (void)DeleteFile(itmp);
7085 /* Backslashes in a temp file name cause problems when filtering with
7086 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
7087 * didn't set 'shellslash'. */
7088 retval = vim_strsave(itmp);
7089 if (*p_shcf == '-' || p_ssl)
7090 for (p = retval; *p; ++p)
7091 if (*p == '\\')
7092 *p = '/';
7093 return retval;
7095 # else /* WIN3264 */
7097 # ifdef USE_TMPNAM
7098 /* tmpnam() will make its own name */
7099 if (*tmpnam((char *)itmp) == NUL)
7100 return NULL;
7101 # else
7102 char_u *p;
7104 # ifdef VMS_TEMPNAM
7105 /* mktemp() is not working on VMS. It seems to be
7106 * a do-nothing function. Therefore we use tempnam().
7108 sprintf((char *)itmp, "VIM%c", extra_char);
7109 p = (char_u *)tempnam("tmp:", (char *)itmp);
7110 if (p != NULL)
7112 /* VMS will use '.LOG' if we don't explicitly specify an extension,
7113 * and VIM will then be unable to find the file later */
7114 STRCPY(itmp, p);
7115 STRCAT(itmp, ".txt");
7116 free(p);
7118 else
7119 return NULL;
7120 # else
7121 STRCPY(itmp, TEMPNAME);
7122 if ((p = vim_strchr(itmp, '?')) != NULL)
7123 *p = extra_char;
7124 if (mktemp((char *)itmp) == NULL)
7125 return NULL;
7126 # endif
7127 # endif
7129 return vim_strsave(itmp);
7130 # endif /* WIN3264 */
7131 #endif /* TEMPDIRNAMES */
7134 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
7136 * Convert all backslashes in fname to forward slashes in-place.
7138 void
7139 forward_slash(fname)
7140 char_u *fname;
7142 char_u *p;
7144 for (p = fname; *p != NUL; ++p)
7145 # ifdef FEAT_MBYTE
7146 /* The Big5 encoding can have '\' in the trail byte. */
7147 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
7148 ++p;
7149 else
7150 # endif
7151 if (*p == '\\')
7152 *p = '/';
7154 #endif
7158 * Code for automatic commands.
7160 * Only included when "FEAT_AUTOCMD" has been defined.
7163 #if defined(FEAT_AUTOCMD) || defined(PROTO)
7166 * The autocommands are stored in a list for each event.
7167 * Autocommands for the same pattern, that are consecutive, are joined
7168 * together, to avoid having to match the pattern too often.
7169 * The result is an array of Autopat lists, which point to AutoCmd lists:
7171 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7172 * Autopat.cmds Autopat.cmds
7173 * | |
7174 * V V
7175 * AutoCmd.next AutoCmd.next
7176 * | |
7177 * V V
7178 * AutoCmd.next NULL
7181 * NULL
7183 * first_autopat[1] --> Autopat.next --> NULL
7184 * Autopat.cmds
7187 * AutoCmd.next
7190 * NULL
7191 * etc.
7193 * The order of AutoCmds is important, this is the order in which they were
7194 * defined and will have to be executed.
7196 typedef struct AutoCmd
7198 char_u *cmd; /* The command to be executed (NULL
7199 when command has been removed) */
7200 char nested; /* If autocommands nest here */
7201 char last; /* last command in list */
7202 #ifdef FEAT_EVAL
7203 scid_T scriptID; /* script ID where defined */
7204 #endif
7205 struct AutoCmd *next; /* Next AutoCmd in list */
7206 } AutoCmd;
7208 typedef struct AutoPat
7210 int group; /* group ID */
7211 char_u *pat; /* pattern as typed (NULL when pattern
7212 has been removed) */
7213 int patlen; /* strlen() of pat */
7214 regprog_T *reg_prog; /* compiled regprog for pattern */
7215 char allow_dirs; /* Pattern may match whole path */
7216 char last; /* last pattern for apply_autocmds() */
7217 AutoCmd *cmds; /* list of commands to do */
7218 struct AutoPat *next; /* next AutoPat in AutoPat list */
7219 int buflocal_nr; /* !=0 for buffer-local AutoPat */
7220 } AutoPat;
7222 static struct event_name
7224 char *name; /* event name */
7225 event_T event; /* event number */
7226 } event_names[] =
7228 {"BufAdd", EVENT_BUFADD},
7229 {"BufCreate", EVENT_BUFADD},
7230 {"BufDelete", EVENT_BUFDELETE},
7231 {"BufEnter", EVENT_BUFENTER},
7232 {"BufFilePost", EVENT_BUFFILEPOST},
7233 {"BufFilePre", EVENT_BUFFILEPRE},
7234 {"BufHidden", EVENT_BUFHIDDEN},
7235 {"BufLeave", EVENT_BUFLEAVE},
7236 {"BufNew", EVENT_BUFNEW},
7237 {"BufNewFile", EVENT_BUFNEWFILE},
7238 {"BufRead", EVENT_BUFREADPOST},
7239 {"BufReadCmd", EVENT_BUFREADCMD},
7240 {"BufReadPost", EVENT_BUFREADPOST},
7241 {"BufReadPre", EVENT_BUFREADPRE},
7242 {"BufUnload", EVENT_BUFUNLOAD},
7243 {"BufWinEnter", EVENT_BUFWINENTER},
7244 {"BufWinLeave", EVENT_BUFWINLEAVE},
7245 {"BufWipeout", EVENT_BUFWIPEOUT},
7246 {"BufWrite", EVENT_BUFWRITEPRE},
7247 {"BufWritePost", EVENT_BUFWRITEPOST},
7248 {"BufWritePre", EVENT_BUFWRITEPRE},
7249 {"BufWriteCmd", EVENT_BUFWRITECMD},
7250 {"CmdwinEnter", EVENT_CMDWINENTER},
7251 {"CmdwinLeave", EVENT_CMDWINLEAVE},
7252 {"ColorScheme", EVENT_COLORSCHEME},
7253 {"CursorHold", EVENT_CURSORHOLD},
7254 {"CursorHoldI", EVENT_CURSORHOLDI},
7255 {"CursorMoved", EVENT_CURSORMOVED},
7256 {"CursorMovedI", EVENT_CURSORMOVEDI},
7257 {"EncodingChanged", EVENT_ENCODINGCHANGED},
7258 {"FileEncoding", EVENT_ENCODINGCHANGED},
7259 {"FileAppendPost", EVENT_FILEAPPENDPOST},
7260 {"FileAppendPre", EVENT_FILEAPPENDPRE},
7261 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
7262 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
7263 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
7264 {"FileChangedRO", EVENT_FILECHANGEDRO},
7265 {"FileReadPost", EVENT_FILEREADPOST},
7266 {"FileReadPre", EVENT_FILEREADPRE},
7267 {"FileReadCmd", EVENT_FILEREADCMD},
7268 {"FileType", EVENT_FILETYPE},
7269 {"FileWritePost", EVENT_FILEWRITEPOST},
7270 {"FileWritePre", EVENT_FILEWRITEPRE},
7271 {"FileWriteCmd", EVENT_FILEWRITECMD},
7272 {"FilterReadPost", EVENT_FILTERREADPOST},
7273 {"FilterReadPre", EVENT_FILTERREADPRE},
7274 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7275 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7276 {"FocusGained", EVENT_FOCUSGAINED},
7277 {"FocusLost", EVENT_FOCUSLOST},
7278 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7279 {"GUIEnter", EVENT_GUIENTER},
7280 {"GUIFailed", EVENT_GUIFAILED},
7281 {"InsertChange", EVENT_INSERTCHANGE},
7282 {"InsertEnter", EVENT_INSERTENTER},
7283 {"InsertLeave", EVENT_INSERTLEAVE},
7284 {"MenuPopup", EVENT_MENUPOPUP},
7285 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7286 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7287 {"RemoteReply", EVENT_REMOTEREPLY},
7288 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7289 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7290 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7291 {"SourcePre", EVENT_SOURCEPRE},
7292 {"SourceCmd", EVENT_SOURCECMD},
7293 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7294 {"StdinReadPost", EVENT_STDINREADPOST},
7295 {"StdinReadPre", EVENT_STDINREADPRE},
7296 {"SwapExists", EVENT_SWAPEXISTS},
7297 {"Syntax", EVENT_SYNTAX},
7298 {"TabEnter", EVENT_TABENTER},
7299 {"TabLeave", EVENT_TABLEAVE},
7300 {"TermChanged", EVENT_TERMCHANGED},
7301 {"TermResponse", EVENT_TERMRESPONSE},
7302 {"User", EVENT_USER},
7303 {"VimEnter", EVENT_VIMENTER},
7304 {"VimLeave", EVENT_VIMLEAVE},
7305 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7306 {"WinEnter", EVENT_WINENTER},
7307 {"WinLeave", EVENT_WINLEAVE},
7308 {"VimResized", EVENT_VIMRESIZED},
7309 {NULL, (event_T)0}
7312 static AutoPat *first_autopat[NUM_EVENTS] =
7314 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7315 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7316 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7317 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7318 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7319 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7323 * struct used to keep status while executing autocommands for an event.
7325 typedef struct AutoPatCmd
7327 AutoPat *curpat; /* next AutoPat to examine */
7328 AutoCmd *nextcmd; /* next AutoCmd to execute */
7329 int group; /* group being used */
7330 char_u *fname; /* fname to match with */
7331 char_u *sfname; /* sfname to match with */
7332 char_u *tail; /* tail of fname */
7333 event_T event; /* current event */
7334 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7335 buf is deleted */
7336 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7337 } AutoPatCmd;
7339 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7342 * augroups stores a list of autocmd group names.
7344 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7345 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7348 * The ID of the current group. Group 0 is the default one.
7350 static int current_augroup = AUGROUP_DEFAULT;
7352 static int au_need_clean = FALSE; /* need to delete marked patterns */
7354 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7355 static void au_remove_pat __ARGS((AutoPat *ap));
7356 static void au_remove_cmds __ARGS((AutoPat *ap));
7357 static void au_cleanup __ARGS((void));
7358 static int au_new_group __ARGS((char_u *name));
7359 static void au_del_group __ARGS((char_u *name));
7360 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7361 static char_u *event_nr2name __ARGS((event_T event));
7362 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7363 static int event_ignored __ARGS((event_T event));
7364 static int au_get_grouparg __ARGS((char_u **argp));
7365 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7366 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7367 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));
7368 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7371 static event_T last_event;
7372 static int last_group;
7373 static int autocmd_blocked = 0; /* block all autocmds */
7376 * Show the autocommands for one AutoPat.
7378 static void
7379 show_autocmd(ap, event)
7380 AutoPat *ap;
7381 event_T event;
7383 AutoCmd *ac;
7385 /* Check for "got_int" (here and at various places below), which is set
7386 * when "q" has been hit for the "--more--" prompt */
7387 if (got_int)
7388 return;
7389 if (ap->pat == NULL) /* pattern has been removed */
7390 return;
7392 msg_putchar('\n');
7393 if (got_int)
7394 return;
7395 if (event != last_event || ap->group != last_group)
7397 if (ap->group != AUGROUP_DEFAULT)
7399 if (AUGROUP_NAME(ap->group) == NULL)
7400 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7401 else
7402 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7403 msg_puts((char_u *)" ");
7405 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7406 last_event = event;
7407 last_group = ap->group;
7408 msg_putchar('\n');
7409 if (got_int)
7410 return;
7412 msg_col = 4;
7413 msg_outtrans(ap->pat);
7415 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7417 if (ac->cmd != NULL) /* skip removed commands */
7419 if (msg_col >= 14)
7420 msg_putchar('\n');
7421 msg_col = 14;
7422 if (got_int)
7423 return;
7424 msg_outtrans(ac->cmd);
7425 #ifdef FEAT_EVAL
7426 if (p_verbose > 0)
7427 last_set_msg(ac->scriptID);
7428 #endif
7429 if (got_int)
7430 return;
7431 if (ac->next != NULL)
7433 msg_putchar('\n');
7434 if (got_int)
7435 return;
7442 * Mark an autocommand pattern for deletion.
7444 static void
7445 au_remove_pat(ap)
7446 AutoPat *ap;
7448 vim_free(ap->pat);
7449 ap->pat = NULL;
7450 ap->buflocal_nr = -1;
7451 au_need_clean = TRUE;
7455 * Mark all commands for a pattern for deletion.
7457 static void
7458 au_remove_cmds(ap)
7459 AutoPat *ap;
7461 AutoCmd *ac;
7463 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7465 vim_free(ac->cmd);
7466 ac->cmd = NULL;
7468 au_need_clean = TRUE;
7472 * Cleanup autocommands and patterns that have been deleted.
7473 * This is only done when not executing autocommands.
7475 static void
7476 au_cleanup()
7478 AutoPat *ap, **prev_ap;
7479 AutoCmd *ac, **prev_ac;
7480 event_T event;
7482 if (autocmd_busy || !au_need_clean)
7483 return;
7485 /* loop over all events */
7486 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7487 event = (event_T)((int)event + 1))
7489 /* loop over all autocommand patterns */
7490 prev_ap = &(first_autopat[(int)event]);
7491 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7493 /* loop over all commands for this pattern */
7494 prev_ac = &(ap->cmds);
7495 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7497 /* remove the command if the pattern is to be deleted or when
7498 * the command has been marked for deletion */
7499 if (ap->pat == NULL || ac->cmd == NULL)
7501 *prev_ac = ac->next;
7502 vim_free(ac->cmd);
7503 vim_free(ac);
7505 else
7506 prev_ac = &(ac->next);
7509 /* remove the pattern if it has been marked for deletion */
7510 if (ap->pat == NULL)
7512 *prev_ap = ap->next;
7513 vim_free(ap->reg_prog);
7514 vim_free(ap);
7516 else
7517 prev_ap = &(ap->next);
7521 au_need_clean = FALSE;
7525 * Called when buffer is freed, to remove/invalidate related buffer-local
7526 * autocmds.
7528 void
7529 aubuflocal_remove(buf)
7530 buf_T *buf;
7532 AutoPat *ap;
7533 event_T event;
7534 AutoPatCmd *apc;
7536 /* invalidate currently executing autocommands */
7537 for (apc = active_apc_list; apc; apc = apc->next)
7538 if (buf->b_fnum == apc->arg_bufnr)
7539 apc->arg_bufnr = 0;
7541 /* invalidate buflocals looping through events */
7542 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7543 event = (event_T)((int)event + 1))
7544 /* loop over all autocommand patterns */
7545 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7546 if (ap->buflocal_nr == buf->b_fnum)
7548 au_remove_pat(ap);
7549 if (p_verbose >= 6)
7551 verbose_enter();
7552 smsg((char_u *)
7553 _("auto-removing autocommand: %s <buffer=%d>"),
7554 event_nr2name(event), buf->b_fnum);
7555 verbose_leave();
7558 au_cleanup();
7562 * Add an autocmd group name.
7563 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7565 static int
7566 au_new_group(name)
7567 char_u *name;
7569 int i;
7571 i = au_find_group(name);
7572 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7574 /* First try using a free entry. */
7575 for (i = 0; i < augroups.ga_len; ++i)
7576 if (AUGROUP_NAME(i) == NULL)
7577 break;
7578 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7579 return AUGROUP_ERROR;
7581 AUGROUP_NAME(i) = vim_strsave(name);
7582 if (AUGROUP_NAME(i) == NULL)
7583 return AUGROUP_ERROR;
7584 if (i == augroups.ga_len)
7585 ++augroups.ga_len;
7588 return i;
7591 static void
7592 au_del_group(name)
7593 char_u *name;
7595 int i;
7597 i = au_find_group(name);
7598 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7599 EMSG2(_("E367: No such group: \"%s\""), name);
7600 else
7602 vim_free(AUGROUP_NAME(i));
7603 AUGROUP_NAME(i) = NULL;
7608 * Find the ID of an autocmd group name.
7609 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7611 static int
7612 au_find_group(name)
7613 char_u *name;
7615 int i;
7617 for (i = 0; i < augroups.ga_len; ++i)
7618 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7619 return i;
7620 return AUGROUP_ERROR;
7624 * Return TRUE if augroup "name" exists.
7627 au_has_group(name)
7628 char_u *name;
7630 return au_find_group(name) != AUGROUP_ERROR;
7634 * ":augroup {name}".
7636 void
7637 do_augroup(arg, del_group)
7638 char_u *arg;
7639 int del_group;
7641 int i;
7643 if (del_group)
7645 if (*arg == NUL)
7646 EMSG(_(e_argreq));
7647 else
7648 au_del_group(arg);
7650 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7651 current_augroup = AUGROUP_DEFAULT;
7652 else if (*arg) /* ":aug xxx": switch to group xxx */
7654 i = au_new_group(arg);
7655 if (i != AUGROUP_ERROR)
7656 current_augroup = i;
7658 else /* ":aug": list the group names */
7660 msg_start();
7661 for (i = 0; i < augroups.ga_len; ++i)
7663 if (AUGROUP_NAME(i) != NULL)
7665 msg_puts(AUGROUP_NAME(i));
7666 msg_puts((char_u *)" ");
7669 msg_clr_eos();
7670 msg_end();
7674 #if defined(EXITFREE) || defined(PROTO)
7675 void
7676 free_all_autocmds()
7678 for (current_augroup = -1; current_augroup < augroups.ga_len;
7679 ++current_augroup)
7680 do_autocmd((char_u *)"", TRUE);
7681 ga_clear_strings(&augroups);
7683 #endif
7686 * Return the event number for event name "start".
7687 * Return NUM_EVENTS if the event name was not found.
7688 * Return a pointer to the next event name in "end".
7690 static event_T
7691 event_name2nr(start, end)
7692 char_u *start;
7693 char_u **end;
7695 char_u *p;
7696 int i;
7697 int len;
7699 /* the event name ends with end of line, a blank or a comma */
7700 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7702 for (i = 0; event_names[i].name != NULL; ++i)
7704 len = (int)STRLEN(event_names[i].name);
7705 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7706 break;
7708 if (*p == ',')
7709 ++p;
7710 *end = p;
7711 if (event_names[i].name == NULL)
7712 return NUM_EVENTS;
7713 return event_names[i].event;
7717 * Return the name for event "event".
7719 static char_u *
7720 event_nr2name(event)
7721 event_T event;
7723 int i;
7725 for (i = 0; event_names[i].name != NULL; ++i)
7726 if (event_names[i].event == event)
7727 return (char_u *)event_names[i].name;
7728 return (char_u *)"Unknown";
7732 * Scan over the events. "*" stands for all events.
7734 static char_u *
7735 find_end_event(arg, have_group)
7736 char_u *arg;
7737 int have_group; /* TRUE when group name was found */
7739 char_u *pat;
7740 char_u *p;
7742 if (*arg == '*')
7744 if (arg[1] && !vim_iswhite(arg[1]))
7746 EMSG2(_("E215: Illegal character after *: %s"), arg);
7747 return NULL;
7749 pat = arg + 1;
7751 else
7753 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7755 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7757 if (have_group)
7758 EMSG2(_("E216: No such event: %s"), pat);
7759 else
7760 EMSG2(_("E216: No such group or event: %s"), pat);
7761 return NULL;
7765 return pat;
7769 * Return TRUE if "event" is included in 'eventignore'.
7771 static int
7772 event_ignored(event)
7773 event_T event;
7775 char_u *p = p_ei;
7777 while (*p != NUL)
7779 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7780 return TRUE;
7781 if (event_name2nr(p, &p) == event)
7782 return TRUE;
7785 return FALSE;
7789 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7792 check_ei()
7794 char_u *p = p_ei;
7796 while (*p)
7798 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7800 p += 3;
7801 if (*p == ',')
7802 ++p;
7804 else if (event_name2nr(p, &p) == NUM_EVENTS)
7805 return FAIL;
7808 return OK;
7811 # if defined(FEAT_SYN_HL) || defined(PROTO)
7814 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7815 * buffer loaded into the window. "what" must start with a comma.
7816 * Returns the old value of 'eventignore' in allocated memory.
7818 char_u *
7819 au_event_disable(what)
7820 char *what;
7822 char_u *new_ei;
7823 char_u *save_ei;
7825 save_ei = vim_strsave(p_ei);
7826 if (save_ei != NULL)
7828 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7829 if (new_ei != NULL)
7831 STRCAT(new_ei, what);
7832 set_string_option_direct((char_u *)"ei", -1, new_ei,
7833 OPT_FREE, SID_NONE);
7834 vim_free(new_ei);
7837 return save_ei;
7840 void
7841 au_event_restore(old_ei)
7842 char_u *old_ei;
7844 if (old_ei != NULL)
7846 set_string_option_direct((char_u *)"ei", -1, old_ei,
7847 OPT_FREE, SID_NONE);
7848 vim_free(old_ei);
7851 # endif /* FEAT_SYN_HL */
7854 * do_autocmd() -- implements the :autocmd command. Can be used in the
7855 * following ways:
7857 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7858 * will be automatically executed for <event>
7859 * when editing a file matching <pat>, in
7860 * the current group.
7861 * :autocmd <event> <pat> Show the auto-commands associated with
7862 * <event> and <pat>.
7863 * :autocmd <event> Show the auto-commands associated with
7864 * <event>.
7865 * :autocmd Show all auto-commands.
7866 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7867 * <event> and <pat>, and add the command
7868 * <cmd>, for the current group.
7869 * :autocmd! <event> <pat> Remove all auto-commands associated with
7870 * <event> and <pat> for the current group.
7871 * :autocmd! <event> Remove all auto-commands associated with
7872 * <event> for the current group.
7873 * :autocmd! Remove ALL auto-commands for the current
7874 * group.
7876 * Multiple events and patterns may be given separated by commas. Here are
7877 * some examples:
7878 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7879 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7881 * :autocmd * *.c show all autocommands for *.c files.
7883 * Mostly a {group} argument can optionally appear before <event>.
7885 void
7886 do_autocmd(arg, forceit)
7887 char_u *arg;
7888 int forceit;
7890 char_u *pat;
7891 char_u *envpat = NULL;
7892 char_u *cmd;
7893 event_T event;
7894 int need_free = FALSE;
7895 int nested = FALSE;
7896 int group;
7899 * Check for a legal group name. If not, use AUGROUP_ALL.
7901 group = au_get_grouparg(&arg);
7902 if (arg == NULL) /* out of memory */
7903 return;
7906 * Scan over the events.
7907 * If we find an illegal name, return here, don't do anything.
7909 pat = find_end_event(arg, group != AUGROUP_ALL);
7910 if (pat == NULL)
7911 return;
7914 * Scan over the pattern. Put a NUL at the end.
7916 pat = skipwhite(pat);
7917 cmd = pat;
7918 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
7919 cmd++;
7920 if (*cmd)
7921 *cmd++ = NUL;
7923 /* Expand environment variables in the pattern. Set 'shellslash', we want
7924 * forward slashes here. */
7925 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
7927 #ifdef BACKSLASH_IN_FILENAME
7928 int p_ssl_save = p_ssl;
7930 p_ssl = TRUE;
7931 #endif
7932 envpat = expand_env_save(pat);
7933 #ifdef BACKSLASH_IN_FILENAME
7934 p_ssl = p_ssl_save;
7935 #endif
7936 if (envpat != NULL)
7937 pat = envpat;
7941 * Check for "nested" flag.
7943 cmd = skipwhite(cmd);
7944 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
7946 nested = TRUE;
7947 cmd = skipwhite(cmd + 6);
7951 * Find the start of the commands.
7952 * Expand <sfile> in it.
7954 if (*cmd != NUL)
7956 cmd = expand_sfile(cmd);
7957 if (cmd == NULL) /* some error */
7958 return;
7959 need_free = TRUE;
7963 * Print header when showing autocommands.
7965 if (!forceit && *cmd == NUL)
7967 /* Highlight title */
7968 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7972 * Loop over the events.
7974 last_event = (event_T)-1; /* for listing the event name */
7975 last_group = AUGROUP_ERROR; /* for listing the group name */
7976 if (*arg == '*' || *arg == NUL)
7978 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7979 event = (event_T)((int)event + 1))
7980 if (do_autocmd_event(event, pat,
7981 nested, cmd, forceit, group) == FAIL)
7982 break;
7984 else
7986 while (*arg && !vim_iswhite(*arg))
7987 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
7988 nested, cmd, forceit, group) == FAIL)
7989 break;
7992 if (need_free)
7993 vim_free(cmd);
7994 vim_free(envpat);
7998 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
7999 * The "argp" argument is advanced to the following argument.
8001 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
8003 static int
8004 au_get_grouparg(argp)
8005 char_u **argp;
8007 char_u *group_name;
8008 char_u *p;
8009 char_u *arg = *argp;
8010 int group = AUGROUP_ALL;
8012 p = skiptowhite(arg);
8013 if (p > arg)
8015 group_name = vim_strnsave(arg, (int)(p - arg));
8016 if (group_name == NULL) /* out of memory */
8017 return AUGROUP_ERROR;
8018 group = au_find_group(group_name);
8019 if (group == AUGROUP_ERROR)
8020 group = AUGROUP_ALL; /* no match, use all groups */
8021 else
8022 *argp = skipwhite(p); /* match, skip over group name */
8023 vim_free(group_name);
8025 return group;
8029 * do_autocmd() for one event.
8030 * If *pat == NUL do for all patterns.
8031 * If *cmd == NUL show entries.
8032 * If forceit == TRUE delete entries.
8033 * If group is not AUGROUP_ALL, only use this group.
8035 static int
8036 do_autocmd_event(event, pat, nested, cmd, forceit, group)
8037 event_T event;
8038 char_u *pat;
8039 int nested;
8040 char_u *cmd;
8041 int forceit;
8042 int group;
8044 AutoPat *ap;
8045 AutoPat **prev_ap;
8046 AutoCmd *ac;
8047 AutoCmd **prev_ac;
8048 int brace_level;
8049 char_u *endpat;
8050 int findgroup;
8051 int allgroups;
8052 int patlen;
8053 int is_buflocal;
8054 int buflocal_nr;
8055 char_u buflocal_pat[25]; /* for "<buffer=X>" */
8057 if (group == AUGROUP_ALL)
8058 findgroup = current_augroup;
8059 else
8060 findgroup = group;
8061 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
8064 * Show or delete all patterns for an event.
8066 if (*pat == NUL)
8068 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
8070 if (forceit) /* delete the AutoPat, if it's in the current group */
8072 if (ap->group == findgroup)
8073 au_remove_pat(ap);
8075 else if (group == AUGROUP_ALL || ap->group == group)
8076 show_autocmd(ap, event);
8081 * Loop through all the specified patterns.
8083 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
8086 * Find end of the pattern.
8087 * Watch out for a comma in braces, like "*.\{obj,o\}".
8089 brace_level = 0;
8090 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
8091 || endpat[-1] == '\\'); ++endpat)
8093 if (*endpat == '{')
8094 brace_level++;
8095 else if (*endpat == '}')
8096 brace_level--;
8098 if (pat == endpat) /* ignore single comma */
8099 continue;
8100 patlen = (int)(endpat - pat);
8103 * detect special <buflocal[=X]> buffer-local patterns
8105 is_buflocal = FALSE;
8106 buflocal_nr = 0;
8108 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
8109 && pat[patlen - 1] == '>')
8111 /* Error will be printed only for addition. printing and removing
8112 * will proceed silently. */
8113 is_buflocal = TRUE;
8114 if (patlen == 8)
8115 buflocal_nr = curbuf->b_fnum;
8116 else if (patlen > 9 && pat[7] == '=')
8118 /* <buffer=abuf> */
8119 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
8120 buflocal_nr = autocmd_bufnr;
8121 /* <buffer=123> */
8122 else if (skipdigits(pat + 8) == pat + patlen - 1)
8123 buflocal_nr = atoi((char *)pat + 8);
8127 if (is_buflocal)
8129 /* normalize pat into standard "<buffer>#N" form */
8130 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
8131 pat = buflocal_pat; /* can modify pat and patlen */
8132 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
8136 * Find AutoPat entries with this pattern.
8138 prev_ap = &first_autopat[(int)event];
8139 while ((ap = *prev_ap) != NULL)
8141 if (ap->pat != NULL)
8143 /* Accept a pattern when:
8144 * - a group was specified and it's that group, or a group was
8145 * not specified and it's the current group, or a group was
8146 * not specified and we are listing
8147 * - the length of the pattern matches
8148 * - the pattern matches.
8149 * For <buffer[=X]>, this condition works because we normalize
8150 * all buffer-local patterns.
8152 if ((allgroups || ap->group == findgroup)
8153 && ap->patlen == patlen
8154 && STRNCMP(pat, ap->pat, patlen) == 0)
8157 * Remove existing autocommands.
8158 * If adding any new autocmd's for this AutoPat, don't
8159 * delete the pattern from the autopat list, append to
8160 * this list.
8162 if (forceit)
8164 if (*cmd != NUL && ap->next == NULL)
8166 au_remove_cmds(ap);
8167 break;
8169 au_remove_pat(ap);
8173 * Show autocmd's for this autopat, or buflocals <buffer=X>
8175 else if (*cmd == NUL)
8176 show_autocmd(ap, event);
8179 * Add autocmd to this autopat, if it's the last one.
8181 else if (ap->next == NULL)
8182 break;
8185 prev_ap = &ap->next;
8189 * Add a new command.
8191 if (*cmd != NUL)
8194 * If the pattern we want to add a command to does appear at the
8195 * end of the list (or not is not in the list at all), add the
8196 * pattern at the end of the list.
8198 if (ap == NULL)
8200 /* refuse to add buffer-local ap if buffer number is invalid */
8201 if (is_buflocal && (buflocal_nr == 0
8202 || buflist_findnr(buflocal_nr) == NULL))
8204 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8205 buflocal_nr);
8206 return FAIL;
8209 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
8210 if (ap == NULL)
8211 return FAIL;
8212 ap->pat = vim_strnsave(pat, patlen);
8213 ap->patlen = patlen;
8214 if (ap->pat == NULL)
8216 vim_free(ap);
8217 return FAIL;
8220 if (is_buflocal)
8222 ap->buflocal_nr = buflocal_nr;
8223 ap->reg_prog = NULL;
8225 else
8227 char_u *reg_pat;
8229 ap->buflocal_nr = 0;
8230 reg_pat = file_pat_to_reg_pat(pat, endpat,
8231 &ap->allow_dirs, TRUE);
8232 if (reg_pat != NULL)
8233 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
8234 vim_free(reg_pat);
8235 if (reg_pat == NULL || ap->reg_prog == NULL)
8237 vim_free(ap->pat);
8238 vim_free(ap);
8239 return FAIL;
8242 ap->cmds = NULL;
8243 *prev_ap = ap;
8244 ap->next = NULL;
8245 if (group == AUGROUP_ALL)
8246 ap->group = current_augroup;
8247 else
8248 ap->group = group;
8252 * Add the autocmd at the end of the AutoCmd list.
8254 prev_ac = &(ap->cmds);
8255 while ((ac = *prev_ac) != NULL)
8256 prev_ac = &ac->next;
8257 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
8258 if (ac == NULL)
8259 return FAIL;
8260 ac->cmd = vim_strsave(cmd);
8261 #ifdef FEAT_EVAL
8262 ac->scriptID = current_SID;
8263 #endif
8264 if (ac->cmd == NULL)
8266 vim_free(ac);
8267 return FAIL;
8269 ac->next = NULL;
8270 *prev_ac = ac;
8271 ac->nested = nested;
8275 au_cleanup(); /* may really delete removed patterns/commands now */
8276 return OK;
8280 * Implementation of ":doautocmd [group] event [fname]".
8281 * Return OK for success, FAIL for failure;
8284 do_doautocmd(arg, do_msg)
8285 char_u *arg;
8286 int do_msg; /* give message for no matching autocmds? */
8288 char_u *fname;
8289 int nothing_done = TRUE;
8290 int group;
8293 * Check for a legal group name. If not, use AUGROUP_ALL.
8295 group = au_get_grouparg(&arg);
8296 if (arg == NULL) /* out of memory */
8297 return FAIL;
8299 if (*arg == '*')
8301 EMSG(_("E217: Can't execute autocommands for ALL events"));
8302 return FAIL;
8306 * Scan over the events.
8307 * If we find an illegal name, return here, don't do anything.
8309 fname = find_end_event(arg, group != AUGROUP_ALL);
8310 if (fname == NULL)
8311 return FAIL;
8313 fname = skipwhite(fname);
8316 * Loop over the events.
8318 while (*arg && !vim_iswhite(*arg))
8319 if (apply_autocmds_group(event_name2nr(arg, &arg),
8320 fname, NULL, TRUE, group, curbuf, NULL))
8321 nothing_done = FALSE;
8323 if (nothing_done && do_msg)
8324 MSG(_("No matching autocommands"));
8326 #ifdef FEAT_EVAL
8327 return aborting() ? FAIL : OK;
8328 #else
8329 return OK;
8330 #endif
8334 * ":doautoall": execute autocommands for each loaded buffer.
8336 void
8337 ex_doautoall(eap)
8338 exarg_T *eap;
8340 int retval;
8341 aco_save_T aco;
8342 buf_T *buf;
8345 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8346 * equal to curbuf, but for some buffers there may not be a window.
8347 * So we change the buffer for the current window for a moment. This
8348 * gives problems when the autocommands make changes to the list of
8349 * buffers or windows...
8351 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8353 if (buf->b_ml.ml_mfp != NULL)
8355 /* find a window for this buffer and save some values */
8356 aucmd_prepbuf(&aco, buf);
8358 /* execute the autocommands for this buffer */
8359 retval = do_doautocmd(eap->arg, FALSE);
8361 /* Execute the modeline settings, but don't set window-local
8362 * options if we are using the current window for another buffer. */
8363 do_modelines(aco.save_curwin == NULL ? OPT_NOWIN : 0);
8365 /* restore the current window */
8366 aucmd_restbuf(&aco);
8368 /* stop if there is some error or buffer was deleted */
8369 if (retval == FAIL || !buf_valid(buf))
8370 break;
8374 check_cursor(); /* just in case lines got deleted */
8378 * Prepare for executing autocommands for (hidden) buffer "buf".
8379 * Search a window for the current buffer. Save the cursor position and
8380 * screen offset.
8381 * Set "curbuf" and "curwin" to match "buf".
8382 * When FEAT_AUTOCMD is not defined another version is used, see below.
8384 void
8385 aucmd_prepbuf(aco, buf)
8386 aco_save_T *aco; /* structure to save values in */
8387 buf_T *buf; /* new curbuf */
8389 win_T *win;
8391 aco->new_curbuf = buf;
8393 /* Find a window that is for the new buffer */
8394 if (buf == curbuf) /* be quick when buf is curbuf */
8395 win = curwin;
8396 else
8397 #ifdef FEAT_WINDOWS
8398 for (win = firstwin; win != NULL; win = win->w_next)
8399 if (win->w_buffer == buf)
8400 break;
8401 #else
8402 win = NULL;
8403 #endif
8406 * Prefer to use an existing window for the buffer, it has the least side
8407 * effects (esp. if "buf" is curbuf).
8408 * Otherwise, use curwin for "buf". It might make some items in the
8409 * window invalid. At least save the cursor and topline.
8411 if (win != NULL)
8413 /* there is a window for "buf", make it the curwin */
8414 aco->save_curwin = curwin;
8415 curwin = win;
8416 aco->save_buf = win->w_buffer;
8417 aco->new_curwin = win;
8419 else
8421 /* there is no window for "buf", use curwin */
8422 aco->save_curwin = NULL;
8423 aco->save_buf = curbuf;
8424 --curbuf->b_nwindows;
8425 curwin->w_buffer = buf;
8426 ++buf->b_nwindows;
8428 /* save cursor and topline, set them to safe values */
8429 aco->save_cursor = curwin->w_cursor;
8430 curwin->w_cursor.lnum = 1;
8431 curwin->w_cursor.col = 0;
8432 aco->save_topline = curwin->w_topline;
8433 curwin->w_topline = 1;
8434 #ifdef FEAT_DIFF
8435 aco->save_topfill = curwin->w_topfill;
8436 curwin->w_topfill = 0;
8437 #endif
8440 curbuf = buf;
8444 * Cleanup after executing autocommands for a (hidden) buffer.
8445 * Restore the window as it was (if possible).
8446 * When FEAT_AUTOCMD is not defined another version is used, see below.
8448 void
8449 aucmd_restbuf(aco)
8450 aco_save_T *aco; /* structure holding saved values */
8452 if (aco->save_curwin != NULL)
8454 /* restore curwin */
8455 #ifdef FEAT_WINDOWS
8456 if (win_valid(aco->save_curwin))
8457 #endif
8459 /* restore the buffer which was previously edited by curwin, if
8460 * it's still the same window and it's valid */
8461 if (curwin == aco->new_curwin
8462 && buf_valid(aco->save_buf)
8463 && aco->save_buf->b_ml.ml_mfp != NULL)
8465 --curbuf->b_nwindows;
8466 curbuf = aco->save_buf;
8467 curwin->w_buffer = curbuf;
8468 ++curbuf->b_nwindows;
8471 curwin = aco->save_curwin;
8472 curbuf = curwin->w_buffer;
8475 else
8477 /* restore buffer for curwin if it still exists and is loaded */
8478 if (buf_valid(aco->save_buf) && aco->save_buf->b_ml.ml_mfp != NULL)
8480 --curbuf->b_nwindows;
8481 curbuf = aco->save_buf;
8482 curwin->w_buffer = curbuf;
8483 ++curbuf->b_nwindows;
8484 curwin->w_cursor = aco->save_cursor;
8485 check_cursor();
8486 /* check topline < line_count, in case lines got deleted */
8487 if (aco->save_topline <= curbuf->b_ml.ml_line_count)
8489 curwin->w_topline = aco->save_topline;
8490 #ifdef FEAT_DIFF
8491 curwin->w_topfill = aco->save_topfill;
8492 #endif
8494 else
8496 curwin->w_topline = curbuf->b_ml.ml_line_count;
8497 #ifdef FEAT_DIFF
8498 curwin->w_topfill = 0;
8499 #endif
8505 static int autocmd_nested = FALSE;
8508 * Execute autocommands for "event" and file name "fname".
8509 * Return TRUE if some commands were executed.
8512 apply_autocmds(event, fname, fname_io, force, buf)
8513 event_T event;
8514 char_u *fname; /* NULL or empty means use actual file name */
8515 char_u *fname_io; /* fname to use for <afile> on cmdline */
8516 int force; /* when TRUE, ignore autocmd_busy */
8517 buf_T *buf; /* buffer for <abuf> */
8519 return apply_autocmds_group(event, fname, fname_io, force,
8520 AUGROUP_ALL, buf, NULL);
8524 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8525 * setting v:filearg.
8527 static int
8528 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8529 event_T event;
8530 char_u *fname;
8531 char_u *fname_io;
8532 int force;
8533 buf_T *buf;
8534 exarg_T *eap;
8536 return apply_autocmds_group(event, fname, fname_io, force,
8537 AUGROUP_ALL, buf, eap);
8541 * Like apply_autocmds(), but handles the caller's retval. If the script
8542 * processing is being aborted or if retval is FAIL when inside a try
8543 * conditional, no autocommands are executed. If otherwise the autocommands
8544 * cause the script to be aborted, retval is set to FAIL.
8547 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8548 event_T event;
8549 char_u *fname; /* NULL or empty means use actual file name */
8550 char_u *fname_io; /* fname to use for <afile> on cmdline */
8551 int force; /* when TRUE, ignore autocmd_busy */
8552 buf_T *buf; /* buffer for <abuf> */
8553 int *retval; /* pointer to caller's retval */
8555 int did_cmd;
8557 #ifdef FEAT_EVAL
8558 if (should_abort(*retval))
8559 return FALSE;
8560 #endif
8562 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8563 AUGROUP_ALL, buf, NULL);
8564 if (did_cmd
8565 #ifdef FEAT_EVAL
8566 && aborting()
8567 #endif
8569 *retval = FAIL;
8570 return did_cmd;
8574 * Return TRUE when there is a CursorHold autocommand defined.
8577 has_cursorhold()
8579 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8580 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8584 * Return TRUE if the CursorHold event can be triggered.
8587 trigger_cursorhold()
8589 int state;
8591 if (!did_cursorhold && has_cursorhold() && !Recording
8592 #ifdef FEAT_INS_EXPAND
8593 && !ins_compl_active()
8594 #endif
8597 state = get_real_state();
8598 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8599 return TRUE;
8601 return FALSE;
8605 * Return TRUE when there is a CursorMoved autocommand defined.
8608 has_cursormoved()
8610 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8614 * Return TRUE when there is a CursorMovedI autocommand defined.
8617 has_cursormovedI()
8619 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8622 static int
8623 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8624 event_T event;
8625 char_u *fname; /* NULL or empty means use actual file name */
8626 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8627 use fname */
8628 int force; /* when TRUE, ignore autocmd_busy */
8629 int group; /* group ID, or AUGROUP_ALL */
8630 buf_T *buf; /* buffer for <abuf> */
8631 exarg_T *eap; /* command arguments */
8633 char_u *sfname = NULL; /* short file name */
8634 char_u *tail;
8635 int save_changed;
8636 buf_T *old_curbuf;
8637 int retval = FALSE;
8638 char_u *save_sourcing_name;
8639 linenr_T save_sourcing_lnum;
8640 char_u *save_autocmd_fname;
8641 int save_autocmd_fname_full;
8642 int save_autocmd_bufnr;
8643 char_u *save_autocmd_match;
8644 int save_autocmd_busy;
8645 int save_autocmd_nested;
8646 static int nesting = 0;
8647 AutoPatCmd patcmd;
8648 AutoPat *ap;
8649 #ifdef FEAT_EVAL
8650 scid_T save_current_SID;
8651 void *save_funccalp;
8652 char_u *save_cmdarg;
8653 long save_cmdbang;
8654 #endif
8655 static int filechangeshell_busy = FALSE;
8656 #ifdef FEAT_PROFILE
8657 proftime_T wait_time;
8658 #endif
8661 * Quickly return if there are no autocommands for this event or
8662 * autocommands are blocked.
8664 if (first_autopat[(int)event] == NULL || autocmd_blocked > 0)
8665 goto BYPASS_AU;
8668 * When autocommands are busy, new autocommands are only executed when
8669 * explicitly enabled with the "nested" flag.
8671 if (autocmd_busy && !(force || autocmd_nested))
8672 goto BYPASS_AU;
8674 #ifdef FEAT_EVAL
8676 * Quickly return when immediately aborting on error, or when an interrupt
8677 * occurred or an exception was thrown but not caught.
8679 if (aborting())
8680 goto BYPASS_AU;
8681 #endif
8684 * FileChangedShell never nests, because it can create an endless loop.
8686 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8687 || event == EVENT_FILECHANGEDSHELLPOST))
8688 goto BYPASS_AU;
8691 * Ignore events in 'eventignore'.
8693 if (event_ignored(event))
8694 goto BYPASS_AU;
8697 * Allow nesting of autocommands, but restrict the depth, because it's
8698 * possible to create an endless loop.
8700 if (nesting == 10)
8702 EMSG(_("E218: autocommand nesting too deep"));
8703 goto BYPASS_AU;
8707 * Check if these autocommands are disabled. Used when doing ":all" or
8708 * ":ball".
8710 if ( (autocmd_no_enter
8711 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8712 || (autocmd_no_leave
8713 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8714 goto BYPASS_AU;
8717 * Save the autocmd_* variables and info about the current buffer.
8719 save_autocmd_fname = autocmd_fname;
8720 save_autocmd_fname_full = autocmd_fname_full;
8721 save_autocmd_bufnr = autocmd_bufnr;
8722 save_autocmd_match = autocmd_match;
8723 save_autocmd_busy = autocmd_busy;
8724 save_autocmd_nested = autocmd_nested;
8725 save_changed = curbuf->b_changed;
8726 old_curbuf = curbuf;
8729 * Set the file name to be used for <afile>.
8730 * Make a copy to avoid that changing a buffer name or directory makes it
8731 * invalid.
8733 if (fname_io == NULL)
8735 if (fname != NULL && *fname != NUL)
8736 autocmd_fname = fname;
8737 else if (buf != NULL)
8738 autocmd_fname = buf->b_ffname;
8739 else
8740 autocmd_fname = NULL;
8742 else
8743 autocmd_fname = fname_io;
8744 if (autocmd_fname != NULL)
8745 autocmd_fname = vim_strsave(autocmd_fname);
8746 autocmd_fname_full = FALSE; /* call FullName_save() later */
8749 * Set the buffer number to be used for <abuf>.
8751 if (buf == NULL)
8752 autocmd_bufnr = 0;
8753 else
8754 autocmd_bufnr = buf->b_fnum;
8757 * When the file name is NULL or empty, use the file name of buffer "buf".
8758 * Always use the full path of the file name to match with, in case
8759 * "allow_dirs" is set.
8761 if (fname == NULL || *fname == NUL)
8763 if (buf == NULL)
8764 fname = NULL;
8765 else
8767 #ifdef FEAT_SYN_HL
8768 if (event == EVENT_SYNTAX)
8769 fname = buf->b_p_syn;
8770 else
8771 #endif
8772 if (event == EVENT_FILETYPE)
8773 fname = buf->b_p_ft;
8774 else
8776 if (buf->b_sfname != NULL)
8777 sfname = vim_strsave(buf->b_sfname);
8778 fname = buf->b_ffname;
8781 if (fname == NULL)
8782 fname = (char_u *)"";
8783 fname = vim_strsave(fname); /* make a copy, so we can change it */
8785 else
8787 sfname = vim_strsave(fname);
8788 /* Don't try expanding FileType, Syntax, FuncUndefined, WindowID or
8789 * QuickFixCmd* */
8790 if (event == EVENT_FILETYPE
8791 || event == EVENT_SYNTAX
8792 || event == EVENT_FUNCUNDEFINED
8793 || event == EVENT_REMOTEREPLY
8794 || event == EVENT_SPELLFILEMISSING
8795 || event == EVENT_QUICKFIXCMDPRE
8796 || event == EVENT_QUICKFIXCMDPOST)
8797 fname = vim_strsave(fname);
8798 else
8799 fname = FullName_save(fname, FALSE);
8801 if (fname == NULL) /* out of memory */
8803 vim_free(sfname);
8804 retval = FALSE;
8805 goto BYPASS_AU;
8808 #ifdef BACKSLASH_IN_FILENAME
8810 * Replace all backslashes with forward slashes. This makes the
8811 * autocommand patterns portable between Unix and MS-DOS.
8813 if (sfname != NULL)
8814 forward_slash(sfname);
8815 forward_slash(fname);
8816 #endif
8818 #ifdef VMS
8819 /* remove version for correct match */
8820 if (sfname != NULL)
8821 vms_remove_version(sfname);
8822 vms_remove_version(fname);
8823 #endif
8826 * Set the name to be used for <amatch>.
8828 autocmd_match = fname;
8831 /* Don't redraw while doing auto commands. */
8832 ++RedrawingDisabled;
8833 save_sourcing_name = sourcing_name;
8834 sourcing_name = NULL; /* don't free this one */
8835 save_sourcing_lnum = sourcing_lnum;
8836 sourcing_lnum = 0; /* no line number here */
8838 #ifdef FEAT_EVAL
8839 save_current_SID = current_SID;
8841 # ifdef FEAT_PROFILE
8842 if (do_profiling == PROF_YES)
8843 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
8844 # endif
8846 /* Don't use local function variables, if called from a function */
8847 save_funccalp = save_funccal();
8848 #endif
8851 * When starting to execute autocommands, save the search patterns.
8853 if (!autocmd_busy)
8855 save_search_patterns();
8856 saveRedobuff();
8857 did_filetype = keep_filetype;
8861 * Note that we are applying autocmds. Some commands need to know.
8863 autocmd_busy = TRUE;
8864 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
8865 ++nesting; /* see matching decrement below */
8867 /* Remember that FileType was triggered. Used for did_filetype(). */
8868 if (event == EVENT_FILETYPE)
8869 did_filetype = TRUE;
8871 tail = gettail(fname);
8873 /* Find first autocommand that matches */
8874 patcmd.curpat = first_autopat[(int)event];
8875 patcmd.nextcmd = NULL;
8876 patcmd.group = group;
8877 patcmd.fname = fname;
8878 patcmd.sfname = sfname;
8879 patcmd.tail = tail;
8880 patcmd.event = event;
8881 patcmd.arg_bufnr = autocmd_bufnr;
8882 patcmd.next = NULL;
8883 auto_next_pat(&patcmd, FALSE);
8885 /* found one, start executing the autocommands */
8886 if (patcmd.curpat != NULL)
8888 /* add to active_apc_list */
8889 patcmd.next = active_apc_list;
8890 active_apc_list = &patcmd;
8892 #ifdef FEAT_EVAL
8893 /* set v:cmdarg (only when there is a matching pattern) */
8894 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
8895 if (eap != NULL)
8897 save_cmdarg = set_cmdarg(eap, NULL);
8898 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
8900 else
8901 save_cmdarg = NULL; /* avoid gcc warning */
8902 #endif
8903 retval = TRUE;
8904 /* mark the last pattern, to avoid an endless loop when more patterns
8905 * are added when executing autocommands */
8906 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
8907 ap->last = FALSE;
8908 ap->last = TRUE;
8909 check_lnums(TRUE); /* make sure cursor and topline are valid */
8910 do_cmdline(NULL, getnextac, (void *)&patcmd,
8911 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
8912 #ifdef FEAT_EVAL
8913 if (eap != NULL)
8915 (void)set_cmdarg(NULL, save_cmdarg);
8916 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
8918 #endif
8919 /* delete from active_apc_list */
8920 if (active_apc_list == &patcmd) /* just in case */
8921 active_apc_list = patcmd.next;
8924 --RedrawingDisabled;
8925 autocmd_busy = save_autocmd_busy;
8926 filechangeshell_busy = FALSE;
8927 autocmd_nested = save_autocmd_nested;
8928 vim_free(sourcing_name);
8929 sourcing_name = save_sourcing_name;
8930 sourcing_lnum = save_sourcing_lnum;
8931 vim_free(autocmd_fname);
8932 autocmd_fname = save_autocmd_fname;
8933 autocmd_fname_full = save_autocmd_fname_full;
8934 autocmd_bufnr = save_autocmd_bufnr;
8935 autocmd_match = save_autocmd_match;
8936 #ifdef FEAT_EVAL
8937 current_SID = save_current_SID;
8938 restore_funccal(save_funccalp);
8939 # ifdef FEAT_PROFILE
8940 if (do_profiling == PROF_YES)
8941 prof_child_exit(&wait_time);
8942 # endif
8943 #endif
8944 vim_free(fname);
8945 vim_free(sfname);
8946 --nesting; /* see matching increment above */
8949 * When stopping to execute autocommands, restore the search patterns and
8950 * the redo buffer.
8952 if (!autocmd_busy)
8954 restore_search_patterns();
8955 restoreRedobuff();
8956 did_filetype = FALSE;
8960 * Some events don't set or reset the Changed flag.
8961 * Check if still in the same buffer!
8963 if (curbuf == old_curbuf
8964 && (event == EVENT_BUFREADPOST
8965 || event == EVENT_BUFWRITEPOST
8966 || event == EVENT_FILEAPPENDPOST
8967 || event == EVENT_VIMLEAVE
8968 || event == EVENT_VIMLEAVEPRE))
8970 #ifdef FEAT_TITLE
8971 if (curbuf->b_changed != save_changed)
8972 need_maketitle = TRUE;
8973 #endif
8974 curbuf->b_changed = save_changed;
8977 au_cleanup(); /* may really delete removed patterns/commands now */
8979 BYPASS_AU:
8980 /* When wiping out a buffer make sure all its buffer-local autocommands
8981 * are deleted. */
8982 if (event == EVENT_BUFWIPEOUT && buf != NULL)
8983 aubuflocal_remove(buf);
8985 return retval;
8988 # ifdef FEAT_EVAL
8989 static char_u *old_termresponse = NULL;
8990 # endif
8993 * Block triggering autocommands until unblock_autocmd() is called.
8994 * Can be used recursively, so long as it's symmetric.
8996 void
8997 block_autocmds()
8999 # ifdef FEAT_EVAL
9000 /* Remember the value of v:termresponse. */
9001 if (autocmd_blocked == 0)
9002 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
9003 # endif
9004 ++autocmd_blocked;
9007 void
9008 unblock_autocmds()
9010 --autocmd_blocked;
9012 # ifdef FEAT_EVAL
9013 /* When v:termresponse was set while autocommands were blocked, trigger
9014 * the autocommands now. Esp. useful when executing a shell command
9015 * during startup (vimdiff). */
9016 if (autocmd_blocked == 0
9017 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
9018 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
9019 # endif
9023 * Find next autocommand pattern that matches.
9025 static void
9026 auto_next_pat(apc, stop_at_last)
9027 AutoPatCmd *apc;
9028 int stop_at_last; /* stop when 'last' flag is set */
9030 AutoPat *ap;
9031 AutoCmd *cp;
9032 char_u *name;
9033 char *s;
9035 vim_free(sourcing_name);
9036 sourcing_name = NULL;
9038 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
9040 apc->curpat = NULL;
9042 /* Only use a pattern when it has not been removed, has commands and
9043 * the group matches. For buffer-local autocommands only check the
9044 * buffer number. */
9045 if (ap->pat != NULL && ap->cmds != NULL
9046 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
9048 /* execution-condition */
9049 if (ap->buflocal_nr == 0
9050 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
9051 apc->sfname, apc->tail, ap->allow_dirs))
9052 : ap->buflocal_nr == apc->arg_bufnr)
9054 name = event_nr2name(apc->event);
9055 s = _("%s Auto commands for \"%s\"");
9056 sourcing_name = alloc((unsigned)(STRLEN(s)
9057 + STRLEN(name) + ap->patlen + 1));
9058 if (sourcing_name != NULL)
9060 sprintf((char *)sourcing_name, s,
9061 (char *)name, (char *)ap->pat);
9062 if (p_verbose >= 8)
9064 verbose_enter();
9065 smsg((char_u *)_("Executing %s"), sourcing_name);
9066 verbose_leave();
9070 apc->curpat = ap;
9071 apc->nextcmd = ap->cmds;
9072 /* mark last command */
9073 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
9074 cp->last = FALSE;
9075 cp->last = TRUE;
9077 line_breakcheck();
9078 if (apc->curpat != NULL) /* found a match */
9079 break;
9081 if (stop_at_last && ap->last)
9082 break;
9087 * Get next autocommand command.
9088 * Called by do_cmdline() to get the next line for ":if".
9089 * Returns allocated string, or NULL for end of autocommands.
9091 /* ARGSUSED */
9092 static char_u *
9093 getnextac(c, cookie, indent)
9094 int c; /* not used */
9095 void *cookie;
9096 int indent; /* not used */
9098 AutoPatCmd *acp = (AutoPatCmd *)cookie;
9099 char_u *retval;
9100 AutoCmd *ac;
9102 /* Can be called again after returning the last line. */
9103 if (acp->curpat == NULL)
9104 return NULL;
9106 /* repeat until we find an autocommand to execute */
9107 for (;;)
9109 /* skip removed commands */
9110 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
9111 if (acp->nextcmd->last)
9112 acp->nextcmd = NULL;
9113 else
9114 acp->nextcmd = acp->nextcmd->next;
9116 if (acp->nextcmd != NULL)
9117 break;
9119 /* at end of commands, find next pattern that matches */
9120 if (acp->curpat->last)
9121 acp->curpat = NULL;
9122 else
9123 acp->curpat = acp->curpat->next;
9124 if (acp->curpat != NULL)
9125 auto_next_pat(acp, TRUE);
9126 if (acp->curpat == NULL)
9127 return NULL;
9130 ac = acp->nextcmd;
9132 if (p_verbose >= 9)
9134 verbose_enter_scroll();
9135 smsg((char_u *)_("autocommand %s"), ac->cmd);
9136 msg_puts((char_u *)"\n"); /* don't overwrite this either */
9137 verbose_leave_scroll();
9139 retval = vim_strsave(ac->cmd);
9140 autocmd_nested = ac->nested;
9141 #ifdef FEAT_EVAL
9142 current_SID = ac->scriptID;
9143 #endif
9144 if (ac->last)
9145 acp->nextcmd = NULL;
9146 else
9147 acp->nextcmd = ac->next;
9148 return retval;
9152 * Return TRUE if there is a matching autocommand for "fname".
9153 * To account for buffer-local autocommands, function needs to know
9154 * in which buffer the file will be opened.
9157 has_autocmd(event, sfname, buf)
9158 event_T event;
9159 char_u *sfname;
9160 buf_T *buf;
9162 AutoPat *ap;
9163 char_u *fname;
9164 char_u *tail = gettail(sfname);
9165 int retval = FALSE;
9167 fname = FullName_save(sfname, FALSE);
9168 if (fname == NULL)
9169 return FALSE;
9171 #ifdef BACKSLASH_IN_FILENAME
9173 * Replace all backslashes with forward slashes. This makes the
9174 * autocommand patterns portable between Unix and MS-DOS.
9176 sfname = vim_strsave(sfname);
9177 if (sfname != NULL)
9178 forward_slash(sfname);
9179 forward_slash(fname);
9180 #endif
9182 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
9183 if (ap->pat != NULL && ap->cmds != NULL
9184 && (ap->buflocal_nr == 0
9185 ? match_file_pat(NULL, ap->reg_prog,
9186 fname, sfname, tail, ap->allow_dirs)
9187 : buf != NULL && ap->buflocal_nr == buf->b_fnum
9190 retval = TRUE;
9191 break;
9194 vim_free(fname);
9195 #ifdef BACKSLASH_IN_FILENAME
9196 vim_free(sfname);
9197 #endif
9199 return retval;
9202 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9204 * Function given to ExpandGeneric() to obtain the list of autocommand group
9205 * names.
9207 /*ARGSUSED*/
9208 char_u *
9209 get_augroup_name(xp, idx)
9210 expand_T *xp;
9211 int idx;
9213 if (idx == augroups.ga_len) /* add "END" add the end */
9214 return (char_u *)"END";
9215 if (idx >= augroups.ga_len) /* end of list */
9216 return NULL;
9217 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
9218 return (char_u *)"";
9219 return AUGROUP_NAME(idx); /* return a name */
9222 static int include_groups = FALSE;
9224 char_u *
9225 set_context_in_autocmd(xp, arg, doautocmd)
9226 expand_T *xp;
9227 char_u *arg;
9228 int doautocmd; /* TRUE for :doauto*, FALSE for :autocmd */
9230 char_u *p;
9231 int group;
9233 /* check for a group name, skip it if present */
9234 include_groups = FALSE;
9235 p = arg;
9236 group = au_get_grouparg(&arg);
9237 if (group == AUGROUP_ERROR)
9238 return NULL;
9239 /* If there only is a group name that's what we expand. */
9240 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
9242 arg = p;
9243 group = AUGROUP_ALL;
9246 /* skip over event name */
9247 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
9248 if (*p == ',')
9249 arg = p + 1;
9250 if (*p == NUL)
9252 if (group == AUGROUP_ALL)
9253 include_groups = TRUE;
9254 xp->xp_context = EXPAND_EVENTS; /* expand event name */
9255 xp->xp_pattern = arg;
9256 return NULL;
9259 /* skip over pattern */
9260 arg = skipwhite(p);
9261 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
9262 arg++;
9263 if (*arg)
9264 return arg; /* expand (next) command */
9266 if (doautocmd)
9267 xp->xp_context = EXPAND_FILES; /* expand file names */
9268 else
9269 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
9270 return NULL;
9274 * Function given to ExpandGeneric() to obtain the list of event names.
9276 /*ARGSUSED*/
9277 char_u *
9278 get_event_name(xp, idx)
9279 expand_T *xp;
9280 int idx;
9282 if (idx < augroups.ga_len) /* First list group names, if wanted */
9284 if (!include_groups || AUGROUP_NAME(idx) == NULL)
9285 return (char_u *)""; /* skip deleted entries */
9286 return AUGROUP_NAME(idx); /* return a name */
9288 return (char_u *)event_names[idx - augroups.ga_len].name;
9291 #endif /* FEAT_CMDL_COMPL */
9294 * Return TRUE if autocmd is supported.
9297 autocmd_supported(name)
9298 char_u *name;
9300 char_u *p;
9302 return (event_name2nr(name, &p) != NUM_EVENTS);
9306 * Return TRUE if an autocommand is defined for a group, event and
9307 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9308 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9309 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9310 * Used for:
9311 * exists("#Group") or
9312 * exists("#Group#Event") or
9313 * exists("#Group#Event#pat") or
9314 * exists("#Event") or
9315 * exists("#Event#pat")
9318 au_exists(arg)
9319 char_u *arg;
9321 char_u *arg_save;
9322 char_u *pattern = NULL;
9323 char_u *event_name;
9324 char_u *p;
9325 event_T event;
9326 AutoPat *ap;
9327 buf_T *buflocal_buf = NULL;
9328 int group;
9329 int retval = FALSE;
9331 /* Make a copy so that we can change the '#' chars to a NUL. */
9332 arg_save = vim_strsave(arg);
9333 if (arg_save == NULL)
9334 return FALSE;
9335 p = vim_strchr(arg_save, '#');
9336 if (p != NULL)
9337 *p++ = NUL;
9339 /* First, look for an autocmd group name */
9340 group = au_find_group(arg_save);
9341 if (group == AUGROUP_ERROR)
9343 /* Didn't match a group name, assume the first argument is an event. */
9344 group = AUGROUP_ALL;
9345 event_name = arg_save;
9347 else
9349 if (p == NULL)
9351 /* "Group": group name is present and it's recognized */
9352 retval = TRUE;
9353 goto theend;
9356 /* Must be "Group#Event" or "Group#Event#pat". */
9357 event_name = p;
9358 p = vim_strchr(event_name, '#');
9359 if (p != NULL)
9360 *p++ = NUL; /* "Group#Event#pat" */
9363 pattern = p; /* "pattern" is NULL when there is no pattern */
9365 /* find the index (enum) for the event name */
9366 event = event_name2nr(event_name, &p);
9368 /* return FALSE if the event name is not recognized */
9369 if (event == NUM_EVENTS)
9370 goto theend;
9372 /* Find the first autocommand for this event.
9373 * If there isn't any, return FALSE;
9374 * If there is one and no pattern given, return TRUE; */
9375 ap = first_autopat[(int)event];
9376 if (ap == NULL)
9377 goto theend;
9378 if (pattern == NULL)
9380 retval = TRUE;
9381 goto theend;
9384 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9385 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9386 if (STRICMP(pattern, "<buffer>") == 0)
9387 buflocal_buf = curbuf;
9389 /* Check if there is an autocommand with the given pattern. */
9390 for ( ; ap != NULL; ap = ap->next)
9391 /* only use a pattern when it has not been removed and has commands. */
9392 /* For buffer-local autocommands, fnamecmp() works fine. */
9393 if (ap->pat != NULL && ap->cmds != NULL
9394 && (group == AUGROUP_ALL || ap->group == group)
9395 && (buflocal_buf == NULL
9396 ? fnamecmp(ap->pat, pattern) == 0
9397 : ap->buflocal_nr == buflocal_buf->b_fnum))
9399 retval = TRUE;
9400 break;
9403 theend:
9404 vim_free(arg_save);
9405 return retval;
9408 #else /* FEAT_AUTOCMD */
9411 * Prepare for executing commands for (hidden) buffer "buf".
9412 * This is the non-autocommand version, it simply saves "curbuf" and sets
9413 * "curbuf" and "curwin" to match "buf".
9415 void
9416 aucmd_prepbuf(aco, buf)
9417 aco_save_T *aco; /* structure to save values in */
9418 buf_T *buf; /* new curbuf */
9420 aco->save_buf = curbuf;
9421 curbuf = buf;
9422 curwin->w_buffer = buf;
9426 * Restore after executing commands for a (hidden) buffer.
9427 * This is the non-autocommand version.
9429 void
9430 aucmd_restbuf(aco)
9431 aco_save_T *aco; /* structure holding saved values */
9433 curbuf = aco->save_buf;
9434 curwin->w_buffer = curbuf;
9437 #endif /* FEAT_AUTOCMD */
9440 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9442 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9443 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9444 * vim_regcomp() often.
9445 * Used for autocommands and 'wildignore'.
9446 * Returns TRUE if there is a match, FALSE otherwise.
9449 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9450 char_u *pattern; /* pattern to match with */
9451 regprog_T *prog; /* pre-compiled regprog or NULL */
9452 char_u *fname; /* full path of file name */
9453 char_u *sfname; /* short file name or NULL */
9454 char_u *tail; /* tail of path */
9455 int allow_dirs; /* allow matching with dir */
9457 regmatch_T regmatch;
9458 int result = FALSE;
9459 #ifdef FEAT_OSFILETYPE
9460 int no_pattern = FALSE; /* TRUE if check is filetype only */
9461 char_u *type_start;
9462 char_u c;
9463 int match = FALSE;
9464 #endif
9466 #ifdef CASE_INSENSITIVE_FILENAME
9467 regmatch.rm_ic = TRUE; /* Always ignore case */
9468 #else
9469 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9470 #endif
9471 #ifdef FEAT_OSFILETYPE
9472 if (*pattern == '<')
9474 /* There is a filetype condition specified with this pattern.
9475 * Check the filetype matches first. If not, don't bother with the
9476 * pattern (set regprog to NULL).
9477 * Always use magic for the regexp.
9480 for (type_start = pattern + 1; (c = *pattern); pattern++)
9482 if ((c == ';' || c == '>') && match == FALSE)
9484 *pattern = NUL; /* Terminate the string */
9485 match = mch_check_filetype(fname, type_start);
9486 *pattern = c; /* Restore the terminator */
9487 type_start = pattern + 1;
9489 if (c == '>')
9490 break;
9493 /* (c should never be NUL, but check anyway) */
9494 if (match == FALSE || c == NUL)
9495 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9496 else if (*pattern == NUL)
9498 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9499 no_pattern = TRUE; /* Always matches - don't check pat. */
9501 else
9502 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9504 else
9505 #endif
9507 if (prog != NULL)
9508 regmatch.regprog = prog;
9509 else
9510 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9514 * Try for a match with the pattern with:
9515 * 1. the full file name, when the pattern has a '/'.
9516 * 2. the short file name, when the pattern has a '/'.
9517 * 3. the tail of the file name, when the pattern has no '/'.
9519 if (
9520 #ifdef FEAT_OSFILETYPE
9521 /* If the check is for a filetype only and we don't care
9522 * about the path then skip all the regexp stuff.
9524 no_pattern ||
9525 #endif
9526 (regmatch.regprog != NULL
9527 && ((allow_dirs
9528 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9529 || (sfname != NULL
9530 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9531 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9532 result = TRUE;
9534 if (prog == NULL)
9535 vim_free(regmatch.regprog);
9536 return result;
9538 #endif
9540 #if defined(FEAT_WILDIGN) || defined(PROTO)
9542 * Return TRUE if a file matches with a pattern in "list".
9543 * "list" is a comma-separated list of patterns, like 'wildignore'.
9544 * "sfname" is the short file name or NULL, "ffname" the long file name.
9547 match_file_list(list, sfname, ffname)
9548 char_u *list;
9549 char_u *sfname;
9550 char_u *ffname;
9552 char_u buf[100];
9553 char_u *tail;
9554 char_u *regpat;
9555 char allow_dirs;
9556 int match;
9557 char_u *p;
9559 tail = gettail(sfname);
9561 /* try all patterns in 'wildignore' */
9562 p = list;
9563 while (*p)
9565 copy_option_part(&p, buf, 100, ",");
9566 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9567 if (regpat == NULL)
9568 break;
9569 match = match_file_pat(regpat, NULL, ffname, sfname,
9570 tail, (int)allow_dirs);
9571 vim_free(regpat);
9572 if (match)
9573 return TRUE;
9575 return FALSE;
9577 #endif
9580 * Convert the given pattern "pat" which has shell style wildcards in it, into
9581 * a regular expression, and return the result in allocated memory. If there
9582 * is a directory path separator to be matched, then TRUE is put in
9583 * allow_dirs, otherwise FALSE is put there -- webb.
9584 * Handle backslashes before special characters, like "\*" and "\ ".
9586 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9587 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9589 * Returns NULL when out of memory.
9591 /*ARGSUSED*/
9592 char_u *
9593 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9594 char_u *pat;
9595 char_u *pat_end; /* first char after pattern or NULL */
9596 char *allow_dirs; /* Result passed back out in here */
9597 int no_bslash; /* Don't use a backward slash as pathsep */
9599 int size;
9600 char_u *endp;
9601 char_u *reg_pat;
9602 char_u *p;
9603 int i;
9604 int nested = 0;
9605 int add_dollar = TRUE;
9606 #ifdef FEAT_OSFILETYPE
9607 int check_length = 0;
9608 #endif
9610 if (allow_dirs != NULL)
9611 *allow_dirs = FALSE;
9612 if (pat_end == NULL)
9613 pat_end = pat + STRLEN(pat);
9615 #ifdef FEAT_OSFILETYPE
9616 /* Find out how much of the string is the filetype check */
9617 if (*pat == '<')
9619 /* Count chars until the next '>' */
9620 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9622 if (p < pat_end)
9624 /* Pattern is of the form <.*>.* */
9625 check_length = p - pat + 1;
9626 if (p + 1 >= pat_end)
9628 /* The 'pattern' is a filetype check ONLY */
9629 reg_pat = (char_u *)alloc(check_length + 1);
9630 if (reg_pat != NULL)
9632 mch_memmove(reg_pat, pat, (size_t)check_length);
9633 reg_pat[check_length] = NUL;
9635 return reg_pat;
9638 /* else: there was no closing '>' - assume it was a normal pattern */
9641 pat += check_length;
9642 size = 2 + check_length;
9643 #else
9644 size = 2; /* '^' at start, '$' at end */
9645 #endif
9647 for (p = pat; p < pat_end; p++)
9649 switch (*p)
9651 case '*':
9652 case '.':
9653 case ',':
9654 case '{':
9655 case '}':
9656 case '~':
9657 size += 2; /* extra backslash */
9658 break;
9659 #ifdef BACKSLASH_IN_FILENAME
9660 case '\\':
9661 case '/':
9662 size += 4; /* could become "[\/]" */
9663 break;
9664 #endif
9665 default:
9666 size++;
9667 # ifdef FEAT_MBYTE
9668 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9670 ++p;
9671 ++size;
9673 # endif
9674 break;
9677 reg_pat = alloc(size + 1);
9678 if (reg_pat == NULL)
9679 return NULL;
9681 #ifdef FEAT_OSFILETYPE
9682 /* Copy the type check in to the start. */
9683 if (check_length)
9684 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9685 i = check_length;
9686 #else
9687 i = 0;
9688 #endif
9690 if (pat[0] == '*')
9691 while (pat[0] == '*' && pat < pat_end - 1)
9692 pat++;
9693 else
9694 reg_pat[i++] = '^';
9695 endp = pat_end - 1;
9696 if (*endp == '*')
9698 while (endp - pat > 0 && *endp == '*')
9699 endp--;
9700 add_dollar = FALSE;
9702 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9704 switch (*p)
9706 case '*':
9707 reg_pat[i++] = '.';
9708 reg_pat[i++] = '*';
9709 while (p[1] == '*') /* "**" matches like "*" */
9710 ++p;
9711 break;
9712 case '.':
9713 #ifdef RISCOS
9714 if (allow_dirs != NULL)
9715 *allow_dirs = TRUE;
9716 /* FALLTHROUGH */
9717 #endif
9718 case '~':
9719 reg_pat[i++] = '\\';
9720 reg_pat[i++] = *p;
9721 break;
9722 case '?':
9723 #ifdef RISCOS
9724 case '#':
9725 #endif
9726 reg_pat[i++] = '.';
9727 break;
9728 case '\\':
9729 if (p[1] == NUL)
9730 break;
9731 #ifdef BACKSLASH_IN_FILENAME
9732 if (!no_bslash)
9734 /* translate:
9735 * "\x" to "\\x" e.g., "dir\file"
9736 * "\*" to "\\.*" e.g., "dir\*.c"
9737 * "\?" to "\\." e.g., "dir\??.c"
9738 * "\+" to "\+" e.g., "fileX\+.c"
9740 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9741 && p[1] != '+')
9743 reg_pat[i++] = '[';
9744 reg_pat[i++] = '\\';
9745 reg_pat[i++] = '/';
9746 reg_pat[i++] = ']';
9747 if (allow_dirs != NULL)
9748 *allow_dirs = TRUE;
9749 break;
9752 #endif
9753 if (*++p == '?'
9754 #ifdef BACKSLASH_IN_FILENAME
9755 && no_bslash
9756 #endif
9758 reg_pat[i++] = '?';
9759 else
9760 if (*p == ',')
9761 reg_pat[i++] = ',';
9762 else
9764 if (allow_dirs != NULL && vim_ispathsep(*p)
9765 #ifdef BACKSLASH_IN_FILENAME
9766 && (!no_bslash || *p != '\\')
9767 #endif
9769 *allow_dirs = TRUE;
9770 reg_pat[i++] = '\\';
9771 reg_pat[i++] = *p;
9773 break;
9774 #ifdef BACKSLASH_IN_FILENAME
9775 case '/':
9776 reg_pat[i++] = '[';
9777 reg_pat[i++] = '\\';
9778 reg_pat[i++] = '/';
9779 reg_pat[i++] = ']';
9780 if (allow_dirs != NULL)
9781 *allow_dirs = TRUE;
9782 break;
9783 #endif
9784 case '{':
9785 reg_pat[i++] = '\\';
9786 reg_pat[i++] = '(';
9787 nested++;
9788 break;
9789 case '}':
9790 reg_pat[i++] = '\\';
9791 reg_pat[i++] = ')';
9792 --nested;
9793 break;
9794 case ',':
9795 if (nested)
9797 reg_pat[i++] = '\\';
9798 reg_pat[i++] = '|';
9800 else
9801 reg_pat[i++] = ',';
9802 break;
9803 default:
9804 # ifdef FEAT_MBYTE
9805 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9806 reg_pat[i++] = *p++;
9807 else
9808 # endif
9809 if (allow_dirs != NULL && vim_ispathsep(*p))
9810 *allow_dirs = TRUE;
9811 reg_pat[i++] = *p;
9812 break;
9815 if (add_dollar)
9816 reg_pat[i++] = '$';
9817 reg_pat[i] = NUL;
9818 if (nested != 0)
9820 if (nested < 0)
9821 EMSG(_("E219: Missing {."));
9822 else
9823 EMSG(_("E220: Missing }."));
9824 vim_free(reg_pat);
9825 reg_pat = NULL;
9827 return reg_pat;