[7.2.261] When deleting lines with a specific folding configuration E38 may
[vim_mainline.git] / src / fileio.c
blob5deb1a3984f13c320dbe27623d1c568205d3e948
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 linenr_T bw_conv_error_lnum; /* first line with error or zero */
125 linenr_T bw_start_lnum; /* line number at start of buffer */
126 # ifdef USE_ICONV
127 iconv_t bw_iconv_fd; /* descriptor for iconv() or -1 */
128 # endif
129 #endif
132 static int buf_write_bytes __ARGS((struct bw_info *ip));
134 #ifdef FEAT_MBYTE
135 static linenr_T readfile_linenr __ARGS((linenr_T linecnt, char_u *p, char_u *endp));
136 static int ucs2bytes __ARGS((unsigned c, char_u **pp, int flags));
137 static int need_conversion __ARGS((char_u *fenc));
138 static int get_fio_flags __ARGS((char_u *ptr));
139 static char_u *check_for_bom __ARGS((char_u *p, long size, int *lenp, int flags));
140 static int make_bom __ARGS((char_u *buf, char_u *name));
141 # ifdef WIN3264
142 static int get_win_fio_flags __ARGS((char_u *ptr));
143 # endif
144 # ifdef MACOS_X
145 static int get_mac_fio_flags __ARGS((char_u *ptr));
146 # endif
147 #endif
148 static int move_lines __ARGS((buf_T *frombuf, buf_T *tobuf));
149 #ifdef FEAT_AUTOCMD
150 static char *e_auchangedbuf = N_("E812: Autocommands changed buffer or buffer name");
151 #endif
153 void
154 filemess(buf, name, s, attr)
155 buf_T *buf;
156 char_u *name;
157 char_u *s;
158 int attr;
160 int msg_scroll_save;
162 if (msg_silent != 0)
163 return;
164 msg_add_fname(buf, name); /* put file name in IObuff with quotes */
165 /* If it's extremely long, truncate it. */
166 if (STRLEN(IObuff) > IOSIZE - 80)
167 IObuff[IOSIZE - 80] = NUL;
168 STRCAT(IObuff, s);
170 * For the first message may have to start a new line.
171 * For further ones overwrite the previous one, reset msg_scroll before
172 * calling filemess().
174 msg_scroll_save = msg_scroll;
175 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
176 msg_scroll = FALSE;
177 if (!msg_scroll) /* wait a bit when overwriting an error msg */
178 check_for_delay(FALSE);
179 msg_start();
180 msg_scroll = msg_scroll_save;
181 msg_scrolled_ign = TRUE;
182 /* may truncate the message to avoid a hit-return prompt */
183 msg_outtrans_attr(msg_may_trunc(FALSE, IObuff), attr);
184 msg_clr_eos();
185 out_flush();
186 msg_scrolled_ign = FALSE;
190 * Read lines from file "fname" into the buffer after line "from".
192 * 1. We allocate blocks with lalloc, as big as possible.
193 * 2. Each block is filled with characters from the file with a single read().
194 * 3. The lines are inserted in the buffer with ml_append().
196 * (caller must check that fname != NULL, unless READ_STDIN is used)
198 * "lines_to_skip" is the number of lines that must be skipped
199 * "lines_to_read" is the number of lines that are appended
200 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
202 * flags:
203 * READ_NEW starting to edit a new buffer
204 * READ_FILTER reading filter output
205 * READ_STDIN read from stdin instead of a file
206 * READ_BUFFER read from curbuf instead of a file (converting after reading
207 * stdin)
208 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
210 * return FAIL for failure, OK otherwise
213 readfile(fname, sfname, from, lines_to_skip, lines_to_read, eap, flags)
214 char_u *fname;
215 char_u *sfname;
216 linenr_T from;
217 linenr_T lines_to_skip;
218 linenr_T lines_to_read;
219 exarg_T *eap; /* can be NULL! */
220 int flags;
222 int fd = 0;
223 int newfile = (flags & READ_NEW);
224 int check_readonly;
225 int filtering = (flags & READ_FILTER);
226 int read_stdin = (flags & READ_STDIN);
227 int read_buffer = (flags & READ_BUFFER);
228 int set_options = newfile || read_buffer
229 || (eap != NULL && eap->read_edit);
230 linenr_T read_buf_lnum = 1; /* next line to read from curbuf */
231 colnr_T read_buf_col = 0; /* next char to read from this line */
232 char_u c;
233 linenr_T lnum = from;
234 char_u *ptr = NULL; /* pointer into read buffer */
235 char_u *buffer = NULL; /* read buffer */
236 char_u *new_buffer = NULL; /* init to shut up gcc */
237 char_u *line_start = NULL; /* init to shut up gcc */
238 int wasempty; /* buffer was empty before reading */
239 colnr_T len;
240 long size = 0;
241 char_u *p;
242 long filesize = 0;
243 int skip_read = FALSE;
244 #ifdef FEAT_CRYPT
245 char_u *cryptkey = NULL;
246 #endif
247 int split = 0; /* number of split lines */
248 #define UNKNOWN 0x0fffffff /* file size is unknown */
249 linenr_T linecnt;
250 int error = FALSE; /* errors encountered */
251 int ff_error = EOL_UNKNOWN; /* file format with errors */
252 long linerest = 0; /* remaining chars in line */
253 #ifdef UNIX
254 int perm = 0;
255 int swap_mode = -1; /* protection bits for swap file */
256 #else
257 int perm;
258 #endif
259 int fileformat = 0; /* end-of-line format */
260 int keep_fileformat = FALSE;
261 struct stat st;
262 int file_readonly;
263 linenr_T skip_count = 0;
264 linenr_T read_count = 0;
265 int msg_save = msg_scroll;
266 linenr_T read_no_eol_lnum = 0; /* non-zero lnum when last line of
267 * last read was missing the eol */
268 int try_mac = (vim_strchr(p_ffs, 'm') != NULL);
269 int try_dos = (vim_strchr(p_ffs, 'd') != NULL);
270 int try_unix = (vim_strchr(p_ffs, 'x') != NULL);
271 int file_rewind = FALSE;
272 #ifdef FEAT_MBYTE
273 int can_retry;
274 linenr_T conv_error = 0; /* line nr with conversion error */
275 linenr_T illegal_byte = 0; /* line nr with illegal byte */
276 int keep_dest_enc = FALSE; /* don't retry when char doesn't fit
277 in destination encoding */
278 int bad_char_behavior = BAD_REPLACE;
279 /* BAD_KEEP, BAD_DROP or character to
280 * replace with */
281 char_u *tmpname = NULL; /* name of 'charconvert' output file */
282 int fio_flags = 0;
283 char_u *fenc; /* fileencoding to use */
284 int fenc_alloced; /* fenc_next is in allocated memory */
285 char_u *fenc_next = NULL; /* next item in 'fencs' or NULL */
286 int advance_fenc = FALSE;
287 long real_size = 0;
288 # ifdef USE_ICONV
289 iconv_t iconv_fd = (iconv_t)-1; /* descriptor for iconv() or -1 */
290 # ifdef FEAT_EVAL
291 int did_iconv = FALSE; /* TRUE when iconv() failed and trying
292 'charconvert' next */
293 # endif
294 # endif
295 int converted = FALSE; /* TRUE if conversion done */
296 int notconverted = FALSE; /* TRUE if conversion wanted but it
297 wasn't possible */
298 char_u conv_rest[CONV_RESTLEN];
299 int conv_restlen = 0; /* nr of bytes in conv_rest[] */
300 #endif
302 #ifdef FEAT_AUTOCMD
303 /* Remember the initial values of curbuf, curbuf->b_ffname and
304 * curbuf->b_fname to detect whether they are altered as a result of
305 * executing nasty autocommands. Also check if "fname" and "sfname"
306 * point to one of these values. */
307 buf_T *old_curbuf = curbuf;
308 char_u *old_b_ffname = curbuf->b_ffname;
309 char_u *old_b_fname = curbuf->b_fname;
310 int using_b_ffname = (fname == curbuf->b_ffname)
311 || (sfname == curbuf->b_ffname);
312 int using_b_fname = (fname == curbuf->b_fname)
313 || (sfname == curbuf->b_fname);
314 #endif
315 write_no_eol_lnum = 0; /* in case it was set by the previous read */
318 * If there is no file name yet, use the one for the read file.
319 * BF_NOTEDITED is set to reflect this.
320 * Don't do this for a read from a filter.
321 * Only do this when 'cpoptions' contains the 'f' flag.
323 if (curbuf->b_ffname == NULL
324 && !filtering
325 && fname != NULL
326 && vim_strchr(p_cpo, CPO_FNAMER) != NULL
327 && !(flags & READ_DUMMY))
329 if (set_rw_fname(fname, sfname) == FAIL)
330 return FAIL;
333 /* After reading a file the cursor line changes but we don't want to
334 * display the line. */
335 ex_no_reprint = TRUE;
337 /* don't display the file info for another buffer now */
338 need_fileinfo = FALSE;
341 * For Unix: Use the short file name whenever possible.
342 * Avoids problems with networks and when directory names are changed.
343 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
344 * another directory, which we don't detect.
346 if (sfname == NULL)
347 sfname = fname;
348 #if defined(UNIX) || defined(__EMX__)
349 fname = sfname;
350 #endif
352 #ifdef FEAT_AUTOCMD
354 * The BufReadCmd and FileReadCmd events intercept the reading process by
355 * executing the associated commands instead.
357 if (!filtering && !read_stdin && !read_buffer)
359 pos_T pos;
361 pos = curbuf->b_op_start;
363 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
364 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
365 curbuf->b_op_start.col = 0;
367 if (newfile)
369 if (apply_autocmds_exarg(EVENT_BUFREADCMD, NULL, sfname,
370 FALSE, curbuf, eap))
371 #ifdef FEAT_EVAL
372 return aborting() ? FAIL : OK;
373 #else
374 return OK;
375 #endif
377 else if (apply_autocmds_exarg(EVENT_FILEREADCMD, sfname, sfname,
378 FALSE, NULL, eap))
379 #ifdef FEAT_EVAL
380 return aborting() ? FAIL : OK;
381 #else
382 return OK;
383 #endif
385 curbuf->b_op_start = pos;
387 #endif
389 if ((shortmess(SHM_OVER) || curbuf->b_help) && p_verbose == 0)
390 msg_scroll = FALSE; /* overwrite previous file message */
391 else
392 msg_scroll = TRUE; /* don't overwrite previous file message */
395 * If the name ends in a path separator, we can't open it. Check here,
396 * because reading the file may actually work, but then creating the swap
397 * file may destroy it! Reported on MS-DOS and Win 95.
398 * If the name is too long we might crash further on, quit here.
400 if (fname != NULL && *fname != NUL)
402 p = fname + STRLEN(fname);
403 if (after_pathsep(fname, p) || STRLEN(fname) >= MAXPATHL)
405 filemess(curbuf, fname, (char_u *)_("Illegal file name"), 0);
406 msg_end();
407 msg_scroll = msg_save;
408 return FAIL;
412 #ifdef UNIX
414 * On Unix it is possible to read a directory, so we have to
415 * check for it before the mch_open().
417 if (!read_stdin && !read_buffer)
419 perm = mch_getperm(fname);
420 if (perm >= 0 && !S_ISREG(perm) /* not a regular file ... */
421 # ifdef S_ISFIFO
422 && !S_ISFIFO(perm) /* ... or fifo */
423 # endif
424 # ifdef S_ISSOCK
425 && !S_ISSOCK(perm) /* ... or socket */
426 # endif
427 # ifdef OPEN_CHR_FILES
428 && !(S_ISCHR(perm) && is_dev_fd_file(fname))
429 /* ... or a character special file named /dev/fd/<n> */
430 # endif
433 if (S_ISDIR(perm))
434 filemess(curbuf, fname, (char_u *)_("is a directory"), 0);
435 else
436 filemess(curbuf, fname, (char_u *)_("is not a file"), 0);
437 msg_end();
438 msg_scroll = msg_save;
439 return FAIL;
442 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
444 * MS-Windows allows opening a device, but we will probably get stuck
445 * trying to read it.
447 if (!p_odev && mch_nodetype(fname) == NODE_WRITABLE)
449 filemess(curbuf, fname, (char_u *)_("is a device (disabled with 'opendevice' option)"), 0);
450 msg_end();
451 msg_scroll = msg_save;
452 return FAIL;
454 # endif
456 #endif
458 /* set default 'fileformat' */
459 if (set_options)
461 if (eap != NULL && eap->force_ff != 0)
462 set_fileformat(get_fileformat_force(curbuf, eap), OPT_LOCAL);
463 else if (*p_ffs != NUL)
464 set_fileformat(default_fileformat(), OPT_LOCAL);
467 /* set or reset 'binary' */
468 if (eap != NULL && eap->force_bin != 0)
470 int oldval = curbuf->b_p_bin;
472 curbuf->b_p_bin = (eap->force_bin == FORCE_BIN);
473 set_options_bin(oldval, curbuf->b_p_bin, OPT_LOCAL);
477 * When opening a new file we take the readonly flag from the file.
478 * Default is r/w, can be set to r/o below.
479 * Don't reset it when in readonly mode
480 * Only set/reset b_p_ro when BF_CHECK_RO is set.
482 check_readonly = (newfile && (curbuf->b_flags & BF_CHECK_RO));
483 if (check_readonly && !readonlymode)
484 curbuf->b_p_ro = FALSE;
486 if (newfile && !read_stdin && !read_buffer)
488 /* Remember time of file.
489 * For RISCOS, also remember the filetype.
491 if (mch_stat((char *)fname, &st) >= 0)
493 buf_store_time(curbuf, &st, fname);
494 curbuf->b_mtime_read = curbuf->b_mtime;
496 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
497 /* Read the filetype into the buffer local filetype option. */
498 mch_read_filetype(fname);
499 #endif
500 #ifdef UNIX
502 * Use the protection bits of the original file for the swap file.
503 * This makes it possible for others to read the name of the
504 * edited file from the swapfile, but only if they can read the
505 * edited file.
506 * Remove the "write" and "execute" bits for group and others
507 * (they must not write the swapfile).
508 * Add the "read" and "write" bits for the user, otherwise we may
509 * not be able to write to the file ourselves.
510 * Setting the bits is done below, after creating the swap file.
512 swap_mode = (st.st_mode & 0644) | 0600;
513 #endif
514 #ifdef FEAT_CW_EDITOR
515 /* Get the FSSpec on MacOS
516 * TODO: Update it properly when the buffer name changes
518 (void)GetFSSpecFromPath(curbuf->b_ffname, &curbuf->b_FSSpec);
519 #endif
520 #ifdef VMS
521 curbuf->b_fab_rfm = st.st_fab_rfm;
522 curbuf->b_fab_rat = st.st_fab_rat;
523 curbuf->b_fab_mrs = st.st_fab_mrs;
524 #endif
526 else
528 curbuf->b_mtime = 0;
529 curbuf->b_mtime_read = 0;
530 curbuf->b_orig_size = 0;
531 curbuf->b_orig_mode = 0;
534 /* Reset the "new file" flag. It will be set again below when the
535 * file doesn't exist. */
536 curbuf->b_flags &= ~(BF_NEW | BF_NEW_W);
540 * for UNIX: check readonly with perm and mch_access()
541 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
542 * for MSDOS and Amiga: check readonly by trying to open the file for writing
544 file_readonly = FALSE;
545 if (read_stdin)
547 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
548 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
549 setmode(0, O_BINARY);
550 #endif
552 else if (!read_buffer)
554 #ifdef USE_MCH_ACCESS
555 if (
556 # ifdef UNIX
557 !(perm & 0222) ||
558 # endif
559 mch_access((char *)fname, W_OK))
560 file_readonly = TRUE;
561 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
562 #else
563 if (!newfile
564 || readonlymode
565 || (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0)
567 file_readonly = TRUE;
568 /* try to open ro */
569 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
571 #endif
574 if (fd < 0) /* cannot open at all */
576 #ifndef UNIX
577 int isdir_f;
578 #endif
579 msg_scroll = msg_save;
580 #ifndef UNIX
582 * On MSDOS and Amiga we can't open a directory, check here.
584 isdir_f = (mch_isdir(fname));
585 perm = mch_getperm(fname); /* check if the file exists */
586 if (isdir_f)
588 filemess(curbuf, sfname, (char_u *)_("is a directory"), 0);
589 curbuf->b_p_ro = TRUE; /* must use "w!" now */
591 else
592 #endif
593 if (newfile)
595 if (perm < 0)
598 * Set the 'new-file' flag, so that when the file has
599 * been created by someone else, a ":w" will complain.
601 curbuf->b_flags |= BF_NEW;
603 /* Create a swap file now, so that other Vims are warned
604 * that we are editing this file. Don't do this for a
605 * "nofile" or "nowrite" buffer type. */
606 #ifdef FEAT_QUICKFIX
607 if (!bt_dontwrite(curbuf))
608 #endif
610 check_need_swap(newfile);
611 #ifdef FEAT_AUTOCMD
612 /* SwapExists autocommand may mess things up */
613 if (curbuf != old_curbuf
614 || (using_b_ffname
615 && (old_b_ffname != curbuf->b_ffname))
616 || (using_b_fname
617 && (old_b_fname != curbuf->b_fname)))
619 EMSG(_(e_auchangedbuf));
620 return FAIL;
622 #endif
624 if (dir_of_file_exists(fname))
625 filemess(curbuf, sfname, (char_u *)_("[New File]"), 0);
626 else
627 filemess(curbuf, sfname,
628 (char_u *)_("[New DIRECTORY]"), 0);
629 #ifdef FEAT_VIMINFO
630 /* Even though this is a new file, it might have been
631 * edited before and deleted. Get the old marks. */
632 check_marks_read();
633 #endif
634 #ifdef FEAT_MBYTE
635 if (eap != NULL && eap->force_enc != 0)
637 /* set forced 'fileencoding' */
638 fenc = enc_canonize(eap->cmd + eap->force_enc);
639 if (fenc != NULL)
640 set_string_option_direct((char_u *)"fenc", -1,
641 fenc, OPT_FREE|OPT_LOCAL, 0);
642 vim_free(fenc);
644 #endif
645 #ifdef FEAT_AUTOCMD
646 apply_autocmds_exarg(EVENT_BUFNEWFILE, sfname, sfname,
647 FALSE, curbuf, eap);
648 #endif
649 /* remember the current fileformat */
650 save_file_ff(curbuf);
652 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
653 if (aborting()) /* autocmds may abort script processing */
654 return FAIL;
655 #endif
656 return OK; /* a new file is not an error */
658 else
660 filemess(curbuf, sfname, (char_u *)(
661 # ifdef EFBIG
662 (errno == EFBIG) ? _("[File too big]") :
663 # endif
664 _("[Permission Denied]")), 0);
665 curbuf->b_p_ro = TRUE; /* must use "w!" now */
669 return FAIL;
673 * Only set the 'ro' flag for readonly files the first time they are
674 * loaded. Help files always get readonly mode
676 if ((check_readonly && file_readonly) || curbuf->b_help)
677 curbuf->b_p_ro = TRUE;
679 if (set_options)
681 /* Don't change 'eol' if reading from buffer as it will already be
682 * correctly set when reading stdin. */
683 if (!read_buffer)
685 curbuf->b_p_eol = TRUE;
686 curbuf->b_start_eol = TRUE;
688 #ifdef FEAT_MBYTE
689 curbuf->b_p_bomb = FALSE;
690 curbuf->b_start_bomb = FALSE;
691 #endif
694 /* Create a swap file now, so that other Vims are warned that we are
695 * editing this file.
696 * Don't do this for a "nofile" or "nowrite" buffer type. */
697 #ifdef FEAT_QUICKFIX
698 if (!bt_dontwrite(curbuf))
699 #endif
701 check_need_swap(newfile);
702 #ifdef FEAT_AUTOCMD
703 if (!read_stdin && (curbuf != old_curbuf
704 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
705 || (using_b_fname && (old_b_fname != curbuf->b_fname))))
707 EMSG(_(e_auchangedbuf));
708 if (!read_buffer)
709 close(fd);
710 return FAIL;
712 #endif
713 #ifdef UNIX
714 /* Set swap file protection bits after creating it. */
715 if (swap_mode > 0 && curbuf->b_ml.ml_mfp != NULL
716 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
717 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
718 #endif
721 #if defined(HAS_SWAP_EXISTS_ACTION)
722 /* If "Quit" selected at ATTENTION dialog, don't load the file */
723 if (swap_exists_action == SEA_QUIT)
725 if (!read_buffer && !read_stdin)
726 close(fd);
727 return FAIL;
729 #endif
731 ++no_wait_return; /* don't wait for return yet */
734 * Set '[ mark to the line above where the lines go (line 1 if zero).
736 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
737 curbuf->b_op_start.col = 0;
739 #ifdef FEAT_AUTOCMD
740 if (!read_buffer)
742 int m = msg_scroll;
743 int n = msg_scrolled;
746 * The file must be closed again, the autocommands may want to change
747 * the file before reading it.
749 if (!read_stdin)
750 close(fd); /* ignore errors */
753 * The output from the autocommands should not overwrite anything and
754 * should not be overwritten: Set msg_scroll, restore its value if no
755 * output was done.
757 msg_scroll = TRUE;
758 if (filtering)
759 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
760 FALSE, curbuf, eap);
761 else if (read_stdin)
762 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
763 FALSE, curbuf, eap);
764 else if (newfile)
765 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
766 FALSE, curbuf, eap);
767 else
768 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
769 FALSE, NULL, eap);
770 if (msg_scrolled == n)
771 msg_scroll = m;
773 #ifdef FEAT_EVAL
774 if (aborting()) /* autocmds may abort script processing */
776 --no_wait_return;
777 msg_scroll = msg_save;
778 curbuf->b_p_ro = TRUE; /* must use "w!" now */
779 return FAIL;
781 #endif
783 * Don't allow the autocommands to change the current buffer.
784 * Try to re-open the file.
786 * Don't allow the autocommands to change the buffer name either
787 * (cd for example) if it invalidates fname or sfname.
789 if (!read_stdin && (curbuf != old_curbuf
790 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
791 || (using_b_fname && (old_b_fname != curbuf->b_fname))
792 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
794 --no_wait_return;
795 msg_scroll = msg_save;
796 if (fd < 0)
797 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
798 else
799 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
800 curbuf->b_p_ro = TRUE; /* must use "w!" now */
801 return FAIL;
804 #endif /* FEAT_AUTOCMD */
806 /* Autocommands may add lines to the file, need to check if it is empty */
807 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
809 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
812 * Show the user that we are busy reading the input. Sometimes this
813 * may take a while. When reading from stdin another program may
814 * still be running, don't move the cursor to the last line, unless
815 * always using the GUI.
817 if (read_stdin)
819 #ifndef ALWAYS_USE_GUI
820 mch_msg(_("Vim: Reading from stdin...\n"));
821 #endif
822 #ifdef FEAT_GUI
823 /* Also write a message in the GUI window, if there is one. */
824 if (gui.in_use && !gui.dying && !gui.starting)
826 p = (char_u *)_("Reading from stdin...");
827 gui_write(p, (int)STRLEN(p));
829 #endif
831 else if (!read_buffer)
832 filemess(curbuf, sfname, (char_u *)"", 0);
835 msg_scroll = FALSE; /* overwrite the file message */
838 * Set linecnt now, before the "retry" caused by a wrong guess for
839 * fileformat, and after the autocommands, which may change them.
841 linecnt = curbuf->b_ml.ml_line_count;
843 #ifdef FEAT_MBYTE
844 /* "++bad=" argument. */
845 if (eap != NULL && eap->bad_char != 0)
847 bad_char_behavior = eap->bad_char;
848 if (set_options)
849 curbuf->b_bad_char = eap->bad_char;
851 else
852 curbuf->b_bad_char = 0;
855 * Decide which 'encoding' to use or use first.
857 if (eap != NULL && eap->force_enc != 0)
859 fenc = enc_canonize(eap->cmd + eap->force_enc);
860 fenc_alloced = TRUE;
861 keep_dest_enc = TRUE;
863 else if (curbuf->b_p_bin)
865 fenc = (char_u *)""; /* binary: don't convert */
866 fenc_alloced = FALSE;
868 else if (curbuf->b_help)
870 char_u firstline[80];
871 int fc;
873 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
874 * fails it must be latin1.
875 * Always do this when 'encoding' is "utf-8". Otherwise only do
876 * this when needed to avoid [converted] remarks all the time.
877 * It is needed when the first line contains non-ASCII characters.
878 * That is only in *.??x files. */
879 fenc = (char_u *)"latin1";
880 c = enc_utf8;
881 if (!c && !read_stdin)
883 fc = fname[STRLEN(fname) - 1];
884 if (TOLOWER_ASC(fc) == 'x')
886 /* Read the first line (and a bit more). Immediately rewind to
887 * the start of the file. If the read() fails "len" is -1. */
888 len = vim_read(fd, firstline, 80);
889 lseek(fd, (off_t)0L, SEEK_SET);
890 for (p = firstline; p < firstline + len; ++p)
891 if (*p >= 0x80)
893 c = TRUE;
894 break;
899 if (c)
901 fenc_next = fenc;
902 fenc = (char_u *)"utf-8";
904 /* When the file is utf-8 but a character doesn't fit in
905 * 'encoding' don't retry. In help text editing utf-8 bytes
906 * doesn't make sense. */
907 if (!enc_utf8)
908 keep_dest_enc = TRUE;
910 fenc_alloced = FALSE;
912 else if (*p_fencs == NUL)
914 fenc = curbuf->b_p_fenc; /* use format from buffer */
915 fenc_alloced = FALSE;
917 else
919 fenc_next = p_fencs; /* try items in 'fileencodings' */
920 fenc = next_fenc(&fenc_next);
921 fenc_alloced = TRUE;
923 #endif
926 * Jump back here to retry reading the file in different ways.
927 * Reasons to retry:
928 * - encoding conversion failed: try another one from "fenc_next"
929 * - BOM detected and fenc was set, need to setup conversion
930 * - "fileformat" check failed: try another
932 * Variables set for special retry actions:
933 * "file_rewind" Rewind the file to start reading it again.
934 * "advance_fenc" Advance "fenc" using "fenc_next".
935 * "skip_read" Re-use already read bytes (BOM detected).
936 * "did_iconv" iconv() conversion failed, try 'charconvert'.
937 * "keep_fileformat" Don't reset "fileformat".
939 * Other status indicators:
940 * "tmpname" When != NULL did conversion with 'charconvert'.
941 * Output file has to be deleted afterwards.
942 * "iconv_fd" When != -1 did conversion with iconv().
944 retry:
946 if (file_rewind)
948 if (read_buffer)
950 read_buf_lnum = 1;
951 read_buf_col = 0;
953 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
955 /* Can't rewind the file, give up. */
956 error = TRUE;
957 goto failed;
959 /* Delete the previously read lines. */
960 while (lnum > from)
961 ml_delete(lnum--, FALSE);
962 file_rewind = FALSE;
963 #ifdef FEAT_MBYTE
964 if (set_options)
966 curbuf->b_p_bomb = FALSE;
967 curbuf->b_start_bomb = FALSE;
969 conv_error = 0;
970 #endif
974 * When retrying with another "fenc" and the first time "fileformat"
975 * will be reset.
977 if (keep_fileformat)
978 keep_fileformat = FALSE;
979 else
981 if (eap != NULL && eap->force_ff != 0)
983 fileformat = get_fileformat_force(curbuf, eap);
984 try_unix = try_dos = try_mac = FALSE;
986 else if (curbuf->b_p_bin)
987 fileformat = EOL_UNIX; /* binary: use Unix format */
988 else if (*p_ffs == NUL)
989 fileformat = get_fileformat(curbuf);/* use format from buffer */
990 else
991 fileformat = EOL_UNKNOWN; /* detect from file */
994 #ifdef FEAT_MBYTE
995 # ifdef USE_ICONV
996 if (iconv_fd != (iconv_t)-1)
998 /* aborted conversion with iconv(), close the descriptor */
999 iconv_close(iconv_fd);
1000 iconv_fd = (iconv_t)-1;
1002 # endif
1004 if (advance_fenc)
1007 * Try the next entry in 'fileencodings'.
1009 advance_fenc = FALSE;
1011 if (eap != NULL && eap->force_enc != 0)
1013 /* Conversion given with "++cc=" wasn't possible, read
1014 * without conversion. */
1015 notconverted = TRUE;
1016 conv_error = 0;
1017 if (fenc_alloced)
1018 vim_free(fenc);
1019 fenc = (char_u *)"";
1020 fenc_alloced = FALSE;
1022 else
1024 if (fenc_alloced)
1025 vim_free(fenc);
1026 if (fenc_next != NULL)
1028 fenc = next_fenc(&fenc_next);
1029 fenc_alloced = (fenc_next != NULL);
1031 else
1033 fenc = (char_u *)"";
1034 fenc_alloced = FALSE;
1037 if (tmpname != NULL)
1039 mch_remove(tmpname); /* delete converted file */
1040 vim_free(tmpname);
1041 tmpname = NULL;
1046 * Conversion may be required when the encoding of the file is different
1047 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4.
1049 fio_flags = 0;
1050 converted = need_conversion(fenc);
1051 if (converted)
1054 /* "ucs-bom" means we need to check the first bytes of the file
1055 * for a BOM. */
1056 if (STRCMP(fenc, ENC_UCSBOM) == 0)
1057 fio_flags = FIO_UCSBOM;
1060 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1061 * done. This is handled below after read(). Prepare the
1062 * fio_flags to avoid having to parse the string each time.
1063 * Also check for Unicode to Latin1 conversion, because iconv()
1064 * appears not to handle this correctly. This works just like
1065 * conversion to UTF-8 except how the resulting character is put in
1066 * the buffer.
1068 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1069 fio_flags = get_fio_flags(fenc);
1071 # ifdef WIN3264
1073 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1074 * is handled with MultiByteToWideChar().
1076 if (fio_flags == 0)
1077 fio_flags = get_win_fio_flags(fenc);
1078 # endif
1080 # ifdef MACOS_X
1081 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1082 if (fio_flags == 0)
1083 fio_flags = get_mac_fio_flags(fenc);
1084 # endif
1086 # ifdef USE_ICONV
1088 * Try using iconv() if we can't convert internally.
1090 if (fio_flags == 0
1091 # ifdef FEAT_EVAL
1092 && !did_iconv
1093 # endif
1095 iconv_fd = (iconv_t)my_iconv_open(
1096 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1097 # endif
1099 # ifdef FEAT_EVAL
1101 * Use the 'charconvert' expression when conversion is required
1102 * and we can't do it internally or with iconv().
1104 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1105 # ifdef USE_ICONV
1106 && iconv_fd == (iconv_t)-1
1107 # endif
1110 # ifdef USE_ICONV
1111 did_iconv = FALSE;
1112 # endif
1113 /* Skip conversion when it's already done (retry for wrong
1114 * "fileformat"). */
1115 if (tmpname == NULL)
1117 tmpname = readfile_charconvert(fname, fenc, &fd);
1118 if (tmpname == NULL)
1120 /* Conversion failed. Try another one. */
1121 advance_fenc = TRUE;
1122 if (fd < 0)
1124 /* Re-opening the original file failed! */
1125 EMSG(_("E202: Conversion made file unreadable!"));
1126 error = TRUE;
1127 goto failed;
1129 goto retry;
1133 else
1134 # endif
1136 if (fio_flags == 0
1137 # ifdef USE_ICONV
1138 && iconv_fd == (iconv_t)-1
1139 # endif
1142 /* Conversion wanted but we can't.
1143 * Try the next conversion in 'fileencodings' */
1144 advance_fenc = TRUE;
1145 goto retry;
1150 /* Set "can_retry" when it's possible to rewind the file and try with
1151 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1152 * stdin or fixed at a specific encoding. */
1153 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1154 #endif
1156 if (!skip_read)
1158 linerest = 0;
1159 filesize = 0;
1160 skip_count = lines_to_skip;
1161 read_count = lines_to_read;
1162 #ifdef FEAT_MBYTE
1163 conv_restlen = 0;
1164 #endif
1167 while (!error && !got_int)
1170 * We allocate as much space for the file as we can get, plus
1171 * space for the old line plus room for one terminating NUL.
1172 * The amount is limited by the fact that read() only can read
1173 * upto max_unsigned characters (and other things).
1175 #if SIZEOF_INT <= 2
1176 if (linerest >= 0x7ff0)
1178 ++split;
1179 *ptr = NL; /* split line by inserting a NL */
1180 size = 1;
1182 else
1183 #endif
1185 if (!skip_read)
1187 #if SIZEOF_INT > 2
1188 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1189 size = SSIZE_MAX; /* use max I/O size, 52K */
1190 # else
1191 size = 0x10000L; /* use buffer >= 64K */
1192 # endif
1193 #else
1194 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1195 #endif
1197 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1199 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1200 FALSE)) != NULL)
1201 break;
1203 if (new_buffer == NULL)
1205 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1206 error = TRUE;
1207 break;
1209 if (linerest) /* copy characters from the previous buffer */
1210 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1211 vim_free(buffer);
1212 buffer = new_buffer;
1213 ptr = buffer + linerest;
1214 line_start = buffer;
1216 #ifdef FEAT_MBYTE
1217 /* May need room to translate into.
1218 * For iconv() we don't really know the required space, use a
1219 * factor ICONV_MULT.
1220 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1221 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1222 * become up to 4 bytes, size must be multiple of 2
1223 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1224 * multiple of 2
1225 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1226 * multiple of 4 */
1227 real_size = (int)size;
1228 # ifdef USE_ICONV
1229 if (iconv_fd != (iconv_t)-1)
1230 size = size / ICONV_MULT;
1231 else
1232 # endif
1233 if (fio_flags & FIO_LATIN1)
1234 size = size / 2;
1235 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1236 size = (size * 2 / 3) & ~1;
1237 else if (fio_flags & FIO_UCS4)
1238 size = (size * 2 / 3) & ~3;
1239 else if (fio_flags == FIO_UCSBOM)
1240 size = size / ICONV_MULT; /* worst case */
1241 # ifdef WIN3264
1242 else if (fio_flags & FIO_CODEPAGE)
1243 size = size / ICONV_MULT; /* also worst case */
1244 # endif
1245 # ifdef MACOS_X
1246 else if (fio_flags & FIO_MACROMAN)
1247 size = size / ICONV_MULT; /* also worst case */
1248 # endif
1249 #endif
1251 #ifdef FEAT_MBYTE
1252 if (conv_restlen > 0)
1254 /* Insert unconverted bytes from previous line. */
1255 mch_memmove(ptr, conv_rest, conv_restlen);
1256 ptr += conv_restlen;
1257 size -= conv_restlen;
1259 #endif
1261 if (read_buffer)
1264 * Read bytes from curbuf. Used for converting text read
1265 * from stdin.
1267 if (read_buf_lnum > from)
1268 size = 0;
1269 else
1271 int n, ni;
1272 long tlen;
1274 tlen = 0;
1275 for (;;)
1277 p = ml_get(read_buf_lnum) + read_buf_col;
1278 n = (int)STRLEN(p);
1279 if ((int)tlen + n + 1 > size)
1281 /* Filled up to "size", append partial line.
1282 * Change NL to NUL to reverse the effect done
1283 * below. */
1284 n = (int)(size - tlen);
1285 for (ni = 0; ni < n; ++ni)
1287 if (p[ni] == NL)
1288 ptr[tlen++] = NUL;
1289 else
1290 ptr[tlen++] = p[ni];
1292 read_buf_col += n;
1293 break;
1295 else
1297 /* Append whole line and new-line. Change NL
1298 * to NUL to reverse the effect done below. */
1299 for (ni = 0; ni < n; ++ni)
1301 if (p[ni] == NL)
1302 ptr[tlen++] = NUL;
1303 else
1304 ptr[tlen++] = p[ni];
1306 ptr[tlen++] = NL;
1307 read_buf_col = 0;
1308 if (++read_buf_lnum > from)
1310 /* When the last line didn't have an
1311 * end-of-line don't add it now either. */
1312 if (!curbuf->b_p_eol)
1313 --tlen;
1314 size = tlen;
1315 break;
1321 else
1324 * Read bytes from the file.
1326 size = vim_read(fd, ptr, size);
1329 if (size <= 0)
1331 if (size < 0) /* read error */
1332 error = TRUE;
1333 #ifdef FEAT_MBYTE
1334 else if (conv_restlen > 0)
1337 * Reached end-of-file but some trailing bytes could
1338 * not be converted. Truncated file?
1341 /* When we did a conversion report an error. */
1342 if (fio_flags != 0
1343 # ifdef USE_ICONV
1344 || iconv_fd != (iconv_t)-1
1345 # endif
1348 if (conv_error == 0)
1349 conv_error = curbuf->b_ml.ml_line_count
1350 - linecnt + 1;
1352 /* Remember the first linenr with an illegal byte */
1353 else if (illegal_byte == 0)
1354 illegal_byte = curbuf->b_ml.ml_line_count
1355 - linecnt + 1;
1356 if (bad_char_behavior == BAD_DROP)
1358 *(ptr - conv_restlen) = NUL;
1359 conv_restlen = 0;
1361 else
1363 /* Replace the trailing bytes with the replacement
1364 * character if we were converting; if we weren't,
1365 * leave the UTF8 checking code to do it, as it
1366 * works slightly differently. */
1367 if (bad_char_behavior != BAD_KEEP && (fio_flags != 0
1368 # ifdef USE_ICONV
1369 || iconv_fd != (iconv_t)-1
1370 # endif
1373 while (conv_restlen > 0)
1375 *(--ptr) = bad_char_behavior;
1376 --conv_restlen;
1379 fio_flags = 0; /* don't convert this */
1380 # ifdef USE_ICONV
1381 if (iconv_fd != (iconv_t)-1)
1383 iconv_close(iconv_fd);
1384 iconv_fd = (iconv_t)-1;
1386 # endif
1389 #endif
1392 #ifdef FEAT_CRYPT
1394 * At start of file: Check for magic number of encryption.
1396 if (filesize == 0)
1397 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1398 &filesize, newfile);
1400 * Decrypt the read bytes.
1402 if (cryptkey != NULL && size > 0)
1403 for (p = ptr; p < ptr + size; ++p)
1404 ZDECODE(*p);
1405 #endif
1407 skip_read = FALSE;
1409 #ifdef FEAT_MBYTE
1411 * At start of file (or after crypt magic number): Check for BOM.
1412 * Also check for a BOM for other Unicode encodings, but not after
1413 * converting with 'charconvert' or when a BOM has already been
1414 * found.
1416 if ((filesize == 0
1417 # ifdef FEAT_CRYPT
1418 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1419 # endif
1421 && (fio_flags == FIO_UCSBOM
1422 || (!curbuf->b_p_bomb
1423 && tmpname == NULL
1424 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1426 char_u *ccname;
1427 int blen;
1429 /* no BOM detection in a short file or in binary mode */
1430 if (size < 2 || curbuf->b_p_bin)
1431 ccname = NULL;
1432 else
1433 ccname = check_for_bom(ptr, size, &blen,
1434 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1435 if (ccname != NULL)
1437 /* Remove BOM from the text */
1438 filesize += blen;
1439 size -= blen;
1440 mch_memmove(ptr, ptr + blen, (size_t)size);
1441 if (set_options)
1443 curbuf->b_p_bomb = TRUE;
1444 curbuf->b_start_bomb = TRUE;
1448 if (fio_flags == FIO_UCSBOM)
1450 if (ccname == NULL)
1452 /* No BOM detected: retry with next encoding. */
1453 advance_fenc = TRUE;
1455 else
1457 /* BOM detected: set "fenc" and jump back */
1458 if (fenc_alloced)
1459 vim_free(fenc);
1460 fenc = ccname;
1461 fenc_alloced = FALSE;
1463 /* retry reading without getting new bytes or rewinding */
1464 skip_read = TRUE;
1465 goto retry;
1469 /* Include not converted bytes. */
1470 ptr -= conv_restlen;
1471 size += conv_restlen;
1472 conv_restlen = 0;
1473 #endif
1475 * Break here for a read error or end-of-file.
1477 if (size <= 0)
1478 break;
1480 #ifdef FEAT_MBYTE
1482 # ifdef USE_ICONV
1483 if (iconv_fd != (iconv_t)-1)
1486 * Attempt conversion of the read bytes to 'encoding' using
1487 * iconv().
1489 const char *fromp;
1490 char *top;
1491 size_t from_size;
1492 size_t to_size;
1494 fromp = (char *)ptr;
1495 from_size = size;
1496 ptr += size;
1497 top = (char *)ptr;
1498 to_size = real_size - size;
1501 * If there is conversion error or not enough room try using
1502 * another conversion. Except for when there is no
1503 * alternative (help files).
1505 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1506 &top, &to_size)
1507 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1508 || from_size > CONV_RESTLEN)
1510 if (can_retry)
1511 goto rewind_retry;
1512 if (conv_error == 0)
1513 conv_error = readfile_linenr(linecnt,
1514 ptr, (char_u *)top);
1516 /* Deal with a bad byte and continue with the next. */
1517 ++fromp;
1518 --from_size;
1519 if (bad_char_behavior == BAD_KEEP)
1521 *top++ = *(fromp - 1);
1522 --to_size;
1524 else if (bad_char_behavior != BAD_DROP)
1526 *top++ = bad_char_behavior;
1527 --to_size;
1531 if (from_size > 0)
1533 /* Some remaining characters, keep them for the next
1534 * round. */
1535 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1536 conv_restlen = (int)from_size;
1539 /* move the linerest to before the converted characters */
1540 line_start = ptr - linerest;
1541 mch_memmove(line_start, buffer, (size_t)linerest);
1542 size = (long)((char_u *)top - ptr);
1544 # endif
1546 # ifdef WIN3264
1547 if (fio_flags & FIO_CODEPAGE)
1549 char_u *src, *dst;
1550 WCHAR ucs2buf[3];
1551 int ucs2len;
1552 int codepage = FIO_GET_CP(fio_flags);
1553 int bytelen;
1554 int found_bad;
1555 char replstr[2];
1558 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1559 * a codepage, using standard MS-Windows functions. This
1560 * requires two steps:
1561 * 1. convert from 'fileencoding' to ucs-2
1562 * 2. convert from ucs-2 to 'encoding'
1564 * Because there may be illegal bytes AND an incomplete byte
1565 * sequence at the end, we may have to do the conversion one
1566 * character at a time to get it right.
1569 /* Replacement string for WideCharToMultiByte(). */
1570 if (bad_char_behavior > 0)
1571 replstr[0] = bad_char_behavior;
1572 else
1573 replstr[0] = '?';
1574 replstr[1] = NUL;
1577 * Move the bytes to the end of the buffer, so that we have
1578 * room to put the result at the start.
1580 src = ptr + real_size - size;
1581 mch_memmove(src, ptr, size);
1584 * Do the conversion.
1586 dst = ptr;
1587 size = size;
1588 while (size > 0)
1590 found_bad = FALSE;
1592 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1593 if (codepage == CP_UTF8)
1595 /* Handle CP_UTF8 input ourselves to be able to handle
1596 * trailing bytes properly.
1597 * Get one UTF-8 character from src. */
1598 bytelen = (int)utf_ptr2len_len(src, size);
1599 if (bytelen > size)
1601 /* Only got some bytes of a character. Normally
1602 * it's put in "conv_rest", but if it's too long
1603 * deal with it as if they were illegal bytes. */
1604 if (bytelen <= CONV_RESTLEN)
1605 break;
1607 /* weird overlong byte sequence */
1608 bytelen = size;
1609 found_bad = TRUE;
1611 else
1613 int u8c = utf_ptr2char(src);
1615 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1616 found_bad = TRUE;
1617 ucs2buf[0] = u8c;
1618 ucs2len = 1;
1621 else
1622 # endif
1624 /* We don't know how long the byte sequence is, try
1625 * from one to three bytes. */
1626 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1627 ++bytelen)
1629 ucs2len = MultiByteToWideChar(codepage,
1630 MB_ERR_INVALID_CHARS,
1631 (LPCSTR)src, bytelen,
1632 ucs2buf, 3);
1633 if (ucs2len > 0)
1634 break;
1636 if (ucs2len == 0)
1638 /* If we have only one byte then it's probably an
1639 * incomplete byte sequence. Otherwise discard
1640 * one byte as a bad character. */
1641 if (size == 1)
1642 break;
1643 found_bad = TRUE;
1644 bytelen = 1;
1648 if (!found_bad)
1650 int i;
1652 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1653 if (enc_utf8)
1655 /* From UCS-2 to UTF-8. Cannot fail. */
1656 for (i = 0; i < ucs2len; ++i)
1657 dst += utf_char2bytes(ucs2buf[i], dst);
1659 else
1661 BOOL bad = FALSE;
1662 int dstlen;
1664 /* From UCS-2 to "enc_codepage". If the
1665 * conversion uses the default character "?",
1666 * the data doesn't fit in this encoding. */
1667 dstlen = WideCharToMultiByte(enc_codepage, 0,
1668 (LPCWSTR)ucs2buf, ucs2len,
1669 (LPSTR)dst, (int)(src - dst),
1670 replstr, &bad);
1671 if (bad)
1672 found_bad = TRUE;
1673 else
1674 dst += dstlen;
1678 if (found_bad)
1680 /* Deal with bytes we can't convert. */
1681 if (can_retry)
1682 goto rewind_retry;
1683 if (conv_error == 0)
1684 conv_error = readfile_linenr(linecnt, ptr, dst);
1685 if (bad_char_behavior != BAD_DROP)
1687 if (bad_char_behavior == BAD_KEEP)
1689 mch_memmove(dst, src, bytelen);
1690 dst += bytelen;
1692 else
1693 *dst++ = bad_char_behavior;
1697 src += bytelen;
1698 size -= bytelen;
1701 if (size > 0)
1703 /* An incomplete byte sequence remaining. */
1704 mch_memmove(conv_rest, src, size);
1705 conv_restlen = size;
1708 /* The new size is equal to how much "dst" was advanced. */
1709 size = (long)(dst - ptr);
1711 else
1712 # endif
1713 # ifdef MACOS_CONVERT
1714 if (fio_flags & FIO_MACROMAN)
1717 * Conversion from Apple MacRoman char encoding to UTF-8 or
1718 * latin1. This is in os_mac_conv.c.
1720 if (macroman2enc(ptr, &size, real_size) == FAIL)
1721 goto rewind_retry;
1723 else
1724 # endif
1725 if (fio_flags != 0)
1727 int u8c;
1728 char_u *dest;
1729 char_u *tail = NULL;
1732 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1733 * "enc_utf8" not set: Convert Unicode to Latin1.
1734 * Go from end to start through the buffer, because the number
1735 * of bytes may increase.
1736 * "dest" points to after where the UTF-8 bytes go, "p" points
1737 * to after the next character to convert.
1739 dest = ptr + real_size;
1740 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1742 p = ptr + size;
1743 if (fio_flags == FIO_UTF8)
1745 /* Check for a trailing incomplete UTF-8 sequence */
1746 tail = ptr + size - 1;
1747 while (tail > ptr && (*tail & 0xc0) == 0x80)
1748 --tail;
1749 if (tail + utf_byte2len(*tail) <= ptr + size)
1750 tail = NULL;
1751 else
1752 p = tail;
1755 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1757 /* Check for a trailing byte */
1758 p = ptr + (size & ~1);
1759 if (size & 1)
1760 tail = p;
1761 if ((fio_flags & FIO_UTF16) && p > ptr)
1763 /* Check for a trailing leading word */
1764 if (fio_flags & FIO_ENDIAN_L)
1766 u8c = (*--p << 8);
1767 u8c += *--p;
1769 else
1771 u8c = *--p;
1772 u8c += (*--p << 8);
1774 if (u8c >= 0xd800 && u8c <= 0xdbff)
1775 tail = p;
1776 else
1777 p += 2;
1780 else /* FIO_UCS4 */
1782 /* Check for trailing 1, 2 or 3 bytes */
1783 p = ptr + (size & ~3);
1784 if (size & 3)
1785 tail = p;
1788 /* If there is a trailing incomplete sequence move it to
1789 * conv_rest[]. */
1790 if (tail != NULL)
1792 conv_restlen = (int)((ptr + size) - tail);
1793 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1794 size -= conv_restlen;
1798 while (p > ptr)
1800 if (fio_flags & FIO_LATIN1)
1801 u8c = *--p;
1802 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1804 if (fio_flags & FIO_ENDIAN_L)
1806 u8c = (*--p << 8);
1807 u8c += *--p;
1809 else
1811 u8c = *--p;
1812 u8c += (*--p << 8);
1814 if ((fio_flags & FIO_UTF16)
1815 && u8c >= 0xdc00 && u8c <= 0xdfff)
1817 int u16c;
1819 if (p == ptr)
1821 /* Missing leading word. */
1822 if (can_retry)
1823 goto rewind_retry;
1824 if (conv_error == 0)
1825 conv_error = readfile_linenr(linecnt,
1826 ptr, p);
1827 if (bad_char_behavior == BAD_DROP)
1828 continue;
1829 if (bad_char_behavior != BAD_KEEP)
1830 u8c = bad_char_behavior;
1833 /* found second word of double-word, get the first
1834 * word and compute the resulting character */
1835 if (fio_flags & FIO_ENDIAN_L)
1837 u16c = (*--p << 8);
1838 u16c += *--p;
1840 else
1842 u16c = *--p;
1843 u16c += (*--p << 8);
1845 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1846 + (u8c & 0x3ff);
1848 /* Check if the word is indeed a leading word. */
1849 if (u16c < 0xd800 || u16c > 0xdbff)
1851 if (can_retry)
1852 goto rewind_retry;
1853 if (conv_error == 0)
1854 conv_error = readfile_linenr(linecnt,
1855 ptr, p);
1856 if (bad_char_behavior == BAD_DROP)
1857 continue;
1858 if (bad_char_behavior != BAD_KEEP)
1859 u8c = bad_char_behavior;
1863 else if (fio_flags & FIO_UCS4)
1865 if (fio_flags & FIO_ENDIAN_L)
1867 u8c = (*--p << 24);
1868 u8c += (*--p << 16);
1869 u8c += (*--p << 8);
1870 u8c += *--p;
1872 else /* big endian */
1874 u8c = *--p;
1875 u8c += (*--p << 8);
1876 u8c += (*--p << 16);
1877 u8c += (*--p << 24);
1880 else /* UTF-8 */
1882 if (*--p < 0x80)
1883 u8c = *p;
1884 else
1886 len = utf_head_off(ptr, p);
1887 p -= len;
1888 u8c = utf_ptr2char(p);
1889 if (len == 0)
1891 /* Not a valid UTF-8 character, retry with
1892 * another fenc when possible, otherwise just
1893 * report the error. */
1894 if (can_retry)
1895 goto rewind_retry;
1896 if (conv_error == 0)
1897 conv_error = readfile_linenr(linecnt,
1898 ptr, p);
1899 if (bad_char_behavior == BAD_DROP)
1900 continue;
1901 if (bad_char_behavior != BAD_KEEP)
1902 u8c = bad_char_behavior;
1906 if (enc_utf8) /* produce UTF-8 */
1908 dest -= utf_char2len(u8c);
1909 (void)utf_char2bytes(u8c, dest);
1911 else /* produce Latin1 */
1913 --dest;
1914 if (u8c >= 0x100)
1916 /* character doesn't fit in latin1, retry with
1917 * another fenc when possible, otherwise just
1918 * report the error. */
1919 if (can_retry)
1920 goto rewind_retry;
1921 if (conv_error == 0)
1922 conv_error = readfile_linenr(linecnt, ptr, p);
1923 if (bad_char_behavior == BAD_DROP)
1924 ++dest;
1925 else if (bad_char_behavior == BAD_KEEP)
1926 *dest = u8c;
1927 else if (eap != NULL && eap->bad_char != 0)
1928 *dest = bad_char_behavior;
1929 else
1930 *dest = 0xBF;
1932 else
1933 *dest = u8c;
1937 /* move the linerest to before the converted characters */
1938 line_start = dest - linerest;
1939 mch_memmove(line_start, buffer, (size_t)linerest);
1940 size = (long)((ptr + real_size) - dest);
1941 ptr = dest;
1943 else if (enc_utf8 && !curbuf->b_p_bin)
1945 int incomplete_tail = FALSE;
1947 /* Reading UTF-8: Check if the bytes are valid UTF-8. */
1948 for (p = ptr; ; ++p)
1950 int todo = (int)((ptr + size) - p);
1951 int l;
1953 if (todo <= 0)
1954 break;
1955 if (*p >= 0x80)
1957 /* A length of 1 means it's an illegal byte. Accept
1958 * an incomplete character at the end though, the next
1959 * read() will get the next bytes, we'll check it
1960 * then. */
1961 l = utf_ptr2len_len(p, todo);
1962 if (l > todo && !incomplete_tail)
1964 /* Avoid retrying with a different encoding when
1965 * a truncated file is more likely, or attempting
1966 * to read the rest of an incomplete sequence when
1967 * we have already done so. */
1968 if (p > ptr || filesize > 0)
1969 incomplete_tail = TRUE;
1970 /* Incomplete byte sequence, move it to conv_rest[]
1971 * and try to read the rest of it, unless we've
1972 * already done so. */
1973 if (p > ptr)
1975 conv_restlen = todo;
1976 mch_memmove(conv_rest, p, conv_restlen);
1977 size -= conv_restlen;
1978 break;
1981 if (l == 1 || l > todo)
1983 /* Illegal byte. If we can try another encoding
1984 * do that, unless at EOF where a truncated
1985 * file is more likely than a conversion error. */
1986 if (can_retry && !incomplete_tail)
1987 break;
1988 # ifdef USE_ICONV
1989 /* When we did a conversion report an error. */
1990 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1991 conv_error = readfile_linenr(linecnt, ptr, p);
1992 # endif
1993 /* Remember the first linenr with an illegal byte */
1994 if (conv_error == 0 && illegal_byte == 0)
1995 illegal_byte = readfile_linenr(linecnt, ptr, p);
1997 /* Drop, keep or replace the bad byte. */
1998 if (bad_char_behavior == BAD_DROP)
2000 mch_memmove(p, p + 1, todo - 1);
2001 --p;
2002 --size;
2004 else if (bad_char_behavior != BAD_KEEP)
2005 *p = bad_char_behavior;
2007 else
2008 p += l - 1;
2011 if (p < ptr + size && !incomplete_tail)
2013 /* Detected a UTF-8 error. */
2014 rewind_retry:
2015 /* Retry reading with another conversion. */
2016 # if defined(FEAT_EVAL) && defined(USE_ICONV)
2017 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
2018 /* iconv() failed, try 'charconvert' */
2019 did_iconv = TRUE;
2020 else
2021 # endif
2022 /* use next item from 'fileencodings' */
2023 advance_fenc = TRUE;
2024 file_rewind = TRUE;
2025 goto retry;
2028 #endif
2030 /* count the number of characters (after conversion!) */
2031 filesize += size;
2034 * when reading the first part of a file: guess EOL type
2036 if (fileformat == EOL_UNKNOWN)
2038 /* First try finding a NL, for Dos and Unix */
2039 if (try_dos || try_unix)
2041 for (p = ptr; p < ptr + size; ++p)
2043 if (*p == NL)
2045 if (!try_unix
2046 || (try_dos && p > ptr && p[-1] == CAR))
2047 fileformat = EOL_DOS;
2048 else
2049 fileformat = EOL_UNIX;
2050 break;
2054 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
2055 if (fileformat == EOL_UNIX && try_mac)
2057 /* Need to reset the counters when retrying fenc. */
2058 try_mac = 1;
2059 try_unix = 1;
2060 for (; p >= ptr && *p != CAR; p--)
2062 if (p >= ptr)
2064 for (p = ptr; p < ptr + size; ++p)
2066 if (*p == NL)
2067 try_unix++;
2068 else if (*p == CAR)
2069 try_mac++;
2071 if (try_mac > try_unix)
2072 fileformat = EOL_MAC;
2077 /* No NL found: may use Mac format */
2078 if (fileformat == EOL_UNKNOWN && try_mac)
2079 fileformat = EOL_MAC;
2081 /* Still nothing found? Use first format in 'ffs' */
2082 if (fileformat == EOL_UNKNOWN)
2083 fileformat = default_fileformat();
2085 /* if editing a new file: may set p_tx and p_ff */
2086 if (set_options)
2087 set_fileformat(fileformat, OPT_LOCAL);
2092 * This loop is executed once for every character read.
2093 * Keep it fast!
2095 if (fileformat == EOL_MAC)
2097 --ptr;
2098 while (++ptr, --size >= 0)
2100 /* catch most common case first */
2101 if ((c = *ptr) != NUL && c != CAR && c != NL)
2102 continue;
2103 if (c == NUL)
2104 *ptr = NL; /* NULs are replaced by newlines! */
2105 else if (c == NL)
2106 *ptr = CAR; /* NLs are replaced by CRs! */
2107 else
2109 if (skip_count == 0)
2111 *ptr = NUL; /* end of line */
2112 len = (colnr_T) (ptr - line_start + 1);
2113 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2115 error = TRUE;
2116 break;
2118 ++lnum;
2119 if (--read_count == 0)
2121 error = TRUE; /* break loop */
2122 line_start = ptr; /* nothing left to write */
2123 break;
2126 else
2127 --skip_count;
2128 line_start = ptr + 1;
2132 else
2134 --ptr;
2135 while (++ptr, --size >= 0)
2137 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2138 continue;
2139 if (c == NUL)
2140 *ptr = NL; /* NULs are replaced by newlines! */
2141 else
2143 if (skip_count == 0)
2145 *ptr = NUL; /* end of line */
2146 len = (colnr_T)(ptr - line_start + 1);
2147 if (fileformat == EOL_DOS)
2149 if (ptr[-1] == CAR) /* remove CR */
2151 ptr[-1] = NUL;
2152 --len;
2155 * Reading in Dos format, but no CR-LF found!
2156 * When 'fileformats' includes "unix", delete all
2157 * the lines read so far and start all over again.
2158 * Otherwise give an error message later.
2160 else if (ff_error != EOL_DOS)
2162 if ( try_unix
2163 && !read_stdin
2164 && (read_buffer
2165 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2167 fileformat = EOL_UNIX;
2168 if (set_options)
2169 set_fileformat(EOL_UNIX, OPT_LOCAL);
2170 file_rewind = TRUE;
2171 keep_fileformat = TRUE;
2172 goto retry;
2174 ff_error = EOL_DOS;
2177 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2179 error = TRUE;
2180 break;
2182 ++lnum;
2183 if (--read_count == 0)
2185 error = TRUE; /* break loop */
2186 line_start = ptr; /* nothing left to write */
2187 break;
2190 else
2191 --skip_count;
2192 line_start = ptr + 1;
2196 linerest = (long)(ptr - line_start);
2197 ui_breakcheck();
2200 failed:
2201 /* not an error, max. number of lines reached */
2202 if (error && read_count == 0)
2203 error = FALSE;
2206 * If we get EOF in the middle of a line, note the fact and
2207 * complete the line ourselves.
2208 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2210 if (!error
2211 && !got_int
2212 && linerest != 0
2213 && !(!curbuf->b_p_bin
2214 && fileformat == EOL_DOS
2215 && *line_start == Ctrl_Z
2216 && ptr == line_start + 1))
2218 /* remember for when writing */
2219 if (set_options)
2220 curbuf->b_p_eol = FALSE;
2221 *ptr = NUL;
2222 if (ml_append(lnum, line_start,
2223 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2224 error = TRUE;
2225 else
2226 read_no_eol_lnum = ++lnum;
2229 if (set_options)
2230 save_file_ff(curbuf); /* remember the current file format */
2232 #ifdef FEAT_CRYPT
2233 if (cryptkey != curbuf->b_p_key)
2234 vim_free(cryptkey);
2235 #endif
2237 #ifdef FEAT_MBYTE
2238 /* If editing a new file: set 'fenc' for the current buffer.
2239 * Also for ":read ++edit file". */
2240 if (set_options)
2241 set_string_option_direct((char_u *)"fenc", -1, fenc,
2242 OPT_FREE|OPT_LOCAL, 0);
2243 if (fenc_alloced)
2244 vim_free(fenc);
2245 # ifdef USE_ICONV
2246 if (iconv_fd != (iconv_t)-1)
2248 iconv_close(iconv_fd);
2249 iconv_fd = (iconv_t)-1;
2251 # endif
2252 #endif
2254 if (!read_buffer && !read_stdin)
2255 close(fd); /* errors are ignored */
2256 vim_free(buffer);
2258 #ifdef HAVE_DUP
2259 if (read_stdin)
2261 /* Use stderr for stdin, makes shell commands work. */
2262 close(0);
2263 ignored = dup(2);
2265 #endif
2267 #ifdef FEAT_MBYTE
2268 if (tmpname != NULL)
2270 mch_remove(tmpname); /* delete converted file */
2271 vim_free(tmpname);
2273 #endif
2274 --no_wait_return; /* may wait for return now */
2277 * In recovery mode everything but autocommands is skipped.
2279 if (!recoverymode)
2281 /* need to delete the last line, which comes from the empty buffer */
2282 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2284 #ifdef FEAT_NETBEANS_INTG
2285 netbeansFireChanges = 0;
2286 #endif
2287 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2288 #ifdef FEAT_NETBEANS_INTG
2289 netbeansFireChanges = 1;
2290 #endif
2291 --linecnt;
2293 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2294 if (filesize == 0)
2295 linecnt = 0;
2296 if (newfile || read_buffer)
2298 redraw_curbuf_later(NOT_VALID);
2299 #ifdef FEAT_DIFF
2300 /* After reading the text into the buffer the diff info needs to
2301 * be updated. */
2302 diff_invalidate(curbuf);
2303 #endif
2304 #ifdef FEAT_FOLDING
2305 /* All folds in the window are invalid now. Mark them for update
2306 * before triggering autocommands. */
2307 foldUpdateAll(curwin);
2308 #endif
2310 else if (linecnt) /* appended at least one line */
2311 appended_lines_mark(from, linecnt);
2313 #ifndef ALWAYS_USE_GUI
2315 * If we were reading from the same terminal as where messages go,
2316 * the screen will have been messed up.
2317 * Switch on raw mode now and clear the screen.
2319 if (read_stdin)
2321 settmode(TMODE_RAW); /* set to raw mode */
2322 starttermcap();
2323 screenclear();
2325 #endif
2327 if (got_int)
2329 if (!(flags & READ_DUMMY))
2331 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2332 if (newfile)
2333 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2335 msg_scroll = msg_save;
2336 #ifdef FEAT_VIMINFO
2337 check_marks_read();
2338 #endif
2339 return OK; /* an interrupt isn't really an error */
2342 if (!filtering && !(flags & READ_DUMMY))
2344 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2345 c = FALSE;
2347 #ifdef UNIX
2348 # ifdef S_ISFIFO
2349 if (S_ISFIFO(perm)) /* fifo or socket */
2351 STRCAT(IObuff, _("[fifo/socket]"));
2352 c = TRUE;
2354 # else
2355 # ifdef S_IFIFO
2356 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2358 STRCAT(IObuff, _("[fifo]"));
2359 c = TRUE;
2361 # endif
2362 # ifdef S_IFSOCK
2363 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2365 STRCAT(IObuff, _("[socket]"));
2366 c = TRUE;
2368 # endif
2369 # endif
2370 # ifdef OPEN_CHR_FILES
2371 if (S_ISCHR(perm)) /* or character special */
2373 STRCAT(IObuff, _("[character special]"));
2374 c = TRUE;
2376 # endif
2377 #endif
2378 if (curbuf->b_p_ro)
2380 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2381 c = TRUE;
2383 if (read_no_eol_lnum)
2385 msg_add_eol();
2386 c = TRUE;
2388 if (ff_error == EOL_DOS)
2390 STRCAT(IObuff, _("[CR missing]"));
2391 c = TRUE;
2393 if (split)
2395 STRCAT(IObuff, _("[long lines split]"));
2396 c = TRUE;
2398 #ifdef FEAT_MBYTE
2399 if (notconverted)
2401 STRCAT(IObuff, _("[NOT converted]"));
2402 c = TRUE;
2404 else if (converted)
2406 STRCAT(IObuff, _("[converted]"));
2407 c = TRUE;
2409 #endif
2410 #ifdef FEAT_CRYPT
2411 if (cryptkey != NULL)
2413 STRCAT(IObuff, _("[crypted]"));
2414 c = TRUE;
2416 #endif
2417 #ifdef FEAT_MBYTE
2418 if (conv_error != 0)
2420 sprintf((char *)IObuff + STRLEN(IObuff),
2421 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2422 c = TRUE;
2424 else if (illegal_byte > 0)
2426 sprintf((char *)IObuff + STRLEN(IObuff),
2427 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2428 c = TRUE;
2430 else
2431 #endif
2432 if (error)
2434 STRCAT(IObuff, _("[READ ERRORS]"));
2435 c = TRUE;
2437 if (msg_add_fileformat(fileformat))
2438 c = TRUE;
2439 #ifdef FEAT_CRYPT
2440 if (cryptkey != NULL)
2441 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2442 else
2443 #endif
2444 msg_add_lines(c, (long)linecnt, filesize);
2446 vim_free(keep_msg);
2447 keep_msg = NULL;
2448 msg_scrolled_ign = TRUE;
2449 #ifdef ALWAYS_USE_GUI
2450 /* Don't show the message when reading stdin, it would end up in a
2451 * message box (which might be shown when exiting!) */
2452 if (read_stdin || read_buffer)
2453 p = msg_may_trunc(FALSE, IObuff);
2454 else
2455 #endif
2456 p = msg_trunc_attr(IObuff, FALSE, 0);
2457 if (read_stdin || read_buffer || restart_edit != 0
2458 || (msg_scrolled != 0 && !need_wait_return))
2459 /* Need to repeat the message after redrawing when:
2460 * - When reading from stdin (the screen will be cleared next).
2461 * - When restart_edit is set (otherwise there will be a delay
2462 * before redrawing).
2463 * - When the screen was scrolled but there is no wait-return
2464 * prompt. */
2465 set_keep_msg(p, 0);
2466 msg_scrolled_ign = FALSE;
2469 /* with errors writing the file requires ":w!" */
2470 if (newfile && (error
2471 #ifdef FEAT_MBYTE
2472 || conv_error != 0
2473 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2474 #endif
2476 curbuf->b_p_ro = TRUE;
2478 u_clearline(); /* cannot use "U" command after adding lines */
2481 * In Ex mode: cursor at last new line.
2482 * Otherwise: cursor at first new line.
2484 if (exmode_active)
2485 curwin->w_cursor.lnum = from + linecnt;
2486 else
2487 curwin->w_cursor.lnum = from + 1;
2488 check_cursor_lnum();
2489 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2492 * Set '[ and '] marks to the newly read lines.
2494 curbuf->b_op_start.lnum = from + 1;
2495 curbuf->b_op_start.col = 0;
2496 curbuf->b_op_end.lnum = from + linecnt;
2497 curbuf->b_op_end.col = 0;
2499 #ifdef WIN32
2501 * Work around a weird problem: When a file has two links (only
2502 * possible on NTFS) and we write through one link, then stat() it
2503 * through the other link, the timestamp information may be wrong.
2504 * It's correct again after reading the file, thus reset the timestamp
2505 * here.
2507 if (newfile && !read_stdin && !read_buffer
2508 && mch_stat((char *)fname, &st) >= 0)
2510 buf_store_time(curbuf, &st, fname);
2511 curbuf->b_mtime_read = curbuf->b_mtime;
2513 #endif
2515 msg_scroll = msg_save;
2517 #ifdef FEAT_VIMINFO
2519 * Get the marks before executing autocommands, so they can be used there.
2521 check_marks_read();
2522 #endif
2525 * Trick: We remember if the last line of the read didn't have
2526 * an eol for when writing it again. This is required for
2527 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2529 write_no_eol_lnum = read_no_eol_lnum;
2531 #ifdef FEAT_AUTOCMD
2532 if (!read_stdin && !read_buffer)
2534 int m = msg_scroll;
2535 int n = msg_scrolled;
2537 /* Save the fileformat now, otherwise the buffer will be considered
2538 * modified if the format/encoding was automatically detected. */
2539 if (set_options)
2540 save_file_ff(curbuf);
2543 * The output from the autocommands should not overwrite anything and
2544 * should not be overwritten: Set msg_scroll, restore its value if no
2545 * output was done.
2547 msg_scroll = TRUE;
2548 if (filtering)
2549 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2550 FALSE, curbuf, eap);
2551 else if (newfile)
2552 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2553 FALSE, curbuf, eap);
2554 else
2555 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2556 FALSE, NULL, eap);
2557 if (msg_scrolled == n)
2558 msg_scroll = m;
2559 #ifdef FEAT_EVAL
2560 if (aborting()) /* autocmds may abort script processing */
2561 return FAIL;
2562 #endif
2564 #endif
2566 if (recoverymode && error)
2567 return FAIL;
2568 return OK;
2571 #ifdef OPEN_CHR_FILES
2573 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2574 * which is the name of files used for process substitution output by
2575 * some shells on some operating systems, e.g., bash on SunOS.
2576 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2578 static int
2579 is_dev_fd_file(fname)
2580 char_u *fname;
2582 return (STRNCMP(fname, "/dev/fd/", 8) == 0
2583 && VIM_ISDIGIT(fname[8])
2584 && *skipdigits(fname + 9) == NUL
2585 && (fname[9] != NUL
2586 || (fname[8] != '0' && fname[8] != '1' && fname[8] != '2')));
2588 #endif
2590 #ifdef FEAT_MBYTE
2593 * From the current line count and characters read after that, estimate the
2594 * line number where we are now.
2595 * Used for error messages that include a line number.
2597 static linenr_T
2598 readfile_linenr(linecnt, p, endp)
2599 linenr_T linecnt; /* line count before reading more bytes */
2600 char_u *p; /* start of more bytes read */
2601 char_u *endp; /* end of more bytes read */
2603 char_u *s;
2604 linenr_T lnum;
2606 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2607 for (s = p; s < endp; ++s)
2608 if (*s == '\n')
2609 ++lnum;
2610 return lnum;
2612 #endif
2615 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2616 * equal to the buffer "buf". Used for calling readfile().
2617 * Returns OK or FAIL.
2620 prep_exarg(eap, buf)
2621 exarg_T *eap;
2622 buf_T *buf;
2624 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2625 #ifdef FEAT_MBYTE
2626 + STRLEN(buf->b_p_fenc)
2627 #endif
2628 + 15));
2629 if (eap->cmd == NULL)
2630 return FAIL;
2632 #ifdef FEAT_MBYTE
2633 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2634 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2635 eap->bad_char = buf->b_bad_char;
2636 #else
2637 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2638 #endif
2639 eap->force_ff = 7;
2641 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2642 eap->read_edit = FALSE;
2643 eap->forceit = FALSE;
2644 return OK;
2647 #ifdef FEAT_MBYTE
2649 * Find next fileencoding to use from 'fileencodings'.
2650 * "pp" points to fenc_next. It's advanced to the next item.
2651 * When there are no more items, an empty string is returned and *pp is set to
2652 * NULL.
2653 * When *pp is not set to NULL, the result is in allocated memory.
2655 static char_u *
2656 next_fenc(pp)
2657 char_u **pp;
2659 char_u *p;
2660 char_u *r;
2662 if (**pp == NUL)
2664 *pp = NULL;
2665 return (char_u *)"";
2667 p = vim_strchr(*pp, ',');
2668 if (p == NULL)
2670 r = enc_canonize(*pp);
2671 *pp += STRLEN(*pp);
2673 else
2675 r = vim_strnsave(*pp, (int)(p - *pp));
2676 *pp = p + 1;
2677 if (r != NULL)
2679 p = enc_canonize(r);
2680 vim_free(r);
2681 r = p;
2684 if (r == NULL) /* out of memory */
2686 r = (char_u *)"";
2687 *pp = NULL;
2689 return r;
2692 # ifdef FEAT_EVAL
2694 * Convert a file with the 'charconvert' expression.
2695 * This closes the file which is to be read, converts it and opens the
2696 * resulting file for reading.
2697 * Returns name of the resulting converted file (the caller should delete it
2698 * after reading it).
2699 * Returns NULL if the conversion failed ("*fdp" is not set) .
2701 static char_u *
2702 readfile_charconvert(fname, fenc, fdp)
2703 char_u *fname; /* name of input file */
2704 char_u *fenc; /* converted from */
2705 int *fdp; /* in/out: file descriptor of file */
2707 char_u *tmpname;
2708 char_u *errmsg = NULL;
2710 tmpname = vim_tempname('r');
2711 if (tmpname == NULL)
2712 errmsg = (char_u *)_("Can't find temp file for conversion");
2713 else
2715 close(*fdp); /* close the input file, ignore errors */
2716 *fdp = -1;
2717 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2718 fname, tmpname) == FAIL)
2719 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2720 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2721 O_RDONLY | O_EXTRA, 0)) < 0)
2722 errmsg = (char_u *)_("can't read output of 'charconvert'");
2725 if (errmsg != NULL)
2727 /* Don't use emsg(), it breaks mappings, the retry with
2728 * another type of conversion might still work. */
2729 MSG(errmsg);
2730 if (tmpname != NULL)
2732 mch_remove(tmpname); /* delete converted file */
2733 vim_free(tmpname);
2734 tmpname = NULL;
2738 /* If the input file is closed, open it (caller should check for error). */
2739 if (*fdp < 0)
2740 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2742 return tmpname;
2744 # endif
2746 #endif
2748 #ifdef FEAT_VIMINFO
2750 * Read marks for the current buffer from the viminfo file, when we support
2751 * buffer marks and the buffer has a name.
2753 static void
2754 check_marks_read()
2756 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2757 && curbuf->b_ffname != NULL)
2758 read_viminfo(NULL, VIF_WANT_MARKS);
2760 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2761 * the ' parameter after opening a buffer. */
2762 curbuf->b_marks_read = TRUE;
2764 #endif
2766 #ifdef FEAT_CRYPT
2768 * Check for magic number used for encryption.
2769 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2770 * *filesizep are updated.
2771 * Return the (new) encryption key, NULL for no encryption.
2773 static char_u *
2774 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2775 char_u *cryptkey; /* previous encryption key or NULL */
2776 char_u *ptr; /* pointer to read bytes */
2777 long *sizep; /* length of read bytes */
2778 long *filesizep; /* nr of bytes used from file */
2779 int newfile; /* editing a new buffer */
2781 if (*sizep >= CRYPT_MAGIC_LEN
2782 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2784 if (cryptkey == NULL)
2786 if (*curbuf->b_p_key)
2787 cryptkey = curbuf->b_p_key;
2788 else
2790 /* When newfile is TRUE, store the typed key
2791 * in the 'key' option and don't free it. */
2792 cryptkey = get_crypt_key(newfile, FALSE);
2793 /* check if empty key entered */
2794 if (cryptkey != NULL && *cryptkey == NUL)
2796 if (cryptkey != curbuf->b_p_key)
2797 vim_free(cryptkey);
2798 cryptkey = NULL;
2803 if (cryptkey != NULL)
2805 crypt_init_keys(cryptkey);
2807 /* Remove magic number from the text */
2808 *filesizep += CRYPT_MAGIC_LEN;
2809 *sizep -= CRYPT_MAGIC_LEN;
2810 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2813 /* When starting to edit a new file which does not have
2814 * encryption, clear the 'key' option, except when
2815 * starting up (called with -x argument) */
2816 else if (newfile && *curbuf->b_p_key && !starting)
2817 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2819 return cryptkey;
2821 #endif
2823 #ifdef UNIX
2824 static void
2825 set_file_time(fname, atime, mtime)
2826 char_u *fname;
2827 time_t atime; /* access time */
2828 time_t mtime; /* modification time */
2830 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2831 struct utimbuf buf;
2833 buf.actime = atime;
2834 buf.modtime = mtime;
2835 (void)utime((char *)fname, &buf);
2836 # else
2837 # if defined(HAVE_UTIMES)
2838 struct timeval tvp[2];
2840 tvp[0].tv_sec = atime;
2841 tvp[0].tv_usec = 0;
2842 tvp[1].tv_sec = mtime;
2843 tvp[1].tv_usec = 0;
2844 # ifdef NeXT
2845 (void)utimes((char *)fname, tvp);
2846 # else
2847 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2848 # endif
2849 # endif
2850 # endif
2852 #endif /* UNIX */
2854 #if defined(VMS) && !defined(MIN)
2855 /* Older DECC compiler for VAX doesn't define MIN() */
2856 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2857 #endif
2860 * Return TRUE if a file appears to be read-only from the file permissions.
2863 check_file_readonly(fname, perm)
2864 char_u *fname; /* full path to file */
2865 int perm; /* known permissions on file */
2867 #ifndef USE_MCH_ACCESS
2868 int fd = 0;
2869 #endif
2871 return (
2872 #ifdef USE_MCH_ACCESS
2873 # ifdef UNIX
2874 (perm & 0222) == 0 ||
2875 # endif
2876 mch_access((char *)fname, W_OK)
2877 #else
2878 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
2879 ? TRUE : (close(fd), FALSE)
2880 #endif
2886 * buf_write() - write to file "fname" lines "start" through "end"
2888 * We do our own buffering here because fwrite() is so slow.
2890 * If "forceit" is true, we don't care for errors when attempting backups.
2891 * In case of an error everything possible is done to restore the original
2892 * file. But when "forceit" is TRUE, we risk losing it.
2894 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2895 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2897 * This function must NOT use NameBuff (because it's called by autowrite()).
2899 * return FAIL for failure, OK otherwise
2902 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2903 reset_changed, filtering)
2904 buf_T *buf;
2905 char_u *fname;
2906 char_u *sfname;
2907 linenr_T start, end;
2908 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2909 NULL! */
2910 int append; /* append to the file */
2911 int forceit;
2912 int reset_changed;
2913 int filtering;
2915 int fd;
2916 char_u *backup = NULL;
2917 int backup_copy = FALSE; /* copy the original file? */
2918 int dobackup;
2919 char_u *ffname;
2920 char_u *wfname = NULL; /* name of file to write to */
2921 char_u *s;
2922 char_u *ptr;
2923 char_u c;
2924 int len;
2925 linenr_T lnum;
2926 long nchars;
2927 char_u *errmsg = NULL;
2928 int errmsg_allocated = FALSE;
2929 char_u *errnum = NULL;
2930 char_u *buffer;
2931 char_u smallbuf[SMBUFSIZE];
2932 char_u *backup_ext;
2933 int bufsize;
2934 long perm; /* file permissions */
2935 int retval = OK;
2936 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2937 int msg_save = msg_scroll;
2938 int overwriting; /* TRUE if writing over original */
2939 int no_eol = FALSE; /* no end-of-line written */
2940 int device = FALSE; /* writing to a device */
2941 struct stat st_old;
2942 int prev_got_int = got_int;
2943 int file_readonly = FALSE; /* overwritten file is read-only */
2944 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2945 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2946 int made_writable = FALSE; /* 'w' bit has been set */
2947 #endif
2948 /* writing everything */
2949 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2950 #ifdef FEAT_AUTOCMD
2951 linenr_T old_line_count = buf->b_ml.ml_line_count;
2952 #endif
2953 int attr;
2954 int fileformat;
2955 int write_bin;
2956 struct bw_info write_info; /* info for buf_write_bytes() */
2957 #ifdef FEAT_MBYTE
2958 int converted = FALSE;
2959 int notconverted = FALSE;
2960 char_u *fenc; /* effective 'fileencoding' */
2961 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2962 #endif
2963 #ifdef HAS_BW_FLAGS
2964 int wb_flags = 0;
2965 #endif
2966 #ifdef HAVE_ACL
2967 vim_acl_T acl = NULL; /* ACL copied from original file to
2968 backup or new file */
2969 #endif
2971 if (fname == NULL || *fname == NUL) /* safety check */
2972 return FAIL;
2975 * Disallow writing from .exrc and .vimrc in current directory for
2976 * security reasons.
2978 if (check_secure())
2979 return FAIL;
2981 /* Avoid a crash for a long name. */
2982 if (STRLEN(fname) >= MAXPATHL)
2984 EMSG(_(e_longname));
2985 return FAIL;
2988 #ifdef FEAT_MBYTE
2989 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2990 write_info.bw_conv_buf = NULL;
2991 write_info.bw_conv_error = FALSE;
2992 write_info.bw_conv_error_lnum = 0;
2993 write_info.bw_restlen = 0;
2994 # ifdef USE_ICONV
2995 write_info.bw_iconv_fd = (iconv_t)-1;
2996 # endif
2997 #endif
2999 /* After writing a file changedtick changes but we don't want to display
3000 * the line. */
3001 ex_no_reprint = TRUE;
3004 * If there is no file name yet, use the one for the written file.
3005 * BF_NOTEDITED is set to reflect this (in case the write fails).
3006 * Don't do this when the write is for a filter command.
3007 * Don't do this when appending.
3008 * Only do this when 'cpoptions' contains the 'F' flag.
3010 if (buf->b_ffname == NULL
3011 && reset_changed
3012 && whole
3013 && buf == curbuf
3014 #ifdef FEAT_QUICKFIX
3015 && !bt_nofile(buf)
3016 #endif
3017 && !filtering
3018 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
3019 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
3021 if (set_rw_fname(fname, sfname) == FAIL)
3022 return FAIL;
3023 buf = curbuf; /* just in case autocmds made "buf" invalid */
3026 if (sfname == NULL)
3027 sfname = fname;
3029 * For Unix: Use the short file name whenever possible.
3030 * Avoids problems with networks and when directory names are changed.
3031 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
3032 * another directory, which we don't detect
3034 ffname = fname; /* remember full fname */
3035 #ifdef UNIX
3036 fname = sfname;
3037 #endif
3039 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
3040 overwriting = TRUE;
3041 else
3042 overwriting = FALSE;
3044 if (exiting)
3045 settmode(TMODE_COOK); /* when exiting allow typahead now */
3047 ++no_wait_return; /* don't wait for return yet */
3050 * Set '[ and '] marks to the lines to be written.
3052 buf->b_op_start.lnum = start;
3053 buf->b_op_start.col = 0;
3054 buf->b_op_end.lnum = end;
3055 buf->b_op_end.col = 0;
3057 #ifdef FEAT_AUTOCMD
3059 aco_save_T aco;
3060 int buf_ffname = FALSE;
3061 int buf_sfname = FALSE;
3062 int buf_fname_f = FALSE;
3063 int buf_fname_s = FALSE;
3064 int did_cmd = FALSE;
3065 int nofile_err = FALSE;
3066 int empty_memline = (buf->b_ml.ml_mfp == NULL);
3069 * Apply PRE aucocommands.
3070 * Set curbuf to the buffer to be written.
3071 * Careful: The autocommands may call buf_write() recursively!
3073 if (ffname == buf->b_ffname)
3074 buf_ffname = TRUE;
3075 if (sfname == buf->b_sfname)
3076 buf_sfname = TRUE;
3077 if (fname == buf->b_ffname)
3078 buf_fname_f = TRUE;
3079 if (fname == buf->b_sfname)
3080 buf_fname_s = TRUE;
3082 /* set curwin/curbuf to buf and save a few things */
3083 aucmd_prepbuf(&aco, buf);
3085 if (append)
3087 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
3088 sfname, sfname, FALSE, curbuf, eap)))
3090 #ifdef FEAT_QUICKFIX
3091 if (overwriting && bt_nofile(curbuf))
3092 nofile_err = TRUE;
3093 else
3094 #endif
3095 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
3096 sfname, sfname, FALSE, curbuf, eap);
3099 else if (filtering)
3101 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
3102 NULL, sfname, FALSE, curbuf, eap);
3104 else if (reset_changed && whole)
3106 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
3107 sfname, sfname, FALSE, curbuf, eap)))
3109 #ifdef FEAT_QUICKFIX
3110 if (overwriting && bt_nofile(curbuf))
3111 nofile_err = TRUE;
3112 else
3113 #endif
3114 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
3115 sfname, sfname, FALSE, curbuf, eap);
3118 else
3120 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
3121 sfname, sfname, FALSE, curbuf, eap)))
3123 #ifdef FEAT_QUICKFIX
3124 if (overwriting && bt_nofile(curbuf))
3125 nofile_err = TRUE;
3126 else
3127 #endif
3128 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
3129 sfname, sfname, FALSE, curbuf, eap);
3133 /* restore curwin/curbuf and a few other things */
3134 aucmd_restbuf(&aco);
3137 * In three situations we return here and don't write the file:
3138 * 1. the autocommands deleted or unloaded the buffer.
3139 * 2. The autocommands abort script processing.
3140 * 3. If one of the "Cmd" autocommands was executed.
3142 if (!buf_valid(buf))
3143 buf = NULL;
3144 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
3145 || did_cmd || nofile_err
3146 #ifdef FEAT_EVAL
3147 || aborting()
3148 #endif
3151 --no_wait_return;
3152 msg_scroll = msg_save;
3153 if (nofile_err)
3154 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3156 if (nofile_err
3157 #ifdef FEAT_EVAL
3158 || aborting()
3159 #endif
3161 /* An aborting error, interrupt or exception in the
3162 * autocommands. */
3163 return FAIL;
3164 if (did_cmd)
3166 if (buf == NULL)
3167 /* The buffer was deleted. We assume it was written
3168 * (can't retry anyway). */
3169 return OK;
3170 if (overwriting)
3172 /* Assume the buffer was written, update the timestamp. */
3173 ml_timestamp(buf);
3174 if (append)
3175 buf->b_flags &= ~BF_NEW;
3176 else
3177 buf->b_flags &= ~BF_WRITE_MASK;
3179 if (reset_changed && buf->b_changed && !append
3180 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3181 /* Buffer still changed, the autocommands didn't work
3182 * properly. */
3183 return FAIL;
3184 return OK;
3186 #ifdef FEAT_EVAL
3187 if (!aborting())
3188 #endif
3189 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3190 return FAIL;
3194 * The autocommands may have changed the number of lines in the file.
3195 * When writing the whole file, adjust the end.
3196 * When writing part of the file, assume that the autocommands only
3197 * changed the number of lines that are to be written (tricky!).
3199 if (buf->b_ml.ml_line_count != old_line_count)
3201 if (whole) /* write all */
3202 end = buf->b_ml.ml_line_count;
3203 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3204 end += buf->b_ml.ml_line_count - old_line_count;
3205 else /* less lines */
3207 end -= old_line_count - buf->b_ml.ml_line_count;
3208 if (end < start)
3210 --no_wait_return;
3211 msg_scroll = msg_save;
3212 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3213 return FAIL;
3219 * The autocommands may have changed the name of the buffer, which may
3220 * be kept in fname, ffname and sfname.
3222 if (buf_ffname)
3223 ffname = buf->b_ffname;
3224 if (buf_sfname)
3225 sfname = buf->b_sfname;
3226 if (buf_fname_f)
3227 fname = buf->b_ffname;
3228 if (buf_fname_s)
3229 fname = buf->b_sfname;
3231 #endif
3233 #ifdef FEAT_NETBEANS_INTG
3234 if (usingNetbeans && isNetbeansBuffer(buf))
3236 if (whole)
3239 * b_changed can be 0 after an undo, but we still need to write
3240 * the buffer to NetBeans.
3242 if (buf->b_changed || isNetbeansModified(buf))
3244 --no_wait_return; /* may wait for return now */
3245 msg_scroll = msg_save;
3246 netbeans_save_buffer(buf); /* no error checking... */
3247 return retval;
3249 else
3251 errnum = (char_u *)"E656: ";
3252 errmsg = (char_u *)_("NetBeans disallows writes of unmodified buffers");
3253 buffer = NULL;
3254 goto fail;
3257 else
3259 errnum = (char_u *)"E657: ";
3260 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3261 buffer = NULL;
3262 goto fail;
3265 #endif
3267 if (shortmess(SHM_OVER) && !exiting)
3268 msg_scroll = FALSE; /* overwrite previous file message */
3269 else
3270 msg_scroll = TRUE; /* don't overwrite previous file message */
3271 if (!filtering)
3272 filemess(buf,
3273 #ifndef UNIX
3274 sfname,
3275 #else
3276 fname,
3277 #endif
3278 (char_u *)"", 0); /* show that we are busy */
3279 msg_scroll = FALSE; /* always overwrite the file message now */
3281 buffer = alloc(BUFSIZE);
3282 if (buffer == NULL) /* can't allocate big buffer, use small
3283 * one (to be able to write when out of
3284 * memory) */
3286 buffer = smallbuf;
3287 bufsize = SMBUFSIZE;
3289 else
3290 bufsize = BUFSIZE;
3293 * Get information about original file (if there is one).
3295 #if defined(UNIX) && !defined(ARCHIE)
3296 st_old.st_dev = 0;
3297 st_old.st_ino = 0;
3298 perm = -1;
3299 if (mch_stat((char *)fname, &st_old) < 0)
3300 newfile = TRUE;
3301 else
3303 perm = st_old.st_mode;
3304 if (!S_ISREG(st_old.st_mode)) /* not a file */
3306 if (S_ISDIR(st_old.st_mode))
3308 errnum = (char_u *)"E502: ";
3309 errmsg = (char_u *)_("is a directory");
3310 goto fail;
3312 if (mch_nodetype(fname) != NODE_WRITABLE)
3314 errnum = (char_u *)"E503: ";
3315 errmsg = (char_u *)_("is not a file or writable device");
3316 goto fail;
3318 /* It's a device of some kind (or a fifo) which we can write to
3319 * but for which we can't make a backup. */
3320 device = TRUE;
3321 newfile = TRUE;
3322 perm = -1;
3325 #else /* !UNIX */
3327 * Check for a writable device name.
3329 c = mch_nodetype(fname);
3330 if (c == NODE_OTHER)
3332 errnum = (char_u *)"E503: ";
3333 errmsg = (char_u *)_("is not a file or writable device");
3334 goto fail;
3336 if (c == NODE_WRITABLE)
3338 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3339 /* MS-Windows allows opening a device, but we will probably get stuck
3340 * trying to write to it. */
3341 if (!p_odev)
3343 errnum = (char_u *)"E796: ";
3344 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3345 goto fail;
3347 # endif
3348 device = TRUE;
3349 newfile = TRUE;
3350 perm = -1;
3352 else
3354 perm = mch_getperm(fname);
3355 if (perm < 0)
3356 newfile = TRUE;
3357 else if (mch_isdir(fname))
3359 errnum = (char_u *)"E502: ";
3360 errmsg = (char_u *)_("is a directory");
3361 goto fail;
3363 if (overwriting)
3364 (void)mch_stat((char *)fname, &st_old);
3366 #endif /* !UNIX */
3368 if (!device && !newfile)
3371 * Check if the file is really writable (when renaming the file to
3372 * make a backup we won't discover it later).
3374 file_readonly = check_file_readonly(fname, (int)perm);
3376 if (!forceit && file_readonly)
3378 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3380 errnum = (char_u *)"E504: ";
3381 errmsg = (char_u *)_(err_readonly);
3383 else
3385 errnum = (char_u *)"E505: ";
3386 errmsg = (char_u *)_("is read-only (add ! to override)");
3388 goto fail;
3392 * Check if the timestamp hasn't changed since reading the file.
3394 if (overwriting)
3396 retval = check_mtime(buf, &st_old);
3397 if (retval == FAIL)
3398 goto fail;
3402 #ifdef HAVE_ACL
3404 * For systems that support ACL: get the ACL from the original file.
3406 if (!newfile)
3407 acl = mch_get_acl(fname);
3408 #endif
3411 * If 'backupskip' is not empty, don't make a backup for some files.
3413 dobackup = (p_wb || p_bk || *p_pm != NUL);
3414 #ifdef FEAT_WILDIGN
3415 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3416 dobackup = FALSE;
3417 #endif
3420 * Save the value of got_int and reset it. We don't want a previous
3421 * interruption cancel writing, only hitting CTRL-C while writing should
3422 * abort it.
3424 prev_got_int = got_int;
3425 got_int = FALSE;
3427 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3428 buf->b_saving = TRUE;
3431 * If we are not appending or filtering, the file exists, and the
3432 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3433 * When 'patchmode' is set also make a backup when appending.
3435 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3436 * off. This helps when editing large files on almost-full disks.
3438 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3440 #if defined(UNIX) || defined(WIN32)
3441 struct stat st;
3442 #endif
3444 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3445 backup_copy = TRUE;
3446 #if defined(UNIX) || defined(WIN32)
3447 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3449 int i;
3451 # ifdef UNIX
3453 * Don't rename the file when:
3454 * - it's a hard link
3455 * - it's a symbolic link
3456 * - we don't have write permission in the directory
3457 * - we can't set the owner/group of the new file
3459 if (st_old.st_nlink > 1
3460 || mch_lstat((char *)fname, &st) < 0
3461 || st.st_dev != st_old.st_dev
3462 || st.st_ino != st_old.st_ino
3463 # ifndef HAVE_FCHOWN
3464 || st.st_uid != st_old.st_uid
3465 || st.st_gid != st_old.st_gid
3466 # endif
3468 backup_copy = TRUE;
3469 else
3470 # else
3471 # ifdef WIN32
3472 /* On NTFS file systems hard links are possible. */
3473 if (mch_is_linked(fname))
3474 backup_copy = TRUE;
3475 else
3476 # endif
3477 # endif
3480 * Check if we can create a file and set the owner/group to
3481 * the ones from the original file.
3482 * First find a file name that doesn't exist yet (use some
3483 * arbitrary numbers).
3485 STRCPY(IObuff, fname);
3486 for (i = 4913; ; i += 123)
3488 sprintf((char *)gettail(IObuff), "%d", i);
3489 if (mch_lstat((char *)IObuff, &st) < 0)
3490 break;
3492 fd = mch_open((char *)IObuff,
3493 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3494 if (fd < 0) /* can't write in directory */
3495 backup_copy = TRUE;
3496 else
3498 # ifdef UNIX
3499 # ifdef HAVE_FCHOWN
3500 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
3501 # endif
3502 if (mch_stat((char *)IObuff, &st) < 0
3503 || st.st_uid != st_old.st_uid
3504 || st.st_gid != st_old.st_gid
3505 || (long)st.st_mode != perm)
3506 backup_copy = TRUE;
3507 # endif
3508 /* Close the file before removing it, on MS-Windows we
3509 * can't delete an open file. */
3510 close(fd);
3511 mch_remove(IObuff);
3516 # ifdef UNIX
3518 * Break symlinks and/or hardlinks if we've been asked to.
3520 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3522 int lstat_res;
3524 lstat_res = mch_lstat((char *)fname, &st);
3526 /* Symlinks. */
3527 if ((bkc_flags & BKC_BREAKSYMLINK)
3528 && lstat_res == 0
3529 && st.st_ino != st_old.st_ino)
3530 backup_copy = FALSE;
3532 /* Hardlinks. */
3533 if ((bkc_flags & BKC_BREAKHARDLINK)
3534 && st_old.st_nlink > 1
3535 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3536 backup_copy = FALSE;
3538 #endif
3540 #endif
3542 /* make sure we have a valid backup extension to use */
3543 if (*p_bex == NUL)
3545 #ifdef RISCOS
3546 backup_ext = (char_u *)"/bak";
3547 #else
3548 backup_ext = (char_u *)".bak";
3549 #endif
3551 else
3552 backup_ext = p_bex;
3554 if (backup_copy
3555 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3557 int bfd;
3558 char_u *copybuf, *wp;
3559 int some_error = FALSE;
3560 struct stat st_new;
3561 char_u *dirp;
3562 char_u *rootname;
3563 #if defined(UNIX) && !defined(SHORT_FNAME)
3564 int did_set_shortname;
3565 #endif
3567 copybuf = alloc(BUFSIZE + 1);
3568 if (copybuf == NULL)
3570 some_error = TRUE; /* out of memory */
3571 goto nobackup;
3575 * Try to make the backup in each directory in the 'bdir' option.
3577 * Unix semantics has it, that we may have a writable file,
3578 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3579 * - the directory is not writable,
3580 * - the file may be a symbolic link,
3581 * - the file may belong to another user/group, etc.
3583 * For these reasons, the existing writable file must be truncated
3584 * and reused. Creation of a backup COPY will be attempted.
3586 dirp = p_bdir;
3587 while (*dirp)
3589 #ifdef UNIX
3590 st_new.st_ino = 0;
3591 st_new.st_dev = 0;
3592 st_new.st_gid = 0;
3593 #endif
3596 * Isolate one directory name, using an entry in 'bdir'.
3598 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3599 rootname = get_file_in_dir(fname, copybuf);
3600 if (rootname == NULL)
3602 some_error = TRUE; /* out of memory */
3603 goto nobackup;
3606 #if defined(UNIX) && !defined(SHORT_FNAME)
3607 did_set_shortname = FALSE;
3608 #endif
3611 * May try twice if 'shortname' not set.
3613 for (;;)
3616 * Make backup file name.
3618 backup = buf_modname(
3619 #ifdef SHORT_FNAME
3620 TRUE,
3621 #else
3622 (buf->b_p_sn || buf->b_shortname),
3623 #endif
3624 rootname, backup_ext, FALSE);
3625 if (backup == NULL)
3627 vim_free(rootname);
3628 some_error = TRUE; /* out of memory */
3629 goto nobackup;
3633 * Check if backup file already exists.
3635 if (mch_stat((char *)backup, &st_new) >= 0)
3637 #ifdef UNIX
3639 * Check if backup file is same as original file.
3640 * May happen when modname() gave the same file back.
3641 * E.g. silly link, or file name-length reached.
3642 * If we don't check here, we either ruin the file
3643 * when copying or erase it after writing. jw.
3645 if (st_new.st_dev == st_old.st_dev
3646 && st_new.st_ino == st_old.st_ino)
3648 vim_free(backup);
3649 backup = NULL; /* no backup file to delete */
3650 # ifndef SHORT_FNAME
3652 * may try again with 'shortname' set
3654 if (!(buf->b_shortname || buf->b_p_sn))
3656 buf->b_shortname = TRUE;
3657 did_set_shortname = TRUE;
3658 continue;
3660 /* setting shortname didn't help */
3661 if (did_set_shortname)
3662 buf->b_shortname = FALSE;
3663 # endif
3664 break;
3666 #endif
3669 * If we are not going to keep the backup file, don't
3670 * delete an existing one, try to use another name.
3671 * Change one character, just before the extension.
3673 if (!p_bk)
3675 wp = backup + STRLEN(backup) - 1
3676 - STRLEN(backup_ext);
3677 if (wp < backup) /* empty file name ??? */
3678 wp = backup;
3679 *wp = 'z';
3680 while (*wp > 'a'
3681 && mch_stat((char *)backup, &st_new) >= 0)
3682 --*wp;
3683 /* They all exist??? Must be something wrong. */
3684 if (*wp == 'a')
3686 vim_free(backup);
3687 backup = NULL;
3691 break;
3693 vim_free(rootname);
3696 * Try to create the backup file
3698 if (backup != NULL)
3700 /* remove old backup, if present */
3701 mch_remove(backup);
3702 /* Open with O_EXCL to avoid the file being created while
3703 * we were sleeping (symlink hacker attack?) */
3704 bfd = mch_open((char *)backup,
3705 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3706 perm & 0777);
3707 if (bfd < 0)
3709 vim_free(backup);
3710 backup = NULL;
3712 else
3714 /* set file protection same as original file, but
3715 * strip s-bit */
3716 (void)mch_setperm(backup, perm & 0777);
3718 #ifdef UNIX
3720 * Try to set the group of the backup same as the
3721 * original file. If this fails, set the protection
3722 * bits for the group same as the protection bits for
3723 * others.
3725 if (st_new.st_gid != st_old.st_gid
3726 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3727 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3728 # endif
3730 mch_setperm(backup,
3731 (perm & 0707) | ((perm & 07) << 3));
3732 # ifdef HAVE_SELINUX
3733 mch_copy_sec(fname, backup);
3734 # endif
3735 #endif
3738 * copy the file.
3740 write_info.bw_fd = bfd;
3741 write_info.bw_buf = copybuf;
3742 #ifdef HAS_BW_FLAGS
3743 write_info.bw_flags = FIO_NOCONVERT;
3744 #endif
3745 while ((write_info.bw_len = vim_read(fd, copybuf,
3746 BUFSIZE)) > 0)
3748 if (buf_write_bytes(&write_info) == FAIL)
3750 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3751 break;
3753 ui_breakcheck();
3754 if (got_int)
3756 errmsg = (char_u *)_(e_interr);
3757 break;
3761 if (close(bfd) < 0 && errmsg == NULL)
3762 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3763 if (write_info.bw_len < 0)
3764 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3765 #ifdef UNIX
3766 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3767 #endif
3768 #ifdef HAVE_ACL
3769 mch_set_acl(backup, acl);
3770 #endif
3771 #ifdef HAVE_SELINUX
3772 mch_copy_sec(fname, backup);
3773 #endif
3774 break;
3778 nobackup:
3779 close(fd); /* ignore errors for closing read file */
3780 vim_free(copybuf);
3782 if (backup == NULL && errmsg == NULL)
3783 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3784 /* ignore errors when forceit is TRUE */
3785 if ((some_error || errmsg != NULL) && !forceit)
3787 retval = FAIL;
3788 goto fail;
3790 errmsg = NULL;
3792 else
3794 char_u *dirp;
3795 char_u *p;
3796 char_u *rootname;
3799 * Make a backup by renaming the original file.
3802 * If 'cpoptions' includes the "W" flag, we don't want to
3803 * overwrite a read-only file. But rename may be possible
3804 * anyway, thus we need an extra check here.
3806 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3808 errnum = (char_u *)"E504: ";
3809 errmsg = (char_u *)_(err_readonly);
3810 goto fail;
3815 * Form the backup file name - change path/fo.o.h to
3816 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3817 * that works is used.
3819 dirp = p_bdir;
3820 while (*dirp)
3823 * Isolate one directory name and make the backup file name.
3825 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3826 rootname = get_file_in_dir(fname, IObuff);
3827 if (rootname == NULL)
3828 backup = NULL;
3829 else
3831 backup = buf_modname(
3832 #ifdef SHORT_FNAME
3833 TRUE,
3834 #else
3835 (buf->b_p_sn || buf->b_shortname),
3836 #endif
3837 rootname, backup_ext, FALSE);
3838 vim_free(rootname);
3841 if (backup != NULL)
3844 * If we are not going to keep the backup file, don't
3845 * delete an existing one, try to use another name.
3846 * Change one character, just before the extension.
3848 if (!p_bk && mch_getperm(backup) >= 0)
3850 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3851 if (p < backup) /* empty file name ??? */
3852 p = backup;
3853 *p = 'z';
3854 while (*p > 'a' && mch_getperm(backup) >= 0)
3855 --*p;
3856 /* They all exist??? Must be something wrong! */
3857 if (*p == 'a')
3859 vim_free(backup);
3860 backup = NULL;
3864 if (backup != NULL)
3867 * Delete any existing backup and move the current version
3868 * to the backup. For safety, we don't remove the backup
3869 * until the write has finished successfully. And if the
3870 * 'backup' option is set, leave it around.
3873 * If the renaming of the original file to the backup file
3874 * works, quit here.
3876 if (vim_rename(fname, backup) == 0)
3877 break;
3879 vim_free(backup); /* don't do the rename below */
3880 backup = NULL;
3883 if (backup == NULL && !forceit)
3885 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3886 goto fail;
3891 #if defined(UNIX) && !defined(ARCHIE)
3892 /* When using ":w!" and the file was read-only: make it writable */
3893 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3894 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3896 perm |= 0200;
3897 (void)mch_setperm(fname, perm);
3898 made_writable = TRUE;
3900 #endif
3902 /* When using ":w!" and writing to the current file, 'readonly' makes no
3903 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3904 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3906 buf->b_p_ro = FALSE;
3907 #ifdef FEAT_TITLE
3908 need_maketitle = TRUE; /* set window title later */
3909 #endif
3910 #ifdef FEAT_WINDOWS
3911 status_redraw_all(); /* redraw status lines later */
3912 #endif
3915 if (end > buf->b_ml.ml_line_count)
3916 end = buf->b_ml.ml_line_count;
3917 if (buf->b_ml.ml_flags & ML_EMPTY)
3918 start = end + 1;
3921 * If the original file is being overwritten, there is a small chance that
3922 * we crash in the middle of writing. Therefore the file is preserved now.
3923 * This makes all block numbers positive so that recovery does not need
3924 * the original file.
3925 * Don't do this if there is a backup file and we are exiting.
3927 if (reset_changed && !newfile && overwriting
3928 && !(exiting && backup != NULL))
3930 ml_preserve(buf, FALSE);
3931 if (got_int)
3933 errmsg = (char_u *)_(e_interr);
3934 goto restore_backup;
3938 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3940 * Before risking to lose the original file verify if there's
3941 * a resource fork to preserve, and if cannot be done warn
3942 * the users. This happens when overwriting without backups.
3944 if (backup == NULL && overwriting && !append)
3945 if (mch_has_resource_fork(fname))
3947 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3948 goto restore_backup;
3950 #endif
3952 #ifdef VMS
3953 vms_remove_version(fname); /* remove version */
3954 #endif
3955 /* Default: write the file directly. May write to a temp file for
3956 * multi-byte conversion. */
3957 wfname = fname;
3959 #ifdef FEAT_MBYTE
3960 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3961 if (eap != NULL && eap->force_enc != 0)
3963 fenc = eap->cmd + eap->force_enc;
3964 fenc = enc_canonize(fenc);
3965 fenc_tofree = fenc;
3967 else
3968 fenc = buf->b_p_fenc;
3971 * Check if the file needs to be converted.
3973 converted = need_conversion(fenc);
3976 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3977 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3978 * Prepare the flags for it and allocate bw_conv_buf when needed.
3980 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3982 wb_flags = get_fio_flags(fenc);
3983 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3985 /* Need to allocate a buffer to translate into. */
3986 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3987 write_info.bw_conv_buflen = bufsize * 2;
3988 else /* FIO_UCS4 */
3989 write_info.bw_conv_buflen = bufsize * 4;
3990 write_info.bw_conv_buf
3991 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3992 if (write_info.bw_conv_buf == NULL)
3993 end = 0;
3997 # ifdef WIN3264
3998 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
4000 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
4001 write_info.bw_conv_buflen = bufsize * 4;
4002 write_info.bw_conv_buf
4003 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4004 if (write_info.bw_conv_buf == NULL)
4005 end = 0;
4007 # endif
4009 # ifdef MACOS_X
4010 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
4012 write_info.bw_conv_buflen = bufsize * 3;
4013 write_info.bw_conv_buf
4014 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4015 if (write_info.bw_conv_buf == NULL)
4016 end = 0;
4018 # endif
4020 # if defined(FEAT_EVAL) || defined(USE_ICONV)
4021 if (converted && wb_flags == 0)
4023 # ifdef USE_ICONV
4025 * Use iconv() conversion when conversion is needed and it's not done
4026 * internally.
4028 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
4029 enc_utf8 ? (char_u *)"utf-8" : p_enc);
4030 if (write_info.bw_iconv_fd != (iconv_t)-1)
4032 /* We're going to use iconv(), allocate a buffer to convert in. */
4033 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
4034 write_info.bw_conv_buf
4035 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4036 if (write_info.bw_conv_buf == NULL)
4037 end = 0;
4038 write_info.bw_first = TRUE;
4040 # ifdef FEAT_EVAL
4041 else
4042 # endif
4043 # endif
4045 # ifdef FEAT_EVAL
4047 * When the file needs to be converted with 'charconvert' after
4048 * writing, write to a temp file instead and let the conversion
4049 * overwrite the original file.
4051 if (*p_ccv != NUL)
4053 wfname = vim_tempname('w');
4054 if (wfname == NULL) /* Can't write without a tempfile! */
4056 errmsg = (char_u *)_("E214: Can't find temp file for writing");
4057 goto restore_backup;
4060 # endif
4062 # endif
4063 if (converted && wb_flags == 0
4064 # ifdef USE_ICONV
4065 && write_info.bw_iconv_fd == (iconv_t)-1
4066 # endif
4067 # ifdef FEAT_EVAL
4068 && wfname == fname
4069 # endif
4072 if (!forceit)
4074 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
4075 goto restore_backup;
4077 notconverted = TRUE;
4079 #endif
4082 * Open the file "wfname" for writing.
4083 * We may try to open the file twice: If we can't write to the
4084 * file and forceit is TRUE we delete the existing file and try to create
4085 * a new one. If this still fails we may have lost the original file!
4086 * (this may happen when the user reached his quotum for number of files).
4087 * Appending will fail if the file does not exist and forceit is FALSE.
4089 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
4090 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
4091 : (O_CREAT | O_TRUNC))
4092 , perm < 0 ? 0666 : (perm & 0777))) < 0)
4095 * A forced write will try to create a new file if the old one is
4096 * still readonly. This may also happen when the directory is
4097 * read-only. In that case the mch_remove() will fail.
4099 if (errmsg == NULL)
4101 #ifdef UNIX
4102 struct stat st;
4104 /* Don't delete the file when it's a hard or symbolic link. */
4105 if ((!newfile && st_old.st_nlink > 1)
4106 || (mch_lstat((char *)fname, &st) == 0
4107 && (st.st_dev != st_old.st_dev
4108 || st.st_ino != st_old.st_ino)))
4109 errmsg = (char_u *)_("E166: Can't open linked file for writing");
4110 else
4111 #endif
4113 errmsg = (char_u *)_("E212: Can't open file for writing");
4114 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
4115 && perm >= 0)
4117 #ifdef UNIX
4118 /* we write to the file, thus it should be marked
4119 writable after all */
4120 if (!(perm & 0200))
4121 made_writable = TRUE;
4122 perm |= 0200;
4123 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
4124 perm &= 0777;
4125 #endif
4126 if (!append) /* don't remove when appending */
4127 mch_remove(wfname);
4128 continue;
4133 restore_backup:
4135 struct stat st;
4138 * If we failed to open the file, we don't need a backup. Throw it
4139 * away. If we moved or removed the original file try to put the
4140 * backup in its place.
4142 if (backup != NULL && wfname == fname)
4144 if (backup_copy)
4147 * There is a small chance that we removed the original,
4148 * try to move the copy in its place.
4149 * This may not work if the vim_rename() fails.
4150 * In that case we leave the copy around.
4152 /* If file does not exist, put the copy in its place */
4153 if (mch_stat((char *)fname, &st) < 0)
4154 vim_rename(backup, fname);
4155 /* if original file does exist throw away the copy */
4156 if (mch_stat((char *)fname, &st) >= 0)
4157 mch_remove(backup);
4159 else
4161 /* try to put the original file back */
4162 vim_rename(backup, fname);
4166 /* if original file no longer exists give an extra warning */
4167 if (!newfile && mch_stat((char *)fname, &st) < 0)
4168 end = 0;
4171 #ifdef FEAT_MBYTE
4172 if (wfname != fname)
4173 vim_free(wfname);
4174 #endif
4175 goto fail;
4177 errmsg = NULL;
4179 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4180 /* TODO: Is it need for MACOS_X? (Dany) */
4182 * On macintosh copy the original files attributes (i.e. the backup)
4183 * This is done in order to preserve the resource fork and the
4184 * Finder attribute (label, comments, custom icons, file creator)
4186 if (backup != NULL && overwriting && !append)
4188 if (backup_copy)
4189 (void)mch_copy_file_attribute(wfname, backup);
4190 else
4191 (void)mch_copy_file_attribute(backup, wfname);
4194 if (!overwriting && !append)
4196 if (buf->b_ffname != NULL)
4197 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4198 /* Should copy resource fork */
4200 #endif
4202 write_info.bw_fd = fd;
4204 #ifdef FEAT_CRYPT
4205 if (*buf->b_p_key && !filtering)
4207 crypt_init_keys(buf->b_p_key);
4208 /* Write magic number, so that Vim knows that this file is encrypted
4209 * when reading it again. This also undergoes utf-8 to ucs-2/4
4210 * conversion when needed. */
4211 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4212 write_info.bw_len = CRYPT_MAGIC_LEN;
4213 write_info.bw_flags = FIO_NOCONVERT;
4214 if (buf_write_bytes(&write_info) == FAIL)
4215 end = 0;
4216 wb_flags |= FIO_ENCRYPTED;
4218 #endif
4220 write_info.bw_buf = buffer;
4221 nchars = 0;
4223 /* use "++bin", "++nobin" or 'binary' */
4224 if (eap != NULL && eap->force_bin != 0)
4225 write_bin = (eap->force_bin == FORCE_BIN);
4226 else
4227 write_bin = buf->b_p_bin;
4229 #ifdef FEAT_MBYTE
4231 * The BOM is written just after the encryption magic number.
4232 * Skip it when appending and the file already existed, the BOM only makes
4233 * sense at the start of the file.
4235 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4237 write_info.bw_len = make_bom(buffer, fenc);
4238 if (write_info.bw_len > 0)
4240 /* don't convert, do encryption */
4241 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4242 if (buf_write_bytes(&write_info) == FAIL)
4243 end = 0;
4244 else
4245 nchars += write_info.bw_len;
4248 write_info.bw_start_lnum = start;
4249 #endif
4251 write_info.bw_len = bufsize;
4252 #ifdef HAS_BW_FLAGS
4253 write_info.bw_flags = wb_flags;
4254 #endif
4255 fileformat = get_fileformat_force(buf, eap);
4256 s = buffer;
4257 len = 0;
4258 for (lnum = start; lnum <= end; ++lnum)
4261 * The next while loop is done once for each character written.
4262 * Keep it fast!
4264 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4265 while ((c = *++ptr) != NUL)
4267 if (c == NL)
4268 *s = NUL; /* replace newlines with NULs */
4269 else if (c == CAR && fileformat == EOL_MAC)
4270 *s = NL; /* Mac: replace CRs with NLs */
4271 else
4272 *s = c;
4273 ++s;
4274 if (++len != bufsize)
4275 continue;
4276 if (buf_write_bytes(&write_info) == FAIL)
4278 end = 0; /* write error: break loop */
4279 break;
4281 nchars += bufsize;
4282 s = buffer;
4283 len = 0;
4284 #ifdef FEAT_MBYTE
4285 write_info.bw_start_lnum = lnum;
4286 #endif
4288 /* write failed or last line has no EOL: stop here */
4289 if (end == 0
4290 || (lnum == end
4291 && write_bin
4292 && (lnum == write_no_eol_lnum
4293 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4295 ++lnum; /* written the line, count it */
4296 no_eol = TRUE;
4297 break;
4299 if (fileformat == EOL_UNIX)
4300 *s++ = NL;
4301 else
4303 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4304 if (fileformat == EOL_DOS) /* write CR-NL */
4306 if (++len == bufsize)
4308 if (buf_write_bytes(&write_info) == FAIL)
4310 end = 0; /* write error: break loop */
4311 break;
4313 nchars += bufsize;
4314 s = buffer;
4315 len = 0;
4317 *s++ = NL;
4320 if (++len == bufsize && end)
4322 if (buf_write_bytes(&write_info) == FAIL)
4324 end = 0; /* write error: break loop */
4325 break;
4327 nchars += bufsize;
4328 s = buffer;
4329 len = 0;
4331 ui_breakcheck();
4332 if (got_int)
4334 end = 0; /* Interrupted, break loop */
4335 break;
4338 #ifdef VMS
4340 * On VMS there is a problem: newlines get added when writing blocks
4341 * at a time. Fix it by writing a line at a time.
4342 * This is much slower!
4343 * Explanation: VAX/DECC RTL insists that records in some RMS
4344 * structures end with a newline (carriage return) character, and if
4345 * they don't it adds one.
4346 * With other RMS structures it works perfect without this fix.
4348 if (buf->b_fab_rfm == FAB$C_VFC
4349 || ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0))
4351 int b2write;
4353 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4354 ? MIN(4096, bufsize)
4355 : MIN(buf->b_fab_mrs, bufsize));
4357 b2write = len;
4358 while (b2write > 0)
4360 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4361 if (buf_write_bytes(&write_info) == FAIL)
4363 end = 0;
4364 break;
4366 b2write -= MIN(b2write, buf->b_fab_mrs);
4368 write_info.bw_len = bufsize;
4369 nchars += len;
4370 s = buffer;
4371 len = 0;
4373 #endif
4375 if (len > 0 && end > 0)
4377 write_info.bw_len = len;
4378 if (buf_write_bytes(&write_info) == FAIL)
4379 end = 0; /* write error */
4380 nchars += len;
4383 #if defined(UNIX) && defined(HAVE_FSYNC)
4384 /* On many journalling file systems there is a bug that causes both the
4385 * original and the backup file to be lost when halting the system right
4386 * after writing the file. That's because only the meta-data is
4387 * journalled. Syncing the file slows down the system, but assures it has
4388 * been written to disk and we don't lose it.
4389 * For a device do try the fsync() but don't complain if it does not work
4390 * (could be a pipe).
4391 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4392 if (p_fs && fsync(fd) != 0 && !device)
4394 errmsg = (char_u *)_("E667: Fsync failed");
4395 end = 0;
4397 #endif
4399 #ifdef HAVE_SELINUX
4400 /* Probably need to set the security context. */
4401 if (!backup_copy)
4402 mch_copy_sec(backup, wfname);
4403 #endif
4405 #ifdef UNIX
4406 /* When creating a new file, set its owner/group to that of the original
4407 * file. Get the new device and inode number. */
4408 if (backup != NULL && !backup_copy)
4410 # ifdef HAVE_FCHOWN
4411 struct stat st;
4413 /* don't change the owner when it's already OK, some systems remove
4414 * permission or ACL stuff */
4415 if (mch_stat((char *)wfname, &st) < 0
4416 || st.st_uid != st_old.st_uid
4417 || st.st_gid != st_old.st_gid)
4419 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
4420 if (perm >= 0) /* set permission again, may have changed */
4421 (void)mch_setperm(wfname, perm);
4423 # endif
4424 buf_setino(buf);
4426 else if (!buf->b_dev_valid)
4427 /* Set the inode when creating a new file. */
4428 buf_setino(buf);
4429 #endif
4431 if (close(fd) != 0)
4433 errmsg = (char_u *)_("E512: Close failed");
4434 end = 0;
4437 #ifdef UNIX
4438 if (made_writable)
4439 perm &= ~0200; /* reset 'w' bit for security reasons */
4440 #endif
4441 if (perm >= 0) /* set perm. of new file same as old file */
4442 (void)mch_setperm(wfname, perm);
4443 #ifdef RISCOS
4444 if (!append && !filtering)
4445 /* Set the filetype after writing the file. */
4446 mch_set_filetype(wfname, buf->b_p_oft);
4447 #endif
4448 #ifdef HAVE_ACL
4449 /* Probably need to set the ACL before changing the user (can't set the
4450 * ACL on a file the user doesn't own). */
4451 if (!backup_copy)
4452 mch_set_acl(wfname, acl);
4453 #endif
4456 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4457 if (wfname != fname)
4460 * The file was written to a temp file, now it needs to be converted
4461 * with 'charconvert' to (overwrite) the output file.
4463 if (end != 0)
4465 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4466 wfname, fname) == FAIL)
4468 write_info.bw_conv_error = TRUE;
4469 end = 0;
4472 mch_remove(wfname);
4473 vim_free(wfname);
4475 #endif
4477 if (end == 0)
4479 if (errmsg == NULL)
4481 #ifdef FEAT_MBYTE
4482 if (write_info.bw_conv_error)
4484 if (write_info.bw_conv_error_lnum == 0)
4485 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4486 else
4488 errmsg_allocated = TRUE;
4489 errmsg = alloc(300);
4490 vim_snprintf((char *)errmsg, 300, _("E513: write error, conversion failed in line %ld (make 'fenc' empty to override)"),
4491 (long)write_info.bw_conv_error_lnum);
4494 else
4495 #endif
4496 if (got_int)
4497 errmsg = (char_u *)_(e_interr);
4498 else
4499 errmsg = (char_u *)_("E514: write error (file system full?)");
4503 * If we have a backup file, try to put it in place of the new file,
4504 * because the new file is probably corrupt. This avoids losing the
4505 * original file when trying to make a backup when writing the file a
4506 * second time.
4507 * When "backup_copy" is set we need to copy the backup over the new
4508 * file. Otherwise rename the backup file.
4509 * If this is OK, don't give the extra warning message.
4511 if (backup != NULL)
4513 if (backup_copy)
4515 /* This may take a while, if we were interrupted let the user
4516 * know we got the message. */
4517 if (got_int)
4519 MSG(_(e_interr));
4520 out_flush();
4522 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4524 if ((write_info.bw_fd = mch_open((char *)fname,
4525 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4526 perm & 0777)) >= 0)
4528 /* copy the file. */
4529 write_info.bw_buf = smallbuf;
4530 #ifdef HAS_BW_FLAGS
4531 write_info.bw_flags = FIO_NOCONVERT;
4532 #endif
4533 while ((write_info.bw_len = vim_read(fd, smallbuf,
4534 SMBUFSIZE)) > 0)
4535 if (buf_write_bytes(&write_info) == FAIL)
4536 break;
4538 if (close(write_info.bw_fd) >= 0
4539 && write_info.bw_len == 0)
4540 end = 1; /* success */
4542 close(fd); /* ignore errors for closing read file */
4545 else
4547 if (vim_rename(backup, fname) == 0)
4548 end = 1;
4551 goto fail;
4554 lnum -= start; /* compute number of written lines */
4555 --no_wait_return; /* may wait for return now */
4557 #if !(defined(UNIX) || defined(VMS))
4558 fname = sfname; /* use shortname now, for the messages */
4559 #endif
4560 if (!filtering)
4562 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4563 c = FALSE;
4564 #ifdef FEAT_MBYTE
4565 if (write_info.bw_conv_error)
4567 STRCAT(IObuff, _(" CONVERSION ERROR"));
4568 c = TRUE;
4569 if (write_info.bw_conv_error_lnum != 0)
4571 size_t l = STRLEN(IObuff);
4572 vim_snprintf((char *)IObuff + l, IOSIZE - l, _(" in line %ld;"),
4573 (long)write_info.bw_conv_error_lnum);
4576 else if (notconverted)
4578 STRCAT(IObuff, _("[NOT converted]"));
4579 c = TRUE;
4581 else if (converted)
4583 STRCAT(IObuff, _("[converted]"));
4584 c = TRUE;
4586 #endif
4587 if (device)
4589 STRCAT(IObuff, _("[Device]"));
4590 c = TRUE;
4592 else if (newfile)
4594 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4595 c = TRUE;
4597 if (no_eol)
4599 msg_add_eol();
4600 c = TRUE;
4602 /* may add [unix/dos/mac] */
4603 if (msg_add_fileformat(fileformat))
4604 c = TRUE;
4605 #ifdef FEAT_CRYPT
4606 if (wb_flags & FIO_ENCRYPTED)
4608 STRCAT(IObuff, _("[crypted]"));
4609 c = TRUE;
4611 #endif
4612 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4613 if (!shortmess(SHM_WRITE))
4615 if (append)
4616 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4617 else
4618 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4621 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4624 /* When written everything correctly: reset 'modified'. Unless not
4625 * writing to the original file and '+' is not in 'cpoptions'. */
4626 if (reset_changed && whole && !append
4627 #ifdef FEAT_MBYTE
4628 && !write_info.bw_conv_error
4629 #endif
4630 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4633 unchanged(buf, TRUE);
4634 u_unchanged(buf);
4638 * If written to the current file, update the timestamp of the swap file
4639 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4641 if (overwriting)
4643 ml_timestamp(buf);
4644 if (append)
4645 buf->b_flags &= ~BF_NEW;
4646 else
4647 buf->b_flags &= ~BF_WRITE_MASK;
4651 * If we kept a backup until now, and we are in patch mode, then we make
4652 * the backup file our 'original' file.
4654 if (*p_pm && dobackup)
4656 char *org = (char *)buf_modname(
4657 #ifdef SHORT_FNAME
4658 TRUE,
4659 #else
4660 (buf->b_p_sn || buf->b_shortname),
4661 #endif
4662 fname, p_pm, FALSE);
4664 if (backup != NULL)
4666 struct stat st;
4669 * If the original file does not exist yet
4670 * the current backup file becomes the original file
4672 if (org == NULL)
4673 EMSG(_("E205: Patchmode: can't save original file"));
4674 else if (mch_stat(org, &st) < 0)
4676 vim_rename(backup, (char_u *)org);
4677 vim_free(backup); /* don't delete the file */
4678 backup = NULL;
4679 #ifdef UNIX
4680 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4681 #endif
4685 * If there is no backup file, remember that a (new) file was
4686 * created.
4688 else
4690 int empty_fd;
4692 if (org == NULL
4693 || (empty_fd = mch_open(org,
4694 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4695 perm < 0 ? 0666 : (perm & 0777))) < 0)
4696 EMSG(_("E206: patchmode: can't touch empty original file"));
4697 else
4698 close(empty_fd);
4700 if (org != NULL)
4702 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4703 vim_free(org);
4708 * Remove the backup unless 'backup' option is set
4710 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4711 EMSG(_("E207: Can't delete backup file"));
4713 #ifdef FEAT_SUN_WORKSHOP
4714 if (usingSunWorkShop)
4715 workshop_file_saved((char *) ffname);
4716 #endif
4718 goto nofail;
4721 * Finish up. We get here either after failure or success.
4723 fail:
4724 --no_wait_return; /* may wait for return now */
4725 nofail:
4727 /* Done saving, we accept changed buffer warnings again */
4728 buf->b_saving = FALSE;
4730 vim_free(backup);
4731 if (buffer != smallbuf)
4732 vim_free(buffer);
4733 #ifdef FEAT_MBYTE
4734 vim_free(fenc_tofree);
4735 vim_free(write_info.bw_conv_buf);
4736 # ifdef USE_ICONV
4737 if (write_info.bw_iconv_fd != (iconv_t)-1)
4739 iconv_close(write_info.bw_iconv_fd);
4740 write_info.bw_iconv_fd = (iconv_t)-1;
4742 # endif
4743 #endif
4744 #ifdef HAVE_ACL
4745 mch_free_acl(acl);
4746 #endif
4748 if (errmsg != NULL)
4750 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4752 attr = hl_attr(HLF_E); /* set highlight for error messages */
4753 msg_add_fname(buf,
4754 #ifndef UNIX
4755 sfname
4756 #else
4757 fname
4758 #endif
4759 ); /* put file name in IObuff with quotes */
4760 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4761 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4762 /* If the error message has the form "is ...", put the error number in
4763 * front of the file name. */
4764 if (errnum != NULL)
4766 STRMOVE(IObuff + numlen, IObuff);
4767 mch_memmove(IObuff, errnum, (size_t)numlen);
4769 STRCAT(IObuff, errmsg);
4770 emsg(IObuff);
4771 if (errmsg_allocated)
4772 vim_free(errmsg);
4774 retval = FAIL;
4775 if (end == 0)
4777 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4778 attr | MSG_HIST);
4779 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4780 attr | MSG_HIST);
4782 /* Update the timestamp to avoid an "overwrite changed file"
4783 * prompt when writing again. */
4784 if (mch_stat((char *)fname, &st_old) >= 0)
4786 buf_store_time(buf, &st_old, fname);
4787 buf->b_mtime_read = buf->b_mtime;
4791 msg_scroll = msg_save;
4793 #ifdef FEAT_AUTOCMD
4794 #ifdef FEAT_EVAL
4795 if (!should_abort(retval))
4796 #else
4797 if (!got_int)
4798 #endif
4800 aco_save_T aco;
4802 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4805 * Apply POST autocommands.
4806 * Careful: The autocommands may call buf_write() recursively!
4808 aucmd_prepbuf(&aco, buf);
4810 if (append)
4811 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4812 FALSE, curbuf, eap);
4813 else if (filtering)
4814 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4815 FALSE, curbuf, eap);
4816 else if (reset_changed && whole)
4817 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4818 FALSE, curbuf, eap);
4819 else
4820 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4821 FALSE, curbuf, eap);
4823 /* restore curwin/curbuf and a few other things */
4824 aucmd_restbuf(&aco);
4826 #ifdef FEAT_EVAL
4827 if (aborting()) /* autocmds may abort script processing */
4828 retval = FALSE;
4829 #endif
4831 #endif
4833 got_int |= prev_got_int;
4835 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4836 /* Update machine specific information. */
4837 mch_post_buffer_write(buf);
4838 #endif
4839 return retval;
4843 * Set the name of the current buffer. Use when the buffer doesn't have a
4844 * name and a ":r" or ":w" command with a file name is used.
4846 static int
4847 set_rw_fname(fname, sfname)
4848 char_u *fname;
4849 char_u *sfname;
4851 #ifdef FEAT_AUTOCMD
4852 buf_T *buf = curbuf;
4854 /* It's like the unnamed buffer is deleted.... */
4855 if (curbuf->b_p_bl)
4856 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4857 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4858 # ifdef FEAT_EVAL
4859 if (aborting()) /* autocmds may abort script processing */
4860 return FAIL;
4861 # endif
4862 if (curbuf != buf)
4864 /* We are in another buffer now, don't do the renaming. */
4865 EMSG(_(e_auchangedbuf));
4866 return FAIL;
4868 #endif
4870 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4871 curbuf->b_flags |= BF_NOTEDITED;
4873 #ifdef FEAT_AUTOCMD
4874 /* ....and a new named one is created */
4875 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4876 if (curbuf->b_p_bl)
4877 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4878 # ifdef FEAT_EVAL
4879 if (aborting()) /* autocmds may abort script processing */
4880 return FAIL;
4881 # endif
4883 /* Do filetype detection now if 'filetype' is empty. */
4884 if (*curbuf->b_p_ft == NUL)
4886 if (au_has_group((char_u *)"filetypedetect"))
4887 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4888 do_modelines(0);
4890 #endif
4892 return OK;
4896 * Put file name into IObuff with quotes.
4898 void
4899 msg_add_fname(buf, fname)
4900 buf_T *buf;
4901 char_u *fname;
4903 if (fname == NULL)
4904 fname = (char_u *)"-stdin-";
4905 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4906 IObuff[0] = '"';
4907 STRCAT(IObuff, "\" ");
4911 * Append message for text mode to IObuff.
4912 * Return TRUE if something appended.
4914 static int
4915 msg_add_fileformat(eol_type)
4916 int eol_type;
4918 #ifndef USE_CRNL
4919 if (eol_type == EOL_DOS)
4921 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4922 return TRUE;
4924 #endif
4925 #ifndef USE_CR
4926 if (eol_type == EOL_MAC)
4928 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4929 return TRUE;
4931 #endif
4932 #if defined(USE_CRNL) || defined(USE_CR)
4933 if (eol_type == EOL_UNIX)
4935 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4936 return TRUE;
4938 #endif
4939 return FALSE;
4943 * Append line and character count to IObuff.
4945 void
4946 msg_add_lines(insert_space, lnum, nchars)
4947 int insert_space;
4948 long lnum;
4949 long nchars;
4951 char_u *p;
4953 p = IObuff + STRLEN(IObuff);
4955 if (insert_space)
4956 *p++ = ' ';
4957 if (shortmess(SHM_LINES))
4958 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4959 else
4961 if (lnum == 1)
4962 STRCPY(p, _("1 line, "));
4963 else
4964 sprintf((char *)p, _("%ld lines, "), lnum);
4965 p += STRLEN(p);
4966 if (nchars == 1)
4967 STRCPY(p, _("1 character"));
4968 else
4969 sprintf((char *)p, _("%ld characters"), nchars);
4974 * Append message for missing line separator to IObuff.
4976 static void
4977 msg_add_eol()
4979 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4983 * Check modification time of file, before writing to it.
4984 * The size isn't checked, because using a tool like "gzip" takes care of
4985 * using the same timestamp but can't set the size.
4987 static int
4988 check_mtime(buf, st)
4989 buf_T *buf;
4990 struct stat *st;
4992 if (buf->b_mtime_read != 0
4993 && time_differs((long)st->st_mtime, buf->b_mtime_read))
4995 msg_scroll = TRUE; /* don't overwrite messages here */
4996 msg_silent = 0; /* must give this prompt */
4997 /* don't use emsg() here, don't want to flush the buffers */
4998 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4999 hl_attr(HLF_E));
5000 if (ask_yesno((char_u *)_("Do you really want to write to it"),
5001 TRUE) == 'n')
5002 return FAIL;
5003 msg_scroll = FALSE; /* always overwrite the file message now */
5005 return OK;
5008 static int
5009 time_differs(t1, t2)
5010 long t1, t2;
5012 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
5013 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
5014 * the seconds. Since the roundoff is done when flushing the inode, the
5015 * time may change unexpectedly by one second!!! */
5016 return (t1 - t2 > 1 || t2 - t1 > 1);
5017 #else
5018 return (t1 != t2);
5019 #endif
5023 * Call write() to write a number of bytes to the file.
5024 * Also handles encryption and 'encoding' conversion.
5026 * Return FAIL for failure, OK otherwise.
5028 static int
5029 buf_write_bytes(ip)
5030 struct bw_info *ip;
5032 int wlen;
5033 char_u *buf = ip->bw_buf; /* data to write */
5034 int len = ip->bw_len; /* length of data */
5035 #ifdef HAS_BW_FLAGS
5036 int flags = ip->bw_flags; /* extra flags */
5037 #endif
5039 #ifdef FEAT_MBYTE
5041 * Skip conversion when writing the crypt magic number or the BOM.
5043 if (!(flags & FIO_NOCONVERT))
5045 char_u *p;
5046 unsigned c;
5047 int n;
5049 if (flags & FIO_UTF8)
5052 * Convert latin1 in the buffer to UTF-8 in the file.
5054 p = ip->bw_conv_buf; /* translate to buffer */
5055 for (wlen = 0; wlen < len; ++wlen)
5056 p += utf_char2bytes(buf[wlen], p);
5057 buf = ip->bw_conv_buf;
5058 len = (int)(p - ip->bw_conv_buf);
5060 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
5063 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
5064 * Latin1 chars in the file.
5066 if (flags & FIO_LATIN1)
5067 p = buf; /* translate in-place (can only get shorter) */
5068 else
5069 p = ip->bw_conv_buf; /* translate to buffer */
5070 for (wlen = 0; wlen < len; wlen += n)
5072 if (wlen == 0 && ip->bw_restlen != 0)
5074 int l;
5076 /* Use remainder of previous call. Append the start of
5077 * buf[] to get a full sequence. Might still be too
5078 * short! */
5079 l = CONV_RESTLEN - ip->bw_restlen;
5080 if (l > len)
5081 l = len;
5082 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
5083 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
5084 if (n > ip->bw_restlen + len)
5086 /* We have an incomplete byte sequence at the end to
5087 * be written. We can't convert it without the
5088 * remaining bytes. Keep them for the next call. */
5089 if (ip->bw_restlen + len > CONV_RESTLEN)
5090 return FAIL;
5091 ip->bw_restlen += len;
5092 break;
5094 if (n > 1)
5095 c = utf_ptr2char(ip->bw_rest);
5096 else
5097 c = ip->bw_rest[0];
5098 if (n >= ip->bw_restlen)
5100 n -= ip->bw_restlen;
5101 ip->bw_restlen = 0;
5103 else
5105 ip->bw_restlen -= n;
5106 mch_memmove(ip->bw_rest, ip->bw_rest + n,
5107 (size_t)ip->bw_restlen);
5108 n = 0;
5111 else
5113 n = utf_ptr2len_len(buf + wlen, len - wlen);
5114 if (n > len - wlen)
5116 /* We have an incomplete byte sequence at the end to
5117 * be written. We can't convert it without the
5118 * remaining bytes. Keep them for the next call. */
5119 if (len - wlen > CONV_RESTLEN)
5120 return FAIL;
5121 ip->bw_restlen = len - wlen;
5122 mch_memmove(ip->bw_rest, buf + wlen,
5123 (size_t)ip->bw_restlen);
5124 break;
5126 if (n > 1)
5127 c = utf_ptr2char(buf + wlen);
5128 else
5129 c = buf[wlen];
5132 if (ucs2bytes(c, &p, flags) && !ip->bw_conv_error)
5134 ip->bw_conv_error = TRUE;
5135 ip->bw_conv_error_lnum = ip->bw_start_lnum;
5137 if (c == NL)
5138 ++ip->bw_start_lnum;
5140 if (flags & FIO_LATIN1)
5141 len = (int)(p - buf);
5142 else
5144 buf = ip->bw_conv_buf;
5145 len = (int)(p - ip->bw_conv_buf);
5149 # ifdef WIN3264
5150 else if (flags & FIO_CODEPAGE)
5153 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5154 * codepage.
5156 char_u *from;
5157 size_t fromlen;
5158 char_u *to;
5159 int u8c;
5160 BOOL bad = FALSE;
5161 int needed;
5163 if (ip->bw_restlen > 0)
5165 /* Need to concatenate the remainder of the previous call and
5166 * the bytes of the current call. Use the end of the
5167 * conversion buffer for this. */
5168 fromlen = len + ip->bw_restlen;
5169 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5170 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5171 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5173 else
5175 from = buf;
5176 fromlen = len;
5179 to = ip->bw_conv_buf;
5180 if (enc_utf8)
5182 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5183 * The buffer has been allocated to be big enough. */
5184 while (fromlen > 0)
5186 n = (int)utf_ptr2len_len(from, (int)fromlen);
5187 if (n > (int)fromlen) /* incomplete byte sequence */
5188 break;
5189 u8c = utf_ptr2char(from);
5190 *to++ = (u8c & 0xff);
5191 *to++ = (u8c >> 8);
5192 fromlen -= n;
5193 from += n;
5196 /* Copy remainder to ip->bw_rest[] to be used for the next
5197 * call. */
5198 if (fromlen > CONV_RESTLEN)
5200 /* weird overlong sequence */
5201 ip->bw_conv_error = TRUE;
5202 return FAIL;
5204 mch_memmove(ip->bw_rest, from, fromlen);
5205 ip->bw_restlen = (int)fromlen;
5207 else
5209 /* Convert from enc_codepage to UCS-2, to the start of the
5210 * buffer. The buffer has been allocated to be big enough. */
5211 ip->bw_restlen = 0;
5212 needed = MultiByteToWideChar(enc_codepage,
5213 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5214 NULL, 0);
5215 if (needed == 0)
5217 /* When conversion fails there may be a trailing byte. */
5218 needed = MultiByteToWideChar(enc_codepage,
5219 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5220 NULL, 0);
5221 if (needed == 0)
5223 /* Conversion doesn't work. */
5224 ip->bw_conv_error = TRUE;
5225 return FAIL;
5227 /* Save the trailing byte for the next call. */
5228 ip->bw_rest[0] = from[fromlen - 1];
5229 ip->bw_restlen = 1;
5231 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5232 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5233 (LPWSTR)to, needed);
5234 if (needed == 0)
5236 /* Safety check: Conversion doesn't work. */
5237 ip->bw_conv_error = TRUE;
5238 return FAIL;
5240 to += needed * 2;
5243 fromlen = to - ip->bw_conv_buf;
5244 buf = to;
5245 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5246 if (FIO_GET_CP(flags) == CP_UTF8)
5248 /* Convert from UCS-2 to UTF-8, using the remainder of the
5249 * conversion buffer. Fails when out of space. */
5250 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5252 u8c = *from++;
5253 u8c += (*from++ << 8);
5254 to += utf_char2bytes(u8c, to);
5255 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5257 ip->bw_conv_error = TRUE;
5258 return FAIL;
5261 len = (int)(to - buf);
5263 else
5264 #endif
5266 /* Convert from UCS-2 to the codepage, using the remainder of
5267 * the conversion buffer. If the conversion uses the default
5268 * character "0", the data doesn't fit in this encoding, so
5269 * fail. */
5270 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5271 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5272 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0,
5273 &bad);
5274 if (bad)
5276 ip->bw_conv_error = TRUE;
5277 return FAIL;
5281 # endif
5283 # ifdef MACOS_CONVERT
5284 else if (flags & FIO_MACROMAN)
5287 * Convert UTF-8 or latin1 to Apple MacRoman.
5289 char_u *from;
5290 size_t fromlen;
5292 if (ip->bw_restlen > 0)
5294 /* Need to concatenate the remainder of the previous call and
5295 * the bytes of the current call. Use the end of the
5296 * conversion buffer for this. */
5297 fromlen = len + ip->bw_restlen;
5298 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5299 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5300 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5302 else
5304 from = buf;
5305 fromlen = len;
5308 if (enc2macroman(from, fromlen,
5309 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5310 ip->bw_rest, &ip->bw_restlen) == FAIL)
5312 ip->bw_conv_error = TRUE;
5313 return FAIL;
5315 buf = ip->bw_conv_buf;
5317 # endif
5319 # ifdef USE_ICONV
5320 if (ip->bw_iconv_fd != (iconv_t)-1)
5322 const char *from;
5323 size_t fromlen;
5324 char *to;
5325 size_t tolen;
5327 /* Convert with iconv(). */
5328 if (ip->bw_restlen > 0)
5330 char *fp;
5332 /* Need to concatenate the remainder of the previous call and
5333 * the bytes of the current call. Use the end of the
5334 * conversion buffer for this. */
5335 fromlen = len + ip->bw_restlen;
5336 fp = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5337 mch_memmove(fp, ip->bw_rest, (size_t)ip->bw_restlen);
5338 mch_memmove(fp + ip->bw_restlen, buf, (size_t)len);
5339 from = fp;
5340 tolen = ip->bw_conv_buflen - fromlen;
5342 else
5344 from = (const char *)buf;
5345 fromlen = len;
5346 tolen = ip->bw_conv_buflen;
5348 to = (char *)ip->bw_conv_buf;
5350 if (ip->bw_first)
5352 size_t save_len = tolen;
5354 /* output the initial shift state sequence */
5355 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5357 /* There is a bug in iconv() on Linux (which appears to be
5358 * wide-spread) which sets "to" to NULL and messes up "tolen".
5360 if (to == NULL)
5362 to = (char *)ip->bw_conv_buf;
5363 tolen = save_len;
5365 ip->bw_first = FALSE;
5369 * If iconv() has an error or there is not enough room, fail.
5371 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5372 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5373 || fromlen > CONV_RESTLEN)
5375 ip->bw_conv_error = TRUE;
5376 return FAIL;
5379 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5380 if (fromlen > 0)
5381 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5382 ip->bw_restlen = (int)fromlen;
5384 buf = ip->bw_conv_buf;
5385 len = (int)((char_u *)to - ip->bw_conv_buf);
5387 # endif
5389 #endif /* FEAT_MBYTE */
5391 #ifdef FEAT_CRYPT
5392 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5394 int ztemp, t, i;
5396 for (i = 0; i < len; i++)
5398 ztemp = buf[i];
5399 buf[i] = ZENCODE(ztemp, t);
5402 #endif
5404 /* Repeat the write(), it may be interrupted by a signal. */
5405 while (len > 0)
5407 wlen = vim_write(ip->bw_fd, buf, len);
5408 if (wlen <= 0) /* error! */
5409 return FAIL;
5410 len -= wlen;
5411 buf += wlen;
5413 return OK;
5416 #ifdef FEAT_MBYTE
5418 * Convert a Unicode character to bytes.
5419 * Return TRUE for an error, FALSE when it's OK.
5421 static int
5422 ucs2bytes(c, pp, flags)
5423 unsigned c; /* in: character */
5424 char_u **pp; /* in/out: pointer to result */
5425 int flags; /* FIO_ flags */
5427 char_u *p = *pp;
5428 int error = FALSE;
5429 int cc;
5432 if (flags & FIO_UCS4)
5434 if (flags & FIO_ENDIAN_L)
5436 *p++ = c;
5437 *p++ = (c >> 8);
5438 *p++ = (c >> 16);
5439 *p++ = (c >> 24);
5441 else
5443 *p++ = (c >> 24);
5444 *p++ = (c >> 16);
5445 *p++ = (c >> 8);
5446 *p++ = c;
5449 else if (flags & (FIO_UCS2 | FIO_UTF16))
5451 if (c >= 0x10000)
5453 if (flags & FIO_UTF16)
5455 /* Make two words, ten bits of the character in each. First
5456 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5457 c -= 0x10000;
5458 if (c >= 0x100000)
5459 error = TRUE;
5460 cc = ((c >> 10) & 0x3ff) + 0xd800;
5461 if (flags & FIO_ENDIAN_L)
5463 *p++ = cc;
5464 *p++ = ((unsigned)cc >> 8);
5466 else
5468 *p++ = ((unsigned)cc >> 8);
5469 *p++ = cc;
5471 c = (c & 0x3ff) + 0xdc00;
5473 else
5474 error = TRUE;
5476 if (flags & FIO_ENDIAN_L)
5478 *p++ = c;
5479 *p++ = (c >> 8);
5481 else
5483 *p++ = (c >> 8);
5484 *p++ = c;
5487 else /* Latin1 */
5489 if (c >= 0x100)
5491 error = TRUE;
5492 *p++ = 0xBF;
5494 else
5495 *p++ = c;
5498 *pp = p;
5499 return error;
5503 * Return TRUE if file encoding "fenc" requires conversion from or to
5504 * 'encoding'.
5506 static int
5507 need_conversion(fenc)
5508 char_u *fenc;
5510 int same_encoding;
5511 int enc_flags;
5512 int fenc_flags;
5514 if (*fenc == NUL || STRCMP(p_enc, fenc) == 0)
5515 same_encoding = TRUE;
5516 else
5518 /* Ignore difference between "ansi" and "latin1", "ucs-4" and
5519 * "ucs-4be", etc. */
5520 enc_flags = get_fio_flags(p_enc);
5521 fenc_flags = get_fio_flags(fenc);
5522 same_encoding = (enc_flags != 0 && fenc_flags == enc_flags);
5524 if (same_encoding)
5526 /* Specified encoding matches with 'encoding'. This requires
5527 * conversion when 'encoding' is Unicode but not UTF-8. */
5528 return enc_unicode != 0;
5531 /* Encodings differ. However, conversion is not needed when 'enc' is any
5532 * Unicode encoding and the file is UTF-8. */
5533 return !(enc_utf8 && fenc_flags == FIO_UTF8);
5537 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5538 * internal conversion.
5539 * if "ptr" is an empty string, use 'encoding'.
5541 static int
5542 get_fio_flags(ptr)
5543 char_u *ptr;
5545 int prop;
5547 if (*ptr == NUL)
5548 ptr = p_enc;
5550 prop = enc_canon_props(ptr);
5551 if (prop & ENC_UNICODE)
5553 if (prop & ENC_2BYTE)
5555 if (prop & ENC_ENDIAN_L)
5556 return FIO_UCS2 | FIO_ENDIAN_L;
5557 return FIO_UCS2;
5559 if (prop & ENC_4BYTE)
5561 if (prop & ENC_ENDIAN_L)
5562 return FIO_UCS4 | FIO_ENDIAN_L;
5563 return FIO_UCS4;
5565 if (prop & ENC_2WORD)
5567 if (prop & ENC_ENDIAN_L)
5568 return FIO_UTF16 | FIO_ENDIAN_L;
5569 return FIO_UTF16;
5571 return FIO_UTF8;
5573 if (prop & ENC_LATIN1)
5574 return FIO_LATIN1;
5575 /* must be ENC_DBCS, requires iconv() */
5576 return 0;
5579 #ifdef WIN3264
5581 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5582 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5583 * Used for conversion between 'encoding' and 'fileencoding'.
5585 static int
5586 get_win_fio_flags(ptr)
5587 char_u *ptr;
5589 int cp;
5591 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5592 if (!enc_utf8 && enc_codepage <= 0)
5593 return 0;
5595 cp = encname2codepage(ptr);
5596 if (cp == 0)
5598 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5599 if (STRCMP(ptr, "utf-8") == 0)
5600 cp = CP_UTF8;
5601 else
5602 # endif
5603 return 0;
5605 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5607 #endif
5609 #ifdef MACOS_X
5611 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5612 * needed for the internal conversion to/from utf-8 or latin1.
5614 static int
5615 get_mac_fio_flags(ptr)
5616 char_u *ptr;
5618 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5619 && (enc_canon_props(ptr) & ENC_MACROMAN))
5620 return FIO_MACROMAN;
5621 return 0;
5623 #endif
5626 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5627 * "size" must be at least 2.
5628 * Return the name of the encoding and set "*lenp" to the length.
5629 * Returns NULL when no BOM found.
5631 static char_u *
5632 check_for_bom(p, size, lenp, flags)
5633 char_u *p;
5634 long size;
5635 int *lenp;
5636 int flags;
5638 char *name = NULL;
5639 int len = 2;
5641 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5642 && (flags == FIO_ALL || flags == FIO_UTF8 || flags == 0))
5644 name = "utf-8"; /* EF BB BF */
5645 len = 3;
5647 else if (p[0] == 0xff && p[1] == 0xfe)
5649 if (size >= 4 && p[2] == 0 && p[3] == 0
5650 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5652 name = "ucs-4le"; /* FF FE 00 00 */
5653 len = 4;
5655 else if (flags == (FIO_UCS2 | FIO_ENDIAN_L))
5656 name = "ucs-2le"; /* FF FE */
5657 else if (flags == FIO_ALL || flags == (FIO_UTF16 | FIO_ENDIAN_L))
5658 /* utf-16le is preferred, it also works for ucs-2le text */
5659 name = "utf-16le"; /* FF FE */
5661 else if (p[0] == 0xfe && p[1] == 0xff
5662 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5664 /* Default to utf-16, it works also for ucs-2 text. */
5665 if (flags == FIO_UCS2)
5666 name = "ucs-2"; /* FE FF */
5667 else
5668 name = "utf-16"; /* FE FF */
5670 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5671 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5673 name = "ucs-4"; /* 00 00 FE FF */
5674 len = 4;
5677 *lenp = len;
5678 return (char_u *)name;
5682 * Generate a BOM in "buf[4]" for encoding "name".
5683 * Return the length of the BOM (zero when no BOM).
5685 static int
5686 make_bom(buf, name)
5687 char_u *buf;
5688 char_u *name;
5690 int flags;
5691 char_u *p;
5693 flags = get_fio_flags(name);
5695 /* Can't put a BOM in a non-Unicode file. */
5696 if (flags == FIO_LATIN1 || flags == 0)
5697 return 0;
5699 if (flags == FIO_UTF8) /* UTF-8 */
5701 buf[0] = 0xef;
5702 buf[1] = 0xbb;
5703 buf[2] = 0xbf;
5704 return 3;
5706 p = buf;
5707 (void)ucs2bytes(0xfeff, &p, flags);
5708 return (int)(p - buf);
5710 #endif
5712 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5713 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5715 * Try to find a shortname by comparing the fullname with the current
5716 * directory.
5717 * Returns "full_path" or pointer into "full_path" if shortened.
5719 char_u *
5720 shorten_fname1(full_path)
5721 char_u *full_path;
5723 char_u dirname[MAXPATHL];
5724 char_u *p = full_path;
5726 if (mch_dirname(dirname, MAXPATHL) == OK)
5728 p = shorten_fname(full_path, dirname);
5729 if (p == NULL || *p == NUL)
5730 p = full_path;
5732 return p;
5734 #endif
5737 * Try to find a shortname by comparing the fullname with the current
5738 * directory.
5739 * Returns NULL if not shorter name possible, pointer into "full_path"
5740 * otherwise.
5742 char_u *
5743 shorten_fname(full_path, dir_name)
5744 char_u *full_path;
5745 char_u *dir_name;
5747 int len;
5748 char_u *p;
5750 if (full_path == NULL)
5751 return NULL;
5752 len = (int)STRLEN(dir_name);
5753 if (fnamencmp(dir_name, full_path, len) == 0)
5755 p = full_path + len;
5756 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5758 * MSDOS: when a file is in the root directory, dir_name will end in a
5759 * slash, since C: by itself does not define a specific dir. In this
5760 * case p may already be correct. <negri>
5762 if (!((len > 2) && (*(p - 2) == ':')))
5763 #endif
5765 if (vim_ispathsep(*p))
5766 ++p;
5767 #ifndef VMS /* the path separator is always part of the path */
5768 else
5769 p = NULL;
5770 #endif
5773 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5775 * When using a file in the current drive, remove the drive name:
5776 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5777 * a floppy from "A:\dir" to "B:\dir".
5779 else if (len > 3
5780 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5781 && full_path[1] == ':'
5782 && vim_ispathsep(full_path[2]))
5783 p = full_path + 2;
5784 #endif
5785 else
5786 p = NULL;
5787 return p;
5791 * Shorten filenames for all buffers.
5792 * When "force" is TRUE: Use full path from now on for files currently being
5793 * edited, both for file name and swap file name. Try to shorten the file
5794 * names a bit, if safe to do so.
5795 * When "force" is FALSE: Only try to shorten absolute file names.
5796 * For buffers that have buftype "nofile" or "scratch": never change the file
5797 * name.
5799 void
5800 shorten_fnames(force)
5801 int force;
5803 char_u dirname[MAXPATHL];
5804 buf_T *buf;
5805 char_u *p;
5807 mch_dirname(dirname, MAXPATHL);
5808 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5810 if (buf->b_fname != NULL
5811 #ifdef FEAT_QUICKFIX
5812 && !bt_nofile(buf)
5813 #endif
5814 && !path_with_url(buf->b_fname)
5815 && (force
5816 || buf->b_sfname == NULL
5817 || mch_isFullName(buf->b_sfname)))
5819 vim_free(buf->b_sfname);
5820 buf->b_sfname = NULL;
5821 p = shorten_fname(buf->b_ffname, dirname);
5822 if (p != NULL)
5824 buf->b_sfname = vim_strsave(p);
5825 buf->b_fname = buf->b_sfname;
5827 if (p == NULL || buf->b_fname == NULL)
5828 buf->b_fname = buf->b_ffname;
5831 /* Always make the swap file name a full path, a "nofile" buffer may
5832 * also have a swap file. */
5833 mf_fullname(buf->b_ml.ml_mfp);
5835 #ifdef FEAT_WINDOWS
5836 status_redraw_all();
5837 redraw_tabline = TRUE;
5838 #endif
5841 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5842 || defined(FEAT_GUI_MSWIN) \
5843 || defined(FEAT_GUI_MAC) \
5844 || defined(PROTO)
5846 * Shorten all filenames in "fnames[count]" by current directory.
5848 void
5849 shorten_filenames(fnames, count)
5850 char_u **fnames;
5851 int count;
5853 int i;
5854 char_u dirname[MAXPATHL];
5855 char_u *p;
5857 if (fnames == NULL || count < 1)
5858 return;
5859 mch_dirname(dirname, sizeof(dirname));
5860 for (i = 0; i < count; ++i)
5862 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5864 /* shorten_fname() returns pointer in given "fnames[i]". If free
5865 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5866 * "p" first then free fnames[i]. */
5867 p = vim_strsave(p);
5868 vim_free(fnames[i]);
5869 fnames[i] = p;
5873 #endif
5876 * add extension to file name - change path/fo.o.h to path/fo.o.h.ext or
5877 * fo_o_h.ext for MSDOS or when shortname option set.
5879 * Assumed that fname is a valid name found in the filesystem we assure that
5880 * the return value is a different name and ends in 'ext'.
5881 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5882 * characters otherwise.
5883 * Space for the returned name is allocated, must be freed later.
5884 * Returns NULL when out of memory.
5886 char_u *
5887 modname(fname, ext, prepend_dot)
5888 char_u *fname, *ext;
5889 int prepend_dot; /* may prepend a '.' to file name */
5891 return buf_modname(
5892 #ifdef SHORT_FNAME
5893 TRUE,
5894 #else
5895 (curbuf->b_p_sn || curbuf->b_shortname),
5896 #endif
5897 fname, ext, prepend_dot);
5900 char_u *
5901 buf_modname(shortname, fname, ext, prepend_dot)
5902 int shortname; /* use 8.3 file name */
5903 char_u *fname, *ext;
5904 int prepend_dot; /* may prepend a '.' to file name */
5906 char_u *retval;
5907 char_u *s;
5908 char_u *e;
5909 char_u *ptr;
5910 int fnamelen, extlen;
5912 extlen = (int)STRLEN(ext);
5915 * If there is no file name we must get the name of the current directory
5916 * (we need the full path in case :cd is used).
5918 if (fname == NULL || *fname == NUL)
5920 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5921 if (retval == NULL)
5922 return NULL;
5923 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5924 (fnamelen = (int)STRLEN(retval)) == 0)
5926 vim_free(retval);
5927 return NULL;
5929 if (!after_pathsep(retval, retval + fnamelen))
5931 retval[fnamelen++] = PATHSEP;
5932 retval[fnamelen] = NUL;
5934 #ifndef SHORT_FNAME
5935 prepend_dot = FALSE; /* nothing to prepend a dot to */
5936 #endif
5938 else
5940 fnamelen = (int)STRLEN(fname);
5941 retval = alloc((unsigned)(fnamelen + extlen + 3));
5942 if (retval == NULL)
5943 return NULL;
5944 STRCPY(retval, fname);
5945 #ifdef VMS
5946 vms_remove_version(retval); /* we do not need versions here */
5947 #endif
5951 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5952 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5953 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5954 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5956 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5958 #ifndef RISCOS
5959 if (*ext == '.'
5960 # ifdef USE_LONG_FNAME
5961 && (!USE_LONG_FNAME || shortname)
5962 # else
5963 # ifndef SHORT_FNAME
5964 && shortname
5965 # endif
5966 # endif
5968 if (*ptr == '.') /* replace '.' by '_' */
5969 *ptr = '_';
5970 #endif
5971 if (vim_ispathsep(*ptr))
5973 ++ptr;
5974 break;
5978 /* the file name has at most BASENAMELEN characters. */
5979 #ifndef SHORT_FNAME
5980 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5981 ptr[BASENAMELEN] = '\0';
5982 #endif
5984 s = ptr + STRLEN(ptr);
5987 * For 8.3 file names we may have to reduce the length.
5989 #ifdef USE_LONG_FNAME
5990 if (!USE_LONG_FNAME || shortname)
5991 #else
5992 # ifndef SHORT_FNAME
5993 if (shortname)
5994 # endif
5995 #endif
5998 * If there is no file name, or the file name ends in '/', and the
5999 * extension starts with '.', put a '_' before the dot, because just
6000 * ".ext" is invalid.
6002 if (fname == NULL || *fname == NUL
6003 || vim_ispathsep(fname[STRLEN(fname) - 1]))
6005 #ifdef RISCOS
6006 if (*ext == '/')
6007 #else
6008 if (*ext == '.')
6009 #endif
6010 *s++ = '_';
6013 * If the extension starts with '.', truncate the base name at 8
6014 * characters
6016 #ifdef RISCOS
6017 /* We normally use '/', but swap files are '_' */
6018 else if (*ext == '/' || *ext == '_')
6019 #else
6020 else if (*ext == '.')
6021 #endif
6023 if ((size_t)(s - ptr) > (size_t)8)
6025 s = ptr + 8;
6026 *s = '\0';
6030 * If the extension doesn't start with '.', and the file name
6031 * doesn't have an extension yet, append a '.'
6033 #ifdef RISCOS
6034 else if ((e = vim_strchr(ptr, '/')) == NULL)
6035 *s++ = '/';
6036 #else
6037 else if ((e = vim_strchr(ptr, '.')) == NULL)
6038 *s++ = '.';
6039 #endif
6041 * If the extension doesn't start with '.', and there already is an
6042 * extension, it may need to be truncated
6044 else if ((int)STRLEN(e) + extlen > 4)
6045 s = e + 4 - extlen;
6047 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
6049 * If there is no file name, and the extension starts with '.', put a
6050 * '_' before the dot, because just ".ext" may be invalid if it's on a
6051 * FAT partition, and on HPFS it doesn't matter.
6053 else if ((fname == NULL || *fname == NUL) && *ext == '.')
6054 *s++ = '_';
6055 #endif
6058 * Append the extension.
6059 * ext can start with '.' and cannot exceed 3 more characters.
6061 STRCPY(s, ext);
6063 #ifndef SHORT_FNAME
6065 * Prepend the dot.
6067 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
6068 #ifdef RISCOS
6070 #else
6072 #endif
6073 #ifdef USE_LONG_FNAME
6074 && USE_LONG_FNAME
6075 #endif
6078 STRMOVE(e + 1, e);
6079 #ifdef RISCOS
6080 *e = '/';
6081 #else
6082 *e = '.';
6083 #endif
6085 #endif
6088 * Check that, after appending the extension, the file name is really
6089 * different.
6091 if (fname != NULL && STRCMP(fname, retval) == 0)
6093 /* we search for a character that can be replaced by '_' */
6094 while (--s >= ptr)
6096 if (*s != '_')
6098 *s = '_';
6099 break;
6102 if (s < ptr) /* fname was "________.<ext>", how tricky! */
6103 *ptr = 'v';
6105 return retval;
6109 * Like fgets(), but if the file line is too long, it is truncated and the
6110 * rest of the line is thrown away. Returns TRUE for end-of-file.
6113 vim_fgets(buf, size, fp)
6114 char_u *buf;
6115 int size;
6116 FILE *fp;
6118 char *eof;
6119 #define FGETS_SIZE 200
6120 char tbuf[FGETS_SIZE];
6122 buf[size - 2] = NUL;
6123 #ifdef USE_CR
6124 eof = fgets_cr((char *)buf, size, fp);
6125 #else
6126 eof = fgets((char *)buf, size, fp);
6127 #endif
6128 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
6130 buf[size - 1] = NUL; /* Truncate the line */
6132 /* Now throw away the rest of the line: */
6135 tbuf[FGETS_SIZE - 2] = NUL;
6136 #ifdef USE_CR
6137 ignoredp = fgets_cr((char *)tbuf, FGETS_SIZE, fp);
6138 #else
6139 ignoredp = fgets((char *)tbuf, FGETS_SIZE, fp);
6140 #endif
6141 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
6143 return (eof == NULL);
6146 #if defined(USE_CR) || defined(PROTO)
6148 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6149 * Returns TRUE for end-of-file.
6150 * Only used for the Mac, because it's much slower than vim_fgets().
6153 tag_fgets(buf, size, fp)
6154 char_u *buf;
6155 int size;
6156 FILE *fp;
6158 int i = 0;
6159 int c;
6160 int eof = FALSE;
6162 for (;;)
6164 c = fgetc(fp);
6165 if (c == EOF)
6167 eof = TRUE;
6168 break;
6170 if (c == '\r')
6172 /* Always store a NL for end-of-line. */
6173 if (i < size - 1)
6174 buf[i++] = '\n';
6175 c = fgetc(fp);
6176 if (c != '\n') /* Macintosh format: single CR. */
6177 ungetc(c, fp);
6178 break;
6180 if (i < size - 1)
6181 buf[i++] = c;
6182 if (c == '\n')
6183 break;
6185 buf[i] = NUL;
6186 return eof;
6188 #endif
6191 * rename() only works if both files are on the same file system, this
6192 * function will (attempts to?) copy the file across if rename fails -- webb
6193 * Return -1 for failure, 0 for success.
6196 vim_rename(from, to)
6197 char_u *from;
6198 char_u *to;
6200 int fd_in;
6201 int fd_out;
6202 int n;
6203 char *errmsg = NULL;
6204 char *buffer;
6205 #ifdef AMIGA
6206 BPTR flock;
6207 #endif
6208 struct stat st;
6209 long perm;
6210 #ifdef HAVE_ACL
6211 vim_acl_T acl; /* ACL from original file */
6212 #endif
6213 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6214 int use_tmp_file = FALSE;
6215 #endif
6218 * When the names are identical, there is nothing to do. When they refer
6219 * to the same file (ignoring case and slash/backslash differences) but
6220 * the file name differs we need to go through a temp file.
6222 if (fnamecmp(from, to) == 0)
6224 #ifdef CASE_INSENSITIVE_FILENAME
6225 if (STRCMP(gettail(from), gettail(to)) != 0)
6226 use_tmp_file = TRUE;
6227 else
6228 #endif
6229 return 0;
6233 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6235 if (mch_stat((char *)from, &st) < 0)
6236 return -1;
6238 #ifdef UNIX
6240 struct stat st_to;
6242 /* It's possible for the source and destination to be the same file.
6243 * This happens when "from" and "to" differ in case and are on a FAT32
6244 * filesystem. In that case go through a temp file name. */
6245 if (mch_stat((char *)to, &st_to) >= 0
6246 && st.st_dev == st_to.st_dev
6247 && st.st_ino == st_to.st_ino)
6248 use_tmp_file = TRUE;
6250 #endif
6252 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6253 if (use_tmp_file)
6255 char tempname[MAXPATHL + 1];
6258 * Find a name that doesn't exist and is in the same directory.
6259 * Rename "from" to "tempname" and then rename "tempname" to "to".
6261 if (STRLEN(from) >= MAXPATHL - 5)
6262 return -1;
6263 STRCPY(tempname, from);
6264 for (n = 123; n < 99999; ++n)
6266 sprintf((char *)gettail((char_u *)tempname), "%d", n);
6267 if (mch_stat(tempname, &st) < 0)
6269 if (mch_rename((char *)from, tempname) == 0)
6271 if (mch_rename(tempname, (char *)to) == 0)
6272 return 0;
6273 /* Strange, the second step failed. Try moving the
6274 * file back and return failure. */
6275 mch_rename(tempname, (char *)from);
6276 return -1;
6278 /* If it fails for one temp name it will most likely fail
6279 * for any temp name, give up. */
6280 return -1;
6283 return -1;
6285 #endif
6288 * Delete the "to" file, this is required on some systems to make the
6289 * mch_rename() work, on other systems it makes sure that we don't have
6290 * two files when the mch_rename() fails.
6293 #ifdef AMIGA
6295 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6296 * that the name of the "to" file is the same as the "from" file, even
6297 * though the names are different. To avoid the chance of accidentally
6298 * deleting the "from" file (horror!) we lock it during the remove.
6300 * When used for making a backup before writing the file: This should not
6301 * happen with ":w", because startscript() should detect this problem and
6302 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6303 * name. This problem does exist with ":w filename", but then the
6304 * original file will be somewhere else so the backup isn't really
6305 * important. If autoscripting is off the rename may fail.
6307 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6308 #endif
6309 mch_remove(to);
6310 #ifdef AMIGA
6311 if (flock)
6312 UnLock(flock);
6313 #endif
6316 * First try a normal rename, return if it works.
6318 if (mch_rename((char *)from, (char *)to) == 0)
6319 return 0;
6322 * Rename() failed, try copying the file.
6324 perm = mch_getperm(from);
6325 #ifdef HAVE_ACL
6326 /* For systems that support ACL: get the ACL from the original file. */
6327 acl = mch_get_acl(from);
6328 #endif
6329 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6330 if (fd_in == -1)
6332 #ifdef HAVE_ACL
6333 mch_free_acl(acl);
6334 #endif
6335 return -1;
6338 /* Create the new file with same permissions as the original. */
6339 fd_out = mch_open((char *)to,
6340 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6341 if (fd_out == -1)
6343 close(fd_in);
6344 #ifdef HAVE_ACL
6345 mch_free_acl(acl);
6346 #endif
6347 return -1;
6350 buffer = (char *)alloc(BUFSIZE);
6351 if (buffer == NULL)
6353 close(fd_out);
6354 close(fd_in);
6355 #ifdef HAVE_ACL
6356 mch_free_acl(acl);
6357 #endif
6358 return -1;
6361 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6362 if (vim_write(fd_out, buffer, n) != n)
6364 errmsg = _("E208: Error writing to \"%s\"");
6365 break;
6368 vim_free(buffer);
6369 close(fd_in);
6370 if (close(fd_out) < 0)
6371 errmsg = _("E209: Error closing \"%s\"");
6372 if (n < 0)
6374 errmsg = _("E210: Error reading \"%s\"");
6375 to = from;
6377 #ifndef UNIX /* for Unix mch_open() already set the permission */
6378 mch_setperm(to, perm);
6379 #endif
6380 #ifdef HAVE_ACL
6381 mch_set_acl(to, acl);
6382 mch_free_acl(acl);
6383 #endif
6384 if (errmsg != NULL)
6386 EMSG2(errmsg, to);
6387 return -1;
6389 mch_remove(from);
6390 return 0;
6393 static int already_warned = FALSE;
6396 * Check if any not hidden buffer has been changed.
6397 * Postpone the check if there are characters in the stuff buffer, a global
6398 * command is being executed, a mapping is being executed or an autocommand is
6399 * busy.
6400 * Returns TRUE if some message was written (screen should be redrawn and
6401 * cursor positioned).
6404 check_timestamps(focus)
6405 int focus; /* called for GUI focus event */
6407 buf_T *buf;
6408 int didit = 0;
6409 int n;
6411 /* Don't check timestamps while system() or another low-level function may
6412 * cause us to lose and gain focus. */
6413 if (no_check_timestamps > 0)
6414 return FALSE;
6416 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6417 * event and we would keep on checking if the file is steadily growing.
6418 * Do check again after typing something. */
6419 if (focus && did_check_timestamps)
6421 need_check_timestamps = TRUE;
6422 return FALSE;
6425 if (!stuff_empty() || global_busy || !typebuf_typed()
6426 #ifdef FEAT_AUTOCMD
6427 || autocmd_busy || curbuf_lock > 0 || allbuf_lock > 0
6428 #endif
6430 need_check_timestamps = TRUE; /* check later */
6431 else
6433 ++no_wait_return;
6434 did_check_timestamps = TRUE;
6435 already_warned = FALSE;
6436 for (buf = firstbuf; buf != NULL; )
6438 /* Only check buffers in a window. */
6439 if (buf->b_nwindows > 0)
6441 n = buf_check_timestamp(buf, focus);
6442 if (didit < n)
6443 didit = n;
6444 if (n > 0 && !buf_valid(buf))
6446 /* Autocommands have removed the buffer, start at the
6447 * first one again. */
6448 buf = firstbuf;
6449 continue;
6452 buf = buf->b_next;
6454 --no_wait_return;
6455 need_check_timestamps = FALSE;
6456 if (need_wait_return && didit == 2)
6458 /* make sure msg isn't overwritten */
6459 msg_puts((char_u *)"\n");
6460 out_flush();
6463 return didit;
6467 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6468 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6469 * empty.
6471 static int
6472 move_lines(frombuf, tobuf)
6473 buf_T *frombuf;
6474 buf_T *tobuf;
6476 buf_T *tbuf = curbuf;
6477 int retval = OK;
6478 linenr_T lnum;
6479 char_u *p;
6481 /* Copy the lines in "frombuf" to "tobuf". */
6482 curbuf = tobuf;
6483 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6485 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6486 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6488 vim_free(p);
6489 retval = FAIL;
6490 break;
6492 vim_free(p);
6495 /* Delete all the lines in "frombuf". */
6496 if (retval != FAIL)
6498 curbuf = frombuf;
6499 for (lnum = curbuf->b_ml.ml_line_count; lnum > 0; --lnum)
6500 if (ml_delete(lnum, FALSE) == FAIL)
6502 /* Oops! We could try putting back the saved lines, but that
6503 * might fail again... */
6504 retval = FAIL;
6505 break;
6509 curbuf = tbuf;
6510 return retval;
6514 * Check if buffer "buf" has been changed.
6515 * Also check if the file for a new buffer unexpectedly appeared.
6516 * return 1 if a changed buffer was found.
6517 * return 2 if a message has been displayed.
6518 * return 0 otherwise.
6521 buf_check_timestamp(buf, focus)
6522 buf_T *buf;
6523 int focus UNUSED; /* called for GUI focus event */
6525 struct stat st;
6526 int stat_res;
6527 int retval = 0;
6528 char_u *path;
6529 char_u *tbuf;
6530 char *mesg = NULL;
6531 char *mesg2 = "";
6532 int helpmesg = FALSE;
6533 int reload = FALSE;
6534 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6535 int can_reload = FALSE;
6536 #endif
6537 size_t orig_size = buf->b_orig_size;
6538 int orig_mode = buf->b_orig_mode;
6539 #ifdef FEAT_GUI
6540 int save_mouse_correct = need_mouse_correct;
6541 #endif
6542 #ifdef FEAT_AUTOCMD
6543 static int busy = FALSE;
6544 int n;
6545 char_u *s;
6546 #endif
6547 char *reason;
6549 /* If there is no file name, the buffer is not loaded, 'buftype' is
6550 * set, we are in the middle of a save or being called recursively: ignore
6551 * this buffer. */
6552 if (buf->b_ffname == NULL
6553 || buf->b_ml.ml_mfp == NULL
6554 #if defined(FEAT_QUICKFIX)
6555 || *buf->b_p_bt != NUL
6556 #endif
6557 || buf->b_saving
6558 #ifdef FEAT_AUTOCMD
6559 || busy
6560 #endif
6561 #ifdef FEAT_NETBEANS_INTG
6562 || isNetbeansBuffer(buf)
6563 #endif
6565 return 0;
6567 if ( !(buf->b_flags & BF_NOTEDITED)
6568 && buf->b_mtime != 0
6569 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6570 || time_differs((long)st.st_mtime, buf->b_mtime)
6571 #ifdef HAVE_ST_MODE
6572 || (int)st.st_mode != buf->b_orig_mode
6573 #else
6574 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6575 #endif
6578 retval = 1;
6580 /* set b_mtime to stop further warnings (e.g., when executing
6581 * FileChangedShell autocmd) */
6582 if (stat_res < 0)
6584 buf->b_mtime = 0;
6585 buf->b_orig_size = 0;
6586 buf->b_orig_mode = 0;
6588 else
6589 buf_store_time(buf, &st, buf->b_ffname);
6591 /* Don't do anything for a directory. Might contain the file
6592 * explorer. */
6593 if (mch_isdir(buf->b_fname))
6597 * If 'autoread' is set, the buffer has no changes and the file still
6598 * exists, reload the buffer. Use the buffer-local option value if it
6599 * was set, the global option value otherwise.
6601 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6602 && !bufIsChanged(buf) && stat_res >= 0)
6603 reload = TRUE;
6604 else
6606 if (stat_res < 0)
6607 reason = "deleted";
6608 else if (bufIsChanged(buf))
6609 reason = "conflict";
6610 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6611 reason = "changed";
6612 else if (orig_mode != buf->b_orig_mode)
6613 reason = "mode";
6614 else
6615 reason = "time";
6617 #ifdef FEAT_AUTOCMD
6619 * Only give the warning if there are no FileChangedShell
6620 * autocommands.
6621 * Avoid being called recursively by setting "busy".
6623 busy = TRUE;
6624 # ifdef FEAT_EVAL
6625 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6626 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6627 # endif
6628 ++allbuf_lock;
6629 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6630 buf->b_fname, buf->b_fname, FALSE, buf);
6631 --allbuf_lock;
6632 busy = FALSE;
6633 if (n)
6635 if (!buf_valid(buf))
6636 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6637 # ifdef FEAT_EVAL
6638 s = get_vim_var_str(VV_FCS_CHOICE);
6639 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6640 reload = TRUE;
6641 else if (STRCMP(s, "ask") == 0)
6642 n = FALSE;
6643 else
6644 # endif
6645 return 2;
6647 if (!n)
6648 #endif
6650 if (*reason == 'd')
6651 mesg = _("E211: File \"%s\" no longer available");
6652 else
6654 helpmesg = TRUE;
6655 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6656 can_reload = TRUE;
6657 #endif
6659 * Check if the file contents really changed to avoid
6660 * giving a warning when only the timestamp was set (e.g.,
6661 * checked out of CVS). Always warn when the buffer was
6662 * changed.
6664 if (reason[2] == 'n')
6666 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6667 mesg2 = _("See \":help W12\" for more info.");
6669 else if (reason[1] == 'h')
6671 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6672 mesg2 = _("See \":help W11\" for more info.");
6674 else if (*reason == 'm')
6676 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6677 mesg2 = _("See \":help W16\" for more info.");
6679 else
6680 /* Only timestamp changed, store it to avoid a warning
6681 * in check_mtime() later. */
6682 buf->b_mtime_read = buf->b_mtime;
6688 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6689 && vim_fexists(buf->b_ffname))
6691 retval = 1;
6692 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6693 buf->b_flags |= BF_NEW_W;
6694 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6695 can_reload = TRUE;
6696 #endif
6699 if (mesg != NULL)
6701 path = home_replace_save(buf, buf->b_fname);
6702 if (path != NULL)
6704 if (!helpmesg)
6705 mesg2 = "";
6706 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6707 + STRLEN(mesg2) + 2));
6708 sprintf((char *)tbuf, mesg, path);
6709 #ifdef FEAT_EVAL
6710 /* Set warningmsg here, before the unimportant and output-specific
6711 * mesg2 has been appended. */
6712 set_vim_var_string(VV_WARNINGMSG, tbuf, -1);
6713 #endif
6714 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6715 if (can_reload)
6717 if (*mesg2 != NUL)
6719 STRCAT(tbuf, "\n");
6720 STRCAT(tbuf, mesg2);
6722 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6723 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6724 reload = TRUE;
6726 else
6727 #endif
6728 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6730 if (*mesg2 != NUL)
6732 STRCAT(tbuf, "; ");
6733 STRCAT(tbuf, mesg2);
6735 EMSG(tbuf);
6736 retval = 2;
6738 else
6740 # ifdef FEAT_AUTOCMD
6741 if (!autocmd_busy)
6742 # endif
6744 msg_start();
6745 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6746 if (*mesg2 != NUL)
6747 msg_puts_attr((char_u *)mesg2,
6748 hl_attr(HLF_W) + MSG_HIST);
6749 msg_clr_eos();
6750 (void)msg_end();
6751 if (emsg_silent == 0)
6753 out_flush();
6754 # ifdef FEAT_GUI
6755 if (!focus)
6756 # endif
6757 /* give the user some time to think about it */
6758 ui_delay(1000L, TRUE);
6760 /* don't redraw and erase the message */
6761 redraw_cmdline = FALSE;
6764 already_warned = TRUE;
6767 vim_free(path);
6768 vim_free(tbuf);
6772 if (reload)
6773 /* Reload the buffer. */
6774 buf_reload(buf, orig_mode);
6776 #ifdef FEAT_AUTOCMD
6777 /* Trigger FileChangedShell when the file was changed in any way. */
6778 if (buf_valid(buf) && retval != 0)
6779 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6780 buf->b_fname, buf->b_fname, FALSE, buf);
6781 #endif
6782 #ifdef FEAT_GUI
6783 /* restore this in case an autocommand has set it; it would break
6784 * 'mousefocus' */
6785 need_mouse_correct = save_mouse_correct;
6786 #endif
6788 return retval;
6792 * Reload a buffer that is already loaded.
6793 * Used when the file was changed outside of Vim.
6794 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6795 * buf->b_orig_mode may have been reset already.
6797 void
6798 buf_reload(buf, orig_mode)
6799 buf_T *buf;
6800 int orig_mode;
6802 exarg_T ea;
6803 pos_T old_cursor;
6804 linenr_T old_topline;
6805 int old_ro = buf->b_p_ro;
6806 buf_T *savebuf;
6807 int saved = OK;
6808 aco_save_T aco;
6810 /* set curwin/curbuf for "buf" and save some things */
6811 aucmd_prepbuf(&aco, buf);
6813 /* We only want to read the text from the file, not reset the syntax
6814 * highlighting, clear marks, diff status, etc. Force the fileformat
6815 * and encoding to be the same. */
6816 if (prep_exarg(&ea, buf) == OK)
6818 old_cursor = curwin->w_cursor;
6819 old_topline = curwin->w_topline;
6822 * To behave like when a new file is edited (matters for
6823 * BufReadPost autocommands) we first need to delete the current
6824 * buffer contents. But if reading the file fails we should keep
6825 * the old contents. Can't use memory only, the file might be
6826 * too big. Use a hidden buffer to move the buffer contents to.
6828 if (bufempty())
6829 savebuf = NULL;
6830 else
6832 /* Allocate a buffer without putting it in the buffer list. */
6833 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6834 if (savebuf != NULL && buf == curbuf)
6836 /* Open the memline. */
6837 curbuf = savebuf;
6838 curwin->w_buffer = savebuf;
6839 saved = ml_open(curbuf);
6840 curbuf = buf;
6841 curwin->w_buffer = buf;
6843 if (savebuf == NULL || saved == FAIL || buf != curbuf
6844 || move_lines(buf, savebuf) == FAIL)
6846 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6847 buf->b_fname);
6848 saved = FAIL;
6852 if (saved == OK)
6854 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6855 #ifdef FEAT_AUTOCMD
6856 keep_filetype = TRUE; /* don't detect 'filetype' */
6857 #endif
6858 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6859 (linenr_T)0,
6860 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6862 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6863 if (!aborting())
6864 #endif
6865 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6866 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6868 /* Put the text back from the save buffer. First
6869 * delete any lines that readfile() added. */
6870 while (!bufempty())
6871 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6872 break;
6873 (void)move_lines(savebuf, buf);
6876 else if (buf == curbuf)
6878 /* Mark the buffer as unmodified and free undo info. */
6879 unchanged(buf, TRUE);
6880 u_blockfree(buf);
6881 u_clearall(buf);
6884 vim_free(ea.cmd);
6886 if (savebuf != NULL && buf_valid(savebuf))
6887 wipe_buffer(savebuf, FALSE);
6889 #ifdef FEAT_DIFF
6890 /* Invalidate diff info if necessary. */
6891 diff_invalidate(curbuf);
6892 #endif
6894 /* Restore the topline and cursor position and check it (lines may
6895 * have been removed). */
6896 if (old_topline > curbuf->b_ml.ml_line_count)
6897 curwin->w_topline = curbuf->b_ml.ml_line_count;
6898 else
6899 curwin->w_topline = old_topline;
6900 curwin->w_cursor = old_cursor;
6901 check_cursor();
6902 update_topline();
6903 #ifdef FEAT_AUTOCMD
6904 keep_filetype = FALSE;
6905 #endif
6906 #ifdef FEAT_FOLDING
6908 win_T *wp;
6909 tabpage_T *tp;
6911 /* Update folds unless they are defined manually. */
6912 FOR_ALL_TAB_WINDOWS(tp, wp)
6913 if (wp->w_buffer == curwin->w_buffer
6914 && !foldmethodIsManual(wp))
6915 foldUpdateAll(wp);
6917 #endif
6918 /* If the mode didn't change and 'readonly' was set, keep the old
6919 * value; the user probably used the ":view" command. But don't
6920 * reset it, might have had a read error. */
6921 if (orig_mode == curbuf->b_orig_mode)
6922 curbuf->b_p_ro |= old_ro;
6925 /* restore curwin/curbuf and a few other things */
6926 aucmd_restbuf(&aco);
6927 /* Careful: autocommands may have made "buf" invalid! */
6930 void
6931 buf_store_time(buf, st, fname)
6932 buf_T *buf;
6933 struct stat *st;
6934 char_u *fname UNUSED;
6936 buf->b_mtime = (long)st->st_mtime;
6937 buf->b_orig_size = (size_t)st->st_size;
6938 #ifdef HAVE_ST_MODE
6939 buf->b_orig_mode = (int)st->st_mode;
6940 #else
6941 buf->b_orig_mode = mch_getperm(fname);
6942 #endif
6946 * Adjust the line with missing eol, used for the next write.
6947 * Used for do_filter(), when the input lines for the filter are deleted.
6949 void
6950 write_lnum_adjust(offset)
6951 linenr_T offset;
6953 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
6954 write_no_eol_lnum += offset;
6957 #if defined(TEMPDIRNAMES) || defined(PROTO)
6958 static long temp_count = 0; /* Temp filename counter. */
6961 * Delete the temp directory and all files it contains.
6963 void
6964 vim_deltempdir()
6966 char_u **files;
6967 int file_count;
6968 int i;
6970 if (vim_tempdir != NULL)
6972 sprintf((char *)NameBuff, "%s*", vim_tempdir);
6973 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
6974 EW_DIR|EW_FILE|EW_SILENT) == OK)
6976 for (i = 0; i < file_count; ++i)
6977 mch_remove(files[i]);
6978 FreeWild(file_count, files);
6980 gettail(NameBuff)[-1] = NUL;
6981 (void)mch_rmdir(NameBuff);
6983 vim_free(vim_tempdir);
6984 vim_tempdir = NULL;
6987 #endif
6990 * vim_tempname(): Return a unique name that can be used for a temp file.
6992 * The temp file is NOT created.
6994 * The returned pointer is to allocated memory.
6995 * The returned pointer is NULL if no valid name was found.
6997 char_u *
6998 vim_tempname(extra_char)
6999 int extra_char UNUSED; /* char to use in the name instead of '?' */
7001 #ifdef USE_TMPNAM
7002 char_u itmp[L_tmpnam]; /* use tmpnam() */
7003 #else
7004 char_u itmp[TEMPNAMELEN];
7005 #endif
7007 #ifdef TEMPDIRNAMES
7008 static char *(tempdirs[]) = {TEMPDIRNAMES};
7009 int i;
7010 long nr;
7011 long off;
7012 # ifndef EEXIST
7013 struct stat st;
7014 # endif
7017 * This will create a directory for private use by this instance of Vim.
7018 * This is done once, and the same directory is used for all temp files.
7019 * This method avoids security problems because of symlink attacks et al.
7020 * It's also a bit faster, because we only need to check for an existing
7021 * file when creating the directory and not for each temp file.
7023 if (vim_tempdir == NULL)
7026 * Try the entries in TEMPDIRNAMES to create the temp directory.
7028 for (i = 0; i < (int)(sizeof(tempdirs) / sizeof(char *)); ++i)
7030 /* expand $TMP, leave room for "/v1100000/999999999" */
7031 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
7032 if (mch_isdir(itmp)) /* directory exists */
7034 # ifdef __EMX__
7035 /* If $TMP contains a forward slash (perhaps using bash or
7036 * tcsh), don't add a backslash, use a forward slash!
7037 * Adding 2 backslashes didn't work. */
7038 if (vim_strchr(itmp, '/') != NULL)
7039 STRCAT(itmp, "/");
7040 else
7041 # endif
7042 add_pathsep(itmp);
7044 /* Get an arbitrary number of up to 6 digits. When it's
7045 * unlikely that it already exists it will be faster,
7046 * otherwise it doesn't matter. The use of mkdir() avoids any
7047 * security problems because of the predictable number. */
7048 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
7050 /* Try up to 10000 different values until we find a name that
7051 * doesn't exist. */
7052 for (off = 0; off < 10000L; ++off)
7054 int r;
7055 #if defined(UNIX) || defined(VMS)
7056 mode_t umask_save;
7057 #endif
7059 sprintf((char *)itmp + STRLEN(itmp), "v%ld", nr + off);
7060 # ifndef EEXIST
7061 /* If mkdir() does not set errno to EEXIST, check for
7062 * existing file here. There is a race condition then,
7063 * although it's fail-safe. */
7064 if (mch_stat((char *)itmp, &st) >= 0)
7065 continue;
7066 # endif
7067 #if defined(UNIX) || defined(VMS)
7068 /* Make sure the umask doesn't remove the executable bit.
7069 * "repl" has been reported to use "177". */
7070 umask_save = umask(077);
7071 #endif
7072 r = vim_mkdir(itmp, 0700);
7073 #if defined(UNIX) || defined(VMS)
7074 (void)umask(umask_save);
7075 #endif
7076 if (r == 0)
7078 char_u *buf;
7080 /* Directory was created, use this name.
7081 * Expand to full path; When using the current
7082 * directory a ":cd" would confuse us. */
7083 buf = alloc((unsigned)MAXPATHL + 1);
7084 if (buf != NULL)
7086 if (vim_FullName(itmp, buf, MAXPATHL, FALSE)
7087 == FAIL)
7088 STRCPY(buf, itmp);
7089 # ifdef __EMX__
7090 if (vim_strchr(buf, '/') != NULL)
7091 STRCAT(buf, "/");
7092 else
7093 # endif
7094 add_pathsep(buf);
7095 vim_tempdir = vim_strsave(buf);
7096 vim_free(buf);
7098 break;
7100 # ifdef EEXIST
7101 /* If the mkdir() didn't fail because the file/dir exists,
7102 * we probably can't create any dir here, try another
7103 * place. */
7104 if (errno != EEXIST)
7105 # endif
7106 break;
7108 if (vim_tempdir != NULL)
7109 break;
7114 if (vim_tempdir != NULL)
7116 /* There is no need to check if the file exists, because we own the
7117 * directory and nobody else creates a file in it. */
7118 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
7119 return vim_strsave(itmp);
7122 return NULL;
7124 #else /* TEMPDIRNAMES */
7126 # ifdef WIN3264
7127 char szTempFile[_MAX_PATH + 1];
7128 char buf4[4];
7129 char_u *retval;
7130 char_u *p;
7132 STRCPY(itmp, "");
7133 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
7134 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
7135 strcpy(buf4, "VIM");
7136 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
7137 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
7138 return NULL;
7139 /* GetTempFileName() will create the file, we don't want that */
7140 (void)DeleteFile(itmp);
7142 /* Backslashes in a temp file name cause problems when filtering with
7143 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
7144 * didn't set 'shellslash'. */
7145 retval = vim_strsave(itmp);
7146 if (*p_shcf == '-' || p_ssl)
7147 for (p = retval; *p; ++p)
7148 if (*p == '\\')
7149 *p = '/';
7150 return retval;
7152 # else /* WIN3264 */
7154 # ifdef USE_TMPNAM
7155 /* tmpnam() will make its own name */
7156 if (*tmpnam((char *)itmp) == NUL)
7157 return NULL;
7158 # else
7159 char_u *p;
7161 # ifdef VMS_TEMPNAM
7162 /* mktemp() is not working on VMS. It seems to be
7163 * a do-nothing function. Therefore we use tempnam().
7165 sprintf((char *)itmp, "VIM%c", extra_char);
7166 p = (char_u *)tempnam("tmp:", (char *)itmp);
7167 if (p != NULL)
7169 /* VMS will use '.LOG' if we don't explicitly specify an extension,
7170 * and VIM will then be unable to find the file later */
7171 STRCPY(itmp, p);
7172 STRCAT(itmp, ".txt");
7173 free(p);
7175 else
7176 return NULL;
7177 # else
7178 STRCPY(itmp, TEMPNAME);
7179 if ((p = vim_strchr(itmp, '?')) != NULL)
7180 *p = extra_char;
7181 if (mktemp((char *)itmp) == NULL)
7182 return NULL;
7183 # endif
7184 # endif
7186 return vim_strsave(itmp);
7187 # endif /* WIN3264 */
7188 #endif /* TEMPDIRNAMES */
7191 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
7193 * Convert all backslashes in fname to forward slashes in-place.
7195 void
7196 forward_slash(fname)
7197 char_u *fname;
7199 char_u *p;
7201 for (p = fname; *p != NUL; ++p)
7202 # ifdef FEAT_MBYTE
7203 /* The Big5 encoding can have '\' in the trail byte. */
7204 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
7205 ++p;
7206 else
7207 # endif
7208 if (*p == '\\')
7209 *p = '/';
7211 #endif
7215 * Code for automatic commands.
7217 * Only included when "FEAT_AUTOCMD" has been defined.
7220 #if defined(FEAT_AUTOCMD) || defined(PROTO)
7223 * The autocommands are stored in a list for each event.
7224 * Autocommands for the same pattern, that are consecutive, are joined
7225 * together, to avoid having to match the pattern too often.
7226 * The result is an array of Autopat lists, which point to AutoCmd lists:
7228 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7229 * Autopat.cmds Autopat.cmds
7230 * | |
7231 * V V
7232 * AutoCmd.next AutoCmd.next
7233 * | |
7234 * V V
7235 * AutoCmd.next NULL
7238 * NULL
7240 * first_autopat[1] --> Autopat.next --> NULL
7241 * Autopat.cmds
7244 * AutoCmd.next
7247 * NULL
7248 * etc.
7250 * The order of AutoCmds is important, this is the order in which they were
7251 * defined and will have to be executed.
7253 typedef struct AutoCmd
7255 char_u *cmd; /* The command to be executed (NULL
7256 when command has been removed) */
7257 char nested; /* If autocommands nest here */
7258 char last; /* last command in list */
7259 #ifdef FEAT_EVAL
7260 scid_T scriptID; /* script ID where defined */
7261 #endif
7262 struct AutoCmd *next; /* Next AutoCmd in list */
7263 } AutoCmd;
7265 typedef struct AutoPat
7267 int group; /* group ID */
7268 char_u *pat; /* pattern as typed (NULL when pattern
7269 has been removed) */
7270 int patlen; /* strlen() of pat */
7271 regprog_T *reg_prog; /* compiled regprog for pattern */
7272 char allow_dirs; /* Pattern may match whole path */
7273 char last; /* last pattern for apply_autocmds() */
7274 AutoCmd *cmds; /* list of commands to do */
7275 struct AutoPat *next; /* next AutoPat in AutoPat list */
7276 int buflocal_nr; /* !=0 for buffer-local AutoPat */
7277 } AutoPat;
7279 static struct event_name
7281 char *name; /* event name */
7282 event_T event; /* event number */
7283 } event_names[] =
7285 {"BufAdd", EVENT_BUFADD},
7286 {"BufCreate", EVENT_BUFADD},
7287 {"BufDelete", EVENT_BUFDELETE},
7288 {"BufEnter", EVENT_BUFENTER},
7289 {"BufFilePost", EVENT_BUFFILEPOST},
7290 {"BufFilePre", EVENT_BUFFILEPRE},
7291 {"BufHidden", EVENT_BUFHIDDEN},
7292 {"BufLeave", EVENT_BUFLEAVE},
7293 {"BufNew", EVENT_BUFNEW},
7294 {"BufNewFile", EVENT_BUFNEWFILE},
7295 {"BufRead", EVENT_BUFREADPOST},
7296 {"BufReadCmd", EVENT_BUFREADCMD},
7297 {"BufReadPost", EVENT_BUFREADPOST},
7298 {"BufReadPre", EVENT_BUFREADPRE},
7299 {"BufUnload", EVENT_BUFUNLOAD},
7300 {"BufWinEnter", EVENT_BUFWINENTER},
7301 {"BufWinLeave", EVENT_BUFWINLEAVE},
7302 {"BufWipeout", EVENT_BUFWIPEOUT},
7303 {"BufWrite", EVENT_BUFWRITEPRE},
7304 {"BufWritePost", EVENT_BUFWRITEPOST},
7305 {"BufWritePre", EVENT_BUFWRITEPRE},
7306 {"BufWriteCmd", EVENT_BUFWRITECMD},
7307 {"CmdwinEnter", EVENT_CMDWINENTER},
7308 {"CmdwinLeave", EVENT_CMDWINLEAVE},
7309 {"ColorScheme", EVENT_COLORSCHEME},
7310 {"CursorHold", EVENT_CURSORHOLD},
7311 {"CursorHoldI", EVENT_CURSORHOLDI},
7312 {"CursorMoved", EVENT_CURSORMOVED},
7313 {"CursorMovedI", EVENT_CURSORMOVEDI},
7314 {"EncodingChanged", EVENT_ENCODINGCHANGED},
7315 {"FileEncoding", EVENT_ENCODINGCHANGED},
7316 {"FileAppendPost", EVENT_FILEAPPENDPOST},
7317 {"FileAppendPre", EVENT_FILEAPPENDPRE},
7318 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
7319 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
7320 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
7321 {"FileChangedRO", EVENT_FILECHANGEDRO},
7322 {"FileReadPost", EVENT_FILEREADPOST},
7323 {"FileReadPre", EVENT_FILEREADPRE},
7324 {"FileReadCmd", EVENT_FILEREADCMD},
7325 {"FileType", EVENT_FILETYPE},
7326 {"FileWritePost", EVENT_FILEWRITEPOST},
7327 {"FileWritePre", EVENT_FILEWRITEPRE},
7328 {"FileWriteCmd", EVENT_FILEWRITECMD},
7329 {"FilterReadPost", EVENT_FILTERREADPOST},
7330 {"FilterReadPre", EVENT_FILTERREADPRE},
7331 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7332 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7333 {"FocusGained", EVENT_FOCUSGAINED},
7334 {"FocusLost", EVENT_FOCUSLOST},
7335 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7336 {"GUIEnter", EVENT_GUIENTER},
7337 {"GUIFailed", EVENT_GUIFAILED},
7338 {"InsertChange", EVENT_INSERTCHANGE},
7339 {"InsertEnter", EVENT_INSERTENTER},
7340 {"InsertLeave", EVENT_INSERTLEAVE},
7341 {"MenuPopup", EVENT_MENUPOPUP},
7342 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7343 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7344 {"RemoteReply", EVENT_REMOTEREPLY},
7345 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7346 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7347 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7348 {"SourcePre", EVENT_SOURCEPRE},
7349 {"SourceCmd", EVENT_SOURCECMD},
7350 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7351 {"StdinReadPost", EVENT_STDINREADPOST},
7352 {"StdinReadPre", EVENT_STDINREADPRE},
7353 {"SwapExists", EVENT_SWAPEXISTS},
7354 {"Syntax", EVENT_SYNTAX},
7355 {"TabEnter", EVENT_TABENTER},
7356 {"TabLeave", EVENT_TABLEAVE},
7357 {"TermChanged", EVENT_TERMCHANGED},
7358 {"TermResponse", EVENT_TERMRESPONSE},
7359 {"User", EVENT_USER},
7360 {"VimEnter", EVENT_VIMENTER},
7361 {"VimLeave", EVENT_VIMLEAVE},
7362 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7363 {"WinEnter", EVENT_WINENTER},
7364 {"WinLeave", EVENT_WINLEAVE},
7365 {"VimResized", EVENT_VIMRESIZED},
7366 {NULL, (event_T)0}
7369 static AutoPat *first_autopat[NUM_EVENTS] =
7371 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7372 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7373 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7374 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7375 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7376 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7380 * struct used to keep status while executing autocommands for an event.
7382 typedef struct AutoPatCmd
7384 AutoPat *curpat; /* next AutoPat to examine */
7385 AutoCmd *nextcmd; /* next AutoCmd to execute */
7386 int group; /* group being used */
7387 char_u *fname; /* fname to match with */
7388 char_u *sfname; /* sfname to match with */
7389 char_u *tail; /* tail of fname */
7390 event_T event; /* current event */
7391 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7392 buf is deleted */
7393 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7394 } AutoPatCmd;
7396 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7399 * augroups stores a list of autocmd group names.
7401 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7402 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7405 * The ID of the current group. Group 0 is the default one.
7407 static int current_augroup = AUGROUP_DEFAULT;
7409 static int au_need_clean = FALSE; /* need to delete marked patterns */
7411 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7412 static void au_remove_pat __ARGS((AutoPat *ap));
7413 static void au_remove_cmds __ARGS((AutoPat *ap));
7414 static void au_cleanup __ARGS((void));
7415 static int au_new_group __ARGS((char_u *name));
7416 static void au_del_group __ARGS((char_u *name));
7417 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7418 static char_u *event_nr2name __ARGS((event_T event));
7419 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7420 static int event_ignored __ARGS((event_T event));
7421 static int au_get_grouparg __ARGS((char_u **argp));
7422 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7423 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7424 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));
7425 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7428 static event_T last_event;
7429 static int last_group;
7430 static int autocmd_blocked = 0; /* block all autocmds */
7433 * Show the autocommands for one AutoPat.
7435 static void
7436 show_autocmd(ap, event)
7437 AutoPat *ap;
7438 event_T event;
7440 AutoCmd *ac;
7442 /* Check for "got_int" (here and at various places below), which is set
7443 * when "q" has been hit for the "--more--" prompt */
7444 if (got_int)
7445 return;
7446 if (ap->pat == NULL) /* pattern has been removed */
7447 return;
7449 msg_putchar('\n');
7450 if (got_int)
7451 return;
7452 if (event != last_event || ap->group != last_group)
7454 if (ap->group != AUGROUP_DEFAULT)
7456 if (AUGROUP_NAME(ap->group) == NULL)
7457 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7458 else
7459 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7460 msg_puts((char_u *)" ");
7462 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7463 last_event = event;
7464 last_group = ap->group;
7465 msg_putchar('\n');
7466 if (got_int)
7467 return;
7469 msg_col = 4;
7470 msg_outtrans(ap->pat);
7472 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7474 if (ac->cmd != NULL) /* skip removed commands */
7476 if (msg_col >= 14)
7477 msg_putchar('\n');
7478 msg_col = 14;
7479 if (got_int)
7480 return;
7481 msg_outtrans(ac->cmd);
7482 #ifdef FEAT_EVAL
7483 if (p_verbose > 0)
7484 last_set_msg(ac->scriptID);
7485 #endif
7486 if (got_int)
7487 return;
7488 if (ac->next != NULL)
7490 msg_putchar('\n');
7491 if (got_int)
7492 return;
7499 * Mark an autocommand pattern for deletion.
7501 static void
7502 au_remove_pat(ap)
7503 AutoPat *ap;
7505 vim_free(ap->pat);
7506 ap->pat = NULL;
7507 ap->buflocal_nr = -1;
7508 au_need_clean = TRUE;
7512 * Mark all commands for a pattern for deletion.
7514 static void
7515 au_remove_cmds(ap)
7516 AutoPat *ap;
7518 AutoCmd *ac;
7520 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7522 vim_free(ac->cmd);
7523 ac->cmd = NULL;
7525 au_need_clean = TRUE;
7529 * Cleanup autocommands and patterns that have been deleted.
7530 * This is only done when not executing autocommands.
7532 static void
7533 au_cleanup()
7535 AutoPat *ap, **prev_ap;
7536 AutoCmd *ac, **prev_ac;
7537 event_T event;
7539 if (autocmd_busy || !au_need_clean)
7540 return;
7542 /* loop over all events */
7543 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7544 event = (event_T)((int)event + 1))
7546 /* loop over all autocommand patterns */
7547 prev_ap = &(first_autopat[(int)event]);
7548 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7550 /* loop over all commands for this pattern */
7551 prev_ac = &(ap->cmds);
7552 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7554 /* remove the command if the pattern is to be deleted or when
7555 * the command has been marked for deletion */
7556 if (ap->pat == NULL || ac->cmd == NULL)
7558 *prev_ac = ac->next;
7559 vim_free(ac->cmd);
7560 vim_free(ac);
7562 else
7563 prev_ac = &(ac->next);
7566 /* remove the pattern if it has been marked for deletion */
7567 if (ap->pat == NULL)
7569 *prev_ap = ap->next;
7570 vim_free(ap->reg_prog);
7571 vim_free(ap);
7573 else
7574 prev_ap = &(ap->next);
7578 au_need_clean = FALSE;
7582 * Called when buffer is freed, to remove/invalidate related buffer-local
7583 * autocmds.
7585 void
7586 aubuflocal_remove(buf)
7587 buf_T *buf;
7589 AutoPat *ap;
7590 event_T event;
7591 AutoPatCmd *apc;
7593 /* invalidate currently executing autocommands */
7594 for (apc = active_apc_list; apc; apc = apc->next)
7595 if (buf->b_fnum == apc->arg_bufnr)
7596 apc->arg_bufnr = 0;
7598 /* invalidate buflocals looping through events */
7599 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7600 event = (event_T)((int)event + 1))
7601 /* loop over all autocommand patterns */
7602 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7603 if (ap->buflocal_nr == buf->b_fnum)
7605 au_remove_pat(ap);
7606 if (p_verbose >= 6)
7608 verbose_enter();
7609 smsg((char_u *)
7610 _("auto-removing autocommand: %s <buffer=%d>"),
7611 event_nr2name(event), buf->b_fnum);
7612 verbose_leave();
7615 au_cleanup();
7619 * Add an autocmd group name.
7620 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7622 static int
7623 au_new_group(name)
7624 char_u *name;
7626 int i;
7628 i = au_find_group(name);
7629 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7631 /* First try using a free entry. */
7632 for (i = 0; i < augroups.ga_len; ++i)
7633 if (AUGROUP_NAME(i) == NULL)
7634 break;
7635 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7636 return AUGROUP_ERROR;
7638 AUGROUP_NAME(i) = vim_strsave(name);
7639 if (AUGROUP_NAME(i) == NULL)
7640 return AUGROUP_ERROR;
7641 if (i == augroups.ga_len)
7642 ++augroups.ga_len;
7645 return i;
7648 static void
7649 au_del_group(name)
7650 char_u *name;
7652 int i;
7654 i = au_find_group(name);
7655 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7656 EMSG2(_("E367: No such group: \"%s\""), name);
7657 else
7659 vim_free(AUGROUP_NAME(i));
7660 AUGROUP_NAME(i) = NULL;
7665 * Find the ID of an autocmd group name.
7666 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7668 static int
7669 au_find_group(name)
7670 char_u *name;
7672 int i;
7674 for (i = 0; i < augroups.ga_len; ++i)
7675 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7676 return i;
7677 return AUGROUP_ERROR;
7681 * Return TRUE if augroup "name" exists.
7684 au_has_group(name)
7685 char_u *name;
7687 return au_find_group(name) != AUGROUP_ERROR;
7691 * ":augroup {name}".
7693 void
7694 do_augroup(arg, del_group)
7695 char_u *arg;
7696 int del_group;
7698 int i;
7700 if (del_group)
7702 if (*arg == NUL)
7703 EMSG(_(e_argreq));
7704 else
7705 au_del_group(arg);
7707 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7708 current_augroup = AUGROUP_DEFAULT;
7709 else if (*arg) /* ":aug xxx": switch to group xxx */
7711 i = au_new_group(arg);
7712 if (i != AUGROUP_ERROR)
7713 current_augroup = i;
7715 else /* ":aug": list the group names */
7717 msg_start();
7718 for (i = 0; i < augroups.ga_len; ++i)
7720 if (AUGROUP_NAME(i) != NULL)
7722 msg_puts(AUGROUP_NAME(i));
7723 msg_puts((char_u *)" ");
7726 msg_clr_eos();
7727 msg_end();
7731 #if defined(EXITFREE) || defined(PROTO)
7732 void
7733 free_all_autocmds()
7735 for (current_augroup = -1; current_augroup < augroups.ga_len;
7736 ++current_augroup)
7737 do_autocmd((char_u *)"", TRUE);
7738 ga_clear_strings(&augroups);
7740 #endif
7743 * Return the event number for event name "start".
7744 * Return NUM_EVENTS if the event name was not found.
7745 * Return a pointer to the next event name in "end".
7747 static event_T
7748 event_name2nr(start, end)
7749 char_u *start;
7750 char_u **end;
7752 char_u *p;
7753 int i;
7754 int len;
7756 /* the event name ends with end of line, a blank or a comma */
7757 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7759 for (i = 0; event_names[i].name != NULL; ++i)
7761 len = (int)STRLEN(event_names[i].name);
7762 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7763 break;
7765 if (*p == ',')
7766 ++p;
7767 *end = p;
7768 if (event_names[i].name == NULL)
7769 return NUM_EVENTS;
7770 return event_names[i].event;
7774 * Return the name for event "event".
7776 static char_u *
7777 event_nr2name(event)
7778 event_T event;
7780 int i;
7782 for (i = 0; event_names[i].name != NULL; ++i)
7783 if (event_names[i].event == event)
7784 return (char_u *)event_names[i].name;
7785 return (char_u *)"Unknown";
7789 * Scan over the events. "*" stands for all events.
7791 static char_u *
7792 find_end_event(arg, have_group)
7793 char_u *arg;
7794 int have_group; /* TRUE when group name was found */
7796 char_u *pat;
7797 char_u *p;
7799 if (*arg == '*')
7801 if (arg[1] && !vim_iswhite(arg[1]))
7803 EMSG2(_("E215: Illegal character after *: %s"), arg);
7804 return NULL;
7806 pat = arg + 1;
7808 else
7810 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7812 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7814 if (have_group)
7815 EMSG2(_("E216: No such event: %s"), pat);
7816 else
7817 EMSG2(_("E216: No such group or event: %s"), pat);
7818 return NULL;
7822 return pat;
7826 * Return TRUE if "event" is included in 'eventignore'.
7828 static int
7829 event_ignored(event)
7830 event_T event;
7832 char_u *p = p_ei;
7834 while (*p != NUL)
7836 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7837 return TRUE;
7838 if (event_name2nr(p, &p) == event)
7839 return TRUE;
7842 return FALSE;
7846 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7849 check_ei()
7851 char_u *p = p_ei;
7853 while (*p)
7855 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7857 p += 3;
7858 if (*p == ',')
7859 ++p;
7861 else if (event_name2nr(p, &p) == NUM_EVENTS)
7862 return FAIL;
7865 return OK;
7868 # if defined(FEAT_SYN_HL) || defined(PROTO)
7871 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7872 * buffer loaded into the window. "what" must start with a comma.
7873 * Returns the old value of 'eventignore' in allocated memory.
7875 char_u *
7876 au_event_disable(what)
7877 char *what;
7879 char_u *new_ei;
7880 char_u *save_ei;
7882 save_ei = vim_strsave(p_ei);
7883 if (save_ei != NULL)
7885 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7886 if (new_ei != NULL)
7888 STRCAT(new_ei, what);
7889 set_string_option_direct((char_u *)"ei", -1, new_ei,
7890 OPT_FREE, SID_NONE);
7891 vim_free(new_ei);
7894 return save_ei;
7897 void
7898 au_event_restore(old_ei)
7899 char_u *old_ei;
7901 if (old_ei != NULL)
7903 set_string_option_direct((char_u *)"ei", -1, old_ei,
7904 OPT_FREE, SID_NONE);
7905 vim_free(old_ei);
7908 # endif /* FEAT_SYN_HL */
7911 * do_autocmd() -- implements the :autocmd command. Can be used in the
7912 * following ways:
7914 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7915 * will be automatically executed for <event>
7916 * when editing a file matching <pat>, in
7917 * the current group.
7918 * :autocmd <event> <pat> Show the auto-commands associated with
7919 * <event> and <pat>.
7920 * :autocmd <event> Show the auto-commands associated with
7921 * <event>.
7922 * :autocmd Show all auto-commands.
7923 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7924 * <event> and <pat>, and add the command
7925 * <cmd>, for the current group.
7926 * :autocmd! <event> <pat> Remove all auto-commands associated with
7927 * <event> and <pat> for the current group.
7928 * :autocmd! <event> Remove all auto-commands associated with
7929 * <event> for the current group.
7930 * :autocmd! Remove ALL auto-commands for the current
7931 * group.
7933 * Multiple events and patterns may be given separated by commas. Here are
7934 * some examples:
7935 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7936 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7938 * :autocmd * *.c show all autocommands for *.c files.
7940 * Mostly a {group} argument can optionally appear before <event>.
7942 void
7943 do_autocmd(arg, forceit)
7944 char_u *arg;
7945 int forceit;
7947 char_u *pat;
7948 char_u *envpat = NULL;
7949 char_u *cmd;
7950 event_T event;
7951 int need_free = FALSE;
7952 int nested = FALSE;
7953 int group;
7956 * Check for a legal group name. If not, use AUGROUP_ALL.
7958 group = au_get_grouparg(&arg);
7959 if (arg == NULL) /* out of memory */
7960 return;
7963 * Scan over the events.
7964 * If we find an illegal name, return here, don't do anything.
7966 pat = find_end_event(arg, group != AUGROUP_ALL);
7967 if (pat == NULL)
7968 return;
7971 * Scan over the pattern. Put a NUL at the end.
7973 pat = skipwhite(pat);
7974 cmd = pat;
7975 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
7976 cmd++;
7977 if (*cmd)
7978 *cmd++ = NUL;
7980 /* Expand environment variables in the pattern. Set 'shellslash', we want
7981 * forward slashes here. */
7982 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
7984 #ifdef BACKSLASH_IN_FILENAME
7985 int p_ssl_save = p_ssl;
7987 p_ssl = TRUE;
7988 #endif
7989 envpat = expand_env_save(pat);
7990 #ifdef BACKSLASH_IN_FILENAME
7991 p_ssl = p_ssl_save;
7992 #endif
7993 if (envpat != NULL)
7994 pat = envpat;
7998 * Check for "nested" flag.
8000 cmd = skipwhite(cmd);
8001 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
8003 nested = TRUE;
8004 cmd = skipwhite(cmd + 6);
8008 * Find the start of the commands.
8009 * Expand <sfile> in it.
8011 if (*cmd != NUL)
8013 cmd = expand_sfile(cmd);
8014 if (cmd == NULL) /* some error */
8015 return;
8016 need_free = TRUE;
8020 * Print header when showing autocommands.
8022 if (!forceit && *cmd == NUL)
8024 /* Highlight title */
8025 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
8029 * Loop over the events.
8031 last_event = (event_T)-1; /* for listing the event name */
8032 last_group = AUGROUP_ERROR; /* for listing the group name */
8033 if (*arg == '*' || *arg == NUL)
8035 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
8036 event = (event_T)((int)event + 1))
8037 if (do_autocmd_event(event, pat,
8038 nested, cmd, forceit, group) == FAIL)
8039 break;
8041 else
8043 while (*arg && !vim_iswhite(*arg))
8044 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
8045 nested, cmd, forceit, group) == FAIL)
8046 break;
8049 if (need_free)
8050 vim_free(cmd);
8051 vim_free(envpat);
8055 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
8056 * The "argp" argument is advanced to the following argument.
8058 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
8060 static int
8061 au_get_grouparg(argp)
8062 char_u **argp;
8064 char_u *group_name;
8065 char_u *p;
8066 char_u *arg = *argp;
8067 int group = AUGROUP_ALL;
8069 p = skiptowhite(arg);
8070 if (p > arg)
8072 group_name = vim_strnsave(arg, (int)(p - arg));
8073 if (group_name == NULL) /* out of memory */
8074 return AUGROUP_ERROR;
8075 group = au_find_group(group_name);
8076 if (group == AUGROUP_ERROR)
8077 group = AUGROUP_ALL; /* no match, use all groups */
8078 else
8079 *argp = skipwhite(p); /* match, skip over group name */
8080 vim_free(group_name);
8082 return group;
8086 * do_autocmd() for one event.
8087 * If *pat == NUL do for all patterns.
8088 * If *cmd == NUL show entries.
8089 * If forceit == TRUE delete entries.
8090 * If group is not AUGROUP_ALL, only use this group.
8092 static int
8093 do_autocmd_event(event, pat, nested, cmd, forceit, group)
8094 event_T event;
8095 char_u *pat;
8096 int nested;
8097 char_u *cmd;
8098 int forceit;
8099 int group;
8101 AutoPat *ap;
8102 AutoPat **prev_ap;
8103 AutoCmd *ac;
8104 AutoCmd **prev_ac;
8105 int brace_level;
8106 char_u *endpat;
8107 int findgroup;
8108 int allgroups;
8109 int patlen;
8110 int is_buflocal;
8111 int buflocal_nr;
8112 char_u buflocal_pat[25]; /* for "<buffer=X>" */
8114 if (group == AUGROUP_ALL)
8115 findgroup = current_augroup;
8116 else
8117 findgroup = group;
8118 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
8121 * Show or delete all patterns for an event.
8123 if (*pat == NUL)
8125 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
8127 if (forceit) /* delete the AutoPat, if it's in the current group */
8129 if (ap->group == findgroup)
8130 au_remove_pat(ap);
8132 else if (group == AUGROUP_ALL || ap->group == group)
8133 show_autocmd(ap, event);
8138 * Loop through all the specified patterns.
8140 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
8143 * Find end of the pattern.
8144 * Watch out for a comma in braces, like "*.\{obj,o\}".
8146 brace_level = 0;
8147 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
8148 || endpat[-1] == '\\'); ++endpat)
8150 if (*endpat == '{')
8151 brace_level++;
8152 else if (*endpat == '}')
8153 brace_level--;
8155 if (pat == endpat) /* ignore single comma */
8156 continue;
8157 patlen = (int)(endpat - pat);
8160 * detect special <buflocal[=X]> buffer-local patterns
8162 is_buflocal = FALSE;
8163 buflocal_nr = 0;
8165 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
8166 && pat[patlen - 1] == '>')
8168 /* Error will be printed only for addition. printing and removing
8169 * will proceed silently. */
8170 is_buflocal = TRUE;
8171 if (patlen == 8)
8172 buflocal_nr = curbuf->b_fnum;
8173 else if (patlen > 9 && pat[7] == '=')
8175 /* <buffer=abuf> */
8176 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
8177 buflocal_nr = autocmd_bufnr;
8178 /* <buffer=123> */
8179 else if (skipdigits(pat + 8) == pat + patlen - 1)
8180 buflocal_nr = atoi((char *)pat + 8);
8184 if (is_buflocal)
8186 /* normalize pat into standard "<buffer>#N" form */
8187 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
8188 pat = buflocal_pat; /* can modify pat and patlen */
8189 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
8193 * Find AutoPat entries with this pattern.
8195 prev_ap = &first_autopat[(int)event];
8196 while ((ap = *prev_ap) != NULL)
8198 if (ap->pat != NULL)
8200 /* Accept a pattern when:
8201 * - a group was specified and it's that group, or a group was
8202 * not specified and it's the current group, or a group was
8203 * not specified and we are listing
8204 * - the length of the pattern matches
8205 * - the pattern matches.
8206 * For <buffer[=X]>, this condition works because we normalize
8207 * all buffer-local patterns.
8209 if ((allgroups || ap->group == findgroup)
8210 && ap->patlen == patlen
8211 && STRNCMP(pat, ap->pat, patlen) == 0)
8214 * Remove existing autocommands.
8215 * If adding any new autocmd's for this AutoPat, don't
8216 * delete the pattern from the autopat list, append to
8217 * this list.
8219 if (forceit)
8221 if (*cmd != NUL && ap->next == NULL)
8223 au_remove_cmds(ap);
8224 break;
8226 au_remove_pat(ap);
8230 * Show autocmd's for this autopat, or buflocals <buffer=X>
8232 else if (*cmd == NUL)
8233 show_autocmd(ap, event);
8236 * Add autocmd to this autopat, if it's the last one.
8238 else if (ap->next == NULL)
8239 break;
8242 prev_ap = &ap->next;
8246 * Add a new command.
8248 if (*cmd != NUL)
8251 * If the pattern we want to add a command to does appear at the
8252 * end of the list (or not is not in the list at all), add the
8253 * pattern at the end of the list.
8255 if (ap == NULL)
8257 /* refuse to add buffer-local ap if buffer number is invalid */
8258 if (is_buflocal && (buflocal_nr == 0
8259 || buflist_findnr(buflocal_nr) == NULL))
8261 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8262 buflocal_nr);
8263 return FAIL;
8266 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
8267 if (ap == NULL)
8268 return FAIL;
8269 ap->pat = vim_strnsave(pat, patlen);
8270 ap->patlen = patlen;
8271 if (ap->pat == NULL)
8273 vim_free(ap);
8274 return FAIL;
8277 if (is_buflocal)
8279 ap->buflocal_nr = buflocal_nr;
8280 ap->reg_prog = NULL;
8282 else
8284 char_u *reg_pat;
8286 ap->buflocal_nr = 0;
8287 reg_pat = file_pat_to_reg_pat(pat, endpat,
8288 &ap->allow_dirs, TRUE);
8289 if (reg_pat != NULL)
8290 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
8291 vim_free(reg_pat);
8292 if (reg_pat == NULL || ap->reg_prog == NULL)
8294 vim_free(ap->pat);
8295 vim_free(ap);
8296 return FAIL;
8299 ap->cmds = NULL;
8300 *prev_ap = ap;
8301 ap->next = NULL;
8302 if (group == AUGROUP_ALL)
8303 ap->group = current_augroup;
8304 else
8305 ap->group = group;
8309 * Add the autocmd at the end of the AutoCmd list.
8311 prev_ac = &(ap->cmds);
8312 while ((ac = *prev_ac) != NULL)
8313 prev_ac = &ac->next;
8314 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
8315 if (ac == NULL)
8316 return FAIL;
8317 ac->cmd = vim_strsave(cmd);
8318 #ifdef FEAT_EVAL
8319 ac->scriptID = current_SID;
8320 #endif
8321 if (ac->cmd == NULL)
8323 vim_free(ac);
8324 return FAIL;
8326 ac->next = NULL;
8327 *prev_ac = ac;
8328 ac->nested = nested;
8332 au_cleanup(); /* may really delete removed patterns/commands now */
8333 return OK;
8337 * Implementation of ":doautocmd [group] event [fname]".
8338 * Return OK for success, FAIL for failure;
8341 do_doautocmd(arg, do_msg)
8342 char_u *arg;
8343 int do_msg; /* give message for no matching autocmds? */
8345 char_u *fname;
8346 int nothing_done = TRUE;
8347 int group;
8350 * Check for a legal group name. If not, use AUGROUP_ALL.
8352 group = au_get_grouparg(&arg);
8353 if (arg == NULL) /* out of memory */
8354 return FAIL;
8356 if (*arg == '*')
8358 EMSG(_("E217: Can't execute autocommands for ALL events"));
8359 return FAIL;
8363 * Scan over the events.
8364 * If we find an illegal name, return here, don't do anything.
8366 fname = find_end_event(arg, group != AUGROUP_ALL);
8367 if (fname == NULL)
8368 return FAIL;
8370 fname = skipwhite(fname);
8373 * Loop over the events.
8375 while (*arg && !vim_iswhite(*arg))
8376 if (apply_autocmds_group(event_name2nr(arg, &arg),
8377 fname, NULL, TRUE, group, curbuf, NULL))
8378 nothing_done = FALSE;
8380 if (nothing_done && do_msg)
8381 MSG(_("No matching autocommands"));
8383 #ifdef FEAT_EVAL
8384 return aborting() ? FAIL : OK;
8385 #else
8386 return OK;
8387 #endif
8391 * ":doautoall": execute autocommands for each loaded buffer.
8393 void
8394 ex_doautoall(eap)
8395 exarg_T *eap;
8397 int retval;
8398 aco_save_T aco;
8399 buf_T *buf;
8402 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8403 * equal to curbuf, but for some buffers there may not be a window.
8404 * So we change the buffer for the current window for a moment. This
8405 * gives problems when the autocommands make changes to the list of
8406 * buffers or windows...
8408 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8410 if (buf->b_ml.ml_mfp != NULL)
8412 /* find a window for this buffer and save some values */
8413 aucmd_prepbuf(&aco, buf);
8415 /* execute the autocommands for this buffer */
8416 retval = do_doautocmd(eap->arg, FALSE);
8418 /* Execute the modeline settings, but don't set window-local
8419 * options if we are using the current window for another buffer. */
8420 do_modelines(curwin == aucmd_win ? OPT_NOWIN : 0);
8422 /* restore the current window */
8423 aucmd_restbuf(&aco);
8425 /* stop if there is some error or buffer was deleted */
8426 if (retval == FAIL || !buf_valid(buf))
8427 break;
8431 check_cursor(); /* just in case lines got deleted */
8435 * Prepare for executing autocommands for (hidden) buffer "buf".
8436 * Search for a visible window containing the current buffer. If there isn't
8437 * one then use "aucmd_win".
8438 * Set "curbuf" and "curwin" to match "buf".
8439 * When FEAT_AUTOCMD is not defined another version is used, see below.
8441 void
8442 aucmd_prepbuf(aco, buf)
8443 aco_save_T *aco; /* structure to save values in */
8444 buf_T *buf; /* new curbuf */
8446 win_T *win;
8447 #ifdef FEAT_WINDOWS
8448 int save_ea;
8449 #endif
8451 /* Find a window that is for the new buffer */
8452 if (buf == curbuf) /* be quick when buf is curbuf */
8453 win = curwin;
8454 else
8455 #ifdef FEAT_WINDOWS
8456 for (win = firstwin; win != NULL; win = win->w_next)
8457 if (win->w_buffer == buf)
8458 break;
8459 #else
8460 win = NULL;
8461 #endif
8463 /* Allocate "aucmd_win" when needed. If this fails (out of memory) fall
8464 * back to using the current window. */
8465 if (win == NULL && aucmd_win == NULL)
8467 win_alloc_aucmd_win();
8468 if (aucmd_win == NULL)
8469 win = curwin;
8471 if (win == NULL && aucmd_win_used)
8472 /* Strange recursive autocommand, fall back to using the current
8473 * window. Expect a few side effects... */
8474 win = curwin;
8476 aco->save_curwin = curwin;
8477 aco->save_curbuf = curbuf;
8478 if (win != NULL)
8480 /* There is a window for "buf" in the current tab page, make it the
8481 * curwin. This is preferred, it has the least side effects (esp. if
8482 * "buf" is curbuf). */
8483 aco->use_aucmd_win = FALSE;
8484 curwin = win;
8486 else
8488 /* There is no window for "buf", use "aucmd_win". To minimize the side
8489 * effects, insert it in a the current tab page.
8490 * Anything related to a window (e.g., setting folds) may have
8491 * unexpected results. */
8492 aco->use_aucmd_win = TRUE;
8493 aucmd_win_used = TRUE;
8494 aucmd_win->w_buffer = buf;
8495 ++buf->b_nwindows;
8496 win_init_empty(aucmd_win); /* set cursor and topline to safe values */
8497 vim_free(aucmd_win->w_localdir);
8498 aucmd_win->w_localdir = NULL;
8500 /* Make sure w_localdir and globaldir are NULL to avoid a chdir() in
8501 * win_enter_ext(). */
8502 aucmd_win->w_localdir = NULL;
8503 aco->globaldir = globaldir;
8504 globaldir = NULL;
8507 #ifdef FEAT_WINDOWS
8508 /* Split the current window, put the aucmd_win in the upper half.
8509 * We don't want the BufEnter or WinEnter autocommands. */
8510 block_autocmds();
8511 make_snapshot(SNAP_AUCMD_IDX);
8512 save_ea = p_ea;
8513 p_ea = FALSE;
8514 (void)win_split_ins(0, WSP_TOP, aucmd_win, 0);
8515 (void)win_comp_pos(); /* recompute window positions */
8516 p_ea = save_ea;
8517 unblock_autocmds();
8518 #endif
8519 curwin = aucmd_win;
8521 curbuf = buf;
8522 aco->new_curwin = curwin;
8523 aco->new_curbuf = curbuf;
8527 * Cleanup after executing autocommands for a (hidden) buffer.
8528 * Restore the window as it was (if possible).
8529 * When FEAT_AUTOCMD is not defined another version is used, see below.
8531 void
8532 aucmd_restbuf(aco)
8533 aco_save_T *aco; /* structure holding saved values */
8535 #ifdef FEAT_WINDOWS
8536 int dummy;
8537 #endif
8539 if (aco->use_aucmd_win)
8541 --curbuf->b_nwindows;
8542 #ifdef FEAT_WINDOWS
8543 /* Find "aucmd_win", it can't be closed, but it may be in another tab
8544 * page. Do not trigger autocommands here. */
8545 block_autocmds();
8546 if (curwin != aucmd_win)
8548 tabpage_T *tp;
8549 win_T *wp;
8551 FOR_ALL_TAB_WINDOWS(tp, wp)
8553 if (wp == aucmd_win)
8555 if (tp != curtab)
8556 goto_tabpage_tp(tp);
8557 win_goto(aucmd_win);
8558 break;
8563 /* Remove the window and frame from the tree of frames. */
8564 (void)winframe_remove(curwin, &dummy, NULL);
8565 win_remove(curwin, NULL);
8566 aucmd_win_used = FALSE;
8567 last_status(FALSE); /* may need to remove last status line */
8568 restore_snapshot(SNAP_AUCMD_IDX, FALSE);
8569 (void)win_comp_pos(); /* recompute window positions */
8570 unblock_autocmds();
8572 if (win_valid(aco->save_curwin))
8573 curwin = aco->save_curwin;
8574 else
8575 /* Hmm, original window disappeared. Just use the first one. */
8576 curwin = firstwin;
8577 # ifdef FEAT_EVAL
8578 vars_clear(&aucmd_win->w_vars.dv_hashtab); /* free all w: variables */
8579 # endif
8580 #else
8581 curwin = aco->save_curwin;
8582 #endif
8583 curbuf = curwin->w_buffer;
8585 vim_free(globaldir);
8586 globaldir = aco->globaldir;
8588 /* the buffer contents may have changed */
8589 check_cursor();
8590 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
8592 curwin->w_topline = curbuf->b_ml.ml_line_count;
8593 #ifdef FEAT_DIFF
8594 curwin->w_topfill = 0;
8595 #endif
8597 #if defined(FEAT_GUI)
8598 /* Hide the scrollbars from the aucmd_win and update. */
8599 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_LEFT], FALSE);
8600 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_RIGHT], FALSE);
8601 gui_may_update_scrollbars();
8602 #endif
8604 else
8606 /* restore curwin */
8607 #ifdef FEAT_WINDOWS
8608 if (win_valid(aco->save_curwin))
8609 #endif
8611 /* Restore the buffer which was previously edited by curwin, if
8612 * it was changed, we are still the same window and the buffer is
8613 * valid. */
8614 if (curwin == aco->new_curwin
8615 && curbuf != aco->new_curbuf
8616 && buf_valid(aco->new_curbuf)
8617 && aco->new_curbuf->b_ml.ml_mfp != NULL)
8619 --curbuf->b_nwindows;
8620 curbuf = aco->new_curbuf;
8621 curwin->w_buffer = curbuf;
8622 ++curbuf->b_nwindows;
8625 curwin = aco->save_curwin;
8626 curbuf = curwin->w_buffer;
8631 static int autocmd_nested = FALSE;
8634 * Execute autocommands for "event" and file name "fname".
8635 * Return TRUE if some commands were executed.
8638 apply_autocmds(event, fname, fname_io, force, buf)
8639 event_T event;
8640 char_u *fname; /* NULL or empty means use actual file name */
8641 char_u *fname_io; /* fname to use for <afile> on cmdline */
8642 int force; /* when TRUE, ignore autocmd_busy */
8643 buf_T *buf; /* buffer for <abuf> */
8645 return apply_autocmds_group(event, fname, fname_io, force,
8646 AUGROUP_ALL, buf, NULL);
8650 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8651 * setting v:filearg.
8653 static int
8654 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8655 event_T event;
8656 char_u *fname;
8657 char_u *fname_io;
8658 int force;
8659 buf_T *buf;
8660 exarg_T *eap;
8662 return apply_autocmds_group(event, fname, fname_io, force,
8663 AUGROUP_ALL, buf, eap);
8667 * Like apply_autocmds(), but handles the caller's retval. If the script
8668 * processing is being aborted or if retval is FAIL when inside a try
8669 * conditional, no autocommands are executed. If otherwise the autocommands
8670 * cause the script to be aborted, retval is set to FAIL.
8673 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8674 event_T event;
8675 char_u *fname; /* NULL or empty means use actual file name */
8676 char_u *fname_io; /* fname to use for <afile> on cmdline */
8677 int force; /* when TRUE, ignore autocmd_busy */
8678 buf_T *buf; /* buffer for <abuf> */
8679 int *retval; /* pointer to caller's retval */
8681 int did_cmd;
8683 #ifdef FEAT_EVAL
8684 if (should_abort(*retval))
8685 return FALSE;
8686 #endif
8688 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8689 AUGROUP_ALL, buf, NULL);
8690 if (did_cmd
8691 #ifdef FEAT_EVAL
8692 && aborting()
8693 #endif
8695 *retval = FAIL;
8696 return did_cmd;
8700 * Return TRUE when there is a CursorHold autocommand defined.
8703 has_cursorhold()
8705 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8706 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8710 * Return TRUE if the CursorHold event can be triggered.
8713 trigger_cursorhold()
8715 int state;
8717 if (!did_cursorhold && has_cursorhold() && !Recording
8718 #ifdef FEAT_INS_EXPAND
8719 && !ins_compl_active()
8720 #endif
8723 state = get_real_state();
8724 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8725 return TRUE;
8727 return FALSE;
8731 * Return TRUE when there is a CursorMoved autocommand defined.
8734 has_cursormoved()
8736 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8740 * Return TRUE when there is a CursorMovedI autocommand defined.
8743 has_cursormovedI()
8745 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8748 static int
8749 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8750 event_T event;
8751 char_u *fname; /* NULL or empty means use actual file name */
8752 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8753 use fname */
8754 int force; /* when TRUE, ignore autocmd_busy */
8755 int group; /* group ID, or AUGROUP_ALL */
8756 buf_T *buf; /* buffer for <abuf> */
8757 exarg_T *eap; /* command arguments */
8759 char_u *sfname = NULL; /* short file name */
8760 char_u *tail;
8761 int save_changed;
8762 buf_T *old_curbuf;
8763 int retval = FALSE;
8764 char_u *save_sourcing_name;
8765 linenr_T save_sourcing_lnum;
8766 char_u *save_autocmd_fname;
8767 int save_autocmd_fname_full;
8768 int save_autocmd_bufnr;
8769 char_u *save_autocmd_match;
8770 int save_autocmd_busy;
8771 int save_autocmd_nested;
8772 static int nesting = 0;
8773 AutoPatCmd patcmd;
8774 AutoPat *ap;
8775 #ifdef FEAT_EVAL
8776 scid_T save_current_SID;
8777 void *save_funccalp;
8778 char_u *save_cmdarg;
8779 long save_cmdbang;
8780 #endif
8781 static int filechangeshell_busy = FALSE;
8782 #ifdef FEAT_PROFILE
8783 proftime_T wait_time;
8784 #endif
8787 * Quickly return if there are no autocommands for this event or
8788 * autocommands are blocked.
8790 if (first_autopat[(int)event] == NULL || autocmd_blocked > 0)
8791 goto BYPASS_AU;
8794 * When autocommands are busy, new autocommands are only executed when
8795 * explicitly enabled with the "nested" flag.
8797 if (autocmd_busy && !(force || autocmd_nested))
8798 goto BYPASS_AU;
8800 #ifdef FEAT_EVAL
8802 * Quickly return when immediately aborting on error, or when an interrupt
8803 * occurred or an exception was thrown but not caught.
8805 if (aborting())
8806 goto BYPASS_AU;
8807 #endif
8810 * FileChangedShell never nests, because it can create an endless loop.
8812 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8813 || event == EVENT_FILECHANGEDSHELLPOST))
8814 goto BYPASS_AU;
8817 * Ignore events in 'eventignore'.
8819 if (event_ignored(event))
8820 goto BYPASS_AU;
8823 * Allow nesting of autocommands, but restrict the depth, because it's
8824 * possible to create an endless loop.
8826 if (nesting == 10)
8828 EMSG(_("E218: autocommand nesting too deep"));
8829 goto BYPASS_AU;
8833 * Check if these autocommands are disabled. Used when doing ":all" or
8834 * ":ball".
8836 if ( (autocmd_no_enter
8837 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8838 || (autocmd_no_leave
8839 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8840 goto BYPASS_AU;
8843 * Save the autocmd_* variables and info about the current buffer.
8845 save_autocmd_fname = autocmd_fname;
8846 save_autocmd_fname_full = autocmd_fname_full;
8847 save_autocmd_bufnr = autocmd_bufnr;
8848 save_autocmd_match = autocmd_match;
8849 save_autocmd_busy = autocmd_busy;
8850 save_autocmd_nested = autocmd_nested;
8851 save_changed = curbuf->b_changed;
8852 old_curbuf = curbuf;
8855 * Set the file name to be used for <afile>.
8856 * Make a copy to avoid that changing a buffer name or directory makes it
8857 * invalid.
8859 if (fname_io == NULL)
8861 if (fname != NULL && *fname != NUL)
8862 autocmd_fname = fname;
8863 else if (buf != NULL)
8864 autocmd_fname = buf->b_ffname;
8865 else
8866 autocmd_fname = NULL;
8868 else
8869 autocmd_fname = fname_io;
8870 if (autocmd_fname != NULL)
8871 autocmd_fname = vim_strsave(autocmd_fname);
8872 autocmd_fname_full = FALSE; /* call FullName_save() later */
8875 * Set the buffer number to be used for <abuf>.
8877 if (buf == NULL)
8878 autocmd_bufnr = 0;
8879 else
8880 autocmd_bufnr = buf->b_fnum;
8883 * When the file name is NULL or empty, use the file name of buffer "buf".
8884 * Always use the full path of the file name to match with, in case
8885 * "allow_dirs" is set.
8887 if (fname == NULL || *fname == NUL)
8889 if (buf == NULL)
8890 fname = NULL;
8891 else
8893 #ifdef FEAT_SYN_HL
8894 if (event == EVENT_SYNTAX)
8895 fname = buf->b_p_syn;
8896 else
8897 #endif
8898 if (event == EVENT_FILETYPE)
8899 fname = buf->b_p_ft;
8900 else
8902 if (buf->b_sfname != NULL)
8903 sfname = vim_strsave(buf->b_sfname);
8904 fname = buf->b_ffname;
8907 if (fname == NULL)
8908 fname = (char_u *)"";
8909 fname = vim_strsave(fname); /* make a copy, so we can change it */
8911 else
8913 sfname = vim_strsave(fname);
8914 /* Don't try expanding FileType, Syntax, FuncUndefined, WindowID or
8915 * QuickFixCmd* */
8916 if (event == EVENT_FILETYPE
8917 || event == EVENT_SYNTAX
8918 || event == EVENT_FUNCUNDEFINED
8919 || event == EVENT_REMOTEREPLY
8920 || event == EVENT_SPELLFILEMISSING
8921 || event == EVENT_QUICKFIXCMDPRE
8922 || event == EVENT_QUICKFIXCMDPOST)
8923 fname = vim_strsave(fname);
8924 else
8925 fname = FullName_save(fname, FALSE);
8927 if (fname == NULL) /* out of memory */
8929 vim_free(sfname);
8930 retval = FALSE;
8931 goto BYPASS_AU;
8934 #ifdef BACKSLASH_IN_FILENAME
8936 * Replace all backslashes with forward slashes. This makes the
8937 * autocommand patterns portable between Unix and MS-DOS.
8939 if (sfname != NULL)
8940 forward_slash(sfname);
8941 forward_slash(fname);
8942 #endif
8944 #ifdef VMS
8945 /* remove version for correct match */
8946 if (sfname != NULL)
8947 vms_remove_version(sfname);
8948 vms_remove_version(fname);
8949 #endif
8952 * Set the name to be used for <amatch>.
8954 autocmd_match = fname;
8957 /* Don't redraw while doing auto commands. */
8958 ++RedrawingDisabled;
8959 save_sourcing_name = sourcing_name;
8960 sourcing_name = NULL; /* don't free this one */
8961 save_sourcing_lnum = sourcing_lnum;
8962 sourcing_lnum = 0; /* no line number here */
8964 #ifdef FEAT_EVAL
8965 save_current_SID = current_SID;
8967 # ifdef FEAT_PROFILE
8968 if (do_profiling == PROF_YES)
8969 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
8970 # endif
8972 /* Don't use local function variables, if called from a function */
8973 save_funccalp = save_funccal();
8974 #endif
8977 * When starting to execute autocommands, save the search patterns.
8979 if (!autocmd_busy)
8981 save_search_patterns();
8982 saveRedobuff();
8983 did_filetype = keep_filetype;
8987 * Note that we are applying autocmds. Some commands need to know.
8989 autocmd_busy = TRUE;
8990 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
8991 ++nesting; /* see matching decrement below */
8993 /* Remember that FileType was triggered. Used for did_filetype(). */
8994 if (event == EVENT_FILETYPE)
8995 did_filetype = TRUE;
8997 tail = gettail(fname);
8999 /* Find first autocommand that matches */
9000 patcmd.curpat = first_autopat[(int)event];
9001 patcmd.nextcmd = NULL;
9002 patcmd.group = group;
9003 patcmd.fname = fname;
9004 patcmd.sfname = sfname;
9005 patcmd.tail = tail;
9006 patcmd.event = event;
9007 patcmd.arg_bufnr = autocmd_bufnr;
9008 patcmd.next = NULL;
9009 auto_next_pat(&patcmd, FALSE);
9011 /* found one, start executing the autocommands */
9012 if (patcmd.curpat != NULL)
9014 /* add to active_apc_list */
9015 patcmd.next = active_apc_list;
9016 active_apc_list = &patcmd;
9018 #ifdef FEAT_EVAL
9019 /* set v:cmdarg (only when there is a matching pattern) */
9020 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
9021 if (eap != NULL)
9023 save_cmdarg = set_cmdarg(eap, NULL);
9024 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
9026 else
9027 save_cmdarg = NULL; /* avoid gcc warning */
9028 #endif
9029 retval = TRUE;
9030 /* mark the last pattern, to avoid an endless loop when more patterns
9031 * are added when executing autocommands */
9032 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
9033 ap->last = FALSE;
9034 ap->last = TRUE;
9035 check_lnums(TRUE); /* make sure cursor and topline are valid */
9036 do_cmdline(NULL, getnextac, (void *)&patcmd,
9037 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
9038 #ifdef FEAT_EVAL
9039 if (eap != NULL)
9041 (void)set_cmdarg(NULL, save_cmdarg);
9042 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
9044 #endif
9045 /* delete from active_apc_list */
9046 if (active_apc_list == &patcmd) /* just in case */
9047 active_apc_list = patcmd.next;
9050 --RedrawingDisabled;
9051 autocmd_busy = save_autocmd_busy;
9052 filechangeshell_busy = FALSE;
9053 autocmd_nested = save_autocmd_nested;
9054 vim_free(sourcing_name);
9055 sourcing_name = save_sourcing_name;
9056 sourcing_lnum = save_sourcing_lnum;
9057 vim_free(autocmd_fname);
9058 autocmd_fname = save_autocmd_fname;
9059 autocmd_fname_full = save_autocmd_fname_full;
9060 autocmd_bufnr = save_autocmd_bufnr;
9061 autocmd_match = save_autocmd_match;
9062 #ifdef FEAT_EVAL
9063 current_SID = save_current_SID;
9064 restore_funccal(save_funccalp);
9065 # ifdef FEAT_PROFILE
9066 if (do_profiling == PROF_YES)
9067 prof_child_exit(&wait_time);
9068 # endif
9069 #endif
9070 vim_free(fname);
9071 vim_free(sfname);
9072 --nesting; /* see matching increment above */
9075 * When stopping to execute autocommands, restore the search patterns and
9076 * the redo buffer.
9078 if (!autocmd_busy)
9080 restore_search_patterns();
9081 restoreRedobuff();
9082 did_filetype = FALSE;
9086 * Some events don't set or reset the Changed flag.
9087 * Check if still in the same buffer!
9089 if (curbuf == old_curbuf
9090 && (event == EVENT_BUFREADPOST
9091 || event == EVENT_BUFWRITEPOST
9092 || event == EVENT_FILEAPPENDPOST
9093 || event == EVENT_VIMLEAVE
9094 || event == EVENT_VIMLEAVEPRE))
9096 #ifdef FEAT_TITLE
9097 if (curbuf->b_changed != save_changed)
9098 need_maketitle = TRUE;
9099 #endif
9100 curbuf->b_changed = save_changed;
9103 au_cleanup(); /* may really delete removed patterns/commands now */
9105 BYPASS_AU:
9106 /* When wiping out a buffer make sure all its buffer-local autocommands
9107 * are deleted. */
9108 if (event == EVENT_BUFWIPEOUT && buf != NULL)
9109 aubuflocal_remove(buf);
9111 return retval;
9114 # ifdef FEAT_EVAL
9115 static char_u *old_termresponse = NULL;
9116 # endif
9119 * Block triggering autocommands until unblock_autocmd() is called.
9120 * Can be used recursively, so long as it's symmetric.
9122 void
9123 block_autocmds()
9125 # ifdef FEAT_EVAL
9126 /* Remember the value of v:termresponse. */
9127 if (autocmd_blocked == 0)
9128 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
9129 # endif
9130 ++autocmd_blocked;
9133 void
9134 unblock_autocmds()
9136 --autocmd_blocked;
9138 # ifdef FEAT_EVAL
9139 /* When v:termresponse was set while autocommands were blocked, trigger
9140 * the autocommands now. Esp. useful when executing a shell command
9141 * during startup (vimdiff). */
9142 if (autocmd_blocked == 0
9143 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
9144 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
9145 # endif
9149 * Find next autocommand pattern that matches.
9151 static void
9152 auto_next_pat(apc, stop_at_last)
9153 AutoPatCmd *apc;
9154 int stop_at_last; /* stop when 'last' flag is set */
9156 AutoPat *ap;
9157 AutoCmd *cp;
9158 char_u *name;
9159 char *s;
9161 vim_free(sourcing_name);
9162 sourcing_name = NULL;
9164 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
9166 apc->curpat = NULL;
9168 /* Only use a pattern when it has not been removed, has commands and
9169 * the group matches. For buffer-local autocommands only check the
9170 * buffer number. */
9171 if (ap->pat != NULL && ap->cmds != NULL
9172 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
9174 /* execution-condition */
9175 if (ap->buflocal_nr == 0
9176 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
9177 apc->sfname, apc->tail, ap->allow_dirs))
9178 : ap->buflocal_nr == apc->arg_bufnr)
9180 name = event_nr2name(apc->event);
9181 s = _("%s Auto commands for \"%s\"");
9182 sourcing_name = alloc((unsigned)(STRLEN(s)
9183 + STRLEN(name) + ap->patlen + 1));
9184 if (sourcing_name != NULL)
9186 sprintf((char *)sourcing_name, s,
9187 (char *)name, (char *)ap->pat);
9188 if (p_verbose >= 8)
9190 verbose_enter();
9191 smsg((char_u *)_("Executing %s"), sourcing_name);
9192 verbose_leave();
9196 apc->curpat = ap;
9197 apc->nextcmd = ap->cmds;
9198 /* mark last command */
9199 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
9200 cp->last = FALSE;
9201 cp->last = TRUE;
9203 line_breakcheck();
9204 if (apc->curpat != NULL) /* found a match */
9205 break;
9207 if (stop_at_last && ap->last)
9208 break;
9213 * Get next autocommand command.
9214 * Called by do_cmdline() to get the next line for ":if".
9215 * Returns allocated string, or NULL for end of autocommands.
9217 static char_u *
9218 getnextac(c, cookie, indent)
9219 int c UNUSED;
9220 void *cookie;
9221 int indent UNUSED;
9223 AutoPatCmd *acp = (AutoPatCmd *)cookie;
9224 char_u *retval;
9225 AutoCmd *ac;
9227 /* Can be called again after returning the last line. */
9228 if (acp->curpat == NULL)
9229 return NULL;
9231 /* repeat until we find an autocommand to execute */
9232 for (;;)
9234 /* skip removed commands */
9235 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
9236 if (acp->nextcmd->last)
9237 acp->nextcmd = NULL;
9238 else
9239 acp->nextcmd = acp->nextcmd->next;
9241 if (acp->nextcmd != NULL)
9242 break;
9244 /* at end of commands, find next pattern that matches */
9245 if (acp->curpat->last)
9246 acp->curpat = NULL;
9247 else
9248 acp->curpat = acp->curpat->next;
9249 if (acp->curpat != NULL)
9250 auto_next_pat(acp, TRUE);
9251 if (acp->curpat == NULL)
9252 return NULL;
9255 ac = acp->nextcmd;
9257 if (p_verbose >= 9)
9259 verbose_enter_scroll();
9260 smsg((char_u *)_("autocommand %s"), ac->cmd);
9261 msg_puts((char_u *)"\n"); /* don't overwrite this either */
9262 verbose_leave_scroll();
9264 retval = vim_strsave(ac->cmd);
9265 autocmd_nested = ac->nested;
9266 #ifdef FEAT_EVAL
9267 current_SID = ac->scriptID;
9268 #endif
9269 if (ac->last)
9270 acp->nextcmd = NULL;
9271 else
9272 acp->nextcmd = ac->next;
9273 return retval;
9277 * Return TRUE if there is a matching autocommand for "fname".
9278 * To account for buffer-local autocommands, function needs to know
9279 * in which buffer the file will be opened.
9282 has_autocmd(event, sfname, buf)
9283 event_T event;
9284 char_u *sfname;
9285 buf_T *buf;
9287 AutoPat *ap;
9288 char_u *fname;
9289 char_u *tail = gettail(sfname);
9290 int retval = FALSE;
9292 fname = FullName_save(sfname, FALSE);
9293 if (fname == NULL)
9294 return FALSE;
9296 #ifdef BACKSLASH_IN_FILENAME
9298 * Replace all backslashes with forward slashes. This makes the
9299 * autocommand patterns portable between Unix and MS-DOS.
9301 sfname = vim_strsave(sfname);
9302 if (sfname != NULL)
9303 forward_slash(sfname);
9304 forward_slash(fname);
9305 #endif
9307 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
9308 if (ap->pat != NULL && ap->cmds != NULL
9309 && (ap->buflocal_nr == 0
9310 ? match_file_pat(NULL, ap->reg_prog,
9311 fname, sfname, tail, ap->allow_dirs)
9312 : buf != NULL && ap->buflocal_nr == buf->b_fnum
9315 retval = TRUE;
9316 break;
9319 vim_free(fname);
9320 #ifdef BACKSLASH_IN_FILENAME
9321 vim_free(sfname);
9322 #endif
9324 return retval;
9327 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9329 * Function given to ExpandGeneric() to obtain the list of autocommand group
9330 * names.
9332 char_u *
9333 get_augroup_name(xp, idx)
9334 expand_T *xp UNUSED;
9335 int idx;
9337 if (idx == augroups.ga_len) /* add "END" add the end */
9338 return (char_u *)"END";
9339 if (idx >= augroups.ga_len) /* end of list */
9340 return NULL;
9341 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
9342 return (char_u *)"";
9343 return AUGROUP_NAME(idx); /* return a name */
9346 static int include_groups = FALSE;
9348 char_u *
9349 set_context_in_autocmd(xp, arg, doautocmd)
9350 expand_T *xp;
9351 char_u *arg;
9352 int doautocmd; /* TRUE for :doauto*, FALSE for :autocmd */
9354 char_u *p;
9355 int group;
9357 /* check for a group name, skip it if present */
9358 include_groups = FALSE;
9359 p = arg;
9360 group = au_get_grouparg(&arg);
9361 if (group == AUGROUP_ERROR)
9362 return NULL;
9363 /* If there only is a group name that's what we expand. */
9364 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
9366 arg = p;
9367 group = AUGROUP_ALL;
9370 /* skip over event name */
9371 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
9372 if (*p == ',')
9373 arg = p + 1;
9374 if (*p == NUL)
9376 if (group == AUGROUP_ALL)
9377 include_groups = TRUE;
9378 xp->xp_context = EXPAND_EVENTS; /* expand event name */
9379 xp->xp_pattern = arg;
9380 return NULL;
9383 /* skip over pattern */
9384 arg = skipwhite(p);
9385 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
9386 arg++;
9387 if (*arg)
9388 return arg; /* expand (next) command */
9390 if (doautocmd)
9391 xp->xp_context = EXPAND_FILES; /* expand file names */
9392 else
9393 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
9394 return NULL;
9398 * Function given to ExpandGeneric() to obtain the list of event names.
9400 char_u *
9401 get_event_name(xp, idx)
9402 expand_T *xp UNUSED;
9403 int idx;
9405 if (idx < augroups.ga_len) /* First list group names, if wanted */
9407 if (!include_groups || AUGROUP_NAME(idx) == NULL)
9408 return (char_u *)""; /* skip deleted entries */
9409 return AUGROUP_NAME(idx); /* return a name */
9411 return (char_u *)event_names[idx - augroups.ga_len].name;
9414 #endif /* FEAT_CMDL_COMPL */
9417 * Return TRUE if autocmd is supported.
9420 autocmd_supported(name)
9421 char_u *name;
9423 char_u *p;
9425 return (event_name2nr(name, &p) != NUM_EVENTS);
9429 * Return TRUE if an autocommand is defined for a group, event and
9430 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9431 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9432 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9433 * Used for:
9434 * exists("#Group") or
9435 * exists("#Group#Event") or
9436 * exists("#Group#Event#pat") or
9437 * exists("#Event") or
9438 * exists("#Event#pat")
9441 au_exists(arg)
9442 char_u *arg;
9444 char_u *arg_save;
9445 char_u *pattern = NULL;
9446 char_u *event_name;
9447 char_u *p;
9448 event_T event;
9449 AutoPat *ap;
9450 buf_T *buflocal_buf = NULL;
9451 int group;
9452 int retval = FALSE;
9454 /* Make a copy so that we can change the '#' chars to a NUL. */
9455 arg_save = vim_strsave(arg);
9456 if (arg_save == NULL)
9457 return FALSE;
9458 p = vim_strchr(arg_save, '#');
9459 if (p != NULL)
9460 *p++ = NUL;
9462 /* First, look for an autocmd group name */
9463 group = au_find_group(arg_save);
9464 if (group == AUGROUP_ERROR)
9466 /* Didn't match a group name, assume the first argument is an event. */
9467 group = AUGROUP_ALL;
9468 event_name = arg_save;
9470 else
9472 if (p == NULL)
9474 /* "Group": group name is present and it's recognized */
9475 retval = TRUE;
9476 goto theend;
9479 /* Must be "Group#Event" or "Group#Event#pat". */
9480 event_name = p;
9481 p = vim_strchr(event_name, '#');
9482 if (p != NULL)
9483 *p++ = NUL; /* "Group#Event#pat" */
9486 pattern = p; /* "pattern" is NULL when there is no pattern */
9488 /* find the index (enum) for the event name */
9489 event = event_name2nr(event_name, &p);
9491 /* return FALSE if the event name is not recognized */
9492 if (event == NUM_EVENTS)
9493 goto theend;
9495 /* Find the first autocommand for this event.
9496 * If there isn't any, return FALSE;
9497 * If there is one and no pattern given, return TRUE; */
9498 ap = first_autopat[(int)event];
9499 if (ap == NULL)
9500 goto theend;
9502 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9503 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9504 if (pattern != NULL && STRICMP(pattern, "<buffer>") == 0)
9505 buflocal_buf = curbuf;
9507 /* Check if there is an autocommand with the given pattern. */
9508 for ( ; ap != NULL; ap = ap->next)
9509 /* only use a pattern when it has not been removed and has commands. */
9510 /* For buffer-local autocommands, fnamecmp() works fine. */
9511 if (ap->pat != NULL && ap->cmds != NULL
9512 && (group == AUGROUP_ALL || ap->group == group)
9513 && (pattern == NULL
9514 || (buflocal_buf == NULL
9515 ? fnamecmp(ap->pat, pattern) == 0
9516 : ap->buflocal_nr == buflocal_buf->b_fnum)))
9518 retval = TRUE;
9519 break;
9522 theend:
9523 vim_free(arg_save);
9524 return retval;
9527 #else /* FEAT_AUTOCMD */
9530 * Prepare for executing commands for (hidden) buffer "buf".
9531 * This is the non-autocommand version, it simply saves "curbuf" and sets
9532 * "curbuf" and "curwin" to match "buf".
9534 void
9535 aucmd_prepbuf(aco, buf)
9536 aco_save_T *aco; /* structure to save values in */
9537 buf_T *buf; /* new curbuf */
9539 aco->save_curbuf = curbuf;
9540 --curbuf->b_nwindows;
9541 curbuf = buf;
9542 curwin->w_buffer = buf;
9543 ++curbuf->b_nwindows;
9547 * Restore after executing commands for a (hidden) buffer.
9548 * This is the non-autocommand version.
9550 void
9551 aucmd_restbuf(aco)
9552 aco_save_T *aco; /* structure holding saved values */
9554 --curbuf->b_nwindows;
9555 curbuf = aco->save_curbuf;
9556 curwin->w_buffer = curbuf;
9557 ++curbuf->b_nwindows;
9560 #endif /* FEAT_AUTOCMD */
9563 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9565 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9566 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9567 * vim_regcomp() often.
9568 * Used for autocommands and 'wildignore'.
9569 * Returns TRUE if there is a match, FALSE otherwise.
9572 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9573 char_u *pattern; /* pattern to match with */
9574 regprog_T *prog; /* pre-compiled regprog or NULL */
9575 char_u *fname; /* full path of file name */
9576 char_u *sfname; /* short file name or NULL */
9577 char_u *tail; /* tail of path */
9578 int allow_dirs; /* allow matching with dir */
9580 regmatch_T regmatch;
9581 int result = FALSE;
9582 #ifdef FEAT_OSFILETYPE
9583 int no_pattern = FALSE; /* TRUE if check is filetype only */
9584 char_u *type_start;
9585 char_u c;
9586 int match = FALSE;
9587 #endif
9589 #ifdef CASE_INSENSITIVE_FILENAME
9590 regmatch.rm_ic = TRUE; /* Always ignore case */
9591 #else
9592 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9593 #endif
9594 #ifdef FEAT_OSFILETYPE
9595 if (*pattern == '<')
9597 /* There is a filetype condition specified with this pattern.
9598 * Check the filetype matches first. If not, don't bother with the
9599 * pattern (set regprog to NULL).
9600 * Always use magic for the regexp.
9603 for (type_start = pattern + 1; (c = *pattern); pattern++)
9605 if ((c == ';' || c == '>') && match == FALSE)
9607 *pattern = NUL; /* Terminate the string */
9608 match = mch_check_filetype(fname, type_start);
9609 *pattern = c; /* Restore the terminator */
9610 type_start = pattern + 1;
9612 if (c == '>')
9613 break;
9616 /* (c should never be NUL, but check anyway) */
9617 if (match == FALSE || c == NUL)
9618 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9619 else if (*pattern == NUL)
9621 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9622 no_pattern = TRUE; /* Always matches - don't check pat. */
9624 else
9625 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9627 else
9628 #endif
9630 if (prog != NULL)
9631 regmatch.regprog = prog;
9632 else
9633 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9637 * Try for a match with the pattern with:
9638 * 1. the full file name, when the pattern has a '/'.
9639 * 2. the short file name, when the pattern has a '/'.
9640 * 3. the tail of the file name, when the pattern has no '/'.
9642 if (
9643 #ifdef FEAT_OSFILETYPE
9644 /* If the check is for a filetype only and we don't care
9645 * about the path then skip all the regexp stuff.
9647 no_pattern ||
9648 #endif
9649 (regmatch.regprog != NULL
9650 && ((allow_dirs
9651 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9652 || (sfname != NULL
9653 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9654 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9655 result = TRUE;
9657 if (prog == NULL)
9658 vim_free(regmatch.regprog);
9659 return result;
9661 #endif
9663 #if defined(FEAT_WILDIGN) || defined(PROTO)
9665 * Return TRUE if a file matches with a pattern in "list".
9666 * "list" is a comma-separated list of patterns, like 'wildignore'.
9667 * "sfname" is the short file name or NULL, "ffname" the long file name.
9670 match_file_list(list, sfname, ffname)
9671 char_u *list;
9672 char_u *sfname;
9673 char_u *ffname;
9675 char_u buf[100];
9676 char_u *tail;
9677 char_u *regpat;
9678 char allow_dirs;
9679 int match;
9680 char_u *p;
9682 tail = gettail(sfname);
9684 /* try all patterns in 'wildignore' */
9685 p = list;
9686 while (*p)
9688 copy_option_part(&p, buf, 100, ",");
9689 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9690 if (regpat == NULL)
9691 break;
9692 match = match_file_pat(regpat, NULL, ffname, sfname,
9693 tail, (int)allow_dirs);
9694 vim_free(regpat);
9695 if (match)
9696 return TRUE;
9698 return FALSE;
9700 #endif
9703 * Convert the given pattern "pat" which has shell style wildcards in it, into
9704 * a regular expression, and return the result in allocated memory. If there
9705 * is a directory path separator to be matched, then TRUE is put in
9706 * allow_dirs, otherwise FALSE is put there -- webb.
9707 * Handle backslashes before special characters, like "\*" and "\ ".
9709 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9710 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9712 * Returns NULL when out of memory.
9714 char_u *
9715 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9716 char_u *pat;
9717 char_u *pat_end; /* first char after pattern or NULL */
9718 char *allow_dirs; /* Result passed back out in here */
9719 int no_bslash UNUSED; /* Don't use a backward slash as pathsep */
9721 int size;
9722 char_u *endp;
9723 char_u *reg_pat;
9724 char_u *p;
9725 int i;
9726 int nested = 0;
9727 int add_dollar = TRUE;
9728 #ifdef FEAT_OSFILETYPE
9729 int check_length = 0;
9730 #endif
9732 if (allow_dirs != NULL)
9733 *allow_dirs = FALSE;
9734 if (pat_end == NULL)
9735 pat_end = pat + STRLEN(pat);
9737 #ifdef FEAT_OSFILETYPE
9738 /* Find out how much of the string is the filetype check */
9739 if (*pat == '<')
9741 /* Count chars until the next '>' */
9742 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9744 if (p < pat_end)
9746 /* Pattern is of the form <.*>.* */
9747 check_length = p - pat + 1;
9748 if (p + 1 >= pat_end)
9750 /* The 'pattern' is a filetype check ONLY */
9751 reg_pat = (char_u *)alloc(check_length + 1);
9752 if (reg_pat != NULL)
9754 mch_memmove(reg_pat, pat, (size_t)check_length);
9755 reg_pat[check_length] = NUL;
9757 return reg_pat;
9760 /* else: there was no closing '>' - assume it was a normal pattern */
9763 pat += check_length;
9764 size = 2 + check_length;
9765 #else
9766 size = 2; /* '^' at start, '$' at end */
9767 #endif
9769 for (p = pat; p < pat_end; p++)
9771 switch (*p)
9773 case '*':
9774 case '.':
9775 case ',':
9776 case '{':
9777 case '}':
9778 case '~':
9779 size += 2; /* extra backslash */
9780 break;
9781 #ifdef BACKSLASH_IN_FILENAME
9782 case '\\':
9783 case '/':
9784 size += 4; /* could become "[\/]" */
9785 break;
9786 #endif
9787 default:
9788 size++;
9789 # ifdef FEAT_MBYTE
9790 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9792 ++p;
9793 ++size;
9795 # endif
9796 break;
9799 reg_pat = alloc(size + 1);
9800 if (reg_pat == NULL)
9801 return NULL;
9803 #ifdef FEAT_OSFILETYPE
9804 /* Copy the type check in to the start. */
9805 if (check_length)
9806 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9807 i = check_length;
9808 #else
9809 i = 0;
9810 #endif
9812 if (pat[0] == '*')
9813 while (pat[0] == '*' && pat < pat_end - 1)
9814 pat++;
9815 else
9816 reg_pat[i++] = '^';
9817 endp = pat_end - 1;
9818 if (*endp == '*')
9820 while (endp - pat > 0 && *endp == '*')
9821 endp--;
9822 add_dollar = FALSE;
9824 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9826 switch (*p)
9828 case '*':
9829 reg_pat[i++] = '.';
9830 reg_pat[i++] = '*';
9831 while (p[1] == '*') /* "**" matches like "*" */
9832 ++p;
9833 break;
9834 case '.':
9835 #ifdef RISCOS
9836 if (allow_dirs != NULL)
9837 *allow_dirs = TRUE;
9838 /* FALLTHROUGH */
9839 #endif
9840 case '~':
9841 reg_pat[i++] = '\\';
9842 reg_pat[i++] = *p;
9843 break;
9844 case '?':
9845 #ifdef RISCOS
9846 case '#':
9847 #endif
9848 reg_pat[i++] = '.';
9849 break;
9850 case '\\':
9851 if (p[1] == NUL)
9852 break;
9853 #ifdef BACKSLASH_IN_FILENAME
9854 if (!no_bslash)
9856 /* translate:
9857 * "\x" to "\\x" e.g., "dir\file"
9858 * "\*" to "\\.*" e.g., "dir\*.c"
9859 * "\?" to "\\." e.g., "dir\??.c"
9860 * "\+" to "\+" e.g., "fileX\+.c"
9862 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9863 && p[1] != '+')
9865 reg_pat[i++] = '[';
9866 reg_pat[i++] = '\\';
9867 reg_pat[i++] = '/';
9868 reg_pat[i++] = ']';
9869 if (allow_dirs != NULL)
9870 *allow_dirs = TRUE;
9871 break;
9874 #endif
9875 if (*++p == '?'
9876 #ifdef BACKSLASH_IN_FILENAME
9877 && no_bslash
9878 #endif
9880 reg_pat[i++] = '?';
9881 else
9882 if (*p == ',')
9883 reg_pat[i++] = ',';
9884 else
9886 if (allow_dirs != NULL && vim_ispathsep(*p)
9887 #ifdef BACKSLASH_IN_FILENAME
9888 && (!no_bslash || *p != '\\')
9889 #endif
9891 *allow_dirs = TRUE;
9892 reg_pat[i++] = '\\';
9893 reg_pat[i++] = *p;
9895 break;
9896 #ifdef BACKSLASH_IN_FILENAME
9897 case '/':
9898 reg_pat[i++] = '[';
9899 reg_pat[i++] = '\\';
9900 reg_pat[i++] = '/';
9901 reg_pat[i++] = ']';
9902 if (allow_dirs != NULL)
9903 *allow_dirs = TRUE;
9904 break;
9905 #endif
9906 case '{':
9907 reg_pat[i++] = '\\';
9908 reg_pat[i++] = '(';
9909 nested++;
9910 break;
9911 case '}':
9912 reg_pat[i++] = '\\';
9913 reg_pat[i++] = ')';
9914 --nested;
9915 break;
9916 case ',':
9917 if (nested)
9919 reg_pat[i++] = '\\';
9920 reg_pat[i++] = '|';
9922 else
9923 reg_pat[i++] = ',';
9924 break;
9925 default:
9926 # ifdef FEAT_MBYTE
9927 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9928 reg_pat[i++] = *p++;
9929 else
9930 # endif
9931 if (allow_dirs != NULL && vim_ispathsep(*p))
9932 *allow_dirs = TRUE;
9933 reg_pat[i++] = *p;
9934 break;
9937 if (add_dollar)
9938 reg_pat[i++] = '$';
9939 reg_pat[i] = NUL;
9940 if (nested != 0)
9942 if (nested < 0)
9943 EMSG(_("E219: Missing {."));
9944 else
9945 EMSG(_("E220: Missing }."));
9946 vim_free(reg_pat);
9947 reg_pat = NULL;
9949 return reg_pat;