Snapshot 44
[MacVim.git] / src / fileio.c
blob3c69a34043b61a1ddada700f2b54a3bdd7e24579
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * fileio.c: read from and write to a file
14 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
15 # include "vimio.h" /* for lseek(), must be before vim.h */
16 #endif
18 #if defined __EMX__
19 # include "vimio.h" /* for mktemp(), CJW 1997-12-03 */
20 #endif
22 #include "vim.h"
24 #ifdef __TANDEM
25 # include <limits.h> /* for SSIZE_MAX */
26 #endif
28 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
29 # include <utime.h> /* for struct utimbuf */
30 #endif
32 #define BUFSIZE 8192 /* size of normal write buffer */
33 #define SMBUFSIZE 256 /* size of emergency write buffer */
35 #ifdef FEAT_CRYPT
36 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
37 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
38 #endif
40 /* Is there any system that doesn't have access()? */
41 #define USE_MCH_ACCESS
43 #if defined(sun) && defined(S_ISCHR)
44 # define OPEN_CHR_FILES
45 static int is_dev_fd_file(char_u *fname);
46 #endif
47 #ifdef FEAT_MBYTE
48 static char_u *next_fenc __ARGS((char_u **pp));
49 # ifdef FEAT_EVAL
50 static char_u *readfile_charconvert __ARGS((char_u *fname, char_u *fenc, int *fdp));
51 # endif
52 #endif
53 #ifdef FEAT_VIMINFO
54 static void check_marks_read __ARGS((void));
55 #endif
56 #ifdef FEAT_CRYPT
57 static char_u *check_for_cryptkey __ARGS((char_u *cryptkey, char_u *ptr, long *sizep, long *filesizep, int newfile));
58 #endif
59 #ifdef UNIX
60 static void set_file_time __ARGS((char_u *fname, time_t atime, time_t mtime));
61 #endif
62 static int set_rw_fname __ARGS((char_u *fname, char_u *sfname));
63 static int msg_add_fileformat __ARGS((int eol_type));
64 static void msg_add_eol __ARGS((void));
65 static int check_mtime __ARGS((buf_T *buf, struct stat *s));
66 static int time_differs __ARGS((long t1, long t2));
67 #ifdef FEAT_AUTOCMD
68 static int apply_autocmds_exarg __ARGS((event_T event, char_u *fname, char_u *fname_io, int force, buf_T *buf, exarg_T *eap));
69 static int au_find_group __ARGS((char_u *name));
71 # define AUGROUP_DEFAULT -1 /* default autocmd group */
72 # define AUGROUP_ERROR -2 /* erroneous autocmd group */
73 # define AUGROUP_ALL -3 /* all autocmd groups */
74 #endif
76 #if defined(FEAT_CRYPT) || defined(FEAT_MBYTE)
77 # define HAS_BW_FLAGS
78 # define FIO_LATIN1 0x01 /* convert Latin1 */
79 # define FIO_UTF8 0x02 /* convert UTF-8 */
80 # define FIO_UCS2 0x04 /* convert UCS-2 */
81 # define FIO_UCS4 0x08 /* convert UCS-4 */
82 # define FIO_UTF16 0x10 /* convert UTF-16 */
83 # ifdef WIN3264
84 # define FIO_CODEPAGE 0x20 /* convert MS-Windows codepage */
85 # define FIO_PUT_CP(x) (((x) & 0xffff) << 16) /* put codepage in top word */
86 # define FIO_GET_CP(x) (((x)>>16) & 0xffff) /* get codepage from top word */
87 # endif
88 # ifdef MACOS_X
89 # define FIO_MACROMAN 0x20 /* convert MacRoman */
90 # endif
91 # define FIO_ENDIAN_L 0x80 /* little endian */
92 # define FIO_ENCRYPTED 0x1000 /* encrypt written bytes */
93 # define FIO_NOCONVERT 0x2000 /* skip encoding conversion */
94 # define FIO_UCSBOM 0x4000 /* check for BOM at start of file */
95 # define FIO_ALL -1 /* allow all formats */
96 #endif
98 /* When converting, a read() or write() may leave some bytes to be converted
99 * for the next call. The value is guessed... */
100 #define CONV_RESTLEN 30
102 /* We have to guess how much a sequence of bytes may expand when converting
103 * with iconv() to be able to allocate a buffer. */
104 #define ICONV_MULT 8
107 * Structure to pass arguments from buf_write() to buf_write_bytes().
109 struct bw_info
111 int bw_fd; /* file descriptor */
112 char_u *bw_buf; /* buffer with data to be written */
113 int bw_len; /* length of data */
114 #ifdef HAS_BW_FLAGS
115 int bw_flags; /* FIO_ flags */
116 #endif
117 #ifdef FEAT_MBYTE
118 char_u bw_rest[CONV_RESTLEN]; /* not converted bytes */
119 int bw_restlen; /* nr of bytes in bw_rest[] */
120 int bw_first; /* first write call */
121 char_u *bw_conv_buf; /* buffer for writing converted chars */
122 int bw_conv_buflen; /* size of bw_conv_buf */
123 int bw_conv_error; /* set for conversion error */
124 # ifdef USE_ICONV
125 iconv_t bw_iconv_fd; /* descriptor for iconv() or -1 */
126 # endif
127 #endif
130 static int buf_write_bytes __ARGS((struct bw_info *ip));
132 #ifdef FEAT_MBYTE
133 static linenr_T readfile_linenr __ARGS((linenr_T linecnt, char_u *p, char_u *endp));
134 static int ucs2bytes __ARGS((unsigned c, char_u **pp, int flags));
135 static int same_encoding __ARGS((char_u *a, char_u *b));
136 static int get_fio_flags __ARGS((char_u *ptr));
137 static char_u *check_for_bom __ARGS((char_u *p, long size, int *lenp, int flags));
138 static int make_bom __ARGS((char_u *buf, char_u *name));
139 # ifdef WIN3264
140 static int get_win_fio_flags __ARGS((char_u *ptr));
141 # endif
142 # ifdef MACOS_X
143 static int get_mac_fio_flags __ARGS((char_u *ptr));
144 # endif
145 #endif
146 static int move_lines __ARGS((buf_T *frombuf, buf_T *tobuf));
147 #ifdef FEAT_AUTOCMD
148 static char *e_auchangedbuf = N_("E812: Autocommands changed buffer or buffer name");
149 #endif
151 void
152 filemess(buf, name, s, attr)
153 buf_T *buf;
154 char_u *name;
155 char_u *s;
156 int attr;
158 int msg_scroll_save;
160 if (msg_silent != 0)
161 return;
162 msg_add_fname(buf, name); /* put file name in IObuff with quotes */
163 /* If it's extremely long, truncate it. */
164 if (STRLEN(IObuff) > IOSIZE - 80)
165 IObuff[IOSIZE - 80] = NUL;
166 STRCAT(IObuff, s);
168 * For the first message may have to start a new line.
169 * For further ones overwrite the previous one, reset msg_scroll before
170 * calling filemess().
172 msg_scroll_save = msg_scroll;
173 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
174 msg_scroll = FALSE;
175 if (!msg_scroll) /* wait a bit when overwriting an error msg */
176 check_for_delay(FALSE);
177 msg_start();
178 msg_scroll = msg_scroll_save;
179 msg_scrolled_ign = TRUE;
180 /* may truncate the message to avoid a hit-return prompt */
181 msg_outtrans_attr(msg_may_trunc(FALSE, IObuff), attr);
182 msg_clr_eos();
183 out_flush();
184 msg_scrolled_ign = FALSE;
188 * Read lines from file "fname" into the buffer after line "from".
190 * 1. We allocate blocks with lalloc, as big as possible.
191 * 2. Each block is filled with characters from the file with a single read().
192 * 3. The lines are inserted in the buffer with ml_append().
194 * (caller must check that fname != NULL, unless READ_STDIN is used)
196 * "lines_to_skip" is the number of lines that must be skipped
197 * "lines_to_read" is the number of lines that are appended
198 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
200 * flags:
201 * READ_NEW starting to edit a new buffer
202 * READ_FILTER reading filter output
203 * READ_STDIN read from stdin instead of a file
204 * READ_BUFFER read from curbuf instead of a file (converting after reading
205 * stdin)
206 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
208 * return FAIL for failure, OK otherwise
211 readfile(fname, sfname, from, lines_to_skip, lines_to_read, eap, flags)
212 char_u *fname;
213 char_u *sfname;
214 linenr_T from;
215 linenr_T lines_to_skip;
216 linenr_T lines_to_read;
217 exarg_T *eap; /* can be NULL! */
218 int flags;
220 int fd = 0;
221 int newfile = (flags & READ_NEW);
222 int check_readonly;
223 int filtering = (flags & READ_FILTER);
224 int read_stdin = (flags & READ_STDIN);
225 int read_buffer = (flags & READ_BUFFER);
226 int set_options = newfile || read_buffer
227 || (eap != NULL && eap->read_edit);
228 linenr_T read_buf_lnum = 1; /* next line to read from curbuf */
229 colnr_T read_buf_col = 0; /* next char to read from this line */
230 char_u c;
231 linenr_T lnum = from;
232 char_u *ptr = NULL; /* pointer into read buffer */
233 char_u *buffer = NULL; /* read buffer */
234 char_u *new_buffer = NULL; /* init to shut up gcc */
235 char_u *line_start = NULL; /* init to shut up gcc */
236 int wasempty; /* buffer was empty before reading */
237 colnr_T len;
238 long size = 0;
239 char_u *p;
240 long filesize = 0;
241 int skip_read = FALSE;
242 #ifdef FEAT_CRYPT
243 char_u *cryptkey = NULL;
244 #endif
245 int split = 0; /* number of split lines */
246 #define UNKNOWN 0x0fffffff /* file size is unknown */
247 linenr_T linecnt;
248 int error = FALSE; /* errors encountered */
249 int ff_error = EOL_UNKNOWN; /* file format with errors */
250 long linerest = 0; /* remaining chars in line */
251 #ifdef UNIX
252 int perm = 0;
253 int swap_mode = -1; /* protection bits for swap file */
254 #else
255 int perm;
256 #endif
257 int fileformat = 0; /* end-of-line format */
258 int keep_fileformat = FALSE;
259 struct stat st;
260 int file_readonly;
261 linenr_T skip_count = 0;
262 linenr_T read_count = 0;
263 int msg_save = msg_scroll;
264 linenr_T read_no_eol_lnum = 0; /* non-zero lnum when last line of
265 * last read was missing the eol */
266 int try_mac = (vim_strchr(p_ffs, 'm') != NULL);
267 int try_dos = (vim_strchr(p_ffs, 'd') != NULL);
268 int try_unix = (vim_strchr(p_ffs, 'x') != NULL);
269 int file_rewind = FALSE;
270 #ifdef FEAT_MBYTE
271 int can_retry;
272 linenr_T conv_error = 0; /* line nr with conversion error */
273 linenr_T illegal_byte = 0; /* line nr with illegal byte */
274 int keep_dest_enc = FALSE; /* don't retry when char doesn't fit
275 in destination encoding */
276 int bad_char_behavior = BAD_REPLACE;
277 /* BAD_KEEP, BAD_DROP or character to
278 * replace with */
279 char_u *tmpname = NULL; /* name of 'charconvert' output file */
280 int fio_flags = 0;
281 char_u *fenc; /* fileencoding to use */
282 int fenc_alloced; /* fenc_next is in allocated memory */
283 char_u *fenc_next = NULL; /* next item in 'fencs' or NULL */
284 int advance_fenc = FALSE;
285 long real_size = 0;
286 # ifdef USE_ICONV
287 iconv_t iconv_fd = (iconv_t)-1; /* descriptor for iconv() or -1 */
288 # ifdef FEAT_EVAL
289 int did_iconv = FALSE; /* TRUE when iconv() failed and trying
290 'charconvert' next */
291 # endif
292 # endif
293 int converted = FALSE; /* TRUE if conversion done */
294 int notconverted = FALSE; /* TRUE if conversion wanted but it
295 wasn't possible */
296 char_u conv_rest[CONV_RESTLEN];
297 int conv_restlen = 0; /* nr of bytes in conv_rest[] */
298 #endif
300 #ifdef FEAT_AUTOCMD
301 /* Remember the initial values of curbuf, curbuf->b_ffname and
302 * curbuf->b_fname to detect whether they are altered as a result of
303 * executing nasty autocommands. Also check if "fname" and "sfname"
304 * point to one of these values. */
305 buf_T *old_curbuf = curbuf;
306 char_u *old_b_ffname = curbuf->b_ffname;
307 char_u *old_b_fname = curbuf->b_fname;
308 int using_b_ffname = (fname == curbuf->b_ffname)
309 || (sfname == curbuf->b_ffname);
310 int using_b_fname = (fname == curbuf->b_fname)
311 || (sfname == curbuf->b_fname);
312 #endif
313 write_no_eol_lnum = 0; /* in case it was set by the previous read */
316 * If there is no file name yet, use the one for the read file.
317 * BF_NOTEDITED is set to reflect this.
318 * Don't do this for a read from a filter.
319 * Only do this when 'cpoptions' contains the 'f' flag.
321 if (curbuf->b_ffname == NULL
322 && !filtering
323 && fname != NULL
324 && vim_strchr(p_cpo, CPO_FNAMER) != NULL
325 && !(flags & READ_DUMMY))
327 if (set_rw_fname(fname, sfname) == FAIL)
328 return FAIL;
331 /* After reading a file the cursor line changes but we don't want to
332 * display the line. */
333 ex_no_reprint = TRUE;
335 /* don't display the file info for another buffer now */
336 need_fileinfo = FALSE;
339 * For Unix: Use the short file name whenever possible.
340 * Avoids problems with networks and when directory names are changed.
341 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
342 * another directory, which we don't detect.
344 if (sfname == NULL)
345 sfname = fname;
346 #if defined(UNIX) || defined(__EMX__)
347 fname = sfname;
348 #endif
350 #ifdef FEAT_AUTOCMD
352 * The BufReadCmd and FileReadCmd events intercept the reading process by
353 * executing the associated commands instead.
355 if (!filtering && !read_stdin && !read_buffer)
357 pos_T pos;
359 pos = curbuf->b_op_start;
361 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
362 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
363 curbuf->b_op_start.col = 0;
365 if (newfile)
367 if (apply_autocmds_exarg(EVENT_BUFREADCMD, NULL, sfname,
368 FALSE, curbuf, eap))
369 #ifdef FEAT_EVAL
370 return aborting() ? FAIL : OK;
371 #else
372 return OK;
373 #endif
375 else if (apply_autocmds_exarg(EVENT_FILEREADCMD, sfname, sfname,
376 FALSE, NULL, eap))
377 #ifdef FEAT_EVAL
378 return aborting() ? FAIL : OK;
379 #else
380 return OK;
381 #endif
383 curbuf->b_op_start = pos;
385 #endif
387 if ((shortmess(SHM_OVER) || curbuf->b_help) && p_verbose == 0)
388 msg_scroll = FALSE; /* overwrite previous file message */
389 else
390 msg_scroll = TRUE; /* don't overwrite previous file message */
393 * If the name ends in a path separator, we can't open it. Check here,
394 * because reading the file may actually work, but then creating the swap
395 * file may destroy it! Reported on MS-DOS and Win 95.
396 * If the name is too long we might crash further on, quit here.
398 if (fname != NULL && *fname != NUL)
400 p = fname + STRLEN(fname);
401 if (after_pathsep(fname, p) || STRLEN(fname) >= MAXPATHL)
403 filemess(curbuf, fname, (char_u *)_("Illegal file name"), 0);
404 msg_end();
405 msg_scroll = msg_save;
406 return FAIL;
410 #ifdef UNIX
412 * On Unix it is possible to read a directory, so we have to
413 * check for it before the mch_open().
415 if (!read_stdin && !read_buffer)
417 perm = mch_getperm(fname);
418 if (perm >= 0 && !S_ISREG(perm) /* not a regular file ... */
419 # ifdef S_ISFIFO
420 && !S_ISFIFO(perm) /* ... or fifo */
421 # endif
422 # ifdef S_ISSOCK
423 && !S_ISSOCK(perm) /* ... or socket */
424 # endif
425 # ifdef OPEN_CHR_FILES
426 && !(S_ISCHR(perm) && is_dev_fd_file(fname))
427 /* ... or a character special file named /dev/fd/<n> */
428 # endif
431 if (S_ISDIR(perm))
432 filemess(curbuf, fname, (char_u *)_("is a directory"), 0);
433 else
434 filemess(curbuf, fname, (char_u *)_("is not a file"), 0);
435 msg_end();
436 msg_scroll = msg_save;
437 return FAIL;
440 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
442 * MS-Windows allows opening a device, but we will probably get stuck
443 * trying to read it.
445 if (!p_odev && mch_nodetype(fname) == NODE_WRITABLE)
447 filemess(curbuf, fname, (char_u *)_("is a device (disabled with 'opendevice' option)"), 0);
448 msg_end();
449 msg_scroll = msg_save;
450 return FAIL;
452 # endif
454 #endif
456 /* set default 'fileformat' */
457 if (set_options)
459 if (eap != NULL && eap->force_ff != 0)
460 set_fileformat(get_fileformat_force(curbuf, eap), OPT_LOCAL);
461 else if (*p_ffs != NUL)
462 set_fileformat(default_fileformat(), OPT_LOCAL);
465 /* set or reset 'binary' */
466 if (eap != NULL && eap->force_bin != 0)
468 int oldval = curbuf->b_p_bin;
470 curbuf->b_p_bin = (eap->force_bin == FORCE_BIN);
471 set_options_bin(oldval, curbuf->b_p_bin, OPT_LOCAL);
475 * When opening a new file we take the readonly flag from the file.
476 * Default is r/w, can be set to r/o below.
477 * Don't reset it when in readonly mode
478 * Only set/reset b_p_ro when BF_CHECK_RO is set.
480 check_readonly = (newfile && (curbuf->b_flags & BF_CHECK_RO));
481 if (check_readonly && !readonlymode)
482 curbuf->b_p_ro = FALSE;
484 if (newfile && !read_stdin && !read_buffer)
486 /* Remember time of file.
487 * For RISCOS, also remember the filetype.
489 if (mch_stat((char *)fname, &st) >= 0)
491 buf_store_time(curbuf, &st, fname);
492 curbuf->b_mtime_read = curbuf->b_mtime;
494 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
495 /* Read the filetype into the buffer local filetype option. */
496 mch_read_filetype(fname);
497 #endif
498 #ifdef UNIX
500 * Use the protection bits of the original file for the swap file.
501 * This makes it possible for others to read the name of the
502 * edited file from the swapfile, but only if they can read the
503 * edited file.
504 * Remove the "write" and "execute" bits for group and others
505 * (they must not write the swapfile).
506 * Add the "read" and "write" bits for the user, otherwise we may
507 * not be able to write to the file ourselves.
508 * Setting the bits is done below, after creating the swap file.
510 swap_mode = (st.st_mode & 0644) | 0600;
511 #endif
512 #ifdef FEAT_CW_EDITOR
513 /* Get the FSSpec on MacOS
514 * TODO: Update it properly when the buffer name changes
516 (void)GetFSSpecFromPath(curbuf->b_ffname, &curbuf->b_FSSpec);
517 #endif
518 #ifdef VMS
519 curbuf->b_fab_rfm = st.st_fab_rfm;
520 curbuf->b_fab_rat = st.st_fab_rat;
521 curbuf->b_fab_mrs = st.st_fab_mrs;
522 #endif
524 else
526 curbuf->b_mtime = 0;
527 curbuf->b_mtime_read = 0;
528 curbuf->b_orig_size = 0;
529 curbuf->b_orig_mode = 0;
532 /* Reset the "new file" flag. It will be set again below when the
533 * file doesn't exist. */
534 curbuf->b_flags &= ~(BF_NEW | BF_NEW_W);
538 * for UNIX: check readonly with perm and mch_access()
539 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
540 * for MSDOS and Amiga: check readonly by trying to open the file for writing
542 file_readonly = FALSE;
543 if (read_stdin)
545 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
546 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
547 setmode(0, O_BINARY);
548 #endif
550 else if (!read_buffer)
552 #ifdef USE_MCH_ACCESS
553 if (
554 # ifdef UNIX
555 !(perm & 0222) ||
556 # endif
557 mch_access((char *)fname, W_OK))
558 file_readonly = TRUE;
559 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
560 #else
561 if (!newfile
562 || readonlymode
563 || (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0)
565 file_readonly = TRUE;
566 /* try to open ro */
567 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
569 #endif
572 if (fd < 0) /* cannot open at all */
574 #ifndef UNIX
575 int isdir_f;
576 #endif
577 msg_scroll = msg_save;
578 #ifndef UNIX
580 * On MSDOS and Amiga we can't open a directory, check here.
582 isdir_f = (mch_isdir(fname));
583 perm = mch_getperm(fname); /* check if the file exists */
584 if (isdir_f)
586 filemess(curbuf, sfname, (char_u *)_("is a directory"), 0);
587 curbuf->b_p_ro = TRUE; /* must use "w!" now */
589 else
590 #endif
591 if (newfile)
593 if (perm < 0)
596 * Set the 'new-file' flag, so that when the file has
597 * been created by someone else, a ":w" will complain.
599 curbuf->b_flags |= BF_NEW;
601 /* Create a swap file now, so that other Vims are warned
602 * that we are editing this file. Don't do this for a
603 * "nofile" or "nowrite" buffer type. */
604 #ifdef FEAT_QUICKFIX
605 if (!bt_dontwrite(curbuf))
606 #endif
608 check_need_swap(newfile);
609 #ifdef FEAT_AUTOCMD
610 /* SwapExists autocommand may mess things up */
611 if (curbuf != old_curbuf
612 || (using_b_ffname
613 && (old_b_ffname != curbuf->b_ffname))
614 || (using_b_fname
615 && (old_b_fname != curbuf->b_fname)))
617 EMSG(_(e_auchangedbuf));
618 return FAIL;
620 #endif
622 if (dir_of_file_exists(fname))
623 filemess(curbuf, sfname, (char_u *)_("[New File]"), 0);
624 else
625 filemess(curbuf, sfname,
626 (char_u *)_("[New DIRECTORY]"), 0);
627 #ifdef FEAT_VIMINFO
628 /* Even though this is a new file, it might have been
629 * edited before and deleted. Get the old marks. */
630 check_marks_read();
631 #endif
632 #ifdef FEAT_MBYTE
633 if (eap != NULL && eap->force_enc != 0)
635 /* set forced 'fileencoding' */
636 fenc = enc_canonize(eap->cmd + eap->force_enc);
637 if (fenc != NULL)
638 set_string_option_direct((char_u *)"fenc", -1,
639 fenc, OPT_FREE|OPT_LOCAL, 0);
640 vim_free(fenc);
642 #endif
643 #ifdef FEAT_AUTOCMD
644 apply_autocmds_exarg(EVENT_BUFNEWFILE, sfname, sfname,
645 FALSE, curbuf, eap);
646 #endif
647 /* remember the current fileformat */
648 save_file_ff(curbuf);
650 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
651 if (aborting()) /* autocmds may abort script processing */
652 return FAIL;
653 #endif
654 return OK; /* a new file is not an error */
656 else
658 filemess(curbuf, sfname, (char_u *)(
659 # ifdef EFBIG
660 (errno == EFBIG) ? _("[File too big]") :
661 # endif
662 _("[Permission Denied]")), 0);
663 curbuf->b_p_ro = TRUE; /* must use "w!" now */
667 return FAIL;
671 * Only set the 'ro' flag for readonly files the first time they are
672 * loaded. Help files always get readonly mode
674 if ((check_readonly && file_readonly) || curbuf->b_help)
675 curbuf->b_p_ro = TRUE;
677 if (set_options)
679 /* Don't change 'eol' if reading from buffer as it will already be
680 * correctly set when reading stdin. */
681 if (!read_buffer)
683 curbuf->b_p_eol = TRUE;
684 curbuf->b_start_eol = TRUE;
686 #ifdef FEAT_MBYTE
687 curbuf->b_p_bomb = FALSE;
688 curbuf->b_start_bomb = FALSE;
689 #endif
692 /* Create a swap file now, so that other Vims are warned that we are
693 * editing this file.
694 * Don't do this for a "nofile" or "nowrite" buffer type. */
695 #ifdef FEAT_QUICKFIX
696 if (!bt_dontwrite(curbuf))
697 #endif
699 check_need_swap(newfile);
700 #ifdef FEAT_AUTOCMD
701 if (!read_stdin && (curbuf != old_curbuf
702 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
703 || (using_b_fname && (old_b_fname != curbuf->b_fname))))
705 EMSG(_(e_auchangedbuf));
706 if (!read_buffer)
707 close(fd);
708 return FAIL;
710 #endif
711 #ifdef UNIX
712 /* Set swap file protection bits after creating it. */
713 if (swap_mode > 0 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
714 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
715 #endif
718 #if defined(HAS_SWAP_EXISTS_ACTION)
719 /* If "Quit" selected at ATTENTION dialog, don't load the file */
720 if (swap_exists_action == SEA_QUIT)
722 if (!read_buffer && !read_stdin)
723 close(fd);
724 return FAIL;
726 #endif
728 ++no_wait_return; /* don't wait for return yet */
731 * Set '[ mark to the line above where the lines go (line 1 if zero).
733 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
734 curbuf->b_op_start.col = 0;
736 #ifdef FEAT_AUTOCMD
737 if (!read_buffer)
739 int m = msg_scroll;
740 int n = msg_scrolled;
743 * The file must be closed again, the autocommands may want to change
744 * the file before reading it.
746 if (!read_stdin)
747 close(fd); /* ignore errors */
750 * The output from the autocommands should not overwrite anything and
751 * should not be overwritten: Set msg_scroll, restore its value if no
752 * output was done.
754 msg_scroll = TRUE;
755 if (filtering)
756 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
757 FALSE, curbuf, eap);
758 else if (read_stdin)
759 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
760 FALSE, curbuf, eap);
761 else if (newfile)
762 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
763 FALSE, curbuf, eap);
764 else
765 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
766 FALSE, NULL, eap);
767 if (msg_scrolled == n)
768 msg_scroll = m;
770 #ifdef FEAT_EVAL
771 if (aborting()) /* autocmds may abort script processing */
773 --no_wait_return;
774 msg_scroll = msg_save;
775 curbuf->b_p_ro = TRUE; /* must use "w!" now */
776 return FAIL;
778 #endif
780 * Don't allow the autocommands to change the current buffer.
781 * Try to re-open the file.
783 * Don't allow the autocommands to change the buffer name either
784 * (cd for example) if it invalidates fname or sfname.
786 if (!read_stdin && (curbuf != old_curbuf
787 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
788 || (using_b_fname && (old_b_fname != curbuf->b_fname))
789 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
791 --no_wait_return;
792 msg_scroll = msg_save;
793 if (fd < 0)
794 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
795 else
796 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
797 curbuf->b_p_ro = TRUE; /* must use "w!" now */
798 return FAIL;
801 #endif /* FEAT_AUTOCMD */
803 /* Autocommands may add lines to the file, need to check if it is empty */
804 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
806 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
809 * Show the user that we are busy reading the input. Sometimes this
810 * may take a while. When reading from stdin another program may
811 * still be running, don't move the cursor to the last line, unless
812 * always using the GUI.
814 if (read_stdin)
816 #ifndef ALWAYS_USE_GUI
817 mch_msg(_("Vim: Reading from stdin...\n"));
818 #endif
819 #ifdef FEAT_GUI
820 /* Also write a message in the GUI window, if there is one. */
821 if (gui.in_use && !gui.dying && !gui.starting)
823 p = (char_u *)_("Reading from stdin...");
824 gui_write(p, (int)STRLEN(p));
826 #endif
828 else if (!read_buffer)
829 filemess(curbuf, sfname, (char_u *)"", 0);
832 msg_scroll = FALSE; /* overwrite the file message */
835 * Set linecnt now, before the "retry" caused by a wrong guess for
836 * fileformat, and after the autocommands, which may change them.
838 linecnt = curbuf->b_ml.ml_line_count;
840 #ifdef FEAT_MBYTE
841 /* "++bad=" argument. */
842 if (eap != NULL && eap->bad_char != 0)
844 bad_char_behavior = eap->bad_char;
845 if (set_options)
846 curbuf->b_bad_char = eap->bad_char;
848 else
849 curbuf->b_bad_char = 0;
852 * Decide which 'encoding' to use or use first.
854 if (eap != NULL && eap->force_enc != 0)
856 fenc = enc_canonize(eap->cmd + eap->force_enc);
857 fenc_alloced = TRUE;
858 keep_dest_enc = TRUE;
860 else if (curbuf->b_p_bin)
862 fenc = (char_u *)""; /* binary: don't convert */
863 fenc_alloced = FALSE;
865 else if (curbuf->b_help)
867 char_u firstline[80];
868 int fc;
870 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
871 * fails it must be latin1.
872 * Always do this when 'encoding' is "utf-8". Otherwise only do
873 * this when needed to avoid [converted] remarks all the time.
874 * It is needed when the first line contains non-ASCII characters.
875 * That is only in *.??x files. */
876 fenc = (char_u *)"latin1";
877 c = enc_utf8;
878 if (!c && !read_stdin)
880 fc = fname[STRLEN(fname) - 1];
881 if (TOLOWER_ASC(fc) == 'x')
883 /* Read the first line (and a bit more). Immediately rewind to
884 * the start of the file. If the read() fails "len" is -1. */
885 len = vim_read(fd, firstline, 80);
886 lseek(fd, (off_t)0L, SEEK_SET);
887 for (p = firstline; p < firstline + len; ++p)
888 if (*p >= 0x80)
890 c = TRUE;
891 break;
896 if (c)
898 fenc_next = fenc;
899 fenc = (char_u *)"utf-8";
901 /* When the file is utf-8 but a character doesn't fit in
902 * 'encoding' don't retry. In help text editing utf-8 bytes
903 * doesn't make sense. */
904 if (!enc_utf8)
905 keep_dest_enc = TRUE;
907 fenc_alloced = FALSE;
909 else if (*p_fencs == NUL)
911 fenc = curbuf->b_p_fenc; /* use format from buffer */
912 fenc_alloced = FALSE;
914 else
916 fenc_next = p_fencs; /* try items in 'fileencodings' */
917 fenc = next_fenc(&fenc_next);
918 fenc_alloced = TRUE;
920 #endif
923 * Jump back here to retry reading the file in different ways.
924 * Reasons to retry:
925 * - encoding conversion failed: try another one from "fenc_next"
926 * - BOM detected and fenc was set, need to setup conversion
927 * - "fileformat" check failed: try another
929 * Variables set for special retry actions:
930 * "file_rewind" Rewind the file to start reading it again.
931 * "advance_fenc" Advance "fenc" using "fenc_next".
932 * "skip_read" Re-use already read bytes (BOM detected).
933 * "did_iconv" iconv() conversion failed, try 'charconvert'.
934 * "keep_fileformat" Don't reset "fileformat".
936 * Other status indicators:
937 * "tmpname" When != NULL did conversion with 'charconvert'.
938 * Output file has to be deleted afterwards.
939 * "iconv_fd" When != -1 did conversion with iconv().
941 retry:
943 if (file_rewind)
945 if (read_buffer)
947 read_buf_lnum = 1;
948 read_buf_col = 0;
950 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
952 /* Can't rewind the file, give up. */
953 error = TRUE;
954 goto failed;
956 /* Delete the previously read lines. */
957 while (lnum > from)
958 ml_delete(lnum--, FALSE);
959 file_rewind = FALSE;
960 #ifdef FEAT_MBYTE
961 if (set_options)
963 curbuf->b_p_bomb = FALSE;
964 curbuf->b_start_bomb = FALSE;
966 conv_error = 0;
967 #endif
971 * When retrying with another "fenc" and the first time "fileformat"
972 * will be reset.
974 if (keep_fileformat)
975 keep_fileformat = FALSE;
976 else
978 if (eap != NULL && eap->force_ff != 0)
980 fileformat = get_fileformat_force(curbuf, eap);
981 try_unix = try_dos = try_mac = FALSE;
983 else if (curbuf->b_p_bin)
984 fileformat = EOL_UNIX; /* binary: use Unix format */
985 else if (*p_ffs == NUL)
986 fileformat = get_fileformat(curbuf);/* use format from buffer */
987 else
988 fileformat = EOL_UNKNOWN; /* detect from file */
991 #ifdef FEAT_MBYTE
992 # ifdef USE_ICONV
993 if (iconv_fd != (iconv_t)-1)
995 /* aborted conversion with iconv(), close the descriptor */
996 iconv_close(iconv_fd);
997 iconv_fd = (iconv_t)-1;
999 # endif
1001 if (advance_fenc)
1004 * Try the next entry in 'fileencodings'.
1006 advance_fenc = FALSE;
1008 if (eap != NULL && eap->force_enc != 0)
1010 /* Conversion given with "++cc=" wasn't possible, read
1011 * without conversion. */
1012 notconverted = TRUE;
1013 conv_error = 0;
1014 if (fenc_alloced)
1015 vim_free(fenc);
1016 fenc = (char_u *)"";
1017 fenc_alloced = FALSE;
1019 else
1021 if (fenc_alloced)
1022 vim_free(fenc);
1023 if (fenc_next != NULL)
1025 fenc = next_fenc(&fenc_next);
1026 fenc_alloced = (fenc_next != NULL);
1028 else
1030 fenc = (char_u *)"";
1031 fenc_alloced = FALSE;
1034 if (tmpname != NULL)
1036 mch_remove(tmpname); /* delete converted file */
1037 vim_free(tmpname);
1038 tmpname = NULL;
1043 * Conversion is required when the encoding of the file is different
1044 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
1045 * conversion to UTF-8).
1047 fio_flags = 0;
1048 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
1049 if (converted || enc_unicode != 0)
1052 /* "ucs-bom" means we need to check the first bytes of the file
1053 * for a BOM. */
1054 if (STRCMP(fenc, ENC_UCSBOM) == 0)
1055 fio_flags = FIO_UCSBOM;
1058 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1059 * done. This is handled below after read(). Prepare the
1060 * fio_flags to avoid having to parse the string each time.
1061 * Also check for Unicode to Latin1 conversion, because iconv()
1062 * appears not to handle this correctly. This works just like
1063 * conversion to UTF-8 except how the resulting character is put in
1064 * the buffer.
1066 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1067 fio_flags = get_fio_flags(fenc);
1069 # ifdef WIN3264
1071 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1072 * is handled with MultiByteToWideChar().
1074 if (fio_flags == 0)
1075 fio_flags = get_win_fio_flags(fenc);
1076 # endif
1078 # ifdef MACOS_X
1079 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1080 if (fio_flags == 0)
1081 fio_flags = get_mac_fio_flags(fenc);
1082 # endif
1084 # ifdef USE_ICONV
1086 * Try using iconv() if we can't convert internally.
1088 if (fio_flags == 0
1089 # ifdef FEAT_EVAL
1090 && !did_iconv
1091 # endif
1093 iconv_fd = (iconv_t)my_iconv_open(
1094 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1095 # endif
1097 # ifdef FEAT_EVAL
1099 * Use the 'charconvert' expression when conversion is required
1100 * and we can't do it internally or with iconv().
1102 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1103 # ifdef USE_ICONV
1104 && iconv_fd == (iconv_t)-1
1105 # endif
1108 # ifdef USE_ICONV
1109 did_iconv = FALSE;
1110 # endif
1111 /* Skip conversion when it's already done (retry for wrong
1112 * "fileformat"). */
1113 if (tmpname == NULL)
1115 tmpname = readfile_charconvert(fname, fenc, &fd);
1116 if (tmpname == NULL)
1118 /* Conversion failed. Try another one. */
1119 advance_fenc = TRUE;
1120 if (fd < 0)
1122 /* Re-opening the original file failed! */
1123 EMSG(_("E202: Conversion made file unreadable!"));
1124 error = TRUE;
1125 goto failed;
1127 goto retry;
1131 else
1132 # endif
1134 if (fio_flags == 0
1135 # ifdef USE_ICONV
1136 && iconv_fd == (iconv_t)-1
1137 # endif
1140 /* Conversion wanted but we can't.
1141 * Try the next conversion in 'fileencodings' */
1142 advance_fenc = TRUE;
1143 goto retry;
1148 /* Set "can_retry" when it's possible to rewind the file and try with
1149 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1150 * stdin or fixed at a specific encoding. */
1151 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1152 #endif
1154 if (!skip_read)
1156 linerest = 0;
1157 filesize = 0;
1158 skip_count = lines_to_skip;
1159 read_count = lines_to_read;
1160 #ifdef FEAT_MBYTE
1161 conv_restlen = 0;
1162 #endif
1165 while (!error && !got_int)
1168 * We allocate as much space for the file as we can get, plus
1169 * space for the old line plus room for one terminating NUL.
1170 * The amount is limited by the fact that read() only can read
1171 * upto max_unsigned characters (and other things).
1173 #if SIZEOF_INT <= 2
1174 if (linerest >= 0x7ff0)
1176 ++split;
1177 *ptr = NL; /* split line by inserting a NL */
1178 size = 1;
1180 else
1181 #endif
1183 if (!skip_read)
1185 #if SIZEOF_INT > 2
1186 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1187 size = SSIZE_MAX; /* use max I/O size, 52K */
1188 # else
1189 size = 0x10000L; /* use buffer >= 64K */
1190 # endif
1191 #else
1192 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1193 #endif
1195 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1197 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1198 FALSE)) != NULL)
1199 break;
1201 if (new_buffer == NULL)
1203 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1204 error = TRUE;
1205 break;
1207 if (linerest) /* copy characters from the previous buffer */
1208 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1209 vim_free(buffer);
1210 buffer = new_buffer;
1211 ptr = buffer + linerest;
1212 line_start = buffer;
1214 #ifdef FEAT_MBYTE
1215 /* May need room to translate into.
1216 * For iconv() we don't really know the required space, use a
1217 * factor ICONV_MULT.
1218 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1219 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1220 * become up to 4 bytes, size must be multiple of 2
1221 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1222 * multiple of 2
1223 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1224 * multiple of 4 */
1225 real_size = (int)size;
1226 # ifdef USE_ICONV
1227 if (iconv_fd != (iconv_t)-1)
1228 size = size / ICONV_MULT;
1229 else
1230 # endif
1231 if (fio_flags & FIO_LATIN1)
1232 size = size / 2;
1233 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1234 size = (size * 2 / 3) & ~1;
1235 else if (fio_flags & FIO_UCS4)
1236 size = (size * 2 / 3) & ~3;
1237 else if (fio_flags == FIO_UCSBOM)
1238 size = size / ICONV_MULT; /* worst case */
1239 # ifdef WIN3264
1240 else if (fio_flags & FIO_CODEPAGE)
1241 size = size / ICONV_MULT; /* also worst case */
1242 # endif
1243 # ifdef MACOS_X
1244 else if (fio_flags & FIO_MACROMAN)
1245 size = size / ICONV_MULT; /* also worst case */
1246 # endif
1247 #endif
1249 #ifdef FEAT_MBYTE
1250 if (conv_restlen > 0)
1252 /* Insert unconverted bytes from previous line. */
1253 mch_memmove(ptr, conv_rest, conv_restlen);
1254 ptr += conv_restlen;
1255 size -= conv_restlen;
1257 #endif
1259 if (read_buffer)
1262 * Read bytes from curbuf. Used for converting text read
1263 * from stdin.
1265 if (read_buf_lnum > from)
1266 size = 0;
1267 else
1269 int n, ni;
1270 long tlen;
1272 tlen = 0;
1273 for (;;)
1275 p = ml_get(read_buf_lnum) + read_buf_col;
1276 n = (int)STRLEN(p);
1277 if ((int)tlen + n + 1 > size)
1279 /* Filled up to "size", append partial line.
1280 * Change NL to NUL to reverse the effect done
1281 * below. */
1282 n = (int)(size - tlen);
1283 for (ni = 0; ni < n; ++ni)
1285 if (p[ni] == NL)
1286 ptr[tlen++] = NUL;
1287 else
1288 ptr[tlen++] = p[ni];
1290 read_buf_col += n;
1291 break;
1293 else
1295 /* Append whole line and new-line. Change NL
1296 * to NUL to reverse the effect done below. */
1297 for (ni = 0; ni < n; ++ni)
1299 if (p[ni] == NL)
1300 ptr[tlen++] = NUL;
1301 else
1302 ptr[tlen++] = p[ni];
1304 ptr[tlen++] = NL;
1305 read_buf_col = 0;
1306 if (++read_buf_lnum > from)
1308 /* When the last line didn't have an
1309 * end-of-line don't add it now either. */
1310 if (!curbuf->b_p_eol)
1311 --tlen;
1312 size = tlen;
1313 break;
1319 else
1322 * Read bytes from the file.
1324 size = vim_read(fd, ptr, size);
1327 if (size <= 0)
1329 if (size < 0) /* read error */
1330 error = TRUE;
1331 #ifdef FEAT_MBYTE
1332 else if (conv_restlen > 0)
1335 * Reached end-of-file but some trailing bytes could
1336 * not be converted. Truncated file?
1339 /* When we did a conversion report an error. */
1340 if (fio_flags != 0
1341 # ifdef USE_ICONV
1342 || iconv_fd != (iconv_t)-1
1343 # endif
1346 if (conv_error == 0)
1347 conv_error = curbuf->b_ml.ml_line_count
1348 - linecnt + 1;
1350 /* Remember the first linenr with an illegal byte */
1351 else if (illegal_byte == 0)
1352 illegal_byte = curbuf->b_ml.ml_line_count
1353 - linecnt + 1;
1354 if (bad_char_behavior == BAD_DROP)
1356 *(ptr - conv_restlen) = NUL;
1357 conv_restlen = 0;
1359 else
1361 /* Replace the trailing bytes with the replacement
1362 * character if we were converting; if we weren't,
1363 * leave the UTF8 checking code to do it, as it
1364 * works slightly differently. */
1365 if (bad_char_behavior != BAD_KEEP && (fio_flags != 0
1366 # ifdef USE_ICONV
1367 || iconv_fd != (iconv_t)-1
1368 # endif
1371 while (conv_restlen > 0)
1373 *(--ptr) = bad_char_behavior;
1374 --conv_restlen;
1377 fio_flags = 0; /* don't convert this */
1378 # ifdef USE_ICONV
1379 if (iconv_fd != (iconv_t)-1)
1381 iconv_close(iconv_fd);
1382 iconv_fd = (iconv_t)-1;
1384 # endif
1387 #endif
1390 #ifdef FEAT_CRYPT
1392 * At start of file: Check for magic number of encryption.
1394 if (filesize == 0)
1395 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1396 &filesize, newfile);
1398 * Decrypt the read bytes.
1400 if (cryptkey != NULL && size > 0)
1401 for (p = ptr; p < ptr + size; ++p)
1402 ZDECODE(*p);
1403 #endif
1405 skip_read = FALSE;
1407 #ifdef FEAT_MBYTE
1409 * At start of file (or after crypt magic number): Check for BOM.
1410 * Also check for a BOM for other Unicode encodings, but not after
1411 * converting with 'charconvert' or when a BOM has already been
1412 * found.
1414 if ((filesize == 0
1415 # ifdef FEAT_CRYPT
1416 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1417 # endif
1419 && (fio_flags == FIO_UCSBOM
1420 || (!curbuf->b_p_bomb
1421 && tmpname == NULL
1422 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1424 char_u *ccname;
1425 int blen;
1427 /* no BOM detection in a short file or in binary mode */
1428 if (size < 2 || curbuf->b_p_bin)
1429 ccname = NULL;
1430 else
1431 ccname = check_for_bom(ptr, size, &blen,
1432 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1433 if (ccname != NULL)
1435 /* Remove BOM from the text */
1436 filesize += blen;
1437 size -= blen;
1438 mch_memmove(ptr, ptr + blen, (size_t)size);
1439 if (set_options)
1441 curbuf->b_p_bomb = TRUE;
1442 curbuf->b_start_bomb = TRUE;
1446 if (fio_flags == FIO_UCSBOM)
1448 if (ccname == NULL)
1450 /* No BOM detected: retry with next encoding. */
1451 advance_fenc = TRUE;
1453 else
1455 /* BOM detected: set "fenc" and jump back */
1456 if (fenc_alloced)
1457 vim_free(fenc);
1458 fenc = ccname;
1459 fenc_alloced = FALSE;
1461 /* retry reading without getting new bytes or rewinding */
1462 skip_read = TRUE;
1463 goto retry;
1467 /* Include not converted bytes. */
1468 ptr -= conv_restlen;
1469 size += conv_restlen;
1470 conv_restlen = 0;
1471 #endif
1473 * Break here for a read error or end-of-file.
1475 if (size <= 0)
1476 break;
1478 #ifdef FEAT_MBYTE
1480 # ifdef USE_ICONV
1481 if (iconv_fd != (iconv_t)-1)
1484 * Attempt conversion of the read bytes to 'encoding' using
1485 * iconv().
1487 const char *fromp;
1488 char *top;
1489 size_t from_size;
1490 size_t to_size;
1492 fromp = (char *)ptr;
1493 from_size = size;
1494 ptr += size;
1495 top = (char *)ptr;
1496 to_size = real_size - size;
1499 * If there is conversion error or not enough room try using
1500 * another conversion. Except for when there is no
1501 * alternative (help files).
1503 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1504 &top, &to_size)
1505 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1506 || from_size > CONV_RESTLEN)
1508 if (can_retry)
1509 goto rewind_retry;
1510 if (conv_error == 0)
1511 conv_error = readfile_linenr(linecnt,
1512 ptr, (char_u *)top);
1514 /* Deal with a bad byte and continue with the next. */
1515 ++fromp;
1516 --from_size;
1517 if (bad_char_behavior == BAD_KEEP)
1519 *top++ = *(fromp - 1);
1520 --to_size;
1522 else if (bad_char_behavior != BAD_DROP)
1524 *top++ = bad_char_behavior;
1525 --to_size;
1529 if (from_size > 0)
1531 /* Some remaining characters, keep them for the next
1532 * round. */
1533 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1534 conv_restlen = (int)from_size;
1537 /* move the linerest to before the converted characters */
1538 line_start = ptr - linerest;
1539 mch_memmove(line_start, buffer, (size_t)linerest);
1540 size = (long)((char_u *)top - ptr);
1542 # endif
1544 # ifdef WIN3264
1545 if (fio_flags & FIO_CODEPAGE)
1547 char_u *src, *dst;
1548 WCHAR ucs2buf[3];
1549 int ucs2len;
1550 int codepage = FIO_GET_CP(fio_flags);
1551 int bytelen;
1552 int found_bad;
1553 char replstr[2];
1556 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1557 * a codepage, using standard MS-Windows functions. This
1558 * requires two steps:
1559 * 1. convert from 'fileencoding' to ucs-2
1560 * 2. convert from ucs-2 to 'encoding'
1562 * Because there may be illegal bytes AND an incomplete byte
1563 * sequence at the end, we may have to do the conversion one
1564 * character at a time to get it right.
1567 /* Replacement string for WideCharToMultiByte(). */
1568 if (bad_char_behavior > 0)
1569 replstr[0] = bad_char_behavior;
1570 else
1571 replstr[0] = '?';
1572 replstr[1] = NUL;
1575 * Move the bytes to the end of the buffer, so that we have
1576 * room to put the result at the start.
1578 src = ptr + real_size - size;
1579 mch_memmove(src, ptr, size);
1582 * Do the conversion.
1584 dst = ptr;
1585 size = size;
1586 while (size > 0)
1588 found_bad = FALSE;
1590 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1591 if (codepage == CP_UTF8)
1593 /* Handle CP_UTF8 input ourselves to be able to handle
1594 * trailing bytes properly.
1595 * Get one UTF-8 character from src. */
1596 bytelen = (int)utf_ptr2len_len(src, size);
1597 if (bytelen > size)
1599 /* Only got some bytes of a character. Normally
1600 * it's put in "conv_rest", but if it's too long
1601 * deal with it as if they were illegal bytes. */
1602 if (bytelen <= CONV_RESTLEN)
1603 break;
1605 /* weird overlong byte sequence */
1606 bytelen = size;
1607 found_bad = TRUE;
1609 else
1611 int u8c = utf_ptr2char(src);
1613 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1614 found_bad = TRUE;
1615 ucs2buf[0] = u8c;
1616 ucs2len = 1;
1619 else
1620 # endif
1622 /* We don't know how long the byte sequence is, try
1623 * from one to three bytes. */
1624 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1625 ++bytelen)
1627 ucs2len = MultiByteToWideChar(codepage,
1628 MB_ERR_INVALID_CHARS,
1629 (LPCSTR)src, bytelen,
1630 ucs2buf, 3);
1631 if (ucs2len > 0)
1632 break;
1634 if (ucs2len == 0)
1636 /* If we have only one byte then it's probably an
1637 * incomplete byte sequence. Otherwise discard
1638 * one byte as a bad character. */
1639 if (size == 1)
1640 break;
1641 found_bad = TRUE;
1642 bytelen = 1;
1646 if (!found_bad)
1648 int i;
1650 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1651 if (enc_utf8)
1653 /* From UCS-2 to UTF-8. Cannot fail. */
1654 for (i = 0; i < ucs2len; ++i)
1655 dst += utf_char2bytes(ucs2buf[i], dst);
1657 else
1659 BOOL bad = FALSE;
1660 int dstlen;
1662 /* From UCS-2 to "enc_codepage". If the
1663 * conversion uses the default character "?",
1664 * the data doesn't fit in this encoding. */
1665 dstlen = WideCharToMultiByte(enc_codepage, 0,
1666 (LPCWSTR)ucs2buf, ucs2len,
1667 (LPSTR)dst, (int)(src - dst),
1668 replstr, &bad);
1669 if (bad)
1670 found_bad = TRUE;
1671 else
1672 dst += dstlen;
1676 if (found_bad)
1678 /* Deal with bytes we can't convert. */
1679 if (can_retry)
1680 goto rewind_retry;
1681 if (conv_error == 0)
1682 conv_error = readfile_linenr(linecnt, ptr, dst);
1683 if (bad_char_behavior != BAD_DROP)
1685 if (bad_char_behavior == BAD_KEEP)
1687 mch_memmove(dst, src, bytelen);
1688 dst += bytelen;
1690 else
1691 *dst++ = bad_char_behavior;
1695 src += bytelen;
1696 size -= bytelen;
1699 if (size > 0)
1701 /* An incomplete byte sequence remaining. */
1702 mch_memmove(conv_rest, src, size);
1703 conv_restlen = size;
1706 /* The new size is equal to how much "dst" was advanced. */
1707 size = (long)(dst - ptr);
1709 else
1710 # endif
1711 # ifdef MACOS_CONVERT
1712 if (fio_flags & FIO_MACROMAN)
1715 * Conversion from Apple MacRoman char encoding to UTF-8 or
1716 * latin1. This is in os_mac_conv.c.
1718 if (macroman2enc(ptr, &size, real_size) == FAIL)
1719 goto rewind_retry;
1721 else
1722 # endif
1723 if (fio_flags != 0)
1725 int u8c;
1726 char_u *dest;
1727 char_u *tail = NULL;
1730 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1731 * "enc_utf8" not set: Convert Unicode to Latin1.
1732 * Go from end to start through the buffer, because the number
1733 * of bytes may increase.
1734 * "dest" points to after where the UTF-8 bytes go, "p" points
1735 * to after the next character to convert.
1737 dest = ptr + real_size;
1738 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1740 p = ptr + size;
1741 if (fio_flags == FIO_UTF8)
1743 /* Check for a trailing incomplete UTF-8 sequence */
1744 tail = ptr + size - 1;
1745 while (tail > ptr && (*tail & 0xc0) == 0x80)
1746 --tail;
1747 if (tail + utf_byte2len(*tail) <= ptr + size)
1748 tail = NULL;
1749 else
1750 p = tail;
1753 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1755 /* Check for a trailing byte */
1756 p = ptr + (size & ~1);
1757 if (size & 1)
1758 tail = p;
1759 if ((fio_flags & FIO_UTF16) && p > ptr)
1761 /* Check for a trailing leading word */
1762 if (fio_flags & FIO_ENDIAN_L)
1764 u8c = (*--p << 8);
1765 u8c += *--p;
1767 else
1769 u8c = *--p;
1770 u8c += (*--p << 8);
1772 if (u8c >= 0xd800 && u8c <= 0xdbff)
1773 tail = p;
1774 else
1775 p += 2;
1778 else /* FIO_UCS4 */
1780 /* Check for trailing 1, 2 or 3 bytes */
1781 p = ptr + (size & ~3);
1782 if (size & 3)
1783 tail = p;
1786 /* If there is a trailing incomplete sequence move it to
1787 * conv_rest[]. */
1788 if (tail != NULL)
1790 conv_restlen = (int)((ptr + size) - tail);
1791 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1792 size -= conv_restlen;
1796 while (p > ptr)
1798 if (fio_flags & FIO_LATIN1)
1799 u8c = *--p;
1800 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1802 if (fio_flags & FIO_ENDIAN_L)
1804 u8c = (*--p << 8);
1805 u8c += *--p;
1807 else
1809 u8c = *--p;
1810 u8c += (*--p << 8);
1812 if ((fio_flags & FIO_UTF16)
1813 && u8c >= 0xdc00 && u8c <= 0xdfff)
1815 int u16c;
1817 if (p == ptr)
1819 /* Missing leading word. */
1820 if (can_retry)
1821 goto rewind_retry;
1822 if (conv_error == 0)
1823 conv_error = readfile_linenr(linecnt,
1824 ptr, p);
1825 if (bad_char_behavior == BAD_DROP)
1826 continue;
1827 if (bad_char_behavior != BAD_KEEP)
1828 u8c = bad_char_behavior;
1831 /* found second word of double-word, get the first
1832 * word and compute the resulting character */
1833 if (fio_flags & FIO_ENDIAN_L)
1835 u16c = (*--p << 8);
1836 u16c += *--p;
1838 else
1840 u16c = *--p;
1841 u16c += (*--p << 8);
1843 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1844 + (u8c & 0x3ff);
1846 /* Check if the word is indeed a leading word. */
1847 if (u16c < 0xd800 || u16c > 0xdbff)
1849 if (can_retry)
1850 goto rewind_retry;
1851 if (conv_error == 0)
1852 conv_error = readfile_linenr(linecnt,
1853 ptr, p);
1854 if (bad_char_behavior == BAD_DROP)
1855 continue;
1856 if (bad_char_behavior != BAD_KEEP)
1857 u8c = bad_char_behavior;
1861 else if (fio_flags & FIO_UCS4)
1863 if (fio_flags & FIO_ENDIAN_L)
1865 u8c = (*--p << 24);
1866 u8c += (*--p << 16);
1867 u8c += (*--p << 8);
1868 u8c += *--p;
1870 else /* big endian */
1872 u8c = *--p;
1873 u8c += (*--p << 8);
1874 u8c += (*--p << 16);
1875 u8c += (*--p << 24);
1878 else /* UTF-8 */
1880 if (*--p < 0x80)
1881 u8c = *p;
1882 else
1884 len = utf_head_off(ptr, p);
1885 p -= len;
1886 u8c = utf_ptr2char(p);
1887 if (len == 0)
1889 /* Not a valid UTF-8 character, retry with
1890 * another fenc when possible, otherwise just
1891 * report the error. */
1892 if (can_retry)
1893 goto rewind_retry;
1894 if (conv_error == 0)
1895 conv_error = readfile_linenr(linecnt,
1896 ptr, p);
1897 if (bad_char_behavior == BAD_DROP)
1898 continue;
1899 if (bad_char_behavior != BAD_KEEP)
1900 u8c = bad_char_behavior;
1904 if (enc_utf8) /* produce UTF-8 */
1906 dest -= utf_char2len(u8c);
1907 (void)utf_char2bytes(u8c, dest);
1909 else /* produce Latin1 */
1911 --dest;
1912 if (u8c >= 0x100)
1914 /* character doesn't fit in latin1, retry with
1915 * another fenc when possible, otherwise just
1916 * report the error. */
1917 if (can_retry)
1918 goto rewind_retry;
1919 if (conv_error == 0)
1920 conv_error = readfile_linenr(linecnt, ptr, p);
1921 if (bad_char_behavior == BAD_DROP)
1922 ++dest;
1923 else if (bad_char_behavior == BAD_KEEP)
1924 *dest = u8c;
1925 else if (eap != NULL && eap->bad_char != 0)
1926 *dest = bad_char_behavior;
1927 else
1928 *dest = 0xBF;
1930 else
1931 *dest = u8c;
1935 /* move the linerest to before the converted characters */
1936 line_start = dest - linerest;
1937 mch_memmove(line_start, buffer, (size_t)linerest);
1938 size = (long)((ptr + real_size) - dest);
1939 ptr = dest;
1941 else if (enc_utf8 && !curbuf->b_p_bin)
1943 int incomplete_tail = FALSE;
1945 /* Reading UTF-8: Check if the bytes are valid UTF-8. */
1946 for (p = ptr; ; ++p)
1948 int todo = (int)((ptr + size) - p);
1949 int l;
1951 if (todo <= 0)
1952 break;
1953 if (*p >= 0x80)
1955 /* A length of 1 means it's an illegal byte. Accept
1956 * an incomplete character at the end though, the next
1957 * read() will get the next bytes, we'll check it
1958 * then. */
1959 l = utf_ptr2len_len(p, todo);
1960 if (l > todo && !incomplete_tail)
1962 /* Avoid retrying with a different encoding when
1963 * a truncated file is more likely, or attempting
1964 * to read the rest of an incomplete sequence when
1965 * we have already done so. */
1966 if (p > ptr || filesize > 0)
1967 incomplete_tail = TRUE;
1968 /* Incomplete byte sequence, move it to conv_rest[]
1969 * and try to read the rest of it, unless we've
1970 * already done so. */
1971 if (p > ptr)
1973 conv_restlen = todo;
1974 mch_memmove(conv_rest, p, conv_restlen);
1975 size -= conv_restlen;
1976 break;
1979 if (l == 1 || l > todo)
1981 /* Illegal byte. If we can try another encoding
1982 * do that, unless at EOF where a truncated
1983 * file is more likely than a conversion error. */
1984 if (can_retry && !incomplete_tail)
1985 break;
1986 # ifdef USE_ICONV
1987 /* When we did a conversion report an error. */
1988 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1989 conv_error = readfile_linenr(linecnt, ptr, p);
1990 # endif
1991 /* Remember the first linenr with an illegal byte */
1992 if (conv_error == 0 && illegal_byte == 0)
1993 illegal_byte = readfile_linenr(linecnt, ptr, p);
1995 /* Drop, keep or replace the bad byte. */
1996 if (bad_char_behavior == BAD_DROP)
1998 mch_memmove(p, p + 1, todo - 1);
1999 --p;
2000 --size;
2002 else if (bad_char_behavior != BAD_KEEP)
2003 *p = bad_char_behavior;
2005 else
2006 p += l - 1;
2009 if (p < ptr + size && !incomplete_tail)
2011 /* Detected a UTF-8 error. */
2012 rewind_retry:
2013 /* Retry reading with another conversion. */
2014 # if defined(FEAT_EVAL) && defined(USE_ICONV)
2015 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
2016 /* iconv() failed, try 'charconvert' */
2017 did_iconv = TRUE;
2018 else
2019 # endif
2020 /* use next item from 'fileencodings' */
2021 advance_fenc = TRUE;
2022 file_rewind = TRUE;
2023 goto retry;
2026 #endif
2028 /* count the number of characters (after conversion!) */
2029 filesize += size;
2032 * when reading the first part of a file: guess EOL type
2034 if (fileformat == EOL_UNKNOWN)
2036 /* First try finding a NL, for Dos and Unix */
2037 if (try_dos || try_unix)
2039 for (p = ptr; p < ptr + size; ++p)
2041 if (*p == NL)
2043 if (!try_unix
2044 || (try_dos && p > ptr && p[-1] == CAR))
2045 fileformat = EOL_DOS;
2046 else
2047 fileformat = EOL_UNIX;
2048 break;
2052 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
2053 if (fileformat == EOL_UNIX && try_mac)
2055 /* Need to reset the counters when retrying fenc. */
2056 try_mac = 1;
2057 try_unix = 1;
2058 for (; p >= ptr && *p != CAR; p--)
2060 if (p >= ptr)
2062 for (p = ptr; p < ptr + size; ++p)
2064 if (*p == NL)
2065 try_unix++;
2066 else if (*p == CAR)
2067 try_mac++;
2069 if (try_mac > try_unix)
2070 fileformat = EOL_MAC;
2075 /* No NL found: may use Mac format */
2076 if (fileformat == EOL_UNKNOWN && try_mac)
2077 fileformat = EOL_MAC;
2079 /* Still nothing found? Use first format in 'ffs' */
2080 if (fileformat == EOL_UNKNOWN)
2081 fileformat = default_fileformat();
2083 /* if editing a new file: may set p_tx and p_ff */
2084 if (set_options)
2085 set_fileformat(fileformat, OPT_LOCAL);
2090 * This loop is executed once for every character read.
2091 * Keep it fast!
2093 if (fileformat == EOL_MAC)
2095 --ptr;
2096 while (++ptr, --size >= 0)
2098 /* catch most common case first */
2099 if ((c = *ptr) != NUL && c != CAR && c != NL)
2100 continue;
2101 if (c == NUL)
2102 *ptr = NL; /* NULs are replaced by newlines! */
2103 else if (c == NL)
2104 *ptr = CAR; /* NLs are replaced by CRs! */
2105 else
2107 if (skip_count == 0)
2109 *ptr = NUL; /* end of line */
2110 len = (colnr_T) (ptr - line_start + 1);
2111 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2113 error = TRUE;
2114 break;
2116 ++lnum;
2117 if (--read_count == 0)
2119 error = TRUE; /* break loop */
2120 line_start = ptr; /* nothing left to write */
2121 break;
2124 else
2125 --skip_count;
2126 line_start = ptr + 1;
2130 else
2132 --ptr;
2133 while (++ptr, --size >= 0)
2135 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2136 continue;
2137 if (c == NUL)
2138 *ptr = NL; /* NULs are replaced by newlines! */
2139 else
2141 if (skip_count == 0)
2143 *ptr = NUL; /* end of line */
2144 len = (colnr_T)(ptr - line_start + 1);
2145 if (fileformat == EOL_DOS)
2147 if (ptr[-1] == CAR) /* remove CR */
2149 ptr[-1] = NUL;
2150 --len;
2153 * Reading in Dos format, but no CR-LF found!
2154 * When 'fileformats' includes "unix", delete all
2155 * the lines read so far and start all over again.
2156 * Otherwise give an error message later.
2158 else if (ff_error != EOL_DOS)
2160 if ( try_unix
2161 && !read_stdin
2162 && (read_buffer
2163 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2165 fileformat = EOL_UNIX;
2166 if (set_options)
2167 set_fileformat(EOL_UNIX, OPT_LOCAL);
2168 file_rewind = TRUE;
2169 keep_fileformat = TRUE;
2170 goto retry;
2172 ff_error = EOL_DOS;
2175 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2177 error = TRUE;
2178 break;
2180 ++lnum;
2181 if (--read_count == 0)
2183 error = TRUE; /* break loop */
2184 line_start = ptr; /* nothing left to write */
2185 break;
2188 else
2189 --skip_count;
2190 line_start = ptr + 1;
2194 linerest = (long)(ptr - line_start);
2195 ui_breakcheck();
2198 failed:
2199 /* not an error, max. number of lines reached */
2200 if (error && read_count == 0)
2201 error = FALSE;
2204 * If we get EOF in the middle of a line, note the fact and
2205 * complete the line ourselves.
2206 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2208 if (!error
2209 && !got_int
2210 && linerest != 0
2211 && !(!curbuf->b_p_bin
2212 && fileformat == EOL_DOS
2213 && *line_start == Ctrl_Z
2214 && ptr == line_start + 1))
2216 /* remember for when writing */
2217 if (set_options)
2218 curbuf->b_p_eol = FALSE;
2219 *ptr = NUL;
2220 if (ml_append(lnum, line_start,
2221 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2222 error = TRUE;
2223 else
2224 read_no_eol_lnum = ++lnum;
2227 if (set_options)
2228 save_file_ff(curbuf); /* remember the current file format */
2230 #ifdef FEAT_CRYPT
2231 if (cryptkey != curbuf->b_p_key)
2232 vim_free(cryptkey);
2233 #endif
2235 #ifdef FEAT_MBYTE
2236 /* If editing a new file: set 'fenc' for the current buffer.
2237 * Also for ":read ++edit file". */
2238 if (set_options)
2239 set_string_option_direct((char_u *)"fenc", -1, fenc,
2240 OPT_FREE|OPT_LOCAL, 0);
2241 if (fenc_alloced)
2242 vim_free(fenc);
2243 # ifdef USE_ICONV
2244 if (iconv_fd != (iconv_t)-1)
2246 iconv_close(iconv_fd);
2247 iconv_fd = (iconv_t)-1;
2249 # endif
2250 #endif
2252 if (!read_buffer && !read_stdin)
2253 close(fd); /* errors are ignored */
2254 vim_free(buffer);
2256 #ifdef HAVE_DUP
2257 if (read_stdin)
2259 /* Use stderr for stdin, makes shell commands work. */
2260 close(0);
2261 ignored = dup(2);
2263 #endif
2265 #ifdef FEAT_MBYTE
2266 if (tmpname != NULL)
2268 mch_remove(tmpname); /* delete converted file */
2269 vim_free(tmpname);
2271 #endif
2272 --no_wait_return; /* may wait for return now */
2275 * In recovery mode everything but autocommands is skipped.
2277 if (!recoverymode)
2279 /* need to delete the last line, which comes from the empty buffer */
2280 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2282 #ifdef FEAT_NETBEANS_INTG
2283 netbeansFireChanges = 0;
2284 #endif
2285 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2286 #ifdef FEAT_NETBEANS_INTG
2287 netbeansFireChanges = 1;
2288 #endif
2289 --linecnt;
2291 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2292 if (filesize == 0)
2293 linecnt = 0;
2294 if (newfile || read_buffer)
2296 redraw_curbuf_later(NOT_VALID);
2297 #ifdef FEAT_DIFF
2298 /* After reading the text into the buffer the diff info needs to
2299 * be updated. */
2300 diff_invalidate(curbuf);
2301 #endif
2302 #ifdef FEAT_FOLDING
2303 /* All folds in the window are invalid now. Mark them for update
2304 * before triggering autocommands. */
2305 foldUpdateAll(curwin);
2306 #endif
2308 else if (linecnt) /* appended at least one line */
2309 appended_lines_mark(from, linecnt);
2311 #ifndef ALWAYS_USE_GUI
2313 * If we were reading from the same terminal as where messages go,
2314 * the screen will have been messed up.
2315 * Switch on raw mode now and clear the screen.
2317 if (read_stdin)
2319 settmode(TMODE_RAW); /* set to raw mode */
2320 starttermcap();
2321 screenclear();
2323 #endif
2325 if (got_int)
2327 if (!(flags & READ_DUMMY))
2329 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2330 if (newfile)
2331 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2333 msg_scroll = msg_save;
2334 #ifdef FEAT_VIMINFO
2335 check_marks_read();
2336 #endif
2337 return OK; /* an interrupt isn't really an error */
2340 if (!filtering && !(flags & READ_DUMMY))
2342 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2343 c = FALSE;
2345 #ifdef UNIX
2346 # ifdef S_ISFIFO
2347 if (S_ISFIFO(perm)) /* fifo or socket */
2349 STRCAT(IObuff, _("[fifo/socket]"));
2350 c = TRUE;
2352 # else
2353 # ifdef S_IFIFO
2354 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2356 STRCAT(IObuff, _("[fifo]"));
2357 c = TRUE;
2359 # endif
2360 # ifdef S_IFSOCK
2361 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2363 STRCAT(IObuff, _("[socket]"));
2364 c = TRUE;
2366 # endif
2367 # endif
2368 # ifdef OPEN_CHR_FILES
2369 if (S_ISCHR(perm)) /* or character special */
2371 STRCAT(IObuff, _("[character special]"));
2372 c = TRUE;
2374 # endif
2375 #endif
2376 if (curbuf->b_p_ro)
2378 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2379 c = TRUE;
2381 if (read_no_eol_lnum)
2383 msg_add_eol();
2384 c = TRUE;
2386 if (ff_error == EOL_DOS)
2388 STRCAT(IObuff, _("[CR missing]"));
2389 c = TRUE;
2391 if (split)
2393 STRCAT(IObuff, _("[long lines split]"));
2394 c = TRUE;
2396 #ifdef FEAT_MBYTE
2397 if (notconverted)
2399 STRCAT(IObuff, _("[NOT converted]"));
2400 c = TRUE;
2402 else if (converted)
2404 STRCAT(IObuff, _("[converted]"));
2405 c = TRUE;
2407 #endif
2408 #ifdef FEAT_CRYPT
2409 if (cryptkey != NULL)
2411 STRCAT(IObuff, _("[crypted]"));
2412 c = TRUE;
2414 #endif
2415 #ifdef FEAT_MBYTE
2416 if (conv_error != 0)
2418 sprintf((char *)IObuff + STRLEN(IObuff),
2419 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2420 c = TRUE;
2422 else if (illegal_byte > 0)
2424 sprintf((char *)IObuff + STRLEN(IObuff),
2425 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2426 c = TRUE;
2428 else
2429 #endif
2430 if (error)
2432 STRCAT(IObuff, _("[READ ERRORS]"));
2433 c = TRUE;
2435 if (msg_add_fileformat(fileformat))
2436 c = TRUE;
2437 #ifdef FEAT_CRYPT
2438 if (cryptkey != NULL)
2439 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2440 else
2441 #endif
2442 msg_add_lines(c, (long)linecnt, filesize);
2444 vim_free(keep_msg);
2445 keep_msg = NULL;
2446 msg_scrolled_ign = TRUE;
2447 #ifdef ALWAYS_USE_GUI
2448 /* Don't show the message when reading stdin, it would end up in a
2449 * message box (which might be shown when exiting!) */
2450 if (read_stdin || read_buffer)
2451 p = msg_may_trunc(FALSE, IObuff);
2452 else
2453 #endif
2454 p = msg_trunc_attr(IObuff, FALSE, 0);
2455 if (read_stdin || read_buffer || restart_edit != 0
2456 || (msg_scrolled != 0 && !need_wait_return))
2457 /* Need to repeat the message after redrawing when:
2458 * - When reading from stdin (the screen will be cleared next).
2459 * - When restart_edit is set (otherwise there will be a delay
2460 * before redrawing).
2461 * - When the screen was scrolled but there is no wait-return
2462 * prompt. */
2463 set_keep_msg(p, 0);
2464 msg_scrolled_ign = FALSE;
2467 /* with errors writing the file requires ":w!" */
2468 if (newfile && (error
2469 #ifdef FEAT_MBYTE
2470 || conv_error != 0
2471 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2472 #endif
2474 curbuf->b_p_ro = TRUE;
2476 u_clearline(); /* cannot use "U" command after adding lines */
2479 * In Ex mode: cursor at last new line.
2480 * Otherwise: cursor at first new line.
2482 if (exmode_active)
2483 curwin->w_cursor.lnum = from + linecnt;
2484 else
2485 curwin->w_cursor.lnum = from + 1;
2486 check_cursor_lnum();
2487 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2490 * Set '[ and '] marks to the newly read lines.
2492 curbuf->b_op_start.lnum = from + 1;
2493 curbuf->b_op_start.col = 0;
2494 curbuf->b_op_end.lnum = from + linecnt;
2495 curbuf->b_op_end.col = 0;
2497 #ifdef WIN32
2499 * Work around a weird problem: When a file has two links (only
2500 * possible on NTFS) and we write through one link, then stat() it
2501 * through the other link, the timestamp information may be wrong.
2502 * It's correct again after reading the file, thus reset the timestamp
2503 * here.
2505 if (newfile && !read_stdin && !read_buffer
2506 && mch_stat((char *)fname, &st) >= 0)
2508 buf_store_time(curbuf, &st, fname);
2509 curbuf->b_mtime_read = curbuf->b_mtime;
2511 #endif
2513 msg_scroll = msg_save;
2515 #ifdef FEAT_VIMINFO
2517 * Get the marks before executing autocommands, so they can be used there.
2519 check_marks_read();
2520 #endif
2523 * Trick: We remember if the last line of the read didn't have
2524 * an eol for when writing it again. This is required for
2525 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2527 write_no_eol_lnum = read_no_eol_lnum;
2529 #ifdef FEAT_AUTOCMD
2530 if (!read_stdin && !read_buffer)
2532 int m = msg_scroll;
2533 int n = msg_scrolled;
2535 /* Save the fileformat now, otherwise the buffer will be considered
2536 * modified if the format/encoding was automatically detected. */
2537 if (set_options)
2538 save_file_ff(curbuf);
2541 * The output from the autocommands should not overwrite anything and
2542 * should not be overwritten: Set msg_scroll, restore its value if no
2543 * output was done.
2545 msg_scroll = TRUE;
2546 if (filtering)
2547 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2548 FALSE, curbuf, eap);
2549 else if (newfile)
2550 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2551 FALSE, curbuf, eap);
2552 else
2553 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2554 FALSE, NULL, eap);
2555 if (msg_scrolled == n)
2556 msg_scroll = m;
2557 #ifdef FEAT_EVAL
2558 if (aborting()) /* autocmds may abort script processing */
2559 return FAIL;
2560 #endif
2562 #endif
2564 if (recoverymode && error)
2565 return FAIL;
2566 return OK;
2569 #ifdef OPEN_CHR_FILES
2571 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2572 * which is the name of files used for process substitution output by
2573 * some shells on some operating systems, e.g., bash on SunOS.
2574 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2576 static int
2577 is_dev_fd_file(fname)
2578 char_u *fname;
2580 return (STRNCMP(fname, "/dev/fd/", 8) == 0
2581 && VIM_ISDIGIT(fname[8])
2582 && *skipdigits(fname + 9) == NUL
2583 && (fname[9] != NUL
2584 || (fname[8] != '0' && fname[8] != '1' && fname[8] != '2')));
2586 #endif
2588 #ifdef FEAT_MBYTE
2591 * From the current line count and characters read after that, estimate the
2592 * line number where we are now.
2593 * Used for error messages that include a line number.
2595 static linenr_T
2596 readfile_linenr(linecnt, p, endp)
2597 linenr_T linecnt; /* line count before reading more bytes */
2598 char_u *p; /* start of more bytes read */
2599 char_u *endp; /* end of more bytes read */
2601 char_u *s;
2602 linenr_T lnum;
2604 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2605 for (s = p; s < endp; ++s)
2606 if (*s == '\n')
2607 ++lnum;
2608 return lnum;
2610 #endif
2613 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2614 * equal to the buffer "buf". Used for calling readfile().
2615 * Returns OK or FAIL.
2618 prep_exarg(eap, buf)
2619 exarg_T *eap;
2620 buf_T *buf;
2622 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2623 #ifdef FEAT_MBYTE
2624 + STRLEN(buf->b_p_fenc)
2625 #endif
2626 + 15));
2627 if (eap->cmd == NULL)
2628 return FAIL;
2630 #ifdef FEAT_MBYTE
2631 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2632 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2633 eap->bad_char = buf->b_bad_char;
2634 #else
2635 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2636 #endif
2637 eap->force_ff = 7;
2639 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2640 eap->read_edit = FALSE;
2641 eap->forceit = FALSE;
2642 return OK;
2645 #ifdef FEAT_MBYTE
2647 * Find next fileencoding to use from 'fileencodings'.
2648 * "pp" points to fenc_next. It's advanced to the next item.
2649 * When there are no more items, an empty string is returned and *pp is set to
2650 * NULL.
2651 * When *pp is not set to NULL, the result is in allocated memory.
2653 static char_u *
2654 next_fenc(pp)
2655 char_u **pp;
2657 char_u *p;
2658 char_u *r;
2660 if (**pp == NUL)
2662 *pp = NULL;
2663 return (char_u *)"";
2665 p = vim_strchr(*pp, ',');
2666 if (p == NULL)
2668 r = enc_canonize(*pp);
2669 *pp += STRLEN(*pp);
2671 else
2673 r = vim_strnsave(*pp, (int)(p - *pp));
2674 *pp = p + 1;
2675 if (r != NULL)
2677 p = enc_canonize(r);
2678 vim_free(r);
2679 r = p;
2682 if (r == NULL) /* out of memory */
2684 r = (char_u *)"";
2685 *pp = NULL;
2687 return r;
2690 # ifdef FEAT_EVAL
2692 * Convert a file with the 'charconvert' expression.
2693 * This closes the file which is to be read, converts it and opens the
2694 * resulting file for reading.
2695 * Returns name of the resulting converted file (the caller should delete it
2696 * after reading it).
2697 * Returns NULL if the conversion failed ("*fdp" is not set) .
2699 static char_u *
2700 readfile_charconvert(fname, fenc, fdp)
2701 char_u *fname; /* name of input file */
2702 char_u *fenc; /* converted from */
2703 int *fdp; /* in/out: file descriptor of file */
2705 char_u *tmpname;
2706 char_u *errmsg = NULL;
2708 tmpname = vim_tempname('r');
2709 if (tmpname == NULL)
2710 errmsg = (char_u *)_("Can't find temp file for conversion");
2711 else
2713 close(*fdp); /* close the input file, ignore errors */
2714 *fdp = -1;
2715 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2716 fname, tmpname) == FAIL)
2717 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2718 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2719 O_RDONLY | O_EXTRA, 0)) < 0)
2720 errmsg = (char_u *)_("can't read output of 'charconvert'");
2723 if (errmsg != NULL)
2725 /* Don't use emsg(), it breaks mappings, the retry with
2726 * another type of conversion might still work. */
2727 MSG(errmsg);
2728 if (tmpname != NULL)
2730 mch_remove(tmpname); /* delete converted file */
2731 vim_free(tmpname);
2732 tmpname = NULL;
2736 /* If the input file is closed, open it (caller should check for error). */
2737 if (*fdp < 0)
2738 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2740 return tmpname;
2742 # endif
2744 #endif
2746 #ifdef FEAT_VIMINFO
2748 * Read marks for the current buffer from the viminfo file, when we support
2749 * buffer marks and the buffer has a name.
2751 static void
2752 check_marks_read()
2754 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2755 && curbuf->b_ffname != NULL)
2756 read_viminfo(NULL, VIF_WANT_MARKS);
2758 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2759 * the ' parameter after opening a buffer. */
2760 curbuf->b_marks_read = TRUE;
2762 #endif
2764 #ifdef FEAT_CRYPT
2766 * Check for magic number used for encryption.
2767 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2768 * *filesizep are updated.
2769 * Return the (new) encryption key, NULL for no encryption.
2771 static char_u *
2772 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2773 char_u *cryptkey; /* previous encryption key or NULL */
2774 char_u *ptr; /* pointer to read bytes */
2775 long *sizep; /* length of read bytes */
2776 long *filesizep; /* nr of bytes used from file */
2777 int newfile; /* editing a new buffer */
2779 if (*sizep >= CRYPT_MAGIC_LEN
2780 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2782 if (cryptkey == NULL)
2784 if (*curbuf->b_p_key)
2785 cryptkey = curbuf->b_p_key;
2786 else
2788 /* When newfile is TRUE, store the typed key
2789 * in the 'key' option and don't free it. */
2790 cryptkey = get_crypt_key(newfile, FALSE);
2791 /* check if empty key entered */
2792 if (cryptkey != NULL && *cryptkey == NUL)
2794 if (cryptkey != curbuf->b_p_key)
2795 vim_free(cryptkey);
2796 cryptkey = NULL;
2801 if (cryptkey != NULL)
2803 crypt_init_keys(cryptkey);
2805 /* Remove magic number from the text */
2806 *filesizep += CRYPT_MAGIC_LEN;
2807 *sizep -= CRYPT_MAGIC_LEN;
2808 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2811 /* When starting to edit a new file which does not have
2812 * encryption, clear the 'key' option, except when
2813 * starting up (called with -x argument) */
2814 else if (newfile && *curbuf->b_p_key && !starting)
2815 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2817 return cryptkey;
2819 #endif
2821 #ifdef UNIX
2822 static void
2823 set_file_time(fname, atime, mtime)
2824 char_u *fname;
2825 time_t atime; /* access time */
2826 time_t mtime; /* modification time */
2828 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2829 struct utimbuf buf;
2831 buf.actime = atime;
2832 buf.modtime = mtime;
2833 (void)utime((char *)fname, &buf);
2834 # else
2835 # if defined(HAVE_UTIMES)
2836 struct timeval tvp[2];
2838 tvp[0].tv_sec = atime;
2839 tvp[0].tv_usec = 0;
2840 tvp[1].tv_sec = mtime;
2841 tvp[1].tv_usec = 0;
2842 # ifdef NeXT
2843 (void)utimes((char *)fname, tvp);
2844 # else
2845 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2846 # endif
2847 # endif
2848 # endif
2850 #endif /* UNIX */
2852 #if defined(VMS) && !defined(MIN)
2853 /* Older DECC compiler for VAX doesn't define MIN() */
2854 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2855 #endif
2858 * Return TRUE if a file appears to be read-only from the file permissions.
2861 check_file_readonly(fname, perm)
2862 char_u *fname; /* full path to file */
2863 int perm; /* known permissions on file */
2865 #ifndef USE_MCH_ACCESS
2866 int fd = 0;
2867 #endif
2869 return (
2870 #ifdef USE_MCH_ACCESS
2871 # ifdef UNIX
2872 (perm & 0222) == 0 ||
2873 # endif
2874 mch_access((char *)fname, W_OK)
2875 #else
2876 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
2877 ? TRUE : (close(fd), FALSE)
2878 #endif
2884 * buf_write() - write to file "fname" lines "start" through "end"
2886 * We do our own buffering here because fwrite() is so slow.
2888 * If "forceit" is true, we don't care for errors when attempting backups.
2889 * In case of an error everything possible is done to restore the original
2890 * file. But when "forceit" is TRUE, we risk losing it.
2892 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2893 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2895 * This function must NOT use NameBuff (because it's called by autowrite()).
2897 * return FAIL for failure, OK otherwise
2900 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2901 reset_changed, filtering)
2902 buf_T *buf;
2903 char_u *fname;
2904 char_u *sfname;
2905 linenr_T start, end;
2906 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2907 NULL! */
2908 int append; /* append to the file */
2909 int forceit;
2910 int reset_changed;
2911 int filtering;
2913 int fd;
2914 char_u *backup = NULL;
2915 int backup_copy = FALSE; /* copy the original file? */
2916 int dobackup;
2917 char_u *ffname;
2918 char_u *wfname = NULL; /* name of file to write to */
2919 char_u *s;
2920 char_u *ptr;
2921 char_u c;
2922 int len;
2923 linenr_T lnum;
2924 long nchars;
2925 char_u *errmsg = NULL;
2926 char_u *errnum = NULL;
2927 char_u *buffer;
2928 char_u smallbuf[SMBUFSIZE];
2929 char_u *backup_ext;
2930 int bufsize;
2931 long perm; /* file permissions */
2932 int retval = OK;
2933 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2934 int msg_save = msg_scroll;
2935 int overwriting; /* TRUE if writing over original */
2936 int no_eol = FALSE; /* no end-of-line written */
2937 int device = FALSE; /* writing to a device */
2938 struct stat st_old;
2939 int prev_got_int = got_int;
2940 int file_readonly = FALSE; /* overwritten file is read-only */
2941 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2942 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2943 int made_writable = FALSE; /* 'w' bit has been set */
2944 #endif
2945 /* writing everything */
2946 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2947 #ifdef FEAT_AUTOCMD
2948 linenr_T old_line_count = buf->b_ml.ml_line_count;
2949 #endif
2950 int attr;
2951 int fileformat;
2952 int write_bin;
2953 struct bw_info write_info; /* info for buf_write_bytes() */
2954 #ifdef FEAT_MBYTE
2955 int converted = FALSE;
2956 int notconverted = FALSE;
2957 char_u *fenc; /* effective 'fileencoding' */
2958 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2959 #endif
2960 #ifdef HAS_BW_FLAGS
2961 int wb_flags = 0;
2962 #endif
2963 #ifdef HAVE_ACL
2964 vim_acl_T acl = NULL; /* ACL copied from original file to
2965 backup or new file */
2966 #endif
2968 if (fname == NULL || *fname == NUL) /* safety check */
2969 return FAIL;
2972 * Disallow writing from .exrc and .vimrc in current directory for
2973 * security reasons.
2975 if (check_secure())
2976 return FAIL;
2978 /* Avoid a crash for a long name. */
2979 if (STRLEN(fname) >= MAXPATHL)
2981 EMSG(_(e_longname));
2982 return FAIL;
2985 #ifdef FEAT_MBYTE
2986 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2987 write_info.bw_conv_buf = NULL;
2988 write_info.bw_conv_error = FALSE;
2989 write_info.bw_restlen = 0;
2990 # ifdef USE_ICONV
2991 write_info.bw_iconv_fd = (iconv_t)-1;
2992 # endif
2993 #endif
2995 /* After writing a file changedtick changes but we don't want to display
2996 * the line. */
2997 ex_no_reprint = TRUE;
3000 * If there is no file name yet, use the one for the written file.
3001 * BF_NOTEDITED is set to reflect this (in case the write fails).
3002 * Don't do this when the write is for a filter command.
3003 * Don't do this when appending.
3004 * Only do this when 'cpoptions' contains the 'F' flag.
3006 if (buf->b_ffname == NULL
3007 && reset_changed
3008 && whole
3009 && buf == curbuf
3010 #ifdef FEAT_QUICKFIX
3011 && !bt_nofile(buf)
3012 #endif
3013 && !filtering
3014 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
3015 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
3017 if (set_rw_fname(fname, sfname) == FAIL)
3018 return FAIL;
3019 buf = curbuf; /* just in case autocmds made "buf" invalid */
3022 if (sfname == NULL)
3023 sfname = fname;
3025 * For Unix: Use the short file name whenever possible.
3026 * Avoids problems with networks and when directory names are changed.
3027 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
3028 * another directory, which we don't detect
3030 ffname = fname; /* remember full fname */
3031 #ifdef UNIX
3032 fname = sfname;
3033 #endif
3035 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
3036 overwriting = TRUE;
3037 else
3038 overwriting = FALSE;
3040 if (exiting)
3041 settmode(TMODE_COOK); /* when exiting allow typahead now */
3043 ++no_wait_return; /* don't wait for return yet */
3046 * Set '[ and '] marks to the lines to be written.
3048 buf->b_op_start.lnum = start;
3049 buf->b_op_start.col = 0;
3050 buf->b_op_end.lnum = end;
3051 buf->b_op_end.col = 0;
3053 #ifdef FEAT_AUTOCMD
3055 aco_save_T aco;
3056 int buf_ffname = FALSE;
3057 int buf_sfname = FALSE;
3058 int buf_fname_f = FALSE;
3059 int buf_fname_s = FALSE;
3060 int did_cmd = FALSE;
3061 int nofile_err = FALSE;
3062 int empty_memline = (buf->b_ml.ml_mfp == NULL);
3065 * Apply PRE aucocommands.
3066 * Set curbuf to the buffer to be written.
3067 * Careful: The autocommands may call buf_write() recursively!
3069 if (ffname == buf->b_ffname)
3070 buf_ffname = TRUE;
3071 if (sfname == buf->b_sfname)
3072 buf_sfname = TRUE;
3073 if (fname == buf->b_ffname)
3074 buf_fname_f = TRUE;
3075 if (fname == buf->b_sfname)
3076 buf_fname_s = TRUE;
3078 /* set curwin/curbuf to buf and save a few things */
3079 aucmd_prepbuf(&aco, buf);
3081 if (append)
3083 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
3084 sfname, sfname, FALSE, curbuf, eap)))
3086 #ifdef FEAT_QUICKFIX
3087 if (overwriting && bt_nofile(curbuf))
3088 nofile_err = TRUE;
3089 else
3090 #endif
3091 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
3092 sfname, sfname, FALSE, curbuf, eap);
3095 else if (filtering)
3097 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
3098 NULL, sfname, FALSE, curbuf, eap);
3100 else if (reset_changed && whole)
3102 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
3103 sfname, sfname, FALSE, curbuf, eap)))
3105 #ifdef FEAT_QUICKFIX
3106 if (overwriting && bt_nofile(curbuf))
3107 nofile_err = TRUE;
3108 else
3109 #endif
3110 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
3111 sfname, sfname, FALSE, curbuf, eap);
3114 else
3116 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
3117 sfname, sfname, FALSE, curbuf, eap)))
3119 #ifdef FEAT_QUICKFIX
3120 if (overwriting && bt_nofile(curbuf))
3121 nofile_err = TRUE;
3122 else
3123 #endif
3124 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
3125 sfname, sfname, FALSE, curbuf, eap);
3129 /* restore curwin/curbuf and a few other things */
3130 aucmd_restbuf(&aco);
3133 * In three situations we return here and don't write the file:
3134 * 1. the autocommands deleted or unloaded the buffer.
3135 * 2. The autocommands abort script processing.
3136 * 3. If one of the "Cmd" autocommands was executed.
3138 if (!buf_valid(buf))
3139 buf = NULL;
3140 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
3141 || did_cmd || nofile_err
3142 #ifdef FEAT_EVAL
3143 || aborting()
3144 #endif
3147 --no_wait_return;
3148 msg_scroll = msg_save;
3149 if (nofile_err)
3150 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3152 if (nofile_err
3153 #ifdef FEAT_EVAL
3154 || aborting()
3155 #endif
3157 /* An aborting error, interrupt or exception in the
3158 * autocommands. */
3159 return FAIL;
3160 if (did_cmd)
3162 if (buf == NULL)
3163 /* The buffer was deleted. We assume it was written
3164 * (can't retry anyway). */
3165 return OK;
3166 if (overwriting)
3168 /* Assume the buffer was written, update the timestamp. */
3169 ml_timestamp(buf);
3170 if (append)
3171 buf->b_flags &= ~BF_NEW;
3172 else
3173 buf->b_flags &= ~BF_WRITE_MASK;
3175 if (reset_changed && buf->b_changed && !append
3176 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3177 /* Buffer still changed, the autocommands didn't work
3178 * properly. */
3179 return FAIL;
3180 return OK;
3182 #ifdef FEAT_EVAL
3183 if (!aborting())
3184 #endif
3185 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3186 return FAIL;
3190 * The autocommands may have changed the number of lines in the file.
3191 * When writing the whole file, adjust the end.
3192 * When writing part of the file, assume that the autocommands only
3193 * changed the number of lines that are to be written (tricky!).
3195 if (buf->b_ml.ml_line_count != old_line_count)
3197 if (whole) /* write all */
3198 end = buf->b_ml.ml_line_count;
3199 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3200 end += buf->b_ml.ml_line_count - old_line_count;
3201 else /* less lines */
3203 end -= old_line_count - buf->b_ml.ml_line_count;
3204 if (end < start)
3206 --no_wait_return;
3207 msg_scroll = msg_save;
3208 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3209 return FAIL;
3215 * The autocommands may have changed the name of the buffer, which may
3216 * be kept in fname, ffname and sfname.
3218 if (buf_ffname)
3219 ffname = buf->b_ffname;
3220 if (buf_sfname)
3221 sfname = buf->b_sfname;
3222 if (buf_fname_f)
3223 fname = buf->b_ffname;
3224 if (buf_fname_s)
3225 fname = buf->b_sfname;
3227 #endif
3229 #ifdef FEAT_NETBEANS_INTG
3230 if (usingNetbeans && isNetbeansBuffer(buf))
3232 if (whole)
3235 * b_changed can be 0 after an undo, but we still need to write
3236 * the buffer to NetBeans.
3238 if (buf->b_changed || isNetbeansModified(buf))
3240 --no_wait_return; /* may wait for return now */
3241 msg_scroll = msg_save;
3242 netbeans_save_buffer(buf); /* no error checking... */
3243 return retval;
3245 else
3247 errnum = (char_u *)"E656: ";
3248 errmsg = (char_u *)_("NetBeans disallows writes of unmodified buffers");
3249 buffer = NULL;
3250 goto fail;
3253 else
3255 errnum = (char_u *)"E657: ";
3256 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3257 buffer = NULL;
3258 goto fail;
3261 #endif
3263 if (shortmess(SHM_OVER) && !exiting)
3264 msg_scroll = FALSE; /* overwrite previous file message */
3265 else
3266 msg_scroll = TRUE; /* don't overwrite previous file message */
3267 if (!filtering)
3268 filemess(buf,
3269 #ifndef UNIX
3270 sfname,
3271 #else
3272 fname,
3273 #endif
3274 (char_u *)"", 0); /* show that we are busy */
3275 msg_scroll = FALSE; /* always overwrite the file message now */
3277 buffer = alloc(BUFSIZE);
3278 if (buffer == NULL) /* can't allocate big buffer, use small
3279 * one (to be able to write when out of
3280 * memory) */
3282 buffer = smallbuf;
3283 bufsize = SMBUFSIZE;
3285 else
3286 bufsize = BUFSIZE;
3289 * Get information about original file (if there is one).
3291 #if defined(UNIX) && !defined(ARCHIE)
3292 st_old.st_dev = 0;
3293 st_old.st_ino = 0;
3294 perm = -1;
3295 if (mch_stat((char *)fname, &st_old) < 0)
3296 newfile = TRUE;
3297 else
3299 perm = st_old.st_mode;
3300 if (!S_ISREG(st_old.st_mode)) /* not a file */
3302 if (S_ISDIR(st_old.st_mode))
3304 errnum = (char_u *)"E502: ";
3305 errmsg = (char_u *)_("is a directory");
3306 goto fail;
3308 if (mch_nodetype(fname) != NODE_WRITABLE)
3310 errnum = (char_u *)"E503: ";
3311 errmsg = (char_u *)_("is not a file or writable device");
3312 goto fail;
3314 /* It's a device of some kind (or a fifo) which we can write to
3315 * but for which we can't make a backup. */
3316 device = TRUE;
3317 newfile = TRUE;
3318 perm = -1;
3321 #else /* !UNIX */
3323 * Check for a writable device name.
3325 c = mch_nodetype(fname);
3326 if (c == NODE_OTHER)
3328 errnum = (char_u *)"E503: ";
3329 errmsg = (char_u *)_("is not a file or writable device");
3330 goto fail;
3332 if (c == NODE_WRITABLE)
3334 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3335 /* MS-Windows allows opening a device, but we will probably get stuck
3336 * trying to write to it. */
3337 if (!p_odev)
3339 errnum = (char_u *)"E796: ";
3340 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3341 goto fail;
3343 # endif
3344 device = TRUE;
3345 newfile = TRUE;
3346 perm = -1;
3348 else
3350 perm = mch_getperm(fname);
3351 if (perm < 0)
3352 newfile = TRUE;
3353 else if (mch_isdir(fname))
3355 errnum = (char_u *)"E502: ";
3356 errmsg = (char_u *)_("is a directory");
3357 goto fail;
3359 if (overwriting)
3360 (void)mch_stat((char *)fname, &st_old);
3362 #endif /* !UNIX */
3364 if (!device && !newfile)
3367 * Check if the file is really writable (when renaming the file to
3368 * make a backup we won't discover it later).
3370 file_readonly = check_file_readonly(fname, (int)perm);
3372 if (!forceit && file_readonly)
3374 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3376 errnum = (char_u *)"E504: ";
3377 errmsg = (char_u *)_(err_readonly);
3379 else
3381 errnum = (char_u *)"E505: ";
3382 errmsg = (char_u *)_("is read-only (add ! to override)");
3384 goto fail;
3388 * Check if the timestamp hasn't changed since reading the file.
3390 if (overwriting)
3392 retval = check_mtime(buf, &st_old);
3393 if (retval == FAIL)
3394 goto fail;
3398 #ifdef HAVE_ACL
3400 * For systems that support ACL: get the ACL from the original file.
3402 if (!newfile)
3403 acl = mch_get_acl(fname);
3404 #endif
3407 * If 'backupskip' is not empty, don't make a backup for some files.
3409 dobackup = (p_wb || p_bk || *p_pm != NUL);
3410 #ifdef FEAT_WILDIGN
3411 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3412 dobackup = FALSE;
3413 #endif
3416 * Save the value of got_int and reset it. We don't want a previous
3417 * interruption cancel writing, only hitting CTRL-C while writing should
3418 * abort it.
3420 prev_got_int = got_int;
3421 got_int = FALSE;
3423 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3424 buf->b_saving = TRUE;
3427 * If we are not appending or filtering, the file exists, and the
3428 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3429 * When 'patchmode' is set also make a backup when appending.
3431 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3432 * off. This helps when editing large files on almost-full disks.
3434 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3436 #if defined(UNIX) || defined(WIN32)
3437 struct stat st;
3438 #endif
3440 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3441 backup_copy = TRUE;
3442 #if defined(UNIX) || defined(WIN32)
3443 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3445 int i;
3447 # ifdef UNIX
3449 * Don't rename the file when:
3450 * - it's a hard link
3451 * - it's a symbolic link
3452 * - we don't have write permission in the directory
3453 * - we can't set the owner/group of the new file
3455 if (st_old.st_nlink > 1
3456 || mch_lstat((char *)fname, &st) < 0
3457 || st.st_dev != st_old.st_dev
3458 || st.st_ino != st_old.st_ino
3459 # ifndef HAVE_FCHOWN
3460 || st.st_uid != st_old.st_uid
3461 || st.st_gid != st_old.st_gid
3462 # endif
3464 backup_copy = TRUE;
3465 else
3466 # else
3467 # ifdef WIN32
3468 /* On NTFS file systems hard links are possible. */
3469 if (mch_is_linked(fname))
3470 backup_copy = TRUE;
3471 else
3472 # endif
3473 # endif
3476 * Check if we can create a file and set the owner/group to
3477 * the ones from the original file.
3478 * First find a file name that doesn't exist yet (use some
3479 * arbitrary numbers).
3481 STRCPY(IObuff, fname);
3482 for (i = 4913; ; i += 123)
3484 sprintf((char *)gettail(IObuff), "%d", i);
3485 if (mch_lstat((char *)IObuff, &st) < 0)
3486 break;
3488 fd = mch_open((char *)IObuff,
3489 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3490 if (fd < 0) /* can't write in directory */
3491 backup_copy = TRUE;
3492 else
3494 # ifdef UNIX
3495 # ifdef HAVE_FCHOWN
3496 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
3497 # endif
3498 if (mch_stat((char *)IObuff, &st) < 0
3499 || st.st_uid != st_old.st_uid
3500 || st.st_gid != st_old.st_gid
3501 || st.st_mode != perm)
3502 backup_copy = TRUE;
3503 # endif
3504 /* Close the file before removing it, on MS-Windows we
3505 * can't delete an open file. */
3506 close(fd);
3507 mch_remove(IObuff);
3512 # ifdef UNIX
3514 * Break symlinks and/or hardlinks if we've been asked to.
3516 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3518 int lstat_res;
3520 lstat_res = mch_lstat((char *)fname, &st);
3522 /* Symlinks. */
3523 if ((bkc_flags & BKC_BREAKSYMLINK)
3524 && lstat_res == 0
3525 && st.st_ino != st_old.st_ino)
3526 backup_copy = FALSE;
3528 /* Hardlinks. */
3529 if ((bkc_flags & BKC_BREAKHARDLINK)
3530 && st_old.st_nlink > 1
3531 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3532 backup_copy = FALSE;
3534 #endif
3536 #endif
3538 /* make sure we have a valid backup extension to use */
3539 if (*p_bex == NUL)
3541 #ifdef RISCOS
3542 backup_ext = (char_u *)"/bak";
3543 #else
3544 backup_ext = (char_u *)".bak";
3545 #endif
3547 else
3548 backup_ext = p_bex;
3550 if (backup_copy
3551 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3553 int bfd;
3554 char_u *copybuf, *wp;
3555 int some_error = FALSE;
3556 struct stat st_new;
3557 char_u *dirp;
3558 char_u *rootname;
3559 #if defined(UNIX) && !defined(SHORT_FNAME)
3560 int did_set_shortname;
3561 #endif
3563 copybuf = alloc(BUFSIZE + 1);
3564 if (copybuf == NULL)
3566 some_error = TRUE; /* out of memory */
3567 goto nobackup;
3571 * Try to make the backup in each directory in the 'bdir' option.
3573 * Unix semantics has it, that we may have a writable file,
3574 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3575 * - the directory is not writable,
3576 * - the file may be a symbolic link,
3577 * - the file may belong to another user/group, etc.
3579 * For these reasons, the existing writable file must be truncated
3580 * and reused. Creation of a backup COPY will be attempted.
3582 dirp = p_bdir;
3583 while (*dirp)
3585 #ifdef UNIX
3586 st_new.st_ino = 0;
3587 st_new.st_dev = 0;
3588 st_new.st_gid = 0;
3589 #endif
3592 * Isolate one directory name, using an entry in 'bdir'.
3594 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3595 rootname = get_file_in_dir(fname, copybuf);
3596 if (rootname == NULL)
3598 some_error = TRUE; /* out of memory */
3599 goto nobackup;
3602 #if defined(UNIX) && !defined(SHORT_FNAME)
3603 did_set_shortname = FALSE;
3604 #endif
3607 * May try twice if 'shortname' not set.
3609 for (;;)
3612 * Make backup file name.
3614 backup = buf_modname(
3615 #ifdef SHORT_FNAME
3616 TRUE,
3617 #else
3618 (buf->b_p_sn || buf->b_shortname),
3619 #endif
3620 rootname, backup_ext, FALSE);
3621 if (backup == NULL)
3623 vim_free(rootname);
3624 some_error = TRUE; /* out of memory */
3625 goto nobackup;
3629 * Check if backup file already exists.
3631 if (mch_stat((char *)backup, &st_new) >= 0)
3633 #ifdef UNIX
3635 * Check if backup file is same as original file.
3636 * May happen when modname() gave the same file back.
3637 * E.g. silly link, or file name-length reached.
3638 * If we don't check here, we either ruin the file
3639 * when copying or erase it after writing. jw.
3641 if (st_new.st_dev == st_old.st_dev
3642 && st_new.st_ino == st_old.st_ino)
3644 vim_free(backup);
3645 backup = NULL; /* no backup file to delete */
3646 # ifndef SHORT_FNAME
3648 * may try again with 'shortname' set
3650 if (!(buf->b_shortname || buf->b_p_sn))
3652 buf->b_shortname = TRUE;
3653 did_set_shortname = TRUE;
3654 continue;
3656 /* setting shortname didn't help */
3657 if (did_set_shortname)
3658 buf->b_shortname = FALSE;
3659 # endif
3660 break;
3662 #endif
3665 * If we are not going to keep the backup file, don't
3666 * delete an existing one, try to use another name.
3667 * Change one character, just before the extension.
3669 if (!p_bk)
3671 wp = backup + STRLEN(backup) - 1
3672 - STRLEN(backup_ext);
3673 if (wp < backup) /* empty file name ??? */
3674 wp = backup;
3675 *wp = 'z';
3676 while (*wp > 'a'
3677 && mch_stat((char *)backup, &st_new) >= 0)
3678 --*wp;
3679 /* They all exist??? Must be something wrong. */
3680 if (*wp == 'a')
3682 vim_free(backup);
3683 backup = NULL;
3687 break;
3689 vim_free(rootname);
3692 * Try to create the backup file
3694 if (backup != NULL)
3696 /* remove old backup, if present */
3697 mch_remove(backup);
3698 /* Open with O_EXCL to avoid the file being created while
3699 * we were sleeping (symlink hacker attack?) */
3700 bfd = mch_open((char *)backup,
3701 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3702 perm & 0777);
3703 if (bfd < 0)
3705 vim_free(backup);
3706 backup = NULL;
3708 else
3710 /* set file protection same as original file, but
3711 * strip s-bit */
3712 (void)mch_setperm(backup, perm & 0777);
3714 #ifdef UNIX
3716 * Try to set the group of the backup same as the
3717 * original file. If this fails, set the protection
3718 * bits for the group same as the protection bits for
3719 * others.
3721 if (st_new.st_gid != st_old.st_gid
3722 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3723 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3724 # endif
3726 mch_setperm(backup,
3727 (perm & 0707) | ((perm & 07) << 3));
3728 # ifdef HAVE_SELINUX
3729 mch_copy_sec(fname, backup);
3730 # endif
3731 #endif
3734 * copy the file.
3736 write_info.bw_fd = bfd;
3737 write_info.bw_buf = copybuf;
3738 #ifdef HAS_BW_FLAGS
3739 write_info.bw_flags = FIO_NOCONVERT;
3740 #endif
3741 while ((write_info.bw_len = vim_read(fd, copybuf,
3742 BUFSIZE)) > 0)
3744 if (buf_write_bytes(&write_info) == FAIL)
3746 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3747 break;
3749 ui_breakcheck();
3750 if (got_int)
3752 errmsg = (char_u *)_(e_interr);
3753 break;
3757 if (close(bfd) < 0 && errmsg == NULL)
3758 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3759 if (write_info.bw_len < 0)
3760 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3761 #ifdef UNIX
3762 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3763 #endif
3764 #ifdef HAVE_ACL
3765 mch_set_acl(backup, acl);
3766 #endif
3767 #ifdef HAVE_SELINUX
3768 mch_copy_sec(fname, backup);
3769 #endif
3770 break;
3774 nobackup:
3775 close(fd); /* ignore errors for closing read file */
3776 vim_free(copybuf);
3778 if (backup == NULL && errmsg == NULL)
3779 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3780 /* ignore errors when forceit is TRUE */
3781 if ((some_error || errmsg != NULL) && !forceit)
3783 retval = FAIL;
3784 goto fail;
3786 errmsg = NULL;
3788 else
3790 char_u *dirp;
3791 char_u *p;
3792 char_u *rootname;
3795 * Make a backup by renaming the original file.
3798 * If 'cpoptions' includes the "W" flag, we don't want to
3799 * overwrite a read-only file. But rename may be possible
3800 * anyway, thus we need an extra check here.
3802 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3804 errnum = (char_u *)"E504: ";
3805 errmsg = (char_u *)_(err_readonly);
3806 goto fail;
3811 * Form the backup file name - change path/fo.o.h to
3812 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3813 * that works is used.
3815 dirp = p_bdir;
3816 while (*dirp)
3819 * Isolate one directory name and make the backup file name.
3821 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3822 rootname = get_file_in_dir(fname, IObuff);
3823 if (rootname == NULL)
3824 backup = NULL;
3825 else
3827 backup = buf_modname(
3828 #ifdef SHORT_FNAME
3829 TRUE,
3830 #else
3831 (buf->b_p_sn || buf->b_shortname),
3832 #endif
3833 rootname, backup_ext, FALSE);
3834 vim_free(rootname);
3837 if (backup != NULL)
3840 * If we are not going to keep the backup file, don't
3841 * delete an existing one, try to use another name.
3842 * Change one character, just before the extension.
3844 if (!p_bk && mch_getperm(backup) >= 0)
3846 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3847 if (p < backup) /* empty file name ??? */
3848 p = backup;
3849 *p = 'z';
3850 while (*p > 'a' && mch_getperm(backup) >= 0)
3851 --*p;
3852 /* They all exist??? Must be something wrong! */
3853 if (*p == 'a')
3855 vim_free(backup);
3856 backup = NULL;
3860 if (backup != NULL)
3863 * Delete any existing backup and move the current version
3864 * to the backup. For safety, we don't remove the backup
3865 * until the write has finished successfully. And if the
3866 * 'backup' option is set, leave it around.
3869 * If the renaming of the original file to the backup file
3870 * works, quit here.
3872 if (vim_rename(fname, backup) == 0)
3873 break;
3875 vim_free(backup); /* don't do the rename below */
3876 backup = NULL;
3879 if (backup == NULL && !forceit)
3881 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3882 goto fail;
3887 #if defined(UNIX) && !defined(ARCHIE)
3888 /* When using ":w!" and the file was read-only: make it writable */
3889 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3890 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3892 perm |= 0200;
3893 (void)mch_setperm(fname, perm);
3894 made_writable = TRUE;
3896 #endif
3898 /* When using ":w!" and writing to the current file, 'readonly' makes no
3899 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3900 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3902 buf->b_p_ro = FALSE;
3903 #ifdef FEAT_TITLE
3904 need_maketitle = TRUE; /* set window title later */
3905 #endif
3906 #ifdef FEAT_WINDOWS
3907 status_redraw_all(); /* redraw status lines later */
3908 #endif
3911 if (end > buf->b_ml.ml_line_count)
3912 end = buf->b_ml.ml_line_count;
3913 if (buf->b_ml.ml_flags & ML_EMPTY)
3914 start = end + 1;
3917 * If the original file is being overwritten, there is a small chance that
3918 * we crash in the middle of writing. Therefore the file is preserved now.
3919 * This makes all block numbers positive so that recovery does not need
3920 * the original file.
3921 * Don't do this if there is a backup file and we are exiting.
3923 if (reset_changed && !newfile && overwriting
3924 && !(exiting && backup != NULL))
3926 ml_preserve(buf, FALSE);
3927 if (got_int)
3929 errmsg = (char_u *)_(e_interr);
3930 goto restore_backup;
3934 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3936 * Before risking to lose the original file verify if there's
3937 * a resource fork to preserve, and if cannot be done warn
3938 * the users. This happens when overwriting without backups.
3940 if (backup == NULL && overwriting && !append)
3941 if (mch_has_resource_fork(fname))
3943 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3944 goto restore_backup;
3946 #endif
3948 #ifdef VMS
3949 vms_remove_version(fname); /* remove version */
3950 #endif
3951 /* Default: write the file directly. May write to a temp file for
3952 * multi-byte conversion. */
3953 wfname = fname;
3955 #ifdef FEAT_MBYTE
3956 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3957 if (eap != NULL && eap->force_enc != 0)
3959 fenc = eap->cmd + eap->force_enc;
3960 fenc = enc_canonize(fenc);
3961 fenc_tofree = fenc;
3963 else
3964 fenc = buf->b_p_fenc;
3967 * The file needs to be converted when 'fileencoding' is set and
3968 * 'fileencoding' differs from 'encoding'.
3970 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
3973 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3974 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3975 * Prepare the flags for it and allocate bw_conv_buf when needed.
3977 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3979 wb_flags = get_fio_flags(fenc);
3980 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3982 /* Need to allocate a buffer to translate into. */
3983 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3984 write_info.bw_conv_buflen = bufsize * 2;
3985 else /* FIO_UCS4 */
3986 write_info.bw_conv_buflen = bufsize * 4;
3987 write_info.bw_conv_buf
3988 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3989 if (write_info.bw_conv_buf == NULL)
3990 end = 0;
3994 # ifdef WIN3264
3995 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
3997 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3998 write_info.bw_conv_buflen = bufsize * 4;
3999 write_info.bw_conv_buf
4000 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4001 if (write_info.bw_conv_buf == NULL)
4002 end = 0;
4004 # endif
4006 # ifdef MACOS_X
4007 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
4009 write_info.bw_conv_buflen = bufsize * 3;
4010 write_info.bw_conv_buf
4011 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4012 if (write_info.bw_conv_buf == NULL)
4013 end = 0;
4015 # endif
4017 # if defined(FEAT_EVAL) || defined(USE_ICONV)
4018 if (converted && wb_flags == 0)
4020 # ifdef USE_ICONV
4022 * Use iconv() conversion when conversion is needed and it's not done
4023 * internally.
4025 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
4026 enc_utf8 ? (char_u *)"utf-8" : p_enc);
4027 if (write_info.bw_iconv_fd != (iconv_t)-1)
4029 /* We're going to use iconv(), allocate a buffer to convert in. */
4030 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
4031 write_info.bw_conv_buf
4032 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4033 if (write_info.bw_conv_buf == NULL)
4034 end = 0;
4035 write_info.bw_first = TRUE;
4037 # ifdef FEAT_EVAL
4038 else
4039 # endif
4040 # endif
4042 # ifdef FEAT_EVAL
4044 * When the file needs to be converted with 'charconvert' after
4045 * writing, write to a temp file instead and let the conversion
4046 * overwrite the original file.
4048 if (*p_ccv != NUL)
4050 wfname = vim_tempname('w');
4051 if (wfname == NULL) /* Can't write without a tempfile! */
4053 errmsg = (char_u *)_("E214: Can't find temp file for writing");
4054 goto restore_backup;
4057 # endif
4059 # endif
4060 if (converted && wb_flags == 0
4061 # ifdef USE_ICONV
4062 && write_info.bw_iconv_fd == (iconv_t)-1
4063 # endif
4064 # ifdef FEAT_EVAL
4065 && wfname == fname
4066 # endif
4069 if (!forceit)
4071 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
4072 goto restore_backup;
4074 notconverted = TRUE;
4076 #endif
4079 * Open the file "wfname" for writing.
4080 * We may try to open the file twice: If we can't write to the
4081 * file and forceit is TRUE we delete the existing file and try to create
4082 * a new one. If this still fails we may have lost the original file!
4083 * (this may happen when the user reached his quotum for number of files).
4084 * Appending will fail if the file does not exist and forceit is FALSE.
4086 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
4087 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
4088 : (O_CREAT | O_TRUNC))
4089 , perm < 0 ? 0666 : (perm & 0777))) < 0)
4092 * A forced write will try to create a new file if the old one is
4093 * still readonly. This may also happen when the directory is
4094 * read-only. In that case the mch_remove() will fail.
4096 if (errmsg == NULL)
4098 #ifdef UNIX
4099 struct stat st;
4101 /* Don't delete the file when it's a hard or symbolic link. */
4102 if ((!newfile && st_old.st_nlink > 1)
4103 || (mch_lstat((char *)fname, &st) == 0
4104 && (st.st_dev != st_old.st_dev
4105 || st.st_ino != st_old.st_ino)))
4106 errmsg = (char_u *)_("E166: Can't open linked file for writing");
4107 else
4108 #endif
4110 errmsg = (char_u *)_("E212: Can't open file for writing");
4111 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
4112 && perm >= 0)
4114 #ifdef UNIX
4115 /* we write to the file, thus it should be marked
4116 writable after all */
4117 if (!(perm & 0200))
4118 made_writable = TRUE;
4119 perm |= 0200;
4120 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
4121 perm &= 0777;
4122 #endif
4123 if (!append) /* don't remove when appending */
4124 mch_remove(wfname);
4125 continue;
4130 restore_backup:
4132 struct stat st;
4135 * If we failed to open the file, we don't need a backup. Throw it
4136 * away. If we moved or removed the original file try to put the
4137 * backup in its place.
4139 if (backup != NULL && wfname == fname)
4141 if (backup_copy)
4144 * There is a small chance that we removed the original,
4145 * try to move the copy in its place.
4146 * This may not work if the vim_rename() fails.
4147 * In that case we leave the copy around.
4149 /* If file does not exist, put the copy in its place */
4150 if (mch_stat((char *)fname, &st) < 0)
4151 vim_rename(backup, fname);
4152 /* if original file does exist throw away the copy */
4153 if (mch_stat((char *)fname, &st) >= 0)
4154 mch_remove(backup);
4156 else
4158 /* try to put the original file back */
4159 vim_rename(backup, fname);
4163 /* if original file no longer exists give an extra warning */
4164 if (!newfile && mch_stat((char *)fname, &st) < 0)
4165 end = 0;
4168 #ifdef FEAT_MBYTE
4169 if (wfname != fname)
4170 vim_free(wfname);
4171 #endif
4172 goto fail;
4174 errmsg = NULL;
4176 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4177 /* TODO: Is it need for MACOS_X? (Dany) */
4179 * On macintosh copy the original files attributes (i.e. the backup)
4180 * This is done in order to preserve the resource fork and the
4181 * Finder attribute (label, comments, custom icons, file creator)
4183 if (backup != NULL && overwriting && !append)
4185 if (backup_copy)
4186 (void)mch_copy_file_attribute(wfname, backup);
4187 else
4188 (void)mch_copy_file_attribute(backup, wfname);
4191 if (!overwriting && !append)
4193 if (buf->b_ffname != NULL)
4194 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4195 /* Should copy resource fork */
4197 #endif
4199 write_info.bw_fd = fd;
4201 #ifdef FEAT_CRYPT
4202 if (*buf->b_p_key && !filtering)
4204 crypt_init_keys(buf->b_p_key);
4205 /* Write magic number, so that Vim knows that this file is encrypted
4206 * when reading it again. This also undergoes utf-8 to ucs-2/4
4207 * conversion when needed. */
4208 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4209 write_info.bw_len = CRYPT_MAGIC_LEN;
4210 write_info.bw_flags = FIO_NOCONVERT;
4211 if (buf_write_bytes(&write_info) == FAIL)
4212 end = 0;
4213 wb_flags |= FIO_ENCRYPTED;
4215 #endif
4217 write_info.bw_buf = buffer;
4218 nchars = 0;
4220 /* use "++bin", "++nobin" or 'binary' */
4221 if (eap != NULL && eap->force_bin != 0)
4222 write_bin = (eap->force_bin == FORCE_BIN);
4223 else
4224 write_bin = buf->b_p_bin;
4226 #ifdef FEAT_MBYTE
4228 * The BOM is written just after the encryption magic number.
4229 * Skip it when appending and the file already existed, the BOM only makes
4230 * sense at the start of the file.
4232 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4234 write_info.bw_len = make_bom(buffer, fenc);
4235 if (write_info.bw_len > 0)
4237 /* don't convert, do encryption */
4238 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4239 if (buf_write_bytes(&write_info) == FAIL)
4240 end = 0;
4241 else
4242 nchars += write_info.bw_len;
4245 #endif
4247 write_info.bw_len = bufsize;
4248 #ifdef HAS_BW_FLAGS
4249 write_info.bw_flags = wb_flags;
4250 #endif
4251 fileformat = get_fileformat_force(buf, eap);
4252 s = buffer;
4253 len = 0;
4254 for (lnum = start; lnum <= end; ++lnum)
4257 * The next while loop is done once for each character written.
4258 * Keep it fast!
4260 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4261 while ((c = *++ptr) != NUL)
4263 if (c == NL)
4264 *s = NUL; /* replace newlines with NULs */
4265 else if (c == CAR && fileformat == EOL_MAC)
4266 *s = NL; /* Mac: replace CRs with NLs */
4267 else
4268 *s = c;
4269 ++s;
4270 if (++len != bufsize)
4271 continue;
4272 if (buf_write_bytes(&write_info) == FAIL)
4274 end = 0; /* write error: break loop */
4275 break;
4277 nchars += bufsize;
4278 s = buffer;
4279 len = 0;
4281 /* write failed or last line has no EOL: stop here */
4282 if (end == 0
4283 || (lnum == end
4284 && write_bin
4285 && (lnum == write_no_eol_lnum
4286 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4288 ++lnum; /* written the line, count it */
4289 no_eol = TRUE;
4290 break;
4292 if (fileformat == EOL_UNIX)
4293 *s++ = NL;
4294 else
4296 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4297 if (fileformat == EOL_DOS) /* write CR-NL */
4299 if (++len == bufsize)
4301 if (buf_write_bytes(&write_info) == FAIL)
4303 end = 0; /* write error: break loop */
4304 break;
4306 nchars += bufsize;
4307 s = buffer;
4308 len = 0;
4310 *s++ = NL;
4313 if (++len == bufsize && end)
4315 if (buf_write_bytes(&write_info) == FAIL)
4317 end = 0; /* write error: break loop */
4318 break;
4320 nchars += bufsize;
4321 s = buffer;
4322 len = 0;
4324 ui_breakcheck();
4325 if (got_int)
4327 end = 0; /* Interrupted, break loop */
4328 break;
4331 #ifdef VMS
4333 * On VMS there is a problem: newlines get added when writing blocks
4334 * at a time. Fix it by writing a line at a time.
4335 * This is much slower!
4336 * Explanation: VAX/DECC RTL insists that records in some RMS
4337 * structures end with a newline (carriage return) character, and if
4338 * they don't it adds one.
4339 * With other RMS structures it works perfect without this fix.
4341 if (buf->b_fab_rfm == FAB$C_VFC
4342 || ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0))
4344 int b2write;
4346 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4347 ? MIN(4096, bufsize)
4348 : MIN(buf->b_fab_mrs, bufsize));
4350 b2write = len;
4351 while (b2write > 0)
4353 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4354 if (buf_write_bytes(&write_info) == FAIL)
4356 end = 0;
4357 break;
4359 b2write -= MIN(b2write, buf->b_fab_mrs);
4361 write_info.bw_len = bufsize;
4362 nchars += len;
4363 s = buffer;
4364 len = 0;
4366 #endif
4368 if (len > 0 && end > 0)
4370 write_info.bw_len = len;
4371 if (buf_write_bytes(&write_info) == FAIL)
4372 end = 0; /* write error */
4373 nchars += len;
4376 #if defined(UNIX) && defined(HAVE_FSYNC)
4377 /* On many journalling file systems there is a bug that causes both the
4378 * original and the backup file to be lost when halting the system right
4379 * after writing the file. That's because only the meta-data is
4380 * journalled. Syncing the file slows down the system, but assures it has
4381 * been written to disk and we don't lose it.
4382 * For a device do try the fsync() but don't complain if it does not work
4383 * (could be a pipe).
4384 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4385 if (p_fs && fsync(fd) != 0 && !device)
4387 errmsg = (char_u *)_("E667: Fsync failed");
4388 end = 0;
4390 #endif
4392 #ifdef HAVE_SELINUX
4393 /* Probably need to set the security context. */
4394 if (!backup_copy)
4395 mch_copy_sec(backup, wfname);
4396 #endif
4398 #ifdef UNIX
4399 /* When creating a new file, set its owner/group to that of the original
4400 * file. Get the new device and inode number. */
4401 if (backup != NULL && !backup_copy)
4403 # ifdef HAVE_FCHOWN
4404 struct stat st;
4406 /* don't change the owner when it's already OK, some systems remove
4407 * permission or ACL stuff */
4408 if (mch_stat((char *)wfname, &st) < 0
4409 || st.st_uid != st_old.st_uid
4410 || st.st_gid != st_old.st_gid)
4412 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
4413 if (perm >= 0) /* set permission again, may have changed */
4414 (void)mch_setperm(wfname, perm);
4416 # endif
4417 buf_setino(buf);
4419 else if (buf->b_dev < 0)
4420 /* Set the inode when creating a new file. */
4421 buf_setino(buf);
4422 #endif
4424 if (close(fd) != 0)
4426 errmsg = (char_u *)_("E512: Close failed");
4427 end = 0;
4430 #ifdef UNIX
4431 if (made_writable)
4432 perm &= ~0200; /* reset 'w' bit for security reasons */
4433 #endif
4434 if (perm >= 0) /* set perm. of new file same as old file */
4435 (void)mch_setperm(wfname, perm);
4436 #ifdef RISCOS
4437 if (!append && !filtering)
4438 /* Set the filetype after writing the file. */
4439 mch_set_filetype(wfname, buf->b_p_oft);
4440 #endif
4441 #ifdef HAVE_ACL
4442 /* Probably need to set the ACL before changing the user (can't set the
4443 * ACL on a file the user doesn't own). */
4444 if (!backup_copy)
4445 mch_set_acl(wfname, acl);
4446 #endif
4449 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4450 if (wfname != fname)
4453 * The file was written to a temp file, now it needs to be converted
4454 * with 'charconvert' to (overwrite) the output file.
4456 if (end != 0)
4458 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4459 wfname, fname) == FAIL)
4461 write_info.bw_conv_error = TRUE;
4462 end = 0;
4465 mch_remove(wfname);
4466 vim_free(wfname);
4468 #endif
4470 if (end == 0)
4472 if (errmsg == NULL)
4474 #ifdef FEAT_MBYTE
4475 if (write_info.bw_conv_error)
4476 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4477 else
4478 #endif
4479 if (got_int)
4480 errmsg = (char_u *)_(e_interr);
4481 else
4482 errmsg = (char_u *)_("E514: write error (file system full?)");
4486 * If we have a backup file, try to put it in place of the new file,
4487 * because the new file is probably corrupt. This avoids losing the
4488 * original file when trying to make a backup when writing the file a
4489 * second time.
4490 * When "backup_copy" is set we need to copy the backup over the new
4491 * file. Otherwise rename the backup file.
4492 * If this is OK, don't give the extra warning message.
4494 if (backup != NULL)
4496 if (backup_copy)
4498 /* This may take a while, if we were interrupted let the user
4499 * know we got the message. */
4500 if (got_int)
4502 MSG(_(e_interr));
4503 out_flush();
4505 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4507 if ((write_info.bw_fd = mch_open((char *)fname,
4508 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4509 perm & 0777)) >= 0)
4511 /* copy the file. */
4512 write_info.bw_buf = smallbuf;
4513 #ifdef HAS_BW_FLAGS
4514 write_info.bw_flags = FIO_NOCONVERT;
4515 #endif
4516 while ((write_info.bw_len = vim_read(fd, smallbuf,
4517 SMBUFSIZE)) > 0)
4518 if (buf_write_bytes(&write_info) == FAIL)
4519 break;
4521 if (close(write_info.bw_fd) >= 0
4522 && write_info.bw_len == 0)
4523 end = 1; /* success */
4525 close(fd); /* ignore errors for closing read file */
4528 else
4530 if (vim_rename(backup, fname) == 0)
4531 end = 1;
4534 goto fail;
4537 lnum -= start; /* compute number of written lines */
4538 --no_wait_return; /* may wait for return now */
4540 #if !(defined(UNIX) || defined(VMS))
4541 fname = sfname; /* use shortname now, for the messages */
4542 #endif
4543 if (!filtering)
4545 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4546 c = FALSE;
4547 #ifdef FEAT_MBYTE
4548 if (write_info.bw_conv_error)
4550 STRCAT(IObuff, _(" CONVERSION ERROR"));
4551 c = TRUE;
4553 else if (notconverted)
4555 STRCAT(IObuff, _("[NOT converted]"));
4556 c = TRUE;
4558 else if (converted)
4560 STRCAT(IObuff, _("[converted]"));
4561 c = TRUE;
4563 #endif
4564 if (device)
4566 STRCAT(IObuff, _("[Device]"));
4567 c = TRUE;
4569 else if (newfile)
4571 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4572 c = TRUE;
4574 if (no_eol)
4576 msg_add_eol();
4577 c = TRUE;
4579 /* may add [unix/dos/mac] */
4580 if (msg_add_fileformat(fileformat))
4581 c = TRUE;
4582 #ifdef FEAT_CRYPT
4583 if (wb_flags & FIO_ENCRYPTED)
4585 STRCAT(IObuff, _("[crypted]"));
4586 c = TRUE;
4588 #endif
4589 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4590 if (!shortmess(SHM_WRITE))
4592 if (append)
4593 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4594 else
4595 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4598 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4601 /* When written everything correctly: reset 'modified'. Unless not
4602 * writing to the original file and '+' is not in 'cpoptions'. */
4603 if (reset_changed && whole && !append
4604 #ifdef FEAT_MBYTE
4605 && !write_info.bw_conv_error
4606 #endif
4607 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4610 unchanged(buf, TRUE);
4611 u_unchanged(buf);
4615 * If written to the current file, update the timestamp of the swap file
4616 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4618 if (overwriting)
4620 ml_timestamp(buf);
4621 if (append)
4622 buf->b_flags &= ~BF_NEW;
4623 else
4624 buf->b_flags &= ~BF_WRITE_MASK;
4628 * If we kept a backup until now, and we are in patch mode, then we make
4629 * the backup file our 'original' file.
4631 if (*p_pm && dobackup)
4633 char *org = (char *)buf_modname(
4634 #ifdef SHORT_FNAME
4635 TRUE,
4636 #else
4637 (buf->b_p_sn || buf->b_shortname),
4638 #endif
4639 fname, p_pm, FALSE);
4641 if (backup != NULL)
4643 struct stat st;
4646 * If the original file does not exist yet
4647 * the current backup file becomes the original file
4649 if (org == NULL)
4650 EMSG(_("E205: Patchmode: can't save original file"));
4651 else if (mch_stat(org, &st) < 0)
4653 vim_rename(backup, (char_u *)org);
4654 vim_free(backup); /* don't delete the file */
4655 backup = NULL;
4656 #ifdef UNIX
4657 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4658 #endif
4662 * If there is no backup file, remember that a (new) file was
4663 * created.
4665 else
4667 int empty_fd;
4669 if (org == NULL
4670 || (empty_fd = mch_open(org,
4671 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4672 perm < 0 ? 0666 : (perm & 0777))) < 0)
4673 EMSG(_("E206: patchmode: can't touch empty original file"));
4674 else
4675 close(empty_fd);
4677 if (org != NULL)
4679 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4680 vim_free(org);
4685 * Remove the backup unless 'backup' option is set
4687 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4688 EMSG(_("E207: Can't delete backup file"));
4690 #ifdef FEAT_SUN_WORKSHOP
4691 if (usingSunWorkShop)
4692 workshop_file_saved((char *) ffname);
4693 #endif
4695 goto nofail;
4698 * Finish up. We get here either after failure or success.
4700 fail:
4701 --no_wait_return; /* may wait for return now */
4702 nofail:
4704 /* Done saving, we accept changed buffer warnings again */
4705 buf->b_saving = FALSE;
4707 vim_free(backup);
4708 if (buffer != smallbuf)
4709 vim_free(buffer);
4710 #ifdef FEAT_MBYTE
4711 vim_free(fenc_tofree);
4712 vim_free(write_info.bw_conv_buf);
4713 # ifdef USE_ICONV
4714 if (write_info.bw_iconv_fd != (iconv_t)-1)
4716 iconv_close(write_info.bw_iconv_fd);
4717 write_info.bw_iconv_fd = (iconv_t)-1;
4719 # endif
4720 #endif
4721 #ifdef HAVE_ACL
4722 mch_free_acl(acl);
4723 #endif
4725 if (errmsg != NULL)
4727 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4729 attr = hl_attr(HLF_E); /* set highlight for error messages */
4730 msg_add_fname(buf,
4731 #ifndef UNIX
4732 sfname
4733 #else
4734 fname
4735 #endif
4736 ); /* put file name in IObuff with quotes */
4737 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4738 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4739 /* If the error message has the form "is ...", put the error number in
4740 * front of the file name. */
4741 if (errnum != NULL)
4743 STRMOVE(IObuff + numlen, IObuff);
4744 mch_memmove(IObuff, errnum, (size_t)numlen);
4746 STRCAT(IObuff, errmsg);
4747 emsg(IObuff);
4749 retval = FAIL;
4750 if (end == 0)
4752 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4753 attr | MSG_HIST);
4754 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4755 attr | MSG_HIST);
4757 /* Update the timestamp to avoid an "overwrite changed file"
4758 * prompt when writing again. */
4759 if (mch_stat((char *)fname, &st_old) >= 0)
4761 buf_store_time(buf, &st_old, fname);
4762 buf->b_mtime_read = buf->b_mtime;
4766 msg_scroll = msg_save;
4768 #ifdef FEAT_AUTOCMD
4769 #ifdef FEAT_EVAL
4770 if (!should_abort(retval))
4771 #else
4772 if (!got_int)
4773 #endif
4775 aco_save_T aco;
4777 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4780 * Apply POST autocommands.
4781 * Careful: The autocommands may call buf_write() recursively!
4783 aucmd_prepbuf(&aco, buf);
4785 if (append)
4786 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4787 FALSE, curbuf, eap);
4788 else if (filtering)
4789 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4790 FALSE, curbuf, eap);
4791 else if (reset_changed && whole)
4792 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4793 FALSE, curbuf, eap);
4794 else
4795 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4796 FALSE, curbuf, eap);
4798 /* restore curwin/curbuf and a few other things */
4799 aucmd_restbuf(&aco);
4801 #ifdef FEAT_EVAL
4802 if (aborting()) /* autocmds may abort script processing */
4803 retval = FALSE;
4804 #endif
4806 #endif
4808 got_int |= prev_got_int;
4810 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4811 /* Update machine specific information. */
4812 mch_post_buffer_write(buf);
4813 #endif
4814 #ifdef FEAT_ODB_EDITOR
4815 odb_post_buffer_write(buf);
4816 #endif
4818 return retval;
4822 * Set the name of the current buffer. Use when the buffer doesn't have a
4823 * name and a ":r" or ":w" command with a file name is used.
4825 static int
4826 set_rw_fname(fname, sfname)
4827 char_u *fname;
4828 char_u *sfname;
4830 #ifdef FEAT_AUTOCMD
4831 /* It's like the unnamed buffer is deleted.... */
4832 if (curbuf->b_p_bl)
4833 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4834 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4835 # ifdef FEAT_EVAL
4836 if (aborting()) /* autocmds may abort script processing */
4837 return FAIL;
4838 # endif
4839 #endif
4841 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4842 curbuf->b_flags |= BF_NOTEDITED;
4844 #ifdef FEAT_AUTOCMD
4845 /* ....and a new named one is created */
4846 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4847 if (curbuf->b_p_bl)
4848 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4849 # ifdef FEAT_EVAL
4850 if (aborting()) /* autocmds may abort script processing */
4851 return FAIL;
4852 # endif
4854 /* Do filetype detection now if 'filetype' is empty. */
4855 if (*curbuf->b_p_ft == NUL)
4857 if (au_has_group((char_u *)"filetypedetect"))
4858 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4859 do_modelines(0);
4861 #endif
4863 return OK;
4867 * Put file name into IObuff with quotes.
4869 void
4870 msg_add_fname(buf, fname)
4871 buf_T *buf;
4872 char_u *fname;
4874 if (fname == NULL)
4875 fname = (char_u *)"-stdin-";
4876 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4877 IObuff[0] = '"';
4878 STRCAT(IObuff, "\" ");
4882 * Append message for text mode to IObuff.
4883 * Return TRUE if something appended.
4885 static int
4886 msg_add_fileformat(eol_type)
4887 int eol_type;
4889 #ifndef USE_CRNL
4890 if (eol_type == EOL_DOS)
4892 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4893 return TRUE;
4895 #endif
4896 #ifndef USE_CR
4897 if (eol_type == EOL_MAC)
4899 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4900 return TRUE;
4902 #endif
4903 #if defined(USE_CRNL) || defined(USE_CR)
4904 if (eol_type == EOL_UNIX)
4906 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4907 return TRUE;
4909 #endif
4910 return FALSE;
4914 * Append line and character count to IObuff.
4916 void
4917 msg_add_lines(insert_space, lnum, nchars)
4918 int insert_space;
4919 long lnum;
4920 long nchars;
4922 char_u *p;
4924 p = IObuff + STRLEN(IObuff);
4926 if (insert_space)
4927 *p++ = ' ';
4928 if (shortmess(SHM_LINES))
4929 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4930 else
4932 if (lnum == 1)
4933 STRCPY(p, _("1 line, "));
4934 else
4935 sprintf((char *)p, _("%ld lines, "), lnum);
4936 p += STRLEN(p);
4937 if (nchars == 1)
4938 STRCPY(p, _("1 character"));
4939 else
4940 sprintf((char *)p, _("%ld characters"), nchars);
4945 * Append message for missing line separator to IObuff.
4947 static void
4948 msg_add_eol()
4950 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4954 * Check modification time of file, before writing to it.
4955 * The size isn't checked, because using a tool like "gzip" takes care of
4956 * using the same timestamp but can't set the size.
4958 static int
4959 check_mtime(buf, st)
4960 buf_T *buf;
4961 struct stat *st;
4963 if (buf->b_mtime_read != 0
4964 && time_differs((long)st->st_mtime, buf->b_mtime_read))
4966 msg_scroll = TRUE; /* don't overwrite messages here */
4967 msg_silent = 0; /* must give this prompt */
4968 /* don't use emsg() here, don't want to flush the buffers */
4969 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4970 hl_attr(HLF_E));
4971 if (ask_yesno((char_u *)_("Do you really want to write to it"),
4972 TRUE) == 'n')
4973 return FAIL;
4974 msg_scroll = FALSE; /* always overwrite the file message now */
4976 return OK;
4979 static int
4980 time_differs(t1, t2)
4981 long t1, t2;
4983 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4984 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4985 * the seconds. Since the roundoff is done when flushing the inode, the
4986 * time may change unexpectedly by one second!!! */
4987 return (t1 - t2 > 1 || t2 - t1 > 1);
4988 #else
4989 return (t1 != t2);
4990 #endif
4994 * Call write() to write a number of bytes to the file.
4995 * Also handles encryption and 'encoding' conversion.
4997 * Return FAIL for failure, OK otherwise.
4999 static int
5000 buf_write_bytes(ip)
5001 struct bw_info *ip;
5003 int wlen;
5004 char_u *buf = ip->bw_buf; /* data to write */
5005 int len = ip->bw_len; /* length of data */
5006 #ifdef HAS_BW_FLAGS
5007 int flags = ip->bw_flags; /* extra flags */
5008 #endif
5010 #ifdef FEAT_MBYTE
5012 * Skip conversion when writing the crypt magic number or the BOM.
5014 if (!(flags & FIO_NOCONVERT))
5016 char_u *p;
5017 unsigned c;
5018 int n;
5020 if (flags & FIO_UTF8)
5023 * Convert latin1 in the buffer to UTF-8 in the file.
5025 p = ip->bw_conv_buf; /* translate to buffer */
5026 for (wlen = 0; wlen < len; ++wlen)
5027 p += utf_char2bytes(buf[wlen], p);
5028 buf = ip->bw_conv_buf;
5029 len = (int)(p - ip->bw_conv_buf);
5031 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
5034 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
5035 * Latin1 chars in the file.
5037 if (flags & FIO_LATIN1)
5038 p = buf; /* translate in-place (can only get shorter) */
5039 else
5040 p = ip->bw_conv_buf; /* translate to buffer */
5041 for (wlen = 0; wlen < len; wlen += n)
5043 if (wlen == 0 && ip->bw_restlen != 0)
5045 int l;
5047 /* Use remainder of previous call. Append the start of
5048 * buf[] to get a full sequence. Might still be too
5049 * short! */
5050 l = CONV_RESTLEN - ip->bw_restlen;
5051 if (l > len)
5052 l = len;
5053 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
5054 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
5055 if (n > ip->bw_restlen + len)
5057 /* We have an incomplete byte sequence at the end to
5058 * be written. We can't convert it without the
5059 * remaining bytes. Keep them for the next call. */
5060 if (ip->bw_restlen + len > CONV_RESTLEN)
5061 return FAIL;
5062 ip->bw_restlen += len;
5063 break;
5065 if (n > 1)
5066 c = utf_ptr2char(ip->bw_rest);
5067 else
5068 c = ip->bw_rest[0];
5069 if (n >= ip->bw_restlen)
5071 n -= ip->bw_restlen;
5072 ip->bw_restlen = 0;
5074 else
5076 ip->bw_restlen -= n;
5077 mch_memmove(ip->bw_rest, ip->bw_rest + n,
5078 (size_t)ip->bw_restlen);
5079 n = 0;
5082 else
5084 n = utf_ptr2len_len(buf + wlen, len - wlen);
5085 if (n > len - wlen)
5087 /* We have an incomplete byte sequence at the end to
5088 * be written. We can't convert it without the
5089 * remaining bytes. Keep them for the next call. */
5090 if (len - wlen > CONV_RESTLEN)
5091 return FAIL;
5092 ip->bw_restlen = len - wlen;
5093 mch_memmove(ip->bw_rest, buf + wlen,
5094 (size_t)ip->bw_restlen);
5095 break;
5097 if (n > 1)
5098 c = utf_ptr2char(buf + wlen);
5099 else
5100 c = buf[wlen];
5103 ip->bw_conv_error |= ucs2bytes(c, &p, flags);
5105 if (flags & FIO_LATIN1)
5106 len = (int)(p - buf);
5107 else
5109 buf = ip->bw_conv_buf;
5110 len = (int)(p - ip->bw_conv_buf);
5114 # ifdef WIN3264
5115 else if (flags & FIO_CODEPAGE)
5118 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5119 * codepage.
5121 char_u *from;
5122 size_t fromlen;
5123 char_u *to;
5124 int u8c;
5125 BOOL bad = FALSE;
5126 int needed;
5128 if (ip->bw_restlen > 0)
5130 /* Need to concatenate the remainder of the previous call and
5131 * the bytes of the current call. Use the end of the
5132 * conversion buffer for this. */
5133 fromlen = len + ip->bw_restlen;
5134 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5135 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5136 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5138 else
5140 from = buf;
5141 fromlen = len;
5144 to = ip->bw_conv_buf;
5145 if (enc_utf8)
5147 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5148 * The buffer has been allocated to be big enough. */
5149 while (fromlen > 0)
5151 n = (int)utf_ptr2len_len(from, (int)fromlen);
5152 if (n > (int)fromlen) /* incomplete byte sequence */
5153 break;
5154 u8c = utf_ptr2char(from);
5155 *to++ = (u8c & 0xff);
5156 *to++ = (u8c >> 8);
5157 fromlen -= n;
5158 from += n;
5161 /* Copy remainder to ip->bw_rest[] to be used for the next
5162 * call. */
5163 if (fromlen > CONV_RESTLEN)
5165 /* weird overlong sequence */
5166 ip->bw_conv_error = TRUE;
5167 return FAIL;
5169 mch_memmove(ip->bw_rest, from, fromlen);
5170 ip->bw_restlen = (int)fromlen;
5172 else
5174 /* Convert from enc_codepage to UCS-2, to the start of the
5175 * buffer. The buffer has been allocated to be big enough. */
5176 ip->bw_restlen = 0;
5177 needed = MultiByteToWideChar(enc_codepage,
5178 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5179 NULL, 0);
5180 if (needed == 0)
5182 /* When conversion fails there may be a trailing byte. */
5183 needed = MultiByteToWideChar(enc_codepage,
5184 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5185 NULL, 0);
5186 if (needed == 0)
5188 /* Conversion doesn't work. */
5189 ip->bw_conv_error = TRUE;
5190 return FAIL;
5192 /* Save the trailing byte for the next call. */
5193 ip->bw_rest[0] = from[fromlen - 1];
5194 ip->bw_restlen = 1;
5196 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5197 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5198 (LPWSTR)to, needed);
5199 if (needed == 0)
5201 /* Safety check: Conversion doesn't work. */
5202 ip->bw_conv_error = TRUE;
5203 return FAIL;
5205 to += needed * 2;
5208 fromlen = to - ip->bw_conv_buf;
5209 buf = to;
5210 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5211 if (FIO_GET_CP(flags) == CP_UTF8)
5213 /* Convert from UCS-2 to UTF-8, using the remainder of the
5214 * conversion buffer. Fails when out of space. */
5215 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5217 u8c = *from++;
5218 u8c += (*from++ << 8);
5219 to += utf_char2bytes(u8c, to);
5220 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5222 ip->bw_conv_error = TRUE;
5223 return FAIL;
5226 len = (int)(to - buf);
5228 else
5229 #endif
5231 /* Convert from UCS-2 to the codepage, using the remainder of
5232 * the conversion buffer. If the conversion uses the default
5233 * character "0", the data doesn't fit in this encoding, so
5234 * fail. */
5235 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5236 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5237 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0,
5238 &bad);
5239 if (bad)
5241 ip->bw_conv_error = TRUE;
5242 return FAIL;
5246 # endif
5248 # ifdef MACOS_CONVERT
5249 else if (flags & FIO_MACROMAN)
5252 * Convert UTF-8 or latin1 to Apple MacRoman.
5254 char_u *from;
5255 size_t fromlen;
5257 if (ip->bw_restlen > 0)
5259 /* Need to concatenate the remainder of the previous call and
5260 * the bytes of the current call. Use the end of the
5261 * conversion buffer for this. */
5262 fromlen = len + ip->bw_restlen;
5263 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5264 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5265 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5267 else
5269 from = buf;
5270 fromlen = len;
5273 if (enc2macroman(from, fromlen,
5274 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5275 ip->bw_rest, &ip->bw_restlen) == FAIL)
5277 ip->bw_conv_error = TRUE;
5278 return FAIL;
5280 buf = ip->bw_conv_buf;
5282 # endif
5284 # ifdef USE_ICONV
5285 if (ip->bw_iconv_fd != (iconv_t)-1)
5287 const char *from;
5288 size_t fromlen;
5289 char *to;
5290 size_t tolen;
5292 /* Convert with iconv(). */
5293 if (ip->bw_restlen > 0)
5295 char *fp;
5297 /* Need to concatenate the remainder of the previous call and
5298 * the bytes of the current call. Use the end of the
5299 * conversion buffer for this. */
5300 fromlen = len + ip->bw_restlen;
5301 fp = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5302 mch_memmove(fp, ip->bw_rest, (size_t)ip->bw_restlen);
5303 mch_memmove(fp + ip->bw_restlen, buf, (size_t)len);
5304 from = fp;
5305 tolen = ip->bw_conv_buflen - fromlen;
5307 else
5309 from = (const char *)buf;
5310 fromlen = len;
5311 tolen = ip->bw_conv_buflen;
5313 to = (char *)ip->bw_conv_buf;
5315 if (ip->bw_first)
5317 size_t save_len = tolen;
5319 /* output the initial shift state sequence */
5320 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5322 /* There is a bug in iconv() on Linux (which appears to be
5323 * wide-spread) which sets "to" to NULL and messes up "tolen".
5325 if (to == NULL)
5327 to = (char *)ip->bw_conv_buf;
5328 tolen = save_len;
5330 ip->bw_first = FALSE;
5334 * If iconv() has an error or there is not enough room, fail.
5336 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5337 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5338 || fromlen > CONV_RESTLEN)
5340 ip->bw_conv_error = TRUE;
5341 return FAIL;
5344 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5345 if (fromlen > 0)
5346 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5347 ip->bw_restlen = (int)fromlen;
5349 buf = ip->bw_conv_buf;
5350 len = (int)((char_u *)to - ip->bw_conv_buf);
5352 # endif
5354 #endif /* FEAT_MBYTE */
5356 #ifdef FEAT_CRYPT
5357 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5359 int ztemp, t, i;
5361 for (i = 0; i < len; i++)
5363 ztemp = buf[i];
5364 buf[i] = ZENCODE(ztemp, t);
5367 #endif
5369 /* Repeat the write(), it may be interrupted by a signal. */
5370 while (len > 0)
5372 wlen = vim_write(ip->bw_fd, buf, len);
5373 if (wlen <= 0) /* error! */
5374 return FAIL;
5375 len -= wlen;
5376 buf += wlen;
5378 return OK;
5381 #ifdef FEAT_MBYTE
5383 * Convert a Unicode character to bytes.
5385 static int
5386 ucs2bytes(c, pp, flags)
5387 unsigned c; /* in: character */
5388 char_u **pp; /* in/out: pointer to result */
5389 int flags; /* FIO_ flags */
5391 char_u *p = *pp;
5392 int error = FALSE;
5393 int cc;
5396 if (flags & FIO_UCS4)
5398 if (flags & FIO_ENDIAN_L)
5400 *p++ = c;
5401 *p++ = (c >> 8);
5402 *p++ = (c >> 16);
5403 *p++ = (c >> 24);
5405 else
5407 *p++ = (c >> 24);
5408 *p++ = (c >> 16);
5409 *p++ = (c >> 8);
5410 *p++ = c;
5413 else if (flags & (FIO_UCS2 | FIO_UTF16))
5415 if (c >= 0x10000)
5417 if (flags & FIO_UTF16)
5419 /* Make two words, ten bits of the character in each. First
5420 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5421 c -= 0x10000;
5422 if (c >= 0x100000)
5423 error = TRUE;
5424 cc = ((c >> 10) & 0x3ff) + 0xd800;
5425 if (flags & FIO_ENDIAN_L)
5427 *p++ = cc;
5428 *p++ = ((unsigned)cc >> 8);
5430 else
5432 *p++ = ((unsigned)cc >> 8);
5433 *p++ = cc;
5435 c = (c & 0x3ff) + 0xdc00;
5437 else
5438 error = TRUE;
5440 if (flags & FIO_ENDIAN_L)
5442 *p++ = c;
5443 *p++ = (c >> 8);
5445 else
5447 *p++ = (c >> 8);
5448 *p++ = c;
5451 else /* Latin1 */
5453 if (c >= 0x100)
5455 error = TRUE;
5456 *p++ = 0xBF;
5458 else
5459 *p++ = c;
5462 *pp = p;
5463 return error;
5467 * Return TRUE if "a" and "b" are the same 'encoding'.
5468 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5470 static int
5471 same_encoding(a, b)
5472 char_u *a;
5473 char_u *b;
5475 int f;
5477 if (STRCMP(a, b) == 0)
5478 return TRUE;
5479 f = get_fio_flags(a);
5480 return (f != 0 && get_fio_flags(b) == f);
5484 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5485 * internal conversion.
5486 * if "ptr" is an empty string, use 'encoding'.
5488 static int
5489 get_fio_flags(ptr)
5490 char_u *ptr;
5492 int prop;
5494 if (*ptr == NUL)
5495 ptr = p_enc;
5497 prop = enc_canon_props(ptr);
5498 if (prop & ENC_UNICODE)
5500 if (prop & ENC_2BYTE)
5502 if (prop & ENC_ENDIAN_L)
5503 return FIO_UCS2 | FIO_ENDIAN_L;
5504 return FIO_UCS2;
5506 if (prop & ENC_4BYTE)
5508 if (prop & ENC_ENDIAN_L)
5509 return FIO_UCS4 | FIO_ENDIAN_L;
5510 return FIO_UCS4;
5512 if (prop & ENC_2WORD)
5514 if (prop & ENC_ENDIAN_L)
5515 return FIO_UTF16 | FIO_ENDIAN_L;
5516 return FIO_UTF16;
5518 return FIO_UTF8;
5520 if (prop & ENC_LATIN1)
5521 return FIO_LATIN1;
5522 /* must be ENC_DBCS, requires iconv() */
5523 return 0;
5526 #ifdef WIN3264
5528 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5529 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5530 * Used for conversion between 'encoding' and 'fileencoding'.
5532 static int
5533 get_win_fio_flags(ptr)
5534 char_u *ptr;
5536 int cp;
5538 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5539 if (!enc_utf8 && enc_codepage <= 0)
5540 return 0;
5542 cp = encname2codepage(ptr);
5543 if (cp == 0)
5545 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5546 if (STRCMP(ptr, "utf-8") == 0)
5547 cp = CP_UTF8;
5548 else
5549 # endif
5550 return 0;
5552 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5554 #endif
5556 #ifdef MACOS_X
5558 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5559 * needed for the internal conversion to/from utf-8 or latin1.
5561 static int
5562 get_mac_fio_flags(ptr)
5563 char_u *ptr;
5565 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5566 && (enc_canon_props(ptr) & ENC_MACROMAN))
5567 return FIO_MACROMAN;
5568 return 0;
5570 #endif
5573 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5574 * "size" must be at least 2.
5575 * Return the name of the encoding and set "*lenp" to the length.
5576 * Returns NULL when no BOM found.
5578 static char_u *
5579 check_for_bom(p, size, lenp, flags)
5580 char_u *p;
5581 long size;
5582 int *lenp;
5583 int flags;
5585 char *name = NULL;
5586 int len = 2;
5588 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5589 && (flags == FIO_ALL || flags == FIO_UTF8 || flags == 0))
5591 name = "utf-8"; /* EF BB BF */
5592 len = 3;
5594 else if (p[0] == 0xff && p[1] == 0xfe)
5596 if (size >= 4 && p[2] == 0 && p[3] == 0
5597 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5599 name = "ucs-4le"; /* FF FE 00 00 */
5600 len = 4;
5602 else if (flags == (FIO_UCS2 | FIO_ENDIAN_L))
5603 name = "ucs-2le"; /* FF FE */
5604 else if (flags == FIO_ALL || flags == (FIO_UTF16 | FIO_ENDIAN_L))
5605 /* utf-16le is preferred, it also works for ucs-2le text */
5606 name = "utf-16le"; /* FF FE */
5608 else if (p[0] == 0xfe && p[1] == 0xff
5609 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5611 /* Default to utf-16, it works also for ucs-2 text. */
5612 if (flags == FIO_UCS2)
5613 name = "ucs-2"; /* FE FF */
5614 else
5615 name = "utf-16"; /* FE FF */
5617 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5618 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5620 name = "ucs-4"; /* 00 00 FE FF */
5621 len = 4;
5624 *lenp = len;
5625 return (char_u *)name;
5629 * Generate a BOM in "buf[4]" for encoding "name".
5630 * Return the length of the BOM (zero when no BOM).
5632 static int
5633 make_bom(buf, name)
5634 char_u *buf;
5635 char_u *name;
5637 int flags;
5638 char_u *p;
5640 flags = get_fio_flags(name);
5642 /* Can't put a BOM in a non-Unicode file. */
5643 if (flags == FIO_LATIN1 || flags == 0)
5644 return 0;
5646 if (flags == FIO_UTF8) /* UTF-8 */
5648 buf[0] = 0xef;
5649 buf[1] = 0xbb;
5650 buf[2] = 0xbf;
5651 return 3;
5653 p = buf;
5654 (void)ucs2bytes(0xfeff, &p, flags);
5655 return (int)(p - buf);
5657 #endif
5659 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5660 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5662 * Try to find a shortname by comparing the fullname with the current
5663 * directory.
5664 * Returns "full_path" or pointer into "full_path" if shortened.
5666 char_u *
5667 shorten_fname1(full_path)
5668 char_u *full_path;
5670 char_u dirname[MAXPATHL];
5671 char_u *p = full_path;
5673 if (mch_dirname(dirname, MAXPATHL) == OK)
5675 p = shorten_fname(full_path, dirname);
5676 if (p == NULL || *p == NUL)
5677 p = full_path;
5679 return p;
5681 #endif
5684 * Try to find a shortname by comparing the fullname with the current
5685 * directory.
5686 * Returns NULL if not shorter name possible, pointer into "full_path"
5687 * otherwise.
5689 char_u *
5690 shorten_fname(full_path, dir_name)
5691 char_u *full_path;
5692 char_u *dir_name;
5694 int len;
5695 char_u *p;
5697 if (full_path == NULL)
5698 return NULL;
5699 len = (int)STRLEN(dir_name);
5700 if (fnamencmp(dir_name, full_path, len) == 0)
5702 p = full_path + len;
5703 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5705 * MSDOS: when a file is in the root directory, dir_name will end in a
5706 * slash, since C: by itself does not define a specific dir. In this
5707 * case p may already be correct. <negri>
5709 if (!((len > 2) && (*(p - 2) == ':')))
5710 #endif
5712 if (vim_ispathsep(*p))
5713 ++p;
5714 #ifndef VMS /* the path separator is always part of the path */
5715 else
5716 p = NULL;
5717 #endif
5720 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5722 * When using a file in the current drive, remove the drive name:
5723 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5724 * a floppy from "A:\dir" to "B:\dir".
5726 else if (len > 3
5727 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5728 && full_path[1] == ':'
5729 && vim_ispathsep(full_path[2]))
5730 p = full_path + 2;
5731 #endif
5732 else
5733 p = NULL;
5734 return p;
5738 * Shorten filenames for all buffers.
5739 * When "force" is TRUE: Use full path from now on for files currently being
5740 * edited, both for file name and swap file name. Try to shorten the file
5741 * names a bit, if safe to do so.
5742 * When "force" is FALSE: Only try to shorten absolute file names.
5743 * For buffers that have buftype "nofile" or "scratch": never change the file
5744 * name.
5746 void
5747 shorten_fnames(force)
5748 int force;
5750 char_u dirname[MAXPATHL];
5751 buf_T *buf;
5752 char_u *p;
5754 mch_dirname(dirname, MAXPATHL);
5755 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5757 if (buf->b_fname != NULL
5758 #ifdef FEAT_QUICKFIX
5759 && !bt_nofile(buf)
5760 #endif
5761 && !path_with_url(buf->b_fname)
5762 && (force
5763 || buf->b_sfname == NULL
5764 || mch_isFullName(buf->b_sfname)))
5766 vim_free(buf->b_sfname);
5767 buf->b_sfname = NULL;
5768 p = shorten_fname(buf->b_ffname, dirname);
5769 if (p != NULL)
5771 buf->b_sfname = vim_strsave(p);
5772 buf->b_fname = buf->b_sfname;
5774 if (p == NULL || buf->b_fname == NULL)
5775 buf->b_fname = buf->b_ffname;
5778 /* Always make the swap file name a full path, a "nofile" buffer may
5779 * also have a swap file. */
5780 mf_fullname(buf->b_ml.ml_mfp);
5782 #ifdef FEAT_WINDOWS
5783 status_redraw_all();
5784 redraw_tabline = TRUE;
5785 #endif
5788 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5789 || defined(FEAT_GUI_MSWIN) \
5790 || defined(FEAT_GUI_MAC) \
5791 || defined(PROTO) \
5792 || defined(FEAT_GUI_MACVIM)
5794 * Shorten all filenames in "fnames[count]" by current directory.
5796 void
5797 shorten_filenames(fnames, count)
5798 char_u **fnames;
5799 int count;
5801 int i;
5802 char_u dirname[MAXPATHL];
5803 char_u *p;
5805 if (fnames == NULL || count < 1)
5806 return;
5807 mch_dirname(dirname, sizeof(dirname));
5808 for (i = 0; i < count; ++i)
5810 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5812 /* shorten_fname() returns pointer in given "fnames[i]". If free
5813 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5814 * "p" first then free fnames[i]. */
5815 p = vim_strsave(p);
5816 vim_free(fnames[i]);
5817 fnames[i] = p;
5821 #endif
5824 * add extension to file name - change path/fo.o.h to path/fo.o.h.ext or
5825 * fo_o_h.ext for MSDOS or when shortname option set.
5827 * Assumed that fname is a valid name found in the filesystem we assure that
5828 * the return value is a different name and ends in 'ext'.
5829 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5830 * characters otherwise.
5831 * Space for the returned name is allocated, must be freed later.
5832 * Returns NULL when out of memory.
5834 char_u *
5835 modname(fname, ext, prepend_dot)
5836 char_u *fname, *ext;
5837 int prepend_dot; /* may prepend a '.' to file name */
5839 return buf_modname(
5840 #ifdef SHORT_FNAME
5841 TRUE,
5842 #else
5843 (curbuf->b_p_sn || curbuf->b_shortname),
5844 #endif
5845 fname, ext, prepend_dot);
5848 char_u *
5849 buf_modname(shortname, fname, ext, prepend_dot)
5850 int shortname; /* use 8.3 file name */
5851 char_u *fname, *ext;
5852 int prepend_dot; /* may prepend a '.' to file name */
5854 char_u *retval;
5855 char_u *s;
5856 char_u *e;
5857 char_u *ptr;
5858 int fnamelen, extlen;
5860 extlen = (int)STRLEN(ext);
5863 * If there is no file name we must get the name of the current directory
5864 * (we need the full path in case :cd is used).
5866 if (fname == NULL || *fname == NUL)
5868 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5869 if (retval == NULL)
5870 return NULL;
5871 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5872 (fnamelen = (int)STRLEN(retval)) == 0)
5874 vim_free(retval);
5875 return NULL;
5877 if (!after_pathsep(retval, retval + fnamelen))
5879 retval[fnamelen++] = PATHSEP;
5880 retval[fnamelen] = NUL;
5882 #ifndef SHORT_FNAME
5883 prepend_dot = FALSE; /* nothing to prepend a dot to */
5884 #endif
5886 else
5888 fnamelen = (int)STRLEN(fname);
5889 retval = alloc((unsigned)(fnamelen + extlen + 3));
5890 if (retval == NULL)
5891 return NULL;
5892 STRCPY(retval, fname);
5893 #ifdef VMS
5894 vms_remove_version(retval); /* we do not need versions here */
5895 #endif
5899 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5900 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5901 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5902 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5904 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5906 #ifndef RISCOS
5907 if (*ext == '.'
5908 # ifdef USE_LONG_FNAME
5909 && (!USE_LONG_FNAME || shortname)
5910 # else
5911 # ifndef SHORT_FNAME
5912 && shortname
5913 # endif
5914 # endif
5916 if (*ptr == '.') /* replace '.' by '_' */
5917 *ptr = '_';
5918 #endif
5919 if (vim_ispathsep(*ptr))
5921 ++ptr;
5922 break;
5926 /* the file name has at most BASENAMELEN characters. */
5927 #ifndef SHORT_FNAME
5928 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5929 ptr[BASENAMELEN] = '\0';
5930 #endif
5932 s = ptr + STRLEN(ptr);
5935 * For 8.3 file names we may have to reduce the length.
5937 #ifdef USE_LONG_FNAME
5938 if (!USE_LONG_FNAME || shortname)
5939 #else
5940 # ifndef SHORT_FNAME
5941 if (shortname)
5942 # endif
5943 #endif
5946 * If there is no file name, or the file name ends in '/', and the
5947 * extension starts with '.', put a '_' before the dot, because just
5948 * ".ext" is invalid.
5950 if (fname == NULL || *fname == NUL
5951 || vim_ispathsep(fname[STRLEN(fname) - 1]))
5953 #ifdef RISCOS
5954 if (*ext == '/')
5955 #else
5956 if (*ext == '.')
5957 #endif
5958 *s++ = '_';
5961 * If the extension starts with '.', truncate the base name at 8
5962 * characters
5964 #ifdef RISCOS
5965 /* We normally use '/', but swap files are '_' */
5966 else if (*ext == '/' || *ext == '_')
5967 #else
5968 else if (*ext == '.')
5969 #endif
5971 if (s - ptr > (size_t)8)
5973 s = ptr + 8;
5974 *s = '\0';
5978 * If the extension doesn't start with '.', and the file name
5979 * doesn't have an extension yet, append a '.'
5981 #ifdef RISCOS
5982 else if ((e = vim_strchr(ptr, '/')) == NULL)
5983 *s++ = '/';
5984 #else
5985 else if ((e = vim_strchr(ptr, '.')) == NULL)
5986 *s++ = '.';
5987 #endif
5989 * If the extension doesn't start with '.', and there already is an
5990 * extension, it may need to be truncated
5992 else if ((int)STRLEN(e) + extlen > 4)
5993 s = e + 4 - extlen;
5995 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5997 * If there is no file name, and the extension starts with '.', put a
5998 * '_' before the dot, because just ".ext" may be invalid if it's on a
5999 * FAT partition, and on HPFS it doesn't matter.
6001 else if ((fname == NULL || *fname == NUL) && *ext == '.')
6002 *s++ = '_';
6003 #endif
6006 * Append the extension.
6007 * ext can start with '.' and cannot exceed 3 more characters.
6009 STRCPY(s, ext);
6011 #ifndef SHORT_FNAME
6013 * Prepend the dot.
6015 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
6016 #ifdef RISCOS
6018 #else
6020 #endif
6021 #ifdef USE_LONG_FNAME
6022 && USE_LONG_FNAME
6023 #endif
6026 STRMOVE(e + 1, e);
6027 #ifdef RISCOS
6028 *e = '/';
6029 #else
6030 *e = '.';
6031 #endif
6033 #endif
6036 * Check that, after appending the extension, the file name is really
6037 * different.
6039 if (fname != NULL && STRCMP(fname, retval) == 0)
6041 /* we search for a character that can be replaced by '_' */
6042 while (--s >= ptr)
6044 if (*s != '_')
6046 *s = '_';
6047 break;
6050 if (s < ptr) /* fname was "________.<ext>", how tricky! */
6051 *ptr = 'v';
6053 return retval;
6057 * Like fgets(), but if the file line is too long, it is truncated and the
6058 * rest of the line is thrown away. Returns TRUE for end-of-file.
6061 vim_fgets(buf, size, fp)
6062 char_u *buf;
6063 int size;
6064 FILE *fp;
6066 char *eof;
6067 #define FGETS_SIZE 200
6068 char tbuf[FGETS_SIZE];
6070 buf[size - 2] = NUL;
6071 #ifdef USE_CR
6072 eof = fgets_cr((char *)buf, size, fp);
6073 #else
6074 eof = fgets((char *)buf, size, fp);
6075 #endif
6076 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
6078 buf[size - 1] = NUL; /* Truncate the line */
6080 /* Now throw away the rest of the line: */
6083 tbuf[FGETS_SIZE - 2] = NUL;
6084 #ifdef USE_CR
6085 ignoredp = fgets_cr((char *)tbuf, FGETS_SIZE, fp);
6086 #else
6087 ignoredp = fgets((char *)tbuf, FGETS_SIZE, fp);
6088 #endif
6089 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
6091 return (eof == NULL);
6094 #if defined(USE_CR) || defined(PROTO)
6096 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6097 * Returns TRUE for end-of-file.
6098 * Only used for the Mac, because it's much slower than vim_fgets().
6101 tag_fgets(buf, size, fp)
6102 char_u *buf;
6103 int size;
6104 FILE *fp;
6106 int i = 0;
6107 int c;
6108 int eof = FALSE;
6110 for (;;)
6112 c = fgetc(fp);
6113 if (c == EOF)
6115 eof = TRUE;
6116 break;
6118 if (c == '\r')
6120 /* Always store a NL for end-of-line. */
6121 if (i < size - 1)
6122 buf[i++] = '\n';
6123 c = fgetc(fp);
6124 if (c != '\n') /* Macintosh format: single CR. */
6125 ungetc(c, fp);
6126 break;
6128 if (i < size - 1)
6129 buf[i++] = c;
6130 if (c == '\n')
6131 break;
6133 buf[i] = NUL;
6134 return eof;
6136 #endif
6139 * rename() only works if both files are on the same file system, this
6140 * function will (attempts to?) copy the file across if rename fails -- webb
6141 * Return -1 for failure, 0 for success.
6144 vim_rename(from, to)
6145 char_u *from;
6146 char_u *to;
6148 int fd_in;
6149 int fd_out;
6150 int n;
6151 char *errmsg = NULL;
6152 char *buffer;
6153 #ifdef AMIGA
6154 BPTR flock;
6155 #endif
6156 struct stat st;
6157 long perm;
6158 #ifdef HAVE_ACL
6159 vim_acl_T acl; /* ACL from original file */
6160 #endif
6161 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6162 int use_tmp_file = FALSE;
6163 #endif
6166 * When the names are identical, there is nothing to do. When they refer
6167 * to the same file (ignoring case and slash/backslash differences) but
6168 * the file name differs we need to go through a temp file.
6170 if (fnamecmp(from, to) == 0)
6172 #ifdef CASE_INSENSITIVE_FILENAME
6173 if (STRCMP(gettail(from), gettail(to)) != 0)
6174 use_tmp_file = TRUE;
6175 else
6176 #endif
6177 return 0;
6181 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6183 if (mch_stat((char *)from, &st) < 0)
6184 return -1;
6186 #ifdef UNIX
6188 struct stat st_to;
6190 /* It's possible for the source and destination to be the same file.
6191 * This happens when "from" and "to" differ in case and are on a FAT32
6192 * filesystem. In that case go through a temp file name. */
6193 if (mch_stat((char *)to, &st_to) >= 0
6194 && st.st_dev == st_to.st_dev
6195 && st.st_ino == st_to.st_ino)
6196 use_tmp_file = TRUE;
6198 #endif
6200 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6201 if (use_tmp_file)
6203 char tempname[MAXPATHL + 1];
6206 * Find a name that doesn't exist and is in the same directory.
6207 * Rename "from" to "tempname" and then rename "tempname" to "to".
6209 if (STRLEN(from) >= MAXPATHL - 5)
6210 return -1;
6211 STRCPY(tempname, from);
6212 for (n = 123; n < 99999; ++n)
6214 sprintf((char *)gettail((char_u *)tempname), "%d", n);
6215 if (mch_stat(tempname, &st) < 0)
6217 if (mch_rename((char *)from, tempname) == 0)
6219 if (mch_rename(tempname, (char *)to) == 0)
6220 return 0;
6221 /* Strange, the second step failed. Try moving the
6222 * file back and return failure. */
6223 mch_rename(tempname, (char *)from);
6224 return -1;
6226 /* If it fails for one temp name it will most likely fail
6227 * for any temp name, give up. */
6228 return -1;
6231 return -1;
6233 #endif
6236 * Delete the "to" file, this is required on some systems to make the
6237 * mch_rename() work, on other systems it makes sure that we don't have
6238 * two files when the mch_rename() fails.
6241 #ifdef AMIGA
6243 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6244 * that the name of the "to" file is the same as the "from" file, even
6245 * though the names are different. To avoid the chance of accidentally
6246 * deleting the "from" file (horror!) we lock it during the remove.
6248 * When used for making a backup before writing the file: This should not
6249 * happen with ":w", because startscript() should detect this problem and
6250 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6251 * name. This problem does exist with ":w filename", but then the
6252 * original file will be somewhere else so the backup isn't really
6253 * important. If autoscripting is off the rename may fail.
6255 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6256 #endif
6257 mch_remove(to);
6258 #ifdef AMIGA
6259 if (flock)
6260 UnLock(flock);
6261 #endif
6264 * First try a normal rename, return if it works.
6266 if (mch_rename((char *)from, (char *)to) == 0)
6267 return 0;
6270 * Rename() failed, try copying the file.
6272 perm = mch_getperm(from);
6273 #ifdef HAVE_ACL
6274 /* For systems that support ACL: get the ACL from the original file. */
6275 acl = mch_get_acl(from);
6276 #endif
6277 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6278 if (fd_in == -1)
6280 #ifdef HAVE_ACL
6281 mch_free_acl(acl);
6282 #endif
6283 return -1;
6286 /* Create the new file with same permissions as the original. */
6287 fd_out = mch_open((char *)to,
6288 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6289 if (fd_out == -1)
6291 close(fd_in);
6292 #ifdef HAVE_ACL
6293 mch_free_acl(acl);
6294 #endif
6295 return -1;
6298 buffer = (char *)alloc(BUFSIZE);
6299 if (buffer == NULL)
6301 close(fd_out);
6302 close(fd_in);
6303 #ifdef HAVE_ACL
6304 mch_free_acl(acl);
6305 #endif
6306 return -1;
6309 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6310 if (vim_write(fd_out, buffer, n) != n)
6312 errmsg = _("E208: Error writing to \"%s\"");
6313 break;
6316 vim_free(buffer);
6317 close(fd_in);
6318 if (close(fd_out) < 0)
6319 errmsg = _("E209: Error closing \"%s\"");
6320 if (n < 0)
6322 errmsg = _("E210: Error reading \"%s\"");
6323 to = from;
6325 #ifndef UNIX /* for Unix mch_open() already set the permission */
6326 mch_setperm(to, perm);
6327 #endif
6328 #ifdef HAVE_ACL
6329 mch_set_acl(to, acl);
6330 mch_free_acl(acl);
6331 #endif
6332 if (errmsg != NULL)
6334 EMSG2(errmsg, to);
6335 return -1;
6337 mch_remove(from);
6338 return 0;
6341 static int already_warned = FALSE;
6342 #ifdef FEAT_GUI_MACVIM
6343 static int default_reload_choice = 0;
6344 #endif
6347 * Check if any not hidden buffer has been changed.
6348 * Postpone the check if there are characters in the stuff buffer, a global
6349 * command is being executed, a mapping is being executed or an autocommand is
6350 * busy.
6351 * Returns TRUE if some message was written (screen should be redrawn and
6352 * cursor positioned).
6355 check_timestamps(focus)
6356 int focus; /* called for GUI focus event */
6358 buf_T *buf;
6359 int didit = 0;
6360 int n;
6362 /* Don't check timestamps while system() or another low-level function may
6363 * cause us to lose and gain focus. */
6364 if (no_check_timestamps > 0)
6365 return FALSE;
6367 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6368 * event and we would keep on checking if the file is steadily growing.
6369 * Do check again after typing something. */
6370 if (focus && did_check_timestamps)
6372 need_check_timestamps = TRUE;
6373 return FALSE;
6376 if (!stuff_empty() || global_busy || !typebuf_typed()
6377 #ifdef FEAT_AUTOCMD
6378 || autocmd_busy || curbuf_lock > 0 || allbuf_lock > 0
6379 #endif
6381 need_check_timestamps = TRUE; /* check later */
6382 else
6384 ++no_wait_return;
6385 did_check_timestamps = TRUE;
6386 already_warned = FALSE;
6387 #ifdef FEAT_GUI_MACVIM
6388 default_reload_choice = 0;
6389 #endif
6390 for (buf = firstbuf; buf != NULL; )
6392 /* Only check buffers in a window. */
6393 if (buf->b_nwindows > 0)
6395 n = buf_check_timestamp(buf, focus);
6396 if (didit < n)
6397 didit = n;
6398 if (n > 0 && !buf_valid(buf))
6400 /* Autocommands have removed the buffer, start at the
6401 * first one again. */
6402 buf = firstbuf;
6403 continue;
6406 buf = buf->b_next;
6408 #ifdef FEAT_GUI_MACVIM
6409 default_reload_choice = 0;
6410 #endif
6411 --no_wait_return;
6412 need_check_timestamps = FALSE;
6413 if (need_wait_return && didit == 2)
6415 /* make sure msg isn't overwritten */
6416 msg_puts((char_u *)"\n");
6417 out_flush();
6420 return didit;
6424 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6425 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6426 * empty.
6428 static int
6429 move_lines(frombuf, tobuf)
6430 buf_T *frombuf;
6431 buf_T *tobuf;
6433 buf_T *tbuf = curbuf;
6434 int retval = OK;
6435 linenr_T lnum;
6436 char_u *p;
6438 /* Copy the lines in "frombuf" to "tobuf". */
6439 curbuf = tobuf;
6440 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6442 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6443 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6445 vim_free(p);
6446 retval = FAIL;
6447 break;
6449 vim_free(p);
6452 /* Delete all the lines in "frombuf". */
6453 if (retval != FAIL)
6455 curbuf = frombuf;
6456 for (lnum = curbuf->b_ml.ml_line_count; lnum > 0; --lnum)
6457 if (ml_delete(lnum, FALSE) == FAIL)
6459 /* Oops! We could try putting back the saved lines, but that
6460 * might fail again... */
6461 retval = FAIL;
6462 break;
6466 curbuf = tbuf;
6467 return retval;
6471 * Check if buffer "buf" has been changed.
6472 * Also check if the file for a new buffer unexpectedly appeared.
6473 * return 1 if a changed buffer was found.
6474 * return 2 if a message has been displayed.
6475 * return 0 otherwise.
6477 /*ARGSUSED*/
6479 buf_check_timestamp(buf, focus)
6480 buf_T *buf;
6481 int focus; /* called for GUI focus event */
6483 struct stat st;
6484 int stat_res;
6485 int retval = 0;
6486 char_u *path;
6487 char_u *tbuf;
6488 char *mesg = NULL;
6489 char *mesg2 = "";
6490 int helpmesg = FALSE;
6491 int reload = FALSE;
6492 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6493 int can_reload = FALSE;
6494 #endif
6495 size_t orig_size = buf->b_orig_size;
6496 int orig_mode = buf->b_orig_mode;
6497 #ifdef FEAT_GUI
6498 int save_mouse_correct = need_mouse_correct;
6499 #endif
6500 #ifdef FEAT_AUTOCMD
6501 static int busy = FALSE;
6502 int n;
6503 char_u *s;
6504 #endif
6505 char *reason;
6507 /* If there is no file name, the buffer is not loaded, 'buftype' is
6508 * set, we are in the middle of a save or being called recursively: ignore
6509 * this buffer. */
6510 if (buf->b_ffname == NULL
6511 || buf->b_ml.ml_mfp == NULL
6512 #if defined(FEAT_QUICKFIX)
6513 || *buf->b_p_bt != NUL
6514 #endif
6515 || buf->b_saving
6516 #ifdef FEAT_AUTOCMD
6517 || busy
6518 #endif
6519 #ifdef FEAT_NETBEANS_INTG
6520 || isNetbeansBuffer(buf)
6521 #endif
6523 return 0;
6525 if ( !(buf->b_flags & BF_NOTEDITED)
6526 && buf->b_mtime != 0
6527 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6528 || time_differs((long)st.st_mtime, buf->b_mtime)
6529 #ifdef HAVE_ST_MODE
6530 || (int)st.st_mode != buf->b_orig_mode
6531 #else
6532 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6533 #endif
6536 retval = 1;
6538 /* set b_mtime to stop further warnings (e.g., when executing
6539 * FileChangedShell autocmd) */
6540 if (stat_res < 0)
6542 buf->b_mtime = 0;
6543 buf->b_orig_size = 0;
6544 buf->b_orig_mode = 0;
6546 else
6547 buf_store_time(buf, &st, buf->b_ffname);
6549 /* Don't do anything for a directory. Might contain the file
6550 * explorer. */
6551 if (mch_isdir(buf->b_fname))
6555 * If 'autoread' is set, the buffer has no changes and the file still
6556 * exists, reload the buffer. Use the buffer-local option value if it
6557 * was set, the global option value otherwise.
6559 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6560 && !bufIsChanged(buf) && stat_res >= 0)
6561 reload = TRUE;
6562 else
6564 if (stat_res < 0)
6565 reason = "deleted";
6566 else if (bufIsChanged(buf))
6567 reason = "conflict";
6568 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6569 reason = "changed";
6570 else if (orig_mode != buf->b_orig_mode)
6571 reason = "mode";
6572 else
6573 reason = "time";
6575 #ifdef FEAT_AUTOCMD
6577 * Only give the warning if there are no FileChangedShell
6578 * autocommands.
6579 * Avoid being called recursively by setting "busy".
6581 busy = TRUE;
6582 # ifdef FEAT_EVAL
6583 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6584 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6585 # endif
6586 ++allbuf_lock;
6587 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6588 buf->b_fname, buf->b_fname, FALSE, buf);
6589 --allbuf_lock;
6590 busy = FALSE;
6591 if (n)
6593 if (!buf_valid(buf))
6594 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6595 # ifdef FEAT_EVAL
6596 s = get_vim_var_str(VV_FCS_CHOICE);
6597 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6598 reload = TRUE;
6599 else if (STRCMP(s, "ask") == 0)
6600 n = FALSE;
6601 else
6602 # endif
6603 return 2;
6605 if (!n)
6606 #endif
6608 if (*reason == 'd')
6609 mesg = _("E211: File \"%s\" no longer available");
6610 else
6612 helpmesg = TRUE;
6613 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6614 can_reload = TRUE;
6615 #endif
6617 * Check if the file contents really changed to avoid
6618 * giving a warning when only the timestamp was set (e.g.,
6619 * checked out of CVS). Always warn when the buffer was
6620 * changed.
6622 if (reason[2] == 'n')
6624 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6625 mesg2 = _("See \":help W12\" for more info.");
6627 else if (reason[1] == 'h')
6629 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6630 mesg2 = _("See \":help W11\" for more info.");
6632 else if (*reason == 'm')
6634 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6635 mesg2 = _("See \":help W16\" for more info.");
6637 /* Else: only timestamp changed, ignored */
6643 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6644 && vim_fexists(buf->b_ffname))
6646 retval = 1;
6647 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6648 buf->b_flags |= BF_NEW_W;
6649 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6650 can_reload = TRUE;
6651 #endif
6654 if (mesg != NULL)
6656 path = home_replace_save(buf, buf->b_fname);
6657 if (path != NULL)
6659 if (!helpmesg)
6660 mesg2 = "";
6661 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6662 + STRLEN(mesg2) + 2));
6663 sprintf((char *)tbuf, mesg, path);
6664 #ifdef FEAT_EVAL
6665 /* Set warningmsg here, before the unimportant and output-specific
6666 * mesg2 has been appended. */
6667 set_vim_var_string(VV_WARNINGMSG, tbuf, -1);
6668 #endif
6669 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6670 if (can_reload)
6672 if (*mesg2 != NUL)
6674 STRCAT(tbuf, "\n");
6675 STRCAT(tbuf, mesg2);
6677 # ifdef FEAT_GUI_MACVIM
6678 if (default_reload_choice > 0)
6680 if (default_reload_choice == 2)
6681 reload = TRUE;
6683 else
6685 switch (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6686 (char_u *)_("&OK\n&Load File\nLoad &All\n&Ignore All"),
6687 1, NULL))
6689 case 3:
6690 default_reload_choice = 2;
6691 case 2:
6692 reload = TRUE;
6693 break;
6694 case 4:
6695 default_reload_choice = 1;
6696 break;
6699 # else
6700 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6701 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6702 reload = TRUE;
6703 # endif
6705 else
6706 #endif
6707 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6709 if (*mesg2 != NUL)
6711 STRCAT(tbuf, "; ");
6712 STRCAT(tbuf, mesg2);
6714 EMSG(tbuf);
6715 retval = 2;
6717 else
6719 # ifdef FEAT_AUTOCMD
6720 if (!autocmd_busy)
6721 # endif
6723 msg_start();
6724 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6725 if (*mesg2 != NUL)
6726 msg_puts_attr((char_u *)mesg2,
6727 hl_attr(HLF_W) + MSG_HIST);
6728 msg_clr_eos();
6729 (void)msg_end();
6730 if (emsg_silent == 0)
6732 out_flush();
6733 # ifdef FEAT_GUI
6734 if (!focus)
6735 # endif
6736 /* give the user some time to think about it */
6737 ui_delay(1000L, TRUE);
6739 /* don't redraw and erase the message */
6740 redraw_cmdline = FALSE;
6743 already_warned = TRUE;
6746 vim_free(path);
6747 vim_free(tbuf);
6751 if (reload)
6752 /* Reload the buffer. */
6753 buf_reload(buf, orig_mode);
6755 #ifdef FEAT_AUTOCMD
6756 /* Trigger FileChangedShell when the file was changed in any way. */
6757 if (buf_valid(buf) && retval != 0)
6758 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6759 buf->b_fname, buf->b_fname, FALSE, buf);
6760 #endif
6761 #ifdef FEAT_GUI
6762 /* restore this in case an autocommand has set it; it would break
6763 * 'mousefocus' */
6764 need_mouse_correct = save_mouse_correct;
6765 #endif
6767 return retval;
6771 * Reload a buffer that is already loaded.
6772 * Used when the file was changed outside of Vim.
6773 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6774 * buf->b_orig_mode may have been reset already.
6776 void
6777 buf_reload(buf, orig_mode)
6778 buf_T *buf;
6779 int orig_mode;
6781 exarg_T ea;
6782 pos_T old_cursor;
6783 linenr_T old_topline;
6784 int old_ro = buf->b_p_ro;
6785 buf_T *savebuf;
6786 int saved = OK;
6787 aco_save_T aco;
6789 /* set curwin/curbuf for "buf" and save some things */
6790 aucmd_prepbuf(&aco, buf);
6792 /* We only want to read the text from the file, not reset the syntax
6793 * highlighting, clear marks, diff status, etc. Force the fileformat
6794 * and encoding to be the same. */
6795 if (prep_exarg(&ea, buf) == OK)
6797 old_cursor = curwin->w_cursor;
6798 old_topline = curwin->w_topline;
6801 * To behave like when a new file is edited (matters for
6802 * BufReadPost autocommands) we first need to delete the current
6803 * buffer contents. But if reading the file fails we should keep
6804 * the old contents. Can't use memory only, the file might be
6805 * too big. Use a hidden buffer to move the buffer contents to.
6807 if (bufempty())
6808 savebuf = NULL;
6809 else
6811 /* Allocate a buffer without putting it in the buffer list. */
6812 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6813 if (savebuf != NULL && buf == curbuf)
6815 /* Open the memline. */
6816 curbuf = savebuf;
6817 curwin->w_buffer = savebuf;
6818 saved = ml_open(curbuf);
6819 curbuf = buf;
6820 curwin->w_buffer = buf;
6822 if (savebuf == NULL || saved == FAIL || buf != curbuf
6823 || move_lines(buf, savebuf) == FAIL)
6825 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6826 buf->b_fname);
6827 saved = FAIL;
6831 if (saved == OK)
6833 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6834 #ifdef FEAT_AUTOCMD
6835 keep_filetype = TRUE; /* don't detect 'filetype' */
6836 #endif
6837 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6838 (linenr_T)0,
6839 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6841 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6842 if (!aborting())
6843 #endif
6844 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6845 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6847 /* Put the text back from the save buffer. First
6848 * delete any lines that readfile() added. */
6849 while (!bufempty())
6850 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6851 break;
6852 (void)move_lines(savebuf, buf);
6855 else if (buf == curbuf)
6857 /* Mark the buffer as unmodified and free undo info. */
6858 unchanged(buf, TRUE);
6859 u_blockfree(buf);
6860 u_clearall(buf);
6863 vim_free(ea.cmd);
6865 if (savebuf != NULL && buf_valid(savebuf))
6866 wipe_buffer(savebuf, FALSE);
6868 #ifdef FEAT_DIFF
6869 /* Invalidate diff info if necessary. */
6870 diff_invalidate(curbuf);
6871 #endif
6873 /* Restore the topline and cursor position and check it (lines may
6874 * have been removed). */
6875 if (old_topline > curbuf->b_ml.ml_line_count)
6876 curwin->w_topline = curbuf->b_ml.ml_line_count;
6877 else
6878 curwin->w_topline = old_topline;
6879 curwin->w_cursor = old_cursor;
6880 check_cursor();
6881 update_topline();
6882 #ifdef FEAT_AUTOCMD
6883 keep_filetype = FALSE;
6884 #endif
6885 #ifdef FEAT_FOLDING
6887 win_T *wp;
6889 /* Update folds unless they are defined manually. */
6890 FOR_ALL_WINDOWS(wp)
6891 if (wp->w_buffer == curwin->w_buffer
6892 && !foldmethodIsManual(wp))
6893 foldUpdateAll(wp);
6895 #endif
6896 /* If the mode didn't change and 'readonly' was set, keep the old
6897 * value; the user probably used the ":view" command. But don't
6898 * reset it, might have had a read error. */
6899 if (orig_mode == curbuf->b_orig_mode)
6900 curbuf->b_p_ro |= old_ro;
6903 /* restore curwin/curbuf and a few other things */
6904 aucmd_restbuf(&aco);
6905 /* Careful: autocommands may have made "buf" invalid! */
6908 /*ARGSUSED*/
6909 void
6910 buf_store_time(buf, st, fname)
6911 buf_T *buf;
6912 struct stat *st;
6913 char_u *fname;
6915 buf->b_mtime = (long)st->st_mtime;
6916 buf->b_orig_size = (size_t)st->st_size;
6917 #ifdef HAVE_ST_MODE
6918 buf->b_orig_mode = (int)st->st_mode;
6919 #else
6920 buf->b_orig_mode = mch_getperm(fname);
6921 #endif
6925 * Adjust the line with missing eol, used for the next write.
6926 * Used for do_filter(), when the input lines for the filter are deleted.
6928 void
6929 write_lnum_adjust(offset)
6930 linenr_T offset;
6932 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
6933 write_no_eol_lnum += offset;
6936 #if defined(TEMPDIRNAMES) || defined(PROTO)
6937 static long temp_count = 0; /* Temp filename counter. */
6940 * Delete the temp directory and all files it contains.
6942 void
6943 vim_deltempdir()
6945 char_u **files;
6946 int file_count;
6947 int i;
6949 if (vim_tempdir != NULL)
6951 sprintf((char *)NameBuff, "%s*", vim_tempdir);
6952 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
6953 EW_DIR|EW_FILE|EW_SILENT) == OK)
6955 for (i = 0; i < file_count; ++i)
6956 mch_remove(files[i]);
6957 FreeWild(file_count, files);
6959 gettail(NameBuff)[-1] = NUL;
6960 (void)mch_rmdir(NameBuff);
6962 vim_free(vim_tempdir);
6963 vim_tempdir = NULL;
6966 #endif
6969 * vim_tempname(): Return a unique name that can be used for a temp file.
6971 * The temp file is NOT created.
6973 * The returned pointer is to allocated memory.
6974 * The returned pointer is NULL if no valid name was found.
6976 /*ARGSUSED*/
6977 char_u *
6978 vim_tempname(extra_char)
6979 int extra_char; /* character to use in the name instead of '?' */
6981 #ifdef USE_TMPNAM
6982 char_u itmp[L_tmpnam]; /* use tmpnam() */
6983 #else
6984 char_u itmp[TEMPNAMELEN];
6985 #endif
6987 #ifdef TEMPDIRNAMES
6988 static char *(tempdirs[]) = {TEMPDIRNAMES};
6989 int i;
6990 long nr;
6991 long off;
6992 # ifndef EEXIST
6993 struct stat st;
6994 # endif
6997 * This will create a directory for private use by this instance of Vim.
6998 * This is done once, and the same directory is used for all temp files.
6999 * This method avoids security problems because of symlink attacks et al.
7000 * It's also a bit faster, because we only need to check for an existing
7001 * file when creating the directory and not for each temp file.
7003 if (vim_tempdir == NULL)
7006 * Try the entries in TEMPDIRNAMES to create the temp directory.
7008 for (i = 0; i < sizeof(tempdirs) / sizeof(char *); ++i)
7010 /* expand $TMP, leave room for "/v1100000/999999999" */
7011 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
7012 if (mch_isdir(itmp)) /* directory exists */
7014 # ifdef __EMX__
7015 /* If $TMP contains a forward slash (perhaps using bash or
7016 * tcsh), don't add a backslash, use a forward slash!
7017 * Adding 2 backslashes didn't work. */
7018 if (vim_strchr(itmp, '/') != NULL)
7019 STRCAT(itmp, "/");
7020 else
7021 # endif
7022 add_pathsep(itmp);
7024 /* Get an arbitrary number of up to 6 digits. When it's
7025 * unlikely that it already exists it will be faster,
7026 * otherwise it doesn't matter. The use of mkdir() avoids any
7027 * security problems because of the predictable number. */
7028 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
7030 /* Try up to 10000 different values until we find a name that
7031 * doesn't exist. */
7032 for (off = 0; off < 10000L; ++off)
7034 int r;
7035 #if defined(UNIX) || defined(VMS)
7036 mode_t umask_save;
7037 #endif
7039 sprintf((char *)itmp + STRLEN(itmp), "v%ld", nr + off);
7040 # ifndef EEXIST
7041 /* If mkdir() does not set errno to EEXIST, check for
7042 * existing file here. There is a race condition then,
7043 * although it's fail-safe. */
7044 if (mch_stat((char *)itmp, &st) >= 0)
7045 continue;
7046 # endif
7047 #if defined(UNIX) || defined(VMS)
7048 /* Make sure the umask doesn't remove the executable bit.
7049 * "repl" has been reported to use "177". */
7050 umask_save = umask(077);
7051 #endif
7052 r = vim_mkdir(itmp, 0700);
7053 #if defined(UNIX) || defined(VMS)
7054 (void)umask(umask_save);
7055 #endif
7056 if (r == 0)
7058 char_u *buf;
7060 /* Directory was created, use this name.
7061 * Expand to full path; When using the current
7062 * directory a ":cd" would confuse us. */
7063 buf = alloc((unsigned)MAXPATHL + 1);
7064 if (buf != NULL)
7066 if (vim_FullName(itmp, buf, MAXPATHL, FALSE)
7067 == FAIL)
7068 STRCPY(buf, itmp);
7069 # ifdef __EMX__
7070 if (vim_strchr(buf, '/') != NULL)
7071 STRCAT(buf, "/");
7072 else
7073 # endif
7074 add_pathsep(buf);
7075 vim_tempdir = vim_strsave(buf);
7076 vim_free(buf);
7078 break;
7080 # ifdef EEXIST
7081 /* If the mkdir() didn't fail because the file/dir exists,
7082 * we probably can't create any dir here, try another
7083 * place. */
7084 if (errno != EEXIST)
7085 # endif
7086 break;
7088 if (vim_tempdir != NULL)
7089 break;
7094 if (vim_tempdir != NULL)
7096 /* There is no need to check if the file exists, because we own the
7097 * directory and nobody else creates a file in it. */
7098 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
7099 return vim_strsave(itmp);
7102 return NULL;
7104 #else /* TEMPDIRNAMES */
7106 # ifdef WIN3264
7107 char szTempFile[_MAX_PATH + 1];
7108 char buf4[4];
7109 char_u *retval;
7110 char_u *p;
7112 STRCPY(itmp, "");
7113 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
7114 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
7115 strcpy(buf4, "VIM");
7116 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
7117 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
7118 return NULL;
7119 /* GetTempFileName() will create the file, we don't want that */
7120 (void)DeleteFile(itmp);
7122 /* Backslashes in a temp file name cause problems when filtering with
7123 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
7124 * didn't set 'shellslash'. */
7125 retval = vim_strsave(itmp);
7126 if (*p_shcf == '-' || p_ssl)
7127 for (p = retval; *p; ++p)
7128 if (*p == '\\')
7129 *p = '/';
7130 return retval;
7132 # else /* WIN3264 */
7134 # ifdef USE_TMPNAM
7135 /* tmpnam() will make its own name */
7136 if (*tmpnam((char *)itmp) == NUL)
7137 return NULL;
7138 # else
7139 char_u *p;
7141 # ifdef VMS_TEMPNAM
7142 /* mktemp() is not working on VMS. It seems to be
7143 * a do-nothing function. Therefore we use tempnam().
7145 sprintf((char *)itmp, "VIM%c", extra_char);
7146 p = (char_u *)tempnam("tmp:", (char *)itmp);
7147 if (p != NULL)
7149 /* VMS will use '.LOG' if we don't explicitly specify an extension,
7150 * and VIM will then be unable to find the file later */
7151 STRCPY(itmp, p);
7152 STRCAT(itmp, ".txt");
7153 free(p);
7155 else
7156 return NULL;
7157 # else
7158 STRCPY(itmp, TEMPNAME);
7159 if ((p = vim_strchr(itmp, '?')) != NULL)
7160 *p = extra_char;
7161 if (mktemp((char *)itmp) == NULL)
7162 return NULL;
7163 # endif
7164 # endif
7166 return vim_strsave(itmp);
7167 # endif /* WIN3264 */
7168 #endif /* TEMPDIRNAMES */
7171 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
7173 * Convert all backslashes in fname to forward slashes in-place.
7175 void
7176 forward_slash(fname)
7177 char_u *fname;
7179 char_u *p;
7181 for (p = fname; *p != NUL; ++p)
7182 # ifdef FEAT_MBYTE
7183 /* The Big5 encoding can have '\' in the trail byte. */
7184 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
7185 ++p;
7186 else
7187 # endif
7188 if (*p == '\\')
7189 *p = '/';
7191 #endif
7195 * Code for automatic commands.
7197 * Only included when "FEAT_AUTOCMD" has been defined.
7200 #if defined(FEAT_AUTOCMD) || defined(PROTO)
7203 * The autocommands are stored in a list for each event.
7204 * Autocommands for the same pattern, that are consecutive, are joined
7205 * together, to avoid having to match the pattern too often.
7206 * The result is an array of Autopat lists, which point to AutoCmd lists:
7208 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7209 * Autopat.cmds Autopat.cmds
7210 * | |
7211 * V V
7212 * AutoCmd.next AutoCmd.next
7213 * | |
7214 * V V
7215 * AutoCmd.next NULL
7218 * NULL
7220 * first_autopat[1] --> Autopat.next --> NULL
7221 * Autopat.cmds
7224 * AutoCmd.next
7227 * NULL
7228 * etc.
7230 * The order of AutoCmds is important, this is the order in which they were
7231 * defined and will have to be executed.
7233 typedef struct AutoCmd
7235 char_u *cmd; /* The command to be executed (NULL
7236 when command has been removed) */
7237 char nested; /* If autocommands nest here */
7238 char last; /* last command in list */
7239 #ifdef FEAT_EVAL
7240 scid_T scriptID; /* script ID where defined */
7241 #endif
7242 struct AutoCmd *next; /* Next AutoCmd in list */
7243 } AutoCmd;
7245 typedef struct AutoPat
7247 int group; /* group ID */
7248 char_u *pat; /* pattern as typed (NULL when pattern
7249 has been removed) */
7250 int patlen; /* strlen() of pat */
7251 regprog_T *reg_prog; /* compiled regprog for pattern */
7252 char allow_dirs; /* Pattern may match whole path */
7253 char last; /* last pattern for apply_autocmds() */
7254 AutoCmd *cmds; /* list of commands to do */
7255 struct AutoPat *next; /* next AutoPat in AutoPat list */
7256 int buflocal_nr; /* !=0 for buffer-local AutoPat */
7257 } AutoPat;
7259 static struct event_name
7261 char *name; /* event name */
7262 event_T event; /* event number */
7263 } event_names[] =
7265 {"BufAdd", EVENT_BUFADD},
7266 {"BufCreate", EVENT_BUFADD},
7267 {"BufDelete", EVENT_BUFDELETE},
7268 {"BufEnter", EVENT_BUFENTER},
7269 {"BufFilePost", EVENT_BUFFILEPOST},
7270 {"BufFilePre", EVENT_BUFFILEPRE},
7271 {"BufHidden", EVENT_BUFHIDDEN},
7272 {"BufLeave", EVENT_BUFLEAVE},
7273 {"BufNew", EVENT_BUFNEW},
7274 {"BufNewFile", EVENT_BUFNEWFILE},
7275 {"BufRead", EVENT_BUFREADPOST},
7276 {"BufReadCmd", EVENT_BUFREADCMD},
7277 {"BufReadPost", EVENT_BUFREADPOST},
7278 {"BufReadPre", EVENT_BUFREADPRE},
7279 {"BufUnload", EVENT_BUFUNLOAD},
7280 {"BufWinEnter", EVENT_BUFWINENTER},
7281 {"BufWinLeave", EVENT_BUFWINLEAVE},
7282 {"BufWipeout", EVENT_BUFWIPEOUT},
7283 {"BufWrite", EVENT_BUFWRITEPRE},
7284 {"BufWritePost", EVENT_BUFWRITEPOST},
7285 {"BufWritePre", EVENT_BUFWRITEPRE},
7286 {"BufWriteCmd", EVENT_BUFWRITECMD},
7287 {"CmdwinEnter", EVENT_CMDWINENTER},
7288 {"CmdwinLeave", EVENT_CMDWINLEAVE},
7289 {"ColorScheme", EVENT_COLORSCHEME},
7290 {"CursorHold", EVENT_CURSORHOLD},
7291 {"CursorHoldI", EVENT_CURSORHOLDI},
7292 {"CursorMoved", EVENT_CURSORMOVED},
7293 {"CursorMovedI", EVENT_CURSORMOVEDI},
7294 {"EncodingChanged", EVENT_ENCODINGCHANGED},
7295 {"FileEncoding", EVENT_ENCODINGCHANGED},
7296 {"FileAppendPost", EVENT_FILEAPPENDPOST},
7297 {"FileAppendPre", EVENT_FILEAPPENDPRE},
7298 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
7299 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
7300 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
7301 {"FileChangedRO", EVENT_FILECHANGEDRO},
7302 {"FileReadPost", EVENT_FILEREADPOST},
7303 {"FileReadPre", EVENT_FILEREADPRE},
7304 {"FileReadCmd", EVENT_FILEREADCMD},
7305 {"FileType", EVENT_FILETYPE},
7306 {"FileWritePost", EVENT_FILEWRITEPOST},
7307 {"FileWritePre", EVENT_FILEWRITEPRE},
7308 {"FileWriteCmd", EVENT_FILEWRITECMD},
7309 {"FilterReadPost", EVENT_FILTERREADPOST},
7310 {"FilterReadPre", EVENT_FILTERREADPRE},
7311 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7312 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7313 {"FocusGained", EVENT_FOCUSGAINED},
7314 {"FocusLost", EVENT_FOCUSLOST},
7315 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7316 {"GUIEnter", EVENT_GUIENTER},
7317 {"GUIFailed", EVENT_GUIFAILED},
7318 {"InsertChange", EVENT_INSERTCHANGE},
7319 {"InsertEnter", EVENT_INSERTENTER},
7320 {"InsertLeave", EVENT_INSERTLEAVE},
7321 {"MenuPopup", EVENT_MENUPOPUP},
7322 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7323 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7324 {"RemoteReply", EVENT_REMOTEREPLY},
7325 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7326 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7327 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7328 {"SourcePre", EVENT_SOURCEPRE},
7329 {"SourceCmd", EVENT_SOURCECMD},
7330 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7331 {"StdinReadPost", EVENT_STDINREADPOST},
7332 {"StdinReadPre", EVENT_STDINREADPRE},
7333 {"SwapExists", EVENT_SWAPEXISTS},
7334 {"Syntax", EVENT_SYNTAX},
7335 {"TabEnter", EVENT_TABENTER},
7336 {"TabLeave", EVENT_TABLEAVE},
7337 {"TermChanged", EVENT_TERMCHANGED},
7338 {"TermResponse", EVENT_TERMRESPONSE},
7339 {"User", EVENT_USER},
7340 {"VimEnter", EVENT_VIMENTER},
7341 {"VimLeave", EVENT_VIMLEAVE},
7342 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7343 {"WinEnter", EVENT_WINENTER},
7344 {"WinLeave", EVENT_WINLEAVE},
7345 {"VimResized", EVENT_VIMRESIZED},
7346 {NULL, (event_T)0}
7349 static AutoPat *first_autopat[NUM_EVENTS] =
7351 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7352 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7353 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7354 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7355 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7356 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7360 * struct used to keep status while executing autocommands for an event.
7362 typedef struct AutoPatCmd
7364 AutoPat *curpat; /* next AutoPat to examine */
7365 AutoCmd *nextcmd; /* next AutoCmd to execute */
7366 int group; /* group being used */
7367 char_u *fname; /* fname to match with */
7368 char_u *sfname; /* sfname to match with */
7369 char_u *tail; /* tail of fname */
7370 event_T event; /* current event */
7371 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7372 buf is deleted */
7373 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7374 } AutoPatCmd;
7376 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7379 * augroups stores a list of autocmd group names.
7381 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7382 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7385 * The ID of the current group. Group 0 is the default one.
7387 static int current_augroup = AUGROUP_DEFAULT;
7389 static int au_need_clean = FALSE; /* need to delete marked patterns */
7391 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7392 static void au_remove_pat __ARGS((AutoPat *ap));
7393 static void au_remove_cmds __ARGS((AutoPat *ap));
7394 static void au_cleanup __ARGS((void));
7395 static int au_new_group __ARGS((char_u *name));
7396 static void au_del_group __ARGS((char_u *name));
7397 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7398 static char_u *event_nr2name __ARGS((event_T event));
7399 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7400 static int event_ignored __ARGS((event_T event));
7401 static int au_get_grouparg __ARGS((char_u **argp));
7402 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7403 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7404 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));
7405 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7408 static event_T last_event;
7409 static int last_group;
7410 static int autocmd_blocked = 0; /* block all autocmds */
7413 * Show the autocommands for one AutoPat.
7415 static void
7416 show_autocmd(ap, event)
7417 AutoPat *ap;
7418 event_T event;
7420 AutoCmd *ac;
7422 /* Check for "got_int" (here and at various places below), which is set
7423 * when "q" has been hit for the "--more--" prompt */
7424 if (got_int)
7425 return;
7426 if (ap->pat == NULL) /* pattern has been removed */
7427 return;
7429 msg_putchar('\n');
7430 if (got_int)
7431 return;
7432 if (event != last_event || ap->group != last_group)
7434 if (ap->group != AUGROUP_DEFAULT)
7436 if (AUGROUP_NAME(ap->group) == NULL)
7437 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7438 else
7439 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7440 msg_puts((char_u *)" ");
7442 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7443 last_event = event;
7444 last_group = ap->group;
7445 msg_putchar('\n');
7446 if (got_int)
7447 return;
7449 msg_col = 4;
7450 msg_outtrans(ap->pat);
7452 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7454 if (ac->cmd != NULL) /* skip removed commands */
7456 if (msg_col >= 14)
7457 msg_putchar('\n');
7458 msg_col = 14;
7459 if (got_int)
7460 return;
7461 msg_outtrans(ac->cmd);
7462 #ifdef FEAT_EVAL
7463 if (p_verbose > 0)
7464 last_set_msg(ac->scriptID);
7465 #endif
7466 if (got_int)
7467 return;
7468 if (ac->next != NULL)
7470 msg_putchar('\n');
7471 if (got_int)
7472 return;
7479 * Mark an autocommand pattern for deletion.
7481 static void
7482 au_remove_pat(ap)
7483 AutoPat *ap;
7485 vim_free(ap->pat);
7486 ap->pat = NULL;
7487 ap->buflocal_nr = -1;
7488 au_need_clean = TRUE;
7492 * Mark all commands for a pattern for deletion.
7494 static void
7495 au_remove_cmds(ap)
7496 AutoPat *ap;
7498 AutoCmd *ac;
7500 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7502 vim_free(ac->cmd);
7503 ac->cmd = NULL;
7505 au_need_clean = TRUE;
7509 * Cleanup autocommands and patterns that have been deleted.
7510 * This is only done when not executing autocommands.
7512 static void
7513 au_cleanup()
7515 AutoPat *ap, **prev_ap;
7516 AutoCmd *ac, **prev_ac;
7517 event_T event;
7519 if (autocmd_busy || !au_need_clean)
7520 return;
7522 /* loop over all events */
7523 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7524 event = (event_T)((int)event + 1))
7526 /* loop over all autocommand patterns */
7527 prev_ap = &(first_autopat[(int)event]);
7528 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7530 /* loop over all commands for this pattern */
7531 prev_ac = &(ap->cmds);
7532 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7534 /* remove the command if the pattern is to be deleted or when
7535 * the command has been marked for deletion */
7536 if (ap->pat == NULL || ac->cmd == NULL)
7538 *prev_ac = ac->next;
7539 vim_free(ac->cmd);
7540 vim_free(ac);
7542 else
7543 prev_ac = &(ac->next);
7546 /* remove the pattern if it has been marked for deletion */
7547 if (ap->pat == NULL)
7549 *prev_ap = ap->next;
7550 vim_free(ap->reg_prog);
7551 vim_free(ap);
7553 else
7554 prev_ap = &(ap->next);
7558 au_need_clean = FALSE;
7562 * Called when buffer is freed, to remove/invalidate related buffer-local
7563 * autocmds.
7565 void
7566 aubuflocal_remove(buf)
7567 buf_T *buf;
7569 AutoPat *ap;
7570 event_T event;
7571 AutoPatCmd *apc;
7573 /* invalidate currently executing autocommands */
7574 for (apc = active_apc_list; apc; apc = apc->next)
7575 if (buf->b_fnum == apc->arg_bufnr)
7576 apc->arg_bufnr = 0;
7578 /* invalidate buflocals looping through events */
7579 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7580 event = (event_T)((int)event + 1))
7581 /* loop over all autocommand patterns */
7582 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7583 if (ap->buflocal_nr == buf->b_fnum)
7585 au_remove_pat(ap);
7586 if (p_verbose >= 6)
7588 verbose_enter();
7589 smsg((char_u *)
7590 _("auto-removing autocommand: %s <buffer=%d>"),
7591 event_nr2name(event), buf->b_fnum);
7592 verbose_leave();
7595 au_cleanup();
7599 * Add an autocmd group name.
7600 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7602 static int
7603 au_new_group(name)
7604 char_u *name;
7606 int i;
7608 i = au_find_group(name);
7609 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7611 /* First try using a free entry. */
7612 for (i = 0; i < augroups.ga_len; ++i)
7613 if (AUGROUP_NAME(i) == NULL)
7614 break;
7615 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7616 return AUGROUP_ERROR;
7618 AUGROUP_NAME(i) = vim_strsave(name);
7619 if (AUGROUP_NAME(i) == NULL)
7620 return AUGROUP_ERROR;
7621 if (i == augroups.ga_len)
7622 ++augroups.ga_len;
7625 return i;
7628 static void
7629 au_del_group(name)
7630 char_u *name;
7632 int i;
7634 i = au_find_group(name);
7635 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7636 EMSG2(_("E367: No such group: \"%s\""), name);
7637 else
7639 vim_free(AUGROUP_NAME(i));
7640 AUGROUP_NAME(i) = NULL;
7645 * Find the ID of an autocmd group name.
7646 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7648 static int
7649 au_find_group(name)
7650 char_u *name;
7652 int i;
7654 for (i = 0; i < augroups.ga_len; ++i)
7655 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7656 return i;
7657 return AUGROUP_ERROR;
7661 * Return TRUE if augroup "name" exists.
7664 au_has_group(name)
7665 char_u *name;
7667 return au_find_group(name) != AUGROUP_ERROR;
7671 * ":augroup {name}".
7673 void
7674 do_augroup(arg, del_group)
7675 char_u *arg;
7676 int del_group;
7678 int i;
7680 if (del_group)
7682 if (*arg == NUL)
7683 EMSG(_(e_argreq));
7684 else
7685 au_del_group(arg);
7687 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7688 current_augroup = AUGROUP_DEFAULT;
7689 else if (*arg) /* ":aug xxx": switch to group xxx */
7691 i = au_new_group(arg);
7692 if (i != AUGROUP_ERROR)
7693 current_augroup = i;
7695 else /* ":aug": list the group names */
7697 msg_start();
7698 for (i = 0; i < augroups.ga_len; ++i)
7700 if (AUGROUP_NAME(i) != NULL)
7702 msg_puts(AUGROUP_NAME(i));
7703 msg_puts((char_u *)" ");
7706 msg_clr_eos();
7707 msg_end();
7711 #if defined(EXITFREE) || defined(PROTO)
7712 void
7713 free_all_autocmds()
7715 for (current_augroup = -1; current_augroup < augroups.ga_len;
7716 ++current_augroup)
7717 do_autocmd((char_u *)"", TRUE);
7718 ga_clear_strings(&augroups);
7720 #endif
7723 * Return the event number for event name "start".
7724 * Return NUM_EVENTS if the event name was not found.
7725 * Return a pointer to the next event name in "end".
7727 static event_T
7728 event_name2nr(start, end)
7729 char_u *start;
7730 char_u **end;
7732 char_u *p;
7733 int i;
7734 int len;
7736 /* the event name ends with end of line, a blank or a comma */
7737 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7739 for (i = 0; event_names[i].name != NULL; ++i)
7741 len = (int)STRLEN(event_names[i].name);
7742 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7743 break;
7745 if (*p == ',')
7746 ++p;
7747 *end = p;
7748 if (event_names[i].name == NULL)
7749 return NUM_EVENTS;
7750 return event_names[i].event;
7754 * Return the name for event "event".
7756 static char_u *
7757 event_nr2name(event)
7758 event_T event;
7760 int i;
7762 for (i = 0; event_names[i].name != NULL; ++i)
7763 if (event_names[i].event == event)
7764 return (char_u *)event_names[i].name;
7765 return (char_u *)"Unknown";
7769 * Scan over the events. "*" stands for all events.
7771 static char_u *
7772 find_end_event(arg, have_group)
7773 char_u *arg;
7774 int have_group; /* TRUE when group name was found */
7776 char_u *pat;
7777 char_u *p;
7779 if (*arg == '*')
7781 if (arg[1] && !vim_iswhite(arg[1]))
7783 EMSG2(_("E215: Illegal character after *: %s"), arg);
7784 return NULL;
7786 pat = arg + 1;
7788 else
7790 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7792 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7794 if (have_group)
7795 EMSG2(_("E216: No such event: %s"), pat);
7796 else
7797 EMSG2(_("E216: No such group or event: %s"), pat);
7798 return NULL;
7802 return pat;
7806 * Return TRUE if "event" is included in 'eventignore'.
7808 static int
7809 event_ignored(event)
7810 event_T event;
7812 char_u *p = p_ei;
7814 while (*p != NUL)
7816 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7817 return TRUE;
7818 if (event_name2nr(p, &p) == event)
7819 return TRUE;
7822 return FALSE;
7826 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7829 check_ei()
7831 char_u *p = p_ei;
7833 while (*p)
7835 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7837 p += 3;
7838 if (*p == ',')
7839 ++p;
7841 else if (event_name2nr(p, &p) == NUM_EVENTS)
7842 return FAIL;
7845 return OK;
7848 # if defined(FEAT_SYN_HL) || defined(PROTO)
7851 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7852 * buffer loaded into the window. "what" must start with a comma.
7853 * Returns the old value of 'eventignore' in allocated memory.
7855 char_u *
7856 au_event_disable(what)
7857 char *what;
7859 char_u *new_ei;
7860 char_u *save_ei;
7862 save_ei = vim_strsave(p_ei);
7863 if (save_ei != NULL)
7865 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7866 if (new_ei != NULL)
7868 STRCAT(new_ei, what);
7869 set_string_option_direct((char_u *)"ei", -1, new_ei,
7870 OPT_FREE, SID_NONE);
7871 vim_free(new_ei);
7874 return save_ei;
7877 void
7878 au_event_restore(old_ei)
7879 char_u *old_ei;
7881 if (old_ei != NULL)
7883 set_string_option_direct((char_u *)"ei", -1, old_ei,
7884 OPT_FREE, SID_NONE);
7885 vim_free(old_ei);
7888 # endif /* FEAT_SYN_HL */
7891 * do_autocmd() -- implements the :autocmd command. Can be used in the
7892 * following ways:
7894 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7895 * will be automatically executed for <event>
7896 * when editing a file matching <pat>, in
7897 * the current group.
7898 * :autocmd <event> <pat> Show the auto-commands associated with
7899 * <event> and <pat>.
7900 * :autocmd <event> Show the auto-commands associated with
7901 * <event>.
7902 * :autocmd Show all auto-commands.
7903 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7904 * <event> and <pat>, and add the command
7905 * <cmd>, for the current group.
7906 * :autocmd! <event> <pat> Remove all auto-commands associated with
7907 * <event> and <pat> for the current group.
7908 * :autocmd! <event> Remove all auto-commands associated with
7909 * <event> for the current group.
7910 * :autocmd! Remove ALL auto-commands for the current
7911 * group.
7913 * Multiple events and patterns may be given separated by commas. Here are
7914 * some examples:
7915 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7916 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7918 * :autocmd * *.c show all autocommands for *.c files.
7920 * Mostly a {group} argument can optionally appear before <event>.
7922 void
7923 do_autocmd(arg, forceit)
7924 char_u *arg;
7925 int forceit;
7927 char_u *pat;
7928 char_u *envpat = NULL;
7929 char_u *cmd;
7930 event_T event;
7931 int need_free = FALSE;
7932 int nested = FALSE;
7933 int group;
7936 * Check for a legal group name. If not, use AUGROUP_ALL.
7938 group = au_get_grouparg(&arg);
7939 if (arg == NULL) /* out of memory */
7940 return;
7943 * Scan over the events.
7944 * If we find an illegal name, return here, don't do anything.
7946 pat = find_end_event(arg, group != AUGROUP_ALL);
7947 if (pat == NULL)
7948 return;
7951 * Scan over the pattern. Put a NUL at the end.
7953 pat = skipwhite(pat);
7954 cmd = pat;
7955 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
7956 cmd++;
7957 if (*cmd)
7958 *cmd++ = NUL;
7960 /* Expand environment variables in the pattern. Set 'shellslash', we want
7961 * forward slashes here. */
7962 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
7964 #ifdef BACKSLASH_IN_FILENAME
7965 int p_ssl_save = p_ssl;
7967 p_ssl = TRUE;
7968 #endif
7969 envpat = expand_env_save(pat);
7970 #ifdef BACKSLASH_IN_FILENAME
7971 p_ssl = p_ssl_save;
7972 #endif
7973 if (envpat != NULL)
7974 pat = envpat;
7978 * Check for "nested" flag.
7980 cmd = skipwhite(cmd);
7981 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
7983 nested = TRUE;
7984 cmd = skipwhite(cmd + 6);
7988 * Find the start of the commands.
7989 * Expand <sfile> in it.
7991 if (*cmd != NUL)
7993 cmd = expand_sfile(cmd);
7994 if (cmd == NULL) /* some error */
7995 return;
7996 need_free = TRUE;
8000 * Print header when showing autocommands.
8002 if (!forceit && *cmd == NUL)
8004 /* Highlight title */
8005 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
8009 * Loop over the events.
8011 last_event = (event_T)-1; /* for listing the event name */
8012 last_group = AUGROUP_ERROR; /* for listing the group name */
8013 if (*arg == '*' || *arg == NUL)
8015 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
8016 event = (event_T)((int)event + 1))
8017 if (do_autocmd_event(event, pat,
8018 nested, cmd, forceit, group) == FAIL)
8019 break;
8021 else
8023 while (*arg && !vim_iswhite(*arg))
8024 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
8025 nested, cmd, forceit, group) == FAIL)
8026 break;
8029 if (need_free)
8030 vim_free(cmd);
8031 vim_free(envpat);
8035 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
8036 * The "argp" argument is advanced to the following argument.
8038 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
8040 static int
8041 au_get_grouparg(argp)
8042 char_u **argp;
8044 char_u *group_name;
8045 char_u *p;
8046 char_u *arg = *argp;
8047 int group = AUGROUP_ALL;
8049 p = skiptowhite(arg);
8050 if (p > arg)
8052 group_name = vim_strnsave(arg, (int)(p - arg));
8053 if (group_name == NULL) /* out of memory */
8054 return AUGROUP_ERROR;
8055 group = au_find_group(group_name);
8056 if (group == AUGROUP_ERROR)
8057 group = AUGROUP_ALL; /* no match, use all groups */
8058 else
8059 *argp = skipwhite(p); /* match, skip over group name */
8060 vim_free(group_name);
8062 return group;
8066 * do_autocmd() for one event.
8067 * If *pat == NUL do for all patterns.
8068 * If *cmd == NUL show entries.
8069 * If forceit == TRUE delete entries.
8070 * If group is not AUGROUP_ALL, only use this group.
8072 static int
8073 do_autocmd_event(event, pat, nested, cmd, forceit, group)
8074 event_T event;
8075 char_u *pat;
8076 int nested;
8077 char_u *cmd;
8078 int forceit;
8079 int group;
8081 AutoPat *ap;
8082 AutoPat **prev_ap;
8083 AutoCmd *ac;
8084 AutoCmd **prev_ac;
8085 int brace_level;
8086 char_u *endpat;
8087 int findgroup;
8088 int allgroups;
8089 int patlen;
8090 int is_buflocal;
8091 int buflocal_nr;
8092 char_u buflocal_pat[25]; /* for "<buffer=X>" */
8094 if (group == AUGROUP_ALL)
8095 findgroup = current_augroup;
8096 else
8097 findgroup = group;
8098 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
8101 * Show or delete all patterns for an event.
8103 if (*pat == NUL)
8105 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
8107 if (forceit) /* delete the AutoPat, if it's in the current group */
8109 if (ap->group == findgroup)
8110 au_remove_pat(ap);
8112 else if (group == AUGROUP_ALL || ap->group == group)
8113 show_autocmd(ap, event);
8118 * Loop through all the specified patterns.
8120 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
8123 * Find end of the pattern.
8124 * Watch out for a comma in braces, like "*.\{obj,o\}".
8126 brace_level = 0;
8127 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
8128 || endpat[-1] == '\\'); ++endpat)
8130 if (*endpat == '{')
8131 brace_level++;
8132 else if (*endpat == '}')
8133 brace_level--;
8135 if (pat == endpat) /* ignore single comma */
8136 continue;
8137 patlen = (int)(endpat - pat);
8140 * detect special <buflocal[=X]> buffer-local patterns
8142 is_buflocal = FALSE;
8143 buflocal_nr = 0;
8145 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
8146 && pat[patlen - 1] == '>')
8148 /* Error will be printed only for addition. printing and removing
8149 * will proceed silently. */
8150 is_buflocal = TRUE;
8151 if (patlen == 8)
8152 buflocal_nr = curbuf->b_fnum;
8153 else if (patlen > 9 && pat[7] == '=')
8155 /* <buffer=abuf> */
8156 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
8157 buflocal_nr = autocmd_bufnr;
8158 /* <buffer=123> */
8159 else if (skipdigits(pat + 8) == pat + patlen - 1)
8160 buflocal_nr = atoi((char *)pat + 8);
8164 if (is_buflocal)
8166 /* normalize pat into standard "<buffer>#N" form */
8167 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
8168 pat = buflocal_pat; /* can modify pat and patlen */
8169 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
8173 * Find AutoPat entries with this pattern.
8175 prev_ap = &first_autopat[(int)event];
8176 while ((ap = *prev_ap) != NULL)
8178 if (ap->pat != NULL)
8180 /* Accept a pattern when:
8181 * - a group was specified and it's that group, or a group was
8182 * not specified and it's the current group, or a group was
8183 * not specified and we are listing
8184 * - the length of the pattern matches
8185 * - the pattern matches.
8186 * For <buffer[=X]>, this condition works because we normalize
8187 * all buffer-local patterns.
8189 if ((allgroups || ap->group == findgroup)
8190 && ap->patlen == patlen
8191 && STRNCMP(pat, ap->pat, patlen) == 0)
8194 * Remove existing autocommands.
8195 * If adding any new autocmd's for this AutoPat, don't
8196 * delete the pattern from the autopat list, append to
8197 * this list.
8199 if (forceit)
8201 if (*cmd != NUL && ap->next == NULL)
8203 au_remove_cmds(ap);
8204 break;
8206 au_remove_pat(ap);
8210 * Show autocmd's for this autopat, or buflocals <buffer=X>
8212 else if (*cmd == NUL)
8213 show_autocmd(ap, event);
8216 * Add autocmd to this autopat, if it's the last one.
8218 else if (ap->next == NULL)
8219 break;
8222 prev_ap = &ap->next;
8226 * Add a new command.
8228 if (*cmd != NUL)
8231 * If the pattern we want to add a command to does appear at the
8232 * end of the list (or not is not in the list at all), add the
8233 * pattern at the end of the list.
8235 if (ap == NULL)
8237 /* refuse to add buffer-local ap if buffer number is invalid */
8238 if (is_buflocal && (buflocal_nr == 0
8239 || buflist_findnr(buflocal_nr) == NULL))
8241 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8242 buflocal_nr);
8243 return FAIL;
8246 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
8247 if (ap == NULL)
8248 return FAIL;
8249 ap->pat = vim_strnsave(pat, patlen);
8250 ap->patlen = patlen;
8251 if (ap->pat == NULL)
8253 vim_free(ap);
8254 return FAIL;
8257 if (is_buflocal)
8259 ap->buflocal_nr = buflocal_nr;
8260 ap->reg_prog = NULL;
8262 else
8264 char_u *reg_pat;
8266 ap->buflocal_nr = 0;
8267 reg_pat = file_pat_to_reg_pat(pat, endpat,
8268 &ap->allow_dirs, TRUE);
8269 if (reg_pat != NULL)
8270 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
8271 vim_free(reg_pat);
8272 if (reg_pat == NULL || ap->reg_prog == NULL)
8274 vim_free(ap->pat);
8275 vim_free(ap);
8276 return FAIL;
8279 ap->cmds = NULL;
8280 *prev_ap = ap;
8281 ap->next = NULL;
8282 if (group == AUGROUP_ALL)
8283 ap->group = current_augroup;
8284 else
8285 ap->group = group;
8289 * Add the autocmd at the end of the AutoCmd list.
8291 prev_ac = &(ap->cmds);
8292 while ((ac = *prev_ac) != NULL)
8293 prev_ac = &ac->next;
8294 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
8295 if (ac == NULL)
8296 return FAIL;
8297 ac->cmd = vim_strsave(cmd);
8298 #ifdef FEAT_EVAL
8299 ac->scriptID = current_SID;
8300 #endif
8301 if (ac->cmd == NULL)
8303 vim_free(ac);
8304 return FAIL;
8306 ac->next = NULL;
8307 *prev_ac = ac;
8308 ac->nested = nested;
8312 au_cleanup(); /* may really delete removed patterns/commands now */
8313 return OK;
8317 * Implementation of ":doautocmd [group] event [fname]".
8318 * Return OK for success, FAIL for failure;
8321 do_doautocmd(arg, do_msg)
8322 char_u *arg;
8323 int do_msg; /* give message for no matching autocmds? */
8325 char_u *fname;
8326 int nothing_done = TRUE;
8327 int group;
8330 * Check for a legal group name. If not, use AUGROUP_ALL.
8332 group = au_get_grouparg(&arg);
8333 if (arg == NULL) /* out of memory */
8334 return FAIL;
8336 if (*arg == '*')
8338 EMSG(_("E217: Can't execute autocommands for ALL events"));
8339 return FAIL;
8343 * Scan over the events.
8344 * If we find an illegal name, return here, don't do anything.
8346 fname = find_end_event(arg, group != AUGROUP_ALL);
8347 if (fname == NULL)
8348 return FAIL;
8350 fname = skipwhite(fname);
8353 * Loop over the events.
8355 while (*arg && !vim_iswhite(*arg))
8356 if (apply_autocmds_group(event_name2nr(arg, &arg),
8357 fname, NULL, TRUE, group, curbuf, NULL))
8358 nothing_done = FALSE;
8360 if (nothing_done && do_msg)
8361 MSG(_("No matching autocommands"));
8363 #ifdef FEAT_EVAL
8364 return aborting() ? FAIL : OK;
8365 #else
8366 return OK;
8367 #endif
8371 * ":doautoall": execute autocommands for each loaded buffer.
8373 void
8374 ex_doautoall(eap)
8375 exarg_T *eap;
8377 int retval;
8378 aco_save_T aco;
8379 buf_T *buf;
8382 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8383 * equal to curbuf, but for some buffers there may not be a window.
8384 * So we change the buffer for the current window for a moment. This
8385 * gives problems when the autocommands make changes to the list of
8386 * buffers or windows...
8388 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8390 if (buf->b_ml.ml_mfp != NULL)
8392 /* find a window for this buffer and save some values */
8393 aucmd_prepbuf(&aco, buf);
8395 /* execute the autocommands for this buffer */
8396 retval = do_doautocmd(eap->arg, FALSE);
8398 /* Execute the modeline settings, but don't set window-local
8399 * options if we are using the current window for another buffer. */
8400 do_modelines(aco.save_curwin == NULL ? OPT_NOWIN : 0);
8402 /* restore the current window */
8403 aucmd_restbuf(&aco);
8405 /* stop if there is some error or buffer was deleted */
8406 if (retval == FAIL || !buf_valid(buf))
8407 break;
8411 check_cursor(); /* just in case lines got deleted */
8415 * Prepare for executing autocommands for (hidden) buffer "buf".
8416 * Search a window for the current buffer. Save the cursor position and
8417 * screen offset.
8418 * Set "curbuf" and "curwin" to match "buf".
8419 * When FEAT_AUTOCMD is not defined another version is used, see below.
8421 void
8422 aucmd_prepbuf(aco, buf)
8423 aco_save_T *aco; /* structure to save values in */
8424 buf_T *buf; /* new curbuf */
8426 win_T *win;
8428 aco->new_curbuf = buf;
8430 /* Find a window that is for the new buffer */
8431 if (buf == curbuf) /* be quick when buf is curbuf */
8432 win = curwin;
8433 else
8434 #ifdef FEAT_WINDOWS
8435 for (win = firstwin; win != NULL; win = win->w_next)
8436 if (win->w_buffer == buf)
8437 break;
8438 #else
8439 win = NULL;
8440 #endif
8443 * Prefer to use an existing window for the buffer, it has the least side
8444 * effects (esp. if "buf" is curbuf).
8445 * Otherwise, use curwin for "buf". It might make some items in the
8446 * window invalid. At least save the cursor and topline.
8448 if (win != NULL)
8450 /* there is a window for "buf", make it the curwin */
8451 aco->save_curwin = curwin;
8452 curwin = win;
8453 aco->save_buf = win->w_buffer;
8454 aco->new_curwin = win;
8456 else
8458 /* there is no window for "buf", use curwin */
8459 aco->save_curwin = NULL;
8460 aco->save_buf = curbuf;
8461 --curbuf->b_nwindows;
8462 curwin->w_buffer = buf;
8463 ++buf->b_nwindows;
8465 /* save cursor and topline, set them to safe values */
8466 aco->save_cursor = curwin->w_cursor;
8467 curwin->w_cursor.lnum = 1;
8468 curwin->w_cursor.col = 0;
8469 aco->save_topline = curwin->w_topline;
8470 curwin->w_topline = 1;
8471 #ifdef FEAT_DIFF
8472 aco->save_topfill = curwin->w_topfill;
8473 curwin->w_topfill = 0;
8474 #endif
8477 curbuf = buf;
8481 * Cleanup after executing autocommands for a (hidden) buffer.
8482 * Restore the window as it was (if possible).
8483 * When FEAT_AUTOCMD is not defined another version is used, see below.
8485 void
8486 aucmd_restbuf(aco)
8487 aco_save_T *aco; /* structure holding saved values */
8489 if (aco->save_curwin != NULL)
8491 /* restore curwin */
8492 #ifdef FEAT_WINDOWS
8493 if (win_valid(aco->save_curwin))
8494 #endif
8496 /* restore the buffer which was previously edited by curwin, if
8497 * it's still the same window and it's valid */
8498 if (curwin == aco->new_curwin
8499 && buf_valid(aco->save_buf)
8500 && aco->save_buf->b_ml.ml_mfp != NULL)
8502 --curbuf->b_nwindows;
8503 curbuf = aco->save_buf;
8504 curwin->w_buffer = curbuf;
8505 ++curbuf->b_nwindows;
8508 curwin = aco->save_curwin;
8509 curbuf = curwin->w_buffer;
8512 else
8514 /* restore buffer for curwin if it still exists and is loaded */
8515 if (buf_valid(aco->save_buf) && aco->save_buf->b_ml.ml_mfp != NULL)
8517 --curbuf->b_nwindows;
8518 curbuf = aco->save_buf;
8519 curwin->w_buffer = curbuf;
8520 ++curbuf->b_nwindows;
8521 curwin->w_cursor = aco->save_cursor;
8522 check_cursor();
8523 /* check topline < line_count, in case lines got deleted */
8524 if (aco->save_topline <= curbuf->b_ml.ml_line_count)
8526 curwin->w_topline = aco->save_topline;
8527 #ifdef FEAT_DIFF
8528 curwin->w_topfill = aco->save_topfill;
8529 #endif
8531 else
8533 curwin->w_topline = curbuf->b_ml.ml_line_count;
8534 #ifdef FEAT_DIFF
8535 curwin->w_topfill = 0;
8536 #endif
8542 static int autocmd_nested = FALSE;
8545 * Execute autocommands for "event" and file name "fname".
8546 * Return TRUE if some commands were executed.
8549 apply_autocmds(event, fname, fname_io, force, buf)
8550 event_T event;
8551 char_u *fname; /* NULL or empty means use actual file name */
8552 char_u *fname_io; /* fname to use for <afile> on cmdline */
8553 int force; /* when TRUE, ignore autocmd_busy */
8554 buf_T *buf; /* buffer for <abuf> */
8556 return apply_autocmds_group(event, fname, fname_io, force,
8557 AUGROUP_ALL, buf, NULL);
8561 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8562 * setting v:filearg.
8564 static int
8565 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8566 event_T event;
8567 char_u *fname;
8568 char_u *fname_io;
8569 int force;
8570 buf_T *buf;
8571 exarg_T *eap;
8573 return apply_autocmds_group(event, fname, fname_io, force,
8574 AUGROUP_ALL, buf, eap);
8578 * Like apply_autocmds(), but handles the caller's retval. If the script
8579 * processing is being aborted or if retval is FAIL when inside a try
8580 * conditional, no autocommands are executed. If otherwise the autocommands
8581 * cause the script to be aborted, retval is set to FAIL.
8584 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8585 event_T event;
8586 char_u *fname; /* NULL or empty means use actual file name */
8587 char_u *fname_io; /* fname to use for <afile> on cmdline */
8588 int force; /* when TRUE, ignore autocmd_busy */
8589 buf_T *buf; /* buffer for <abuf> */
8590 int *retval; /* pointer to caller's retval */
8592 int did_cmd;
8594 #ifdef FEAT_EVAL
8595 if (should_abort(*retval))
8596 return FALSE;
8597 #endif
8599 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8600 AUGROUP_ALL, buf, NULL);
8601 if (did_cmd
8602 #ifdef FEAT_EVAL
8603 && aborting()
8604 #endif
8606 *retval = FAIL;
8607 return did_cmd;
8611 * Return TRUE when there is a CursorHold autocommand defined.
8614 has_cursorhold()
8616 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8617 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8621 * Return TRUE if the CursorHold event can be triggered.
8624 trigger_cursorhold()
8626 int state;
8628 if (!did_cursorhold && has_cursorhold() && !Recording
8629 #ifdef FEAT_INS_EXPAND
8630 && !ins_compl_active()
8631 #endif
8634 state = get_real_state();
8635 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8636 return TRUE;
8638 return FALSE;
8642 * Return TRUE when there is a CursorMoved autocommand defined.
8645 has_cursormoved()
8647 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8651 * Return TRUE when there is a CursorMovedI autocommand defined.
8654 has_cursormovedI()
8656 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8659 static int
8660 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8661 event_T event;
8662 char_u *fname; /* NULL or empty means use actual file name */
8663 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8664 use fname */
8665 int force; /* when TRUE, ignore autocmd_busy */
8666 int group; /* group ID, or AUGROUP_ALL */
8667 buf_T *buf; /* buffer for <abuf> */
8668 exarg_T *eap; /* command arguments */
8670 char_u *sfname = NULL; /* short file name */
8671 char_u *tail;
8672 int save_changed;
8673 buf_T *old_curbuf;
8674 int retval = FALSE;
8675 char_u *save_sourcing_name;
8676 linenr_T save_sourcing_lnum;
8677 char_u *save_autocmd_fname;
8678 int save_autocmd_fname_full;
8679 int save_autocmd_bufnr;
8680 char_u *save_autocmd_match;
8681 int save_autocmd_busy;
8682 int save_autocmd_nested;
8683 static int nesting = 0;
8684 AutoPatCmd patcmd;
8685 AutoPat *ap;
8686 #ifdef FEAT_EVAL
8687 scid_T save_current_SID;
8688 void *save_funccalp;
8689 char_u *save_cmdarg;
8690 long save_cmdbang;
8691 #endif
8692 static int filechangeshell_busy = FALSE;
8693 #ifdef FEAT_PROFILE
8694 proftime_T wait_time;
8695 #endif
8698 * Quickly return if there are no autocommands for this event or
8699 * autocommands are blocked.
8701 if (first_autopat[(int)event] == NULL || autocmd_blocked > 0)
8702 goto BYPASS_AU;
8705 * When autocommands are busy, new autocommands are only executed when
8706 * explicitly enabled with the "nested" flag.
8708 if (autocmd_busy && !(force || autocmd_nested))
8709 goto BYPASS_AU;
8711 #ifdef FEAT_EVAL
8713 * Quickly return when immediately aborting on error, or when an interrupt
8714 * occurred or an exception was thrown but not caught.
8716 if (aborting())
8717 goto BYPASS_AU;
8718 #endif
8721 * FileChangedShell never nests, because it can create an endless loop.
8723 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8724 || event == EVENT_FILECHANGEDSHELLPOST))
8725 goto BYPASS_AU;
8728 * Ignore events in 'eventignore'.
8730 if (event_ignored(event))
8731 goto BYPASS_AU;
8734 * Allow nesting of autocommands, but restrict the depth, because it's
8735 * possible to create an endless loop.
8737 if (nesting == 10)
8739 EMSG(_("E218: autocommand nesting too deep"));
8740 goto BYPASS_AU;
8744 * Check if these autocommands are disabled. Used when doing ":all" or
8745 * ":ball".
8747 if ( (autocmd_no_enter
8748 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8749 || (autocmd_no_leave
8750 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8751 goto BYPASS_AU;
8754 * Save the autocmd_* variables and info about the current buffer.
8756 save_autocmd_fname = autocmd_fname;
8757 save_autocmd_fname_full = autocmd_fname_full;
8758 save_autocmd_bufnr = autocmd_bufnr;
8759 save_autocmd_match = autocmd_match;
8760 save_autocmd_busy = autocmd_busy;
8761 save_autocmd_nested = autocmd_nested;
8762 save_changed = curbuf->b_changed;
8763 old_curbuf = curbuf;
8766 * Set the file name to be used for <afile>.
8767 * Make a copy to avoid that changing a buffer name or directory makes it
8768 * invalid.
8770 if (fname_io == NULL)
8772 if (fname != NULL && *fname != NUL)
8773 autocmd_fname = fname;
8774 else if (buf != NULL)
8775 autocmd_fname = buf->b_ffname;
8776 else
8777 autocmd_fname = NULL;
8779 else
8780 autocmd_fname = fname_io;
8781 if (autocmd_fname != NULL)
8782 autocmd_fname = vim_strsave(autocmd_fname);
8783 autocmd_fname_full = FALSE; /* call FullName_save() later */
8786 * Set the buffer number to be used for <abuf>.
8788 if (buf == NULL)
8789 autocmd_bufnr = 0;
8790 else
8791 autocmd_bufnr = buf->b_fnum;
8794 * When the file name is NULL or empty, use the file name of buffer "buf".
8795 * Always use the full path of the file name to match with, in case
8796 * "allow_dirs" is set.
8798 if (fname == NULL || *fname == NUL)
8800 if (buf == NULL)
8801 fname = NULL;
8802 else
8804 #ifdef FEAT_SYN_HL
8805 if (event == EVENT_SYNTAX)
8806 fname = buf->b_p_syn;
8807 else
8808 #endif
8809 if (event == EVENT_FILETYPE)
8810 fname = buf->b_p_ft;
8811 else
8813 if (buf->b_sfname != NULL)
8814 sfname = vim_strsave(buf->b_sfname);
8815 fname = buf->b_ffname;
8818 if (fname == NULL)
8819 fname = (char_u *)"";
8820 fname = vim_strsave(fname); /* make a copy, so we can change it */
8822 else
8824 sfname = vim_strsave(fname);
8825 /* Don't try expanding FileType, Syntax, WindowID or QuickFixCmd* */
8826 if (event == EVENT_FILETYPE
8827 || event == EVENT_SYNTAX
8828 || event == EVENT_REMOTEREPLY
8829 || event == EVENT_SPELLFILEMISSING
8830 || event == EVENT_QUICKFIXCMDPRE
8831 || event == EVENT_QUICKFIXCMDPOST)
8832 fname = vim_strsave(fname);
8833 else
8834 fname = FullName_save(fname, FALSE);
8836 if (fname == NULL) /* out of memory */
8838 vim_free(sfname);
8839 retval = FALSE;
8840 goto BYPASS_AU;
8843 #ifdef BACKSLASH_IN_FILENAME
8845 * Replace all backslashes with forward slashes. This makes the
8846 * autocommand patterns portable between Unix and MS-DOS.
8848 if (sfname != NULL)
8849 forward_slash(sfname);
8850 forward_slash(fname);
8851 #endif
8853 #ifdef VMS
8854 /* remove version for correct match */
8855 if (sfname != NULL)
8856 vms_remove_version(sfname);
8857 vms_remove_version(fname);
8858 #endif
8861 * Set the name to be used for <amatch>.
8863 autocmd_match = fname;
8866 /* Don't redraw while doing auto commands. */
8867 ++RedrawingDisabled;
8868 save_sourcing_name = sourcing_name;
8869 sourcing_name = NULL; /* don't free this one */
8870 save_sourcing_lnum = sourcing_lnum;
8871 sourcing_lnum = 0; /* no line number here */
8873 #ifdef FEAT_EVAL
8874 save_current_SID = current_SID;
8876 # ifdef FEAT_PROFILE
8877 if (do_profiling == PROF_YES)
8878 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
8879 # endif
8881 /* Don't use local function variables, if called from a function */
8882 save_funccalp = save_funccal();
8883 #endif
8886 * When starting to execute autocommands, save the search patterns.
8888 if (!autocmd_busy)
8890 save_search_patterns();
8891 saveRedobuff();
8892 did_filetype = keep_filetype;
8896 * Note that we are applying autocmds. Some commands need to know.
8898 autocmd_busy = TRUE;
8899 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
8900 ++nesting; /* see matching decrement below */
8902 /* Remember that FileType was triggered. Used for did_filetype(). */
8903 if (event == EVENT_FILETYPE)
8904 did_filetype = TRUE;
8906 tail = gettail(fname);
8908 /* Find first autocommand that matches */
8909 patcmd.curpat = first_autopat[(int)event];
8910 patcmd.nextcmd = NULL;
8911 patcmd.group = group;
8912 patcmd.fname = fname;
8913 patcmd.sfname = sfname;
8914 patcmd.tail = tail;
8915 patcmd.event = event;
8916 patcmd.arg_bufnr = autocmd_bufnr;
8917 patcmd.next = NULL;
8918 auto_next_pat(&patcmd, FALSE);
8920 /* found one, start executing the autocommands */
8921 if (patcmd.curpat != NULL)
8923 /* add to active_apc_list */
8924 patcmd.next = active_apc_list;
8925 active_apc_list = &patcmd;
8927 #ifdef FEAT_EVAL
8928 /* set v:cmdarg (only when there is a matching pattern) */
8929 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
8930 if (eap != NULL)
8932 save_cmdarg = set_cmdarg(eap, NULL);
8933 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
8935 else
8936 save_cmdarg = NULL; /* avoid gcc warning */
8937 #endif
8938 retval = TRUE;
8939 /* mark the last pattern, to avoid an endless loop when more patterns
8940 * are added when executing autocommands */
8941 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
8942 ap->last = FALSE;
8943 ap->last = TRUE;
8944 check_lnums(TRUE); /* make sure cursor and topline are valid */
8945 do_cmdline(NULL, getnextac, (void *)&patcmd,
8946 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
8947 #ifdef FEAT_EVAL
8948 if (eap != NULL)
8950 (void)set_cmdarg(NULL, save_cmdarg);
8951 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
8953 #endif
8954 /* delete from active_apc_list */
8955 if (active_apc_list == &patcmd) /* just in case */
8956 active_apc_list = patcmd.next;
8959 --RedrawingDisabled;
8960 autocmd_busy = save_autocmd_busy;
8961 filechangeshell_busy = FALSE;
8962 autocmd_nested = save_autocmd_nested;
8963 vim_free(sourcing_name);
8964 sourcing_name = save_sourcing_name;
8965 sourcing_lnum = save_sourcing_lnum;
8966 vim_free(autocmd_fname);
8967 autocmd_fname = save_autocmd_fname;
8968 autocmd_fname_full = save_autocmd_fname_full;
8969 autocmd_bufnr = save_autocmd_bufnr;
8970 autocmd_match = save_autocmd_match;
8971 #ifdef FEAT_EVAL
8972 current_SID = save_current_SID;
8973 restore_funccal(save_funccalp);
8974 # ifdef FEAT_PROFILE
8975 if (do_profiling == PROF_YES)
8976 prof_child_exit(&wait_time);
8977 # endif
8978 #endif
8979 vim_free(fname);
8980 vim_free(sfname);
8981 --nesting; /* see matching increment above */
8984 * When stopping to execute autocommands, restore the search patterns and
8985 * the redo buffer.
8987 if (!autocmd_busy)
8989 restore_search_patterns();
8990 restoreRedobuff();
8991 did_filetype = FALSE;
8995 * Some events don't set or reset the Changed flag.
8996 * Check if still in the same buffer!
8998 if (curbuf == old_curbuf
8999 && (event == EVENT_BUFREADPOST
9000 || event == EVENT_BUFWRITEPOST
9001 || event == EVENT_FILEAPPENDPOST
9002 || event == EVENT_VIMLEAVE
9003 || event == EVENT_VIMLEAVEPRE))
9005 #ifdef FEAT_TITLE
9006 if (curbuf->b_changed != save_changed)
9007 need_maketitle = TRUE;
9008 #endif
9009 curbuf->b_changed = save_changed;
9012 au_cleanup(); /* may really delete removed patterns/commands now */
9014 BYPASS_AU:
9015 /* When wiping out a buffer make sure all its buffer-local autocommands
9016 * are deleted. */
9017 if (event == EVENT_BUFWIPEOUT && buf != NULL)
9018 aubuflocal_remove(buf);
9020 return retval;
9023 # ifdef FEAT_EVAL
9024 static char_u *old_termresponse = NULL;
9025 # endif
9028 * Block triggering autocommands until unblock_autocmd() is called.
9029 * Can be used recursively, so long as it's symmetric.
9031 void
9032 block_autocmds()
9034 # ifdef FEAT_EVAL
9035 /* Remember the value of v:termresponse. */
9036 if (autocmd_blocked == 0)
9037 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
9038 # endif
9039 ++autocmd_blocked;
9042 void
9043 unblock_autocmds()
9045 --autocmd_blocked;
9047 # ifdef FEAT_EVAL
9048 /* When v:termresponse was set while autocommands were blocked, trigger
9049 * the autocommands now. Esp. useful when executing a shell command
9050 * during startup (vimdiff). */
9051 if (autocmd_blocked == 0
9052 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
9053 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
9054 # endif
9058 * Find next autocommand pattern that matches.
9060 static void
9061 auto_next_pat(apc, stop_at_last)
9062 AutoPatCmd *apc;
9063 int stop_at_last; /* stop when 'last' flag is set */
9065 AutoPat *ap;
9066 AutoCmd *cp;
9067 char_u *name;
9068 char *s;
9070 vim_free(sourcing_name);
9071 sourcing_name = NULL;
9073 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
9075 apc->curpat = NULL;
9077 /* Only use a pattern when it has not been removed, has commands and
9078 * the group matches. For buffer-local autocommands only check the
9079 * buffer number. */
9080 if (ap->pat != NULL && ap->cmds != NULL
9081 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
9083 /* execution-condition */
9084 if (ap->buflocal_nr == 0
9085 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
9086 apc->sfname, apc->tail, ap->allow_dirs))
9087 : ap->buflocal_nr == apc->arg_bufnr)
9089 name = event_nr2name(apc->event);
9090 s = _("%s Auto commands for \"%s\"");
9091 sourcing_name = alloc((unsigned)(STRLEN(s)
9092 + STRLEN(name) + ap->patlen + 1));
9093 if (sourcing_name != NULL)
9095 sprintf((char *)sourcing_name, s,
9096 (char *)name, (char *)ap->pat);
9097 if (p_verbose >= 8)
9099 verbose_enter();
9100 smsg((char_u *)_("Executing %s"), sourcing_name);
9101 verbose_leave();
9105 apc->curpat = ap;
9106 apc->nextcmd = ap->cmds;
9107 /* mark last command */
9108 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
9109 cp->last = FALSE;
9110 cp->last = TRUE;
9112 line_breakcheck();
9113 if (apc->curpat != NULL) /* found a match */
9114 break;
9116 if (stop_at_last && ap->last)
9117 break;
9122 * Get next autocommand command.
9123 * Called by do_cmdline() to get the next line for ":if".
9124 * Returns allocated string, or NULL for end of autocommands.
9126 /* ARGSUSED */
9127 static char_u *
9128 getnextac(c, cookie, indent)
9129 int c; /* not used */
9130 void *cookie;
9131 int indent; /* not used */
9133 AutoPatCmd *acp = (AutoPatCmd *)cookie;
9134 char_u *retval;
9135 AutoCmd *ac;
9137 /* Can be called again after returning the last line. */
9138 if (acp->curpat == NULL)
9139 return NULL;
9141 /* repeat until we find an autocommand to execute */
9142 for (;;)
9144 /* skip removed commands */
9145 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
9146 if (acp->nextcmd->last)
9147 acp->nextcmd = NULL;
9148 else
9149 acp->nextcmd = acp->nextcmd->next;
9151 if (acp->nextcmd != NULL)
9152 break;
9154 /* at end of commands, find next pattern that matches */
9155 if (acp->curpat->last)
9156 acp->curpat = NULL;
9157 else
9158 acp->curpat = acp->curpat->next;
9159 if (acp->curpat != NULL)
9160 auto_next_pat(acp, TRUE);
9161 if (acp->curpat == NULL)
9162 return NULL;
9165 ac = acp->nextcmd;
9167 if (p_verbose >= 9)
9169 verbose_enter_scroll();
9170 smsg((char_u *)_("autocommand %s"), ac->cmd);
9171 msg_puts((char_u *)"\n"); /* don't overwrite this either */
9172 verbose_leave_scroll();
9174 retval = vim_strsave(ac->cmd);
9175 autocmd_nested = ac->nested;
9176 #ifdef FEAT_EVAL
9177 current_SID = ac->scriptID;
9178 #endif
9179 if (ac->last)
9180 acp->nextcmd = NULL;
9181 else
9182 acp->nextcmd = ac->next;
9183 return retval;
9187 * Return TRUE if there is a matching autocommand for "fname".
9188 * To account for buffer-local autocommands, function needs to know
9189 * in which buffer the file will be opened.
9192 has_autocmd(event, sfname, buf)
9193 event_T event;
9194 char_u *sfname;
9195 buf_T *buf;
9197 AutoPat *ap;
9198 char_u *fname;
9199 char_u *tail = gettail(sfname);
9200 int retval = FALSE;
9202 fname = FullName_save(sfname, FALSE);
9203 if (fname == NULL)
9204 return FALSE;
9206 #ifdef BACKSLASH_IN_FILENAME
9208 * Replace all backslashes with forward slashes. This makes the
9209 * autocommand patterns portable between Unix and MS-DOS.
9211 sfname = vim_strsave(sfname);
9212 if (sfname != NULL)
9213 forward_slash(sfname);
9214 forward_slash(fname);
9215 #endif
9217 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
9218 if (ap->pat != NULL && ap->cmds != NULL
9219 && (ap->buflocal_nr == 0
9220 ? match_file_pat(NULL, ap->reg_prog,
9221 fname, sfname, tail, ap->allow_dirs)
9222 : buf != NULL && ap->buflocal_nr == buf->b_fnum
9225 retval = TRUE;
9226 break;
9229 vim_free(fname);
9230 #ifdef BACKSLASH_IN_FILENAME
9231 vim_free(sfname);
9232 #endif
9234 return retval;
9237 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9239 * Function given to ExpandGeneric() to obtain the list of autocommand group
9240 * names.
9242 /*ARGSUSED*/
9243 char_u *
9244 get_augroup_name(xp, idx)
9245 expand_T *xp;
9246 int idx;
9248 if (idx == augroups.ga_len) /* add "END" add the end */
9249 return (char_u *)"END";
9250 if (idx >= augroups.ga_len) /* end of list */
9251 return NULL;
9252 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
9253 return (char_u *)"";
9254 return AUGROUP_NAME(idx); /* return a name */
9257 static int include_groups = FALSE;
9259 char_u *
9260 set_context_in_autocmd(xp, arg, doautocmd)
9261 expand_T *xp;
9262 char_u *arg;
9263 int doautocmd; /* TRUE for :doauto*, FALSE for :autocmd */
9265 char_u *p;
9266 int group;
9268 /* check for a group name, skip it if present */
9269 include_groups = FALSE;
9270 p = arg;
9271 group = au_get_grouparg(&arg);
9272 if (group == AUGROUP_ERROR)
9273 return NULL;
9274 /* If there only is a group name that's what we expand. */
9275 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
9277 arg = p;
9278 group = AUGROUP_ALL;
9281 /* skip over event name */
9282 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
9283 if (*p == ',')
9284 arg = p + 1;
9285 if (*p == NUL)
9287 if (group == AUGROUP_ALL)
9288 include_groups = TRUE;
9289 xp->xp_context = EXPAND_EVENTS; /* expand event name */
9290 xp->xp_pattern = arg;
9291 return NULL;
9294 /* skip over pattern */
9295 arg = skipwhite(p);
9296 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
9297 arg++;
9298 if (*arg)
9299 return arg; /* expand (next) command */
9301 if (doautocmd)
9302 xp->xp_context = EXPAND_FILES; /* expand file names */
9303 else
9304 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
9305 return NULL;
9309 * Function given to ExpandGeneric() to obtain the list of event names.
9311 /*ARGSUSED*/
9312 char_u *
9313 get_event_name(xp, idx)
9314 expand_T *xp;
9315 int idx;
9317 if (idx < augroups.ga_len) /* First list group names, if wanted */
9319 if (!include_groups || AUGROUP_NAME(idx) == NULL)
9320 return (char_u *)""; /* skip deleted entries */
9321 return AUGROUP_NAME(idx); /* return a name */
9323 return (char_u *)event_names[idx - augroups.ga_len].name;
9326 #endif /* FEAT_CMDL_COMPL */
9329 * Return TRUE if autocmd is supported.
9332 autocmd_supported(name)
9333 char_u *name;
9335 char_u *p;
9337 return (event_name2nr(name, &p) != NUM_EVENTS);
9341 * Return TRUE if an autocommand is defined for a group, event and
9342 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9343 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9344 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9345 * Used for:
9346 * exists("#Group") or
9347 * exists("#Group#Event") or
9348 * exists("#Group#Event#pat") or
9349 * exists("#Event") or
9350 * exists("#Event#pat")
9353 au_exists(arg)
9354 char_u *arg;
9356 char_u *arg_save;
9357 char_u *pattern = NULL;
9358 char_u *event_name;
9359 char_u *p;
9360 event_T event;
9361 AutoPat *ap;
9362 buf_T *buflocal_buf = NULL;
9363 int group;
9364 int retval = FALSE;
9366 /* Make a copy so that we can change the '#' chars to a NUL. */
9367 arg_save = vim_strsave(arg);
9368 if (arg_save == NULL)
9369 return FALSE;
9370 p = vim_strchr(arg_save, '#');
9371 if (p != NULL)
9372 *p++ = NUL;
9374 /* First, look for an autocmd group name */
9375 group = au_find_group(arg_save);
9376 if (group == AUGROUP_ERROR)
9378 /* Didn't match a group name, assume the first argument is an event. */
9379 group = AUGROUP_ALL;
9380 event_name = arg_save;
9382 else
9384 if (p == NULL)
9386 /* "Group": group name is present and it's recognized */
9387 retval = TRUE;
9388 goto theend;
9391 /* Must be "Group#Event" or "Group#Event#pat". */
9392 event_name = p;
9393 p = vim_strchr(event_name, '#');
9394 if (p != NULL)
9395 *p++ = NUL; /* "Group#Event#pat" */
9398 pattern = p; /* "pattern" is NULL when there is no pattern */
9400 /* find the index (enum) for the event name */
9401 event = event_name2nr(event_name, &p);
9403 /* return FALSE if the event name is not recognized */
9404 if (event == NUM_EVENTS)
9405 goto theend;
9407 /* Find the first autocommand for this event.
9408 * If there isn't any, return FALSE;
9409 * If there is one and no pattern given, return TRUE; */
9410 ap = first_autopat[(int)event];
9411 if (ap == NULL)
9412 goto theend;
9413 if (pattern == NULL)
9415 retval = TRUE;
9416 goto theend;
9419 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9420 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9421 if (STRICMP(pattern, "<buffer>") == 0)
9422 buflocal_buf = curbuf;
9424 /* Check if there is an autocommand with the given pattern. */
9425 for ( ; ap != NULL; ap = ap->next)
9426 /* only use a pattern when it has not been removed and has commands. */
9427 /* For buffer-local autocommands, fnamecmp() works fine. */
9428 if (ap->pat != NULL && ap->cmds != NULL
9429 && (group == AUGROUP_ALL || ap->group == group)
9430 && (buflocal_buf == NULL
9431 ? fnamecmp(ap->pat, pattern) == 0
9432 : ap->buflocal_nr == buflocal_buf->b_fnum))
9434 retval = TRUE;
9435 break;
9438 theend:
9439 vim_free(arg_save);
9440 return retval;
9443 #else /* FEAT_AUTOCMD */
9446 * Prepare for executing commands for (hidden) buffer "buf".
9447 * This is the non-autocommand version, it simply saves "curbuf" and sets
9448 * "curbuf" and "curwin" to match "buf".
9450 void
9451 aucmd_prepbuf(aco, buf)
9452 aco_save_T *aco; /* structure to save values in */
9453 buf_T *buf; /* new curbuf */
9455 aco->save_buf = curbuf;
9456 curbuf = buf;
9457 curwin->w_buffer = buf;
9461 * Restore after executing commands for a (hidden) buffer.
9462 * This is the non-autocommand version.
9464 void
9465 aucmd_restbuf(aco)
9466 aco_save_T *aco; /* structure holding saved values */
9468 curbuf = aco->save_buf;
9469 curwin->w_buffer = curbuf;
9472 #endif /* FEAT_AUTOCMD */
9475 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9477 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9478 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9479 * vim_regcomp() often.
9480 * Used for autocommands and 'wildignore'.
9481 * Returns TRUE if there is a match, FALSE otherwise.
9484 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9485 char_u *pattern; /* pattern to match with */
9486 regprog_T *prog; /* pre-compiled regprog or NULL */
9487 char_u *fname; /* full path of file name */
9488 char_u *sfname; /* short file name or NULL */
9489 char_u *tail; /* tail of path */
9490 int allow_dirs; /* allow matching with dir */
9492 regmatch_T regmatch;
9493 int result = FALSE;
9494 #ifdef FEAT_OSFILETYPE
9495 int no_pattern = FALSE; /* TRUE if check is filetype only */
9496 char_u *type_start;
9497 char_u c;
9498 int match = FALSE;
9499 #endif
9501 #ifdef CASE_INSENSITIVE_FILENAME
9502 regmatch.rm_ic = TRUE; /* Always ignore case */
9503 #else
9504 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9505 #endif
9506 #ifdef FEAT_OSFILETYPE
9507 if (*pattern == '<')
9509 /* There is a filetype condition specified with this pattern.
9510 * Check the filetype matches first. If not, don't bother with the
9511 * pattern (set regprog to NULL).
9512 * Always use magic for the regexp.
9515 for (type_start = pattern + 1; (c = *pattern); pattern++)
9517 if ((c == ';' || c == '>') && match == FALSE)
9519 *pattern = NUL; /* Terminate the string */
9520 match = mch_check_filetype(fname, type_start);
9521 *pattern = c; /* Restore the terminator */
9522 type_start = pattern + 1;
9524 if (c == '>')
9525 break;
9528 /* (c should never be NUL, but check anyway) */
9529 if (match == FALSE || c == NUL)
9530 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9531 else if (*pattern == NUL)
9533 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9534 no_pattern = TRUE; /* Always matches - don't check pat. */
9536 else
9537 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9539 else
9540 #endif
9542 if (prog != NULL)
9543 regmatch.regprog = prog;
9544 else
9545 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9549 * Try for a match with the pattern with:
9550 * 1. the full file name, when the pattern has a '/'.
9551 * 2. the short file name, when the pattern has a '/'.
9552 * 3. the tail of the file name, when the pattern has no '/'.
9554 if (
9555 #ifdef FEAT_OSFILETYPE
9556 /* If the check is for a filetype only and we don't care
9557 * about the path then skip all the regexp stuff.
9559 no_pattern ||
9560 #endif
9561 (regmatch.regprog != NULL
9562 && ((allow_dirs
9563 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9564 || (sfname != NULL
9565 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9566 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9567 result = TRUE;
9569 if (prog == NULL)
9570 vim_free(regmatch.regprog);
9571 return result;
9573 #endif
9575 #if defined(FEAT_WILDIGN) || defined(PROTO)
9577 * Return TRUE if a file matches with a pattern in "list".
9578 * "list" is a comma-separated list of patterns, like 'wildignore'.
9579 * "sfname" is the short file name or NULL, "ffname" the long file name.
9582 match_file_list(list, sfname, ffname)
9583 char_u *list;
9584 char_u *sfname;
9585 char_u *ffname;
9587 char_u buf[100];
9588 char_u *tail;
9589 char_u *regpat;
9590 char allow_dirs;
9591 int match;
9592 char_u *p;
9594 tail = gettail(sfname);
9596 /* try all patterns in 'wildignore' */
9597 p = list;
9598 while (*p)
9600 copy_option_part(&p, buf, 100, ",");
9601 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9602 if (regpat == NULL)
9603 break;
9604 match = match_file_pat(regpat, NULL, ffname, sfname,
9605 tail, (int)allow_dirs);
9606 vim_free(regpat);
9607 if (match)
9608 return TRUE;
9610 return FALSE;
9612 #endif
9615 * Convert the given pattern "pat" which has shell style wildcards in it, into
9616 * a regular expression, and return the result in allocated memory. If there
9617 * is a directory path separator to be matched, then TRUE is put in
9618 * allow_dirs, otherwise FALSE is put there -- webb.
9619 * Handle backslashes before special characters, like "\*" and "\ ".
9621 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9622 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9624 * Returns NULL when out of memory.
9626 /*ARGSUSED*/
9627 char_u *
9628 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9629 char_u *pat;
9630 char_u *pat_end; /* first char after pattern or NULL */
9631 char *allow_dirs; /* Result passed back out in here */
9632 int no_bslash; /* Don't use a backward slash as pathsep */
9634 int size;
9635 char_u *endp;
9636 char_u *reg_pat;
9637 char_u *p;
9638 int i;
9639 int nested = 0;
9640 int add_dollar = TRUE;
9641 #ifdef FEAT_OSFILETYPE
9642 int check_length = 0;
9643 #endif
9645 if (allow_dirs != NULL)
9646 *allow_dirs = FALSE;
9647 if (pat_end == NULL)
9648 pat_end = pat + STRLEN(pat);
9650 #ifdef FEAT_OSFILETYPE
9651 /* Find out how much of the string is the filetype check */
9652 if (*pat == '<')
9654 /* Count chars until the next '>' */
9655 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9657 if (p < pat_end)
9659 /* Pattern is of the form <.*>.* */
9660 check_length = p - pat + 1;
9661 if (p + 1 >= pat_end)
9663 /* The 'pattern' is a filetype check ONLY */
9664 reg_pat = (char_u *)alloc(check_length + 1);
9665 if (reg_pat != NULL)
9667 mch_memmove(reg_pat, pat, (size_t)check_length);
9668 reg_pat[check_length] = NUL;
9670 return reg_pat;
9673 /* else: there was no closing '>' - assume it was a normal pattern */
9676 pat += check_length;
9677 size = 2 + check_length;
9678 #else
9679 size = 2; /* '^' at start, '$' at end */
9680 #endif
9682 for (p = pat; p < pat_end; p++)
9684 switch (*p)
9686 case '*':
9687 case '.':
9688 case ',':
9689 case '{':
9690 case '}':
9691 case '~':
9692 size += 2; /* extra backslash */
9693 break;
9694 #ifdef BACKSLASH_IN_FILENAME
9695 case '\\':
9696 case '/':
9697 size += 4; /* could become "[\/]" */
9698 break;
9699 #endif
9700 default:
9701 size++;
9702 # ifdef FEAT_MBYTE
9703 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9705 ++p;
9706 ++size;
9708 # endif
9709 break;
9712 reg_pat = alloc(size + 1);
9713 if (reg_pat == NULL)
9714 return NULL;
9716 #ifdef FEAT_OSFILETYPE
9717 /* Copy the type check in to the start. */
9718 if (check_length)
9719 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9720 i = check_length;
9721 #else
9722 i = 0;
9723 #endif
9725 if (pat[0] == '*')
9726 while (pat[0] == '*' && pat < pat_end - 1)
9727 pat++;
9728 else
9729 reg_pat[i++] = '^';
9730 endp = pat_end - 1;
9731 if (*endp == '*')
9733 while (endp - pat > 0 && *endp == '*')
9734 endp--;
9735 add_dollar = FALSE;
9737 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9739 switch (*p)
9741 case '*':
9742 reg_pat[i++] = '.';
9743 reg_pat[i++] = '*';
9744 while (p[1] == '*') /* "**" matches like "*" */
9745 ++p;
9746 break;
9747 case '.':
9748 #ifdef RISCOS
9749 if (allow_dirs != NULL)
9750 *allow_dirs = TRUE;
9751 /* FALLTHROUGH */
9752 #endif
9753 case '~':
9754 reg_pat[i++] = '\\';
9755 reg_pat[i++] = *p;
9756 break;
9757 case '?':
9758 #ifdef RISCOS
9759 case '#':
9760 #endif
9761 reg_pat[i++] = '.';
9762 break;
9763 case '\\':
9764 if (p[1] == NUL)
9765 break;
9766 #ifdef BACKSLASH_IN_FILENAME
9767 if (!no_bslash)
9769 /* translate:
9770 * "\x" to "\\x" e.g., "dir\file"
9771 * "\*" to "\\.*" e.g., "dir\*.c"
9772 * "\?" to "\\." e.g., "dir\??.c"
9773 * "\+" to "\+" e.g., "fileX\+.c"
9775 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9776 && p[1] != '+')
9778 reg_pat[i++] = '[';
9779 reg_pat[i++] = '\\';
9780 reg_pat[i++] = '/';
9781 reg_pat[i++] = ']';
9782 if (allow_dirs != NULL)
9783 *allow_dirs = TRUE;
9784 break;
9787 #endif
9788 if (*++p == '?'
9789 #ifdef BACKSLASH_IN_FILENAME
9790 && no_bslash
9791 #endif
9793 reg_pat[i++] = '?';
9794 else
9795 if (*p == ',')
9796 reg_pat[i++] = ',';
9797 else
9799 if (allow_dirs != NULL && vim_ispathsep(*p)
9800 #ifdef BACKSLASH_IN_FILENAME
9801 && (!no_bslash || *p != '\\')
9802 #endif
9804 *allow_dirs = TRUE;
9805 reg_pat[i++] = '\\';
9806 reg_pat[i++] = *p;
9808 break;
9809 #ifdef BACKSLASH_IN_FILENAME
9810 case '/':
9811 reg_pat[i++] = '[';
9812 reg_pat[i++] = '\\';
9813 reg_pat[i++] = '/';
9814 reg_pat[i++] = ']';
9815 if (allow_dirs != NULL)
9816 *allow_dirs = TRUE;
9817 break;
9818 #endif
9819 case '{':
9820 reg_pat[i++] = '\\';
9821 reg_pat[i++] = '(';
9822 nested++;
9823 break;
9824 case '}':
9825 reg_pat[i++] = '\\';
9826 reg_pat[i++] = ')';
9827 --nested;
9828 break;
9829 case ',':
9830 if (nested)
9832 reg_pat[i++] = '\\';
9833 reg_pat[i++] = '|';
9835 else
9836 reg_pat[i++] = ',';
9837 break;
9838 default:
9839 # ifdef FEAT_MBYTE
9840 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9841 reg_pat[i++] = *p++;
9842 else
9843 # endif
9844 if (allow_dirs != NULL && vim_ispathsep(*p))
9845 *allow_dirs = TRUE;
9846 reg_pat[i++] = *p;
9847 break;
9850 if (add_dollar)
9851 reg_pat[i++] = '$';
9852 reg_pat[i] = NUL;
9853 if (nested != 0)
9855 if (nested < 0)
9856 EMSG(_("E219: Missing {."));
9857 else
9858 EMSG(_("E220: Missing }."));
9859 vim_free(reg_pat);
9860 reg_pat = NULL;
9862 return reg_pat;