Merged from the latest developing branch.
[MacVim.git] / src / fileio.c
blob61c21480a423c9889e83e94cf1dc507d5c8a9d05
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 != NULL
714 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
715 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
716 #endif
719 #if defined(HAS_SWAP_EXISTS_ACTION)
720 /* If "Quit" selected at ATTENTION dialog, don't load the file */
721 if (swap_exists_action == SEA_QUIT)
723 if (!read_buffer && !read_stdin)
724 close(fd);
725 return FAIL;
727 #endif
729 ++no_wait_return; /* don't wait for return yet */
732 * Set '[ mark to the line above where the lines go (line 1 if zero).
734 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
735 curbuf->b_op_start.col = 0;
737 #ifdef FEAT_AUTOCMD
738 if (!read_buffer)
740 int m = msg_scroll;
741 int n = msg_scrolled;
744 * The file must be closed again, the autocommands may want to change
745 * the file before reading it.
747 if (!read_stdin)
748 close(fd); /* ignore errors */
751 * The output from the autocommands should not overwrite anything and
752 * should not be overwritten: Set msg_scroll, restore its value if no
753 * output was done.
755 msg_scroll = TRUE;
756 if (filtering)
757 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
758 FALSE, curbuf, eap);
759 else if (read_stdin)
760 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
761 FALSE, curbuf, eap);
762 else if (newfile)
763 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
764 FALSE, curbuf, eap);
765 else
766 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
767 FALSE, NULL, eap);
768 if (msg_scrolled == n)
769 msg_scroll = m;
771 #ifdef FEAT_EVAL
772 if (aborting()) /* autocmds may abort script processing */
774 --no_wait_return;
775 msg_scroll = msg_save;
776 curbuf->b_p_ro = TRUE; /* must use "w!" now */
777 return FAIL;
779 #endif
781 * Don't allow the autocommands to change the current buffer.
782 * Try to re-open the file.
784 * Don't allow the autocommands to change the buffer name either
785 * (cd for example) if it invalidates fname or sfname.
787 if (!read_stdin && (curbuf != old_curbuf
788 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
789 || (using_b_fname && (old_b_fname != curbuf->b_fname))
790 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
792 --no_wait_return;
793 msg_scroll = msg_save;
794 if (fd < 0)
795 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
796 else
797 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
798 curbuf->b_p_ro = TRUE; /* must use "w!" now */
799 return FAIL;
802 #endif /* FEAT_AUTOCMD */
804 /* Autocommands may add lines to the file, need to check if it is empty */
805 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
807 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
810 * Show the user that we are busy reading the input. Sometimes this
811 * may take a while. When reading from stdin another program may
812 * still be running, don't move the cursor to the last line, unless
813 * always using the GUI.
815 if (read_stdin)
817 #ifndef ALWAYS_USE_GUI
818 mch_msg(_("Vim: Reading from stdin...\n"));
819 #endif
820 #ifdef FEAT_GUI
821 /* Also write a message in the GUI window, if there is one. */
822 if (gui.in_use && !gui.dying && !gui.starting)
824 p = (char_u *)_("Reading from stdin...");
825 gui_write(p, (int)STRLEN(p));
827 #endif
829 else if (!read_buffer)
830 filemess(curbuf, sfname, (char_u *)"", 0);
833 msg_scroll = FALSE; /* overwrite the file message */
836 * Set linecnt now, before the "retry" caused by a wrong guess for
837 * fileformat, and after the autocommands, which may change them.
839 linecnt = curbuf->b_ml.ml_line_count;
841 #ifdef FEAT_MBYTE
842 /* "++bad=" argument. */
843 if (eap != NULL && eap->bad_char != 0)
845 bad_char_behavior = eap->bad_char;
846 if (set_options)
847 curbuf->b_bad_char = eap->bad_char;
849 else
850 curbuf->b_bad_char = 0;
853 * Decide which 'encoding' to use or use first.
855 if (eap != NULL && eap->force_enc != 0)
857 fenc = enc_canonize(eap->cmd + eap->force_enc);
858 fenc_alloced = TRUE;
859 keep_dest_enc = TRUE;
861 else if (curbuf->b_p_bin)
863 fenc = (char_u *)""; /* binary: don't convert */
864 fenc_alloced = FALSE;
866 else if (curbuf->b_help)
868 char_u firstline[80];
869 int fc;
871 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
872 * fails it must be latin1.
873 * Always do this when 'encoding' is "utf-8". Otherwise only do
874 * this when needed to avoid [converted] remarks all the time.
875 * It is needed when the first line contains non-ASCII characters.
876 * That is only in *.??x files. */
877 fenc = (char_u *)"latin1";
878 c = enc_utf8;
879 if (!c && !read_stdin)
881 fc = fname[STRLEN(fname) - 1];
882 if (TOLOWER_ASC(fc) == 'x')
884 /* Read the first line (and a bit more). Immediately rewind to
885 * the start of the file. If the read() fails "len" is -1. */
886 len = vim_read(fd, firstline, 80);
887 lseek(fd, (off_t)0L, SEEK_SET);
888 for (p = firstline; p < firstline + len; ++p)
889 if (*p >= 0x80)
891 c = TRUE;
892 break;
897 if (c)
899 fenc_next = fenc;
900 fenc = (char_u *)"utf-8";
902 /* When the file is utf-8 but a character doesn't fit in
903 * 'encoding' don't retry. In help text editing utf-8 bytes
904 * doesn't make sense. */
905 if (!enc_utf8)
906 keep_dest_enc = TRUE;
908 fenc_alloced = FALSE;
910 else if (*p_fencs == NUL)
912 fenc = curbuf->b_p_fenc; /* use format from buffer */
913 fenc_alloced = FALSE;
915 else
917 fenc_next = p_fencs; /* try items in 'fileencodings' */
918 fenc = next_fenc(&fenc_next);
919 fenc_alloced = TRUE;
921 #endif
924 * Jump back here to retry reading the file in different ways.
925 * Reasons to retry:
926 * - encoding conversion failed: try another one from "fenc_next"
927 * - BOM detected and fenc was set, need to setup conversion
928 * - "fileformat" check failed: try another
930 * Variables set for special retry actions:
931 * "file_rewind" Rewind the file to start reading it again.
932 * "advance_fenc" Advance "fenc" using "fenc_next".
933 * "skip_read" Re-use already read bytes (BOM detected).
934 * "did_iconv" iconv() conversion failed, try 'charconvert'.
935 * "keep_fileformat" Don't reset "fileformat".
937 * Other status indicators:
938 * "tmpname" When != NULL did conversion with 'charconvert'.
939 * Output file has to be deleted afterwards.
940 * "iconv_fd" When != -1 did conversion with iconv().
942 retry:
944 if (file_rewind)
946 if (read_buffer)
948 read_buf_lnum = 1;
949 read_buf_col = 0;
951 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
953 /* Can't rewind the file, give up. */
954 error = TRUE;
955 goto failed;
957 /* Delete the previously read lines. */
958 while (lnum > from)
959 ml_delete(lnum--, FALSE);
960 file_rewind = FALSE;
961 #ifdef FEAT_MBYTE
962 if (set_options)
964 curbuf->b_p_bomb = FALSE;
965 curbuf->b_start_bomb = FALSE;
967 conv_error = 0;
968 #endif
972 * When retrying with another "fenc" and the first time "fileformat"
973 * will be reset.
975 if (keep_fileformat)
976 keep_fileformat = FALSE;
977 else
979 if (eap != NULL && eap->force_ff != 0)
981 fileformat = get_fileformat_force(curbuf, eap);
982 try_unix = try_dos = try_mac = FALSE;
984 else if (curbuf->b_p_bin)
985 fileformat = EOL_UNIX; /* binary: use Unix format */
986 else if (*p_ffs == NUL)
987 fileformat = get_fileformat(curbuf);/* use format from buffer */
988 else
989 fileformat = EOL_UNKNOWN; /* detect from file */
992 #ifdef FEAT_MBYTE
993 # ifdef USE_ICONV
994 if (iconv_fd != (iconv_t)-1)
996 /* aborted conversion with iconv(), close the descriptor */
997 iconv_close(iconv_fd);
998 iconv_fd = (iconv_t)-1;
1000 # endif
1002 if (advance_fenc)
1005 * Try the next entry in 'fileencodings'.
1007 advance_fenc = FALSE;
1009 if (eap != NULL && eap->force_enc != 0)
1011 /* Conversion given with "++cc=" wasn't possible, read
1012 * without conversion. */
1013 notconverted = TRUE;
1014 conv_error = 0;
1015 if (fenc_alloced)
1016 vim_free(fenc);
1017 fenc = (char_u *)"";
1018 fenc_alloced = FALSE;
1020 else
1022 if (fenc_alloced)
1023 vim_free(fenc);
1024 if (fenc_next != NULL)
1026 fenc = next_fenc(&fenc_next);
1027 fenc_alloced = (fenc_next != NULL);
1029 else
1031 fenc = (char_u *)"";
1032 fenc_alloced = FALSE;
1035 if (tmpname != NULL)
1037 mch_remove(tmpname); /* delete converted file */
1038 vim_free(tmpname);
1039 tmpname = NULL;
1044 * Conversion is required when the encoding of the file is different
1045 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
1046 * conversion to UTF-8).
1048 fio_flags = 0;
1049 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
1050 if (converted || enc_unicode != 0)
1053 /* "ucs-bom" means we need to check the first bytes of the file
1054 * for a BOM. */
1055 if (STRCMP(fenc, ENC_UCSBOM) == 0)
1056 fio_flags = FIO_UCSBOM;
1059 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1060 * done. This is handled below after read(). Prepare the
1061 * fio_flags to avoid having to parse the string each time.
1062 * Also check for Unicode to Latin1 conversion, because iconv()
1063 * appears not to handle this correctly. This works just like
1064 * conversion to UTF-8 except how the resulting character is put in
1065 * the buffer.
1067 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1068 fio_flags = get_fio_flags(fenc);
1070 # ifdef WIN3264
1072 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1073 * is handled with MultiByteToWideChar().
1075 if (fio_flags == 0)
1076 fio_flags = get_win_fio_flags(fenc);
1077 # endif
1079 # ifdef MACOS_X
1080 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1081 if (fio_flags == 0)
1082 fio_flags = get_mac_fio_flags(fenc);
1083 # endif
1085 # ifdef USE_ICONV
1087 * Try using iconv() if we can't convert internally.
1089 if (fio_flags == 0
1090 # ifdef FEAT_EVAL
1091 && !did_iconv
1092 # endif
1094 iconv_fd = (iconv_t)my_iconv_open(
1095 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1096 # endif
1098 # ifdef FEAT_EVAL
1100 * Use the 'charconvert' expression when conversion is required
1101 * and we can't do it internally or with iconv().
1103 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1104 # ifdef USE_ICONV
1105 && iconv_fd == (iconv_t)-1
1106 # endif
1109 # ifdef USE_ICONV
1110 did_iconv = FALSE;
1111 # endif
1112 /* Skip conversion when it's already done (retry for wrong
1113 * "fileformat"). */
1114 if (tmpname == NULL)
1116 tmpname = readfile_charconvert(fname, fenc, &fd);
1117 if (tmpname == NULL)
1119 /* Conversion failed. Try another one. */
1120 advance_fenc = TRUE;
1121 if (fd < 0)
1123 /* Re-opening the original file failed! */
1124 EMSG(_("E202: Conversion made file unreadable!"));
1125 error = TRUE;
1126 goto failed;
1128 goto retry;
1132 else
1133 # endif
1135 if (fio_flags == 0
1136 # ifdef USE_ICONV
1137 && iconv_fd == (iconv_t)-1
1138 # endif
1141 /* Conversion wanted but we can't.
1142 * Try the next conversion in 'fileencodings' */
1143 advance_fenc = TRUE;
1144 goto retry;
1149 /* Set "can_retry" when it's possible to rewind the file and try with
1150 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1151 * stdin or fixed at a specific encoding. */
1152 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1153 #endif
1155 if (!skip_read)
1157 linerest = 0;
1158 filesize = 0;
1159 skip_count = lines_to_skip;
1160 read_count = lines_to_read;
1161 #ifdef FEAT_MBYTE
1162 conv_restlen = 0;
1163 #endif
1166 while (!error && !got_int)
1169 * We allocate as much space for the file as we can get, plus
1170 * space for the old line plus room for one terminating NUL.
1171 * The amount is limited by the fact that read() only can read
1172 * upto max_unsigned characters (and other things).
1174 #if SIZEOF_INT <= 2
1175 if (linerest >= 0x7ff0)
1177 ++split;
1178 *ptr = NL; /* split line by inserting a NL */
1179 size = 1;
1181 else
1182 #endif
1184 if (!skip_read)
1186 #if SIZEOF_INT > 2
1187 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1188 size = SSIZE_MAX; /* use max I/O size, 52K */
1189 # else
1190 size = 0x10000L; /* use buffer >= 64K */
1191 # endif
1192 #else
1193 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1194 #endif
1196 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1198 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1199 FALSE)) != NULL)
1200 break;
1202 if (new_buffer == NULL)
1204 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1205 error = TRUE;
1206 break;
1208 if (linerest) /* copy characters from the previous buffer */
1209 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1210 vim_free(buffer);
1211 buffer = new_buffer;
1212 ptr = buffer + linerest;
1213 line_start = buffer;
1215 #ifdef FEAT_MBYTE
1216 /* May need room to translate into.
1217 * For iconv() we don't really know the required space, use a
1218 * factor ICONV_MULT.
1219 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1220 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1221 * become up to 4 bytes, size must be multiple of 2
1222 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1223 * multiple of 2
1224 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1225 * multiple of 4 */
1226 real_size = (int)size;
1227 # ifdef USE_ICONV
1228 if (iconv_fd != (iconv_t)-1)
1229 size = size / ICONV_MULT;
1230 else
1231 # endif
1232 if (fio_flags & FIO_LATIN1)
1233 size = size / 2;
1234 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1235 size = (size * 2 / 3) & ~1;
1236 else if (fio_flags & FIO_UCS4)
1237 size = (size * 2 / 3) & ~3;
1238 else if (fio_flags == FIO_UCSBOM)
1239 size = size / ICONV_MULT; /* worst case */
1240 # ifdef WIN3264
1241 else if (fio_flags & FIO_CODEPAGE)
1242 size = size / ICONV_MULT; /* also worst case */
1243 # endif
1244 # ifdef MACOS_X
1245 else if (fio_flags & FIO_MACROMAN)
1246 size = size / ICONV_MULT; /* also worst case */
1247 # endif
1248 #endif
1250 #ifdef FEAT_MBYTE
1251 if (conv_restlen > 0)
1253 /* Insert unconverted bytes from previous line. */
1254 mch_memmove(ptr, conv_rest, conv_restlen);
1255 ptr += conv_restlen;
1256 size -= conv_restlen;
1258 #endif
1260 if (read_buffer)
1263 * Read bytes from curbuf. Used for converting text read
1264 * from stdin.
1266 if (read_buf_lnum > from)
1267 size = 0;
1268 else
1270 int n, ni;
1271 long tlen;
1273 tlen = 0;
1274 for (;;)
1276 p = ml_get(read_buf_lnum) + read_buf_col;
1277 n = (int)STRLEN(p);
1278 if ((int)tlen + n + 1 > size)
1280 /* Filled up to "size", append partial line.
1281 * Change NL to NUL to reverse the effect done
1282 * below. */
1283 n = (int)(size - tlen);
1284 for (ni = 0; ni < n; ++ni)
1286 if (p[ni] == NL)
1287 ptr[tlen++] = NUL;
1288 else
1289 ptr[tlen++] = p[ni];
1291 read_buf_col += n;
1292 break;
1294 else
1296 /* Append whole line and new-line. Change NL
1297 * to NUL to reverse the effect done below. */
1298 for (ni = 0; ni < n; ++ni)
1300 if (p[ni] == NL)
1301 ptr[tlen++] = NUL;
1302 else
1303 ptr[tlen++] = p[ni];
1305 ptr[tlen++] = NL;
1306 read_buf_col = 0;
1307 if (++read_buf_lnum > from)
1309 /* When the last line didn't have an
1310 * end-of-line don't add it now either. */
1311 if (!curbuf->b_p_eol)
1312 --tlen;
1313 size = tlen;
1314 break;
1320 else
1323 * Read bytes from the file.
1325 size = vim_read(fd, ptr, size);
1328 if (size <= 0)
1330 if (size < 0) /* read error */
1331 error = TRUE;
1332 #ifdef FEAT_MBYTE
1333 else if (conv_restlen > 0)
1336 * Reached end-of-file but some trailing bytes could
1337 * not be converted. Truncated file?
1340 /* When we did a conversion report an error. */
1341 if (fio_flags != 0
1342 # ifdef USE_ICONV
1343 || iconv_fd != (iconv_t)-1
1344 # endif
1347 if (conv_error == 0)
1348 conv_error = curbuf->b_ml.ml_line_count
1349 - linecnt + 1;
1351 /* Remember the first linenr with an illegal byte */
1352 else if (illegal_byte == 0)
1353 illegal_byte = curbuf->b_ml.ml_line_count
1354 - linecnt + 1;
1355 if (bad_char_behavior == BAD_DROP)
1357 *(ptr - conv_restlen) = NUL;
1358 conv_restlen = 0;
1360 else
1362 /* Replace the trailing bytes with the replacement
1363 * character if we were converting; if we weren't,
1364 * leave the UTF8 checking code to do it, as it
1365 * works slightly differently. */
1366 if (bad_char_behavior != BAD_KEEP && (fio_flags != 0
1367 # ifdef USE_ICONV
1368 || iconv_fd != (iconv_t)-1
1369 # endif
1372 while (conv_restlen > 0)
1374 *(--ptr) = bad_char_behavior;
1375 --conv_restlen;
1378 fio_flags = 0; /* don't convert this */
1379 # ifdef USE_ICONV
1380 if (iconv_fd != (iconv_t)-1)
1382 iconv_close(iconv_fd);
1383 iconv_fd = (iconv_t)-1;
1385 # endif
1388 #endif
1391 #ifdef FEAT_CRYPT
1393 * At start of file: Check for magic number of encryption.
1395 if (filesize == 0)
1396 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1397 &filesize, newfile);
1399 * Decrypt the read bytes.
1401 if (cryptkey != NULL && size > 0)
1402 for (p = ptr; p < ptr + size; ++p)
1403 ZDECODE(*p);
1404 #endif
1406 skip_read = FALSE;
1408 #ifdef FEAT_MBYTE
1410 * At start of file (or after crypt magic number): Check for BOM.
1411 * Also check for a BOM for other Unicode encodings, but not after
1412 * converting with 'charconvert' or when a BOM has already been
1413 * found.
1415 if ((filesize == 0
1416 # ifdef FEAT_CRYPT
1417 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1418 # endif
1420 && (fio_flags == FIO_UCSBOM
1421 || (!curbuf->b_p_bomb
1422 && tmpname == NULL
1423 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1425 char_u *ccname;
1426 int blen;
1428 /* no BOM detection in a short file or in binary mode */
1429 if (size < 2 || curbuf->b_p_bin)
1430 ccname = NULL;
1431 else
1432 ccname = check_for_bom(ptr, size, &blen,
1433 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1434 if (ccname != NULL)
1436 /* Remove BOM from the text */
1437 filesize += blen;
1438 size -= blen;
1439 mch_memmove(ptr, ptr + blen, (size_t)size);
1440 if (set_options)
1442 curbuf->b_p_bomb = TRUE;
1443 curbuf->b_start_bomb = TRUE;
1447 if (fio_flags == FIO_UCSBOM)
1449 if (ccname == NULL)
1451 /* No BOM detected: retry with next encoding. */
1452 advance_fenc = TRUE;
1454 else
1456 /* BOM detected: set "fenc" and jump back */
1457 if (fenc_alloced)
1458 vim_free(fenc);
1459 fenc = ccname;
1460 fenc_alloced = FALSE;
1462 /* retry reading without getting new bytes or rewinding */
1463 skip_read = TRUE;
1464 goto retry;
1468 /* Include not converted bytes. */
1469 ptr -= conv_restlen;
1470 size += conv_restlen;
1471 conv_restlen = 0;
1472 #endif
1474 * Break here for a read error or end-of-file.
1476 if (size <= 0)
1477 break;
1479 #ifdef FEAT_MBYTE
1481 # ifdef USE_ICONV
1482 if (iconv_fd != (iconv_t)-1)
1485 * Attempt conversion of the read bytes to 'encoding' using
1486 * iconv().
1488 const char *fromp;
1489 char *top;
1490 size_t from_size;
1491 size_t to_size;
1493 fromp = (char *)ptr;
1494 from_size = size;
1495 ptr += size;
1496 top = (char *)ptr;
1497 to_size = real_size - size;
1500 * If there is conversion error or not enough room try using
1501 * another conversion. Except for when there is no
1502 * alternative (help files).
1504 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1505 &top, &to_size)
1506 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1507 || from_size > CONV_RESTLEN)
1509 if (can_retry)
1510 goto rewind_retry;
1511 if (conv_error == 0)
1512 conv_error = readfile_linenr(linecnt,
1513 ptr, (char_u *)top);
1515 /* Deal with a bad byte and continue with the next. */
1516 ++fromp;
1517 --from_size;
1518 if (bad_char_behavior == BAD_KEEP)
1520 *top++ = *(fromp - 1);
1521 --to_size;
1523 else if (bad_char_behavior != BAD_DROP)
1525 *top++ = bad_char_behavior;
1526 --to_size;
1530 if (from_size > 0)
1532 /* Some remaining characters, keep them for the next
1533 * round. */
1534 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1535 conv_restlen = (int)from_size;
1538 /* move the linerest to before the converted characters */
1539 line_start = ptr - linerest;
1540 mch_memmove(line_start, buffer, (size_t)linerest);
1541 size = (long)((char_u *)top - ptr);
1543 # endif
1545 # ifdef WIN3264
1546 if (fio_flags & FIO_CODEPAGE)
1548 char_u *src, *dst;
1549 WCHAR ucs2buf[3];
1550 int ucs2len;
1551 int codepage = FIO_GET_CP(fio_flags);
1552 int bytelen;
1553 int found_bad;
1554 char replstr[2];
1557 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1558 * a codepage, using standard MS-Windows functions. This
1559 * requires two steps:
1560 * 1. convert from 'fileencoding' to ucs-2
1561 * 2. convert from ucs-2 to 'encoding'
1563 * Because there may be illegal bytes AND an incomplete byte
1564 * sequence at the end, we may have to do the conversion one
1565 * character at a time to get it right.
1568 /* Replacement string for WideCharToMultiByte(). */
1569 if (bad_char_behavior > 0)
1570 replstr[0] = bad_char_behavior;
1571 else
1572 replstr[0] = '?';
1573 replstr[1] = NUL;
1576 * Move the bytes to the end of the buffer, so that we have
1577 * room to put the result at the start.
1579 src = ptr + real_size - size;
1580 mch_memmove(src, ptr, size);
1583 * Do the conversion.
1585 dst = ptr;
1586 size = size;
1587 while (size > 0)
1589 found_bad = FALSE;
1591 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1592 if (codepage == CP_UTF8)
1594 /* Handle CP_UTF8 input ourselves to be able to handle
1595 * trailing bytes properly.
1596 * Get one UTF-8 character from src. */
1597 bytelen = (int)utf_ptr2len_len(src, size);
1598 if (bytelen > size)
1600 /* Only got some bytes of a character. Normally
1601 * it's put in "conv_rest", but if it's too long
1602 * deal with it as if they were illegal bytes. */
1603 if (bytelen <= CONV_RESTLEN)
1604 break;
1606 /* weird overlong byte sequence */
1607 bytelen = size;
1608 found_bad = TRUE;
1610 else
1612 int u8c = utf_ptr2char(src);
1614 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1615 found_bad = TRUE;
1616 ucs2buf[0] = u8c;
1617 ucs2len = 1;
1620 else
1621 # endif
1623 /* We don't know how long the byte sequence is, try
1624 * from one to three bytes. */
1625 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1626 ++bytelen)
1628 ucs2len = MultiByteToWideChar(codepage,
1629 MB_ERR_INVALID_CHARS,
1630 (LPCSTR)src, bytelen,
1631 ucs2buf, 3);
1632 if (ucs2len > 0)
1633 break;
1635 if (ucs2len == 0)
1637 /* If we have only one byte then it's probably an
1638 * incomplete byte sequence. Otherwise discard
1639 * one byte as a bad character. */
1640 if (size == 1)
1641 break;
1642 found_bad = TRUE;
1643 bytelen = 1;
1647 if (!found_bad)
1649 int i;
1651 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1652 if (enc_utf8)
1654 /* From UCS-2 to UTF-8. Cannot fail. */
1655 for (i = 0; i < ucs2len; ++i)
1656 dst += utf_char2bytes(ucs2buf[i], dst);
1658 else
1660 BOOL bad = FALSE;
1661 int dstlen;
1663 /* From UCS-2 to "enc_codepage". If the
1664 * conversion uses the default character "?",
1665 * the data doesn't fit in this encoding. */
1666 dstlen = WideCharToMultiByte(enc_codepage, 0,
1667 (LPCWSTR)ucs2buf, ucs2len,
1668 (LPSTR)dst, (int)(src - dst),
1669 replstr, &bad);
1670 if (bad)
1671 found_bad = TRUE;
1672 else
1673 dst += dstlen;
1677 if (found_bad)
1679 /* Deal with bytes we can't convert. */
1680 if (can_retry)
1681 goto rewind_retry;
1682 if (conv_error == 0)
1683 conv_error = readfile_linenr(linecnt, ptr, dst);
1684 if (bad_char_behavior != BAD_DROP)
1686 if (bad_char_behavior == BAD_KEEP)
1688 mch_memmove(dst, src, bytelen);
1689 dst += bytelen;
1691 else
1692 *dst++ = bad_char_behavior;
1696 src += bytelen;
1697 size -= bytelen;
1700 if (size > 0)
1702 /* An incomplete byte sequence remaining. */
1703 mch_memmove(conv_rest, src, size);
1704 conv_restlen = size;
1707 /* The new size is equal to how much "dst" was advanced. */
1708 size = (long)(dst - ptr);
1710 else
1711 # endif
1712 # ifdef MACOS_CONVERT
1713 if (fio_flags & FIO_MACROMAN)
1716 * Conversion from Apple MacRoman char encoding to UTF-8 or
1717 * latin1. This is in os_mac_conv.c.
1719 if (macroman2enc(ptr, &size, real_size) == FAIL)
1720 goto rewind_retry;
1722 else
1723 # endif
1724 if (fio_flags != 0)
1726 int u8c;
1727 char_u *dest;
1728 char_u *tail = NULL;
1731 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1732 * "enc_utf8" not set: Convert Unicode to Latin1.
1733 * Go from end to start through the buffer, because the number
1734 * of bytes may increase.
1735 * "dest" points to after where the UTF-8 bytes go, "p" points
1736 * to after the next character to convert.
1738 dest = ptr + real_size;
1739 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1741 p = ptr + size;
1742 if (fio_flags == FIO_UTF8)
1744 /* Check for a trailing incomplete UTF-8 sequence */
1745 tail = ptr + size - 1;
1746 while (tail > ptr && (*tail & 0xc0) == 0x80)
1747 --tail;
1748 if (tail + utf_byte2len(*tail) <= ptr + size)
1749 tail = NULL;
1750 else
1751 p = tail;
1754 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1756 /* Check for a trailing byte */
1757 p = ptr + (size & ~1);
1758 if (size & 1)
1759 tail = p;
1760 if ((fio_flags & FIO_UTF16) && p > ptr)
1762 /* Check for a trailing leading word */
1763 if (fio_flags & FIO_ENDIAN_L)
1765 u8c = (*--p << 8);
1766 u8c += *--p;
1768 else
1770 u8c = *--p;
1771 u8c += (*--p << 8);
1773 if (u8c >= 0xd800 && u8c <= 0xdbff)
1774 tail = p;
1775 else
1776 p += 2;
1779 else /* FIO_UCS4 */
1781 /* Check for trailing 1, 2 or 3 bytes */
1782 p = ptr + (size & ~3);
1783 if (size & 3)
1784 tail = p;
1787 /* If there is a trailing incomplete sequence move it to
1788 * conv_rest[]. */
1789 if (tail != NULL)
1791 conv_restlen = (int)((ptr + size) - tail);
1792 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1793 size -= conv_restlen;
1797 while (p > ptr)
1799 if (fio_flags & FIO_LATIN1)
1800 u8c = *--p;
1801 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1803 if (fio_flags & FIO_ENDIAN_L)
1805 u8c = (*--p << 8);
1806 u8c += *--p;
1808 else
1810 u8c = *--p;
1811 u8c += (*--p << 8);
1813 if ((fio_flags & FIO_UTF16)
1814 && u8c >= 0xdc00 && u8c <= 0xdfff)
1816 int u16c;
1818 if (p == ptr)
1820 /* Missing leading word. */
1821 if (can_retry)
1822 goto rewind_retry;
1823 if (conv_error == 0)
1824 conv_error = readfile_linenr(linecnt,
1825 ptr, p);
1826 if (bad_char_behavior == BAD_DROP)
1827 continue;
1828 if (bad_char_behavior != BAD_KEEP)
1829 u8c = bad_char_behavior;
1832 /* found second word of double-word, get the first
1833 * word and compute the resulting character */
1834 if (fio_flags & FIO_ENDIAN_L)
1836 u16c = (*--p << 8);
1837 u16c += *--p;
1839 else
1841 u16c = *--p;
1842 u16c += (*--p << 8);
1844 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1845 + (u8c & 0x3ff);
1847 /* Check if the word is indeed a leading word. */
1848 if (u16c < 0xd800 || u16c > 0xdbff)
1850 if (can_retry)
1851 goto rewind_retry;
1852 if (conv_error == 0)
1853 conv_error = readfile_linenr(linecnt,
1854 ptr, p);
1855 if (bad_char_behavior == BAD_DROP)
1856 continue;
1857 if (bad_char_behavior != BAD_KEEP)
1858 u8c = bad_char_behavior;
1862 else if (fio_flags & FIO_UCS4)
1864 if (fio_flags & FIO_ENDIAN_L)
1866 u8c = (*--p << 24);
1867 u8c += (*--p << 16);
1868 u8c += (*--p << 8);
1869 u8c += *--p;
1871 else /* big endian */
1873 u8c = *--p;
1874 u8c += (*--p << 8);
1875 u8c += (*--p << 16);
1876 u8c += (*--p << 24);
1879 else /* UTF-8 */
1881 if (*--p < 0x80)
1882 u8c = *p;
1883 else
1885 len = utf_head_off(ptr, p);
1886 p -= len;
1887 u8c = utf_ptr2char(p);
1888 if (len == 0)
1890 /* Not a valid UTF-8 character, retry with
1891 * another fenc when possible, otherwise just
1892 * report the error. */
1893 if (can_retry)
1894 goto rewind_retry;
1895 if (conv_error == 0)
1896 conv_error = readfile_linenr(linecnt,
1897 ptr, p);
1898 if (bad_char_behavior == BAD_DROP)
1899 continue;
1900 if (bad_char_behavior != BAD_KEEP)
1901 u8c = bad_char_behavior;
1905 if (enc_utf8) /* produce UTF-8 */
1907 dest -= utf_char2len(u8c);
1908 (void)utf_char2bytes(u8c, dest);
1910 else /* produce Latin1 */
1912 --dest;
1913 if (u8c >= 0x100)
1915 /* character doesn't fit in latin1, retry with
1916 * another fenc when possible, otherwise just
1917 * report the error. */
1918 if (can_retry)
1919 goto rewind_retry;
1920 if (conv_error == 0)
1921 conv_error = readfile_linenr(linecnt, ptr, p);
1922 if (bad_char_behavior == BAD_DROP)
1923 ++dest;
1924 else if (bad_char_behavior == BAD_KEEP)
1925 *dest = u8c;
1926 else if (eap != NULL && eap->bad_char != 0)
1927 *dest = bad_char_behavior;
1928 else
1929 *dest = 0xBF;
1931 else
1932 *dest = u8c;
1936 /* move the linerest to before the converted characters */
1937 line_start = dest - linerest;
1938 mch_memmove(line_start, buffer, (size_t)linerest);
1939 size = (long)((ptr + real_size) - dest);
1940 ptr = dest;
1942 else if (enc_utf8 && !curbuf->b_p_bin)
1944 int incomplete_tail = FALSE;
1946 /* Reading UTF-8: Check if the bytes are valid UTF-8. */
1947 for (p = ptr; ; ++p)
1949 int todo = (int)((ptr + size) - p);
1950 int l;
1952 if (todo <= 0)
1953 break;
1954 if (*p >= 0x80)
1956 /* A length of 1 means it's an illegal byte. Accept
1957 * an incomplete character at the end though, the next
1958 * read() will get the next bytes, we'll check it
1959 * then. */
1960 l = utf_ptr2len_len(p, todo);
1961 if (l > todo && !incomplete_tail)
1963 /* Avoid retrying with a different encoding when
1964 * a truncated file is more likely, or attempting
1965 * to read the rest of an incomplete sequence when
1966 * we have already done so. */
1967 if (p > ptr || filesize > 0)
1968 incomplete_tail = TRUE;
1969 /* Incomplete byte sequence, move it to conv_rest[]
1970 * and try to read the rest of it, unless we've
1971 * already done so. */
1972 if (p > ptr)
1974 conv_restlen = todo;
1975 mch_memmove(conv_rest, p, conv_restlen);
1976 size -= conv_restlen;
1977 break;
1980 if (l == 1 || l > todo)
1982 /* Illegal byte. If we can try another encoding
1983 * do that, unless at EOF where a truncated
1984 * file is more likely than a conversion error. */
1985 if (can_retry && !incomplete_tail)
1986 break;
1987 # ifdef USE_ICONV
1988 /* When we did a conversion report an error. */
1989 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1990 conv_error = readfile_linenr(linecnt, ptr, p);
1991 # endif
1992 /* Remember the first linenr with an illegal byte */
1993 if (conv_error == 0 && illegal_byte == 0)
1994 illegal_byte = readfile_linenr(linecnt, ptr, p);
1996 /* Drop, keep or replace the bad byte. */
1997 if (bad_char_behavior == BAD_DROP)
1999 mch_memmove(p, p + 1, todo - 1);
2000 --p;
2001 --size;
2003 else if (bad_char_behavior != BAD_KEEP)
2004 *p = bad_char_behavior;
2006 else
2007 p += l - 1;
2010 if (p < ptr + size && !incomplete_tail)
2012 /* Detected a UTF-8 error. */
2013 rewind_retry:
2014 /* Retry reading with another conversion. */
2015 # if defined(FEAT_EVAL) && defined(USE_ICONV)
2016 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
2017 /* iconv() failed, try 'charconvert' */
2018 did_iconv = TRUE;
2019 else
2020 # endif
2021 /* use next item from 'fileencodings' */
2022 advance_fenc = TRUE;
2023 file_rewind = TRUE;
2024 goto retry;
2027 #endif
2029 /* count the number of characters (after conversion!) */
2030 filesize += size;
2033 * when reading the first part of a file: guess EOL type
2035 if (fileformat == EOL_UNKNOWN)
2037 /* First try finding a NL, for Dos and Unix */
2038 if (try_dos || try_unix)
2040 for (p = ptr; p < ptr + size; ++p)
2042 if (*p == NL)
2044 if (!try_unix
2045 || (try_dos && p > ptr && p[-1] == CAR))
2046 fileformat = EOL_DOS;
2047 else
2048 fileformat = EOL_UNIX;
2049 break;
2053 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
2054 if (fileformat == EOL_UNIX && try_mac)
2056 /* Need to reset the counters when retrying fenc. */
2057 try_mac = 1;
2058 try_unix = 1;
2059 for (; p >= ptr && *p != CAR; p--)
2061 if (p >= ptr)
2063 for (p = ptr; p < ptr + size; ++p)
2065 if (*p == NL)
2066 try_unix++;
2067 else if (*p == CAR)
2068 try_mac++;
2070 if (try_mac > try_unix)
2071 fileformat = EOL_MAC;
2076 /* No NL found: may use Mac format */
2077 if (fileformat == EOL_UNKNOWN && try_mac)
2078 fileformat = EOL_MAC;
2080 /* Still nothing found? Use first format in 'ffs' */
2081 if (fileformat == EOL_UNKNOWN)
2082 fileformat = default_fileformat();
2084 /* if editing a new file: may set p_tx and p_ff */
2085 if (set_options)
2086 set_fileformat(fileformat, OPT_LOCAL);
2091 * This loop is executed once for every character read.
2092 * Keep it fast!
2094 if (fileformat == EOL_MAC)
2096 --ptr;
2097 while (++ptr, --size >= 0)
2099 /* catch most common case first */
2100 if ((c = *ptr) != NUL && c != CAR && c != NL)
2101 continue;
2102 if (c == NUL)
2103 *ptr = NL; /* NULs are replaced by newlines! */
2104 else if (c == NL)
2105 *ptr = CAR; /* NLs are replaced by CRs! */
2106 else
2108 if (skip_count == 0)
2110 *ptr = NUL; /* end of line */
2111 len = (colnr_T) (ptr - line_start + 1);
2112 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2114 error = TRUE;
2115 break;
2117 ++lnum;
2118 if (--read_count == 0)
2120 error = TRUE; /* break loop */
2121 line_start = ptr; /* nothing left to write */
2122 break;
2125 else
2126 --skip_count;
2127 line_start = ptr + 1;
2131 else
2133 --ptr;
2134 while (++ptr, --size >= 0)
2136 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2137 continue;
2138 if (c == NUL)
2139 *ptr = NL; /* NULs are replaced by newlines! */
2140 else
2142 if (skip_count == 0)
2144 *ptr = NUL; /* end of line */
2145 len = (colnr_T)(ptr - line_start + 1);
2146 if (fileformat == EOL_DOS)
2148 if (ptr[-1] == CAR) /* remove CR */
2150 ptr[-1] = NUL;
2151 --len;
2154 * Reading in Dos format, but no CR-LF found!
2155 * When 'fileformats' includes "unix", delete all
2156 * the lines read so far and start all over again.
2157 * Otherwise give an error message later.
2159 else if (ff_error != EOL_DOS)
2161 if ( try_unix
2162 && !read_stdin
2163 && (read_buffer
2164 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2166 fileformat = EOL_UNIX;
2167 if (set_options)
2168 set_fileformat(EOL_UNIX, OPT_LOCAL);
2169 file_rewind = TRUE;
2170 keep_fileformat = TRUE;
2171 goto retry;
2173 ff_error = EOL_DOS;
2176 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2178 error = TRUE;
2179 break;
2181 ++lnum;
2182 if (--read_count == 0)
2184 error = TRUE; /* break loop */
2185 line_start = ptr; /* nothing left to write */
2186 break;
2189 else
2190 --skip_count;
2191 line_start = ptr + 1;
2195 linerest = (long)(ptr - line_start);
2196 ui_breakcheck();
2199 failed:
2200 /* not an error, max. number of lines reached */
2201 if (error && read_count == 0)
2202 error = FALSE;
2205 * If we get EOF in the middle of a line, note the fact and
2206 * complete the line ourselves.
2207 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2209 if (!error
2210 && !got_int
2211 && linerest != 0
2212 && !(!curbuf->b_p_bin
2213 && fileformat == EOL_DOS
2214 && *line_start == Ctrl_Z
2215 && ptr == line_start + 1))
2217 /* remember for when writing */
2218 if (set_options)
2219 curbuf->b_p_eol = FALSE;
2220 *ptr = NUL;
2221 if (ml_append(lnum, line_start,
2222 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2223 error = TRUE;
2224 else
2225 read_no_eol_lnum = ++lnum;
2228 if (set_options)
2229 save_file_ff(curbuf); /* remember the current file format */
2231 #ifdef FEAT_CRYPT
2232 if (cryptkey != curbuf->b_p_key)
2233 vim_free(cryptkey);
2234 #endif
2236 #ifdef FEAT_MBYTE
2237 /* If editing a new file: set 'fenc' for the current buffer.
2238 * Also for ":read ++edit file". */
2239 if (set_options)
2240 set_string_option_direct((char_u *)"fenc", -1, fenc,
2241 OPT_FREE|OPT_LOCAL, 0);
2242 if (fenc_alloced)
2243 vim_free(fenc);
2244 # ifdef USE_ICONV
2245 if (iconv_fd != (iconv_t)-1)
2247 iconv_close(iconv_fd);
2248 iconv_fd = (iconv_t)-1;
2250 # endif
2251 #endif
2253 if (!read_buffer && !read_stdin)
2254 close(fd); /* errors are ignored */
2255 vim_free(buffer);
2257 #ifdef HAVE_DUP
2258 if (read_stdin)
2260 /* Use stderr for stdin, makes shell commands work. */
2261 close(0);
2262 ignored = dup(2);
2264 #endif
2266 #ifdef FEAT_MBYTE
2267 if (tmpname != NULL)
2269 mch_remove(tmpname); /* delete converted file */
2270 vim_free(tmpname);
2272 #endif
2273 --no_wait_return; /* may wait for return now */
2276 * In recovery mode everything but autocommands is skipped.
2278 if (!recoverymode)
2280 /* need to delete the last line, which comes from the empty buffer */
2281 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2283 #ifdef FEAT_NETBEANS_INTG
2284 netbeansFireChanges = 0;
2285 #endif
2286 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2287 #ifdef FEAT_NETBEANS_INTG
2288 netbeansFireChanges = 1;
2289 #endif
2290 --linecnt;
2292 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2293 if (filesize == 0)
2294 linecnt = 0;
2295 if (newfile || read_buffer)
2297 redraw_curbuf_later(NOT_VALID);
2298 #ifdef FEAT_DIFF
2299 /* After reading the text into the buffer the diff info needs to
2300 * be updated. */
2301 diff_invalidate(curbuf);
2302 #endif
2303 #ifdef FEAT_FOLDING
2304 /* All folds in the window are invalid now. Mark them for update
2305 * before triggering autocommands. */
2306 foldUpdateAll(curwin);
2307 #endif
2309 else if (linecnt) /* appended at least one line */
2310 appended_lines_mark(from, linecnt);
2312 #ifndef ALWAYS_USE_GUI
2314 * If we were reading from the same terminal as where messages go,
2315 * the screen will have been messed up.
2316 * Switch on raw mode now and clear the screen.
2318 if (read_stdin)
2320 settmode(TMODE_RAW); /* set to raw mode */
2321 starttermcap();
2322 screenclear();
2324 #endif
2326 if (got_int)
2328 if (!(flags & READ_DUMMY))
2330 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2331 if (newfile)
2332 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2334 msg_scroll = msg_save;
2335 #ifdef FEAT_VIMINFO
2336 check_marks_read();
2337 #endif
2338 return OK; /* an interrupt isn't really an error */
2341 if (!filtering && !(flags & READ_DUMMY))
2343 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2344 c = FALSE;
2346 #ifdef UNIX
2347 # ifdef S_ISFIFO
2348 if (S_ISFIFO(perm)) /* fifo or socket */
2350 STRCAT(IObuff, _("[fifo/socket]"));
2351 c = TRUE;
2353 # else
2354 # ifdef S_IFIFO
2355 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2357 STRCAT(IObuff, _("[fifo]"));
2358 c = TRUE;
2360 # endif
2361 # ifdef S_IFSOCK
2362 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2364 STRCAT(IObuff, _("[socket]"));
2365 c = TRUE;
2367 # endif
2368 # endif
2369 # ifdef OPEN_CHR_FILES
2370 if (S_ISCHR(perm)) /* or character special */
2372 STRCAT(IObuff, _("[character special]"));
2373 c = TRUE;
2375 # endif
2376 #endif
2377 if (curbuf->b_p_ro)
2379 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2380 c = TRUE;
2382 if (read_no_eol_lnum)
2384 msg_add_eol();
2385 c = TRUE;
2387 if (ff_error == EOL_DOS)
2389 STRCAT(IObuff, _("[CR missing]"));
2390 c = TRUE;
2392 if (split)
2394 STRCAT(IObuff, _("[long lines split]"));
2395 c = TRUE;
2397 #ifdef FEAT_MBYTE
2398 if (notconverted)
2400 STRCAT(IObuff, _("[NOT converted]"));
2401 c = TRUE;
2403 else if (converted)
2405 STRCAT(IObuff, _("[converted]"));
2406 c = TRUE;
2408 #endif
2409 #ifdef FEAT_CRYPT
2410 if (cryptkey != NULL)
2412 STRCAT(IObuff, _("[crypted]"));
2413 c = TRUE;
2415 #endif
2416 #ifdef FEAT_MBYTE
2417 if (conv_error != 0)
2419 sprintf((char *)IObuff + STRLEN(IObuff),
2420 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2421 c = TRUE;
2423 else if (illegal_byte > 0)
2425 sprintf((char *)IObuff + STRLEN(IObuff),
2426 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2427 c = TRUE;
2429 else
2430 #endif
2431 if (error)
2433 STRCAT(IObuff, _("[READ ERRORS]"));
2434 c = TRUE;
2436 if (msg_add_fileformat(fileformat))
2437 c = TRUE;
2438 #ifdef FEAT_CRYPT
2439 if (cryptkey != NULL)
2440 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2441 else
2442 #endif
2443 msg_add_lines(c, (long)linecnt, filesize);
2445 vim_free(keep_msg);
2446 keep_msg = NULL;
2447 msg_scrolled_ign = TRUE;
2448 #ifdef ALWAYS_USE_GUI
2449 /* Don't show the message when reading stdin, it would end up in a
2450 * message box (which might be shown when exiting!) */
2451 if (read_stdin || read_buffer)
2452 p = msg_may_trunc(FALSE, IObuff);
2453 else
2454 #endif
2455 p = msg_trunc_attr(IObuff, FALSE, 0);
2456 if (read_stdin || read_buffer || restart_edit != 0
2457 || (msg_scrolled != 0 && !need_wait_return))
2458 /* Need to repeat the message after redrawing when:
2459 * - When reading from stdin (the screen will be cleared next).
2460 * - When restart_edit is set (otherwise there will be a delay
2461 * before redrawing).
2462 * - When the screen was scrolled but there is no wait-return
2463 * prompt. */
2464 set_keep_msg(p, 0);
2465 msg_scrolled_ign = FALSE;
2468 /* with errors writing the file requires ":w!" */
2469 if (newfile && (error
2470 #ifdef FEAT_MBYTE
2471 || conv_error != 0
2472 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2473 #endif
2475 curbuf->b_p_ro = TRUE;
2477 u_clearline(); /* cannot use "U" command after adding lines */
2480 * In Ex mode: cursor at last new line.
2481 * Otherwise: cursor at first new line.
2483 if (exmode_active)
2484 curwin->w_cursor.lnum = from + linecnt;
2485 else
2486 curwin->w_cursor.lnum = from + 1;
2487 check_cursor_lnum();
2488 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2491 * Set '[ and '] marks to the newly read lines.
2493 curbuf->b_op_start.lnum = from + 1;
2494 curbuf->b_op_start.col = 0;
2495 curbuf->b_op_end.lnum = from + linecnt;
2496 curbuf->b_op_end.col = 0;
2498 #ifdef WIN32
2500 * Work around a weird problem: When a file has two links (only
2501 * possible on NTFS) and we write through one link, then stat() it
2502 * through the other link, the timestamp information may be wrong.
2503 * It's correct again after reading the file, thus reset the timestamp
2504 * here.
2506 if (newfile && !read_stdin && !read_buffer
2507 && mch_stat((char *)fname, &st) >= 0)
2509 buf_store_time(curbuf, &st, fname);
2510 curbuf->b_mtime_read = curbuf->b_mtime;
2512 #endif
2514 msg_scroll = msg_save;
2516 #ifdef FEAT_VIMINFO
2518 * Get the marks before executing autocommands, so they can be used there.
2520 check_marks_read();
2521 #endif
2524 * Trick: We remember if the last line of the read didn't have
2525 * an eol for when writing it again. This is required for
2526 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2528 write_no_eol_lnum = read_no_eol_lnum;
2530 #ifdef FEAT_AUTOCMD
2531 if (!read_stdin && !read_buffer)
2533 int m = msg_scroll;
2534 int n = msg_scrolled;
2536 /* Save the fileformat now, otherwise the buffer will be considered
2537 * modified if the format/encoding was automatically detected. */
2538 if (set_options)
2539 save_file_ff(curbuf);
2542 * The output from the autocommands should not overwrite anything and
2543 * should not be overwritten: Set msg_scroll, restore its value if no
2544 * output was done.
2546 msg_scroll = TRUE;
2547 if (filtering)
2548 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2549 FALSE, curbuf, eap);
2550 else if (newfile)
2551 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2552 FALSE, curbuf, eap);
2553 else
2554 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2555 FALSE, NULL, eap);
2556 if (msg_scrolled == n)
2557 msg_scroll = m;
2558 #ifdef FEAT_EVAL
2559 if (aborting()) /* autocmds may abort script processing */
2560 return FAIL;
2561 #endif
2563 #endif
2565 if (recoverymode && error)
2566 return FAIL;
2567 return OK;
2570 #ifdef OPEN_CHR_FILES
2572 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2573 * which is the name of files used for process substitution output by
2574 * some shells on some operating systems, e.g., bash on SunOS.
2575 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2577 static int
2578 is_dev_fd_file(fname)
2579 char_u *fname;
2581 return (STRNCMP(fname, "/dev/fd/", 8) == 0
2582 && VIM_ISDIGIT(fname[8])
2583 && *skipdigits(fname + 9) == NUL
2584 && (fname[9] != NUL
2585 || (fname[8] != '0' && fname[8] != '1' && fname[8] != '2')));
2587 #endif
2589 #ifdef FEAT_MBYTE
2592 * From the current line count and characters read after that, estimate the
2593 * line number where we are now.
2594 * Used for error messages that include a line number.
2596 static linenr_T
2597 readfile_linenr(linecnt, p, endp)
2598 linenr_T linecnt; /* line count before reading more bytes */
2599 char_u *p; /* start of more bytes read */
2600 char_u *endp; /* end of more bytes read */
2602 char_u *s;
2603 linenr_T lnum;
2605 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2606 for (s = p; s < endp; ++s)
2607 if (*s == '\n')
2608 ++lnum;
2609 return lnum;
2611 #endif
2614 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2615 * equal to the buffer "buf". Used for calling readfile().
2616 * Returns OK or FAIL.
2619 prep_exarg(eap, buf)
2620 exarg_T *eap;
2621 buf_T *buf;
2623 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2624 #ifdef FEAT_MBYTE
2625 + STRLEN(buf->b_p_fenc)
2626 #endif
2627 + 15));
2628 if (eap->cmd == NULL)
2629 return FAIL;
2631 #ifdef FEAT_MBYTE
2632 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2633 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2634 eap->bad_char = buf->b_bad_char;
2635 #else
2636 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2637 #endif
2638 eap->force_ff = 7;
2640 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2641 eap->read_edit = FALSE;
2642 eap->forceit = FALSE;
2643 return OK;
2646 #ifdef FEAT_MBYTE
2648 * Find next fileencoding to use from 'fileencodings'.
2649 * "pp" points to fenc_next. It's advanced to the next item.
2650 * When there are no more items, an empty string is returned and *pp is set to
2651 * NULL.
2652 * When *pp is not set to NULL, the result is in allocated memory.
2654 static char_u *
2655 next_fenc(pp)
2656 char_u **pp;
2658 char_u *p;
2659 char_u *r;
2661 if (**pp == NUL)
2663 *pp = NULL;
2664 return (char_u *)"";
2666 p = vim_strchr(*pp, ',');
2667 if (p == NULL)
2669 r = enc_canonize(*pp);
2670 *pp += STRLEN(*pp);
2672 else
2674 r = vim_strnsave(*pp, (int)(p - *pp));
2675 *pp = p + 1;
2676 if (r != NULL)
2678 p = enc_canonize(r);
2679 vim_free(r);
2680 r = p;
2683 if (r == NULL) /* out of memory */
2685 r = (char_u *)"";
2686 *pp = NULL;
2688 return r;
2691 # ifdef FEAT_EVAL
2693 * Convert a file with the 'charconvert' expression.
2694 * This closes the file which is to be read, converts it and opens the
2695 * resulting file for reading.
2696 * Returns name of the resulting converted file (the caller should delete it
2697 * after reading it).
2698 * Returns NULL if the conversion failed ("*fdp" is not set) .
2700 static char_u *
2701 readfile_charconvert(fname, fenc, fdp)
2702 char_u *fname; /* name of input file */
2703 char_u *fenc; /* converted from */
2704 int *fdp; /* in/out: file descriptor of file */
2706 char_u *tmpname;
2707 char_u *errmsg = NULL;
2709 tmpname = vim_tempname('r');
2710 if (tmpname == NULL)
2711 errmsg = (char_u *)_("Can't find temp file for conversion");
2712 else
2714 close(*fdp); /* close the input file, ignore errors */
2715 *fdp = -1;
2716 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2717 fname, tmpname) == FAIL)
2718 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2719 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2720 O_RDONLY | O_EXTRA, 0)) < 0)
2721 errmsg = (char_u *)_("can't read output of 'charconvert'");
2724 if (errmsg != NULL)
2726 /* Don't use emsg(), it breaks mappings, the retry with
2727 * another type of conversion might still work. */
2728 MSG(errmsg);
2729 if (tmpname != NULL)
2731 mch_remove(tmpname); /* delete converted file */
2732 vim_free(tmpname);
2733 tmpname = NULL;
2737 /* If the input file is closed, open it (caller should check for error). */
2738 if (*fdp < 0)
2739 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2741 return tmpname;
2743 # endif
2745 #endif
2747 #ifdef FEAT_VIMINFO
2749 * Read marks for the current buffer from the viminfo file, when we support
2750 * buffer marks and the buffer has a name.
2752 static void
2753 check_marks_read()
2755 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2756 && curbuf->b_ffname != NULL)
2757 read_viminfo(NULL, VIF_WANT_MARKS);
2759 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2760 * the ' parameter after opening a buffer. */
2761 curbuf->b_marks_read = TRUE;
2763 #endif
2765 #ifdef FEAT_CRYPT
2767 * Check for magic number used for encryption.
2768 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2769 * *filesizep are updated.
2770 * Return the (new) encryption key, NULL for no encryption.
2772 static char_u *
2773 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2774 char_u *cryptkey; /* previous encryption key or NULL */
2775 char_u *ptr; /* pointer to read bytes */
2776 long *sizep; /* length of read bytes */
2777 long *filesizep; /* nr of bytes used from file */
2778 int newfile; /* editing a new buffer */
2780 if (*sizep >= CRYPT_MAGIC_LEN
2781 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2783 if (cryptkey == NULL)
2785 if (*curbuf->b_p_key)
2786 cryptkey = curbuf->b_p_key;
2787 else
2789 /* When newfile is TRUE, store the typed key
2790 * in the 'key' option and don't free it. */
2791 cryptkey = get_crypt_key(newfile, FALSE);
2792 /* check if empty key entered */
2793 if (cryptkey != NULL && *cryptkey == NUL)
2795 if (cryptkey != curbuf->b_p_key)
2796 vim_free(cryptkey);
2797 cryptkey = NULL;
2802 if (cryptkey != NULL)
2804 crypt_init_keys(cryptkey);
2806 /* Remove magic number from the text */
2807 *filesizep += CRYPT_MAGIC_LEN;
2808 *sizep -= CRYPT_MAGIC_LEN;
2809 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2812 /* When starting to edit a new file which does not have
2813 * encryption, clear the 'key' option, except when
2814 * starting up (called with -x argument) */
2815 else if (newfile && *curbuf->b_p_key && !starting)
2816 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2818 return cryptkey;
2820 #endif
2822 #ifdef UNIX
2823 static void
2824 set_file_time(fname, atime, mtime)
2825 char_u *fname;
2826 time_t atime; /* access time */
2827 time_t mtime; /* modification time */
2829 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2830 struct utimbuf buf;
2832 buf.actime = atime;
2833 buf.modtime = mtime;
2834 (void)utime((char *)fname, &buf);
2835 # else
2836 # if defined(HAVE_UTIMES)
2837 struct timeval tvp[2];
2839 tvp[0].tv_sec = atime;
2840 tvp[0].tv_usec = 0;
2841 tvp[1].tv_sec = mtime;
2842 tvp[1].tv_usec = 0;
2843 # ifdef NeXT
2844 (void)utimes((char *)fname, tvp);
2845 # else
2846 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2847 # endif
2848 # endif
2849 # endif
2851 #endif /* UNIX */
2853 #if defined(VMS) && !defined(MIN)
2854 /* Older DECC compiler for VAX doesn't define MIN() */
2855 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2856 #endif
2859 * Return TRUE if a file appears to be read-only from the file permissions.
2862 check_file_readonly(fname, perm)
2863 char_u *fname; /* full path to file */
2864 int perm; /* known permissions on file */
2866 #ifndef USE_MCH_ACCESS
2867 int fd = 0;
2868 #endif
2870 return (
2871 #ifdef USE_MCH_ACCESS
2872 # ifdef UNIX
2873 (perm & 0222) == 0 ||
2874 # endif
2875 mch_access((char *)fname, W_OK)
2876 #else
2877 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
2878 ? TRUE : (close(fd), FALSE)
2879 #endif
2885 * buf_write() - write to file "fname" lines "start" through "end"
2887 * We do our own buffering here because fwrite() is so slow.
2889 * If "forceit" is true, we don't care for errors when attempting backups.
2890 * In case of an error everything possible is done to restore the original
2891 * file. But when "forceit" is TRUE, we risk losing it.
2893 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2894 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2896 * This function must NOT use NameBuff (because it's called by autowrite()).
2898 * return FAIL for failure, OK otherwise
2901 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2902 reset_changed, filtering)
2903 buf_T *buf;
2904 char_u *fname;
2905 char_u *sfname;
2906 linenr_T start, end;
2907 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2908 NULL! */
2909 int append; /* append to the file */
2910 int forceit;
2911 int reset_changed;
2912 int filtering;
2914 int fd;
2915 char_u *backup = NULL;
2916 int backup_copy = FALSE; /* copy the original file? */
2917 int dobackup;
2918 char_u *ffname;
2919 char_u *wfname = NULL; /* name of file to write to */
2920 char_u *s;
2921 char_u *ptr;
2922 char_u c;
2923 int len;
2924 linenr_T lnum;
2925 long nchars;
2926 char_u *errmsg = NULL;
2927 char_u *errnum = NULL;
2928 char_u *buffer;
2929 char_u smallbuf[SMBUFSIZE];
2930 char_u *backup_ext;
2931 int bufsize;
2932 long perm; /* file permissions */
2933 int retval = OK;
2934 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2935 int msg_save = msg_scroll;
2936 int overwriting; /* TRUE if writing over original */
2937 int no_eol = FALSE; /* no end-of-line written */
2938 int device = FALSE; /* writing to a device */
2939 struct stat st_old;
2940 int prev_got_int = got_int;
2941 int file_readonly = FALSE; /* overwritten file is read-only */
2942 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2943 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2944 int made_writable = FALSE; /* 'w' bit has been set */
2945 #endif
2946 /* writing everything */
2947 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2948 #ifdef FEAT_AUTOCMD
2949 linenr_T old_line_count = buf->b_ml.ml_line_count;
2950 #endif
2951 int attr;
2952 int fileformat;
2953 int write_bin;
2954 struct bw_info write_info; /* info for buf_write_bytes() */
2955 #ifdef FEAT_MBYTE
2956 int converted = FALSE;
2957 int notconverted = FALSE;
2958 char_u *fenc; /* effective 'fileencoding' */
2959 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2960 #endif
2961 #ifdef HAS_BW_FLAGS
2962 int wb_flags = 0;
2963 #endif
2964 #ifdef HAVE_ACL
2965 vim_acl_T acl = NULL; /* ACL copied from original file to
2966 backup or new file */
2967 #endif
2969 if (fname == NULL || *fname == NUL) /* safety check */
2970 return FAIL;
2973 * Disallow writing from .exrc and .vimrc in current directory for
2974 * security reasons.
2976 if (check_secure())
2977 return FAIL;
2979 /* Avoid a crash for a long name. */
2980 if (STRLEN(fname) >= MAXPATHL)
2982 EMSG(_(e_longname));
2983 return FAIL;
2986 #ifdef FEAT_MBYTE
2987 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2988 write_info.bw_conv_buf = NULL;
2989 write_info.bw_conv_error = FALSE;
2990 write_info.bw_restlen = 0;
2991 # ifdef USE_ICONV
2992 write_info.bw_iconv_fd = (iconv_t)-1;
2993 # endif
2994 #endif
2996 /* After writing a file changedtick changes but we don't want to display
2997 * the line. */
2998 ex_no_reprint = TRUE;
3001 * If there is no file name yet, use the one for the written file.
3002 * BF_NOTEDITED is set to reflect this (in case the write fails).
3003 * Don't do this when the write is for a filter command.
3004 * Don't do this when appending.
3005 * Only do this when 'cpoptions' contains the 'F' flag.
3007 if (buf->b_ffname == NULL
3008 && reset_changed
3009 && whole
3010 && buf == curbuf
3011 #ifdef FEAT_QUICKFIX
3012 && !bt_nofile(buf)
3013 #endif
3014 && !filtering
3015 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
3016 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
3018 if (set_rw_fname(fname, sfname) == FAIL)
3019 return FAIL;
3020 buf = curbuf; /* just in case autocmds made "buf" invalid */
3023 if (sfname == NULL)
3024 sfname = fname;
3026 * For Unix: Use the short file name whenever possible.
3027 * Avoids problems with networks and when directory names are changed.
3028 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
3029 * another directory, which we don't detect
3031 ffname = fname; /* remember full fname */
3032 #ifdef UNIX
3033 fname = sfname;
3034 #endif
3036 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
3037 overwriting = TRUE;
3038 else
3039 overwriting = FALSE;
3041 if (exiting)
3042 settmode(TMODE_COOK); /* when exiting allow typahead now */
3044 ++no_wait_return; /* don't wait for return yet */
3047 * Set '[ and '] marks to the lines to be written.
3049 buf->b_op_start.lnum = start;
3050 buf->b_op_start.col = 0;
3051 buf->b_op_end.lnum = end;
3052 buf->b_op_end.col = 0;
3054 #ifdef FEAT_AUTOCMD
3056 aco_save_T aco;
3057 int buf_ffname = FALSE;
3058 int buf_sfname = FALSE;
3059 int buf_fname_f = FALSE;
3060 int buf_fname_s = FALSE;
3061 int did_cmd = FALSE;
3062 int nofile_err = FALSE;
3063 int empty_memline = (buf->b_ml.ml_mfp == NULL);
3066 * Apply PRE aucocommands.
3067 * Set curbuf to the buffer to be written.
3068 * Careful: The autocommands may call buf_write() recursively!
3070 if (ffname == buf->b_ffname)
3071 buf_ffname = TRUE;
3072 if (sfname == buf->b_sfname)
3073 buf_sfname = TRUE;
3074 if (fname == buf->b_ffname)
3075 buf_fname_f = TRUE;
3076 if (fname == buf->b_sfname)
3077 buf_fname_s = TRUE;
3079 /* set curwin/curbuf to buf and save a few things */
3080 aucmd_prepbuf(&aco, buf);
3082 if (append)
3084 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
3085 sfname, sfname, FALSE, curbuf, eap)))
3087 #ifdef FEAT_QUICKFIX
3088 if (overwriting && bt_nofile(curbuf))
3089 nofile_err = TRUE;
3090 else
3091 #endif
3092 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
3093 sfname, sfname, FALSE, curbuf, eap);
3096 else if (filtering)
3098 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
3099 NULL, sfname, FALSE, curbuf, eap);
3101 else if (reset_changed && whole)
3103 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
3104 sfname, sfname, FALSE, curbuf, eap)))
3106 #ifdef FEAT_QUICKFIX
3107 if (overwriting && bt_nofile(curbuf))
3108 nofile_err = TRUE;
3109 else
3110 #endif
3111 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
3112 sfname, sfname, FALSE, curbuf, eap);
3115 else
3117 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
3118 sfname, sfname, FALSE, curbuf, eap)))
3120 #ifdef FEAT_QUICKFIX
3121 if (overwriting && bt_nofile(curbuf))
3122 nofile_err = TRUE;
3123 else
3124 #endif
3125 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
3126 sfname, sfname, FALSE, curbuf, eap);
3130 /* restore curwin/curbuf and a few other things */
3131 aucmd_restbuf(&aco);
3134 * In three situations we return here and don't write the file:
3135 * 1. the autocommands deleted or unloaded the buffer.
3136 * 2. The autocommands abort script processing.
3137 * 3. If one of the "Cmd" autocommands was executed.
3139 if (!buf_valid(buf))
3140 buf = NULL;
3141 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
3142 || did_cmd || nofile_err
3143 #ifdef FEAT_EVAL
3144 || aborting()
3145 #endif
3148 --no_wait_return;
3149 msg_scroll = msg_save;
3150 if (nofile_err)
3151 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3153 if (nofile_err
3154 #ifdef FEAT_EVAL
3155 || aborting()
3156 #endif
3158 /* An aborting error, interrupt or exception in the
3159 * autocommands. */
3160 return FAIL;
3161 if (did_cmd)
3163 if (buf == NULL)
3164 /* The buffer was deleted. We assume it was written
3165 * (can't retry anyway). */
3166 return OK;
3167 if (overwriting)
3169 /* Assume the buffer was written, update the timestamp. */
3170 ml_timestamp(buf);
3171 if (append)
3172 buf->b_flags &= ~BF_NEW;
3173 else
3174 buf->b_flags &= ~BF_WRITE_MASK;
3176 if (reset_changed && buf->b_changed && !append
3177 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3178 /* Buffer still changed, the autocommands didn't work
3179 * properly. */
3180 return FAIL;
3181 return OK;
3183 #ifdef FEAT_EVAL
3184 if (!aborting())
3185 #endif
3186 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3187 return FAIL;
3191 * The autocommands may have changed the number of lines in the file.
3192 * When writing the whole file, adjust the end.
3193 * When writing part of the file, assume that the autocommands only
3194 * changed the number of lines that are to be written (tricky!).
3196 if (buf->b_ml.ml_line_count != old_line_count)
3198 if (whole) /* write all */
3199 end = buf->b_ml.ml_line_count;
3200 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3201 end += buf->b_ml.ml_line_count - old_line_count;
3202 else /* less lines */
3204 end -= old_line_count - buf->b_ml.ml_line_count;
3205 if (end < start)
3207 --no_wait_return;
3208 msg_scroll = msg_save;
3209 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3210 return FAIL;
3216 * The autocommands may have changed the name of the buffer, which may
3217 * be kept in fname, ffname and sfname.
3219 if (buf_ffname)
3220 ffname = buf->b_ffname;
3221 if (buf_sfname)
3222 sfname = buf->b_sfname;
3223 if (buf_fname_f)
3224 fname = buf->b_ffname;
3225 if (buf_fname_s)
3226 fname = buf->b_sfname;
3228 #endif
3230 #ifdef FEAT_NETBEANS_INTG
3231 if (usingNetbeans && isNetbeansBuffer(buf))
3233 if (whole)
3236 * b_changed can be 0 after an undo, but we still need to write
3237 * the buffer to NetBeans.
3239 if (buf->b_changed || isNetbeansModified(buf))
3241 --no_wait_return; /* may wait for return now */
3242 msg_scroll = msg_save;
3243 netbeans_save_buffer(buf); /* no error checking... */
3244 return retval;
3246 else
3248 errnum = (char_u *)"E656: ";
3249 errmsg = (char_u *)_("NetBeans disallows writes of unmodified buffers");
3250 buffer = NULL;
3251 goto fail;
3254 else
3256 errnum = (char_u *)"E657: ";
3257 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3258 buffer = NULL;
3259 goto fail;
3262 #endif
3264 if (shortmess(SHM_OVER) && !exiting)
3265 msg_scroll = FALSE; /* overwrite previous file message */
3266 else
3267 msg_scroll = TRUE; /* don't overwrite previous file message */
3268 if (!filtering)
3269 filemess(buf,
3270 #ifndef UNIX
3271 sfname,
3272 #else
3273 fname,
3274 #endif
3275 (char_u *)"", 0); /* show that we are busy */
3276 msg_scroll = FALSE; /* always overwrite the file message now */
3278 buffer = alloc(BUFSIZE);
3279 if (buffer == NULL) /* can't allocate big buffer, use small
3280 * one (to be able to write when out of
3281 * memory) */
3283 buffer = smallbuf;
3284 bufsize = SMBUFSIZE;
3286 else
3287 bufsize = BUFSIZE;
3290 * Get information about original file (if there is one).
3292 #if defined(UNIX) && !defined(ARCHIE)
3293 st_old.st_dev = 0;
3294 st_old.st_ino = 0;
3295 perm = -1;
3296 if (mch_stat((char *)fname, &st_old) < 0)
3297 newfile = TRUE;
3298 else
3300 perm = st_old.st_mode;
3301 if (!S_ISREG(st_old.st_mode)) /* not a file */
3303 if (S_ISDIR(st_old.st_mode))
3305 errnum = (char_u *)"E502: ";
3306 errmsg = (char_u *)_("is a directory");
3307 goto fail;
3309 if (mch_nodetype(fname) != NODE_WRITABLE)
3311 errnum = (char_u *)"E503: ";
3312 errmsg = (char_u *)_("is not a file or writable device");
3313 goto fail;
3315 /* It's a device of some kind (or a fifo) which we can write to
3316 * but for which we can't make a backup. */
3317 device = TRUE;
3318 newfile = TRUE;
3319 perm = -1;
3322 #else /* !UNIX */
3324 * Check for a writable device name.
3326 c = mch_nodetype(fname);
3327 if (c == NODE_OTHER)
3329 errnum = (char_u *)"E503: ";
3330 errmsg = (char_u *)_("is not a file or writable device");
3331 goto fail;
3333 if (c == NODE_WRITABLE)
3335 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3336 /* MS-Windows allows opening a device, but we will probably get stuck
3337 * trying to write to it. */
3338 if (!p_odev)
3340 errnum = (char_u *)"E796: ";
3341 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3342 goto fail;
3344 # endif
3345 device = TRUE;
3346 newfile = TRUE;
3347 perm = -1;
3349 else
3351 perm = mch_getperm(fname);
3352 if (perm < 0)
3353 newfile = TRUE;
3354 else if (mch_isdir(fname))
3356 errnum = (char_u *)"E502: ";
3357 errmsg = (char_u *)_("is a directory");
3358 goto fail;
3360 if (overwriting)
3361 (void)mch_stat((char *)fname, &st_old);
3363 #endif /* !UNIX */
3365 if (!device && !newfile)
3368 * Check if the file is really writable (when renaming the file to
3369 * make a backup we won't discover it later).
3371 file_readonly = check_file_readonly(fname, (int)perm);
3373 if (!forceit && file_readonly)
3375 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3377 errnum = (char_u *)"E504: ";
3378 errmsg = (char_u *)_(err_readonly);
3380 else
3382 errnum = (char_u *)"E505: ";
3383 errmsg = (char_u *)_("is read-only (add ! to override)");
3385 goto fail;
3389 * Check if the timestamp hasn't changed since reading the file.
3391 if (overwriting)
3393 retval = check_mtime(buf, &st_old);
3394 if (retval == FAIL)
3395 goto fail;
3399 #ifdef HAVE_ACL
3401 * For systems that support ACL: get the ACL from the original file.
3403 if (!newfile)
3404 acl = mch_get_acl(fname);
3405 #endif
3408 * If 'backupskip' is not empty, don't make a backup for some files.
3410 dobackup = (p_wb || p_bk || *p_pm != NUL);
3411 #ifdef FEAT_WILDIGN
3412 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3413 dobackup = FALSE;
3414 #endif
3417 * Save the value of got_int and reset it. We don't want a previous
3418 * interruption cancel writing, only hitting CTRL-C while writing should
3419 * abort it.
3421 prev_got_int = got_int;
3422 got_int = FALSE;
3424 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3425 buf->b_saving = TRUE;
3428 * If we are not appending or filtering, the file exists, and the
3429 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3430 * When 'patchmode' is set also make a backup when appending.
3432 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3433 * off. This helps when editing large files on almost-full disks.
3435 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3437 #if defined(UNIX) || defined(WIN32)
3438 struct stat st;
3439 #endif
3441 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3442 backup_copy = TRUE;
3443 #if defined(UNIX) || defined(WIN32)
3444 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3446 int i;
3448 # ifdef UNIX
3450 * Don't rename the file when:
3451 * - it's a hard link
3452 * - it's a symbolic link
3453 * - we don't have write permission in the directory
3454 * - we can't set the owner/group of the new file
3456 if (st_old.st_nlink > 1
3457 || mch_lstat((char *)fname, &st) < 0
3458 || st.st_dev != st_old.st_dev
3459 || st.st_ino != st_old.st_ino
3460 # ifndef HAVE_FCHOWN
3461 || st.st_uid != st_old.st_uid
3462 || st.st_gid != st_old.st_gid
3463 # endif
3465 backup_copy = TRUE;
3466 else
3467 # else
3468 # ifdef WIN32
3469 /* On NTFS file systems hard links are possible. */
3470 if (mch_is_linked(fname))
3471 backup_copy = TRUE;
3472 else
3473 # endif
3474 # endif
3477 * Check if we can create a file and set the owner/group to
3478 * the ones from the original file.
3479 * First find a file name that doesn't exist yet (use some
3480 * arbitrary numbers).
3482 STRCPY(IObuff, fname);
3483 for (i = 4913; ; i += 123)
3485 sprintf((char *)gettail(IObuff), "%d", i);
3486 if (mch_lstat((char *)IObuff, &st) < 0)
3487 break;
3489 fd = mch_open((char *)IObuff,
3490 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3491 if (fd < 0) /* can't write in directory */
3492 backup_copy = TRUE;
3493 else
3495 # ifdef UNIX
3496 # ifdef HAVE_FCHOWN
3497 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
3498 # endif
3499 if (mch_stat((char *)IObuff, &st) < 0
3500 || st.st_uid != st_old.st_uid
3501 || st.st_gid != st_old.st_gid
3502 || (long)st.st_mode != perm)
3503 backup_copy = TRUE;
3504 # endif
3505 /* Close the file before removing it, on MS-Windows we
3506 * can't delete an open file. */
3507 close(fd);
3508 mch_remove(IObuff);
3513 # ifdef UNIX
3515 * Break symlinks and/or hardlinks if we've been asked to.
3517 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3519 int lstat_res;
3521 lstat_res = mch_lstat((char *)fname, &st);
3523 /* Symlinks. */
3524 if ((bkc_flags & BKC_BREAKSYMLINK)
3525 && lstat_res == 0
3526 && st.st_ino != st_old.st_ino)
3527 backup_copy = FALSE;
3529 /* Hardlinks. */
3530 if ((bkc_flags & BKC_BREAKHARDLINK)
3531 && st_old.st_nlink > 1
3532 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3533 backup_copy = FALSE;
3535 #endif
3537 #endif
3539 /* make sure we have a valid backup extension to use */
3540 if (*p_bex == NUL)
3542 #ifdef RISCOS
3543 backup_ext = (char_u *)"/bak";
3544 #else
3545 backup_ext = (char_u *)".bak";
3546 #endif
3548 else
3549 backup_ext = p_bex;
3551 if (backup_copy
3552 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3554 int bfd;
3555 char_u *copybuf, *wp;
3556 int some_error = FALSE;
3557 struct stat st_new;
3558 char_u *dirp;
3559 char_u *rootname;
3560 #if defined(UNIX) && !defined(SHORT_FNAME)
3561 int did_set_shortname;
3562 #endif
3564 copybuf = alloc(BUFSIZE + 1);
3565 if (copybuf == NULL)
3567 some_error = TRUE; /* out of memory */
3568 goto nobackup;
3572 * Try to make the backup in each directory in the 'bdir' option.
3574 * Unix semantics has it, that we may have a writable file,
3575 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3576 * - the directory is not writable,
3577 * - the file may be a symbolic link,
3578 * - the file may belong to another user/group, etc.
3580 * For these reasons, the existing writable file must be truncated
3581 * and reused. Creation of a backup COPY will be attempted.
3583 dirp = p_bdir;
3584 while (*dirp)
3586 #ifdef UNIX
3587 st_new.st_ino = 0;
3588 st_new.st_dev = 0;
3589 st_new.st_gid = 0;
3590 #endif
3593 * Isolate one directory name, using an entry in 'bdir'.
3595 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3596 rootname = get_file_in_dir(fname, copybuf);
3597 if (rootname == NULL)
3599 some_error = TRUE; /* out of memory */
3600 goto nobackup;
3603 #if defined(UNIX) && !defined(SHORT_FNAME)
3604 did_set_shortname = FALSE;
3605 #endif
3608 * May try twice if 'shortname' not set.
3610 for (;;)
3613 * Make backup file name.
3615 backup = buf_modname(
3616 #ifdef SHORT_FNAME
3617 TRUE,
3618 #else
3619 (buf->b_p_sn || buf->b_shortname),
3620 #endif
3621 rootname, backup_ext, FALSE);
3622 if (backup == NULL)
3624 vim_free(rootname);
3625 some_error = TRUE; /* out of memory */
3626 goto nobackup;
3630 * Check if backup file already exists.
3632 if (mch_stat((char *)backup, &st_new) >= 0)
3634 #ifdef UNIX
3636 * Check if backup file is same as original file.
3637 * May happen when modname() gave the same file back.
3638 * E.g. silly link, or file name-length reached.
3639 * If we don't check here, we either ruin the file
3640 * when copying or erase it after writing. jw.
3642 if (st_new.st_dev == st_old.st_dev
3643 && st_new.st_ino == st_old.st_ino)
3645 vim_free(backup);
3646 backup = NULL; /* no backup file to delete */
3647 # ifndef SHORT_FNAME
3649 * may try again with 'shortname' set
3651 if (!(buf->b_shortname || buf->b_p_sn))
3653 buf->b_shortname = TRUE;
3654 did_set_shortname = TRUE;
3655 continue;
3657 /* setting shortname didn't help */
3658 if (did_set_shortname)
3659 buf->b_shortname = FALSE;
3660 # endif
3661 break;
3663 #endif
3666 * If we are not going to keep the backup file, don't
3667 * delete an existing one, try to use another name.
3668 * Change one character, just before the extension.
3670 if (!p_bk)
3672 wp = backup + STRLEN(backup) - 1
3673 - STRLEN(backup_ext);
3674 if (wp < backup) /* empty file name ??? */
3675 wp = backup;
3676 *wp = 'z';
3677 while (*wp > 'a'
3678 && mch_stat((char *)backup, &st_new) >= 0)
3679 --*wp;
3680 /* They all exist??? Must be something wrong. */
3681 if (*wp == 'a')
3683 vim_free(backup);
3684 backup = NULL;
3688 break;
3690 vim_free(rootname);
3693 * Try to create the backup file
3695 if (backup != NULL)
3697 /* remove old backup, if present */
3698 mch_remove(backup);
3699 /* Open with O_EXCL to avoid the file being created while
3700 * we were sleeping (symlink hacker attack?) */
3701 bfd = mch_open((char *)backup,
3702 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3703 perm & 0777);
3704 if (bfd < 0)
3706 vim_free(backup);
3707 backup = NULL;
3709 else
3711 /* set file protection same as original file, but
3712 * strip s-bit */
3713 (void)mch_setperm(backup, perm & 0777);
3715 #ifdef UNIX
3717 * Try to set the group of the backup same as the
3718 * original file. If this fails, set the protection
3719 * bits for the group same as the protection bits for
3720 * others.
3722 if (st_new.st_gid != st_old.st_gid
3723 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3724 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3725 # endif
3727 mch_setperm(backup,
3728 (perm & 0707) | ((perm & 07) << 3));
3729 # ifdef HAVE_SELINUX
3730 mch_copy_sec(fname, backup);
3731 # endif
3732 #endif
3735 * copy the file.
3737 write_info.bw_fd = bfd;
3738 write_info.bw_buf = copybuf;
3739 #ifdef HAS_BW_FLAGS
3740 write_info.bw_flags = FIO_NOCONVERT;
3741 #endif
3742 while ((write_info.bw_len = vim_read(fd, copybuf,
3743 BUFSIZE)) > 0)
3745 if (buf_write_bytes(&write_info) == FAIL)
3747 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3748 break;
3750 ui_breakcheck();
3751 if (got_int)
3753 errmsg = (char_u *)_(e_interr);
3754 break;
3758 if (close(bfd) < 0 && errmsg == NULL)
3759 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3760 if (write_info.bw_len < 0)
3761 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3762 #ifdef UNIX
3763 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3764 #endif
3765 #ifdef HAVE_ACL
3766 mch_set_acl(backup, acl);
3767 #endif
3768 #ifdef HAVE_SELINUX
3769 mch_copy_sec(fname, backup);
3770 #endif
3771 break;
3775 nobackup:
3776 close(fd); /* ignore errors for closing read file */
3777 vim_free(copybuf);
3779 if (backup == NULL && errmsg == NULL)
3780 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3781 /* ignore errors when forceit is TRUE */
3782 if ((some_error || errmsg != NULL) && !forceit)
3784 retval = FAIL;
3785 goto fail;
3787 errmsg = NULL;
3789 else
3791 char_u *dirp;
3792 char_u *p;
3793 char_u *rootname;
3796 * Make a backup by renaming the original file.
3799 * If 'cpoptions' includes the "W" flag, we don't want to
3800 * overwrite a read-only file. But rename may be possible
3801 * anyway, thus we need an extra check here.
3803 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3805 errnum = (char_u *)"E504: ";
3806 errmsg = (char_u *)_(err_readonly);
3807 goto fail;
3812 * Form the backup file name - change path/fo.o.h to
3813 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3814 * that works is used.
3816 dirp = p_bdir;
3817 while (*dirp)
3820 * Isolate one directory name and make the backup file name.
3822 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3823 rootname = get_file_in_dir(fname, IObuff);
3824 if (rootname == NULL)
3825 backup = NULL;
3826 else
3828 backup = buf_modname(
3829 #ifdef SHORT_FNAME
3830 TRUE,
3831 #else
3832 (buf->b_p_sn || buf->b_shortname),
3833 #endif
3834 rootname, backup_ext, FALSE);
3835 vim_free(rootname);
3838 if (backup != NULL)
3841 * If we are not going to keep the backup file, don't
3842 * delete an existing one, try to use another name.
3843 * Change one character, just before the extension.
3845 if (!p_bk && mch_getperm(backup) >= 0)
3847 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3848 if (p < backup) /* empty file name ??? */
3849 p = backup;
3850 *p = 'z';
3851 while (*p > 'a' && mch_getperm(backup) >= 0)
3852 --*p;
3853 /* They all exist??? Must be something wrong! */
3854 if (*p == 'a')
3856 vim_free(backup);
3857 backup = NULL;
3861 if (backup != NULL)
3864 * Delete any existing backup and move the current version
3865 * to the backup. For safety, we don't remove the backup
3866 * until the write has finished successfully. And if the
3867 * 'backup' option is set, leave it around.
3870 * If the renaming of the original file to the backup file
3871 * works, quit here.
3873 if (vim_rename(fname, backup) == 0)
3874 break;
3876 vim_free(backup); /* don't do the rename below */
3877 backup = NULL;
3880 if (backup == NULL && !forceit)
3882 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3883 goto fail;
3888 #if defined(UNIX) && !defined(ARCHIE)
3889 /* When using ":w!" and the file was read-only: make it writable */
3890 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3891 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3893 perm |= 0200;
3894 (void)mch_setperm(fname, perm);
3895 made_writable = TRUE;
3897 #endif
3899 /* When using ":w!" and writing to the current file, 'readonly' makes no
3900 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3901 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3903 buf->b_p_ro = FALSE;
3904 #ifdef FEAT_TITLE
3905 need_maketitle = TRUE; /* set window title later */
3906 #endif
3907 #ifdef FEAT_WINDOWS
3908 status_redraw_all(); /* redraw status lines later */
3909 #endif
3912 if (end > buf->b_ml.ml_line_count)
3913 end = buf->b_ml.ml_line_count;
3914 if (buf->b_ml.ml_flags & ML_EMPTY)
3915 start = end + 1;
3918 * If the original file is being overwritten, there is a small chance that
3919 * we crash in the middle of writing. Therefore the file is preserved now.
3920 * This makes all block numbers positive so that recovery does not need
3921 * the original file.
3922 * Don't do this if there is a backup file and we are exiting.
3924 if (reset_changed && !newfile && overwriting
3925 && !(exiting && backup != NULL))
3927 ml_preserve(buf, FALSE);
3928 if (got_int)
3930 errmsg = (char_u *)_(e_interr);
3931 goto restore_backup;
3935 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3937 * Before risking to lose the original file verify if there's
3938 * a resource fork to preserve, and if cannot be done warn
3939 * the users. This happens when overwriting without backups.
3941 if (backup == NULL && overwriting && !append)
3942 if (mch_has_resource_fork(fname))
3944 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3945 goto restore_backup;
3947 #endif
3949 #ifdef VMS
3950 vms_remove_version(fname); /* remove version */
3951 #endif
3952 /* Default: write the file directly. May write to a temp file for
3953 * multi-byte conversion. */
3954 wfname = fname;
3956 #ifdef FEAT_MBYTE
3957 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3958 if (eap != NULL && eap->force_enc != 0)
3960 fenc = eap->cmd + eap->force_enc;
3961 fenc = enc_canonize(fenc);
3962 fenc_tofree = fenc;
3964 else
3965 fenc = buf->b_p_fenc;
3968 * The file needs to be converted when 'fileencoding' is set and
3969 * 'fileencoding' differs from 'encoding'.
3971 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
3974 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3975 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3976 * Prepare the flags for it and allocate bw_conv_buf when needed.
3978 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3980 wb_flags = get_fio_flags(fenc);
3981 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3983 /* Need to allocate a buffer to translate into. */
3984 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3985 write_info.bw_conv_buflen = bufsize * 2;
3986 else /* FIO_UCS4 */
3987 write_info.bw_conv_buflen = bufsize * 4;
3988 write_info.bw_conv_buf
3989 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3990 if (write_info.bw_conv_buf == NULL)
3991 end = 0;
3995 # ifdef WIN3264
3996 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
3998 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3999 write_info.bw_conv_buflen = bufsize * 4;
4000 write_info.bw_conv_buf
4001 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4002 if (write_info.bw_conv_buf == NULL)
4003 end = 0;
4005 # endif
4007 # ifdef MACOS_X
4008 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
4010 write_info.bw_conv_buflen = bufsize * 3;
4011 write_info.bw_conv_buf
4012 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4013 if (write_info.bw_conv_buf == NULL)
4014 end = 0;
4016 # endif
4018 # if defined(FEAT_EVAL) || defined(USE_ICONV)
4019 if (converted && wb_flags == 0)
4021 # ifdef USE_ICONV
4023 * Use iconv() conversion when conversion is needed and it's not done
4024 * internally.
4026 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
4027 enc_utf8 ? (char_u *)"utf-8" : p_enc);
4028 if (write_info.bw_iconv_fd != (iconv_t)-1)
4030 /* We're going to use iconv(), allocate a buffer to convert in. */
4031 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
4032 write_info.bw_conv_buf
4033 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4034 if (write_info.bw_conv_buf == NULL)
4035 end = 0;
4036 write_info.bw_first = TRUE;
4038 # ifdef FEAT_EVAL
4039 else
4040 # endif
4041 # endif
4043 # ifdef FEAT_EVAL
4045 * When the file needs to be converted with 'charconvert' after
4046 * writing, write to a temp file instead and let the conversion
4047 * overwrite the original file.
4049 if (*p_ccv != NUL)
4051 wfname = vim_tempname('w');
4052 if (wfname == NULL) /* Can't write without a tempfile! */
4054 errmsg = (char_u *)_("E214: Can't find temp file for writing");
4055 goto restore_backup;
4058 # endif
4060 # endif
4061 if (converted && wb_flags == 0
4062 # ifdef USE_ICONV
4063 && write_info.bw_iconv_fd == (iconv_t)-1
4064 # endif
4065 # ifdef FEAT_EVAL
4066 && wfname == fname
4067 # endif
4070 if (!forceit)
4072 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
4073 goto restore_backup;
4075 notconverted = TRUE;
4077 #endif
4080 * Open the file "wfname" for writing.
4081 * We may try to open the file twice: If we can't write to the
4082 * file and forceit is TRUE we delete the existing file and try to create
4083 * a new one. If this still fails we may have lost the original file!
4084 * (this may happen when the user reached his quotum for number of files).
4085 * Appending will fail if the file does not exist and forceit is FALSE.
4087 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
4088 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
4089 : (O_CREAT | O_TRUNC))
4090 , perm < 0 ? 0666 : (perm & 0777))) < 0)
4093 * A forced write will try to create a new file if the old one is
4094 * still readonly. This may also happen when the directory is
4095 * read-only. In that case the mch_remove() will fail.
4097 if (errmsg == NULL)
4099 #ifdef UNIX
4100 struct stat st;
4102 /* Don't delete the file when it's a hard or symbolic link. */
4103 if ((!newfile && st_old.st_nlink > 1)
4104 || (mch_lstat((char *)fname, &st) == 0
4105 && (st.st_dev != st_old.st_dev
4106 || st.st_ino != st_old.st_ino)))
4107 errmsg = (char_u *)_("E166: Can't open linked file for writing");
4108 else
4109 #endif
4111 errmsg = (char_u *)_("E212: Can't open file for writing");
4112 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
4113 && perm >= 0)
4115 #ifdef UNIX
4116 /* we write to the file, thus it should be marked
4117 writable after all */
4118 if (!(perm & 0200))
4119 made_writable = TRUE;
4120 perm |= 0200;
4121 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
4122 perm &= 0777;
4123 #endif
4124 if (!append) /* don't remove when appending */
4125 mch_remove(wfname);
4126 continue;
4131 restore_backup:
4133 struct stat st;
4136 * If we failed to open the file, we don't need a backup. Throw it
4137 * away. If we moved or removed the original file try to put the
4138 * backup in its place.
4140 if (backup != NULL && wfname == fname)
4142 if (backup_copy)
4145 * There is a small chance that we removed the original,
4146 * try to move the copy in its place.
4147 * This may not work if the vim_rename() fails.
4148 * In that case we leave the copy around.
4150 /* If file does not exist, put the copy in its place */
4151 if (mch_stat((char *)fname, &st) < 0)
4152 vim_rename(backup, fname);
4153 /* if original file does exist throw away the copy */
4154 if (mch_stat((char *)fname, &st) >= 0)
4155 mch_remove(backup);
4157 else
4159 /* try to put the original file back */
4160 vim_rename(backup, fname);
4164 /* if original file no longer exists give an extra warning */
4165 if (!newfile && mch_stat((char *)fname, &st) < 0)
4166 end = 0;
4169 #ifdef FEAT_MBYTE
4170 if (wfname != fname)
4171 vim_free(wfname);
4172 #endif
4173 goto fail;
4175 errmsg = NULL;
4177 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4178 /* TODO: Is it need for MACOS_X? (Dany) */
4180 * On macintosh copy the original files attributes (i.e. the backup)
4181 * This is done in order to preserve the resource fork and the
4182 * Finder attribute (label, comments, custom icons, file creator)
4184 if (backup != NULL && overwriting && !append)
4186 if (backup_copy)
4187 (void)mch_copy_file_attribute(wfname, backup);
4188 else
4189 (void)mch_copy_file_attribute(backup, wfname);
4192 if (!overwriting && !append)
4194 if (buf->b_ffname != NULL)
4195 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4196 /* Should copy resource fork */
4198 #endif
4200 write_info.bw_fd = fd;
4202 #ifdef FEAT_CRYPT
4203 if (*buf->b_p_key && !filtering)
4205 crypt_init_keys(buf->b_p_key);
4206 /* Write magic number, so that Vim knows that this file is encrypted
4207 * when reading it again. This also undergoes utf-8 to ucs-2/4
4208 * conversion when needed. */
4209 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4210 write_info.bw_len = CRYPT_MAGIC_LEN;
4211 write_info.bw_flags = FIO_NOCONVERT;
4212 if (buf_write_bytes(&write_info) == FAIL)
4213 end = 0;
4214 wb_flags |= FIO_ENCRYPTED;
4216 #endif
4218 write_info.bw_buf = buffer;
4219 nchars = 0;
4221 /* use "++bin", "++nobin" or 'binary' */
4222 if (eap != NULL && eap->force_bin != 0)
4223 write_bin = (eap->force_bin == FORCE_BIN);
4224 else
4225 write_bin = buf->b_p_bin;
4227 #ifdef FEAT_MBYTE
4229 * The BOM is written just after the encryption magic number.
4230 * Skip it when appending and the file already existed, the BOM only makes
4231 * sense at the start of the file.
4233 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4235 write_info.bw_len = make_bom(buffer, fenc);
4236 if (write_info.bw_len > 0)
4238 /* don't convert, do encryption */
4239 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4240 if (buf_write_bytes(&write_info) == FAIL)
4241 end = 0;
4242 else
4243 nchars += write_info.bw_len;
4246 #endif
4248 write_info.bw_len = bufsize;
4249 #ifdef HAS_BW_FLAGS
4250 write_info.bw_flags = wb_flags;
4251 #endif
4252 fileformat = get_fileformat_force(buf, eap);
4253 s = buffer;
4254 len = 0;
4255 for (lnum = start; lnum <= end; ++lnum)
4258 * The next while loop is done once for each character written.
4259 * Keep it fast!
4261 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4262 while ((c = *++ptr) != NUL)
4264 if (c == NL)
4265 *s = NUL; /* replace newlines with NULs */
4266 else if (c == CAR && fileformat == EOL_MAC)
4267 *s = NL; /* Mac: replace CRs with NLs */
4268 else
4269 *s = c;
4270 ++s;
4271 if (++len != bufsize)
4272 continue;
4273 if (buf_write_bytes(&write_info) == FAIL)
4275 end = 0; /* write error: break loop */
4276 break;
4278 nchars += bufsize;
4279 s = buffer;
4280 len = 0;
4282 /* write failed or last line has no EOL: stop here */
4283 if (end == 0
4284 || (lnum == end
4285 && write_bin
4286 && (lnum == write_no_eol_lnum
4287 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4289 ++lnum; /* written the line, count it */
4290 no_eol = TRUE;
4291 break;
4293 if (fileformat == EOL_UNIX)
4294 *s++ = NL;
4295 else
4297 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4298 if (fileformat == EOL_DOS) /* write CR-NL */
4300 if (++len == bufsize)
4302 if (buf_write_bytes(&write_info) == FAIL)
4304 end = 0; /* write error: break loop */
4305 break;
4307 nchars += bufsize;
4308 s = buffer;
4309 len = 0;
4311 *s++ = NL;
4314 if (++len == bufsize && end)
4316 if (buf_write_bytes(&write_info) == FAIL)
4318 end = 0; /* write error: break loop */
4319 break;
4321 nchars += bufsize;
4322 s = buffer;
4323 len = 0;
4325 ui_breakcheck();
4326 if (got_int)
4328 end = 0; /* Interrupted, break loop */
4329 break;
4332 #ifdef VMS
4334 * On VMS there is a problem: newlines get added when writing blocks
4335 * at a time. Fix it by writing a line at a time.
4336 * This is much slower!
4337 * Explanation: VAX/DECC RTL insists that records in some RMS
4338 * structures end with a newline (carriage return) character, and if
4339 * they don't it adds one.
4340 * With other RMS structures it works perfect without this fix.
4342 if (buf->b_fab_rfm == FAB$C_VFC
4343 || ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0))
4345 int b2write;
4347 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4348 ? MIN(4096, bufsize)
4349 : MIN(buf->b_fab_mrs, bufsize));
4351 b2write = len;
4352 while (b2write > 0)
4354 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4355 if (buf_write_bytes(&write_info) == FAIL)
4357 end = 0;
4358 break;
4360 b2write -= MIN(b2write, buf->b_fab_mrs);
4362 write_info.bw_len = bufsize;
4363 nchars += len;
4364 s = buffer;
4365 len = 0;
4367 #endif
4369 if (len > 0 && end > 0)
4371 write_info.bw_len = len;
4372 if (buf_write_bytes(&write_info) == FAIL)
4373 end = 0; /* write error */
4374 nchars += len;
4377 #if defined(UNIX) && defined(HAVE_FSYNC)
4378 /* On many journalling file systems there is a bug that causes both the
4379 * original and the backup file to be lost when halting the system right
4380 * after writing the file. That's because only the meta-data is
4381 * journalled. Syncing the file slows down the system, but assures it has
4382 * been written to disk and we don't lose it.
4383 * For a device do try the fsync() but don't complain if it does not work
4384 * (could be a pipe).
4385 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4386 if (p_fs && fsync(fd) != 0 && !device)
4388 errmsg = (char_u *)_("E667: Fsync failed");
4389 end = 0;
4391 #endif
4393 #ifdef HAVE_SELINUX
4394 /* Probably need to set the security context. */
4395 if (!backup_copy)
4396 mch_copy_sec(backup, wfname);
4397 #endif
4399 #ifdef UNIX
4400 /* When creating a new file, set its owner/group to that of the original
4401 * file. Get the new device and inode number. */
4402 if (backup != NULL && !backup_copy)
4404 # ifdef HAVE_FCHOWN
4405 struct stat st;
4407 /* don't change the owner when it's already OK, some systems remove
4408 * permission or ACL stuff */
4409 if (mch_stat((char *)wfname, &st) < 0
4410 || st.st_uid != st_old.st_uid
4411 || st.st_gid != st_old.st_gid)
4413 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
4414 if (perm >= 0) /* set permission again, may have changed */
4415 (void)mch_setperm(wfname, perm);
4417 # endif
4418 buf_setino(buf);
4420 else if (!buf->b_dev_valid)
4421 /* Set the inode when creating a new file. */
4422 buf_setino(buf);
4423 #endif
4425 if (close(fd) != 0)
4427 errmsg = (char_u *)_("E512: Close failed");
4428 end = 0;
4431 #ifdef UNIX
4432 if (made_writable)
4433 perm &= ~0200; /* reset 'w' bit for security reasons */
4434 #endif
4435 if (perm >= 0) /* set perm. of new file same as old file */
4436 (void)mch_setperm(wfname, perm);
4437 #ifdef RISCOS
4438 if (!append && !filtering)
4439 /* Set the filetype after writing the file. */
4440 mch_set_filetype(wfname, buf->b_p_oft);
4441 #endif
4442 #ifdef HAVE_ACL
4443 /* Probably need to set the ACL before changing the user (can't set the
4444 * ACL on a file the user doesn't own). */
4445 if (!backup_copy)
4446 mch_set_acl(wfname, acl);
4447 #endif
4450 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4451 if (wfname != fname)
4454 * The file was written to a temp file, now it needs to be converted
4455 * with 'charconvert' to (overwrite) the output file.
4457 if (end != 0)
4459 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4460 wfname, fname) == FAIL)
4462 write_info.bw_conv_error = TRUE;
4463 end = 0;
4466 mch_remove(wfname);
4467 vim_free(wfname);
4469 #endif
4471 if (end == 0)
4473 if (errmsg == NULL)
4475 #ifdef FEAT_MBYTE
4476 if (write_info.bw_conv_error)
4477 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4478 else
4479 #endif
4480 if (got_int)
4481 errmsg = (char_u *)_(e_interr);
4482 else
4483 errmsg = (char_u *)_("E514: write error (file system full?)");
4487 * If we have a backup file, try to put it in place of the new file,
4488 * because the new file is probably corrupt. This avoids losing the
4489 * original file when trying to make a backup when writing the file a
4490 * second time.
4491 * When "backup_copy" is set we need to copy the backup over the new
4492 * file. Otherwise rename the backup file.
4493 * If this is OK, don't give the extra warning message.
4495 if (backup != NULL)
4497 if (backup_copy)
4499 /* This may take a while, if we were interrupted let the user
4500 * know we got the message. */
4501 if (got_int)
4503 MSG(_(e_interr));
4504 out_flush();
4506 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4508 if ((write_info.bw_fd = mch_open((char *)fname,
4509 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4510 perm & 0777)) >= 0)
4512 /* copy the file. */
4513 write_info.bw_buf = smallbuf;
4514 #ifdef HAS_BW_FLAGS
4515 write_info.bw_flags = FIO_NOCONVERT;
4516 #endif
4517 while ((write_info.bw_len = vim_read(fd, smallbuf,
4518 SMBUFSIZE)) > 0)
4519 if (buf_write_bytes(&write_info) == FAIL)
4520 break;
4522 if (close(write_info.bw_fd) >= 0
4523 && write_info.bw_len == 0)
4524 end = 1; /* success */
4526 close(fd); /* ignore errors for closing read file */
4529 else
4531 if (vim_rename(backup, fname) == 0)
4532 end = 1;
4535 goto fail;
4538 lnum -= start; /* compute number of written lines */
4539 --no_wait_return; /* may wait for return now */
4541 #if !(defined(UNIX) || defined(VMS))
4542 fname = sfname; /* use shortname now, for the messages */
4543 #endif
4544 if (!filtering)
4546 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4547 c = FALSE;
4548 #ifdef FEAT_MBYTE
4549 if (write_info.bw_conv_error)
4551 STRCAT(IObuff, _(" CONVERSION ERROR"));
4552 c = TRUE;
4554 else if (notconverted)
4556 STRCAT(IObuff, _("[NOT converted]"));
4557 c = TRUE;
4559 else if (converted)
4561 STRCAT(IObuff, _("[converted]"));
4562 c = TRUE;
4564 #endif
4565 if (device)
4567 STRCAT(IObuff, _("[Device]"));
4568 c = TRUE;
4570 else if (newfile)
4572 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4573 c = TRUE;
4575 if (no_eol)
4577 msg_add_eol();
4578 c = TRUE;
4580 /* may add [unix/dos/mac] */
4581 if (msg_add_fileformat(fileformat))
4582 c = TRUE;
4583 #ifdef FEAT_CRYPT
4584 if (wb_flags & FIO_ENCRYPTED)
4586 STRCAT(IObuff, _("[crypted]"));
4587 c = TRUE;
4589 #endif
4590 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4591 if (!shortmess(SHM_WRITE))
4593 if (append)
4594 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4595 else
4596 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4599 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4602 /* When written everything correctly: reset 'modified'. Unless not
4603 * writing to the original file and '+' is not in 'cpoptions'. */
4604 if (reset_changed && whole && !append
4605 #ifdef FEAT_MBYTE
4606 && !write_info.bw_conv_error
4607 #endif
4608 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4611 unchanged(buf, TRUE);
4612 u_unchanged(buf);
4616 * If written to the current file, update the timestamp of the swap file
4617 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4619 if (overwriting)
4621 ml_timestamp(buf);
4622 if (append)
4623 buf->b_flags &= ~BF_NEW;
4624 else
4625 buf->b_flags &= ~BF_WRITE_MASK;
4629 * If we kept a backup until now, and we are in patch mode, then we make
4630 * the backup file our 'original' file.
4632 if (*p_pm && dobackup)
4634 char *org = (char *)buf_modname(
4635 #ifdef SHORT_FNAME
4636 TRUE,
4637 #else
4638 (buf->b_p_sn || buf->b_shortname),
4639 #endif
4640 fname, p_pm, FALSE);
4642 if (backup != NULL)
4644 struct stat st;
4647 * If the original file does not exist yet
4648 * the current backup file becomes the original file
4650 if (org == NULL)
4651 EMSG(_("E205: Patchmode: can't save original file"));
4652 else if (mch_stat(org, &st) < 0)
4654 vim_rename(backup, (char_u *)org);
4655 vim_free(backup); /* don't delete the file */
4656 backup = NULL;
4657 #ifdef UNIX
4658 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4659 #endif
4663 * If there is no backup file, remember that a (new) file was
4664 * created.
4666 else
4668 int empty_fd;
4670 if (org == NULL
4671 || (empty_fd = mch_open(org,
4672 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4673 perm < 0 ? 0666 : (perm & 0777))) < 0)
4674 EMSG(_("E206: patchmode: can't touch empty original file"));
4675 else
4676 close(empty_fd);
4678 if (org != NULL)
4680 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4681 vim_free(org);
4686 * Remove the backup unless 'backup' option is set
4688 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4689 EMSG(_("E207: Can't delete backup file"));
4691 #ifdef FEAT_SUN_WORKSHOP
4692 if (usingSunWorkShop)
4693 workshop_file_saved((char *) ffname);
4694 #endif
4696 goto nofail;
4699 * Finish up. We get here either after failure or success.
4701 fail:
4702 --no_wait_return; /* may wait for return now */
4703 nofail:
4705 /* Done saving, we accept changed buffer warnings again */
4706 buf->b_saving = FALSE;
4708 vim_free(backup);
4709 if (buffer != smallbuf)
4710 vim_free(buffer);
4711 #ifdef FEAT_MBYTE
4712 vim_free(fenc_tofree);
4713 vim_free(write_info.bw_conv_buf);
4714 # ifdef USE_ICONV
4715 if (write_info.bw_iconv_fd != (iconv_t)-1)
4717 iconv_close(write_info.bw_iconv_fd);
4718 write_info.bw_iconv_fd = (iconv_t)-1;
4720 # endif
4721 #endif
4722 #ifdef HAVE_ACL
4723 mch_free_acl(acl);
4724 #endif
4726 if (errmsg != NULL)
4728 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4730 attr = hl_attr(HLF_E); /* set highlight for error messages */
4731 msg_add_fname(buf,
4732 #ifndef UNIX
4733 sfname
4734 #else
4735 fname
4736 #endif
4737 ); /* put file name in IObuff with quotes */
4738 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4739 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4740 /* If the error message has the form "is ...", put the error number in
4741 * front of the file name. */
4742 if (errnum != NULL)
4744 STRMOVE(IObuff + numlen, IObuff);
4745 mch_memmove(IObuff, errnum, (size_t)numlen);
4747 STRCAT(IObuff, errmsg);
4748 emsg(IObuff);
4750 retval = FAIL;
4751 if (end == 0)
4753 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4754 attr | MSG_HIST);
4755 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4756 attr | MSG_HIST);
4758 /* Update the timestamp to avoid an "overwrite changed file"
4759 * prompt when writing again. */
4760 if (mch_stat((char *)fname, &st_old) >= 0)
4762 buf_store_time(buf, &st_old, fname);
4763 buf->b_mtime_read = buf->b_mtime;
4767 msg_scroll = msg_save;
4769 #ifdef FEAT_AUTOCMD
4770 #ifdef FEAT_EVAL
4771 if (!should_abort(retval))
4772 #else
4773 if (!got_int)
4774 #endif
4776 aco_save_T aco;
4778 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4781 * Apply POST autocommands.
4782 * Careful: The autocommands may call buf_write() recursively!
4784 aucmd_prepbuf(&aco, buf);
4786 if (append)
4787 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4788 FALSE, curbuf, eap);
4789 else if (filtering)
4790 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4791 FALSE, curbuf, eap);
4792 else if (reset_changed && whole)
4793 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4794 FALSE, curbuf, eap);
4795 else
4796 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4797 FALSE, curbuf, eap);
4799 /* restore curwin/curbuf and a few other things */
4800 aucmd_restbuf(&aco);
4802 #ifdef FEAT_EVAL
4803 if (aborting()) /* autocmds may abort script processing */
4804 retval = FALSE;
4805 #endif
4807 #endif
4809 got_int |= prev_got_int;
4811 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4812 /* Update machine specific information. */
4813 mch_post_buffer_write(buf);
4814 #endif
4815 return retval;
4819 * Set the name of the current buffer. Use when the buffer doesn't have a
4820 * name and a ":r" or ":w" command with a file name is used.
4822 static int
4823 set_rw_fname(fname, sfname)
4824 char_u *fname;
4825 char_u *sfname;
4827 #ifdef FEAT_AUTOCMD
4828 buf_T *buf = curbuf;
4830 /* It's like the unnamed buffer is deleted.... */
4831 if (curbuf->b_p_bl)
4832 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4833 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4834 # ifdef FEAT_EVAL
4835 if (aborting()) /* autocmds may abort script processing */
4836 return FAIL;
4837 # endif
4838 if (curbuf != buf)
4840 /* We are in another buffer now, don't do the renaming. */
4841 EMSG(_(e_auchangedbuf));
4842 return FAIL;
4844 #endif
4846 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4847 curbuf->b_flags |= BF_NOTEDITED;
4849 #ifdef FEAT_AUTOCMD
4850 /* ....and a new named one is created */
4851 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4852 if (curbuf->b_p_bl)
4853 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4854 # ifdef FEAT_EVAL
4855 if (aborting()) /* autocmds may abort script processing */
4856 return FAIL;
4857 # endif
4859 /* Do filetype detection now if 'filetype' is empty. */
4860 if (*curbuf->b_p_ft == NUL)
4862 if (au_has_group((char_u *)"filetypedetect"))
4863 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4864 do_modelines(0);
4866 #endif
4868 return OK;
4872 * Put file name into IObuff with quotes.
4874 void
4875 msg_add_fname(buf, fname)
4876 buf_T *buf;
4877 char_u *fname;
4879 if (fname == NULL)
4880 fname = (char_u *)"-stdin-";
4881 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4882 IObuff[0] = '"';
4883 STRCAT(IObuff, "\" ");
4887 * Append message for text mode to IObuff.
4888 * Return TRUE if something appended.
4890 static int
4891 msg_add_fileformat(eol_type)
4892 int eol_type;
4894 #ifndef USE_CRNL
4895 if (eol_type == EOL_DOS)
4897 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4898 return TRUE;
4900 #endif
4901 #ifndef USE_CR
4902 if (eol_type == EOL_MAC)
4904 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4905 return TRUE;
4907 #endif
4908 #if defined(USE_CRNL) || defined(USE_CR)
4909 if (eol_type == EOL_UNIX)
4911 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4912 return TRUE;
4914 #endif
4915 return FALSE;
4919 * Append line and character count to IObuff.
4921 void
4922 msg_add_lines(insert_space, lnum, nchars)
4923 int insert_space;
4924 long lnum;
4925 long nchars;
4927 char_u *p;
4929 p = IObuff + STRLEN(IObuff);
4931 if (insert_space)
4932 *p++ = ' ';
4933 if (shortmess(SHM_LINES))
4934 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4935 else
4937 if (lnum == 1)
4938 STRCPY(p, _("1 line, "));
4939 else
4940 sprintf((char *)p, _("%ld lines, "), lnum);
4941 p += STRLEN(p);
4942 if (nchars == 1)
4943 STRCPY(p, _("1 character"));
4944 else
4945 sprintf((char *)p, _("%ld characters"), nchars);
4950 * Append message for missing line separator to IObuff.
4952 static void
4953 msg_add_eol()
4955 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4959 * Check modification time of file, before writing to it.
4960 * The size isn't checked, because using a tool like "gzip" takes care of
4961 * using the same timestamp but can't set the size.
4963 static int
4964 check_mtime(buf, st)
4965 buf_T *buf;
4966 struct stat *st;
4968 if (buf->b_mtime_read != 0
4969 && time_differs((long)st->st_mtime, buf->b_mtime_read))
4971 msg_scroll = TRUE; /* don't overwrite messages here */
4972 msg_silent = 0; /* must give this prompt */
4973 /* don't use emsg() here, don't want to flush the buffers */
4974 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4975 hl_attr(HLF_E));
4976 if (ask_yesno((char_u *)_("Do you really want to write to it"),
4977 TRUE) == 'n')
4978 return FAIL;
4979 msg_scroll = FALSE; /* always overwrite the file message now */
4981 return OK;
4984 static int
4985 time_differs(t1, t2)
4986 long t1, t2;
4988 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4989 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4990 * the seconds. Since the roundoff is done when flushing the inode, the
4991 * time may change unexpectedly by one second!!! */
4992 return (t1 - t2 > 1 || t2 - t1 > 1);
4993 #else
4994 return (t1 != t2);
4995 #endif
4999 * Call write() to write a number of bytes to the file.
5000 * Also handles encryption and 'encoding' conversion.
5002 * Return FAIL for failure, OK otherwise.
5004 static int
5005 buf_write_bytes(ip)
5006 struct bw_info *ip;
5008 int wlen;
5009 char_u *buf = ip->bw_buf; /* data to write */
5010 int len = ip->bw_len; /* length of data */
5011 #ifdef HAS_BW_FLAGS
5012 int flags = ip->bw_flags; /* extra flags */
5013 #endif
5015 #ifdef FEAT_MBYTE
5017 * Skip conversion when writing the crypt magic number or the BOM.
5019 if (!(flags & FIO_NOCONVERT))
5021 char_u *p;
5022 unsigned c;
5023 int n;
5025 if (flags & FIO_UTF8)
5028 * Convert latin1 in the buffer to UTF-8 in the file.
5030 p = ip->bw_conv_buf; /* translate to buffer */
5031 for (wlen = 0; wlen < len; ++wlen)
5032 p += utf_char2bytes(buf[wlen], p);
5033 buf = ip->bw_conv_buf;
5034 len = (int)(p - ip->bw_conv_buf);
5036 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
5039 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
5040 * Latin1 chars in the file.
5042 if (flags & FIO_LATIN1)
5043 p = buf; /* translate in-place (can only get shorter) */
5044 else
5045 p = ip->bw_conv_buf; /* translate to buffer */
5046 for (wlen = 0; wlen < len; wlen += n)
5048 if (wlen == 0 && ip->bw_restlen != 0)
5050 int l;
5052 /* Use remainder of previous call. Append the start of
5053 * buf[] to get a full sequence. Might still be too
5054 * short! */
5055 l = CONV_RESTLEN - ip->bw_restlen;
5056 if (l > len)
5057 l = len;
5058 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
5059 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
5060 if (n > ip->bw_restlen + len)
5062 /* We have an incomplete byte sequence at the end to
5063 * be written. We can't convert it without the
5064 * remaining bytes. Keep them for the next call. */
5065 if (ip->bw_restlen + len > CONV_RESTLEN)
5066 return FAIL;
5067 ip->bw_restlen += len;
5068 break;
5070 if (n > 1)
5071 c = utf_ptr2char(ip->bw_rest);
5072 else
5073 c = ip->bw_rest[0];
5074 if (n >= ip->bw_restlen)
5076 n -= ip->bw_restlen;
5077 ip->bw_restlen = 0;
5079 else
5081 ip->bw_restlen -= n;
5082 mch_memmove(ip->bw_rest, ip->bw_rest + n,
5083 (size_t)ip->bw_restlen);
5084 n = 0;
5087 else
5089 n = utf_ptr2len_len(buf + wlen, len - wlen);
5090 if (n > len - wlen)
5092 /* We have an incomplete byte sequence at the end to
5093 * be written. We can't convert it without the
5094 * remaining bytes. Keep them for the next call. */
5095 if (len - wlen > CONV_RESTLEN)
5096 return FAIL;
5097 ip->bw_restlen = len - wlen;
5098 mch_memmove(ip->bw_rest, buf + wlen,
5099 (size_t)ip->bw_restlen);
5100 break;
5102 if (n > 1)
5103 c = utf_ptr2char(buf + wlen);
5104 else
5105 c = buf[wlen];
5108 ip->bw_conv_error |= ucs2bytes(c, &p, flags);
5110 if (flags & FIO_LATIN1)
5111 len = (int)(p - buf);
5112 else
5114 buf = ip->bw_conv_buf;
5115 len = (int)(p - ip->bw_conv_buf);
5119 # ifdef WIN3264
5120 else if (flags & FIO_CODEPAGE)
5123 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5124 * codepage.
5126 char_u *from;
5127 size_t fromlen;
5128 char_u *to;
5129 int u8c;
5130 BOOL bad = FALSE;
5131 int needed;
5133 if (ip->bw_restlen > 0)
5135 /* Need to concatenate the remainder of the previous call and
5136 * the bytes of the current call. Use the end of the
5137 * conversion buffer for this. */
5138 fromlen = len + ip->bw_restlen;
5139 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5140 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5141 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5143 else
5145 from = buf;
5146 fromlen = len;
5149 to = ip->bw_conv_buf;
5150 if (enc_utf8)
5152 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5153 * The buffer has been allocated to be big enough. */
5154 while (fromlen > 0)
5156 n = (int)utf_ptr2len_len(from, (int)fromlen);
5157 if (n > (int)fromlen) /* incomplete byte sequence */
5158 break;
5159 u8c = utf_ptr2char(from);
5160 *to++ = (u8c & 0xff);
5161 *to++ = (u8c >> 8);
5162 fromlen -= n;
5163 from += n;
5166 /* Copy remainder to ip->bw_rest[] to be used for the next
5167 * call. */
5168 if (fromlen > CONV_RESTLEN)
5170 /* weird overlong sequence */
5171 ip->bw_conv_error = TRUE;
5172 return FAIL;
5174 mch_memmove(ip->bw_rest, from, fromlen);
5175 ip->bw_restlen = (int)fromlen;
5177 else
5179 /* Convert from enc_codepage to UCS-2, to the start of the
5180 * buffer. The buffer has been allocated to be big enough. */
5181 ip->bw_restlen = 0;
5182 needed = MultiByteToWideChar(enc_codepage,
5183 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5184 NULL, 0);
5185 if (needed == 0)
5187 /* When conversion fails there may be a trailing byte. */
5188 needed = MultiByteToWideChar(enc_codepage,
5189 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5190 NULL, 0);
5191 if (needed == 0)
5193 /* Conversion doesn't work. */
5194 ip->bw_conv_error = TRUE;
5195 return FAIL;
5197 /* Save the trailing byte for the next call. */
5198 ip->bw_rest[0] = from[fromlen - 1];
5199 ip->bw_restlen = 1;
5201 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5202 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5203 (LPWSTR)to, needed);
5204 if (needed == 0)
5206 /* Safety check: Conversion doesn't work. */
5207 ip->bw_conv_error = TRUE;
5208 return FAIL;
5210 to += needed * 2;
5213 fromlen = to - ip->bw_conv_buf;
5214 buf = to;
5215 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5216 if (FIO_GET_CP(flags) == CP_UTF8)
5218 /* Convert from UCS-2 to UTF-8, using the remainder of the
5219 * conversion buffer. Fails when out of space. */
5220 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5222 u8c = *from++;
5223 u8c += (*from++ << 8);
5224 to += utf_char2bytes(u8c, to);
5225 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5227 ip->bw_conv_error = TRUE;
5228 return FAIL;
5231 len = (int)(to - buf);
5233 else
5234 #endif
5236 /* Convert from UCS-2 to the codepage, using the remainder of
5237 * the conversion buffer. If the conversion uses the default
5238 * character "0", the data doesn't fit in this encoding, so
5239 * fail. */
5240 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5241 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5242 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0,
5243 &bad);
5244 if (bad)
5246 ip->bw_conv_error = TRUE;
5247 return FAIL;
5251 # endif
5253 # ifdef MACOS_CONVERT
5254 else if (flags & FIO_MACROMAN)
5257 * Convert UTF-8 or latin1 to Apple MacRoman.
5259 char_u *from;
5260 size_t fromlen;
5262 if (ip->bw_restlen > 0)
5264 /* Need to concatenate the remainder of the previous call and
5265 * the bytes of the current call. Use the end of the
5266 * conversion buffer for this. */
5267 fromlen = len + ip->bw_restlen;
5268 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5269 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5270 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5272 else
5274 from = buf;
5275 fromlen = len;
5278 if (enc2macroman(from, fromlen,
5279 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5280 ip->bw_rest, &ip->bw_restlen) == FAIL)
5282 ip->bw_conv_error = TRUE;
5283 return FAIL;
5285 buf = ip->bw_conv_buf;
5287 # endif
5289 # ifdef USE_ICONV
5290 if (ip->bw_iconv_fd != (iconv_t)-1)
5292 const char *from;
5293 size_t fromlen;
5294 char *to;
5295 size_t tolen;
5297 /* Convert with iconv(). */
5298 if (ip->bw_restlen > 0)
5300 char *fp;
5302 /* Need to concatenate the remainder of the previous call and
5303 * the bytes of the current call. Use the end of the
5304 * conversion buffer for this. */
5305 fromlen = len + ip->bw_restlen;
5306 fp = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5307 mch_memmove(fp, ip->bw_rest, (size_t)ip->bw_restlen);
5308 mch_memmove(fp + ip->bw_restlen, buf, (size_t)len);
5309 from = fp;
5310 tolen = ip->bw_conv_buflen - fromlen;
5312 else
5314 from = (const char *)buf;
5315 fromlen = len;
5316 tolen = ip->bw_conv_buflen;
5318 to = (char *)ip->bw_conv_buf;
5320 if (ip->bw_first)
5322 size_t save_len = tolen;
5324 /* output the initial shift state sequence */
5325 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5327 /* There is a bug in iconv() on Linux (which appears to be
5328 * wide-spread) which sets "to" to NULL and messes up "tolen".
5330 if (to == NULL)
5332 to = (char *)ip->bw_conv_buf;
5333 tolen = save_len;
5335 ip->bw_first = FALSE;
5339 * If iconv() has an error or there is not enough room, fail.
5341 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5342 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5343 || fromlen > CONV_RESTLEN)
5345 ip->bw_conv_error = TRUE;
5346 return FAIL;
5349 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5350 if (fromlen > 0)
5351 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5352 ip->bw_restlen = (int)fromlen;
5354 buf = ip->bw_conv_buf;
5355 len = (int)((char_u *)to - ip->bw_conv_buf);
5357 # endif
5359 #endif /* FEAT_MBYTE */
5361 #ifdef FEAT_CRYPT
5362 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5364 int ztemp, t, i;
5366 for (i = 0; i < len; i++)
5368 ztemp = buf[i];
5369 buf[i] = ZENCODE(ztemp, t);
5372 #endif
5374 /* Repeat the write(), it may be interrupted by a signal. */
5375 while (len > 0)
5377 wlen = vim_write(ip->bw_fd, buf, len);
5378 if (wlen <= 0) /* error! */
5379 return FAIL;
5380 len -= wlen;
5381 buf += wlen;
5383 return OK;
5386 #ifdef FEAT_MBYTE
5388 * Convert a Unicode character to bytes.
5390 static int
5391 ucs2bytes(c, pp, flags)
5392 unsigned c; /* in: character */
5393 char_u **pp; /* in/out: pointer to result */
5394 int flags; /* FIO_ flags */
5396 char_u *p = *pp;
5397 int error = FALSE;
5398 int cc;
5401 if (flags & FIO_UCS4)
5403 if (flags & FIO_ENDIAN_L)
5405 *p++ = c;
5406 *p++ = (c >> 8);
5407 *p++ = (c >> 16);
5408 *p++ = (c >> 24);
5410 else
5412 *p++ = (c >> 24);
5413 *p++ = (c >> 16);
5414 *p++ = (c >> 8);
5415 *p++ = c;
5418 else if (flags & (FIO_UCS2 | FIO_UTF16))
5420 if (c >= 0x10000)
5422 if (flags & FIO_UTF16)
5424 /* Make two words, ten bits of the character in each. First
5425 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5426 c -= 0x10000;
5427 if (c >= 0x100000)
5428 error = TRUE;
5429 cc = ((c >> 10) & 0x3ff) + 0xd800;
5430 if (flags & FIO_ENDIAN_L)
5432 *p++ = cc;
5433 *p++ = ((unsigned)cc >> 8);
5435 else
5437 *p++ = ((unsigned)cc >> 8);
5438 *p++ = cc;
5440 c = (c & 0x3ff) + 0xdc00;
5442 else
5443 error = TRUE;
5445 if (flags & FIO_ENDIAN_L)
5447 *p++ = c;
5448 *p++ = (c >> 8);
5450 else
5452 *p++ = (c >> 8);
5453 *p++ = c;
5456 else /* Latin1 */
5458 if (c >= 0x100)
5460 error = TRUE;
5461 *p++ = 0xBF;
5463 else
5464 *p++ = c;
5467 *pp = p;
5468 return error;
5472 * Return TRUE if "a" and "b" are the same 'encoding'.
5473 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5475 static int
5476 same_encoding(a, b)
5477 char_u *a;
5478 char_u *b;
5480 int f;
5482 if (STRCMP(a, b) == 0)
5483 return TRUE;
5484 f = get_fio_flags(a);
5485 return (f != 0 && get_fio_flags(b) == f);
5489 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5490 * internal conversion.
5491 * if "ptr" is an empty string, use 'encoding'.
5493 static int
5494 get_fio_flags(ptr)
5495 char_u *ptr;
5497 int prop;
5499 if (*ptr == NUL)
5500 ptr = p_enc;
5502 prop = enc_canon_props(ptr);
5503 if (prop & ENC_UNICODE)
5505 if (prop & ENC_2BYTE)
5507 if (prop & ENC_ENDIAN_L)
5508 return FIO_UCS2 | FIO_ENDIAN_L;
5509 return FIO_UCS2;
5511 if (prop & ENC_4BYTE)
5513 if (prop & ENC_ENDIAN_L)
5514 return FIO_UCS4 | FIO_ENDIAN_L;
5515 return FIO_UCS4;
5517 if (prop & ENC_2WORD)
5519 if (prop & ENC_ENDIAN_L)
5520 return FIO_UTF16 | FIO_ENDIAN_L;
5521 return FIO_UTF16;
5523 return FIO_UTF8;
5525 if (prop & ENC_LATIN1)
5526 return FIO_LATIN1;
5527 /* must be ENC_DBCS, requires iconv() */
5528 return 0;
5531 #ifdef WIN3264
5533 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5534 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5535 * Used for conversion between 'encoding' and 'fileencoding'.
5537 static int
5538 get_win_fio_flags(ptr)
5539 char_u *ptr;
5541 int cp;
5543 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5544 if (!enc_utf8 && enc_codepage <= 0)
5545 return 0;
5547 cp = encname2codepage(ptr);
5548 if (cp == 0)
5550 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5551 if (STRCMP(ptr, "utf-8") == 0)
5552 cp = CP_UTF8;
5553 else
5554 # endif
5555 return 0;
5557 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5559 #endif
5561 #ifdef MACOS_X
5563 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5564 * needed for the internal conversion to/from utf-8 or latin1.
5566 static int
5567 get_mac_fio_flags(ptr)
5568 char_u *ptr;
5570 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5571 && (enc_canon_props(ptr) & ENC_MACROMAN))
5572 return FIO_MACROMAN;
5573 return 0;
5575 #endif
5578 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5579 * "size" must be at least 2.
5580 * Return the name of the encoding and set "*lenp" to the length.
5581 * Returns NULL when no BOM found.
5583 static char_u *
5584 check_for_bom(p, size, lenp, flags)
5585 char_u *p;
5586 long size;
5587 int *lenp;
5588 int flags;
5590 char *name = NULL;
5591 int len = 2;
5593 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5594 && (flags == FIO_ALL || flags == FIO_UTF8 || flags == 0))
5596 name = "utf-8"; /* EF BB BF */
5597 len = 3;
5599 else if (p[0] == 0xff && p[1] == 0xfe)
5601 if (size >= 4 && p[2] == 0 && p[3] == 0
5602 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5604 name = "ucs-4le"; /* FF FE 00 00 */
5605 len = 4;
5607 else if (flags == (FIO_UCS2 | FIO_ENDIAN_L))
5608 name = "ucs-2le"; /* FF FE */
5609 else if (flags == FIO_ALL || flags == (FIO_UTF16 | FIO_ENDIAN_L))
5610 /* utf-16le is preferred, it also works for ucs-2le text */
5611 name = "utf-16le"; /* FF FE */
5613 else if (p[0] == 0xfe && p[1] == 0xff
5614 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5616 /* Default to utf-16, it works also for ucs-2 text. */
5617 if (flags == FIO_UCS2)
5618 name = "ucs-2"; /* FE FF */
5619 else
5620 name = "utf-16"; /* FE FF */
5622 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5623 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5625 name = "ucs-4"; /* 00 00 FE FF */
5626 len = 4;
5629 *lenp = len;
5630 return (char_u *)name;
5634 * Generate a BOM in "buf[4]" for encoding "name".
5635 * Return the length of the BOM (zero when no BOM).
5637 static int
5638 make_bom(buf, name)
5639 char_u *buf;
5640 char_u *name;
5642 int flags;
5643 char_u *p;
5645 flags = get_fio_flags(name);
5647 /* Can't put a BOM in a non-Unicode file. */
5648 if (flags == FIO_LATIN1 || flags == 0)
5649 return 0;
5651 if (flags == FIO_UTF8) /* UTF-8 */
5653 buf[0] = 0xef;
5654 buf[1] = 0xbb;
5655 buf[2] = 0xbf;
5656 return 3;
5658 p = buf;
5659 (void)ucs2bytes(0xfeff, &p, flags);
5660 return (int)(p - buf);
5662 #endif
5664 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5665 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5667 * Try to find a shortname by comparing the fullname with the current
5668 * directory.
5669 * Returns "full_path" or pointer into "full_path" if shortened.
5671 char_u *
5672 shorten_fname1(full_path)
5673 char_u *full_path;
5675 char_u dirname[MAXPATHL];
5676 char_u *p = full_path;
5678 if (mch_dirname(dirname, MAXPATHL) == OK)
5680 p = shorten_fname(full_path, dirname);
5681 if (p == NULL || *p == NUL)
5682 p = full_path;
5684 return p;
5686 #endif
5689 * Try to find a shortname by comparing the fullname with the current
5690 * directory.
5691 * Returns NULL if not shorter name possible, pointer into "full_path"
5692 * otherwise.
5694 char_u *
5695 shorten_fname(full_path, dir_name)
5696 char_u *full_path;
5697 char_u *dir_name;
5699 int len;
5700 char_u *p;
5702 if (full_path == NULL)
5703 return NULL;
5704 len = (int)STRLEN(dir_name);
5705 if (fnamencmp(dir_name, full_path, len) == 0)
5707 p = full_path + len;
5708 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5710 * MSDOS: when a file is in the root directory, dir_name will end in a
5711 * slash, since C: by itself does not define a specific dir. In this
5712 * case p may already be correct. <negri>
5714 if (!((len > 2) && (*(p - 2) == ':')))
5715 #endif
5717 if (vim_ispathsep(*p))
5718 ++p;
5719 #ifndef VMS /* the path separator is always part of the path */
5720 else
5721 p = NULL;
5722 #endif
5725 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5727 * When using a file in the current drive, remove the drive name:
5728 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5729 * a floppy from "A:\dir" to "B:\dir".
5731 else if (len > 3
5732 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5733 && full_path[1] == ':'
5734 && vim_ispathsep(full_path[2]))
5735 p = full_path + 2;
5736 #endif
5737 else
5738 p = NULL;
5739 return p;
5743 * Shorten filenames for all buffers.
5744 * When "force" is TRUE: Use full path from now on for files currently being
5745 * edited, both for file name and swap file name. Try to shorten the file
5746 * names a bit, if safe to do so.
5747 * When "force" is FALSE: Only try to shorten absolute file names.
5748 * For buffers that have buftype "nofile" or "scratch": never change the file
5749 * name.
5751 void
5752 shorten_fnames(force)
5753 int force;
5755 char_u dirname[MAXPATHL];
5756 buf_T *buf;
5757 char_u *p;
5759 mch_dirname(dirname, MAXPATHL);
5760 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5762 if (buf->b_fname != NULL
5763 #ifdef FEAT_QUICKFIX
5764 && !bt_nofile(buf)
5765 #endif
5766 && !path_with_url(buf->b_fname)
5767 && (force
5768 || buf->b_sfname == NULL
5769 || mch_isFullName(buf->b_sfname)))
5771 vim_free(buf->b_sfname);
5772 buf->b_sfname = NULL;
5773 p = shorten_fname(buf->b_ffname, dirname);
5774 if (p != NULL)
5776 buf->b_sfname = vim_strsave(p);
5777 buf->b_fname = buf->b_sfname;
5779 if (p == NULL || buf->b_fname == NULL)
5780 buf->b_fname = buf->b_ffname;
5783 /* Always make the swap file name a full path, a "nofile" buffer may
5784 * also have a swap file. */
5785 mf_fullname(buf->b_ml.ml_mfp);
5787 #ifdef FEAT_WINDOWS
5788 status_redraw_all();
5789 redraw_tabline = TRUE;
5790 #endif
5793 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5794 || defined(FEAT_GUI_MSWIN) \
5795 || defined(FEAT_GUI_MAC) \
5796 || defined(PROTO)
5798 * Shorten all filenames in "fnames[count]" by current directory.
5800 void
5801 shorten_filenames(fnames, count)
5802 char_u **fnames;
5803 int count;
5805 int i;
5806 char_u dirname[MAXPATHL];
5807 char_u *p;
5809 if (fnames == NULL || count < 1)
5810 return;
5811 mch_dirname(dirname, sizeof(dirname));
5812 for (i = 0; i < count; ++i)
5814 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5816 /* shorten_fname() returns pointer in given "fnames[i]". If free
5817 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5818 * "p" first then free fnames[i]. */
5819 p = vim_strsave(p);
5820 vim_free(fnames[i]);
5821 fnames[i] = p;
5825 #endif
5828 * add extension to file name - change path/fo.o.h to path/fo.o.h.ext or
5829 * fo_o_h.ext for MSDOS or when shortname option set.
5831 * Assumed that fname is a valid name found in the filesystem we assure that
5832 * the return value is a different name and ends in 'ext'.
5833 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5834 * characters otherwise.
5835 * Space for the returned name is allocated, must be freed later.
5836 * Returns NULL when out of memory.
5838 char_u *
5839 modname(fname, ext, prepend_dot)
5840 char_u *fname, *ext;
5841 int prepend_dot; /* may prepend a '.' to file name */
5843 return buf_modname(
5844 #ifdef SHORT_FNAME
5845 TRUE,
5846 #else
5847 (curbuf->b_p_sn || curbuf->b_shortname),
5848 #endif
5849 fname, ext, prepend_dot);
5852 char_u *
5853 buf_modname(shortname, fname, ext, prepend_dot)
5854 int shortname; /* use 8.3 file name */
5855 char_u *fname, *ext;
5856 int prepend_dot; /* may prepend a '.' to file name */
5858 char_u *retval;
5859 char_u *s;
5860 char_u *e;
5861 char_u *ptr;
5862 int fnamelen, extlen;
5864 extlen = (int)STRLEN(ext);
5867 * If there is no file name we must get the name of the current directory
5868 * (we need the full path in case :cd is used).
5870 if (fname == NULL || *fname == NUL)
5872 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5873 if (retval == NULL)
5874 return NULL;
5875 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5876 (fnamelen = (int)STRLEN(retval)) == 0)
5878 vim_free(retval);
5879 return NULL;
5881 if (!after_pathsep(retval, retval + fnamelen))
5883 retval[fnamelen++] = PATHSEP;
5884 retval[fnamelen] = NUL;
5886 #ifndef SHORT_FNAME
5887 prepend_dot = FALSE; /* nothing to prepend a dot to */
5888 #endif
5890 else
5892 fnamelen = (int)STRLEN(fname);
5893 retval = alloc((unsigned)(fnamelen + extlen + 3));
5894 if (retval == NULL)
5895 return NULL;
5896 STRCPY(retval, fname);
5897 #ifdef VMS
5898 vms_remove_version(retval); /* we do not need versions here */
5899 #endif
5903 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5904 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5905 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5906 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5908 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5910 #ifndef RISCOS
5911 if (*ext == '.'
5912 # ifdef USE_LONG_FNAME
5913 && (!USE_LONG_FNAME || shortname)
5914 # else
5915 # ifndef SHORT_FNAME
5916 && shortname
5917 # endif
5918 # endif
5920 if (*ptr == '.') /* replace '.' by '_' */
5921 *ptr = '_';
5922 #endif
5923 if (vim_ispathsep(*ptr))
5925 ++ptr;
5926 break;
5930 /* the file name has at most BASENAMELEN characters. */
5931 #ifndef SHORT_FNAME
5932 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5933 ptr[BASENAMELEN] = '\0';
5934 #endif
5936 s = ptr + STRLEN(ptr);
5939 * For 8.3 file names we may have to reduce the length.
5941 #ifdef USE_LONG_FNAME
5942 if (!USE_LONG_FNAME || shortname)
5943 #else
5944 # ifndef SHORT_FNAME
5945 if (shortname)
5946 # endif
5947 #endif
5950 * If there is no file name, or the file name ends in '/', and the
5951 * extension starts with '.', put a '_' before the dot, because just
5952 * ".ext" is invalid.
5954 if (fname == NULL || *fname == NUL
5955 || vim_ispathsep(fname[STRLEN(fname) - 1]))
5957 #ifdef RISCOS
5958 if (*ext == '/')
5959 #else
5960 if (*ext == '.')
5961 #endif
5962 *s++ = '_';
5965 * If the extension starts with '.', truncate the base name at 8
5966 * characters
5968 #ifdef RISCOS
5969 /* We normally use '/', but swap files are '_' */
5970 else if (*ext == '/' || *ext == '_')
5971 #else
5972 else if (*ext == '.')
5973 #endif
5975 if ((size_t)(s - ptr) > (size_t)8)
5977 s = ptr + 8;
5978 *s = '\0';
5982 * If the extension doesn't start with '.', and the file name
5983 * doesn't have an extension yet, append a '.'
5985 #ifdef RISCOS
5986 else if ((e = vim_strchr(ptr, '/')) == NULL)
5987 *s++ = '/';
5988 #else
5989 else if ((e = vim_strchr(ptr, '.')) == NULL)
5990 *s++ = '.';
5991 #endif
5993 * If the extension doesn't start with '.', and there already is an
5994 * extension, it may need to be truncated
5996 else if ((int)STRLEN(e) + extlen > 4)
5997 s = e + 4 - extlen;
5999 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
6001 * If there is no file name, and the extension starts with '.', put a
6002 * '_' before the dot, because just ".ext" may be invalid if it's on a
6003 * FAT partition, and on HPFS it doesn't matter.
6005 else if ((fname == NULL || *fname == NUL) && *ext == '.')
6006 *s++ = '_';
6007 #endif
6010 * Append the extension.
6011 * ext can start with '.' and cannot exceed 3 more characters.
6013 STRCPY(s, ext);
6015 #ifndef SHORT_FNAME
6017 * Prepend the dot.
6019 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
6020 #ifdef RISCOS
6022 #else
6024 #endif
6025 #ifdef USE_LONG_FNAME
6026 && USE_LONG_FNAME
6027 #endif
6030 STRMOVE(e + 1, e);
6031 #ifdef RISCOS
6032 *e = '/';
6033 #else
6034 *e = '.';
6035 #endif
6037 #endif
6040 * Check that, after appending the extension, the file name is really
6041 * different.
6043 if (fname != NULL && STRCMP(fname, retval) == 0)
6045 /* we search for a character that can be replaced by '_' */
6046 while (--s >= ptr)
6048 if (*s != '_')
6050 *s = '_';
6051 break;
6054 if (s < ptr) /* fname was "________.<ext>", how tricky! */
6055 *ptr = 'v';
6057 return retval;
6061 * Like fgets(), but if the file line is too long, it is truncated and the
6062 * rest of the line is thrown away. Returns TRUE for end-of-file.
6065 vim_fgets(buf, size, fp)
6066 char_u *buf;
6067 int size;
6068 FILE *fp;
6070 char *eof;
6071 #define FGETS_SIZE 200
6072 char tbuf[FGETS_SIZE];
6074 buf[size - 2] = NUL;
6075 #ifdef USE_CR
6076 eof = fgets_cr((char *)buf, size, fp);
6077 #else
6078 eof = fgets((char *)buf, size, fp);
6079 #endif
6080 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
6082 buf[size - 1] = NUL; /* Truncate the line */
6084 /* Now throw away the rest of the line: */
6087 tbuf[FGETS_SIZE - 2] = NUL;
6088 #ifdef USE_CR
6089 ignoredp = fgets_cr((char *)tbuf, FGETS_SIZE, fp);
6090 #else
6091 ignoredp = fgets((char *)tbuf, FGETS_SIZE, fp);
6092 #endif
6093 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
6095 return (eof == NULL);
6098 #if defined(USE_CR) || defined(PROTO)
6100 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6101 * Returns TRUE for end-of-file.
6102 * Only used for the Mac, because it's much slower than vim_fgets().
6105 tag_fgets(buf, size, fp)
6106 char_u *buf;
6107 int size;
6108 FILE *fp;
6110 int i = 0;
6111 int c;
6112 int eof = FALSE;
6114 for (;;)
6116 c = fgetc(fp);
6117 if (c == EOF)
6119 eof = TRUE;
6120 break;
6122 if (c == '\r')
6124 /* Always store a NL for end-of-line. */
6125 if (i < size - 1)
6126 buf[i++] = '\n';
6127 c = fgetc(fp);
6128 if (c != '\n') /* Macintosh format: single CR. */
6129 ungetc(c, fp);
6130 break;
6132 if (i < size - 1)
6133 buf[i++] = c;
6134 if (c == '\n')
6135 break;
6137 buf[i] = NUL;
6138 return eof;
6140 #endif
6143 * rename() only works if both files are on the same file system, this
6144 * function will (attempts to?) copy the file across if rename fails -- webb
6145 * Return -1 for failure, 0 for success.
6148 vim_rename(from, to)
6149 char_u *from;
6150 char_u *to;
6152 int fd_in;
6153 int fd_out;
6154 int n;
6155 char *errmsg = NULL;
6156 char *buffer;
6157 #ifdef AMIGA
6158 BPTR flock;
6159 #endif
6160 struct stat st;
6161 long perm;
6162 #ifdef HAVE_ACL
6163 vim_acl_T acl; /* ACL from original file */
6164 #endif
6165 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6166 int use_tmp_file = FALSE;
6167 #endif
6170 * When the names are identical, there is nothing to do. When they refer
6171 * to the same file (ignoring case and slash/backslash differences) but
6172 * the file name differs we need to go through a temp file.
6174 if (fnamecmp(from, to) == 0)
6176 #ifdef CASE_INSENSITIVE_FILENAME
6177 if (STRCMP(gettail(from), gettail(to)) != 0)
6178 use_tmp_file = TRUE;
6179 else
6180 #endif
6181 return 0;
6185 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6187 if (mch_stat((char *)from, &st) < 0)
6188 return -1;
6190 #ifdef UNIX
6192 struct stat st_to;
6194 /* It's possible for the source and destination to be the same file.
6195 * This happens when "from" and "to" differ in case and are on a FAT32
6196 * filesystem. In that case go through a temp file name. */
6197 if (mch_stat((char *)to, &st_to) >= 0
6198 && st.st_dev == st_to.st_dev
6199 && st.st_ino == st_to.st_ino)
6200 use_tmp_file = TRUE;
6202 #endif
6204 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6205 if (use_tmp_file)
6207 char tempname[MAXPATHL + 1];
6210 * Find a name that doesn't exist and is in the same directory.
6211 * Rename "from" to "tempname" and then rename "tempname" to "to".
6213 if (STRLEN(from) >= MAXPATHL - 5)
6214 return -1;
6215 STRCPY(tempname, from);
6216 for (n = 123; n < 99999; ++n)
6218 sprintf((char *)gettail((char_u *)tempname), "%d", n);
6219 if (mch_stat(tempname, &st) < 0)
6221 if (mch_rename((char *)from, tempname) == 0)
6223 if (mch_rename(tempname, (char *)to) == 0)
6224 return 0;
6225 /* Strange, the second step failed. Try moving the
6226 * file back and return failure. */
6227 mch_rename(tempname, (char *)from);
6228 return -1;
6230 /* If it fails for one temp name it will most likely fail
6231 * for any temp name, give up. */
6232 return -1;
6235 return -1;
6237 #endif
6240 * Delete the "to" file, this is required on some systems to make the
6241 * mch_rename() work, on other systems it makes sure that we don't have
6242 * two files when the mch_rename() fails.
6245 #ifdef AMIGA
6247 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6248 * that the name of the "to" file is the same as the "from" file, even
6249 * though the names are different. To avoid the chance of accidentally
6250 * deleting the "from" file (horror!) we lock it during the remove.
6252 * When used for making a backup before writing the file: This should not
6253 * happen with ":w", because startscript() should detect this problem and
6254 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6255 * name. This problem does exist with ":w filename", but then the
6256 * original file will be somewhere else so the backup isn't really
6257 * important. If autoscripting is off the rename may fail.
6259 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6260 #endif
6261 mch_remove(to);
6262 #ifdef AMIGA
6263 if (flock)
6264 UnLock(flock);
6265 #endif
6268 * First try a normal rename, return if it works.
6270 if (mch_rename((char *)from, (char *)to) == 0)
6271 return 0;
6274 * Rename() failed, try copying the file.
6276 perm = mch_getperm(from);
6277 #ifdef HAVE_ACL
6278 /* For systems that support ACL: get the ACL from the original file. */
6279 acl = mch_get_acl(from);
6280 #endif
6281 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6282 if (fd_in == -1)
6284 #ifdef HAVE_ACL
6285 mch_free_acl(acl);
6286 #endif
6287 return -1;
6290 /* Create the new file with same permissions as the original. */
6291 fd_out = mch_open((char *)to,
6292 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6293 if (fd_out == -1)
6295 close(fd_in);
6296 #ifdef HAVE_ACL
6297 mch_free_acl(acl);
6298 #endif
6299 return -1;
6302 buffer = (char *)alloc(BUFSIZE);
6303 if (buffer == NULL)
6305 close(fd_out);
6306 close(fd_in);
6307 #ifdef HAVE_ACL
6308 mch_free_acl(acl);
6309 #endif
6310 return -1;
6313 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6314 if (vim_write(fd_out, buffer, n) != n)
6316 errmsg = _("E208: Error writing to \"%s\"");
6317 break;
6320 vim_free(buffer);
6321 close(fd_in);
6322 if (close(fd_out) < 0)
6323 errmsg = _("E209: Error closing \"%s\"");
6324 if (n < 0)
6326 errmsg = _("E210: Error reading \"%s\"");
6327 to = from;
6329 #ifndef UNIX /* for Unix mch_open() already set the permission */
6330 mch_setperm(to, perm);
6331 #endif
6332 #ifdef HAVE_ACL
6333 mch_set_acl(to, acl);
6334 mch_free_acl(acl);
6335 #endif
6336 if (errmsg != NULL)
6338 EMSG2(errmsg, to);
6339 return -1;
6341 mch_remove(from);
6342 return 0;
6345 static int already_warned = FALSE;
6348 * Check if any not hidden buffer has been changed.
6349 * Postpone the check if there are characters in the stuff buffer, a global
6350 * command is being executed, a mapping is being executed or an autocommand is
6351 * busy.
6352 * Returns TRUE if some message was written (screen should be redrawn and
6353 * cursor positioned).
6356 check_timestamps(focus)
6357 int focus; /* called for GUI focus event */
6359 buf_T *buf;
6360 int didit = 0;
6361 int n;
6363 /* Don't check timestamps while system() or another low-level function may
6364 * cause us to lose and gain focus. */
6365 if (no_check_timestamps > 0)
6366 return FALSE;
6368 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6369 * event and we would keep on checking if the file is steadily growing.
6370 * Do check again after typing something. */
6371 if (focus && did_check_timestamps)
6373 need_check_timestamps = TRUE;
6374 return FALSE;
6377 if (!stuff_empty() || global_busy || !typebuf_typed()
6378 #ifdef FEAT_AUTOCMD
6379 || autocmd_busy || curbuf_lock > 0 || allbuf_lock > 0
6380 #endif
6382 need_check_timestamps = TRUE; /* check later */
6383 else
6385 ++no_wait_return;
6386 did_check_timestamps = TRUE;
6387 already_warned = FALSE;
6388 for (buf = firstbuf; buf != NULL; )
6390 /* Only check buffers in a window. */
6391 if (buf->b_nwindows > 0)
6393 n = buf_check_timestamp(buf, focus);
6394 if (didit < n)
6395 didit = n;
6396 if (n > 0 && !buf_valid(buf))
6398 /* Autocommands have removed the buffer, start at the
6399 * first one again. */
6400 buf = firstbuf;
6401 continue;
6404 buf = buf->b_next;
6406 --no_wait_return;
6407 need_check_timestamps = FALSE;
6408 if (need_wait_return && didit == 2)
6410 /* make sure msg isn't overwritten */
6411 msg_puts((char_u *)"\n");
6412 out_flush();
6415 return didit;
6419 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6420 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6421 * empty.
6423 static int
6424 move_lines(frombuf, tobuf)
6425 buf_T *frombuf;
6426 buf_T *tobuf;
6428 buf_T *tbuf = curbuf;
6429 int retval = OK;
6430 linenr_T lnum;
6431 char_u *p;
6433 /* Copy the lines in "frombuf" to "tobuf". */
6434 curbuf = tobuf;
6435 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6437 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6438 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6440 vim_free(p);
6441 retval = FAIL;
6442 break;
6444 vim_free(p);
6447 /* Delete all the lines in "frombuf". */
6448 if (retval != FAIL)
6450 curbuf = frombuf;
6451 for (lnum = curbuf->b_ml.ml_line_count; lnum > 0; --lnum)
6452 if (ml_delete(lnum, FALSE) == FAIL)
6454 /* Oops! We could try putting back the saved lines, but that
6455 * might fail again... */
6456 retval = FAIL;
6457 break;
6461 curbuf = tbuf;
6462 return retval;
6466 * Check if buffer "buf" has been changed.
6467 * Also check if the file for a new buffer unexpectedly appeared.
6468 * return 1 if a changed buffer was found.
6469 * return 2 if a message has been displayed.
6470 * return 0 otherwise.
6473 buf_check_timestamp(buf, focus)
6474 buf_T *buf;
6475 int focus UNUSED; /* called for GUI focus event */
6477 struct stat st;
6478 int stat_res;
6479 int retval = 0;
6480 char_u *path;
6481 char_u *tbuf;
6482 char *mesg = NULL;
6483 char *mesg2 = "";
6484 int helpmesg = FALSE;
6485 int reload = FALSE;
6486 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6487 int can_reload = FALSE;
6488 #endif
6489 size_t orig_size = buf->b_orig_size;
6490 int orig_mode = buf->b_orig_mode;
6491 #ifdef FEAT_GUI
6492 int save_mouse_correct = need_mouse_correct;
6493 #endif
6494 #ifdef FEAT_AUTOCMD
6495 static int busy = FALSE;
6496 int n;
6497 char_u *s;
6498 #endif
6499 char *reason;
6501 /* If there is no file name, the buffer is not loaded, 'buftype' is
6502 * set, we are in the middle of a save or being called recursively: ignore
6503 * this buffer. */
6504 if (buf->b_ffname == NULL
6505 || buf->b_ml.ml_mfp == NULL
6506 #if defined(FEAT_QUICKFIX)
6507 || *buf->b_p_bt != NUL
6508 #endif
6509 || buf->b_saving
6510 #ifdef FEAT_AUTOCMD
6511 || busy
6512 #endif
6513 #ifdef FEAT_NETBEANS_INTG
6514 || isNetbeansBuffer(buf)
6515 #endif
6517 return 0;
6519 if ( !(buf->b_flags & BF_NOTEDITED)
6520 && buf->b_mtime != 0
6521 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6522 || time_differs((long)st.st_mtime, buf->b_mtime)
6523 #ifdef HAVE_ST_MODE
6524 || (int)st.st_mode != buf->b_orig_mode
6525 #else
6526 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6527 #endif
6530 retval = 1;
6532 /* set b_mtime to stop further warnings (e.g., when executing
6533 * FileChangedShell autocmd) */
6534 if (stat_res < 0)
6536 buf->b_mtime = 0;
6537 buf->b_orig_size = 0;
6538 buf->b_orig_mode = 0;
6540 else
6541 buf_store_time(buf, &st, buf->b_ffname);
6543 /* Don't do anything for a directory. Might contain the file
6544 * explorer. */
6545 if (mch_isdir(buf->b_fname))
6549 * If 'autoread' is set, the buffer has no changes and the file still
6550 * exists, reload the buffer. Use the buffer-local option value if it
6551 * was set, the global option value otherwise.
6553 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6554 && !bufIsChanged(buf) && stat_res >= 0)
6555 reload = TRUE;
6556 else
6558 if (stat_res < 0)
6559 reason = "deleted";
6560 else if (bufIsChanged(buf))
6561 reason = "conflict";
6562 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6563 reason = "changed";
6564 else if (orig_mode != buf->b_orig_mode)
6565 reason = "mode";
6566 else
6567 reason = "time";
6569 #ifdef FEAT_AUTOCMD
6571 * Only give the warning if there are no FileChangedShell
6572 * autocommands.
6573 * Avoid being called recursively by setting "busy".
6575 busy = TRUE;
6576 # ifdef FEAT_EVAL
6577 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6578 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6579 # endif
6580 ++allbuf_lock;
6581 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6582 buf->b_fname, buf->b_fname, FALSE, buf);
6583 --allbuf_lock;
6584 busy = FALSE;
6585 if (n)
6587 if (!buf_valid(buf))
6588 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6589 # ifdef FEAT_EVAL
6590 s = get_vim_var_str(VV_FCS_CHOICE);
6591 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6592 reload = TRUE;
6593 else if (STRCMP(s, "ask") == 0)
6594 n = FALSE;
6595 else
6596 # endif
6597 return 2;
6599 if (!n)
6600 #endif
6602 if (*reason == 'd')
6603 mesg = _("E211: File \"%s\" no longer available");
6604 else
6606 helpmesg = TRUE;
6607 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6608 can_reload = TRUE;
6609 #endif
6611 * Check if the file contents really changed to avoid
6612 * giving a warning when only the timestamp was set (e.g.,
6613 * checked out of CVS). Always warn when the buffer was
6614 * changed.
6616 if (reason[2] == 'n')
6618 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6619 mesg2 = _("See \":help W12\" for more info.");
6621 else if (reason[1] == 'h')
6623 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6624 mesg2 = _("See \":help W11\" for more info.");
6626 else if (*reason == 'm')
6628 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6629 mesg2 = _("See \":help W16\" for more info.");
6631 else
6632 /* Only timestamp changed, store it to avoid a warning
6633 * in check_mtime() later. */
6634 buf->b_mtime_read = buf->b_mtime;
6640 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6641 && vim_fexists(buf->b_ffname))
6643 retval = 1;
6644 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6645 buf->b_flags |= BF_NEW_W;
6646 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6647 can_reload = TRUE;
6648 #endif
6651 if (mesg != NULL)
6653 path = home_replace_save(buf, buf->b_fname);
6654 if (path != NULL)
6656 if (!helpmesg)
6657 mesg2 = "";
6658 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6659 + STRLEN(mesg2) + 2));
6660 sprintf((char *)tbuf, mesg, path);
6661 #ifdef FEAT_EVAL
6662 /* Set warningmsg here, before the unimportant and output-specific
6663 * mesg2 has been appended. */
6664 set_vim_var_string(VV_WARNINGMSG, tbuf, -1);
6665 #endif
6666 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6667 if (can_reload)
6669 if (*mesg2 != NUL)
6671 STRCAT(tbuf, "\n");
6672 STRCAT(tbuf, mesg2);
6674 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6675 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6676 reload = TRUE;
6678 else
6679 #endif
6680 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6682 if (*mesg2 != NUL)
6684 STRCAT(tbuf, "; ");
6685 STRCAT(tbuf, mesg2);
6687 EMSG(tbuf);
6688 retval = 2;
6690 else
6692 # ifdef FEAT_AUTOCMD
6693 if (!autocmd_busy)
6694 # endif
6696 msg_start();
6697 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6698 if (*mesg2 != NUL)
6699 msg_puts_attr((char_u *)mesg2,
6700 hl_attr(HLF_W) + MSG_HIST);
6701 msg_clr_eos();
6702 (void)msg_end();
6703 if (emsg_silent == 0)
6705 out_flush();
6706 # ifdef FEAT_GUI
6707 if (!focus)
6708 # endif
6709 /* give the user some time to think about it */
6710 ui_delay(1000L, TRUE);
6712 /* don't redraw and erase the message */
6713 redraw_cmdline = FALSE;
6716 already_warned = TRUE;
6719 vim_free(path);
6720 vim_free(tbuf);
6724 if (reload)
6725 /* Reload the buffer. */
6726 buf_reload(buf, orig_mode);
6728 #ifdef FEAT_AUTOCMD
6729 /* Trigger FileChangedShell when the file was changed in any way. */
6730 if (buf_valid(buf) && retval != 0)
6731 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6732 buf->b_fname, buf->b_fname, FALSE, buf);
6733 #endif
6734 #ifdef FEAT_GUI
6735 /* restore this in case an autocommand has set it; it would break
6736 * 'mousefocus' */
6737 need_mouse_correct = save_mouse_correct;
6738 #endif
6740 return retval;
6744 * Reload a buffer that is already loaded.
6745 * Used when the file was changed outside of Vim.
6746 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6747 * buf->b_orig_mode may have been reset already.
6749 void
6750 buf_reload(buf, orig_mode)
6751 buf_T *buf;
6752 int orig_mode;
6754 exarg_T ea;
6755 pos_T old_cursor;
6756 linenr_T old_topline;
6757 int old_ro = buf->b_p_ro;
6758 buf_T *savebuf;
6759 int saved = OK;
6760 aco_save_T aco;
6762 /* set curwin/curbuf for "buf" and save some things */
6763 aucmd_prepbuf(&aco, buf);
6765 /* We only want to read the text from the file, not reset the syntax
6766 * highlighting, clear marks, diff status, etc. Force the fileformat
6767 * and encoding to be the same. */
6768 if (prep_exarg(&ea, buf) == OK)
6770 old_cursor = curwin->w_cursor;
6771 old_topline = curwin->w_topline;
6774 * To behave like when a new file is edited (matters for
6775 * BufReadPost autocommands) we first need to delete the current
6776 * buffer contents. But if reading the file fails we should keep
6777 * the old contents. Can't use memory only, the file might be
6778 * too big. Use a hidden buffer to move the buffer contents to.
6780 if (bufempty())
6781 savebuf = NULL;
6782 else
6784 /* Allocate a buffer without putting it in the buffer list. */
6785 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6786 if (savebuf != NULL && buf == curbuf)
6788 /* Open the memline. */
6789 curbuf = savebuf;
6790 curwin->w_buffer = savebuf;
6791 saved = ml_open(curbuf);
6792 curbuf = buf;
6793 curwin->w_buffer = buf;
6795 if (savebuf == NULL || saved == FAIL || buf != curbuf
6796 || move_lines(buf, savebuf) == FAIL)
6798 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6799 buf->b_fname);
6800 saved = FAIL;
6804 if (saved == OK)
6806 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6807 #ifdef FEAT_AUTOCMD
6808 keep_filetype = TRUE; /* don't detect 'filetype' */
6809 #endif
6810 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6811 (linenr_T)0,
6812 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6814 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6815 if (!aborting())
6816 #endif
6817 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6818 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6820 /* Put the text back from the save buffer. First
6821 * delete any lines that readfile() added. */
6822 while (!bufempty())
6823 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6824 break;
6825 (void)move_lines(savebuf, buf);
6828 else if (buf == curbuf)
6830 /* Mark the buffer as unmodified and free undo info. */
6831 unchanged(buf, TRUE);
6832 u_blockfree(buf);
6833 u_clearall(buf);
6836 vim_free(ea.cmd);
6838 if (savebuf != NULL && buf_valid(savebuf))
6839 wipe_buffer(savebuf, FALSE);
6841 #ifdef FEAT_DIFF
6842 /* Invalidate diff info if necessary. */
6843 diff_invalidate(curbuf);
6844 #endif
6846 /* Restore the topline and cursor position and check it (lines may
6847 * have been removed). */
6848 if (old_topline > curbuf->b_ml.ml_line_count)
6849 curwin->w_topline = curbuf->b_ml.ml_line_count;
6850 else
6851 curwin->w_topline = old_topline;
6852 curwin->w_cursor = old_cursor;
6853 check_cursor();
6854 update_topline();
6855 #ifdef FEAT_AUTOCMD
6856 keep_filetype = FALSE;
6857 #endif
6858 #ifdef FEAT_FOLDING
6860 win_T *wp;
6861 tabpage_T *tp;
6863 /* Update folds unless they are defined manually. */
6864 FOR_ALL_TAB_WINDOWS(tp, wp)
6865 if (wp->w_buffer == curwin->w_buffer
6866 && !foldmethodIsManual(wp))
6867 foldUpdateAll(wp);
6869 #endif
6870 /* If the mode didn't change and 'readonly' was set, keep the old
6871 * value; the user probably used the ":view" command. But don't
6872 * reset it, might have had a read error. */
6873 if (orig_mode == curbuf->b_orig_mode)
6874 curbuf->b_p_ro |= old_ro;
6877 /* restore curwin/curbuf and a few other things */
6878 aucmd_restbuf(&aco);
6879 /* Careful: autocommands may have made "buf" invalid! */
6882 void
6883 buf_store_time(buf, st, fname)
6884 buf_T *buf;
6885 struct stat *st;
6886 char_u *fname UNUSED;
6888 buf->b_mtime = (long)st->st_mtime;
6889 buf->b_orig_size = (size_t)st->st_size;
6890 #ifdef HAVE_ST_MODE
6891 buf->b_orig_mode = (int)st->st_mode;
6892 #else
6893 buf->b_orig_mode = mch_getperm(fname);
6894 #endif
6898 * Adjust the line with missing eol, used for the next write.
6899 * Used for do_filter(), when the input lines for the filter are deleted.
6901 void
6902 write_lnum_adjust(offset)
6903 linenr_T offset;
6905 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
6906 write_no_eol_lnum += offset;
6909 #if defined(TEMPDIRNAMES) || defined(PROTO)
6910 static long temp_count = 0; /* Temp filename counter. */
6913 * Delete the temp directory and all files it contains.
6915 void
6916 vim_deltempdir()
6918 char_u **files;
6919 int file_count;
6920 int i;
6922 if (vim_tempdir != NULL)
6924 sprintf((char *)NameBuff, "%s*", vim_tempdir);
6925 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
6926 EW_DIR|EW_FILE|EW_SILENT) == OK)
6928 for (i = 0; i < file_count; ++i)
6929 mch_remove(files[i]);
6930 FreeWild(file_count, files);
6932 gettail(NameBuff)[-1] = NUL;
6933 (void)mch_rmdir(NameBuff);
6935 vim_free(vim_tempdir);
6936 vim_tempdir = NULL;
6939 #endif
6942 * vim_tempname(): Return a unique name that can be used for a temp file.
6944 * The temp file is NOT created.
6946 * The returned pointer is to allocated memory.
6947 * The returned pointer is NULL if no valid name was found.
6949 char_u *
6950 vim_tempname(extra_char)
6951 int extra_char UNUSED; /* char to use in the name instead of '?' */
6953 #ifdef USE_TMPNAM
6954 char_u itmp[L_tmpnam]; /* use tmpnam() */
6955 #else
6956 char_u itmp[TEMPNAMELEN];
6957 #endif
6959 #ifdef TEMPDIRNAMES
6960 static char *(tempdirs[]) = {TEMPDIRNAMES};
6961 int i;
6962 long nr;
6963 long off;
6964 # ifndef EEXIST
6965 struct stat st;
6966 # endif
6969 * This will create a directory for private use by this instance of Vim.
6970 * This is done once, and the same directory is used for all temp files.
6971 * This method avoids security problems because of symlink attacks et al.
6972 * It's also a bit faster, because we only need to check for an existing
6973 * file when creating the directory and not for each temp file.
6975 if (vim_tempdir == NULL)
6978 * Try the entries in TEMPDIRNAMES to create the temp directory.
6980 for (i = 0; i < (int)(sizeof(tempdirs) / sizeof(char *)); ++i)
6982 /* expand $TMP, leave room for "/v1100000/999999999" */
6983 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
6984 if (mch_isdir(itmp)) /* directory exists */
6986 # ifdef __EMX__
6987 /* If $TMP contains a forward slash (perhaps using bash or
6988 * tcsh), don't add a backslash, use a forward slash!
6989 * Adding 2 backslashes didn't work. */
6990 if (vim_strchr(itmp, '/') != NULL)
6991 STRCAT(itmp, "/");
6992 else
6993 # endif
6994 add_pathsep(itmp);
6996 /* Get an arbitrary number of up to 6 digits. When it's
6997 * unlikely that it already exists it will be faster,
6998 * otherwise it doesn't matter. The use of mkdir() avoids any
6999 * security problems because of the predictable number. */
7000 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
7002 /* Try up to 10000 different values until we find a name that
7003 * doesn't exist. */
7004 for (off = 0; off < 10000L; ++off)
7006 int r;
7007 #if defined(UNIX) || defined(VMS)
7008 mode_t umask_save;
7009 #endif
7011 sprintf((char *)itmp + STRLEN(itmp), "v%ld", nr + off);
7012 # ifndef EEXIST
7013 /* If mkdir() does not set errno to EEXIST, check for
7014 * existing file here. There is a race condition then,
7015 * although it's fail-safe. */
7016 if (mch_stat((char *)itmp, &st) >= 0)
7017 continue;
7018 # endif
7019 #if defined(UNIX) || defined(VMS)
7020 /* Make sure the umask doesn't remove the executable bit.
7021 * "repl" has been reported to use "177". */
7022 umask_save = umask(077);
7023 #endif
7024 r = vim_mkdir(itmp, 0700);
7025 #if defined(UNIX) || defined(VMS)
7026 (void)umask(umask_save);
7027 #endif
7028 if (r == 0)
7030 char_u *buf;
7032 /* Directory was created, use this name.
7033 * Expand to full path; When using the current
7034 * directory a ":cd" would confuse us. */
7035 buf = alloc((unsigned)MAXPATHL + 1);
7036 if (buf != NULL)
7038 if (vim_FullName(itmp, buf, MAXPATHL, FALSE)
7039 == FAIL)
7040 STRCPY(buf, itmp);
7041 # ifdef __EMX__
7042 if (vim_strchr(buf, '/') != NULL)
7043 STRCAT(buf, "/");
7044 else
7045 # endif
7046 add_pathsep(buf);
7047 vim_tempdir = vim_strsave(buf);
7048 vim_free(buf);
7050 break;
7052 # ifdef EEXIST
7053 /* If the mkdir() didn't fail because the file/dir exists,
7054 * we probably can't create any dir here, try another
7055 * place. */
7056 if (errno != EEXIST)
7057 # endif
7058 break;
7060 if (vim_tempdir != NULL)
7061 break;
7066 if (vim_tempdir != NULL)
7068 /* There is no need to check if the file exists, because we own the
7069 * directory and nobody else creates a file in it. */
7070 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
7071 return vim_strsave(itmp);
7074 return NULL;
7076 #else /* TEMPDIRNAMES */
7078 # ifdef WIN3264
7079 char szTempFile[_MAX_PATH + 1];
7080 char buf4[4];
7081 char_u *retval;
7082 char_u *p;
7084 STRCPY(itmp, "");
7085 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
7086 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
7087 strcpy(buf4, "VIM");
7088 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
7089 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
7090 return NULL;
7091 /* GetTempFileName() will create the file, we don't want that */
7092 (void)DeleteFile(itmp);
7094 /* Backslashes in a temp file name cause problems when filtering with
7095 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
7096 * didn't set 'shellslash'. */
7097 retval = vim_strsave(itmp);
7098 if (*p_shcf == '-' || p_ssl)
7099 for (p = retval; *p; ++p)
7100 if (*p == '\\')
7101 *p = '/';
7102 return retval;
7104 # else /* WIN3264 */
7106 # ifdef USE_TMPNAM
7107 /* tmpnam() will make its own name */
7108 if (*tmpnam((char *)itmp) == NUL)
7109 return NULL;
7110 # else
7111 char_u *p;
7113 # ifdef VMS_TEMPNAM
7114 /* mktemp() is not working on VMS. It seems to be
7115 * a do-nothing function. Therefore we use tempnam().
7117 sprintf((char *)itmp, "VIM%c", extra_char);
7118 p = (char_u *)tempnam("tmp:", (char *)itmp);
7119 if (p != NULL)
7121 /* VMS will use '.LOG' if we don't explicitly specify an extension,
7122 * and VIM will then be unable to find the file later */
7123 STRCPY(itmp, p);
7124 STRCAT(itmp, ".txt");
7125 free(p);
7127 else
7128 return NULL;
7129 # else
7130 STRCPY(itmp, TEMPNAME);
7131 if ((p = vim_strchr(itmp, '?')) != NULL)
7132 *p = extra_char;
7133 if (mktemp((char *)itmp) == NULL)
7134 return NULL;
7135 # endif
7136 # endif
7138 return vim_strsave(itmp);
7139 # endif /* WIN3264 */
7140 #endif /* TEMPDIRNAMES */
7143 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
7145 * Convert all backslashes in fname to forward slashes in-place.
7147 void
7148 forward_slash(fname)
7149 char_u *fname;
7151 char_u *p;
7153 for (p = fname; *p != NUL; ++p)
7154 # ifdef FEAT_MBYTE
7155 /* The Big5 encoding can have '\' in the trail byte. */
7156 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
7157 ++p;
7158 else
7159 # endif
7160 if (*p == '\\')
7161 *p = '/';
7163 #endif
7167 * Code for automatic commands.
7169 * Only included when "FEAT_AUTOCMD" has been defined.
7172 #if defined(FEAT_AUTOCMD) || defined(PROTO)
7175 * The autocommands are stored in a list for each event.
7176 * Autocommands for the same pattern, that are consecutive, are joined
7177 * together, to avoid having to match the pattern too often.
7178 * The result is an array of Autopat lists, which point to AutoCmd lists:
7180 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7181 * Autopat.cmds Autopat.cmds
7182 * | |
7183 * V V
7184 * AutoCmd.next AutoCmd.next
7185 * | |
7186 * V V
7187 * AutoCmd.next NULL
7190 * NULL
7192 * first_autopat[1] --> Autopat.next --> NULL
7193 * Autopat.cmds
7196 * AutoCmd.next
7199 * NULL
7200 * etc.
7202 * The order of AutoCmds is important, this is the order in which they were
7203 * defined and will have to be executed.
7205 typedef struct AutoCmd
7207 char_u *cmd; /* The command to be executed (NULL
7208 when command has been removed) */
7209 char nested; /* If autocommands nest here */
7210 char last; /* last command in list */
7211 #ifdef FEAT_EVAL
7212 scid_T scriptID; /* script ID where defined */
7213 #endif
7214 struct AutoCmd *next; /* Next AutoCmd in list */
7215 } AutoCmd;
7217 typedef struct AutoPat
7219 int group; /* group ID */
7220 char_u *pat; /* pattern as typed (NULL when pattern
7221 has been removed) */
7222 int patlen; /* strlen() of pat */
7223 regprog_T *reg_prog; /* compiled regprog for pattern */
7224 char allow_dirs; /* Pattern may match whole path */
7225 char last; /* last pattern for apply_autocmds() */
7226 AutoCmd *cmds; /* list of commands to do */
7227 struct AutoPat *next; /* next AutoPat in AutoPat list */
7228 int buflocal_nr; /* !=0 for buffer-local AutoPat */
7229 } AutoPat;
7231 static struct event_name
7233 char *name; /* event name */
7234 event_T event; /* event number */
7235 } event_names[] =
7237 {"BufAdd", EVENT_BUFADD},
7238 {"BufCreate", EVENT_BUFADD},
7239 {"BufDelete", EVENT_BUFDELETE},
7240 {"BufEnter", EVENT_BUFENTER},
7241 {"BufFilePost", EVENT_BUFFILEPOST},
7242 {"BufFilePre", EVENT_BUFFILEPRE},
7243 {"BufHidden", EVENT_BUFHIDDEN},
7244 {"BufLeave", EVENT_BUFLEAVE},
7245 {"BufNew", EVENT_BUFNEW},
7246 {"BufNewFile", EVENT_BUFNEWFILE},
7247 {"BufRead", EVENT_BUFREADPOST},
7248 {"BufReadCmd", EVENT_BUFREADCMD},
7249 {"BufReadPost", EVENT_BUFREADPOST},
7250 {"BufReadPre", EVENT_BUFREADPRE},
7251 {"BufUnload", EVENT_BUFUNLOAD},
7252 {"BufWinEnter", EVENT_BUFWINENTER},
7253 {"BufWinLeave", EVENT_BUFWINLEAVE},
7254 {"BufWipeout", EVENT_BUFWIPEOUT},
7255 {"BufWrite", EVENT_BUFWRITEPRE},
7256 {"BufWritePost", EVENT_BUFWRITEPOST},
7257 {"BufWritePre", EVENT_BUFWRITEPRE},
7258 {"BufWriteCmd", EVENT_BUFWRITECMD},
7259 {"CmdwinEnter", EVENT_CMDWINENTER},
7260 {"CmdwinLeave", EVENT_CMDWINLEAVE},
7261 {"ColorScheme", EVENT_COLORSCHEME},
7262 {"CursorHold", EVENT_CURSORHOLD},
7263 {"CursorHoldI", EVENT_CURSORHOLDI},
7264 {"CursorMoved", EVENT_CURSORMOVED},
7265 {"CursorMovedI", EVENT_CURSORMOVEDI},
7266 {"EncodingChanged", EVENT_ENCODINGCHANGED},
7267 {"FileEncoding", EVENT_ENCODINGCHANGED},
7268 {"FileAppendPost", EVENT_FILEAPPENDPOST},
7269 {"FileAppendPre", EVENT_FILEAPPENDPRE},
7270 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
7271 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
7272 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
7273 {"FileChangedRO", EVENT_FILECHANGEDRO},
7274 {"FileReadPost", EVENT_FILEREADPOST},
7275 {"FileReadPre", EVENT_FILEREADPRE},
7276 {"FileReadCmd", EVENT_FILEREADCMD},
7277 {"FileType", EVENT_FILETYPE},
7278 {"FileWritePost", EVENT_FILEWRITEPOST},
7279 {"FileWritePre", EVENT_FILEWRITEPRE},
7280 {"FileWriteCmd", EVENT_FILEWRITECMD},
7281 {"FilterReadPost", EVENT_FILTERREADPOST},
7282 {"FilterReadPre", EVENT_FILTERREADPRE},
7283 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7284 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7285 {"FocusGained", EVENT_FOCUSGAINED},
7286 {"FocusLost", EVENT_FOCUSLOST},
7287 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7288 {"GUIEnter", EVENT_GUIENTER},
7289 {"GUIFailed", EVENT_GUIFAILED},
7290 {"InsertChange", EVENT_INSERTCHANGE},
7291 {"InsertEnter", EVENT_INSERTENTER},
7292 {"InsertLeave", EVENT_INSERTLEAVE},
7293 {"MenuPopup", EVENT_MENUPOPUP},
7294 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7295 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7296 {"RemoteReply", EVENT_REMOTEREPLY},
7297 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7298 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7299 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7300 {"SourcePre", EVENT_SOURCEPRE},
7301 {"SourceCmd", EVENT_SOURCECMD},
7302 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7303 {"StdinReadPost", EVENT_STDINREADPOST},
7304 {"StdinReadPre", EVENT_STDINREADPRE},
7305 {"SwapExists", EVENT_SWAPEXISTS},
7306 {"Syntax", EVENT_SYNTAX},
7307 {"TabEnter", EVENT_TABENTER},
7308 {"TabLeave", EVENT_TABLEAVE},
7309 {"TermChanged", EVENT_TERMCHANGED},
7310 {"TermResponse", EVENT_TERMRESPONSE},
7311 {"User", EVENT_USER},
7312 {"VimEnter", EVENT_VIMENTER},
7313 {"VimLeave", EVENT_VIMLEAVE},
7314 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7315 {"WinEnter", EVENT_WINENTER},
7316 {"WinLeave", EVENT_WINLEAVE},
7317 {"VimResized", EVENT_VIMRESIZED},
7318 {NULL, (event_T)0}
7321 static AutoPat *first_autopat[NUM_EVENTS] =
7323 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7324 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7325 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7326 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7327 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7328 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7332 * struct used to keep status while executing autocommands for an event.
7334 typedef struct AutoPatCmd
7336 AutoPat *curpat; /* next AutoPat to examine */
7337 AutoCmd *nextcmd; /* next AutoCmd to execute */
7338 int group; /* group being used */
7339 char_u *fname; /* fname to match with */
7340 char_u *sfname; /* sfname to match with */
7341 char_u *tail; /* tail of fname */
7342 event_T event; /* current event */
7343 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7344 buf is deleted */
7345 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7346 } AutoPatCmd;
7348 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7351 * augroups stores a list of autocmd group names.
7353 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7354 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7357 * The ID of the current group. Group 0 is the default one.
7359 static int current_augroup = AUGROUP_DEFAULT;
7361 static int au_need_clean = FALSE; /* need to delete marked patterns */
7363 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7364 static void au_remove_pat __ARGS((AutoPat *ap));
7365 static void au_remove_cmds __ARGS((AutoPat *ap));
7366 static void au_cleanup __ARGS((void));
7367 static int au_new_group __ARGS((char_u *name));
7368 static void au_del_group __ARGS((char_u *name));
7369 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7370 static char_u *event_nr2name __ARGS((event_T event));
7371 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7372 static int event_ignored __ARGS((event_T event));
7373 static int au_get_grouparg __ARGS((char_u **argp));
7374 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7375 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7376 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));
7377 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7380 static event_T last_event;
7381 static int last_group;
7382 static int autocmd_blocked = 0; /* block all autocmds */
7385 * Show the autocommands for one AutoPat.
7387 static void
7388 show_autocmd(ap, event)
7389 AutoPat *ap;
7390 event_T event;
7392 AutoCmd *ac;
7394 /* Check for "got_int" (here and at various places below), which is set
7395 * when "q" has been hit for the "--more--" prompt */
7396 if (got_int)
7397 return;
7398 if (ap->pat == NULL) /* pattern has been removed */
7399 return;
7401 msg_putchar('\n');
7402 if (got_int)
7403 return;
7404 if (event != last_event || ap->group != last_group)
7406 if (ap->group != AUGROUP_DEFAULT)
7408 if (AUGROUP_NAME(ap->group) == NULL)
7409 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7410 else
7411 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7412 msg_puts((char_u *)" ");
7414 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7415 last_event = event;
7416 last_group = ap->group;
7417 msg_putchar('\n');
7418 if (got_int)
7419 return;
7421 msg_col = 4;
7422 msg_outtrans(ap->pat);
7424 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7426 if (ac->cmd != NULL) /* skip removed commands */
7428 if (msg_col >= 14)
7429 msg_putchar('\n');
7430 msg_col = 14;
7431 if (got_int)
7432 return;
7433 msg_outtrans(ac->cmd);
7434 #ifdef FEAT_EVAL
7435 if (p_verbose > 0)
7436 last_set_msg(ac->scriptID);
7437 #endif
7438 if (got_int)
7439 return;
7440 if (ac->next != NULL)
7442 msg_putchar('\n');
7443 if (got_int)
7444 return;
7451 * Mark an autocommand pattern for deletion.
7453 static void
7454 au_remove_pat(ap)
7455 AutoPat *ap;
7457 vim_free(ap->pat);
7458 ap->pat = NULL;
7459 ap->buflocal_nr = -1;
7460 au_need_clean = TRUE;
7464 * Mark all commands for a pattern for deletion.
7466 static void
7467 au_remove_cmds(ap)
7468 AutoPat *ap;
7470 AutoCmd *ac;
7472 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7474 vim_free(ac->cmd);
7475 ac->cmd = NULL;
7477 au_need_clean = TRUE;
7481 * Cleanup autocommands and patterns that have been deleted.
7482 * This is only done when not executing autocommands.
7484 static void
7485 au_cleanup()
7487 AutoPat *ap, **prev_ap;
7488 AutoCmd *ac, **prev_ac;
7489 event_T event;
7491 if (autocmd_busy || !au_need_clean)
7492 return;
7494 /* loop over all events */
7495 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7496 event = (event_T)((int)event + 1))
7498 /* loop over all autocommand patterns */
7499 prev_ap = &(first_autopat[(int)event]);
7500 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7502 /* loop over all commands for this pattern */
7503 prev_ac = &(ap->cmds);
7504 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7506 /* remove the command if the pattern is to be deleted or when
7507 * the command has been marked for deletion */
7508 if (ap->pat == NULL || ac->cmd == NULL)
7510 *prev_ac = ac->next;
7511 vim_free(ac->cmd);
7512 vim_free(ac);
7514 else
7515 prev_ac = &(ac->next);
7518 /* remove the pattern if it has been marked for deletion */
7519 if (ap->pat == NULL)
7521 *prev_ap = ap->next;
7522 vim_free(ap->reg_prog);
7523 vim_free(ap);
7525 else
7526 prev_ap = &(ap->next);
7530 au_need_clean = FALSE;
7534 * Called when buffer is freed, to remove/invalidate related buffer-local
7535 * autocmds.
7537 void
7538 aubuflocal_remove(buf)
7539 buf_T *buf;
7541 AutoPat *ap;
7542 event_T event;
7543 AutoPatCmd *apc;
7545 /* invalidate currently executing autocommands */
7546 for (apc = active_apc_list; apc; apc = apc->next)
7547 if (buf->b_fnum == apc->arg_bufnr)
7548 apc->arg_bufnr = 0;
7550 /* invalidate buflocals looping through events */
7551 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7552 event = (event_T)((int)event + 1))
7553 /* loop over all autocommand patterns */
7554 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7555 if (ap->buflocal_nr == buf->b_fnum)
7557 au_remove_pat(ap);
7558 if (p_verbose >= 6)
7560 verbose_enter();
7561 smsg((char_u *)
7562 _("auto-removing autocommand: %s <buffer=%d>"),
7563 event_nr2name(event), buf->b_fnum);
7564 verbose_leave();
7567 au_cleanup();
7571 * Add an autocmd group name.
7572 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7574 static int
7575 au_new_group(name)
7576 char_u *name;
7578 int i;
7580 i = au_find_group(name);
7581 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7583 /* First try using a free entry. */
7584 for (i = 0; i < augroups.ga_len; ++i)
7585 if (AUGROUP_NAME(i) == NULL)
7586 break;
7587 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7588 return AUGROUP_ERROR;
7590 AUGROUP_NAME(i) = vim_strsave(name);
7591 if (AUGROUP_NAME(i) == NULL)
7592 return AUGROUP_ERROR;
7593 if (i == augroups.ga_len)
7594 ++augroups.ga_len;
7597 return i;
7600 static void
7601 au_del_group(name)
7602 char_u *name;
7604 int i;
7606 i = au_find_group(name);
7607 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7608 EMSG2(_("E367: No such group: \"%s\""), name);
7609 else
7611 vim_free(AUGROUP_NAME(i));
7612 AUGROUP_NAME(i) = NULL;
7617 * Find the ID of an autocmd group name.
7618 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7620 static int
7621 au_find_group(name)
7622 char_u *name;
7624 int i;
7626 for (i = 0; i < augroups.ga_len; ++i)
7627 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7628 return i;
7629 return AUGROUP_ERROR;
7633 * Return TRUE if augroup "name" exists.
7636 au_has_group(name)
7637 char_u *name;
7639 return au_find_group(name) != AUGROUP_ERROR;
7643 * ":augroup {name}".
7645 void
7646 do_augroup(arg, del_group)
7647 char_u *arg;
7648 int del_group;
7650 int i;
7652 if (del_group)
7654 if (*arg == NUL)
7655 EMSG(_(e_argreq));
7656 else
7657 au_del_group(arg);
7659 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7660 current_augroup = AUGROUP_DEFAULT;
7661 else if (*arg) /* ":aug xxx": switch to group xxx */
7663 i = au_new_group(arg);
7664 if (i != AUGROUP_ERROR)
7665 current_augroup = i;
7667 else /* ":aug": list the group names */
7669 msg_start();
7670 for (i = 0; i < augroups.ga_len; ++i)
7672 if (AUGROUP_NAME(i) != NULL)
7674 msg_puts(AUGROUP_NAME(i));
7675 msg_puts((char_u *)" ");
7678 msg_clr_eos();
7679 msg_end();
7683 #if defined(EXITFREE) || defined(PROTO)
7684 void
7685 free_all_autocmds()
7687 for (current_augroup = -1; current_augroup < augroups.ga_len;
7688 ++current_augroup)
7689 do_autocmd((char_u *)"", TRUE);
7690 ga_clear_strings(&augroups);
7692 #endif
7695 * Return the event number for event name "start".
7696 * Return NUM_EVENTS if the event name was not found.
7697 * Return a pointer to the next event name in "end".
7699 static event_T
7700 event_name2nr(start, end)
7701 char_u *start;
7702 char_u **end;
7704 char_u *p;
7705 int i;
7706 int len;
7708 /* the event name ends with end of line, a blank or a comma */
7709 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7711 for (i = 0; event_names[i].name != NULL; ++i)
7713 len = (int)STRLEN(event_names[i].name);
7714 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7715 break;
7717 if (*p == ',')
7718 ++p;
7719 *end = p;
7720 if (event_names[i].name == NULL)
7721 return NUM_EVENTS;
7722 return event_names[i].event;
7726 * Return the name for event "event".
7728 static char_u *
7729 event_nr2name(event)
7730 event_T event;
7732 int i;
7734 for (i = 0; event_names[i].name != NULL; ++i)
7735 if (event_names[i].event == event)
7736 return (char_u *)event_names[i].name;
7737 return (char_u *)"Unknown";
7741 * Scan over the events. "*" stands for all events.
7743 static char_u *
7744 find_end_event(arg, have_group)
7745 char_u *arg;
7746 int have_group; /* TRUE when group name was found */
7748 char_u *pat;
7749 char_u *p;
7751 if (*arg == '*')
7753 if (arg[1] && !vim_iswhite(arg[1]))
7755 EMSG2(_("E215: Illegal character after *: %s"), arg);
7756 return NULL;
7758 pat = arg + 1;
7760 else
7762 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7764 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7766 if (have_group)
7767 EMSG2(_("E216: No such event: %s"), pat);
7768 else
7769 EMSG2(_("E216: No such group or event: %s"), pat);
7770 return NULL;
7774 return pat;
7778 * Return TRUE if "event" is included in 'eventignore'.
7780 static int
7781 event_ignored(event)
7782 event_T event;
7784 char_u *p = p_ei;
7786 while (*p != NUL)
7788 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7789 return TRUE;
7790 if (event_name2nr(p, &p) == event)
7791 return TRUE;
7794 return FALSE;
7798 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7801 check_ei()
7803 char_u *p = p_ei;
7805 while (*p)
7807 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7809 p += 3;
7810 if (*p == ',')
7811 ++p;
7813 else if (event_name2nr(p, &p) == NUM_EVENTS)
7814 return FAIL;
7817 return OK;
7820 # if defined(FEAT_SYN_HL) || defined(PROTO)
7823 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7824 * buffer loaded into the window. "what" must start with a comma.
7825 * Returns the old value of 'eventignore' in allocated memory.
7827 char_u *
7828 au_event_disable(what)
7829 char *what;
7831 char_u *new_ei;
7832 char_u *save_ei;
7834 save_ei = vim_strsave(p_ei);
7835 if (save_ei != NULL)
7837 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7838 if (new_ei != NULL)
7840 STRCAT(new_ei, what);
7841 set_string_option_direct((char_u *)"ei", -1, new_ei,
7842 OPT_FREE, SID_NONE);
7843 vim_free(new_ei);
7846 return save_ei;
7849 void
7850 au_event_restore(old_ei)
7851 char_u *old_ei;
7853 if (old_ei != NULL)
7855 set_string_option_direct((char_u *)"ei", -1, old_ei,
7856 OPT_FREE, SID_NONE);
7857 vim_free(old_ei);
7860 # endif /* FEAT_SYN_HL */
7863 * do_autocmd() -- implements the :autocmd command. Can be used in the
7864 * following ways:
7866 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7867 * will be automatically executed for <event>
7868 * when editing a file matching <pat>, in
7869 * the current group.
7870 * :autocmd <event> <pat> Show the auto-commands associated with
7871 * <event> and <pat>.
7872 * :autocmd <event> Show the auto-commands associated with
7873 * <event>.
7874 * :autocmd Show all auto-commands.
7875 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7876 * <event> and <pat>, and add the command
7877 * <cmd>, for the current group.
7878 * :autocmd! <event> <pat> Remove all auto-commands associated with
7879 * <event> and <pat> for the current group.
7880 * :autocmd! <event> Remove all auto-commands associated with
7881 * <event> for the current group.
7882 * :autocmd! Remove ALL auto-commands for the current
7883 * group.
7885 * Multiple events and patterns may be given separated by commas. Here are
7886 * some examples:
7887 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7888 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7890 * :autocmd * *.c show all autocommands for *.c files.
7892 * Mostly a {group} argument can optionally appear before <event>.
7894 void
7895 do_autocmd(arg, forceit)
7896 char_u *arg;
7897 int forceit;
7899 char_u *pat;
7900 char_u *envpat = NULL;
7901 char_u *cmd;
7902 event_T event;
7903 int need_free = FALSE;
7904 int nested = FALSE;
7905 int group;
7908 * Check for a legal group name. If not, use AUGROUP_ALL.
7910 group = au_get_grouparg(&arg);
7911 if (arg == NULL) /* out of memory */
7912 return;
7915 * Scan over the events.
7916 * If we find an illegal name, return here, don't do anything.
7918 pat = find_end_event(arg, group != AUGROUP_ALL);
7919 if (pat == NULL)
7920 return;
7923 * Scan over the pattern. Put a NUL at the end.
7925 pat = skipwhite(pat);
7926 cmd = pat;
7927 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
7928 cmd++;
7929 if (*cmd)
7930 *cmd++ = NUL;
7932 /* Expand environment variables in the pattern. Set 'shellslash', we want
7933 * forward slashes here. */
7934 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
7936 #ifdef BACKSLASH_IN_FILENAME
7937 int p_ssl_save = p_ssl;
7939 p_ssl = TRUE;
7940 #endif
7941 envpat = expand_env_save(pat);
7942 #ifdef BACKSLASH_IN_FILENAME
7943 p_ssl = p_ssl_save;
7944 #endif
7945 if (envpat != NULL)
7946 pat = envpat;
7950 * Check for "nested" flag.
7952 cmd = skipwhite(cmd);
7953 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
7955 nested = TRUE;
7956 cmd = skipwhite(cmd + 6);
7960 * Find the start of the commands.
7961 * Expand <sfile> in it.
7963 if (*cmd != NUL)
7965 cmd = expand_sfile(cmd);
7966 if (cmd == NULL) /* some error */
7967 return;
7968 need_free = TRUE;
7972 * Print header when showing autocommands.
7974 if (!forceit && *cmd == NUL)
7976 /* Highlight title */
7977 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7981 * Loop over the events.
7983 last_event = (event_T)-1; /* for listing the event name */
7984 last_group = AUGROUP_ERROR; /* for listing the group name */
7985 if (*arg == '*' || *arg == NUL)
7987 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7988 event = (event_T)((int)event + 1))
7989 if (do_autocmd_event(event, pat,
7990 nested, cmd, forceit, group) == FAIL)
7991 break;
7993 else
7995 while (*arg && !vim_iswhite(*arg))
7996 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
7997 nested, cmd, forceit, group) == FAIL)
7998 break;
8001 if (need_free)
8002 vim_free(cmd);
8003 vim_free(envpat);
8007 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
8008 * The "argp" argument is advanced to the following argument.
8010 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
8012 static int
8013 au_get_grouparg(argp)
8014 char_u **argp;
8016 char_u *group_name;
8017 char_u *p;
8018 char_u *arg = *argp;
8019 int group = AUGROUP_ALL;
8021 p = skiptowhite(arg);
8022 if (p > arg)
8024 group_name = vim_strnsave(arg, (int)(p - arg));
8025 if (group_name == NULL) /* out of memory */
8026 return AUGROUP_ERROR;
8027 group = au_find_group(group_name);
8028 if (group == AUGROUP_ERROR)
8029 group = AUGROUP_ALL; /* no match, use all groups */
8030 else
8031 *argp = skipwhite(p); /* match, skip over group name */
8032 vim_free(group_name);
8034 return group;
8038 * do_autocmd() for one event.
8039 * If *pat == NUL do for all patterns.
8040 * If *cmd == NUL show entries.
8041 * If forceit == TRUE delete entries.
8042 * If group is not AUGROUP_ALL, only use this group.
8044 static int
8045 do_autocmd_event(event, pat, nested, cmd, forceit, group)
8046 event_T event;
8047 char_u *pat;
8048 int nested;
8049 char_u *cmd;
8050 int forceit;
8051 int group;
8053 AutoPat *ap;
8054 AutoPat **prev_ap;
8055 AutoCmd *ac;
8056 AutoCmd **prev_ac;
8057 int brace_level;
8058 char_u *endpat;
8059 int findgroup;
8060 int allgroups;
8061 int patlen;
8062 int is_buflocal;
8063 int buflocal_nr;
8064 char_u buflocal_pat[25]; /* for "<buffer=X>" */
8066 if (group == AUGROUP_ALL)
8067 findgroup = current_augroup;
8068 else
8069 findgroup = group;
8070 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
8073 * Show or delete all patterns for an event.
8075 if (*pat == NUL)
8077 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
8079 if (forceit) /* delete the AutoPat, if it's in the current group */
8081 if (ap->group == findgroup)
8082 au_remove_pat(ap);
8084 else if (group == AUGROUP_ALL || ap->group == group)
8085 show_autocmd(ap, event);
8090 * Loop through all the specified patterns.
8092 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
8095 * Find end of the pattern.
8096 * Watch out for a comma in braces, like "*.\{obj,o\}".
8098 brace_level = 0;
8099 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
8100 || endpat[-1] == '\\'); ++endpat)
8102 if (*endpat == '{')
8103 brace_level++;
8104 else if (*endpat == '}')
8105 brace_level--;
8107 if (pat == endpat) /* ignore single comma */
8108 continue;
8109 patlen = (int)(endpat - pat);
8112 * detect special <buflocal[=X]> buffer-local patterns
8114 is_buflocal = FALSE;
8115 buflocal_nr = 0;
8117 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
8118 && pat[patlen - 1] == '>')
8120 /* Error will be printed only for addition. printing and removing
8121 * will proceed silently. */
8122 is_buflocal = TRUE;
8123 if (patlen == 8)
8124 buflocal_nr = curbuf->b_fnum;
8125 else if (patlen > 9 && pat[7] == '=')
8127 /* <buffer=abuf> */
8128 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
8129 buflocal_nr = autocmd_bufnr;
8130 /* <buffer=123> */
8131 else if (skipdigits(pat + 8) == pat + patlen - 1)
8132 buflocal_nr = atoi((char *)pat + 8);
8136 if (is_buflocal)
8138 /* normalize pat into standard "<buffer>#N" form */
8139 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
8140 pat = buflocal_pat; /* can modify pat and patlen */
8141 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
8145 * Find AutoPat entries with this pattern.
8147 prev_ap = &first_autopat[(int)event];
8148 while ((ap = *prev_ap) != NULL)
8150 if (ap->pat != NULL)
8152 /* Accept a pattern when:
8153 * - a group was specified and it's that group, or a group was
8154 * not specified and it's the current group, or a group was
8155 * not specified and we are listing
8156 * - the length of the pattern matches
8157 * - the pattern matches.
8158 * For <buffer[=X]>, this condition works because we normalize
8159 * all buffer-local patterns.
8161 if ((allgroups || ap->group == findgroup)
8162 && ap->patlen == patlen
8163 && STRNCMP(pat, ap->pat, patlen) == 0)
8166 * Remove existing autocommands.
8167 * If adding any new autocmd's for this AutoPat, don't
8168 * delete the pattern from the autopat list, append to
8169 * this list.
8171 if (forceit)
8173 if (*cmd != NUL && ap->next == NULL)
8175 au_remove_cmds(ap);
8176 break;
8178 au_remove_pat(ap);
8182 * Show autocmd's for this autopat, or buflocals <buffer=X>
8184 else if (*cmd == NUL)
8185 show_autocmd(ap, event);
8188 * Add autocmd to this autopat, if it's the last one.
8190 else if (ap->next == NULL)
8191 break;
8194 prev_ap = &ap->next;
8198 * Add a new command.
8200 if (*cmd != NUL)
8203 * If the pattern we want to add a command to does appear at the
8204 * end of the list (or not is not in the list at all), add the
8205 * pattern at the end of the list.
8207 if (ap == NULL)
8209 /* refuse to add buffer-local ap if buffer number is invalid */
8210 if (is_buflocal && (buflocal_nr == 0
8211 || buflist_findnr(buflocal_nr) == NULL))
8213 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8214 buflocal_nr);
8215 return FAIL;
8218 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
8219 if (ap == NULL)
8220 return FAIL;
8221 ap->pat = vim_strnsave(pat, patlen);
8222 ap->patlen = patlen;
8223 if (ap->pat == NULL)
8225 vim_free(ap);
8226 return FAIL;
8229 if (is_buflocal)
8231 ap->buflocal_nr = buflocal_nr;
8232 ap->reg_prog = NULL;
8234 else
8236 char_u *reg_pat;
8238 ap->buflocal_nr = 0;
8239 reg_pat = file_pat_to_reg_pat(pat, endpat,
8240 &ap->allow_dirs, TRUE);
8241 if (reg_pat != NULL)
8242 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
8243 vim_free(reg_pat);
8244 if (reg_pat == NULL || ap->reg_prog == NULL)
8246 vim_free(ap->pat);
8247 vim_free(ap);
8248 return FAIL;
8251 ap->cmds = NULL;
8252 *prev_ap = ap;
8253 ap->next = NULL;
8254 if (group == AUGROUP_ALL)
8255 ap->group = current_augroup;
8256 else
8257 ap->group = group;
8261 * Add the autocmd at the end of the AutoCmd list.
8263 prev_ac = &(ap->cmds);
8264 while ((ac = *prev_ac) != NULL)
8265 prev_ac = &ac->next;
8266 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
8267 if (ac == NULL)
8268 return FAIL;
8269 ac->cmd = vim_strsave(cmd);
8270 #ifdef FEAT_EVAL
8271 ac->scriptID = current_SID;
8272 #endif
8273 if (ac->cmd == NULL)
8275 vim_free(ac);
8276 return FAIL;
8278 ac->next = NULL;
8279 *prev_ac = ac;
8280 ac->nested = nested;
8284 au_cleanup(); /* may really delete removed patterns/commands now */
8285 return OK;
8289 * Implementation of ":doautocmd [group] event [fname]".
8290 * Return OK for success, FAIL for failure;
8293 do_doautocmd(arg, do_msg)
8294 char_u *arg;
8295 int do_msg; /* give message for no matching autocmds? */
8297 char_u *fname;
8298 int nothing_done = TRUE;
8299 int group;
8302 * Check for a legal group name. If not, use AUGROUP_ALL.
8304 group = au_get_grouparg(&arg);
8305 if (arg == NULL) /* out of memory */
8306 return FAIL;
8308 if (*arg == '*')
8310 EMSG(_("E217: Can't execute autocommands for ALL events"));
8311 return FAIL;
8315 * Scan over the events.
8316 * If we find an illegal name, return here, don't do anything.
8318 fname = find_end_event(arg, group != AUGROUP_ALL);
8319 if (fname == NULL)
8320 return FAIL;
8322 fname = skipwhite(fname);
8325 * Loop over the events.
8327 while (*arg && !vim_iswhite(*arg))
8328 if (apply_autocmds_group(event_name2nr(arg, &arg),
8329 fname, NULL, TRUE, group, curbuf, NULL))
8330 nothing_done = FALSE;
8332 if (nothing_done && do_msg)
8333 MSG(_("No matching autocommands"));
8335 #ifdef FEAT_EVAL
8336 return aborting() ? FAIL : OK;
8337 #else
8338 return OK;
8339 #endif
8343 * ":doautoall": execute autocommands for each loaded buffer.
8345 void
8346 ex_doautoall(eap)
8347 exarg_T *eap;
8349 int retval;
8350 aco_save_T aco;
8351 buf_T *buf;
8354 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8355 * equal to curbuf, but for some buffers there may not be a window.
8356 * So we change the buffer for the current window for a moment. This
8357 * gives problems when the autocommands make changes to the list of
8358 * buffers or windows...
8360 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8362 if (buf->b_ml.ml_mfp != NULL)
8364 /* find a window for this buffer and save some values */
8365 aucmd_prepbuf(&aco, buf);
8367 /* execute the autocommands for this buffer */
8368 retval = do_doautocmd(eap->arg, FALSE);
8370 /* Execute the modeline settings, but don't set window-local
8371 * options if we are using the current window for another buffer. */
8372 do_modelines(curwin == aucmd_win ? OPT_NOWIN : 0);
8374 /* restore the current window */
8375 aucmd_restbuf(&aco);
8377 /* stop if there is some error or buffer was deleted */
8378 if (retval == FAIL || !buf_valid(buf))
8379 break;
8383 check_cursor(); /* just in case lines got deleted */
8387 * Prepare for executing autocommands for (hidden) buffer "buf".
8388 * Search for a visible window containing the current buffer. If there isn't
8389 * one then use "aucmd_win".
8390 * Set "curbuf" and "curwin" to match "buf".
8391 * When FEAT_AUTOCMD is not defined another version is used, see below.
8393 void
8394 aucmd_prepbuf(aco, buf)
8395 aco_save_T *aco; /* structure to save values in */
8396 buf_T *buf; /* new curbuf */
8398 win_T *win;
8399 #ifdef FEAT_WINDOWS
8400 int save_ea;
8401 #endif
8403 /* Find a window that is for the new buffer */
8404 if (buf == curbuf) /* be quick when buf is curbuf */
8405 win = curwin;
8406 else
8407 #ifdef FEAT_WINDOWS
8408 for (win = firstwin; win != NULL; win = win->w_next)
8409 if (win->w_buffer == buf)
8410 break;
8411 #else
8412 win = NULL;
8413 #endif
8415 /* Allocate "aucmd_win" when needed. If this fails (out of memory) fall
8416 * back to using the current window. */
8417 if (win == NULL && aucmd_win == NULL)
8419 win_alloc_aucmd_win();
8420 if (aucmd_win == NULL)
8421 win = curwin;
8424 aco->save_curwin = curwin;
8425 aco->save_curbuf = curbuf;
8426 if (win != NULL)
8428 /* There is a window for "buf" in the current tab page, make it the
8429 * curwin. This is preferred, it has the least side effects (esp. if
8430 * "buf" is curbuf). */
8431 curwin = win;
8433 else
8435 /* There is no window for "buf", use "aucmd_win". To minimize the side
8436 * effects, insert it in a the current tab page.
8437 * Anything related to a window (e.g., setting folds) may have
8438 * unexpected results. */
8439 aucmd_win->w_buffer = buf;
8440 ++buf->b_nwindows;
8441 win_init_empty(aucmd_win); /* set cursor and topline to safe values */
8443 #ifdef FEAT_WINDOWS
8444 /* Split the current window, put the aucmd_win in the upper half. */
8445 make_snapshot(SNAP_AUCMD_IDX);
8446 save_ea = p_ea;
8447 p_ea = FALSE;
8448 (void)win_split_ins(0, WSP_TOP, aucmd_win, 0);
8449 (void)win_comp_pos(); /* recompute window positions */
8450 p_ea = save_ea;
8451 #endif
8452 curwin = aucmd_win;
8454 curbuf = buf;
8455 aco->new_curwin = curwin;
8456 aco->new_curbuf = curbuf;
8460 * Cleanup after executing autocommands for a (hidden) buffer.
8461 * Restore the window as it was (if possible).
8462 * When FEAT_AUTOCMD is not defined another version is used, see below.
8464 void
8465 aucmd_restbuf(aco)
8466 aco_save_T *aco; /* structure holding saved values */
8468 #ifdef FEAT_WINDOWS
8469 int dummy;
8470 #endif
8472 if (aco->new_curwin == aucmd_win)
8474 --curbuf->b_nwindows;
8475 #ifdef FEAT_WINDOWS
8476 /* Find "aucmd_win", it can't be closed, but it may be in another tab
8477 * page. */
8478 if (curwin != aucmd_win)
8480 tabpage_T *tp;
8481 win_T *wp;
8483 FOR_ALL_TAB_WINDOWS(tp, wp)
8485 if (wp == aucmd_win)
8487 if (tp != curtab)
8488 goto_tabpage_tp(tp);
8489 win_goto(aucmd_win);
8490 break;
8495 /* Remove the window and frame from the tree of frames. */
8496 (void)winframe_remove(curwin, &dummy, NULL);
8497 win_remove(curwin, NULL);
8498 last_status(FALSE); /* may need to remove last status line */
8499 restore_snapshot(SNAP_AUCMD_IDX, FALSE);
8500 (void)win_comp_pos(); /* recompute window positions */
8502 if (win_valid(aco->save_curwin))
8503 curwin = aco->save_curwin;
8504 else
8505 /* Hmm, original window disappeared. Just use the first one. */
8506 curwin = firstwin;
8507 # ifdef FEAT_EVAL
8508 vars_clear(&aucmd_win->w_vars.dv_hashtab); /* free all w: variables */
8509 # endif
8510 #else
8511 curwin = aco->save_curwin;
8512 #endif
8513 curbuf = curwin->w_buffer;
8515 /* the buffer contents may have changed */
8516 check_cursor();
8517 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
8519 curwin->w_topline = curbuf->b_ml.ml_line_count;
8520 #ifdef FEAT_DIFF
8521 curwin->w_topfill = 0;
8522 #endif
8524 #if defined(FEAT_GUI)
8525 /* Hide the scrollbars from the aucmd_win and update. */
8526 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_LEFT], FALSE);
8527 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_RIGHT], FALSE);
8528 gui_may_update_scrollbars();
8529 #endif
8531 else
8533 /* restore curwin */
8534 #ifdef FEAT_WINDOWS
8535 if (win_valid(aco->save_curwin))
8536 #endif
8538 /* Restore the buffer which was previously edited by curwin, if
8539 * it was chagned, we are still the same window and the buffer is
8540 * valid. */
8541 if (curwin == aco->new_curwin
8542 && curbuf != aco->new_curbuf
8543 && buf_valid(aco->new_curbuf)
8544 && aco->new_curbuf->b_ml.ml_mfp != NULL)
8546 --curbuf->b_nwindows;
8547 curbuf = aco->new_curbuf;
8548 curwin->w_buffer = curbuf;
8549 ++curbuf->b_nwindows;
8552 curwin = aco->save_curwin;
8553 curbuf = curwin->w_buffer;
8558 static int autocmd_nested = FALSE;
8561 * Execute autocommands for "event" and file name "fname".
8562 * Return TRUE if some commands were executed.
8565 apply_autocmds(event, fname, fname_io, force, buf)
8566 event_T event;
8567 char_u *fname; /* NULL or empty means use actual file name */
8568 char_u *fname_io; /* fname to use for <afile> on cmdline */
8569 int force; /* when TRUE, ignore autocmd_busy */
8570 buf_T *buf; /* buffer for <abuf> */
8572 return apply_autocmds_group(event, fname, fname_io, force,
8573 AUGROUP_ALL, buf, NULL);
8577 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8578 * setting v:filearg.
8580 static int
8581 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8582 event_T event;
8583 char_u *fname;
8584 char_u *fname_io;
8585 int force;
8586 buf_T *buf;
8587 exarg_T *eap;
8589 return apply_autocmds_group(event, fname, fname_io, force,
8590 AUGROUP_ALL, buf, eap);
8594 * Like apply_autocmds(), but handles the caller's retval. If the script
8595 * processing is being aborted or if retval is FAIL when inside a try
8596 * conditional, no autocommands are executed. If otherwise the autocommands
8597 * cause the script to be aborted, retval is set to FAIL.
8600 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8601 event_T event;
8602 char_u *fname; /* NULL or empty means use actual file name */
8603 char_u *fname_io; /* fname to use for <afile> on cmdline */
8604 int force; /* when TRUE, ignore autocmd_busy */
8605 buf_T *buf; /* buffer for <abuf> */
8606 int *retval; /* pointer to caller's retval */
8608 int did_cmd;
8610 #ifdef FEAT_EVAL
8611 if (should_abort(*retval))
8612 return FALSE;
8613 #endif
8615 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8616 AUGROUP_ALL, buf, NULL);
8617 if (did_cmd
8618 #ifdef FEAT_EVAL
8619 && aborting()
8620 #endif
8622 *retval = FAIL;
8623 return did_cmd;
8627 * Return TRUE when there is a CursorHold autocommand defined.
8630 has_cursorhold()
8632 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8633 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8637 * Return TRUE if the CursorHold event can be triggered.
8640 trigger_cursorhold()
8642 int state;
8644 if (!did_cursorhold && has_cursorhold() && !Recording
8645 #ifdef FEAT_INS_EXPAND
8646 && !ins_compl_active()
8647 #endif
8650 state = get_real_state();
8651 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8652 return TRUE;
8654 return FALSE;
8658 * Return TRUE when there is a CursorMoved autocommand defined.
8661 has_cursormoved()
8663 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8667 * Return TRUE when there is a CursorMovedI autocommand defined.
8670 has_cursormovedI()
8672 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8675 static int
8676 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8677 event_T event;
8678 char_u *fname; /* NULL or empty means use actual file name */
8679 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8680 use fname */
8681 int force; /* when TRUE, ignore autocmd_busy */
8682 int group; /* group ID, or AUGROUP_ALL */
8683 buf_T *buf; /* buffer for <abuf> */
8684 exarg_T *eap; /* command arguments */
8686 char_u *sfname = NULL; /* short file name */
8687 char_u *tail;
8688 int save_changed;
8689 buf_T *old_curbuf;
8690 int retval = FALSE;
8691 char_u *save_sourcing_name;
8692 linenr_T save_sourcing_lnum;
8693 char_u *save_autocmd_fname;
8694 int save_autocmd_fname_full;
8695 int save_autocmd_bufnr;
8696 char_u *save_autocmd_match;
8697 int save_autocmd_busy;
8698 int save_autocmd_nested;
8699 static int nesting = 0;
8700 AutoPatCmd patcmd;
8701 AutoPat *ap;
8702 #ifdef FEAT_EVAL
8703 scid_T save_current_SID;
8704 void *save_funccalp;
8705 char_u *save_cmdarg;
8706 long save_cmdbang;
8707 #endif
8708 static int filechangeshell_busy = FALSE;
8709 #ifdef FEAT_PROFILE
8710 proftime_T wait_time;
8711 #endif
8714 * Quickly return if there are no autocommands for this event or
8715 * autocommands are blocked.
8717 if (first_autopat[(int)event] == NULL || autocmd_blocked > 0)
8718 goto BYPASS_AU;
8721 * When autocommands are busy, new autocommands are only executed when
8722 * explicitly enabled with the "nested" flag.
8724 if (autocmd_busy && !(force || autocmd_nested))
8725 goto BYPASS_AU;
8727 #ifdef FEAT_EVAL
8729 * Quickly return when immediately aborting on error, or when an interrupt
8730 * occurred or an exception was thrown but not caught.
8732 if (aborting())
8733 goto BYPASS_AU;
8734 #endif
8737 * FileChangedShell never nests, because it can create an endless loop.
8739 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8740 || event == EVENT_FILECHANGEDSHELLPOST))
8741 goto BYPASS_AU;
8744 * Ignore events in 'eventignore'.
8746 if (event_ignored(event))
8747 goto BYPASS_AU;
8750 * Allow nesting of autocommands, but restrict the depth, because it's
8751 * possible to create an endless loop.
8753 if (nesting == 10)
8755 EMSG(_("E218: autocommand nesting too deep"));
8756 goto BYPASS_AU;
8760 * Check if these autocommands are disabled. Used when doing ":all" or
8761 * ":ball".
8763 if ( (autocmd_no_enter
8764 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8765 || (autocmd_no_leave
8766 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8767 goto BYPASS_AU;
8770 * Save the autocmd_* variables and info about the current buffer.
8772 save_autocmd_fname = autocmd_fname;
8773 save_autocmd_fname_full = autocmd_fname_full;
8774 save_autocmd_bufnr = autocmd_bufnr;
8775 save_autocmd_match = autocmd_match;
8776 save_autocmd_busy = autocmd_busy;
8777 save_autocmd_nested = autocmd_nested;
8778 save_changed = curbuf->b_changed;
8779 old_curbuf = curbuf;
8782 * Set the file name to be used for <afile>.
8783 * Make a copy to avoid that changing a buffer name or directory makes it
8784 * invalid.
8786 if (fname_io == NULL)
8788 if (fname != NULL && *fname != NUL)
8789 autocmd_fname = fname;
8790 else if (buf != NULL)
8791 autocmd_fname = buf->b_ffname;
8792 else
8793 autocmd_fname = NULL;
8795 else
8796 autocmd_fname = fname_io;
8797 if (autocmd_fname != NULL)
8798 autocmd_fname = vim_strsave(autocmd_fname);
8799 autocmd_fname_full = FALSE; /* call FullName_save() later */
8802 * Set the buffer number to be used for <abuf>.
8804 if (buf == NULL)
8805 autocmd_bufnr = 0;
8806 else
8807 autocmd_bufnr = buf->b_fnum;
8810 * When the file name is NULL or empty, use the file name of buffer "buf".
8811 * Always use the full path of the file name to match with, in case
8812 * "allow_dirs" is set.
8814 if (fname == NULL || *fname == NUL)
8816 if (buf == NULL)
8817 fname = NULL;
8818 else
8820 #ifdef FEAT_SYN_HL
8821 if (event == EVENT_SYNTAX)
8822 fname = buf->b_p_syn;
8823 else
8824 #endif
8825 if (event == EVENT_FILETYPE)
8826 fname = buf->b_p_ft;
8827 else
8829 if (buf->b_sfname != NULL)
8830 sfname = vim_strsave(buf->b_sfname);
8831 fname = buf->b_ffname;
8834 if (fname == NULL)
8835 fname = (char_u *)"";
8836 fname = vim_strsave(fname); /* make a copy, so we can change it */
8838 else
8840 sfname = vim_strsave(fname);
8841 /* Don't try expanding FileType, Syntax, FuncUndefined, WindowID or
8842 * QuickFixCmd* */
8843 if (event == EVENT_FILETYPE
8844 || event == EVENT_SYNTAX
8845 || event == EVENT_FUNCUNDEFINED
8846 || event == EVENT_REMOTEREPLY
8847 || event == EVENT_SPELLFILEMISSING
8848 || event == EVENT_QUICKFIXCMDPRE
8849 || event == EVENT_QUICKFIXCMDPOST)
8850 fname = vim_strsave(fname);
8851 else
8852 fname = FullName_save(fname, FALSE);
8854 if (fname == NULL) /* out of memory */
8856 vim_free(sfname);
8857 retval = FALSE;
8858 goto BYPASS_AU;
8861 #ifdef BACKSLASH_IN_FILENAME
8863 * Replace all backslashes with forward slashes. This makes the
8864 * autocommand patterns portable between Unix and MS-DOS.
8866 if (sfname != NULL)
8867 forward_slash(sfname);
8868 forward_slash(fname);
8869 #endif
8871 #ifdef VMS
8872 /* remove version for correct match */
8873 if (sfname != NULL)
8874 vms_remove_version(sfname);
8875 vms_remove_version(fname);
8876 #endif
8879 * Set the name to be used for <amatch>.
8881 autocmd_match = fname;
8884 /* Don't redraw while doing auto commands. */
8885 ++RedrawingDisabled;
8886 save_sourcing_name = sourcing_name;
8887 sourcing_name = NULL; /* don't free this one */
8888 save_sourcing_lnum = sourcing_lnum;
8889 sourcing_lnum = 0; /* no line number here */
8891 #ifdef FEAT_EVAL
8892 save_current_SID = current_SID;
8894 # ifdef FEAT_PROFILE
8895 if (do_profiling == PROF_YES)
8896 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
8897 # endif
8899 /* Don't use local function variables, if called from a function */
8900 save_funccalp = save_funccal();
8901 #endif
8904 * When starting to execute autocommands, save the search patterns.
8906 if (!autocmd_busy)
8908 save_search_patterns();
8909 saveRedobuff();
8910 did_filetype = keep_filetype;
8914 * Note that we are applying autocmds. Some commands need to know.
8916 autocmd_busy = TRUE;
8917 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
8918 ++nesting; /* see matching decrement below */
8920 /* Remember that FileType was triggered. Used for did_filetype(). */
8921 if (event == EVENT_FILETYPE)
8922 did_filetype = TRUE;
8924 tail = gettail(fname);
8926 /* Find first autocommand that matches */
8927 patcmd.curpat = first_autopat[(int)event];
8928 patcmd.nextcmd = NULL;
8929 patcmd.group = group;
8930 patcmd.fname = fname;
8931 patcmd.sfname = sfname;
8932 patcmd.tail = tail;
8933 patcmd.event = event;
8934 patcmd.arg_bufnr = autocmd_bufnr;
8935 patcmd.next = NULL;
8936 auto_next_pat(&patcmd, FALSE);
8938 /* found one, start executing the autocommands */
8939 if (patcmd.curpat != NULL)
8941 /* add to active_apc_list */
8942 patcmd.next = active_apc_list;
8943 active_apc_list = &patcmd;
8945 #ifdef FEAT_EVAL
8946 /* set v:cmdarg (only when there is a matching pattern) */
8947 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
8948 if (eap != NULL)
8950 save_cmdarg = set_cmdarg(eap, NULL);
8951 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
8953 else
8954 save_cmdarg = NULL; /* avoid gcc warning */
8955 #endif
8956 retval = TRUE;
8957 /* mark the last pattern, to avoid an endless loop when more patterns
8958 * are added when executing autocommands */
8959 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
8960 ap->last = FALSE;
8961 ap->last = TRUE;
8962 check_lnums(TRUE); /* make sure cursor and topline are valid */
8963 do_cmdline(NULL, getnextac, (void *)&patcmd,
8964 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
8965 #ifdef FEAT_EVAL
8966 if (eap != NULL)
8968 (void)set_cmdarg(NULL, save_cmdarg);
8969 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
8971 #endif
8972 /* delete from active_apc_list */
8973 if (active_apc_list == &patcmd) /* just in case */
8974 active_apc_list = patcmd.next;
8977 --RedrawingDisabled;
8978 autocmd_busy = save_autocmd_busy;
8979 filechangeshell_busy = FALSE;
8980 autocmd_nested = save_autocmd_nested;
8981 vim_free(sourcing_name);
8982 sourcing_name = save_sourcing_name;
8983 sourcing_lnum = save_sourcing_lnum;
8984 vim_free(autocmd_fname);
8985 autocmd_fname = save_autocmd_fname;
8986 autocmd_fname_full = save_autocmd_fname_full;
8987 autocmd_bufnr = save_autocmd_bufnr;
8988 autocmd_match = save_autocmd_match;
8989 #ifdef FEAT_EVAL
8990 current_SID = save_current_SID;
8991 restore_funccal(save_funccalp);
8992 # ifdef FEAT_PROFILE
8993 if (do_profiling == PROF_YES)
8994 prof_child_exit(&wait_time);
8995 # endif
8996 #endif
8997 vim_free(fname);
8998 vim_free(sfname);
8999 --nesting; /* see matching increment above */
9002 * When stopping to execute autocommands, restore the search patterns and
9003 * the redo buffer.
9005 if (!autocmd_busy)
9007 restore_search_patterns();
9008 restoreRedobuff();
9009 did_filetype = FALSE;
9013 * Some events don't set or reset the Changed flag.
9014 * Check if still in the same buffer!
9016 if (curbuf == old_curbuf
9017 && (event == EVENT_BUFREADPOST
9018 || event == EVENT_BUFWRITEPOST
9019 || event == EVENT_FILEAPPENDPOST
9020 || event == EVENT_VIMLEAVE
9021 || event == EVENT_VIMLEAVEPRE))
9023 #ifdef FEAT_TITLE
9024 if (curbuf->b_changed != save_changed)
9025 need_maketitle = TRUE;
9026 #endif
9027 curbuf->b_changed = save_changed;
9030 au_cleanup(); /* may really delete removed patterns/commands now */
9032 BYPASS_AU:
9033 /* When wiping out a buffer make sure all its buffer-local autocommands
9034 * are deleted. */
9035 if (event == EVENT_BUFWIPEOUT && buf != NULL)
9036 aubuflocal_remove(buf);
9038 return retval;
9041 # ifdef FEAT_EVAL
9042 static char_u *old_termresponse = NULL;
9043 # endif
9046 * Block triggering autocommands until unblock_autocmd() is called.
9047 * Can be used recursively, so long as it's symmetric.
9049 void
9050 block_autocmds()
9052 # ifdef FEAT_EVAL
9053 /* Remember the value of v:termresponse. */
9054 if (autocmd_blocked == 0)
9055 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
9056 # endif
9057 ++autocmd_blocked;
9060 void
9061 unblock_autocmds()
9063 --autocmd_blocked;
9065 # ifdef FEAT_EVAL
9066 /* When v:termresponse was set while autocommands were blocked, trigger
9067 * the autocommands now. Esp. useful when executing a shell command
9068 * during startup (vimdiff). */
9069 if (autocmd_blocked == 0
9070 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
9071 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
9072 # endif
9076 * Find next autocommand pattern that matches.
9078 static void
9079 auto_next_pat(apc, stop_at_last)
9080 AutoPatCmd *apc;
9081 int stop_at_last; /* stop when 'last' flag is set */
9083 AutoPat *ap;
9084 AutoCmd *cp;
9085 char_u *name;
9086 char *s;
9088 vim_free(sourcing_name);
9089 sourcing_name = NULL;
9091 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
9093 apc->curpat = NULL;
9095 /* Only use a pattern when it has not been removed, has commands and
9096 * the group matches. For buffer-local autocommands only check the
9097 * buffer number. */
9098 if (ap->pat != NULL && ap->cmds != NULL
9099 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
9101 /* execution-condition */
9102 if (ap->buflocal_nr == 0
9103 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
9104 apc->sfname, apc->tail, ap->allow_dirs))
9105 : ap->buflocal_nr == apc->arg_bufnr)
9107 name = event_nr2name(apc->event);
9108 s = _("%s Auto commands for \"%s\"");
9109 sourcing_name = alloc((unsigned)(STRLEN(s)
9110 + STRLEN(name) + ap->patlen + 1));
9111 if (sourcing_name != NULL)
9113 sprintf((char *)sourcing_name, s,
9114 (char *)name, (char *)ap->pat);
9115 if (p_verbose >= 8)
9117 verbose_enter();
9118 smsg((char_u *)_("Executing %s"), sourcing_name);
9119 verbose_leave();
9123 apc->curpat = ap;
9124 apc->nextcmd = ap->cmds;
9125 /* mark last command */
9126 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
9127 cp->last = FALSE;
9128 cp->last = TRUE;
9130 line_breakcheck();
9131 if (apc->curpat != NULL) /* found a match */
9132 break;
9134 if (stop_at_last && ap->last)
9135 break;
9140 * Get next autocommand command.
9141 * Called by do_cmdline() to get the next line for ":if".
9142 * Returns allocated string, or NULL for end of autocommands.
9144 static char_u *
9145 getnextac(c, cookie, indent)
9146 int c UNUSED;
9147 void *cookie;
9148 int indent UNUSED;
9150 AutoPatCmd *acp = (AutoPatCmd *)cookie;
9151 char_u *retval;
9152 AutoCmd *ac;
9154 /* Can be called again after returning the last line. */
9155 if (acp->curpat == NULL)
9156 return NULL;
9158 /* repeat until we find an autocommand to execute */
9159 for (;;)
9161 /* skip removed commands */
9162 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
9163 if (acp->nextcmd->last)
9164 acp->nextcmd = NULL;
9165 else
9166 acp->nextcmd = acp->nextcmd->next;
9168 if (acp->nextcmd != NULL)
9169 break;
9171 /* at end of commands, find next pattern that matches */
9172 if (acp->curpat->last)
9173 acp->curpat = NULL;
9174 else
9175 acp->curpat = acp->curpat->next;
9176 if (acp->curpat != NULL)
9177 auto_next_pat(acp, TRUE);
9178 if (acp->curpat == NULL)
9179 return NULL;
9182 ac = acp->nextcmd;
9184 if (p_verbose >= 9)
9186 verbose_enter_scroll();
9187 smsg((char_u *)_("autocommand %s"), ac->cmd);
9188 msg_puts((char_u *)"\n"); /* don't overwrite this either */
9189 verbose_leave_scroll();
9191 retval = vim_strsave(ac->cmd);
9192 autocmd_nested = ac->nested;
9193 #ifdef FEAT_EVAL
9194 current_SID = ac->scriptID;
9195 #endif
9196 if (ac->last)
9197 acp->nextcmd = NULL;
9198 else
9199 acp->nextcmd = ac->next;
9200 return retval;
9204 * Return TRUE if there is a matching autocommand for "fname".
9205 * To account for buffer-local autocommands, function needs to know
9206 * in which buffer the file will be opened.
9209 has_autocmd(event, sfname, buf)
9210 event_T event;
9211 char_u *sfname;
9212 buf_T *buf;
9214 AutoPat *ap;
9215 char_u *fname;
9216 char_u *tail = gettail(sfname);
9217 int retval = FALSE;
9219 fname = FullName_save(sfname, FALSE);
9220 if (fname == NULL)
9221 return FALSE;
9223 #ifdef BACKSLASH_IN_FILENAME
9225 * Replace all backslashes with forward slashes. This makes the
9226 * autocommand patterns portable between Unix and MS-DOS.
9228 sfname = vim_strsave(sfname);
9229 if (sfname != NULL)
9230 forward_slash(sfname);
9231 forward_slash(fname);
9232 #endif
9234 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
9235 if (ap->pat != NULL && ap->cmds != NULL
9236 && (ap->buflocal_nr == 0
9237 ? match_file_pat(NULL, ap->reg_prog,
9238 fname, sfname, tail, ap->allow_dirs)
9239 : buf != NULL && ap->buflocal_nr == buf->b_fnum
9242 retval = TRUE;
9243 break;
9246 vim_free(fname);
9247 #ifdef BACKSLASH_IN_FILENAME
9248 vim_free(sfname);
9249 #endif
9251 return retval;
9254 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9256 * Function given to ExpandGeneric() to obtain the list of autocommand group
9257 * names.
9259 char_u *
9260 get_augroup_name(xp, idx)
9261 expand_T *xp UNUSED;
9262 int idx;
9264 if (idx == augroups.ga_len) /* add "END" add the end */
9265 return (char_u *)"END";
9266 if (idx >= augroups.ga_len) /* end of list */
9267 return NULL;
9268 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
9269 return (char_u *)"";
9270 return AUGROUP_NAME(idx); /* return a name */
9273 static int include_groups = FALSE;
9275 char_u *
9276 set_context_in_autocmd(xp, arg, doautocmd)
9277 expand_T *xp;
9278 char_u *arg;
9279 int doautocmd; /* TRUE for :doauto*, FALSE for :autocmd */
9281 char_u *p;
9282 int group;
9284 /* check for a group name, skip it if present */
9285 include_groups = FALSE;
9286 p = arg;
9287 group = au_get_grouparg(&arg);
9288 if (group == AUGROUP_ERROR)
9289 return NULL;
9290 /* If there only is a group name that's what we expand. */
9291 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
9293 arg = p;
9294 group = AUGROUP_ALL;
9297 /* skip over event name */
9298 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
9299 if (*p == ',')
9300 arg = p + 1;
9301 if (*p == NUL)
9303 if (group == AUGROUP_ALL)
9304 include_groups = TRUE;
9305 xp->xp_context = EXPAND_EVENTS; /* expand event name */
9306 xp->xp_pattern = arg;
9307 return NULL;
9310 /* skip over pattern */
9311 arg = skipwhite(p);
9312 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
9313 arg++;
9314 if (*arg)
9315 return arg; /* expand (next) command */
9317 if (doautocmd)
9318 xp->xp_context = EXPAND_FILES; /* expand file names */
9319 else
9320 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
9321 return NULL;
9325 * Function given to ExpandGeneric() to obtain the list of event names.
9327 char_u *
9328 get_event_name(xp, idx)
9329 expand_T *xp UNUSED;
9330 int idx;
9332 if (idx < augroups.ga_len) /* First list group names, if wanted */
9334 if (!include_groups || AUGROUP_NAME(idx) == NULL)
9335 return (char_u *)""; /* skip deleted entries */
9336 return AUGROUP_NAME(idx); /* return a name */
9338 return (char_u *)event_names[idx - augroups.ga_len].name;
9341 #endif /* FEAT_CMDL_COMPL */
9344 * Return TRUE if autocmd is supported.
9347 autocmd_supported(name)
9348 char_u *name;
9350 char_u *p;
9352 return (event_name2nr(name, &p) != NUM_EVENTS);
9356 * Return TRUE if an autocommand is defined for a group, event and
9357 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9358 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9359 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9360 * Used for:
9361 * exists("#Group") or
9362 * exists("#Group#Event") or
9363 * exists("#Group#Event#pat") or
9364 * exists("#Event") or
9365 * exists("#Event#pat")
9368 au_exists(arg)
9369 char_u *arg;
9371 char_u *arg_save;
9372 char_u *pattern = NULL;
9373 char_u *event_name;
9374 char_u *p;
9375 event_T event;
9376 AutoPat *ap;
9377 buf_T *buflocal_buf = NULL;
9378 int group;
9379 int retval = FALSE;
9381 /* Make a copy so that we can change the '#' chars to a NUL. */
9382 arg_save = vim_strsave(arg);
9383 if (arg_save == NULL)
9384 return FALSE;
9385 p = vim_strchr(arg_save, '#');
9386 if (p != NULL)
9387 *p++ = NUL;
9389 /* First, look for an autocmd group name */
9390 group = au_find_group(arg_save);
9391 if (group == AUGROUP_ERROR)
9393 /* Didn't match a group name, assume the first argument is an event. */
9394 group = AUGROUP_ALL;
9395 event_name = arg_save;
9397 else
9399 if (p == NULL)
9401 /* "Group": group name is present and it's recognized */
9402 retval = TRUE;
9403 goto theend;
9406 /* Must be "Group#Event" or "Group#Event#pat". */
9407 event_name = p;
9408 p = vim_strchr(event_name, '#');
9409 if (p != NULL)
9410 *p++ = NUL; /* "Group#Event#pat" */
9413 pattern = p; /* "pattern" is NULL when there is no pattern */
9415 /* find the index (enum) for the event name */
9416 event = event_name2nr(event_name, &p);
9418 /* return FALSE if the event name is not recognized */
9419 if (event == NUM_EVENTS)
9420 goto theend;
9422 /* Find the first autocommand for this event.
9423 * If there isn't any, return FALSE;
9424 * If there is one and no pattern given, return TRUE; */
9425 ap = first_autopat[(int)event];
9426 if (ap == NULL)
9427 goto theend;
9428 if (pattern == NULL)
9430 retval = TRUE;
9431 goto theend;
9434 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9435 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9436 if (STRICMP(pattern, "<buffer>") == 0)
9437 buflocal_buf = curbuf;
9439 /* Check if there is an autocommand with the given pattern. */
9440 for ( ; ap != NULL; ap = ap->next)
9441 /* only use a pattern when it has not been removed and has commands. */
9442 /* For buffer-local autocommands, fnamecmp() works fine. */
9443 if (ap->pat != NULL && ap->cmds != NULL
9444 && (group == AUGROUP_ALL || ap->group == group)
9445 && (buflocal_buf == NULL
9446 ? fnamecmp(ap->pat, pattern) == 0
9447 : ap->buflocal_nr == buflocal_buf->b_fnum))
9449 retval = TRUE;
9450 break;
9453 theend:
9454 vim_free(arg_save);
9455 return retval;
9458 #else /* FEAT_AUTOCMD */
9461 * Prepare for executing commands for (hidden) buffer "buf".
9462 * This is the non-autocommand version, it simply saves "curbuf" and sets
9463 * "curbuf" and "curwin" to match "buf".
9465 void
9466 aucmd_prepbuf(aco, buf)
9467 aco_save_T *aco; /* structure to save values in */
9468 buf_T *buf; /* new curbuf */
9470 aco->save_curbuf = curbuf;
9471 --curbuf->b_nwindows;
9472 curbuf = buf;
9473 curwin->w_buffer = buf;
9474 ++curbuf->b_nwindows;
9478 * Restore after executing commands for a (hidden) buffer.
9479 * This is the non-autocommand version.
9481 void
9482 aucmd_restbuf(aco)
9483 aco_save_T *aco; /* structure holding saved values */
9485 --curbuf->b_nwindows;
9486 curbuf = aco->save_curbuf;
9487 curwin->w_buffer = curbuf;
9488 ++curbuf->b_nwindows;
9491 #endif /* FEAT_AUTOCMD */
9494 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9496 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9497 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9498 * vim_regcomp() often.
9499 * Used for autocommands and 'wildignore'.
9500 * Returns TRUE if there is a match, FALSE otherwise.
9503 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9504 char_u *pattern; /* pattern to match with */
9505 regprog_T *prog; /* pre-compiled regprog or NULL */
9506 char_u *fname; /* full path of file name */
9507 char_u *sfname; /* short file name or NULL */
9508 char_u *tail; /* tail of path */
9509 int allow_dirs; /* allow matching with dir */
9511 regmatch_T regmatch;
9512 int result = FALSE;
9513 #ifdef FEAT_OSFILETYPE
9514 int no_pattern = FALSE; /* TRUE if check is filetype only */
9515 char_u *type_start;
9516 char_u c;
9517 int match = FALSE;
9518 #endif
9520 #ifdef CASE_INSENSITIVE_FILENAME
9521 regmatch.rm_ic = TRUE; /* Always ignore case */
9522 #else
9523 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9524 #endif
9525 #ifdef FEAT_OSFILETYPE
9526 if (*pattern == '<')
9528 /* There is a filetype condition specified with this pattern.
9529 * Check the filetype matches first. If not, don't bother with the
9530 * pattern (set regprog to NULL).
9531 * Always use magic for the regexp.
9534 for (type_start = pattern + 1; (c = *pattern); pattern++)
9536 if ((c == ';' || c == '>') && match == FALSE)
9538 *pattern = NUL; /* Terminate the string */
9539 match = mch_check_filetype(fname, type_start);
9540 *pattern = c; /* Restore the terminator */
9541 type_start = pattern + 1;
9543 if (c == '>')
9544 break;
9547 /* (c should never be NUL, but check anyway) */
9548 if (match == FALSE || c == NUL)
9549 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9550 else if (*pattern == NUL)
9552 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9553 no_pattern = TRUE; /* Always matches - don't check pat. */
9555 else
9556 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9558 else
9559 #endif
9561 if (prog != NULL)
9562 regmatch.regprog = prog;
9563 else
9564 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9568 * Try for a match with the pattern with:
9569 * 1. the full file name, when the pattern has a '/'.
9570 * 2. the short file name, when the pattern has a '/'.
9571 * 3. the tail of the file name, when the pattern has no '/'.
9573 if (
9574 #ifdef FEAT_OSFILETYPE
9575 /* If the check is for a filetype only and we don't care
9576 * about the path then skip all the regexp stuff.
9578 no_pattern ||
9579 #endif
9580 (regmatch.regprog != NULL
9581 && ((allow_dirs
9582 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9583 || (sfname != NULL
9584 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9585 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9586 result = TRUE;
9588 if (prog == NULL)
9589 vim_free(regmatch.regprog);
9590 return result;
9592 #endif
9594 #if defined(FEAT_WILDIGN) || defined(PROTO)
9596 * Return TRUE if a file matches with a pattern in "list".
9597 * "list" is a comma-separated list of patterns, like 'wildignore'.
9598 * "sfname" is the short file name or NULL, "ffname" the long file name.
9601 match_file_list(list, sfname, ffname)
9602 char_u *list;
9603 char_u *sfname;
9604 char_u *ffname;
9606 char_u buf[100];
9607 char_u *tail;
9608 char_u *regpat;
9609 char allow_dirs;
9610 int match;
9611 char_u *p;
9613 tail = gettail(sfname);
9615 /* try all patterns in 'wildignore' */
9616 p = list;
9617 while (*p)
9619 copy_option_part(&p, buf, 100, ",");
9620 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9621 if (regpat == NULL)
9622 break;
9623 match = match_file_pat(regpat, NULL, ffname, sfname,
9624 tail, (int)allow_dirs);
9625 vim_free(regpat);
9626 if (match)
9627 return TRUE;
9629 return FALSE;
9631 #endif
9634 * Convert the given pattern "pat" which has shell style wildcards in it, into
9635 * a regular expression, and return the result in allocated memory. If there
9636 * is a directory path separator to be matched, then TRUE is put in
9637 * allow_dirs, otherwise FALSE is put there -- webb.
9638 * Handle backslashes before special characters, like "\*" and "\ ".
9640 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9641 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9643 * Returns NULL when out of memory.
9645 char_u *
9646 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9647 char_u *pat;
9648 char_u *pat_end; /* first char after pattern or NULL */
9649 char *allow_dirs; /* Result passed back out in here */
9650 int no_bslash UNUSED; /* Don't use a backward slash as pathsep */
9652 int size;
9653 char_u *endp;
9654 char_u *reg_pat;
9655 char_u *p;
9656 int i;
9657 int nested = 0;
9658 int add_dollar = TRUE;
9659 #ifdef FEAT_OSFILETYPE
9660 int check_length = 0;
9661 #endif
9663 if (allow_dirs != NULL)
9664 *allow_dirs = FALSE;
9665 if (pat_end == NULL)
9666 pat_end = pat + STRLEN(pat);
9668 #ifdef FEAT_OSFILETYPE
9669 /* Find out how much of the string is the filetype check */
9670 if (*pat == '<')
9672 /* Count chars until the next '>' */
9673 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9675 if (p < pat_end)
9677 /* Pattern is of the form <.*>.* */
9678 check_length = p - pat + 1;
9679 if (p + 1 >= pat_end)
9681 /* The 'pattern' is a filetype check ONLY */
9682 reg_pat = (char_u *)alloc(check_length + 1);
9683 if (reg_pat != NULL)
9685 mch_memmove(reg_pat, pat, (size_t)check_length);
9686 reg_pat[check_length] = NUL;
9688 return reg_pat;
9691 /* else: there was no closing '>' - assume it was a normal pattern */
9694 pat += check_length;
9695 size = 2 + check_length;
9696 #else
9697 size = 2; /* '^' at start, '$' at end */
9698 #endif
9700 for (p = pat; p < pat_end; p++)
9702 switch (*p)
9704 case '*':
9705 case '.':
9706 case ',':
9707 case '{':
9708 case '}':
9709 case '~':
9710 size += 2; /* extra backslash */
9711 break;
9712 #ifdef BACKSLASH_IN_FILENAME
9713 case '\\':
9714 case '/':
9715 size += 4; /* could become "[\/]" */
9716 break;
9717 #endif
9718 default:
9719 size++;
9720 # ifdef FEAT_MBYTE
9721 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9723 ++p;
9724 ++size;
9726 # endif
9727 break;
9730 reg_pat = alloc(size + 1);
9731 if (reg_pat == NULL)
9732 return NULL;
9734 #ifdef FEAT_OSFILETYPE
9735 /* Copy the type check in to the start. */
9736 if (check_length)
9737 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9738 i = check_length;
9739 #else
9740 i = 0;
9741 #endif
9743 if (pat[0] == '*')
9744 while (pat[0] == '*' && pat < pat_end - 1)
9745 pat++;
9746 else
9747 reg_pat[i++] = '^';
9748 endp = pat_end - 1;
9749 if (*endp == '*')
9751 while (endp - pat > 0 && *endp == '*')
9752 endp--;
9753 add_dollar = FALSE;
9755 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9757 switch (*p)
9759 case '*':
9760 reg_pat[i++] = '.';
9761 reg_pat[i++] = '*';
9762 while (p[1] == '*') /* "**" matches like "*" */
9763 ++p;
9764 break;
9765 case '.':
9766 #ifdef RISCOS
9767 if (allow_dirs != NULL)
9768 *allow_dirs = TRUE;
9769 /* FALLTHROUGH */
9770 #endif
9771 case '~':
9772 reg_pat[i++] = '\\';
9773 reg_pat[i++] = *p;
9774 break;
9775 case '?':
9776 #ifdef RISCOS
9777 case '#':
9778 #endif
9779 reg_pat[i++] = '.';
9780 break;
9781 case '\\':
9782 if (p[1] == NUL)
9783 break;
9784 #ifdef BACKSLASH_IN_FILENAME
9785 if (!no_bslash)
9787 /* translate:
9788 * "\x" to "\\x" e.g., "dir\file"
9789 * "\*" to "\\.*" e.g., "dir\*.c"
9790 * "\?" to "\\." e.g., "dir\??.c"
9791 * "\+" to "\+" e.g., "fileX\+.c"
9793 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9794 && p[1] != '+')
9796 reg_pat[i++] = '[';
9797 reg_pat[i++] = '\\';
9798 reg_pat[i++] = '/';
9799 reg_pat[i++] = ']';
9800 if (allow_dirs != NULL)
9801 *allow_dirs = TRUE;
9802 break;
9805 #endif
9806 if (*++p == '?'
9807 #ifdef BACKSLASH_IN_FILENAME
9808 && no_bslash
9809 #endif
9811 reg_pat[i++] = '?';
9812 else
9813 if (*p == ',')
9814 reg_pat[i++] = ',';
9815 else
9817 if (allow_dirs != NULL && vim_ispathsep(*p)
9818 #ifdef BACKSLASH_IN_FILENAME
9819 && (!no_bslash || *p != '\\')
9820 #endif
9822 *allow_dirs = TRUE;
9823 reg_pat[i++] = '\\';
9824 reg_pat[i++] = *p;
9826 break;
9827 #ifdef BACKSLASH_IN_FILENAME
9828 case '/':
9829 reg_pat[i++] = '[';
9830 reg_pat[i++] = '\\';
9831 reg_pat[i++] = '/';
9832 reg_pat[i++] = ']';
9833 if (allow_dirs != NULL)
9834 *allow_dirs = TRUE;
9835 break;
9836 #endif
9837 case '{':
9838 reg_pat[i++] = '\\';
9839 reg_pat[i++] = '(';
9840 nested++;
9841 break;
9842 case '}':
9843 reg_pat[i++] = '\\';
9844 reg_pat[i++] = ')';
9845 --nested;
9846 break;
9847 case ',':
9848 if (nested)
9850 reg_pat[i++] = '\\';
9851 reg_pat[i++] = '|';
9853 else
9854 reg_pat[i++] = ',';
9855 break;
9856 default:
9857 # ifdef FEAT_MBYTE
9858 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9859 reg_pat[i++] = *p++;
9860 else
9861 # endif
9862 if (allow_dirs != NULL && vim_ispathsep(*p))
9863 *allow_dirs = TRUE;
9864 reg_pat[i++] = *p;
9865 break;
9868 if (add_dollar)
9869 reg_pat[i++] = '$';
9870 reg_pat[i] = NUL;
9871 if (nested != 0)
9873 if (nested < 0)
9874 EMSG(_("E219: Missing {."));
9875 else
9876 EMSG(_("E220: Missing }."));
9877 vim_free(reg_pat);
9878 reg_pat = NULL;
9880 return reg_pat;